/ Hex Artifact Content
Login

Artifact e011dcc3942e6ddc8dd7b894e9e6702e4269161e:


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 41  #ifndef SQLITE_A
0790: 50 49 43 41 4c 4c 0a 23 20 64 65 66 69 6e 65 20  PICALL.# define 
07a0: 53 51 4c 49 54 45 5f 41 50 49 43 41 4c 4c 0a 23  SQLITE_APICALL.#
07b0: 65 6e 64 69 66 0a 23 69 66 6e 64 65 66 20 53 51  endif.#ifndef SQ
07c0: 4c 49 54 45 5f 53 54 44 43 41 4c 4c 0a 23 20 64  LITE_STDCALL.# d
07d0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53 54 44  efine SQLITE_STD
07e0: 43 41 4c 4c 20 53 51 4c 49 54 45 5f 41 50 49 43  CALL SQLITE_APIC
07f0: 41 4c 4c 0a 23 65 6e 64 69 66 0a 23 69 66 6e 64  ALL.#endif.#ifnd
0800: 65 66 20 53 51 4c 49 54 45 5f 43 41 4c 4c 42 41  ef SQLITE_CALLBA
0810: 43 4b 0a 23 20 64 65 66 69 6e 65 20 53 51 4c 49  CK.# define SQLI
0820: 54 45 5f 43 41 4c 4c 42 41 43 4b 0a 23 65 6e 64  TE_CALLBACK.#end
0830: 69 66 0a 23 69 66 6e 64 65 66 20 53 51 4c 49 54  if.#ifndef SQLIT
0840: 45 5f 53 59 53 41 50 49 0a 23 20 64 65 66 69 6e  E_SYSAPI.# defin
0850: 65 20 53 51 4c 49 54 45 5f 53 59 53 41 50 49 0a  e SQLITE_SYSAPI.
0860: 23 65 6e 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 54 68  #endif../*.** Th
0870: 65 73 65 20 6e 6f 2d 6f 70 20 6d 61 63 72 6f 73  ese no-op macros
0880: 20 61 72 65 20 75 73 65 64 20 69 6e 20 66 72 6f   are used in fro
0890: 6e 74 20 6f 66 20 69 6e 74 65 72 66 61 63 65 73  nt of interfaces
08a0: 20 74 6f 20 6d 61 72 6b 20 74 68 6f 73 65 0a 2a   to mark those.*
08b0: 2a 20 69 6e 74 65 72 66 61 63 65 73 20 61 73 20  * interfaces as 
08c0: 65 69 74 68 65 72 20 64 65 70 72 65 63 61 74 65  either deprecate
08d0: 64 20 6f 72 20 65 78 70 65 72 69 6d 65 6e 74 61  d or experimenta
08e0: 6c 2e 20 20 4e 65 77 20 61 70 70 6c 69 63 61 74  l.  New applicat
08f0: 69 6f 6e 73 0a 2a 2a 20 73 68 6f 75 6c 64 20 6e  ions.** should n
0900: 6f 74 20 75 73 65 20 64 65 70 72 65 63 61 74 65  ot use deprecate
0910: 64 20 69 6e 74 65 72 66 61 63 65 73 20 2d 20 74  d interfaces - t
0920: 68 65 79 20 61 72 65 20 73 75 70 70 6f 72 74 65  hey are supporte
0930: 64 20 66 6f 72 20 62 61 63 6b 77 61 72 64 73 0a  d for backwards.
0940: 2a 2a 20 63 6f 6d 70 61 74 69 62 69 6c 69 74 79  ** compatibility
0950: 20 6f 6e 6c 79 2e 20 20 41 70 70 6c 69 63 61 74   only.  Applicat
0960: 69 6f 6e 20 77 72 69 74 65 72 73 20 73 68 6f 75  ion writers shou
0970: 6c 64 20 62 65 20 61 77 61 72 65 20 74 68 61 74  ld be aware that
0980: 0a 2a 2a 20 65 78 70 65 72 69 6d 65 6e 74 61 6c  .** experimental
0990: 20 69 6e 74 65 72 66 61 63 65 73 20 61 72 65 20   interfaces are 
09a0: 73 75 62 6a 65 63 74 20 74 6f 20 63 68 61 6e 67  subject to chang
09b0: 65 20 69 6e 20 70 6f 69 6e 74 20 72 65 6c 65 61  e in point relea
09c0: 73 65 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65  ses..**.** These
09d0: 20 6d 61 63 72 6f 73 20 75 73 65 64 20 74 6f 20   macros used to 
09e0: 72 65 73 6f 6c 76 65 20 74 6f 20 76 61 72 69 6f  resolve to vario
09f0: 75 73 20 6b 69 6e 64 73 20 6f 66 20 63 6f 6d 70  us kinds of comp
0a00: 69 6c 65 72 20 6d 61 67 69 63 20 74 68 61 74 0a  iler magic that.
0a10: 2a 2a 20 77 6f 75 6c 64 20 67 65 6e 65 72 61 74  ** would generat
0a20: 65 20 77 61 72 6e 69 6e 67 20 6d 65 73 73 61 67  e warning messag
0a30: 65 73 20 77 68 65 6e 20 74 68 65 79 20 77 65 72  es when they wer
0a40: 65 20 75 73 65 64 2e 20 20 42 75 74 20 74 68 61  e used.  But tha
0a50: 74 0a 2a 2a 20 63 6f 6d 70 69 6c 65 72 20 6d 61  t.** compiler ma
0a60: 67 69 63 20 65 6e 64 65 64 20 75 70 20 67 65 6e  gic ended up gen
0a70: 65 72 61 74 69 6e 67 20 73 75 63 68 20 61 20 66  erating such a f
0a80: 6c 75 72 72 79 20 6f 66 20 62 75 67 20 72 65 70  lurry of bug rep
0a90: 6f 72 74 73 0a 2a 2a 20 74 68 61 74 20 77 65 20  orts.** that we 
0aa0: 68 61 76 65 20 74 61 6b 65 6e 20 69 74 20 61 6c  have taken it al
0ab0: 6c 20 6f 75 74 20 61 6e 64 20 67 6f 6e 65 20 62  l out and gone b
0ac0: 61 63 6b 20 74 6f 20 75 73 69 6e 67 20 73 69 6d  ack to using sim
0ad0: 70 6c 65 0a 2a 2a 20 6e 6f 6f 70 20 6d 61 63 72  ple.** noop macr
0ae0: 6f 73 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53  os..*/.#define S
0af0: 51 4c 49 54 45 5f 44 45 50 52 45 43 41 54 45 44  QLITE_DEPRECATED
0b00: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
0b10: 45 58 50 45 52 49 4d 45 4e 54 41 4c 0a 0a 2f 2a  EXPERIMENTAL../*
0b20: 0a 2a 2a 20 45 6e 73 75 72 65 20 74 68 65 73 65  .** Ensure these
0b30: 20 73 79 6d 62 6f 6c 73 20 77 65 72 65 20 6e 6f   symbols were no
0b40: 74 20 64 65 66 69 6e 65 64 20 62 79 20 73 6f 6d  t defined by som
0b50: 65 20 70 72 65 76 69 6f 75 73 20 68 65 61 64 65  e previous heade
0b60: 72 20 66 69 6c 65 2e 0a 2a 2f 0a 23 69 66 64 65  r file..*/.#ifde
0b70: 66 20 53 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e  f SQLITE_VERSION
0b80: 0a 23 20 75 6e 64 65 66 20 53 51 4c 49 54 45 5f  .# undef SQLITE_
0b90: 56 45 52 53 49 4f 4e 0a 23 65 6e 64 69 66 0a 23  VERSION.#endif.#
0ba0: 69 66 64 65 66 20 53 51 4c 49 54 45 5f 56 45 52  ifdef SQLITE_VER
0bb0: 53 49 4f 4e 5f 4e 55 4d 42 45 52 0a 23 20 75 6e  SION_NUMBER.# un
0bc0: 64 65 66 20 53 51 4c 49 54 45 5f 56 45 52 53 49  def SQLITE_VERSI
0bd0: 4f 4e 5f 4e 55 4d 42 45 52 0a 23 65 6e 64 69 66  ON_NUMBER.#endif
0be0: 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
0bf0: 3a 20 43 6f 6d 70 69 6c 65 2d 54 69 6d 65 20 4c  : Compile-Time L
0c00: 69 62 72 61 72 79 20 56 65 72 73 69 6f 6e 20 4e  ibrary Version N
0c10: 75 6d 62 65 72 73 0a 2a 2a 0a 2a 2a 20 5e 28 54  umbers.**.** ^(T
0c20: 68 65 20 5b 53 51 4c 49 54 45 5f 56 45 52 53 49  he [SQLITE_VERSI
0c30: 4f 4e 5d 20 43 20 70 72 65 70 72 6f 63 65 73 73  ON] C preprocess
0c40: 6f 72 20 6d 61 63 72 6f 20 69 6e 20 74 68 65 20  or macro in the 
0c50: 73 71 6c 69 74 65 33 2e 68 20 68 65 61 64 65 72  sqlite3.h header
0c60: 0a 2a 2a 20 65 76 61 6c 75 61 74 65 73 20 74 6f  .** evaluates to
0c70: 20 61 20 73 74 72 69 6e 67 20 6c 69 74 65 72 61   a string litera
0c80: 6c 20 74 68 61 74 20 69 73 20 74 68 65 20 53 51  l that is the SQ
0c90: 4c 69 74 65 20 76 65 72 73 69 6f 6e 20 69 6e 20  Lite version in 
0ca0: 74 68 65 0a 2a 2a 20 66 6f 72 6d 61 74 20 22 58  the.** format "X
0cb0: 2e 59 2e 5a 22 20 77 68 65 72 65 20 58 20 69 73  .Y.Z" where X is
0cc0: 20 74 68 65 20 6d 61 6a 6f 72 20 76 65 72 73 69   the major versi
0cd0: 6f 6e 20 6e 75 6d 62 65 72 20 28 61 6c 77 61 79  on number (alway
0ce0: 73 20 33 20 66 6f 72 0a 2a 2a 20 53 51 4c 69 74  s 3 for.** SQLit
0cf0: 65 33 29 20 61 6e 64 20 59 20 69 73 20 74 68 65  e3) and Y is the
0d00: 20 6d 69 6e 6f 72 20 76 65 72 73 69 6f 6e 20 6e   minor version n
0d10: 75 6d 62 65 72 20 61 6e 64 20 5a 20 69 73 20 74  umber and Z is t
0d20: 68 65 20 72 65 6c 65 61 73 65 20 6e 75 6d 62 65  he release numbe
0d30: 72 2e 29 5e 0a 2a 2a 20 5e 28 54 68 65 20 5b 53  r.)^.** ^(The [S
0d40: 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e 5f 4e 55  QLITE_VERSION_NU
0d50: 4d 42 45 52 5d 20 43 20 70 72 65 70 72 6f 63 65  MBER] C preproce
0d60: 73 73 6f 72 20 6d 61 63 72 6f 20 72 65 73 6f 6c  ssor macro resol
0d70: 76 65 73 20 74 6f 20 61 6e 20 69 6e 74 65 67 65  ves to an intege
0d80: 72 0a 2a 2a 20 77 69 74 68 20 74 68 65 20 76 61  r.** with the va
0d90: 6c 75 65 20 28 58 2a 31 30 30 30 30 30 30 20 2b  lue (X*1000000 +
0da0: 20 59 2a 31 30 30 30 20 2b 20 5a 29 20 77 68 65   Y*1000 + Z) whe
0db0: 72 65 20 58 2c 20 59 2c 20 61 6e 64 20 5a 20 61  re X, Y, and Z a
0dc0: 72 65 20 74 68 65 20 73 61 6d 65 0a 2a 2a 20 6e  re the same.** n
0dd0: 75 6d 62 65 72 73 20 75 73 65 64 20 69 6e 20 5b  umbers used in [
0de0: 53 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e 5d 2e  SQLITE_VERSION].
0df0: 29 5e 0a 2a 2a 20 54 68 65 20 53 51 4c 49 54 45  )^.** The SQLITE
0e00: 5f 56 45 52 53 49 4f 4e 5f 4e 55 4d 42 45 52 20  _VERSION_NUMBER 
0e10: 66 6f 72 20 61 6e 79 20 67 69 76 65 6e 20 72 65  for any given re
0e20: 6c 65 61 73 65 20 6f 66 20 53 51 4c 69 74 65 20  lease of SQLite 
0e30: 77 69 6c 6c 20 61 6c 73 6f 0a 2a 2a 20 62 65 20  will also.** be 
0e40: 6c 61 72 67 65 72 20 74 68 61 6e 20 74 68 65 20  larger than the 
0e50: 72 65 6c 65 61 73 65 20 66 72 6f 6d 20 77 68 69  release from whi
0e60: 63 68 20 69 74 20 69 73 20 64 65 72 69 76 65 64  ch it is derived
0e70: 2e 20 20 45 69 74 68 65 72 20 59 20 77 69 6c 6c  .  Either Y will
0e80: 0a 2a 2a 20 62 65 20 68 65 6c 64 20 63 6f 6e 73  .** be held cons
0e90: 74 61 6e 74 20 61 6e 64 20 5a 20 77 69 6c 6c 20  tant and Z will 
0ea0: 62 65 20 69 6e 63 72 65 6d 65 6e 74 65 64 20 6f  be incremented o
0eb0: 72 20 65 6c 73 65 20 59 20 77 69 6c 6c 20 62 65  r else Y will be
0ec0: 20 69 6e 63 72 65 6d 65 6e 74 65 64 0a 2a 2a 20   incremented.** 
0ed0: 61 6e 64 20 5a 20 77 69 6c 6c 20 62 65 20 72 65  and Z will be re
0ee0: 73 65 74 20 74 6f 20 7a 65 72 6f 2e 0a 2a 2a 0a  set to zero..**.
0ef0: 2a 2a 20 53 69 6e 63 65 20 76 65 72 73 69 6f 6e  ** Since version
0f00: 20 33 2e 36 2e 31 38 2c 20 53 51 4c 69 74 65 20   3.6.18, SQLite 
0f10: 73 6f 75 72 63 65 20 63 6f 64 65 20 68 61 73 20  source code has 
0f20: 62 65 65 6e 20 73 74 6f 72 65 64 20 69 6e 20 74  been stored in t
0f30: 68 65 0a 2a 2a 20 3c 61 20 68 72 65 66 3d 22 68  he.** <a href="h
0f40: 74 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c  ttp://www.fossil
0f50: 2d 73 63 6d 2e 6f 72 67 2f 22 3e 46 6f 73 73 69  -scm.org/">Fossi
0f60: 6c 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20  l configuration 
0f70: 6d 61 6e 61 67 65 6d 65 6e 74 0a 2a 2a 20 73 79  management.** sy
0f80: 73 74 65 6d 3c 2f 61 3e 2e 20 20 5e 54 68 65 20  stem</a>.  ^The 
0f90: 53 51 4c 49 54 45 5f 53 4f 55 52 43 45 5f 49 44  SQLITE_SOURCE_ID
0fa0: 20 6d 61 63 72 6f 20 65 76 61 6c 75 61 74 65 73   macro evaluates
0fb0: 20 74 6f 0a 2a 2a 20 61 20 73 74 72 69 6e 67 20   to.** a string 
0fc0: 77 68 69 63 68 20 69 64 65 6e 74 69 66 69 65 73  which identifies
0fd0: 20 61 20 70 61 72 74 69 63 75 6c 61 72 20 63 68   a particular ch
0fe0: 65 63 6b 2d 69 6e 20 6f 66 20 53 51 4c 69 74 65  eck-in of SQLite
0ff0: 0a 2a 2a 20 77 69 74 68 69 6e 20 69 74 73 20 63  .** within its c
1000: 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d 61 6e  onfiguration man
1010: 61 67 65 6d 65 6e 74 20 73 79 73 74 65 6d 2e 20  agement system. 
1020: 20 5e 54 68 65 20 53 51 4c 49 54 45 5f 53 4f 55   ^The SQLITE_SOU
1030: 52 43 45 5f 49 44 0a 2a 2a 20 73 74 72 69 6e 67  RCE_ID.** string
1040: 20 63 6f 6e 74 61 69 6e 73 20 74 68 65 20 64 61   contains the da
1050: 74 65 20 61 6e 64 20 74 69 6d 65 20 6f 66 20 74  te and time of t
1060: 68 65 20 63 68 65 63 6b 2d 69 6e 20 28 55 54 43  he check-in (UTC
1070: 29 20 61 6e 64 20 61 6e 20 53 48 41 31 0a 2a 2a  ) and an SHA1.**
1080: 20 68 61 73 68 20 6f 66 20 74 68 65 20 65 6e 74   hash of the ent
1090: 69 72 65 20 73 6f 75 72 63 65 20 74 72 65 65 2e  ire source tree.
10a0: 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 3a  .**.** See also:
10b0: 20 5b 73 71 6c 69 74 65 33 5f 6c 69 62 76 65 72   [sqlite3_libver
10c0: 73 69 6f 6e 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c  sion()],.** [sql
10d0: 69 74 65 33 5f 6c 69 62 76 65 72 73 69 6f 6e 5f  ite3_libversion_
10e0: 6e 75 6d 62 65 72 28 29 5d 2c 20 5b 73 71 6c 69  number()], [sqli
10f0: 74 65 33 5f 73 6f 75 72 63 65 69 64 28 29 5d 2c  te3_sourceid()],
1100: 0a 2a 2a 20 5b 73 71 6c 69 74 65 5f 76 65 72 73  .** [sqlite_vers
1110: 69 6f 6e 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69  ion()] and [sqli
1120: 74 65 5f 73 6f 75 72 63 65 5f 69 64 28 29 5d 2e  te_source_id()].
1130: 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  .*/.#define SQLI
1140: 54 45 5f 56 45 52 53 49 4f 4e 20 20 20 20 20 20  TE_VERSION      
1150: 20 20 22 2d 2d 56 45 52 53 2d 2d 22 0a 23 64 65    "--VERS--".#de
1160: 66 69 6e 65 20 53 51 4c 49 54 45 5f 56 45 52 53  fine SQLITE_VERS
1170: 49 4f 4e 5f 4e 55 4d 42 45 52 20 2d 2d 56 45 52  ION_NUMBER --VER
1180: 53 49 4f 4e 2d 4e 55 4d 42 45 52 2d 2d 0a 23 64  SION-NUMBER--.#d
1190: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53 4f 55  efine SQLITE_SOU
11a0: 52 43 45 5f 49 44 20 20 20 20 20 20 22 2d 2d 53  RCE_ID      "--S
11b0: 4f 55 52 43 45 2d 49 44 2d 2d 22 0a 0a 2f 2a 0a  OURCE-ID--"../*.
11c0: 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 52 75 6e  ** CAPI3REF: Run
11d0: 2d 54 69 6d 65 20 4c 69 62 72 61 72 79 20 56 65  -Time Library Ve
11e0: 72 73 69 6f 6e 20 4e 75 6d 62 65 72 73 0a 2a 2a  rsion Numbers.**
11f0: 20 4b 45 59 57 4f 52 44 53 3a 20 73 71 6c 69 74   KEYWORDS: sqlit
1200: 65 33 5f 76 65 72 73 69 6f 6e 2c 20 73 71 6c 69  e3_version, sqli
1210: 74 65 33 5f 73 6f 75 72 63 65 69 64 0a 2a 2a 0a  te3_sourceid.**.
1220: 2a 2a 20 54 68 65 73 65 20 69 6e 74 65 72 66 61  ** These interfa
1230: 63 65 73 20 70 72 6f 76 69 64 65 20 74 68 65 20  ces provide the 
1240: 73 61 6d 65 20 69 6e 66 6f 72 6d 61 74 69 6f 6e  same information
1250: 20 61 73 20 74 68 65 20 5b 53 51 4c 49 54 45 5f   as the [SQLITE_
1260: 56 45 52 53 49 4f 4e 5d 2c 0a 2a 2a 20 5b 53 51  VERSION],.** [SQ
1270: 4c 49 54 45 5f 56 45 52 53 49 4f 4e 5f 4e 55 4d  LITE_VERSION_NUM
1280: 42 45 52 5d 2c 20 61 6e 64 20 5b 53 51 4c 49 54  BER], and [SQLIT
1290: 45 5f 53 4f 55 52 43 45 5f 49 44 5d 20 43 20 70  E_SOURCE_ID] C p
12a0: 72 65 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72  reprocessor macr
12b0: 6f 73 0a 2a 2a 20 62 75 74 20 61 72 65 20 61 73  os.** but are as
12c0: 73 6f 63 69 61 74 65 64 20 77 69 74 68 20 74 68  sociated with th
12d0: 65 20 6c 69 62 72 61 72 79 20 69 6e 73 74 65 61  e library instea
12e0: 64 20 6f 66 20 74 68 65 20 68 65 61 64 65 72 20  d of the header 
12f0: 66 69 6c 65 2e 20 20 5e 28 43 61 75 74 69 6f 75  file.  ^(Cautiou
1300: 73 0a 2a 2a 20 70 72 6f 67 72 61 6d 6d 65 72 73  s.** programmers
1310: 20 6d 69 67 68 74 20 69 6e 63 6c 75 64 65 20 61   might include a
1320: 73 73 65 72 74 28 29 20 73 74 61 74 65 6d 65 6e  ssert() statemen
1330: 74 73 20 69 6e 20 74 68 65 69 72 20 61 70 70 6c  ts in their appl
1340: 69 63 61 74 69 6f 6e 20 74 6f 0a 2a 2a 20 76 65  ication to.** ve
1350: 72 69 66 79 20 74 68 61 74 20 76 61 6c 75 65 73  rify that values
1360: 20 72 65 74 75 72 6e 65 64 20 62 79 20 74 68 65   returned by the
1370: 73 65 20 69 6e 74 65 72 66 61 63 65 73 20 6d 61  se interfaces ma
1380: 74 63 68 20 74 68 65 20 6d 61 63 72 6f 73 20 69  tch the macros i
1390: 6e 0a 2a 2a 20 74 68 65 20 68 65 61 64 65 72 2c  n.** the header,
13a0: 20 61 6e 64 20 74 68 75 73 20 65 6e 73 75 72 65   and thus ensure
13b0: 20 74 68 61 74 20 74 68 65 20 61 70 70 6c 69 63   that the applic
13c0: 61 74 69 6f 6e 20 69 73 0a 2a 2a 20 63 6f 6d 70  ation is.** comp
13d0: 69 6c 65 64 20 77 69 74 68 20 6d 61 74 63 68 69  iled with matchi
13e0: 6e 67 20 6c 69 62 72 61 72 79 20 61 6e 64 20 68  ng library and h
13f0: 65 61 64 65 72 20 66 69 6c 65 73 2e 0a 2a 2a 0a  eader files..**.
1400: 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c  ** <blockquote><
1410: 70 72 65 3e 0a 2a 2a 20 61 73 73 65 72 74 28 20  pre>.** assert( 
1420: 73 71 6c 69 74 65 33 5f 6c 69 62 76 65 72 73 69  sqlite3_libversi
1430: 6f 6e 5f 6e 75 6d 62 65 72 28 29 3d 3d 53 51 4c  on_number()==SQL
1440: 49 54 45 5f 56 45 52 53 49 4f 4e 5f 4e 55 4d 42  ITE_VERSION_NUMB
1450: 45 52 20 29 3b 0a 2a 2a 20 61 73 73 65 72 74 28  ER );.** assert(
1460: 20 73 74 72 63 6d 70 28 73 71 6c 69 74 65 33 5f   strcmp(sqlite3_
1470: 73 6f 75 72 63 65 69 64 28 29 2c 53 51 4c 49 54  sourceid(),SQLIT
1480: 45 5f 53 4f 55 52 43 45 5f 49 44 29 3d 3d 30 20  E_SOURCE_ID)==0 
1490: 29 3b 0a 2a 2a 20 61 73 73 65 72 74 28 20 73 74  );.** assert( st
14a0: 72 63 6d 70 28 73 71 6c 69 74 65 33 5f 6c 69 62  rcmp(sqlite3_lib
14b0: 76 65 72 73 69 6f 6e 28 29 2c 53 51 4c 49 54 45  version(),SQLITE
14c0: 5f 56 45 52 53 49 4f 4e 29 3d 3d 30 20 29 3b 0a  _VERSION)==0 );.
14d0: 2a 2a 20 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b  ** </pre></block
14e0: 71 75 6f 74 65 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5e  quote>)^.**.** ^
14f0: 54 68 65 20 73 71 6c 69 74 65 33 5f 76 65 72 73  The sqlite3_vers
1500: 69 6f 6e 5b 5d 20 73 74 72 69 6e 67 20 63 6f 6e  ion[] string con
1510: 73 74 61 6e 74 20 63 6f 6e 74 61 69 6e 73 20 74  stant contains t
1520: 68 65 20 74 65 78 74 20 6f 66 20 5b 53 51 4c 49  he text of [SQLI
1530: 54 45 5f 56 45 52 53 49 4f 4e 5d 0a 2a 2a 20 6d  TE_VERSION].** m
1540: 61 63 72 6f 2e 20 20 5e 54 68 65 20 73 71 6c 69  acro.  ^The sqli
1550: 74 65 33 5f 6c 69 62 76 65 72 73 69 6f 6e 28 29  te3_libversion()
1560: 20 66 75 6e 63 74 69 6f 6e 20 72 65 74 75 72 6e   function return
1570: 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74  s a pointer to t
1580: 68 65 0a 2a 2a 20 74 6f 20 74 68 65 20 73 71 6c  he.** to the sql
1590: 69 74 65 33 5f 76 65 72 73 69 6f 6e 5b 5d 20 73  ite3_version[] s
15a0: 74 72 69 6e 67 20 63 6f 6e 73 74 61 6e 74 2e 20  tring constant. 
15b0: 20 54 68 65 20 73 71 6c 69 74 65 33 5f 6c 69 62   The sqlite3_lib
15c0: 76 65 72 73 69 6f 6e 28 29 0a 2a 2a 20 66 75 6e  version().** fun
15d0: 63 74 69 6f 6e 20 69 73 20 70 72 6f 76 69 64 65  ction is provide
15e0: 64 20 66 6f 72 20 75 73 65 20 69 6e 20 44 4c 4c  d for use in DLL
15f0: 73 20 73 69 6e 63 65 20 44 4c 4c 20 75 73 65 72  s since DLL user
1600: 73 20 75 73 75 61 6c 6c 79 20 64 6f 20 6e 6f 74  s usually do not
1610: 20 68 61 76 65 0a 2a 2a 20 64 69 72 65 63 74 20   have.** direct 
1620: 61 63 63 65 73 73 20 74 6f 20 73 74 72 69 6e 67  access to string
1630: 20 63 6f 6e 73 74 61 6e 74 73 20 77 69 74 68 69   constants withi
1640: 6e 20 74 68 65 20 44 4c 4c 2e 20 20 5e 54 68 65  n the DLL.  ^The
1650: 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 6c 69 62 76  .** sqlite3_libv
1660: 65 72 73 69 6f 6e 5f 6e 75 6d 62 65 72 28 29 20  ersion_number() 
1670: 66 75 6e 63 74 69 6f 6e 20 72 65 74 75 72 6e 73  function returns
1680: 20 61 6e 20 69 6e 74 65 67 65 72 20 65 71 75 61   an integer equa
1690: 6c 20 74 6f 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f  l to.** [SQLITE_
16a0: 56 45 52 53 49 4f 4e 5f 4e 55 4d 42 45 52 5d 2e  VERSION_NUMBER].
16b0: 20 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 73    ^The sqlite3_s
16c0: 6f 75 72 63 65 69 64 28 29 20 66 75 6e 63 74 69  ourceid() functi
16d0: 6f 6e 20 72 65 74 75 72 6e 73 20 0a 2a 2a 20 61  on returns .** a
16e0: 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20 73 74   pointer to a st
16f0: 72 69 6e 67 20 63 6f 6e 73 74 61 6e 74 20 77 68  ring constant wh
1700: 6f 73 65 20 76 61 6c 75 65 20 69 73 20 74 68 65  ose value is the
1710: 20 73 61 6d 65 20 61 73 20 74 68 65 20 0a 2a 2a   same as the .**
1720: 20 5b 53 51 4c 49 54 45 5f 53 4f 55 52 43 45 5f   [SQLITE_SOURCE_
1730: 49 44 5d 20 43 20 70 72 65 70 72 6f 63 65 73 73  ID] C preprocess
1740: 6f 72 20 6d 61 63 72 6f 2e 0a 2a 2a 0a 2a 2a 20  or macro..**.** 
1750: 53 65 65 20 61 6c 73 6f 3a 20 5b 73 71 6c 69 74  See also: [sqlit
1760: 65 5f 76 65 72 73 69 6f 6e 28 29 5d 20 61 6e 64  e_version()] and
1770: 20 5b 73 71 6c 69 74 65 5f 73 6f 75 72 63 65 5f   [sqlite_source_
1780: 69 64 28 29 5d 2e 0a 2a 2f 0a 53 51 4c 49 54 45  id()]..*/.SQLITE
1790: 5f 45 58 54 45 52 4e 20 63 6f 6e 73 74 20 63 68  _EXTERN const ch
17a0: 61 72 20 73 71 6c 69 74 65 33 5f 76 65 72 73 69  ar sqlite3_versi
17b0: 6f 6e 5b 5d 3b 0a 63 6f 6e 73 74 20 63 68 61 72  on[];.const char
17c0: 20 2a 73 71 6c 69 74 65 33 5f 6c 69 62 76 65 72   *sqlite3_libver
17d0: 73 69 6f 6e 28 76 6f 69 64 29 3b 0a 63 6f 6e 73  sion(void);.cons
17e0: 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f  t char *sqlite3_
17f0: 73 6f 75 72 63 65 69 64 28 76 6f 69 64 29 3b 0a  sourceid(void);.
1800: 69 6e 74 20 73 71 6c 69 74 65 33 5f 6c 69 62 76  int sqlite3_libv
1810: 65 72 73 69 6f 6e 5f 6e 75 6d 62 65 72 28 76 6f  ersion_number(vo
1820: 69 64 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  id);../*.** CAPI
1830: 33 52 45 46 3a 20 52 75 6e 2d 54 69 6d 65 20 4c  3REF: Run-Time L
1840: 69 62 72 61 72 79 20 43 6f 6d 70 69 6c 61 74 69  ibrary Compilati
1850: 6f 6e 20 4f 70 74 69 6f 6e 73 20 44 69 61 67 6e  on Options Diagn
1860: 6f 73 74 69 63 73 0a 2a 2a 0a 2a 2a 20 5e 54 68  ostics.**.** ^Th
1870: 65 20 73 71 6c 69 74 65 33 5f 63 6f 6d 70 69 6c  e sqlite3_compil
1880: 65 6f 70 74 69 6f 6e 5f 75 73 65 64 28 29 20 66  eoption_used() f
1890: 75 6e 63 74 69 6f 6e 20 72 65 74 75 72 6e 73 20  unction returns 
18a0: 30 20 6f 72 20 31 20 0a 2a 2a 20 69 6e 64 69 63  0 or 1 .** indic
18b0: 61 74 69 6e 67 20 77 68 65 74 68 65 72 20 74 68  ating whether th
18c0: 65 20 73 70 65 63 69 66 69 65 64 20 6f 70 74 69  e specified opti
18d0: 6f 6e 20 77 61 73 20 64 65 66 69 6e 65 64 20 61  on was defined a
18e0: 74 20 0a 2a 2a 20 63 6f 6d 70 69 6c 65 20 74 69  t .** compile ti
18f0: 6d 65 2e 20 20 5e 54 68 65 20 53 51 4c 49 54 45  me.  ^The SQLITE
1900: 5f 20 70 72 65 66 69 78 20 6d 61 79 20 62 65 20  _ prefix may be 
1910: 6f 6d 69 74 74 65 64 20 66 72 6f 6d 20 74 68 65  omitted from the
1920: 20 0a 2a 2a 20 6f 70 74 69 6f 6e 20 6e 61 6d 65   .** option name
1930: 20 70 61 73 73 65 64 20 74 6f 20 73 71 6c 69 74   passed to sqlit
1940: 65 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e  e3_compileoption
1950: 5f 75 73 65 64 28 29 2e 20 20 0a 2a 2a 0a 2a 2a  _used().  .**.**
1960: 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 63 6f   ^The sqlite3_co
1970: 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 67 65 74 28  mpileoption_get(
1980: 29 20 66 75 6e 63 74 69 6f 6e 20 61 6c 6c 6f 77  ) function allow
1990: 73 20 69 74 65 72 61 74 69 6e 67 0a 2a 2a 20 6f  s iterating.** o
19a0: 76 65 72 20 74 68 65 20 6c 69 73 74 20 6f 66 20  ver the list of 
19b0: 6f 70 74 69 6f 6e 73 20 74 68 61 74 20 77 65 72  options that wer
19c0: 65 20 64 65 66 69 6e 65 64 20 61 74 20 63 6f 6d  e defined at com
19d0: 70 69 6c 65 20 74 69 6d 65 20 62 79 0a 2a 2a 20  pile time by.** 
19e0: 72 65 74 75 72 6e 69 6e 67 20 74 68 65 20 4e 2d  returning the N-
19f0: 74 68 20 63 6f 6d 70 69 6c 65 20 74 69 6d 65 20  th compile time 
1a00: 6f 70 74 69 6f 6e 20 73 74 72 69 6e 67 2e 20 20  option string.  
1a10: 5e 49 66 20 4e 20 69 73 20 6f 75 74 20 6f 66 20  ^If N is out of 
1a20: 72 61 6e 67 65 2c 0a 2a 2a 20 73 71 6c 69 74 65  range,.** sqlite
1a30: 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f  3_compileoption_
1a40: 67 65 74 28 29 20 72 65 74 75 72 6e 73 20 61 20  get() returns a 
1a50: 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2e 20 20 5e  NULL pointer.  ^
1a60: 54 68 65 20 53 51 4c 49 54 45 5f 20 0a 2a 2a 20  The SQLITE_ .** 
1a70: 70 72 65 66 69 78 20 69 73 20 6f 6d 69 74 74 65  prefix is omitte
1a80: 64 20 66 72 6f 6d 20 61 6e 79 20 73 74 72 69 6e  d from any strin
1a90: 67 73 20 72 65 74 75 72 6e 65 64 20 62 79 20 0a  gs returned by .
1aa0: 2a 2a 20 73 71 6c 69 74 65 33 5f 63 6f 6d 70 69  ** sqlite3_compi
1ab0: 6c 65 6f 70 74 69 6f 6e 5f 67 65 74 28 29 2e 0a  leoption_get()..
1ac0: 2a 2a 0a 2a 2a 20 5e 53 75 70 70 6f 72 74 20 66  **.** ^Support f
1ad0: 6f 72 20 74 68 65 20 64 69 61 67 6e 6f 73 74 69  or the diagnosti
1ae0: 63 20 66 75 6e 63 74 69 6f 6e 73 20 73 71 6c 69  c functions sqli
1af0: 74 65 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f  te3_compileoptio
1b00: 6e 5f 75 73 65 64 28 29 0a 2a 2a 20 61 6e 64 20  n_used().** and 
1b10: 73 71 6c 69 74 65 33 5f 63 6f 6d 70 69 6c 65 6f  sqlite3_compileo
1b20: 70 74 69 6f 6e 5f 67 65 74 28 29 20 6d 61 79 20  ption_get() may 
1b30: 62 65 20 6f 6d 69 74 74 65 64 20 62 79 20 73 70  be omitted by sp
1b40: 65 63 69 66 79 69 6e 67 20 74 68 65 20 0a 2a 2a  ecifying the .**
1b50: 20 5b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 43 4f   [SQLITE_OMIT_CO
1b60: 4d 50 49 4c 45 4f 50 54 49 4f 4e 5f 44 49 41 47  MPILEOPTION_DIAG
1b70: 53 5d 20 6f 70 74 69 6f 6e 20 61 74 20 63 6f 6d  S] option at com
1b80: 70 69 6c 65 20 74 69 6d 65 2e 0a 2a 2a 0a 2a 2a  pile time..**.**
1b90: 20 53 65 65 20 61 6c 73 6f 3a 20 53 51 4c 20 66   See also: SQL f
1ba0: 75 6e 63 74 69 6f 6e 73 20 5b 73 71 6c 69 74 65  unctions [sqlite
1bb0: 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 75  _compileoption_u
1bc0: 73 65 64 28 29 5d 20 61 6e 64 0a 2a 2a 20 5b 73  sed()] and.** [s
1bd0: 71 6c 69 74 65 5f 63 6f 6d 70 69 6c 65 6f 70 74  qlite_compileopt
1be0: 69 6f 6e 5f 67 65 74 28 29 5d 20 61 6e 64 20 74  ion_get()] and t
1bf0: 68 65 20 5b 63 6f 6d 70 69 6c 65 5f 6f 70 74 69  he [compile_opti
1c00: 6f 6e 73 20 70 72 61 67 6d 61 5d 2e 0a 2a 2f 0a  ons pragma]..*/.
1c10: 23 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f  #ifndef SQLITE_O
1c20: 4d 49 54 5f 43 4f 4d 50 49 4c 45 4f 50 54 49 4f  MIT_COMPILEOPTIO
1c30: 4e 5f 44 49 41 47 53 0a 69 6e 74 20 73 71 6c 69  N_DIAGS.int sqli
1c40: 74 65 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f  te3_compileoptio
1c50: 6e 5f 75 73 65 64 28 63 6f 6e 73 74 20 63 68 61  n_used(const cha
1c60: 72 20 2a 7a 4f 70 74 4e 61 6d 65 29 3b 0a 63 6f  r *zOptName);.co
1c70: 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65  nst char *sqlite
1c80: 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f  3_compileoption_
1c90: 67 65 74 28 69 6e 74 20 4e 29 3b 0a 23 65 6e 64  get(int N);.#end
1ca0: 69 66 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  if../*.** CAPI3R
1cb0: 45 46 3a 20 54 65 73 74 20 54 6f 20 53 65 65 20  EF: Test To See 
1cc0: 49 66 20 54 68 65 20 4c 69 62 72 61 72 79 20 49  If The Library I
1cd0: 73 20 54 68 72 65 61 64 73 61 66 65 0a 2a 2a 0a  s Threadsafe.**.
1ce0: 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  ** ^The sqlite3_
1cf0: 74 68 72 65 61 64 73 61 66 65 28 29 20 66 75 6e  threadsafe() fun
1d00: 63 74 69 6f 6e 20 72 65 74 75 72 6e 73 20 7a 65  ction returns ze
1d10: 72 6f 20 69 66 20 61 6e 64 20 6f 6e 6c 79 20 69  ro if and only i
1d20: 66 0a 2a 2a 20 53 51 4c 69 74 65 20 77 61 73 20  f.** SQLite was 
1d30: 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 6d 75  compiled with mu
1d40: 74 65 78 69 6e 67 20 63 6f 64 65 20 6f 6d 69 74  texing code omit
1d50: 74 65 64 20 64 75 65 20 74 6f 20 74 68 65 0a 2a  ted due to the.*
1d60: 2a 20 5b 53 51 4c 49 54 45 5f 54 48 52 45 41 44  * [SQLITE_THREAD
1d70: 53 41 46 45 5d 20 63 6f 6d 70 69 6c 65 2d 74 69  SAFE] compile-ti
1d80: 6d 65 20 6f 70 74 69 6f 6e 20 62 65 69 6e 67 20  me option being 
1d90: 73 65 74 20 74 6f 20 30 2e 0a 2a 2a 0a 2a 2a 20  set to 0..**.** 
1da0: 53 51 4c 69 74 65 20 63 61 6e 20 62 65 20 63 6f  SQLite can be co
1db0: 6d 70 69 6c 65 64 20 77 69 74 68 20 6f 72 20 77  mpiled with or w
1dc0: 69 74 68 6f 75 74 20 6d 75 74 65 78 65 73 2e 20  ithout mutexes. 
1dd0: 20 57 68 65 6e 0a 2a 2a 20 74 68 65 20 5b 53 51   When.** the [SQ
1de0: 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45 5d  LITE_THREADSAFE]
1df0: 20 43 20 70 72 65 70 72 6f 63 65 73 73 6f 72 20   C preprocessor 
1e00: 6d 61 63 72 6f 20 69 73 20 31 20 6f 72 20 32 2c  macro is 1 or 2,
1e10: 20 6d 75 74 65 78 65 73 0a 2a 2a 20 61 72 65 20   mutexes.** are 
1e20: 65 6e 61 62 6c 65 64 20 61 6e 64 20 53 51 4c 69  enabled and SQLi
1e30: 74 65 20 69 73 20 74 68 72 65 61 64 73 61 66 65  te is threadsafe
1e40: 2e 20 20 57 68 65 6e 20 74 68 65 0a 2a 2a 20 5b  .  When the.** [
1e50: 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46  SQLITE_THREADSAF
1e60: 45 5d 20 6d 61 63 72 6f 20 69 73 20 30 2c 20 0a  E] macro is 0, .
1e70: 2a 2a 20 74 68 65 20 6d 75 74 65 78 65 73 20 61  ** the mutexes a
1e80: 72 65 20 6f 6d 69 74 74 65 64 2e 20 20 57 69 74  re omitted.  Wit
1e90: 68 6f 75 74 20 74 68 65 20 6d 75 74 65 78 65 73  hout the mutexes
1ea0: 2c 20 69 74 20 69 73 20 6e 6f 74 20 73 61 66 65  , it is not safe
1eb0: 0a 2a 2a 20 74 6f 20 75 73 65 20 53 51 4c 69 74  .** to use SQLit
1ec0: 65 20 63 6f 6e 63 75 72 72 65 6e 74 6c 79 20 66  e concurrently f
1ed0: 72 6f 6d 20 6d 6f 72 65 20 74 68 61 6e 20 6f 6e  rom more than on
1ee0: 65 20 74 68 72 65 61 64 2e 0a 2a 2a 0a 2a 2a 20  e thread..**.** 
1ef0: 45 6e 61 62 6c 69 6e 67 20 6d 75 74 65 78 65 73  Enabling mutexes
1f00: 20 69 6e 63 75 72 73 20 61 20 6d 65 61 73 75 72   incurs a measur
1f10: 61 62 6c 65 20 70 65 72 66 6f 72 6d 61 6e 63 65  able performance
1f20: 20 70 65 6e 61 6c 74 79 2e 0a 2a 2a 20 53 6f 20   penalty..** So 
1f30: 69 66 20 73 70 65 65 64 20 69 73 20 6f 66 20 75  if speed is of u
1f40: 74 6d 6f 73 74 20 69 6d 70 6f 72 74 61 6e 63 65  tmost importance
1f50: 2c 20 69 74 20 6d 61 6b 65 73 20 73 65 6e 73 65  , it makes sense
1f60: 20 74 6f 20 64 69 73 61 62 6c 65 0a 2a 2a 20 74   to disable.** t
1f70: 68 65 20 6d 75 74 65 78 65 73 2e 20 20 42 75 74  he mutexes.  But
1f80: 20 66 6f 72 20 6d 61 78 69 6d 75 6d 20 73 61 66   for maximum saf
1f90: 65 74 79 2c 20 6d 75 74 65 78 65 73 20 73 68 6f  ety, mutexes sho
1fa0: 75 6c 64 20 62 65 20 65 6e 61 62 6c 65 64 2e 0a  uld be enabled..
1fb0: 2a 2a 20 5e 54 68 65 20 64 65 66 61 75 6c 74 20  ** ^The default 
1fc0: 62 65 68 61 76 69 6f 72 20 69 73 20 66 6f 72 20  behavior is for 
1fd0: 6d 75 74 65 78 65 73 20 74 6f 20 62 65 20 65 6e  mutexes to be en
1fe0: 61 62 6c 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 69  abled..**.** Thi
1ff0: 73 20 69 6e 74 65 72 66 61 63 65 20 63 61 6e 20  s interface can 
2000: 62 65 20 75 73 65 64 20 62 79 20 61 6e 20 61 70  be used by an ap
2010: 70 6c 69 63 61 74 69 6f 6e 20 74 6f 20 6d 61 6b  plication to mak
2020: 65 20 73 75 72 65 20 74 68 61 74 20 74 68 65 0a  e sure that the.
2030: 2a 2a 20 76 65 72 73 69 6f 6e 20 6f 66 20 53 51  ** version of SQ
2040: 4c 69 74 65 20 74 68 61 74 20 69 74 20 69 73 20  Lite that it is 
2050: 6c 69 6e 6b 69 6e 67 20 61 67 61 69 6e 73 74 20  linking against 
2060: 77 61 73 20 63 6f 6d 70 69 6c 65 64 20 77 69 74  was compiled wit
2070: 68 0a 2a 2a 20 74 68 65 20 64 65 73 69 72 65 64  h.** the desired
2080: 20 73 65 74 74 69 6e 67 20 6f 66 20 74 68 65 20   setting of the 
2090: 5b 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41  [SQLITE_THREADSA
20a0: 46 45 5d 20 6d 61 63 72 6f 2e 0a 2a 2a 0a 2a 2a  FE] macro..**.**
20b0: 20 54 68 69 73 20 69 6e 74 65 72 66 61 63 65 20   This interface 
20c0: 6f 6e 6c 79 20 72 65 70 6f 72 74 73 20 6f 6e 20  only reports on 
20d0: 74 68 65 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65  the compile-time
20e0: 20 6d 75 74 65 78 20 73 65 74 74 69 6e 67 0a 2a   mutex setting.*
20f0: 2a 20 6f 66 20 74 68 65 20 5b 53 51 4c 49 54 45  * of the [SQLITE
2100: 5f 54 48 52 45 41 44 53 41 46 45 5d 20 66 6c 61  _THREADSAFE] fla
2110: 67 2e 20 20 49 66 20 53 51 4c 69 74 65 20 69 73  g.  If SQLite is
2120: 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 0a 2a   compiled with.*
2130: 2a 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53  * SQLITE_THREADS
2140: 41 46 45 3d 31 20 6f 72 20 3d 32 20 74 68 65 6e  AFE=1 or =2 then
2150: 20 6d 75 74 65 78 65 73 20 61 72 65 20 65 6e 61   mutexes are ena
2160: 62 6c 65 64 20 62 79 20 64 65 66 61 75 6c 74 20  bled by default 
2170: 62 75 74 0a 2a 2a 20 63 61 6e 20 62 65 20 66 75  but.** can be fu
2180: 6c 6c 79 20 6f 72 20 70 61 72 74 69 61 6c 6c 79  lly or partially
2190: 20 64 69 73 61 62 6c 65 64 20 75 73 69 6e 67 20   disabled using 
21a0: 61 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c 69 74  a call to [sqlit
21b0: 65 33 5f 63 6f 6e 66 69 67 28 29 5d 0a 2a 2a 20  e3_config()].** 
21c0: 77 69 74 68 20 74 68 65 20 76 65 72 62 73 20 5b  with the verbs [
21d0: 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 49  SQLITE_CONFIG_SI
21e0: 4e 47 4c 45 54 48 52 45 41 44 5d 2c 20 5b 53 51  NGLETHREAD], [SQ
21f0: 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 55 4c 54  LITE_CONFIG_MULT
2200: 49 54 48 52 45 41 44 5d 2c 0a 2a 2a 20 6f 72 20  ITHREAD],.** or 
2210: 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53  [SQLITE_CONFIG_S
2220: 45 52 49 41 4c 49 5a 45 44 5d 2e 20 20 5e 28 54  ERIALIZED].  ^(T
2230: 68 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 20  he return value 
2240: 6f 66 20 74 68 65 0a 2a 2a 20 73 71 6c 69 74 65  of the.** sqlite
2250: 33 5f 74 68 72 65 61 64 73 61 66 65 28 29 20 66  3_threadsafe() f
2260: 75 6e 63 74 69 6f 6e 20 73 68 6f 77 73 20 6f 6e  unction shows on
2270: 6c 79 20 74 68 65 20 63 6f 6d 70 69 6c 65 2d 74  ly the compile-t
2280: 69 6d 65 20 73 65 74 74 69 6e 67 20 6f 66 0a 2a  ime setting of.*
2290: 2a 20 74 68 72 65 61 64 20 73 61 66 65 74 79 2c  * thread safety,
22a0: 20 6e 6f 74 20 61 6e 79 20 72 75 6e 2d 74 69 6d   not any run-tim
22b0: 65 20 63 68 61 6e 67 65 73 20 74 6f 20 74 68 61  e changes to tha
22c0: 74 20 73 65 74 74 69 6e 67 20 6d 61 64 65 20 62  t setting made b
22d0: 79 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63 6f 6e  y.** sqlite3_con
22e0: 66 69 67 28 29 2e 20 49 6e 20 6f 74 68 65 72 20  fig(). In other 
22f0: 77 6f 72 64 73 2c 20 74 68 65 20 72 65 74 75 72  words, the retur
2300: 6e 20 76 61 6c 75 65 20 66 72 6f 6d 20 73 71 6c  n value from sql
2310: 69 74 65 33 5f 74 68 72 65 61 64 73 61 66 65 28  ite3_threadsafe(
2320: 29 0a 2a 2a 20 69 73 20 75 6e 63 68 61 6e 67 65  ).** is unchange
2330: 64 20 62 79 20 63 61 6c 6c 73 20 74 6f 20 73 71  d by calls to sq
2340: 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 2e 29  lite3_config().)
2350: 5e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 74 68 65 20  ^.**.** See the 
2360: 5b 74 68 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d  [threading mode]
2370: 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66   documentation f
2380: 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c 20 69 6e  or additional in
2390: 66 6f 72 6d 61 74 69 6f 6e 2e 0a 2a 2f 0a 69 6e  formation..*/.in
23a0: 74 20 73 71 6c 69 74 65 33 5f 74 68 72 65 61 64  t sqlite3_thread
23b0: 73 61 66 65 28 76 6f 69 64 29 3b 0a 0a 2f 2a 0a  safe(void);../*.
23c0: 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 44 61 74  ** CAPI3REF: Dat
23d0: 61 62 61 73 65 20 43 6f 6e 6e 65 63 74 69 6f 6e  abase Connection
23e0: 20 48 61 6e 64 6c 65 0a 2a 2a 20 4b 45 59 57 4f   Handle.** KEYWO
23f0: 52 44 53 3a 20 7b 64 61 74 61 62 61 73 65 20 63  RDS: {database c
2400: 6f 6e 6e 65 63 74 69 6f 6e 7d 20 7b 64 61 74 61  onnection} {data
2410: 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73  base connections
2420: 7d 0a 2a 2a 0a 2a 2a 20 45 61 63 68 20 6f 70 65  }.**.** Each ope
2430: 6e 20 53 51 4c 69 74 65 20 64 61 74 61 62 61 73  n SQLite databas
2440: 65 20 69 73 20 72 65 70 72 65 73 65 6e 74 65 64  e is represented
2450: 20 62 79 20 61 20 70 6f 69 6e 74 65 72 20 74 6f   by a pointer to
2460: 20 61 6e 20 69 6e 73 74 61 6e 63 65 20 6f 66 0a   an instance of.
2470: 2a 2a 20 74 68 65 20 6f 70 61 71 75 65 20 73 74  ** the opaque st
2480: 72 75 63 74 75 72 65 20 6e 61 6d 65 64 20 22 73  ructure named "s
2490: 71 6c 69 74 65 33 22 2e 20 20 49 74 20 69 73 20  qlite3".  It is 
24a0: 75 73 65 66 75 6c 20 74 6f 20 74 68 69 6e 6b 20  useful to think 
24b0: 6f 66 20 61 6e 20 73 71 6c 69 74 65 33 0a 2a 2a  of an sqlite3.**
24c0: 20 70 6f 69 6e 74 65 72 20 61 73 20 61 6e 20 6f   pointer as an o
24d0: 62 6a 65 63 74 2e 20 20 54 68 65 20 5b 73 71 6c  bject.  The [sql
24e0: 69 74 65 33 5f 6f 70 65 6e 28 29 5d 2c 20 5b 73  ite3_open()], [s
24f0: 71 6c 69 74 65 33 5f 6f 70 65 6e 31 36 28 29 5d  qlite3_open16()]
2500: 2c 20 61 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74 65  , and.** [sqlite
2510: 33 5f 6f 70 65 6e 5f 76 32 28 29 5d 20 69 6e 74  3_open_v2()] int
2520: 65 72 66 61 63 65 73 20 61 72 65 20 69 74 73 20  erfaces are its 
2530: 63 6f 6e 73 74 72 75 63 74 6f 72 73 2c 20 61 6e  constructors, an
2540: 64 20 5b 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65  d [sqlite3_close
2550: 28 29 5d 0a 2a 2a 20 61 6e 64 20 5b 73 71 6c 69  ()].** and [sqli
2560: 74 65 33 5f 63 6c 6f 73 65 5f 76 32 28 29 5d 20  te3_close_v2()] 
2570: 61 72 65 20 69 74 73 20 64 65 73 74 72 75 63 74  are its destruct
2580: 6f 72 73 2e 20 20 54 68 65 72 65 20 61 72 65 20  ors.  There are 
2590: 6d 61 6e 79 20 6f 74 68 65 72 0a 2a 2a 20 69 6e  many other.** in
25a0: 74 65 72 66 61 63 65 73 20 28 73 75 63 68 20 61  terfaces (such a
25b0: 73 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 70 72  s.** [sqlite3_pr
25c0: 65 70 61 72 65 5f 76 32 28 29 5d 2c 20 5b 73 71  epare_v2()], [sq
25d0: 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e  lite3_create_fun
25e0: 63 74 69 6f 6e 28 29 5d 2c 20 61 6e 64 0a 2a 2a  ction()], and.**
25f0: 20 5b 73 71 6c 69 74 65 33 5f 62 75 73 79 5f 74   [sqlite3_busy_t
2600: 69 6d 65 6f 75 74 28 29 5d 20 74 6f 20 6e 61 6d  imeout()] to nam
2610: 65 20 62 75 74 20 74 68 72 65 65 29 20 74 68 61  e but three) tha
2620: 74 20 61 72 65 20 6d 65 74 68 6f 64 73 20 6f 6e  t are methods on
2630: 20 61 6e 0a 2a 2a 20 73 71 6c 69 74 65 33 20 6f   an.** sqlite3 o
2640: 62 6a 65 63 74 2e 0a 2a 2f 0a 74 79 70 65 64 65  bject..*/.typede
2650: 66 20 73 74 72 75 63 74 20 73 71 6c 69 74 65 33  f struct sqlite3
2660: 20 73 71 6c 69 74 65 33 3b 0a 0a 2f 2a 0a 2a 2a   sqlite3;../*.**
2670: 20 43 41 50 49 33 52 45 46 3a 20 36 34 2d 42 69   CAPI3REF: 64-Bi
2680: 74 20 49 6e 74 65 67 65 72 20 54 79 70 65 73 0a  t Integer Types.
2690: 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20 73 71 6c  ** KEYWORDS: sql
26a0: 69 74 65 5f 69 6e 74 36 34 20 73 71 6c 69 74 65  ite_int64 sqlite
26b0: 5f 75 69 6e 74 36 34 0a 2a 2a 0a 2a 2a 20 42 65  _uint64.**.** Be
26c0: 63 61 75 73 65 20 74 68 65 72 65 20 69 73 20 6e  cause there is n
26d0: 6f 20 63 72 6f 73 73 2d 70 6c 61 74 66 6f 72 6d  o cross-platform
26e0: 20 77 61 79 20 74 6f 20 73 70 65 63 69 66 79 20   way to specify 
26f0: 36 34 2d 62 69 74 20 69 6e 74 65 67 65 72 20 74  64-bit integer t
2700: 79 70 65 73 0a 2a 2a 20 53 51 4c 69 74 65 20 69  ypes.** SQLite i
2710: 6e 63 6c 75 64 65 73 20 74 79 70 65 64 65 66 73  ncludes typedefs
2720: 20 66 6f 72 20 36 34 2d 62 69 74 20 73 69 67 6e   for 64-bit sign
2730: 65 64 20 61 6e 64 20 75 6e 73 69 67 6e 65 64 20  ed and unsigned 
2740: 69 6e 74 65 67 65 72 73 2e 0a 2a 2a 0a 2a 2a 20  integers..**.** 
2750: 54 68 65 20 73 71 6c 69 74 65 33 5f 69 6e 74 36  The sqlite3_int6
2760: 34 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 75 69  4 and sqlite3_ui
2770: 6e 74 36 34 20 61 72 65 20 74 68 65 20 70 72 65  nt64 are the pre
2780: 66 65 72 72 65 64 20 74 79 70 65 20 64 65 66 69  ferred type defi
2790: 6e 69 74 69 6f 6e 73 2e 0a 2a 2a 20 54 68 65 20  nitions..** The 
27a0: 73 71 6c 69 74 65 5f 69 6e 74 36 34 20 61 6e 64  sqlite_int64 and
27b0: 20 73 71 6c 69 74 65 5f 75 69 6e 74 36 34 20 74   sqlite_uint64 t
27c0: 79 70 65 73 20 61 72 65 20 73 75 70 70 6f 72 74  ypes are support
27d0: 65 64 20 66 6f 72 20 62 61 63 6b 77 61 72 64 73  ed for backwards
27e0: 0a 2a 2a 20 63 6f 6d 70 61 74 69 62 69 6c 69 74  .** compatibilit
27f0: 79 20 6f 6e 6c 79 2e 0a 2a 2a 0a 2a 2a 20 5e 54  y only..**.** ^T
2800: 68 65 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34  he sqlite3_int64
2810: 20 61 6e 64 20 73 71 6c 69 74 65 5f 69 6e 74 36   and sqlite_int6
2820: 34 20 74 79 70 65 73 20 63 61 6e 20 73 74 6f 72  4 types can stor
2830: 65 20 69 6e 74 65 67 65 72 20 76 61 6c 75 65 73  e integer values
2840: 0a 2a 2a 20 62 65 74 77 65 65 6e 20 2d 39 32 32  .** between -922
2850: 33 33 37 32 30 33 36 38 35 34 37 37 35 38 30 38  3372036854775808
2860: 20 61 6e 64 20 2b 39 32 32 33 33 37 32 30 33 36   and +9223372036
2870: 38 35 34 37 37 35 38 30 37 20 69 6e 63 6c 75 73  854775807 inclus
2880: 69 76 65 2e 20 20 5e 54 68 65 0a 2a 2a 20 73 71  ive.  ^The.** sq
2890: 6c 69 74 65 33 5f 75 69 6e 74 36 34 20 61 6e 64  lite3_uint64 and
28a0: 20 73 71 6c 69 74 65 5f 75 69 6e 74 36 34 20 74   sqlite_uint64 t
28b0: 79 70 65 73 20 63 61 6e 20 73 74 6f 72 65 20 69  ypes can store i
28c0: 6e 74 65 67 65 72 20 76 61 6c 75 65 73 20 0a 2a  nteger values .*
28d0: 2a 20 62 65 74 77 65 65 6e 20 30 20 61 6e 64 20  * between 0 and 
28e0: 2b 31 38 34 34 36 37 34 34 30 37 33 37 30 39 35  +184467440737095
28f0: 35 31 36 31 35 20 69 6e 63 6c 75 73 69 76 65 2e  51615 inclusive.
2900: 0a 2a 2f 0a 23 69 66 64 65 66 20 53 51 4c 49 54  .*/.#ifdef SQLIT
2910: 45 5f 49 4e 54 36 34 5f 54 59 50 45 0a 20 20 74  E_INT64_TYPE.  t
2920: 79 70 65 64 65 66 20 53 51 4c 49 54 45 5f 49 4e  ypedef SQLITE_IN
2930: 54 36 34 5f 54 59 50 45 20 73 71 6c 69 74 65 5f  T64_TYPE sqlite_
2940: 69 6e 74 36 34 3b 0a 20 20 74 79 70 65 64 65 66  int64;.  typedef
2950: 20 75 6e 73 69 67 6e 65 64 20 53 51 4c 49 54 45   unsigned SQLITE
2960: 5f 49 4e 54 36 34 5f 54 59 50 45 20 73 71 6c 69  _INT64_TYPE sqli
2970: 74 65 5f 75 69 6e 74 36 34 3b 0a 23 65 6c 69 66  te_uint64;.#elif
2980: 20 64 65 66 69 6e 65 64 28 5f 4d 53 43 5f 56 45   defined(_MSC_VE
2990: 52 29 20 7c 7c 20 64 65 66 69 6e 65 64 28 5f 5f  R) || defined(__
29a0: 42 4f 52 4c 41 4e 44 43 5f 5f 29 0a 20 20 74 79  BORLANDC__).  ty
29b0: 70 65 64 65 66 20 5f 5f 69 6e 74 36 34 20 73 71  pedef __int64 sq
29c0: 6c 69 74 65 5f 69 6e 74 36 34 3b 0a 20 20 74 79  lite_int64;.  ty
29d0: 70 65 64 65 66 20 75 6e 73 69 67 6e 65 64 20 5f  pedef unsigned _
29e0: 5f 69 6e 74 36 34 20 73 71 6c 69 74 65 5f 75 69  _int64 sqlite_ui
29f0: 6e 74 36 34 3b 0a 23 65 6c 73 65 0a 20 20 74 79  nt64;.#else.  ty
2a00: 70 65 64 65 66 20 6c 6f 6e 67 20 6c 6f 6e 67 20  pedef long long 
2a10: 69 6e 74 20 73 71 6c 69 74 65 5f 69 6e 74 36 34  int sqlite_int64
2a20: 3b 0a 20 20 74 79 70 65 64 65 66 20 75 6e 73 69  ;.  typedef unsi
2a30: 67 6e 65 64 20 6c 6f 6e 67 20 6c 6f 6e 67 20 69  gned long long i
2a40: 6e 74 20 73 71 6c 69 74 65 5f 75 69 6e 74 36 34  nt sqlite_uint64
2a50: 3b 0a 23 65 6e 64 69 66 0a 74 79 70 65 64 65 66  ;.#endif.typedef
2a60: 20 73 71 6c 69 74 65 5f 69 6e 74 36 34 20 73 71   sqlite_int64 sq
2a70: 6c 69 74 65 33 5f 69 6e 74 36 34 3b 0a 74 79 70  lite3_int64;.typ
2a80: 65 64 65 66 20 73 71 6c 69 74 65 5f 75 69 6e 74  edef sqlite_uint
2a90: 36 34 20 73 71 6c 69 74 65 33 5f 75 69 6e 74 36  64 sqlite3_uint6
2aa0: 34 3b 0a 0a 2f 2a 0a 2a 2a 20 49 66 20 63 6f 6d  4;../*.** If com
2ab0: 70 69 6c 69 6e 67 20 66 6f 72 20 61 20 70 72 6f  piling for a pro
2ac0: 63 65 73 73 6f 72 20 74 68 61 74 20 6c 61 63 6b  cessor that lack
2ad0: 73 20 66 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74  s floating point
2ae0: 20 73 75 70 70 6f 72 74 2c 0a 2a 2a 20 73 75 62   support,.** sub
2af0: 73 74 69 74 75 74 65 20 69 6e 74 65 67 65 72 20  stitute integer 
2b00: 66 6f 72 20 66 6c 6f 61 74 69 6e 67 2d 70 6f 69  for floating-poi
2b10: 6e 74 2e 0a 2a 2f 0a 23 69 66 64 65 66 20 53 51  nt..*/.#ifdef SQ
2b20: 4c 49 54 45 5f 4f 4d 49 54 5f 46 4c 4f 41 54 49  LITE_OMIT_FLOATI
2b30: 4e 47 5f 50 4f 49 4e 54 0a 23 20 64 65 66 69 6e  NG_POINT.# defin
2b40: 65 20 64 6f 75 62 6c 65 20 73 71 6c 69 74 65 33  e double sqlite3
2b50: 5f 69 6e 74 36 34 0a 23 65 6e 64 69 66 0a 0a 2f  _int64.#endif../
2b60: 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 43  *.** CAPI3REF: C
2b70: 6c 6f 73 69 6e 67 20 41 20 44 61 74 61 62 61 73  losing A Databas
2b80: 65 20 43 6f 6e 6e 65 63 74 69 6f 6e 0a 2a 2a 20  e Connection.** 
2b90: 44 45 53 54 52 55 43 54 4f 52 3a 20 73 71 6c 69  DESTRUCTOR: sqli
2ba0: 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  te3.**.** ^The s
2bb0: 71 6c 69 74 65 33 5f 63 6c 6f 73 65 28 29 20 61  qlite3_close() a
2bc0: 6e 64 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65  nd sqlite3_close
2bd0: 5f 76 32 28 29 20 72 6f 75 74 69 6e 65 73 20 61  _v2() routines a
2be0: 72 65 20 64 65 73 74 72 75 63 74 6f 72 73 0a 2a  re destructors.*
2bf0: 2a 20 66 6f 72 20 74 68 65 20 5b 73 71 6c 69 74  * for the [sqlit
2c00: 65 33 5d 20 6f 62 6a 65 63 74 2e 0a 2a 2a 20 5e  e3] object..** ^
2c10: 43 61 6c 6c 73 20 74 6f 20 73 71 6c 69 74 65 33  Calls to sqlite3
2c20: 5f 63 6c 6f 73 65 28 29 20 61 6e 64 20 73 71 6c  _close() and sql
2c30: 69 74 65 33 5f 63 6c 6f 73 65 5f 76 32 28 29 20  ite3_close_v2() 
2c40: 72 65 74 75 72 6e 20 5b 53 51 4c 49 54 45 5f 4f  return [SQLITE_O
2c50: 4b 5d 20 69 66 0a 2a 2a 20 74 68 65 20 5b 73 71  K] if.** the [sq
2c60: 6c 69 74 65 33 5d 20 6f 62 6a 65 63 74 20 69 73  lite3] object is
2c70: 20 73 75 63 63 65 73 73 66 75 6c 6c 79 20 64 65   successfully de
2c80: 73 74 72 6f 79 65 64 20 61 6e 64 20 61 6c 6c 20  stroyed and all 
2c90: 61 73 73 6f 63 69 61 74 65 64 0a 2a 2a 20 72 65  associated.** re
2ca0: 73 6f 75 72 63 65 73 20 61 72 65 20 64 65 61 6c  sources are deal
2cb0: 6c 6f 63 61 74 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e  located..**.** ^
2cc0: 49 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20  If the database 
2cd0: 63 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 61 73  connection is as
2ce0: 73 6f 63 69 61 74 65 64 20 77 69 74 68 20 75 6e  sociated with un
2cf0: 66 69 6e 61 6c 69 7a 65 64 20 70 72 65 70 61 72  finalized prepar
2d00: 65 64 0a 2a 2a 20 73 74 61 74 65 6d 65 6e 74 73  ed.** statements
2d10: 20 6f 72 20 75 6e 66 69 6e 69 73 68 65 64 20 73   or unfinished s
2d20: 71 6c 69 74 65 33 5f 62 61 63 6b 75 70 20 6f 62  qlite3_backup ob
2d30: 6a 65 63 74 73 20 74 68 65 6e 20 73 71 6c 69 74  jects then sqlit
2d40: 65 33 5f 63 6c 6f 73 65 28 29 0a 2a 2a 20 77 69  e3_close().** wi
2d50: 6c 6c 20 6c 65 61 76 65 20 74 68 65 20 64 61 74  ll leave the dat
2d60: 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
2d70: 20 6f 70 65 6e 20 61 6e 64 20 72 65 74 75 72 6e   open and return
2d80: 20 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d 2e 0a   [SQLITE_BUSY]..
2d90: 2a 2a 20 5e 49 66 20 73 71 6c 69 74 65 33 5f 63  ** ^If sqlite3_c
2da0: 6c 6f 73 65 5f 76 32 28 29 20 69 73 20 63 61 6c  lose_v2() is cal
2db0: 6c 65 64 20 77 69 74 68 20 75 6e 66 69 6e 61 6c  led with unfinal
2dc0: 69 7a 65 64 20 70 72 65 70 61 72 65 64 20 73 74  ized prepared st
2dd0: 61 74 65 6d 65 6e 74 73 0a 2a 2a 20 61 6e 64 2f  atements.** and/
2de0: 6f 72 20 75 6e 66 69 6e 69 73 68 65 64 20 73 71  or unfinished sq
2df0: 6c 69 74 65 33 5f 62 61 63 6b 75 70 73 2c 20 74  lite3_backups, t
2e00: 68 65 6e 20 74 68 65 20 64 61 74 61 62 61 73 65  hen the database
2e10: 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 62 65 63 6f   connection beco
2e20: 6d 65 73 0a 2a 2a 20 61 6e 20 75 6e 75 73 61 62  mes.** an unusab
2e30: 6c 65 20 22 7a 6f 6d 62 69 65 22 20 77 68 69 63  le "zombie" whic
2e40: 68 20 77 69 6c 6c 20 61 75 74 6f 6d 61 74 69 63  h will automatic
2e50: 61 6c 6c 79 20 62 65 20 64 65 61 6c 6c 6f 63 61  ally be dealloca
2e60: 74 65 64 20 77 68 65 6e 20 74 68 65 0a 2a 2a 20  ted when the.** 
2e70: 6c 61 73 74 20 70 72 65 70 61 72 65 64 20 73 74  last prepared st
2e80: 61 74 65 6d 65 6e 74 20 69 73 20 66 69 6e 61 6c  atement is final
2e90: 69 7a 65 64 20 6f 72 20 74 68 65 20 6c 61 73 74  ized or the last
2ea0: 20 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 70 20   sqlite3_backup 
2eb0: 69 73 0a 2a 2a 20 66 69 6e 69 73 68 65 64 2e 20  is.** finished. 
2ec0: 20 54 68 65 20 73 71 6c 69 74 65 33 5f 63 6c 6f   The sqlite3_clo
2ed0: 73 65 5f 76 32 28 29 20 69 6e 74 65 72 66 61 63  se_v2() interfac
2ee0: 65 20 69 73 20 69 6e 74 65 6e 64 65 64 20 66 6f  e is intended fo
2ef0: 72 20 75 73 65 20 77 69 74 68 0a 2a 2a 20 68 6f  r use with.** ho
2f00: 73 74 20 6c 61 6e 67 75 61 67 65 73 20 74 68 61  st languages tha
2f10: 74 20 61 72 65 20 67 61 72 62 61 67 65 20 63 6f  t are garbage co
2f20: 6c 6c 65 63 74 65 64 2c 20 61 6e 64 20 77 68 65  llected, and whe
2f30: 72 65 20 74 68 65 20 6f 72 64 65 72 20 69 6e 20  re the order in 
2f40: 77 68 69 63 68 0a 2a 2a 20 64 65 73 74 72 75 63  which.** destruc
2f50: 74 6f 72 73 20 61 72 65 20 63 61 6c 6c 65 64 20  tors are called 
2f60: 69 73 20 61 72 62 69 74 72 61 72 79 2e 0a 2a 2a  is arbitrary..**
2f70: 0a 2a 2a 20 41 70 70 6c 69 63 61 74 69 6f 6e 73  .** Applications
2f80: 20 73 68 6f 75 6c 64 20 5b 73 71 6c 69 74 65 33   should [sqlite3
2f90: 5f 66 69 6e 61 6c 69 7a 65 20 7c 20 66 69 6e 61  _finalize | fina
2fa0: 6c 69 7a 65 5d 20 61 6c 6c 20 5b 70 72 65 70 61  lize] all [prepa
2fb0: 72 65 64 20 73 74 61 74 65 6d 65 6e 74 73 5d 2c  red statements],
2fc0: 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62 6c 6f  .** [sqlite3_blo
2fd0: 62 5f 63 6c 6f 73 65 20 7c 20 63 6c 6f 73 65 5d  b_close | close]
2fe0: 20 61 6c 6c 20 5b 42 4c 4f 42 20 68 61 6e 64 6c   all [BLOB handl
2ff0: 65 73 5d 2c 20 61 6e 64 20 0a 2a 2a 20 5b 73 71  es], and .** [sq
3000: 6c 69 74 65 33 5f 62 61 63 6b 75 70 5f 66 69 6e  lite3_backup_fin
3010: 69 73 68 20 7c 20 66 69 6e 69 73 68 5d 20 61 6c  ish | finish] al
3020: 6c 20 5b 73 71 6c 69 74 65 33 5f 62 61 63 6b 75  l [sqlite3_backu
3030: 70 5d 20 6f 62 6a 65 63 74 73 20 61 73 73 6f 63  p] objects assoc
3040: 69 61 74 65 64 0a 2a 2a 20 77 69 74 68 20 74 68  iated.** with th
3050: 65 20 5b 73 71 6c 69 74 65 33 5d 20 6f 62 6a 65  e [sqlite3] obje
3060: 63 74 20 70 72 69 6f 72 20 74 6f 20 61 74 74 65  ct prior to atte
3070: 6d 70 74 69 6e 67 20 74 6f 20 63 6c 6f 73 65 20  mpting to close 
3080: 74 68 65 20 6f 62 6a 65 63 74 2e 20 20 5e 49 66  the object.  ^If
3090: 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73  .** sqlite3_clos
30a0: 65 5f 76 32 28 29 20 69 73 20 63 61 6c 6c 65 64  e_v2() is called
30b0: 20 6f 6e 20 61 20 5b 64 61 74 61 62 61 73 65 20   on a [database 
30c0: 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 74 68 61 74  connection] that
30d0: 20 73 74 69 6c 6c 20 68 61 73 0a 2a 2a 20 6f 75   still has.** ou
30e0: 74 73 74 61 6e 64 69 6e 67 20 5b 70 72 65 70 61  tstanding [prepa
30f0: 72 65 64 20 73 74 61 74 65 6d 65 6e 74 73 5d 2c  red statements],
3100: 20 5b 42 4c 4f 42 20 68 61 6e 64 6c 65 73 5d 2c   [BLOB handles],
3110: 20 61 6e 64 2f 6f 72 0a 2a 2a 20 5b 73 71 6c 69   and/or.** [sqli
3120: 74 65 33 5f 62 61 63 6b 75 70 5d 20 6f 62 6a 65  te3_backup] obje
3130: 63 74 73 20 74 68 65 6e 20 69 74 20 72 65 74 75  cts then it retu
3140: 72 6e 73 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20  rns [SQLITE_OK] 
3150: 61 6e 64 20 74 68 65 20 64 65 61 6c 6c 6f 63 61  and the dealloca
3160: 74 69 6f 6e 0a 2a 2a 20 6f 66 20 72 65 73 6f 75  tion.** of resou
3170: 72 63 65 73 20 69 73 20 64 65 66 65 72 72 65 64  rces is deferred
3180: 20 75 6e 74 69 6c 20 61 6c 6c 20 5b 70 72 65 70   until all [prep
3190: 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 73 5d  ared statements]
31a0: 2c 20 5b 42 4c 4f 42 20 68 61 6e 64 6c 65 73 5d  , [BLOB handles]
31b0: 2c 0a 2a 2a 20 61 6e 64 20 5b 73 71 6c 69 74 65  ,.** and [sqlite
31c0: 33 5f 62 61 63 6b 75 70 5d 20 6f 62 6a 65 63 74  3_backup] object
31d0: 73 20 61 72 65 20 61 6c 73 6f 20 64 65 73 74 72  s are also destr
31e0: 6f 79 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20  oyed..**.** ^If 
31f0: 61 6e 20 5b 73 71 6c 69 74 65 33 5d 20 6f 62 6a  an [sqlite3] obj
3200: 65 63 74 20 69 73 20 64 65 73 74 72 6f 79 65 64  ect is destroyed
3210: 20 77 68 69 6c 65 20 61 20 74 72 61 6e 73 61 63   while a transac
3220: 74 69 6f 6e 20 69 73 20 6f 70 65 6e 2c 0a 2a 2a  tion is open,.**
3230: 20 74 68 65 20 74 72 61 6e 73 61 63 74 69 6f 6e   the transaction
3240: 20 69 73 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c   is automaticall
3250: 79 20 72 6f 6c 6c 65 64 20 62 61 63 6b 2e 0a 2a  y rolled back..*
3260: 2a 0a 2a 2a 20 54 68 65 20 43 20 70 61 72 61 6d  *.** The C param
3270: 65 74 65 72 20 74 6f 20 5b 73 71 6c 69 74 65 33  eter to [sqlite3
3280: 5f 63 6c 6f 73 65 28 43 29 5d 20 61 6e 64 20 5b  _close(C)] and [
3290: 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 5f 76 32  sqlite3_close_v2
32a0: 28 43 29 5d 0a 2a 2a 20 6d 75 73 74 20 62 65 20  (C)].** must be 
32b0: 65 69 74 68 65 72 20 61 20 4e 55 4c 4c 0a 2a 2a  either a NULL.**
32c0: 20 70 6f 69 6e 74 65 72 20 6f 72 20 61 6e 20 5b   pointer or an [
32d0: 73 71 6c 69 74 65 33 5d 20 6f 62 6a 65 63 74 20  sqlite3] object 
32e0: 70 6f 69 6e 74 65 72 20 6f 62 74 61 69 6e 65 64  pointer obtained
32f0: 0a 2a 2a 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65  .** from [sqlite
3300: 33 5f 6f 70 65 6e 28 29 5d 2c 20 5b 73 71 6c 69  3_open()], [sqli
3310: 74 65 33 5f 6f 70 65 6e 31 36 28 29 5d 2c 20 6f  te3_open16()], o
3320: 72 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6f 70  r.** [sqlite3_op
3330: 65 6e 5f 76 32 28 29 5d 2c 20 61 6e 64 20 6e 6f  en_v2()], and no
3340: 74 20 70 72 65 76 69 6f 75 73 6c 79 20 63 6c 6f  t previously clo
3350: 73 65 64 2e 0a 2a 2a 20 5e 43 61 6c 6c 69 6e 67  sed..** ^Calling
3360: 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 28 29   sqlite3_close()
3370: 20 6f 72 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73   or sqlite3_clos
3380: 65 5f 76 32 28 29 20 77 69 74 68 20 61 20 4e 55  e_v2() with a NU
3390: 4c 4c 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 61 72  LL pointer.** ar
33a0: 67 75 6d 65 6e 74 20 69 73 20 61 20 68 61 72 6d  gument is a harm
33b0: 6c 65 73 73 20 6e 6f 2d 6f 70 2e 0a 2a 2f 0a 69  less no-op..*/.i
33c0: 6e 74 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65  nt sqlite3_close
33d0: 28 73 71 6c 69 74 65 33 2a 29 3b 0a 69 6e 74 20  (sqlite3*);.int 
33e0: 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 5f 76 32  sqlite3_close_v2
33f0: 28 73 71 6c 69 74 65 33 2a 29 3b 0a 0a 2f 2a 0a  (sqlite3*);../*.
3400: 2a 2a 20 54 68 65 20 74 79 70 65 20 66 6f 72 20  ** The type for 
3410: 61 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74  a callback funct
3420: 69 6f 6e 2e 0a 2a 2a 20 54 68 69 73 20 69 73 20  ion..** This is 
3430: 6c 65 67 61 63 79 20 61 6e 64 20 64 65 70 72 65  legacy and depre
3440: 63 61 74 65 64 2e 20 20 49 74 20 69 73 20 69 6e  cated.  It is in
3450: 63 6c 75 64 65 64 20 66 6f 72 20 68 69 73 74 6f  cluded for histo
3460: 72 69 63 61 6c 0a 2a 2a 20 63 6f 6d 70 61 74 69  rical.** compati
3470: 62 69 6c 69 74 79 20 61 6e 64 20 69 73 20 6e 6f  bility and is no
3480: 74 20 64 6f 63 75 6d 65 6e 74 65 64 2e 0a 2a 2f  t documented..*/
3490: 0a 74 79 70 65 64 65 66 20 69 6e 74 20 28 2a 73  .typedef int (*s
34a0: 71 6c 69 74 65 33 5f 63 61 6c 6c 62 61 63 6b 29  qlite3_callback)
34b0: 28 76 6f 69 64 2a 2c 69 6e 74 2c 63 68 61 72 2a  (void*,int,char*
34c0: 2a 2c 20 63 68 61 72 2a 2a 29 3b 0a 0a 2f 2a 0a  *, char**);../*.
34d0: 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4f 6e 65  ** CAPI3REF: One
34e0: 2d 53 74 65 70 20 51 75 65 72 79 20 45 78 65 63  -Step Query Exec
34f0: 75 74 69 6f 6e 20 49 6e 74 65 72 66 61 63 65 0a  ution Interface.
3500: 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74  ** METHOD: sqlit
3510: 65 33 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c  e3.**.** The sql
3520: 69 74 65 33 5f 65 78 65 63 28 29 20 69 6e 74 65  ite3_exec() inte
3530: 72 66 61 63 65 20 69 73 20 61 20 63 6f 6e 76 65  rface is a conve
3540: 6e 69 65 6e 63 65 20 77 72 61 70 70 65 72 20 61  nience wrapper a
3550: 72 6f 75 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74 65  round.** [sqlite
3560: 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d 2c  3_prepare_v2()],
3570: 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29   [sqlite3_step()
3580: 5d 2c 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f  ], and [sqlite3_
3590: 66 69 6e 61 6c 69 7a 65 28 29 5d 2c 0a 2a 2a 20  finalize()],.** 
35a0: 74 68 61 74 20 61 6c 6c 6f 77 73 20 61 6e 20 61  that allows an a
35b0: 70 70 6c 69 63 61 74 69 6f 6e 20 74 6f 20 72 75  pplication to ru
35c0: 6e 20 6d 75 6c 74 69 70 6c 65 20 73 74 61 74 65  n multiple state
35d0: 6d 65 6e 74 73 20 6f 66 20 53 51 4c 0a 2a 2a 20  ments of SQL.** 
35e0: 77 69 74 68 6f 75 74 20 68 61 76 69 6e 67 20 74  without having t
35f0: 6f 20 75 73 65 20 61 20 6c 6f 74 20 6f 66 20 43  o use a lot of C
3600: 20 63 6f 64 65 2e 20 0a 2a 2a 0a 2a 2a 20 5e 54   code. .**.** ^T
3610: 68 65 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28  he sqlite3_exec(
3620: 29 20 69 6e 74 65 72 66 61 63 65 20 72 75 6e 73  ) interface runs
3630: 20 7a 65 72 6f 20 6f 72 20 6d 6f 72 65 20 55 54   zero or more UT
3640: 46 2d 38 20 65 6e 63 6f 64 65 64 2c 0a 2a 2a 20  F-8 encoded,.** 
3650: 73 65 6d 69 63 6f 6c 6f 6e 2d 73 65 70 61 72 61  semicolon-separa
3660: 74 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  te SQL statement
3670: 73 20 70 61 73 73 65 64 20 69 6e 74 6f 20 69 74  s passed into it
3680: 73 20 32 6e 64 20 61 72 67 75 6d 65 6e 74 2c 0a  s 2nd argument,.
3690: 2a 2a 20 69 6e 20 74 68 65 20 63 6f 6e 74 65 78  ** in the contex
36a0: 74 20 6f 66 20 74 68 65 20 5b 64 61 74 61 62 61  t of the [databa
36b0: 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 70  se connection] p
36c0: 61 73 73 65 64 20 69 6e 20 61 73 20 69 74 73 20  assed in as its 
36d0: 31 73 74 0a 2a 2a 20 61 72 67 75 6d 65 6e 74 2e  1st.** argument.
36e0: 20 20 5e 49 66 20 74 68 65 20 63 61 6c 6c 62 61    ^If the callba
36f0: 63 6b 20 66 75 6e 63 74 69 6f 6e 20 6f 66 20 74  ck function of t
3700: 68 65 20 33 72 64 20 61 72 67 75 6d 65 6e 74 20  he 3rd argument 
3710: 74 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 65 78  to.** sqlite3_ex
3720: 65 63 28 29 20 69 73 20 6e 6f 74 20 4e 55 4c 4c  ec() is not NULL
3730: 2c 20 74 68 65 6e 20 69 74 20 69 73 20 69 6e 76  , then it is inv
3740: 6f 6b 65 64 20 66 6f 72 20 65 61 63 68 20 72 65  oked for each re
3750: 73 75 6c 74 20 72 6f 77 0a 2a 2a 20 63 6f 6d 69  sult row.** comi
3760: 6e 67 20 6f 75 74 20 6f 66 20 74 68 65 20 65 76  ng out of the ev
3770: 61 6c 75 61 74 65 64 20 53 51 4c 20 73 74 61 74  aluated SQL stat
3780: 65 6d 65 6e 74 73 2e 20 20 5e 54 68 65 20 34 74  ements.  ^The 4t
3790: 68 20 61 72 67 75 6d 65 6e 74 20 74 6f 0a 2a 2a  h argument to.**
37a0: 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 20   sqlite3_exec() 
37b0: 69 73 20 72 65 6c 61 79 65 64 20 74 68 72 6f 75  is relayed throu
37c0: 67 68 20 74 6f 20 74 68 65 20 31 73 74 20 61 72  gh to the 1st ar
37d0: 67 75 6d 65 6e 74 20 6f 66 20 65 61 63 68 0a 2a  gument of each.*
37e0: 2a 20 63 61 6c 6c 62 61 63 6b 20 69 6e 76 6f 63  * callback invoc
37f0: 61 74 69 6f 6e 2e 20 20 5e 49 66 20 74 68 65 20  ation.  ^If the 
3800: 63 61 6c 6c 62 61 63 6b 20 70 6f 69 6e 74 65 72  callback pointer
3810: 20 74 6f 20 73 71 6c 69 74 65 33 5f 65 78 65 63   to sqlite3_exec
3820: 28 29 0a 2a 2a 20 69 73 20 4e 55 4c 4c 2c 20 74  ().** is NULL, t
3830: 68 65 6e 20 6e 6f 20 63 61 6c 6c 62 61 63 6b 20  hen no callback 
3840: 69 73 20 65 76 65 72 20 69 6e 76 6f 6b 65 64 20  is ever invoked 
3850: 61 6e 64 20 72 65 73 75 6c 74 20 72 6f 77 73 20  and result rows 
3860: 61 72 65 0a 2a 2a 20 69 67 6e 6f 72 65 64 2e 0a  are.** ignored..
3870: 2a 2a 0a 2a 2a 20 5e 49 66 20 61 6e 20 65 72 72  **.** ^If an err
3880: 6f 72 20 6f 63 63 75 72 73 20 77 68 69 6c 65 20  or occurs while 
3890: 65 76 61 6c 75 61 74 69 6e 67 20 74 68 65 20 53  evaluating the S
38a0: 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 20 70 61  QL statements pa
38b0: 73 73 65 64 20 69 6e 74 6f 0a 2a 2a 20 73 71 6c  ssed into.** sql
38c0: 69 74 65 33 5f 65 78 65 63 28 29 2c 20 74 68 65  ite3_exec(), the
38d0: 6e 20 65 78 65 63 75 74 69 6f 6e 20 6f 66 20 74  n execution of t
38e0: 68 65 20 63 75 72 72 65 6e 74 20 73 74 61 74 65  he current state
38f0: 6d 65 6e 74 20 73 74 6f 70 73 20 61 6e 64 0a 2a  ment stops and.*
3900: 2a 20 73 75 62 73 65 71 75 65 6e 74 20 73 74 61  * subsequent sta
3910: 74 65 6d 65 6e 74 73 20 61 72 65 20 73 6b 69 70  tements are skip
3920: 70 65 64 2e 20 20 5e 49 66 20 74 68 65 20 35 74  ped.  ^If the 5t
3930: 68 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73  h parameter to s
3940: 71 6c 69 74 65 33 5f 65 78 65 63 28 29 0a 2a 2a  qlite3_exec().**
3950: 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 20 74 68 65   is not NULL the
3960: 6e 20 61 6e 79 20 65 72 72 6f 72 20 6d 65 73 73  n any error mess
3970: 61 67 65 20 69 73 20 77 72 69 74 74 65 6e 20 69  age is written i
3980: 6e 74 6f 20 6d 65 6d 6f 72 79 20 6f 62 74 61 69  nto memory obtai
3990: 6e 65 64 0a 2a 2a 20 66 72 6f 6d 20 5b 73 71 6c  ned.** from [sql
39a0: 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 20 61  ite3_malloc()] a
39b0: 6e 64 20 70 61 73 73 65 64 20 62 61 63 6b 20 74  nd passed back t
39c0: 68 72 6f 75 67 68 20 74 68 65 20 35 74 68 20 70  hrough the 5th p
39d0: 61 72 61 6d 65 74 65 72 2e 0a 2a 2a 20 54 6f 20  arameter..** To 
39e0: 61 76 6f 69 64 20 6d 65 6d 6f 72 79 20 6c 65 61  avoid memory lea
39f0: 6b 73 2c 20 74 68 65 20 61 70 70 6c 69 63 61 74  ks, the applicat
3a00: 69 6f 6e 20 73 68 6f 75 6c 64 20 69 6e 76 6f 6b  ion should invok
3a10: 65 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 28  e [sqlite3_free(
3a20: 29 5d 0a 2a 2a 20 6f 6e 20 65 72 72 6f 72 20 6d  )].** on error m
3a30: 65 73 73 61 67 65 20 73 74 72 69 6e 67 73 20 72  essage strings r
3a40: 65 74 75 72 6e 65 64 20 74 68 72 6f 75 67 68 20  eturned through 
3a50: 74 68 65 20 35 74 68 20 70 61 72 61 6d 65 74 65  the 5th paramete
3a60: 72 20 6f 66 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  r of.** sqlite3_
3a70: 65 78 65 63 28 29 20 61 66 74 65 72 20 74 68 65  exec() after the
3a80: 20 65 72 72 6f 72 20 6d 65 73 73 61 67 65 20 73   error message s
3a90: 74 72 69 6e 67 20 69 73 20 6e 6f 20 6c 6f 6e 67  tring is no long
3aa0: 65 72 20 6e 65 65 64 65 64 2e 0a 2a 2a 20 5e 49  er needed..** ^I
3ab0: 66 20 74 68 65 20 35 74 68 20 70 61 72 61 6d 65  f the 5th parame
3ac0: 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 65  ter to sqlite3_e
3ad0: 78 65 63 28 29 20 69 73 20 6e 6f 74 20 4e 55 4c  xec() is not NUL
3ae0: 4c 20 61 6e 64 20 6e 6f 20 65 72 72 6f 72 73 0a  L and no errors.
3af0: 2a 2a 20 6f 63 63 75 72 2c 20 74 68 65 6e 20 73  ** occur, then s
3b00: 71 6c 69 74 65 33 5f 65 78 65 63 28 29 20 73 65  qlite3_exec() se
3b10: 74 73 20 74 68 65 20 70 6f 69 6e 74 65 72 20 69  ts the pointer i
3b20: 6e 20 69 74 73 20 35 74 68 20 70 61 72 61 6d 65  n its 5th parame
3b30: 74 65 72 20 74 6f 0a 2a 2a 20 4e 55 4c 4c 20 62  ter to.** NULL b
3b40: 65 66 6f 72 65 20 72 65 74 75 72 6e 69 6e 67 2e  efore returning.
3b50: 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 61 6e 20 73 71  .**.** ^If an sq
3b60: 6c 69 74 65 33 5f 65 78 65 63 28 29 20 63 61 6c  lite3_exec() cal
3b70: 6c 62 61 63 6b 20 72 65 74 75 72 6e 73 20 6e 6f  lback returns no
3b80: 6e 2d 7a 65 72 6f 2c 20 74 68 65 20 73 71 6c 69  n-zero, the sqli
3b90: 74 65 33 5f 65 78 65 63 28 29 0a 2a 2a 20 72 6f  te3_exec().** ro
3ba0: 75 74 69 6e 65 20 72 65 74 75 72 6e 73 20 53 51  utine returns SQ
3bb0: 4c 49 54 45 5f 41 42 4f 52 54 20 77 69 74 68 6f  LITE_ABORT witho
3bc0: 75 74 20 69 6e 76 6f 6b 69 6e 67 20 74 68 65 20  ut invoking the 
3bd0: 63 61 6c 6c 62 61 63 6b 20 61 67 61 69 6e 20 61  callback again a
3be0: 6e 64 0a 2a 2a 20 77 69 74 68 6f 75 74 20 72 75  nd.** without ru
3bf0: 6e 6e 69 6e 67 20 61 6e 79 20 73 75 62 73 65 71  nning any subseq
3c00: 75 65 6e 74 20 53 51 4c 20 73 74 61 74 65 6d 65  uent SQL stateme
3c10: 6e 74 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  nts..**.** ^The 
3c20: 32 6e 64 20 61 72 67 75 6d 65 6e 74 20 74 6f 20  2nd argument to 
3c30: 74 68 65 20 73 71 6c 69 74 65 33 5f 65 78 65 63  the sqlite3_exec
3c40: 28 29 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63  () callback func
3c50: 74 69 6f 6e 20 69 73 20 74 68 65 0a 2a 2a 20 6e  tion is the.** n
3c60: 75 6d 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73  umber of columns
3c70: 20 69 6e 20 74 68 65 20 72 65 73 75 6c 74 2e 20   in the result. 
3c80: 20 5e 54 68 65 20 33 72 64 20 61 72 67 75 6d 65   ^The 3rd argume
3c90: 6e 74 20 74 6f 20 74 68 65 20 73 71 6c 69 74 65  nt to the sqlite
3ca0: 33 5f 65 78 65 63 28 29 0a 2a 2a 20 63 61 6c 6c  3_exec().** call
3cb0: 62 61 63 6b 20 69 73 20 61 6e 20 61 72 72 61 79  back is an array
3cc0: 20 6f 66 20 70 6f 69 6e 74 65 72 73 20 74 6f 20   of pointers to 
3cd0: 73 74 72 69 6e 67 73 20 6f 62 74 61 69 6e 65 64  strings obtained
3ce0: 20 61 73 20 69 66 20 66 72 6f 6d 0a 2a 2a 20 5b   as if from.** [
3cf0: 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74  sqlite3_column_t
3d00: 65 78 74 28 29 5d 2c 20 6f 6e 65 20 66 6f 72 20  ext()], one for 
3d10: 65 61 63 68 20 63 6f 6c 75 6d 6e 2e 20 20 5e 49  each column.  ^I
3d20: 66 20 61 6e 20 65 6c 65 6d 65 6e 74 20 6f 66 20  f an element of 
3d30: 61 0a 2a 2a 20 72 65 73 75 6c 74 20 72 6f 77 20  a.** result row 
3d40: 69 73 20 4e 55 4c 4c 20 74 68 65 6e 20 74 68 65  is NULL then the
3d50: 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20 73   corresponding s
3d60: 74 72 69 6e 67 20 70 6f 69 6e 74 65 72 20 66 6f  tring pointer fo
3d70: 72 20 74 68 65 0a 2a 2a 20 73 71 6c 69 74 65 33  r the.** sqlite3
3d80: 5f 65 78 65 63 28 29 20 63 61 6c 6c 62 61 63 6b  _exec() callback
3d90: 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74   is a NULL point
3da0: 65 72 2e 20 20 5e 54 68 65 20 34 74 68 20 61 72  er.  ^The 4th ar
3db0: 67 75 6d 65 6e 74 20 74 6f 20 74 68 65 0a 2a 2a  gument to the.**
3dc0: 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 20   sqlite3_exec() 
3dd0: 63 61 6c 6c 62 61 63 6b 20 69 73 20 61 6e 20 61  callback is an a
3de0: 72 72 61 79 20 6f 66 20 70 6f 69 6e 74 65 72 73  rray of pointers
3df0: 20 74 6f 20 73 74 72 69 6e 67 73 20 77 68 65 72   to strings wher
3e00: 65 20 65 61 63 68 0a 2a 2a 20 65 6e 74 72 79 20  e each.** entry 
3e10: 72 65 70 72 65 73 65 6e 74 73 20 74 68 65 20 6e  represents the n
3e20: 61 6d 65 20 6f 66 20 63 6f 72 72 65 73 70 6f 6e  ame of correspon
3e30: 64 69 6e 67 20 72 65 73 75 6c 74 20 63 6f 6c 75  ding result colu
3e40: 6d 6e 20 61 73 20 6f 62 74 61 69 6e 65 64 0a 2a  mn as obtained.*
3e50: 2a 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f  * from [sqlite3_
3e60: 63 6f 6c 75 6d 6e 5f 6e 61 6d 65 28 29 5d 2e 0a  column_name()]..
3e70: 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 32 6e  **.** ^If the 2n
3e80: 64 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73  d parameter to s
3e90: 71 6c 69 74 65 33 5f 65 78 65 63 28 29 20 69 73  qlite3_exec() is
3ea0: 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2c   a NULL pointer,
3eb0: 20 61 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 74 6f   a pointer.** to
3ec0: 20 61 6e 20 65 6d 70 74 79 20 73 74 72 69 6e 67   an empty string
3ed0: 2c 20 6f 72 20 61 20 70 6f 69 6e 74 65 72 20 74  , or a pointer t
3ee0: 68 61 74 20 63 6f 6e 74 61 69 6e 73 20 6f 6e 6c  hat contains onl
3ef0: 79 20 77 68 69 74 65 73 70 61 63 65 20 61 6e 64  y whitespace and
3f00: 2f 6f 72 20 0a 2a 2a 20 53 51 4c 20 63 6f 6d 6d  /or .** SQL comm
3f10: 65 6e 74 73 2c 20 74 68 65 6e 20 6e 6f 20 53 51  ents, then no SQ
3f20: 4c 20 73 74 61 74 65 6d 65 6e 74 73 20 61 72 65  L statements are
3f30: 20 65 76 61 6c 75 61 74 65 64 20 61 6e 64 20 74   evaluated and t
3f40: 68 65 20 64 61 74 61 62 61 73 65 0a 2a 2a 20 69  he database.** i
3f50: 73 20 6e 6f 74 20 63 68 61 6e 67 65 64 2e 0a 2a  s not changed..*
3f60: 2a 0a 2a 2a 20 52 65 73 74 72 69 63 74 69 6f 6e  *.** Restriction
3f70: 73 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a  s:.**.** <ul>.**
3f80: 20 3c 6c 69 3e 20 54 68 65 20 61 70 70 6c 69 63   <li> The applic
3f90: 61 74 69 6f 6e 20 6d 75 73 74 20 65 6e 73 75 72  ation must ensur
3fa0: 65 20 74 68 61 74 20 74 68 65 20 31 73 74 20 70  e that the 1st p
3fb0: 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69  arameter to sqli
3fc0: 74 65 33 5f 65 78 65 63 28 29 0a 2a 2a 20 20 20  te3_exec().**   
3fd0: 20 20 20 69 73 20 61 20 76 61 6c 69 64 20 61 6e     is a valid an
3fe0: 64 20 6f 70 65 6e 20 5b 64 61 74 61 62 61 73 65  d open [database
3ff0: 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 2e 0a 2a 2a   connection]..**
4000: 20 3c 6c 69 3e 20 54 68 65 20 61 70 70 6c 69 63   <li> The applic
4010: 61 74 69 6f 6e 20 6d 75 73 74 20 6e 6f 74 20 63  ation must not c
4020: 6c 6f 73 65 20 74 68 65 20 5b 64 61 74 61 62 61  lose the [databa
4030: 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 73  se connection] s
4040: 70 65 63 69 66 69 65 64 20 62 79 0a 2a 2a 20 20  pecified by.**  
4050: 20 20 20 20 74 68 65 20 31 73 74 20 70 61 72 61      the 1st para
4060: 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33  meter to sqlite3
4070: 5f 65 78 65 63 28 29 20 77 68 69 6c 65 20 73 71  _exec() while sq
4080: 6c 69 74 65 33 5f 65 78 65 63 28 29 20 69 73 20  lite3_exec() is 
4090: 72 75 6e 6e 69 6e 67 2e 0a 2a 2a 20 3c 6c 69 3e  running..** <li>
40a0: 20 54 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   The application
40b0: 20 6d 75 73 74 20 6e 6f 74 20 6d 6f 64 69 66 79   must not modify
40c0: 20 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65   the SQL stateme
40d0: 6e 74 20 74 65 78 74 20 70 61 73 73 65 64 20 69  nt text passed i
40e0: 6e 74 6f 0a 2a 2a 20 20 20 20 20 20 74 68 65 20  nto.**      the 
40f0: 32 6e 64 20 70 61 72 61 6d 65 74 65 72 20 6f 66  2nd parameter of
4100: 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 20   sqlite3_exec() 
4110: 77 68 69 6c 65 20 73 71 6c 69 74 65 33 5f 65 78  while sqlite3_ex
4120: 65 63 28 29 20 69 73 20 72 75 6e 6e 69 6e 67 2e  ec() is running.
4130: 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2f 0a 69 6e 74  .** </ul>.*/.int
4140: 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28 0a 20   sqlite3_exec(. 
4150: 20 73 71 6c 69 74 65 33 2a 2c 20 20 20 20 20 20   sqlite3*,      
4160: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
4170: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 41              /* A
4180: 6e 20 6f 70 65 6e 20 64 61 74 61 62 61 73 65 20  n open database 
4190: 2a 2f 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20  */.  const char 
41a0: 2a 73 71 6c 2c 20 20 20 20 20 20 20 20 20 20 20  *sql,           
41b0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
41c0: 2f 2a 20 53 51 4c 20 74 6f 20 62 65 20 65 76 61  /* SQL to be eva
41d0: 6c 75 61 74 65 64 20 2a 2f 0a 20 20 69 6e 74 20  luated */.  int 
41e0: 28 2a 63 61 6c 6c 62 61 63 6b 29 28 76 6f 69 64  (*callback)(void
41f0: 2a 2c 69 6e 74 2c 63 68 61 72 2a 2a 2c 63 68 61  *,int,char**,cha
4200: 72 2a 2a 29 2c 20 20 2f 2a 20 43 61 6c 6c 62 61  r**),  /* Callba
4210: 63 6b 20 66 75 6e 63 74 69 6f 6e 20 2a 2f 0a 20  ck function */. 
4220: 20 76 6f 69 64 20 2a 2c 20 20 20 20 20 20 20 20   void *,        
4230: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
4240: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 31              /* 1
4250: 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 63  st argument to c
4260: 61 6c 6c 62 61 63 6b 20 2a 2f 0a 20 20 63 68 61  allback */.  cha
4270: 72 20 2a 2a 65 72 72 6d 73 67 20 20 20 20 20 20  r **errmsg      
4280: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
4290: 20 20 20 20 20 20 20 20 2f 2a 20 45 72 72 6f 72          /* Error
42a0: 20 6d 73 67 20 77 72 69 74 74 65 6e 20 68 65 72   msg written her
42b0: 65 20 2a 2f 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43  e */.);../*.** C
42c0: 41 50 49 33 52 45 46 3a 20 52 65 73 75 6c 74 20  API3REF: Result 
42d0: 43 6f 64 65 73 0a 2a 2a 20 4b 45 59 57 4f 52 44  Codes.** KEYWORD
42e0: 53 3a 20 7b 72 65 73 75 6c 74 20 63 6f 64 65 20  S: {result code 
42f0: 64 65 66 69 6e 69 74 69 6f 6e 73 7d 0a 2a 2a 0a  definitions}.**.
4300: 2a 2a 20 4d 61 6e 79 20 53 51 4c 69 74 65 20 66  ** Many SQLite f
4310: 75 6e 63 74 69 6f 6e 73 20 72 65 74 75 72 6e 20  unctions return 
4320: 61 6e 20 69 6e 74 65 67 65 72 20 72 65 73 75 6c  an integer resul
4330: 74 20 63 6f 64 65 20 66 72 6f 6d 20 74 68 65 20  t code from the 
4340: 73 65 74 20 73 68 6f 77 6e 0a 2a 2a 20 68 65 72  set shown.** her
4350: 65 20 69 6e 20 6f 72 64 65 72 20 74 6f 20 69 6e  e in order to in
4360: 64 69 63 61 74 65 20 73 75 63 63 65 73 73 20 6f  dicate success o
4370: 72 20 66 61 69 6c 75 72 65 2e 0a 2a 2a 0a 2a 2a  r failure..**.**
4380: 20 4e 65 77 20 65 72 72 6f 72 20 63 6f 64 65 73   New error codes
4390: 20 6d 61 79 20 62 65 20 61 64 64 65 64 20 69 6e   may be added in
43a0: 20 66 75 74 75 72 65 20 76 65 72 73 69 6f 6e 73   future versions
43b0: 20 6f 66 20 53 51 4c 69 74 65 2e 0a 2a 2a 0a 2a   of SQLite..**.*
43c0: 2a 20 53 65 65 20 61 6c 73 6f 3a 20 5b 65 78 74  * See also: [ext
43d0: 65 6e 64 65 64 20 72 65 73 75 6c 74 20 63 6f 64  ended result cod
43e0: 65 20 64 65 66 69 6e 69 74 69 6f 6e 73 5d 0a 2a  e definitions].*
43f0: 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
4400: 5f 4f 4b 20 20 20 20 20 20 20 20 20 20 20 30 20  _OK           0 
4410: 20 20 2f 2a 20 53 75 63 63 65 73 73 66 75 6c 20    /* Successful 
4420: 72 65 73 75 6c 74 20 2a 2f 0a 2f 2a 20 62 65 67  result */./* beg
4430: 69 6e 6e 69 6e 67 2d 6f 66 2d 65 72 72 6f 72 2d  inning-of-error-
4440: 63 6f 64 65 73 20 2a 2f 0a 23 64 65 66 69 6e 65  codes */.#define
4450: 20 53 51 4c 49 54 45 5f 45 52 52 4f 52 20 20 20   SQLITE_ERROR   
4460: 20 20 20 20 20 31 20 20 20 2f 2a 20 53 51 4c 20       1   /* SQL 
4470: 65 72 72 6f 72 20 6f 72 20 6d 69 73 73 69 6e 67  error or missing
4480: 20 64 61 74 61 62 61 73 65 20 2a 2f 0a 23 64 65   database */.#de
4490: 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4e 54 45  fine SQLITE_INTE
44a0: 52 4e 41 4c 20 20 20 20 20 32 20 20 20 2f 2a 20  RNAL     2   /* 
44b0: 49 6e 74 65 72 6e 61 6c 20 6c 6f 67 69 63 20 65  Internal logic e
44c0: 72 72 6f 72 20 69 6e 20 53 51 4c 69 74 65 20 2a  rror in SQLite *
44d0: 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
44e0: 5f 50 45 52 4d 20 20 20 20 20 20 20 20 20 33 20  _PERM         3 
44f0: 20 20 2f 2a 20 41 63 63 65 73 73 20 70 65 72 6d    /* Access perm
4500: 69 73 73 69 6f 6e 20 64 65 6e 69 65 64 20 2a 2f  ission denied */
4510: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
4520: 41 42 4f 52 54 20 20 20 20 20 20 20 20 34 20 20  ABORT        4  
4530: 20 2f 2a 20 43 61 6c 6c 62 61 63 6b 20 72 6f 75   /* Callback rou
4540: 74 69 6e 65 20 72 65 71 75 65 73 74 65 64 20 61  tine requested a
4550: 6e 20 61 62 6f 72 74 20 2a 2f 0a 23 64 65 66 69  n abort */.#defi
4560: 6e 65 20 53 51 4c 49 54 45 5f 42 55 53 59 20 20  ne SQLITE_BUSY  
4570: 20 20 20 20 20 20 20 35 20 20 20 2f 2a 20 54 68         5   /* Th
4580: 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20  e database file 
4590: 69 73 20 6c 6f 63 6b 65 64 20 2a 2f 0a 23 64 65  is locked */.#de
45a0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c 4f 43 4b  fine SQLITE_LOCK
45b0: 45 44 20 20 20 20 20 20 20 36 20 20 20 2f 2a 20  ED       6   /* 
45c0: 41 20 74 61 62 6c 65 20 69 6e 20 74 68 65 20 64  A table in the d
45d0: 61 74 61 62 61 73 65 20 69 73 20 6c 6f 63 6b 65  atabase is locke
45e0: 64 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  d */.#define SQL
45f0: 49 54 45 5f 4e 4f 4d 45 4d 20 20 20 20 20 20 20  ITE_NOMEM       
4600: 20 37 20 20 20 2f 2a 20 41 20 6d 61 6c 6c 6f 63   7   /* A malloc
4610: 28 29 20 66 61 69 6c 65 64 20 2a 2f 0a 23 64 65  () failed */.#de
4620: 66 69 6e 65 20 53 51 4c 49 54 45 5f 52 45 41 44  fine SQLITE_READ
4630: 4f 4e 4c 59 20 20 20 20 20 38 20 20 20 2f 2a 20  ONLY     8   /* 
4640: 41 74 74 65 6d 70 74 20 74 6f 20 77 72 69 74 65  Attempt to write
4650: 20 61 20 72 65 61 64 6f 6e 6c 79 20 64 61 74 61   a readonly data
4660: 62 61 73 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20  base */.#define 
4670: 53 51 4c 49 54 45 5f 49 4e 54 45 52 52 55 50 54  SQLITE_INTERRUPT
4680: 20 20 20 20 39 20 20 20 2f 2a 20 4f 70 65 72 61      9   /* Opera
4690: 74 69 6f 6e 20 74 65 72 6d 69 6e 61 74 65 64 20  tion terminated 
46a0: 62 79 20 73 71 6c 69 74 65 33 5f 69 6e 74 65 72  by sqlite3_inter
46b0: 72 75 70 74 28 29 2a 2f 0a 23 64 65 66 69 6e 65  rupt()*/.#define
46c0: 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 20 20 20   SQLITE_IOERR   
46d0: 20 20 20 20 31 30 20 20 20 2f 2a 20 53 6f 6d 65      10   /* Some
46e0: 20 6b 69 6e 64 20 6f 66 20 64 69 73 6b 20 49 2f   kind of disk I/
46f0: 4f 20 65 72 72 6f 72 20 6f 63 63 75 72 72 65 64  O error occurred
4700: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
4710: 54 45 5f 43 4f 52 52 55 50 54 20 20 20 20 20 31  TE_CORRUPT     1
4720: 31 20 20 20 2f 2a 20 54 68 65 20 64 61 74 61 62  1   /* The datab
4730: 61 73 65 20 64 69 73 6b 20 69 6d 61 67 65 20 69  ase disk image i
4740: 73 20 6d 61 6c 66 6f 72 6d 65 64 20 2a 2f 0a 23  s malformed */.#
4750: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4e 4f  define SQLITE_NO
4760: 54 46 4f 55 4e 44 20 20 20 20 31 32 20 20 20 2f  TFOUND    12   /
4770: 2a 20 55 6e 6b 6e 6f 77 6e 20 6f 70 63 6f 64 65  * Unknown opcode
4780: 20 69 6e 20 73 71 6c 69 74 65 33 5f 66 69 6c 65   in sqlite3_file
4790: 5f 63 6f 6e 74 72 6f 6c 28 29 20 2a 2f 0a 23 64  _control() */.#d
47a0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 55 4c  efine SQLITE_FUL
47b0: 4c 20 20 20 20 20 20 20 20 31 33 20 20 20 2f 2a  L        13   /*
47c0: 20 49 6e 73 65 72 74 69 6f 6e 20 66 61 69 6c 65   Insertion faile
47d0: 64 20 62 65 63 61 75 73 65 20 64 61 74 61 62 61  d because databa
47e0: 73 65 20 69 73 20 66 75 6c 6c 20 2a 2f 0a 23 64  se is full */.#d
47f0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 41 4e  efine SQLITE_CAN
4800: 54 4f 50 45 4e 20 20 20 20 31 34 20 20 20 2f 2a  TOPEN    14   /*
4810: 20 55 6e 61 62 6c 65 20 74 6f 20 6f 70 65 6e 20   Unable to open 
4820: 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c  the database fil
4830: 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  e */.#define SQL
4840: 49 54 45 5f 50 52 4f 54 4f 43 4f 4c 20 20 20 20  ITE_PROTOCOL    
4850: 31 35 20 20 20 2f 2a 20 44 61 74 61 62 61 73 65  15   /* Database
4860: 20 6c 6f 63 6b 20 70 72 6f 74 6f 63 6f 6c 20 65   lock protocol e
4870: 72 72 6f 72 20 2a 2f 0a 23 64 65 66 69 6e 65 20  rror */.#define 
4880: 53 51 4c 49 54 45 5f 45 4d 50 54 59 20 20 20 20  SQLITE_EMPTY    
4890: 20 20 20 31 36 20 20 20 2f 2a 20 44 61 74 61 62     16   /* Datab
48a0: 61 73 65 20 69 73 20 65 6d 70 74 79 20 2a 2f 0a  ase is empty */.
48b0: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53  #define SQLITE_S
48c0: 43 48 45 4d 41 20 20 20 20 20 20 31 37 20 20 20  CHEMA      17   
48d0: 2f 2a 20 54 68 65 20 64 61 74 61 62 61 73 65 20  /* The database 
48e0: 73 63 68 65 6d 61 20 63 68 61 6e 67 65 64 20 2a  schema changed *
48f0: 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
4900: 5f 54 4f 4f 42 49 47 20 20 20 20 20 20 31 38 20  _TOOBIG      18 
4910: 20 20 2f 2a 20 53 74 72 69 6e 67 20 6f 72 20 42    /* String or B
4920: 4c 4f 42 20 65 78 63 65 65 64 73 20 73 69 7a 65  LOB exceeds size
4930: 20 6c 69 6d 69 74 20 2a 2f 0a 23 64 65 66 69 6e   limit */.#defin
4940: 65 20 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41  e SQLITE_CONSTRA
4950: 49 4e 54 20 20 31 39 20 20 20 2f 2a 20 41 62 6f  INT  19   /* Abo
4960: 72 74 20 64 75 65 20 74 6f 20 63 6f 6e 73 74 72  rt due to constr
4970: 61 69 6e 74 20 76 69 6f 6c 61 74 69 6f 6e 20 2a  aint violation *
4980: 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
4990: 5f 4d 49 53 4d 41 54 43 48 20 20 20 20 32 30 20  _MISMATCH    20 
49a0: 20 20 2f 2a 20 44 61 74 61 20 74 79 70 65 20 6d    /* Data type m
49b0: 69 73 6d 61 74 63 68 20 2a 2f 0a 23 64 65 66 69  ismatch */.#defi
49c0: 6e 65 20 53 51 4c 49 54 45 5f 4d 49 53 55 53 45  ne SQLITE_MISUSE
49d0: 20 20 20 20 20 20 32 31 20 20 20 2f 2a 20 4c 69        21   /* Li
49e0: 62 72 61 72 79 20 75 73 65 64 20 69 6e 63 6f 72  brary used incor
49f0: 72 65 63 74 6c 79 20 2a 2f 0a 23 64 65 66 69 6e  rectly */.#defin
4a00: 65 20 53 51 4c 49 54 45 5f 4e 4f 4c 46 53 20 20  e SQLITE_NOLFS  
4a10: 20 20 20 20 20 32 32 20 20 20 2f 2a 20 55 73 65       22   /* Use
4a20: 73 20 4f 53 20 66 65 61 74 75 72 65 73 20 6e 6f  s OS features no
4a30: 74 20 73 75 70 70 6f 72 74 65 64 20 6f 6e 20 68  t supported on h
4a40: 6f 73 74 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ost */.#define S
4a50: 51 4c 49 54 45 5f 41 55 54 48 20 20 20 20 20 20  QLITE_AUTH      
4a60: 20 20 32 33 20 20 20 2f 2a 20 41 75 74 68 6f 72    23   /* Author
4a70: 69 7a 61 74 69 6f 6e 20 64 65 6e 69 65 64 20 2a  ization denied *
4a80: 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
4a90: 5f 46 4f 52 4d 41 54 20 20 20 20 20 20 32 34 20  _FORMAT      24 
4aa0: 20 20 2f 2a 20 41 75 78 69 6c 69 61 72 79 20 64    /* Auxiliary d
4ab0: 61 74 61 62 61 73 65 20 66 6f 72 6d 61 74 20 65  atabase format e
4ac0: 72 72 6f 72 20 2a 2f 0a 23 64 65 66 69 6e 65 20  rror */.#define 
4ad0: 53 51 4c 49 54 45 5f 52 41 4e 47 45 20 20 20 20  SQLITE_RANGE    
4ae0: 20 20 20 32 35 20 20 20 2f 2a 20 32 6e 64 20 70     25   /* 2nd p
4af0: 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69  arameter to sqli
4b00: 74 65 33 5f 62 69 6e 64 20 6f 75 74 20 6f 66 20  te3_bind out of 
4b10: 72 61 6e 67 65 20 2a 2f 0a 23 64 65 66 69 6e 65  range */.#define
4b20: 20 53 51 4c 49 54 45 5f 4e 4f 54 41 44 42 20 20   SQLITE_NOTADB  
4b30: 20 20 20 20 32 36 20 20 20 2f 2a 20 46 69 6c 65      26   /* File
4b40: 20 6f 70 65 6e 65 64 20 74 68 61 74 20 69 73 20   opened that is 
4b50: 6e 6f 74 20 61 20 64 61 74 61 62 61 73 65 20 66  not a database f
4b60: 69 6c 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ile */.#define S
4b70: 51 4c 49 54 45 5f 4e 4f 54 49 43 45 20 20 20 20  QLITE_NOTICE    
4b80: 20 20 32 37 20 20 20 2f 2a 20 4e 6f 74 69 66 69    27   /* Notifi
4b90: 63 61 74 69 6f 6e 73 20 66 72 6f 6d 20 73 71 6c  cations from sql
4ba0: 69 74 65 33 5f 6c 6f 67 28 29 20 2a 2f 0a 23 64  ite3_log() */.#d
4bb0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 57 41 52  efine SQLITE_WAR
4bc0: 4e 49 4e 47 20 20 20 20 20 32 38 20 20 20 2f 2a  NING     28   /*
4bd0: 20 57 61 72 6e 69 6e 67 73 20 66 72 6f 6d 20 73   Warnings from s
4be0: 71 6c 69 74 65 33 5f 6c 6f 67 28 29 20 2a 2f 0a  qlite3_log() */.
4bf0: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 52  #define SQLITE_R
4c00: 4f 57 20 20 20 20 20 20 20 20 20 31 30 30 20 20  OW         100  
4c10: 2f 2a 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28  /* sqlite3_step(
4c20: 29 20 68 61 73 20 61 6e 6f 74 68 65 72 20 72 6f  ) has another ro
4c30: 77 20 72 65 61 64 79 20 2a 2f 0a 23 64 65 66 69  w ready */.#defi
4c40: 6e 65 20 53 51 4c 49 54 45 5f 44 4f 4e 45 20 20  ne SQLITE_DONE  
4c50: 20 20 20 20 20 20 31 30 31 20 20 2f 2a 20 73 71        101  /* sq
4c60: 6c 69 74 65 33 5f 73 74 65 70 28 29 20 68 61 73  lite3_step() has
4c70: 20 66 69 6e 69 73 68 65 64 20 65 78 65 63 75 74   finished execut
4c80: 69 6e 67 20 2a 2f 0a 2f 2a 20 65 6e 64 2d 6f 66  ing */./* end-of
4c90: 2d 65 72 72 6f 72 2d 63 6f 64 65 73 20 2a 2f 0a  -error-codes */.
4ca0: 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
4cb0: 20 45 78 74 65 6e 64 65 64 20 52 65 73 75 6c 74   Extended Result
4cc0: 20 43 6f 64 65 73 0a 2a 2a 20 4b 45 59 57 4f 52   Codes.** KEYWOR
4cd0: 44 53 3a 20 7b 65 78 74 65 6e 64 65 64 20 72 65  DS: {extended re
4ce0: 73 75 6c 74 20 63 6f 64 65 20 64 65 66 69 6e 69  sult code defini
4cf0: 74 69 6f 6e 73 7d 0a 2a 2a 0a 2a 2a 20 49 6e 20  tions}.**.** In 
4d00: 69 74 73 20 64 65 66 61 75 6c 74 20 63 6f 6e 66  its default conf
4d10: 69 67 75 72 61 74 69 6f 6e 2c 20 53 51 4c 69 74  iguration, SQLit
4d20: 65 20 41 50 49 20 72 6f 75 74 69 6e 65 73 20 72  e API routines r
4d30: 65 74 75 72 6e 20 6f 6e 65 20 6f 66 20 33 30 20  eturn one of 30 
4d40: 69 6e 74 65 67 65 72 0a 2a 2a 20 5b 72 65 73 75  integer.** [resu
4d50: 6c 74 20 63 6f 64 65 73 5d 2e 20 20 48 6f 77 65  lt codes].  Howe
4d60: 76 65 72 2c 20 65 78 70 65 72 69 65 6e 63 65 20  ver, experience 
4d70: 68 61 73 20 73 68 6f 77 6e 20 74 68 61 74 20 6d  has shown that m
4d80: 61 6e 79 20 6f 66 0a 2a 2a 20 74 68 65 73 65 20  any of.** these 
4d90: 72 65 73 75 6c 74 20 63 6f 64 65 73 20 61 72 65  result codes are
4da0: 20 74 6f 6f 20 63 6f 61 72 73 65 2d 67 72 61 69   too coarse-grai
4db0: 6e 65 64 2e 20 20 54 68 65 79 20 64 6f 20 6e 6f  ned.  They do no
4dc0: 74 20 70 72 6f 76 69 64 65 20 61 73 0a 2a 2a 20  t provide as.** 
4dd0: 6d 75 63 68 20 69 6e 66 6f 72 6d 61 74 69 6f 6e  much information
4de0: 20 61 62 6f 75 74 20 70 72 6f 62 6c 65 6d 73 20   about problems 
4df0: 61 73 20 70 72 6f 67 72 61 6d 6d 65 72 73 20 6d  as programmers m
4e00: 69 67 68 74 20 6c 69 6b 65 2e 20 20 49 6e 20 61  ight like.  In a
4e10: 6e 20 65 66 66 6f 72 74 20 74 6f 0a 2a 2a 20 61  n effort to.** a
4e20: 64 64 72 65 73 73 20 74 68 69 73 2c 20 6e 65 77  ddress this, new
4e30: 65 72 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 53  er versions of S
4e40: 51 4c 69 74 65 20 28 76 65 72 73 69 6f 6e 20 33  QLite (version 3
4e50: 2e 33 2e 38 20 61 6e 64 20 6c 61 74 65 72 29 20  .3.8 and later) 
4e60: 69 6e 63 6c 75 64 65 0a 2a 2a 20 73 75 70 70 6f  include.** suppo
4e70: 72 74 20 66 6f 72 20 61 64 64 69 74 69 6f 6e 61  rt for additiona
4e80: 6c 20 72 65 73 75 6c 74 20 63 6f 64 65 73 20 74  l result codes t
4e90: 68 61 74 20 70 72 6f 76 69 64 65 20 6d 6f 72 65  hat provide more
4ea0: 20 64 65 74 61 69 6c 65 64 20 69 6e 66 6f 72 6d   detailed inform
4eb0: 61 74 69 6f 6e 0a 2a 2a 20 61 62 6f 75 74 20 65  ation.** about e
4ec0: 72 72 6f 72 73 2e 20 54 68 65 73 65 20 5b 65 78  rrors. These [ex
4ed0: 74 65 6e 64 65 64 20 72 65 73 75 6c 74 20 63 6f  tended result co
4ee0: 64 65 73 5d 20 61 72 65 20 65 6e 61 62 6c 65 64  des] are enabled
4ef0: 20 6f 72 20 64 69 73 61 62 6c 65 64 0a 2a 2a 20   or disabled.** 
4f00: 6f 6e 20 61 20 70 65 72 20 64 61 74 61 62 61 73  on a per databas
4f10: 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 62 61 73  e connection bas
4f20: 69 73 20 75 73 69 6e 67 20 74 68 65 0a 2a 2a 20  is using the.** 
4f30: 5b 73 71 6c 69 74 65 33 5f 65 78 74 65 6e 64 65  [sqlite3_extende
4f40: 64 5f 72 65 73 75 6c 74 5f 63 6f 64 65 73 28 29  d_result_codes()
4f50: 5d 20 41 50 49 2e 20 20 4f 72 2c 20 74 68 65 20  ] API.  Or, the 
4f60: 65 78 74 65 6e 64 65 64 20 63 6f 64 65 20 66 6f  extended code fo
4f70: 72 0a 2a 2a 20 74 68 65 20 6d 6f 73 74 20 72 65  r.** the most re
4f80: 63 65 6e 74 20 65 72 72 6f 72 20 63 61 6e 20 62  cent error can b
4f90: 65 20 6f 62 74 61 69 6e 65 64 20 75 73 69 6e 67  e obtained using
4fa0: 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 65 78 74  .** [sqlite3_ext
4fb0: 65 6e 64 65 64 5f 65 72 72 63 6f 64 65 28 29 5d  ended_errcode()]
4fc0: 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  ..*/.#define SQL
4fd0: 49 54 45 5f 49 4f 45 52 52 5f 52 45 41 44 20 20  ITE_IOERR_READ  
4fe0: 20 20 20 20 20 20 20 20 20 20 20 20 28 53 51 4c              (SQL
4ff0: 49 54 45 5f 49 4f 45 52 52 20 7c 20 28 31 3c 3c  ITE_IOERR | (1<<
5000: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
5010: 54 45 5f 49 4f 45 52 52 5f 53 48 4f 52 54 5f 52  TE_IOERR_SHORT_R
5020: 45 41 44 20 20 20 20 20 20 20 20 28 53 51 4c 49  EAD        (SQLI
5030: 54 45 5f 49 4f 45 52 52 20 7c 20 28 32 3c 3c 38  TE_IOERR | (2<<8
5040: 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  )).#define SQLIT
5050: 45 5f 49 4f 45 52 52 5f 57 52 49 54 45 20 20 20  E_IOERR_WRITE   
5060: 20 20 20 20 20 20 20 20 20 20 28 53 51 4c 49 54            (SQLIT
5070: 45 5f 49 4f 45 52 52 20 7c 20 28 33 3c 3c 38 29  E_IOERR | (3<<8)
5080: 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  ).#define SQLITE
5090: 5f 49 4f 45 52 52 5f 46 53 59 4e 43 20 20 20 20  _IOERR_FSYNC    
50a0: 20 20 20 20 20 20 20 20 20 28 53 51 4c 49 54 45           (SQLITE
50b0: 5f 49 4f 45 52 52 20 7c 20 28 34 3c 3c 38 29 29  _IOERR | (4<<8))
50c0: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
50d0: 49 4f 45 52 52 5f 44 49 52 5f 46 53 59 4e 43 20  IOERR_DIR_FSYNC 
50e0: 20 20 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f          (SQLITE_
50f0: 49 4f 45 52 52 20 7c 20 28 35 3c 3c 38 29 29 0a  IOERR | (5<<8)).
5100: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49  #define SQLITE_I
5110: 4f 45 52 52 5f 54 52 55 4e 43 41 54 45 20 20 20  OERR_TRUNCATE   
5120: 20 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 49         (SQLITE_I
5130: 4f 45 52 52 20 7c 20 28 36 3c 3c 38 29 29 0a 23  OERR | (6<<8)).#
5140: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f  define SQLITE_IO
5150: 45 52 52 5f 46 53 54 41 54 20 20 20 20 20 20 20  ERR_FSTAT       
5160: 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 49 4f        (SQLITE_IO
5170: 45 52 52 20 7c 20 28 37 3c 3c 38 29 29 0a 23 64  ERR | (7<<8)).#d
5180: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45  efine SQLITE_IOE
5190: 52 52 5f 55 4e 4c 4f 43 4b 20 20 20 20 20 20 20  RR_UNLOCK       
51a0: 20 20 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45       (SQLITE_IOE
51b0: 52 52 20 7c 20 28 38 3c 3c 38 29 29 0a 23 64 65  RR | (8<<8)).#de
51c0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52  fine SQLITE_IOER
51d0: 52 5f 52 44 4c 4f 43 4b 20 20 20 20 20 20 20 20  R_RDLOCK        
51e0: 20 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52      (SQLITE_IOER
51f0: 52 20 7c 20 28 39 3c 3c 38 29 29 0a 23 64 65 66  R | (9<<8)).#def
5200: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5210: 5f 44 45 4c 45 54 45 20 20 20 20 20 20 20 20 20  _DELETE         
5220: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
5230: 20 7c 20 28 31 30 3c 3c 38 29 29 0a 23 64 65 66   | (10<<8)).#def
5240: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5250: 5f 42 4c 4f 43 4b 45 44 20 20 20 20 20 20 20 20  _BLOCKED        
5260: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
5270: 20 7c 20 28 31 31 3c 3c 38 29 29 0a 23 64 65 66   | (11<<8)).#def
5280: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5290: 5f 4e 4f 4d 45 4d 20 20 20 20 20 20 20 20 20 20  _NOMEM          
52a0: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
52b0: 20 7c 20 28 31 32 3c 3c 38 29 29 0a 23 64 65 66   | (12<<8)).#def
52c0: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
52d0: 5f 41 43 43 45 53 53 20 20 20 20 20 20 20 20 20  _ACCESS         
52e0: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
52f0: 20 7c 20 28 31 33 3c 3c 38 29 29 0a 23 64 65 66   | (13<<8)).#def
5300: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5310: 5f 43 48 45 43 4b 52 45 53 45 52 56 45 44 4c 4f  _CHECKRESERVEDLO
5320: 43 4b 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52  CK (SQLITE_IOERR
5330: 20 7c 20 28 31 34 3c 3c 38 29 29 0a 23 64 65 66   | (14<<8)).#def
5340: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5350: 5f 4c 4f 43 4b 20 20 20 20 20 20 20 20 20 20 20  _LOCK           
5360: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
5370: 20 7c 20 28 31 35 3c 3c 38 29 29 0a 23 64 65 66   | (15<<8)).#def
5380: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5390: 5f 43 4c 4f 53 45 20 20 20 20 20 20 20 20 20 20  _CLOSE          
53a0: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
53b0: 20 7c 20 28 31 36 3c 3c 38 29 29 0a 23 64 65 66   | (16<<8)).#def
53c0: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
53d0: 5f 44 49 52 5f 43 4c 4f 53 45 20 20 20 20 20 20  _DIR_CLOSE      
53e0: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
53f0: 20 7c 20 28 31 37 3c 3c 38 29 29 0a 23 64 65 66   | (17<<8)).#def
5400: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5410: 5f 53 48 4d 4f 50 45 4e 20 20 20 20 20 20 20 20  _SHMOPEN        
5420: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
5430: 20 7c 20 28 31 38 3c 3c 38 29 29 0a 23 64 65 66   | (18<<8)).#def
5440: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5450: 5f 53 48 4d 53 49 5a 45 20 20 20 20 20 20 20 20  _SHMSIZE        
5460: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
5470: 20 7c 20 28 31 39 3c 3c 38 29 29 0a 23 64 65 66   | (19<<8)).#def
5480: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5490: 5f 53 48 4d 4c 4f 43 4b 20 20 20 20 20 20 20 20  _SHMLOCK        
54a0: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
54b0: 20 7c 20 28 32 30 3c 3c 38 29 29 0a 23 64 65 66   | (20<<8)).#def
54c0: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
54d0: 5f 53 48 4d 4d 41 50 20 20 20 20 20 20 20 20 20  _SHMMAP         
54e0: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
54f0: 20 7c 20 28 32 31 3c 3c 38 29 29 0a 23 64 65 66   | (21<<8)).#def
5500: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5510: 5f 53 45 45 4b 20 20 20 20 20 20 20 20 20 20 20  _SEEK           
5520: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
5530: 20 7c 20 28 32 32 3c 3c 38 29 29 0a 23 64 65 66   | (22<<8)).#def
5540: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5550: 5f 44 45 4c 45 54 45 5f 4e 4f 45 4e 54 20 20 20  _DELETE_NOENT   
5560: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
5570: 20 7c 20 28 32 33 3c 3c 38 29 29 0a 23 64 65 66   | (23<<8)).#def
5580: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5590: 5f 4d 4d 41 50 20 20 20 20 20 20 20 20 20 20 20  _MMAP           
55a0: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
55b0: 20 7c 20 28 32 34 3c 3c 38 29 29 0a 23 64 65 66   | (24<<8)).#def
55c0: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
55d0: 5f 47 45 54 54 45 4d 50 50 41 54 48 20 20 20 20  _GETTEMPPATH    
55e0: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
55f0: 20 7c 20 28 32 35 3c 3c 38 29 29 0a 23 64 65 66   | (25<<8)).#def
5600: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5610: 5f 43 4f 4e 56 50 41 54 48 20 20 20 20 20 20 20  _CONVPATH       
5620: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
5630: 20 7c 20 28 32 36 3c 3c 38 29 29 0a 23 64 65 66   | (26<<8)).#def
5640: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5650: 5f 56 4e 4f 44 45 20 20 20 20 20 20 20 20 20 20  _VNODE          
5660: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
5670: 20 7c 20 28 32 37 3c 3c 38 29 29 0a 23 64 65 66   | (27<<8)).#def
5680: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5690: 5f 41 55 54 48 20 20 20 20 20 20 20 20 20 20 20  _AUTH           
56a0: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
56b0: 20 7c 20 28 32 38 3c 3c 38 29 29 0a 23 64 65 66   | (28<<8)).#def
56c0: 69 6e 65 20 53 51 4c 49 54 45 5f 4c 4f 43 4b 45  ine SQLITE_LOCKE
56d0: 44 5f 53 48 41 52 45 44 43 41 43 48 45 20 20 20  D_SHAREDCACHE   
56e0: 20 20 20 28 53 51 4c 49 54 45 5f 4c 4f 43 4b 45     (SQLITE_LOCKE
56f0: 44 20 7c 20 20 28 31 3c 3c 38 29 29 0a 23 64 65  D |  (1<<8)).#de
5700: 66 69 6e 65 20 53 51 4c 49 54 45 5f 42 55 53 59  fine SQLITE_BUSY
5710: 5f 52 45 43 4f 56 45 52 59 20 20 20 20 20 20 20  _RECOVERY       
5720: 20 20 20 20 28 53 51 4c 49 54 45 5f 42 55 53 59      (SQLITE_BUSY
5730: 20 20 20 7c 20 20 28 31 3c 3c 38 29 29 0a 23 64     |  (1<<8)).#d
5740: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 42 55 53  efine SQLITE_BUS
5750: 59 5f 53 4e 41 50 53 48 4f 54 20 20 20 20 20 20  Y_SNAPSHOT      
5760: 20 20 20 20 20 28 53 51 4c 49 54 45 5f 42 55 53       (SQLITE_BUS
5770: 59 20 20 20 7c 20 20 28 32 3c 3c 38 29 29 0a 23  Y   |  (2<<8)).#
5780: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 41  define SQLITE_CA
5790: 4e 54 4f 50 45 4e 5f 4e 4f 54 45 4d 50 44 49 52  NTOPEN_NOTEMPDIR
57a0: 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 43 41        (SQLITE_CA
57b0: 4e 54 4f 50 45 4e 20 7c 20 28 31 3c 3c 38 29 29  NTOPEN | (1<<8))
57c0: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
57d0: 43 41 4e 54 4f 50 45 4e 5f 49 53 44 49 52 20 20  CANTOPEN_ISDIR  
57e0: 20 20 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f          (SQLITE_
57f0: 43 41 4e 54 4f 50 45 4e 20 7c 20 28 32 3c 3c 38  CANTOPEN | (2<<8
5800: 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  )).#define SQLIT
5810: 45 5f 43 41 4e 54 4f 50 45 4e 5f 46 55 4c 4c 50  E_CANTOPEN_FULLP
5820: 41 54 48 20 20 20 20 20 20 20 28 53 51 4c 49 54  ATH       (SQLIT
5830: 45 5f 43 41 4e 54 4f 50 45 4e 20 7c 20 28 33 3c  E_CANTOPEN | (3<
5840: 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c  <8)).#define SQL
5850: 49 54 45 5f 43 41 4e 54 4f 50 45 4e 5f 43 4f 4e  ITE_CANTOPEN_CON
5860: 56 50 41 54 48 20 20 20 20 20 20 20 28 53 51 4c  VPATH       (SQL
5870: 49 54 45 5f 43 41 4e 54 4f 50 45 4e 20 7c 20 28  ITE_CANTOPEN | (
5880: 34 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53  4<<8)).#define S
5890: 51 4c 49 54 45 5f 43 4f 52 52 55 50 54 5f 56 54  QLITE_CORRUPT_VT
58a0: 41 42 20 20 20 20 20 20 20 20 20 20 20 20 28 53  AB            (S
58b0: 51 4c 49 54 45 5f 43 4f 52 52 55 50 54 20 7c 20  QLITE_CORRUPT | 
58c0: 28 31 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20  (1<<8)).#define 
58d0: 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c 59 5f  SQLITE_READONLY_
58e0: 52 45 43 4f 56 45 52 59 20 20 20 20 20 20 20 28  RECOVERY       (
58f0: 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c 59 20  SQLITE_READONLY 
5900: 7c 20 28 31 3c 3c 38 29 29 0a 23 64 65 66 69 6e  | (1<<8)).#defin
5910: 65 20 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c  e SQLITE_READONL
5920: 59 5f 43 41 4e 54 4c 4f 43 4b 20 20 20 20 20 20  Y_CANTLOCK      
5930: 20 28 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c   (SQLITE_READONL
5940: 59 20 7c 20 28 32 3c 3c 38 29 29 0a 23 64 65 66  Y | (2<<8)).#def
5950: 69 6e 65 20 53 51 4c 49 54 45 5f 52 45 41 44 4f  ine SQLITE_READO
5960: 4e 4c 59 5f 52 4f 4c 4c 42 41 43 4b 20 20 20 20  NLY_ROLLBACK    
5970: 20 20 20 28 53 51 4c 49 54 45 5f 52 45 41 44 4f     (SQLITE_READO
5980: 4e 4c 59 20 7c 20 28 33 3c 3c 38 29 29 0a 23 64  NLY | (3<<8)).#d
5990: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 52 45 41  efine SQLITE_REA
59a0: 44 4f 4e 4c 59 5f 44 42 4d 4f 56 45 44 20 20 20  DONLY_DBMOVED   
59b0: 20 20 20 20 20 28 53 51 4c 49 54 45 5f 52 45 41       (SQLITE_REA
59c0: 44 4f 4e 4c 59 20 7c 20 28 34 3c 3c 38 29 29 0a  DONLY | (4<<8)).
59d0: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41  #define SQLITE_A
59e0: 42 4f 52 54 5f 52 4f 4c 4c 42 41 43 4b 20 20 20  BORT_ROLLBACK   
59f0: 20 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 41         (SQLITE_A
5a00: 42 4f 52 54 20 7c 20 28 32 3c 3c 38 29 29 0a 23  BORT | (2<<8)).#
5a10: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f  define SQLITE_CO
5a20: 4e 53 54 52 41 49 4e 54 5f 43 48 45 43 4b 20 20  NSTRAINT_CHECK  
5a30: 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 43 4f        (SQLITE_CO
5a40: 4e 53 54 52 41 49 4e 54 20 7c 20 28 31 3c 3c 38  NSTRAINT | (1<<8
5a50: 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  )).#define SQLIT
5a60: 45 5f 43 4f 4e 53 54 52 41 49 4e 54 5f 43 4f 4d  E_CONSTRAINT_COM
5a70: 4d 49 54 48 4f 4f 4b 20 20 20 28 53 51 4c 49 54  MITHOOK   (SQLIT
5a80: 45 5f 43 4f 4e 53 54 52 41 49 4e 54 20 7c 20 28  E_CONSTRAINT | (
5a90: 32 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53  2<<8)).#define S
5aa0: 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49 4e 54  QLITE_CONSTRAINT
5ab0: 5f 46 4f 52 45 49 47 4e 4b 45 59 20 20 20 28 53  _FOREIGNKEY   (S
5ac0: 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49 4e 54  QLITE_CONSTRAINT
5ad0: 20 7c 20 28 33 3c 3c 38 29 29 0a 23 64 65 66 69   | (3<<8)).#defi
5ae0: 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52  ne SQLITE_CONSTR
5af0: 41 49 4e 54 5f 46 55 4e 43 54 49 4f 4e 20 20 20  AINT_FUNCTION   
5b00: 20 20 28 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52    (SQLITE_CONSTR
5b10: 41 49 4e 54 20 7c 20 28 34 3c 3c 38 29 29 0a 23  AINT | (4<<8)).#
5b20: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f  define SQLITE_CO
5b30: 4e 53 54 52 41 49 4e 54 5f 4e 4f 54 4e 55 4c 4c  NSTRAINT_NOTNULL
5b40: 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 43 4f        (SQLITE_CO
5b50: 4e 53 54 52 41 49 4e 54 20 7c 20 28 35 3c 3c 38  NSTRAINT | (5<<8
5b60: 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  )).#define SQLIT
5b70: 45 5f 43 4f 4e 53 54 52 41 49 4e 54 5f 50 52 49  E_CONSTRAINT_PRI
5b80: 4d 41 52 59 4b 45 59 20 20 20 28 53 51 4c 49 54  MARYKEY   (SQLIT
5b90: 45 5f 43 4f 4e 53 54 52 41 49 4e 54 20 7c 20 28  E_CONSTRAINT | (
5ba0: 36 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53  6<<8)).#define S
5bb0: 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49 4e 54  QLITE_CONSTRAINT
5bc0: 5f 54 52 49 47 47 45 52 20 20 20 20 20 20 28 53  _TRIGGER      (S
5bd0: 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49 4e 54  QLITE_CONSTRAINT
5be0: 20 7c 20 28 37 3c 3c 38 29 29 0a 23 64 65 66 69   | (7<<8)).#defi
5bf0: 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52  ne SQLITE_CONSTR
5c00: 41 49 4e 54 5f 55 4e 49 51 55 45 20 20 20 20 20  AINT_UNIQUE     
5c10: 20 20 28 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52    (SQLITE_CONSTR
5c20: 41 49 4e 54 20 7c 20 28 38 3c 3c 38 29 29 0a 23  AINT | (8<<8)).#
5c30: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f  define SQLITE_CO
5c40: 4e 53 54 52 41 49 4e 54 5f 56 54 41 42 20 20 20  NSTRAINT_VTAB   
5c50: 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 43 4f        (SQLITE_CO
5c60: 4e 53 54 52 41 49 4e 54 20 7c 20 28 39 3c 3c 38  NSTRAINT | (9<<8
5c70: 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  )).#define SQLIT
5c80: 45 5f 43 4f 4e 53 54 52 41 49 4e 54 5f 52 4f 57  E_CONSTRAINT_ROW
5c90: 49 44 20 20 20 20 20 20 20 20 28 53 51 4c 49 54  ID        (SQLIT
5ca0: 45 5f 43 4f 4e 53 54 52 41 49 4e 54 20 7c 28 31  E_CONSTRAINT |(1
5cb0: 30 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53  0<<8)).#define S
5cc0: 51 4c 49 54 45 5f 4e 4f 54 49 43 45 5f 52 45 43  QLITE_NOTICE_REC
5cd0: 4f 56 45 52 5f 57 41 4c 20 20 20 20 20 20 28 53  OVER_WAL      (S
5ce0: 51 4c 49 54 45 5f 4e 4f 54 49 43 45 20 7c 20 28  QLITE_NOTICE | (
5cf0: 31 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53  1<<8)).#define S
5d00: 51 4c 49 54 45 5f 4e 4f 54 49 43 45 5f 52 45 43  QLITE_NOTICE_REC
5d10: 4f 56 45 52 5f 52 4f 4c 4c 42 41 43 4b 20 28 53  OVER_ROLLBACK (S
5d20: 51 4c 49 54 45 5f 4e 4f 54 49 43 45 20 7c 20 28  QLITE_NOTICE | (
5d30: 32 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53  2<<8)).#define S
5d40: 51 4c 49 54 45 5f 57 41 52 4e 49 4e 47 5f 41 55  QLITE_WARNING_AU
5d50: 54 4f 49 4e 44 45 58 20 20 20 20 20 20 20 28 53  TOINDEX       (S
5d60: 51 4c 49 54 45 5f 57 41 52 4e 49 4e 47 20 7c 20  QLITE_WARNING | 
5d70: 28 31 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20  (1<<8)).#define 
5d80: 53 51 4c 49 54 45 5f 41 55 54 48 5f 55 53 45 52  SQLITE_AUTH_USER
5d90: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 28                 (
5da0: 53 51 4c 49 54 45 5f 41 55 54 48 20 7c 20 28 31  SQLITE_AUTH | (1
5db0: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
5dc0: 4c 49 54 45 5f 4f 4b 5f 4c 4f 41 44 5f 50 45 52  LITE_OK_LOAD_PER
5dd0: 4d 41 4e 45 4e 54 4c 59 20 20 20 20 20 28 53 51  MANENTLY     (SQ
5de0: 4c 49 54 45 5f 4f 4b 20 7c 20 28 31 3c 3c 38 29  LITE_OK | (1<<8)
5df0: 29 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  )../*.** CAPI3RE
5e00: 46 3a 20 46 6c 61 67 73 20 46 6f 72 20 46 69 6c  F: Flags For Fil
5e10: 65 20 4f 70 65 6e 20 4f 70 65 72 61 74 69 6f 6e  e Open Operation
5e20: 73 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 62 69  s.**.** These bi
5e30: 74 20 76 61 6c 75 65 73 20 61 72 65 20 69 6e 74  t values are int
5e40: 65 6e 64 65 64 20 66 6f 72 20 75 73 65 20 69 6e  ended for use in
5e50: 20 74 68 65 0a 2a 2a 20 33 72 64 20 70 61 72 61   the.** 3rd para
5e60: 6d 65 74 65 72 20 74 6f 20 74 68 65 20 5b 73 71  meter to the [sq
5e70: 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 5d  lite3_open_v2()]
5e80: 20 69 6e 74 65 72 66 61 63 65 20 61 6e 64 0a 2a   interface and.*
5e90: 2a 20 69 6e 20 74 68 65 20 34 74 68 20 70 61 72  * in the 4th par
5ea0: 61 6d 65 74 65 72 20 74 6f 20 74 68 65 20 5b 73  ameter to the [s
5eb0: 71 6c 69 74 65 33 5f 76 66 73 2e 78 4f 70 65 6e  qlite3_vfs.xOpen
5ec0: 5d 20 6d 65 74 68 6f 64 2e 0a 2a 2f 0a 23 64 65  ] method..*/.#de
5ed0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
5ee0: 5f 52 45 41 44 4f 4e 4c 59 20 20 20 20 20 20 20  _READONLY       
5ef0: 20 20 30 78 30 30 30 30 30 30 30 31 20 20 2f 2a    0x00000001  /*
5f00: 20 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f   Ok for sqlite3_
5f10: 6f 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65  open_v2() */.#de
5f20: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
5f30: 5f 52 45 41 44 57 52 49 54 45 20 20 20 20 20 20  _READWRITE      
5f40: 20 20 30 78 30 30 30 30 30 30 30 32 20 20 2f 2a    0x00000002  /*
5f50: 20 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f   Ok for sqlite3_
5f60: 6f 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65  open_v2() */.#de
5f70: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
5f80: 5f 43 52 45 41 54 45 20 20 20 20 20 20 20 20 20  _CREATE         
5f90: 20 20 30 78 30 30 30 30 30 30 30 34 20 20 2f 2a    0x00000004  /*
5fa0: 20 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f   Ok for sqlite3_
5fb0: 6f 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65  open_v2() */.#de
5fc0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
5fd0: 5f 44 45 4c 45 54 45 4f 4e 43 4c 4f 53 45 20 20  _DELETEONCLOSE  
5fe0: 20 20 30 78 30 30 30 30 30 30 30 38 20 20 2f 2a    0x00000008  /*
5ff0: 20 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65   VFS only */.#de
6000: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
6010: 5f 45 58 43 4c 55 53 49 56 45 20 20 20 20 20 20  _EXCLUSIVE      
6020: 20 20 30 78 30 30 30 30 30 30 31 30 20 20 2f 2a    0x00000010  /*
6030: 20 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65   VFS only */.#de
6040: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
6050: 5f 41 55 54 4f 50 52 4f 58 59 20 20 20 20 20 20  _AUTOPROXY      
6060: 20 20 30 78 30 30 30 30 30 30 32 30 20 20 2f 2a    0x00000020  /*
6070: 20 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65   VFS only */.#de
6080: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
6090: 5f 55 52 49 20 20 20 20 20 20 20 20 20 20 20 20  _URI            
60a0: 20 20 30 78 30 30 30 30 30 30 34 30 20 20 2f 2a    0x00000040  /*
60b0: 20 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f   Ok for sqlite3_
60c0: 6f 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65  open_v2() */.#de
60d0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
60e0: 5f 4d 45 4d 4f 52 59 20 20 20 20 20 20 20 20 20  _MEMORY         
60f0: 20 20 30 78 30 30 30 30 30 30 38 30 20 20 2f 2a    0x00000080  /*
6100: 20 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f   Ok for sqlite3_
6110: 6f 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65  open_v2() */.#de
6120: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
6130: 5f 4d 41 49 4e 5f 44 42 20 20 20 20 20 20 20 20  _MAIN_DB        
6140: 20 20 30 78 30 30 30 30 30 31 30 30 20 20 2f 2a    0x00000100  /*
6150: 20 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65   VFS only */.#de
6160: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
6170: 5f 54 45 4d 50 5f 44 42 20 20 20 20 20 20 20 20  _TEMP_DB        
6180: 20 20 30 78 30 30 30 30 30 32 30 30 20 20 2f 2a    0x00000200  /*
6190: 20 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65   VFS only */.#de
61a0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
61b0: 5f 54 52 41 4e 53 49 45 4e 54 5f 44 42 20 20 20  _TRANSIENT_DB   
61c0: 20 20 30 78 30 30 30 30 30 34 30 30 20 20 2f 2a    0x00000400  /*
61d0: 20 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65   VFS only */.#de
61e0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
61f0: 5f 4d 41 49 4e 5f 4a 4f 55 52 4e 41 4c 20 20 20  _MAIN_JOURNAL   
6200: 20 20 30 78 30 30 30 30 30 38 30 30 20 20 2f 2a    0x00000800  /*
6210: 20 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65   VFS only */.#de
6220: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
6230: 5f 54 45 4d 50 5f 4a 4f 55 52 4e 41 4c 20 20 20  _TEMP_JOURNAL   
6240: 20 20 30 78 30 30 30 30 31 30 30 30 20 20 2f 2a    0x00001000  /*
6250: 20 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65   VFS only */.#de
6260: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
6270: 5f 53 55 42 4a 4f 55 52 4e 41 4c 20 20 20 20 20  _SUBJOURNAL     
6280: 20 20 30 78 30 30 30 30 32 30 30 30 20 20 2f 2a    0x00002000  /*
6290: 20 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65   VFS only */.#de
62a0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
62b0: 5f 4d 41 53 54 45 52 5f 4a 4f 55 52 4e 41 4c 20  _MASTER_JOURNAL 
62c0: 20 20 30 78 30 30 30 30 34 30 30 30 20 20 2f 2a    0x00004000  /*
62d0: 20 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65   VFS only */.#de
62e0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
62f0: 5f 4e 4f 4d 55 54 45 58 20 20 20 20 20 20 20 20  _NOMUTEX        
6300: 20 20 30 78 30 30 30 30 38 30 30 30 20 20 2f 2a    0x00008000  /*
6310: 20 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f   Ok for sqlite3_
6320: 6f 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65  open_v2() */.#de
6330: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
6340: 5f 46 55 4c 4c 4d 55 54 45 58 20 20 20 20 20 20  _FULLMUTEX      
6350: 20 20 30 78 30 30 30 31 30 30 30 30 20 20 2f 2a    0x00010000  /*
6360: 20 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f   Ok for sqlite3_
6370: 6f 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65  open_v2() */.#de
6380: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
6390: 5f 53 48 41 52 45 44 43 41 43 48 45 20 20 20 20  _SHAREDCACHE    
63a0: 20 20 30 78 30 30 30 32 30 30 30 30 20 20 2f 2a    0x00020000  /*
63b0: 20 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f   Ok for sqlite3_
63c0: 6f 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65  open_v2() */.#de
63d0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
63e0: 5f 50 52 49 56 41 54 45 43 41 43 48 45 20 20 20  _PRIVATECACHE   
63f0: 20 20 30 78 30 30 30 34 30 30 30 30 20 20 2f 2a    0x00040000  /*
6400: 20 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f   Ok for sqlite3_
6410: 6f 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65  open_v2() */.#de
6420: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e  fine SQLITE_OPEN
6430: 5f 57 41 4c 20 20 20 20 20 20 20 20 20 20 20 20  _WAL            
6440: 20 20 30 78 30 30 30 38 30 30 30 30 20 20 2f 2a    0x00080000  /*
6450: 20 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 0a 2f 2a   VFS only */../*
6460: 20 52 65 73 65 72 76 65 64 3a 20 20 20 20 20 20   Reserved:      
6470: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
6480: 20 20 20 30 78 30 30 46 30 30 30 30 30 20 2a 2f     0x00F00000 */
6490: 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
64a0: 3a 20 44 65 76 69 63 65 20 43 68 61 72 61 63 74  : Device Charact
64b0: 65 72 69 73 74 69 63 73 0a 2a 2a 0a 2a 2a 20 54  eristics.**.** T
64c0: 68 65 20 78 44 65 76 69 63 65 43 68 61 72 61 63  he xDeviceCharac
64d0: 74 65 72 69 73 74 69 63 73 20 6d 65 74 68 6f 64  teristics method
64e0: 20 6f 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33   of the [sqlite3
64f0: 5f 69 6f 5f 6d 65 74 68 6f 64 73 5d 0a 2a 2a 20  _io_methods].** 
6500: 6f 62 6a 65 63 74 20 72 65 74 75 72 6e 73 20 61  object returns a
6510: 6e 20 69 6e 74 65 67 65 72 20 77 68 69 63 68 20  n integer which 
6520: 69 73 20 61 20 76 65 63 74 6f 72 20 6f 66 20 74  is a vector of t
6530: 68 65 73 65 0a 2a 2a 20 62 69 74 20 76 61 6c 75  hese.** bit valu
6540: 65 73 20 65 78 70 72 65 73 73 69 6e 67 20 49 2f  es expressing I/
6550: 4f 20 63 68 61 72 61 63 74 65 72 69 73 74 69 63  O characteristic
6560: 73 20 6f 66 20 74 68 65 20 6d 61 73 73 20 73 74  s of the mass st
6570: 6f 72 61 67 65 0a 2a 2a 20 64 65 76 69 63 65 20  orage.** device 
6580: 74 68 61 74 20 68 6f 6c 64 73 20 74 68 65 20 66  that holds the f
6590: 69 6c 65 20 74 68 61 74 20 74 68 65 20 5b 73 71  ile that the [sq
65a0: 6c 69 74 65 33 5f 69 6f 5f 6d 65 74 68 6f 64 73  lite3_io_methods
65b0: 5d 0a 2a 2a 20 72 65 66 65 72 73 20 74 6f 2e 0a  ].** refers to..
65c0: 2a 2a 0a 2a 2a 20 54 68 65 20 53 51 4c 49 54 45  **.** The SQLITE
65d0: 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 20 70 72  _IOCAP_ATOMIC pr
65e0: 6f 70 65 72 74 79 20 6d 65 61 6e 73 20 74 68 61  operty means tha
65f0: 74 20 61 6c 6c 20 77 72 69 74 65 73 20 6f 66 0a  t all writes of.
6600: 2a 2a 20 61 6e 79 20 73 69 7a 65 20 61 72 65 20  ** any size are 
6610: 61 74 6f 6d 69 63 2e 20 20 54 68 65 20 53 51 4c  atomic.  The SQL
6620: 49 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43  ITE_IOCAP_ATOMIC
6630: 6e 6e 6e 20 76 61 6c 75 65 73 0a 2a 2a 20 6d 65  nnn values.** me
6640: 61 6e 20 74 68 61 74 20 77 72 69 74 65 73 20 6f  an that writes o
6650: 66 20 62 6c 6f 63 6b 73 20 74 68 61 74 20 61 72  f blocks that ar
6660: 65 20 6e 6e 6e 20 62 79 74 65 73 20 69 6e 20 73  e nnn bytes in s
6670: 69 7a 65 20 61 6e 64 0a 2a 2a 20 61 72 65 20 61  ize and.** are a
6680: 6c 69 67 6e 65 64 20 74 6f 20 61 6e 20 61 64 64  ligned to an add
6690: 72 65 73 73 20 77 68 69 63 68 20 69 73 20 61 6e  ress which is an
66a0: 20 69 6e 74 65 67 65 72 20 6d 75 6c 74 69 70 6c   integer multipl
66b0: 65 20 6f 66 0a 2a 2a 20 6e 6e 6e 20 61 72 65 20  e of.** nnn are 
66c0: 61 74 6f 6d 69 63 2e 20 20 54 68 65 20 53 51 4c  atomic.  The SQL
66d0: 49 54 45 5f 49 4f 43 41 50 5f 53 41 46 45 5f 41  ITE_IOCAP_SAFE_A
66e0: 50 50 45 4e 44 20 76 61 6c 75 65 20 6d 65 61 6e  PPEND value mean
66f0: 73 0a 2a 2a 20 74 68 61 74 20 77 68 65 6e 20 64  s.** that when d
6700: 61 74 61 20 69 73 20 61 70 70 65 6e 64 65 64 20  ata is appended 
6710: 74 6f 20 61 20 66 69 6c 65 2c 20 74 68 65 20 64  to a file, the d
6720: 61 74 61 20 69 73 20 61 70 70 65 6e 64 65 64 0a  ata is appended.
6730: 2a 2a 20 66 69 72 73 74 20 74 68 65 6e 20 74 68  ** first then th
6740: 65 20 73 69 7a 65 20 6f 66 20 74 68 65 20 66 69  e size of the fi
6750: 6c 65 20 69 73 20 65 78 74 65 6e 64 65 64 2c 20  le is extended, 
6760: 6e 65 76 65 72 20 74 68 65 20 6f 74 68 65 72 0a  never the other.
6770: 2a 2a 20 77 61 79 20 61 72 6f 75 6e 64 2e 20 20  ** way around.  
6780: 54 68 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50  The SQLITE_IOCAP
6790: 5f 53 45 51 55 45 4e 54 49 41 4c 20 70 72 6f 70  _SEQUENTIAL prop
67a0: 65 72 74 79 20 6d 65 61 6e 73 20 74 68 61 74 0a  erty means that.
67b0: 2a 2a 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 69  ** information i
67c0: 73 20 77 72 69 74 74 65 6e 20 74 6f 20 64 69 73  s written to dis
67d0: 6b 20 69 6e 20 74 68 65 20 73 61 6d 65 20 6f 72  k in the same or
67e0: 64 65 72 20 61 73 20 63 61 6c 6c 73 0a 2a 2a 20  der as calls.** 
67f0: 74 6f 20 78 57 72 69 74 65 28 29 2e 20 20 54 68  to xWrite().  Th
6800: 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 50  e SQLITE_IOCAP_P
6810: 4f 57 45 52 53 41 46 45 5f 4f 56 45 52 57 52 49  OWERSAFE_OVERWRI
6820: 54 45 20 70 72 6f 70 65 72 74 79 20 6d 65 61 6e  TE property mean
6830: 73 20 74 68 61 74 0a 2a 2a 20 61 66 74 65 72 20  s that.** after 
6840: 72 65 62 6f 6f 74 20 66 6f 6c 6c 6f 77 69 6e 67  reboot following
6850: 20 61 20 63 72 61 73 68 20 6f 72 20 70 6f 77 65   a crash or powe
6860: 72 20 6c 6f 73 73 2c 20 74 68 65 20 6f 6e 6c 79  r loss, the only
6870: 20 62 79 74 65 73 20 69 6e 20 61 0a 2a 2a 20 66   bytes in a.** f
6880: 69 6c 65 20 74 68 61 74 20 77 65 72 65 20 77 72  ile that were wr
6890: 69 74 74 65 6e 20 61 74 20 74 68 65 20 61 70 70  itten at the app
68a0: 6c 69 63 61 74 69 6f 6e 20 6c 65 76 65 6c 20 6d  lication level m
68b0: 69 67 68 74 20 68 61 76 65 20 63 68 61 6e 67 65  ight have change
68c0: 64 0a 2a 2a 20 61 6e 64 20 74 68 61 74 20 61 64  d.** and that ad
68d0: 6a 61 63 65 6e 74 20 62 79 74 65 73 2c 20 65 76  jacent bytes, ev
68e0: 65 6e 20 62 79 74 65 73 20 77 69 74 68 69 6e 20  en bytes within 
68f0: 74 68 65 20 73 61 6d 65 20 73 65 63 74 6f 72 20  the same sector 
6900: 61 72 65 0a 2a 2a 20 67 75 61 72 61 6e 74 65 65  are.** guarantee
6910: 64 20 74 6f 20 62 65 20 75 6e 63 68 61 6e 67 65  d to be unchange
6920: 64 2e 20 20 54 68 65 20 53 51 4c 49 54 45 5f 49  d.  The SQLITE_I
6930: 4f 43 41 50 5f 55 4e 44 45 4c 45 54 41 42 4c 45  OCAP_UNDELETABLE
6940: 5f 57 48 45 4e 5f 4f 50 45 4e 0a 2a 2a 20 66 6c  _WHEN_OPEN.** fl
6950: 61 67 20 69 6e 64 69 63 61 74 65 20 74 68 61 74  ag indicate that
6960: 20 61 20 66 69 6c 65 20 63 61 6e 6e 6f 74 20 62   a file cannot b
6970: 65 20 64 65 6c 65 74 65 64 20 77 68 65 6e 20 6f  e deleted when o
6980: 70 65 6e 2e 20 20 54 68 65 0a 2a 2a 20 53 51 4c  pen.  The.** SQL
6990: 49 54 45 5f 49 4f 43 41 50 5f 49 4d 4d 55 54 41  ITE_IOCAP_IMMUTA
69a0: 42 4c 45 20 66 6c 61 67 20 69 6e 64 69 63 61 74  BLE flag indicat
69b0: 65 73 20 74 68 61 74 20 74 68 65 20 66 69 6c 65  es that the file
69c0: 20 69 73 20 6f 6e 0a 2a 2a 20 72 65 61 64 2d 6f   is on.** read-o
69d0: 6e 6c 79 20 6d 65 64 69 61 20 61 6e 64 20 63 61  nly media and ca
69e0: 6e 6e 6f 74 20 62 65 20 63 68 61 6e 67 65 64 20  nnot be changed 
69f0: 65 76 65 6e 20 62 79 20 70 72 6f 63 65 73 73 65  even by processe
6a00: 73 20 77 69 74 68 0a 2a 2a 20 65 6c 65 76 61 74  s with.** elevat
6a10: 65 64 20 70 72 69 76 69 6c 65 67 65 73 2e 0a 2a  ed privileges..*
6a20: 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
6a30: 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 20 20 20  _IOCAP_ATOMIC   
6a40: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 78                0x
6a50: 30 30 30 30 30 30 30 31 0a 23 64 65 66 69 6e 65  00000001.#define
6a60: 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 41 54   SQLITE_IOCAP_AT
6a70: 4f 4d 49 43 35 31 32 20 20 20 20 20 20 20 20 20  OMIC512         
6a80: 20 20 20 20 20 30 78 30 30 30 30 30 30 30 32 0a       0x00000002.
6a90: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49  #define SQLITE_I
6aa0: 4f 43 41 50 5f 41 54 4f 4d 49 43 31 4b 20 20 20  OCAP_ATOMIC1K   
6ab0: 20 20 20 20 20 20 20 20 20 20 20 20 30 78 30 30              0x00
6ac0: 30 30 30 30 30 34 0a 23 64 65 66 69 6e 65 20 53  000004.#define S
6ad0: 51 4c 49 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d  QLITE_IOCAP_ATOM
6ae0: 49 43 32 4b 20 20 20 20 20 20 20 20 20 20 20 20  IC2K            
6af0: 20 20 20 30 78 30 30 30 30 30 30 30 38 0a 23 64     0x00000008.#d
6b00: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 43  efine SQLITE_IOC
6b10: 41 50 5f 41 54 4f 4d 49 43 34 4b 20 20 20 20 20  AP_ATOMIC4K     
6b20: 20 20 20 20 20 20 20 20 20 20 30 78 30 30 30 30            0x0000
6b30: 30 30 31 30 0a 23 64 65 66 69 6e 65 20 53 51 4c  0010.#define SQL
6b40: 49 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43  ITE_IOCAP_ATOMIC
6b50: 38 4b 20 20 20 20 20 20 20 20 20 20 20 20 20 20  8K              
6b60: 20 30 78 30 30 30 30 30 30 32 30 0a 23 64 65 66   0x00000020.#def
6b70: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50  ine SQLITE_IOCAP
6b80: 5f 41 54 4f 4d 49 43 31 36 4b 20 20 20 20 20 20  _ATOMIC16K      
6b90: 20 20 20 20 20 20 20 20 30 78 30 30 30 30 30 30          0x000000
6ba0: 34 30 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  40.#define SQLIT
6bb0: 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 33 32  E_IOCAP_ATOMIC32
6bc0: 4b 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30  K              0
6bd0: 78 30 30 30 30 30 30 38 30 0a 23 64 65 66 69 6e  x00000080.#defin
6be0: 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 41  e SQLITE_IOCAP_A
6bf0: 54 4f 4d 49 43 36 34 4b 20 20 20 20 20 20 20 20  TOMIC64K        
6c00: 20 20 20 20 20 20 30 78 30 30 30 30 30 31 30 30        0x00000100
6c10: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
6c20: 49 4f 43 41 50 5f 53 41 46 45 5f 41 50 50 45 4e  IOCAP_SAFE_APPEN
6c30: 44 20 20 20 20 20 20 20 20 20 20 20 20 30 78 30  D            0x0
6c40: 30 30 30 30 32 30 30 0a 23 64 65 66 69 6e 65 20  0000200.#define 
6c50: 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 53 45 51  SQLITE_IOCAP_SEQ
6c60: 55 45 4e 54 49 41 4c 20 20 20 20 20 20 20 20 20  UENTIAL         
6c70: 20 20 20 20 30 78 30 30 30 30 30 34 30 30 0a 23      0x00000400.#
6c80: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f  define SQLITE_IO
6c90: 43 41 50 5f 55 4e 44 45 4c 45 54 41 42 4c 45 5f  CAP_UNDELETABLE_
6ca0: 57 48 45 4e 5f 4f 50 45 4e 20 20 30 78 30 30 30  WHEN_OPEN  0x000
6cb0: 30 30 38 30 30 0a 23 64 65 66 69 6e 65 20 53 51  00800.#define SQ
6cc0: 4c 49 54 45 5f 49 4f 43 41 50 5f 50 4f 57 45 52  LITE_IOCAP_POWER
6cd0: 53 41 46 45 5f 4f 56 45 52 57 52 49 54 45 20 20  SAFE_OVERWRITE  
6ce0: 20 20 30 78 30 30 30 30 31 30 30 30 0a 23 64 65    0x00001000.#de
6cf0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 43 41  fine SQLITE_IOCA
6d00: 50 5f 49 4d 4d 55 54 41 42 4c 45 20 20 20 20 20  P_IMMUTABLE     
6d10: 20 20 20 20 20 20 20 20 20 30 78 30 30 30 30 32           0x00002
6d20: 30 30 30 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  000../*.** CAPI3
6d30: 52 45 46 3a 20 46 69 6c 65 20 4c 6f 63 6b 69 6e  REF: File Lockin
6d40: 67 20 4c 65 76 65 6c 73 0a 2a 2a 0a 2a 2a 20 53  g Levels.**.** S
6d50: 51 4c 69 74 65 20 75 73 65 73 20 6f 6e 65 20 6f  QLite uses one o
6d60: 66 20 74 68 65 73 65 20 69 6e 74 65 67 65 72 20  f these integer 
6d70: 76 61 6c 75 65 73 20 61 73 20 74 68 65 20 73 65  values as the se
6d80: 63 6f 6e 64 0a 2a 2a 20 61 72 67 75 6d 65 6e 74  cond.** argument
6d90: 20 74 6f 20 63 61 6c 6c 73 20 69 74 20 6d 61 6b   to calls it mak
6da0: 65 73 20 74 6f 20 74 68 65 20 78 4c 6f 63 6b 28  es to the xLock(
6db0: 29 20 61 6e 64 20 78 55 6e 6c 6f 63 6b 28 29 20  ) and xUnlock() 
6dc0: 6d 65 74 68 6f 64 73 0a 2a 2a 20 6f 66 20 61 6e  methods.** of an
6dd0: 20 5b 73 71 6c 69 74 65 33 5f 69 6f 5f 6d 65 74   [sqlite3_io_met
6de0: 68 6f 64 73 5d 20 6f 62 6a 65 63 74 2e 0a 2a 2f  hods] object..*/
6df0: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
6e00: 4c 4f 43 4b 5f 4e 4f 4e 45 20 20 20 20 20 20 20  LOCK_NONE       
6e10: 20 20 20 30 0a 23 64 65 66 69 6e 65 20 53 51 4c     0.#define SQL
6e20: 49 54 45 5f 4c 4f 43 4b 5f 53 48 41 52 45 44 20  ITE_LOCK_SHARED 
6e30: 20 20 20 20 20 20 20 31 0a 23 64 65 66 69 6e 65         1.#define
6e40: 20 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 52 45 53   SQLITE_LOCK_RES
6e50: 45 52 56 45 44 20 20 20 20 20 20 32 0a 23 64 65  ERVED      2.#de
6e60: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c 4f 43 4b  fine SQLITE_LOCK
6e70: 5f 50 45 4e 44 49 4e 47 20 20 20 20 20 20 20 33  _PENDING       3
6e80: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
6e90: 4c 4f 43 4b 5f 45 58 43 4c 55 53 49 56 45 20 20  LOCK_EXCLUSIVE  
6ea0: 20 20 20 34 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49     4../*.** CAPI
6eb0: 33 52 45 46 3a 20 53 79 6e 63 68 72 6f 6e 69 7a  3REF: Synchroniz
6ec0: 61 74 69 6f 6e 20 54 79 70 65 20 46 6c 61 67 73  ation Type Flags
6ed0: 0a 2a 2a 0a 2a 2a 20 57 68 65 6e 20 53 51 4c 69  .**.** When SQLi
6ee0: 74 65 20 69 6e 76 6f 6b 65 73 20 74 68 65 20 78  te invokes the x
6ef0: 53 79 6e 63 28 29 20 6d 65 74 68 6f 64 20 6f 66  Sync() method of
6f00: 20 61 6e 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f   an.** [sqlite3_
6f10: 69 6f 5f 6d 65 74 68 6f 64 73 5d 20 6f 62 6a 65  io_methods] obje
6f20: 63 74 20 69 74 20 75 73 65 73 20 61 20 63 6f 6d  ct it uses a com
6f30: 62 69 6e 61 74 69 6f 6e 20 6f 66 0a 2a 2a 20 74  bination of.** t
6f40: 68 65 73 65 20 69 6e 74 65 67 65 72 20 76 61 6c  hese integer val
6f50: 75 65 73 20 61 73 20 74 68 65 20 73 65 63 6f 6e  ues as the secon
6f60: 64 20 61 72 67 75 6d 65 6e 74 2e 0a 2a 2a 0a 2a  d argument..**.*
6f70: 2a 20 57 68 65 6e 20 74 68 65 20 53 51 4c 49 54  * When the SQLIT
6f80: 45 5f 53 59 4e 43 5f 44 41 54 41 4f 4e 4c 59 20  E_SYNC_DATAONLY 
6f90: 66 6c 61 67 20 69 73 20 75 73 65 64 2c 20 69 74  flag is used, it
6fa0: 20 6d 65 61 6e 73 20 74 68 61 74 20 74 68 65 0a   means that the.
6fb0: 2a 2a 20 73 79 6e 63 20 6f 70 65 72 61 74 69 6f  ** sync operatio
6fc0: 6e 20 6f 6e 6c 79 20 6e 65 65 64 73 20 74 6f 20  n only needs to 
6fd0: 66 6c 75 73 68 20 64 61 74 61 20 74 6f 20 6d 61  flush data to ma
6fe0: 73 73 20 73 74 6f 72 61 67 65 2e 20 20 49 6e 6f  ss storage.  Ino
6ff0: 64 65 0a 2a 2a 20 69 6e 66 6f 72 6d 61 74 69 6f  de.** informatio
7000: 6e 20 6e 65 65 64 20 6e 6f 74 20 62 65 20 66 6c  n need not be fl
7010: 75 73 68 65 64 2e 20 49 66 20 74 68 65 20 6c 6f  ushed. If the lo
7020: 77 65 72 20 66 6f 75 72 20 62 69 74 73 20 6f 66  wer four bits of
7030: 20 74 68 65 20 66 6c 61 67 0a 2a 2a 20 65 71 75   the flag.** equ
7040: 61 6c 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 4e  al SQLITE_SYNC_N
7050: 4f 52 4d 41 4c 2c 20 74 68 61 74 20 6d 65 61 6e  ORMAL, that mean
7060: 73 20 74 6f 20 75 73 65 20 6e 6f 72 6d 61 6c 20  s to use normal 
7070: 66 73 79 6e 63 28 29 20 73 65 6d 61 6e 74 69 63  fsync() semantic
7080: 73 2e 0a 2a 2a 20 49 66 20 74 68 65 20 6c 6f 77  s..** If the low
7090: 65 72 20 66 6f 75 72 20 62 69 74 73 20 65 71 75  er four bits equ
70a0: 61 6c 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 46  al SQLITE_SYNC_F
70b0: 55 4c 4c 2c 20 74 68 61 74 20 6d 65 61 6e 73 0a  ULL, that means.
70c0: 2a 2a 20 74 6f 20 75 73 65 20 4d 61 63 20 4f 53  ** to use Mac OS
70d0: 20 58 20 73 74 79 6c 65 20 66 75 6c 6c 73 79 6e   X style fullsyn
70e0: 63 20 69 6e 73 74 65 61 64 20 6f 66 20 66 73 79  c instead of fsy
70f0: 6e 63 28 29 2e 0a 2a 2a 0a 2a 2a 20 44 6f 20 6e  nc()..**.** Do n
7100: 6f 74 20 63 6f 6e 66 75 73 65 20 74 68 65 20 53  ot confuse the S
7110: 51 4c 49 54 45 5f 53 59 4e 43 5f 4e 4f 52 4d 41  QLITE_SYNC_NORMA
7120: 4c 20 61 6e 64 20 53 51 4c 49 54 45 5f 53 59 4e  L and SQLITE_SYN
7130: 43 5f 46 55 4c 4c 20 66 6c 61 67 73 0a 2a 2a 20  C_FULL flags.** 
7140: 77 69 74 68 20 74 68 65 20 5b 50 52 41 47 4d 41  with the [PRAGMA
7150: 20 73 79 6e 63 68 72 6f 6e 6f 75 73 5d 3d 4e 4f   synchronous]=NO
7160: 52 4d 41 4c 20 61 6e 64 20 5b 50 52 41 47 4d 41  RMAL and [PRAGMA
7170: 20 73 79 6e 63 68 72 6f 6e 6f 75 73 5d 3d 46 55   synchronous]=FU
7180: 4c 4c 0a 2a 2a 20 73 65 74 74 69 6e 67 73 2e 20  LL.** settings. 
7190: 20 54 68 65 20 5b 73 79 6e 63 68 72 6f 6e 6f 75   The [synchronou
71a0: 73 20 70 72 61 67 6d 61 5d 20 64 65 74 65 72 6d  s pragma] determ
71b0: 69 6e 65 73 20 77 68 65 6e 20 63 61 6c 6c 73 20  ines when calls 
71c0: 74 6f 20 74 68 65 0a 2a 2a 20 78 53 79 6e 63 20  to the.** xSync 
71d0: 56 46 53 20 6d 65 74 68 6f 64 20 6f 63 63 75 72  VFS method occur
71e0: 20 61 6e 64 20 61 70 70 6c 69 65 73 20 75 6e 69   and applies uni
71f0: 66 6f 72 6d 6c 79 20 61 63 72 6f 73 73 20 61 6c  formly across al
7200: 6c 20 70 6c 61 74 66 6f 72 6d 73 2e 0a 2a 2a 20  l platforms..** 
7210: 54 68 65 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f  The SQLITE_SYNC_
7220: 4e 4f 52 4d 41 4c 20 61 6e 64 20 53 51 4c 49 54  NORMAL and SQLIT
7230: 45 5f 53 59 4e 43 5f 46 55 4c 4c 20 66 6c 61 67  E_SYNC_FULL flag
7240: 73 20 64 65 74 65 72 6d 69 6e 65 20 68 6f 77 0a  s determine how.
7250: 2a 2a 20 65 6e 65 72 67 65 74 69 63 20 6f 72 20  ** energetic or 
7260: 72 69 67 6f 72 6f 75 73 20 6f 72 20 66 6f 72 63  rigorous or forc
7270: 65 66 75 6c 20 74 68 65 20 73 79 6e 63 20 6f 70  eful the sync op
7280: 65 72 61 74 69 6f 6e 73 20 61 72 65 20 61 6e 64  erations are and
7290: 0a 2a 2a 20 6f 6e 6c 79 20 6d 61 6b 65 20 61 20  .** only make a 
72a0: 64 69 66 66 65 72 65 6e 63 65 20 6f 6e 20 4d 61  difference on Ma
72b0: 63 20 4f 53 58 20 66 6f 72 20 74 68 65 20 64 65  c OSX for the de
72c0: 66 61 75 6c 74 20 53 51 4c 69 74 65 20 63 6f 64  fault SQLite cod
72d0: 65 2e 0a 2a 2a 20 28 54 68 69 72 64 2d 70 61 72  e..** (Third-par
72e0: 74 79 20 56 46 53 20 69 6d 70 6c 65 6d 65 6e 74  ty VFS implement
72f0: 61 74 69 6f 6e 73 20 6d 69 67 68 74 20 61 6c 73  ations might als
7300: 6f 20 6d 61 6b 65 20 74 68 65 20 64 69 73 74 69  o make the disti
7310: 6e 63 74 69 6f 6e 0a 2a 2a 20 62 65 74 77 65 65  nction.** betwee
7320: 6e 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 4e 4f  n SQLITE_SYNC_NO
7330: 52 4d 41 4c 20 61 6e 64 20 53 51 4c 49 54 45 5f  RMAL and SQLITE_
7340: 53 59 4e 43 5f 46 55 4c 4c 2c 20 62 75 74 20 61  SYNC_FULL, but a
7350: 6d 6f 6e 67 20 74 68 65 0a 2a 2a 20 6f 70 65 72  mong the.** oper
7360: 61 74 69 6e 67 20 73 79 73 74 65 6d 73 20 6e 61  ating systems na
7370: 74 69 76 65 6c 79 20 73 75 70 70 6f 72 74 65 64  tively supported
7380: 20 62 79 20 53 51 4c 69 74 65 2c 20 6f 6e 6c 79   by SQLite, only
7390: 20 4d 61 63 20 4f 53 58 0a 2a 2a 20 63 61 72 65   Mac OSX.** care
73a0: 73 20 61 62 6f 75 74 20 74 68 65 20 64 69 66 66  s about the diff
73b0: 65 72 65 6e 63 65 2e 29 0a 2a 2f 0a 23 64 65 66  erence.).*/.#def
73c0: 69 6e 65 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f  ine SQLITE_SYNC_
73d0: 4e 4f 52 4d 41 4c 20 20 20 20 20 20 20 20 30 78  NORMAL        0x
73e0: 30 30 30 30 32 0a 23 64 65 66 69 6e 65 20 53 51  00002.#define SQ
73f0: 4c 49 54 45 5f 53 59 4e 43 5f 46 55 4c 4c 20 20  LITE_SYNC_FULL  
7400: 20 20 20 20 20 20 20 20 30 78 30 30 30 30 33 0a          0x00003.
7410: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53  #define SQLITE_S
7420: 59 4e 43 5f 44 41 54 41 4f 4e 4c 59 20 20 20 20  YNC_DATAONLY    
7430: 20 20 30 78 30 30 30 31 30 0a 0a 2f 2a 0a 2a 2a    0x00010../*.**
7440: 20 43 41 50 49 33 52 45 46 3a 20 4f 53 20 49 6e   CAPI3REF: OS In
7450: 74 65 72 66 61 63 65 20 4f 70 65 6e 20 46 69 6c  terface Open Fil
7460: 65 20 48 61 6e 64 6c 65 0a 2a 2a 0a 2a 2a 20 41  e Handle.**.** A
7470: 6e 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d  n [sqlite3_file]
7480: 20 6f 62 6a 65 63 74 20 72 65 70 72 65 73 65 6e   object represen
7490: 74 73 20 61 6e 20 6f 70 65 6e 20 66 69 6c 65 20  ts an open file 
74a0: 69 6e 20 74 68 65 20 0a 2a 2a 20 5b 73 71 6c 69  in the .** [sqli
74b0: 74 65 33 5f 76 66 73 20 7c 20 4f 53 20 69 6e 74  te3_vfs | OS int
74c0: 65 72 66 61 63 65 20 6c 61 79 65 72 5d 2e 20 20  erface layer].  
74d0: 49 6e 64 69 76 69 64 75 61 6c 20 4f 53 20 69 6e  Individual OS in
74e0: 74 65 72 66 61 63 65 0a 2a 2a 20 69 6d 70 6c 65  terface.** imple
74f0: 6d 65 6e 74 61 74 69 6f 6e 73 20 77 69 6c 6c 0a  mentations will.
7500: 2a 2a 20 77 61 6e 74 20 74 6f 20 73 75 62 63 6c  ** want to subcl
7510: 61 73 73 20 74 68 69 73 20 6f 62 6a 65 63 74 20  ass this object 
7520: 62 79 20 61 70 70 65 6e 64 69 6e 67 20 61 64 64  by appending add
7530: 69 74 69 6f 6e 61 6c 20 66 69 65 6c 64 73 0a 2a  itional fields.*
7540: 2a 20 66 6f 72 20 74 68 65 69 72 20 6f 77 6e 20  * for their own 
7550: 75 73 65 2e 20 20 54 68 65 20 70 4d 65 74 68 6f  use.  The pMetho
7560: 64 73 20 65 6e 74 72 79 20 69 73 20 61 20 70 6f  ds entry is a po
7570: 69 6e 74 65 72 20 74 6f 20 61 6e 0a 2a 2a 20 5b  inter to an.** [
7580: 73 71 6c 69 74 65 33 5f 69 6f 5f 6d 65 74 68 6f  sqlite3_io_metho
7590: 64 73 5d 20 6f 62 6a 65 63 74 20 74 68 61 74 20  ds] object that 
75a0: 64 65 66 69 6e 65 73 20 6d 65 74 68 6f 64 73 20  defines methods 
75b0: 66 6f 72 20 70 65 72 66 6f 72 6d 69 6e 67 0a 2a  for performing.*
75c0: 2a 20 49 2f 4f 20 6f 70 65 72 61 74 69 6f 6e 73  * I/O operations
75d0: 20 6f 6e 20 74 68 65 20 6f 70 65 6e 20 66 69 6c   on the open fil
75e0: 65 2e 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73 74  e..*/.typedef st
75f0: 72 75 63 74 20 73 71 6c 69 74 65 33 5f 66 69 6c  ruct sqlite3_fil
7600: 65 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 3b 0a  e sqlite3_file;.
7610: 73 74 72 75 63 74 20 73 71 6c 69 74 65 33 5f 66  struct sqlite3_f
7620: 69 6c 65 20 7b 0a 20 20 63 6f 6e 73 74 20 73 74  ile {.  const st
7630: 72 75 63 74 20 73 71 6c 69 74 65 33 5f 69 6f 5f  ruct sqlite3_io_
7640: 6d 65 74 68 6f 64 73 20 2a 70 4d 65 74 68 6f 64  methods *pMethod
7650: 73 3b 20 20 2f 2a 20 4d 65 74 68 6f 64 73 20 66  s;  /* Methods f
7660: 6f 72 20 61 6e 20 6f 70 65 6e 20 66 69 6c 65 20  or an open file 
7670: 2a 2f 0a 7d 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  */.};../*.** CAP
7680: 49 33 52 45 46 3a 20 4f 53 20 49 6e 74 65 72 66  I3REF: OS Interf
7690: 61 63 65 20 46 69 6c 65 20 56 69 72 74 75 61 6c  ace File Virtual
76a0: 20 4d 65 74 68 6f 64 73 20 4f 62 6a 65 63 74 0a   Methods Object.
76b0: 2a 2a 0a 2a 2a 20 45 76 65 72 79 20 66 69 6c 65  **.** Every file
76c0: 20 6f 70 65 6e 65 64 20 62 79 20 74 68 65 20 5b   opened by the [
76d0: 73 71 6c 69 74 65 33 5f 76 66 73 2e 78 4f 70 65  sqlite3_vfs.xOpe
76e0: 6e 5d 20 6d 65 74 68 6f 64 20 70 6f 70 75 6c 61  n] method popula
76f0: 74 65 73 20 61 6e 0a 2a 2a 20 5b 73 71 6c 69 74  tes an.** [sqlit
7700: 65 33 5f 66 69 6c 65 5d 20 6f 62 6a 65 63 74 20  e3_file] object 
7710: 28 6f 72 2c 20 6d 6f 72 65 20 63 6f 6d 6d 6f 6e  (or, more common
7720: 6c 79 2c 20 61 20 73 75 62 63 6c 61 73 73 20 6f  ly, a subclass o
7730: 66 20 74 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65  f the.** [sqlite
7740: 33 5f 66 69 6c 65 5d 20 6f 62 6a 65 63 74 29 20  3_file] object) 
7750: 77 69 74 68 20 61 20 70 6f 69 6e 74 65 72 20 74  with a pointer t
7760: 6f 20 61 6e 20 69 6e 73 74 61 6e 63 65 20 6f 66  o an instance of
7770: 20 74 68 69 73 20 6f 62 6a 65 63 74 2e 0a 2a 2a   this object..**
7780: 20 54 68 69 73 20 6f 62 6a 65 63 74 20 64 65 66   This object def
7790: 69 6e 65 73 20 74 68 65 20 6d 65 74 68 6f 64 73  ines the methods
77a0: 20 75 73 65 64 20 74 6f 20 70 65 72 66 6f 72 6d   used to perform
77b0: 20 76 61 72 69 6f 75 73 20 6f 70 65 72 61 74 69   various operati
77c0: 6f 6e 73 0a 2a 2a 20 61 67 61 69 6e 73 74 20 74  ons.** against t
77d0: 68 65 20 6f 70 65 6e 20 66 69 6c 65 20 72 65 70  he open file rep
77e0: 72 65 73 65 6e 74 65 64 20 62 79 20 74 68 65 20  resented by the 
77f0: 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d 20 6f  [sqlite3_file] o
7800: 62 6a 65 63 74 2e 0a 2a 2a 0a 2a 2a 20 49 66 20  bject..**.** If 
7810: 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 66 73  the [sqlite3_vfs
7820: 2e 78 4f 70 65 6e 5d 20 6d 65 74 68 6f 64 20 73  .xOpen] method s
7830: 65 74 73 20 74 68 65 20 73 71 6c 69 74 65 33 5f  ets the sqlite3_
7840: 66 69 6c 65 2e 70 4d 65 74 68 6f 64 73 20 65 6c  file.pMethods el
7850: 65 6d 65 6e 74 20 0a 2a 2a 20 74 6f 20 61 20 6e  ement .** to a n
7860: 6f 6e 2d 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2c  on-NULL pointer,
7870: 20 74 68 65 6e 20 74 68 65 20 73 71 6c 69 74 65   then the sqlite
7880: 33 5f 69 6f 5f 6d 65 74 68 6f 64 73 2e 78 43 6c  3_io_methods.xCl
7890: 6f 73 65 20 6d 65 74 68 6f 64 0a 2a 2a 20 6d 61  ose method.** ma
78a0: 79 20 62 65 20 69 6e 76 6f 6b 65 64 20 65 76 65  y be invoked eve
78b0: 6e 20 69 66 20 74 68 65 20 5b 73 71 6c 69 74 65  n if the [sqlite
78c0: 33 5f 76 66 73 2e 78 4f 70 65 6e 5d 20 72 65 70  3_vfs.xOpen] rep
78d0: 6f 72 74 65 64 20 74 68 61 74 20 69 74 20 66 61  orted that it fa
78e0: 69 6c 65 64 2e 20 20 54 68 65 0a 2a 2a 20 6f 6e  iled.  The.** on
78f0: 6c 79 20 77 61 79 20 74 6f 20 70 72 65 76 65 6e  ly way to preven
7900: 74 20 61 20 63 61 6c 6c 20 74 6f 20 78 43 6c 6f  t a call to xClo
7910: 73 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 61 20 66  se following a f
7920: 61 69 6c 65 64 20 5b 73 71 6c 69 74 65 33 5f 76  ailed [sqlite3_v
7930: 66 73 2e 78 4f 70 65 6e 5d 0a 2a 2a 20 69 73 20  fs.xOpen].** is 
7940: 66 6f 72 20 74 68 65 20 5b 73 71 6c 69 74 65 33  for the [sqlite3
7950: 5f 76 66 73 2e 78 4f 70 65 6e 5d 20 74 6f 20 73  _vfs.xOpen] to s
7960: 65 74 20 74 68 65 20 73 71 6c 69 74 65 33 5f 66  et the sqlite3_f
7970: 69 6c 65 2e 70 4d 65 74 68 6f 64 73 20 65 6c 65  ile.pMethods ele
7980: 6d 65 6e 74 0a 2a 2a 20 74 6f 20 4e 55 4c 4c 2e  ment.** to NULL.
7990: 0a 2a 2a 0a 2a 2a 20 54 68 65 20 66 6c 61 67 73  .**.** The flags
79a0: 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 78 53 79   argument to xSy
79b0: 6e 63 20 6d 61 79 20 62 65 20 6f 6e 65 20 6f 66  nc may be one of
79c0: 20 5b 53 51 4c 49 54 45 5f 53 59 4e 43 5f 4e 4f   [SQLITE_SYNC_NO
79d0: 52 4d 41 4c 5d 20 6f 72 0a 2a 2a 20 5b 53 51 4c  RMAL] or.** [SQL
79e0: 49 54 45 5f 53 59 4e 43 5f 46 55 4c 4c 5d 2e 20  ITE_SYNC_FULL]. 
79f0: 20 54 68 65 20 66 69 72 73 74 20 63 68 6f 69 63   The first choic
7a00: 65 20 69 73 20 74 68 65 20 6e 6f 72 6d 61 6c 20  e is the normal 
7a10: 66 73 79 6e 63 28 29 2e 0a 2a 2a 20 54 68 65 20  fsync()..** The 
7a20: 73 65 63 6f 6e 64 20 63 68 6f 69 63 65 20 69 73  second choice is
7a30: 20 61 20 4d 61 63 20 4f 53 20 58 20 73 74 79 6c   a Mac OS X styl
7a40: 65 20 66 75 6c 6c 73 79 6e 63 2e 20 20 54 68 65  e fullsync.  The
7a50: 20 5b 53 51 4c 49 54 45 5f 53 59 4e 43 5f 44 41   [SQLITE_SYNC_DA
7a60: 54 41 4f 4e 4c 59 5d 0a 2a 2a 20 66 6c 61 67 20  TAONLY].** flag 
7a70: 6d 61 79 20 62 65 20 4f 52 65 64 20 69 6e 20 74  may be ORed in t
7a80: 6f 20 69 6e 64 69 63 61 74 65 20 74 68 61 74 20  o indicate that 
7a90: 6f 6e 6c 79 20 74 68 65 20 64 61 74 61 20 6f 66  only the data of
7aa0: 20 74 68 65 20 66 69 6c 65 0a 2a 2a 20 61 6e 64   the file.** and
7ab0: 20 6e 6f 74 20 69 74 73 20 69 6e 6f 64 65 20 6e   not its inode n
7ac0: 65 65 64 73 20 74 6f 20 62 65 20 73 79 6e 63 65  eeds to be synce
7ad0: 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 69 6e 74  d..**.** The int
7ae0: 65 67 65 72 20 76 61 6c 75 65 73 20 74 6f 20 78  eger values to x
7af0: 4c 6f 63 6b 28 29 20 61 6e 64 20 78 55 6e 6c 6f  Lock() and xUnlo
7b00: 63 6b 28 29 20 61 72 65 20 6f 6e 65 20 6f 66 0a  ck() are one of.
7b10: 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20  ** <ul>.** <li> 
7b20: 5b 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 4e 4f 4e  [SQLITE_LOCK_NON
7b30: 45 5d 2c 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c  E],.** <li> [SQL
7b40: 49 54 45 5f 4c 4f 43 4b 5f 53 48 41 52 45 44 5d  ITE_LOCK_SHARED]
7b50: 2c 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54  ,.** <li> [SQLIT
7b60: 45 5f 4c 4f 43 4b 5f 52 45 53 45 52 56 45 44 5d  E_LOCK_RESERVED]
7b70: 2c 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54  ,.** <li> [SQLIT
7b80: 45 5f 4c 4f 43 4b 5f 50 45 4e 44 49 4e 47 5d 2c  E_LOCK_PENDING],
7b90: 20 6f 72 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c   or.** <li> [SQL
7ba0: 49 54 45 5f 4c 4f 43 4b 5f 45 58 43 4c 55 53 49  ITE_LOCK_EXCLUSI
7bb0: 56 45 5d 2e 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a  VE]..** </ul>.**
7bc0: 20 78 4c 6f 63 6b 28 29 20 69 6e 63 72 65 61 73   xLock() increas
7bd0: 65 73 20 74 68 65 20 6c 6f 63 6b 2e 20 78 55 6e  es the lock. xUn
7be0: 6c 6f 63 6b 28 29 20 64 65 63 72 65 61 73 65 73  lock() decreases
7bf0: 20 74 68 65 20 6c 6f 63 6b 2e 0a 2a 2a 20 54 68   the lock..** Th
7c00: 65 20 78 43 68 65 63 6b 52 65 73 65 72 76 65 64  e xCheckReserved
7c10: 4c 6f 63 6b 28 29 20 6d 65 74 68 6f 64 20 63 68  Lock() method ch
7c20: 65 63 6b 73 20 77 68 65 74 68 65 72 20 61 6e 79  ecks whether any
7c30: 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63   database connec
7c40: 74 69 6f 6e 2c 0a 2a 2a 20 65 69 74 68 65 72 20  tion,.** either 
7c50: 69 6e 20 74 68 69 73 20 70 72 6f 63 65 73 73 20  in this process 
7c60: 6f 72 20 69 6e 20 73 6f 6d 65 20 6f 74 68 65 72  or in some other
7c70: 20 70 72 6f 63 65 73 73 2c 20 69 73 20 68 6f 6c   process, is hol
7c80: 64 69 6e 67 20 61 20 52 45 53 45 52 56 45 44 2c  ding a RESERVED,
7c90: 0a 2a 2a 20 50 45 4e 44 49 4e 47 2c 20 6f 72 20  .** PENDING, or 
7ca0: 45 58 43 4c 55 53 49 56 45 20 6c 6f 63 6b 20 6f  EXCLUSIVE lock o
7cb0: 6e 20 74 68 65 20 66 69 6c 65 2e 20 20 49 74 20  n the file.  It 
7cc0: 72 65 74 75 72 6e 73 20 74 72 75 65 0a 2a 2a 20  returns true.** 
7cd0: 69 66 20 73 75 63 68 20 61 20 6c 6f 63 6b 20 65  if such a lock e
7ce0: 78 69 73 74 73 20 61 6e 64 20 66 61 6c 73 65 20  xists and false 
7cf0: 6f 74 68 65 72 77 69 73 65 2e 0a 2a 2a 0a 2a 2a  otherwise..**.**
7d00: 20 54 68 65 20 78 46 69 6c 65 43 6f 6e 74 72 6f   The xFileContro
7d10: 6c 28 29 20 6d 65 74 68 6f 64 20 69 73 20 61 20  l() method is a 
7d20: 67 65 6e 65 72 69 63 20 69 6e 74 65 72 66 61 63  generic interfac
7d30: 65 20 74 68 61 74 20 61 6c 6c 6f 77 73 20 63 75  e that allows cu
7d40: 73 74 6f 6d 0a 2a 2a 20 56 46 53 20 69 6d 70 6c  stom.** VFS impl
7d50: 65 6d 65 6e 74 61 74 69 6f 6e 73 20 74 6f 20 64  ementations to d
7d60: 69 72 65 63 74 6c 79 20 63 6f 6e 74 72 6f 6c 20  irectly control 
7d70: 61 6e 20 6f 70 65 6e 20 66 69 6c 65 20 75 73 69  an open file usi
7d80: 6e 67 20 74 68 65 0a 2a 2a 20 5b 73 71 6c 69 74  ng the.** [sqlit
7d90: 65 33 5f 66 69 6c 65 5f 63 6f 6e 74 72 6f 6c 28  e3_file_control(
7da0: 29 5d 20 69 6e 74 65 72 66 61 63 65 2e 20 20 54  )] interface.  T
7db0: 68 65 20 73 65 63 6f 6e 64 20 22 6f 70 22 20 61  he second "op" a
7dc0: 72 67 75 6d 65 6e 74 20 69 73 20 61 6e 0a 2a 2a  rgument is an.**
7dd0: 20 69 6e 74 65 67 65 72 20 6f 70 63 6f 64 65 2e   integer opcode.
7de0: 20 20 54 68 65 20 74 68 69 72 64 20 61 72 67 75    The third argu
7df0: 6d 65 6e 74 20 69 73 20 61 20 67 65 6e 65 72 69  ment is a generi
7e00: 63 20 70 6f 69 6e 74 65 72 20 69 6e 74 65 6e 64  c pointer intend
7e10: 65 64 20 74 6f 0a 2a 2a 20 70 6f 69 6e 74 20 74  ed to.** point t
7e20: 6f 20 61 20 73 74 72 75 63 74 75 72 65 20 74 68  o a structure th
7e30: 61 74 20 6d 61 79 20 63 6f 6e 74 61 69 6e 20 61  at may contain a
7e40: 72 67 75 6d 65 6e 74 73 20 6f 72 20 73 70 61 63  rguments or spac
7e50: 65 20 69 6e 20 77 68 69 63 68 20 74 6f 0a 2a 2a  e in which to.**
7e60: 20 77 72 69 74 65 20 72 65 74 75 72 6e 20 76 61   write return va
7e70: 6c 75 65 73 2e 20 20 50 6f 74 65 6e 74 69 61 6c  lues.  Potential
7e80: 20 75 73 65 73 20 66 6f 72 20 78 46 69 6c 65 43   uses for xFileC
7e90: 6f 6e 74 72 6f 6c 28 29 20 6d 69 67 68 74 20 62  ontrol() might b
7ea0: 65 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 73 20 74  e.** functions t
7eb0: 6f 20 65 6e 61 62 6c 65 20 62 6c 6f 63 6b 69 6e  o enable blockin
7ec0: 67 20 6c 6f 63 6b 73 20 77 69 74 68 20 74 69 6d  g locks with tim
7ed0: 65 6f 75 74 73 2c 20 74 6f 20 63 68 61 6e 67 65  eouts, to change
7ee0: 20 74 68 65 0a 2a 2a 20 6c 6f 63 6b 69 6e 67 20   the.** locking 
7ef0: 73 74 72 61 74 65 67 79 20 28 66 6f 72 20 65 78  strategy (for ex
7f00: 61 6d 70 6c 65 20 74 6f 20 75 73 65 20 64 6f 74  ample to use dot
7f10: 2d 66 69 6c 65 20 6c 6f 63 6b 73 29 2c 20 74 6f  -file locks), to
7f20: 20 69 6e 71 75 69 72 65 0a 2a 2a 20 61 62 6f 75   inquire.** abou
7f30: 74 20 74 68 65 20 73 74 61 74 75 73 20 6f 66 20  t the status of 
7f40: 61 20 6c 6f 63 6b 2c 20 6f 72 20 74 6f 20 62 72  a lock, or to br
7f50: 65 61 6b 20 73 74 61 6c 65 20 6c 6f 63 6b 73 2e  eak stale locks.
7f60: 20 20 54 68 65 20 53 51 4c 69 74 65 0a 2a 2a 20    The SQLite.** 
7f70: 63 6f 72 65 20 72 65 73 65 72 76 65 73 20 61 6c  core reserves al
7f80: 6c 20 6f 70 63 6f 64 65 73 20 6c 65 73 73 20 74  l opcodes less t
7f90: 68 61 6e 20 31 30 30 20 66 6f 72 20 69 74 73 20  han 100 for its 
7fa0: 6f 77 6e 20 75 73 65 2e 0a 2a 2a 20 41 20 5b 66  own use..** A [f
7fb0: 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 6f 70 63 6f  ile control opco
7fc0: 64 65 73 20 7c 20 6c 69 73 74 20 6f 66 20 6f 70  des | list of op
7fd0: 63 6f 64 65 73 5d 20 6c 65 73 73 20 74 68 61 6e  codes] less than
7fe0: 20 31 30 30 20 69 73 20 61 76 61 69 6c 61 62 6c   100 is availabl
7ff0: 65 2e 0a 2a 2a 20 41 70 70 6c 69 63 61 74 69 6f  e..** Applicatio
8000: 6e 73 20 74 68 61 74 20 64 65 66 69 6e 65 20 61  ns that define a
8010: 20 63 75 73 74 6f 6d 20 78 46 69 6c 65 43 6f 6e   custom xFileCon
8020: 74 72 6f 6c 20 6d 65 74 68 6f 64 20 73 68 6f 75  trol method shou
8030: 6c 64 20 75 73 65 20 6f 70 63 6f 64 65 73 0a 2a  ld use opcodes.*
8040: 2a 20 67 72 65 61 74 65 72 20 74 68 61 6e 20 31  * greater than 1
8050: 30 30 20 74 6f 20 61 76 6f 69 64 20 63 6f 6e 66  00 to avoid conf
8060: 6c 69 63 74 73 2e 20 20 56 46 53 20 69 6d 70 6c  licts.  VFS impl
8070: 65 6d 65 6e 74 61 74 69 6f 6e 73 20 73 68 6f 75  ementations shou
8080: 6c 64 0a 2a 2a 20 72 65 74 75 72 6e 20 5b 53 51  ld.** return [SQ
8090: 4c 49 54 45 5f 4e 4f 54 46 4f 55 4e 44 5d 20 66  LITE_NOTFOUND] f
80a0: 6f 72 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20  or file control 
80b0: 6f 70 63 6f 64 65 73 20 74 68 61 74 20 74 68 65  opcodes that the
80c0: 79 20 64 6f 20 6e 6f 74 0a 2a 2a 20 72 65 63 6f  y do not.** reco
80d0: 67 6e 69 7a 65 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  gnize..**.** The
80e0: 20 78 53 65 63 74 6f 72 53 69 7a 65 28 29 20 6d   xSectorSize() m
80f0: 65 74 68 6f 64 20 72 65 74 75 72 6e 73 20 74 68  ethod returns th
8100: 65 20 73 65 63 74 6f 72 20 73 69 7a 65 20 6f 66  e sector size of
8110: 20 74 68 65 0a 2a 2a 20 64 65 76 69 63 65 20 74   the.** device t
8120: 68 61 74 20 75 6e 64 65 72 6c 69 65 73 20 74 68  hat underlies th
8130: 65 20 66 69 6c 65 2e 20 20 54 68 65 20 73 65 63  e file.  The sec
8140: 74 6f 72 20 73 69 7a 65 20 69 73 20 74 68 65 0a  tor size is the.
8150: 2a 2a 20 6d 69 6e 69 6d 75 6d 20 77 72 69 74 65  ** minimum write
8160: 20 74 68 61 74 20 63 61 6e 20 62 65 20 70 65 72   that can be per
8170: 66 6f 72 6d 65 64 20 77 69 74 68 6f 75 74 20 64  formed without d
8180: 69 73 74 75 72 62 69 6e 67 0a 2a 2a 20 6f 74 68  isturbing.** oth
8190: 65 72 20 62 79 74 65 73 20 69 6e 20 74 68 65 20  er bytes in the 
81a0: 66 69 6c 65 2e 20 20 54 68 65 20 78 44 65 76 69  file.  The xDevi
81b0: 63 65 43 68 61 72 61 63 74 65 72 69 73 74 69 63  ceCharacteristic
81c0: 73 28 29 0a 2a 2a 20 6d 65 74 68 6f 64 20 72 65  s().** method re
81d0: 74 75 72 6e 73 20 61 20 62 69 74 20 76 65 63 74  turns a bit vect
81e0: 6f 72 20 64 65 73 63 72 69 62 69 6e 67 20 62 65  or describing be
81f0: 68 61 76 69 6f 72 73 20 6f 66 20 74 68 65 0a 2a  haviors of the.*
8200: 2a 20 75 6e 64 65 72 6c 79 69 6e 67 20 64 65 76  * underlying dev
8210: 69 63 65 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a  ice:.**.** <ul>.
8220: 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f  ** <li> [SQLITE_
8230: 49 4f 43 41 50 5f 41 54 4f 4d 49 43 5d 0a 2a 2a  IOCAP_ATOMIC].**
8240: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f   <li> [SQLITE_IO
8250: 43 41 50 5f 41 54 4f 4d 49 43 35 31 32 5d 0a 2a  CAP_ATOMIC512].*
8260: 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49  * <li> [SQLITE_I
8270: 4f 43 41 50 5f 41 54 4f 4d 49 43 31 4b 5d 0a 2a  OCAP_ATOMIC1K].*
8280: 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49  * <li> [SQLITE_I
8290: 4f 43 41 50 5f 41 54 4f 4d 49 43 32 4b 5d 0a 2a  OCAP_ATOMIC2K].*
82a0: 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49  * <li> [SQLITE_I
82b0: 4f 43 41 50 5f 41 54 4f 4d 49 43 34 4b 5d 0a 2a  OCAP_ATOMIC4K].*
82c0: 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49  * <li> [SQLITE_I
82d0: 4f 43 41 50 5f 41 54 4f 4d 49 43 38 4b 5d 0a 2a  OCAP_ATOMIC8K].*
82e0: 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49  * <li> [SQLITE_I
82f0: 4f 43 41 50 5f 41 54 4f 4d 49 43 31 36 4b 5d 0a  OCAP_ATOMIC16K].
8300: 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f  ** <li> [SQLITE_
8310: 49 4f 43 41 50 5f 41 54 4f 4d 49 43 33 32 4b 5d  IOCAP_ATOMIC32K]
8320: 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45  .** <li> [SQLITE
8330: 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 36 34 4b  _IOCAP_ATOMIC64K
8340: 5d 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54  ].** <li> [SQLIT
8350: 45 5f 49 4f 43 41 50 5f 53 41 46 45 5f 41 50 50  E_IOCAP_SAFE_APP
8360: 45 4e 44 5d 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51  END].** <li> [SQ
8370: 4c 49 54 45 5f 49 4f 43 41 50 5f 53 45 51 55 45  LITE_IOCAP_SEQUE
8380: 4e 54 49 41 4c 5d 0a 2a 2a 20 3c 2f 75 6c 3e 0a  NTIAL].** </ul>.
8390: 2a 2a 0a 2a 2a 20 54 68 65 20 53 51 4c 49 54 45  **.** The SQLITE
83a0: 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 20 70 72  _IOCAP_ATOMIC pr
83b0: 6f 70 65 72 74 79 20 6d 65 61 6e 73 20 74 68 61  operty means tha
83c0: 74 20 61 6c 6c 20 77 72 69 74 65 73 20 6f 66 0a  t all writes of.
83d0: 2a 2a 20 61 6e 79 20 73 69 7a 65 20 61 72 65 20  ** any size are 
83e0: 61 74 6f 6d 69 63 2e 20 20 54 68 65 20 53 51 4c  atomic.  The SQL
83f0: 49 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43  ITE_IOCAP_ATOMIC
8400: 6e 6e 6e 20 76 61 6c 75 65 73 0a 2a 2a 20 6d 65  nnn values.** me
8410: 61 6e 20 74 68 61 74 20 77 72 69 74 65 73 20 6f  an that writes o
8420: 66 20 62 6c 6f 63 6b 73 20 74 68 61 74 20 61 72  f blocks that ar
8430: 65 20 6e 6e 6e 20 62 79 74 65 73 20 69 6e 20 73  e nnn bytes in s
8440: 69 7a 65 20 61 6e 64 0a 2a 2a 20 61 72 65 20 61  ize and.** are a
8450: 6c 69 67 6e 65 64 20 74 6f 20 61 6e 20 61 64 64  ligned to an add
8460: 72 65 73 73 20 77 68 69 63 68 20 69 73 20 61 6e  ress which is an
8470: 20 69 6e 74 65 67 65 72 20 6d 75 6c 74 69 70 6c   integer multipl
8480: 65 20 6f 66 0a 2a 2a 20 6e 6e 6e 20 61 72 65 20  e of.** nnn are 
8490: 61 74 6f 6d 69 63 2e 20 20 54 68 65 20 53 51 4c  atomic.  The SQL
84a0: 49 54 45 5f 49 4f 43 41 50 5f 53 41 46 45 5f 41  ITE_IOCAP_SAFE_A
84b0: 50 50 45 4e 44 20 76 61 6c 75 65 20 6d 65 61 6e  PPEND value mean
84c0: 73 0a 2a 2a 20 74 68 61 74 20 77 68 65 6e 20 64  s.** that when d
84d0: 61 74 61 20 69 73 20 61 70 70 65 6e 64 65 64 20  ata is appended 
84e0: 74 6f 20 61 20 66 69 6c 65 2c 20 74 68 65 20 64  to a file, the d
84f0: 61 74 61 20 69 73 20 61 70 70 65 6e 64 65 64 0a  ata is appended.
8500: 2a 2a 20 66 69 72 73 74 20 74 68 65 6e 20 74 68  ** first then th
8510: 65 20 73 69 7a 65 20 6f 66 20 74 68 65 20 66 69  e size of the fi
8520: 6c 65 20 69 73 20 65 78 74 65 6e 64 65 64 2c 20  le is extended, 
8530: 6e 65 76 65 72 20 74 68 65 20 6f 74 68 65 72 0a  never the other.
8540: 2a 2a 20 77 61 79 20 61 72 6f 75 6e 64 2e 20 20  ** way around.  
8550: 54 68 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50  The SQLITE_IOCAP
8560: 5f 53 45 51 55 45 4e 54 49 41 4c 20 70 72 6f 70  _SEQUENTIAL prop
8570: 65 72 74 79 20 6d 65 61 6e 73 20 74 68 61 74 0a  erty means that.
8580: 2a 2a 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 69  ** information i
8590: 73 20 77 72 69 74 74 65 6e 20 74 6f 20 64 69 73  s written to dis
85a0: 6b 20 69 6e 20 74 68 65 20 73 61 6d 65 20 6f 72  k in the same or
85b0: 64 65 72 20 61 73 20 63 61 6c 6c 73 0a 2a 2a 20  der as calls.** 
85c0: 74 6f 20 78 57 72 69 74 65 28 29 2e 0a 2a 2a 0a  to xWrite()..**.
85d0: 2a 2a 20 49 66 20 78 52 65 61 64 28 29 20 72 65  ** If xRead() re
85e0: 74 75 72 6e 73 20 53 51 4c 49 54 45 5f 49 4f 45  turns SQLITE_IOE
85f0: 52 52 5f 53 48 4f 52 54 5f 52 45 41 44 20 69 74  RR_SHORT_READ it
8600: 20 6d 75 73 74 20 61 6c 73 6f 20 66 69 6c 6c 0a   must also fill.
8610: 2a 2a 20 69 6e 20 74 68 65 20 75 6e 72 65 61 64  ** in the unread
8620: 20 70 6f 72 74 69 6f 6e 73 20 6f 66 20 74 68 65   portions of the
8630: 20 62 75 66 66 65 72 20 77 69 74 68 20 7a 65 72   buffer with zer
8640: 6f 73 2e 20 20 41 20 56 46 53 20 74 68 61 74 0a  os.  A VFS that.
8650: 2a 2a 20 66 61 69 6c 73 20 74 6f 20 7a 65 72 6f  ** fails to zero
8660: 2d 66 69 6c 6c 20 73 68 6f 72 74 20 72 65 61 64  -fill short read
8670: 73 20 6d 69 67 68 74 20 73 65 65 6d 20 74 6f 20  s might seem to 
8680: 77 6f 72 6b 2e 20 20 48 6f 77 65 76 65 72 2c 0a  work.  However,.
8690: 2a 2a 20 66 61 69 6c 75 72 65 20 74 6f 20 7a 65  ** failure to ze
86a0: 72 6f 2d 66 69 6c 6c 20 73 68 6f 72 74 20 72 65  ro-fill short re
86b0: 61 64 73 20 77 69 6c 6c 20 65 76 65 6e 74 75 61  ads will eventua
86c0: 6c 6c 79 20 6c 65 61 64 20 74 6f 0a 2a 2a 20 64  lly lead to.** d
86d0: 61 74 61 62 61 73 65 20 63 6f 72 72 75 70 74 69  atabase corrupti
86e0: 6f 6e 2e 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73  on..*/.typedef s
86f0: 74 72 75 63 74 20 73 71 6c 69 74 65 33 5f 69 6f  truct sqlite3_io
8700: 5f 6d 65 74 68 6f 64 73 20 73 71 6c 69 74 65 33  _methods sqlite3
8710: 5f 69 6f 5f 6d 65 74 68 6f 64 73 3b 0a 73 74 72  _io_methods;.str
8720: 75 63 74 20 73 71 6c 69 74 65 33 5f 69 6f 5f 6d  uct sqlite3_io_m
8730: 65 74 68 6f 64 73 20 7b 0a 20 20 69 6e 74 20 69  ethods {.  int i
8740: 56 65 72 73 69 6f 6e 3b 0a 20 20 69 6e 74 20 28  Version;.  int (
8750: 2a 78 43 6c 6f 73 65 29 28 73 71 6c 69 74 65 33  *xClose)(sqlite3
8760: 5f 66 69 6c 65 2a 29 3b 0a 20 20 69 6e 74 20 28  _file*);.  int (
8770: 2a 78 52 65 61 64 29 28 73 71 6c 69 74 65 33 5f  *xRead)(sqlite3_
8780: 66 69 6c 65 2a 2c 20 76 6f 69 64 2a 2c 20 69 6e  file*, void*, in
8790: 74 20 69 41 6d 74 2c 20 73 71 6c 69 74 65 33 5f  t iAmt, sqlite3_
87a0: 69 6e 74 36 34 20 69 4f 66 73 74 29 3b 0a 20 20  int64 iOfst);.  
87b0: 69 6e 74 20 28 2a 78 57 72 69 74 65 29 28 73 71  int (*xWrite)(sq
87c0: 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 63 6f 6e  lite3_file*, con
87d0: 73 74 20 76 6f 69 64 2a 2c 20 69 6e 74 20 69 41  st void*, int iA
87e0: 6d 74 2c 20 73 71 6c 69 74 65 33 5f 69 6e 74 36  mt, sqlite3_int6
87f0: 34 20 69 4f 66 73 74 29 3b 0a 20 20 69 6e 74 20  4 iOfst);.  int 
8800: 28 2a 78 54 72 75 6e 63 61 74 65 29 28 73 71 6c  (*xTruncate)(sql
8810: 69 74 65 33 5f 66 69 6c 65 2a 2c 20 73 71 6c 69  ite3_file*, sqli
8820: 74 65 33 5f 69 6e 74 36 34 20 73 69 7a 65 29 3b  te3_int64 size);
8830: 0a 20 20 69 6e 74 20 28 2a 78 53 79 6e 63 29 28  .  int (*xSync)(
8840: 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 69  sqlite3_file*, i
8850: 6e 74 20 66 6c 61 67 73 29 3b 0a 20 20 69 6e 74  nt flags);.  int
8860: 20 28 2a 78 46 69 6c 65 53 69 7a 65 29 28 73 71   (*xFileSize)(sq
8870: 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 73 71 6c  lite3_file*, sql
8880: 69 74 65 33 5f 69 6e 74 36 34 20 2a 70 53 69 7a  ite3_int64 *pSiz
8890: 65 29 3b 0a 20 20 69 6e 74 20 28 2a 78 4c 6f 63  e);.  int (*xLoc
88a0: 6b 29 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a  k)(sqlite3_file*
88b0: 2c 20 69 6e 74 29 3b 0a 20 20 69 6e 74 20 28 2a  , int);.  int (*
88c0: 78 55 6e 6c 6f 63 6b 29 28 73 71 6c 69 74 65 33  xUnlock)(sqlite3
88d0: 5f 66 69 6c 65 2a 2c 20 69 6e 74 29 3b 0a 20 20  _file*, int);.  
88e0: 69 6e 74 20 28 2a 78 43 68 65 63 6b 52 65 73 65  int (*xCheckRese
88f0: 72 76 65 64 4c 6f 63 6b 29 28 73 71 6c 69 74 65  rvedLock)(sqlite
8900: 33 5f 66 69 6c 65 2a 2c 20 69 6e 74 20 2a 70 52  3_file*, int *pR
8910: 65 73 4f 75 74 29 3b 0a 20 20 69 6e 74 20 28 2a  esOut);.  int (*
8920: 78 46 69 6c 65 43 6f 6e 74 72 6f 6c 29 28 73 71  xFileControl)(sq
8930: 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 69 6e 74  lite3_file*, int
8940: 20 6f 70 2c 20 76 6f 69 64 20 2a 70 41 72 67 29   op, void *pArg)
8950: 3b 0a 20 20 69 6e 74 20 28 2a 78 53 65 63 74 6f  ;.  int (*xSecto
8960: 72 53 69 7a 65 29 28 73 71 6c 69 74 65 33 5f 66  rSize)(sqlite3_f
8970: 69 6c 65 2a 29 3b 0a 20 20 69 6e 74 20 28 2a 78  ile*);.  int (*x
8980: 44 65 76 69 63 65 43 68 61 72 61 63 74 65 72 69  DeviceCharacteri
8990: 73 74 69 63 73 29 28 73 71 6c 69 74 65 33 5f 66  stics)(sqlite3_f
89a0: 69 6c 65 2a 29 3b 0a 20 20 2f 2a 20 4d 65 74 68  ile*);.  /* Meth
89b0: 6f 64 73 20 61 62 6f 76 65 20 61 72 65 20 76 61  ods above are va
89c0: 6c 69 64 20 66 6f 72 20 76 65 72 73 69 6f 6e 20  lid for version 
89d0: 31 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 53 68  1 */.  int (*xSh
89e0: 6d 4d 61 70 29 28 73 71 6c 69 74 65 33 5f 66 69  mMap)(sqlite3_fi
89f0: 6c 65 2a 2c 20 69 6e 74 20 69 50 67 2c 20 69 6e  le*, int iPg, in
8a00: 74 20 70 67 73 7a 2c 20 69 6e 74 2c 20 76 6f 69  t pgsz, int, voi
8a10: 64 20 76 6f 6c 61 74 69 6c 65 2a 2a 29 3b 0a 20  d volatile**);. 
8a20: 20 69 6e 74 20 28 2a 78 53 68 6d 4c 6f 63 6b 29   int (*xShmLock)
8a30: 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20  (sqlite3_file*, 
8a40: 69 6e 74 20 6f 66 66 73 65 74 2c 20 69 6e 74 20  int offset, int 
8a50: 6e 2c 20 69 6e 74 20 66 6c 61 67 73 29 3b 0a 20  n, int flags);. 
8a60: 20 76 6f 69 64 20 28 2a 78 53 68 6d 42 61 72 72   void (*xShmBarr
8a70: 69 65 72 29 28 73 71 6c 69 74 65 33 5f 66 69 6c  ier)(sqlite3_fil
8a80: 65 2a 29 3b 0a 20 20 69 6e 74 20 28 2a 78 53 68  e*);.  int (*xSh
8a90: 6d 55 6e 6d 61 70 29 28 73 71 6c 69 74 65 33 5f  mUnmap)(sqlite3_
8aa0: 66 69 6c 65 2a 2c 20 69 6e 74 20 64 65 6c 65 74  file*, int delet
8ab0: 65 46 6c 61 67 29 3b 0a 20 20 2f 2a 20 4d 65 74  eFlag);.  /* Met
8ac0: 68 6f 64 73 20 61 62 6f 76 65 20 61 72 65 20 76  hods above are v
8ad0: 61 6c 69 64 20 66 6f 72 20 76 65 72 73 69 6f 6e  alid for version
8ae0: 20 32 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 46   2 */.  int (*xF
8af0: 65 74 63 68 29 28 73 71 6c 69 74 65 33 5f 66 69  etch)(sqlite3_fi
8b00: 6c 65 2a 2c 20 73 71 6c 69 74 65 33 5f 69 6e 74  le*, sqlite3_int
8b10: 36 34 20 69 4f 66 73 74 2c 20 69 6e 74 20 69 41  64 iOfst, int iA
8b20: 6d 74 2c 20 76 6f 69 64 20 2a 2a 70 70 29 3b 0a  mt, void **pp);.
8b30: 20 20 69 6e 74 20 28 2a 78 55 6e 66 65 74 63 68    int (*xUnfetch
8b40: 29 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c  )(sqlite3_file*,
8b50: 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 20 69   sqlite3_int64 i
8b60: 4f 66 73 74 2c 20 76 6f 69 64 20 2a 70 29 3b 0a  Ofst, void *p);.
8b70: 20 20 2f 2a 20 4d 65 74 68 6f 64 73 20 61 62 6f    /* Methods abo
8b80: 76 65 20 61 72 65 20 76 61 6c 69 64 20 66 6f 72  ve are valid for
8b90: 20 76 65 72 73 69 6f 6e 20 33 20 2a 2f 0a 20 20   version 3 */.  
8ba0: 2f 2a 20 41 64 64 69 74 69 6f 6e 61 6c 20 6d 65  /* Additional me
8bb0: 74 68 6f 64 73 20 6d 61 79 20 62 65 20 61 64 64  thods may be add
8bc0: 65 64 20 69 6e 20 66 75 74 75 72 65 20 72 65 6c  ed in future rel
8bd0: 65 61 73 65 73 20 2a 2f 0a 7d 3b 0a 0a 2f 2a 0a  eases */.};../*.
8be0: 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 53 74 61  ** CAPI3REF: Sta
8bf0: 6e 64 61 72 64 20 46 69 6c 65 20 43 6f 6e 74 72  ndard File Contr
8c00: 6f 6c 20 4f 70 63 6f 64 65 73 0a 2a 2a 20 4b 45  ol Opcodes.** KE
8c10: 59 57 4f 52 44 53 3a 20 7b 66 69 6c 65 20 63 6f  YWORDS: {file co
8c20: 6e 74 72 6f 6c 20 6f 70 63 6f 64 65 73 7d 20 7b  ntrol opcodes} {
8c30: 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 6f 70 63  file control opc
8c40: 6f 64 65 7d 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65  ode}.**.** These
8c50: 20 69 6e 74 65 67 65 72 20 63 6f 6e 73 74 61 6e   integer constan
8c60: 74 73 20 61 72 65 20 6f 70 63 6f 64 65 73 20 66  ts are opcodes f
8c70: 6f 72 20 74 68 65 20 78 46 69 6c 65 43 6f 6e 74  or the xFileCont
8c80: 72 6f 6c 20 6d 65 74 68 6f 64 0a 2a 2a 20 6f 66  rol method.** of
8c90: 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 69 6f   the [sqlite3_io
8ca0: 5f 6d 65 74 68 6f 64 73 5d 20 6f 62 6a 65 63 74  _methods] object
8cb0: 20 61 6e 64 20 66 6f 72 20 74 68 65 20 5b 73 71   and for the [sq
8cc0: 6c 69 74 65 33 5f 66 69 6c 65 5f 63 6f 6e 74 72  lite3_file_contr
8cd0: 6f 6c 28 29 5d 0a 2a 2a 20 69 6e 74 65 72 66 61  ol()].** interfa
8ce0: 63 65 2e 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a  ce..**.** <ul>.*
8cf0: 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46  * <li>[[SQLITE_F
8d00: 43 4e 54 4c 5f 4c 4f 43 4b 53 54 41 54 45 5d 5d  CNTL_LOCKSTATE]]
8d10: 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54 45 5f  .** The [SQLITE_
8d20: 46 43 4e 54 4c 5f 4c 4f 43 4b 53 54 41 54 45 5d  FCNTL_LOCKSTATE]
8d30: 20 6f 70 63 6f 64 65 20 69 73 20 75 73 65 64 20   opcode is used 
8d40: 66 6f 72 20 64 65 62 75 67 67 69 6e 67 2e 20 20  for debugging.  
8d50: 54 68 69 73 0a 2a 2a 20 6f 70 63 6f 64 65 20 63  This.** opcode c
8d60: 61 75 73 65 73 20 74 68 65 20 78 46 69 6c 65 43  auses the xFileC
8d70: 6f 6e 74 72 6f 6c 20 6d 65 74 68 6f 64 20 74 6f  ontrol method to
8d80: 20 77 72 69 74 65 20 74 68 65 20 63 75 72 72 65   write the curre
8d90: 6e 74 20 73 74 61 74 65 20 6f 66 0a 2a 2a 20 74  nt state of.** t
8da0: 68 65 20 6c 6f 63 6b 20 28 6f 6e 65 20 6f 66 20  he lock (one of 
8db0: 5b 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 4e 4f 4e  [SQLITE_LOCK_NON
8dc0: 45 5d 2c 20 5b 53 51 4c 49 54 45 5f 4c 4f 43 4b  E], [SQLITE_LOCK
8dd0: 5f 53 48 41 52 45 44 5d 2c 0a 2a 2a 20 5b 53 51  _SHARED],.** [SQ
8de0: 4c 49 54 45 5f 4c 4f 43 4b 5f 52 45 53 45 52 56  LITE_LOCK_RESERV
8df0: 45 44 5d 2c 20 5b 53 51 4c 49 54 45 5f 4c 4f 43  ED], [SQLITE_LOC
8e00: 4b 5f 50 45 4e 44 49 4e 47 5d 2c 20 6f 72 20 5b  K_PENDING], or [
8e10: 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 45 58 43 4c  SQLITE_LOCK_EXCL
8e20: 55 53 49 56 45 5d 29 0a 2a 2a 20 69 6e 74 6f 20  USIVE]).** into 
8e30: 61 6e 20 69 6e 74 65 67 65 72 20 74 68 61 74 20  an integer that 
8e40: 74 68 65 20 70 41 72 67 20 61 72 67 75 6d 65 6e  the pArg argumen
8e50: 74 20 70 6f 69 6e 74 73 20 74 6f 2e 20 54 68 69  t points to. Thi
8e60: 73 20 63 61 70 61 62 69 6c 69 74 79 0a 2a 2a 20  s capability.** 
8e70: 69 73 20 75 73 65 64 20 64 75 72 69 6e 67 20 74  is used during t
8e80: 65 73 74 69 6e 67 20 61 6e 64 20 69 73 20 6f 6e  esting and is on
8e90: 6c 79 20 61 76 61 69 6c 61 62 6c 65 20 77 68 65  ly available whe
8ea0: 6e 20 74 68 65 20 53 51 4c 49 54 45 5f 54 45 53  n the SQLITE_TES
8eb0: 54 0a 2a 2a 20 63 6f 6d 70 69 6c 65 2d 74 69 6d  T.** compile-tim
8ec0: 65 20 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64  e option is used
8ed0: 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51  ..**.** <li>[[SQ
8ee0: 4c 49 54 45 5f 46 43 4e 54 4c 5f 53 49 5a 45 5f  LITE_FCNTL_SIZE_
8ef0: 48 49 4e 54 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53  HINT]].** The [S
8f00: 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 53 49 5a 45  QLITE_FCNTL_SIZE
8f10: 5f 48 49 4e 54 5d 20 6f 70 63 6f 64 65 20 69 73  _HINT] opcode is
8f20: 20 75 73 65 64 20 62 79 20 53 51 4c 69 74 65 20   used by SQLite 
8f30: 74 6f 20 67 69 76 65 20 74 68 65 20 56 46 53 0a  to give the VFS.
8f40: 2a 2a 20 6c 61 79 65 72 20 61 20 68 69 6e 74 20  ** layer a hint 
8f50: 6f 66 20 68 6f 77 20 6c 61 72 67 65 20 74 68 65  of how large the
8f60: 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 77   database file w
8f70: 69 6c 6c 20 67 72 6f 77 20 74 6f 20 62 65 20 64  ill grow to be d
8f80: 75 72 69 6e 67 20 74 68 65 0a 2a 2a 20 63 75 72  uring the.** cur
8f90: 72 65 6e 74 20 74 72 61 6e 73 61 63 74 69 6f 6e  rent transaction
8fa0: 2e 20 20 54 68 69 73 20 68 69 6e 74 20 69 73 20  .  This hint is 
8fb0: 6e 6f 74 20 67 75 61 72 61 6e 74 65 65 64 20 74  not guaranteed t
8fc0: 6f 20 62 65 20 61 63 63 75 72 61 74 65 20 62 75  o be accurate bu
8fd0: 74 20 69 74 0a 2a 2a 20 69 73 20 6f 66 74 65 6e  t it.** is often
8fe0: 20 63 6c 6f 73 65 2e 20 20 54 68 65 20 75 6e 64   close.  The und
8ff0: 65 72 6c 79 69 6e 67 20 56 46 53 20 6d 69 67 68  erlying VFS migh
9000: 74 20 63 68 6f 6f 73 65 20 74 6f 20 70 72 65 61  t choose to prea
9010: 6c 6c 6f 63 61 74 65 20 64 61 74 61 62 61 73 65  llocate database
9020: 0a 2a 2a 20 66 69 6c 65 20 73 70 61 63 65 20 62  .** file space b
9030: 61 73 65 64 20 6f 6e 20 74 68 69 73 20 68 69 6e  ased on this hin
9040: 74 20 69 6e 20 6f 72 64 65 72 20 74 6f 20 68 65  t in order to he
9050: 6c 70 20 77 72 69 74 65 73 20 74 6f 20 74 68 65  lp writes to the
9060: 20 64 61 74 61 62 61 73 65 0a 2a 2a 20 66 69 6c   database.** fil
9070: 65 20 72 75 6e 20 66 61 73 74 65 72 2e 0a 2a 2a  e run faster..**
9080: 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45  .** <li>[[SQLITE
9090: 5f 46 43 4e 54 4c 5f 43 48 55 4e 4b 5f 53 49 5a  _FCNTL_CHUNK_SIZ
90a0: 45 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49  E]].** The [SQLI
90b0: 54 45 5f 46 43 4e 54 4c 5f 43 48 55 4e 4b 5f 53  TE_FCNTL_CHUNK_S
90c0: 49 5a 45 5d 20 6f 70 63 6f 64 65 20 69 73 20 75  IZE] opcode is u
90d0: 73 65 64 20 74 6f 20 72 65 71 75 65 73 74 20 74  sed to request t
90e0: 68 61 74 20 74 68 65 20 56 46 53 0a 2a 2a 20 65  hat the VFS.** e
90f0: 78 74 65 6e 64 73 20 61 6e 64 20 74 72 75 6e 63  xtends and trunc
9100: 61 74 65 73 20 74 68 65 20 64 61 74 61 62 61 73  ates the databas
9110: 65 20 66 69 6c 65 20 69 6e 20 63 68 75 6e 6b 73  e file in chunks
9120: 20 6f 66 20 61 20 73 69 7a 65 20 73 70 65 63 69   of a size speci
9130: 66 69 65 64 0a 2a 2a 20 62 79 20 74 68 65 20 75  fied.** by the u
9140: 73 65 72 2e 20 54 68 65 20 66 6f 75 72 74 68 20  ser. The fourth 
9150: 61 72 67 75 6d 65 6e 74 20 74 6f 20 5b 73 71 6c  argument to [sql
9160: 69 74 65 33 5f 66 69 6c 65 5f 63 6f 6e 74 72 6f  ite3_file_contro
9170: 6c 28 29 5d 20 73 68 6f 75 6c 64 20 0a 2a 2a 20  l()] should .** 
9180: 70 6f 69 6e 74 20 74 6f 20 61 6e 20 69 6e 74 65  point to an inte
9190: 67 65 72 20 28 74 79 70 65 20 69 6e 74 29 20 63  ger (type int) c
91a0: 6f 6e 74 61 69 6e 69 6e 67 20 74 68 65 20 6e 65  ontaining the ne
91b0: 77 20 63 68 75 6e 6b 2d 73 69 7a 65 20 74 6f 20  w chunk-size to 
91c0: 75 73 65 0a 2a 2a 20 66 6f 72 20 74 68 65 20 6e  use.** for the n
91d0: 6f 6d 69 6e 61 74 65 64 20 64 61 74 61 62 61 73  ominated databas
91e0: 65 2e 20 41 6c 6c 6f 63 61 74 69 6e 67 20 64 61  e. Allocating da
91f0: 74 61 62 61 73 65 20 66 69 6c 65 20 73 70 61 63  tabase file spac
9200: 65 20 69 6e 20 6c 61 72 67 65 0a 2a 2a 20 63 68  e in large.** ch
9210: 75 6e 6b 73 20 28 73 61 79 20 31 4d 42 20 61 74  unks (say 1MB at
9220: 20 61 20 74 69 6d 65 29 2c 20 6d 61 79 20 72 65   a time), may re
9230: 64 75 63 65 20 66 69 6c 65 2d 73 79 73 74 65 6d  duce file-system
9240: 20 66 72 61 67 6d 65 6e 74 61 74 69 6f 6e 20 61   fragmentation a
9250: 6e 64 0a 2a 2a 20 69 6d 70 72 6f 76 65 20 70 65  nd.** improve pe
9260: 72 66 6f 72 6d 61 6e 63 65 20 6f 6e 20 73 6f 6d  rformance on som
9270: 65 20 73 79 73 74 65 6d 73 2e 0a 2a 2a 0a 2a 2a  e systems..**.**
9280: 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43   <li>[[SQLITE_FC
9290: 4e 54 4c 5f 46 49 4c 45 5f 50 4f 49 4e 54 45 52  NTL_FILE_POINTER
92a0: 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54  ]].** The [SQLIT
92b0: 45 5f 46 43 4e 54 4c 5f 46 49 4c 45 5f 50 4f 49  E_FCNTL_FILE_POI
92c0: 4e 54 45 52 5d 20 6f 70 63 6f 64 65 20 69 73 20  NTER] opcode is 
92d0: 75 73 65 64 20 74 6f 20 6f 62 74 61 69 6e 20 61  used to obtain a
92e0: 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 74 6f 20 74   pointer.** to t
92f0: 68 65 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65  he [sqlite3_file
9300: 5d 20 6f 62 6a 65 63 74 20 61 73 73 6f 63 69 61  ] object associa
9310: 74 65 64 20 77 69 74 68 20 61 20 70 61 72 74 69  ted with a parti
9320: 63 75 6c 61 72 20 64 61 74 61 62 61 73 65 0a 2a  cular database.*
9330: 2a 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e 20 20 53  * connection.  S
9340: 65 65 20 61 6c 73 6f 20 5b 53 51 4c 49 54 45 5f  ee also [SQLITE_
9350: 46 43 4e 54 4c 5f 4a 4f 55 52 4e 41 4c 5f 50 4f  FCNTL_JOURNAL_PO
9360: 49 4e 54 45 52 5d 2e 0a 2a 2a 0a 2a 2a 20 3c 6c  INTER]..**.** <l
9370: 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  i>[[SQLITE_FCNTL
9380: 5f 4a 4f 55 52 4e 41 4c 5f 50 4f 49 4e 54 45 52  _JOURNAL_POINTER
9390: 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54  ]].** The [SQLIT
93a0: 45 5f 46 43 4e 54 4c 5f 4a 4f 55 52 4e 41 4c 5f  E_FCNTL_JOURNAL_
93b0: 50 4f 49 4e 54 45 52 5d 20 6f 70 63 6f 64 65 20  POINTER] opcode 
93c0: 69 73 20 75 73 65 64 20 74 6f 20 6f 62 74 61 69  is used to obtai
93d0: 6e 20 61 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 74  n a pointer.** t
93e0: 6f 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 66  o the [sqlite3_f
93f0: 69 6c 65 5d 20 6f 62 6a 65 63 74 20 61 73 73 6f  ile] object asso
9400: 63 69 61 74 65 64 20 77 69 74 68 20 74 68 65 20  ciated with the 
9410: 6a 6f 75 72 6e 61 6c 20 66 69 6c 65 20 28 65 69  journal file (ei
9420: 74 68 65 72 0a 2a 2a 20 74 68 65 20 5b 72 6f 6c  ther.** the [rol
9430: 6c 62 61 63 6b 20 6a 6f 75 72 6e 61 6c 5d 20 6f  lback journal] o
9440: 72 20 74 68 65 20 5b 77 72 69 74 65 2d 61 68 65  r the [write-ahe
9450: 61 64 20 6c 6f 67 5d 29 20 66 6f 72 20 61 20 70  ad log]) for a p
9460: 61 72 74 69 63 75 6c 61 72 20 64 61 74 61 62 61  articular databa
9470: 73 65 0a 2a 2a 20 63 6f 6e 6e 65 63 74 69 6f 6e  se.** connection
9480: 2e 20 20 53 65 65 20 61 6c 73 6f 20 5b 53 51 4c  .  See also [SQL
9490: 49 54 45 5f 46 43 4e 54 4c 5f 46 49 4c 45 5f 50  ITE_FCNTL_FILE_P
94a0: 4f 49 4e 54 45 52 5d 2e 0a 2a 2a 0a 2a 2a 20 3c  OINTER]..**.** <
94b0: 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54  li>[[SQLITE_FCNT
94c0: 4c 5f 53 59 4e 43 5f 4f 4d 49 54 54 45 44 5d 5d  L_SYNC_OMITTED]]
94d0: 0a 2a 2a 20 4e 6f 20 6c 6f 6e 67 65 72 20 69 6e  .** No longer in
94e0: 20 75 73 65 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e   use..**.** <li>
94f0: 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 53  [[SQLITE_FCNTL_S
9500: 59 4e 43 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53 51  YNC]].** The [SQ
9510: 4c 49 54 45 5f 46 43 4e 54 4c 5f 53 59 4e 43 5d  LITE_FCNTL_SYNC]
9520: 20 6f 70 63 6f 64 65 20 69 73 20 67 65 6e 65 72   opcode is gener
9530: 61 74 65 64 20 69 6e 74 65 72 6e 61 6c 6c 79 20  ated internally 
9540: 62 79 20 53 51 4c 69 74 65 20 61 6e 64 0a 2a 2a  by SQLite and.**
9550: 20 73 65 6e 74 20 74 6f 20 74 68 65 20 56 46 53   sent to the VFS
9560: 20 69 6d 6d 65 64 69 61 74 65 6c 79 20 62 65 66   immediately bef
9570: 6f 72 65 20 74 68 65 20 78 53 79 6e 63 20 6d 65  ore the xSync me
9580: 74 68 6f 64 20 69 73 20 69 6e 76 6f 6b 65 64 20  thod is invoked 
9590: 6f 6e 20 61 0a 2a 2a 20 64 61 74 61 62 61 73 65  on a.** database
95a0: 20 66 69 6c 65 20 64 65 73 63 72 69 70 74 6f 72   file descriptor
95b0: 2e 20 4f 72 2c 20 69 66 20 74 68 65 20 78 53 79  . Or, if the xSy
95c0: 6e 63 20 6d 65 74 68 6f 64 20 69 73 20 6e 6f 74  nc method is not
95d0: 20 69 6e 76 6f 6b 65 64 20 0a 2a 2a 20 62 65 63   invoked .** bec
95e0: 61 75 73 65 20 74 68 65 20 75 73 65 72 20 68 61  ause the user ha
95f0: 73 20 63 6f 6e 66 69 67 75 72 65 64 20 53 51 4c  s configured SQL
9600: 69 74 65 20 77 69 74 68 20 0a 2a 2a 20 5b 50 52  ite with .** [PR
9610: 41 47 4d 41 20 73 79 6e 63 68 72 6f 6e 6f 75 73  AGMA synchronous
9620: 20 7c 20 50 52 41 47 4d 41 20 73 79 6e 63 68 72   | PRAGMA synchr
9630: 6f 6e 6f 75 73 3d 4f 46 46 5d 20 69 74 20 69 73  onous=OFF] it is
9640: 20 69 6e 76 6f 6b 65 64 20 69 6e 20 70 6c 61 63   invoked in plac
9650: 65 20 0a 2a 2a 20 6f 66 20 74 68 65 20 78 53 79  e .** of the xSy
9660: 6e 63 20 6d 65 74 68 6f 64 2e 20 49 6e 20 6d 6f  nc method. In mo
9670: 73 74 20 63 61 73 65 73 2c 20 74 68 65 20 70 6f  st cases, the po
9680: 69 6e 74 65 72 20 61 72 67 75 6d 65 6e 74 20 70  inter argument p
9690: 61 73 73 65 64 20 77 69 74 68 0a 2a 2a 20 74 68  assed with.** th
96a0: 69 73 20 66 69 6c 65 2d 63 6f 6e 74 72 6f 6c 20  is file-control 
96b0: 69 73 20 4e 55 4c 4c 2e 20 48 6f 77 65 76 65 72  is NULL. However
96c0: 2c 20 69 66 20 74 68 65 20 64 61 74 61 62 61 73  , if the databas
96d0: 65 20 66 69 6c 65 20 69 73 20 62 65 69 6e 67 20  e file is being 
96e0: 73 79 6e 63 65 64 0a 2a 2a 20 61 73 20 70 61 72  synced.** as par
96f0: 74 20 6f 66 20 61 20 6d 75 6c 74 69 2d 64 61 74  t of a multi-dat
9700: 61 62 61 73 65 20 63 6f 6d 6d 69 74 2c 20 74 68  abase commit, th
9710: 65 20 61 72 67 75 6d 65 6e 74 20 70 6f 69 6e 74  e argument point
9720: 73 20 74 6f 20 61 20 6e 75 6c 2d 74 65 72 6d 69  s to a nul-termi
9730: 6e 61 74 65 64 0a 2a 2a 20 73 74 72 69 6e 67 20  nated.** string 
9740: 63 6f 6e 74 61 69 6e 69 6e 67 20 74 68 65 20 74  containing the t
9750: 72 61 6e 73 61 63 74 69 6f 6e 73 20 6d 61 73 74  ransactions mast
9760: 65 72 2d 6a 6f 75 72 6e 61 6c 20 66 69 6c 65 20  er-journal file 
9770: 6e 61 6d 65 2e 20 56 46 53 65 73 20 74 68 61 74  name. VFSes that
9780: 20 0a 2a 2a 20 64 6f 20 6e 6f 74 20 6e 65 65 64   .** do not need
9790: 20 74 68 69 73 20 73 69 67 6e 61 6c 20 73 68 6f   this signal sho
97a0: 75 6c 64 20 73 69 6c 65 6e 74 6c 79 20 69 67 6e  uld silently ign
97b0: 6f 72 65 20 74 68 69 73 20 6f 70 63 6f 64 65 2e  ore this opcode.
97c0: 20 41 70 70 6c 69 63 61 74 69 6f 6e 73 20 0a 2a   Applications .*
97d0: 2a 20 73 68 6f 75 6c 64 20 6e 6f 74 20 63 61 6c  * should not cal
97e0: 6c 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5f  l [sqlite3_file_
97f0: 63 6f 6e 74 72 6f 6c 28 29 5d 20 77 69 74 68 20  control()] with 
9800: 74 68 69 73 20 6f 70 63 6f 64 65 20 61 73 20 64  this opcode as d
9810: 6f 69 6e 67 20 73 6f 20 6d 61 79 20 0a 2a 2a 20  oing so may .** 
9820: 64 69 73 72 75 70 74 20 74 68 65 20 6f 70 65 72  disrupt the oper
9830: 61 74 69 6f 6e 20 6f 66 20 74 68 65 20 73 70 65  ation of the spe
9840: 63 69 61 6c 69 7a 65 64 20 56 46 53 65 73 20 74  cialized VFSes t
9850: 68 61 74 20 64 6f 20 72 65 71 75 69 72 65 20 69  hat do require i
9860: 74 2e 20 20 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b  t.  .**.** <li>[
9870: 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 43 4f  [SQLITE_FCNTL_CO
9880: 4d 4d 49 54 5f 50 48 41 53 45 54 57 4f 5d 5d 0a  MMIT_PHASETWO]].
9890: 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 46  ** The [SQLITE_F
98a0: 43 4e 54 4c 5f 43 4f 4d 4d 49 54 5f 50 48 41 53  CNTL_COMMIT_PHAS
98b0: 45 54 57 4f 5d 20 6f 70 63 6f 64 65 20 69 73 20  ETWO] opcode is 
98c0: 67 65 6e 65 72 61 74 65 64 20 69 6e 74 65 72 6e  generated intern
98d0: 61 6c 6c 79 20 62 79 20 53 51 4c 69 74 65 0a 2a  ally by SQLite.*
98e0: 2a 20 61 6e 64 20 73 65 6e 74 20 74 6f 20 74 68  * and sent to th
98f0: 65 20 56 46 53 20 61 66 74 65 72 20 61 20 74 72  e VFS after a tr
9900: 61 6e 73 61 63 74 69 6f 6e 20 68 61 73 20 62 65  ansaction has be
9910: 65 6e 20 63 6f 6d 6d 69 74 74 65 64 20 69 6d 6d  en committed imm
9920: 65 64 69 61 74 65 6c 79 0a 2a 2a 20 62 75 74 20  ediately.** but 
9930: 62 65 66 6f 72 65 20 74 68 65 20 64 61 74 61 62  before the datab
9940: 61 73 65 20 69 73 20 75 6e 6c 6f 63 6b 65 64 2e  ase is unlocked.
9950: 20 56 46 53 65 73 20 74 68 61 74 20 64 6f 20 6e   VFSes that do n
9960: 6f 74 20 6e 65 65 64 20 74 68 69 73 20 73 69 67  ot need this sig
9970: 6e 61 6c 0a 2a 2a 20 73 68 6f 75 6c 64 20 73 69  nal.** should si
9980: 6c 65 6e 74 6c 79 20 69 67 6e 6f 72 65 20 74 68  lently ignore th
9990: 69 73 20 6f 70 63 6f 64 65 2e 20 41 70 70 6c 69  is opcode. Appli
99a0: 63 61 74 69 6f 6e 73 20 73 68 6f 75 6c 64 20 6e  cations should n
99b0: 6f 74 20 63 61 6c 6c 0a 2a 2a 20 5b 73 71 6c 69  ot call.** [sqli
99c0: 74 65 33 5f 66 69 6c 65 5f 63 6f 6e 74 72 6f 6c  te3_file_control
99d0: 28 29 5d 20 77 69 74 68 20 74 68 69 73 20 6f 70  ()] with this op
99e0: 63 6f 64 65 20 61 73 20 64 6f 69 6e 67 20 73 6f  code as doing so
99f0: 20 6d 61 79 20 64 69 73 72 75 70 74 20 74 68 65   may disrupt the
9a00: 20 0a 2a 2a 20 6f 70 65 72 61 74 69 6f 6e 20 6f   .** operation o
9a10: 66 20 74 68 65 20 73 70 65 63 69 61 6c 69 7a 65  f the specialize
9a20: 64 20 56 46 53 65 73 20 74 68 61 74 20 64 6f 20  d VFSes that do 
9a30: 72 65 71 75 69 72 65 20 69 74 2e 20 20 0a 2a 2a  require it.  .**
9a40: 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45  .** <li>[[SQLITE
9a50: 5f 46 43 4e 54 4c 5f 57 49 4e 33 32 5f 41 56 5f  _FCNTL_WIN32_AV_
9a60: 52 45 54 52 59 5d 5d 0a 2a 2a 20 5e 54 68 65 20  RETRY]].** ^The 
9a70: 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 57 49  [SQLITE_FCNTL_WI
9a80: 4e 33 32 5f 41 56 5f 52 45 54 52 59 5d 20 6f 70  N32_AV_RETRY] op
9a90: 63 6f 64 65 20 69 73 20 75 73 65 64 20 74 6f 20  code is used to 
9aa0: 63 6f 6e 66 69 67 75 72 65 20 61 75 74 6f 6d 61  configure automa
9ab0: 74 69 63 0a 2a 2a 20 72 65 74 72 79 20 63 6f 75  tic.** retry cou
9ac0: 6e 74 73 20 61 6e 64 20 69 6e 74 65 72 76 61 6c  nts and interval
9ad0: 73 20 66 6f 72 20 63 65 72 74 61 69 6e 20 64 69  s for certain di
9ae0: 73 6b 20 49 2f 4f 20 6f 70 65 72 61 74 69 6f 6e  sk I/O operation
9af0: 73 20 66 6f 72 20 74 68 65 0a 2a 2a 20 77 69 6e  s for the.** win
9b00: 64 6f 77 73 20 5b 56 46 53 5d 20 69 6e 20 6f 72  dows [VFS] in or
9b10: 64 65 72 20 74 6f 20 70 72 6f 76 69 64 65 20 72  der to provide r
9b20: 6f 62 75 73 74 6e 65 73 73 20 69 6e 20 74 68 65  obustness in the
9b30: 20 70 72 65 73 65 6e 63 65 20 6f 66 0a 2a 2a 20   presence of.** 
9b40: 61 6e 74 69 2d 76 69 72 75 73 20 70 72 6f 67 72  anti-virus progr
9b50: 61 6d 73 2e 20 20 42 79 20 64 65 66 61 75 6c 74  ams.  By default
9b60: 2c 20 74 68 65 20 77 69 6e 64 6f 77 73 20 56 46  , the windows VF
9b70: 53 20 77 69 6c 6c 20 72 65 74 72 79 20 66 69 6c  S will retry fil
9b80: 65 20 72 65 61 64 2c 0a 2a 2a 20 66 69 6c 65 20  e read,.** file 
9b90: 77 72 69 74 65 2c 20 61 6e 64 20 66 69 6c 65 20  write, and file 
9ba0: 64 65 6c 65 74 65 20 6f 70 65 72 61 74 69 6f 6e  delete operation
9bb0: 73 20 75 70 20 74 6f 20 31 30 20 74 69 6d 65 73  s up to 10 times
9bc0: 2c 20 77 69 74 68 20 61 20 64 65 6c 61 79 0a 2a  , with a delay.*
9bd0: 2a 20 6f 66 20 32 35 20 6d 69 6c 6c 69 73 65 63  * of 25 millisec
9be0: 6f 6e 64 73 20 62 65 66 6f 72 65 20 74 68 65 20  onds before the 
9bf0: 66 69 72 73 74 20 72 65 74 72 79 20 61 6e 64 20  first retry and 
9c00: 77 69 74 68 20 74 68 65 20 64 65 6c 61 79 20 69  with the delay i
9c10: 6e 63 72 65 61 73 69 6e 67 0a 2a 2a 20 62 79 20  ncreasing.** by 
9c20: 61 6e 20 61 64 64 69 74 69 6f 6e 61 6c 20 32 35  an additional 25
9c30: 20 6d 69 6c 6c 69 73 65 63 6f 6e 64 73 20 77 69   milliseconds wi
9c40: 74 68 20 65 61 63 68 20 73 75 62 73 65 71 75 65  th each subseque
9c50: 6e 74 20 72 65 74 72 79 2e 20 20 54 68 69 73 0a  nt retry.  This.
9c60: 2a 2a 20 6f 70 63 6f 64 65 20 61 6c 6c 6f 77 73  ** opcode allows
9c70: 20 74 68 65 73 65 20 74 77 6f 20 76 61 6c 75 65   these two value
9c80: 73 20 28 31 30 20 72 65 74 72 69 65 73 20 61 6e  s (10 retries an
9c90: 64 20 32 35 20 6d 69 6c 6c 69 73 65 63 6f 6e 64  d 25 millisecond
9ca0: 73 20 6f 66 20 64 65 6c 61 79 29 0a 2a 2a 20 74  s of delay).** t
9cb0: 6f 20 62 65 20 61 64 6a 75 73 74 65 64 2e 20 20  o be adjusted.  
9cc0: 54 68 65 20 76 61 6c 75 65 73 20 61 72 65 20 63  The values are c
9cd0: 68 61 6e 67 65 64 20 66 6f 72 20 61 6c 6c 20 64  hanged for all d
9ce0: 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
9cf0: 6f 6e 73 0a 2a 2a 20 77 69 74 68 69 6e 20 74 68  ons.** within th
9d00: 65 20 73 61 6d 65 20 70 72 6f 63 65 73 73 2e 20  e same process. 
9d10: 20 54 68 65 20 61 72 67 75 6d 65 6e 74 20 69 73   The argument is
9d20: 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e   a pointer to an
9d30: 20 61 72 72 61 79 20 6f 66 20 74 77 6f 0a 2a 2a   array of two.**
9d40: 20 69 6e 74 65 67 65 72 73 20 77 68 65 72 65 20   integers where 
9d50: 74 68 65 20 66 69 72 73 74 20 69 6e 74 65 67 65  the first intege
9d60: 72 20 69 20 74 68 65 20 6e 65 77 20 72 65 74 72  r i the new retr
9d70: 79 20 63 6f 75 6e 74 20 61 6e 64 20 74 68 65 20  y count and the 
9d80: 73 65 63 6f 6e 64 0a 2a 2a 20 69 6e 74 65 67 65  second.** intege
9d90: 72 20 69 73 20 74 68 65 20 64 65 6c 61 79 2e 20  r is the delay. 
9da0: 20 49 66 20 65 69 74 68 65 72 20 69 6e 74 65 67   If either integ
9db0: 65 72 20 69 73 20 6e 65 67 61 74 69 76 65 2c 20  er is negative, 
9dc0: 74 68 65 6e 20 74 68 65 20 73 65 74 74 69 6e 67  then the setting
9dd0: 0a 2a 2a 20 69 73 20 6e 6f 74 20 63 68 61 6e 67  .** is not chang
9de0: 65 64 20 62 75 74 20 69 6e 73 74 65 61 64 20 74  ed but instead t
9df0: 68 65 20 70 72 69 6f 72 20 76 61 6c 75 65 20 6f  he prior value o
9e00: 66 20 74 68 61 74 20 73 65 74 74 69 6e 67 20 69  f that setting i
9e10: 73 20 77 72 69 74 74 65 6e 0a 2a 2a 20 69 6e 74  s written.** int
9e20: 6f 20 74 68 65 20 61 72 72 61 79 20 65 6e 74 72  o the array entr
9e30: 79 2c 20 61 6c 6c 6f 77 69 6e 67 20 74 68 65 20  y, allowing the 
9e40: 63 75 72 72 65 6e 74 20 72 65 74 72 79 20 73 65  current retry se
9e50: 74 74 69 6e 67 73 20 74 6f 20 62 65 0a 2a 2a 20  ttings to be.** 
9e60: 69 6e 74 65 72 72 6f 67 61 74 65 64 2e 20 20 54  interrogated.  T
9e70: 68 65 20 7a 44 62 4e 61 6d 65 20 70 61 72 61 6d  he zDbName param
9e80: 65 74 65 72 20 69 73 20 69 67 6e 6f 72 65 64 2e  eter is ignored.
9e90: 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c  .**.** <li>[[SQL
9ea0: 49 54 45 5f 46 43 4e 54 4c 5f 50 45 52 53 49 53  ITE_FCNTL_PERSIS
9eb0: 54 5f 57 41 4c 5d 5d 0a 2a 2a 20 5e 54 68 65 20  T_WAL]].** ^The 
9ec0: 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 50 45  [SQLITE_FCNTL_PE
9ed0: 52 53 49 53 54 5f 57 41 4c 5d 20 6f 70 63 6f 64  RSIST_WAL] opcod
9ee0: 65 20 69 73 20 75 73 65 64 20 74 6f 20 73 65 74  e is used to set
9ef0: 20 6f 72 20 71 75 65 72 79 20 74 68 65 0a 2a 2a   or query the.**
9f00: 20 70 65 72 73 69 73 74 65 6e 74 20 5b 57 41 4c   persistent [WAL
9f10: 20 7c 20 57 72 69 74 65 20 41 68 65 61 64 20 4c   | Write Ahead L
9f20: 6f 67 5d 20 73 65 74 74 69 6e 67 2e 20 20 42 79  og] setting.  By
9f30: 20 64 65 66 61 75 6c 74 2c 20 74 68 65 20 61 75   default, the au
9f40: 78 69 6c 69 61 72 79 0a 2a 2a 20 77 72 69 74 65  xiliary.** write
9f50: 20 61 68 65 61 64 20 6c 6f 67 20 61 6e 64 20 73   ahead log and s
9f60: 68 61 72 65 64 20 6d 65 6d 6f 72 79 20 66 69 6c  hared memory fil
9f70: 65 73 20 75 73 65 64 20 66 6f 72 20 74 72 61 6e  es used for tran
9f80: 73 61 63 74 69 6f 6e 20 63 6f 6e 74 72 6f 6c 0a  saction control.
9f90: 2a 2a 20 61 72 65 20 61 75 74 6f 6d 61 74 69 63  ** are automatic
9fa0: 61 6c 6c 79 20 64 65 6c 65 74 65 64 20 77 68 65  ally deleted whe
9fb0: 6e 20 74 68 65 20 6c 61 74 65 73 74 20 63 6f 6e  n the latest con
9fc0: 6e 65 63 74 69 6f 6e 20 74 6f 20 74 68 65 20 64  nection to the d
9fd0: 61 74 61 62 61 73 65 0a 2a 2a 20 63 6c 6f 73 65  atabase.** close
9fe0: 73 2e 20 20 53 65 74 74 69 6e 67 20 70 65 72 73  s.  Setting pers
9ff0: 69 73 74 65 6e 74 20 57 41 4c 20 6d 6f 64 65 20  istent WAL mode 
a000: 63 61 75 73 65 73 20 74 68 6f 73 65 20 66 69 6c  causes those fil
a010: 65 73 20 74 6f 20 70 65 72 73 69 73 74 20 61 66  es to persist af
a020: 74 65 72 0a 2a 2a 20 63 6c 6f 73 65 2e 20 20 50  ter.** close.  P
a030: 65 72 73 69 73 74 69 6e 67 20 74 68 65 20 66 69  ersisting the fi
a040: 6c 65 73 20 69 73 20 75 73 65 66 75 6c 20 77 68  les is useful wh
a050: 65 6e 20 6f 74 68 65 72 20 70 72 6f 63 65 73 73  en other process
a060: 65 73 20 74 68 61 74 20 64 6f 20 6e 6f 74 0a 2a  es that do not.*
a070: 2a 20 68 61 76 65 20 77 72 69 74 65 20 70 65 72  * have write per
a080: 6d 69 73 73 69 6f 6e 20 6f 6e 20 74 68 65 20 64  mission on the d
a090: 69 72 65 63 74 6f 72 79 20 63 6f 6e 74 61 69 6e  irectory contain
a0a0: 69 6e 67 20 74 68 65 20 64 61 74 61 62 61 73 65  ing the database
a0b0: 20 66 69 6c 65 20 77 61 6e 74 0a 2a 2a 20 74 6f   file want.** to
a0c0: 20 72 65 61 64 20 74 68 65 20 64 61 74 61 62 61   read the databa
a0d0: 73 65 20 66 69 6c 65 2c 20 61 73 20 74 68 65 20  se file, as the 
a0e0: 57 41 4c 20 61 6e 64 20 73 68 61 72 65 64 20 6d  WAL and shared m
a0f0: 65 6d 6f 72 79 20 66 69 6c 65 73 20 6d 75 73 74  emory files must
a100: 20 65 78 69 73 74 0a 2a 2a 20 69 6e 20 6f 72 64   exist.** in ord
a110: 65 72 20 66 6f 72 20 74 68 65 20 64 61 74 61 62  er for the datab
a120: 61 73 65 20 74 6f 20 62 65 20 72 65 61 64 61 62  ase to be readab
a130: 6c 65 2e 20 20 54 68 65 20 66 6f 75 72 74 68 20  le.  The fourth 
a140: 70 61 72 61 6d 65 74 65 72 20 74 6f 0a 2a 2a 20  parameter to.** 
a150: 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5f 63 6f  [sqlite3_file_co
a160: 6e 74 72 6f 6c 28 29 5d 20 66 6f 72 20 74 68 69  ntrol()] for thi
a170: 73 20 6f 70 63 6f 64 65 20 73 68 6f 75 6c 64 20  s opcode should 
a180: 62 65 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20  be a pointer to 
a190: 61 6e 20 69 6e 74 65 67 65 72 2e 0a 2a 2a 20 54  an integer..** T
a1a0: 68 61 74 20 69 6e 74 65 67 65 72 20 69 73 20 30  hat integer is 0
a1b0: 20 74 6f 20 64 69 73 61 62 6c 65 20 70 65 72 73   to disable pers
a1c0: 69 73 74 65 6e 74 20 57 41 4c 20 6d 6f 64 65 20  istent WAL mode 
a1d0: 6f 72 20 31 20 74 6f 20 65 6e 61 62 6c 65 20 70  or 1 to enable p
a1e0: 65 72 73 69 73 74 65 6e 74 0a 2a 2a 20 57 41 4c  ersistent.** WAL
a1f0: 20 6d 6f 64 65 2e 20 20 49 66 20 74 68 65 20 69   mode.  If the i
a200: 6e 74 65 67 65 72 20 69 73 20 2d 31 2c 20 74 68  nteger is -1, th
a210: 65 6e 20 69 74 20 69 73 20 6f 76 65 72 77 72 69  en it is overwri
a220: 74 74 65 6e 20 77 69 74 68 20 74 68 65 20 63 75  tten with the cu
a230: 72 72 65 6e 74 0a 2a 2a 20 57 41 4c 20 70 65 72  rrent.** WAL per
a240: 73 69 73 74 65 6e 63 65 20 73 65 74 74 69 6e 67  sistence setting
a250: 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51  ..**.** <li>[[SQ
a260: 4c 49 54 45 5f 46 43 4e 54 4c 5f 50 4f 57 45 52  LITE_FCNTL_POWER
a270: 53 41 46 45 5f 4f 56 45 52 57 52 49 54 45 5d 5d  SAFE_OVERWRITE]]
a280: 0a 2a 2a 20 5e 54 68 65 20 5b 53 51 4c 49 54 45  .** ^The [SQLITE
a290: 5f 46 43 4e 54 4c 5f 50 4f 57 45 52 53 41 46 45  _FCNTL_POWERSAFE
a2a0: 5f 4f 56 45 52 57 52 49 54 45 5d 20 6f 70 63 6f  _OVERWRITE] opco
a2b0: 64 65 20 69 73 20 75 73 65 64 20 74 6f 20 73 65  de is used to se
a2c0: 74 20 6f 72 20 71 75 65 72 79 20 74 68 65 0a 2a  t or query the.*
a2d0: 2a 20 70 65 72 73 69 73 74 65 6e 74 20 22 70 6f  * persistent "po
a2e0: 77 65 72 73 61 66 65 2d 6f 76 65 72 77 72 69 74  wersafe-overwrit
a2f0: 65 22 20 6f 72 20 22 50 53 4f 57 22 20 73 65 74  e" or "PSOW" set
a300: 74 69 6e 67 2e 20 20 54 68 65 20 50 53 4f 57 20  ting.  The PSOW 
a310: 73 65 74 74 69 6e 67 0a 2a 2a 20 64 65 74 65 72  setting.** deter
a320: 6d 69 6e 65 73 20 74 68 65 20 5b 53 51 4c 49 54  mines the [SQLIT
a330: 45 5f 49 4f 43 41 50 5f 50 4f 57 45 52 53 41 46  E_IOCAP_POWERSAF
a340: 45 5f 4f 56 45 52 57 52 49 54 45 5d 20 62 69 74  E_OVERWRITE] bit
a350: 20 6f 66 20 74 68 65 0a 2a 2a 20 78 44 65 76 69   of the.** xDevi
a360: 63 65 43 68 61 72 61 63 74 65 72 69 73 74 69 63  ceCharacteristic
a370: 73 20 6d 65 74 68 6f 64 73 2e 20 54 68 65 20 66  s methods. The f
a380: 6f 75 72 74 68 20 70 61 72 61 6d 65 74 65 72 20  ourth parameter 
a390: 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 66  to.** [sqlite3_f
a3a0: 69 6c 65 5f 63 6f 6e 74 72 6f 6c 28 29 5d 20 66  ile_control()] f
a3b0: 6f 72 20 74 68 69 73 20 6f 70 63 6f 64 65 20 73  or this opcode s
a3c0: 68 6f 75 6c 64 20 62 65 20 61 20 70 6f 69 6e 74  hould be a point
a3d0: 65 72 20 74 6f 20 61 6e 20 69 6e 74 65 67 65 72  er to an integer
a3e0: 2e 0a 2a 2a 20 54 68 61 74 20 69 6e 74 65 67 65  ..** That intege
a3f0: 72 20 69 73 20 30 20 74 6f 20 64 69 73 61 62 6c  r is 0 to disabl
a400: 65 20 7a 65 72 6f 2d 64 61 6d 61 67 65 20 6d 6f  e zero-damage mo
a410: 64 65 20 6f 72 20 31 20 74 6f 20 65 6e 61 62 6c  de or 1 to enabl
a420: 65 20 7a 65 72 6f 2d 64 61 6d 61 67 65 0a 2a 2a  e zero-damage.**
a430: 20 6d 6f 64 65 2e 20 20 49 66 20 74 68 65 20 69   mode.  If the i
a440: 6e 74 65 67 65 72 20 69 73 20 2d 31 2c 20 74 68  nteger is -1, th
a450: 65 6e 20 69 74 20 69 73 20 6f 76 65 72 77 72 69  en it is overwri
a460: 74 74 65 6e 20 77 69 74 68 20 74 68 65 20 63 75  tten with the cu
a470: 72 72 65 6e 74 0a 2a 2a 20 7a 65 72 6f 2d 64 61  rrent.** zero-da
a480: 6d 61 67 65 20 6d 6f 64 65 20 73 65 74 74 69 6e  mage mode settin
a490: 67 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53  g..**.** <li>[[S
a4a0: 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 4f 56 45 52  QLITE_FCNTL_OVER
a4b0: 57 52 49 54 45 5d 5d 0a 2a 2a 20 5e 54 68 65 20  WRITE]].** ^The 
a4c0: 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 4f 56  [SQLITE_FCNTL_OV
a4d0: 45 52 57 52 49 54 45 5d 20 6f 70 63 6f 64 65 20  ERWRITE] opcode 
a4e0: 69 73 20 69 6e 76 6f 6b 65 64 20 62 79 20 53 51  is invoked by SQ
a4f0: 4c 69 74 65 20 61 66 74 65 72 20 6f 70 65 6e 69  Lite after openi
a500: 6e 67 0a 2a 2a 20 61 20 77 72 69 74 65 20 74 72  ng.** a write tr
a510: 61 6e 73 61 63 74 69 6f 6e 20 74 6f 20 69 6e 64  ansaction to ind
a520: 69 63 61 74 65 20 74 68 61 74 2c 20 75 6e 6c 65  icate that, unle
a530: 73 73 20 69 74 20 69 73 20 72 6f 6c 6c 65 64 20  ss it is rolled 
a540: 62 61 63 6b 20 66 6f 72 20 73 6f 6d 65 0a 2a 2a  back for some.**
a550: 20 72 65 61 73 6f 6e 2c 20 74 68 65 20 65 6e 74   reason, the ent
a560: 69 72 65 20 64 61 74 61 62 61 73 65 20 66 69 6c  ire database fil
a570: 65 20 77 69 6c 6c 20 62 65 20 6f 76 65 72 77 72  e will be overwr
a580: 69 74 74 65 6e 20 62 79 20 74 68 65 20 63 75 72  itten by the cur
a590: 72 65 6e 74 20 0a 2a 2a 20 74 72 61 6e 73 61 63  rent .** transac
a5a0: 74 69 6f 6e 2e 20 54 68 69 73 20 69 73 20 75 73  tion. This is us
a5b0: 65 64 20 62 79 20 56 41 43 55 55 4d 20 6f 70 65  ed by VACUUM ope
a5c0: 72 61 74 69 6f 6e 73 2e 0a 2a 2a 0a 2a 2a 20 3c  rations..**.** <
a5d0: 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54  li>[[SQLITE_FCNT
a5e0: 4c 5f 56 46 53 4e 41 4d 45 5d 5d 0a 2a 2a 20 5e  L_VFSNAME]].** ^
a5f0: 54 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54  The [SQLITE_FCNT
a600: 4c 5f 56 46 53 4e 41 4d 45 5d 20 6f 70 63 6f 64  L_VFSNAME] opcod
a610: 65 20 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f  e can be used to
a620: 20 6f 62 74 61 69 6e 20 74 68 65 20 6e 61 6d 65   obtain the name
a630: 73 20 6f 66 0a 2a 2a 20 61 6c 6c 20 5b 56 46 53  s of.** all [VFS
a640: 65 73 5d 20 69 6e 20 74 68 65 20 56 46 53 20 73  es] in the VFS s
a650: 74 61 63 6b 2e 20 20 54 68 65 20 6e 61 6d 65 73  tack.  The names
a660: 20 61 72 65 20 6f 66 20 61 6c 6c 20 56 46 53 20   are of all VFS 
a670: 73 68 69 6d 73 20 61 6e 64 20 74 68 65 0a 2a 2a  shims and the.**
a680: 20 66 69 6e 61 6c 20 62 6f 74 74 6f 6d 2d 6c 65   final bottom-le
a690: 76 65 6c 20 56 46 53 20 61 72 65 20 77 72 69 74  vel VFS are writ
a6a0: 74 65 6e 20 69 6e 74 6f 20 6d 65 6d 6f 72 79 20  ten into memory 
a6b0: 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 0a 2a  obtained from .*
a6c0: 2a 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f  * [sqlite3_mallo
a6d0: 63 28 29 5d 20 61 6e 64 20 74 68 65 20 72 65 73  c()] and the res
a6e0: 75 6c 74 20 69 73 20 73 74 6f 72 65 64 20 69 6e  ult is stored in
a6f0: 20 74 68 65 20 63 68 61 72 2a 20 76 61 72 69 61   the char* varia
a700: 62 6c 65 0a 2a 2a 20 74 68 61 74 20 74 68 65 20  ble.** that the 
a710: 66 6f 75 72 74 68 20 70 61 72 61 6d 65 74 65 72  fourth parameter
a720: 20 6f 66 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c   of [sqlite3_fil
a730: 65 5f 63 6f 6e 74 72 6f 6c 28 29 5d 20 70 6f 69  e_control()] poi
a740: 6e 74 73 20 74 6f 2e 0a 2a 2a 20 54 68 65 20 63  nts to..** The c
a750: 61 6c 6c 65 72 20 69 73 20 72 65 73 70 6f 6e 73  aller is respons
a760: 69 62 6c 65 20 66 6f 72 20 66 72 65 65 69 6e 67  ible for freeing
a770: 20 74 68 65 20 6d 65 6d 6f 72 79 20 77 68 65 6e   the memory when
a780: 20 64 6f 6e 65 2e 20 20 41 73 20 77 69 74 68 0a   done.  As with.
a790: 2a 2a 20 61 6c 6c 20 66 69 6c 65 2d 63 6f 6e 74  ** all file-cont
a7a0: 72 6f 6c 20 61 63 74 69 6f 6e 73 2c 20 74 68 65  rol actions, the
a7b0: 72 65 20 69 73 20 6e 6f 20 67 75 61 72 61 6e 74  re is no guarant
a7c0: 65 65 20 74 68 61 74 20 74 68 69 73 20 77 69 6c  ee that this wil
a7d0: 6c 20 61 63 74 75 61 6c 6c 79 0a 2a 2a 20 64 6f  l actually.** do
a7e0: 20 61 6e 79 74 68 69 6e 67 2e 20 20 43 61 6c 6c   anything.  Call
a7f0: 65 72 73 20 73 68 6f 75 6c 64 20 69 6e 69 74 69  ers should initi
a800: 61 6c 69 7a 65 20 74 68 65 20 63 68 61 72 2a 20  alize the char* 
a810: 76 61 72 69 61 62 6c 65 20 74 6f 20 61 20 4e 55  variable to a NU
a820: 4c 4c 0a 2a 2a 20 70 6f 69 6e 74 65 72 20 69 6e  LL.** pointer in
a830: 20 63 61 73 65 20 74 68 69 73 20 66 69 6c 65 2d   case this file-
a840: 63 6f 6e 74 72 6f 6c 20 69 73 20 6e 6f 74 20 69  control is not i
a850: 6d 70 6c 65 6d 65 6e 74 65 64 2e 20 20 54 68 69  mplemented.  Thi
a860: 73 20 66 69 6c 65 2d 63 6f 6e 74 72 6f 6c 0a 2a  s file-control.*
a870: 2a 20 69 73 20 69 6e 74 65 6e 64 65 64 20 66 6f  * is intended fo
a880: 72 20 64 69 61 67 6e 6f 73 74 69 63 20 75 73 65  r diagnostic use
a890: 20 6f 6e 6c 79 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69   only..**.** <li
a8a0: 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  >[[SQLITE_FCNTL_
a8b0: 56 46 53 5f 50 4f 49 4e 54 45 52 5d 5d 0a 2a 2a  VFS_POINTER]].**
a8c0: 20 5e 54 68 65 20 5b 53 51 4c 49 54 45 5f 46 43   ^The [SQLITE_FC
a8d0: 4e 54 4c 5f 56 46 53 5f 50 4f 49 4e 54 45 52 5d  NTL_VFS_POINTER]
a8e0: 20 6f 70 63 6f 64 65 20 66 69 6e 64 73 20 61 20   opcode finds a 
a8f0: 70 6f 69 6e 74 65 72 20 74 6f 20 74 68 65 20 74  pointer to the t
a900: 6f 70 2d 6c 65 76 65 6c 0a 2a 2a 20 5b 56 46 53  op-level.** [VFS
a910: 65 73 5d 20 63 75 72 72 65 6e 74 6c 79 20 69 6e  es] currently in
a920: 20 75 73 65 2e 20 20 5e 28 54 68 65 20 61 72 67   use.  ^(The arg
a930: 75 6d 65 6e 74 20 58 20 69 6e 0a 2a 2a 20 73 71  ument X in.** sq
a940: 6c 69 74 65 33 5f 66 69 6c 65 5f 63 6f 6e 74 72  lite3_file_contr
a950: 6f 6c 28 64 62 2c 53 51 4c 49 54 45 5f 46 43 4e  ol(db,SQLITE_FCN
a960: 54 4c 5f 56 46 53 5f 50 4f 49 4e 54 45 52 2c 58  TL_VFS_POINTER,X
a970: 29 20 6d 75 73 74 20 62 65 0a 2a 2a 20 6f 66 20  ) must be.** of 
a980: 74 79 70 65 20 22 5b 73 71 6c 69 74 65 33 5f 76  type "[sqlite3_v
a990: 66 73 5d 20 2a 2a 22 2e 20 20 54 68 69 73 20 6f  fs] **".  This o
a9a0: 70 63 6f 64 65 73 20 77 69 6c 6c 20 73 65 74 20  pcodes will set 
a9b0: 2a 58 0a 2a 2a 20 74 6f 20 61 20 70 6f 69 6e 74  *X.** to a point
a9c0: 65 72 20 74 6f 20 74 68 65 20 74 6f 70 2d 6c 65  er to the top-le
a9d0: 76 65 6c 20 56 46 53 2e 29 5e 0a 2a 2a 20 5e 57  vel VFS.)^.** ^W
a9e0: 68 65 6e 20 74 68 65 72 65 20 61 72 65 20 6d 75  hen there are mu
a9f0: 6c 74 69 70 6c 65 20 56 46 53 20 73 68 69 6d 73  ltiple VFS shims
aa00: 20 69 6e 20 74 68 65 20 73 74 61 63 6b 2c 20 74   in the stack, t
aa10: 68 69 73 20 6f 70 63 6f 64 65 20 66 69 6e 64 73  his opcode finds
aa20: 20 74 68 65 0a 2a 2a 20 75 70 70 65 72 2d 6d 6f   the.** upper-mo
aa30: 73 74 20 73 68 69 6d 20 6f 6e 6c 79 2e 0a 2a 2a  st shim only..**
aa40: 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45  .** <li>[[SQLITE
aa50: 5f 46 43 4e 54 4c 5f 50 52 41 47 4d 41 5d 5d 0a  _FCNTL_PRAGMA]].
aa60: 2a 2a 20 5e 57 68 65 6e 65 76 65 72 20 61 20 5b  ** ^Whenever a [
aa70: 50 52 41 47 4d 41 5d 20 73 74 61 74 65 6d 65 6e  PRAGMA] statemen
aa80: 74 20 69 73 20 70 61 72 73 65 64 2c 20 61 6e 20  t is parsed, an 
aa90: 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 50 52  [SQLITE_FCNTL_PR
aaa0: 41 47 4d 41 5d 20 0a 2a 2a 20 66 69 6c 65 20 63  AGMA] .** file c
aab0: 6f 6e 74 72 6f 6c 20 69 73 20 73 65 6e 74 20 74  ontrol is sent t
aac0: 6f 20 74 68 65 20 6f 70 65 6e 20 5b 73 71 6c 69  o the open [sqli
aad0: 74 65 33 5f 66 69 6c 65 5d 20 6f 62 6a 65 63 74  te3_file] object
aae0: 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 0a 2a   corresponding.*
aaf0: 2a 20 74 6f 20 74 68 65 20 64 61 74 61 62 61 73  * to the databas
ab00: 65 20 66 69 6c 65 20 74 6f 20 77 68 69 63 68 20  e file to which 
ab10: 74 68 65 20 70 72 61 67 6d 61 20 73 74 61 74 65  the pragma state
ab20: 6d 65 6e 74 20 72 65 66 65 72 73 2e 20 5e 54 68  ment refers. ^Th
ab30: 65 20 61 72 67 75 6d 65 6e 74 0a 2a 2a 20 74 6f  e argument.** to
ab40: 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e   the [SQLITE_FCN
ab50: 54 4c 5f 50 52 41 47 4d 41 5d 20 66 69 6c 65 20  TL_PRAGMA] file 
ab60: 63 6f 6e 74 72 6f 6c 20 69 73 20 61 6e 20 61 72  control is an ar
ab70: 72 61 79 20 6f 66 0a 2a 2a 20 70 6f 69 6e 74 65  ray of.** pointe
ab80: 72 73 20 74 6f 20 73 74 72 69 6e 67 73 20 28 63  rs to strings (c
ab90: 68 61 72 2a 2a 29 20 69 6e 20 77 68 69 63 68 20  har**) in which 
aba0: 74 68 65 20 73 65 63 6f 6e 64 20 65 6c 65 6d 65  the second eleme
abb0: 6e 74 20 6f 66 20 74 68 65 20 61 72 72 61 79 0a  nt of the array.
abc0: 2a 2a 20 69 73 20 74 68 65 20 6e 61 6d 65 20 6f  ** is the name o
abd0: 66 20 74 68 65 20 70 72 61 67 6d 61 20 61 6e 64  f the pragma and
abe0: 20 74 68 65 20 74 68 69 72 64 20 65 6c 65 6d 65   the third eleme
abf0: 6e 74 20 69 73 20 74 68 65 20 61 72 67 75 6d 65  nt is the argume
ac00: 6e 74 20 74 6f 20 74 68 65 0a 2a 2a 20 70 72 61  nt to the.** pra
ac10: 67 6d 61 20 6f 72 20 4e 55 4c 4c 20 69 66 20 74  gma or NULL if t
ac20: 68 65 20 70 72 61 67 6d 61 20 68 61 73 20 6e 6f  he pragma has no
ac30: 20 61 72 67 75 6d 65 6e 74 2e 20 20 5e 54 68 65   argument.  ^The
ac40: 20 68 61 6e 64 6c 65 72 20 66 6f 72 20 61 6e 0a   handler for an.
ac50: 2a 2a 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  ** [SQLITE_FCNTL
ac60: 5f 50 52 41 47 4d 41 5d 20 66 69 6c 65 20 63 6f  _PRAGMA] file co
ac70: 6e 74 72 6f 6c 20 63 61 6e 20 6f 70 74 69 6f 6e  ntrol can option
ac80: 61 6c 6c 79 20 6d 61 6b 65 20 74 68 65 20 66 69  ally make the fi
ac90: 72 73 74 20 65 6c 65 6d 65 6e 74 0a 2a 2a 20 6f  rst element.** o
aca0: 66 20 74 68 65 20 63 68 61 72 2a 2a 20 61 72 67  f the char** arg
acb0: 75 6d 65 6e 74 20 70 6f 69 6e 74 20 74 6f 20 61  ument point to a
acc0: 20 73 74 72 69 6e 67 20 6f 62 74 61 69 6e 65 64   string obtained
acd0: 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 6d   from [sqlite3_m
ace0: 70 72 69 6e 74 66 28 29 5d 0a 2a 2a 20 6f 72 20  printf()].** or 
acf0: 74 68 65 20 65 71 75 69 76 61 6c 65 6e 74 20 61  the equivalent a
ad00: 6e 64 20 74 68 61 74 20 73 74 72 69 6e 67 20 77  nd that string w
ad10: 69 6c 6c 20 62 65 63 6f 6d 65 20 74 68 65 20 72  ill become the r
ad20: 65 73 75 6c 74 20 6f 66 20 74 68 65 20 70 72 61  esult of the pra
ad30: 67 6d 61 20 6f 72 0a 2a 2a 20 74 68 65 20 65 72  gma or.** the er
ad40: 72 6f 72 20 6d 65 73 73 61 67 65 20 69 66 20 74  ror message if t
ad50: 68 65 20 70 72 61 67 6d 61 20 66 61 69 6c 73 2e  he pragma fails.
ad60: 20 5e 49 66 20 74 68 65 0a 2a 2a 20 5b 53 51 4c   ^If the.** [SQL
ad70: 49 54 45 5f 46 43 4e 54 4c 5f 50 52 41 47 4d 41  ITE_FCNTL_PRAGMA
ad80: 5d 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 72  ] file control r
ad90: 65 74 75 72 6e 73 20 5b 53 51 4c 49 54 45 5f 4e  eturns [SQLITE_N
ada0: 4f 54 46 4f 55 4e 44 5d 2c 20 74 68 65 6e 20 6e  OTFOUND], then n
adb0: 6f 72 6d 61 6c 20 0a 2a 2a 20 5b 50 52 41 47 4d  ormal .** [PRAGM
adc0: 41 5d 20 70 72 6f 63 65 73 73 69 6e 67 20 63 6f  A] processing co
add0: 6e 74 69 6e 75 65 73 2e 20 20 5e 49 66 20 74 68  ntinues.  ^If th
ade0: 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  e [SQLITE_FCNTL_
adf0: 50 52 41 47 4d 41 5d 0a 2a 2a 20 66 69 6c 65 20  PRAGMA].** file 
ae00: 63 6f 6e 74 72 6f 6c 20 72 65 74 75 72 6e 73 20  control returns 
ae10: 5b 53 51 4c 49 54 45 5f 4f 4b 5d 2c 20 74 68 65  [SQLITE_OK], the
ae20: 6e 20 74 68 65 20 70 61 72 73 65 72 20 61 73 73  n the parser ass
ae30: 75 6d 65 73 20 74 68 61 74 20 74 68 65 0a 2a 2a  umes that the.**
ae40: 20 56 46 53 20 68 61 73 20 68 61 6e 64 6c 65 64   VFS has handled
ae50: 20 74 68 65 20 50 52 41 47 4d 41 20 69 74 73 65   the PRAGMA itse
ae60: 6c 66 20 61 6e 64 20 74 68 65 20 70 61 72 73 65  lf and the parse
ae70: 72 20 67 65 6e 65 72 61 74 65 73 20 61 20 6e 6f  r generates a no
ae80: 2d 6f 70 0a 2a 2a 20 70 72 65 70 61 72 65 64 20  -op.** prepared 
ae90: 73 74 61 74 65 6d 65 6e 74 20 69 66 20 72 65 73  statement if res
aea0: 75 6c 74 20 73 74 72 69 6e 67 20 69 73 20 4e 55  ult string is NU
aeb0: 4c 4c 2c 20 6f 72 20 74 68 61 74 20 72 65 74 75  LL, or that retu
aec0: 72 6e 73 20 61 20 63 6f 70 79 0a 2a 2a 20 6f 66  rns a copy.** of
aed0: 20 74 68 65 20 72 65 73 75 6c 74 20 73 74 72 69   the result stri
aee0: 6e 67 20 69 66 20 74 68 65 20 73 74 72 69 6e 67  ng if the string
aef0: 20 69 73 20 6e 6f 6e 2d 4e 55 4c 4c 2e 0a 2a 2a   is non-NULL..**
af00: 20 5e 49 66 20 74 68 65 20 5b 53 51 4c 49 54 45   ^If the [SQLITE
af10: 5f 46 43 4e 54 4c 5f 50 52 41 47 4d 41 5d 20 66  _FCNTL_PRAGMA] f
af20: 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 72 65 74 75  ile control retu
af30: 72 6e 73 0a 2a 2a 20 61 6e 79 20 72 65 73 75 6c  rns.** any resul
af40: 74 20 63 6f 64 65 20 6f 74 68 65 72 20 74 68 61  t code other tha
af50: 6e 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 6f 72  n [SQLITE_OK] or
af60: 20 5b 53 51 4c 49 54 45 5f 4e 4f 54 46 4f 55 4e   [SQLITE_NOTFOUN
af70: 44 5d 2c 20 74 68 61 74 20 6d 65 61 6e 73 0a 2a  D], that means.*
af80: 2a 20 74 68 61 74 20 74 68 65 20 56 46 53 20 65  * that the VFS e
af90: 6e 63 6f 75 6e 74 65 72 65 64 20 61 6e 20 65 72  ncountered an er
afa0: 72 6f 72 20 77 68 69 6c 65 20 68 61 6e 64 6c 69  ror while handli
afb0: 6e 67 20 74 68 65 20 5b 50 52 41 47 4d 41 5d 20  ng the [PRAGMA] 
afc0: 61 6e 64 20 74 68 65 0a 2a 2a 20 63 6f 6d 70 69  and the.** compi
afd0: 6c 61 74 69 6f 6e 20 6f 66 20 74 68 65 20 50 52  lation of the PR
afe0: 41 47 4d 41 20 66 61 69 6c 73 20 77 69 74 68 20  AGMA fails with 
aff0: 61 6e 20 65 72 72 6f 72 2e 20 20 5e 54 68 65 20  an error.  ^The 
b000: 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 50 52  [SQLITE_FCNTL_PR
b010: 41 47 4d 41 5d 0a 2a 2a 20 66 69 6c 65 20 63 6f  AGMA].** file co
b020: 6e 74 72 6f 6c 20 6f 63 63 75 72 73 20 61 74 20  ntrol occurs at 
b030: 74 68 65 20 62 65 67 69 6e 6e 69 6e 67 20 6f 66  the beginning of
b040: 20 70 72 61 67 6d 61 20 73 74 61 74 65 6d 65 6e   pragma statemen
b050: 74 20 61 6e 61 6c 79 73 69 73 20 61 6e 64 20 73  t analysis and s
b060: 6f 0a 2a 2a 20 69 74 20 69 73 20 61 62 6c 65 20  o.** it is able 
b070: 74 6f 20 6f 76 65 72 72 69 64 65 20 62 75 69 6c  to override buil
b080: 74 2d 69 6e 20 5b 50 52 41 47 4d 41 5d 20 73 74  t-in [PRAGMA] st
b090: 61 74 65 6d 65 6e 74 73 2e 0a 2a 2a 0a 2a 2a 20  atements..**.** 
b0a0: 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e  <li>[[SQLITE_FCN
b0b0: 54 4c 5f 42 55 53 59 48 41 4e 44 4c 45 52 5d 5d  TL_BUSYHANDLER]]
b0c0: 0a 2a 2a 20 5e 54 68 65 20 5b 53 51 4c 49 54 45  .** ^The [SQLITE
b0d0: 5f 46 43 4e 54 4c 5f 42 55 53 59 48 41 4e 44 4c  _FCNTL_BUSYHANDL
b0e0: 45 52 5d 0a 2a 2a 20 66 69 6c 65 2d 63 6f 6e 74  ER].** file-cont
b0f0: 72 6f 6c 20 6d 61 79 20 62 65 20 69 6e 76 6f 6b  rol may be invok
b100: 65 64 20 62 79 20 53 51 4c 69 74 65 20 6f 6e 20  ed by SQLite on 
b110: 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c  the database fil
b120: 65 20 68 61 6e 64 6c 65 0a 2a 2a 20 73 68 6f 72  e handle.** shor
b130: 74 6c 79 20 61 66 74 65 72 20 69 74 20 69 73 20  tly after it is 
b140: 6f 70 65 6e 65 64 20 69 6e 20 6f 72 64 65 72 20  opened in order 
b150: 74 6f 20 70 72 6f 76 69 64 65 20 61 20 63 75 73  to provide a cus
b160: 74 6f 6d 20 56 46 53 20 77 69 74 68 20 61 63 63  tom VFS with acc
b170: 65 73 73 0a 2a 2a 20 74 6f 20 74 68 65 20 63 6f  ess.** to the co
b180: 6e 6e 65 63 74 69 6f 6e 73 20 62 75 73 79 2d 68  nnections busy-h
b190: 61 6e 64 6c 65 72 20 63 61 6c 6c 62 61 63 6b 2e  andler callback.
b1a0: 20 54 68 65 20 61 72 67 75 6d 65 6e 74 20 69 73   The argument is
b1b0: 20 6f 66 20 74 79 70 65 20 28 76 6f 69 64 20 2a   of type (void *
b1c0: 2a 29 0a 2a 2a 20 2d 20 61 6e 20 61 72 72 61 79  *).** - an array
b1d0: 20 6f 66 20 74 77 6f 20 28 76 6f 69 64 20 2a 29   of two (void *)
b1e0: 20 76 61 6c 75 65 73 2e 20 54 68 65 20 66 69 72   values. The fir
b1f0: 73 74 20 28 76 6f 69 64 20 2a 29 20 61 63 74 75  st (void *) actu
b200: 61 6c 6c 79 20 70 6f 69 6e 74 73 0a 2a 2a 20 74  ally points.** t
b210: 6f 20 61 20 66 75 6e 63 74 69 6f 6e 20 6f 66 20  o a function of 
b220: 74 79 70 65 20 28 69 6e 74 20 28 2a 29 28 76 6f  type (int (*)(vo
b230: 69 64 20 2a 29 29 2e 20 49 6e 20 6f 72 64 65 72  id *)). In order
b240: 20 74 6f 20 69 6e 76 6f 6b 65 20 74 68 65 20 63   to invoke the c
b250: 6f 6e 6e 65 63 74 69 6f 6e 73 0a 2a 2a 20 62 75  onnections.** bu
b260: 73 79 2d 68 61 6e 64 6c 65 72 2c 20 74 68 69 73  sy-handler, this
b270: 20 66 75 6e 63 74 69 6f 6e 20 73 68 6f 75 6c 64   function should
b280: 20 62 65 20 69 6e 76 6f 6b 65 64 20 77 69 74 68   be invoked with
b290: 20 74 68 65 20 73 65 63 6f 6e 64 20 28 76 6f 69   the second (voi
b2a0: 64 20 2a 29 20 69 6e 0a 2a 2a 20 74 68 65 20 61  d *) in.** the a
b2b0: 72 72 61 79 20 61 73 20 74 68 65 20 6f 6e 6c 79  rray as the only
b2c0: 20 61 72 67 75 6d 65 6e 74 2e 20 49 66 20 69 74   argument. If it
b2d0: 20 72 65 74 75 72 6e 73 20 6e 6f 6e 2d 7a 65 72   returns non-zer
b2e0: 6f 2c 20 74 68 65 6e 20 74 68 65 20 6f 70 65 72  o, then the oper
b2f0: 61 74 69 6f 6e 0a 2a 2a 20 73 68 6f 75 6c 64 20  ation.** should 
b300: 62 65 20 72 65 74 72 69 65 64 2e 20 49 66 20 69  be retried. If i
b310: 74 20 72 65 74 75 72 6e 73 20 7a 65 72 6f 2c 20  t returns zero, 
b320: 74 68 65 20 63 75 73 74 6f 6d 20 56 46 53 20 73  the custom VFS s
b330: 68 6f 75 6c 64 20 61 62 61 6e 64 6f 6e 20 74 68  hould abandon th
b340: 65 0a 2a 2a 20 63 75 72 72 65 6e 74 20 6f 70 65  e.** current ope
b350: 72 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 3c 6c  ration..**.** <l
b360: 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  i>[[SQLITE_FCNTL
b370: 5f 54 45 4d 50 46 49 4c 45 4e 41 4d 45 5d 5d 0a  _TEMPFILENAME]].
b380: 2a 2a 20 5e 41 70 70 6c 69 63 61 74 69 6f 6e 20  ** ^Application 
b390: 63 61 6e 20 69 6e 76 6f 6b 65 20 74 68 65 20 5b  can invoke the [
b3a0: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 54 45 4d  SQLITE_FCNTL_TEM
b3b0: 50 46 49 4c 45 4e 41 4d 45 5d 20 66 69 6c 65 2d  PFILENAME] file-
b3c0: 63 6f 6e 74 72 6f 6c 0a 2a 2a 20 74 6f 20 68 61  control.** to ha
b3d0: 76 65 20 53 51 4c 69 74 65 20 67 65 6e 65 72 61  ve SQLite genera
b3e0: 74 65 20 61 0a 2a 2a 20 74 65 6d 70 6f 72 61 72  te a.** temporar
b3f0: 79 20 66 69 6c 65 6e 61 6d 65 20 75 73 69 6e 67  y filename using
b400: 20 74 68 65 20 73 61 6d 65 20 61 6c 67 6f 72 69   the same algori
b410: 74 68 6d 20 74 68 61 74 20 69 73 20 66 6f 6c 6c  thm that is foll
b420: 6f 77 65 64 20 74 6f 20 67 65 6e 65 72 61 74 65  owed to generate
b430: 0a 2a 2a 20 74 65 6d 70 6f 72 61 72 79 20 66 69  .** temporary fi
b440: 6c 65 6e 61 6d 65 73 20 66 6f 72 20 54 45 4d 50  lenames for TEMP
b450: 20 74 61 62 6c 65 73 20 61 6e 64 20 6f 74 68 65   tables and othe
b460: 72 20 69 6e 74 65 72 6e 61 6c 20 75 73 65 73 2e  r internal uses.
b470: 20 20 54 68 65 0a 2a 2a 20 61 72 67 75 6d 65 6e    The.** argumen
b480: 74 20 73 68 6f 75 6c 64 20 62 65 20 61 20 63 68  t should be a ch
b490: 61 72 2a 2a 20 77 68 69 63 68 20 77 69 6c 6c 20  ar** which will 
b4a0: 62 65 20 66 69 6c 6c 65 64 20 77 69 74 68 20 74  be filled with t
b4b0: 68 65 20 66 69 6c 65 6e 61 6d 65 0a 2a 2a 20 77  he filename.** w
b4c0: 72 69 74 74 65 6e 20 69 6e 74 6f 20 6d 65 6d 6f  ritten into memo
b4d0: 72 79 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d  ry obtained from
b4e0: 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63   [sqlite3_malloc
b4f0: 28 29 5d 2e 20 20 54 68 65 20 63 61 6c 6c 65 72  ()].  The caller
b500: 20 73 68 6f 75 6c 64 0a 2a 2a 20 69 6e 76 6f 6b   should.** invok
b510: 65 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 28  e [sqlite3_free(
b520: 29 5d 20 6f 6e 20 74 68 65 20 72 65 73 75 6c 74  )] on the result
b530: 20 74 6f 20 61 76 6f 69 64 20 61 20 6d 65 6d 6f   to avoid a memo
b540: 72 79 20 6c 65 61 6b 2e 0a 2a 2a 0a 2a 2a 20 3c  ry leak..**.** <
b550: 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54  li>[[SQLITE_FCNT
b560: 4c 5f 4d 4d 41 50 5f 53 49 5a 45 5d 5d 0a 2a 2a  L_MMAP_SIZE]].**
b570: 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e   The [SQLITE_FCN
b580: 54 4c 5f 4d 4d 41 50 5f 53 49 5a 45 5d 20 66 69  TL_MMAP_SIZE] fi
b590: 6c 65 20 63 6f 6e 74 72 6f 6c 20 69 73 20 75 73  le control is us
b5a0: 65 64 20 74 6f 20 71 75 65 72 79 20 6f 72 20 73  ed to query or s
b5b0: 65 74 20 74 68 65 0a 2a 2a 20 6d 61 78 69 6d 75  et the.** maximu
b5c0: 6d 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65  m number of byte
b5d0: 73 20 74 68 61 74 20 77 69 6c 6c 20 62 65 20 75  s that will be u
b5e0: 73 65 64 20 66 6f 72 20 6d 65 6d 6f 72 79 2d 6d  sed for memory-m
b5f0: 61 70 70 65 64 20 49 2f 4f 2e 0a 2a 2a 20 54 68  apped I/O..** Th
b600: 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 20  e argument is a 
b610: 70 6f 69 6e 74 65 72 20 74 6f 20 61 20 76 61 6c  pointer to a val
b620: 75 65 20 6f 66 20 74 79 70 65 20 73 71 6c 69 74  ue of type sqlit
b630: 65 33 5f 69 6e 74 36 34 20 74 68 61 74 0a 2a 2a  e3_int64 that.**
b640: 20 69 73 20 61 6e 20 61 64 76 69 73 6f 72 79 20   is an advisory 
b650: 6d 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f  maximum number o
b660: 66 20 62 79 74 65 73 20 69 6e 20 74 68 65 20 66  f bytes in the f
b670: 69 6c 65 20 74 6f 20 6d 65 6d 6f 72 79 20 6d 61  ile to memory ma
b680: 70 2e 20 20 54 68 65 0a 2a 2a 20 70 6f 69 6e 74  p.  The.** point
b690: 65 72 20 69 73 20 6f 76 65 72 77 72 69 74 74 65  er is overwritte
b6a0: 6e 20 77 69 74 68 20 74 68 65 20 6f 6c 64 20 76  n with the old v
b6b0: 61 6c 75 65 2e 20 20 54 68 65 20 6c 69 6d 69 74  alue.  The limit
b6c0: 20 69 73 20 6e 6f 74 20 63 68 61 6e 67 65 64 20   is not changed 
b6d0: 69 66 0a 2a 2a 20 74 68 65 20 76 61 6c 75 65 20  if.** the value 
b6e0: 6f 72 69 67 69 6e 61 6c 6c 79 20 70 6f 69 6e 74  originally point
b6f0: 65 64 20 74 6f 20 69 73 20 6e 65 67 61 74 69 76  ed to is negativ
b700: 65 2c 20 61 6e 64 20 73 6f 20 74 68 65 20 63 75  e, and so the cu
b710: 72 72 65 6e 74 20 6c 69 6d 69 74 20 0a 2a 2a 20  rrent limit .** 
b720: 63 61 6e 20 62 65 20 71 75 65 72 69 65 64 20 62  can be queried b
b730: 79 20 70 61 73 73 69 6e 67 20 69 6e 20 61 20 70  y passing in a p
b740: 6f 69 6e 74 65 72 20 74 6f 20 61 20 6e 65 67 61  ointer to a nega
b750: 74 69 76 65 20 6e 75 6d 62 65 72 2e 20 20 54 68  tive number.  Th
b760: 69 73 0a 2a 2a 20 66 69 6c 65 2d 63 6f 6e 74 72  is.** file-contr
b770: 6f 6c 20 69 73 20 75 73 65 64 20 69 6e 74 65 72  ol is used inter
b780: 6e 61 6c 6c 79 20 74 6f 20 69 6d 70 6c 65 6d 65  nally to impleme
b790: 6e 74 20 5b 50 52 41 47 4d 41 20 6d 6d 61 70 5f  nt [PRAGMA mmap_
b7a0: 73 69 7a 65 5d 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69  size]..**.** <li
b7b0: 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  >[[SQLITE_FCNTL_
b7c0: 54 52 41 43 45 5d 5d 0a 2a 2a 20 54 68 65 20 5b  TRACE]].** The [
b7d0: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 54 52 41  SQLITE_FCNTL_TRA
b7e0: 43 45 5d 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c  CE] file control
b7f0: 20 70 72 6f 76 69 64 65 73 20 61 64 76 69 73 6f   provides adviso
b800: 72 79 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 0a 2a  ry information.*
b810: 2a 20 74 6f 20 74 68 65 20 56 46 53 20 61 62 6f  * to the VFS abo
b820: 75 74 20 77 68 61 74 20 74 68 65 20 68 69 67 68  ut what the high
b830: 65 72 20 6c 61 79 65 72 73 20 6f 66 20 74 68 65  er layers of the
b840: 20 53 51 4c 69 74 65 20 73 74 61 63 6b 20 61 72   SQLite stack ar
b850: 65 20 64 6f 69 6e 67 2e 0a 2a 2a 20 54 68 69 73  e doing..** This
b860: 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 69 73   file control is
b870: 20 75 73 65 64 20 62 79 20 73 6f 6d 65 20 56 46   used by some VF
b880: 53 20 61 63 74 69 76 69 74 79 20 74 72 61 63 69  S activity traci
b890: 6e 67 20 5b 73 68 69 6d 73 5d 2e 0a 2a 2a 20 54  ng [shims]..** T
b8a0: 68 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61  he argument is a
b8b0: 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64   zero-terminated
b8c0: 20 73 74 72 69 6e 67 2e 20 20 48 69 67 68 65 72   string.  Higher
b8d0: 20 6c 61 79 65 72 73 20 69 6e 20 74 68 65 0a 2a   layers in the.*
b8e0: 2a 20 53 51 4c 69 74 65 20 73 74 61 63 6b 20 6d  * SQLite stack m
b8f0: 61 79 20 67 65 6e 65 72 61 74 65 20 69 6e 73 74  ay generate inst
b900: 61 6e 63 65 73 20 6f 66 20 74 68 69 73 20 66 69  ances of this fi
b910: 6c 65 20 63 6f 6e 74 72 6f 6c 20 69 66 0a 2a 2a  le control if.**
b920: 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 55 53 45   the [SQLITE_USE
b930: 5f 46 43 4e 54 4c 5f 54 52 41 43 45 5d 20 63 6f  _FCNTL_TRACE] co
b940: 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f  mpile-time optio
b950: 6e 20 69 73 20 65 6e 61 62 6c 65 64 2e 0a 2a 2a  n is enabled..**
b960: 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45  .** <li>[[SQLITE
b970: 5f 46 43 4e 54 4c 5f 48 41 53 5f 4d 4f 56 45 44  _FCNTL_HAS_MOVED
b980: 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54  ]].** The [SQLIT
b990: 45 5f 46 43 4e 54 4c 5f 48 41 53 5f 4d 4f 56 45  E_FCNTL_HAS_MOVE
b9a0: 44 5d 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20  D] file control 
b9b0: 69 6e 74 65 72 70 72 65 74 73 20 69 74 73 20 61  interprets its a
b9c0: 72 67 75 6d 65 6e 74 20 61 73 20 61 0a 2a 2a 20  rgument as a.** 
b9d0: 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 69 6e  pointer to an in
b9e0: 74 65 67 65 72 20 61 6e 64 20 69 74 20 77 72 69  teger and it wri
b9f0: 74 65 73 20 61 20 62 6f 6f 6c 65 61 6e 20 69 6e  tes a boolean in
ba00: 74 6f 20 74 68 61 74 20 69 6e 74 65 67 65 72 20  to that integer 
ba10: 64 65 70 65 6e 64 69 6e 67 0a 2a 2a 20 6f 6e 20  depending.** on 
ba20: 77 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20 74  whether or not t
ba30: 68 65 20 66 69 6c 65 20 68 61 73 20 62 65 65 6e  he file has been
ba40: 20 72 65 6e 61 6d 65 64 2c 20 6d 6f 76 65 64 2c   renamed, moved,
ba50: 20 6f 72 20 64 65 6c 65 74 65 64 20 73 69 6e 63   or deleted sinc
ba60: 65 20 69 74 0a 2a 2a 20 77 61 73 20 66 69 72 73  e it.** was firs
ba70: 74 20 6f 70 65 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20  t opened..**.** 
ba80: 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e  <li>[[SQLITE_FCN
ba90: 54 4c 5f 57 49 4e 33 32 5f 53 45 54 5f 48 41 4e  TL_WIN32_SET_HAN
baa0: 44 4c 45 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53 51  DLE]].** The [SQ
bab0: 4c 49 54 45 5f 46 43 4e 54 4c 5f 57 49 4e 33 32  LITE_FCNTL_WIN32
bac0: 5f 53 45 54 5f 48 41 4e 44 4c 45 5d 20 6f 70 63  _SET_HANDLE] opc
bad0: 6f 64 65 20 69 73 20 75 73 65 64 20 66 6f 72 20  ode is used for 
bae0: 64 65 62 75 67 67 69 6e 67 2e 20 20 54 68 69 73  debugging.  This
baf0: 0a 2a 2a 20 6f 70 63 6f 64 65 20 63 61 75 73 65  .** opcode cause
bb00: 73 20 74 68 65 20 78 46 69 6c 65 43 6f 6e 74 72  s the xFileContr
bb10: 6f 6c 20 6d 65 74 68 6f 64 20 74 6f 20 73 77 61  ol method to swa
bb20: 70 20 74 68 65 20 66 69 6c 65 20 68 61 6e 64 6c  p the file handl
bb30: 65 20 77 69 74 68 20 74 68 65 20 6f 6e 65 0a 2a  e with the one.*
bb40: 2a 20 70 6f 69 6e 74 65 64 20 74 6f 20 62 79 20  * pointed to by 
bb50: 74 68 65 20 70 41 72 67 20 61 72 67 75 6d 65 6e  the pArg argumen
bb60: 74 2e 20 20 54 68 69 73 20 63 61 70 61 62 69 6c  t.  This capabil
bb70: 69 74 79 20 69 73 20 75 73 65 64 20 64 75 72 69  ity is used duri
bb80: 6e 67 20 74 65 73 74 69 6e 67 0a 2a 2a 20 61 6e  ng testing.** an
bb90: 64 20 6f 6e 6c 79 20 6e 65 65 64 73 20 74 6f 20  d only needs to 
bba0: 62 65 20 73 75 70 70 6f 72 74 65 64 20 77 68 65  be supported whe
bbb0: 6e 20 53 51 4c 49 54 45 5f 54 45 53 54 20 69 73  n SQLITE_TEST is
bbc0: 20 64 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20   defined..**.** 
bbd0: 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e  <li>[[SQLITE_FCN
bbe0: 54 4c 5f 57 41 4c 5f 42 4c 4f 43 4b 5d 5d 0a 2a  TL_WAL_BLOCK]].*
bbf0: 2a 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 46 43  * The [SQLITE_FC
bc00: 4e 54 4c 5f 57 41 4c 5f 42 4c 4f 43 4b 5d 20 69  NTL_WAL_BLOCK] i
bc10: 73 20 61 20 73 69 67 6e 61 6c 20 74 6f 20 74 68  s a signal to th
bc20: 65 20 56 46 53 20 6c 61 79 65 72 20 74 68 61 74  e VFS layer that
bc30: 20 69 74 20 6d 69 67 68 74 0a 2a 2a 20 62 65 20   it might.** be 
bc40: 61 64 76 61 6e 74 61 67 65 6f 75 73 20 74 6f 20  advantageous to 
bc50: 62 6c 6f 63 6b 20 6f 6e 20 74 68 65 20 6e 65 78  block on the nex
bc60: 74 20 57 41 4c 20 6c 6f 63 6b 20 69 66 20 74 68  t WAL lock if th
bc70: 65 20 6c 6f 63 6b 20 69 73 20 6e 6f 74 20 69 6d  e lock is not im
bc80: 6d 65 64 69 61 74 65 6c 79 0a 2a 2a 20 61 76 61  mediately.** ava
bc90: 69 6c 61 62 6c 65 2e 20 20 54 68 65 20 57 41 4c  ilable.  The WAL
bca0: 20 73 75 62 73 79 73 74 65 6d 20 69 73 73 75 65   subsystem issue
bcb0: 73 20 74 68 69 73 20 73 69 67 6e 61 6c 20 64 75  s this signal du
bcc0: 72 69 6e 67 20 72 61 72 65 0a 2a 2a 20 63 69 72  ring rare.** cir
bcd0: 63 75 6d 73 74 61 6e 63 65 73 20 69 6e 20 6f 72  cumstances in or
bce0: 64 65 72 20 74 6f 20 66 69 78 20 61 20 70 72 6f  der to fix a pro
bcf0: 62 6c 65 6d 20 77 69 74 68 20 70 72 69 6f 72 69  blem with priori
bd00: 74 79 20 69 6e 76 65 72 73 69 6f 6e 2e 0a 2a 2a  ty inversion..**
bd10: 20 41 70 70 6c 69 63 61 74 69 6f 6e 73 20 73 68   Applications sh
bd20: 6f 75 6c 64 20 3c 65 6d 3e 6e 6f 74 3c 2f 65 6d  ould <em>not</em
bd30: 3e 20 75 73 65 20 74 68 69 73 20 66 69 6c 65 2d  > use this file-
bd40: 63 6f 6e 74 72 6f 6c 2e 0a 2a 2a 0a 2a 2a 20 3c  control..**.** <
bd50: 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54  li>[[SQLITE_FCNT
bd60: 4c 5f 5a 49 50 56 46 53 5d 5d 0a 2a 2a 20 54 68  L_ZIPVFS]].** Th
bd70: 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  e [SQLITE_FCNTL_
bd80: 5a 49 50 56 46 53 5d 20 6f 70 63 6f 64 65 20 69  ZIPVFS] opcode i
bd90: 73 20 69 6d 70 6c 65 6d 65 6e 74 65 64 20 62 79  s implemented by
bda0: 20 7a 69 70 76 66 73 20 6f 6e 6c 79 2e 20 41 6c   zipvfs only. Al
bdb0: 6c 20 6f 74 68 65 72 0a 2a 2a 20 56 46 53 20 73  l other.** VFS s
bdc0: 68 6f 75 6c 64 20 72 65 74 75 72 6e 20 53 51 4c  hould return SQL
bdd0: 49 54 45 5f 4e 4f 54 46 4f 55 4e 44 20 66 6f 72  ITE_NOTFOUND for
bde0: 20 74 68 69 73 20 6f 70 63 6f 64 65 2e 0a 2a 2a   this opcode..**
bdf0: 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45  .** <li>[[SQLITE
be00: 5f 46 43 4e 54 4c 5f 52 42 55 5d 5d 0a 2a 2a 20  _FCNTL_RBU]].** 
be10: 54 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54  The [SQLITE_FCNT
be20: 4c 5f 52 42 55 5d 20 6f 70 63 6f 64 65 20 69 73  L_RBU] opcode is
be30: 20 69 6d 70 6c 65 6d 65 6e 74 65 64 20 62 79 20   implemented by 
be40: 74 68 65 20 73 70 65 63 69 61 6c 20 56 46 53 20  the special VFS 
be50: 75 73 65 64 20 62 79 0a 2a 2a 20 74 68 65 20 52  used by.** the R
be60: 42 55 20 65 78 74 65 6e 73 69 6f 6e 20 6f 6e 6c  BU extension onl
be70: 79 2e 20 20 41 6c 6c 20 6f 74 68 65 72 20 56 46  y.  All other VF
be80: 53 20 73 68 6f 75 6c 64 20 72 65 74 75 72 6e 20  S should return 
be90: 53 51 4c 49 54 45 5f 4e 4f 54 46 4f 55 4e 44 20  SQLITE_NOTFOUND 
bea0: 66 6f 72 0a 2a 2a 20 74 68 69 73 20 6f 70 63 6f  for.** this opco
beb0: 64 65 2e 20 20 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a  de.  .** </ul>.*
bec0: 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
bed0: 5f 46 43 4e 54 4c 5f 4c 4f 43 4b 53 54 41 54 45  _FCNTL_LOCKSTATE
bee0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 31                 1
bef0: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
bf00: 46 43 4e 54 4c 5f 47 45 54 5f 4c 4f 43 4b 50 52  FCNTL_GET_LOCKPR
bf10: 4f 58 59 46 49 4c 45 20 20 20 20 20 20 20 32 0a  OXYFILE       2.
bf20: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46  #define SQLITE_F
bf30: 43 4e 54 4c 5f 53 45 54 5f 4c 4f 43 4b 50 52 4f  CNTL_SET_LOCKPRO
bf40: 58 59 46 49 4c 45 20 20 20 20 20 20 20 33 0a 23  XYFILE       3.#
bf50: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43  define SQLITE_FC
bf60: 4e 54 4c 5f 4c 41 53 54 5f 45 52 52 4e 4f 20 20  NTL_LAST_ERRNO  
bf70: 20 20 20 20 20 20 20 20 20 20 20 20 34 0a 23 64              4.#d
bf80: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e  efine SQLITE_FCN
bf90: 54 4c 5f 53 49 5a 45 5f 48 49 4e 54 20 20 20 20  TL_SIZE_HINT    
bfa0: 20 20 20 20 20 20 20 20 20 20 20 35 0a 23 64 65             5.#de
bfb0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54  fine SQLITE_FCNT
bfc0: 4c 5f 43 48 55 4e 4b 5f 53 49 5a 45 20 20 20 20  L_CHUNK_SIZE    
bfd0: 20 20 20 20 20 20 20 20 20 20 36 0a 23 64 65 66            6.#def
bfe0: 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c  ine SQLITE_FCNTL
bff0: 5f 46 49 4c 45 5f 50 4f 49 4e 54 45 52 20 20 20  _FILE_POINTER   
c000: 20 20 20 20 20 20 20 20 20 37 0a 23 64 65 66 69           7.#defi
c010: 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  ne SQLITE_FCNTL_
c020: 53 59 4e 43 5f 4f 4d 49 54 54 45 44 20 20 20 20  SYNC_OMITTED    
c030: 20 20 20 20 20 20 20 20 38 0a 23 64 65 66 69 6e          8.#defin
c040: 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 57  e SQLITE_FCNTL_W
c050: 49 4e 33 32 5f 41 56 5f 52 45 54 52 59 20 20 20  IN32_AV_RETRY   
c060: 20 20 20 20 20 20 20 39 0a 23 64 65 66 69 6e 65         9.#define
c070: 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 50 45   SQLITE_FCNTL_PE
c080: 52 53 49 53 54 5f 57 41 4c 20 20 20 20 20 20 20  RSIST_WAL       
c090: 20 20 20 20 20 31 30 0a 23 64 65 66 69 6e 65 20       10.#define 
c0a0: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 4f 56 45  SQLITE_FCNTL_OVE
c0b0: 52 57 52 49 54 45 20 20 20 20 20 20 20 20 20 20  RWRITE          
c0c0: 20 20 20 20 31 31 0a 23 64 65 66 69 6e 65 20 53      11.#define S
c0d0: 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 56 46 53 4e  QLITE_FCNTL_VFSN
c0e0: 41 4d 45 20 20 20 20 20 20 20 20 20 20 20 20 20  AME             
c0f0: 20 20 20 31 32 0a 23 64 65 66 69 6e 65 20 53 51     12.#define SQ
c100: 4c 49 54 45 5f 46 43 4e 54 4c 5f 50 4f 57 45 52  LITE_FCNTL_POWER
c110: 53 41 46 45 5f 4f 56 45 52 57 52 49 54 45 20 20  SAFE_OVERWRITE  
c120: 20 20 31 33 0a 23 64 65 66 69 6e 65 20 53 51 4c    13.#define SQL
c130: 49 54 45 5f 46 43 4e 54 4c 5f 50 52 41 47 4d 41  ITE_FCNTL_PRAGMA
c140: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
c150: 20 31 34 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   14.#define SQLI
c160: 54 45 5f 46 43 4e 54 4c 5f 42 55 53 59 48 41 4e  TE_FCNTL_BUSYHAN
c170: 44 4c 45 52 20 20 20 20 20 20 20 20 20 20 20 20  DLER            
c180: 31 35 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  15.#define SQLIT
c190: 45 5f 46 43 4e 54 4c 5f 54 45 4d 50 46 49 4c 45  E_FCNTL_TEMPFILE
c1a0: 4e 41 4d 45 20 20 20 20 20 20 20 20 20 20 20 31  NAME           1
c1b0: 36 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  6.#define SQLITE
c1c0: 5f 46 43 4e 54 4c 5f 4d 4d 41 50 5f 53 49 5a 45  _FCNTL_MMAP_SIZE
c1d0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 31 38                18
c1e0: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
c1f0: 46 43 4e 54 4c 5f 54 52 41 43 45 20 20 20 20 20  FCNTL_TRACE     
c200: 20 20 20 20 20 20 20 20 20 20 20 20 20 31 39 0a               19.
c210: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46  #define SQLITE_F
c220: 43 4e 54 4c 5f 48 41 53 5f 4d 4f 56 45 44 20 20  CNTL_HAS_MOVED  
c230: 20 20 20 20 20 20 20 20 20 20 20 20 32 30 0a 23              20.#
c240: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43  define SQLITE_FC
c250: 4e 54 4c 5f 53 59 4e 43 20 20 20 20 20 20 20 20  NTL_SYNC        
c260: 20 20 20 20 20 20 20 20 20 20 20 32 31 0a 23 64             21.#d
c270: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e  efine SQLITE_FCN
c280: 54 4c 5f 43 4f 4d 4d 49 54 5f 50 48 41 53 45 54  TL_COMMIT_PHASET
c290: 57 4f 20 20 20 20 20 20 20 20 32 32 0a 23 64 65  WO        22.#de
c2a0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54  fine SQLITE_FCNT
c2b0: 4c 5f 57 49 4e 33 32 5f 53 45 54 5f 48 41 4e 44  L_WIN32_SET_HAND
c2c0: 4c 45 20 20 20 20 20 20 20 32 33 0a 23 64 65 66  LE       23.#def
c2d0: 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c  ine SQLITE_FCNTL
c2e0: 5f 57 41 4c 5f 42 4c 4f 43 4b 20 20 20 20 20 20  _WAL_BLOCK      
c2f0: 20 20 20 20 20 20 20 20 32 34 0a 23 64 65 66 69          24.#defi
c300: 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  ne SQLITE_FCNTL_
c310: 5a 49 50 56 46 53 20 20 20 20 20 20 20 20 20 20  ZIPVFS          
c320: 20 20 20 20 20 20 20 32 35 0a 23 64 65 66 69 6e         25.#defin
c330: 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 52  e SQLITE_FCNTL_R
c340: 42 55 20 20 20 20 20 20 20 20 20 20 20 20 20 20  BU              
c350: 20 20 20 20 20 20 32 36 0a 23 64 65 66 69 6e 65        26.#define
c360: 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 56 46   SQLITE_FCNTL_VF
c370: 53 5f 50 4f 49 4e 54 45 52 20 20 20 20 20 20 20  S_POINTER       
c380: 20 20 20 20 20 32 37 0a 23 64 65 66 69 6e 65 20       27.#define 
c390: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 4a 4f 55  SQLITE_FCNTL_JOU
c3a0: 52 4e 41 4c 5f 50 4f 49 4e 54 45 52 20 20 20 20  RNAL_POINTER    
c3b0: 20 20 20 20 32 38 0a 0a 2f 2a 20 64 65 70 72 65      28../* depre
c3c0: 63 61 74 65 64 20 6e 61 6d 65 73 20 2a 2f 0a 23  cated names */.#
c3d0: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 47 45  define SQLITE_GE
c3e0: 54 5f 4c 4f 43 4b 50 52 4f 58 59 46 49 4c 45 20  T_LOCKPROXYFILE 
c3f0: 20 20 20 20 20 53 51 4c 49 54 45 5f 46 43 4e 54       SQLITE_FCNT
c400: 4c 5f 47 45 54 5f 4c 4f 43 4b 50 52 4f 58 59 46  L_GET_LOCKPROXYF
c410: 49 4c 45 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  ILE.#define SQLI
c420: 54 45 5f 53 45 54 5f 4c 4f 43 4b 50 52 4f 58 59  TE_SET_LOCKPROXY
c430: 46 49 4c 45 20 20 20 20 20 20 53 51 4c 49 54 45  FILE      SQLITE
c440: 5f 46 43 4e 54 4c 5f 53 45 54 5f 4c 4f 43 4b 50  _FCNTL_SET_LOCKP
c450: 52 4f 58 59 46 49 4c 45 0a 23 64 65 66 69 6e 65  ROXYFILE.#define
c460: 20 53 51 4c 49 54 45 5f 4c 41 53 54 5f 45 52 52   SQLITE_LAST_ERR
c470: 4e 4f 20 20 20 20 20 20 20 20 20 20 20 20 20 53  NO             S
c480: 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 4c 41 53 54  QLITE_FCNTL_LAST
c490: 5f 45 52 52 4e 4f 0a 0a 0a 2f 2a 0a 2a 2a 20 43  _ERRNO.../*.** C
c4a0: 41 50 49 33 52 45 46 3a 20 4d 75 74 65 78 20 48  API3REF: Mutex H
c4b0: 61 6e 64 6c 65 0a 2a 2a 0a 2a 2a 20 54 68 65 20  andle.**.** The 
c4c0: 6d 75 74 65 78 20 6d 6f 64 75 6c 65 20 77 69 74  mutex module wit
c4d0: 68 69 6e 20 53 51 4c 69 74 65 20 64 65 66 69 6e  hin SQLite defin
c4e0: 65 73 20 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65  es [sqlite3_mute
c4f0: 78 5d 20 74 6f 20 62 65 20 61 6e 0a 2a 2a 20 61  x] to be an.** a
c500: 62 73 74 72 61 63 74 20 74 79 70 65 20 66 6f 72  bstract type for
c510: 20 61 20 6d 75 74 65 78 20 6f 62 6a 65 63 74 2e   a mutex object.
c520: 20 20 54 68 65 20 53 51 4c 69 74 65 20 63 6f 72    The SQLite cor
c530: 65 20 6e 65 76 65 72 20 6c 6f 6f 6b 73 0a 2a 2a  e never looks.**
c540: 20 61 74 20 74 68 65 20 69 6e 74 65 72 6e 61 6c   at the internal
c550: 20 72 65 70 72 65 73 65 6e 74 61 74 69 6f 6e 20   representation 
c560: 6f 66 20 61 6e 20 5b 73 71 6c 69 74 65 33 5f 6d  of an [sqlite3_m
c570: 75 74 65 78 5d 2e 20 20 49 74 20 6f 6e 6c 79 0a  utex].  It only.
c580: 2a 2a 20 64 65 61 6c 73 20 77 69 74 68 20 70 6f  ** deals with po
c590: 69 6e 74 65 72 73 20 74 6f 20 74 68 65 20 5b 73  inters to the [s
c5a0: 71 6c 69 74 65 33 5f 6d 75 74 65 78 5d 20 6f 62  qlite3_mutex] ob
c5b0: 6a 65 63 74 2e 0a 2a 2a 0a 2a 2a 20 4d 75 74 65  ject..**.** Mute
c5c0: 78 65 73 20 61 72 65 20 63 72 65 61 74 65 64 20  xes are created 
c5d0: 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 6d  using [sqlite3_m
c5e0: 75 74 65 78 5f 61 6c 6c 6f 63 28 29 5d 2e 0a 2a  utex_alloc()]..*
c5f0: 2f 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74  /.typedef struct
c600: 20 73 71 6c 69 74 65 33 5f 6d 75 74 65 78 20 73   sqlite3_mutex s
c610: 71 6c 69 74 65 33 5f 6d 75 74 65 78 3b 0a 0a 2f  qlite3_mutex;../
c620: 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4c  *.** CAPI3REF: L
c630: 6f 61 64 61 62 6c 65 20 45 78 74 65 6e 73 69 6f  oadable Extensio
c640: 6e 20 54 68 75 6e 6b 0a 2a 2a 0a 2a 2a 20 41 20  n Thunk.**.** A 
c650: 70 6f 69 6e 74 65 72 20 74 6f 20 74 68 65 20 6f  pointer to the o
c660: 70 61 71 75 65 20 73 71 6c 69 74 65 33 5f 61 70  paque sqlite3_ap
c670: 69 5f 72 6f 75 74 69 6e 65 73 20 73 74 72 75 63  i_routines struc
c680: 74 75 72 65 20 69 73 20 70 61 73 73 65 64 20 61  ture is passed a
c690: 73 0a 2a 2a 20 74 68 65 20 74 68 69 72 64 20 70  s.** the third p
c6a0: 61 72 61 6d 65 74 65 72 20 74 6f 20 65 6e 74 72  arameter to entr
c6b0: 79 20 70 6f 69 6e 74 73 20 6f 66 20 5b 6c 6f 61  y points of [loa
c6c0: 64 61 62 6c 65 20 65 78 74 65 6e 73 69 6f 6e 73  dable extensions
c6d0: 5d 2e 20 20 54 68 69 73 0a 2a 2a 20 73 74 72 75  ].  This.** stru
c6e0: 63 74 75 72 65 20 6d 75 73 74 20 62 65 20 74 79  cture must be ty
c6f0: 70 65 64 65 66 65 64 20 69 6e 20 6f 72 64 65 72  pedefed in order
c700: 20 74 6f 20 77 6f 72 6b 20 61 72 6f 75 6e 64 20   to work around 
c710: 63 6f 6d 70 69 6c 65 72 20 77 61 72 6e 69 6e 67  compiler warning
c720: 73 0a 2a 2a 20 6f 6e 20 73 6f 6d 65 20 70 6c 61  s.** on some pla
c730: 74 66 6f 72 6d 73 2e 0a 2a 2f 0a 74 79 70 65 64  tforms..*/.typed
c740: 65 66 20 73 74 72 75 63 74 20 73 71 6c 69 74 65  ef struct sqlite
c750: 33 5f 61 70 69 5f 72 6f 75 74 69 6e 65 73 20 73  3_api_routines s
c760: 71 6c 69 74 65 33 5f 61 70 69 5f 72 6f 75 74 69  qlite3_api_routi
c770: 6e 65 73 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  nes;../*.** CAPI
c780: 33 52 45 46 3a 20 4f 53 20 49 6e 74 65 72 66 61  3REF: OS Interfa
c790: 63 65 20 4f 62 6a 65 63 74 0a 2a 2a 0a 2a 2a 20  ce Object.**.** 
c7a0: 41 6e 20 69 6e 73 74 61 6e 63 65 20 6f 66 20 74  An instance of t
c7b0: 68 65 20 73 71 6c 69 74 65 33 5f 76 66 73 20 6f  he sqlite3_vfs o
c7c0: 62 6a 65 63 74 20 64 65 66 69 6e 65 73 20 74 68  bject defines th
c7d0: 65 20 69 6e 74 65 72 66 61 63 65 20 62 65 74 77  e interface betw
c7e0: 65 65 6e 0a 2a 2a 20 74 68 65 20 53 51 4c 69 74  een.** the SQLit
c7f0: 65 20 63 6f 72 65 20 61 6e 64 20 74 68 65 20 75  e core and the u
c800: 6e 64 65 72 6c 79 69 6e 67 20 6f 70 65 72 61 74  nderlying operat
c810: 69 6e 67 20 73 79 73 74 65 6d 2e 20 20 54 68 65  ing system.  The
c820: 20 22 76 66 73 22 0a 2a 2a 20 69 6e 20 74 68 65   "vfs".** in the
c830: 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 6f 62 6a   name of the obj
c840: 65 63 74 20 73 74 61 6e 64 73 20 66 6f 72 20 22  ect stands for "
c850: 76 69 72 74 75 61 6c 20 66 69 6c 65 20 73 79 73  virtual file sys
c860: 74 65 6d 22 2e 20 20 53 65 65 0a 2a 2a 20 74 68  tem".  See.** th
c870: 65 20 5b 56 46 53 20 7c 20 56 46 53 20 64 6f 63  e [VFS | VFS doc
c880: 75 6d 65 6e 74 61 74 69 6f 6e 5d 20 66 6f 72 20  umentation] for 
c890: 66 75 72 74 68 65 72 20 69 6e 66 6f 72 6d 61 74  further informat
c8a0: 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 76  ion..**.** The v
c8b0: 61 6c 75 65 20 6f 66 20 74 68 65 20 69 56 65 72  alue of the iVer
c8c0: 73 69 6f 6e 20 66 69 65 6c 64 20 69 73 20 69 6e  sion field is in
c8d0: 69 74 69 61 6c 6c 79 20 31 20 62 75 74 20 6d 61  itially 1 but ma
c8e0: 79 20 62 65 20 6c 61 72 67 65 72 20 69 6e 0a 2a  y be larger in.*
c8f0: 2a 20 66 75 74 75 72 65 20 76 65 72 73 69 6f 6e  * future version
c900: 73 20 6f 66 20 53 51 4c 69 74 65 2e 20 20 41 64  s of SQLite.  Ad
c910: 64 69 74 69 6f 6e 61 6c 20 66 69 65 6c 64 73 20  ditional fields 
c920: 6d 61 79 20 62 65 20 61 70 70 65 6e 64 65 64 20  may be appended 
c930: 74 6f 20 74 68 69 73 0a 2a 2a 20 6f 62 6a 65 63  to this.** objec
c940: 74 20 77 68 65 6e 20 74 68 65 20 69 56 65 72 73  t when the iVers
c950: 69 6f 6e 20 76 61 6c 75 65 20 69 73 20 69 6e 63  ion value is inc
c960: 72 65 61 73 65 64 2e 20 20 4e 6f 74 65 20 74 68  reased.  Note th
c970: 61 74 20 74 68 65 20 73 74 72 75 63 74 75 72 65  at the structure
c980: 0a 2a 2a 20 6f 66 20 74 68 65 20 73 71 6c 69 74  .** of the sqlit
c990: 65 33 5f 76 66 73 20 6f 62 6a 65 63 74 20 63 68  e3_vfs object ch
c9a0: 61 6e 67 65 73 20 69 6e 20 74 68 65 20 74 72 61  anges in the tra
c9b0: 6e 73 61 63 74 69 6f 6e 20 62 65 74 77 65 65 6e  nsaction between
c9c0: 0a 2a 2a 20 53 51 4c 69 74 65 20 76 65 72 73 69  .** SQLite versi
c9d0: 6f 6e 20 33 2e 35 2e 39 20 61 6e 64 20 33 2e 36  on 3.5.9 and 3.6
c9e0: 2e 30 20 61 6e 64 20 79 65 74 20 74 68 65 20 69  .0 and yet the i
c9f0: 56 65 72 73 69 6f 6e 20 66 69 65 6c 64 20 77 61  Version field wa
ca00: 73 20 6e 6f 74 0a 2a 2a 20 6d 6f 64 69 66 69 65  s not.** modifie
ca10: 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 7a 4f  d..**.** The szO
ca20: 73 46 69 6c 65 20 66 69 65 6c 64 20 69 73 20 74  sFile field is t
ca30: 68 65 20 73 69 7a 65 20 6f 66 20 74 68 65 20 73  he size of the s
ca40: 75 62 63 6c 61 73 73 65 64 20 5b 73 71 6c 69 74  ubclassed [sqlit
ca50: 65 33 5f 66 69 6c 65 5d 0a 2a 2a 20 73 74 72 75  e3_file].** stru
ca60: 63 74 75 72 65 20 75 73 65 64 20 62 79 20 74 68  cture used by th
ca70: 69 73 20 56 46 53 2e 20 20 6d 78 50 61 74 68 6e  is VFS.  mxPathn
ca80: 61 6d 65 20 69 73 20 74 68 65 20 6d 61 78 69 6d  ame is the maxim
ca90: 75 6d 20 6c 65 6e 67 74 68 20 6f 66 0a 2a 2a 20  um length of.** 
caa0: 61 20 70 61 74 68 6e 61 6d 65 20 69 6e 20 74 68  a pathname in th
cab0: 69 73 20 56 46 53 2e 0a 2a 2a 0a 2a 2a 20 52 65  is VFS..**.** Re
cac0: 67 69 73 74 65 72 65 64 20 73 71 6c 69 74 65 33  gistered sqlite3
cad0: 5f 76 66 73 20 6f 62 6a 65 63 74 73 20 61 72 65  _vfs objects are
cae0: 20 6b 65 70 74 20 6f 6e 20 61 20 6c 69 6e 6b 65   kept on a linke
caf0: 64 20 6c 69 73 74 20 66 6f 72 6d 65 64 20 62 79  d list formed by
cb00: 0a 2a 2a 20 74 68 65 20 70 4e 65 78 74 20 70 6f  .** the pNext po
cb10: 69 6e 74 65 72 2e 20 20 54 68 65 20 5b 73 71 6c  inter.  The [sql
cb20: 69 74 65 33 5f 76 66 73 5f 72 65 67 69 73 74 65  ite3_vfs_registe
cb30: 72 28 29 5d 0a 2a 2a 20 61 6e 64 20 5b 73 71 6c  r()].** and [sql
cb40: 69 74 65 33 5f 76 66 73 5f 75 6e 72 65 67 69 73  ite3_vfs_unregis
cb50: 74 65 72 28 29 5d 20 69 6e 74 65 72 66 61 63 65  ter()] interface
cb60: 73 20 6d 61 6e 61 67 65 20 74 68 69 73 20 6c 69  s manage this li
cb70: 73 74 0a 2a 2a 20 69 6e 20 61 20 74 68 72 65 61  st.** in a threa
cb80: 64 2d 73 61 66 65 20 77 61 79 2e 20 20 54 68 65  d-safe way.  The
cb90: 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5f 66 69   [sqlite3_vfs_fi
cba0: 6e 64 28 29 5d 20 69 6e 74 65 72 66 61 63 65 0a  nd()] interface.
cbb0: 2a 2a 20 73 65 61 72 63 68 65 73 20 74 68 65 20  ** searches the 
cbc0: 6c 69 73 74 2e 20 20 4e 65 69 74 68 65 72 20 74  list.  Neither t
cbd0: 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 63  he application c
cbe0: 6f 64 65 20 6e 6f 72 20 74 68 65 20 56 46 53 0a  ode nor the VFS.
cbf0: 2a 2a 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f  ** implementatio
cc00: 6e 20 73 68 6f 75 6c 64 20 75 73 65 20 74 68 65  n should use the
cc10: 20 70 4e 65 78 74 20 70 6f 69 6e 74 65 72 2e 0a   pNext pointer..
cc20: 2a 2a 0a 2a 2a 20 54 68 65 20 70 4e 65 78 74 20  **.** The pNext 
cc30: 66 69 65 6c 64 20 69 73 20 74 68 65 20 6f 6e 6c  field is the onl
cc40: 79 20 66 69 65 6c 64 20 69 6e 20 74 68 65 20 73  y field in the s
cc50: 71 6c 69 74 65 33 5f 76 66 73 0a 2a 2a 20 73 74  qlite3_vfs.** st
cc60: 72 75 63 74 75 72 65 20 74 68 61 74 20 53 51 4c  ructure that SQL
cc70: 69 74 65 20 77 69 6c 6c 20 65 76 65 72 20 6d 6f  ite will ever mo
cc80: 64 69 66 79 2e 20 20 53 51 4c 69 74 65 20 77 69  dify.  SQLite wi
cc90: 6c 6c 20 6f 6e 6c 79 20 61 63 63 65 73 73 0a 2a  ll only access.*
cca0: 2a 20 6f 72 20 6d 6f 64 69 66 79 20 74 68 69 73  * or modify this
ccb0: 20 66 69 65 6c 64 20 77 68 69 6c 65 20 68 6f 6c   field while hol
ccc0: 64 69 6e 67 20 61 20 70 61 72 74 69 63 75 6c 61  ding a particula
ccd0: 72 20 73 74 61 74 69 63 20 6d 75 74 65 78 2e 0a  r static mutex..
cce0: 2a 2a 20 54 68 65 20 61 70 70 6c 69 63 61 74 69  ** The applicati
ccf0: 6f 6e 20 73 68 6f 75 6c 64 20 6e 65 76 65 72 20  on should never 
cd00: 6d 6f 64 69 66 79 20 61 6e 79 74 68 69 6e 67 20  modify anything 
cd10: 77 69 74 68 69 6e 20 74 68 65 20 73 71 6c 69 74  within the sqlit
cd20: 65 33 5f 76 66 73 0a 2a 2a 20 6f 62 6a 65 63 74  e3_vfs.** object
cd30: 20 6f 6e 63 65 20 74 68 65 20 6f 62 6a 65 63 74   once the object
cd40: 20 68 61 73 20 62 65 65 6e 20 72 65 67 69 73 74   has been regist
cd50: 65 72 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  ered..**.** The 
cd60: 7a 4e 61 6d 65 20 66 69 65 6c 64 20 68 6f 6c 64  zName field hold
cd70: 73 20 74 68 65 20 6e 61 6d 65 20 6f 66 20 74 68  s the name of th
cd80: 65 20 56 46 53 20 6d 6f 64 75 6c 65 2e 20 20 54  e VFS module.  T
cd90: 68 65 20 6e 61 6d 65 20 6d 75 73 74 0a 2a 2a 20  he name must.** 
cda0: 62 65 20 75 6e 69 71 75 65 20 61 63 72 6f 73 73  be unique across
cdb0: 20 61 6c 6c 20 56 46 53 20 6d 6f 64 75 6c 65 73   all VFS modules
cdc0: 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 73 71 6c 69 74 65  ..**.** [[sqlite
cdd0: 33 5f 76 66 73 2e 78 4f 70 65 6e 5d 5d 0a 2a 2a  3_vfs.xOpen]].**
cde0: 20 5e 53 51 4c 69 74 65 20 67 75 61 72 61 6e 74   ^SQLite guarant
cdf0: 65 65 73 20 74 68 61 74 20 74 68 65 20 7a 46 69  ees that the zFi
ce00: 6c 65 6e 61 6d 65 20 70 61 72 61 6d 65 74 65 72  lename parameter
ce10: 20 74 6f 20 78 4f 70 65 6e 0a 2a 2a 20 69 73 20   to xOpen.** is 
ce20: 65 69 74 68 65 72 20 61 20 4e 55 4c 4c 20 70 6f  either a NULL po
ce30: 69 6e 74 65 72 20 6f 72 20 73 74 72 69 6e 67 20  inter or string 
ce40: 6f 62 74 61 69 6e 65 64 0a 2a 2a 20 66 72 6f 6d  obtained.** from
ce50: 20 78 46 75 6c 6c 50 61 74 68 6e 61 6d 65 28 29   xFullPathname()
ce60: 20 77 69 74 68 20 61 6e 20 6f 70 74 69 6f 6e 61   with an optiona
ce70: 6c 20 73 75 66 66 69 78 20 61 64 64 65 64 2e 0a  l suffix added..
ce80: 2a 2a 20 5e 49 66 20 61 20 73 75 66 66 69 78 20  ** ^If a suffix 
ce90: 69 73 20 61 64 64 65 64 20 74 6f 20 74 68 65 20  is added to the 
cea0: 7a 46 69 6c 65 6e 61 6d 65 20 70 61 72 61 6d 65  zFilename parame
ceb0: 74 65 72 2c 20 69 74 20 77 69 6c 6c 0a 2a 2a 20  ter, it will.** 
cec0: 63 6f 6e 73 69 73 74 20 6f 66 20 61 20 73 69 6e  consist of a sin
ced0: 67 6c 65 20 22 2d 22 20 63 68 61 72 61 63 74 65  gle "-" characte
cee0: 72 20 66 6f 6c 6c 6f 77 65 64 20 62 79 20 6e 6f  r followed by no
cef0: 20 6d 6f 72 65 20 74 68 61 6e 0a 2a 2a 20 31 31   more than.** 11
cf00: 20 61 6c 70 68 61 6e 75 6d 65 72 69 63 20 61 6e   alphanumeric an
cf10: 64 2f 6f 72 20 22 2d 22 20 63 68 61 72 61 63 74  d/or "-" charact
cf20: 65 72 73 2e 0a 2a 2a 20 5e 53 51 4c 69 74 65 20  ers..** ^SQLite 
cf30: 66 75 72 74 68 65 72 20 67 75 61 72 61 6e 74 65  further guarante
cf40: 65 73 20 74 68 61 74 0a 2a 2a 20 74 68 65 20 73  es that.** the s
cf50: 74 72 69 6e 67 20 77 69 6c 6c 20 62 65 20 76 61  tring will be va
cf60: 6c 69 64 20 61 6e 64 20 75 6e 63 68 61 6e 67 65  lid and unchange
cf70: 64 20 75 6e 74 69 6c 20 78 43 6c 6f 73 65 28 29  d until xClose()
cf80: 20 69 73 0a 2a 2a 20 63 61 6c 6c 65 64 2e 20 42   is.** called. B
cf90: 65 63 61 75 73 65 20 6f 66 20 74 68 65 20 70 72  ecause of the pr
cfa0: 65 76 69 6f 75 73 20 73 65 6e 74 65 6e 63 65 2c  evious sentence,
cfb0: 0a 2a 2a 20 74 68 65 20 5b 73 71 6c 69 74 65 33  .** the [sqlite3
cfc0: 5f 66 69 6c 65 5d 20 63 61 6e 20 73 61 66 65 6c  _file] can safel
cfd0: 79 20 73 74 6f 72 65 20 61 20 70 6f 69 6e 74 65  y store a pointe
cfe0: 72 20 74 6f 20 74 68 65 0a 2a 2a 20 66 69 6c 65  r to the.** file
cff0: 6e 61 6d 65 20 69 66 20 69 74 20 6e 65 65 64 73  name if it needs
d000: 20 74 6f 20 72 65 6d 65 6d 62 65 72 20 74 68 65   to remember the
d010: 20 66 69 6c 65 6e 61 6d 65 20 66 6f 72 20 73 6f   filename for so
d020: 6d 65 20 72 65 61 73 6f 6e 2e 0a 2a 2a 20 49 66  me reason..** If
d030: 20 74 68 65 20 7a 46 69 6c 65 6e 61 6d 65 20 70   the zFilename p
d040: 61 72 61 6d 65 74 65 72 20 74 6f 20 78 4f 70 65  arameter to xOpe
d050: 6e 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e  n is a NULL poin
d060: 74 65 72 20 74 68 65 6e 20 78 4f 70 65 6e 0a 2a  ter then xOpen.*
d070: 2a 20 6d 75 73 74 20 69 6e 76 65 6e 74 20 69 74  * must invent it
d080: 73 20 6f 77 6e 20 74 65 6d 70 6f 72 61 72 79 20  s own temporary 
d090: 6e 61 6d 65 20 66 6f 72 20 74 68 65 20 66 69 6c  name for the fil
d0a0: 65 2e 20 20 5e 57 68 65 6e 65 76 65 72 20 74 68  e.  ^Whenever th
d0b0: 65 20 0a 2a 2a 20 78 46 69 6c 65 6e 61 6d 65 20  e .** xFilename 
d0c0: 70 61 72 61 6d 65 74 65 72 20 69 73 20 4e 55 4c  parameter is NUL
d0d0: 4c 20 69 74 20 77 69 6c 6c 20 61 6c 73 6f 20 62  L it will also b
d0e0: 65 20 74 68 65 20 63 61 73 65 20 74 68 61 74 20  e the case that 
d0f0: 74 68 65 0a 2a 2a 20 66 6c 61 67 73 20 70 61 72  the.** flags par
d100: 61 6d 65 74 65 72 20 77 69 6c 6c 20 69 6e 63 6c  ameter will incl
d110: 75 64 65 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  ude [SQLITE_OPEN
d120: 5f 44 45 4c 45 54 45 4f 4e 43 4c 4f 53 45 5d 2e  _DELETEONCLOSE].
d130: 0a 2a 2a 0a 2a 2a 20 54 68 65 20 66 6c 61 67 73  .**.** The flags
d140: 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 78 4f 70   argument to xOp
d150: 65 6e 28 29 20 69 6e 63 6c 75 64 65 73 20 61 6c  en() includes al
d160: 6c 20 62 69 74 73 20 73 65 74 20 69 6e 0a 2a 2a  l bits set in.**
d170: 20 74 68 65 20 66 6c 61 67 73 20 61 72 67 75 6d   the flags argum
d180: 65 6e 74 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f  ent to [sqlite3_
d190: 6f 70 65 6e 5f 76 32 28 29 5d 2e 20 20 4f 72 20  open_v2()].  Or 
d1a0: 69 66 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e  if [sqlite3_open
d1b0: 28 29 5d 0a 2a 2a 20 6f 72 20 5b 73 71 6c 69 74  ()].** or [sqlit
d1c0: 65 33 5f 6f 70 65 6e 31 36 28 29 5d 20 69 73 20  e3_open16()] is 
d1d0: 75 73 65 64 2c 20 74 68 65 6e 20 66 6c 61 67 73  used, then flags
d1e0: 20 69 6e 63 6c 75 64 65 73 20 61 74 20 6c 65 61   includes at lea
d1f0: 73 74 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 4f 50  st.** [SQLITE_OP
d200: 45 4e 5f 52 45 41 44 57 52 49 54 45 5d 20 7c 20  EN_READWRITE] | 
d210: 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 43 52 45  [SQLITE_OPEN_CRE
d220: 41 54 45 5d 2e 20 0a 2a 2a 20 49 66 20 78 4f 70  ATE]. .** If xOp
d230: 65 6e 28 29 20 6f 70 65 6e 73 20 61 20 66 69 6c  en() opens a fil
d240: 65 20 72 65 61 64 2d 6f 6e 6c 79 20 74 68 65 6e  e read-only then
d250: 20 69 74 20 73 65 74 73 20 2a 70 4f 75 74 46 6c   it sets *pOutFl
d260: 61 67 73 20 74 6f 0a 2a 2a 20 69 6e 63 6c 75 64  ags to.** includ
d270: 65 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 52  e [SQLITE_OPEN_R
d280: 45 41 44 4f 4e 4c 59 5d 2e 20 20 4f 74 68 65 72  EADONLY].  Other
d290: 20 62 69 74 73 20 69 6e 20 2a 70 4f 75 74 46 6c   bits in *pOutFl
d2a0: 61 67 73 20 6d 61 79 20 62 65 20 73 65 74 2e 0a  ags may be set..
d2b0: 2a 2a 0a 2a 2a 20 5e 28 53 51 4c 69 74 65 20 77  **.** ^(SQLite w
d2c0: 69 6c 6c 20 61 6c 73 6f 20 61 64 64 20 6f 6e 65  ill also add one
d2d0: 20 6f 66 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e   of the followin
d2e0: 67 20 66 6c 61 67 73 20 74 6f 20 74 68 65 20 78  g flags to the x
d2f0: 4f 70 65 6e 28 29 0a 2a 2a 20 63 61 6c 6c 2c 20  Open().** call, 
d300: 64 65 70 65 6e 64 69 6e 67 20 6f 6e 20 74 68 65  depending on the
d310: 20 6f 62 6a 65 63 74 20 62 65 69 6e 67 20 6f 70   object being op
d320: 65 6e 65 64 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e  ened:.**.** <ul>
d330: 0a 2a 2a 20 3c 6c 69 3e 20 20 5b 53 51 4c 49 54  .** <li>  [SQLIT
d340: 45 5f 4f 50 45 4e 5f 4d 41 49 4e 5f 44 42 5d 0a  E_OPEN_MAIN_DB].
d350: 2a 2a 20 3c 6c 69 3e 20 20 5b 53 51 4c 49 54 45  ** <li>  [SQLITE
d360: 5f 4f 50 45 4e 5f 4d 41 49 4e 5f 4a 4f 55 52 4e  _OPEN_MAIN_JOURN
d370: 41 4c 5d 0a 2a 2a 20 3c 6c 69 3e 20 20 5b 53 51  AL].** <li>  [SQ
d380: 4c 49 54 45 5f 4f 50 45 4e 5f 54 45 4d 50 5f 44  LITE_OPEN_TEMP_D
d390: 42 5d 0a 2a 2a 20 3c 6c 69 3e 20 20 5b 53 51 4c  B].** <li>  [SQL
d3a0: 49 54 45 5f 4f 50 45 4e 5f 54 45 4d 50 5f 4a 4f  ITE_OPEN_TEMP_JO
d3b0: 55 52 4e 41 4c 5d 0a 2a 2a 20 3c 6c 69 3e 20 20  URNAL].** <li>  
d3c0: 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 54 52 41  [SQLITE_OPEN_TRA
d3d0: 4e 53 49 45 4e 54 5f 44 42 5d 0a 2a 2a 20 3c 6c  NSIENT_DB].** <l
d3e0: 69 3e 20 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  i>  [SQLITE_OPEN
d3f0: 5f 53 55 42 4a 4f 55 52 4e 41 4c 5d 0a 2a 2a 20  _SUBJOURNAL].** 
d400: 3c 6c 69 3e 20 20 5b 53 51 4c 49 54 45 5f 4f 50  <li>  [SQLITE_OP
d410: 45 4e 5f 4d 41 53 54 45 52 5f 4a 4f 55 52 4e 41  EN_MASTER_JOURNA
d420: 4c 5d 0a 2a 2a 20 3c 6c 69 3e 20 20 5b 53 51 4c  L].** <li>  [SQL
d430: 49 54 45 5f 4f 50 45 4e 5f 57 41 4c 5d 0a 2a 2a  ITE_OPEN_WAL].**
d440: 20 3c 2f 75 6c 3e 29 5e 0a 2a 2a 0a 2a 2a 20 54   </ul>)^.**.** T
d450: 68 65 20 66 69 6c 65 20 49 2f 4f 20 69 6d 70 6c  he file I/O impl
d460: 65 6d 65 6e 74 61 74 69 6f 6e 20 63 61 6e 20 75  ementation can u
d470: 73 65 20 74 68 65 20 6f 62 6a 65 63 74 20 74 79  se the object ty
d480: 70 65 20 66 6c 61 67 73 20 74 6f 0a 2a 2a 20 63  pe flags to.** c
d490: 68 61 6e 67 65 20 74 68 65 20 77 61 79 20 69 74  hange the way it
d4a0: 20 64 65 61 6c 73 20 77 69 74 68 20 66 69 6c 65   deals with file
d4b0: 73 2e 20 20 46 6f 72 20 65 78 61 6d 70 6c 65 2c  s.  For example,
d4c0: 20 61 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 0a   an application.
d4d0: 2a 2a 20 74 68 61 74 20 64 6f 65 73 20 6e 6f 74  ** that does not
d4e0: 20 63 61 72 65 20 61 62 6f 75 74 20 63 72 61 73   care about cras
d4f0: 68 20 72 65 63 6f 76 65 72 79 20 6f 72 20 72 6f  h recovery or ro
d500: 6c 6c 62 61 63 6b 20 6d 69 67 68 74 20 6d 61 6b  llback might mak
d510: 65 0a 2a 2a 20 74 68 65 20 6f 70 65 6e 20 6f 66  e.** the open of
d520: 20 61 20 6a 6f 75 72 6e 61 6c 20 66 69 6c 65 20   a journal file 
d530: 61 20 6e 6f 2d 6f 70 2e 20 20 57 72 69 74 65 73  a no-op.  Writes
d540: 20 74 6f 20 74 68 69 73 20 6a 6f 75 72 6e 61 6c   to this journal
d550: 20 77 6f 75 6c 64 0a 2a 2a 20 61 6c 73 6f 20 62   would.** also b
d560: 65 20 6e 6f 2d 6f 70 73 2c 20 61 6e 64 20 61 6e  e no-ops, and an
d570: 79 20 61 74 74 65 6d 70 74 20 74 6f 20 72 65 61  y attempt to rea
d580: 64 20 74 68 65 20 6a 6f 75 72 6e 61 6c 20 77 6f  d the journal wo
d590: 75 6c 64 20 72 65 74 75 72 6e 0a 2a 2a 20 53 51  uld return.** SQ
d5a0: 4c 49 54 45 5f 49 4f 45 52 52 2e 20 20 4f 72 20  LITE_IOERR.  Or 
d5b0: 74 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  the implementati
d5c0: 6f 6e 20 6d 69 67 68 74 20 72 65 63 6f 67 6e 69  on might recogni
d5d0: 7a 65 20 74 68 61 74 20 61 20 64 61 74 61 62 61  ze that a databa
d5e0: 73 65 0a 2a 2a 20 66 69 6c 65 20 77 69 6c 6c 20  se.** file will 
d5f0: 62 65 20 64 6f 69 6e 67 20 70 61 67 65 2d 61 6c  be doing page-al
d600: 69 67 6e 65 64 20 73 65 63 74 6f 72 20 72 65 61  igned sector rea
d610: 64 73 20 61 6e 64 20 77 72 69 74 65 73 20 69 6e  ds and writes in
d620: 20 61 20 72 61 6e 64 6f 6d 0a 2a 2a 20 6f 72 64   a random.** ord
d630: 65 72 20 61 6e 64 20 73 65 74 20 75 70 20 69 74  er and set up it
d640: 73 20 49 2f 4f 20 73 75 62 73 79 73 74 65 6d 20  s I/O subsystem 
d650: 61 63 63 6f 72 64 69 6e 67 6c 79 2e 0a 2a 2a 0a  accordingly..**.
d660: 2a 2a 20 53 51 4c 69 74 65 20 6d 69 67 68 74 20  ** SQLite might 
d670: 61 6c 73 6f 20 61 64 64 20 6f 6e 65 20 6f 66 20  also add one of 
d680: 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 66 6c  the following fl
d690: 61 67 73 20 74 6f 20 74 68 65 20 78 4f 70 65 6e  ags to the xOpen
d6a0: 20 6d 65 74 68 6f 64 3a 0a 2a 2a 0a 2a 2a 20 3c   method:.**.** <
d6b0: 75 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c  ul>.** <li> [SQL
d6c0: 49 54 45 5f 4f 50 45 4e 5f 44 45 4c 45 54 45 4f  ITE_OPEN_DELETEO
d6d0: 4e 43 4c 4f 53 45 5d 0a 2a 2a 20 3c 6c 69 3e 20  NCLOSE].** <li> 
d6e0: 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 45 58 43  [SQLITE_OPEN_EXC
d6f0: 4c 55 53 49 56 45 5d 0a 2a 2a 20 3c 2f 75 6c 3e  LUSIVE].** </ul>
d700: 0a 2a 2a 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49  .**.** The [SQLI
d710: 54 45 5f 4f 50 45 4e 5f 44 45 4c 45 54 45 4f 4e  TE_OPEN_DELETEON
d720: 43 4c 4f 53 45 5d 20 66 6c 61 67 20 6d 65 61 6e  CLOSE] flag mean
d730: 73 20 74 68 65 20 66 69 6c 65 20 73 68 6f 75 6c  s the file shoul
d740: 64 20 62 65 0a 2a 2a 20 64 65 6c 65 74 65 64 20  d be.** deleted 
d750: 77 68 65 6e 20 69 74 20 69 73 20 63 6c 6f 73 65  when it is close
d760: 64 2e 20 20 5e 54 68 65 20 5b 53 51 4c 49 54 45  d.  ^The [SQLITE
d770: 5f 4f 50 45 4e 5f 44 45 4c 45 54 45 4f 4e 43 4c  _OPEN_DELETEONCL
d780: 4f 53 45 5d 0a 2a 2a 20 77 69 6c 6c 20 62 65 20  OSE].** will be 
d790: 73 65 74 20 66 6f 72 20 54 45 4d 50 20 64 61 74  set for TEMP dat
d7a0: 61 62 61 73 65 73 20 61 6e 64 20 74 68 65 69 72  abases and their
d7b0: 20 6a 6f 75 72 6e 61 6c 73 2c 20 74 72 61 6e 73   journals, trans
d7c0: 69 65 6e 74 0a 2a 2a 20 64 61 74 61 62 61 73 65  ient.** database
d7d0: 73 2c 20 61 6e 64 20 73 75 62 6a 6f 75 72 6e 61  s, and subjourna
d7e0: 6c 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 5b  ls..**.** ^The [
d7f0: 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 45 58 43 4c  SQLITE_OPEN_EXCL
d800: 55 53 49 56 45 5d 20 66 6c 61 67 20 69 73 20 61  USIVE] flag is a
d810: 6c 77 61 79 73 20 75 73 65 64 20 69 6e 20 63 6f  lways used in co
d820: 6e 6a 75 6e 63 74 69 6f 6e 0a 2a 2a 20 77 69 74  njunction.** wit
d830: 68 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 4f 50  h the [SQLITE_OP
d840: 45 4e 5f 43 52 45 41 54 45 5d 20 66 6c 61 67 2c  EN_CREATE] flag,
d850: 20 77 68 69 63 68 20 61 72 65 20 62 6f 74 68 20   which are both 
d860: 64 69 72 65 63 74 6c 79 0a 2a 2a 20 61 6e 61 6c  directly.** anal
d870: 6f 67 6f 75 73 20 74 6f 20 74 68 65 20 4f 5f 45  ogous to the O_E
d880: 58 43 4c 20 61 6e 64 20 4f 5f 43 52 45 41 54 20  XCL and O_CREAT 
d890: 66 6c 61 67 73 20 6f 66 20 74 68 65 20 50 4f 53  flags of the POS
d8a0: 49 58 20 6f 70 65 6e 28 29 0a 2a 2a 20 41 50 49  IX open().** API
d8b0: 2e 20 20 54 68 65 20 53 51 4c 49 54 45 5f 4f 50  .  The SQLITE_OP
d8c0: 45 4e 5f 45 58 43 4c 55 53 49 56 45 20 66 6c 61  EN_EXCLUSIVE fla
d8d0: 67 2c 20 77 68 65 6e 20 70 61 69 72 65 64 20 77  g, when paired w
d8e0: 69 74 68 20 74 68 65 20 0a 2a 2a 20 53 51 4c 49  ith the .** SQLI
d8f0: 54 45 5f 4f 50 45 4e 5f 43 52 45 41 54 45 2c 20  TE_OPEN_CREATE, 
d900: 69 73 20 75 73 65 64 20 74 6f 20 69 6e 64 69 63  is used to indic
d910: 61 74 65 20 74 68 61 74 20 66 69 6c 65 20 73 68  ate that file sh
d920: 6f 75 6c 64 20 61 6c 77 61 79 73 0a 2a 2a 20 62  ould always.** b
d930: 65 20 63 72 65 61 74 65 64 2c 20 61 6e 64 20 74  e created, and t
d940: 68 61 74 20 69 74 20 69 73 20 61 6e 20 65 72 72  hat it is an err
d950: 6f 72 20 69 66 20 69 74 20 61 6c 72 65 61 64 79  or if it already
d960: 20 65 78 69 73 74 73 2e 0a 2a 2a 20 49 74 20 69   exists..** It i
d970: 73 20 3c 69 3e 6e 6f 74 3c 2f 69 3e 20 75 73 65  s <i>not</i> use
d980: 64 20 74 6f 20 69 6e 64 69 63 61 74 65 20 74 68  d to indicate th
d990: 65 20 66 69 6c 65 20 73 68 6f 75 6c 64 20 62 65  e file should be
d9a0: 20 6f 70 65 6e 65 64 20 0a 2a 2a 20 66 6f 72 20   opened .** for 
d9b0: 65 78 63 6c 75 73 69 76 65 20 61 63 63 65 73 73  exclusive access
d9c0: 2e 0a 2a 2a 0a 2a 2a 20 5e 41 74 20 6c 65 61 73  ..**.** ^At leas
d9d0: 74 20 73 7a 4f 73 46 69 6c 65 20 62 79 74 65 73  t szOsFile bytes
d9e0: 20 6f 66 20 6d 65 6d 6f 72 79 20 61 72 65 20 61   of memory are a
d9f0: 6c 6c 6f 63 61 74 65 64 20 62 79 20 53 51 4c 69  llocated by SQLi
da00: 74 65 0a 2a 2a 20 74 6f 20 68 6f 6c 64 20 74 68  te.** to hold th
da10: 65 20 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65  e  [sqlite3_file
da20: 5d 20 73 74 72 75 63 74 75 72 65 20 70 61 73 73  ] structure pass
da30: 65 64 20 61 73 20 74 68 65 20 74 68 69 72 64 0a  ed as the third.
da40: 2a 2a 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 78  ** argument to x
da50: 4f 70 65 6e 2e 20 20 54 68 65 20 78 4f 70 65 6e  Open.  The xOpen
da60: 20 6d 65 74 68 6f 64 20 64 6f 65 73 20 6e 6f 74   method does not
da70: 20 68 61 76 65 20 74 6f 0a 2a 2a 20 61 6c 6c 6f   have to.** allo
da80: 63 61 74 65 20 74 68 65 20 73 74 72 75 63 74 75  cate the structu
da90: 72 65 3b 20 69 74 20 73 68 6f 75 6c 64 20 6a 75  re; it should ju
daa0: 73 74 20 66 69 6c 6c 20 69 74 20 69 6e 2e 20 20  st fill it in.  
dab0: 4e 6f 74 65 20 74 68 61 74 0a 2a 2a 20 74 68 65  Note that.** the
dac0: 20 78 4f 70 65 6e 20 6d 65 74 68 6f 64 20 6d 75   xOpen method mu
dad0: 73 74 20 73 65 74 20 74 68 65 20 73 71 6c 69 74  st set the sqlit
dae0: 65 33 5f 66 69 6c 65 2e 70 4d 65 74 68 6f 64 73  e3_file.pMethods
daf0: 20 74 6f 20 65 69 74 68 65 72 0a 2a 2a 20 61 20   to either.** a 
db00: 76 61 6c 69 64 20 5b 73 71 6c 69 74 65 33 5f 69  valid [sqlite3_i
db10: 6f 5f 6d 65 74 68 6f 64 73 5d 20 6f 62 6a 65 63  o_methods] objec
db20: 74 20 6f 72 20 74 6f 20 4e 55 4c 4c 2e 20 20 78  t or to NULL.  x
db30: 4f 70 65 6e 20 6d 75 73 74 20 64 6f 0a 2a 2a 20  Open must do.** 
db40: 74 68 69 73 20 65 76 65 6e 20 69 66 20 74 68 65  this even if the
db50: 20 6f 70 65 6e 20 66 61 69 6c 73 2e 20 20 53 51   open fails.  SQ
db60: 4c 69 74 65 20 65 78 70 65 63 74 73 20 74 68 61  Lite expects tha
db70: 74 20 74 68 65 20 73 71 6c 69 74 65 33 5f 66 69  t the sqlite3_fi
db80: 6c 65 2e 70 4d 65 74 68 6f 64 73 0a 2a 2a 20 65  le.pMethods.** e
db90: 6c 65 6d 65 6e 74 20 77 69 6c 6c 20 62 65 20 76  lement will be v
dba0: 61 6c 69 64 20 61 66 74 65 72 20 78 4f 70 65 6e  alid after xOpen
dbb0: 20 72 65 74 75 72 6e 73 20 72 65 67 61 72 64 6c   returns regardl
dbc0: 65 73 73 20 6f 66 20 74 68 65 20 73 75 63 63 65  ess of the succe
dbd0: 73 73 0a 2a 2a 20 6f 72 20 66 61 69 6c 75 72 65  ss.** or failure
dbe0: 20 6f 66 20 74 68 65 20 78 4f 70 65 6e 20 63 61   of the xOpen ca
dbf0: 6c 6c 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 73 71 6c 69  ll..**.** [[sqli
dc00: 74 65 33 5f 76 66 73 2e 78 41 63 63 65 73 73 5d  te3_vfs.xAccess]
dc10: 5d 0a 2a 2a 20 5e 54 68 65 20 66 6c 61 67 73 20  ].** ^The flags 
dc20: 61 72 67 75 6d 65 6e 74 20 74 6f 20 78 41 63 63  argument to xAcc
dc30: 65 73 73 28 29 20 6d 61 79 20 62 65 20 5b 53 51  ess() may be [SQ
dc40: 4c 49 54 45 5f 41 43 43 45 53 53 5f 45 58 49 53  LITE_ACCESS_EXIS
dc50: 54 53 5d 0a 2a 2a 20 74 6f 20 74 65 73 74 20 66  TS].** to test f
dc60: 6f 72 20 74 68 65 20 65 78 69 73 74 65 6e 63 65  or the existence
dc70: 20 6f 66 20 61 20 66 69 6c 65 2c 20 6f 72 20 5b   of a file, or [
dc80: 53 51 4c 49 54 45 5f 41 43 43 45 53 53 5f 52 45  SQLITE_ACCESS_RE
dc90: 41 44 57 52 49 54 45 5d 20 74 6f 0a 2a 2a 20 74  ADWRITE] to.** t
dca0: 65 73 74 20 77 68 65 74 68 65 72 20 61 20 66 69  est whether a fi
dcb0: 6c 65 20 69 73 20 72 65 61 64 61 62 6c 65 20 61  le is readable a
dcc0: 6e 64 20 77 72 69 74 61 62 6c 65 2c 20 6f 72 20  nd writable, or 
dcd0: 5b 53 51 4c 49 54 45 5f 41 43 43 45 53 53 5f 52  [SQLITE_ACCESS_R
dce0: 45 41 44 5d 0a 2a 2a 20 74 6f 20 74 65 73 74 20  EAD].** to test 
dcf0: 77 68 65 74 68 65 72 20 61 20 66 69 6c 65 20 69  whether a file i
dd00: 73 20 61 74 20 6c 65 61 73 74 20 72 65 61 64 61  s at least reada
dd10: 62 6c 65 2e 20 20 20 54 68 65 20 66 69 6c 65 20  ble.   The file 
dd20: 63 61 6e 20 62 65 20 61 0a 2a 2a 20 64 69 72 65  can be a.** dire
dd30: 63 74 6f 72 79 2e 0a 2a 2a 0a 2a 2a 20 5e 53 51  ctory..**.** ^SQ
dd40: 4c 69 74 65 20 77 69 6c 6c 20 61 6c 77 61 79 73  Lite will always
dd50: 20 61 6c 6c 6f 63 61 74 65 20 61 74 20 6c 65 61   allocate at lea
dd60: 73 74 20 6d 78 50 61 74 68 6e 61 6d 65 2b 31 20  st mxPathname+1 
dd70: 62 79 74 65 73 20 66 6f 72 20 74 68 65 0a 2a 2a  bytes for the.**
dd80: 20 6f 75 74 70 75 74 20 62 75 66 66 65 72 20 78   output buffer x
dd90: 46 75 6c 6c 50 61 74 68 6e 61 6d 65 2e 20 20 54  FullPathname.  T
dda0: 68 65 20 65 78 61 63 74 20 73 69 7a 65 20 6f 66  he exact size of
ddb0: 20 74 68 65 20 6f 75 74 70 75 74 20 62 75 66 66   the output buff
ddc0: 65 72 0a 2a 2a 20 69 73 20 61 6c 73 6f 20 70 61  er.** is also pa
ddd0: 73 73 65 64 20 61 73 20 61 20 70 61 72 61 6d 65  ssed as a parame
dde0: 74 65 72 20 74 6f 20 62 6f 74 68 20 20 6d 65 74  ter to both  met
ddf0: 68 6f 64 73 2e 20 49 66 20 74 68 65 20 6f 75 74  hods. If the out
de00: 70 75 74 20 62 75 66 66 65 72 0a 2a 2a 20 69 73  put buffer.** is
de10: 20 6e 6f 74 20 6c 61 72 67 65 20 65 6e 6f 75 67   not large enoug
de20: 68 2c 20 5b 53 51 4c 49 54 45 5f 43 41 4e 54 4f  h, [SQLITE_CANTO
de30: 50 45 4e 5d 20 73 68 6f 75 6c 64 20 62 65 20 72  PEN] should be r
de40: 65 74 75 72 6e 65 64 2e 20 53 69 6e 63 65 20 74  eturned. Since t
de50: 68 69 73 20 69 73 0a 2a 2a 20 68 61 6e 64 6c 65  his is.** handle
de60: 64 20 61 73 20 61 20 66 61 74 61 6c 20 65 72 72  d as a fatal err
de70: 6f 72 20 62 79 20 53 51 4c 69 74 65 2c 20 76 66  or by SQLite, vf
de80: 73 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  s implementation
de90: 73 20 73 68 6f 75 6c 64 20 65 6e 64 65 61 76 6f  s should endeavo
dea0: 72 0a 2a 2a 20 74 6f 20 70 72 65 76 65 6e 74 20  r.** to prevent 
deb0: 74 68 69 73 20 62 79 20 73 65 74 74 69 6e 67 20  this by setting 
dec0: 6d 78 50 61 74 68 6e 61 6d 65 20 74 6f 20 61 20  mxPathname to a 
ded0: 73 75 66 66 69 63 69 65 6e 74 6c 79 20 6c 61 72  sufficiently lar
dee0: 67 65 20 76 61 6c 75 65 2e 0a 2a 2a 0a 2a 2a 20  ge value..**.** 
def0: 54 68 65 20 78 52 61 6e 64 6f 6d 6e 65 73 73 28  The xRandomness(
df00: 29 2c 20 78 53 6c 65 65 70 28 29 2c 20 78 43 75  ), xSleep(), xCu
df10: 72 72 65 6e 74 54 69 6d 65 28 29 2c 20 61 6e 64  rrentTime(), and
df20: 20 78 43 75 72 72 65 6e 74 54 69 6d 65 49 6e 74   xCurrentTimeInt
df30: 36 34 28 29 0a 2a 2a 20 69 6e 74 65 72 66 61 63  64().** interfac
df40: 65 73 20 61 72 65 20 6e 6f 74 20 73 74 72 69 63  es are not stric
df50: 74 6c 79 20 61 20 70 61 72 74 20 6f 66 20 74 68  tly a part of th
df60: 65 20 66 69 6c 65 73 79 73 74 65 6d 2c 20 62 75  e filesystem, bu
df70: 74 20 74 68 65 79 20 61 72 65 0a 2a 2a 20 69 6e  t they are.** in
df80: 63 6c 75 64 65 64 20 69 6e 20 74 68 65 20 56 46  cluded in the VF
df90: 53 20 73 74 72 75 63 74 75 72 65 20 66 6f 72 20  S structure for 
dfa0: 63 6f 6d 70 6c 65 74 65 6e 65 73 73 2e 0a 2a 2a  completeness..**
dfb0: 20 54 68 65 20 78 52 61 6e 64 6f 6d 6e 65 73 73   The xRandomness
dfc0: 28 29 20 66 75 6e 63 74 69 6f 6e 20 61 74 74 65  () function atte
dfd0: 6d 70 74 73 20 74 6f 20 72 65 74 75 72 6e 20 6e  mpts to return n
dfe0: 42 79 74 65 73 20 62 79 74 65 73 0a 2a 2a 20 6f  Bytes bytes.** o
dff0: 66 20 67 6f 6f 64 2d 71 75 61 6c 69 74 79 20 72  f good-quality r
e000: 61 6e 64 6f 6d 6e 65 73 73 20 69 6e 74 6f 20 7a  andomness into z
e010: 4f 75 74 2e 20 20 54 68 65 20 72 65 74 75 72 6e  Out.  The return
e020: 20 76 61 6c 75 65 20 69 73 0a 2a 2a 20 74 68 65   value is.** the
e030: 20 61 63 74 75 61 6c 20 6e 75 6d 62 65 72 20 6f   actual number o
e040: 66 20 62 79 74 65 73 20 6f 66 20 72 61 6e 64 6f  f bytes of rando
e050: 6d 6e 65 73 73 20 6f 62 74 61 69 6e 65 64 2e 0a  mness obtained..
e060: 2a 2a 20 54 68 65 20 78 53 6c 65 65 70 28 29 20  ** The xSleep() 
e070: 6d 65 74 68 6f 64 20 63 61 75 73 65 73 20 74 68  method causes th
e080: 65 20 63 61 6c 6c 69 6e 67 20 74 68 72 65 61 64  e calling thread
e090: 20 74 6f 20 73 6c 65 65 70 20 66 6f 72 20 61 74   to sleep for at
e0a0: 0a 2a 2a 20 6c 65 61 73 74 20 74 68 65 20 6e 75  .** least the nu
e0b0: 6d 62 65 72 20 6f 66 20 6d 69 63 72 6f 73 65 63  mber of microsec
e0c0: 6f 6e 64 73 20 67 69 76 65 6e 2e 20 20 5e 54 68  onds given.  ^Th
e0d0: 65 20 78 43 75 72 72 65 6e 74 54 69 6d 65 28 29  e xCurrentTime()
e0e0: 0a 2a 2a 20 6d 65 74 68 6f 64 20 72 65 74 75 72  .** method retur
e0f0: 6e 73 20 61 20 4a 75 6c 69 61 6e 20 44 61 79 20  ns a Julian Day 
e100: 4e 75 6d 62 65 72 20 66 6f 72 20 74 68 65 20 63  Number for the c
e110: 75 72 72 65 6e 74 20 64 61 74 65 20 61 6e 64 20  urrent date and 
e120: 74 69 6d 65 20 61 73 0a 2a 2a 20 61 20 66 6c 6f  time as.** a flo
e130: 61 74 69 6e 67 20 70 6f 69 6e 74 20 76 61 6c 75  ating point valu
e140: 65 2e 0a 2a 2a 20 5e 54 68 65 20 78 43 75 72 72  e..** ^The xCurr
e150: 65 6e 74 54 69 6d 65 49 6e 74 36 34 28 29 20 6d  entTimeInt64() m
e160: 65 74 68 6f 64 20 72 65 74 75 72 6e 73 2c 20 61  ethod returns, a
e170: 73 20 61 6e 20 69 6e 74 65 67 65 72 2c 20 74 68  s an integer, th
e180: 65 20 4a 75 6c 69 61 6e 0a 2a 2a 20 44 61 79 20  e Julian.** Day 
e190: 4e 75 6d 62 65 72 20 6d 75 6c 74 69 70 6c 69 65  Number multiplie
e1a0: 64 20 62 79 20 38 36 34 30 30 30 30 30 20 28 74  d by 86400000 (t
e1b0: 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 6d 69 6c  he number of mil
e1c0: 6c 69 73 65 63 6f 6e 64 73 20 69 6e 20 0a 2a 2a  liseconds in .**
e1d0: 20 61 20 32 34 2d 68 6f 75 72 20 64 61 79 29 2e   a 24-hour day).
e1e0: 20 20 0a 2a 2a 20 5e 53 51 4c 69 74 65 20 77 69    .** ^SQLite wi
e1f0: 6c 6c 20 75 73 65 20 74 68 65 20 78 43 75 72 72  ll use the xCurr
e200: 65 6e 74 54 69 6d 65 49 6e 74 36 34 28 29 20 6d  entTimeInt64() m
e210: 65 74 68 6f 64 20 74 6f 20 67 65 74 20 74 68 65  ethod to get the
e220: 20 63 75 72 72 65 6e 74 0a 2a 2a 20 64 61 74 65   current.** date
e230: 20 61 6e 64 20 74 69 6d 65 20 69 66 20 74 68 61   and time if tha
e240: 74 20 6d 65 74 68 6f 64 20 69 73 20 61 76 61 69  t method is avai
e250: 6c 61 62 6c 65 20 28 69 66 20 69 56 65 72 73 69  lable (if iVersi
e260: 6f 6e 20 69 73 20 32 20 6f 72 20 0a 2a 2a 20 67  on is 2 or .** g
e270: 72 65 61 74 65 72 20 61 6e 64 20 74 68 65 20 66  reater and the f
e280: 75 6e 63 74 69 6f 6e 20 70 6f 69 6e 74 65 72 20  unction pointer 
e290: 69 73 20 6e 6f 74 20 4e 55 4c 4c 29 20 61 6e 64  is not NULL) and
e2a0: 20 77 69 6c 6c 20 66 61 6c 6c 20 62 61 63 6b 0a   will fall back.
e2b0: 2a 2a 20 74 6f 20 78 43 75 72 72 65 6e 74 54 69  ** to xCurrentTi
e2c0: 6d 65 28 29 20 69 66 20 78 43 75 72 72 65 6e 74  me() if xCurrent
e2d0: 54 69 6d 65 49 6e 74 36 34 28 29 20 69 73 20 75  TimeInt64() is u
e2e0: 6e 61 76 61 69 6c 61 62 6c 65 2e 0a 2a 2a 0a 2a  navailable..**.*
e2f0: 2a 20 5e 54 68 65 20 78 53 65 74 53 79 73 74 65  * ^The xSetSyste
e300: 6d 43 61 6c 6c 28 29 2c 20 78 47 65 74 53 79 73  mCall(), xGetSys
e310: 74 65 6d 43 61 6c 6c 28 29 2c 20 61 6e 64 20 78  temCall(), and x
e320: 4e 65 73 74 53 79 73 74 65 6d 43 61 6c 6c 28 29  NestSystemCall()
e330: 20 69 6e 74 65 72 66 61 63 65 73 0a 2a 2a 20 61   interfaces.** a
e340: 72 65 20 6e 6f 74 20 75 73 65 64 20 62 79 20 74  re not used by t
e350: 68 65 20 53 51 4c 69 74 65 20 63 6f 72 65 2e 20  he SQLite core. 
e360: 20 54 68 65 73 65 20 6f 70 74 69 6f 6e 61 6c 20   These optional 
e370: 69 6e 74 65 72 66 61 63 65 73 20 61 72 65 20 70  interfaces are p
e380: 72 6f 76 69 64 65 64 0a 2a 2a 20 62 79 20 73 6f  rovided.** by so
e390: 6d 65 20 56 46 53 65 73 20 74 6f 20 66 61 63 69  me VFSes to faci
e3a0: 6c 69 74 61 74 65 20 74 65 73 74 69 6e 67 20 6f  litate testing o
e3b0: 66 20 74 68 65 20 56 46 53 20 63 6f 64 65 2e 20  f the VFS code. 
e3c0: 42 79 20 6f 76 65 72 72 69 64 69 6e 67 20 0a 2a  By overriding .*
e3d0: 2a 20 73 79 73 74 65 6d 20 63 61 6c 6c 73 20 77  * system calls w
e3e0: 69 74 68 20 66 75 6e 63 74 69 6f 6e 73 20 75 6e  ith functions un
e3f0: 64 65 72 20 69 74 73 20 63 6f 6e 74 72 6f 6c 2c  der its control,
e400: 20 61 20 74 65 73 74 20 70 72 6f 67 72 61 6d 20   a test program 
e410: 63 61 6e 0a 2a 2a 20 73 69 6d 75 6c 61 74 65 20  can.** simulate 
e420: 66 61 75 6c 74 73 20 61 6e 64 20 65 72 72 6f 72  faults and error
e430: 20 63 6f 6e 64 69 74 69 6f 6e 73 20 74 68 61 74   conditions that
e440: 20 77 6f 75 6c 64 20 6f 74 68 65 72 77 69 73 65   would otherwise
e450: 20 62 65 20 64 69 66 66 69 63 75 6c 74 0a 2a 2a   be difficult.**
e460: 20 6f 72 20 69 6d 70 6f 73 73 69 62 6c 65 20 74   or impossible t
e470: 6f 20 69 6e 64 75 63 65 2e 20 20 54 68 65 20 73  o induce.  The s
e480: 65 74 20 6f 66 20 73 79 73 74 65 6d 20 63 61 6c  et of system cal
e490: 6c 73 20 74 68 61 74 20 63 61 6e 20 62 65 20 6f  ls that can be o
e4a0: 76 65 72 72 69 64 64 65 6e 0a 2a 2a 20 76 61 72  verridden.** var
e4b0: 69 65 73 20 66 72 6f 6d 20 6f 6e 65 20 56 46 53  ies from one VFS
e4c0: 20 74 6f 20 61 6e 6f 74 68 65 72 2c 20 61 6e 64   to another, and
e4d0: 20 66 72 6f 6d 20 6f 6e 65 20 76 65 72 73 69 6f   from one versio
e4e0: 6e 20 6f 66 20 74 68 65 20 73 61 6d 65 20 56 46  n of the same VF
e4f0: 53 20 74 6f 20 74 68 65 0a 2a 2a 20 6e 65 78 74  S to the.** next
e500: 2e 20 20 41 70 70 6c 69 63 61 74 69 6f 6e 73 20  .  Applications 
e510: 74 68 61 74 20 75 73 65 20 74 68 65 73 65 20 69  that use these i
e520: 6e 74 65 72 66 61 63 65 73 20 6d 75 73 74 20 62  nterfaces must b
e530: 65 20 70 72 65 70 61 72 65 64 20 66 6f 72 20 61  e prepared for a
e540: 6e 79 0a 2a 2a 20 6f 72 20 61 6c 6c 20 6f 66 20  ny.** or all of 
e550: 74 68 65 73 65 20 69 6e 74 65 72 66 61 63 65 73  these interfaces
e560: 20 74 6f 20 62 65 20 4e 55 4c 4c 20 6f 72 20 66   to be NULL or f
e570: 6f 72 20 74 68 65 69 72 20 62 65 68 61 76 69 6f  or their behavio
e580: 72 20 74 6f 20 63 68 61 6e 67 65 0a 2a 2a 20 66  r to change.** f
e590: 72 6f 6d 20 6f 6e 65 20 72 65 6c 65 61 73 65 20  rom one release 
e5a0: 74 6f 20 74 68 65 20 6e 65 78 74 2e 20 20 41 70  to the next.  Ap
e5b0: 70 6c 69 63 61 74 69 6f 6e 73 20 6d 75 73 74 20  plications must 
e5c0: 6e 6f 74 20 61 74 74 65 6d 70 74 20 74 6f 20 61  not attempt to a
e5d0: 63 63 65 73 73 0a 2a 2a 20 61 6e 79 20 6f 66 20  ccess.** any of 
e5e0: 74 68 65 73 65 20 6d 65 74 68 6f 64 73 20 69 66  these methods if
e5f0: 20 74 68 65 20 69 56 65 72 73 69 6f 6e 20 6f 66   the iVersion of
e600: 20 74 68 65 20 56 46 53 20 69 73 20 6c 65 73 73   the VFS is less
e610: 20 74 68 61 6e 20 33 2e 0a 2a 2f 0a 74 79 70 65   than 3..*/.type
e620: 64 65 66 20 73 74 72 75 63 74 20 73 71 6c 69 74  def struct sqlit
e630: 65 33 5f 76 66 73 20 73 71 6c 69 74 65 33 5f 76  e3_vfs sqlite3_v
e640: 66 73 3b 0a 74 79 70 65 64 65 66 20 76 6f 69 64  fs;.typedef void
e650: 20 28 2a 73 71 6c 69 74 65 33 5f 73 79 73 63 61   (*sqlite3_sysca
e660: 6c 6c 5f 70 74 72 29 28 76 6f 69 64 29 3b 0a 73  ll_ptr)(void);.s
e670: 74 72 75 63 74 20 73 71 6c 69 74 65 33 5f 76 66  truct sqlite3_vf
e680: 73 20 7b 0a 20 20 69 6e 74 20 69 56 65 72 73 69  s {.  int iVersi
e690: 6f 6e 3b 20 20 20 20 20 20 20 20 20 20 20 20 2f  on;            /
e6a0: 2a 20 53 74 72 75 63 74 75 72 65 20 76 65 72 73  * Structure vers
e6b0: 69 6f 6e 20 6e 75 6d 62 65 72 20 28 63 75 72 72  ion number (curr
e6c0: 65 6e 74 6c 79 20 33 29 20 2a 2f 0a 20 20 69 6e  ently 3) */.  in
e6d0: 74 20 73 7a 4f 73 46 69 6c 65 3b 20 20 20 20 20  t szOsFile;     
e6e0: 20 20 20 20 20 20 20 2f 2a 20 53 69 7a 65 20 6f         /* Size o
e6f0: 66 20 73 75 62 63 6c 61 73 73 65 64 20 73 71 6c  f subclassed sql
e700: 69 74 65 33 5f 66 69 6c 65 20 2a 2f 0a 20 20 69  ite3_file */.  i
e710: 6e 74 20 6d 78 50 61 74 68 6e 61 6d 65 3b 20 20  nt mxPathname;  
e720: 20 20 20 20 20 20 20 20 2f 2a 20 4d 61 78 69 6d          /* Maxim
e730: 75 6d 20 66 69 6c 65 20 70 61 74 68 6e 61 6d 65  um file pathname
e740: 20 6c 65 6e 67 74 68 20 2a 2f 0a 20 20 73 71 6c   length */.  sql
e750: 69 74 65 33 5f 76 66 73 20 2a 70 4e 65 78 74 3b  ite3_vfs *pNext;
e760: 20 20 20 20 20 20 2f 2a 20 4e 65 78 74 20 72 65        /* Next re
e770: 67 69 73 74 65 72 65 64 20 56 46 53 20 2a 2f 0a  gistered VFS */.
e780: 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 4e    const char *zN
e790: 61 6d 65 3b 20 20 20 20 20 20 20 2f 2a 20 4e 61  ame;       /* Na
e7a0: 6d 65 20 6f 66 20 74 68 69 73 20 76 69 72 74 75  me of this virtu
e7b0: 61 6c 20 66 69 6c 65 20 73 79 73 74 65 6d 20 2a  al file system *
e7c0: 2f 0a 20 20 76 6f 69 64 20 2a 70 41 70 70 44 61  /.  void *pAppDa
e7d0: 74 61 3b 20 20 20 20 20 20 20 20 20 20 2f 2a 20  ta;          /* 
e7e0: 50 6f 69 6e 74 65 72 20 74 6f 20 61 70 70 6c 69  Pointer to appli
e7f0: 63 61 74 69 6f 6e 2d 73 70 65 63 69 66 69 63 20  cation-specific 
e800: 64 61 74 61 20 2a 2f 0a 20 20 69 6e 74 20 28 2a  data */.  int (*
e810: 78 4f 70 65 6e 29 28 73 71 6c 69 74 65 33 5f 76  xOpen)(sqlite3_v
e820: 66 73 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72 20  fs*, const char 
e830: 2a 7a 4e 61 6d 65 2c 20 73 71 6c 69 74 65 33 5f  *zName, sqlite3_
e840: 66 69 6c 65 2a 2c 0a 20 20 20 20 20 20 20 20 20  file*,.         
e850: 20 20 20 20 20 20 69 6e 74 20 66 6c 61 67 73 2c        int flags,
e860: 20 69 6e 74 20 2a 70 4f 75 74 46 6c 61 67 73 29   int *pOutFlags)
e870: 3b 0a 20 20 69 6e 74 20 28 2a 78 44 65 6c 65 74  ;.  int (*xDelet
e880: 65 29 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c  e)(sqlite3_vfs*,
e890: 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 4e 61   const char *zNa
e8a0: 6d 65 2c 20 69 6e 74 20 73 79 6e 63 44 69 72 29  me, int syncDir)
e8b0: 3b 0a 20 20 69 6e 74 20 28 2a 78 41 63 63 65 73  ;.  int (*xAcces
e8c0: 73 29 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c  s)(sqlite3_vfs*,
e8d0: 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 4e 61   const char *zNa
e8e0: 6d 65 2c 20 69 6e 74 20 66 6c 61 67 73 2c 20 69  me, int flags, i
e8f0: 6e 74 20 2a 70 52 65 73 4f 75 74 29 3b 0a 20 20  nt *pResOut);.  
e900: 69 6e 74 20 28 2a 78 46 75 6c 6c 50 61 74 68 6e  int (*xFullPathn
e910: 61 6d 65 29 28 73 71 6c 69 74 65 33 5f 76 66 73  ame)(sqlite3_vfs
e920: 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a  *, const char *z
e930: 4e 61 6d 65 2c 20 69 6e 74 20 6e 4f 75 74 2c 20  Name, int nOut, 
e940: 63 68 61 72 20 2a 7a 4f 75 74 29 3b 0a 20 20 76  char *zOut);.  v
e950: 6f 69 64 20 2a 28 2a 78 44 6c 4f 70 65 6e 29 28  oid *(*xDlOpen)(
e960: 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 63 6f  sqlite3_vfs*, co
e970: 6e 73 74 20 63 68 61 72 20 2a 7a 46 69 6c 65 6e  nst char *zFilen
e980: 61 6d 65 29 3b 0a 20 20 76 6f 69 64 20 28 2a 78  ame);.  void (*x
e990: 44 6c 45 72 72 6f 72 29 28 73 71 6c 69 74 65 33  DlError)(sqlite3
e9a0: 5f 76 66 73 2a 2c 20 69 6e 74 20 6e 42 79 74 65  _vfs*, int nByte
e9b0: 2c 20 63 68 61 72 20 2a 7a 45 72 72 4d 73 67 29  , char *zErrMsg)
e9c0: 3b 0a 20 20 76 6f 69 64 20 28 2a 28 2a 78 44 6c  ;.  void (*(*xDl
e9d0: 53 79 6d 29 28 73 71 6c 69 74 65 33 5f 76 66 73  Sym)(sqlite3_vfs
e9e0: 2a 2c 76 6f 69 64 2a 2c 20 63 6f 6e 73 74 20 63  *,void*, const c
e9f0: 68 61 72 20 2a 7a 53 79 6d 62 6f 6c 29 29 28 76  har *zSymbol))(v
ea00: 6f 69 64 29 3b 0a 20 20 76 6f 69 64 20 28 2a 78  oid);.  void (*x
ea10: 44 6c 43 6c 6f 73 65 29 28 73 71 6c 69 74 65 33  DlClose)(sqlite3
ea20: 5f 76 66 73 2a 2c 20 76 6f 69 64 2a 29 3b 0a 20  _vfs*, void*);. 
ea30: 20 69 6e 74 20 28 2a 78 52 61 6e 64 6f 6d 6e 65   int (*xRandomne
ea40: 73 73 29 28 73 71 6c 69 74 65 33 5f 76 66 73 2a  ss)(sqlite3_vfs*
ea50: 2c 20 69 6e 74 20 6e 42 79 74 65 2c 20 63 68 61  , int nByte, cha
ea60: 72 20 2a 7a 4f 75 74 29 3b 0a 20 20 69 6e 74 20  r *zOut);.  int 
ea70: 28 2a 78 53 6c 65 65 70 29 28 73 71 6c 69 74 65  (*xSleep)(sqlite
ea80: 33 5f 76 66 73 2a 2c 20 69 6e 74 20 6d 69 63 72  3_vfs*, int micr
ea90: 6f 73 65 63 6f 6e 64 73 29 3b 0a 20 20 69 6e 74  oseconds);.  int
eaa0: 20 28 2a 78 43 75 72 72 65 6e 74 54 69 6d 65 29   (*xCurrentTime)
eab0: 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 64  (sqlite3_vfs*, d
eac0: 6f 75 62 6c 65 2a 29 3b 0a 20 20 69 6e 74 20 28  ouble*);.  int (
ead0: 2a 78 47 65 74 4c 61 73 74 45 72 72 6f 72 29 28  *xGetLastError)(
eae0: 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 69 6e  sqlite3_vfs*, in
eaf0: 74 2c 20 63 68 61 72 20 2a 29 3b 0a 20 20 2f 2a  t, char *);.  /*
eb00: 0a 20 20 2a 2a 20 54 68 65 20 6d 65 74 68 6f 64  .  ** The method
eb10: 73 20 61 62 6f 76 65 20 61 72 65 20 69 6e 20 76  s above are in v
eb20: 65 72 73 69 6f 6e 20 31 20 6f 66 20 74 68 65 20  ersion 1 of the 
eb30: 73 71 6c 69 74 65 5f 76 66 73 20 6f 62 6a 65 63  sqlite_vfs objec
eb40: 74 0a 20 20 2a 2a 20 64 65 66 69 6e 69 74 69 6f  t.  ** definitio
eb50: 6e 2e 20 20 54 68 6f 73 65 20 74 68 61 74 20 66  n.  Those that f
eb60: 6f 6c 6c 6f 77 20 61 72 65 20 61 64 64 65 64 20  ollow are added 
eb70: 69 6e 20 76 65 72 73 69 6f 6e 20 32 20 6f 72 20  in version 2 or 
eb80: 6c 61 74 65 72 0a 20 20 2a 2f 0a 20 20 69 6e 74  later.  */.  int
eb90: 20 28 2a 78 43 75 72 72 65 6e 74 54 69 6d 65 49   (*xCurrentTimeI
eba0: 6e 74 36 34 29 28 73 71 6c 69 74 65 33 5f 76 66  nt64)(sqlite3_vf
ebb0: 73 2a 2c 20 73 71 6c 69 74 65 33 5f 69 6e 74 36  s*, sqlite3_int6
ebc0: 34 2a 29 3b 0a 20 20 2f 2a 0a 20 20 2a 2a 20 54  4*);.  /*.  ** T
ebd0: 68 65 20 6d 65 74 68 6f 64 73 20 61 62 6f 76 65  he methods above
ebe0: 20 61 72 65 20 69 6e 20 76 65 72 73 69 6f 6e 73   are in versions
ebf0: 20 31 20 61 6e 64 20 32 20 6f 66 20 74 68 65 20   1 and 2 of the 
ec00: 73 71 6c 69 74 65 5f 76 66 73 20 6f 62 6a 65 63  sqlite_vfs objec
ec10: 74 2e 0a 20 20 2a 2a 20 54 68 6f 73 65 20 62 65  t..  ** Those be
ec20: 6c 6f 77 20 61 72 65 20 66 6f 72 20 76 65 72 73  low are for vers
ec30: 69 6f 6e 20 33 20 61 6e 64 20 67 72 65 61 74 65  ion 3 and greate
ec40: 72 2e 0a 20 20 2a 2f 0a 20 20 69 6e 74 20 28 2a  r..  */.  int (*
ec50: 78 53 65 74 53 79 73 74 65 6d 43 61 6c 6c 29 28  xSetSystemCall)(
ec60: 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 63 6f  sqlite3_vfs*, co
ec70: 6e 73 74 20 63 68 61 72 20 2a 7a 4e 61 6d 65 2c  nst char *zName,
ec80: 20 73 71 6c 69 74 65 33 5f 73 79 73 63 61 6c 6c   sqlite3_syscall
ec90: 5f 70 74 72 29 3b 0a 20 20 73 71 6c 69 74 65 33  _ptr);.  sqlite3
eca0: 5f 73 79 73 63 61 6c 6c 5f 70 74 72 20 28 2a 78  _syscall_ptr (*x
ecb0: 47 65 74 53 79 73 74 65 6d 43 61 6c 6c 29 28 73  GetSystemCall)(s
ecc0: 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 63 6f 6e  qlite3_vfs*, con
ecd0: 73 74 20 63 68 61 72 20 2a 7a 4e 61 6d 65 29 3b  st char *zName);
ece0: 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 28  .  const char *(
ecf0: 2a 78 4e 65 78 74 53 79 73 74 65 6d 43 61 6c 6c  *xNextSystemCall
ed00: 29 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20  )(sqlite3_vfs*, 
ed10: 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 4e 61 6d  const char *zNam
ed20: 65 29 3b 0a 20 20 2f 2a 0a 20 20 2a 2a 20 54 68  e);.  /*.  ** Th
ed30: 65 20 6d 65 74 68 6f 64 73 20 61 62 6f 76 65 20  e methods above 
ed40: 61 72 65 20 69 6e 20 76 65 72 73 69 6f 6e 73 20  are in versions 
ed50: 31 20 74 68 72 6f 75 67 68 20 33 20 6f 66 20 74  1 through 3 of t
ed60: 68 65 20 73 71 6c 69 74 65 5f 76 66 73 20 6f 62  he sqlite_vfs ob
ed70: 6a 65 63 74 2e 0a 20 20 2a 2a 20 4e 65 77 20 66  ject..  ** New f
ed80: 69 65 6c 64 73 20 6d 61 79 20 62 65 20 61 70 70  ields may be app
ed90: 65 6e 64 65 64 20 69 6e 20 66 75 74 75 72 65 20  ended in future 
eda0: 76 65 72 73 69 6f 6e 73 2e 20 20 54 68 65 20 69  versions.  The i
edb0: 56 65 72 73 69 6f 6e 0a 20 20 2a 2a 20 76 61 6c  Version.  ** val
edc0: 75 65 20 77 69 6c 6c 20 69 6e 63 72 65 6d 65 6e  ue will incremen
edd0: 74 20 77 68 65 6e 65 76 65 72 20 74 68 69 73 20  t whenever this 
ede0: 68 61 70 70 65 6e 73 2e 20 0a 20 20 2a 2f 0a 7d  happens. .  */.}
edf0: 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
ee00: 46 3a 20 46 6c 61 67 73 20 66 6f 72 20 74 68 65  F: Flags for the
ee10: 20 78 41 63 63 65 73 73 20 56 46 53 20 6d 65 74   xAccess VFS met
ee20: 68 6f 64 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20  hod.**.** These 
ee30: 69 6e 74 65 67 65 72 20 63 6f 6e 73 74 61 6e 74  integer constant
ee40: 73 20 63 61 6e 20 62 65 20 75 73 65 64 20 61 73  s can be used as
ee50: 20 74 68 65 20 74 68 69 72 64 20 70 61 72 61 6d   the third param
ee60: 65 74 65 72 20 74 6f 0a 2a 2a 20 74 68 65 20 78  eter to.** the x
ee70: 41 63 63 65 73 73 20 6d 65 74 68 6f 64 20 6f 66  Access method of
ee80: 20 61 6e 20 5b 73 71 6c 69 74 65 33 5f 76 66 73   an [sqlite3_vfs
ee90: 5d 20 6f 62 6a 65 63 74 2e 20 20 54 68 65 79 20  ] object.  They 
eea0: 64 65 74 65 72 6d 69 6e 65 0a 2a 2a 20 77 68 61  determine.** wha
eeb0: 74 20 6b 69 6e 64 20 6f 66 20 70 65 72 6d 69 73  t kind of permis
eec0: 73 69 6f 6e 73 20 74 68 65 20 78 41 63 63 65 73  sions the xAcces
eed0: 73 20 6d 65 74 68 6f 64 20 69 73 20 6c 6f 6f 6b  s method is look
eee0: 69 6e 67 20 66 6f 72 2e 0a 2a 2a 20 57 69 74 68  ing for..** With
eef0: 20 53 51 4c 49 54 45 5f 41 43 43 45 53 53 5f 45   SQLITE_ACCESS_E
ef00: 58 49 53 54 53 2c 20 74 68 65 20 78 41 63 63 65  XISTS, the xAcce
ef10: 73 73 20 6d 65 74 68 6f 64 0a 2a 2a 20 73 69 6d  ss method.** sim
ef20: 70 6c 79 20 63 68 65 63 6b 73 20 77 68 65 74 68  ply checks wheth
ef30: 65 72 20 74 68 65 20 66 69 6c 65 20 65 78 69 73  er the file exis
ef40: 74 73 2e 0a 2a 2a 20 57 69 74 68 20 53 51 4c 49  ts..** With SQLI
ef50: 54 45 5f 41 43 43 45 53 53 5f 52 45 41 44 57 52  TE_ACCESS_READWR
ef60: 49 54 45 2c 20 74 68 65 20 78 41 63 63 65 73 73  ITE, the xAccess
ef70: 20 6d 65 74 68 6f 64 0a 2a 2a 20 63 68 65 63 6b   method.** check
ef80: 73 20 77 68 65 74 68 65 72 20 74 68 65 20 6e 61  s whether the na
ef90: 6d 65 64 20 64 69 72 65 63 74 6f 72 79 20 69 73  med directory is
efa0: 20 62 6f 74 68 20 72 65 61 64 61 62 6c 65 20 61   both readable a
efb0: 6e 64 20 77 72 69 74 61 62 6c 65 0a 2a 2a 20 28  nd writable.** (
efc0: 69 6e 20 6f 74 68 65 72 20 77 6f 72 64 73 2c 20  in other words, 
efd0: 69 66 20 66 69 6c 65 73 20 63 61 6e 20 62 65 20  if files can be 
efe0: 61 64 64 65 64 2c 20 72 65 6d 6f 76 65 64 2c 20  added, removed, 
eff0: 61 6e 64 20 72 65 6e 61 6d 65 64 20 77 69 74 68  and renamed with
f000: 69 6e 0a 2a 2a 20 74 68 65 20 64 69 72 65 63 74  in.** the direct
f010: 6f 72 79 29 2e 0a 2a 2a 20 54 68 65 20 53 51 4c  ory)..** The SQL
f020: 49 54 45 5f 41 43 43 45 53 53 5f 52 45 41 44 57  ITE_ACCESS_READW
f030: 52 49 54 45 20 63 6f 6e 73 74 61 6e 74 20 69 73  RITE constant is
f040: 20 63 75 72 72 65 6e 74 6c 79 20 75 73 65 64 20   currently used 
f050: 6f 6e 6c 79 20 62 79 20 74 68 65 0a 2a 2a 20 5b  only by the.** [
f060: 74 65 6d 70 5f 73 74 6f 72 65 5f 64 69 72 65 63  temp_store_direc
f070: 74 6f 72 79 20 70 72 61 67 6d 61 5d 2c 20 74 68  tory pragma], th
f080: 6f 75 67 68 20 74 68 69 73 20 63 6f 75 6c 64 20  ough this could 
f090: 63 68 61 6e 67 65 20 69 6e 20 61 20 66 75 74 75  change in a futu
f0a0: 72 65 0a 2a 2a 20 72 65 6c 65 61 73 65 20 6f 66  re.** release of
f0b0: 20 53 51 4c 69 74 65 2e 0a 2a 2a 20 57 69 74 68   SQLite..** With
f0c0: 20 53 51 4c 49 54 45 5f 41 43 43 45 53 53 5f 52   SQLITE_ACCESS_R
f0d0: 45 41 44 2c 20 74 68 65 20 78 41 63 63 65 73 73  EAD, the xAccess
f0e0: 20 6d 65 74 68 6f 64 0a 2a 2a 20 63 68 65 63 6b   method.** check
f0f0: 73 20 77 68 65 74 68 65 72 20 74 68 65 20 66 69  s whether the fi
f100: 6c 65 20 69 73 20 72 65 61 64 61 62 6c 65 2e 20  le is readable. 
f110: 20 54 68 65 20 53 51 4c 49 54 45 5f 41 43 43 45   The SQLITE_ACCE
f120: 53 53 5f 52 45 41 44 20 63 6f 6e 73 74 61 6e 74  SS_READ constant
f130: 20 69 73 0a 2a 2a 20 63 75 72 72 65 6e 74 6c 79   is.** currently
f140: 20 75 6e 75 73 65 64 2c 20 74 68 6f 75 67 68 20   unused, though 
f150: 69 74 20 6d 69 67 68 74 20 62 65 20 75 73 65 64  it might be used
f160: 20 69 6e 20 61 20 66 75 74 75 72 65 20 72 65 6c   in a future rel
f170: 65 61 73 65 20 6f 66 0a 2a 2a 20 53 51 4c 69 74  ease of.** SQLit
f180: 65 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  e..*/.#define SQ
f190: 4c 49 54 45 5f 41 43 43 45 53 53 5f 45 58 49 53  LITE_ACCESS_EXIS
f1a0: 54 53 20 20 20 20 30 0a 23 64 65 66 69 6e 65 20  TS    0.#define 
f1b0: 53 51 4c 49 54 45 5f 41 43 43 45 53 53 5f 52 45  SQLITE_ACCESS_RE
f1c0: 41 44 57 52 49 54 45 20 31 20 20 20 2f 2a 20 55  ADWRITE 1   /* U
f1d0: 73 65 64 20 62 79 20 50 52 41 47 4d 41 20 74 65  sed by PRAGMA te
f1e0: 6d 70 5f 73 74 6f 72 65 5f 64 69 72 65 63 74 6f  mp_store_directo
f1f0: 72 79 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  ry */.#define SQ
f200: 4c 49 54 45 5f 41 43 43 45 53 53 5f 52 45 41 44  LITE_ACCESS_READ
f210: 20 20 20 20 20 20 32 20 20 20 2f 2a 20 55 6e 75        2   /* Unu
f220: 73 65 64 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 43 41  sed */../*.** CA
f230: 50 49 33 52 45 46 3a 20 46 6c 61 67 73 20 66 6f  PI3REF: Flags fo
f240: 72 20 74 68 65 20 78 53 68 6d 4c 6f 63 6b 20 56  r the xShmLock V
f250: 46 53 20 6d 65 74 68 6f 64 0a 2a 2a 0a 2a 2a 20  FS method.**.** 
f260: 54 68 65 73 65 20 69 6e 74 65 67 65 72 20 63 6f  These integer co
f270: 6e 73 74 61 6e 74 73 20 64 65 66 69 6e 65 20 74  nstants define t
f280: 68 65 20 76 61 72 69 6f 75 73 20 6c 6f 63 6b 69  he various locki
f290: 6e 67 20 6f 70 65 72 61 74 69 6f 6e 73 0a 2a 2a  ng operations.**
f2a0: 20 61 6c 6c 6f 77 65 64 20 62 79 20 74 68 65 20   allowed by the 
f2b0: 78 53 68 6d 4c 6f 63 6b 20 6d 65 74 68 6f 64 20  xShmLock method 
f2c0: 6f 66 20 5b 73 71 6c 69 74 65 33 5f 69 6f 5f 6d  of [sqlite3_io_m
f2d0: 65 74 68 6f 64 73 5d 2e 20 20 54 68 65 0a 2a 2a  ethods].  The.**
f2e0: 20 66 6f 6c 6c 6f 77 69 6e 67 20 61 72 65 20 74   following are t
f2f0: 68 65 20 6f 6e 6c 79 20 6c 65 67 61 6c 20 63 6f  he only legal co
f300: 6d 62 69 6e 61 74 69 6f 6e 73 20 6f 66 20 66 6c  mbinations of fl
f310: 61 67 73 20 74 6f 20 74 68 65 0a 2a 2a 20 78 53  ags to the.** xS
f320: 68 6d 4c 6f 63 6b 20 6d 65 74 68 6f 64 3a 0a 2a  hmLock method:.*
f330: 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c 69  *.** <ul>.** <li
f340: 3e 20 20 53 51 4c 49 54 45 5f 53 48 4d 5f 4c 4f  >  SQLITE_SHM_LO
f350: 43 4b 20 7c 20 53 51 4c 49 54 45 5f 53 48 4d 5f  CK | SQLITE_SHM_
f360: 53 48 41 52 45 44 0a 2a 2a 20 3c 6c 69 3e 20 20  SHARED.** <li>  
f370: 53 51 4c 49 54 45 5f 53 48 4d 5f 4c 4f 43 4b 20  SQLITE_SHM_LOCK 
f380: 7c 20 53 51 4c 49 54 45 5f 53 48 4d 5f 45 58 43  | SQLITE_SHM_EXC
f390: 4c 55 53 49 56 45 0a 2a 2a 20 3c 6c 69 3e 20 20  LUSIVE.** <li>  
f3a0: 53 51 4c 49 54 45 5f 53 48 4d 5f 55 4e 4c 4f 43  SQLITE_SHM_UNLOC
f3b0: 4b 20 7c 20 53 51 4c 49 54 45 5f 53 48 4d 5f 53  K | SQLITE_SHM_S
f3c0: 48 41 52 45 44 0a 2a 2a 20 3c 6c 69 3e 20 20 53  HARED.** <li>  S
f3d0: 51 4c 49 54 45 5f 53 48 4d 5f 55 4e 4c 4f 43 4b  QLITE_SHM_UNLOCK
f3e0: 20 7c 20 53 51 4c 49 54 45 5f 53 48 4d 5f 45 58   | SQLITE_SHM_EX
f3f0: 43 4c 55 53 49 56 45 0a 2a 2a 20 3c 2f 75 6c 3e  CLUSIVE.** </ul>
f400: 0a 2a 2a 0a 2a 2a 20 57 68 65 6e 20 75 6e 6c 6f  .**.** When unlo
f410: 63 6b 69 6e 67 2c 20 74 68 65 20 73 61 6d 65 20  cking, the same 
f420: 53 48 41 52 45 44 20 6f 72 20 45 58 43 4c 55 53  SHARED or EXCLUS
f430: 49 56 45 20 66 6c 61 67 20 6d 75 73 74 20 62 65  IVE flag must be
f440: 20 73 75 70 70 6c 69 65 64 20 61 73 0a 2a 2a 20   supplied as.** 
f450: 77 61 73 20 67 69 76 65 6e 20 6f 6e 20 74 68 65  was given on the
f460: 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20 6c   corresponding l
f470: 6f 63 6b 2e 20 20 0a 2a 2a 0a 2a 2a 20 54 68 65  ock.  .**.** The
f480: 20 78 53 68 6d 4c 6f 63 6b 20 6d 65 74 68 6f 64   xShmLock method
f490: 20 63 61 6e 20 74 72 61 6e 73 69 74 69 6f 6e 20   can transition 
f4a0: 62 65 74 77 65 65 6e 20 75 6e 6c 6f 63 6b 65 64  between unlocked
f4b0: 20 61 6e 64 20 53 48 41 52 45 44 20 6f 72 0a 2a   and SHARED or.*
f4c0: 2a 20 62 65 74 77 65 65 6e 20 75 6e 6c 6f 63 6b  * between unlock
f4d0: 65 64 20 61 6e 64 20 45 58 43 4c 55 53 49 56 45  ed and EXCLUSIVE
f4e0: 2e 20 20 49 74 20 63 61 6e 6e 6f 74 20 74 72 61  .  It cannot tra
f4f0: 6e 73 69 74 69 6f 6e 20 62 65 74 77 65 65 6e 20  nsition between 
f500: 53 48 41 52 45 44 0a 2a 2a 20 61 6e 64 20 45 58  SHARED.** and EX
f510: 43 4c 55 53 49 56 45 2e 0a 2a 2f 0a 23 64 65 66  CLUSIVE..*/.#def
f520: 69 6e 65 20 53 51 4c 49 54 45 5f 53 48 4d 5f 55  ine SQLITE_SHM_U
f530: 4e 4c 4f 43 4b 20 20 20 20 20 20 20 31 0a 23 64  NLOCK       1.#d
f540: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53 48 4d  efine SQLITE_SHM
f550: 5f 4c 4f 43 4b 20 20 20 20 20 20 20 20 20 32 0a  _LOCK         2.
f560: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53  #define SQLITE_S
f570: 48 4d 5f 53 48 41 52 45 44 20 20 20 20 20 20 20  HM_SHARED       
f580: 34 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  4.#define SQLITE
f590: 5f 53 48 4d 5f 45 58 43 4c 55 53 49 56 45 20 20  _SHM_EXCLUSIVE  
f5a0: 20 20 38 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33    8../*.** CAPI3
f5b0: 52 45 46 3a 20 4d 61 78 69 6d 75 6d 20 78 53 68  REF: Maximum xSh
f5c0: 6d 4c 6f 63 6b 20 69 6e 64 65 78 0a 2a 2a 0a 2a  mLock index.**.*
f5d0: 2a 20 54 68 65 20 78 53 68 6d 4c 6f 63 6b 20 6d  * The xShmLock m
f5e0: 65 74 68 6f 64 20 6f 6e 20 5b 73 71 6c 69 74 65  ethod on [sqlite
f5f0: 33 5f 69 6f 5f 6d 65 74 68 6f 64 73 5d 20 6d 61  3_io_methods] ma
f600: 79 20 75 73 65 20 76 61 6c 75 65 73 0a 2a 2a 20  y use values.** 
f610: 62 65 74 77 65 65 6e 20 30 20 61 6e 64 20 74 68  between 0 and th
f620: 69 73 20 75 70 70 65 72 20 62 6f 75 6e 64 20 61  is upper bound a
f630: 73 20 69 74 73 20 22 6f 66 66 73 65 74 22 20 61  s its "offset" a
f640: 72 67 75 6d 65 6e 74 2e 0a 2a 2a 20 54 68 65 20  rgument..** The 
f650: 53 51 4c 69 74 65 20 63 6f 72 65 20 77 69 6c 6c  SQLite core will
f660: 20 6e 65 76 65 72 20 61 74 74 65 6d 70 74 20 74   never attempt t
f670: 6f 20 61 63 71 75 69 72 65 20 6f 72 20 72 65 6c  o acquire or rel
f680: 65 61 73 65 20 61 0a 2a 2a 20 6c 6f 63 6b 20 6f  ease a.** lock o
f690: 75 74 73 69 64 65 20 6f 66 20 74 68 69 73 20 72  utside of this r
f6a0: 61 6e 67 65 0a 2a 2f 0a 23 64 65 66 69 6e 65 20  ange.*/.#define 
f6b0: 53 51 4c 49 54 45 5f 53 48 4d 5f 4e 4c 4f 43 4b  SQLITE_SHM_NLOCK
f6c0: 20 20 20 20 20 20 20 20 38 0a 0a 0a 2f 2a 0a 2a          8.../*.*
f6d0: 2a 20 43 41 50 49 33 52 45 46 3a 20 49 6e 69 74  * CAPI3REF: Init
f6e0: 69 61 6c 69 7a 65 20 54 68 65 20 53 51 4c 69 74  ialize The SQLit
f6f0: 65 20 4c 69 62 72 61 72 79 0a 2a 2a 0a 2a 2a 20  e Library.**.** 
f700: 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 69 6e 69  ^The sqlite3_ini
f710: 74 69 61 6c 69 7a 65 28 29 20 72 6f 75 74 69 6e  tialize() routin
f720: 65 20 69 6e 69 74 69 61 6c 69 7a 65 73 20 74 68  e initializes th
f730: 65 0a 2a 2a 20 53 51 4c 69 74 65 20 6c 69 62 72  e.** SQLite libr
f740: 61 72 79 2e 20 20 5e 54 68 65 20 73 71 6c 69 74  ary.  ^The sqlit
f750: 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 20 72 6f  e3_shutdown() ro
f760: 75 74 69 6e 65 0a 2a 2a 20 64 65 61 6c 6c 6f 63  utine.** dealloc
f770: 61 74 65 73 20 61 6e 79 20 72 65 73 6f 75 72 63  ates any resourc
f780: 65 73 20 74 68 61 74 20 77 65 72 65 20 61 6c 6c  es that were all
f790: 6f 63 61 74 65 64 20 62 79 20 73 71 6c 69 74 65  ocated by sqlite
f7a0: 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 2e 0a  3_initialize()..
f7b0: 2a 2a 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65  ** These routine
f7c0: 73 20 61 72 65 20 64 65 73 69 67 6e 65 64 20 74  s are designed t
f7d0: 6f 20 61 69 64 20 69 6e 20 70 72 6f 63 65 73 73  o aid in process
f7e0: 20 69 6e 69 74 69 61 6c 69 7a 61 74 69 6f 6e 20   initialization 
f7f0: 61 6e 64 0a 2a 2a 20 73 68 75 74 64 6f 77 6e 20  and.** shutdown 
f800: 6f 6e 20 65 6d 62 65 64 64 65 64 20 73 79 73 74  on embedded syst
f810: 65 6d 73 2e 20 20 57 6f 72 6b 73 74 61 74 69 6f  ems.  Workstatio
f820: 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 75  n applications u
f830: 73 69 6e 67 0a 2a 2a 20 53 51 4c 69 74 65 20 6e  sing.** SQLite n
f840: 6f 72 6d 61 6c 6c 79 20 64 6f 20 6e 6f 74 20 6e  ormally do not n
f850: 65 65 64 20 74 6f 20 69 6e 76 6f 6b 65 20 65 69  eed to invoke ei
f860: 74 68 65 72 20 6f 66 20 74 68 65 73 65 20 72 6f  ther of these ro
f870: 75 74 69 6e 65 73 2e 0a 2a 2a 0a 2a 2a 20 41 20  utines..**.** A 
f880: 63 61 6c 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f  call to sqlite3_
f890: 69 6e 69 74 69 61 6c 69 7a 65 28 29 20 69 73 20  initialize() is 
f8a0: 61 6e 20 22 65 66 66 65 63 74 69 76 65 22 20 63  an "effective" c
f8b0: 61 6c 6c 20 69 66 20 69 74 20 69 73 0a 2a 2a 20  all if it is.** 
f8c0: 74 68 65 20 66 69 72 73 74 20 74 69 6d 65 20 73  the first time s
f8d0: 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a  qlite3_initializ
f8e0: 65 28 29 20 69 73 20 69 6e 76 6f 6b 65 64 20 64  e() is invoked d
f8f0: 75 72 69 6e 67 20 74 68 65 20 6c 69 66 65 74 69  uring the lifeti
f900: 6d 65 20 6f 66 0a 2a 2a 20 74 68 65 20 70 72 6f  me of.** the pro
f910: 63 65 73 73 2c 20 6f 72 20 69 66 20 69 74 20 69  cess, or if it i
f920: 73 20 74 68 65 20 66 69 72 73 74 20 74 69 6d 65  s the first time
f930: 20 73 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c   sqlite3_initial
f940: 69 7a 65 28 29 20 69 73 20 69 6e 76 6f 6b 65 64  ize() is invoked
f950: 0a 2a 2a 20 66 6f 6c 6c 6f 77 69 6e 67 20 61 20  .** following a 
f960: 63 61 6c 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f  call to sqlite3_
f970: 73 68 75 74 64 6f 77 6e 28 29 2e 20 20 5e 28 4f  shutdown().  ^(O
f980: 6e 6c 79 20 61 6e 20 65 66 66 65 63 74 69 76 65  nly an effective
f990: 20 63 61 6c 6c 0a 2a 2a 20 6f 66 20 73 71 6c 69   call.** of sqli
f9a0: 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29  te3_initialize()
f9b0: 20 64 6f 65 73 20 61 6e 79 20 69 6e 69 74 69 61   does any initia
f9c0: 6c 69 7a 61 74 69 6f 6e 2e 20 20 41 6c 6c 20 6f  lization.  All o
f9d0: 74 68 65 72 20 63 61 6c 6c 73 0a 2a 2a 20 61 72  ther calls.** ar
f9e0: 65 20 68 61 72 6d 6c 65 73 73 20 6e 6f 2d 6f 70  e harmless no-op
f9f0: 73 2e 29 5e 0a 2a 2a 0a 2a 2a 20 41 20 63 61 6c  s.)^.**.** A cal
fa00: 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f 73 68 75  l to sqlite3_shu
fa10: 74 64 6f 77 6e 28 29 20 69 73 20 61 6e 20 22 65  tdown() is an "e
fa20: 66 66 65 63 74 69 76 65 22 20 63 61 6c 6c 20 69  ffective" call i
fa30: 66 20 69 74 20 69 73 20 74 68 65 20 66 69 72 73  f it is the firs
fa40: 74 0a 2a 2a 20 63 61 6c 6c 20 74 6f 20 73 71 6c  t.** call to sql
fa50: 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 20  ite3_shutdown() 
fa60: 73 69 6e 63 65 20 74 68 65 20 6c 61 73 74 20 73  since the last s
fa70: 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a  qlite3_initializ
fa80: 65 28 29 2e 20 20 5e 28 4f 6e 6c 79 0a 2a 2a 20  e().  ^(Only.** 
fa90: 61 6e 20 65 66 66 65 63 74 69 76 65 20 63 61 6c  an effective cal
faa0: 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f 73 68 75  l to sqlite3_shu
fab0: 74 64 6f 77 6e 28 29 20 64 6f 65 73 20 61 6e 79  tdown() does any
fac0: 20 64 65 69 6e 69 74 69 61 6c 69 7a 61 74 69 6f   deinitializatio
fad0: 6e 2e 0a 2a 2a 20 41 6c 6c 20 6f 74 68 65 72 20  n..** All other 
fae0: 76 61 6c 69 64 20 63 61 6c 6c 73 20 74 6f 20 73  valid calls to s
faf0: 71 6c 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28  qlite3_shutdown(
fb00: 29 20 61 72 65 20 68 61 72 6d 6c 65 73 73 20 6e  ) are harmless n
fb10: 6f 2d 6f 70 73 2e 29 5e 0a 2a 2a 0a 2a 2a 20 54  o-ops.)^.**.** T
fb20: 68 65 20 73 71 6c 69 74 65 33 5f 69 6e 69 74 69  he sqlite3_initi
fb30: 61 6c 69 7a 65 28 29 20 69 6e 74 65 72 66 61 63  alize() interfac
fb40: 65 20 69 73 20 74 68 72 65 61 64 73 61 66 65 2c  e is threadsafe,
fb50: 20 62 75 74 20 73 71 6c 69 74 65 33 5f 73 68 75   but sqlite3_shu
fb60: 74 64 6f 77 6e 28 29 0a 2a 2a 20 69 73 20 6e 6f  tdown().** is no
fb70: 74 2e 20 20 54 68 65 20 73 71 6c 69 74 65 33 5f  t.  The sqlite3_
fb80: 73 68 75 74 64 6f 77 6e 28 29 20 69 6e 74 65 72  shutdown() inter
fb90: 66 61 63 65 20 6d 75 73 74 20 6f 6e 6c 79 20 62  face must only b
fba0: 65 20 63 61 6c 6c 65 64 20 66 72 6f 6d 20 61 0a  e called from a.
fbb0: 2a 2a 20 73 69 6e 67 6c 65 20 74 68 72 65 61 64  ** single thread
fbc0: 2e 20 20 41 6c 6c 20 6f 70 65 6e 20 5b 64 61 74  .  All open [dat
fbd0: 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
fbe0: 73 5d 20 6d 75 73 74 20 62 65 20 63 6c 6f 73 65  s] must be close
fbf0: 64 20 61 6e 64 20 61 6c 6c 0a 2a 2a 20 6f 74 68  d and all.** oth
fc00: 65 72 20 53 51 4c 69 74 65 20 72 65 73 6f 75 72  er SQLite resour
fc10: 63 65 73 20 6d 75 73 74 20 62 65 20 64 65 61 6c  ces must be deal
fc20: 6c 6f 63 61 74 65 64 20 70 72 69 6f 72 20 74 6f  located prior to
fc30: 20 69 6e 76 6f 6b 69 6e 67 0a 2a 2a 20 73 71 6c   invoking.** sql
fc40: 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 2e  ite3_shutdown().
fc50: 0a 2a 2a 0a 2a 2a 20 41 6d 6f 6e 67 20 6f 74 68  .**.** Among oth
fc60: 65 72 20 74 68 69 6e 67 73 2c 20 5e 73 71 6c 69  er things, ^sqli
fc70: 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29  te3_initialize()
fc80: 20 77 69 6c 6c 20 69 6e 76 6f 6b 65 0a 2a 2a 20   will invoke.** 
fc90: 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e 69 74 28  sqlite3_os_init(
fca0: 29 2e 20 20 53 69 6d 69 6c 61 72 6c 79 2c 20 5e  ).  Similarly, ^
fcb0: 73 71 6c 69 74 65 33 5f 73 68 75 74 64 6f 77 6e  sqlite3_shutdown
fcc0: 28 29 0a 2a 2a 20 77 69 6c 6c 20 69 6e 76 6f 6b  ().** will invok
fcd0: 65 20 73 71 6c 69 74 65 33 5f 6f 73 5f 65 6e 64  e sqlite3_os_end
fce0: 28 29 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  ()..**.** ^The s
fcf0: 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a  qlite3_initializ
fd00: 65 28 29 20 72 6f 75 74 69 6e 65 20 72 65 74 75  e() routine retu
fd10: 72 6e 73 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20  rns [SQLITE_OK] 
fd20: 6f 6e 20 73 75 63 63 65 73 73 2e 0a 2a 2a 20 5e  on success..** ^
fd30: 49 66 20 66 6f 72 20 73 6f 6d 65 20 72 65 61 73  If for some reas
fd40: 6f 6e 2c 20 73 71 6c 69 74 65 33 5f 69 6e 69 74  on, sqlite3_init
fd50: 69 61 6c 69 7a 65 28 29 20 69 73 20 75 6e 61 62  ialize() is unab
fd60: 6c 65 20 74 6f 20 69 6e 69 74 69 61 6c 69 7a 65  le to initialize
fd70: 0a 2a 2a 20 74 68 65 20 6c 69 62 72 61 72 79 20  .** the library 
fd80: 28 70 65 72 68 61 70 73 20 69 74 20 69 73 20 75  (perhaps it is u
fd90: 6e 61 62 6c 65 20 74 6f 20 61 6c 6c 6f 63 61 74  nable to allocat
fda0: 65 20 61 20 6e 65 65 64 65 64 20 72 65 73 6f 75  e a needed resou
fdb0: 72 63 65 20 73 75 63 68 0a 2a 2a 20 61 73 20 61  rce such.** as a
fdc0: 20 6d 75 74 65 78 29 20 69 74 20 72 65 74 75 72   mutex) it retur
fdd0: 6e 73 20 61 6e 20 5b 65 72 72 6f 72 20 63 6f 64  ns an [error cod
fde0: 65 5d 20 6f 74 68 65 72 20 74 68 61 6e 20 5b 53  e] other than [S
fdf0: 51 4c 49 54 45 5f 4f 4b 5d 2e 0a 2a 2a 0a 2a 2a  QLITE_OK]..**.**
fe00: 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 69 6e   ^The sqlite3_in
fe10: 69 74 69 61 6c 69 7a 65 28 29 20 72 6f 75 74 69  itialize() routi
fe20: 6e 65 20 69 73 20 63 61 6c 6c 65 64 20 69 6e 74  ne is called int
fe30: 65 72 6e 61 6c 6c 79 20 62 79 20 6d 61 6e 79 20  ernally by many 
fe40: 6f 74 68 65 72 0a 2a 2a 20 53 51 4c 69 74 65 20  other.** SQLite 
fe50: 69 6e 74 65 72 66 61 63 65 73 20 73 6f 20 74 68  interfaces so th
fe60: 61 74 20 61 6e 20 61 70 70 6c 69 63 61 74 69 6f  at an applicatio
fe70: 6e 20 75 73 75 61 6c 6c 79 20 64 6f 65 73 20 6e  n usually does n
fe80: 6f 74 20 6e 65 65 64 20 74 6f 0a 2a 2a 20 69 6e  ot need to.** in
fe90: 76 6f 6b 65 20 73 71 6c 69 74 65 33 5f 69 6e 69  voke sqlite3_ini
fea0: 74 69 61 6c 69 7a 65 28 29 20 64 69 72 65 63 74  tialize() direct
feb0: 6c 79 2e 20 20 46 6f 72 20 65 78 61 6d 70 6c 65  ly.  For example
fec0: 2c 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28  , [sqlite3_open(
fed0: 29 5d 0a 2a 2a 20 63 61 6c 6c 73 20 73 71 6c 69  )].** calls sqli
fee0: 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29  te3_initialize()
fef0: 20 73 6f 20 74 68 65 20 53 51 4c 69 74 65 20 6c   so the SQLite l
ff00: 69 62 72 61 72 79 20 77 69 6c 6c 20 62 65 20 61  ibrary will be a
ff10: 75 74 6f 6d 61 74 69 63 61 6c 6c 79 0a 2a 2a 20  utomatically.** 
ff20: 69 6e 69 74 69 61 6c 69 7a 65 64 20 77 68 65 6e  initialized when
ff30: 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29   [sqlite3_open()
ff40: 5d 20 69 73 20 63 61 6c 6c 65 64 20 69 66 20 69  ] is called if i
ff50: 74 20 68 61 73 20 6e 6f 74 20 62 65 20 69 6e 69  t has not be ini
ff60: 74 69 61 6c 69 7a 65 64 0a 2a 2a 20 61 6c 72 65  tialized.** alre
ff70: 61 64 79 2e 20 20 5e 48 6f 77 65 76 65 72 2c 20  ady.  ^However, 
ff80: 69 66 20 53 51 4c 69 74 65 20 69 73 20 63 6f 6d  if SQLite is com
ff90: 70 69 6c 65 64 20 77 69 74 68 20 74 68 65 20 5b  piled with the [
ffa0: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 55 54 4f  SQLITE_OMIT_AUTO
ffb0: 49 4e 49 54 5d 0a 2a 2a 20 63 6f 6d 70 69 6c 65  INIT].** compile
ffc0: 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 2c 20 74 68  -time option, th
ffd0: 65 6e 20 74 68 65 20 61 75 74 6f 6d 61 74 69 63  en the automatic
ffe0: 20 63 61 6c 6c 73 20 74 6f 20 73 71 6c 69 74 65   calls to sqlite
fff0: 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 0a 2a  3_initialize().*
10000 2a 20 61 72 65 20 6f 6d 69 74 74 65 64 20 61 6e  * are omitted an
10010 64 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f  d the applicatio
10020 6e 20 6d 75 73 74 20 63 61 6c 6c 20 73 71 6c 69  n must call sqli
10030 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29  te3_initialize()
10040 20 64 69 72 65 63 74 6c 79 0a 2a 2a 20 70 72 69   directly.** pri
10050 6f 72 20 74 6f 20 75 73 69 6e 67 20 61 6e 79 20  or to using any 
10060 6f 74 68 65 72 20 53 51 4c 69 74 65 20 69 6e 74  other SQLite int
10070 65 72 66 61 63 65 2e 20 20 46 6f 72 20 6d 61 78  erface.  For max
10080 69 6d 75 6d 20 70 6f 72 74 61 62 69 6c 69 74 79  imum portability
10090 2c 0a 2a 2a 20 69 74 20 69 73 20 72 65 63 6f 6d  ,.** it is recom
100a0 6d 65 6e 64 65 64 20 74 68 61 74 20 61 70 70 6c  mended that appl
100b0 69 63 61 74 69 6f 6e 73 20 61 6c 77 61 79 73 20  ications always 
100c0 69 6e 76 6f 6b 65 20 73 71 6c 69 74 65 33 5f 69  invoke sqlite3_i
100d0 6e 69 74 69 61 6c 69 7a 65 28 29 0a 2a 2a 20 64  nitialize().** d
100e0 69 72 65 63 74 6c 79 20 70 72 69 6f 72 20 74 6f  irectly prior to
100f0 20 75 73 69 6e 67 20 61 6e 79 20 6f 74 68 65 72   using any other
10100 20 53 51 4c 69 74 65 20 69 6e 74 65 72 66 61 63   SQLite interfac
10110 65 2e 20 20 46 75 74 75 72 65 20 72 65 6c 65 61  e.  Future relea
10120 73 65 73 0a 2a 2a 20 6f 66 20 53 51 4c 69 74 65  ses.** of SQLite
10130 20 6d 61 79 20 72 65 71 75 69 72 65 20 74 68 69   may require thi
10140 73 2e 20 20 49 6e 20 6f 74 68 65 72 20 77 6f 72  s.  In other wor
10150 64 73 2c 20 74 68 65 20 62 65 68 61 76 69 6f 72  ds, the behavior
10160 20 65 78 68 69 62 69 74 65 64 0a 2a 2a 20 77 68   exhibited.** wh
10170 65 6e 20 53 51 4c 69 74 65 20 69 73 20 63 6f 6d  en SQLite is com
10180 70 69 6c 65 64 20 77 69 74 68 20 5b 53 51 4c 49  piled with [SQLI
10190 54 45 5f 4f 4d 49 54 5f 41 55 54 4f 49 4e 49 54  TE_OMIT_AUTOINIT
101a0 5d 20 6d 69 67 68 74 20 62 65 63 6f 6d 65 20 74  ] might become t
101b0 68 65 0a 2a 2a 20 64 65 66 61 75 6c 74 20 62 65  he.** default be
101c0 68 61 76 69 6f 72 20 69 6e 20 73 6f 6d 65 20 66  havior in some f
101d0 75 74 75 72 65 20 72 65 6c 65 61 73 65 20 6f 66  uture release of
101e0 20 53 51 4c 69 74 65 2e 0a 2a 2a 0a 2a 2a 20 54   SQLite..**.** T
101f0 68 65 20 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e  he sqlite3_os_in
10200 69 74 28 29 20 72 6f 75 74 69 6e 65 20 64 6f 65  it() routine doe
10210 73 20 6f 70 65 72 61 74 69 6e 67 2d 73 79 73 74  s operating-syst
10220 65 6d 20 73 70 65 63 69 66 69 63 0a 2a 2a 20 69  em specific.** i
10230 6e 69 74 69 61 6c 69 7a 61 74 69 6f 6e 20 6f 66  nitialization of
10240 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62 72   the SQLite libr
10250 61 72 79 2e 20 20 54 68 65 20 73 71 6c 69 74 65  ary.  The sqlite
10260 33 5f 6f 73 5f 65 6e 64 28 29 0a 2a 2a 20 72 6f  3_os_end().** ro
10270 75 74 69 6e 65 20 75 6e 64 6f 65 73 20 74 68 65  utine undoes the
10280 20 65 66 66 65 63 74 20 6f 66 20 73 71 6c 69 74   effect of sqlit
10290 65 33 5f 6f 73 5f 69 6e 69 74 28 29 2e 20 20 54  e3_os_init().  T
102a0 79 70 69 63 61 6c 20 74 61 73 6b 73 0a 2a 2a 20  ypical tasks.** 
102b0 70 65 72 66 6f 72 6d 65 64 20 62 79 20 74 68 65  performed by the
102c0 73 65 20 72 6f 75 74 69 6e 65 73 20 69 6e 63 6c  se routines incl
102d0 75 64 65 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 6f  ude allocation o
102e0 72 20 64 65 61 6c 6c 6f 63 61 74 69 6f 6e 0a 2a  r deallocation.*
102f0 2a 20 6f 66 20 73 74 61 74 69 63 20 72 65 73 6f  * of static reso
10300 75 72 63 65 73 2c 20 69 6e 69 74 69 61 6c 69 7a  urces, initializ
10310 61 74 69 6f 6e 20 6f 66 20 67 6c 6f 62 61 6c 20  ation of global 
10320 76 61 72 69 61 62 6c 65 73 2c 0a 2a 2a 20 73 65  variables,.** se
10330 74 74 69 6e 67 20 75 70 20 61 20 64 65 66 61 75  tting up a defau
10340 6c 74 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5d  lt [sqlite3_vfs]
10350 20 6d 6f 64 75 6c 65 2c 20 6f 72 20 73 65 74 74   module, or sett
10360 69 6e 67 20 75 70 0a 2a 2a 20 61 20 64 65 66 61  ing up.** a defa
10370 75 6c 74 20 63 6f 6e 66 69 67 75 72 61 74 69 6f  ult configuratio
10380 6e 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33  n using [sqlite3
10390 5f 63 6f 6e 66 69 67 28 29 5d 2e 0a 2a 2a 0a 2a  _config()]..**.*
103a0 2a 20 54 68 65 20 61 70 70 6c 69 63 61 74 69 6f  * The applicatio
103b0 6e 20 73 68 6f 75 6c 64 20 6e 65 76 65 72 20 69  n should never i
103c0 6e 76 6f 6b 65 20 65 69 74 68 65 72 20 73 71 6c  nvoke either sql
103d0 69 74 65 33 5f 6f 73 5f 69 6e 69 74 28 29 0a 2a  ite3_os_init().*
103e0 2a 20 6f 72 20 73 71 6c 69 74 65 33 5f 6f 73 5f  * or sqlite3_os_
103f0 65 6e 64 28 29 20 64 69 72 65 63 74 6c 79 2e 20  end() directly. 
10400 20 54 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   The application
10410 20 73 68 6f 75 6c 64 20 6f 6e 6c 79 20 69 6e 76   should only inv
10420 6f 6b 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 69  oke.** sqlite3_i
10430 6e 69 74 69 61 6c 69 7a 65 28 29 20 61 6e 64 20  nitialize() and 
10440 73 71 6c 69 74 65 33 5f 73 68 75 74 64 6f 77 6e  sqlite3_shutdown
10450 28 29 2e 20 20 54 68 65 20 73 71 6c 69 74 65 33  ().  The sqlite3
10460 5f 6f 73 5f 69 6e 69 74 28 29 0a 2a 2a 20 69 6e  _os_init().** in
10470 74 65 72 66 61 63 65 20 69 73 20 63 61 6c 6c 65  terface is calle
10480 64 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20  d automatically 
10490 62 79 20 73 71 6c 69 74 65 33 5f 69 6e 69 74 69  by sqlite3_initi
104a0 61 6c 69 7a 65 28 29 20 61 6e 64 0a 2a 2a 20 73  alize() and.** s
104b0 71 6c 69 74 65 33 5f 6f 73 5f 65 6e 64 28 29 20  qlite3_os_end() 
104c0 69 73 20 63 61 6c 6c 65 64 20 62 79 20 73 71 6c  is called by sql
104d0 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 2e  ite3_shutdown().
104e0 20 20 41 70 70 72 6f 70 72 69 61 74 65 0a 2a 2a    Appropriate.**
104f0 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73   implementations
10500 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f 73 5f   for sqlite3_os_
10510 69 6e 69 74 28 29 20 61 6e 64 20 73 71 6c 69 74  init() and sqlit
10520 65 33 5f 6f 73 5f 65 6e 64 28 29 0a 2a 2a 20 61  e3_os_end().** a
10530 72 65 20 62 75 69 6c 74 20 69 6e 74 6f 20 53 51  re built into SQ
10540 4c 69 74 65 20 77 68 65 6e 20 69 74 20 69 73 20  Lite when it is 
10550 63 6f 6d 70 69 6c 65 64 20 66 6f 72 20 55 6e 69  compiled for Uni
10560 78 2c 20 57 69 6e 64 6f 77 73 2c 20 6f 72 20 4f  x, Windows, or O
10570 53 2f 32 2e 0a 2a 2a 20 57 68 65 6e 20 5b 63 75  S/2..** When [cu
10580 73 74 6f 6d 20 62 75 69 6c 64 73 20 7c 20 62 75  stom builds | bu
10590 69 6c 74 20 66 6f 72 20 6f 74 68 65 72 20 70 6c  ilt for other pl
105a0 61 74 66 6f 72 6d 73 5d 0a 2a 2a 20 28 75 73 69  atforms].** (usi
105b0 6e 67 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 4f  ng the [SQLITE_O
105c0 53 5f 4f 54 48 45 52 3d 31 5d 20 63 6f 6d 70 69  S_OTHER=1] compi
105d0 6c 65 2d 74 69 6d 65 0a 2a 2a 20 6f 70 74 69 6f  le-time.** optio
105e0 6e 29 20 74 68 65 20 61 70 70 6c 69 63 61 74 69  n) the applicati
105f0 6f 6e 20 6d 75 73 74 20 73 75 70 70 6c 79 20 61  on must supply a
10600 20 73 75 69 74 61 62 6c 65 20 69 6d 70 6c 65 6d   suitable implem
10610 65 6e 74 61 74 69 6f 6e 20 66 6f 72 0a 2a 2a 20  entation for.** 
10620 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e 69 74 28  sqlite3_os_init(
10630 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 6f 73  ) and sqlite3_os
10640 5f 65 6e 64 28 29 2e 20 20 41 6e 20 61 70 70 6c  _end().  An appl
10650 69 63 61 74 69 6f 6e 2d 73 75 70 70 6c 69 65 64  ication-supplied
10660 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  .** implementati
10670 6f 6e 20 6f 66 20 73 71 6c 69 74 65 33 5f 6f 73  on of sqlite3_os
10680 5f 69 6e 69 74 28 29 20 6f 72 20 73 71 6c 69 74  _init() or sqlit
10690 65 33 5f 6f 73 5f 65 6e 64 28 29 0a 2a 2a 20 6d  e3_os_end().** m
106a0 75 73 74 20 72 65 74 75 72 6e 20 5b 53 51 4c 49  ust return [SQLI
106b0 54 45 5f 4f 4b 5d 20 6f 6e 20 73 75 63 63 65 73  TE_OK] on succes
106c0 73 20 61 6e 64 20 73 6f 6d 65 20 6f 74 68 65 72  s and some other
106d0 20 5b 65 72 72 6f 72 20 63 6f 64 65 5d 20 75 70   [error code] up
106e0 6f 6e 0a 2a 2a 20 66 61 69 6c 75 72 65 2e 0a 2a  on.** failure..*
106f0 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 69 6e  /.int sqlite3_in
10700 69 74 69 61 6c 69 7a 65 28 76 6f 69 64 29 3b 0a  itialize(void);.
10710 69 6e 74 20 73 71 6c 69 74 65 33 5f 73 68 75 74  int sqlite3_shut
10720 64 6f 77 6e 28 76 6f 69 64 29 3b 0a 69 6e 74 20  down(void);.int 
10730 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e 69 74 28  sqlite3_os_init(
10740 76 6f 69 64 29 3b 0a 69 6e 74 20 73 71 6c 69 74  void);.int sqlit
10750 65 33 5f 6f 73 5f 65 6e 64 28 76 6f 69 64 29 3b  e3_os_end(void);
10760 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
10770 3a 20 43 6f 6e 66 69 67 75 72 69 6e 67 20 54 68  : Configuring Th
10780 65 20 53 51 4c 69 74 65 20 4c 69 62 72 61 72 79  e SQLite Library
10790 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74  .**.** The sqlit
107a0 65 33 5f 63 6f 6e 66 69 67 28 29 20 69 6e 74 65  e3_config() inte
107b0 72 66 61 63 65 20 69 73 20 75 73 65 64 20 74 6f  rface is used to
107c0 20 6d 61 6b 65 20 67 6c 6f 62 61 6c 20 63 6f 6e   make global con
107d0 66 69 67 75 72 61 74 69 6f 6e 0a 2a 2a 20 63 68  figuration.** ch
107e0 61 6e 67 65 73 20 74 6f 20 53 51 4c 69 74 65 20  anges to SQLite 
107f0 69 6e 20 6f 72 64 65 72 20 74 6f 20 74 75 6e 65  in order to tune
10800 20 53 51 4c 69 74 65 20 74 6f 20 74 68 65 20 73   SQLite to the s
10810 70 65 63 69 66 69 63 20 6e 65 65 64 73 20 6f 66  pecific needs of
10820 0a 2a 2a 20 74 68 65 20 61 70 70 6c 69 63 61 74  .** the applicat
10830 69 6f 6e 2e 20 20 54 68 65 20 64 65 66 61 75 6c  ion.  The defaul
10840 74 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20  t configuration 
10850 69 73 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 66  is recommended f
10860 6f 72 20 6d 6f 73 74 0a 2a 2a 20 61 70 70 6c 69  or most.** appli
10870 63 61 74 69 6f 6e 73 20 61 6e 64 20 73 6f 20 74  cations and so t
10880 68 69 73 20 72 6f 75 74 69 6e 65 20 69 73 20 75  his routine is u
10890 73 75 61 6c 6c 79 20 6e 6f 74 20 6e 65 63 65 73  sually not neces
108a0 73 61 72 79 2e 20 20 49 74 20 69 73 0a 2a 2a 20  sary.  It is.** 
108b0 70 72 6f 76 69 64 65 64 20 74 6f 20 73 75 70 70  provided to supp
108c0 6f 72 74 20 72 61 72 65 20 61 70 70 6c 69 63 61  ort rare applica
108d0 74 69 6f 6e 73 20 77 69 74 68 20 75 6e 75 73 75  tions with unusu
108e0 61 6c 20 6e 65 65 64 73 2e 0a 2a 2a 0a 2a 2a 20  al needs..**.** 
108f0 3c 62 3e 54 68 65 20 73 71 6c 69 74 65 33 5f 63  <b>The sqlite3_c
10900 6f 6e 66 69 67 28 29 20 69 6e 74 65 72 66 61 63  onfig() interfac
10910 65 20 69 73 20 6e 6f 74 20 74 68 72 65 61 64 73  e is not threads
10920 61 66 65 2e 20 54 68 65 20 61 70 70 6c 69 63 61  afe. The applica
10930 74 69 6f 6e 0a 2a 2a 20 6d 75 73 74 20 65 6e 73  tion.** must ens
10940 75 72 65 20 74 68 61 74 20 6e 6f 20 6f 74 68 65  ure that no othe
10950 72 20 53 51 4c 69 74 65 20 69 6e 74 65 72 66 61  r SQLite interfa
10960 63 65 73 20 61 72 65 20 69 6e 76 6f 6b 65 64 20  ces are invoked 
10970 62 79 20 6f 74 68 65 72 0a 2a 2a 20 74 68 72 65  by other.** thre
10980 61 64 73 20 77 68 69 6c 65 20 73 71 6c 69 74 65  ads while sqlite
10990 33 5f 63 6f 6e 66 69 67 28 29 20 69 73 20 72 75  3_config() is ru
109a0 6e 6e 69 6e 67 2e 3c 2f 62 3e 0a 2a 2a 0a 2a 2a  nning.</b>.**.**
109b0 20 54 68 65 20 73 71 6c 69 74 65 33 5f 63 6f 6e   The sqlite3_con
109c0 66 69 67 28 29 20 69 6e 74 65 72 66 61 63 65 0a  fig() interface.
109d0 2a 2a 20 6d 61 79 20 6f 6e 6c 79 20 62 65 20 69  ** may only be i
109e0 6e 76 6f 6b 65 64 20 70 72 69 6f 72 20 74 6f 20  nvoked prior to 
109f0 6c 69 62 72 61 72 79 20 69 6e 69 74 69 61 6c 69  library initiali
10a00 7a 61 74 69 6f 6e 20 75 73 69 6e 67 0a 2a 2a 20  zation using.** 
10a10 5b 73 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c  [sqlite3_initial
10a20 69 7a 65 28 29 5d 20 6f 72 20 61 66 74 65 72 20  ize()] or after 
10a30 73 68 75 74 64 6f 77 6e 20 62 79 20 5b 73 71 6c  shutdown by [sql
10a40 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 5d  ite3_shutdown()]
10a50 2e 0a 2a 2a 20 5e 49 66 20 73 71 6c 69 74 65 33  ..** ^If sqlite3
10a60 5f 63 6f 6e 66 69 67 28 29 20 69 73 20 63 61 6c  _config() is cal
10a70 6c 65 64 20 61 66 74 65 72 20 5b 73 71 6c 69 74  led after [sqlit
10a80 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 5d  e3_initialize()]
10a90 20 61 6e 64 20 62 65 66 6f 72 65 0a 2a 2a 20 5b   and before.** [
10aa0 73 71 6c 69 74 65 33 5f 73 68 75 74 64 6f 77 6e  sqlite3_shutdown
10ab0 28 29 5d 20 74 68 65 6e 20 69 74 20 77 69 6c 6c  ()] then it will
10ac0 20 72 65 74 75 72 6e 20 53 51 4c 49 54 45 5f 4d   return SQLITE_M
10ad0 49 53 55 53 45 2e 0a 2a 2a 20 4e 6f 74 65 2c 20  ISUSE..** Note, 
10ae0 68 6f 77 65 76 65 72 2c 20 74 68 61 74 20 5e 73  however, that ^s
10af0 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 20  qlite3_config() 
10b00 63 61 6e 20 62 65 20 63 61 6c 6c 65 64 20 61 73  can be called as
10b10 20 70 61 72 74 20 6f 66 20 74 68 65 0a 2a 2a 20   part of the.** 
10b20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 6f  implementation o
10b30 66 20 61 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e  f an application
10b40 2d 64 65 66 69 6e 65 64 20 5b 73 71 6c 69 74 65  -defined [sqlite
10b50 33 5f 6f 73 5f 69 6e 69 74 28 29 5d 2e 0a 2a 2a  3_os_init()]..**
10b60 0a 2a 2a 20 54 68 65 20 66 69 72 73 74 20 61 72  .** The first ar
10b70 67 75 6d 65 6e 74 20 74 6f 20 73 71 6c 69 74 65  gument to sqlite
10b80 33 5f 63 6f 6e 66 69 67 28 29 20 69 73 20 61 6e  3_config() is an
10b90 20 69 6e 74 65 67 65 72 0a 2a 2a 20 5b 63 6f 6e   integer.** [con
10ba0 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f  figuration optio
10bb0 6e 5d 20 74 68 61 74 20 64 65 74 65 72 6d 69 6e  n] that determin
10bc0 65 73 0a 2a 2a 20 77 68 61 74 20 70 72 6f 70 65  es.** what prope
10bd0 72 74 79 20 6f 66 20 53 51 4c 69 74 65 20 69 73  rty of SQLite is
10be0 20 74 6f 20 62 65 20 63 6f 6e 66 69 67 75 72 65   to be configure
10bf0 64 2e 20 20 53 75 62 73 65 71 75 65 6e 74 20 61  d.  Subsequent a
10c00 72 67 75 6d 65 6e 74 73 0a 2a 2a 20 76 61 72 79  rguments.** vary
10c10 20 64 65 70 65 6e 64 69 6e 67 20 6f 6e 20 74 68   depending on th
10c20 65 20 5b 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e  e [configuration
10c30 20 6f 70 74 69 6f 6e 5d 0a 2a 2a 20 69 6e 20 74   option].** in t
10c40 68 65 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e  he first argumen
10c50 74 2e 0a 2a 2a 0a 2a 2a 20 5e 57 68 65 6e 20 61  t..**.** ^When a
10c60 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f   configuration o
10c70 70 74 69 6f 6e 20 69 73 20 73 65 74 2c 20 73 71  ption is set, sq
10c80 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 20 72  lite3_config() r
10c90 65 74 75 72 6e 73 20 5b 53 51 4c 49 54 45 5f 4f  eturns [SQLITE_O
10ca0 4b 5d 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 6f  K]..** ^If the o
10cb0 70 74 69 6f 6e 20 69 73 20 75 6e 6b 6e 6f 77 6e  ption is unknown
10cc0 20 6f 72 20 53 51 4c 69 74 65 20 69 73 20 75 6e   or SQLite is un
10cd0 61 62 6c 65 20 74 6f 20 73 65 74 20 74 68 65 20  able to set the 
10ce0 6f 70 74 69 6f 6e 0a 2a 2a 20 74 68 65 6e 20 74  option.** then t
10cf0 68 69 73 20 72 6f 75 74 69 6e 65 20 72 65 74 75  his routine retu
10d00 72 6e 73 20 61 20 6e 6f 6e 2d 7a 65 72 6f 20 5b  rns a non-zero [
10d10 65 72 72 6f 72 20 63 6f 64 65 5d 2e 0a 2a 2f 0a  error code]..*/.
10d20 69 6e 74 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66  int sqlite3_conf
10d30 69 67 28 69 6e 74 2c 20 2e 2e 2e 29 3b 0a 0a 2f  ig(int, ...);../
10d40 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 43  *.** CAPI3REF: C
10d50 6f 6e 66 69 67 75 72 65 20 64 61 74 61 62 61 73  onfigure databas
10d60 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 0a 2a 2a  e connections.**
10d70 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33   METHOD: sqlite3
10d80 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74  .**.** The sqlit
10d90 65 33 5f 64 62 5f 63 6f 6e 66 69 67 28 29 20 69  e3_db_config() i
10da0 6e 74 65 72 66 61 63 65 20 69 73 20 75 73 65 64  nterface is used
10db0 20 74 6f 20 6d 61 6b 65 20 63 6f 6e 66 69 67 75   to make configu
10dc0 72 61 74 69 6f 6e 0a 2a 2a 20 63 68 61 6e 67 65  ration.** change
10dd0 73 20 74 6f 20 61 20 5b 64 61 74 61 62 61 73 65  s to a [database
10de0 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 2e 20 20 54   connection].  T
10df0 68 65 20 69 6e 74 65 72 66 61 63 65 20 69 73 20  he interface is 
10e00 73 69 6d 69 6c 61 72 20 74 6f 0a 2a 2a 20 5b 73  similar to.** [s
10e10 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d  qlite3_config()]
10e20 20 65 78 63 65 70 74 20 74 68 61 74 20 74 68 65   except that the
10e30 20 63 68 61 6e 67 65 73 20 61 70 70 6c 79 20 74   changes apply t
10e40 6f 20 61 20 73 69 6e 67 6c 65 0a 2a 2a 20 5b 64  o a single.** [d
10e50 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
10e60 6f 6e 5d 20 28 73 70 65 63 69 66 69 65 64 20 69  on] (specified i
10e70 6e 20 74 68 65 20 66 69 72 73 74 20 61 72 67 75  n the first argu
10e80 6d 65 6e 74 29 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  ment)..**.** The
10e90 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74   second argument
10ea0 20 74 6f 20 73 71 6c 69 74 65 33 5f 64 62 5f 63   to sqlite3_db_c
10eb0 6f 6e 66 69 67 28 44 2c 56 2c 2e 2e 2e 29 20 20  onfig(D,V,...)  
10ec0 69 73 20 74 68 65 0a 2a 2a 20 5b 53 51 4c 49 54  is the.** [SQLIT
10ed0 45 5f 44 42 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41  E_DBCONFIG_LOOKA
10ee0 53 49 44 45 20 7c 20 63 6f 6e 66 69 67 75 72 61  SIDE | configura
10ef0 74 69 6f 6e 20 76 65 72 62 5d 20 2d 20 61 6e 20  tion verb] - an 
10f00 69 6e 74 65 67 65 72 20 63 6f 64 65 20 0a 2a 2a  integer code .**
10f10 20 74 68 61 74 20 69 6e 64 69 63 61 74 65 73 20   that indicates 
10f20 77 68 61 74 20 61 73 70 65 63 74 20 6f 66 20 74  what aspect of t
10f30 68 65 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e  he [database con
10f40 6e 65 63 74 69 6f 6e 5d 20 69 73 20 62 65 69 6e  nection] is bein
10f50 67 20 63 6f 6e 66 69 67 75 72 65 64 2e 0a 2a 2a  g configured..**
10f60 20 53 75 62 73 65 71 75 65 6e 74 20 61 72 67 75   Subsequent argu
10f70 6d 65 6e 74 73 20 76 61 72 79 20 64 65 70 65 6e  ments vary depen
10f80 64 69 6e 67 20 6f 6e 20 74 68 65 20 63 6f 6e 66  ding on the conf
10f90 69 67 75 72 61 74 69 6f 6e 20 76 65 72 62 2e 0a  iguration verb..
10fa0 2a 2a 0a 2a 2a 20 5e 43 61 6c 6c 73 20 74 6f 20  **.** ^Calls to 
10fb0 73 71 6c 69 74 65 33 5f 64 62 5f 63 6f 6e 66 69  sqlite3_db_confi
10fc0 67 28 29 20 72 65 74 75 72 6e 20 53 51 4c 49 54  g() return SQLIT
10fd0 45 5f 4f 4b 20 69 66 20 61 6e 64 20 6f 6e 6c 79  E_OK if and only
10fe0 20 69 66 0a 2a 2a 20 74 68 65 20 63 61 6c 6c 20   if.** the call 
10ff0 69 73 20 63 6f 6e 73 69 64 65 72 65 64 20 73 75  is considered su
11000 63 63 65 73 73 66 75 6c 2e 0a 2a 2f 0a 69 6e 74  ccessful..*/.int
11010 20 73 71 6c 69 74 65 33 5f 64 62 5f 63 6f 6e 66   sqlite3_db_conf
11020 69 67 28 73 71 6c 69 74 65 33 2a 2c 20 69 6e 74  ig(sqlite3*, int
11030 20 6f 70 2c 20 2e 2e 2e 29 3b 0a 0a 2f 2a 0a 2a   op, ...);../*.*
11040 2a 20 43 41 50 49 33 52 45 46 3a 20 4d 65 6d 6f  * CAPI3REF: Memo
11050 72 79 20 41 6c 6c 6f 63 61 74 69 6f 6e 20 52 6f  ry Allocation Ro
11060 75 74 69 6e 65 73 0a 2a 2a 0a 2a 2a 20 41 6e 20  utines.**.** An 
11070 69 6e 73 74 61 6e 63 65 20 6f 66 20 74 68 69 73  instance of this
11080 20 6f 62 6a 65 63 74 20 64 65 66 69 6e 65 73 20   object defines 
11090 74 68 65 20 69 6e 74 65 72 66 61 63 65 20 62 65  the interface be
110a0 74 77 65 65 6e 20 53 51 4c 69 74 65 0a 2a 2a 20  tween SQLite.** 
110b0 61 6e 64 20 6c 6f 77 2d 6c 65 76 65 6c 20 6d 65  and low-level me
110c0 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20  mory allocation 
110d0 72 6f 75 74 69 6e 65 73 2e 0a 2a 2a 0a 2a 2a 20  routines..**.** 
110e0 54 68 69 73 20 6f 62 6a 65 63 74 20 69 73 20 75  This object is u
110f0 73 65 64 20 69 6e 20 6f 6e 6c 79 20 6f 6e 65 20  sed in only one 
11100 70 6c 61 63 65 20 69 6e 20 74 68 65 20 53 51 4c  place in the SQL
11110 69 74 65 20 69 6e 74 65 72 66 61 63 65 2e 0a 2a  ite interface..*
11120 2a 20 41 20 70 6f 69 6e 74 65 72 20 74 6f 20 61  * A pointer to a
11130 6e 20 69 6e 73 74 61 6e 63 65 20 6f 66 20 74 68  n instance of th
11140 69 73 20 6f 62 6a 65 63 74 20 69 73 20 74 68 65  is object is the
11150 20 61 72 67 75 6d 65 6e 74 20 74 6f 0a 2a 2a 20   argument to.** 
11160 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28  [sqlite3_config(
11170 29 5d 20 77 68 65 6e 20 74 68 65 20 63 6f 6e 66  )] when the conf
11180 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e  iguration option
11190 20 69 73 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 43   is.** [SQLITE_C
111a0 4f 4e 46 49 47 5f 4d 41 4c 4c 4f 43 5d 20 6f 72  ONFIG_MALLOC] or
111b0 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f   [SQLITE_CONFIG_
111c0 47 45 54 4d 41 4c 4c 4f 43 5d 2e 20 20 0a 2a 2a  GETMALLOC].  .**
111d0 20 42 79 20 63 72 65 61 74 69 6e 67 20 61 6e 20   By creating an 
111e0 69 6e 73 74 61 6e 63 65 20 6f 66 20 74 68 69 73  instance of this
111f0 20 6f 62 6a 65 63 74 0a 2a 2a 20 61 6e 64 20 70   object.** and p
11200 61 73 73 69 6e 67 20 69 74 20 74 6f 20 5b 73 71  assing it to [sq
11210 6c 69 74 65 33 5f 63 6f 6e 66 69 67 5d 28 5b 53  lite3_config]([S
11220 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 41 4c  QLITE_CONFIG_MAL
11230 4c 4f 43 5d 29 0a 2a 2a 20 64 75 72 69 6e 67 20  LOC]).** during 
11240 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 2c 20 61  configuration, a
11250 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 63 61  n application ca
11260 6e 20 73 70 65 63 69 66 79 20 61 6e 20 61 6c 74  n specify an alt
11270 65 72 6e 61 74 69 76 65 0a 2a 2a 20 6d 65 6d 6f  ernative.** memo
11280 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 73 75  ry allocation su
11290 62 73 79 73 74 65 6d 20 66 6f 72 20 53 51 4c 69  bsystem for SQLi
112a0 74 65 20 74 6f 20 75 73 65 20 66 6f 72 20 61 6c  te to use for al
112b0 6c 20 6f 66 20 69 74 73 0a 2a 2a 20 64 79 6e 61  l of its.** dyna
112c0 6d 69 63 20 6d 65 6d 6f 72 79 20 6e 65 65 64 73  mic memory needs
112d0 2e 0a 2a 2a 0a 2a 2a 20 4e 6f 74 65 20 74 68 61  ..**.** Note tha
112e0 74 20 53 51 4c 69 74 65 20 63 6f 6d 65 73 20 77  t SQLite comes w
112f0 69 74 68 20 73 65 76 65 72 61 6c 20 5b 62 75 69  ith several [bui
11300 6c 74 2d 69 6e 20 6d 65 6d 6f 72 79 20 61 6c 6c  lt-in memory all
11310 6f 63 61 74 6f 72 73 5d 0a 2a 2a 20 74 68 61 74  ocators].** that
11320 20 61 72 65 20 70 65 72 66 65 63 74 6c 79 20 61   are perfectly a
11330 64 65 71 75 61 74 65 20 66 6f 72 20 74 68 65 20  dequate for the 
11340 6f 76 65 72 77 68 65 6c 6d 69 6e 67 20 6d 61 6a  overwhelming maj
11350 6f 72 69 74 79 20 6f 66 20 61 70 70 6c 69 63 61  ority of applica
11360 74 69 6f 6e 73 0a 2a 2a 20 61 6e 64 20 74 68 61  tions.** and tha
11370 74 20 74 68 69 73 20 6f 62 6a 65 63 74 20 69 73  t this object is
11380 20 6f 6e 6c 79 20 75 73 65 66 75 6c 20 74 6f 20   only useful to 
11390 61 20 74 69 6e 79 20 6d 69 6e 6f 72 69 74 79 20  a tiny minority 
113a0 6f 66 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 0a  of applications.
113b0 2a 2a 20 77 69 74 68 20 73 70 65 63 69 61 6c 69  ** with speciali
113c0 7a 65 64 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  zed memory alloc
113d0 61 74 69 6f 6e 20 72 65 71 75 69 72 65 6d 65 6e  ation requiremen
113e0 74 73 2e 20 20 54 68 69 73 20 6f 62 6a 65 63 74  ts.  This object
113f0 20 69 73 0a 2a 2a 20 61 6c 73 6f 20 75 73 65 64   is.** also used
11400 20 64 75 72 69 6e 67 20 74 65 73 74 69 6e 67 20   during testing 
11410 6f 66 20 53 51 4c 69 74 65 20 69 6e 20 6f 72 64  of SQLite in ord
11420 65 72 20 74 6f 20 73 70 65 63 69 66 79 20 61 6e  er to specify an
11430 20 61 6c 74 65 72 6e 61 74 69 76 65 0a 2a 2a 20   alternative.** 
11440 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72  memory allocator
11450 20 74 68 61 74 20 73 69 6d 75 6c 61 74 65 73 20   that simulates 
11460 6d 65 6d 6f 72 79 20 6f 75 74 2d 6f 66 2d 6d 65  memory out-of-me
11470 6d 6f 72 79 20 63 6f 6e 64 69 74 69 6f 6e 73 20  mory conditions 
11480 69 6e 0a 2a 2a 20 6f 72 64 65 72 20 74 6f 20 76  in.** order to v
11490 65 72 69 66 79 20 74 68 61 74 20 53 51 4c 69 74  erify that SQLit
114a0 65 20 72 65 63 6f 76 65 72 73 20 67 72 61 63 65  e recovers grace
114b0 66 75 6c 6c 79 20 66 72 6f 6d 20 73 75 63 68 0a  fully from such.
114c0 2a 2a 20 63 6f 6e 64 69 74 69 6f 6e 73 2e 0a 2a  ** conditions..*
114d0 2a 0a 2a 2a 20 54 68 65 20 78 4d 61 6c 6c 6f 63  *.** The xMalloc
114e0 2c 20 78 52 65 61 6c 6c 6f 63 2c 20 61 6e 64 20  , xRealloc, and 
114f0 78 46 72 65 65 20 6d 65 74 68 6f 64 73 20 6d 75  xFree methods mu
11500 73 74 20 77 6f 72 6b 20 6c 69 6b 65 20 74 68 65  st work like the
11510 0a 2a 2a 20 6d 61 6c 6c 6f 63 28 29 2c 20 72 65  .** malloc(), re
11520 61 6c 6c 6f 63 28 29 20 61 6e 64 20 66 72 65 65  alloc() and free
11530 28 29 20 66 75 6e 63 74 69 6f 6e 73 20 66 72 6f  () functions fro
11540 6d 20 74 68 65 20 73 74 61 6e 64 61 72 64 20 43  m the standard C
11550 20 6c 69 62 72 61 72 79 2e 0a 2a 2a 20 5e 53 51   library..** ^SQ
11560 4c 69 74 65 20 67 75 61 72 61 6e 74 65 65 73 20  Lite guarantees 
11570 74 68 61 74 20 74 68 65 20 73 65 63 6f 6e 64 20  that the second 
11580 61 72 67 75 6d 65 6e 74 20 74 6f 0a 2a 2a 20 78  argument to.** x
11590 52 65 61 6c 6c 6f 63 20 69 73 20 61 6c 77 61 79  Realloc is alway
115a0 73 20 61 20 76 61 6c 75 65 20 72 65 74 75 72 6e  s a value return
115b0 65 64 20 62 79 20 61 20 70 72 69 6f 72 20 63 61  ed by a prior ca
115c0 6c 6c 20 74 6f 20 78 52 6f 75 6e 64 75 70 2e 0a  ll to xRoundup..
115d0 2a 2a 0a 2a 2a 20 78 53 69 7a 65 20 73 68 6f 75  **.** xSize shou
115e0 6c 64 20 72 65 74 75 72 6e 20 74 68 65 20 61 6c  ld return the al
115f0 6c 6f 63 61 74 65 64 20 73 69 7a 65 20 6f 66 20  located size of 
11600 61 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  a memory allocat
11610 69 6f 6e 0a 2a 2a 20 70 72 65 76 69 6f 75 73 6c  ion.** previousl
11620 79 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20  y obtained from 
11630 78 4d 61 6c 6c 6f 63 20 6f 72 20 78 52 65 61 6c  xMalloc or xReal
11640 6c 6f 63 2e 20 20 54 68 65 20 61 6c 6c 6f 63 61  loc.  The alloca
11650 74 65 64 20 73 69 7a 65 0a 2a 2a 20 69 73 20 61  ted size.** is a
11660 6c 77 61 79 73 20 61 74 20 6c 65 61 73 74 20 61  lways at least a
11670 73 20 62 69 67 20 61 73 20 74 68 65 20 72 65 71  s big as the req
11680 75 65 73 74 65 64 20 73 69 7a 65 20 62 75 74 20  uested size but 
11690 6d 61 79 20 62 65 20 6c 61 72 67 65 72 2e 0a 2a  may be larger..*
116a0 2a 0a 2a 2a 20 54 68 65 20 78 52 6f 75 6e 64 75  *.** The xRoundu
116b0 70 20 6d 65 74 68 6f 64 20 72 65 74 75 72 6e 73  p method returns
116c0 20 77 68 61 74 20 77 6f 75 6c 64 20 62 65 20 74   what would be t
116d0 68 65 20 61 6c 6c 6f 63 61 74 65 64 20 73 69 7a  he allocated siz
116e0 65 20 6f 66 0a 2a 2a 20 61 20 6d 65 6d 6f 72 79  e of.** a memory
116f0 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 67 69 76 65   allocation give
11700 6e 20 61 20 70 61 72 74 69 63 75 6c 61 72 20 72  n a particular r
11710 65 71 75 65 73 74 65 64 20 73 69 7a 65 2e 20 20  equested size.  
11720 4d 6f 73 74 20 6d 65 6d 6f 72 79 0a 2a 2a 20 61  Most memory.** a
11730 6c 6c 6f 63 61 74 6f 72 73 20 72 6f 75 6e 64 20  llocators round 
11740 75 70 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  up memory alloca
11750 74 69 6f 6e 73 20 61 74 20 6c 65 61 73 74 20 74  tions at least t
11760 6f 20 74 68 65 20 6e 65 78 74 20 6d 75 6c 74 69  o the next multi
11770 70 6c 65 0a 2a 2a 20 6f 66 20 38 2e 20 20 53 6f  ple.** of 8.  So
11780 6d 65 20 61 6c 6c 6f 63 61 74 6f 72 73 20 72 6f  me allocators ro
11790 75 6e 64 20 75 70 20 74 6f 20 61 20 6c 61 72 67  und up to a larg
117a0 65 72 20 6d 75 6c 74 69 70 6c 65 20 6f 72 20 74  er multiple or t
117b0 6f 20 61 20 70 6f 77 65 72 20 6f 66 20 32 2e 0a  o a power of 2..
117c0 2a 2a 20 45 76 65 72 79 20 6d 65 6d 6f 72 79 20  ** Every memory 
117d0 61 6c 6c 6f 63 61 74 69 6f 6e 20 72 65 71 75 65  allocation reque
117e0 73 74 20 63 6f 6d 69 6e 67 20 69 6e 20 74 68 72  st coming in thr
117f0 6f 75 67 68 20 5b 73 71 6c 69 74 65 33 5f 6d 61  ough [sqlite3_ma
11800 6c 6c 6f 63 28 29 5d 0a 2a 2a 20 6f 72 20 5b 73  lloc()].** or [s
11810 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63 28 29  qlite3_realloc()
11820 5d 20 66 69 72 73 74 20 63 61 6c 6c 73 20 78 52  ] first calls xR
11830 6f 75 6e 64 75 70 2e 20 20 49 66 20 78 52 6f 75  oundup.  If xRou
11840 6e 64 75 70 20 72 65 74 75 72 6e 73 20 30 2c 20  ndup returns 0, 
11850 0a 2a 2a 20 74 68 61 74 20 63 61 75 73 65 73 20  .** that causes 
11860 74 68 65 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e  the correspondin
11870 67 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  g memory allocat
11880 69 6f 6e 20 74 6f 20 66 61 69 6c 2e 0a 2a 2a 0a  ion to fail..**.
11890 2a 2a 20 54 68 65 20 78 49 6e 69 74 20 6d 65 74  ** The xInit met
118a0 68 6f 64 20 69 6e 69 74 69 61 6c 69 7a 65 73 20  hod initializes 
118b0 74 68 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  the memory alloc
118c0 61 74 6f 72 2e 20 20 46 6f 72 20 65 78 61 6d 70  ator.  For examp
118d0 6c 65 2c 0a 2a 2a 20 69 74 20 6d 69 67 68 74 20  le,.** it might 
118e0 61 6c 6c 6f 63 61 74 65 20 61 6e 79 20 72 65 71  allocate any req
118f0 75 69 72 65 20 6d 75 74 65 78 65 73 20 6f 72 20  uire mutexes or 
11900 69 6e 69 74 69 61 6c 69 7a 65 20 69 6e 74 65 72  initialize inter
11910 6e 61 6c 20 64 61 74 61 0a 2a 2a 20 73 74 72 75  nal data.** stru
11920 63 74 75 72 65 73 2e 20 20 54 68 65 20 78 53 68  ctures.  The xSh
11930 75 74 64 6f 77 6e 20 6d 65 74 68 6f 64 20 69 73  utdown method is
11940 20 69 6e 76 6f 6b 65 64 20 28 69 6e 64 69 72 65   invoked (indire
11950 63 74 6c 79 29 20 62 79 0a 2a 2a 20 5b 73 71 6c  ctly) by.** [sql
11960 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 5d  ite3_shutdown()]
11970 20 61 6e 64 20 73 68 6f 75 6c 64 20 64 65 61 6c   and should deal
11980 6c 6f 63 61 74 65 20 61 6e 79 20 72 65 73 6f 75  locate any resou
11990 72 63 65 73 20 61 63 71 75 69 72 65 64 0a 2a 2a  rces acquired.**
119a0 20 62 79 20 78 49 6e 69 74 2e 20 20 54 68 65 20   by xInit.  The 
119b0 70 41 70 70 44 61 74 61 20 70 6f 69 6e 74 65 72  pAppData pointer
119c0 20 69 73 20 75 73 65 64 20 61 73 20 74 68 65 20   is used as the 
119d0 6f 6e 6c 79 20 70 61 72 61 6d 65 74 65 72 20 74  only parameter t
119e0 6f 0a 2a 2a 20 78 49 6e 69 74 20 61 6e 64 20 78  o.** xInit and x
119f0 53 68 75 74 64 6f 77 6e 2e 0a 2a 2a 0a 2a 2a 20  Shutdown..**.** 
11a00 53 51 4c 69 74 65 20 68 6f 6c 64 73 20 74 68 65  SQLite holds the
11a10 20 5b 53 51 4c 49 54 45 5f 4d 55 54 45 58 5f 53   [SQLITE_MUTEX_S
11a20 54 41 54 49 43 5f 4d 41 53 54 45 52 5d 20 6d 75  TATIC_MASTER] mu
11a30 74 65 78 20 77 68 65 6e 20 69 74 20 69 6e 76 6f  tex when it invo
11a40 6b 65 73 0a 2a 2a 20 74 68 65 20 78 49 6e 69 74  kes.** the xInit
11a50 20 6d 65 74 68 6f 64 2c 20 73 6f 20 74 68 65 20   method, so the 
11a60 78 49 6e 69 74 20 6d 65 74 68 6f 64 20 6e 65 65  xInit method nee
11a70 64 20 6e 6f 74 20 62 65 20 74 68 72 65 61 64 73  d not be threads
11a80 61 66 65 2e 20 20 54 68 65 0a 2a 2a 20 78 53 68  afe.  The.** xSh
11a90 75 74 64 6f 77 6e 20 6d 65 74 68 6f 64 20 69 73  utdown method is
11aa0 20 6f 6e 6c 79 20 63 61 6c 6c 65 64 20 66 72 6f   only called fro
11ab0 6d 20 5b 73 71 6c 69 74 65 33 5f 73 68 75 74 64  m [sqlite3_shutd
11ac0 6f 77 6e 28 29 5d 20 73 6f 20 69 74 20 64 6f 65  own()] so it doe
11ad0 73 0a 2a 2a 20 6e 6f 74 20 6e 65 65 64 20 74 6f  s.** not need to
11ae0 20 62 65 20 74 68 72 65 61 64 73 61 66 65 20 65   be threadsafe e
11af0 69 74 68 65 72 2e 20 20 46 6f 72 20 61 6c 6c 20  ither.  For all 
11b00 6f 74 68 65 72 20 6d 65 74 68 6f 64 73 2c 20 53  other methods, S
11b10 51 4c 69 74 65 0a 2a 2a 20 68 6f 6c 64 73 20 74  QLite.** holds t
11b20 68 65 20 5b 53 51 4c 49 54 45 5f 4d 55 54 45 58  he [SQLITE_MUTEX
11b30 5f 53 54 41 54 49 43 5f 4d 45 4d 5d 20 6d 75 74  _STATIC_MEM] mut
11b40 65 78 20 61 73 20 6c 6f 6e 67 20 61 73 20 74 68  ex as long as th
11b50 65 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 43 4f 4e  e.** [SQLITE_CON
11b60 46 49 47 5f 4d 45 4d 53 54 41 54 55 53 5d 20 63  FIG_MEMSTATUS] c
11b70 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74  onfiguration opt
11b80 69 6f 6e 20 69 73 20 74 75 72 6e 65 64 20 6f 6e  ion is turned on
11b90 20 28 77 68 69 63 68 0a 2a 2a 20 69 74 20 69 73   (which.** it is
11ba0 20 62 79 20 64 65 66 61 75 6c 74 29 20 61 6e 64   by default) and
11bb0 20 73 6f 20 74 68 65 20 6d 65 74 68 6f 64 73 20   so the methods 
11bc0 61 72 65 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c  are automaticall
11bd0 79 20 73 65 72 69 61 6c 69 7a 65 64 2e 0a 2a 2a  y serialized..**
11be0 20 48 6f 77 65 76 65 72 2c 20 69 66 20 5b 53 51   However, if [SQ
11bf0 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 45 4d 53  LITE_CONFIG_MEMS
11c00 54 41 54 55 53 5d 20 69 73 20 64 69 73 61 62 6c  TATUS] is disabl
11c10 65 64 2c 20 74 68 65 6e 20 74 68 65 20 6f 74 68  ed, then the oth
11c20 65 72 0a 2a 2a 20 6d 65 74 68 6f 64 73 20 6d 75  er.** methods mu
11c30 73 74 20 62 65 20 74 68 72 65 61 64 73 61 66 65  st be threadsafe
11c40 20 6f 72 20 65 6c 73 65 20 6d 61 6b 65 20 74 68   or else make th
11c50 65 69 72 20 6f 77 6e 20 61 72 72 61 6e 67 65 6d  eir own arrangem
11c60 65 6e 74 73 20 66 6f 72 0a 2a 2a 20 73 65 72 69  ents for.** seri
11c70 61 6c 69 7a 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a  alization..**.**
11c80 20 53 51 4c 69 74 65 20 77 69 6c 6c 20 6e 65 76   SQLite will nev
11c90 65 72 20 69 6e 76 6f 6b 65 20 78 49 6e 69 74 28  er invoke xInit(
11ca0 29 20 6d 6f 72 65 20 74 68 61 6e 20 6f 6e 63 65  ) more than once
11cb0 20 77 69 74 68 6f 75 74 20 61 6e 20 69 6e 74 65   without an inte
11cc0 72 76 65 6e 69 6e 67 0a 2a 2a 20 63 61 6c 6c 20  rvening.** call 
11cd0 74 6f 20 78 53 68 75 74 64 6f 77 6e 28 29 2e 0a  to xShutdown()..
11ce0 2a 2f 0a 74 79 70 65 64 65 66 20 73 74 72 75 63  */.typedef struc
11cf0 74 20 73 71 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65  t sqlite3_mem_me
11d00 74 68 6f 64 73 20 73 71 6c 69 74 65 33 5f 6d 65  thods sqlite3_me
11d10 6d 5f 6d 65 74 68 6f 64 73 3b 0a 73 74 72 75 63  m_methods;.struc
11d20 74 20 73 71 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65  t sqlite3_mem_me
11d30 74 68 6f 64 73 20 7b 0a 20 20 76 6f 69 64 20 2a  thods {.  void *
11d40 28 2a 78 4d 61 6c 6c 6f 63 29 28 69 6e 74 29 3b  (*xMalloc)(int);
11d50 20 20 20 20 20 20 20 20 20 2f 2a 20 4d 65 6d 6f           /* Memo
11d60 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 66 75  ry allocation fu
11d70 6e 63 74 69 6f 6e 20 2a 2f 0a 20 20 76 6f 69 64  nction */.  void
11d80 20 28 2a 78 46 72 65 65 29 28 76 6f 69 64 2a 29   (*xFree)(void*)
11d90 3b 20 20 20 20 20 20 20 20 20 20 2f 2a 20 46 72  ;          /* Fr
11da0 65 65 20 61 20 70 72 69 6f 72 20 61 6c 6c 6f 63  ee a prior alloc
11db0 61 74 69 6f 6e 20 2a 2f 0a 20 20 76 6f 69 64 20  ation */.  void 
11dc0 2a 28 2a 78 52 65 61 6c 6c 6f 63 29 28 76 6f 69  *(*xRealloc)(voi
11dd0 64 2a 2c 69 6e 74 29 3b 20 20 2f 2a 20 52 65 73  d*,int);  /* Res
11de0 69 7a 65 20 61 6e 20 61 6c 6c 6f 63 61 74 69 6f  ize an allocatio
11df0 6e 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 53 69  n */.  int (*xSi
11e00 7a 65 29 28 76 6f 69 64 2a 29 3b 20 20 20 20 20  ze)(void*);     
11e10 20 20 20 20 20 20 2f 2a 20 52 65 74 75 72 6e 20        /* Return 
11e20 74 68 65 20 73 69 7a 65 20 6f 66 20 61 6e 20 61  the size of an a
11e30 6c 6c 6f 63 61 74 69 6f 6e 20 2a 2f 0a 20 20 69  llocation */.  i
11e40 6e 74 20 28 2a 78 52 6f 75 6e 64 75 70 29 28 69  nt (*xRoundup)(i
11e50 6e 74 29 3b 20 20 20 20 20 20 20 20 20 20 2f 2a  nt);          /*
11e60 20 52 6f 75 6e 64 20 75 70 20 72 65 71 75 65 73   Round up reques
11e70 74 20 73 69 7a 65 20 74 6f 20 61 6c 6c 6f 63 61  t size to alloca
11e80 74 69 6f 6e 20 73 69 7a 65 20 2a 2f 0a 20 20 69  tion size */.  i
11e90 6e 74 20 28 2a 78 49 6e 69 74 29 28 76 6f 69 64  nt (*xInit)(void
11ea0 2a 29 3b 20 20 20 20 20 20 20 20 20 20 20 2f 2a  *);           /*
11eb0 20 49 6e 69 74 69 61 6c 69 7a 65 20 74 68 65 20   Initialize the 
11ec0 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72  memory allocator
11ed0 20 2a 2f 0a 20 20 76 6f 69 64 20 28 2a 78 53 68   */.  void (*xSh
11ee0 75 74 64 6f 77 6e 29 28 76 6f 69 64 2a 29 3b 20  utdown)(void*); 
11ef0 20 20 20 20 20 2f 2a 20 44 65 69 6e 69 74 69 61       /* Deinitia
11f00 6c 69 7a 65 20 74 68 65 20 6d 65 6d 6f 72 79 20  lize the memory 
11f10 61 6c 6c 6f 63 61 74 6f 72 20 2a 2f 0a 20 20 76  allocator */.  v
11f20 6f 69 64 20 2a 70 41 70 70 44 61 74 61 3b 20 20  oid *pAppData;  
11f30 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a                /*
11f40 20 41 72 67 75 6d 65 6e 74 20 74 6f 20 78 49 6e   Argument to xIn
11f50 69 74 28 29 20 61 6e 64 20 78 53 68 75 74 64 6f  it() and xShutdo
11f60 77 6e 28 29 20 2a 2f 0a 7d 3b 0a 0a 2f 2a 0a 2a  wn() */.};../*.*
11f70 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6f 6e 66  * CAPI3REF: Conf
11f80 69 67 75 72 61 74 69 6f 6e 20 4f 70 74 69 6f 6e  iguration Option
11f90 73 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b  s.** KEYWORDS: {
11fa0 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70  configuration op
11fb0 74 69 6f 6e 7d 0a 2a 2a 0a 2a 2a 20 54 68 65 73  tion}.**.** Thes
11fc0 65 20 63 6f 6e 73 74 61 6e 74 73 20 61 72 65 20  e constants are 
11fd0 74 68 65 20 61 76 61 69 6c 61 62 6c 65 20 69 6e  the available in
11fe0 74 65 67 65 72 20 63 6f 6e 66 69 67 75 72 61 74  teger configurat
11ff0 69 6f 6e 20 6f 70 74 69 6f 6e 73 20 74 68 61 74  ion options that
12000 0a 2a 2a 20 63 61 6e 20 62 65 20 70 61 73 73 65  .** can be passe
12010 64 20 61 73 20 74 68 65 20 66 69 72 73 74 20 61  d as the first a
12020 72 67 75 6d 65 6e 74 20 74 6f 20 74 68 65 20 5b  rgument to the [
12030 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29  sqlite3_config()
12040 5d 20 69 6e 74 65 72 66 61 63 65 2e 0a 2a 2a 0a  ] interface..**.
12050 2a 2a 20 4e 65 77 20 63 6f 6e 66 69 67 75 72 61  ** New configura
12060 74 69 6f 6e 20 6f 70 74 69 6f 6e 73 20 6d 61 79  tion options may
12070 20 62 65 20 61 64 64 65 64 20 69 6e 20 66 75 74   be added in fut
12080 75 72 65 20 72 65 6c 65 61 73 65 73 20 6f 66 20  ure releases of 
12090 53 51 4c 69 74 65 2e 0a 2a 2a 20 45 78 69 73 74  SQLite..** Exist
120a0 69 6e 67 20 63 6f 6e 66 69 67 75 72 61 74 69 6f  ing configuratio
120b0 6e 20 6f 70 74 69 6f 6e 73 20 6d 69 67 68 74 20  n options might 
120c0 62 65 20 64 69 73 63 6f 6e 74 69 6e 75 65 64 2e  be discontinued.
120d0 20 20 41 70 70 6c 69 63 61 74 69 6f 6e 73 0a 2a    Applications.*
120e0 2a 20 73 68 6f 75 6c 64 20 63 68 65 63 6b 20 74  * should check t
120f0 68 65 20 72 65 74 75 72 6e 20 63 6f 64 65 20 66  he return code f
12100 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e  rom [sqlite3_con
12110 66 69 67 28 29 5d 20 74 6f 20 6d 61 6b 65 20 73  fig()] to make s
12120 75 72 65 20 74 68 61 74 0a 2a 2a 20 74 68 65 20  ure that.** the 
12130 63 61 6c 6c 20 77 6f 72 6b 65 64 2e 20 20 54 68  call worked.  Th
12140 65 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69  e [sqlite3_confi
12150 67 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 77  g()] interface w
12160 69 6c 6c 20 72 65 74 75 72 6e 20 61 0a 2a 2a 20  ill return a.** 
12170 6e 6f 6e 2d 7a 65 72 6f 20 5b 65 72 72 6f 72 20  non-zero [error 
12180 63 6f 64 65 5d 20 69 66 20 61 20 64 69 73 63 6f  code] if a disco
12190 6e 74 69 6e 75 65 64 20 6f 72 20 75 6e 73 75 70  ntinued or unsup
121a0 70 6f 72 74 65 64 20 63 6f 6e 66 69 67 75 72 61  ported configura
121b0 74 69 6f 6e 20 6f 70 74 69 6f 6e 0a 2a 2a 20 69  tion option.** i
121c0 73 20 69 6e 76 6f 6b 65 64 2e 0a 2a 2a 0a 2a 2a  s invoked..**.**
121d0 20 3c 64 6c 3e 0a 2a 2a 20 5b 5b 53 51 4c 49 54   <dl>.** [[SQLIT
121e0 45 5f 43 4f 4e 46 49 47 5f 53 49 4e 47 4c 45 54  E_CONFIG_SINGLET
121f0 48 52 45 41 44 5d 5d 20 3c 64 74 3e 53 51 4c 49  HREAD]] <dt>SQLI
12200 54 45 5f 43 4f 4e 46 49 47 5f 53 49 4e 47 4c 45  TE_CONFIG_SINGLE
12210 54 48 52 45 41 44 3c 2f 64 74 3e 0a 2a 2a 20 3c  THREAD</dt>.** <
12220 64 64 3e 54 68 65 72 65 20 61 72 65 20 6e 6f 20  dd>There are no 
12230 61 72 67 75 6d 65 6e 74 73 20 74 6f 20 74 68 69  arguments to thi
12240 73 20 6f 70 74 69 6f 6e 2e 20 20 5e 54 68 69 73  s option.  ^This
12250 20 6f 70 74 69 6f 6e 20 73 65 74 73 20 74 68 65   option sets the
12260 0a 2a 2a 20 5b 74 68 72 65 61 64 69 6e 67 20 6d  .** [threading m
12270 6f 64 65 5d 20 74 6f 20 53 69 6e 67 6c 65 2d 74  ode] to Single-t
12280 68 72 65 61 64 2e 20 20 49 6e 20 6f 74 68 65 72  hread.  In other
12290 20 77 6f 72 64 73 2c 20 69 74 20 64 69 73 61 62   words, it disab
122a0 6c 65 73 0a 2a 2a 20 61 6c 6c 20 6d 75 74 65 78  les.** all mutex
122b0 69 6e 67 20 61 6e 64 20 70 75 74 73 20 53 51 4c  ing and puts SQL
122c0 69 74 65 20 69 6e 74 6f 20 61 20 6d 6f 64 65 20  ite into a mode 
122d0 77 68 65 72 65 20 69 74 20 63 61 6e 20 6f 6e 6c  where it can onl
122e0 79 20 62 65 20 75 73 65 64 0a 2a 2a 20 62 79 20  y be used.** by 
122f0 61 20 73 69 6e 67 6c 65 20 74 68 72 65 61 64 2e  a single thread.
12300 20 20 20 5e 49 66 20 53 51 4c 69 74 65 20 69 73     ^If SQLite is
12310 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 0a 2a   compiled with.*
12320 2a 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 54 48  * the [SQLITE_TH
12330 52 45 41 44 53 41 46 45 20 7c 20 53 51 4c 49 54  READSAFE | SQLIT
12340 45 5f 54 48 52 45 41 44 53 41 46 45 3d 30 5d 20  E_THREADSAFE=0] 
12350 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
12360 69 6f 6e 20 74 68 65 6e 0a 2a 2a 20 69 74 20 69  ion then.** it i
12370 73 20 6e 6f 74 20 70 6f 73 73 69 62 6c 65 20 74  s not possible t
12380 6f 20 63 68 61 6e 67 65 20 74 68 65 20 5b 74 68  o change the [th
12390 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 66 72  reading mode] fr
123a0 6f 6d 20 69 74 73 20 64 65 66 61 75 6c 74 0a 2a  om its default.*
123b0 2a 20 76 61 6c 75 65 20 6f 66 20 53 69 6e 67 6c  * value of Singl
123c0 65 2d 74 68 72 65 61 64 20 61 6e 64 20 73 6f 20  e-thread and so 
123d0 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28  [sqlite3_config(
123e0 29 5d 20 77 69 6c 6c 20 72 65 74 75 72 6e 20 0a  )] will return .
123f0 2a 2a 20 5b 53 51 4c 49 54 45 5f 45 52 52 4f 52  ** [SQLITE_ERROR
12400 5d 20 69 66 20 63 61 6c 6c 65 64 20 77 69 74 68  ] if called with
12410 20 74 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46   the SQLITE_CONF
12420 49 47 5f 53 49 4e 47 4c 45 54 48 52 45 41 44 0a  IG_SINGLETHREAD.
12430 2a 2a 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e  ** configuration
12440 20 6f 70 74 69 6f 6e 2e 3c 2f 64 64 3e 0a 2a 2a   option.</dd>.**
12450 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e  .** [[SQLITE_CON
12460 46 49 47 5f 4d 55 4c 54 49 54 48 52 45 41 44 5d  FIG_MULTITHREAD]
12470 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e  ] <dt>SQLITE_CON
12480 46 49 47 5f 4d 55 4c 54 49 54 48 52 45 41 44 3c  FIG_MULTITHREAD<
12490 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 72  /dt>.** <dd>Ther
124a0 65 20 61 72 65 20 6e 6f 20 61 72 67 75 6d 65 6e  e are no argumen
124b0 74 73 20 74 6f 20 74 68 69 73 20 6f 70 74 69 6f  ts to this optio
124c0 6e 2e 20 20 5e 54 68 69 73 20 6f 70 74 69 6f 6e  n.  ^This option
124d0 20 73 65 74 73 20 74 68 65 0a 2a 2a 20 5b 74 68   sets the.** [th
124e0 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 74 6f  reading mode] to
124f0 20 4d 75 6c 74 69 2d 74 68 72 65 61 64 2e 20 20   Multi-thread.  
12500 49 6e 20 6f 74 68 65 72 20 77 6f 72 64 73 2c 20  In other words, 
12510 69 74 20 64 69 73 61 62 6c 65 73 0a 2a 2a 20 6d  it disables.** m
12520 75 74 65 78 69 6e 67 20 6f 6e 20 5b 64 61 74 61  utexing on [data
12530 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d  base connection]
12540 20 61 6e 64 20 5b 70 72 65 70 61 72 65 64 20 73   and [prepared s
12550 74 61 74 65 6d 65 6e 74 5d 20 6f 62 6a 65 63 74  tatement] object
12560 73 2e 0a 2a 2a 20 54 68 65 20 61 70 70 6c 69 63  s..** The applic
12570 61 74 69 6f 6e 20 69 73 20 72 65 73 70 6f 6e 73  ation is respons
12580 69 62 6c 65 20 66 6f 72 20 73 65 72 69 61 6c 69  ible for seriali
12590 7a 69 6e 67 20 61 63 63 65 73 73 20 74 6f 0a 2a  zing access to.*
125a0 2a 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  * [database conn
125b0 65 63 74 69 6f 6e 73 5d 20 61 6e 64 20 5b 70 72  ections] and [pr
125c0 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
125d0 73 5d 2e 20 20 42 75 74 20 6f 74 68 65 72 20 6d  s].  But other m
125e0 75 74 65 78 65 73 0a 2a 2a 20 61 72 65 20 65 6e  utexes.** are en
125f0 61 62 6c 65 64 20 73 6f 20 74 68 61 74 20 53 51  abled so that SQ
12600 4c 69 74 65 20 77 69 6c 6c 20 62 65 20 73 61 66  Lite will be saf
12610 65 20 74 6f 20 75 73 65 20 69 6e 20 61 20 6d 75  e to use in a mu
12620 6c 74 69 2d 74 68 72 65 61 64 65 64 0a 2a 2a 20  lti-threaded.** 
12630 65 6e 76 69 72 6f 6e 6d 65 6e 74 20 61 73 20 6c  environment as l
12640 6f 6e 67 20 61 73 20 6e 6f 20 74 77 6f 20 74 68  ong as no two th
12650 72 65 61 64 73 20 61 74 74 65 6d 70 74 20 74 6f  reads attempt to
12660 20 75 73 65 20 74 68 65 20 73 61 6d 65 0a 2a 2a   use the same.**
12670 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65   [database conne
12680 63 74 69 6f 6e 5d 20 61 74 20 74 68 65 20 73 61  ction] at the sa
12690 6d 65 20 74 69 6d 65 2e 20 20 5e 49 66 20 53 51  me time.  ^If SQ
126a0 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c 65 64  Lite is compiled
126b0 20 77 69 74 68 0a 2a 2a 20 74 68 65 20 5b 53 51   with.** the [SQ
126c0 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45 20  LITE_THREADSAFE 
126d0 7c 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53  | SQLITE_THREADS
126e0 41 46 45 3d 30 5d 20 63 6f 6d 70 69 6c 65 2d 74  AFE=0] compile-t
126f0 69 6d 65 20 6f 70 74 69 6f 6e 20 74 68 65 6e 0a  ime option then.
12700 2a 2a 20 69 74 20 69 73 20 6e 6f 74 20 70 6f 73  ** it is not pos
12710 73 69 62 6c 65 20 74 6f 20 73 65 74 20 74 68 65  sible to set the
12720 20 4d 75 6c 74 69 2d 74 68 72 65 61 64 20 5b 74   Multi-thread [t
12730 68 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 61  hreading mode] a
12740 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63  nd.** [sqlite3_c
12750 6f 6e 66 69 67 28 29 5d 20 77 69 6c 6c 20 72 65  onfig()] will re
12760 74 75 72 6e 20 5b 53 51 4c 49 54 45 5f 45 52 52  turn [SQLITE_ERR
12770 4f 52 5d 20 69 66 20 63 61 6c 6c 65 64 20 77 69  OR] if called wi
12780 74 68 20 74 68 65 0a 2a 2a 20 53 51 4c 49 54 45  th the.** SQLITE
12790 5f 43 4f 4e 46 49 47 5f 4d 55 4c 54 49 54 48 52  _CONFIG_MULTITHR
127a0 45 41 44 20 63 6f 6e 66 69 67 75 72 61 74 69 6f  EAD configuratio
127b0 6e 20 6f 70 74 69 6f 6e 2e 3c 2f 64 64 3e 0a 2a  n option.</dd>.*
127c0 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 43 4f  *.** [[SQLITE_CO
127d0 4e 46 49 47 5f 53 45 52 49 41 4c 49 5a 45 44 5d  NFIG_SERIALIZED]
127e0 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e  ] <dt>SQLITE_CON
127f0 46 49 47 5f 53 45 52 49 41 4c 49 5a 45 44 3c 2f  FIG_SERIALIZED</
12800 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 72 65  dt>.** <dd>There
12810 20 61 72 65 20 6e 6f 20 61 72 67 75 6d 65 6e 74   are no argument
12820 73 20 74 6f 20 74 68 69 73 20 6f 70 74 69 6f 6e  s to this option
12830 2e 20 20 5e 54 68 69 73 20 6f 70 74 69 6f 6e 20  .  ^This option 
12840 73 65 74 73 20 74 68 65 0a 2a 2a 20 5b 74 68 72  sets the.** [thr
12850 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 74 6f 20  eading mode] to 
12860 53 65 72 69 61 6c 69 7a 65 64 2e 20 49 6e 20 6f  Serialized. In o
12870 74 68 65 72 20 77 6f 72 64 73 2c 20 74 68 69 73  ther words, this
12880 20 6f 70 74 69 6f 6e 20 65 6e 61 62 6c 65 73 0a   option enables.
12890 2a 2a 20 61 6c 6c 20 6d 75 74 65 78 65 73 20 69  ** all mutexes i
128a0 6e 63 6c 75 64 69 6e 67 20 74 68 65 20 72 65 63  ncluding the rec
128b0 75 72 73 69 76 65 0a 2a 2a 20 6d 75 74 65 78 65  ursive.** mutexe
128c0 73 20 6f 6e 20 5b 64 61 74 61 62 61 73 65 20 63  s on [database c
128d0 6f 6e 6e 65 63 74 69 6f 6e 5d 20 61 6e 64 20 5b  onnection] and [
128e0 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
128f0 6e 74 5d 20 6f 62 6a 65 63 74 73 2e 0a 2a 2a 20  nt] objects..** 
12900 49 6e 20 74 68 69 73 20 6d 6f 64 65 20 28 77 68  In this mode (wh
12910 69 63 68 20 69 73 20 74 68 65 20 64 65 66 61 75  ich is the defau
12920 6c 74 20 77 68 65 6e 20 53 51 4c 69 74 65 20 69  lt when SQLite i
12930 73 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 0a  s compiled with.
12940 2a 2a 20 5b 53 51 4c 49 54 45 5f 54 48 52 45 41  ** [SQLITE_THREA
12950 44 53 41 46 45 3d 31 5d 29 20 74 68 65 20 53 51  DSAFE=1]) the SQ
12960 4c 69 74 65 20 6c 69 62 72 61 72 79 20 77 69 6c  Lite library wil
12970 6c 20 69 74 73 65 6c 66 20 73 65 72 69 61 6c 69  l itself seriali
12980 7a 65 20 61 63 63 65 73 73 0a 2a 2a 20 74 6f 20  ze access.** to 
12990 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63  [database connec
129a0 74 69 6f 6e 73 5d 20 61 6e 64 20 5b 70 72 65 70  tions] and [prep
129b0 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 73 5d  ared statements]
129c0 20 73 6f 20 74 68 61 74 20 74 68 65 0a 2a 2a 20   so that the.** 
129d0 61 70 70 6c 69 63 61 74 69 6f 6e 20 69 73 20 66  application is f
129e0 72 65 65 20 74 6f 20 75 73 65 20 74 68 65 20 73  ree to use the s
129f0 61 6d 65 20 5b 64 61 74 61 62 61 73 65 20 63 6f  ame [database co
12a00 6e 6e 65 63 74 69 6f 6e 5d 20 6f 72 20 74 68 65  nnection] or the
12a10 0a 2a 2a 20 73 61 6d 65 20 5b 70 72 65 70 61 72  .** same [prepar
12a20 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 69 6e  ed statement] in
12a30 20 64 69 66 66 65 72 65 6e 74 20 74 68 72 65 61   different threa
12a40 64 73 20 61 74 20 74 68 65 20 73 61 6d 65 20 74  ds at the same t
12a50 69 6d 65 2e 0a 2a 2a 20 5e 49 66 20 53 51 4c 69  ime..** ^If SQLi
12a60 74 65 20 69 73 20 63 6f 6d 70 69 6c 65 64 20 77  te is compiled w
12a70 69 74 68 0a 2a 2a 20 74 68 65 20 5b 53 51 4c 49  ith.** the [SQLI
12a80 54 45 5f 54 48 52 45 41 44 53 41 46 45 20 7c 20  TE_THREADSAFE | 
12a90 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46  SQLITE_THREADSAF
12aa0 45 3d 30 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d  E=0] compile-tim
12ab0 65 20 6f 70 74 69 6f 6e 20 74 68 65 6e 0a 2a 2a  e option then.**
12ac0 20 69 74 20 69 73 20 6e 6f 74 20 70 6f 73 73 69   it is not possi
12ad0 62 6c 65 20 74 6f 20 73 65 74 20 74 68 65 20 53  ble to set the S
12ae0 65 72 69 61 6c 69 7a 65 64 20 5b 74 68 72 65 61  erialized [threa
12af0 64 69 6e 67 20 6d 6f 64 65 5d 20 61 6e 64 0a 2a  ding mode] and.*
12b00 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69  * [sqlite3_confi
12b10 67 28 29 5d 20 77 69 6c 6c 20 72 65 74 75 72 6e  g()] will return
12b20 20 5b 53 51 4c 49 54 45 5f 45 52 52 4f 52 5d 20   [SQLITE_ERROR] 
12b30 69 66 20 63 61 6c 6c 65 64 20 77 69 74 68 20 74  if called with t
12b40 68 65 0a 2a 2a 20 53 51 4c 49 54 45 5f 43 4f 4e  he.** SQLITE_CON
12b50 46 49 47 5f 53 45 52 49 41 4c 49 5a 45 44 20 63  FIG_SERIALIZED c
12b60 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74  onfiguration opt
12b70 69 6f 6e 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20  ion.</dd>.**.** 
12b80 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  [[SQLITE_CONFIG_
12b90 4d 41 4c 4c 4f 43 5d 5d 20 3c 64 74 3e 53 51 4c  MALLOC]] <dt>SQL
12ba0 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 41 4c 4c 4f  ITE_CONFIG_MALLO
12bb0 43 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e  C</dt>.** <dd> ^
12bc0 28 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46  (The SQLITE_CONF
12bd0 49 47 5f 4d 41 4c 4c 4f 43 20 6f 70 74 69 6f 6e  IG_MALLOC option
12be0 20 74 61 6b 65 73 20 61 20 73 69 6e 67 6c 65 20   takes a single 
12bf0 61 72 67 75 6d 65 6e 74 20 77 68 69 63 68 20 69  argument which i
12c00 73 20 0a 2a 2a 20 61 20 70 6f 69 6e 74 65 72 20  s .** a pointer 
12c10 74 6f 20 61 6e 20 69 6e 73 74 61 6e 63 65 20 6f  to an instance o
12c20 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 6d  f the [sqlite3_m
12c30 65 6d 5f 6d 65 74 68 6f 64 73 5d 20 73 74 72 75  em_methods] stru
12c40 63 74 75 72 65 2e 0a 2a 2a 20 54 68 65 20 61 72  cture..** The ar
12c50 67 75 6d 65 6e 74 20 73 70 65 63 69 66 69 65 73  gument specifies
12c60 0a 2a 2a 20 61 6c 74 65 72 6e 61 74 69 76 65 20  .** alternative 
12c70 6c 6f 77 2d 6c 65 76 65 6c 20 6d 65 6d 6f 72 79  low-level memory
12c80 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 72 6f 75 74   allocation rout
12c90 69 6e 65 73 20 74 6f 20 62 65 20 75 73 65 64 20  ines to be used 
12ca0 69 6e 20 70 6c 61 63 65 20 6f 66 0a 2a 2a 20 74  in place of.** t
12cb0 68 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  he memory alloca
12cc0 74 69 6f 6e 20 72 6f 75 74 69 6e 65 73 20 62 75  tion routines bu
12cd0 69 6c 74 20 69 6e 74 6f 20 53 51 4c 69 74 65 2e  ilt into SQLite.
12ce0 29 5e 20 5e 53 51 4c 69 74 65 20 6d 61 6b 65 73  )^ ^SQLite makes
12cf0 0a 2a 2a 20 69 74 73 20 6f 77 6e 20 70 72 69 76  .** its own priv
12d00 61 74 65 20 63 6f 70 79 20 6f 66 20 74 68 65 20  ate copy of the 
12d10 63 6f 6e 74 65 6e 74 20 6f 66 20 74 68 65 20 5b  content of the [
12d20 73 71 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65 74 68  sqlite3_mem_meth
12d30 6f 64 73 5d 20 73 74 72 75 63 74 75 72 65 0a 2a  ods] structure.*
12d40 2a 20 62 65 66 6f 72 65 20 74 68 65 20 5b 73 71  * before the [sq
12d50 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d 20  lite3_config()] 
12d60 63 61 6c 6c 20 72 65 74 75 72 6e 73 2e 3c 2f 64  call returns.</d
12d70 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  d>.**.** [[SQLIT
12d80 45 5f 43 4f 4e 46 49 47 5f 47 45 54 4d 41 4c 4c  E_CONFIG_GETMALL
12d90 4f 43 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f  OC]] <dt>SQLITE_
12da0 43 4f 4e 46 49 47 5f 47 45 54 4d 41 4c 4c 4f 43  CONFIG_GETMALLOC
12db0 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 28  </dt>.** <dd> ^(
12dc0 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  The SQLITE_CONFI
12dd0 47 5f 47 45 54 4d 41 4c 4c 4f 43 20 6f 70 74 69  G_GETMALLOC opti
12de0 6f 6e 20 74 61 6b 65 73 20 61 20 73 69 6e 67 6c  on takes a singl
12df0 65 20 61 72 67 75 6d 65 6e 74 20 77 68 69 63 68  e argument which
12e00 0a 2a 2a 20 69 73 20 61 20 70 6f 69 6e 74 65 72  .** is a pointer
12e10 20 74 6f 20 61 6e 20 69 6e 73 74 61 6e 63 65 20   to an instance 
12e20 6f 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  of the [sqlite3_
12e30 6d 65 6d 5f 6d 65 74 68 6f 64 73 5d 20 73 74 72  mem_methods] str
12e40 75 63 74 75 72 65 2e 0a 2a 2a 20 54 68 65 20 5b  ucture..** The [
12e50 73 71 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65 74 68  sqlite3_mem_meth
12e60 6f 64 73 5d 0a 2a 2a 20 73 74 72 75 63 74 75 72  ods].** structur
12e70 65 20 69 73 20 66 69 6c 6c 65 64 20 77 69 74 68  e is filled with
12e80 20 74 68 65 20 63 75 72 72 65 6e 74 6c 79 20 64   the currently d
12e90 65 66 69 6e 65 64 20 6d 65 6d 6f 72 79 20 61 6c  efined memory al
12ea0 6c 6f 63 61 74 69 6f 6e 20 72 6f 75 74 69 6e 65  location routine
12eb0 73 2e 29 5e 0a 2a 2a 20 54 68 69 73 20 6f 70 74  s.)^.** This opt
12ec0 69 6f 6e 20 63 61 6e 20 62 65 20 75 73 65 64 20  ion can be used 
12ed0 74 6f 20 6f 76 65 72 6c 6f 61 64 20 74 68 65 20  to overload the 
12ee0 64 65 66 61 75 6c 74 20 6d 65 6d 6f 72 79 20 61  default memory a
12ef0 6c 6c 6f 63 61 74 69 6f 6e 0a 2a 2a 20 72 6f 75  llocation.** rou
12f00 74 69 6e 65 73 20 77 69 74 68 20 61 20 77 72 61  tines with a wra
12f10 70 70 65 72 20 74 68 61 74 20 73 69 6d 75 6c 61  pper that simula
12f20 74 69 6f 6e 73 20 6d 65 6d 6f 72 79 20 61 6c 6c  tions memory all
12f30 6f 63 61 74 69 6f 6e 20 66 61 69 6c 75 72 65 20  ocation failure 
12f40 6f 72 0a 2a 2a 20 74 72 61 63 6b 73 20 6d 65 6d  or.** tracks mem
12f50 6f 72 79 20 75 73 61 67 65 2c 20 66 6f 72 20 65  ory usage, for e
12f60 78 61 6d 70 6c 65 2e 20 3c 2f 64 64 3e 0a 2a 2a  xample. </dd>.**
12f70 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e  .** [[SQLITE_CON
12f80 46 49 47 5f 4d 45 4d 53 54 41 54 55 53 5d 5d 20  FIG_MEMSTATUS]] 
12f90 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49  <dt>SQLITE_CONFI
12fa0 47 5f 4d 45 4d 53 54 41 54 55 53 3c 2f 64 74 3e  G_MEMSTATUS</dt>
12fb0 0a 2a 2a 20 3c 64 64 3e 20 5e 54 68 65 20 53 51  .** <dd> ^The SQ
12fc0 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 45 4d 53  LITE_CONFIG_MEMS
12fd0 54 41 54 55 53 20 6f 70 74 69 6f 6e 20 74 61 6b  TATUS option tak
12fe0 65 73 20 73 69 6e 67 6c 65 20 61 72 67 75 6d 65  es single argume
12ff0 6e 74 20 6f 66 20 74 79 70 65 20 69 6e 74 2c 0a  nt of type int,.
13000 2a 2a 20 69 6e 74 65 72 70 72 65 74 65 64 20 61  ** interpreted a
13010 73 20 61 20 62 6f 6f 6c 65 61 6e 2c 20 77 68 69  s a boolean, whi
13020 63 68 20 65 6e 61 62 6c 65 73 20 6f 72 20 64 69  ch enables or di
13030 73 61 62 6c 65 73 20 74 68 65 20 63 6f 6c 6c 65  sables the colle
13040 63 74 69 6f 6e 20 6f 66 0a 2a 2a 20 6d 65 6d 6f  ction of.** memo
13050 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 73 74  ry allocation st
13060 61 74 69 73 74 69 63 73 2e 20 5e 28 57 68 65 6e  atistics. ^(When
13070 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69   memory allocati
13080 6f 6e 20 73 74 61 74 69 73 74 69 63 73 20 61 72  on statistics ar
13090 65 0a 2a 2a 20 64 69 73 61 62 6c 65 64 2c 20 74  e.** disabled, t
130a0 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 53 51 4c  he following SQL
130b0 69 74 65 20 69 6e 74 65 72 66 61 63 65 73 20 62  ite interfaces b
130c0 65 63 6f 6d 65 20 6e 6f 6e 2d 6f 70 65 72 61 74  ecome non-operat
130d0 69 6f 6e 61 6c 3a 0a 2a 2a 20 20 20 3c 75 6c 3e  ional:.**   <ul>
130e0 0a 2a 2a 20 20 20 3c 6c 69 3e 20 5b 73 71 6c 69  .**   <li> [sqli
130f0 74 65 33 5f 6d 65 6d 6f 72 79 5f 75 73 65 64 28  te3_memory_used(
13100 29 5d 0a 2a 2a 20 20 20 3c 6c 69 3e 20 5b 73 71  )].**   <li> [sq
13110 6c 69 74 65 33 5f 6d 65 6d 6f 72 79 5f 68 69 67  lite3_memory_hig
13120 68 77 61 74 65 72 28 29 5d 0a 2a 2a 20 20 20 3c  hwater()].**   <
13130 6c 69 3e 20 5b 73 71 6c 69 74 65 33 5f 73 6f 66  li> [sqlite3_sof
13140 74 5f 68 65 61 70 5f 6c 69 6d 69 74 36 34 28 29  t_heap_limit64()
13150 5d 0a 2a 2a 20 20 20 3c 6c 69 3e 20 5b 73 71 6c  ].**   <li> [sql
13160 69 74 65 33 5f 73 74 61 74 75 73 36 34 28 29 5d  ite3_status64()]
13170 0a 2a 2a 20 20 20 3c 2f 75 6c 3e 29 5e 0a 2a 2a  .**   </ul>)^.**
13180 20 5e 4d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74   ^Memory allocat
13190 69 6f 6e 20 73 74 61 74 69 73 74 69 63 73 20 61  ion statistics a
131a0 72 65 20 65 6e 61 62 6c 65 64 20 62 79 20 64 65  re enabled by de
131b0 66 61 75 6c 74 20 75 6e 6c 65 73 73 20 53 51 4c  fault unless SQL
131c0 69 74 65 20 69 73 0a 2a 2a 20 63 6f 6d 70 69 6c  ite is.** compil
131d0 65 64 20 77 69 74 68 20 5b 53 51 4c 49 54 45 5f  ed with [SQLITE_
131e0 44 45 46 41 55 4c 54 5f 4d 45 4d 53 54 41 54 55  DEFAULT_MEMSTATU
131f0 53 5d 3d 30 20 69 6e 20 77 68 69 63 68 20 63 61  S]=0 in which ca
13200 73 65 20 6d 65 6d 6f 72 79 0a 2a 2a 20 61 6c 6c  se memory.** all
13210 6f 63 61 74 69 6f 6e 20 73 74 61 74 69 73 74 69  ocation statisti
13220 63 73 20 61 72 65 20 64 69 73 61 62 6c 65 64 20  cs are disabled 
13230 62 79 20 64 65 66 61 75 6c 74 2e 0a 2a 2a 20 3c  by default..** <
13240 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c  /dd>.**.** [[SQL
13250 49 54 45 5f 43 4f 4e 46 49 47 5f 53 43 52 41 54  ITE_CONFIG_SCRAT
13260 43 48 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f  CH]] <dt>SQLITE_
13270 43 4f 4e 46 49 47 5f 53 43 52 41 54 43 48 3c 2f  CONFIG_SCRATCH</
13280 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 54 68 65  dt>.** <dd> ^The
13290 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53   SQLITE_CONFIG_S
132a0 43 52 41 54 43 48 20 6f 70 74 69 6f 6e 20 73 70  CRATCH option sp
132b0 65 63 69 66 69 65 73 20 61 20 73 74 61 74 69 63  ecifies a static
132c0 20 6d 65 6d 6f 72 79 20 62 75 66 66 65 72 0a 2a   memory buffer.*
132d0 2a 20 74 68 61 74 20 53 51 4c 69 74 65 20 63 61  * that SQLite ca
132e0 6e 20 75 73 65 20 66 6f 72 20 73 63 72 61 74 63  n use for scratc
132f0 68 20 6d 65 6d 6f 72 79 2e 20 20 5e 28 54 68 65  h memory.  ^(The
13300 72 65 20 61 72 65 20 74 68 72 65 65 20 61 72 67  re are three arg
13310 75 6d 65 6e 74 73 0a 2a 2a 20 74 6f 20 53 51 4c  uments.** to SQL
13320 49 54 45 5f 43 4f 4e 46 49 47 5f 53 43 52 41 54  ITE_CONFIG_SCRAT
13330 43 48 3a 20 20 41 20 70 6f 69 6e 74 65 72 20 61  CH:  A pointer a
13340 6e 20 38 2d 62 79 74 65 0a 2a 2a 20 61 6c 69 67  n 8-byte.** alig
13350 6e 65 64 20 6d 65 6d 6f 72 79 20 62 75 66 66 65  ned memory buffe
13360 72 20 66 72 6f 6d 20 77 68 69 63 68 20 74 68 65  r from which the
13370 20 73 63 72 61 74 63 68 20 61 6c 6c 6f 63 61 74   scratch allocat
13380 69 6f 6e 73 20 77 69 6c 6c 20 62 65 0a 2a 2a 20  ions will be.** 
13390 64 72 61 77 6e 2c 20 74 68 65 20 73 69 7a 65 20  drawn, the size 
133a0 6f 66 20 65 61 63 68 20 73 63 72 61 74 63 68 20  of each scratch 
133b0 61 6c 6c 6f 63 61 74 69 6f 6e 20 28 73 7a 29 2c  allocation (sz),
133c0 0a 2a 2a 20 61 6e 64 20 74 68 65 20 6d 61 78 69  .** and the maxi
133d0 6d 75 6d 20 6e 75 6d 62 65 72 20 6f 66 20 73 63  mum number of sc
133e0 72 61 74 63 68 20 61 6c 6c 6f 63 61 74 69 6f 6e  ratch allocation
133f0 73 20 28 4e 29 2e 29 5e 0a 2a 2a 20 54 68 65 20  s (N).)^.** The 
13400 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 6d  first argument m
13410 75 73 74 20 62 65 20 61 20 70 6f 69 6e 74 65 72  ust be a pointer
13420 20 74 6f 20 61 6e 20 38 2d 62 79 74 65 20 61 6c   to an 8-byte al
13430 69 67 6e 65 64 20 62 75 66 66 65 72 0a 2a 2a 20  igned buffer.** 
13440 6f 66 20 61 74 20 6c 65 61 73 74 20 73 7a 2a 4e  of at least sz*N
13450 20 62 79 74 65 73 20 6f 66 20 6d 65 6d 6f 72 79   bytes of memory
13460 2e 0a 2a 2a 20 5e 53 51 4c 69 74 65 20 77 69 6c  ..** ^SQLite wil
13470 6c 20 6e 6f 74 20 75 73 65 20 6d 6f 72 65 20 74  l not use more t
13480 68 61 6e 20 6f 6e 65 20 73 63 72 61 74 63 68 20  han one scratch 
13490 62 75 66 66 65 72 73 20 70 65 72 20 74 68 72 65  buffers per thre
134a0 61 64 2e 0a 2a 2a 20 5e 53 51 4c 69 74 65 20 77  ad..** ^SQLite w
134b0 69 6c 6c 20 6e 65 76 65 72 20 72 65 71 75 65 73  ill never reques
134c0 74 20 61 20 73 63 72 61 74 63 68 20 62 75 66 66  t a scratch buff
134d0 65 72 20 74 68 61 74 20 69 73 20 6d 6f 72 65 20  er that is more 
134e0 74 68 61 6e 20 36 0a 2a 2a 20 74 69 6d 65 73 20  than 6.** times 
134f0 74 68 65 20 64 61 74 61 62 61 73 65 20 70 61 67  the database pag
13500 65 20 73 69 7a 65 2e 0a 2a 2a 20 5e 49 66 20 53  e size..** ^If S
13510 51 4c 69 74 65 20 6e 65 65 64 73 20 6e 65 65 64  QLite needs need
13520 73 20 61 64 64 69 74 69 6f 6e 61 6c 0a 2a 2a 20  s additional.** 
13530 73 63 72 61 74 63 68 20 6d 65 6d 6f 72 79 20 62  scratch memory b
13540 65 79 6f 6e 64 20 77 68 61 74 20 69 73 20 70 72  eyond what is pr
13550 6f 76 69 64 65 64 20 62 79 20 74 68 69 73 20 63  ovided by this c
13560 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74  onfiguration opt
13570 69 6f 6e 2c 20 74 68 65 6e 20 0a 2a 2a 20 5b 73  ion, then .** [s
13580 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d  qlite3_malloc()]
13590 20 77 69 6c 6c 20 62 65 20 75 73 65 64 20 74 6f   will be used to
135a0 20 6f 62 74 61 69 6e 20 74 68 65 20 6d 65 6d 6f   obtain the memo
135b0 72 79 20 6e 65 65 64 65 64 2e 3c 70 3e 0a 2a 2a  ry needed.<p>.**
135c0 20 5e 57 68 65 6e 20 74 68 65 20 61 70 70 6c 69   ^When the appli
135d0 63 61 74 69 6f 6e 20 70 72 6f 76 69 64 65 73 20  cation provides 
135e0 61 6e 79 20 61 6d 6f 75 6e 74 20 6f 66 20 73 63  any amount of sc
135f0 72 61 74 63 68 20 6d 65 6d 6f 72 79 20 75 73 69  ratch memory usi
13600 6e 67 0a 2a 2a 20 53 51 4c 49 54 45 5f 43 4f 4e  ng.** SQLITE_CON
13610 46 49 47 5f 53 43 52 41 54 43 48 2c 20 53 51 4c  FIG_SCRATCH, SQL
13620 69 74 65 20 61 76 6f 69 64 73 20 75 6e 6e 65 63  ite avoids unnec
13630 65 73 73 61 72 79 20 6c 61 72 67 65 0a 2a 2a 20  essary large.** 
13640 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 7c  [sqlite3_malloc|
13650 68 65 61 70 20 61 6c 6c 6f 63 61 74 69 6f 6e 73  heap allocations
13660 5d 2e 0a 2a 2a 20 54 68 69 73 20 63 61 6e 20 68  ]..** This can h
13670 65 6c 70 20 5b 52 6f 62 73 6f 6e 20 70 72 6f 6f  elp [Robson proo
13680 66 7c 70 72 65 76 65 6e 74 20 6d 65 6d 6f 72 79  f|prevent memory
13690 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 66 61 69 6c   allocation fail
136a0 75 72 65 73 5d 20 64 75 65 20 74 6f 20 68 65 61  ures] due to hea
136b0 70 0a 2a 2a 20 66 72 61 67 6d 65 6e 74 61 74 69  p.** fragmentati
136c0 6f 6e 20 69 6e 20 6c 6f 77 2d 6d 65 6d 6f 72 79  on in low-memory
136d0 20 65 6d 62 65 64 64 65 64 20 73 79 73 74 65 6d   embedded system
136e0 73 2e 0a 2a 2a 20 3c 2f 64 64 3e 0a 2a 2a 0a 2a  s..** </dd>.**.*
136f0 2a 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49  * [[SQLITE_CONFI
13700 47 5f 50 41 47 45 43 41 43 48 45 5d 5d 20 3c 64  G_PAGECACHE]] <d
13710 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  t>SQLITE_CONFIG_
13720 50 41 47 45 43 41 43 48 45 3c 2f 64 74 3e 0a 2a  PAGECACHE</dt>.*
13730 2a 20 3c 64 64 3e 20 5e 54 68 65 20 53 51 4c 49  * <dd> ^The SQLI
13740 54 45 5f 43 4f 4e 46 49 47 5f 50 41 47 45 43 41  TE_CONFIG_PAGECA
13750 43 48 45 20 6f 70 74 69 6f 6e 20 73 70 65 63 69  CHE option speci
13760 66 69 65 73 20 61 20 6d 65 6d 6f 72 79 20 70 6f  fies a memory po
13770 6f 6c 0a 2a 2a 20 74 68 61 74 20 53 51 4c 69 74  ol.** that SQLit
13780 65 20 63 61 6e 20 75 73 65 20 66 6f 72 20 74 68  e can use for th
13790 65 20 64 61 74 61 62 61 73 65 20 70 61 67 65 20  e database page 
137a0 63 61 63 68 65 20 77 69 74 68 20 74 68 65 20 64  cache with the d
137b0 65 66 61 75 6c 74 20 70 61 67 65 0a 2a 2a 20 63  efault page.** c
137c0 61 63 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74  ache implementat
137d0 69 6f 6e 2e 20 20 0a 2a 2a 20 54 68 69 73 20 63  ion.  .** This c
137e0 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74  onfiguration opt
137f0 69 6f 6e 20 69 73 20 61 20 6e 6f 2d 6f 70 20 69  ion is a no-op i
13800 66 20 61 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e  f an application
13810 2d 64 65 66 69 6e 65 20 70 61 67 65 0a 2a 2a 20  -define page.** 
13820 63 61 63 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61  cache implementa
13830 74 69 6f 6e 20 69 73 20 6c 6f 61 64 65 64 20 75  tion is loaded u
13840 73 69 6e 67 20 74 68 65 20 5b 53 51 4c 49 54 45  sing the [SQLITE
13850 5f 43 4f 4e 46 49 47 5f 50 43 41 43 48 45 32 5d  _CONFIG_PCACHE2]
13860 2e 0a 2a 2a 20 5e 54 68 65 72 65 20 61 72 65 20  ..** ^There are 
13870 74 68 72 65 65 20 61 72 67 75 6d 65 6e 74 73 20  three arguments 
13880 74 6f 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47  to SQLITE_CONFIG
13890 5f 50 41 47 45 43 41 43 48 45 3a 20 41 20 70 6f  _PAGECACHE: A po
138a0 69 6e 74 65 72 20 74 6f 0a 2a 2a 20 38 2d 62 79  inter to.** 8-by
138b0 74 65 20 61 6c 69 67 6e 65 64 20 6d 65 6d 6f 72  te aligned memor
138c0 79 20 28 70 4d 65 6d 29 2c 20 74 68 65 20 73 69  y (pMem), the si
138d0 7a 65 20 6f 66 20 65 61 63 68 20 70 61 67 65 20  ze of each page 
138e0 63 61 63 68 65 20 6c 69 6e 65 20 28 73 7a 29 2c  cache line (sz),
138f0 0a 2a 2a 20 61 6e 64 20 74 68 65 20 6e 75 6d 62  .** and the numb
13900 65 72 20 6f 66 20 63 61 63 68 65 20 6c 69 6e 65  er of cache line
13910 73 20 28 4e 29 2e 0a 2a 2a 20 54 68 65 20 73 7a  s (N)..** The sz
13920 20 61 72 67 75 6d 65 6e 74 20 73 68 6f 75 6c 64   argument should
13930 20 62 65 20 74 68 65 20 73 69 7a 65 20 6f 66 20   be the size of 
13940 74 68 65 20 6c 61 72 67 65 73 74 20 64 61 74 61  the largest data
13950 62 61 73 65 20 70 61 67 65 0a 2a 2a 20 28 61 20  base page.** (a 
13960 70 6f 77 65 72 20 6f 66 20 74 77 6f 20 62 65 74  power of two bet
13970 77 65 65 6e 20 35 31 32 20 61 6e 64 20 36 35 35  ween 512 and 655
13980 33 36 29 20 70 6c 75 73 20 73 6f 6d 65 20 65 78  36) plus some ex
13990 74 72 61 20 62 79 74 65 73 20 66 6f 72 20 65 61  tra bytes for ea
139a0 63 68 0a 2a 2a 20 70 61 67 65 20 68 65 61 64 65  ch.** page heade
139b0 72 2e 20 20 5e 54 68 65 20 6e 75 6d 62 65 72 20  r.  ^The number 
139c0 6f 66 20 65 78 74 72 61 20 62 79 74 65 73 20 6e  of extra bytes n
139d0 65 65 64 65 64 20 62 79 20 74 68 65 20 70 61 67  eeded by the pag
139e0 65 20 68 65 61 64 65 72 0a 2a 2a 20 63 61 6e 20  e header.** can 
139f0 62 65 20 64 65 74 65 72 6d 69 6e 65 64 20 75 73  be determined us
13a00 69 6e 67 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46  ing [SQLITE_CONF
13a10 49 47 5f 50 43 41 43 48 45 5f 48 44 52 53 5a 5d  IG_PCACHE_HDRSZ]
13a20 2e 0a 2a 2a 20 5e 49 74 20 69 73 20 68 61 72 6d  ..** ^It is harm
13a30 6c 65 73 73 2c 20 61 70 61 72 74 20 66 72 6f 6d  less, apart from
13a40 20 74 68 65 20 77 61 73 74 65 64 20 6d 65 6d 6f   the wasted memo
13a50 72 79 2c 0a 2a 2a 20 66 6f 72 20 74 68 65 20 73  ry,.** for the s
13a60 7a 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 62  z parameter to b
13a70 65 20 6c 61 72 67 65 72 20 74 68 61 6e 20 6e 65  e larger than ne
13a80 63 65 73 73 61 72 79 2e 20 20 54 68 65 20 70 4d  cessary.  The pM
13a90 65 6d 0a 2a 2a 20 61 72 67 75 6d 65 6e 74 20 6d  em.** argument m
13aa0 75 73 74 20 62 65 20 65 69 74 68 65 72 20 61 20  ust be either a 
13ab0 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 6f 72 20  NULL pointer or 
13ac0 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20  a pointer to an 
13ad0 38 2d 62 79 74 65 0a 2a 2a 20 61 6c 69 67 6e 65  8-byte.** aligne
13ae0 64 20 62 6c 6f 63 6b 20 6f 66 20 6d 65 6d 6f 72  d block of memor
13af0 79 20 6f 66 20 61 74 20 6c 65 61 73 74 20 73 7a  y of at least sz
13b00 2a 4e 20 62 79 74 65 73 2c 20 6f 74 68 65 72 77  *N bytes, otherw
13b10 69 73 65 0a 2a 2a 20 73 75 62 73 65 71 75 65 6e  ise.** subsequen
13b20 74 20 62 65 68 61 76 69 6f 72 20 69 73 20 75 6e  t behavior is un
13b30 64 65 66 69 6e 65 64 2e 0a 2a 2a 20 5e 57 68 65  defined..** ^Whe
13b40 6e 20 70 4d 65 6d 20 69 73 20 6e 6f 74 20 4e 55  n pMem is not NU
13b50 4c 4c 2c 20 53 51 4c 69 74 65 20 77 69 6c 6c 20  LL, SQLite will 
13b60 73 74 72 69 76 65 20 74 6f 20 75 73 65 20 74 68  strive to use th
13b70 65 20 6d 65 6d 6f 72 79 20 70 72 6f 76 69 64 65  e memory provide
13b80 64 0a 2a 2a 20 74 6f 20 73 61 74 69 73 66 79 20  d.** to satisfy 
13b90 70 61 67 65 20 63 61 63 68 65 20 6e 65 65 64 73  page cache needs
13ba0 2c 20 66 61 6c 6c 69 6e 67 20 62 61 63 6b 20 74  , falling back t
13bb0 6f 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f  o [sqlite3_mallo
13bc0 63 28 29 5d 20 69 66 0a 2a 2a 20 61 20 70 61 67  c()] if.** a pag
13bd0 65 20 63 61 63 68 65 20 6c 69 6e 65 20 69 73 20  e cache line is 
13be0 6c 61 72 67 65 72 20 74 68 61 6e 20 73 7a 20 62  larger than sz b
13bf0 79 74 65 73 20 6f 72 20 69 66 20 61 6c 6c 20 6f  ytes or if all o
13c00 66 20 74 68 65 20 70 4d 65 6d 20 62 75 66 66 65  f the pMem buffe
13c10 72 0a 2a 2a 20 69 73 20 65 78 68 61 75 73 74 65  r.** is exhauste
13c20 64 2e 0a 2a 2a 20 5e 49 66 20 70 4d 65 6d 20 69  d..** ^If pMem i
13c30 73 20 4e 55 4c 4c 20 61 6e 64 20 4e 20 69 73 20  s NULL and N is 
13c40 6e 6f 6e 2d 7a 65 72 6f 2c 20 74 68 65 6e 20 65  non-zero, then e
13c50 61 63 68 20 64 61 74 61 62 61 73 65 20 63 6f 6e  ach database con
13c60 6e 65 63 74 69 6f 6e 0a 2a 2a 20 64 6f 65 73 20  nection.** does 
13c70 61 6e 20 69 6e 69 74 69 61 6c 20 62 75 6c 6b 20  an initial bulk 
13c80 61 6c 6c 6f 63 61 74 69 6f 6e 20 66 6f 72 20 70  allocation for p
13c90 61 67 65 20 63 61 63 68 65 20 6d 65 6d 6f 72 79  age cache memory
13ca0 0a 2a 2a 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65  .** from [sqlite
13cb0 33 5f 6d 61 6c 6c 6f 63 28 29 5d 20 73 75 66 66  3_malloc()] suff
13cc0 69 63 69 65 6e 74 20 66 6f 72 20 4e 20 63 61 63  icient for N cac
13cd0 68 65 20 6c 69 6e 65 73 20 69 66 20 4e 20 69 73  he lines if N is
13ce0 20 70 6f 73 69 74 69 76 65 20 6f 72 0a 2a 2a 20   positive or.** 
13cf0 6f 66 20 2d 31 30 32 34 2a 4e 20 62 79 74 65 73  of -1024*N bytes
13d00 20 69 66 20 4e 20 69 73 20 6e 65 67 61 74 69 76   if N is negativ
13d10 65 2c 20 2e 20 5e 49 66 20 61 64 64 69 74 69 6f  e, . ^If additio
13d20 6e 61 6c 0a 2a 2a 20 70 61 67 65 20 63 61 63 68  nal.** page cach
13d30 65 20 6d 65 6d 6f 72 79 20 69 73 20 6e 65 65 64  e memory is need
13d40 65 64 20 62 65 79 6f 6e 64 20 77 68 61 74 20 69  ed beyond what i
13d50 73 20 70 72 6f 76 69 64 65 64 20 62 79 20 74 68  s provided by th
13d60 65 20 69 6e 69 74 69 61 6c 0a 2a 2a 20 61 6c 6c  e initial.** all
13d70 6f 63 61 74 69 6f 6e 2c 20 74 68 65 6e 20 53 51  ocation, then SQ
13d80 4c 69 74 65 20 67 6f 65 73 20 74 6f 20 5b 73 71  Lite goes to [sq
13d90 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 20  lite3_malloc()] 
13da0 73 65 70 61 72 61 74 65 6c 79 20 66 6f 72 20 65  separately for e
13db0 61 63 68 0a 2a 2a 20 61 64 64 69 74 69 6f 6e 61  ach.** additiona
13dc0 6c 20 63 61 63 68 65 20 6c 69 6e 65 2e 20 3c 2f  l cache line. </
13dd0 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49  dd>.**.** [[SQLI
13de0 54 45 5f 43 4f 4e 46 49 47 5f 48 45 41 50 5d 5d  TE_CONFIG_HEAP]]
13df0 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46   <dt>SQLITE_CONF
13e00 49 47 5f 48 45 41 50 3c 2f 64 74 3e 0a 2a 2a 20  IG_HEAP</dt>.** 
13e10 3c 64 64 3e 20 5e 54 68 65 20 53 51 4c 49 54 45  <dd> ^The SQLITE
13e20 5f 43 4f 4e 46 49 47 5f 48 45 41 50 20 6f 70 74  _CONFIG_HEAP opt
13e30 69 6f 6e 20 73 70 65 63 69 66 69 65 73 20 61 20  ion specifies a 
13e40 73 74 61 74 69 63 20 6d 65 6d 6f 72 79 20 62 75  static memory bu
13e50 66 66 65 72 20 0a 2a 2a 20 74 68 61 74 20 53 51  ffer .** that SQ
13e60 4c 69 74 65 20 77 69 6c 6c 20 75 73 65 20 66 6f  Lite will use fo
13e70 72 20 61 6c 6c 20 6f 66 20 69 74 73 20 64 79 6e  r all of its dyn
13e80 61 6d 69 63 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f  amic memory allo
13e90 63 61 74 69 6f 6e 20 6e 65 65 64 73 0a 2a 2a 20  cation needs.** 
13ea0 62 65 79 6f 6e 64 20 74 68 6f 73 65 20 70 72 6f  beyond those pro
13eb0 76 69 64 65 64 20 66 6f 72 20 62 79 20 5b 53 51  vided for by [SQ
13ec0 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 43 52 41  LITE_CONFIG_SCRA
13ed0 54 43 48 5d 20 61 6e 64 0a 2a 2a 20 5b 53 51 4c  TCH] and.** [SQL
13ee0 49 54 45 5f 43 4f 4e 46 49 47 5f 50 41 47 45 43  ITE_CONFIG_PAGEC
13ef0 41 43 48 45 5d 2e 0a 2a 2a 20 5e 54 68 65 20 53  ACHE]..** ^The S
13f00 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 48 45 41  QLITE_CONFIG_HEA
13f10 50 20 6f 70 74 69 6f 6e 20 69 73 20 6f 6e 6c 79  P option is only
13f20 20 61 76 61 69 6c 61 62 6c 65 20 69 66 20 53 51   available if SQ
13f30 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c 65 64  Lite is compiled
13f40 0a 2a 2a 20 77 69 74 68 20 65 69 74 68 65 72 20  .** with either 
13f50 5b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4d  [SQLITE_ENABLE_M
13f60 45 4d 53 59 53 33 5d 20 6f 72 20 5b 53 51 4c 49  EMSYS3] or [SQLI
13f70 54 45 5f 45 4e 41 42 4c 45 5f 4d 45 4d 53 59 53  TE_ENABLE_MEMSYS
13f80 35 5d 20 61 6e 64 20 72 65 74 75 72 6e 73 0a 2a  5] and returns.*
13f90 2a 20 5b 53 51 4c 49 54 45 5f 45 52 52 4f 52 5d  * [SQLITE_ERROR]
13fa0 20 69 66 20 69 6e 76 6f 6b 65 64 20 6f 74 68 65   if invoked othe
13fb0 72 77 69 73 65 2e 0a 2a 2a 20 5e 54 68 65 72 65  rwise..** ^There
13fc0 20 61 72 65 20 74 68 72 65 65 20 61 72 67 75 6d   are three argum
13fd0 65 6e 74 73 20 74 6f 20 53 51 4c 49 54 45 5f 43  ents to SQLITE_C
13fe0 4f 4e 46 49 47 5f 48 45 41 50 3a 0a 2a 2a 20 41  ONFIG_HEAP:.** A
13ff0 6e 20 38 2d 62 79 74 65 20 61 6c 69 67 6e 65 64  n 8-byte aligned
14000 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68 65 20   pointer to the 
14010 6d 65 6d 6f 72 79 2c 0a 2a 2a 20 74 68 65 20 6e  memory,.** the n
14020 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73 20 69  umber of bytes i
14030 6e 20 74 68 65 20 6d 65 6d 6f 72 79 20 62 75 66  n the memory buf
14040 66 65 72 2c 20 61 6e 64 20 74 68 65 20 6d 69 6e  fer, and the min
14050 69 6d 75 6d 20 61 6c 6c 6f 63 61 74 69 6f 6e 20  imum allocation 
14060 73 69 7a 65 2e 0a 2a 2a 20 5e 49 66 20 74 68 65  size..** ^If the
14070 20 66 69 72 73 74 20 70 6f 69 6e 74 65 72 20 28   first pointer (
14080 74 68 65 20 6d 65 6d 6f 72 79 20 70 6f 69 6e 74  the memory point
14090 65 72 29 20 69 73 20 4e 55 4c 4c 2c 20 74 68 65  er) is NULL, the
140a0 6e 20 53 51 4c 69 74 65 20 72 65 76 65 72 74 73  n SQLite reverts
140b0 0a 2a 2a 20 74 6f 20 75 73 69 6e 67 20 69 74 73  .** to using its
140c0 20 64 65 66 61 75 6c 74 20 6d 65 6d 6f 72 79 20   default memory 
140d0 61 6c 6c 6f 63 61 74 6f 72 20 28 74 68 65 20 73  allocator (the s
140e0 79 73 74 65 6d 20 6d 61 6c 6c 6f 63 28 29 20 69  ystem malloc() i
140f0 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 29 2c 0a  mplementation),.
14100 2a 2a 20 75 6e 64 6f 69 6e 67 20 61 6e 79 20 70  ** undoing any p
14110 72 69 6f 72 20 69 6e 76 6f 63 61 74 69 6f 6e 20  rior invocation 
14120 6f 66 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49  of [SQLITE_CONFI
14130 47 5f 4d 41 4c 4c 4f 43 5d 2e 20 20 5e 49 66 20  G_MALLOC].  ^If 
14140 74 68 65 0a 2a 2a 20 6d 65 6d 6f 72 79 20 70 6f  the.** memory po
14150 69 6e 74 65 72 20 69 73 20 6e 6f 74 20 4e 55 4c  inter is not NUL
14160 4c 20 74 68 65 6e 20 74 68 65 20 61 6c 74 65 72  L then the alter
14170 6e 61 74 69 76 65 20 6d 65 6d 6f 72 79 0a 2a 2a  native memory.**
14180 20 61 6c 6c 6f 63 61 74 6f 72 20 69 73 20 65 6e   allocator is en
14190 67 61 67 65 64 20 74 6f 20 68 61 6e 64 6c 65 20  gaged to handle 
141a0 61 6c 6c 20 6f 66 20 53 51 4c 69 74 65 73 20 6d  all of SQLites m
141b0 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e  emory allocation
141c0 20 6e 65 65 64 73 2e 0a 2a 2a 20 54 68 65 20 66   needs..** The f
141d0 69 72 73 74 20 70 6f 69 6e 74 65 72 20 28 74 68  irst pointer (th
141e0 65 20 6d 65 6d 6f 72 79 20 70 6f 69 6e 74 65 72  e memory pointer
141f0 29 20 6d 75 73 74 20 62 65 20 61 6c 69 67 6e 65  ) must be aligne
14200 64 20 74 6f 20 61 6e 20 38 2d 62 79 74 65 0a 2a  d to an 8-byte.*
14210 2a 20 62 6f 75 6e 64 61 72 79 20 6f 72 20 73 75  * boundary or su
14220 62 73 65 71 75 65 6e 74 20 62 65 68 61 76 69 6f  bsequent behavio
14230 72 20 6f 66 20 53 51 4c 69 74 65 20 77 69 6c 6c  r of SQLite will
14240 20 62 65 20 75 6e 64 65 66 69 6e 65 64 2e 0a 2a   be undefined..*
14250 2a 20 54 68 65 20 6d 69 6e 69 6d 75 6d 20 61 6c  * The minimum al
14260 6c 6f 63 61 74 69 6f 6e 20 73 69 7a 65 20 69 73  location size is
14270 20 63 61 70 70 65 64 20 61 74 20 32 2a 2a 31 32   capped at 2**12
14280 2e 20 52 65 61 73 6f 6e 61 62 6c 65 20 76 61 6c  . Reasonable val
14290 75 65 73 0a 2a 2a 20 66 6f 72 20 74 68 65 20 6d  ues.** for the m
142a0 69 6e 69 6d 75 6d 20 61 6c 6c 6f 63 61 74 69 6f  inimum allocatio
142b0 6e 20 73 69 7a 65 20 61 72 65 20 32 2a 2a 35 20  n size are 2**5 
142c0 74 68 72 6f 75 67 68 20 32 2a 2a 38 2e 3c 2f 64  through 2**8.</d
142d0 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  d>.**.** [[SQLIT
142e0 45 5f 43 4f 4e 46 49 47 5f 4d 55 54 45 58 5d 5d  E_CONFIG_MUTEX]]
142f0 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46   <dt>SQLITE_CONF
14300 49 47 5f 4d 55 54 45 58 3c 2f 64 74 3e 0a 2a 2a  IG_MUTEX</dt>.**
14310 20 3c 64 64 3e 20 5e 28 54 68 65 20 53 51 4c 49   <dd> ^(The SQLI
14320 54 45 5f 43 4f 4e 46 49 47 5f 4d 55 54 45 58 20  TE_CONFIG_MUTEX 
14330 6f 70 74 69 6f 6e 20 74 61 6b 65 73 20 61 20 73  option takes a s
14340 69 6e 67 6c 65 20 61 72 67 75 6d 65 6e 74 20 77  ingle argument w
14350 68 69 63 68 20 69 73 20 61 0a 2a 2a 20 70 6f 69  hich is a.** poi
14360 6e 74 65 72 20 74 6f 20 61 6e 20 69 6e 73 74 61  nter to an insta
14370 6e 63 65 20 6f 66 20 74 68 65 20 5b 73 71 6c 69  nce of the [sqli
14380 74 65 33 5f 6d 75 74 65 78 5f 6d 65 74 68 6f 64  te3_mutex_method
14390 73 5d 20 73 74 72 75 63 74 75 72 65 2e 0a 2a 2a  s] structure..**
143a0 20 54 68 65 20 61 72 67 75 6d 65 6e 74 20 73 70   The argument sp
143b0 65 63 69 66 69 65 73 20 61 6c 74 65 72 6e 61 74  ecifies alternat
143c0 69 76 65 20 6c 6f 77 2d 6c 65 76 65 6c 20 6d 75  ive low-level mu
143d0 74 65 78 20 72 6f 75 74 69 6e 65 73 20 74 6f 20  tex routines to 
143e0 62 65 20 75 73 65 64 0a 2a 2a 20 69 6e 20 70 6c  be used.** in pl
143f0 61 63 65 20 74 68 65 20 6d 75 74 65 78 20 72 6f  ace the mutex ro
14400 75 74 69 6e 65 73 20 62 75 69 6c 74 20 69 6e 74  utines built int
14410 6f 20 53 51 4c 69 74 65 2e 29 5e 20 20 5e 53 51  o SQLite.)^  ^SQ
14420 4c 69 74 65 20 6d 61 6b 65 73 20 61 20 63 6f 70  Lite makes a cop
14430 79 20 6f 66 0a 2a 2a 20 74 68 65 20 63 6f 6e 74  y of.** the cont
14440 65 6e 74 20 6f 66 20 74 68 65 20 5b 73 71 6c 69  ent of the [sqli
14450 74 65 33 5f 6d 75 74 65 78 5f 6d 65 74 68 6f 64  te3_mutex_method
14460 73 5d 20 73 74 72 75 63 74 75 72 65 20 62 65 66  s] structure bef
14470 6f 72 65 20 74 68 65 20 63 61 6c 6c 20 74 6f 0a  ore the call to.
14480 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66  ** [sqlite3_conf
14490 69 67 28 29 5d 20 72 65 74 75 72 6e 73 2e 20 5e  ig()] returns. ^
144a0 49 66 20 53 51 4c 69 74 65 20 69 73 20 63 6f 6d  If SQLite is com
144b0 70 69 6c 65 64 20 77 69 74 68 0a 2a 2a 20 74 68  piled with.** th
144c0 65 20 5b 53 51 4c 49 54 45 5f 54 48 52 45 41 44  e [SQLITE_THREAD
144d0 53 41 46 45 20 7c 20 53 51 4c 49 54 45 5f 54 48  SAFE | SQLITE_TH
144e0 52 45 41 44 53 41 46 45 3d 30 5d 20 63 6f 6d 70  READSAFE=0] comp
144f0 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20  ile-time option 
14500 74 68 65 6e 0a 2a 2a 20 74 68 65 20 65 6e 74 69  then.** the enti
14510 72 65 20 6d 75 74 65 78 69 6e 67 20 73 75 62 73  re mutexing subs
14520 79 73 74 65 6d 20 69 73 20 6f 6d 69 74 74 65 64  ystem is omitted
14530 20 66 72 6f 6d 20 74 68 65 20 62 75 69 6c 64 20   from the build 
14540 61 6e 64 20 68 65 6e 63 65 20 63 61 6c 6c 73 20  and hence calls 
14550 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63  to.** [sqlite3_c
14560 6f 6e 66 69 67 28 29 5d 20 77 69 74 68 20 74 68  onfig()] with th
14570 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  e SQLITE_CONFIG_
14580 4d 55 54 45 58 20 63 6f 6e 66 69 67 75 72 61 74  MUTEX configurat
14590 69 6f 6e 20 6f 70 74 69 6f 6e 20 77 69 6c 6c 0a  ion option will.
145a0 2a 2a 20 72 65 74 75 72 6e 20 5b 53 51 4c 49 54  ** return [SQLIT
145b0 45 5f 45 52 52 4f 52 5d 2e 3c 2f 64 64 3e 0a 2a  E_ERROR].</dd>.*
145c0 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 43 4f  *.** [[SQLITE_CO
145d0 4e 46 49 47 5f 47 45 54 4d 55 54 45 58 5d 5d 20  NFIG_GETMUTEX]] 
145e0 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49  <dt>SQLITE_CONFI
145f0 47 5f 47 45 54 4d 55 54 45 58 3c 2f 64 74 3e 0a  G_GETMUTEX</dt>.
14600 2a 2a 20 3c 64 64 3e 20 5e 28 54 68 65 20 53 51  ** <dd> ^(The SQ
14610 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 4d  LITE_CONFIG_GETM
14620 55 54 45 58 20 6f 70 74 69 6f 6e 20 74 61 6b 65  UTEX option take
14630 73 20 61 20 73 69 6e 67 6c 65 20 61 72 67 75 6d  s a single argum
14640 65 6e 74 20 77 68 69 63 68 0a 2a 2a 20 69 73 20  ent which.** is 
14650 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20  a pointer to an 
14660 69 6e 73 74 61 6e 63 65 20 6f 66 20 74 68 65 20  instance of the 
14670 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65 78 5f 6d  [sqlite3_mutex_m
14680 65 74 68 6f 64 73 5d 20 73 74 72 75 63 74 75 72  ethods] structur
14690 65 2e 20 20 54 68 65 0a 2a 2a 20 5b 73 71 6c 69  e.  The.** [sqli
146a0 74 65 33 5f 6d 75 74 65 78 5f 6d 65 74 68 6f 64  te3_mutex_method
146b0 73 5d 0a 2a 2a 20 73 74 72 75 63 74 75 72 65 20  s].** structure 
146c0 69 73 20 66 69 6c 6c 65 64 20 77 69 74 68 20 74  is filled with t
146d0 68 65 20 63 75 72 72 65 6e 74 6c 79 20 64 65 66  he currently def
146e0 69 6e 65 64 20 6d 75 74 65 78 20 72 6f 75 74 69  ined mutex routi
146f0 6e 65 73 2e 29 5e 0a 2a 2a 20 54 68 69 73 20 6f  nes.)^.** This o
14700 70 74 69 6f 6e 20 63 61 6e 20 62 65 20 75 73 65  ption can be use
14710 64 20 74 6f 20 6f 76 65 72 6c 6f 61 64 20 74 68  d to overload th
14720 65 20 64 65 66 61 75 6c 74 20 6d 75 74 65 78 20  e default mutex 
14730 61 6c 6c 6f 63 61 74 69 6f 6e 0a 2a 2a 20 72 6f  allocation.** ro
14740 75 74 69 6e 65 73 20 77 69 74 68 20 61 20 77 72  utines with a wr
14750 61 70 70 65 72 20 75 73 65 64 20 74 6f 20 74 72  apper used to tr
14760 61 63 6b 20 6d 75 74 65 78 20 75 73 61 67 65 20  ack mutex usage 
14770 66 6f 72 20 70 65 72 66 6f 72 6d 61 6e 63 65 0a  for performance.
14780 2a 2a 20 70 72 6f 66 69 6c 69 6e 67 20 6f 72 20  ** profiling or 
14790 74 65 73 74 69 6e 67 2c 20 66 6f 72 20 65 78 61  testing, for exa
147a0 6d 70 6c 65 2e 20 20 20 5e 49 66 20 53 51 4c 69  mple.   ^If SQLi
147b0 74 65 20 69 73 20 63 6f 6d 70 69 6c 65 64 20 77  te is compiled w
147c0 69 74 68 0a 2a 2a 20 74 68 65 20 5b 53 51 4c 49  ith.** the [SQLI
147d0 54 45 5f 54 48 52 45 41 44 53 41 46 45 20 7c 20  TE_THREADSAFE | 
147e0 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46  SQLITE_THREADSAF
147f0 45 3d 30 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d  E=0] compile-tim
14800 65 20 6f 70 74 69 6f 6e 20 74 68 65 6e 0a 2a 2a  e option then.**
14810 20 74 68 65 20 65 6e 74 69 72 65 20 6d 75 74 65   the entire mute
14820 78 69 6e 67 20 73 75 62 73 79 73 74 65 6d 20 69  xing subsystem i
14830 73 20 6f 6d 69 74 74 65 64 20 66 72 6f 6d 20 74  s omitted from t
14840 68 65 20 62 75 69 6c 64 20 61 6e 64 20 68 65 6e  he build and hen
14850 63 65 20 63 61 6c 6c 73 20 74 6f 0a 2a 2a 20 5b  ce calls to.** [
14860 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29  sqlite3_config()
14870 5d 20 77 69 74 68 20 74 68 65 20 53 51 4c 49 54  ] with the SQLIT
14880 45 5f 43 4f 4e 46 49 47 5f 47 45 54 4d 55 54 45  E_CONFIG_GETMUTE
14890 58 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20  X configuration 
148a0 6f 70 74 69 6f 6e 20 77 69 6c 6c 0a 2a 2a 20 72  option will.** r
148b0 65 74 75 72 6e 20 5b 53 51 4c 49 54 45 5f 45 52  eturn [SQLITE_ER
148c0 52 4f 52 5d 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a  ROR].</dd>.**.**
148d0 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
148e0 5f 4c 4f 4f 4b 41 53 49 44 45 5d 5d 20 3c 64 74  _LOOKASIDE]] <dt
148f0 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4c  >SQLITE_CONFIG_L
14900 4f 4f 4b 41 53 49 44 45 3c 2f 64 74 3e 0a 2a 2a  OOKASIDE</dt>.**
14910 20 3c 64 64 3e 20 5e 28 54 68 65 20 53 51 4c 49   <dd> ^(The SQLI
14920 54 45 5f 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53  TE_CONFIG_LOOKAS
14930 49 44 45 20 6f 70 74 69 6f 6e 20 74 61 6b 65 73  IDE option takes
14940 20 74 77 6f 20 61 72 67 75 6d 65 6e 74 73 20 74   two arguments t
14950 68 61 74 20 64 65 74 65 72 6d 69 6e 65 0a 2a 2a  hat determine.**
14960 20 74 68 65 20 64 65 66 61 75 6c 74 20 73 69 7a   the default siz
14970 65 20 6f 66 20 6c 6f 6f 6b 61 73 69 64 65 20 6d  e of lookaside m
14980 65 6d 6f 72 79 20 6f 6e 20 65 61 63 68 20 5b 64  emory on each [d
14990 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
149a0 6f 6e 5d 2e 0a 2a 2a 20 54 68 65 20 66 69 72 73  on]..** The firs
149b0 74 20 61 72 67 75 6d 65 6e 74 20 69 73 20 74 68  t argument is th
149c0 65 0a 2a 2a 20 73 69 7a 65 20 6f 66 20 65 61 63  e.** size of eac
149d0 68 20 6c 6f 6f 6b 61 73 69 64 65 20 62 75 66 66  h lookaside buff
149e0 65 72 20 73 6c 6f 74 20 61 6e 64 20 74 68 65 20  er slot and the 
149f0 73 65 63 6f 6e 64 20 69 73 20 74 68 65 20 6e 75  second is the nu
14a00 6d 62 65 72 20 6f 66 0a 2a 2a 20 73 6c 6f 74 73  mber of.** slots
14a10 20 61 6c 6c 6f 63 61 74 65 64 20 74 6f 20 65 61   allocated to ea
14a20 63 68 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  ch database conn
14a30 65 63 74 69 6f 6e 2e 29 5e 20 20 5e 28 53 51 4c  ection.)^  ^(SQL
14a40 49 54 45 5f 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41  ITE_CONFIG_LOOKA
14a50 53 49 44 45 0a 2a 2a 20 73 65 74 73 20 74 68 65  SIDE.** sets the
14a60 20 3c 69 3e 64 65 66 61 75 6c 74 3c 2f 69 3e 20   <i>default</i> 
14a70 6c 6f 6f 6b 61 73 69 64 65 20 73 69 7a 65 2e 20  lookaside size. 
14a80 54 68 65 20 5b 53 51 4c 49 54 45 5f 44 42 43 4f  The [SQLITE_DBCO
14a90 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49 44 45 5d 0a  NFIG_LOOKASIDE].
14aa0 2a 2a 20 6f 70 74 69 6f 6e 20 74 6f 20 5b 73 71  ** option to [sq
14ab0 6c 69 74 65 33 5f 64 62 5f 63 6f 6e 66 69 67 28  lite3_db_config(
14ac0 29 5d 20 63 61 6e 20 62 65 20 75 73 65 64 20 74  )] can be used t
14ad0 6f 20 63 68 61 6e 67 65 20 74 68 65 20 6c 6f 6f  o change the loo
14ae0 6b 61 73 69 64 65 0a 2a 2a 20 63 6f 6e 66 69 67  kaside.** config
14af0 75 72 61 74 69 6f 6e 20 6f 6e 20 69 6e 64 69 76  uration on indiv
14b00 69 64 75 61 6c 20 63 6f 6e 6e 65 63 74 69 6f 6e  idual connection
14b10 73 2e 29 5e 20 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a  s.)^ </dd>.**.**
14b20 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
14b30 5f 50 43 41 43 48 45 32 5d 5d 20 3c 64 74 3e 53  _PCACHE2]] <dt>S
14b40 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 43 41  QLITE_CONFIG_PCA
14b50 43 48 45 32 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64  CHE2</dt>.** <dd
14b60 3e 20 5e 28 54 68 65 20 53 51 4c 49 54 45 5f 43  > ^(The SQLITE_C
14b70 4f 4e 46 49 47 5f 50 43 41 43 48 45 32 20 6f 70  ONFIG_PCACHE2 op
14b80 74 69 6f 6e 20 74 61 6b 65 73 20 61 20 73 69 6e  tion takes a sin
14b90 67 6c 65 20 61 72 67 75 6d 65 6e 74 20 77 68 69  gle argument whi
14ba0 63 68 20 69 73 20 0a 2a 2a 20 61 20 70 6f 69 6e  ch is .** a poin
14bb0 74 65 72 20 74 6f 20 61 6e 20 5b 73 71 6c 69 74  ter to an [sqlit
14bc0 65 33 5f 70 63 61 63 68 65 5f 6d 65 74 68 6f 64  e3_pcache_method
14bd0 73 32 5d 20 6f 62 6a 65 63 74 2e 20 20 54 68 69  s2] object.  Thi
14be0 73 20 6f 62 6a 65 63 74 20 73 70 65 63 69 66 69  s object specifi
14bf0 65 73 0a 2a 2a 20 74 68 65 20 69 6e 74 65 72 66  es.** the interf
14c00 61 63 65 20 74 6f 20 61 20 63 75 73 74 6f 6d 20  ace to a custom 
14c10 70 61 67 65 20 63 61 63 68 65 20 69 6d 70 6c 65  page cache imple
14c20 6d 65 6e 74 61 74 69 6f 6e 2e 29 5e 0a 2a 2a 20  mentation.)^.** 
14c30 5e 53 51 4c 69 74 65 20 6d 61 6b 65 73 20 61 20  ^SQLite makes a 
14c40 63 6f 70 79 20 6f 66 20 74 68 65 20 5b 73 71 6c  copy of the [sql
14c50 69 74 65 33 5f 70 63 61 63 68 65 5f 6d 65 74 68  ite3_pcache_meth
14c60 6f 64 73 32 5d 20 6f 62 6a 65 63 74 2e 3c 2f 64  ods2] object.</d
14c70 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  d>.**.** [[SQLIT
14c80 45 5f 43 4f 4e 46 49 47 5f 47 45 54 50 43 41 43  E_CONFIG_GETPCAC
14c90 48 45 32 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45  HE2]] <dt>SQLITE
14ca0 5f 43 4f 4e 46 49 47 5f 47 45 54 50 43 41 43 48  _CONFIG_GETPCACH
14cb0 45 32 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20  E2</dt>.** <dd> 
14cc0 5e 28 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e  ^(The SQLITE_CON
14cd0 46 49 47 5f 47 45 54 50 43 41 43 48 45 32 20 6f  FIG_GETPCACHE2 o
14ce0 70 74 69 6f 6e 20 74 61 6b 65 73 20 61 20 73 69  ption takes a si
14cf0 6e 67 6c 65 20 61 72 67 75 6d 65 6e 74 20 77 68  ngle argument wh
14d00 69 63 68 0a 2a 2a 20 69 73 20 61 20 70 6f 69 6e  ich.** is a poin
14d10 74 65 72 20 74 6f 20 61 6e 20 5b 73 71 6c 69 74  ter to an [sqlit
14d20 65 33 5f 70 63 61 63 68 65 5f 6d 65 74 68 6f 64  e3_pcache_method
14d30 73 32 5d 20 6f 62 6a 65 63 74 2e 20 20 53 51 4c  s2] object.  SQL
14d40 69 74 65 20 63 6f 70 69 65 73 20 6f 66 0a 2a 2a  ite copies of.**
14d50 20 74 68 65 20 63 75 72 72 65 6e 74 20 70 61 67   the current pag
14d60 65 20 63 61 63 68 65 20 69 6d 70 6c 65 6d 65 6e  e cache implemen
14d70 74 61 74 69 6f 6e 20 69 6e 74 6f 20 74 68 61 74  tation into that
14d80 20 6f 62 6a 65 63 74 2e 29 5e 20 3c 2f 64 64 3e   object.)^ </dd>
14d90 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f  .**.** [[SQLITE_
14da0 43 4f 4e 46 49 47 5f 4c 4f 47 5d 5d 20 3c 64 74  CONFIG_LOG]] <dt
14db0 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4c  >SQLITE_CONFIG_L
14dc0 4f 47 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20  OG</dt>.** <dd> 
14dd0 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  The SQLITE_CONFI
14de0 47 5f 4c 4f 47 20 6f 70 74 69 6f 6e 20 69 73 20  G_LOG option is 
14df0 75 73 65 64 20 74 6f 20 63 6f 6e 66 69 67 75 72  used to configur
14e00 65 20 74 68 65 20 53 51 4c 69 74 65 0a 2a 2a 20  e the SQLite.** 
14e10 67 6c 6f 62 61 6c 20 5b 65 72 72 6f 72 20 6c 6f  global [error lo
14e20 67 5d 2e 0a 2a 2a 20 28 5e 54 68 65 20 53 51 4c  g]..** (^The SQL
14e30 49 54 45 5f 43 4f 4e 46 49 47 5f 4c 4f 47 20 6f  ITE_CONFIG_LOG o
14e40 70 74 69 6f 6e 20 74 61 6b 65 73 20 74 77 6f 20  ption takes two 
14e50 61 72 67 75 6d 65 6e 74 73 3a 20 61 20 70 6f 69  arguments: a poi
14e60 6e 74 65 72 20 74 6f 20 61 0a 2a 2a 20 66 75 6e  nter to a.** fun
14e70 63 74 69 6f 6e 20 77 69 74 68 20 61 20 63 61 6c  ction with a cal
14e80 6c 20 73 69 67 6e 61 74 75 72 65 20 6f 66 20 76  l signature of v
14e90 6f 69 64 28 2a 29 28 76 6f 69 64 2a 2c 69 6e 74  oid(*)(void*,int
14ea0 2c 63 6f 6e 73 74 20 63 68 61 72 2a 29 2c 20 0a  ,const char*), .
14eb0 2a 2a 20 61 6e 64 20 61 20 70 6f 69 6e 74 65 72  ** and a pointer
14ec0 20 74 6f 20 76 6f 69 64 2e 20 5e 49 66 20 74 68   to void. ^If th
14ed0 65 20 66 75 6e 63 74 69 6f 6e 20 70 6f 69 6e 74  e function point
14ee0 65 72 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 2c 20  er is not NULL, 
14ef0 69 74 20 69 73 0a 2a 2a 20 69 6e 76 6f 6b 65 64  it is.** invoked
14f00 20 62 79 20 5b 73 71 6c 69 74 65 33 5f 6c 6f 67   by [sqlite3_log
14f10 28 29 5d 20 74 6f 20 70 72 6f 63 65 73 73 20 65  ()] to process e
14f20 61 63 68 20 6c 6f 67 67 69 6e 67 20 65 76 65 6e  ach logging even
14f30 74 2e 20 20 5e 49 66 20 74 68 65 0a 2a 2a 20 66  t.  ^If the.** f
14f40 75 6e 63 74 69 6f 6e 20 70 6f 69 6e 74 65 72 20  unction pointer 
14f50 69 73 20 4e 55 4c 4c 2c 20 74 68 65 20 5b 73 71  is NULL, the [sq
14f60 6c 69 74 65 33 5f 6c 6f 67 28 29 5d 20 69 6e 74  lite3_log()] int
14f70 65 72 66 61 63 65 20 62 65 63 6f 6d 65 73 20 61  erface becomes a
14f80 20 6e 6f 2d 6f 70 2e 0a 2a 2a 20 5e 54 68 65 20   no-op..** ^The 
14f90 76 6f 69 64 20 70 6f 69 6e 74 65 72 20 74 68 61  void pointer tha
14fa0 74 20 69 73 20 74 68 65 20 73 65 63 6f 6e 64 20  t is the second 
14fb0 61 72 67 75 6d 65 6e 74 20 74 6f 20 53 51 4c 49  argument to SQLI
14fc0 54 45 5f 43 4f 4e 46 49 47 5f 4c 4f 47 20 69 73  TE_CONFIG_LOG is
14fd0 0a 2a 2a 20 70 61 73 73 65 64 20 74 68 72 6f 75  .** passed throu
14fe0 67 68 20 61 73 20 74 68 65 20 66 69 72 73 74 20  gh as the first 
14ff0 70 61 72 61 6d 65 74 65 72 20 74 6f 20 74 68 65  parameter to the
15000 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66   application-def
15010 69 6e 65 64 20 6c 6f 67 67 65 72 0a 2a 2a 20 66  ined logger.** f
15020 75 6e 63 74 69 6f 6e 20 77 68 65 6e 65 76 65 72  unction whenever
15030 20 74 68 61 74 20 66 75 6e 63 74 69 6f 6e 20 69   that function i
15040 73 20 69 6e 76 6f 6b 65 64 2e 20 20 5e 54 68 65  s invoked.  ^The
15050 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65   second paramete
15060 72 20 74 6f 0a 2a 2a 20 74 68 65 20 6c 6f 67 67  r to.** the logg
15070 65 72 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 61  er function is a
15080 20 63 6f 70 79 20 6f 66 20 74 68 65 20 66 69 72   copy of the fir
15090 73 74 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20  st parameter to 
150a0 74 68 65 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e  the correspondin
150b0 67 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6c 6f  g.** [sqlite3_lo
150c0 67 28 29 5d 20 63 61 6c 6c 20 61 6e 64 20 69 73  g()] call and is
150d0 20 69 6e 74 65 6e 64 65 64 20 74 6f 20 62 65 20   intended to be 
150e0 61 20 5b 72 65 73 75 6c 74 20 63 6f 64 65 5d 20  a [result code] 
150f0 6f 72 20 61 6e 0a 2a 2a 20 5b 65 78 74 65 6e 64  or an.** [extend
15100 65 64 20 72 65 73 75 6c 74 20 63 6f 64 65 5d 2e  ed result code].
15110 20 20 5e 54 68 65 20 74 68 69 72 64 20 70 61 72    ^The third par
15120 61 6d 65 74 65 72 20 70 61 73 73 65 64 20 74 6f  ameter passed to
15130 20 74 68 65 20 6c 6f 67 67 65 72 20 69 73 0a 2a   the logger is.*
15140 2a 20 6c 6f 67 20 6d 65 73 73 61 67 65 20 61 66  * log message af
15150 74 65 72 20 66 6f 72 6d 61 74 74 69 6e 67 20 76  ter formatting v
15160 69 61 20 5b 73 71 6c 69 74 65 33 5f 73 6e 70 72  ia [sqlite3_snpr
15170 69 6e 74 66 28 29 5d 2e 0a 2a 2a 20 54 68 65 20  intf()]..** The 
15180 53 51 4c 69 74 65 20 6c 6f 67 67 69 6e 67 20 69  SQLite logging i
15190 6e 74 65 72 66 61 63 65 20 69 73 20 6e 6f 74 20  nterface is not 
151a0 72 65 65 6e 74 72 61 6e 74 3b 20 74 68 65 20 6c  reentrant; the l
151b0 6f 67 67 65 72 20 66 75 6e 63 74 69 6f 6e 0a 2a  ogger function.*
151c0 2a 20 73 75 70 70 6c 69 65 64 20 62 79 20 74 68  * supplied by th
151d0 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 6d 75  e application mu
151e0 73 74 20 6e 6f 74 20 69 6e 76 6f 6b 65 20 61 6e  st not invoke an
151f0 79 20 53 51 4c 69 74 65 20 69 6e 74 65 72 66 61  y SQLite interfa
15200 63 65 2e 0a 2a 2a 20 49 6e 20 61 20 6d 75 6c 74  ce..** In a mult
15210 69 2d 74 68 72 65 61 64 65 64 20 61 70 70 6c 69  i-threaded appli
15220 63 61 74 69 6f 6e 2c 20 74 68 65 20 61 70 70 6c  cation, the appl
15230 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20  ication-defined 
15240 6c 6f 67 67 65 72 0a 2a 2a 20 66 75 6e 63 74 69  logger.** functi
15250 6f 6e 20 6d 75 73 74 20 62 65 20 74 68 72 65 61  on must be threa
15260 64 73 61 66 65 2e 20 3c 2f 64 64 3e 0a 2a 2a 0a  dsafe. </dd>.**.
15270 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46  ** [[SQLITE_CONF
15280 49 47 5f 55 52 49 5d 5d 20 3c 64 74 3e 53 51 4c  IG_URI]] <dt>SQL
15290 49 54 45 5f 43 4f 4e 46 49 47 5f 55 52 49 0a 2a  ITE_CONFIG_URI.*
152a0 2a 20 3c 64 64 3e 5e 28 54 68 65 20 53 51 4c 49  * <dd>^(The SQLI
152b0 54 45 5f 43 4f 4e 46 49 47 5f 55 52 49 20 6f 70  TE_CONFIG_URI op
152c0 74 69 6f 6e 20 74 61 6b 65 73 20 61 20 73 69 6e  tion takes a sin
152d0 67 6c 65 20 61 72 67 75 6d 65 6e 74 20 6f 66 20  gle argument of 
152e0 74 79 70 65 20 69 6e 74 2e 0a 2a 2a 20 49 66 20  type int..** If 
152f0 6e 6f 6e 2d 7a 65 72 6f 2c 20 74 68 65 6e 20 55  non-zero, then U
15300 52 49 20 68 61 6e 64 6c 69 6e 67 20 69 73 20 67  RI handling is g
15310 6c 6f 62 61 6c 6c 79 20 65 6e 61 62 6c 65 64 2e  lobally enabled.
15320 20 49 66 20 74 68 65 20 70 61 72 61 6d 65 74 65   If the paramete
15330 72 20 69 73 20 7a 65 72 6f 2c 0a 2a 2a 20 74 68  r is zero,.** th
15340 65 6e 20 55 52 49 20 68 61 6e 64 6c 69 6e 67 20  en URI handling 
15350 69 73 20 67 6c 6f 62 61 6c 6c 79 20 64 69 73 61  is globally disa
15360 62 6c 65 64 2e 29 5e 20 5e 49 66 20 55 52 49 20  bled.)^ ^If URI 
15370 68 61 6e 64 6c 69 6e 67 20 69 73 20 67 6c 6f 62  handling is glob
15380 61 6c 6c 79 0a 2a 2a 20 65 6e 61 62 6c 65 64 2c  ally.** enabled,
15390 20 61 6c 6c 20 66 69 6c 65 6e 61 6d 65 73 20 70   all filenames p
153a0 61 73 73 65 64 20 74 6f 20 5b 73 71 6c 69 74 65  assed to [sqlite
153b0 33 5f 6f 70 65 6e 28 29 5d 2c 20 5b 73 71 6c 69  3_open()], [sqli
153c0 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 5d 2c 0a  te3_open_v2()],.
153d0 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e  ** [sqlite3_open
153e0 31 36 28 29 5d 20 6f 72 0a 2a 2a 20 73 70 65 63  16()] or.** spec
153f0 69 66 69 65 64 20 61 73 20 70 61 72 74 20 6f 66  ified as part of
15400 20 5b 41 54 54 41 43 48 5d 20 63 6f 6d 6d 61 6e   [ATTACH] comman
15410 64 73 20 61 72 65 20 69 6e 74 65 72 70 72 65 74  ds are interpret
15420 65 64 20 61 73 20 55 52 49 73 2c 20 72 65 67 61  ed as URIs, rega
15430 72 64 6c 65 73 73 0a 2a 2a 20 6f 66 20 77 68 65  rdless.** of whe
15440 74 68 65 72 20 6f 72 20 6e 6f 74 20 74 68 65 20  ther or not the 
15450 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 55 52 49  [SQLITE_OPEN_URI
15460 5d 20 66 6c 61 67 20 69 73 20 73 65 74 20 77 68  ] flag is set wh
15470 65 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 0a  en the database.
15480 2a 2a 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 69 73  ** connection is
15490 20 6f 70 65 6e 65 64 2e 20 5e 49 66 20 69 74 20   opened. ^If it 
154a0 69 73 20 67 6c 6f 62 61 6c 6c 79 20 64 69 73 61  is globally disa
154b0 62 6c 65 64 2c 20 66 69 6c 65 6e 61 6d 65 73 20  bled, filenames 
154c0 61 72 65 0a 2a 2a 20 6f 6e 6c 79 20 69 6e 74 65  are.** only inte
154d0 72 70 72 65 74 65 64 20 61 73 20 55 52 49 73 20  rpreted as URIs 
154e0 69 66 20 74 68 65 20 53 51 4c 49 54 45 5f 4f 50  if the SQLITE_OP
154f0 45 4e 5f 55 52 49 20 66 6c 61 67 20 69 73 20 73  EN_URI flag is s
15500 65 74 20 77 68 65 6e 20 74 68 65 0a 2a 2a 20 64  et when the.** d
15510 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
15520 6f 6e 20 69 73 20 6f 70 65 6e 65 64 2e 20 5e 28  on is opened. ^(
15530 42 79 20 64 65 66 61 75 6c 74 2c 20 55 52 49 20  By default, URI 
15540 68 61 6e 64 6c 69 6e 67 20 69 73 20 67 6c 6f 62  handling is glob
15550 61 6c 6c 79 0a 2a 2a 20 64 69 73 61 62 6c 65 64  ally.** disabled
15560 2e 20 54 68 65 20 64 65 66 61 75 6c 74 20 76 61  . The default va
15570 6c 75 65 20 6d 61 79 20 62 65 20 63 68 61 6e 67  lue may be chang
15580 65 64 20 62 79 20 63 6f 6d 70 69 6c 69 6e 67 20  ed by compiling 
15590 77 69 74 68 20 74 68 65 0a 2a 2a 20 5b 53 51 4c  with the.** [SQL
155a0 49 54 45 5f 55 53 45 5f 55 52 49 5d 20 73 79 6d  ITE_USE_URI] sym
155b0 62 6f 6c 20 64 65 66 69 6e 65 64 2e 29 5e 0a 2a  bol defined.)^.*
155c0 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 43 4f  *.** [[SQLITE_CO
155d0 4e 46 49 47 5f 43 4f 56 45 52 49 4e 47 5f 49 4e  NFIG_COVERING_IN
155e0 44 45 58 5f 53 43 41 4e 5d 5d 20 3c 64 74 3e 53  DEX_SCAN]] <dt>S
155f0 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 43 4f 56  QLITE_CONFIG_COV
15600 45 52 49 4e 47 5f 49 4e 44 45 58 5f 53 43 41 4e  ERING_INDEX_SCAN
15610 0a 2a 2a 20 3c 64 64 3e 5e 54 68 65 20 53 51 4c  .** <dd>^The SQL
15620 49 54 45 5f 43 4f 4e 46 49 47 5f 43 4f 56 45 52  ITE_CONFIG_COVER
15630 49 4e 47 5f 49 4e 44 45 58 5f 53 43 41 4e 20 6f  ING_INDEX_SCAN o
15640 70 74 69 6f 6e 20 74 61 6b 65 73 20 61 20 73 69  ption takes a si
15650 6e 67 6c 65 20 69 6e 74 65 67 65 72 0a 2a 2a 20  ngle integer.** 
15660 61 72 67 75 6d 65 6e 74 20 77 68 69 63 68 20 69  argument which i
15670 73 20 69 6e 74 65 72 70 72 65 74 65 64 20 61 73  s interpreted as
15680 20 61 20 62 6f 6f 6c 65 61 6e 20 69 6e 20 6f 72   a boolean in or
15690 64 65 72 20 74 6f 20 65 6e 61 62 6c 65 20 6f 72  der to enable or
156a0 20 64 69 73 61 62 6c 65 0a 2a 2a 20 74 68 65 20   disable.** the 
156b0 75 73 65 20 6f 66 20 63 6f 76 65 72 69 6e 67 20  use of covering 
156c0 69 6e 64 69 63 65 73 20 66 6f 72 20 66 75 6c 6c  indices for full
156d0 20 74 61 62 6c 65 20 73 63 61 6e 73 20 69 6e 20   table scans in 
156e0 74 68 65 20 71 75 65 72 79 20 6f 70 74 69 6d 69  the query optimi
156f0 7a 65 72 2e 0a 2a 2a 20 5e 54 68 65 20 64 65 66  zer..** ^The def
15700 61 75 6c 74 20 73 65 74 74 69 6e 67 20 69 73 20  ault setting is 
15710 64 65 74 65 72 6d 69 6e 65 64 0a 2a 2a 20 62 79  determined.** by
15720 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 41 4c 4c   the [SQLITE_ALL
15730 4f 57 5f 43 4f 56 45 52 49 4e 47 5f 49 4e 44 45  OW_COVERING_INDE
15740 58 5f 53 43 41 4e 5d 20 63 6f 6d 70 69 6c 65 2d  X_SCAN] compile-
15750 74 69 6d 65 20 6f 70 74 69 6f 6e 2c 20 6f 72 20  time option, or 
15760 69 73 20 22 6f 6e 22 0a 2a 2a 20 69 66 20 74 68  is "on".** if th
15770 61 74 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20  at compile-time 
15780 6f 70 74 69 6f 6e 20 69 73 20 6f 6d 69 74 74 65  option is omitte
15790 64 2e 0a 2a 2a 20 54 68 65 20 61 62 69 6c 69 74  d..** The abilit
157a0 79 20 74 6f 20 64 69 73 61 62 6c 65 20 74 68 65  y to disable the
157b0 20 75 73 65 20 6f 66 20 63 6f 76 65 72 69 6e 67   use of covering
157c0 20 69 6e 64 69 63 65 73 20 66 6f 72 20 66 75 6c   indices for ful
157d0 6c 20 74 61 62 6c 65 20 73 63 61 6e 73 0a 2a 2a  l table scans.**
157e0 20 69 73 20 62 65 63 61 75 73 65 20 73 6f 6d 65   is because some
157f0 20 69 6e 63 6f 72 72 65 63 74 6c 79 20 63 6f 64   incorrectly cod
15800 65 64 20 6c 65 67 61 63 79 20 61 70 70 6c 69 63  ed legacy applic
15810 61 74 69 6f 6e 73 20 6d 69 67 68 74 20 6d 61 6c  ations might mal
15820 66 75 6e 63 74 69 6f 6e 0a 2a 2a 20 77 68 65 6e  function.** when
15830 20 74 68 65 20 6f 70 74 69 6d 69 7a 61 74 69 6f   the optimizatio
15840 6e 20 69 73 20 65 6e 61 62 6c 65 64 2e 20 20 50  n is enabled.  P
15850 72 6f 76 69 64 69 6e 67 20 74 68 65 20 61 62 69  roviding the abi
15860 6c 69 74 79 20 74 6f 0a 2a 2a 20 64 69 73 61 62  lity to.** disab
15870 6c 65 20 74 68 65 20 6f 70 74 69 6d 69 7a 61 74  le the optimizat
15880 69 6f 6e 20 61 6c 6c 6f 77 73 20 74 68 65 20 6f  ion allows the o
15890 6c 64 65 72 2c 20 62 75 67 67 79 20 61 70 70 6c  lder, buggy appl
158a0 69 63 61 74 69 6f 6e 20 63 6f 64 65 20 74 6f 20  ication code to 
158b0 77 6f 72 6b 0a 2a 2a 20 77 69 74 68 6f 75 74 20  work.** without 
158c0 63 68 61 6e 67 65 20 65 76 65 6e 20 77 69 74 68  change even with
158d0 20 6e 65 77 65 72 20 76 65 72 73 69 6f 6e 73 20   newer versions 
158e0 6f 66 20 53 51 4c 69 74 65 2e 0a 2a 2a 0a 2a 2a  of SQLite..**.**
158f0 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
15900 5f 50 43 41 43 48 45 5d 5d 20 5b 5b 53 51 4c 49  _PCACHE]] [[SQLI
15910 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 50 43 41  TE_CONFIG_GETPCA
15920 43 48 45 5d 5d 0a 2a 2a 20 3c 64 74 3e 53 51 4c  CHE]].** <dt>SQL
15930 49 54 45 5f 43 4f 4e 46 49 47 5f 50 43 41 43 48  ITE_CONFIG_PCACH
15940 45 20 61 6e 64 20 53 51 4c 49 54 45 5f 43 4f 4e  E and SQLITE_CON
15950 46 49 47 5f 47 45 54 50 43 41 43 48 45 0a 2a 2a  FIG_GETPCACHE.**
15960 20 3c 64 64 3e 20 54 68 65 73 65 20 6f 70 74 69   <dd> These opti
15970 6f 6e 73 20 61 72 65 20 6f 62 73 6f 6c 65 74 65  ons are obsolete
15980 20 61 6e 64 20 73 68 6f 75 6c 64 20 6e 6f 74 20   and should not 
15990 62 65 20 75 73 65 64 20 62 79 20 6e 65 77 20 63  be used by new c
159a0 6f 64 65 2e 0a 2a 2a 20 54 68 65 79 20 61 72 65  ode..** They are
159b0 20 72 65 74 61 69 6e 65 64 20 66 6f 72 20 62 61   retained for ba
159c0 63 6b 77 61 72 64 73 20 63 6f 6d 70 61 74 69 62  ckwards compatib
159d0 69 6c 69 74 79 20 62 75 74 20 61 72 65 20 6e 6f  ility but are no
159e0 77 20 6e 6f 2d 6f 70 73 2e 0a 2a 2a 20 3c 2f 64  w no-ops..** </d
159f0 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  d>.**.** [[SQLIT
15a00 45 5f 43 4f 4e 46 49 47 5f 53 51 4c 4c 4f 47 5d  E_CONFIG_SQLLOG]
15a10 5d 0a 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f  ].** <dt>SQLITE_
15a20 43 4f 4e 46 49 47 5f 53 51 4c 4c 4f 47 0a 2a 2a  CONFIG_SQLLOG.**
15a30 20 3c 64 64 3e 54 68 69 73 20 6f 70 74 69 6f 6e   <dd>This option
15a40 20 69 73 20 6f 6e 6c 79 20 61 76 61 69 6c 61 62   is only availab
15a50 6c 65 20 69 66 20 73 71 6c 69 74 65 20 69 73 20  le if sqlite is 
15a60 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 74 68  compiled with th
15a70 65 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 45 4e 41  e.** [SQLITE_ENA
15a80 42 4c 45 5f 53 51 4c 4c 4f 47 5d 20 70 72 65 2d  BLE_SQLLOG] pre-
15a90 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f 20  processor macro 
15aa0 64 65 66 69 6e 65 64 2e 20 54 68 65 20 66 69 72  defined. The fir
15ab0 73 74 20 61 72 67 75 6d 65 6e 74 20 73 68 6f 75  st argument shou
15ac0 6c 64 0a 2a 2a 20 62 65 20 61 20 70 6f 69 6e 74  ld.** be a point
15ad0 65 72 20 74 6f 20 61 20 66 75 6e 63 74 69 6f 6e  er to a function
15ae0 20 6f 66 20 74 79 70 65 20 76 6f 69 64 28 2a 29   of type void(*)
15af0 28 76 6f 69 64 2a 2c 73 71 6c 69 74 65 33 2a 2c  (void*,sqlite3*,
15b00 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20 69 6e 74  const char*, int
15b10 29 2e 0a 2a 2a 20 54 68 65 20 73 65 63 6f 6e 64  )..** The second
15b20 20 73 68 6f 75 6c 64 20 62 65 20 6f 66 20 74 79   should be of ty
15b30 70 65 20 28 76 6f 69 64 2a 29 2e 20 54 68 65 20  pe (void*). The 
15b40 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f  callback is invo
15b50 6b 65 64 20 62 79 20 74 68 65 20 6c 69 62 72 61  ked by the libra
15b60 72 79 0a 2a 2a 20 69 6e 20 74 68 72 65 65 20 73  ry.** in three s
15b70 65 70 61 72 61 74 65 20 63 69 72 63 75 6d 73 74  eparate circumst
15b80 61 6e 63 65 73 2c 20 69 64 65 6e 74 69 66 69 65  ances, identifie
15b90 64 20 62 79 20 74 68 65 20 76 61 6c 75 65 20 70  d by the value p
15ba0 61 73 73 65 64 20 61 73 20 74 68 65 0a 2a 2a 20  assed as the.** 
15bb0 66 6f 75 72 74 68 20 70 61 72 61 6d 65 74 65 72  fourth parameter
15bc0 2e 20 49 66 20 74 68 65 20 66 6f 75 72 74 68 20  . If the fourth 
15bd0 70 61 72 61 6d 65 74 65 72 20 69 73 20 30 2c 20  parameter is 0, 
15be0 74 68 65 6e 20 74 68 65 20 64 61 74 61 62 61 73  then the databas
15bf0 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 0a 2a 2a 20  e connection.** 
15c00 70 61 73 73 65 64 20 61 73 20 74 68 65 20 73 65  passed as the se
15c10 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20 68 61  cond argument ha
15c20 73 20 6a 75 73 74 20 62 65 65 6e 20 6f 70 65 6e  s just been open
15c30 65 64 2e 20 54 68 65 20 74 68 69 72 64 20 61 72  ed. The third ar
15c40 67 75 6d 65 6e 74 0a 2a 2a 20 70 6f 69 6e 74 73  gument.** points
15c50 20 74 6f 20 61 20 62 75 66 66 65 72 20 63 6f 6e   to a buffer con
15c60 74 61 69 6e 69 6e 67 20 74 68 65 20 6e 61 6d 65  taining the name
15c70 20 6f 66 20 74 68 65 20 6d 61 69 6e 20 64 61 74   of the main dat
15c80 61 62 61 73 65 20 66 69 6c 65 2e 20 49 66 20 74  abase file. If t
15c90 68 65 0a 2a 2a 20 66 6f 75 72 74 68 20 70 61 72  he.** fourth par
15ca0 61 6d 65 74 65 72 20 69 73 20 31 2c 20 74 68 65  ameter is 1, the
15cb0 6e 20 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d  n the SQL statem
15cc0 65 6e 74 20 74 68 61 74 20 74 68 65 20 74 68 69  ent that the thi
15cd0 72 64 20 70 61 72 61 6d 65 74 65 72 0a 2a 2a 20  rd parameter.** 
15ce0 70 6f 69 6e 74 73 20 74 6f 20 68 61 73 20 6a 75  points to has ju
15cf0 73 74 20 62 65 65 6e 20 65 78 65 63 75 74 65 64  st been executed
15d00 2e 20 4f 72 2c 20 69 66 20 74 68 65 20 66 6f 75  . Or, if the fou
15d10 72 74 68 20 70 61 72 61 6d 65 74 65 72 20 69 73  rth parameter is
15d20 20 32 2c 20 74 68 65 6e 0a 2a 2a 20 74 68 65 20   2, then.** the 
15d30 63 6f 6e 6e 65 63 74 69 6f 6e 20 62 65 69 6e 67  connection being
15d40 20 70 61 73 73 65 64 20 61 73 20 74 68 65 20 73   passed as the s
15d50 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20  econd parameter 
15d60 69 73 20 62 65 69 6e 67 20 63 6c 6f 73 65 64 2e  is being closed.
15d70 20 54 68 65 0a 2a 2a 20 74 68 69 72 64 20 70 61   The.** third pa
15d80 72 61 6d 65 74 65 72 20 69 73 20 70 61 73 73 65  rameter is passe
15d90 64 20 4e 55 4c 4c 20 49 6e 20 74 68 69 73 20 63  d NULL In this c
15da0 61 73 65 2e 20 20 41 6e 20 65 78 61 6d 70 6c 65  ase.  An example
15db0 20 6f 66 20 75 73 69 6e 67 20 74 68 69 73 0a 2a   of using this.*
15dc0 2a 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20  * configuration 
15dd0 6f 70 74 69 6f 6e 20 63 61 6e 20 62 65 20 73 65  option can be se
15de0 65 6e 20 69 6e 20 74 68 65 20 22 74 65 73 74 5f  en in the "test_
15df0 73 71 6c 6c 6f 67 2e 63 22 20 73 6f 75 72 63 65  sqllog.c" source
15e00 20 66 69 6c 65 20 69 6e 0a 2a 2a 20 74 68 65 20   file in.** the 
15e10 63 61 6e 6f 6e 69 63 61 6c 20 53 51 4c 69 74 65  canonical SQLite
15e20 20 73 6f 75 72 63 65 20 74 72 65 65 2e 3c 2f 64   source tree.</d
15e30 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  d>.**.** [[SQLIT
15e40 45 5f 43 4f 4e 46 49 47 5f 4d 4d 41 50 5f 53 49  E_CONFIG_MMAP_SI
15e50 5a 45 5d 5d 0a 2a 2a 20 3c 64 74 3e 53 51 4c 49  ZE]].** <dt>SQLI
15e60 54 45 5f 43 4f 4e 46 49 47 5f 4d 4d 41 50 5f 53  TE_CONFIG_MMAP_S
15e70 49 5a 45 0a 2a 2a 20 3c 64 64 3e 5e 53 51 4c 49  IZE.** <dd>^SQLI
15e80 54 45 5f 43 4f 4e 46 49 47 5f 4d 4d 41 50 5f 53  TE_CONFIG_MMAP_S
15e90 49 5a 45 20 74 61 6b 65 73 20 74 77 6f 20 36 34  IZE takes two 64
15ea0 2d 62 69 74 20 69 6e 74 65 67 65 72 20 28 73 71  -bit integer (sq
15eb0 6c 69 74 65 33 5f 69 6e 74 36 34 29 20 76 61 6c  lite3_int64) val
15ec0 75 65 73 0a 2a 2a 20 74 68 61 74 20 61 72 65 20  ues.** that are 
15ed0 74 68 65 20 64 65 66 61 75 6c 74 20 6d 6d 61 70  the default mmap
15ee0 20 73 69 7a 65 20 6c 69 6d 69 74 20 28 74 68 65   size limit (the
15ef0 20 64 65 66 61 75 6c 74 20 73 65 74 74 69 6e 67   default setting
15f00 20 66 6f 72 0a 2a 2a 20 5b 50 52 41 47 4d 41 20   for.** [PRAGMA 
15f10 6d 6d 61 70 5f 73 69 7a 65 5d 29 20 61 6e 64 20  mmap_size]) and 
15f20 74 68 65 20 6d 61 78 69 6d 75 6d 20 61 6c 6c 6f  the maximum allo
15f30 77 65 64 20 6d 6d 61 70 20 73 69 7a 65 20 6c 69  wed mmap size li
15f40 6d 69 74 2e 0a 2a 2a 20 5e 54 68 65 20 64 65 66  mit..** ^The def
15f50 61 75 6c 74 20 73 65 74 74 69 6e 67 20 63 61 6e  ault setting can
15f60 20 62 65 20 6f 76 65 72 72 69 64 64 65 6e 20 62   be overridden b
15f70 79 20 65 61 63 68 20 64 61 74 61 62 61 73 65 20  y each database 
15f80 63 6f 6e 6e 65 63 74 69 6f 6e 20 75 73 69 6e 67  connection using
15f90 0a 2a 2a 20 65 69 74 68 65 72 20 74 68 65 20 5b  .** either the [
15fa0 50 52 41 47 4d 41 20 6d 6d 61 70 5f 73 69 7a 65  PRAGMA mmap_size
15fb0 5d 20 63 6f 6d 6d 61 6e 64 2c 20 6f 72 20 62 79  ] command, or by
15fc0 20 75 73 69 6e 67 20 74 68 65 0a 2a 2a 20 5b 53   using the.** [S
15fd0 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 4d 4d 41 50  QLITE_FCNTL_MMAP
15fe0 5f 53 49 5a 45 5d 20 66 69 6c 65 20 63 6f 6e 74  _SIZE] file cont
15ff0 72 6f 6c 2e 20 20 5e 28 54 68 65 20 6d 61 78 69  rol.  ^(The maxi
16000 6d 75 6d 20 61 6c 6c 6f 77 65 64 20 6d 6d 61 70  mum allowed mmap
16010 20 73 69 7a 65 0a 2a 2a 20 77 69 6c 6c 20 62 65   size.** will be
16020 20 73 69 6c 65 6e 74 6c 79 20 74 72 75 6e 63 61   silently trunca
16030 74 65 64 20 69 66 20 6e 65 63 65 73 73 61 72 79  ted if necessary
16040 20 73 6f 20 74 68 61 74 20 69 74 20 64 6f 65 73   so that it does
16050 20 6e 6f 74 20 65 78 63 65 65 64 20 74 68 65 0a   not exceed the.
16060 2a 2a 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20  ** compile-time 
16070 6d 61 78 69 6d 75 6d 20 6d 6d 61 70 20 73 69 7a  maximum mmap siz
16080 65 20 73 65 74 20 62 79 20 74 68 65 0a 2a 2a 20  e set by the.** 
16090 5b 53 51 4c 49 54 45 5f 4d 41 58 5f 4d 4d 41 50  [SQLITE_MAX_MMAP
160a0 5f 53 49 5a 45 5d 20 63 6f 6d 70 69 6c 65 2d 74  _SIZE] compile-t
160b0 69 6d 65 20 6f 70 74 69 6f 6e 2e 29 5e 0a 2a 2a  ime option.)^.**
160c0 20 5e 49 66 20 65 69 74 68 65 72 20 61 72 67 75   ^If either argu
160d0 6d 65 6e 74 20 74 6f 20 74 68 69 73 20 6f 70 74  ment to this opt
160e0 69 6f 6e 20 69 73 20 6e 65 67 61 74 69 76 65 2c  ion is negative,
160f0 20 74 68 65 6e 20 74 68 61 74 20 61 72 67 75 6d   then that argum
16100 65 6e 74 20 69 73 0a 2a 2a 20 63 68 61 6e 67 65  ent is.** change
16110 64 20 74 6f 20 69 74 73 20 63 6f 6d 70 69 6c 65  d to its compile
16120 2d 74 69 6d 65 20 64 65 66 61 75 6c 74 2e 0a 2a  -time default..*
16130 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 43 4f  *.** [[SQLITE_CO
16140 4e 46 49 47 5f 57 49 4e 33 32 5f 48 45 41 50 53  NFIG_WIN32_HEAPS
16150 49 5a 45 5d 5d 0a 2a 2a 20 3c 64 74 3e 53 51 4c  IZE]].** <dt>SQL
16160 49 54 45 5f 43 4f 4e 46 49 47 5f 57 49 4e 33 32  ITE_CONFIG_WIN32
16170 5f 48 45 41 50 53 49 5a 45 0a 2a 2a 20 3c 64 64  _HEAPSIZE.** <dd
16180 3e 5e 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e  >^The SQLITE_CON
16190 46 49 47 5f 57 49 4e 33 32 5f 48 45 41 50 53 49  FIG_WIN32_HEAPSI
161a0 5a 45 20 6f 70 74 69 6f 6e 20 69 73 20 6f 6e 6c  ZE option is onl
161b0 79 20 61 76 61 69 6c 61 62 6c 65 20 69 66 20 53  y available if S
161c0 51 4c 69 74 65 20 69 73 0a 2a 2a 20 63 6f 6d 70  QLite is.** comp
161d0 69 6c 65 64 20 66 6f 72 20 57 69 6e 64 6f 77 73  iled for Windows
161e0 20 77 69 74 68 20 74 68 65 20 5b 53 51 4c 49 54   with the [SQLIT
161f0 45 5f 57 49 4e 33 32 5f 4d 41 4c 4c 4f 43 5d 20  E_WIN32_MALLOC] 
16200 70 72 65 2d 70 72 6f 63 65 73 73 6f 72 20 6d 61  pre-processor ma
16210 63 72 6f 0a 2a 2a 20 64 65 66 69 6e 65 64 2e 20  cro.** defined. 
16220 5e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 57  ^SQLITE_CONFIG_W
16230 49 4e 33 32 5f 48 45 41 50 53 49 5a 45 20 74 61  IN32_HEAPSIZE ta
16240 6b 65 73 20 61 20 33 32 2d 62 69 74 20 75 6e 73  kes a 32-bit uns
16250 69 67 6e 65 64 20 69 6e 74 65 67 65 72 20 76 61  igned integer va
16260 6c 75 65 0a 2a 2a 20 74 68 61 74 20 73 70 65 63  lue.** that spec
16270 69 66 69 65 73 20 74 68 65 20 6d 61 78 69 6d 75  ifies the maximu
16280 6d 20 73 69 7a 65 20 6f 66 20 74 68 65 20 63 72  m size of the cr
16290 65 61 74 65 64 20 68 65 61 70 2e 0a 2a 2a 0a 2a  eated heap..**.*
162a0 2a 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49  * [[SQLITE_CONFI
162b0 47 5f 50 43 41 43 48 45 5f 48 44 52 53 5a 5d 5d  G_PCACHE_HDRSZ]]
162c0 0a 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43  .** <dt>SQLITE_C
162d0 4f 4e 46 49 47 5f 50 43 41 43 48 45 5f 48 44 52  ONFIG_PCACHE_HDR
162e0 53 5a 0a 2a 2a 20 3c 64 64 3e 5e 54 68 65 20 53  SZ.** <dd>^The S
162f0 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 43 41  QLITE_CONFIG_PCA
16300 43 48 45 5f 48 44 52 53 5a 20 6f 70 74 69 6f 6e  CHE_HDRSZ option
16310 20 74 61 6b 65 73 20 61 20 73 69 6e 67 6c 65 20   takes a single 
16320 70 61 72 61 6d 65 74 65 72 20 77 68 69 63 68 0a  parameter which.
16330 2a 2a 20 69 73 20 61 20 70 6f 69 6e 74 65 72 20  ** is a pointer 
16340 74 6f 20 61 6e 20 69 6e 74 65 67 65 72 20 61 6e  to an integer an
16350 64 20 77 72 69 74 65 73 20 69 6e 74 6f 20 74 68  d writes into th
16360 61 74 20 69 6e 74 65 67 65 72 20 74 68 65 20 6e  at integer the n
16370 75 6d 62 65 72 20 6f 66 20 65 78 74 72 61 0a 2a  umber of extra.*
16380 2a 20 62 79 74 65 73 20 70 65 72 20 70 61 67 65  * bytes per page
16390 20 72 65 71 75 69 72 65 64 20 66 6f 72 20 65 61   required for ea
163a0 63 68 20 70 61 67 65 20 69 6e 20 5b 53 51 4c 49  ch page in [SQLI
163b0 54 45 5f 43 4f 4e 46 49 47 5f 50 41 47 45 43 41  TE_CONFIG_PAGECA
163c0 43 48 45 5d 2e 0a 2a 2a 20 54 68 65 20 61 6d 6f  CHE]..** The amo
163d0 75 6e 74 20 6f 66 20 65 78 74 72 61 20 73 70 61  unt of extra spa
163e0 63 65 20 72 65 71 75 69 72 65 64 20 63 61 6e 20  ce required can 
163f0 63 68 61 6e 67 65 20 64 65 70 65 6e 64 69 6e 67  change depending
16400 20 6f 6e 20 74 68 65 20 63 6f 6d 70 69 6c 65 72   on the compiler
16410 2c 0a 2a 2a 20 74 61 72 67 65 74 20 70 6c 61 74  ,.** target plat
16420 66 6f 72 6d 2c 20 61 6e 64 20 53 51 4c 69 74 65  form, and SQLite
16430 20 76 65 72 73 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20   version..**.** 
16440 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  [[SQLITE_CONFIG_
16450 50 4d 41 53 5a 5d 5d 0a 2a 2a 20 3c 64 74 3e 53  PMASZ]].** <dt>S
16460 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 4d 41  QLITE_CONFIG_PMA
16470 53 5a 0a 2a 2a 20 3c 64 64 3e 5e 54 68 65 20 53  SZ.** <dd>^The S
16480 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 4d 41  QLITE_CONFIG_PMA
16490 53 5a 20 6f 70 74 69 6f 6e 20 74 61 6b 65 73 20  SZ option takes 
164a0 61 20 73 69 6e 67 6c 65 20 70 61 72 61 6d 65 74  a single paramet
164b0 65 72 20 77 68 69 63 68 0a 2a 2a 20 69 73 20 61  er which.** is a
164c0 6e 20 75 6e 73 69 67 6e 65 64 20 69 6e 74 65 67  n unsigned integ
164d0 65 72 20 61 6e 64 20 73 65 74 73 20 74 68 65 20  er and sets the 
164e0 22 4d 69 6e 69 6d 75 6d 20 50 4d 41 20 53 69 7a  "Minimum PMA Siz
164f0 65 22 20 66 6f 72 20 74 68 65 20 6d 75 6c 74 69  e" for the multi
16500 74 68 72 65 61 64 65 64 0a 2a 2a 20 73 6f 72 74  threaded.** sort
16510 65 72 20 74 6f 20 74 68 61 74 20 69 6e 74 65 67  er to that integ
16520 65 72 2e 20 20 54 68 65 20 64 65 66 61 75 6c 74  er.  The default
16530 20 6d 69 6e 69 6d 75 6d 20 50 4d 41 20 53 69 7a   minimum PMA Siz
16540 65 20 69 73 20 73 65 74 20 62 79 20 74 68 65 0a  e is set by the.
16550 2a 2a 20 5b 53 51 4c 49 54 45 5f 53 4f 52 54 45  ** [SQLITE_SORTE
16560 52 5f 50 4d 41 53 5a 5d 20 63 6f 6d 70 69 6c 65  R_PMASZ] compile
16570 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 2e 20 20 4e  -time option.  N
16580 65 77 20 74 68 72 65 61 64 73 20 61 72 65 20 6c  ew threads are l
16590 61 75 6e 63 68 65 64 0a 2a 2a 20 74 6f 20 68 65  aunched.** to he
165a0 6c 70 20 77 69 74 68 20 73 6f 72 74 20 6f 70 65  lp with sort ope
165b0 72 61 74 69 6f 6e 73 20 77 68 65 6e 20 6d 75 6c  rations when mul
165c0 74 69 74 68 72 65 61 64 65 64 20 73 6f 72 74 69  tithreaded sorti
165d0 6e 67 0a 2a 2a 20 69 73 20 65 6e 61 62 6c 65 64  ng.** is enabled
165e0 20 28 75 73 69 6e 67 20 74 68 65 20 5b 50 52 41   (using the [PRA
165f0 47 4d 41 20 74 68 72 65 61 64 73 5d 20 63 6f 6d  GMA threads] com
16600 6d 61 6e 64 29 20 61 6e 64 20 74 68 65 20 61 6d  mand) and the am
16610 6f 75 6e 74 20 6f 66 20 63 6f 6e 74 65 6e 74 0a  ount of content.
16620 2a 2a 20 74 6f 20 62 65 20 73 6f 72 74 65 64 20  ** to be sorted 
16630 65 78 63 65 65 64 73 20 74 68 65 20 70 61 67 65  exceeds the page
16640 20 73 69 7a 65 20 74 69 6d 65 73 20 74 68 65 20   size times the 
16650 6d 69 6e 69 6d 75 6d 20 6f 66 20 74 68 65 0a 2a  minimum of the.*
16660 2a 20 5b 50 52 41 47 4d 41 20 63 61 63 68 65 5f  * [PRAGMA cache_
16670 73 69 7a 65 5d 20 73 65 74 74 69 6e 67 20 61 6e  size] setting an
16680 64 20 74 68 69 73 20 76 61 6c 75 65 2e 0a 2a 2a  d this value..**
16690 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e  .** [[SQLITE_CON
166a0 46 49 47 5f 53 54 4d 54 4a 52 4e 4c 5f 53 50 49  FIG_STMTJRNL_SPI
166b0 4c 4c 5d 5d 0a 2a 2a 20 3c 64 74 3e 53 51 4c 49  LL]].** <dt>SQLI
166c0 54 45 5f 43 4f 4e 46 49 47 5f 53 54 4d 54 4a 52  TE_CONFIG_STMTJR
166d0 4e 4c 5f 53 50 49 4c 4c 0a 2a 2a 20 3c 64 64 3e  NL_SPILL.** <dd>
166e0 5e 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46  ^The SQLITE_CONF
166f0 49 47 5f 53 54 4d 54 4a 52 4e 4c 5f 53 50 49 4c  IG_STMTJRNL_SPIL
16700 4c 20 6f 70 74 69 6f 6e 20 74 61 6b 65 73 20 61  L option takes a
16710 20 73 69 6e 67 6c 65 20 70 61 72 61 6d 65 74 65   single paramete
16720 72 20 77 68 69 63 68 0a 2a 2a 20 62 65 63 6f 6d  r which.** becom
16730 65 73 20 74 68 65 20 5b 73 74 61 74 65 6d 65 6e  es the [statemen
16740 74 20 6a 6f 75 72 6e 61 6c 5d 20 73 70 69 6c 6c  t journal] spill
16750 2d 74 6f 2d 64 69 73 6b 20 74 68 72 65 73 68 6f  -to-disk thresho
16760 6c 64 2e 20 20 0a 2a 2a 20 5b 53 74 61 74 65 6d  ld.  .** [Statem
16770 65 6e 74 20 6a 6f 75 72 6e 61 6c 73 5d 20 61 72  ent journals] ar
16780 65 20 68 65 6c 64 20 69 6e 20 6d 65 6d 6f 72 79  e held in memory
16790 20 75 6e 74 69 6c 20 74 68 65 69 72 20 73 69 7a   until their siz
167a0 65 20 28 69 6e 20 62 79 74 65 73 29 0a 2a 2a 20  e (in bytes).** 
167b0 65 78 63 65 65 64 73 20 74 68 69 73 20 74 68 72  exceeds this thr
167c0 65 73 68 6f 6c 64 2c 20 61 74 20 77 68 69 63 68  eshold, at which
167d0 20 70 6f 69 6e 74 20 74 68 65 79 20 61 72 65 20   point they are 
167e0 77 72 69 74 74 65 6e 20 74 6f 20 64 69 73 6b 2e  written to disk.
167f0 0a 2a 2a 20 4f 72 20 69 66 20 74 68 65 20 74 68  .** Or if the th
16800 72 65 73 68 6f 6c 64 20 69 73 20 2d 31 2c 20 73  reshold is -1, s
16810 74 61 74 65 6d 65 6e 74 20 6a 6f 75 72 6e 61 6c  tatement journal
16820 73 20 61 72 65 20 61 6c 77 61 79 73 20 68 65 6c  s are always hel
16830 64 0a 2a 2a 20 65 78 63 6c 75 73 69 76 65 6c 79  d.** exclusively
16840 20 69 6e 20 6d 65 6d 6f 72 79 2e 0a 2a 2a 20 53   in memory..** S
16850 69 6e 63 65 20 6d 61 6e 79 20 73 74 61 74 65 6d  ince many statem
16860 65 6e 74 20 6a 6f 75 72 6e 61 6c 73 20 6e 65 76  ent journals nev
16870 65 72 20 62 65 63 6f 6d 65 20 6c 61 72 67 65 2c  er become large,
16880 20 73 65 74 74 69 6e 67 20 74 68 65 20 73 70 69   setting the spi
16890 6c 6c 0a 2a 2a 20 74 68 72 65 73 68 6f 6c 64 20  ll.** threshold 
168a0 74 6f 20 61 20 76 61 6c 75 65 20 73 75 63 68 20  to a value such 
168b0 61 73 20 36 34 4b 69 42 20 63 61 6e 20 67 72 65  as 64KiB can gre
168c0 61 74 6c 79 20 72 65 64 75 63 65 20 74 68 65 20  atly reduce the 
168d0 61 6d 6f 75 6e 74 20 6f 66 0a 2a 2a 20 49 2f 4f  amount of.** I/O
168e0 20 72 65 71 75 69 72 65 64 20 74 6f 20 73 75 70   required to sup
168f0 70 6f 72 74 20 73 74 61 74 65 6d 65 6e 74 20 72  port statement r
16900 6f 6c 6c 62 61 63 6b 2e 0a 2a 2a 20 54 68 65 20  ollback..** The 
16910 64 65 66 61 75 6c 74 20 76 61 6c 75 65 20 66 6f  default value fo
16920 72 20 74 68 69 73 20 73 65 74 74 69 6e 67 20 69  r this setting i
16930 73 20 63 6f 6e 74 72 6f 6c 6c 65 64 20 62 79 20  s controlled by 
16940 74 68 65 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 53  the.** [SQLITE_S
16950 54 4d 54 4a 52 4e 4c 5f 53 50 49 4c 4c 5d 20 63  TMTJRNL_SPILL] c
16960 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69  ompile-time opti
16970 6f 6e 2e 0a 2a 2a 20 3c 2f 64 6c 3e 0a 2a 2f 0a  on..** </dl>.*/.
16980 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43  #define SQLITE_C
16990 4f 4e 46 49 47 5f 53 49 4e 47 4c 45 54 48 52 45  ONFIG_SINGLETHRE
169a0 41 44 20 20 31 20 20 2f 2a 20 6e 69 6c 20 2a 2f  AD  1  /* nil */
169b0 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
169c0 43 4f 4e 46 49 47 5f 4d 55 4c 54 49 54 48 52 45  CONFIG_MULTITHRE
169d0 41 44 20 20 20 32 20 20 2f 2a 20 6e 69 6c 20 2a  AD   2  /* nil *
169e0 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
169f0 5f 43 4f 4e 46 49 47 5f 53 45 52 49 41 4c 49 5a  _CONFIG_SERIALIZ
16a00 45 44 20 20 20 20 33 20 20 2f 2a 20 6e 69 6c 20  ED    3  /* nil 
16a10 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
16a20 45 5f 43 4f 4e 46 49 47 5f 4d 41 4c 4c 4f 43 20  E_CONFIG_MALLOC 
16a30 20 20 20 20 20 20 20 34 20 20 2f 2a 20 73 71 6c         4  /* sql
16a40 69 74 65 33 5f 6d 65 6d 5f 6d 65 74 68 6f 64 73  ite3_mem_methods
16a50 2a 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  * */.#define SQL
16a60 49 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 4d 41  ITE_CONFIG_GETMA
16a70 4c 4c 4f 43 20 20 20 20 20 35 20 20 2f 2a 20 73  LLOC     5  /* s
16a80 71 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65 74 68 6f  qlite3_mem_metho
16a90 64 73 2a 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ds* */.#define S
16aa0 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 43 52  QLITE_CONFIG_SCR
16ab0 41 54 43 48 20 20 20 20 20 20 20 36 20 20 2f 2a  ATCH       6  /*
16ac0 20 76 6f 69 64 2a 2c 20 69 6e 74 20 73 7a 2c 20   void*, int sz, 
16ad0 69 6e 74 20 4e 20 2a 2f 0a 23 64 65 66 69 6e 65  int N */.#define
16ae0 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50   SQLITE_CONFIG_P
16af0 41 47 45 43 41 43 48 45 20 20 20 20 20 37 20 20  AGECACHE     7  
16b00 2f 2a 20 76 6f 69 64 2a 2c 20 69 6e 74 20 73 7a  /* void*, int sz
16b10 2c 20 69 6e 74 20 4e 20 2a 2f 0a 23 64 65 66 69  , int N */.#defi
16b20 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47  ne SQLITE_CONFIG
16b30 5f 48 45 41 50 20 20 20 20 20 20 20 20 20 20 38  _HEAP          8
16b40 20 20 2f 2a 20 76 6f 69 64 2a 2c 20 69 6e 74 20    /* void*, int 
16b50 6e 42 79 74 65 2c 20 69 6e 74 20 6d 69 6e 20 2a  nByte, int min *
16b60 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
16b70 5f 43 4f 4e 46 49 47 5f 4d 45 4d 53 54 41 54 55  _CONFIG_MEMSTATU
16b80 53 20 20 20 20 20 39 20 20 2f 2a 20 62 6f 6f 6c  S     9  /* bool
16b90 65 61 6e 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ean */.#define S
16ba0 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 55 54  QLITE_CONFIG_MUT
16bb0 45 58 20 20 20 20 20 20 20 20 31 30 20 20 2f 2a  EX        10  /*
16bc0 20 73 71 6c 69 74 65 33 5f 6d 75 74 65 78 5f 6d   sqlite3_mutex_m
16bd0 65 74 68 6f 64 73 2a 20 2a 2f 0a 23 64 65 66 69  ethods* */.#defi
16be0 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47  ne SQLITE_CONFIG
16bf0 5f 47 45 54 4d 55 54 45 58 20 20 20 20 20 31 31  _GETMUTEX     11
16c00 20 20 2f 2a 20 73 71 6c 69 74 65 33 5f 6d 75 74    /* sqlite3_mut
16c10 65 78 5f 6d 65 74 68 6f 64 73 2a 20 2a 2f 0a 2f  ex_methods* */./
16c20 2a 20 70 72 65 76 69 6f 75 73 6c 79 20 53 51 4c  * previously SQL
16c30 49 54 45 5f 43 4f 4e 46 49 47 5f 43 48 55 4e 4b  ITE_CONFIG_CHUNK
16c40 41 4c 4c 4f 43 20 31 32 20 77 68 69 63 68 20 69  ALLOC 12 which i
16c50 73 20 6e 6f 77 20 75 6e 75 73 65 64 2e 20 2a 2f  s now unused. */
16c60 20 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45   .#define SQLITE
16c70 5f 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49 44  _CONFIG_LOOKASID
16c80 45 20 20 20 20 31 33 20 20 2f 2a 20 69 6e 74 20  E    13  /* int 
16c90 69 6e 74 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  int */.#define S
16ca0 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 43 41  QLITE_CONFIG_PCA
16cb0 43 48 45 20 20 20 20 20 20 20 31 34 20 20 2f 2a  CHE       14  /*
16cc0 20 6e 6f 2d 6f 70 20 2a 2f 0a 23 64 65 66 69 6e   no-op */.#defin
16cd0 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  e SQLITE_CONFIG_
16ce0 47 45 54 50 43 41 43 48 45 20 20 20 20 31 35 20  GETPCACHE    15 
16cf0 20 2f 2a 20 6e 6f 2d 6f 70 20 2a 2f 0a 23 64 65   /* no-op */.#de
16d00 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46  fine SQLITE_CONF
16d10 49 47 5f 4c 4f 47 20 20 20 20 20 20 20 20 20 20  IG_LOG          
16d20 31 36 20 20 2f 2a 20 78 46 75 6e 63 2c 20 76 6f  16  /* xFunc, vo
16d30 69 64 2a 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  id* */.#define S
16d40 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 55 52 49  QLITE_CONFIG_URI
16d50 20 20 20 20 20 20 20 20 20 20 31 37 20 20 2f 2a            17  /*
16d60 20 69 6e 74 20 2a 2f 0a 23 64 65 66 69 6e 65 20   int */.#define 
16d70 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 43  SQLITE_CONFIG_PC
16d80 41 43 48 45 32 20 20 20 20 20 20 31 38 20 20 2f  ACHE2      18  /
16d90 2a 20 73 71 6c 69 74 65 33 5f 70 63 61 63 68 65  * sqlite3_pcache
16da0 5f 6d 65 74 68 6f 64 73 32 2a 20 2a 2f 0a 23 64  _methods2* */.#d
16db0 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e  efine SQLITE_CON
16dc0 46 49 47 5f 47 45 54 50 43 41 43 48 45 32 20 20  FIG_GETPCACHE2  
16dd0 20 31 39 20 20 2f 2a 20 73 71 6c 69 74 65 33 5f   19  /* sqlite3_
16de0 70 63 61 63 68 65 5f 6d 65 74 68 6f 64 73 32 2a  pcache_methods2*
16df0 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
16e00 54 45 5f 43 4f 4e 46 49 47 5f 43 4f 56 45 52 49  TE_CONFIG_COVERI
16e10 4e 47 5f 49 4e 44 45 58 5f 53 43 41 4e 20 32 30  NG_INDEX_SCAN 20
16e20 20 20 2f 2a 20 69 6e 74 20 2a 2f 0a 23 64 65 66    /* int */.#def
16e30 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  ine SQLITE_CONFI
16e40 47 5f 53 51 4c 4c 4f 47 20 20 20 20 20 20 20 32  G_SQLLOG       2
16e50 31 20 20 2f 2a 20 78 53 71 6c 6c 6f 67 2c 20 76  1  /* xSqllog, v
16e60 6f 69 64 2a 20 2a 2f 0a 23 64 65 66 69 6e 65 20  oid* */.#define 
16e70 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 4d  SQLITE_CONFIG_MM
16e80 41 50 5f 53 49 5a 45 20 20 20 20 32 32 20 20 2f  AP_SIZE    22  /
16e90 2a 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 2c  * sqlite3_int64,
16ea0 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 20 2a   sqlite3_int64 *
16eb0 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
16ec0 5f 43 4f 4e 46 49 47 5f 57 49 4e 33 32 5f 48 45  _CONFIG_WIN32_HE
16ed0 41 50 53 49 5a 45 20 20 20 20 20 20 32 33 20 20  APSIZE      23  
16ee0 2f 2a 20 69 6e 74 20 6e 42 79 74 65 20 2a 2f 0a  /* int nByte */.
16ef0 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43  #define SQLITE_C
16f00 4f 4e 46 49 47 5f 50 43 41 43 48 45 5f 48 44 52  ONFIG_PCACHE_HDR
16f10 53 5a 20 20 20 20 20 20 20 20 32 34 20 20 2f 2a  SZ        24  /*
16f20 20 69 6e 74 20 2a 70 73 7a 20 2a 2f 0a 23 64 65   int *psz */.#de
16f30 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46  fine SQLITE_CONF
16f40 49 47 5f 50 4d 41 53 5a 20 20 20 20 20 20 20 20  IG_PMASZ        
16f50 20 20 20 20 20 20 20 32 35 20 20 2f 2a 20 75 6e         25  /* un
16f60 73 69 67 6e 65 64 20 69 6e 74 20 73 7a 50 6d 61  signed int szPma
16f70 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
16f80 54 45 5f 43 4f 4e 46 49 47 5f 53 54 4d 54 4a 52  TE_CONFIG_STMTJR
16f90 4e 4c 5f 53 50 49 4c 4c 20 20 20 20 20 20 32 36  NL_SPILL      26
16fa0 20 20 2f 2a 20 69 6e 74 20 6e 42 79 74 65 20 2a    /* int nByte *
16fb0 2f 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  /../*.** CAPI3RE
16fc0 46 3a 20 44 61 74 61 62 61 73 65 20 43 6f 6e 6e  F: Database Conn
16fd0 65 63 74 69 6f 6e 20 43 6f 6e 66 69 67 75 72 61  ection Configura
16fe0 74 69 6f 6e 20 4f 70 74 69 6f 6e 73 0a 2a 2a 0a  tion Options.**.
16ff0 2a 2a 20 54 68 65 73 65 20 63 6f 6e 73 74 61 6e  ** These constan
17000 74 73 20 61 72 65 20 74 68 65 20 61 76 61 69 6c  ts are the avail
17010 61 62 6c 65 20 69 6e 74 65 67 65 72 20 63 6f 6e  able integer con
17020 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f  figuration optio
17030 6e 73 20 74 68 61 74 0a 2a 2a 20 63 61 6e 20 62  ns that.** can b
17040 65 20 70 61 73 73 65 64 20 61 73 20 74 68 65 20  e passed as the 
17050 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20  second argument 
17060 74 6f 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  to the [sqlite3_
17070 64 62 5f 63 6f 6e 66 69 67 28 29 5d 20 69 6e 74  db_config()] int
17080 65 72 66 61 63 65 2e 0a 2a 2a 0a 2a 2a 20 4e 65  erface..**.** Ne
17090 77 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20  w configuration 
170a0 6f 70 74 69 6f 6e 73 20 6d 61 79 20 62 65 20 61  options may be a
170b0 64 64 65 64 20 69 6e 20 66 75 74 75 72 65 20 72  dded in future r
170c0 65 6c 65 61 73 65 73 20 6f 66 20 53 51 4c 69 74  eleases of SQLit
170d0 65 2e 0a 2a 2a 20 45 78 69 73 74 69 6e 67 20 63  e..** Existing c
170e0 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74  onfiguration opt
170f0 69 6f 6e 73 20 6d 69 67 68 74 20 62 65 20 64 69  ions might be di
17100 73 63 6f 6e 74 69 6e 75 65 64 2e 20 20 41 70 70  scontinued.  App
17110 6c 69 63 61 74 69 6f 6e 73 0a 2a 2a 20 73 68 6f  lications.** sho
17120 75 6c 64 20 63 68 65 63 6b 20 74 68 65 20 72 65  uld check the re
17130 74 75 72 6e 20 63 6f 64 65 20 66 72 6f 6d 20 5b  turn code from [
17140 73 71 6c 69 74 65 33 5f 64 62 5f 63 6f 6e 66 69  sqlite3_db_confi
17150 67 28 29 5d 20 74 6f 20 6d 61 6b 65 20 73 75 72  g()] to make sur
17160 65 20 74 68 61 74 0a 2a 2a 20 74 68 65 20 63 61  e that.** the ca
17170 6c 6c 20 77 6f 72 6b 65 64 2e 20 20 5e 54 68 65  ll worked.  ^The
17180 20 5b 73 71 6c 69 74 65 33 5f 64 62 5f 63 6f 6e   [sqlite3_db_con
17190 66 69 67 28 29 5d 20 69 6e 74 65 72 66 61 63 65  fig()] interface
171a0 20 77 69 6c 6c 20 72 65 74 75 72 6e 20 61 0a 2a   will return a.*
171b0 2a 20 6e 6f 6e 2d 7a 65 72 6f 20 5b 65 72 72 6f  * non-zero [erro
171c0 72 20 63 6f 64 65 5d 20 69 66 20 61 20 64 69 73  r code] if a dis
171d0 63 6f 6e 74 69 6e 75 65 64 20 6f 72 20 75 6e 73  continued or uns
171e0 75 70 70 6f 72 74 65 64 20 63 6f 6e 66 69 67 75  upported configu
171f0 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 0a 2a 2a  ration option.**
17200 20 69 73 20 69 6e 76 6f 6b 65 64 2e 0a 2a 2a 0a   is invoked..**.
17210 2a 2a 20 3c 64 6c 3e 0a 2a 2a 20 3c 64 74 3e 53  ** <dl>.** <dt>S
17220 51 4c 49 54 45 5f 44 42 43 4f 4e 46 49 47 5f 4c  QLITE_DBCONFIG_L
17230 4f 4f 4b 41 53 49 44 45 3c 2f 64 74 3e 0a 2a 2a  OOKASIDE</dt>.**
17240 20 3c 64 64 3e 20 5e 54 68 69 73 20 6f 70 74 69   <dd> ^This opti
17250 6f 6e 20 74 61 6b 65 73 20 74 68 72 65 65 20 61  on takes three a
17260 64 64 69 74 69 6f 6e 61 6c 20 61 72 67 75 6d 65  dditional argume
17270 6e 74 73 20 74 68 61 74 20 64 65 74 65 72 6d 69  nts that determi
17280 6e 65 20 74 68 65 20 0a 2a 2a 20 5b 6c 6f 6f 6b  ne the .** [look
17290 61 73 69 64 65 20 6d 65 6d 6f 72 79 20 61 6c 6c  aside memory all
172a0 6f 63 61 74 6f 72 5d 20 63 6f 6e 66 69 67 75 72  ocator] configur
172b0 61 74 69 6f 6e 20 66 6f 72 20 74 68 65 20 5b 64  ation for the [d
172c0 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
172d0 6f 6e 5d 2e 0a 2a 2a 20 5e 54 68 65 20 66 69 72  on]..** ^The fir
172e0 73 74 20 61 72 67 75 6d 65 6e 74 20 28 74 68 65  st argument (the
172f0 20 74 68 69 72 64 20 70 61 72 61 6d 65 74 65 72   third parameter
17300 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 64 62 5f   to [sqlite3_db_
17310 63 6f 6e 66 69 67 28 29 5d 20 69 73 20 61 0a 2a  config()] is a.*
17320 2a 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20 6d  * pointer to a m
17330 65 6d 6f 72 79 20 62 75 66 66 65 72 20 74 6f 20  emory buffer to 
17340 75 73 65 20 66 6f 72 20 6c 6f 6f 6b 61 73 69 64  use for lookasid
17350 65 20 6d 65 6d 6f 72 79 2e 0a 2a 2a 20 5e 54 68  e memory..** ^Th
17360 65 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74  e first argument
17370 20 61 66 74 65 72 20 74 68 65 20 53 51 4c 49 54   after the SQLIT
17380 45 5f 44 42 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41  E_DBCONFIG_LOOKA
17390 53 49 44 45 20 76 65 72 62 0a 2a 2a 20 6d 61 79  SIDE verb.** may
173a0 20 62 65 20 4e 55 4c 4c 20 69 6e 20 77 68 69 63   be NULL in whic
173b0 68 20 63 61 73 65 20 53 51 4c 69 74 65 20 77 69  h case SQLite wi
173c0 6c 6c 20 61 6c 6c 6f 63 61 74 65 20 74 68 65 0a  ll allocate the.
173d0 2a 2a 20 6c 6f 6f 6b 61 73 69 64 65 20 62 75 66  ** lookaside buf
173e0 66 65 72 20 69 74 73 65 6c 66 20 75 73 69 6e 67  fer itself using
173f0 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63   [sqlite3_malloc
17400 28 29 5d 2e 20 5e 54 68 65 20 73 65 63 6f 6e 64  ()]. ^The second
17410 20 61 72 67 75 6d 65 6e 74 20 69 73 20 74 68 65   argument is the
17420 0a 2a 2a 20 73 69 7a 65 20 6f 66 20 65 61 63 68  .** size of each
17430 20 6c 6f 6f 6b 61 73 69 64 65 20 62 75 66 66 65   lookaside buffe
17440 72 20 73 6c 6f 74 2e 20 20 5e 54 68 65 20 74 68  r slot.  ^The th
17450 69 72 64 20 61 72 67 75 6d 65 6e 74 20 69 73 20  ird argument is 
17460 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 0a 2a 2a  the number of.**
17470 20 73 6c 6f 74 73 2e 20 20 54 68 65 20 73 69 7a   slots.  The siz
17480 65 20 6f 66 20 74 68 65 20 62 75 66 66 65 72 20  e of the buffer 
17490 69 6e 20 74 68 65 20 66 69 72 73 74 20 61 72 67  in the first arg
174a0 75 6d 65 6e 74 20 6d 75 73 74 20 62 65 20 67 72  ument must be gr
174b0 65 61 74 65 72 20 74 68 61 6e 0a 2a 2a 20 6f 72  eater than.** or
174c0 20 65 71 75 61 6c 20 74 6f 20 74 68 65 20 70 72   equal to the pr
174d0 6f 64 75 63 74 20 6f 66 20 74 68 65 20 73 65 63  oduct of the sec
174e0 6f 6e 64 20 61 6e 64 20 74 68 69 72 64 20 61 72  ond and third ar
174f0 67 75 6d 65 6e 74 73 2e 20 20 54 68 65 20 62 75  guments.  The bu
17500 66 66 65 72 0a 2a 2a 20 6d 75 73 74 20 62 65 20  ffer.** must be 
17510 61 6c 69 67 6e 65 64 20 74 6f 20 61 6e 20 38 2d  aligned to an 8-
17520 62 79 74 65 20 62 6f 75 6e 64 61 72 79 2e 20 20  byte boundary.  
17530 5e 49 66 20 74 68 65 20 73 65 63 6f 6e 64 20 61  ^If the second a
17540 72 67 75 6d 65 6e 74 20 74 6f 0a 2a 2a 20 53 51  rgument to.** SQ
17550 4c 49 54 45 5f 44 42 43 4f 4e 46 49 47 5f 4c 4f  LITE_DBCONFIG_LO
17560 4f 4b 41 53 49 44 45 20 69 73 20 6e 6f 74 20 61  OKASIDE is not a
17570 20 6d 75 6c 74 69 70 6c 65 20 6f 66 20 38 2c 20   multiple of 8, 
17580 69 74 20 69 73 20 69 6e 74 65 72 6e 61 6c 6c 79  it is internally
17590 0a 2a 2a 20 72 6f 75 6e 64 65 64 20 64 6f 77 6e  .** rounded down
175a0 20 74 6f 20 74 68 65 20 6e 65 78 74 20 73 6d 61   to the next sma
175b0 6c 6c 65 72 20 6d 75 6c 74 69 70 6c 65 20 6f 66  ller multiple of
175c0 20 38 2e 20 20 5e 28 54 68 65 20 6c 6f 6f 6b 61   8.  ^(The looka
175d0 73 69 64 65 20 6d 65 6d 6f 72 79 0a 2a 2a 20 63  side memory.** c
175e0 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 66 6f 72  onfiguration for
175f0 20 61 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e   a database conn
17600 65 63 74 69 6f 6e 20 63 61 6e 20 6f 6e 6c 79 20  ection can only 
17610 62 65 20 63 68 61 6e 67 65 64 20 77 68 65 6e 20  be changed when 
17620 74 68 61 74 0a 2a 2a 20 63 6f 6e 6e 65 63 74 69  that.** connecti
17630 6f 6e 20 69 73 20 6e 6f 74 20 63 75 72 72 65 6e  on is not curren
17640 74 6c 79 20 75 73 69 6e 67 20 6c 6f 6f 6b 61 73  tly using lookas
17650 69 64 65 20 6d 65 6d 6f 72 79 2c 20 6f 72 20 69  ide memory, or i
17660 6e 20 6f 74 68 65 72 20 77 6f 72 64 73 0a 2a 2a  n other words.**
17670 20 77 68 65 6e 20 74 68 65 20 22 63 75 72 72 65   when the "curre
17680 6e 74 20 76 61 6c 75 65 22 20 72 65 74 75 72 6e  nt value" return
17690 65 64 20 62 79 0a 2a 2a 20 5b 73 71 6c 69 74 65  ed by.** [sqlite
176a0 33 5f 64 62 5f 73 74 61 74 75 73 5d 28 44 2c 5b  3_db_status](D,[
176b0 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4c 4f  SQLITE_CONFIG_LO
176c0 4f 4b 41 53 49 44 45 5d 2c 2e 2e 2e 29 20 69 73  OKASIDE],...) is
176d0 20 7a 65 72 6f 2e 0a 2a 2a 20 41 6e 79 20 61 74   zero..** Any at
176e0 74 65 6d 70 74 20 74 6f 20 63 68 61 6e 67 65 20  tempt to change 
176f0 74 68 65 20 6c 6f 6f 6b 61 73 69 64 65 20 6d 65  the lookaside me
17700 6d 6f 72 79 20 63 6f 6e 66 69 67 75 72 61 74 69  mory configurati
17710 6f 6e 20 77 68 65 6e 20 6c 6f 6f 6b 61 73 69 64  on when lookasid
17720 65 0a 2a 2a 20 6d 65 6d 6f 72 79 20 69 73 20 69  e.** memory is i
17730 6e 20 75 73 65 20 6c 65 61 76 65 73 20 74 68 65  n use leaves the
17740 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 75   configuration u
17750 6e 63 68 61 6e 67 65 64 20 61 6e 64 20 72 65 74  nchanged and ret
17760 75 72 6e 73 20 0a 2a 2a 20 5b 53 51 4c 49 54 45  urns .** [SQLITE
17770 5f 42 55 53 59 5d 2e 29 5e 3c 2f 64 64 3e 0a 2a  _BUSY].)^</dd>.*
17780 2a 0a 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f  *.** <dt>SQLITE_
17790 44 42 43 4f 4e 46 49 47 5f 45 4e 41 42 4c 45 5f  DBCONFIG_ENABLE_
177a0 46 4b 45 59 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64  FKEY</dt>.** <dd
177b0 3e 20 5e 54 68 69 73 20 6f 70 74 69 6f 6e 20 69  > ^This option i
177c0 73 20 75 73 65 64 20 74 6f 20 65 6e 61 62 6c 65  s used to enable
177d0 20 6f 72 20 64 69 73 61 62 6c 65 20 74 68 65 20   or disable the 
177e0 65 6e 66 6f 72 63 65 6d 65 6e 74 20 6f 66 0a 2a  enforcement of.*
177f0 2a 20 5b 66 6f 72 65 69 67 6e 20 6b 65 79 20 63  * [foreign key c
17800 6f 6e 73 74 72 61 69 6e 74 73 5d 2e 20 20 54 68  onstraints].  Th
17810 65 72 65 20 73 68 6f 75 6c 64 20 62 65 20 74 77  ere should be tw
17820 6f 20 61 64 64 69 74 69 6f 6e 61 6c 20 61 72 67  o additional arg
17830 75 6d 65 6e 74 73 2e 0a 2a 2a 20 54 68 65 20 66  uments..** The f
17840 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 69 73  irst argument is
17850 20 61 6e 20 69 6e 74 65 67 65 72 20 77 68 69 63   an integer whic
17860 68 20 69 73 20 30 20 74 6f 20 64 69 73 61 62 6c  h is 0 to disabl
17870 65 20 46 4b 20 65 6e 66 6f 72 63 65 6d 65 6e 74  e FK enforcement
17880 2c 0a 2a 2a 20 70 6f 73 69 74 69 76 65 20 74 6f  ,.** positive to
17890 20 65 6e 61 62 6c 65 20 46 4b 20 65 6e 66 6f 72   enable FK enfor
178a0 63 65 6d 65 6e 74 20 6f 72 20 6e 65 67 61 74 69  cement or negati
178b0 76 65 20 74 6f 20 6c 65 61 76 65 20 46 4b 20 65  ve to leave FK e
178c0 6e 66 6f 72 63 65 6d 65 6e 74 0a 2a 2a 20 75 6e  nforcement.** un
178d0 63 68 61 6e 67 65 64 2e 20 20 54 68 65 20 73 65  changed.  The se
178e0 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20 69  cond parameter i
178f0 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61  s a pointer to a
17900 6e 20 69 6e 74 65 67 65 72 20 69 6e 74 6f 20 77  n integer into w
17910 68 69 63 68 0a 2a 2a 20 69 73 20 77 72 69 74 74  hich.** is writt
17920 65 6e 20 30 20 6f 72 20 31 20 74 6f 20 69 6e 64  en 0 or 1 to ind
17930 69 63 61 74 65 20 77 68 65 74 68 65 72 20 46 4b  icate whether FK
17940 20 65 6e 66 6f 72 63 65 6d 65 6e 74 20 69 73 20   enforcement is 
17950 6f 66 66 20 6f 72 20 6f 6e 0a 2a 2a 20 66 6f 6c  off or on.** fol
17960 6c 6f 77 69 6e 67 20 74 68 69 73 20 63 61 6c 6c  lowing this call
17970 2e 20 20 54 68 65 20 73 65 63 6f 6e 64 20 70 61  .  The second pa
17980 72 61 6d 65 74 65 72 20 6d 61 79 20 62 65 20 61  rameter may be a
17990 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2c 20 69   NULL pointer, i
179a0 6e 0a 2a 2a 20 77 68 69 63 68 20 63 61 73 65 20  n.** which case 
179b0 74 68 65 20 46 4b 20 65 6e 66 6f 72 63 65 6d 65  the FK enforceme
179c0 6e 74 20 73 65 74 74 69 6e 67 20 69 73 20 6e 6f  nt setting is no
179d0 74 20 72 65 70 6f 72 74 65 64 20 62 61 63 6b 2e  t reported back.
179e0 20 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 64 74   </dd>.**.** <dt
179f0 3e 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46 49 47  >SQLITE_DBCONFIG
17a00 5f 45 4e 41 42 4c 45 5f 54 52 49 47 47 45 52 3c  _ENABLE_TRIGGER<
17a10 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 54 68  /dt>.** <dd> ^Th
17a20 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 75 73 65  is option is use
17a30 64 20 74 6f 20 65 6e 61 62 6c 65 20 6f 72 20 64  d to enable or d
17a40 69 73 61 62 6c 65 20 5b 43 52 45 41 54 45 20 54  isable [CREATE T
17a50 52 49 47 47 45 52 20 7c 20 74 72 69 67 67 65 72  RIGGER | trigger
17a60 73 5d 2e 0a 2a 2a 20 54 68 65 72 65 20 73 68 6f  s]..** There sho
17a70 75 6c 64 20 62 65 20 74 77 6f 20 61 64 64 69 74  uld be two addit
17a80 69 6f 6e 61 6c 20 61 72 67 75 6d 65 6e 74 73 2e  ional arguments.
17a90 0a 2a 2a 20 54 68 65 20 66 69 72 73 74 20 61 72  .** The first ar
17aa0 67 75 6d 65 6e 74 20 69 73 20 61 6e 20 69 6e 74  gument is an int
17ab0 65 67 65 72 20 77 68 69 63 68 20 69 73 20 30 20  eger which is 0 
17ac0 74 6f 20 64 69 73 61 62 6c 65 20 74 72 69 67 67  to disable trigg
17ad0 65 72 73 2c 0a 2a 2a 20 70 6f 73 69 74 69 76 65  ers,.** positive
17ae0 20 74 6f 20 65 6e 61 62 6c 65 20 74 72 69 67 67   to enable trigg
17af0 65 72 73 20 6f 72 20 6e 65 67 61 74 69 76 65 20  ers or negative 
17b00 74 6f 20 6c 65 61 76 65 20 74 68 65 20 73 65 74  to leave the set
17b10 74 69 6e 67 20 75 6e 63 68 61 6e 67 65 64 2e 0a  ting unchanged..
17b20 2a 2a 20 54 68 65 20 73 65 63 6f 6e 64 20 70 61  ** The second pa
17b30 72 61 6d 65 74 65 72 20 69 73 20 61 20 70 6f 69  rameter is a poi
17b40 6e 74 65 72 20 74 6f 20 61 6e 20 69 6e 74 65 67  nter to an integ
17b50 65 72 20 69 6e 74 6f 20 77 68 69 63 68 0a 2a 2a  er into which.**
17b60 20 69 73 20 77 72 69 74 74 65 6e 20 30 20 6f 72   is written 0 or
17b70 20 31 20 74 6f 20 69 6e 64 69 63 61 74 65 20 77   1 to indicate w
17b80 68 65 74 68 65 72 20 74 72 69 67 67 65 72 73 20  hether triggers 
17b90 61 72 65 20 64 69 73 61 62 6c 65 64 20 6f 72 20  are disabled or 
17ba0 65 6e 61 62 6c 65 64 0a 2a 2a 20 66 6f 6c 6c 6f  enabled.** follo
17bb0 77 69 6e 67 20 74 68 69 73 20 63 61 6c 6c 2e 20  wing this call. 
17bc0 20 54 68 65 20 73 65 63 6f 6e 64 20 70 61 72 61   The second para
17bd0 6d 65 74 65 72 20 6d 61 79 20 62 65 20 61 20 4e  meter may be a N
17be0 55 4c 4c 20 70 6f 69 6e 74 65 72 2c 20 69 6e 0a  ULL pointer, in.
17bf0 2a 2a 20 77 68 69 63 68 20 63 61 73 65 20 74 68  ** which case th
17c00 65 20 74 72 69 67 67 65 72 20 73 65 74 74 69 6e  e trigger settin
17c10 67 20 69 73 20 6e 6f 74 20 72 65 70 6f 72 74 65  g is not reporte
17c20 64 20 62 61 63 6b 2e 20 3c 2f 64 64 3e 0a 2a 2a  d back. </dd>.**
17c30 0a 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f 44  .** <dt>SQLITE_D
17c40 42 43 4f 4e 46 49 47 5f 45 4e 41 42 4c 45 5f 46  BCONFIG_ENABLE_F
17c50 54 53 33 5f 54 4f 4b 45 4e 49 5a 45 52 3c 2f 64  TS3_TOKENIZER</d
17c60 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 54 68 69 73  t>.** <dd> ^This
17c70 20 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 20   option is used 
17c80 74 6f 20 65 6e 61 62 6c 65 20 6f 72 20 64 69 73  to enable or dis
17c90 61 62 6c 65 20 74 68 65 20 74 77 6f 2d 61 72 67  able the two-arg
17ca0 75 6d 65 6e 74 0a 2a 2a 20 76 65 72 73 69 6f 6e  ument.** version
17cb0 20 6f 66 20 74 68 65 20 5b 66 74 73 33 5f 74 6f   of the [fts3_to
17cc0 6b 65 6e 69 7a 65 72 28 29 5d 20 66 75 6e 63 74  kenizer()] funct
17cd0 69 6f 6e 20 77 68 69 63 68 20 69 73 20 70 61 72  ion which is par
17ce0 74 20 6f 66 20 74 68 65 0a 2a 2a 20 5b 46 54 53  t of the.** [FTS
17cf0 33 5d 20 66 75 6c 6c 2d 74 65 78 74 20 73 65 61  3] full-text sea
17d00 72 63 68 20 65 6e 67 69 6e 65 20 65 78 74 65 6e  rch engine exten
17d10 73 69 6f 6e 2e 0a 2a 2a 20 54 68 65 72 65 20 73  sion..** There s
17d20 68 6f 75 6c 64 20 62 65 20 74 77 6f 20 61 64 64  hould be two add
17d30 69 74 69 6f 6e 61 6c 20 61 72 67 75 6d 65 6e 74  itional argument
17d40 73 2e 0a 2a 2a 20 54 68 65 20 66 69 72 73 74 20  s..** The first 
17d50 61 72 67 75 6d 65 6e 74 20 69 73 20 61 6e 20 69  argument is an i
17d60 6e 74 65 67 65 72 20 77 68 69 63 68 20 69 73 20  nteger which is 
17d70 30 20 74 6f 20 64 69 73 61 62 6c 65 20 66 74 73  0 to disable fts
17d80 33 5f 74 6f 6b 65 6e 69 7a 65 72 28 29 20 6f 72  3_tokenizer() or
17d90 0a 2a 2a 20 70 6f 73 69 74 69 76 65 20 74 6f 20  .** positive to 
17da0 65 6e 61 62 6c 65 20 66 74 73 33 5f 74 6f 6b 65  enable fts3_toke
17db0 6e 69 7a 65 72 28 29 20 6f 72 20 6e 65 67 61 74  nizer() or negat
17dc0 69 76 65 20 74 6f 20 6c 65 61 76 65 20 74 68 65  ive to leave the
17dd0 20 73 65 74 74 69 6e 67 0a 2a 2a 20 75 6e 63 68   setting.** unch
17de0 61 6e 67 65 64 2e 0a 2a 2a 20 54 68 65 20 73 65  anged..** The se
17df0 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20 69  cond parameter i
17e00 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61  s a pointer to a
17e10 6e 20 69 6e 74 65 67 65 72 20 69 6e 74 6f 20 77  n integer into w
17e20 68 69 63 68 0a 2a 2a 20 69 73 20 77 72 69 74 74  hich.** is writt
17e30 65 6e 20 30 20 6f 72 20 31 20 74 6f 20 69 6e 64  en 0 or 1 to ind
17e40 69 63 61 74 65 20 77 68 65 74 68 65 72 20 66 74  icate whether ft
17e50 73 33 5f 74 6f 6b 65 6e 69 7a 65 72 20 69 73 20  s3_tokenizer is 
17e60 64 69 73 61 62 6c 65 64 20 6f 72 20 65 6e 61 62  disabled or enab
17e70 6c 65 64 0a 2a 2a 20 66 6f 6c 6c 6f 77 69 6e 67  led.** following
17e80 20 74 68 69 73 20 63 61 6c 6c 2e 20 20 54 68 65   this call.  The
17e90 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65   second paramete
17ea0 72 20 6d 61 79 20 62 65 20 61 20 4e 55 4c 4c 20  r may be a NULL 
17eb0 70 6f 69 6e 74 65 72 2c 20 69 6e 0a 2a 2a 20 77  pointer, in.** w
17ec0 68 69 63 68 20 63 61 73 65 20 74 68 65 20 6e 65  hich case the ne
17ed0 77 20 73 65 74 74 69 6e 67 20 69 73 20 6e 6f 74  w setting is not
17ee0 20 72 65 70 6f 72 74 65 64 20 62 61 63 6b 2e 20   reported back. 
17ef0 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 64 74 3e  </dd>.**.** <dt>
17f00 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46 49 47 5f  SQLITE_DBCONFIG_
17f10 45 4e 41 42 4c 45 5f 4c 4f 41 44 5f 45 58 54 45  ENABLE_LOAD_EXTE
17f20 4e 53 49 4f 4e 3c 2f 64 74 3e 0a 2a 2a 20 3c 64  NSION</dt>.** <d
17f30 64 3e 20 5e 54 68 69 73 20 6f 70 74 69 6f 6e 20  d> ^This option 
17f40 69 73 20 75 73 65 64 20 74 6f 20 65 6e 61 62 6c  is used to enabl
17f50 65 20 6f 72 20 64 69 73 61 62 6c 65 20 74 68 65  e or disable the
17f60 20 5b 73 71 6c 69 74 65 33 5f 6c 6f 61 64 5f 65   [sqlite3_load_e
17f70 78 74 65 6e 73 69 6f 6e 28 29 5d 0a 2a 2a 20 69  xtension()].** i
17f80 6e 74 65 72 66 61 63 65 20 69 6e 64 65 70 65 6e  nterface indepen
17f90 64 65 6e 74 6c 79 20 6f 66 20 74 68 65 20 5b 6c  dently of the [l
17fa0 6f 61 64 5f 65 78 74 65 6e 73 69 6f 6e 28 29 5d  oad_extension()]
17fb0 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 2e 0a 2a   SQL function..*
17fc0 2a 20 54 68 65 20 5b 73 71 6c 69 74 65 33 5f 65  * The [sqlite3_e
17fd0 6e 61 62 6c 65 5f 6c 6f 61 64 5f 65 78 74 65 6e  nable_load_exten
17fe0 73 69 6f 6e 28 29 5d 20 41 50 49 20 65 6e 61 62  sion()] API enab
17ff0 6c 65 73 20 6f 72 20 64 69 73 61 62 6c 65 73 20  les or disables 
18000 62 6f 74 68 20 74 68 65 0a 2a 2a 20 43 2d 41 50  both the.** C-AP
18010 49 20 5b 73 71 6c 69 74 65 33 5f 6c 6f 61 64 5f  I [sqlite3_load_
18020 65 78 74 65 6e 73 69 6f 6e 28 29 5d 20 61 6e 64  extension()] and
18030 20 74 68 65 20 53 51 4c 20 66 75 6e 63 74 69 6f   the SQL functio
18040 6e 20 5b 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f  n [load_extensio
18050 6e 28 29 5d 2e 0a 2a 2a 20 54 68 65 72 65 20 73  n()]..** There s
18060 68 6f 75 6c 64 20 62 65 20 74 77 6f 20 61 64 64  hould be two add
18070 69 74 69 6f 6e 61 6c 20 61 72 67 75 6d 65 6e 74  itional argument
18080 73 2e 0a 2a 2a 20 57 68 65 6e 20 74 68 65 20 66  s..** When the f
18090 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f  irst argument to
180a0 20 74 68 69 73 20 69 6e 74 65 72 66 61 63 65 20   this interface 
180b0 69 73 20 31 2c 20 74 68 65 6e 20 6f 6e 6c 79 20  is 1, then only 
180c0 74 68 65 20 43 2d 41 50 49 20 69 73 0a 2a 2a 20  the C-API is.** 
180d0 65 6e 61 62 6c 65 64 20 61 6e 64 20 74 68 65 20  enabled and the 
180e0 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 72 65 6d  SQL function rem
180f0 61 69 6e 73 20 64 69 73 61 62 6c 65 64 2e 20 20  ains disabled.  
18100 49 66 20 74 68 65 20 66 69 72 73 74 20 61 72 67  If the first arg
18110 6d 65 6e 74 20 74 6f 0a 2a 2a 20 74 68 69 73 20  ment to.** this 
18120 69 6e 74 65 72 66 61 63 65 20 69 73 20 30 2c 20  interface is 0, 
18130 74 68 65 6e 20 62 6f 74 68 20 74 68 65 20 43 2d  then both the C-
18140 41 50 49 20 61 6e 64 20 74 68 65 20 53 51 4c 20  API and the SQL 
18150 66 75 6e 63 74 69 6f 6e 20 61 72 65 20 64 69 73  function are dis
18160 61 62 6c 65 64 2e 0a 2a 2a 20 49 66 20 74 68 65  abled..** If the
18170 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20   first argument 
18180 69 73 20 2d 31 2c 20 74 68 65 6e 20 6e 6f 20 63  is -1, then no c
18190 68 61 6e 67 65 73 20 61 72 65 20 6d 61 64 65 20  hanges are made 
181a0 74 6f 20 73 74 61 74 65 20 6f 66 20 65 69 74 68  to state of eith
181b0 65 72 20 74 68 65 0a 2a 2a 20 43 2d 41 50 49 20  er the.** C-API 
181c0 6f 72 20 74 68 65 20 53 51 4c 20 66 75 6e 63 74  or the SQL funct
181d0 69 6f 6e 2e 0a 2a 2a 20 54 68 65 20 73 65 63 6f  ion..** The seco
181e0 6e 64 20 70 61 72 61 6d 65 74 65 72 20 69 73 20  nd parameter is 
181f0 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20  a pointer to an 
18200 69 6e 74 65 67 65 72 20 69 6e 74 6f 20 77 68 69  integer into whi
18210 63 68 0a 2a 2a 20 69 73 20 77 72 69 74 74 65 6e  ch.** is written
18220 20 30 20 6f 72 20 31 20 74 6f 20 69 6e 64 69 63   0 or 1 to indic
18230 61 74 65 20 77 68 65 74 68 65 72 20 5b 73 71 6c  ate whether [sql
18240 69 74 65 33 5f 6c 6f 61 64 5f 65 78 74 65 6e 73  ite3_load_extens
18250 69 6f 6e 28 29 5d 20 69 6e 74 65 72 66 61 63 65  ion()] interface
18260 0a 2a 2a 20 69 73 20 64 69 73 61 62 6c 65 64 20  .** is disabled 
18270 6f 72 20 65 6e 61 62 6c 65 64 20 66 6f 6c 6c 6f  or enabled follo
18280 77 69 6e 67 20 74 68 69 73 20 63 61 6c 6c 2e 20  wing this call. 
18290 20 54 68 65 20 73 65 63 6f 6e 64 20 70 61 72 61   The second para
182a0 6d 65 74 65 72 20 6d 61 79 0a 2a 2a 20 62 65 20  meter may.** be 
182b0 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2c 20  a NULL pointer, 
182c0 69 6e 20 77 68 69 63 68 20 63 61 73 65 20 74 68  in which case th
182d0 65 20 6e 65 77 20 73 65 74 74 69 6e 67 20 69 73  e new setting is
182e0 20 6e 6f 74 20 72 65 70 6f 72 74 65 64 20 62 61   not reported ba
182f0 63 6b 2e 0a 2a 2a 20 3c 2f 64 64 3e 0a 2a 2a 0a  ck..** </dd>.**.
18300 2a 2a 20 3c 2f 64 6c 3e 0a 2a 2f 0a 23 64 65 66  ** </dl>.*/.#def
18310 69 6e 65 20 53 51 4c 49 54 45 5f 44 42 43 4f 4e  ine SQLITE_DBCON
18320 46 49 47 5f 4c 4f 4f 4b 41 53 49 44 45 20 20 20  FIG_LOOKASIDE   
18330 20 20 20 20 20 20 20 20 20 20 31 30 30 31 20 2f            1001 /
18340 2a 20 76 6f 69 64 2a 20 69 6e 74 20 69 6e 74 20  * void* int int 
18350 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
18360 45 5f 44 42 43 4f 4e 46 49 47 5f 45 4e 41 42 4c  E_DBCONFIG_ENABL
18370 45 5f 46 4b 45 59 20 20 20 20 20 20 20 20 20 20  E_FKEY          
18380 20 31 30 30 32 20 2f 2a 20 69 6e 74 20 69 6e 74   1002 /* int int
18390 2a 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  * */.#define SQL
183a0 49 54 45 5f 44 42 43 4f 4e 46 49 47 5f 45 4e 41  ITE_DBCONFIG_ENA
183b0 42 4c 45 5f 54 52 49 47 47 45 52 20 20 20 20 20  BLE_TRIGGER     
183c0 20 20 20 31 30 30 33 20 2f 2a 20 69 6e 74 20 69     1003 /* int i
183d0 6e 74 2a 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  nt* */.#define S
183e0 51 4c 49 54 45 5f 44 42 43 4f 4e 46 49 47 5f 45  QLITE_DBCONFIG_E
183f0 4e 41 42 4c 45 5f 46 54 53 33 5f 54 4f 4b 45 4e  NABLE_FTS3_TOKEN
18400 49 5a 45 52 20 31 30 30 34 20 2f 2a 20 69 6e 74  IZER 1004 /* int
18410 20 69 6e 74 2a 20 2a 2f 0a 23 64 65 66 69 6e 65   int* */.#define
18420 20 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46 49 47   SQLITE_DBCONFIG
18430 5f 45 4e 41 42 4c 45 5f 4c 4f 41 44 5f 45 58 54  _ENABLE_LOAD_EXT
18440 45 4e 53 49 4f 4e 20 31 30 30 35 20 2f 2a 20 69  ENSION 1005 /* i
18450 6e 74 20 69 6e 74 2a 20 2a 2f 0a 0a 0a 2f 2a 0a  nt int* */.../*.
18460 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 45 6e 61  ** CAPI3REF: Ena
18470 62 6c 65 20 4f 72 20 44 69 73 61 62 6c 65 20 45  ble Or Disable E
18480 78 74 65 6e 64 65 64 20 52 65 73 75 6c 74 20 43  xtended Result C
18490 6f 64 65 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20  odes.** METHOD: 
184a0 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 54  sqlite3.**.** ^T
184b0 68 65 20 73 71 6c 69 74 65 33 5f 65 78 74 65 6e  he sqlite3_exten
184c0 64 65 64 5f 72 65 73 75 6c 74 5f 63 6f 64 65 73  ded_result_codes
184d0 28 29 20 72 6f 75 74 69 6e 65 20 65 6e 61 62 6c  () routine enabl
184e0 65 73 20 6f 72 20 64 69 73 61 62 6c 65 73 20 74  es or disables t
184f0 68 65 0a 2a 2a 20 5b 65 78 74 65 6e 64 65 64 20  he.** [extended 
18500 72 65 73 75 6c 74 20 63 6f 64 65 73 5d 20 66 65  result codes] fe
18510 61 74 75 72 65 20 6f 66 20 53 51 4c 69 74 65 2e  ature of SQLite.
18520 20 5e 54 68 65 20 65 78 74 65 6e 64 65 64 20 72   ^The extended r
18530 65 73 75 6c 74 0a 2a 2a 20 63 6f 64 65 73 20 61  esult.** codes a
18540 72 65 20 64 69 73 61 62 6c 65 64 20 62 79 20 64  re disabled by d
18550 65 66 61 75 6c 74 20 66 6f 72 20 68 69 73 74 6f  efault for histo
18560 72 69 63 61 6c 20 63 6f 6d 70 61 74 69 62 69 6c  rical compatibil
18570 69 74 79 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69  ity..*/.int sqli
18580 74 65 33 5f 65 78 74 65 6e 64 65 64 5f 72 65 73  te3_extended_res
18590 75 6c 74 5f 63 6f 64 65 73 28 73 71 6c 69 74 65  ult_codes(sqlite
185a0 33 2a 2c 20 69 6e 74 20 6f 6e 6f 66 66 29 3b 0a  3*, int onoff);.
185b0 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
185c0 20 4c 61 73 74 20 49 6e 73 65 72 74 20 52 6f 77   Last Insert Row
185d0 69 64 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  id.** METHOD: sq
185e0 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 45 61 63  lite3.**.** ^Eac
185f0 68 20 65 6e 74 72 79 20 69 6e 20 6d 6f 73 74 20  h entry in most 
18600 53 51 4c 69 74 65 20 74 61 62 6c 65 73 20 28 65  SQLite tables (e
18610 78 63 65 70 74 20 66 6f 72 20 5b 57 49 54 48 4f  xcept for [WITHO
18620 55 54 20 52 4f 57 49 44 5d 20 74 61 62 6c 65 73  UT ROWID] tables
18630 29 0a 2a 2a 20 68 61 73 20 61 20 75 6e 69 71 75  ).** has a uniqu
18640 65 20 36 34 2d 62 69 74 20 73 69 67 6e 65 64 0a  e 64-bit signed.
18650 2a 2a 20 69 6e 74 65 67 65 72 20 6b 65 79 20 63  ** integer key c
18660 61 6c 6c 65 64 20 74 68 65 20 5b 52 4f 57 49 44  alled the [ROWID
18670 20 7c 20 22 72 6f 77 69 64 22 5d 2e 20 5e 54 68   | "rowid"]. ^Th
18680 65 20 72 6f 77 69 64 20 69 73 20 61 6c 77 61 79  e rowid is alway
18690 73 20 61 76 61 69 6c 61 62 6c 65 0a 2a 2a 20 61  s available.** a
186a0 73 20 61 6e 20 75 6e 64 65 63 6c 61 72 65 64 20  s an undeclared 
186b0 63 6f 6c 75 6d 6e 20 6e 61 6d 65 64 20 52 4f 57  column named ROW
186c0 49 44 2c 20 4f 49 44 2c 20 6f 72 20 5f 52 4f 57  ID, OID, or _ROW
186d0 49 44 5f 20 61 73 20 6c 6f 6e 67 20 61 73 20 74  ID_ as long as t
186e0 68 6f 73 65 0a 2a 2a 20 6e 61 6d 65 73 20 61 72  hose.** names ar
186f0 65 20 6e 6f 74 20 61 6c 73 6f 20 75 73 65 64 20  e not also used 
18700 62 79 20 65 78 70 6c 69 63 69 74 6c 79 20 64 65  by explicitly de
18710 63 6c 61 72 65 64 20 63 6f 6c 75 6d 6e 73 2e 20  clared columns. 
18720 5e 49 66 0a 2a 2a 20 74 68 65 20 74 61 62 6c 65  ^If.** the table
18730 20 68 61 73 20 61 20 63 6f 6c 75 6d 6e 20 6f 66   has a column of
18740 20 74 79 70 65 20 5b 49 4e 54 45 47 45 52 20 50   type [INTEGER P
18750 52 49 4d 41 52 59 20 4b 45 59 5d 20 74 68 65 6e  RIMARY KEY] then
18760 20 74 68 61 74 20 63 6f 6c 75 6d 6e 0a 2a 2a 20   that column.** 
18770 69 73 20 61 6e 6f 74 68 65 72 20 61 6c 69 61 73  is another alias
18780 20 66 6f 72 20 74 68 65 20 72 6f 77 69 64 2e 0a   for the rowid..
18790 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  **.** ^The sqlit
187a0 65 33 5f 6c 61 73 74 5f 69 6e 73 65 72 74 5f 72  e3_last_insert_r
187b0 6f 77 69 64 28 44 29 20 69 6e 74 65 72 66 61 63  owid(D) interfac
187c0 65 20 72 65 74 75 72 6e 73 20 74 68 65 20 5b 72  e returns the [r
187d0 6f 77 69 64 5d 20 6f 66 20 74 68 65 20 0a 2a 2a  owid] of the .**
187e0 20 6d 6f 73 74 20 72 65 63 65 6e 74 20 73 75 63   most recent suc
187f0 63 65 73 73 66 75 6c 20 5b 49 4e 53 45 52 54 5d  cessful [INSERT]
18800 20 69 6e 74 6f 20 61 20 72 6f 77 69 64 20 74 61   into a rowid ta
18810 62 6c 65 20 6f 72 20 5b 76 69 72 74 75 61 6c 20  ble or [virtual 
18820 74 61 62 6c 65 5d 0a 2a 2a 20 6f 6e 20 64 61 74  table].** on dat
18830 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
18840 20 44 2e 0a 2a 2a 20 5e 49 6e 73 65 72 74 73 20   D..** ^Inserts 
18850 69 6e 74 6f 20 5b 57 49 54 48 4f 55 54 20 52 4f  into [WITHOUT RO
18860 57 49 44 5d 20 74 61 62 6c 65 73 20 61 72 65 20  WID] tables are 
18870 6e 6f 74 20 72 65 63 6f 72 64 65 64 2e 0a 2a 2a  not recorded..**
18880 20 5e 49 66 20 6e 6f 20 73 75 63 63 65 73 73 66   ^If no successf
18890 75 6c 20 5b 49 4e 53 45 52 54 5d 73 20 69 6e 74  ul [INSERT]s int
188a0 6f 20 72 6f 77 69 64 20 74 61 62 6c 65 73 0a 2a  o rowid tables.*
188b0 2a 20 68 61 76 65 20 65 76 65 72 20 6f 63 63 75  * have ever occu
188c0 72 72 65 64 20 6f 6e 20 74 68 65 20 64 61 74 61  rred on the data
188d0 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20  base connection 
188e0 44 2c 20 0a 2a 2a 20 74 68 65 6e 20 73 71 6c 69  D, .** then sqli
188f0 74 65 33 5f 6c 61 73 74 5f 69 6e 73 65 72 74 5f  te3_last_insert_
18900 72 6f 77 69 64 28 44 29 20 72 65 74 75 72 6e 73  rowid(D) returns
18910 20 7a 65 72 6f 2e 0a 2a 2a 0a 2a 2a 20 5e 28 49   zero..**.** ^(I
18920 66 20 61 6e 20 5b 49 4e 53 45 52 54 5d 20 6f 63  f an [INSERT] oc
18930 63 75 72 73 20 77 69 74 68 69 6e 20 61 20 74 72  curs within a tr
18940 69 67 67 65 72 20 6f 72 20 77 69 74 68 69 6e 20  igger or within 
18950 61 20 5b 76 69 72 74 75 61 6c 20 74 61 62 6c 65  a [virtual table
18960 5d 0a 2a 2a 20 6d 65 74 68 6f 64 2c 20 74 68 65  ].** method, the
18970 6e 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 77  n this routine w
18980 69 6c 6c 20 72 65 74 75 72 6e 20 74 68 65 20 5b  ill return the [
18990 72 6f 77 69 64 5d 20 6f 66 20 74 68 65 20 69 6e  rowid] of the in
189a0 73 65 72 74 65 64 0a 2a 2a 20 72 6f 77 20 61 73  serted.** row as
189b0 20 6c 6f 6e 67 20 61 73 20 74 68 65 20 74 72 69   long as the tri
189c0 67 67 65 72 20 6f 72 20 76 69 72 74 75 61 6c 20  gger or virtual 
189d0 74 61 62 6c 65 20 6d 65 74 68 6f 64 20 69 73 20  table method is 
189e0 72 75 6e 6e 69 6e 67 2e 0a 2a 2a 20 42 75 74 20  running..** But 
189f0 6f 6e 63 65 20 74 68 65 20 74 72 69 67 67 65 72  once the trigger
18a00 20 6f 72 20 76 69 72 74 75 61 6c 20 74 61 62 6c   or virtual tabl
18a10 65 20 6d 65 74 68 6f 64 20 65 6e 64 73 2c 20 74  e method ends, t
18a20 68 65 20 76 61 6c 75 65 20 72 65 74 75 72 6e 65  he value returne
18a30 64 20 0a 2a 2a 20 62 79 20 74 68 69 73 20 72 6f  d .** by this ro
18a40 75 74 69 6e 65 20 72 65 76 65 72 74 73 20 74 6f  utine reverts to
18a50 20 77 68 61 74 20 69 74 20 77 61 73 20 62 65 66   what it was bef
18a60 6f 72 65 20 74 68 65 20 74 72 69 67 67 65 72 20  ore the trigger 
18a70 6f 72 20 76 69 72 74 75 61 6c 0a 2a 2a 20 74 61  or virtual.** ta
18a80 62 6c 65 20 6d 65 74 68 6f 64 20 62 65 67 61 6e  ble method began
18a90 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 41 6e 20 5b 49  .)^.**.** ^An [I
18aa0 4e 53 45 52 54 5d 20 74 68 61 74 20 66 61 69 6c  NSERT] that fail
18ab0 73 20 64 75 65 20 74 6f 20 61 20 63 6f 6e 73 74  s due to a const
18ac0 72 61 69 6e 74 20 76 69 6f 6c 61 74 69 6f 6e 20  raint violation 
18ad0 69 73 20 6e 6f 74 20 61 0a 2a 2a 20 73 75 63 63  is not a.** succ
18ae0 65 73 73 66 75 6c 20 5b 49 4e 53 45 52 54 5d 20  essful [INSERT] 
18af0 61 6e 64 20 64 6f 65 73 20 6e 6f 74 20 63 68 61  and does not cha
18b00 6e 67 65 20 74 68 65 20 76 61 6c 75 65 20 72 65  nge the value re
18b10 74 75 72 6e 65 64 20 62 79 20 74 68 69 73 0a 2a  turned by this.*
18b20 2a 20 72 6f 75 74 69 6e 65 2e 20 20 5e 54 68 75  * routine.  ^Thu
18b30 73 20 49 4e 53 45 52 54 20 4f 52 20 46 41 49 4c  s INSERT OR FAIL
18b40 2c 20 49 4e 53 45 52 54 20 4f 52 20 49 47 4e 4f  , INSERT OR IGNO
18b50 52 45 2c 20 49 4e 53 45 52 54 20 4f 52 20 52 4f  RE, INSERT OR RO
18b60 4c 4c 42 41 43 4b 2c 0a 2a 2a 20 61 6e 64 20 49  LLBACK,.** and I
18b70 4e 53 45 52 54 20 4f 52 20 41 42 4f 52 54 20 6d  NSERT OR ABORT m
18b80 61 6b 65 20 6e 6f 20 63 68 61 6e 67 65 73 20 74  ake no changes t
18b90 6f 20 74 68 65 20 72 65 74 75 72 6e 20 76 61 6c  o the return val
18ba0 75 65 20 6f 66 20 74 68 69 73 0a 2a 2a 20 72 6f  ue of this.** ro
18bb0 75 74 69 6e 65 20 77 68 65 6e 20 74 68 65 69 72  utine when their
18bc0 20 69 6e 73 65 72 74 69 6f 6e 20 66 61 69 6c 73   insertion fails
18bd0 2e 20 20 5e 28 57 68 65 6e 20 49 4e 53 45 52 54  .  ^(When INSERT
18be0 20 4f 52 20 52 45 50 4c 41 43 45 0a 2a 2a 20 65   OR REPLACE.** e
18bf0 6e 63 6f 75 6e 74 65 72 73 20 61 20 63 6f 6e 73  ncounters a cons
18c00 74 72 61 69 6e 74 20 76 69 6f 6c 61 74 69 6f 6e  traint violation
18c10 2c 20 69 74 20 64 6f 65 73 20 6e 6f 74 20 66 61  , it does not fa
18c20 69 6c 2e 20 20 54 68 65 0a 2a 2a 20 49 4e 53 45  il.  The.** INSE
18c30 52 54 20 63 6f 6e 74 69 6e 75 65 73 20 74 6f 20  RT continues to 
18c40 63 6f 6d 70 6c 65 74 69 6f 6e 20 61 66 74 65 72  completion after
18c50 20 64 65 6c 65 74 69 6e 67 20 72 6f 77 73 20 74   deleting rows t
18c60 68 61 74 20 63 61 75 73 65 64 0a 2a 2a 20 74 68  hat caused.** th
18c70 65 20 63 6f 6e 73 74 72 61 69 6e 74 20 70 72 6f  e constraint pro
18c80 62 6c 65 6d 20 73 6f 20 49 4e 53 45 52 54 20 4f  blem so INSERT O
18c90 52 20 52 45 50 4c 41 43 45 20 77 69 6c 6c 20 61  R REPLACE will a
18ca0 6c 77 61 79 73 20 63 68 61 6e 67 65 0a 2a 2a 20  lways change.** 
18cb0 74 68 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65  the return value
18cc0 20 6f 66 20 74 68 69 73 20 69 6e 74 65 72 66 61   of this interfa
18cd0 63 65 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 46 6f 72  ce.)^.**.** ^For
18ce0 20 74 68 65 20 70 75 72 70 6f 73 65 73 20 6f 66   the purposes of
18cf0 20 74 68 69 73 20 72 6f 75 74 69 6e 65 2c 20 61   this routine, a
18d00 6e 20 5b 49 4e 53 45 52 54 5d 20 69 73 20 63 6f  n [INSERT] is co
18d10 6e 73 69 64 65 72 65 64 20 74 6f 0a 2a 2a 20 62  nsidered to.** b
18d20 65 20 73 75 63 63 65 73 73 66 75 6c 20 65 76 65  e successful eve
18d30 6e 20 69 66 20 69 74 20 69 73 20 73 75 62 73 65  n if it is subse
18d40 71 75 65 6e 74 6c 79 20 72 6f 6c 6c 65 64 20 62  quently rolled b
18d50 61 63 6b 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20  ack..**.** This 
18d60 66 75 6e 63 74 69 6f 6e 20 69 73 20 61 63 63 65  function is acce
18d70 73 73 69 62 6c 65 20 74 6f 20 53 51 4c 20 73 74  ssible to SQL st
18d80 61 74 65 6d 65 6e 74 73 20 76 69 61 20 74 68 65  atements via the
18d90 0a 2a 2a 20 5b 6c 61 73 74 5f 69 6e 73 65 72 74  .** [last_insert
18da0 5f 72 6f 77 69 64 28 29 20 53 51 4c 20 66 75 6e  _rowid() SQL fun
18db0 63 74 69 6f 6e 5d 2e 0a 2a 2a 0a 2a 2a 20 49 66  ction]..**.** If
18dc0 20 61 20 73 65 70 61 72 61 74 65 20 74 68 72 65   a separate thre
18dd0 61 64 20 70 65 72 66 6f 72 6d 73 20 61 20 6e 65  ad performs a ne
18de0 77 20 5b 49 4e 53 45 52 54 5d 20 6f 6e 20 74 68  w [INSERT] on th
18df0 65 20 73 61 6d 65 0a 2a 2a 20 64 61 74 61 62 61  e same.** databa
18e00 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 77 68  se connection wh
18e10 69 6c 65 20 74 68 65 20 5b 73 71 6c 69 74 65 33  ile the [sqlite3
18e20 5f 6c 61 73 74 5f 69 6e 73 65 72 74 5f 72 6f 77  _last_insert_row
18e30 69 64 28 29 5d 0a 2a 2a 20 66 75 6e 63 74 69 6f  id()].** functio
18e40 6e 20 69 73 20 72 75 6e 6e 69 6e 67 20 61 6e 64  n is running and
18e50 20 74 68 75 73 20 63 68 61 6e 67 65 73 20 74 68   thus changes th
18e60 65 20 6c 61 73 74 20 69 6e 73 65 72 74 20 5b 72  e last insert [r
18e70 6f 77 69 64 5d 2c 0a 2a 2a 20 74 68 65 6e 20 74  owid],.** then t
18e80 68 65 20 76 61 6c 75 65 20 72 65 74 75 72 6e 65  he value returne
18e90 64 20 62 79 20 5b 73 71 6c 69 74 65 33 5f 6c 61  d by [sqlite3_la
18ea0 73 74 5f 69 6e 73 65 72 74 5f 72 6f 77 69 64 28  st_insert_rowid(
18eb0 29 5d 20 69 73 0a 2a 2a 20 75 6e 70 72 65 64 69  )] is.** unpredi
18ec0 63 74 61 62 6c 65 20 61 6e 64 20 6d 69 67 68 74  ctable and might
18ed0 20 6e 6f 74 20 65 71 75 61 6c 20 65 69 74 68 65   not equal eithe
18ee0 72 20 74 68 65 20 6f 6c 64 20 6f 72 20 74 68 65  r the old or the
18ef0 20 6e 65 77 0a 2a 2a 20 6c 61 73 74 20 69 6e 73   new.** last ins
18f00 65 72 74 20 5b 72 6f 77 69 64 5d 2e 0a 2a 2f 0a  ert [rowid]..*/.
18f10 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 20 73 71  sqlite3_int64 sq
18f20 6c 69 74 65 33 5f 6c 61 73 74 5f 69 6e 73 65 72  lite3_last_inser
18f30 74 5f 72 6f 77 69 64 28 73 71 6c 69 74 65 33 2a  t_rowid(sqlite3*
18f40 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
18f50 45 46 3a 20 43 6f 75 6e 74 20 54 68 65 20 4e 75  EF: Count The Nu
18f60 6d 62 65 72 20 4f 66 20 52 6f 77 73 20 4d 6f 64  mber Of Rows Mod
18f70 69 66 69 65 64 0a 2a 2a 20 4d 45 54 48 4f 44 3a  ified.** METHOD:
18f80 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e   sqlite3.**.** ^
18f90 54 68 69 73 20 66 75 6e 63 74 69 6f 6e 20 72 65  This function re
18fa0 74 75 72 6e 73 20 74 68 65 20 6e 75 6d 62 65 72  turns the number
18fb0 20 6f 66 20 72 6f 77 73 20 6d 6f 64 69 66 69 65   of rows modifie
18fc0 64 2c 20 69 6e 73 65 72 74 65 64 20 6f 72 0a 2a  d, inserted or.*
18fd0 2a 20 64 65 6c 65 74 65 64 20 62 79 20 74 68 65  * deleted by the
18fe0 20 6d 6f 73 74 20 72 65 63 65 6e 74 6c 79 20 63   most recently c
18ff0 6f 6d 70 6c 65 74 65 64 20 49 4e 53 45 52 54 2c  ompleted INSERT,
19000 20 55 50 44 41 54 45 20 6f 72 20 44 45 4c 45 54   UPDATE or DELET
19010 45 0a 2a 2a 20 73 74 61 74 65 6d 65 6e 74 20 6f  E.** statement o
19020 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63  n the database c
19030 6f 6e 6e 65 63 74 69 6f 6e 20 73 70 65 63 69 66  onnection specif
19040 69 65 64 20 62 79 20 74 68 65 20 6f 6e 6c 79 20  ied by the only 
19050 70 61 72 61 6d 65 74 65 72 2e 0a 2a 2a 20 5e 45  parameter..** ^E
19060 78 65 63 75 74 69 6e 67 20 61 6e 79 20 6f 74 68  xecuting any oth
19070 65 72 20 74 79 70 65 20 6f 66 20 53 51 4c 20 73  er type of SQL s
19080 74 61 74 65 6d 65 6e 74 20 64 6f 65 73 20 6e 6f  tatement does no
19090 74 20 6d 6f 64 69 66 79 20 74 68 65 20 76 61 6c  t modify the val
190a0 75 65 0a 2a 2a 20 72 65 74 75 72 6e 65 64 20 62  ue.** returned b
190b0 79 20 74 68 69 73 20 66 75 6e 63 74 69 6f 6e 2e  y this function.
190c0 0a 2a 2a 0a 2a 2a 20 5e 4f 6e 6c 79 20 63 68 61  .**.** ^Only cha
190d0 6e 67 65 73 20 6d 61 64 65 20 64 69 72 65 63 74  nges made direct
190e0 6c 79 20 62 79 20 74 68 65 20 49 4e 53 45 52 54  ly by the INSERT
190f0 2c 20 55 50 44 41 54 45 20 6f 72 20 44 45 4c 45  , UPDATE or DELE
19100 54 45 20 73 74 61 74 65 6d 65 6e 74 20 61 72 65  TE statement are
19110 0a 2a 2a 20 63 6f 6e 73 69 64 65 72 65 64 20 2d  .** considered -
19120 20 61 75 78 69 6c 69 61 72 79 20 63 68 61 6e 67   auxiliary chang
19130 65 73 20 63 61 75 73 65 64 20 62 79 20 5b 43 52  es caused by [CR
19140 45 41 54 45 20 54 52 49 47 47 45 52 20 7c 20 74  EATE TRIGGER | t
19150 72 69 67 67 65 72 73 5d 2c 20 0a 2a 2a 20 5b 66  riggers], .** [f
19160 6f 72 65 69 67 6e 20 6b 65 79 20 61 63 74 69 6f  oreign key actio
19170 6e 73 5d 20 6f 72 20 5b 52 45 50 4c 41 43 45 5d  ns] or [REPLACE]
19180 20 63 6f 6e 73 74 72 61 69 6e 74 20 72 65 73 6f   constraint reso
19190 6c 75 74 69 6f 6e 20 61 72 65 20 6e 6f 74 20 63  lution are not c
191a0 6f 75 6e 74 65 64 2e 0a 2a 2a 20 0a 2a 2a 20 43  ounted..** .** C
191b0 68 61 6e 67 65 73 20 74 6f 20 61 20 76 69 65 77  hanges to a view
191c0 20 74 68 61 74 20 61 72 65 20 69 6e 74 65 72 63   that are interc
191d0 65 70 74 65 64 20 62 79 20 0a 2a 2a 20 5b 49 4e  epted by .** [IN
191e0 53 54 45 41 44 20 4f 46 20 74 72 69 67 67 65 72  STEAD OF trigger
191f0 20 7c 20 49 4e 53 54 45 41 44 20 4f 46 20 74 72   | INSTEAD OF tr
19200 69 67 67 65 72 73 5d 20 61 72 65 20 6e 6f 74 20  iggers] are not 
19210 63 6f 75 6e 74 65 64 2e 20 5e 54 68 65 20 76 61  counted. ^The va
19220 6c 75 65 20 0a 2a 2a 20 72 65 74 75 72 6e 65 64  lue .** returned
19230 20 62 79 20 73 71 6c 69 74 65 33 5f 63 68 61 6e   by sqlite3_chan
19240 67 65 73 28 29 20 69 6d 6d 65 64 69 61 74 65 6c  ges() immediatel
19250 79 20 61 66 74 65 72 20 61 6e 20 49 4e 53 45 52  y after an INSER
19260 54 2c 20 55 50 44 41 54 45 20 6f 72 20 0a 2a 2a  T, UPDATE or .**
19270 20 44 45 4c 45 54 45 20 73 74 61 74 65 6d 65 6e   DELETE statemen
19280 74 20 72 75 6e 20 6f 6e 20 61 20 76 69 65 77 20  t run on a view 
19290 69 73 20 61 6c 77 61 79 73 20 7a 65 72 6f 2e 20  is always zero. 
192a0 4f 6e 6c 79 20 63 68 61 6e 67 65 73 20 6d 61 64  Only changes mad
192b0 65 20 74 6f 20 72 65 61 6c 20 0a 2a 2a 20 74 61  e to real .** ta
192c0 62 6c 65 73 20 61 72 65 20 63 6f 75 6e 74 65 64  bles are counted
192d0 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 6e 67 73 20 61  ..**.** Things a
192e0 72 65 20 6d 6f 72 65 20 63 6f 6d 70 6c 69 63 61  re more complica
192f0 74 65 64 20 69 66 20 74 68 65 20 73 71 6c 69 74  ted if the sqlit
19300 65 33 5f 63 68 61 6e 67 65 73 28 29 20 66 75 6e  e3_changes() fun
19310 63 74 69 6f 6e 20 69 73 0a 2a 2a 20 65 78 65 63  ction is.** exec
19320 75 74 65 64 20 77 68 69 6c 65 20 61 20 74 72 69  uted while a tri
19330 67 67 65 72 20 70 72 6f 67 72 61 6d 20 69 73 20  gger program is 
19340 72 75 6e 6e 69 6e 67 2e 20 54 68 69 73 20 6d 61  running. This ma
19350 79 20 68 61 70 70 65 6e 20 69 66 20 74 68 65 0a  y happen if the.
19360 2a 2a 20 70 72 6f 67 72 61 6d 20 75 73 65 73 20  ** program uses 
19370 74 68 65 20 5b 63 68 61 6e 67 65 73 28 29 20 53  the [changes() S
19380 51 4c 20 66 75 6e 63 74 69 6f 6e 5d 2c 20 6f 72  QL function], or
19390 20 69 66 20 73 6f 6d 65 20 6f 74 68 65 72 20 63   if some other c
193a0 61 6c 6c 62 61 63 6b 0a 2a 2a 20 66 75 6e 63 74  allback.** funct
193b0 69 6f 6e 20 69 6e 76 6f 6b 65 73 20 73 71 6c 69  ion invokes sqli
193c0 74 65 33 5f 63 68 61 6e 67 65 73 28 29 20 64 69  te3_changes() di
193d0 72 65 63 74 6c 79 2e 20 45 73 73 65 6e 74 69 61  rectly. Essentia
193e0 6c 6c 79 3a 0a 2a 2a 20 0a 2a 2a 20 3c 75 6c 3e  lly:.** .** <ul>
193f0 0a 2a 2a 20 20 20 3c 6c 69 3e 20 5e 28 42 65 66  .**   <li> ^(Bef
19400 6f 72 65 20 65 6e 74 65 72 69 6e 67 20 61 20 74  ore entering a t
19410 72 69 67 67 65 72 20 70 72 6f 67 72 61 6d 20 74  rigger program t
19420 68 65 20 76 61 6c 75 65 20 72 65 74 75 72 6e 65  he value returne
19430 64 20 62 79 0a 2a 2a 20 20 20 20 20 20 20 20 73  d by.**        s
19440 71 6c 69 74 65 33 5f 63 68 61 6e 67 65 73 28 29  qlite3_changes()
19450 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 73 61 76   function is sav
19460 65 64 2e 20 41 66 74 65 72 20 74 68 65 20 74 72  ed. After the tr
19470 69 67 67 65 72 20 70 72 6f 67 72 61 6d 20 0a 2a  igger program .*
19480 2a 20 20 20 20 20 20 20 20 68 61 73 20 66 69 6e  *        has fin
19490 69 73 68 65 64 2c 20 74 68 65 20 6f 72 69 67 69  ished, the origi
194a0 6e 61 6c 20 76 61 6c 75 65 20 69 73 20 72 65 73  nal value is res
194b0 74 6f 72 65 64 2e 29 5e 0a 2a 2a 20 0a 2a 2a 20  tored.)^.** .** 
194c0 20 20 3c 6c 69 3e 20 5e 28 57 69 74 68 69 6e 20    <li> ^(Within 
194d0 61 20 74 72 69 67 67 65 72 20 70 72 6f 67 72 61  a trigger progra
194e0 6d 20 65 61 63 68 20 49 4e 53 45 52 54 2c 20 55  m each INSERT, U
194f0 50 44 41 54 45 20 61 6e 64 20 44 45 4c 45 54 45  PDATE and DELETE
19500 20 0a 2a 2a 20 20 20 20 20 20 20 20 73 74 61 74   .**        stat
19510 65 6d 65 6e 74 20 73 65 74 73 20 74 68 65 20 76  ement sets the v
19520 61 6c 75 65 20 72 65 74 75 72 6e 65 64 20 62 79  alue returned by
19530 20 73 71 6c 69 74 65 33 5f 63 68 61 6e 67 65 73   sqlite3_changes
19540 28 29 20 0a 2a 2a 20 20 20 20 20 20 20 20 75 70  () .**        up
19550 6f 6e 20 63 6f 6d 70 6c 65 74 69 6f 6e 20 61 73  on completion as
19560 20 6e 6f 72 6d 61 6c 2e 20 4f 66 20 63 6f 75 72   normal. Of cour
19570 73 65 2c 20 74 68 69 73 20 76 61 6c 75 65 20 77  se, this value w
19580 69 6c 6c 20 6e 6f 74 20 69 6e 63 6c 75 64 65 20  ill not include 
19590 0a 2a 2a 20 20 20 20 20 20 20 20 61 6e 79 20 63  .**        any c
195a0 68 61 6e 67 65 73 20 70 65 72 66 6f 72 6d 65 64  hanges performed
195b0 20 62 79 20 73 75 62 2d 74 72 69 67 67 65 72 73   by sub-triggers
195c0 2c 20 61 73 20 74 68 65 20 73 71 6c 69 74 65 33  , as the sqlite3
195d0 5f 63 68 61 6e 67 65 73 28 29 20 0a 2a 2a 20 20  _changes() .**  
195e0 20 20 20 20 20 20 76 61 6c 75 65 20 77 69 6c 6c        value will
195f0 20 62 65 20 73 61 76 65 64 20 61 6e 64 20 72 65   be saved and re
19600 73 74 6f 72 65 64 20 61 66 74 65 72 20 65 61 63  stored after eac
19610 68 20 73 75 62 2d 74 72 69 67 67 65 72 20 68 61  h sub-trigger ha
19620 73 20 72 75 6e 2e 29 5e 0a 2a 2a 20 3c 2f 75 6c  s run.)^.** </ul
19630 3e 0a 2a 2a 20 0a 2a 2a 20 5e 54 68 69 73 20 6d  >.** .** ^This m
19640 65 61 6e 73 20 74 68 61 74 20 69 66 20 74 68 65  eans that if the
19650 20 63 68 61 6e 67 65 73 28 29 20 53 51 4c 20 66   changes() SQL f
19660 75 6e 63 74 69 6f 6e 20 28 6f 72 20 73 69 6d 69  unction (or simi
19670 6c 61 72 29 20 69 73 20 75 73 65 64 0a 2a 2a 20  lar) is used.** 
19680 62 79 20 74 68 65 20 66 69 72 73 74 20 49 4e 53  by the first INS
19690 45 52 54 2c 20 55 50 44 41 54 45 20 6f 72 20 44  ERT, UPDATE or D
196a0 45 4c 45 54 45 20 73 74 61 74 65 6d 65 6e 74 20  ELETE statement 
196b0 77 69 74 68 69 6e 20 61 20 74 72 69 67 67 65 72  within a trigger
196c0 2c 20 69 74 20 0a 2a 2a 20 72 65 74 75 72 6e 73  , it .** returns
196d0 20 74 68 65 20 76 61 6c 75 65 20 61 73 20 73 65   the value as se
196e0 74 20 77 68 65 6e 20 74 68 65 20 63 61 6c 6c 69  t when the calli
196f0 6e 67 20 73 74 61 74 65 6d 65 6e 74 20 62 65 67  ng statement beg
19700 61 6e 20 65 78 65 63 75 74 69 6e 67 2e 0a 2a 2a  an executing..**
19710 20 5e 49 66 20 69 74 20 69 73 20 75 73 65 64 20   ^If it is used 
19720 62 79 20 74 68 65 20 73 65 63 6f 6e 64 20 6f 72  by the second or
19730 20 73 75 62 73 65 71 75 65 6e 74 20 73 75 63 68   subsequent such
19740 20 73 74 61 74 65 6d 65 6e 74 20 77 69 74 68 69   statement withi
19750 6e 20 61 20 74 72 69 67 67 65 72 20 0a 2a 2a 20  n a trigger .** 
19760 70 72 6f 67 72 61 6d 2c 20 74 68 65 20 76 61 6c  program, the val
19770 75 65 20 72 65 74 75 72 6e 65 64 20 72 65 66 6c  ue returned refl
19780 65 63 74 73 20 74 68 65 20 6e 75 6d 62 65 72 20  ects the number 
19790 6f 66 20 72 6f 77 73 20 6d 6f 64 69 66 69 65 64  of rows modified
197a0 20 62 79 20 74 68 65 20 0a 2a 2a 20 70 72 65 76   by the .** prev
197b0 69 6f 75 73 20 49 4e 53 45 52 54 2c 20 55 50 44  ious INSERT, UPD
197c0 41 54 45 20 6f 72 20 44 45 4c 45 54 45 20 73 74  ATE or DELETE st
197d0 61 74 65 6d 65 6e 74 20 77 69 74 68 69 6e 20 74  atement within t
197e0 68 65 20 73 61 6d 65 20 74 72 69 67 67 65 72 2e  he same trigger.
197f0 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 20  .**.** See also 
19800 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 74 6f 74  the [sqlite3_tot
19810 61 6c 5f 63 68 61 6e 67 65 73 28 29 5d 20 69 6e  al_changes()] in
19820 74 65 72 66 61 63 65 2c 20 74 68 65 0a 2a 2a 20  terface, the.** 
19830 5b 63 6f 75 6e 74 5f 63 68 61 6e 67 65 73 20 70  [count_changes p
19840 72 61 67 6d 61 5d 2c 20 61 6e 64 20 74 68 65 20  ragma], and the 
19850 5b 63 68 61 6e 67 65 73 28 29 20 53 51 4c 20 66  [changes() SQL f
19860 75 6e 63 74 69 6f 6e 5d 2e 0a 2a 2a 0a 2a 2a 20  unction]..**.** 
19870 49 66 20 61 20 73 65 70 61 72 61 74 65 20 74 68  If a separate th
19880 72 65 61 64 20 6d 61 6b 65 73 20 63 68 61 6e 67  read makes chang
19890 65 73 20 6f 6e 20 74 68 65 20 73 61 6d 65 20 64  es on the same d
198a0 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
198b0 6f 6e 0a 2a 2a 20 77 68 69 6c 65 20 5b 73 71 6c  on.** while [sql
198c0 69 74 65 33 5f 63 68 61 6e 67 65 73 28 29 5d 20  ite3_changes()] 
198d0 69 73 20 72 75 6e 6e 69 6e 67 20 74 68 65 6e 20  is running then 
198e0 74 68 65 20 76 61 6c 75 65 20 72 65 74 75 72 6e  the value return
198f0 65 64 0a 2a 2a 20 69 73 20 75 6e 70 72 65 64 69  ed.** is unpredi
19900 63 74 61 62 6c 65 20 61 6e 64 20 6e 6f 74 20 6d  ctable and not m
19910 65 61 6e 69 6e 67 66 75 6c 2e 0a 2a 2f 0a 69 6e  eaningful..*/.in
19920 74 20 73 71 6c 69 74 65 33 5f 63 68 61 6e 67 65  t sqlite3_change
19930 73 28 73 71 6c 69 74 65 33 2a 29 3b 0a 0a 2f 2a  s(sqlite3*);../*
19940 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 54 6f  .** CAPI3REF: To
19950 74 61 6c 20 4e 75 6d 62 65 72 20 4f 66 20 52 6f  tal Number Of Ro
19960 77 73 20 4d 6f 64 69 66 69 65 64 0a 2a 2a 20 4d  ws Modified.** M
19970 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a  ETHOD: sqlite3.*
19980 2a 0a 2a 2a 20 5e 54 68 69 73 20 66 75 6e 63 74  *.** ^This funct
19990 69 6f 6e 20 72 65 74 75 72 6e 73 20 74 68 65 20  ion returns the 
199a0 74 6f 74 61 6c 20 6e 75 6d 62 65 72 20 6f 66 20  total number of 
199b0 72 6f 77 73 20 69 6e 73 65 72 74 65 64 2c 20 6d  rows inserted, m
199c0 6f 64 69 66 69 65 64 20 6f 72 0a 2a 2a 20 64 65  odified or.** de
199d0 6c 65 74 65 64 20 62 79 20 61 6c 6c 20 5b 49 4e  leted by all [IN
199e0 53 45 52 54 5d 2c 20 5b 55 50 44 41 54 45 5d 20  SERT], [UPDATE] 
199f0 6f 72 20 5b 44 45 4c 45 54 45 5d 20 73 74 61 74  or [DELETE] stat
19a00 65 6d 65 6e 74 73 20 63 6f 6d 70 6c 65 74 65 64  ements completed
19a10 0a 2a 2a 20 73 69 6e 63 65 20 74 68 65 20 64 61  .** since the da
19a20 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
19a30 6e 20 77 61 73 20 6f 70 65 6e 65 64 2c 20 69 6e  n was opened, in
19a40 63 6c 75 64 69 6e 67 20 74 68 6f 73 65 20 65 78  cluding those ex
19a50 65 63 75 74 65 64 20 61 73 0a 2a 2a 20 70 61 72  ecuted as.** par
19a60 74 20 6f 66 20 74 72 69 67 67 65 72 20 70 72 6f  t of trigger pro
19a70 67 72 61 6d 73 2e 20 5e 45 78 65 63 75 74 69 6e  grams. ^Executin
19a80 67 20 61 6e 79 20 6f 74 68 65 72 20 74 79 70 65  g any other type
19a90 20 6f 66 20 53 51 4c 20 73 74 61 74 65 6d 65 6e   of SQL statemen
19aa0 74 0a 2a 2a 20 64 6f 65 73 20 6e 6f 74 20 61 66  t.** does not af
19ab0 66 65 63 74 20 74 68 65 20 76 61 6c 75 65 20 72  fect the value r
19ac0 65 74 75 72 6e 65 64 20 62 79 20 73 71 6c 69 74  eturned by sqlit
19ad0 65 33 5f 74 6f 74 61 6c 5f 63 68 61 6e 67 65 73  e3_total_changes
19ae0 28 29 2e 0a 2a 2a 20 0a 2a 2a 20 5e 43 68 61 6e  ()..** .** ^Chan
19af0 67 65 73 20 6d 61 64 65 20 61 73 20 70 61 72 74  ges made as part
19b00 20 6f 66 20 5b 66 6f 72 65 69 67 6e 20 6b 65 79   of [foreign key
19b10 20 61 63 74 69 6f 6e 73 5d 20 61 72 65 20 69 6e   actions] are in
19b20 63 6c 75 64 65 64 20 69 6e 20 74 68 65 0a 2a 2a  cluded in the.**
19b30 20 63 6f 75 6e 74 2c 20 62 75 74 20 74 68 6f 73   count, but thos
19b40 65 20 6d 61 64 65 20 61 73 20 70 61 72 74 20 6f  e made as part o
19b50 66 20 52 45 50 4c 41 43 45 20 63 6f 6e 73 74 72  f REPLACE constr
19b60 61 69 6e 74 20 72 65 73 6f 6c 75 74 69 6f 6e 20  aint resolution 
19b70 61 72 65 0a 2a 2a 20 6e 6f 74 2e 20 5e 43 68 61  are.** not. ^Cha
19b80 6e 67 65 73 20 74 6f 20 61 20 76 69 65 77 20 74  nges to a view t
19b90 68 61 74 20 61 72 65 20 69 6e 74 65 72 63 65 70  hat are intercep
19ba0 74 65 64 20 62 79 20 49 4e 53 54 45 41 44 20 4f  ted by INSTEAD O
19bb0 46 20 74 72 69 67 67 65 72 73 20 0a 2a 2a 20 61  F triggers .** a
19bc0 72 65 20 6e 6f 74 20 63 6f 75 6e 74 65 64 2e 0a  re not counted..
19bd0 2a 2a 20 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 20  ** .** See also 
19be0 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 63 68 61  the [sqlite3_cha
19bf0 6e 67 65 73 28 29 5d 20 69 6e 74 65 72 66 61 63  nges()] interfac
19c00 65 2c 20 74 68 65 0a 2a 2a 20 5b 63 6f 75 6e 74  e, the.** [count
19c10 5f 63 68 61 6e 67 65 73 20 70 72 61 67 6d 61 5d  _changes pragma]
19c20 2c 20 61 6e 64 20 74 68 65 20 5b 74 6f 74 61 6c  , and the [total
19c30 5f 63 68 61 6e 67 65 73 28 29 20 53 51 4c 20 66  _changes() SQL f
19c40 75 6e 63 74 69 6f 6e 5d 2e 0a 2a 2a 0a 2a 2a 20  unction]..**.** 
19c50 49 66 20 61 20 73 65 70 61 72 61 74 65 20 74 68  If a separate th
19c60 72 65 61 64 20 6d 61 6b 65 73 20 63 68 61 6e 67  read makes chang
19c70 65 73 20 6f 6e 20 74 68 65 20 73 61 6d 65 20 64  es on the same d
19c80 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
19c90 6f 6e 0a 2a 2a 20 77 68 69 6c 65 20 5b 73 71 6c  on.** while [sql
19ca0 69 74 65 33 5f 74 6f 74 61 6c 5f 63 68 61 6e 67  ite3_total_chang
19cb0 65 73 28 29 5d 20 69 73 20 72 75 6e 6e 69 6e 67  es()] is running
19cc0 20 74 68 65 6e 20 74 68 65 20 76 61 6c 75 65 0a   then the value.
19cd0 2a 2a 20 72 65 74 75 72 6e 65 64 20 69 73 20 75  ** returned is u
19ce0 6e 70 72 65 64 69 63 74 61 62 6c 65 20 61 6e 64  npredictable and
19cf0 20 6e 6f 74 20 6d 65 61 6e 69 6e 67 66 75 6c 2e   not meaningful.
19d00 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .*/.int sqlite3_
19d10 74 6f 74 61 6c 5f 63 68 61 6e 67 65 73 28 73 71  total_changes(sq
19d20 6c 69 74 65 33 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20  lite3*);../*.** 
19d30 43 41 50 49 33 52 45 46 3a 20 49 6e 74 65 72 72  CAPI3REF: Interr
19d40 75 70 74 20 41 20 4c 6f 6e 67 2d 52 75 6e 6e 69  upt A Long-Runni
19d50 6e 67 20 51 75 65 72 79 0a 2a 2a 20 4d 45 54 48  ng Query.** METH
19d60 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a  OD: sqlite3.**.*
19d70 2a 20 5e 54 68 69 73 20 66 75 6e 63 74 69 6f 6e  * ^This function
19d80 20 63 61 75 73 65 73 20 61 6e 79 20 70 65 6e 64   causes any pend
19d90 69 6e 67 20 64 61 74 61 62 61 73 65 20 6f 70 65  ing database ope
19da0 72 61 74 69 6f 6e 20 74 6f 20 61 62 6f 72 74 20  ration to abort 
19db0 61 6e 64 0a 2a 2a 20 72 65 74 75 72 6e 20 61 74  and.** return at
19dc0 20 69 74 73 20 65 61 72 6c 69 65 73 74 20 6f 70   its earliest op
19dd0 70 6f 72 74 75 6e 69 74 79 2e 20 54 68 69 73 20  portunity. This 
19de0 72 6f 75 74 69 6e 65 20 69 73 20 74 79 70 69 63  routine is typic
19df0 61 6c 6c 79 0a 2a 2a 20 63 61 6c 6c 65 64 20 69  ally.** called i
19e00 6e 20 72 65 73 70 6f 6e 73 65 20 74 6f 20 61 20  n response to a 
19e10 75 73 65 72 20 61 63 74 69 6f 6e 20 73 75 63 68  user action such
19e20 20 61 73 20 70 72 65 73 73 69 6e 67 20 22 43 61   as pressing "Ca
19e30 6e 63 65 6c 22 0a 2a 2a 20 6f 72 20 43 74 72 6c  ncel".** or Ctrl
19e40 2d 43 20 77 68 65 72 65 20 74 68 65 20 75 73 65  -C where the use
19e50 72 20 77 61 6e 74 73 20 61 20 6c 6f 6e 67 20 71  r wants a long q
19e60 75 65 72 79 20 6f 70 65 72 61 74 69 6f 6e 20 74  uery operation t
19e70 6f 20 68 61 6c 74 0a 2a 2a 20 69 6d 6d 65 64 69  o halt.** immedi
19e80 61 74 65 6c 79 2e 0a 2a 2a 0a 2a 2a 20 5e 49 74  ately..**.** ^It
19e90 20 69 73 20 73 61 66 65 20 74 6f 20 63 61 6c 6c   is safe to call
19ea0 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 66 72   this routine fr
19eb0 6f 6d 20 61 20 74 68 72 65 61 64 20 64 69 66 66  om a thread diff
19ec0 65 72 65 6e 74 20 66 72 6f 6d 20 74 68 65 0a 2a  erent from the.*
19ed0 2a 20 74 68 72 65 61 64 20 74 68 61 74 20 69 73  * thread that is
19ee0 20 63 75 72 72 65 6e 74 6c 79 20 72 75 6e 6e 69   currently runni
19ef0 6e 67 20 74 68 65 20 64 61 74 61 62 61 73 65 20  ng the database 
19f00 6f 70 65 72 61 74 69 6f 6e 2e 20 20 42 75 74 20  operation.  But 
19f10 69 74 0a 2a 2a 20 69 73 20 6e 6f 74 20 73 61 66  it.** is not saf
19f20 65 20 74 6f 20 63 61 6c 6c 20 74 68 69 73 20 72  e to call this r
19f30 6f 75 74 69 6e 65 20 77 69 74 68 20 61 20 5b 64  outine with a [d
19f40 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
19f50 6f 6e 5d 20 74 68 61 74 0a 2a 2a 20 69 73 20 63  on] that.** is c
19f60 6c 6f 73 65 64 20 6f 72 20 6d 69 67 68 74 20 63  losed or might c
19f70 6c 6f 73 65 20 62 65 66 6f 72 65 20 73 71 6c 69  lose before sqli
19f80 74 65 33 5f 69 6e 74 65 72 72 75 70 74 28 29 20  te3_interrupt() 
19f90 72 65 74 75 72 6e 73 2e 0a 2a 2a 0a 2a 2a 20 5e  returns..**.** ^
19fa0 49 66 20 61 6e 20 53 51 4c 20 6f 70 65 72 61 74  If an SQL operat
19fb0 69 6f 6e 20 69 73 20 76 65 72 79 20 6e 65 61 72  ion is very near
19fc0 6c 79 20 66 69 6e 69 73 68 65 64 20 61 74 20 74  ly finished at t
19fd0 68 65 20 74 69 6d 65 20 77 68 65 6e 0a 2a 2a 20  he time when.** 
19fe0 73 71 6c 69 74 65 33 5f 69 6e 74 65 72 72 75 70  sqlite3_interrup
19ff0 74 28 29 20 69 73 20 63 61 6c 6c 65 64 2c 20 74  t() is called, t
1a000 68 65 6e 20 69 74 20 6d 69 67 68 74 20 6e 6f 74  hen it might not
1a010 20 68 61 76 65 20 61 6e 20 6f 70 70 6f 72 74 75   have an opportu
1a020 6e 69 74 79 0a 2a 2a 20 74 6f 20 62 65 20 69 6e  nity.** to be in
1a030 74 65 72 72 75 70 74 65 64 20 61 6e 64 20 6d 69  terrupted and mi
1a040 67 68 74 20 63 6f 6e 74 69 6e 75 65 20 74 6f 20  ght continue to 
1a050 63 6f 6d 70 6c 65 74 69 6f 6e 2e 0a 2a 2a 0a 2a  completion..**.*
1a060 2a 20 5e 41 6e 20 53 51 4c 20 6f 70 65 72 61 74  * ^An SQL operat
1a070 69 6f 6e 20 74 68 61 74 20 69 73 20 69 6e 74 65  ion that is inte
1a080 72 72 75 70 74 65 64 20 77 69 6c 6c 20 72 65 74  rrupted will ret
1a090 75 72 6e 20 5b 53 51 4c 49 54 45 5f 49 4e 54 45  urn [SQLITE_INTE
1a0a0 52 52 55 50 54 5d 2e 0a 2a 2a 20 5e 49 66 20 74  RRUPT]..** ^If t
1a0b0 68 65 20 69 6e 74 65 72 72 75 70 74 65 64 20 53  he interrupted S
1a0c0 51 4c 20 6f 70 65 72 61 74 69 6f 6e 20 69 73 20  QL operation is 
1a0d0 61 6e 20 49 4e 53 45 52 54 2c 20 55 50 44 41 54  an INSERT, UPDAT
1a0e0 45 2c 20 6f 72 20 44 45 4c 45 54 45 0a 2a 2a 20  E, or DELETE.** 
1a0f0 74 68 61 74 20 69 73 20 69 6e 73 69 64 65 20 61  that is inside a
1a100 6e 20 65 78 70 6c 69 63 69 74 20 74 72 61 6e 73  n explicit trans
1a110 61 63 74 69 6f 6e 2c 20 74 68 65 6e 20 74 68 65  action, then the
1a120 20 65 6e 74 69 72 65 20 74 72 61 6e 73 61 63 74   entire transact
1a130 69 6f 6e 0a 2a 2a 20 77 69 6c 6c 20 62 65 20 72  ion.** will be r
1a140 6f 6c 6c 65 64 20 62 61 63 6b 20 61 75 74 6f 6d  olled back autom
1a150 61 74 69 63 61 6c 6c 79 2e 0a 2a 2a 0a 2a 2a 20  atically..**.** 
1a160 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 69 6e 74  ^The sqlite3_int
1a170 65 72 72 75 70 74 28 44 29 20 63 61 6c 6c 20 69  errupt(D) call i
1a180 73 20 69 6e 20 65 66 66 65 63 74 20 75 6e 74 69  s in effect unti
1a190 6c 20 61 6c 6c 20 63 75 72 72 65 6e 74 6c 79 20  l all currently 
1a1a0 72 75 6e 6e 69 6e 67 0a 2a 2a 20 53 51 4c 20 73  running.** SQL s
1a1b0 74 61 74 65 6d 65 6e 74 73 20 6f 6e 20 5b 64 61  tatements on [da
1a1c0 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
1a1d0 6e 5d 20 44 20 63 6f 6d 70 6c 65 74 65 2e 20 20  n] D complete.  
1a1e0 5e 41 6e 79 20 6e 65 77 20 53 51 4c 20 73 74 61  ^Any new SQL sta
1a1f0 74 65 6d 65 6e 74 73 0a 2a 2a 20 74 68 61 74 20  tements.** that 
1a200 61 72 65 20 73 74 61 72 74 65 64 20 61 66 74 65  are started afte
1a210 72 20 74 68 65 20 73 71 6c 69 74 65 33 5f 69 6e  r the sqlite3_in
1a220 74 65 72 72 75 70 74 28 29 20 63 61 6c 6c 20 61  terrupt() call a
1a230 6e 64 20 62 65 66 6f 72 65 20 74 68 65 20 0a 2a  nd before the .*
1a240 2a 20 72 75 6e 6e 69 6e 67 20 73 74 61 74 65 6d  * running statem
1a250 65 6e 74 73 20 72 65 61 63 68 65 73 20 7a 65 72  ents reaches zer
1a260 6f 20 61 72 65 20 69 6e 74 65 72 72 75 70 74 65  o are interrupte
1a270 64 20 61 73 20 69 66 20 74 68 65 79 20 68 61 64  d as if they had
1a280 20 62 65 65 6e 0a 2a 2a 20 72 75 6e 6e 69 6e 67   been.** running
1a290 20 70 72 69 6f 72 20 74 6f 20 74 68 65 20 73 71   prior to the sq
1a2a0 6c 69 74 65 33 5f 69 6e 74 65 72 72 75 70 74 28  lite3_interrupt(
1a2b0 29 20 63 61 6c 6c 2e 20 20 5e 4e 65 77 20 53 51  ) call.  ^New SQ
1a2c0 4c 20 73 74 61 74 65 6d 65 6e 74 73 0a 2a 2a 20  L statements.** 
1a2d0 74 68 61 74 20 61 72 65 20 73 74 61 72 74 65 64  that are started
1a2e0 20 61 66 74 65 72 20 74 68 65 20 72 75 6e 6e 69   after the runni
1a2f0 6e 67 20 73 74 61 74 65 6d 65 6e 74 20 63 6f 75  ng statement cou
1a300 6e 74 20 72 65 61 63 68 65 73 20 7a 65 72 6f 20  nt reaches zero 
1a310 61 72 65 0a 2a 2a 20 6e 6f 74 20 65 66 66 65 63  are.** not effec
1a320 74 65 64 20 62 79 20 74 68 65 20 73 71 6c 69 74  ted by the sqlit
1a330 65 33 5f 69 6e 74 65 72 72 75 70 74 28 29 2e 0a  e3_interrupt()..
1a340 2a 2a 20 5e 41 20 63 61 6c 6c 20 74 6f 20 73 71  ** ^A call to sq
1a350 6c 69 74 65 33 5f 69 6e 74 65 72 72 75 70 74 28  lite3_interrupt(
1a360 44 29 20 74 68 61 74 20 6f 63 63 75 72 73 20 77  D) that occurs w
1a370 68 65 6e 20 74 68 65 72 65 20 61 72 65 20 6e 6f  hen there are no
1a380 20 72 75 6e 6e 69 6e 67 0a 2a 2a 20 53 51 4c 20   running.** SQL 
1a390 73 74 61 74 65 6d 65 6e 74 73 20 69 73 20 61 20  statements is a 
1a3a0 6e 6f 2d 6f 70 20 61 6e 64 20 68 61 73 20 6e 6f  no-op and has no
1a3b0 20 65 66 66 65 63 74 20 6f 6e 20 53 51 4c 20 73   effect on SQL s
1a3c0 74 61 74 65 6d 65 6e 74 73 0a 2a 2a 20 74 68 61  tatements.** tha
1a3d0 74 20 61 72 65 20 73 74 61 72 74 65 64 20 61 66  t are started af
1a3e0 74 65 72 20 74 68 65 20 73 71 6c 69 74 65 33 5f  ter the sqlite3_
1a3f0 69 6e 74 65 72 72 75 70 74 28 29 20 63 61 6c 6c  interrupt() call
1a400 20 72 65 74 75 72 6e 73 2e 0a 2a 2a 0a 2a 2a 20   returns..**.** 
1a410 49 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20  If the database 
1a420 63 6f 6e 6e 65 63 74 69 6f 6e 20 63 6c 6f 73 65  connection close
1a430 73 20 77 68 69 6c 65 20 5b 73 71 6c 69 74 65 33  s while [sqlite3
1a440 5f 69 6e 74 65 72 72 75 70 74 28 29 5d 0a 2a 2a  _interrupt()].**
1a450 20 69 73 20 72 75 6e 6e 69 6e 67 20 74 68 65 6e   is running then
1a460 20 62 61 64 20 74 68 69 6e 67 73 20 77 69 6c 6c   bad things will
1a470 20 6c 69 6b 65 6c 79 20 68 61 70 70 65 6e 2e 0a   likely happen..
1a480 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 5f  */.void sqlite3_
1a490 69 6e 74 65 72 72 75 70 74 28 73 71 6c 69 74 65  interrupt(sqlite
1a4a0 33 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  3*);../*.** CAPI
1a4b0 33 52 45 46 3a 20 44 65 74 65 72 6d 69 6e 65 20  3REF: Determine 
1a4c0 49 66 20 41 6e 20 53 51 4c 20 53 74 61 74 65 6d  If An SQL Statem
1a4d0 65 6e 74 20 49 73 20 43 6f 6d 70 6c 65 74 65 0a  ent Is Complete.
1a4e0 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72 6f 75 74  **.** These rout
1a4f0 69 6e 65 73 20 61 72 65 20 75 73 65 66 75 6c 20  ines are useful 
1a500 64 75 72 69 6e 67 20 63 6f 6d 6d 61 6e 64 2d 6c  during command-l
1a510 69 6e 65 20 69 6e 70 75 74 20 74 6f 20 64 65 74  ine input to det
1a520 65 72 6d 69 6e 65 20 69 66 20 74 68 65 0a 2a 2a  ermine if the.**
1a530 20 63 75 72 72 65 6e 74 6c 79 20 65 6e 74 65 72   currently enter
1a540 65 64 20 74 65 78 74 20 73 65 65 6d 73 20 74 6f  ed text seems to
1a550 20 66 6f 72 6d 20 61 20 63 6f 6d 70 6c 65 74 65   form a complete
1a560 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 6f   SQL statement o
1a570 72 0a 2a 2a 20 69 66 20 61 64 64 69 74 69 6f 6e  r.** if addition
1a580 61 6c 20 69 6e 70 75 74 20 69 73 20 6e 65 65 64  al input is need
1a590 65 64 20 62 65 66 6f 72 65 20 73 65 6e 64 69 6e  ed before sendin
1a5a0 67 20 74 68 65 20 74 65 78 74 20 69 6e 74 6f 0a  g the text into.
1a5b0 2a 2a 20 53 51 4c 69 74 65 20 66 6f 72 20 70 61  ** SQLite for pa
1a5c0 72 73 69 6e 67 2e 20 20 5e 54 68 65 73 65 20 72  rsing.  ^These r
1a5d0 6f 75 74 69 6e 65 73 20 72 65 74 75 72 6e 20 31  outines return 1
1a5e0 20 69 66 20 74 68 65 20 69 6e 70 75 74 20 73 74   if the input st
1a5f0 72 69 6e 67 0a 2a 2a 20 61 70 70 65 61 72 73 20  ring.** appears 
1a600 74 6f 20 62 65 20 61 20 63 6f 6d 70 6c 65 74 65  to be a complete
1a610 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2e 20   SQL statement. 
1a620 20 5e 41 20 73 74 61 74 65 6d 65 6e 74 20 69 73   ^A statement is
1a630 20 6a 75 64 67 65 64 20 74 6f 20 62 65 0a 2a 2a   judged to be.**
1a640 20 63 6f 6d 70 6c 65 74 65 20 69 66 20 69 74 20   complete if it 
1a650 65 6e 64 73 20 77 69 74 68 20 61 20 73 65 6d 69  ends with a semi
1a660 63 6f 6c 6f 6e 20 74 6f 6b 65 6e 20 61 6e 64 20  colon token and 
1a670 69 73 20 6e 6f 74 20 61 20 70 72 65 66 69 78 20  is not a prefix 
1a680 6f 66 20 61 0a 2a 2a 20 77 65 6c 6c 2d 66 6f 72  of a.** well-for
1a690 6d 65 64 20 43 52 45 41 54 45 20 54 52 49 47 47  med CREATE TRIGG
1a6a0 45 52 20 73 74 61 74 65 6d 65 6e 74 2e 20 20 5e  ER statement.  ^
1a6b0 53 65 6d 69 63 6f 6c 6f 6e 73 20 74 68 61 74 20  Semicolons that 
1a6c0 61 72 65 20 65 6d 62 65 64 64 65 64 20 77 69 74  are embedded wit
1a6d0 68 69 6e 0a 2a 2a 20 73 74 72 69 6e 67 20 6c 69  hin.** string li
1a6e0 74 65 72 61 6c 73 20 6f 72 20 71 75 6f 74 65 64  terals or quoted
1a6f0 20 69 64 65 6e 74 69 66 69 65 72 20 6e 61 6d 65   identifier name
1a700 73 20 6f 72 20 63 6f 6d 6d 65 6e 74 73 20 61 72  s or comments ar
1a710 65 20 6e 6f 74 0a 2a 2a 20 69 6e 64 65 70 65 6e  e not.** indepen
1a720 64 65 6e 74 20 74 6f 6b 65 6e 73 20 28 74 68 65  dent tokens (the
1a730 79 20 61 72 65 20 70 61 72 74 20 6f 66 20 74 68  y are part of th
1a740 65 20 74 6f 6b 65 6e 20 69 6e 20 77 68 69 63 68  e token in which
1a750 20 74 68 65 79 20 61 72 65 0a 2a 2a 20 65 6d 62   they are.** emb
1a760 65 64 64 65 64 29 20 61 6e 64 20 74 68 75 73 20  edded) and thus 
1a770 64 6f 20 6e 6f 74 20 63 6f 75 6e 74 20 61 73 20  do not count as 
1a780 61 20 73 74 61 74 65 6d 65 6e 74 20 74 65 72 6d  a statement term
1a790 69 6e 61 74 6f 72 2e 20 20 5e 57 68 69 74 65 73  inator.  ^Whites
1a7a0 70 61 63 65 0a 2a 2a 20 61 6e 64 20 63 6f 6d 6d  pace.** and comm
1a7b0 65 6e 74 73 20 74 68 61 74 20 66 6f 6c 6c 6f 77  ents that follow
1a7c0 20 74 68 65 20 66 69 6e 61 6c 20 73 65 6d 69 63   the final semic
1a7d0 6f 6c 6f 6e 20 61 72 65 20 69 67 6e 6f 72 65 64  olon are ignored
1a7e0 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 73 65 20 72  ..**.** ^These r
1a7f0 6f 75 74 69 6e 65 73 20 72 65 74 75 72 6e 20 30  outines return 0
1a800 20 69 66 20 74 68 65 20 73 74 61 74 65 6d 65 6e   if the statemen
1a810 74 20 69 73 20 69 6e 63 6f 6d 70 6c 65 74 65 2e  t is incomplete.
1a820 20 20 5e 49 66 20 61 0a 2a 2a 20 6d 65 6d 6f 72    ^If a.** memor
1a830 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 66 61 69  y allocation fai
1a840 6c 73 2c 20 74 68 65 6e 20 53 51 4c 49 54 45 5f  ls, then SQLITE_
1a850 4e 4f 4d 45 4d 20 69 73 20 72 65 74 75 72 6e 65  NOMEM is returne
1a860 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 73 65 20  d..**.** ^These 
1a870 72 6f 75 74 69 6e 65 73 20 64 6f 20 6e 6f 74 20  routines do not 
1a880 70 61 72 73 65 20 74 68 65 20 53 51 4c 20 73 74  parse the SQL st
1a890 61 74 65 6d 65 6e 74 73 20 74 68 75 73 0a 2a 2a  atements thus.**
1a8a0 20 77 69 6c 6c 20 6e 6f 74 20 64 65 74 65 63 74   will not detect
1a8b0 20 73 79 6e 74 61 63 74 69 63 61 6c 6c 79 20 69   syntactically i
1a8c0 6e 63 6f 72 72 65 63 74 20 53 51 4c 2e 0a 2a 2a  ncorrect SQL..**
1a8d0 0a 2a 2a 20 5e 28 49 66 20 53 51 4c 69 74 65 20  .** ^(If SQLite 
1a8e0 68 61 73 20 6e 6f 74 20 62 65 65 6e 20 69 6e 69  has not been ini
1a8f0 74 69 61 6c 69 7a 65 64 20 75 73 69 6e 67 20 5b  tialized using [
1a900 73 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69  sqlite3_initiali
1a910 7a 65 28 29 5d 20 70 72 69 6f 72 20 0a 2a 2a 20  ze()] prior .** 
1a920 74 6f 20 69 6e 76 6f 6b 69 6e 67 20 73 71 6c 69  to invoking sqli
1a930 74 65 33 5f 63 6f 6d 70 6c 65 74 65 31 36 28 29  te3_complete16()
1a940 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f 69 6e   then sqlite3_in
1a950 69 74 69 61 6c 69 7a 65 28 29 20 69 73 20 69 6e  itialize() is in
1a960 76 6f 6b 65 64 0a 2a 2a 20 61 75 74 6f 6d 61 74  voked.** automat
1a970 69 63 61 6c 6c 79 20 62 79 20 73 71 6c 69 74 65  ically by sqlite
1a980 33 5f 63 6f 6d 70 6c 65 74 65 31 36 28 29 2e 20  3_complete16(). 
1a990 20 49 66 20 74 68 61 74 20 69 6e 69 74 69 61 6c   If that initial
1a9a0 69 7a 61 74 69 6f 6e 20 66 61 69 6c 73 2c 0a 2a  ization fails,.*
1a9b0 2a 20 74 68 65 6e 20 74 68 65 20 72 65 74 75 72  * then the retur
1a9c0 6e 20 76 61 6c 75 65 20 66 72 6f 6d 20 73 71 6c  n value from sql
1a9d0 69 74 65 33 5f 63 6f 6d 70 6c 65 74 65 31 36 28  ite3_complete16(
1a9e0 29 20 77 69 6c 6c 20 62 65 20 6e 6f 6e 2d 7a 65  ) will be non-ze
1a9f0 72 6f 0a 2a 2a 20 72 65 67 61 72 64 6c 65 73 73  ro.** regardless
1aa00 20 6f 66 20 77 68 65 74 68 65 72 20 6f 72 20 6e   of whether or n
1aa10 6f 74 20 74 68 65 20 69 6e 70 75 74 20 53 51 4c  ot the input SQL
1aa20 20 69 73 20 63 6f 6d 70 6c 65 74 65 2e 29 5e 0a   is complete.)^.
1aa30 2a 2a 0a 2a 2a 20 54 68 65 20 69 6e 70 75 74 20  **.** The input 
1aa40 74 6f 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6d 70  to [sqlite3_comp
1aa50 6c 65 74 65 28 29 5d 20 6d 75 73 74 20 62 65 20  lete()] must be 
1aa60 61 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65  a zero-terminate
1aa70 64 0a 2a 2a 20 55 54 46 2d 38 20 73 74 72 69 6e  d.** UTF-8 strin
1aa80 67 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 69 6e 70  g..**.** The inp
1aa90 75 74 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 63  ut to [sqlite3_c
1aaa0 6f 6d 70 6c 65 74 65 31 36 28 29 5d 20 6d 75 73  omplete16()] mus
1aab0 74 20 62 65 20 61 20 7a 65 72 6f 2d 74 65 72 6d  t be a zero-term
1aac0 69 6e 61 74 65 64 0a 2a 2a 20 55 54 46 2d 31 36  inated.** UTF-16
1aad0 20 73 74 72 69 6e 67 20 69 6e 20 6e 61 74 69 76   string in nativ
1aae0 65 20 62 79 74 65 20 6f 72 64 65 72 2e 0a 2a 2f  e byte order..*/
1aaf0 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 63 6f 6d  .int sqlite3_com
1ab00 70 6c 65 74 65 28 63 6f 6e 73 74 20 63 68 61 72  plete(const char
1ab10 20 2a 73 71 6c 29 3b 0a 69 6e 74 20 73 71 6c 69   *sql);.int sqli
1ab20 74 65 33 5f 63 6f 6d 70 6c 65 74 65 31 36 28 63  te3_complete16(c
1ab30 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c 29 3b  onst void *sql);
1ab40 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
1ab50 3a 20 52 65 67 69 73 74 65 72 20 41 20 43 61 6c  : Register A Cal
1ab60 6c 62 61 63 6b 20 54 6f 20 48 61 6e 64 6c 65 20  lback To Handle 
1ab70 53 51 4c 49 54 45 5f 42 55 53 59 20 45 72 72 6f  SQLITE_BUSY Erro
1ab80 72 73 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20  rs.** KEYWORDS: 
1ab90 7b 62 75 73 79 2d 68 61 6e 64 6c 65 72 20 63 61  {busy-handler ca
1aba0 6c 6c 62 61 63 6b 7d 20 7b 62 75 73 79 20 68 61  llback} {busy ha
1abb0 6e 64 6c 65 72 7d 0a 2a 2a 20 4d 45 54 48 4f 44  ndler}.** METHOD
1abc0 3a 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20  : sqlite3.**.** 
1abd0 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 62 75 73  ^The sqlite3_bus
1abe0 79 5f 68 61 6e 64 6c 65 72 28 44 2c 58 2c 50 29  y_handler(D,X,P)
1abf0 20 72 6f 75 74 69 6e 65 20 73 65 74 73 20 61 20   routine sets a 
1ac00 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f  callback functio
1ac10 6e 20 58 0a 2a 2a 20 74 68 61 74 20 6d 69 67 68  n X.** that migh
1ac20 74 20 62 65 20 69 6e 76 6f 6b 65 64 20 77 69 74  t be invoked wit
1ac30 68 20 61 72 67 75 6d 65 6e 74 20 50 20 77 68 65  h argument P whe
1ac40 6e 65 76 65 72 0a 2a 2a 20 61 6e 20 61 74 74 65  never.** an atte
1ac50 6d 70 74 20 69 73 20 6d 61 64 65 20 74 6f 20 61  mpt is made to a
1ac60 63 63 65 73 73 20 61 20 64 61 74 61 62 61 73 65  ccess a database
1ac70 20 74 61 62 6c 65 20 61 73 73 6f 63 69 61 74 65   table associate
1ac80 64 20 77 69 74 68 0a 2a 2a 20 5b 64 61 74 61 62  d with.** [datab
1ac90 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20  ase connection] 
1aca0 44 20 77 68 65 6e 20 61 6e 6f 74 68 65 72 20 74  D when another t
1acb0 68 72 65 61 64 0a 2a 2a 20 6f 72 20 70 72 6f 63  hread.** or proc
1acc0 65 73 73 20 68 61 73 20 74 68 65 20 74 61 62 6c  ess has the tabl
1acd0 65 20 6c 6f 63 6b 65 64 2e 0a 2a 2a 20 54 68 65  e locked..** The
1ace0 20 73 71 6c 69 74 65 33 5f 62 75 73 79 5f 68 61   sqlite3_busy_ha
1acf0 6e 64 6c 65 72 28 29 20 69 6e 74 65 72 66 61 63  ndler() interfac
1ad00 65 20 69 73 20 75 73 65 64 20 74 6f 20 69 6d 70  e is used to imp
1ad10 6c 65 6d 65 6e 74 0a 2a 2a 20 5b 73 71 6c 69 74  lement.** [sqlit
1ad20 65 33 5f 62 75 73 79 5f 74 69 6d 65 6f 75 74 28  e3_busy_timeout(
1ad30 29 5d 20 61 6e 64 20 5b 50 52 41 47 4d 41 20 62  )] and [PRAGMA b
1ad40 75 73 79 5f 74 69 6d 65 6f 75 74 5d 2e 0a 2a 2a  usy_timeout]..**
1ad50 0a 2a 2a 20 5e 49 66 20 74 68 65 20 62 75 73 79  .** ^If the busy
1ad60 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 4e 55 4c   callback is NUL
1ad70 4c 2c 20 74 68 65 6e 20 5b 53 51 4c 49 54 45 5f  L, then [SQLITE_
1ad80 42 55 53 59 5d 0a 2a 2a 20 69 73 20 72 65 74 75  BUSY].** is retu
1ad90 72 6e 65 64 20 69 6d 6d 65 64 69 61 74 65 6c 79  rned immediately
1ada0 20 75 70 6f 6e 20 65 6e 63 6f 75 6e 74 65 72 69   upon encounteri
1adb0 6e 67 20 74 68 65 20 6c 6f 63 6b 2e 20 20 5e 49  ng the lock.  ^I
1adc0 66 20 74 68 65 20 62 75 73 79 20 63 61 6c 6c 62  f the busy callb
1add0 61 63 6b 0a 2a 2a 20 69 73 20 6e 6f 74 20 4e 55  ack.** is not NU
1ade0 4c 4c 2c 20 74 68 65 6e 20 74 68 65 20 63 61 6c  LL, then the cal
1adf0 6c 62 61 63 6b 20 6d 69 67 68 74 20 62 65 20 69  lback might be i
1ae00 6e 76 6f 6b 65 64 20 77 69 74 68 20 74 77 6f 20  nvoked with two 
1ae10 61 72 67 75 6d 65 6e 74 73 2e 0a 2a 2a 0a 2a 2a  arguments..**.**
1ae20 20 5e 54 68 65 20 66 69 72 73 74 20 61 72 67 75   ^The first argu
1ae30 6d 65 6e 74 20 74 6f 20 74 68 65 20 62 75 73 79  ment to the busy
1ae40 20 68 61 6e 64 6c 65 72 20 69 73 20 61 20 63 6f   handler is a co
1ae50 70 79 20 6f 66 20 74 68 65 20 76 6f 69 64 2a 20  py of the void* 
1ae60 70 6f 69 6e 74 65 72 20 77 68 69 63 68 0a 2a 2a  pointer which.**
1ae70 20 69 73 20 74 68 65 20 74 68 69 72 64 20 61 72   is the third ar
1ae80 67 75 6d 65 6e 74 20 74 6f 20 73 71 6c 69 74 65  gument to sqlite
1ae90 33 5f 62 75 73 79 5f 68 61 6e 64 6c 65 72 28 29  3_busy_handler()
1aea0 2e 20 20 5e 54 68 65 20 73 65 63 6f 6e 64 20 61  .  ^The second a
1aeb0 72 67 75 6d 65 6e 74 20 74 6f 0a 2a 2a 20 74 68  rgument to.** th
1aec0 65 20 62 75 73 79 20 68 61 6e 64 6c 65 72 20 63  e busy handler c
1aed0 61 6c 6c 62 61 63 6b 20 69 73 20 74 68 65 20 6e  allback is the n
1aee0 75 6d 62 65 72 20 6f 66 20 74 69 6d 65 73 20 74  umber of times t
1aef0 68 61 74 20 74 68 65 20 62 75 73 79 20 68 61 6e  hat the busy han
1af00 64 6c 65 72 20 68 61 73 0a 2a 2a 20 62 65 65 6e  dler has.** been
1af10 20 69 6e 76 6f 6b 65 64 20 70 72 65 76 69 6f 75   invoked previou
1af20 73 6c 79 20 66 6f 72 20 74 68 65 20 73 61 6d 65  sly for the same
1af30 20 6c 6f 63 6b 69 6e 67 20 65 76 65 6e 74 2e 20   locking event. 
1af40 20 5e 49 66 20 74 68 65 0a 2a 2a 20 62 75 73 79   ^If the.** busy
1af50 20 63 61 6c 6c 62 61 63 6b 20 72 65 74 75 72 6e   callback return
1af60 73 20 30 2c 20 74 68 65 6e 20 6e 6f 20 61 64 64  s 0, then no add
1af70 69 74 69 6f 6e 61 6c 20 61 74 74 65 6d 70 74 73  itional attempts
1af80 20 61 72 65 20 6d 61 64 65 20 74 6f 0a 2a 2a 20   are made to.** 
1af90 61 63 63 65 73 73 20 74 68 65 20 64 61 74 61 62  access the datab
1afa0 61 73 65 20 61 6e 64 20 5b 53 51 4c 49 54 45 5f  ase and [SQLITE_
1afb0 42 55 53 59 5d 20 69 73 20 72 65 74 75 72 6e 65  BUSY] is returne
1afc0 64 0a 2a 2a 20 74 6f 20 74 68 65 20 61 70 70 6c  d.** to the appl
1afd0 69 63 61 74 69 6f 6e 2e 0a 2a 2a 20 5e 49 66 20  ication..** ^If 
1afe0 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 72 65 74  the callback ret
1aff0 75 72 6e 73 20 6e 6f 6e 2d 7a 65 72 6f 2c 20 74  urns non-zero, t
1b000 68 65 6e 20 61 6e 6f 74 68 65 72 20 61 74 74 65  hen another atte
1b010 6d 70 74 0a 2a 2a 20 69 73 20 6d 61 64 65 20 74  mpt.** is made t
1b020 6f 20 61 63 63 65 73 73 20 74 68 65 20 64 61 74  o access the dat
1b030 61 62 61 73 65 20 61 6e 64 20 74 68 65 20 63 79  abase and the cy
1b040 63 6c 65 20 72 65 70 65 61 74 73 2e 0a 2a 2a 0a  cle repeats..**.
1b050 2a 2a 20 54 68 65 20 70 72 65 73 65 6e 63 65 20  ** The presence 
1b060 6f 66 20 61 20 62 75 73 79 20 68 61 6e 64 6c 65  of a busy handle
1b070 72 20 64 6f 65 73 20 6e 6f 74 20 67 75 61 72 61  r does not guara
1b080 6e 74 65 65 20 74 68 61 74 20 69 74 20 77 69 6c  ntee that it wil
1b090 6c 20 62 65 20 69 6e 76 6f 6b 65 64 0a 2a 2a 20  l be invoked.** 
1b0a0 77 68 65 6e 20 74 68 65 72 65 20 69 73 20 6c 6f  when there is lo
1b0b0 63 6b 20 63 6f 6e 74 65 6e 74 69 6f 6e 2e 20 5e  ck contention. ^
1b0c0 49 66 20 53 51 4c 69 74 65 20 64 65 74 65 72 6d  If SQLite determ
1b0d0 69 6e 65 73 20 74 68 61 74 20 69 6e 76 6f 6b 69  ines that invoki
1b0e0 6e 67 20 74 68 65 20 62 75 73 79 0a 2a 2a 20 68  ng the busy.** h
1b0f0 61 6e 64 6c 65 72 20 63 6f 75 6c 64 20 72 65 73  andler could res
1b100 75 6c 74 20 69 6e 20 61 20 64 65 61 64 6c 6f 63  ult in a deadloc
1b110 6b 2c 20 69 74 20 77 69 6c 6c 20 67 6f 20 61 68  k, it will go ah
1b120 65 61 64 20 61 6e 64 20 72 65 74 75 72 6e 20 5b  ead and return [
1b130 53 51 4c 49 54 45 5f 42 55 53 59 5d 0a 2a 2a 20  SQLITE_BUSY].** 
1b140 74 6f 20 74 68 65 20 61 70 70 6c 69 63 61 74 69  to the applicati
1b150 6f 6e 20 69 6e 73 74 65 61 64 20 6f 66 20 69 6e  on instead of in
1b160 76 6f 6b 69 6e 67 20 74 68 65 20 0a 2a 2a 20 62  voking the .** b
1b170 75 73 79 20 68 61 6e 64 6c 65 72 2e 0a 2a 2a 20  usy handler..** 
1b180 43 6f 6e 73 69 64 65 72 20 61 20 73 63 65 6e 61  Consider a scena
1b190 72 69 6f 20 77 68 65 72 65 20 6f 6e 65 20 70 72  rio where one pr
1b1a0 6f 63 65 73 73 20 69 73 20 68 6f 6c 64 69 6e 67  ocess is holding
1b1b0 20 61 20 72 65 61 64 20 6c 6f 63 6b 20 74 68 61   a read lock tha
1b1c0 74 0a 2a 2a 20 69 74 20 69 73 20 74 72 79 69 6e  t.** it is tryin
1b1d0 67 20 74 6f 20 70 72 6f 6d 6f 74 65 20 74 6f 20  g to promote to 
1b1e0 61 20 72 65 73 65 72 76 65 64 20 6c 6f 63 6b 20  a reserved lock 
1b1f0 61 6e 64 0a 2a 2a 20 61 20 73 65 63 6f 6e 64 20  and.** a second 
1b200 70 72 6f 63 65 73 73 20 69 73 20 68 6f 6c 64 69  process is holdi
1b210 6e 67 20 61 20 72 65 73 65 72 76 65 64 20 6c 6f  ng a reserved lo
1b220 63 6b 20 74 68 61 74 20 69 74 20 69 73 20 74 72  ck that it is tr
1b230 79 69 6e 67 0a 2a 2a 20 74 6f 20 70 72 6f 6d 6f  ying.** to promo
1b240 74 65 20 74 6f 20 61 6e 20 65 78 63 6c 75 73 69  te to an exclusi
1b250 76 65 20 6c 6f 63 6b 2e 20 20 54 68 65 20 66 69  ve lock.  The fi
1b260 72 73 74 20 70 72 6f 63 65 73 73 20 63 61 6e 6e  rst process cann
1b270 6f 74 20 70 72 6f 63 65 65 64 0a 2a 2a 20 62 65  ot proceed.** be
1b280 63 61 75 73 65 20 69 74 20 69 73 20 62 6c 6f 63  cause it is bloc
1b290 6b 65 64 20 62 79 20 74 68 65 20 73 65 63 6f 6e  ked by the secon
1b2a0 64 20 61 6e 64 20 74 68 65 20 73 65 63 6f 6e 64  d and the second
1b2b0 20 70 72 6f 63 65 73 73 20 63 61 6e 6e 6f 74 0a   process cannot.
1b2c0 2a 2a 20 70 72 6f 63 65 65 64 20 62 65 63 61 75  ** proceed becau
1b2d0 73 65 20 69 74 20 69 73 20 62 6c 6f 63 6b 65 64  se it is blocked
1b2e0 20 62 79 20 74 68 65 20 66 69 72 73 74 2e 20 20   by the first.  
1b2f0 49 66 20 62 6f 74 68 20 70 72 6f 63 65 73 73 65  If both processe
1b300 73 0a 2a 2a 20 69 6e 76 6f 6b 65 20 74 68 65 20  s.** invoke the 
1b310 62 75 73 79 20 68 61 6e 64 6c 65 72 73 2c 20 6e  busy handlers, n
1b320 65 69 74 68 65 72 20 77 69 6c 6c 20 6d 61 6b 65  either will make
1b330 20 61 6e 79 20 70 72 6f 67 72 65 73 73 2e 20 20   any progress.  
1b340 54 68 65 72 65 66 6f 72 65 2c 0a 2a 2a 20 53 51  Therefore,.** SQ
1b350 4c 69 74 65 20 72 65 74 75 72 6e 73 20 5b 53 51  Lite returns [SQ
1b360 4c 49 54 45 5f 42 55 53 59 5d 20 66 6f 72 20 74  LITE_BUSY] for t
1b370 68 65 20 66 69 72 73 74 20 70 72 6f 63 65 73 73  he first process
1b380 2c 20 68 6f 70 69 6e 67 20 74 68 61 74 20 74 68  , hoping that th
1b390 69 73 0a 2a 2a 20 77 69 6c 6c 20 69 6e 64 75 63  is.** will induc
1b3a0 65 20 74 68 65 20 66 69 72 73 74 20 70 72 6f 63  e the first proc
1b3b0 65 73 73 20 74 6f 20 72 65 6c 65 61 73 65 20 69  ess to release i
1b3c0 74 73 20 72 65 61 64 20 6c 6f 63 6b 20 61 6e 64  ts read lock and
1b3d0 20 61 6c 6c 6f 77 0a 2a 2a 20 74 68 65 20 73 65   allow.** the se
1b3e0 63 6f 6e 64 20 70 72 6f 63 65 73 73 20 74 6f 20  cond process to 
1b3f0 70 72 6f 63 65 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e  proceed..**.** ^
1b400 54 68 65 20 64 65 66 61 75 6c 74 20 62 75 73 79  The default busy
1b410 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 4e 55 4c   callback is NUL
1b420 4c 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 65 72 65  L..**.** ^(There
1b430 20 63 61 6e 20 6f 6e 6c 79 20 62 65 20 61 20 73   can only be a s
1b440 69 6e 67 6c 65 20 62 75 73 79 20 68 61 6e 64 6c  ingle busy handl
1b450 65 72 20 64 65 66 69 6e 65 64 20 66 6f 72 20 65  er defined for e
1b460 61 63 68 0a 2a 2a 20 5b 64 61 74 61 62 61 73 65  ach.** [database
1b470 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 2e 20 20 53   connection].  S
1b480 65 74 74 69 6e 67 20 61 20 6e 65 77 20 62 75 73  etting a new bus
1b490 79 20 68 61 6e 64 6c 65 72 20 63 6c 65 61 72 73  y handler clears
1b4a0 20 61 6e 79 0a 2a 2a 20 70 72 65 76 69 6f 75 73   any.** previous
1b4b0 6c 79 20 73 65 74 20 68 61 6e 64 6c 65 72 2e 29  ly set handler.)
1b4c0 5e 20 20 5e 4e 6f 74 65 20 74 68 61 74 20 63 61  ^  ^Note that ca
1b4d0 6c 6c 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 62  lling [sqlite3_b
1b4e0 75 73 79 5f 74 69 6d 65 6f 75 74 28 29 5d 0a 2a  usy_timeout()].*
1b4f0 2a 20 6f 72 20 65 76 61 6c 75 61 74 69 6e 67 20  * or evaluating 
1b500 5b 50 52 41 47 4d 41 20 62 75 73 79 5f 74 69 6d  [PRAGMA busy_tim
1b510 65 6f 75 74 3d 4e 5d 20 77 69 6c 6c 20 63 68 61  eout=N] will cha
1b520 6e 67 65 20 74 68 65 0a 2a 2a 20 62 75 73 79 20  nge the.** busy 
1b530 68 61 6e 64 6c 65 72 20 61 6e 64 20 74 68 75 73  handler and thus
1b540 20 63 6c 65 61 72 20 61 6e 79 20 70 72 65 76 69   clear any previ
1b550 6f 75 73 6c 79 20 73 65 74 20 62 75 73 79 20 68  ously set busy h
1b560 61 6e 64 6c 65 72 2e 0a 2a 2a 0a 2a 2a 20 54 68  andler..**.** Th
1b570 65 20 62 75 73 79 20 63 61 6c 6c 62 61 63 6b 20  e busy callback 
1b580 73 68 6f 75 6c 64 20 6e 6f 74 20 74 61 6b 65 20  should not take 
1b590 61 6e 79 20 61 63 74 69 6f 6e 73 20 77 68 69 63  any actions whic
1b5a0 68 20 6d 6f 64 69 66 79 20 74 68 65 0a 2a 2a 20  h modify the.** 
1b5b0 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
1b5c0 69 6f 6e 20 74 68 61 74 20 69 6e 76 6f 6b 65 64  ion that invoked
1b5d0 20 74 68 65 20 62 75 73 79 20 68 61 6e 64 6c 65   the busy handle
1b5e0 72 2e 20 20 49 6e 20 6f 74 68 65 72 20 77 6f 72  r.  In other wor
1b5f0 64 73 2c 0a 2a 2a 20 74 68 65 20 62 75 73 79 20  ds,.** the busy 
1b600 68 61 6e 64 6c 65 72 20 69 73 20 6e 6f 74 20 72  handler is not r
1b610 65 65 6e 74 72 61 6e 74 2e 20 20 41 6e 79 20 73  eentrant.  Any s
1b620 75 63 68 20 61 63 74 69 6f 6e 73 0a 2a 2a 20 72  uch actions.** r
1b630 65 73 75 6c 74 20 69 6e 20 75 6e 64 65 66 69 6e  esult in undefin
1b640 65 64 20 62 65 68 61 76 69 6f 72 2e 0a 2a 2a 20  ed behavior..** 
1b650 0a 2a 2a 20 41 20 62 75 73 79 20 68 61 6e 64 6c  .** A busy handl
1b660 65 72 20 6d 75 73 74 20 6e 6f 74 20 63 6c 6f 73  er must not clos
1b670 65 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63  e the database c
1b680 6f 6e 6e 65 63 74 69 6f 6e 0a 2a 2a 20 6f 72 20  onnection.** or 
1b690 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d  [prepared statem
1b6a0 65 6e 74 5d 20 74 68 61 74 20 69 6e 76 6f 6b 65  ent] that invoke
1b6b0 64 20 74 68 65 20 62 75 73 79 20 68 61 6e 64 6c  d the busy handl
1b6c0 65 72 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  er..*/.int sqlit
1b6d0 65 33 5f 62 75 73 79 5f 68 61 6e 64 6c 65 72 28  e3_busy_handler(
1b6e0 73 71 6c 69 74 65 33 2a 2c 69 6e 74 28 2a 29 28  sqlite3*,int(*)(
1b6f0 76 6f 69 64 2a 2c 69 6e 74 29 2c 76 6f 69 64 2a  void*,int),void*
1b700 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
1b710 45 46 3a 20 53 65 74 20 41 20 42 75 73 79 20 54  EF: Set A Busy T
1b720 69 6d 65 6f 75 74 0a 2a 2a 20 4d 45 54 48 4f 44  imeout.** METHOD
1b730 3a 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20  : sqlite3.**.** 
1b740 5e 54 68 69 73 20 72 6f 75 74 69 6e 65 20 73 65  ^This routine se
1b750 74 73 20 61 20 5b 73 71 6c 69 74 65 33 5f 62 75  ts a [sqlite3_bu
1b760 73 79 5f 68 61 6e 64 6c 65 72 20 7c 20 62 75 73  sy_handler | bus
1b770 79 20 68 61 6e 64 6c 65 72 5d 20 74 68 61 74 20  y handler] that 
1b780 73 6c 65 65 70 73 0a 2a 2a 20 66 6f 72 20 61 20  sleeps.** for a 
1b790 73 70 65 63 69 66 69 65 64 20 61 6d 6f 75 6e 74  specified amount
1b7a0 20 6f 66 20 74 69 6d 65 20 77 68 65 6e 20 61 20   of time when a 
1b7b0 74 61 62 6c 65 20 69 73 20 6c 6f 63 6b 65 64 2e  table is locked.
1b7c0 20 20 5e 54 68 65 20 68 61 6e 64 6c 65 72 0a 2a    ^The handler.*
1b7d0 2a 20 77 69 6c 6c 20 73 6c 65 65 70 20 6d 75 6c  * will sleep mul
1b7e0 74 69 70 6c 65 20 74 69 6d 65 73 20 75 6e 74 69  tiple times unti
1b7f0 6c 20 61 74 20 6c 65 61 73 74 20 22 6d 73 22 20  l at least "ms" 
1b800 6d 69 6c 6c 69 73 65 63 6f 6e 64 73 20 6f 66 20  milliseconds of 
1b810 73 6c 65 65 70 69 6e 67 0a 2a 2a 20 68 61 76 65  sleeping.** have
1b820 20 61 63 63 75 6d 75 6c 61 74 65 64 2e 20 20 5e   accumulated.  ^
1b830 41 66 74 65 72 20 61 74 20 6c 65 61 73 74 20 22  After at least "
1b840 6d 73 22 20 6d 69 6c 6c 69 73 65 63 6f 6e 64 73  ms" milliseconds
1b850 20 6f 66 20 73 6c 65 65 70 69 6e 67 2c 0a 2a 2a   of sleeping,.**
1b860 20 74 68 65 20 68 61 6e 64 6c 65 72 20 72 65 74   the handler ret
1b870 75 72 6e 73 20 30 20 77 68 69 63 68 20 63 61 75  urns 0 which cau
1b880 73 65 73 20 5b 73 71 6c 69 74 65 33 5f 73 74 65  ses [sqlite3_ste
1b890 70 28 29 5d 20 74 6f 20 72 65 74 75 72 6e 0a 2a  p()] to return.*
1b8a0 2a 20 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d 2e  * [SQLITE_BUSY].
1b8b0 0a 2a 2a 0a 2a 2a 20 5e 43 61 6c 6c 69 6e 67 20  .**.** ^Calling 
1b8c0 74 68 69 73 20 72 6f 75 74 69 6e 65 20 77 69 74  this routine wit
1b8d0 68 20 61 6e 20 61 72 67 75 6d 65 6e 74 20 6c 65  h an argument le
1b8e0 73 73 20 74 68 61 6e 20 6f 72 20 65 71 75 61 6c  ss than or equal
1b8f0 20 74 6f 20 7a 65 72 6f 0a 2a 2a 20 74 75 72 6e   to zero.** turn
1b900 73 20 6f 66 66 20 61 6c 6c 20 62 75 73 79 20 68  s off all busy h
1b910 61 6e 64 6c 65 72 73 2e 0a 2a 2a 0a 2a 2a 20 5e  andlers..**.** ^
1b920 28 54 68 65 72 65 20 63 61 6e 20 6f 6e 6c 79 20  (There can only 
1b930 62 65 20 61 20 73 69 6e 67 6c 65 20 62 75 73 79  be a single busy
1b940 20 68 61 6e 64 6c 65 72 20 66 6f 72 20 61 20 70   handler for a p
1b950 61 72 74 69 63 75 6c 61 72 0a 2a 2a 20 5b 64 61  articular.** [da
1b960 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
1b970 6e 5d 20 61 74 20 61 6e 79 20 67 69 76 65 6e 20  n] at any given 
1b980 6d 6f 6d 65 6e 74 2e 20 20 49 66 20 61 6e 6f 74  moment.  If anot
1b990 68 65 72 20 62 75 73 79 20 68 61 6e 64 6c 65 72  her busy handler
1b9a0 0a 2a 2a 20 77 61 73 20 64 65 66 69 6e 65 64 20  .** was defined 
1b9b0 20 28 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33   (using [sqlite3
1b9c0 5f 62 75 73 79 5f 68 61 6e 64 6c 65 72 28 29 5d  _busy_handler()]
1b9d0 29 20 70 72 69 6f 72 20 74 6f 20 63 61 6c 6c 69  ) prior to calli
1b9e0 6e 67 0a 2a 2a 20 74 68 69 73 20 72 6f 75 74 69  ng.** this routi
1b9f0 6e 65 2c 20 74 68 61 74 20 6f 74 68 65 72 20 62  ne, that other b
1ba00 75 73 79 20 68 61 6e 64 6c 65 72 20 69 73 20 63  usy handler is c
1ba10 6c 65 61 72 65 64 2e 29 5e 0a 2a 2a 0a 2a 2a 20  leared.)^.**.** 
1ba20 53 65 65 20 61 6c 73 6f 3a 20 20 5b 50 52 41 47  See also:  [PRAG
1ba30 4d 41 20 62 75 73 79 5f 74 69 6d 65 6f 75 74 5d  MA busy_timeout]
1ba40 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .*/.int sqlite3_
1ba50 62 75 73 79 5f 74 69 6d 65 6f 75 74 28 73 71 6c  busy_timeout(sql
1ba60 69 74 65 33 2a 2c 20 69 6e 74 20 6d 73 29 3b 0a  ite3*, int ms);.
1ba70 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
1ba80 20 43 6f 6e 76 65 6e 69 65 6e 63 65 20 52 6f 75   Convenience Rou
1ba90 74 69 6e 65 73 20 46 6f 72 20 52 75 6e 6e 69 6e  tines For Runnin
1baa0 67 20 51 75 65 72 69 65 73 0a 2a 2a 20 4d 45 54  g Queries.** MET
1bab0 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a 2a 0a  HOD: sqlite3.**.
1bac0 2a 2a 20 54 68 69 73 20 69 73 20 61 20 6c 65 67  ** This is a leg
1bad0 61 63 79 20 69 6e 74 65 72 66 61 63 65 20 74 68  acy interface th
1bae0 61 74 20 69 73 20 70 72 65 73 65 72 76 65 64 20  at is preserved 
1baf0 66 6f 72 20 62 61 63 6b 77 61 72 64 73 20 63 6f  for backwards co
1bb00 6d 70 61 74 69 62 69 6c 69 74 79 2e 0a 2a 2a 20  mpatibility..** 
1bb10 55 73 65 20 6f 66 20 74 68 69 73 20 69 6e 74 65  Use of this inte
1bb20 72 66 61 63 65 20 69 73 20 6e 6f 74 20 72 65 63  rface is not rec
1bb30 6f 6d 6d 65 6e 64 65 64 2e 0a 2a 2a 0a 2a 2a 20  ommended..**.** 
1bb40 44 65 66 69 6e 69 74 69 6f 6e 3a 20 41 20 3c 62  Definition: A <b
1bb50 3e 72 65 73 75 6c 74 20 74 61 62 6c 65 3c 2f 62  >result table</b
1bb60 3e 20 69 73 20 6d 65 6d 6f 72 79 20 64 61 74 61  > is memory data
1bb70 20 73 74 72 75 63 74 75 72 65 20 63 72 65 61 74   structure creat
1bb80 65 64 20 62 79 20 74 68 65 0a 2a 2a 20 5b 73 71  ed by the.** [sq
1bb90 6c 69 74 65 33 5f 67 65 74 5f 74 61 62 6c 65 28  lite3_get_table(
1bba0 29 5d 20 69 6e 74 65 72 66 61 63 65 2e 20 20 41  )] interface.  A
1bbb0 20 72 65 73 75 6c 74 20 74 61 62 6c 65 20 72 65   result table re
1bbc0 63 6f 72 64 73 20 74 68 65 0a 2a 2a 20 63 6f 6d  cords the.** com
1bbd0 70 6c 65 74 65 20 71 75 65 72 79 20 72 65 73 75  plete query resu
1bbe0 6c 74 73 20 66 72 6f 6d 20 6f 6e 65 20 6f 72 20  lts from one or 
1bbf0 6d 6f 72 65 20 71 75 65 72 69 65 73 2e 0a 2a 2a  more queries..**
1bc00 0a 2a 2a 20 54 68 65 20 74 61 62 6c 65 20 63 6f  .** The table co
1bc10 6e 63 65 70 74 75 61 6c 6c 79 20 68 61 73 20 61  nceptually has a
1bc20 20 6e 75 6d 62 65 72 20 6f 66 20 72 6f 77 73 20   number of rows 
1bc30 61 6e 64 20 63 6f 6c 75 6d 6e 73 2e 20 20 42 75  and columns.  Bu
1bc40 74 0a 2a 2a 20 74 68 65 73 65 20 6e 75 6d 62 65  t.** these numbe
1bc50 72 73 20 61 72 65 20 6e 6f 74 20 70 61 72 74 20  rs are not part 
1bc60 6f 66 20 74 68 65 20 72 65 73 75 6c 74 20 74 61  of the result ta
1bc70 62 6c 65 20 69 74 73 65 6c 66 2e 20 20 54 68 65  ble itself.  The
1bc80 73 65 0a 2a 2a 20 6e 75 6d 62 65 72 73 20 61 72  se.** numbers ar
1bc90 65 20 6f 62 74 61 69 6e 65 64 20 73 65 70 61 72  e obtained separ
1bca0 61 74 65 6c 79 2e 20 20 4c 65 74 20 4e 20 62 65  ately.  Let N be
1bcb0 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 72   the number of r
1bcc0 6f 77 73 0a 2a 2a 20 61 6e 64 20 4d 20 62 65 20  ows.** and M be 
1bcd0 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 63 6f  the number of co
1bce0 6c 75 6d 6e 73 2e 0a 2a 2a 0a 2a 2a 20 41 20 72  lumns..**.** A r
1bcf0 65 73 75 6c 74 20 74 61 62 6c 65 20 69 73 20 61  esult table is a
1bd00 6e 20 61 72 72 61 79 20 6f 66 20 70 6f 69 6e 74  n array of point
1bd10 65 72 73 20 74 6f 20 7a 65 72 6f 2d 74 65 72 6d  ers to zero-term
1bd20 69 6e 61 74 65 64 20 55 54 46 2d 38 20 73 74 72  inated UTF-8 str
1bd30 69 6e 67 73 2e 0a 2a 2a 20 54 68 65 72 65 20 61  ings..** There a
1bd40 72 65 20 28 4e 2b 31 29 2a 4d 20 65 6c 65 6d 65  re (N+1)*M eleme
1bd50 6e 74 73 20 69 6e 20 74 68 65 20 61 72 72 61 79  nts in the array
1bd60 2e 20 20 54 68 65 20 66 69 72 73 74 20 4d 20 70  .  The first M p
1bd70 6f 69 6e 74 65 72 73 20 70 6f 69 6e 74 0a 2a 2a  ointers point.**
1bd80 20 74 6f 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61   to zero-termina
1bd90 74 65 64 20 73 74 72 69 6e 67 73 20 74 68 61 74  ted strings that
1bda0 20 20 63 6f 6e 74 61 69 6e 20 74 68 65 20 6e 61    contain the na
1bdb0 6d 65 73 20 6f 66 20 74 68 65 20 63 6f 6c 75 6d  mes of the colum
1bdc0 6e 73 2e 0a 2a 2a 20 54 68 65 20 72 65 6d 61 69  ns..** The remai
1bdd0 6e 69 6e 67 20 65 6e 74 72 69 65 73 20 61 6c 6c  ning entries all
1bde0 20 70 6f 69 6e 74 20 74 6f 20 71 75 65 72 79 20   point to query 
1bdf0 72 65 73 75 6c 74 73 2e 20 20 4e 55 4c 4c 20 76  results.  NULL v
1be00 61 6c 75 65 73 20 72 65 73 75 6c 74 0a 2a 2a 20  alues result.** 
1be10 69 6e 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 73  in NULL pointers
1be20 2e 20 20 41 6c 6c 20 6f 74 68 65 72 20 76 61 6c  .  All other val
1be30 75 65 73 20 61 72 65 20 69 6e 20 74 68 65 69 72  ues are in their
1be40 20 55 54 46 2d 38 20 7a 65 72 6f 2d 74 65 72 6d   UTF-8 zero-term
1be50 69 6e 61 74 65 64 0a 2a 2a 20 73 74 72 69 6e 67  inated.** string
1be60 20 72 65 70 72 65 73 65 6e 74 61 74 69 6f 6e 20   representation 
1be70 61 73 20 72 65 74 75 72 6e 65 64 20 62 79 20 5b  as returned by [
1be80 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74  sqlite3_column_t
1be90 65 78 74 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 41 20  ext()]..**.** A 
1bea0 72 65 73 75 6c 74 20 74 61 62 6c 65 20 6d 69 67  result table mig
1beb0 68 74 20 63 6f 6e 73 69 73 74 20 6f 66 20 6f 6e  ht consist of on
1bec0 65 20 6f 72 20 6d 6f 72 65 20 6d 65 6d 6f 72 79  e or more memory
1bed0 20 61 6c 6c 6f 63 61 74 69 6f 6e 73 2e 0a 2a 2a   allocations..**
1bee0 20 49 74 20 69 73 20 6e 6f 74 20 73 61 66 65 20   It is not safe 
1bef0 74 6f 20 70 61 73 73 20 61 20 72 65 73 75 6c 74  to pass a result
1bf00 20 74 61 62 6c 65 20 64 69 72 65 63 74 6c 79 20   table directly 
1bf10 74 6f 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65  to [sqlite3_free
1bf20 28 29 5d 2e 0a 2a 2a 20 41 20 72 65 73 75 6c 74  ()]..** A result
1bf30 20 74 61 62 6c 65 20 73 68 6f 75 6c 64 20 62 65   table should be
1bf40 20 64 65 61 6c 6c 6f 63 61 74 65 64 20 75 73 69   deallocated usi
1bf50 6e 67 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65  ng [sqlite3_free
1bf60 5f 74 61 62 6c 65 28 29 5d 2e 0a 2a 2a 0a 2a 2a  _table()]..**.**
1bf70 20 5e 28 41 73 20 61 6e 20 65 78 61 6d 70 6c 65   ^(As an example
1bf80 20 6f 66 20 74 68 65 20 72 65 73 75 6c 74 20 74   of the result t
1bf90 61 62 6c 65 20 66 6f 72 6d 61 74 2c 20 73 75 70  able format, sup
1bfa0 70 6f 73 65 20 61 20 71 75 65 72 79 20 72 65 73  pose a query res
1bfb0 75 6c 74 0a 2a 2a 20 69 73 20 61 73 20 66 6f 6c  ult.** is as fol
1bfc0 6c 6f 77 73 3a 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f  lows:.**.** <blo
1bfd0 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 2a 2a  ckquote><pre>.**
1bfe0 20 20 20 20 20 20 20 20 4e 61 6d 65 20 20 20 20          Name    
1bff0 20 20 20 20 7c 20 41 67 65 0a 2a 2a 20 20 20 20      | Age.**    
1c000 20 20 20 20 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d      ------------
1c010 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 0a 2a 2a 20 20  -----------.**  
1c020 20 20 20 20 20 20 41 6c 69 63 65 20 20 20 20 20        Alice     
1c030 20 20 7c 20 34 33 0a 2a 2a 20 20 20 20 20 20 20    | 43.**       
1c040 20 42 6f 62 20 20 20 20 20 20 20 20 20 7c 20 32   Bob         | 2
1c050 38 0a 2a 2a 20 20 20 20 20 20 20 20 43 69 6e 64  8.**        Cind
1c060 79 20 20 20 20 20 20 20 7c 20 32 31 0a 2a 2a 20  y       | 21.** 
1c070 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f  </pre></blockquo
1c080 74 65 3e 0a 2a 2a 0a 2a 2a 20 54 68 65 72 65 20  te>.**.** There 
1c090 61 72 65 20 74 77 6f 20 63 6f 6c 75 6d 6e 20 28  are two column (
1c0a0 4d 3d 3d 32 29 20 61 6e 64 20 74 68 72 65 65 20  M==2) and three 
1c0b0 72 6f 77 73 20 28 4e 3d 3d 33 29 2e 20 20 54 68  rows (N==3).  Th
1c0c0 75 73 20 74 68 65 0a 2a 2a 20 72 65 73 75 6c 74  us the.** result
1c0d0 20 74 61 62 6c 65 20 68 61 73 20 38 20 65 6e 74   table has 8 ent
1c0e0 72 69 65 73 2e 20 20 53 75 70 70 6f 73 65 20 74  ries.  Suppose t
1c0f0 68 65 20 72 65 73 75 6c 74 20 74 61 62 6c 65 20  he result table 
1c100 69 73 20 73 74 6f 72 65 64 0a 2a 2a 20 69 6e 20  is stored.** in 
1c110 61 6e 20 61 72 72 61 79 20 6e 61 6d 65 73 20 61  an array names a
1c120 7a 52 65 73 75 6c 74 2e 20 20 54 68 65 6e 20 61  zResult.  Then a
1c130 7a 52 65 73 75 6c 74 20 68 6f 6c 64 73 20 74 68  zResult holds th
1c140 69 73 20 63 6f 6e 74 65 6e 74 3a 0a 2a 2a 0a 2a  is content:.**.*
1c150 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70  * <blockquote><p
1c160 72 65 3e 0a 2a 2a 20 20 20 20 20 20 20 20 61 7a  re>.**        az
1c170 52 65 73 75 6c 74 26 23 39 31 3b 30 5d 20 3d 20  Result&#91;0] = 
1c180 22 4e 61 6d 65 22 3b 0a 2a 2a 20 20 20 20 20 20  "Name";.**      
1c190 20 20 61 7a 52 65 73 75 6c 74 26 23 39 31 3b 31    azResult&#91;1
1c1a0 5d 20 3d 20 22 41 67 65 22 3b 0a 2a 2a 20 20 20  ] = "Age";.**   
1c1b0 20 20 20 20 20 61 7a 52 65 73 75 6c 74 26 23 39       azResult&#9
1c1c0 31 3b 32 5d 20 3d 20 22 41 6c 69 63 65 22 3b 0a  1;2] = "Alice";.
1c1d0 2a 2a 20 20 20 20 20 20 20 20 61 7a 52 65 73 75  **        azResu
1c1e0 6c 74 26 23 39 31 3b 33 5d 20 3d 20 22 34 33 22  lt&#91;3] = "43"
1c1f0 3b 0a 2a 2a 20 20 20 20 20 20 20 20 61 7a 52 65  ;.**        azRe
1c200 73 75 6c 74 26 23 39 31 3b 34 5d 20 3d 20 22 42  sult&#91;4] = "B
1c210 6f 62 22 3b 0a 2a 2a 20 20 20 20 20 20 20 20 61  ob";.**        a
1c220 7a 52 65 73 75 6c 74 26 23 39 31 3b 35 5d 20 3d  zResult&#91;5] =
1c230 20 22 32 38 22 3b 0a 2a 2a 20 20 20 20 20 20 20   "28";.**       
1c240 20 61 7a 52 65 73 75 6c 74 26 23 39 31 3b 36 5d   azResult&#91;6]
1c250 20 3d 20 22 43 69 6e 64 79 22 3b 0a 2a 2a 20 20   = "Cindy";.**  
1c260 20 20 20 20 20 20 61 7a 52 65 73 75 6c 74 26 23        azResult&#
1c270 39 31 3b 37 5d 20 3d 20 22 32 31 22 3b 0a 2a 2a  91;7] = "21";.**
1c280 20 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75   </pre></blockqu
1c290 6f 74 65 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 54 68  ote>)^.**.** ^Th
1c2a0 65 20 73 71 6c 69 74 65 33 5f 67 65 74 5f 74 61  e sqlite3_get_ta
1c2b0 62 6c 65 28 29 20 66 75 6e 63 74 69 6f 6e 20 65  ble() function e
1c2c0 76 61 6c 75 61 74 65 73 20 6f 6e 65 20 6f 72 20  valuates one or 
1c2d0 6d 6f 72 65 0a 2a 2a 20 73 65 6d 69 63 6f 6c 6f  more.** semicolo
1c2e0 6e 2d 73 65 70 61 72 61 74 65 64 20 53 51 4c 20  n-separated SQL 
1c2f0 73 74 61 74 65 6d 65 6e 74 73 20 69 6e 20 74 68  statements in th
1c300 65 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65  e zero-terminate
1c310 64 20 55 54 46 2d 38 0a 2a 2a 20 73 74 72 69 6e  d UTF-8.** strin
1c320 67 20 6f 66 20 69 74 73 20 32 6e 64 20 70 61 72  g of its 2nd par
1c330 61 6d 65 74 65 72 20 61 6e 64 20 72 65 74 75 72  ameter and retur
1c340 6e 73 20 61 20 72 65 73 75 6c 74 20 74 61 62 6c  ns a result tabl
1c350 65 20 74 6f 20 74 68 65 0a 2a 2a 20 70 6f 69 6e  e to the.** poin
1c360 74 65 72 20 67 69 76 65 6e 20 69 6e 20 69 74 73  ter given in its
1c370 20 33 72 64 20 70 61 72 61 6d 65 74 65 72 2e 0a   3rd parameter..
1c380 2a 2a 0a 2a 2a 20 41 66 74 65 72 20 74 68 65 20  **.** After the 
1c390 61 70 70 6c 69 63 61 74 69 6f 6e 20 68 61 73 20  application has 
1c3a0 66 69 6e 69 73 68 65 64 20 77 69 74 68 20 74 68  finished with th
1c3b0 65 20 72 65 73 75 6c 74 20 66 72 6f 6d 20 73 71  e result from sq
1c3c0 6c 69 74 65 33 5f 67 65 74 5f 74 61 62 6c 65 28  lite3_get_table(
1c3d0 29 2c 0a 2a 2a 20 69 74 20 6d 75 73 74 20 70 61  ),.** it must pa
1c3e0 73 73 20 74 68 65 20 72 65 73 75 6c 74 20 74 61  ss the result ta
1c3f0 62 6c 65 20 70 6f 69 6e 74 65 72 20 74 6f 20 73  ble pointer to s
1c400 71 6c 69 74 65 33 5f 66 72 65 65 5f 74 61 62 6c  qlite3_free_tabl
1c410 65 28 29 20 69 6e 20 6f 72 64 65 72 20 74 6f 0a  e() in order to.
1c420 2a 2a 20 72 65 6c 65 61 73 65 20 74 68 65 20 6d  ** release the m
1c430 65 6d 6f 72 79 20 74 68 61 74 20 77 61 73 20 6d  emory that was m
1c440 61 6c 6c 6f 63 65 64 2e 20 20 42 65 63 61 75 73  alloced.  Becaus
1c450 65 20 6f 66 20 74 68 65 20 77 61 79 20 74 68 65  e of the way the
1c460 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c  .** [sqlite3_mal
1c470 6c 6f 63 28 29 5d 20 68 61 70 70 65 6e 73 20 77  loc()] happens w
1c480 69 74 68 69 6e 20 73 71 6c 69 74 65 33 5f 67 65  ithin sqlite3_ge
1c490 74 5f 74 61 62 6c 65 28 29 2c 20 74 68 65 20 63  t_table(), the c
1c4a0 61 6c 6c 69 6e 67 0a 2a 2a 20 66 75 6e 63 74 69  alling.** functi
1c4b0 6f 6e 20 6d 75 73 74 20 6e 6f 74 20 74 72 79 20  on must not try 
1c4c0 74 6f 20 63 61 6c 6c 20 5b 73 71 6c 69 74 65 33  to call [sqlite3
1c4d0 5f 66 72 65 65 28 29 5d 20 64 69 72 65 63 74 6c  _free()] directl
1c4e0 79 2e 20 20 4f 6e 6c 79 0a 2a 2a 20 5b 73 71 6c  y.  Only.** [sql
1c4f0 69 74 65 33 5f 66 72 65 65 5f 74 61 62 6c 65 28  ite3_free_table(
1c500 29 5d 20 69 73 20 61 62 6c 65 20 74 6f 20 72 65  )] is able to re
1c510 6c 65 61 73 65 20 74 68 65 20 6d 65 6d 6f 72 79  lease the memory
1c520 20 70 72 6f 70 65 72 6c 79 20 61 6e 64 20 73 61   properly and sa
1c530 66 65 6c 79 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  fely..**.** The 
1c540 73 71 6c 69 74 65 33 5f 67 65 74 5f 74 61 62 6c  sqlite3_get_tabl
1c550 65 28 29 20 69 6e 74 65 72 66 61 63 65 20 69 73  e() interface is
1c560 20 69 6d 70 6c 65 6d 65 6e 74 65 64 20 61 73 20   implemented as 
1c570 61 20 77 72 61 70 70 65 72 20 61 72 6f 75 6e 64  a wrapper around
1c580 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 65 78 65  .** [sqlite3_exe
1c590 63 28 29 5d 2e 20 20 54 68 65 20 73 71 6c 69 74  c()].  The sqlit
1c5a0 65 33 5f 67 65 74 5f 74 61 62 6c 65 28 29 20 72  e3_get_table() r
1c5b0 6f 75 74 69 6e 65 20 64 6f 65 73 20 6e 6f 74 20  outine does not 
1c5c0 68 61 76 65 20 61 63 63 65 73 73 0a 2a 2a 20 74  have access.** t
1c5d0 6f 20 61 6e 79 20 69 6e 74 65 72 6e 61 6c 20 64  o any internal d
1c5e0 61 74 61 20 73 74 72 75 63 74 75 72 65 73 20 6f  ata structures o
1c5f0 66 20 53 51 4c 69 74 65 2e 20 20 49 74 20 75 73  f SQLite.  It us
1c600 65 73 20 6f 6e 6c 79 20 74 68 65 20 70 75 62 6c  es only the publ
1c610 69 63 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20  ic.** interface 
1c620 64 65 66 69 6e 65 64 20 68 65 72 65 2e 20 20 41  defined here.  A
1c630 73 20 61 20 63 6f 6e 73 65 71 75 65 6e 63 65 2c  s a consequence,
1c640 20 65 72 72 6f 72 73 20 74 68 61 74 20 6f 63 63   errors that occ
1c650 75 72 20 69 6e 20 74 68 65 0a 2a 2a 20 77 72 61  ur in the.** wra
1c660 70 70 65 72 20 6c 61 79 65 72 20 6f 75 74 73 69  pper layer outsi
1c670 64 65 20 6f 66 20 74 68 65 20 69 6e 74 65 72 6e  de of the intern
1c680 61 6c 20 5b 73 71 6c 69 74 65 33 5f 65 78 65 63  al [sqlite3_exec
1c690 28 29 5d 20 63 61 6c 6c 20 61 72 65 20 6e 6f 74  ()] call are not
1c6a0 0a 2a 2a 20 72 65 66 6c 65 63 74 65 64 20 69 6e  .** reflected in
1c6b0 20 73 75 62 73 65 71 75 65 6e 74 20 63 61 6c 6c   subsequent call
1c6c0 73 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 65 72  s to [sqlite3_er
1c6d0 72 63 6f 64 65 28 29 5d 20 6f 72 0a 2a 2a 20 5b  rcode()] or.** [
1c6e0 73 71 6c 69 74 65 33 5f 65 72 72 6d 73 67 28 29  sqlite3_errmsg()
1c6f0 5d 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  ]..*/.int sqlite
1c700 33 5f 67 65 74 5f 74 61 62 6c 65 28 0a 20 20 73  3_get_table(.  s
1c710 71 6c 69 74 65 33 20 2a 64 62 2c 20 20 20 20 20  qlite3 *db,     
1c720 20 20 20 20 20 2f 2a 20 41 6e 20 6f 70 65 6e 20       /* An open 
1c730 64 61 74 61 62 61 73 65 20 2a 2f 0a 20 20 63 6f  database */.  co
1c740 6e 73 74 20 63 68 61 72 20 2a 7a 53 71 6c 2c 20  nst char *zSql, 
1c750 20 20 20 20 2f 2a 20 53 51 4c 20 74 6f 20 62 65      /* SQL to be
1c760 20 65 76 61 6c 75 61 74 65 64 20 2a 2f 0a 20 20   evaluated */.  
1c770 63 68 61 72 20 2a 2a 2a 70 61 7a 52 65 73 75 6c  char ***pazResul
1c780 74 2c 20 20 20 20 2f 2a 20 52 65 73 75 6c 74 73  t,    /* Results
1c790 20 6f 66 20 74 68 65 20 71 75 65 72 79 20 2a 2f   of the query */
1c7a0 0a 20 20 69 6e 74 20 2a 70 6e 52 6f 77 2c 20 20  .  int *pnRow,  
1c7b0 20 20 20 20 20 20 20 20 20 2f 2a 20 4e 75 6d 62           /* Numb
1c7c0 65 72 20 6f 66 20 72 65 73 75 6c 74 20 72 6f 77  er of result row
1c7d0 73 20 77 72 69 74 74 65 6e 20 68 65 72 65 20 2a  s written here *
1c7e0 2f 0a 20 20 69 6e 74 20 2a 70 6e 43 6f 6c 75 6d  /.  int *pnColum
1c7f0 6e 2c 20 20 20 20 20 20 20 20 2f 2a 20 4e 75 6d  n,        /* Num
1c800 62 65 72 20 6f 66 20 72 65 73 75 6c 74 20 63 6f  ber of result co
1c810 6c 75 6d 6e 73 20 77 72 69 74 74 65 6e 20 68 65  lumns written he
1c820 72 65 20 2a 2f 0a 20 20 63 68 61 72 20 2a 2a 70  re */.  char **p
1c830 7a 45 72 72 6d 73 67 20 20 20 20 20 20 20 2f 2a  zErrmsg       /*
1c840 20 45 72 72 6f 72 20 6d 73 67 20 77 72 69 74 74   Error msg writt
1c850 65 6e 20 68 65 72 65 20 2a 2f 0a 29 3b 0a 76 6f  en here */.);.vo
1c860 69 64 20 73 71 6c 69 74 65 33 5f 66 72 65 65 5f  id sqlite3_free_
1c870 74 61 62 6c 65 28 63 68 61 72 20 2a 2a 72 65 73  table(char **res
1c880 75 6c 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  ult);../*.** CAP
1c890 49 33 52 45 46 3a 20 46 6f 72 6d 61 74 74 65 64  I3REF: Formatted
1c8a0 20 53 74 72 69 6e 67 20 50 72 69 6e 74 69 6e 67   String Printing
1c8b0 20 46 75 6e 63 74 69 6f 6e 73 0a 2a 2a 0a 2a 2a   Functions.**.**
1c8c0 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20   These routines 
1c8d0 61 72 65 20 77 6f 72 6b 2d 61 6c 69 6b 65 73 20  are work-alikes 
1c8e0 6f 66 20 74 68 65 20 22 70 72 69 6e 74 66 28 29  of the "printf()
1c8f0 22 20 66 61 6d 69 6c 79 20 6f 66 20 66 75 6e 63  " family of func
1c900 74 69 6f 6e 73 0a 2a 2a 20 66 72 6f 6d 20 74 68  tions.** from th
1c910 65 20 73 74 61 6e 64 61 72 64 20 43 20 6c 69 62  e standard C lib
1c920 72 61 72 79 2e 0a 2a 2a 20 54 68 65 73 65 20 72  rary..** These r
1c930 6f 75 74 69 6e 65 73 20 75 6e 64 65 72 73 74 61  outines understa
1c940 6e 64 20 6d 6f 73 74 20 6f 66 20 74 68 65 20 63  nd most of the c
1c950 6f 6d 6d 6f 6e 20 4b 26 52 20 66 6f 72 6d 61 74  ommon K&R format
1c960 74 69 6e 67 20 6f 70 74 69 6f 6e 73 2c 0a 2a 2a  ting options,.**
1c970 20 70 6c 75 73 20 73 6f 6d 65 20 61 64 64 69 74   plus some addit
1c980 69 6f 6e 61 6c 20 6e 6f 6e 2d 73 74 61 6e 64 61  ional non-standa
1c990 72 64 20 66 6f 72 6d 61 74 73 2c 20 64 65 74 61  rd formats, deta
1c9a0 69 6c 65 64 20 62 65 6c 6f 77 2e 0a 2a 2a 20 4e  iled below..** N
1c9b0 6f 74 65 20 74 68 61 74 20 73 6f 6d 65 20 6f 66  ote that some of
1c9c0 20 74 68 65 20 6d 6f 72 65 20 6f 62 73 63 75 72   the more obscur
1c9d0 65 20 66 6f 72 6d 61 74 74 69 6e 67 20 6f 70 74  e formatting opt
1c9e0 69 6f 6e 73 20 66 72 6f 6d 20 72 65 63 65 6e 74  ions from recent
1c9f0 0a 2a 2a 20 43 2d 6c 69 62 72 61 72 79 20 73 74  .** C-library st
1ca00 61 6e 64 61 72 64 73 20 61 72 65 20 6f 6d 69 74  andards are omit
1ca10 74 65 64 20 66 72 6f 6d 20 74 68 69 73 20 69 6d  ted from this im
1ca20 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 2e 0a 2a 2a  plementation..**
1ca30 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33  .** ^The sqlite3
1ca40 5f 6d 70 72 69 6e 74 66 28 29 20 61 6e 64 20 73  _mprintf() and s
1ca50 71 6c 69 74 65 33 5f 76 6d 70 72 69 6e 74 66 28  qlite3_vmprintf(
1ca60 29 20 72 6f 75 74 69 6e 65 73 20 77 72 69 74 65  ) routines write
1ca70 20 74 68 65 69 72 0a 2a 2a 20 72 65 73 75 6c 74   their.** result
1ca80 73 20 69 6e 74 6f 20 6d 65 6d 6f 72 79 20 6f 62  s into memory ob
1ca90 74 61 69 6e 65 64 20 66 72 6f 6d 20 5b 73 71 6c  tained from [sql
1caa0 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 2e 0a  ite3_malloc()]..
1cab0 2a 2a 20 54 68 65 20 73 74 72 69 6e 67 73 20 72  ** The strings r
1cac0 65 74 75 72 6e 65 64 20 62 79 20 74 68 65 73 65  eturned by these
1cad0 20 74 77 6f 20 72 6f 75 74 69 6e 65 73 20 73 68   two routines sh
1cae0 6f 75 6c 64 20 62 65 0a 2a 2a 20 72 65 6c 65 61  ould be.** relea
1caf0 73 65 64 20 62 79 20 5b 73 71 6c 69 74 65 33 5f  sed by [sqlite3_
1cb00 66 72 65 65 28 29 5d 2e 20 20 5e 42 6f 74 68 20  free()].  ^Both 
1cb10 72 6f 75 74 69 6e 65 73 20 72 65 74 75 72 6e 20  routines return 
1cb20 61 0a 2a 2a 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  a.** NULL pointe
1cb30 72 20 69 66 20 5b 73 71 6c 69 74 65 33 5f 6d 61  r if [sqlite3_ma
1cb40 6c 6c 6f 63 28 29 5d 20 69 73 20 75 6e 61 62 6c  lloc()] is unabl
1cb50 65 20 74 6f 20 61 6c 6c 6f 63 61 74 65 20 65 6e  e to allocate en
1cb60 6f 75 67 68 0a 2a 2a 20 6d 65 6d 6f 72 79 20 74  ough.** memory t
1cb70 6f 20 68 6f 6c 64 20 74 68 65 20 72 65 73 75 6c  o hold the resul
1cb80 74 69 6e 67 20 73 74 72 69 6e 67 2e 0a 2a 2a 0a  ting string..**.
1cb90 2a 2a 20 5e 28 54 68 65 20 73 71 6c 69 74 65 33  ** ^(The sqlite3
1cba0 5f 73 6e 70 72 69 6e 74 66 28 29 20 72 6f 75 74  _snprintf() rout
1cbb0 69 6e 65 20 69 73 20 73 69 6d 69 6c 61 72 20 74  ine is similar t
1cbc0 6f 20 22 73 6e 70 72 69 6e 74 66 28 29 22 20 66  o "snprintf()" f
1cbd0 72 6f 6d 0a 2a 2a 20 74 68 65 20 73 74 61 6e 64  rom.** the stand
1cbe0 61 72 64 20 43 20 6c 69 62 72 61 72 79 2e 20 20  ard C library.  
1cbf0 54 68 65 20 72 65 73 75 6c 74 20 69 73 20 77 72  The result is wr
1cc00 69 74 74 65 6e 20 69 6e 74 6f 20 74 68 65 0a 2a  itten into the.*
1cc10 2a 20 62 75 66 66 65 72 20 73 75 70 70 6c 69 65  * buffer supplie
1cc20 64 20 61 73 20 74 68 65 20 73 65 63 6f 6e 64 20  d as the second 
1cc30 70 61 72 61 6d 65 74 65 72 20 77 68 6f 73 65 20  parameter whose 
1cc40 73 69 7a 65 20 69 73 20 67 69 76 65 6e 20 62 79  size is given by
1cc50 0a 2a 2a 20 74 68 65 20 66 69 72 73 74 20 70 61  .** the first pa
1cc60 72 61 6d 65 74 65 72 2e 20 4e 6f 74 65 20 74 68  rameter. Note th
1cc70 61 74 20 74 68 65 20 6f 72 64 65 72 20 6f 66 20  at the order of 
1cc80 74 68 65 0a 2a 2a 20 66 69 72 73 74 20 74 77 6f  the.** first two
1cc90 20 70 61 72 61 6d 65 74 65 72 73 20 69 73 20 72   parameters is r
1cca0 65 76 65 72 73 65 64 20 66 72 6f 6d 20 73 6e 70  eversed from snp
1ccb0 72 69 6e 74 66 28 29 2e 29 5e 20 20 54 68 69 73  rintf().)^  This
1ccc0 20 69 73 20 61 6e 0a 2a 2a 20 68 69 73 74 6f 72   is an.** histor
1ccd0 69 63 61 6c 20 61 63 63 69 64 65 6e 74 20 74 68  ical accident th
1cce0 61 74 20 63 61 6e 6e 6f 74 20 62 65 20 66 69 78  at cannot be fix
1ccf0 65 64 20 77 69 74 68 6f 75 74 20 62 72 65 61 6b  ed without break
1cd00 69 6e 67 0a 2a 2a 20 62 61 63 6b 77 61 72 64 73  ing.** backwards
1cd10 20 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 2e 20   compatibility. 
1cd20 20 5e 28 4e 6f 74 65 20 61 6c 73 6f 20 74 68 61   ^(Note also tha
1cd30 74 20 73 71 6c 69 74 65 33 5f 73 6e 70 72 69 6e  t sqlite3_snprin
1cd40 74 66 28 29 0a 2a 2a 20 72 65 74 75 72 6e 73 20  tf().** returns 
1cd50 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 69 74 73  a pointer to its
1cd60 20 62 75 66 66 65 72 20 69 6e 73 74 65 61 64 20   buffer instead 
1cd70 6f 66 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  of the number of
1cd80 0a 2a 2a 20 63 68 61 72 61 63 74 65 72 73 20 61  .** characters a
1cd90 63 74 75 61 6c 6c 79 20 77 72 69 74 74 65 6e 20  ctually written 
1cda0 69 6e 74 6f 20 74 68 65 20 62 75 66 66 65 72 2e  into the buffer.
1cdb0 29 5e 20 20 57 65 20 61 64 6d 69 74 20 74 68 61  )^  We admit tha
1cdc0 74 0a 2a 2a 20 74 68 65 20 6e 75 6d 62 65 72 20  t.** the number 
1cdd0 6f 66 20 63 68 61 72 61 63 74 65 72 73 20 77 72  of characters wr
1cde0 69 74 74 65 6e 20 77 6f 75 6c 64 20 62 65 20 61  itten would be a
1cdf0 20 6d 6f 72 65 20 75 73 65 66 75 6c 20 72 65 74   more useful ret
1ce00 75 72 6e 0a 2a 2a 20 76 61 6c 75 65 20 62 75 74  urn.** value but
1ce10 20 77 65 20 63 61 6e 6e 6f 74 20 63 68 61 6e 67   we cannot chang
1ce20 65 20 74 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61  e the implementa
1ce30 74 69 6f 6e 20 6f 66 20 73 71 6c 69 74 65 33 5f  tion of sqlite3_
1ce40 73 6e 70 72 69 6e 74 66 28 29 0a 2a 2a 20 6e 6f  snprintf().** no
1ce50 77 20 77 69 74 68 6f 75 74 20 62 72 65 61 6b 69  w without breaki
1ce60 6e 67 20 63 6f 6d 70 61 74 69 62 69 6c 69 74 79  ng compatibility
1ce70 2e 0a 2a 2a 0a 2a 2a 20 5e 41 73 20 6c 6f 6e 67  ..**.** ^As long
1ce80 20 61 73 20 74 68 65 20 62 75 66 66 65 72 20 73   as the buffer s
1ce90 69 7a 65 20 69 73 20 67 72 65 61 74 65 72 20 74  ize is greater t
1cea0 68 61 6e 20 7a 65 72 6f 2c 20 73 71 6c 69 74 65  han zero, sqlite
1ceb0 33 5f 73 6e 70 72 69 6e 74 66 28 29 0a 2a 2a 20  3_snprintf().** 
1cec0 67 75 61 72 61 6e 74 65 65 73 20 74 68 61 74 20  guarantees that 
1ced0 74 68 65 20 62 75 66 66 65 72 20 69 73 20 61 6c  the buffer is al
1cee0 77 61 79 73 20 7a 65 72 6f 2d 74 65 72 6d 69 6e  ways zero-termin
1cef0 61 74 65 64 2e 20 20 5e 54 68 65 20 66 69 72 73  ated.  ^The firs
1cf00 74 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72 20 22  t.** parameter "
1cf10 6e 22 20 69 73 20 74 68 65 20 74 6f 74 61 6c 20  n" is the total 
1cf20 73 69 7a 65 20 6f 66 20 74 68 65 20 62 75 66 66  size of the buff
1cf30 65 72 2c 20 69 6e 63 6c 75 64 69 6e 67 20 73 70  er, including sp
1cf40 61 63 65 20 66 6f 72 0a 2a 2a 20 74 68 65 20 7a  ace for.** the z
1cf50 65 72 6f 20 74 65 72 6d 69 6e 61 74 6f 72 2e 20  ero terminator. 
1cf60 20 53 6f 20 74 68 65 20 6c 6f 6e 67 65 73 74 20   So the longest 
1cf70 73 74 72 69 6e 67 20 74 68 61 74 20 63 61 6e 20  string that can 
1cf80 62 65 20 63 6f 6d 70 6c 65 74 65 6c 79 0a 2a 2a  be completely.**
1cf90 20 77 72 69 74 74 65 6e 20 77 69 6c 6c 20 62 65   written will be
1cfa0 20 6e 2d 31 20 63 68 61 72 61 63 74 65 72 73 2e   n-1 characters.
1cfb0 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69  .**.** ^The sqli
1cfc0 74 65 33 5f 76 73 6e 70 72 69 6e 74 66 28 29 20  te3_vsnprintf() 
1cfd0 72 6f 75 74 69 6e 65 20 69 73 20 61 20 76 61 72  routine is a var
1cfe0 61 72 67 73 20 76 65 72 73 69 6f 6e 20 6f 66 20  args version of 
1cff0 73 71 6c 69 74 65 33 5f 73 6e 70 72 69 6e 74 66  sqlite3_snprintf
1d000 28 29 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20  ()..**.** These 
1d010 72 6f 75 74 69 6e 65 73 20 61 6c 6c 20 69 6d 70  routines all imp
1d020 6c 65 6d 65 6e 74 20 73 6f 6d 65 20 61 64 64 69  lement some addi
1d030 74 69 6f 6e 61 6c 20 66 6f 72 6d 61 74 74 69 6e  tional formattin
1d040 67 0a 2a 2a 20 6f 70 74 69 6f 6e 73 20 74 68 61  g.** options tha
1d050 74 20 61 72 65 20 75 73 65 66 75 6c 20 66 6f 72  t are useful for
1d060 20 63 6f 6e 73 74 72 75 63 74 69 6e 67 20 53 51   constructing SQ
1d070 4c 20 73 74 61 74 65 6d 65 6e 74 73 2e 0a 2a 2a  L statements..**
1d080 20 41 6c 6c 20 6f 66 20 74 68 65 20 75 73 75 61   All of the usua
1d090 6c 20 70 72 69 6e 74 66 28 29 20 66 6f 72 6d 61  l printf() forma
1d0a0 74 74 69 6e 67 20 6f 70 74 69 6f 6e 73 20 61 70  tting options ap
1d0b0 70 6c 79 2e 20 20 49 6e 20 61 64 64 69 74 69 6f  ply.  In additio
1d0c0 6e 2c 20 74 68 65 72 65 0a 2a 2a 20 69 73 20 61  n, there.** is a
1d0d0 72 65 20 22 25 71 22 2c 20 22 25 51 22 2c 20 22  re "%q", "%Q", "
1d0e0 25 77 22 20 61 6e 64 20 22 25 7a 22 20 6f 70 74  %w" and "%z" opt
1d0f0 69 6f 6e 73 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68  ions..**.** ^(Th
1d100 65 20 25 71 20 6f 70 74 69 6f 6e 20 77 6f 72 6b  e %q option work
1d110 73 20 6c 69 6b 65 20 25 73 20 69 6e 20 74 68 61  s like %s in tha
1d120 74 20 69 74 20 73 75 62 73 74 69 74 75 74 65 73  t it substitutes
1d130 20 61 20 6e 75 6c 2d 74 65 72 6d 69 6e 61 74 65   a nul-terminate
1d140 64 0a 2a 2a 20 73 74 72 69 6e 67 20 66 72 6f 6d  d.** string from
1d150 20 74 68 65 20 61 72 67 75 6d 65 6e 74 20 6c 69   the argument li
1d160 73 74 2e 20 20 42 75 74 20 25 71 20 61 6c 73 6f  st.  But %q also
1d170 20 64 6f 75 62 6c 65 73 20 65 76 65 72 79 20 27   doubles every '
1d180 5c 27 27 20 63 68 61 72 61 63 74 65 72 2e 0a 2a  \'' character..*
1d190 2a 20 25 71 20 69 73 20 64 65 73 69 67 6e 65 64  * %q is designed
1d1a0 20 66 6f 72 20 75 73 65 20 69 6e 73 69 64 65 20   for use inside 
1d1b0 61 20 73 74 72 69 6e 67 20 6c 69 74 65 72 61 6c  a string literal
1d1c0 2e 29 5e 20 20 42 79 20 64 6f 75 62 6c 69 6e 67  .)^  By doubling
1d1d0 20 65 61 63 68 20 27 5c 27 27 0a 2a 2a 20 63 68   each '\''.** ch
1d1e0 61 72 61 63 74 65 72 20 69 74 20 65 73 63 61 70  aracter it escap
1d1f0 65 73 20 74 68 61 74 20 63 68 61 72 61 63 74 65  es that characte
1d200 72 20 61 6e 64 20 61 6c 6c 6f 77 73 20 69 74 20  r and allows it 
1d210 74 6f 20 62 65 20 69 6e 73 65 72 74 65 64 20 69  to be inserted i
1d220 6e 74 6f 0a 2a 2a 20 74 68 65 20 73 74 72 69 6e  nto.** the strin
1d230 67 2e 0a 2a 2a 0a 2a 2a 20 46 6f 72 20 65 78 61  g..**.** For exa
1d240 6d 70 6c 65 2c 20 61 73 73 75 6d 65 20 74 68 65  mple, assume the
1d250 20 73 74 72 69 6e 67 20 76 61 72 69 61 62 6c 65   string variable
1d260 20 7a 54 65 78 74 20 63 6f 6e 74 61 69 6e 73 20   zText contains 
1d270 74 65 78 74 20 61 73 20 66 6f 6c 6c 6f 77 73 3a  text as follows:
1d280 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f  .**.** <blockquo
1d290 74 65 3e 3c 70 72 65 3e 0a 2a 2a 20 20 63 68 61  te><pre>.**  cha
1d2a0 72 20 2a 7a 54 65 78 74 20 3d 20 22 49 74 27 73  r *zText = "It's
1d2b0 20 61 20 68 61 70 70 79 20 64 61 79 21 22 3b 0a   a happy day!";.
1d2c0 2a 2a 20 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b  ** </pre></block
1d2d0 71 75 6f 74 65 3e 0a 2a 2a 0a 2a 2a 20 4f 6e 65  quote>.**.** One
1d2e0 20 63 61 6e 20 75 73 65 20 74 68 69 73 20 74 65   can use this te
1d2f0 78 74 20 69 6e 20 61 6e 20 53 51 4c 20 73 74 61  xt in an SQL sta
1d300 74 65 6d 65 6e 74 20 61 73 20 66 6f 6c 6c 6f 77  tement as follow
1d310 73 3a 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71  s:.**.** <blockq
1d320 75 6f 74 65 3e 3c 70 72 65 3e 0a 2a 2a 20 20 63  uote><pre>.**  c
1d330 68 61 72 20 2a 7a 53 51 4c 20 3d 20 73 71 6c 69  har *zSQL = sqli
1d340 74 65 33 5f 6d 70 72 69 6e 74 66 28 22 49 4e 53  te3_mprintf("INS
1d350 45 52 54 20 49 4e 54 4f 20 74 61 62 6c 65 20 56  ERT INTO table V
1d360 41 4c 55 45 53 28 27 25 71 27 29 22 2c 20 7a 54  ALUES('%q')", zT
1d370 65 78 74 29 3b 0a 2a 2a 20 20 73 71 6c 69 74 65  ext);.**  sqlite
1d380 33 5f 65 78 65 63 28 64 62 2c 20 7a 53 51 4c 2c  3_exec(db, zSQL,
1d390 20 30 2c 20 30 2c 20 30 29 3b 0a 2a 2a 20 20 73   0, 0, 0);.**  s
1d3a0 71 6c 69 74 65 33 5f 66 72 65 65 28 7a 53 51 4c  qlite3_free(zSQL
1d3b0 29 3b 0a 2a 2a 20 3c 2f 70 72 65 3e 3c 2f 62 6c  );.** </pre></bl
1d3c0 6f 63 6b 71 75 6f 74 65 3e 0a 2a 2a 0a 2a 2a 20  ockquote>.**.** 
1d3d0 42 65 63 61 75 73 65 20 74 68 65 20 25 71 20 66  Because the %q f
1d3e0 6f 72 6d 61 74 20 73 74 72 69 6e 67 20 69 73 20  ormat string is 
1d3f0 75 73 65 64 2c 20 74 68 65 20 27 5c 27 27 20 63  used, the '\'' c
1d400 68 61 72 61 63 74 65 72 20 69 6e 20 7a 54 65 78  haracter in zTex
1d410 74 0a 2a 2a 20 69 73 20 65 73 63 61 70 65 64 20  t.** is escaped 
1d420 61 6e 64 20 74 68 65 20 53 51 4c 20 67 65 6e 65  and the SQL gene
1d430 72 61 74 65 64 20 69 73 20 61 73 20 66 6f 6c 6c  rated is as foll
1d440 6f 77 73 3a 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63  ows:.**.** <bloc
1d450 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 2a 2a 20  kquote><pre>.** 
1d460 20 49 4e 53 45 52 54 20 49 4e 54 4f 20 74 61 62   INSERT INTO tab
1d470 6c 65 31 20 56 41 4c 55 45 53 28 27 49 74 27 27  le1 VALUES('It''
1d480 73 20 61 20 68 61 70 70 79 20 64 61 79 21 27 29  s a happy day!')
1d490 0a 2a 2a 20 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63  .** </pre></bloc
1d4a0 6b 71 75 6f 74 65 3e 0a 2a 2a 0a 2a 2a 20 54 68  kquote>.**.** Th
1d4b0 69 73 20 69 73 20 63 6f 72 72 65 63 74 2e 20 20  is is correct.  
1d4c0 48 61 64 20 77 65 20 75 73 65 64 20 25 73 20 69  Had we used %s i
1d4d0 6e 73 74 65 61 64 20 6f 66 20 25 71 2c 20 74 68  nstead of %q, th
1d4e0 65 20 67 65 6e 65 72 61 74 65 64 20 53 51 4c 0a  e generated SQL.
1d4f0 2a 2a 20 77 6f 75 6c 64 20 68 61 76 65 20 6c 6f  ** would have lo
1d500 6f 6b 65 64 20 6c 69 6b 65 20 74 68 69 73 3a 0a  oked like this:.
1d510 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74  **.** <blockquot
1d520 65 3e 3c 70 72 65 3e 0a 2a 2a 20 20 49 4e 53 45  e><pre>.**  INSE
1d530 52 54 20 49 4e 54 4f 20 74 61 62 6c 65 31 20 56  RT INTO table1 V
1d540 41 4c 55 45 53 28 27 49 74 27 73 20 61 20 68 61  ALUES('It's a ha
1d550 70 70 79 20 64 61 79 21 27 29 3b 0a 2a 2a 20 3c  ppy day!');.** <
1d560 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74  /pre></blockquot
1d570 65 3e 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 73 65  e>.**.** This se
1d580 63 6f 6e 64 20 65 78 61 6d 70 6c 65 20 69 73 20  cond example is 
1d590 61 6e 20 53 51 4c 20 73 79 6e 74 61 78 20 65 72  an SQL syntax er
1d5a0 72 6f 72 2e 20 20 41 73 20 61 20 67 65 6e 65 72  ror.  As a gener
1d5b0 61 6c 20 72 75 6c 65 20 79 6f 75 20 73 68 6f 75  al rule you shou
1d5c0 6c 64 0a 2a 2a 20 61 6c 77 61 79 73 20 75 73 65  ld.** always use
1d5d0 20 25 71 20 69 6e 73 74 65 61 64 20 6f 66 20 25   %q instead of %
1d5e0 73 20 77 68 65 6e 20 69 6e 73 65 72 74 69 6e 67  s when inserting
1d5f0 20 74 65 78 74 20 69 6e 74 6f 20 61 20 73 74 72   text into a str
1d600 69 6e 67 20 6c 69 74 65 72 61 6c 2e 0a 2a 2a 0a  ing literal..**.
1d610 2a 2a 20 5e 28 54 68 65 20 25 51 20 6f 70 74 69  ** ^(The %Q opti
1d620 6f 6e 20 77 6f 72 6b 73 20 6c 69 6b 65 20 25 71  on works like %q
1d630 20 65 78 63 65 70 74 20 69 74 20 61 6c 73 6f 20   except it also 
1d640 61 64 64 73 20 73 69 6e 67 6c 65 20 71 75 6f 74  adds single quot
1d650 65 73 20 61 72 6f 75 6e 64 0a 2a 2a 20 74 68 65  es around.** the
1d660 20 6f 75 74 73 69 64 65 20 6f 66 20 74 68 65 20   outside of the 
1d670 74 6f 74 61 6c 20 73 74 72 69 6e 67 2e 20 20 41  total string.  A
1d680 64 64 69 74 69 6f 6e 61 6c 6c 79 2c 20 69 66 20  dditionally, if 
1d690 74 68 65 20 70 61 72 61 6d 65 74 65 72 20 69 6e  the parameter in
1d6a0 20 74 68 65 0a 2a 2a 20 61 72 67 75 6d 65 6e 74   the.** argument
1d6b0 20 6c 69 73 74 20 69 73 20 61 20 4e 55 4c 4c 20   list is a NULL 
1d6c0 70 6f 69 6e 74 65 72 2c 20 25 51 20 73 75 62 73  pointer, %Q subs
1d6d0 74 69 74 75 74 65 73 20 74 68 65 20 74 65 78 74  titutes the text
1d6e0 20 22 4e 55 4c 4c 22 20 28 77 69 74 68 6f 75 74   "NULL" (without
1d6f0 0a 2a 2a 20 73 69 6e 67 6c 65 20 71 75 6f 74 65  .** single quote
1d700 73 29 2e 29 5e 20 20 53 6f 2c 20 66 6f 72 20 65  s).)^  So, for e
1d710 78 61 6d 70 6c 65 2c 20 6f 6e 65 20 63 6f 75 6c  xample, one coul
1d720 64 20 73 61 79 3a 0a 2a 2a 0a 2a 2a 20 3c 62 6c  d say:.**.** <bl
1d730 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 2a  ockquote><pre>.*
1d740 2a 20 20 63 68 61 72 20 2a 7a 53 51 4c 20 3d 20  *  char *zSQL = 
1d750 73 71 6c 69 74 65 33 5f 6d 70 72 69 6e 74 66 28  sqlite3_mprintf(
1d760 22 49 4e 53 45 52 54 20 49 4e 54 4f 20 74 61 62  "INSERT INTO tab
1d770 6c 65 20 56 41 4c 55 45 53 28 25 51 29 22 2c 20  le VALUES(%Q)", 
1d780 7a 54 65 78 74 29 3b 0a 2a 2a 20 20 73 71 6c 69  zText);.**  sqli
1d790 74 65 33 5f 65 78 65 63 28 64 62 2c 20 7a 53 51  te3_exec(db, zSQ
1d7a0 4c 2c 20 30 2c 20 30 2c 20 30 29 3b 0a 2a 2a 20  L, 0, 0, 0);.** 
1d7b0 20 73 71 6c 69 74 65 33 5f 66 72 65 65 28 7a 53   sqlite3_free(zS
1d7c0 51 4c 29 3b 0a 2a 2a 20 3c 2f 70 72 65 3e 3c 2f  QL);.** </pre></
1d7d0 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 2a 2a 0a 2a  blockquote>.**.*
1d7e0 2a 20 54 68 65 20 63 6f 64 65 20 61 62 6f 76 65  * The code above
1d7f0 20 77 69 6c 6c 20 72 65 6e 64 65 72 20 61 20 63   will render a c
1d800 6f 72 72 65 63 74 20 53 51 4c 20 73 74 61 74 65  orrect SQL state
1d810 6d 65 6e 74 20 69 6e 20 74 68 65 20 7a 53 51 4c  ment in the zSQL
1d820 0a 2a 2a 20 76 61 72 69 61 62 6c 65 20 65 76 65  .** variable eve
1d830 6e 20 69 66 20 74 68 65 20 7a 54 65 78 74 20 76  n if the zText v
1d840 61 72 69 61 62 6c 65 20 69 73 20 61 20 4e 55 4c  ariable is a NUL
1d850 4c 20 70 6f 69 6e 74 65 72 2e 0a 2a 2a 0a 2a 2a  L pointer..**.**
1d860 20 5e 28 54 68 65 20 22 25 77 22 20 66 6f 72 6d   ^(The "%w" form
1d870 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e 20 69 73  atting option is
1d880 20 6c 69 6b 65 20 22 25 71 22 20 65 78 63 65 70   like "%q" excep
1d890 74 20 74 68 61 74 20 69 74 20 65 78 70 65 63 74  t that it expect
1d8a0 73 20 74 6f 0a 2a 2a 20 62 65 20 63 6f 6e 74 61  s to.** be conta
1d8b0 69 6e 65 64 20 77 69 74 68 69 6e 20 64 6f 75 62  ined within doub
1d8c0 6c 65 2d 71 75 6f 74 65 73 20 69 6e 73 74 65 61  le-quotes instea
1d8d0 64 20 6f 66 20 73 69 6e 67 6c 65 20 71 75 6f 74  d of single quot
1d8e0 65 73 2c 20 61 6e 64 20 69 74 0a 2a 2a 20 65 73  es, and it.** es
1d8f0 63 61 70 65 73 20 74 68 65 20 64 6f 75 62 6c 65  capes the double
1d900 2d 71 75 6f 74 65 20 63 68 61 72 61 63 74 65 72  -quote character
1d910 20 69 6e 73 74 65 61 64 20 6f 66 20 74 68 65 20   instead of the 
1d920 73 69 6e 67 6c 65 2d 71 75 6f 74 65 0a 2a 2a 20  single-quote.** 
1d930 63 68 61 72 61 63 74 65 72 2e 29 5e 20 20 54 68  character.)^  Th
1d940 65 20 22 25 77 22 20 66 6f 72 6d 61 74 74 69 6e  e "%w" formattin
1d950 67 20 6f 70 74 69 6f 6e 20 69 73 20 69 6e 74 65  g option is inte
1d960 6e 64 65 64 20 66 6f 72 20 73 61 66 65 6c 79 20  nded for safely 
1d970 69 6e 73 65 72 74 69 6e 67 0a 2a 2a 20 74 61 62  inserting.** tab
1d980 6c 65 20 61 6e 64 20 63 6f 6c 75 6d 6e 20 6e 61  le and column na
1d990 6d 65 73 20 69 6e 74 6f 20 61 20 63 6f 6e 73 74  mes into a const
1d9a0 72 75 63 74 65 64 20 53 51 4c 20 73 74 61 74 65  ructed SQL state
1d9b0 6d 65 6e 74 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68  ment..**.** ^(Th
1d9c0 65 20 22 25 7a 22 20 66 6f 72 6d 61 74 74 69 6e  e "%z" formattin
1d9d0 67 20 6f 70 74 69 6f 6e 20 77 6f 72 6b 73 20 6c  g option works l
1d9e0 69 6b 65 20 22 25 73 22 20 62 75 74 20 77 69 74  ike "%s" but wit
1d9f0 68 20 74 68 65 0a 2a 2a 20 61 64 64 69 74 69 6f  h the.** additio
1da00 6e 20 74 68 61 74 20 61 66 74 65 72 20 74 68 65  n that after the
1da10 20 73 74 72 69 6e 67 20 68 61 73 20 62 65 65 6e   string has been
1da20 20 72 65 61 64 20 61 6e 64 20 63 6f 70 69 65 64   read and copied
1da30 20 69 6e 74 6f 0a 2a 2a 20 74 68 65 20 72 65 73   into.** the res
1da40 75 6c 74 2c 20 5b 73 71 6c 69 74 65 33 5f 66 72  ult, [sqlite3_fr
1da50 65 65 28 29 5d 20 69 73 20 63 61 6c 6c 65 64 20  ee()] is called 
1da60 6f 6e 20 74 68 65 20 69 6e 70 75 74 20 73 74 72  on the input str
1da70 69 6e 67 2e 29 5e 0a 2a 2f 0a 63 68 61 72 20 2a  ing.)^.*/.char *
1da80 73 71 6c 69 74 65 33 5f 6d 70 72 69 6e 74 66 28  sqlite3_mprintf(
1da90 63 6f 6e 73 74 20 63 68 61 72 2a 2c 2e 2e 2e 29  const char*,...)
1daa0 3b 0a 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f  ;.char *sqlite3_
1dab0 76 6d 70 72 69 6e 74 66 28 63 6f 6e 73 74 20 63  vmprintf(const c
1dac0 68 61 72 2a 2c 20 76 61 5f 6c 69 73 74 29 3b 0a  har*, va_list);.
1dad0 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 73 6e  char *sqlite3_sn
1dae0 70 72 69 6e 74 66 28 69 6e 74 2c 63 68 61 72 2a  printf(int,char*
1daf0 2c 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20 2e 2e  ,const char*, ..
1db00 2e 29 3b 0a 63 68 61 72 20 2a 73 71 6c 69 74 65  .);.char *sqlite
1db10 33 5f 76 73 6e 70 72 69 6e 74 66 28 69 6e 74 2c  3_vsnprintf(int,
1db20 63 68 61 72 2a 2c 63 6f 6e 73 74 20 63 68 61 72  char*,const char
1db30 2a 2c 20 76 61 5f 6c 69 73 74 29 3b 0a 0a 2f 2a  *, va_list);../*
1db40 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4d 65  .** CAPI3REF: Me
1db50 6d 6f 72 79 20 41 6c 6c 6f 63 61 74 69 6f 6e 20  mory Allocation 
1db60 53 75 62 73 79 73 74 65 6d 0a 2a 2a 0a 2a 2a 20  Subsystem.**.** 
1db70 54 68 65 20 53 51 4c 69 74 65 20 63 6f 72 65 20  The SQLite core 
1db80 75 73 65 73 20 74 68 65 73 65 20 74 68 72 65 65  uses these three
1db90 20 72 6f 75 74 69 6e 65 73 20 66 6f 72 20 61 6c   routines for al
1dba0 6c 20 6f 66 20 69 74 73 20 6f 77 6e 0a 2a 2a 20  l of its own.** 
1dbb0 69 6e 74 65 72 6e 61 6c 20 6d 65 6d 6f 72 79 20  internal memory 
1dbc0 61 6c 6c 6f 63 61 74 69 6f 6e 20 6e 65 65 64 73  allocation needs
1dbd0 2e 20 22 43 6f 72 65 22 20 69 6e 20 74 68 65 20  . "Core" in the 
1dbe0 70 72 65 76 69 6f 75 73 20 73 65 6e 74 65 6e 63  previous sentenc
1dbf0 65 0a 2a 2a 20 64 6f 65 73 20 6e 6f 74 20 69 6e  e.** does not in
1dc00 63 6c 75 64 65 20 6f 70 65 72 61 74 69 6e 67 2d  clude operating-
1dc10 73 79 73 74 65 6d 20 73 70 65 63 69 66 69 63 20  system specific 
1dc20 56 46 53 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  VFS implementati
1dc30 6f 6e 2e 20 20 54 68 65 0a 2a 2a 20 57 69 6e 64  on.  The.** Wind
1dc40 6f 77 73 20 56 46 53 20 75 73 65 73 20 6e 61 74  ows VFS uses nat
1dc50 69 76 65 20 6d 61 6c 6c 6f 63 28 29 20 61 6e 64  ive malloc() and
1dc60 20 66 72 65 65 28 29 20 66 6f 72 20 73 6f 6d 65   free() for some
1dc70 20 6f 70 65 72 61 74 69 6f 6e 73 2e 0a 2a 2a 0a   operations..**.
1dc80 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  ** ^The sqlite3_
1dc90 6d 61 6c 6c 6f 63 28 29 20 72 6f 75 74 69 6e 65  malloc() routine
1dca0 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69 6e 74   returns a point
1dcb0 65 72 20 74 6f 20 61 20 62 6c 6f 63 6b 0a 2a 2a  er to a block.**
1dcc0 20 6f 66 20 6d 65 6d 6f 72 79 20 61 74 20 6c 65   of memory at le
1dcd0 61 73 74 20 4e 20 62 79 74 65 73 20 69 6e 20 6c  ast N bytes in l
1dce0 65 6e 67 74 68 2c 20 77 68 65 72 65 20 4e 20 69  ength, where N i
1dcf0 73 20 74 68 65 20 70 61 72 61 6d 65 74 65 72 2e  s the parameter.
1dd00 0a 2a 2a 20 5e 49 66 20 73 71 6c 69 74 65 33 5f  .** ^If sqlite3_
1dd10 6d 61 6c 6c 6f 63 28 29 20 69 73 20 75 6e 61 62  malloc() is unab
1dd20 6c 65 20 74 6f 20 6f 62 74 61 69 6e 20 73 75 66  le to obtain suf
1dd30 66 69 63 69 65 6e 74 20 66 72 65 65 0a 2a 2a 20  ficient free.** 
1dd40 6d 65 6d 6f 72 79 2c 20 69 74 20 72 65 74 75 72  memory, it retur
1dd50 6e 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  ns a NULL pointe
1dd60 72 2e 20 20 5e 49 66 20 74 68 65 20 70 61 72 61  r.  ^If the para
1dd70 6d 65 74 65 72 20 4e 20 74 6f 0a 2a 2a 20 73 71  meter N to.** sq
1dd80 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 20 69  lite3_malloc() i
1dd90 73 20 7a 65 72 6f 20 6f 72 20 6e 65 67 61 74 69  s zero or negati
1dda0 76 65 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f  ve then sqlite3_
1ddb0 6d 61 6c 6c 6f 63 28 29 20 72 65 74 75 72 6e 73  malloc() returns
1ddc0 0a 2a 2a 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74  .** a NULL point
1ddd0 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  er..**.** ^The s
1dde0 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 36 34 28  qlite3_malloc64(
1ddf0 4e 29 20 72 6f 75 74 69 6e 65 20 77 6f 72 6b 73  N) routine works
1de00 20 6a 75 73 74 20 6c 69 6b 65 0a 2a 2a 20 73 71   just like.** sq
1de10 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 4e 29 20  lite3_malloc(N) 
1de20 65 78 63 65 70 74 20 74 68 61 74 20 4e 20 69 73  except that N is
1de30 20 61 6e 20 75 6e 73 69 67 6e 65 64 20 36 34 2d   an unsigned 64-
1de40 62 69 74 20 69 6e 74 65 67 65 72 20 69 6e 73 74  bit integer inst
1de50 65 61 64 0a 2a 2a 20 6f 66 20 61 20 73 69 67 6e  ead.** of a sign
1de60 65 64 20 33 32 2d 62 69 74 20 69 6e 74 65 67 65  ed 32-bit intege
1de70 72 2e 0a 2a 2a 0a 2a 2a 20 5e 43 61 6c 6c 69 6e  r..**.** ^Callin
1de80 67 20 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29  g sqlite3_free()
1de90 20 77 69 74 68 20 61 20 70 6f 69 6e 74 65 72 20   with a pointer 
1dea0 70 72 65 76 69 6f 75 73 6c 79 20 72 65 74 75 72  previously retur
1deb0 6e 65 64 0a 2a 2a 20 62 79 20 73 71 6c 69 74 65  ned.** by sqlite
1dec0 33 5f 6d 61 6c 6c 6f 63 28 29 20 6f 72 20 73 71  3_malloc() or sq
1ded0 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63 28 29 20  lite3_realloc() 
1dee0 72 65 6c 65 61 73 65 73 20 74 68 61 74 20 6d 65  releases that me
1def0 6d 6f 72 79 20 73 6f 0a 2a 2a 20 74 68 61 74 20  mory so.** that 
1df00 69 74 20 6d 69 67 68 74 20 62 65 20 72 65 75 73  it might be reus
1df10 65 64 2e 20 20 5e 54 68 65 20 73 71 6c 69 74 65  ed.  ^The sqlite
1df20 33 5f 66 72 65 65 28 29 20 72 6f 75 74 69 6e 65  3_free() routine
1df30 20 69 73 0a 2a 2a 20 61 20 6e 6f 2d 6f 70 20 69   is.** a no-op i
1df40 66 20 69 73 20 63 61 6c 6c 65 64 20 77 69 74 68  f is called with
1df50 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2e   a NULL pointer.
1df60 20 20 50 61 73 73 69 6e 67 20 61 20 4e 55 4c 4c    Passing a NULL
1df70 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 74 6f 20 73   pointer.** to s
1df80 71 6c 69 74 65 33 5f 66 72 65 65 28 29 20 69 73  qlite3_free() is
1df90 20 68 61 72 6d 6c 65 73 73 2e 20 20 41 66 74 65   harmless.  Afte
1dfa0 72 20 62 65 69 6e 67 20 66 72 65 65 64 2c 20 6d  r being freed, m
1dfb0 65 6d 6f 72 79 0a 2a 2a 20 73 68 6f 75 6c 64 20  emory.** should 
1dfc0 6e 65 69 74 68 65 72 20 62 65 20 72 65 61 64 20  neither be read 
1dfd0 6e 6f 72 20 77 72 69 74 74 65 6e 2e 20 20 45 76  nor written.  Ev
1dfe0 65 6e 20 72 65 61 64 69 6e 67 20 70 72 65 76 69  en reading previ
1dff0 6f 75 73 6c 79 20 66 72 65 65 64 0a 2a 2a 20 6d  ously freed.** m
1e000 65 6d 6f 72 79 20 6d 69 67 68 74 20 72 65 73 75  emory might resu
1e010 6c 74 20 69 6e 20 61 20 73 65 67 6d 65 6e 74 61  lt in a segmenta
1e020 74 69 6f 6e 20 66 61 75 6c 74 20 6f 72 20 6f 74  tion fault or ot
1e030 68 65 72 20 73 65 76 65 72 65 20 65 72 72 6f 72  her severe error
1e040 2e 0a 2a 2a 20 4d 65 6d 6f 72 79 20 63 6f 72 72  ..** Memory corr
1e050 75 70 74 69 6f 6e 2c 20 61 20 73 65 67 6d 65 6e  uption, a segmen
1e060 74 61 74 69 6f 6e 20 66 61 75 6c 74 2c 20 6f 72  tation fault, or
1e070 20 6f 74 68 65 72 20 73 65 76 65 72 65 20 65 72   other severe er
1e080 72 6f 72 0a 2a 2a 20 6d 69 67 68 74 20 72 65 73  ror.** might res
1e090 75 6c 74 20 69 66 20 73 71 6c 69 74 65 33 5f 66  ult if sqlite3_f
1e0a0 72 65 65 28 29 20 69 73 20 63 61 6c 6c 65 64 20  ree() is called 
1e0b0 77 69 74 68 20 61 20 6e 6f 6e 2d 4e 55 4c 4c 20  with a non-NULL 
1e0c0 70 6f 69 6e 74 65 72 20 74 68 61 74 0a 2a 2a 20  pointer that.** 
1e0d0 77 61 73 20 6e 6f 74 20 6f 62 74 61 69 6e 65 64  was not obtained
1e0e0 20 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f 6d 61   from sqlite3_ma
1e0f0 6c 6c 6f 63 28 29 20 6f 72 20 73 71 6c 69 74 65  lloc() or sqlite
1e100 33 5f 72 65 61 6c 6c 6f 63 28 29 2e 0a 2a 2a 0a  3_realloc()..**.
1e110 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  ** ^The sqlite3_
1e120 72 65 61 6c 6c 6f 63 28 58 2c 4e 29 20 69 6e 74  realloc(X,N) int
1e130 65 72 66 61 63 65 20 61 74 74 65 6d 70 74 73 20  erface attempts 
1e140 74 6f 20 72 65 73 69 7a 65 20 61 0a 2a 2a 20 70  to resize a.** p
1e150 72 69 6f 72 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f  rior memory allo
1e160 63 61 74 69 6f 6e 20 58 20 74 6f 20 62 65 20 61  cation X to be a
1e170 74 20 6c 65 61 73 74 20 4e 20 62 79 74 65 73 2e  t least N bytes.
1e180 0a 2a 2a 20 5e 49 66 20 74 68 65 20 58 20 70 61  .** ^If the X pa
1e190 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74  rameter to sqlit
1e1a0 65 33 5f 72 65 61 6c 6c 6f 63 28 58 2c 4e 29 0a  e3_realloc(X,N).
1e1b0 2a 2a 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69  ** is a NULL poi
1e1c0 6e 74 65 72 20 74 68 65 6e 20 69 74 73 20 62 65  nter then its be
1e1d0 68 61 76 69 6f 72 20 69 73 20 69 64 65 6e 74 69  havior is identi
1e1e0 63 61 6c 20 74 6f 20 63 61 6c 6c 69 6e 67 0a 2a  cal to calling.*
1e1f0 2a 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63  * sqlite3_malloc
1e200 28 4e 29 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20  (N)..** ^If the 
1e210 4e 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73  N parameter to s
1e220 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63 28 58  qlite3_realloc(X
1e230 2c 4e 29 20 69 73 20 7a 65 72 6f 20 6f 72 0a 2a  ,N) is zero or.*
1e240 2a 20 6e 65 67 61 74 69 76 65 20 74 68 65 6e 20  * negative then 
1e250 74 68 65 20 62 65 68 61 76 69 6f 72 20 69 73 20  the behavior is 
1e260 65 78 61 63 74 6c 79 20 74 68 65 20 73 61 6d 65  exactly the same
1e270 20 61 73 20 63 61 6c 6c 69 6e 67 0a 2a 2a 20 73   as calling.** s
1e280 71 6c 69 74 65 33 5f 66 72 65 65 28 58 29 2e 0a  qlite3_free(X)..
1e290 2a 2a 20 5e 73 71 6c 69 74 65 33 5f 72 65 61 6c  ** ^sqlite3_real
1e2a0 6c 6f 63 28 58 2c 4e 29 20 72 65 74 75 72 6e 73  loc(X,N) returns
1e2b0 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20   a pointer to a 
1e2c0 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f  memory allocatio
1e2d0 6e 0a 2a 2a 20 6f 66 20 61 74 20 6c 65 61 73 74  n.** of at least
1e2e0 20 4e 20 62 79 74 65 73 20 69 6e 20 73 69 7a 65   N bytes in size
1e2f0 20 6f 72 20 4e 55 4c 4c 20 69 66 20 69 6e 73 75   or NULL if insu
1e300 66 66 69 63 69 65 6e 74 20 6d 65 6d 6f 72 79 20  fficient memory 
1e310 69 73 20 61 76 61 69 6c 61 62 6c 65 2e 0a 2a 2a  is available..**
1e320 20 5e 49 66 20 4d 20 69 73 20 74 68 65 20 73 69   ^If M is the si
1e330 7a 65 20 6f 66 20 74 68 65 20 70 72 69 6f 72 20  ze of the prior 
1e340 61 6c 6c 6f 63 61 74 69 6f 6e 2c 20 74 68 65 6e  allocation, then
1e350 20 6d 69 6e 28 4e 2c 4d 29 20 62 79 74 65 73 0a   min(N,M) bytes.
1e360 2a 2a 20 6f 66 20 74 68 65 20 70 72 69 6f 72 20  ** of the prior 
1e370 61 6c 6c 6f 63 61 74 69 6f 6e 20 61 72 65 20 63  allocation are c
1e380 6f 70 69 65 64 20 69 6e 74 6f 20 74 68 65 20 62  opied into the b
1e390 65 67 69 6e 6e 69 6e 67 20 6f 66 20 62 75 66 66  eginning of buff
1e3a0 65 72 20 72 65 74 75 72 6e 65 64 0a 2a 2a 20 62  er returned.** b
1e3b0 79 20 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f  y sqlite3_reallo
1e3c0 63 28 58 2c 4e 29 20 61 6e 64 20 74 68 65 20 70  c(X,N) and the p
1e3d0 72 69 6f 72 20 61 6c 6c 6f 63 61 74 69 6f 6e 20  rior allocation 
1e3e0 69 73 20 66 72 65 65 64 2e 0a 2a 2a 20 5e 49 66  is freed..** ^If
1e3f0 20 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63   sqlite3_realloc
1e400 28 58 2c 4e 29 20 72 65 74 75 72 6e 73 20 4e 55  (X,N) returns NU
1e410 4c 4c 20 61 6e 64 20 4e 20 69 73 20 70 6f 73 69  LL and N is posi
1e420 74 69 76 65 2c 20 74 68 65 6e 20 74 68 65 0a 2a  tive, then the.*
1e430 2a 20 70 72 69 6f 72 20 61 6c 6c 6f 63 61 74 69  * prior allocati
1e440 6f 6e 20 69 73 20 6e 6f 74 20 66 72 65 65 64 2e  on is not freed.
1e450 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69  .**.** ^The sqli
1e460 74 65 33 5f 72 65 61 6c 6c 6f 63 36 34 28 58 2c  te3_realloc64(X,
1e470 4e 29 20 69 6e 74 65 72 66 61 63 65 73 20 77 6f  N) interfaces wo
1e480 72 6b 73 20 74 68 65 20 73 61 6d 65 20 61 73 0a  rks the same as.
1e490 2a 2a 20 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c  ** sqlite3_reall
1e4a0 6f 63 28 58 2c 4e 29 20 65 78 63 65 70 74 20 74  oc(X,N) except t
1e4b0 68 61 74 20 4e 20 69 73 20 61 20 36 34 2d 62 69  hat N is a 64-bi
1e4c0 74 20 75 6e 73 69 67 6e 65 64 20 69 6e 74 65 67  t unsigned integ
1e4d0 65 72 20 69 6e 73 74 65 61 64 0a 2a 2a 20 6f 66  er instead.** of
1e4e0 20 61 20 33 32 2d 62 69 74 20 73 69 67 6e 65 64   a 32-bit signed
1e4f0 20 69 6e 74 65 67 65 72 2e 0a 2a 2a 0a 2a 2a 20   integer..**.** 
1e500 5e 49 66 20 58 20 69 73 20 61 20 6d 65 6d 6f 72  ^If X is a memor
1e510 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 70 72 65  y allocation pre
1e520 76 69 6f 75 73 6c 79 20 6f 62 74 61 69 6e 65 64  viously obtained
1e530 20 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f 6d 61   from sqlite3_ma
1e540 6c 6c 6f 63 28 29 2c 0a 2a 2a 20 73 71 6c 69 74  lloc(),.** sqlit
1e550 65 33 5f 6d 61 6c 6c 6f 63 36 34 28 29 2c 20 73  e3_malloc64(), s
1e560 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63 28 29  qlite3_realloc()
1e570 2c 20 6f 72 20 73 71 6c 69 74 65 33 5f 72 65 61  , or sqlite3_rea
1e580 6c 6c 6f 63 36 34 28 29 2c 20 74 68 65 6e 0a 2a  lloc64(), then.*
1e590 2a 20 73 71 6c 69 74 65 33 5f 6d 73 69 7a 65 28  * sqlite3_msize(
1e5a0 58 29 20 72 65 74 75 72 6e 73 20 74 68 65 20 73  X) returns the s
1e5b0 69 7a 65 20 6f 66 20 74 68 61 74 20 6d 65 6d 6f  ize of that memo
1e5c0 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 69 6e  ry allocation in
1e5d0 20 62 79 74 65 73 2e 0a 2a 2a 20 5e 54 68 65 20   bytes..** ^The 
1e5e0 76 61 6c 75 65 20 72 65 74 75 72 6e 65 64 20 62  value returned b
1e5f0 79 20 73 71 6c 69 74 65 33 5f 6d 73 69 7a 65 28  y sqlite3_msize(
1e600 58 29 20 6d 69 67 68 74 20 62 65 20 6c 61 72 67  X) might be larg
1e610 65 72 20 74 68 61 6e 20 74 68 65 20 6e 75 6d 62  er than the numb
1e620 65 72 0a 2a 2a 20 6f 66 20 62 79 74 65 73 20 72  er.** of bytes r
1e630 65 71 75 65 73 74 65 64 20 77 68 65 6e 20 58 20  equested when X 
1e640 77 61 73 20 61 6c 6c 6f 63 61 74 65 64 2e 20 20  was allocated.  
1e650 5e 49 66 20 58 20 69 73 20 61 20 4e 55 4c 4c 20  ^If X is a NULL 
1e660 70 6f 69 6e 74 65 72 20 74 68 65 6e 0a 2a 2a 20  pointer then.** 
1e670 73 71 6c 69 74 65 33 5f 6d 73 69 7a 65 28 58 29  sqlite3_msize(X)
1e680 20 72 65 74 75 72 6e 73 20 7a 65 72 6f 2e 20 20   returns zero.  
1e690 49 66 20 58 20 70 6f 69 6e 74 73 20 74 6f 20 73  If X points to s
1e6a0 6f 6d 65 74 68 69 6e 67 20 74 68 61 74 20 69 73  omething that is
1e6b0 20 6e 6f 74 0a 2a 2a 20 74 68 65 20 62 65 67 69   not.** the begi
1e6c0 6e 6e 69 6e 67 20 6f 66 20 6d 65 6d 6f 72 79 20  nning of memory 
1e6d0 61 6c 6c 6f 63 61 74 69 6f 6e 2c 20 6f 72 20 69  allocation, or i
1e6e0 66 20 69 74 20 70 6f 69 6e 74 73 20 74 6f 20 61  f it points to a
1e6f0 20 66 6f 72 6d 65 72 6c 79 0a 2a 2a 20 76 61 6c   formerly.** val
1e700 69 64 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  id memory alloca
1e710 74 69 6f 6e 20 74 68 61 74 20 68 61 73 20 6e 6f  tion that has no
1e720 77 20 62 65 65 6e 20 66 72 65 65 64 2c 20 74 68  w been freed, th
1e730 65 6e 20 74 68 65 20 62 65 68 61 76 69 6f 72 0a  en the behavior.
1e740 2a 2a 20 6f 66 20 73 71 6c 69 74 65 33 5f 6d 73  ** of sqlite3_ms
1e750 69 7a 65 28 58 29 20 69 73 20 75 6e 64 65 66 69  ize(X) is undefi
1e760 6e 65 64 20 61 6e 64 20 70 6f 73 73 69 62 6c 79  ned and possibly
1e770 20 68 61 72 6d 66 75 6c 2e 0a 2a 2a 0a 2a 2a 20   harmful..**.** 
1e780 5e 54 68 65 20 6d 65 6d 6f 72 79 20 72 65 74 75  ^The memory retu
1e790 72 6e 65 64 20 62 79 20 73 71 6c 69 74 65 33 5f  rned by sqlite3_
1e7a0 6d 61 6c 6c 6f 63 28 29 2c 20 73 71 6c 69 74 65  malloc(), sqlite
1e7b0 33 5f 72 65 61 6c 6c 6f 63 28 29 2c 0a 2a 2a 20  3_realloc(),.** 
1e7c0 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 36 34  sqlite3_malloc64
1e7d0 28 29 2c 20 61 6e 64 20 73 71 6c 69 74 65 33 5f  (), and sqlite3_
1e7e0 72 65 61 6c 6c 6f 63 36 34 28 29 0a 2a 2a 20 69  realloc64().** i
1e7f0 73 20 61 6c 77 61 79 73 20 61 6c 69 67 6e 65 64  s always aligned
1e800 20 74 6f 20 61 74 20 6c 65 61 73 74 20 61 6e 20   to at least an 
1e810 38 20 62 79 74 65 20 62 6f 75 6e 64 61 72 79 2c  8 byte boundary,
1e820 20 6f 72 20 74 6f 20 61 0a 2a 2a 20 34 20 62 79   or to a.** 4 by
1e830 74 65 20 62 6f 75 6e 64 61 72 79 20 69 66 20 74  te boundary if t
1e840 68 65 20 5b 53 51 4c 49 54 45 5f 34 5f 42 59 54  he [SQLITE_4_BYT
1e850 45 5f 41 4c 49 47 4e 45 44 5f 4d 41 4c 4c 4f 43  E_ALIGNED_MALLOC
1e860 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 0a 2a  ] compile-time.*
1e870 2a 20 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64  * option is used
1e880 2e 0a 2a 2a 0a 2a 2a 20 49 6e 20 53 51 4c 69 74  ..**.** In SQLit
1e890 65 20 76 65 72 73 69 6f 6e 20 33 2e 35 2e 30 20  e version 3.5.0 
1e8a0 61 6e 64 20 33 2e 35 2e 31 2c 20 69 74 20 77 61  and 3.5.1, it wa
1e8b0 73 20 70 6f 73 73 69 62 6c 65 20 74 6f 20 64 65  s possible to de
1e8c0 66 69 6e 65 0a 2a 2a 20 74 68 65 20 53 51 4c 49  fine.** the SQLI
1e8d0 54 45 5f 4f 4d 49 54 5f 4d 45 4d 4f 52 59 5f 41  TE_OMIT_MEMORY_A
1e8e0 4c 4c 4f 43 41 54 49 4f 4e 20 77 68 69 63 68 20  LLOCATION which 
1e8f0 77 6f 75 6c 64 20 63 61 75 73 65 20 74 68 65 20  would cause the 
1e900 62 75 69 6c 74 2d 69 6e 0a 2a 2a 20 69 6d 70 6c  built-in.** impl
1e910 65 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20 74 68  ementation of th
1e920 65 73 65 20 72 6f 75 74 69 6e 65 73 20 74 6f 20  ese routines to 
1e930 62 65 20 6f 6d 69 74 74 65 64 2e 20 20 54 68 61  be omitted.  Tha
1e940 74 20 63 61 70 61 62 69 6c 69 74 79 0a 2a 2a 20  t capability.** 
1e950 69 73 20 6e 6f 20 6c 6f 6e 67 65 72 20 70 72 6f  is no longer pro
1e960 76 69 64 65 64 2e 20 20 4f 6e 6c 79 20 62 75 69  vided.  Only bui
1e970 6c 74 2d 69 6e 20 6d 65 6d 6f 72 79 20 61 6c 6c  lt-in memory all
1e980 6f 63 61 74 6f 72 73 20 63 61 6e 20 62 65 20 75  ocators can be u
1e990 73 65 64 2e 0a 2a 2a 0a 2a 2a 20 50 72 69 6f 72  sed..**.** Prior
1e9a0 20 74 6f 20 53 51 4c 69 74 65 20 76 65 72 73 69   to SQLite versi
1e9b0 6f 6e 20 33 2e 37 2e 31 30 2c 20 74 68 65 20 57  on 3.7.10, the W
1e9c0 69 6e 64 6f 77 73 20 4f 53 20 69 6e 74 65 72 66  indows OS interf
1e9d0 61 63 65 20 6c 61 79 65 72 20 63 61 6c 6c 65 64  ace layer called
1e9e0 0a 2a 2a 20 74 68 65 20 73 79 73 74 65 6d 20 6d  .** the system m
1e9f0 61 6c 6c 6f 63 28 29 20 61 6e 64 20 66 72 65 65  alloc() and free
1ea00 28 29 20 64 69 72 65 63 74 6c 79 20 77 68 65 6e  () directly when
1ea10 20 63 6f 6e 76 65 72 74 69 6e 67 0a 2a 2a 20 66   converting.** f
1ea20 69 6c 65 6e 61 6d 65 73 20 62 65 74 77 65 65 6e  ilenames between
1ea30 20 74 68 65 20 55 54 46 2d 38 20 65 6e 63 6f 64   the UTF-8 encod
1ea40 69 6e 67 20 75 73 65 64 20 62 79 20 53 51 4c 69  ing used by SQLi
1ea50 74 65 0a 2a 2a 20 61 6e 64 20 77 68 61 74 65 76  te.** and whatev
1ea60 65 72 20 66 69 6c 65 6e 61 6d 65 20 65 6e 63 6f  er filename enco
1ea70 64 69 6e 67 20 69 73 20 75 73 65 64 20 62 79 20  ding is used by 
1ea80 74 68 65 20 70 61 72 74 69 63 75 6c 61 72 20 57  the particular W
1ea90 69 6e 64 6f 77 73 0a 2a 2a 20 69 6e 73 74 61 6c  indows.** instal
1eaa0 6c 61 74 69 6f 6e 2e 20 20 4d 65 6d 6f 72 79 20  lation.  Memory 
1eab0 61 6c 6c 6f 63 61 74 69 6f 6e 20 65 72 72 6f 72  allocation error
1eac0 73 20 77 65 72 65 20 64 65 74 65 63 74 65 64 2c  s were detected,
1ead0 20 62 75 74 0a 2a 2a 20 74 68 65 79 20 77 65 72   but.** they wer
1eae0 65 20 72 65 70 6f 72 74 65 64 20 62 61 63 6b 20  e reported back 
1eaf0 61 73 20 5b 53 51 4c 49 54 45 5f 43 41 4e 54 4f  as [SQLITE_CANTO
1eb00 50 45 4e 5d 20 6f 72 0a 2a 2a 20 5b 53 51 4c 49  PEN] or.** [SQLI
1eb10 54 45 5f 49 4f 45 52 52 5d 20 72 61 74 68 65 72  TE_IOERR] rather
1eb20 20 74 68 61 6e 20 5b 53 51 4c 49 54 45 5f 4e 4f   than [SQLITE_NO
1eb30 4d 45 4d 5d 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  MEM]..**.** The 
1eb40 70 6f 69 6e 74 65 72 20 61 72 67 75 6d 65 6e 74  pointer argument
1eb50 73 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 66 72  s to [sqlite3_fr
1eb60 65 65 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74  ee()] and [sqlit
1eb70 65 33 5f 72 65 61 6c 6c 6f 63 28 29 5d 0a 2a 2a  e3_realloc()].**
1eb80 20 6d 75 73 74 20 62 65 20 65 69 74 68 65 72 20   must be either 
1eb90 4e 55 4c 4c 20 6f 72 20 65 6c 73 65 20 70 6f 69  NULL or else poi
1eba0 6e 74 65 72 73 20 6f 62 74 61 69 6e 65 64 20 66  nters obtained f
1ebb0 72 6f 6d 20 61 20 70 72 69 6f 72 0a 2a 2a 20 69  rom a prior.** i
1ebc0 6e 76 6f 63 61 74 69 6f 6e 20 6f 66 20 5b 73 71  nvocation of [sq
1ebd0 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 20  lite3_malloc()] 
1ebe0 6f 72 20 5b 73 71 6c 69 74 65 33 5f 72 65 61 6c  or [sqlite3_real
1ebf0 6c 6f 63 28 29 5d 20 74 68 61 74 20 68 61 76 65  loc()] that have
1ec00 0a 2a 2a 20 6e 6f 74 20 79 65 74 20 62 65 65 6e  .** not yet been
1ec10 20 72 65 6c 65 61 73 65 64 2e 0a 2a 2a 0a 2a 2a   released..**.**
1ec20 20 54 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   The application
1ec30 20 6d 75 73 74 20 6e 6f 74 20 72 65 61 64 20 6f   must not read o
1ec40 72 20 77 72 69 74 65 20 61 6e 79 20 70 61 72 74  r write any part
1ec50 20 6f 66 0a 2a 2a 20 61 20 62 6c 6f 63 6b 20 6f   of.** a block o
1ec60 66 20 6d 65 6d 6f 72 79 20 61 66 74 65 72 20 69  f memory after i
1ec70 74 20 68 61 73 20 62 65 65 6e 20 72 65 6c 65 61  t has been relea
1ec80 73 65 64 20 75 73 69 6e 67 0a 2a 2a 20 5b 73 71  sed using.** [sq
1ec90 6c 69 74 65 33 5f 66 72 65 65 28 29 5d 20 6f 72  lite3_free()] or
1eca0 20 5b 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f   [sqlite3_reallo
1ecb0 63 28 29 5d 2e 0a 2a 2f 0a 76 6f 69 64 20 2a 73  c()]..*/.void *s
1ecc0 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 69 6e  qlite3_malloc(in
1ecd0 74 29 3b 0a 76 6f 69 64 20 2a 73 71 6c 69 74 65  t);.void *sqlite
1ece0 33 5f 6d 61 6c 6c 6f 63 36 34 28 73 71 6c 69 74  3_malloc64(sqlit
1ecf0 65 33 5f 75 69 6e 74 36 34 29 3b 0a 76 6f 69 64  e3_uint64);.void
1ed00 20 2a 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f   *sqlite3_reallo
1ed10 63 28 76 6f 69 64 2a 2c 20 69 6e 74 29 3b 0a 76  c(void*, int);.v
1ed20 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 72 65 61  oid *sqlite3_rea
1ed30 6c 6c 6f 63 36 34 28 76 6f 69 64 2a 2c 20 73 71  lloc64(void*, sq
1ed40 6c 69 74 65 33 5f 75 69 6e 74 36 34 29 3b 0a 76  lite3_uint64);.v
1ed50 6f 69 64 20 73 71 6c 69 74 65 33 5f 66 72 65 65  oid sqlite3_free
1ed60 28 76 6f 69 64 2a 29 3b 0a 73 71 6c 69 74 65 33  (void*);.sqlite3
1ed70 5f 75 69 6e 74 36 34 20 73 71 6c 69 74 65 33 5f  _uint64 sqlite3_
1ed80 6d 73 69 7a 65 28 76 6f 69 64 2a 29 3b 0a 0a 2f  msize(void*);../
1ed90 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4d  *.** CAPI3REF: M
1eda0 65 6d 6f 72 79 20 41 6c 6c 6f 63 61 74 6f 72 20  emory Allocator 
1edb0 53 74 61 74 69 73 74 69 63 73 0a 2a 2a 0a 2a 2a  Statistics.**.**
1edc0 20 53 51 4c 69 74 65 20 70 72 6f 76 69 64 65 73   SQLite provides
1edd0 20 74 68 65 73 65 20 74 77 6f 20 69 6e 74 65 72   these two inter
1ede0 66 61 63 65 73 20 66 6f 72 20 72 65 70 6f 72 74  faces for report
1edf0 69 6e 67 20 6f 6e 20 74 68 65 20 73 74 61 74 75  ing on the statu
1ee00 73 0a 2a 2a 20 6f 66 20 74 68 65 20 5b 73 71 6c  s.** of the [sql
1ee10 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 2c 20  ite3_malloc()], 
1ee20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29 5d  [sqlite3_free()]
1ee30 2c 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 72  , and [sqlite3_r
1ee40 65 61 6c 6c 6f 63 28 29 5d 0a 2a 2a 20 72 6f 75  ealloc()].** rou
1ee50 74 69 6e 65 73 2c 20 77 68 69 63 68 20 66 6f 72  tines, which for
1ee60 6d 20 74 68 65 20 62 75 69 6c 74 2d 69 6e 20 6d  m the built-in m
1ee70 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e  emory allocation
1ee80 20 73 75 62 73 79 73 74 65 6d 2e 0a 2a 2a 0a 2a   subsystem..**.*
1ee90 2a 20 5e 54 68 65 20 5b 73 71 6c 69 74 65 33 5f  * ^The [sqlite3_
1eea0 6d 65 6d 6f 72 79 5f 75 73 65 64 28 29 5d 20 72  memory_used()] r
1eeb0 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73 20 74  outine returns t
1eec0 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74  he number of byt
1eed0 65 73 0a 2a 2a 20 6f 66 20 6d 65 6d 6f 72 79 20  es.** of memory 
1eee0 63 75 72 72 65 6e 74 6c 79 20 6f 75 74 73 74 61  currently outsta
1eef0 6e 64 69 6e 67 20 28 6d 61 6c 6c 6f 63 65 64 20  nding (malloced 
1ef00 62 75 74 20 6e 6f 74 20 66 72 65 65 64 29 2e 0a  but not freed)..
1ef10 2a 2a 20 5e 54 68 65 20 5b 73 71 6c 69 74 65 33  ** ^The [sqlite3
1ef20 5f 6d 65 6d 6f 72 79 5f 68 69 67 68 77 61 74 65  _memory_highwate
1ef30 72 28 29 5d 20 72 6f 75 74 69 6e 65 20 72 65 74  r()] routine ret
1ef40 75 72 6e 73 20 74 68 65 20 6d 61 78 69 6d 75 6d  urns the maximum
1ef50 0a 2a 2a 20 76 61 6c 75 65 20 6f 66 20 5b 73 71  .** value of [sq
1ef60 6c 69 74 65 33 5f 6d 65 6d 6f 72 79 5f 75 73 65  lite3_memory_use
1ef70 64 28 29 5d 20 73 69 6e 63 65 20 74 68 65 20 68  d()] since the h
1ef80 69 67 68 2d 77 61 74 65 72 20 6d 61 72 6b 0a 2a  igh-water mark.*
1ef90 2a 20 77 61 73 20 6c 61 73 74 20 72 65 73 65 74  * was last reset
1efa0 2e 20 20 5e 54 68 65 20 76 61 6c 75 65 73 20 72  .  ^The values r
1efb0 65 74 75 72 6e 65 64 20 62 79 20 5b 73 71 6c 69  eturned by [sqli
1efc0 74 65 33 5f 6d 65 6d 6f 72 79 5f 75 73 65 64 28  te3_memory_used(
1efd0 29 5d 20 61 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74  )] and.** [sqlit
1efe0 65 33 5f 6d 65 6d 6f 72 79 5f 68 69 67 68 77 61  e3_memory_highwa
1eff0 74 65 72 28 29 5d 20 69 6e 63 6c 75 64 65 20 61  ter()] include a
1f000 6e 79 20 6f 76 65 72 68 65 61 64 0a 2a 2a 20 61  ny overhead.** a
1f010 64 64 65 64 20 62 79 20 53 51 4c 69 74 65 20 69  dded by SQLite i
1f020 6e 20 69 74 73 20 69 6d 70 6c 65 6d 65 6e 74 61  n its implementa
1f030 74 69 6f 6e 20 6f 66 20 5b 73 71 6c 69 74 65 33  tion of [sqlite3
1f040 5f 6d 61 6c 6c 6f 63 28 29 5d 2c 0a 2a 2a 20 62  _malloc()],.** b
1f050 75 74 20 6e 6f 74 20 6f 76 65 72 68 65 61 64 20  ut not overhead 
1f060 61 64 64 65 64 20 62 79 20 74 68 65 20 61 6e 79  added by the any
1f070 20 75 6e 64 65 72 6c 79 69 6e 67 20 73 79 73 74   underlying syst
1f080 65 6d 20 6c 69 62 72 61 72 79 0a 2a 2a 20 72 6f  em library.** ro
1f090 75 74 69 6e 65 73 20 74 68 61 74 20 5b 73 71 6c  utines that [sql
1f0a0 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 20 6d  ite3_malloc()] m
1f0b0 61 79 20 63 61 6c 6c 2e 0a 2a 2a 0a 2a 2a 20 5e  ay call..**.** ^
1f0c0 54 68 65 20 6d 65 6d 6f 72 79 20 68 69 67 68 2d  The memory high-
1f0d0 77 61 74 65 72 20 6d 61 72 6b 20 69 73 20 72 65  water mark is re
1f0e0 73 65 74 20 74 6f 20 74 68 65 20 63 75 72 72 65  set to the curre
1f0f0 6e 74 20 76 61 6c 75 65 20 6f 66 0a 2a 2a 20 5b  nt value of.** [
1f100 73 71 6c 69 74 65 33 5f 6d 65 6d 6f 72 79 5f 75  sqlite3_memory_u
1f110 73 65 64 28 29 5d 20 69 66 20 61 6e 64 20 6f 6e  sed()] if and on
1f120 6c 79 20 69 66 20 74 68 65 20 70 61 72 61 6d 65  ly if the parame
1f130 74 65 72 20 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74  ter to.** [sqlit
1f140 65 33 5f 6d 65 6d 6f 72 79 5f 68 69 67 68 77 61  e3_memory_highwa
1f150 74 65 72 28 29 5d 20 69 73 20 74 72 75 65 2e 20  ter()] is true. 
1f160 20 5e 54 68 65 20 76 61 6c 75 65 20 72 65 74 75   ^The value retu
1f170 72 6e 65 64 0a 2a 2a 20 62 79 20 5b 73 71 6c 69  rned.** by [sqli
1f180 74 65 33 5f 6d 65 6d 6f 72 79 5f 68 69 67 68 77  te3_memory_highw
1f190 61 74 65 72 28 31 29 5d 20 69 73 20 74 68 65 20  ater(1)] is the 
1f1a0 68 69 67 68 2d 77 61 74 65 72 20 6d 61 72 6b 0a  high-water mark.
1f1b0 2a 2a 20 70 72 69 6f 72 20 74 6f 20 74 68 65 20  ** prior to the 
1f1c0 72 65 73 65 74 2e 0a 2a 2f 0a 73 71 6c 69 74 65  reset..*/.sqlite
1f1d0 33 5f 69 6e 74 36 34 20 73 71 6c 69 74 65 33 5f  3_int64 sqlite3_
1f1e0 6d 65 6d 6f 72 79 5f 75 73 65 64 28 76 6f 69 64  memory_used(void
1f1f0 29 3b 0a 73 71 6c 69 74 65 33 5f 69 6e 74 36 34  );.sqlite3_int64
1f200 20 73 71 6c 69 74 65 33 5f 6d 65 6d 6f 72 79 5f   sqlite3_memory_
1f210 68 69 67 68 77 61 74 65 72 28 69 6e 74 20 72 65  highwater(int re
1f220 73 65 74 46 6c 61 67 29 3b 0a 0a 2f 2a 0a 2a 2a  setFlag);../*.**
1f230 20 43 41 50 49 33 52 45 46 3a 20 50 73 65 75 64   CAPI3REF: Pseud
1f240 6f 2d 52 61 6e 64 6f 6d 20 4e 75 6d 62 65 72 20  o-Random Number 
1f250 47 65 6e 65 72 61 74 6f 72 0a 2a 2a 0a 2a 2a 20  Generator.**.** 
1f260 53 51 4c 69 74 65 20 63 6f 6e 74 61 69 6e 73 20  SQLite contains 
1f270 61 20 68 69 67 68 2d 71 75 61 6c 69 74 79 20 70  a high-quality p
1f280 73 65 75 64 6f 2d 72 61 6e 64 6f 6d 20 6e 75 6d  seudo-random num
1f290 62 65 72 20 67 65 6e 65 72 61 74 6f 72 20 28 50  ber generator (P
1f2a0 52 4e 47 29 20 75 73 65 64 20 74 6f 0a 2a 2a 20  RNG) used to.** 
1f2b0 73 65 6c 65 63 74 20 72 61 6e 64 6f 6d 20 5b 52  select random [R
1f2c0 4f 57 49 44 20 7c 20 52 4f 57 49 44 73 5d 20 77  OWID | ROWIDs] w
1f2d0 68 65 6e 20 69 6e 73 65 72 74 69 6e 67 20 6e 65  hen inserting ne
1f2e0 77 20 72 65 63 6f 72 64 73 20 69 6e 74 6f 20 61  w records into a
1f2f0 20 74 61 62 6c 65 20 74 68 61 74 0a 2a 2a 20 61   table that.** a
1f300 6c 72 65 61 64 79 20 75 73 65 73 20 74 68 65 20  lready uses the 
1f310 6c 61 72 67 65 73 74 20 70 6f 73 73 69 62 6c 65  largest possible
1f320 20 5b 52 4f 57 49 44 5d 2e 20 20 54 68 65 20 50   [ROWID].  The P
1f330 52 4e 47 20 69 73 20 61 6c 73 6f 20 75 73 65 64  RNG is also used
1f340 20 66 6f 72 0a 2a 2a 20 74 68 65 20 62 75 69 6c   for.** the buil
1f350 64 2d 69 6e 20 72 61 6e 64 6f 6d 28 29 20 61 6e  d-in random() an
1f360 64 20 72 61 6e 64 6f 6d 62 6c 6f 62 28 29 20 53  d randomblob() S
1f370 51 4c 20 66 75 6e 63 74 69 6f 6e 73 2e 20 20 54  QL functions.  T
1f380 68 69 73 20 69 6e 74 65 72 66 61 63 65 20 61 6c  his interface al
1f390 6c 6f 77 73 0a 2a 2a 20 61 70 70 6c 69 63 61 74  lows.** applicat
1f3a0 69 6f 6e 73 20 74 6f 20 61 63 63 65 73 73 20 74  ions to access t
1f3b0 68 65 20 73 61 6d 65 20 50 52 4e 47 20 66 6f 72  he same PRNG for
1f3c0 20 6f 74 68 65 72 20 70 75 72 70 6f 73 65 73 2e   other purposes.
1f3d0 0a 2a 2a 0a 2a 2a 20 5e 41 20 63 61 6c 6c 20 74  .**.** ^A call t
1f3e0 6f 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 73  o this routine s
1f3f0 74 6f 72 65 73 20 4e 20 62 79 74 65 73 20 6f 66  tores N bytes of
1f400 20 72 61 6e 64 6f 6d 6e 65 73 73 20 69 6e 74 6f   randomness into
1f410 20 62 75 66 66 65 72 20 50 2e 0a 2a 2a 20 5e 54   buffer P..** ^T
1f420 68 65 20 50 20 70 61 72 61 6d 65 74 65 72 20 63  he P parameter c
1f430 61 6e 20 62 65 20 61 20 4e 55 4c 4c 20 70 6f 69  an be a NULL poi
1f440 6e 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20  nter..**.** ^If 
1f450 74 68 69 73 20 72 6f 75 74 69 6e 65 20 68 61 73  this routine has
1f460 20 6e 6f 74 20 62 65 65 6e 20 70 72 65 76 69 6f   not been previo
1f470 75 73 6c 79 20 63 61 6c 6c 65 64 20 6f 72 20 69  usly called or i
1f480 66 20 74 68 65 20 70 72 65 76 69 6f 75 73 0a 2a  f the previous.*
1f490 2a 20 63 61 6c 6c 20 68 61 64 20 4e 20 6c 65 73  * call had N les
1f4a0 73 20 74 68 61 6e 20 6f 6e 65 20 6f 72 20 61 20  s than one or a 
1f4b0 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 66 6f 72  NULL pointer for
1f4c0 20 50 2c 20 74 68 65 6e 20 74 68 65 20 50 52 4e   P, then the PRN
1f4d0 47 20 69 73 0a 2a 2a 20 73 65 65 64 65 64 20 75  G is.** seeded u
1f4e0 73 69 6e 67 20 72 61 6e 64 6f 6d 6e 65 73 73 20  sing randomness 
1f4f0 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 74 68  obtained from th
1f500 65 20 78 52 61 6e 64 6f 6d 6e 65 73 73 20 6d 65  e xRandomness me
1f510 74 68 6f 64 20 6f 66 0a 2a 2a 20 74 68 65 20 64  thod of.** the d
1f520 65 66 61 75 6c 74 20 5b 73 71 6c 69 74 65 33 5f  efault [sqlite3_
1f530 76 66 73 5d 20 6f 62 6a 65 63 74 2e 0a 2a 2a 20  vfs] object..** 
1f540 5e 49 66 20 74 68 65 20 70 72 65 76 69 6f 75 73  ^If the previous
1f550 20 63 61 6c 6c 20 74 6f 20 74 68 69 73 20 72 6f   call to this ro
1f560 75 74 69 6e 65 20 68 61 64 20 61 6e 20 4e 20 6f  utine had an N o
1f570 66 20 31 20 6f 72 20 6d 6f 72 65 20 61 6e 64 20  f 1 or more and 
1f580 61 0a 2a 2a 20 6e 6f 6e 2d 4e 55 4c 4c 20 50 20  a.** non-NULL P 
1f590 74 68 65 6e 20 74 68 65 20 70 73 65 75 64 6f 2d  then the pseudo-
1f5a0 72 61 6e 64 6f 6d 6e 65 73 73 20 69 73 20 67 65  randomness is ge
1f5b0 6e 65 72 61 74 65 64 0a 2a 2a 20 69 6e 74 65 72  nerated.** inter
1f5c0 6e 61 6c 6c 79 20 61 6e 64 20 77 69 74 68 6f 75  nally and withou
1f5d0 74 20 72 65 63 6f 75 72 73 65 20 74 6f 20 74 68  t recourse to th
1f5e0 65 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5d 20  e [sqlite3_vfs] 
1f5f0 78 52 61 6e 64 6f 6d 6e 65 73 73 0a 2a 2a 20 6d  xRandomness.** m
1f600 65 74 68 6f 64 2e 0a 2a 2f 0a 76 6f 69 64 20 73  ethod..*/.void s
1f610 71 6c 69 74 65 33 5f 72 61 6e 64 6f 6d 6e 65 73  qlite3_randomnes
1f620 73 28 69 6e 74 20 4e 2c 20 76 6f 69 64 20 2a 50  s(int N, void *P
1f630 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
1f640 45 46 3a 20 43 6f 6d 70 69 6c 65 2d 54 69 6d 65  EF: Compile-Time
1f650 20 41 75 74 68 6f 72 69 7a 61 74 69 6f 6e 20 43   Authorization C
1f660 61 6c 6c 62 61 63 6b 73 0a 2a 2a 20 4d 45 54 48  allbacks.** METH
1f670 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a  OD: sqlite3.**.*
1f680 2a 20 5e 54 68 69 73 20 72 6f 75 74 69 6e 65 20  * ^This routine 
1f690 72 65 67 69 73 74 65 72 73 20 61 6e 20 61 75 74  registers an aut
1f6a0 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61 63 6b  horizer callback
1f6b0 20 77 69 74 68 20 61 20 70 61 72 74 69 63 75 6c   with a particul
1f6c0 61 72 0a 2a 2a 20 5b 64 61 74 61 62 61 73 65 20  ar.** [database 
1f6d0 63 6f 6e 6e 65 63 74 69 6f 6e 5d 2c 20 73 75 70  connection], sup
1f6e0 70 6c 69 65 64 20 69 6e 20 74 68 65 20 66 69 72  plied in the fir
1f6f0 73 74 20 61 72 67 75 6d 65 6e 74 2e 0a 2a 2a 20  st argument..** 
1f700 5e 54 68 65 20 61 75 74 68 6f 72 69 7a 65 72 20  ^The authorizer 
1f710 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f  callback is invo
1f720 6b 65 64 20 61 73 20 53 51 4c 20 73 74 61 74 65  ked as SQL state
1f730 6d 65 6e 74 73 20 61 72 65 20 62 65 69 6e 67 20  ments are being 
1f740 63 6f 6d 70 69 6c 65 64 0a 2a 2a 20 62 79 20 5b  compiled.** by [
1f750 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 28  sqlite3_prepare(
1f760 29 5d 20 6f 72 20 69 74 73 20 76 61 72 69 61 6e  )] or its varian
1f770 74 73 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70  ts [sqlite3_prep
1f780 61 72 65 5f 76 32 28 29 5d 2c 0a 2a 2a 20 5b 73  are_v2()],.** [s
1f790 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 31 36  qlite3_prepare16
1f7a0 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 33  ()] and [sqlite3
1f7b0 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28 29 5d  _prepare16_v2()]
1f7c0 2e 20 20 5e 41 74 20 76 61 72 69 6f 75 73 0a 2a  .  ^At various.*
1f7d0 2a 20 70 6f 69 6e 74 73 20 64 75 72 69 6e 67 20  * points during 
1f7e0 74 68 65 20 63 6f 6d 70 69 6c 61 74 69 6f 6e 20  the compilation 
1f7f0 70 72 6f 63 65 73 73 2c 20 61 73 20 6c 6f 67 69  process, as logi
1f800 63 20 69 73 20 62 65 69 6e 67 20 63 72 65 61 74  c is being creat
1f810 65 64 0a 2a 2a 20 74 6f 20 70 65 72 66 6f 72 6d  ed.** to perform
1f820 20 76 61 72 69 6f 75 73 20 61 63 74 69 6f 6e 73   various actions
1f830 2c 20 74 68 65 20 61 75 74 68 6f 72 69 7a 65 72  , the authorizer
1f840 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76   callback is inv
1f850 6f 6b 65 64 20 74 6f 0a 2a 2a 20 73 65 65 20 69  oked to.** see i
1f860 66 20 74 68 6f 73 65 20 61 63 74 69 6f 6e 73 20  f those actions 
1f870 61 72 65 20 61 6c 6c 6f 77 65 64 2e 20 20 5e 54  are allowed.  ^T
1f880 68 65 20 61 75 74 68 6f 72 69 7a 65 72 20 63 61  he authorizer ca
1f890 6c 6c 62 61 63 6b 20 73 68 6f 75 6c 64 0a 2a 2a  llback should.**
1f8a0 20 72 65 74 75 72 6e 20 5b 53 51 4c 49 54 45 5f   return [SQLITE_
1f8b0 4f 4b 5d 20 74 6f 20 61 6c 6c 6f 77 20 74 68 65  OK] to allow the
1f8c0 20 61 63 74 69 6f 6e 2c 20 5b 53 51 4c 49 54 45   action, [SQLITE
1f8d0 5f 49 47 4e 4f 52 45 5d 20 74 6f 20 64 69 73 61  _IGNORE] to disa
1f8e0 6c 6c 6f 77 20 74 68 65 0a 2a 2a 20 73 70 65 63  llow the.** spec
1f8f0 69 66 69 63 20 61 63 74 69 6f 6e 20 62 75 74 20  ific action but 
1f900 61 6c 6c 6f 77 20 74 68 65 20 53 51 4c 20 73 74  allow the SQL st
1f910 61 74 65 6d 65 6e 74 20 74 6f 20 63 6f 6e 74 69  atement to conti
1f920 6e 75 65 20 74 6f 20 62 65 0a 2a 2a 20 63 6f 6d  nue to be.** com
1f930 70 69 6c 65 64 2c 20 6f 72 20 5b 53 51 4c 49 54  piled, or [SQLIT
1f940 45 5f 44 45 4e 59 5d 20 74 6f 20 63 61 75 73 65  E_DENY] to cause
1f950 20 74 68 65 20 65 6e 74 69 72 65 20 53 51 4c 20   the entire SQL 
1f960 73 74 61 74 65 6d 65 6e 74 20 74 6f 20 62 65 0a  statement to be.
1f970 2a 2a 20 72 65 6a 65 63 74 65 64 20 77 69 74 68  ** rejected with
1f980 20 61 6e 20 65 72 72 6f 72 2e 20 20 5e 49 66 20   an error.  ^If 
1f990 74 68 65 20 61 75 74 68 6f 72 69 7a 65 72 20 63  the authorizer c
1f9a0 61 6c 6c 62 61 63 6b 20 72 65 74 75 72 6e 73 0a  allback returns.
1f9b0 2a 2a 20 61 6e 79 20 76 61 6c 75 65 20 6f 74 68  ** any value oth
1f9c0 65 72 20 74 68 61 6e 20 5b 53 51 4c 49 54 45 5f  er than [SQLITE_
1f9d0 49 47 4e 4f 52 45 5d 2c 20 5b 53 51 4c 49 54 45  IGNORE], [SQLITE
1f9e0 5f 4f 4b 5d 2c 20 6f 72 20 5b 53 51 4c 49 54 45  _OK], or [SQLITE
1f9f0 5f 44 45 4e 59 5d 0a 2a 2a 20 74 68 65 6e 20 74  _DENY].** then t
1fa00 68 65 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70  he [sqlite3_prep
1fa10 61 72 65 5f 76 32 28 29 5d 20 6f 72 20 65 71 75  are_v2()] or equ
1fa20 69 76 61 6c 65 6e 74 20 63 61 6c 6c 20 74 68 61  ivalent call tha
1fa30 74 20 74 72 69 67 67 65 72 65 64 0a 2a 2a 20 74  t triggered.** t
1fa40 68 65 20 61 75 74 68 6f 72 69 7a 65 72 20 77 69  he authorizer wi
1fa50 6c 6c 20 66 61 69 6c 20 77 69 74 68 20 61 6e 20  ll fail with an 
1fa60 65 72 72 6f 72 20 6d 65 73 73 61 67 65 2e 0a 2a  error message..*
1fa70 2a 0a 2a 2a 20 57 68 65 6e 20 74 68 65 20 63 61  *.** When the ca
1fa80 6c 6c 62 61 63 6b 20 72 65 74 75 72 6e 73 20 5b  llback returns [
1fa90 53 51 4c 49 54 45 5f 4f 4b 5d 2c 20 74 68 61 74  SQLITE_OK], that
1faa0 20 6d 65 61 6e 73 20 74 68 65 20 6f 70 65 72 61   means the opera
1fab0 74 69 6f 6e 0a 2a 2a 20 72 65 71 75 65 73 74 65  tion.** requeste
1fac0 64 20 69 73 20 6f 6b 2e 20 20 5e 57 68 65 6e 20  d is ok.  ^When 
1fad0 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 72 65 74  the callback ret
1fae0 75 72 6e 73 20 5b 53 51 4c 49 54 45 5f 44 45 4e  urns [SQLITE_DEN
1faf0 59 5d 2c 20 74 68 65 0a 2a 2a 20 5b 73 71 6c 69  Y], the.** [sqli
1fb00 74 65 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29  te3_prepare_v2()
1fb10 5d 20 6f 72 20 65 71 75 69 76 61 6c 65 6e 74 20  ] or equivalent 
1fb20 63 61 6c 6c 20 74 68 61 74 20 74 72 69 67 67 65  call that trigge
1fb30 72 65 64 20 74 68 65 0a 2a 2a 20 61 75 74 68 6f  red the.** autho
1fb40 72 69 7a 65 72 20 77 69 6c 6c 20 66 61 69 6c 20  rizer will fail 
1fb50 77 69 74 68 20 61 6e 20 65 72 72 6f 72 20 6d 65  with an error me
1fb60 73 73 61 67 65 20 65 78 70 6c 61 69 6e 69 6e 67  ssage explaining
1fb70 20 74 68 61 74 0a 2a 2a 20 61 63 63 65 73 73 20   that.** access 
1fb80 69 73 20 64 65 6e 69 65 64 2e 20 0a 2a 2a 0a 2a  is denied. .**.*
1fb90 2a 20 5e 54 68 65 20 66 69 72 73 74 20 70 61 72  * ^The first par
1fba0 61 6d 65 74 65 72 20 74 6f 20 74 68 65 20 61 75  ameter to the au
1fbb0 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61 63  thorizer callbac
1fbc0 6b 20 69 73 20 61 20 63 6f 70 79 20 6f 66 20 74  k is a copy of t
1fbd0 68 65 20 74 68 69 72 64 0a 2a 2a 20 70 61 72 61  he third.** para
1fbe0 6d 65 74 65 72 20 74 6f 20 74 68 65 20 73 71 6c  meter to the sql
1fbf0 69 74 65 33 5f 73 65 74 5f 61 75 74 68 6f 72 69  ite3_set_authori
1fc00 7a 65 72 28 29 20 69 6e 74 65 72 66 61 63 65 2e  zer() interface.
1fc10 20 5e 54 68 65 20 73 65 63 6f 6e 64 20 70 61 72   ^The second par
1fc20 61 6d 65 74 65 72 0a 2a 2a 20 74 6f 20 74 68 65  ameter.** to the
1fc30 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 61 6e 20   callback is an 
1fc40 69 6e 74 65 67 65 72 20 5b 53 51 4c 49 54 45 5f  integer [SQLITE_
1fc50 43 4f 50 59 20 7c 20 61 63 74 69 6f 6e 20 63 6f  COPY | action co
1fc60 64 65 5d 20 74 68 61 74 20 73 70 65 63 69 66 69  de] that specifi
1fc70 65 73 0a 2a 2a 20 74 68 65 20 70 61 72 74 69 63  es.** the partic
1fc80 75 6c 61 72 20 61 63 74 69 6f 6e 20 74 6f 20 62  ular action to b
1fc90 65 20 61 75 74 68 6f 72 69 7a 65 64 2e 20 5e 54  e authorized. ^T
1fca0 68 65 20 74 68 69 72 64 20 74 68 72 6f 75 67 68  he third through
1fcb0 20 73 69 78 74 68 20 70 61 72 61 6d 65 74 65 72   sixth parameter
1fcc0 73 0a 2a 2a 20 74 6f 20 74 68 65 20 63 61 6c 6c  s.** to the call
1fcd0 62 61 63 6b 20 61 72 65 20 7a 65 72 6f 2d 74 65  back are zero-te
1fce0 72 6d 69 6e 61 74 65 64 20 73 74 72 69 6e 67 73  rminated strings
1fcf0 20 74 68 61 74 20 63 6f 6e 74 61 69 6e 20 61 64   that contain ad
1fd00 64 69 74 69 6f 6e 61 6c 0a 2a 2a 20 64 65 74 61  ditional.** deta
1fd10 69 6c 73 20 61 62 6f 75 74 20 74 68 65 20 61 63  ils about the ac
1fd20 74 69 6f 6e 20 74 6f 20 62 65 20 61 75 74 68 6f  tion to be autho
1fd30 72 69 7a 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66  rized..**.** ^If
1fd40 20 74 68 65 20 61 63 74 69 6f 6e 20 63 6f 64 65   the action code
1fd50 20 69 73 20 5b 53 51 4c 49 54 45 5f 52 45 41 44   is [SQLITE_READ
1fd60 5d 0a 2a 2a 20 61 6e 64 20 74 68 65 20 63 61 6c  ].** and the cal
1fd70 6c 62 61 63 6b 20 72 65 74 75 72 6e 73 20 5b 53  lback returns [S
1fd80 51 4c 49 54 45 5f 49 47 4e 4f 52 45 5d 20 74 68  QLITE_IGNORE] th
1fd90 65 6e 20 74 68 65 0a 2a 2a 20 5b 70 72 65 70 61  en the.** [prepa
1fda0 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 73  red statement] s
1fdb0 74 61 74 65 6d 65 6e 74 20 69 73 20 63 6f 6e 73  tatement is cons
1fdc0 74 72 75 63 74 65 64 20 74 6f 20 73 75 62 73 74  tructed to subst
1fdd0 69 74 75 74 65 0a 2a 2a 20 61 20 4e 55 4c 4c 20  itute.** a NULL 
1fde0 76 61 6c 75 65 20 69 6e 20 70 6c 61 63 65 20 6f  value in place o
1fdf0 66 20 74 68 65 20 74 61 62 6c 65 20 63 6f 6c 75  f the table colu
1fe00 6d 6e 20 74 68 61 74 20 77 6f 75 6c 64 20 68 61  mn that would ha
1fe10 76 65 0a 2a 2a 20 62 65 65 6e 20 72 65 61 64 20  ve.** been read 
1fe20 69 66 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 68  if [SQLITE_OK] h
1fe30 61 64 20 62 65 65 6e 20 72 65 74 75 72 6e 65 64  ad been returned
1fe40 2e 20 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 49  .  The [SQLITE_I
1fe50 47 4e 4f 52 45 5d 0a 2a 2a 20 72 65 74 75 72 6e  GNORE].** return
1fe60 20 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20   can be used to 
1fe70 64 65 6e 79 20 61 6e 20 75 6e 74 72 75 73 74 65  deny an untruste
1fe80 64 20 75 73 65 72 20 61 63 63 65 73 73 20 74 6f  d user access to
1fe90 20 69 6e 64 69 76 69 64 75 61 6c 0a 2a 2a 20 63   individual.** c
1fea0 6f 6c 75 6d 6e 73 20 6f 66 20 61 20 74 61 62 6c  olumns of a tabl
1feb0 65 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 61 63  e..** ^If the ac
1fec0 74 69 6f 6e 20 63 6f 64 65 20 69 73 20 5b 53 51  tion code is [SQ
1fed0 4c 49 54 45 5f 44 45 4c 45 54 45 5d 20 61 6e 64  LITE_DELETE] and
1fee0 20 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 72 65   the callback re
1fef0 74 75 72 6e 73 0a 2a 2a 20 5b 53 51 4c 49 54 45  turns.** [SQLITE
1ff00 5f 49 47 4e 4f 52 45 5d 20 74 68 65 6e 20 74 68  _IGNORE] then th
1ff10 65 20 5b 44 45 4c 45 54 45 5d 20 6f 70 65 72 61  e [DELETE] opera
1ff20 74 69 6f 6e 20 70 72 6f 63 65 65 64 73 20 62 75  tion proceeds bu
1ff30 74 20 74 68 65 0a 2a 2a 20 5b 74 72 75 6e 63 61  t the.** [trunca
1ff40 74 65 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e 5d  te optimization]
1ff50 20 69 73 20 64 69 73 61 62 6c 65 64 20 61 6e 64   is disabled and
1ff60 20 61 6c 6c 20 72 6f 77 73 20 61 72 65 20 64 65   all rows are de
1ff70 6c 65 74 65 64 20 69 6e 64 69 76 69 64 75 61 6c  leted individual
1ff80 6c 79 2e 0a 2a 2a 0a 2a 2a 20 41 6e 20 61 75 74  ly..**.** An aut
1ff90 68 6f 72 69 7a 65 72 20 69 73 20 75 73 65 64 20  horizer is used 
1ffa0 77 68 65 6e 20 5b 73 71 6c 69 74 65 33 5f 70 72  when [sqlite3_pr
1ffb0 65 70 61 72 65 20 7c 20 70 72 65 70 61 72 69 6e  epare | preparin
1ffc0 67 5d 0a 2a 2a 20 53 51 4c 20 73 74 61 74 65 6d  g].** SQL statem
1ffd0 65 6e 74 73 20 66 72 6f 6d 20 61 6e 20 75 6e 74  ents from an unt
1ffe0 72 75 73 74 65 64 20 73 6f 75 72 63 65 2c 20 74  rusted source, t
1fff0 6f 20 65 6e 73 75 72 65 20 74 68 61 74 20 74 68  o ensure that th
20000 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73  e SQL statements
20010 0a 2a 2a 20 64 6f 20 6e 6f 74 20 74 72 79 20 74  .** do not try t
20020 6f 20 61 63 63 65 73 73 20 64 61 74 61 20 74 68  o access data th
20030 65 79 20 61 72 65 20 6e 6f 74 20 61 6c 6c 6f 77  ey are not allow
20040 65 64 20 74 6f 20 73 65 65 2c 20 6f 72 20 74 68  ed to see, or th
20050 61 74 20 74 68 65 79 20 64 6f 20 6e 6f 74 0a 2a  at they do not.*
20060 2a 20 74 72 79 20 74 6f 20 65 78 65 63 75 74 65  * try to execute
20070 20 6d 61 6c 69 63 69 6f 75 73 20 73 74 61 74 65   malicious state
20080 6d 65 6e 74 73 20 74 68 61 74 20 64 61 6d 61 67  ments that damag
20090 65 20 74 68 65 20 64 61 74 61 62 61 73 65 2e 20  e the database. 
200a0 20 46 6f 72 0a 2a 2a 20 65 78 61 6d 70 6c 65 2c   For.** example,
200b0 20 61 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 20   an application 
200c0 6d 61 79 20 61 6c 6c 6f 77 20 61 20 75 73 65 72  may allow a user
200d0 20 74 6f 20 65 6e 74 65 72 20 61 72 62 69 74 72   to enter arbitr
200e0 61 72 79 0a 2a 2a 20 53 51 4c 20 71 75 65 72 69  ary.** SQL queri
200f0 65 73 20 66 6f 72 20 65 76 61 6c 75 61 74 69 6f  es for evaluatio
20100 6e 20 62 79 20 61 20 64 61 74 61 62 61 73 65 2e  n by a database.
20110 20 20 42 75 74 20 74 68 65 20 61 70 70 6c 69 63    But the applic
20120 61 74 69 6f 6e 20 64 6f 65 73 0a 2a 2a 20 6e 6f  ation does.** no
20130 74 20 77 61 6e 74 20 74 68 65 20 75 73 65 72 20  t want the user 
20140 74 6f 20 62 65 20 61 62 6c 65 20 74 6f 20 6d 61  to be able to ma
20150 6b 65 20 61 72 62 69 74 72 61 72 79 20 63 68 61  ke arbitrary cha
20160 6e 67 65 73 20 74 6f 20 74 68 65 0a 2a 2a 20 64  nges to the.** d
20170 61 74 61 62 61 73 65 2e 20 20 41 6e 20 61 75 74  atabase.  An aut
20180 68 6f 72 69 7a 65 72 20 63 6f 75 6c 64 20 74 68  horizer could th
20190 65 6e 20 62 65 20 70 75 74 20 69 6e 20 70 6c 61  en be put in pla
201a0 63 65 20 77 68 69 6c 65 20 74 68 65 0a 2a 2a 20  ce while the.** 
201b0 75 73 65 72 2d 65 6e 74 65 72 65 64 20 53 51 4c  user-entered SQL
201c0 20 69 73 20 62 65 69 6e 67 20 5b 73 71 6c 69 74   is being [sqlit
201d0 65 33 5f 70 72 65 70 61 72 65 20 7c 20 70 72 65  e3_prepare | pre
201e0 70 61 72 65 64 5d 20 74 68 61 74 0a 2a 2a 20 64  pared] that.** d
201f0 69 73 61 6c 6c 6f 77 73 20 65 76 65 72 79 74 68  isallows everyth
20200 69 6e 67 20 65 78 63 65 70 74 20 5b 53 45 4c 45  ing except [SELE
20210 43 54 5d 20 73 74 61 74 65 6d 65 6e 74 73 2e 0a  CT] statements..
20220 2a 2a 0a 2a 2a 20 41 70 70 6c 69 63 61 74 69 6f  **.** Applicatio
20230 6e 73 20 74 68 61 74 20 6e 65 65 64 20 74 6f 20  ns that need to 
20240 70 72 6f 63 65 73 73 20 53 51 4c 20 66 72 6f 6d  process SQL from
20250 20 75 6e 74 72 75 73 74 65 64 20 73 6f 75 72 63   untrusted sourc
20260 65 73 0a 2a 2a 20 6d 69 67 68 74 20 61 6c 73 6f  es.** might also
20270 20 63 6f 6e 73 69 64 65 72 20 6c 6f 77 65 72 69   consider loweri
20280 6e 67 20 72 65 73 6f 75 72 63 65 20 6c 69 6d 69  ng resource limi
20290 74 73 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65  ts using [sqlite
202a0 33 5f 6c 69 6d 69 74 28 29 5d 0a 2a 2a 20 61 6e  3_limit()].** an
202b0 64 20 6c 69 6d 69 74 69 6e 67 20 64 61 74 61 62  d limiting datab
202c0 61 73 65 20 73 69 7a 65 20 75 73 69 6e 67 20 74  ase size using t
202d0 68 65 20 5b 6d 61 78 5f 70 61 67 65 5f 63 6f 75  he [max_page_cou
202e0 6e 74 5d 20 5b 50 52 41 47 4d 41 5d 0a 2a 2a 20  nt] [PRAGMA].** 
202f0 69 6e 20 61 64 64 69 74 69 6f 6e 20 74 6f 20 75  in addition to u
20300 73 69 6e 67 20 61 6e 20 61 75 74 68 6f 72 69 7a  sing an authoriz
20310 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 28 4f 6e 6c 79  er..**.** ^(Only
20320 20 61 20 73 69 6e 67 6c 65 20 61 75 74 68 6f 72   a single author
20330 69 7a 65 72 20 63 61 6e 20 62 65 20 69 6e 20 70  izer can be in p
20340 6c 61 63 65 20 6f 6e 20 61 20 64 61 74 61 62 61  lace on a databa
20350 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 0a 2a 2a  se connection.**
20360 20 61 74 20 61 20 74 69 6d 65 2e 20 20 45 61 63   at a time.  Eac
20370 68 20 63 61 6c 6c 20 74 6f 20 73 71 6c 69 74 65  h call to sqlite
20380 33 5f 73 65 74 5f 61 75 74 68 6f 72 69 7a 65 72  3_set_authorizer
20390 20 6f 76 65 72 72 69 64 65 73 20 74 68 65 0a 2a   overrides the.*
203a0 2a 20 70 72 65 76 69 6f 75 73 20 63 61 6c 6c 2e  * previous call.
203b0 29 5e 20 20 5e 44 69 73 61 62 6c 65 20 74 68 65  )^  ^Disable the
203c0 20 61 75 74 68 6f 72 69 7a 65 72 20 62 79 20 69   authorizer by i
203d0 6e 73 74 61 6c 6c 69 6e 67 20 61 20 4e 55 4c 4c  nstalling a NULL
203e0 20 63 61 6c 6c 62 61 63 6b 2e 0a 2a 2a 20 54 68   callback..** Th
203f0 65 20 61 75 74 68 6f 72 69 7a 65 72 20 69 73 20  e authorizer is 
20400 64 69 73 61 62 6c 65 64 20 62 79 20 64 65 66 61  disabled by defa
20410 75 6c 74 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 61  ult..**.** The a
20420 75 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61  uthorizer callba
20430 63 6b 20 6d 75 73 74 20 6e 6f 74 20 64 6f 20 61  ck must not do a
20440 6e 79 74 68 69 6e 67 20 74 68 61 74 20 77 69 6c  nything that wil
20450 6c 20 6d 6f 64 69 66 79 0a 2a 2a 20 74 68 65 20  l modify.** the 
20460 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
20470 69 6f 6e 20 74 68 61 74 20 69 6e 76 6f 6b 65 64  ion that invoked
20480 20 74 68 65 20 61 75 74 68 6f 72 69 7a 65 72 20   the authorizer 
20490 63 61 6c 6c 62 61 63 6b 2e 0a 2a 2a 20 4e 6f 74  callback..** Not
204a0 65 20 74 68 61 74 20 5b 73 71 6c 69 74 65 33 5f  e that [sqlite3_
204b0 70 72 65 70 61 72 65 5f 76 32 28 29 5d 20 61 6e  prepare_v2()] an
204c0 64 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28  d [sqlite3_step(
204d0 29 5d 20 62 6f 74 68 20 6d 6f 64 69 66 79 20 74  )] both modify t
204e0 68 65 69 72 0a 2a 2a 20 64 61 74 61 62 61 73 65  heir.** database
204f0 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 20 66 6f 72   connections for
20500 20 74 68 65 20 6d 65 61 6e 69 6e 67 20 6f 66 20   the meaning of 
20510 22 6d 6f 64 69 66 79 22 20 69 6e 20 74 68 69 73  "modify" in this
20520 20 70 61 72 61 67 72 61 70 68 2e 0a 2a 2a 0a 2a   paragraph..**.*
20530 2a 20 5e 57 68 65 6e 20 5b 73 71 6c 69 74 65 33  * ^When [sqlite3
20540 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d 20 69  _prepare_v2()] i
20550 73 20 75 73 65 64 20 74 6f 20 70 72 65 70 61 72  s used to prepar
20560 65 20 61 20 73 74 61 74 65 6d 65 6e 74 2c 20 74  e a statement, t
20570 68 65 0a 2a 2a 20 73 74 61 74 65 6d 65 6e 74 20  he.** statement 
20580 6d 69 67 68 74 20 62 65 20 72 65 2d 70 72 65 70  might be re-prep
20590 61 72 65 64 20 64 75 72 69 6e 67 20 5b 73 71 6c  ared during [sql
205a0 69 74 65 33 5f 73 74 65 70 28 29 5d 20 64 75 65  ite3_step()] due
205b0 20 74 6f 20 61 20 0a 2a 2a 20 73 63 68 65 6d 61   to a .** schema
205c0 20 63 68 61 6e 67 65 2e 20 20 48 65 6e 63 65 2c   change.  Hence,
205d0 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   the application
205e0 20 73 68 6f 75 6c 64 20 65 6e 73 75 72 65 20 74   should ensure t
205f0 68 61 74 20 74 68 65 0a 2a 2a 20 63 6f 72 72 65  hat the.** corre
20600 63 74 20 61 75 74 68 6f 72 69 7a 65 72 20 63 61  ct authorizer ca
20610 6c 6c 62 61 63 6b 20 72 65 6d 61 69 6e 73 20 69  llback remains i
20620 6e 20 70 6c 61 63 65 20 64 75 72 69 6e 67 20 74  n place during t
20630 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70  he [sqlite3_step
20640 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 4e 6f 74 65  ()]..**.** ^Note
20650 20 74 68 61 74 20 74 68 65 20 61 75 74 68 6f 72   that the author
20660 69 7a 65 72 20 63 61 6c 6c 62 61 63 6b 20 69 73  izer callback is
20670 20 69 6e 76 6f 6b 65 64 20 6f 6e 6c 79 20 64 75   invoked only du
20680 72 69 6e 67 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  ring.** [sqlite3
20690 5f 70 72 65 70 61 72 65 28 29 5d 20 6f 72 20 69  _prepare()] or i
206a0 74 73 20 76 61 72 69 61 6e 74 73 2e 20 20 41 75  ts variants.  Au
206b0 74 68 6f 72 69 7a 61 74 69 6f 6e 20 69 73 20 6e  thorization is n
206c0 6f 74 0a 2a 2a 20 70 65 72 66 6f 72 6d 65 64 20  ot.** performed 
206d0 64 75 72 69 6e 67 20 73 74 61 74 65 6d 65 6e 74  during statement
206e0 20 65 76 61 6c 75 61 74 69 6f 6e 20 69 6e 20 5b   evaluation in [
206f0 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 2c  sqlite3_step()],
20700 20 75 6e 6c 65 73 73 0a 2a 2a 20 61 73 20 73 74   unless.** as st
20710 61 74 65 64 20 69 6e 20 74 68 65 20 70 72 65 76  ated in the prev
20720 69 6f 75 73 20 70 61 72 61 67 72 61 70 68 2c 20  ious paragraph, 
20730 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 20 69  sqlite3_step() i
20740 6e 76 6f 6b 65 73 0a 2a 2a 20 73 71 6c 69 74 65  nvokes.** sqlite
20750 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29 20 74  3_prepare_v2() t
20760 6f 20 72 65 70 72 65 70 61 72 65 20 61 20 73 74  o reprepare a st
20770 61 74 65 6d 65 6e 74 20 61 66 74 65 72 20 61 20  atement after a 
20780 73 63 68 65 6d 61 20 63 68 61 6e 67 65 2e 0a 2a  schema change..*
20790 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 73 65  /.int sqlite3_se
207a0 74 5f 61 75 74 68 6f 72 69 7a 65 72 28 0a 20 20  t_authorizer(.  
207b0 73 71 6c 69 74 65 33 2a 2c 0a 20 20 69 6e 74 20  sqlite3*,.  int 
207c0 28 2a 78 41 75 74 68 29 28 76 6f 69 64 2a 2c 69  (*xAuth)(void*,i
207d0 6e 74 2c 63 6f 6e 73 74 20 63 68 61 72 2a 2c 63  nt,const char*,c
207e0 6f 6e 73 74 20 63 68 61 72 2a 2c 63 6f 6e 73 74  onst char*,const
207f0 20 63 68 61 72 2a 2c 63 6f 6e 73 74 20 63 68 61   char*,const cha
20800 72 2a 29 2c 0a 20 20 76 6f 69 64 20 2a 70 55 73  r*),.  void *pUs
20810 65 72 44 61 74 61 0a 29 3b 0a 0a 2f 2a 0a 2a 2a  erData.);../*.**
20820 20 43 41 50 49 33 52 45 46 3a 20 41 75 74 68 6f   CAPI3REF: Autho
20830 72 69 7a 65 72 20 52 65 74 75 72 6e 20 43 6f 64  rizer Return Cod
20840 65 73 0a 2a 2a 0a 2a 2a 20 54 68 65 20 5b 73 71  es.**.** The [sq
20850 6c 69 74 65 33 5f 73 65 74 5f 61 75 74 68 6f 72  lite3_set_author
20860 69 7a 65 72 20 7c 20 61 75 74 68 6f 72 69 7a 65  izer | authorize
20870 72 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74  r callback funct
20880 69 6f 6e 5d 20 6d 75 73 74 0a 2a 2a 20 72 65 74  ion] must.** ret
20890 75 72 6e 20 65 69 74 68 65 72 20 5b 53 51 4c 49  urn either [SQLI
208a0 54 45 5f 4f 4b 5d 20 6f 72 20 6f 6e 65 20 6f 66  TE_OK] or one of
208b0 20 74 68 65 73 65 20 74 77 6f 20 63 6f 6e 73 74   these two const
208c0 61 6e 74 73 20 69 6e 20 6f 72 64 65 72 0a 2a 2a  ants in order.**
208d0 20 74 6f 20 73 69 67 6e 61 6c 20 53 51 4c 69 74   to signal SQLit
208e0 65 20 77 68 65 74 68 65 72 20 6f 72 20 6e 6f 74  e whether or not
208f0 20 74 68 65 20 61 63 74 69 6f 6e 20 69 73 20 70   the action is p
20900 65 72 6d 69 74 74 65 64 2e 20 20 53 65 65 20 74  ermitted.  See t
20910 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 73  he.** [sqlite3_s
20920 65 74 5f 61 75 74 68 6f 72 69 7a 65 72 20 7c 20  et_authorizer | 
20930 61 75 74 68 6f 72 69 7a 65 72 20 64 6f 63 75 6d  authorizer docum
20940 65 6e 74 61 74 69 6f 6e 5d 20 66 6f 72 20 61 64  entation] for ad
20950 64 69 74 69 6f 6e 61 6c 0a 2a 2a 20 69 6e 66 6f  ditional.** info
20960 72 6d 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 4e  rmation..**.** N
20970 6f 74 65 20 74 68 61 74 20 53 51 4c 49 54 45 5f  ote that SQLITE_
20980 49 47 4e 4f 52 45 20 69 73 20 61 6c 73 6f 20 75  IGNORE is also u
20990 73 65 64 20 61 73 20 61 20 5b 63 6f 6e 66 6c 69  sed as a [confli
209a0 63 74 20 72 65 73 6f 6c 75 74 69 6f 6e 20 6d 6f  ct resolution mo
209b0 64 65 5d 0a 2a 2a 20 72 65 74 75 72 6e 65 64 20  de].** returned 
209c0 66 72 6f 6d 20 74 68 65 20 5b 73 71 6c 69 74 65  from the [sqlite
209d0 33 5f 76 74 61 62 5f 6f 6e 5f 63 6f 6e 66 6c 69  3_vtab_on_confli
209e0 63 74 28 29 5d 20 69 6e 74 65 72 66 61 63 65 2e  ct()] interface.
209f0 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  .*/.#define SQLI
20a00 54 45 5f 44 45 4e 59 20 20 20 31 20 20 20 2f 2a  TE_DENY   1   /*
20a10 20 41 62 6f 72 74 20 74 68 65 20 53 51 4c 20 73   Abort the SQL s
20a20 74 61 74 65 6d 65 6e 74 20 77 69 74 68 20 61 6e  tatement with an
20a30 20 65 72 72 6f 72 20 2a 2f 0a 23 64 65 66 69 6e   error */.#defin
20a40 65 20 53 51 4c 49 54 45 5f 49 47 4e 4f 52 45 20  e SQLITE_IGNORE 
20a50 32 20 20 20 2f 2a 20 44 6f 6e 27 74 20 61 6c 6c  2   /* Don't all
20a60 6f 77 20 61 63 63 65 73 73 2c 20 62 75 74 20 64  ow access, but d
20a70 6f 6e 27 74 20 67 65 6e 65 72 61 74 65 20 61 6e  on't generate an
20a80 20 65 72 72 6f 72 20 2a 2f 0a 0a 2f 2a 0a 2a 2a   error */../*.**
20a90 20 43 41 50 49 33 52 45 46 3a 20 41 75 74 68 6f   CAPI3REF: Autho
20aa0 72 69 7a 65 72 20 41 63 74 69 6f 6e 20 43 6f 64  rizer Action Cod
20ab0 65 73 0a 2a 2a 0a 2a 2a 20 54 68 65 20 5b 73 71  es.**.** The [sq
20ac0 6c 69 74 65 33 5f 73 65 74 5f 61 75 74 68 6f 72  lite3_set_author
20ad0 69 7a 65 72 28 29 5d 20 69 6e 74 65 72 66 61 63  izer()] interfac
20ae0 65 20 72 65 67 69 73 74 65 72 73 20 61 20 63 61  e registers a ca
20af0 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 0a  llback function.
20b00 2a 2a 20 74 68 61 74 20 69 73 20 69 6e 76 6f 6b  ** that is invok
20b10 65 64 20 74 6f 20 61 75 74 68 6f 72 69 7a 65 20  ed to authorize 
20b20 63 65 72 74 61 69 6e 20 53 51 4c 20 73 74 61 74  certain SQL stat
20b30 65 6d 65 6e 74 20 61 63 74 69 6f 6e 73 2e 20 20  ement actions.  
20b40 54 68 65 0a 2a 2a 20 73 65 63 6f 6e 64 20 70 61  The.** second pa
20b50 72 61 6d 65 74 65 72 20 74 6f 20 74 68 65 20 63  rameter to the c
20b60 61 6c 6c 62 61 63 6b 20 69 73 20 61 6e 20 69 6e  allback is an in
20b70 74 65 67 65 72 20 63 6f 64 65 20 74 68 61 74 20  teger code that 
20b80 73 70 65 63 69 66 69 65 73 0a 2a 2a 20 77 68 61  specifies.** wha
20b90 74 20 61 63 74 69 6f 6e 20 69 73 20 62 65 69 6e  t action is bein
20ba0 67 20 61 75 74 68 6f 72 69 7a 65 64 2e 20 20 54  g authorized.  T
20bb0 68 65 73 65 20 61 72 65 20 74 68 65 20 69 6e 74  hese are the int
20bc0 65 67 65 72 20 61 63 74 69 6f 6e 20 63 6f 64 65  eger action code
20bd0 73 20 74 68 61 74 0a 2a 2a 20 74 68 65 20 61 75  s that.** the au
20be0 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61 63  thorizer callbac
20bf0 6b 20 6d 61 79 20 62 65 20 70 61 73 73 65 64 2e  k may be passed.
20c00 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 61 63 74  .**.** These act
20c10 69 6f 6e 20 63 6f 64 65 20 76 61 6c 75 65 73 20  ion code values 
20c20 73 69 67 6e 69 66 79 20 77 68 61 74 20 6b 69 6e  signify what kin
20c30 64 20 6f 66 20 6f 70 65 72 61 74 69 6f 6e 20 69  d of operation i
20c40 73 20 74 6f 20 62 65 0a 2a 2a 20 61 75 74 68 6f  s to be.** autho
20c50 72 69 7a 65 64 2e 20 20 54 68 65 20 33 72 64 20  rized.  The 3rd 
20c60 61 6e 64 20 34 74 68 20 70 61 72 61 6d 65 74 65  and 4th paramete
20c70 72 73 20 74 6f 20 74 68 65 20 61 75 74 68 6f 72  rs to the author
20c80 69 7a 61 74 69 6f 6e 0a 2a 2a 20 63 61 6c 6c 62  ization.** callb
20c90 61 63 6b 20 66 75 6e 63 74 69 6f 6e 20 77 69 6c  ack function wil
20ca0 6c 20 62 65 20 70 61 72 61 6d 65 74 65 72 73 20  l be parameters 
20cb0 6f 72 20 4e 55 4c 4c 20 64 65 70 65 6e 64 69 6e  or NULL dependin
20cc0 67 20 6f 6e 20 77 68 69 63 68 20 6f 66 20 74 68  g on which of th
20cd0 65 73 65 0a 2a 2a 20 63 6f 64 65 73 20 69 73 20  ese.** codes is 
20ce0 75 73 65 64 20 61 73 20 74 68 65 20 73 65 63 6f  used as the seco
20cf0 6e 64 20 70 61 72 61 6d 65 74 65 72 2e 20 20 5e  nd parameter.  ^
20d00 28 54 68 65 20 35 74 68 20 70 61 72 61 6d 65 74  (The 5th paramet
20d10 65 72 20 74 6f 20 74 68 65 0a 2a 2a 20 61 75 74  er to the.** aut
20d20 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61 63 6b  horizer callback
20d30 20 69 73 20 74 68 65 20 6e 61 6d 65 20 6f 66 20   is the name of 
20d40 74 68 65 20 64 61 74 61 62 61 73 65 20 28 22 6d  the database ("m
20d50 61 69 6e 22 2c 20 22 74 65 6d 70 22 2c 0a 2a 2a  ain", "temp",.**
20d60 20 65 74 63 2e 29 20 69 66 20 61 70 70 6c 69 63   etc.) if applic
20d70 61 62 6c 65 2e 29 5e 20 20 5e 54 68 65 20 36 74  able.)^  ^The 6t
20d80 68 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 74  h parameter to t
20d90 68 65 20 61 75 74 68 6f 72 69 7a 65 72 20 63 61  he authorizer ca
20da0 6c 6c 62 61 63 6b 0a 2a 2a 20 69 73 20 74 68 65  llback.** is the
20db0 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 69 6e 6e   name of the inn
20dc0 65 72 2d 6d 6f 73 74 20 74 72 69 67 67 65 72 20  er-most trigger 
20dd0 6f 72 20 76 69 65 77 20 74 68 61 74 20 69 73 20  or view that is 
20de0 72 65 73 70 6f 6e 73 69 62 6c 65 20 66 6f 72 0a  responsible for.
20df0 2a 2a 20 74 68 65 20 61 63 63 65 73 73 20 61 74  ** the access at
20e00 74 65 6d 70 74 20 6f 72 20 4e 55 4c 4c 20 69 66  tempt or NULL if
20e10 20 74 68 69 73 20 61 63 63 65 73 73 20 61 74 74   this access att
20e20 65 6d 70 74 20 69 73 20 64 69 72 65 63 74 6c 79  empt is directly
20e30 20 66 72 6f 6d 0a 2a 2a 20 74 6f 70 2d 6c 65 76   from.** top-lev
20e40 65 6c 20 53 51 4c 20 63 6f 64 65 2e 0a 2a 2f 0a  el SQL code..*/.
20e50 2f 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  /***************
20e60 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
20e70 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 20 33 72 64  ************ 3rd
20e80 20 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 20 34 74   ************ 4t
20e90 68 20 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2f 0a 23  h ***********/.#
20ea0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 52  define SQLITE_CR
20eb0 45 41 54 45 5f 49 4e 44 45 58 20 20 20 20 20 20  EATE_INDEX      
20ec0 20 20 20 20 31 20 20 20 2f 2a 20 49 6e 64 65 78      1   /* Index
20ed0 20 4e 61 6d 65 20 20 20 20 20 20 54 61 62 6c 65   Name      Table
20ee0 20 4e 61 6d 65 20 20 20 20 20 20 2a 2f 0a 23 64   Name      */.#d
20ef0 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 52 45  efine SQLITE_CRE
20f00 41 54 45 5f 54 41 42 4c 45 20 20 20 20 20 20 20  ATE_TABLE       
20f10 20 20 20 32 20 20 20 2f 2a 20 54 61 62 6c 65 20     2   /* Table 
20f20 4e 61 6d 65 20 20 20 20 20 20 4e 55 4c 4c 20 20  Name      NULL  
20f30 20 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64 65            */.#de
20f40 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 52 45 41  fine SQLITE_CREA
20f50 54 45 5f 54 45 4d 50 5f 49 4e 44 45 58 20 20 20  TE_TEMP_INDEX   
20f60 20 20 33 20 20 20 2f 2a 20 49 6e 64 65 78 20 4e    3   /* Index N
20f70 61 6d 65 20 20 20 20 20 20 54 61 62 6c 65 20 4e  ame      Table N
20f80 61 6d 65 20 20 20 20 20 20 2a 2f 0a 23 64 65 66  ame      */.#def
20f90 69 6e 65 20 53 51 4c 49 54 45 5f 43 52 45 41 54  ine SQLITE_CREAT
20fa0 45 5f 54 45 4d 50 5f 54 41 42 4c 45 20 20 20 20  E_TEMP_TABLE    
20fb0 20 34 20 20 20 2f 2a 20 54 61 62 6c 65 20 4e 61   4   /* Table Na
20fc0 6d 65 20 20 20 20 20 20 4e 55 4c 4c 20 20 20 20  me      NULL    
20fd0 20 20 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69          */.#defi
20fe0 6e 65 20 53 51 4c 49 54 45 5f 43 52 45 41 54 45  ne SQLITE_CREATE
20ff0 5f 54 45 4d 50 5f 54 52 49 47 47 45 52 20 20 20  _TEMP_TRIGGER   
21000 35 20 20 20 2f 2a 20 54 72 69 67 67 65 72 20 4e  5   /* Trigger N
21010 61 6d 65 20 20 20 20 54 61 62 6c 65 20 4e 61 6d  ame    Table Nam
21020 65 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e  e      */.#defin
21030 65 20 53 51 4c 49 54 45 5f 43 52 45 41 54 45 5f  e SQLITE_CREATE_
21040 54 45 4d 50 5f 56 49 45 57 20 20 20 20 20 20 36  TEMP_VIEW      6
21050 20 20 20 2f 2a 20 56 69 65 77 20 4e 61 6d 65 20     /* View Name 
21060 20 20 20 20 20 20 4e 55 4c 4c 20 20 20 20 20 20        NULL      
21070 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65        */.#define
21080 20 53 51 4c 49 54 45 5f 43 52 45 41 54 45 5f 54   SQLITE_CREATE_T
21090 52 49 47 47 45 52 20 20 20 20 20 20 20 20 37 20  RIGGER        7 
210a0 20 20 2f 2a 20 54 72 69 67 67 65 72 20 4e 61 6d    /* Trigger Nam
210b0 65 20 20 20 20 54 61 62 6c 65 20 4e 61 6d 65 20  e    Table Name 
210c0 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20       */.#define 
210d0 53 51 4c 49 54 45 5f 43 52 45 41 54 45 5f 56 49  SQLITE_CREATE_VI
210e0 45 57 20 20 20 20 20 20 20 20 20 20 20 38 20 20  EW           8  
210f0 20 2f 2a 20 56 69 65 77 20 4e 61 6d 65 20 20 20   /* View Name   
21100 20 20 20 20 4e 55 4c 4c 20 20 20 20 20 20 20 20      NULL        
21110 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53      */.#define S
21120 51 4c 49 54 45 5f 44 45 4c 45 54 45 20 20 20 20  QLITE_DELETE    
21130 20 20 20 20 20 20 20 20 20 20 20 20 39 20 20 20              9   
21140 2f 2a 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20  /* Table Name   
21150 20 20 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20     NULL         
21160 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51     */.#define SQ
21170 4c 49 54 45 5f 44 52 4f 50 5f 49 4e 44 45 58 20  LITE_DROP_INDEX 
21180 20 20 20 20 20 20 20 20 20 20 31 30 20 20 20 2f            10   /
21190 2a 20 49 6e 64 65 78 20 4e 61 6d 65 20 20 20 20  * Index Name    
211a0 20 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20 20    Table Name    
211b0 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c    */.#define SQL
211c0 49 54 45 5f 44 52 4f 50 5f 54 41 42 4c 45 20 20  ITE_DROP_TABLE  
211d0 20 20 20 20 20 20 20 20 20 31 31 20 20 20 2f 2a           11   /*
211e0 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20   Table Name     
211f0 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20   NULL           
21200 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
21210 54 45 5f 44 52 4f 50 5f 54 45 4d 50 5f 49 4e 44  TE_DROP_TEMP_IND
21220 45 58 20 20 20 20 20 20 31 32 20 20 20 2f 2a 20  EX      12   /* 
21230 49 6e 64 65 78 20 4e 61 6d 65 20 20 20 20 20 20  Index Name      
21240 54 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20 20  Table Name      
21250 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
21260 45 5f 44 52 4f 50 5f 54 45 4d 50 5f 54 41 42 4c  E_DROP_TEMP_TABL
21270 45 20 20 20 20 20 20 31 33 20 20 20 2f 2a 20 54  E      13   /* T
21280 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 4e  able Name      N
21290 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20 20 2a  ULL            *
212a0 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
212b0 5f 44 52 4f 50 5f 54 45 4d 50 5f 54 52 49 47 47  _DROP_TEMP_TRIGG
212c0 45 52 20 20 20 20 31 34 20 20 20 2f 2a 20 54 72  ER    14   /* Tr
212d0 69 67 67 65 72 20 4e 61 6d 65 20 20 20 20 54 61  igger Name    Ta
212e0 62 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 2a 2f  ble Name      */
212f0 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
21300 44 52 4f 50 5f 54 45 4d 50 5f 56 49 45 57 20 20  DROP_TEMP_VIEW  
21310 20 20 20 20 20 31 35 20 20 20 2f 2a 20 56 69 65       15   /* Vie
21320 77 20 4e 61 6d 65 20 20 20 20 20 20 20 4e 55 4c  w Name       NUL
21330 4c 20 20 20 20 20 20 20 20 20 20 20 20 2a 2f 0a  L            */.
21340 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44  #define SQLITE_D
21350 52 4f 50 5f 54 52 49 47 47 45 52 20 20 20 20 20  ROP_TRIGGER     
21360 20 20 20 20 31 36 20 20 20 2f 2a 20 54 72 69 67      16   /* Trig
21370 67 65 72 20 4e 61 6d 65 20 20 20 20 54 61 62 6c  ger Name    Tabl
21380 65 20 4e 61 6d 65 20 20 20 20 20 20 2a 2f 0a 23  e Name      */.#
21390 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 52  define SQLITE_DR
213a0 4f 50 5f 56 49 45 57 20 20 20 20 20 20 20 20 20  OP_VIEW         
213b0 20 20 20 31 37 20 20 20 2f 2a 20 56 69 65 77 20     17   /* View 
213c0 4e 61 6d 65 20 20 20 20 20 20 20 4e 55 4c 4c 20  Name       NULL 
213d0 20 20 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64             */.#d
213e0 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4e 53  efine SQLITE_INS
213f0 45 52 54 20 20 20 20 20 20 20 20 20 20 20 20 20  ERT             
21400 20 20 31 38 20 20 20 2f 2a 20 54 61 62 6c 65 20    18   /* Table 
21410 4e 61 6d 65 20 20 20 20 20 20 4e 55 4c 4c 20 20  Name      NULL  
21420 20 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64 65            */.#de
21430 66 69 6e 65 20 53 51 4c 49 54 45 5f 50 52 41 47  fine SQLITE_PRAG
21440 4d 41 20 20 20 20 20 20 20 20 20 20 20 20 20 20  MA              
21450 20 31 39 20 20 20 2f 2a 20 50 72 61 67 6d 61 20   19   /* Pragma 
21460 4e 61 6d 65 20 20 20 20 20 31 73 74 20 61 72 67  Name     1st arg
21470 20 6f 72 20 4e 55 4c 4c 20 2a 2f 0a 23 64 65 66   or NULL */.#def
21480 69 6e 65 20 53 51 4c 49 54 45 5f 52 45 41 44 20  ine SQLITE_READ 
21490 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
214a0 32 30 20 20 20 2f 2a 20 54 61 62 6c 65 20 4e 61  20   /* Table Na
214b0 6d 65 20 20 20 20 20 20 43 6f 6c 75 6d 6e 20 4e  me      Column N
214c0 61 6d 65 20 20 20 20 20 2a 2f 0a 23 64 65 66 69  ame     */.#defi
214d0 6e 65 20 53 51 4c 49 54 45 5f 53 45 4c 45 43 54  ne SQLITE_SELECT
214e0 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 32                 2
214f0 31 20 20 20 2f 2a 20 4e 55 4c 4c 20 20 20 20 20  1   /* NULL     
21500 20 20 20 20 20 20 20 4e 55 4c 4c 20 20 20 20 20         NULL     
21510 20 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e         */.#defin
21520 65 20 53 51 4c 49 54 45 5f 54 52 41 4e 53 41 43  e SQLITE_TRANSAC
21530 54 49 4f 4e 20 20 20 20 20 20 20 20 20 20 32 32  TION          22
21540 20 20 20 2f 2a 20 4f 70 65 72 61 74 69 6f 6e 20     /* Operation 
21550 20 20 20 20 20 20 4e 55 4c 4c 20 20 20 20 20 20        NULL      
21560 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65        */.#define
21570 20 53 51 4c 49 54 45 5f 55 50 44 41 54 45 20 20   SQLITE_UPDATE  
21580 20 20 20 20 20 20 20 20 20 20 20 20 20 32 33 20               23 
21590 20 20 2f 2a 20 54 61 62 6c 65 20 4e 61 6d 65 20    /* Table Name 
215a0 20 20 20 20 20 43 6f 6c 75 6d 6e 20 4e 61 6d 65       Column Name
215b0 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20       */.#define 
215c0 53 51 4c 49 54 45 5f 41 54 54 41 43 48 20 20 20  SQLITE_ATTACH   
215d0 20 20 20 20 20 20 20 20 20 20 20 20 32 34 20 20              24  
215e0 20 2f 2a 20 46 69 6c 65 6e 61 6d 65 20 20 20 20   /* Filename    
215f0 20 20 20 20 4e 55 4c 4c 20 20 20 20 20 20 20 20      NULL        
21600 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53      */.#define S
21610 51 4c 49 54 45 5f 44 45 54 41 43 48 20 20 20 20  QLITE_DETACH    
21620 20 20 20 20 20 20 20 20 20 20 20 32 35 20 20 20             25   
21630 2f 2a 20 44 61 74 61 62 61 73 65 20 4e 61 6d 65  /* Database Name
21640 20 20 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20     NULL         
21650 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51     */.#define SQ
21660 4c 49 54 45 5f 41 4c 54 45 52 5f 54 41 42 4c 45  LITE_ALTER_TABLE
21670 20 20 20 20 20 20 20 20 20 20 32 36 20 20 20 2f            26   /
21680 2a 20 44 61 74 61 62 61 73 65 20 4e 61 6d 65 20  * Database Name 
21690 20 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20 20    Table Name    
216a0 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c    */.#define SQL
216b0 49 54 45 5f 52 45 49 4e 44 45 58 20 20 20 20 20  ITE_REINDEX     
216c0 20 20 20 20 20 20 20 20 20 32 37 20 20 20 2f 2a           27   /*
216d0 20 49 6e 64 65 78 20 4e 61 6d 65 20 20 20 20 20   Index Name     
216e0 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20   NULL           
216f0 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
21700 54 45 5f 41 4e 41 4c 59 5a 45 20 20 20 20 20 20  TE_ANALYZE      
21710 20 20 20 20 20 20 20 20 32 38 20 20 20 2f 2a 20          28   /* 
21720 54 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20 20  Table Name      
21730 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20 20  NULL            
21740 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
21750 45 5f 43 52 45 41 54 45 5f 56 54 41 42 4c 45 20  E_CREATE_VTABLE 
21760 20 20 20 20 20 20 20 32 39 20 20 20 2f 2a 20 54         29   /* T
21770 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 4d  able Name      M
21780 6f 64 75 6c 65 20 4e 61 6d 65 20 20 20 20 20 2a  odule Name     *
21790 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
217a0 5f 44 52 4f 50 5f 56 54 41 42 4c 45 20 20 20 20  _DROP_VTABLE    
217b0 20 20 20 20 20 20 33 30 20 20 20 2f 2a 20 54 61        30   /* Ta
217c0 62 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 4d 6f  ble Name      Mo
217d0 64 75 6c 65 20 4e 61 6d 65 20 20 20 20 20 2a 2f  dule Name     */
217e0 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
217f0 46 55 4e 43 54 49 4f 4e 20 20 20 20 20 20 20 20  FUNCTION        
21800 20 20 20 20 20 33 31 20 20 20 2f 2a 20 4e 55 4c       31   /* NUL
21810 4c 20 20 20 20 20 20 20 20 20 20 20 20 46 75 6e  L            Fun
21820 63 74 69 6f 6e 20 4e 61 6d 65 20 20 20 2a 2f 0a  ction Name   */.
21830 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53  #define SQLITE_S
21840 41 56 45 50 4f 49 4e 54 20 20 20 20 20 20 20 20  AVEPOINT        
21850 20 20 20 20 33 32 20 20 20 2f 2a 20 4f 70 65 72      32   /* Oper
21860 61 74 69 6f 6e 20 20 20 20 20 20 20 53 61 76 65  ation       Save
21870 70 6f 69 6e 74 20 4e 61 6d 65 20 20 2a 2f 0a 23  point Name  */.#
21880 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f  define SQLITE_CO
21890 50 59 20 20 20 20 20 20 20 20 20 20 20 20 20 20  PY              
218a0 20 20 20 20 30 20 20 20 2f 2a 20 4e 6f 20 6c 6f      0   /* No lo
218b0 6e 67 65 72 20 75 73 65 64 20 2a 2f 0a 23 64 65  nger used */.#de
218c0 66 69 6e 65 20 53 51 4c 49 54 45 5f 52 45 43 55  fine SQLITE_RECU
218d0 52 53 49 56 45 20 20 20 20 20 20 20 20 20 20 20  RSIVE           
218e0 20 33 33 20 20 20 2f 2a 20 4e 55 4c 4c 20 20 20   33   /* NULL   
218f0 20 20 20 20 20 20 20 20 20 4e 55 4c 4c 20 20 20           NULL   
21900 20 20 20 20 20 20 20 20 20 2a 2f 0a 0a 2f 2a 0a           */../*.
21910 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 54 72 61  ** CAPI3REF: Tra
21920 63 69 6e 67 20 41 6e 64 20 50 72 6f 66 69 6c 69  cing And Profili
21930 6e 67 20 46 75 6e 63 74 69 6f 6e 73 0a 2a 2a 20  ng Functions.** 
21940 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a  METHOD: sqlite3.
21950 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72 6f 75 74  **.** These rout
21960 69 6e 65 73 20 61 72 65 20 64 65 70 72 65 63 61  ines are depreca
21970 74 65 64 2e 20 55 73 65 20 74 68 65 20 5b 73 71  ted. Use the [sq
21980 6c 69 74 65 33 5f 74 72 61 63 65 5f 76 32 28 29  lite3_trace_v2()
21990 5d 20 69 6e 74 65 72 66 61 63 65 0a 2a 2a 20 69  ] interface.** i
219a0 6e 73 74 65 61 64 20 6f 66 20 74 68 65 20 72 6f  nstead of the ro
219b0 75 74 69 6e 65 73 20 64 65 73 63 72 69 62 65 64  utines described
219c0 20 68 65 72 65 2e 0a 2a 2a 0a 2a 2a 20 54 68 65   here..**.** The
219d0 73 65 20 72 6f 75 74 69 6e 65 73 20 72 65 67 69  se routines regi
219e0 73 74 65 72 20 63 61 6c 6c 62 61 63 6b 20 66 75  ster callback fu
219f0 6e 63 74 69 6f 6e 73 20 74 68 61 74 20 63 61 6e  nctions that can
21a00 20 62 65 20 75 73 65 64 20 66 6f 72 0a 2a 2a 20   be used for.** 
21a10 74 72 61 63 69 6e 67 20 61 6e 64 20 70 72 6f 66  tracing and prof
21a20 69 6c 69 6e 67 20 74 68 65 20 65 78 65 63 75 74  iling the execut
21a30 69 6f 6e 20 6f 66 20 53 51 4c 20 73 74 61 74 65  ion of SQL state
21a40 6d 65 6e 74 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  ments..**.** ^Th
21a50 65 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74  e callback funct
21a60 69 6f 6e 20 72 65 67 69 73 74 65 72 65 64 20 62  ion registered b
21a70 79 20 73 71 6c 69 74 65 33 5f 74 72 61 63 65 28  y sqlite3_trace(
21a80 29 20 69 73 20 69 6e 76 6f 6b 65 64 20 61 74 0a  ) is invoked at.
21a90 2a 2a 20 76 61 72 69 6f 75 73 20 74 69 6d 65 73  ** various times
21aa0 20 77 68 65 6e 20 61 6e 20 53 51 4c 20 73 74 61   when an SQL sta
21ab0 74 65 6d 65 6e 74 20 69 73 20 62 65 69 6e 67 20  tement is being 
21ac0 72 75 6e 20 62 79 20 5b 73 71 6c 69 74 65 33 5f  run by [sqlite3_
21ad0 73 74 65 70 28 29 5d 2e 0a 2a 2a 20 5e 54 68 65  step()]..** ^The
21ae0 20 73 71 6c 69 74 65 33 5f 74 72 61 63 65 28 29   sqlite3_trace()
21af0 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76   callback is inv
21b00 6f 6b 65 64 20 77 69 74 68 20 61 20 55 54 46 2d  oked with a UTF-
21b10 38 20 72 65 6e 64 65 72 69 6e 67 20 6f 66 20 74  8 rendering of t
21b20 68 65 0a 2a 2a 20 53 51 4c 20 73 74 61 74 65 6d  he.** SQL statem
21b30 65 6e 74 20 74 65 78 74 20 61 73 20 74 68 65 20  ent text as the 
21b40 73 74 61 74 65 6d 65 6e 74 20 66 69 72 73 74 20  statement first 
21b50 62 65 67 69 6e 73 20 65 78 65 63 75 74 69 6e 67  begins executing
21b60 2e 0a 2a 2a 20 5e 28 41 64 64 69 74 69 6f 6e 61  ..** ^(Additiona
21b70 6c 20 73 71 6c 69 74 65 33 5f 74 72 61 63 65 28  l sqlite3_trace(
21b80 29 20 63 61 6c 6c 62 61 63 6b 73 20 6d 69 67 68  ) callbacks migh
21b90 74 20 6f 63 63 75 72 0a 2a 2a 20 61 73 20 65 61  t occur.** as ea
21ba0 63 68 20 74 72 69 67 67 65 72 65 64 20 73 75 62  ch triggered sub
21bb0 70 72 6f 67 72 61 6d 20 69 73 20 65 6e 74 65 72  program is enter
21bc0 65 64 2e 20 20 54 68 65 20 63 61 6c 6c 62 61 63  ed.  The callbac
21bd0 6b 73 20 66 6f 72 20 74 72 69 67 67 65 72 73 0a  ks for triggers.
21be0 2a 2a 20 63 6f 6e 74 61 69 6e 20 61 20 55 54 46  ** contain a UTF
21bf0 2d 38 20 53 51 4c 20 63 6f 6d 6d 65 6e 74 20 74  -8 SQL comment t
21c00 68 61 74 20 69 64 65 6e 74 69 66 69 65 73 20 74  hat identifies t
21c10 68 65 20 74 72 69 67 67 65 72 2e 29 5e 0a 2a 2a  he trigger.)^.**
21c20 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54 45 5f  .** The [SQLITE_
21c30 54 52 41 43 45 5f 53 49 5a 45 5f 4c 49 4d 49 54  TRACE_SIZE_LIMIT
21c40 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f  ] compile-time o
21c50 70 74 69 6f 6e 20 63 61 6e 20 62 65 20 75 73 65  ption can be use
21c60 64 20 74 6f 20 6c 69 6d 69 74 0a 2a 2a 20 74 68  d to limit.** th
21c70 65 20 6c 65 6e 67 74 68 20 6f 66 20 5b 62 6f 75  e length of [bou
21c80 6e 64 20 70 61 72 61 6d 65 74 65 72 5d 20 65 78  nd parameter] ex
21c90 70 61 6e 73 69 6f 6e 20 69 6e 20 74 68 65 20 6f  pansion in the o
21ca0 75 74 70 75 74 20 6f 66 20 73 71 6c 69 74 65 33  utput of sqlite3
21cb0 5f 74 72 61 63 65 28 29 2e 0a 2a 2a 0a 2a 2a 20  _trace()..**.** 
21cc0 5e 54 68 65 20 63 61 6c 6c 62 61 63 6b 20 66 75  ^The callback fu
21cd0 6e 63 74 69 6f 6e 20 72 65 67 69 73 74 65 72 65  nction registere
21ce0 64 20 62 79 20 73 71 6c 69 74 65 33 5f 70 72 6f  d by sqlite3_pro
21cf0 66 69 6c 65 28 29 20 69 73 20 69 6e 76 6f 6b 65  file() is invoke
21d00 64 0a 2a 2a 20 61 73 20 65 61 63 68 20 53 51 4c  d.** as each SQL
21d10 20 73 74 61 74 65 6d 65 6e 74 20 66 69 6e 69 73   statement finis
21d20 68 65 73 2e 20 20 5e 54 68 65 20 70 72 6f 66 69  hes.  ^The profi
21d30 6c 65 20 63 61 6c 6c 62 61 63 6b 20 63 6f 6e 74  le callback cont
21d40 61 69 6e 73 0a 2a 2a 20 74 68 65 20 6f 72 69 67  ains.** the orig
21d50 69 6e 61 6c 20 73 74 61 74 65 6d 65 6e 74 20 74  inal statement t
21d60 65 78 74 20 61 6e 64 20 61 6e 20 65 73 74 69 6d  ext and an estim
21d70 61 74 65 20 6f 66 20 77 61 6c 6c 2d 63 6c 6f 63  ate of wall-cloc
21d80 6b 20 74 69 6d 65 0a 2a 2a 20 6f 66 20 68 6f 77  k time.** of how
21d90 20 6c 6f 6e 67 20 74 68 61 74 20 73 74 61 74 65   long that state
21da0 6d 65 6e 74 20 74 6f 6f 6b 20 74 6f 20 72 75 6e  ment took to run
21db0 2e 20 20 5e 54 68 65 20 70 72 6f 66 69 6c 65 20  .  ^The profile 
21dc0 63 61 6c 6c 62 61 63 6b 0a 2a 2a 20 74 69 6d 65  callback.** time
21dd0 20 69 73 20 69 6e 20 75 6e 69 74 73 20 6f 66 20   is in units of 
21de0 6e 61 6e 6f 73 65 63 6f 6e 64 73 2c 20 68 6f 77  nanoseconds, how
21df0 65 76 65 72 20 74 68 65 20 63 75 72 72 65 6e 74  ever the current
21e00 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 0a   implementation.
21e10 2a 2a 20 69 73 20 6f 6e 6c 79 20 63 61 70 61 62  ** is only capab
21e20 6c 65 20 6f 66 20 6d 69 6c 6c 69 73 65 63 6f 6e  le of millisecon
21e30 64 20 72 65 73 6f 6c 75 74 69 6f 6e 20 73 6f 20  d resolution so 
21e40 74 68 65 20 73 69 78 20 6c 65 61 73 74 20 73 69  the six least si
21e50 67 6e 69 66 69 63 61 6e 74 0a 2a 2a 20 64 69 67  gnificant.** dig
21e60 69 74 73 20 69 6e 20 74 68 65 20 74 69 6d 65 20  its in the time 
21e70 61 72 65 20 6d 65 61 6e 69 6e 67 6c 65 73 73 2e  are meaningless.
21e80 20 20 46 75 74 75 72 65 20 76 65 72 73 69 6f 6e    Future version
21e90 73 20 6f 66 20 53 51 4c 69 74 65 0a 2a 2a 20 6d  s of SQLite.** m
21ea0 69 67 68 74 20 70 72 6f 76 69 64 65 20 67 72 65  ight provide gre
21eb0 61 74 65 72 20 72 65 73 6f 6c 75 74 69 6f 6e 20  ater resolution 
21ec0 6f 6e 20 74 68 65 20 70 72 6f 66 69 6c 65 72 20  on the profiler 
21ed0 63 61 6c 6c 62 61 63 6b 2e 20 20 54 68 65 0a 2a  callback.  The.*
21ee0 2a 20 73 71 6c 69 74 65 33 5f 70 72 6f 66 69 6c  * sqlite3_profil
21ef0 65 28 29 20 66 75 6e 63 74 69 6f 6e 20 69 73 20  e() function is 
21f00 63 6f 6e 73 69 64 65 72 65 64 20 65 78 70 65 72  considered exper
21f10 69 6d 65 6e 74 61 6c 20 61 6e 64 20 69 73 0a 2a  imental and is.*
21f20 2a 20 73 75 62 6a 65 63 74 20 74 6f 20 63 68 61  * subject to cha
21f30 6e 67 65 20 69 6e 20 66 75 74 75 72 65 20 76 65  nge in future ve
21f40 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74 65  rsions of SQLite
21f50 2e 0a 2a 2f 0a 53 51 4c 49 54 45 5f 44 45 50 52  ..*/.SQLITE_DEPR
21f60 45 43 41 54 45 44 20 76 6f 69 64 20 2a 73 71 6c  ECATED void *sql
21f70 69 74 65 33 5f 74 72 61 63 65 28 73 71 6c 69 74  ite3_trace(sqlit
21f80 65 33 2a 2c 0a 20 20 20 76 6f 69 64 28 2a 78 54  e3*,.   void(*xT
21f90 72 61 63 65 29 28 76 6f 69 64 2a 2c 63 6f 6e 73  race)(void*,cons
21fa0 74 20 63 68 61 72 2a 29 2c 20 76 6f 69 64 2a 29  t char*), void*)
21fb0 3b 0a 53 51 4c 49 54 45 5f 44 45 50 52 45 43 41  ;.SQLITE_DEPRECA
21fc0 54 45 44 20 76 6f 69 64 20 2a 73 71 6c 69 74 65  TED void *sqlite
21fd0 33 5f 70 72 6f 66 69 6c 65 28 73 71 6c 69 74 65  3_profile(sqlite
21fe0 33 2a 2c 0a 20 20 20 76 6f 69 64 28 2a 78 50 72  3*,.   void(*xPr
21ff0 6f 66 69 6c 65 29 28 76 6f 69 64 2a 2c 63 6f 6e  ofile)(void*,con
22000 73 74 20 63 68 61 72 2a 2c 73 71 6c 69 74 65 33  st char*,sqlite3
22010 5f 75 69 6e 74 36 34 29 2c 20 76 6f 69 64 2a 29  _uint64), void*)
22020 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
22030 46 3a 20 53 51 4c 20 54 72 61 63 65 20 45 76 65  F: SQL Trace Eve
22040 6e 74 20 43 6f 64 65 73 0a 2a 2a 20 4b 45 59 57  nt Codes.** KEYW
22050 4f 52 44 53 3a 20 53 51 4c 49 54 45 5f 54 52 41  ORDS: SQLITE_TRA
22060 43 45 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 63  CE.**.** These c
22070 6f 6e 73 74 61 6e 74 73 20 69 64 65 6e 74 69 66  onstants identif
22080 79 20 63 6c 61 73 73 65 73 20 6f 66 20 65 76 65  y classes of eve
22090 6e 74 73 20 74 68 61 74 20 63 61 6e 20 62 65 20  nts that can be 
220a0 6d 6f 6e 69 74 6f 72 65 64 0a 2a 2a 20 75 73 69  monitored.** usi
220b0 6e 67 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  ng the [sqlite3_
220c0 74 72 61 63 65 5f 76 32 28 29 5d 20 74 72 61 63  trace_v2()] trac
220d0 69 6e 67 20 6c 6f 67 69 63 2e 20 20 54 68 65 20  ing logic.  The 
220e0 74 68 69 72 64 20 61 72 67 75 6d 65 6e 74 0a 2a  third argument.*
220f0 2a 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 74 72  * to [sqlite3_tr
22100 61 63 65 5f 76 32 28 29 5d 20 69 73 20 61 6e 20  ace_v2()] is an 
22110 4f 52 2d 65 64 20 63 6f 6d 62 69 6e 61 74 69 6f  OR-ed combinatio
22120 6e 20 6f 66 20 6f 6e 65 20 6f 72 20 6d 6f 72 65  n of one or more
22130 20 6f 66 0a 2a 2a 20 74 68 65 20 66 6f 6c 6c 6f   of.** the follo
22140 77 69 6e 67 20 63 6f 6e 73 74 61 6e 74 73 2e 20  wing constants. 
22150 20 5e 54 68 65 20 66 69 72 73 74 20 61 72 67 75   ^The first argu
22160 6d 65 6e 74 20 74 6f 20 74 68 65 20 74 72 61 63  ment to the trac
22170 65 20 63 61 6c 6c 62 61 63 6b 0a 2a 2a 20 69 73  e callback.** is
22180 20 6f 6e 65 20 6f 66 20 74 68 65 20 66 6f 6c 6c   one of the foll
22190 6f 77 69 6e 67 20 63 6f 6e 73 74 61 6e 74 73 2e  owing constants.
221a0 0a 2a 2a 0a 2a 2a 20 4e 65 77 20 74 72 61 63 69  .**.** New traci
221b0 6e 67 20 63 6f 6e 73 74 61 6e 74 73 20 6d 61 79  ng constants may
221c0 20 62 65 20 61 64 64 65 64 20 69 6e 20 66 75 74   be added in fut
221d0 75 72 65 20 72 65 6c 65 61 73 65 73 2e 0a 2a 2a  ure releases..**
221e0 0a 2a 2a 20 5e 41 20 74 72 61 63 65 20 63 61 6c  .** ^A trace cal
221f0 6c 62 61 63 6b 20 68 61 73 20 66 6f 75 72 20 61  lback has four a
22200 72 67 75 6d 65 6e 74 73 3a 20 78 43 61 6c 6c 62  rguments: xCallb
22210 61 63 6b 28 54 2c 43 2c 50 2c 58 29 2e 0a 2a 2a  ack(T,C,P,X)..**
22220 20 5e 54 68 65 20 54 20 61 72 67 75 6d 65 6e 74   ^The T argument
22230 20 69 73 20 6f 6e 65 20 6f 66 20 74 68 65 20 69   is one of the i
22240 6e 74 65 67 65 72 20 74 79 70 65 20 63 6f 64 65  nteger type code
22250 73 20 61 62 6f 76 65 2e 0a 2a 2a 20 5e 54 68 65  s above..** ^The
22260 20 43 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61   C argument is a
22270 20 63 6f 70 79 20 6f 66 20 74 68 65 20 63 6f 6e   copy of the con
22280 74 65 78 74 20 70 6f 69 6e 74 65 72 20 70 61 73  text pointer pas
22290 73 65 64 20 69 6e 20 61 73 20 74 68 65 0a 2a 2a  sed in as the.**
222a0 20 66 6f 75 72 74 68 20 61 72 67 75 6d 65 6e 74   fourth argument
222b0 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 74 72 61   to [sqlite3_tra
222c0 63 65 5f 76 32 28 29 5d 2e 0a 2a 2a 20 54 68 65  ce_v2()]..** The
222d0 20 50 20 61 6e 64 20 58 20 61 72 67 75 6d 65 6e   P and X argumen
222e0 74 73 20 61 72 65 20 70 6f 69 6e 74 65 72 73 20  ts are pointers 
222f0 77 68 6f 73 65 20 6d 65 61 6e 69 6e 67 73 20 64  whose meanings d
22300 65 70 65 6e 64 20 6f 6e 20 54 2e 0a 2a 2a 0a 2a  epend on T..**.*
22310 2a 20 3c 64 6c 3e 0a 2a 2a 20 5b 5b 53 51 4c 49  * <dl>.** [[SQLI
22320 54 45 5f 54 52 41 43 45 5f 53 54 4d 54 5d 5d 20  TE_TRACE_STMT]] 
22330 3c 64 74 3e 53 51 4c 49 54 45 5f 54 52 41 43 45  <dt>SQLITE_TRACE
22340 5f 53 54 4d 54 3c 2f 64 74 3e 0a 2a 2a 20 3c 64  _STMT</dt>.** <d
22350 64 3e 5e 41 6e 20 53 51 4c 49 54 45 5f 54 52 41  d>^An SQLITE_TRA
22360 43 45 5f 53 54 4d 54 20 63 61 6c 6c 62 61 63 6b  CE_STMT callback
22370 20 69 73 20 69 6e 76 6f 6b 65 64 20 77 68 65 6e   is invoked when
22380 20 61 20 70 72 65 70 61 72 65 64 20 73 74 61 74   a prepared stat
22390 65 6d 65 6e 74 0a 2a 2a 20 66 69 72 73 74 20 62  ement.** first b
223a0 65 67 69 6e 73 20 72 75 6e 6e 69 6e 67 20 61 6e  egins running an
223b0 64 20 70 6f 73 73 69 62 6c 79 20 61 74 20 6f 74  d possibly at ot
223c0 68 65 72 20 74 69 6d 65 73 20 64 75 72 69 6e 67  her times during
223d0 20 74 68 65 0a 2a 2a 20 65 78 65 63 75 74 69 6f   the.** executio
223e0 6e 20 6f 66 20 74 68 65 20 70 72 65 70 61 72 65  n of the prepare
223f0 64 20 73 74 61 74 65 6d 65 6e 74 2c 20 73 75 63  d statement, suc
22400 68 20 61 73 20 61 74 20 74 68 65 20 73 74 61 72  h as at the star
22410 74 20 6f 66 20 65 61 63 68 0a 2a 2a 20 74 72 69  t of each.** tri
22420 67 67 65 72 20 73 75 62 70 72 6f 67 72 61 6d 2e  gger subprogram.
22430 20 5e 54 68 65 20 50 20 61 72 67 75 6d 65 6e 74   ^The P argument
22440 20 69 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f   is a pointer to
22450 20 74 68 65 0a 2a 2a 20 5b 70 72 65 70 61 72 65   the.** [prepare
22460 64 20 73 74 61 74 65 6d 65 6e 74 5d 2e 20 5e 54  d statement]. ^T
22470 68 65 20 58 20 61 72 67 75 6d 65 6e 74 20 69 73  he X argument is
22480 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20   a pointer to a 
22490 73 74 72 69 6e 67 20 77 68 69 63 68 0a 2a 2a 20  string which.** 
224a0 69 73 20 74 68 65 20 75 6e 65 78 70 61 6e 64 65  is the unexpande
224b0 64 20 53 51 4c 20 74 65 78 74 20 6f 66 20 74 68  d SQL text of th
224c0 65 20 70 72 65 70 61 72 65 64 20 73 74 61 74 65  e prepared state
224d0 6d 65 6e 74 20 6f 72 20 61 6e 20 53 51 4c 20 63  ment or an SQL c
224e0 6f 6d 6d 65 6e 74 20 0a 2a 2a 20 74 68 61 74 20  omment .** that 
224f0 69 6e 64 69 63 61 74 65 73 20 74 68 65 20 69 6e  indicates the in
22500 76 6f 63 61 74 69 6f 6e 20 6f 66 20 61 20 74 72  vocation of a tr
22510 69 67 67 65 72 2e 20 20 5e 54 68 65 20 63 61 6c  igger.  ^The cal
22520 6c 62 61 63 6b 20 63 61 6e 20 63 6f 6d 70 75 74  lback can comput
22530 65 0a 2a 2a 20 74 68 65 20 73 61 6d 65 20 74 65  e.** the same te
22540 78 74 20 74 68 61 74 20 77 6f 75 6c 64 20 68 61  xt that would ha
22550 76 65 20 62 65 65 6e 20 72 65 74 75 72 6e 65 64  ve been returned
22560 20 62 79 20 74 68 65 20 6c 65 67 61 63 79 20 5b   by the legacy [
22570 73 71 6c 69 74 65 33 5f 74 72 61 63 65 28 29 5d  sqlite3_trace()]
22580 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 62 79  .** interface by
22590 20 75 73 69 6e 67 20 74 68 65 20 58 20 61 72 67   using the X arg
225a0 75 6d 65 6e 74 20 77 68 65 6e 20 58 20 62 65 67  ument when X beg
225b0 69 6e 73 20 77 69 74 68 20 22 2d 2d 22 20 61 6e  ins with "--" an
225c0 64 20 69 6e 76 6f 6b 69 6e 67 0a 2a 2a 20 5b 73  d invoking.** [s
225d0 71 6c 69 74 65 33 5f 65 78 70 61 6e 64 65 64 5f  qlite3_expanded_
225e0 73 71 6c 28 50 29 5d 20 6f 74 68 65 72 77 69 73  sql(P)] otherwis
225f0 65 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  e..**.** [[SQLIT
22600 45 5f 54 52 41 43 45 5f 50 52 4f 46 49 4c 45 5d  E_TRACE_PROFILE]
22610 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f 54 52 41  ] <dt>SQLITE_TRA
22620 43 45 5f 50 52 4f 46 49 4c 45 3c 2f 64 74 3e 0a  CE_PROFILE</dt>.
22630 2a 2a 20 3c 64 64 3e 5e 41 6e 20 53 51 4c 49 54  ** <dd>^An SQLIT
22640 45 5f 54 52 41 43 45 5f 50 52 4f 46 49 4c 45 20  E_TRACE_PROFILE 
22650 63 61 6c 6c 62 61 63 6b 20 70 72 6f 76 69 64 65  callback provide
22660 73 20 61 70 70 72 6f 78 69 6d 61 74 65 6c 79 20  s approximately 
22670 74 68 65 20 73 61 6d 65 0a 2a 2a 20 69 6e 66 6f  the same.** info
22680 72 6d 61 74 69 6f 6e 20 61 73 20 69 73 20 70 72  rmation as is pr
22690 6f 76 69 64 65 64 20 62 79 20 74 68 65 20 5b 73  ovided by the [s
226a0 71 6c 69 74 65 33 5f 70 72 6f 66 69 6c 65 28 29  qlite3_profile()
226b0 5d 20 63 61 6c 6c 62 61 63 6b 2e 0a 2a 2a 20 5e  ] callback..** ^
226c0 54 68 65 20 50 20 61 72 67 75 6d 65 6e 74 20 69  The P argument i
226d0 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74  s a pointer to t
226e0 68 65 20 5b 70 72 65 70 61 72 65 64 20 73 74 61  he [prepared sta
226f0 74 65 6d 65 6e 74 5d 20 61 6e 64 20 74 68 65 0a  tement] and the.
22700 2a 2a 20 58 20 61 72 67 75 6d 65 6e 74 20 70 6f  ** X argument po
22710 69 6e 74 73 20 74 6f 20 61 20 36 34 2d 62 69 74  ints to a 64-bit
22720 20 69 6e 74 65 67 65 72 20 77 68 69 63 68 20 69   integer which i
22730 73 20 74 68 65 20 65 73 74 69 6d 61 74 65 64 20  s the estimated 
22740 6f 66 0a 2a 2a 20 74 68 65 20 6e 75 6d 62 65 72  of.** the number
22750 20 6f 66 20 6e 61 6e 6f 73 65 63 6f 6e 64 20 74   of nanosecond t
22760 68 61 74 20 74 68 65 20 70 72 65 70 61 72 65 64  hat the prepared
22770 20 73 74 61 74 65 6d 65 6e 74 20 74 6f 6f 6b 20   statement took 
22780 74 6f 20 72 75 6e 2e 0a 2a 2a 20 5e 54 68 65 20  to run..** ^The 
22790 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 50 52 4f  SQLITE_TRACE_PRO
227a0 46 49 4c 45 20 63 61 6c 6c 62 61 63 6b 20 69 73  FILE callback is
227b0 20 69 6e 76 6f 6b 65 64 20 77 68 65 6e 20 74 68   invoked when th
227c0 65 20 73 74 61 74 65 6d 65 6e 74 20 66 69 6e 69  e statement fini
227d0 73 68 65 73 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51  shes..**.** [[SQ
227e0 4c 49 54 45 5f 54 52 41 43 45 5f 52 4f 57 5d 5d  LITE_TRACE_ROW]]
227f0 20 3c 64 74 3e 53 51 4c 49 54 45 5f 54 52 41 43   <dt>SQLITE_TRAC
22800 45 5f 52 4f 57 3c 2f 64 74 3e 0a 2a 2a 20 3c 64  E_ROW</dt>.** <d
22810 64 3e 5e 41 6e 20 53 51 4c 49 54 45 5f 54 52 41  d>^An SQLITE_TRA
22820 43 45 5f 52 4f 57 20 63 61 6c 6c 62 61 63 6b 20  CE_ROW callback 
22830 69 73 20 69 6e 76 6f 6b 65 64 20 77 68 65 6e 65  is invoked whene
22840 76 65 72 20 61 20 70 72 65 70 61 72 65 64 0a 2a  ver a prepared.*
22850 2a 20 73 74 61 74 65 6d 65 6e 74 20 67 65 6e 65  * statement gene
22860 72 61 74 65 73 20 61 20 73 69 6e 67 6c 65 20 72  rates a single r
22870 6f 77 20 6f 66 20 72 65 73 75 6c 74 2e 20 20 0a  ow of result.  .
22880 2a 2a 20 5e 54 68 65 20 50 20 61 72 67 75 6d 65  ** ^The P argume
22890 6e 74 20 69 73 20 61 20 70 6f 69 6e 74 65 72 20  nt is a pointer 
228a0 74 6f 20 74 68 65 20 5b 70 72 65 70 61 72 65 64  to the [prepared
228b0 20 73 74 61 74 65 6d 65 6e 74 5d 20 61 6e 64 20   statement] and 
228c0 74 68 65 0a 2a 2a 20 58 20 61 72 67 75 6d 65 6e  the.** X argumen
228d0 74 20 69 73 20 75 6e 75 73 65 64 2e 0a 2a 2a 0a  t is unused..**.
228e0 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 54 52 41 43  ** [[SQLITE_TRAC
228f0 45 5f 43 4c 4f 53 45 5d 5d 20 3c 64 74 3e 53 51  E_CLOSE]] <dt>SQ
22900 4c 49 54 45 5f 54 52 41 43 45 5f 43 4c 4f 53 45  LITE_TRACE_CLOSE
22910 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 5e 41 6e  </dt>.** <dd>^An
22920 20 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 43 4c   SQLITE_TRACE_CL
22930 4f 53 45 20 63 61 6c 6c 62 61 63 6b 20 69 73 20  OSE callback is 
22940 69 6e 76 6f 6b 65 64 20 77 68 65 6e 20 61 20 64  invoked when a d
22950 61 74 61 62 61 73 65 0a 2a 2a 20 63 6f 6e 6e 65  atabase.** conne
22960 63 74 69 6f 6e 20 63 6c 6f 73 65 73 2e 0a 2a 2a  ction closes..**
22970 20 5e 54 68 65 20 50 20 61 72 67 75 6d 65 6e 74   ^The P argument
22980 20 69 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f   is a pointer to
22990 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20 63   the [database c
229a0 6f 6e 6e 65 63 74 69 6f 6e 5d 20 6f 62 6a 65 63  onnection] objec
229b0 74 0a 2a 2a 20 61 6e 64 20 74 68 65 20 58 20 61  t.** and the X a
229c0 72 67 75 6d 65 6e 74 20 69 73 20 75 6e 75 73 65  rgument is unuse
229d0 64 2e 0a 2a 2a 20 3c 2f 64 6c 3e 0a 2a 2f 0a 23  d..** </dl>.*/.#
229e0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 54 52  define SQLITE_TR
229f0 41 43 45 5f 53 54 4d 54 20 20 20 20 20 20 20 30  ACE_STMT       0
22a00 78 30 31 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  x01.#define SQLI
22a10 54 45 5f 54 52 41 43 45 5f 50 52 4f 46 49 4c 45  TE_TRACE_PROFILE
22a20 20 20 20 20 30 78 30 32 0a 23 64 65 66 69 6e 65      0x02.#define
22a30 20 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 52 4f   SQLITE_TRACE_RO
22a40 57 20 20 20 20 20 20 20 20 30 78 30 34 0a 23 64  W        0x04.#d
22a50 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 54 52 41  efine SQLITE_TRA
22a60 43 45 5f 43 4c 4f 53 45 20 20 20 20 20 20 30 78  CE_CLOSE      0x
22a70 30 38 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  08../*.** CAPI3R
22a80 45 46 3a 20 53 51 4c 20 54 72 61 63 65 20 48 6f  EF: SQL Trace Ho
22a90 6f 6b 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  ok.** METHOD: sq
22aa0 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  lite3.**.** ^The
22ab0 20 73 71 6c 69 74 65 33 5f 74 72 61 63 65 5f 76   sqlite3_trace_v
22ac0 32 28 44 2c 4d 2c 58 2c 50 29 20 69 6e 74 65 72  2(D,M,X,P) inter
22ad0 66 61 63 65 20 72 65 67 69 73 74 65 72 73 20 61  face registers a
22ae0 20 74 72 61 63 65 20 63 61 6c 6c 62 61 63 6b 0a   trace callback.
22af0 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 58 20 61 67  ** function X ag
22b00 61 69 6e 73 74 20 5b 64 61 74 61 62 61 73 65 20  ainst [database 
22b10 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 44 2c 20 75  connection] D, u
22b20 73 69 6e 67 20 70 72 6f 70 65 72 74 79 20 6d 61  sing property ma
22b30 73 6b 20 4d 0a 2a 2a 20 61 6e 64 20 63 6f 6e 74  sk M.** and cont
22b40 65 78 74 20 70 6f 69 6e 74 65 72 20 50 2e 20 20  ext pointer P.  
22b50 5e 49 66 20 74 68 65 20 58 20 63 61 6c 6c 62 61  ^If the X callba
22b60 63 6b 20 69 73 0a 2a 2a 20 4e 55 4c 4c 20 6f 72  ck is.** NULL or
22b70 20 69 66 20 74 68 65 20 4d 20 6d 61 73 6b 20 69   if the M mask i
22b80 73 20 7a 65 72 6f 2c 20 74 68 65 6e 20 74 72 61  s zero, then tra
22b90 63 69 6e 67 20 69 73 20 64 69 73 61 62 6c 65 64  cing is disabled
22ba0 2e 20 20 54 68 65 0a 2a 2a 20 4d 20 61 72 67 75  .  The.** M argu
22bb0 6d 65 6e 74 20 73 68 6f 75 6c 64 20 62 65 20 74  ment should be t
22bc0 68 65 20 62 69 74 77 69 73 65 20 4f 52 2d 65 64  he bitwise OR-ed
22bd0 20 63 6f 6d 62 69 6e 61 74 69 6f 6e 20 6f 66 0a   combination of.
22be0 2a 2a 20 7a 65 72 6f 20 6f 72 20 6d 6f 72 65 20  ** zero or more 
22bf0 5b 53 51 4c 49 54 45 5f 54 52 41 43 45 5d 20 63  [SQLITE_TRACE] c
22c00 6f 6e 73 74 61 6e 74 73 2e 0a 2a 2a 0a 2a 2a 20  onstants..**.** 
22c10 5e 45 61 63 68 20 63 61 6c 6c 20 74 6f 20 65 69  ^Each call to ei
22c20 74 68 65 72 20 73 71 6c 69 74 65 33 5f 74 72 61  ther sqlite3_tra
22c30 63 65 28 29 20 6f 72 20 73 71 6c 69 74 65 33 5f  ce() or sqlite3_
22c40 74 72 61 63 65 5f 76 32 28 29 20 6f 76 65 72 72  trace_v2() overr
22c50 69 64 65 73 20 0a 2a 2a 20 28 63 61 6e 63 65 6c  ides .** (cancel
22c60 73 29 20 61 6e 79 20 70 72 69 6f 72 20 63 61 6c  s) any prior cal
22c70 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 5f 74 72  ls to sqlite3_tr
22c80 61 63 65 28 29 20 6f 72 20 73 71 6c 69 74 65 33  ace() or sqlite3
22c90 5f 74 72 61 63 65 5f 76 32 28 29 2e 0a 2a 2a 0a  _trace_v2()..**.
22ca0 2a 2a 20 5e 54 68 65 20 58 20 63 61 6c 6c 62 61  ** ^The X callba
22cb0 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20 77 68  ck is invoked wh
22cc0 65 6e 65 76 65 72 20 61 6e 79 20 6f 66 20 74 68  enever any of th
22cd0 65 20 65 76 65 6e 74 73 20 69 64 65 6e 74 69 66  e events identif
22ce0 69 65 64 20 62 79 20 0a 2a 2a 20 6d 61 73 6b 20  ied by .** mask 
22cf0 4d 20 6f 63 63 75 72 2e 20 20 5e 54 68 65 20 69  M occur.  ^The i
22d00 6e 74 65 67 65 72 20 72 65 74 75 72 6e 20 76 61  nteger return va
22d10 6c 75 65 20 66 72 6f 6d 20 74 68 65 20 63 61 6c  lue from the cal
22d20 6c 62 61 63 6b 20 69 73 20 63 75 72 72 65 6e 74  lback is current
22d30 6c 79 0a 2a 2a 20 69 67 6e 6f 72 65 64 2c 20 74  ly.** ignored, t
22d40 68 6f 75 67 68 20 74 68 69 73 20 6d 61 79 20 63  hough this may c
22d50 68 61 6e 67 65 20 69 6e 20 66 75 74 75 72 65 20  hange in future 
22d60 72 65 6c 65 61 73 65 73 2e 20 20 43 61 6c 6c 62  releases.  Callb
22d70 61 63 6b 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e 74  ack.** implement
22d80 61 74 69 6f 6e 73 20 73 68 6f 75 6c 64 20 72 65  ations should re
22d90 74 75 72 6e 20 7a 65 72 6f 20 74 6f 20 65 6e 73  turn zero to ens
22da0 75 72 65 20 66 75 74 75 72 65 20 63 6f 6d 70 61  ure future compa
22db0 74 69 62 69 6c 69 74 79 2e 0a 2a 2a 0a 2a 2a 20  tibility..**.** 
22dc0 5e 41 20 74 72 61 63 65 20 63 61 6c 6c 62 61 63  ^A trace callbac
22dd0 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20 77 69 74  k is invoked wit
22de0 68 20 66 6f 75 72 20 61 72 67 75 6d 65 6e 74 73  h four arguments
22df0 3a 20 63 61 6c 6c 62 61 63 6b 28 54 2c 43 2c 50  : callback(T,C,P
22e00 2c 58 29 2e 0a 2a 2a 20 5e 54 68 65 20 54 20 61  ,X)..** ^The T a
22e10 72 67 75 6d 65 6e 74 20 69 73 20 6f 6e 65 20 6f  rgument is one o
22e20 66 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 54 52  f the [SQLITE_TR
22e30 41 43 45 5d 0a 2a 2a 20 63 6f 6e 73 74 61 6e 74  ACE].** constant
22e40 73 20 74 6f 20 69 6e 64 69 63 61 74 65 20 77 68  s to indicate wh
22e50 79 20 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 77  y the callback w
22e60 61 73 20 69 6e 76 6f 6b 65 64 2e 0a 2a 2a 20 5e  as invoked..** ^
22e70 54 68 65 20 43 20 61 72 67 75 6d 65 6e 74 20 69  The C argument i
22e80 73 20 61 20 63 6f 70 79 20 6f 66 20 74 68 65 20  s a copy of the 
22e90 63 6f 6e 74 65 78 74 20 70 6f 69 6e 74 65 72 2e  context pointer.
22ea0 0a 2a 2a 20 54 68 65 20 50 20 61 6e 64 20 58 20  .** The P and X 
22eb0 61 72 67 75 6d 65 6e 74 73 20 61 72 65 20 70 6f  arguments are po
22ec0 69 6e 74 65 72 73 20 77 68 6f 73 65 20 6d 65 61  inters whose mea
22ed0 6e 69 6e 67 73 20 64 65 70 65 6e 64 20 6f 6e 20  nings depend on 
22ee0 54 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c  T..**.** The sql
22ef0 69 74 65 33 5f 74 72 61 63 65 5f 76 32 28 29 20  ite3_trace_v2() 
22f00 69 6e 74 65 72 66 61 63 65 20 69 73 20 69 6e 74  interface is int
22f10 65 6e 64 65 64 20 74 6f 20 72 65 70 6c 61 63 65  ended to replace
22f20 20 74 68 65 20 6c 65 67 61 63 79 0a 2a 2a 20 69   the legacy.** i
22f30 6e 74 65 72 66 61 63 65 73 20 5b 73 71 6c 69 74  nterfaces [sqlit
22f40 65 33 5f 74 72 61 63 65 28 29 5d 20 61 6e 64 20  e3_trace()] and 
22f50 5b 73 71 6c 69 74 65 33 5f 70 72 6f 66 69 6c 65  [sqlite3_profile
22f60 28 29 5d 2c 20 62 6f 74 68 20 6f 66 20 77 68 69  ()], both of whi
22f70 63 68 0a 2a 2a 20 61 72 65 20 64 65 70 72 65 63  ch.** are deprec
22f80 61 74 65 64 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c  ated..*/.int sql
22f90 69 74 65 33 5f 74 72 61 63 65 5f 76 32 28 0a 20  ite3_trace_v2(. 
22fa0 20 73 71 6c 69 74 65 33 2a 2c 0a 20 20 75 6e 73   sqlite3*,.  uns
22fb0 69 67 6e 65 64 20 75 4d 61 73 6b 2c 0a 20 20 69  igned uMask,.  i
22fc0 6e 74 28 2a 78 43 61 6c 6c 62 61 63 6b 29 28 75  nt(*xCallback)(u
22fd0 6e 73 69 67 6e 65 64 2c 76 6f 69 64 2a 2c 76 6f  nsigned,void*,vo
22fe0 69 64 2a 2c 76 6f 69 64 2a 29 2c 0a 20 20 76 6f  id*,void*),.  vo
22ff0 69 64 20 2a 70 43 74 78 0a 29 3b 0a 0a 2f 2a 0a  id *pCtx.);../*.
23000 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 51 75 65  ** CAPI3REF: Que
23010 72 79 20 50 72 6f 67 72 65 73 73 20 43 61 6c 6c  ry Progress Call
23020 62 61 63 6b 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a  backs.** METHOD:
23030 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e   sqlite3.**.** ^
23040 54 68 65 20 73 71 6c 69 74 65 33 5f 70 72 6f 67  The sqlite3_prog
23050 72 65 73 73 5f 68 61 6e 64 6c 65 72 28 44 2c 4e  ress_handler(D,N
23060 2c 58 2c 50 29 20 69 6e 74 65 72 66 61 63 65 20  ,X,P) interface 
23070 63 61 75 73 65 73 20 74 68 65 20 63 61 6c 6c 62  causes the callb
23080 61 63 6b 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20  ack.** function 
23090 58 20 74 6f 20 62 65 20 69 6e 76 6f 6b 65 64 20  X to be invoked 
230a0 70 65 72 69 6f 64 69 63 61 6c 6c 79 20 64 75 72  periodically dur
230b0 69 6e 67 20 6c 6f 6e 67 20 72 75 6e 6e 69 6e 67  ing long running
230c0 20 63 61 6c 6c 73 20 74 6f 0a 2a 2a 20 5b 73 71   calls to.** [sq
230d0 6c 69 74 65 33 5f 65 78 65 63 28 29 5d 2c 20 5b  lite3_exec()], [
230e0 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20  sqlite3_step()] 
230f0 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 67 65 74  and [sqlite3_get
23100 5f 74 61 62 6c 65 28 29 5d 20 66 6f 72 0a 2a 2a  _table()] for.**
23110 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63   database connec
23120 74 69 6f 6e 20 44 2e 20 20 41 6e 20 65 78 61 6d  tion D.  An exam
23130 70 6c 65 20 75 73 65 20 66 6f 72 20 74 68 69 73  ple use for this
23140 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 69 73  .** interface is
23150 20 74 6f 20 6b 65 65 70 20 61 20 47 55 49 20 75   to keep a GUI u
23160 70 64 61 74 65 64 20 64 75 72 69 6e 67 20 61 20  pdated during a 
23170 6c 61 72 67 65 20 71 75 65 72 79 2e 0a 2a 2a 0a  large query..**.
23180 2a 2a 20 5e 54 68 65 20 70 61 72 61 6d 65 74 65  ** ^The paramete
23190 72 20 50 20 69 73 20 70 61 73 73 65 64 20 74 68  r P is passed th
231a0 72 6f 75 67 68 20 61 73 20 74 68 65 20 6f 6e 6c  rough as the onl
231b0 79 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 74  y parameter to t
231c0 68 65 20 0a 2a 2a 20 63 61 6c 6c 62 61 63 6b 20  he .** callback 
231d0 66 75 6e 63 74 69 6f 6e 20 58 2e 20 20 5e 54 68  function X.  ^Th
231e0 65 20 70 61 72 61 6d 65 74 65 72 20 4e 20 69 73  e parameter N is
231f0 20 74 68 65 20 61 70 70 72 6f 78 69 6d 61 74 65   the approximate
23200 20 6e 75 6d 62 65 72 20 6f 66 20 0a 2a 2a 20 5b   number of .** [
23210 76 69 72 74 75 61 6c 20 6d 61 63 68 69 6e 65 20  virtual machine 
23220 69 6e 73 74 72 75 63 74 69 6f 6e 73 5d 20 74 68  instructions] th
23230 61 74 20 61 72 65 20 65 76 61 6c 75 61 74 65 64  at are evaluated
23240 20 62 65 74 77 65 65 6e 20 73 75 63 63 65 73 73   between success
23250 69 76 65 0a 2a 2a 20 69 6e 76 6f 63 61 74 69 6f  ive.** invocatio
23260 6e 73 20 6f 66 20 74 68 65 20 63 61 6c 6c 62 61  ns of the callba
23270 63 6b 20 58 2e 20 20 5e 49 66 20 4e 20 69 73 20  ck X.  ^If N is 
23280 6c 65 73 73 20 74 68 61 6e 20 6f 6e 65 20 74 68  less than one th
23290 65 6e 20 74 68 65 20 70 72 6f 67 72 65 73 73 0a  en the progress.
232a0 2a 2a 20 68 61 6e 64 6c 65 72 20 69 73 20 64 69  ** handler is di
232b0 73 61 62 6c 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 4f  sabled..**.** ^O
232c0 6e 6c 79 20 61 20 73 69 6e 67 6c 65 20 70 72 6f  nly a single pro
232d0 67 72 65 73 73 20 68 61 6e 64 6c 65 72 20 6d 61  gress handler ma
232e0 79 20 62 65 20 64 65 66 69 6e 65 64 20 61 74 20  y be defined at 
232f0 6f 6e 65 20 74 69 6d 65 20 70 65 72 0a 2a 2a 20  one time per.** 
23300 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63  [database connec
23310 74 69 6f 6e 5d 3b 20 73 65 74 74 69 6e 67 20 61  tion]; setting a
23320 20 6e 65 77 20 70 72 6f 67 72 65 73 73 20 68 61   new progress ha
23330 6e 64 6c 65 72 20 63 61 6e 63 65 6c 73 20 74 68  ndler cancels th
23340 65 0a 2a 2a 20 6f 6c 64 20 6f 6e 65 2e 20 20 5e  e.** old one.  ^
23350 53 65 74 74 69 6e 67 20 70 61 72 61 6d 65 74 65  Setting paramete
23360 72 20 58 20 74 6f 20 4e 55 4c 4c 20 64 69 73 61  r X to NULL disa
23370 62 6c 65 73 20 74 68 65 20 70 72 6f 67 72 65 73  bles the progres
23380 73 20 68 61 6e 64 6c 65 72 2e 0a 2a 2a 20 5e 54  s handler..** ^T
23390 68 65 20 70 72 6f 67 72 65 73 73 20 68 61 6e 64  he progress hand
233a0 6c 65 72 20 69 73 20 61 6c 73 6f 20 64 69 73 61  ler is also disa
233b0 62 6c 65 64 20 62 79 20 73 65 74 74 69 6e 67 20  bled by setting 
233c0 4e 20 74 6f 20 61 20 76 61 6c 75 65 20 6c 65 73  N to a value les
233d0 73 0a 2a 2a 20 74 68 61 6e 20 31 2e 0a 2a 2a 0a  s.** than 1..**.
233e0 2a 2a 20 5e 49 66 20 74 68 65 20 70 72 6f 67 72  ** ^If the progr
233f0 65 73 73 20 63 61 6c 6c 62 61 63 6b 20 72 65 74  ess callback ret
23400 75 72 6e 73 20 6e 6f 6e 2d 7a 65 72 6f 2c 20 74  urns non-zero, t
23410 68 65 20 6f 70 65 72 61 74 69 6f 6e 20 69 73 0a  he operation is.
23420 2a 2a 20 69 6e 74 65 72 72 75 70 74 65 64 2e 20  ** interrupted. 
23430 20 54 68 69 73 20 66 65 61 74 75 72 65 20 63 61   This feature ca
23440 6e 20 62 65 20 75 73 65 64 20 74 6f 20 69 6d 70  n be used to imp
23450 6c 65 6d 65 6e 74 20 61 0a 2a 2a 20 22 43 61 6e  lement a.** "Can
23460 63 65 6c 22 20 62 75 74 74 6f 6e 20 6f 6e 20 61  cel" button on a
23470 20 47 55 49 20 70 72 6f 67 72 65 73 73 20 64 69   GUI progress di
23480 61 6c 6f 67 20 62 6f 78 2e 0a 2a 2a 0a 2a 2a 20  alog box..**.** 
23490 54 68 65 20 70 72 6f 67 72 65 73 73 20 68 61 6e  The progress han
234a0 64 6c 65 72 20 63 61 6c 6c 62 61 63 6b 20 6d 75  dler callback mu
234b0 73 74 20 6e 6f 74 20 64 6f 20 61 6e 79 74 68 69  st not do anythi
234c0 6e 67 20 74 68 61 74 20 77 69 6c 6c 20 6d 6f 64  ng that will mod
234d0 69 66 79 0a 2a 2a 20 74 68 65 20 64 61 74 61 62  ify.** the datab
234e0 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 74  ase connection t
234f0 68 61 74 20 69 6e 76 6f 6b 65 64 20 74 68 65 20  hat invoked the 
23500 70 72 6f 67 72 65 73 73 20 68 61 6e 64 6c 65 72  progress handler
23510 2e 0a 2a 2a 20 4e 6f 74 65 20 74 68 61 74 20 5b  ..** Note that [
23520 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f  sqlite3_prepare_
23530 76 32 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74  v2()] and [sqlit
23540 65 33 5f 73 74 65 70 28 29 5d 20 62 6f 74 68 20  e3_step()] both 
23550 6d 6f 64 69 66 79 20 74 68 65 69 72 0a 2a 2a 20  modify their.** 
23560 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
23570 69 6f 6e 73 20 66 6f 72 20 74 68 65 20 6d 65 61  ions for the mea
23580 6e 69 6e 67 20 6f 66 20 22 6d 6f 64 69 66 79 22  ning of "modify"
23590 20 69 6e 20 74 68 69 73 20 70 61 72 61 67 72 61   in this paragra
235a0 70 68 2e 0a 2a 2a 0a 2a 2f 0a 76 6f 69 64 20 73  ph..**.*/.void s
235b0 71 6c 69 74 65 33 5f 70 72 6f 67 72 65 73 73 5f  qlite3_progress_
235c0 68 61 6e 64 6c 65 72 28 73 71 6c 69 74 65 33 2a  handler(sqlite3*
235d0 2c 20 69 6e 74 2c 20 69 6e 74 28 2a 29 28 76 6f  , int, int(*)(vo
235e0 69 64 2a 29 2c 20 76 6f 69 64 2a 29 3b 0a 0a 2f  id*), void*);../
235f0 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4f  *.** CAPI3REF: O
23600 70 65 6e 69 6e 67 20 41 20 4e 65 77 20 44 61 74  pening A New Dat
23610 61 62 61 73 65 20 43 6f 6e 6e 65 63 74 69 6f 6e  abase Connection
23620 0a 2a 2a 20 43 4f 4e 53 54 52 55 43 54 4f 52 3a  .** CONSTRUCTOR:
23630 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e   sqlite3.**.** ^
23640 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 6f  These routines o
23650 70 65 6e 20 61 6e 20 53 51 4c 69 74 65 20 64 61  pen an SQLite da
23660 74 61 62 61 73 65 20 66 69 6c 65 20 61 73 20 73  tabase file as s
23670 70 65 63 69 66 69 65 64 20 62 79 20 74 68 65 20  pecified by the 
23680 0a 2a 2a 20 66 69 6c 65 6e 61 6d 65 20 61 72 67  .** filename arg
23690 75 6d 65 6e 74 2e 20 5e 54 68 65 20 66 69 6c 65  ument. ^The file
236a0 6e 61 6d 65 20 61 72 67 75 6d 65 6e 74 20 69 73  name argument is
236b0 20 69 6e 74 65 72 70 72 65 74 65 64 20 61 73 20   interpreted as 
236c0 55 54 46 2d 38 20 66 6f 72 0a 2a 2a 20 73 71 6c  UTF-8 for.** sql
236d0 69 74 65 33 5f 6f 70 65 6e 28 29 20 61 6e 64 20  ite3_open() and 
236e0 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28  sqlite3_open_v2(
236f0 29 20 61 6e 64 20 61 73 20 55 54 46 2d 31 36 20  ) and as UTF-16 
23700 69 6e 20 74 68 65 20 6e 61 74 69 76 65 20 62 79  in the native by
23710 74 65 0a 2a 2a 20 6f 72 64 65 72 20 66 6f 72 20  te.** order for 
23720 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31 36 28 29  sqlite3_open16()
23730 2e 20 5e 28 41 20 5b 64 61 74 61 62 61 73 65 20  . ^(A [database 
23740 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 68 61 6e 64  connection] hand
23750 6c 65 20 69 73 20 75 73 75 61 6c 6c 79 0a 2a 2a  le is usually.**
23760 20 72 65 74 75 72 6e 65 64 20 69 6e 20 2a 70 70   returned in *pp
23770 44 62 2c 20 65 76 65 6e 20 69 66 20 61 6e 20 65  Db, even if an e
23780 72 72 6f 72 20 6f 63 63 75 72 73 2e 20 20 54 68  rror occurs.  Th
23790 65 20 6f 6e 6c 79 20 65 78 63 65 70 74 69 6f 6e  e only exception
237a0 20 69 73 20 74 68 61 74 0a 2a 2a 20 69 66 20 53   is that.** if S
237b0 51 4c 69 74 65 20 69 73 20 75 6e 61 62 6c 65 20  QLite is unable 
237c0 74 6f 20 61 6c 6c 6f 63 61 74 65 20 6d 65 6d 6f  to allocate memo
237d0 72 79 20 74 6f 20 68 6f 6c 64 20 74 68 65 20 5b  ry to hold the [
237e0 73 71 6c 69 74 65 33 5d 20 6f 62 6a 65 63 74 2c  sqlite3] object,
237f0 0a 2a 2a 20 61 20 4e 55 4c 4c 20 77 69 6c 6c 20  .** a NULL will 
23800 62 65 20 77 72 69 74 74 65 6e 20 69 6e 74 6f 20  be written into 
23810 2a 70 70 44 62 20 69 6e 73 74 65 61 64 20 6f 66  *ppDb instead of
23820 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68   a pointer to th
23830 65 20 5b 73 71 6c 69 74 65 33 5d 0a 2a 2a 20 6f  e [sqlite3].** o
23840 62 6a 65 63 74 2e 29 5e 20 5e 28 49 66 20 74 68  bject.)^ ^(If th
23850 65 20 64 61 74 61 62 61 73 65 20 69 73 20 6f 70  e database is op
23860 65 6e 65 64 20 28 61 6e 64 2f 6f 72 20 63 72 65  ened (and/or cre
23870 61 74 65 64 29 20 73 75 63 63 65 73 73 66 75 6c  ated) successful
23880 6c 79 2c 20 74 68 65 6e 0a 2a 2a 20 5b 53 51 4c  ly, then.** [SQL
23890 49 54 45 5f 4f 4b 5d 20 69 73 20 72 65 74 75 72  ITE_OK] is retur
238a0 6e 65 64 2e 20 20 4f 74 68 65 72 77 69 73 65 20  ned.  Otherwise 
238b0 61 6e 20 5b 65 72 72 6f 72 20 63 6f 64 65 5d 20  an [error code] 
238c0 69 73 20 72 65 74 75 72 6e 65 64 2e 29 5e 20 5e  is returned.)^ ^
238d0 54 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  The.** [sqlite3_
238e0 65 72 72 6d 73 67 28 29 5d 20 6f 72 20 5b 73 71  errmsg()] or [sq
238f0 6c 69 74 65 33 5f 65 72 72 6d 73 67 31 36 28 29  lite3_errmsg16()
23900 5d 20 72 6f 75 74 69 6e 65 73 20 63 61 6e 20 62  ] routines can b
23910 65 20 75 73 65 64 20 74 6f 20 6f 62 74 61 69 6e  e used to obtain
23920 0a 2a 2a 20 61 6e 20 45 6e 67 6c 69 73 68 20 6c  .** an English l
23930 61 6e 67 75 61 67 65 20 64 65 73 63 72 69 70 74  anguage descript
23940 69 6f 6e 20 6f 66 20 74 68 65 20 65 72 72 6f 72  ion of the error
23950 20 66 6f 6c 6c 6f 77 69 6e 67 20 61 20 66 61 69   following a fai
23960 6c 75 72 65 20 6f 66 20 61 6e 79 0a 2a 2a 20 6f  lure of any.** o
23970 66 20 74 68 65 20 73 71 6c 69 74 65 33 5f 6f 70  f the sqlite3_op
23980 65 6e 28 29 20 72 6f 75 74 69 6e 65 73 2e 0a 2a  en() routines..*
23990 2a 0a 2a 2a 20 5e 54 68 65 20 64 65 66 61 75 6c  *.** ^The defaul
239a0 74 20 65 6e 63 6f 64 69 6e 67 20 77 69 6c 6c 20  t encoding will 
239b0 62 65 20 55 54 46 2d 38 20 66 6f 72 20 64 61 74  be UTF-8 for dat
239c0 61 62 61 73 65 73 20 63 72 65 61 74 65 64 20 75  abases created u
239d0 73 69 6e 67 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  sing.** sqlite3_
239e0 6f 70 65 6e 28 29 20 6f 72 20 73 71 6c 69 74 65  open() or sqlite
239f0 33 5f 6f 70 65 6e 5f 76 32 28 29 2e 20 20 5e 54  3_open_v2().  ^T
23a00 68 65 20 64 65 66 61 75 6c 74 20 65 6e 63 6f 64  he default encod
23a10 69 6e 67 20 66 6f 72 20 64 61 74 61 62 61 73 65  ing for database
23a20 73 0a 2a 2a 20 63 72 65 61 74 65 64 20 75 73 69  s.** created usi
23a30 6e 67 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31  ng sqlite3_open1
23a40 36 28 29 20 77 69 6c 6c 20 62 65 20 55 54 46 2d  6() will be UTF-
23a50 31 36 20 69 6e 20 74 68 65 20 6e 61 74 69 76 65  16 in the native
23a60 20 62 79 74 65 20 6f 72 64 65 72 2e 0a 2a 2a 0a   byte order..**.
23a70 2a 2a 20 57 68 65 74 68 65 72 20 6f 72 20 6e 6f  ** Whether or no
23a80 74 20 61 6e 20 65 72 72 6f 72 20 6f 63 63 75 72  t an error occur
23a90 73 20 77 68 65 6e 20 69 74 20 69 73 20 6f 70 65  s when it is ope
23aa0 6e 65 64 2c 20 72 65 73 6f 75 72 63 65 73 0a 2a  ned, resources.*
23ab0 2a 20 61 73 73 6f 63 69 61 74 65 64 20 77 69 74  * associated wit
23ac0 68 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20  h the [database 
23ad0 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 68 61 6e 64  connection] hand
23ae0 6c 65 20 73 68 6f 75 6c 64 20 62 65 20 72 65 6c  le should be rel
23af0 65 61 73 65 64 20 62 79 0a 2a 2a 20 70 61 73 73  eased by.** pass
23b00 69 6e 67 20 69 74 20 74 6f 20 5b 73 71 6c 69 74  ing it to [sqlit
23b10 65 33 5f 63 6c 6f 73 65 28 29 5d 20 77 68 65 6e  e3_close()] when
23b20 20 69 74 20 69 73 20 6e 6f 20 6c 6f 6e 67 65 72   it is no longer
23b30 20 72 65 71 75 69 72 65 64 2e 0a 2a 2a 0a 2a 2a   required..**.**
23b40 20 54 68 65 20 73 71 6c 69 74 65 33 5f 6f 70 65   The sqlite3_ope
23b50 6e 5f 76 32 28 29 20 69 6e 74 65 72 66 61 63 65  n_v2() interface
23b60 20 77 6f 72 6b 73 20 6c 69 6b 65 20 73 71 6c 69   works like sqli
23b70 74 65 33 5f 6f 70 65 6e 28 29 0a 2a 2a 20 65 78  te3_open().** ex
23b80 63 65 70 74 20 74 68 61 74 20 69 74 20 61 63 63  cept that it acc
23b90 65 70 74 73 20 74 77 6f 20 61 64 64 69 74 69 6f  epts two additio
23ba0 6e 61 6c 20 70 61 72 61 6d 65 74 65 72 73 20 66  nal parameters f
23bb0 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c 20 63 6f  or additional co
23bc0 6e 74 72 6f 6c 0a 2a 2a 20 6f 76 65 72 20 74 68  ntrol.** over th
23bd0 65 20 6e 65 77 20 64 61 74 61 62 61 73 65 20 63  e new database c
23be0 6f 6e 6e 65 63 74 69 6f 6e 2e 20 20 5e 28 54 68  onnection.  ^(Th
23bf0 65 20 66 6c 61 67 73 20 70 61 72 61 6d 65 74 65  e flags paramete
23c00 72 20 74 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  r to.** sqlite3_
23c10 6f 70 65 6e 5f 76 32 28 29 20 63 61 6e 20 74 61  open_v2() can ta
23c20 6b 65 20 6f 6e 65 20 6f 66 0a 2a 2a 20 74 68 65  ke one of.** the
23c30 20 66 6f 6c 6c 6f 77 69 6e 67 20 74 68 72 65 65   following three
23c40 20 76 61 6c 75 65 73 2c 20 6f 70 74 69 6f 6e 61   values, optiona
23c50 6c 6c 79 20 63 6f 6d 62 69 6e 65 64 20 77 69 74  lly combined wit
23c60 68 20 74 68 65 20 0a 2a 2a 20 5b 53 51 4c 49 54  h the .** [SQLIT
23c70 45 5f 4f 50 45 4e 5f 4e 4f 4d 55 54 45 58 5d 2c  E_OPEN_NOMUTEX],
23c80 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 46 55   [SQLITE_OPEN_FU
23c90 4c 4c 4d 55 54 45 58 5d 2c 20 5b 53 51 4c 49 54  LLMUTEX], [SQLIT
23ca0 45 5f 4f 50 45 4e 5f 53 48 41 52 45 44 43 41 43  E_OPEN_SHAREDCAC
23cb0 48 45 5d 2c 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f  HE],.** [SQLITE_
23cc0 4f 50 45 4e 5f 50 52 49 56 41 54 45 43 41 43 48  OPEN_PRIVATECACH
23cd0 45 5d 2c 20 61 6e 64 2f 6f 72 20 5b 53 51 4c 49  E], and/or [SQLI
23ce0 54 45 5f 4f 50 45 4e 5f 55 52 49 5d 20 66 6c 61  TE_OPEN_URI] fla
23cf0 67 73 3a 29 5e 0a 2a 2a 0a 2a 2a 20 3c 64 6c 3e  gs:)^.**.** <dl>
23d00 0a 2a 2a 20 5e 28 3c 64 74 3e 5b 53 51 4c 49 54  .** ^(<dt>[SQLIT
23d10 45 5f 4f 50 45 4e 5f 52 45 41 44 4f 4e 4c 59 5d  E_OPEN_READONLY]
23d20 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65  </dt>.** <dd>The
23d30 20 64 61 74 61 62 61 73 65 20 69 73 20 6f 70 65   database is ope
23d40 6e 65 64 20 69 6e 20 72 65 61 64 2d 6f 6e 6c 79  ned in read-only
23d50 20 6d 6f 64 65 2e 20 20 49 66 20 74 68 65 20 64   mode.  If the d
23d60 61 74 61 62 61 73 65 20 64 6f 65 73 20 6e 6f 74  atabase does not
23d70 0a 2a 2a 20 61 6c 72 65 61 64 79 20 65 78 69 73  .** already exis
23d80 74 2c 20 61 6e 20 65 72 72 6f 72 20 69 73 20 72  t, an error is r
23d90 65 74 75 72 6e 65 64 2e 3c 2f 64 64 3e 29 5e 0a  eturned.</dd>)^.
23da0 2a 2a 0a 2a 2a 20 5e 28 3c 64 74 3e 5b 53 51 4c  **.** ^(<dt>[SQL
23db0 49 54 45 5f 4f 50 45 4e 5f 52 45 41 44 57 52 49  ITE_OPEN_READWRI
23dc0 54 45 5d 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e  TE]</dt>.** <dd>
23dd0 54 68 65 20 64 61 74 61 62 61 73 65 20 69 73 20  The database is 
23de0 6f 70 65 6e 65 64 20 66 6f 72 20 72 65 61 64 69  opened for readi
23df0 6e 67 20 61 6e 64 20 77 72 69 74 69 6e 67 20 69  ng and writing i
23e00 66 20 70 6f 73 73 69 62 6c 65 2c 20 6f 72 20 72  f possible, or r
23e10 65 61 64 69 6e 67 0a 2a 2a 20 6f 6e 6c 79 20 69  eading.** only i
23e20 66 20 74 68 65 20 66 69 6c 65 20 69 73 20 77 72  f the file is wr
23e30 69 74 65 20 70 72 6f 74 65 63 74 65 64 20 62 79  ite protected by
23e40 20 74 68 65 20 6f 70 65 72 61 74 69 6e 67 20 73   the operating s
23e50 79 73 74 65 6d 2e 20 20 49 6e 20 65 69 74 68 65  ystem.  In eithe
23e60 72 0a 2a 2a 20 63 61 73 65 20 74 68 65 20 64 61  r.** case the da
23e70 74 61 62 61 73 65 20 6d 75 73 74 20 61 6c 72 65  tabase must alre
23e80 61 64 79 20 65 78 69 73 74 2c 20 6f 74 68 65 72  ady exist, other
23e90 77 69 73 65 20 61 6e 20 65 72 72 6f 72 20 69 73  wise an error is
23ea0 20 72 65 74 75 72 6e 65 64 2e 3c 2f 64 64 3e 29   returned.</dd>)
23eb0 5e 0a 2a 2a 0a 2a 2a 20 5e 28 3c 64 74 3e 5b 53  ^.**.** ^(<dt>[S
23ec0 51 4c 49 54 45 5f 4f 50 45 4e 5f 52 45 41 44 57  QLITE_OPEN_READW
23ed0 52 49 54 45 5d 20 7c 20 5b 53 51 4c 49 54 45 5f  RITE] | [SQLITE_
23ee0 4f 50 45 4e 5f 43 52 45 41 54 45 5d 3c 2f 64 74  OPEN_CREATE]</dt
23ef0 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 64 61 74  >.** <dd>The dat
23f00 61 62 61 73 65 20 69 73 20 6f 70 65 6e 65 64 20  abase is opened 
23f10 66 6f 72 20 72 65 61 64 69 6e 67 20 61 6e 64 20  for reading and 
23f20 77 72 69 74 69 6e 67 2c 20 61 6e 64 20 69 73 20  writing, and is 
23f30 63 72 65 61 74 65 64 20 69 66 0a 2a 2a 20 69 74  created if.** it
23f40 20 64 6f 65 73 20 6e 6f 74 20 61 6c 72 65 61 64   does not alread
23f50 79 20 65 78 69 73 74 2e 20 54 68 69 73 20 69 73  y exist. This is
23f60 20 74 68 65 20 62 65 68 61 76 69 6f 72 20 74 68   the behavior th
23f70 61 74 20 69 73 20 61 6c 77 61 79 73 20 75 73 65  at is always use
23f80 64 20 66 6f 72 0a 2a 2a 20 73 71 6c 69 74 65 33  d for.** sqlite3
23f90 5f 6f 70 65 6e 28 29 20 61 6e 64 20 73 71 6c 69  _open() and sqli
23fa0 74 65 33 5f 6f 70 65 6e 31 36 28 29 2e 3c 2f 64  te3_open16().</d
23fb0 64 3e 29 5e 0a 2a 2a 20 3c 2f 64 6c 3e 0a 2a 2a  d>)^.** </dl>.**
23fc0 0a 2a 2a 20 49 66 20 74 68 65 20 33 72 64 20 70  .** If the 3rd p
23fd0 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69  arameter to sqli
23fe0 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 20 69 73  te3_open_v2() is
23ff0 20 6e 6f 74 20 6f 6e 65 20 6f 66 20 74 68 65 0a   not one of the.
24000 2a 2a 20 63 6f 6d 62 69 6e 61 74 69 6f 6e 73 20  ** combinations 
24010 73 68 6f 77 6e 20 61 62 6f 76 65 20 6f 70 74 69  shown above opti
24020 6f 6e 61 6c 6c 79 20 63 6f 6d 62 69 6e 65 64 20  onally combined 
24030 77 69 74 68 20 6f 74 68 65 72 0a 2a 2a 20 5b 53  with other.** [S
24040 51 4c 49 54 45 5f 4f 50 45 4e 5f 52 45 41 44 4f  QLITE_OPEN_READO
24050 4e 4c 59 20 7c 20 53 51 4c 49 54 45 5f 4f 50 45  NLY | SQLITE_OPE
24060 4e 5f 2a 20 62 69 74 73 5d 0a 2a 2a 20 74 68 65  N_* bits].** the
24070 6e 20 74 68 65 20 62 65 68 61 76 69 6f 72 20 69  n the behavior i
24080 73 20 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a 0a  s undefined..**.
24090 2a 2a 20 5e 49 66 20 74 68 65 20 5b 53 51 4c 49  ** ^If the [SQLI
240a0 54 45 5f 4f 50 45 4e 5f 4e 4f 4d 55 54 45 58 5d  TE_OPEN_NOMUTEX]
240b0 20 66 6c 61 67 20 69 73 20 73 65 74 2c 20 74 68   flag is set, th
240c0 65 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20  en the database 
240d0 63 6f 6e 6e 65 63 74 69 6f 6e 0a 2a 2a 20 6f 70  connection.** op
240e0 65 6e 73 20 69 6e 20 74 68 65 20 6d 75 6c 74 69  ens in the multi
240f0 2d 74 68 72 65 61 64 20 5b 74 68 72 65 61 64 69  -thread [threadi
24100 6e 67 20 6d 6f 64 65 5d 20 61 73 20 6c 6f 6e 67  ng mode] as long
24110 20 61 73 20 74 68 65 20 73 69 6e 67 6c 65 2d 74   as the single-t
24120 68 72 65 61 64 0a 2a 2a 20 6d 6f 64 65 20 68 61  hread.** mode ha
24130 73 20 6e 6f 74 20 62 65 65 6e 20 73 65 74 20 61  s not been set a
24140 74 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f  t compile-time o
24150 72 20 73 74 61 72 74 2d 74 69 6d 65 2e 20 20 5e  r start-time.  ^
24160 49 66 20 74 68 65 0a 2a 2a 20 5b 53 51 4c 49 54  If the.** [SQLIT
24170 45 5f 4f 50 45 4e 5f 46 55 4c 4c 4d 55 54 45 58  E_OPEN_FULLMUTEX
24180 5d 20 66 6c 61 67 20 69 73 20 73 65 74 20 74 68  ] flag is set th
24190 65 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20  en the database 
241a0 63 6f 6e 6e 65 63 74 69 6f 6e 20 6f 70 65 6e 73  connection opens
241b0 0a 2a 2a 20 69 6e 20 74 68 65 20 73 65 72 69 61  .** in the seria
241c0 6c 69 7a 65 64 20 5b 74 68 72 65 61 64 69 6e 67  lized [threading
241d0 20 6d 6f 64 65 5d 20 75 6e 6c 65 73 73 20 73 69   mode] unless si
241e0 6e 67 6c 65 2d 74 68 72 65 61 64 20 77 61 73 0a  ngle-thread was.
241f0 2a 2a 20 70 72 65 76 69 6f 75 73 6c 79 20 73 65  ** previously se
24200 6c 65 63 74 65 64 20 61 74 20 63 6f 6d 70 69 6c  lected at compil
24210 65 2d 74 69 6d 65 20 6f 72 20 73 74 61 72 74 2d  e-time or start-
24220 74 69 6d 65 2e 0a 2a 2a 20 5e 54 68 65 20 5b 53  time..** ^The [S
24230 51 4c 49 54 45 5f 4f 50 45 4e 5f 53 48 41 52 45  QLITE_OPEN_SHARE
24240 44 43 41 43 48 45 5d 20 66 6c 61 67 20 63 61 75  DCACHE] flag cau
24250 73 65 73 20 74 68 65 20 64 61 74 61 62 61 73 65  ses the database
24260 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 6f 20 62   connection to b
24270 65 0a 2a 2a 20 65 6c 69 67 69 62 6c 65 20 74 6f  e.** eligible to
24280 20 75 73 65 20 5b 73 68 61 72 65 64 20 63 61 63   use [shared cac
24290 68 65 20 6d 6f 64 65 5d 2c 20 72 65 67 61 72 64  he mode], regard
242a0 6c 65 73 73 20 6f 66 20 77 68 65 74 68 65 72 20  less of whether 
242b0 6f 72 20 6e 6f 74 20 73 68 61 72 65 64 0a 2a 2a  or not shared.**
242c0 20 63 61 63 68 65 20 69 73 20 65 6e 61 62 6c 65   cache is enable
242d0 64 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33  d using [sqlite3
242e0 5f 65 6e 61 62 6c 65 5f 73 68 61 72 65 64 5f 63  _enable_shared_c
242f0 61 63 68 65 28 29 5d 2e 20 20 5e 54 68 65 0a 2a  ache()].  ^The.*
24300 2a 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 50  * [SQLITE_OPEN_P
24310 52 49 56 41 54 45 43 41 43 48 45 5d 20 66 6c 61  RIVATECACHE] fla
24320 67 20 63 61 75 73 65 73 20 74 68 65 20 64 61 74  g causes the dat
24330 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
24340 20 74 6f 20 6e 6f 74 0a 2a 2a 20 70 61 72 74 69   to not.** parti
24350 63 69 70 61 74 65 20 69 6e 20 5b 73 68 61 72 65  cipate in [share
24360 64 20 63 61 63 68 65 20 6d 6f 64 65 5d 20 65 76  d cache mode] ev
24370 65 6e 20 69 66 20 69 74 20 69 73 20 65 6e 61 62  en if it is enab
24380 6c 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  led..**.** ^The 
24390 66 6f 75 72 74 68 20 70 61 72 61 6d 65 74 65 72  fourth parameter
243a0 20 74 6f 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e   to sqlite3_open
243b0 5f 76 32 28 29 20 69 73 20 74 68 65 20 6e 61 6d  _v2() is the nam
243c0 65 20 6f 66 20 74 68 65 0a 2a 2a 20 5b 73 71 6c  e of the.** [sql
243d0 69 74 65 33 5f 76 66 73 5d 20 6f 62 6a 65 63 74  ite3_vfs] object
243e0 20 74 68 61 74 20 64 65 66 69 6e 65 73 20 74 68   that defines th
243f0 65 20 6f 70 65 72 61 74 69 6e 67 20 73 79 73 74  e operating syst
24400 65 6d 20 69 6e 74 65 72 66 61 63 65 20 74 68 61  em interface tha
24410 74 0a 2a 2a 20 74 68 65 20 6e 65 77 20 64 61 74  t.** the new dat
24420 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
24430 20 73 68 6f 75 6c 64 20 75 73 65 2e 20 20 5e 49   should use.  ^I
24440 66 20 74 68 65 20 66 6f 75 72 74 68 20 70 61 72  f the fourth par
24450 61 6d 65 74 65 72 20 69 73 0a 2a 2a 20 61 20 4e  ameter is.** a N
24460 55 4c 4c 20 70 6f 69 6e 74 65 72 20 74 68 65 6e  ULL pointer then
24470 20 74 68 65 20 64 65 66 61 75 6c 74 20 5b 73 71   the default [sq
24480 6c 69 74 65 33 5f 76 66 73 5d 20 6f 62 6a 65 63  lite3_vfs] objec
24490 74 20 69 73 20 75 73 65 64 2e 0a 2a 2a 0a 2a 2a  t is used..**.**
244a0 20 5e 49 66 20 74 68 65 20 66 69 6c 65 6e 61 6d   ^If the filenam
244b0 65 20 69 73 20 22 3a 6d 65 6d 6f 72 79 3a 22 2c  e is ":memory:",
244c0 20 74 68 65 6e 20 61 20 70 72 69 76 61 74 65 2c   then a private,
244d0 20 74 65 6d 70 6f 72 61 72 79 20 69 6e 2d 6d 65   temporary in-me
244e0 6d 6f 72 79 20 64 61 74 61 62 61 73 65 0a 2a 2a  mory database.**
244f0 20 69 73 20 63 72 65 61 74 65 64 20 66 6f 72 20   is created for 
24500 74 68 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e 20  the connection. 
24510 20 5e 54 68 69 73 20 69 6e 2d 6d 65 6d 6f 72 79   ^This in-memory
24520 20 64 61 74 61 62 61 73 65 20 77 69 6c 6c 20 76   database will v
24530 61 6e 69 73 68 20 77 68 65 6e 0a 2a 2a 20 74 68  anish when.** th
24540 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65  e database conne
24550 63 74 69 6f 6e 20 69 73 20 63 6c 6f 73 65 64 2e  ction is closed.
24560 20 20 46 75 74 75 72 65 20 76 65 72 73 69 6f 6e    Future version
24570 73 20 6f 66 20 53 51 4c 69 74 65 20 6d 69 67 68  s of SQLite migh
24580 74 0a 2a 2a 20 6d 61 6b 65 20 75 73 65 20 6f 66  t.** make use of
24590 20 61 64 64 69 74 69 6f 6e 61 6c 20 73 70 65 63   additional spec
245a0 69 61 6c 20 66 69 6c 65 6e 61 6d 65 73 20 74 68  ial filenames th
245b0 61 74 20 62 65 67 69 6e 20 77 69 74 68 20 74 68  at begin with th
245c0 65 20 22 3a 22 20 63 68 61 72 61 63 74 65 72 2e  e ":" character.
245d0 0a 2a 2a 20 49 74 20 69 73 20 72 65 63 6f 6d 6d  .** It is recomm
245e0 65 6e 64 65 64 20 74 68 61 74 20 77 68 65 6e 20  ended that when 
245f0 61 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 6e  a database filen
24600 61 6d 65 20 61 63 74 75 61 6c 6c 79 20 64 6f 65  ame actually doe
24610 73 20 62 65 67 69 6e 20 77 69 74 68 0a 2a 2a 20  s begin with.** 
24620 61 20 22 3a 22 20 63 68 61 72 61 63 74 65 72 20  a ":" character 
24630 79 6f 75 20 73 68 6f 75 6c 64 20 70 72 65 66 69  you should prefi
24640 78 20 74 68 65 20 66 69 6c 65 6e 61 6d 65 20 77  x the filename w
24650 69 74 68 20 61 20 70 61 74 68 6e 61 6d 65 20 73  ith a pathname s
24660 75 63 68 20 61 73 0a 2a 2a 20 22 2e 2f 22 20 74  uch as.** "./" t
24670 6f 20 61 76 6f 69 64 20 61 6d 62 69 67 75 69 74  o avoid ambiguit
24680 79 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65  y..**.** ^If the
24690 20 66 69 6c 65 6e 61 6d 65 20 69 73 20 61 6e 20   filename is an 
246a0 65 6d 70 74 79 20 73 74 72 69 6e 67 2c 20 74 68  empty string, th
246b0 65 6e 20 61 20 70 72 69 76 61 74 65 2c 20 74 65  en a private, te
246c0 6d 70 6f 72 61 72 79 0a 2a 2a 20 6f 6e 2d 64 69  mporary.** on-di
246d0 73 6b 20 64 61 74 61 62 61 73 65 20 77 69 6c 6c  sk database will
246e0 20 62 65 20 63 72 65 61 74 65 64 2e 20 20 5e 54   be created.  ^T
246f0 68 69 73 20 70 72 69 76 61 74 65 20 64 61 74 61  his private data
24700 62 61 73 65 20 77 69 6c 6c 20 62 65 0a 2a 2a 20  base will be.** 
24710 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 64 65  automatically de
24720 6c 65 74 65 64 20 61 73 20 73 6f 6f 6e 20 61 73  leted as soon as
24730 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63 6f   the database co
24740 6e 6e 65 63 74 69 6f 6e 20 69 73 20 63 6c 6f 73  nnection is clos
24750 65 64 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 55 52 49 20  ed..**.** [[URI 
24760 66 69 6c 65 6e 61 6d 65 73 20 69 6e 20 73 71 6c  filenames in sql
24770 69 74 65 33 5f 6f 70 65 6e 28 29 5d 5d 20 3c 68  ite3_open()]] <h
24780 33 3e 55 52 49 20 46 69 6c 65 6e 61 6d 65 73 3c  3>URI Filenames<
24790 2f 68 33 3e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 5b  /h3>.**.** ^If [
247a0 55 52 49 20 66 69 6c 65 6e 61 6d 65 5d 20 69 6e  URI filename] in
247b0 74 65 72 70 72 65 74 61 74 69 6f 6e 20 69 73 20  terpretation is 
247c0 65 6e 61 62 6c 65 64 2c 20 61 6e 64 20 74 68 65  enabled, and the
247d0 20 66 69 6c 65 6e 61 6d 65 20 61 72 67 75 6d 65   filename argume
247e0 6e 74 0a 2a 2a 20 62 65 67 69 6e 73 20 77 69 74  nt.** begins wit
247f0 68 20 22 66 69 6c 65 3a 22 2c 20 74 68 65 6e 20  h "file:", then 
24800 74 68 65 20 66 69 6c 65 6e 61 6d 65 20 69 73 20  the filename is 
24810 69 6e 74 65 72 70 72 65 74 65 64 20 61 73 20 61  interpreted as a
24820 20 55 52 49 2e 20 5e 55 52 49 0a 2a 2a 20 66 69   URI. ^URI.** fi
24830 6c 65 6e 61 6d 65 20 69 6e 74 65 72 70 72 65 74  lename interpret
24840 61 74 69 6f 6e 20 69 73 20 65 6e 61 62 6c 65 64  ation is enabled
24850 20 69 66 20 74 68 65 20 5b 53 51 4c 49 54 45 5f   if the [SQLITE_
24860 4f 50 45 4e 5f 55 52 49 5d 20 66 6c 61 67 20 69  OPEN_URI] flag i
24870 73 0a 2a 2a 20 73 65 74 20 69 6e 20 74 68 65 20  s.** set in the 
24880 66 6f 75 72 74 68 20 61 72 67 75 6d 65 6e 74 20  fourth argument 
24890 74 6f 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f  to sqlite3_open_
248a0 76 32 28 29 2c 20 6f 72 20 69 66 20 69 74 20 68  v2(), or if it h
248b0 61 73 0a 2a 2a 20 62 65 65 6e 20 65 6e 61 62 6c  as.** been enabl
248c0 65 64 20 67 6c 6f 62 61 6c 6c 79 20 75 73 69 6e  ed globally usin
248d0 67 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 43 4f  g the [SQLITE_CO
248e0 4e 46 49 47 5f 55 52 49 5d 20 6f 70 74 69 6f 6e  NFIG_URI] option
248f0 20 77 69 74 68 20 74 68 65 0a 2a 2a 20 5b 73 71   with the.** [sq
24900 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d 20  lite3_config()] 
24910 6d 65 74 68 6f 64 20 6f 72 20 62 79 20 74 68 65  method or by the
24920 20 5b 53 51 4c 49 54 45 5f 55 53 45 5f 55 52 49   [SQLITE_USE_URI
24930 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f  ] compile-time o
24940 70 74 69 6f 6e 2e 0a 2a 2a 20 41 73 20 6f 66 20  ption..** As of 
24950 53 51 4c 69 74 65 20 76 65 72 73 69 6f 6e 20 33  SQLite version 3
24960 2e 37 2e 37 2c 20 55 52 49 20 66 69 6c 65 6e 61  .7.7, URI filena
24970 6d 65 20 69 6e 74 65 72 70 72 65 74 61 74 69 6f  me interpretatio
24980 6e 20 69 73 20 74 75 72 6e 65 64 20 6f 66 66 0a  n is turned off.
24990 2a 2a 20 62 79 20 64 65 66 61 75 6c 74 2c 20 62  ** by default, b
249a0 75 74 20 66 75 74 75 72 65 20 72 65 6c 65 61 73  ut future releas
249b0 65 73 20 6f 66 20 53 51 4c 69 74 65 20 6d 69 67  es of SQLite mig
249c0 68 74 20 65 6e 61 62 6c 65 20 55 52 49 20 66 69  ht enable URI fi
249d0 6c 65 6e 61 6d 65 0a 2a 2a 20 69 6e 74 65 72 70  lename.** interp
249e0 72 65 74 61 74 69 6f 6e 20 62 79 20 64 65 66 61  retation by defa
249f0 75 6c 74 2e 20 20 53 65 65 20 22 5b 55 52 49 20  ult.  See "[URI 
24a00 66 69 6c 65 6e 61 6d 65 73 5d 22 20 66 6f 72 20  filenames]" for 
24a10 61 64 64 69 74 69 6f 6e 61 6c 0a 2a 2a 20 69 6e  additional.** in
24a20 66 6f 72 6d 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a  formation..**.**
24a30 20 55 52 49 20 66 69 6c 65 6e 61 6d 65 73 20 61   URI filenames a
24a40 72 65 20 70 61 72 73 65 64 20 61 63 63 6f 72 64  re parsed accord
24a50 69 6e 67 20 74 6f 20 52 46 43 20 33 39 38 36 2e  ing to RFC 3986.
24a60 20 5e 49 66 20 74 68 65 20 55 52 49 20 63 6f 6e   ^If the URI con
24a70 74 61 69 6e 73 20 61 6e 0a 2a 2a 20 61 75 74 68  tains an.** auth
24a80 6f 72 69 74 79 2c 20 74 68 65 6e 20 69 74 20 6d  ority, then it m
24a90 75 73 74 20 62 65 20 65 69 74 68 65 72 20 61 6e  ust be either an
24aa0 20 65 6d 70 74 79 20 73 74 72 69 6e 67 20 6f 72   empty string or
24ab0 20 74 68 65 20 73 74 72 69 6e 67 20 0a 2a 2a 20   the string .** 
24ac0 22 6c 6f 63 61 6c 68 6f 73 74 22 2e 20 5e 49 66  "localhost". ^If
24ad0 20 74 68 65 20 61 75 74 68 6f 72 69 74 79 20 69   the authority i
24ae0 73 20 6e 6f 74 20 61 6e 20 65 6d 70 74 79 20 73  s not an empty s
24af0 74 72 69 6e 67 20 6f 72 20 22 6c 6f 63 61 6c 68  tring or "localh
24b00 6f 73 74 22 2c 20 61 6e 20 0a 2a 2a 20 65 72 72  ost", an .** err
24b10 6f 72 20 69 73 20 72 65 74 75 72 6e 65 64 20 74  or is returned t
24b20 6f 20 74 68 65 20 63 61 6c 6c 65 72 2e 20 5e 54  o the caller. ^T
24b30 68 65 20 66 72 61 67 6d 65 6e 74 20 63 6f 6d 70  he fragment comp
24b40 6f 6e 65 6e 74 20 6f 66 20 61 20 55 52 49 2c 20  onent of a URI, 
24b50 69 66 20 0a 2a 2a 20 70 72 65 73 65 6e 74 2c 20  if .** present, 
24b60 69 73 20 69 67 6e 6f 72 65 64 2e 0a 2a 2a 0a 2a  is ignored..**.*
24b70 2a 20 5e 53 51 4c 69 74 65 20 75 73 65 73 20 74  * ^SQLite uses t
24b80 68 65 20 70 61 74 68 20 63 6f 6d 70 6f 6e 65 6e  he path componen
24b90 74 20 6f 66 20 74 68 65 20 55 52 49 20 61 73 20  t of the URI as 
24ba0 74 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20  the name of the 
24bb0 64 69 73 6b 20 66 69 6c 65 0a 2a 2a 20 77 68 69  disk file.** whi
24bc0 63 68 20 63 6f 6e 74 61 69 6e 73 20 74 68 65 20  ch contains the 
24bd0 64 61 74 61 62 61 73 65 2e 20 5e 49 66 20 74 68  database. ^If th
24be0 65 20 70 61 74 68 20 62 65 67 69 6e 73 20 77 69  e path begins wi
24bf0 74 68 20 61 20 27 2f 27 20 63 68 61 72 61 63 74  th a '/' charact
24c00 65 72 2c 20 0a 2a 2a 20 74 68 65 6e 20 69 74 20  er, .** then it 
24c10 69 73 20 69 6e 74 65 72 70 72 65 74 65 64 20 61  is interpreted a
24c20 73 20 61 6e 20 61 62 73 6f 6c 75 74 65 20 70 61  s an absolute pa
24c30 74 68 2e 20 5e 49 66 20 74 68 65 20 70 61 74 68  th. ^If the path
24c40 20 64 6f 65 73 20 6e 6f 74 20 62 65 67 69 6e 20   does not begin 
24c50 0a 2a 2a 20 77 69 74 68 20 61 20 27 2f 27 20 28  .** with a '/' (
24c60 6d 65 61 6e 69 6e 67 20 74 68 61 74 20 74 68 65  meaning that the
24c70 20 61 75 74 68 6f 72 69 74 79 20 73 65 63 74 69   authority secti
24c80 6f 6e 20 69 73 20 6f 6d 69 74 74 65 64 20 66 72  on is omitted fr
24c90 6f 6d 20 74 68 65 20 55 52 49 29 0a 2a 2a 20 74  om the URI).** t
24ca0 68 65 6e 20 74 68 65 20 70 61 74 68 20 69 73 20  hen the path is 
24cb0 69 6e 74 65 72 70 72 65 74 65 64 20 61 73 20 61  interpreted as a
24cc0 20 72 65 6c 61 74 69 76 65 20 70 61 74 68 2e 20   relative path. 
24cd0 0a 2a 2a 20 5e 28 4f 6e 20 77 69 6e 64 6f 77 73  .** ^(On windows
24ce0 2c 20 74 68 65 20 66 69 72 73 74 20 63 6f 6d 70  , the first comp
24cf0 6f 6e 65 6e 74 20 6f 66 20 61 6e 20 61 62 73 6f  onent of an abso
24d00 6c 75 74 65 20 70 61 74 68 20 0a 2a 2a 20 69 73  lute path .** is
24d10 20 61 20 64 72 69 76 65 20 73 70 65 63 69 66 69   a drive specifi
24d20 63 61 74 69 6f 6e 20 28 65 2e 67 2e 20 22 43 3a  cation (e.g. "C:
24d30 22 29 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 63 6f  ").)^.**.** [[co
24d40 72 65 20 55 52 49 20 71 75 65 72 79 20 70 61 72  re URI query par
24d50 61 6d 65 74 65 72 73 5d 5d 0a 2a 2a 20 54 68 65  ameters]].** The
24d60 20 71 75 65 72 79 20 63 6f 6d 70 6f 6e 65 6e 74   query component
24d70 20 6f 66 20 61 20 55 52 49 20 6d 61 79 20 63 6f   of a URI may co
24d80 6e 74 61 69 6e 20 70 61 72 61 6d 65 74 65 72 73  ntain parameters
24d90 20 74 68 61 74 20 61 72 65 20 69 6e 74 65 72 70   that are interp
24da0 72 65 74 65 64 0a 2a 2a 20 65 69 74 68 65 72 20  reted.** either 
24db0 62 79 20 53 51 4c 69 74 65 20 69 74 73 65 6c 66  by SQLite itself
24dc0 2c 20 6f 72 20 62 79 20 61 20 5b 56 46 53 20 7c  , or by a [VFS |
24dd0 20 63 75 73 74 6f 6d 20 56 46 53 20 69 6d 70 6c   custom VFS impl
24de0 65 6d 65 6e 74 61 74 69 6f 6e 5d 2e 0a 2a 2a 20  ementation]..** 
24df0 53 51 4c 69 74 65 20 61 6e 64 20 69 74 73 20 62  SQLite and its b
24e00 75 69 6c 74 2d 69 6e 20 5b 56 46 53 65 73 5d 20  uilt-in [VFSes] 
24e10 69 6e 74 65 72 70 72 65 74 20 74 68 65 0a 2a 2a  interpret the.**
24e20 20 66 6f 6c 6c 6f 77 69 6e 67 20 71 75 65 72 79   following query
24e30 20 70 61 72 61 6d 65 74 65 72 73 3a 0a 2a 2a 0a   parameters:.**.
24e40 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 20 20 3c 6c 69  ** <ul>.**   <li
24e50 3e 20 3c 62 3e 76 66 73 3c 2f 62 3e 3a 20 5e 54  > <b>vfs</b>: ^T
24e60 68 65 20 22 76 66 73 22 20 70 61 72 61 6d 65 74  he "vfs" paramet
24e70 65 72 20 6d 61 79 20 62 65 20 75 73 65 64 20 74  er may be used t
24e80 6f 20 73 70 65 63 69 66 79 20 74 68 65 20 6e 61  o specify the na
24e90 6d 65 20 6f 66 0a 2a 2a 20 20 20 20 20 61 20 56  me of.**     a V
24ea0 46 53 20 6f 62 6a 65 63 74 20 74 68 61 74 20 70  FS object that p
24eb0 72 6f 76 69 64 65 73 20 74 68 65 20 6f 70 65 72  rovides the oper
24ec0 61 74 69 6e 67 20 73 79 73 74 65 6d 20 69 6e 74  ating system int
24ed0 65 72 66 61 63 65 20 74 68 61 74 20 73 68 6f 75  erface that shou
24ee0 6c 64 0a 2a 2a 20 20 20 20 20 62 65 20 75 73 65  ld.**     be use
24ef0 64 20 74 6f 20 61 63 63 65 73 73 20 74 68 65 20  d to access the 
24f00 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 6f 6e  database file on
24f10 20 64 69 73 6b 2e 20 5e 49 66 20 74 68 69 73 20   disk. ^If this 
24f20 6f 70 74 69 6f 6e 20 69 73 20 73 65 74 20 74 6f  option is set to
24f30 0a 2a 2a 20 20 20 20 20 61 6e 20 65 6d 70 74 79  .**     an empty
24f40 20 73 74 72 69 6e 67 20 74 68 65 20 64 65 66 61   string the defa
24f50 75 6c 74 20 56 46 53 20 6f 62 6a 65 63 74 20 69  ult VFS object i
24f60 73 20 75 73 65 64 2e 20 5e 53 70 65 63 69 66 79  s used. ^Specify
24f70 69 6e 67 20 61 6e 20 75 6e 6b 6e 6f 77 6e 0a 2a  ing an unknown.*
24f80 2a 20 20 20 20 20 56 46 53 20 69 73 20 61 6e 20  *     VFS is an 
24f90 65 72 72 6f 72 2e 20 5e 49 66 20 73 71 6c 69 74  error. ^If sqlit
24fa0 65 33 5f 6f 70 65 6e 5f 76 32 28 29 20 69 73 20  e3_open_v2() is 
24fb0 75 73 65 64 20 61 6e 64 20 74 68 65 20 76 66 73  used and the vfs
24fc0 20 6f 70 74 69 6f 6e 20 69 73 0a 2a 2a 20 20 20   option is.**   
24fd0 20 20 70 72 65 73 65 6e 74 2c 20 74 68 65 6e 20    present, then 
24fe0 74 68 65 20 56 46 53 20 73 70 65 63 69 66 69 65  the VFS specifie
24ff0 64 20 62 79 20 74 68 65 20 6f 70 74 69 6f 6e 20  d by the option 
25000 74 61 6b 65 73 20 70 72 65 63 65 64 65 6e 63 65  takes precedence
25010 20 6f 76 65 72 0a 2a 2a 20 20 20 20 20 74 68 65   over.**     the
25020 20 76 61 6c 75 65 20 70 61 73 73 65 64 20 61 73   value passed as
25030 20 74 68 65 20 66 6f 75 72 74 68 20 70 61 72 61   the fourth para
25040 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33  meter to sqlite3
25050 5f 6f 70 65 6e 5f 76 32 28 29 2e 0a 2a 2a 0a 2a  _open_v2()..**.*
25060 2a 20 20 20 3c 6c 69 3e 20 3c 62 3e 6d 6f 64 65  *   <li> <b>mode
25070 3c 2f 62 3e 3a 20 5e 28 54 68 65 20 6d 6f 64 65  </b>: ^(The mode
25080 20 70 61 72 61 6d 65 74 65 72 20 6d 61 79 20 62   parameter may b
25090 65 20 73 65 74 20 74 6f 20 65 69 74 68 65 72 20  e set to either 
250a0 22 72 6f 22 2c 20 22 72 77 22 2c 0a 2a 2a 20 20  "ro", "rw",.**  
250b0 20 20 20 22 72 77 63 22 2c 20 6f 72 20 22 6d 65     "rwc", or "me
250c0 6d 6f 72 79 22 2e 20 41 74 74 65 6d 70 74 69 6e  mory". Attemptin
250d0 67 20 74 6f 20 73 65 74 20 69 74 20 74 6f 20 61  g to set it to a
250e0 6e 79 20 6f 74 68 65 72 20 76 61 6c 75 65 20 69  ny other value i
250f0 73 0a 2a 2a 20 20 20 20 20 61 6e 20 65 72 72 6f  s.**     an erro
25100 72 29 5e 2e 20 0a 2a 2a 20 20 20 20 20 5e 49 66  r)^. .**     ^If
25110 20 22 72 6f 22 20 69 73 20 73 70 65 63 69 66 69   "ro" is specifi
25120 65 64 2c 20 74 68 65 6e 20 74 68 65 20 64 61 74  ed, then the dat
25130 61 62 61 73 65 20 69 73 20 6f 70 65 6e 65 64 20  abase is opened 
25140 66 6f 72 20 72 65 61 64 2d 6f 6e 6c 79 20 0a 2a  for read-only .*
25150 2a 20 20 20 20 20 61 63 63 65 73 73 2c 20 6a 75  *     access, ju
25160 73 74 20 61 73 20 69 66 20 74 68 65 20 5b 53 51  st as if the [SQ
25170 4c 49 54 45 5f 4f 50 45 4e 5f 52 45 41 44 4f 4e  LITE_OPEN_READON
25180 4c 59 5d 20 66 6c 61 67 20 68 61 64 20 62 65 65  LY] flag had bee
25190 6e 20 73 65 74 20 69 6e 20 74 68 65 20 0a 2a 2a  n set in the .**
251a0 20 20 20 20 20 74 68 69 72 64 20 61 72 67 75 6d       third argum
251b0 65 6e 74 20 74 6f 20 73 71 6c 69 74 65 33 5f 6f  ent to sqlite3_o
251c0 70 65 6e 5f 76 32 28 29 2e 20 5e 49 66 20 74 68  pen_v2(). ^If th
251d0 65 20 6d 6f 64 65 20 6f 70 74 69 6f 6e 20 69 73  e mode option is
251e0 20 73 65 74 20 74 6f 20 0a 2a 2a 20 20 20 20 20   set to .**     
251f0 22 72 77 22 2c 20 74 68 65 6e 20 74 68 65 20 64  "rw", then the d
25200 61 74 61 62 61 73 65 20 69 73 20 6f 70 65 6e 65  atabase is opene
25210 64 20 66 6f 72 20 72 65 61 64 2d 77 72 69 74 65  d for read-write
25220 20 28 62 75 74 20 6e 6f 74 20 63 72 65 61 74 65   (but not create
25230 29 20 0a 2a 2a 20 20 20 20 20 61 63 63 65 73 73  ) .**     access
25240 2c 20 61 73 20 69 66 20 53 51 4c 49 54 45 5f 4f  , as if SQLITE_O
25250 50 45 4e 5f 52 45 41 44 57 52 49 54 45 20 28 62  PEN_READWRITE (b
25260 75 74 20 6e 6f 74 20 53 51 4c 49 54 45 5f 4f 50  ut not SQLITE_OP
25270 45 4e 5f 43 52 45 41 54 45 29 20 68 61 64 20 0a  EN_CREATE) had .
25280 2a 2a 20 20 20 20 20 62 65 65 6e 20 73 65 74 2e  **     been set.
25290 20 5e 56 61 6c 75 65 20 22 72 77 63 22 20 69 73   ^Value "rwc" is
252a0 20 65 71 75 69 76 61 6c 65 6e 74 20 74 6f 20 73   equivalent to s
252b0 65 74 74 69 6e 67 20 62 6f 74 68 20 0a 2a 2a 20  etting both .** 
252c0 20 20 20 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f      SQLITE_OPEN_
252d0 52 45 41 44 57 52 49 54 45 20 61 6e 64 20 53 51  READWRITE and SQ
252e0 4c 49 54 45 5f 4f 50 45 4e 5f 43 52 45 41 54 45  LITE_OPEN_CREATE
252f0 2e 20 20 5e 49 66 20 74 68 65 20 6d 6f 64 65 20  .  ^If the mode 
25300 6f 70 74 69 6f 6e 20 69 73 0a 2a 2a 20 20 20 20  option is.**    
25310 20 73 65 74 20 74 6f 20 22 6d 65 6d 6f 72 79 22   set to "memory"
25320 20 74 68 65 6e 20 61 20 70 75 72 65 20 5b 69 6e   then a pure [in
25330 2d 6d 65 6d 6f 72 79 20 64 61 74 61 62 61 73 65  -memory database
25340 5d 20 74 68 61 74 20 6e 65 76 65 72 20 72 65 61  ] that never rea
25350 64 73 0a 2a 2a 20 20 20 20 20 6f 72 20 77 72 69  ds.**     or wri
25360 74 65 73 20 66 72 6f 6d 20 64 69 73 6b 20 69 73  tes from disk is
25370 20 75 73 65 64 2e 20 5e 49 74 20 69 73 20 61 6e   used. ^It is an
25380 20 65 72 72 6f 72 20 74 6f 20 73 70 65 63 69 66   error to specif
25390 79 20 61 20 76 61 6c 75 65 20 66 6f 72 0a 2a 2a  y a value for.**
253a0 20 20 20 20 20 74 68 65 20 6d 6f 64 65 20 70 61       the mode pa
253b0 72 61 6d 65 74 65 72 20 74 68 61 74 20 69 73 20  rameter that is 
253c0 6c 65 73 73 20 72 65 73 74 72 69 63 74 69 76 65  less restrictive
253d0 20 74 68 61 6e 20 74 68 61 74 20 73 70 65 63 69   than that speci
253e0 66 69 65 64 20 62 79 0a 2a 2a 20 20 20 20 20 74  fied by.**     t
253f0 68 65 20 66 6c 61 67 73 20 70 61 73 73 65 64 20  he flags passed 
25400 69 6e 20 74 68 65 20 74 68 69 72 64 20 70 61 72  in the third par
25410 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65  ameter to sqlite
25420 33 5f 6f 70 65 6e 5f 76 32 28 29 2e 0a 2a 2a 0a  3_open_v2()..**.
25430 2a 2a 20 20 20 3c 6c 69 3e 20 3c 62 3e 63 61 63  **   <li> <b>cac
25440 68 65 3c 2f 62 3e 3a 20 5e 54 68 65 20 63 61 63  he</b>: ^The cac
25450 68 65 20 70 61 72 61 6d 65 74 65 72 20 6d 61 79  he parameter may
25460 20 62 65 20 73 65 74 20 74 6f 20 65 69 74 68 65   be set to eithe
25470 72 20 22 73 68 61 72 65 64 22 20 6f 72 0a 2a 2a  r "shared" or.**
25480 20 20 20 20 20 22 70 72 69 76 61 74 65 22 2e 20       "private". 
25490 5e 53 65 74 74 69 6e 67 20 69 74 20 74 6f 20 22  ^Setting it to "
254a0 73 68 61 72 65 64 22 20 69 73 20 65 71 75 69 76  shared" is equiv
254b0 61 6c 65 6e 74 20 74 6f 20 73 65 74 74 69 6e 67  alent to setting
254c0 20 74 68 65 0a 2a 2a 20 20 20 20 20 53 51 4c 49   the.**     SQLI
254d0 54 45 5f 4f 50 45 4e 5f 53 48 41 52 45 44 43 41  TE_OPEN_SHAREDCA
254e0 43 48 45 20 62 69 74 20 69 6e 20 74 68 65 20 66  CHE bit in the f
254f0 6c 61 67 73 20 61 72 67 75 6d 65 6e 74 20 70 61  lags argument pa
25500 73 73 65 64 20 74 6f 0a 2a 2a 20 20 20 20 20 73  ssed to.**     s
25510 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29  qlite3_open_v2()
25520 2e 20 5e 53 65 74 74 69 6e 67 20 74 68 65 20 63  . ^Setting the c
25530 61 63 68 65 20 70 61 72 61 6d 65 74 65 72 20 74  ache parameter t
25540 6f 20 22 70 72 69 76 61 74 65 22 20 69 73 20 0a  o "private" is .
25550 2a 2a 20 20 20 20 20 65 71 75 69 76 61 6c 65 6e  **     equivalen
25560 74 20 74 6f 20 73 65 74 74 69 6e 67 20 74 68 65  t to setting the
25570 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 50 52 49   SQLITE_OPEN_PRI
25580 56 41 54 45 43 41 43 48 45 20 62 69 74 2e 0a 2a  VATECACHE bit..*
25590 2a 20 20 20 20 20 5e 49 66 20 73 71 6c 69 74 65  *     ^If sqlite
255a0 33 5f 6f 70 65 6e 5f 76 32 28 29 20 69 73 20 75  3_open_v2() is u
255b0 73 65 64 20 61 6e 64 20 74 68 65 20 22 63 61 63  sed and the "cac
255c0 68 65 22 20 70 61 72 61 6d 65 74 65 72 20 69 73  he" parameter is
255d0 20 70 72 65 73 65 6e 74 20 69 6e 0a 2a 2a 20 20   present in.**  
255e0 20 20 20 61 20 55 52 49 20 66 69 6c 65 6e 61 6d     a URI filenam
255f0 65 2c 20 69 74 73 20 76 61 6c 75 65 20 6f 76 65  e, its value ove
25600 72 72 69 64 65 73 20 61 6e 79 20 62 65 68 61 76  rrides any behav
25610 69 6f 72 20 72 65 71 75 65 73 74 65 64 20 62 79  ior requested by
25620 20 73 65 74 74 69 6e 67 0a 2a 2a 20 20 20 20 20   setting.**     
25630 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 50 52 49 56  SQLITE_OPEN_PRIV
25640 41 54 45 43 41 43 48 45 20 6f 72 20 53 51 4c 49  ATECACHE or SQLI
25650 54 45 5f 4f 50 45 4e 5f 53 48 41 52 45 44 43 41  TE_OPEN_SHAREDCA
25660 43 48 45 20 66 6c 61 67 2e 0a 2a 2a 0a 2a 2a 20  CHE flag..**.** 
25670 20 3c 6c 69 3e 20 3c 62 3e 70 73 6f 77 3c 2f 62   <li> <b>psow</b
25680 3e 3a 20 5e 54 68 65 20 70 73 6f 77 20 70 61 72  >: ^The psow par
25690 61 6d 65 74 65 72 20 69 6e 64 69 63 61 74 65 73  ameter indicates
256a0 20 77 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20   whether or not 
256b0 74 68 65 0a 2a 2a 20 20 20 20 20 5b 70 6f 77 65  the.**     [powe
256c0 72 73 61 66 65 20 6f 76 65 72 77 72 69 74 65 5d  rsafe overwrite]
256d0 20 70 72 6f 70 65 72 74 79 20 64 6f 65 73 20 6f   property does o
256e0 72 20 64 6f 65 73 20 6e 6f 74 20 61 70 70 6c 79  r does not apply
256f0 20 74 6f 20 74 68 65 0a 2a 2a 20 20 20 20 20 73   to the.**     s
25700 74 6f 72 61 67 65 20 6d 65 64 69 61 20 6f 6e 20  torage media on 
25710 77 68 69 63 68 20 74 68 65 20 64 61 74 61 62 61  which the databa
25720 73 65 20 66 69 6c 65 20 72 65 73 69 64 65 73 2e  se file resides.
25730 0a 2a 2a 0a 2a 2a 20 20 3c 6c 69 3e 20 3c 62 3e  .**.**  <li> <b>
25740 6e 6f 6c 6f 63 6b 3c 2f 62 3e 3a 20 5e 54 68 65  nolock</b>: ^The
25750 20 6e 6f 6c 6f 63 6b 20 70 61 72 61 6d 65 74 65   nolock paramete
25760 72 20 69 73 20 61 20 62 6f 6f 6c 65 61 6e 20 71  r is a boolean q
25770 75 65 72 79 20 70 61 72 61 6d 65 74 65 72 0a 2a  uery parameter.*
25780 2a 20 20 20 20 20 77 68 69 63 68 20 69 66 20 73  *     which if s
25790 65 74 20 64 69 73 61 62 6c 65 73 20 66 69 6c 65  et disables file
257a0 20 6c 6f 63 6b 69 6e 67 20 69 6e 20 72 6f 6c 6c   locking in roll
257b0 62 61 63 6b 20 6a 6f 75 72 6e 61 6c 20 6d 6f 64  back journal mod
257c0 65 73 2e 20 20 54 68 69 73 0a 2a 2a 20 20 20 20  es.  This.**    
257d0 20 69 73 20 75 73 65 66 75 6c 20 66 6f 72 20 61   is useful for a
257e0 63 63 65 73 73 69 6e 67 20 61 20 64 61 74 61 62  ccessing a datab
257f0 61 73 65 20 6f 6e 20 61 20 66 69 6c 65 73 79 73  ase on a filesys
25800 74 65 6d 20 74 68 61 74 20 64 6f 65 73 20 6e 6f  tem that does no
25810 74 0a 2a 2a 20 20 20 20 20 73 75 70 70 6f 72 74  t.**     support
25820 20 6c 6f 63 6b 69 6e 67 2e 20 20 43 61 75 74 69   locking.  Cauti
25830 6f 6e 3a 20 20 44 61 74 61 62 61 73 65 20 63 6f  on:  Database co
25840 72 72 75 70 74 69 6f 6e 20 6d 69 67 68 74 20 72  rruption might r
25850 65 73 75 6c 74 20 69 66 20 74 77 6f 0a 2a 2a 20  esult if two.** 
25860 20 20 20 20 6f 72 20 6d 6f 72 65 20 70 72 6f 63      or more proc
25870 65 73 73 65 73 20 77 72 69 74 65 20 74 6f 20 74  esses write to t
25880 68 65 20 73 61 6d 65 20 64 61 74 61 62 61 73 65  he same database
25890 20 61 6e 64 20 61 6e 79 20 6f 6e 65 20 6f 66 20   and any one of 
258a0 74 68 6f 73 65 0a 2a 2a 20 20 20 20 20 70 72 6f  those.**     pro
258b0 63 65 73 73 65 73 20 75 73 65 73 20 6e 6f 6c 6f  cesses uses nolo
258c0 63 6b 3d 31 2e 0a 2a 2a 0a 2a 2a 20 20 3c 6c 69  ck=1..**.**  <li
258d0 3e 20 3c 62 3e 69 6d 6d 75 74 61 62 6c 65 3c 2f  > <b>immutable</
258e0 62 3e 3a 20 5e 54 68 65 20 69 6d 6d 75 74 61 62  b>: ^The immutab
258f0 6c 65 20 70 61 72 61 6d 65 74 65 72 20 69 73 20  le parameter is 
25900 61 20 62 6f 6f 6c 65 61 6e 20 71 75 65 72 79 0a  a boolean query.
25910 2a 2a 20 20 20 20 20 70 61 72 61 6d 65 74 65 72  **     parameter
25920 20 74 68 61 74 20 69 6e 64 69 63 61 74 65 73 20   that indicates 
25930 74 68 61 74 20 74 68 65 20 64 61 74 61 62 61 73  that the databas
25940 65 20 66 69 6c 65 20 69 73 20 73 74 6f 72 65 64  e file is stored
25950 20 6f 6e 0a 2a 2a 20 20 20 20 20 72 65 61 64 2d   on.**     read-
25960 6f 6e 6c 79 20 6d 65 64 69 61 2e 20 20 5e 57 68  only media.  ^Wh
25970 65 6e 20 69 6d 6d 75 74 61 62 6c 65 20 69 73 20  en immutable is 
25980 73 65 74 2c 20 53 51 4c 69 74 65 20 61 73 73 75  set, SQLite assu
25990 6d 65 73 20 74 68 61 74 20 74 68 65 0a 2a 2a 20  mes that the.** 
259a0 20 20 20 20 64 61 74 61 62 61 73 65 20 66 69 6c      database fil
259b0 65 20 63 61 6e 6e 6f 74 20 62 65 20 63 68 61 6e  e cannot be chan
259c0 67 65 64 2c 20 65 76 65 6e 20 62 79 20 61 20 70  ged, even by a p
259d0 72 6f 63 65 73 73 20 77 69 74 68 20 68 69 67 68  rocess with high
259e0 65 72 0a 2a 2a 20 20 20 20 20 70 72 69 76 69 6c  er.**     privil
259f0 65 67 65 2c 20 61 6e 64 20 73 6f 20 74 68 65 20  ege, and so the 
25a00 64 61 74 61 62 61 73 65 20 69 73 20 6f 70 65 6e  database is open
25a10 65 64 20 72 65 61 64 2d 6f 6e 6c 79 20 61 6e 64  ed read-only and
25a20 20 61 6c 6c 20 6c 6f 63 6b 69 6e 67 0a 2a 2a 20   all locking.** 
25a30 20 20 20 20 61 6e 64 20 63 68 61 6e 67 65 20 64      and change d
25a40 65 74 65 63 74 69 6f 6e 20 69 73 20 64 69 73 61  etection is disa
25a50 62 6c 65 64 2e 20 20 43 61 75 74 69 6f 6e 3a 20  bled.  Caution: 
25a60 53 65 74 74 69 6e 67 20 74 68 65 20 69 6d 6d 75  Setting the immu
25a70 74 61 62 6c 65 0a 2a 2a 20 20 20 20 20 70 72 6f  table.**     pro
25a80 70 65 72 74 79 20 6f 6e 20 61 20 64 61 74 61 62  perty on a datab
25a90 61 73 65 20 66 69 6c 65 20 74 68 61 74 20 64 6f  ase file that do
25aa0 65 73 20 69 6e 20 66 61 63 74 20 63 68 61 6e 67  es in fact chang
25ab0 65 20 63 61 6e 20 72 65 73 75 6c 74 0a 2a 2a 20  e can result.** 
25ac0 20 20 20 20 69 6e 20 69 6e 63 6f 72 72 65 63 74      in incorrect
25ad0 20 71 75 65 72 79 20 72 65 73 75 6c 74 73 20 61   query results a
25ae0 6e 64 2f 6f 72 20 5b 53 51 4c 49 54 45 5f 43 4f  nd/or [SQLITE_CO
25af0 52 52 55 50 54 5d 20 65 72 72 6f 72 73 2e 0a 2a  RRUPT] errors..*
25b00 2a 20 20 20 20 20 53 65 65 20 61 6c 73 6f 3a 20  *     See also: 
25b10 5b 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 49 4d  [SQLITE_IOCAP_IM
25b20 4d 55 54 41 42 4c 45 5d 2e 0a 2a 2a 20 20 20 20  MUTABLE]..**    
25b30 20 20 20 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 0a     .** </ul>.**.
25b40 2a 2a 20 5e 53 70 65 63 69 66 79 69 6e 67 20 61  ** ^Specifying a
25b50 6e 20 75 6e 6b 6e 6f 77 6e 20 70 61 72 61 6d 65  n unknown parame
25b60 74 65 72 20 69 6e 20 74 68 65 20 71 75 65 72 79  ter in the query
25b70 20 63 6f 6d 70 6f 6e 65 6e 74 20 6f 66 20 61 20   component of a 
25b80 55 52 49 20 69 73 20 6e 6f 74 20 61 6e 0a 2a 2a  URI is not an.**
25b90 20 65 72 72 6f 72 2e 20 20 46 75 74 75 72 65 20   error.  Future 
25ba0 76 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69  versions of SQLi
25bb0 74 65 20 6d 69 67 68 74 20 75 6e 64 65 72 73 74  te might underst
25bc0 61 6e 64 20 61 64 64 69 74 69 6f 6e 61 6c 20 71  and additional q
25bd0 75 65 72 79 0a 2a 2a 20 70 61 72 61 6d 65 74 65  uery.** paramete
25be0 72 73 2e 20 20 53 65 65 20 22 5b 71 75 65 72 79  rs.  See "[query
25bf0 20 70 61 72 61 6d 65 74 65 72 73 20 77 69 74 68   parameters with
25c00 20 73 70 65 63 69 61 6c 20 6d 65 61 6e 69 6e 67   special meaning
25c10 20 74 6f 20 53 51 4c 69 74 65 5d 22 20 66 6f 72   to SQLite]" for
25c20 0a 2a 2a 20 61 64 64 69 74 69 6f 6e 61 6c 20 69  .** additional i
25c30 6e 66 6f 72 6d 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a  nformation..**.*
25c40 2a 20 5b 5b 55 52 49 20 66 69 6c 65 6e 61 6d 65  * [[URI filename
25c50 20 65 78 61 6d 70 6c 65 73 5d 5d 20 3c 68 33 3e   examples]] <h3>
25c60 55 52 49 20 66 69 6c 65 6e 61 6d 65 20 65 78 61  URI filename exa
25c70 6d 70 6c 65 73 3c 2f 68 33 3e 0a 2a 2a 0a 2a 2a  mples</h3>.**.**
25c80 20 3c 74 61 62 6c 65 20 62 6f 72 64 65 72 3d 22   <table border="
25c90 31 22 20 61 6c 69 67 6e 3d 63 65 6e 74 65 72 20  1" align=center 
25ca0 63 65 6c 6c 70 61 64 64 69 6e 67 3d 35 3e 0a 2a  cellpadding=5>.*
25cb0 2a 20 3c 74 72 3e 3c 74 68 3e 20 55 52 49 20 66  * <tr><th> URI f
25cc0 69 6c 65 6e 61 6d 65 73 20 3c 74 68 3e 20 52 65  ilenames <th> Re
25cd0 73 75 6c 74 73 0a 2a 2a 20 3c 74 72 3e 3c 74 64  sults.** <tr><td
25ce0 3e 20 66 69 6c 65 3a 64 61 74 61 2e 64 62 20 3c  > file:data.db <
25cf0 74 64 3e 20 0a 2a 2a 20 20 20 20 20 20 20 20 20  td> .**         
25d00 20 4f 70 65 6e 20 74 68 65 20 66 69 6c 65 20 22   Open the file "
25d10 64 61 74 61 2e 64 62 22 20 69 6e 20 74 68 65 20  data.db" in the 
25d20 63 75 72 72 65 6e 74 20 64 69 72 65 63 74 6f 72  current director
25d30 79 2e 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 66  y..** <tr><td> f
25d40 69 6c 65 3a 2f 68 6f 6d 65 2f 66 72 65 64 2f 64  ile:/home/fred/d
25d50 61 74 61 2e 64 62 3c 62 72 3e 0a 2a 2a 20 20 20  ata.db<br>.**   
25d60 20 20 20 20 20 20 20 66 69 6c 65 3a 2f 2f 2f 68         file:///h
25d70 6f 6d 65 2f 66 72 65 64 2f 64 61 74 61 2e 64 62  ome/fred/data.db
25d80 20 3c 62 72 3e 20 0a 2a 2a 20 20 20 20 20 20 20   <br> .**       
25d90 20 20 20 66 69 6c 65 3a 2f 2f 6c 6f 63 61 6c 68     file://localh
25da0 6f 73 74 2f 68 6f 6d 65 2f 66 72 65 64 2f 64 61  ost/home/fred/da
25db0 74 61 2e 64 62 20 3c 62 72 3e 20 3c 74 64 3e 20  ta.db <br> <td> 
25dc0 0a 2a 2a 20 20 20 20 20 20 20 20 20 20 4f 70 65  .**          Ope
25dd0 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66  n the database f
25de0 69 6c 65 20 22 2f 68 6f 6d 65 2f 66 72 65 64 2f  ile "/home/fred/
25df0 64 61 74 61 2e 64 62 22 2e 0a 2a 2a 20 3c 74 72  data.db"..** <tr
25e00 3e 3c 74 64 3e 20 66 69 6c 65 3a 2f 2f 64 61 72  ><td> file://dar
25e10 6b 73 74 61 72 2f 68 6f 6d 65 2f 66 72 65 64 2f  kstar/home/fred/
25e20 64 61 74 61 2e 64 62 20 3c 74 64 3e 20 0a 2a 2a  data.db <td> .**
25e30 20 20 20 20 20 20 20 20 20 20 41 6e 20 65 72 72            An err
25e40 6f 72 2e 20 22 64 61 72 6b 73 74 61 72 22 20 69  or. "darkstar" i
25e50 73 20 6e 6f 74 20 61 20 72 65 63 6f 67 6e 69 7a  s not a recogniz
25e60 65 64 20 61 75 74 68 6f 72 69 74 79 2e 0a 2a 2a  ed authority..**
25e70 20 3c 74 72 3e 3c 74 64 20 73 74 79 6c 65 3d 22   <tr><td style="
25e80 77 68 69 74 65 2d 73 70 61 63 65 3a 6e 6f 77 72  white-space:nowr
25e90 61 70 22 3e 20 0a 2a 2a 20 20 20 20 20 20 20 20  ap"> .**        
25ea0 20 20 66 69 6c 65 3a 2f 2f 2f 43 3a 2f 44 6f 63    file:///C:/Doc
25eb0 75 6d 65 6e 74 73 25 32 30 61 6e 64 25 32 30 53  uments%20and%20S
25ec0 65 74 74 69 6e 67 73 2f 66 72 65 64 2f 44 65 73  ettings/fred/Des
25ed0 6b 74 6f 70 2f 64 61 74 61 2e 64 62 0a 2a 2a 20  ktop/data.db.** 
25ee0 20 20 20 20 3c 74 64 3e 20 57 69 6e 64 6f 77 73      <td> Windows
25ef0 20 6f 6e 6c 79 3a 20 4f 70 65 6e 20 74 68 65 20   only: Open the 
25f00 66 69 6c 65 20 22 64 61 74 61 2e 64 62 22 20 6f  file "data.db" o
25f10 6e 20 66 72 65 64 27 73 20 64 65 73 6b 74 6f 70  n fred's desktop
25f20 20 6f 6e 20 64 72 69 76 65 0a 2a 2a 20 20 20 20   on drive.**    
25f30 20 20 20 20 20 20 43 3a 2e 20 4e 6f 74 65 20 74        C:. Note t
25f40 68 61 74 20 74 68 65 20 25 32 30 20 65 73 63 61  hat the %20 esca
25f50 70 69 6e 67 20 69 6e 20 74 68 69 73 20 65 78 61  ping in this exa
25f60 6d 70 6c 65 20 69 73 20 6e 6f 74 20 73 74 72 69  mple is not stri
25f70 63 74 6c 79 20 0a 2a 2a 20 20 20 20 20 20 20 20  ctly .**        
25f80 20 20 6e 65 63 65 73 73 61 72 79 20 2d 20 73 70    necessary - sp
25f90 61 63 65 20 63 68 61 72 61 63 74 65 72 73 20 63  ace characters c
25fa0 61 6e 20 62 65 20 75 73 65 64 20 6c 69 74 65 72  an be used liter
25fb0 61 6c 6c 79 0a 2a 2a 20 20 20 20 20 20 20 20 20  ally.**         
25fc0 20 69 6e 20 55 52 49 20 66 69 6c 65 6e 61 6d 65   in URI filename
25fd0 73 2e 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 66  s..** <tr><td> f
25fe0 69 6c 65 3a 64 61 74 61 2e 64 62 3f 6d 6f 64 65  ile:data.db?mode
25ff0 3d 72 6f 26 63 61 63 68 65 3d 70 72 69 76 61 74  =ro&cache=privat
26000 65 20 3c 74 64 3e 20 0a 2a 2a 20 20 20 20 20 20  e <td> .**      
26010 20 20 20 20 4f 70 65 6e 20 66 69 6c 65 20 22 64      Open file "d
26020 61 74 61 2e 64 62 22 20 69 6e 20 74 68 65 20 63  ata.db" in the c
26030 75 72 72 65 6e 74 20 64 69 72 65 63 74 6f 72 79  urrent directory
26040 20 66 6f 72 20 72 65 61 64 2d 6f 6e 6c 79 20 61   for read-only a
26050 63 63 65 73 73 2e 0a 2a 2a 20 20 20 20 20 20 20  ccess..**       
26060 20 20 20 52 65 67 61 72 64 6c 65 73 73 20 6f 66     Regardless of
26070 20 77 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20   whether or not 
26080 73 68 61 72 65 64 2d 63 61 63 68 65 20 6d 6f 64  shared-cache mod
26090 65 20 69 73 20 65 6e 61 62 6c 65 64 20 62 79 0a  e is enabled by.
260a0 2a 2a 20 20 20 20 20 20 20 20 20 20 64 65 66 61  **          defa
260b0 75 6c 74 2c 20 75 73 65 20 61 20 70 72 69 76 61  ult, use a priva
260c0 74 65 20 63 61 63 68 65 2e 0a 2a 2a 20 3c 74 72  te cache..** <tr
260d0 3e 3c 74 64 3e 20 66 69 6c 65 3a 2f 68 6f 6d 65  ><td> file:/home
260e0 2f 66 72 65 64 2f 64 61 74 61 2e 64 62 3f 76 66  /fred/data.db?vf
260f0 73 3d 75 6e 69 78 2d 64 6f 74 66 69 6c 65 20 3c  s=unix-dotfile <
26100 74 64 3e 0a 2a 2a 20 20 20 20 20 20 20 20 20 20  td>.**          
26110 4f 70 65 6e 20 66 69 6c 65 20 22 2f 68 6f 6d 65  Open file "/home
26120 2f 66 72 65 64 2f 64 61 74 61 2e 64 62 22 2e 20  /fred/data.db". 
26130 55 73 65 20 74 68 65 20 73 70 65 63 69 61 6c 20  Use the special 
26140 56 46 53 20 22 75 6e 69 78 2d 64 6f 74 66 69 6c  VFS "unix-dotfil
26150 65 22 0a 2a 2a 20 20 20 20 20 20 20 20 20 20 74  e".**          t
26160 68 61 74 20 75 73 65 73 20 64 6f 74 2d 66 69 6c  hat uses dot-fil
26170 65 73 20 69 6e 20 70 6c 61 63 65 20 6f 66 20 70  es in place of p
26180 6f 73 69 78 20 61 64 76 69 73 6f 72 79 20 6c 6f  osix advisory lo
26190 63 6b 69 6e 67 2e 0a 2a 2a 20 3c 74 72 3e 3c 74  cking..** <tr><t
261a0 64 3e 20 66 69 6c 65 3a 64 61 74 61 2e 64 62 3f  d> file:data.db?
261b0 6d 6f 64 65 3d 72 65 61 64 6f 6e 6c 79 20 3c 74  mode=readonly <t
261c0 64 3e 20 0a 2a 2a 20 20 20 20 20 20 20 20 20 20  d> .**          
261d0 41 6e 20 65 72 72 6f 72 2e 20 22 72 65 61 64 6f  An error. "reado
261e0 6e 6c 79 22 20 69 73 20 6e 6f 74 20 61 20 76 61  nly" is not a va
261f0 6c 69 64 20 6f 70 74 69 6f 6e 20 66 6f 72 20 74  lid option for t
26200 68 65 20 22 6d 6f 64 65 22 20 70 61 72 61 6d 65  he "mode" parame
26210 74 65 72 2e 0a 2a 2a 20 3c 2f 74 61 62 6c 65 3e  ter..** </table>
26220 0a 2a 2a 0a 2a 2a 20 5e 55 52 49 20 68 65 78 61  .**.** ^URI hexa
26230 64 65 63 69 6d 61 6c 20 65 73 63 61 70 65 20 73  decimal escape s
26240 65 71 75 65 6e 63 65 73 20 28 25 48 48 29 20 61  equences (%HH) a
26250 72 65 20 73 75 70 70 6f 72 74 65 64 20 77 69 74  re supported wit
26260 68 69 6e 20 74 68 65 20 70 61 74 68 20 61 6e 64  hin the path and
26270 0a 2a 2a 20 71 75 65 72 79 20 63 6f 6d 70 6f 6e  .** query compon
26280 65 6e 74 73 20 6f 66 20 61 20 55 52 49 2e 20 41  ents of a URI. A
26290 20 68 65 78 61 64 65 63 69 6d 61 6c 20 65 73 63   hexadecimal esc
262a0 61 70 65 20 73 65 71 75 65 6e 63 65 20 63 6f 6e  ape sequence con
262b0 73 69 73 74 73 20 6f 66 20 61 0a 2a 2a 20 70 65  sists of a.** pe
262c0 72 63 65 6e 74 20 73 69 67 6e 20 2d 20 22 25 22  rcent sign - "%"
262d0 20 2d 20 66 6f 6c 6c 6f 77 65 64 20 62 79 20 65   - followed by e
262e0 78 61 63 74 6c 79 20 74 77 6f 20 68 65 78 61 64  xactly two hexad
262f0 65 63 69 6d 61 6c 20 64 69 67 69 74 73 20 0a 2a  ecimal digits .*
26300 2a 20 73 70 65 63 69 66 79 69 6e 67 20 61 6e 20  * specifying an 
26310 6f 63 74 65 74 20 76 61 6c 75 65 2e 20 5e 42 65  octet value. ^Be
26320 66 6f 72 65 20 74 68 65 20 70 61 74 68 20 6f 72  fore the path or
26330 20 71 75 65 72 79 20 63 6f 6d 70 6f 6e 65 6e 74   query component
26340 73 20 6f 66 20 61 0a 2a 2a 20 55 52 49 20 66 69  s of a.** URI fi
26350 6c 65 6e 61 6d 65 20 61 72 65 20 69 6e 74 65 72  lename are inter
26360 70 72 65 74 65 64 2c 20 74 68 65 79 20 61 72 65  preted, they are
26370 20 65 6e 63 6f 64 65 64 20 75 73 69 6e 67 20 55   encoded using U
26380 54 46 2d 38 20 61 6e 64 20 61 6c 6c 20 0a 2a 2a  TF-8 and all .**
26390 20 68 65 78 61 64 65 63 69 6d 61 6c 20 65 73 63   hexadecimal esc
263a0 61 70 65 20 73 65 71 75 65 6e 63 65 73 20 72 65  ape sequences re
263b0 70 6c 61 63 65 64 20 62 79 20 61 20 73 69 6e 67  placed by a sing
263c0 6c 65 20 62 79 74 65 20 63 6f 6e 74 61 69 6e 69  le byte containi
263d0 6e 67 20 74 68 65 0a 2a 2a 20 63 6f 72 72 65 73  ng the.** corres
263e0 70 6f 6e 64 69 6e 67 20 6f 63 74 65 74 2e 20 49  ponding octet. I
263f0 66 20 74 68 69 73 20 70 72 6f 63 65 73 73 20 67  f this process g
26400 65 6e 65 72 61 74 65 73 20 61 6e 20 69 6e 76 61  enerates an inva
26410 6c 69 64 20 55 54 46 2d 38 20 65 6e 63 6f 64 69  lid UTF-8 encodi
26420 6e 67 2c 0a 2a 2a 20 74 68 65 20 72 65 73 75 6c  ng,.** the resul
26430 74 73 20 61 72 65 20 75 6e 64 65 66 69 6e 65 64  ts are undefined
26440 2e 0a 2a 2a 0a 2a 2a 20 3c 62 3e 4e 6f 74 65 20  ..**.** <b>Note 
26450 74 6f 20 57 69 6e 64 6f 77 73 20 75 73 65 72 73  to Windows users
26460 3a 3c 2f 62 3e 20 20 54 68 65 20 65 6e 63 6f 64  :</b>  The encod
26470 69 6e 67 20 75 73 65 64 20 66 6f 72 20 74 68 65  ing used for the
26480 20 66 69 6c 65 6e 61 6d 65 20 61 72 67 75 6d 65   filename argume
26490 6e 74 0a 2a 2a 20 6f 66 20 73 71 6c 69 74 65 33  nt.** of sqlite3
264a0 5f 6f 70 65 6e 28 29 20 61 6e 64 20 73 71 6c 69  _open() and sqli
264b0 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 20 6d 75  te3_open_v2() mu
264c0 73 74 20 62 65 20 55 54 46 2d 38 2c 20 6e 6f 74  st be UTF-8, not
264d0 20 77 68 61 74 65 76 65 72 0a 2a 2a 20 63 6f 64   whatever.** cod
264e0 65 70 61 67 65 20 69 73 20 63 75 72 72 65 6e 74  epage is current
264f0 6c 79 20 64 65 66 69 6e 65 64 2e 20 20 46 69 6c  ly defined.  Fil
26500 65 6e 61 6d 65 73 20 63 6f 6e 74 61 69 6e 69 6e  enames containin
26510 67 20 69 6e 74 65 72 6e 61 74 69 6f 6e 61 6c 0a  g international.
26520 2a 2a 20 63 68 61 72 61 63 74 65 72 73 20 6d 75  ** characters mu
26530 73 74 20 62 65 20 63 6f 6e 76 65 72 74 65 64 20  st be converted 
26540 74 6f 20 55 54 46 2d 38 20 70 72 69 6f 72 20 74  to UTF-8 prior t
26550 6f 20 70 61 73 73 69 6e 67 20 74 68 65 6d 20 69  o passing them i
26560 6e 74 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 6f  nto.** sqlite3_o
26570 70 65 6e 28 29 20 6f 72 20 73 71 6c 69 74 65 33  pen() or sqlite3
26580 5f 6f 70 65 6e 5f 76 32 28 29 2e 0a 2a 2a 0a 2a  _open_v2()..**.*
26590 2a 20 3c 62 3e 4e 6f 74 65 20 74 6f 20 57 69 6e  * <b>Note to Win
265a0 64 6f 77 73 20 52 75 6e 74 69 6d 65 20 75 73 65  dows Runtime use
265b0 72 73 3a 3c 2f 62 3e 20 20 54 68 65 20 74 65 6d  rs:</b>  The tem
265c0 70 6f 72 61 72 79 20 64 69 72 65 63 74 6f 72 79  porary directory
265d0 20 6d 75 73 74 20 62 65 20 73 65 74 0a 2a 2a 20   must be set.** 
265e0 70 72 69 6f 72 20 74 6f 20 63 61 6c 6c 69 6e 67  prior to calling
265f0 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 20   sqlite3_open() 
26600 6f 72 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f  or sqlite3_open_
26610 76 32 28 29 2e 20 20 4f 74 68 65 72 77 69 73 65  v2().  Otherwise
26620 2c 20 76 61 72 69 6f 75 73 0a 2a 2a 20 66 65 61  , various.** fea
26630 74 75 72 65 73 20 74 68 61 74 20 72 65 71 75 69  tures that requi
26640 72 65 20 74 68 65 20 75 73 65 20 6f 66 20 74 65  re the use of te
26650 6d 70 6f 72 61 72 79 20 66 69 6c 65 73 20 6d 61  mporary files ma
26660 79 20 66 61 69 6c 2e 0a 2a 2a 0a 2a 2a 20 53 65  y fail..**.** Se
26670 65 20 61 6c 73 6f 3a 20 5b 73 71 6c 69 74 65 33  e also: [sqlite3
26680 5f 74 65 6d 70 5f 64 69 72 65 63 74 6f 72 79 5d  _temp_directory]
26690 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .*/.int sqlite3_
266a0 6f 70 65 6e 28 0a 20 20 63 6f 6e 73 74 20 63 68  open(.  const ch
266b0 61 72 20 2a 66 69 6c 65 6e 61 6d 65 2c 20 20 20  ar *filename,   
266c0 2f 2a 20 44 61 74 61 62 61 73 65 20 66 69 6c 65  /* Database file
266d0 6e 61 6d 65 20 28 55 54 46 2d 38 29 20 2a 2f 0a  name (UTF-8) */.
266e0 20 20 73 71 6c 69 74 65 33 20 2a 2a 70 70 44 62    sqlite3 **ppDb
266f0 20 20 20 20 20 20 20 20 20 20 2f 2a 20 4f 55 54            /* OUT
26700 3a 20 53 51 4c 69 74 65 20 64 62 20 68 61 6e 64  : SQLite db hand
26710 6c 65 20 2a 2f 0a 29 3b 0a 69 6e 74 20 73 71 6c  le */.);.int sql
26720 69 74 65 33 5f 6f 70 65 6e 31 36 28 0a 20 20 63  ite3_open16(.  c
26730 6f 6e 73 74 20 76 6f 69 64 20 2a 66 69 6c 65 6e  onst void *filen
26740 61 6d 65 2c 20 20 20 2f 2a 20 44 61 74 61 62 61  ame,   /* Databa
26750 73 65 20 66 69 6c 65 6e 61 6d 65 20 28 55 54 46  se filename (UTF
26760 2d 31 36 29 20 2a 2f 0a 20 20 73 71 6c 69 74 65  -16) */.  sqlite
26770 33 20 2a 2a 70 70 44 62 20 20 20 20 20 20 20 20  3 **ppDb        
26780 20 20 2f 2a 20 4f 55 54 3a 20 53 51 4c 69 74 65    /* OUT: SQLite
26790 20 64 62 20 68 61 6e 64 6c 65 20 2a 2f 0a 29 3b   db handle */.);
267a0 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 6f 70 65  .int sqlite3_ope
267b0 6e 5f 76 32 28 0a 20 20 63 6f 6e 73 74 20 63 68  n_v2(.  const ch
267c0 61 72 20 2a 66 69 6c 65 6e 61 6d 65 2c 20 20 20  ar *filename,   
267d0 2f 2a 20 44 61 74 61 62 61 73 65 20 66 69 6c 65  /* Database file
267e0 6e 61 6d 65 20 28 55 54 46 2d 38 29 20 2a 2f 0a  name (UTF-8) */.
267f0 20 20 73 71 6c 69 74 65 33 20 2a 2a 70 70 44 62    sqlite3 **ppDb
26800 2c 20 20 20 20 20 20 20 20 20 2f 2a 20 4f 55 54  ,         /* OUT
26810 3a 20 53 51 4c 69 74 65 20 64 62 20 68 61 6e 64  : SQLite db hand
26820 6c 65 20 2a 2f 0a 20 20 69 6e 74 20 66 6c 61 67  le */.  int flag
26830 73 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20  s,              
26840 2f 2a 20 46 6c 61 67 73 20 2a 2f 0a 20 20 63 6f  /* Flags */.  co
26850 6e 73 74 20 63 68 61 72 20 2a 7a 56 66 73 20 20  nst char *zVfs  
26860 20 20 20 20 20 20 2f 2a 20 4e 61 6d 65 20 6f 66        /* Name of
26870 20 56 46 53 20 6d 6f 64 75 6c 65 20 74 6f 20 75   VFS module to u
26880 73 65 20 2a 2f 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20  se */.);../*.** 
26890 43 41 50 49 33 52 45 46 3a 20 4f 62 74 61 69 6e  CAPI3REF: Obtain
268a0 20 56 61 6c 75 65 73 20 46 6f 72 20 55 52 49 20   Values For URI 
268b0 50 61 72 61 6d 65 74 65 72 73 0a 2a 2a 0a 2a 2a  Parameters.**.**
268c0 20 54 68 65 73 65 20 61 72 65 20 75 74 69 6c 69   These are utili
268d0 74 79 20 72 6f 75 74 69 6e 65 73 2c 20 75 73 65  ty routines, use
268e0 66 75 6c 20 74 6f 20 56 46 53 20 69 6d 70 6c 65  ful to VFS imple
268f0 6d 65 6e 74 61 74 69 6f 6e 73 2c 20 74 68 61 74  mentations, that
26900 20 63 68 65 63 6b 0a 2a 2a 20 74 6f 20 73 65 65   check.** to see
26910 20 69 66 20 61 20 64 61 74 61 62 61 73 65 20 66   if a database f
26920 69 6c 65 20 77 61 73 20 61 20 55 52 49 20 74 68  ile was a URI th
26930 61 74 20 63 6f 6e 74 61 69 6e 65 64 20 61 20 73  at contained a s
26940 70 65 63 69 66 69 63 20 71 75 65 72 79 20 0a 2a  pecific query .*
26950 2a 20 70 61 72 61 6d 65 74 65 72 2c 20 61 6e 64  * parameter, and
26960 20 69 66 20 73 6f 20 6f 62 74 61 69 6e 73 20 74   if so obtains t
26970 68 65 20 76 61 6c 75 65 20 6f 66 20 74 68 61 74  he value of that
26980 20 71 75 65 72 79 20 70 61 72 61 6d 65 74 65 72   query parameter
26990 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 46 20 69 73 20  ..**.** If F is 
269a0 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c  the database fil
269b0 65 6e 61 6d 65 20 70 6f 69 6e 74 65 72 20 70 61  ename pointer pa
269c0 73 73 65 64 20 69 6e 74 6f 20 74 68 65 20 78 4f  ssed into the xO
269d0 70 65 6e 28 29 20 6d 65 74 68 6f 64 20 6f 66 20  pen() method of 
269e0 0a 2a 2a 20 61 20 56 46 53 20 69 6d 70 6c 65 6d  .** a VFS implem
269f0 65 6e 74 61 74 69 6f 6e 20 77 68 65 6e 20 74 68  entation when th
26a00 65 20 66 6c 61 67 73 20 70 61 72 61 6d 65 74 65  e flags paramete
26a10 72 20 74 6f 20 78 4f 70 65 6e 28 29 20 68 61 73  r to xOpen() has
26a20 20 6f 6e 65 20 6f 72 20 0a 2a 2a 20 6d 6f 72 65   one or .** more
26a30 20 6f 66 20 74 68 65 20 5b 53 51 4c 49 54 45 5f   of the [SQLITE_
26a40 4f 50 45 4e 5f 55 52 49 5d 20 6f 72 20 5b 53 51  OPEN_URI] or [SQ
26a50 4c 49 54 45 5f 4f 50 45 4e 5f 4d 41 49 4e 5f 44  LITE_OPEN_MAIN_D
26a60 42 5d 20 62 69 74 73 20 73 65 74 20 61 6e 64 0a  B] bits set and.
26a70 2a 2a 20 50 20 69 73 20 74 68 65 20 6e 61 6d 65  ** P is the name
26a80 20 6f 66 20 74 68 65 20 71 75 65 72 79 20 70 61   of the query pa
26a90 72 61 6d 65 74 65 72 2c 20 74 68 65 6e 0a 2a 2a  rameter, then.**
26aa0 20 73 71 6c 69 74 65 33 5f 75 72 69 5f 70 61 72   sqlite3_uri_par
26ab0 61 6d 65 74 65 72 28 46 2c 50 29 20 72 65 74 75  ameter(F,P) retu
26ac0 72 6e 73 20 74 68 65 20 76 61 6c 75 65 20 6f 66  rns the value of
26ad0 20 74 68 65 20 50 0a 2a 2a 20 70 61 72 61 6d 65   the P.** parame
26ae0 74 65 72 20 69 66 20 69 74 20 65 78 69 73 74 73  ter if it exists
26af0 20 6f 72 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74   or a NULL point
26b00 65 72 20 69 66 20 50 20 64 6f 65 73 20 6e 6f 74  er if P does not
26b10 20 61 70 70 65 61 72 20 61 73 20 61 20 0a 2a 2a   appear as a .**
26b20 20 71 75 65 72 79 20 70 61 72 61 6d 65 74 65 72   query parameter
26b30 20 6f 6e 20 46 2e 20 20 49 66 20 50 20 69 73 20   on F.  If P is 
26b40 61 20 71 75 65 72 79 20 70 61 72 61 6d 65 74 65  a query paramete
26b50 72 20 6f 66 20 46 0a 2a 2a 20 68 61 73 20 6e 6f  r of F.** has no
26b60 20 65 78 70 6c 69 63 69 74 20 76 61 6c 75 65 2c   explicit value,
26b70 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f 75 72   then sqlite3_ur
26b80 69 5f 70 61 72 61 6d 65 74 65 72 28 46 2c 50 29  i_parameter(F,P)
26b90 20 72 65 74 75 72 6e 73 0a 2a 2a 20 61 20 70 6f   returns.** a po
26ba0 69 6e 74 65 72 20 74 6f 20 61 6e 20 65 6d 70 74  inter to an empt
26bb0 79 20 73 74 72 69 6e 67 2e 0a 2a 2a 0a 2a 2a 20  y string..**.** 
26bc0 54 68 65 20 73 71 6c 69 74 65 33 5f 75 72 69 5f  The sqlite3_uri_
26bd0 62 6f 6f 6c 65 61 6e 28 46 2c 50 2c 42 29 20 72  boolean(F,P,B) r
26be0 6f 75 74 69 6e 65 20 61 73 73 75 6d 65 73 20 74  outine assumes t
26bf0 68 61 74 20 50 20 69 73 20 61 20 62 6f 6f 6c 65  hat P is a boole
26c00 61 6e 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72 20  an.** parameter 
26c10 61 6e 64 20 72 65 74 75 72 6e 73 20 74 72 75 65  and returns true
26c20 20 28 31 29 20 6f 72 20 66 61 6c 73 65 20 28 30   (1) or false (0
26c30 29 20 61 63 63 6f 72 64 69 6e 67 20 74 6f 20 74  ) according to t
26c40 68 65 20 76 61 6c 75 65 0a 2a 2a 20 6f 66 20 50  he value.** of P
26c50 2e 20 20 54 68 65 20 73 71 6c 69 74 65 33 5f 75  .  The sqlite3_u
26c60 72 69 5f 62 6f 6f 6c 65 61 6e 28 46 2c 50 2c 42  ri_boolean(F,P,B
26c70 29 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e  ) routine return
26c80 73 20 74 72 75 65 20 28 31 29 20 69 66 20 74 68  s true (1) if th
26c90 65 0a 2a 2a 20 76 61 6c 75 65 20 6f 66 20 71 75  e.** value of qu
26ca0 65 72 79 20 70 61 72 61 6d 65 74 65 72 20 50 20  ery parameter P 
26cb0 69 73 20 6f 6e 65 20 6f 66 20 22 79 65 73 22 2c  is one of "yes",
26cc0 20 22 74 72 75 65 22 2c 20 6f 72 20 22 6f 6e 22   "true", or "on"
26cd0 20 69 6e 20 61 6e 79 0a 2a 2a 20 63 61 73 65 20   in any.** case 
26ce0 6f 72 20 69 66 20 74 68 65 20 76 61 6c 75 65 20  or if the value 
26cf0 62 65 67 69 6e 73 20 77 69 74 68 20 61 20 6e 6f  begins with a no
26d00 6e 2d 7a 65 72 6f 20 6e 75 6d 62 65 72 2e 20 20  n-zero number.  
26d10 54 68 65 20 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  The .** sqlite3_
26d20 75 72 69 5f 62 6f 6f 6c 65 61 6e 28 46 2c 50 2c  uri_boolean(F,P,
26d30 42 29 20 72 6f 75 74 69 6e 65 73 20 72 65 74 75  B) routines retu
26d40 72 6e 73 20 66 61 6c 73 65 20 28 30 29 20 69 66  rns false (0) if
26d50 20 74 68 65 20 76 61 6c 75 65 20 6f 66 0a 2a 2a   the value of.**
26d60 20 71 75 65 72 79 20 70 61 72 61 6d 65 74 65 72   query parameter
26d70 20 50 20 69 73 20 6f 6e 65 20 6f 66 20 22 6e 6f   P is one of "no
26d80 22 2c 20 22 66 61 6c 73 65 22 2c 20 6f 72 20 22  ", "false", or "
26d90 6f 66 66 22 20 69 6e 20 61 6e 79 20 63 61 73 65  off" in any case
26da0 20 6f 72 0a 2a 2a 20 69 66 20 74 68 65 20 76 61   or.** if the va
26db0 6c 75 65 20 62 65 67 69 6e 73 20 77 69 74 68 20  lue begins with 
26dc0 61 20 6e 75 6d 65 72 69 63 20 7a 65 72 6f 2e 20  a numeric zero. 
26dd0 20 49 66 20 50 20 69 73 20 6e 6f 74 20 61 20 71   If P is not a q
26de0 75 65 72 79 0a 2a 2a 20 70 61 72 61 6d 65 74 65  uery.** paramete
26df0 72 20 6f 6e 20 46 20 6f 72 20 69 66 20 74 68 65  r on F or if the
26e00 20 76 61 6c 75 65 20 6f 66 20 50 20 69 73 20 64   value of P is d
26e10 6f 65 73 20 6e 6f 74 20 6d 61 74 63 68 20 61 6e  oes not match an
26e20 79 20 6f 66 20 74 68 65 0a 2a 2a 20 61 62 6f 76  y of the.** abov
26e30 65 2c 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f  e, then sqlite3_
26e40 75 72 69 5f 62 6f 6f 6c 65 61 6e 28 46 2c 50 2c  uri_boolean(F,P,
26e50 42 29 20 72 65 74 75 72 6e 73 20 28 42 21 3d 30  B) returns (B!=0
26e60 29 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c  )..**.** The sql
26e70 69 74 65 33 5f 75 72 69 5f 69 6e 74 36 34 28 46  ite3_uri_int64(F
26e80 2c 50 2c 44 29 20 72 6f 75 74 69 6e 65 20 63 6f  ,P,D) routine co
26e90 6e 76 65 72 74 73 20 74 68 65 20 76 61 6c 75 65  nverts the value
26ea0 20 6f 66 20 50 20 69 6e 74 6f 20 61 0a 2a 2a 20   of P into a.** 
26eb0 36 34 2d 62 69 74 20 73 69 67 6e 65 64 20 69 6e  64-bit signed in
26ec0 74 65 67 65 72 20 61 6e 64 20 72 65 74 75 72 6e  teger and return
26ed0 73 20 74 68 61 74 20 69 6e 74 65 67 65 72 2c 20  s that integer, 
26ee0 6f 72 20 44 20 69 66 20 50 20 64 6f 65 73 20 6e  or D if P does n
26ef0 6f 74 0a 2a 2a 20 65 78 69 73 74 2e 20 20 49 66  ot.** exist.  If
26f00 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20 50 20   the value of P 
26f10 69 73 20 73 6f 6d 65 74 68 69 6e 67 20 6f 74 68  is something oth
26f20 65 72 20 74 68 61 6e 20 61 6e 20 69 6e 74 65 67  er than an integ
26f30 65 72 2c 20 74 68 65 6e 0a 2a 2a 20 7a 65 72 6f  er, then.** zero
26f40 20 69 73 20 72 65 74 75 72 6e 65 64 2e 0a 2a 2a   is returned..**
26f50 20 0a 2a 2a 20 49 66 20 46 20 69 73 20 61 20 4e   .** If F is a N
26f60 55 4c 4c 20 70 6f 69 6e 74 65 72 2c 20 74 68 65  ULL pointer, the
26f70 6e 20 73 71 6c 69 74 65 33 5f 75 72 69 5f 70 61  n sqlite3_uri_pa
26f80 72 61 6d 65 74 65 72 28 46 2c 50 29 20 72 65 74  rameter(F,P) ret
26f90 75 72 6e 73 20 4e 55 4c 4c 20 61 6e 64 0a 2a 2a  urns NULL and.**
26fa0 20 73 71 6c 69 74 65 33 5f 75 72 69 5f 62 6f 6f   sqlite3_uri_boo
26fb0 6c 65 61 6e 28 46 2c 50 2c 42 29 20 72 65 74 75  lean(F,P,B) retu
26fc0 72 6e 73 20 42 2e 20 20 49 66 20 46 20 69 73 20  rns B.  If F is 
26fd0 6e 6f 74 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74  not a NULL point
26fe0 65 72 20 61 6e 64 0a 2a 2a 20 69 73 20 6e 6f 74  er and.** is not
26ff0 20 61 20 64 61 74 61 62 61 73 65 20 66 69 6c 65   a database file
27000 20 70 61 74 68 6e 61 6d 65 20 70 6f 69 6e 74 65   pathname pointe
27010 72 20 74 68 61 74 20 53 51 4c 69 74 65 20 70 61  r that SQLite pa
27020 73 73 65 64 20 69 6e 74 6f 20 74 68 65 20 78 4f  ssed into the xO
27030 70 65 6e 0a 2a 2a 20 56 46 53 20 6d 65 74 68 6f  pen.** VFS metho
27040 64 2c 20 74 68 65 6e 20 74 68 65 20 62 65 68 61  d, then the beha
27050 76 69 6f 72 20 6f 66 20 74 68 69 73 20 72 6f 75  vior of this rou
27060 74 69 6e 65 20 69 73 20 75 6e 64 65 66 69 6e 65  tine is undefine
27070 64 20 61 6e 64 20 70 72 6f 62 61 62 6c 79 0a 2a  d and probably.*
27080 2a 20 75 6e 64 65 73 69 72 61 62 6c 65 2e 0a 2a  * undesirable..*
27090 2f 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 71  /.const char *sq
270a0 6c 69 74 65 33 5f 75 72 69 5f 70 61 72 61 6d 65  lite3_uri_parame
270b0 74 65 72 28 63 6f 6e 73 74 20 63 68 61 72 20 2a  ter(const char *
270c0 7a 46 69 6c 65 6e 61 6d 65 2c 20 63 6f 6e 73 74  zFilename, const
270d0 20 63 68 61 72 20 2a 7a 50 61 72 61 6d 29 3b 0a   char *zParam);.
270e0 69 6e 74 20 73 71 6c 69 74 65 33 5f 75 72 69 5f  int sqlite3_uri_
270f0 62 6f 6f 6c 65 61 6e 28 63 6f 6e 73 74 20 63 68  boolean(const ch
27100 61 72 20 2a 7a 46 69 6c 65 2c 20 63 6f 6e 73 74  ar *zFile, const
27110 20 63 68 61 72 20 2a 7a 50 61 72 61 6d 2c 20 69   char *zParam, i
27120 6e 74 20 62 44 65 66 61 75 6c 74 29 3b 0a 73 71  nt bDefault);.sq
27130 6c 69 74 65 33 5f 69 6e 74 36 34 20 73 71 6c 69  lite3_int64 sqli
27140 74 65 33 5f 75 72 69 5f 69 6e 74 36 34 28 63 6f  te3_uri_int64(co
27150 6e 73 74 20 63 68 61 72 2a 2c 20 63 6f 6e 73 74  nst char*, const
27160 20 63 68 61 72 2a 2c 20 73 71 6c 69 74 65 33 5f   char*, sqlite3_
27170 69 6e 74 36 34 29 3b 0a 0a 0a 2f 2a 0a 2a 2a 20  int64);.../*.** 
27180 43 41 50 49 33 52 45 46 3a 20 45 72 72 6f 72 20  CAPI3REF: Error 
27190 43 6f 64 65 73 20 41 6e 64 20 4d 65 73 73 61 67  Codes And Messag
271a0 65 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  es.** METHOD: sq
271b0 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 49 66 20  lite3.**.** ^If 
271c0 74 68 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 20  the most recent 
271d0 73 71 6c 69 74 65 33 5f 2a 20 41 50 49 20 63 61  sqlite3_* API ca
271e0 6c 6c 20 61 73 73 6f 63 69 61 74 65 64 20 77 69  ll associated wi
271f0 74 68 20 0a 2a 2a 20 5b 64 61 74 61 62 61 73 65  th .** [database
27200 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 44 20 66   connection] D f
27210 61 69 6c 65 64 2c 20 74 68 65 6e 20 74 68 65 20  ailed, then the 
27220 73 71 6c 69 74 65 33 5f 65 72 72 63 6f 64 65 28  sqlite3_errcode(
27230 44 29 20 69 6e 74 65 72 66 61 63 65 0a 2a 2a 20  D) interface.** 
27240 72 65 74 75 72 6e 73 20 74 68 65 20 6e 75 6d 65  returns the nume
27250 72 69 63 20 5b 72 65 73 75 6c 74 20 63 6f 64 65  ric [result code
27260 5d 20 6f 72 20 5b 65 78 74 65 6e 64 65 64 20 72  ] or [extended r
27270 65 73 75 6c 74 20 63 6f 64 65 5d 20 66 6f 72 20  esult code] for 
27280 74 68 61 74 0a 2a 2a 20 41 50 49 20 63 61 6c 6c  that.** API call
27290 2e 0a 2a 2a 20 49 66 20 74 68 65 20 6d 6f 73 74  ..** If the most
272a0 20 72 65 63 65 6e 74 20 41 50 49 20 63 61 6c 6c   recent API call
272b0 20 77 61 73 20 73 75 63 63 65 73 73 66 75 6c 2c   was successful,
272c0 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20 72 65 74  .** then the ret
272d0 75 72 6e 20 76 61 6c 75 65 20 66 72 6f 6d 20 73  urn value from s
272e0 71 6c 69 74 65 33 5f 65 72 72 63 6f 64 65 28 29  qlite3_errcode()
272f0 20 69 73 20 75 6e 64 65 66 69 6e 65 64 2e 0a 2a   is undefined..*
27300 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 65  * ^The sqlite3_e
27310 78 74 65 6e 64 65 64 5f 65 72 72 63 6f 64 65 28  xtended_errcode(
27320 29 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 69  ).** interface i
27330 73 20 74 68 65 20 73 61 6d 65 20 65 78 63 65 70  s the same excep
27340 74 20 74 68 61 74 20 69 74 20 61 6c 77 61 79 73  t that it always
27350 20 72 65 74 75 72 6e 73 20 74 68 65 20 0a 2a 2a   returns the .**
27360 20 5b 65 78 74 65 6e 64 65 64 20 72 65 73 75 6c   [extended resul
27370 74 20 63 6f 64 65 5d 20 65 76 65 6e 20 77 68 65  t code] even whe
27380 6e 20 65 78 74 65 6e 64 65 64 20 72 65 73 75 6c  n extended resul
27390 74 20 63 6f 64 65 73 20 61 72 65 0a 2a 2a 20 64  t codes are.** d
273a0 69 73 61 62 6c 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e  isabled..**.** ^
273b0 54 68 65 20 73 71 6c 69 74 65 33 5f 65 72 72 6d  The sqlite3_errm
273c0 73 67 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33  sg() and sqlite3
273d0 5f 65 72 72 6d 73 67 31 36 28 29 20 72 65 74 75  _errmsg16() retu
273e0 72 6e 20 45 6e 67 6c 69 73 68 2d 6c 61 6e 67 75  rn English-langu
273f0 61 67 65 0a 2a 2a 20 74 65 78 74 20 74 68 61 74  age.** text that
27400 20 64 65 73 63 72 69 62 65 73 20 74 68 65 20 65   describes the e
27410 72 72 6f 72 2c 20 61 73 20 65 69 74 68 65 72 20  rror, as either 
27420 55 54 46 2d 38 20 6f 72 20 55 54 46 2d 31 36 20  UTF-8 or UTF-16 
27430 72 65 73 70 65 63 74 69 76 65 6c 79 2e 0a 2a 2a  respectively..**
27440 20 5e 28 4d 65 6d 6f 72 79 20 74 6f 20 68 6f 6c   ^(Memory to hol
27450 64 20 74 68 65 20 65 72 72 6f 72 20 6d 65 73 73  d the error mess
27460 61 67 65 20 73 74 72 69 6e 67 20 69 73 20 6d 61  age string is ma
27470 6e 61 67 65 64 20 69 6e 74 65 72 6e 61 6c 6c 79  naged internally
27480 2e 0a 2a 2a 20 54 68 65 20 61 70 70 6c 69 63 61  ..** The applica
27490 74 69 6f 6e 20 64 6f 65 73 20 6e 6f 74 20 6e 65  tion does not ne
274a0 65 64 20 74 6f 20 77 6f 72 72 79 20 61 62 6f 75  ed to worry abou
274b0 74 20 66 72 65 65 69 6e 67 20 74 68 65 20 72 65  t freeing the re
274c0 73 75 6c 74 2e 0a 2a 2a 20 48 6f 77 65 76 65 72  sult..** However
274d0 2c 20 74 68 65 20 65 72 72 6f 72 20 73 74 72 69  , the error stri
274e0 6e 67 20 6d 69 67 68 74 20 62 65 20 6f 76 65 72  ng might be over
274f0 77 72 69 74 74 65 6e 20 6f 72 20 64 65 61 6c 6c  written or deall
27500 6f 63 61 74 65 64 20 62 79 0a 2a 2a 20 73 75 62  ocated by.** sub
27510 73 65 71 75 65 6e 74 20 63 61 6c 6c 73 20 74 6f  sequent calls to
27520 20 6f 74 68 65 72 20 53 51 4c 69 74 65 20 69 6e   other SQLite in
27530 74 65 72 66 61 63 65 20 66 75 6e 63 74 69 6f 6e  terface function
27540 73 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  s.)^.**.** ^The 
27550 73 71 6c 69 74 65 33 5f 65 72 72 73 74 72 28 29  sqlite3_errstr()
27560 20 69 6e 74 65 72 66 61 63 65 20 72 65 74 75 72   interface retur
27570 6e 73 20 74 68 65 20 45 6e 67 6c 69 73 68 2d 6c  ns the English-l
27580 61 6e 67 75 61 67 65 20 74 65 78 74 0a 2a 2a 20  anguage text.** 
27590 74 68 61 74 20 64 65 73 63 72 69 62 65 73 20 74  that describes t
275a0 68 65 20 5b 72 65 73 75 6c 74 20 63 6f 64 65 5d  he [result code]
275b0 2c 20 61 73 20 55 54 46 2d 38 2e 0a 2a 2a 20 5e  , as UTF-8..** ^
275c0 28 4d 65 6d 6f 72 79 20 74 6f 20 68 6f 6c 64 20  (Memory to hold 
275d0 74 68 65 20 65 72 72 6f 72 20 6d 65 73 73 61 67  the error messag
275e0 65 20 73 74 72 69 6e 67 20 69 73 20 6d 61 6e 61  e string is mana
275f0 67 65 64 20 69 6e 74 65 72 6e 61 6c 6c 79 0a 2a  ged internally.*
27600 2a 20 61 6e 64 20 6d 75 73 74 20 6e 6f 74 20 62  * and must not b
27610 65 20 66 72 65 65 64 20 62 79 20 74 68 65 20 61  e freed by the a
27620 70 70 6c 69 63 61 74 69 6f 6e 29 5e 2e 0a 2a 2a  pplication)^..**
27630 0a 2a 2a 20 57 68 65 6e 20 74 68 65 20 73 65 72  .** When the ser
27640 69 61 6c 69 7a 65 64 20 5b 74 68 72 65 61 64 69  ialized [threadi
27650 6e 67 20 6d 6f 64 65 5d 20 69 73 20 69 6e 20 75  ng mode] is in u
27660 73 65 2c 20 69 74 20 6d 69 67 68 74 20 62 65 20  se, it might be 
27670 74 68 65 0a 2a 2a 20 63 61 73 65 20 74 68 61 74  the.** case that
27680 20 61 20 73 65 63 6f 6e 64 20 65 72 72 6f 72 20   a second error 
27690 6f 63 63 75 72 73 20 6f 6e 20 61 20 73 65 70 61  occurs on a sepa
276a0 72 61 74 65 20 74 68 72 65 61 64 20 69 6e 20 62  rate thread in b
276b0 65 74 77 65 65 6e 0a 2a 2a 20 74 68 65 20 74 69  etween.** the ti
276c0 6d 65 20 6f 66 20 74 68 65 20 66 69 72 73 74 20  me of the first 
276d0 65 72 72 6f 72 20 61 6e 64 20 74 68 65 20 63 61  error and the ca
276e0 6c 6c 20 74 6f 20 74 68 65 73 65 20 69 6e 74 65  ll to these inte
276f0 72 66 61 63 65 73 2e 0a 2a 2a 20 57 68 65 6e 20  rfaces..** When 
27700 74 68 61 74 20 68 61 70 70 65 6e 73 2c 20 74 68  that happens, th
27710 65 20 73 65 63 6f 6e 64 20 65 72 72 6f 72 20 77  e second error w
27720 69 6c 6c 20 62 65 20 72 65 70 6f 72 74 65 64 20  ill be reported 
27730 73 69 6e 63 65 20 74 68 65 73 65 0a 2a 2a 20 69  since these.** i
27740 6e 74 65 72 66 61 63 65 73 20 61 6c 77 61 79 73  nterfaces always
27750 20 72 65 70 6f 72 74 20 74 68 65 20 6d 6f 73 74   report the most
27760 20 72 65 63 65 6e 74 20 72 65 73 75 6c 74 2e 20   recent result. 
27770 20 54 6f 20 61 76 6f 69 64 0a 2a 2a 20 74 68 69   To avoid.** thi
27780 73 2c 20 65 61 63 68 20 74 68 72 65 61 64 20 63  s, each thread c
27790 61 6e 20 6f 62 74 61 69 6e 20 65 78 63 6c 75 73  an obtain exclus
277a0 69 76 65 20 75 73 65 20 6f 66 20 74 68 65 20 5b  ive use of the [
277b0 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
277c0 69 6f 6e 5d 20 44 0a 2a 2a 20 62 79 20 69 6e 76  ion] D.** by inv
277d0 6f 6b 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 6d  oking [sqlite3_m
277e0 75 74 65 78 5f 65 6e 74 65 72 5d 28 5b 73 71 6c  utex_enter]([sql
277f0 69 74 65 33 5f 64 62 5f 6d 75 74 65 78 5d 28 44  ite3_db_mutex](D
27800 29 29 20 62 65 66 6f 72 65 20 62 65 67 69 6e 6e  )) before beginn
27810 69 6e 67 0a 2a 2a 20 74 6f 20 75 73 65 20 44 20  ing.** to use D 
27820 61 6e 64 20 69 6e 76 6f 6b 69 6e 67 20 5b 73 71  and invoking [sq
27830 6c 69 74 65 33 5f 6d 75 74 65 78 5f 6c 65 61 76  lite3_mutex_leav
27840 65 5d 28 5b 73 71 6c 69 74 65 33 5f 64 62 5f 6d  e]([sqlite3_db_m
27850 75 74 65 78 5d 28 44 29 29 20 61 66 74 65 72 0a  utex](D)) after.
27860 2a 2a 20 61 6c 6c 20 63 61 6c 6c 73 20 74 6f 20  ** all calls to 
27870 74 68 65 20 69 6e 74 65 72 66 61 63 65 73 20 6c  the interfaces l
27880 69 73 74 65 64 20 68 65 72 65 20 61 72 65 20 63  isted here are c
27890 6f 6d 70 6c 65 74 65 64 2e 0a 2a 2a 0a 2a 2a 20  ompleted..**.** 
278a0 49 66 20 61 6e 20 69 6e 74 65 72 66 61 63 65 20  If an interface 
278b0 66 61 69 6c 73 20 77 69 74 68 20 53 51 4c 49 54  fails with SQLIT
278c0 45 5f 4d 49 53 55 53 45 2c 20 74 68 61 74 20 6d  E_MISUSE, that m
278d0 65 61 6e 73 20 74 68 65 20 69 6e 74 65 72 66 61  eans the interfa
278e0 63 65 0a 2a 2a 20 77 61 73 20 69 6e 76 6f 6b 65  ce.** was invoke
278f0 64 20 69 6e 63 6f 72 72 65 63 74 6c 79 20 62 79  d incorrectly by
27900 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   the application
27910 2e 20 20 49 6e 20 74 68 61 74 20 63 61 73 65 2c  .  In that case,
27920 20 74 68 65 0a 2a 2a 20 65 72 72 6f 72 20 63 6f   the.** error co
27930 64 65 20 61 6e 64 20 6d 65 73 73 61 67 65 20 6d  de and message m
27940 61 79 20 6f 72 20 6d 61 79 20 6e 6f 74 20 62 65  ay or may not be
27950 20 73 65 74 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c   set..*/.int sql
27960 69 74 65 33 5f 65 72 72 63 6f 64 65 28 73 71 6c  ite3_errcode(sql
27970 69 74 65 33 20 2a 64 62 29 3b 0a 69 6e 74 20 73  ite3 *db);.int s
27980 71 6c 69 74 65 33 5f 65 78 74 65 6e 64 65 64 5f  qlite3_extended_
27990 65 72 72 63 6f 64 65 28 73 71 6c 69 74 65 33 20  errcode(sqlite3 
279a0 2a 64 62 29 3b 0a 63 6f 6e 73 74 20 63 68 61 72  *db);.const char
279b0 20 2a 73 71 6c 69 74 65 33 5f 65 72 72 6d 73 67   *sqlite3_errmsg
279c0 28 73 71 6c 69 74 65 33 2a 29 3b 0a 63 6f 6e 73  (sqlite3*);.cons
279d0 74 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f  t void *sqlite3_
279e0 65 72 72 6d 73 67 31 36 28 73 71 6c 69 74 65 33  errmsg16(sqlite3
279f0 2a 29 3b 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a  *);.const char *
27a00 73 71 6c 69 74 65 33 5f 65 72 72 73 74 72 28 69  sqlite3_errstr(i
27a10 6e 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  nt);../*.** CAPI
27a20 33 52 45 46 3a 20 50 72 65 70 61 72 65 64 20 53  3REF: Prepared S
27a30 74 61 74 65 6d 65 6e 74 20 4f 62 6a 65 63 74 0a  tatement Object.
27a40 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b 70 72  ** KEYWORDS: {pr
27a50 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
27a60 7d 20 7b 70 72 65 70 61 72 65 64 20 73 74 61 74  } {prepared stat
27a70 65 6d 65 6e 74 73 7d 0a 2a 2a 0a 2a 2a 20 41 6e  ements}.**.** An
27a80 20 69 6e 73 74 61 6e 63 65 20 6f 66 20 74 68 69   instance of thi
27a90 73 20 6f 62 6a 65 63 74 20 72 65 70 72 65 73 65  s object represe
27aa0 6e 74 73 20 61 20 73 69 6e 67 6c 65 20 53 51 4c  nts a single SQL
27ab0 20 73 74 61 74 65 6d 65 6e 74 20 74 68 61 74 0a   statement that.
27ac0 2a 2a 20 68 61 73 20 62 65 65 6e 20 63 6f 6d 70  ** has been comp
27ad0 69 6c 65 64 20 69 6e 74 6f 20 62 69 6e 61 72 79  iled into binary
27ae0 20 66 6f 72 6d 20 61 6e 64 20 69 73 20 72 65 61   form and is rea
27af0 64 79 20 74 6f 20 62 65 20 65 76 61 6c 75 61 74  dy to be evaluat
27b00 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 6e 6b 20  ed..**.** Think 
27b10 6f 66 20 65 61 63 68 20 53 51 4c 20 73 74 61 74  of each SQL stat
27b20 65 6d 65 6e 74 20 61 73 20 61 20 73 65 70 61 72  ement as a separ
27b30 61 74 65 20 63 6f 6d 70 75 74 65 72 20 70 72 6f  ate computer pro
27b40 67 72 61 6d 2e 20 20 54 68 65 0a 2a 2a 20 6f 72  gram.  The.** or
27b50 69 67 69 6e 61 6c 20 53 51 4c 20 74 65 78 74 20  iginal SQL text 
27b60 69 73 20 73 6f 75 72 63 65 20 63 6f 64 65 2e 20  is source code. 
27b70 20 41 20 70 72 65 70 61 72 65 64 20 73 74 61 74   A prepared stat
27b80 65 6d 65 6e 74 20 6f 62 6a 65 63 74 20 0a 2a 2a  ement object .**
27b90 20 69 73 20 74 68 65 20 63 6f 6d 70 69 6c 65 64   is the compiled
27ba0 20 6f 62 6a 65 63 74 20 63 6f 64 65 2e 20 20 41   object code.  A
27bb0 6c 6c 20 53 51 4c 20 6d 75 73 74 20 62 65 20 63  ll SQL must be c
27bc0 6f 6e 76 65 72 74 65 64 20 69 6e 74 6f 20 61 0a  onverted into a.
27bd0 2a 2a 20 70 72 65 70 61 72 65 64 20 73 74 61 74  ** prepared stat
27be0 65 6d 65 6e 74 20 62 65 66 6f 72 65 20 69 74 20  ement before it 
27bf0 63 61 6e 20 62 65 20 72 75 6e 2e 0a 2a 2a 0a 2a  can be run..**.*
27c00 2a 20 54 68 65 20 6c 69 66 65 2d 63 79 63 6c 65  * The life-cycle
27c10 20 6f 66 20 61 20 70 72 65 70 61 72 65 64 20 73   of a prepared s
27c20 74 61 74 65 6d 65 6e 74 20 6f 62 6a 65 63 74 20  tatement object 
27c30 75 73 75 61 6c 6c 79 20 67 6f 65 73 20 6c 69 6b  usually goes lik
27c40 65 20 74 68 69 73 3a 0a 2a 2a 0a 2a 2a 20 3c 6f  e this:.**.** <o
27c50 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20 43 72 65 61 74  l>.** <li> Creat
27c60 65 20 74 68 65 20 70 72 65 70 61 72 65 64 20 73  e the prepared s
27c70 74 61 74 65 6d 65 6e 74 20 6f 62 6a 65 63 74 20  tatement object 
27c80 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 70  using [sqlite3_p
27c90 72 65 70 61 72 65 5f 76 32 28 29 5d 2e 0a 2a 2a  repare_v2()]..**
27ca0 20 3c 6c 69 3e 20 42 69 6e 64 20 76 61 6c 75 65   <li> Bind value
27cb0 73 20 74 6f 20 5b 70 61 72 61 6d 65 74 65 72 73  s to [parameters
27cc0 5d 20 75 73 69 6e 67 20 74 68 65 20 73 71 6c 69  ] using the sqli
27cd0 74 65 33 5f 62 69 6e 64 5f 2a 28 29 0a 2a 2a 20  te3_bind_*().** 
27ce0 20 20 20 20 20 69 6e 74 65 72 66 61 63 65 73 2e       interfaces.
27cf0 0a 2a 2a 20 3c 6c 69 3e 20 52 75 6e 20 74 68 65  .** <li> Run the
27d00 20 53 51 4c 20 62 79 20 63 61 6c 6c 69 6e 67 20   SQL by calling 
27d10 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d  [sqlite3_step()]
27d20 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 20 74 69 6d   one or more tim
27d30 65 73 2e 0a 2a 2a 20 3c 6c 69 3e 20 52 65 73 65  es..** <li> Rese
27d40 74 20 74 68 65 20 70 72 65 70 61 72 65 64 20 73  t the prepared s
27d50 74 61 74 65 6d 65 6e 74 20 75 73 69 6e 67 20 5b  tatement using [
27d60 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d  sqlite3_reset()]
27d70 20 74 68 65 6e 20 67 6f 20 62 61 63 6b 0a 2a 2a   then go back.**
27d80 20 20 20 20 20 20 74 6f 20 73 74 65 70 20 32 2e        to step 2.
27d90 20 20 44 6f 20 74 68 69 73 20 7a 65 72 6f 20 6f    Do this zero o
27da0 72 20 6d 6f 72 65 20 74 69 6d 65 73 2e 0a 2a 2a  r more times..**
27db0 20 3c 6c 69 3e 20 44 65 73 74 72 6f 79 20 74 68   <li> Destroy th
27dc0 65 20 6f 62 6a 65 63 74 20 75 73 69 6e 67 20 5b  e object using [
27dd0 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65  sqlite3_finalize
27de0 28 29 5d 2e 0a 2a 2a 20 3c 2f 6f 6c 3e 0a 2a 2f  ()]..** </ol>.*/
27df0 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20  .typedef struct 
27e00 73 71 6c 69 74 65 33 5f 73 74 6d 74 20 73 71 6c  sqlite3_stmt sql
27e10 69 74 65 33 5f 73 74 6d 74 3b 0a 0a 2f 2a 0a 2a  ite3_stmt;../*.*
27e20 2a 20 43 41 50 49 33 52 45 46 3a 20 52 75 6e 2d  * CAPI3REF: Run-
27e30 74 69 6d 65 20 4c 69 6d 69 74 73 0a 2a 2a 20 4d  time Limits.** M
27e40 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a  ETHOD: sqlite3.*
27e50 2a 0a 2a 2a 20 5e 28 54 68 69 73 20 69 6e 74 65  *.** ^(This inte
27e60 72 66 61 63 65 20 61 6c 6c 6f 77 73 20 74 68 65  rface allows the
27e70 20 73 69 7a 65 20 6f 66 20 76 61 72 69 6f 75 73   size of various
27e80 20 63 6f 6e 73 74 72 75 63 74 73 20 74 6f 20 62   constructs to b
27e90 65 20 6c 69 6d 69 74 65 64 0a 2a 2a 20 6f 6e 20  e limited.** on 
27ea0 61 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 62 79 20  a connection by 
27eb0 63 6f 6e 6e 65 63 74 69 6f 6e 20 62 61 73 69 73  connection basis
27ec0 2e 20 20 54 68 65 20 66 69 72 73 74 20 70 61 72  .  The first par
27ed0 61 6d 65 74 65 72 20 69 73 20 74 68 65 0a 2a 2a  ameter is the.**
27ee0 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65   [database conne
27ef0 63 74 69 6f 6e 5d 20 77 68 6f 73 65 20 6c 69 6d  ction] whose lim
27f00 69 74 20 69 73 20 74 6f 20 62 65 20 73 65 74 20  it is to be set 
27f10 6f 72 20 71 75 65 72 69 65 64 2e 20 20 54 68 65  or queried.  The
27f20 0a 2a 2a 20 73 65 63 6f 6e 64 20 70 61 72 61 6d  .** second param
27f30 65 74 65 72 20 69 73 20 6f 6e 65 20 6f 66 20 74  eter is one of t
27f40 68 65 20 5b 6c 69 6d 69 74 20 63 61 74 65 67 6f  he [limit catego
27f50 72 69 65 73 5d 20 74 68 61 74 20 64 65 66 69 6e  ries] that defin
27f60 65 20 61 0a 2a 2a 20 63 6c 61 73 73 20 6f 66 20  e a.** class of 
27f70 63 6f 6e 73 74 72 75 63 74 73 20 74 6f 20 62 65  constructs to be
27f80 20 73 69 7a 65 20 6c 69 6d 69 74 65 64 2e 20 20   size limited.  
27f90 54 68 65 20 74 68 69 72 64 20 70 61 72 61 6d 65  The third parame
27fa0 74 65 72 20 69 73 20 74 68 65 0a 2a 2a 20 6e 65  ter is the.** ne
27fb0 77 20 6c 69 6d 69 74 20 66 6f 72 20 74 68 61 74  w limit for that
27fc0 20 63 6f 6e 73 74 72 75 63 74 2e 29 5e 0a 2a 2a   construct.)^.**
27fd0 0a 2a 2a 20 5e 49 66 20 74 68 65 20 6e 65 77 20  .** ^If the new 
27fe0 6c 69 6d 69 74 20 69 73 20 61 20 6e 65 67 61 74  limit is a negat
27ff0 69 76 65 20 6e 75 6d 62 65 72 2c 20 74 68 65 20  ive number, the 
28000 6c 69 6d 69 74 20 69 73 20 75 6e 63 68 61 6e 67  limit is unchang
28010 65 64 2e 0a 2a 2a 20 5e 28 46 6f 72 20 65 61 63  ed..** ^(For eac
28020 68 20 6c 69 6d 69 74 20 63 61 74 65 67 6f 72 79  h limit category
28030 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 3c 69   SQLITE_LIMIT_<i
28040 3e 4e 41 4d 45 3c 2f 69 3e 20 74 68 65 72 65 20  >NAME</i> there 
28050 69 73 20 61 20 0a 2a 2a 20 5b 6c 69 6d 69 74 73  is a .** [limits
28060 20 7c 20 68 61 72 64 20 75 70 70 65 72 20 62 6f   | hard upper bo
28070 75 6e 64 5d 0a 2a 2a 20 73 65 74 20 61 74 20 63  und].** set at c
28080 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 62 79 20 61  ompile-time by a
28090 20 43 20 70 72 65 70 72 6f 63 65 73 73 6f 72 20   C preprocessor 
280a0 6d 61 63 72 6f 20 63 61 6c 6c 65 64 0a 2a 2a 20  macro called.** 
280b0 5b 6c 69 6d 69 74 73 20 7c 20 53 51 4c 49 54 45  [limits | SQLITE
280c0 5f 4d 41 58 5f 3c 69 3e 4e 41 4d 45 3c 2f 69 3e  _MAX_<i>NAME</i>
280d0 5d 2e 0a 2a 2a 20 28 54 68 65 20 22 5f 4c 49 4d  ]..** (The "_LIM
280e0 49 54 5f 22 20 69 6e 20 74 68 65 20 6e 61 6d 65  IT_" in the name
280f0 20 69 73 20 63 68 61 6e 67 65 64 20 74 6f 20 22   is changed to "
28100 5f 4d 41 58 5f 22 2e 29 29 5e 0a 2a 2a 20 5e 41  _MAX_".))^.** ^A
28110 74 74 65 6d 70 74 73 20 74 6f 20 69 6e 63 72 65  ttempts to incre
28120 61 73 65 20 61 20 6c 69 6d 69 74 20 61 62 6f 76  ase a limit abov
28130 65 20 69 74 73 20 68 61 72 64 20 75 70 70 65 72  e its hard upper
28140 20 62 6f 75 6e 64 20 61 72 65 0a 2a 2a 20 73 69   bound are.** si
28150 6c 65 6e 74 6c 79 20 74 72 75 6e 63 61 74 65 64  lently truncated
28160 20 74 6f 20 74 68 65 20 68 61 72 64 20 75 70 70   to the hard upp
28170 65 72 20 62 6f 75 6e 64 2e 0a 2a 2a 0a 2a 2a 20  er bound..**.** 
28180 5e 52 65 67 61 72 64 6c 65 73 73 20 6f 66 20 77  ^Regardless of w
28190 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20 74 68  hether or not th
281a0 65 20 6c 69 6d 69 74 20 77 61 73 20 63 68 61 6e  e limit was chan
281b0 67 65 64 2c 20 74 68 65 20 0a 2a 2a 20 5b 73 71  ged, the .** [sq
281c0 6c 69 74 65 33 5f 6c 69 6d 69 74 28 29 5d 20 69  lite3_limit()] i
281d0 6e 74 65 72 66 61 63 65 20 72 65 74 75 72 6e 73  nterface returns
281e0 20 74 68 65 20 70 72 69 6f 72 20 76 61 6c 75 65   the prior value
281f0 20 6f 66 20 74 68 65 20 6c 69 6d 69 74 2e 0a 2a   of the limit..*
28200 2a 20 5e 48 65 6e 63 65 2c 20 74 6f 20 66 69 6e  * ^Hence, to fin
28210 64 20 74 68 65 20 63 75 72 72 65 6e 74 20 76 61  d the current va
28220 6c 75 65 20 6f 66 20 61 20 6c 69 6d 69 74 20 77  lue of a limit w
28230 69 74 68 6f 75 74 20 63 68 61 6e 67 69 6e 67 20  ithout changing 
28240 69 74 2c 0a 2a 2a 20 73 69 6d 70 6c 79 20 69 6e  it,.** simply in
28250 76 6f 6b 65 20 74 68 69 73 20 69 6e 74 65 72 66  voke this interf
28260 61 63 65 20 77 69 74 68 20 74 68 65 20 74 68 69  ace with the thi
28270 72 64 20 70 61 72 61 6d 65 74 65 72 20 73 65 74  rd parameter set
28280 20 74 6f 20 2d 31 2e 0a 2a 2a 0a 2a 2a 20 52 75   to -1..**.** Ru
28290 6e 2d 74 69 6d 65 20 6c 69 6d 69 74 73 20 61 72  n-time limits ar
282a0 65 20 69 6e 74 65 6e 64 65 64 20 66 6f 72 20 75  e intended for u
282b0 73 65 20 69 6e 20 61 70 70 6c 69 63 61 74 69 6f  se in applicatio
282c0 6e 73 20 74 68 61 74 20 6d 61 6e 61 67 65 0a 2a  ns that manage.*
282d0 2a 20 62 6f 74 68 20 74 68 65 69 72 20 6f 77 6e  * both their own
282e0 20 69 6e 74 65 72 6e 61 6c 20 64 61 74 61 62 61   internal databa
282f0 73 65 20 61 6e 64 20 61 6c 73 6f 20 64 61 74 61  se and also data
28300 62 61 73 65 73 20 74 68 61 74 20 61 72 65 20 63  bases that are c
28310 6f 6e 74 72 6f 6c 6c 65 64 0a 2a 2a 20 62 79 20  ontrolled.** by 
28320 75 6e 74 72 75 73 74 65 64 20 65 78 74 65 72 6e  untrusted extern
28330 61 6c 20 73 6f 75 72 63 65 73 2e 20 20 41 6e 20  al sources.  An 
28340 65 78 61 6d 70 6c 65 20 61 70 70 6c 69 63 61 74  example applicat
28350 69 6f 6e 20 6d 69 67 68 74 20 62 65 20 61 0a 2a  ion might be a.*
28360 2a 20 77 65 62 20 62 72 6f 77 73 65 72 20 74 68  * web browser th
28370 61 74 20 68 61 73 20 69 74 73 20 6f 77 6e 20 64  at has its own d
28380 61 74 61 62 61 73 65 73 20 66 6f 72 20 73 74 6f  atabases for sto
28390 72 69 6e 67 20 68 69 73 74 6f 72 79 20 61 6e 64  ring history and
283a0 0a 2a 2a 20 73 65 70 61 72 61 74 65 20 64 61 74  .** separate dat
283b0 61 62 61 73 65 73 20 63 6f 6e 74 72 6f 6c 6c 65  abases controlle
283c0 64 20 62 79 20 4a 61 76 61 53 63 72 69 70 74 20  d by JavaScript 
283d0 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 64 6f 77  applications dow
283e0 6e 6c 6f 61 64 65 64 0a 2a 2a 20 6f 66 66 20 74  nloaded.** off t
283f0 68 65 20 49 6e 74 65 72 6e 65 74 2e 20 20 54 68  he Internet.  Th
28400 65 20 69 6e 74 65 72 6e 61 6c 20 64 61 74 61 62  e internal datab
28410 61 73 65 73 20 63 61 6e 20 62 65 20 67 69 76 65  ases can be give
28420 6e 20 74 68 65 0a 2a 2a 20 6c 61 72 67 65 2c 20  n the.** large, 
28430 64 65 66 61 75 6c 74 20 6c 69 6d 69 74 73 2e 20  default limits. 
28440 20 44 61 74 61 62 61 73 65 73 20 6d 61 6e 61 67   Databases manag
28450 65 64 20 62 79 20 65 78 74 65 72 6e 61 6c 20 73  ed by external s
28460 6f 75 72 63 65 73 20 63 61 6e 0a 2a 2a 20 62 65  ources can.** be
28470 20 67 69 76 65 6e 20 6d 75 63 68 20 73 6d 61 6c   given much smal
28480 6c 65 72 20 6c 69 6d 69 74 73 20 64 65 73 69 67  ler limits desig
28490 6e 65 64 20 74 6f 20 70 72 65 76 65 6e 74 20 61  ned to prevent a
284a0 20 64 65 6e 69 61 6c 20 6f 66 20 73 65 72 76 69   denial of servi
284b0 63 65 0a 2a 2a 20 61 74 74 61 63 6b 2e 20 20 44  ce.** attack.  D
284c0 65 76 65 6c 6f 70 65 72 73 20 6d 69 67 68 74 20  evelopers might 
284d0 61 6c 73 6f 20 77 61 6e 74 20 74 6f 20 75 73 65  also want to use
284e0 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 65   the [sqlite3_se
284f0 74 5f 61 75 74 68 6f 72 69 7a 65 72 28 29 5d 0a  t_authorizer()].
28500 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20  ** interface to 
28510 66 75 72 74 68 65 72 20 63 6f 6e 74 72 6f 6c 20  further control 
28520 75 6e 74 72 75 73 74 65 64 20 53 51 4c 2e 20 20  untrusted SQL.  
28530 54 68 65 20 73 69 7a 65 20 6f 66 20 74 68 65 20  The size of the 
28540 64 61 74 61 62 61 73 65 0a 2a 2a 20 63 72 65 61  database.** crea
28550 74 65 64 20 62 79 20 61 6e 20 75 6e 74 72 75 73  ted by an untrus
28560 74 65 64 20 73 63 72 69 70 74 20 63 61 6e 20 62  ted script can b
28570 65 20 63 6f 6e 74 61 69 6e 65 64 20 75 73 69 6e  e contained usin
28580 67 20 74 68 65 0a 2a 2a 20 5b 6d 61 78 5f 70 61  g the.** [max_pa
28590 67 65 5f 63 6f 75 6e 74 5d 20 5b 50 52 41 47 4d  ge_count] [PRAGM
285a0 41 5d 2e 0a 2a 2a 0a 2a 2a 20 4e 65 77 20 72 75  A]..**.** New ru
285b0 6e 2d 74 69 6d 65 20 6c 69 6d 69 74 20 63 61 74  n-time limit cat
285c0 65 67 6f 72 69 65 73 20 6d 61 79 20 62 65 20 61  egories may be a
285d0 64 64 65 64 20 69 6e 20 66 75 74 75 72 65 20 72  dded in future r
285e0 65 6c 65 61 73 65 73 2e 0a 2a 2f 0a 69 6e 74 20  eleases..*/.int 
285f0 73 71 6c 69 74 65 33 5f 6c 69 6d 69 74 28 73 71  sqlite3_limit(sq
28600 6c 69 74 65 33 2a 2c 20 69 6e 74 20 69 64 2c 20  lite3*, int id, 
28610 69 6e 74 20 6e 65 77 56 61 6c 29 3b 0a 0a 2f 2a  int newVal);../*
28620 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 52 75  .** CAPI3REF: Ru
28630 6e 2d 54 69 6d 65 20 4c 69 6d 69 74 20 43 61 74  n-Time Limit Cat
28640 65 67 6f 72 69 65 73 0a 2a 2a 20 4b 45 59 57 4f  egories.** KEYWO
28650 52 44 53 3a 20 7b 6c 69 6d 69 74 20 63 61 74 65  RDS: {limit cate
28660 67 6f 72 79 7d 20 7b 2a 6c 69 6d 69 74 20 63 61  gory} {*limit ca
28670 74 65 67 6f 72 69 65 73 7d 0a 2a 2a 0a 2a 2a 20  tegories}.**.** 
28680 54 68 65 73 65 20 63 6f 6e 73 74 61 6e 74 73 20  These constants 
28690 64 65 66 69 6e 65 20 76 61 72 69 6f 75 73 20 70  define various p
286a0 65 72 66 6f 72 6d 61 6e 63 65 20 6c 69 6d 69 74  erformance limit
286b0 73 0a 2a 2a 20 74 68 61 74 20 63 61 6e 20 62 65  s.** that can be
286c0 20 6c 6f 77 65 72 65 64 20 61 74 20 72 75 6e 2d   lowered at run-
286d0 74 69 6d 65 20 75 73 69 6e 67 20 5b 73 71 6c 69  time using [sqli
286e0 74 65 33 5f 6c 69 6d 69 74 28 29 5d 2e 0a 2a 2a  te3_limit()]..**
286f0 20 54 68 65 20 73 79 6e 6f 70 73 69 73 20 6f 66   The synopsis of
28700 20 74 68 65 20 6d 65 61 6e 69 6e 67 73 20 6f 66   the meanings of
28710 20 74 68 65 20 76 61 72 69 6f 75 73 20 6c 69 6d   the various lim
28720 69 74 73 20 69 73 20 73 68 6f 77 6e 20 62 65 6c  its is shown bel
28730 6f 77 2e 0a 2a 2a 20 41 64 64 69 74 69 6f 6e 61  ow..** Additiona
28740 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 69 73  l information is
28750 20 61 76 61 69 6c 61 62 6c 65 20 61 74 20 5b 6c   available at [l
28760 69 6d 69 74 73 20 7c 20 4c 69 6d 69 74 73 20 69  imits | Limits i
28770 6e 20 53 51 4c 69 74 65 5d 2e 0a 2a 2a 0a 2a 2a  n SQLite]..**.**
28780 20 3c 64 6c 3e 0a 2a 2a 20 5b 5b 53 51 4c 49 54   <dl>.** [[SQLIT
28790 45 5f 4c 49 4d 49 54 5f 4c 45 4e 47 54 48 5d 5d  E_LIMIT_LENGTH]]
287a0 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49   ^(<dt>SQLITE_LI
287b0 4d 49 54 5f 4c 45 4e 47 54 48 3c 2f 64 74 3e 0a  MIT_LENGTH</dt>.
287c0 2a 2a 20 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d  ** <dd>The maxim
287d0 75 6d 20 73 69 7a 65 20 6f 66 20 61 6e 79 20 73  um size of any s
287e0 74 72 69 6e 67 20 6f 72 20 42 4c 4f 42 20 6f 72  tring or BLOB or
287f0 20 74 61 62 6c 65 20 72 6f 77 2c 20 69 6e 20 62   table row, in b
28800 79 74 65 73 2e 3c 64 64 3e 29 5e 0a 2a 2a 0a 2a  ytes.<dd>)^.**.*
28810 2a 20 5b 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54  * [[SQLITE_LIMIT
28820 5f 53 51 4c 5f 4c 45 4e 47 54 48 5d 5d 20 5e 28  _SQL_LENGTH]] ^(
28830 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54  <dt>SQLITE_LIMIT
28840 5f 53 51 4c 5f 4c 45 4e 47 54 48 3c 2f 64 74 3e  _SQL_LENGTH</dt>
28850 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 6d 61 78 69  .** <dd>The maxi
28860 6d 75 6d 20 6c 65 6e 67 74 68 20 6f 66 20 61 6e  mum length of an
28870 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2c 20   SQL statement, 
28880 69 6e 20 62 79 74 65 73 2e 3c 2f 64 64 3e 29 5e  in bytes.</dd>)^
28890 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f  .**.** [[SQLITE_
288a0 4c 49 4d 49 54 5f 43 4f 4c 55 4d 4e 5d 5d 20 5e  LIMIT_COLUMN]] ^
288b0 28 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d 49  (<dt>SQLITE_LIMI
288c0 54 5f 43 4f 4c 55 4d 4e 3c 2f 64 74 3e 0a 2a 2a  T_COLUMN</dt>.**
288d0 20 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d   <dd>The maximum
288e0 20 6e 75 6d 62 65 72 20 6f 66 20 63 6f 6c 75 6d   number of colum
288f0 6e 73 20 69 6e 20 61 20 74 61 62 6c 65 20 64 65  ns in a table de
28900 66 69 6e 69 74 69 6f 6e 20 6f 72 20 69 6e 20 74  finition or in t
28910 68 65 0a 2a 2a 20 72 65 73 75 6c 74 20 73 65 74  he.** result set
28920 20 6f 66 20 61 20 5b 53 45 4c 45 43 54 5d 20 6f   of a [SELECT] o
28930 72 20 74 68 65 20 6d 61 78 69 6d 75 6d 20 6e 75  r the maximum nu
28940 6d 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 20  mber of columns 
28950 69 6e 20 61 6e 20 69 6e 64 65 78 0a 2a 2a 20 6f  in an index.** o
28960 72 20 69 6e 20 61 6e 20 4f 52 44 45 52 20 42 59  r in an ORDER BY
28970 20 6f 72 20 47 52 4f 55 50 20 42 59 20 63 6c 61   or GROUP BY cla
28980 75 73 65 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 0a 2a  use.</dd>)^.**.*
28990 2a 20 5b 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54  * [[SQLITE_LIMIT
289a0 5f 45 58 50 52 5f 44 45 50 54 48 5d 5d 20 5e 28  _EXPR_DEPTH]] ^(
289b0 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54  <dt>SQLITE_LIMIT
289c0 5f 45 58 50 52 5f 44 45 50 54 48 3c 2f 64 74 3e  _EXPR_DEPTH</dt>
289d0 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 6d 61 78 69  .** <dd>The maxi
289e0 6d 75 6d 20 64 65 70 74 68 20 6f 66 20 74 68 65  mum depth of the
289f0 20 70 61 72 73 65 20 74 72 65 65 20 6f 6e 20 61   parse tree on a
28a00 6e 79 20 65 78 70 72 65 73 73 69 6f 6e 2e 3c 2f  ny expression.</
28a10 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51  dd>)^.**.** [[SQ
28a20 4c 49 54 45 5f 4c 49 4d 49 54 5f 43 4f 4d 50 4f  LITE_LIMIT_COMPO
28a30 55 4e 44 5f 53 45 4c 45 43 54 5d 5d 20 5e 28 3c  UND_SELECT]] ^(<
28a40 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f  dt>SQLITE_LIMIT_
28a50 43 4f 4d 50 4f 55 4e 44 5f 53 45 4c 45 43 54 3c  COMPOUND_SELECT<
28a60 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20  /dt>.** <dd>The 
28a70 6d 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f  maximum number o
28a80 66 20 74 65 72 6d 73 20 69 6e 20 61 20 63 6f 6d  f terms in a com
28a90 70 6f 75 6e 64 20 53 45 4c 45 43 54 20 73 74 61  pound SELECT sta
28aa0 74 65 6d 65 6e 74 2e 3c 2f 64 64 3e 29 5e 0a 2a  tement.</dd>)^.*
28ab0 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 4c 49  *.** [[SQLITE_LI
28ac0 4d 49 54 5f 56 44 42 45 5f 4f 50 5d 5d 20 5e 28  MIT_VDBE_OP]] ^(
28ad0 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54  <dt>SQLITE_LIMIT
28ae0 5f 56 44 42 45 5f 4f 50 3c 2f 64 74 3e 0a 2a 2a  _VDBE_OP</dt>.**
28af0 20 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d   <dd>The maximum
28b00 20 6e 75 6d 62 65 72 20 6f 66 20 69 6e 73 74 72   number of instr
28b10 75 63 74 69 6f 6e 73 20 69 6e 20 61 20 76 69 72  uctions in a vir
28b20 74 75 61 6c 20 6d 61 63 68 69 6e 65 20 70 72 6f  tual machine pro
28b30 67 72 61 6d 0a 2a 2a 20 75 73 65 64 20 74 6f 20  gram.** used to 
28b40 69 6d 70 6c 65 6d 65 6e 74 20 61 6e 20 53 51 4c  implement an SQL
28b50 20 73 74 61 74 65 6d 65 6e 74 2e 20 20 54 68 69   statement.  Thi
28b60 73 20 6c 69 6d 69 74 20 69 73 20 6e 6f 74 20 63  s limit is not c
28b70 75 72 72 65 6e 74 6c 79 0a 2a 2a 20 65 6e 66 6f  urrently.** enfo
28b80 72 63 65 64 2c 20 74 68 6f 75 67 68 20 74 68 61  rced, though tha
28b90 74 20 6d 69 67 68 74 20 62 65 20 61 64 64 65 64  t might be added
28ba0 20 69 6e 20 73 6f 6d 65 20 66 75 74 75 72 65 20   in some future 
28bb0 72 65 6c 65 61 73 65 20 6f 66 0a 2a 2a 20 53 51  release of.** SQ
28bc0 4c 69 74 65 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 0a  Lite.</dd>)^.**.
28bd0 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 4c 49 4d 49  ** [[SQLITE_LIMI
28be0 54 5f 46 55 4e 43 54 49 4f 4e 5f 41 52 47 5d 5d  T_FUNCTION_ARG]]
28bf0 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49   ^(<dt>SQLITE_LI
28c00 4d 49 54 5f 46 55 4e 43 54 49 4f 4e 5f 41 52 47  MIT_FUNCTION_ARG
28c10 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65  </dt>.** <dd>The
28c20 20 6d 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20   maximum number 
28c30 6f 66 20 61 72 67 75 6d 65 6e 74 73 20 6f 6e 20  of arguments on 
28c40 61 20 66 75 6e 63 74 69 6f 6e 2e 3c 2f 64 64 3e  a function.</dd>
28c50 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  )^.**.** [[SQLIT
28c60 45 5f 4c 49 4d 49 54 5f 41 54 54 41 43 48 45 44  E_LIMIT_ATTACHED
28c70 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f  ]] ^(<dt>SQLITE_
28c80 4c 49 4d 49 54 5f 41 54 54 41 43 48 45 44 3c 2f  LIMIT_ATTACHED</
28c90 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 6d  dt>.** <dd>The m
28ca0 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f 66  aximum number of
28cb0 20 5b 41 54 54 41 43 48 20 7c 20 61 74 74 61 63   [ATTACH | attac
28cc0 68 65 64 20 64 61 74 61 62 61 73 65 73 5d 2e 29  hed databases].)
28cd0 5e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53  ^</dd>.**.** [[S
28ce0 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 4c 49 4b 45  QLITE_LIMIT_LIKE
28cf0 5f 50 41 54 54 45 52 4e 5f 4c 45 4e 47 54 48 5d  _PATTERN_LENGTH]
28d00 5d 0a 2a 2a 20 5e 28 3c 64 74 3e 53 51 4c 49 54  ].** ^(<dt>SQLIT
28d10 45 5f 4c 49 4d 49 54 5f 4c 49 4b 45 5f 50 41 54  E_LIMIT_LIKE_PAT
28d20 54 45 52 4e 5f 4c 45 4e 47 54 48 3c 2f 64 74 3e  TERN_LENGTH</dt>
28d30 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 6d 61 78 69  .** <dd>The maxi
28d40 6d 75 6d 20 6c 65 6e 67 74 68 20 6f 66 20 74 68  mum length of th
28d50 65 20 70 61 74 74 65 72 6e 20 61 72 67 75 6d 65  e pattern argume
28d60 6e 74 20 74 6f 20 74 68 65 20 5b 4c 49 4b 45 5d  nt to the [LIKE]
28d70 20 6f 72 0a 2a 2a 20 5b 47 4c 4f 42 5d 20 6f 70   or.** [GLOB] op
28d80 65 72 61 74 6f 72 73 2e 3c 2f 64 64 3e 29 5e 0a  erators.</dd>)^.
28d90 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 4c  **.** [[SQLITE_L
28da0 49 4d 49 54 5f 56 41 52 49 41 42 4c 45 5f 4e 55  IMIT_VARIABLE_NU
28db0 4d 42 45 52 5d 5d 0a 2a 2a 20 5e 28 3c 64 74 3e  MBER]].** ^(<dt>
28dc0 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 56 41 52  SQLITE_LIMIT_VAR
28dd0 49 41 42 4c 45 5f 4e 55 4d 42 45 52 3c 2f 64 74  IABLE_NUMBER</dt
28de0 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 6d 61 78  >.** <dd>The max
28df0 69 6d 75 6d 20 69 6e 64 65 78 20 6e 75 6d 62 65  imum index numbe
28e00 72 20 6f 66 20 61 6e 79 20 5b 70 61 72 61 6d 65  r of any [parame
28e10 74 65 72 5d 20 69 6e 20 61 6e 20 53 51 4c 20 73  ter] in an SQL s
28e20 74 61 74 65 6d 65 6e 74 2e 29 5e 0a 2a 2a 0a 2a  tatement.)^.**.*
28e30 2a 20 5b 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54  * [[SQLITE_LIMIT
28e40 5f 54 52 49 47 47 45 52 5f 44 45 50 54 48 5d 5d  _TRIGGER_DEPTH]]
28e50 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49   ^(<dt>SQLITE_LI
28e60 4d 49 54 5f 54 52 49 47 47 45 52 5f 44 45 50 54  MIT_TRIGGER_DEPT
28e70 48 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68  H</dt>.** <dd>Th
28e80 65 20 6d 61 78 69 6d 75 6d 20 64 65 70 74 68 20  e maximum depth 
28e90 6f 66 20 72 65 63 75 72 73 69 6f 6e 20 66 6f 72  of recursion for
28ea0 20 74 72 69 67 67 65 72 73 2e 3c 2f 64 64 3e 29   triggers.</dd>)
28eb0 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45  ^.**.** [[SQLITE
28ec0 5f 4c 49 4d 49 54 5f 57 4f 52 4b 45 52 5f 54 48  _LIMIT_WORKER_TH
28ed0 52 45 41 44 53 5d 5d 20 5e 28 3c 64 74 3e 53 51  READS]] ^(<dt>SQ
28ee0 4c 49 54 45 5f 4c 49 4d 49 54 5f 57 4f 52 4b 45  LITE_LIMIT_WORKE
28ef0 52 5f 54 48 52 45 41 44 53 3c 2f 64 74 3e 0a 2a  R_THREADS</dt>.*
28f00 2a 20 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d 75  * <dd>The maximu
28f10 6d 20 6e 75 6d 62 65 72 20 6f 66 20 61 75 78 69  m number of auxi
28f20 6c 69 61 72 79 20 77 6f 72 6b 65 72 20 74 68 72  liary worker thr
28f30 65 61 64 73 20 74 68 61 74 20 61 20 73 69 6e 67  eads that a sing
28f40 6c 65 0a 2a 2a 20 5b 70 72 65 70 61 72 65 64 20  le.** [prepared 
28f50 73 74 61 74 65 6d 65 6e 74 5d 20 6d 61 79 20 73  statement] may s
28f60 74 61 72 74 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 20  tart.</dd>)^.** 
28f70 3c 2f 64 6c 3e 0a 2a 2f 0a 23 64 65 66 69 6e 65  </dl>.*/.#define
28f80 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 4c 45   SQLITE_LIMIT_LE
28f90 4e 47 54 48 20 20 20 20 20 20 20 20 20 20 20 20  NGTH            
28fa0 20 20 20 20 20 20 20 20 30 0a 23 64 65 66 69 6e          0.#defin
28fb0 65 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 53  e SQLITE_LIMIT_S
28fc0 51 4c 5f 4c 45 4e 47 54 48 20 20 20 20 20 20 20  QL_LENGTH       
28fd0 20 20 20 20 20 20 20 20 20 31 0a 23 64 65 66 69           1.#defi
28fe0 6e 65 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f  ne SQLITE_LIMIT_
28ff0 43 4f 4c 55 4d 4e 20 20 20 20 20 20 20 20 20 20  COLUMN          
29000 20 20 20 20 20 20 20 20 20 20 32 0a 23 64 65 66            2.#def
29010 69 6e 65 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54  ine SQLITE_LIMIT
29020 5f 45 58 50 52 5f 44 45 50 54 48 20 20 20 20 20  _EXPR_DEPTH     
29030 20 20 20 20 20 20 20 20 20 20 20 33 0a 23 64 65             3.#de
29040 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c 49 4d 49  fine SQLITE_LIMI
29050 54 5f 43 4f 4d 50 4f 55 4e 44 5f 53 45 4c 45 43  T_COMPOUND_SELEC
29060 54 20 20 20 20 20 20 20 20 20 20 20 34 0a 23 64  T           4.#d
29070 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c 49 4d  efine SQLITE_LIM
29080 49 54 5f 56 44 42 45 5f 4f 50 20 20 20 20 20 20  IT_VDBE_OP      
29090 20 20 20 20 20 20 20 20 20 20 20 20 20 35 0a 23               5.#
290a0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c 49  define SQLITE_LI
290b0 4d 49 54 5f 46 55 4e 43 54 49 4f 4e 5f 41 52 47  MIT_FUNCTION_ARG
290c0 20 20 20 20 20 20 20 20 20 20 20 20 20 20 36 0a                6.
290d0 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c  #define SQLITE_L
290e0 49 4d 49 54 5f 41 54 54 41 43 48 45 44 20 20 20  IMIT_ATTACHED   
290f0 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 37                 7
29100 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
29110 4c 49 4d 49 54 5f 4c 49 4b 45 5f 50 41 54 54 45  LIMIT_LIKE_PATTE
29120 52 4e 5f 4c 45 4e 47 54 48 20 20 20 20 20 20 20  RN_LENGTH       
29130 38 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  8.#define SQLITE
29140 5f 4c 49 4d 49 54 5f 56 41 52 49 41 42 4c 45 5f  _LIMIT_VARIABLE_
29150 4e 55 4d 42 45 52 20 20 20 20 20 20 20 20 20 20  NUMBER          
29160 20 39 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54   9.#define SQLIT
29170 45 5f 4c 49 4d 49 54 5f 54 52 49 47 47 45 52 5f  E_LIMIT_TRIGGER_
29180 44 45 50 54 48 20 20 20 20 20 20 20 20 20 20 20  DEPTH           
29190 20 31 30 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   10.#define SQLI
291a0 54 45 5f 4c 49 4d 49 54 5f 57 4f 52 4b 45 52 5f  TE_LIMIT_WORKER_
291b0 54 48 52 45 41 44 53 20 20 20 20 20 20 20 20 20  THREADS         
291c0 20 20 31 31 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49    11../*.** CAPI
291d0 33 52 45 46 3a 20 43 6f 6d 70 69 6c 69 6e 67 20  3REF: Compiling 
291e0 41 6e 20 53 51 4c 20 53 74 61 74 65 6d 65 6e 74  An SQL Statement
291f0 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b 53  .** KEYWORDS: {S
29200 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 63 6f 6d  QL statement com
29210 70 69 6c 65 72 7d 0a 2a 2a 20 4d 45 54 48 4f 44  piler}.** METHOD
29220 3a 20 73 71 6c 69 74 65 33 0a 2a 2a 20 43 4f 4e  : sqlite3.** CON
29230 53 54 52 55 43 54 4f 52 3a 20 73 71 6c 69 74 65  STRUCTOR: sqlite
29240 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 54 6f 20  3_stmt.**.** To 
29250 65 78 65 63 75 74 65 20 61 6e 20 53 51 4c 20 71  execute an SQL q
29260 75 65 72 79 2c 20 69 74 20 6d 75 73 74 20 66 69  uery, it must fi
29270 72 73 74 20 62 65 20 63 6f 6d 70 69 6c 65 64 20  rst be compiled 
29280 69 6e 74 6f 20 61 20 62 79 74 65 2d 63 6f 64 65  into a byte-code
29290 0a 2a 2a 20 70 72 6f 67 72 61 6d 20 75 73 69 6e  .** program usin
292a0 67 20 6f 6e 65 20 6f 66 20 74 68 65 73 65 20 72  g one of these r
292b0 6f 75 74 69 6e 65 73 2e 0a 2a 2a 0a 2a 2a 20 54  outines..**.** T
292c0 68 65 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e  he first argumen
292d0 74 2c 20 22 64 62 22 2c 20 69 73 20 61 20 5b 64  t, "db", is a [d
292e0 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
292f0 6f 6e 5d 20 6f 62 74 61 69 6e 65 64 20 66 72 6f  on] obtained fro
29300 6d 20 61 0a 2a 2a 20 70 72 69 6f 72 20 73 75 63  m a.** prior suc
29310 63 65 73 73 66 75 6c 20 63 61 6c 6c 20 74 6f 20  cessful call to 
29320 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 5d  [sqlite3_open()]
29330 2c 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f  , [sqlite3_open_
29340 76 32 28 29 5d 20 6f 72 0a 2a 2a 20 5b 73 71 6c  v2()] or.** [sql
29350 69 74 65 33 5f 6f 70 65 6e 31 36 28 29 5d 2e 20  ite3_open16()]. 
29360 20 54 68 65 20 64 61 74 61 62 61 73 65 20 63 6f   The database co
29370 6e 6e 65 63 74 69 6f 6e 20 6d 75 73 74 20 6e 6f  nnection must no
29380 74 20 68 61 76 65 20 62 65 65 6e 20 63 6c 6f 73  t have been clos
29390 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 65  ed..**.** The se
293a0 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 2c 20 22  cond argument, "
293b0 7a 53 71 6c 22 2c 20 69 73 20 74 68 65 20 73 74  zSql", is the st
293c0 61 74 65 6d 65 6e 74 20 74 6f 20 62 65 20 63 6f  atement to be co
293d0 6d 70 69 6c 65 64 2c 20 65 6e 63 6f 64 65 64 0a  mpiled, encoded.
293e0 2a 2a 20 61 73 20 65 69 74 68 65 72 20 55 54 46  ** as either UTF
293f0 2d 38 20 6f 72 20 55 54 46 2d 31 36 2e 20 20 54  -8 or UTF-16.  T
29400 68 65 20 73 71 6c 69 74 65 33 5f 70 72 65 70 61  he sqlite3_prepa
29410 72 65 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33  re() and sqlite3
29420 5f 70 72 65 70 61 72 65 5f 76 32 28 29 0a 2a 2a  _prepare_v2().**
29430 20 69 6e 74 65 72 66 61 63 65 73 20 75 73 65 20   interfaces use 
29440 55 54 46 2d 38 2c 20 61 6e 64 20 73 71 6c 69 74  UTF-8, and sqlit
29450 65 33 5f 70 72 65 70 61 72 65 31 36 28 29 20 61  e3_prepare16() a
29460 6e 64 20 73 71 6c 69 74 65 33 5f 70 72 65 70 61  nd sqlite3_prepa
29470 72 65 31 36 5f 76 32 28 29 0a 2a 2a 20 75 73 65  re16_v2().** use
29480 20 55 54 46 2d 31 36 2e 0a 2a 2a 0a 2a 2a 20 5e   UTF-16..**.** ^
29490 49 66 20 74 68 65 20 6e 42 79 74 65 20 61 72 67  If the nByte arg
294a0 75 6d 65 6e 74 20 69 73 20 6e 65 67 61 74 69 76  ument is negativ
294b0 65 2c 20 74 68 65 6e 20 7a 53 71 6c 20 69 73 20  e, then zSql is 
294c0 72 65 61 64 20 75 70 20 74 6f 20 74 68 65 0a 2a  read up to the.*
294d0 2a 20 66 69 72 73 74 20 7a 65 72 6f 20 74 65 72  * first zero ter
294e0 6d 69 6e 61 74 6f 72 2e 20 5e 49 66 20 6e 42 79  minator. ^If nBy
294f0 74 65 20 69 73 20 70 6f 73 69 74 69 76 65 2c 20  te is positive, 
29500 74 68 65 6e 20 69 74 20 69 73 20 74 68 65 0a 2a  then it is the.*
29510 2a 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65  * number of byte
29520 73 20 72 65 61 64 20 66 72 6f 6d 20 7a 53 71 6c  s read from zSql
29530 2e 20 20 5e 49 66 20 6e 42 79 74 65 20 69 73 20  .  ^If nByte is 
29540 7a 65 72 6f 2c 20 74 68 65 6e 20 6e 6f 20 70 72  zero, then no pr
29550 65 70 61 72 65 64 0a 2a 2a 20 73 74 61 74 65 6d  epared.** statem
29560 65 6e 74 20 69 73 20 67 65 6e 65 72 61 74 65 64  ent is generated
29570 2e 0a 2a 2a 20 49 66 20 74 68 65 20 63 61 6c 6c  ..** If the call
29580 65 72 20 6b 6e 6f 77 73 20 74 68 61 74 20 74 68  er knows that th
29590 65 20 73 75 70 70 6c 69 65 64 20 73 74 72 69 6e  e supplied strin
295a0 67 20 69 73 20 6e 75 6c 2d 74 65 72 6d 69 6e 61  g is nul-termina
295b0 74 65 64 2c 20 74 68 65 6e 0a 2a 2a 20 74 68 65  ted, then.** the
295c0 72 65 20 69 73 20 61 20 73 6d 61 6c 6c 20 70 65  re is a small pe
295d0 72 66 6f 72 6d 61 6e 63 65 20 61 64 76 61 6e 74  rformance advant
295e0 61 67 65 20 74 6f 20 70 61 73 73 69 6e 67 20 61  age to passing a
295f0 6e 20 6e 42 79 74 65 20 70 61 72 61 6d 65 74 65  n nByte paramete
29600 72 20 74 68 61 74 0a 2a 2a 20 69 73 20 74 68 65  r that.** is the
29610 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73   number of bytes
29620 20 69 6e 20 74 68 65 20 69 6e 70 75 74 20 73 74   in the input st
29630 72 69 6e 67 20 3c 69 3e 69 6e 63 6c 75 64 69 6e  ring <i>includin
29640 67 3c 2f 69 3e 0a 2a 2a 20 74 68 65 20 6e 75 6c  g</i>.** the nul
29650 2d 74 65 72 6d 69 6e 61 74 6f 72 2e 0a 2a 2a 0a  -terminator..**.
29660 2a 2a 20 5e 49 66 20 70 7a 54 61 69 6c 20 69 73  ** ^If pzTail is
29670 20 6e 6f 74 20 4e 55 4c 4c 20 74 68 65 6e 20 2a   not NULL then *
29680 70 7a 54 61 69 6c 20 69 73 20 6d 61 64 65 20 74  pzTail is made t
29690 6f 20 70 6f 69 6e 74 20 74 6f 20 74 68 65 20 66  o point to the f
296a0 69 72 73 74 20 62 79 74 65 0a 2a 2a 20 70 61 73  irst byte.** pas
296b0 74 20 74 68 65 20 65 6e 64 20 6f 66 20 74 68 65  t the end of the
296c0 20 66 69 72 73 74 20 53 51 4c 20 73 74 61 74 65   first SQL state
296d0 6d 65 6e 74 20 69 6e 20 7a 53 71 6c 2e 20 20 54  ment in zSql.  T
296e0 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 6f 6e  hese routines on
296f0 6c 79 0a 2a 2a 20 63 6f 6d 70 69 6c 65 20 74 68  ly.** compile th
29700 65 20 66 69 72 73 74 20 73 74 61 74 65 6d 65 6e  e first statemen
29710 74 20 69 6e 20 7a 53 71 6c 2c 20 73 6f 20 2a 70  t in zSql, so *p
29720 7a 54 61 69 6c 20 69 73 20 6c 65 66 74 20 70 6f  zTail is left po
29730 69 6e 74 69 6e 67 20 74 6f 0a 2a 2a 20 77 68 61  inting to.** wha
29740 74 20 72 65 6d 61 69 6e 73 20 75 6e 63 6f 6d 70  t remains uncomp
29750 69 6c 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 2a 70 70  iled..**.** ^*pp
29760 53 74 6d 74 20 69 73 20 6c 65 66 74 20 70 6f 69  Stmt is left poi
29770 6e 74 69 6e 67 20 74 6f 20 61 20 63 6f 6d 70 69  nting to a compi
29780 6c 65 64 20 5b 70 72 65 70 61 72 65 64 20 73 74  led [prepared st
29790 61 74 65 6d 65 6e 74 5d 20 74 68 61 74 20 63 61  atement] that ca
297a0 6e 20 62 65 0a 2a 2a 20 65 78 65 63 75 74 65 64  n be.** executed
297b0 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f   using [sqlite3_
297c0 73 74 65 70 28 29 5d 2e 20 20 5e 49 66 20 74 68  step()].  ^If th
297d0 65 72 65 20 69 73 20 61 6e 20 65 72 72 6f 72 2c  ere is an error,
297e0 20 2a 70 70 53 74 6d 74 20 69 73 20 73 65 74 0a   *ppStmt is set.
297f0 2a 2a 20 74 6f 20 4e 55 4c 4c 2e 20 20 5e 49 66  ** to NULL.  ^If
29800 20 74 68 65 20 69 6e 70 75 74 20 74 65 78 74 20   the input text 
29810 63 6f 6e 74 61 69 6e 73 20 6e 6f 20 53 51 4c 20  contains no SQL 
29820 28 69 66 20 74 68 65 20 69 6e 70 75 74 20 69 73  (if the input is
29830 20 61 6e 20 65 6d 70 74 79 0a 2a 2a 20 73 74 72   an empty.** str
29840 69 6e 67 20 6f 72 20 61 20 63 6f 6d 6d 65 6e 74  ing or a comment
29850 29 20 74 68 65 6e 20 2a 70 70 53 74 6d 74 20 69  ) then *ppStmt i
29860 73 20 73 65 74 20 74 6f 20 4e 55 4c 4c 2e 0a 2a  s set to NULL..*
29870 2a 20 54 68 65 20 63 61 6c 6c 69 6e 67 20 70 72  * The calling pr
29880 6f 63 65 64 75 72 65 20 69 73 20 72 65 73 70 6f  ocedure is respo
29890 6e 73 69 62 6c 65 20 66 6f 72 20 64 65 6c 65 74  nsible for delet
298a0 69 6e 67 20 74 68 65 20 63 6f 6d 70 69 6c 65 64  ing the compiled
298b0 0a 2a 2a 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  .** SQL statemen
298c0 74 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33  t using [sqlite3
298d0 5f 66 69 6e 61 6c 69 7a 65 28 29 5d 20 61 66 74  _finalize()] aft
298e0 65 72 20 69 74 20 68 61 73 20 66 69 6e 69 73 68  er it has finish
298f0 65 64 20 77 69 74 68 20 69 74 2e 0a 2a 2a 20 70  ed with it..** p
29900 70 53 74 6d 74 20 6d 61 79 20 6e 6f 74 20 62 65  pStmt may not be
29910 20 4e 55 4c 4c 2e 0a 2a 2a 0a 2a 2a 20 5e 4f 6e   NULL..**.** ^On
29920 20 73 75 63 63 65 73 73 2c 20 74 68 65 20 73 71   success, the sq
29930 6c 69 74 65 33 5f 70 72 65 70 61 72 65 28 29 20  lite3_prepare() 
29940 66 61 6d 69 6c 79 20 6f 66 20 72 6f 75 74 69 6e  family of routin
29950 65 73 20 72 65 74 75 72 6e 20 5b 53 51 4c 49 54  es return [SQLIT
29960 45 5f 4f 4b 5d 3b 0a 2a 2a 20 6f 74 68 65 72 77  E_OK];.** otherw
29970 69 73 65 20 61 6e 20 5b 65 72 72 6f 72 20 63 6f  ise an [error co
29980 64 65 5d 20 69 73 20 72 65 74 75 72 6e 65 64 2e  de] is returned.
29990 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74  .**.** The sqlit
299a0 65 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29 20  e3_prepare_v2() 
299b0 61 6e 64 20 73 71 6c 69 74 65 33 5f 70 72 65 70  and sqlite3_prep
299c0 61 72 65 31 36 5f 76 32 28 29 20 69 6e 74 65 72  are16_v2() inter
299d0 66 61 63 65 73 20 61 72 65 0a 2a 2a 20 72 65 63  faces are.** rec
299e0 6f 6d 6d 65 6e 64 65 64 20 66 6f 72 20 61 6c 6c  ommended for all
299f0 20 6e 65 77 20 70 72 6f 67 72 61 6d 73 2e 20 54   new programs. T
29a00 68 65 20 74 77 6f 20 6f 6c 64 65 72 20 69 6e 74  he two older int
29a10 65 72 66 61 63 65 73 20 61 72 65 20 72 65 74 61  erfaces are reta
29a20 69 6e 65 64 0a 2a 2a 20 66 6f 72 20 62 61 63 6b  ined.** for back
29a30 77 61 72 64 73 20 63 6f 6d 70 61 74 69 62 69 6c  wards compatibil
29a40 69 74 79 2c 20 62 75 74 20 74 68 65 69 72 20 75  ity, but their u
29a50 73 65 20 69 73 20 64 69 73 63 6f 75 72 61 67 65  se is discourage
29a60 64 2e 0a 2a 2a 20 5e 49 6e 20 74 68 65 20 22 76  d..** ^In the "v
29a70 32 22 20 69 6e 74 65 72 66 61 63 65 73 2c 20 74  2" interfaces, t
29a80 68 65 20 70 72 65 70 61 72 65 64 20 73 74 61 74  he prepared stat
29a90 65 6d 65 6e 74 0a 2a 2a 20 74 68 61 74 20 69 73  ement.** that is
29aa0 20 72 65 74 75 72 6e 65 64 20 28 74 68 65 20 5b   returned (the [
29ab0 73 71 6c 69 74 65 33 5f 73 74 6d 74 5d 20 6f 62  sqlite3_stmt] ob
29ac0 6a 65 63 74 29 20 63 6f 6e 74 61 69 6e 73 20 61  ject) contains a
29ad0 20 63 6f 70 79 20 6f 66 20 74 68 65 0a 2a 2a 20   copy of the.** 
29ae0 6f 72 69 67 69 6e 61 6c 20 53 51 4c 20 74 65 78  original SQL tex
29af0 74 2e 20 54 68 69 73 20 63 61 75 73 65 73 20 74  t. This causes t
29b00 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70  he [sqlite3_step
29b10 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 74 6f  ()] interface to
29b20 0a 2a 2a 20 62 65 68 61 76 65 20 64 69 66 66 65  .** behave diffe
29b30 72 65 6e 74 6c 79 20 69 6e 20 74 68 72 65 65 20  rently in three 
29b40 77 61 79 73 3a 0a 2a 2a 0a 2a 2a 20 3c 6f 6c 3e  ways:.**.** <ol>
29b50 0a 2a 2a 20 3c 6c 69 3e 0a 2a 2a 20 5e 49 66 20  .** <li>.** ^If 
29b60 74 68 65 20 64 61 74 61 62 61 73 65 20 73 63 68  the database sch
29b70 65 6d 61 20 63 68 61 6e 67 65 73 2c 20 69 6e 73  ema changes, ins
29b80 74 65 61 64 20 6f 66 20 72 65 74 75 72 6e 69 6e  tead of returnin
29b90 67 20 5b 53 51 4c 49 54 45 5f 53 43 48 45 4d 41  g [SQLITE_SCHEMA
29ba0 5d 20 61 73 20 69 74 0a 2a 2a 20 61 6c 77 61 79  ] as it.** alway
29bb0 73 20 75 73 65 64 20 74 6f 20 64 6f 2c 20 5b 73  s used to do, [s
29bc0 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 77  qlite3_step()] w
29bd0 69 6c 6c 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c  ill automaticall
29be0 79 20 72 65 63 6f 6d 70 69 6c 65 20 74 68 65 20  y recompile the 
29bf0 53 51 4c 0a 2a 2a 20 73 74 61 74 65 6d 65 6e 74  SQL.** statement
29c00 20 61 6e 64 20 74 72 79 20 74 6f 20 72 75 6e 20   and try to run 
29c10 69 74 20 61 67 61 69 6e 2e 20 41 73 20 6d 61 6e  it again. As man
29c20 79 20 61 73 20 5b 53 51 4c 49 54 45 5f 4d 41 58  y as [SQLITE_MAX
29c30 5f 53 43 48 45 4d 41 5f 52 45 54 52 59 5d 0a 2a  _SCHEMA_RETRY].*
29c40 2a 20 72 65 74 72 69 65 73 20 77 69 6c 6c 20 6f  * retries will o
29c50 63 63 75 72 20 62 65 66 6f 72 65 20 73 71 6c 69  ccur before sqli
29c60 74 65 33 5f 73 74 65 70 28 29 20 67 69 76 65 73  te3_step() gives
29c70 20 75 70 20 61 6e 64 20 72 65 74 75 72 6e 73 20   up and returns 
29c80 61 6e 20 65 72 72 6f 72 2e 0a 2a 2a 20 3c 2f 6c  an error..** </l
29c90 69 3e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 0a 2a 2a  i>.**.** <li>.**
29ca0 20 5e 57 68 65 6e 20 61 6e 20 65 72 72 6f 72 20   ^When an error 
29cb0 6f 63 63 75 72 73 2c 20 5b 73 71 6c 69 74 65 33  occurs, [sqlite3
29cc0 5f 73 74 65 70 28 29 5d 20 77 69 6c 6c 20 72 65  _step()] will re
29cd0 74 75 72 6e 20 6f 6e 65 20 6f 66 20 74 68 65 20  turn one of the 
29ce0 64 65 74 61 69 6c 65 64 0a 2a 2a 20 5b 65 72 72  detailed.** [err
29cf0 6f 72 20 63 6f 64 65 73 5d 20 6f 72 20 5b 65 78  or codes] or [ex
29d00 74 65 6e 64 65 64 20 65 72 72 6f 72 20 63 6f 64  tended error cod
29d10 65 73 5d 2e 20 20 5e 54 68 65 20 6c 65 67 61 63  es].  ^The legac
29d20 79 20 62 65 68 61 76 69 6f 72 20 77 61 73 20 74  y behavior was t
29d30 68 61 74 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  hat.** [sqlite3_
29d40 73 74 65 70 28 29 5d 20 77 6f 75 6c 64 20 6f 6e  step()] would on
29d50 6c 79 20 72 65 74 75 72 6e 20 61 20 67 65 6e 65  ly return a gene
29d60 72 69 63 20 5b 53 51 4c 49 54 45 5f 45 52 52 4f  ric [SQLITE_ERRO
29d70 52 5d 20 72 65 73 75 6c 74 20 63 6f 64 65 0a 2a  R] result code.*
29d80 2a 20 61 6e 64 20 74 68 65 20 61 70 70 6c 69 63  * and the applic
29d90 61 74 69 6f 6e 20 77 6f 75 6c 64 20 68 61 76 65  ation would have
29da0 20 74 6f 20 6d 61 6b 65 20 61 20 73 65 63 6f 6e   to make a secon
29db0 64 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c 69 74  d call to [sqlit
29dc0 65 33 5f 72 65 73 65 74 28 29 5d 0a 2a 2a 20 69  e3_reset()].** i
29dd0 6e 20 6f 72 64 65 72 20 74 6f 20 66 69 6e 64 20  n order to find 
29de0 74 68 65 20 75 6e 64 65 72 6c 79 69 6e 67 20 63  the underlying c
29df0 61 75 73 65 20 6f 66 20 74 68 65 20 70 72 6f 62  ause of the prob
29e00 6c 65 6d 2e 20 57 69 74 68 20 74 68 65 20 22 76  lem. With the "v
29e10 32 22 20 70 72 65 70 61 72 65 0a 2a 2a 20 69 6e  2" prepare.** in
29e20 74 65 72 66 61 63 65 73 2c 20 74 68 65 20 75 6e  terfaces, the un
29e30 64 65 72 6c 79 69 6e 67 20 72 65 61 73 6f 6e 20  derlying reason 
29e40 66 6f 72 20 74 68 65 20 65 72 72 6f 72 20 69 73  for the error is
29e50 20 72 65 74 75 72 6e 65 64 20 69 6d 6d 65 64 69   returned immedi
29e60 61 74 65 6c 79 2e 0a 2a 2a 20 3c 2f 6c 69 3e 0a  ately..** </li>.
29e70 2a 2a 0a 2a 2a 20 3c 6c 69 3e 0a 2a 2a 20 5e 49  **.** <li>.** ^I
29e80 66 20 74 68 65 20 73 70 65 63 69 66 69 63 20 76  f the specific v
29e90 61 6c 75 65 20 62 6f 75 6e 64 20 74 6f 20 5b 70  alue bound to [p
29ea0 61 72 61 6d 65 74 65 72 20 7c 20 68 6f 73 74 20  arameter | host 
29eb0 70 61 72 61 6d 65 74 65 72 5d 20 69 6e 20 74 68  parameter] in th
29ec0 65 20 0a 2a 2a 20 57 48 45 52 45 20 63 6c 61 75  e .** WHERE clau
29ed0 73 65 20 6d 69 67 68 74 20 69 6e 66 6c 75 65 6e  se might influen
29ee0 63 65 20 74 68 65 20 63 68 6f 69 63 65 20 6f 66  ce the choice of
29ef0 20 71 75 65 72 79 20 70 6c 61 6e 20 66 6f 72 20   query plan for 
29f00 61 20 73 74 61 74 65 6d 65 6e 74 2c 0a 2a 2a 20  a statement,.** 
29f10 74 68 65 6e 20 74 68 65 20 73 74 61 74 65 6d 65  then the stateme
29f20 6e 74 20 77 69 6c 6c 20 62 65 20 61 75 74 6f 6d  nt will be autom
29f30 61 74 69 63 61 6c 6c 79 20 72 65 63 6f 6d 70 69  atically recompi
29f40 6c 65 64 2c 20 61 73 20 69 66 20 74 68 65 72 65  led, as if there
29f50 20 68 61 64 20 62 65 65 6e 20 0a 2a 2a 20 61 20   had been .** a 
29f60 73 63 68 65 6d 61 20 63 68 61 6e 67 65 2c 20 6f  schema change, o
29f70 6e 20 74 68 65 20 66 69 72 73 74 20 20 5b 73 71  n the first  [sq
29f80 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 63 61  lite3_step()] ca
29f90 6c 6c 20 66 6f 6c 6c 6f 77 69 6e 67 20 61 6e 79  ll following any
29fa0 20 63 68 61 6e 67 65 0a 2a 2a 20 74 6f 20 74 68   change.** to th
29fb0 65 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  e [sqlite3_bind_
29fc0 74 65 78 74 20 7c 20 62 69 6e 64 69 6e 67 73 5d  text | bindings]
29fd0 20 6f 66 20 74 68 61 74 20 5b 70 61 72 61 6d 65   of that [parame
29fe0 74 65 72 5d 2e 20 0a 2a 2a 20 5e 54 68 65 20 73  ter]. .** ^The s
29ff0 70 65 63 69 66 69 63 20 76 61 6c 75 65 20 6f 66  pecific value of
2a000 20 57 48 45 52 45 2d 63 6c 61 75 73 65 20 5b 70   WHERE-clause [p
2a010 61 72 61 6d 65 74 65 72 5d 20 6d 69 67 68 74 20  arameter] might 
2a020 69 6e 66 6c 75 65 6e 63 65 20 74 68 65 20 0a 2a  influence the .*
2a030 2a 20 63 68 6f 69 63 65 20 6f 66 20 71 75 65 72  * choice of quer
2a040 79 20 70 6c 61 6e 20 69 66 20 74 68 65 20 70 61  y plan if the pa
2a050 72 61 6d 65 74 65 72 20 69 73 20 74 68 65 20 6c  rameter is the l
2a060 65 66 74 2d 68 61 6e 64 20 73 69 64 65 20 6f 66  eft-hand side of
2a070 20 61 20 5b 4c 49 4b 45 5d 0a 2a 2a 20 6f 72 20   a [LIKE].** or 
2a080 5b 47 4c 4f 42 5d 20 6f 70 65 72 61 74 6f 72 20  [GLOB] operator 
2a090 6f 72 20 69 66 20 74 68 65 20 70 61 72 61 6d 65  or if the parame
2a0a0 74 65 72 20 69 73 20 63 6f 6d 70 61 72 65 64 20  ter is compared 
2a0b0 74 6f 20 61 6e 20 69 6e 64 65 78 65 64 20 63 6f  to an indexed co
2a0c0 6c 75 6d 6e 0a 2a 2a 20 61 6e 64 20 74 68 65 20  lumn.** and the 
2a0d0 5b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 53  [SQLITE_ENABLE_S
2a0e0 54 41 54 33 5d 20 63 6f 6d 70 69 6c 65 2d 74 69  TAT3] compile-ti
2a0f0 6d 65 20 6f 70 74 69 6f 6e 20 69 73 20 65 6e 61  me option is ena
2a100 62 6c 65 64 2e 0a 2a 2a 20 3c 2f 6c 69 3e 0a 2a  bled..** </li>.*
2a110 2a 20 3c 2f 6f 6c 3e 0a 2a 2f 0a 69 6e 74 20 73  * </ol>.*/.int s
2a120 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 28 0a  qlite3_prepare(.
2a130 20 20 73 71 6c 69 74 65 33 20 2a 64 62 2c 20 20    sqlite3 *db,  
2a140 20 20 20 20 20 20 20 20 20 20 2f 2a 20 44 61 74            /* Dat
2a150 61 62 61 73 65 20 68 61 6e 64 6c 65 20 2a 2f 0a  abase handle */.
2a160 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 53    const char *zS
2a170 71 6c 2c 20 20 20 20 20 20 20 2f 2a 20 53 51 4c  ql,       /* SQL
2a180 20 73 74 61 74 65 6d 65 6e 74 2c 20 55 54 46 2d   statement, UTF-
2a190 38 20 65 6e 63 6f 64 65 64 20 2a 2f 0a 20 20 69  8 encoded */.  i
2a1a0 6e 74 20 6e 42 79 74 65 2c 20 20 20 20 20 20 20  nt nByte,       
2a1b0 20 20 20 20 20 20 20 2f 2a 20 4d 61 78 69 6d 75         /* Maximu
2a1c0 6d 20 6c 65 6e 67 74 68 20 6f 66 20 7a 53 71 6c  m length of zSql
2a1d0 20 69 6e 20 62 79 74 65 73 2e 20 2a 2f 0a 20 20   in bytes. */.  
2a1e0 73 71 6c 69 74 65 33 5f 73 74 6d 74 20 2a 2a 70  sqlite3_stmt **p
2a1f0 70 53 74 6d 74 2c 20 20 2f 2a 20 4f 55 54 3a 20  pStmt,  /* OUT: 
2a200 53 74 61 74 65 6d 65 6e 74 20 68 61 6e 64 6c 65  Statement handle
2a210 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 63 68 61 72   */.  const char
2a220 20 2a 2a 70 7a 54 61 69 6c 20 20 20 20 20 2f 2a   **pzTail     /*
2a230 20 4f 55 54 3a 20 50 6f 69 6e 74 65 72 20 74 6f   OUT: Pointer to
2a240 20 75 6e 75 73 65 64 20 70 6f 72 74 69 6f 6e 20   unused portion 
2a250 6f 66 20 7a 53 71 6c 20 2a 2f 0a 29 3b 0a 69 6e  of zSql */.);.in
2a260 74 20 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72  t sqlite3_prepar
2a270 65 5f 76 32 28 0a 20 20 73 71 6c 69 74 65 33 20  e_v2(.  sqlite3 
2a280 2a 64 62 2c 20 20 20 20 20 20 20 20 20 20 20 20  *db,            
2a290 2f 2a 20 44 61 74 61 62 61 73 65 20 68 61 6e 64  /* Database hand
2a2a0 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 63 68  le */.  const ch
2a2b0 61 72 20 2a 7a 53 71 6c 2c 20 20 20 20 20 20 20  ar *zSql,       
2a2c0 2f 2a 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  /* SQL statement
2a2d0 2c 20 55 54 46 2d 38 20 65 6e 63 6f 64 65 64 20  , UTF-8 encoded 
2a2e0 2a 2f 0a 20 20 69 6e 74 20 6e 42 79 74 65 2c 20  */.  int nByte, 
2a2f0 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
2a300 4d 61 78 69 6d 75 6d 20 6c 65 6e 67 74 68 20 6f  Maximum length o
2a310 66 20 7a 53 71 6c 20 69 6e 20 62 79 74 65 73 2e  f zSql in bytes.
2a320 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33 5f 73 74   */.  sqlite3_st
2a330 6d 74 20 2a 2a 70 70 53 74 6d 74 2c 20 20 2f 2a  mt **ppStmt,  /*
2a340 20 4f 55 54 3a 20 53 74 61 74 65 6d 65 6e 74 20   OUT: Statement 
2a350 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73  handle */.  cons
2a360 74 20 63 68 61 72 20 2a 2a 70 7a 54 61 69 6c 20  t char **pzTail 
2a370 20 20 20 20 2f 2a 20 4f 55 54 3a 20 50 6f 69 6e      /* OUT: Poin
2a380 74 65 72 20 74 6f 20 75 6e 75 73 65 64 20 70 6f  ter to unused po
2a390 72 74 69 6f 6e 20 6f 66 20 7a 53 71 6c 20 2a 2f  rtion of zSql */
2a3a0 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .);.int sqlite3_
2a3b0 70 72 65 70 61 72 65 31 36 28 0a 20 20 73 71 6c  prepare16(.  sql
2a3c0 69 74 65 33 20 2a 64 62 2c 20 20 20 20 20 20 20  ite3 *db,       
2a3d0 20 20 20 20 20 2f 2a 20 44 61 74 61 62 61 73 65       /* Database
2a3e0 20 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 63 6f 6e   handle */.  con
2a3f0 73 74 20 76 6f 69 64 20 2a 7a 53 71 6c 2c 20 20  st void *zSql,  
2a400 20 20 20 20 20 2f 2a 20 53 51 4c 20 73 74 61 74       /* SQL stat
2a410 65 6d 65 6e 74 2c 20 55 54 46 2d 31 36 20 65 6e  ement, UTF-16 en
2a420 63 6f 64 65 64 20 2a 2f 0a 20 20 69 6e 74 20 6e  coded */.  int n
2a430 42 79 74 65 2c 20 20 20 20 20 20 20 20 20 20 20  Byte,           
2a440 20 20 20 2f 2a 20 4d 61 78 69 6d 75 6d 20 6c 65     /* Maximum le
2a450 6e 67 74 68 20 6f 66 20 7a 53 71 6c 20 69 6e 20  ngth of zSql in 
2a460 62 79 74 65 73 2e 20 2a 2f 0a 20 20 73 71 6c 69  bytes. */.  sqli
2a470 74 65 33 5f 73 74 6d 74 20 2a 2a 70 70 53 74 6d  te3_stmt **ppStm
2a480 74 2c 20 20 2f 2a 20 4f 55 54 3a 20 53 74 61 74  t,  /* OUT: Stat
2a490 65 6d 65 6e 74 20 68 61 6e 64 6c 65 20 2a 2f 0a  ement handle */.
2a4a0 20 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a 2a 70    const void **p
2a4b0 7a 54 61 69 6c 20 20 20 20 20 2f 2a 20 4f 55 54  zTail     /* OUT
2a4c0 3a 20 50 6f 69 6e 74 65 72 20 74 6f 20 75 6e 75  : Pointer to unu
2a4d0 73 65 64 20 70 6f 72 74 69 6f 6e 20 6f 66 20 7a  sed portion of z
2a4e0 53 71 6c 20 2a 2f 0a 29 3b 0a 69 6e 74 20 73 71  Sql */.);.int sq
2a4f0 6c 69 74 65 33 5f 70 72 65 70 61 72 65 31 36 5f  lite3_prepare16_
2a500 76 32 28 0a 20 20 73 71 6c 69 74 65 33 20 2a 64  v2(.  sqlite3 *d
2a510 62 2c 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a  b,            /*
2a520 20 44 61 74 61 62 61 73 65 20 68 61 6e 64 6c 65   Database handle
2a530 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 76 6f 69 64   */.  const void
2a540 20 2a 7a 53 71 6c 2c 20 20 20 20 20 20 20 2f 2a   *zSql,       /*
2a550 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2c 20   SQL statement, 
2a560 55 54 46 2d 31 36 20 65 6e 63 6f 64 65 64 20 2a  UTF-16 encoded *
2a570 2f 0a 20 20 69 6e 74 20 6e 42 79 74 65 2c 20 20  /.  int nByte,  
2a580 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 4d              /* M
2a590 61 78 69 6d 75 6d 20 6c 65 6e 67 74 68 20 6f 66  aximum length of
2a5a0 20 7a 53 71 6c 20 69 6e 20 62 79 74 65 73 2e 20   zSql in bytes. 
2a5b0 2a 2f 0a 20 20 73 71 6c 69 74 65 33 5f 73 74 6d  */.  sqlite3_stm
2a5c0 74 20 2a 2a 70 70 53 74 6d 74 2c 20 20 2f 2a 20  t **ppStmt,  /* 
2a5d0 4f 55 54 3a 20 53 74 61 74 65 6d 65 6e 74 20 68  OUT: Statement h
2a5e0 61 6e 64 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73 74  andle */.  const
2a5f0 20 76 6f 69 64 20 2a 2a 70 7a 54 61 69 6c 20 20   void **pzTail  
2a600 20 20 20 2f 2a 20 4f 55 54 3a 20 50 6f 69 6e 74     /* OUT: Point
2a610 65 72 20 74 6f 20 75 6e 75 73 65 64 20 70 6f 72  er to unused por
2a620 74 69 6f 6e 20 6f 66 20 7a 53 71 6c 20 2a 2f 0a  tion of zSql */.
2a630 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
2a640 45 46 3a 20 52 65 74 72 69 65 76 69 6e 67 20 53  EF: Retrieving S
2a650 74 61 74 65 6d 65 6e 74 20 53 51 4c 0a 2a 2a 20  tatement SQL.** 
2a660 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f  METHOD: sqlite3_
2a670 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  stmt.**.** ^The 
2a680 73 71 6c 69 74 65 33 5f 73 71 6c 28 50 29 20 69  sqlite3_sql(P) i
2a690 6e 74 65 72 66 61 63 65 20 72 65 74 75 72 6e 73  nterface returns
2a6a0 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20   a pointer to a 
2a6b0 63 6f 70 79 20 6f 66 20 74 68 65 20 55 54 46 2d  copy of the UTF-
2a6c0 38 0a 2a 2a 20 53 51 4c 20 74 65 78 74 20 75 73  8.** SQL text us
2a6d0 65 64 20 74 6f 20 63 72 65 61 74 65 20 5b 70 72  ed to create [pr
2a6e0 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
2a6f0 5d 20 50 20 69 66 20 50 20 77 61 73 0a 2a 2a 20  ] P if P was.** 
2a700 63 72 65 61 74 65 64 20 62 79 20 65 69 74 68 65  created by eithe
2a710 72 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61  r [sqlite3_prepa
2a720 72 65 5f 76 32 28 29 5d 20 6f 72 20 5b 73 71 6c  re_v2()] or [sql
2a730 69 74 65 33 5f 70 72 65 70 61 72 65 31 36 5f 76  ite3_prepare16_v
2a740 32 28 29 5d 2e 0a 2a 2a 20 5e 54 68 65 20 73 71  2()]..** ^The sq
2a750 6c 69 74 65 33 5f 65 78 70 61 6e 64 65 64 5f 73  lite3_expanded_s
2a760 71 6c 28 50 29 20 69 6e 74 65 72 66 61 63 65 20  ql(P) interface 
2a770 72 65 74 75 72 6e 73 20 61 20 70 6f 69 6e 74 65  returns a pointe
2a780 72 20 74 6f 20 61 20 55 54 46 2d 38 0a 2a 2a 20  r to a UTF-8.** 
2a790 73 74 72 69 6e 67 20 63 6f 6e 74 61 69 6e 69 6e  string containin
2a7a0 67 20 74 68 65 20 53 51 4c 20 74 65 78 74 20 6f  g the SQL text o
2a7b0 66 20 70 72 65 70 61 72 65 64 20 73 74 61 74 65  f prepared state
2a7c0 6d 65 6e 74 20 50 20 77 69 74 68 0a 2a 2a 20 5b  ment P with.** [
2a7d0 62 6f 75 6e 64 20 70 61 72 61 6d 65 74 65 72 73  bound parameters
2a7e0 5d 20 65 78 70 61 6e 64 65 64 2e 0a 2a 2a 0a 2a  ] expanded..**.*
2a7f0 2a 20 5e 28 46 6f 72 20 65 78 61 6d 70 6c 65 2c  * ^(For example,
2a800 20 69 66 20 61 20 70 72 65 70 61 72 65 64 20 73   if a prepared s
2a810 74 61 74 65 6d 65 6e 74 20 69 73 20 63 72 65 61  tatement is crea
2a820 74 65 64 20 75 73 69 6e 67 20 74 68 65 20 53 51  ted using the SQ
2a830 4c 0a 2a 2a 20 74 65 78 74 20 22 53 45 4c 45 43  L.** text "SELEC
2a840 54 20 24 61 62 63 2c 3a 78 79 7a 22 20 61 6e 64  T $abc,:xyz" and
2a850 20 69 66 20 70 61 72 61 6d 65 74 65 72 20 24 61   if parameter $a
2a860 62 63 20 69 73 20 62 6f 75 6e 64 20 74 6f 20 69  bc is bound to i
2a870 6e 74 65 67 65 72 20 32 33 34 35 0a 2a 2a 20 61  nteger 2345.** a
2a880 6e 64 20 70 61 72 61 6d 65 74 65 72 20 3a 78 79  nd parameter :xy
2a890 7a 20 69 73 20 75 6e 62 6f 75 6e 64 2c 20 74 68  z is unbound, th
2a8a0 65 6e 20 73 71 6c 69 74 65 33 5f 73 71 6c 28 29  en sqlite3_sql()
2a8b0 20 77 69 6c 6c 20 72 65 74 75 72 6e 0a 2a 2a 20   will return.** 
2a8c0 74 68 65 20 6f 72 69 67 69 6e 61 6c 20 73 74 72  the original str
2a8d0 69 6e 67 2c 20 22 53 45 4c 45 43 54 20 24 61 62  ing, "SELECT $ab
2a8e0 63 2c 3a 78 79 7a 22 20 62 75 74 20 73 71 6c 69  c,:xyz" but sqli
2a8f0 74 65 33 5f 65 78 70 61 6e 64 65 64 5f 73 71 6c  te3_expanded_sql
2a900 28 29 0a 2a 2a 20 77 69 6c 6c 20 72 65 74 75 72  ().** will retur
2a910 6e 20 22 53 45 4c 45 43 54 20 32 33 34 35 2c 4e  n "SELECT 2345,N
2a920 55 4c 4c 22 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 54  ULL".)^.**.** ^T
2a930 68 65 20 73 71 6c 69 74 65 33 5f 65 78 70 61 6e  he sqlite3_expan
2a940 64 65 64 5f 73 71 6c 28 29 20 69 6e 74 65 72 66  ded_sql() interf
2a950 61 63 65 20 72 65 74 75 72 6e 73 20 4e 55 4c 4c  ace returns NULL
2a960 20 69 66 20 69 6e 73 75 66 66 69 63 69 65 6e 74   if insufficient
2a970 20 6d 65 6d 6f 72 79 0a 2a 2a 20 69 73 20 61 76   memory.** is av
2a980 61 69 6c 61 62 6c 65 20 74 6f 20 68 6f 6c 64 20  ailable to hold 
2a990 74 68 65 20 72 65 73 75 6c 74 2c 20 6f 72 20 69  the result, or i
2a9a0 66 20 74 68 65 20 72 65 73 75 6c 74 20 77 6f 75  f the result wou
2a9b0 6c 64 20 65 78 63 65 65 64 20 74 68 65 0a 2a 2a  ld exceed the.**
2a9c0 20 74 68 65 20 6d 61 78 69 6d 75 6d 20 73 74 72   the maximum str
2a9d0 69 6e 67 20 6c 65 6e 67 74 68 20 64 65 74 65 72  ing length deter
2a9e0 6d 69 6e 65 64 20 62 79 20 74 68 65 20 5b 53 51  mined by the [SQ
2a9f0 4c 49 54 45 5f 4c 49 4d 49 54 5f 4c 45 4e 47 54  LITE_LIMIT_LENGT
2aa00 48 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 5b  H]..**.** ^The [
2aa10 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 53 49 5a  SQLITE_TRACE_SIZ
2aa20 45 5f 4c 49 4d 49 54 5d 20 63 6f 6d 70 69 6c 65  E_LIMIT] compile
2aa30 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20 6c 69 6d  -time option lim
2aa40 69 74 73 20 74 68 65 20 73 69 7a 65 20 6f 66 0a  its the size of.
2aa50 2a 2a 20 62 6f 75 6e 64 20 70 61 72 61 6d 65 74  ** bound paramet
2aa60 65 72 20 65 78 70 61 6e 73 69 6f 6e 73 2e 20 20  er expansions.  
2aa70 5e 54 68 65 20 5b 53 51 4c 49 54 45 5f 4f 4d 49  ^The [SQLITE_OMI
2aa80 54 5f 54 52 41 43 45 5d 20 63 6f 6d 70 69 6c 65  T_TRACE] compile
2aa90 2d 74 69 6d 65 0a 2a 2a 20 6f 70 74 69 6f 6e 20  -time.** option 
2aaa0 63 61 75 73 65 73 20 73 71 6c 69 74 65 33 5f 65  causes sqlite3_e
2aab0 78 70 61 6e 64 65 64 5f 73 71 6c 28 29 20 74 6f  xpanded_sql() to
2aac0 20 61 6c 77 61 79 73 20 72 65 74 75 72 6e 20 4e   always return N
2aad0 55 4c 4c 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  ULL..**.** ^The 
2aae0 73 74 72 69 6e 67 20 72 65 74 75 72 6e 65 64 20  string returned 
2aaf0 62 79 20 73 71 6c 69 74 65 33 5f 73 71 6c 28 50  by sqlite3_sql(P
2ab00 29 20 69 73 20 6d 61 6e 61 67 65 64 20 62 79 20  ) is managed by 
2ab10 53 51 4c 69 74 65 20 61 6e 64 20 69 73 0a 2a 2a  SQLite and is.**
2ab20 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 66   automatically f
2ab30 72 65 65 64 20 77 68 65 6e 20 74 68 65 20 70 72  reed when the pr
2ab40 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
2ab50 20 69 73 20 66 69 6e 61 6c 69 7a 65 64 2e 0a 2a   is finalized..*
2ab60 2a 20 5e 54 68 65 20 73 74 72 69 6e 67 20 72 65  * ^The string re
2ab70 74 75 72 6e 65 64 20 62 79 20 73 71 6c 69 74 65  turned by sqlite
2ab80 33 5f 65 78 70 61 6e 64 65 64 5f 73 71 6c 28 50  3_expanded_sql(P
2ab90 29 2c 20 6f 6e 20 74 68 65 20 6f 74 68 65 72 20  ), on the other 
2aba0 68 61 6e 64 2c 0a 2a 2a 20 69 73 20 6f 62 74 61  hand,.** is obta
2abb0 69 6e 65 64 20 66 72 6f 6d 20 5b 73 71 6c 69 74  ined from [sqlit
2abc0 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 20 61 6e 64  e3_malloc()] and
2abd0 20 6d 75 73 74 20 62 65 20 66 72 65 65 20 62 79   must be free by
2abe0 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   the application
2abf0 0a 2a 2a 20 62 79 20 70 61 73 73 69 6e 67 20 69  .** by passing i
2ac00 74 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 66 72  t to [sqlite3_fr
2ac10 65 65 28 29 5d 2e 0a 2a 2f 0a 63 6f 6e 73 74 20  ee()]..*/.const 
2ac20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 73 71  char *sqlite3_sq
2ac30 6c 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 20 2a  l(sqlite3_stmt *
2ac40 70 53 74 6d 74 29 3b 0a 63 68 61 72 20 2a 73 71  pStmt);.char *sq
2ac50 6c 69 74 65 33 5f 65 78 70 61 6e 64 65 64 5f 73  lite3_expanded_s
2ac60 71 6c 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 20  ql(sqlite3_stmt 
2ac70 2a 70 53 74 6d 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20  *pStmt);../*.** 
2ac80 43 41 50 49 33 52 45 46 3a 20 44 65 74 65 72 6d  CAPI3REF: Determ
2ac90 69 6e 65 20 49 66 20 41 6e 20 53 51 4c 20 53 74  ine If An SQL St
2aca0 61 74 65 6d 65 6e 74 20 57 72 69 74 65 73 20 54  atement Writes T
2acb0 68 65 20 44 61 74 61 62 61 73 65 0a 2a 2a 20 4d  he Database.** M
2acc0 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73  ETHOD: sqlite3_s
2acd0 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  tmt.**.** ^The s
2ace0 71 6c 69 74 65 33 5f 73 74 6d 74 5f 72 65 61 64  qlite3_stmt_read
2acf0 6f 6e 6c 79 28 58 29 20 69 6e 74 65 72 66 61 63  only(X) interfac
2ad00 65 20 72 65 74 75 72 6e 73 20 74 72 75 65 20 28  e returns true (
2ad10 6e 6f 6e 2d 7a 65 72 6f 29 20 69 66 0a 2a 2a 20  non-zero) if.** 
2ad20 61 6e 64 20 6f 6e 6c 79 20 69 66 20 74 68 65 20  and only if the 
2ad30 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d  [prepared statem
2ad40 65 6e 74 5d 20 58 20 6d 61 6b 65 73 20 6e 6f 20  ent] X makes no 
2ad50 64 69 72 65 63 74 20 63 68 61 6e 67 65 73 20 74  direct changes t
2ad60 6f 0a 2a 2a 20 74 68 65 20 63 6f 6e 74 65 6e 74  o.** the content
2ad70 20 6f 66 20 74 68 65 20 64 61 74 61 62 61 73 65   of the database
2ad80 20 66 69 6c 65 2e 0a 2a 2a 0a 2a 2a 20 4e 6f 74   file..**.** Not
2ad90 65 20 74 68 61 74 20 5b 61 70 70 6c 69 63 61 74  e that [applicat
2ada0 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51 4c 20  ion-defined SQL 
2adb0 66 75 6e 63 74 69 6f 6e 73 5d 20 6f 72 0a 2a 2a  functions] or.**
2adc0 20 5b 76 69 72 74 75 61 6c 20 74 61 62 6c 65 73   [virtual tables
2add0 5d 20 6d 69 67 68 74 20 63 68 61 6e 67 65 20 74  ] might change t
2ade0 68 65 20 64 61 74 61 62 61 73 65 20 69 6e 64 69  he database indi
2adf0 72 65 63 74 6c 79 20 61 73 20 61 20 73 69 64 65  rectly as a side
2ae00 20 65 66 66 65 63 74 2e 20 20 0a 2a 2a 20 5e 28   effect.  .** ^(
2ae10 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20 69 66 20  For example, if 
2ae20 61 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 64  an application d
2ae30 65 66 69 6e 65 73 20 61 20 66 75 6e 63 74 69 6f  efines a functio
2ae40 6e 20 22 65 76 61 6c 28 29 22 20 74 68 61 74 20  n "eval()" that 
2ae50 0a 2a 2a 20 63 61 6c 6c 73 20 5b 73 71 6c 69 74  .** calls [sqlit
2ae60 65 33 5f 65 78 65 63 28 29 5d 2c 20 74 68 65 6e  e3_exec()], then
2ae70 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 53   the following S
2ae80 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 77 6f 75  QL statement wou
2ae90 6c 64 0a 2a 2a 20 63 68 61 6e 67 65 20 74 68 65  ld.** change the
2aea0 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 74   database file t
2aeb0 68 72 6f 75 67 68 20 73 69 64 65 2d 65 66 66 65  hrough side-effe
2aec0 63 74 73 3a 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63  cts:.**.** <bloc
2aed0 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 2a 2a 20  kquote><pre>.** 
2aee0 20 20 20 53 45 4c 45 43 54 20 65 76 61 6c 28 27     SELECT eval('
2aef0 44 45 4c 45 54 45 20 46 52 4f 4d 20 74 31 27 29  DELETE FROM t1')
2af00 20 46 52 4f 4d 20 74 32 3b 0a 2a 2a 20 3c 2f 70   FROM t2;.** </p
2af10 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e  re></blockquote>
2af20 0a 2a 2a 0a 2a 2a 20 42 75 74 20 62 65 63 61 75  .**.** But becau
2af30 73 65 20 74 68 65 20 5b 53 45 4c 45 43 54 5d 20  se the [SELECT] 
2af40 73 74 61 74 65 6d 65 6e 74 20 64 6f 65 73 20 6e  statement does n
2af50 6f 74 20 63 68 61 6e 67 65 20 74 68 65 20 64 61  ot change the da
2af60 74 61 62 61 73 65 20 66 69 6c 65 0a 2a 2a 20 64  tabase file.** d
2af70 69 72 65 63 74 6c 79 2c 20 73 71 6c 69 74 65 33  irectly, sqlite3
2af80 5f 73 74 6d 74 5f 72 65 61 64 6f 6e 6c 79 28 29  _stmt_readonly()
2af90 20 77 6f 75 6c 64 20 73 74 69 6c 6c 20 72 65 74   would still ret
2afa0 75 72 6e 20 74 72 75 65 2e 29 5e 0a 2a 2a 0a 2a  urn true.)^.**.*
2afb0 2a 20 5e 54 72 61 6e 73 61 63 74 69 6f 6e 20 63  * ^Transaction c
2afc0 6f 6e 74 72 6f 6c 20 73 74 61 74 65 6d 65 6e 74  ontrol statement
2afd0 73 20 73 75 63 68 20 61 73 20 5b 42 45 47 49 4e  s such as [BEGIN
2afe0 5d 2c 20 5b 43 4f 4d 4d 49 54 5d 2c 20 5b 52 4f  ], [COMMIT], [RO
2aff0 4c 4c 42 41 43 4b 5d 2c 0a 2a 2a 20 5b 53 41 56  LLBACK],.** [SAV
2b000 45 50 4f 49 4e 54 5d 2c 20 61 6e 64 20 5b 52 45  EPOINT], and [RE
2b010 4c 45 41 53 45 5d 20 63 61 75 73 65 20 73 71 6c  LEASE] cause sql
2b020 69 74 65 33 5f 73 74 6d 74 5f 72 65 61 64 6f 6e  ite3_stmt_readon
2b030 6c 79 28 29 20 74 6f 20 72 65 74 75 72 6e 20 74  ly() to return t
2b040 72 75 65 2c 0a 2a 2a 20 73 69 6e 63 65 20 74 68  rue,.** since th
2b050 65 20 73 74 61 74 65 6d 65 6e 74 73 20 74 68 65  e statements the
2b060 6d 73 65 6c 76 65 73 20 64 6f 20 6e 6f 74 20 61  mselves do not a
2b070 63 74 75 61 6c 6c 79 20 6d 6f 64 69 66 79 20 74  ctually modify t
2b080 68 65 20 64 61 74 61 62 61 73 65 20 62 75 74 0a  he database but.
2b090 2a 2a 20 72 61 74 68 65 72 20 74 68 65 79 20 63  ** rather they c
2b0a0 6f 6e 74 72 6f 6c 20 74 68 65 20 74 69 6d 69 6e  ontrol the timin
2b0b0 67 20 6f 66 20 77 68 65 6e 20 6f 74 68 65 72 20  g of when other 
2b0c0 73 74 61 74 65 6d 65 6e 74 73 20 6d 6f 64 69 66  statements modif
2b0d0 79 20 74 68 65 20 0a 2a 2a 20 64 61 74 61 62 61  y the .** databa
2b0e0 73 65 2e 20 20 5e 54 68 65 20 5b 41 54 54 41 43  se.  ^The [ATTAC
2b0f0 48 5d 20 61 6e 64 20 5b 44 45 54 41 43 48 5d 20  H] and [DETACH] 
2b100 73 74 61 74 65 6d 65 6e 74 73 20 61 6c 73 6f 20  statements also 
2b110 63 61 75 73 65 0a 2a 2a 20 73 71 6c 69 74 65 33  cause.** sqlite3
2b120 5f 73 74 6d 74 5f 72 65 61 64 6f 6e 6c 79 28 29  _stmt_readonly()
2b130 20 74 6f 20 72 65 74 75 72 6e 20 74 72 75 65 20   to return true 
2b140 73 69 6e 63 65 2c 20 77 68 69 6c 65 20 74 68 6f  since, while tho
2b150 73 65 20 73 74 61 74 65 6d 65 6e 74 73 0a 2a 2a  se statements.**
2b160 20 63 68 61 6e 67 65 20 74 68 65 20 63 6f 6e 66   change the conf
2b170 69 67 75 72 61 74 69 6f 6e 20 6f 66 20 61 20 64  iguration of a d
2b180 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
2b190 6f 6e 2c 20 74 68 65 79 20 64 6f 20 6e 6f 74 20  on, they do not 
2b1a0 6d 61 6b 65 20 0a 2a 2a 20 63 68 61 6e 67 65 73  make .** changes
2b1b0 20 74 6f 20 74 68 65 20 63 6f 6e 74 65 6e 74 20   to the content 
2b1c0 6f 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20  of the database 
2b1d0 66 69 6c 65 73 20 6f 6e 20 64 69 73 6b 2e 0a 2a  files on disk..*
2b1e0 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 73 74  /.int sqlite3_st
2b1f0 6d 74 5f 72 65 61 64 6f 6e 6c 79 28 73 71 6c 69  mt_readonly(sqli
2b200 74 65 33 5f 73 74 6d 74 20 2a 70 53 74 6d 74 29  te3_stmt *pStmt)
2b210 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
2b220 46 3a 20 44 65 74 65 72 6d 69 6e 65 20 49 66 20  F: Determine If 
2b230 41 20 50 72 65 70 61 72 65 64 20 53 74 61 74 65  A Prepared State
2b240 6d 65 6e 74 20 48 61 73 20 42 65 65 6e 20 52 65  ment Has Been Re
2b250 73 65 74 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73  set.** METHOD: s
2b260 71 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a  qlite3_stmt.**.*
2b270 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 73  * ^The sqlite3_s
2b280 74 6d 74 5f 62 75 73 79 28 53 29 20 69 6e 74 65  tmt_busy(S) inte
2b290 72 66 61 63 65 20 72 65 74 75 72 6e 73 20 74 72  rface returns tr
2b2a0 75 65 20 28 6e 6f 6e 2d 7a 65 72 6f 29 20 69 66  ue (non-zero) if
2b2b0 20 74 68 65 0a 2a 2a 20 5b 70 72 65 70 61 72 65   the.** [prepare
2b2c0 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 53 20 68  d statement] S h
2b2d0 61 73 20 62 65 65 6e 20 73 74 65 70 70 65 64 20  as been stepped 
2b2e0 61 74 20 6c 65 61 73 74 20 6f 6e 63 65 20 75 73  at least once us
2b2f0 69 6e 67 20 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  ing .** [sqlite3
2b300 5f 73 74 65 70 28 53 29 5d 20 62 75 74 20 68 61  _step(S)] but ha
2b310 73 20 6e 65 69 74 68 65 72 20 72 75 6e 20 74 6f  s neither run to
2b320 20 63 6f 6d 70 6c 65 74 69 6f 6e 20 28 72 65 74   completion (ret
2b330 75 72 6e 65 64 0a 2a 2a 20 5b 53 51 4c 49 54 45  urned.** [SQLITE
2b340 5f 44 4f 4e 45 5d 20 66 72 6f 6d 20 5b 73 71 6c  _DONE] from [sql
2b350 69 74 65 33 5f 73 74 65 70 28 53 29 5d 29 20 6e  ite3_step(S)]) n
2b360 6f 72 0a 2a 2a 20 62 65 65 6e 20 72 65 73 65 74  or.** been reset
2b370 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f   using [sqlite3_
2b380 72 65 73 65 74 28 53 29 5d 2e 20 20 5e 54 68 65  reset(S)].  ^The
2b390 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 5f 62 75   sqlite3_stmt_bu
2b3a0 73 79 28 53 29 0a 2a 2a 20 69 6e 74 65 72 66 61  sy(S).** interfa
2b3b0 63 65 20 72 65 74 75 72 6e 73 20 66 61 6c 73 65  ce returns false
2b3c0 20 69 66 20 53 20 69 73 20 61 20 4e 55 4c 4c 20   if S is a NULL 
2b3d0 70 6f 69 6e 74 65 72 2e 20 20 49 66 20 53 20 69  pointer.  If S i
2b3e0 73 20 6e 6f 74 20 61 20 0a 2a 2a 20 4e 55 4c 4c  s not a .** NULL
2b3f0 20 70 6f 69 6e 74 65 72 20 61 6e 64 20 69 73 20   pointer and is 
2b400 6e 6f 74 20 61 20 70 6f 69 6e 74 65 72 20 74 6f  not a pointer to
2b410 20 61 20 76 61 6c 69 64 20 5b 70 72 65 70 61 72   a valid [prepar
2b420 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 0a 2a 2a  ed statement].**
2b430 20 6f 62 6a 65 63 74 2c 20 74 68 65 6e 20 74 68   object, then th
2b440 65 20 62 65 68 61 76 69 6f 72 20 69 73 20 75 6e  e behavior is un
2b450 64 65 66 69 6e 65 64 20 61 6e 64 20 70 72 6f 62  defined and prob
2b460 61 62 6c 79 20 75 6e 64 65 73 69 72 61 62 6c 65  ably undesirable
2b470 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 69 6e 74  ..**.** This int
2b480 65 72 66 61 63 65 20 63 61 6e 20 62 65 20 75 73  erface can be us
2b490 65 64 20 69 6e 20 63 6f 6d 62 69 6e 61 74 69 6f  ed in combinatio
2b4a0 6e 20 5b 73 71 6c 69 74 65 33 5f 6e 65 78 74 5f  n [sqlite3_next_
2b4b0 73 74 6d 74 28 29 5d 0a 2a 2a 20 74 6f 20 6c 6f  stmt()].** to lo
2b4c0 63 61 74 65 20 61 6c 6c 20 70 72 65 70 61 72 65  cate all prepare
2b4d0 64 20 73 74 61 74 65 6d 65 6e 74 73 20 61 73 73  d statements ass
2b4e0 6f 63 69 61 74 65 64 20 77 69 74 68 20 61 20 64  ociated with a d
2b4f0 61 74 61 62 61 73 65 20 0a 2a 2a 20 63 6f 6e 6e  atabase .** conn
2b500 65 63 74 69 6f 6e 20 74 68 61 74 20 61 72 65 20  ection that are 
2b510 69 6e 20 6e 65 65 64 20 6f 66 20 62 65 69 6e 67  in need of being
2b520 20 72 65 73 65 74 2e 20 20 54 68 69 73 20 63 61   reset.  This ca
2b530 6e 20 62 65 20 75 73 65 64 2c 0a 2a 2a 20 66 6f  n be used,.** fo
2b540 72 20 65 78 61 6d 70 6c 65 2c 20 69 6e 20 64 69  r example, in di
2b550 61 67 6e 6f 73 74 69 63 20 72 6f 75 74 69 6e 65  agnostic routine
2b560 73 20 74 6f 20 73 65 61 72 63 68 20 66 6f 72 20  s to search for 
2b570 70 72 65 70 61 72 65 64 20 0a 2a 2a 20 73 74 61  prepared .** sta
2b580 74 65 6d 65 6e 74 73 20 74 68 61 74 20 61 72 65  tements that are
2b590 20 68 6f 6c 64 69 6e 67 20 61 20 74 72 61 6e 73   holding a trans
2b5a0 61 63 74 69 6f 6e 20 6f 70 65 6e 2e 0a 2a 2f 0a  action open..*/.
2b5b0 69 6e 74 20 73 71 6c 69 74 65 33 5f 73 74 6d 74  int sqlite3_stmt
2b5c0 5f 62 75 73 79 28 73 71 6c 69 74 65 33 5f 73 74  _busy(sqlite3_st
2b5d0 6d 74 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  mt*);../*.** CAP
2b5e0 49 33 52 45 46 3a 20 44 79 6e 61 6d 69 63 61 6c  I3REF: Dynamical
2b5f0 6c 79 20 54 79 70 65 64 20 56 61 6c 75 65 20 4f  ly Typed Value O
2b600 62 6a 65 63 74 0a 2a 2a 20 4b 45 59 57 4f 52 44  bject.** KEYWORD
2b610 53 3a 20 7b 70 72 6f 74 65 63 74 65 64 20 73 71  S: {protected sq
2b620 6c 69 74 65 33 5f 76 61 6c 75 65 7d 20 7b 75 6e  lite3_value} {un
2b630 70 72 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65  protected sqlite
2b640 33 5f 76 61 6c 75 65 7d 0a 2a 2a 0a 2a 2a 20 53  3_value}.**.** S
2b650 51 4c 69 74 65 20 75 73 65 73 20 74 68 65 20 73  QLite uses the s
2b660 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a  qlite3_value obj
2b670 65 63 74 20 74 6f 20 72 65 70 72 65 73 65 6e 74  ect to represent
2b680 20 61 6c 6c 20 76 61 6c 75 65 73 0a 2a 2a 20 74   all values.** t
2b690 68 61 74 20 63 61 6e 20 62 65 20 73 74 6f 72 65  hat can be store
2b6a0 64 20 69 6e 20 61 20 64 61 74 61 62 61 73 65 20  d in a database 
2b6b0 74 61 62 6c 65 2e 20 53 51 4c 69 74 65 20 75 73  table. SQLite us
2b6c0 65 73 20 64 79 6e 61 6d 69 63 20 74 79 70 69 6e  es dynamic typin
2b6d0 67 0a 2a 2a 20 66 6f 72 20 74 68 65 20 76 61 6c  g.** for the val
2b6e0 75 65 73 20 69 74 20 73 74 6f 72 65 73 2e 20 20  ues it stores.  
2b6f0 5e 56 61 6c 75 65 73 20 73 74 6f 72 65 64 20 69  ^Values stored i
2b700 6e 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20  n sqlite3_value 
2b710 6f 62 6a 65 63 74 73 0a 2a 2a 20 63 61 6e 20 62  objects.** can b
2b720 65 20 69 6e 74 65 67 65 72 73 2c 20 66 6c 6f 61  e integers, floa
2b730 74 69 6e 67 20 70 6f 69 6e 74 20 76 61 6c 75 65  ting point value
2b740 73 2c 20 73 74 72 69 6e 67 73 2c 20 42 4c 4f 42  s, strings, BLOB
2b750 73 2c 20 6f 72 20 4e 55 4c 4c 2e 0a 2a 2a 0a 2a  s, or NULL..**.*
2b760 2a 20 41 6e 20 73 71 6c 69 74 65 33 5f 76 61 6c  * An sqlite3_val
2b770 75 65 20 6f 62 6a 65 63 74 20 6d 61 79 20 62 65  ue object may be
2b780 20 65 69 74 68 65 72 20 22 70 72 6f 74 65 63 74   either "protect
2b790 65 64 22 20 6f 72 20 22 75 6e 70 72 6f 74 65 63  ed" or "unprotec
2b7a0 74 65 64 22 2e 0a 2a 2a 20 53 6f 6d 65 20 69 6e  ted"..** Some in
2b7b0 74 65 72 66 61 63 65 73 20 72 65 71 75 69 72 65  terfaces require
2b7c0 20 61 20 70 72 6f 74 65 63 74 65 64 20 73 71 6c   a protected sql
2b7d0 69 74 65 33 5f 76 61 6c 75 65 2e 20 20 4f 74 68  ite3_value.  Oth
2b7e0 65 72 20 69 6e 74 65 72 66 61 63 65 73 0a 2a 2a  er interfaces.**
2b7f0 20 77 69 6c 6c 20 61 63 63 65 70 74 20 65 69 74   will accept eit
2b800 68 65 72 20 61 20 70 72 6f 74 65 63 74 65 64 20  her a protected 
2b810 6f 72 20 61 6e 20 75 6e 70 72 6f 74 65 63 74 65  or an unprotecte
2b820 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2e  d sqlite3_value.
2b830 0a 2a 2a 20 45 76 65 72 79 20 69 6e 74 65 72 66  .** Every interf
2b840 61 63 65 20 74 68 61 74 20 61 63 63 65 70 74 73  ace that accepts
2b850 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 61   sqlite3_value a
2b860 72 67 75 6d 65 6e 74 73 20 73 70 65 63 69 66 69  rguments specifi
2b870 65 73 0a 2a 2a 20 77 68 65 74 68 65 72 20 6f 72  es.** whether or
2b880 20 6e 6f 74 20 69 74 20 72 65 71 75 69 72 65 73   not it requires
2b890 20 61 20 70 72 6f 74 65 63 74 65 64 20 73 71 6c   a protected sql
2b8a0 69 74 65 33 5f 76 61 6c 75 65 2e 20 20 54 68 65  ite3_value.  The
2b8b0 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c  .** [sqlite3_val
2b8c0 75 65 5f 64 75 70 28 29 5d 20 69 6e 74 65 72 66  ue_dup()] interf
2b8d0 61 63 65 20 63 61 6e 20 62 65 20 75 73 65 64 20  ace can be used 
2b8e0 74 6f 20 63 6f 6e 73 74 72 75 63 74 20 61 20 6e  to construct a n
2b8f0 65 77 20 0a 2a 2a 20 70 72 6f 74 65 63 74 65 64  ew .** protected
2b900 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 66   sqlite3_value f
2b910 72 6f 6d 20 61 6e 20 75 6e 70 72 6f 74 65 63 74  rom an unprotect
2b920 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  ed sqlite3_value
2b930 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 74 65 72 6d  ..**.** The term
2b940 73 20 22 70 72 6f 74 65 63 74 65 64 22 20 61 6e  s "protected" an
2b950 64 20 22 75 6e 70 72 6f 74 65 63 74 65 64 22 20  d "unprotected" 
2b960 72 65 66 65 72 20 74 6f 20 77 68 65 74 68 65 72  refer to whether
2b970 20 6f 72 20 6e 6f 74 0a 2a 2a 20 61 20 6d 75 74   or not.** a mut
2b980 65 78 20 69 73 20 68 65 6c 64 2e 20 20 41 6e 20  ex is held.  An 
2b990 69 6e 74 65 72 6e 61 6c 20 6d 75 74 65 78 20 69  internal mutex i
2b9a0 73 20 68 65 6c 64 20 66 6f 72 20 61 20 70 72 6f  s held for a pro
2b9b0 74 65 63 74 65 64 0a 2a 2a 20 73 71 6c 69 74 65  tected.** sqlite
2b9c0 33 5f 76 61 6c 75 65 20 6f 62 6a 65 63 74 20 62  3_value object b
2b9d0 75 74 20 6e 6f 20 6d 75 74 65 78 20 69 73 20 68  ut no mutex is h
2b9e0 65 6c 64 20 66 6f 72 20 61 6e 20 75 6e 70 72 6f  eld for an unpro
2b9f0 74 65 63 74 65 64 0a 2a 2a 20 73 71 6c 69 74 65  tected.** sqlite
2ba00 33 5f 76 61 6c 75 65 20 6f 62 6a 65 63 74 2e 20  3_value object. 
2ba10 20 49 66 20 53 51 4c 69 74 65 20 69 73 20 63 6f   If SQLite is co
2ba20 6d 70 69 6c 65 64 20 74 6f 20 62 65 20 73 69 6e  mpiled to be sin
2ba30 67 6c 65 2d 74 68 72 65 61 64 65 64 0a 2a 2a 20  gle-threaded.** 
2ba40 28 77 69 74 68 20 5b 53 51 4c 49 54 45 5f 54 48  (with [SQLITE_TH
2ba50 52 45 41 44 53 41 46 45 3d 30 5d 20 61 6e 64 20  READSAFE=0] and 
2ba60 77 69 74 68 20 5b 73 71 6c 69 74 65 33 5f 74 68  with [sqlite3_th
2ba70 72 65 61 64 73 61 66 65 28 29 5d 20 72 65 74 75  readsafe()] retu
2ba80 72 6e 69 6e 67 20 30 29 0a 2a 2a 20 6f 72 20 69  rning 0).** or i
2ba90 66 20 53 51 4c 69 74 65 20 69 73 20 72 75 6e 20  f SQLite is run 
2baa0 69 6e 20 6f 6e 65 20 6f 66 20 72 65 64 75 63 65  in one of reduce
2bab0 64 20 6d 75 74 65 78 20 6d 6f 64 65 73 20 0a 2a  d mutex modes .*
2bac0 2a 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47  * [SQLITE_CONFIG
2bad0 5f 53 49 4e 47 4c 45 54 48 52 45 41 44 5d 20 6f  _SINGLETHREAD] o
2bae0 72 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47  r [SQLITE_CONFIG
2baf0 5f 4d 55 4c 54 49 54 48 52 45 41 44 5d 0a 2a 2a  _MULTITHREAD].**
2bb00 20 74 68 65 6e 20 74 68 65 72 65 20 69 73 20 6e   then there is n
2bb10 6f 20 64 69 73 74 69 6e 63 74 69 6f 6e 20 62 65  o distinction be
2bb20 74 77 65 65 6e 20 70 72 6f 74 65 63 74 65 64 20  tween protected 
2bb30 61 6e 64 20 75 6e 70 72 6f 74 65 63 74 65 64 0a  and unprotected.
2bb40 2a 2a 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  ** sqlite3_value
2bb50 20 6f 62 6a 65 63 74 73 20 61 6e 64 20 74 68 65   objects and the
2bb60 79 20 63 61 6e 20 62 65 20 75 73 65 64 20 69 6e  y can be used in
2bb70 74 65 72 63 68 61 6e 67 65 61 62 6c 79 2e 20 20  terchangeably.  
2bb80 48 6f 77 65 76 65 72 2c 0a 2a 2a 20 66 6f 72 20  However,.** for 
2bb90 6d 61 78 69 6d 75 6d 20 63 6f 64 65 20 70 6f 72  maximum code por
2bba0 74 61 62 69 6c 69 74 79 20 69 74 20 69 73 20 72  tability it is r
2bbb0 65 63 6f 6d 6d 65 6e 64 65 64 20 74 68 61 74 20  ecommended that 
2bbc0 61 70 70 6c 69 63 61 74 69 6f 6e 73 0a 2a 2a 20  applications.** 
2bbd0 73 74 69 6c 6c 20 6d 61 6b 65 20 74 68 65 20 64  still make the d
2bbe0 69 73 74 69 6e 63 74 69 6f 6e 20 62 65 74 77 65  istinction betwe
2bbf0 65 6e 20 70 72 6f 74 65 63 74 65 64 20 61 6e 64  en protected and
2bc00 20 75 6e 70 72 6f 74 65 63 74 65 64 0a 2a 2a 20   unprotected.** 
2bc10 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f 62  sqlite3_value ob
2bc20 6a 65 63 74 73 20 65 76 65 6e 20 77 68 65 6e 20  jects even when 
2bc30 6e 6f 74 20 73 74 72 69 63 74 6c 79 20 72 65 71  not strictly req
2bc40 75 69 72 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  uired..**.** ^Th
2bc50 65 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20  e sqlite3_value 
2bc60 6f 62 6a 65 63 74 73 20 74 68 61 74 20 61 72 65  objects that are
2bc70 20 70 61 73 73 65 64 20 61 73 20 70 61 72 61 6d   passed as param
2bc80 65 74 65 72 73 20 69 6e 74 6f 20 74 68 65 0a 2a  eters into the.*
2bc90 2a 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  * implementation
2bca0 20 6f 66 20 5b 61 70 70 6c 69 63 61 74 69 6f 6e   of [application
2bcb0 2d 64 65 66 69 6e 65 64 20 53 51 4c 20 66 75 6e  -defined SQL fun
2bcc0 63 74 69 6f 6e 73 5d 20 61 72 65 20 70 72 6f 74  ctions] are prot
2bcd0 65 63 74 65 64 2e 0a 2a 2a 20 5e 54 68 65 20 73  ected..** ^The s
2bce0 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a  qlite3_value obj
2bcf0 65 63 74 20 72 65 74 75 72 6e 65 64 20 62 79 0a  ect returned by.
2bd00 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75  ** [sqlite3_colu
2bd10 6d 6e 5f 76 61 6c 75 65 28 29 5d 20 69 73 20 75  mn_value()] is u
2bd20 6e 70 72 6f 74 65 63 74 65 64 2e 0a 2a 2a 20 55  nprotected..** U
2bd30 6e 70 72 6f 74 65 63 74 65 64 20 73 71 6c 69 74  nprotected sqlit
2bd40 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65 63 74 73  e3_value objects
2bd50 20 6d 61 79 20 6f 6e 6c 79 20 62 65 20 75 73 65   may only be use
2bd60 64 20 77 69 74 68 0a 2a 2a 20 5b 73 71 6c 69 74  d with.** [sqlit
2bd70 65 33 5f 72 65 73 75 6c 74 5f 76 61 6c 75 65 28  e3_result_value(
2bd80 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f  )] and [sqlite3_
2bd90 62 69 6e 64 5f 76 61 6c 75 65 28 29 5d 2e 0a 2a  bind_value()]..*
2bda0 2a 20 54 68 65 20 5b 73 71 6c 69 74 65 33 5f 76  * The [sqlite3_v
2bdb0 61 6c 75 65 5f 62 6c 6f 62 20 7c 20 73 71 6c 69  alue_blob | sqli
2bdc0 74 65 33 5f 76 61 6c 75 65 5f 74 79 70 65 28 29  te3_value_type()
2bdd0 5d 20 66 61 6d 69 6c 79 20 6f 66 0a 2a 2a 20 69  ] family of.** i
2bde0 6e 74 65 72 66 61 63 65 73 20 72 65 71 75 69 72  nterfaces requir
2bdf0 65 20 70 72 6f 74 65 63 74 65 64 20 73 71 6c 69  e protected sqli
2be00 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65 63 74  te3_value object
2be10 73 2e 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73 74  s..*/.typedef st
2be20 72 75 63 74 20 4d 65 6d 20 73 71 6c 69 74 65 33  ruct Mem sqlite3
2be30 5f 76 61 6c 75 65 3b 0a 0a 2f 2a 0a 2a 2a 20 43  _value;../*.** C
2be40 41 50 49 33 52 45 46 3a 20 53 51 4c 20 46 75 6e  API3REF: SQL Fun
2be50 63 74 69 6f 6e 20 43 6f 6e 74 65 78 74 20 4f 62  ction Context Ob
2be60 6a 65 63 74 0a 2a 2a 0a 2a 2a 20 54 68 65 20 63  ject.**.** The c
2be70 6f 6e 74 65 78 74 20 69 6e 20 77 68 69 63 68 20  ontext in which 
2be80 61 6e 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20  an SQL function 
2be90 65 78 65 63 75 74 65 73 20 69 73 20 73 74 6f 72  executes is stor
2bea0 65 64 20 69 6e 20 61 6e 0a 2a 2a 20 73 71 6c 69  ed in an.** sqli
2beb0 74 65 33 5f 63 6f 6e 74 65 78 74 20 6f 62 6a 65  te3_context obje
2bec0 63 74 2e 20 20 5e 41 20 70 6f 69 6e 74 65 72 20  ct.  ^A pointer 
2bed0 74 6f 20 61 6e 20 73 71 6c 69 74 65 33 5f 63 6f  to an sqlite3_co
2bee0 6e 74 65 78 74 20 6f 62 6a 65 63 74 0a 2a 2a 20  ntext object.** 
2bef0 69 73 20 61 6c 77 61 79 73 20 66 69 72 73 74 20  is always first 
2bf00 70 61 72 61 6d 65 74 65 72 20 74 6f 20 5b 61 70  parameter to [ap
2bf10 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65  plication-define
2bf20 64 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 5d  d SQL functions]
2bf30 2e 0a 2a 2a 20 54 68 65 20 61 70 70 6c 69 63 61  ..** The applica
2bf40 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51 4c  tion-defined SQL
2bf50 20 66 75 6e 63 74 69 6f 6e 20 69 6d 70 6c 65 6d   function implem
2bf60 65 6e 74 61 74 69 6f 6e 20 77 69 6c 6c 20 70 61  entation will pa
2bf70 73 73 20 74 68 69 73 0a 2a 2a 20 70 6f 69 6e 74  ss this.** point
2bf80 65 72 20 74 68 72 6f 75 67 68 20 69 6e 74 6f 20  er through into 
2bf90 63 61 6c 6c 73 20 74 6f 20 5b 73 71 6c 69 74 65  calls to [sqlite
2bfa0 33 5f 72 65 73 75 6c 74 5f 69 6e 74 20 7c 20 73  3_result_int | s
2bfb0 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 28 29 5d  qlite3_result()]
2bfc0 2c 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 61 67  ,.** [sqlite3_ag
2bfd0 67 72 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28  gregate_context(
2bfe0 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 75 73 65  )], [sqlite3_use
2bff0 72 5f 64 61 74 61 28 29 5d 2c 0a 2a 2a 20 5b 73  r_data()],.** [s
2c000 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 5f 64  qlite3_context_d
2c010 62 5f 68 61 6e 64 6c 65 28 29 5d 2c 20 5b 73 71  b_handle()], [sq
2c020 6c 69 74 65 33 5f 67 65 74 5f 61 75 78 64 61 74  lite3_get_auxdat
2c030 61 28 29 5d 2c 0a 2a 2a 20 61 6e 64 2f 6f 72 20  a()],.** and/or 
2c040 5b 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78  [sqlite3_set_aux
2c050 64 61 74 61 28 29 5d 2e 0a 2a 2f 0a 74 79 70 65  data()]..*/.type
2c060 64 65 66 20 73 74 72 75 63 74 20 73 71 6c 69 74  def struct sqlit
2c070 65 33 5f 63 6f 6e 74 65 78 74 20 73 71 6c 69 74  e3_context sqlit
2c080 65 33 5f 63 6f 6e 74 65 78 74 3b 0a 0a 2f 2a 0a  e3_context;../*.
2c090 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 42 69 6e  ** CAPI3REF: Bin
2c0a0 64 69 6e 67 20 56 61 6c 75 65 73 20 54 6f 20 50  ding Values To P
2c0b0 72 65 70 61 72 65 64 20 53 74 61 74 65 6d 65 6e  repared Statemen
2c0c0 74 73 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20  ts.** KEYWORDS: 
2c0d0 7b 68 6f 73 74 20 70 61 72 61 6d 65 74 65 72 7d  {host parameter}
2c0e0 20 7b 68 6f 73 74 20 70 61 72 61 6d 65 74 65 72   {host parameter
2c0f0 73 7d 20 7b 68 6f 73 74 20 70 61 72 61 6d 65 74  s} {host paramet
2c100 65 72 20 6e 61 6d 65 7d 0a 2a 2a 20 4b 45 59 57  er name}.** KEYW
2c110 4f 52 44 53 3a 20 7b 53 51 4c 20 70 61 72 61 6d  ORDS: {SQL param
2c120 65 74 65 72 7d 20 7b 53 51 4c 20 70 61 72 61 6d  eter} {SQL param
2c130 65 74 65 72 73 7d 20 7b 70 61 72 61 6d 65 74 65  eters} {paramete
2c140 72 20 62 69 6e 64 69 6e 67 7d 0a 2a 2a 20 4d 45  r binding}.** ME
2c150 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73 74  THOD: sqlite3_st
2c160 6d 74 0a 2a 2a 0a 2a 2a 20 5e 28 49 6e 20 74 68  mt.**.** ^(In th
2c170 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20  e SQL statement 
2c180 74 65 78 74 20 69 6e 70 75 74 20 74 6f 20 5b 73  text input to [s
2c190 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76  qlite3_prepare_v
2c1a0 32 28 29 5d 20 61 6e 64 20 69 74 73 20 76 61 72  2()] and its var
2c1b0 69 61 6e 74 73 2c 0a 2a 2a 20 6c 69 74 65 72 61  iants,.** litera
2c1c0 6c 73 20 6d 61 79 20 62 65 20 72 65 70 6c 61 63  ls may be replac
2c1d0 65 64 20 62 79 20 61 20 5b 70 61 72 61 6d 65 74  ed by a [paramet
2c1e0 65 72 5d 20 74 68 61 74 20 6d 61 74 63 68 65 73  er] that matches
2c1f0 20 6f 6e 65 20 6f 66 20 66 6f 6c 6c 6f 77 69 6e   one of followin
2c200 67 0a 2a 2a 20 74 65 6d 70 6c 61 74 65 73 3a 0a  g.** templates:.
2c210 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c  **.** <ul>.** <l
2c220 69 3e 20 20 3f 0a 2a 2a 20 3c 6c 69 3e 20 20 3f  i>  ?.** <li>  ?
2c230 4e 4e 4e 0a 2a 2a 20 3c 6c 69 3e 20 20 3a 56 56  NNN.** <li>  :VV
2c240 56 0a 2a 2a 20 3c 6c 69 3e 20 20 40 56 56 56 0a  V.** <li>  @VVV.
2c250 2a 2a 20 3c 6c 69 3e 20 20 24 56 56 56 0a 2a 2a  ** <li>  $VVV.**
2c260 20 3c 2f 75 6c 3e 0a 2a 2a 0a 2a 2a 20 49 6e 20   </ul>.**.** In 
2c270 74 68 65 20 74 65 6d 70 6c 61 74 65 73 20 61 62  the templates ab
2c280 6f 76 65 2c 20 4e 4e 4e 20 72 65 70 72 65 73 65  ove, NNN represe
2c290 6e 74 73 20 61 6e 20 69 6e 74 65 67 65 72 20 6c  nts an integer l
2c2a0 69 74 65 72 61 6c 2c 0a 2a 2a 20 61 6e 64 20 56  iteral,.** and V
2c2b0 56 56 20 72 65 70 72 65 73 65 6e 74 73 20 61 6e  VV represents an
2c2c0 20 61 6c 70 68 61 6e 75 6d 65 72 69 63 20 69 64   alphanumeric id
2c2d0 65 6e 74 69 66 69 65 72 2e 29 5e 20 20 5e 54 68  entifier.)^  ^Th
2c2e0 65 20 76 61 6c 75 65 73 20 6f 66 20 74 68 65 73  e values of thes
2c2f0 65 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72 73 20  e.** parameters 
2c300 28 61 6c 73 6f 20 63 61 6c 6c 65 64 20 22 68 6f  (also called "ho
2c310 73 74 20 70 61 72 61 6d 65 74 65 72 20 6e 61 6d  st parameter nam
2c320 65 73 22 20 6f 72 20 22 53 51 4c 20 70 61 72 61  es" or "SQL para
2c330 6d 65 74 65 72 73 22 29 0a 2a 2a 20 63 61 6e 20  meters").** can 
2c340 62 65 20 73 65 74 20 75 73 69 6e 67 20 74 68 65  be set using the
2c350 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 2a 28   sqlite3_bind_*(
2c360 29 20 72 6f 75 74 69 6e 65 73 20 64 65 66 69 6e  ) routines defin
2c370 65 64 20 68 65 72 65 2e 0a 2a 2a 0a 2a 2a 20 5e  ed here..**.** ^
2c380 54 68 65 20 66 69 72 73 74 20 61 72 67 75 6d 65  The first argume
2c390 6e 74 20 74 6f 20 74 68 65 20 73 71 6c 69 74 65  nt to the sqlite
2c3a0 33 5f 62 69 6e 64 5f 2a 28 29 20 72 6f 75 74 69  3_bind_*() routi
2c3b0 6e 65 73 20 69 73 20 61 6c 77 61 79 73 0a 2a 2a  nes is always.**
2c3c0 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68   a pointer to th
2c3d0 65 20 5b 73 71 6c 69 74 65 33 5f 73 74 6d 74 5d  e [sqlite3_stmt]
2c3e0 20 6f 62 6a 65 63 74 20 72 65 74 75 72 6e 65 64   object returned
2c3f0 20 66 72 6f 6d 0a 2a 2a 20 5b 73 71 6c 69 74 65   from.** [sqlite
2c400 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d 20  3_prepare_v2()] 
2c410 6f 72 20 69 74 73 20 76 61 72 69 61 6e 74 73 2e  or its variants.
2c420 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 65 63 6f  .**.** ^The seco
2c430 6e 64 20 61 72 67 75 6d 65 6e 74 20 69 73 20 74  nd argument is t
2c440 68 65 20 69 6e 64 65 78 20 6f 66 20 74 68 65 20  he index of the 
2c450 53 51 4c 20 70 61 72 61 6d 65 74 65 72 20 74 6f  SQL parameter to
2c460 20 62 65 20 73 65 74 2e 0a 2a 2a 20 5e 54 68 65   be set..** ^The
2c470 20 6c 65 66 74 6d 6f 73 74 20 53 51 4c 20 70 61   leftmost SQL pa
2c480 72 61 6d 65 74 65 72 20 68 61 73 20 61 6e 20 69  rameter has an i
2c490 6e 64 65 78 20 6f 66 20 31 2e 20 20 5e 57 68 65  ndex of 1.  ^Whe
2c4a0 6e 20 74 68 65 20 73 61 6d 65 20 6e 61 6d 65 64  n the same named
2c4b0 0a 2a 2a 20 53 51 4c 20 70 61 72 61 6d 65 74 65  .** SQL paramete
2c4c0 72 20 69 73 20 75 73 65 64 20 6d 6f 72 65 20 74  r is used more t
2c4d0 68 61 6e 20 6f 6e 63 65 2c 20 73 65 63 6f 6e 64  han once, second
2c4e0 20 61 6e 64 20 73 75 62 73 65 71 75 65 6e 74 0a   and subsequent.
2c4f0 2a 2a 20 6f 63 63 75 72 72 65 6e 63 65 73 20 68  ** occurrences h
2c500 61 76 65 20 74 68 65 20 73 61 6d 65 20 69 6e 64  ave the same ind
2c510 65 78 20 61 73 20 74 68 65 20 66 69 72 73 74 20  ex as the first 
2c520 6f 63 63 75 72 72 65 6e 63 65 2e 0a 2a 2a 20 5e  occurrence..** ^
2c530 54 68 65 20 69 6e 64 65 78 20 66 6f 72 20 6e 61  The index for na
2c540 6d 65 64 20 70 61 72 61 6d 65 74 65 72 73 20 63  med parameters c
2c550 61 6e 20 62 65 20 6c 6f 6f 6b 65 64 20 75 70 20  an be looked up 
2c560 75 73 69 6e 67 20 74 68 65 0a 2a 2a 20 5b 73 71  using the.** [sq
2c570 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d  lite3_bind_param
2c580 65 74 65 72 5f 69 6e 64 65 78 28 29 5d 20 41 50  eter_index()] AP
2c590 49 20 69 66 20 64 65 73 69 72 65 64 2e 20 20 5e  I if desired.  ^
2c5a0 54 68 65 20 69 6e 64 65 78 0a 2a 2a 20 66 6f 72  The index.** for
2c5b0 20 22 3f 4e 4e 4e 22 20 70 61 72 61 6d 65 74 65   "?NNN" paramete
2c5c0 72 73 20 69 73 20 74 68 65 20 76 61 6c 75 65 20  rs is the value 
2c5d0 6f 66 20 4e 4e 4e 2e 0a 2a 2a 20 5e 54 68 65 20  of NNN..** ^The 
2c5e0 4e 4e 4e 20 76 61 6c 75 65 20 6d 75 73 74 20 62  NNN value must b
2c5f0 65 20 62 65 74 77 65 65 6e 20 31 20 61 6e 64 20  e between 1 and 
2c600 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 6c 69 6d  the [sqlite3_lim
2c610 69 74 28 29 5d 0a 2a 2a 20 70 61 72 61 6d 65 74  it()].** paramet
2c620 65 72 20 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54  er [SQLITE_LIMIT
2c630 5f 56 41 52 49 41 42 4c 45 5f 4e 55 4d 42 45 52  _VARIABLE_NUMBER
2c640 5d 20 28 64 65 66 61 75 6c 74 20 76 61 6c 75 65  ] (default value
2c650 3a 20 39 39 39 29 2e 0a 2a 2a 0a 2a 2a 20 5e 54  : 999)..**.** ^T
2c660 68 65 20 74 68 69 72 64 20 61 72 67 75 6d 65 6e  he third argumen
2c670 74 20 69 73 20 74 68 65 20 76 61 6c 75 65 20 74  t is the value t
2c680 6f 20 62 69 6e 64 20 74 6f 20 74 68 65 20 70 61  o bind to the pa
2c690 72 61 6d 65 74 65 72 2e 0a 2a 2a 20 5e 49 66 20  rameter..** ^If 
2c6a0 74 68 65 20 74 68 69 72 64 20 70 61 72 61 6d 65  the third parame
2c6b0 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 62  ter to sqlite3_b
2c6c0 69 6e 64 5f 74 65 78 74 28 29 20 6f 72 20 73 71  ind_text() or sq
2c6d0 6c 69 74 65 33 5f 62 69 6e 64 5f 74 65 78 74 31  lite3_bind_text1
2c6e0 36 28 29 0a 2a 2a 20 6f 72 20 73 71 6c 69 74 65  6().** or sqlite
2c6f0 33 5f 62 69 6e 64 5f 62 6c 6f 62 28 29 20 69 73  3_bind_blob() is
2c700 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20   a NULL pointer 
2c710 74 68 65 6e 20 74 68 65 20 66 6f 75 72 74 68 20  then the fourth 
2c720 70 61 72 61 6d 65 74 65 72 0a 2a 2a 20 69 73 20  parameter.** is 
2c730 69 67 6e 6f 72 65 64 20 61 6e 64 20 74 68 65 20  ignored and the 
2c740 65 6e 64 20 72 65 73 75 6c 74 20 69 73 20 74 68  end result is th
2c750 65 20 73 61 6d 65 20 61 73 20 73 71 6c 69 74 65  e same as sqlite
2c760 33 5f 62 69 6e 64 5f 6e 75 6c 6c 28 29 2e 0a 2a  3_bind_null()..*
2c770 2a 0a 2a 2a 20 5e 28 49 6e 20 74 68 6f 73 65 20  *.** ^(In those 
2c780 72 6f 75 74 69 6e 65 73 20 74 68 61 74 20 68 61  routines that ha
2c790 76 65 20 61 20 66 6f 75 72 74 68 20 61 72 67 75  ve a fourth argu
2c7a0 6d 65 6e 74 2c 20 69 74 73 20 76 61 6c 75 65 20  ment, its value 
2c7b0 69 73 20 74 68 65 0a 2a 2a 20 6e 75 6d 62 65 72  is the.** number
2c7c0 20 6f 66 20 62 79 74 65 73 20 69 6e 20 74 68 65   of bytes in the
2c7d0 20 70 61 72 61 6d 65 74 65 72 2e 20 20 54 6f 20   parameter.  To 
2c7e0 62 65 20 63 6c 65 61 72 3a 20 74 68 65 20 76 61  be clear: the va
2c7f0 6c 75 65 20 69 73 20 74 68 65 0a 2a 2a 20 6e 75  lue is the.** nu
2c800 6d 62 65 72 20 6f 66 20 3c 75 3e 62 79 74 65 73  mber of <u>bytes
2c810 3c 2f 75 3e 20 69 6e 20 74 68 65 20 76 61 6c 75  </u> in the valu
2c820 65 2c 20 6e 6f 74 20 74 68 65 20 6e 75 6d 62 65  e, not the numbe
2c830 72 20 6f 66 20 63 68 61 72 61 63 74 65 72 73 2e  r of characters.
2c840 29 5e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 66 6f  )^.** ^If the fo
2c850 75 72 74 68 20 70 61 72 61 6d 65 74 65 72 20 74  urth parameter t
2c860 6f 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74  o sqlite3_bind_t
2c870 65 78 74 28 29 20 6f 72 20 73 71 6c 69 74 65 33  ext() or sqlite3
2c880 5f 62 69 6e 64 5f 74 65 78 74 31 36 28 29 0a 2a  _bind_text16().*
2c890 2a 20 69 73 20 6e 65 67 61 74 69 76 65 2c 20 74  * is negative, t
2c8a0 68 65 6e 20 74 68 65 20 6c 65 6e 67 74 68 20 6f  hen the length o
2c8b0 66 20 74 68 65 20 73 74 72 69 6e 67 20 69 73 0a  f the string is.
2c8c0 2a 2a 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  ** the number of
2c8d0 20 62 79 74 65 73 20 75 70 20 74 6f 20 74 68 65   bytes up to the
2c8e0 20 66 69 72 73 74 20 7a 65 72 6f 20 74 65 72 6d   first zero term
2c8f0 69 6e 61 74 6f 72 2e 0a 2a 2a 20 49 66 20 74 68  inator..** If th
2c900 65 20 66 6f 75 72 74 68 20 70 61 72 61 6d 65 74  e fourth paramet
2c910 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 62 69  er to sqlite3_bi
2c920 6e 64 5f 62 6c 6f 62 28 29 20 69 73 20 6e 65 67  nd_blob() is neg
2c930 61 74 69 76 65 2c 20 74 68 65 6e 0a 2a 2a 20 74  ative, then.** t
2c940 68 65 20 62 65 68 61 76 69 6f 72 20 69 73 20 75  he behavior is u
2c950 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a 20 49 66 20  ndefined..** If 
2c960 61 20 6e 6f 6e 2d 6e 65 67 61 74 69 76 65 20 66  a non-negative f
2c970 6f 75 72 74 68 20 70 61 72 61 6d 65 74 65 72 20  ourth parameter 
2c980 69 73 20 70 72 6f 76 69 64 65 64 20 74 6f 20 73  is provided to s
2c990 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74 65 78 74  qlite3_bind_text
2c9a0 28 29 0a 2a 2a 20 6f 72 20 73 71 6c 69 74 65 33  ().** or sqlite3
2c9b0 5f 62 69 6e 64 5f 74 65 78 74 31 36 28 29 20 6f  _bind_text16() o
2c9c0 72 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74  r sqlite3_bind_t
2c9d0 65 78 74 36 34 28 29 20 74 68 65 6e 0a 2a 2a 20  ext64() then.** 
2c9e0 74 68 61 74 20 70 61 72 61 6d 65 74 65 72 20 6d  that parameter m
2c9f0 75 73 74 20 62 65 20 74 68 65 20 62 79 74 65 20  ust be the byte 
2ca00 6f 66 66 73 65 74 0a 2a 2a 20 77 68 65 72 65 20  offset.** where 
2ca10 74 68 65 20 4e 55 4c 20 74 65 72 6d 69 6e 61 74  the NUL terminat
2ca20 6f 72 20 77 6f 75 6c 64 20 6f 63 63 75 72 20 61  or would occur a
2ca30 73 73 75 6d 69 6e 67 20 74 68 65 20 73 74 72 69  ssuming the stri
2ca40 6e 67 20 77 65 72 65 20 4e 55 4c 0a 2a 2a 20 74  ng were NUL.** t
2ca50 65 72 6d 69 6e 61 74 65 64 2e 20 20 49 66 20 61  erminated.  If a
2ca60 6e 79 20 4e 55 4c 20 63 68 61 72 61 63 74 65 72  ny NUL character
2ca70 73 20 6f 63 63 75 72 20 61 74 20 62 79 74 65 20  s occur at byte 
2ca80 6f 66 66 73 65 74 73 20 6c 65 73 73 20 74 68 61  offsets less tha
2ca90 6e 20 0a 2a 2a 20 74 68 65 20 76 61 6c 75 65 20  n .** the value 
2caa0 6f 66 20 74 68 65 20 66 6f 75 72 74 68 20 70 61  of the fourth pa
2cab0 72 61 6d 65 74 65 72 20 74 68 65 6e 20 74 68 65  rameter then the
2cac0 20 72 65 73 75 6c 74 69 6e 67 20 73 74 72 69 6e   resulting strin
2cad0 67 20 76 61 6c 75 65 20 77 69 6c 6c 0a 2a 2a 20  g value will.** 
2cae0 63 6f 6e 74 61 69 6e 20 65 6d 62 65 64 64 65 64  contain embedded
2caf0 20 4e 55 4c 73 2e 20 20 54 68 65 20 72 65 73 75   NULs.  The resu
2cb00 6c 74 20 6f 66 20 65 78 70 72 65 73 73 69 6f 6e  lt of expression
2cb10 73 20 69 6e 76 6f 6c 76 69 6e 67 20 73 74 72 69  s involving stri
2cb20 6e 67 73 0a 2a 2a 20 77 69 74 68 20 65 6d 62 65  ngs.** with embe
2cb30 64 64 65 64 20 4e 55 4c 73 20 69 73 20 75 6e 64  dded NULs is und
2cb40 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54  efined..**.** ^T
2cb50 68 65 20 66 69 66 74 68 20 61 72 67 75 6d 65 6e  he fifth argumen
2cb60 74 20 74 6f 20 74 68 65 20 42 4c 4f 42 20 61 6e  t to the BLOB an
2cb70 64 20 73 74 72 69 6e 67 20 62 69 6e 64 69 6e 67  d string binding
2cb80 20 69 6e 74 65 72 66 61 63 65 73 0a 2a 2a 20 69   interfaces.** i
2cb90 73 20 61 20 64 65 73 74 72 75 63 74 6f 72 20 75  s a destructor u
2cba0 73 65 64 20 74 6f 20 64 69 73 70 6f 73 65 20 6f  sed to dispose o
2cbb0 66 20 74 68 65 20 42 4c 4f 42 20 6f 72 0a 2a 2a  f the BLOB or.**
2cbc0 20 73 74 72 69 6e 67 20 61 66 74 65 72 20 53 51   string after SQ
2cbd0 4c 69 74 65 20 68 61 73 20 66 69 6e 69 73 68 65  Lite has finishe
2cbe0 64 20 77 69 74 68 20 69 74 2e 20 20 5e 54 68 65  d with it.  ^The
2cbf0 20 64 65 73 74 72 75 63 74 6f 72 20 69 73 20 63   destructor is c
2cc00 61 6c 6c 65 64 0a 2a 2a 20 74 6f 20 64 69 73 70  alled.** to disp
2cc10 6f 73 65 20 6f 66 20 74 68 65 20 42 4c 4f 42 20  ose of the BLOB 
2cc20 6f 72 20 73 74 72 69 6e 67 20 65 76 65 6e 20 69  or string even i
2cc30 66 20 74 68 65 20 63 61 6c 6c 20 74 6f 20 62 69  f the call to bi
2cc40 6e 64 20 41 50 49 20 66 61 69 6c 73 2e 0a 2a 2a  nd API fails..**
2cc50 20 5e 49 66 20 74 68 65 20 66 69 66 74 68 20 61   ^If the fifth a
2cc60 72 67 75 6d 65 6e 74 20 69 73 0a 2a 2a 20 74 68  rgument is.** th
2cc70 65 20 73 70 65 63 69 61 6c 20 76 61 6c 75 65 20  e special value 
2cc80 5b 53 51 4c 49 54 45 5f 53 54 41 54 49 43 5d 2c  [SQLITE_STATIC],
2cc90 20 74 68 65 6e 20 53 51 4c 69 74 65 20 61 73 73   then SQLite ass
2cca0 75 6d 65 73 20 74 68 61 74 20 74 68 65 0a 2a 2a  umes that the.**
2ccb0 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 69 73 20   information is 
2ccc0 69 6e 20 73 74 61 74 69 63 2c 20 75 6e 6d 61 6e  in static, unman
2ccd0 61 67 65 64 20 73 70 61 63 65 20 61 6e 64 20 64  aged space and d
2cce0 6f 65 73 20 6e 6f 74 20 6e 65 65 64 20 74 6f 20  oes not need to 
2ccf0 62 65 20 66 72 65 65 64 2e 0a 2a 2a 20 5e 49 66  be freed..** ^If
2cd00 20 74 68 65 20 66 69 66 74 68 20 61 72 67 75 6d   the fifth argum
2cd10 65 6e 74 20 68 61 73 20 74 68 65 20 76 61 6c 75  ent has the valu
2cd20 65 20 5b 53 51 4c 49 54 45 5f 54 52 41 4e 53 49  e [SQLITE_TRANSI
2cd30 45 4e 54 5d 2c 20 74 68 65 6e 0a 2a 2a 20 53 51  ENT], then.** SQ
2cd40 4c 69 74 65 20 6d 61 6b 65 73 20 69 74 73 20 6f  Lite makes its o
2cd50 77 6e 20 70 72 69 76 61 74 65 20 63 6f 70 79 20  wn private copy 
2cd60 6f 66 20 74 68 65 20 64 61 74 61 20 69 6d 6d 65  of the data imme
2cd70 64 69 61 74 65 6c 79 2c 20 62 65 66 6f 72 65 0a  diately, before.
2cd80 2a 2a 20 74 68 65 20 73 71 6c 69 74 65 33 5f 62  ** the sqlite3_b
2cd90 69 6e 64 5f 2a 28 29 20 72 6f 75 74 69 6e 65 20  ind_*() routine 
2cda0 72 65 74 75 72 6e 73 2e 0a 2a 2a 0a 2a 2a 20 5e  returns..**.** ^
2cdb0 54 68 65 20 73 69 78 74 68 20 61 72 67 75 6d 65  The sixth argume
2cdc0 6e 74 20 74 6f 20 73 71 6c 69 74 65 33 5f 62 69  nt to sqlite3_bi
2cdd0 6e 64 5f 74 65 78 74 36 34 28 29 20 6d 75 73 74  nd_text64() must
2cde0 20 62 65 20 6f 6e 65 20 6f 66 0a 2a 2a 20 5b 53   be one of.** [S
2cdf0 51 4c 49 54 45 5f 55 54 46 38 5d 2c 20 5b 53 51  QLITE_UTF8], [SQ
2ce00 4c 49 54 45 5f 55 54 46 31 36 5d 2c 20 5b 53 51  LITE_UTF16], [SQ
2ce10 4c 49 54 45 5f 55 54 46 31 36 42 45 5d 2c 20 6f  LITE_UTF16BE], o
2ce20 72 20 5b 53 51 4c 49 54 45 5f 55 54 46 31 36 4c  r [SQLITE_UTF16L
2ce30 45 5d 0a 2a 2a 20 74 6f 20 73 70 65 63 69 66 79  E].** to specify
2ce40 20 74 68 65 20 65 6e 63 6f 64 69 6e 67 20 6f 66   the encoding of
2ce50 20 74 68 65 20 74 65 78 74 20 69 6e 20 74 68 65   the text in the
2ce60 20 74 68 69 72 64 20 70 61 72 61 6d 65 74 65 72   third parameter
2ce70 2e 20 20 49 66 0a 2a 2a 20 74 68 65 20 73 69 78  .  If.** the six
2ce80 74 68 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 73  th argument to s
2ce90 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74 65 78 74  qlite3_bind_text
2cea0 36 34 28 29 20 69 73 20 6e 6f 74 20 6f 6e 65 20  64() is not one 
2ceb0 6f 66 20 74 68 65 0a 2a 2a 20 61 6c 6c 6f 77 65  of the.** allowe
2cec0 64 20 76 61 6c 75 65 73 20 73 68 6f 77 6e 20 61  d values shown a
2ced0 62 6f 76 65 2c 20 6f 72 20 69 66 20 74 68 65 20  bove, or if the 
2cee0 74 65 78 74 20 65 6e 63 6f 64 69 6e 67 20 69 73  text encoding is
2cef0 20 64 69 66 66 65 72 65 6e 74 0a 2a 2a 20 66 72   different.** fr
2cf00 6f 6d 20 74 68 65 20 65 6e 63 6f 64 69 6e 67 20  om the encoding 
2cf10 73 70 65 63 69 66 69 65 64 20 62 79 20 74 68 65  specified by the
2cf20 20 73 69 78 74 68 20 70 61 72 61 6d 65 74 65 72   sixth parameter
2cf30 2c 20 74 68 65 6e 20 74 68 65 20 62 65 68 61 76  , then the behav
2cf40 69 6f 72 0a 2a 2a 20 69 73 20 75 6e 64 65 66 69  ior.** is undefi
2cf50 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  ned..**.** ^The 
2cf60 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 7a 65 72  sqlite3_bind_zer
2cf70 6f 62 6c 6f 62 28 29 20 72 6f 75 74 69 6e 65 20  oblob() routine 
2cf80 62 69 6e 64 73 20 61 20 42 4c 4f 42 20 6f 66 20  binds a BLOB of 
2cf90 6c 65 6e 67 74 68 20 4e 20 74 68 61 74 0a 2a 2a  length N that.**
2cfa0 20 69 73 20 66 69 6c 6c 65 64 20 77 69 74 68 20   is filled with 
2cfb0 7a 65 72 6f 65 73 2e 20 20 5e 41 20 7a 65 72 6f  zeroes.  ^A zero
2cfc0 62 6c 6f 62 20 75 73 65 73 20 61 20 66 69 78 65  blob uses a fixe
2cfd0 64 20 61 6d 6f 75 6e 74 20 6f 66 20 6d 65 6d 6f  d amount of memo
2cfe0 72 79 0a 2a 2a 20 28 6a 75 73 74 20 61 6e 20 69  ry.** (just an i
2cff0 6e 74 65 67 65 72 20 74 6f 20 68 6f 6c 64 20 69  nteger to hold i
2d000 74 73 20 73 69 7a 65 29 20 77 68 69 6c 65 20 69  ts size) while i
2d010 74 20 69 73 20 62 65 69 6e 67 20 70 72 6f 63 65  t is being proce
2d020 73 73 65 64 2e 0a 2a 2a 20 5a 65 72 6f 62 6c 6f  ssed..** Zeroblo
2d030 62 73 20 61 72 65 20 69 6e 74 65 6e 64 65 64 20  bs are intended 
2d040 74 6f 20 73 65 72 76 65 20 61 73 20 70 6c 61 63  to serve as plac
2d050 65 68 6f 6c 64 65 72 73 20 66 6f 72 20 42 4c 4f  eholders for BLO
2d060 42 73 20 77 68 6f 73 65 0a 2a 2a 20 63 6f 6e 74  Bs whose.** cont
2d070 65 6e 74 20 69 73 20 6c 61 74 65 72 20 77 72 69  ent is later wri
2d080 74 74 65 6e 20 75 73 69 6e 67 0a 2a 2a 20 5b 73  tten using.** [s
2d090 71 6c 69 74 65 33 5f 62 6c 6f 62 5f 6f 70 65 6e  qlite3_blob_open
2d0a0 20 7c 20 69 6e 63 72 65 6d 65 6e 74 61 6c 20 42   | incremental B
2d0b0 4c 4f 42 20 49 2f 4f 5d 20 72 6f 75 74 69 6e 65  LOB I/O] routine
2d0c0 73 2e 0a 2a 2a 20 5e 41 20 6e 65 67 61 74 69 76  s..** ^A negativ
2d0d0 65 20 76 61 6c 75 65 20 66 6f 72 20 74 68 65 20  e value for the 
2d0e0 7a 65 72 6f 62 6c 6f 62 20 72 65 73 75 6c 74 73  zeroblob results
2d0f0 20 69 6e 20 61 20 7a 65 72 6f 2d 6c 65 6e 67 74   in a zero-lengt
2d100 68 20 42 4c 4f 42 2e 0a 2a 2a 0a 2a 2a 20 5e 49  h BLOB..**.** ^I
2d110 66 20 61 6e 79 20 6f 66 20 74 68 65 20 73 71 6c  f any of the sql
2d120 69 74 65 33 5f 62 69 6e 64 5f 2a 28 29 20 72 6f  ite3_bind_*() ro
2d130 75 74 69 6e 65 73 20 61 72 65 20 63 61 6c 6c 65  utines are calle
2d140 64 20 77 69 74 68 20 61 20 4e 55 4c 4c 20 70 6f  d with a NULL po
2d150 69 6e 74 65 72 0a 2a 2a 20 66 6f 72 20 74 68 65  inter.** for the
2d160 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65   [prepared state
2d170 6d 65 6e 74 5d 20 6f 72 20 77 69 74 68 20 61 20  ment] or with a 
2d180 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
2d190 6e 74 20 66 6f 72 20 77 68 69 63 68 0a 2a 2a 20  nt for which.** 
2d1a0 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d  [sqlite3_step()]
2d1b0 20 68 61 73 20 62 65 65 6e 20 63 61 6c 6c 65 64   has been called
2d1c0 20 6d 6f 72 65 20 72 65 63 65 6e 74 6c 79 20 74   more recently t
2d1d0 68 61 6e 20 5b 73 71 6c 69 74 65 33 5f 72 65 73  han [sqlite3_res
2d1e0 65 74 28 29 5d 2c 0a 2a 2a 20 74 68 65 6e 20 74  et()],.** then t
2d1f0 68 65 20 63 61 6c 6c 20 77 69 6c 6c 20 72 65 74  he call will ret
2d200 75 72 6e 20 5b 53 51 4c 49 54 45 5f 4d 49 53 55  urn [SQLITE_MISU
2d210 53 45 5d 2e 20 20 49 66 20 61 6e 79 20 73 71 6c  SE].  If any sql
2d220 69 74 65 33 5f 62 69 6e 64 5f 28 29 0a 2a 2a 20  ite3_bind_().** 
2d230 72 6f 75 74 69 6e 65 20 69 73 20 70 61 73 73 65  routine is passe
2d240 64 20 61 20 5b 70 72 65 70 61 72 65 64 20 73 74  d a [prepared st
2d250 61 74 65 6d 65 6e 74 5d 20 74 68 61 74 20 68 61  atement] that ha
2d260 73 20 62 65 65 6e 20 66 69 6e 61 6c 69 7a 65 64  s been finalized
2d270 2c 20 74 68 65 0a 2a 2a 20 72 65 73 75 6c 74 20  , the.** result 
2d280 69 73 20 75 6e 64 65 66 69 6e 65 64 20 61 6e 64  is undefined and
2d290 20 70 72 6f 62 61 62 6c 79 20 68 61 72 6d 66 75   probably harmfu
2d2a0 6c 2e 0a 2a 2a 0a 2a 2a 20 5e 42 69 6e 64 69 6e  l..**.** ^Bindin
2d2b0 67 73 20 61 72 65 20 6e 6f 74 20 63 6c 65 61 72  gs are not clear
2d2c0 65 64 20 62 79 20 74 68 65 20 5b 73 71 6c 69 74  ed by the [sqlit
2d2d0 65 33 5f 72 65 73 65 74 28 29 5d 20 72 6f 75 74  e3_reset()] rout
2d2e0 69 6e 65 2e 0a 2a 2a 20 5e 55 6e 62 6f 75 6e 64  ine..** ^Unbound
2d2f0 20 70 61 72 61 6d 65 74 65 72 73 20 61 72 65 20   parameters are 
2d300 69 6e 74 65 72 70 72 65 74 65 64 20 61 73 20 4e  interpreted as N
2d310 55 4c 4c 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  ULL..**.** ^The 
2d320 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 2a 20 72  sqlite3_bind_* r
2d330 6f 75 74 69 6e 65 73 20 72 65 74 75 72 6e 20 5b  outines return [
2d340 53 51 4c 49 54 45 5f 4f 4b 5d 20 6f 6e 20 73 75  SQLITE_OK] on su
2d350 63 63 65 73 73 20 6f 72 20 61 6e 0a 2a 2a 20 5b  ccess or an.** [
2d360 65 72 72 6f 72 20 63 6f 64 65 5d 20 69 66 20 61  error code] if a
2d370 6e 79 74 68 69 6e 67 20 67 6f 65 73 20 77 72 6f  nything goes wro
2d380 6e 67 2e 0a 2a 2a 20 5e 5b 53 51 4c 49 54 45 5f  ng..** ^[SQLITE_
2d390 54 4f 4f 42 49 47 5d 20 6d 69 67 68 74 20 62 65  TOOBIG] might be
2d3a0 20 72 65 74 75 72 6e 65 64 20 69 66 20 74 68 65   returned if the
2d3b0 20 73 69 7a 65 20 6f 66 20 61 20 73 74 72 69 6e   size of a strin
2d3c0 67 20 6f 72 20 42 4c 4f 42 0a 2a 2a 20 65 78 63  g or BLOB.** exc
2d3d0 65 65 64 73 20 6c 69 6d 69 74 73 20 69 6d 70 6f  eeds limits impo
2d3e0 73 65 64 20 62 79 20 5b 73 71 6c 69 74 65 33 5f  sed by [sqlite3_
2d3f0 6c 69 6d 69 74 5d 28 5b 53 51 4c 49 54 45 5f 4c  limit]([SQLITE_L
2d400 49 4d 49 54 5f 4c 45 4e 47 54 48 5d 29 20 6f 72  IMIT_LENGTH]) or
2d410 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 4d 41 58 5f  .** [SQLITE_MAX_
2d420 4c 45 4e 47 54 48 5d 2e 0a 2a 2a 20 5e 5b 53 51  LENGTH]..** ^[SQ
2d430 4c 49 54 45 5f 52 41 4e 47 45 5d 20 69 73 20 72  LITE_RANGE] is r
2d440 65 74 75 72 6e 65 64 20 69 66 20 74 68 65 20 70  eturned if the p
2d450 61 72 61 6d 65 74 65 72 0a 2a 2a 20 69 6e 64 65  arameter.** inde
2d460 78 20 69 73 20 6f 75 74 20 6f 66 20 72 61 6e 67  x is out of rang
2d470 65 2e 20 20 5e 5b 53 51 4c 49 54 45 5f 4e 4f 4d  e.  ^[SQLITE_NOM
2d480 45 4d 5d 20 69 73 20 72 65 74 75 72 6e 65 64 20  EM] is returned 
2d490 69 66 20 6d 61 6c 6c 6f 63 28 29 20 66 61 69 6c  if malloc() fail
2d4a0 73 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73  s..**.** See als
2d4b0 6f 3a 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64  o: [sqlite3_bind
2d4c0 5f 70 61 72 61 6d 65 74 65 72 5f 63 6f 75 6e 74  _parameter_count
2d4d0 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  ()],.** [sqlite3
2d4e0 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f  _bind_parameter_
2d4f0 6e 61 6d 65 28 29 5d 2c 20 61 6e 64 20 5b 73 71  name()], and [sq
2d500 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d  lite3_bind_param
2d510 65 74 65 72 5f 69 6e 64 65 78 28 29 5d 2e 0a 2a  eter_index()]..*
2d520 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62 69  /.int sqlite3_bi
2d530 6e 64 5f 62 6c 6f 62 28 73 71 6c 69 74 65 33 5f  nd_blob(sqlite3_
2d540 73 74 6d 74 2a 2c 20 69 6e 74 2c 20 63 6f 6e 73  stmt*, int, cons
2d550 74 20 76 6f 69 64 2a 2c 20 69 6e 74 20 6e 2c 20  t void*, int n, 
2d560 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a 29 29 3b  void(*)(void*));
2d570 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62 69 6e  .int sqlite3_bin
2d580 64 5f 62 6c 6f 62 36 34 28 73 71 6c 69 74 65 33  d_blob64(sqlite3
2d590 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c 20 63 6f 6e  _stmt*, int, con
2d5a0 73 74 20 76 6f 69 64 2a 2c 20 73 71 6c 69 74 65  st void*, sqlite
2d5b0 33 5f 75 69 6e 74 36 34 2c 0a 20 20 20 20 20 20  3_uint64,.      
2d5c0 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2d5d0 20 20 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a 29    void(*)(void*)
2d5e0 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62  );.int sqlite3_b
2d5f0 69 6e 64 5f 64 6f 75 62 6c 65 28 73 71 6c 69 74  ind_double(sqlit
2d600 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c 20 64  e3_stmt*, int, d
2d610 6f 75 62 6c 65 29 3b 0a 69 6e 74 20 73 71 6c 69  ouble);.int sqli
2d620 74 65 33 5f 62 69 6e 64 5f 69 6e 74 28 73 71 6c  te3_bind_int(sql
2d630 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c  ite3_stmt*, int,
2d640 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74   int);.int sqlit
2d650 65 33 5f 62 69 6e 64 5f 69 6e 74 36 34 28 73 71  e3_bind_int64(sq
2d660 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74  lite3_stmt*, int
2d670 2c 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 29  , sqlite3_int64)
2d680 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62 69  ;.int sqlite3_bi
2d690 6e 64 5f 6e 75 6c 6c 28 73 71 6c 69 74 65 33 5f  nd_null(sqlite3_
2d6a0 73 74 6d 74 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74  stmt*, int);.int
2d6b0 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74 65   sqlite3_bind_te
2d6c0 78 74 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a  xt(sqlite3_stmt*
2d6d0 2c 69 6e 74 2c 63 6f 6e 73 74 20 63 68 61 72 2a  ,int,const char*
2d6e0 2c 69 6e 74 2c 76 6f 69 64 28 2a 29 28 76 6f 69  ,int,void(*)(voi
2d6f0 64 2a 29 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  d*));.int sqlite
2d700 33 5f 62 69 6e 64 5f 74 65 78 74 31 36 28 73 71  3_bind_text16(sq
2d710 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74  lite3_stmt*, int
2d720 2c 20 63 6f 6e 73 74 20 76 6f 69 64 2a 2c 20 69  , const void*, i
2d730 6e 74 2c 20 76 6f 69 64 28 2a 29 28 76 6f 69 64  nt, void(*)(void
2d740 2a 29 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  *));.int sqlite3
2d750 5f 62 69 6e 64 5f 74 65 78 74 36 34 28 73 71 6c  _bind_text64(sql
2d760 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c  ite3_stmt*, int,
2d770 20 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20 73 71   const char*, sq
2d780 6c 69 74 65 33 5f 75 69 6e 74 36 34 2c 0a 20 20  lite3_uint64,.  
2d790 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2d7a0 20 20 20 20 20 20 20 76 6f 69 64 28 2a 29 28 76         void(*)(v
2d7b0 6f 69 64 2a 29 2c 20 75 6e 73 69 67 6e 65 64 20  oid*), unsigned 
2d7c0 63 68 61 72 20 65 6e 63 6f 64 69 6e 67 29 3b 0a  char encoding);.
2d7d0 69 6e 74 20 73 71 6c 69 74 65 33 5f 62 69 6e 64  int sqlite3_bind
2d7e0 5f 76 61 6c 75 65 28 73 71 6c 69 74 65 33 5f 73  _value(sqlite3_s
2d7f0 74 6d 74 2a 2c 20 69 6e 74 2c 20 63 6f 6e 73 74  tmt*, int, const
2d800 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29   sqlite3_value*)
2d810 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62 69  ;.int sqlite3_bi
2d820 6e 64 5f 7a 65 72 6f 62 6c 6f 62 28 73 71 6c 69  nd_zeroblob(sqli
2d830 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c 20  te3_stmt*, int, 
2d840 69 6e 74 20 6e 29 3b 0a 69 6e 74 20 73 71 6c 69  int n);.int sqli
2d850 74 65 33 5f 62 69 6e 64 5f 7a 65 72 6f 62 6c 6f  te3_bind_zeroblo
2d860 62 36 34 28 73 71 6c 69 74 65 33 5f 73 74 6d 74  b64(sqlite3_stmt
2d870 2a 2c 20 69 6e 74 2c 20 73 71 6c 69 74 65 33 5f  *, int, sqlite3_
2d880 75 69 6e 74 36 34 29 3b 0a 0a 2f 2a 0a 2a 2a 20  uint64);../*.** 
2d890 43 41 50 49 33 52 45 46 3a 20 4e 75 6d 62 65 72  CAPI3REF: Number
2d8a0 20 4f 66 20 53 51 4c 20 50 61 72 61 6d 65 74 65   Of SQL Paramete
2d8b0 72 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  rs.** METHOD: sq
2d8c0 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a  lite3_stmt.**.**
2d8d0 20 5e 54 68 69 73 20 72 6f 75 74 69 6e 65 20 63   ^This routine c
2d8e0 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20 66 69  an be used to fi
2d8f0 6e 64 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  nd the number of
2d900 20 5b 53 51 4c 20 70 61 72 61 6d 65 74 65 72 73   [SQL parameters
2d910 5d 0a 2a 2a 20 69 6e 20 61 20 5b 70 72 65 70 61  ].** in a [prepa
2d920 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 2e 20  red statement]. 
2d930 20 53 51 4c 20 70 61 72 61 6d 65 74 65 72 73 20   SQL parameters 
2d940 61 72 65 20 74 6f 6b 65 6e 73 20 6f 66 20 74 68  are tokens of th
2d950 65 0a 2a 2a 20 66 6f 72 6d 20 22 3f 22 2c 20 22  e.** form "?", "
2d960 3f 4e 4e 4e 22 2c 20 22 3a 41 41 41 22 2c 20 22  ?NNN", ":AAA", "
2d970 24 41 41 41 22 2c 20 6f 72 20 22 40 41 41 41 22  $AAA", or "@AAA"
2d980 20 74 68 61 74 20 73 65 72 76 65 20 61 73 0a 2a   that serve as.*
2d990 2a 20 70 6c 61 63 65 68 6f 6c 64 65 72 73 20 66  * placeholders f
2d9a0 6f 72 20 76 61 6c 75 65 73 20 74 68 61 74 20 61  or values that a
2d9b0 72 65 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64  re [sqlite3_bind
2d9c0 5f 62 6c 6f 62 20 7c 20 62 6f 75 6e 64 5d 0a 2a  _blob | bound].*
2d9d0 2a 20 74 6f 20 74 68 65 20 70 61 72 61 6d 65 74  * to the paramet
2d9e0 65 72 73 20 61 74 20 61 20 6c 61 74 65 72 20 74  ers at a later t
2d9f0 69 6d 65 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 69  ime..**.** ^(Thi
2da00 73 20 72 6f 75 74 69 6e 65 20 61 63 74 75 61 6c  s routine actual
2da10 6c 79 20 72 65 74 75 72 6e 73 20 74 68 65 20 69  ly returns the i
2da20 6e 64 65 78 20 6f 66 20 74 68 65 20 6c 61 72 67  ndex of the larg
2da30 65 73 74 20 28 72 69 67 68 74 6d 6f 73 74 29 0a  est (rightmost).
2da40 2a 2a 20 70 61 72 61 6d 65 74 65 72 2e 20 46 6f  ** parameter. Fo
2da50 72 20 61 6c 6c 20 66 6f 72 6d 73 20 65 78 63 65  r all forms exce
2da60 70 74 20 3f 4e 4e 4e 2c 20 74 68 69 73 20 77 69  pt ?NNN, this wi
2da70 6c 6c 20 63 6f 72 72 65 73 70 6f 6e 64 20 74 6f  ll correspond to
2da80 20 74 68 65 0a 2a 2a 20 6e 75 6d 62 65 72 20 6f   the.** number o
2da90 66 20 75 6e 69 71 75 65 20 70 61 72 61 6d 65 74  f unique paramet
2daa0 65 72 73 2e 20 20 49 66 20 70 61 72 61 6d 65 74  ers.  If paramet
2dab0 65 72 73 20 6f 66 20 74 68 65 20 3f 4e 4e 4e 20  ers of the ?NNN 
2dac0 66 6f 72 6d 20 61 72 65 20 75 73 65 64 2c 0a 2a  form are used,.*
2dad0 2a 20 74 68 65 72 65 20 6d 61 79 20 62 65 20 67  * there may be g
2dae0 61 70 73 20 69 6e 20 74 68 65 20 6c 69 73 74 2e  aps in the list.
2daf0 29 5e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73  )^.**.** See als
2db00 6f 3a 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64  o: [sqlite3_bind
2db10 5f 62 6c 6f 62 7c 73 71 6c 69 74 65 33 5f 62 69  _blob|sqlite3_bi
2db20 6e 64 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74  nd()],.** [sqlit
2db30 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65  e3_bind_paramete
2db40 72 5f 6e 61 6d 65 28 29 5d 2c 20 61 6e 64 0a 2a  r_name()], and.*
2db50 2a 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  * [sqlite3_bind_
2db60 70 61 72 61 6d 65 74 65 72 5f 69 6e 64 65 78 28  parameter_index(
2db70 29 5d 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  )]..*/.int sqlit
2db80 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65  e3_bind_paramete
2db90 72 5f 63 6f 75 6e 74 28 73 71 6c 69 74 65 33 5f  r_count(sqlite3_
2dba0 73 74 6d 74 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43  stmt*);../*.** C
2dbb0 41 50 49 33 52 45 46 3a 20 4e 61 6d 65 20 4f 66  API3REF: Name Of
2dbc0 20 41 20 48 6f 73 74 20 50 61 72 61 6d 65 74 65   A Host Paramete
2dbd0 72 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c  r.** METHOD: sql
2dbe0 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20  ite3_stmt.**.** 
2dbf0 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 62 69 6e  ^The sqlite3_bin
2dc00 64 5f 70 61 72 61 6d 65 74 65 72 5f 6e 61 6d 65  d_parameter_name
2dc10 28 50 2c 4e 29 20 69 6e 74 65 72 66 61 63 65 20  (P,N) interface 
2dc20 72 65 74 75 72 6e 73 0a 2a 2a 20 74 68 65 20 6e  returns.** the n
2dc30 61 6d 65 20 6f 66 20 74 68 65 20 4e 2d 74 68 20  ame of the N-th 
2dc40 5b 53 51 4c 20 70 61 72 61 6d 65 74 65 72 5d 20  [SQL parameter] 
2dc50 69 6e 20 74 68 65 20 5b 70 72 65 70 61 72 65 64  in the [prepared
2dc60 20 73 74 61 74 65 6d 65 6e 74 5d 20 50 2e 0a 2a   statement] P..*
2dc70 2a 20 5e 28 53 51 4c 20 70 61 72 61 6d 65 74 65  * ^(SQL paramete
2dc80 72 73 20 6f 66 20 74 68 65 20 66 6f 72 6d 20 22  rs of the form "
2dc90 3f 4e 4e 4e 22 20 6f 72 20 22 3a 41 41 41 22 20  ?NNN" or ":AAA" 
2dca0 6f 72 20 22 40 41 41 41 22 20 6f 72 20 22 24 41  or "@AAA" or "$A
2dcb0 41 41 22 0a 2a 2a 20 68 61 76 65 20 61 20 6e 61  AA".** have a na
2dcc0 6d 65 20 77 68 69 63 68 20 69 73 20 74 68 65 20  me which is the 
2dcd0 73 74 72 69 6e 67 20 22 3f 4e 4e 4e 22 20 6f 72  string "?NNN" or
2dce0 20 22 3a 41 41 41 22 20 6f 72 20 22 40 41 41 41   ":AAA" or "@AAA
2dcf0 22 20 6f 72 20 22 24 41 41 41 22 0a 2a 2a 20 72  " or "$AAA".** r
2dd00 65 73 70 65 63 74 69 76 65 6c 79 2e 0a 2a 2a 20  espectively..** 
2dd10 49 6e 20 6f 74 68 65 72 20 77 6f 72 64 73 2c 20  In other words, 
2dd20 74 68 65 20 69 6e 69 74 69 61 6c 20 22 3a 22 20  the initial ":" 
2dd30 6f 72 20 22 24 22 20 6f 72 20 22 40 22 20 6f 72  or "$" or "@" or
2dd40 20 22 3f 22 0a 2a 2a 20 69 73 20 69 6e 63 6c 75   "?".** is inclu
2dd50 64 65 64 20 61 73 20 70 61 72 74 20 6f 66 20 74  ded as part of t
2dd60 68 65 20 6e 61 6d 65 2e 29 5e 0a 2a 2a 20 5e 50  he name.)^.** ^P
2dd70 61 72 61 6d 65 74 65 72 73 20 6f 66 20 74 68 65  arameters of the
2dd80 20 66 6f 72 6d 20 22 3f 22 20 77 69 74 68 6f 75   form "?" withou
2dd90 74 20 61 20 66 6f 6c 6c 6f 77 69 6e 67 20 69 6e  t a following in
2dda0 74 65 67 65 72 20 68 61 76 65 20 6e 6f 20 6e 61  teger have no na
2ddb0 6d 65 0a 2a 2a 20 61 6e 64 20 61 72 65 20 72 65  me.** and are re
2ddc0 66 65 72 72 65 64 20 74 6f 20 61 73 20 22 6e 61  ferred to as "na
2ddd0 6d 65 6c 65 73 73 22 20 6f 72 20 22 61 6e 6f 6e  meless" or "anon
2dde0 79 6d 6f 75 73 20 70 61 72 61 6d 65 74 65 72 73  ymous parameters
2ddf0 22 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66 69  "..**.** ^The fi
2de00 72 73 74 20 68 6f 73 74 20 70 61 72 61 6d 65 74  rst host paramet
2de10 65 72 20 68 61 73 20 61 6e 20 69 6e 64 65 78 20  er has an index 
2de20 6f 66 20 31 2c 20 6e 6f 74 20 30 2e 0a 2a 2a 0a  of 1, not 0..**.
2de30 2a 2a 20 5e 49 66 20 74 68 65 20 76 61 6c 75 65  ** ^If the value
2de40 20 4e 20 69 73 20 6f 75 74 20 6f 66 20 72 61 6e   N is out of ran
2de50 67 65 20 6f 72 20 69 66 20 74 68 65 20 4e 2d 74  ge or if the N-t
2de60 68 20 70 61 72 61 6d 65 74 65 72 20 69 73 0a 2a  h parameter is.*
2de70 2a 20 6e 61 6d 65 6c 65 73 73 2c 20 74 68 65 6e  * nameless, then
2de80 20 4e 55 4c 4c 20 69 73 20 72 65 74 75 72 6e 65   NULL is returne
2de90 64 2e 20 20 5e 54 68 65 20 72 65 74 75 72 6e 65  d.  ^The returne
2dea0 64 20 73 74 72 69 6e 67 20 69 73 0a 2a 2a 20 61  d string is.** a
2deb0 6c 77 61 79 73 20 69 6e 20 55 54 46 2d 38 20 65  lways in UTF-8 e
2dec0 6e 63 6f 64 69 6e 67 20 65 76 65 6e 20 69 66 20  ncoding even if 
2ded0 74 68 65 20 6e 61 6d 65 64 20 70 61 72 61 6d 65  the named parame
2dee0 74 65 72 20 77 61 73 0a 2a 2a 20 6f 72 69 67 69  ter was.** origi
2def0 6e 61 6c 6c 79 20 73 70 65 63 69 66 69 65 64 20  nally specified 
2df00 61 73 20 55 54 46 2d 31 36 20 69 6e 20 5b 73 71  as UTF-16 in [sq
2df10 6c 69 74 65 33 5f 70 72 65 70 61 72 65 31 36 28  lite3_prepare16(
2df20 29 5d 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69 74 65  )] or.** [sqlite
2df30 33 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28 29  3_prepare16_v2()
2df40 5d 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73  ]..**.** See als
2df50 6f 3a 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64  o: [sqlite3_bind
2df60 5f 62 6c 6f 62 7c 73 71 6c 69 74 65 33 5f 62 69  _blob|sqlite3_bi
2df70 6e 64 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74  nd()],.** [sqlit
2df80 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65  e3_bind_paramete
2df90 72 5f 63 6f 75 6e 74 28 29 5d 2c 20 61 6e 64 0a  r_count()], and.
2dfa0 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64  ** [sqlite3_bind
2dfb0 5f 70 61 72 61 6d 65 74 65 72 5f 69 6e 64 65 78  _parameter_index
2dfc0 28 29 5d 2e 0a 2a 2f 0a 63 6f 6e 73 74 20 63 68  ()]..*/.const ch
2dfd0 61 72 20 2a 73 71 6c 69 74 65 33 5f 62 69 6e 64  ar *sqlite3_bind
2dfe0 5f 70 61 72 61 6d 65 74 65 72 5f 6e 61 6d 65 28  _parameter_name(
2dff0 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69  sqlite3_stmt*, i
2e000 6e 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  nt);../*.** CAPI
2e010 33 52 45 46 3a 20 49 6e 64 65 78 20 4f 66 20 41  3REF: Index Of A
2e020 20 50 61 72 61 6d 65 74 65 72 20 57 69 74 68 20   Parameter With 
2e030 41 20 47 69 76 65 6e 20 4e 61 6d 65 0a 2a 2a 20  A Given Name.** 
2e040 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f  METHOD: sqlite3_
2e050 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 52 65 74 75  stmt.**.** ^Retu
2e060 72 6e 20 74 68 65 20 69 6e 64 65 78 20 6f 66 20  rn the index of 
2e070 61 6e 20 53 51 4c 20 70 61 72 61 6d 65 74 65 72  an SQL parameter
2e080 20 67 69 76 65 6e 20 69 74 73 20 6e 61 6d 65 2e   given its name.
2e090 20 20 5e 54 68 65 0a 2a 2a 20 69 6e 64 65 78 20    ^The.** index 
2e0a0 76 61 6c 75 65 20 72 65 74 75 72 6e 65 64 20 69  value returned i
2e0b0 73 20 73 75 69 74 61 62 6c 65 20 66 6f 72 20 75  s suitable for u
2e0c0 73 65 20 61 73 20 74 68 65 20 73 65 63 6f 6e 64  se as the second
2e0d0 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72 20 74 6f  .** parameter to
2e0e0 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 62   [sqlite3_bind_b
2e0f0 6c 6f 62 7c 73 71 6c 69 74 65 33 5f 62 69 6e 64  lob|sqlite3_bind
2e100 28 29 5d 2e 20 20 5e 41 20 7a 65 72 6f 0a 2a 2a  ()].  ^A zero.**
2e110 20 69 73 20 72 65 74 75 72 6e 65 64 20 69 66 20   is returned if 
2e120 6e 6f 20 6d 61 74 63 68 69 6e 67 20 70 61 72 61  no matching para
2e130 6d 65 74 65 72 20 69 73 20 66 6f 75 6e 64 2e 20  meter is found. 
2e140 20 5e 54 68 65 20 70 61 72 61 6d 65 74 65 72 0a   ^The parameter.
2e150 2a 2a 20 6e 61 6d 65 20 6d 75 73 74 20 62 65 20  ** name must be 
2e160 67 69 76 65 6e 20 69 6e 20 55 54 46 2d 38 20 65  given in UTF-8 e
2e170 76 65 6e 20 69 66 20 74 68 65 20 6f 72 69 67 69  ven if the origi
2e180 6e 61 6c 20 73 74 61 74 65 6d 65 6e 74 0a 2a 2a  nal statement.**
2e190 20 77 61 73 20 70 72 65 70 61 72 65 64 20 66 72   was prepared fr
2e1a0 6f 6d 20 55 54 46 2d 31 36 20 74 65 78 74 20 75  om UTF-16 text u
2e1b0 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 70 72  sing [sqlite3_pr
2e1c0 65 70 61 72 65 31 36 5f 76 32 28 29 5d 2e 0a 2a  epare16_v2()]..*
2e1d0 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 3a 20 5b  *.** See also: [
2e1e0 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 62 6c 6f  sqlite3_bind_blo
2e1f0 62 7c 73 71 6c 69 74 65 33 5f 62 69 6e 64 28 29  b|sqlite3_bind()
2e200 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62  ],.** [sqlite3_b
2e210 69 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f 63 6f  ind_parameter_co
2e220 75 6e 74 28 29 5d 2c 20 61 6e 64 0a 2a 2a 20 5b  unt()], and.** [
2e230 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61 72  sqlite3_bind_par
2e240 61 6d 65 74 65 72 5f 6e 61 6d 65 28 29 5d 2e 0a  ameter_name()]..
2e250 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62  */.int sqlite3_b
2e260 69 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f 69 6e  ind_parameter_in
2e270 64 65 78 28 73 71 6c 69 74 65 33 5f 73 74 6d 74  dex(sqlite3_stmt
2e280 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a  *, const char *z
2e290 4e 61 6d 65 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41  Name);../*.** CA
2e2a0 50 49 33 52 45 46 3a 20 52 65 73 65 74 20 41 6c  PI3REF: Reset Al
2e2b0 6c 20 42 69 6e 64 69 6e 67 73 20 4f 6e 20 41 20  l Bindings On A 
2e2c0 50 72 65 70 61 72 65 64 20 53 74 61 74 65 6d 65  Prepared Stateme
2e2d0 6e 74 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  nt.** METHOD: sq
2e2e0 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a  lite3_stmt.**.**
2e2f0 20 5e 43 6f 6e 74 72 61 72 79 20 74 6f 20 74 68   ^Contrary to th
2e300 65 20 69 6e 74 75 69 74 69 6f 6e 20 6f 66 20 6d  e intuition of m
2e310 61 6e 79 2c 20 5b 73 71 6c 69 74 65 33 5f 72 65  any, [sqlite3_re
2e320 73 65 74 28 29 5d 20 64 6f 65 73 20 6e 6f 74 20  set()] does not 
2e330 72 65 73 65 74 0a 2a 2a 20 74 68 65 20 5b 73 71  reset.** the [sq
2e340 6c 69 74 65 33 5f 62 69 6e 64 5f 62 6c 6f 62 20  lite3_bind_blob 
2e350 7c 20 62 69 6e 64 69 6e 67 73 5d 20 6f 6e 20 61  | bindings] on a
2e360 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65   [prepared state
2e370 6d 65 6e 74 5d 2e 0a 2a 2a 20 5e 55 73 65 20 74  ment]..** ^Use t
2e380 68 69 73 20 72 6f 75 74 69 6e 65 20 74 6f 20 72  his routine to r
2e390 65 73 65 74 20 61 6c 6c 20 68 6f 73 74 20 70 61  eset all host pa
2e3a0 72 61 6d 65 74 65 72 73 20 74 6f 20 4e 55 4c 4c  rameters to NULL
2e3b0 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  ..*/.int sqlite3
2e3c0 5f 63 6c 65 61 72 5f 62 69 6e 64 69 6e 67 73 28  _clear_bindings(
2e3d0 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 29 3b 0a  sqlite3_stmt*);.
2e3e0 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
2e3f0 20 4e 75 6d 62 65 72 20 4f 66 20 43 6f 6c 75 6d   Number Of Colum
2e400 6e 73 20 49 6e 20 41 20 52 65 73 75 6c 74 20 53  ns In A Result S
2e410 65 74 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  et.** METHOD: sq
2e420 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a  lite3_stmt.**.**
2e430 20 5e 52 65 74 75 72 6e 20 74 68 65 20 6e 75 6d   ^Return the num
2e440 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 20 69  ber of columns i
2e450 6e 20 74 68 65 20 72 65 73 75 6c 74 20 73 65 74  n the result set
2e460 20 72 65 74 75 72 6e 65 64 20 62 79 20 74 68 65   returned by the
2e470 0a 2a 2a 20 5b 70 72 65 70 61 72 65 64 20 73 74  .** [prepared st
2e480 61 74 65 6d 65 6e 74 5d 2e 20 5e 54 68 69 73 20  atement]. ^This 
2e490 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73 20  routine returns 
2e4a0 30 20 69 66 20 70 53 74 6d 74 20 69 73 20 61 6e  0 if pStmt is an
2e4b0 20 53 51 4c 0a 2a 2a 20 73 74 61 74 65 6d 65 6e   SQL.** statemen
2e4c0 74 20 74 68 61 74 20 64 6f 65 73 20 6e 6f 74 20  t that does not 
2e4d0 72 65 74 75 72 6e 20 64 61 74 61 20 28 66 6f 72  return data (for
2e4e0 20 65 78 61 6d 70 6c 65 20 61 6e 20 5b 55 50 44   example an [UPD
2e4f0 41 54 45 5d 29 2e 0a 2a 2a 0a 2a 2a 20 53 65 65  ATE])..**.** See
2e500 20 61 6c 73 6f 3a 20 5b 73 71 6c 69 74 65 33 5f   also: [sqlite3_
2e510 64 61 74 61 5f 63 6f 75 6e 74 28 29 5d 0a 2a 2f  data_count()].*/
2e520 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 63 6f 6c  .int sqlite3_col
2e530 75 6d 6e 5f 63 6f 75 6e 74 28 73 71 6c 69 74 65  umn_count(sqlite
2e540 33 5f 73 74 6d 74 20 2a 70 53 74 6d 74 29 3b 0a  3_stmt *pStmt);.
2e550 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
2e560 20 43 6f 6c 75 6d 6e 20 4e 61 6d 65 73 20 49 6e   Column Names In
2e570 20 41 20 52 65 73 75 6c 74 20 53 65 74 0a 2a 2a   A Result Set.**
2e580 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33   METHOD: sqlite3
2e590 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  _stmt.**.** ^The
2e5a0 73 65 20 72 6f 75 74 69 6e 65 73 20 72 65 74 75  se routines retu
2e5b0 72 6e 20 74 68 65 20 6e 61 6d 65 20 61 73 73 69  rn the name assi
2e5c0 67 6e 65 64 20 74 6f 20 61 20 70 61 72 74 69 63  gned to a partic
2e5d0 75 6c 61 72 20 63 6f 6c 75 6d 6e 0a 2a 2a 20 69  ular column.** i
2e5e0 6e 20 74 68 65 20 72 65 73 75 6c 74 20 73 65 74  n the result set
2e5f0 20 6f 66 20 61 20 5b 53 45 4c 45 43 54 5d 20 73   of a [SELECT] s
2e600 74 61 74 65 6d 65 6e 74 2e 20 20 5e 54 68 65 20  tatement.  ^The 
2e610 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6e  sqlite3_column_n
2e620 61 6d 65 28 29 0a 2a 2a 20 69 6e 74 65 72 66 61  ame().** interfa
2e630 63 65 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69  ce returns a poi
2e640 6e 74 65 72 20 74 6f 20 61 20 7a 65 72 6f 2d 74  nter to a zero-t
2e650 65 72 6d 69 6e 61 74 65 64 20 55 54 46 2d 38 20  erminated UTF-8 
2e660 73 74 72 69 6e 67 0a 2a 2a 20 61 6e 64 20 73 71  string.** and sq
2e670 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6e 61 6d  lite3_column_nam
2e680 65 31 36 28 29 20 72 65 74 75 72 6e 73 20 61 20  e16() returns a 
2e690 70 6f 69 6e 74 65 72 20 74 6f 20 61 20 7a 65 72  pointer to a zer
2e6a0 6f 2d 74 65 72 6d 69 6e 61 74 65 64 0a 2a 2a 20  o-terminated.** 
2e6b0 55 54 46 2d 31 36 20 73 74 72 69 6e 67 2e 20 20  UTF-16 string.  
2e6c0 5e 54 68 65 20 66 69 72 73 74 20 70 61 72 61 6d  ^The first param
2e6d0 65 74 65 72 20 69 73 20 74 68 65 20 5b 70 72 65  eter is the [pre
2e6e0 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d  pared statement]
2e6f0 0a 2a 2a 20 74 68 61 74 20 69 6d 70 6c 65 6d 65  .** that impleme
2e700 6e 74 73 20 74 68 65 20 5b 53 45 4c 45 43 54 5d  nts the [SELECT]
2e710 20 73 74 61 74 65 6d 65 6e 74 2e 20 5e 54 68 65   statement. ^The
2e720 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65   second paramete
2e730 72 20 69 73 20 74 68 65 0a 2a 2a 20 63 6f 6c 75  r is the.** colu
2e740 6d 6e 20 6e 75 6d 62 65 72 2e 20 20 5e 54 68 65  mn number.  ^The
2e750 20 6c 65 66 74 6d 6f 73 74 20 63 6f 6c 75 6d 6e   leftmost column
2e760 20 69 73 20 6e 75 6d 62 65 72 20 30 2e 0a 2a 2a   is number 0..**
2e770 0a 2a 2a 20 5e 54 68 65 20 72 65 74 75 72 6e 65  .** ^The returne
2e780 64 20 73 74 72 69 6e 67 20 70 6f 69 6e 74 65 72  d string pointer
2e790 20 69 73 20 76 61 6c 69 64 20 75 6e 74 69 6c 20   is valid until 
2e7a0 65 69 74 68 65 72 20 74 68 65 20 5b 70 72 65 70  either the [prep
2e7b0 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 0a  ared statement].
2e7c0 2a 2a 20 69 73 20 64 65 73 74 72 6f 79 65 64 20  ** is destroyed 
2e7d0 62 79 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e 61  by [sqlite3_fina
2e7e0 6c 69 7a 65 28 29 5d 20 6f 72 20 75 6e 74 69 6c  lize()] or until
2e7f0 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20 69   the statement i
2e800 73 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 0a  s automatically.
2e810 2a 2a 20 72 65 70 72 65 70 61 72 65 64 20 62 79  ** reprepared by
2e820 20 74 68 65 20 66 69 72 73 74 20 63 61 6c 6c 20   the first call 
2e830 74 6f 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70  to [sqlite3_step
2e840 28 29 5d 20 66 6f 72 20 61 20 70 61 72 74 69 63  ()] for a partic
2e850 75 6c 61 72 20 72 75 6e 0a 2a 2a 20 6f 72 20 75  ular run.** or u
2e860 6e 74 69 6c 20 74 68 65 20 6e 65 78 74 20 63 61  ntil the next ca
2e870 6c 6c 20 74 6f 0a 2a 2a 20 73 71 6c 69 74 65 33  ll to.** sqlite3
2e880 5f 63 6f 6c 75 6d 6e 5f 6e 61 6d 65 28 29 20 6f  _column_name() o
2e890 72 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  r sqlite3_column
2e8a0 5f 6e 61 6d 65 31 36 28 29 20 6f 6e 20 74 68 65  _name16() on the
2e8b0 20 73 61 6d 65 20 63 6f 6c 75 6d 6e 2e 0a 2a 2a   same column..**
2e8c0 0a 2a 2a 20 5e 49 66 20 73 71 6c 69 74 65 33 5f  .** ^If sqlite3_
2e8d0 6d 61 6c 6c 6f 63 28 29 20 66 61 69 6c 73 20 64  malloc() fails d
2e8e0 75 72 69 6e 67 20 74 68 65 20 70 72 6f 63 65 73  uring the proces
2e8f0 73 69 6e 67 20 6f 66 20 65 69 74 68 65 72 20 72  sing of either r
2e900 6f 75 74 69 6e 65 0a 2a 2a 20 28 66 6f 72 20 65  outine.** (for e
2e910 78 61 6d 70 6c 65 20 64 75 72 69 6e 67 20 61 20  xample during a 
2e920 63 6f 6e 76 65 72 73 69 6f 6e 20 66 72 6f 6d 20  conversion from 
2e930 55 54 46 2d 38 20 74 6f 20 55 54 46 2d 31 36 29  UTF-8 to UTF-16)
2e940 20 74 68 65 6e 20 61 0a 2a 2a 20 4e 55 4c 4c 20   then a.** NULL 
2e950 70 6f 69 6e 74 65 72 20 69 73 20 72 65 74 75 72  pointer is retur
2e960 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  ned..**.** ^The 
2e970 6e 61 6d 65 20 6f 66 20 61 20 72 65 73 75 6c 74  name of a result
2e980 20 63 6f 6c 75 6d 6e 20 69 73 20 74 68 65 20 76   column is the v
2e990 61 6c 75 65 20 6f 66 20 74 68 65 20 22 41 53 22  alue of the "AS"
2e9a0 20 63 6c 61 75 73 65 20 66 6f 72 0a 2a 2a 20 74   clause for.** t
2e9b0 68 61 74 20 63 6f 6c 75 6d 6e 2c 20 69 66 20 74  hat column, if t
2e9c0 68 65 72 65 20 69 73 20 61 6e 20 41 53 20 63 6c  here is an AS cl
2e9d0 61 75 73 65 2e 20 20 49 66 20 74 68 65 72 65 20  ause.  If there 
2e9e0 69 73 20 6e 6f 20 41 53 20 63 6c 61 75 73 65 0a  is no AS clause.
2e9f0 2a 2a 20 74 68 65 6e 20 74 68 65 20 6e 61 6d 65  ** then the name
2ea00 20 6f 66 20 74 68 65 20 63 6f 6c 75 6d 6e 20 69   of the column i
2ea10 73 20 75 6e 73 70 65 63 69 66 69 65 64 20 61 6e  s unspecified an
2ea20 64 20 6d 61 79 20 63 68 61 6e 67 65 20 66 72 6f  d may change fro
2ea30 6d 0a 2a 2a 20 6f 6e 65 20 72 65 6c 65 61 73 65  m.** one release
2ea40 20 6f 66 20 53 51 4c 69 74 65 20 74 6f 20 74 68   of SQLite to th
2ea50 65 20 6e 65 78 74 2e 0a 2a 2f 0a 63 6f 6e 73 74  e next..*/.const
2ea60 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 63   char *sqlite3_c
2ea70 6f 6c 75 6d 6e 5f 6e 61 6d 65 28 73 71 6c 69 74  olumn_name(sqlit
2ea80 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 4e 29  e3_stmt*, int N)
2ea90 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71  ;.const void *sq
2eaa0 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6e 61 6d  lite3_column_nam
2eab0 65 31 36 28 73 71 6c 69 74 65 33 5f 73 74 6d 74  e16(sqlite3_stmt
2eac0 2a 2c 20 69 6e 74 20 4e 29 3b 0a 0a 2f 2a 0a 2a  *, int N);../*.*
2ead0 2a 20 43 41 50 49 33 52 45 46 3a 20 53 6f 75 72  * CAPI3REF: Sour
2eae0 63 65 20 4f 66 20 44 61 74 61 20 49 6e 20 41 20  ce Of Data In A 
2eaf0 51 75 65 72 79 20 52 65 73 75 6c 74 0a 2a 2a 20  Query Result.** 
2eb00 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f  METHOD: sqlite3_
2eb10 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 73  stmt.**.** ^Thes
2eb20 65 20 72 6f 75 74 69 6e 65 73 20 70 72 6f 76 69  e routines provi
2eb30 64 65 20 61 20 6d 65 61 6e 73 20 74 6f 20 64 65  de a means to de
2eb40 74 65 72 6d 69 6e 65 20 74 68 65 20 64 61 74 61  termine the data
2eb50 62 61 73 65 2c 20 74 61 62 6c 65 2c 20 61 6e 64  base, table, and
2eb60 0a 2a 2a 20 74 61 62 6c 65 20 63 6f 6c 75 6d 6e  .** table column
2eb70 20 74 68 61 74 20 69 73 20 74 68 65 20 6f 72 69   that is the ori
2eb80 67 69 6e 20 6f 66 20 61 20 70 61 72 74 69 63 75  gin of a particu
2eb90 6c 61 72 20 72 65 73 75 6c 74 20 63 6f 6c 75 6d  lar result colum
2eba0 6e 20 69 6e 0a 2a 2a 20 5b 53 45 4c 45 43 54 5d  n in.** [SELECT]
2ebb0 20 73 74 61 74 65 6d 65 6e 74 2e 0a 2a 2a 20 5e   statement..** ^
2ebc0 54 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20  The name of the 
2ebd0 64 61 74 61 62 61 73 65 20 6f 72 20 74 61 62 6c  database or tabl
2ebe0 65 20 6f 72 20 63 6f 6c 75 6d 6e 20 63 61 6e 20  e or column can 
2ebf0 62 65 20 72 65 74 75 72 6e 65 64 20 61 73 0a 2a  be returned as.*
2ec00 2a 20 65 69 74 68 65 72 20 61 20 55 54 46 2d 38  * either a UTF-8
2ec10 20 6f 72 20 55 54 46 2d 31 36 20 73 74 72 69 6e   or UTF-16 strin
2ec20 67 2e 20 20 5e 54 68 65 20 5f 64 61 74 61 62 61  g.  ^The _databa
2ec30 73 65 5f 20 72 6f 75 74 69 6e 65 73 20 72 65 74  se_ routines ret
2ec40 75 72 6e 0a 2a 2a 20 74 68 65 20 64 61 74 61 62  urn.** the datab
2ec50 61 73 65 20 6e 61 6d 65 2c 20 74 68 65 20 5f 74  ase name, the _t
2ec60 61 62 6c 65 5f 20 72 6f 75 74 69 6e 65 73 20 72  able_ routines r
2ec70 65 74 75 72 6e 20 74 68 65 20 74 61 62 6c 65 20  eturn the table 
2ec80 6e 61 6d 65 2c 20 61 6e 64 0a 2a 2a 20 74 68 65  name, and.** the
2ec90 20 6f 72 69 67 69 6e 5f 20 72 6f 75 74 69 6e 65   origin_ routine
2eca0 73 20 72 65 74 75 72 6e 20 74 68 65 20 63 6f 6c  s return the col
2ecb0 75 6d 6e 20 6e 61 6d 65 2e 0a 2a 2a 20 5e 54 68  umn name..** ^Th
2ecc0 65 20 72 65 74 75 72 6e 65 64 20 73 74 72 69 6e  e returned strin
2ecd0 67 20 69 73 20 76 61 6c 69 64 20 75 6e 74 69 6c  g is valid until
2ece0 20 74 68 65 20 5b 70 72 65 70 61 72 65 64 20 73   the [prepared s
2ecf0 74 61 74 65 6d 65 6e 74 5d 20 69 73 20 64 65 73  tatement] is des
2ed00 74 72 6f 79 65 64 0a 2a 2a 20 75 73 69 6e 67 20  troyed.** using 
2ed10 5b 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a  [sqlite3_finaliz
2ed20 65 28 29 5d 20 6f 72 20 75 6e 74 69 6c 20 74 68  e()] or until th
2ed30 65 20 73 74 61 74 65 6d 65 6e 74 20 69 73 20 61  e statement is a
2ed40 75 74 6f 6d 61 74 69 63 61 6c 6c 79 0a 2a 2a 20  utomatically.** 
2ed50 72 65 70 72 65 70 61 72 65 64 20 62 79 20 74 68  reprepared by th
2ed60 65 20 66 69 72 73 74 20 63 61 6c 6c 20 74 6f 20  e first call to 
2ed70 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d  [sqlite3_step()]
2ed80 20 66 6f 72 20 61 20 70 61 72 74 69 63 75 6c 61   for a particula
2ed90 72 20 72 75 6e 0a 2a 2a 20 6f 72 20 75 6e 74 69  r run.** or unti
2eda0 6c 20 74 68 65 20 73 61 6d 65 20 69 6e 66 6f 72  l the same infor
2edb0 6d 61 74 69 6f 6e 20 69 73 20 72 65 71 75 65 73  mation is reques
2edc0 74 65 64 0a 2a 2a 20 61 67 61 69 6e 20 69 6e 20  ted.** again in 
2edd0 61 20 64 69 66 66 65 72 65 6e 74 20 65 6e 63 6f  a different enco
2ede0 64 69 6e 67 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  ding..**.** ^The
2edf0 20 6e 61 6d 65 73 20 72 65 74 75 72 6e 65 64 20   names returned 
2ee00 61 72 65 20 74 68 65 20 6f 72 69 67 69 6e 61 6c  are the original
2ee10 20 75 6e 2d 61 6c 69 61 73 65 64 20 6e 61 6d 65   un-aliased name
2ee20 73 20 6f 66 20 74 68 65 0a 2a 2a 20 64 61 74 61  s of the.** data
2ee30 62 61 73 65 2c 20 74 61 62 6c 65 2c 20 61 6e 64  base, table, and
2ee40 20 63 6f 6c 75 6d 6e 2e 0a 2a 2a 0a 2a 2a 20 5e   column..**.** ^
2ee50 54 68 65 20 66 69 72 73 74 20 61 72 67 75 6d 65  The first argume
2ee60 6e 74 20 74 6f 20 74 68 65 73 65 20 69 6e 74 65  nt to these inte
2ee70 72 66 61 63 65 73 20 69 73 20 61 20 5b 70 72 65  rfaces is a [pre
2ee80 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d  pared statement]
2ee90 2e 0a 2a 2a 20 5e 54 68 65 73 65 20 66 75 6e 63  ..** ^These func
2eea0 74 69 6f 6e 73 20 72 65 74 75 72 6e 20 69 6e 66  tions return inf
2eeb0 6f 72 6d 61 74 69 6f 6e 20 61 62 6f 75 74 20 74  ormation about t
2eec0 68 65 20 4e 74 68 20 72 65 73 75 6c 74 20 63 6f  he Nth result co
2eed0 6c 75 6d 6e 20 72 65 74 75 72 6e 65 64 20 62 79  lumn returned by
2eee0 0a 2a 2a 20 74 68 65 20 73 74 61 74 65 6d 65 6e  .** the statemen
2eef0 74 2c 20 77 68 65 72 65 20 4e 20 69 73 20 74 68  t, where N is th
2ef00 65 20 73 65 63 6f 6e 64 20 66 75 6e 63 74 69 6f  e second functio
2ef10 6e 20 61 72 67 75 6d 65 6e 74 2e 0a 2a 2a 20 5e  n argument..** ^
2ef20 54 68 65 20 6c 65 66 74 2d 6d 6f 73 74 20 63 6f  The left-most co
2ef30 6c 75 6d 6e 20 69 73 20 63 6f 6c 75 6d 6e 20 30  lumn is column 0
2ef40 20 66 6f 72 20 74 68 65 73 65 20 72 6f 75 74 69   for these routi
2ef50 6e 65 73 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74  nes..**.** ^If t
2ef60 68 65 20 4e 74 68 20 63 6f 6c 75 6d 6e 20 72 65  he Nth column re
2ef70 74 75 72 6e 65 64 20 62 79 20 74 68 65 20 73 74  turned by the st
2ef80 61 74 65 6d 65 6e 74 20 69 73 20 61 6e 20 65 78  atement is an ex
2ef90 70 72 65 73 73 69 6f 6e 20 6f 72 0a 2a 2a 20 73  pression or.** s
2efa0 75 62 71 75 65 72 79 20 61 6e 64 20 69 73 20 6e  ubquery and is n
2efb0 6f 74 20 61 20 63 6f 6c 75 6d 6e 20 76 61 6c 75  ot a column valu
2efc0 65 2c 20 74 68 65 6e 20 61 6c 6c 20 6f 66 20 74  e, then all of t
2efd0 68 65 73 65 20 66 75 6e 63 74 69 6f 6e 73 20 72  hese functions r
2efe0 65 74 75 72 6e 0a 2a 2a 20 4e 55 4c 4c 2e 20 20  eturn.** NULL.  
2eff0 5e 54 68 65 73 65 20 72 6f 75 74 69 6e 65 20 6d  ^These routine m
2f000 69 67 68 74 20 61 6c 73 6f 20 72 65 74 75 72 6e  ight also return
2f010 20 4e 55 4c 4c 20 69 66 20 61 20 6d 65 6d 6f 72   NULL if a memor
2f020 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 65 72 72  y allocation err
2f030 6f 72 0a 2a 2a 20 6f 63 63 75 72 73 2e 20 20 5e  or.** occurs.  ^
2f040 4f 74 68 65 72 77 69 73 65 2c 20 74 68 65 79 20  Otherwise, they 
2f050 72 65 74 75 72 6e 20 74 68 65 20 6e 61 6d 65 20  return the name 
2f060 6f 66 20 74 68 65 20 61 74 74 61 63 68 65 64 20  of the attached 
2f070 64 61 74 61 62 61 73 65 2c 20 74 61 62 6c 65 2c  database, table,
2f080 0a 2a 2a 20 6f 72 20 63 6f 6c 75 6d 6e 20 74 68  .** or column th
2f090 61 74 20 71 75 65 72 79 20 72 65 73 75 6c 74 20  at query result 
2f0a0 63 6f 6c 75 6d 6e 20 77 61 73 20 65 78 74 72 61  column was extra
2f0b0 63 74 65 64 20 66 72 6f 6d 2e 0a 2a 2a 0a 2a 2a  cted from..**.**
2f0c0 20 5e 41 73 20 77 69 74 68 20 61 6c 6c 20 6f 74   ^As with all ot
2f0d0 68 65 72 20 53 51 4c 69 74 65 20 41 50 49 73 2c  her SQLite APIs,
2f0e0 20 74 68 6f 73 65 20 77 68 6f 73 65 20 6e 61 6d   those whose nam
2f0f0 65 73 20 65 6e 64 20 77 69 74 68 20 22 31 36 22  es end with "16"
2f100 20 72 65 74 75 72 6e 0a 2a 2a 20 55 54 46 2d 31   return.** UTF-1
2f110 36 20 65 6e 63 6f 64 65 64 20 73 74 72 69 6e 67  6 encoded string
2f120 73 20 61 6e 64 20 74 68 65 20 6f 74 68 65 72 20  s and the other 
2f130 66 75 6e 63 74 69 6f 6e 73 20 72 65 74 75 72 6e  functions return
2f140 20 55 54 46 2d 38 2e 0a 2a 2a 0a 2a 2a 20 5e 54   UTF-8..**.** ^T
2f150 68 65 73 65 20 41 50 49 73 20 61 72 65 20 6f 6e  hese APIs are on
2f160 6c 79 20 61 76 61 69 6c 61 62 6c 65 20 69 66 20  ly available if 
2f170 74 68 65 20 6c 69 62 72 61 72 79 20 77 61 73 20  the library was 
2f180 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 74 68  compiled with th
2f190 65 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 45 4e 41  e.** [SQLITE_ENA
2f1a0 42 4c 45 5f 43 4f 4c 55 4d 4e 5f 4d 45 54 41 44  BLE_COLUMN_METAD
2f1b0 41 54 41 5d 20 43 2d 70 72 65 70 72 6f 63 65 73  ATA] C-preproces
2f1c0 73 6f 72 20 73 79 6d 62 6f 6c 2e 0a 2a 2a 0a 2a  sor symbol..**.*
2f1d0 2a 20 49 66 20 74 77 6f 20 6f 72 20 6d 6f 72 65  * If two or more
2f1e0 20 74 68 72 65 61 64 73 20 63 61 6c 6c 20 6f 6e   threads call on
2f1f0 65 20 6f 72 20 6d 6f 72 65 20 6f 66 20 74 68 65  e or more of the
2f200 73 65 20 72 6f 75 74 69 6e 65 73 20 61 67 61 69  se routines agai
2f210 6e 73 74 20 74 68 65 20 73 61 6d 65 0a 2a 2a 20  nst the same.** 
2f220 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
2f230 6e 74 20 61 6e 64 20 63 6f 6c 75 6d 6e 20 61 74  nt and column at
2f240 20 74 68 65 20 73 61 6d 65 20 74 69 6d 65 20 74   the same time t
2f250 68 65 6e 20 74 68 65 20 72 65 73 75 6c 74 73 20  hen the results 
2f260 61 72 65 0a 2a 2a 20 75 6e 64 65 66 69 6e 65 64  are.** undefined
2f270 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 74 77 6f 20 6f  ..**.** If two o
2f280 72 20 6d 6f 72 65 20 74 68 72 65 61 64 73 20 63  r more threads c
2f290 61 6c 6c 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 0a  all one or more.
2f2a0 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75  ** [sqlite3_colu
2f2b0 6d 6e 5f 64 61 74 61 62 61 73 65 5f 6e 61 6d 65  mn_database_name
2f2c0 20 7c 20 63 6f 6c 75 6d 6e 20 6d 65 74 61 64 61   | column metada
2f2d0 74 61 20 69 6e 74 65 72 66 61 63 65 73 5d 0a 2a  ta interfaces].*
2f2e0 2a 20 66 6f 72 20 74 68 65 20 73 61 6d 65 20 5b  * for the same [
2f2f0 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
2f300 6e 74 5d 20 61 6e 64 20 72 65 73 75 6c 74 20 63  nt] and result c
2f310 6f 6c 75 6d 6e 0a 2a 2a 20 61 74 20 74 68 65 20  olumn.** at the 
2f320 73 61 6d 65 20 74 69 6d 65 20 74 68 65 6e 20 74  same time then t
2f330 68 65 20 72 65 73 75 6c 74 73 20 61 72 65 20 75  he results are u
2f340 6e 64 65 66 69 6e 65 64 2e 0a 2a 2f 0a 63 6f 6e  ndefined..*/.con
2f350 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33  st char *sqlite3
2f360 5f 63 6f 6c 75 6d 6e 5f 64 61 74 61 62 61 73 65  _column_database
2f370 5f 6e 61 6d 65 28 73 71 6c 69 74 65 33 5f 73 74  _name(sqlite3_st
2f380 6d 74 2a 2c 69 6e 74 29 3b 0a 63 6f 6e 73 74 20  mt*,int);.const 
2f390 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 63 6f  void *sqlite3_co
2f3a0 6c 75 6d 6e 5f 64 61 74 61 62 61 73 65 5f 6e 61  lumn_database_na
2f3b0 6d 65 31 36 28 73 71 6c 69 74 65 33 5f 73 74 6d  me16(sqlite3_stm
2f3c0 74 2a 2c 69 6e 74 29 3b 0a 63 6f 6e 73 74 20 63  t*,int);.const c
2f3d0 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c  har *sqlite3_col
2f3e0 75 6d 6e 5f 74 61 62 6c 65 5f 6e 61 6d 65 28 73  umn_table_name(s
2f3f0 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 69 6e 74  qlite3_stmt*,int
2f400 29 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73  );.const void *s
2f410 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 61  qlite3_column_ta
2f420 62 6c 65 5f 6e 61 6d 65 31 36 28 73 71 6c 69 74  ble_name16(sqlit
2f430 65 33 5f 73 74 6d 74 2a 2c 69 6e 74 29 3b 0a 63  e3_stmt*,int);.c
2f440 6f 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74  onst char *sqlit
2f450 65 33 5f 63 6f 6c 75 6d 6e 5f 6f 72 69 67 69 6e  e3_column_origin
2f460 5f 6e 61 6d 65 28 73 71 6c 69 74 65 33 5f 73 74  _name(sqlite3_st
2f470 6d 74 2a 2c 69 6e 74 29 3b 0a 63 6f 6e 73 74 20  mt*,int);.const 
2f480 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 63 6f  void *sqlite3_co
2f490 6c 75 6d 6e 5f 6f 72 69 67 69 6e 5f 6e 61 6d 65  lumn_origin_name
2f4a0 31 36 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a  16(sqlite3_stmt*
2f4b0 2c 69 6e 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41  ,int);../*.** CA
2f4c0 50 49 33 52 45 46 3a 20 44 65 63 6c 61 72 65 64  PI3REF: Declared
2f4d0 20 44 61 74 61 74 79 70 65 20 4f 66 20 41 20 51   Datatype Of A Q
2f4e0 75 65 72 79 20 52 65 73 75 6c 74 0a 2a 2a 20 4d  uery Result.** M
2f4f0 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73  ETHOD: sqlite3_s
2f500 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20  tmt.**.** ^(The 
2f510 66 69 72 73 74 20 70 61 72 61 6d 65 74 65 72 20  first parameter 
2f520 69 73 20 61 20 5b 70 72 65 70 61 72 65 64 20 73  is a [prepared s
2f530 74 61 74 65 6d 65 6e 74 5d 2e 0a 2a 2a 20 49 66  tatement]..** If
2f540 20 74 68 69 73 20 73 74 61 74 65 6d 65 6e 74 20   this statement 
2f550 69 73 20 61 20 5b 53 45 4c 45 43 54 5d 20 73 74  is a [SELECT] st
2f560 61 74 65 6d 65 6e 74 20 61 6e 64 20 74 68 65 20  atement and the 
2f570 4e 74 68 20 63 6f 6c 75 6d 6e 20 6f 66 20 74 68  Nth column of th
2f580 65 0a 2a 2a 20 72 65 74 75 72 6e 65 64 20 72 65  e.** returned re
2f590 73 75 6c 74 20 73 65 74 20 6f 66 20 74 68 61 74  sult set of that
2f5a0 20 5b 53 45 4c 45 43 54 5d 20 69 73 20 61 20 74   [SELECT] is a t
2f5b0 61 62 6c 65 20 63 6f 6c 75 6d 6e 20 28 6e 6f 74  able column (not
2f5c0 20 61 6e 0a 2a 2a 20 65 78 70 72 65 73 73 69 6f   an.** expressio
2f5d0 6e 20 6f 72 20 73 75 62 71 75 65 72 79 29 20 74  n or subquery) t
2f5e0 68 65 6e 20 74 68 65 20 64 65 63 6c 61 72 65 64  hen the declared
2f5f0 20 74 79 70 65 20 6f 66 20 74 68 65 20 74 61 62   type of the tab
2f600 6c 65 0a 2a 2a 20 63 6f 6c 75 6d 6e 20 69 73 20  le.** column is 
2f610 72 65 74 75 72 6e 65 64 2e 29 5e 20 20 5e 49 66  returned.)^  ^If
2f620 20 74 68 65 20 4e 74 68 20 63 6f 6c 75 6d 6e 20   the Nth column 
2f630 6f 66 20 74 68 65 20 72 65 73 75 6c 74 20 73 65  of the result se
2f640 74 20 69 73 20 61 6e 0a 2a 2a 20 65 78 70 72 65  t is an.** expre
2f650 73 73 69 6f 6e 20 6f 72 20 73 75 62 71 75 65 72  ssion or subquer
2f660 79 2c 20 74 68 65 6e 20 61 20 4e 55 4c 4c 20 70  y, then a NULL p
2f670 6f 69 6e 74 65 72 20 69 73 20 72 65 74 75 72 6e  ointer is return
2f680 65 64 2e 0a 2a 2a 20 5e 54 68 65 20 72 65 74 75  ed..** ^The retu
2f690 72 6e 65 64 20 73 74 72 69 6e 67 20 69 73 20 61  rned string is a
2f6a0 6c 77 61 79 73 20 55 54 46 2d 38 20 65 6e 63 6f  lways UTF-8 enco
2f6b0 64 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 28 46 6f 72  ded..**.** ^(For
2f6c0 20 65 78 61 6d 70 6c 65 2c 20 67 69 76 65 6e 20   example, given 
2f6d0 74 68 65 20 64 61 74 61 62 61 73 65 20 73 63 68  the database sch
2f6e0 65 6d 61 3a 0a 2a 2a 0a 2a 2a 20 43 52 45 41 54  ema:.**.** CREAT
2f6f0 45 20 54 41 42 4c 45 20 74 31 28 63 31 20 56 41  E TABLE t1(c1 VA
2f700 52 49 41 4e 54 29 3b 0a 2a 2a 0a 2a 2a 20 61 6e  RIANT);.**.** an
2f710 64 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20  d the following 
2f720 73 74 61 74 65 6d 65 6e 74 20 74 6f 20 62 65 20  statement to be 
2f730 63 6f 6d 70 69 6c 65 64 3a 0a 2a 2a 0a 2a 2a 20  compiled:.**.** 
2f740 53 45 4c 45 43 54 20 63 31 20 2b 20 31 2c 20 63  SELECT c1 + 1, c
2f750 31 20 46 52 4f 4d 20 74 31 3b 0a 2a 2a 0a 2a 2a  1 FROM t1;.**.**
2f760 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 77 6f   this routine wo
2f770 75 6c 64 20 72 65 74 75 72 6e 20 74 68 65 20 73  uld return the s
2f780 74 72 69 6e 67 20 22 56 41 52 49 41 4e 54 22 20  tring "VARIANT" 
2f790 66 6f 72 20 74 68 65 20 73 65 63 6f 6e 64 20 72  for the second r
2f7a0 65 73 75 6c 74 0a 2a 2a 20 63 6f 6c 75 6d 6e 20  esult.** column 
2f7b0 28 69 3d 3d 31 29 2c 20 61 6e 64 20 61 20 4e 55  (i==1), and a NU
2f7c0 4c 4c 20 70 6f 69 6e 74 65 72 20 66 6f 72 20 74  LL pointer for t
2f7d0 68 65 20 66 69 72 73 74 20 72 65 73 75 6c 74 20  he first result 
2f7e0 63 6f 6c 75 6d 6e 20 28 69 3d 3d 30 29 2e 29 5e  column (i==0).)^
2f7f0 0a 2a 2a 0a 2a 2a 20 5e 53 51 4c 69 74 65 20 75  .**.** ^SQLite u
2f800 73 65 73 20 64 79 6e 61 6d 69 63 20 72 75 6e 2d  ses dynamic run-
2f810 74 69 6d 65 20 74 79 70 69 6e 67 2e 20 20 5e 53  time typing.  ^S
2f820 6f 20 6a 75 73 74 20 62 65 63 61 75 73 65 20 61  o just because a
2f830 20 63 6f 6c 75 6d 6e 0a 2a 2a 20 69 73 20 64 65   column.** is de
2f840 63 6c 61 72 65 64 20 74 6f 20 63 6f 6e 74 61 69  clared to contai
2f850 6e 20 61 20 70 61 72 74 69 63 75 6c 61 72 20 74  n a particular t
2f860 79 70 65 20 64 6f 65 73 20 6e 6f 74 20 6d 65 61  ype does not mea
2f870 6e 20 74 68 61 74 20 74 68 65 0a 2a 2a 20 64 61  n that the.** da
2f880 74 61 20 73 74 6f 72 65 64 20 69 6e 20 74 68 61  ta stored in tha
2f890 74 20 63 6f 6c 75 6d 6e 20 69 73 20 6f 66 20 74  t column is of t
2f8a0 68 65 20 64 65 63 6c 61 72 65 64 20 74 79 70 65  he declared type
2f8b0 2e 20 20 53 51 4c 69 74 65 20 69 73 0a 2a 2a 20  .  SQLite is.** 
2f8c0 73 74 72 6f 6e 67 6c 79 20 74 79 70 65 64 2c 20  strongly typed, 
2f8d0 62 75 74 20 74 68 65 20 74 79 70 69 6e 67 20 69  but the typing i
2f8e0 73 20 64 79 6e 61 6d 69 63 20 6e 6f 74 20 73 74  s dynamic not st
2f8f0 61 74 69 63 2e 20 20 5e 54 79 70 65 0a 2a 2a 20  atic.  ^Type.** 
2f900 69 73 20 61 73 73 6f 63 69 61 74 65 64 20 77 69  is associated wi
2f910 74 68 20 69 6e 64 69 76 69 64 75 61 6c 20 76 61  th individual va
2f920 6c 75 65 73 2c 20 6e 6f 74 20 77 69 74 68 20 74  lues, not with t
2f930 68 65 20 63 6f 6e 74 61 69 6e 65 72 73 0a 2a 2a  he containers.**
2f940 20 75 73 65 64 20 74 6f 20 68 6f 6c 64 20 74 68   used to hold th
2f950 6f 73 65 20 76 61 6c 75 65 73 2e 0a 2a 2f 0a 63  ose values..*/.c
2f960 6f 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74  onst char *sqlit
2f970 65 33 5f 63 6f 6c 75 6d 6e 5f 64 65 63 6c 74 79  e3_column_declty
2f980 70 65 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a  pe(sqlite3_stmt*
2f990 2c 69 6e 74 29 3b 0a 63 6f 6e 73 74 20 76 6f 69  ,int);.const voi
2f9a0 64 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  d *sqlite3_colum
2f9b0 6e 5f 64 65 63 6c 74 79 70 65 31 36 28 73 71 6c  n_decltype16(sql
2f9c0 69 74 65 33 5f 73 74 6d 74 2a 2c 69 6e 74 29 3b  ite3_stmt*,int);
2f9d0 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
2f9e0 3a 20 45 76 61 6c 75 61 74 65 20 41 6e 20 53 51  : Evaluate An SQ
2f9f0 4c 20 53 74 61 74 65 6d 65 6e 74 0a 2a 2a 20 4d  L Statement.** M
2fa00 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73  ETHOD: sqlite3_s
2fa10 74 6d 74 0a 2a 2a 0a 2a 2a 20 41 66 74 65 72 20  tmt.**.** After 
2fa20 61 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74  a [prepared stat
2fa30 65 6d 65 6e 74 5d 20 68 61 73 20 62 65 65 6e 20  ement] has been 
2fa40 70 72 65 70 61 72 65 64 20 75 73 69 6e 67 20 65  prepared using e
2fa50 69 74 68 65 72 0a 2a 2a 20 5b 73 71 6c 69 74 65  ither.** [sqlite
2fa60 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d 20  3_prepare_v2()] 
2fa70 6f 72 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70  or [sqlite3_prep
2fa80 61 72 65 31 36 5f 76 32 28 29 5d 20 6f 72 20 6f  are16_v2()] or o
2fa90 6e 65 20 6f 66 20 74 68 65 20 6c 65 67 61 63 79  ne of the legacy
2faa0 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 73 20 5b  .** interfaces [
2fab0 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 28  sqlite3_prepare(
2fac0 29 5d 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f 70  )] or [sqlite3_p
2fad0 72 65 70 61 72 65 31 36 28 29 5d 2c 20 74 68 69  repare16()], thi
2fae0 73 20 66 75 6e 63 74 69 6f 6e 0a 2a 2a 20 6d 75  s function.** mu
2faf0 73 74 20 62 65 20 63 61 6c 6c 65 64 20 6f 6e 65  st be called one
2fb00 20 6f 72 20 6d 6f 72 65 20 74 69 6d 65 73 20 74   or more times t
2fb10 6f 20 65 76 61 6c 75 61 74 65 20 74 68 65 20 73  o evaluate the s
2fb20 74 61 74 65 6d 65 6e 74 2e 0a 2a 2a 0a 2a 2a 20  tatement..**.** 
2fb30 54 68 65 20 64 65 74 61 69 6c 73 20 6f 66 20 74  The details of t
2fb40 68 65 20 62 65 68 61 76 69 6f 72 20 6f 66 20 74  he behavior of t
2fb50 68 65 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28  he sqlite3_step(
2fb60 29 20 69 6e 74 65 72 66 61 63 65 20 64 65 70 65  ) interface depe
2fb70 6e 64 0a 2a 2a 20 6f 6e 20 77 68 65 74 68 65 72  nd.** on whether
2fb80 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20 77   the statement w
2fb90 61 73 20 70 72 65 70 61 72 65 64 20 75 73 69 6e  as prepared usin
2fba0 67 20 74 68 65 20 6e 65 77 65 72 20 22 76 32 22  g the newer "v2"
2fbb0 20 69 6e 74 65 72 66 61 63 65 0a 2a 2a 20 5b 73   interface.** [s
2fbc0 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76  qlite3_prepare_v
2fbd0 32 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65  2()] and [sqlite
2fbe0 33 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28 29  3_prepare16_v2()
2fbf0 5d 20 6f 72 20 74 68 65 20 6f 6c 64 65 72 20 6c  ] or the older l
2fc00 65 67 61 63 79 0a 2a 2a 20 69 6e 74 65 72 66 61  egacy.** interfa
2fc10 63 65 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70  ce [sqlite3_prep
2fc20 61 72 65 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69  are()] and [sqli
2fc30 74 65 33 5f 70 72 65 70 61 72 65 31 36 28 29 5d  te3_prepare16()]
2fc40 2e 20 20 54 68 65 20 75 73 65 20 6f 66 20 74 68  .  The use of th
2fc50 65 0a 2a 2a 20 6e 65 77 20 22 76 32 22 20 69 6e  e.** new "v2" in
2fc60 74 65 72 66 61 63 65 20 69 73 20 72 65 63 6f 6d  terface is recom
2fc70 6d 65 6e 64 65 64 20 66 6f 72 20 6e 65 77 20 61  mended for new a
2fc80 70 70 6c 69 63 61 74 69 6f 6e 73 20 62 75 74 20  pplications but 
2fc90 74 68 65 20 6c 65 67 61 63 79 0a 2a 2a 20 69 6e  the legacy.** in
2fca0 74 65 72 66 61 63 65 20 77 69 6c 6c 20 63 6f 6e  terface will con
2fcb0 74 69 6e 75 65 20 74 6f 20 62 65 20 73 75 70 70  tinue to be supp
2fcc0 6f 72 74 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 49 6e  orted..**.** ^In
2fcd0 20 74 68 65 20 6c 65 67 61 63 79 20 69 6e 74 65   the legacy inte
2fce0 72 66 61 63 65 2c 20 74 68 65 20 72 65 74 75 72  rface, the retur
2fcf0 6e 20 76 61 6c 75 65 20 77 69 6c 6c 20 62 65 20  n value will be 
2fd00 65 69 74 68 65 72 20 5b 53 51 4c 49 54 45 5f 42  either [SQLITE_B
2fd10 55 53 59 5d 2c 0a 2a 2a 20 5b 53 51 4c 49 54 45  USY],.** [SQLITE
2fd20 5f 44 4f 4e 45 5d 2c 20 5b 53 51 4c 49 54 45 5f  _DONE], [SQLITE_
2fd30 52 4f 57 5d 2c 20 5b 53 51 4c 49 54 45 5f 45 52  ROW], [SQLITE_ER
2fd40 52 4f 52 5d 2c 20 6f 72 20 5b 53 51 4c 49 54 45  ROR], or [SQLITE
2fd50 5f 4d 49 53 55 53 45 5d 2e 0a 2a 2a 20 5e 57 69  _MISUSE]..** ^Wi
2fd60 74 68 20 74 68 65 20 22 76 32 22 20 69 6e 74 65  th the "v2" inte
2fd70 72 66 61 63 65 2c 20 61 6e 79 20 6f 66 20 74 68  rface, any of th
2fd80 65 20 6f 74 68 65 72 20 5b 72 65 73 75 6c 74 20  e other [result 
2fd90 63 6f 64 65 73 5d 20 6f 72 0a 2a 2a 20 5b 65 78  codes] or.** [ex
2fda0 74 65 6e 64 65 64 20 72 65 73 75 6c 74 20 63 6f  tended result co
2fdb0 64 65 73 5d 20 6d 69 67 68 74 20 62 65 20 72 65  des] might be re
2fdc0 74 75 72 6e 65 64 20 61 73 20 77 65 6c 6c 2e 0a  turned as well..
2fdd0 2a 2a 0a 2a 2a 20 5e 5b 53 51 4c 49 54 45 5f 42  **.** ^[SQLITE_B
2fde0 55 53 59 5d 20 6d 65 61 6e 73 20 74 68 61 74 20  USY] means that 
2fdf0 74 68 65 20 64 61 74 61 62 61 73 65 20 65 6e 67  the database eng
2fe00 69 6e 65 20 77 61 73 20 75 6e 61 62 6c 65 20 74  ine was unable t
2fe10 6f 20 61 63 71 75 69 72 65 20 74 68 65 0a 2a 2a  o acquire the.**
2fe20 20 64 61 74 61 62 61 73 65 20 6c 6f 63 6b 73 20   database locks 
2fe30 69 74 20 6e 65 65 64 73 20 74 6f 20 64 6f 20 69  it needs to do i
2fe40 74 73 20 6a 6f 62 2e 20 20 5e 49 66 20 74 68 65  ts job.  ^If the
2fe50 20 73 74 61 74 65 6d 65 6e 74 20 69 73 20 61 20   statement is a 
2fe60 5b 43 4f 4d 4d 49 54 5d 0a 2a 2a 20 6f 72 20 6f  [COMMIT].** or o
2fe70 63 63 75 72 73 20 6f 75 74 73 69 64 65 20 6f 66  ccurs outside of
2fe80 20 61 6e 20 65 78 70 6c 69 63 69 74 20 74 72 61   an explicit tra
2fe90 6e 73 61 63 74 69 6f 6e 2c 20 74 68 65 6e 20 79  nsaction, then y
2fea0 6f 75 20 63 61 6e 20 72 65 74 72 79 20 74 68 65  ou can retry the
2feb0 0a 2a 2a 20 73 74 61 74 65 6d 65 6e 74 2e 20 20  .** statement.  
2fec0 49 66 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74  If the statement
2fed0 20 69 73 20 6e 6f 74 20 61 20 5b 43 4f 4d 4d 49   is not a [COMMI
2fee0 54 5d 20 61 6e 64 20 6f 63 63 75 72 73 20 77 69  T] and occurs wi
2fef0 74 68 69 6e 20 61 6e 0a 2a 2a 20 65 78 70 6c 69  thin an.** expli
2ff00 63 69 74 20 74 72 61 6e 73 61 63 74 69 6f 6e 20  cit transaction 
2ff10 74 68 65 6e 20 79 6f 75 20 73 68 6f 75 6c 64 20  then you should 
2ff20 72 6f 6c 6c 62 61 63 6b 20 74 68 65 20 74 72 61  rollback the tra
2ff30 6e 73 61 63 74 69 6f 6e 20 62 65 66 6f 72 65 0a  nsaction before.
2ff40 2a 2a 20 63 6f 6e 74 69 6e 75 69 6e 67 2e 0a 2a  ** continuing..*
2ff50 2a 0a 2a 2a 20 5e 5b 53 51 4c 49 54 45 5f 44 4f  *.** ^[SQLITE_DO
2ff60 4e 45 5d 20 6d 65 61 6e 73 20 74 68 61 74 20 74  NE] means that t
2ff70 68 65 20 73 74 61 74 65 6d 65 6e 74 20 68 61 73  he statement has
2ff80 20 66 69 6e 69 73 68 65 64 20 65 78 65 63 75 74   finished execut
2ff90 69 6e 67 0a 2a 2a 20 73 75 63 63 65 73 73 66 75  ing.** successfu
2ffa0 6c 6c 79 2e 20 20 73 71 6c 69 74 65 33 5f 73 74  lly.  sqlite3_st
2ffb0 65 70 28 29 20 73 68 6f 75 6c 64 20 6e 6f 74 20  ep() should not 
2ffc0 62 65 20 63 61 6c 6c 65 64 20 61 67 61 69 6e 20  be called again 
2ffd0 6f 6e 20 74 68 69 73 20 76 69 72 74 75 61 6c 0a  on this virtual.
2ffe0 2a 2a 20 6d 61 63 68 69 6e 65 20 77 69 74 68 6f  ** machine witho
2fff0 75 74 20 66 69 72 73 74 20 63 61 6c 6c 69 6e 67  ut first calling
30000 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28   [sqlite3_reset(
30010 29 5d 20 74 6f 20 72 65 73 65 74 20 74 68 65 20  )] to reset the 
30020 76 69 72 74 75 61 6c 0a 2a 2a 20 6d 61 63 68 69  virtual.** machi
30030 6e 65 20 62 61 63 6b 20 74 6f 20 69 74 73 20 69  ne back to its i
30040 6e 69 74 69 61 6c 20 73 74 61 74 65 2e 0a 2a 2a  nitial state..**
30050 0a 2a 2a 20 5e 49 66 20 74 68 65 20 53 51 4c 20  .** ^If the SQL 
30060 73 74 61 74 65 6d 65 6e 74 20 62 65 69 6e 67 20  statement being 
30070 65 78 65 63 75 74 65 64 20 72 65 74 75 72 6e 73  executed returns
30080 20 61 6e 79 20 64 61 74 61 2c 20 74 68 65 6e 20   any data, then 
30090 5b 53 51 4c 49 54 45 5f 52 4f 57 5d 0a 2a 2a 20  [SQLITE_ROW].** 
300a0 69 73 20 72 65 74 75 72 6e 65 64 20 65 61 63 68  is returned each
300b0 20 74 69 6d 65 20 61 20 6e 65 77 20 72 6f 77 20   time a new row 
300c0 6f 66 20 64 61 74 61 20 69 73 20 72 65 61 64 79  of data is ready
300d0 20 66 6f 72 20 70 72 6f 63 65 73 73 69 6e 67 20   for processing 
300e0 62 79 20 74 68 65 0a 2a 2a 20 63 61 6c 6c 65 72  by the.** caller
300f0 2e 20 54 68 65 20 76 61 6c 75 65 73 20 6d 61 79  . The values may
30100 20 62 65 20 61 63 63 65 73 73 65 64 20 75 73 69   be accessed usi
30110 6e 67 20 74 68 65 20 5b 63 6f 6c 75 6d 6e 20 61  ng the [column a
30120 63 63 65 73 73 20 66 75 6e 63 74 69 6f 6e 73 5d  ccess functions]
30130 2e 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 73 74 65  ..** sqlite3_ste
30140 70 28 29 20 69 73 20 63 61 6c 6c 65 64 20 61 67  p() is called ag
30150 61 69 6e 20 74 6f 20 72 65 74 72 69 65 76 65 20  ain to retrieve 
30160 74 68 65 20 6e 65 78 74 20 72 6f 77 20 6f 66 20  the next row of 
30170 64 61 74 61 2e 0a 2a 2a 0a 2a 2a 20 5e 5b 53 51  data..**.** ^[SQ
30180 4c 49 54 45 5f 45 52 52 4f 52 5d 20 6d 65 61 6e  LITE_ERROR] mean
30190 73 20 74 68 61 74 20 61 20 72 75 6e 2d 74 69 6d  s that a run-tim
301a0 65 20 65 72 72 6f 72 20 28 73 75 63 68 20 61 73  e error (such as
301b0 20 61 20 63 6f 6e 73 74 72 61 69 6e 74 0a 2a 2a   a constraint.**
301c0 20 76 69 6f 6c 61 74 69 6f 6e 29 20 68 61 73 20   violation) has 
301d0 6f 63 63 75 72 72 65 64 2e 20 20 73 71 6c 69 74  occurred.  sqlit
301e0 65 33 5f 73 74 65 70 28 29 20 73 68 6f 75 6c 64  e3_step() should
301f0 20 6e 6f 74 20 62 65 20 63 61 6c 6c 65 64 20 61   not be called a
30200 67 61 69 6e 20 6f 6e 0a 2a 2a 20 74 68 65 20 56  gain on.** the V
30210 4d 2e 20 4d 6f 72 65 20 69 6e 66 6f 72 6d 61 74  M. More informat
30220 69 6f 6e 20 6d 61 79 20 62 65 20 66 6f 75 6e 64  ion may be found
30230 20 62 79 20 63 61 6c 6c 69 6e 67 20 5b 73 71 6c   by calling [sql
30240 69 74 65 33 5f 65 72 72 6d 73 67 28 29 5d 2e 0a  ite3_errmsg()]..
30250 2a 2a 20 5e 57 69 74 68 20 74 68 65 20 6c 65 67  ** ^With the leg
30260 61 63 79 20 69 6e 74 65 72 66 61 63 65 2c 20 61  acy interface, a
30270 20 6d 6f 72 65 20 73 70 65 63 69 66 69 63 20 65   more specific e
30280 72 72 6f 72 20 63 6f 64 65 20 28 66 6f 72 20 65  rror code (for e
30290 78 61 6d 70 6c 65 2c 0a 2a 2a 20 5b 53 51 4c 49  xample,.** [SQLI
302a0 54 45 5f 49 4e 54 45 52 52 55 50 54 5d 2c 20 5b  TE_INTERRUPT], [
302b0 53 51 4c 49 54 45 5f 53 43 48 45 4d 41 5d 2c 20  SQLITE_SCHEMA], 
302c0 5b 53 51 4c 49 54 45 5f 43 4f 52 52 55 50 54 5d  [SQLITE_CORRUPT]
302d0 2c 20 61 6e 64 20 73 6f 20 66 6f 72 74 68 29 0a  , and so forth).
302e0 2a 2a 20 63 61 6e 20 62 65 20 6f 62 74 61 69 6e  ** can be obtain
302f0 65 64 20 62 79 20 63 61 6c 6c 69 6e 67 20 5b 73  ed by calling [s
30300 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20  qlite3_reset()] 
30310 6f 6e 20 74 68 65 0a 2a 2a 20 5b 70 72 65 70 61  on the.** [prepa
30320 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 2e 20  red statement]. 
30330 20 5e 49 6e 20 74 68 65 20 22 76 32 22 20 69 6e   ^In the "v2" in
30340 74 65 72 66 61 63 65 2c 0a 2a 2a 20 74 68 65 20  terface,.** the 
30350 6d 6f 72 65 20 73 70 65 63 69 66 69 63 20 65 72  more specific er
30360 72 6f 72 20 63 6f 64 65 20 69 73 20 72 65 74 75  ror code is retu
30370 72 6e 65 64 20 64 69 72 65 63 74 6c 79 20 62 79  rned directly by
30380 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 2e   sqlite3_step().
30390 0a 2a 2a 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 4d  .**.** [SQLITE_M
303a0 49 53 55 53 45 5d 20 6d 65 61 6e 73 20 74 68 61  ISUSE] means tha
303b0 74 20 74 68 65 20 74 68 69 73 20 72 6f 75 74 69  t the this routi
303c0 6e 65 20 77 61 73 20 63 61 6c 6c 65 64 20 69 6e  ne was called in
303d0 61 70 70 72 6f 70 72 69 61 74 65 6c 79 2e 0a 2a  appropriately..*
303e0 2a 20 50 65 72 68 61 70 73 20 69 74 20 77 61 73  * Perhaps it was
303f0 20 63 61 6c 6c 65 64 20 6f 6e 20 61 20 5b 70 72   called on a [pr
30400 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
30410 5d 20 74 68 61 74 20 68 61 73 0a 2a 2a 20 61 6c  ] that has.** al
30420 72 65 61 64 79 20 62 65 65 6e 20 5b 73 71 6c 69  ready been [sqli
30430 74 65 33 5f 66 69 6e 61 6c 69 7a 65 20 7c 20 66  te3_finalize | f
30440 69 6e 61 6c 69 7a 65 64 5d 20 6f 72 20 6f 6e 20  inalized] or on 
30450 6f 6e 65 20 74 68 61 74 20 68 61 64 0a 2a 2a 20  one that had.** 
30460 70 72 65 76 69 6f 75 73 6c 79 20 72 65 74 75 72  previously retur
30470 6e 65 64 20 5b 53 51 4c 49 54 45 5f 45 52 52 4f  ned [SQLITE_ERRO
30480 52 5d 20 6f 72 20 5b 53 51 4c 49 54 45 5f 44 4f  R] or [SQLITE_DO
30490 4e 45 5d 2e 20 20 4f 72 20 69 74 20 63 6f 75 6c  NE].  Or it coul
304a0 64 0a 2a 2a 20 62 65 20 74 68 65 20 63 61 73 65  d.** be the case
304b0 20 74 68 61 74 20 74 68 65 20 73 61 6d 65 20 64   that the same d
304c0 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
304d0 6f 6e 20 69 73 20 62 65 69 6e 67 20 75 73 65 64  on is being used
304e0 20 62 79 20 74 77 6f 20 6f 72 0a 2a 2a 20 6d 6f   by two or.** mo
304f0 72 65 20 74 68 72 65 61 64 73 20 61 74 20 74 68  re threads at th
30500 65 20 73 61 6d 65 20 6d 6f 6d 65 6e 74 20 69 6e  e same moment in
30510 20 74 69 6d 65 2e 0a 2a 2a 0a 2a 2a 20 46 6f 72   time..**.** For
30520 20 61 6c 6c 20 76 65 72 73 69 6f 6e 73 20 6f 66   all versions of
30530 20 53 51 4c 69 74 65 20 75 70 20 74 6f 20 61 6e   SQLite up to an
30540 64 20 69 6e 63 6c 75 64 69 6e 67 20 33 2e 36 2e  d including 3.6.
30550 32 33 2e 31 2c 20 61 20 63 61 6c 6c 20 74 6f 0a  23.1, a call to.
30560 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65  ** [sqlite3_rese
30570 74 28 29 5d 20 77 61 73 20 72 65 71 75 69 72 65  t()] was require
30580 64 20 61 66 74 65 72 20 73 71 6c 69 74 65 33 5f  d after sqlite3_
30590 73 74 65 70 28 29 20 72 65 74 75 72 6e 65 64 20  step() returned 
305a0 61 6e 79 74 68 69 6e 67 0a 2a 2a 20 6f 74 68 65  anything.** othe
305b0 72 20 74 68 61 6e 20 5b 53 51 4c 49 54 45 5f 52  r than [SQLITE_R
305c0 4f 57 5d 20 62 65 66 6f 72 65 20 61 6e 79 20 73  OW] before any s
305d0 75 62 73 65 71 75 65 6e 74 20 69 6e 76 6f 63 61  ubsequent invoca
305e0 74 69 6f 6e 20 6f 66 0a 2a 2a 20 73 71 6c 69 74  tion of.** sqlit
305f0 65 33 5f 73 74 65 70 28 29 2e 20 20 46 61 69 6c  e3_step().  Fail
30600 75 72 65 20 74 6f 20 72 65 73 65 74 20 74 68 65  ure to reset the
30610 20 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d   prepared statem
30620 65 6e 74 20 75 73 69 6e 67 20 0a 2a 2a 20 5b 73  ent using .** [s
30630 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20  qlite3_reset()] 
30640 77 6f 75 6c 64 20 72 65 73 75 6c 74 20 69 6e 20  would result in 
30650 61 6e 20 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53  an [SQLITE_MISUS
30660 45 5d 20 72 65 74 75 72 6e 20 66 72 6f 6d 0a 2a  E] return from.*
30670 2a 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29  * sqlite3_step()
30680 2e 20 20 42 75 74 20 61 66 74 65 72 20 76 65 72  .  But after ver
30690 73 69 6f 6e 20 33 2e 36 2e 32 33 2e 31 2c 20 73  sion 3.6.23.1, s
306a0 71 6c 69 74 65 33 5f 73 74 65 70 28 29 20 62 65  qlite3_step() be
306b0 67 61 6e 0a 2a 2a 20 63 61 6c 6c 69 6e 67 20 5b  gan.** calling [
306c0 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d  sqlite3_reset()]
306d0 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 69   automatically i
306e0 6e 20 74 68 69 73 20 63 69 72 63 75 6d 73 74 61  n this circumsta
306f0 6e 63 65 20 72 61 74 68 65 72 0a 2a 2a 20 74 68  nce rather.** th
30700 61 6e 20 72 65 74 75 72 6e 69 6e 67 20 5b 53 51  an returning [SQ
30710 4c 49 54 45 5f 4d 49 53 55 53 45 5d 2e 20 20 54  LITE_MISUSE].  T
30720 68 69 73 20 69 73 20 6e 6f 74 20 63 6f 6e 73 69  his is not consi
30730 64 65 72 65 64 20 61 20 63 6f 6d 70 61 74 69 62  dered a compatib
30740 69 6c 69 74 79 0a 2a 2a 20 62 72 65 61 6b 20 62  ility.** break b
30750 65 63 61 75 73 65 20 61 6e 79 20 61 70 70 6c 69  ecause any appli
30760 63 61 74 69 6f 6e 20 74 68 61 74 20 65 76 65 72  cation that ever
30770 20 72 65 63 65 69 76 65 73 20 61 6e 20 53 51 4c   receives an SQL
30780 49 54 45 5f 4d 49 53 55 53 45 20 65 72 72 6f 72  ITE_MISUSE error
30790 0a 2a 2a 20 69 73 20 62 72 6f 6b 65 6e 20 62 79  .** is broken by
307a0 20 64 65 66 69 6e 69 74 69 6f 6e 2e 20 20 54 68   definition.  Th
307b0 65 20 5b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41  e [SQLITE_OMIT_A
307c0 55 54 4f 52 45 53 45 54 5d 20 63 6f 6d 70 69 6c  UTORESET] compil
307d0 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 0a 2a 2a  e-time option.**
307e0 20 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20   can be used to 
307f0 72 65 73 74 6f 72 65 20 74 68 65 20 6c 65 67 61  restore the lega
30800 63 79 20 62 65 68 61 76 69 6f 72 2e 0a 2a 2a 0a  cy behavior..**.
30810 2a 2a 20 3c 62 3e 47 6f 6f 66 79 20 49 6e 74 65  ** <b>Goofy Inte
30820 72 66 61 63 65 20 41 6c 65 72 74 3a 3c 2f 62 3e  rface Alert:</b>
30830 20 49 6e 20 74 68 65 20 6c 65 67 61 63 79 20 69   In the legacy i
30840 6e 74 65 72 66 61 63 65 2c 20 74 68 65 20 73 71  nterface, the sq
30850 6c 69 74 65 33 5f 73 74 65 70 28 29 0a 2a 2a 20  lite3_step().** 
30860 41 50 49 20 61 6c 77 61 79 73 20 72 65 74 75 72  API always retur
30870 6e 73 20 61 20 67 65 6e 65 72 69 63 20 65 72 72  ns a generic err
30880 6f 72 20 63 6f 64 65 2c 20 5b 53 51 4c 49 54 45  or code, [SQLITE
30890 5f 45 52 52 4f 52 5d 2c 20 66 6f 6c 6c 6f 77 69  _ERROR], followi
308a0 6e 67 20 61 6e 79 0a 2a 2a 20 65 72 72 6f 72 20  ng any.** error 
308b0 6f 74 68 65 72 20 74 68 61 6e 20 5b 53 51 4c 49  other than [SQLI
308c0 54 45 5f 42 55 53 59 5d 20 61 6e 64 20 5b 53 51  TE_BUSY] and [SQ
308d0 4c 49 54 45 5f 4d 49 53 55 53 45 5d 2e 20 20 59  LITE_MISUSE].  Y
308e0 6f 75 20 6d 75 73 74 20 63 61 6c 6c 0a 2a 2a 20  ou must call.** 
308f0 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29  [sqlite3_reset()
30900 5d 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f 66 69  ] or [sqlite3_fi
30910 6e 61 6c 69 7a 65 28 29 5d 20 69 6e 20 6f 72 64  nalize()] in ord
30920 65 72 20 74 6f 20 66 69 6e 64 20 6f 6e 65 20 6f  er to find one o
30930 66 20 74 68 65 0a 2a 2a 20 73 70 65 63 69 66 69  f the.** specifi
30940 63 20 5b 65 72 72 6f 72 20 63 6f 64 65 73 5d 20  c [error codes] 
30950 74 68 61 74 20 62 65 74 74 65 72 20 64 65 73 63  that better desc
30960 72 69 62 65 73 20 74 68 65 20 65 72 72 6f 72 2e  ribes the error.
30970 0a 2a 2a 20 57 65 20 61 64 6d 69 74 20 74 68 61  .** We admit tha
30980 74 20 74 68 69 73 20 69 73 20 61 20 67 6f 6f 66  t this is a goof
30990 79 20 64 65 73 69 67 6e 2e 20 20 54 68 65 20 70  y design.  The p
309a0 72 6f 62 6c 65 6d 20 68 61 73 20 62 65 65 6e 20  roblem has been 
309b0 66 69 78 65 64 0a 2a 2a 20 77 69 74 68 20 74 68  fixed.** with th
309c0 65 20 22 76 32 22 20 69 6e 74 65 72 66 61 63 65  e "v2" interface
309d0 2e 20 20 49 66 20 79 6f 75 20 70 72 65 70 61 72  .  If you prepar
309e0 65 20 61 6c 6c 20 6f 66 20 79 6f 75 72 20 53 51  e all of your SQ
309f0 4c 20 73 74 61 74 65 6d 65 6e 74 73 0a 2a 2a 20  L statements.** 
30a00 75 73 69 6e 67 20 65 69 74 68 65 72 20 5b 73 71  using either [sq
30a10 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76 32  lite3_prepare_v2
30a20 28 29 5d 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f  ()] or [sqlite3_
30a30 70 72 65 70 61 72 65 31 36 5f 76 32 28 29 5d 20  prepare16_v2()] 
30a40 69 6e 73 74 65 61 64 0a 2a 2a 20 6f 66 20 74 68  instead.** of th
30a50 65 20 6c 65 67 61 63 79 20 5b 73 71 6c 69 74 65  e legacy [sqlite
30a60 33 5f 70 72 65 70 61 72 65 28 29 5d 20 61 6e 64  3_prepare()] and
30a70 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72   [sqlite3_prepar
30a80 65 31 36 28 29 5d 20 69 6e 74 65 72 66 61 63 65  e16()] interface
30a90 73 2c 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20 6d  s,.** then the m
30aa0 6f 72 65 20 73 70 65 63 69 66 69 63 20 5b 65 72  ore specific [er
30ab0 72 6f 72 20 63 6f 64 65 73 5d 20 61 72 65 20 72  ror codes] are r
30ac0 65 74 75 72 6e 65 64 20 64 69 72 65 63 74 6c 79  eturned directly
30ad0 0a 2a 2a 20 62 79 20 73 71 6c 69 74 65 33 5f 73  .** by sqlite3_s
30ae0 74 65 70 28 29 2e 20 20 54 68 65 20 75 73 65 20  tep().  The use 
30af0 6f 66 20 74 68 65 20 22 76 32 22 20 69 6e 74 65  of the "v2" inte
30b00 72 66 61 63 65 20 69 73 20 72 65 63 6f 6d 6d 65  rface is recomme
30b10 6e 64 65 64 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c  nded..*/.int sql
30b20 69 74 65 33 5f 73 74 65 70 28 73 71 6c 69 74 65  ite3_step(sqlite
30b30 33 5f 73 74 6d 74 2a 29 3b 0a 0a 2f 2a 0a 2a 2a  3_stmt*);../*.**
30b40 20 43 41 50 49 33 52 45 46 3a 20 4e 75 6d 62 65   CAPI3REF: Numbe
30b50 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 20 69 6e 20  r of columns in 
30b60 61 20 72 65 73 75 6c 74 20 73 65 74 0a 2a 2a 20  a result set.** 
30b70 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f  METHOD: sqlite3_
30b80 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  stmt.**.** ^The 
30b90 73 71 6c 69 74 65 33 5f 64 61 74 61 5f 63 6f 75  sqlite3_data_cou
30ba0 6e 74 28 50 29 20 69 6e 74 65 72 66 61 63 65 20  nt(P) interface 
30bb0 72 65 74 75 72 6e 73 20 74 68 65 20 6e 75 6d 62  returns the numb
30bc0 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 20 69 6e  er of columns in
30bd0 20 74 68 65 0a 2a 2a 20 63 75 72 72 65 6e 74 20   the.** current 
30be0 72 6f 77 20 6f 66 20 74 68 65 20 72 65 73 75 6c  row of the resul
30bf0 74 20 73 65 74 20 6f 66 20 5b 70 72 65 70 61 72  t set of [prepar
30c00 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 50 2e  ed statement] P.
30c10 0a 2a 2a 20 5e 49 66 20 70 72 65 70 61 72 65 64  .** ^If prepared
30c20 20 73 74 61 74 65 6d 65 6e 74 20 50 20 64 6f 65   statement P doe
30c30 73 20 6e 6f 74 20 68 61 76 65 20 72 65 73 75 6c  s not have resul
30c40 74 73 20 72 65 61 64 79 20 74 6f 20 72 65 74 75  ts ready to retu
30c50 72 6e 0a 2a 2a 20 28 76 69 61 20 63 61 6c 6c 73  rn.** (via calls
30c60 20 74 6f 20 74 68 65 20 5b 73 71 6c 69 74 65 33   to the [sqlite3
30c70 5f 63 6f 6c 75 6d 6e 5f 69 6e 74 20 7c 20 73 71  _column_int | sq
30c80 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 2a 28 29  lite3_column_*()
30c90 5d 20 6f 66 0a 2a 2a 20 69 6e 74 65 72 66 61 63  ] of.** interfac
30ca0 65 73 29 20 74 68 65 6e 20 73 71 6c 69 74 65 33  es) then sqlite3
30cb0 5f 64 61 74 61 5f 63 6f 75 6e 74 28 50 29 20 72  _data_count(P) r
30cc0 65 74 75 72 6e 73 20 30 2e 0a 2a 2a 20 5e 54 68  eturns 0..** ^Th
30cd0 65 20 73 71 6c 69 74 65 33 5f 64 61 74 61 5f 63  e sqlite3_data_c
30ce0 6f 75 6e 74 28 50 29 20 72 6f 75 74 69 6e 65 20  ount(P) routine 
30cf0 61 6c 73 6f 20 72 65 74 75 72 6e 73 20 30 20 69  also returns 0 i
30d00 66 20 50 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f  f P is a NULL po
30d10 69 6e 74 65 72 2e 0a 2a 2a 20 5e 54 68 65 20 73  inter..** ^The s
30d20 71 6c 69 74 65 33 5f 64 61 74 61 5f 63 6f 75 6e  qlite3_data_coun
30d30 74 28 50 29 20 72 6f 75 74 69 6e 65 20 72 65 74  t(P) routine ret
30d40 75 72 6e 73 20 30 20 69 66 20 74 68 65 20 70 72  urns 0 if the pr
30d50 65 76 69 6f 75 73 20 63 61 6c 6c 20 74 6f 0a 2a  evious call to.*
30d60 2a 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 5d  * [sqlite3_step]
30d70 28 50 29 20 72 65 74 75 72 6e 65 64 20 5b 53 51  (P) returned [SQ
30d80 4c 49 54 45 5f 44 4f 4e 45 5d 2e 20 20 5e 54 68  LITE_DONE].  ^Th
30d90 65 20 73 71 6c 69 74 65 33 5f 64 61 74 61 5f 63  e sqlite3_data_c
30da0 6f 75 6e 74 28 50 29 0a 2a 2a 20 77 69 6c 6c 20  ount(P).** will 
30db0 72 65 74 75 72 6e 20 6e 6f 6e 2d 7a 65 72 6f 20  return non-zero 
30dc0 69 66 20 70 72 65 76 69 6f 75 73 20 63 61 6c 6c  if previous call
30dd0 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 73 74 65   to [sqlite3_ste
30de0 70 5d 28 50 29 20 72 65 74 75 72 6e 65 64 0a 2a  p](P) returned.*
30df0 2a 20 5b 53 51 4c 49 54 45 5f 52 4f 57 5d 2c 20  * [SQLITE_ROW], 
30e00 65 78 63 65 70 74 20 69 6e 20 74 68 65 20 63 61  except in the ca
30e10 73 65 20 6f 66 20 74 68 65 20 5b 50 52 41 47 4d  se of the [PRAGM
30e20 41 20 69 6e 63 72 65 6d 65 6e 74 61 6c 5f 76 61  A incremental_va
30e30 63 75 75 6d 5d 0a 2a 2a 20 77 68 65 72 65 20 69  cuum].** where i
30e40 74 20 61 6c 77 61 79 73 20 72 65 74 75 72 6e 73  t always returns
30e50 20 7a 65 72 6f 20 73 69 6e 63 65 20 65 61 63 68   zero since each
30e60 20 73 74 65 70 20 6f 66 20 74 68 61 74 20 6d 75   step of that mu
30e70 6c 74 69 2d 73 74 65 70 0a 2a 2a 20 70 72 61 67  lti-step.** prag
30e80 6d 61 20 72 65 74 75 72 6e 73 20 30 20 63 6f 6c  ma returns 0 col
30e90 75 6d 6e 73 20 6f 66 20 64 61 74 61 2e 0a 2a 2a  umns of data..**
30ea0 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 3a 20 5b 73  .** See also: [s
30eb0 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 63 6f  qlite3_column_co
30ec0 75 6e 74 28 29 5d 0a 2a 2f 0a 69 6e 74 20 73 71  unt()].*/.int sq
30ed0 6c 69 74 65 33 5f 64 61 74 61 5f 63 6f 75 6e 74  lite3_data_count
30ee0 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 20 2a 70  (sqlite3_stmt *p
30ef0 53 74 6d 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41  Stmt);../*.** CA
30f00 50 49 33 52 45 46 3a 20 46 75 6e 64 61 6d 65 6e  PI3REF: Fundamen
30f10 74 61 6c 20 44 61 74 61 74 79 70 65 73 0a 2a 2a  tal Datatypes.**
30f20 20 4b 45 59 57 4f 52 44 53 3a 20 53 51 4c 49 54   KEYWORDS: SQLIT
30f30 45 5f 54 45 58 54 0a 2a 2a 0a 2a 2a 20 5e 28 45  E_TEXT.**.** ^(E
30f40 76 65 72 79 20 76 61 6c 75 65 20 69 6e 20 53 51  very value in SQ
30f50 4c 69 74 65 20 68 61 73 20 6f 6e 65 20 6f 66 20  Lite has one of 
30f60 66 69 76 65 20 66 75 6e 64 61 6d 65 6e 74 61 6c  five fundamental
30f70 20 64 61 74 61 74 79 70 65 73 3a 0a 2a 2a 0a 2a   datatypes:.**.*
30f80 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20 36  * <ul>.** <li> 6
30f90 34 2d 62 69 74 20 73 69 67 6e 65 64 20 69 6e 74  4-bit signed int
30fa0 65 67 65 72 0a 2a 2a 20 3c 6c 69 3e 20 36 34 2d  eger.** <li> 64-
30fb0 62 69 74 20 49 45 45 45 20 66 6c 6f 61 74 69 6e  bit IEEE floatin
30fc0 67 20 70 6f 69 6e 74 20 6e 75 6d 62 65 72 0a 2a  g point number.*
30fd0 2a 20 3c 6c 69 3e 20 73 74 72 69 6e 67 0a 2a 2a  * <li> string.**
30fe0 20 3c 6c 69 3e 20 42 4c 4f 42 0a 2a 2a 20 3c 6c   <li> BLOB.** <l
30ff0 69 3e 20 4e 55 4c 4c 0a 2a 2a 20 3c 2f 75 6c 3e  i> NULL.** </ul>
31000 29 5e 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 63  )^.**.** These c
31010 6f 6e 73 74 61 6e 74 73 20 61 72 65 20 63 6f 64  onstants are cod
31020 65 73 20 66 6f 72 20 65 61 63 68 20 6f 66 20 74  es for each of t
31030 68 6f 73 65 20 74 79 70 65 73 2e 0a 2a 2a 0a 2a  hose types..**.*
31040 2a 20 4e 6f 74 65 20 74 68 61 74 20 74 68 65 20  * Note that the 
31050 53 51 4c 49 54 45 5f 54 45 58 54 20 63 6f 6e 73  SQLITE_TEXT cons
31060 74 61 6e 74 20 77 61 73 20 61 6c 73 6f 20 75 73  tant was also us
31070 65 64 20 69 6e 20 53 51 4c 69 74 65 20 76 65 72  ed in SQLite ver
31080 73 69 6f 6e 20 32 0a 2a 2a 20 66 6f 72 20 61 20  sion 2.** for a 
31090 63 6f 6d 70 6c 65 74 65 6c 79 20 64 69 66 66 65  completely diffe
310a0 72 65 6e 74 20 6d 65 61 6e 69 6e 67 2e 20 20 53  rent meaning.  S
310b0 6f 66 74 77 61 72 65 20 74 68 61 74 20 6c 69 6e  oftware that lin
310c0 6b 73 20 61 67 61 69 6e 73 74 20 62 6f 74 68 0a  ks against both.
310d0 2a 2a 20 53 51 4c 69 74 65 20 76 65 72 73 69 6f  ** SQLite versio
310e0 6e 20 32 20 61 6e 64 20 53 51 4c 69 74 65 20 76  n 2 and SQLite v
310f0 65 72 73 69 6f 6e 20 33 20 73 68 6f 75 6c 64 20  ersion 3 should 
31100 75 73 65 20 53 51 4c 49 54 45 33 5f 54 45 58 54  use SQLITE3_TEXT
31110 2c 20 6e 6f 74 0a 2a 2a 20 53 51 4c 49 54 45 5f  , not.** SQLITE_
31120 54 45 58 54 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65  TEXT..*/.#define
31130 20 53 51 4c 49 54 45 5f 49 4e 54 45 47 45 52 20   SQLITE_INTEGER 
31140 20 31 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54   1.#define SQLIT
31150 45 5f 46 4c 4f 41 54 20 20 20 20 32 0a 23 64 65  E_FLOAT    2.#de
31160 66 69 6e 65 20 53 51 4c 49 54 45 5f 42 4c 4f 42  fine SQLITE_BLOB
31170 20 20 20 20 20 34 0a 23 64 65 66 69 6e 65 20 53       4.#define S
31180 51 4c 49 54 45 5f 4e 55 4c 4c 20 20 20 20 20 35  QLITE_NULL     5
31190 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 54  .#ifdef SQLITE_T
311a0 45 58 54 0a 23 20 75 6e 64 65 66 20 53 51 4c 49  EXT.# undef SQLI
311b0 54 45 5f 54 45 58 54 0a 23 65 6c 73 65 0a 23 20  TE_TEXT.#else.# 
311c0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 54 45  define SQLITE_TE
311d0 58 54 20 20 20 20 20 33 0a 23 65 6e 64 69 66 0a  XT     3.#endif.
311e0 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 33 5f  #define SQLITE3_
311f0 54 45 58 54 20 20 20 20 20 33 0a 0a 2f 2a 0a 2a  TEXT     3../*.*
31200 2a 20 43 41 50 49 33 52 45 46 3a 20 52 65 73 75  * CAPI3REF: Resu
31210 6c 74 20 56 61 6c 75 65 73 20 46 72 6f 6d 20 41  lt Values From A
31220 20 51 75 65 72 79 0a 2a 2a 20 4b 45 59 57 4f 52   Query.** KEYWOR
31230 44 53 3a 20 7b 63 6f 6c 75 6d 6e 20 61 63 63 65  DS: {column acce
31240 73 73 20 66 75 6e 63 74 69 6f 6e 73 7d 0a 2a 2a  ss functions}.**
31250 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33   METHOD: sqlite3
31260 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  _stmt.**.** ^The
31270 73 65 20 72 6f 75 74 69 6e 65 73 20 72 65 74 75  se routines retu
31280 72 6e 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 61  rn information a
31290 62 6f 75 74 20 61 20 73 69 6e 67 6c 65 20 63 6f  bout a single co
312a0 6c 75 6d 6e 20 6f 66 20 74 68 65 20 63 75 72 72  lumn of the curr
312b0 65 6e 74 0a 2a 2a 20 72 65 73 75 6c 74 20 72 6f  ent.** result ro
312c0 77 20 6f 66 20 61 20 71 75 65 72 79 2e 20 20 5e  w of a query.  ^
312d0 49 6e 20 65 76 65 72 79 20 63 61 73 65 20 74 68  In every case th
312e0 65 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74  e first argument
312f0 20 69 73 20 61 20 70 6f 69 6e 74 65 72 0a 2a 2a   is a pointer.**
31300 20 74 6f 20 74 68 65 20 5b 70 72 65 70 61 72 65   to the [prepare
31310 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 74 68 61  d statement] tha
31320 74 20 69 73 20 62 65 69 6e 67 20 65 76 61 6c 75  t is being evalu
31330 61 74 65 64 20 28 74 68 65 20 5b 73 71 6c 69 74  ated (the [sqlit
31340 65 33 5f 73 74 6d 74 2a 5d 0a 2a 2a 20 74 68 61  e3_stmt*].** tha
31350 74 20 77 61 73 20 72 65 74 75 72 6e 65 64 20 66  t was returned f
31360 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 70 72 65  rom [sqlite3_pre
31370 70 61 72 65 5f 76 32 28 29 5d 20 6f 72 20 6f 6e  pare_v2()] or on
31380 65 20 6f 66 20 69 74 73 20 76 61 72 69 61 6e 74  e of its variant
31390 73 29 0a 2a 2a 20 61 6e 64 20 74 68 65 20 73 65  s).** and the se
313a0 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20 69 73  cond argument is
313b0 20 74 68 65 20 69 6e 64 65 78 20 6f 66 20 74 68   the index of th
313c0 65 20 63 6f 6c 75 6d 6e 20 66 6f 72 20 77 68 69  e column for whi
313d0 63 68 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 0a 2a  ch information.*
313e0 2a 20 73 68 6f 75 6c 64 20 62 65 20 72 65 74 75  * should be retu
313f0 72 6e 65 64 2e 20 5e 54 68 65 20 6c 65 66 74 6d  rned. ^The leftm
31400 6f 73 74 20 63 6f 6c 75 6d 6e 20 6f 66 20 74 68  ost column of th
31410 65 20 72 65 73 75 6c 74 20 73 65 74 20 68 61 73  e result set has
31420 20 74 68 65 20 69 6e 64 65 78 20 30 2e 0a 2a 2a   the index 0..**
31430 20 5e 54 68 65 20 6e 75 6d 62 65 72 20 6f 66 20   ^The number of 
31440 63 6f 6c 75 6d 6e 73 20 69 6e 20 74 68 65 20 72  columns in the r
31450 65 73 75 6c 74 20 63 61 6e 20 62 65 20 64 65 74  esult can be det
31460 65 72 6d 69 6e 65 64 20 75 73 69 6e 67 0a 2a 2a  ermined using.**
31470 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e   [sqlite3_column
31480 5f 63 6f 75 6e 74 28 29 5d 2e 0a 2a 2a 0a 2a 2a  _count()]..**.**
31490 20 49 66 20 74 68 65 20 53 51 4c 20 73 74 61 74   If the SQL stat
314a0 65 6d 65 6e 74 20 64 6f 65 73 20 6e 6f 74 20 63  ement does not c
314b0 75 72 72 65 6e 74 6c 79 20 70 6f 69 6e 74 20 74  urrently point t
314c0 6f 20 61 20 76 61 6c 69 64 20 72 6f 77 2c 20 6f  o a valid row, o
314d0 72 20 69 66 20 74 68 65 0a 2a 2a 20 63 6f 6c 75  r if the.** colu
314e0 6d 6e 20 69 6e 64 65 78 20 69 73 20 6f 75 74 20  mn index is out 
314f0 6f 66 20 72 61 6e 67 65 2c 20 74 68 65 20 72 65  of range, the re
31500 73 75 6c 74 20 69 73 20 75 6e 64 65 66 69 6e 65  sult is undefine
31510 64 2e 0a 2a 2a 20 54 68 65 73 65 20 72 6f 75 74  d..** These rout
31520 69 6e 65 73 20 6d 61 79 20 6f 6e 6c 79 20 62 65  ines may only be
31530 20 63 61 6c 6c 65 64 20 77 68 65 6e 20 74 68 65   called when the
31540 20 6d 6f 73 74 20 72 65 63 65 6e 74 20 63 61 6c   most recent cal
31550 6c 20 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  l to.** [sqlite3
31560 5f 73 74 65 70 28 29 5d 20 68 61 73 20 72 65 74  _step()] has ret
31570 75 72 6e 65 64 20 5b 53 51 4c 49 54 45 5f 52 4f  urned [SQLITE_RO
31580 57 5d 20 61 6e 64 20 6e 65 69 74 68 65 72 0a 2a  W] and neither.*
31590 2a 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74  * [sqlite3_reset
315a0 28 29 5d 20 6e 6f 72 20 5b 73 71 6c 69 74 65 33  ()] nor [sqlite3
315b0 5f 66 69 6e 61 6c 69 7a 65 28 29 5d 20 68 61 76  _finalize()] hav
315c0 65 20 62 65 65 6e 20 63 61 6c 6c 65 64 20 73 75  e been called su
315d0 62 73 65 71 75 65 6e 74 6c 79 2e 0a 2a 2a 20 49  bsequently..** I
315e0 66 20 61 6e 79 20 6f 66 20 74 68 65 73 65 20 72  f any of these r
315f0 6f 75 74 69 6e 65 73 20 61 72 65 20 63 61 6c 6c  outines are call
31600 65 64 20 61 66 74 65 72 20 5b 73 71 6c 69 74 65  ed after [sqlite
31610 33 5f 72 65 73 65 74 28 29 5d 20 6f 72 0a 2a 2a  3_reset()] or.**
31620 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69   [sqlite3_finali
31630 7a 65 28 29 5d 20 6f 72 20 61 66 74 65 72 20 5b  ze()] or after [
31640 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20  sqlite3_step()] 
31650 68 61 73 20 72 65 74 75 72 6e 65 64 0a 2a 2a 20  has returned.** 
31660 73 6f 6d 65 74 68 69 6e 67 20 6f 74 68 65 72 20  something other 
31670 74 68 61 6e 20 5b 53 51 4c 49 54 45 5f 52 4f 57  than [SQLITE_ROW
31680 5d 2c 20 74 68 65 20 72 65 73 75 6c 74 73 20 61  ], the results a
31690 72 65 20 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a  re undefined..**
316a0 20 49 66 20 5b 73 71 6c 69 74 65 33 5f 73 74 65   If [sqlite3_ste
316b0 70 28 29 5d 20 6f 72 20 5b 73 71 6c 69 74 65 33  p()] or [sqlite3
316c0 5f 72 65 73 65 74 28 29 5d 20 6f 72 20 5b 73 71  _reset()] or [sq
316d0 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28 29  lite3_finalize()
316e0 5d 0a 2a 2a 20 61 72 65 20 63 61 6c 6c 65 64 20  ].** are called 
316f0 66 72 6f 6d 20 61 20 64 69 66 66 65 72 65 6e 74  from a different
31700 20 74 68 72 65 61 64 20 77 68 69 6c 65 20 61 6e   thread while an
31710 79 20 6f 66 20 74 68 65 73 65 20 72 6f 75 74 69  y of these routi
31720 6e 65 73 0a 2a 2a 20 61 72 65 20 70 65 6e 64 69  nes.** are pendi
31730 6e 67 2c 20 74 68 65 6e 20 74 68 65 20 72 65 73  ng, then the res
31740 75 6c 74 73 20 61 72 65 20 75 6e 64 65 66 69 6e  ults are undefin
31750 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  ed..**.** ^The s
31760 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 79  qlite3_column_ty
31770 70 65 28 29 20 72 6f 75 74 69 6e 65 20 72 65 74  pe() routine ret
31780 75 72 6e 73 20 74 68 65 0a 2a 2a 20 5b 53 51 4c  urns the.** [SQL
31790 49 54 45 5f 49 4e 54 45 47 45 52 20 7c 20 64 61  ITE_INTEGER | da
317a0 74 61 74 79 70 65 20 63 6f 64 65 5d 20 66 6f 72  tatype code] for
317b0 20 74 68 65 20 69 6e 69 74 69 61 6c 20 64 61 74   the initial dat
317c0 61 20 74 79 70 65 0a 2a 2a 20 6f 66 20 74 68 65  a type.** of the
317d0 20 72 65 73 75 6c 74 20 63 6f 6c 75 6d 6e 2e 20   result column. 
317e0 20 5e 54 68 65 20 72 65 74 75 72 6e 65 64 20 76   ^The returned v
317f0 61 6c 75 65 20 69 73 20 6f 6e 65 20 6f 66 20 5b  alue is one of [
31800 53 51 4c 49 54 45 5f 49 4e 54 45 47 45 52 5d 2c  SQLITE_INTEGER],
31810 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 46 4c 4f 41  .** [SQLITE_FLOA
31820 54 5d 2c 20 5b 53 51 4c 49 54 45 5f 54 45 58 54  T], [SQLITE_TEXT
31830 5d 2c 20 5b 53 51 4c 49 54 45 5f 42 4c 4f 42 5d  ], [SQLITE_BLOB]
31840 2c 20 6f 72 20 5b 53 51 4c 49 54 45 5f 4e 55 4c  , or [SQLITE_NUL
31850 4c 5d 2e 20 20 54 68 65 20 76 61 6c 75 65 0a 2a  L].  The value.*
31860 2a 20 72 65 74 75 72 6e 65 64 20 62 79 20 73 71  * returned by sq
31870 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 79 70  lite3_column_typ
31880 65 28 29 20 69 73 20 6f 6e 6c 79 20 6d 65 61 6e  e() is only mean
31890 69 6e 67 66 75 6c 20 69 66 20 6e 6f 20 74 79 70  ingful if no typ
318a0 65 0a 2a 2a 20 63 6f 6e 76 65 72 73 69 6f 6e 73  e.** conversions
318b0 20 68 61 76 65 20 6f 63 63 75 72 72 65 64 20 61   have occurred a
318c0 73 20 64 65 73 63 72 69 62 65 64 20 62 65 6c 6f  s described belo
318d0 77 2e 20 20 41 66 74 65 72 20 61 20 74 79 70 65  w.  After a type
318e0 20 63 6f 6e 76 65 72 73 69 6f 6e 2c 0a 2a 2a 20   conversion,.** 
318f0 74 68 65 20 76 61 6c 75 65 20 72 65 74 75 72 6e  the value return
31900 65 64 20 62 79 20 73 71 6c 69 74 65 33 5f 63 6f  ed by sqlite3_co
31910 6c 75 6d 6e 5f 74 79 70 65 28 29 20 69 73 20 75  lumn_type() is u
31920 6e 64 65 66 69 6e 65 64 2e 20 20 46 75 74 75 72  ndefined.  Futur
31930 65 0a 2a 2a 20 76 65 72 73 69 6f 6e 73 20 6f 66  e.** versions of
31940 20 53 51 4c 69 74 65 20 6d 61 79 20 63 68 61 6e   SQLite may chan
31950 67 65 20 74 68 65 20 62 65 68 61 76 69 6f 72 20  ge the behavior 
31960 6f 66 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  of sqlite3_colum
31970 6e 5f 74 79 70 65 28 29 0a 2a 2a 20 66 6f 6c 6c  n_type().** foll
31980 6f 77 69 6e 67 20 61 20 74 79 70 65 20 63 6f 6e  owing a type con
31990 76 65 72 73 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e  version..**.** ^
319a0 49 66 20 74 68 65 20 72 65 73 75 6c 74 20 69 73  If the result is
319b0 20 61 20 42 4c 4f 42 20 6f 72 20 55 54 46 2d 38   a BLOB or UTF-8
319c0 20 73 74 72 69 6e 67 20 74 68 65 6e 20 74 68 65   string then the
319d0 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
319e0 62 79 74 65 73 28 29 0a 2a 2a 20 72 6f 75 74 69  bytes().** routi
319f0 6e 65 20 72 65 74 75 72 6e 73 20 74 68 65 20 6e  ne returns the n
31a00 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73 20 69  umber of bytes i
31a10 6e 20 74 68 61 74 20 42 4c 4f 42 20 6f 72 20 73  n that BLOB or s
31a20 74 72 69 6e 67 2e 0a 2a 2a 20 5e 49 66 20 74 68  tring..** ^If th
31a30 65 20 72 65 73 75 6c 74 20 69 73 20 61 20 55 54  e result is a UT
31a40 46 2d 31 36 20 73 74 72 69 6e 67 2c 20 74 68 65  F-16 string, the
31a50 6e 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  n sqlite3_column
31a60 5f 62 79 74 65 73 28 29 20 63 6f 6e 76 65 72 74  _bytes() convert
31a70 73 0a 2a 2a 20 74 68 65 20 73 74 72 69 6e 67 20  s.** the string 
31a80 74 6f 20 55 54 46 2d 38 20 61 6e 64 20 74 68 65  to UTF-8 and the
31a90 6e 20 72 65 74 75 72 6e 73 20 74 68 65 20 6e 75  n returns the nu
31aa0 6d 62 65 72 20 6f 66 20 62 79 74 65 73 2e 0a 2a  mber of bytes..*
31ab0 2a 20 5e 49 66 20 74 68 65 20 72 65 73 75 6c 74  * ^If the result
31ac0 20 69 73 20 61 20 6e 75 6d 65 72 69 63 20 76 61   is a numeric va
31ad0 6c 75 65 20 74 68 65 6e 20 73 71 6c 69 74 65 33  lue then sqlite3
31ae0 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29 20  _column_bytes() 
31af0 75 73 65 73 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  uses.** [sqlite3
31b00 5f 73 6e 70 72 69 6e 74 66 28 29 5d 20 74 6f 20  _snprintf()] to 
31b10 63 6f 6e 76 65 72 74 20 74 68 61 74 20 76 61 6c  convert that val
31b20 75 65 20 74 6f 20 61 20 55 54 46 2d 38 20 73 74  ue to a UTF-8 st
31b30 72 69 6e 67 20 61 6e 64 20 72 65 74 75 72 6e 73  ring and returns
31b40 0a 2a 2a 20 74 68 65 20 6e 75 6d 62 65 72 20 6f  .** the number o
31b50 66 20 62 79 74 65 73 20 69 6e 20 74 68 61 74 20  f bytes in that 
31b60 73 74 72 69 6e 67 2e 0a 2a 2a 20 5e 49 66 20 74  string..** ^If t
31b70 68 65 20 72 65 73 75 6c 74 20 69 73 20 4e 55 4c  he result is NUL
31b80 4c 2c 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f  L, then sqlite3_
31b90 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29 20 72  column_bytes() r
31ba0 65 74 75 72 6e 73 20 7a 65 72 6f 2e 0a 2a 2a 0a  eturns zero..**.
31bb0 2a 2a 20 5e 49 66 20 74 68 65 20 72 65 73 75 6c  ** ^If the resul
31bc0 74 20 69 73 20 61 20 42 4c 4f 42 20 6f 72 20 55  t is a BLOB or U
31bd0 54 46 2d 31 36 20 73 74 72 69 6e 67 20 74 68 65  TF-16 string the
31be0 6e 20 74 68 65 20 73 71 6c 69 74 65 33 5f 63 6f  n the sqlite3_co
31bf0 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28 29 0a 2a  lumn_bytes16().*
31c00 2a 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e  * routine return
31c10 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20  s the number of 
31c20 62 79 74 65 73 20 69 6e 20 74 68 61 74 20 42 4c  bytes in that BL
31c30 4f 42 20 6f 72 20 73 74 72 69 6e 67 2e 0a 2a 2a  OB or string..**
31c40 20 5e 49 66 20 74 68 65 20 72 65 73 75 6c 74 20   ^If the result 
31c50 69 73 20 61 20 55 54 46 2d 38 20 73 74 72 69 6e  is a UTF-8 strin
31c60 67 2c 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f  g, then sqlite3_
31c70 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28 29  column_bytes16()
31c80 20 63 6f 6e 76 65 72 74 73 0a 2a 2a 20 74 68 65   converts.** the
31c90 20 73 74 72 69 6e 67 20 74 6f 20 55 54 46 2d 31   string to UTF-1
31ca0 36 20 61 6e 64 20 74 68 65 6e 20 72 65 74 75 72  6 and then retur
31cb0 6e 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  ns the number of
31cc0 20 62 79 74 65 73 2e 0a 2a 2a 20 5e 49 66 20 74   bytes..** ^If t
31cd0 68 65 20 72 65 73 75 6c 74 20 69 73 20 61 20 6e  he result is a n
31ce0 75 6d 65 72 69 63 20 76 61 6c 75 65 20 74 68 65  umeric value the
31cf0 6e 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  n sqlite3_column
31d00 5f 62 79 74 65 73 31 36 28 29 20 75 73 65 73 0a  _bytes16() uses.
31d10 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 73 6e 70 72  ** [sqlite3_snpr
31d20 69 6e 74 66 28 29 5d 20 74 6f 20 63 6f 6e 76 65  intf()] to conve
31d30 72 74 20 74 68 61 74 20 76 61 6c 75 65 20 74 6f  rt that value to
31d40 20 61 20 55 54 46 2d 31 36 20 73 74 72 69 6e 67   a UTF-16 string
31d50 20 61 6e 64 20 72 65 74 75 72 6e 73 0a 2a 2a 20   and returns.** 
31d60 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 62 79  the number of by
31d70 74 65 73 20 69 6e 20 74 68 61 74 20 73 74 72 69  tes in that stri
31d80 6e 67 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 72  ng..** ^If the r
31d90 65 73 75 6c 74 20 69 73 20 4e 55 4c 4c 2c 20 74  esult is NULL, t
31da0 68 65 6e 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75  hen sqlite3_colu
31db0 6d 6e 5f 62 79 74 65 73 31 36 28 29 20 72 65 74  mn_bytes16() ret
31dc0 75 72 6e 73 20 7a 65 72 6f 2e 0a 2a 2a 0a 2a 2a  urns zero..**.**
31dd0 20 5e 54 68 65 20 76 61 6c 75 65 73 20 72 65 74   ^The values ret
31de0 75 72 6e 65 64 20 62 79 20 5b 73 71 6c 69 74 65  urned by [sqlite
31df0 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29  3_column_bytes()
31e00 5d 20 61 6e 64 20 0a 2a 2a 20 5b 73 71 6c 69 74  ] and .** [sqlit
31e10 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31  e3_column_bytes1
31e20 36 28 29 5d 20 64 6f 20 6e 6f 74 20 69 6e 63 6c  6()] do not incl
31e30 75 64 65 20 74 68 65 20 7a 65 72 6f 20 74 65 72  ude the zero ter
31e40 6d 69 6e 61 74 6f 72 73 20 61 74 20 74 68 65 20  minators at the 
31e50 65 6e 64 0a 2a 2a 20 6f 66 20 74 68 65 20 73 74  end.** of the st
31e60 72 69 6e 67 2e 20 20 5e 46 6f 72 20 63 6c 61 72  ring.  ^For clar
31e70 69 74 79 3a 20 74 68 65 20 76 61 6c 75 65 73 20  ity: the values 
31e80 72 65 74 75 72 6e 65 64 20 62 79 0a 2a 2a 20 5b  returned by.** [
31e90 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62  sqlite3_column_b
31ea0 79 74 65 73 28 29 5d 20 61 6e 64 20 5b 73 71 6c  ytes()] and [sql
31eb0 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65  ite3_column_byte
31ec0 73 31 36 28 29 5d 20 61 72 65 20 74 68 65 20 6e  s16()] are the n
31ed0 75 6d 62 65 72 20 6f 66 0a 2a 2a 20 62 79 74 65  umber of.** byte
31ee0 73 20 69 6e 20 74 68 65 20 73 74 72 69 6e 67 2c  s in the string,
31ef0 20 6e 6f 74 20 74 68 65 20 6e 75 6d 62 65 72 20   not the number 
31f00 6f 66 20 63 68 61 72 61 63 74 65 72 73 2e 0a 2a  of characters..*
31f10 2a 0a 2a 2a 20 5e 53 74 72 69 6e 67 73 20 72 65  *.** ^Strings re
31f20 74 75 72 6e 65 64 20 62 79 20 73 71 6c 69 74 65  turned by sqlite
31f30 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 29 20  3_column_text() 
31f40 61 6e 64 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75  and sqlite3_colu
31f50 6d 6e 5f 74 65 78 74 31 36 28 29 2c 0a 2a 2a 20  mn_text16(),.** 
31f60 65 76 65 6e 20 65 6d 70 74 79 20 73 74 72 69 6e  even empty strin
31f70 67 73 2c 20 61 72 65 20 61 6c 77 61 79 73 20 7a  gs, are always z
31f80 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 2e 20  ero-terminated. 
31f90 20 5e 54 68 65 20 72 65 74 75 72 6e 0a 2a 2a 20   ^The return.** 
31fa0 76 61 6c 75 65 20 66 72 6f 6d 20 73 71 6c 69 74  value from sqlit
31fb0 65 33 5f 63 6f 6c 75 6d 6e 5f 62 6c 6f 62 28 29  e3_column_blob()
31fc0 20 66 6f 72 20 61 20 7a 65 72 6f 2d 6c 65 6e 67   for a zero-leng
31fd0 74 68 20 42 4c 4f 42 20 69 73 20 61 20 4e 55 4c  th BLOB is a NUL
31fe0 4c 20 70 6f 69 6e 74 65 72 2e 0a 2a 2a 0a 2a 2a  L pointer..**.**
31ff0 20 3c 62 3e 57 61 72 6e 69 6e 67 3a 3c 2f 62 3e   <b>Warning:</b>
32000 20 5e 54 68 65 20 6f 62 6a 65 63 74 20 72 65 74   ^The object ret
32010 75 72 6e 65 64 20 62 79 20 5b 73 71 6c 69 74 65  urned by [sqlite
32020 33 5f 63 6f 6c 75 6d 6e 5f 76 61 6c 75 65 28 29  3_column_value()
32030 5d 20 69 73 20 61 6e 0a 2a 2a 20 5b 75 6e 70 72  ] is an.** [unpr
32040 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f  otected sqlite3_
32050 76 61 6c 75 65 5d 20 6f 62 6a 65 63 74 2e 20 20  value] object.  
32060 49 6e 20 61 20 6d 75 6c 74 69 74 68 72 65 61 64  In a multithread
32070 65 64 20 65 6e 76 69 72 6f 6e 6d 65 6e 74 2c 0a  ed environment,.
32080 2a 2a 20 61 6e 20 75 6e 70 72 6f 74 65 63 74 65  ** an unprotecte
32090 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20  d sqlite3_value 
320a0 6f 62 6a 65 63 74 20 6d 61 79 20 6f 6e 6c 79 20  object may only 
320b0 62 65 20 75 73 65 64 20 73 61 66 65 6c 79 20 77  be used safely w
320c0 69 74 68 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  ith.** [sqlite3_
320d0 62 69 6e 64 5f 76 61 6c 75 65 28 29 5d 20 61 6e  bind_value()] an
320e0 64 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 75 6c  d [sqlite3_resul
320f0 74 5f 76 61 6c 75 65 28 29 5d 2e 0a 2a 2a 20 49  t_value()]..** I
32100 66 20 74 68 65 20 5b 75 6e 70 72 6f 74 65 63 74  f the [unprotect
32110 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  ed sqlite3_value
32120 5d 20 6f 62 6a 65 63 74 20 72 65 74 75 72 6e 65  ] object returne
32130 64 20 62 79 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  d by.** [sqlite3
32140 5f 63 6f 6c 75 6d 6e 5f 76 61 6c 75 65 28 29 5d  _column_value()]
32150 20 69 73 20 75 73 65 64 20 69 6e 20 61 6e 79 20   is used in any 
32160 6f 74 68 65 72 20 77 61 79 2c 20 69 6e 63 6c 75  other way, inclu
32170 64 69 6e 67 20 63 61 6c 6c 73 0a 2a 2a 20 74 6f  ding calls.** to
32180 20 72 6f 75 74 69 6e 65 73 20 6c 69 6b 65 20 5b   routines like [
32190 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 69 6e  sqlite3_value_in
321a0 74 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 76  t()], [sqlite3_v
321b0 61 6c 75 65 5f 74 65 78 74 28 29 5d 2c 0a 2a 2a  alue_text()],.**
321c0 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c   or [sqlite3_val
321d0 75 65 5f 62 79 74 65 73 28 29 5d 2c 20 74 68 65  ue_bytes()], the
321e0 20 62 65 68 61 76 69 6f 72 20 69 73 20 6e 6f 74   behavior is not
321f0 20 74 68 72 65 61 64 73 61 66 65 2e 0a 2a 2a 0a   threadsafe..**.
32200 2a 2a 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65  ** These routine
32210 73 20 61 74 74 65 6d 70 74 20 74 6f 20 63 6f 6e  s attempt to con
32220 76 65 72 74 20 74 68 65 20 76 61 6c 75 65 20 77  vert the value w
32230 68 65 72 65 20 61 70 70 72 6f 70 72 69 61 74 65  here appropriate
32240 2e 20 20 5e 46 6f 72 0a 2a 2a 20 65 78 61 6d 70  .  ^For.** examp
32250 6c 65 2c 20 69 66 20 74 68 65 20 69 6e 74 65 72  le, if the inter
32260 6e 61 6c 20 72 65 70 72 65 73 65 6e 74 61 74 69  nal representati
32270 6f 6e 20 69 73 20 46 4c 4f 41 54 20 61 6e 64 20  on is FLOAT and 
32280 61 20 74 65 78 74 20 72 65 73 75 6c 74 0a 2a 2a  a text result.**
32290 20 69 73 20 72 65 71 75 65 73 74 65 64 2c 20 5b   is requested, [
322a0 73 71 6c 69 74 65 33 5f 73 6e 70 72 69 6e 74 66  sqlite3_snprintf
322b0 28 29 5d 20 69 73 20 75 73 65 64 20 69 6e 74 65  ()] is used inte
322c0 72 6e 61 6c 6c 79 20 74 6f 20 70 65 72 66 6f 72  rnally to perfor
322d0 6d 20 74 68 65 0a 2a 2a 20 63 6f 6e 76 65 72 73  m the.** convers
322e0 69 6f 6e 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c  ion automaticall
322f0 79 2e 20 20 5e 28 54 68 65 20 66 6f 6c 6c 6f 77  y.  ^(The follow
32300 69 6e 67 20 74 61 62 6c 65 20 64 65 74 61 69 6c  ing table detail
32310 73 20 74 68 65 20 63 6f 6e 76 65 72 73 69 6f 6e  s the conversion
32320 73 0a 2a 2a 20 74 68 61 74 20 61 72 65 20 61 70  s.** that are ap
32330 70 6c 69 65 64 3a 0a 2a 2a 0a 2a 2a 20 3c 62 6c  plied:.**.** <bl
32340 6f 63 6b 71 75 6f 74 65 3e 0a 2a 2a 20 3c 74 61  ockquote>.** <ta
32350 62 6c 65 20 62 6f 72 64 65 72 3d 22 31 22 3e 0a  ble border="1">.
32360 2a 2a 20 3c 74 72 3e 3c 74 68 3e 20 49 6e 74 65  ** <tr><th> Inte
32370 72 6e 61 6c 3c 62 72 3e 54 79 70 65 20 3c 74 68  rnal<br>Type <th
32380 3e 20 52 65 71 75 65 73 74 65 64 3c 62 72 3e 54  > Requested<br>T
32390 79 70 65 20 3c 74 68 3e 20 20 43 6f 6e 76 65 72  ype <th>  Conver
323a0 73 69 6f 6e 0a 2a 2a 0a 2a 2a 20 3c 74 72 3e 3c  sion.**.** <tr><
323b0 74 64 3e 20 20 4e 55 4c 4c 20 20 20 20 3c 74 64  td>  NULL    <td
323c0 3e 20 49 4e 54 45 47 45 52 20 20 20 3c 74 64 3e  > INTEGER   <td>
323d0 20 52 65 73 75 6c 74 20 69 73 20 30 0a 2a 2a 20   Result is 0.** 
323e0 3c 74 72 3e 3c 74 64 3e 20 20 4e 55 4c 4c 20 20  <tr><td>  NULL  
323f0 20 20 3c 74 64 3e 20 20 46 4c 4f 41 54 20 20 20    <td>  FLOAT   
32400 20 3c 74 64 3e 20 52 65 73 75 6c 74 20 69 73 20   <td> Result is 
32410 30 2e 30 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20  0.0.** <tr><td> 
32420 20 4e 55 4c 4c 20 20 20 20 3c 74 64 3e 20 20 20   NULL    <td>   
32430 54 45 58 54 20 20 20 20 3c 74 64 3e 20 52 65 73  TEXT    <td> Res
32440 75 6c 74 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f  ult is a NULL po
32450 69 6e 74 65 72 0a 2a 2a 20 3c 74 72 3e 3c 74 64  inter.** <tr><td
32460 3e 20 20 4e 55 4c 4c 20 20 20 20 3c 74 64 3e 20  >  NULL    <td> 
32470 20 20 42 4c 4f 42 20 20 20 20 3c 74 64 3e 20 52    BLOB    <td> R
32480 65 73 75 6c 74 20 69 73 20 61 20 4e 55 4c 4c 20  esult is a NULL 
32490 70 6f 69 6e 74 65 72 0a 2a 2a 20 3c 74 72 3e 3c  pointer.** <tr><
324a0 74 64 3e 20 49 4e 54 45 47 45 52 20 20 3c 74 64  td> INTEGER  <td
324b0 3e 20 20 46 4c 4f 41 54 20 20 20 20 3c 74 64 3e  >  FLOAT    <td>
324c0 20 43 6f 6e 76 65 72 74 20 66 72 6f 6d 20 69 6e   Convert from in
324d0 74 65 67 65 72 20 74 6f 20 66 6c 6f 61 74 0a 2a  teger to float.*
324e0 2a 20 3c 74 72 3e 3c 74 64 3e 20 49 4e 54 45 47  * <tr><td> INTEG
324f0 45 52 20 20 3c 74 64 3e 20 20 20 54 45 58 54 20  ER  <td>   TEXT 
32500 20 20 20 3c 74 64 3e 20 41 53 43 49 49 20 72 65     <td> ASCII re
32510 6e 64 65 72 69 6e 67 20 6f 66 20 74 68 65 20 69  ndering of the i
32520 6e 74 65 67 65 72 0a 2a 2a 20 3c 74 72 3e 3c 74  nteger.** <tr><t
32530 64 3e 20 49 4e 54 45 47 45 52 20 20 3c 74 64 3e  d> INTEGER  <td>
32540 20 20 20 42 4c 4f 42 20 20 20 20 3c 74 64 3e 20     BLOB    <td> 
32550 53 61 6d 65 20 61 73 20 49 4e 54 45 47 45 52 2d  Same as INTEGER-
32560 3e 54 45 58 54 0a 2a 2a 20 3c 74 72 3e 3c 74 64  >TEXT.** <tr><td
32570 3e 20 20 46 4c 4f 41 54 20 20 20 3c 74 64 3e 20  >  FLOAT   <td> 
32580 49 4e 54 45 47 45 52 20 20 20 3c 74 64 3e 20 5b  INTEGER   <td> [
32590 43 41 53 54 5d 20 74 6f 20 49 4e 54 45 47 45 52  CAST] to INTEGER
325a0 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 46 4c  .** <tr><td>  FL
325b0 4f 41 54 20 20 20 3c 74 64 3e 20 20 20 54 45 58  OAT   <td>   TEX
325c0 54 20 20 20 20 3c 74 64 3e 20 41 53 43 49 49 20  T    <td> ASCII 
325d0 72 65 6e 64 65 72 69 6e 67 20 6f 66 20 74 68 65  rendering of the
325e0 20 66 6c 6f 61 74 0a 2a 2a 20 3c 74 72 3e 3c 74   float.** <tr><t
325f0 64 3e 20 20 46 4c 4f 41 54 20 20 20 3c 74 64 3e  d>  FLOAT   <td>
32600 20 20 20 42 4c 4f 42 20 20 20 20 3c 74 64 3e 20     BLOB    <td> 
32610 5b 43 41 53 54 5d 20 74 6f 20 42 4c 4f 42 0a 2a  [CAST] to BLOB.*
32620 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 54 45 58 54  * <tr><td>  TEXT
32630 20 20 20 20 3c 74 64 3e 20 49 4e 54 45 47 45 52      <td> INTEGER
32640 20 20 20 3c 74 64 3e 20 5b 43 41 53 54 5d 20 74     <td> [CAST] t
32650 6f 20 49 4e 54 45 47 45 52 0a 2a 2a 20 3c 74 72  o INTEGER.** <tr
32660 3e 3c 74 64 3e 20 20 54 45 58 54 20 20 20 20 3c  ><td>  TEXT    <
32670 74 64 3e 20 20 46 4c 4f 41 54 20 20 20 20 3c 74  td>  FLOAT    <t
32680 64 3e 20 5b 43 41 53 54 5d 20 74 6f 20 52 45 41  d> [CAST] to REA
32690 4c 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 54  L.** <tr><td>  T
326a0 45 58 54 20 20 20 20 3c 74 64 3e 20 20 20 42 4c  EXT    <td>   BL
326b0 4f 42 20 20 20 20 3c 74 64 3e 20 4e 6f 20 63 68  OB    <td> No ch
326c0 61 6e 67 65 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e  ange.** <tr><td>
326d0 20 20 42 4c 4f 42 20 20 20 20 3c 74 64 3e 20 49    BLOB    <td> I
326e0 4e 54 45 47 45 52 20 20 20 3c 74 64 3e 20 5b 43  NTEGER   <td> [C
326f0 41 53 54 5d 20 74 6f 20 49 4e 54 45 47 45 52 0a  AST] to INTEGER.
32700 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 42 4c 4f  ** <tr><td>  BLO
32710 42 20 20 20 20 3c 74 64 3e 20 20 46 4c 4f 41 54  B    <td>  FLOAT
32720 20 20 20 20 3c 74 64 3e 20 5b 43 41 53 54 5d 20      <td> [CAST] 
32730 74 6f 20 52 45 41 4c 0a 2a 2a 20 3c 74 72 3e 3c  to REAL.** <tr><
32740 74 64 3e 20 20 42 4c 4f 42 20 20 20 20 3c 74 64  td>  BLOB    <td
32750 3e 20 20 20 54 45 58 54 20 20 20 20 3c 74 64 3e  >   TEXT    <td>
32760 20 41 64 64 20 61 20 7a 65 72 6f 20 74 65 72 6d   Add a zero term
32770 69 6e 61 74 6f 72 20 69 66 20 6e 65 65 64 65 64  inator if needed
32780 0a 2a 2a 20 3c 2f 74 61 62 6c 65 3e 0a 2a 2a 20  .** </table>.** 
32790 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 29 5e 0a  </blockquote>)^.
327a0 2a 2a 0a 2a 2a 20 4e 6f 74 65 20 74 68 61 74 20  **.** Note that 
327b0 77 68 65 6e 20 74 79 70 65 20 63 6f 6e 76 65 72  when type conver
327c0 73 69 6f 6e 73 20 6f 63 63 75 72 2c 20 70 6f 69  sions occur, poi
327d0 6e 74 65 72 73 20 72 65 74 75 72 6e 65 64 20 62  nters returned b
327e0 79 20 70 72 69 6f 72 0a 2a 2a 20 63 61 6c 6c 73  y prior.** calls
327f0 20 74 6f 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75   to sqlite3_colu
32800 6d 6e 5f 62 6c 6f 62 28 29 2c 20 73 71 6c 69 74  mn_blob(), sqlit
32810 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 29  e3_column_text()
32820 2c 20 61 6e 64 2f 6f 72 0a 2a 2a 20 73 71 6c 69  , and/or.** sqli
32830 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 31  te3_column_text1
32840 36 28 29 20 6d 61 79 20 62 65 20 69 6e 76 61 6c  6() may be inval
32850 69 64 61 74 65 64 2e 0a 2a 2a 20 54 79 70 65 20  idated..** Type 
32860 63 6f 6e 76 65 72 73 69 6f 6e 73 20 61 6e 64 20  conversions and 
32870 70 6f 69 6e 74 65 72 20 69 6e 76 61 6c 69 64 61  pointer invalida
32880 74 69 6f 6e 73 20 6d 69 67 68 74 20 6f 63 63 75  tions might occu
32890 72 0a 2a 2a 20 69 6e 20 74 68 65 20 66 6f 6c 6c  r.** in the foll
328a0 6f 77 69 6e 67 20 63 61 73 65 73 3a 0a 2a 2a 0a  owing cases:.**.
328b0 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20  ** <ul>.** <li> 
328c0 54 68 65 20 69 6e 69 74 69 61 6c 20 63 6f 6e 74  The initial cont
328d0 65 6e 74 20 69 73 20 61 20 42 4c 4f 42 20 61 6e  ent is a BLOB an
328e0 64 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  d sqlite3_column
328f0 5f 74 65 78 74 28 29 20 6f 72 0a 2a 2a 20 20 20  _text() or.**   
32900 20 20 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d     sqlite3_colum
32910 6e 5f 74 65 78 74 31 36 28 29 20 69 73 20 63 61  n_text16() is ca
32920 6c 6c 65 64 2e 20 20 41 20 7a 65 72 6f 2d 74 65  lled.  A zero-te
32930 72 6d 69 6e 61 74 6f 72 20 6d 69 67 68 74 0a 2a  rminator might.*
32940 2a 20 20 20 20 20 20 6e 65 65 64 20 74 6f 20 62  *      need to b
32950 65 20 61 64 64 65 64 20 74 6f 20 74 68 65 20 73  e added to the s
32960 74 72 69 6e 67 2e 3c 2f 6c 69 3e 0a 2a 2a 20 3c  tring.</li>.** <
32970 6c 69 3e 20 54 68 65 20 69 6e 69 74 69 61 6c 20  li> The initial 
32980 63 6f 6e 74 65 6e 74 20 69 73 20 55 54 46 2d 38  content is UTF-8
32990 20 74 65 78 74 20 61 6e 64 20 73 71 6c 69 74 65   text and sqlite
329a0 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31 36  3_column_bytes16
329b0 28 29 20 6f 72 0a 2a 2a 20 20 20 20 20 20 73 71  () or.**      sq
329c0 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78  lite3_column_tex
329d0 74 31 36 28 29 20 69 73 20 63 61 6c 6c 65 64 2e  t16() is called.
329e0 20 20 54 68 65 20 63 6f 6e 74 65 6e 74 20 6d 75    The content mu
329f0 73 74 20 62 65 20 63 6f 6e 76 65 72 74 65 64 0a  st be converted.
32a00 2a 2a 20 20 20 20 20 20 74 6f 20 55 54 46 2d 31  **      to UTF-1
32a10 36 2e 3c 2f 6c 69 3e 0a 2a 2a 20 3c 6c 69 3e 20  6.</li>.** <li> 
32a20 54 68 65 20 69 6e 69 74 69 61 6c 20 63 6f 6e 74  The initial cont
32a30 65 6e 74 20 69 73 20 55 54 46 2d 31 36 20 74 65  ent is UTF-16 te
32a40 78 74 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 63  xt and sqlite3_c
32a50 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29 20 6f 72  olumn_bytes() or
32a60 0a 2a 2a 20 20 20 20 20 20 73 71 6c 69 74 65 33  .**      sqlite3
32a70 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 29 20 69  _column_text() i
32a80 73 20 63 61 6c 6c 65 64 2e 20 20 54 68 65 20 63  s called.  The c
32a90 6f 6e 74 65 6e 74 20 6d 75 73 74 20 62 65 20 63  ontent must be c
32aa0 6f 6e 76 65 72 74 65 64 0a 2a 2a 20 20 20 20 20  onverted.**     
32ab0 20 74 6f 20 55 54 46 2d 38 2e 3c 2f 6c 69 3e 0a   to UTF-8.</li>.
32ac0 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 0a 2a 2a 20 5e  ** </ul>.**.** ^
32ad0 43 6f 6e 76 65 72 73 69 6f 6e 73 20 62 65 74 77  Conversions betw
32ae0 65 65 6e 20 55 54 46 2d 31 36 62 65 20 61 6e 64  een UTF-16be and
32af0 20 55 54 46 2d 31 36 6c 65 20 61 72 65 20 61 6c   UTF-16le are al
32b00 77 61 79 73 20 64 6f 6e 65 20 69 6e 20 70 6c 61  ways done in pla
32b10 63 65 20 61 6e 64 20 64 6f 0a 2a 2a 20 6e 6f 74  ce and do.** not
32b20 20 69 6e 76 61 6c 69 64 61 74 65 20 61 20 70 72   invalidate a pr
32b30 69 6f 72 20 70 6f 69 6e 74 65 72 2c 20 74 68 6f  ior pointer, tho
32b40 75 67 68 20 6f 66 20 63 6f 75 72 73 65 20 74 68  ugh of course th
32b50 65 20 63 6f 6e 74 65 6e 74 20 6f 66 20 74 68 65  e content of the
32b60 20 62 75 66 66 65 72 0a 2a 2a 20 74 68 61 74 20   buffer.** that 
32b70 74 68 65 20 70 72 69 6f 72 20 70 6f 69 6e 74 65  the prior pointe
32b80 72 20 72 65 66 65 72 65 6e 63 65 73 20 77 69 6c  r references wil
32b90 6c 20 68 61 76 65 20 62 65 65 6e 20 6d 6f 64 69  l have been modi
32ba0 66 69 65 64 2e 20 20 4f 74 68 65 72 20 6b 69 6e  fied.  Other kin
32bb0 64 73 0a 2a 2a 20 6f 66 20 63 6f 6e 76 65 72 73  ds.** of convers
32bc0 69 6f 6e 20 61 72 65 20 64 6f 6e 65 20 69 6e 20  ion are done in 
32bd0 70 6c 61 63 65 20 77 68 65 6e 20 69 74 20 69 73  place when it is
32be0 20 70 6f 73 73 69 62 6c 65 2c 20 62 75 74 20 73   possible, but s
32bf0 6f 6d 65 74 69 6d 65 73 20 74 68 65 79 0a 2a 2a  ometimes they.**
32c00 20 61 72 65 20 6e 6f 74 20 70 6f 73 73 69 62 6c   are not possibl
32c10 65 20 61 6e 64 20 69 6e 20 74 68 6f 73 65 20 63  e and in those c
32c20 61 73 65 73 20 70 72 69 6f 72 20 70 6f 69 6e 74  ases prior point
32c30 65 72 73 20 61 72 65 20 69 6e 76 61 6c 69 64 61  ers are invalida
32c40 74 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73  ted..**.** The s
32c50 61 66 65 73 74 20 70 6f 6c 69 63 79 20 69 73 20  afest policy is 
32c60 74 6f 20 69 6e 76 6f 6b 65 20 74 68 65 73 65 20  to invoke these 
32c70 72 6f 75 74 69 6e 65 73 0a 2a 2a 20 69 6e 20 6f  routines.** in o
32c80 6e 65 20 6f 66 20 74 68 65 20 66 6f 6c 6c 6f 77  ne of the follow
32c90 69 6e 67 20 77 61 79 73 3a 0a 2a 2a 0a 2a 2a 20  ing ways:.**.** 
32ca0 3c 75 6c 3e 0a 2a 2a 20 20 3c 6c 69 3e 73 71 6c  <ul>.**  <li>sql
32cb0 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74  ite3_column_text
32cc0 28 29 20 66 6f 6c 6c 6f 77 65 64 20 62 79 20 73  () followed by s
32cd0 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79  qlite3_column_by
32ce0 74 65 73 28 29 3c 2f 6c 69 3e 0a 2a 2a 20 20 3c  tes()</li>.**  <
32cf0 6c 69 3e 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  li>sqlite3_colum
32d00 6e 5f 62 6c 6f 62 28 29 20 66 6f 6c 6c 6f 77 65  n_blob() followe
32d10 64 20 62 79 20 73 71 6c 69 74 65 33 5f 63 6f 6c  d by sqlite3_col
32d20 75 6d 6e 5f 62 79 74 65 73 28 29 3c 2f 6c 69 3e  umn_bytes()</li>
32d30 0a 2a 2a 20 20 3c 6c 69 3e 73 71 6c 69 74 65 33  .**  <li>sqlite3
32d40 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 31 36 28 29  _column_text16()
32d50 20 66 6f 6c 6c 6f 77 65 64 20 62 79 20 73 71 6c   followed by sql
32d60 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65  ite3_column_byte
32d70 73 31 36 28 29 3c 2f 6c 69 3e 0a 2a 2a 20 3c 2f  s16()</li>.** </
32d80 75 6c 3e 0a 2a 2a 0a 2a 2a 20 49 6e 20 6f 74 68  ul>.**.** In oth
32d90 65 72 20 77 6f 72 64 73 2c 20 79 6f 75 20 73 68  er words, you sh
32da0 6f 75 6c 64 20 63 61 6c 6c 20 73 71 6c 69 74 65  ould call sqlite
32db0 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 29 2c  3_column_text(),
32dc0 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75  .** sqlite3_colu
32dd0 6d 6e 5f 62 6c 6f 62 28 29 2c 20 6f 72 20 73 71  mn_blob(), or sq
32de0 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78  lite3_column_tex
32df0 74 31 36 28 29 20 66 69 72 73 74 20 74 6f 20 66  t16() first to f
32e00 6f 72 63 65 20 74 68 65 20 72 65 73 75 6c 74 0a  orce the result.
32e10 2a 2a 20 69 6e 74 6f 20 74 68 65 20 64 65 73 69  ** into the desi
32e20 72 65 64 20 66 6f 72 6d 61 74 2c 20 74 68 65 6e  red format, then
32e30 20 69 6e 76 6f 6b 65 20 73 71 6c 69 74 65 33 5f   invoke sqlite3_
32e40 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29 20 6f  column_bytes() o
32e50 72 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63 6f 6c  r.** sqlite3_col
32e60 75 6d 6e 5f 62 79 74 65 73 31 36 28 29 20 74 6f  umn_bytes16() to
32e70 20 66 69 6e 64 20 74 68 65 20 73 69 7a 65 20 6f   find the size o
32e80 66 20 74 68 65 20 72 65 73 75 6c 74 2e 20 20 44  f the result.  D
32e90 6f 20 6e 6f 74 20 6d 69 78 20 63 61 6c 6c 73 0a  o not mix calls.
32ea0 2a 2a 20 74 6f 20 73 71 6c 69 74 65 33 5f 63 6f  ** to sqlite3_co
32eb0 6c 75 6d 6e 5f 74 65 78 74 28 29 20 6f 72 20 73  lumn_text() or s
32ec0 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 6c  qlite3_column_bl
32ed0 6f 62 28 29 20 77 69 74 68 20 63 61 6c 6c 73 20  ob() with calls 
32ee0 74 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63 6f  to.** sqlite3_co
32ef0 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28 29 2c 20  lumn_bytes16(), 
32f00 61 6e 64 20 64 6f 20 6e 6f 74 20 6d 69 78 20 63  and do not mix c
32f10 61 6c 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 5f  alls to sqlite3_
32f20 63 6f 6c 75 6d 6e 5f 74 65 78 74 31 36 28 29 0a  column_text16().
32f30 2a 2a 20 77 69 74 68 20 63 61 6c 6c 73 20 74 6f  ** with calls to
32f40 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
32f50 62 79 74 65 73 28 29 2e 0a 2a 2a 0a 2a 2a 20 5e  bytes()..**.** ^
32f60 54 68 65 20 70 6f 69 6e 74 65 72 73 20 72 65 74  The pointers ret
32f70 75 72 6e 65 64 20 61 72 65 20 76 61 6c 69 64 20  urned are valid 
32f80 75 6e 74 69 6c 20 61 20 74 79 70 65 20 63 6f 6e  until a type con
32f90 76 65 72 73 69 6f 6e 20 6f 63 63 75 72 73 20 61  version occurs a
32fa0 73 0a 2a 2a 20 64 65 73 63 72 69 62 65 64 20 61  s.** described a
32fb0 62 6f 76 65 2c 20 6f 72 20 75 6e 74 69 6c 20 5b  bove, or until [
32fc0 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20  sqlite3_step()] 
32fd0 6f 72 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65  or [sqlite3_rese
32fe0 74 28 29 5d 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69  t()] or.** [sqli
32ff0 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28 29 5d 20  te3_finalize()] 
33000 69 73 20 63 61 6c 6c 65 64 2e 20 20 5e 54 68 65  is called.  ^The
33010 20 6d 65 6d 6f 72 79 20 73 70 61 63 65 20 75 73   memory space us
33020 65 64 20 74 6f 20 68 6f 6c 64 20 73 74 72 69 6e  ed to hold strin
33030 67 73 0a 2a 2a 20 61 6e 64 20 42 4c 4f 42 73 20  gs.** and BLOBs 
33040 69 73 20 66 72 65 65 64 20 61 75 74 6f 6d 61 74  is freed automat
33050 69 63 61 6c 6c 79 2e 20 20 44 6f 20 3c 65 6d 3e  ically.  Do <em>
33060 6e 6f 74 3c 2f 65 6d 3e 20 70 61 73 73 20 74 68  not</em> pass th
33070 65 20 70 6f 69 6e 74 65 72 73 20 72 65 74 75 72  e pointers retur
33080 6e 65 64 0a 2a 2a 20 66 72 6f 6d 20 5b 73 71 6c  ned.** from [sql
33090 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 6c 6f 62  ite3_column_blob
330a0 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 63 6f  ()], [sqlite3_co
330b0 6c 75 6d 6e 5f 74 65 78 74 28 29 5d 2c 20 65 74  lumn_text()], et
330c0 63 2e 20 69 6e 74 6f 0a 2a 2a 20 5b 73 71 6c 69  c. into.** [sqli
330d0 74 65 33 5f 66 72 65 65 28 29 5d 2e 0a 2a 2a 0a  te3_free()]..**.
330e0 2a 2a 20 5e 28 49 66 20 61 20 6d 65 6d 6f 72 79  ** ^(If a memory
330f0 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 65 72 72 6f   allocation erro
33100 72 20 6f 63 63 75 72 73 20 64 75 72 69 6e 67 20  r occurs during 
33110 74 68 65 20 65 76 61 6c 75 61 74 69 6f 6e 20 6f  the evaluation o
33120 66 20 61 6e 79 0a 2a 2a 20 6f 66 20 74 68 65 73  f any.** of thes
33130 65 20 72 6f 75 74 69 6e 65 73 2c 20 61 20 64 65  e routines, a de
33140 66 61 75 6c 74 20 76 61 6c 75 65 20 69 73 20 72  fault value is r
33150 65 74 75 72 6e 65 64 2e 20 20 54 68 65 20 64 65  eturned.  The de
33160 66 61 75 6c 74 20 76 61 6c 75 65 0a 2a 2a 20 69  fault value.** i
33170 73 20 65 69 74 68 65 72 20 74 68 65 20 69 6e 74  s either the int
33180 65 67 65 72 20 30 2c 20 74 68 65 20 66 6c 6f 61  eger 0, the floa
33190 74 69 6e 67 20 70 6f 69 6e 74 20 6e 75 6d 62 65  ting point numbe
331a0 72 20 30 2e 30 2c 20 6f 72 20 61 20 4e 55 4c 4c  r 0.0, or a NULL
331b0 0a 2a 2a 20 70 6f 69 6e 74 65 72 2e 20 20 53 75  .** pointer.  Su
331c0 62 73 65 71 75 65 6e 74 20 63 61 6c 6c 73 20 74  bsequent calls t
331d0 6f 20 5b 73 71 6c 69 74 65 33 5f 65 72 72 63 6f  o [sqlite3_errco
331e0 64 65 28 29 5d 20 77 69 6c 6c 20 72 65 74 75 72  de()] will retur
331f0 6e 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 4e 4f 4d  n.** [SQLITE_NOM
33200 45 4d 5d 2e 29 5e 0a 2a 2f 0a 63 6f 6e 73 74 20  EM].)^.*/.const 
33210 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 63 6f  void *sqlite3_co
33220 6c 75 6d 6e 5f 62 6c 6f 62 28 73 71 6c 69 74 65  lumn_blob(sqlite
33230 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43 6f  3_stmt*, int iCo
33240 6c 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  l);.int sqlite3_
33250 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 73 71 6c  column_bytes(sql
33260 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20  ite3_stmt*, int 
33270 69 43 6f 6c 29 3b 0a 69 6e 74 20 73 71 6c 69 74  iCol);.int sqlit
33280 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31  e3_column_bytes1
33290 36 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c  6(sqlite3_stmt*,
332a0 20 69 6e 74 20 69 43 6f 6c 29 3b 0a 64 6f 75 62   int iCol);.doub
332b0 6c 65 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  le sqlite3_colum
332c0 6e 5f 64 6f 75 62 6c 65 28 73 71 6c 69 74 65 33  n_double(sqlite3
332d0 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43 6f 6c  _stmt*, int iCol
332e0 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 63  );.int sqlite3_c
332f0 6f 6c 75 6d 6e 5f 69 6e 74 28 73 71 6c 69 74 65  olumn_int(sqlite
33300 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43 6f  3_stmt*, int iCo
33310 6c 29 3b 0a 73 71 6c 69 74 65 33 5f 69 6e 74 36  l);.sqlite3_int6
33320 34 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  4 sqlite3_column
33330 5f 69 6e 74 36 34 28 73 71 6c 69 74 65 33 5f 73  _int64(sqlite3_s
33340 74 6d 74 2a 2c 20 69 6e 74 20 69 43 6f 6c 29 3b  tmt*, int iCol);
33350 0a 63 6f 6e 73 74 20 75 6e 73 69 67 6e 65 64 20  .const unsigned 
33360 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 63 6f  char *sqlite3_co
33370 6c 75 6d 6e 5f 74 65 78 74 28 73 71 6c 69 74 65  lumn_text(sqlite
33380 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43 6f  3_stmt*, int iCo
33390 6c 29 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a  l);.const void *
333a0 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74  sqlite3_column_t
333b0 65 78 74 31 36 28 73 71 6c 69 74 65 33 5f 73 74  ext16(sqlite3_st
333c0 6d 74 2a 2c 20 69 6e 74 20 69 43 6f 6c 29 3b 0a  mt*, int iCol);.
333d0 69 6e 74 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75  int sqlite3_colu
333e0 6d 6e 5f 74 79 70 65 28 73 71 6c 69 74 65 33 5f  mn_type(sqlite3_
333f0 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43 6f 6c 29  stmt*, int iCol)
33400 3b 0a 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20  ;.sqlite3_value 
33410 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f  *sqlite3_column_
33420 76 61 6c 75 65 28 73 71 6c 69 74 65 33 5f 73 74  value(sqlite3_st
33430 6d 74 2a 2c 20 69 6e 74 20 69 43 6f 6c 29 3b 0a  mt*, int iCol);.
33440 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
33450 20 44 65 73 74 72 6f 79 20 41 20 50 72 65 70 61   Destroy A Prepa
33460 72 65 64 20 53 74 61 74 65 6d 65 6e 74 20 4f 62  red Statement Ob
33470 6a 65 63 74 0a 2a 2a 20 44 45 53 54 52 55 43 54  ject.** DESTRUCT
33480 4f 52 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d 74  OR: sqlite3_stmt
33490 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69  .**.** ^The sqli
334a0 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28 29 20 66  te3_finalize() f
334b0 75 6e 63 74 69 6f 6e 20 69 73 20 63 61 6c 6c 65  unction is calle
334c0 64 20 74 6f 20 64 65 6c 65 74 65 20 61 20 5b 70  d to delete a [p
334d0 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e  repared statemen
334e0 74 5d 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 6d  t]..** ^If the m
334f0 6f 73 74 20 72 65 63 65 6e 74 20 65 76 61 6c 75  ost recent evalu
33500 61 74 69 6f 6e 20 6f 66 20 74 68 65 20 73 74 61  ation of the sta
33510 74 65 6d 65 6e 74 20 65 6e 63 6f 75 6e 74 65 72  tement encounter
33520 65 64 20 6e 6f 20 65 72 72 6f 72 73 0a 2a 2a 20  ed no errors.** 
33530 6f 72 20 69 66 20 74 68 65 20 73 74 61 74 65 6d  or if the statem
33540 65 6e 74 20 69 73 20 6e 65 76 65 72 20 62 65 65  ent is never bee
33550 6e 20 65 76 61 6c 75 61 74 65 64 2c 20 74 68 65  n evaluated, the
33560 6e 20 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69  n sqlite3_finali
33570 7a 65 28 29 20 72 65 74 75 72 6e 73 0a 2a 2a 20  ze() returns.** 
33580 53 51 4c 49 54 45 5f 4f 4b 2e 20 20 5e 49 66 20  SQLITE_OK.  ^If 
33590 74 68 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 20  the most recent 
335a0 65 76 61 6c 75 61 74 69 6f 6e 20 6f 66 20 73 74  evaluation of st
335b0 61 74 65 6d 65 6e 74 20 53 20 66 61 69 6c 65 64  atement S failed
335c0 2c 20 74 68 65 6e 0a 2a 2a 20 73 71 6c 69 74 65  , then.** sqlite
335d0 33 5f 66 69 6e 61 6c 69 7a 65 28 53 29 20 72 65  3_finalize(S) re
335e0 74 75 72 6e 73 20 74 68 65 20 61 70 70 72 6f 70  turns the approp
335f0 72 69 61 74 65 20 5b 65 72 72 6f 72 20 63 6f 64  riate [error cod
33600 65 5d 20 6f 72 0a 2a 2a 20 5b 65 78 74 65 6e 64  e] or.** [extend
33610 65 64 20 65 72 72 6f 72 20 63 6f 64 65 5d 2e 0a  ed error code]..
33620 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  **.** ^The sqlit
33630 65 33 5f 66 69 6e 61 6c 69 7a 65 28 53 29 20 72  e3_finalize(S) r
33640 6f 75 74 69 6e 65 20 63 61 6e 20 62 65 20 63 61  outine can be ca
33650 6c 6c 65 64 20 61 74 20 61 6e 79 20 70 6f 69 6e  lled at any poin
33660 74 20 64 75 72 69 6e 67 0a 2a 2a 20 74 68 65 20  t during.** the 
33670 6c 69 66 65 20 63 79 63 6c 65 20 6f 66 20 5b 70  life cycle of [p
33680 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e  repared statemen
33690 74 5d 20 53 3a 0a 2a 2a 20 62 65 66 6f 72 65 20  t] S:.** before 
336a0 73 74 61 74 65 6d 65 6e 74 20 53 20 69 73 20 65  statement S is e
336b0 76 65 72 20 65 76 61 6c 75 61 74 65 64 2c 20 61  ver evaluated, a
336c0 66 74 65 72 0a 2a 2a 20 6f 6e 65 20 6f 72 20 6d  fter.** one or m
336d0 6f 72 65 20 63 61 6c 6c 73 20 74 6f 20 5b 73 71  ore calls to [sq
336e0 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d 2c 20  lite3_reset()], 
336f0 6f 72 20 61 66 74 65 72 20 61 6e 79 20 63 61 6c  or after any cal
33700 6c 0a 2a 2a 20 74 6f 20 5b 73 71 6c 69 74 65 33  l.** to [sqlite3
33710 5f 73 74 65 70 28 29 5d 20 72 65 67 61 72 64 6c  _step()] regardl
33720 65 73 73 20 6f 66 20 77 68 65 74 68 65 72 20 6f  ess of whether o
33730 72 20 6e 6f 74 20 74 68 65 20 73 74 61 74 65 6d  r not the statem
33740 65 6e 74 20 68 61 73 0a 2a 2a 20 63 6f 6d 70 6c  ent has.** compl
33750 65 74 65 64 20 65 78 65 63 75 74 69 6f 6e 2e 0a  eted execution..
33760 2a 2a 0a 2a 2a 20 5e 49 6e 76 6f 6b 69 6e 67 20  **.** ^Invoking 
33770 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65  sqlite3_finalize
33780 28 29 20 6f 6e 20 61 20 4e 55 4c 4c 20 70 6f 69  () on a NULL poi
33790 6e 74 65 72 20 69 73 20 61 20 68 61 72 6d 6c 65  nter is a harmle
337a0 73 73 20 6e 6f 2d 6f 70 2e 0a 2a 2a 0a 2a 2a 20  ss no-op..**.** 
337b0 54 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20  The application 
337c0 6d 75 73 74 20 66 69 6e 61 6c 69 7a 65 20 65 76  must finalize ev
337d0 65 72 79 20 5b 70 72 65 70 61 72 65 64 20 73 74  ery [prepared st
337e0 61 74 65 6d 65 6e 74 5d 20 69 6e 20 6f 72 64 65  atement] in orde
337f0 72 20 74 6f 20 61 76 6f 69 64 0a 2a 2a 20 72 65  r to avoid.** re
33800 73 6f 75 72 63 65 20 6c 65 61 6b 73 2e 20 20 49  source leaks.  I
33810 74 20 69 73 20 61 20 67 72 69 65 76 6f 75 73 20  t is a grievous 
33820 65 72 72 6f 72 20 66 6f 72 20 74 68 65 20 61 70  error for the ap
33830 70 6c 69 63 61 74 69 6f 6e 20 74 6f 20 74 72 79  plication to try
33840 20 74 6f 20 75 73 65 0a 2a 2a 20 61 20 70 72 65   to use.** a pre
33850 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 20  pared statement 
33860 61 66 74 65 72 20 69 74 20 68 61 73 20 62 65 65  after it has bee
33870 6e 20 66 69 6e 61 6c 69 7a 65 64 2e 20 20 41 6e  n finalized.  An
33880 79 20 75 73 65 20 6f 66 20 61 20 70 72 65 70 61  y use of a prepa
33890 72 65 64 0a 2a 2a 20 73 74 61 74 65 6d 65 6e 74  red.** statement
338a0 20 61 66 74 65 72 20 69 74 20 68 61 73 20 62 65   after it has be
338b0 65 6e 20 66 69 6e 61 6c 69 7a 65 64 20 63 61 6e  en finalized can
338c0 20 72 65 73 75 6c 74 20 69 6e 20 75 6e 64 65 66   result in undef
338d0 69 6e 65 64 20 61 6e 64 0a 2a 2a 20 75 6e 64 65  ined and.** unde
338e0 73 69 72 61 62 6c 65 20 62 65 68 61 76 69 6f 72  sirable behavior
338f0 20 73 75 63 68 20 61 73 20 73 65 67 66 61 75 6c   such as segfaul
33900 74 73 20 61 6e 64 20 68 65 61 70 20 63 6f 72 72  ts and heap corr
33910 75 70 74 69 6f 6e 2e 0a 2a 2f 0a 69 6e 74 20 73  uption..*/.int s
33920 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28  qlite3_finalize(
33930 73 71 6c 69 74 65 33 5f 73 74 6d 74 20 2a 70 53  sqlite3_stmt *pS
33940 74 6d 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  tmt);../*.** CAP
33950 49 33 52 45 46 3a 20 52 65 73 65 74 20 41 20 50  I3REF: Reset A P
33960 72 65 70 61 72 65 64 20 53 74 61 74 65 6d 65 6e  repared Statemen
33970 74 20 4f 62 6a 65 63 74 0a 2a 2a 20 4d 45 54 48  t Object.** METH
33980 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d 74  OD: sqlite3_stmt
33990 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74  .**.** The sqlit
339a0 65 33 5f 72 65 73 65 74 28 29 20 66 75 6e 63 74  e3_reset() funct
339b0 69 6f 6e 20 69 73 20 63 61 6c 6c 65 64 20 74 6f  ion is called to
339c0 20 72 65 73 65 74 20 61 20 5b 70 72 65 70 61 72   reset a [prepar
339d0 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 0a 2a 2a  ed statement].**
339e0 20 6f 62 6a 65 63 74 20 62 61 63 6b 20 74 6f 20   object back to 
339f0 69 74 73 20 69 6e 69 74 69 61 6c 20 73 74 61 74  its initial stat
33a00 65 2c 20 72 65 61 64 79 20 74 6f 20 62 65 20 72  e, ready to be r
33a10 65 2d 65 78 65 63 75 74 65 64 2e 0a 2a 2a 20 5e  e-executed..** ^
33a20 41 6e 79 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  Any SQL statemen
33a30 74 20 76 61 72 69 61 62 6c 65 73 20 74 68 61 74  t variables that
33a40 20 68 61 64 20 76 61 6c 75 65 73 20 62 6f 75 6e   had values boun
33a50 64 20 74 6f 20 74 68 65 6d 20 75 73 69 6e 67 0a  d to them using.
33a60 2a 2a 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  ** the [sqlite3_
33a70 62 69 6e 64 5f 62 6c 6f 62 20 7c 20 73 71 6c 69  bind_blob | sqli
33a80 74 65 33 5f 62 69 6e 64 5f 2a 28 29 20 41 50 49  te3_bind_*() API
33a90 5d 20 72 65 74 61 69 6e 20 74 68 65 69 72 20 76  ] retain their v
33aa0 61 6c 75 65 73 2e 0a 2a 2a 20 55 73 65 20 5b 73  alues..** Use [s
33ab0 71 6c 69 74 65 33 5f 63 6c 65 61 72 5f 62 69 6e  qlite3_clear_bin
33ac0 64 69 6e 67 73 28 29 5d 20 74 6f 20 72 65 73 65  dings()] to rese
33ad0 74 20 74 68 65 20 62 69 6e 64 69 6e 67 73 2e 0a  t the bindings..
33ae0 2a 2a 0a 2a 2a 20 5e 54 68 65 20 5b 73 71 6c 69  **.** ^The [sqli
33af0 74 65 33 5f 72 65 73 65 74 28 53 29 5d 20 69 6e  te3_reset(S)] in
33b00 74 65 72 66 61 63 65 20 72 65 73 65 74 73 20 74  terface resets t
33b10 68 65 20 5b 70 72 65 70 61 72 65 64 20 73 74 61  he [prepared sta
33b20 74 65 6d 65 6e 74 5d 20 53 0a 2a 2a 20 62 61 63  tement] S.** bac
33b30 6b 20 74 6f 20 74 68 65 20 62 65 67 69 6e 6e 69  k to the beginni
33b40 6e 67 20 6f 66 20 69 74 73 20 70 72 6f 67 72 61  ng of its progra
33b50 6d 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65  m..**.** ^If the
33b60 20 6d 6f 73 74 20 72 65 63 65 6e 74 20 63 61 6c   most recent cal
33b70 6c 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 73 74  l to [sqlite3_st
33b80 65 70 28 53 29 5d 20 66 6f 72 20 74 68 65 0a 2a  ep(S)] for the.*
33b90 2a 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74  * [prepared stat
33ba0 65 6d 65 6e 74 5d 20 53 20 72 65 74 75 72 6e 65  ement] S returne
33bb0 64 20 5b 53 51 4c 49 54 45 5f 52 4f 57 5d 20 6f  d [SQLITE_ROW] o
33bc0 72 20 5b 53 51 4c 49 54 45 5f 44 4f 4e 45 5d 2c  r [SQLITE_DONE],
33bd0 0a 2a 2a 20 6f 72 20 69 66 20 5b 73 71 6c 69 74  .** or if [sqlit
33be0 65 33 5f 73 74 65 70 28 53 29 5d 20 68 61 73 20  e3_step(S)] has 
33bf0 6e 65 76 65 72 20 62 65 66 6f 72 65 20 62 65 65  never before bee
33c00 6e 20 63 61 6c 6c 65 64 20 6f 6e 20 53 2c 0a 2a  n called on S,.*
33c10 2a 20 74 68 65 6e 20 5b 73 71 6c 69 74 65 33 5f  * then [sqlite3_
33c20 72 65 73 65 74 28 53 29 5d 20 72 65 74 75 72 6e  reset(S)] return
33c30 73 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 2e 0a 2a  s [SQLITE_OK]..*
33c40 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 6d 6f 73  *.** ^If the mos
33c50 74 20 72 65 63 65 6e 74 20 63 61 6c 6c 20 74 6f  t recent call to
33c60 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 53   [sqlite3_step(S
33c70 29 5d 20 66 6f 72 20 74 68 65 0a 2a 2a 20 5b 70  )] for the.** [p
33c80 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e  repared statemen
33c90 74 5d 20 53 20 69 6e 64 69 63 61 74 65 64 20 61  t] S indicated a
33ca0 6e 20 65 72 72 6f 72 2c 20 74 68 65 6e 0a 2a 2a  n error, then.**
33cb0 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28   [sqlite3_reset(
33cc0 53 29 5d 20 72 65 74 75 72 6e 73 20 61 6e 20 61  S)] returns an a
33cd0 70 70 72 6f 70 72 69 61 74 65 20 5b 65 72 72 6f  ppropriate [erro
33ce0 72 20 63 6f 64 65 5d 2e 0a 2a 2a 0a 2a 2a 20 5e  r code]..**.** ^
33cf0 54 68 65 20 5b 73 71 6c 69 74 65 33 5f 72 65 73  The [sqlite3_res
33d00 65 74 28 53 29 5d 20 69 6e 74 65 72 66 61 63 65  et(S)] interface
33d10 20 64 6f 65 73 20 6e 6f 74 20 63 68 61 6e 67 65   does not change
33d20 20 74 68 65 20 76 61 6c 75 65 73 0a 2a 2a 20 6f   the values.** o
33d30 66 20 61 6e 79 20 5b 73 71 6c 69 74 65 33 5f 62  f any [sqlite3_b
33d40 69 6e 64 5f 62 6c 6f 62 7c 62 69 6e 64 69 6e 67  ind_blob|binding
33d50 73 5d 20 6f 6e 20 74 68 65 20 5b 70 72 65 70 61  s] on the [prepa
33d60 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 53  red statement] S
33d70 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  ..*/.int sqlite3
33d80 5f 72 65 73 65 74 28 73 71 6c 69 74 65 33 5f 73  _reset(sqlite3_s
33d90 74 6d 74 20 2a 70 53 74 6d 74 29 3b 0a 0a 2f 2a  tmt *pStmt);../*
33da0 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 43 72  .** CAPI3REF: Cr
33db0 65 61 74 65 20 4f 72 20 52 65 64 65 66 69 6e 65  eate Or Redefine
33dc0 20 53 51 4c 20 46 75 6e 63 74 69 6f 6e 73 0a 2a   SQL Functions.*
33dd0 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b 66 75 6e  * KEYWORDS: {fun
33de0 63 74 69 6f 6e 20 63 72 65 61 74 69 6f 6e 20 72  ction creation r
33df0 6f 75 74 69 6e 65 73 7d 0a 2a 2a 20 4b 45 59 57  outines}.** KEYW
33e00 4f 52 44 53 3a 20 7b 61 70 70 6c 69 63 61 74 69  ORDS: {applicati
33e10 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51 4c 20 66  on-defined SQL f
33e20 75 6e 63 74 69 6f 6e 7d 0a 2a 2a 20 4b 45 59 57  unction}.** KEYW
33e30 4f 52 44 53 3a 20 7b 61 70 70 6c 69 63 61 74 69  ORDS: {applicati
33e40 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51 4c 20 66  on-defined SQL f
33e50 75 6e 63 74 69 6f 6e 73 7d 0a 2a 2a 20 4d 45 54  unctions}.** MET
33e60 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a 2a 0a  HOD: sqlite3.**.
33e70 2a 2a 20 5e 54 68 65 73 65 20 66 75 6e 63 74 69  ** ^These functi
33e80 6f 6e 73 20 28 63 6f 6c 6c 65 63 74 69 76 65 6c  ons (collectivel
33e90 79 20 6b 6e 6f 77 6e 20 61 73 20 22 66 75 6e 63  y known as "func
33ea0 74 69 6f 6e 20 63 72 65 61 74 69 6f 6e 20 72 6f  tion creation ro
33eb0 75 74 69 6e 65 73 22 29 0a 2a 2a 20 61 72 65 20  utines").** are 
33ec0 75 73 65 64 20 74 6f 20 61 64 64 20 53 51 4c 20  used to add SQL 
33ed0 66 75 6e 63 74 69 6f 6e 73 20 6f 72 20 61 67 67  functions or agg
33ee0 72 65 67 61 74 65 73 20 6f 72 20 74 6f 20 72 65  regates or to re
33ef0 64 65 66 69 6e 65 20 74 68 65 20 62 65 68 61 76  define the behav
33f00 69 6f 72 0a 2a 2a 20 6f 66 20 65 78 69 73 74 69  ior.** of existi
33f10 6e 67 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73  ng SQL functions
33f20 20 6f 72 20 61 67 67 72 65 67 61 74 65 73 2e 20   or aggregates. 
33f30 20 54 68 65 20 6f 6e 6c 79 20 64 69 66 66 65 72   The only differ
33f40 65 6e 63 65 73 20 62 65 74 77 65 65 6e 0a 2a 2a  ences between.**
33f50 20 74 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20   these routines 
33f60 61 72 65 20 74 68 65 20 74 65 78 74 20 65 6e 63  are the text enc
33f70 6f 64 69 6e 67 20 65 78 70 65 63 74 65 64 20 66  oding expected f
33f80 6f 72 0a 2a 2a 20 74 68 65 20 73 65 63 6f 6e 64  or.** the second
33f90 20 70 61 72 61 6d 65 74 65 72 20 28 74 68 65 20   parameter (the 
33fa0 6e 61 6d 65 20 6f 66 20 74 68 65 20 66 75 6e 63  name of the func
33fb0 74 69 6f 6e 20 62 65 69 6e 67 20 63 72 65 61 74  tion being creat
33fc0 65 64 29 0a 2a 2a 20 61 6e 64 20 74 68 65 20 70  ed).** and the p
33fd0 72 65 73 65 6e 63 65 20 6f 72 20 61 62 73 65 6e  resence or absen
33fe0 63 65 20 6f 66 20 61 20 64 65 73 74 72 75 63 74  ce of a destruct
33ff0 6f 72 20 63 61 6c 6c 62 61 63 6b 20 66 6f 72 0a  or callback for.
34000 2a 2a 20 74 68 65 20 61 70 70 6c 69 63 61 74 69  ** the applicati
34010 6f 6e 20 64 61 74 61 20 70 6f 69 6e 74 65 72 2e  on data pointer.
34020 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66 69 72 73  .**.** ^The firs
34030 74 20 70 61 72 61 6d 65 74 65 72 20 69 73 20 74  t parameter is t
34040 68 65 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e  he [database con
34050 6e 65 63 74 69 6f 6e 5d 20 74 6f 20 77 68 69 63  nection] to whic
34060 68 20 74 68 65 20 53 51 4c 0a 2a 2a 20 66 75 6e  h the SQL.** fun
34070 63 74 69 6f 6e 20 69 73 20 74 6f 20 62 65 20 61  ction is to be a
34080 64 64 65 64 2e 20 20 5e 49 66 20 61 6e 20 61 70  dded.  ^If an ap
34090 70 6c 69 63 61 74 69 6f 6e 20 75 73 65 73 20 6d  plication uses m
340a0 6f 72 65 20 74 68 61 6e 20 6f 6e 65 20 64 61 74  ore than one dat
340b0 61 62 61 73 65 0a 2a 2a 20 63 6f 6e 6e 65 63 74  abase.** connect
340c0 69 6f 6e 20 74 68 65 6e 20 61 70 70 6c 69 63 61  ion then applica
340d0 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51 4c  tion-defined SQL
340e0 20 66 75 6e 63 74 69 6f 6e 73 20 6d 75 73 74 20   functions must 
340f0 62 65 20 61 64 64 65 64 0a 2a 2a 20 74 6f 20 65  be added.** to e
34100 61 63 68 20 64 61 74 61 62 61 73 65 20 63 6f 6e  ach database con
34110 6e 65 63 74 69 6f 6e 20 73 65 70 61 72 61 74 65  nection separate
34120 6c 79 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  ly..**.** ^The s
34130 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20  econd parameter 
34140 69 73 20 74 68 65 20 6e 61 6d 65 20 6f 66 20 74  is the name of t
34150 68 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20  he SQL function 
34160 74 6f 20 62 65 20 63 72 65 61 74 65 64 20 6f 72  to be created or
34170 0a 2a 2a 20 72 65 64 65 66 69 6e 65 64 2e 20 20  .** redefined.  
34180 5e 54 68 65 20 6c 65 6e 67 74 68 20 6f 66 20 74  ^The length of t
34190 68 65 20 6e 61 6d 65 20 69 73 20 6c 69 6d 69 74  he name is limit
341a0 65 64 20 74 6f 20 32 35 35 20 62 79 74 65 73 20  ed to 255 bytes 
341b0 69 6e 20 61 20 55 54 46 2d 38 0a 2a 2a 20 72 65  in a UTF-8.** re
341c0 70 72 65 73 65 6e 74 61 74 69 6f 6e 2c 20 65 78  presentation, ex
341d0 63 6c 75 73 69 76 65 20 6f 66 20 74 68 65 20 7a  clusive of the z
341e0 65 72 6f 2d 74 65 72 6d 69 6e 61 74 6f 72 2e 20  ero-terminator. 
341f0 20 5e 4e 6f 74 65 20 74 68 61 74 20 74 68 65 20   ^Note that the 
34200 6e 61 6d 65 0a 2a 2a 20 6c 65 6e 67 74 68 20 6c  name.** length l
34210 69 6d 69 74 20 69 73 20 69 6e 20 55 54 46 2d 38  imit is in UTF-8
34220 20 62 79 74 65 73 2c 20 6e 6f 74 20 63 68 61 72   bytes, not char
34230 61 63 74 65 72 73 20 6e 6f 72 20 55 54 46 2d 31  acters nor UTF-1
34240 36 20 62 79 74 65 73 2e 20 20 0a 2a 2a 20 5e 41  6 bytes.  .** ^A
34250 6e 79 20 61 74 74 65 6d 70 74 20 74 6f 20 63 72  ny attempt to cr
34260 65 61 74 65 20 61 20 66 75 6e 63 74 69 6f 6e 20  eate a function 
34270 77 69 74 68 20 61 20 6c 6f 6e 67 65 72 20 6e 61  with a longer na
34280 6d 65 0a 2a 2a 20 77 69 6c 6c 20 72 65 73 75 6c  me.** will resul
34290 74 20 69 6e 20 5b 53 51 4c 49 54 45 5f 4d 49 53  t in [SQLITE_MIS
342a0 55 53 45 5d 20 62 65 69 6e 67 20 72 65 74 75 72  USE] being retur
342b0 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  ned..**.** ^The 
342c0 74 68 69 72 64 20 70 61 72 61 6d 65 74 65 72 20  third parameter 
342d0 28 6e 41 72 67 29 0a 2a 2a 20 69 73 20 74 68 65  (nArg).** is the
342e0 20 6e 75 6d 62 65 72 20 6f 66 20 61 72 67 75 6d   number of argum
342f0 65 6e 74 73 20 74 68 61 74 20 74 68 65 20 53 51  ents that the SQ
34300 4c 20 66 75 6e 63 74 69 6f 6e 20 6f 72 0a 2a 2a  L function or.**
34310 20 61 67 67 72 65 67 61 74 65 20 74 61 6b 65 73   aggregate takes
34320 2e 20 5e 49 66 20 74 68 69 73 20 70 61 72 61 6d  . ^If this param
34330 65 74 65 72 20 69 73 20 2d 31 2c 20 74 68 65 6e  eter is -1, then
34340 20 74 68 65 20 53 51 4c 20 66 75 6e 63 74 69 6f   the SQL functio
34350 6e 20 6f 72 0a 2a 2a 20 61 67 67 72 65 67 61 74  n or.** aggregat
34360 65 20 6d 61 79 20 74 61 6b 65 20 61 6e 79 20 6e  e may take any n
34370 75 6d 62 65 72 20 6f 66 20 61 72 67 75 6d 65 6e  umber of argumen
34380 74 73 20 62 65 74 77 65 65 6e 20 30 20 61 6e 64  ts between 0 and
34390 20 74 68 65 20 6c 69 6d 69 74 0a 2a 2a 20 73 65   the limit.** se
343a0 74 20 62 79 20 5b 73 71 6c 69 74 65 33 5f 6c 69  t by [sqlite3_li
343b0 6d 69 74 5d 28 5b 53 51 4c 49 54 45 5f 4c 49 4d  mit]([SQLITE_LIM
343c0 49 54 5f 46 55 4e 43 54 49 4f 4e 5f 41 52 47 5d  IT_FUNCTION_ARG]
343d0 29 2e 20 20 49 66 20 74 68 65 20 74 68 69 72 64  ).  If the third
343e0 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72 20 69 73  .** parameter is
343f0 20 6c 65 73 73 20 74 68 61 6e 20 2d 31 20 6f 72   less than -1 or
34400 20 67 72 65 61 74 65 72 20 74 68 61 6e 20 31 32   greater than 12
34410 37 20 74 68 65 6e 20 74 68 65 20 62 65 68 61 76  7 then the behav
34420 69 6f 72 20 69 73 0a 2a 2a 20 75 6e 64 65 66 69  ior is.** undefi
34430 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  ned..**.** ^The 
34440 66 6f 75 72 74 68 20 70 61 72 61 6d 65 74 65 72  fourth parameter
34450 2c 20 65 54 65 78 74 52 65 70 2c 20 73 70 65 63  , eTextRep, spec
34460 69 66 69 65 73 20 77 68 61 74 0a 2a 2a 20 5b 53  ifies what.** [S
34470 51 4c 49 54 45 5f 55 54 46 38 20 7c 20 74 65 78  QLITE_UTF8 | tex
34480 74 20 65 6e 63 6f 64 69 6e 67 5d 20 74 68 69 73  t encoding] this
34490 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 70 72   SQL function pr
344a0 65 66 65 72 73 20 66 6f 72 0a 2a 2a 20 69 74 73  efers for.** its
344b0 20 70 61 72 61 6d 65 74 65 72 73 2e 20 20 54 68   parameters.  Th
344c0 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 73 68  e application sh
344d0 6f 75 6c 64 20 73 65 74 20 74 68 69 73 20 70 61  ould set this pa
344e0 72 61 6d 65 74 65 72 20 74 6f 0a 2a 2a 20 5b 53  rameter to.** [S
344f0 51 4c 49 54 45 5f 55 54 46 31 36 4c 45 5d 20 69  QLITE_UTF16LE] i
34500 66 20 74 68 65 20 66 75 6e 63 74 69 6f 6e 20 69  f the function i
34510 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 69 6e  mplementation in
34520 76 6f 6b 65 73 20 0a 2a 2a 20 5b 73 71 6c 69 74  vokes .** [sqlit
34530 65 33 5f 76 61 6c 75 65 5f 74 65 78 74 31 36 6c  e3_value_text16l
34540 65 28 29 5d 20 6f 6e 20 61 6e 20 69 6e 70 75 74  e()] on an input
34550 2c 20 6f 72 20 5b 53 51 4c 49 54 45 5f 55 54 46  , or [SQLITE_UTF
34560 31 36 42 45 5d 20 69 66 20 74 68 65 0a 2a 2a 20  16BE] if the.** 
34570 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 69  implementation i
34580 6e 76 6f 6b 65 73 20 5b 73 71 6c 69 74 65 33 5f  nvokes [sqlite3_
34590 76 61 6c 75 65 5f 74 65 78 74 31 36 62 65 28 29  value_text16be()
345a0 5d 20 6f 6e 20 61 6e 20 69 6e 70 75 74 2c 20 6f  ] on an input, o
345b0 72 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 55 54 46  r.** [SQLITE_UTF
345c0 31 36 5d 20 69 66 20 5b 73 71 6c 69 74 65 33 5f  16] if [sqlite3_
345d0 76 61 6c 75 65 5f 74 65 78 74 31 36 28 29 5d 20  value_text16()] 
345e0 69 73 20 75 73 65 64 2c 20 6f 72 20 5b 53 51 4c  is used, or [SQL
345f0 49 54 45 5f 55 54 46 38 5d 0a 2a 2a 20 6f 74 68  ITE_UTF8].** oth
34600 65 72 77 69 73 65 2e 20 20 5e 54 68 65 20 73 61  erwise.  ^The sa
34610 6d 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20  me SQL function 
34620 6d 61 79 20 62 65 20 72 65 67 69 73 74 65 72 65  may be registere
34630 64 20 6d 75 6c 74 69 70 6c 65 20 74 69 6d 65 73  d multiple times
34640 20 75 73 69 6e 67 0a 2a 2a 20 64 69 66 66 65 72   using.** differ
34650 65 6e 74 20 70 72 65 66 65 72 72 65 64 20 74 65  ent preferred te
34660 78 74 20 65 6e 63 6f 64 69 6e 67 73 2c 20 77 69  xt encodings, wi
34670 74 68 20 64 69 66 66 65 72 65 6e 74 20 69 6d 70  th different imp
34680 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20 66 6f 72  lementations for
34690 0a 2a 2a 20 65 61 63 68 20 65 6e 63 6f 64 69 6e  .** each encodin
346a0 67 2e 0a 2a 2a 20 5e 57 68 65 6e 20 6d 75 6c 74  g..** ^When mult
346b0 69 70 6c 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74  iple implementat
346c0 69 6f 6e 73 20 6f 66 20 74 68 65 20 73 61 6d 65  ions of the same
346d0 20 66 75 6e 63 74 69 6f 6e 20 61 72 65 20 61 76   function are av
346e0 61 69 6c 61 62 6c 65 2c 20 53 51 4c 69 74 65 0a  ailable, SQLite.
346f0 2a 2a 20 77 69 6c 6c 20 70 69 63 6b 20 74 68 65  ** will pick the
34700 20 6f 6e 65 20 74 68 61 74 20 69 6e 76 6f 6c 76   one that involv
34710 65 73 20 74 68 65 20 6c 65 61 73 74 20 61 6d 6f  es the least amo
34720 75 6e 74 20 6f 66 20 64 61 74 61 20 63 6f 6e 76  unt of data conv
34730 65 72 73 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 54  ersion..**.** ^T
34740 68 65 20 66 6f 75 72 74 68 20 70 61 72 61 6d 65  he fourth parame
34750 74 65 72 20 6d 61 79 20 6f 70 74 69 6f 6e 61 6c  ter may optional
34760 6c 79 20 62 65 20 4f 52 65 64 20 77 69 74 68 20  ly be ORed with 
34770 5b 53 51 4c 49 54 45 5f 44 45 54 45 52 4d 49 4e  [SQLITE_DETERMIN
34780 49 53 54 49 43 5d 0a 2a 2a 20 74 6f 20 73 69 67  ISTIC].** to sig
34790 6e 61 6c 20 74 68 61 74 20 74 68 65 20 66 75 6e  nal that the fun
347a0 63 74 69 6f 6e 20 77 69 6c 6c 20 61 6c 77 61 79  ction will alway
347b0 73 20 72 65 74 75 72 6e 20 74 68 65 20 73 61 6d  s return the sam
347c0 65 20 72 65 73 75 6c 74 20 67 69 76 65 6e 0a 2a  e result given.*
347d0 2a 20 74 68 65 20 73 61 6d 65 20 69 6e 70 75 74  * the same input
347e0 73 20 77 69 74 68 69 6e 20 61 20 73 69 6e 67 6c  s within a singl
347f0 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2e  e SQL statement.
34800 20 20 4d 6f 73 74 20 53 51 4c 20 66 75 6e 63 74    Most SQL funct
34810 69 6f 6e 73 20 61 72 65 0a 2a 2a 20 64 65 74 65  ions are.** dete
34820 72 6d 69 6e 69 73 74 69 63 2e 20 20 54 68 65 20  rministic.  The 
34830 62 75 69 6c 74 2d 69 6e 20 5b 72 61 6e 64 6f 6d  built-in [random
34840 28 29 5d 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  ()] SQL function
34850 20 69 73 20 61 6e 20 65 78 61 6d 70 6c 65 20 6f   is an example o
34860 66 20 61 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20  f a.** function 
34870 74 68 61 74 20 69 73 20 6e 6f 74 20 64 65 74 65  that is not dete
34880 72 6d 69 6e 69 73 74 69 63 2e 20 20 54 68 65 20  rministic.  The 
34890 53 51 4c 69 74 65 20 71 75 65 72 79 20 70 6c 61  SQLite query pla
348a0 6e 6e 65 72 20 69 73 20 61 62 6c 65 20 74 6f 0a  nner is able to.
348b0 2a 2a 20 70 65 72 66 6f 72 6d 20 61 64 64 69 74  ** perform addit
348c0 69 6f 6e 61 6c 20 6f 70 74 69 6d 69 7a 61 74 69  ional optimizati
348d0 6f 6e 73 20 6f 6e 20 64 65 74 65 72 6d 69 6e 69  ons on determini
348e0 73 74 69 63 20 66 75 6e 63 74 69 6f 6e 73 2c 20  stic functions, 
348f0 73 6f 20 75 73 65 0a 2a 2a 20 6f 66 20 74 68 65  so use.** of the
34900 20 5b 53 51 4c 49 54 45 5f 44 45 54 45 52 4d 49   [SQLITE_DETERMI
34910 4e 49 53 54 49 43 5d 20 66 6c 61 67 20 69 73 20  NISTIC] flag is 
34920 72 65 63 6f 6d 6d 65 6e 64 65 64 20 77 68 65 72  recommended wher
34930 65 20 70 6f 73 73 69 62 6c 65 2e 0a 2a 2a 0a 2a  e possible..**.*
34940 2a 20 5e 28 54 68 65 20 66 69 66 74 68 20 70 61  * ^(The fifth pa
34950 72 61 6d 65 74 65 72 20 69 73 20 61 6e 20 61 72  rameter is an ar
34960 62 69 74 72 61 72 79 20 70 6f 69 6e 74 65 72 2e  bitrary pointer.
34970 20 20 54 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61    The implementa
34980 74 69 6f 6e 20 6f 66 20 74 68 65 0a 2a 2a 20 66  tion of the.** f
34990 75 6e 63 74 69 6f 6e 20 63 61 6e 20 67 61 69 6e  unction can gain
349a0 20 61 63 63 65 73 73 20 74 6f 20 74 68 69 73 20   access to this 
349b0 70 6f 69 6e 74 65 72 20 75 73 69 6e 67 20 5b 73  pointer using [s
349c0 71 6c 69 74 65 33 5f 75 73 65 72 5f 64 61 74 61  qlite3_user_data
349d0 28 29 5d 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 54 68  ()].)^.**.** ^Th
349e0 65 20 73 69 78 74 68 2c 20 73 65 76 65 6e 74 68  e sixth, seventh
349f0 20 61 6e 64 20 65 69 67 68 74 68 20 70 61 72 61   and eighth para
34a00 6d 65 74 65 72 73 2c 20 78 46 75 6e 63 2c 20 78  meters, xFunc, x
34a10 53 74 65 70 20 61 6e 64 20 78 46 69 6e 61 6c 2c  Step and xFinal,
34a20 20 61 72 65 0a 2a 2a 20 70 6f 69 6e 74 65 72 73   are.** pointers
34a30 20 74 6f 20 43 2d 6c 61 6e 67 75 61 67 65 20 66   to C-language f
34a40 75 6e 63 74 69 6f 6e 73 20 74 68 61 74 20 69 6d  unctions that im
34a50 70 6c 65 6d 65 6e 74 20 74 68 65 20 53 51 4c 20  plement the SQL 
34a60 66 75 6e 63 74 69 6f 6e 20 6f 72 0a 2a 2a 20 61  function or.** a
34a70 67 67 72 65 67 61 74 65 2e 20 5e 41 20 73 63 61  ggregate. ^A sca
34a80 6c 61 72 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  lar SQL function
34a90 20 72 65 71 75 69 72 65 73 20 61 6e 20 69 6d 70   requires an imp
34aa0 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20 74  lementation of t
34ab0 68 65 20 78 46 75 6e 63 0a 2a 2a 20 63 61 6c 6c  he xFunc.** call
34ac0 62 61 63 6b 20 6f 6e 6c 79 3b 20 4e 55 4c 4c 20  back only; NULL 
34ad0 70 6f 69 6e 74 65 72 73 20 6d 75 73 74 20 62 65  pointers must be
34ae0 20 70 61 73 73 65 64 20 61 73 20 74 68 65 20 78   passed as the x
34af0 53 74 65 70 20 61 6e 64 20 78 46 69 6e 61 6c 0a  Step and xFinal.
34b00 2a 2a 20 70 61 72 61 6d 65 74 65 72 73 2e 20 5e  ** parameters. ^
34b10 41 6e 20 61 67 67 72 65 67 61 74 65 20 53 51 4c  An aggregate SQL
34b20 20 66 75 6e 63 74 69 6f 6e 20 72 65 71 75 69 72   function requir
34b30 65 73 20 61 6e 20 69 6d 70 6c 65 6d 65 6e 74 61  es an implementa
34b40 74 69 6f 6e 20 6f 66 20 78 53 74 65 70 0a 2a 2a  tion of xStep.**
34b50 20 61 6e 64 20 78 46 69 6e 61 6c 20 61 6e 64 20   and xFinal and 
34b60 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 6d 75 73  NULL pointer mus
34b70 74 20 62 65 20 70 61 73 73 65 64 20 66 6f 72 20  t be passed for 
34b80 78 46 75 6e 63 2e 20 5e 54 6f 20 64 65 6c 65 74  xFunc. ^To delet
34b90 65 20 61 6e 20 65 78 69 73 74 69 6e 67 0a 2a 2a  e an existing.**
34ba0 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 6f 72   SQL function or
34bb0 20 61 67 67 72 65 67 61 74 65 2c 20 70 61 73 73   aggregate, pass
34bc0 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 73 20 66   NULL pointers f
34bd0 6f 72 20 61 6c 6c 20 74 68 72 65 65 20 66 75 6e  or all three fun
34be0 63 74 69 6f 6e 0a 2a 2a 20 63 61 6c 6c 62 61 63  ction.** callbac
34bf0 6b 73 2e 0a 2a 2a 0a 2a 2a 20 5e 28 49 66 20 74  ks..**.** ^(If t
34c00 68 65 20 6e 69 6e 74 68 20 70 61 72 61 6d 65 74  he ninth paramet
34c10 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 63 72  er to sqlite3_cr
34c20 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 5f 76 32  eate_function_v2
34c30 28 29 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 2c 0a  () is not NULL,.
34c40 2a 2a 20 74 68 65 6e 20 69 74 20 69 73 20 64 65  ** then it is de
34c50 73 74 72 75 63 74 6f 72 20 66 6f 72 20 74 68 65  structor for the
34c60 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 64 61 74   application dat
34c70 61 20 70 6f 69 6e 74 65 72 2e 20 0a 2a 2a 20 54  a pointer. .** T
34c80 68 65 20 64 65 73 74 72 75 63 74 6f 72 20 69 73  he destructor is
34c90 20 69 6e 76 6f 6b 65 64 20 77 68 65 6e 20 74 68   invoked when th
34ca0 65 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 64 65  e function is de
34cb0 6c 65 74 65 64 2c 20 65 69 74 68 65 72 20 62 79  leted, either by
34cc0 20 62 65 69 6e 67 0a 2a 2a 20 6f 76 65 72 6c 6f   being.** overlo
34cd0 61 64 65 64 20 6f 72 20 77 68 65 6e 20 74 68 65  aded or when the
34ce0 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63   database connec
34cf0 74 69 6f 6e 20 63 6c 6f 73 65 73 2e 29 5e 0a 2a  tion closes.)^.*
34d00 2a 20 5e 54 68 65 20 64 65 73 74 72 75 63 74 6f  * ^The destructo
34d10 72 20 69 73 20 61 6c 73 6f 20 69 6e 76 6f 6b 65  r is also invoke
34d20 64 20 69 66 20 74 68 65 20 63 61 6c 6c 20 74 6f  d if the call to
34d30 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63 72 65 61  .** sqlite3_crea
34d40 74 65 5f 66 75 6e 63 74 69 6f 6e 5f 76 32 28 29  te_function_v2()
34d50 20 66 61 69 6c 73 2e 0a 2a 2a 20 5e 57 68 65 6e   fails..** ^When
34d60 20 74 68 65 20 64 65 73 74 72 75 63 74 6f 72 20   the destructor 
34d70 63 61 6c 6c 62 61 63 6b 20 6f 66 20 74 68 65 20  callback of the 
34d80 74 65 6e 74 68 20 70 61 72 61 6d 65 74 65 72 20  tenth parameter 
34d90 69 73 20 69 6e 76 6f 6b 65 64 2c 20 69 74 0a 2a  is invoked, it.*
34da0 2a 20 69 73 20 70 61 73 73 65 64 20 61 20 73 69  * is passed a si
34db0 6e 67 6c 65 20 61 72 67 75 6d 65 6e 74 20 77 68  ngle argument wh
34dc0 69 63 68 20 69 73 20 61 20 63 6f 70 79 20 6f 66  ich is a copy of
34dd0 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   the application
34de0 20 64 61 74 61 20 0a 2a 2a 20 70 6f 69 6e 74 65   data .** pointe
34df0 72 20 77 68 69 63 68 20 77 61 73 20 74 68 65 20  r which was the 
34e00 66 69 66 74 68 20 70 61 72 61 6d 65 74 65 72 20  fifth parameter 
34e10 74 6f 20 73 71 6c 69 74 65 33 5f 63 72 65 61 74  to sqlite3_creat
34e20 65 5f 66 75 6e 63 74 69 6f 6e 5f 76 32 28 29 2e  e_function_v2().
34e30 0a 2a 2a 0a 2a 2a 20 5e 49 74 20 69 73 20 70 65  .**.** ^It is pe
34e40 72 6d 69 74 74 65 64 20 74 6f 20 72 65 67 69 73  rmitted to regis
34e50 74 65 72 20 6d 75 6c 74 69 70 6c 65 20 69 6d 70  ter multiple imp
34e60 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20 6f 66 20  lementations of 
34e70 74 68 65 20 73 61 6d 65 0a 2a 2a 20 66 75 6e 63  the same.** func
34e80 74 69 6f 6e 73 20 77 69 74 68 20 74 68 65 20 73  tions with the s
34e90 61 6d 65 20 6e 61 6d 65 20 62 75 74 20 77 69 74  ame name but wit
34ea0 68 20 65 69 74 68 65 72 20 64 69 66 66 65 72 69  h either differi
34eb0 6e 67 20 6e 75 6d 62 65 72 73 20 6f 66 0a 2a 2a  ng numbers of.**
34ec0 20 61 72 67 75 6d 65 6e 74 73 20 6f 72 20 64 69   arguments or di
34ed0 66 66 65 72 69 6e 67 20 70 72 65 66 65 72 72 65  ffering preferre
34ee0 64 20 74 65 78 74 20 65 6e 63 6f 64 69 6e 67 73  d text encodings
34ef0 2e 20 20 5e 53 51 4c 69 74 65 20 77 69 6c 6c 20  .  ^SQLite will 
34f00 75 73 65 0a 2a 2a 20 74 68 65 20 69 6d 70 6c 65  use.** the imple
34f10 6d 65 6e 74 61 74 69 6f 6e 20 74 68 61 74 20 6d  mentation that m
34f20 6f 73 74 20 63 6c 6f 73 65 6c 79 20 6d 61 74 63  ost closely matc
34f30 68 65 73 20 74 68 65 20 77 61 79 20 69 6e 20 77  hes the way in w
34f40 68 69 63 68 20 74 68 65 0a 2a 2a 20 53 51 4c 20  hich the.** SQL 
34f50 66 75 6e 63 74 69 6f 6e 20 69 73 20 75 73 65 64  function is used
34f60 2e 20 20 5e 41 20 66 75 6e 63 74 69 6f 6e 20 69  .  ^A function i
34f70 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 77 69  mplementation wi
34f80 74 68 20 61 20 6e 6f 6e 2d 6e 65 67 61 74 69 76  th a non-negativ
34f90 65 0a 2a 2a 20 6e 41 72 67 20 70 61 72 61 6d 65  e.** nArg parame
34fa0 74 65 72 20 69 73 20 61 20 62 65 74 74 65 72 20  ter is a better 
34fb0 6d 61 74 63 68 20 74 68 61 6e 20 61 20 66 75 6e  match than a fun
34fc0 63 74 69 6f 6e 20 69 6d 70 6c 65 6d 65 6e 74 61  ction implementa
34fd0 74 69 6f 6e 20 77 69 74 68 0a 2a 2a 20 61 20 6e  tion with.** a n
34fe0 65 67 61 74 69 76 65 20 6e 41 72 67 2e 20 20 5e  egative nArg.  ^
34ff0 41 20 66 75 6e 63 74 69 6f 6e 20 77 68 65 72 65  A function where
35000 20 74 68 65 20 70 72 65 66 65 72 72 65 64 20 74   the preferred t
35010 65 78 74 20 65 6e 63 6f 64 69 6e 67 0a 2a 2a 20  ext encoding.** 
35020 6d 61 74 63 68 65 73 20 74 68 65 20 64 61 74 61  matches the data
35030 62 61 73 65 20 65 6e 63 6f 64 69 6e 67 20 69 73  base encoding is
35040 20 61 20 62 65 74 74 65 72 0a 2a 2a 20 6d 61 74   a better.** mat
35050 63 68 20 74 68 61 6e 20 61 20 66 75 6e 63 74 69  ch than a functi
35060 6f 6e 20 77 68 65 72 65 20 74 68 65 20 65 6e 63  on where the enc
35070 6f 64 69 6e 67 20 69 73 20 64 69 66 66 65 72 65  oding is differe
35080 6e 74 2e 20 20 0a 2a 2a 20 5e 41 20 66 75 6e 63  nt.  .** ^A func
35090 74 69 6f 6e 20 77 68 65 72 65 20 74 68 65 20 65  tion where the e
350a0 6e 63 6f 64 69 6e 67 20 64 69 66 66 65 72 65 6e  ncoding differen
350b0 63 65 20 69 73 20 62 65 74 77 65 65 6e 20 55 54  ce is between UT
350c0 46 31 36 6c 65 20 61 6e 64 20 55 54 46 31 36 62  F16le and UTF16b
350d0 65 0a 2a 2a 20 69 73 20 61 20 63 6c 6f 73 65 72  e.** is a closer
350e0 20 6d 61 74 63 68 20 74 68 61 6e 20 61 20 66 75   match than a fu
350f0 6e 63 74 69 6f 6e 20 77 68 65 72 65 20 74 68 65  nction where the
35100 20 65 6e 63 6f 64 69 6e 67 20 64 69 66 66 65 72   encoding differ
35110 65 6e 63 65 20 69 73 0a 2a 2a 20 62 65 74 77 65  ence is.** betwe
35120 65 6e 20 55 54 46 38 20 61 6e 64 20 55 54 46 31  en UTF8 and UTF1
35130 36 2e 0a 2a 2a 0a 2a 2a 20 5e 42 75 69 6c 74 2d  6..**.** ^Built-
35140 69 6e 20 66 75 6e 63 74 69 6f 6e 73 20 6d 61 79  in functions may
35150 20 62 65 20 6f 76 65 72 6c 6f 61 64 65 64 20 62   be overloaded b
35160 79 20 6e 65 77 20 61 70 70 6c 69 63 61 74 69 6f  y new applicatio
35170 6e 2d 64 65 66 69 6e 65 64 20 66 75 6e 63 74 69  n-defined functi
35180 6f 6e 73 2e 0a 2a 2a 0a 2a 2a 20 5e 41 6e 20 61  ons..**.** ^An a
35190 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e  pplication-defin
351a0 65 64 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 70  ed function is p
351b0 65 72 6d 69 74 74 65 64 20 74 6f 20 63 61 6c 6c  ermitted to call
351c0 20 6f 74 68 65 72 0a 2a 2a 20 53 51 4c 69 74 65   other.** SQLite
351d0 20 69 6e 74 65 72 66 61 63 65 73 2e 20 20 48 6f   interfaces.  Ho
351e0 77 65 76 65 72 2c 20 73 75 63 68 20 63 61 6c 6c  wever, such call
351f0 73 20 6d 75 73 74 20 6e 6f 74 0a 2a 2a 20 63 6c  s must not.** cl
35200 6f 73 65 20 74 68 65 20 64 61 74 61 62 61 73 65  ose the database
35210 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 6e 6f 72 20   connection nor 
35220 66 69 6e 61 6c 69 7a 65 20 6f 72 20 72 65 73 65  finalize or rese
35230 74 20 74 68 65 20 70 72 65 70 61 72 65 64 0a 2a  t the prepared.*
35240 2a 20 73 74 61 74 65 6d 65 6e 74 20 69 6e 20 77  * statement in w
35250 68 69 63 68 20 74 68 65 20 66 75 6e 63 74 69 6f  hich the functio
35260 6e 20 69 73 20 72 75 6e 6e 69 6e 67 2e 0a 2a 2f  n is running..*/
35270 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 63 72 65  .int sqlite3_cre
35280 61 74 65 5f 66 75 6e 63 74 69 6f 6e 28 0a 20 20  ate_function(.  
35290 73 71 6c 69 74 65 33 20 2a 64 62 2c 0a 20 20 63  sqlite3 *db,.  c
352a0 6f 6e 73 74 20 63 68 61 72 20 2a 7a 46 75 6e 63  onst char *zFunc
352b0 74 69 6f 6e 4e 61 6d 65 2c 0a 20 20 69 6e 74 20  tionName,.  int 
352c0 6e 41 72 67 2c 0a 20 20 69 6e 74 20 65 54 65 78  nArg,.  int eTex
352d0 74 52 65 70 2c 0a 20 20 76 6f 69 64 20 2a 70 41  tRep,.  void *pA
352e0 70 70 2c 0a 20 20 76 6f 69 64 20 28 2a 78 46 75  pp,.  void (*xFu
352f0 6e 63 29 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74  nc)(sqlite3_cont
35300 65 78 74 2a 2c 69 6e 74 2c 73 71 6c 69 74 65 33  ext*,int,sqlite3
35310 5f 76 61 6c 75 65 2a 2a 29 2c 0a 20 20 76 6f 69  _value**),.  voi
35320 64 20 28 2a 78 53 74 65 70 29 28 73 71 6c 69 74  d (*xStep)(sqlit
35330 65 33 5f 63 6f 6e 74 65 78 74 2a 2c 69 6e 74 2c  e3_context*,int,
35340 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 2a 29  sqlite3_value**)
35350 2c 0a 20 20 76 6f 69 64 20 28 2a 78 46 69 6e 61  ,.  void (*xFina
35360 6c 29 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65  l)(sqlite3_conte
35370 78 74 2a 29 0a 29 3b 0a 69 6e 74 20 73 71 6c 69  xt*).);.int sqli
35380 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74  te3_create_funct
35390 69 6f 6e 31 36 28 0a 20 20 73 71 6c 69 74 65 33  ion16(.  sqlite3
353a0 20 2a 64 62 2c 0a 20 20 63 6f 6e 73 74 20 76 6f   *db,.  const vo
353b0 69 64 20 2a 7a 46 75 6e 63 74 69 6f 6e 4e 61 6d  id *zFunctionNam
353c0 65 2c 0a 20 20 69 6e 74 20 6e 41 72 67 2c 0a 20  e,.  int nArg,. 
353d0 20 69 6e 74 20 65 54 65 78 74 52 65 70 2c 0a 20   int eTextRep,. 
353e0 20 76 6f 69 64 20 2a 70 41 70 70 2c 0a 20 20 76   void *pApp,.  v
353f0 6f 69 64 20 28 2a 78 46 75 6e 63 29 28 73 71 6c  oid (*xFunc)(sql
35400 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 2c 69 6e  ite3_context*,in
35410 74 2c 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a  t,sqlite3_value*
35420 2a 29 2c 0a 20 20 76 6f 69 64 20 28 2a 78 53 74  *),.  void (*xSt
35430 65 70 29 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74  ep)(sqlite3_cont
35440 65 78 74 2a 2c 69 6e 74 2c 73 71 6c 69 74 65 33  ext*,int,sqlite3
35450 5f 76 61 6c 75 65 2a 2a 29 2c 0a 20 20 76 6f 69  _value**),.  voi
35460 64 20 28 2a 78 46 69 6e 61 6c 29 28 73 71 6c 69  d (*xFinal)(sqli
35470 74 65 33 5f 63 6f 6e 74 65 78 74 2a 29 0a 29 3b  te3_context*).);
35480 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 63 72 65  .int sqlite3_cre
35490 61 74 65 5f 66 75 6e 63 74 69 6f 6e 5f 76 32 28  ate_function_v2(
354a0 0a 20 20 73 71 6c 69 74 65 33 20 2a 64 62 2c 0a  .  sqlite3 *db,.
354b0 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 46    const char *zF
354c0 75 6e 63 74 69 6f 6e 4e 61 6d 65 2c 0a 20 20 69  unctionName,.  i
354d0 6e 74 20 6e 41 72 67 2c 0a 20 20 69 6e 74 20 65  nt nArg,.  int e
354e0 54 65 78 74 52 65 70 2c 0a 20 20 76 6f 69 64 20  TextRep,.  void 
354f0 2a 70 41 70 70 2c 0a 20 20 76 6f 69 64 20 28 2a  *pApp,.  void (*
35500 78 46 75 6e 63 29 28 73 71 6c 69 74 65 33 5f 63  xFunc)(sqlite3_c
35510 6f 6e 74 65 78 74 2a 2c 69 6e 74 2c 73 71 6c 69  ontext*,int,sqli
35520 74 65 33 5f 76 61 6c 75 65 2a 2a 29 2c 0a 20 20  te3_value**),.  
35530 76 6f 69 64 20 28 2a 78 53 74 65 70 29 28 73 71  void (*xStep)(sq
35540 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 2c 69  lite3_context*,i
35550 6e 74 2c 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  nt,sqlite3_value
35560 2a 2a 29 2c 0a 20 20 76 6f 69 64 20 28 2a 78 46  **),.  void (*xF
35570 69 6e 61 6c 29 28 73 71 6c 69 74 65 33 5f 63 6f  inal)(sqlite3_co
35580 6e 74 65 78 74 2a 29 2c 0a 20 20 76 6f 69 64 28  ntext*),.  void(
35590 2a 78 44 65 73 74 72 6f 79 29 28 76 6f 69 64 2a  *xDestroy)(void*
355a0 29 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  ).);../*.** CAPI
355b0 33 52 45 46 3a 20 54 65 78 74 20 45 6e 63 6f 64  3REF: Text Encod
355c0 69 6e 67 73 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65  ings.**.** These
355d0 20 63 6f 6e 73 74 61 6e 74 20 64 65 66 69 6e 65   constant define
355e0 20 69 6e 74 65 67 65 72 20 63 6f 64 65 73 20 74   integer codes t
355f0 68 61 74 20 72 65 70 72 65 73 65 6e 74 20 74 68  hat represent th
35600 65 20 76 61 72 69 6f 75 73 0a 2a 2a 20 74 65 78  e various.** tex
35610 74 20 65 6e 63 6f 64 69 6e 67 73 20 73 75 70 70  t encodings supp
35620 6f 72 74 65 64 20 62 79 20 53 51 4c 69 74 65 2e  orted by SQLite.
35630 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  .*/.#define SQLI
35640 54 45 5f 55 54 46 38 20 20 20 20 20 20 20 20 20  TE_UTF8         
35650 20 20 31 20 20 20 20 2f 2a 20 49 4d 50 3a 20 52    1    /* IMP: R
35660 2d 33 37 35 31 34 2d 33 35 35 36 36 20 2a 2f 0a  -37514-35566 */.
35670 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 55  #define SQLITE_U
35680 54 46 31 36 4c 45 20 20 20 20 20 20 20 20 32 20  TF16LE        2 
35690 20 20 20 2f 2a 20 49 4d 50 3a 20 52 2d 30 33 33     /* IMP: R-033
356a0 37 31 2d 33 37 36 33 37 20 2a 2f 0a 23 64 65 66  71-37637 */.#def
356b0 69 6e 65 20 53 51 4c 49 54 45 5f 55 54 46 31 36  ine SQLITE_UTF16
356c0 42 45 20 20 20 20 20 20 20 20 33 20 20 20 20 2f  BE        3    /
356d0 2a 20 49 4d 50 3a 20 52 2d 35 31 39 37 31 2d 33  * IMP: R-51971-3
356e0 34 31 35 34 20 2a 2f 0a 23 64 65 66 69 6e 65 20  4154 */.#define 
356f0 53 51 4c 49 54 45 5f 55 54 46 31 36 20 20 20 20  SQLITE_UTF16    
35700 20 20 20 20 20 20 34 20 20 20 20 2f 2a 20 55 73        4    /* Us
35710 65 20 6e 61 74 69 76 65 20 62 79 74 65 20 6f 72  e native byte or
35720 64 65 72 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  der */.#define S
35730 51 4c 49 54 45 5f 41 4e 59 20 20 20 20 20 20 20  QLITE_ANY       
35740 20 20 20 20 20 35 20 20 20 20 2f 2a 20 44 65 70       5    /* Dep
35750 72 65 63 61 74 65 64 20 2a 2f 0a 23 64 65 66 69  recated */.#defi
35760 6e 65 20 53 51 4c 49 54 45 5f 55 54 46 31 36 5f  ne SQLITE_UTF16_
35770 41 4c 49 47 4e 45 44 20 20 38 20 20 20 20 2f 2a  ALIGNED  8    /*
35780 20 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f   sqlite3_create_
35790 63 6f 6c 6c 61 74 69 6f 6e 20 6f 6e 6c 79 20 2a  collation only *
357a0 2f 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  /../*.** CAPI3RE
357b0 46 3a 20 46 75 6e 63 74 69 6f 6e 20 46 6c 61 67  F: Function Flag
357c0 73 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 63 6f  s.**.** These co
357d0 6e 73 74 61 6e 74 73 20 6d 61 79 20 62 65 20 4f  nstants may be O
357e0 52 65 64 20 74 6f 67 65 74 68 65 72 20 77 69 74  Red together wit
357f0 68 20 74 68 65 20 0a 2a 2a 20 5b 53 51 4c 49 54  h the .** [SQLIT
35800 45 5f 55 54 46 38 20 7c 20 70 72 65 66 65 72 72  E_UTF8 | preferr
35810 65 64 20 74 65 78 74 20 65 6e 63 6f 64 69 6e 67  ed text encoding
35820 5d 20 61 73 20 74 68 65 20 66 6f 75 72 74 68 20  ] as the fourth 
35830 61 72 67 75 6d 65 6e 74 0a 2a 2a 20 74 6f 20 5b  argument.** to [
35840 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 66  sqlite3_create_f
35850 75 6e 63 74 69 6f 6e 28 29 5d 2c 20 5b 73 71 6c  unction()], [sql
35860 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63  ite3_create_func
35870 74 69 6f 6e 31 36 28 29 5d 2c 20 6f 72 0a 2a 2a  tion16()], or.**
35880 20 5b 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65   [sqlite3_create
35890 5f 66 75 6e 63 74 69 6f 6e 5f 76 32 28 29 5d 2e  _function_v2()].
358a0 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  .*/.#define SQLI
358b0 54 45 5f 44 45 54 45 52 4d 49 4e 49 53 54 49 43  TE_DETERMINISTIC
358c0 20 20 20 20 30 78 38 30 30 0a 0a 2f 2a 0a 2a 2a      0x800../*.**
358d0 20 43 41 50 49 33 52 45 46 3a 20 44 65 70 72 65   CAPI3REF: Depre
358e0 63 61 74 65 64 20 46 75 6e 63 74 69 6f 6e 73 0a  cated Functions.
358f0 2a 2a 20 44 45 50 52 45 43 41 54 45 44 0a 2a 2a  ** DEPRECATED.**
35900 0a 2a 2a 20 54 68 65 73 65 20 66 75 6e 63 74 69  .** These functi
35910 6f 6e 73 20 61 72 65 20 5b 64 65 70 72 65 63 61  ons are [depreca
35920 74 65 64 5d 2e 20 20 49 6e 20 6f 72 64 65 72 20  ted].  In order 
35930 74 6f 20 6d 61 69 6e 74 61 69 6e 0a 2a 2a 20 62  to maintain.** b
35940 61 63 6b 77 61 72 64 73 20 63 6f 6d 70 61 74 69  ackwards compati
35950 62 69 6c 69 74 79 20 77 69 74 68 20 6f 6c 64 65  bility with olde
35960 72 20 63 6f 64 65 2c 20 74 68 65 73 65 20 66 75  r code, these fu
35970 6e 63 74 69 6f 6e 73 20 63 6f 6e 74 69 6e 75 65  nctions continue
35980 20 0a 2a 2a 20 74 6f 20 62 65 20 73 75 70 70 6f   .** to be suppo
35990 72 74 65 64 2e 20 20 48 6f 77 65 76 65 72 2c 20  rted.  However, 
359a0 6e 65 77 20 61 70 70 6c 69 63 61 74 69 6f 6e 73  new applications
359b0 20 73 68 6f 75 6c 64 20 61 76 6f 69 64 0a 2a 2a   should avoid.**
359c0 20 74 68 65 20 75 73 65 20 6f 66 20 74 68 65 73   the use of thes
359d0 65 20 66 75 6e 63 74 69 6f 6e 73 2e 20 20 54 6f  e functions.  To
359e0 20 65 6e 63 6f 75 72 61 67 65 20 70 72 6f 67 72   encourage progr
359f0 61 6d 6d 65 72 73 20 74 6f 20 61 76 6f 69 64 0a  ammers to avoid.
35a00 2a 2a 20 74 68 65 73 65 20 66 75 6e 63 74 69 6f  ** these functio
35a10 6e 73 2c 20 77 65 20 77 69 6c 6c 20 6e 6f 74 20  ns, we will not 
35a20 65 78 70 6c 61 69 6e 20 77 68 61 74 20 74 68 65  explain what the
35a30 79 20 64 6f 2e 0a 2a 2f 0a 23 69 66 6e 64 65 66  y do..*/.#ifndef
35a40 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 44 45 50   SQLITE_OMIT_DEP
35a50 52 45 43 41 54 45 44 0a 53 51 4c 49 54 45 5f 44  RECATED.SQLITE_D
35a60 45 50 52 45 43 41 54 45 44 20 69 6e 74 20 73 71  EPRECATED int sq
35a70 6c 69 74 65 33 5f 61 67 67 72 65 67 61 74 65 5f  lite3_aggregate_
35a80 63 6f 75 6e 74 28 73 71 6c 69 74 65 33 5f 63 6f  count(sqlite3_co
35a90 6e 74 65 78 74 2a 29 3b 0a 53 51 4c 49 54 45 5f  ntext*);.SQLITE_
35aa0 44 45 50 52 45 43 41 54 45 44 20 69 6e 74 20 73  DEPRECATED int s
35ab0 71 6c 69 74 65 33 5f 65 78 70 69 72 65 64 28 73  qlite3_expired(s
35ac0 71 6c 69 74 65 33 5f 73 74 6d 74 2a 29 3b 0a 53  qlite3_stmt*);.S
35ad0 51 4c 49 54 45 5f 44 45 50 52 45 43 41 54 45 44  QLITE_DEPRECATED
35ae0 20 69 6e 74 20 73 71 6c 69 74 65 33 5f 74 72 61   int sqlite3_tra
35af0 6e 73 66 65 72 5f 62 69 6e 64 69 6e 67 73 28 73  nsfer_bindings(s
35b00 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 73 71  qlite3_stmt*, sq
35b10 6c 69 74 65 33 5f 73 74 6d 74 2a 29 3b 0a 53 51  lite3_stmt*);.SQ
35b20 4c 49 54 45 5f 44 45 50 52 45 43 41 54 45 44 20  LITE_DEPRECATED 
35b30 69 6e 74 20 73 71 6c 69 74 65 33 5f 67 6c 6f 62  int sqlite3_glob
35b40 61 6c 5f 72 65 63 6f 76 65 72 28 76 6f 69 64 29  al_recover(void)
35b50 3b 0a 53 51 4c 49 54 45 5f 44 45 50 52 45 43 41  ;.SQLITE_DEPRECA
35b60 54 45 44 20 76 6f 69 64 20 73 71 6c 69 74 65 33  TED void sqlite3
35b70 5f 74 68 72 65 61 64 5f 63 6c 65 61 6e 75 70 28  _thread_cleanup(
35b80 76 6f 69 64 29 3b 0a 53 51 4c 49 54 45 5f 44 45  void);.SQLITE_DE
35b90 50 52 45 43 41 54 45 44 20 69 6e 74 20 73 71 6c  PRECATED int sql
35ba0 69 74 65 33 5f 6d 65 6d 6f 72 79 5f 61 6c 61 72  ite3_memory_alar
35bb0 6d 28 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a 2c  m(void(*)(void*,
35bc0 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 2c 69 6e  sqlite3_int64,in
35bd0 74 29 2c 0a 20 20 20 20 20 20 20 20 20 20 20 20  t),.            
35be0 20 20 20 20 20 20 20 20 20 20 76 6f 69 64 2a 2c            void*,
35bf0 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 29 3b 0a  sqlite3_int64);.
35c00 23 65 6e 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 43 41  #endif../*.** CA
35c10 50 49 33 52 45 46 3a 20 4f 62 74 61 69 6e 69 6e  PI3REF: Obtainin
35c20 67 20 53 51 4c 20 56 61 6c 75 65 73 0a 2a 2a 20  g SQL Values.** 
35c30 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f  METHOD: sqlite3_
35c40 76 61 6c 75 65 0a 2a 2a 0a 2a 2a 20 54 68 65 20  value.**.** The 
35c50 43 2d 6c 61 6e 67 75 61 67 65 20 69 6d 70 6c 65  C-language imple
35c60 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20 53 51 4c  mentation of SQL
35c70 20 66 75 6e 63 74 69 6f 6e 73 20 61 6e 64 20 61   functions and a
35c80 67 67 72 65 67 61 74 65 73 20 75 73 65 73 0a 2a  ggregates uses.*
35c90 2a 20 74 68 69 73 20 73 65 74 20 6f 66 20 69 6e  * this set of in
35ca0 74 65 72 66 61 63 65 20 72 6f 75 74 69 6e 65 73  terface routines
35cb0 20 74 6f 20 61 63 63 65 73 73 20 74 68 65 20 70   to access the p
35cc0 61 72 61 6d 65 74 65 72 20 76 61 6c 75 65 73 20  arameter values 
35cd0 6f 6e 0a 2a 2a 20 74 68 65 20 66 75 6e 63 74 69  on.** the functi
35ce0 6f 6e 20 6f 72 20 61 67 67 72 65 67 61 74 65 2e  on or aggregate.
35cf0 20 20 0a 2a 2a 0a 2a 2a 20 54 68 65 20 78 46 75    .**.** The xFu
35d00 6e 63 20 28 66 6f 72 20 73 63 61 6c 61 72 20 66  nc (for scalar f
35d10 75 6e 63 74 69 6f 6e 73 29 20 6f 72 20 78 53 74  unctions) or xSt
35d20 65 70 20 28 66 6f 72 20 61 67 67 72 65 67 61 74  ep (for aggregat
35d30 65 73 29 20 70 61 72 61 6d 65 74 65 72 73 0a 2a  es) parameters.*
35d40 2a 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 63 72  * to [sqlite3_cr
35d50 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 28 29 5d  eate_function()]
35d60 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 63 72   and [sqlite3_cr
35d70 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 31 36 28  eate_function16(
35d80 29 5d 0a 2a 2a 20 64 65 66 69 6e 65 20 63 61 6c  )].** define cal
35d90 6c 62 61 63 6b 73 20 74 68 61 74 20 69 6d 70 6c  lbacks that impl
35da0 65 6d 65 6e 74 20 74 68 65 20 53 51 4c 20 66 75  ement the SQL fu
35db0 6e 63 74 69 6f 6e 73 20 61 6e 64 20 61 67 67 72  nctions and aggr
35dc0 65 67 61 74 65 73 2e 0a 2a 2a 20 54 68 65 20 33  egates..** The 3
35dd0 72 64 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20  rd parameter to 
35de0 74 68 65 73 65 20 63 61 6c 6c 62 61 63 6b 73 20  these callbacks 
35df0 69 73 20 61 6e 20 61 72 72 61 79 20 6f 66 20 70  is an array of p
35e00 6f 69 6e 74 65 72 73 20 74 6f 0a 2a 2a 20 5b 70  ointers to.** [p
35e10 72 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65 33  rotected sqlite3
35e20 5f 76 61 6c 75 65 5d 20 6f 62 6a 65 63 74 73 2e  _value] objects.
35e30 20 20 54 68 65 72 65 20 69 73 20 6f 6e 65 20 5b    There is one [
35e40 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f  sqlite3_value] o
35e50 62 6a 65 63 74 20 66 6f 72 0a 2a 2a 20 65 61 63  bject for.** eac
35e60 68 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 74  h parameter to t
35e70 68 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 2e  he SQL function.
35e80 20 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73    These routines
35e90 20 61 72 65 20 75 73 65 64 20 74 6f 0a 2a 2a 20   are used to.** 
35ea0 65 78 74 72 61 63 74 20 76 61 6c 75 65 73 20 66  extract values f
35eb0 72 6f 6d 20 74 68 65 20 5b 73 71 6c 69 74 65 33  rom the [sqlite3
35ec0 5f 76 61 6c 75 65 5d 20 6f 62 6a 65 63 74 73 2e  _value] objects.
35ed0 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72 6f 75  .**.** These rou
35ee0 74 69 6e 65 73 20 77 6f 72 6b 20 6f 6e 6c 79 20  tines work only 
35ef0 77 69 74 68 20 5b 70 72 6f 74 65 63 74 65 64 20  with [protected 
35f00 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f  sqlite3_value] o
35f10 62 6a 65 63 74 73 2e 0a 2a 2a 20 41 6e 79 20 61  bjects..** Any a
35f20 74 74 65 6d 70 74 20 74 6f 20 75 73 65 20 74 68  ttempt to use th
35f30 65 73 65 20 72 6f 75 74 69 6e 65 73 20 6f 6e 20  ese routines on 
35f40 61 6e 20 5b 75 6e 70 72 6f 74 65 63 74 65 64 20  an [unprotected 
35f50 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 0a 2a  sqlite3_value].*
35f60 2a 20 6f 62 6a 65 63 74 20 72 65 73 75 6c 74 73  * object results
35f70 20 69 6e 20 75 6e 64 65 66 69 6e 65 64 20 62 65   in undefined be
35f80 68 61 76 69 6f 72 2e 0a 2a 2a 0a 2a 2a 20 5e 54  havior..**.** ^T
35f90 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 77 6f  hese routines wo
35fa0 72 6b 20 6a 75 73 74 20 6c 69 6b 65 20 74 68 65  rk just like the
35fb0 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20 5b   corresponding [
35fc0 63 6f 6c 75 6d 6e 20 61 63 63 65 73 73 20 66 75  column access fu
35fd0 6e 63 74 69 6f 6e 73 5d 0a 2a 2a 20 65 78 63 65  nctions].** exce
35fe0 70 74 20 74 68 61 74 20 74 68 65 73 65 20 72 6f  pt that these ro
35ff0 75 74 69 6e 65 73 20 74 61 6b 65 20 61 20 73 69  utines take a si
36000 6e 67 6c 65 20 5b 70 72 6f 74 65 63 74 65 64 20  ngle [protected 
36010 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f  sqlite3_value] o
36020 62 6a 65 63 74 0a 2a 2a 20 70 6f 69 6e 74 65 72  bject.** pointer
36030 20 69 6e 73 74 65 61 64 20 6f 66 20 61 20 5b 73   instead of a [s
36040 71 6c 69 74 65 33 5f 73 74 6d 74 2a 5d 20 70 6f  qlite3_stmt*] po
36050 69 6e 74 65 72 20 61 6e 64 20 61 6e 20 69 6e 74  inter and an int
36060 65 67 65 72 20 63 6f 6c 75 6d 6e 20 6e 75 6d 62  eger column numb
36070 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  er..**.** ^The s
36080 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 65 78  qlite3_value_tex
36090 74 31 36 28 29 20 69 6e 74 65 72 66 61 63 65 20  t16() interface 
360a0 65 78 74 72 61 63 74 73 20 61 20 55 54 46 2d 31  extracts a UTF-1
360b0 36 20 73 74 72 69 6e 67 0a 2a 2a 20 69 6e 20 74  6 string.** in t
360c0 68 65 20 6e 61 74 69 76 65 20 62 79 74 65 2d 6f  he native byte-o
360d0 72 64 65 72 20 6f 66 20 74 68 65 20 68 6f 73 74  rder of the host
360e0 20 6d 61 63 68 69 6e 65 2e 20 20 5e 54 68 65 0a   machine.  ^The.
360f0 2a 2a 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  ** sqlite3_value
36100 5f 74 65 78 74 31 36 62 65 28 29 20 61 6e 64 20  _text16be() and 
36110 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 65  sqlite3_value_te
36120 78 74 31 36 6c 65 28 29 20 69 6e 74 65 72 66 61  xt16le() interfa
36130 63 65 73 0a 2a 2a 20 65 78 74 72 61 63 74 20 55  ces.** extract U
36140 54 46 2d 31 36 20 73 74 72 69 6e 67 73 20 61 73  TF-16 strings as
36150 20 62 69 67 2d 65 6e 64 69 61 6e 20 61 6e 64 20   big-endian and 
36160 6c 69 74 74 6c 65 2d 65 6e 64 69 61 6e 20 72 65  little-endian re
36170 73 70 65 63 74 69 76 65 6c 79 2e 0a 2a 2a 0a 2a  spectively..**.*
36180 2a 20 5e 28 54 68 65 20 73 71 6c 69 74 65 33 5f  * ^(The sqlite3_
36190 76 61 6c 75 65 5f 6e 75 6d 65 72 69 63 5f 74 79  value_numeric_ty
361a0 70 65 28 29 20 69 6e 74 65 72 66 61 63 65 20 61  pe() interface a
361b0 74 74 65 6d 70 74 73 20 74 6f 20 61 70 70 6c 79  ttempts to apply
361c0 0a 2a 2a 20 6e 75 6d 65 72 69 63 20 61 66 66 69  .** numeric affi
361d0 6e 69 74 79 20 74 6f 20 74 68 65 20 76 61 6c 75  nity to the valu
361e0 65 2e 20 20 54 68 69 73 20 6d 65 61 6e 73 20 74  e.  This means t
361f0 68 61 74 20 61 6e 20 61 74 74 65 6d 70 74 20 69  hat an attempt i
36200 73 0a 2a 2a 20 6d 61 64 65 20 74 6f 20 63 6f 6e  s.** made to con
36210 76 65 72 74 20 74 68 65 20 76 61 6c 75 65 20 74  vert the value t
36220 6f 20 61 6e 20 69 6e 74 65 67 65 72 20 6f 72 20  o an integer or 
36230 66 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 2e 20  floating point. 
36240 20 49 66 0a 2a 2a 20 73 75 63 68 20 61 20 63 6f   If.** such a co
36250 6e 76 65 72 73 69 6f 6e 20 69 73 20 70 6f 73 73  nversion is poss
36260 69 62 6c 65 20 77 69 74 68 6f 75 74 20 6c 6f 73  ible without los
36270 73 20 6f 66 20 69 6e 66 6f 72 6d 61 74 69 6f 6e  s of information
36280 20 28 69 6e 20 6f 74 68 65 72 0a 2a 2a 20 77 6f   (in other.** wo
36290 72 64 73 2c 20 69 66 20 74 68 65 20 76 61 6c 75  rds, if the valu
362a0 65 20 69 73 20 61 20 73 74 72 69 6e 67 20 74 68  e is a string th
362b0 61 74 20 6c 6f 6f 6b 73 20 6c 69 6b 65 20 61 20  at looks like a 
362c0 6e 75 6d 62 65 72 29 0a 2a 2a 20 74 68 65 6e 20  number).** then 
362d0 74 68 65 20 63 6f 6e 76 65 72 73 69 6f 6e 20 69  the conversion i
362e0 73 20 70 65 72 66 6f 72 6d 65 64 2e 20 20 4f 74  s performed.  Ot
362f0 68 65 72 77 69 73 65 20 6e 6f 20 63 6f 6e 76 65  herwise no conve
36300 72 73 69 6f 6e 20 6f 63 63 75 72 73 2e 0a 2a 2a  rsion occurs..**
36310 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 49 4e 54   The [SQLITE_INT
36320 45 47 45 52 20 7c 20 64 61 74 61 74 79 70 65 5d  EGER | datatype]
36330 20 61 66 74 65 72 20 63 6f 6e 76 65 72 73 69 6f   after conversio
36340 6e 20 69 73 20 72 65 74 75 72 6e 65 64 2e 29 5e  n is returned.)^
36350 0a 2a 2a 0a 2a 2a 20 50 6c 65 61 73 65 20 70 61  .**.** Please pa
36360 79 20 70 61 72 74 69 63 75 6c 61 72 20 61 74 74  y particular att
36370 65 6e 74 69 6f 6e 20 74 6f 20 74 68 65 20 66 61  ention to the fa
36380 63 74 20 74 68 61 74 20 74 68 65 20 70 6f 69 6e  ct that the poin
36390 74 65 72 20 72 65 74 75 72 6e 65 64 0a 2a 2a 20  ter returned.** 
363a0 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 76 61  from [sqlite3_va
363b0 6c 75 65 5f 62 6c 6f 62 28 29 5d 2c 20 5b 73 71  lue_blob()], [sq
363c0 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 65 78 74  lite3_value_text
363d0 28 29 5d 2c 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69  ()], or.** [sqli
363e0 74 65 33 5f 76 61 6c 75 65 5f 74 65 78 74 31 36  te3_value_text16
363f0 28 29 5d 20 63 61 6e 20 62 65 20 69 6e 76 61 6c  ()] can be inval
36400 69 64 61 74 65 64 20 62 79 20 61 20 73 75 62 73  idated by a subs
36410 65 71 75 65 6e 74 20 63 61 6c 6c 20 74 6f 0a 2a  equent call to.*
36420 2a 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  * [sqlite3_value
36430 5f 62 79 74 65 73 28 29 5d 2c 20 5b 73 71 6c 69  _bytes()], [sqli
36440 74 65 33 5f 76 61 6c 75 65 5f 62 79 74 65 73 31  te3_value_bytes1
36450 36 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 76  6()], [sqlite3_v
36460 61 6c 75 65 5f 74 65 78 74 28 29 5d 2c 0a 2a 2a  alue_text()],.**
36470 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c   or [sqlite3_val
36480 75 65 5f 74 65 78 74 31 36 28 29 5d 2e 0a 2a 2a  ue_text16()]..**
36490 0a 2a 2a 20 54 68 65 73 65 20 72 6f 75 74 69 6e  .** These routin
364a0 65 73 20 6d 75 73 74 20 62 65 20 63 61 6c 6c 65  es must be calle
364b0 64 20 66 72 6f 6d 20 74 68 65 20 73 61 6d 65 20  d from the same 
364c0 74 68 72 65 61 64 20 61 73 0a 2a 2a 20 74 68 65  thread as.** the
364d0 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 74 68   SQL function th
364e0 61 74 20 73 75 70 70 6c 69 65 64 20 74 68 65 20  at supplied the 
364f0 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 5d  [sqlite3_value*]
36500 20 70 61 72 61 6d 65 74 65 72 73 2e 0a 2a 2f 0a   parameters..*/.
36510 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c 69  const void *sqli
36520 74 65 33 5f 76 61 6c 75 65 5f 62 6c 6f 62 28 73  te3_value_blob(s
36530 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a  qlite3_value*);.
36540 69 6e 74 20 73 71 6c 69 74 65 33 5f 76 61 6c 75  int sqlite3_valu
36550 65 5f 62 79 74 65 73 28 73 71 6c 69 74 65 33 5f  e_bytes(sqlite3_
36560 76 61 6c 75 65 2a 29 3b 0a 69 6e 74 20 73 71 6c  value*);.int sql
36570 69 74 65 33 5f 76 61 6c 75 65 5f 62 79 74 65 73  ite3_value_bytes
36580 31 36 28 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  16(sqlite3_value
36590 2a 29 3b 0a 64 6f 75 62 6c 65 20 73 71 6c 69 74  *);.double sqlit
365a0 65 33 5f 76 61 6c 75 65 5f 64 6f 75 62 6c 65 28  e3_value_double(
365b0 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b  sqlite3_value*);
365c0 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 76 61 6c  .int sqlite3_val
365d0 75 65 5f 69 6e 74 28 73 71 6c 69 74 65 33 5f 76  ue_int(sqlite3_v
365e0 61 6c 75 65 2a 29 3b 0a 73 71 6c 69 74 65 33 5f  alue*);.sqlite3_
365f0 69 6e 74 36 34 20 73 71 6c 69 74 65 33 5f 76 61  int64 sqlite3_va
36600 6c 75 65 5f 69 6e 74 36 34 28 73 71 6c 69 74 65  lue_int64(sqlite
36610 33 5f 76 61 6c 75 65 2a 29 3b 0a 63 6f 6e 73 74  3_value*);.const
36620 20 75 6e 73 69 67 6e 65 64 20 63 68 61 72 20 2a   unsigned char *
36630 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 65  sqlite3_value_te
36640 78 74 28 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  xt(sqlite3_value
36650 2a 29 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a  *);.const void *
36660 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 65  sqlite3_value_te
36670 78 74 31 36 28 73 71 6c 69 74 65 33 5f 76 61 6c  xt16(sqlite3_val
36680 75 65 2a 29 3b 0a 63 6f 6e 73 74 20 76 6f 69 64  ue*);.const void
36690 20 2a 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f   *sqlite3_value_
366a0 74 65 78 74 31 36 6c 65 28 73 71 6c 69 74 65 33  text16le(sqlite3
366b0 5f 76 61 6c 75 65 2a 29 3b 0a 63 6f 6e 73 74 20  _value*);.const 
366c0 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 76 61  void *sqlite3_va
366d0 6c 75 65 5f 74 65 78 74 31 36 62 65 28 73 71 6c  lue_text16be(sql
366e0 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 69 6e  ite3_value*);.in
366f0 74 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f  t sqlite3_value_
36700 74 79 70 65 28 73 71 6c 69 74 65 33 5f 76 61 6c  type(sqlite3_val
36710 75 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  ue*);.int sqlite
36720 33 5f 76 61 6c 75 65 5f 6e 75 6d 65 72 69 63 5f  3_value_numeric_
36730 74 79 70 65 28 73 71 6c 69 74 65 33 5f 76 61 6c  type(sqlite3_val
36740 75 65 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  ue*);../*.** CAP
36750 49 33 52 45 46 3a 20 46 69 6e 64 69 6e 67 20 54  I3REF: Finding T
36760 68 65 20 53 75 62 74 79 70 65 20 4f 66 20 53 51  he Subtype Of SQ
36770 4c 20 56 61 6c 75 65 73 0a 2a 2a 20 4d 45 54 48  L Values.** METH
36780 4f 44 3a 20 73 71 6c 69 74 65 33 5f 76 61 6c 75  OD: sqlite3_valu
36790 65 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69  e.**.** The sqli
367a0 74 65 33 5f 76 61 6c 75 65 5f 73 75 62 74 79 70  te3_value_subtyp
367b0 65 28 56 29 20 66 75 6e 63 74 69 6f 6e 20 72 65  e(V) function re
367c0 74 75 72 6e 73 20 74 68 65 20 73 75 62 74 79 70  turns the subtyp
367d0 65 20 66 6f 72 0a 2a 2a 20 61 6e 20 5b 61 70 70  e for.** an [app
367e0 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64  lication-defined
367f0 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 5d 20 61   SQL function] a
36800 72 67 75 6d 65 6e 74 20 56 2e 20 20 54 68 65 20  rgument V.  The 
36810 73 75 62 74 79 70 65 0a 2a 2a 20 69 6e 66 6f 72  subtype.** infor
36820 6d 61 74 69 6f 6e 20 63 61 6e 20 62 65 20 75 73  mation can be us
36830 65 64 20 74 6f 20 70 61 73 73 20 61 20 6c 69 6d  ed to pass a lim
36840 69 74 65 64 20 61 6d 6f 75 6e 74 20 6f 66 20 63  ited amount of c
36850 6f 6e 74 65 78 74 20 66 72 6f 6d 0a 2a 2a 20 6f  ontext from.** o
36860 6e 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20  ne SQL function 
36870 74 6f 20 61 6e 6f 74 68 65 72 2e 20 20 55 73 65  to another.  Use
36880 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 72 65   the [sqlite3_re
36890 73 75 6c 74 5f 73 75 62 74 79 70 65 28 29 5d 0a  sult_subtype()].
368a0 2a 2a 20 72 6f 75 74 69 6e 65 20 74 6f 20 73 65  ** routine to se
368b0 74 20 74 68 65 20 73 75 62 74 79 70 65 20 66 6f  t the subtype fo
368c0 72 20 74 68 65 20 72 65 74 75 72 6e 20 76 61 6c  r the return val
368d0 75 65 20 6f 66 20 61 6e 20 53 51 4c 20 66 75 6e  ue of an SQL fun
368e0 63 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 53 51 4c  ction..**.** SQL
368f0 69 74 65 20 6d 61 6b 65 73 20 6e 6f 20 75 73 65  ite makes no use
36900 20 6f 66 20 73 75 62 74 79 70 65 20 69 74 73 65   of subtype itse
36910 6c 66 2e 20 20 49 74 20 6d 65 72 65 6c 79 20 70  lf.  It merely p
36920 61 73 73 65 73 20 74 68 65 20 73 75 62 74 79 70  asses the subtyp
36930 65 0a 2a 2a 20 66 72 6f 6d 20 74 68 65 20 72 65  e.** from the re
36940 73 75 6c 74 20 6f 66 20 6f 6e 65 20 5b 61 70 70  sult of one [app
36950 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64  lication-defined
36960 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 5d 20 69   SQL function] i
36970 6e 74 6f 20 74 68 65 0a 2a 2a 20 69 6e 70 75 74  nto the.** input
36980 20 6f 66 20 61 6e 6f 74 68 65 72 2e 0a 2a 2f 0a   of another..*/.
36990 75 6e 73 69 67 6e 65 64 20 69 6e 74 20 73 71 6c  unsigned int sql
369a0 69 74 65 33 5f 76 61 6c 75 65 5f 73 75 62 74 79  ite3_value_subty
369b0 70 65 28 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  pe(sqlite3_value
369c0 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  *);../*.** CAPI3
369d0 52 45 46 3a 20 43 6f 70 79 20 41 6e 64 20 46 72  REF: Copy And Fr
369e0 65 65 20 53 51 4c 20 56 61 6c 75 65 73 0a 2a 2a  ee SQL Values.**
369f0 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33   METHOD: sqlite3
36a00 5f 76 61 6c 75 65 0a 2a 2a 0a 2a 2a 20 5e 54 68  _value.**.** ^Th
36a10 65 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f  e sqlite3_value_
36a20 64 75 70 28 56 29 20 69 6e 74 65 72 66 61 63 65  dup(V) interface
36a30 20 6d 61 6b 65 73 20 61 20 63 6f 70 79 20 6f 66   makes a copy of
36a40 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 61   the [sqlite3_va
36a50 6c 75 65 5d 0a 2a 2a 20 6f 62 6a 65 63 74 20 44  lue].** object D
36a60 20 61 6e 64 20 72 65 74 75 72 6e 73 20 61 20 70   and returns a p
36a70 6f 69 6e 74 65 72 20 74 6f 20 74 68 61 74 20 63  ointer to that c
36a80 6f 70 79 2e 20 20 5e 54 68 65 20 5b 73 71 6c 69  opy.  ^The [sqli
36a90 74 65 33 5f 76 61 6c 75 65 5d 20 72 65 74 75 72  te3_value] retur
36aa0 6e 65 64 0a 2a 2a 20 69 73 20 61 20 5b 70 72 6f  ned.** is a [pro
36ab0 74 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76  tected sqlite3_v
36ac0 61 6c 75 65 5d 20 6f 62 6a 65 63 74 20 65 76 65  alue] object eve
36ad0 6e 20 69 66 20 74 68 65 20 69 6e 70 75 74 20 69  n if the input i
36ae0 73 20 6e 6f 74 2e 0a 2a 2a 20 5e 54 68 65 20 73  s not..** ^The s
36af0 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 64 75 70  qlite3_value_dup
36b00 28 56 29 20 69 6e 74 65 72 66 61 63 65 20 72 65  (V) interface re
36b10 74 75 72 6e 73 20 4e 55 4c 4c 20 69 66 20 56 20  turns NULL if V 
36b20 69 73 20 4e 55 4c 4c 20 6f 72 20 69 66 20 61 0a  is NULL or if a.
36b30 2a 2a 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  ** memory alloca
36b40 74 69 6f 6e 20 66 61 69 6c 73 2e 0a 2a 2a 0a 2a  tion fails..**.*
36b50 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 76  * ^The sqlite3_v
36b60 61 6c 75 65 5f 66 72 65 65 28 56 29 20 69 6e 74  alue_free(V) int
36b70 65 72 66 61 63 65 20 66 72 65 65 73 20 61 6e 20  erface frees an 
36b80 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20  [sqlite3_value] 
36b90 6f 62 6a 65 63 74 0a 2a 2a 20 70 72 65 76 69 6f  object.** previo
36ba0 75 73 6c 79 20 6f 62 74 61 69 6e 65 64 20 66 72  usly obtained fr
36bb0 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75  om [sqlite3_valu
36bc0 65 5f 64 75 70 28 29 5d 2e 20 20 5e 49 66 20 56  e_dup()].  ^If V
36bd0 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74   is a NULL point
36be0 65 72 0a 2a 2a 20 74 68 65 6e 20 73 71 6c 69 74  er.** then sqlit
36bf0 65 33 5f 76 61 6c 75 65 5f 66 72 65 65 28 56 29  e3_value_free(V)
36c00 20 69 73 20 61 20 68 61 72 6d 6c 65 73 73 20 6e   is a harmless n
36c10 6f 2d 6f 70 2e 0a 2a 2f 0a 73 71 6c 69 74 65 33  o-op..*/.sqlite3
36c20 5f 76 61 6c 75 65 20 2a 73 71 6c 69 74 65 33 5f  _value *sqlite3_
36c30 76 61 6c 75 65 5f 64 75 70 28 63 6f 6e 73 74 20  value_dup(const 
36c40 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b  sqlite3_value*);
36c50 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 5f 76 61  .void sqlite3_va
36c60 6c 75 65 5f 66 72 65 65 28 73 71 6c 69 74 65 33  lue_free(sqlite3
36c70 5f 76 61 6c 75 65 2a 29 3b 0a 0a 2f 2a 0a 2a 2a  _value*);../*.**
36c80 20 43 41 50 49 33 52 45 46 3a 20 4f 62 74 61 69   CAPI3REF: Obtai
36c90 6e 20 41 67 67 72 65 67 61 74 65 20 46 75 6e 63  n Aggregate Func
36ca0 74 69 6f 6e 20 43 6f 6e 74 65 78 74 0a 2a 2a 20  tion Context.** 
36cb0 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f  METHOD: sqlite3_
36cc0 63 6f 6e 74 65 78 74 0a 2a 2a 0a 2a 2a 20 49 6d  context.**.** Im
36cd0 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20 6f 66  plementations of
36ce0 20 61 67 67 72 65 67 61 74 65 20 53 51 4c 20 66   aggregate SQL f
36cf0 75 6e 63 74 69 6f 6e 73 20 75 73 65 20 74 68 69  unctions use thi
36d00 73 0a 2a 2a 20 72 6f 75 74 69 6e 65 20 74 6f 20  s.** routine to 
36d10 61 6c 6c 6f 63 61 74 65 20 6d 65 6d 6f 72 79 20  allocate memory 
36d20 66 6f 72 20 73 74 6f 72 69 6e 67 20 74 68 65 69  for storing thei
36d30 72 20 73 74 61 74 65 2e 0a 2a 2a 0a 2a 2a 20 5e  r state..**.** ^
36d40 54 68 65 20 66 69 72 73 74 20 74 69 6d 65 20 74  The first time t
36d50 68 65 20 73 71 6c 69 74 65 33 5f 61 67 67 72 65  he sqlite3_aggre
36d60 67 61 74 65 5f 63 6f 6e 74 65 78 74 28 43 2c 4e  gate_context(C,N
36d70 29 20 72 6f 75 74 69 6e 65 20 69 73 20 63 61 6c  ) routine is cal
36d80 6c 65 64 20 0a 2a 2a 20 66 6f 72 20 61 20 70 61  led .** for a pa
36d90 72 74 69 63 75 6c 61 72 20 61 67 67 72 65 67 61  rticular aggrega
36da0 74 65 20 66 75 6e 63 74 69 6f 6e 2c 20 53 51 4c  te function, SQL
36db0 69 74 65 0a 2a 2a 20 61 6c 6c 6f 63 61 74 65 73  ite.** allocates
36dc0 20 4e 20 6f 66 20 6d 65 6d 6f 72 79 2c 20 7a 65   N of memory, ze
36dd0 72 6f 65 73 20 6f 75 74 20 74 68 61 74 20 6d 65  roes out that me
36de0 6d 6f 72 79 2c 20 61 6e 64 20 72 65 74 75 72 6e  mory, and return
36df0 73 20 61 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 74  s a pointer.** t
36e00 6f 20 74 68 65 20 6e 65 77 20 6d 65 6d 6f 72 79  o the new memory
36e10 2e 20 5e 4f 6e 20 73 65 63 6f 6e 64 20 61 6e 64  . ^On second and
36e20 20 73 75 62 73 65 71 75 65 6e 74 20 63 61 6c 6c   subsequent call
36e30 73 20 74 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  s to.** sqlite3_
36e40 61 67 67 72 65 67 61 74 65 5f 63 6f 6e 74 65 78  aggregate_contex
36e50 74 28 29 20 66 6f 72 20 74 68 65 20 73 61 6d 65  t() for the same
36e60 20 61 67 67 72 65 67 61 74 65 20 66 75 6e 63 74   aggregate funct
36e70 69 6f 6e 20 69 6e 73 74 61 6e 63 65 2c 0a 2a 2a  ion instance,.**
36e80 20 74 68 65 20 73 61 6d 65 20 62 75 66 66 65 72   the same buffer
36e90 20 69 73 20 72 65 74 75 72 6e 65 64 2e 20 20 53   is returned.  S
36ea0 71 6c 69 74 65 33 5f 61 67 67 72 65 67 61 74 65  qlite3_aggregate
36eb0 5f 63 6f 6e 74 65 78 74 28 29 20 69 73 20 6e 6f  _context() is no
36ec0 72 6d 61 6c 6c 79 0a 2a 2a 20 63 61 6c 6c 65 64  rmally.** called
36ed0 20 6f 6e 63 65 20 66 6f 72 20 65 61 63 68 20 69   once for each i
36ee0 6e 76 6f 63 61 74 69 6f 6e 20 6f 66 20 74 68 65  nvocation of the
36ef0 20 78 53 74 65 70 20 63 61 6c 6c 62 61 63 6b 20   xStep callback 
36f00 61 6e 64 20 74 68 65 6e 20 6f 6e 65 0a 2a 2a 20  and then one.** 
36f10 6c 61 73 74 20 74 69 6d 65 20 77 68 65 6e 20 74  last time when t
36f20 68 65 20 78 46 69 6e 61 6c 20 63 61 6c 6c 62 61  he xFinal callba
36f30 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 2e 20 20  ck is invoked.  
36f40 5e 28 57 68 65 6e 20 6e 6f 20 72 6f 77 73 20 6d  ^(When no rows m
36f50 61 74 63 68 0a 2a 2a 20 61 6e 20 61 67 67 72 65  atch.** an aggre
36f60 67 61 74 65 20 71 75 65 72 79 2c 20 74 68 65 20  gate query, the 
36f70 78 53 74 65 70 28 29 20 63 61 6c 6c 62 61 63 6b  xStep() callback
36f80 20 6f 66 20 74 68 65 20 61 67 67 72 65 67 61 74   of the aggregat
36f90 65 20 66 75 6e 63 74 69 6f 6e 0a 2a 2a 20 69 6d  e function.** im
36fa0 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 69 73 20  plementation is 
36fb0 6e 65 76 65 72 20 63 61 6c 6c 65 64 20 61 6e 64  never called and
36fc0 20 78 46 69 6e 61 6c 28 29 20 69 73 20 63 61 6c   xFinal() is cal
36fd0 6c 65 64 20 65 78 61 63 74 6c 79 20 6f 6e 63 65  led exactly once
36fe0 2e 0a 2a 2a 20 49 6e 20 74 68 6f 73 65 20 63 61  ..** In those ca
36ff0 73 65 73 2c 20 73 71 6c 69 74 65 33 5f 61 67 67  ses, sqlite3_agg
37000 72 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28 29  regate_context()
37010 20 6d 69 67 68 74 20 62 65 20 63 61 6c 6c 65 64   might be called
37020 20 66 6f 72 20 74 68 65 0a 2a 2a 20 66 69 72 73   for the.** firs
37030 74 20 74 69 6d 65 20 66 72 6f 6d 20 77 69 74 68  t time from with
37040 69 6e 20 78 46 69 6e 61 6c 28 29 2e 29 5e 0a 2a  in xFinal().)^.*
37050 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65  *.** ^The sqlite
37060 33 5f 61 67 67 72 65 67 61 74 65 5f 63 6f 6e 74  3_aggregate_cont
37070 65 78 74 28 43 2c 4e 29 20 72 6f 75 74 69 6e 65  ext(C,N) routine
37080 20 72 65 74 75 72 6e 73 20 61 20 4e 55 4c 4c 20   returns a NULL 
37090 70 6f 69 6e 74 65 72 20 0a 2a 2a 20 77 68 65 6e  pointer .** when
370a0 20 66 69 72 73 74 20 63 61 6c 6c 65 64 20 69 66   first called if
370b0 20 4e 20 69 73 20 6c 65 73 73 20 74 68 61 6e 20   N is less than 
370c0 6f 72 20 65 71 75 61 6c 20 74 6f 20 7a 65 72 6f  or equal to zero
370d0 20 6f 72 20 69 66 20 61 20 6d 65 6d 6f 72 79 0a   or if a memory.
370e0 2a 2a 20 61 6c 6c 6f 63 61 74 65 20 65 72 72 6f  ** allocate erro
370f0 72 20 6f 63 63 75 72 73 2e 0a 2a 2a 0a 2a 2a 20  r occurs..**.** 
37100 5e 28 54 68 65 20 61 6d 6f 75 6e 74 20 6f 66 20  ^(The amount of 
37110 73 70 61 63 65 20 61 6c 6c 6f 63 61 74 65 64 20  space allocated 
37120 62 79 20 73 71 6c 69 74 65 33 5f 61 67 67 72 65  by sqlite3_aggre
37130 67 61 74 65 5f 63 6f 6e 74 65 78 74 28 43 2c 4e  gate_context(C,N
37140 29 20 69 73 0a 2a 2a 20 64 65 74 65 72 6d 69 6e  ) is.** determin
37150 65 64 20 62 79 20 74 68 65 20 4e 20 70 61 72 61  ed by the N para
37160 6d 65 74 65 72 20 6f 6e 20 66 69 72 73 74 20 73  meter on first s
37170 75 63 63 65 73 73 66 75 6c 20 63 61 6c 6c 2e 20  uccessful call. 
37180 20 43 68 61 6e 67 69 6e 67 20 74 68 65 0a 2a 2a   Changing the.**
37190 20 76 61 6c 75 65 20 6f 66 20 4e 20 69 6e 20 73   value of N in s
371a0 75 62 73 65 71 75 65 6e 74 20 63 61 6c 6c 20 74  ubsequent call t
371b0 6f 20 73 71 6c 69 74 65 33 5f 61 67 67 72 65 67  o sqlite3_aggreg
371c0 61 74 65 5f 63 6f 6e 74 65 78 74 28 29 20 77 69  ate_context() wi
371d0 74 68 69 6e 0a 2a 2a 20 74 68 65 20 73 61 6d 65  thin.** the same
371e0 20 61 67 67 72 65 67 61 74 65 20 66 75 6e 63 74   aggregate funct
371f0 69 6f 6e 20 69 6e 73 74 61 6e 63 65 20 77 69 6c  ion instance wil
37200 6c 20 6e 6f 74 20 72 65 73 69 7a 65 20 74 68 65  l not resize the
37210 20 6d 65 6d 6f 72 79 0a 2a 2a 20 61 6c 6c 6f 63   memory.** alloc
37220 61 74 69 6f 6e 2e 29 5e 20 20 57 69 74 68 69 6e  ation.)^  Within
37230 20 74 68 65 20 78 46 69 6e 61 6c 20 63 61 6c 6c   the xFinal call
37240 62 61 63 6b 2c 20 69 74 20 69 73 20 63 75 73 74  back, it is cust
37250 6f 6d 61 72 79 20 74 6f 20 73 65 74 0a 2a 2a 20  omary to set.** 
37260 4e 3d 30 20 69 6e 20 63 61 6c 6c 73 20 74 6f 20  N=0 in calls to 
37270 73 71 6c 69 74 65 33 5f 61 67 67 72 65 67 61 74  sqlite3_aggregat
37280 65 5f 63 6f 6e 74 65 78 74 28 43 2c 4e 29 20 73  e_context(C,N) s
37290 6f 20 74 68 61 74 20 6e 6f 20 0a 2a 2a 20 70 6f  o that no .** po
372a0 69 6e 74 6c 65 73 73 20 6d 65 6d 6f 72 79 20 61  intless memory a
372b0 6c 6c 6f 63 61 74 69 6f 6e 73 20 6f 63 63 75 72  llocations occur
372c0 2e 0a 2a 2a 0a 2a 2a 20 5e 53 51 4c 69 74 65 20  ..**.** ^SQLite 
372d0 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 66 72  automatically fr
372e0 65 65 73 20 74 68 65 20 6d 65 6d 6f 72 79 20 61  ees the memory a
372f0 6c 6c 6f 63 61 74 65 64 20 62 79 20 0a 2a 2a 20  llocated by .** 
37300 73 71 6c 69 74 65 33 5f 61 67 67 72 65 67 61 74  sqlite3_aggregat
37310 65 5f 63 6f 6e 74 65 78 74 28 29 20 77 68 65 6e  e_context() when
37320 20 74 68 65 20 61 67 67 72 65 67 61 74 65 20 71   the aggregate q
37330 75 65 72 79 20 63 6f 6e 63 6c 75 64 65 73 2e 0a  uery concludes..
37340 2a 2a 0a 2a 2a 20 54 68 65 20 66 69 72 73 74 20  **.** The first 
37350 70 61 72 61 6d 65 74 65 72 20 6d 75 73 74 20 62  parameter must b
37360 65 20 61 20 63 6f 70 79 20 6f 66 20 74 68 65 0a  e a copy of the.
37370 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 74  ** [sqlite3_cont
37380 65 78 74 20 7c 20 53 51 4c 20 66 75 6e 63 74 69  ext | SQL functi
37390 6f 6e 20 63 6f 6e 74 65 78 74 5d 20 74 68 61 74  on context] that
373a0 20 69 73 20 74 68 65 20 66 69 72 73 74 20 70 61   is the first pa
373b0 72 61 6d 65 74 65 72 0a 2a 2a 20 74 6f 20 74 68  rameter.** to th
373c0 65 20 78 53 74 65 70 20 6f 72 20 78 46 69 6e 61  e xStep or xFina
373d0 6c 20 63 61 6c 6c 62 61 63 6b 20 72 6f 75 74 69  l callback routi
373e0 6e 65 20 74 68 61 74 20 69 6d 70 6c 65 6d 65 6e  ne that implemen
373f0 74 73 20 74 68 65 20 61 67 67 72 65 67 61 74 65  ts the aggregate
37400 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 2e 0a 2a 2a  .** function..**
37410 0a 2a 2a 20 54 68 69 73 20 72 6f 75 74 69 6e 65  .** This routine
37420 20 6d 75 73 74 20 62 65 20 63 61 6c 6c 65 64 20   must be called 
37430 66 72 6f 6d 20 74 68 65 20 73 61 6d 65 20 74 68  from the same th
37440 72 65 61 64 20 69 6e 20 77 68 69 63 68 0a 2a 2a  read in which.**
37450 20 74 68 65 20 61 67 67 72 65 67 61 74 65 20 53   the aggregate S
37460 51 4c 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 72  QL function is r
37470 75 6e 6e 69 6e 67 2e 0a 2a 2f 0a 76 6f 69 64 20  unning..*/.void 
37480 2a 73 71 6c 69 74 65 33 5f 61 67 67 72 65 67 61  *sqlite3_aggrega
37490 74 65 5f 63 6f 6e 74 65 78 74 28 73 71 6c 69 74  te_context(sqlit
374a0 65 33 5f 63 6f 6e 74 65 78 74 2a 2c 20 69 6e 74  e3_context*, int
374b0 20 6e 42 79 74 65 73 29 3b 0a 0a 2f 2a 0a 2a 2a   nBytes);../*.**
374c0 20 43 41 50 49 33 52 45 46 3a 20 55 73 65 72 20   CAPI3REF: User 
374d0 44 61 74 61 20 46 6f 72 20 46 75 6e 63 74 69 6f  Data For Functio
374e0 6e 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  ns.** METHOD: sq
374f0 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 0a 2a 2a  lite3_context.**
37500 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33  .** ^The sqlite3
37510 5f 75 73 65 72 5f 64 61 74 61 28 29 20 69 6e 74  _user_data() int
37520 65 72 66 61 63 65 20 72 65 74 75 72 6e 73 20 61  erface returns a
37530 20 63 6f 70 79 20 6f 66 0a 2a 2a 20 74 68 65 20   copy of.** the 
37540 70 6f 69 6e 74 65 72 20 74 68 61 74 20 77 61 73  pointer that was
37550 20 74 68 65 20 70 55 73 65 72 44 61 74 61 20 70   the pUserData p
37560 61 72 61 6d 65 74 65 72 20 28 74 68 65 20 35 74  arameter (the 5t
37570 68 20 70 61 72 61 6d 65 74 65 72 29 0a 2a 2a 20  h parameter).** 
37580 6f 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  of the [sqlite3_
37590 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 28  create_function(
375a0 29 5d 0a 2a 2a 20 61 6e 64 20 5b 73 71 6c 69 74  )].** and [sqlit
375b0 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69  e3_create_functi
375c0 6f 6e 31 36 28 29 5d 20 72 6f 75 74 69 6e 65 73  on16()] routines
375d0 20 74 68 61 74 20 6f 72 69 67 69 6e 61 6c 6c 79   that originally
375e0 0a 2a 2a 20 72 65 67 69 73 74 65 72 65 64 20 74  .** registered t
375f0 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 64  he application d
37600 65 66 69 6e 65 64 20 66 75 6e 63 74 69 6f 6e 2e  efined function.
37610 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 72 6f 75 74  .**.** This rout
37620 69 6e 65 20 6d 75 73 74 20 62 65 20 63 61 6c 6c  ine must be call
37630 65 64 20 66 72 6f 6d 20 74 68 65 20 73 61 6d 65  ed from the same
37640 20 74 68 72 65 61 64 20 69 6e 20 77 68 69 63 68   thread in which
37650 0a 2a 2a 20 74 68 65 20 61 70 70 6c 69 63 61 74  .** the applicat
37660 69 6f 6e 2d 64 65 66 69 6e 65 64 20 66 75 6e 63  ion-defined func
37670 74 69 6f 6e 20 69 73 20 72 75 6e 6e 69 6e 67 2e  tion is running.
37680 0a 2a 2f 0a 76 6f 69 64 20 2a 73 71 6c 69 74 65  .*/.void *sqlite
37690 33 5f 75 73 65 72 5f 64 61 74 61 28 73 71 6c 69  3_user_data(sqli
376a0 74 65 33 5f 63 6f 6e 74 65 78 74 2a 29 3b 0a 0a  te3_context*);..
376b0 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
376c0 44 61 74 61 62 61 73 65 20 43 6f 6e 6e 65 63 74  Database Connect
376d0 69 6f 6e 20 46 6f 72 20 46 75 6e 63 74 69 6f 6e  ion For Function
376e0 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c  s.** METHOD: sql
376f0 69 74 65 33 5f 63 6f 6e 74 65 78 74 0a 2a 2a 0a  ite3_context.**.
37700 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  ** ^The sqlite3_
37710 63 6f 6e 74 65 78 74 5f 64 62 5f 68 61 6e 64 6c  context_db_handl
37720 65 28 29 20 69 6e 74 65 72 66 61 63 65 20 72 65  e() interface re
37730 74 75 72 6e 73 20 61 20 63 6f 70 79 20 6f 66 0a  turns a copy of.
37740 2a 2a 20 74 68 65 20 70 6f 69 6e 74 65 72 20 74  ** the pointer t
37750 6f 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20  o the [database 
37760 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 28 74 68 65  connection] (the
37770 20 31 73 74 20 70 61 72 61 6d 65 74 65 72 29 0a   1st parameter).
37780 2a 2a 20 6f 66 20 74 68 65 20 5b 73 71 6c 69 74  ** of the [sqlit
37790 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69  e3_create_functi
377a0 6f 6e 28 29 5d 0a 2a 2a 20 61 6e 64 20 5b 73 71  on()].** and [sq
377b0 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e  lite3_create_fun
377c0 63 74 69 6f 6e 31 36 28 29 5d 20 72 6f 75 74 69  ction16()] routi
377d0 6e 65 73 20 74 68 61 74 20 6f 72 69 67 69 6e 61  nes that origina
377e0 6c 6c 79 0a 2a 2a 20 72 65 67 69 73 74 65 72 65  lly.** registere
377f0 64 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f  d the applicatio
37800 6e 20 64 65 66 69 6e 65 64 20 66 75 6e 63 74 69  n defined functi
37810 6f 6e 2e 0a 2a 2f 0a 73 71 6c 69 74 65 33 20 2a  on..*/.sqlite3 *
37820 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 5f  sqlite3_context_
37830 64 62 5f 68 61 6e 64 6c 65 28 73 71 6c 69 74 65  db_handle(sqlite
37840 33 5f 63 6f 6e 74 65 78 74 2a 29 3b 0a 0a 2f 2a  3_context*);../*
37850 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 46 75  .** CAPI3REF: Fu
37860 6e 63 74 69 6f 6e 20 41 75 78 69 6c 69 61 72 79  nction Auxiliary
37870 20 44 61 74 61 0a 2a 2a 20 4d 45 54 48 4f 44 3a   Data.** METHOD:
37880 20 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74   sqlite3_context
37890 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 66 75 6e  .**.** These fun
378a0 63 74 69 6f 6e 73 20 6d 61 79 20 62 65 20 75 73  ctions may be us
378b0 65 64 20 62 79 20 28 6e 6f 6e 2d 61 67 67 72 65  ed by (non-aggre
378c0 67 61 74 65 29 20 53 51 4c 20 66 75 6e 63 74 69  gate) SQL functi
378d0 6f 6e 73 20 74 6f 0a 2a 2a 20 61 73 73 6f 63 69  ons to.** associ
378e0 61 74 65 20 6d 65 74 61 64 61 74 61 20 77 69 74  ate metadata wit
378f0 68 20 61 72 67 75 6d 65 6e 74 20 76 61 6c 75 65  h argument value
37900 73 2e 20 49 66 20 74 68 65 20 73 61 6d 65 20 76  s. If the same v
37910 61 6c 75 65 20 69 73 20 70 61 73 73 65 64 20 74  alue is passed t
37920 6f 0a 2a 2a 20 6d 75 6c 74 69 70 6c 65 20 69 6e  o.** multiple in
37930 76 6f 63 61 74 69 6f 6e 73 20 6f 66 20 74 68 65  vocations of the
37940 20 73 61 6d 65 20 53 51 4c 20 66 75 6e 63 74 69   same SQL functi
37950 6f 6e 20 64 75 72 69 6e 67 20 71 75 65 72 79 20  on during query 
37960 65 78 65 63 75 74 69 6f 6e 2c 20 75 6e 64 65 72  execution, under
37970 0a 2a 2a 20 73 6f 6d 65 20 63 69 72 63 75 6d 73  .** some circums
37980 74 61 6e 63 65 73 20 74 68 65 20 61 73 73 6f 63  tances the assoc
37990 69 61 74 65 64 20 6d 65 74 61 64 61 74 61 20 6d  iated metadata m
379a0 61 79 20 62 65 20 70 72 65 73 65 72 76 65 64 2e  ay be preserved.
379b0 20 20 41 6e 20 65 78 61 6d 70 6c 65 0a 2a 2a 20    An example.** 
379c0 6f 66 20 77 68 65 72 65 20 74 68 69 73 20 6d 69  of where this mi
379d0 67 68 74 20 62 65 20 75 73 65 66 75 6c 20 69 73  ght be useful is
379e0 20 69 6e 20 61 20 72 65 67 75 6c 61 72 2d 65 78   in a regular-ex
379f0 70 72 65 73 73 69 6f 6e 20 6d 61 74 63 68 69 6e  pression matchin
37a00 67 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 2e 20 54  g.** function. T
37a10 68 65 20 63 6f 6d 70 69 6c 65 64 20 76 65 72 73  he compiled vers
37a20 69 6f 6e 20 6f 66 20 74 68 65 20 72 65 67 75 6c  ion of the regul
37a30 61 72 20 65 78 70 72 65 73 73 69 6f 6e 20 63 61  ar expression ca
37a40 6e 20 62 65 20 73 74 6f 72 65 64 20 61 73 0a 2a  n be stored as.*
37a50 2a 20 6d 65 74 61 64 61 74 61 20 61 73 73 6f 63  * metadata assoc
37a60 69 61 74 65 64 20 77 69 74 68 20 74 68 65 20 70  iated with the p
37a70 61 74 74 65 72 6e 20 73 74 72 69 6e 67 2e 20 20  attern string.  
37a80 0a 2a 2a 20 54 68 65 6e 20 61 73 20 6c 6f 6e 67  .** Then as long
37a90 20 61 73 20 74 68 65 20 70 61 74 74 65 72 6e 20   as the pattern 
37aa0 73 74 72 69 6e 67 20 72 65 6d 61 69 6e 73 20 74  string remains t
37ab0 68 65 20 73 61 6d 65 2c 0a 2a 2a 20 74 68 65 20  he same,.** the 
37ac0 63 6f 6d 70 69 6c 65 64 20 72 65 67 75 6c 61 72  compiled regular
37ad0 20 65 78 70 72 65 73 73 69 6f 6e 20 63 61 6e 20   expression can 
37ae0 62 65 20 72 65 75 73 65 64 20 6f 6e 20 6d 75 6c  be reused on mul
37af0 74 69 70 6c 65 0a 2a 2a 20 69 6e 76 6f 63 61 74  tiple.** invocat
37b00 69 6f 6e 73 20 6f 66 20 74 68 65 20 73 61 6d 65  ions of the same
37b10 20 66 75 6e 63 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a   function..**.**
37b20 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 67 65   ^The sqlite3_ge
37b30 74 5f 61 75 78 64 61 74 61 28 29 20 69 6e 74 65  t_auxdata() inte
37b40 72 66 61 63 65 20 72 65 74 75 72 6e 73 20 61 20  rface returns a 
37b50 70 6f 69 6e 74 65 72 20 74 6f 20 74 68 65 20 6d  pointer to the m
37b60 65 74 61 64 61 74 61 0a 2a 2a 20 61 73 73 6f 63  etadata.** assoc
37b70 69 61 74 65 64 20 62 79 20 74 68 65 20 73 71 6c  iated by the sql
37b80 69 74 65 33 5f 73 65 74 5f 61 75 78 64 61 74 61  ite3_set_auxdata
37b90 28 29 20 66 75 6e 63 74 69 6f 6e 20 77 69 74 68  () function with
37ba0 20 74 68 65 20 4e 74 68 20 61 72 67 75 6d 65 6e   the Nth argumen
37bb0 74 0a 2a 2a 20 76 61 6c 75 65 20 74 6f 20 74 68  t.** value to th
37bc0 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65  e application-de
37bd0 66 69 6e 65 64 20 66 75 6e 63 74 69 6f 6e 2e 20  fined function. 
37be0 5e 49 66 20 74 68 65 72 65 20 69 73 20 6e 6f 20  ^If there is no 
37bf0 6d 65 74 61 64 61 74 61 0a 2a 2a 20 61 73 73 6f  metadata.** asso
37c00 63 69 61 74 65 64 20 77 69 74 68 20 74 68 65 20  ciated with the 
37c10 66 75 6e 63 74 69 6f 6e 20 61 72 67 75 6d 65 6e  function argumen
37c20 74 2c 20 74 68 69 73 20 73 71 6c 69 74 65 33 5f  t, this sqlite3_
37c30 67 65 74 5f 61 75 78 64 61 74 61 28 29 20 69 6e  get_auxdata() in
37c40 74 65 72 66 61 63 65 0a 2a 2a 20 72 65 74 75 72  terface.** retur
37c50 6e 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  ns a NULL pointe
37c60 72 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71  r..**.** ^The sq
37c70 6c 69 74 65 33 5f 73 65 74 5f 61 75 78 64 61 74  lite3_set_auxdat
37c80 61 28 43 2c 4e 2c 50 2c 58 29 20 69 6e 74 65 72  a(C,N,P,X) inter
37c90 66 61 63 65 20 73 61 76 65 73 20 50 20 61 73 20  face saves P as 
37ca0 6d 65 74 61 64 61 74 61 20 66 6f 72 20 74 68 65  metadata for the
37cb0 20 4e 2d 74 68 0a 2a 2a 20 61 72 67 75 6d 65 6e   N-th.** argumen
37cc0 74 20 6f 66 20 74 68 65 20 61 70 70 6c 69 63 61  t of the applica
37cd0 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 66 75 6e  tion-defined fun
37ce0 63 74 69 6f 6e 2e 20 20 5e 53 75 62 73 65 71 75  ction.  ^Subsequ
37cf0 65 6e 74 0a 2a 2a 20 63 61 6c 6c 73 20 74 6f 20  ent.** calls to 
37d00 73 71 6c 69 74 65 33 5f 67 65 74 5f 61 75 78 64  sqlite3_get_auxd
37d10 61 74 61 28 43 2c 4e 29 20 72 65 74 75 72 6e 20  ata(C,N) return 
37d20 50 20 66 72 6f 6d 20 74 68 65 20 6d 6f 73 74 20  P from the most 
37d30 72 65 63 65 6e 74 0a 2a 2a 20 73 71 6c 69 74 65  recent.** sqlite
37d40 33 5f 73 65 74 5f 61 75 78 64 61 74 61 28 43 2c  3_set_auxdata(C,
37d50 4e 2c 50 2c 58 29 20 63 61 6c 6c 20 69 66 20 74  N,P,X) call if t
37d60 68 65 20 6d 65 74 61 64 61 74 61 20 69 73 20 73  he metadata is s
37d70 74 69 6c 6c 20 76 61 6c 69 64 20 6f 72 0a 2a 2a  till valid or.**
37d80 20 4e 55 4c 4c 20 69 66 20 74 68 65 20 6d 65 74   NULL if the met
37d90 61 64 61 74 61 20 68 61 73 20 62 65 65 6e 20 64  adata has been d
37da0 69 73 63 61 72 64 65 64 2e 0a 2a 2a 20 5e 41 66  iscarded..** ^Af
37db0 74 65 72 20 65 61 63 68 20 63 61 6c 6c 20 74 6f  ter each call to
37dc0 20 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78   sqlite3_set_aux
37dd0 64 61 74 61 28 43 2c 4e 2c 50 2c 58 29 20 77 68  data(C,N,P,X) wh
37de0 65 72 65 20 58 20 69 73 20 6e 6f 74 20 4e 55 4c  ere X is not NUL
37df0 4c 2c 0a 2a 2a 20 53 51 4c 69 74 65 20 77 69 6c  L,.** SQLite wil
37e00 6c 20 69 6e 76 6f 6b 65 20 74 68 65 20 64 65 73  l invoke the des
37e10 74 72 75 63 74 6f 72 20 66 75 6e 63 74 69 6f 6e  tructor function
37e20 20 58 20 77 69 74 68 20 70 61 72 61 6d 65 74 65   X with paramete
37e30 72 20 50 20 65 78 61 63 74 6c 79 0a 2a 2a 20 6f  r P exactly.** o
37e40 6e 63 65 2c 20 77 68 65 6e 20 74 68 65 20 6d 65  nce, when the me
37e50 74 61 64 61 74 61 20 69 73 20 64 69 73 63 61 72  tadata is discar
37e60 64 65 64 2e 0a 2a 2a 20 53 51 4c 69 74 65 20 69  ded..** SQLite i
37e70 73 20 66 72 65 65 20 74 6f 20 64 69 73 63 61 72  s free to discar
37e80 64 20 74 68 65 20 6d 65 74 61 64 61 74 61 20 61  d the metadata a
37e90 74 20 61 6e 79 20 74 69 6d 65 2c 20 69 6e 63 6c  t any time, incl
37ea0 75 64 69 6e 67 3a 20 3c 75 6c 3e 0a 2a 2a 20 3c  uding: <ul>.** <
37eb0 6c 69 3e 20 5e 28 77 68 65 6e 20 74 68 65 20 63  li> ^(when the c
37ec0 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20 66 75 6e  orresponding fun
37ed0 63 74 69 6f 6e 20 70 61 72 61 6d 65 74 65 72 20  ction parameter 
37ee0 63 68 61 6e 67 65 73 29 5e 2c 20 6f 72 0a 2a 2a  changes)^, or.**
37ef0 20 3c 6c 69 3e 20 5e 28 77 68 65 6e 20 5b 73 71   <li> ^(when [sq
37f00 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20 6f  lite3_reset()] o
37f10 72 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c  r [sqlite3_final
37f20 69 7a 65 28 29 5d 20 69 73 20 63 61 6c 6c 65 64  ize()] is called
37f30 20 66 6f 72 20 74 68 65 0a 2a 2a 20 20 20 20 20   for the.**     
37f40 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 29 5e   SQL statement)^
37f50 2c 20 6f 72 0a 2a 2a 20 3c 6c 69 3e 20 5e 28 77  , or.** <li> ^(w
37f60 68 65 6e 20 73 71 6c 69 74 65 33 5f 73 65 74 5f  hen sqlite3_set_
37f70 61 75 78 64 61 74 61 28 29 20 69 73 20 69 6e 76  auxdata() is inv
37f80 6f 6b 65 64 20 61 67 61 69 6e 20 6f 6e 20 74 68  oked again on th
37f90 65 20 73 61 6d 65 0a 2a 2a 20 20 20 20 20 20 20  e same.**       
37fa0 70 61 72 61 6d 65 74 65 72 29 5e 2c 20 6f 72 0a  parameter)^, or.
37fb0 2a 2a 20 3c 6c 69 3e 20 5e 28 64 75 72 69 6e 67  ** <li> ^(during
37fc0 20 74 68 65 20 6f 72 69 67 69 6e 61 6c 20 73 71   the original sq
37fd0 6c 69 74 65 33 5f 73 65 74 5f 61 75 78 64 61 74  lite3_set_auxdat
37fe0 61 28 29 20 63 61 6c 6c 20 77 68 65 6e 20 61 20  a() call when a 
37ff0 6d 65 6d 6f 72 79 20 0a 2a 2a 20 20 20 20 20 20  memory .**      
38000 61 6c 6c 6f 63 61 74 69 6f 6e 20 65 72 72 6f 72  allocation error
38010 20 6f 63 63 75 72 73 2e 29 5e 20 3c 2f 75 6c 3e   occurs.)^ </ul>
38020 0a 2a 2a 0a 2a 2a 20 4e 6f 74 65 20 74 68 65 20  .**.** Note the 
38030 6c 61 73 74 20 62 75 6c 6c 65 74 20 69 6e 20 70  last bullet in p
38040 61 72 74 69 63 75 6c 61 72 2e 20 20 54 68 65 20  articular.  The 
38050 64 65 73 74 72 75 63 74 6f 72 20 58 20 69 6e 20  destructor X in 
38060 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 73 65 74 5f  .** sqlite3_set_
38070 61 75 78 64 61 74 61 28 43 2c 4e 2c 50 2c 58 29  auxdata(C,N,P,X)
38080 20 6d 69 67 68 74 20 62 65 20 63 61 6c 6c 65 64   might be called
38090 20 69 6d 6d 65 64 69 61 74 65 6c 79 2c 20 62 65   immediately, be
380a0 66 6f 72 65 20 74 68 65 0a 2a 2a 20 73 71 6c 69  fore the.** sqli
380b0 74 65 33 5f 73 65 74 5f 61 75 78 64 61 74 61 28  te3_set_auxdata(
380c0 29 20 69 6e 74 65 72 66 61 63 65 20 65 76 65 6e  ) interface even
380d0 20 72 65 74 75 72 6e 73 2e 20 20 48 65 6e 63 65   returns.  Hence
380e0 20 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78   sqlite3_set_aux
380f0 64 61 74 61 28 29 0a 2a 2a 20 73 68 6f 75 6c 64  data().** should
38100 20 62 65 20 63 61 6c 6c 65 64 20 6e 65 61 72 20   be called near 
38110 74 68 65 20 65 6e 64 20 6f 66 20 74 68 65 20 66  the end of the f
38120 75 6e 63 74 69 6f 6e 20 69 6d 70 6c 65 6d 65 6e  unction implemen
38130 74 61 74 69 6f 6e 20 61 6e 64 20 74 68 65 0a 2a  tation and the.*
38140 2a 20 66 75 6e 63 74 69 6f 6e 20 69 6d 70 6c 65  * function imple
38150 6d 65 6e 74 61 74 69 6f 6e 20 73 68 6f 75 6c 64  mentation should
38160 20 6e 6f 74 20 6d 61 6b 65 20 61 6e 79 20 75 73   not make any us
38170 65 20 6f 66 20 50 20 61 66 74 65 72 0a 2a 2a 20  e of P after.** 
38180 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78 64  sqlite3_set_auxd
38190 61 74 61 28 29 20 68 61 73 20 62 65 65 6e 20 63  ata() has been c
381a0 61 6c 6c 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 28 49  alled..**.** ^(I
381b0 6e 20 70 72 61 63 74 69 63 65 2c 20 6d 65 74 61  n practice, meta
381c0 64 61 74 61 20 69 73 20 70 72 65 73 65 72 76 65  data is preserve
381d0 64 20 62 65 74 77 65 65 6e 20 66 75 6e 63 74 69  d between functi
381e0 6f 6e 20 63 61 6c 6c 73 20 66 6f 72 0a 2a 2a 20  on calls for.** 
381f0 66 75 6e 63 74 69 6f 6e 20 70 61 72 61 6d 65 74  function paramet
38200 65 72 73 20 74 68 61 74 20 61 72 65 20 63 6f 6d  ers that are com
38210 70 69 6c 65 2d 74 69 6d 65 20 63 6f 6e 73 74 61  pile-time consta
38220 6e 74 73 2c 20 69 6e 63 6c 75 64 69 6e 67 20 6c  nts, including l
38230 69 74 65 72 61 6c 0a 2a 2a 20 76 61 6c 75 65 73  iteral.** values
38240 20 61 6e 64 20 5b 70 61 72 61 6d 65 74 65 72 73   and [parameters
38250 5d 20 61 6e 64 20 65 78 70 72 65 73 73 69 6f 6e  ] and expression
38260 73 20 63 6f 6d 70 6f 73 65 64 20 66 72 6f 6d 20  s composed from 
38270 74 68 65 20 73 61 6d 65 2e 29 5e 0a 2a 2a 0a 2a  the same.)^.**.*
38280 2a 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73  * These routines
38290 20 6d 75 73 74 20 62 65 20 63 61 6c 6c 65 64 20   must be called 
382a0 66 72 6f 6d 20 74 68 65 20 73 61 6d 65 20 74 68  from the same th
382b0 72 65 61 64 20 69 6e 20 77 68 69 63 68 0a 2a 2a  read in which.**
382c0 20 74 68 65 20 53 51 4c 20 66 75 6e 63 74 69 6f   the SQL functio
382d0 6e 20 69 73 20 72 75 6e 6e 69 6e 67 2e 0a 2a 2f  n is running..*/
382e0 0a 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 67  .void *sqlite3_g
382f0 65 74 5f 61 75 78 64 61 74 61 28 73 71 6c 69 74  et_auxdata(sqlit
38300 65 33 5f 63 6f 6e 74 65 78 74 2a 2c 20 69 6e 74  e3_context*, int
38310 20 4e 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65   N);.void sqlite
38320 33 5f 73 65 74 5f 61 75 78 64 61 74 61 28 73 71  3_set_auxdata(sq
38330 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 2c 20  lite3_context*, 
38340 69 6e 74 20 4e 2c 20 76 6f 69 64 2a 2c 20 76 6f  int N, void*, vo
38350 69 64 20 28 2a 29 28 76 6f 69 64 2a 29 29 3b 0a  id (*)(void*));.
38360 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
38370 3a 20 43 6f 6e 73 74 61 6e 74 73 20 44 65 66 69  : Constants Defi
38380 6e 69 6e 67 20 53 70 65 63 69 61 6c 20 44 65 73  ning Special Des
38390 74 72 75 63 74 6f 72 20 42 65 68 61 76 69 6f 72  tructor Behavior
383a0 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 61 72 65  .**.** These are
383b0 20 73 70 65 63 69 61 6c 20 76 61 6c 75 65 73 20   special values 
383c0 66 6f 72 20 74 68 65 20 64 65 73 74 72 75 63 74  for the destruct
383d0 6f 72 20 74 68 61 74 20 69 73 20 70 61 73 73 65  or that is passe
383e0 64 20 69 6e 20 61 73 20 74 68 65 0a 2a 2a 20 66  d in as the.** f
383f0 69 6e 61 6c 20 61 72 67 75 6d 65 6e 74 20 74 6f  inal argument to
38400 20 72 6f 75 74 69 6e 65 73 20 6c 69 6b 65 20 5b   routines like [
38410 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 62  sqlite3_result_b
38420 6c 6f 62 28 29 5d 2e 20 20 5e 49 66 20 74 68 65  lob()].  ^If the
38430 20 64 65 73 74 72 75 63 74 6f 72 0a 2a 2a 20 61   destructor.** a
38440 72 67 75 6d 65 6e 74 20 69 73 20 53 51 4c 49 54  rgument is SQLIT
38450 45 5f 53 54 41 54 49 43 2c 20 69 74 20 6d 65 61  E_STATIC, it mea
38460 6e 73 20 74 68 61 74 20 74 68 65 20 63 6f 6e 74  ns that the cont
38470 65 6e 74 20 70 6f 69 6e 74 65 72 20 69 73 20 63  ent pointer is c
38480 6f 6e 73 74 61 6e 74 0a 2a 2a 20 61 6e 64 20 77  onstant.** and w
38490 69 6c 6c 20 6e 65 76 65 72 20 63 68 61 6e 67 65  ill never change
384a0 2e 20 20 49 74 20 64 6f 65 73 20 6e 6f 74 20 6e  .  It does not n
384b0 65 65 64 20 74 6f 20 62 65 20 64 65 73 74 72 6f  eed to be destro
384c0 79 65 64 2e 20 20 5e 54 68 65 0a 2a 2a 20 53 51  yed.  ^The.** SQ
384d0 4c 49 54 45 5f 54 52 41 4e 53 49 45 4e 54 20 76  LITE_TRANSIENT v
384e0 61 6c 75 65 20 6d 65 61 6e 73 20 74 68 61 74 20  alue means that 
384f0 74 68 65 20 63 6f 6e 74 65 6e 74 20 77 69 6c 6c  the content will
38500 20 6c 69 6b 65 6c 79 20 63 68 61 6e 67 65 20 69   likely change i
38510 6e 0a 2a 2a 20 74 68 65 20 6e 65 61 72 20 66 75  n.** the near fu
38520 74 75 72 65 20 61 6e 64 20 74 68 61 74 20 53 51  ture and that SQ
38530 4c 69 74 65 20 73 68 6f 75 6c 64 20 6d 61 6b 65  Lite should make
38540 20 69 74 73 20 6f 77 6e 20 70 72 69 76 61 74 65   its own private
38550 20 63 6f 70 79 20 6f 66 0a 2a 2a 20 74 68 65 20   copy of.** the 
38560 63 6f 6e 74 65 6e 74 20 62 65 66 6f 72 65 20 72  content before r
38570 65 74 75 72 6e 69 6e 67 2e 0a 2a 2a 0a 2a 2a 20  eturning..**.** 
38580 54 68 65 20 74 79 70 65 64 65 66 20 69 73 20 6e  The typedef is n
38590 65 63 65 73 73 61 72 79 20 74 6f 20 77 6f 72 6b  ecessary to work
385a0 20 61 72 6f 75 6e 64 20 70 72 6f 62 6c 65 6d 73   around problems
385b0 20 69 6e 20 63 65 72 74 61 69 6e 0a 2a 2a 20 43   in certain.** C
385c0 2b 2b 20 63 6f 6d 70 69 6c 65 72 73 2e 0a 2a 2f  ++ compilers..*/
385d0 0a 74 79 70 65 64 65 66 20 76 6f 69 64 20 28 2a  .typedef void (*
385e0 73 71 6c 69 74 65 33 5f 64 65 73 74 72 75 63 74  sqlite3_destruct
385f0 6f 72 5f 74 79 70 65 29 28 76 6f 69 64 2a 29 3b  or_type)(void*);
38600 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
38610 53 54 41 54 49 43 20 20 20 20 20 20 28 28 73 71  STATIC      ((sq
38620 6c 69 74 65 33 5f 64 65 73 74 72 75 63 74 6f 72  lite3_destructor
38630 5f 74 79 70 65 29 30 29 0a 23 64 65 66 69 6e 65  _type)0).#define
38640 20 53 51 4c 49 54 45 5f 54 52 41 4e 53 49 45 4e   SQLITE_TRANSIEN
38650 54 20 20 20 28 28 73 71 6c 69 74 65 33 5f 64 65  T   ((sqlite3_de
38660 73 74 72 75 63 74 6f 72 5f 74 79 70 65 29 2d 31  structor_type)-1
38670 29 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  )../*.** CAPI3RE
38680 46 3a 20 53 65 74 74 69 6e 67 20 54 68 65 20 52  F: Setting The R
38690 65 73 75 6c 74 20 4f 66 20 41 6e 20 53 51 4c 20  esult Of An SQL 
386a0 46 75 6e 63 74 69 6f 6e 0a 2a 2a 20 4d 45 54 48  Function.** METH
386b0 4f 44 3a 20 73 71 6c 69 74 65 33 5f 63 6f 6e 74  OD: sqlite3_cont
386c0 65 78 74 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20  ext.**.** These 
386d0 72 6f 75 74 69 6e 65 73 20 61 72 65 20 75 73 65  routines are use
386e0 64 20 62 79 20 74 68 65 20 78 46 75 6e 63 20 6f  d by the xFunc o
386f0 72 20 78 46 69 6e 61 6c 20 63 61 6c 6c 62 61 63  r xFinal callbac
38700 6b 73 20 74 68 61 74 0a 2a 2a 20 69 6d 70 6c 65  ks that.** imple
38710 6d 65 6e 74 20 53 51 4c 20 66 75 6e 63 74 69 6f  ment SQL functio
38720 6e 73 20 61 6e 64 20 61 67 67 72 65 67 61 74 65  ns and aggregate
38730 73 2e 20 20 53 65 65 0a 2a 2a 20 5b 73 71 6c 69  s.  See.** [sqli
38740 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74  te3_create_funct
38750 69 6f 6e 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69  ion()] and [sqli
38760 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74  te3_create_funct
38770 69 6f 6e 31 36 28 29 5d 0a 2a 2a 20 66 6f 72 20  ion16()].** for 
38780 61 64 64 69 74 69 6f 6e 61 6c 20 69 6e 66 6f 72  additional infor
38790 6d 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 54 68  mation..**.** Th
387a0 65 73 65 20 66 75 6e 63 74 69 6f 6e 73 20 77 6f  ese functions wo
387b0 72 6b 20 76 65 72 79 20 6d 75 63 68 20 6c 69 6b  rk very much lik
387c0 65 20 74 68 65 20 5b 70 61 72 61 6d 65 74 65 72  e the [parameter
387d0 20 62 69 6e 64 69 6e 67 5d 20 66 61 6d 69 6c 79   binding] family
387e0 20 6f 66 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 73   of.** functions
387f0 20 75 73 65 64 20 74 6f 20 62 69 6e 64 20 76 61   used to bind va
38800