/ Hex Artifact Content
Login

Artifact 63774172623fe82336ad0757f373343a87bd0b36:


0000: 2f 2a 0a 2a 2a 20 32 30 30 31 20 53 65 70 74 65  /*.** 2001 Septe
0010: 6d 62 65 72 20 31 35 0a 2a 2a 0a 2a 2a 20 54 68  mber 15.**.** Th
0020: 65 20 61 75 74 68 6f 72 20 64 69 73 63 6c 61 69  e author disclai
0030: 6d 73 20 63 6f 70 79 72 69 67 68 74 20 74 6f 20  ms copyright to 
0040: 74 68 69 73 20 73 6f 75 72 63 65 20 63 6f 64 65  this source code
0050: 2e 20 20 49 6e 20 70 6c 61 63 65 20 6f 66 0a 2a  .  In place of.*
0060: 2a 20 61 20 6c 65 67 61 6c 20 6e 6f 74 69 63 65  * a legal notice
0070: 2c 20 68 65 72 65 20 69 73 20 61 20 62 6c 65 73  , here is a bles
0080: 73 69 6e 67 3a 0a 2a 2a 0a 2a 2a 20 20 20 20 4d  sing:.**.**    M
0090: 61 79 20 79 6f 75 20 64 6f 20 67 6f 6f 64 20 61  ay you do good a
00a0: 6e 64 20 6e 6f 74 20 65 76 69 6c 2e 0a 2a 2a 20  nd not evil..** 
00b0: 20 20 20 4d 61 79 20 79 6f 75 20 66 69 6e 64 20     May you find 
00c0: 66 6f 72 67 69 76 65 6e 65 73 73 20 66 6f 72 20  forgiveness for 
00d0: 79 6f 75 72 73 65 6c 66 20 61 6e 64 20 66 6f 72  yourself and for
00e0: 67 69 76 65 20 6f 74 68 65 72 73 2e 0a 2a 2a 20  give others..** 
00f0: 20 20 20 4d 61 79 20 79 6f 75 20 73 68 61 72 65     May you share
0100: 20 66 72 65 65 6c 79 2c 20 6e 65 76 65 72 20 74   freely, never t
0110: 61 6b 69 6e 67 20 6d 6f 72 65 20 74 68 61 6e 20  aking more than 
0120: 79 6f 75 20 67 69 76 65 2e 0a 2a 2a 0a 2a 2a 2a  you give..**.***
0130: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0140: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0150: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0160: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0170: 2a 2a 2a 2a 2a 2a 0a 2a 2a 20 54 68 69 73 20 68  ******.** This h
0180: 65 61 64 65 72 20 66 69 6c 65 20 64 65 66 69 6e  eader file defin
0190: 65 73 20 74 68 65 20 69 6e 74 65 72 66 61 63 65  es the interface
01a0: 20 74 68 61 74 20 74 68 65 20 53 51 4c 69 74 65   that the SQLite
01b0: 20 6c 69 62 72 61 72 79 0a 2a 2a 20 70 72 65 73   library.** pres
01c0: 65 6e 74 73 20 74 6f 20 63 6c 69 65 6e 74 20 70  ents to client p
01d0: 72 6f 67 72 61 6d 73 2e 20 20 49 66 20 61 20 43  rograms.  If a C
01e0: 2d 66 75 6e 63 74 69 6f 6e 2c 20 73 74 72 75 63  -function, struc
01f0: 74 75 72 65 2c 20 64 61 74 61 74 79 70 65 2c 0a  ture, datatype,.
0200: 2a 2a 20 6f 72 20 63 6f 6e 73 74 61 6e 74 20 64  ** or constant d
0210: 65 66 69 6e 69 74 69 6f 6e 20 64 6f 65 73 20 6e  efinition does n
0220: 6f 74 20 61 70 70 65 61 72 20 69 6e 20 74 68 69  ot appear in thi
0230: 73 20 66 69 6c 65 2c 20 74 68 65 6e 20 69 74 20  s file, then it 
0240: 69 73 0a 2a 2a 20 6e 6f 74 20 61 20 70 75 62 6c  is.** not a publ
0250: 69 73 68 65 64 20 41 50 49 20 6f 66 20 53 51 4c  ished API of SQL
0260: 69 74 65 2c 20 69 73 20 73 75 62 6a 65 63 74 20  ite, is subject 
0270: 74 6f 20 63 68 61 6e 67 65 20 77 69 74 68 6f 75  to change withou
0280: 74 0a 2a 2a 20 6e 6f 74 69 63 65 2c 20 61 6e 64  t.** notice, and
0290: 20 73 68 6f 75 6c 64 20 6e 6f 74 20 62 65 20 72   should not be r
02a0: 65 66 65 72 65 6e 63 65 64 20 62 79 20 70 72 6f  eferenced by pro
02b0: 67 72 61 6d 73 20 74 68 61 74 20 75 73 65 20 53  grams that use S
02c0: 51 4c 69 74 65 2e 0a 2a 2a 0a 2a 2a 20 53 6f 6d  QLite..**.** Som
02d0: 65 20 6f 66 20 74 68 65 20 64 65 66 69 6e 69 74  e of the definit
02e0: 69 6f 6e 73 20 74 68 61 74 20 61 72 65 20 69 6e  ions that are in
02f0: 20 74 68 69 73 20 66 69 6c 65 20 61 72 65 20 6d   this file are m
0300: 61 72 6b 65 64 20 61 73 0a 2a 2a 20 22 65 78 70  arked as.** "exp
0310: 65 72 69 6d 65 6e 74 61 6c 22 2e 20 20 45 78 70  erimental".  Exp
0320: 65 72 69 6d 65 6e 74 61 6c 20 69 6e 74 65 72 66  erimental interf
0330: 61 63 65 73 20 61 72 65 20 6e 6f 72 6d 61 6c 6c  aces are normall
0340: 79 20 6e 65 77 0a 2a 2a 20 66 65 61 74 75 72 65  y new.** feature
0350: 73 20 72 65 63 65 6e 74 6c 79 20 61 64 64 65 64  s recently added
0360: 20 74 6f 20 53 51 4c 69 74 65 2e 20 20 57 65 20   to SQLite.  We 
0370: 64 6f 20 6e 6f 74 20 61 6e 74 69 63 69 70 61 74  do not anticipat
0380: 65 20 63 68 61 6e 67 65 73 0a 2a 2a 20 74 6f 20  e changes.** to 
0390: 65 78 70 65 72 69 6d 65 6e 74 61 6c 20 69 6e 74  experimental int
03a0: 65 72 66 61 63 65 73 20 62 75 74 20 72 65 73 65  erfaces but rese
03b0: 72 76 65 20 74 68 65 20 72 69 67 68 74 20 74 6f  rve the right to
03c0: 20 6d 61 6b 65 20 6d 69 6e 6f 72 20 63 68 61 6e   make minor chan
03d0: 67 65 73 0a 2a 2a 20 69 66 20 65 78 70 65 72 69  ges.** if experi
03e0: 65 6e 63 65 20 66 72 6f 6d 20 75 73 65 20 22 69  ence from use "i
03f0: 6e 20 74 68 65 20 77 69 6c 64 22 20 73 75 67 67  n the wild" sugg
0400: 65 73 74 20 73 75 63 68 20 63 68 61 6e 67 65 73  est such changes
0410: 20 61 72 65 20 70 72 75 64 65 6e 74 2e 0a 2a 2a   are prudent..**
0420: 0a 2a 2a 20 54 68 65 20 6f 66 66 69 63 69 61 6c  .** The official
0430: 20 43 2d 6c 61 6e 67 75 61 67 65 20 41 50 49 20   C-language API 
0440: 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 6f  documentation fo
0450: 72 20 53 51 4c 69 74 65 20 69 73 20 64 65 72 69  r SQLite is deri
0460: 76 65 64 0a 2a 2a 20 66 72 6f 6d 20 63 6f 6d 6d  ved.** from comm
0470: 65 6e 74 73 20 69 6e 20 74 68 69 73 20 66 69 6c  ents in this fil
0480: 65 2e 20 20 54 68 69 73 20 66 69 6c 65 20 69 73  e.  This file is
0490: 20 74 68 65 20 61 75 74 68 6f 72 69 74 61 74 69   the authoritati
04a0: 76 65 20 73 6f 75 72 63 65 0a 2a 2a 20 6f 6e 20  ve source.** on 
04b0: 68 6f 77 20 53 51 4c 69 74 65 20 69 6e 74 65 72  how SQLite inter
04c0: 66 61 63 65 73 20 61 72 65 20 73 75 70 70 6f 73  faces are suppos
04d0: 65 64 20 74 6f 20 6f 70 65 72 61 74 65 2e 0a 2a  ed to operate..*
04e0: 2a 0a 2a 2a 20 54 68 65 20 6e 61 6d 65 20 6f 66  *.** The name of
04f0: 20 74 68 69 73 20 66 69 6c 65 20 75 6e 64 65 72   this file under
0500: 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d   configuration m
0510: 61 6e 61 67 65 6d 65 6e 74 20 69 73 20 22 73 71  anagement is "sq
0520: 6c 69 74 65 2e 68 2e 69 6e 22 2e 0a 2a 2a 20 54  lite.h.in"..** T
0530: 68 65 20 6d 61 6b 65 66 69 6c 65 20 6d 61 6b 65  he makefile make
0540: 73 20 73 6f 6d 65 20 6d 69 6e 6f 72 20 63 68 61  s some minor cha
0550: 6e 67 65 73 20 74 6f 20 74 68 69 73 20 66 69 6c  nges to this fil
0560: 65 20 28 73 75 63 68 20 61 73 20 69 6e 73 65 72  e (such as inser
0570: 74 69 6e 67 0a 2a 2a 20 74 68 65 20 76 65 72 73  ting.** the vers
0580: 69 6f 6e 20 6e 75 6d 62 65 72 29 20 61 6e 64 20  ion number) and 
0590: 63 68 61 6e 67 65 73 20 69 74 73 20 6e 61 6d 65  changes its name
05a0: 20 74 6f 20 22 73 71 6c 69 74 65 33 2e 68 22 20   to "sqlite3.h" 
05b0: 61 73 0a 2a 2a 20 70 61 72 74 20 6f 66 20 74 68  as.** part of th
05c0: 65 20 62 75 69 6c 64 20 70 72 6f 63 65 73 73 2e  e build process.
05d0: 0a 2a 2f 0a 23 69 66 6e 64 65 66 20 53 51 4c 49  .*/.#ifndef SQLI
05e0: 54 45 33 5f 48 0a 23 64 65 66 69 6e 65 20 53 51  TE3_H.#define SQ
05f0: 4c 49 54 45 33 5f 48 0a 23 69 6e 63 6c 75 64 65  LITE3_H.#include
0600: 20 3c 73 74 64 61 72 67 2e 68 3e 20 20 20 20 20   <stdarg.h>     
0610: 2f 2a 20 4e 65 65 64 65 64 20 66 6f 72 20 74 68  /* Needed for th
0620: 65 20 64 65 66 69 6e 69 74 69 6f 6e 20 6f 66 20  e definition of 
0630: 76 61 5f 6c 69 73 74 20 2a 2f 0a 0a 2f 2a 0a 2a  va_list */../*.*
0640: 2a 20 4d 61 6b 65 20 73 75 72 65 20 77 65 20 63  * Make sure we c
0650: 61 6e 20 63 61 6c 6c 20 74 68 69 73 20 73 74 75  an call this stu
0660: 66 66 20 66 72 6f 6d 20 43 2b 2b 2e 0a 2a 2f 0a  ff from C++..*/.
0670: 23 69 66 64 65 66 20 5f 5f 63 70 6c 75 73 70 6c  #ifdef __cpluspl
0680: 75 73 0a 65 78 74 65 72 6e 20 22 43 22 20 7b 0a  us.extern "C" {.
0690: 23 65 6e 64 69 66 0a 0a 0a 2f 2a 0a 2a 2a 20 50  #endif.../*.** P
06a0: 72 6f 76 69 64 65 20 74 68 65 20 61 62 69 6c 69  rovide the abili
06b0: 74 79 20 74 6f 20 6f 76 65 72 72 69 64 65 20 6c  ty to override l
06c0: 69 6e 6b 61 67 65 20 66 65 61 74 75 72 65 73 20  inkage features 
06d0: 6f 66 20 74 68 65 20 69 6e 74 65 72 66 61 63 65  of the interface
06e0: 2e 0a 2a 2f 0a 23 69 66 6e 64 65 66 20 53 51 4c  ..*/.#ifndef SQL
06f0: 49 54 45 5f 45 58 54 45 52 4e 0a 23 20 64 65 66  ITE_EXTERN.# def
0700: 69 6e 65 20 53 51 4c 49 54 45 5f 45 58 54 45 52  ine SQLITE_EXTER
0710: 4e 20 65 78 74 65 72 6e 0a 23 65 6e 64 69 66 0a  N extern.#endif.
0720: 23 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 41  #ifndef SQLITE_A
0730: 50 49 0a 23 20 64 65 66 69 6e 65 20 53 51 4c 49  PI.# define SQLI
0740: 54 45 5f 41 50 49 0a 23 65 6e 64 69 66 0a 23 69  TE_API.#endif.#i
0750: 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 43 44 45  fndef SQLITE_CDE
0760: 43 4c 0a 23 20 64 65 66 69 6e 65 20 53 51 4c 49  CL.# define SQLI
0770: 54 45 5f 43 44 45 43 4c 0a 23 65 6e 64 69 66 0a  TE_CDECL.#endif.
0780: 23 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 53  #ifndef SQLITE_S
0790: 54 44 43 41 4c 4c 0a 23 20 64 65 66 69 6e 65 20  TDCALL.# define 
07a0: 53 51 4c 49 54 45 5f 53 54 44 43 41 4c 4c 0a 23  SQLITE_STDCALL.#
07b0: 65 6e 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 54 68 65  endif../*.** The
07c0: 73 65 20 6e 6f 2d 6f 70 20 6d 61 63 72 6f 73 20  se no-op macros 
07d0: 61 72 65 20 75 73 65 64 20 69 6e 20 66 72 6f 6e  are used in fron
07e0: 74 20 6f 66 20 69 6e 74 65 72 66 61 63 65 73 20  t of interfaces 
07f0: 74 6f 20 6d 61 72 6b 20 74 68 6f 73 65 0a 2a 2a  to mark those.**
0800: 20 69 6e 74 65 72 66 61 63 65 73 20 61 73 20 65   interfaces as e
0810: 69 74 68 65 72 20 64 65 70 72 65 63 61 74 65 64  ither deprecated
0820: 20 6f 72 20 65 78 70 65 72 69 6d 65 6e 74 61 6c   or experimental
0830: 2e 20 20 4e 65 77 20 61 70 70 6c 69 63 61 74 69  .  New applicati
0840: 6f 6e 73 0a 2a 2a 20 73 68 6f 75 6c 64 20 6e 6f  ons.** should no
0850: 74 20 75 73 65 20 64 65 70 72 65 63 61 74 65 64  t use deprecated
0860: 20 69 6e 74 65 72 66 61 63 65 73 20 2d 20 74 68   interfaces - th
0870: 65 79 20 61 72 65 20 73 75 70 70 6f 72 74 65 64  ey are supported
0880: 20 66 6f 72 20 62 61 63 6b 77 61 72 64 73 0a 2a   for backwards.*
0890: 2a 20 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 20  * compatibility 
08a0: 6f 6e 6c 79 2e 20 20 41 70 70 6c 69 63 61 74 69  only.  Applicati
08b0: 6f 6e 20 77 72 69 74 65 72 73 20 73 68 6f 75 6c  on writers shoul
08c0: 64 20 62 65 20 61 77 61 72 65 20 74 68 61 74 0a  d be aware that.
08d0: 2a 2a 20 65 78 70 65 72 69 6d 65 6e 74 61 6c 20  ** experimental 
08e0: 69 6e 74 65 72 66 61 63 65 73 20 61 72 65 20 73  interfaces are s
08f0: 75 62 6a 65 63 74 20 74 6f 20 63 68 61 6e 67 65  ubject to change
0900: 20 69 6e 20 70 6f 69 6e 74 20 72 65 6c 65 61 73   in point releas
0910: 65 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20  es..**.** These 
0920: 6d 61 63 72 6f 73 20 75 73 65 64 20 74 6f 20 72  macros used to r
0930: 65 73 6f 6c 76 65 20 74 6f 20 76 61 72 69 6f 75  esolve to variou
0940: 73 20 6b 69 6e 64 73 20 6f 66 20 63 6f 6d 70 69  s kinds of compi
0950: 6c 65 72 20 6d 61 67 69 63 20 74 68 61 74 0a 2a  ler magic that.*
0960: 2a 20 77 6f 75 6c 64 20 67 65 6e 65 72 61 74 65  * would generate
0970: 20 77 61 72 6e 69 6e 67 20 6d 65 73 73 61 67 65   warning message
0980: 73 20 77 68 65 6e 20 74 68 65 79 20 77 65 72 65  s when they were
0990: 20 75 73 65 64 2e 20 20 42 75 74 20 74 68 61 74   used.  But that
09a0: 0a 2a 2a 20 63 6f 6d 70 69 6c 65 72 20 6d 61 67  .** compiler mag
09b0: 69 63 20 65 6e 64 65 64 20 75 70 20 67 65 6e 65  ic ended up gene
09c0: 72 61 74 69 6e 67 20 73 75 63 68 20 61 20 66 6c  rating such a fl
09d0: 75 72 72 79 20 6f 66 20 62 75 67 20 72 65 70 6f  urry of bug repo
09e0: 72 74 73 0a 2a 2a 20 74 68 61 74 20 77 65 20 68  rts.** that we h
09f0: 61 76 65 20 74 61 6b 65 6e 20 69 74 20 61 6c 6c  ave taken it all
0a00: 20 6f 75 74 20 61 6e 64 20 67 6f 6e 65 20 62 61   out and gone ba
0a10: 63 6b 20 74 6f 20 75 73 69 6e 67 20 73 69 6d 70  ck to using simp
0a20: 6c 65 0a 2a 2a 20 6e 6f 6f 70 20 6d 61 63 72 6f  le.** noop macro
0a30: 73 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  s..*/.#define SQ
0a40: 4c 49 54 45 5f 44 45 50 52 45 43 41 54 45 44 0a  LITE_DEPRECATED.
0a50: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 45  #define SQLITE_E
0a60: 58 50 45 52 49 4d 45 4e 54 41 4c 0a 0a 2f 2a 0a  XPERIMENTAL../*.
0a70: 2a 2a 20 45 6e 73 75 72 65 20 74 68 65 73 65 20  ** Ensure these 
0a80: 73 79 6d 62 6f 6c 73 20 77 65 72 65 20 6e 6f 74  symbols were not
0a90: 20 64 65 66 69 6e 65 64 20 62 79 20 73 6f 6d 65   defined by some
0aa0: 20 70 72 65 76 69 6f 75 73 20 68 65 61 64 65 72   previous header
0ab0: 20 66 69 6c 65 2e 0a 2a 2f 0a 23 69 66 64 65 66   file..*/.#ifdef
0ac0: 20 53 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e 0a   SQLITE_VERSION.
0ad0: 23 20 75 6e 64 65 66 20 53 51 4c 49 54 45 5f 56  # undef SQLITE_V
0ae0: 45 52 53 49 4f 4e 0a 23 65 6e 64 69 66 0a 23 69  ERSION.#endif.#i
0af0: 66 64 65 66 20 53 51 4c 49 54 45 5f 56 45 52 53  fdef SQLITE_VERS
0b00: 49 4f 4e 5f 4e 55 4d 42 45 52 0a 23 20 75 6e 64  ION_NUMBER.# und
0b10: 65 66 20 53 51 4c 49 54 45 5f 56 45 52 53 49 4f  ef SQLITE_VERSIO
0b20: 4e 5f 4e 55 4d 42 45 52 0a 23 65 6e 64 69 66 0a  N_NUMBER.#endif.
0b30: 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
0b40: 20 43 6f 6d 70 69 6c 65 2d 54 69 6d 65 20 4c 69   Compile-Time Li
0b50: 62 72 61 72 79 20 56 65 72 73 69 6f 6e 20 4e 75  brary Version Nu
0b60: 6d 62 65 72 73 0a 2a 2a 0a 2a 2a 20 5e 28 54 68  mbers.**.** ^(Th
0b70: 65 20 5b 53 51 4c 49 54 45 5f 56 45 52 53 49 4f  e [SQLITE_VERSIO
0b80: 4e 5d 20 43 20 70 72 65 70 72 6f 63 65 73 73 6f  N] C preprocesso
0b90: 72 20 6d 61 63 72 6f 20 69 6e 20 74 68 65 20 73  r macro in the s
0ba0: 71 6c 69 74 65 33 2e 68 20 68 65 61 64 65 72 0a  qlite3.h header.
0bb0: 2a 2a 20 65 76 61 6c 75 61 74 65 73 20 74 6f 20  ** evaluates to 
0bc0: 61 20 73 74 72 69 6e 67 20 6c 69 74 65 72 61 6c  a string literal
0bd0: 20 74 68 61 74 20 69 73 20 74 68 65 20 53 51 4c   that is the SQL
0be0: 69 74 65 20 76 65 72 73 69 6f 6e 20 69 6e 20 74  ite version in t
0bf0: 68 65 0a 2a 2a 20 66 6f 72 6d 61 74 20 22 58 2e  he.** format "X.
0c00: 59 2e 5a 22 20 77 68 65 72 65 20 58 20 69 73 20  Y.Z" where X is 
0c10: 74 68 65 20 6d 61 6a 6f 72 20 76 65 72 73 69 6f  the major versio
0c20: 6e 20 6e 75 6d 62 65 72 20 28 61 6c 77 61 79 73  n number (always
0c30: 20 33 20 66 6f 72 0a 2a 2a 20 53 51 4c 69 74 65   3 for.** SQLite
0c40: 33 29 20 61 6e 64 20 59 20 69 73 20 74 68 65 20  3) and Y is the 
0c50: 6d 69 6e 6f 72 20 76 65 72 73 69 6f 6e 20 6e 75  minor version nu
0c60: 6d 62 65 72 20 61 6e 64 20 5a 20 69 73 20 74 68  mber and Z is th
0c70: 65 20 72 65 6c 65 61 73 65 20 6e 75 6d 62 65 72  e release number
0c80: 2e 29 5e 0a 2a 2a 20 5e 28 54 68 65 20 5b 53 51  .)^.** ^(The [SQ
0c90: 4c 49 54 45 5f 56 45 52 53 49 4f 4e 5f 4e 55 4d  LITE_VERSION_NUM
0ca0: 42 45 52 5d 20 43 20 70 72 65 70 72 6f 63 65 73  BER] C preproces
0cb0: 73 6f 72 20 6d 61 63 72 6f 20 72 65 73 6f 6c 76  sor macro resolv
0cc0: 65 73 20 74 6f 20 61 6e 20 69 6e 74 65 67 65 72  es to an integer
0cd0: 0a 2a 2a 20 77 69 74 68 20 74 68 65 20 76 61 6c  .** with the val
0ce0: 75 65 20 28 58 2a 31 30 30 30 30 30 30 20 2b 20  ue (X*1000000 + 
0cf0: 59 2a 31 30 30 30 20 2b 20 5a 29 20 77 68 65 72  Y*1000 + Z) wher
0d00: 65 20 58 2c 20 59 2c 20 61 6e 64 20 5a 20 61 72  e X, Y, and Z ar
0d10: 65 20 74 68 65 20 73 61 6d 65 0a 2a 2a 20 6e 75  e the same.** nu
0d20: 6d 62 65 72 73 20 75 73 65 64 20 69 6e 20 5b 53  mbers used in [S
0d30: 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e 5d 2e 29  QLITE_VERSION].)
0d40: 5e 0a 2a 2a 20 54 68 65 20 53 51 4c 49 54 45 5f  ^.** The SQLITE_
0d50: 56 45 52 53 49 4f 4e 5f 4e 55 4d 42 45 52 20 66  VERSION_NUMBER f
0d60: 6f 72 20 61 6e 79 20 67 69 76 65 6e 20 72 65 6c  or any given rel
0d70: 65 61 73 65 20 6f 66 20 53 51 4c 69 74 65 20 77  ease of SQLite w
0d80: 69 6c 6c 20 61 6c 73 6f 0a 2a 2a 20 62 65 20 6c  ill also.** be l
0d90: 61 72 67 65 72 20 74 68 61 6e 20 74 68 65 20 72  arger than the r
0da0: 65 6c 65 61 73 65 20 66 72 6f 6d 20 77 68 69 63  elease from whic
0db0: 68 20 69 74 20 69 73 20 64 65 72 69 76 65 64 2e  h it is derived.
0dc0: 20 20 45 69 74 68 65 72 20 59 20 77 69 6c 6c 0a    Either Y will.
0dd0: 2a 2a 20 62 65 20 68 65 6c 64 20 63 6f 6e 73 74  ** be held const
0de0: 61 6e 74 20 61 6e 64 20 5a 20 77 69 6c 6c 20 62  ant and Z will b
0df0: 65 20 69 6e 63 72 65 6d 65 6e 74 65 64 20 6f 72  e incremented or
0e00: 20 65 6c 73 65 20 59 20 77 69 6c 6c 20 62 65 20   else Y will be 
0e10: 69 6e 63 72 65 6d 65 6e 74 65 64 0a 2a 2a 20 61  incremented.** a
0e20: 6e 64 20 5a 20 77 69 6c 6c 20 62 65 20 72 65 73  nd Z will be res
0e30: 65 74 20 74 6f 20 7a 65 72 6f 2e 0a 2a 2a 0a 2a  et to zero..**.*
0e40: 2a 20 53 69 6e 63 65 20 76 65 72 73 69 6f 6e 20  * Since version 
0e50: 33 2e 36 2e 31 38 2c 20 53 51 4c 69 74 65 20 73  3.6.18, SQLite s
0e60: 6f 75 72 63 65 20 63 6f 64 65 20 68 61 73 20 62  ource code has b
0e70: 65 65 6e 20 73 74 6f 72 65 64 20 69 6e 20 74 68  een stored in th
0e80: 65 0a 2a 2a 20 3c 61 20 68 72 65 66 3d 22 68 74  e.** <a href="ht
0e90: 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d  tp://www.fossil-
0ea0: 73 63 6d 2e 6f 72 67 2f 22 3e 46 6f 73 73 69 6c  scm.org/">Fossil
0eb0: 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d   configuration m
0ec0: 61 6e 61 67 65 6d 65 6e 74 0a 2a 2a 20 73 79 73  anagement.** sys
0ed0: 74 65 6d 3c 2f 61 3e 2e 20 20 5e 54 68 65 20 53  tem</a>.  ^The S
0ee0: 51 4c 49 54 45 5f 53 4f 55 52 43 45 5f 49 44 20  QLITE_SOURCE_ID 
0ef0: 6d 61 63 72 6f 20 65 76 61 6c 75 61 74 65 73 20  macro evaluates 
0f00: 74 6f 0a 2a 2a 20 61 20 73 74 72 69 6e 67 20 77  to.** a string w
0f10: 68 69 63 68 20 69 64 65 6e 74 69 66 69 65 73 20  hich identifies 
0f20: 61 20 70 61 72 74 69 63 75 6c 61 72 20 63 68 65  a particular che
0f30: 63 6b 2d 69 6e 20 6f 66 20 53 51 4c 69 74 65 0a  ck-in of SQLite.
0f40: 2a 2a 20 77 69 74 68 69 6e 20 69 74 73 20 63 6f  ** within its co
0f50: 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d 61 6e 61  nfiguration mana
0f60: 67 65 6d 65 6e 74 20 73 79 73 74 65 6d 2e 20 20  gement system.  
0f70: 5e 54 68 65 20 53 51 4c 49 54 45 5f 53 4f 55 52  ^The SQLITE_SOUR
0f80: 43 45 5f 49 44 0a 2a 2a 20 73 74 72 69 6e 67 20  CE_ID.** string 
0f90: 63 6f 6e 74 61 69 6e 73 20 74 68 65 20 64 61 74  contains the dat
0fa0: 65 20 61 6e 64 20 74 69 6d 65 20 6f 66 20 74 68  e and time of th
0fb0: 65 20 63 68 65 63 6b 2d 69 6e 20 28 55 54 43 29  e check-in (UTC)
0fc0: 20 61 6e 64 20 61 6e 20 53 48 41 31 0a 2a 2a 20   and an SHA1.** 
0fd0: 68 61 73 68 20 6f 66 20 74 68 65 20 65 6e 74 69  hash of the enti
0fe0: 72 65 20 73 6f 75 72 63 65 20 74 72 65 65 2e 0a  re source tree..
0ff0: 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 3a 20  **.** See also: 
1000: 5b 73 71 6c 69 74 65 33 5f 6c 69 62 76 65 72 73  [sqlite3_libvers
1010: 69 6f 6e 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69  ion()],.** [sqli
1020: 74 65 33 5f 6c 69 62 76 65 72 73 69 6f 6e 5f 6e  te3_libversion_n
1030: 75 6d 62 65 72 28 29 5d 2c 20 5b 73 71 6c 69 74  umber()], [sqlit
1040: 65 33 5f 73 6f 75 72 63 65 69 64 28 29 5d 2c 0a  e3_sourceid()],.
1050: 2a 2a 20 5b 73 71 6c 69 74 65 5f 76 65 72 73 69  ** [sqlite_versi
1060: 6f 6e 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74  on()] and [sqlit
1070: 65 5f 73 6f 75 72 63 65 5f 69 64 28 29 5d 2e 0a  e_source_id()]..
1080: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
1090: 45 5f 56 45 52 53 49 4f 4e 20 20 20 20 20 20 20  E_VERSION       
10a0: 20 22 2d 2d 56 45 52 53 2d 2d 22 0a 23 64 65 66   "--VERS--".#def
10b0: 69 6e 65 20 53 51 4c 49 54 45 5f 56 45 52 53 49  ine SQLITE_VERSI
10c0: 4f 4e 5f 4e 55 4d 42 45 52 20 2d 2d 56 45 52 53  ON_NUMBER --VERS
10d0: 49 4f 4e 2d 4e 55 4d 42 45 52 2d 2d 0a 23 64 65  ION-NUMBER--.#de
10e0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 53 4f 55 52  fine SQLITE_SOUR
10f0: 43 45 5f 49 44 20 20 20 20 20 20 22 2d 2d 53 4f  CE_ID      "--SO
1100: 55 52 43 45 2d 49 44 2d 2d 22 0a 0a 2f 2a 0a 2a  URCE-ID--"../*.*
1110: 2a 20 43 41 50 49 33 52 45 46 3a 20 52 75 6e 2d  * CAPI3REF: Run-
1120: 54 69 6d 65 20 4c 69 62 72 61 72 79 20 56 65 72  Time Library Ver
1130: 73 69 6f 6e 20 4e 75 6d 62 65 72 73 0a 2a 2a 20  sion Numbers.** 
1140: 4b 45 59 57 4f 52 44 53 3a 20 73 71 6c 69 74 65  KEYWORDS: sqlite
1150: 33 5f 76 65 72 73 69 6f 6e 2c 20 73 71 6c 69 74  3_version, sqlit
1160: 65 33 5f 73 6f 75 72 63 65 69 64 0a 2a 2a 0a 2a  e3_sourceid.**.*
1170: 2a 20 54 68 65 73 65 20 69 6e 74 65 72 66 61 63  * These interfac
1180: 65 73 20 70 72 6f 76 69 64 65 20 74 68 65 20 73  es provide the s
1190: 61 6d 65 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20  ame information 
11a0: 61 73 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 56  as the [SQLITE_V
11b0: 45 52 53 49 4f 4e 5d 2c 0a 2a 2a 20 5b 53 51 4c  ERSION],.** [SQL
11c0: 49 54 45 5f 56 45 52 53 49 4f 4e 5f 4e 55 4d 42  ITE_VERSION_NUMB
11d0: 45 52 5d 2c 20 61 6e 64 20 5b 53 51 4c 49 54 45  ER], and [SQLITE
11e0: 5f 53 4f 55 52 43 45 5f 49 44 5d 20 43 20 70 72  _SOURCE_ID] C pr
11f0: 65 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f  eprocessor macro
1200: 73 0a 2a 2a 20 62 75 74 20 61 72 65 20 61 73 73  s.** but are ass
1210: 6f 63 69 61 74 65 64 20 77 69 74 68 20 74 68 65  ociated with the
1220: 20 6c 69 62 72 61 72 79 20 69 6e 73 74 65 61 64   library instead
1230: 20 6f 66 20 74 68 65 20 68 65 61 64 65 72 20 66   of the header f
1240: 69 6c 65 2e 20 20 5e 28 43 61 75 74 69 6f 75 73  ile.  ^(Cautious
1250: 0a 2a 2a 20 70 72 6f 67 72 61 6d 6d 65 72 73 20  .** programmers 
1260: 6d 69 67 68 74 20 69 6e 63 6c 75 64 65 20 61 73  might include as
1270: 73 65 72 74 28 29 20 73 74 61 74 65 6d 65 6e 74  sert() statement
1280: 73 20 69 6e 20 74 68 65 69 72 20 61 70 70 6c 69  s in their appli
1290: 63 61 74 69 6f 6e 20 74 6f 0a 2a 2a 20 76 65 72  cation to.** ver
12a0: 69 66 79 20 74 68 61 74 20 76 61 6c 75 65 73 20  ify that values 
12b0: 72 65 74 75 72 6e 65 64 20 62 79 20 74 68 65 73  returned by thes
12c0: 65 20 69 6e 74 65 72 66 61 63 65 73 20 6d 61 74  e interfaces mat
12d0: 63 68 20 74 68 65 20 6d 61 63 72 6f 73 20 69 6e  ch the macros in
12e0: 0a 2a 2a 20 74 68 65 20 68 65 61 64 65 72 2c 20  .** the header, 
12f0: 61 6e 64 20 74 68 75 73 20 65 6e 73 75 72 65 20  and thus ensure 
1300: 74 68 61 74 20 74 68 65 20 61 70 70 6c 69 63 61  that the applica
1310: 74 69 6f 6e 20 69 73 0a 2a 2a 20 63 6f 6d 70 69  tion is.** compi
1320: 6c 65 64 20 77 69 74 68 20 6d 61 74 63 68 69 6e  led with matchin
1330: 67 20 6c 69 62 72 61 72 79 20 61 6e 64 20 68 65  g library and he
1340: 61 64 65 72 20 66 69 6c 65 73 2e 0a 2a 2a 0a 2a  ader files..**.*
1350: 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70  * <blockquote><p
1360: 72 65 3e 0a 2a 2a 20 61 73 73 65 72 74 28 20 73  re>.** assert( s
1370: 71 6c 69 74 65 33 5f 6c 69 62 76 65 72 73 69 6f  qlite3_libversio
1380: 6e 5f 6e 75 6d 62 65 72 28 29 3d 3d 53 51 4c 49  n_number()==SQLI
1390: 54 45 5f 56 45 52 53 49 4f 4e 5f 4e 55 4d 42 45  TE_VERSION_NUMBE
13a0: 52 20 29 3b 0a 2a 2a 20 61 73 73 65 72 74 28 20  R );.** assert( 
13b0: 73 74 72 63 6d 70 28 73 71 6c 69 74 65 33 5f 73  strcmp(sqlite3_s
13c0: 6f 75 72 63 65 69 64 28 29 2c 53 51 4c 49 54 45  ourceid(),SQLITE
13d0: 5f 53 4f 55 52 43 45 5f 49 44 29 3d 3d 30 20 29  _SOURCE_ID)==0 )
13e0: 3b 0a 2a 2a 20 61 73 73 65 72 74 28 20 73 74 72  ;.** assert( str
13f0: 63 6d 70 28 73 71 6c 69 74 65 33 5f 6c 69 62 76  cmp(sqlite3_libv
1400: 65 72 73 69 6f 6e 28 29 2c 53 51 4c 49 54 45 5f  ersion(),SQLITE_
1410: 56 45 52 53 49 4f 4e 29 3d 3d 30 20 29 3b 0a 2a  VERSION)==0 );.*
1420: 2a 20 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71  * </pre></blockq
1430: 75 6f 74 65 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 54  uote>)^.**.** ^T
1440: 68 65 20 73 71 6c 69 74 65 33 5f 76 65 72 73 69  he sqlite3_versi
1450: 6f 6e 5b 5d 20 73 74 72 69 6e 67 20 63 6f 6e 73  on[] string cons
1460: 74 61 6e 74 20 63 6f 6e 74 61 69 6e 73 20 74 68  tant contains th
1470: 65 20 74 65 78 74 20 6f 66 20 5b 53 51 4c 49 54  e text of [SQLIT
1480: 45 5f 56 45 52 53 49 4f 4e 5d 0a 2a 2a 20 6d 61  E_VERSION].** ma
1490: 63 72 6f 2e 20 20 5e 54 68 65 20 73 71 6c 69 74  cro.  ^The sqlit
14a0: 65 33 5f 6c 69 62 76 65 72 73 69 6f 6e 28 29 20  e3_libversion() 
14b0: 66 75 6e 63 74 69 6f 6e 20 72 65 74 75 72 6e 73  function returns
14c0: 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68   a pointer to th
14d0: 65 0a 2a 2a 20 74 6f 20 74 68 65 20 73 71 6c 69  e.** to the sqli
14e0: 74 65 33 5f 76 65 72 73 69 6f 6e 5b 5d 20 73 74  te3_version[] st
14f0: 72 69 6e 67 20 63 6f 6e 73 74 61 6e 74 2e 20 20  ring constant.  
1500: 54 68 65 20 73 71 6c 69 74 65 33 5f 6c 69 62 76  The sqlite3_libv
1510: 65 72 73 69 6f 6e 28 29 0a 2a 2a 20 66 75 6e 63  ersion().** func
1520: 74 69 6f 6e 20 69 73 20 70 72 6f 76 69 64 65 64  tion is provided
1530: 20 66 6f 72 20 75 73 65 20 69 6e 20 44 4c 4c 73   for use in DLLs
1540: 20 73 69 6e 63 65 20 44 4c 4c 20 75 73 65 72 73   since DLL users
1550: 20 75 73 75 61 6c 6c 79 20 64 6f 20 6e 6f 74 20   usually do not 
1560: 68 61 76 65 0a 2a 2a 20 64 69 72 65 63 74 20 61  have.** direct a
1570: 63 63 65 73 73 20 74 6f 20 73 74 72 69 6e 67 20  ccess to string 
1580: 63 6f 6e 73 74 61 6e 74 73 20 77 69 74 68 69 6e  constants within
1590: 20 74 68 65 20 44 4c 4c 2e 20 20 5e 54 68 65 0a   the DLL.  ^The.
15a0: 2a 2a 20 73 71 6c 69 74 65 33 5f 6c 69 62 76 65  ** sqlite3_libve
15b0: 72 73 69 6f 6e 5f 6e 75 6d 62 65 72 28 29 20 66  rsion_number() f
15c0: 75 6e 63 74 69 6f 6e 20 72 65 74 75 72 6e 73 20  unction returns 
15d0: 61 6e 20 69 6e 74 65 67 65 72 20 65 71 75 61 6c  an integer equal
15e0: 20 74 6f 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 56   to.** [SQLITE_V
15f0: 45 52 53 49 4f 4e 5f 4e 55 4d 42 45 52 5d 2e 20  ERSION_NUMBER]. 
1600: 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 73 6f   ^The sqlite3_so
1610: 75 72 63 65 69 64 28 29 20 66 75 6e 63 74 69 6f  urceid() functio
1620: 6e 20 72 65 74 75 72 6e 73 20 0a 2a 2a 20 61 20  n returns .** a 
1630: 70 6f 69 6e 74 65 72 20 74 6f 20 61 20 73 74 72  pointer to a str
1640: 69 6e 67 20 63 6f 6e 73 74 61 6e 74 20 77 68 6f  ing constant who
1650: 73 65 20 76 61 6c 75 65 20 69 73 20 74 68 65 20  se value is the 
1660: 73 61 6d 65 20 61 73 20 74 68 65 20 0a 2a 2a 20  same as the .** 
1670: 5b 53 51 4c 49 54 45 5f 53 4f 55 52 43 45 5f 49  [SQLITE_SOURCE_I
1680: 44 5d 20 43 20 70 72 65 70 72 6f 63 65 73 73 6f  D] C preprocesso
1690: 72 20 6d 61 63 72 6f 2e 0a 2a 2a 0a 2a 2a 20 53  r macro..**.** S
16a0: 65 65 20 61 6c 73 6f 3a 20 5b 73 71 6c 69 74 65  ee also: [sqlite
16b0: 5f 76 65 72 73 69 6f 6e 28 29 5d 20 61 6e 64 20  _version()] and 
16c0: 5b 73 71 6c 69 74 65 5f 73 6f 75 72 63 65 5f 69  [sqlite_source_i
16d0: 64 28 29 5d 2e 0a 2a 2f 0a 53 51 4c 49 54 45 5f  d()]..*/.SQLITE_
16e0: 45 58 54 45 52 4e 20 63 6f 6e 73 74 20 63 68 61  EXTERN const cha
16f0: 72 20 73 71 6c 69 74 65 33 5f 76 65 72 73 69 6f  r sqlite3_versio
1700: 6e 5b 5d 3b 0a 63 6f 6e 73 74 20 63 68 61 72 20  n[];.const char 
1710: 2a 73 71 6c 69 74 65 33 5f 6c 69 62 76 65 72 73  *sqlite3_libvers
1720: 69 6f 6e 28 76 6f 69 64 29 3b 0a 63 6f 6e 73 74  ion(void);.const
1730: 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 73   char *sqlite3_s
1740: 6f 75 72 63 65 69 64 28 76 6f 69 64 29 3b 0a 69  ourceid(void);.i
1750: 6e 74 20 73 71 6c 69 74 65 33 5f 6c 69 62 76 65  nt sqlite3_libve
1760: 72 73 69 6f 6e 5f 6e 75 6d 62 65 72 28 76 6f 69  rsion_number(voi
1770: 64 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  d);../*.** CAPI3
1780: 52 45 46 3a 20 52 75 6e 2d 54 69 6d 65 20 4c 69  REF: Run-Time Li
1790: 62 72 61 72 79 20 43 6f 6d 70 69 6c 61 74 69 6f  brary Compilatio
17a0: 6e 20 4f 70 74 69 6f 6e 73 20 44 69 61 67 6e 6f  n Options Diagno
17b0: 73 74 69 63 73 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  stics.**.** ^The
17c0: 20 73 71 6c 69 74 65 33 5f 63 6f 6d 70 69 6c 65   sqlite3_compile
17d0: 6f 70 74 69 6f 6e 5f 75 73 65 64 28 29 20 66 75  option_used() fu
17e0: 6e 63 74 69 6f 6e 20 72 65 74 75 72 6e 73 20 30  nction returns 0
17f0: 20 6f 72 20 31 20 0a 2a 2a 20 69 6e 64 69 63 61   or 1 .** indica
1800: 74 69 6e 67 20 77 68 65 74 68 65 72 20 74 68 65  ting whether the
1810: 20 73 70 65 63 69 66 69 65 64 20 6f 70 74 69 6f   specified optio
1820: 6e 20 77 61 73 20 64 65 66 69 6e 65 64 20 61 74  n was defined at
1830: 20 0a 2a 2a 20 63 6f 6d 70 69 6c 65 20 74 69 6d   .** compile tim
1840: 65 2e 20 20 5e 54 68 65 20 53 51 4c 49 54 45 5f  e.  ^The SQLITE_
1850: 20 70 72 65 66 69 78 20 6d 61 79 20 62 65 20 6f   prefix may be o
1860: 6d 69 74 74 65 64 20 66 72 6f 6d 20 74 68 65 20  mitted from the 
1870: 0a 2a 2a 20 6f 70 74 69 6f 6e 20 6e 61 6d 65 20  .** option name 
1880: 70 61 73 73 65 64 20 74 6f 20 73 71 6c 69 74 65  passed to sqlite
1890: 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f  3_compileoption_
18a0: 75 73 65 64 28 29 2e 20 20 0a 2a 2a 0a 2a 2a 20  used().  .**.** 
18b0: 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 63 6f 6d  ^The sqlite3_com
18c0: 70 69 6c 65 6f 70 74 69 6f 6e 5f 67 65 74 28 29  pileoption_get()
18d0: 20 66 75 6e 63 74 69 6f 6e 20 61 6c 6c 6f 77 73   function allows
18e0: 20 69 74 65 72 61 74 69 6e 67 0a 2a 2a 20 6f 76   iterating.** ov
18f0: 65 72 20 74 68 65 20 6c 69 73 74 20 6f 66 20 6f  er the list of o
1900: 70 74 69 6f 6e 73 20 74 68 61 74 20 77 65 72 65  ptions that were
1910: 20 64 65 66 69 6e 65 64 20 61 74 20 63 6f 6d 70   defined at comp
1920: 69 6c 65 20 74 69 6d 65 20 62 79 0a 2a 2a 20 72  ile time by.** r
1930: 65 74 75 72 6e 69 6e 67 20 74 68 65 20 4e 2d 74  eturning the N-t
1940: 68 20 63 6f 6d 70 69 6c 65 20 74 69 6d 65 20 6f  h compile time o
1950: 70 74 69 6f 6e 20 73 74 72 69 6e 67 2e 20 20 5e  ption string.  ^
1960: 49 66 20 4e 20 69 73 20 6f 75 74 20 6f 66 20 72  If N is out of r
1970: 61 6e 67 65 2c 0a 2a 2a 20 73 71 6c 69 74 65 33  ange,.** sqlite3
1980: 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 67  _compileoption_g
1990: 65 74 28 29 20 72 65 74 75 72 6e 73 20 61 20 4e  et() returns a N
19a0: 55 4c 4c 20 70 6f 69 6e 74 65 72 2e 20 20 5e 54  ULL pointer.  ^T
19b0: 68 65 20 53 51 4c 49 54 45 5f 20 0a 2a 2a 20 70  he SQLITE_ .** p
19c0: 72 65 66 69 78 20 69 73 20 6f 6d 69 74 74 65 64  refix is omitted
19d0: 20 66 72 6f 6d 20 61 6e 79 20 73 74 72 69 6e 67   from any string
19e0: 73 20 72 65 74 75 72 6e 65 64 20 62 79 20 0a 2a  s returned by .*
19f0: 2a 20 73 71 6c 69 74 65 33 5f 63 6f 6d 70 69 6c  * sqlite3_compil
1a00: 65 6f 70 74 69 6f 6e 5f 67 65 74 28 29 2e 0a 2a  eoption_get()..*
1a10: 2a 0a 2a 2a 20 5e 53 75 70 70 6f 72 74 20 66 6f  *.** ^Support fo
1a20: 72 20 74 68 65 20 64 69 61 67 6e 6f 73 74 69 63  r the diagnostic
1a30: 20 66 75 6e 63 74 69 6f 6e 73 20 73 71 6c 69 74   functions sqlit
1a40: 65 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e  e3_compileoption
1a50: 5f 75 73 65 64 28 29 0a 2a 2a 20 61 6e 64 20 73  _used().** and s
1a60: 71 6c 69 74 65 33 5f 63 6f 6d 70 69 6c 65 6f 70  qlite3_compileop
1a70: 74 69 6f 6e 5f 67 65 74 28 29 20 6d 61 79 20 62  tion_get() may b
1a80: 65 20 6f 6d 69 74 74 65 64 20 62 79 20 73 70 65  e omitted by spe
1a90: 63 69 66 79 69 6e 67 20 74 68 65 20 0a 2a 2a 20  cifying the .** 
1aa0: 5b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 43 4f 4d  [SQLITE_OMIT_COM
1ab0: 50 49 4c 45 4f 50 54 49 4f 4e 5f 44 49 41 47 53  PILEOPTION_DIAGS
1ac0: 5d 20 6f 70 74 69 6f 6e 20 61 74 20 63 6f 6d 70  ] option at comp
1ad0: 69 6c 65 20 74 69 6d 65 2e 0a 2a 2a 0a 2a 2a 20  ile time..**.** 
1ae0: 53 65 65 20 61 6c 73 6f 3a 20 53 51 4c 20 66 75  See also: SQL fu
1af0: 6e 63 74 69 6f 6e 73 20 5b 73 71 6c 69 74 65 5f  nctions [sqlite_
1b00: 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 75 73  compileoption_us
1b10: 65 64 28 29 5d 20 61 6e 64 0a 2a 2a 20 5b 73 71  ed()] and.** [sq
1b20: 6c 69 74 65 5f 63 6f 6d 70 69 6c 65 6f 70 74 69  lite_compileopti
1b30: 6f 6e 5f 67 65 74 28 29 5d 20 61 6e 64 20 74 68  on_get()] and th
1b40: 65 20 5b 63 6f 6d 70 69 6c 65 5f 6f 70 74 69 6f  e [compile_optio
1b50: 6e 73 20 70 72 61 67 6d 61 5d 2e 0a 2a 2f 0a 23  ns pragma]..*/.#
1b60: 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d  ifndef SQLITE_OM
1b70: 49 54 5f 43 4f 4d 50 49 4c 45 4f 50 54 49 4f 4e  IT_COMPILEOPTION
1b80: 5f 44 49 41 47 53 0a 69 6e 74 20 73 71 6c 69 74  _DIAGS.int sqlit
1b90: 65 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e  e3_compileoption
1ba0: 5f 75 73 65 64 28 63 6f 6e 73 74 20 63 68 61 72  _used(const char
1bb0: 20 2a 7a 4f 70 74 4e 61 6d 65 29 3b 0a 63 6f 6e   *zOptName);.con
1bc0: 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33  st char *sqlite3
1bd0: 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 67  _compileoption_g
1be0: 65 74 28 69 6e 74 20 4e 29 3b 0a 23 65 6e 64 69  et(int N);.#endi
1bf0: 66 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  f../*.** CAPI3RE
1c00: 46 3a 20 54 65 73 74 20 54 6f 20 53 65 65 20 49  F: Test To See I
1c10: 66 20 54 68 65 20 4c 69 62 72 61 72 79 20 49 73  f The Library Is
1c20: 20 54 68 72 65 61 64 73 61 66 65 0a 2a 2a 0a 2a   Threadsafe.**.*
1c30: 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 74  * ^The sqlite3_t
1c40: 68 72 65 61 64 73 61 66 65 28 29 20 66 75 6e 63  hreadsafe() func
1c50: 74 69 6f 6e 20 72 65 74 75 72 6e 73 20 7a 65 72  tion returns zer
1c60: 6f 20 69 66 20 61 6e 64 20 6f 6e 6c 79 20 69 66  o if and only if
1c70: 0a 2a 2a 20 53 51 4c 69 74 65 20 77 61 73 20 63  .** SQLite was c
1c80: 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 6d 75 74  ompiled with mut
1c90: 65 78 69 6e 67 20 63 6f 64 65 20 6f 6d 69 74 74  exing code omitt
1ca0: 65 64 20 64 75 65 20 74 6f 20 74 68 65 0a 2a 2a  ed due to the.**
1cb0: 20 5b 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53   [SQLITE_THREADS
1cc0: 41 46 45 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d  AFE] compile-tim
1cd0: 65 20 6f 70 74 69 6f 6e 20 62 65 69 6e 67 20 73  e option being s
1ce0: 65 74 20 74 6f 20 30 2e 0a 2a 2a 0a 2a 2a 20 53  et to 0..**.** S
1cf0: 51 4c 69 74 65 20 63 61 6e 20 62 65 20 63 6f 6d  QLite can be com
1d00: 70 69 6c 65 64 20 77 69 74 68 20 6f 72 20 77 69  piled with or wi
1d10: 74 68 6f 75 74 20 6d 75 74 65 78 65 73 2e 20 20  thout mutexes.  
1d20: 57 68 65 6e 0a 2a 2a 20 74 68 65 20 5b 53 51 4c  When.** the [SQL
1d30: 49 54 45 5f 54 48 52 45 41 44 53 41 46 45 5d 20  ITE_THREADSAFE] 
1d40: 43 20 70 72 65 70 72 6f 63 65 73 73 6f 72 20 6d  C preprocessor m
1d50: 61 63 72 6f 20 69 73 20 31 20 6f 72 20 32 2c 20  acro is 1 or 2, 
1d60: 6d 75 74 65 78 65 73 0a 2a 2a 20 61 72 65 20 65  mutexes.** are e
1d70: 6e 61 62 6c 65 64 20 61 6e 64 20 53 51 4c 69 74  nabled and SQLit
1d80: 65 20 69 73 20 74 68 72 65 61 64 73 61 66 65 2e  e is threadsafe.
1d90: 20 20 57 68 65 6e 20 74 68 65 0a 2a 2a 20 5b 53    When the.** [S
1da0: 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45  QLITE_THREADSAFE
1db0: 5d 20 6d 61 63 72 6f 20 69 73 20 30 2c 20 0a 2a  ] macro is 0, .*
1dc0: 2a 20 74 68 65 20 6d 75 74 65 78 65 73 20 61 72  * the mutexes ar
1dd0: 65 20 6f 6d 69 74 74 65 64 2e 20 20 57 69 74 68  e omitted.  With
1de0: 6f 75 74 20 74 68 65 20 6d 75 74 65 78 65 73 2c  out the mutexes,
1df0: 20 69 74 20 69 73 20 6e 6f 74 20 73 61 66 65 0a   it is not safe.
1e00: 2a 2a 20 74 6f 20 75 73 65 20 53 51 4c 69 74 65  ** to use SQLite
1e10: 20 63 6f 6e 63 75 72 72 65 6e 74 6c 79 20 66 72   concurrently fr
1e20: 6f 6d 20 6d 6f 72 65 20 74 68 61 6e 20 6f 6e 65  om more than one
1e30: 20 74 68 72 65 61 64 2e 0a 2a 2a 0a 2a 2a 20 45   thread..**.** E
1e40: 6e 61 62 6c 69 6e 67 20 6d 75 74 65 78 65 73 20  nabling mutexes 
1e50: 69 6e 63 75 72 73 20 61 20 6d 65 61 73 75 72 61  incurs a measura
1e60: 62 6c 65 20 70 65 72 66 6f 72 6d 61 6e 63 65 20  ble performance 
1e70: 70 65 6e 61 6c 74 79 2e 0a 2a 2a 20 53 6f 20 69  penalty..** So i
1e80: 66 20 73 70 65 65 64 20 69 73 20 6f 66 20 75 74  f speed is of ut
1e90: 6d 6f 73 74 20 69 6d 70 6f 72 74 61 6e 63 65 2c  most importance,
1ea0: 20 69 74 20 6d 61 6b 65 73 20 73 65 6e 73 65 20   it makes sense 
1eb0: 74 6f 20 64 69 73 61 62 6c 65 0a 2a 2a 20 74 68  to disable.** th
1ec0: 65 20 6d 75 74 65 78 65 73 2e 20 20 42 75 74 20  e mutexes.  But 
1ed0: 66 6f 72 20 6d 61 78 69 6d 75 6d 20 73 61 66 65  for maximum safe
1ee0: 74 79 2c 20 6d 75 74 65 78 65 73 20 73 68 6f 75  ty, mutexes shou
1ef0: 6c 64 20 62 65 20 65 6e 61 62 6c 65 64 2e 0a 2a  ld be enabled..*
1f00: 2a 20 5e 54 68 65 20 64 65 66 61 75 6c 74 20 62  * ^The default b
1f10: 65 68 61 76 69 6f 72 20 69 73 20 66 6f 72 20 6d  ehavior is for m
1f20: 75 74 65 78 65 73 20 74 6f 20 62 65 20 65 6e 61  utexes to be ena
1f30: 62 6c 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 73  bled..**.** This
1f40: 20 69 6e 74 65 72 66 61 63 65 20 63 61 6e 20 62   interface can b
1f50: 65 20 75 73 65 64 20 62 79 20 61 6e 20 61 70 70  e used by an app
1f60: 6c 69 63 61 74 69 6f 6e 20 74 6f 20 6d 61 6b 65  lication to make
1f70: 20 73 75 72 65 20 74 68 61 74 20 74 68 65 0a 2a   sure that the.*
1f80: 2a 20 76 65 72 73 69 6f 6e 20 6f 66 20 53 51 4c  * version of SQL
1f90: 69 74 65 20 74 68 61 74 20 69 74 20 69 73 20 6c  ite that it is l
1fa0: 69 6e 6b 69 6e 67 20 61 67 61 69 6e 73 74 20 77  inking against w
1fb0: 61 73 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68  as compiled with
1fc0: 0a 2a 2a 20 74 68 65 20 64 65 73 69 72 65 64 20  .** the desired 
1fd0: 73 65 74 74 69 6e 67 20 6f 66 20 74 68 65 20 5b  setting of the [
1fe0: 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46  SQLITE_THREADSAF
1ff0: 45 5d 20 6d 61 63 72 6f 2e 0a 2a 2a 0a 2a 2a 20  E] macro..**.** 
2000: 54 68 69 73 20 69 6e 74 65 72 66 61 63 65 20 6f  This interface o
2010: 6e 6c 79 20 72 65 70 6f 72 74 73 20 6f 6e 20 74  nly reports on t
2020: 68 65 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20  he compile-time 
2030: 6d 75 74 65 78 20 73 65 74 74 69 6e 67 0a 2a 2a  mutex setting.**
2040: 20 6f 66 20 74 68 65 20 5b 53 51 4c 49 54 45 5f   of the [SQLITE_
2050: 54 48 52 45 41 44 53 41 46 45 5d 20 66 6c 61 67  THREADSAFE] flag
2060: 2e 20 20 49 66 20 53 51 4c 69 74 65 20 69 73 20  .  If SQLite is 
2070: 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 0a 2a 2a  compiled with.**
2080: 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41   SQLITE_THREADSA
2090: 46 45 3d 31 20 6f 72 20 3d 32 20 74 68 65 6e 20  FE=1 or =2 then 
20a0: 6d 75 74 65 78 65 73 20 61 72 65 20 65 6e 61 62  mutexes are enab
20b0: 6c 65 64 20 62 79 20 64 65 66 61 75 6c 74 20 62  led by default b
20c0: 75 74 0a 2a 2a 20 63 61 6e 20 62 65 20 66 75 6c  ut.** can be ful
20d0: 6c 79 20 6f 72 20 70 61 72 74 69 61 6c 6c 79 20  ly or partially 
20e0: 64 69 73 61 62 6c 65 64 20 75 73 69 6e 67 20 61  disabled using a
20f0: 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 65   call to [sqlite
2100: 33 5f 63 6f 6e 66 69 67 28 29 5d 0a 2a 2a 20 77  3_config()].** w
2110: 69 74 68 20 74 68 65 20 76 65 72 62 73 20 5b 53  ith the verbs [S
2120: 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 49 4e  QLITE_CONFIG_SIN
2130: 47 4c 45 54 48 52 45 41 44 5d 2c 20 5b 53 51 4c  GLETHREAD], [SQL
2140: 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 55 4c 54 49  ITE_CONFIG_MULTI
2150: 54 48 52 45 41 44 5d 2c 0a 2a 2a 20 6f 72 20 5b  THREAD],.** or [
2160: 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 45  SQLITE_CONFIG_SE
2170: 52 49 41 4c 49 5a 45 44 5d 2e 20 20 5e 28 54 68  RIALIZED].  ^(Th
2180: 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 20 6f  e return value o
2190: 66 20 74 68 65 0a 2a 2a 20 73 71 6c 69 74 65 33  f the.** sqlite3
21a0: 5f 74 68 72 65 61 64 73 61 66 65 28 29 20 66 75  _threadsafe() fu
21b0: 6e 63 74 69 6f 6e 20 73 68 6f 77 73 20 6f 6e 6c  nction shows onl
21c0: 79 20 74 68 65 20 63 6f 6d 70 69 6c 65 2d 74 69  y the compile-ti
21d0: 6d 65 20 73 65 74 74 69 6e 67 20 6f 66 0a 2a 2a  me setting of.**
21e0: 20 74 68 72 65 61 64 20 73 61 66 65 74 79 2c 20   thread safety, 
21f0: 6e 6f 74 20 61 6e 79 20 72 75 6e 2d 74 69 6d 65  not any run-time
2200: 20 63 68 61 6e 67 65 73 20 74 6f 20 74 68 61 74   changes to that
2210: 20 73 65 74 74 69 6e 67 20 6d 61 64 65 20 62 79   setting made by
2220: 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66  .** sqlite3_conf
2230: 69 67 28 29 2e 20 49 6e 20 6f 74 68 65 72 20 77  ig(). In other w
2240: 6f 72 64 73 2c 20 74 68 65 20 72 65 74 75 72 6e  ords, the return
2250: 20 76 61 6c 75 65 20 66 72 6f 6d 20 73 71 6c 69   value from sqli
2260: 74 65 33 5f 74 68 72 65 61 64 73 61 66 65 28 29  te3_threadsafe()
2270: 0a 2a 2a 20 69 73 20 75 6e 63 68 61 6e 67 65 64  .** is unchanged
2280: 20 62 79 20 63 61 6c 6c 73 20 74 6f 20 73 71 6c   by calls to sql
2290: 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 2e 29 5e  ite3_config().)^
22a0: 0a 2a 2a 0a 2a 2a 20 53 65 65 20 74 68 65 20 5b  .**.** See the [
22b0: 74 68 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20  threading mode] 
22c0: 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 6f  documentation fo
22d0: 72 20 61 64 64 69 74 69 6f 6e 61 6c 20 69 6e 66  r additional inf
22e0: 6f 72 6d 61 74 69 6f 6e 2e 0a 2a 2f 0a 69 6e 74  ormation..*/.int
22f0: 20 73 71 6c 69 74 65 33 5f 74 68 72 65 61 64 73   sqlite3_threads
2300: 61 66 65 28 76 6f 69 64 29 3b 0a 0a 2f 2a 0a 2a  afe(void);../*.*
2310: 2a 20 43 41 50 49 33 52 45 46 3a 20 44 61 74 61  * CAPI3REF: Data
2320: 62 61 73 65 20 43 6f 6e 6e 65 63 74 69 6f 6e 20  base Connection 
2330: 48 61 6e 64 6c 65 0a 2a 2a 20 4b 45 59 57 4f 52  Handle.** KEYWOR
2340: 44 53 3a 20 7b 64 61 74 61 62 61 73 65 20 63 6f  DS: {database co
2350: 6e 6e 65 63 74 69 6f 6e 7d 20 7b 64 61 74 61 62  nnection} {datab
2360: 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 7d  ase connections}
2370: 0a 2a 2a 0a 2a 2a 20 45 61 63 68 20 6f 70 65 6e  .**.** Each open
2380: 20 53 51 4c 69 74 65 20 64 61 74 61 62 61 73 65   SQLite database
2390: 20 69 73 20 72 65 70 72 65 73 65 6e 74 65 64 20   is represented 
23a0: 62 79 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20  by a pointer to 
23b0: 61 6e 20 69 6e 73 74 61 6e 63 65 20 6f 66 0a 2a  an instance of.*
23c0: 2a 20 74 68 65 20 6f 70 61 71 75 65 20 73 74 72  * the opaque str
23d0: 75 63 74 75 72 65 20 6e 61 6d 65 64 20 22 73 71  ucture named "sq
23e0: 6c 69 74 65 33 22 2e 20 20 49 74 20 69 73 20 75  lite3".  It is u
23f0: 73 65 66 75 6c 20 74 6f 20 74 68 69 6e 6b 20 6f  seful to think o
2400: 66 20 61 6e 20 73 71 6c 69 74 65 33 0a 2a 2a 20  f an sqlite3.** 
2410: 70 6f 69 6e 74 65 72 20 61 73 20 61 6e 20 6f 62  pointer as an ob
2420: 6a 65 63 74 2e 20 20 54 68 65 20 5b 73 71 6c 69  ject.  The [sqli
2430: 74 65 33 5f 6f 70 65 6e 28 29 5d 2c 20 5b 73 71  te3_open()], [sq
2440: 6c 69 74 65 33 5f 6f 70 65 6e 31 36 28 29 5d 2c  lite3_open16()],
2450: 20 61 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74 65 33   and.** [sqlite3
2460: 5f 6f 70 65 6e 5f 76 32 28 29 5d 20 69 6e 74 65  _open_v2()] inte
2470: 72 66 61 63 65 73 20 61 72 65 20 69 74 73 20 63  rfaces are its c
2480: 6f 6e 73 74 72 75 63 74 6f 72 73 2c 20 61 6e 64  onstructors, and
2490: 20 5b 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 28   [sqlite3_close(
24a0: 29 5d 0a 2a 2a 20 61 6e 64 20 5b 73 71 6c 69 74  )].** and [sqlit
24b0: 65 33 5f 63 6c 6f 73 65 5f 76 32 28 29 5d 20 61  e3_close_v2()] a
24c0: 72 65 20 69 74 73 20 64 65 73 74 72 75 63 74 6f  re its destructo
24d0: 72 73 2e 20 20 54 68 65 72 65 20 61 72 65 20 6d  rs.  There are m
24e0: 61 6e 79 20 6f 74 68 65 72 0a 2a 2a 20 69 6e 74  any other.** int
24f0: 65 72 66 61 63 65 73 20 28 73 75 63 68 20 61 73  erfaces (such as
2500: 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 70 72 65  .** [sqlite3_pre
2510: 70 61 72 65 5f 76 32 28 29 5d 2c 20 5b 73 71 6c  pare_v2()], [sql
2520: 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63  ite3_create_func
2530: 74 69 6f 6e 28 29 5d 2c 20 61 6e 64 0a 2a 2a 20  tion()], and.** 
2540: 5b 73 71 6c 69 74 65 33 5f 62 75 73 79 5f 74 69  [sqlite3_busy_ti
2550: 6d 65 6f 75 74 28 29 5d 20 74 6f 20 6e 61 6d 65  meout()] to name
2560: 20 62 75 74 20 74 68 72 65 65 29 20 74 68 61 74   but three) that
2570: 20 61 72 65 20 6d 65 74 68 6f 64 73 20 6f 6e 20   are methods on 
2580: 61 6e 0a 2a 2a 20 73 71 6c 69 74 65 33 20 6f 62  an.** sqlite3 ob
2590: 6a 65 63 74 2e 0a 2a 2f 0a 74 79 70 65 64 65 66  ject..*/.typedef
25a0: 20 73 74 72 75 63 74 20 73 71 6c 69 74 65 33 20   struct sqlite3 
25b0: 73 71 6c 69 74 65 33 3b 0a 0a 2f 2a 0a 2a 2a 20  sqlite3;../*.** 
25c0: 43 41 50 49 33 52 45 46 3a 20 36 34 2d 42 69 74  CAPI3REF: 64-Bit
25d0: 20 49 6e 74 65 67 65 72 20 54 79 70 65 73 0a 2a   Integer Types.*
25e0: 2a 20 4b 45 59 57 4f 52 44 53 3a 20 73 71 6c 69  * KEYWORDS: sqli
25f0: 74 65 5f 69 6e 74 36 34 20 73 71 6c 69 74 65 5f  te_int64 sqlite_
2600: 75 69 6e 74 36 34 0a 2a 2a 0a 2a 2a 20 42 65 63  uint64.**.** Bec
2610: 61 75 73 65 20 74 68 65 72 65 20 69 73 20 6e 6f  ause there is no
2620: 20 63 72 6f 73 73 2d 70 6c 61 74 66 6f 72 6d 20   cross-platform 
2630: 77 61 79 20 74 6f 20 73 70 65 63 69 66 79 20 36  way to specify 6
2640: 34 2d 62 69 74 20 69 6e 74 65 67 65 72 20 74 79  4-bit integer ty
2650: 70 65 73 0a 2a 2a 20 53 51 4c 69 74 65 20 69 6e  pes.** SQLite in
2660: 63 6c 75 64 65 73 20 74 79 70 65 64 65 66 73 20  cludes typedefs 
2670: 66 6f 72 20 36 34 2d 62 69 74 20 73 69 67 6e 65  for 64-bit signe
2680: 64 20 61 6e 64 20 75 6e 73 69 67 6e 65 64 20 69  d and unsigned i
2690: 6e 74 65 67 65 72 73 2e 0a 2a 2a 0a 2a 2a 20 54  ntegers..**.** T
26a0: 68 65 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34  he sqlite3_int64
26b0: 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 75 69 6e   and sqlite3_uin
26c0: 74 36 34 20 61 72 65 20 74 68 65 20 70 72 65 66  t64 are the pref
26d0: 65 72 72 65 64 20 74 79 70 65 20 64 65 66 69 6e  erred type defin
26e0: 69 74 69 6f 6e 73 2e 0a 2a 2a 20 54 68 65 20 73  itions..** The s
26f0: 71 6c 69 74 65 5f 69 6e 74 36 34 20 61 6e 64 20  qlite_int64 and 
2700: 73 71 6c 69 74 65 5f 75 69 6e 74 36 34 20 74 79  sqlite_uint64 ty
2710: 70 65 73 20 61 72 65 20 73 75 70 70 6f 72 74 65  pes are supporte
2720: 64 20 66 6f 72 20 62 61 63 6b 77 61 72 64 73 0a  d for backwards.
2730: 2a 2a 20 63 6f 6d 70 61 74 69 62 69 6c 69 74 79  ** compatibility
2740: 20 6f 6e 6c 79 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68   only..**.** ^Th
2750: 65 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 20  e sqlite3_int64 
2760: 61 6e 64 20 73 71 6c 69 74 65 5f 69 6e 74 36 34  and sqlite_int64
2770: 20 74 79 70 65 73 20 63 61 6e 20 73 74 6f 72 65   types can store
2780: 20 69 6e 74 65 67 65 72 20 76 61 6c 75 65 73 0a   integer values.
2790: 2a 2a 20 62 65 74 77 65 65 6e 20 2d 39 32 32 33  ** between -9223
27a0: 33 37 32 30 33 36 38 35 34 37 37 35 38 30 38 20  372036854775808 
27b0: 61 6e 64 20 2b 39 32 32 33 33 37 32 30 33 36 38  and +92233720368
27c0: 35 34 37 37 35 38 30 37 20 69 6e 63 6c 75 73 69  54775807 inclusi
27d0: 76 65 2e 20 20 5e 54 68 65 0a 2a 2a 20 73 71 6c  ve.  ^The.** sql
27e0: 69 74 65 33 5f 75 69 6e 74 36 34 20 61 6e 64 20  ite3_uint64 and 
27f0: 73 71 6c 69 74 65 5f 75 69 6e 74 36 34 20 74 79  sqlite_uint64 ty
2800: 70 65 73 20 63 61 6e 20 73 74 6f 72 65 20 69 6e  pes can store in
2810: 74 65 67 65 72 20 76 61 6c 75 65 73 20 0a 2a 2a  teger values .**
2820: 20 62 65 74 77 65 65 6e 20 30 20 61 6e 64 20 2b   between 0 and +
2830: 31 38 34 34 36 37 34 34 30 37 33 37 30 39 35 35  1844674407370955
2840: 31 36 31 35 20 69 6e 63 6c 75 73 69 76 65 2e 0a  1615 inclusive..
2850: 2a 2f 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45  */.#ifdef SQLITE
2860: 5f 49 4e 54 36 34 5f 54 59 50 45 0a 20 20 74 79  _INT64_TYPE.  ty
2870: 70 65 64 65 66 20 53 51 4c 49 54 45 5f 49 4e 54  pedef SQLITE_INT
2880: 36 34 5f 54 59 50 45 20 73 71 6c 69 74 65 5f 69  64_TYPE sqlite_i
2890: 6e 74 36 34 3b 0a 20 20 74 79 70 65 64 65 66 20  nt64;.  typedef 
28a0: 75 6e 73 69 67 6e 65 64 20 53 51 4c 49 54 45 5f  unsigned SQLITE_
28b0: 49 4e 54 36 34 5f 54 59 50 45 20 73 71 6c 69 74  INT64_TYPE sqlit
28c0: 65 5f 75 69 6e 74 36 34 3b 0a 23 65 6c 69 66 20  e_uint64;.#elif 
28d0: 64 65 66 69 6e 65 64 28 5f 4d 53 43 5f 56 45 52  defined(_MSC_VER
28e0: 29 20 7c 7c 20 64 65 66 69 6e 65 64 28 5f 5f 42  ) || defined(__B
28f0: 4f 52 4c 41 4e 44 43 5f 5f 29 0a 20 20 74 79 70  ORLANDC__).  typ
2900: 65 64 65 66 20 5f 5f 69 6e 74 36 34 20 73 71 6c  edef __int64 sql
2910: 69 74 65 5f 69 6e 74 36 34 3b 0a 20 20 74 79 70  ite_int64;.  typ
2920: 65 64 65 66 20 75 6e 73 69 67 6e 65 64 20 5f 5f  edef unsigned __
2930: 69 6e 74 36 34 20 73 71 6c 69 74 65 5f 75 69 6e  int64 sqlite_uin
2940: 74 36 34 3b 0a 23 65 6c 73 65 0a 20 20 74 79 70  t64;.#else.  typ
2950: 65 64 65 66 20 6c 6f 6e 67 20 6c 6f 6e 67 20 69  edef long long i
2960: 6e 74 20 73 71 6c 69 74 65 5f 69 6e 74 36 34 3b  nt sqlite_int64;
2970: 0a 20 20 74 79 70 65 64 65 66 20 75 6e 73 69 67  .  typedef unsig
2980: 6e 65 64 20 6c 6f 6e 67 20 6c 6f 6e 67 20 69 6e  ned long long in
2990: 74 20 73 71 6c 69 74 65 5f 75 69 6e 74 36 34 3b  t sqlite_uint64;
29a0: 0a 23 65 6e 64 69 66 0a 74 79 70 65 64 65 66 20  .#endif.typedef 
29b0: 73 71 6c 69 74 65 5f 69 6e 74 36 34 20 73 71 6c  sqlite_int64 sql
29c0: 69 74 65 33 5f 69 6e 74 36 34 3b 0a 74 79 70 65  ite3_int64;.type
29d0: 64 65 66 20 73 71 6c 69 74 65 5f 75 69 6e 74 36  def sqlite_uint6
29e0: 34 20 73 71 6c 69 74 65 33 5f 75 69 6e 74 36 34  4 sqlite3_uint64
29f0: 3b 0a 0a 2f 2a 0a 2a 2a 20 49 66 20 63 6f 6d 70  ;../*.** If comp
2a00: 69 6c 69 6e 67 20 66 6f 72 20 61 20 70 72 6f 63  iling for a proc
2a10: 65 73 73 6f 72 20 74 68 61 74 20 6c 61 63 6b 73  essor that lacks
2a20: 20 66 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 20   floating point 
2a30: 73 75 70 70 6f 72 74 2c 0a 2a 2a 20 73 75 62 73  support,.** subs
2a40: 74 69 74 75 74 65 20 69 6e 74 65 67 65 72 20 66  titute integer f
2a50: 6f 72 20 66 6c 6f 61 74 69 6e 67 2d 70 6f 69 6e  or floating-poin
2a60: 74 2e 0a 2a 2f 0a 23 69 66 64 65 66 20 53 51 4c  t..*/.#ifdef SQL
2a70: 49 54 45 5f 4f 4d 49 54 5f 46 4c 4f 41 54 49 4e  ITE_OMIT_FLOATIN
2a80: 47 5f 50 4f 49 4e 54 0a 23 20 64 65 66 69 6e 65  G_POINT.# define
2a90: 20 64 6f 75 62 6c 65 20 73 71 6c 69 74 65 33 5f   double sqlite3_
2aa0: 69 6e 74 36 34 0a 23 65 6e 64 69 66 0a 0a 2f 2a  int64.#endif../*
2ab0: 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6c  .** CAPI3REF: Cl
2ac0: 6f 73 69 6e 67 20 41 20 44 61 74 61 62 61 73 65  osing A Database
2ad0: 20 43 6f 6e 6e 65 63 74 69 6f 6e 0a 2a 2a 20 44   Connection.** D
2ae0: 45 53 54 52 55 43 54 4f 52 3a 20 73 71 6c 69 74  ESTRUCTOR: sqlit
2af0: 65 33 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71  e3.**.** ^The sq
2b00: 6c 69 74 65 33 5f 63 6c 6f 73 65 28 29 20 61 6e  lite3_close() an
2b10: 64 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 5f  d sqlite3_close_
2b20: 76 32 28 29 20 72 6f 75 74 69 6e 65 73 20 61 72  v2() routines ar
2b30: 65 20 64 65 73 74 72 75 63 74 6f 72 73 0a 2a 2a  e destructors.**
2b40: 20 66 6f 72 20 74 68 65 20 5b 73 71 6c 69 74 65   for the [sqlite
2b50: 33 5d 20 6f 62 6a 65 63 74 2e 0a 2a 2a 20 5e 43  3] object..** ^C
2b60: 61 6c 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 5f  alls to sqlite3_
2b70: 63 6c 6f 73 65 28 29 20 61 6e 64 20 73 71 6c 69  close() and sqli
2b80: 74 65 33 5f 63 6c 6f 73 65 5f 76 32 28 29 20 72  te3_close_v2() r
2b90: 65 74 75 72 6e 20 5b 53 51 4c 49 54 45 5f 4f 4b  eturn [SQLITE_OK
2ba0: 5d 20 69 66 0a 2a 2a 20 74 68 65 20 5b 73 71 6c  ] if.** the [sql
2bb0: 69 74 65 33 5d 20 6f 62 6a 65 63 74 20 69 73 20  ite3] object is 
2bc0: 73 75 63 63 65 73 73 66 75 6c 6c 79 20 64 65 73  successfully des
2bd0: 74 72 6f 79 65 64 20 61 6e 64 20 61 6c 6c 20 61  troyed and all a
2be0: 73 73 6f 63 69 61 74 65 64 0a 2a 2a 20 72 65 73  ssociated.** res
2bf0: 6f 75 72 63 65 73 20 61 72 65 20 64 65 61 6c 6c  ources are deall
2c00: 6f 63 61 74 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 49  ocated..**.** ^I
2c10: 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63  f the database c
2c20: 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 61 73 73  onnection is ass
2c30: 6f 63 69 61 74 65 64 20 77 69 74 68 20 75 6e 66  ociated with unf
2c40: 69 6e 61 6c 69 7a 65 64 20 70 72 65 70 61 72 65  inalized prepare
2c50: 64 0a 2a 2a 20 73 74 61 74 65 6d 65 6e 74 73 20  d.** statements 
2c60: 6f 72 20 75 6e 66 69 6e 69 73 68 65 64 20 73 71  or unfinished sq
2c70: 6c 69 74 65 33 5f 62 61 63 6b 75 70 20 6f 62 6a  lite3_backup obj
2c80: 65 63 74 73 20 74 68 65 6e 20 73 71 6c 69 74 65  ects then sqlite
2c90: 33 5f 63 6c 6f 73 65 28 29 0a 2a 2a 20 77 69 6c  3_close().** wil
2ca0: 6c 20 6c 65 61 76 65 20 74 68 65 20 64 61 74 61  l leave the data
2cb0: 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20  base connection 
2cc0: 6f 70 65 6e 20 61 6e 64 20 72 65 74 75 72 6e 20  open and return 
2cd0: 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d 2e 0a 2a  [SQLITE_BUSY]..*
2ce0: 2a 20 5e 49 66 20 73 71 6c 69 74 65 33 5f 63 6c  * ^If sqlite3_cl
2cf0: 6f 73 65 5f 76 32 28 29 20 69 73 20 63 61 6c 6c  ose_v2() is call
2d00: 65 64 20 77 69 74 68 20 75 6e 66 69 6e 61 6c 69  ed with unfinali
2d10: 7a 65 64 20 70 72 65 70 61 72 65 64 20 73 74 61  zed prepared sta
2d20: 74 65 6d 65 6e 74 73 0a 2a 2a 20 61 6e 64 2f 6f  tements.** and/o
2d30: 72 20 75 6e 66 69 6e 69 73 68 65 64 20 73 71 6c  r unfinished sql
2d40: 69 74 65 33 5f 62 61 63 6b 75 70 73 2c 20 74 68  ite3_backups, th
2d50: 65 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20  en the database 
2d60: 63 6f 6e 6e 65 63 74 69 6f 6e 20 62 65 63 6f 6d  connection becom
2d70: 65 73 0a 2a 2a 20 61 6e 20 75 6e 75 73 61 62 6c  es.** an unusabl
2d80: 65 20 22 7a 6f 6d 62 69 65 22 20 77 68 69 63 68  e "zombie" which
2d90: 20 77 69 6c 6c 20 61 75 74 6f 6d 61 74 69 63 61   will automatica
2da0: 6c 6c 79 20 62 65 20 64 65 61 6c 6c 6f 63 61 74  lly be deallocat
2db0: 65 64 20 77 68 65 6e 20 74 68 65 0a 2a 2a 20 6c  ed when the.** l
2dc0: 61 73 74 20 70 72 65 70 61 72 65 64 20 73 74 61  ast prepared sta
2dd0: 74 65 6d 65 6e 74 20 69 73 20 66 69 6e 61 6c 69  tement is finali
2de0: 7a 65 64 20 6f 72 20 74 68 65 20 6c 61 73 74 20  zed or the last 
2df0: 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 70 20 69  sqlite3_backup i
2e00: 73 0a 2a 2a 20 66 69 6e 69 73 68 65 64 2e 20 20  s.** finished.  
2e10: 54 68 65 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73  The sqlite3_clos
2e20: 65 5f 76 32 28 29 20 69 6e 74 65 72 66 61 63 65  e_v2() interface
2e30: 20 69 73 20 69 6e 74 65 6e 64 65 64 20 66 6f 72   is intended for
2e40: 20 75 73 65 20 77 69 74 68 0a 2a 2a 20 68 6f 73   use with.** hos
2e50: 74 20 6c 61 6e 67 75 61 67 65 73 20 74 68 61 74  t languages that
2e60: 20 61 72 65 20 67 61 72 62 61 67 65 20 63 6f 6c   are garbage col
2e70: 6c 65 63 74 65 64 2c 20 61 6e 64 20 77 68 65 72  lected, and wher
2e80: 65 20 74 68 65 20 6f 72 64 65 72 20 69 6e 20 77  e the order in w
2e90: 68 69 63 68 0a 2a 2a 20 64 65 73 74 72 75 63 74  hich.** destruct
2ea0: 6f 72 73 20 61 72 65 20 63 61 6c 6c 65 64 20 69  ors are called i
2eb0: 73 20 61 72 62 69 74 72 61 72 79 2e 0a 2a 2a 0a  s arbitrary..**.
2ec0: 2a 2a 20 41 70 70 6c 69 63 61 74 69 6f 6e 73 20  ** Applications 
2ed0: 73 68 6f 75 6c 64 20 5b 73 71 6c 69 74 65 33 5f  should [sqlite3_
2ee0: 66 69 6e 61 6c 69 7a 65 20 7c 20 66 69 6e 61 6c  finalize | final
2ef0: 69 7a 65 5d 20 61 6c 6c 20 5b 70 72 65 70 61 72  ize] all [prepar
2f00: 65 64 20 73 74 61 74 65 6d 65 6e 74 73 5d 2c 0a  ed statements],.
2f10: 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62 6c 6f 62  ** [sqlite3_blob
2f20: 5f 63 6c 6f 73 65 20 7c 20 63 6c 6f 73 65 5d 20  _close | close] 
2f30: 61 6c 6c 20 5b 42 4c 4f 42 20 68 61 6e 64 6c 65  all [BLOB handle
2f40: 73 5d 2c 20 61 6e 64 20 0a 2a 2a 20 5b 73 71 6c  s], and .** [sql
2f50: 69 74 65 33 5f 62 61 63 6b 75 70 5f 66 69 6e 69  ite3_backup_fini
2f60: 73 68 20 7c 20 66 69 6e 69 73 68 5d 20 61 6c 6c  sh | finish] all
2f70: 20 5b 73 71 6c 69 74 65 33 5f 62 61 63 6b 75 70   [sqlite3_backup
2f80: 5d 20 6f 62 6a 65 63 74 73 20 61 73 73 6f 63 69  ] objects associ
2f90: 61 74 65 64 0a 2a 2a 20 77 69 74 68 20 74 68 65  ated.** with the
2fa0: 20 5b 73 71 6c 69 74 65 33 5d 20 6f 62 6a 65 63   [sqlite3] objec
2fb0: 74 20 70 72 69 6f 72 20 74 6f 20 61 74 74 65 6d  t prior to attem
2fc0: 70 74 69 6e 67 20 74 6f 20 63 6c 6f 73 65 20 74  pting to close t
2fd0: 68 65 20 6f 62 6a 65 63 74 2e 20 20 5e 49 66 0a  he object.  ^If.
2fe0: 2a 2a 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65  ** sqlite3_close
2ff0: 5f 76 32 28 29 20 69 73 20 63 61 6c 6c 65 64 20  _v2() is called 
3000: 6f 6e 20 61 20 5b 64 61 74 61 62 61 73 65 20 63  on a [database c
3010: 6f 6e 6e 65 63 74 69 6f 6e 5d 20 74 68 61 74 20  onnection] that 
3020: 73 74 69 6c 6c 20 68 61 73 0a 2a 2a 20 6f 75 74  still has.** out
3030: 73 74 61 6e 64 69 6e 67 20 5b 70 72 65 70 61 72  standing [prepar
3040: 65 64 20 73 74 61 74 65 6d 65 6e 74 73 5d 2c 20  ed statements], 
3050: 5b 42 4c 4f 42 20 68 61 6e 64 6c 65 73 5d 2c 20  [BLOB handles], 
3060: 61 6e 64 2f 6f 72 0a 2a 2a 20 5b 73 71 6c 69 74  and/or.** [sqlit
3070: 65 33 5f 62 61 63 6b 75 70 5d 20 6f 62 6a 65 63  e3_backup] objec
3080: 74 73 20 74 68 65 6e 20 69 74 20 72 65 74 75 72  ts then it retur
3090: 6e 73 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 61  ns [SQLITE_OK] a
30a0: 6e 64 20 74 68 65 20 64 65 61 6c 6c 6f 63 61 74  nd the deallocat
30b0: 69 6f 6e 0a 2a 2a 20 6f 66 20 72 65 73 6f 75 72  ion.** of resour
30c0: 63 65 73 20 69 73 20 64 65 66 65 72 72 65 64 20  ces is deferred 
30d0: 75 6e 74 69 6c 20 61 6c 6c 20 5b 70 72 65 70 61  until all [prepa
30e0: 72 65 64 20 73 74 61 74 65 6d 65 6e 74 73 5d 2c  red statements],
30f0: 20 5b 42 4c 4f 42 20 68 61 6e 64 6c 65 73 5d 2c   [BLOB handles],
3100: 0a 2a 2a 20 61 6e 64 20 5b 73 71 6c 69 74 65 33  .** and [sqlite3
3110: 5f 62 61 63 6b 75 70 5d 20 6f 62 6a 65 63 74 73  _backup] objects
3120: 20 61 72 65 20 61 6c 73 6f 20 64 65 73 74 72 6f   are also destro
3130: 79 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 61  yed..**.** ^If a
3140: 6e 20 5b 73 71 6c 69 74 65 33 5d 20 6f 62 6a 65  n [sqlite3] obje
3150: 63 74 20 69 73 20 64 65 73 74 72 6f 79 65 64 20  ct is destroyed 
3160: 77 68 69 6c 65 20 61 20 74 72 61 6e 73 61 63 74  while a transact
3170: 69 6f 6e 20 69 73 20 6f 70 65 6e 2c 0a 2a 2a 20  ion is open,.** 
3180: 74 68 65 20 74 72 61 6e 73 61 63 74 69 6f 6e 20  the transaction 
3190: 69 73 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79  is automatically
31a0: 20 72 6f 6c 6c 65 64 20 62 61 63 6b 2e 0a 2a 2a   rolled back..**
31b0: 0a 2a 2a 20 54 68 65 20 43 20 70 61 72 61 6d 65  .** The C parame
31c0: 74 65 72 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f  ter to [sqlite3_
31d0: 63 6c 6f 73 65 28 43 29 5d 20 61 6e 64 20 5b 73  close(C)] and [s
31e0: 71 6c 69 74 65 33 5f 63 6c 6f 73 65 5f 76 32 28  qlite3_close_v2(
31f0: 43 29 5d 0a 2a 2a 20 6d 75 73 74 20 62 65 20 65  C)].** must be e
3200: 69 74 68 65 72 20 61 20 4e 55 4c 4c 0a 2a 2a 20  ither a NULL.** 
3210: 70 6f 69 6e 74 65 72 20 6f 72 20 61 6e 20 5b 73  pointer or an [s
3220: 71 6c 69 74 65 33 5d 20 6f 62 6a 65 63 74 20 70  qlite3] object p
3230: 6f 69 6e 74 65 72 20 6f 62 74 61 69 6e 65 64 0a  ointer obtained.
3240: 2a 2a 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33  ** from [sqlite3
3250: 5f 6f 70 65 6e 28 29 5d 2c 20 5b 73 71 6c 69 74  _open()], [sqlit
3260: 65 33 5f 6f 70 65 6e 31 36 28 29 5d 2c 20 6f 72  e3_open16()], or
3270: 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65  .** [sqlite3_ope
3280: 6e 5f 76 32 28 29 5d 2c 20 61 6e 64 20 6e 6f 74  n_v2()], and not
3290: 20 70 72 65 76 69 6f 75 73 6c 79 20 63 6c 6f 73   previously clos
32a0: 65 64 2e 0a 2a 2a 20 5e 43 61 6c 6c 69 6e 67 20  ed..** ^Calling 
32b0: 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 28 29 20  sqlite3_close() 
32c0: 6f 72 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65  or sqlite3_close
32d0: 5f 76 32 28 29 20 77 69 74 68 20 61 20 4e 55 4c  _v2() with a NUL
32e0: 4c 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 61 72 67  L pointer.** arg
32f0: 75 6d 65 6e 74 20 69 73 20 61 20 68 61 72 6d 6c  ument is a harml
3300: 65 73 73 20 6e 6f 2d 6f 70 2e 0a 2a 2f 0a 69 6e  ess no-op..*/.in
3310: 74 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 28  t sqlite3_close(
3320: 73 71 6c 69 74 65 33 2a 29 3b 0a 69 6e 74 20 73  sqlite3*);.int s
3330: 71 6c 69 74 65 33 5f 63 6c 6f 73 65 5f 76 32 28  qlite3_close_v2(
3340: 73 71 6c 69 74 65 33 2a 29 3b 0a 0a 2f 2a 0a 2a  sqlite3*);../*.*
3350: 2a 20 54 68 65 20 74 79 70 65 20 66 6f 72 20 61  * The type for a
3360: 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69   callback functi
3370: 6f 6e 2e 0a 2a 2a 20 54 68 69 73 20 69 73 20 6c  on..** This is l
3380: 65 67 61 63 79 20 61 6e 64 20 64 65 70 72 65 63  egacy and deprec
3390: 61 74 65 64 2e 20 20 49 74 20 69 73 20 69 6e 63  ated.  It is inc
33a0: 6c 75 64 65 64 20 66 6f 72 20 68 69 73 74 6f 72  luded for histor
33b0: 69 63 61 6c 0a 2a 2a 20 63 6f 6d 70 61 74 69 62  ical.** compatib
33c0: 69 6c 69 74 79 20 61 6e 64 20 69 73 20 6e 6f 74  ility and is not
33d0: 20 64 6f 63 75 6d 65 6e 74 65 64 2e 0a 2a 2f 0a   documented..*/.
33e0: 74 79 70 65 64 65 66 20 69 6e 74 20 28 2a 73 71  typedef int (*sq
33f0: 6c 69 74 65 33 5f 63 61 6c 6c 62 61 63 6b 29 28  lite3_callback)(
3400: 76 6f 69 64 2a 2c 69 6e 74 2c 63 68 61 72 2a 2a  void*,int,char**
3410: 2c 20 63 68 61 72 2a 2a 29 3b 0a 0a 2f 2a 0a 2a  , char**);../*.*
3420: 2a 20 43 41 50 49 33 52 45 46 3a 20 4f 6e 65 2d  * CAPI3REF: One-
3430: 53 74 65 70 20 51 75 65 72 79 20 45 78 65 63 75  Step Query Execu
3440: 74 69 6f 6e 20 49 6e 74 65 72 66 61 63 65 0a 2a  tion Interface.*
3450: 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65  * METHOD: sqlite
3460: 33 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69  3.**.** The sqli
3470: 74 65 33 5f 65 78 65 63 28 29 20 69 6e 74 65 72  te3_exec() inter
3480: 66 61 63 65 20 69 73 20 61 20 63 6f 6e 76 65 6e  face is a conven
3490: 69 65 6e 63 65 20 77 72 61 70 70 65 72 20 61 72  ience wrapper ar
34a0: 6f 75 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  ound.** [sqlite3
34b0: 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d 2c 20  _prepare_v2()], 
34c0: 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d  [sqlite3_step()]
34d0: 2c 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 66  , and [sqlite3_f
34e0: 69 6e 61 6c 69 7a 65 28 29 5d 2c 0a 2a 2a 20 74  inalize()],.** t
34f0: 68 61 74 20 61 6c 6c 6f 77 73 20 61 6e 20 61 70  hat allows an ap
3500: 70 6c 69 63 61 74 69 6f 6e 20 74 6f 20 72 75 6e  plication to run
3510: 20 6d 75 6c 74 69 70 6c 65 20 73 74 61 74 65 6d   multiple statem
3520: 65 6e 74 73 20 6f 66 20 53 51 4c 0a 2a 2a 20 77  ents of SQL.** w
3530: 69 74 68 6f 75 74 20 68 61 76 69 6e 67 20 74 6f  ithout having to
3540: 20 75 73 65 20 61 20 6c 6f 74 20 6f 66 20 43 20   use a lot of C 
3550: 63 6f 64 65 2e 20 0a 2a 2a 0a 2a 2a 20 5e 54 68  code. .**.** ^Th
3560: 65 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29  e sqlite3_exec()
3570: 20 69 6e 74 65 72 66 61 63 65 20 72 75 6e 73 20   interface runs 
3580: 7a 65 72 6f 20 6f 72 20 6d 6f 72 65 20 55 54 46  zero or more UTF
3590: 2d 38 20 65 6e 63 6f 64 65 64 2c 0a 2a 2a 20 73  -8 encoded,.** s
35a0: 65 6d 69 63 6f 6c 6f 6e 2d 73 65 70 61 72 61 74  emicolon-separat
35b0: 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73  e SQL statements
35c0: 20 70 61 73 73 65 64 20 69 6e 74 6f 20 69 74 73   passed into its
35d0: 20 32 6e 64 20 61 72 67 75 6d 65 6e 74 2c 0a 2a   2nd argument,.*
35e0: 2a 20 69 6e 20 74 68 65 20 63 6f 6e 74 65 78 74  * in the context
35f0: 20 6f 66 20 74 68 65 20 5b 64 61 74 61 62 61 73   of the [databas
3600: 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 70 61  e connection] pa
3610: 73 73 65 64 20 69 6e 20 61 73 20 69 74 73 20 31  ssed in as its 1
3620: 73 74 0a 2a 2a 20 61 72 67 75 6d 65 6e 74 2e 20  st.** argument. 
3630: 20 5e 49 66 20 74 68 65 20 63 61 6c 6c 62 61 63   ^If the callbac
3640: 6b 20 66 75 6e 63 74 69 6f 6e 20 6f 66 20 74 68  k function of th
3650: 65 20 33 72 64 20 61 72 67 75 6d 65 6e 74 20 74  e 3rd argument t
3660: 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 65 78 65  o.** sqlite3_exe
3670: 63 28 29 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 2c  c() is not NULL,
3680: 20 74 68 65 6e 20 69 74 20 69 73 20 69 6e 76 6f   then it is invo
3690: 6b 65 64 20 66 6f 72 20 65 61 63 68 20 72 65 73  ked for each res
36a0: 75 6c 74 20 72 6f 77 0a 2a 2a 20 63 6f 6d 69 6e  ult row.** comin
36b0: 67 20 6f 75 74 20 6f 66 20 74 68 65 20 65 76 61  g out of the eva
36c0: 6c 75 61 74 65 64 20 53 51 4c 20 73 74 61 74 65  luated SQL state
36d0: 6d 65 6e 74 73 2e 20 20 5e 54 68 65 20 34 74 68  ments.  ^The 4th
36e0: 20 61 72 67 75 6d 65 6e 74 20 74 6f 0a 2a 2a 20   argument to.** 
36f0: 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 20 69  sqlite3_exec() i
3700: 73 20 72 65 6c 61 79 65 64 20 74 68 72 6f 75 67  s relayed throug
3710: 68 20 74 6f 20 74 68 65 20 31 73 74 20 61 72 67  h to the 1st arg
3720: 75 6d 65 6e 74 20 6f 66 20 65 61 63 68 0a 2a 2a  ument of each.**
3730: 20 63 61 6c 6c 62 61 63 6b 20 69 6e 76 6f 63 61   callback invoca
3740: 74 69 6f 6e 2e 20 20 5e 49 66 20 74 68 65 20 63  tion.  ^If the c
3750: 61 6c 6c 62 61 63 6b 20 70 6f 69 6e 74 65 72 20  allback pointer 
3760: 74 6f 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28  to sqlite3_exec(
3770: 29 0a 2a 2a 20 69 73 20 4e 55 4c 4c 2c 20 74 68  ).** is NULL, th
3780: 65 6e 20 6e 6f 20 63 61 6c 6c 62 61 63 6b 20 69  en no callback i
3790: 73 20 65 76 65 72 20 69 6e 76 6f 6b 65 64 20 61  s ever invoked a
37a0: 6e 64 20 72 65 73 75 6c 74 20 72 6f 77 73 20 61  nd result rows a
37b0: 72 65 0a 2a 2a 20 69 67 6e 6f 72 65 64 2e 0a 2a  re.** ignored..*
37c0: 2a 0a 2a 2a 20 5e 49 66 20 61 6e 20 65 72 72 6f  *.** ^If an erro
37d0: 72 20 6f 63 63 75 72 73 20 77 68 69 6c 65 20 65  r occurs while e
37e0: 76 61 6c 75 61 74 69 6e 67 20 74 68 65 20 53 51  valuating the SQ
37f0: 4c 20 73 74 61 74 65 6d 65 6e 74 73 20 70 61 73  L statements pas
3800: 73 65 64 20 69 6e 74 6f 0a 2a 2a 20 73 71 6c 69  sed into.** sqli
3810: 74 65 33 5f 65 78 65 63 28 29 2c 20 74 68 65 6e  te3_exec(), then
3820: 20 65 78 65 63 75 74 69 6f 6e 20 6f 66 20 74 68   execution of th
3830: 65 20 63 75 72 72 65 6e 74 20 73 74 61 74 65 6d  e current statem
3840: 65 6e 74 20 73 74 6f 70 73 20 61 6e 64 0a 2a 2a  ent stops and.**
3850: 20 73 75 62 73 65 71 75 65 6e 74 20 73 74 61 74   subsequent stat
3860: 65 6d 65 6e 74 73 20 61 72 65 20 73 6b 69 70 70  ements are skipp
3870: 65 64 2e 20 20 5e 49 66 20 74 68 65 20 35 74 68  ed.  ^If the 5th
3880: 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71   parameter to sq
3890: 6c 69 74 65 33 5f 65 78 65 63 28 29 0a 2a 2a 20  lite3_exec().** 
38a0: 69 73 20 6e 6f 74 20 4e 55 4c 4c 20 74 68 65 6e  is not NULL then
38b0: 20 61 6e 79 20 65 72 72 6f 72 20 6d 65 73 73 61   any error messa
38c0: 67 65 20 69 73 20 77 72 69 74 74 65 6e 20 69 6e  ge is written in
38d0: 74 6f 20 6d 65 6d 6f 72 79 20 6f 62 74 61 69 6e  to memory obtain
38e0: 65 64 0a 2a 2a 20 66 72 6f 6d 20 5b 73 71 6c 69  ed.** from [sqli
38f0: 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 20 61 6e  te3_malloc()] an
3900: 64 20 70 61 73 73 65 64 20 62 61 63 6b 20 74 68  d passed back th
3910: 72 6f 75 67 68 20 74 68 65 20 35 74 68 20 70 61  rough the 5th pa
3920: 72 61 6d 65 74 65 72 2e 0a 2a 2a 20 54 6f 20 61  rameter..** To a
3930: 76 6f 69 64 20 6d 65 6d 6f 72 79 20 6c 65 61 6b  void memory leak
3940: 73 2c 20 74 68 65 20 61 70 70 6c 69 63 61 74 69  s, the applicati
3950: 6f 6e 20 73 68 6f 75 6c 64 20 69 6e 76 6f 6b 65  on should invoke
3960: 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29   [sqlite3_free()
3970: 5d 0a 2a 2a 20 6f 6e 20 65 72 72 6f 72 20 6d 65  ].** on error me
3980: 73 73 61 67 65 20 73 74 72 69 6e 67 73 20 72 65  ssage strings re
3990: 74 75 72 6e 65 64 20 74 68 72 6f 75 67 68 20 74  turned through t
39a0: 68 65 20 35 74 68 20 70 61 72 61 6d 65 74 65 72  he 5th parameter
39b0: 20 6f 66 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 65   of.** sqlite3_e
39c0: 78 65 63 28 29 20 61 66 74 65 72 20 74 68 65 20  xec() after the 
39d0: 65 72 72 6f 72 20 6d 65 73 73 61 67 65 20 73 74  error message st
39e0: 72 69 6e 67 20 69 73 20 6e 6f 20 6c 6f 6e 67 65  ring is no longe
39f0: 72 20 6e 65 65 64 65 64 2e 0a 2a 2a 20 5e 49 66  r needed..** ^If
3a00: 20 74 68 65 20 35 74 68 20 70 61 72 61 6d 65 74   the 5th paramet
3a10: 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 65 78  er to sqlite3_ex
3a20: 65 63 28 29 20 69 73 20 6e 6f 74 20 4e 55 4c 4c  ec() is not NULL
3a30: 20 61 6e 64 20 6e 6f 20 65 72 72 6f 72 73 0a 2a   and no errors.*
3a40: 2a 20 6f 63 63 75 72 2c 20 74 68 65 6e 20 73 71  * occur, then sq
3a50: 6c 69 74 65 33 5f 65 78 65 63 28 29 20 73 65 74  lite3_exec() set
3a60: 73 20 74 68 65 20 70 6f 69 6e 74 65 72 20 69 6e  s the pointer in
3a70: 20 69 74 73 20 35 74 68 20 70 61 72 61 6d 65 74   its 5th paramet
3a80: 65 72 20 74 6f 0a 2a 2a 20 4e 55 4c 4c 20 62 65  er to.** NULL be
3a90: 66 6f 72 65 20 72 65 74 75 72 6e 69 6e 67 2e 0a  fore returning..
3aa0: 2a 2a 0a 2a 2a 20 5e 49 66 20 61 6e 20 73 71 6c  **.** ^If an sql
3ab0: 69 74 65 33 5f 65 78 65 63 28 29 20 63 61 6c 6c  ite3_exec() call
3ac0: 62 61 63 6b 20 72 65 74 75 72 6e 73 20 6e 6f 6e  back returns non
3ad0: 2d 7a 65 72 6f 2c 20 74 68 65 20 73 71 6c 69 74  -zero, the sqlit
3ae0: 65 33 5f 65 78 65 63 28 29 0a 2a 2a 20 72 6f 75  e3_exec().** rou
3af0: 74 69 6e 65 20 72 65 74 75 72 6e 73 20 53 51 4c  tine returns SQL
3b00: 49 54 45 5f 41 42 4f 52 54 20 77 69 74 68 6f 75  ITE_ABORT withou
3b10: 74 20 69 6e 76 6f 6b 69 6e 67 20 74 68 65 20 63  t invoking the c
3b20: 61 6c 6c 62 61 63 6b 20 61 67 61 69 6e 20 61 6e  allback again an
3b30: 64 0a 2a 2a 20 77 69 74 68 6f 75 74 20 72 75 6e  d.** without run
3b40: 6e 69 6e 67 20 61 6e 79 20 73 75 62 73 65 71 75  ning any subsequ
3b50: 65 6e 74 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  ent SQL statemen
3b60: 74 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 32  ts..**.** ^The 2
3b70: 6e 64 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 74  nd argument to t
3b80: 68 65 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28  he sqlite3_exec(
3b90: 29 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74  ) callback funct
3ba0: 69 6f 6e 20 69 73 20 74 68 65 0a 2a 2a 20 6e 75  ion is the.** nu
3bb0: 6d 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 20  mber of columns 
3bc0: 69 6e 20 74 68 65 20 72 65 73 75 6c 74 2e 20 20  in the result.  
3bd0: 5e 54 68 65 20 33 72 64 20 61 72 67 75 6d 65 6e  ^The 3rd argumen
3be0: 74 20 74 6f 20 74 68 65 20 73 71 6c 69 74 65 33  t to the sqlite3
3bf0: 5f 65 78 65 63 28 29 0a 2a 2a 20 63 61 6c 6c 62  _exec().** callb
3c00: 61 63 6b 20 69 73 20 61 6e 20 61 72 72 61 79 20  ack is an array 
3c10: 6f 66 20 70 6f 69 6e 74 65 72 73 20 74 6f 20 73  of pointers to s
3c20: 74 72 69 6e 67 73 20 6f 62 74 61 69 6e 65 64 20  trings obtained 
3c30: 61 73 20 69 66 20 66 72 6f 6d 0a 2a 2a 20 5b 73  as if from.** [s
3c40: 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65  qlite3_column_te
3c50: 78 74 28 29 5d 2c 20 6f 6e 65 20 66 6f 72 20 65  xt()], one for e
3c60: 61 63 68 20 63 6f 6c 75 6d 6e 2e 20 20 5e 49 66  ach column.  ^If
3c70: 20 61 6e 20 65 6c 65 6d 65 6e 74 20 6f 66 20 61   an element of a
3c80: 0a 2a 2a 20 72 65 73 75 6c 74 20 72 6f 77 20 69  .** result row i
3c90: 73 20 4e 55 4c 4c 20 74 68 65 6e 20 74 68 65 20  s NULL then the 
3ca0: 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20 73 74  corresponding st
3cb0: 72 69 6e 67 20 70 6f 69 6e 74 65 72 20 66 6f 72  ring pointer for
3cc0: 20 74 68 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f   the.** sqlite3_
3cd0: 65 78 65 63 28 29 20 63 61 6c 6c 62 61 63 6b 20  exec() callback 
3ce0: 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  is a NULL pointe
3cf0: 72 2e 20 20 5e 54 68 65 20 34 74 68 20 61 72 67  r.  ^The 4th arg
3d00: 75 6d 65 6e 74 20 74 6f 20 74 68 65 0a 2a 2a 20  ument to the.** 
3d10: 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 20 63  sqlite3_exec() c
3d20: 61 6c 6c 62 61 63 6b 20 69 73 20 61 6e 20 61 72  allback is an ar
3d30: 72 61 79 20 6f 66 20 70 6f 69 6e 74 65 72 73 20  ray of pointers 
3d40: 74 6f 20 73 74 72 69 6e 67 73 20 77 68 65 72 65  to strings where
3d50: 20 65 61 63 68 0a 2a 2a 20 65 6e 74 72 79 20 72   each.** entry r
3d60: 65 70 72 65 73 65 6e 74 73 20 74 68 65 20 6e 61  epresents the na
3d70: 6d 65 20 6f 66 20 63 6f 72 72 65 73 70 6f 6e 64  me of correspond
3d80: 69 6e 67 20 72 65 73 75 6c 74 20 63 6f 6c 75 6d  ing result colum
3d90: 6e 20 61 73 20 6f 62 74 61 69 6e 65 64 0a 2a 2a  n as obtained.**
3da0: 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 63   from [sqlite3_c
3db0: 6f 6c 75 6d 6e 5f 6e 61 6d 65 28 29 5d 2e 0a 2a  olumn_name()]..*
3dc0: 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 32 6e 64  *.** ^If the 2nd
3dd0: 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71   parameter to sq
3de0: 6c 69 74 65 33 5f 65 78 65 63 28 29 20 69 73 20  lite3_exec() is 
3df0: 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2c 20  a NULL pointer, 
3e00: 61 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 74 6f 20  a pointer.** to 
3e10: 61 6e 20 65 6d 70 74 79 20 73 74 72 69 6e 67 2c  an empty string,
3e20: 20 6f 72 20 61 20 70 6f 69 6e 74 65 72 20 74 68   or a pointer th
3e30: 61 74 20 63 6f 6e 74 61 69 6e 73 20 6f 6e 6c 79  at contains only
3e40: 20 77 68 69 74 65 73 70 61 63 65 20 61 6e 64 2f   whitespace and/
3e50: 6f 72 20 0a 2a 2a 20 53 51 4c 20 63 6f 6d 6d 65  or .** SQL comme
3e60: 6e 74 73 2c 20 74 68 65 6e 20 6e 6f 20 53 51 4c  nts, then no SQL
3e70: 20 73 74 61 74 65 6d 65 6e 74 73 20 61 72 65 20   statements are 
3e80: 65 76 61 6c 75 61 74 65 64 20 61 6e 64 20 74 68  evaluated and th
3e90: 65 20 64 61 74 61 62 61 73 65 0a 2a 2a 20 69 73  e database.** is
3ea0: 20 6e 6f 74 20 63 68 61 6e 67 65 64 2e 0a 2a 2a   not changed..**
3eb0: 0a 2a 2a 20 52 65 73 74 72 69 63 74 69 6f 6e 73  .** Restrictions
3ec0: 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20  :.**.** <ul>.** 
3ed0: 3c 6c 69 3e 20 54 68 65 20 61 70 70 6c 69 63 61  <li> The applica
3ee0: 74 69 6f 6e 20 6d 75 73 74 20 65 6e 73 75 72 65  tion must ensure
3ef0: 20 74 68 61 74 20 74 68 65 20 31 73 74 20 70 61   that the 1st pa
3f00: 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74  rameter to sqlit
3f10: 65 33 5f 65 78 65 63 28 29 0a 2a 2a 20 20 20 20  e3_exec().**    
3f20: 20 20 69 73 20 61 20 76 61 6c 69 64 20 61 6e 64    is a valid and
3f30: 20 6f 70 65 6e 20 5b 64 61 74 61 62 61 73 65 20   open [database 
3f40: 63 6f 6e 6e 65 63 74 69 6f 6e 5d 2e 0a 2a 2a 20  connection]..** 
3f50: 3c 6c 69 3e 20 54 68 65 20 61 70 70 6c 69 63 61  <li> The applica
3f60: 74 69 6f 6e 20 6d 75 73 74 20 6e 6f 74 20 63 6c  tion must not cl
3f70: 6f 73 65 20 74 68 65 20 5b 64 61 74 61 62 61 73  ose the [databas
3f80: 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 73 70  e connection] sp
3f90: 65 63 69 66 69 65 64 20 62 79 0a 2a 2a 20 20 20  ecified by.**   
3fa0: 20 20 20 74 68 65 20 31 73 74 20 70 61 72 61 6d     the 1st param
3fb0: 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f  eter to sqlite3_
3fc0: 65 78 65 63 28 29 20 77 68 69 6c 65 20 73 71 6c  exec() while sql
3fd0: 69 74 65 33 5f 65 78 65 63 28 29 20 69 73 20 72  ite3_exec() is r
3fe0: 75 6e 6e 69 6e 67 2e 0a 2a 2a 20 3c 6c 69 3e 20  unning..** <li> 
3ff0: 54 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20  The application 
4000: 6d 75 73 74 20 6e 6f 74 20 6d 6f 64 69 66 79 20  must not modify 
4010: 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  the SQL statemen
4020: 74 20 74 65 78 74 20 70 61 73 73 65 64 20 69 6e  t text passed in
4030: 74 6f 0a 2a 2a 20 20 20 20 20 20 74 68 65 20 32  to.**      the 2
4040: 6e 64 20 70 61 72 61 6d 65 74 65 72 20 6f 66 20  nd parameter of 
4050: 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 20 77  sqlite3_exec() w
4060: 68 69 6c 65 20 73 71 6c 69 74 65 33 5f 65 78 65  hile sqlite3_exe
4070: 63 28 29 20 69 73 20 72 75 6e 6e 69 6e 67 2e 0a  c() is running..
4080: 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2f 0a 69 6e 74 20  ** </ul>.*/.int 
4090: 73 71 6c 69 74 65 33 5f 65 78 65 63 28 0a 20 20  sqlite3_exec(.  
40a0: 73 71 6c 69 74 65 33 2a 2c 20 20 20 20 20 20 20  sqlite3*,       
40b0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
40c0: 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 41 6e             /* An
40d0: 20 6f 70 65 6e 20 64 61 74 61 62 61 73 65 20 2a   open database *
40e0: 2f 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a  /.  const char *
40f0: 73 71 6c 2c 20 20 20 20 20 20 20 20 20 20 20 20  sql,            
4100: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
4110: 2a 20 53 51 4c 20 74 6f 20 62 65 20 65 76 61 6c  * SQL to be eval
4120: 75 61 74 65 64 20 2a 2f 0a 20 20 69 6e 74 20 28  uated */.  int (
4130: 2a 63 61 6c 6c 62 61 63 6b 29 28 76 6f 69 64 2a  *callback)(void*
4140: 2c 69 6e 74 2c 63 68 61 72 2a 2a 2c 63 68 61 72  ,int,char**,char
4150: 2a 2a 29 2c 20 20 2f 2a 20 43 61 6c 6c 62 61 63  **),  /* Callbac
4160: 6b 20 66 75 6e 63 74 69 6f 6e 20 2a 2f 0a 20 20  k function */.  
4170: 76 6f 69 64 20 2a 2c 20 20 20 20 20 20 20 20 20  void *,         
4180: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
4190: 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 31 73             /* 1s
41a0: 74 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 63 61  t argument to ca
41b0: 6c 6c 62 61 63 6b 20 2a 2f 0a 20 20 63 68 61 72  llback */.  char
41c0: 20 2a 2a 65 72 72 6d 73 67 20 20 20 20 20 20 20   **errmsg       
41d0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
41e0: 20 20 20 20 20 20 20 2f 2a 20 45 72 72 6f 72 20         /* Error 
41f0: 6d 73 67 20 77 72 69 74 74 65 6e 20 68 65 72 65  msg written here
4200: 20 2a 2f 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41   */.);../*.** CA
4210: 50 49 33 52 45 46 3a 20 52 65 73 75 6c 74 20 43  PI3REF: Result C
4220: 6f 64 65 73 0a 2a 2a 20 4b 45 59 57 4f 52 44 53  odes.** KEYWORDS
4230: 3a 20 7b 72 65 73 75 6c 74 20 63 6f 64 65 20 64  : {result code d
4240: 65 66 69 6e 69 74 69 6f 6e 73 7d 0a 2a 2a 0a 2a  efinitions}.**.*
4250: 2a 20 4d 61 6e 79 20 53 51 4c 69 74 65 20 66 75  * Many SQLite fu
4260: 6e 63 74 69 6f 6e 73 20 72 65 74 75 72 6e 20 61  nctions return a
4270: 6e 20 69 6e 74 65 67 65 72 20 72 65 73 75 6c 74  n integer result
4280: 20 63 6f 64 65 20 66 72 6f 6d 20 74 68 65 20 73   code from the s
4290: 65 74 20 73 68 6f 77 6e 0a 2a 2a 20 68 65 72 65  et shown.** here
42a0: 20 69 6e 20 6f 72 64 65 72 20 74 6f 20 69 6e 64   in order to ind
42b0: 69 63 61 74 65 20 73 75 63 63 65 73 73 20 6f 72  icate success or
42c0: 20 66 61 69 6c 75 72 65 2e 0a 2a 2a 0a 2a 2a 20   failure..**.** 
42d0: 4e 65 77 20 65 72 72 6f 72 20 63 6f 64 65 73 20  New error codes 
42e0: 6d 61 79 20 62 65 20 61 64 64 65 64 20 69 6e 20  may be added in 
42f0: 66 75 74 75 72 65 20 76 65 72 73 69 6f 6e 73 20  future versions 
4300: 6f 66 20 53 51 4c 69 74 65 2e 0a 2a 2a 0a 2a 2a  of SQLite..**.**
4310: 20 53 65 65 20 61 6c 73 6f 3a 20 5b 65 78 74 65   See also: [exte
4320: 6e 64 65 64 20 72 65 73 75 6c 74 20 63 6f 64 65  nded result code
4330: 20 64 65 66 69 6e 69 74 69 6f 6e 73 5d 0a 2a 2f   definitions].*/
4340: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
4350: 4f 4b 20 20 20 20 20 20 20 20 20 20 20 30 20 20  OK           0  
4360: 20 2f 2a 20 53 75 63 63 65 73 73 66 75 6c 20 72   /* Successful r
4370: 65 73 75 6c 74 20 2a 2f 0a 2f 2a 20 62 65 67 69  esult */./* begi
4380: 6e 6e 69 6e 67 2d 6f 66 2d 65 72 72 6f 72 2d 63  nning-of-error-c
4390: 6f 64 65 73 20 2a 2f 0a 23 64 65 66 69 6e 65 20  odes */.#define 
43a0: 53 51 4c 49 54 45 5f 45 52 52 4f 52 20 20 20 20  SQLITE_ERROR    
43b0: 20 20 20 20 31 20 20 20 2f 2a 20 53 51 4c 20 65      1   /* SQL e
43c0: 72 72 6f 72 20 6f 72 20 6d 69 73 73 69 6e 67 20  rror or missing 
43d0: 64 61 74 61 62 61 73 65 20 2a 2f 0a 23 64 65 66  database */.#def
43e0: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4e 54 45 52  ine SQLITE_INTER
43f0: 4e 41 4c 20 20 20 20 20 32 20 20 20 2f 2a 20 49  NAL     2   /* I
4400: 6e 74 65 72 6e 61 6c 20 6c 6f 67 69 63 20 65 72  nternal logic er
4410: 72 6f 72 20 69 6e 20 53 51 4c 69 74 65 20 2a 2f  ror in SQLite */
4420: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
4430: 50 45 52 4d 20 20 20 20 20 20 20 20 20 33 20 20  PERM         3  
4440: 20 2f 2a 20 41 63 63 65 73 73 20 70 65 72 6d 69   /* Access permi
4450: 73 73 69 6f 6e 20 64 65 6e 69 65 64 20 2a 2f 0a  ssion denied */.
4460: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41  #define SQLITE_A
4470: 42 4f 52 54 20 20 20 20 20 20 20 20 34 20 20 20  BORT        4   
4480: 2f 2a 20 43 61 6c 6c 62 61 63 6b 20 72 6f 75 74  /* Callback rout
4490: 69 6e 65 20 72 65 71 75 65 73 74 65 64 20 61 6e  ine requested an
44a0: 20 61 62 6f 72 74 20 2a 2f 0a 23 64 65 66 69 6e   abort */.#defin
44b0: 65 20 53 51 4c 49 54 45 5f 42 55 53 59 20 20 20  e SQLITE_BUSY   
44c0: 20 20 20 20 20 20 35 20 20 20 2f 2a 20 54 68 65        5   /* The
44d0: 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 69   database file i
44e0: 73 20 6c 6f 63 6b 65 64 20 2a 2f 0a 23 64 65 66  s locked */.#def
44f0: 69 6e 65 20 53 51 4c 49 54 45 5f 4c 4f 43 4b 45  ine SQLITE_LOCKE
4500: 44 20 20 20 20 20 20 20 36 20 20 20 2f 2a 20 41  D       6   /* A
4510: 20 74 61 62 6c 65 20 69 6e 20 74 68 65 20 64 61   table in the da
4520: 74 61 62 61 73 65 20 69 73 20 6c 6f 63 6b 65 64  tabase is locked
4530: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
4540: 54 45 5f 4e 4f 4d 45 4d 20 20 20 20 20 20 20 20  TE_NOMEM        
4550: 37 20 20 20 2f 2a 20 41 20 6d 61 6c 6c 6f 63 28  7   /* A malloc(
4560: 29 20 66 61 69 6c 65 64 20 2a 2f 0a 23 64 65 66  ) failed */.#def
4570: 69 6e 65 20 53 51 4c 49 54 45 5f 52 45 41 44 4f  ine SQLITE_READO
4580: 4e 4c 59 20 20 20 20 20 38 20 20 20 2f 2a 20 41  NLY     8   /* A
4590: 74 74 65 6d 70 74 20 74 6f 20 77 72 69 74 65 20  ttempt to write 
45a0: 61 20 72 65 61 64 6f 6e 6c 79 20 64 61 74 61 62  a readonly datab
45b0: 61 73 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ase */.#define S
45c0: 51 4c 49 54 45 5f 49 4e 54 45 52 52 55 50 54 20  QLITE_INTERRUPT 
45d0: 20 20 20 39 20 20 20 2f 2a 20 4f 70 65 72 61 74     9   /* Operat
45e0: 69 6f 6e 20 74 65 72 6d 69 6e 61 74 65 64 20 62  ion terminated b
45f0: 79 20 73 71 6c 69 74 65 33 5f 69 6e 74 65 72 72  y sqlite3_interr
4600: 75 70 74 28 29 2a 2f 0a 23 64 65 66 69 6e 65 20  upt()*/.#define 
4610: 53 51 4c 49 54 45 5f 49 4f 45 52 52 20 20 20 20  SQLITE_IOERR    
4620: 20 20 20 31 30 20 20 20 2f 2a 20 53 6f 6d 65 20     10   /* Some 
4630: 6b 69 6e 64 20 6f 66 20 64 69 73 6b 20 49 2f 4f  kind of disk I/O
4640: 20 65 72 72 6f 72 20 6f 63 63 75 72 72 65 64 20   error occurred 
4650: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
4660: 45 5f 43 4f 52 52 55 50 54 20 20 20 20 20 31 31  E_CORRUPT     11
4670: 20 20 20 2f 2a 20 54 68 65 20 64 61 74 61 62 61     /* The databa
4680: 73 65 20 64 69 73 6b 20 69 6d 61 67 65 20 69 73  se disk image is
4690: 20 6d 61 6c 66 6f 72 6d 65 64 20 2a 2f 0a 23 64   malformed */.#d
46a0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4e 4f 54  efine SQLITE_NOT
46b0: 46 4f 55 4e 44 20 20 20 20 31 32 20 20 20 2f 2a  FOUND    12   /*
46c0: 20 55 6e 6b 6e 6f 77 6e 20 6f 70 63 6f 64 65 20   Unknown opcode 
46d0: 69 6e 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 5f  in sqlite3_file_
46e0: 63 6f 6e 74 72 6f 6c 28 29 20 2a 2f 0a 23 64 65  control() */.#de
46f0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 55 4c 4c  fine SQLITE_FULL
4700: 20 20 20 20 20 20 20 20 31 33 20 20 20 2f 2a 20          13   /* 
4710: 49 6e 73 65 72 74 69 6f 6e 20 66 61 69 6c 65 64  Insertion failed
4720: 20 62 65 63 61 75 73 65 20 64 61 74 61 62 61 73   because databas
4730: 65 20 69 73 20 66 75 6c 6c 20 2a 2f 0a 23 64 65  e is full */.#de
4740: 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 41 4e 54  fine SQLITE_CANT
4750: 4f 50 45 4e 20 20 20 20 31 34 20 20 20 2f 2a 20  OPEN    14   /* 
4760: 55 6e 61 62 6c 65 20 74 6f 20 6f 70 65 6e 20 74  Unable to open t
4770: 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65  he database file
4780: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
4790: 54 45 5f 50 52 4f 54 4f 43 4f 4c 20 20 20 20 31  TE_PROTOCOL    1
47a0: 35 20 20 20 2f 2a 20 44 61 74 61 62 61 73 65 20  5   /* Database 
47b0: 6c 6f 63 6b 20 70 72 6f 74 6f 63 6f 6c 20 65 72  lock protocol er
47c0: 72 6f 72 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ror */.#define S
47d0: 51 4c 49 54 45 5f 45 4d 50 54 59 20 20 20 20 20  QLITE_EMPTY     
47e0: 20 20 31 36 20 20 20 2f 2a 20 44 61 74 61 62 61    16   /* Databa
47f0: 73 65 20 69 73 20 65 6d 70 74 79 20 2a 2f 0a 23  se is empty */.#
4800: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53 43  define SQLITE_SC
4810: 48 45 4d 41 20 20 20 20 20 20 31 37 20 20 20 2f  HEMA      17   /
4820: 2a 20 54 68 65 20 64 61 74 61 62 61 73 65 20 73  * The database s
4830: 63 68 65 6d 61 20 63 68 61 6e 67 65 64 20 2a 2f  chema changed */
4840: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
4850: 54 4f 4f 42 49 47 20 20 20 20 20 20 31 38 20 20  TOOBIG      18  
4860: 20 2f 2a 20 53 74 72 69 6e 67 20 6f 72 20 42 4c   /* String or BL
4870: 4f 42 20 65 78 63 65 65 64 73 20 73 69 7a 65 20  OB exceeds size 
4880: 6c 69 6d 69 74 20 2a 2f 0a 23 64 65 66 69 6e 65  limit */.#define
4890: 20 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49   SQLITE_CONSTRAI
48a0: 4e 54 20 20 31 39 20 20 20 2f 2a 20 41 62 6f 72  NT  19   /* Abor
48b0: 74 20 64 75 65 20 74 6f 20 63 6f 6e 73 74 72 61  t due to constra
48c0: 69 6e 74 20 76 69 6f 6c 61 74 69 6f 6e 20 2a 2f  int violation */
48d0: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
48e0: 4d 49 53 4d 41 54 43 48 20 20 20 20 32 30 20 20  MISMATCH    20  
48f0: 20 2f 2a 20 44 61 74 61 20 74 79 70 65 20 6d 69   /* Data type mi
4900: 73 6d 61 74 63 68 20 2a 2f 0a 23 64 65 66 69 6e  smatch */.#defin
4910: 65 20 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 20  e SQLITE_MISUSE 
4920: 20 20 20 20 20 32 31 20 20 20 2f 2a 20 4c 69 62       21   /* Lib
4930: 72 61 72 79 20 75 73 65 64 20 69 6e 63 6f 72 72  rary used incorr
4940: 65 63 74 6c 79 20 2a 2f 0a 23 64 65 66 69 6e 65  ectly */.#define
4950: 20 53 51 4c 49 54 45 5f 4e 4f 4c 46 53 20 20 20   SQLITE_NOLFS   
4960: 20 20 20 20 32 32 20 20 20 2f 2a 20 55 73 65 73      22   /* Uses
4970: 20 4f 53 20 66 65 61 74 75 72 65 73 20 6e 6f 74   OS features not
4980: 20 73 75 70 70 6f 72 74 65 64 20 6f 6e 20 68 6f   supported on ho
4990: 73 74 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  st */.#define SQ
49a0: 4c 49 54 45 5f 41 55 54 48 20 20 20 20 20 20 20  LITE_AUTH       
49b0: 20 32 33 20 20 20 2f 2a 20 41 75 74 68 6f 72 69   23   /* Authori
49c0: 7a 61 74 69 6f 6e 20 64 65 6e 69 65 64 20 2a 2f  zation denied */
49d0: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
49e0: 46 4f 52 4d 41 54 20 20 20 20 20 20 32 34 20 20  FORMAT      24  
49f0: 20 2f 2a 20 41 75 78 69 6c 69 61 72 79 20 64 61   /* Auxiliary da
4a00: 74 61 62 61 73 65 20 66 6f 72 6d 61 74 20 65 72  tabase format er
4a10: 72 6f 72 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ror */.#define S
4a20: 51 4c 49 54 45 5f 52 41 4e 47 45 20 20 20 20 20  QLITE_RANGE     
4a30: 20 20 32 35 20 20 20 2f 2a 20 32 6e 64 20 70 61    25   /* 2nd pa
4a40: 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74  rameter to sqlit
4a50: 65 33 5f 62 69 6e 64 20 6f 75 74 20 6f 66 20 72  e3_bind out of r
4a60: 61 6e 67 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20  ange */.#define 
4a70: 53 51 4c 49 54 45 5f 4e 4f 54 41 44 42 20 20 20  SQLITE_NOTADB   
4a80: 20 20 20 32 36 20 20 20 2f 2a 20 46 69 6c 65 20     26   /* File 
4a90: 6f 70 65 6e 65 64 20 74 68 61 74 20 69 73 20 6e  opened that is n
4aa0: 6f 74 20 61 20 64 61 74 61 62 61 73 65 20 66 69  ot a database fi
4ab0: 6c 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  le */.#define SQ
4ac0: 4c 49 54 45 5f 4e 4f 54 49 43 45 20 20 20 20 20  LITE_NOTICE     
4ad0: 20 32 37 20 20 20 2f 2a 20 4e 6f 74 69 66 69 63   27   /* Notific
4ae0: 61 74 69 6f 6e 73 20 66 72 6f 6d 20 73 71 6c 69  ations from sqli
4af0: 74 65 33 5f 6c 6f 67 28 29 20 2a 2f 0a 23 64 65  te3_log() */.#de
4b00: 66 69 6e 65 20 53 51 4c 49 54 45 5f 57 41 52 4e  fine SQLITE_WARN
4b10: 49 4e 47 20 20 20 20 20 32 38 20 20 20 2f 2a 20  ING     28   /* 
4b20: 57 61 72 6e 69 6e 67 73 20 66 72 6f 6d 20 73 71  Warnings from sq
4b30: 6c 69 74 65 33 5f 6c 6f 67 28 29 20 2a 2f 0a 23  lite3_log() */.#
4b40: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 52 4f  define SQLITE_RO
4b50: 57 20 20 20 20 20 20 20 20 20 31 30 30 20 20 2f  W         100  /
4b60: 2a 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29  * sqlite3_step()
4b70: 20 68 61 73 20 61 6e 6f 74 68 65 72 20 72 6f 77   has another row
4b80: 20 72 65 61 64 79 20 2a 2f 0a 23 64 65 66 69 6e   ready */.#defin
4b90: 65 20 53 51 4c 49 54 45 5f 44 4f 4e 45 20 20 20  e SQLITE_DONE   
4ba0: 20 20 20 20 20 31 30 31 20 20 2f 2a 20 73 71 6c       101  /* sql
4bb0: 69 74 65 33 5f 73 74 65 70 28 29 20 68 61 73 20  ite3_step() has 
4bc0: 66 69 6e 69 73 68 65 64 20 65 78 65 63 75 74 69  finished executi
4bd0: 6e 67 20 2a 2f 0a 2f 2a 20 65 6e 64 2d 6f 66 2d  ng */./* end-of-
4be0: 65 72 72 6f 72 2d 63 6f 64 65 73 20 2a 2f 0a 0a  error-codes */..
4bf0: 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
4c00: 45 78 74 65 6e 64 65 64 20 52 65 73 75 6c 74 20  Extended Result 
4c10: 43 6f 64 65 73 0a 2a 2a 20 4b 45 59 57 4f 52 44  Codes.** KEYWORD
4c20: 53 3a 20 7b 65 78 74 65 6e 64 65 64 20 72 65 73  S: {extended res
4c30: 75 6c 74 20 63 6f 64 65 20 64 65 66 69 6e 69 74  ult code definit
4c40: 69 6f 6e 73 7d 0a 2a 2a 0a 2a 2a 20 49 6e 20 69  ions}.**.** In i
4c50: 74 73 20 64 65 66 61 75 6c 74 20 63 6f 6e 66 69  ts default confi
4c60: 67 75 72 61 74 69 6f 6e 2c 20 53 51 4c 69 74 65  guration, SQLite
4c70: 20 41 50 49 20 72 6f 75 74 69 6e 65 73 20 72 65   API routines re
4c80: 74 75 72 6e 20 6f 6e 65 20 6f 66 20 33 30 20 69  turn one of 30 i
4c90: 6e 74 65 67 65 72 0a 2a 2a 20 5b 72 65 73 75 6c  nteger.** [resul
4ca0: 74 20 63 6f 64 65 73 5d 2e 20 20 48 6f 77 65 76  t codes].  Howev
4cb0: 65 72 2c 20 65 78 70 65 72 69 65 6e 63 65 20 68  er, experience h
4cc0: 61 73 20 73 68 6f 77 6e 20 74 68 61 74 20 6d 61  as shown that ma
4cd0: 6e 79 20 6f 66 0a 2a 2a 20 74 68 65 73 65 20 72  ny of.** these r
4ce0: 65 73 75 6c 74 20 63 6f 64 65 73 20 61 72 65 20  esult codes are 
4cf0: 74 6f 6f 20 63 6f 61 72 73 65 2d 67 72 61 69 6e  too coarse-grain
4d00: 65 64 2e 20 20 54 68 65 79 20 64 6f 20 6e 6f 74  ed.  They do not
4d10: 20 70 72 6f 76 69 64 65 20 61 73 0a 2a 2a 20 6d   provide as.** m
4d20: 75 63 68 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20  uch information 
4d30: 61 62 6f 75 74 20 70 72 6f 62 6c 65 6d 73 20 61  about problems a
4d40: 73 20 70 72 6f 67 72 61 6d 6d 65 72 73 20 6d 69  s programmers mi
4d50: 67 68 74 20 6c 69 6b 65 2e 20 20 49 6e 20 61 6e  ght like.  In an
4d60: 20 65 66 66 6f 72 74 20 74 6f 0a 2a 2a 20 61 64   effort to.** ad
4d70: 64 72 65 73 73 20 74 68 69 73 2c 20 6e 65 77 65  dress this, newe
4d80: 72 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 53 51  r versions of SQ
4d90: 4c 69 74 65 20 28 76 65 72 73 69 6f 6e 20 33 2e  Lite (version 3.
4da0: 33 2e 38 20 61 6e 64 20 6c 61 74 65 72 29 20 69  3.8 and later) i
4db0: 6e 63 6c 75 64 65 0a 2a 2a 20 73 75 70 70 6f 72  nclude.** suppor
4dc0: 74 20 66 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c  t for additional
4dd0: 20 72 65 73 75 6c 74 20 63 6f 64 65 73 20 74 68   result codes th
4de0: 61 74 20 70 72 6f 76 69 64 65 20 6d 6f 72 65 20  at provide more 
4df0: 64 65 74 61 69 6c 65 64 20 69 6e 66 6f 72 6d 61  detailed informa
4e00: 74 69 6f 6e 0a 2a 2a 20 61 62 6f 75 74 20 65 72  tion.** about er
4e10: 72 6f 72 73 2e 20 54 68 65 73 65 20 5b 65 78 74  rors. These [ext
4e20: 65 6e 64 65 64 20 72 65 73 75 6c 74 20 63 6f 64  ended result cod
4e30: 65 73 5d 20 61 72 65 20 65 6e 61 62 6c 65 64 20  es] are enabled 
4e40: 6f 72 20 64 69 73 61 62 6c 65 64 0a 2a 2a 20 6f  or disabled.** o
4e50: 6e 20 61 20 70 65 72 20 64 61 74 61 62 61 73 65  n a per database
4e60: 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 62 61 73 69   connection basi
4e70: 73 20 75 73 69 6e 67 20 74 68 65 0a 2a 2a 20 5b  s using the.** [
4e80: 73 71 6c 69 74 65 33 5f 65 78 74 65 6e 64 65 64  sqlite3_extended
4e90: 5f 72 65 73 75 6c 74 5f 63 6f 64 65 73 28 29 5d  _result_codes()]
4ea0: 20 41 50 49 2e 20 20 4f 72 2c 20 74 68 65 20 65   API.  Or, the e
4eb0: 78 74 65 6e 64 65 64 20 63 6f 64 65 20 66 6f 72  xtended code for
4ec0: 0a 2a 2a 20 74 68 65 20 6d 6f 73 74 20 72 65 63  .** the most rec
4ed0: 65 6e 74 20 65 72 72 6f 72 20 63 61 6e 20 62 65  ent error can be
4ee0: 20 6f 62 74 61 69 6e 65 64 20 75 73 69 6e 67 0a   obtained using.
4ef0: 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 65 78 74 65  ** [sqlite3_exte
4f00: 6e 64 65 64 5f 65 72 72 63 6f 64 65 28 29 5d 2e  nded_errcode()].
4f10: 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  .*/.#define SQLI
4f20: 54 45 5f 49 4f 45 52 52 5f 52 45 41 44 20 20 20  TE_IOERR_READ   
4f30: 20 20 20 20 20 20 20 20 20 20 20 28 53 51 4c 49             (SQLI
4f40: 54 45 5f 49 4f 45 52 52 20 7c 20 28 31 3c 3c 38  TE_IOERR | (1<<8
4f50: 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  )).#define SQLIT
4f60: 45 5f 49 4f 45 52 52 5f 53 48 4f 52 54 5f 52 45  E_IOERR_SHORT_RE
4f70: 41 44 20 20 20 20 20 20 20 20 28 53 51 4c 49 54  AD        (SQLIT
4f80: 45 5f 49 4f 45 52 52 20 7c 20 28 32 3c 3c 38 29  E_IOERR | (2<<8)
4f90: 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  ).#define SQLITE
4fa0: 5f 49 4f 45 52 52 5f 57 52 49 54 45 20 20 20 20  _IOERR_WRITE    
4fb0: 20 20 20 20 20 20 20 20 20 28 53 51 4c 49 54 45           (SQLITE
4fc0: 5f 49 4f 45 52 52 20 7c 20 28 33 3c 3c 38 29 29  _IOERR | (3<<8))
4fd0: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
4fe0: 49 4f 45 52 52 5f 46 53 59 4e 43 20 20 20 20 20  IOERR_FSYNC     
4ff0: 20 20 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f          (SQLITE_
5000: 49 4f 45 52 52 20 7c 20 28 34 3c 3c 38 29 29 0a  IOERR | (4<<8)).
5010: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49  #define SQLITE_I
5020: 4f 45 52 52 5f 44 49 52 5f 46 53 59 4e 43 20 20  OERR_DIR_FSYNC  
5030: 20 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 49         (SQLITE_I
5040: 4f 45 52 52 20 7c 20 28 35 3c 3c 38 29 29 0a 23  OERR | (5<<8)).#
5050: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f  define SQLITE_IO
5060: 45 52 52 5f 54 52 55 4e 43 41 54 45 20 20 20 20  ERR_TRUNCATE    
5070: 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 49 4f        (SQLITE_IO
5080: 45 52 52 20 7c 20 28 36 3c 3c 38 29 29 0a 23 64  ERR | (6<<8)).#d
5090: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45  efine SQLITE_IOE
50a0: 52 52 5f 46 53 54 41 54 20 20 20 20 20 20 20 20  RR_FSTAT        
50b0: 20 20 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45       (SQLITE_IOE
50c0: 52 52 20 7c 20 28 37 3c 3c 38 29 29 0a 23 64 65  RR | (7<<8)).#de
50d0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52  fine SQLITE_IOER
50e0: 52 5f 55 4e 4c 4f 43 4b 20 20 20 20 20 20 20 20  R_UNLOCK        
50f0: 20 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52      (SQLITE_IOER
5100: 52 20 7c 20 28 38 3c 3c 38 29 29 0a 23 64 65 66  R | (8<<8)).#def
5110: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
5120: 5f 52 44 4c 4f 43 4b 20 20 20 20 20 20 20 20 20  _RDLOCK         
5130: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
5140: 20 7c 20 28 39 3c 3c 38 29 29 0a 23 64 65 66 69   | (9<<8)).#defi
5150: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5160: 44 45 4c 45 54 45 20 20 20 20 20 20 20 20 20 20  DELETE          
5170: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5180: 7c 20 28 31 30 3c 3c 38 29 29 0a 23 64 65 66 69  | (10<<8)).#defi
5190: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
51a0: 42 4c 4f 43 4b 45 44 20 20 20 20 20 20 20 20 20  BLOCKED         
51b0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
51c0: 7c 20 28 31 31 3c 3c 38 29 29 0a 23 64 65 66 69  | (11<<8)).#defi
51d0: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
51e0: 4e 4f 4d 45 4d 20 20 20 20 20 20 20 20 20 20 20  NOMEM           
51f0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5200: 7c 20 28 31 32 3c 3c 38 29 29 0a 23 64 65 66 69  | (12<<8)).#defi
5210: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5220: 41 43 43 45 53 53 20 20 20 20 20 20 20 20 20 20  ACCESS          
5230: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5240: 7c 20 28 31 33 3c 3c 38 29 29 0a 23 64 65 66 69  | (13<<8)).#defi
5250: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5260: 43 48 45 43 4b 52 45 53 45 52 56 45 44 4c 4f 43  CHECKRESERVEDLOC
5270: 4b 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20  K (SQLITE_IOERR 
5280: 7c 20 28 31 34 3c 3c 38 29 29 0a 23 64 65 66 69  | (14<<8)).#defi
5290: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
52a0: 4c 4f 43 4b 20 20 20 20 20 20 20 20 20 20 20 20  LOCK            
52b0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
52c0: 7c 20 28 31 35 3c 3c 38 29 29 0a 23 64 65 66 69  | (15<<8)).#defi
52d0: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
52e0: 43 4c 4f 53 45 20 20 20 20 20 20 20 20 20 20 20  CLOSE           
52f0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5300: 7c 20 28 31 36 3c 3c 38 29 29 0a 23 64 65 66 69  | (16<<8)).#defi
5310: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5320: 44 49 52 5f 43 4c 4f 53 45 20 20 20 20 20 20 20  DIR_CLOSE       
5330: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5340: 7c 20 28 31 37 3c 3c 38 29 29 0a 23 64 65 66 69  | (17<<8)).#defi
5350: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5360: 53 48 4d 4f 50 45 4e 20 20 20 20 20 20 20 20 20  SHMOPEN         
5370: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5380: 7c 20 28 31 38 3c 3c 38 29 29 0a 23 64 65 66 69  | (18<<8)).#defi
5390: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
53a0: 53 48 4d 53 49 5a 45 20 20 20 20 20 20 20 20 20  SHMSIZE         
53b0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
53c0: 7c 20 28 31 39 3c 3c 38 29 29 0a 23 64 65 66 69  | (19<<8)).#defi
53d0: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
53e0: 53 48 4d 4c 4f 43 4b 20 20 20 20 20 20 20 20 20  SHMLOCK         
53f0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5400: 7c 20 28 32 30 3c 3c 38 29 29 0a 23 64 65 66 69  | (20<<8)).#defi
5410: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5420: 53 48 4d 4d 41 50 20 20 20 20 20 20 20 20 20 20  SHMMAP          
5430: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5440: 7c 20 28 32 31 3c 3c 38 29 29 0a 23 64 65 66 69  | (21<<8)).#defi
5450: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5460: 53 45 45 4b 20 20 20 20 20 20 20 20 20 20 20 20  SEEK            
5470: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5480: 7c 20 28 32 32 3c 3c 38 29 29 0a 23 64 65 66 69  | (22<<8)).#defi
5490: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
54a0: 44 45 4c 45 54 45 5f 4e 4f 45 4e 54 20 20 20 20  DELETE_NOENT    
54b0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
54c0: 7c 20 28 32 33 3c 3c 38 29 29 0a 23 64 65 66 69  | (23<<8)).#defi
54d0: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
54e0: 4d 4d 41 50 20 20 20 20 20 20 20 20 20 20 20 20  MMAP            
54f0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5500: 7c 20 28 32 34 3c 3c 38 29 29 0a 23 64 65 66 69  | (24<<8)).#defi
5510: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5520: 47 45 54 54 45 4d 50 50 41 54 48 20 20 20 20 20  GETTEMPPATH     
5530: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5540: 7c 20 28 32 35 3c 3c 38 29 29 0a 23 64 65 66 69  | (25<<8)).#defi
5550: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
5560: 43 4f 4e 56 50 41 54 48 20 20 20 20 20 20 20 20  CONVPATH        
5570: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5580: 7c 20 28 32 36 3c 3c 38 29 29 0a 23 64 65 66 69  | (26<<8)).#defi
5590: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
55a0: 56 4e 4f 44 45 20 20 20 20 20 20 20 20 20 20 20  VNODE           
55b0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
55c0: 7c 20 28 32 37 3c 3c 38 29 29 0a 23 64 65 66 69  | (27<<8)).#defi
55d0: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
55e0: 41 55 54 48 20 20 20 20 20 20 20 20 20 20 20 20  AUTH            
55f0: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
5600: 7c 20 28 32 38 3c 3c 38 29 29 0a 23 64 65 66 69  | (28<<8)).#defi
5610: 6e 65 20 53 51 4c 49 54 45 5f 4c 4f 43 4b 45 44  ne SQLITE_LOCKED
5620: 5f 53 48 41 52 45 44 43 41 43 48 45 20 20 20 20  _SHAREDCACHE    
5630: 20 20 28 53 51 4c 49 54 45 5f 4c 4f 43 4b 45 44    (SQLITE_LOCKED
5640: 20 7c 20 20 28 31 3c 3c 38 29 29 0a 23 64 65 66   |  (1<<8)).#def
5650: 69 6e 65 20 53 51 4c 49 54 45 5f 42 55 53 59 5f  ine SQLITE_BUSY_
5660: 52 45 43 4f 56 45 52 59 20 20 20 20 20 20 20 20  RECOVERY        
5670: 20 20 20 28 53 51 4c 49 54 45 5f 42 55 53 59 20     (SQLITE_BUSY 
5680: 20 20 7c 20 20 28 31 3c 3c 38 29 29 0a 23 64 65    |  (1<<8)).#de
5690: 66 69 6e 65 20 53 51 4c 49 54 45 5f 42 55 53 59  fine SQLITE_BUSY
56a0: 5f 53 4e 41 50 53 48 4f 54 20 20 20 20 20 20 20  _SNAPSHOT       
56b0: 20 20 20 20 28 53 51 4c 49 54 45 5f 42 55 53 59      (SQLITE_BUSY
56c0: 20 20 20 7c 20 20 28 32 3c 3c 38 29 29 0a 23 64     |  (2<<8)).#d
56d0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 41 4e  efine SQLITE_CAN
56e0: 54 4f 50 45 4e 5f 4e 4f 54 45 4d 50 44 49 52 20  TOPEN_NOTEMPDIR 
56f0: 20 20 20 20 20 28 53 51 4c 49 54 45 5f 43 41 4e       (SQLITE_CAN
5700: 54 4f 50 45 4e 20 7c 20 28 31 3c 3c 38 29 29 0a  TOPEN | (1<<8)).
5710: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43  #define SQLITE_C
5720: 41 4e 54 4f 50 45 4e 5f 49 53 44 49 52 20 20 20  ANTOPEN_ISDIR   
5730: 20 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 43         (SQLITE_C
5740: 41 4e 54 4f 50 45 4e 20 7c 20 28 32 3c 3c 38 29  ANTOPEN | (2<<8)
5750: 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  ).#define SQLITE
5760: 5f 43 41 4e 54 4f 50 45 4e 5f 46 55 4c 4c 50 41  _CANTOPEN_FULLPA
5770: 54 48 20 20 20 20 20 20 20 28 53 51 4c 49 54 45  TH       (SQLITE
5780: 5f 43 41 4e 54 4f 50 45 4e 20 7c 20 28 33 3c 3c  _CANTOPEN | (3<<
5790: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
57a0: 54 45 5f 43 41 4e 54 4f 50 45 4e 5f 43 4f 4e 56  TE_CANTOPEN_CONV
57b0: 50 41 54 48 20 20 20 20 20 20 20 28 53 51 4c 49  PATH       (SQLI
57c0: 54 45 5f 43 41 4e 54 4f 50 45 4e 20 7c 20 28 34  TE_CANTOPEN | (4
57d0: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
57e0: 4c 49 54 45 5f 43 4f 52 52 55 50 54 5f 56 54 41  LITE_CORRUPT_VTA
57f0: 42 20 20 20 20 20 20 20 20 20 20 20 20 28 53 51  B            (SQ
5800: 4c 49 54 45 5f 43 4f 52 52 55 50 54 20 7c 20 28  LITE_CORRUPT | (
5810: 31 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53  1<<8)).#define S
5820: 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c 59 5f 52  QLITE_READONLY_R
5830: 45 43 4f 56 45 52 59 20 20 20 20 20 20 20 28 53  ECOVERY       (S
5840: 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c 59 20 7c  QLITE_READONLY |
5850: 20 28 31 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65   (1<<8)).#define
5860: 20 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c 59   SQLITE_READONLY
5870: 5f 43 41 4e 54 4c 4f 43 4b 20 20 20 20 20 20 20  _CANTLOCK       
5880: 28 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c 59  (SQLITE_READONLY
5890: 20 7c 20 28 32 3c 3c 38 29 29 0a 23 64 65 66 69   | (2<<8)).#defi
58a0: 6e 65 20 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e  ne SQLITE_READON
58b0: 4c 59 5f 52 4f 4c 4c 42 41 43 4b 20 20 20 20 20  LY_ROLLBACK     
58c0: 20 20 28 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e    (SQLITE_READON
58d0: 4c 59 20 7c 20 28 33 3c 3c 38 29 29 0a 23 64 65  LY | (3<<8)).#de
58e0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 52 45 41 44  fine SQLITE_READ
58f0: 4f 4e 4c 59 5f 44 42 4d 4f 56 45 44 20 20 20 20  ONLY_DBMOVED    
5900: 20 20 20 20 28 53 51 4c 49 54 45 5f 52 45 41 44      (SQLITE_READ
5910: 4f 4e 4c 59 20 7c 20 28 34 3c 3c 38 29 29 0a 23  ONLY | (4<<8)).#
5920: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41 42  define SQLITE_AB
5930: 4f 52 54 5f 52 4f 4c 4c 42 41 43 4b 20 20 20 20  ORT_ROLLBACK    
5940: 20 20 20 20 20 20 28 53 51 4c 49 54 45 5f 41 42        (SQLITE_AB
5950: 4f 52 54 20 7c 20 28 32 3c 3c 38 29 29 0a 23 64  ORT | (2<<8)).#d
5960: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e  efine SQLITE_CON
5970: 53 54 52 41 49 4e 54 5f 43 48 45 43 4b 20 20 20  STRAINT_CHECK   
5980: 20 20 20 20 20 28 53 51 4c 49 54 45 5f 43 4f 4e       (SQLITE_CON
5990: 53 54 52 41 49 4e 54 20 7c 20 28 31 3c 3c 38 29  STRAINT | (1<<8)
59a0: 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  ).#define SQLITE
59b0: 5f 43 4f 4e 53 54 52 41 49 4e 54 5f 43 4f 4d 4d  _CONSTRAINT_COMM
59c0: 49 54 48 4f 4f 4b 20 20 20 28 53 51 4c 49 54 45  ITHOOK   (SQLITE
59d0: 5f 43 4f 4e 53 54 52 41 49 4e 54 20 7c 20 28 32  _CONSTRAINT | (2
59e0: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
59f0: 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49 4e 54 5f  LITE_CONSTRAINT_
5a00: 46 4f 52 45 49 47 4e 4b 45 59 20 20 20 28 53 51  FOREIGNKEY   (SQ
5a10: 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49 4e 54 20  LITE_CONSTRAINT 
5a20: 7c 20 28 33 3c 3c 38 29 29 0a 23 64 65 66 69 6e  | (3<<8)).#defin
5a30: 65 20 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41  e SQLITE_CONSTRA
5a40: 49 4e 54 5f 46 55 4e 43 54 49 4f 4e 20 20 20 20  INT_FUNCTION    
5a50: 20 28 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41   (SQLITE_CONSTRA
5a60: 49 4e 54 20 7c 20 28 34 3c 3c 38 29 29 0a 23 64  INT | (4<<8)).#d
5a70: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e  efine SQLITE_CON
5a80: 53 54 52 41 49 4e 54 5f 4e 4f 54 4e 55 4c 4c 20  STRAINT_NOTNULL 
5a90: 20 20 20 20 20 28 53 51 4c 49 54 45 5f 43 4f 4e       (SQLITE_CON
5aa0: 53 54 52 41 49 4e 54 20 7c 20 28 35 3c 3c 38 29  STRAINT | (5<<8)
5ab0: 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  ).#define SQLITE
5ac0: 5f 43 4f 4e 53 54 52 41 49 4e 54 5f 50 52 49 4d  _CONSTRAINT_PRIM
5ad0: 41 52 59 4b 45 59 20 20 20 28 53 51 4c 49 54 45  ARYKEY   (SQLITE
5ae0: 5f 43 4f 4e 53 54 52 41 49 4e 54 20 7c 20 28 36  _CONSTRAINT | (6
5af0: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
5b00: 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49 4e 54 5f  LITE_CONSTRAINT_
5b10: 54 52 49 47 47 45 52 20 20 20 20 20 20 28 53 51  TRIGGER      (SQ
5b20: 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49 4e 54 20  LITE_CONSTRAINT 
5b30: 7c 20 28 37 3c 3c 38 29 29 0a 23 64 65 66 69 6e  | (7<<8)).#defin
5b40: 65 20 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41  e SQLITE_CONSTRA
5b50: 49 4e 54 5f 55 4e 49 51 55 45 20 20 20 20 20 20  INT_UNIQUE      
5b60: 20 28 53 51 4c 49 54 45 5f 43 4f 4e 53 54 52 41   (SQLITE_CONSTRA
5b70: 49 4e 54 20 7c 20 28 38 3c 3c 38 29 29 0a 23 64  INT | (8<<8)).#d
5b80: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e  efine SQLITE_CON
5b90: 53 54 52 41 49 4e 54 5f 56 54 41 42 20 20 20 20  STRAINT_VTAB    
5ba0: 20 20 20 20 20 28 53 51 4c 49 54 45 5f 43 4f 4e       (SQLITE_CON
5bb0: 53 54 52 41 49 4e 54 20 7c 20 28 39 3c 3c 38 29  STRAINT | (9<<8)
5bc0: 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  ).#define SQLITE
5bd0: 5f 43 4f 4e 53 54 52 41 49 4e 54 5f 52 4f 57 49  _CONSTRAINT_ROWI
5be0: 44 20 20 20 20 20 20 20 20 28 53 51 4c 49 54 45  D        (SQLITE
5bf0: 5f 43 4f 4e 53 54 52 41 49 4e 54 20 7c 28 31 30  _CONSTRAINT |(10
5c00: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
5c10: 4c 49 54 45 5f 4e 4f 54 49 43 45 5f 52 45 43 4f  LITE_NOTICE_RECO
5c20: 56 45 52 5f 57 41 4c 20 20 20 20 20 20 28 53 51  VER_WAL      (SQ
5c30: 4c 49 54 45 5f 4e 4f 54 49 43 45 20 7c 20 28 31  LITE_NOTICE | (1
5c40: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
5c50: 4c 49 54 45 5f 4e 4f 54 49 43 45 5f 52 45 43 4f  LITE_NOTICE_RECO
5c60: 56 45 52 5f 52 4f 4c 4c 42 41 43 4b 20 28 53 51  VER_ROLLBACK (SQ
5c70: 4c 49 54 45 5f 4e 4f 54 49 43 45 20 7c 20 28 32  LITE_NOTICE | (2
5c80: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
5c90: 4c 49 54 45 5f 57 41 52 4e 49 4e 47 5f 41 55 54  LITE_WARNING_AUT
5ca0: 4f 49 4e 44 45 58 20 20 20 20 20 20 20 28 53 51  OINDEX       (SQ
5cb0: 4c 49 54 45 5f 57 41 52 4e 49 4e 47 20 7c 20 28  LITE_WARNING | (
5cc0: 31 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53  1<<8)).#define S
5cd0: 51 4c 49 54 45 5f 41 55 54 48 5f 55 53 45 52 20  QLITE_AUTH_USER 
5ce0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 28 53                (S
5cf0: 51 4c 49 54 45 5f 41 55 54 48 20 7c 20 28 31 3c  QLITE_AUTH | (1<
5d00: 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c  <8)).#define SQL
5d10: 49 54 45 5f 4f 4b 5f 4c 4f 41 44 5f 50 45 52 4d  ITE_OK_LOAD_PERM
5d20: 41 4e 45 4e 54 4c 59 20 20 20 20 20 28 53 51 4c  ANENTLY     (SQL
5d30: 49 54 45 5f 4f 4b 20 7c 20 28 31 3c 3c 38 29 29  ITE_OK | (1<<8))
5d40: 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
5d50: 3a 20 46 6c 61 67 73 20 46 6f 72 20 46 69 6c 65  : Flags For File
5d60: 20 4f 70 65 6e 20 4f 70 65 72 61 74 69 6f 6e 73   Open Operations
5d70: 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 62 69 74  .**.** These bit
5d80: 20 76 61 6c 75 65 73 20 61 72 65 20 69 6e 74 65   values are inte
5d90: 6e 64 65 64 20 66 6f 72 20 75 73 65 20 69 6e 20  nded for use in 
5da0: 74 68 65 0a 2a 2a 20 33 72 64 20 70 61 72 61 6d  the.** 3rd param
5db0: 65 74 65 72 20 74 6f 20 74 68 65 20 5b 73 71 6c  eter to the [sql
5dc0: 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 5d 20  ite3_open_v2()] 
5dd0: 69 6e 74 65 72 66 61 63 65 20 61 6e 64 0a 2a 2a  interface and.**
5de0: 20 69 6e 20 74 68 65 20 34 74 68 20 70 61 72 61   in the 4th para
5df0: 6d 65 74 65 72 20 74 6f 20 74 68 65 20 5b 73 71  meter to the [sq
5e00: 6c 69 74 65 33 5f 76 66 73 2e 78 4f 70 65 6e 5d  lite3_vfs.xOpen]
5e10: 20 6d 65 74 68 6f 64 2e 0a 2a 2f 0a 23 64 65 66   method..*/.#def
5e20: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
5e30: 52 45 41 44 4f 4e 4c 59 20 20 20 20 20 20 20 20  READONLY        
5e40: 20 30 78 30 30 30 30 30 30 30 31 20 20 2f 2a 20   0x00000001  /* 
5e50: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
5e60: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
5e70: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
5e80: 52 45 41 44 57 52 49 54 45 20 20 20 20 20 20 20  READWRITE       
5e90: 20 30 78 30 30 30 30 30 30 30 32 20 20 2f 2a 20   0x00000002  /* 
5ea0: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
5eb0: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
5ec0: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
5ed0: 43 52 45 41 54 45 20 20 20 20 20 20 20 20 20 20  CREATE          
5ee0: 20 30 78 30 30 30 30 30 30 30 34 20 20 2f 2a 20   0x00000004  /* 
5ef0: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
5f00: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
5f10: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
5f20: 44 45 4c 45 54 45 4f 4e 43 4c 4f 53 45 20 20 20  DELETEONCLOSE   
5f30: 20 30 78 30 30 30 30 30 30 30 38 20 20 2f 2a 20   0x00000008  /* 
5f40: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
5f50: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
5f60: 45 58 43 4c 55 53 49 56 45 20 20 20 20 20 20 20  EXCLUSIVE       
5f70: 20 30 78 30 30 30 30 30 30 31 30 20 20 2f 2a 20   0x00000010  /* 
5f80: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
5f90: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
5fa0: 41 55 54 4f 50 52 4f 58 59 20 20 20 20 20 20 20  AUTOPROXY       
5fb0: 20 30 78 30 30 30 30 30 30 32 30 20 20 2f 2a 20   0x00000020  /* 
5fc0: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
5fd0: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
5fe0: 55 52 49 20 20 20 20 20 20 20 20 20 20 20 20 20  URI             
5ff0: 20 30 78 30 30 30 30 30 30 34 30 20 20 2f 2a 20   0x00000040  /* 
6000: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
6010: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
6020: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6030: 4d 45 4d 4f 52 59 20 20 20 20 20 20 20 20 20 20  MEMORY          
6040: 20 30 78 30 30 30 30 30 30 38 30 20 20 2f 2a 20   0x00000080  /* 
6050: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
6060: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
6070: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6080: 4d 41 49 4e 5f 44 42 20 20 20 20 20 20 20 20 20  MAIN_DB         
6090: 20 30 78 30 30 30 30 30 31 30 30 20 20 2f 2a 20   0x00000100  /* 
60a0: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
60b0: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
60c0: 54 45 4d 50 5f 44 42 20 20 20 20 20 20 20 20 20  TEMP_DB         
60d0: 20 30 78 30 30 30 30 30 32 30 30 20 20 2f 2a 20   0x00000200  /* 
60e0: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
60f0: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6100: 54 52 41 4e 53 49 45 4e 54 5f 44 42 20 20 20 20  TRANSIENT_DB    
6110: 20 30 78 30 30 30 30 30 34 30 30 20 20 2f 2a 20   0x00000400  /* 
6120: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
6130: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6140: 4d 41 49 4e 5f 4a 4f 55 52 4e 41 4c 20 20 20 20  MAIN_JOURNAL    
6150: 20 30 78 30 30 30 30 30 38 30 30 20 20 2f 2a 20   0x00000800  /* 
6160: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
6170: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6180: 54 45 4d 50 5f 4a 4f 55 52 4e 41 4c 20 20 20 20  TEMP_JOURNAL    
6190: 20 30 78 30 30 30 30 31 30 30 30 20 20 2f 2a 20   0x00001000  /* 
61a0: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
61b0: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
61c0: 53 55 42 4a 4f 55 52 4e 41 4c 20 20 20 20 20 20  SUBJOURNAL      
61d0: 20 30 78 30 30 30 30 32 30 30 30 20 20 2f 2a 20   0x00002000  /* 
61e0: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
61f0: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6200: 4d 41 53 54 45 52 5f 4a 4f 55 52 4e 41 4c 20 20  MASTER_JOURNAL  
6210: 20 30 78 30 30 30 30 34 30 30 30 20 20 2f 2a 20   0x00004000  /* 
6220: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66  VFS only */.#def
6230: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6240: 4e 4f 4d 55 54 45 58 20 20 20 20 20 20 20 20 20  NOMUTEX         
6250: 20 30 78 30 30 30 30 38 30 30 30 20 20 2f 2a 20   0x00008000  /* 
6260: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
6270: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
6280: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6290: 46 55 4c 4c 4d 55 54 45 58 20 20 20 20 20 20 20  FULLMUTEX       
62a0: 20 30 78 30 30 30 31 30 30 30 30 20 20 2f 2a 20   0x00010000  /* 
62b0: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
62c0: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
62d0: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
62e0: 53 48 41 52 45 44 43 41 43 48 45 20 20 20 20 20  SHAREDCACHE     
62f0: 20 30 78 30 30 30 32 30 30 30 30 20 20 2f 2a 20   0x00020000  /* 
6300: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
6310: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
6320: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6330: 50 52 49 56 41 54 45 43 41 43 48 45 20 20 20 20  PRIVATECACHE    
6340: 20 30 78 30 30 30 34 30 30 30 30 20 20 2f 2a 20   0x00040000  /* 
6350: 4f 6b 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f  Ok for sqlite3_o
6360: 70 65 6e 5f 76 32 28 29 20 2a 2f 0a 23 64 65 66  pen_v2() */.#def
6370: 69 6e 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ine SQLITE_OPEN_
6380: 57 41 4c 20 20 20 20 20 20 20 20 20 20 20 20 20  WAL             
6390: 20 30 78 30 30 30 38 30 30 30 30 20 20 2f 2a 20   0x00080000  /* 
63a0: 56 46 53 20 6f 6e 6c 79 20 2a 2f 0a 0a 2f 2a 20  VFS only */../* 
63b0: 52 65 73 65 72 76 65 64 3a 20 20 20 20 20 20 20  Reserved:       
63c0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
63d0: 20 20 30 78 30 30 46 30 30 30 30 30 20 2a 2f 0a    0x00F00000 */.
63e0: 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
63f0: 20 44 65 76 69 63 65 20 43 68 61 72 61 63 74 65   Device Characte
6400: 72 69 73 74 69 63 73 0a 2a 2a 0a 2a 2a 20 54 68  ristics.**.** Th
6410: 65 20 78 44 65 76 69 63 65 43 68 61 72 61 63 74  e xDeviceCharact
6420: 65 72 69 73 74 69 63 73 20 6d 65 74 68 6f 64 20  eristics method 
6430: 6f 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  of the [sqlite3_
6440: 69 6f 5f 6d 65 74 68 6f 64 73 5d 0a 2a 2a 20 6f  io_methods].** o
6450: 62 6a 65 63 74 20 72 65 74 75 72 6e 73 20 61 6e  bject returns an
6460: 20 69 6e 74 65 67 65 72 20 77 68 69 63 68 20 69   integer which i
6470: 73 20 61 20 76 65 63 74 6f 72 20 6f 66 20 74 68  s a vector of th
6480: 65 73 65 0a 2a 2a 20 62 69 74 20 76 61 6c 75 65  ese.** bit value
6490: 73 20 65 78 70 72 65 73 73 69 6e 67 20 49 2f 4f  s expressing I/O
64a0: 20 63 68 61 72 61 63 74 65 72 69 73 74 69 63 73   characteristics
64b0: 20 6f 66 20 74 68 65 20 6d 61 73 73 20 73 74 6f   of the mass sto
64c0: 72 61 67 65 0a 2a 2a 20 64 65 76 69 63 65 20 74  rage.** device t
64d0: 68 61 74 20 68 6f 6c 64 73 20 74 68 65 20 66 69  hat holds the fi
64e0: 6c 65 20 74 68 61 74 20 74 68 65 20 5b 73 71 6c  le that the [sql
64f0: 69 74 65 33 5f 69 6f 5f 6d 65 74 68 6f 64 73 5d  ite3_io_methods]
6500: 0a 2a 2a 20 72 65 66 65 72 73 20 74 6f 2e 0a 2a  .** refers to..*
6510: 2a 0a 2a 2a 20 54 68 65 20 53 51 4c 49 54 45 5f  *.** The SQLITE_
6520: 49 4f 43 41 50 5f 41 54 4f 4d 49 43 20 70 72 6f  IOCAP_ATOMIC pro
6530: 70 65 72 74 79 20 6d 65 61 6e 73 20 74 68 61 74  perty means that
6540: 20 61 6c 6c 20 77 72 69 74 65 73 20 6f 66 0a 2a   all writes of.*
6550: 2a 20 61 6e 79 20 73 69 7a 65 20 61 72 65 20 61  * any size are a
6560: 74 6f 6d 69 63 2e 20 20 54 68 65 20 53 51 4c 49  tomic.  The SQLI
6570: 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 6e  TE_IOCAP_ATOMICn
6580: 6e 6e 20 76 61 6c 75 65 73 0a 2a 2a 20 6d 65 61  nn values.** mea
6590: 6e 20 74 68 61 74 20 77 72 69 74 65 73 20 6f 66  n that writes of
65a0: 20 62 6c 6f 63 6b 73 20 74 68 61 74 20 61 72 65   blocks that are
65b0: 20 6e 6e 6e 20 62 79 74 65 73 20 69 6e 20 73 69   nnn bytes in si
65c0: 7a 65 20 61 6e 64 0a 2a 2a 20 61 72 65 20 61 6c  ze and.** are al
65d0: 69 67 6e 65 64 20 74 6f 20 61 6e 20 61 64 64 72  igned to an addr
65e0: 65 73 73 20 77 68 69 63 68 20 69 73 20 61 6e 20  ess which is an 
65f0: 69 6e 74 65 67 65 72 20 6d 75 6c 74 69 70 6c 65  integer multiple
6600: 20 6f 66 0a 2a 2a 20 6e 6e 6e 20 61 72 65 20 61   of.** nnn are a
6610: 74 6f 6d 69 63 2e 20 20 54 68 65 20 53 51 4c 49  tomic.  The SQLI
6620: 54 45 5f 49 4f 43 41 50 5f 53 41 46 45 5f 41 50  TE_IOCAP_SAFE_AP
6630: 50 45 4e 44 20 76 61 6c 75 65 20 6d 65 61 6e 73  PEND value means
6640: 0a 2a 2a 20 74 68 61 74 20 77 68 65 6e 20 64 61  .** that when da
6650: 74 61 20 69 73 20 61 70 70 65 6e 64 65 64 20 74  ta is appended t
6660: 6f 20 61 20 66 69 6c 65 2c 20 74 68 65 20 64 61  o a file, the da
6670: 74 61 20 69 73 20 61 70 70 65 6e 64 65 64 0a 2a  ta is appended.*
6680: 2a 20 66 69 72 73 74 20 74 68 65 6e 20 74 68 65  * first then the
6690: 20 73 69 7a 65 20 6f 66 20 74 68 65 20 66 69 6c   size of the fil
66a0: 65 20 69 73 20 65 78 74 65 6e 64 65 64 2c 20 6e  e is extended, n
66b0: 65 76 65 72 20 74 68 65 20 6f 74 68 65 72 0a 2a  ever the other.*
66c0: 2a 20 77 61 79 20 61 72 6f 75 6e 64 2e 20 20 54  * way around.  T
66d0: 68 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f  he SQLITE_IOCAP_
66e0: 53 45 51 55 45 4e 54 49 41 4c 20 70 72 6f 70 65  SEQUENTIAL prope
66f0: 72 74 79 20 6d 65 61 6e 73 20 74 68 61 74 0a 2a  rty means that.*
6700: 2a 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 69 73  * information is
6710: 20 77 72 69 74 74 65 6e 20 74 6f 20 64 69 73 6b   written to disk
6720: 20 69 6e 20 74 68 65 20 73 61 6d 65 20 6f 72 64   in the same ord
6730: 65 72 20 61 73 20 63 61 6c 6c 73 0a 2a 2a 20 74  er as calls.** t
6740: 6f 20 78 57 72 69 74 65 28 29 2e 20 20 54 68 65  o xWrite().  The
6750: 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 50 4f   SQLITE_IOCAP_PO
6760: 57 45 52 53 41 46 45 5f 4f 56 45 52 57 52 49 54  WERSAFE_OVERWRIT
6770: 45 20 70 72 6f 70 65 72 74 79 20 6d 65 61 6e 73  E property means
6780: 20 74 68 61 74 0a 2a 2a 20 61 66 74 65 72 20 72   that.** after r
6790: 65 62 6f 6f 74 20 66 6f 6c 6c 6f 77 69 6e 67 20  eboot following 
67a0: 61 20 63 72 61 73 68 20 6f 72 20 70 6f 77 65 72  a crash or power
67b0: 20 6c 6f 73 73 2c 20 74 68 65 20 6f 6e 6c 79 20   loss, the only 
67c0: 62 79 74 65 73 20 69 6e 20 61 0a 2a 2a 20 66 69  bytes in a.** fi
67d0: 6c 65 20 74 68 61 74 20 77 65 72 65 20 77 72 69  le that were wri
67e0: 74 74 65 6e 20 61 74 20 74 68 65 20 61 70 70 6c  tten at the appl
67f0: 69 63 61 74 69 6f 6e 20 6c 65 76 65 6c 20 6d 69  ication level mi
6800: 67 68 74 20 68 61 76 65 20 63 68 61 6e 67 65 64  ght have changed
6810: 0a 2a 2a 20 61 6e 64 20 74 68 61 74 20 61 64 6a  .** and that adj
6820: 61 63 65 6e 74 20 62 79 74 65 73 2c 20 65 76 65  acent bytes, eve
6830: 6e 20 62 79 74 65 73 20 77 69 74 68 69 6e 20 74  n bytes within t
6840: 68 65 20 73 61 6d 65 20 73 65 63 74 6f 72 20 61  he same sector a
6850: 72 65 0a 2a 2a 20 67 75 61 72 61 6e 74 65 65 64  re.** guaranteed
6860: 20 74 6f 20 62 65 20 75 6e 63 68 61 6e 67 65 64   to be unchanged
6870: 2e 20 20 54 68 65 20 53 51 4c 49 54 45 5f 49 4f  .  The SQLITE_IO
6880: 43 41 50 5f 55 4e 44 45 4c 45 54 41 42 4c 45 5f  CAP_UNDELETABLE_
6890: 57 48 45 4e 5f 4f 50 45 4e 0a 2a 2a 20 66 6c 61  WHEN_OPEN.** fla
68a0: 67 20 69 6e 64 69 63 61 74 65 20 74 68 61 74 20  g indicate that 
68b0: 61 20 66 69 6c 65 20 63 61 6e 6e 6f 74 20 62 65  a file cannot be
68c0: 20 64 65 6c 65 74 65 64 20 77 68 65 6e 20 6f 70   deleted when op
68d0: 65 6e 2e 20 20 54 68 65 0a 2a 2a 20 53 51 4c 49  en.  The.** SQLI
68e0: 54 45 5f 49 4f 43 41 50 5f 49 4d 4d 55 54 41 42  TE_IOCAP_IMMUTAB
68f0: 4c 45 20 66 6c 61 67 20 69 6e 64 69 63 61 74 65  LE flag indicate
6900: 73 20 74 68 61 74 20 74 68 65 20 66 69 6c 65 20  s that the file 
6910: 69 73 20 6f 6e 0a 2a 2a 20 72 65 61 64 2d 6f 6e  is on.** read-on
6920: 6c 79 20 6d 65 64 69 61 20 61 6e 64 20 63 61 6e  ly media and can
6930: 6e 6f 74 20 62 65 20 63 68 61 6e 67 65 64 20 65  not be changed e
6940: 76 65 6e 20 62 79 20 70 72 6f 63 65 73 73 65 73  ven by processes
6950: 20 77 69 74 68 0a 2a 2a 20 65 6c 65 76 61 74 65   with.** elevate
6960: 64 20 70 72 69 76 69 6c 65 67 65 73 2e 0a 2a 2f  d privileges..*/
6970: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
6980: 49 4f 43 41 50 5f 41 54 4f 4d 49 43 20 20 20 20  IOCAP_ATOMIC    
6990: 20 20 20 20 20 20 20 20 20 20 20 20 20 30 78 30               0x0
69a0: 30 30 30 30 30 30 31 0a 23 64 65 66 69 6e 65 20  0000001.#define 
69b0: 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 41 54 4f  SQLITE_IOCAP_ATO
69c0: 4d 49 43 35 31 32 20 20 20 20 20 20 20 20 20 20  MIC512          
69d0: 20 20 20 20 30 78 30 30 30 30 30 30 30 32 0a 23      0x00000002.#
69e0: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f  define SQLITE_IO
69f0: 43 41 50 5f 41 54 4f 4d 49 43 31 4b 20 20 20 20  CAP_ATOMIC1K    
6a00: 20 20 20 20 20 20 20 20 20 20 20 30 78 30 30 30             0x000
6a10: 30 30 30 30 34 0a 23 64 65 66 69 6e 65 20 53 51  00004.#define SQ
6a20: 4c 49 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49  LITE_IOCAP_ATOMI
6a30: 43 32 4b 20 20 20 20 20 20 20 20 20 20 20 20 20  C2K             
6a40: 20 20 30 78 30 30 30 30 30 30 30 38 0a 23 64 65    0x00000008.#de
6a50: 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 43 41  fine SQLITE_IOCA
6a60: 50 5f 41 54 4f 4d 49 43 34 4b 20 20 20 20 20 20  P_ATOMIC4K      
6a70: 20 20 20 20 20 20 20 20 20 30 78 30 30 30 30 30           0x00000
6a80: 30 31 30 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  010.#define SQLI
6a90: 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 38  TE_IOCAP_ATOMIC8
6aa0: 4b 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  K               
6ab0: 30 78 30 30 30 30 30 30 32 30 0a 23 64 65 66 69  0x00000020.#defi
6ac0: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f  ne SQLITE_IOCAP_
6ad0: 41 54 4f 4d 49 43 31 36 4b 20 20 20 20 20 20 20  ATOMIC16K       
6ae0: 20 20 20 20 20 20 20 30 78 30 30 30 30 30 30 34         0x0000004
6af0: 30 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  0.#define SQLITE
6b00: 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 33 32 4b  _IOCAP_ATOMIC32K
6b10: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 78                0x
6b20: 30 30 30 30 30 30 38 30 0a 23 64 65 66 69 6e 65  00000080.#define
6b30: 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 41 54   SQLITE_IOCAP_AT
6b40: 4f 4d 49 43 36 34 4b 20 20 20 20 20 20 20 20 20  OMIC64K         
6b50: 20 20 20 20 20 30 78 30 30 30 30 30 31 30 30 0a       0x00000100.
6b60: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49  #define SQLITE_I
6b70: 4f 43 41 50 5f 53 41 46 45 5f 41 50 50 45 4e 44  OCAP_SAFE_APPEND
6b80: 20 20 20 20 20 20 20 20 20 20 20 20 30 78 30 30              0x00
6b90: 30 30 30 32 30 30 0a 23 64 65 66 69 6e 65 20 53  000200.#define S
6ba0: 51 4c 49 54 45 5f 49 4f 43 41 50 5f 53 45 51 55  QLITE_IOCAP_SEQU
6bb0: 45 4e 54 49 41 4c 20 20 20 20 20 20 20 20 20 20  ENTIAL          
6bc0: 20 20 20 30 78 30 30 30 30 30 34 30 30 0a 23 64     0x00000400.#d
6bd0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 43  efine SQLITE_IOC
6be0: 41 50 5f 55 4e 44 45 4c 45 54 41 42 4c 45 5f 57  AP_UNDELETABLE_W
6bf0: 48 45 4e 5f 4f 50 45 4e 20 20 30 78 30 30 30 30  HEN_OPEN  0x0000
6c00: 30 38 30 30 0a 23 64 65 66 69 6e 65 20 53 51 4c  0800.#define SQL
6c10: 49 54 45 5f 49 4f 43 41 50 5f 50 4f 57 45 52 53  ITE_IOCAP_POWERS
6c20: 41 46 45 5f 4f 56 45 52 57 52 49 54 45 20 20 20  AFE_OVERWRITE   
6c30: 20 30 78 30 30 30 30 31 30 30 30 0a 23 64 65 66   0x00001000.#def
6c40: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50  ine SQLITE_IOCAP
6c50: 5f 49 4d 4d 55 54 41 42 4c 45 20 20 20 20 20 20  _IMMUTABLE      
6c60: 20 20 20 20 20 20 20 20 30 78 30 30 30 30 32 30          0x000020
6c70: 30 30 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  00../*.** CAPI3R
6c80: 45 46 3a 20 46 69 6c 65 20 4c 6f 63 6b 69 6e 67  EF: File Locking
6c90: 20 4c 65 76 65 6c 73 0a 2a 2a 0a 2a 2a 20 53 51   Levels.**.** SQ
6ca0: 4c 69 74 65 20 75 73 65 73 20 6f 6e 65 20 6f 66  Lite uses one of
6cb0: 20 74 68 65 73 65 20 69 6e 74 65 67 65 72 20 76   these integer v
6cc0: 61 6c 75 65 73 20 61 73 20 74 68 65 20 73 65 63  alues as the sec
6cd0: 6f 6e 64 0a 2a 2a 20 61 72 67 75 6d 65 6e 74 20  ond.** argument 
6ce0: 74 6f 20 63 61 6c 6c 73 20 69 74 20 6d 61 6b 65  to calls it make
6cf0: 73 20 74 6f 20 74 68 65 20 78 4c 6f 63 6b 28 29  s to the xLock()
6d00: 20 61 6e 64 20 78 55 6e 6c 6f 63 6b 28 29 20 6d   and xUnlock() m
6d10: 65 74 68 6f 64 73 0a 2a 2a 20 6f 66 20 61 6e 20  ethods.** of an 
6d20: 5b 73 71 6c 69 74 65 33 5f 69 6f 5f 6d 65 74 68  [sqlite3_io_meth
6d30: 6f 64 73 5d 20 6f 62 6a 65 63 74 2e 0a 2a 2f 0a  ods] object..*/.
6d40: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c  #define SQLITE_L
6d50: 4f 43 4b 5f 4e 4f 4e 45 20 20 20 20 20 20 20 20  OCK_NONE        
6d60: 20 20 30 0a 23 64 65 66 69 6e 65 20 53 51 4c 49    0.#define SQLI
6d70: 54 45 5f 4c 4f 43 4b 5f 53 48 41 52 45 44 20 20  TE_LOCK_SHARED  
6d80: 20 20 20 20 20 20 31 0a 23 64 65 66 69 6e 65 20        1.#define 
6d90: 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 52 45 53 45  SQLITE_LOCK_RESE
6da0: 52 56 45 44 20 20 20 20 20 20 32 0a 23 64 65 66  RVED      2.#def
6db0: 69 6e 65 20 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f  ine SQLITE_LOCK_
6dc0: 50 45 4e 44 49 4e 47 20 20 20 20 20 20 20 33 0a  PENDING       3.
6dd0: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c  #define SQLITE_L
6de0: 4f 43 4b 5f 45 58 43 4c 55 53 49 56 45 20 20 20  OCK_EXCLUSIVE   
6df0: 20 20 34 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33    4../*.** CAPI3
6e00: 52 45 46 3a 20 53 79 6e 63 68 72 6f 6e 69 7a 61  REF: Synchroniza
6e10: 74 69 6f 6e 20 54 79 70 65 20 46 6c 61 67 73 0a  tion Type Flags.
6e20: 2a 2a 0a 2a 2a 20 57 68 65 6e 20 53 51 4c 69 74  **.** When SQLit
6e30: 65 20 69 6e 76 6f 6b 65 73 20 74 68 65 20 78 53  e invokes the xS
6e40: 79 6e 63 28 29 20 6d 65 74 68 6f 64 20 6f 66 20  ync() method of 
6e50: 61 6e 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 69  an.** [sqlite3_i
6e60: 6f 5f 6d 65 74 68 6f 64 73 5d 20 6f 62 6a 65 63  o_methods] objec
6e70: 74 20 69 74 20 75 73 65 73 20 61 20 63 6f 6d 62  t it uses a comb
6e80: 69 6e 61 74 69 6f 6e 20 6f 66 0a 2a 2a 20 74 68  ination of.** th
6e90: 65 73 65 20 69 6e 74 65 67 65 72 20 76 61 6c 75  ese integer valu
6ea0: 65 73 20 61 73 20 74 68 65 20 73 65 63 6f 6e 64  es as the second
6eb0: 20 61 72 67 75 6d 65 6e 74 2e 0a 2a 2a 0a 2a 2a   argument..**.**
6ec0: 20 57 68 65 6e 20 74 68 65 20 53 51 4c 49 54 45   When the SQLITE
6ed0: 5f 53 59 4e 43 5f 44 41 54 41 4f 4e 4c 59 20 66  _SYNC_DATAONLY f
6ee0: 6c 61 67 20 69 73 20 75 73 65 64 2c 20 69 74 20  lag is used, it 
6ef0: 6d 65 61 6e 73 20 74 68 61 74 20 74 68 65 0a 2a  means that the.*
6f00: 2a 20 73 79 6e 63 20 6f 70 65 72 61 74 69 6f 6e  * sync operation
6f10: 20 6f 6e 6c 79 20 6e 65 65 64 73 20 74 6f 20 66   only needs to f
6f20: 6c 75 73 68 20 64 61 74 61 20 74 6f 20 6d 61 73  lush data to mas
6f30: 73 20 73 74 6f 72 61 67 65 2e 20 20 49 6e 6f 64  s storage.  Inod
6f40: 65 0a 2a 2a 20 69 6e 66 6f 72 6d 61 74 69 6f 6e  e.** information
6f50: 20 6e 65 65 64 20 6e 6f 74 20 62 65 20 66 6c 75   need not be flu
6f60: 73 68 65 64 2e 20 49 66 20 74 68 65 20 6c 6f 77  shed. If the low
6f70: 65 72 20 66 6f 75 72 20 62 69 74 73 20 6f 66 20  er four bits of 
6f80: 74 68 65 20 66 6c 61 67 0a 2a 2a 20 65 71 75 61  the flag.** equa
6f90: 6c 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 4e 4f  l SQLITE_SYNC_NO
6fa0: 52 4d 41 4c 2c 20 74 68 61 74 20 6d 65 61 6e 73  RMAL, that means
6fb0: 20 74 6f 20 75 73 65 20 6e 6f 72 6d 61 6c 20 66   to use normal f
6fc0: 73 79 6e 63 28 29 20 73 65 6d 61 6e 74 69 63 73  sync() semantics
6fd0: 2e 0a 2a 2a 20 49 66 20 74 68 65 20 6c 6f 77 65  ..** If the lowe
6fe0: 72 20 66 6f 75 72 20 62 69 74 73 20 65 71 75 61  r four bits equa
6ff0: 6c 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 46 55  l SQLITE_SYNC_FU
7000: 4c 4c 2c 20 74 68 61 74 20 6d 65 61 6e 73 0a 2a  LL, that means.*
7010: 2a 20 74 6f 20 75 73 65 20 4d 61 63 20 4f 53 20  * to use Mac OS 
7020: 58 20 73 74 79 6c 65 20 66 75 6c 6c 73 79 6e 63  X style fullsync
7030: 20 69 6e 73 74 65 61 64 20 6f 66 20 66 73 79 6e   instead of fsyn
7040: 63 28 29 2e 0a 2a 2a 0a 2a 2a 20 44 6f 20 6e 6f  c()..**.** Do no
7050: 74 20 63 6f 6e 66 75 73 65 20 74 68 65 20 53 51  t confuse the SQ
7060: 4c 49 54 45 5f 53 59 4e 43 5f 4e 4f 52 4d 41 4c  LITE_SYNC_NORMAL
7070: 20 61 6e 64 20 53 51 4c 49 54 45 5f 53 59 4e 43   and SQLITE_SYNC
7080: 5f 46 55 4c 4c 20 66 6c 61 67 73 0a 2a 2a 20 77  _FULL flags.** w
7090: 69 74 68 20 74 68 65 20 5b 50 52 41 47 4d 41 20  ith the [PRAGMA 
70a0: 73 79 6e 63 68 72 6f 6e 6f 75 73 5d 3d 4e 4f 52  synchronous]=NOR
70b0: 4d 41 4c 20 61 6e 64 20 5b 50 52 41 47 4d 41 20  MAL and [PRAGMA 
70c0: 73 79 6e 63 68 72 6f 6e 6f 75 73 5d 3d 46 55 4c  synchronous]=FUL
70d0: 4c 0a 2a 2a 20 73 65 74 74 69 6e 67 73 2e 20 20  L.** settings.  
70e0: 54 68 65 20 5b 73 79 6e 63 68 72 6f 6e 6f 75 73  The [synchronous
70f0: 20 70 72 61 67 6d 61 5d 20 64 65 74 65 72 6d 69   pragma] determi
7100: 6e 65 73 20 77 68 65 6e 20 63 61 6c 6c 73 20 74  nes when calls t
7110: 6f 20 74 68 65 0a 2a 2a 20 78 53 79 6e 63 20 56  o the.** xSync V
7120: 46 53 20 6d 65 74 68 6f 64 20 6f 63 63 75 72 20  FS method occur 
7130: 61 6e 64 20 61 70 70 6c 69 65 73 20 75 6e 69 66  and applies unif
7140: 6f 72 6d 6c 79 20 61 63 72 6f 73 73 20 61 6c 6c  ormly across all
7150: 20 70 6c 61 74 66 6f 72 6d 73 2e 0a 2a 2a 20 54   platforms..** T
7160: 68 65 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 4e  he SQLITE_SYNC_N
7170: 4f 52 4d 41 4c 20 61 6e 64 20 53 51 4c 49 54 45  ORMAL and SQLITE
7180: 5f 53 59 4e 43 5f 46 55 4c 4c 20 66 6c 61 67 73  _SYNC_FULL flags
7190: 20 64 65 74 65 72 6d 69 6e 65 20 68 6f 77 0a 2a   determine how.*
71a0: 2a 20 65 6e 65 72 67 65 74 69 63 20 6f 72 20 72  * energetic or r
71b0: 69 67 6f 72 6f 75 73 20 6f 72 20 66 6f 72 63 65  igorous or force
71c0: 66 75 6c 20 74 68 65 20 73 79 6e 63 20 6f 70 65  ful the sync ope
71d0: 72 61 74 69 6f 6e 73 20 61 72 65 20 61 6e 64 0a  rations are and.
71e0: 2a 2a 20 6f 6e 6c 79 20 6d 61 6b 65 20 61 20 64  ** only make a d
71f0: 69 66 66 65 72 65 6e 63 65 20 6f 6e 20 4d 61 63  ifference on Mac
7200: 20 4f 53 58 20 66 6f 72 20 74 68 65 20 64 65 66   OSX for the def
7210: 61 75 6c 74 20 53 51 4c 69 74 65 20 63 6f 64 65  ault SQLite code
7220: 2e 0a 2a 2a 20 28 54 68 69 72 64 2d 70 61 72 74  ..** (Third-part
7230: 79 20 56 46 53 20 69 6d 70 6c 65 6d 65 6e 74 61  y VFS implementa
7240: 74 69 6f 6e 73 20 6d 69 67 68 74 20 61 6c 73 6f  tions might also
7250: 20 6d 61 6b 65 20 74 68 65 20 64 69 73 74 69 6e   make the distin
7260: 63 74 69 6f 6e 0a 2a 2a 20 62 65 74 77 65 65 6e  ction.** between
7270: 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 4e 4f 52   SQLITE_SYNC_NOR
7280: 4d 41 4c 20 61 6e 64 20 53 51 4c 49 54 45 5f 53  MAL and SQLITE_S
7290: 59 4e 43 5f 46 55 4c 4c 2c 20 62 75 74 20 61 6d  YNC_FULL, but am
72a0: 6f 6e 67 20 74 68 65 0a 2a 2a 20 6f 70 65 72 61  ong the.** opera
72b0: 74 69 6e 67 20 73 79 73 74 65 6d 73 20 6e 61 74  ting systems nat
72c0: 69 76 65 6c 79 20 73 75 70 70 6f 72 74 65 64 20  ively supported 
72d0: 62 79 20 53 51 4c 69 74 65 2c 20 6f 6e 6c 79 20  by SQLite, only 
72e0: 4d 61 63 20 4f 53 58 0a 2a 2a 20 63 61 72 65 73  Mac OSX.** cares
72f0: 20 61 62 6f 75 74 20 74 68 65 20 64 69 66 66 65   about the diffe
7300: 72 65 6e 63 65 2e 29 0a 2a 2f 0a 23 64 65 66 69  rence.).*/.#defi
7310: 6e 65 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 4e  ne SQLITE_SYNC_N
7320: 4f 52 4d 41 4c 20 20 20 20 20 20 20 20 30 78 30  ORMAL        0x0
7330: 30 30 30 32 0a 23 64 65 66 69 6e 65 20 53 51 4c  0002.#define SQL
7340: 49 54 45 5f 53 59 4e 43 5f 46 55 4c 4c 20 20 20  ITE_SYNC_FULL   
7350: 20 20 20 20 20 20 20 30 78 30 30 30 30 33 0a 23         0x00003.#
7360: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53 59  define SQLITE_SY
7370: 4e 43 5f 44 41 54 41 4f 4e 4c 59 20 20 20 20 20  NC_DATAONLY     
7380: 20 30 78 30 30 30 31 30 0a 0a 2f 2a 0a 2a 2a 20   0x00010../*.** 
7390: 43 41 50 49 33 52 45 46 3a 20 4f 53 20 49 6e 74  CAPI3REF: OS Int
73a0: 65 72 66 61 63 65 20 4f 70 65 6e 20 46 69 6c 65  erface Open File
73b0: 20 48 61 6e 64 6c 65 0a 2a 2a 0a 2a 2a 20 41 6e   Handle.**.** An
73c0: 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d 20   [sqlite3_file] 
73d0: 6f 62 6a 65 63 74 20 72 65 70 72 65 73 65 6e 74  object represent
73e0: 73 20 61 6e 20 6f 70 65 6e 20 66 69 6c 65 20 69  s an open file i
73f0: 6e 20 74 68 65 20 0a 2a 2a 20 5b 73 71 6c 69 74  n the .** [sqlit
7400: 65 33 5f 76 66 73 20 7c 20 4f 53 20 69 6e 74 65  e3_vfs | OS inte
7410: 72 66 61 63 65 20 6c 61 79 65 72 5d 2e 20 20 49  rface layer].  I
7420: 6e 64 69 76 69 64 75 61 6c 20 4f 53 20 69 6e 74  ndividual OS int
7430: 65 72 66 61 63 65 0a 2a 2a 20 69 6d 70 6c 65 6d  erface.** implem
7440: 65 6e 74 61 74 69 6f 6e 73 20 77 69 6c 6c 0a 2a  entations will.*
7450: 2a 20 77 61 6e 74 20 74 6f 20 73 75 62 63 6c 61  * want to subcla
7460: 73 73 20 74 68 69 73 20 6f 62 6a 65 63 74 20 62  ss this object b
7470: 79 20 61 70 70 65 6e 64 69 6e 67 20 61 64 64 69  y appending addi
7480: 74 69 6f 6e 61 6c 20 66 69 65 6c 64 73 0a 2a 2a  tional fields.**
7490: 20 66 6f 72 20 74 68 65 69 72 20 6f 77 6e 20 75   for their own u
74a0: 73 65 2e 20 20 54 68 65 20 70 4d 65 74 68 6f 64  se.  The pMethod
74b0: 73 20 65 6e 74 72 79 20 69 73 20 61 20 70 6f 69  s entry is a poi
74c0: 6e 74 65 72 20 74 6f 20 61 6e 0a 2a 2a 20 5b 73  nter to an.** [s
74d0: 71 6c 69 74 65 33 5f 69 6f 5f 6d 65 74 68 6f 64  qlite3_io_method
74e0: 73 5d 20 6f 62 6a 65 63 74 20 74 68 61 74 20 64  s] object that d
74f0: 65 66 69 6e 65 73 20 6d 65 74 68 6f 64 73 20 66  efines methods f
7500: 6f 72 20 70 65 72 66 6f 72 6d 69 6e 67 0a 2a 2a  or performing.**
7510: 20 49 2f 4f 20 6f 70 65 72 61 74 69 6f 6e 73 20   I/O operations 
7520: 6f 6e 20 74 68 65 20 6f 70 65 6e 20 66 69 6c 65  on the open file
7530: 2e 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73 74 72  ..*/.typedef str
7540: 75 63 74 20 73 71 6c 69 74 65 33 5f 66 69 6c 65  uct sqlite3_file
7550: 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 3b 0a 73   sqlite3_file;.s
7560: 74 72 75 63 74 20 73 71 6c 69 74 65 33 5f 66 69  truct sqlite3_fi
7570: 6c 65 20 7b 0a 20 20 63 6f 6e 73 74 20 73 74 72  le {.  const str
7580: 75 63 74 20 73 71 6c 69 74 65 33 5f 69 6f 5f 6d  uct sqlite3_io_m
7590: 65 74 68 6f 64 73 20 2a 70 4d 65 74 68 6f 64 73  ethods *pMethods
75a0: 3b 20 20 2f 2a 20 4d 65 74 68 6f 64 73 20 66 6f  ;  /* Methods fo
75b0: 72 20 61 6e 20 6f 70 65 6e 20 66 69 6c 65 20 2a  r an open file *
75c0: 2f 0a 7d 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  /.};../*.** CAPI
75d0: 33 52 45 46 3a 20 4f 53 20 49 6e 74 65 72 66 61  3REF: OS Interfa
75e0: 63 65 20 46 69 6c 65 20 56 69 72 74 75 61 6c 20  ce File Virtual 
75f0: 4d 65 74 68 6f 64 73 20 4f 62 6a 65 63 74 0a 2a  Methods Object.*
7600: 2a 0a 2a 2a 20 45 76 65 72 79 20 66 69 6c 65 20  *.** Every file 
7610: 6f 70 65 6e 65 64 20 62 79 20 74 68 65 20 5b 73  opened by the [s
7620: 71 6c 69 74 65 33 5f 76 66 73 2e 78 4f 70 65 6e  qlite3_vfs.xOpen
7630: 5d 20 6d 65 74 68 6f 64 20 70 6f 70 75 6c 61 74  ] method populat
7640: 65 73 20 61 6e 0a 2a 2a 20 5b 73 71 6c 69 74 65  es an.** [sqlite
7650: 33 5f 66 69 6c 65 5d 20 6f 62 6a 65 63 74 20 28  3_file] object (
7660: 6f 72 2c 20 6d 6f 72 65 20 63 6f 6d 6d 6f 6e 6c  or, more commonl
7670: 79 2c 20 61 20 73 75 62 63 6c 61 73 73 20 6f 66  y, a subclass of
7680: 20 74 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33   the.** [sqlite3
7690: 5f 66 69 6c 65 5d 20 6f 62 6a 65 63 74 29 20 77  _file] object) w
76a0: 69 74 68 20 61 20 70 6f 69 6e 74 65 72 20 74 6f  ith a pointer to
76b0: 20 61 6e 20 69 6e 73 74 61 6e 63 65 20 6f 66 20   an instance of 
76c0: 74 68 69 73 20 6f 62 6a 65 63 74 2e 0a 2a 2a 20  this object..** 
76d0: 54 68 69 73 20 6f 62 6a 65 63 74 20 64 65 66 69  This object defi
76e0: 6e 65 73 20 74 68 65 20 6d 65 74 68 6f 64 73 20  nes the methods 
76f0: 75 73 65 64 20 74 6f 20 70 65 72 66 6f 72 6d 20  used to perform 
7700: 76 61 72 69 6f 75 73 20 6f 70 65 72 61 74 69 6f  various operatio
7710: 6e 73 0a 2a 2a 20 61 67 61 69 6e 73 74 20 74 68  ns.** against th
7720: 65 20 6f 70 65 6e 20 66 69 6c 65 20 72 65 70 72  e open file repr
7730: 65 73 65 6e 74 65 64 20 62 79 20 74 68 65 20 5b  esented by the [
7740: 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d 20 6f 62  sqlite3_file] ob
7750: 6a 65 63 74 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 74  ject..**.** If t
7760: 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 2e  he [sqlite3_vfs.
7770: 78 4f 70 65 6e 5d 20 6d 65 74 68 6f 64 20 73 65  xOpen] method se
7780: 74 73 20 74 68 65 20 73 71 6c 69 74 65 33 5f 66  ts the sqlite3_f
7790: 69 6c 65 2e 70 4d 65 74 68 6f 64 73 20 65 6c 65  ile.pMethods ele
77a0: 6d 65 6e 74 20 0a 2a 2a 20 74 6f 20 61 20 6e 6f  ment .** to a no
77b0: 6e 2d 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2c 20  n-NULL pointer, 
77c0: 74 68 65 6e 20 74 68 65 20 73 71 6c 69 74 65 33  then the sqlite3
77d0: 5f 69 6f 5f 6d 65 74 68 6f 64 73 2e 78 43 6c 6f  _io_methods.xClo
77e0: 73 65 20 6d 65 74 68 6f 64 0a 2a 2a 20 6d 61 79  se method.** may
77f0: 20 62 65 20 69 6e 76 6f 6b 65 64 20 65 76 65 6e   be invoked even
7800: 20 69 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33   if the [sqlite3
7810: 5f 76 66 73 2e 78 4f 70 65 6e 5d 20 72 65 70 6f  _vfs.xOpen] repo
7820: 72 74 65 64 20 74 68 61 74 20 69 74 20 66 61 69  rted that it fai
7830: 6c 65 64 2e 20 20 54 68 65 0a 2a 2a 20 6f 6e 6c  led.  The.** onl
7840: 79 20 77 61 79 20 74 6f 20 70 72 65 76 65 6e 74  y way to prevent
7850: 20 61 20 63 61 6c 6c 20 74 6f 20 78 43 6c 6f 73   a call to xClos
7860: 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 61 20 66 61  e following a fa
7870: 69 6c 65 64 20 5b 73 71 6c 69 74 65 33 5f 76 66  iled [sqlite3_vf
7880: 73 2e 78 4f 70 65 6e 5d 0a 2a 2a 20 69 73 20 66  s.xOpen].** is f
7890: 6f 72 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  or the [sqlite3_
78a0: 76 66 73 2e 78 4f 70 65 6e 5d 20 74 6f 20 73 65  vfs.xOpen] to se
78b0: 74 20 74 68 65 20 73 71 6c 69 74 65 33 5f 66 69  t the sqlite3_fi
78c0: 6c 65 2e 70 4d 65 74 68 6f 64 73 20 65 6c 65 6d  le.pMethods elem
78d0: 65 6e 74 0a 2a 2a 20 74 6f 20 4e 55 4c 4c 2e 0a  ent.** to NULL..
78e0: 2a 2a 0a 2a 2a 20 54 68 65 20 66 6c 61 67 73 20  **.** The flags 
78f0: 61 72 67 75 6d 65 6e 74 20 74 6f 20 78 53 79 6e  argument to xSyn
7900: 63 20 6d 61 79 20 62 65 20 6f 6e 65 20 6f 66 20  c may be one of 
7910: 5b 53 51 4c 49 54 45 5f 53 59 4e 43 5f 4e 4f 52  [SQLITE_SYNC_NOR
7920: 4d 41 4c 5d 20 6f 72 0a 2a 2a 20 5b 53 51 4c 49  MAL] or.** [SQLI
7930: 54 45 5f 53 59 4e 43 5f 46 55 4c 4c 5d 2e 20 20  TE_SYNC_FULL].  
7940: 54 68 65 20 66 69 72 73 74 20 63 68 6f 69 63 65  The first choice
7950: 20 69 73 20 74 68 65 20 6e 6f 72 6d 61 6c 20 66   is the normal f
7960: 73 79 6e 63 28 29 2e 0a 2a 2a 20 54 68 65 20 73  sync()..** The s
7970: 65 63 6f 6e 64 20 63 68 6f 69 63 65 20 69 73 20  econd choice is 
7980: 61 20 4d 61 63 20 4f 53 20 58 20 73 74 79 6c 65  a Mac OS X style
7990: 20 66 75 6c 6c 73 79 6e 63 2e 20 20 54 68 65 20   fullsync.  The 
79a0: 5b 53 51 4c 49 54 45 5f 53 59 4e 43 5f 44 41 54  [SQLITE_SYNC_DAT
79b0: 41 4f 4e 4c 59 5d 0a 2a 2a 20 66 6c 61 67 20 6d  AONLY].** flag m
79c0: 61 79 20 62 65 20 4f 52 65 64 20 69 6e 20 74 6f  ay be ORed in to
79d0: 20 69 6e 64 69 63 61 74 65 20 74 68 61 74 20 6f   indicate that o
79e0: 6e 6c 79 20 74 68 65 20 64 61 74 61 20 6f 66 20  nly the data of 
79f0: 74 68 65 20 66 69 6c 65 0a 2a 2a 20 61 6e 64 20  the file.** and 
7a00: 6e 6f 74 20 69 74 73 20 69 6e 6f 64 65 20 6e 65  not its inode ne
7a10: 65 64 73 20 74 6f 20 62 65 20 73 79 6e 63 65 64  eds to be synced
7a20: 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 69 6e 74 65  ..**.** The inte
7a30: 67 65 72 20 76 61 6c 75 65 73 20 74 6f 20 78 4c  ger values to xL
7a40: 6f 63 6b 28 29 20 61 6e 64 20 78 55 6e 6c 6f 63  ock() and xUnloc
7a50: 6b 28 29 20 61 72 65 20 6f 6e 65 20 6f 66 0a 2a  k() are one of.*
7a60: 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20 5b  * <ul>.** <li> [
7a70: 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 4e 4f 4e 45  SQLITE_LOCK_NONE
7a80: 5d 2c 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49  ],.** <li> [SQLI
7a90: 54 45 5f 4c 4f 43 4b 5f 53 48 41 52 45 44 5d 2c  TE_LOCK_SHARED],
7aa0: 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45  .** <li> [SQLITE
7ab0: 5f 4c 4f 43 4b 5f 52 45 53 45 52 56 45 44 5d 2c  _LOCK_RESERVED],
7ac0: 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45  .** <li> [SQLITE
7ad0: 5f 4c 4f 43 4b 5f 50 45 4e 44 49 4e 47 5d 2c 20  _LOCK_PENDING], 
7ae0: 6f 72 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49  or.** <li> [SQLI
7af0: 54 45 5f 4c 4f 43 4b 5f 45 58 43 4c 55 53 49 56  TE_LOCK_EXCLUSIV
7b00: 45 5d 2e 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 20  E]..** </ul>.** 
7b10: 78 4c 6f 63 6b 28 29 20 69 6e 63 72 65 61 73 65  xLock() increase
7b20: 73 20 74 68 65 20 6c 6f 63 6b 2e 20 78 55 6e 6c  s the lock. xUnl
7b30: 6f 63 6b 28 29 20 64 65 63 72 65 61 73 65 73 20  ock() decreases 
7b40: 74 68 65 20 6c 6f 63 6b 2e 0a 2a 2a 20 54 68 65  the lock..** The
7b50: 20 78 43 68 65 63 6b 52 65 73 65 72 76 65 64 4c   xCheckReservedL
7b60: 6f 63 6b 28 29 20 6d 65 74 68 6f 64 20 63 68 65  ock() method che
7b70: 63 6b 73 20 77 68 65 74 68 65 72 20 61 6e 79 20  cks whether any 
7b80: 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
7b90: 69 6f 6e 2c 0a 2a 2a 20 65 69 74 68 65 72 20 69  ion,.** either i
7ba0: 6e 20 74 68 69 73 20 70 72 6f 63 65 73 73 20 6f  n this process o
7bb0: 72 20 69 6e 20 73 6f 6d 65 20 6f 74 68 65 72 20  r in some other 
7bc0: 70 72 6f 63 65 73 73 2c 20 69 73 20 68 6f 6c 64  process, is hold
7bd0: 69 6e 67 20 61 20 52 45 53 45 52 56 45 44 2c 0a  ing a RESERVED,.
7be0: 2a 2a 20 50 45 4e 44 49 4e 47 2c 20 6f 72 20 45  ** PENDING, or E
7bf0: 58 43 4c 55 53 49 56 45 20 6c 6f 63 6b 20 6f 6e  XCLUSIVE lock on
7c00: 20 74 68 65 20 66 69 6c 65 2e 20 20 49 74 20 72   the file.  It r
7c10: 65 74 75 72 6e 73 20 74 72 75 65 0a 2a 2a 20 69  eturns true.** i
7c20: 66 20 73 75 63 68 20 61 20 6c 6f 63 6b 20 65 78  f such a lock ex
7c30: 69 73 74 73 20 61 6e 64 20 66 61 6c 73 65 20 6f  ists and false o
7c40: 74 68 65 72 77 69 73 65 2e 0a 2a 2a 0a 2a 2a 20  therwise..**.** 
7c50: 54 68 65 20 78 46 69 6c 65 43 6f 6e 74 72 6f 6c  The xFileControl
7c60: 28 29 20 6d 65 74 68 6f 64 20 69 73 20 61 20 67  () method is a g
7c70: 65 6e 65 72 69 63 20 69 6e 74 65 72 66 61 63 65  eneric interface
7c80: 20 74 68 61 74 20 61 6c 6c 6f 77 73 20 63 75 73   that allows cus
7c90: 74 6f 6d 0a 2a 2a 20 56 46 53 20 69 6d 70 6c 65  tom.** VFS imple
7ca0: 6d 65 6e 74 61 74 69 6f 6e 73 20 74 6f 20 64 69  mentations to di
7cb0: 72 65 63 74 6c 79 20 63 6f 6e 74 72 6f 6c 20 61  rectly control a
7cc0: 6e 20 6f 70 65 6e 20 66 69 6c 65 20 75 73 69 6e  n open file usin
7cd0: 67 20 74 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65  g the.** [sqlite
7ce0: 33 5f 66 69 6c 65 5f 63 6f 6e 74 72 6f 6c 28 29  3_file_control()
7cf0: 5d 20 69 6e 74 65 72 66 61 63 65 2e 20 20 54 68  ] interface.  Th
7d00: 65 20 73 65 63 6f 6e 64 20 22 6f 70 22 20 61 72  e second "op" ar
7d10: 67 75 6d 65 6e 74 20 69 73 20 61 6e 0a 2a 2a 20  gument is an.** 
7d20: 69 6e 74 65 67 65 72 20 6f 70 63 6f 64 65 2e 20  integer opcode. 
7d30: 20 54 68 65 20 74 68 69 72 64 20 61 72 67 75 6d   The third argum
7d40: 65 6e 74 20 69 73 20 61 20 67 65 6e 65 72 69 63  ent is a generic
7d50: 20 70 6f 69 6e 74 65 72 20 69 6e 74 65 6e 64 65   pointer intende
7d60: 64 20 74 6f 0a 2a 2a 20 70 6f 69 6e 74 20 74 6f  d to.** point to
7d70: 20 61 20 73 74 72 75 63 74 75 72 65 20 74 68 61   a structure tha
7d80: 74 20 6d 61 79 20 63 6f 6e 74 61 69 6e 20 61 72  t may contain ar
7d90: 67 75 6d 65 6e 74 73 20 6f 72 20 73 70 61 63 65  guments or space
7da0: 20 69 6e 20 77 68 69 63 68 20 74 6f 0a 2a 2a 20   in which to.** 
7db0: 77 72 69 74 65 20 72 65 74 75 72 6e 20 76 61 6c  write return val
7dc0: 75 65 73 2e 20 20 50 6f 74 65 6e 74 69 61 6c 20  ues.  Potential 
7dd0: 75 73 65 73 20 66 6f 72 20 78 46 69 6c 65 43 6f  uses for xFileCo
7de0: 6e 74 72 6f 6c 28 29 20 6d 69 67 68 74 20 62 65  ntrol() might be
7df0: 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 73 20 74 6f  .** functions to
7e00: 20 65 6e 61 62 6c 65 20 62 6c 6f 63 6b 69 6e 67   enable blocking
7e10: 20 6c 6f 63 6b 73 20 77 69 74 68 20 74 69 6d 65   locks with time
7e20: 6f 75 74 73 2c 20 74 6f 20 63 68 61 6e 67 65 20  outs, to change 
7e30: 74 68 65 0a 2a 2a 20 6c 6f 63 6b 69 6e 67 20 73  the.** locking s
7e40: 74 72 61 74 65 67 79 20 28 66 6f 72 20 65 78 61  trategy (for exa
7e50: 6d 70 6c 65 20 74 6f 20 75 73 65 20 64 6f 74 2d  mple to use dot-
7e60: 66 69 6c 65 20 6c 6f 63 6b 73 29 2c 20 74 6f 20  file locks), to 
7e70: 69 6e 71 75 69 72 65 0a 2a 2a 20 61 62 6f 75 74  inquire.** about
7e80: 20 74 68 65 20 73 74 61 74 75 73 20 6f 66 20 61   the status of a
7e90: 20 6c 6f 63 6b 2c 20 6f 72 20 74 6f 20 62 72 65   lock, or to bre
7ea0: 61 6b 20 73 74 61 6c 65 20 6c 6f 63 6b 73 2e 20  ak stale locks. 
7eb0: 20 54 68 65 20 53 51 4c 69 74 65 0a 2a 2a 20 63   The SQLite.** c
7ec0: 6f 72 65 20 72 65 73 65 72 76 65 73 20 61 6c 6c  ore reserves all
7ed0: 20 6f 70 63 6f 64 65 73 20 6c 65 73 73 20 74 68   opcodes less th
7ee0: 61 6e 20 31 30 30 20 66 6f 72 20 69 74 73 20 6f  an 100 for its o
7ef0: 77 6e 20 75 73 65 2e 0a 2a 2a 20 41 20 5b 66 69  wn use..** A [fi
7f00: 6c 65 20 63 6f 6e 74 72 6f 6c 20 6f 70 63 6f 64  le control opcod
7f10: 65 73 20 7c 20 6c 69 73 74 20 6f 66 20 6f 70 63  es | list of opc
7f20: 6f 64 65 73 5d 20 6c 65 73 73 20 74 68 61 6e 20  odes] less than 
7f30: 31 30 30 20 69 73 20 61 76 61 69 6c 61 62 6c 65  100 is available
7f40: 2e 0a 2a 2a 20 41 70 70 6c 69 63 61 74 69 6f 6e  ..** Application
7f50: 73 20 74 68 61 74 20 64 65 66 69 6e 65 20 61 20  s that define a 
7f60: 63 75 73 74 6f 6d 20 78 46 69 6c 65 43 6f 6e 74  custom xFileCont
7f70: 72 6f 6c 20 6d 65 74 68 6f 64 20 73 68 6f 75 6c  rol method shoul
7f80: 64 20 75 73 65 20 6f 70 63 6f 64 65 73 0a 2a 2a  d use opcodes.**
7f90: 20 67 72 65 61 74 65 72 20 74 68 61 6e 20 31 30   greater than 10
7fa0: 30 20 74 6f 20 61 76 6f 69 64 20 63 6f 6e 66 6c  0 to avoid confl
7fb0: 69 63 74 73 2e 20 20 56 46 53 20 69 6d 70 6c 65  icts.  VFS imple
7fc0: 6d 65 6e 74 61 74 69 6f 6e 73 20 73 68 6f 75 6c  mentations shoul
7fd0: 64 0a 2a 2a 20 72 65 74 75 72 6e 20 5b 53 51 4c  d.** return [SQL
7fe0: 49 54 45 5f 4e 4f 54 46 4f 55 4e 44 5d 20 66 6f  ITE_NOTFOUND] fo
7ff0: 72 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 6f  r file control o
8000: 70 63 6f 64 65 73 20 74 68 61 74 20 74 68 65 79  pcodes that they
8010: 20 64 6f 20 6e 6f 74 0a 2a 2a 20 72 65 63 6f 67   do not.** recog
8020: 6e 69 7a 65 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  nize..**.** The 
8030: 78 53 65 63 74 6f 72 53 69 7a 65 28 29 20 6d 65  xSectorSize() me
8040: 74 68 6f 64 20 72 65 74 75 72 6e 73 20 74 68 65  thod returns the
8050: 20 73 65 63 74 6f 72 20 73 69 7a 65 20 6f 66 20   sector size of 
8060: 74 68 65 0a 2a 2a 20 64 65 76 69 63 65 20 74 68  the.** device th
8070: 61 74 20 75 6e 64 65 72 6c 69 65 73 20 74 68 65  at underlies the
8080: 20 66 69 6c 65 2e 20 20 54 68 65 20 73 65 63 74   file.  The sect
8090: 6f 72 20 73 69 7a 65 20 69 73 20 74 68 65 0a 2a  or size is the.*
80a0: 2a 20 6d 69 6e 69 6d 75 6d 20 77 72 69 74 65 20  * minimum write 
80b0: 74 68 61 74 20 63 61 6e 20 62 65 20 70 65 72 66  that can be perf
80c0: 6f 72 6d 65 64 20 77 69 74 68 6f 75 74 20 64 69  ormed without di
80d0: 73 74 75 72 62 69 6e 67 0a 2a 2a 20 6f 74 68 65  sturbing.** othe
80e0: 72 20 62 79 74 65 73 20 69 6e 20 74 68 65 20 66  r bytes in the f
80f0: 69 6c 65 2e 20 20 54 68 65 20 78 44 65 76 69 63  ile.  The xDevic
8100: 65 43 68 61 72 61 63 74 65 72 69 73 74 69 63 73  eCharacteristics
8110: 28 29 0a 2a 2a 20 6d 65 74 68 6f 64 20 72 65 74  ().** method ret
8120: 75 72 6e 73 20 61 20 62 69 74 20 76 65 63 74 6f  urns a bit vecto
8130: 72 20 64 65 73 63 72 69 62 69 6e 67 20 62 65 68  r describing beh
8140: 61 76 69 6f 72 73 20 6f 66 20 74 68 65 0a 2a 2a  aviors of the.**
8150: 20 75 6e 64 65 72 6c 79 69 6e 67 20 64 65 76 69   underlying devi
8160: 63 65 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a  ce:.**.** <ul>.*
8170: 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49  * <li> [SQLITE_I
8180: 4f 43 41 50 5f 41 54 4f 4d 49 43 5d 0a 2a 2a 20  OCAP_ATOMIC].** 
8190: 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f 43  <li> [SQLITE_IOC
81a0: 41 50 5f 41 54 4f 4d 49 43 35 31 32 5d 0a 2a 2a  AP_ATOMIC512].**
81b0: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f   <li> [SQLITE_IO
81c0: 43 41 50 5f 41 54 4f 4d 49 43 31 4b 5d 0a 2a 2a  CAP_ATOMIC1K].**
81d0: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f   <li> [SQLITE_IO
81e0: 43 41 50 5f 41 54 4f 4d 49 43 32 4b 5d 0a 2a 2a  CAP_ATOMIC2K].**
81f0: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f   <li> [SQLITE_IO
8200: 43 41 50 5f 41 54 4f 4d 49 43 34 4b 5d 0a 2a 2a  CAP_ATOMIC4K].**
8210: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f   <li> [SQLITE_IO
8220: 43 41 50 5f 41 54 4f 4d 49 43 38 4b 5d 0a 2a 2a  CAP_ATOMIC8K].**
8230: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f   <li> [SQLITE_IO
8240: 43 41 50 5f 41 54 4f 4d 49 43 31 36 4b 5d 0a 2a  CAP_ATOMIC16K].*
8250: 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49  * <li> [SQLITE_I
8260: 4f 43 41 50 5f 41 54 4f 4d 49 43 33 32 4b 5d 0a  OCAP_ATOMIC32K].
8270: 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f  ** <li> [SQLITE_
8280: 49 4f 43 41 50 5f 41 54 4f 4d 49 43 36 34 4b 5d  IOCAP_ATOMIC64K]
8290: 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45  .** <li> [SQLITE
82a0: 5f 49 4f 43 41 50 5f 53 41 46 45 5f 41 50 50 45  _IOCAP_SAFE_APPE
82b0: 4e 44 5d 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c  ND].** <li> [SQL
82c0: 49 54 45 5f 49 4f 43 41 50 5f 53 45 51 55 45 4e  ITE_IOCAP_SEQUEN
82d0: 54 49 41 4c 5d 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a  TIAL].** </ul>.*
82e0: 2a 0a 2a 2a 20 54 68 65 20 53 51 4c 49 54 45 5f  *.** The SQLITE_
82f0: 49 4f 43 41 50 5f 41 54 4f 4d 49 43 20 70 72 6f  IOCAP_ATOMIC pro
8300: 70 65 72 74 79 20 6d 65 61 6e 73 20 74 68 61 74  perty means that
8310: 20 61 6c 6c 20 77 72 69 74 65 73 20 6f 66 0a 2a   all writes of.*
8320: 2a 20 61 6e 79 20 73 69 7a 65 20 61 72 65 20 61  * any size are a
8330: 74 6f 6d 69 63 2e 20 20 54 68 65 20 53 51 4c 49  tomic.  The SQLI
8340: 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 6e  TE_IOCAP_ATOMICn
8350: 6e 6e 20 76 61 6c 75 65 73 0a 2a 2a 20 6d 65 61  nn values.** mea
8360: 6e 20 74 68 61 74 20 77 72 69 74 65 73 20 6f 66  n that writes of
8370: 20 62 6c 6f 63 6b 73 20 74 68 61 74 20 61 72 65   blocks that are
8380: 20 6e 6e 6e 20 62 79 74 65 73 20 69 6e 20 73 69   nnn bytes in si
8390: 7a 65 20 61 6e 64 0a 2a 2a 20 61 72 65 20 61 6c  ze and.** are al
83a0: 69 67 6e 65 64 20 74 6f 20 61 6e 20 61 64 64 72  igned to an addr
83b0: 65 73 73 20 77 68 69 63 68 20 69 73 20 61 6e 20  ess which is an 
83c0: 69 6e 74 65 67 65 72 20 6d 75 6c 74 69 70 6c 65  integer multiple
83d0: 20 6f 66 0a 2a 2a 20 6e 6e 6e 20 61 72 65 20 61   of.** nnn are a
83e0: 74 6f 6d 69 63 2e 20 20 54 68 65 20 53 51 4c 49  tomic.  The SQLI
83f0: 54 45 5f 49 4f 43 41 50 5f 53 41 46 45 5f 41 50  TE_IOCAP_SAFE_AP
8400: 50 45 4e 44 20 76 61 6c 75 65 20 6d 65 61 6e 73  PEND value means
8410: 0a 2a 2a 20 74 68 61 74 20 77 68 65 6e 20 64 61  .** that when da
8420: 74 61 20 69 73 20 61 70 70 65 6e 64 65 64 20 74  ta is appended t
8430: 6f 20 61 20 66 69 6c 65 2c 20 74 68 65 20 64 61  o a file, the da
8440: 74 61 20 69 73 20 61 70 70 65 6e 64 65 64 0a 2a  ta is appended.*
8450: 2a 20 66 69 72 73 74 20 74 68 65 6e 20 74 68 65  * first then the
8460: 20 73 69 7a 65 20 6f 66 20 74 68 65 20 66 69 6c   size of the fil
8470: 65 20 69 73 20 65 78 74 65 6e 64 65 64 2c 20 6e  e is extended, n
8480: 65 76 65 72 20 74 68 65 20 6f 74 68 65 72 0a 2a  ever the other.*
8490: 2a 20 77 61 79 20 61 72 6f 75 6e 64 2e 20 20 54  * way around.  T
84a0: 68 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f  he SQLITE_IOCAP_
84b0: 53 45 51 55 45 4e 54 49 41 4c 20 70 72 6f 70 65  SEQUENTIAL prope
84c0: 72 74 79 20 6d 65 61 6e 73 20 74 68 61 74 0a 2a  rty means that.*
84d0: 2a 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 69 73  * information is
84e0: 20 77 72 69 74 74 65 6e 20 74 6f 20 64 69 73 6b   written to disk
84f0: 20 69 6e 20 74 68 65 20 73 61 6d 65 20 6f 72 64   in the same ord
8500: 65 72 20 61 73 20 63 61 6c 6c 73 0a 2a 2a 20 74  er as calls.** t
8510: 6f 20 78 57 72 69 74 65 28 29 2e 0a 2a 2a 0a 2a  o xWrite()..**.*
8520: 2a 20 49 66 20 78 52 65 61 64 28 29 20 72 65 74  * If xRead() ret
8530: 75 72 6e 73 20 53 51 4c 49 54 45 5f 49 4f 45 52  urns SQLITE_IOER
8540: 52 5f 53 48 4f 52 54 5f 52 45 41 44 20 69 74 20  R_SHORT_READ it 
8550: 6d 75 73 74 20 61 6c 73 6f 20 66 69 6c 6c 0a 2a  must also fill.*
8560: 2a 20 69 6e 20 74 68 65 20 75 6e 72 65 61 64 20  * in the unread 
8570: 70 6f 72 74 69 6f 6e 73 20 6f 66 20 74 68 65 20  portions of the 
8580: 62 75 66 66 65 72 20 77 69 74 68 20 7a 65 72 6f  buffer with zero
8590: 73 2e 20 20 41 20 56 46 53 20 74 68 61 74 0a 2a  s.  A VFS that.*
85a0: 2a 20 66 61 69 6c 73 20 74 6f 20 7a 65 72 6f 2d  * fails to zero-
85b0: 66 69 6c 6c 20 73 68 6f 72 74 20 72 65 61 64 73  fill short reads
85c0: 20 6d 69 67 68 74 20 73 65 65 6d 20 74 6f 20 77   might seem to w
85d0: 6f 72 6b 2e 20 20 48 6f 77 65 76 65 72 2c 0a 2a  ork.  However,.*
85e0: 2a 20 66 61 69 6c 75 72 65 20 74 6f 20 7a 65 72  * failure to zer
85f0: 6f 2d 66 69 6c 6c 20 73 68 6f 72 74 20 72 65 61  o-fill short rea
8600: 64 73 20 77 69 6c 6c 20 65 76 65 6e 74 75 61 6c  ds will eventual
8610: 6c 79 20 6c 65 61 64 20 74 6f 0a 2a 2a 20 64 61  ly lead to.** da
8620: 74 61 62 61 73 65 20 63 6f 72 72 75 70 74 69 6f  tabase corruptio
8630: 6e 2e 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73 74  n..*/.typedef st
8640: 72 75 63 74 20 73 71 6c 69 74 65 33 5f 69 6f 5f  ruct sqlite3_io_
8650: 6d 65 74 68 6f 64 73 20 73 71 6c 69 74 65 33 5f  methods sqlite3_
8660: 69 6f 5f 6d 65 74 68 6f 64 73 3b 0a 73 74 72 75  io_methods;.stru
8670: 63 74 20 73 71 6c 69 74 65 33 5f 69 6f 5f 6d 65  ct sqlite3_io_me
8680: 74 68 6f 64 73 20 7b 0a 20 20 69 6e 74 20 69 56  thods {.  int iV
8690: 65 72 73 69 6f 6e 3b 0a 20 20 69 6e 74 20 28 2a  ersion;.  int (*
86a0: 78 43 6c 6f 73 65 29 28 73 71 6c 69 74 65 33 5f  xClose)(sqlite3_
86b0: 66 69 6c 65 2a 29 3b 0a 20 20 69 6e 74 20 28 2a  file*);.  int (*
86c0: 78 52 65 61 64 29 28 73 71 6c 69 74 65 33 5f 66  xRead)(sqlite3_f
86d0: 69 6c 65 2a 2c 20 76 6f 69 64 2a 2c 20 69 6e 74  ile*, void*, int
86e0: 20 69 41 6d 74 2c 20 73 71 6c 69 74 65 33 5f 69   iAmt, sqlite3_i
86f0: 6e 74 36 34 20 69 4f 66 73 74 29 3b 0a 20 20 69  nt64 iOfst);.  i
8700: 6e 74 20 28 2a 78 57 72 69 74 65 29 28 73 71 6c  nt (*xWrite)(sql
8710: 69 74 65 33 5f 66 69 6c 65 2a 2c 20 63 6f 6e 73  ite3_file*, cons
8720: 74 20 76 6f 69 64 2a 2c 20 69 6e 74 20 69 41 6d  t void*, int iAm
8730: 74 2c 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34  t, sqlite3_int64
8740: 20 69 4f 66 73 74 29 3b 0a 20 20 69 6e 74 20 28   iOfst);.  int (
8750: 2a 78 54 72 75 6e 63 61 74 65 29 28 73 71 6c 69  *xTruncate)(sqli
8760: 74 65 33 5f 66 69 6c 65 2a 2c 20 73 71 6c 69 74  te3_file*, sqlit
8770: 65 33 5f 69 6e 74 36 34 20 73 69 7a 65 29 3b 0a  e3_int64 size);.
8780: 20 20 69 6e 74 20 28 2a 78 53 79 6e 63 29 28 73    int (*xSync)(s
8790: 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 69 6e  qlite3_file*, in
87a0: 74 20 66 6c 61 67 73 29 3b 0a 20 20 69 6e 74 20  t flags);.  int 
87b0: 28 2a 78 46 69 6c 65 53 69 7a 65 29 28 73 71 6c  (*xFileSize)(sql
87c0: 69 74 65 33 5f 66 69 6c 65 2a 2c 20 73 71 6c 69  ite3_file*, sqli
87d0: 74 65 33 5f 69 6e 74 36 34 20 2a 70 53 69 7a 65  te3_int64 *pSize
87e0: 29 3b 0a 20 20 69 6e 74 20 28 2a 78 4c 6f 63 6b  );.  int (*xLock
87f0: 29 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c  )(sqlite3_file*,
8800: 20 69 6e 74 29 3b 0a 20 20 69 6e 74 20 28 2a 78   int);.  int (*x
8810: 55 6e 6c 6f 63 6b 29 28 73 71 6c 69 74 65 33 5f  Unlock)(sqlite3_
8820: 66 69 6c 65 2a 2c 20 69 6e 74 29 3b 0a 20 20 69  file*, int);.  i
8830: 6e 74 20 28 2a 78 43 68 65 63 6b 52 65 73 65 72  nt (*xCheckReser
8840: 76 65 64 4c 6f 63 6b 29 28 73 71 6c 69 74 65 33  vedLock)(sqlite3
8850: 5f 66 69 6c 65 2a 2c 20 69 6e 74 20 2a 70 52 65  _file*, int *pRe
8860: 73 4f 75 74 29 3b 0a 20 20 69 6e 74 20 28 2a 78  sOut);.  int (*x
8870: 46 69 6c 65 43 6f 6e 74 72 6f 6c 29 28 73 71 6c  FileControl)(sql
8880: 69 74 65 33 5f 66 69 6c 65 2a 2c 20 69 6e 74 20  ite3_file*, int 
8890: 6f 70 2c 20 76 6f 69 64 20 2a 70 41 72 67 29 3b  op, void *pArg);
88a0: 0a 20 20 69 6e 74 20 28 2a 78 53 65 63 74 6f 72  .  int (*xSector
88b0: 53 69 7a 65 29 28 73 71 6c 69 74 65 33 5f 66 69  Size)(sqlite3_fi
88c0: 6c 65 2a 29 3b 0a 20 20 69 6e 74 20 28 2a 78 44  le*);.  int (*xD
88d0: 65 76 69 63 65 43 68 61 72 61 63 74 65 72 69 73  eviceCharacteris
88e0: 74 69 63 73 29 28 73 71 6c 69 74 65 33 5f 66 69  tics)(sqlite3_fi
88f0: 6c 65 2a 29 3b 0a 20 20 2f 2a 20 4d 65 74 68 6f  le*);.  /* Metho
8900: 64 73 20 61 62 6f 76 65 20 61 72 65 20 76 61 6c  ds above are val
8910: 69 64 20 66 6f 72 20 76 65 72 73 69 6f 6e 20 31  id for version 1
8920: 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 53 68 6d   */.  int (*xShm
8930: 4d 61 70 29 28 73 71 6c 69 74 65 33 5f 66 69 6c  Map)(sqlite3_fil
8940: 65 2a 2c 20 69 6e 74 20 69 50 67 2c 20 69 6e 74  e*, int iPg, int
8950: 20 70 67 73 7a 2c 20 69 6e 74 2c 20 76 6f 69 64   pgsz, int, void
8960: 20 76 6f 6c 61 74 69 6c 65 2a 2a 29 3b 0a 20 20   volatile**);.  
8970: 69 6e 74 20 28 2a 78 53 68 6d 4c 6f 63 6b 29 28  int (*xShmLock)(
8980: 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 69  sqlite3_file*, i
8990: 6e 74 20 6f 66 66 73 65 74 2c 20 69 6e 74 20 6e  nt offset, int n
89a0: 2c 20 69 6e 74 20 66 6c 61 67 73 29 3b 0a 20 20  , int flags);.  
89b0: 76 6f 69 64 20 28 2a 78 53 68 6d 42 61 72 72 69  void (*xShmBarri
89c0: 65 72 29 28 73 71 6c 69 74 65 33 5f 66 69 6c 65  er)(sqlite3_file
89d0: 2a 29 3b 0a 20 20 69 6e 74 20 28 2a 78 53 68 6d  *);.  int (*xShm
89e0: 55 6e 6d 61 70 29 28 73 71 6c 69 74 65 33 5f 66  Unmap)(sqlite3_f
89f0: 69 6c 65 2a 2c 20 69 6e 74 20 64 65 6c 65 74 65  ile*, int delete
8a00: 46 6c 61 67 29 3b 0a 20 20 2f 2a 20 4d 65 74 68  Flag);.  /* Meth
8a10: 6f 64 73 20 61 62 6f 76 65 20 61 72 65 20 76 61  ods above are va
8a20: 6c 69 64 20 66 6f 72 20 76 65 72 73 69 6f 6e 20  lid for version 
8a30: 32 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 46 65  2 */.  int (*xFe
8a40: 74 63 68 29 28 73 71 6c 69 74 65 33 5f 66 69 6c  tch)(sqlite3_fil
8a50: 65 2a 2c 20 73 71 6c 69 74 65 33 5f 69 6e 74 36  e*, sqlite3_int6
8a60: 34 20 69 4f 66 73 74 2c 20 69 6e 74 20 69 41 6d  4 iOfst, int iAm
8a70: 74 2c 20 76 6f 69 64 20 2a 2a 70 70 29 3b 0a 20  t, void **pp);. 
8a80: 20 69 6e 74 20 28 2a 78 55 6e 66 65 74 63 68 29   int (*xUnfetch)
8a90: 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20  (sqlite3_file*, 
8aa0: 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 20 69 4f  sqlite3_int64 iO
8ab0: 66 73 74 2c 20 76 6f 69 64 20 2a 70 29 3b 0a 20  fst, void *p);. 
8ac0: 20 2f 2a 20 4d 65 74 68 6f 64 73 20 61 62 6f 76   /* Methods abov
8ad0: 65 20 61 72 65 20 76 61 6c 69 64 20 66 6f 72 20  e are valid for 
8ae0: 76 65 72 73 69 6f 6e 20 33 20 2a 2f 0a 20 20 2f  version 3 */.  /
8af0: 2a 20 41 64 64 69 74 69 6f 6e 61 6c 20 6d 65 74  * Additional met
8b00: 68 6f 64 73 20 6d 61 79 20 62 65 20 61 64 64 65  hods may be adde
8b10: 64 20 69 6e 20 66 75 74 75 72 65 20 72 65 6c 65  d in future rele
8b20: 61 73 65 73 20 2a 2f 0a 7d 3b 0a 0a 2f 2a 0a 2a  ases */.};../*.*
8b30: 2a 20 43 41 50 49 33 52 45 46 3a 20 53 74 61 6e  * CAPI3REF: Stan
8b40: 64 61 72 64 20 46 69 6c 65 20 43 6f 6e 74 72 6f  dard File Contro
8b50: 6c 20 4f 70 63 6f 64 65 73 0a 2a 2a 20 4b 45 59  l Opcodes.** KEY
8b60: 57 4f 52 44 53 3a 20 7b 66 69 6c 65 20 63 6f 6e  WORDS: {file con
8b70: 74 72 6f 6c 20 6f 70 63 6f 64 65 73 7d 20 7b 66  trol opcodes} {f
8b80: 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 6f 70 63 6f  ile control opco
8b90: 64 65 7d 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20  de}.**.** These 
8ba0: 69 6e 74 65 67 65 72 20 63 6f 6e 73 74 61 6e 74  integer constant
8bb0: 73 20 61 72 65 20 6f 70 63 6f 64 65 73 20 66 6f  s are opcodes fo
8bc0: 72 20 74 68 65 20 78 46 69 6c 65 43 6f 6e 74 72  r the xFileContr
8bd0: 6f 6c 20 6d 65 74 68 6f 64 0a 2a 2a 20 6f 66 20  ol method.** of 
8be0: 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 69 6f 5f  the [sqlite3_io_
8bf0: 6d 65 74 68 6f 64 73 5d 20 6f 62 6a 65 63 74 20  methods] object 
8c00: 61 6e 64 20 66 6f 72 20 74 68 65 20 5b 73 71 6c  and for the [sql
8c10: 69 74 65 33 5f 66 69 6c 65 5f 63 6f 6e 74 72 6f  ite3_file_contro
8c20: 6c 28 29 5d 0a 2a 2a 20 69 6e 74 65 72 66 61 63  l()].** interfac
8c30: 65 2e 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a  e..**.** <ul>.**
8c40: 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43   <li>[[SQLITE_FC
8c50: 4e 54 4c 5f 4c 4f 43 4b 53 54 41 54 45 5d 5d 0a  NTL_LOCKSTATE]].
8c60: 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 46  ** The [SQLITE_F
8c70: 43 4e 54 4c 5f 4c 4f 43 4b 53 54 41 54 45 5d 20  CNTL_LOCKSTATE] 
8c80: 6f 70 63 6f 64 65 20 69 73 20 75 73 65 64 20 66  opcode is used f
8c90: 6f 72 20 64 65 62 75 67 67 69 6e 67 2e 20 20 54  or debugging.  T
8ca0: 68 69 73 0a 2a 2a 20 6f 70 63 6f 64 65 20 63 61  his.** opcode ca
8cb0: 75 73 65 73 20 74 68 65 20 78 46 69 6c 65 43 6f  uses the xFileCo
8cc0: 6e 74 72 6f 6c 20 6d 65 74 68 6f 64 20 74 6f 20  ntrol method to 
8cd0: 77 72 69 74 65 20 74 68 65 20 63 75 72 72 65 6e  write the curren
8ce0: 74 20 73 74 61 74 65 20 6f 66 0a 2a 2a 20 74 68  t state of.** th
8cf0: 65 20 6c 6f 63 6b 20 28 6f 6e 65 20 6f 66 20 5b  e lock (one of [
8d00: 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 4e 4f 4e 45  SQLITE_LOCK_NONE
8d10: 5d 2c 20 5b 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f  ], [SQLITE_LOCK_
8d20: 53 48 41 52 45 44 5d 2c 0a 2a 2a 20 5b 53 51 4c  SHARED],.** [SQL
8d30: 49 54 45 5f 4c 4f 43 4b 5f 52 45 53 45 52 56 45  ITE_LOCK_RESERVE
8d40: 44 5d 2c 20 5b 53 51 4c 49 54 45 5f 4c 4f 43 4b  D], [SQLITE_LOCK
8d50: 5f 50 45 4e 44 49 4e 47 5d 2c 20 6f 72 20 5b 53  _PENDING], or [S
8d60: 51 4c 49 54 45 5f 4c 4f 43 4b 5f 45 58 43 4c 55  QLITE_LOCK_EXCLU
8d70: 53 49 56 45 5d 29 0a 2a 2a 20 69 6e 74 6f 20 61  SIVE]).** into a
8d80: 6e 20 69 6e 74 65 67 65 72 20 74 68 61 74 20 74  n integer that t
8d90: 68 65 20 70 41 72 67 20 61 72 67 75 6d 65 6e 74  he pArg argument
8da0: 20 70 6f 69 6e 74 73 20 74 6f 2e 20 54 68 69 73   points to. This
8db0: 20 63 61 70 61 62 69 6c 69 74 79 0a 2a 2a 20 69   capability.** i
8dc0: 73 20 75 73 65 64 20 64 75 72 69 6e 67 20 74 65  s used during te
8dd0: 73 74 69 6e 67 20 61 6e 64 20 69 73 20 6f 6e 6c  sting and is onl
8de0: 79 20 61 76 61 69 6c 61 62 6c 65 20 77 68 65 6e  y available when
8df0: 20 74 68 65 20 53 51 4c 49 54 45 5f 54 45 53 54   the SQLITE_TEST
8e00: 0a 2a 2a 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65  .** compile-time
8e10: 20 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 2e   option is used.
8e20: 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c  .**.** <li>[[SQL
8e30: 49 54 45 5f 46 43 4e 54 4c 5f 53 49 5a 45 5f 48  ITE_FCNTL_SIZE_H
8e40: 49 4e 54 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53 51  INT]].** The [SQ
8e50: 4c 49 54 45 5f 46 43 4e 54 4c 5f 53 49 5a 45 5f  LITE_FCNTL_SIZE_
8e60: 48 49 4e 54 5d 20 6f 70 63 6f 64 65 20 69 73 20  HINT] opcode is 
8e70: 75 73 65 64 20 62 79 20 53 51 4c 69 74 65 20 74  used by SQLite t
8e80: 6f 20 67 69 76 65 20 74 68 65 20 56 46 53 0a 2a  o give the VFS.*
8e90: 2a 20 6c 61 79 65 72 20 61 20 68 69 6e 74 20 6f  * layer a hint o
8ea0: 66 20 68 6f 77 20 6c 61 72 67 65 20 74 68 65 20  f how large the 
8eb0: 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 77 69  database file wi
8ec0: 6c 6c 20 67 72 6f 77 20 74 6f 20 62 65 20 64 75  ll grow to be du
8ed0: 72 69 6e 67 20 74 68 65 0a 2a 2a 20 63 75 72 72  ring the.** curr
8ee0: 65 6e 74 20 74 72 61 6e 73 61 63 74 69 6f 6e 2e  ent transaction.
8ef0: 20 20 54 68 69 73 20 68 69 6e 74 20 69 73 20 6e    This hint is n
8f00: 6f 74 20 67 75 61 72 61 6e 74 65 65 64 20 74 6f  ot guaranteed to
8f10: 20 62 65 20 61 63 63 75 72 61 74 65 20 62 75 74   be accurate but
8f20: 20 69 74 0a 2a 2a 20 69 73 20 6f 66 74 65 6e 20   it.** is often 
8f30: 63 6c 6f 73 65 2e 20 20 54 68 65 20 75 6e 64 65  close.  The unde
8f40: 72 6c 79 69 6e 67 20 56 46 53 20 6d 69 67 68 74  rlying VFS might
8f50: 20 63 68 6f 6f 73 65 20 74 6f 20 70 72 65 61 6c   choose to preal
8f60: 6c 6f 63 61 74 65 20 64 61 74 61 62 61 73 65 0a  locate database.
8f70: 2a 2a 20 66 69 6c 65 20 73 70 61 63 65 20 62 61  ** file space ba
8f80: 73 65 64 20 6f 6e 20 74 68 69 73 20 68 69 6e 74  sed on this hint
8f90: 20 69 6e 20 6f 72 64 65 72 20 74 6f 20 68 65 6c   in order to hel
8fa0: 70 20 77 72 69 74 65 73 20 74 6f 20 74 68 65 20  p writes to the 
8fb0: 64 61 74 61 62 61 73 65 0a 2a 2a 20 66 69 6c 65  database.** file
8fc0: 20 72 75 6e 20 66 61 73 74 65 72 2e 0a 2a 2a 0a   run faster..**.
8fd0: 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f  ** <li>[[SQLITE_
8fe0: 46 43 4e 54 4c 5f 43 48 55 4e 4b 5f 53 49 5a 45  FCNTL_CHUNK_SIZE
8ff0: 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54  ]].** The [SQLIT
9000: 45 5f 46 43 4e 54 4c 5f 43 48 55 4e 4b 5f 53 49  E_FCNTL_CHUNK_SI
9010: 5a 45 5d 20 6f 70 63 6f 64 65 20 69 73 20 75 73  ZE] opcode is us
9020: 65 64 20 74 6f 20 72 65 71 75 65 73 74 20 74 68  ed to request th
9030: 61 74 20 74 68 65 20 56 46 53 0a 2a 2a 20 65 78  at the VFS.** ex
9040: 74 65 6e 64 73 20 61 6e 64 20 74 72 75 6e 63 61  tends and trunca
9050: 74 65 73 20 74 68 65 20 64 61 74 61 62 61 73 65  tes the database
9060: 20 66 69 6c 65 20 69 6e 20 63 68 75 6e 6b 73 20   file in chunks 
9070: 6f 66 20 61 20 73 69 7a 65 20 73 70 65 63 69 66  of a size specif
9080: 69 65 64 0a 2a 2a 20 62 79 20 74 68 65 20 75 73  ied.** by the us
9090: 65 72 2e 20 54 68 65 20 66 6f 75 72 74 68 20 61  er. The fourth a
90a0: 72 67 75 6d 65 6e 74 20 74 6f 20 5b 73 71 6c 69  rgument to [sqli
90b0: 74 65 33 5f 66 69 6c 65 5f 63 6f 6e 74 72 6f 6c  te3_file_control
90c0: 28 29 5d 20 73 68 6f 75 6c 64 20 0a 2a 2a 20 70  ()] should .** p
90d0: 6f 69 6e 74 20 74 6f 20 61 6e 20 69 6e 74 65 67  oint to an integ
90e0: 65 72 20 28 74 79 70 65 20 69 6e 74 29 20 63 6f  er (type int) co
90f0: 6e 74 61 69 6e 69 6e 67 20 74 68 65 20 6e 65 77  ntaining the new
9100: 20 63 68 75 6e 6b 2d 73 69 7a 65 20 74 6f 20 75   chunk-size to u
9110: 73 65 0a 2a 2a 20 66 6f 72 20 74 68 65 20 6e 6f  se.** for the no
9120: 6d 69 6e 61 74 65 64 20 64 61 74 61 62 61 73 65  minated database
9130: 2e 20 41 6c 6c 6f 63 61 74 69 6e 67 20 64 61 74  . Allocating dat
9140: 61 62 61 73 65 20 66 69 6c 65 20 73 70 61 63 65  abase file space
9150: 20 69 6e 20 6c 61 72 67 65 0a 2a 2a 20 63 68 75   in large.** chu
9160: 6e 6b 73 20 28 73 61 79 20 31 4d 42 20 61 74 20  nks (say 1MB at 
9170: 61 20 74 69 6d 65 29 2c 20 6d 61 79 20 72 65 64  a time), may red
9180: 75 63 65 20 66 69 6c 65 2d 73 79 73 74 65 6d 20  uce file-system 
9190: 66 72 61 67 6d 65 6e 74 61 74 69 6f 6e 20 61 6e  fragmentation an
91a0: 64 0a 2a 2a 20 69 6d 70 72 6f 76 65 20 70 65 72  d.** improve per
91b0: 66 6f 72 6d 61 6e 63 65 20 6f 6e 20 73 6f 6d 65  formance on some
91c0: 20 73 79 73 74 65 6d 73 2e 0a 2a 2a 0a 2a 2a 20   systems..**.** 
91d0: 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e  <li>[[SQLITE_FCN
91e0: 54 4c 5f 46 49 4c 45 5f 50 4f 49 4e 54 45 52 5d  TL_FILE_POINTER]
91f0: 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54 45  ].** The [SQLITE
9200: 5f 46 43 4e 54 4c 5f 46 49 4c 45 5f 50 4f 49 4e  _FCNTL_FILE_POIN
9210: 54 45 52 5d 20 6f 70 63 6f 64 65 20 69 73 20 75  TER] opcode is u
9220: 73 65 64 20 74 6f 20 6f 62 74 61 69 6e 20 61 20  sed to obtain a 
9230: 70 6f 69 6e 74 65 72 0a 2a 2a 20 74 6f 20 74 68  pointer.** to th
9240: 65 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d  e [sqlite3_file]
9250: 20 6f 62 6a 65 63 74 20 61 73 73 6f 63 69 61 74   object associat
9260: 65 64 20 77 69 74 68 20 61 20 70 61 72 74 69 63  ed with a partic
9270: 75 6c 61 72 20 64 61 74 61 62 61 73 65 0a 2a 2a  ular database.**
9280: 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e 20 20 53 65   connection.  Se
9290: 65 20 61 6c 73 6f 20 5b 53 51 4c 49 54 45 5f 46  e also [SQLITE_F
92a0: 43 4e 54 4c 5f 4a 4f 55 52 4e 41 4c 5f 50 4f 49  CNTL_JOURNAL_POI
92b0: 4e 54 45 52 5d 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69  NTER]..**.** <li
92c0: 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  >[[SQLITE_FCNTL_
92d0: 4a 4f 55 52 4e 41 4c 5f 50 4f 49 4e 54 45 52 5d  JOURNAL_POINTER]
92e0: 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54 45  ].** The [SQLITE
92f0: 5f 46 43 4e 54 4c 5f 4a 4f 55 52 4e 41 4c 5f 50  _FCNTL_JOURNAL_P
9300: 4f 49 4e 54 45 52 5d 20 6f 70 63 6f 64 65 20 69  OINTER] opcode i
9310: 73 20 75 73 65 64 20 74 6f 20 6f 62 74 61 69 6e  s used to obtain
9320: 20 61 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 74 6f   a pointer.** to
9330: 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 66 69   the [sqlite3_fi
9340: 6c 65 5d 20 6f 62 6a 65 63 74 20 61 73 73 6f 63  le] object assoc
9350: 69 61 74 65 64 20 77 69 74 68 20 74 68 65 20 6a  iated with the j
9360: 6f 75 72 6e 61 6c 20 66 69 6c 65 20 28 65 69 74  ournal file (eit
9370: 68 65 72 0a 2a 2a 20 74 68 65 20 5b 72 6f 6c 6c  her.** the [roll
9380: 62 61 63 6b 20 6a 6f 75 72 6e 61 6c 5d 20 6f 72  back journal] or
9390: 20 74 68 65 20 5b 77 72 69 74 65 2d 61 68 65 61   the [write-ahea
93a0: 64 20 6c 6f 67 5d 29 20 66 6f 72 20 61 20 70 61  d log]) for a pa
93b0: 72 74 69 63 75 6c 61 72 20 64 61 74 61 62 61 73  rticular databas
93c0: 65 0a 2a 2a 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e  e.** connection.
93d0: 20 20 53 65 65 20 61 6c 73 6f 20 5b 53 51 4c 49    See also [SQLI
93e0: 54 45 5f 46 43 4e 54 4c 5f 46 49 4c 45 5f 50 4f  TE_FCNTL_FILE_PO
93f0: 49 4e 54 45 52 5d 2e 0a 2a 2a 0a 2a 2a 20 3c 6c  INTER]..**.** <l
9400: 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  i>[[SQLITE_FCNTL
9410: 5f 53 59 4e 43 5f 4f 4d 49 54 54 45 44 5d 5d 0a  _SYNC_OMITTED]].
9420: 2a 2a 20 4e 6f 20 6c 6f 6e 67 65 72 20 69 6e 20  ** No longer in 
9430: 75 73 65 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b  use..**.** <li>[
9440: 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 53 59  [SQLITE_FCNTL_SY
9450: 4e 43 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c  NC]].** The [SQL
9460: 49 54 45 5f 46 43 4e 54 4c 5f 53 59 4e 43 5d 20  ITE_FCNTL_SYNC] 
9470: 6f 70 63 6f 64 65 20 69 73 20 67 65 6e 65 72 61  opcode is genera
9480: 74 65 64 20 69 6e 74 65 72 6e 61 6c 6c 79 20 62  ted internally b
9490: 79 20 53 51 4c 69 74 65 20 61 6e 64 0a 2a 2a 20  y SQLite and.** 
94a0: 73 65 6e 74 20 74 6f 20 74 68 65 20 56 46 53 20  sent to the VFS 
94b0: 69 6d 6d 65 64 69 61 74 65 6c 79 20 62 65 66 6f  immediately befo
94c0: 72 65 20 74 68 65 20 78 53 79 6e 63 20 6d 65 74  re the xSync met
94d0: 68 6f 64 20 69 73 20 69 6e 76 6f 6b 65 64 20 6f  hod is invoked o
94e0: 6e 20 61 0a 2a 2a 20 64 61 74 61 62 61 73 65 20  n a.** database 
94f0: 66 69 6c 65 20 64 65 73 63 72 69 70 74 6f 72 2e  file descriptor.
9500: 20 4f 72 2c 20 69 66 20 74 68 65 20 78 53 79 6e   Or, if the xSyn
9510: 63 20 6d 65 74 68 6f 64 20 69 73 20 6e 6f 74 20  c method is not 
9520: 69 6e 76 6f 6b 65 64 20 0a 2a 2a 20 62 65 63 61  invoked .** beca
9530: 75 73 65 20 74 68 65 20 75 73 65 72 20 68 61 73  use the user has
9540: 20 63 6f 6e 66 69 67 75 72 65 64 20 53 51 4c 69   configured SQLi
9550: 74 65 20 77 69 74 68 20 0a 2a 2a 20 5b 50 52 41  te with .** [PRA
9560: 47 4d 41 20 73 79 6e 63 68 72 6f 6e 6f 75 73 20  GMA synchronous 
9570: 7c 20 50 52 41 47 4d 41 20 73 79 6e 63 68 72 6f  | PRAGMA synchro
9580: 6e 6f 75 73 3d 4f 46 46 5d 20 69 74 20 69 73 20  nous=OFF] it is 
9590: 69 6e 76 6f 6b 65 64 20 69 6e 20 70 6c 61 63 65  invoked in place
95a0: 20 0a 2a 2a 20 6f 66 20 74 68 65 20 78 53 79 6e   .** of the xSyn
95b0: 63 20 6d 65 74 68 6f 64 2e 20 49 6e 20 6d 6f 73  c method. In mos
95c0: 74 20 63 61 73 65 73 2c 20 74 68 65 20 70 6f 69  t cases, the poi
95d0: 6e 74 65 72 20 61 72 67 75 6d 65 6e 74 20 70 61  nter argument pa
95e0: 73 73 65 64 20 77 69 74 68 0a 2a 2a 20 74 68 69  ssed with.** thi
95f0: 73 20 66 69 6c 65 2d 63 6f 6e 74 72 6f 6c 20 69  s file-control i
9600: 73 20 4e 55 4c 4c 2e 20 48 6f 77 65 76 65 72 2c  s NULL. However,
9610: 20 69 66 20 74 68 65 20 64 61 74 61 62 61 73 65   if the database
9620: 20 66 69 6c 65 20 69 73 20 62 65 69 6e 67 20 73   file is being s
9630: 79 6e 63 65 64 0a 2a 2a 20 61 73 20 70 61 72 74  ynced.** as part
9640: 20 6f 66 20 61 20 6d 75 6c 74 69 2d 64 61 74 61   of a multi-data
9650: 62 61 73 65 20 63 6f 6d 6d 69 74 2c 20 74 68 65  base commit, the
9660: 20 61 72 67 75 6d 65 6e 74 20 70 6f 69 6e 74 73   argument points
9670: 20 74 6f 20 61 20 6e 75 6c 2d 74 65 72 6d 69 6e   to a nul-termin
9680: 61 74 65 64 0a 2a 2a 20 73 74 72 69 6e 67 20 63  ated.** string c
9690: 6f 6e 74 61 69 6e 69 6e 67 20 74 68 65 20 74 72  ontaining the tr
96a0: 61 6e 73 61 63 74 69 6f 6e 73 20 6d 61 73 74 65  ansactions maste
96b0: 72 2d 6a 6f 75 72 6e 61 6c 20 66 69 6c 65 20 6e  r-journal file n
96c0: 61 6d 65 2e 20 56 46 53 65 73 20 74 68 61 74 20  ame. VFSes that 
96d0: 0a 2a 2a 20 64 6f 20 6e 6f 74 20 6e 65 65 64 20  .** do not need 
96e0: 74 68 69 73 20 73 69 67 6e 61 6c 20 73 68 6f 75  this signal shou
96f0: 6c 64 20 73 69 6c 65 6e 74 6c 79 20 69 67 6e 6f  ld silently igno
9700: 72 65 20 74 68 69 73 20 6f 70 63 6f 64 65 2e 20  re this opcode. 
9710: 41 70 70 6c 69 63 61 74 69 6f 6e 73 20 0a 2a 2a  Applications .**
9720: 20 73 68 6f 75 6c 64 20 6e 6f 74 20 63 61 6c 6c   should not call
9730: 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5f 63   [sqlite3_file_c
9740: 6f 6e 74 72 6f 6c 28 29 5d 20 77 69 74 68 20 74  ontrol()] with t
9750: 68 69 73 20 6f 70 63 6f 64 65 20 61 73 20 64 6f  his opcode as do
9760: 69 6e 67 20 73 6f 20 6d 61 79 20 0a 2a 2a 20 64  ing so may .** d
9770: 69 73 72 75 70 74 20 74 68 65 20 6f 70 65 72 61  isrupt the opera
9780: 74 69 6f 6e 20 6f 66 20 74 68 65 20 73 70 65 63  tion of the spec
9790: 69 61 6c 69 7a 65 64 20 56 46 53 65 73 20 74 68  ialized VFSes th
97a0: 61 74 20 64 6f 20 72 65 71 75 69 72 65 20 69 74  at do require it
97b0: 2e 20 20 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b 5b  .  .**.** <li>[[
97c0: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 43 4f 4d  SQLITE_FCNTL_COM
97d0: 4d 49 54 5f 50 48 41 53 45 54 57 4f 5d 5d 0a 2a  MIT_PHASETWO]].*
97e0: 2a 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 46 43  * The [SQLITE_FC
97f0: 4e 54 4c 5f 43 4f 4d 4d 49 54 5f 50 48 41 53 45  NTL_COMMIT_PHASE
9800: 54 57 4f 5d 20 6f 70 63 6f 64 65 20 69 73 20 67  TWO] opcode is g
9810: 65 6e 65 72 61 74 65 64 20 69 6e 74 65 72 6e 61  enerated interna
9820: 6c 6c 79 20 62 79 20 53 51 4c 69 74 65 0a 2a 2a  lly by SQLite.**
9830: 20 61 6e 64 20 73 65 6e 74 20 74 6f 20 74 68 65   and sent to the
9840: 20 56 46 53 20 61 66 74 65 72 20 61 20 74 72 61   VFS after a tra
9850: 6e 73 61 63 74 69 6f 6e 20 68 61 73 20 62 65 65  nsaction has bee
9860: 6e 20 63 6f 6d 6d 69 74 74 65 64 20 69 6d 6d 65  n committed imme
9870: 64 69 61 74 65 6c 79 0a 2a 2a 20 62 75 74 20 62  diately.** but b
9880: 65 66 6f 72 65 20 74 68 65 20 64 61 74 61 62 61  efore the databa
9890: 73 65 20 69 73 20 75 6e 6c 6f 63 6b 65 64 2e 20  se is unlocked. 
98a0: 56 46 53 65 73 20 74 68 61 74 20 64 6f 20 6e 6f  VFSes that do no
98b0: 74 20 6e 65 65 64 20 74 68 69 73 20 73 69 67 6e  t need this sign
98c0: 61 6c 0a 2a 2a 20 73 68 6f 75 6c 64 20 73 69 6c  al.** should sil
98d0: 65 6e 74 6c 79 20 69 67 6e 6f 72 65 20 74 68 69  ently ignore thi
98e0: 73 20 6f 70 63 6f 64 65 2e 20 41 70 70 6c 69 63  s opcode. Applic
98f0: 61 74 69 6f 6e 73 20 73 68 6f 75 6c 64 20 6e 6f  ations should no
9900: 74 20 63 61 6c 6c 0a 2a 2a 20 5b 73 71 6c 69 74  t call.** [sqlit
9910: 65 33 5f 66 69 6c 65 5f 63 6f 6e 74 72 6f 6c 28  e3_file_control(
9920: 29 5d 20 77 69 74 68 20 74 68 69 73 20 6f 70 63  )] with this opc
9930: 6f 64 65 20 61 73 20 64 6f 69 6e 67 20 73 6f 20  ode as doing so 
9940: 6d 61 79 20 64 69 73 72 75 70 74 20 74 68 65 20  may disrupt the 
9950: 0a 2a 2a 20 6f 70 65 72 61 74 69 6f 6e 20 6f 66  .** operation of
9960: 20 74 68 65 20 73 70 65 63 69 61 6c 69 7a 65 64   the specialized
9970: 20 56 46 53 65 73 20 74 68 61 74 20 64 6f 20 72   VFSes that do r
9980: 65 71 75 69 72 65 20 69 74 2e 20 20 0a 2a 2a 0a  equire it.  .**.
9990: 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f  ** <li>[[SQLITE_
99a0: 46 43 4e 54 4c 5f 57 49 4e 33 32 5f 41 56 5f 52  FCNTL_WIN32_AV_R
99b0: 45 54 52 59 5d 5d 0a 2a 2a 20 5e 54 68 65 20 5b  ETRY]].** ^The [
99c0: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 57 49 4e  SQLITE_FCNTL_WIN
99d0: 33 32 5f 41 56 5f 52 45 54 52 59 5d 20 6f 70 63  32_AV_RETRY] opc
99e0: 6f 64 65 20 69 73 20 75 73 65 64 20 74 6f 20 63  ode is used to c
99f0: 6f 6e 66 69 67 75 72 65 20 61 75 74 6f 6d 61 74  onfigure automat
9a00: 69 63 0a 2a 2a 20 72 65 74 72 79 20 63 6f 75 6e  ic.** retry coun
9a10: 74 73 20 61 6e 64 20 69 6e 74 65 72 76 61 6c 73  ts and intervals
9a20: 20 66 6f 72 20 63 65 72 74 61 69 6e 20 64 69 73   for certain dis
9a30: 6b 20 49 2f 4f 20 6f 70 65 72 61 74 69 6f 6e 73  k I/O operations
9a40: 20 66 6f 72 20 74 68 65 0a 2a 2a 20 77 69 6e 64   for the.** wind
9a50: 6f 77 73 20 5b 56 46 53 5d 20 69 6e 20 6f 72 64  ows [VFS] in ord
9a60: 65 72 20 74 6f 20 70 72 6f 76 69 64 65 20 72 6f  er to provide ro
9a70: 62 75 73 74 6e 65 73 73 20 69 6e 20 74 68 65 20  bustness in the 
9a80: 70 72 65 73 65 6e 63 65 20 6f 66 0a 2a 2a 20 61  presence of.** a
9a90: 6e 74 69 2d 76 69 72 75 73 20 70 72 6f 67 72 61  nti-virus progra
9aa0: 6d 73 2e 20 20 42 79 20 64 65 66 61 75 6c 74 2c  ms.  By default,
9ab0: 20 74 68 65 20 77 69 6e 64 6f 77 73 20 56 46 53   the windows VFS
9ac0: 20 77 69 6c 6c 20 72 65 74 72 79 20 66 69 6c 65   will retry file
9ad0: 20 72 65 61 64 2c 0a 2a 2a 20 66 69 6c 65 20 77   read,.** file w
9ae0: 72 69 74 65 2c 20 61 6e 64 20 66 69 6c 65 20 64  rite, and file d
9af0: 65 6c 65 74 65 20 6f 70 65 72 61 74 69 6f 6e 73  elete operations
9b00: 20 75 70 20 74 6f 20 31 30 20 74 69 6d 65 73 2c   up to 10 times,
9b10: 20 77 69 74 68 20 61 20 64 65 6c 61 79 0a 2a 2a   with a delay.**
9b20: 20 6f 66 20 32 35 20 6d 69 6c 6c 69 73 65 63 6f   of 25 milliseco
9b30: 6e 64 73 20 62 65 66 6f 72 65 20 74 68 65 20 66  nds before the f
9b40: 69 72 73 74 20 72 65 74 72 79 20 61 6e 64 20 77  irst retry and w
9b50: 69 74 68 20 74 68 65 20 64 65 6c 61 79 20 69 6e  ith the delay in
9b60: 63 72 65 61 73 69 6e 67 0a 2a 2a 20 62 79 20 61  creasing.** by a
9b70: 6e 20 61 64 64 69 74 69 6f 6e 61 6c 20 32 35 20  n additional 25 
9b80: 6d 69 6c 6c 69 73 65 63 6f 6e 64 73 20 77 69 74  milliseconds wit
9b90: 68 20 65 61 63 68 20 73 75 62 73 65 71 75 65 6e  h each subsequen
9ba0: 74 20 72 65 74 72 79 2e 20 20 54 68 69 73 0a 2a  t retry.  This.*
9bb0: 2a 20 6f 70 63 6f 64 65 20 61 6c 6c 6f 77 73 20  * opcode allows 
9bc0: 74 68 65 73 65 20 74 77 6f 20 76 61 6c 75 65 73  these two values
9bd0: 20 28 31 30 20 72 65 74 72 69 65 73 20 61 6e 64   (10 retries and
9be0: 20 32 35 20 6d 69 6c 6c 69 73 65 63 6f 6e 64 73   25 milliseconds
9bf0: 20 6f 66 20 64 65 6c 61 79 29 0a 2a 2a 20 74 6f   of delay).** to
9c00: 20 62 65 20 61 64 6a 75 73 74 65 64 2e 20 20 54   be adjusted.  T
9c10: 68 65 20 76 61 6c 75 65 73 20 61 72 65 20 63 68  he values are ch
9c20: 61 6e 67 65 64 20 66 6f 72 20 61 6c 6c 20 64 61  anged for all da
9c30: 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
9c40: 6e 73 0a 2a 2a 20 77 69 74 68 69 6e 20 74 68 65  ns.** within the
9c50: 20 73 61 6d 65 20 70 72 6f 63 65 73 73 2e 20 20   same process.  
9c60: 54 68 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20  The argument is 
9c70: 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20  a pointer to an 
9c80: 61 72 72 61 79 20 6f 66 20 74 77 6f 0a 2a 2a 20  array of two.** 
9c90: 69 6e 74 65 67 65 72 73 20 77 68 65 72 65 20 74  integers where t
9ca0: 68 65 20 66 69 72 73 74 20 69 6e 74 65 67 65 72  he first integer
9cb0: 20 69 20 74 68 65 20 6e 65 77 20 72 65 74 72 79   i the new retry
9cc0: 20 63 6f 75 6e 74 20 61 6e 64 20 74 68 65 20 73   count and the s
9cd0: 65 63 6f 6e 64 0a 2a 2a 20 69 6e 74 65 67 65 72  econd.** integer
9ce0: 20 69 73 20 74 68 65 20 64 65 6c 61 79 2e 20 20   is the delay.  
9cf0: 49 66 20 65 69 74 68 65 72 20 69 6e 74 65 67 65  If either intege
9d00: 72 20 69 73 20 6e 65 67 61 74 69 76 65 2c 20 74  r is negative, t
9d10: 68 65 6e 20 74 68 65 20 73 65 74 74 69 6e 67 0a  hen the setting.
9d20: 2a 2a 20 69 73 20 6e 6f 74 20 63 68 61 6e 67 65  ** is not change
9d30: 64 20 62 75 74 20 69 6e 73 74 65 61 64 20 74 68  d but instead th
9d40: 65 20 70 72 69 6f 72 20 76 61 6c 75 65 20 6f 66  e prior value of
9d50: 20 74 68 61 74 20 73 65 74 74 69 6e 67 20 69 73   that setting is
9d60: 20 77 72 69 74 74 65 6e 0a 2a 2a 20 69 6e 74 6f   written.** into
9d70: 20 74 68 65 20 61 72 72 61 79 20 65 6e 74 72 79   the array entry
9d80: 2c 20 61 6c 6c 6f 77 69 6e 67 20 74 68 65 20 63  , allowing the c
9d90: 75 72 72 65 6e 74 20 72 65 74 72 79 20 73 65 74  urrent retry set
9da0: 74 69 6e 67 73 20 74 6f 20 62 65 0a 2a 2a 20 69  tings to be.** i
9db0: 6e 74 65 72 72 6f 67 61 74 65 64 2e 20 20 54 68  nterrogated.  Th
9dc0: 65 20 7a 44 62 4e 61 6d 65 20 70 61 72 61 6d 65  e zDbName parame
9dd0: 74 65 72 20 69 73 20 69 67 6e 6f 72 65 64 2e 0a  ter is ignored..
9de0: 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49  **.** <li>[[SQLI
9df0: 54 45 5f 46 43 4e 54 4c 5f 50 45 52 53 49 53 54  TE_FCNTL_PERSIST
9e00: 5f 57 41 4c 5d 5d 0a 2a 2a 20 5e 54 68 65 20 5b  _WAL]].** ^The [
9e10: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 50 45 52  SQLITE_FCNTL_PER
9e20: 53 49 53 54 5f 57 41 4c 5d 20 6f 70 63 6f 64 65  SIST_WAL] opcode
9e30: 20 69 73 20 75 73 65 64 20 74 6f 20 73 65 74 20   is used to set 
9e40: 6f 72 20 71 75 65 72 79 20 74 68 65 0a 2a 2a 20  or query the.** 
9e50: 70 65 72 73 69 73 74 65 6e 74 20 5b 57 41 4c 20  persistent [WAL 
9e60: 7c 20 57 72 69 74 65 20 41 68 65 61 64 20 4c 6f  | Write Ahead Lo
9e70: 67 5d 20 73 65 74 74 69 6e 67 2e 20 20 42 79 20  g] setting.  By 
9e80: 64 65 66 61 75 6c 74 2c 20 74 68 65 20 61 75 78  default, the aux
9e90: 69 6c 69 61 72 79 0a 2a 2a 20 77 72 69 74 65 20  iliary.** write 
9ea0: 61 68 65 61 64 20 6c 6f 67 20 61 6e 64 20 73 68  ahead log and sh
9eb0: 61 72 65 64 20 6d 65 6d 6f 72 79 20 66 69 6c 65  ared memory file
9ec0: 73 20 75 73 65 64 20 66 6f 72 20 74 72 61 6e 73  s used for trans
9ed0: 61 63 74 69 6f 6e 20 63 6f 6e 74 72 6f 6c 0a 2a  action control.*
9ee0: 2a 20 61 72 65 20 61 75 74 6f 6d 61 74 69 63 61  * are automatica
9ef0: 6c 6c 79 20 64 65 6c 65 74 65 64 20 77 68 65 6e  lly deleted when
9f00: 20 74 68 65 20 6c 61 74 65 73 74 20 63 6f 6e 6e   the latest conn
9f10: 65 63 74 69 6f 6e 20 74 6f 20 74 68 65 20 64 61  ection to the da
9f20: 74 61 62 61 73 65 0a 2a 2a 20 63 6c 6f 73 65 73  tabase.** closes
9f30: 2e 20 20 53 65 74 74 69 6e 67 20 70 65 72 73 69  .  Setting persi
9f40: 73 74 65 6e 74 20 57 41 4c 20 6d 6f 64 65 20 63  stent WAL mode c
9f50: 61 75 73 65 73 20 74 68 6f 73 65 20 66 69 6c 65  auses those file
9f60: 73 20 74 6f 20 70 65 72 73 69 73 74 20 61 66 74  s to persist aft
9f70: 65 72 0a 2a 2a 20 63 6c 6f 73 65 2e 20 20 50 65  er.** close.  Pe
9f80: 72 73 69 73 74 69 6e 67 20 74 68 65 20 66 69 6c  rsisting the fil
9f90: 65 73 20 69 73 20 75 73 65 66 75 6c 20 77 68 65  es is useful whe
9fa0: 6e 20 6f 74 68 65 72 20 70 72 6f 63 65 73 73 65  n other processe
9fb0: 73 20 74 68 61 74 20 64 6f 20 6e 6f 74 0a 2a 2a  s that do not.**
9fc0: 20 68 61 76 65 20 77 72 69 74 65 20 70 65 72 6d   have write perm
9fd0: 69 73 73 69 6f 6e 20 6f 6e 20 74 68 65 20 64 69  ission on the di
9fe0: 72 65 63 74 6f 72 79 20 63 6f 6e 74 61 69 6e 69  rectory containi
9ff0: 6e 67 20 74 68 65 20 64 61 74 61 62 61 73 65 20  ng the database 
a000: 66 69 6c 65 20 77 61 6e 74 0a 2a 2a 20 74 6f 20  file want.** to 
a010: 72 65 61 64 20 74 68 65 20 64 61 74 61 62 61 73  read the databas
a020: 65 20 66 69 6c 65 2c 20 61 73 20 74 68 65 20 57  e file, as the W
a030: 41 4c 20 61 6e 64 20 73 68 61 72 65 64 20 6d 65  AL and shared me
a040: 6d 6f 72 79 20 66 69 6c 65 73 20 6d 75 73 74 20  mory files must 
a050: 65 78 69 73 74 0a 2a 2a 20 69 6e 20 6f 72 64 65  exist.** in orde
a060: 72 20 66 6f 72 20 74 68 65 20 64 61 74 61 62 61  r for the databa
a070: 73 65 20 74 6f 20 62 65 20 72 65 61 64 61 62 6c  se to be readabl
a080: 65 2e 20 20 54 68 65 20 66 6f 75 72 74 68 20 70  e.  The fourth p
a090: 61 72 61 6d 65 74 65 72 20 74 6f 0a 2a 2a 20 5b  arameter to.** [
a0a0: 73 71 6c 69 74 65 33 5f 66 69 6c 65 5f 63 6f 6e  sqlite3_file_con
a0b0: 74 72 6f 6c 28 29 5d 20 66 6f 72 20 74 68 69 73  trol()] for this
a0c0: 20 6f 70 63 6f 64 65 20 73 68 6f 75 6c 64 20 62   opcode should b
a0d0: 65 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61  e a pointer to a
a0e0: 6e 20 69 6e 74 65 67 65 72 2e 0a 2a 2a 20 54 68  n integer..** Th
a0f0: 61 74 20 69 6e 74 65 67 65 72 20 69 73 20 30 20  at integer is 0 
a100: 74 6f 20 64 69 73 61 62 6c 65 20 70 65 72 73 69  to disable persi
a110: 73 74 65 6e 74 20 57 41 4c 20 6d 6f 64 65 20 6f  stent WAL mode o
a120: 72 20 31 20 74 6f 20 65 6e 61 62 6c 65 20 70 65  r 1 to enable pe
a130: 72 73 69 73 74 65 6e 74 0a 2a 2a 20 57 41 4c 20  rsistent.** WAL 
a140: 6d 6f 64 65 2e 20 20 49 66 20 74 68 65 20 69 6e  mode.  If the in
a150: 74 65 67 65 72 20 69 73 20 2d 31 2c 20 74 68 65  teger is -1, the
a160: 6e 20 69 74 20 69 73 20 6f 76 65 72 77 72 69 74  n it is overwrit
a170: 74 65 6e 20 77 69 74 68 20 74 68 65 20 63 75 72  ten with the cur
a180: 72 65 6e 74 0a 2a 2a 20 57 41 4c 20 70 65 72 73  rent.** WAL pers
a190: 69 73 74 65 6e 63 65 20 73 65 74 74 69 6e 67 2e  istence setting.
a1a0: 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c  .**.** <li>[[SQL
a1b0: 49 54 45 5f 46 43 4e 54 4c 5f 50 4f 57 45 52 53  ITE_FCNTL_POWERS
a1c0: 41 46 45 5f 4f 56 45 52 57 52 49 54 45 5d 5d 0a  AFE_OVERWRITE]].
a1d0: 2a 2a 20 5e 54 68 65 20 5b 53 51 4c 49 54 45 5f  ** ^The [SQLITE_
a1e0: 46 43 4e 54 4c 5f 50 4f 57 45 52 53 41 46 45 5f  FCNTL_POWERSAFE_
a1f0: 4f 56 45 52 57 52 49 54 45 5d 20 6f 70 63 6f 64  OVERWRITE] opcod
a200: 65 20 69 73 20 75 73 65 64 20 74 6f 20 73 65 74  e is used to set
a210: 20 6f 72 20 71 75 65 72 79 20 74 68 65 0a 2a 2a   or query the.**
a220: 20 70 65 72 73 69 73 74 65 6e 74 20 22 70 6f 77   persistent "pow
a230: 65 72 73 61 66 65 2d 6f 76 65 72 77 72 69 74 65  ersafe-overwrite
a240: 22 20 6f 72 20 22 50 53 4f 57 22 20 73 65 74 74  " or "PSOW" sett
a250: 69 6e 67 2e 20 20 54 68 65 20 50 53 4f 57 20 73  ing.  The PSOW s
a260: 65 74 74 69 6e 67 0a 2a 2a 20 64 65 74 65 72 6d  etting.** determ
a270: 69 6e 65 73 20 74 68 65 20 5b 53 51 4c 49 54 45  ines the [SQLITE
a280: 5f 49 4f 43 41 50 5f 50 4f 57 45 52 53 41 46 45  _IOCAP_POWERSAFE
a290: 5f 4f 56 45 52 57 52 49 54 45 5d 20 62 69 74 20  _OVERWRITE] bit 
a2a0: 6f 66 20 74 68 65 0a 2a 2a 20 78 44 65 76 69 63  of the.** xDevic
a2b0: 65 43 68 61 72 61 63 74 65 72 69 73 74 69 63 73  eCharacteristics
a2c0: 20 6d 65 74 68 6f 64 73 2e 20 54 68 65 20 66 6f   methods. The fo
a2d0: 75 72 74 68 20 70 61 72 61 6d 65 74 65 72 20 74  urth parameter t
a2e0: 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 66 69  o.** [sqlite3_fi
a2f0: 6c 65 5f 63 6f 6e 74 72 6f 6c 28 29 5d 20 66 6f  le_control()] fo
a300: 72 20 74 68 69 73 20 6f 70 63 6f 64 65 20 73 68  r this opcode sh
a310: 6f 75 6c 64 20 62 65 20 61 20 70 6f 69 6e 74 65  ould be a pointe
a320: 72 20 74 6f 20 61 6e 20 69 6e 74 65 67 65 72 2e  r to an integer.
a330: 0a 2a 2a 20 54 68 61 74 20 69 6e 74 65 67 65 72  .** That integer
a340: 20 69 73 20 30 20 74 6f 20 64 69 73 61 62 6c 65   is 0 to disable
a350: 20 7a 65 72 6f 2d 64 61 6d 61 67 65 20 6d 6f 64   zero-damage mod
a360: 65 20 6f 72 20 31 20 74 6f 20 65 6e 61 62 6c 65  e or 1 to enable
a370: 20 7a 65 72 6f 2d 64 61 6d 61 67 65 0a 2a 2a 20   zero-damage.** 
a380: 6d 6f 64 65 2e 20 20 49 66 20 74 68 65 20 69 6e  mode.  If the in
a390: 74 65 67 65 72 20 69 73 20 2d 31 2c 20 74 68 65  teger is -1, the
a3a0: 6e 20 69 74 20 69 73 20 6f 76 65 72 77 72 69 74  n it is overwrit
a3b0: 74 65 6e 20 77 69 74 68 20 74 68 65 20 63 75 72  ten with the cur
a3c0: 72 65 6e 74 0a 2a 2a 20 7a 65 72 6f 2d 64 61 6d  rent.** zero-dam
a3d0: 61 67 65 20 6d 6f 64 65 20 73 65 74 74 69 6e 67  age mode setting
a3e0: 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 5b 5b 53 51  ..**.** <li>[[SQ
a3f0: 4c 49 54 45 5f 46 43 4e 54 4c 5f 4f 56 45 52 57  LITE_FCNTL_OVERW
a400: 52 49 54 45 5d 5d 0a 2a 2a 20 5e 54 68 65 20 5b  RITE]].** ^The [
a410: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 4f 56 45  SQLITE_FCNTL_OVE
a420: 52 57 52 49 54 45 5d 20 6f 70 63 6f 64 65 20 69  RWRITE] opcode i
a430: 73 20 69 6e 76 6f 6b 65 64 20 62 79 20 53 51 4c  s invoked by SQL
a440: 69 74 65 20 61 66 74 65 72 20 6f 70 65 6e 69 6e  ite after openin
a450: 67 0a 2a 2a 20 61 20 77 72 69 74 65 20 74 72 61  g.** a write tra
a460: 6e 73 61 63 74 69 6f 6e 20 74 6f 20 69 6e 64 69  nsaction to indi
a470: 63 61 74 65 20 74 68 61 74 2c 20 75 6e 6c 65 73  cate that, unles
a480: 73 20 69 74 20 69 73 20 72 6f 6c 6c 65 64 20 62  s it is rolled b
a490: 61 63 6b 20 66 6f 72 20 73 6f 6d 65 0a 2a 2a 20  ack for some.** 
a4a0: 72 65 61 73 6f 6e 2c 20 74 68 65 20 65 6e 74 69  reason, the enti
a4b0: 72 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65  re database file
a4c0: 20 77 69 6c 6c 20 62 65 20 6f 76 65 72 77 72 69   will be overwri
a4d0: 74 74 65 6e 20 62 79 20 74 68 65 20 63 75 72 72  tten by the curr
a4e0: 65 6e 74 20 0a 2a 2a 20 74 72 61 6e 73 61 63 74  ent .** transact
a4f0: 69 6f 6e 2e 20 54 68 69 73 20 69 73 20 75 73 65  ion. This is use
a500: 64 20 62 79 20 56 41 43 55 55 4d 20 6f 70 65 72  d by VACUUM oper
a510: 61 74 69 6f 6e 73 2e 0a 2a 2a 0a 2a 2a 20 3c 6c  ations..**.** <l
a520: 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  i>[[SQLITE_FCNTL
a530: 5f 56 46 53 4e 41 4d 45 5d 5d 0a 2a 2a 20 5e 54  _VFSNAME]].** ^T
a540: 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  he [SQLITE_FCNTL
a550: 5f 56 46 53 4e 41 4d 45 5d 20 6f 70 63 6f 64 65  _VFSNAME] opcode
a560: 20 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20   can be used to 
a570: 6f 62 74 61 69 6e 20 74 68 65 20 6e 61 6d 65 73  obtain the names
a580: 20 6f 66 0a 2a 2a 20 61 6c 6c 20 5b 56 46 53 65   of.** all [VFSe
a590: 73 5d 20 69 6e 20 74 68 65 20 56 46 53 20 73 74  s] in the VFS st
a5a0: 61 63 6b 2e 20 20 54 68 65 20 6e 61 6d 65 73 20  ack.  The names 
a5b0: 61 72 65 20 6f 66 20 61 6c 6c 20 56 46 53 20 73  are of all VFS s
a5c0: 68 69 6d 73 20 61 6e 64 20 74 68 65 0a 2a 2a 20  hims and the.** 
a5d0: 66 69 6e 61 6c 20 62 6f 74 74 6f 6d 2d 6c 65 76  final bottom-lev
a5e0: 65 6c 20 56 46 53 20 61 72 65 20 77 72 69 74 74  el VFS are writt
a5f0: 65 6e 20 69 6e 74 6f 20 6d 65 6d 6f 72 79 20 6f  en into memory o
a600: 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 0a 2a 2a  btained from .**
a610: 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63   [sqlite3_malloc
a620: 28 29 5d 20 61 6e 64 20 74 68 65 20 72 65 73 75  ()] and the resu
a630: 6c 74 20 69 73 20 73 74 6f 72 65 64 20 69 6e 20  lt is stored in 
a640: 74 68 65 20 63 68 61 72 2a 20 76 61 72 69 61 62  the char* variab
a650: 6c 65 0a 2a 2a 20 74 68 61 74 20 74 68 65 20 66  le.** that the f
a660: 6f 75 72 74 68 20 70 61 72 61 6d 65 74 65 72 20  ourth parameter 
a670: 6f 66 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65  of [sqlite3_file
a680: 5f 63 6f 6e 74 72 6f 6c 28 29 5d 20 70 6f 69 6e  _control()] poin
a690: 74 73 20 74 6f 2e 0a 2a 2a 20 54 68 65 20 63 61  ts to..** The ca
a6a0: 6c 6c 65 72 20 69 73 20 72 65 73 70 6f 6e 73 69  ller is responsi
a6b0: 62 6c 65 20 66 6f 72 20 66 72 65 65 69 6e 67 20  ble for freeing 
a6c0: 74 68 65 20 6d 65 6d 6f 72 79 20 77 68 65 6e 20  the memory when 
a6d0: 64 6f 6e 65 2e 20 20 41 73 20 77 69 74 68 0a 2a  done.  As with.*
a6e0: 2a 20 61 6c 6c 20 66 69 6c 65 2d 63 6f 6e 74 72  * all file-contr
a6f0: 6f 6c 20 61 63 74 69 6f 6e 73 2c 20 74 68 65 72  ol actions, ther
a700: 65 20 69 73 20 6e 6f 20 67 75 61 72 61 6e 74 65  e is no guarante
a710: 65 20 74 68 61 74 20 74 68 69 73 20 77 69 6c 6c  e that this will
a720: 20 61 63 74 75 61 6c 6c 79 0a 2a 2a 20 64 6f 20   actually.** do 
a730: 61 6e 79 74 68 69 6e 67 2e 20 20 43 61 6c 6c 65  anything.  Calle
a740: 72 73 20 73 68 6f 75 6c 64 20 69 6e 69 74 69 61  rs should initia
a750: 6c 69 7a 65 20 74 68 65 20 63 68 61 72 2a 20 76  lize the char* v
a760: 61 72 69 61 62 6c 65 20 74 6f 20 61 20 4e 55 4c  ariable to a NUL
a770: 4c 0a 2a 2a 20 70 6f 69 6e 74 65 72 20 69 6e 20  L.** pointer in 
a780: 63 61 73 65 20 74 68 69 73 20 66 69 6c 65 2d 63  case this file-c
a790: 6f 6e 74 72 6f 6c 20 69 73 20 6e 6f 74 20 69 6d  ontrol is not im
a7a0: 70 6c 65 6d 65 6e 74 65 64 2e 20 20 54 68 69 73  plemented.  This
a7b0: 20 66 69 6c 65 2d 63 6f 6e 74 72 6f 6c 0a 2a 2a   file-control.**
a7c0: 20 69 73 20 69 6e 74 65 6e 64 65 64 20 66 6f 72   is intended for
a7d0: 20 64 69 61 67 6e 6f 73 74 69 63 20 75 73 65 20   diagnostic use 
a7e0: 6f 6e 6c 79 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e  only..**.** <li>
a7f0: 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 56  [[SQLITE_FCNTL_V
a800: 46 53 5f 50 4f 49 4e 54 45 52 5d 5d 0a 2a 2a 20  FS_POINTER]].** 
a810: 5e 54 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e  ^The [SQLITE_FCN
a820: 54 4c 5f 56 46 53 5f 50 4f 49 4e 54 45 52 5d 20  TL_VFS_POINTER] 
a830: 6f 70 63 6f 64 65 20 66 69 6e 64 73 20 61 20 70  opcode finds a p
a840: 6f 69 6e 74 65 72 20 74 6f 20 74 68 65 20 74 6f  ointer to the to
a850: 70 2d 6c 65 76 65 6c 0a 2a 2a 20 5b 56 46 53 65  p-level.** [VFSe
a860: 73 5d 20 63 75 72 72 65 6e 74 6c 79 20 69 6e 20  s] currently in 
a870: 75 73 65 2e 20 20 5e 28 54 68 65 20 61 72 67 75  use.  ^(The argu
a880: 6d 65 6e 74 20 58 20 69 6e 0a 2a 2a 20 73 71 6c  ment X in.** sql
a890: 69 74 65 33 5f 66 69 6c 65 5f 63 6f 6e 74 72 6f  ite3_file_contro
a8a0: 6c 28 64 62 2c 53 51 4c 49 54 45 5f 46 43 4e 54  l(db,SQLITE_FCNT
a8b0: 4c 5f 56 46 53 5f 50 4f 49 4e 54 45 52 2c 58 29  L_VFS_POINTER,X)
a8c0: 20 6d 75 73 74 20 62 65 0a 2a 2a 20 6f 66 20 74   must be.** of t
a8d0: 79 70 65 20 22 5b 73 71 6c 69 74 65 33 5f 76 66  ype "[sqlite3_vf
a8e0: 73 5d 20 2a 2a 22 2e 20 20 54 68 69 73 20 6f 70  s] **".  This op
a8f0: 63 6f 64 65 73 20 77 69 6c 6c 20 73 65 74 20 2a  codes will set *
a900: 58 0a 2a 2a 20 74 6f 20 61 20 70 6f 69 6e 74 65  X.** to a pointe
a910: 72 20 74 6f 20 74 68 65 20 74 6f 70 2d 6c 65 76  r to the top-lev
a920: 65 6c 20 56 46 53 2e 29 5e 0a 2a 2a 20 5e 57 68  el VFS.)^.** ^Wh
a930: 65 6e 20 74 68 65 72 65 20 61 72 65 20 6d 75 6c  en there are mul
a940: 74 69 70 6c 65 20 56 46 53 20 73 68 69 6d 73 20  tiple VFS shims 
a950: 69 6e 20 74 68 65 20 73 74 61 63 6b 2c 20 74 68  in the stack, th
a960: 69 73 20 6f 70 63 6f 64 65 20 66 69 6e 64 73 20  is opcode finds 
a970: 74 68 65 0a 2a 2a 20 75 70 70 65 72 2d 6d 6f 73  the.** upper-mos
a980: 74 20 73 68 69 6d 20 6f 6e 6c 79 2e 0a 2a 2a 0a  t shim only..**.
a990: 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f  ** <li>[[SQLITE_
a9a0: 46 43 4e 54 4c 5f 50 52 41 47 4d 41 5d 5d 0a 2a  FCNTL_PRAGMA]].*
a9b0: 2a 20 5e 57 68 65 6e 65 76 65 72 20 61 20 5b 50  * ^Whenever a [P
a9c0: 52 41 47 4d 41 5d 20 73 74 61 74 65 6d 65 6e 74  RAGMA] statement
a9d0: 20 69 73 20 70 61 72 73 65 64 2c 20 61 6e 20 5b   is parsed, an [
a9e0: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 50 52 41  SQLITE_FCNTL_PRA
a9f0: 47 4d 41 5d 20 0a 2a 2a 20 66 69 6c 65 20 63 6f  GMA] .** file co
aa00: 6e 74 72 6f 6c 20 69 73 20 73 65 6e 74 20 74 6f  ntrol is sent to
aa10: 20 74 68 65 20 6f 70 65 6e 20 5b 73 71 6c 69 74   the open [sqlit
aa20: 65 33 5f 66 69 6c 65 5d 20 6f 62 6a 65 63 74 20  e3_file] object 
aa30: 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 0a 2a 2a  corresponding.**
aa40: 20 74 6f 20 74 68 65 20 64 61 74 61 62 61 73 65   to the database
aa50: 20 66 69 6c 65 20 74 6f 20 77 68 69 63 68 20 74   file to which t
aa60: 68 65 20 70 72 61 67 6d 61 20 73 74 61 74 65 6d  he pragma statem
aa70: 65 6e 74 20 72 65 66 65 72 73 2e 20 5e 54 68 65  ent refers. ^The
aa80: 20 61 72 67 75 6d 65 6e 74 0a 2a 2a 20 74 6f 20   argument.** to 
aa90: 74 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54  the [SQLITE_FCNT
aaa0: 4c 5f 50 52 41 47 4d 41 5d 20 66 69 6c 65 20 63  L_PRAGMA] file c
aab0: 6f 6e 74 72 6f 6c 20 69 73 20 61 6e 20 61 72 72  ontrol is an arr
aac0: 61 79 20 6f 66 0a 2a 2a 20 70 6f 69 6e 74 65 72  ay of.** pointer
aad0: 73 20 74 6f 20 73 74 72 69 6e 67 73 20 28 63 68  s to strings (ch
aae0: 61 72 2a 2a 29 20 69 6e 20 77 68 69 63 68 20 74  ar**) in which t
aaf0: 68 65 20 73 65 63 6f 6e 64 20 65 6c 65 6d 65 6e  he second elemen
ab00: 74 20 6f 66 20 74 68 65 20 61 72 72 61 79 0a 2a  t of the array.*
ab10: 2a 20 69 73 20 74 68 65 20 6e 61 6d 65 20 6f 66  * is the name of
ab20: 20 74 68 65 20 70 72 61 67 6d 61 20 61 6e 64 20   the pragma and 
ab30: 74 68 65 20 74 68 69 72 64 20 65 6c 65 6d 65 6e  the third elemen
ab40: 74 20 69 73 20 74 68 65 20 61 72 67 75 6d 65 6e  t is the argumen
ab50: 74 20 74 6f 20 74 68 65 0a 2a 2a 20 70 72 61 67  t to the.** prag
ab60: 6d 61 20 6f 72 20 4e 55 4c 4c 20 69 66 20 74 68  ma or NULL if th
ab70: 65 20 70 72 61 67 6d 61 20 68 61 73 20 6e 6f 20  e pragma has no 
ab80: 61 72 67 75 6d 65 6e 74 2e 20 20 5e 54 68 65 20  argument.  ^The 
ab90: 68 61 6e 64 6c 65 72 20 66 6f 72 20 61 6e 0a 2a  handler for an.*
aba0: 2a 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  * [SQLITE_FCNTL_
abb0: 50 52 41 47 4d 41 5d 20 66 69 6c 65 20 63 6f 6e  PRAGMA] file con
abc0: 74 72 6f 6c 20 63 61 6e 20 6f 70 74 69 6f 6e 61  trol can optiona
abd0: 6c 6c 79 20 6d 61 6b 65 20 74 68 65 20 66 69 72  lly make the fir
abe0: 73 74 20 65 6c 65 6d 65 6e 74 0a 2a 2a 20 6f 66  st element.** of
abf0: 20 74 68 65 20 63 68 61 72 2a 2a 20 61 72 67 75   the char** argu
ac00: 6d 65 6e 74 20 70 6f 69 6e 74 20 74 6f 20 61 20  ment point to a 
ac10: 73 74 72 69 6e 67 20 6f 62 74 61 69 6e 65 64 20  string obtained 
ac20: 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 6d 70  from [sqlite3_mp
ac30: 72 69 6e 74 66 28 29 5d 0a 2a 2a 20 6f 72 20 74  rintf()].** or t
ac40: 68 65 20 65 71 75 69 76 61 6c 65 6e 74 20 61 6e  he equivalent an
ac50: 64 20 74 68 61 74 20 73 74 72 69 6e 67 20 77 69  d that string wi
ac60: 6c 6c 20 62 65 63 6f 6d 65 20 74 68 65 20 72 65  ll become the re
ac70: 73 75 6c 74 20 6f 66 20 74 68 65 20 70 72 61 67  sult of the prag
ac80: 6d 61 20 6f 72 0a 2a 2a 20 74 68 65 20 65 72 72  ma or.** the err
ac90: 6f 72 20 6d 65 73 73 61 67 65 20 69 66 20 74 68  or message if th
aca0: 65 20 70 72 61 67 6d 61 20 66 61 69 6c 73 2e 20  e pragma fails. 
acb0: 5e 49 66 20 74 68 65 0a 2a 2a 20 5b 53 51 4c 49  ^If the.** [SQLI
acc0: 54 45 5f 46 43 4e 54 4c 5f 50 52 41 47 4d 41 5d  TE_FCNTL_PRAGMA]
acd0: 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 72 65   file control re
ace0: 74 75 72 6e 73 20 5b 53 51 4c 49 54 45 5f 4e 4f  turns [SQLITE_NO
acf0: 54 46 4f 55 4e 44 5d 2c 20 74 68 65 6e 20 6e 6f  TFOUND], then no
ad00: 72 6d 61 6c 20 0a 2a 2a 20 5b 50 52 41 47 4d 41  rmal .** [PRAGMA
ad10: 5d 20 70 72 6f 63 65 73 73 69 6e 67 20 63 6f 6e  ] processing con
ad20: 74 69 6e 75 65 73 2e 20 20 5e 49 66 20 74 68 65  tinues.  ^If the
ad30: 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 50   [SQLITE_FCNTL_P
ad40: 52 41 47 4d 41 5d 0a 2a 2a 20 66 69 6c 65 20 63  RAGMA].** file c
ad50: 6f 6e 74 72 6f 6c 20 72 65 74 75 72 6e 73 20 5b  ontrol returns [
ad60: 53 51 4c 49 54 45 5f 4f 4b 5d 2c 20 74 68 65 6e  SQLITE_OK], then
ad70: 20 74 68 65 20 70 61 72 73 65 72 20 61 73 73 75   the parser assu
ad80: 6d 65 73 20 74 68 61 74 20 74 68 65 0a 2a 2a 20  mes that the.** 
ad90: 56 46 53 20 68 61 73 20 68 61 6e 64 6c 65 64 20  VFS has handled 
ada0: 74 68 65 20 50 52 41 47 4d 41 20 69 74 73 65 6c  the PRAGMA itsel
adb0: 66 20 61 6e 64 20 74 68 65 20 70 61 72 73 65 72  f and the parser
adc0: 20 67 65 6e 65 72 61 74 65 73 20 61 20 6e 6f 2d   generates a no-
add0: 6f 70 0a 2a 2a 20 70 72 65 70 61 72 65 64 20 73  op.** prepared s
ade0: 74 61 74 65 6d 65 6e 74 20 69 66 20 72 65 73 75  tatement if resu
adf0: 6c 74 20 73 74 72 69 6e 67 20 69 73 20 4e 55 4c  lt string is NUL
ae00: 4c 2c 20 6f 72 20 74 68 61 74 20 72 65 74 75 72  L, or that retur
ae10: 6e 73 20 61 20 63 6f 70 79 0a 2a 2a 20 6f 66 20  ns a copy.** of 
ae20: 74 68 65 20 72 65 73 75 6c 74 20 73 74 72 69 6e  the result strin
ae30: 67 20 69 66 20 74 68 65 20 73 74 72 69 6e 67 20  g if the string 
ae40: 69 73 20 6e 6f 6e 2d 4e 55 4c 4c 2e 0a 2a 2a 20  is non-NULL..** 
ae50: 5e 49 66 20 74 68 65 20 5b 53 51 4c 49 54 45 5f  ^If the [SQLITE_
ae60: 46 43 4e 54 4c 5f 50 52 41 47 4d 41 5d 20 66 69  FCNTL_PRAGMA] fi
ae70: 6c 65 20 63 6f 6e 74 72 6f 6c 20 72 65 74 75 72  le control retur
ae80: 6e 73 0a 2a 2a 20 61 6e 79 20 72 65 73 75 6c 74  ns.** any result
ae90: 20 63 6f 64 65 20 6f 74 68 65 72 20 74 68 61 6e   code other than
aea0: 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 6f 72 20   [SQLITE_OK] or 
aeb0: 5b 53 51 4c 49 54 45 5f 4e 4f 54 46 4f 55 4e 44  [SQLITE_NOTFOUND
aec0: 5d 2c 20 74 68 61 74 20 6d 65 61 6e 73 0a 2a 2a  ], that means.**
aed0: 20 74 68 61 74 20 74 68 65 20 56 46 53 20 65 6e   that the VFS en
aee0: 63 6f 75 6e 74 65 72 65 64 20 61 6e 20 65 72 72  countered an err
aef0: 6f 72 20 77 68 69 6c 65 20 68 61 6e 64 6c 69 6e  or while handlin
af00: 67 20 74 68 65 20 5b 50 52 41 47 4d 41 5d 20 61  g the [PRAGMA] a
af10: 6e 64 20 74 68 65 0a 2a 2a 20 63 6f 6d 70 69 6c  nd the.** compil
af20: 61 74 69 6f 6e 20 6f 66 20 74 68 65 20 50 52 41  ation of the PRA
af30: 47 4d 41 20 66 61 69 6c 73 20 77 69 74 68 20 61  GMA fails with a
af40: 6e 20 65 72 72 6f 72 2e 20 20 5e 54 68 65 20 5b  n error.  ^The [
af50: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 50 52 41  SQLITE_FCNTL_PRA
af60: 47 4d 41 5d 0a 2a 2a 20 66 69 6c 65 20 63 6f 6e  GMA].** file con
af70: 74 72 6f 6c 20 6f 63 63 75 72 73 20 61 74 20 74  trol occurs at t
af80: 68 65 20 62 65 67 69 6e 6e 69 6e 67 20 6f 66 20  he beginning of 
af90: 70 72 61 67 6d 61 20 73 74 61 74 65 6d 65 6e 74  pragma statement
afa0: 20 61 6e 61 6c 79 73 69 73 20 61 6e 64 20 73 6f   analysis and so
afb0: 0a 2a 2a 20 69 74 20 69 73 20 61 62 6c 65 20 74  .** it is able t
afc0: 6f 20 6f 76 65 72 72 69 64 65 20 62 75 69 6c 74  o override built
afd0: 2d 69 6e 20 5b 50 52 41 47 4d 41 5d 20 73 74 61  -in [PRAGMA] sta
afe0: 74 65 6d 65 6e 74 73 2e 0a 2a 2a 0a 2a 2a 20 3c  tements..**.** <
aff0: 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54  li>[[SQLITE_FCNT
b000: 4c 5f 42 55 53 59 48 41 4e 44 4c 45 52 5d 5d 0a  L_BUSYHANDLER]].
b010: 2a 2a 20 5e 54 68 65 20 5b 53 51 4c 49 54 45 5f  ** ^The [SQLITE_
b020: 46 43 4e 54 4c 5f 42 55 53 59 48 41 4e 44 4c 45  FCNTL_BUSYHANDLE
b030: 52 5d 0a 2a 2a 20 66 69 6c 65 2d 63 6f 6e 74 72  R].** file-contr
b040: 6f 6c 20 6d 61 79 20 62 65 20 69 6e 76 6f 6b 65  ol may be invoke
b050: 64 20 62 79 20 53 51 4c 69 74 65 20 6f 6e 20 74  d by SQLite on t
b060: 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65  he database file
b070: 20 68 61 6e 64 6c 65 0a 2a 2a 20 73 68 6f 72 74   handle.** short
b080: 6c 79 20 61 66 74 65 72 20 69 74 20 69 73 20 6f  ly after it is o
b090: 70 65 6e 65 64 20 69 6e 20 6f 72 64 65 72 20 74  pened in order t
b0a0: 6f 20 70 72 6f 76 69 64 65 20 61 20 63 75 73 74  o provide a cust
b0b0: 6f 6d 20 56 46 53 20 77 69 74 68 20 61 63 63 65  om VFS with acce
b0c0: 73 73 0a 2a 2a 20 74 6f 20 74 68 65 20 63 6f 6e  ss.** to the con
b0d0: 6e 65 63 74 69 6f 6e 73 20 62 75 73 79 2d 68 61  nections busy-ha
b0e0: 6e 64 6c 65 72 20 63 61 6c 6c 62 61 63 6b 2e 20  ndler callback. 
b0f0: 54 68 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20  The argument is 
b100: 6f 66 20 74 79 70 65 20 28 76 6f 69 64 20 2a 2a  of type (void **
b110: 29 0a 2a 2a 20 2d 20 61 6e 20 61 72 72 61 79 20  ).** - an array 
b120: 6f 66 20 74 77 6f 20 28 76 6f 69 64 20 2a 29 20  of two (void *) 
b130: 76 61 6c 75 65 73 2e 20 54 68 65 20 66 69 72 73  values. The firs
b140: 74 20 28 76 6f 69 64 20 2a 29 20 61 63 74 75 61  t (void *) actua
b150: 6c 6c 79 20 70 6f 69 6e 74 73 0a 2a 2a 20 74 6f  lly points.** to
b160: 20 61 20 66 75 6e 63 74 69 6f 6e 20 6f 66 20 74   a function of t
b170: 79 70 65 20 28 69 6e 74 20 28 2a 29 28 76 6f 69  ype (int (*)(voi
b180: 64 20 2a 29 29 2e 20 49 6e 20 6f 72 64 65 72 20  d *)). In order 
b190: 74 6f 20 69 6e 76 6f 6b 65 20 74 68 65 20 63 6f  to invoke the co
b1a0: 6e 6e 65 63 74 69 6f 6e 73 0a 2a 2a 20 62 75 73  nnections.** bus
b1b0: 79 2d 68 61 6e 64 6c 65 72 2c 20 74 68 69 73 20  y-handler, this 
b1c0: 66 75 6e 63 74 69 6f 6e 20 73 68 6f 75 6c 64 20  function should 
b1d0: 62 65 20 69 6e 76 6f 6b 65 64 20 77 69 74 68 20  be invoked with 
b1e0: 74 68 65 20 73 65 63 6f 6e 64 20 28 76 6f 69 64  the second (void
b1f0: 20 2a 29 20 69 6e 0a 2a 2a 20 74 68 65 20 61 72   *) in.** the ar
b200: 72 61 79 20 61 73 20 74 68 65 20 6f 6e 6c 79 20  ray as the only 
b210: 61 72 67 75 6d 65 6e 74 2e 20 49 66 20 69 74 20  argument. If it 
b220: 72 65 74 75 72 6e 73 20 6e 6f 6e 2d 7a 65 72 6f  returns non-zero
b230: 2c 20 74 68 65 6e 20 74 68 65 20 6f 70 65 72 61  , then the opera
b240: 74 69 6f 6e 0a 2a 2a 20 73 68 6f 75 6c 64 20 62  tion.** should b
b250: 65 20 72 65 74 72 69 65 64 2e 20 49 66 20 69 74  e retried. If it
b260: 20 72 65 74 75 72 6e 73 20 7a 65 72 6f 2c 20 74   returns zero, t
b270: 68 65 20 63 75 73 74 6f 6d 20 56 46 53 20 73 68  he custom VFS sh
b280: 6f 75 6c 64 20 61 62 61 6e 64 6f 6e 20 74 68 65  ould abandon the
b290: 0a 2a 2a 20 63 75 72 72 65 6e 74 20 6f 70 65 72  .** current oper
b2a0: 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69  ation..**.** <li
b2b0: 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  >[[SQLITE_FCNTL_
b2c0: 54 45 4d 50 46 49 4c 45 4e 41 4d 45 5d 5d 0a 2a  TEMPFILENAME]].*
b2d0: 2a 20 5e 41 70 70 6c 69 63 61 74 69 6f 6e 20 63  * ^Application c
b2e0: 61 6e 20 69 6e 76 6f 6b 65 20 74 68 65 20 5b 53  an invoke the [S
b2f0: 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 54 45 4d 50  QLITE_FCNTL_TEMP
b300: 46 49 4c 45 4e 41 4d 45 5d 20 66 69 6c 65 2d 63  FILENAME] file-c
b310: 6f 6e 74 72 6f 6c 0a 2a 2a 20 74 6f 20 68 61 76  ontrol.** to hav
b320: 65 20 53 51 4c 69 74 65 20 67 65 6e 65 72 61 74  e SQLite generat
b330: 65 20 61 0a 2a 2a 20 74 65 6d 70 6f 72 61 72 79  e a.** temporary
b340: 20 66 69 6c 65 6e 61 6d 65 20 75 73 69 6e 67 20   filename using 
b350: 74 68 65 20 73 61 6d 65 20 61 6c 67 6f 72 69 74  the same algorit
b360: 68 6d 20 74 68 61 74 20 69 73 20 66 6f 6c 6c 6f  hm that is follo
b370: 77 65 64 20 74 6f 20 67 65 6e 65 72 61 74 65 0a  wed to generate.
b380: 2a 2a 20 74 65 6d 70 6f 72 61 72 79 20 66 69 6c  ** temporary fil
b390: 65 6e 61 6d 65 73 20 66 6f 72 20 54 45 4d 50 20  enames for TEMP 
b3a0: 74 61 62 6c 65 73 20 61 6e 64 20 6f 74 68 65 72  tables and other
b3b0: 20 69 6e 74 65 72 6e 61 6c 20 75 73 65 73 2e 20   internal uses. 
b3c0: 20 54 68 65 0a 2a 2a 20 61 72 67 75 6d 65 6e 74   The.** argument
b3d0: 20 73 68 6f 75 6c 64 20 62 65 20 61 20 63 68 61   should be a cha
b3e0: 72 2a 2a 20 77 68 69 63 68 20 77 69 6c 6c 20 62  r** which will b
b3f0: 65 20 66 69 6c 6c 65 64 20 77 69 74 68 20 74 68  e filled with th
b400: 65 20 66 69 6c 65 6e 61 6d 65 0a 2a 2a 20 77 72  e filename.** wr
b410: 69 74 74 65 6e 20 69 6e 74 6f 20 6d 65 6d 6f 72  itten into memor
b420: 79 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20  y obtained from 
b430: 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28  [sqlite3_malloc(
b440: 29 5d 2e 20 20 54 68 65 20 63 61 6c 6c 65 72 20  )].  The caller 
b450: 73 68 6f 75 6c 64 0a 2a 2a 20 69 6e 76 6f 6b 65  should.** invoke
b460: 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29   [sqlite3_free()
b470: 5d 20 6f 6e 20 74 68 65 20 72 65 73 75 6c 74 20  ] on the result 
b480: 74 6f 20 61 76 6f 69 64 20 61 20 6d 65 6d 6f 72  to avoid a memor
b490: 79 20 6c 65 61 6b 2e 0a 2a 2a 0a 2a 2a 20 3c 6c  y leak..**.** <l
b4a0: 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  i>[[SQLITE_FCNTL
b4b0: 5f 4d 4d 41 50 5f 53 49 5a 45 5d 5d 0a 2a 2a 20  _MMAP_SIZE]].** 
b4c0: 54 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54  The [SQLITE_FCNT
b4d0: 4c 5f 4d 4d 41 50 5f 53 49 5a 45 5d 20 66 69 6c  L_MMAP_SIZE] fil
b4e0: 65 20 63 6f 6e 74 72 6f 6c 20 69 73 20 75 73 65  e control is use
b4f0: 64 20 74 6f 20 71 75 65 72 79 20 6f 72 20 73 65  d to query or se
b500: 74 20 74 68 65 0a 2a 2a 20 6d 61 78 69 6d 75 6d  t the.** maximum
b510: 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73   number of bytes
b520: 20 74 68 61 74 20 77 69 6c 6c 20 62 65 20 75 73   that will be us
b530: 65 64 20 66 6f 72 20 6d 65 6d 6f 72 79 2d 6d 61  ed for memory-ma
b540: 70 70 65 64 20 49 2f 4f 2e 0a 2a 2a 20 54 68 65  pped I/O..** The
b550: 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 20 70   argument is a p
b560: 6f 69 6e 74 65 72 20 74 6f 20 61 20 76 61 6c 75  ointer to a valu
b570: 65 20 6f 66 20 74 79 70 65 20 73 71 6c 69 74 65  e of type sqlite
b580: 33 5f 69 6e 74 36 34 20 74 68 61 74 0a 2a 2a 20  3_int64 that.** 
b590: 69 73 20 61 6e 20 61 64 76 69 73 6f 72 79 20 6d  is an advisory m
b5a0: 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f 66  aximum number of
b5b0: 20 62 79 74 65 73 20 69 6e 20 74 68 65 20 66 69   bytes in the fi
b5c0: 6c 65 20 74 6f 20 6d 65 6d 6f 72 79 20 6d 61 70  le to memory map
b5d0: 2e 20 20 54 68 65 0a 2a 2a 20 70 6f 69 6e 74 65  .  The.** pointe
b5e0: 72 20 69 73 20 6f 76 65 72 77 72 69 74 74 65 6e  r is overwritten
b5f0: 20 77 69 74 68 20 74 68 65 20 6f 6c 64 20 76 61   with the old va
b600: 6c 75 65 2e 20 20 54 68 65 20 6c 69 6d 69 74 20  lue.  The limit 
b610: 69 73 20 6e 6f 74 20 63 68 61 6e 67 65 64 20 69  is not changed i
b620: 66 0a 2a 2a 20 74 68 65 20 76 61 6c 75 65 20 6f  f.** the value o
b630: 72 69 67 69 6e 61 6c 6c 79 20 70 6f 69 6e 74 65  riginally pointe
b640: 64 20 74 6f 20 69 73 20 6e 65 67 61 74 69 76 65  d to is negative
b650: 2c 20 61 6e 64 20 73 6f 20 74 68 65 20 63 75 72  , and so the cur
b660: 72 65 6e 74 20 6c 69 6d 69 74 20 0a 2a 2a 20 63  rent limit .** c
b670: 61 6e 20 62 65 20 71 75 65 72 69 65 64 20 62 79  an be queried by
b680: 20 70 61 73 73 69 6e 67 20 69 6e 20 61 20 70 6f   passing in a po
b690: 69 6e 74 65 72 20 74 6f 20 61 20 6e 65 67 61 74  inter to a negat
b6a0: 69 76 65 20 6e 75 6d 62 65 72 2e 20 20 54 68 69  ive number.  Thi
b6b0: 73 0a 2a 2a 20 66 69 6c 65 2d 63 6f 6e 74 72 6f  s.** file-contro
b6c0: 6c 20 69 73 20 75 73 65 64 20 69 6e 74 65 72 6e  l is used intern
b6d0: 61 6c 6c 79 20 74 6f 20 69 6d 70 6c 65 6d 65 6e  ally to implemen
b6e0: 74 20 5b 50 52 41 47 4d 41 20 6d 6d 61 70 5f 73  t [PRAGMA mmap_s
b6f0: 69 7a 65 5d 2e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e  ize]..**.** <li>
b700: 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 54  [[SQLITE_FCNTL_T
b710: 52 41 43 45 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53  RACE]].** The [S
b720: 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 54 52 41 43  QLITE_FCNTL_TRAC
b730: 45 5d 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20  E] file control 
b740: 70 72 6f 76 69 64 65 73 20 61 64 76 69 73 6f 72  provides advisor
b750: 79 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 0a 2a 2a  y information.**
b760: 20 74 6f 20 74 68 65 20 56 46 53 20 61 62 6f 75   to the VFS abou
b770: 74 20 77 68 61 74 20 74 68 65 20 68 69 67 68 65  t what the highe
b780: 72 20 6c 61 79 65 72 73 20 6f 66 20 74 68 65 20  r layers of the 
b790: 53 51 4c 69 74 65 20 73 74 61 63 6b 20 61 72 65  SQLite stack are
b7a0: 20 64 6f 69 6e 67 2e 0a 2a 2a 20 54 68 69 73 20   doing..** This 
b7b0: 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 69 73 20  file control is 
b7c0: 75 73 65 64 20 62 79 20 73 6f 6d 65 20 56 46 53  used by some VFS
b7d0: 20 61 63 74 69 76 69 74 79 20 74 72 61 63 69 6e   activity tracin
b7e0: 67 20 5b 73 68 69 6d 73 5d 2e 0a 2a 2a 20 54 68  g [shims]..** Th
b7f0: 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 20  e argument is a 
b800: 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 20  zero-terminated 
b810: 73 74 72 69 6e 67 2e 20 20 48 69 67 68 65 72 20  string.  Higher 
b820: 6c 61 79 65 72 73 20 69 6e 20 74 68 65 0a 2a 2a  layers in the.**
b830: 20 53 51 4c 69 74 65 20 73 74 61 63 6b 20 6d 61   SQLite stack ma
b840: 79 20 67 65 6e 65 72 61 74 65 20 69 6e 73 74 61  y generate insta
b850: 6e 63 65 73 20 6f 66 20 74 68 69 73 20 66 69 6c  nces of this fil
b860: 65 20 63 6f 6e 74 72 6f 6c 20 69 66 0a 2a 2a 20  e control if.** 
b870: 74 68 65 20 5b 53 51 4c 49 54 45 5f 55 53 45 5f  the [SQLITE_USE_
b880: 46 43 4e 54 4c 5f 54 52 41 43 45 5d 20 63 6f 6d  FCNTL_TRACE] com
b890: 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e  pile-time option
b8a0: 20 69 73 20 65 6e 61 62 6c 65 64 2e 0a 2a 2a 0a   is enabled..**.
b8b0: 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f  ** <li>[[SQLITE_
b8c0: 46 43 4e 54 4c 5f 48 41 53 5f 4d 4f 56 45 44 5d  FCNTL_HAS_MOVED]
b8d0: 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54 45  ].** The [SQLITE
b8e0: 5f 46 43 4e 54 4c 5f 48 41 53 5f 4d 4f 56 45 44  _FCNTL_HAS_MOVED
b8f0: 5d 20 66 69 6c 65 20 63 6f 6e 74 72 6f 6c 20 69  ] file control i
b900: 6e 74 65 72 70 72 65 74 73 20 69 74 73 20 61 72  nterprets its ar
b910: 67 75 6d 65 6e 74 20 61 73 20 61 0a 2a 2a 20 70  gument as a.** p
b920: 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 69 6e 74  ointer to an int
b930: 65 67 65 72 20 61 6e 64 20 69 74 20 77 72 69 74  eger and it writ
b940: 65 73 20 61 20 62 6f 6f 6c 65 61 6e 20 69 6e 74  es a boolean int
b950: 6f 20 74 68 61 74 20 69 6e 74 65 67 65 72 20 64  o that integer d
b960: 65 70 65 6e 64 69 6e 67 0a 2a 2a 20 6f 6e 20 77  epending.** on w
b970: 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20 74 68  hether or not th
b980: 65 20 66 69 6c 65 20 68 61 73 20 62 65 65 6e 20  e file has been 
b990: 72 65 6e 61 6d 65 64 2c 20 6d 6f 76 65 64 2c 20  renamed, moved, 
b9a0: 6f 72 20 64 65 6c 65 74 65 64 20 73 69 6e 63 65  or deleted since
b9b0: 20 69 74 0a 2a 2a 20 77 61 73 20 66 69 72 73 74   it.** was first
b9c0: 20 6f 70 65 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 3c   opened..**.** <
b9d0: 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54  li>[[SQLITE_FCNT
b9e0: 4c 5f 57 49 4e 33 32 5f 53 45 54 5f 48 41 4e 44  L_WIN32_SET_HAND
b9f0: 4c 45 5d 5d 0a 2a 2a 20 54 68 65 20 5b 53 51 4c  LE]].** The [SQL
ba00: 49 54 45 5f 46 43 4e 54 4c 5f 57 49 4e 33 32 5f  ITE_FCNTL_WIN32_
ba10: 53 45 54 5f 48 41 4e 44 4c 45 5d 20 6f 70 63 6f  SET_HANDLE] opco
ba20: 64 65 20 69 73 20 75 73 65 64 20 66 6f 72 20 64  de is used for d
ba30: 65 62 75 67 67 69 6e 67 2e 20 20 54 68 69 73 0a  ebugging.  This.
ba40: 2a 2a 20 6f 70 63 6f 64 65 20 63 61 75 73 65 73  ** opcode causes
ba50: 20 74 68 65 20 78 46 69 6c 65 43 6f 6e 74 72 6f   the xFileContro
ba60: 6c 20 6d 65 74 68 6f 64 20 74 6f 20 73 77 61 70  l method to swap
ba70: 20 74 68 65 20 66 69 6c 65 20 68 61 6e 64 6c 65   the file handle
ba80: 20 77 69 74 68 20 74 68 65 20 6f 6e 65 0a 2a 2a   with the one.**
ba90: 20 70 6f 69 6e 74 65 64 20 74 6f 20 62 79 20 74   pointed to by t
baa0: 68 65 20 70 41 72 67 20 61 72 67 75 6d 65 6e 74  he pArg argument
bab0: 2e 20 20 54 68 69 73 20 63 61 70 61 62 69 6c 69  .  This capabili
bac0: 74 79 20 69 73 20 75 73 65 64 20 64 75 72 69 6e  ty is used durin
bad0: 67 20 74 65 73 74 69 6e 67 0a 2a 2a 20 61 6e 64  g testing.** and
bae0: 20 6f 6e 6c 79 20 6e 65 65 64 73 20 74 6f 20 62   only needs to b
baf0: 65 20 73 75 70 70 6f 72 74 65 64 20 77 68 65 6e  e supported when
bb00: 20 53 51 4c 49 54 45 5f 54 45 53 54 20 69 73 20   SQLITE_TEST is 
bb10: 64 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 3c  defined..**.** <
bb20: 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54  li>[[SQLITE_FCNT
bb30: 4c 5f 57 41 4c 5f 42 4c 4f 43 4b 5d 5d 0a 2a 2a  L_WAL_BLOCK]].**
bb40: 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e   The [SQLITE_FCN
bb50: 54 4c 5f 57 41 4c 5f 42 4c 4f 43 4b 5d 20 69 73  TL_WAL_BLOCK] is
bb60: 20 61 20 73 69 67 6e 61 6c 20 74 6f 20 74 68 65   a signal to the
bb70: 20 56 46 53 20 6c 61 79 65 72 20 74 68 61 74 20   VFS layer that 
bb80: 69 74 20 6d 69 67 68 74 0a 2a 2a 20 62 65 20 61  it might.** be a
bb90: 64 76 61 6e 74 61 67 65 6f 75 73 20 74 6f 20 62  dvantageous to b
bba0: 6c 6f 63 6b 20 6f 6e 20 74 68 65 20 6e 65 78 74  lock on the next
bbb0: 20 57 41 4c 20 6c 6f 63 6b 20 69 66 20 74 68 65   WAL lock if the
bbc0: 20 6c 6f 63 6b 20 69 73 20 6e 6f 74 20 69 6d 6d   lock is not imm
bbd0: 65 64 69 61 74 65 6c 79 0a 2a 2a 20 61 76 61 69  ediately.** avai
bbe0: 6c 61 62 6c 65 2e 20 20 54 68 65 20 57 41 4c 20  lable.  The WAL 
bbf0: 73 75 62 73 79 73 74 65 6d 20 69 73 73 75 65 73  subsystem issues
bc00: 20 74 68 69 73 20 73 69 67 6e 61 6c 20 64 75 72   this signal dur
bc10: 69 6e 67 20 72 61 72 65 0a 2a 2a 20 63 69 72 63  ing rare.** circ
bc20: 75 6d 73 74 61 6e 63 65 73 20 69 6e 20 6f 72 64  umstances in ord
bc30: 65 72 20 74 6f 20 66 69 78 20 61 20 70 72 6f 62  er to fix a prob
bc40: 6c 65 6d 20 77 69 74 68 20 70 72 69 6f 72 69 74  lem with priorit
bc50: 79 20 69 6e 76 65 72 73 69 6f 6e 2e 0a 2a 2a 20  y inversion..** 
bc60: 41 70 70 6c 69 63 61 74 69 6f 6e 73 20 73 68 6f  Applications sho
bc70: 75 6c 64 20 3c 65 6d 3e 6e 6f 74 3c 2f 65 6d 3e  uld <em>not</em>
bc80: 20 75 73 65 20 74 68 69 73 20 66 69 6c 65 2d 63   use this file-c
bc90: 6f 6e 74 72 6f 6c 2e 0a 2a 2a 0a 2a 2a 20 3c 6c  ontrol..**.** <l
bca0: 69 3e 5b 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  i>[[SQLITE_FCNTL
bcb0: 5f 5a 49 50 56 46 53 5d 5d 0a 2a 2a 20 54 68 65  _ZIPVFS]].** The
bcc0: 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 5a   [SQLITE_FCNTL_Z
bcd0: 49 50 56 46 53 5d 20 6f 70 63 6f 64 65 20 69 73  IPVFS] opcode is
bce0: 20 69 6d 70 6c 65 6d 65 6e 74 65 64 20 62 79 20   implemented by 
bcf0: 7a 69 70 76 66 73 20 6f 6e 6c 79 2e 20 41 6c 6c  zipvfs only. All
bd00: 20 6f 74 68 65 72 0a 2a 2a 20 56 46 53 20 73 68   other.** VFS sh
bd10: 6f 75 6c 64 20 72 65 74 75 72 6e 20 53 51 4c 49  ould return SQLI
bd20: 54 45 5f 4e 4f 54 46 4f 55 4e 44 20 66 6f 72 20  TE_NOTFOUND for 
bd30: 74 68 69 73 20 6f 70 63 6f 64 65 2e 0a 2a 2a 0a  this opcode..**.
bd40: 2a 2a 20 3c 6c 69 3e 5b 5b 53 51 4c 49 54 45 5f  ** <li>[[SQLITE_
bd50: 46 43 4e 54 4c 5f 52 42 55 5d 5d 0a 2a 2a 20 54  FCNTL_RBU]].** T
bd60: 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  he [SQLITE_FCNTL
bd70: 5f 52 42 55 5d 20 6f 70 63 6f 64 65 20 69 73 20  _RBU] opcode is 
bd80: 69 6d 70 6c 65 6d 65 6e 74 65 64 20 62 79 20 74  implemented by t
bd90: 68 65 20 73 70 65 63 69 61 6c 20 56 46 53 20 75  he special VFS u
bda0: 73 65 64 20 62 79 0a 2a 2a 20 74 68 65 20 52 42  sed by.** the RB
bdb0: 55 20 65 78 74 65 6e 73 69 6f 6e 20 6f 6e 6c 79  U extension only
bdc0: 2e 20 20 41 6c 6c 20 6f 74 68 65 72 20 56 46 53  .  All other VFS
bdd0: 20 73 68 6f 75 6c 64 20 72 65 74 75 72 6e 20 53   should return S
bde0: 51 4c 49 54 45 5f 4e 4f 54 46 4f 55 4e 44 20 66  QLITE_NOTFOUND f
bdf0: 6f 72 0a 2a 2a 20 74 68 69 73 20 6f 70 63 6f 64  or.** this opcod
be00: 65 2e 20 20 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2f  e.  .** </ul>.*/
be10: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
be20: 46 43 4e 54 4c 5f 4c 4f 43 4b 53 54 41 54 45 20  FCNTL_LOCKSTATE 
be30: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 31 0a                1.
be40: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46  #define SQLITE_F
be50: 43 4e 54 4c 5f 47 45 54 5f 4c 4f 43 4b 50 52 4f  CNTL_GET_LOCKPRO
be60: 58 59 46 49 4c 45 20 20 20 20 20 20 20 32 0a 23  XYFILE       2.#
be70: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43  define SQLITE_FC
be80: 4e 54 4c 5f 53 45 54 5f 4c 4f 43 4b 50 52 4f 58  NTL_SET_LOCKPROX
be90: 59 46 49 4c 45 20 20 20 20 20 20 20 33 0a 23 64  YFILE       3.#d
bea0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e  efine SQLITE_FCN
beb0: 54 4c 5f 4c 41 53 54 5f 45 52 52 4e 4f 20 20 20  TL_LAST_ERRNO   
bec0: 20 20 20 20 20 20 20 20 20 20 20 34 0a 23 64 65             4.#de
bed0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54  fine SQLITE_FCNT
bee0: 4c 5f 53 49 5a 45 5f 48 49 4e 54 20 20 20 20 20  L_SIZE_HINT     
bef0: 20 20 20 20 20 20 20 20 20 20 35 0a 23 64 65 66            5.#def
bf00: 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c  ine SQLITE_FCNTL
bf10: 5f 43 48 55 4e 4b 5f 53 49 5a 45 20 20 20 20 20  _CHUNK_SIZE     
bf20: 20 20 20 20 20 20 20 20 20 36 0a 23 64 65 66 69           6.#defi
bf30: 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  ne SQLITE_FCNTL_
bf40: 46 49 4c 45 5f 50 4f 49 4e 54 45 52 20 20 20 20  FILE_POINTER    
bf50: 20 20 20 20 20 20 20 20 37 0a 23 64 65 66 69 6e          7.#defin
bf60: 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 53  e SQLITE_FCNTL_S
bf70: 59 4e 43 5f 4f 4d 49 54 54 45 44 20 20 20 20 20  YNC_OMITTED     
bf80: 20 20 20 20 20 20 20 38 0a 23 64 65 66 69 6e 65         8.#define
bf90: 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 57 49   SQLITE_FCNTL_WI
bfa0: 4e 33 32 5f 41 56 5f 52 45 54 52 59 20 20 20 20  N32_AV_RETRY    
bfb0: 20 20 20 20 20 20 39 0a 23 64 65 66 69 6e 65 20        9.#define 
bfc0: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 50 45 52  SQLITE_FCNTL_PER
bfd0: 53 49 53 54 5f 57 41 4c 20 20 20 20 20 20 20 20  SIST_WAL        
bfe0: 20 20 20 20 31 30 0a 23 64 65 66 69 6e 65 20 53      10.#define S
bff0: 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 4f 56 45 52  QLITE_FCNTL_OVER
c000: 57 52 49 54 45 20 20 20 20 20 20 20 20 20 20 20  WRITE           
c010: 20 20 20 31 31 0a 23 64 65 66 69 6e 65 20 53 51     11.#define SQ
c020: 4c 49 54 45 5f 46 43 4e 54 4c 5f 56 46 53 4e 41  LITE_FCNTL_VFSNA
c030: 4d 45 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ME              
c040: 20 20 31 32 0a 23 64 65 66 69 6e 65 20 53 51 4c    12.#define SQL
c050: 49 54 45 5f 46 43 4e 54 4c 5f 50 4f 57 45 52 53  ITE_FCNTL_POWERS
c060: 41 46 45 5f 4f 56 45 52 57 52 49 54 45 20 20 20  AFE_OVERWRITE   
c070: 20 31 33 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   13.#define SQLI
c080: 54 45 5f 46 43 4e 54 4c 5f 50 52 41 47 4d 41 20  TE_FCNTL_PRAGMA 
c090: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
c0a0: 31 34 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  14.#define SQLIT
c0b0: 45 5f 46 43 4e 54 4c 5f 42 55 53 59 48 41 4e 44  E_FCNTL_BUSYHAND
c0c0: 4c 45 52 20 20 20 20 20 20 20 20 20 20 20 20 31  LER            1
c0d0: 35 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  5.#define SQLITE
c0e0: 5f 46 43 4e 54 4c 5f 54 45 4d 50 46 49 4c 45 4e  _FCNTL_TEMPFILEN
c0f0: 41 4d 45 20 20 20 20 20 20 20 20 20 20 20 31 36  AME           16
c100: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
c110: 46 43 4e 54 4c 5f 4d 4d 41 50 5f 53 49 5a 45 20  FCNTL_MMAP_SIZE 
c120: 20 20 20 20 20 20 20 20 20 20 20 20 20 31 38 0a               18.
c130: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46  #define SQLITE_F
c140: 43 4e 54 4c 5f 54 52 41 43 45 20 20 20 20 20 20  CNTL_TRACE      
c150: 20 20 20 20 20 20 20 20 20 20 20 20 31 39 0a 23              19.#
c160: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43  define SQLITE_FC
c170: 4e 54 4c 5f 48 41 53 5f 4d 4f 56 45 44 20 20 20  NTL_HAS_MOVED   
c180: 20 20 20 20 20 20 20 20 20 20 20 32 30 0a 23 64             20.#d
c190: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e  efine SQLITE_FCN
c1a0: 54 4c 5f 53 59 4e 43 20 20 20 20 20 20 20 20 20  TL_SYNC         
c1b0: 20 20 20 20 20 20 20 20 20 20 32 31 0a 23 64 65            21.#de
c1c0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54  fine SQLITE_FCNT
c1d0: 4c 5f 43 4f 4d 4d 49 54 5f 50 48 41 53 45 54 57  L_COMMIT_PHASETW
c1e0: 4f 20 20 20 20 20 20 20 20 32 32 0a 23 64 65 66  O        22.#def
c1f0: 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c  ine SQLITE_FCNTL
c200: 5f 57 49 4e 33 32 5f 53 45 54 5f 48 41 4e 44 4c  _WIN32_SET_HANDL
c210: 45 20 20 20 20 20 20 20 32 33 0a 23 64 65 66 69  E       23.#defi
c220: 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  ne SQLITE_FCNTL_
c230: 57 41 4c 5f 42 4c 4f 43 4b 20 20 20 20 20 20 20  WAL_BLOCK       
c240: 20 20 20 20 20 20 20 32 34 0a 23 64 65 66 69 6e         24.#defin
c250: 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 5a  e SQLITE_FCNTL_Z
c260: 49 50 56 46 53 20 20 20 20 20 20 20 20 20 20 20  IPVFS           
c270: 20 20 20 20 20 20 32 35 0a 23 64 65 66 69 6e 65        25.#define
c280: 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 52 42   SQLITE_FCNTL_RB
c290: 55 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  U               
c2a0: 20 20 20 20 20 32 36 0a 23 64 65 66 69 6e 65 20       26.#define 
c2b0: 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 56 46 53  SQLITE_FCNTL_VFS
c2c0: 5f 50 4f 49 4e 54 45 52 20 20 20 20 20 20 20 20  _POINTER        
c2d0: 20 20 20 20 32 37 0a 23 64 65 66 69 6e 65 20 53      27.#define S
c2e0: 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 4a 4f 55 52  QLITE_FCNTL_JOUR
c2f0: 4e 41 4c 5f 50 4f 49 4e 54 45 52 20 20 20 20 20  NAL_POINTER     
c300: 20 20 20 32 38 0a 0a 2f 2a 20 64 65 70 72 65 63     28../* deprec
c310: 61 74 65 64 20 6e 61 6d 65 73 20 2a 2f 0a 23 64  ated names */.#d
c320: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 47 45 54  efine SQLITE_GET
c330: 5f 4c 4f 43 4b 50 52 4f 58 59 46 49 4c 45 20 20  _LOCKPROXYFILE  
c340: 20 20 20 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c      SQLITE_FCNTL
c350: 5f 47 45 54 5f 4c 4f 43 4b 50 52 4f 58 59 46 49  _GET_LOCKPROXYFI
c360: 4c 45 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  LE.#define SQLIT
c370: 45 5f 53 45 54 5f 4c 4f 43 4b 50 52 4f 58 59 46  E_SET_LOCKPROXYF
c380: 49 4c 45 20 20 20 20 20 20 53 51 4c 49 54 45 5f  ILE      SQLITE_
c390: 46 43 4e 54 4c 5f 53 45 54 5f 4c 4f 43 4b 50 52  FCNTL_SET_LOCKPR
c3a0: 4f 58 59 46 49 4c 45 0a 23 64 65 66 69 6e 65 20  OXYFILE.#define 
c3b0: 53 51 4c 49 54 45 5f 4c 41 53 54 5f 45 52 52 4e  SQLITE_LAST_ERRN
c3c0: 4f 20 20 20 20 20 20 20 20 20 20 20 20 20 53 51  O             SQ
c3d0: 4c 49 54 45 5f 46 43 4e 54 4c 5f 4c 41 53 54 5f  LITE_FCNTL_LAST_
c3e0: 45 52 52 4e 4f 0a 0a 0a 2f 2a 0a 2a 2a 20 43 41  ERRNO.../*.** CA
c3f0: 50 49 33 52 45 46 3a 20 4d 75 74 65 78 20 48 61  PI3REF: Mutex Ha
c400: 6e 64 6c 65 0a 2a 2a 0a 2a 2a 20 54 68 65 20 6d  ndle.**.** The m
c410: 75 74 65 78 20 6d 6f 64 75 6c 65 20 77 69 74 68  utex module with
c420: 69 6e 20 53 51 4c 69 74 65 20 64 65 66 69 6e 65  in SQLite define
c430: 73 20 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65 78  s [sqlite3_mutex
c440: 5d 20 74 6f 20 62 65 20 61 6e 0a 2a 2a 20 61 62  ] to be an.** ab
c450: 73 74 72 61 63 74 20 74 79 70 65 20 66 6f 72 20  stract type for 
c460: 61 20 6d 75 74 65 78 20 6f 62 6a 65 63 74 2e 20  a mutex object. 
c470: 20 54 68 65 20 53 51 4c 69 74 65 20 63 6f 72 65   The SQLite core
c480: 20 6e 65 76 65 72 20 6c 6f 6f 6b 73 0a 2a 2a 20   never looks.** 
c490: 61 74 20 74 68 65 20 69 6e 74 65 72 6e 61 6c 20  at the internal 
c4a0: 72 65 70 72 65 73 65 6e 74 61 74 69 6f 6e 20 6f  representation o
c4b0: 66 20 61 6e 20 5b 73 71 6c 69 74 65 33 5f 6d 75  f an [sqlite3_mu
c4c0: 74 65 78 5d 2e 20 20 49 74 20 6f 6e 6c 79 0a 2a  tex].  It only.*
c4d0: 2a 20 64 65 61 6c 73 20 77 69 74 68 20 70 6f 69  * deals with poi
c4e0: 6e 74 65 72 73 20 74 6f 20 74 68 65 20 5b 73 71  nters to the [sq
c4f0: 6c 69 74 65 33 5f 6d 75 74 65 78 5d 20 6f 62 6a  lite3_mutex] obj
c500: 65 63 74 2e 0a 2a 2a 0a 2a 2a 20 4d 75 74 65 78  ect..**.** Mutex
c510: 65 73 20 61 72 65 20 63 72 65 61 74 65 64 20 75  es are created u
c520: 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 6d 75  sing [sqlite3_mu
c530: 74 65 78 5f 61 6c 6c 6f 63 28 29 5d 2e 0a 2a 2f  tex_alloc()]..*/
c540: 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20  .typedef struct 
c550: 73 71 6c 69 74 65 33 5f 6d 75 74 65 78 20 73 71  sqlite3_mutex sq
c560: 6c 69 74 65 33 5f 6d 75 74 65 78 3b 0a 0a 2f 2a  lite3_mutex;../*
c570: 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4f 53  .** CAPI3REF: OS
c580: 20 49 6e 74 65 72 66 61 63 65 20 4f 62 6a 65 63   Interface Objec
c590: 74 0a 2a 2a 0a 2a 2a 20 41 6e 20 69 6e 73 74 61  t.**.** An insta
c5a0: 6e 63 65 20 6f 66 20 74 68 65 20 73 71 6c 69 74  nce of the sqlit
c5b0: 65 33 5f 76 66 73 20 6f 62 6a 65 63 74 20 64 65  e3_vfs object de
c5c0: 66 69 6e 65 73 20 74 68 65 20 69 6e 74 65 72 66  fines the interf
c5d0: 61 63 65 20 62 65 74 77 65 65 6e 0a 2a 2a 20 74  ace between.** t
c5e0: 68 65 20 53 51 4c 69 74 65 20 63 6f 72 65 20 61  he SQLite core a
c5f0: 6e 64 20 74 68 65 20 75 6e 64 65 72 6c 79 69 6e  nd the underlyin
c600: 67 20 6f 70 65 72 61 74 69 6e 67 20 73 79 73 74  g operating syst
c610: 65 6d 2e 20 20 54 68 65 20 22 76 66 73 22 0a 2a  em.  The "vfs".*
c620: 2a 20 69 6e 20 74 68 65 20 6e 61 6d 65 20 6f 66  * in the name of
c630: 20 74 68 65 20 6f 62 6a 65 63 74 20 73 74 61 6e   the object stan
c640: 64 73 20 66 6f 72 20 22 76 69 72 74 75 61 6c 20  ds for "virtual 
c650: 66 69 6c 65 20 73 79 73 74 65 6d 22 2e 20 20 53  file system".  S
c660: 65 65 0a 2a 2a 20 74 68 65 20 5b 56 46 53 20 7c  ee.** the [VFS |
c670: 20 56 46 53 20 64 6f 63 75 6d 65 6e 74 61 74 69   VFS documentati
c680: 6f 6e 5d 20 66 6f 72 20 66 75 72 74 68 65 72 20  on] for further 
c690: 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 0a 2a 2a 0a  information..**.
c6a0: 2a 2a 20 54 68 65 20 76 61 6c 75 65 20 6f 66 20  ** The value of 
c6b0: 74 68 65 20 69 56 65 72 73 69 6f 6e 20 66 69 65  the iVersion fie
c6c0: 6c 64 20 69 73 20 69 6e 69 74 69 61 6c 6c 79 20  ld is initially 
c6d0: 31 20 62 75 74 20 6d 61 79 20 62 65 20 6c 61 72  1 but may be lar
c6e0: 67 65 72 20 69 6e 0a 2a 2a 20 66 75 74 75 72 65  ger in.** future
c6f0: 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c   versions of SQL
c700: 69 74 65 2e 20 20 41 64 64 69 74 69 6f 6e 61 6c  ite.  Additional
c710: 20 66 69 65 6c 64 73 20 6d 61 79 20 62 65 20 61   fields may be a
c720: 70 70 65 6e 64 65 64 20 74 6f 20 74 68 69 73 0a  ppended to this.
c730: 2a 2a 20 6f 62 6a 65 63 74 20 77 68 65 6e 20 74  ** object when t
c740: 68 65 20 69 56 65 72 73 69 6f 6e 20 76 61 6c 75  he iVersion valu
c750: 65 20 69 73 20 69 6e 63 72 65 61 73 65 64 2e 20  e is increased. 
c760: 20 4e 6f 74 65 20 74 68 61 74 20 74 68 65 20 73   Note that the s
c770: 74 72 75 63 74 75 72 65 0a 2a 2a 20 6f 66 20 74  tructure.** of t
c780: 68 65 20 73 71 6c 69 74 65 33 5f 76 66 73 20 6f  he sqlite3_vfs o
c790: 62 6a 65 63 74 20 63 68 61 6e 67 65 73 20 69 6e  bject changes in
c7a0: 20 74 68 65 20 74 72 61 6e 73 61 63 74 69 6f 6e   the transaction
c7b0: 20 62 65 74 77 65 65 6e 0a 2a 2a 20 53 51 4c 69   between.** SQLi
c7c0: 74 65 20 76 65 72 73 69 6f 6e 20 33 2e 35 2e 39  te version 3.5.9
c7d0: 20 61 6e 64 20 33 2e 36 2e 30 20 61 6e 64 20 79   and 3.6.0 and y
c7e0: 65 74 20 74 68 65 20 69 56 65 72 73 69 6f 6e 20  et the iVersion 
c7f0: 66 69 65 6c 64 20 77 61 73 20 6e 6f 74 0a 2a 2a  field was not.**
c800: 20 6d 6f 64 69 66 69 65 64 2e 0a 2a 2a 0a 2a 2a   modified..**.**
c810: 20 54 68 65 20 73 7a 4f 73 46 69 6c 65 20 66 69   The szOsFile fi
c820: 65 6c 64 20 69 73 20 74 68 65 20 73 69 7a 65 20  eld is the size 
c830: 6f 66 20 74 68 65 20 73 75 62 63 6c 61 73 73 65  of the subclasse
c840: 64 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d  d [sqlite3_file]
c850: 0a 2a 2a 20 73 74 72 75 63 74 75 72 65 20 75 73  .** structure us
c860: 65 64 20 62 79 20 74 68 69 73 20 56 46 53 2e 20  ed by this VFS. 
c870: 20 6d 78 50 61 74 68 6e 61 6d 65 20 69 73 20 74   mxPathname is t
c880: 68 65 20 6d 61 78 69 6d 75 6d 20 6c 65 6e 67 74  he maximum lengt
c890: 68 20 6f 66 0a 2a 2a 20 61 20 70 61 74 68 6e 61  h of.** a pathna
c8a0: 6d 65 20 69 6e 20 74 68 69 73 20 56 46 53 2e 0a  me in this VFS..
c8b0: 2a 2a 0a 2a 2a 20 52 65 67 69 73 74 65 72 65 64  **.** Registered
c8c0: 20 73 71 6c 69 74 65 33 5f 76 66 73 20 6f 62 6a   sqlite3_vfs obj
c8d0: 65 63 74 73 20 61 72 65 20 6b 65 70 74 20 6f 6e  ects are kept on
c8e0: 20 61 20 6c 69 6e 6b 65 64 20 6c 69 73 74 20 66   a linked list f
c8f0: 6f 72 6d 65 64 20 62 79 0a 2a 2a 20 74 68 65 20  ormed by.** the 
c900: 70 4e 65 78 74 20 70 6f 69 6e 74 65 72 2e 20 20  pNext pointer.  
c910: 54 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 66 73  The [sqlite3_vfs
c920: 5f 72 65 67 69 73 74 65 72 28 29 5d 0a 2a 2a 20  _register()].** 
c930: 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 76 66 73  and [sqlite3_vfs
c940: 5f 75 6e 72 65 67 69 73 74 65 72 28 29 5d 20 69  _unregister()] i
c950: 6e 74 65 72 66 61 63 65 73 20 6d 61 6e 61 67 65  nterfaces manage
c960: 20 74 68 69 73 20 6c 69 73 74 0a 2a 2a 20 69 6e   this list.** in
c970: 20 61 20 74 68 72 65 61 64 2d 73 61 66 65 20 77   a thread-safe w
c980: 61 79 2e 20 20 54 68 65 20 5b 73 71 6c 69 74 65  ay.  The [sqlite
c990: 33 5f 76 66 73 5f 66 69 6e 64 28 29 5d 20 69 6e  3_vfs_find()] in
c9a0: 74 65 72 66 61 63 65 0a 2a 2a 20 73 65 61 72 63  terface.** searc
c9b0: 68 65 73 20 74 68 65 20 6c 69 73 74 2e 20 20 4e  hes the list.  N
c9c0: 65 69 74 68 65 72 20 74 68 65 20 61 70 70 6c 69  either the appli
c9d0: 63 61 74 69 6f 6e 20 63 6f 64 65 20 6e 6f 72 20  cation code nor 
c9e0: 74 68 65 20 56 46 53 0a 2a 2a 20 69 6d 70 6c 65  the VFS.** imple
c9f0: 6d 65 6e 74 61 74 69 6f 6e 20 73 68 6f 75 6c 64  mentation should
ca00: 20 75 73 65 20 74 68 65 20 70 4e 65 78 74 20 70   use the pNext p
ca10: 6f 69 6e 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 54 68  ointer..**.** Th
ca20: 65 20 70 4e 65 78 74 20 66 69 65 6c 64 20 69 73  e pNext field is
ca30: 20 74 68 65 20 6f 6e 6c 79 20 66 69 65 6c 64 20   the only field 
ca40: 69 6e 20 74 68 65 20 73 71 6c 69 74 65 33 5f 76  in the sqlite3_v
ca50: 66 73 0a 2a 2a 20 73 74 72 75 63 74 75 72 65 20  fs.** structure 
ca60: 74 68 61 74 20 53 51 4c 69 74 65 20 77 69 6c 6c  that SQLite will
ca70: 20 65 76 65 72 20 6d 6f 64 69 66 79 2e 20 20 53   ever modify.  S
ca80: 51 4c 69 74 65 20 77 69 6c 6c 20 6f 6e 6c 79 20  QLite will only 
ca90: 61 63 63 65 73 73 0a 2a 2a 20 6f 72 20 6d 6f 64  access.** or mod
caa0: 69 66 79 20 74 68 69 73 20 66 69 65 6c 64 20 77  ify this field w
cab0: 68 69 6c 65 20 68 6f 6c 64 69 6e 67 20 61 20 70  hile holding a p
cac0: 61 72 74 69 63 75 6c 61 72 20 73 74 61 74 69 63  articular static
cad0: 20 6d 75 74 65 78 2e 0a 2a 2a 20 54 68 65 20 61   mutex..** The a
cae0: 70 70 6c 69 63 61 74 69 6f 6e 20 73 68 6f 75 6c  pplication shoul
caf0: 64 20 6e 65 76 65 72 20 6d 6f 64 69 66 79 20 61  d never modify a
cb00: 6e 79 74 68 69 6e 67 20 77 69 74 68 69 6e 20 74  nything within t
cb10: 68 65 20 73 71 6c 69 74 65 33 5f 76 66 73 0a 2a  he sqlite3_vfs.*
cb20: 2a 20 6f 62 6a 65 63 74 20 6f 6e 63 65 20 74 68  * object once th
cb30: 65 20 6f 62 6a 65 63 74 20 68 61 73 20 62 65 65  e object has bee
cb40: 6e 20 72 65 67 69 73 74 65 72 65 64 2e 0a 2a 2a  n registered..**
cb50: 0a 2a 2a 20 54 68 65 20 7a 4e 61 6d 65 20 66 69  .** The zName fi
cb60: 65 6c 64 20 68 6f 6c 64 73 20 74 68 65 20 6e 61  eld holds the na
cb70: 6d 65 20 6f 66 20 74 68 65 20 56 46 53 20 6d 6f  me of the VFS mo
cb80: 64 75 6c 65 2e 20 20 54 68 65 20 6e 61 6d 65 20  dule.  The name 
cb90: 6d 75 73 74 0a 2a 2a 20 62 65 20 75 6e 69 71 75  must.** be uniqu
cba0: 65 20 61 63 72 6f 73 73 20 61 6c 6c 20 56 46 53  e across all VFS
cbb0: 20 6d 6f 64 75 6c 65 73 2e 0a 2a 2a 0a 2a 2a 20   modules..**.** 
cbc0: 5b 5b 73 71 6c 69 74 65 33 5f 76 66 73 2e 78 4f  [[sqlite3_vfs.xO
cbd0: 70 65 6e 5d 5d 0a 2a 2a 20 5e 53 51 4c 69 74 65  pen]].** ^SQLite
cbe0: 20 67 75 61 72 61 6e 74 65 65 73 20 74 68 61 74   guarantees that
cbf0: 20 74 68 65 20 7a 46 69 6c 65 6e 61 6d 65 20 70   the zFilename p
cc00: 61 72 61 6d 65 74 65 72 20 74 6f 20 78 4f 70 65  arameter to xOpe
cc10: 6e 0a 2a 2a 20 69 73 20 65 69 74 68 65 72 20 61  n.** is either a
cc20: 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 6f 72   NULL pointer or
cc30: 20 73 74 72 69 6e 67 20 6f 62 74 61 69 6e 65 64   string obtained
cc40: 0a 2a 2a 20 66 72 6f 6d 20 78 46 75 6c 6c 50 61  .** from xFullPa
cc50: 74 68 6e 61 6d 65 28 29 20 77 69 74 68 20 61 6e  thname() with an
cc60: 20 6f 70 74 69 6f 6e 61 6c 20 73 75 66 66 69 78   optional suffix
cc70: 20 61 64 64 65 64 2e 0a 2a 2a 20 5e 49 66 20 61   added..** ^If a
cc80: 20 73 75 66 66 69 78 20 69 73 20 61 64 64 65 64   suffix is added
cc90: 20 74 6f 20 74 68 65 20 7a 46 69 6c 65 6e 61 6d   to the zFilenam
cca0: 65 20 70 61 72 61 6d 65 74 65 72 2c 20 69 74 20  e parameter, it 
ccb0: 77 69 6c 6c 0a 2a 2a 20 63 6f 6e 73 69 73 74 20  will.** consist 
ccc0: 6f 66 20 61 20 73 69 6e 67 6c 65 20 22 2d 22 20  of a single "-" 
ccd0: 63 68 61 72 61 63 74 65 72 20 66 6f 6c 6c 6f 77  character follow
cce0: 65 64 20 62 79 20 6e 6f 20 6d 6f 72 65 20 74 68  ed by no more th
ccf0: 61 6e 0a 2a 2a 20 31 31 20 61 6c 70 68 61 6e 75  an.** 11 alphanu
cd00: 6d 65 72 69 63 20 61 6e 64 2f 6f 72 20 22 2d 22  meric and/or "-"
cd10: 20 63 68 61 72 61 63 74 65 72 73 2e 0a 2a 2a 20   characters..** 
cd20: 5e 53 51 4c 69 74 65 20 66 75 72 74 68 65 72 20  ^SQLite further 
cd30: 67 75 61 72 61 6e 74 65 65 73 20 74 68 61 74 0a  guarantees that.
cd40: 2a 2a 20 74 68 65 20 73 74 72 69 6e 67 20 77 69  ** the string wi
cd50: 6c 6c 20 62 65 20 76 61 6c 69 64 20 61 6e 64 20  ll be valid and 
cd60: 75 6e 63 68 61 6e 67 65 64 20 75 6e 74 69 6c 20  unchanged until 
cd70: 78 43 6c 6f 73 65 28 29 20 69 73 0a 2a 2a 20 63  xClose() is.** c
cd80: 61 6c 6c 65 64 2e 20 42 65 63 61 75 73 65 20 6f  alled. Because o
cd90: 66 20 74 68 65 20 70 72 65 76 69 6f 75 73 20 73  f the previous s
cda0: 65 6e 74 65 6e 63 65 2c 0a 2a 2a 20 74 68 65 20  entence,.** the 
cdb0: 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d 20 63  [sqlite3_file] c
cdc0: 61 6e 20 73 61 66 65 6c 79 20 73 74 6f 72 65 20  an safely store 
cdd0: 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68 65  a pointer to the
cde0: 0a 2a 2a 20 66 69 6c 65 6e 61 6d 65 20 69 66 20  .** filename if 
cdf0: 69 74 20 6e 65 65 64 73 20 74 6f 20 72 65 6d 65  it needs to reme
ce00: 6d 62 65 72 20 74 68 65 20 66 69 6c 65 6e 61 6d  mber the filenam
ce10: 65 20 66 6f 72 20 73 6f 6d 65 20 72 65 61 73 6f  e for some reaso
ce20: 6e 2e 0a 2a 2a 20 49 66 20 74 68 65 20 7a 46 69  n..** If the zFi
ce30: 6c 65 6e 61 6d 65 20 70 61 72 61 6d 65 74 65 72  lename parameter
ce40: 20 74 6f 20 78 4f 70 65 6e 20 69 73 20 61 20 4e   to xOpen is a N
ce50: 55 4c 4c 20 70 6f 69 6e 74 65 72 20 74 68 65 6e  ULL pointer then
ce60: 20 78 4f 70 65 6e 0a 2a 2a 20 6d 75 73 74 20 69   xOpen.** must i
ce70: 6e 76 65 6e 74 20 69 74 73 20 6f 77 6e 20 74 65  nvent its own te
ce80: 6d 70 6f 72 61 72 79 20 6e 61 6d 65 20 66 6f 72  mporary name for
ce90: 20 74 68 65 20 66 69 6c 65 2e 20 20 5e 57 68 65   the file.  ^Whe
cea0: 6e 65 76 65 72 20 74 68 65 20 0a 2a 2a 20 78 46  never the .** xF
ceb0: 69 6c 65 6e 61 6d 65 20 70 61 72 61 6d 65 74 65  ilename paramete
cec0: 72 20 69 73 20 4e 55 4c 4c 20 69 74 20 77 69 6c  r is NULL it wil
ced0: 6c 20 61 6c 73 6f 20 62 65 20 74 68 65 20 63 61  l also be the ca
cee0: 73 65 20 74 68 61 74 20 74 68 65 0a 2a 2a 20 66  se that the.** f
cef0: 6c 61 67 73 20 70 61 72 61 6d 65 74 65 72 20 77  lags parameter w
cf00: 69 6c 6c 20 69 6e 63 6c 75 64 65 20 5b 53 51 4c  ill include [SQL
cf10: 49 54 45 5f 4f 50 45 4e 5f 44 45 4c 45 54 45 4f  ITE_OPEN_DELETEO
cf20: 4e 43 4c 4f 53 45 5d 2e 0a 2a 2a 0a 2a 2a 20 54  NCLOSE]..**.** T
cf30: 68 65 20 66 6c 61 67 73 20 61 72 67 75 6d 65 6e  he flags argumen
cf40: 74 20 74 6f 20 78 4f 70 65 6e 28 29 20 69 6e 63  t to xOpen() inc
cf50: 6c 75 64 65 73 20 61 6c 6c 20 62 69 74 73 20 73  ludes all bits s
cf60: 65 74 20 69 6e 0a 2a 2a 20 74 68 65 20 66 6c 61  et in.** the fla
cf70: 67 73 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 5b  gs argument to [
cf80: 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28  sqlite3_open_v2(
cf90: 29 5d 2e 20 20 4f 72 20 69 66 20 5b 73 71 6c 69  )].  Or if [sqli
cfa0: 74 65 33 5f 6f 70 65 6e 28 29 5d 0a 2a 2a 20 6f  te3_open()].** o
cfb0: 72 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31  r [sqlite3_open1
cfc0: 36 28 29 5d 20 69 73 20 75 73 65 64 2c 20 74 68  6()] is used, th
cfd0: 65 6e 20 66 6c 61 67 73 20 69 6e 63 6c 75 64 65  en flags include
cfe0: 73 20 61 74 20 6c 65 61 73 74 0a 2a 2a 20 5b 53  s at least.** [S
cff0: 51 4c 49 54 45 5f 4f 50 45 4e 5f 52 45 41 44 57  QLITE_OPEN_READW
d000: 52 49 54 45 5d 20 7c 20 5b 53 51 4c 49 54 45 5f  RITE] | [SQLITE_
d010: 4f 50 45 4e 5f 43 52 45 41 54 45 5d 2e 20 0a 2a  OPEN_CREATE]. .*
d020: 2a 20 49 66 20 78 4f 70 65 6e 28 29 20 6f 70 65  * If xOpen() ope
d030: 6e 73 20 61 20 66 69 6c 65 20 72 65 61 64 2d 6f  ns a file read-o
d040: 6e 6c 79 20 74 68 65 6e 20 69 74 20 73 65 74 73  nly then it sets
d050: 20 2a 70 4f 75 74 46 6c 61 67 73 20 74 6f 0a 2a   *pOutFlags to.*
d060: 2a 20 69 6e 63 6c 75 64 65 20 5b 53 51 4c 49 54  * include [SQLIT
d070: 45 5f 4f 50 45 4e 5f 52 45 41 44 4f 4e 4c 59 5d  E_OPEN_READONLY]
d080: 2e 20 20 4f 74 68 65 72 20 62 69 74 73 20 69 6e  .  Other bits in
d090: 20 2a 70 4f 75 74 46 6c 61 67 73 20 6d 61 79 20   *pOutFlags may 
d0a0: 62 65 20 73 65 74 2e 0a 2a 2a 0a 2a 2a 20 5e 28  be set..**.** ^(
d0b0: 53 51 4c 69 74 65 20 77 69 6c 6c 20 61 6c 73 6f  SQLite will also
d0c0: 20 61 64 64 20 6f 6e 65 20 6f 66 20 74 68 65 20   add one of the 
d0d0: 66 6f 6c 6c 6f 77 69 6e 67 20 66 6c 61 67 73 20  following flags 
d0e0: 74 6f 20 74 68 65 20 78 4f 70 65 6e 28 29 0a 2a  to the xOpen().*
d0f0: 2a 20 63 61 6c 6c 2c 20 64 65 70 65 6e 64 69 6e  * call, dependin
d100: 67 20 6f 6e 20 74 68 65 20 6f 62 6a 65 63 74 20  g on the object 
d110: 62 65 69 6e 67 20 6f 70 65 6e 65 64 3a 0a 2a 2a  being opened:.**
d120: 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c 69 3e  .** <ul>.** <li>
d130: 20 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 4d    [SQLITE_OPEN_M
d140: 41 49 4e 5f 44 42 5d 0a 2a 2a 20 3c 6c 69 3e 20  AIN_DB].** <li> 
d150: 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 4d 41   [SQLITE_OPEN_MA
d160: 49 4e 5f 4a 4f 55 52 4e 41 4c 5d 0a 2a 2a 20 3c  IN_JOURNAL].** <
d170: 6c 69 3e 20 20 5b 53 51 4c 49 54 45 5f 4f 50 45  li>  [SQLITE_OPE
d180: 4e 5f 54 45 4d 50 5f 44 42 5d 0a 2a 2a 20 3c 6c  N_TEMP_DB].** <l
d190: 69 3e 20 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  i>  [SQLITE_OPEN
d1a0: 5f 54 45 4d 50 5f 4a 4f 55 52 4e 41 4c 5d 0a 2a  _TEMP_JOURNAL].*
d1b0: 2a 20 3c 6c 69 3e 20 20 5b 53 51 4c 49 54 45 5f  * <li>  [SQLITE_
d1c0: 4f 50 45 4e 5f 54 52 41 4e 53 49 45 4e 54 5f 44  OPEN_TRANSIENT_D
d1d0: 42 5d 0a 2a 2a 20 3c 6c 69 3e 20 20 5b 53 51 4c  B].** <li>  [SQL
d1e0: 49 54 45 5f 4f 50 45 4e 5f 53 55 42 4a 4f 55 52  ITE_OPEN_SUBJOUR
d1f0: 4e 41 4c 5d 0a 2a 2a 20 3c 6c 69 3e 20 20 5b 53  NAL].** <li>  [S
d200: 51 4c 49 54 45 5f 4f 50 45 4e 5f 4d 41 53 54 45  QLITE_OPEN_MASTE
d210: 52 5f 4a 4f 55 52 4e 41 4c 5d 0a 2a 2a 20 3c 6c  R_JOURNAL].** <l
d220: 69 3e 20 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  i>  [SQLITE_OPEN
d230: 5f 57 41 4c 5d 0a 2a 2a 20 3c 2f 75 6c 3e 29 5e  _WAL].** </ul>)^
d240: 0a 2a 2a 0a 2a 2a 20 54 68 65 20 66 69 6c 65 20  .**.** The file 
d250: 49 2f 4f 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  I/O implementati
d260: 6f 6e 20 63 61 6e 20 75 73 65 20 74 68 65 20 6f  on can use the o
d270: 62 6a 65 63 74 20 74 79 70 65 20 66 6c 61 67 73  bject type flags
d280: 20 74 6f 0a 2a 2a 20 63 68 61 6e 67 65 20 74 68   to.** change th
d290: 65 20 77 61 79 20 69 74 20 64 65 61 6c 73 20 77  e way it deals w
d2a0: 69 74 68 20 66 69 6c 65 73 2e 20 20 46 6f 72 20  ith files.  For 
d2b0: 65 78 61 6d 70 6c 65 2c 20 61 6e 20 61 70 70 6c  example, an appl
d2c0: 69 63 61 74 69 6f 6e 0a 2a 2a 20 74 68 61 74 20  ication.** that 
d2d0: 64 6f 65 73 20 6e 6f 74 20 63 61 72 65 20 61 62  does not care ab
d2e0: 6f 75 74 20 63 72 61 73 68 20 72 65 63 6f 76 65  out crash recove
d2f0: 72 79 20 6f 72 20 72 6f 6c 6c 62 61 63 6b 20 6d  ry or rollback m
d300: 69 67 68 74 20 6d 61 6b 65 0a 2a 2a 20 74 68 65  ight make.** the
d310: 20 6f 70 65 6e 20 6f 66 20 61 20 6a 6f 75 72 6e   open of a journ
d320: 61 6c 20 66 69 6c 65 20 61 20 6e 6f 2d 6f 70 2e  al file a no-op.
d330: 20 20 57 72 69 74 65 73 20 74 6f 20 74 68 69 73    Writes to this
d340: 20 6a 6f 75 72 6e 61 6c 20 77 6f 75 6c 64 0a 2a   journal would.*
d350: 2a 20 61 6c 73 6f 20 62 65 20 6e 6f 2d 6f 70 73  * also be no-ops
d360: 2c 20 61 6e 64 20 61 6e 79 20 61 74 74 65 6d 70  , and any attemp
d370: 74 20 74 6f 20 72 65 61 64 20 74 68 65 20 6a 6f  t to read the jo
d380: 75 72 6e 61 6c 20 77 6f 75 6c 64 20 72 65 74 75  urnal would retu
d390: 72 6e 0a 2a 2a 20 53 51 4c 49 54 45 5f 49 4f 45  rn.** SQLITE_IOE
d3a0: 52 52 2e 20 20 4f 72 20 74 68 65 20 69 6d 70 6c  RR.  Or the impl
d3b0: 65 6d 65 6e 74 61 74 69 6f 6e 20 6d 69 67 68 74  ementation might
d3c0: 20 72 65 63 6f 67 6e 69 7a 65 20 74 68 61 74 20   recognize that 
d3d0: 61 20 64 61 74 61 62 61 73 65 0a 2a 2a 20 66 69  a database.** fi
d3e0: 6c 65 20 77 69 6c 6c 20 62 65 20 64 6f 69 6e 67  le will be doing
d3f0: 20 70 61 67 65 2d 61 6c 69 67 6e 65 64 20 73 65   page-aligned se
d400: 63 74 6f 72 20 72 65 61 64 73 20 61 6e 64 20 77  ctor reads and w
d410: 72 69 74 65 73 20 69 6e 20 61 20 72 61 6e 64 6f  rites in a rando
d420: 6d 0a 2a 2a 20 6f 72 64 65 72 20 61 6e 64 20 73  m.** order and s
d430: 65 74 20 75 70 20 69 74 73 20 49 2f 4f 20 73 75  et up its I/O su
d440: 62 73 79 73 74 65 6d 20 61 63 63 6f 72 64 69 6e  bsystem accordin
d450: 67 6c 79 2e 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74  gly..**.** SQLit
d460: 65 20 6d 69 67 68 74 20 61 6c 73 6f 20 61 64 64  e might also add
d470: 20 6f 6e 65 20 6f 66 20 74 68 65 20 66 6f 6c 6c   one of the foll
d480: 6f 77 69 6e 67 20 66 6c 61 67 73 20 74 6f 20 74  owing flags to t
d490: 68 65 20 78 4f 70 65 6e 20 6d 65 74 68 6f 64 3a  he xOpen method:
d4a0: 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c  .**.** <ul>.** <
d4b0: 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  li> [SQLITE_OPEN
d4c0: 5f 44 45 4c 45 54 45 4f 4e 43 4c 4f 53 45 5d 0a  _DELETEONCLOSE].
d4d0: 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f  ** <li> [SQLITE_
d4e0: 4f 50 45 4e 5f 45 58 43 4c 55 53 49 56 45 5d 0a  OPEN_EXCLUSIVE].
d4f0: 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 0a 2a 2a 20 54  ** </ul>.**.** T
d500: 68 65 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  he [SQLITE_OPEN_
d510: 44 45 4c 45 54 45 4f 4e 43 4c 4f 53 45 5d 20 66  DELETEONCLOSE] f
d520: 6c 61 67 20 6d 65 61 6e 73 20 74 68 65 20 66 69  lag means the fi
d530: 6c 65 20 73 68 6f 75 6c 64 20 62 65 0a 2a 2a 20  le should be.** 
d540: 64 65 6c 65 74 65 64 20 77 68 65 6e 20 69 74 20  deleted when it 
d550: 69 73 20 63 6c 6f 73 65 64 2e 20 20 5e 54 68 65  is closed.  ^The
d560: 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 44 45   [SQLITE_OPEN_DE
d570: 4c 45 54 45 4f 4e 43 4c 4f 53 45 5d 0a 2a 2a 20  LETEONCLOSE].** 
d580: 77 69 6c 6c 20 62 65 20 73 65 74 20 66 6f 72 20  will be set for 
d590: 54 45 4d 50 20 64 61 74 61 62 61 73 65 73 20 61  TEMP databases a
d5a0: 6e 64 20 74 68 65 69 72 20 6a 6f 75 72 6e 61 6c  nd their journal
d5b0: 73 2c 20 74 72 61 6e 73 69 65 6e 74 0a 2a 2a 20  s, transient.** 
d5c0: 64 61 74 61 62 61 73 65 73 2c 20 61 6e 64 20 73  databases, and s
d5d0: 75 62 6a 6f 75 72 6e 61 6c 73 2e 0a 2a 2a 0a 2a  ubjournals..**.*
d5e0: 2a 20 5e 54 68 65 20 5b 53 51 4c 49 54 45 5f 4f  * ^The [SQLITE_O
d5f0: 50 45 4e 5f 45 58 43 4c 55 53 49 56 45 5d 20 66  PEN_EXCLUSIVE] f
d600: 6c 61 67 20 69 73 20 61 6c 77 61 79 73 20 75 73  lag is always us
d610: 65 64 20 69 6e 20 63 6f 6e 6a 75 6e 63 74 69 6f  ed in conjunctio
d620: 6e 0a 2a 2a 20 77 69 74 68 20 74 68 65 20 5b 53  n.** with the [S
d630: 51 4c 49 54 45 5f 4f 50 45 4e 5f 43 52 45 41 54  QLITE_OPEN_CREAT
d640: 45 5d 20 66 6c 61 67 2c 20 77 68 69 63 68 20 61  E] flag, which a
d650: 72 65 20 62 6f 74 68 20 64 69 72 65 63 74 6c 79  re both directly
d660: 0a 2a 2a 20 61 6e 61 6c 6f 67 6f 75 73 20 74 6f  .** analogous to
d670: 20 74 68 65 20 4f 5f 45 58 43 4c 20 61 6e 64 20   the O_EXCL and 
d680: 4f 5f 43 52 45 41 54 20 66 6c 61 67 73 20 6f 66  O_CREAT flags of
d690: 20 74 68 65 20 50 4f 53 49 58 20 6f 70 65 6e 28   the POSIX open(
d6a0: 29 0a 2a 2a 20 41 50 49 2e 20 20 54 68 65 20 53  ).** API.  The S
d6b0: 51 4c 49 54 45 5f 4f 50 45 4e 5f 45 58 43 4c 55  QLITE_OPEN_EXCLU
d6c0: 53 49 56 45 20 66 6c 61 67 2c 20 77 68 65 6e 20  SIVE flag, when 
d6d0: 70 61 69 72 65 64 20 77 69 74 68 20 74 68 65 20  paired with the 
d6e0: 0a 2a 2a 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  .** SQLITE_OPEN_
d6f0: 43 52 45 41 54 45 2c 20 69 73 20 75 73 65 64 20  CREATE, is used 
d700: 74 6f 20 69 6e 64 69 63 61 74 65 20 74 68 61 74  to indicate that
d710: 20 66 69 6c 65 20 73 68 6f 75 6c 64 20 61 6c 77   file should alw
d720: 61 79 73 0a 2a 2a 20 62 65 20 63 72 65 61 74 65  ays.** be create
d730: 64 2c 20 61 6e 64 20 74 68 61 74 20 69 74 20 69  d, and that it i
d740: 73 20 61 6e 20 65 72 72 6f 72 20 69 66 20 69 74  s an error if it
d750: 20 61 6c 72 65 61 64 79 20 65 78 69 73 74 73 2e   already exists.
d760: 0a 2a 2a 20 49 74 20 69 73 20 3c 69 3e 6e 6f 74  .** It is <i>not
d770: 3c 2f 69 3e 20 75 73 65 64 20 74 6f 20 69 6e 64  </i> used to ind
d780: 69 63 61 74 65 20 74 68 65 20 66 69 6c 65 20 73  icate the file s
d790: 68 6f 75 6c 64 20 62 65 20 6f 70 65 6e 65 64 20  hould be opened 
d7a0: 0a 2a 2a 20 66 6f 72 20 65 78 63 6c 75 73 69 76  .** for exclusiv
d7b0: 65 20 61 63 63 65 73 73 2e 0a 2a 2a 0a 2a 2a 20  e access..**.** 
d7c0: 5e 41 74 20 6c 65 61 73 74 20 73 7a 4f 73 46 69  ^At least szOsFi
d7d0: 6c 65 20 62 79 74 65 73 20 6f 66 20 6d 65 6d 6f  le bytes of memo
d7e0: 72 79 20 61 72 65 20 61 6c 6c 6f 63 61 74 65 64  ry are allocated
d7f0: 20 62 79 20 53 51 4c 69 74 65 0a 2a 2a 20 74 6f   by SQLite.** to
d800: 20 68 6f 6c 64 20 74 68 65 20 20 5b 73 71 6c 69   hold the  [sqli
d810: 74 65 33 5f 66 69 6c 65 5d 20 73 74 72 75 63 74  te3_file] struct
d820: 75 72 65 20 70 61 73 73 65 64 20 61 73 20 74 68  ure passed as th
d830: 65 20 74 68 69 72 64 0a 2a 2a 20 61 72 67 75 6d  e third.** argum
d840: 65 6e 74 20 74 6f 20 78 4f 70 65 6e 2e 20 20 54  ent to xOpen.  T
d850: 68 65 20 78 4f 70 65 6e 20 6d 65 74 68 6f 64 20  he xOpen method 
d860: 64 6f 65 73 20 6e 6f 74 20 68 61 76 65 20 74 6f  does not have to
d870: 0a 2a 2a 20 61 6c 6c 6f 63 61 74 65 20 74 68 65  .** allocate the
d880: 20 73 74 72 75 63 74 75 72 65 3b 20 69 74 20 73   structure; it s
d890: 68 6f 75 6c 64 20 6a 75 73 74 20 66 69 6c 6c 20  hould just fill 
d8a0: 69 74 20 69 6e 2e 20 20 4e 6f 74 65 20 74 68 61  it in.  Note tha
d8b0: 74 0a 2a 2a 20 74 68 65 20 78 4f 70 65 6e 20 6d  t.** the xOpen m
d8c0: 65 74 68 6f 64 20 6d 75 73 74 20 73 65 74 20 74  ethod must set t
d8d0: 68 65 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 2e  he sqlite3_file.
d8e0: 70 4d 65 74 68 6f 64 73 20 74 6f 20 65 69 74 68  pMethods to eith
d8f0: 65 72 0a 2a 2a 20 61 20 76 61 6c 69 64 20 5b 73  er.** a valid [s
d900: 71 6c 69 74 65 33 5f 69 6f 5f 6d 65 74 68 6f 64  qlite3_io_method
d910: 73 5d 20 6f 62 6a 65 63 74 20 6f 72 20 74 6f 20  s] object or to 
d920: 4e 55 4c 4c 2e 20 20 78 4f 70 65 6e 20 6d 75 73  NULL.  xOpen mus
d930: 74 20 64 6f 0a 2a 2a 20 74 68 69 73 20 65 76 65  t do.** this eve
d940: 6e 20 69 66 20 74 68 65 20 6f 70 65 6e 20 66 61  n if the open fa
d950: 69 6c 73 2e 20 20 53 51 4c 69 74 65 20 65 78 70  ils.  SQLite exp
d960: 65 63 74 73 20 74 68 61 74 20 74 68 65 20 73 71  ects that the sq
d970: 6c 69 74 65 33 5f 66 69 6c 65 2e 70 4d 65 74 68  lite3_file.pMeth
d980: 6f 64 73 0a 2a 2a 20 65 6c 65 6d 65 6e 74 20 77  ods.** element w
d990: 69 6c 6c 20 62 65 20 76 61 6c 69 64 20 61 66 74  ill be valid aft
d9a0: 65 72 20 78 4f 70 65 6e 20 72 65 74 75 72 6e 73  er xOpen returns
d9b0: 20 72 65 67 61 72 64 6c 65 73 73 20 6f 66 20 74   regardless of t
d9c0: 68 65 20 73 75 63 63 65 73 73 0a 2a 2a 20 6f 72  he success.** or
d9d0: 20 66 61 69 6c 75 72 65 20 6f 66 20 74 68 65 20   failure of the 
d9e0: 78 4f 70 65 6e 20 63 61 6c 6c 2e 0a 2a 2a 0a 2a  xOpen call..**.*
d9f0: 2a 20 5b 5b 73 71 6c 69 74 65 33 5f 76 66 73 2e  * [[sqlite3_vfs.
da00: 78 41 63 63 65 73 73 5d 5d 0a 2a 2a 20 5e 54 68  xAccess]].** ^Th
da10: 65 20 66 6c 61 67 73 20 61 72 67 75 6d 65 6e 74  e flags argument
da20: 20 74 6f 20 78 41 63 63 65 73 73 28 29 20 6d 61   to xAccess() ma
da30: 79 20 62 65 20 5b 53 51 4c 49 54 45 5f 41 43 43  y be [SQLITE_ACC
da40: 45 53 53 5f 45 58 49 53 54 53 5d 0a 2a 2a 20 74  ESS_EXISTS].** t
da50: 6f 20 74 65 73 74 20 66 6f 72 20 74 68 65 20 65  o test for the e
da60: 78 69 73 74 65 6e 63 65 20 6f 66 20 61 20 66 69  xistence of a fi
da70: 6c 65 2c 20 6f 72 20 5b 53 51 4c 49 54 45 5f 41  le, or [SQLITE_A
da80: 43 43 45 53 53 5f 52 45 41 44 57 52 49 54 45 5d  CCESS_READWRITE]
da90: 20 74 6f 0a 2a 2a 20 74 65 73 74 20 77 68 65 74   to.** test whet
daa0: 68 65 72 20 61 20 66 69 6c 65 20 69 73 20 72 65  her a file is re
dab0: 61 64 61 62 6c 65 20 61 6e 64 20 77 72 69 74 61  adable and writa
dac0: 62 6c 65 2c 20 6f 72 20 5b 53 51 4c 49 54 45 5f  ble, or [SQLITE_
dad0: 41 43 43 45 53 53 5f 52 45 41 44 5d 0a 2a 2a 20  ACCESS_READ].** 
dae0: 74 6f 20 74 65 73 74 20 77 68 65 74 68 65 72 20  to test whether 
daf0: 61 20 66 69 6c 65 20 69 73 20 61 74 20 6c 65 61  a file is at lea
db00: 73 74 20 72 65 61 64 61 62 6c 65 2e 20 20 20 54  st readable.   T
db10: 68 65 20 66 69 6c 65 20 63 61 6e 20 62 65 20 61  he file can be a
db20: 0a 2a 2a 20 64 69 72 65 63 74 6f 72 79 2e 0a 2a  .** directory..*
db30: 2a 0a 2a 2a 20 5e 53 51 4c 69 74 65 20 77 69 6c  *.** ^SQLite wil
db40: 6c 20 61 6c 77 61 79 73 20 61 6c 6c 6f 63 61 74  l always allocat
db50: 65 20 61 74 20 6c 65 61 73 74 20 6d 78 50 61 74  e at least mxPat
db60: 68 6e 61 6d 65 2b 31 20 62 79 74 65 73 20 66 6f  hname+1 bytes fo
db70: 72 20 74 68 65 0a 2a 2a 20 6f 75 74 70 75 74 20  r the.** output 
db80: 62 75 66 66 65 72 20 78 46 75 6c 6c 50 61 74 68  buffer xFullPath
db90: 6e 61 6d 65 2e 20 20 54 68 65 20 65 78 61 63 74  name.  The exact
dba0: 20 73 69 7a 65 20 6f 66 20 74 68 65 20 6f 75 74   size of the out
dbb0: 70 75 74 20 62 75 66 66 65 72 0a 2a 2a 20 69 73  put buffer.** is
dbc0: 20 61 6c 73 6f 20 70 61 73 73 65 64 20 61 73 20   also passed as 
dbd0: 61 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 62  a parameter to b
dbe0: 6f 74 68 20 20 6d 65 74 68 6f 64 73 2e 20 49 66  oth  methods. If
dbf0: 20 74 68 65 20 6f 75 74 70 75 74 20 62 75 66 66   the output buff
dc00: 65 72 0a 2a 2a 20 69 73 20 6e 6f 74 20 6c 61 72  er.** is not lar
dc10: 67 65 20 65 6e 6f 75 67 68 2c 20 5b 53 51 4c 49  ge enough, [SQLI
dc20: 54 45 5f 43 41 4e 54 4f 50 45 4e 5d 20 73 68 6f  TE_CANTOPEN] sho
dc30: 75 6c 64 20 62 65 20 72 65 74 75 72 6e 65 64 2e  uld be returned.
dc40: 20 53 69 6e 63 65 20 74 68 69 73 20 69 73 0a 2a   Since this is.*
dc50: 2a 20 68 61 6e 64 6c 65 64 20 61 73 20 61 20 66  * handled as a f
dc60: 61 74 61 6c 20 65 72 72 6f 72 20 62 79 20 53 51  atal error by SQ
dc70: 4c 69 74 65 2c 20 76 66 73 20 69 6d 70 6c 65 6d  Lite, vfs implem
dc80: 65 6e 74 61 74 69 6f 6e 73 20 73 68 6f 75 6c 64  entations should
dc90: 20 65 6e 64 65 61 76 6f 72 0a 2a 2a 20 74 6f 20   endeavor.** to 
dca0: 70 72 65 76 65 6e 74 20 74 68 69 73 20 62 79 20  prevent this by 
dcb0: 73 65 74 74 69 6e 67 20 6d 78 50 61 74 68 6e 61  setting mxPathna
dcc0: 6d 65 20 74 6f 20 61 20 73 75 66 66 69 63 69 65  me to a sufficie
dcd0: 6e 74 6c 79 20 6c 61 72 67 65 20 76 61 6c 75 65  ntly large value
dce0: 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 78 52 61 6e  ..**.** The xRan
dcf0: 64 6f 6d 6e 65 73 73 28 29 2c 20 78 53 6c 65 65  domness(), xSlee
dd00: 70 28 29 2c 20 78 43 75 72 72 65 6e 74 54 69 6d  p(), xCurrentTim
dd10: 65 28 29 2c 20 61 6e 64 20 78 43 75 72 72 65 6e  e(), and xCurren
dd20: 74 54 69 6d 65 49 6e 74 36 34 28 29 0a 2a 2a 20  tTimeInt64().** 
dd30: 69 6e 74 65 72 66 61 63 65 73 20 61 72 65 20 6e  interfaces are n
dd40: 6f 74 20 73 74 72 69 63 74 6c 79 20 61 20 70 61  ot strictly a pa
dd50: 72 74 20 6f 66 20 74 68 65 20 66 69 6c 65 73 79  rt of the filesy
dd60: 73 74 65 6d 2c 20 62 75 74 20 74 68 65 79 20 61  stem, but they a
dd70: 72 65 0a 2a 2a 20 69 6e 63 6c 75 64 65 64 20 69  re.** included i
dd80: 6e 20 74 68 65 20 56 46 53 20 73 74 72 75 63 74  n the VFS struct
dd90: 75 72 65 20 66 6f 72 20 63 6f 6d 70 6c 65 74 65  ure for complete
dda0: 6e 65 73 73 2e 0a 2a 2a 20 54 68 65 20 78 52 61  ness..** The xRa
ddb0: 6e 64 6f 6d 6e 65 73 73 28 29 20 66 75 6e 63 74  ndomness() funct
ddc0: 69 6f 6e 20 61 74 74 65 6d 70 74 73 20 74 6f 20  ion attempts to 
ddd0: 72 65 74 75 72 6e 20 6e 42 79 74 65 73 20 62 79  return nBytes by
dde0: 74 65 73 0a 2a 2a 20 6f 66 20 67 6f 6f 64 2d 71  tes.** of good-q
ddf0: 75 61 6c 69 74 79 20 72 61 6e 64 6f 6d 6e 65 73  uality randomnes
de00: 73 20 69 6e 74 6f 20 7a 4f 75 74 2e 20 20 54 68  s into zOut.  Th
de10: 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 20 69  e return value i
de20: 73 0a 2a 2a 20 74 68 65 20 61 63 74 75 61 6c 20  s.** the actual 
de30: 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73 20  number of bytes 
de40: 6f 66 20 72 61 6e 64 6f 6d 6e 65 73 73 20 6f 62  of randomness ob
de50: 74 61 69 6e 65 64 2e 0a 2a 2a 20 54 68 65 20 78  tained..** The x
de60: 53 6c 65 65 70 28 29 20 6d 65 74 68 6f 64 20 63  Sleep() method c
de70: 61 75 73 65 73 20 74 68 65 20 63 61 6c 6c 69 6e  auses the callin
de80: 67 20 74 68 72 65 61 64 20 74 6f 20 73 6c 65 65  g thread to slee
de90: 70 20 66 6f 72 20 61 74 0a 2a 2a 20 6c 65 61 73  p for at.** leas
dea0: 74 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20  t the number of 
deb0: 6d 69 63 72 6f 73 65 63 6f 6e 64 73 20 67 69 76  microseconds giv
dec0: 65 6e 2e 20 20 5e 54 68 65 20 78 43 75 72 72 65  en.  ^The xCurre
ded0: 6e 74 54 69 6d 65 28 29 0a 2a 2a 20 6d 65 74 68  ntTime().** meth
dee0: 6f 64 20 72 65 74 75 72 6e 73 20 61 20 4a 75 6c  od returns a Jul
def0: 69 61 6e 20 44 61 79 20 4e 75 6d 62 65 72 20 66  ian Day Number f
df00: 6f 72 20 74 68 65 20 63 75 72 72 65 6e 74 20 64  or the current d
df10: 61 74 65 20 61 6e 64 20 74 69 6d 65 20 61 73 0a  ate and time as.
df20: 2a 2a 20 61 20 66 6c 6f 61 74 69 6e 67 20 70 6f  ** a floating po
df30: 69 6e 74 20 76 61 6c 75 65 2e 0a 2a 2a 20 5e 54  int value..** ^T
df40: 68 65 20 78 43 75 72 72 65 6e 74 54 69 6d 65 49  he xCurrentTimeI
df50: 6e 74 36 34 28 29 20 6d 65 74 68 6f 64 20 72 65  nt64() method re
df60: 74 75 72 6e 73 2c 20 61 73 20 61 6e 20 69 6e 74  turns, as an int
df70: 65 67 65 72 2c 20 74 68 65 20 4a 75 6c 69 61 6e  eger, the Julian
df80: 0a 2a 2a 20 44 61 79 20 4e 75 6d 62 65 72 20 6d  .** Day Number m
df90: 75 6c 74 69 70 6c 69 65 64 20 62 79 20 38 36 34  ultiplied by 864
dfa0: 30 30 30 30 30 20 28 74 68 65 20 6e 75 6d 62 65  00000 (the numbe
dfb0: 72 20 6f 66 20 6d 69 6c 6c 69 73 65 63 6f 6e 64  r of millisecond
dfc0: 73 20 69 6e 20 0a 2a 2a 20 61 20 32 34 2d 68 6f  s in .** a 24-ho
dfd0: 75 72 20 64 61 79 29 2e 20 20 0a 2a 2a 20 5e 53  ur day).  .** ^S
dfe0: 51 4c 69 74 65 20 77 69 6c 6c 20 75 73 65 20 74  QLite will use t
dff0: 68 65 20 78 43 75 72 72 65 6e 74 54 69 6d 65 49  he xCurrentTimeI
e000: 6e 74 36 34 28 29 20 6d 65 74 68 6f 64 20 74 6f  nt64() method to
e010: 20 67 65 74 20 74 68 65 20 63 75 72 72 65 6e 74   get the current
e020: 0a 2a 2a 20 64 61 74 65 20 61 6e 64 20 74 69 6d  .** date and tim
e030: 65 20 69 66 20 74 68 61 74 20 6d 65 74 68 6f 64  e if that method
e040: 20 69 73 20 61 76 61 69 6c 61 62 6c 65 20 28 69   is available (i
e050: 66 20 69 56 65 72 73 69 6f 6e 20 69 73 20 32 20  f iVersion is 2 
e060: 6f 72 20 0a 2a 2a 20 67 72 65 61 74 65 72 20 61  or .** greater a
e070: 6e 64 20 74 68 65 20 66 75 6e 63 74 69 6f 6e 20  nd the function 
e080: 70 6f 69 6e 74 65 72 20 69 73 20 6e 6f 74 20 4e  pointer is not N
e090: 55 4c 4c 29 20 61 6e 64 20 77 69 6c 6c 20 66 61  ULL) and will fa
e0a0: 6c 6c 20 62 61 63 6b 0a 2a 2a 20 74 6f 20 78 43  ll back.** to xC
e0b0: 75 72 72 65 6e 74 54 69 6d 65 28 29 20 69 66 20  urrentTime() if 
e0c0: 78 43 75 72 72 65 6e 74 54 69 6d 65 49 6e 74 36  xCurrentTimeInt6
e0d0: 34 28 29 20 69 73 20 75 6e 61 76 61 69 6c 61 62  4() is unavailab
e0e0: 6c 65 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 78  le..**.** ^The x
e0f0: 53 65 74 53 79 73 74 65 6d 43 61 6c 6c 28 29 2c  SetSystemCall(),
e100: 20 78 47 65 74 53 79 73 74 65 6d 43 61 6c 6c 28   xGetSystemCall(
e110: 29 2c 20 61 6e 64 20 78 4e 65 73 74 53 79 73 74  ), and xNestSyst
e120: 65 6d 43 61 6c 6c 28 29 20 69 6e 74 65 72 66 61  emCall() interfa
e130: 63 65 73 0a 2a 2a 20 61 72 65 20 6e 6f 74 20 75  ces.** are not u
e140: 73 65 64 20 62 79 20 74 68 65 20 53 51 4c 69 74  sed by the SQLit
e150: 65 20 63 6f 72 65 2e 20 20 54 68 65 73 65 20 6f  e core.  These o
e160: 70 74 69 6f 6e 61 6c 20 69 6e 74 65 72 66 61 63  ptional interfac
e170: 65 73 20 61 72 65 20 70 72 6f 76 69 64 65 64 0a  es are provided.
e180: 2a 2a 20 62 79 20 73 6f 6d 65 20 56 46 53 65 73  ** by some VFSes
e190: 20 74 6f 20 66 61 63 69 6c 69 74 61 74 65 20 74   to facilitate t
e1a0: 65 73 74 69 6e 67 20 6f 66 20 74 68 65 20 56 46  esting of the VF
e1b0: 53 20 63 6f 64 65 2e 20 42 79 20 6f 76 65 72 72  S code. By overr
e1c0: 69 64 69 6e 67 20 0a 2a 2a 20 73 79 73 74 65 6d  iding .** system
e1d0: 20 63 61 6c 6c 73 20 77 69 74 68 20 66 75 6e 63   calls with func
e1e0: 74 69 6f 6e 73 20 75 6e 64 65 72 20 69 74 73 20  tions under its 
e1f0: 63 6f 6e 74 72 6f 6c 2c 20 61 20 74 65 73 74 20  control, a test 
e200: 70 72 6f 67 72 61 6d 20 63 61 6e 0a 2a 2a 20 73  program can.** s
e210: 69 6d 75 6c 61 74 65 20 66 61 75 6c 74 73 20 61  imulate faults a
e220: 6e 64 20 65 72 72 6f 72 20 63 6f 6e 64 69 74 69  nd error conditi
e230: 6f 6e 73 20 74 68 61 74 20 77 6f 75 6c 64 20 6f  ons that would o
e240: 74 68 65 72 77 69 73 65 20 62 65 20 64 69 66 66  therwise be diff
e250: 69 63 75 6c 74 0a 2a 2a 20 6f 72 20 69 6d 70 6f  icult.** or impo
e260: 73 73 69 62 6c 65 20 74 6f 20 69 6e 64 75 63 65  ssible to induce
e270: 2e 20 20 54 68 65 20 73 65 74 20 6f 66 20 73 79  .  The set of sy
e280: 73 74 65 6d 20 63 61 6c 6c 73 20 74 68 61 74 20  stem calls that 
e290: 63 61 6e 20 62 65 20 6f 76 65 72 72 69 64 64 65  can be overridde
e2a0: 6e 0a 2a 2a 20 76 61 72 69 65 73 20 66 72 6f 6d  n.** varies from
e2b0: 20 6f 6e 65 20 56 46 53 20 74 6f 20 61 6e 6f 74   one VFS to anot
e2c0: 68 65 72 2c 20 61 6e 64 20 66 72 6f 6d 20 6f 6e  her, and from on
e2d0: 65 20 76 65 72 73 69 6f 6e 20 6f 66 20 74 68 65  e version of the
e2e0: 20 73 61 6d 65 20 56 46 53 20 74 6f 20 74 68 65   same VFS to the
e2f0: 0a 2a 2a 20 6e 65 78 74 2e 20 20 41 70 70 6c 69  .** next.  Appli
e300: 63 61 74 69 6f 6e 73 20 74 68 61 74 20 75 73 65  cations that use
e310: 20 74 68 65 73 65 20 69 6e 74 65 72 66 61 63 65   these interface
e320: 73 20 6d 75 73 74 20 62 65 20 70 72 65 70 61 72  s must be prepar
e330: 65 64 20 66 6f 72 20 61 6e 79 0a 2a 2a 20 6f 72  ed for any.** or
e340: 20 61 6c 6c 20 6f 66 20 74 68 65 73 65 20 69 6e   all of these in
e350: 74 65 72 66 61 63 65 73 20 74 6f 20 62 65 20 4e  terfaces to be N
e360: 55 4c 4c 20 6f 72 20 66 6f 72 20 74 68 65 69 72  ULL or for their
e370: 20 62 65 68 61 76 69 6f 72 20 74 6f 20 63 68 61   behavior to cha
e380: 6e 67 65 0a 2a 2a 20 66 72 6f 6d 20 6f 6e 65 20  nge.** from one 
e390: 72 65 6c 65 61 73 65 20 74 6f 20 74 68 65 20 6e  release to the n
e3a0: 65 78 74 2e 20 20 41 70 70 6c 69 63 61 74 69 6f  ext.  Applicatio
e3b0: 6e 73 20 6d 75 73 74 20 6e 6f 74 20 61 74 74 65  ns must not atte
e3c0: 6d 70 74 20 74 6f 20 61 63 63 65 73 73 0a 2a 2a  mpt to access.**
e3d0: 20 61 6e 79 20 6f 66 20 74 68 65 73 65 20 6d 65   any of these me
e3e0: 74 68 6f 64 73 20 69 66 20 74 68 65 20 69 56 65  thods if the iVe
e3f0: 72 73 69 6f 6e 20 6f 66 20 74 68 65 20 56 46 53  rsion of the VFS
e400: 20 69 73 20 6c 65 73 73 20 74 68 61 6e 20 33 2e   is less than 3.
e410: 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73 74 72 75  .*/.typedef stru
e420: 63 74 20 73 71 6c 69 74 65 33 5f 76 66 73 20 73  ct sqlite3_vfs s
e430: 71 6c 69 74 65 33 5f 76 66 73 3b 0a 74 79 70 65  qlite3_vfs;.type
e440: 64 65 66 20 76 6f 69 64 20 28 2a 73 71 6c 69 74  def void (*sqlit
e450: 65 33 5f 73 79 73 63 61 6c 6c 5f 70 74 72 29 28  e3_syscall_ptr)(
e460: 76 6f 69 64 29 3b 0a 73 74 72 75 63 74 20 73 71  void);.struct sq
e470: 6c 69 74 65 33 5f 76 66 73 20 7b 0a 20 20 69 6e  lite3_vfs {.  in
e480: 74 20 69 56 65 72 73 69 6f 6e 3b 20 20 20 20 20  t iVersion;     
e490: 20 20 20 20 20 20 20 2f 2a 20 53 74 72 75 63 74         /* Struct
e4a0: 75 72 65 20 76 65 72 73 69 6f 6e 20 6e 75 6d 62  ure version numb
e4b0: 65 72 20 28 63 75 72 72 65 6e 74 6c 79 20 33 29  er (currently 3)
e4c0: 20 2a 2f 0a 20 20 69 6e 74 20 73 7a 4f 73 46 69   */.  int szOsFi
e4d0: 6c 65 3b 20 20 20 20 20 20 20 20 20 20 20 20 2f  le;            /
e4e0: 2a 20 53 69 7a 65 20 6f 66 20 73 75 62 63 6c 61  * Size of subcla
e4f0: 73 73 65 64 20 73 71 6c 69 74 65 33 5f 66 69 6c  ssed sqlite3_fil
e500: 65 20 2a 2f 0a 20 20 69 6e 74 20 6d 78 50 61 74  e */.  int mxPat
e510: 68 6e 61 6d 65 3b 20 20 20 20 20 20 20 20 20 20  hname;          
e520: 2f 2a 20 4d 61 78 69 6d 75 6d 20 66 69 6c 65 20  /* Maximum file 
e530: 70 61 74 68 6e 61 6d 65 20 6c 65 6e 67 74 68 20  pathname length 
e540: 2a 2f 0a 20 20 73 71 6c 69 74 65 33 5f 76 66 73  */.  sqlite3_vfs
e550: 20 2a 70 4e 65 78 74 3b 20 20 20 20 20 20 2f 2a   *pNext;      /*
e560: 20 4e 65 78 74 20 72 65 67 69 73 74 65 72 65 64   Next registered
e570: 20 56 46 53 20 2a 2f 0a 20 20 63 6f 6e 73 74 20   VFS */.  const 
e580: 63 68 61 72 20 2a 7a 4e 61 6d 65 3b 20 20 20 20  char *zName;    
e590: 20 20 20 2f 2a 20 4e 61 6d 65 20 6f 66 20 74 68     /* Name of th
e5a0: 69 73 20 76 69 72 74 75 61 6c 20 66 69 6c 65 20  is virtual file 
e5b0: 73 79 73 74 65 6d 20 2a 2f 0a 20 20 76 6f 69 64  system */.  void
e5c0: 20 2a 70 41 70 70 44 61 74 61 3b 20 20 20 20 20   *pAppData;     
e5d0: 20 20 20 20 20 2f 2a 20 50 6f 69 6e 74 65 72 20       /* Pointer 
e5e0: 74 6f 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d 73  to application-s
e5f0: 70 65 63 69 66 69 63 20 64 61 74 61 20 2a 2f 0a  pecific data */.
e600: 20 20 69 6e 74 20 28 2a 78 4f 70 65 6e 29 28 73    int (*xOpen)(s
e610: 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 63 6f 6e  qlite3_vfs*, con
e620: 73 74 20 63 68 61 72 20 2a 7a 4e 61 6d 65 2c 20  st char *zName, 
e630: 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 0a 20  sqlite3_file*,. 
e640: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 69 6e                in
e650: 74 20 66 6c 61 67 73 2c 20 69 6e 74 20 2a 70 4f  t flags, int *pO
e660: 75 74 46 6c 61 67 73 29 3b 0a 20 20 69 6e 74 20  utFlags);.  int 
e670: 28 2a 78 44 65 6c 65 74 65 29 28 73 71 6c 69 74  (*xDelete)(sqlit
e680: 65 33 5f 76 66 73 2a 2c 20 63 6f 6e 73 74 20 63  e3_vfs*, const c
e690: 68 61 72 20 2a 7a 4e 61 6d 65 2c 20 69 6e 74 20  har *zName, int 
e6a0: 73 79 6e 63 44 69 72 29 3b 0a 20 20 69 6e 74 20  syncDir);.  int 
e6b0: 28 2a 78 41 63 63 65 73 73 29 28 73 71 6c 69 74  (*xAccess)(sqlit
e6c0: 65 33 5f 76 66 73 2a 2c 20 63 6f 6e 73 74 20 63  e3_vfs*, const c
e6d0: 68 61 72 20 2a 7a 4e 61 6d 65 2c 20 69 6e 74 20  har *zName, int 
e6e0: 66 6c 61 67 73 2c 20 69 6e 74 20 2a 70 52 65 73  flags, int *pRes
e6f0: 4f 75 74 29 3b 0a 20 20 69 6e 74 20 28 2a 78 46  Out);.  int (*xF
e700: 75 6c 6c 50 61 74 68 6e 61 6d 65 29 28 73 71 6c  ullPathname)(sql
e710: 69 74 65 33 5f 76 66 73 2a 2c 20 63 6f 6e 73 74  ite3_vfs*, const
e720: 20 63 68 61 72 20 2a 7a 4e 61 6d 65 2c 20 69 6e   char *zName, in
e730: 74 20 6e 4f 75 74 2c 20 63 68 61 72 20 2a 7a 4f  t nOut, char *zO
e740: 75 74 29 3b 0a 20 20 76 6f 69 64 20 2a 28 2a 78  ut);.  void *(*x
e750: 44 6c 4f 70 65 6e 29 28 73 71 6c 69 74 65 33 5f  DlOpen)(sqlite3_
e760: 76 66 73 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72  vfs*, const char
e770: 20 2a 7a 46 69 6c 65 6e 61 6d 65 29 3b 0a 20 20   *zFilename);.  
e780: 76 6f 69 64 20 28 2a 78 44 6c 45 72 72 6f 72 29  void (*xDlError)
e790: 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 69  (sqlite3_vfs*, i
e7a0: 6e 74 20 6e 42 79 74 65 2c 20 63 68 61 72 20 2a  nt nByte, char *
e7b0: 7a 45 72 72 4d 73 67 29 3b 0a 20 20 76 6f 69 64  zErrMsg);.  void
e7c0: 20 28 2a 28 2a 78 44 6c 53 79 6d 29 28 73 71 6c   (*(*xDlSym)(sql
e7d0: 69 74 65 33 5f 76 66 73 2a 2c 76 6f 69 64 2a 2c  ite3_vfs*,void*,
e7e0: 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 53 79   const char *zSy
e7f0: 6d 62 6f 6c 29 29 28 76 6f 69 64 29 3b 0a 20 20  mbol))(void);.  
e800: 76 6f 69 64 20 28 2a 78 44 6c 43 6c 6f 73 65 29  void (*xDlClose)
e810: 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 76  (sqlite3_vfs*, v
e820: 6f 69 64 2a 29 3b 0a 20 20 69 6e 74 20 28 2a 78  oid*);.  int (*x
e830: 52 61 6e 64 6f 6d 6e 65 73 73 29 28 73 71 6c 69  Randomness)(sqli
e840: 74 65 33 5f 76 66 73 2a 2c 20 69 6e 74 20 6e 42  te3_vfs*, int nB
e850: 79 74 65 2c 20 63 68 61 72 20 2a 7a 4f 75 74 29  yte, char *zOut)
e860: 3b 0a 20 20 69 6e 74 20 28 2a 78 53 6c 65 65 70  ;.  int (*xSleep
e870: 29 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20  )(sqlite3_vfs*, 
e880: 69 6e 74 20 6d 69 63 72 6f 73 65 63 6f 6e 64 73  int microseconds
e890: 29 3b 0a 20 20 69 6e 74 20 28 2a 78 43 75 72 72  );.  int (*xCurr
e8a0: 65 6e 74 54 69 6d 65 29 28 73 71 6c 69 74 65 33  entTime)(sqlite3
e8b0: 5f 76 66 73 2a 2c 20 64 6f 75 62 6c 65 2a 29 3b  _vfs*, double*);
e8c0: 0a 20 20 69 6e 74 20 28 2a 78 47 65 74 4c 61 73  .  int (*xGetLas
e8d0: 74 45 72 72 6f 72 29 28 73 71 6c 69 74 65 33 5f  tError)(sqlite3_
e8e0: 76 66 73 2a 2c 20 69 6e 74 2c 20 63 68 61 72 20  vfs*, int, char 
e8f0: 2a 29 3b 0a 20 20 2f 2a 0a 20 20 2a 2a 20 54 68  *);.  /*.  ** Th
e900: 65 20 6d 65 74 68 6f 64 73 20 61 62 6f 76 65 20  e methods above 
e910: 61 72 65 20 69 6e 20 76 65 72 73 69 6f 6e 20 31  are in version 1
e920: 20 6f 66 20 74 68 65 20 73 71 6c 69 74 65 5f 76   of the sqlite_v
e930: 66 73 20 6f 62 6a 65 63 74 0a 20 20 2a 2a 20 64  fs object.  ** d
e940: 65 66 69 6e 69 74 69 6f 6e 2e 20 20 54 68 6f 73  efinition.  Thos
e950: 65 20 74 68 61 74 20 66 6f 6c 6c 6f 77 20 61 72  e that follow ar
e960: 65 20 61 64 64 65 64 20 69 6e 20 76 65 72 73 69  e added in versi
e970: 6f 6e 20 32 20 6f 72 20 6c 61 74 65 72 0a 20 20  on 2 or later.  
e980: 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 43 75 72 72  */.  int (*xCurr
e990: 65 6e 74 54 69 6d 65 49 6e 74 36 34 29 28 73 71  entTimeInt64)(sq
e9a0: 6c 69 74 65 33 5f 76 66 73 2a 2c 20 73 71 6c 69  lite3_vfs*, sqli
e9b0: 74 65 33 5f 69 6e 74 36 34 2a 29 3b 0a 20 20 2f  te3_int64*);.  /
e9c0: 2a 0a 20 20 2a 2a 20 54 68 65 20 6d 65 74 68 6f  *.  ** The metho
e9d0: 64 73 20 61 62 6f 76 65 20 61 72 65 20 69 6e 20  ds above are in 
e9e0: 76 65 72 73 69 6f 6e 73 20 31 20 61 6e 64 20 32  versions 1 and 2
e9f0: 20 6f 66 20 74 68 65 20 73 71 6c 69 74 65 5f 76   of the sqlite_v
ea00: 66 73 20 6f 62 6a 65 63 74 2e 0a 20 20 2a 2a 20  fs object..  ** 
ea10: 54 68 6f 73 65 20 62 65 6c 6f 77 20 61 72 65 20  Those below are 
ea20: 66 6f 72 20 76 65 72 73 69 6f 6e 20 33 20 61 6e  for version 3 an
ea30: 64 20 67 72 65 61 74 65 72 2e 0a 20 20 2a 2f 0a  d greater..  */.
ea40: 20 20 69 6e 74 20 28 2a 78 53 65 74 53 79 73 74    int (*xSetSyst
ea50: 65 6d 43 61 6c 6c 29 28 73 71 6c 69 74 65 33 5f  emCall)(sqlite3_
ea60: 76 66 73 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72  vfs*, const char
ea70: 20 2a 7a 4e 61 6d 65 2c 20 73 71 6c 69 74 65 33   *zName, sqlite3
ea80: 5f 73 79 73 63 61 6c 6c 5f 70 74 72 29 3b 0a 20  _syscall_ptr);. 
ea90: 20 73 71 6c 69 74 65 33 5f 73 79 73 63 61 6c 6c   sqlite3_syscall
eaa0: 5f 70 74 72 20 28 2a 78 47 65 74 53 79 73 74 65  _ptr (*xGetSyste
eab0: 6d 43 61 6c 6c 29 28 73 71 6c 69 74 65 33 5f 76  mCall)(sqlite3_v
eac0: 66 73 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72 20  fs*, const char 
ead0: 2a 7a 4e 61 6d 65 29 3b 0a 20 20 63 6f 6e 73 74  *zName);.  const
eae0: 20 63 68 61 72 20 2a 28 2a 78 4e 65 78 74 53 79   char *(*xNextSy
eaf0: 73 74 65 6d 43 61 6c 6c 29 28 73 71 6c 69 74 65  stemCall)(sqlite
eb00: 33 5f 76 66 73 2a 2c 20 63 6f 6e 73 74 20 63 68  3_vfs*, const ch
eb10: 61 72 20 2a 7a 4e 61 6d 65 29 3b 0a 20 20 2f 2a  ar *zName);.  /*
eb20: 0a 20 20 2a 2a 20 54 68 65 20 6d 65 74 68 6f 64  .  ** The method
eb30: 73 20 61 62 6f 76 65 20 61 72 65 20 69 6e 20 76  s above are in v
eb40: 65 72 73 69 6f 6e 73 20 31 20 74 68 72 6f 75 67  ersions 1 throug
eb50: 68 20 33 20 6f 66 20 74 68 65 20 73 71 6c 69 74  h 3 of the sqlit
eb60: 65 5f 76 66 73 20 6f 62 6a 65 63 74 2e 0a 20 20  e_vfs object..  
eb70: 2a 2a 20 4e 65 77 20 66 69 65 6c 64 73 20 6d 61  ** New fields ma
eb80: 79 20 62 65 20 61 70 70 65 6e 64 65 64 20 69 6e  y be appended in
eb90: 20 66 75 74 75 72 65 20 76 65 72 73 69 6f 6e 73   future versions
eba0: 2e 20 20 54 68 65 20 69 56 65 72 73 69 6f 6e 0a  .  The iVersion.
ebb0: 20 20 2a 2a 20 76 61 6c 75 65 20 77 69 6c 6c 20    ** value will 
ebc0: 69 6e 63 72 65 6d 65 6e 74 20 77 68 65 6e 65 76  increment whenev
ebd0: 65 72 20 74 68 69 73 20 68 61 70 70 65 6e 73 2e  er this happens.
ebe0: 20 0a 20 20 2a 2f 0a 7d 3b 0a 0a 2f 2a 0a 2a 2a   .  */.};../*.**
ebf0: 20 43 41 50 49 33 52 45 46 3a 20 46 6c 61 67 73   CAPI3REF: Flags
ec00: 20 66 6f 72 20 74 68 65 20 78 41 63 63 65 73 73   for the xAccess
ec10: 20 56 46 53 20 6d 65 74 68 6f 64 0a 2a 2a 0a 2a   VFS method.**.*
ec20: 2a 20 54 68 65 73 65 20 69 6e 74 65 67 65 72 20  * These integer 
ec30: 63 6f 6e 73 74 61 6e 74 73 20 63 61 6e 20 62 65  constants can be
ec40: 20 75 73 65 64 20 61 73 20 74 68 65 20 74 68 69   used as the thi
ec50: 72 64 20 70 61 72 61 6d 65 74 65 72 20 74 6f 0a  rd parameter to.
ec60: 2a 2a 20 74 68 65 20 78 41 63 63 65 73 73 20 6d  ** the xAccess m
ec70: 65 74 68 6f 64 20 6f 66 20 61 6e 20 5b 73 71 6c  ethod of an [sql
ec80: 69 74 65 33 5f 76 66 73 5d 20 6f 62 6a 65 63 74  ite3_vfs] object
ec90: 2e 20 20 54 68 65 79 20 64 65 74 65 72 6d 69 6e  .  They determin
eca0: 65 0a 2a 2a 20 77 68 61 74 20 6b 69 6e 64 20 6f  e.** what kind o
ecb0: 66 20 70 65 72 6d 69 73 73 69 6f 6e 73 20 74 68  f permissions th
ecc0: 65 20 78 41 63 63 65 73 73 20 6d 65 74 68 6f 64  e xAccess method
ecd0: 20 69 73 20 6c 6f 6f 6b 69 6e 67 20 66 6f 72 2e   is looking for.
ece0: 0a 2a 2a 20 57 69 74 68 20 53 51 4c 49 54 45 5f  .** With SQLITE_
ecf0: 41 43 43 45 53 53 5f 45 58 49 53 54 53 2c 20 74  ACCESS_EXISTS, t
ed00: 68 65 20 78 41 63 63 65 73 73 20 6d 65 74 68 6f  he xAccess metho
ed10: 64 0a 2a 2a 20 73 69 6d 70 6c 79 20 63 68 65 63  d.** simply chec
ed20: 6b 73 20 77 68 65 74 68 65 72 20 74 68 65 20 66  ks whether the f
ed30: 69 6c 65 20 65 78 69 73 74 73 2e 0a 2a 2a 20 57  ile exists..** W
ed40: 69 74 68 20 53 51 4c 49 54 45 5f 41 43 43 45 53  ith SQLITE_ACCES
ed50: 53 5f 52 45 41 44 57 52 49 54 45 2c 20 74 68 65  S_READWRITE, the
ed60: 20 78 41 63 63 65 73 73 20 6d 65 74 68 6f 64 0a   xAccess method.
ed70: 2a 2a 20 63 68 65 63 6b 73 20 77 68 65 74 68 65  ** checks whethe
ed80: 72 20 74 68 65 20 6e 61 6d 65 64 20 64 69 72 65  r the named dire
ed90: 63 74 6f 72 79 20 69 73 20 62 6f 74 68 20 72 65  ctory is both re
eda0: 61 64 61 62 6c 65 20 61 6e 64 20 77 72 69 74 61  adable and writa
edb0: 62 6c 65 0a 2a 2a 20 28 69 6e 20 6f 74 68 65 72  ble.** (in other
edc0: 20 77 6f 72 64 73 2c 20 69 66 20 66 69 6c 65 73   words, if files
edd0: 20 63 61 6e 20 62 65 20 61 64 64 65 64 2c 20 72   can be added, r
ede0: 65 6d 6f 76 65 64 2c 20 61 6e 64 20 72 65 6e 61  emoved, and rena
edf0: 6d 65 64 20 77 69 74 68 69 6e 0a 2a 2a 20 74 68  med within.** th
ee00: 65 20 64 69 72 65 63 74 6f 72 79 29 2e 0a 2a 2a  e directory)..**
ee10: 20 54 68 65 20 53 51 4c 49 54 45 5f 41 43 43 45   The SQLITE_ACCE
ee20: 53 53 5f 52 45 41 44 57 52 49 54 45 20 63 6f 6e  SS_READWRITE con
ee30: 73 74 61 6e 74 20 69 73 20 63 75 72 72 65 6e 74  stant is current
ee40: 6c 79 20 75 73 65 64 20 6f 6e 6c 79 20 62 79 20  ly used only by 
ee50: 74 68 65 0a 2a 2a 20 5b 74 65 6d 70 5f 73 74 6f  the.** [temp_sto
ee60: 72 65 5f 64 69 72 65 63 74 6f 72 79 20 70 72 61  re_directory pra
ee70: 67 6d 61 5d 2c 20 74 68 6f 75 67 68 20 74 68 69  gma], though thi
ee80: 73 20 63 6f 75 6c 64 20 63 68 61 6e 67 65 20 69  s could change i
ee90: 6e 20 61 20 66 75 74 75 72 65 0a 2a 2a 20 72 65  n a future.** re
eea0: 6c 65 61 73 65 20 6f 66 20 53 51 4c 69 74 65 2e  lease of SQLite.
eeb0: 0a 2a 2a 20 57 69 74 68 20 53 51 4c 49 54 45 5f  .** With SQLITE_
eec0: 41 43 43 45 53 53 5f 52 45 41 44 2c 20 74 68 65  ACCESS_READ, the
eed0: 20 78 41 63 63 65 73 73 20 6d 65 74 68 6f 64 0a   xAccess method.
eee0: 2a 2a 20 63 68 65 63 6b 73 20 77 68 65 74 68 65  ** checks whethe
eef0: 72 20 74 68 65 20 66 69 6c 65 20 69 73 20 72 65  r the file is re
ef00: 61 64 61 62 6c 65 2e 20 20 54 68 65 20 53 51 4c  adable.  The SQL
ef10: 49 54 45 5f 41 43 43 45 53 53 5f 52 45 41 44 20  ITE_ACCESS_READ 
ef20: 63 6f 6e 73 74 61 6e 74 20 69 73 0a 2a 2a 20 63  constant is.** c
ef30: 75 72 72 65 6e 74 6c 79 20 75 6e 75 73 65 64 2c  urrently unused,
ef40: 20 74 68 6f 75 67 68 20 69 74 20 6d 69 67 68 74   though it might
ef50: 20 62 65 20 75 73 65 64 20 69 6e 20 61 20 66 75   be used in a fu
ef60: 74 75 72 65 20 72 65 6c 65 61 73 65 20 6f 66 0a  ture release of.
ef70: 2a 2a 20 53 51 4c 69 74 65 2e 0a 2a 2f 0a 23 64  ** SQLite..*/.#d
ef80: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41 43 43  efine SQLITE_ACC
ef90: 45 53 53 5f 45 58 49 53 54 53 20 20 20 20 30 0a  ESS_EXISTS    0.
efa0: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41  #define SQLITE_A
efb0: 43 43 45 53 53 5f 52 45 41 44 57 52 49 54 45 20  CCESS_READWRITE 
efc0: 31 20 20 20 2f 2a 20 55 73 65 64 20 62 79 20 50  1   /* Used by P
efd0: 52 41 47 4d 41 20 74 65 6d 70 5f 73 74 6f 72 65  RAGMA temp_store
efe0: 5f 64 69 72 65 63 74 6f 72 79 20 2a 2f 0a 23 64  _directory */.#d
eff0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41 43 43  efine SQLITE_ACC
f000: 45 53 53 5f 52 45 41 44 20 20 20 20 20 20 32 20  ESS_READ      2 
f010: 20 20 2f 2a 20 55 6e 75 73 65 64 20 2a 2f 0a 0a    /* Unused */..
f020: 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
f030: 46 6c 61 67 73 20 66 6f 72 20 74 68 65 20 78 53  Flags for the xS
f040: 68 6d 4c 6f 63 6b 20 56 46 53 20 6d 65 74 68 6f  hmLock VFS metho
f050: 64 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 69 6e  d.**.** These in
f060: 74 65 67 65 72 20 63 6f 6e 73 74 61 6e 74 73 20  teger constants 
f070: 64 65 66 69 6e 65 20 74 68 65 20 76 61 72 69 6f  define the vario
f080: 75 73 20 6c 6f 63 6b 69 6e 67 20 6f 70 65 72 61  us locking opera
f090: 74 69 6f 6e 73 0a 2a 2a 20 61 6c 6c 6f 77 65 64  tions.** allowed
f0a0: 20 62 79 20 74 68 65 20 78 53 68 6d 4c 6f 63 6b   by the xShmLock
f0b0: 20 6d 65 74 68 6f 64 20 6f 66 20 5b 73 71 6c 69   method of [sqli
f0c0: 74 65 33 5f 69 6f 5f 6d 65 74 68 6f 64 73 5d 2e  te3_io_methods].
f0d0: 20 20 54 68 65 0a 2a 2a 20 66 6f 6c 6c 6f 77 69    The.** followi
f0e0: 6e 67 20 61 72 65 20 74 68 65 20 6f 6e 6c 79 20  ng are the only 
f0f0: 6c 65 67 61 6c 20 63 6f 6d 62 69 6e 61 74 69 6f  legal combinatio
f100: 6e 73 20 6f 66 20 66 6c 61 67 73 20 74 6f 20 74  ns of flags to t
f110: 68 65 0a 2a 2a 20 78 53 68 6d 4c 6f 63 6b 20 6d  he.** xShmLock m
f120: 65 74 68 6f 64 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c  ethod:.**.** <ul
f130: 3e 0a 2a 2a 20 3c 6c 69 3e 20 20 53 51 4c 49 54  >.** <li>  SQLIT
f140: 45 5f 53 48 4d 5f 4c 4f 43 4b 20 7c 20 53 51 4c  E_SHM_LOCK | SQL
f150: 49 54 45 5f 53 48 4d 5f 53 48 41 52 45 44 0a 2a  ITE_SHM_SHARED.*
f160: 2a 20 3c 6c 69 3e 20 20 53 51 4c 49 54 45 5f 53  * <li>  SQLITE_S
f170: 48 4d 5f 4c 4f 43 4b 20 7c 20 53 51 4c 49 54 45  HM_LOCK | SQLITE
f180: 5f 53 48 4d 5f 45 58 43 4c 55 53 49 56 45 0a 2a  _SHM_EXCLUSIVE.*
f190: 2a 20 3c 6c 69 3e 20 20 53 51 4c 49 54 45 5f 53  * <li>  SQLITE_S
f1a0: 48 4d 5f 55 4e 4c 4f 43 4b 20 7c 20 53 51 4c 49  HM_UNLOCK | SQLI
f1b0: 54 45 5f 53 48 4d 5f 53 48 41 52 45 44 0a 2a 2a  TE_SHM_SHARED.**
f1c0: 20 3c 6c 69 3e 20 20 53 51 4c 49 54 45 5f 53 48   <li>  SQLITE_SH
f1d0: 4d 5f 55 4e 4c 4f 43 4b 20 7c 20 53 51 4c 49 54  M_UNLOCK | SQLIT
f1e0: 45 5f 53 48 4d 5f 45 58 43 4c 55 53 49 56 45 0a  E_SHM_EXCLUSIVE.
f1f0: 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 0a 2a 2a 20 57  ** </ul>.**.** W
f200: 68 65 6e 20 75 6e 6c 6f 63 6b 69 6e 67 2c 20 74  hen unlocking, t
f210: 68 65 20 73 61 6d 65 20 53 48 41 52 45 44 20 6f  he same SHARED o
f220: 72 20 45 58 43 4c 55 53 49 56 45 20 66 6c 61 67  r EXCLUSIVE flag
f230: 20 6d 75 73 74 20 62 65 20 73 75 70 70 6c 69 65   must be supplie
f240: 64 20 61 73 0a 2a 2a 20 77 61 73 20 67 69 76 65  d as.** was give
f250: 6e 20 6f 6e 20 74 68 65 20 63 6f 72 72 65 73 70  n on the corresp
f260: 6f 6e 64 69 6e 67 20 6c 6f 63 6b 2e 20 20 0a 2a  onding lock.  .*
f270: 2a 0a 2a 2a 20 54 68 65 20 78 53 68 6d 4c 6f 63  *.** The xShmLoc
f280: 6b 20 6d 65 74 68 6f 64 20 63 61 6e 20 74 72 61  k method can tra
f290: 6e 73 69 74 69 6f 6e 20 62 65 74 77 65 65 6e 20  nsition between 
f2a0: 75 6e 6c 6f 63 6b 65 64 20 61 6e 64 20 53 48 41  unlocked and SHA
f2b0: 52 45 44 20 6f 72 0a 2a 2a 20 62 65 74 77 65 65  RED or.** betwee
f2c0: 6e 20 75 6e 6c 6f 63 6b 65 64 20 61 6e 64 20 45  n unlocked and E
f2d0: 58 43 4c 55 53 49 56 45 2e 20 20 49 74 20 63 61  XCLUSIVE.  It ca
f2e0: 6e 6e 6f 74 20 74 72 61 6e 73 69 74 69 6f 6e 20  nnot transition 
f2f0: 62 65 74 77 65 65 6e 20 53 48 41 52 45 44 0a 2a  between SHARED.*
f300: 2a 20 61 6e 64 20 45 58 43 4c 55 53 49 56 45 2e  * and EXCLUSIVE.
f310: 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  .*/.#define SQLI
f320: 54 45 5f 53 48 4d 5f 55 4e 4c 4f 43 4b 20 20 20  TE_SHM_UNLOCK   
f330: 20 20 20 20 31 0a 23 64 65 66 69 6e 65 20 53 51      1.#define SQ
f340: 4c 49 54 45 5f 53 48 4d 5f 4c 4f 43 4b 20 20 20  LITE_SHM_LOCK   
f350: 20 20 20 20 20 20 32 0a 23 64 65 66 69 6e 65 20        2.#define 
f360: 53 51 4c 49 54 45 5f 53 48 4d 5f 53 48 41 52 45  SQLITE_SHM_SHARE
f370: 44 20 20 20 20 20 20 20 34 0a 23 64 65 66 69 6e  D       4.#defin
f380: 65 20 53 51 4c 49 54 45 5f 53 48 4d 5f 45 58 43  e SQLITE_SHM_EXC
f390: 4c 55 53 49 56 45 20 20 20 20 38 0a 0a 2f 2a 0a  LUSIVE    8../*.
f3a0: 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4d 61 78  ** CAPI3REF: Max
f3b0: 69 6d 75 6d 20 78 53 68 6d 4c 6f 63 6b 20 69 6e  imum xShmLock in
f3c0: 64 65 78 0a 2a 2a 0a 2a 2a 20 54 68 65 20 78 53  dex.**.** The xS
f3d0: 68 6d 4c 6f 63 6b 20 6d 65 74 68 6f 64 20 6f 6e  hmLock method on
f3e0: 20 5b 73 71 6c 69 74 65 33 5f 69 6f 5f 6d 65 74   [sqlite3_io_met
f3f0: 68 6f 64 73 5d 20 6d 61 79 20 75 73 65 20 76 61  hods] may use va
f400: 6c 75 65 73 0a 2a 2a 20 62 65 74 77 65 65 6e 20  lues.** between 
f410: 30 20 61 6e 64 20 74 68 69 73 20 75 70 70 65 72  0 and this upper
f420: 20 62 6f 75 6e 64 20 61 73 20 69 74 73 20 22 6f   bound as its "o
f430: 66 66 73 65 74 22 20 61 72 67 75 6d 65 6e 74 2e  ffset" argument.
f440: 0a 2a 2a 20 54 68 65 20 53 51 4c 69 74 65 20 63  .** The SQLite c
f450: 6f 72 65 20 77 69 6c 6c 20 6e 65 76 65 72 20 61  ore will never a
f460: 74 74 65 6d 70 74 20 74 6f 20 61 63 71 75 69 72  ttempt to acquir
f470: 65 20 6f 72 20 72 65 6c 65 61 73 65 20 61 0a 2a  e or release a.*
f480: 2a 20 6c 6f 63 6b 20 6f 75 74 73 69 64 65 20 6f  * lock outside o
f490: 66 20 74 68 69 73 20 72 61 6e 67 65 0a 2a 2f 0a  f this range.*/.
f4a0: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53  #define SQLITE_S
f4b0: 48 4d 5f 4e 4c 4f 43 4b 20 20 20 20 20 20 20 20  HM_NLOCK        
f4c0: 38 0a 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  8.../*.** CAPI3R
f4d0: 45 46 3a 20 49 6e 69 74 69 61 6c 69 7a 65 20 54  EF: Initialize T
f4e0: 68 65 20 53 51 4c 69 74 65 20 4c 69 62 72 61 72  he SQLite Librar
f4f0: 79 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  y.**.** ^The sql
f500: 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28  ite3_initialize(
f510: 29 20 72 6f 75 74 69 6e 65 20 69 6e 69 74 69 61  ) routine initia
f520: 6c 69 7a 65 73 20 74 68 65 0a 2a 2a 20 53 51 4c  lizes the.** SQL
f530: 69 74 65 20 6c 69 62 72 61 72 79 2e 20 20 5e 54  ite library.  ^T
f540: 68 65 20 73 71 6c 69 74 65 33 5f 73 68 75 74 64  he sqlite3_shutd
f550: 6f 77 6e 28 29 20 72 6f 75 74 69 6e 65 0a 2a 2a  own() routine.**
f560: 20 64 65 61 6c 6c 6f 63 61 74 65 73 20 61 6e 79   deallocates any
f570: 20 72 65 73 6f 75 72 63 65 73 20 74 68 61 74 20   resources that 
f580: 77 65 72 65 20 61 6c 6c 6f 63 61 74 65 64 20 62  were allocated b
f590: 79 20 73 71 6c 69 74 65 33 5f 69 6e 69 74 69 61  y sqlite3_initia
f5a0: 6c 69 7a 65 28 29 2e 0a 2a 2a 20 54 68 65 73 65  lize()..** These
f5b0: 20 72 6f 75 74 69 6e 65 73 20 61 72 65 20 64 65   routines are de
f5c0: 73 69 67 6e 65 64 20 74 6f 20 61 69 64 20 69 6e  signed to aid in
f5d0: 20 70 72 6f 63 65 73 73 20 69 6e 69 74 69 61 6c   process initial
f5e0: 69 7a 61 74 69 6f 6e 20 61 6e 64 0a 2a 2a 20 73  ization and.** s
f5f0: 68 75 74 64 6f 77 6e 20 6f 6e 20 65 6d 62 65 64  hutdown on embed
f600: 64 65 64 20 73 79 73 74 65 6d 73 2e 20 20 57 6f  ded systems.  Wo
f610: 72 6b 73 74 61 74 69 6f 6e 20 61 70 70 6c 69 63  rkstation applic
f620: 61 74 69 6f 6e 73 20 75 73 69 6e 67 0a 2a 2a 20  ations using.** 
f630: 53 51 4c 69 74 65 20 6e 6f 72 6d 61 6c 6c 79 20  SQLite normally 
f640: 64 6f 20 6e 6f 74 20 6e 65 65 64 20 74 6f 20 69  do not need to i
f650: 6e 76 6f 6b 65 20 65 69 74 68 65 72 20 6f 66 20  nvoke either of 
f660: 74 68 65 73 65 20 72 6f 75 74 69 6e 65 73 2e 0a  these routines..
f670: 2a 2a 0a 2a 2a 20 41 20 63 61 6c 6c 20 74 6f 20  **.** A call to 
f680: 73 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69  sqlite3_initiali
f690: 7a 65 28 29 20 69 73 20 61 6e 20 22 65 66 66 65  ze() is an "effe
f6a0: 63 74 69 76 65 22 20 63 61 6c 6c 20 69 66 20 69  ctive" call if i
f6b0: 74 20 69 73 0a 2a 2a 20 74 68 65 20 66 69 72 73  t is.** the firs
f6c0: 74 20 74 69 6d 65 20 73 71 6c 69 74 65 33 5f 69  t time sqlite3_i
f6d0: 6e 69 74 69 61 6c 69 7a 65 28 29 20 69 73 20 69  nitialize() is i
f6e0: 6e 76 6f 6b 65 64 20 64 75 72 69 6e 67 20 74 68  nvoked during th
f6f0: 65 20 6c 69 66 65 74 69 6d 65 20 6f 66 0a 2a 2a  e lifetime of.**
f700: 20 74 68 65 20 70 72 6f 63 65 73 73 2c 20 6f 72   the process, or
f710: 20 69 66 20 69 74 20 69 73 20 74 68 65 20 66 69   if it is the fi
f720: 72 73 74 20 74 69 6d 65 20 73 71 6c 69 74 65 33  rst time sqlite3
f730: 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 20 69 73  _initialize() is
f740: 20 69 6e 76 6f 6b 65 64 0a 2a 2a 20 66 6f 6c 6c   invoked.** foll
f750: 6f 77 69 6e 67 20 61 20 63 61 6c 6c 20 74 6f 20  owing a call to 
f760: 73 71 6c 69 74 65 33 5f 73 68 75 74 64 6f 77 6e  sqlite3_shutdown
f770: 28 29 2e 20 20 5e 28 4f 6e 6c 79 20 61 6e 20 65  ().  ^(Only an e
f780: 66 66 65 63 74 69 76 65 20 63 61 6c 6c 0a 2a 2a  ffective call.**
f790: 20 6f 66 20 73 71 6c 69 74 65 33 5f 69 6e 69 74   of sqlite3_init
f7a0: 69 61 6c 69 7a 65 28 29 20 64 6f 65 73 20 61 6e  ialize() does an
f7b0: 79 20 69 6e 69 74 69 61 6c 69 7a 61 74 69 6f 6e  y initialization
f7c0: 2e 20 20 41 6c 6c 20 6f 74 68 65 72 20 63 61 6c  .  All other cal
f7d0: 6c 73 0a 2a 2a 20 61 72 65 20 68 61 72 6d 6c 65  ls.** are harmle
f7e0: 73 73 20 6e 6f 2d 6f 70 73 2e 29 5e 0a 2a 2a 0a  ss no-ops.)^.**.
f7f0: 2a 2a 20 41 20 63 61 6c 6c 20 74 6f 20 73 71 6c  ** A call to sql
f800: 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 20  ite3_shutdown() 
f810: 69 73 20 61 6e 20 22 65 66 66 65 63 74 69 76 65  is an "effective
f820: 22 20 63 61 6c 6c 20 69 66 20 69 74 20 69 73 20  " call if it is 
f830: 74 68 65 20 66 69 72 73 74 0a 2a 2a 20 63 61 6c  the first.** cal
f840: 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f 73 68 75  l to sqlite3_shu
f850: 74 64 6f 77 6e 28 29 20 73 69 6e 63 65 20 74 68  tdown() since th
f860: 65 20 6c 61 73 74 20 73 71 6c 69 74 65 33 5f 69  e last sqlite3_i
f870: 6e 69 74 69 61 6c 69 7a 65 28 29 2e 20 20 5e 28  nitialize().  ^(
f880: 4f 6e 6c 79 0a 2a 2a 20 61 6e 20 65 66 66 65 63  Only.** an effec
f890: 74 69 76 65 20 63 61 6c 6c 20 74 6f 20 73 71 6c  tive call to sql
f8a0: 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 20  ite3_shutdown() 
f8b0: 64 6f 65 73 20 61 6e 79 20 64 65 69 6e 69 74 69  does any deiniti
f8c0: 61 6c 69 7a 61 74 69 6f 6e 2e 0a 2a 2a 20 41 6c  alization..** Al
f8d0: 6c 20 6f 74 68 65 72 20 76 61 6c 69 64 20 63 61  l other valid ca
f8e0: 6c 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 5f 73  lls to sqlite3_s
f8f0: 68 75 74 64 6f 77 6e 28 29 20 61 72 65 20 68 61  hutdown() are ha
f900: 72 6d 6c 65 73 73 20 6e 6f 2d 6f 70 73 2e 29 5e  rmless no-ops.)^
f910: 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74  .**.** The sqlit
f920: 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 20  e3_initialize() 
f930: 69 6e 74 65 72 66 61 63 65 20 69 73 20 74 68 72  interface is thr
f940: 65 61 64 73 61 66 65 2c 20 62 75 74 20 73 71 6c  eadsafe, but sql
f950: 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 0a  ite3_shutdown().
f960: 2a 2a 20 69 73 20 6e 6f 74 2e 20 20 54 68 65 20  ** is not.  The 
f970: 73 71 6c 69 74 65 33 5f 73 68 75 74 64 6f 77 6e  sqlite3_shutdown
f980: 28 29 20 69 6e 74 65 72 66 61 63 65 20 6d 75 73  () interface mus
f990: 74 20 6f 6e 6c 79 20 62 65 20 63 61 6c 6c 65 64  t only be called
f9a0: 20 66 72 6f 6d 20 61 0a 2a 2a 20 73 69 6e 67 6c   from a.** singl
f9b0: 65 20 74 68 72 65 61 64 2e 20 20 41 6c 6c 20 6f  e thread.  All o
f9c0: 70 65 6e 20 5b 64 61 74 61 62 61 73 65 20 63 6f  pen [database co
f9d0: 6e 6e 65 63 74 69 6f 6e 73 5d 20 6d 75 73 74 20  nnections] must 
f9e0: 62 65 20 63 6c 6f 73 65 64 20 61 6e 64 20 61 6c  be closed and al
f9f0: 6c 0a 2a 2a 20 6f 74 68 65 72 20 53 51 4c 69 74  l.** other SQLit
fa00: 65 20 72 65 73 6f 75 72 63 65 73 20 6d 75 73 74  e resources must
fa10: 20 62 65 20 64 65 61 6c 6c 6f 63 61 74 65 64 20   be deallocated 
fa20: 70 72 69 6f 72 20 74 6f 20 69 6e 76 6f 6b 69 6e  prior to invokin
fa30: 67 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 73 68 75  g.** sqlite3_shu
fa40: 74 64 6f 77 6e 28 29 2e 0a 2a 2a 0a 2a 2a 20 41  tdown()..**.** A
fa50: 6d 6f 6e 67 20 6f 74 68 65 72 20 74 68 69 6e 67  mong other thing
fa60: 73 2c 20 5e 73 71 6c 69 74 65 33 5f 69 6e 69 74  s, ^sqlite3_init
fa70: 69 61 6c 69 7a 65 28 29 20 77 69 6c 6c 20 69 6e  ialize() will in
fa80: 76 6f 6b 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  voke.** sqlite3_
fa90: 6f 73 5f 69 6e 69 74 28 29 2e 20 20 53 69 6d 69  os_init().  Simi
faa0: 6c 61 72 6c 79 2c 20 5e 73 71 6c 69 74 65 33 5f  larly, ^sqlite3_
fab0: 73 68 75 74 64 6f 77 6e 28 29 0a 2a 2a 20 77 69  shutdown().** wi
fac0: 6c 6c 20 69 6e 76 6f 6b 65 20 73 71 6c 69 74 65  ll invoke sqlite
fad0: 33 5f 6f 73 5f 65 6e 64 28 29 2e 0a 2a 2a 0a 2a  3_os_end()..**.*
fae0: 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 69  * ^The sqlite3_i
faf0: 6e 69 74 69 61 6c 69 7a 65 28 29 20 72 6f 75 74  nitialize() rout
fb00: 69 6e 65 20 72 65 74 75 72 6e 73 20 5b 53 51 4c  ine returns [SQL
fb10: 49 54 45 5f 4f 4b 5d 20 6f 6e 20 73 75 63 63 65  ITE_OK] on succe
fb20: 73 73 2e 0a 2a 2a 20 5e 49 66 20 66 6f 72 20 73  ss..** ^If for s
fb30: 6f 6d 65 20 72 65 61 73 6f 6e 2c 20 73 71 6c 69  ome reason, sqli
fb40: 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29  te3_initialize()
fb50: 20 69 73 20 75 6e 61 62 6c 65 20 74 6f 20 69 6e   is unable to in
fb60: 69 74 69 61 6c 69 7a 65 0a 2a 2a 20 74 68 65 20  itialize.** the 
fb70: 6c 69 62 72 61 72 79 20 28 70 65 72 68 61 70 73  library (perhaps
fb80: 20 69 74 20 69 73 20 75 6e 61 62 6c 65 20 74 6f   it is unable to
fb90: 20 61 6c 6c 6f 63 61 74 65 20 61 20 6e 65 65 64   allocate a need
fba0: 65 64 20 72 65 73 6f 75 72 63 65 20 73 75 63 68  ed resource such
fbb0: 0a 2a 2a 20 61 73 20 61 20 6d 75 74 65 78 29 20  .** as a mutex) 
fbc0: 69 74 20 72 65 74 75 72 6e 73 20 61 6e 20 5b 65  it returns an [e
fbd0: 72 72 6f 72 20 63 6f 64 65 5d 20 6f 74 68 65 72  rror code] other
fbe0: 20 74 68 61 6e 20 5b 53 51 4c 49 54 45 5f 4f 4b   than [SQLITE_OK
fbf0: 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71  ]..**.** ^The sq
fc00: 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65  lite3_initialize
fc10: 28 29 20 72 6f 75 74 69 6e 65 20 69 73 20 63 61  () routine is ca
fc20: 6c 6c 65 64 20 69 6e 74 65 72 6e 61 6c 6c 79 20  lled internally 
fc30: 62 79 20 6d 61 6e 79 20 6f 74 68 65 72 0a 2a 2a  by many other.**
fc40: 20 53 51 4c 69 74 65 20 69 6e 74 65 72 66 61 63   SQLite interfac
fc50: 65 73 20 73 6f 20 74 68 61 74 20 61 6e 20 61 70  es so that an ap
fc60: 70 6c 69 63 61 74 69 6f 6e 20 75 73 75 61 6c 6c  plication usuall
fc70: 79 20 64 6f 65 73 20 6e 6f 74 20 6e 65 65 64 20  y does not need 
fc80: 74 6f 0a 2a 2a 20 69 6e 76 6f 6b 65 20 73 71 6c  to.** invoke sql
fc90: 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28  ite3_initialize(
fca0: 29 20 64 69 72 65 63 74 6c 79 2e 20 20 46 6f 72  ) directly.  For
fcb0: 20 65 78 61 6d 70 6c 65 2c 20 5b 73 71 6c 69 74   example, [sqlit
fcc0: 65 33 5f 6f 70 65 6e 28 29 5d 0a 2a 2a 20 63 61  e3_open()].** ca
fcd0: 6c 6c 73 20 73 71 6c 69 74 65 33 5f 69 6e 69 74  lls sqlite3_init
fce0: 69 61 6c 69 7a 65 28 29 20 73 6f 20 74 68 65 20  ialize() so the 
fcf0: 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79 20 77  SQLite library w
fd00: 69 6c 6c 20 62 65 20 61 75 74 6f 6d 61 74 69 63  ill be automatic
fd10: 61 6c 6c 79 0a 2a 2a 20 69 6e 69 74 69 61 6c 69  ally.** initiali
fd20: 7a 65 64 20 77 68 65 6e 20 5b 73 71 6c 69 74 65  zed when [sqlite
fd30: 33 5f 6f 70 65 6e 28 29 5d 20 69 73 20 63 61 6c  3_open()] is cal
fd40: 6c 65 64 20 69 66 20 69 74 20 68 61 73 20 6e 6f  led if it has no
fd50: 74 20 62 65 20 69 6e 69 74 69 61 6c 69 7a 65 64  t be initialized
fd60: 0a 2a 2a 20 61 6c 72 65 61 64 79 2e 20 20 5e 48  .** already.  ^H
fd70: 6f 77 65 76 65 72 2c 20 69 66 20 53 51 4c 69 74  owever, if SQLit
fd80: 65 20 69 73 20 63 6f 6d 70 69 6c 65 64 20 77 69  e is compiled wi
fd90: 74 68 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 4f  th the [SQLITE_O
fda0: 4d 49 54 5f 41 55 54 4f 49 4e 49 54 5d 0a 2a 2a  MIT_AUTOINIT].**
fdb0: 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70   compile-time op
fdc0: 74 69 6f 6e 2c 20 74 68 65 6e 20 74 68 65 20 61  tion, then the a
fdd0: 75 74 6f 6d 61 74 69 63 20 63 61 6c 6c 73 20 74  utomatic calls t
fde0: 6f 20 73 71 6c 69 74 65 33 5f 69 6e 69 74 69 61  o sqlite3_initia
fdf0: 6c 69 7a 65 28 29 0a 2a 2a 20 61 72 65 20 6f 6d  lize().** are om
fe00: 69 74 74 65 64 20 61 6e 64 20 74 68 65 20 61 70  itted and the ap
fe10: 70 6c 69 63 61 74 69 6f 6e 20 6d 75 73 74 20 63  plication must c
fe20: 61 6c 6c 20 73 71 6c 69 74 65 33 5f 69 6e 69 74  all sqlite3_init
fe30: 69 61 6c 69 7a 65 28 29 20 64 69 72 65 63 74 6c  ialize() directl
fe40: 79 0a 2a 2a 20 70 72 69 6f 72 20 74 6f 20 75 73  y.** prior to us
fe50: 69 6e 67 20 61 6e 79 20 6f 74 68 65 72 20 53 51  ing any other SQ
fe60: 4c 69 74 65 20 69 6e 74 65 72 66 61 63 65 2e 20  Lite interface. 
fe70: 20 46 6f 72 20 6d 61 78 69 6d 75 6d 20 70 6f 72   For maximum por
fe80: 74 61 62 69 6c 69 74 79 2c 0a 2a 2a 20 69 74 20  tability,.** it 
fe90: 69 73 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 74  is recommended t
fea0: 68 61 74 20 61 70 70 6c 69 63 61 74 69 6f 6e 73  hat applications
feb0: 20 61 6c 77 61 79 73 20 69 6e 76 6f 6b 65 20 73   always invoke s
fec0: 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a  qlite3_initializ
fed0: 65 28 29 0a 2a 2a 20 64 69 72 65 63 74 6c 79 20  e().** directly 
fee0: 70 72 69 6f 72 20 74 6f 20 75 73 69 6e 67 20 61  prior to using a
fef0: 6e 79 20 6f 74 68 65 72 20 53 51 4c 69 74 65 20  ny other SQLite 
ff00: 69 6e 74 65 72 66 61 63 65 2e 20 20 46 75 74 75  interface.  Futu
ff10: 72 65 20 72 65 6c 65 61 73 65 73 0a 2a 2a 20 6f  re releases.** o
ff20: 66 20 53 51 4c 69 74 65 20 6d 61 79 20 72 65 71  f SQLite may req
ff30: 75 69 72 65 20 74 68 69 73 2e 20 20 49 6e 20 6f  uire this.  In o
ff40: 74 68 65 72 20 77 6f 72 64 73 2c 20 74 68 65 20  ther words, the 
ff50: 62 65 68 61 76 69 6f 72 20 65 78 68 69 62 69 74  behavior exhibit
ff60: 65 64 0a 2a 2a 20 77 68 65 6e 20 53 51 4c 69 74  ed.** when SQLit
ff70: 65 20 69 73 20 63 6f 6d 70 69 6c 65 64 20 77 69  e is compiled wi
ff80: 74 68 20 5b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  th [SQLITE_OMIT_
ff90: 41 55 54 4f 49 4e 49 54 5d 20 6d 69 67 68 74 20  AUTOINIT] might 
ffa0: 62 65 63 6f 6d 65 20 74 68 65 0a 2a 2a 20 64 65  become the.** de
ffb0: 66 61 75 6c 74 20 62 65 68 61 76 69 6f 72 20 69  fault behavior i
ffc0: 6e 20 73 6f 6d 65 20 66 75 74 75 72 65 20 72 65  n some future re
ffd0: 6c 65 61 73 65 20 6f 66 20 53 51 4c 69 74 65 2e  lease of SQLite.
ffe0: 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74  .**.** The sqlit
fff0: 65 33 5f 6f 73 5f 69 6e 69 74 28 29 20 72 6f 75  e3_os_init() rou
10000 74 69 6e 65 20 64 6f 65 73 20 6f 70 65 72 61 74  tine does operat
10010 69 6e 67 2d 73 79 73 74 65 6d 20 73 70 65 63 69  ing-system speci
10020 66 69 63 0a 2a 2a 20 69 6e 69 74 69 61 6c 69 7a  fic.** initializ
10030 61 74 69 6f 6e 20 6f 66 20 74 68 65 20 53 51 4c  ation of the SQL
10040 69 74 65 20 6c 69 62 72 61 72 79 2e 20 20 54 68  ite library.  Th
10050 65 20 73 71 6c 69 74 65 33 5f 6f 73 5f 65 6e 64  e sqlite3_os_end
10060 28 29 0a 2a 2a 20 72 6f 75 74 69 6e 65 20 75 6e  ().** routine un
10070 64 6f 65 73 20 74 68 65 20 65 66 66 65 63 74 20  does the effect 
10080 6f 66 20 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e  of sqlite3_os_in
10090 69 74 28 29 2e 20 20 54 79 70 69 63 61 6c 20 74  it().  Typical t
100a0 61 73 6b 73 0a 2a 2a 20 70 65 72 66 6f 72 6d 65  asks.** performe
100b0 64 20 62 79 20 74 68 65 73 65 20 72 6f 75 74 69  d by these routi
100c0 6e 65 73 20 69 6e 63 6c 75 64 65 20 61 6c 6c 6f  nes include allo
100d0 63 61 74 69 6f 6e 20 6f 72 20 64 65 61 6c 6c 6f  cation or deallo
100e0 63 61 74 69 6f 6e 0a 2a 2a 20 6f 66 20 73 74 61  cation.** of sta
100f0 74 69 63 20 72 65 73 6f 75 72 63 65 73 2c 20 69  tic resources, i
10100 6e 69 74 69 61 6c 69 7a 61 74 69 6f 6e 20 6f 66  nitialization of
10110 20 67 6c 6f 62 61 6c 20 76 61 72 69 61 62 6c 65   global variable
10120 73 2c 0a 2a 2a 20 73 65 74 74 69 6e 67 20 75 70  s,.** setting up
10130 20 61 20 64 65 66 61 75 6c 74 20 5b 73 71 6c 69   a default [sqli
10140 74 65 33 5f 76 66 73 5d 20 6d 6f 64 75 6c 65 2c  te3_vfs] module,
10150 20 6f 72 20 73 65 74 74 69 6e 67 20 75 70 0a 2a   or setting up.*
10160 2a 20 61 20 64 65 66 61 75 6c 74 20 63 6f 6e 66  * a default conf
10170 69 67 75 72 61 74 69 6f 6e 20 75 73 69 6e 67 20  iguration using 
10180 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28  [sqlite3_config(
10190 29 5d 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 61 70  )]..**.** The ap
101a0 70 6c 69 63 61 74 69 6f 6e 20 73 68 6f 75 6c 64  plication should
101b0 20 6e 65 76 65 72 20 69 6e 76 6f 6b 65 20 65 69   never invoke ei
101c0 74 68 65 72 20 73 71 6c 69 74 65 33 5f 6f 73 5f  ther sqlite3_os_
101d0 69 6e 69 74 28 29 0a 2a 2a 20 6f 72 20 73 71 6c  init().** or sql
101e0 69 74 65 33 5f 6f 73 5f 65 6e 64 28 29 20 64 69  ite3_os_end() di
101f0 72 65 63 74 6c 79 2e 20 20 54 68 65 20 61 70 70  rectly.  The app
10200 6c 69 63 61 74 69 6f 6e 20 73 68 6f 75 6c 64 20  lication should 
10210 6f 6e 6c 79 20 69 6e 76 6f 6b 65 0a 2a 2a 20 73  only invoke.** s
10220 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a  qlite3_initializ
10230 65 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f  e() and sqlite3_
10240 73 68 75 74 64 6f 77 6e 28 29 2e 20 20 54 68 65  shutdown().  The
10250 20 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e 69 74   sqlite3_os_init
10260 28 29 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20  ().** interface 
10270 69 73 20 63 61 6c 6c 65 64 20 61 75 74 6f 6d 61  is called automa
10280 74 69 63 61 6c 6c 79 20 62 79 20 73 71 6c 69 74  tically by sqlit
10290 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 20  e3_initialize() 
102a0 61 6e 64 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 6f  and.** sqlite3_o
102b0 73 5f 65 6e 64 28 29 20 69 73 20 63 61 6c 6c 65  s_end() is calle
102c0 64 20 62 79 20 73 71 6c 69 74 65 33 5f 73 68 75  d by sqlite3_shu
102d0 74 64 6f 77 6e 28 29 2e 20 20 41 70 70 72 6f 70  tdown().  Approp
102e0 72 69 61 74 65 0a 2a 2a 20 69 6d 70 6c 65 6d 65  riate.** impleme
102f0 6e 74 61 74 69 6f 6e 73 20 66 6f 72 20 73 71 6c  ntations for sql
10300 69 74 65 33 5f 6f 73 5f 69 6e 69 74 28 29 20 61  ite3_os_init() a
10310 6e 64 20 73 71 6c 69 74 65 33 5f 6f 73 5f 65 6e  nd sqlite3_os_en
10320 64 28 29 0a 2a 2a 20 61 72 65 20 62 75 69 6c 74  d().** are built
10330 20 69 6e 74 6f 20 53 51 4c 69 74 65 20 77 68 65   into SQLite whe
10340 6e 20 69 74 20 69 73 20 63 6f 6d 70 69 6c 65 64  n it is compiled
10350 20 66 6f 72 20 55 6e 69 78 2c 20 57 69 6e 64 6f   for Unix, Windo
10360 77 73 2c 20 6f 72 20 4f 53 2f 32 2e 0a 2a 2a 20  ws, or OS/2..** 
10370 57 68 65 6e 20 5b 63 75 73 74 6f 6d 20 62 75 69  When [custom bui
10380 6c 64 73 20 7c 20 62 75 69 6c 74 20 66 6f 72 20  lds | built for 
10390 6f 74 68 65 72 20 70 6c 61 74 66 6f 72 6d 73 5d  other platforms]
103a0 0a 2a 2a 20 28 75 73 69 6e 67 20 74 68 65 20 5b  .** (using the [
103b0 53 51 4c 49 54 45 5f 4f 53 5f 4f 54 48 45 52 3d  SQLITE_OS_OTHER=
103c0 31 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 0a  1] compile-time.
103d0 2a 2a 20 6f 70 74 69 6f 6e 29 20 74 68 65 20 61  ** option) the a
103e0 70 70 6c 69 63 61 74 69 6f 6e 20 6d 75 73 74 20  pplication must 
103f0 73 75 70 70 6c 79 20 61 20 73 75 69 74 61 62 6c  supply a suitabl
10400 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  e implementation
10410 20 66 6f 72 0a 2a 2a 20 73 71 6c 69 74 65 33 5f   for.** sqlite3_
10420 6f 73 5f 69 6e 69 74 28 29 20 61 6e 64 20 73 71  os_init() and sq
10430 6c 69 74 65 33 5f 6f 73 5f 65 6e 64 28 29 2e 20  lite3_os_end(). 
10440 20 41 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d   An application-
10450 73 75 70 70 6c 69 65 64 0a 2a 2a 20 69 6d 70 6c  supplied.** impl
10460 65 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20 73 71  ementation of sq
10470 6c 69 74 65 33 5f 6f 73 5f 69 6e 69 74 28 29 20  lite3_os_init() 
10480 6f 72 20 73 71 6c 69 74 65 33 5f 6f 73 5f 65 6e  or sqlite3_os_en
10490 64 28 29 0a 2a 2a 20 6d 75 73 74 20 72 65 74 75  d().** must retu
104a0 72 6e 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 6f  rn [SQLITE_OK] o
104b0 6e 20 73 75 63 63 65 73 73 20 61 6e 64 20 73 6f  n success and so
104c0 6d 65 20 6f 74 68 65 72 20 5b 65 72 72 6f 72 20  me other [error 
104d0 63 6f 64 65 5d 20 75 70 6f 6e 0a 2a 2a 20 66 61  code] upon.** fa
104e0 69 6c 75 72 65 2e 0a 2a 2f 0a 69 6e 74 20 73 71  ilure..*/.int sq
104f0 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65  lite3_initialize
10500 28 76 6f 69 64 29 3b 0a 69 6e 74 20 73 71 6c 69  (void);.int sqli
10510 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 76 6f 69  te3_shutdown(voi
10520 64 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  d);.int sqlite3_
10530 6f 73 5f 69 6e 69 74 28 76 6f 69 64 29 3b 0a 69  os_init(void);.i
10540 6e 74 20 73 71 6c 69 74 65 33 5f 6f 73 5f 65 6e  nt sqlite3_os_en
10550 64 28 76 6f 69 64 29 3b 0a 0a 2f 2a 0a 2a 2a 20  d(void);../*.** 
10560 43 41 50 49 33 52 45 46 3a 20 43 6f 6e 66 69 67  CAPI3REF: Config
10570 75 72 69 6e 67 20 54 68 65 20 53 51 4c 69 74 65  uring The SQLite
10580 20 4c 69 62 72 61 72 79 0a 2a 2a 0a 2a 2a 20 54   Library.**.** T
10590 68 65 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69  he sqlite3_confi
105a0 67 28 29 20 69 6e 74 65 72 66 61 63 65 20 69 73  g() interface is
105b0 20 75 73 65 64 20 74 6f 20 6d 61 6b 65 20 67 6c   used to make gl
105c0 6f 62 61 6c 20 63 6f 6e 66 69 67 75 72 61 74 69  obal configurati
105d0 6f 6e 0a 2a 2a 20 63 68 61 6e 67 65 73 20 74 6f  on.** changes to
105e0 20 53 51 4c 69 74 65 20 69 6e 20 6f 72 64 65 72   SQLite in order
105f0 20 74 6f 20 74 75 6e 65 20 53 51 4c 69 74 65 20   to tune SQLite 
10600 74 6f 20 74 68 65 20 73 70 65 63 69 66 69 63 20  to the specific 
10610 6e 65 65 64 73 20 6f 66 0a 2a 2a 20 74 68 65 20  needs of.** the 
10620 61 70 70 6c 69 63 61 74 69 6f 6e 2e 20 20 54 68  application.  Th
10630 65 20 64 65 66 61 75 6c 74 20 63 6f 6e 66 69 67  e default config
10640 75 72 61 74 69 6f 6e 20 69 73 20 72 65 63 6f 6d  uration is recom
10650 6d 65 6e 64 65 64 20 66 6f 72 20 6d 6f 73 74 0a  mended for most.
10660 2a 2a 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20  ** applications 
10670 61 6e 64 20 73 6f 20 74 68 69 73 20 72 6f 75 74  and so this rout
10680 69 6e 65 20 69 73 20 75 73 75 61 6c 6c 79 20 6e  ine is usually n
10690 6f 74 20 6e 65 63 65 73 73 61 72 79 2e 20 20 49  ot necessary.  I
106a0 74 20 69 73 0a 2a 2a 20 70 72 6f 76 69 64 65 64  t is.** provided
106b0 20 74 6f 20 73 75 70 70 6f 72 74 20 72 61 72 65   to support rare
106c0 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 77 69   applications wi
106d0 74 68 20 75 6e 75 73 75 61 6c 20 6e 65 65 64 73  th unusual needs
106e0 2e 0a 2a 2a 0a 2a 2a 20 3c 62 3e 54 68 65 20 73  ..**.** <b>The s
106f0 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 20  qlite3_config() 
10700 69 6e 74 65 72 66 61 63 65 20 69 73 20 6e 6f 74  interface is not
10710 20 74 68 72 65 61 64 73 61 66 65 2e 20 54 68 65   threadsafe. The
10720 20 61 70 70 6c 69 63 61 74 69 6f 6e 0a 2a 2a 20   application.** 
10730 6d 75 73 74 20 65 6e 73 75 72 65 20 74 68 61 74  must ensure that
10740 20 6e 6f 20 6f 74 68 65 72 20 53 51 4c 69 74 65   no other SQLite
10750 20 69 6e 74 65 72 66 61 63 65 73 20 61 72 65 20   interfaces are 
10760 69 6e 76 6f 6b 65 64 20 62 79 20 6f 74 68 65 72  invoked by other
10770 0a 2a 2a 20 74 68 72 65 61 64 73 20 77 68 69 6c  .** threads whil
10780 65 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67  e sqlite3_config
10790 28 29 20 69 73 20 72 75 6e 6e 69 6e 67 2e 3c 2f  () is running.</
107a0 62 3e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c  b>.**.** The sql
107b0 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 20 69 6e  ite3_config() in
107c0 74 65 72 66 61 63 65 0a 2a 2a 20 6d 61 79 20 6f  terface.** may o
107d0 6e 6c 79 20 62 65 20 69 6e 76 6f 6b 65 64 20 70  nly be invoked p
107e0 72 69 6f 72 20 74 6f 20 6c 69 62 72 61 72 79 20  rior to library 
107f0 69 6e 69 74 69 61 6c 69 7a 61 74 69 6f 6e 20 75  initialization u
10800 73 69 6e 67 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  sing.** [sqlite3
10810 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 5d 20 6f  _initialize()] o
10820 72 20 61 66 74 65 72 20 73 68 75 74 64 6f 77 6e  r after shutdown
10830 20 62 79 20 5b 73 71 6c 69 74 65 33 5f 73 68 75   by [sqlite3_shu
10840 74 64 6f 77 6e 28 29 5d 2e 0a 2a 2a 20 5e 49 66  tdown()]..** ^If
10850 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28   sqlite3_config(
10860 29 20 69 73 20 63 61 6c 6c 65 64 20 61 66 74 65  ) is called afte
10870 72 20 5b 73 71 6c 69 74 65 33 5f 69 6e 69 74 69  r [sqlite3_initi
10880 61 6c 69 7a 65 28 29 5d 20 61 6e 64 20 62 65 66  alize()] and bef
10890 6f 72 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  ore.** [sqlite3_
108a0 73 68 75 74 64 6f 77 6e 28 29 5d 20 74 68 65 6e  shutdown()] then
108b0 20 69 74 20 77 69 6c 6c 20 72 65 74 75 72 6e 20   it will return 
108c0 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 2e 0a 2a  SQLITE_MISUSE..*
108d0 2a 20 4e 6f 74 65 2c 20 68 6f 77 65 76 65 72 2c  * Note, however,
108e0 20 74 68 61 74 20 5e 73 71 6c 69 74 65 33 5f 63   that ^sqlite3_c
108f0 6f 6e 66 69 67 28 29 20 63 61 6e 20 62 65 20 63  onfig() can be c
10900 61 6c 6c 65 64 20 61 73 20 70 61 72 74 20 6f 66  alled as part of
10910 20 74 68 65 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e   the.** implemen
10920 74 61 74 69 6f 6e 20 6f 66 20 61 6e 20 61 70 70  tation of an app
10930 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64  lication-defined
10940 20 5b 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e 69   [sqlite3_os_ini
10950 74 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  t()]..**.** The 
10960 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74  first argument t
10970 6f 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67  o sqlite3_config
10980 28 29 20 69 73 20 61 6e 20 69 6e 74 65 67 65 72  () is an integer
10990 0a 2a 2a 20 5b 63 6f 6e 66 69 67 75 72 61 74 69  .** [configurati
109a0 6f 6e 20 6f 70 74 69 6f 6e 5d 20 74 68 61 74 20  on option] that 
109b0 64 65 74 65 72 6d 69 6e 65 73 0a 2a 2a 20 77 68  determines.** wh
109c0 61 74 20 70 72 6f 70 65 72 74 79 20 6f 66 20 53  at property of S
109d0 51 4c 69 74 65 20 69 73 20 74 6f 20 62 65 20 63  QLite is to be c
109e0 6f 6e 66 69 67 75 72 65 64 2e 20 20 53 75 62 73  onfigured.  Subs
109f0 65 71 75 65 6e 74 20 61 72 67 75 6d 65 6e 74 73  equent arguments
10a00 0a 2a 2a 20 76 61 72 79 20 64 65 70 65 6e 64 69  .** vary dependi
10a10 6e 67 20 6f 6e 20 74 68 65 20 5b 63 6f 6e 66 69  ng on the [confi
10a20 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 5d  guration option]
10a30 0a 2a 2a 20 69 6e 20 74 68 65 20 66 69 72 73 74  .** in the first
10a40 20 61 72 67 75 6d 65 6e 74 2e 0a 2a 2a 0a 2a 2a   argument..**.**
10a50 20 5e 57 68 65 6e 20 61 20 63 6f 6e 66 69 67 75   ^When a configu
10a60 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 20 69 73  ration option is
10a70 20 73 65 74 2c 20 73 71 6c 69 74 65 33 5f 63 6f   set, sqlite3_co
10a80 6e 66 69 67 28 29 20 72 65 74 75 72 6e 73 20 5b  nfig() returns [
10a90 53 51 4c 49 54 45 5f 4f 4b 5d 2e 0a 2a 2a 20 5e  SQLITE_OK]..** ^
10aa0 49 66 20 74 68 65 20 6f 70 74 69 6f 6e 20 69 73  If the option is
10ab0 20 75 6e 6b 6e 6f 77 6e 20 6f 72 20 53 51 4c 69   unknown or SQLi
10ac0 74 65 20 69 73 20 75 6e 61 62 6c 65 20 74 6f 20  te is unable to 
10ad0 73 65 74 20 74 68 65 20 6f 70 74 69 6f 6e 0a 2a  set the option.*
10ae0 2a 20 74 68 65 6e 20 74 68 69 73 20 72 6f 75 74  * then this rout
10af0 69 6e 65 20 72 65 74 75 72 6e 73 20 61 20 6e 6f  ine returns a no
10b00 6e 2d 7a 65 72 6f 20 5b 65 72 72 6f 72 20 63 6f  n-zero [error co
10b10 64 65 5d 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69  de]..*/.int sqli
10b20 74 65 33 5f 63 6f 6e 66 69 67 28 69 6e 74 2c 20  te3_config(int, 
10b30 2e 2e 2e 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  ...);../*.** CAP
10b40 49 33 52 45 46 3a 20 43 6f 6e 66 69 67 75 72 65  I3REF: Configure
10b50 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63   database connec
10b60 74 69 6f 6e 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a  tions.** METHOD:
10b70 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 54   sqlite3.**.** T
10b80 68 65 20 73 71 6c 69 74 65 33 5f 64 62 5f 63 6f  he sqlite3_db_co
10b90 6e 66 69 67 28 29 20 69 6e 74 65 72 66 61 63 65  nfig() interface
10ba0 20 69 73 20 75 73 65 64 20 74 6f 20 6d 61 6b 65   is used to make
10bb0 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 0a 2a   configuration.*
10bc0 2a 20 63 68 61 6e 67 65 73 20 74 6f 20 61 20 5b  * changes to a [
10bd0 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
10be0 69 6f 6e 5d 2e 20 20 54 68 65 20 69 6e 74 65 72  ion].  The inter
10bf0 66 61 63 65 20 69 73 20 73 69 6d 69 6c 61 72 20  face is similar 
10c00 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63  to.** [sqlite3_c
10c10 6f 6e 66 69 67 28 29 5d 20 65 78 63 65 70 74 20  onfig()] except 
10c20 74 68 61 74 20 74 68 65 20 63 68 61 6e 67 65 73  that the changes
10c30 20 61 70 70 6c 79 20 74 6f 20 61 20 73 69 6e 67   apply to a sing
10c40 6c 65 0a 2a 2a 20 5b 64 61 74 61 62 61 73 65 20  le.** [database 
10c50 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 28 73 70 65  connection] (spe
10c60 63 69 66 69 65 64 20 69 6e 20 74 68 65 20 66 69  cified in the fi
10c70 72 73 74 20 61 72 67 75 6d 65 6e 74 29 2e 0a 2a  rst argument)..*
10c80 2a 0a 2a 2a 20 54 68 65 20 73 65 63 6f 6e 64 20  *.** The second 
10c90 61 72 67 75 6d 65 6e 74 20 74 6f 20 73 71 6c 69  argument to sqli
10ca0 74 65 33 5f 64 62 5f 63 6f 6e 66 69 67 28 44 2c  te3_db_config(D,
10cb0 56 2c 2e 2e 2e 29 20 20 69 73 20 74 68 65 0a 2a  V,...)  is the.*
10cc0 2a 20 5b 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46  * [SQLITE_DBCONF
10cd0 49 47 5f 4c 4f 4f 4b 41 53 49 44 45 20 7c 20 63  IG_LOOKASIDE | c
10ce0 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 76 65 72  onfiguration ver
10cf0 62 5d 20 2d 20 61 6e 20 69 6e 74 65 67 65 72 20  b] - an integer 
10d00 63 6f 64 65 20 0a 2a 2a 20 74 68 61 74 20 69 6e  code .** that in
10d10 64 69 63 61 74 65 73 20 77 68 61 74 20 61 73 70  dicates what asp
10d20 65 63 74 20 6f 66 20 74 68 65 20 5b 64 61 74 61  ect of the [data
10d30 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d  base connection]
10d40 20 69 73 20 62 65 69 6e 67 20 63 6f 6e 66 69 67   is being config
10d50 75 72 65 64 2e 0a 2a 2a 20 53 75 62 73 65 71 75  ured..** Subsequ
10d60 65 6e 74 20 61 72 67 75 6d 65 6e 74 73 20 76 61  ent arguments va
10d70 72 79 20 64 65 70 65 6e 64 69 6e 67 20 6f 6e 20  ry depending on 
10d80 74 68 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f  the configuratio
10d90 6e 20 76 65 72 62 2e 0a 2a 2a 0a 2a 2a 20 5e 43  n verb..**.** ^C
10da0 61 6c 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 5f  alls to sqlite3_
10db0 64 62 5f 63 6f 6e 66 69 67 28 29 20 72 65 74 75  db_config() retu
10dc0 72 6e 20 53 51 4c 49 54 45 5f 4f 4b 20 69 66 20  rn SQLITE_OK if 
10dd0 61 6e 64 20 6f 6e 6c 79 20 69 66 0a 2a 2a 20 74  and only if.** t
10de0 68 65 20 63 61 6c 6c 20 69 73 20 63 6f 6e 73 69  he call is consi
10df0 64 65 72 65 64 20 73 75 63 63 65 73 73 66 75 6c  dered successful
10e00 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  ..*/.int sqlite3
10e10 5f 64 62 5f 63 6f 6e 66 69 67 28 73 71 6c 69 74  _db_config(sqlit
10e20 65 33 2a 2c 20 69 6e 74 20 6f 70 2c 20 2e 2e 2e  e3*, int op, ...
10e30 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
10e40 45 46 3a 20 4d 65 6d 6f 72 79 20 41 6c 6c 6f 63  EF: Memory Alloc
10e50 61 74 69 6f 6e 20 52 6f 75 74 69 6e 65 73 0a 2a  ation Routines.*
10e60 2a 0a 2a 2a 20 41 6e 20 69 6e 73 74 61 6e 63 65  *.** An instance
10e70 20 6f 66 20 74 68 69 73 20 6f 62 6a 65 63 74 20   of this object 
10e80 64 65 66 69 6e 65 73 20 74 68 65 20 69 6e 74 65  defines the inte
10e90 72 66 61 63 65 20 62 65 74 77 65 65 6e 20 53 51  rface between SQ
10ea0 4c 69 74 65 0a 2a 2a 20 61 6e 64 20 6c 6f 77 2d  Lite.** and low-
10eb0 6c 65 76 65 6c 20 6d 65 6d 6f 72 79 20 61 6c 6c  level memory all
10ec0 6f 63 61 74 69 6f 6e 20 72 6f 75 74 69 6e 65 73  ocation routines
10ed0 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 6f 62 6a  ..**.** This obj
10ee0 65 63 74 20 69 73 20 75 73 65 64 20 69 6e 20 6f  ect is used in o
10ef0 6e 6c 79 20 6f 6e 65 20 70 6c 61 63 65 20 69 6e  nly one place in
10f00 20 74 68 65 20 53 51 4c 69 74 65 20 69 6e 74 65   the SQLite inte
10f10 72 66 61 63 65 2e 0a 2a 2a 20 41 20 70 6f 69 6e  rface..** A poin
10f20 74 65 72 20 74 6f 20 61 6e 20 69 6e 73 74 61 6e  ter to an instan
10f30 63 65 20 6f 66 20 74 68 69 73 20 6f 62 6a 65 63  ce of this objec
10f40 74 20 69 73 20 74 68 65 20 61 72 67 75 6d 65 6e  t is the argumen
10f50 74 20 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  t to.** [sqlite3
10f60 5f 63 6f 6e 66 69 67 28 29 5d 20 77 68 65 6e 20  _config()] when 
10f70 74 68 65 20 63 6f 6e 66 69 67 75 72 61 74 69 6f  the configuratio
10f80 6e 20 6f 70 74 69 6f 6e 20 69 73 0a 2a 2a 20 5b  n option is.** [
10f90 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 41  SQLITE_CONFIG_MA
10fa0 4c 4c 4f 43 5d 20 6f 72 20 5b 53 51 4c 49 54 45  LLOC] or [SQLITE
10fb0 5f 43 4f 4e 46 49 47 5f 47 45 54 4d 41 4c 4c 4f  _CONFIG_GETMALLO
10fc0 43 5d 2e 20 20 0a 2a 2a 20 42 79 20 63 72 65 61  C].  .** By crea
10fd0 74 69 6e 67 20 61 6e 20 69 6e 73 74 61 6e 63 65  ting an instance
10fe0 20 6f 66 20 74 68 69 73 20 6f 62 6a 65 63 74 0a   of this object.
10ff0 2a 2a 20 61 6e 64 20 70 61 73 73 69 6e 67 20 69  ** and passing i
11000 74 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 63 6f  t to [sqlite3_co
11010 6e 66 69 67 5d 28 5b 53 51 4c 49 54 45 5f 43 4f  nfig]([SQLITE_CO
11020 4e 46 49 47 5f 4d 41 4c 4c 4f 43 5d 29 0a 2a 2a  NFIG_MALLOC]).**
11030 20 64 75 72 69 6e 67 20 63 6f 6e 66 69 67 75 72   during configur
11040 61 74 69 6f 6e 2c 20 61 6e 20 61 70 70 6c 69 63  ation, an applic
11050 61 74 69 6f 6e 20 63 61 6e 20 73 70 65 63 69 66  ation can specif
11060 79 20 61 6e 20 61 6c 74 65 72 6e 61 74 69 76 65  y an alternative
11070 0a 2a 2a 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  .** memory alloc
11080 61 74 69 6f 6e 20 73 75 62 73 79 73 74 65 6d 20  ation subsystem 
11090 66 6f 72 20 53 51 4c 69 74 65 20 74 6f 20 75 73  for SQLite to us
110a0 65 20 66 6f 72 20 61 6c 6c 20 6f 66 20 69 74 73  e for all of its
110b0 0a 2a 2a 20 64 79 6e 61 6d 69 63 20 6d 65 6d 6f  .** dynamic memo
110c0 72 79 20 6e 65 65 64 73 2e 0a 2a 2a 0a 2a 2a 20  ry needs..**.** 
110d0 4e 6f 74 65 20 74 68 61 74 20 53 51 4c 69 74 65  Note that SQLite
110e0 20 63 6f 6d 65 73 20 77 69 74 68 20 73 65 76 65   comes with seve
110f0 72 61 6c 20 5b 62 75 69 6c 74 2d 69 6e 20 6d 65  ral [built-in me
11100 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 73 5d  mory allocators]
11110 0a 2a 2a 20 74 68 61 74 20 61 72 65 20 70 65 72  .** that are per
11120 66 65 63 74 6c 79 20 61 64 65 71 75 61 74 65 20  fectly adequate 
11130 66 6f 72 20 74 68 65 20 6f 76 65 72 77 68 65 6c  for the overwhel
11140 6d 69 6e 67 20 6d 61 6a 6f 72 69 74 79 20 6f 66  ming majority of
11150 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 0a 2a 2a   applications.**
11160 20 61 6e 64 20 74 68 61 74 20 74 68 69 73 20 6f   and that this o
11170 62 6a 65 63 74 20 69 73 20 6f 6e 6c 79 20 75 73  bject is only us
11180 65 66 75 6c 20 74 6f 20 61 20 74 69 6e 79 20 6d  eful to a tiny m
11190 69 6e 6f 72 69 74 79 20 6f 66 20 61 70 70 6c 69  inority of appli
111a0 63 61 74 69 6f 6e 73 0a 2a 2a 20 77 69 74 68 20  cations.** with 
111b0 73 70 65 63 69 61 6c 69 7a 65 64 20 6d 65 6d 6f  specialized memo
111c0 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 72 65  ry allocation re
111d0 71 75 69 72 65 6d 65 6e 74 73 2e 20 20 54 68 69  quirements.  Thi
111e0 73 20 6f 62 6a 65 63 74 20 69 73 0a 2a 2a 20 61  s object is.** a
111f0 6c 73 6f 20 75 73 65 64 20 64 75 72 69 6e 67 20  lso used during 
11200 74 65 73 74 69 6e 67 20 6f 66 20 53 51 4c 69 74  testing of SQLit
11210 65 20 69 6e 20 6f 72 64 65 72 20 74 6f 20 73 70  e in order to sp
11220 65 63 69 66 79 20 61 6e 20 61 6c 74 65 72 6e 61  ecify an alterna
11230 74 69 76 65 0a 2a 2a 20 6d 65 6d 6f 72 79 20 61  tive.** memory a
11240 6c 6c 6f 63 61 74 6f 72 20 74 68 61 74 20 73 69  llocator that si
11250 6d 75 6c 61 74 65 73 20 6d 65 6d 6f 72 79 20 6f  mulates memory o
11260 75 74 2d 6f 66 2d 6d 65 6d 6f 72 79 20 63 6f 6e  ut-of-memory con
11270 64 69 74 69 6f 6e 73 20 69 6e 0a 2a 2a 20 6f 72  ditions in.** or
11280 64 65 72 20 74 6f 20 76 65 72 69 66 79 20 74 68  der to verify th
11290 61 74 20 53 51 4c 69 74 65 20 72 65 63 6f 76 65  at SQLite recove
112a0 72 73 20 67 72 61 63 65 66 75 6c 6c 79 20 66 72  rs gracefully fr
112b0 6f 6d 20 73 75 63 68 0a 2a 2a 20 63 6f 6e 64 69  om such.** condi
112c0 74 69 6f 6e 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  tions..**.** The
112d0 20 78 4d 61 6c 6c 6f 63 2c 20 78 52 65 61 6c 6c   xMalloc, xReall
112e0 6f 63 2c 20 61 6e 64 20 78 46 72 65 65 20 6d 65  oc, and xFree me
112f0 74 68 6f 64 73 20 6d 75 73 74 20 77 6f 72 6b 20  thods must work 
11300 6c 69 6b 65 20 74 68 65 0a 2a 2a 20 6d 61 6c 6c  like the.** mall
11310 6f 63 28 29 2c 20 72 65 61 6c 6c 6f 63 28 29 20  oc(), realloc() 
11320 61 6e 64 20 66 72 65 65 28 29 20 66 75 6e 63 74  and free() funct
11330 69 6f 6e 73 20 66 72 6f 6d 20 74 68 65 20 73 74  ions from the st
11340 61 6e 64 61 72 64 20 43 20 6c 69 62 72 61 72 79  andard C library
11350 2e 0a 2a 2a 20 5e 53 51 4c 69 74 65 20 67 75 61  ..** ^SQLite gua
11360 72 61 6e 74 65 65 73 20 74 68 61 74 20 74 68 65  rantees that the
11370 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74   second argument
11380 20 74 6f 0a 2a 2a 20 78 52 65 61 6c 6c 6f 63 20   to.** xRealloc 
11390 69 73 20 61 6c 77 61 79 73 20 61 20 76 61 6c 75  is always a valu
113a0 65 20 72 65 74 75 72 6e 65 64 20 62 79 20 61 20  e returned by a 
113b0 70 72 69 6f 72 20 63 61 6c 6c 20 74 6f 20 78 52  prior call to xR
113c0 6f 75 6e 64 75 70 2e 0a 2a 2a 0a 2a 2a 20 78 53  oundup..**.** xS
113d0 69 7a 65 20 73 68 6f 75 6c 64 20 72 65 74 75 72  ize should retur
113e0 6e 20 74 68 65 20 61 6c 6c 6f 63 61 74 65 64 20  n the allocated 
113f0 73 69 7a 65 20 6f 66 20 61 20 6d 65 6d 6f 72 79  size of a memory
11400 20 61 6c 6c 6f 63 61 74 69 6f 6e 0a 2a 2a 20 70   allocation.** p
11410 72 65 76 69 6f 75 73 6c 79 20 6f 62 74 61 69 6e  reviously obtain
11420 65 64 20 66 72 6f 6d 20 78 4d 61 6c 6c 6f 63 20  ed from xMalloc 
11430 6f 72 20 78 52 65 61 6c 6c 6f 63 2e 20 20 54 68  or xRealloc.  Th
11440 65 20 61 6c 6c 6f 63 61 74 65 64 20 73 69 7a 65  e allocated size
11450 0a 2a 2a 20 69 73 20 61 6c 77 61 79 73 20 61 74  .** is always at
11460 20 6c 65 61 73 74 20 61 73 20 62 69 67 20 61 73   least as big as
11470 20 74 68 65 20 72 65 71 75 65 73 74 65 64 20 73   the requested s
11480 69 7a 65 20 62 75 74 20 6d 61 79 20 62 65 20 6c  ize but may be l
11490 61 72 67 65 72 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  arger..**.** The
114a0 20 78 52 6f 75 6e 64 75 70 20 6d 65 74 68 6f 64   xRoundup method
114b0 20 72 65 74 75 72 6e 73 20 77 68 61 74 20 77 6f   returns what wo
114c0 75 6c 64 20 62 65 20 74 68 65 20 61 6c 6c 6f 63  uld be the alloc
114d0 61 74 65 64 20 73 69 7a 65 20 6f 66 0a 2a 2a 20  ated size of.** 
114e0 61 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  a memory allocat
114f0 69 6f 6e 20 67 69 76 65 6e 20 61 20 70 61 72 74  ion given a part
11500 69 63 75 6c 61 72 20 72 65 71 75 65 73 74 65 64  icular requested
11510 20 73 69 7a 65 2e 20 20 4d 6f 73 74 20 6d 65 6d   size.  Most mem
11520 6f 72 79 0a 2a 2a 20 61 6c 6c 6f 63 61 74 6f 72  ory.** allocator
11530 73 20 72 6f 75 6e 64 20 75 70 20 6d 65 6d 6f 72  s round up memor
11540 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 73 20 61 74  y allocations at
11550 20 6c 65 61 73 74 20 74 6f 20 74 68 65 20 6e 65   least to the ne
11560 78 74 20 6d 75 6c 74 69 70 6c 65 0a 2a 2a 20 6f  xt multiple.** o
11570 66 20 38 2e 20 20 53 6f 6d 65 20 61 6c 6c 6f 63  f 8.  Some alloc
11580 61 74 6f 72 73 20 72 6f 75 6e 64 20 75 70 20 74  ators round up t
11590 6f 20 61 20 6c 61 72 67 65 72 20 6d 75 6c 74 69  o a larger multi
115a0 70 6c 65 20 6f 72 20 74 6f 20 61 20 70 6f 77 65  ple or to a powe
115b0 72 20 6f 66 20 32 2e 0a 2a 2a 20 45 76 65 72 79  r of 2..** Every
115c0 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69   memory allocati
115d0 6f 6e 20 72 65 71 75 65 73 74 20 63 6f 6d 69 6e  on request comin
115e0 67 20 69 6e 20 74 68 72 6f 75 67 68 20 5b 73 71  g in through [sq
115f0 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 0a  lite3_malloc()].
11600 2a 2a 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f 72  ** or [sqlite3_r
11610 65 61 6c 6c 6f 63 28 29 5d 20 66 69 72 73 74 20  ealloc()] first 
11620 63 61 6c 6c 73 20 78 52 6f 75 6e 64 75 70 2e 20  calls xRoundup. 
11630 20 49 66 20 78 52 6f 75 6e 64 75 70 20 72 65 74   If xRoundup ret
11640 75 72 6e 73 20 30 2c 20 0a 2a 2a 20 74 68 61 74  urns 0, .** that
11650 20 63 61 75 73 65 73 20 74 68 65 20 63 6f 72 72   causes the corr
11660 65 73 70 6f 6e 64 69 6e 67 20 6d 65 6d 6f 72 79  esponding memory
11670 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 74 6f 20 66   allocation to f
11680 61 69 6c 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 78  ail..**.** The x
11690 49 6e 69 74 20 6d 65 74 68 6f 64 20 69 6e 69 74  Init method init
116a0 69 61 6c 69 7a 65 73 20 74 68 65 20 6d 65 6d 6f  ializes the memo
116b0 72 79 20 61 6c 6c 6f 63 61 74 6f 72 2e 20 20 46  ry allocator.  F
116c0 6f 72 20 65 78 61 6d 70 6c 65 2c 0a 2a 2a 20 69  or example,.** i
116d0 74 20 6d 69 67 68 74 20 61 6c 6c 6f 63 61 74 65  t might allocate
116e0 20 61 6e 79 20 72 65 71 75 69 72 65 20 6d 75 74   any require mut
116f0 65 78 65 73 20 6f 72 20 69 6e 69 74 69 61 6c 69  exes or initiali
11700 7a 65 20 69 6e 74 65 72 6e 61 6c 20 64 61 74 61  ze internal data
11710 0a 2a 2a 20 73 74 72 75 63 74 75 72 65 73 2e 20  .** structures. 
11720 20 54 68 65 20 78 53 68 75 74 64 6f 77 6e 20 6d   The xShutdown m
11730 65 74 68 6f 64 20 69 73 20 69 6e 76 6f 6b 65 64  ethod is invoked
11740 20 28 69 6e 64 69 72 65 63 74 6c 79 29 20 62 79   (indirectly) by
11750 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 73 68 75  .** [sqlite3_shu
11760 74 64 6f 77 6e 28 29 5d 20 61 6e 64 20 73 68 6f  tdown()] and sho
11770 75 6c 64 20 64 65 61 6c 6c 6f 63 61 74 65 20 61  uld deallocate a
11780 6e 79 20 72 65 73 6f 75 72 63 65 73 20 61 63 71  ny resources acq
11790 75 69 72 65 64 0a 2a 2a 20 62 79 20 78 49 6e 69  uired.** by xIni
117a0 74 2e 20 20 54 68 65 20 70 41 70 70 44 61 74 61  t.  The pAppData
117b0 20 70 6f 69 6e 74 65 72 20 69 73 20 75 73 65 64   pointer is used
117c0 20 61 73 20 74 68 65 20 6f 6e 6c 79 20 70 61 72   as the only par
117d0 61 6d 65 74 65 72 20 74 6f 0a 2a 2a 20 78 49 6e  ameter to.** xIn
117e0 69 74 20 61 6e 64 20 78 53 68 75 74 64 6f 77 6e  it and xShutdown
117f0 2e 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74 65 20 68  ..**.** SQLite h
11800 6f 6c 64 73 20 74 68 65 20 5b 53 51 4c 49 54 45  olds the [SQLITE
11810 5f 4d 55 54 45 58 5f 53 54 41 54 49 43 5f 4d 41  _MUTEX_STATIC_MA
11820 53 54 45 52 5d 20 6d 75 74 65 78 20 77 68 65 6e  STER] mutex when
11830 20 69 74 20 69 6e 76 6f 6b 65 73 0a 2a 2a 20 74   it invokes.** t
11840 68 65 20 78 49 6e 69 74 20 6d 65 74 68 6f 64 2c  he xInit method,
11850 20 73 6f 20 74 68 65 20 78 49 6e 69 74 20 6d 65   so the xInit me
11860 74 68 6f 64 20 6e 65 65 64 20 6e 6f 74 20 62 65  thod need not be
11870 20 74 68 72 65 61 64 73 61 66 65 2e 20 20 54 68   threadsafe.  Th
11880 65 0a 2a 2a 20 78 53 68 75 74 64 6f 77 6e 20 6d  e.** xShutdown m
11890 65 74 68 6f 64 20 69 73 20 6f 6e 6c 79 20 63 61  ethod is only ca
118a0 6c 6c 65 64 20 66 72 6f 6d 20 5b 73 71 6c 69 74  lled from [sqlit
118b0 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 5d 20 73  e3_shutdown()] s
118c0 6f 20 69 74 20 64 6f 65 73 0a 2a 2a 20 6e 6f 74  o it does.** not
118d0 20 6e 65 65 64 20 74 6f 20 62 65 20 74 68 72 65   need to be thre
118e0 61 64 73 61 66 65 20 65 69 74 68 65 72 2e 20 20  adsafe either.  
118f0 46 6f 72 20 61 6c 6c 20 6f 74 68 65 72 20 6d 65  For all other me
11900 74 68 6f 64 73 2c 20 53 51 4c 69 74 65 0a 2a 2a  thods, SQLite.**
11910 20 68 6f 6c 64 73 20 74 68 65 20 5b 53 51 4c 49   holds the [SQLI
11920 54 45 5f 4d 55 54 45 58 5f 53 54 41 54 49 43 5f  TE_MUTEX_STATIC_
11930 4d 45 4d 5d 20 6d 75 74 65 78 20 61 73 20 6c 6f  MEM] mutex as lo
11940 6e 67 20 61 73 20 74 68 65 0a 2a 2a 20 5b 53 51  ng as the.** [SQ
11950 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 45 4d 53  LITE_CONFIG_MEMS
11960 54 41 54 55 53 5d 20 63 6f 6e 66 69 67 75 72 61  TATUS] configura
11970 74 69 6f 6e 20 6f 70 74 69 6f 6e 20 69 73 20 74  tion option is t
11980 75 72 6e 65 64 20 6f 6e 20 28 77 68 69 63 68 0a  urned on (which.
11990 2a 2a 20 69 74 20 69 73 20 62 79 20 64 65 66 61  ** it is by defa
119a0 75 6c 74 29 20 61 6e 64 20 73 6f 20 74 68 65 20  ult) and so the 
119b0 6d 65 74 68 6f 64 73 20 61 72 65 20 61 75 74 6f  methods are auto
119c0 6d 61 74 69 63 61 6c 6c 79 20 73 65 72 69 61 6c  matically serial
119d0 69 7a 65 64 2e 0a 2a 2a 20 48 6f 77 65 76 65 72  ized..** However
119e0 2c 20 69 66 20 5b 53 51 4c 49 54 45 5f 43 4f 4e  , if [SQLITE_CON
119f0 46 49 47 5f 4d 45 4d 53 54 41 54 55 53 5d 20 69  FIG_MEMSTATUS] i
11a00 73 20 64 69 73 61 62 6c 65 64 2c 20 74 68 65 6e  s disabled, then
11a10 20 74 68 65 20 6f 74 68 65 72 0a 2a 2a 20 6d 65   the other.** me
11a20 74 68 6f 64 73 20 6d 75 73 74 20 62 65 20 74 68  thods must be th
11a30 72 65 61 64 73 61 66 65 20 6f 72 20 65 6c 73 65  readsafe or else
11a40 20 6d 61 6b 65 20 74 68 65 69 72 20 6f 77 6e 20   make their own 
11a50 61 72 72 61 6e 67 65 6d 65 6e 74 73 20 66 6f 72  arrangements for
11a60 0a 2a 2a 20 73 65 72 69 61 6c 69 7a 61 74 69 6f  .** serializatio
11a70 6e 2e 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74 65 20  n..**.** SQLite 
11a80 77 69 6c 6c 20 6e 65 76 65 72 20 69 6e 76 6f 6b  will never invok
11a90 65 20 78 49 6e 69 74 28 29 20 6d 6f 72 65 20 74  e xInit() more t
11aa0 68 61 6e 20 6f 6e 63 65 20 77 69 74 68 6f 75 74  han once without
11ab0 20 61 6e 20 69 6e 74 65 72 76 65 6e 69 6e 67 0a   an intervening.
11ac0 2a 2a 20 63 61 6c 6c 20 74 6f 20 78 53 68 75 74  ** call to xShut
11ad0 64 6f 77 6e 28 29 2e 0a 2a 2f 0a 74 79 70 65 64  down()..*/.typed
11ae0 65 66 20 73 74 72 75 63 74 20 73 71 6c 69 74 65  ef struct sqlite
11af0 33 5f 6d 65 6d 5f 6d 65 74 68 6f 64 73 20 73 71  3_mem_methods sq
11b00 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65 74 68 6f 64  lite3_mem_method
11b10 73 3b 0a 73 74 72 75 63 74 20 73 71 6c 69 74 65  s;.struct sqlite
11b20 33 5f 6d 65 6d 5f 6d 65 74 68 6f 64 73 20 7b 0a  3_mem_methods {.
11b30 20 20 76 6f 69 64 20 2a 28 2a 78 4d 61 6c 6c 6f    void *(*xMallo
11b40 63 29 28 69 6e 74 29 3b 20 20 20 20 20 20 20 20  c)(int);        
11b50 20 2f 2a 20 4d 65 6d 6f 72 79 20 61 6c 6c 6f 63   /* Memory alloc
11b60 61 74 69 6f 6e 20 66 75 6e 63 74 69 6f 6e 20 2a  ation function *
11b70 2f 0a 20 20 76 6f 69 64 20 28 2a 78 46 72 65 65  /.  void (*xFree
11b80 29 28 76 6f 69 64 2a 29 3b 20 20 20 20 20 20 20  )(void*);       
11b90 20 20 20 2f 2a 20 46 72 65 65 20 61 20 70 72 69     /* Free a pri
11ba0 6f 72 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 2a 2f  or allocation */
11bb0 0a 20 20 76 6f 69 64 20 2a 28 2a 78 52 65 61 6c  .  void *(*xReal
11bc0 6c 6f 63 29 28 76 6f 69 64 2a 2c 69 6e 74 29 3b  loc)(void*,int);
11bd0 20 20 2f 2a 20 52 65 73 69 7a 65 20 61 6e 20 61    /* Resize an a
11be0 6c 6c 6f 63 61 74 69 6f 6e 20 2a 2f 0a 20 20 69  llocation */.  i
11bf0 6e 74 20 28 2a 78 53 69 7a 65 29 28 76 6f 69 64  nt (*xSize)(void
11c00 2a 29 3b 20 20 20 20 20 20 20 20 20 20 20 2f 2a  *);           /*
11c10 20 52 65 74 75 72 6e 20 74 68 65 20 73 69 7a 65   Return the size
11c20 20 6f 66 20 61 6e 20 61 6c 6c 6f 63 61 74 69 6f   of an allocatio
11c30 6e 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 52 6f  n */.  int (*xRo
11c40 75 6e 64 75 70 29 28 69 6e 74 29 3b 20 20 20 20  undup)(int);    
11c50 20 20 20 20 20 20 2f 2a 20 52 6f 75 6e 64 20 75        /* Round u
11c60 70 20 72 65 71 75 65 73 74 20 73 69 7a 65 20 74  p request size t
11c70 6f 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 73 69 7a  o allocation siz
11c80 65 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 49 6e  e */.  int (*xIn
11c90 69 74 29 28 76 6f 69 64 2a 29 3b 20 20 20 20 20  it)(void*);     
11ca0 20 20 20 20 20 20 2f 2a 20 49 6e 69 74 69 61 6c        /* Initial
11cb0 69 7a 65 20 74 68 65 20 6d 65 6d 6f 72 79 20 61  ize the memory a
11cc0 6c 6c 6f 63 61 74 6f 72 20 2a 2f 0a 20 20 76 6f  llocator */.  vo
11cd0 69 64 20 28 2a 78 53 68 75 74 64 6f 77 6e 29 28  id (*xShutdown)(
11ce0 76 6f 69 64 2a 29 3b 20 20 20 20 20 20 2f 2a 20  void*);      /* 
11cf0 44 65 69 6e 69 74 69 61 6c 69 7a 65 20 74 68 65  Deinitialize the
11d00 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f   memory allocato
11d10 72 20 2a 2f 0a 20 20 76 6f 69 64 20 2a 70 41 70  r */.  void *pAp
11d20 70 44 61 74 61 3b 20 20 20 20 20 20 20 20 20 20  pData;          
11d30 20 20 20 20 20 20 2f 2a 20 41 72 67 75 6d 65 6e        /* Argumen
11d40 74 20 74 6f 20 78 49 6e 69 74 28 29 20 61 6e 64  t to xInit() and
11d50 20 78 53 68 75 74 64 6f 77 6e 28 29 20 2a 2f 0a   xShutdown() */.
11d60 7d 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  };../*.** CAPI3R
11d70 45 46 3a 20 43 6f 6e 66 69 67 75 72 61 74 69 6f  EF: Configuratio
11d80 6e 20 4f 70 74 69 6f 6e 73 0a 2a 2a 20 4b 45 59  n Options.** KEY
11d90 57 4f 52 44 53 3a 20 7b 63 6f 6e 66 69 67 75 72  WORDS: {configur
11da0 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 7d 0a 2a 2a  ation option}.**
11db0 0a 2a 2a 20 54 68 65 73 65 20 63 6f 6e 73 74 61  .** These consta
11dc0 6e 74 73 20 61 72 65 20 74 68 65 20 61 76 61 69  nts are the avai
11dd0 6c 61 62 6c 65 20 69 6e 74 65 67 65 72 20 63 6f  lable integer co
11de0 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69  nfiguration opti
11df0 6f 6e 73 20 74 68 61 74 0a 2a 2a 20 63 61 6e 20  ons that.** can 
11e00 62 65 20 70 61 73 73 65 64 20 61 73 20 74 68 65  be passed as the
11e10 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20   first argument 
11e20 74 6f 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  to the [sqlite3_
11e30 63 6f 6e 66 69 67 28 29 5d 20 69 6e 74 65 72 66  config()] interf
11e40 61 63 65 2e 0a 2a 2a 0a 2a 2a 20 4e 65 77 20 63  ace..**.** New c
11e50 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74  onfiguration opt
11e60 69 6f 6e 73 20 6d 61 79 20 62 65 20 61 64 64 65  ions may be adde
11e70 64 20 69 6e 20 66 75 74 75 72 65 20 72 65 6c 65  d in future rele
11e80 61 73 65 73 20 6f 66 20 53 51 4c 69 74 65 2e 0a  ases of SQLite..
11e90 2a 2a 20 45 78 69 73 74 69 6e 67 20 63 6f 6e 66  ** Existing conf
11ea0 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e  iguration option
11eb0 73 20 6d 69 67 68 74 20 62 65 20 64 69 73 63 6f  s might be disco
11ec0 6e 74 69 6e 75 65 64 2e 20 20 41 70 70 6c 69 63  ntinued.  Applic
11ed0 61 74 69 6f 6e 73 0a 2a 2a 20 73 68 6f 75 6c 64  ations.** should
11ee0 20 63 68 65 63 6b 20 74 68 65 20 72 65 74 75 72   check the retur
11ef0 6e 20 63 6f 64 65 20 66 72 6f 6d 20 5b 73 71 6c  n code from [sql
11f00 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d 20 74  ite3_config()] t
11f10 6f 20 6d 61 6b 65 20 73 75 72 65 20 74 68 61 74  o make sure that
11f20 0a 2a 2a 20 74 68 65 20 63 61 6c 6c 20 77 6f 72  .** the call wor
11f30 6b 65 64 2e 20 20 54 68 65 20 5b 73 71 6c 69 74  ked.  The [sqlit
11f40 65 33 5f 63 6f 6e 66 69 67 28 29 5d 20 69 6e 74  e3_config()] int
11f50 65 72 66 61 63 65 20 77 69 6c 6c 20 72 65 74 75  erface will retu
11f60 72 6e 20 61 0a 2a 2a 20 6e 6f 6e 2d 7a 65 72 6f  rn a.** non-zero
11f70 20 5b 65 72 72 6f 72 20 63 6f 64 65 5d 20 69 66   [error code] if
11f80 20 61 20 64 69 73 63 6f 6e 74 69 6e 75 65 64 20   a discontinued 
11f90 6f 72 20 75 6e 73 75 70 70 6f 72 74 65 64 20 63  or unsupported c
11fa0 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74  onfiguration opt
11fb0 69 6f 6e 0a 2a 2a 20 69 73 20 69 6e 76 6f 6b 65  ion.** is invoke
11fc0 64 2e 0a 2a 2a 0a 2a 2a 20 3c 64 6c 3e 0a 2a 2a  d..**.** <dl>.**
11fd0 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
11fe0 5f 53 49 4e 47 4c 45 54 48 52 45 41 44 5d 5d 20  _SINGLETHREAD]] 
11ff0 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49  <dt>SQLITE_CONFI
12000 47 5f 53 49 4e 47 4c 45 54 48 52 45 41 44 3c 2f  G_SINGLETHREAD</
12010 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 72 65  dt>.** <dd>There
12020 20 61 72 65 20 6e 6f 20 61 72 67 75 6d 65 6e 74   are no argument
12030 73 20 74 6f 20 74 68 69 73 20 6f 70 74 69 6f 6e  s to this option
12040 2e 20 20 5e 54 68 69 73 20 6f 70 74 69 6f 6e 20  .  ^This option 
12050 73 65 74 73 20 74 68 65 0a 2a 2a 20 5b 74 68 72  sets the.** [thr
12060 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 74 6f 20  eading mode] to 
12070 53 69 6e 67 6c 65 2d 74 68 72 65 61 64 2e 20 20  Single-thread.  
12080 49 6e 20 6f 74 68 65 72 20 77 6f 72 64 73 2c 20  In other words, 
12090 69 74 20 64 69 73 61 62 6c 65 73 0a 2a 2a 20 61  it disables.** a
120a0 6c 6c 20 6d 75 74 65 78 69 6e 67 20 61 6e 64 20  ll mutexing and 
120b0 70 75 74 73 20 53 51 4c 69 74 65 20 69 6e 74 6f  puts SQLite into
120c0 20 61 20 6d 6f 64 65 20 77 68 65 72 65 20 69 74   a mode where it
120d0 20 63 61 6e 20 6f 6e 6c 79 20 62 65 20 75 73 65   can only be use
120e0 64 0a 2a 2a 20 62 79 20 61 20 73 69 6e 67 6c 65  d.** by a single
120f0 20 74 68 72 65 61 64 2e 20 20 20 5e 49 66 20 53   thread.   ^If S
12100 51 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c 65  QLite is compile
12110 64 20 77 69 74 68 0a 2a 2a 20 74 68 65 20 5b 53  d with.** the [S
12120 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45  QLITE_THREADSAFE
12130 20 7c 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44   | SQLITE_THREAD
12140 53 41 46 45 3d 30 5d 20 63 6f 6d 70 69 6c 65 2d  SAFE=0] compile-
12150 74 69 6d 65 20 6f 70 74 69 6f 6e 20 74 68 65 6e  time option then
12160 0a 2a 2a 20 69 74 20 69 73 20 6e 6f 74 20 70 6f  .** it is not po
12170 73 73 69 62 6c 65 20 74 6f 20 63 68 61 6e 67 65  ssible to change
12180 20 74 68 65 20 5b 74 68 72 65 61 64 69 6e 67 20   the [threading 
12190 6d 6f 64 65 5d 20 66 72 6f 6d 20 69 74 73 20 64  mode] from its d
121a0 65 66 61 75 6c 74 0a 2a 2a 20 76 61 6c 75 65 20  efault.** value 
121b0 6f 66 20 53 69 6e 67 6c 65 2d 74 68 72 65 61 64  of Single-thread
121c0 20 61 6e 64 20 73 6f 20 5b 73 71 6c 69 74 65 33   and so [sqlite3
121d0 5f 63 6f 6e 66 69 67 28 29 5d 20 77 69 6c 6c 20  _config()] will 
121e0 72 65 74 75 72 6e 20 0a 2a 2a 20 5b 53 51 4c 49  return .** [SQLI
121f0 54 45 5f 45 52 52 4f 52 5d 20 69 66 20 63 61 6c  TE_ERROR] if cal
12200 6c 65 64 20 77 69 74 68 20 74 68 65 20 53 51 4c  led with the SQL
12210 49 54 45 5f 43 4f 4e 46 49 47 5f 53 49 4e 47 4c  ITE_CONFIG_SINGL
12220 45 54 48 52 45 41 44 0a 2a 2a 20 63 6f 6e 66 69  ETHREAD.** confi
12230 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 2e  guration option.
12240 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51  </dd>.**.** [[SQ
12250 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 55 4c 54  LITE_CONFIG_MULT
12260 49 54 48 52 45 41 44 5d 5d 20 3c 64 74 3e 53 51  ITHREAD]] <dt>SQ
12270 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 55 4c 54  LITE_CONFIG_MULT
12280 49 54 48 52 45 41 44 3c 2f 64 74 3e 0a 2a 2a 20  ITHREAD</dt>.** 
12290 3c 64 64 3e 54 68 65 72 65 20 61 72 65 20 6e 6f  <dd>There are no
122a0 20 61 72 67 75 6d 65 6e 74 73 20 74 6f 20 74 68   arguments to th
122b0 69 73 20 6f 70 74 69 6f 6e 2e 20 20 5e 54 68 69  is option.  ^Thi
122c0 73 20 6f 70 74 69 6f 6e 20 73 65 74 73 20 74 68  s option sets th
122d0 65 0a 2a 2a 20 5b 74 68 72 65 61 64 69 6e 67 20  e.** [threading 
122e0 6d 6f 64 65 5d 20 74 6f 20 4d 75 6c 74 69 2d 74  mode] to Multi-t
122f0 68 72 65 61 64 2e 20 20 49 6e 20 6f 74 68 65 72  hread.  In other
12300 20 77 6f 72 64 73 2c 20 69 74 20 64 69 73 61 62   words, it disab
12310 6c 65 73 0a 2a 2a 20 6d 75 74 65 78 69 6e 67 20  les.** mutexing 
12320 6f 6e 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e  on [database con
12330 6e 65 63 74 69 6f 6e 5d 20 61 6e 64 20 5b 70 72  nection] and [pr
12340 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
12350 5d 20 6f 62 6a 65 63 74 73 2e 0a 2a 2a 20 54 68  ] objects..** Th
12360 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 69 73  e application is
12370 20 72 65 73 70 6f 6e 73 69 62 6c 65 20 66 6f 72   responsible for
12380 20 73 65 72 69 61 6c 69 7a 69 6e 67 20 61 63 63   serializing acc
12390 65 73 73 20 74 6f 0a 2a 2a 20 5b 64 61 74 61 62  ess to.** [datab
123a0 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 5d  ase connections]
123b0 20 61 6e 64 20 5b 70 72 65 70 61 72 65 64 20 73   and [prepared s
123c0 74 61 74 65 6d 65 6e 74 73 5d 2e 20 20 42 75 74  tatements].  But
123d0 20 6f 74 68 65 72 20 6d 75 74 65 78 65 73 0a 2a   other mutexes.*
123e0 2a 20 61 72 65 20 65 6e 61 62 6c 65 64 20 73 6f  * are enabled so
123f0 20 74 68 61 74 20 53 51 4c 69 74 65 20 77 69 6c   that SQLite wil
12400 6c 20 62 65 20 73 61 66 65 20 74 6f 20 75 73 65  l be safe to use
12410 20 69 6e 20 61 20 6d 75 6c 74 69 2d 74 68 72 65   in a multi-thre
12420 61 64 65 64 0a 2a 2a 20 65 6e 76 69 72 6f 6e 6d  aded.** environm
12430 65 6e 74 20 61 73 20 6c 6f 6e 67 20 61 73 20 6e  ent as long as n
12440 6f 20 74 77 6f 20 74 68 72 65 61 64 73 20 61 74  o two threads at
12450 74 65 6d 70 74 20 74 6f 20 75 73 65 20 74 68 65  tempt to use the
12460 20 73 61 6d 65 0a 2a 2a 20 5b 64 61 74 61 62 61   same.** [databa
12470 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 61  se connection] a
12480 74 20 74 68 65 20 73 61 6d 65 20 74 69 6d 65 2e  t the same time.
12490 20 20 5e 49 66 20 53 51 4c 69 74 65 20 69 73 20    ^If SQLite is 
124a0 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 0a 2a 2a  compiled with.**
124b0 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 54 48 52   the [SQLITE_THR
124c0 45 41 44 53 41 46 45 20 7c 20 53 51 4c 49 54 45  EADSAFE | SQLITE
124d0 5f 54 48 52 45 41 44 53 41 46 45 3d 30 5d 20 63  _THREADSAFE=0] c
124e0 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69  ompile-time opti
124f0 6f 6e 20 74 68 65 6e 0a 2a 2a 20 69 74 20 69 73  on then.** it is
12500 20 6e 6f 74 20 70 6f 73 73 69 62 6c 65 20 74 6f   not possible to
12510 20 73 65 74 20 74 68 65 20 4d 75 6c 74 69 2d 74   set the Multi-t
12520 68 72 65 61 64 20 5b 74 68 72 65 61 64 69 6e 67  hread [threading
12530 20 6d 6f 64 65 5d 20 61 6e 64 0a 2a 2a 20 5b 73   mode] and.** [s
12540 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d  qlite3_config()]
12550 20 77 69 6c 6c 20 72 65 74 75 72 6e 20 5b 53 51   will return [SQ
12560 4c 49 54 45 5f 45 52 52 4f 52 5d 20 69 66 20 63  LITE_ERROR] if c
12570 61 6c 6c 65 64 20 77 69 74 68 20 74 68 65 0a 2a  alled with the.*
12580 2a 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  * SQLITE_CONFIG_
12590 4d 55 4c 54 49 54 48 52 45 41 44 20 63 6f 6e 66  MULTITHREAD conf
125a0 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e  iguration option
125b0 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53  .</dd>.**.** [[S
125c0 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 45 52  QLITE_CONFIG_SER
125d0 49 41 4c 49 5a 45 44 5d 5d 20 3c 64 74 3e 53 51  IALIZED]] <dt>SQ
125e0 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 45 52 49  LITE_CONFIG_SERI
125f0 41 4c 49 5a 45 44 3c 2f 64 74 3e 0a 2a 2a 20 3c  ALIZED</dt>.** <
12600 64 64 3e 54 68 65 72 65 20 61 72 65 20 6e 6f 20  dd>There are no 
12610 61 72 67 75 6d 65 6e 74 73 20 74 6f 20 74 68 69  arguments to thi
12620 73 20 6f 70 74 69 6f 6e 2e 20 20 5e 54 68 69 73  s option.  ^This
12630 20 6f 70 74 69 6f 6e 20 73 65 74 73 20 74 68 65   option sets the
12640 0a 2a 2a 20 5b 74 68 72 65 61 64 69 6e 67 20 6d  .** [threading m
12650 6f 64 65 5d 20 74 6f 20 53 65 72 69 61 6c 69 7a  ode] to Serializ
12660 65 64 2e 20 49 6e 20 6f 74 68 65 72 20 77 6f 72  ed. In other wor
12670 64 73 2c 20 74 68 69 73 20 6f 70 74 69 6f 6e 20  ds, this option 
12680 65 6e 61 62 6c 65 73 0a 2a 2a 20 61 6c 6c 20 6d  enables.** all m
12690 75 74 65 78 65 73 20 69 6e 63 6c 75 64 69 6e 67  utexes including
126a0 20 74 68 65 20 72 65 63 75 72 73 69 76 65 0a 2a   the recursive.*
126b0 2a 20 6d 75 74 65 78 65 73 20 6f 6e 20 5b 64 61  * mutexes on [da
126c0 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
126d0 6e 5d 20 61 6e 64 20 5b 70 72 65 70 61 72 65 64  n] and [prepared
126e0 20 73 74 61 74 65 6d 65 6e 74 5d 20 6f 62 6a 65   statement] obje
126f0 63 74 73 2e 0a 2a 2a 20 49 6e 20 74 68 69 73 20  cts..** In this 
12700 6d 6f 64 65 20 28 77 68 69 63 68 20 69 73 20 74  mode (which is t
12710 68 65 20 64 65 66 61 75 6c 74 20 77 68 65 6e 20  he default when 
12720 53 51 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c  SQLite is compil
12730 65 64 20 77 69 74 68 0a 2a 2a 20 5b 53 51 4c 49  ed with.** [SQLI
12740 54 45 5f 54 48 52 45 41 44 53 41 46 45 3d 31 5d  TE_THREADSAFE=1]
12750 29 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62  ) the SQLite lib
12760 72 61 72 79 20 77 69 6c 6c 20 69 74 73 65 6c 66  rary will itself
12770 20 73 65 72 69 61 6c 69 7a 65 20 61 63 63 65 73   serialize acces
12780 73 0a 2a 2a 20 74 6f 20 5b 64 61 74 61 62 61 73  s.** to [databas
12790 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 5d 20 61  e connections] a
127a0 6e 64 20 5b 70 72 65 70 61 72 65 64 20 73 74 61  nd [prepared sta
127b0 74 65 6d 65 6e 74 73 5d 20 73 6f 20 74 68 61 74  tements] so that
127c0 20 74 68 65 0a 2a 2a 20 61 70 70 6c 69 63 61 74   the.** applicat
127d0 69 6f 6e 20 69 73 20 66 72 65 65 20 74 6f 20 75  ion is free to u
127e0 73 65 20 74 68 65 20 73 61 6d 65 20 5b 64 61 74  se the same [dat
127f0 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
12800 5d 20 6f 72 20 74 68 65 0a 2a 2a 20 73 61 6d 65  ] or the.** same
12810 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65   [prepared state
12820 6d 65 6e 74 5d 20 69 6e 20 64 69 66 66 65 72 65  ment] in differe
12830 6e 74 20 74 68 72 65 61 64 73 20 61 74 20 74 68  nt threads at th
12840 65 20 73 61 6d 65 20 74 69 6d 65 2e 0a 2a 2a 20  e same time..** 
12850 5e 49 66 20 53 51 4c 69 74 65 20 69 73 20 63 6f  ^If SQLite is co
12860 6d 70 69 6c 65 64 20 77 69 74 68 0a 2a 2a 20 74  mpiled with.** t
12870 68 65 20 5b 53 51 4c 49 54 45 5f 54 48 52 45 41  he [SQLITE_THREA
12880 44 53 41 46 45 20 7c 20 53 51 4c 49 54 45 5f 54  DSAFE | SQLITE_T
12890 48 52 45 41 44 53 41 46 45 3d 30 5d 20 63 6f 6d  HREADSAFE=0] com
128a0 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e  pile-time option
128b0 20 74 68 65 6e 0a 2a 2a 20 69 74 20 69 73 20 6e   then.** it is n
128c0 6f 74 20 70 6f 73 73 69 62 6c 65 20 74 6f 20 73  ot possible to s
128d0 65 74 20 74 68 65 20 53 65 72 69 61 6c 69 7a 65  et the Serialize
128e0 64 20 5b 74 68 72 65 61 64 69 6e 67 20 6d 6f 64  d [threading mod
128f0 65 5d 20 61 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74  e] and.** [sqlit
12900 65 33 5f 63 6f 6e 66 69 67 28 29 5d 20 77 69 6c  e3_config()] wil
12910 6c 20 72 65 74 75 72 6e 20 5b 53 51 4c 49 54 45  l return [SQLITE
12920 5f 45 52 52 4f 52 5d 20 69 66 20 63 61 6c 6c 65  _ERROR] if calle
12930 64 20 77 69 74 68 20 74 68 65 0a 2a 2a 20 53 51  d with the.** SQ
12940 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 45 52 49  LITE_CONFIG_SERI
12950 41 4c 49 5a 45 44 20 63 6f 6e 66 69 67 75 72 61  ALIZED configura
12960 74 69 6f 6e 20 6f 70 74 69 6f 6e 2e 3c 2f 64 64  tion option.</dd
12970 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45  >.**.** [[SQLITE
12980 5f 43 4f 4e 46 49 47 5f 4d 41 4c 4c 4f 43 5d 5d  _CONFIG_MALLOC]]
12990 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46   <dt>SQLITE_CONF
129a0 49 47 5f 4d 41 4c 4c 4f 43 3c 2f 64 74 3e 0a 2a  IG_MALLOC</dt>.*
129b0 2a 20 3c 64 64 3e 20 5e 28 54 68 65 20 53 51 4c  * <dd> ^(The SQL
129c0 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 41 4c 4c 4f  ITE_CONFIG_MALLO
129d0 43 20 6f 70 74 69 6f 6e 20 74 61 6b 65 73 20 61  C option takes a
129e0 20 73 69 6e 67 6c 65 20 61 72 67 75 6d 65 6e 74   single argument
129f0 20 77 68 69 63 68 20 69 73 20 0a 2a 2a 20 61 20   which is .** a 
12a00 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 69 6e  pointer to an in
12a10 73 74 61 6e 63 65 20 6f 66 20 74 68 65 20 5b 73  stance of the [s
12a20 71 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65 74 68 6f  qlite3_mem_metho
12a30 64 73 5d 20 73 74 72 75 63 74 75 72 65 2e 0a 2a  ds] structure..*
12a40 2a 20 54 68 65 20 61 72 67 75 6d 65 6e 74 20 73  * The argument s
12a50 70 65 63 69 66 69 65 73 0a 2a 2a 20 61 6c 74 65  pecifies.** alte
12a60 72 6e 61 74 69 76 65 20 6c 6f 77 2d 6c 65 76 65  rnative low-leve
12a70 6c 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  l memory allocat
12a80 69 6f 6e 20 72 6f 75 74 69 6e 65 73 20 74 6f 20  ion routines to 
12a90 62 65 20 75 73 65 64 20 69 6e 20 70 6c 61 63 65  be used in place
12aa0 20 6f 66 0a 2a 2a 20 74 68 65 20 6d 65 6d 6f 72   of.** the memor
12ab0 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 72 6f 75  y allocation rou
12ac0 74 69 6e 65 73 20 62 75 69 6c 74 20 69 6e 74 6f  tines built into
12ad0 20 53 51 4c 69 74 65 2e 29 5e 20 5e 53 51 4c 69   SQLite.)^ ^SQLi
12ae0 74 65 20 6d 61 6b 65 73 0a 2a 2a 20 69 74 73 20  te makes.** its 
12af0 6f 77 6e 20 70 72 69 76 61 74 65 20 63 6f 70 79  own private copy
12b00 20 6f 66 20 74 68 65 20 63 6f 6e 74 65 6e 74 20   of the content 
12b10 6f 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  of the [sqlite3_
12b20 6d 65 6d 5f 6d 65 74 68 6f 64 73 5d 20 73 74 72  mem_methods] str
12b30 75 63 74 75 72 65 0a 2a 2a 20 62 65 66 6f 72 65  ucture.** before
12b40 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 63 6f   the [sqlite3_co
12b50 6e 66 69 67 28 29 5d 20 63 61 6c 6c 20 72 65 74  nfig()] call ret
12b60 75 72 6e 73 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a  urns.</dd>.**.**
12b70 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
12b80 5f 47 45 54 4d 41 4c 4c 4f 43 5d 5d 20 3c 64 74  _GETMALLOC]] <dt
12b90 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 47  >SQLITE_CONFIG_G
12ba0 45 54 4d 41 4c 4c 4f 43 3c 2f 64 74 3e 0a 2a 2a  ETMALLOC</dt>.**
12bb0 20 3c 64 64 3e 20 5e 28 54 68 65 20 53 51 4c 49   <dd> ^(The SQLI
12bc0 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 4d 41 4c  TE_CONFIG_GETMAL
12bd0 4c 4f 43 20 6f 70 74 69 6f 6e 20 74 61 6b 65 73  LOC option takes
12be0 20 61 20 73 69 6e 67 6c 65 20 61 72 67 75 6d 65   a single argume
12bf0 6e 74 20 77 68 69 63 68 0a 2a 2a 20 69 73 20 61  nt which.** is a
12c00 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 69   pointer to an i
12c10 6e 73 74 61 6e 63 65 20 6f 66 20 74 68 65 20 5b  nstance of the [
12c20 73 71 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65 74 68  sqlite3_mem_meth
12c30 6f 64 73 5d 20 73 74 72 75 63 74 75 72 65 2e 0a  ods] structure..
12c40 2a 2a 20 54 68 65 20 5b 73 71 6c 69 74 65 33 5f  ** The [sqlite3_
12c50 6d 65 6d 5f 6d 65 74 68 6f 64 73 5d 0a 2a 2a 20  mem_methods].** 
12c60 73 74 72 75 63 74 75 72 65 20 69 73 20 66 69 6c  structure is fil
12c70 6c 65 64 20 77 69 74 68 20 74 68 65 20 63 75 72  led with the cur
12c80 72 65 6e 74 6c 79 20 64 65 66 69 6e 65 64 20 6d  rently defined m
12c90 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e  emory allocation
12ca0 20 72 6f 75 74 69 6e 65 73 2e 29 5e 0a 2a 2a 20   routines.)^.** 
12cb0 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 6e 20  This option can 
12cc0 62 65 20 75 73 65 64 20 74 6f 20 6f 76 65 72 6c  be used to overl
12cd0 6f 61 64 20 74 68 65 20 64 65 66 61 75 6c 74 20  oad the default 
12ce0 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f  memory allocatio
12cf0 6e 0a 2a 2a 20 72 6f 75 74 69 6e 65 73 20 77 69  n.** routines wi
12d00 74 68 20 61 20 77 72 61 70 70 65 72 20 74 68 61  th a wrapper tha
12d10 74 20 73 69 6d 75 6c 61 74 69 6f 6e 73 20 6d 65  t simulations me
12d20 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20  mory allocation 
12d30 66 61 69 6c 75 72 65 20 6f 72 0a 2a 2a 20 74 72  failure or.** tr
12d40 61 63 6b 73 20 6d 65 6d 6f 72 79 20 75 73 61 67  acks memory usag
12d50 65 2c 20 66 6f 72 20 65 78 61 6d 70 6c 65 2e 20  e, for example. 
12d60 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51  </dd>.**.** [[SQ
12d70 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 45 4d 53  LITE_CONFIG_MEMS
12d80 54 41 54 55 53 5d 5d 20 3c 64 74 3e 53 51 4c 49  TATUS]] <dt>SQLI
12d90 54 45 5f 43 4f 4e 46 49 47 5f 4d 45 4d 53 54 41  TE_CONFIG_MEMSTA
12da0 54 55 53 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e  TUS</dt>.** <dd>
12db0 20 5e 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e   ^The SQLITE_CON
12dc0 46 49 47 5f 4d 45 4d 53 54 41 54 55 53 20 6f 70  FIG_MEMSTATUS op
12dd0 74 69 6f 6e 20 74 61 6b 65 73 20 73 69 6e 67 6c  tion takes singl
12de0 65 20 61 72 67 75 6d 65 6e 74 20 6f 66 20 74 79  e argument of ty
12df0 70 65 20 69 6e 74 2c 0a 2a 2a 20 69 6e 74 65 72  pe int,.** inter
12e00 70 72 65 74 65 64 20 61 73 20 61 20 62 6f 6f 6c  preted as a bool
12e10 65 61 6e 2c 20 77 68 69 63 68 20 65 6e 61 62 6c  ean, which enabl
12e20 65 73 20 6f 72 20 64 69 73 61 62 6c 65 73 20 74  es or disables t
12e30 68 65 20 63 6f 6c 6c 65 63 74 69 6f 6e 20 6f 66  he collection of
12e40 0a 2a 2a 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  .** memory alloc
12e50 61 74 69 6f 6e 20 73 74 61 74 69 73 74 69 63 73  ation statistics
12e60 2e 20 5e 28 57 68 65 6e 20 6d 65 6d 6f 72 79 20  . ^(When memory 
12e70 61 6c 6c 6f 63 61 74 69 6f 6e 20 73 74 61 74 69  allocation stati
12e80 73 74 69 63 73 20 61 72 65 0a 2a 2a 20 64 69 73  stics are.** dis
12e90 61 62 6c 65 64 2c 20 74 68 65 20 66 6f 6c 6c 6f  abled, the follo
12ea0 77 69 6e 67 20 53 51 4c 69 74 65 20 69 6e 74 65  wing SQLite inte
12eb0 72 66 61 63 65 73 20 62 65 63 6f 6d 65 20 6e 6f  rfaces become no
12ec0 6e 2d 6f 70 65 72 61 74 69 6f 6e 61 6c 3a 0a 2a  n-operational:.*
12ed0 2a 20 20 20 3c 75 6c 3e 0a 2a 2a 20 20 20 3c 6c  *   <ul>.**   <l
12ee0 69 3e 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d 6f  i> [sqlite3_memo
12ef0 72 79 5f 75 73 65 64 28 29 5d 0a 2a 2a 20 20 20  ry_used()].**   
12f00 3c 6c 69 3e 20 5b 73 71 6c 69 74 65 33 5f 6d 65  <li> [sqlite3_me
12f10 6d 6f 72 79 5f 68 69 67 68 77 61 74 65 72 28 29  mory_highwater()
12f20 5d 0a 2a 2a 20 20 20 3c 6c 69 3e 20 5b 73 71 6c  ].**   <li> [sql
12f30 69 74 65 33 5f 73 6f 66 74 5f 68 65 61 70 5f 6c  ite3_soft_heap_l
12f40 69 6d 69 74 36 34 28 29 5d 0a 2a 2a 20 20 20 3c  imit64()].**   <
12f50 6c 69 3e 20 5b 73 71 6c 69 74 65 33 5f 73 74 61  li> [sqlite3_sta
12f60 74 75 73 36 34 28 29 5d 0a 2a 2a 20 20 20 3c 2f  tus64()].**   </
12f70 75 6c 3e 29 5e 0a 2a 2a 20 5e 4d 65 6d 6f 72 79  ul>)^.** ^Memory
12f80 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 73 74 61 74   allocation stat
12f90 69 73 74 69 63 73 20 61 72 65 20 65 6e 61 62 6c  istics are enabl
12fa0 65 64 20 62 79 20 64 65 66 61 75 6c 74 20 75 6e  ed by default un
12fb0 6c 65 73 73 20 53 51 4c 69 74 65 20 69 73 0a 2a  less SQLite is.*
12fc0 2a 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 20  * compiled with 
12fd0 5b 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f  [SQLITE_DEFAULT_
12fe0 4d 45 4d 53 54 41 54 55 53 5d 3d 30 20 69 6e 20  MEMSTATUS]=0 in 
12ff0 77 68 69 63 68 20 63 61 73 65 20 6d 65 6d 6f 72  which case memor
13000 79 0a 2a 2a 20 61 6c 6c 6f 63 61 74 69 6f 6e 20  y.** allocation 
13010 73 74 61 74 69 73 74 69 63 73 20 61 72 65 20 64  statistics are d
13020 69 73 61 62 6c 65 64 20 62 79 20 64 65 66 61 75  isabled by defau
13030 6c 74 2e 0a 2a 2a 20 3c 2f 64 64 3e 0a 2a 2a 0a  lt..** </dd>.**.
13040 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46  ** [[SQLITE_CONF
13050 49 47 5f 53 43 52 41 54 43 48 5d 5d 20 3c 64 74  IG_SCRATCH]] <dt
13060 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53  >SQLITE_CONFIG_S
13070 43 52 41 54 43 48 3c 2f 64 74 3e 0a 2a 2a 20 3c  CRATCH</dt>.** <
13080 64 64 3e 20 5e 54 68 65 20 53 51 4c 49 54 45 5f  dd> ^The SQLITE_
13090 43 4f 4e 46 49 47 5f 53 43 52 41 54 43 48 20 6f  CONFIG_SCRATCH o
130a0 70 74 69 6f 6e 20 73 70 65 63 69 66 69 65 73 20  ption specifies 
130b0 61 20 73 74 61 74 69 63 20 6d 65 6d 6f 72 79 20  a static memory 
130c0 62 75 66 66 65 72 0a 2a 2a 20 74 68 61 74 20 53  buffer.** that S
130d0 51 4c 69 74 65 20 63 61 6e 20 75 73 65 20 66 6f  QLite can use fo
130e0 72 20 73 63 72 61 74 63 68 20 6d 65 6d 6f 72 79  r scratch memory
130f0 2e 20 20 5e 28 54 68 65 72 65 20 61 72 65 20 74  .  ^(There are t
13100 68 72 65 65 20 61 72 67 75 6d 65 6e 74 73 0a 2a  hree arguments.*
13110 2a 20 74 6f 20 53 51 4c 49 54 45 5f 43 4f 4e 46  * to SQLITE_CONF
13120 49 47 5f 53 43 52 41 54 43 48 3a 20 20 41 20 70  IG_SCRATCH:  A p
13130 6f 69 6e 74 65 72 20 61 6e 20 38 2d 62 79 74 65  ointer an 8-byte
13140 0a 2a 2a 20 61 6c 69 67 6e 65 64 20 6d 65 6d 6f  .** aligned memo
13150 72 79 20 62 75 66 66 65 72 20 66 72 6f 6d 20 77  ry buffer from w
13160 68 69 63 68 20 74 68 65 20 73 63 72 61 74 63 68  hich the scratch
13170 20 61 6c 6c 6f 63 61 74 69 6f 6e 73 20 77 69 6c   allocations wil
13180 6c 20 62 65 0a 2a 2a 20 64 72 61 77 6e 2c 20 74  l be.** drawn, t
13190 68 65 20 73 69 7a 65 20 6f 66 20 65 61 63 68 20  he size of each 
131a0 73 63 72 61 74 63 68 20 61 6c 6c 6f 63 61 74 69  scratch allocati
131b0 6f 6e 20 28 73 7a 29 2c 0a 2a 2a 20 61 6e 64 20  on (sz),.** and 
131c0 74 68 65 20 6d 61 78 69 6d 75 6d 20 6e 75 6d 62  the maximum numb
131d0 65 72 20 6f 66 20 73 63 72 61 74 63 68 20 61 6c  er of scratch al
131e0 6c 6f 63 61 74 69 6f 6e 73 20 28 4e 29 2e 29 5e  locations (N).)^
131f0 0a 2a 2a 20 54 68 65 20 66 69 72 73 74 20 61 72  .** The first ar
13200 67 75 6d 65 6e 74 20 6d 75 73 74 20 62 65 20 61  gument must be a
13210 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 38   pointer to an 8
13220 2d 62 79 74 65 20 61 6c 69 67 6e 65 64 20 62 75  -byte aligned bu
13230 66 66 65 72 0a 2a 2a 20 6f 66 20 61 74 20 6c 65  ffer.** of at le
13240 61 73 74 20 73 7a 2a 4e 20 62 79 74 65 73 20 6f  ast sz*N bytes o
13250 66 20 6d 65 6d 6f 72 79 2e 0a 2a 2a 20 5e 53 51  f memory..** ^SQ
13260 4c 69 74 65 20 77 69 6c 6c 20 6e 6f 74 20 75 73  Lite will not us
13270 65 20 6d 6f 72 65 20 74 68 61 6e 20 6f 6e 65 20  e more than one 
13280 73 63 72 61 74 63 68 20 62 75 66 66 65 72 73 20  scratch buffers 
13290 70 65 72 20 74 68 72 65 61 64 2e 0a 2a 2a 20 5e  per thread..** ^
132a0 53 51 4c 69 74 65 20 77 69 6c 6c 20 6e 65 76 65  SQLite will neve
132b0 72 20 72 65 71 75 65 73 74 20 61 20 73 63 72 61  r request a scra
132c0 74 63 68 20 62 75 66 66 65 72 20 74 68 61 74 20  tch buffer that 
132d0 69 73 20 6d 6f 72 65 20 74 68 61 6e 20 36 0a 2a  is more than 6.*
132e0 2a 20 74 69 6d 65 73 20 74 68 65 20 64 61 74 61  * times the data
132f0 62 61 73 65 20 70 61 67 65 20 73 69 7a 65 2e 0a  base page size..
13300 2a 2a 20 5e 49 66 20 53 51 4c 69 74 65 20 6e 65  ** ^If SQLite ne
13310 65 64 73 20 6e 65 65 64 73 20 61 64 64 69 74 69  eds needs additi
13320 6f 6e 61 6c 0a 2a 2a 20 73 63 72 61 74 63 68 20  onal.** scratch 
13330 6d 65 6d 6f 72 79 20 62 65 79 6f 6e 64 20 77 68  memory beyond wh
13340 61 74 20 69 73 20 70 72 6f 76 69 64 65 64 20 62  at is provided b
13350 79 20 74 68 69 73 20 63 6f 6e 66 69 67 75 72 61  y this configura
13360 74 69 6f 6e 20 6f 70 74 69 6f 6e 2c 20 74 68 65  tion option, the
13370 6e 20 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6d  n .** [sqlite3_m
13380 61 6c 6c 6f 63 28 29 5d 20 77 69 6c 6c 20 62 65  alloc()] will be
13390 20 75 73 65 64 20 74 6f 20 6f 62 74 61 69 6e 20   used to obtain 
133a0 74 68 65 20 6d 65 6d 6f 72 79 20 6e 65 65 64 65  the memory neede
133b0 64 2e 3c 70 3e 0a 2a 2a 20 5e 57 68 65 6e 20 74  d.<p>.** ^When t
133c0 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 70  he application p
133d0 72 6f 76 69 64 65 73 20 61 6e 79 20 61 6d 6f 75  rovides any amou
133e0 6e 74 20 6f 66 20 73 63 72 61 74 63 68 20 6d 65  nt of scratch me
133f0 6d 6f 72 79 20 75 73 69 6e 67 0a 2a 2a 20 53 51  mory using.** SQ
13400 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 43 52 41  LITE_CONFIG_SCRA
13410 54 43 48 2c 20 53 51 4c 69 74 65 20 61 76 6f 69  TCH, SQLite avoi
13420 64 73 20 75 6e 6e 65 63 65 73 73 61 72 79 20 6c  ds unnecessary l
13430 61 72 67 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  arge.** [sqlite3
13440 5f 6d 61 6c 6c 6f 63 7c 68 65 61 70 20 61 6c 6c  _malloc|heap all
13450 6f 63 61 74 69 6f 6e 73 5d 2e 0a 2a 2a 20 54 68  ocations]..** Th
13460 69 73 20 63 61 6e 20 68 65 6c 70 20 5b 52 6f 62  is can help [Rob
13470 73 6f 6e 20 70 72 6f 6f 66 7c 70 72 65 76 65 6e  son proof|preven
13480 74 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  t memory allocat
13490 69 6f 6e 20 66 61 69 6c 75 72 65 73 5d 20 64 75  ion failures] du
134a0 65 20 74 6f 20 68 65 61 70 0a 2a 2a 20 66 72 61  e to heap.** fra
134b0 67 6d 65 6e 74 61 74 69 6f 6e 20 69 6e 20 6c 6f  gmentation in lo
134c0 77 2d 6d 65 6d 6f 72 79 20 65 6d 62 65 64 64 65  w-memory embedde
134d0 64 20 73 79 73 74 65 6d 73 2e 0a 2a 2a 20 3c 2f  d systems..** </
134e0 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49  dd>.**.** [[SQLI
134f0 54 45 5f 43 4f 4e 46 49 47 5f 50 41 47 45 43 41  TE_CONFIG_PAGECA
13500 43 48 45 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45  CHE]] <dt>SQLITE
13510 5f 43 4f 4e 46 49 47 5f 50 41 47 45 43 41 43 48  _CONFIG_PAGECACH
13520 45 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e  E</dt>.** <dd> ^
13530 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  The SQLITE_CONFI
13540 47 5f 50 41 47 45 43 41 43 48 45 20 6f 70 74 69  G_PAGECACHE opti
13550 6f 6e 20 73 70 65 63 69 66 69 65 73 20 61 20 6d  on specifies a m
13560 65 6d 6f 72 79 20 70 6f 6f 6c 0a 2a 2a 20 74 68  emory pool.** th
13570 61 74 20 53 51 4c 69 74 65 20 63 61 6e 20 75 73  at SQLite can us
13580 65 20 66 6f 72 20 74 68 65 20 64 61 74 61 62 61  e for the databa
13590 73 65 20 70 61 67 65 20 63 61 63 68 65 20 77 69  se page cache wi
135a0 74 68 20 74 68 65 20 64 65 66 61 75 6c 74 20 70  th the default p
135b0 61 67 65 0a 2a 2a 20 63 61 63 68 65 20 69 6d 70  age.** cache imp
135c0 6c 65 6d 65 6e 74 61 74 69 6f 6e 2e 20 20 0a 2a  lementation.  .*
135d0 2a 20 54 68 69 73 20 63 6f 6e 66 69 67 75 72 61  * This configura
135e0 74 69 6f 6e 20 6f 70 74 69 6f 6e 20 69 73 20 61  tion option is a
135f0 20 6e 6f 2d 6f 70 20 69 66 20 61 6e 20 61 70 70   no-op if an app
13600 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 20  lication-define 
13610 70 61 67 65 0a 2a 2a 20 63 61 63 68 65 20 69 6d  page.** cache im
13620 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 69 73 20  plementation is 
13630 6c 6f 61 64 65 64 20 75 73 69 6e 67 20 74 68 65  loaded using the
13640 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f   [SQLITE_CONFIG_
13650 50 43 41 43 48 45 32 5d 2e 0a 2a 2a 20 5e 54 68  PCACHE2]..** ^Th
13660 65 72 65 20 61 72 65 20 74 68 72 65 65 20 61 72  ere are three ar
13670 67 75 6d 65 6e 74 73 20 74 6f 20 53 51 4c 49 54  guments to SQLIT
13680 45 5f 43 4f 4e 46 49 47 5f 50 41 47 45 43 41 43  E_CONFIG_PAGECAC
13690 48 45 3a 20 41 20 70 6f 69 6e 74 65 72 20 74 6f  HE: A pointer to
136a0 0a 2a 2a 20 38 2d 62 79 74 65 20 61 6c 69 67 6e  .** 8-byte align
136b0 65 64 20 6d 65 6d 6f 72 79 20 28 70 4d 65 6d 29  ed memory (pMem)
136c0 2c 20 74 68 65 20 73 69 7a 65 20 6f 66 20 65 61  , the size of ea
136d0 63 68 20 70 61 67 65 20 63 61 63 68 65 20 6c 69  ch page cache li
136e0 6e 65 20 28 73 7a 29 2c 0a 2a 2a 20 61 6e 64 20  ne (sz),.** and 
136f0 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 63 61  the number of ca
13700 63 68 65 20 6c 69 6e 65 73 20 28 4e 29 2e 0a 2a  che lines (N)..*
13710 2a 20 54 68 65 20 73 7a 20 61 72 67 75 6d 65 6e  * The sz argumen
13720 74 20 73 68 6f 75 6c 64 20 62 65 20 74 68 65 20  t should be the 
13730 73 69 7a 65 20 6f 66 20 74 68 65 20 6c 61 72 67  size of the larg
13740 65 73 74 20 64 61 74 61 62 61 73 65 20 70 61 67  est database pag
13750 65 0a 2a 2a 20 28 61 20 70 6f 77 65 72 20 6f 66  e.** (a power of
13760 20 74 77 6f 20 62 65 74 77 65 65 6e 20 35 31 32   two between 512
13770 20 61 6e 64 20 36 35 35 33 36 29 20 70 6c 75 73   and 65536) plus
13780 20 73 6f 6d 65 20 65 78 74 72 61 20 62 79 74 65   some extra byte
13790 73 20 66 6f 72 20 65 61 63 68 0a 2a 2a 20 70 61  s for each.** pa
137a0 67 65 20 68 65 61 64 65 72 2e 20 20 5e 54 68 65  ge header.  ^The
137b0 20 6e 75 6d 62 65 72 20 6f 66 20 65 78 74 72 61   number of extra
137c0 20 62 79 74 65 73 20 6e 65 65 64 65 64 20 62 79   bytes needed by
137d0 20 74 68 65 20 70 61 67 65 20 68 65 61 64 65 72   the page header
137e0 0a 2a 2a 20 63 61 6e 20 62 65 20 64 65 74 65 72  .** can be deter
137f0 6d 69 6e 65 64 20 75 73 69 6e 67 20 5b 53 51 4c  mined using [SQL
13800 49 54 45 5f 43 4f 4e 46 49 47 5f 50 43 41 43 48  ITE_CONFIG_PCACH
13810 45 5f 48 44 52 53 5a 5d 2e 0a 2a 2a 20 5e 49 74  E_HDRSZ]..** ^It
13820 20 69 73 20 68 61 72 6d 6c 65 73 73 2c 20 61 70   is harmless, ap
13830 61 72 74 20 66 72 6f 6d 20 74 68 65 20 77 61 73  art from the was
13840 74 65 64 20 6d 65 6d 6f 72 79 2c 0a 2a 2a 20 66  ted memory,.** f
13850 6f 72 20 74 68 65 20 73 7a 20 70 61 72 61 6d 65  or the sz parame
13860 74 65 72 20 74 6f 20 62 65 20 6c 61 72 67 65 72  ter to be larger
13870 20 74 68 61 6e 20 6e 65 63 65 73 73 61 72 79 2e   than necessary.
13880 20 20 54 68 65 20 70 4d 65 6d 0a 2a 2a 20 61 72    The pMem.** ar
13890 67 75 6d 65 6e 74 20 6d 75 73 74 20 62 65 20 65  gument must be e
138a0 69 74 68 65 72 20 61 20 4e 55 4c 4c 20 70 6f 69  ither a NULL poi
138b0 6e 74 65 72 20 6f 72 20 61 20 70 6f 69 6e 74 65  nter or a pointe
138c0 72 20 74 6f 20 61 6e 20 38 2d 62 79 74 65 0a 2a  r to an 8-byte.*
138d0 2a 20 61 6c 69 67 6e 65 64 20 62 6c 6f 63 6b 20  * aligned block 
138e0 6f 66 20 6d 65 6d 6f 72 79 20 6f 66 20 61 74 20  of memory of at 
138f0 6c 65 61 73 74 20 73 7a 2a 4e 20 62 79 74 65 73  least sz*N bytes
13900 2c 20 6f 74 68 65 72 77 69 73 65 0a 2a 2a 20 73  , otherwise.** s
13910 75 62 73 65 71 75 65 6e 74 20 62 65 68 61 76 69  ubsequent behavi
13920 6f 72 20 69 73 20 75 6e 64 65 66 69 6e 65 64 2e  or is undefined.
13930 0a 2a 2a 20 5e 57 68 65 6e 20 70 4d 65 6d 20 69  .** ^When pMem i
13940 73 20 6e 6f 74 20 4e 55 4c 4c 2c 20 53 51 4c 69  s not NULL, SQLi
13950 74 65 20 77 69 6c 6c 20 73 74 72 69 76 65 20 74  te will strive t
13960 6f 20 75 73 65 20 74 68 65 20 6d 65 6d 6f 72 79  o use the memory
13970 20 70 72 6f 76 69 64 65 64 0a 2a 2a 20 74 6f 20   provided.** to 
13980 73 61 74 69 73 66 79 20 70 61 67 65 20 63 61 63  satisfy page cac
13990 68 65 20 6e 65 65 64 73 2c 20 66 61 6c 6c 69 6e  he needs, fallin
139a0 67 20 62 61 63 6b 20 74 6f 20 5b 73 71 6c 69 74  g back to [sqlit
139b0 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 20 69 66 0a  e3_malloc()] if.
139c0 2a 2a 20 61 20 70 61 67 65 20 63 61 63 68 65 20  ** a page cache 
139d0 6c 69 6e 65 20 69 73 20 6c 61 72 67 65 72 20 74  line is larger t
139e0 68 61 6e 20 73 7a 20 62 79 74 65 73 20 6f 72 20  han sz bytes or 
139f0 69 66 20 61 6c 6c 20 6f 66 20 74 68 65 20 70 4d  if all of the pM
13a00 65 6d 20 62 75 66 66 65 72 0a 2a 2a 20 69 73 20  em buffer.** is 
13a10 65 78 68 61 75 73 74 65 64 2e 0a 2a 2a 20 5e 49  exhausted..** ^I
13a20 66 20 70 4d 65 6d 20 69 73 20 4e 55 4c 4c 20 61  f pMem is NULL a
13a30 6e 64 20 4e 20 69 73 20 6e 6f 6e 2d 7a 65 72 6f  nd N is non-zero
13a40 2c 20 74 68 65 6e 20 65 61 63 68 20 64 61 74 61  , then each data
13a50 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 0a  base connection.
13a60 2a 2a 20 64 6f 65 73 20 61 6e 20 69 6e 69 74 69  ** does an initi
13a70 61 6c 20 62 75 6c 6b 20 61 6c 6c 6f 63 61 74 69  al bulk allocati
13a80 6f 6e 20 66 6f 72 20 70 61 67 65 20 63 61 63 68  on for page cach
13a90 65 20 6d 65 6d 6f 72 79 0a 2a 2a 20 66 72 6f 6d  e memory.** from
13aa0 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63   [sqlite3_malloc
13ab0 28 29 5d 20 73 75 66 66 69 63 69 65 6e 74 20 66  ()] sufficient f
13ac0 6f 72 20 4e 20 63 61 63 68 65 20 6c 69 6e 65 73  or N cache lines
13ad0 20 69 66 20 4e 20 69 73 20 70 6f 73 69 74 69 76   if N is positiv
13ae0 65 20 6f 72 0a 2a 2a 20 6f 66 20 2d 31 30 32 34  e or.** of -1024
13af0 2a 4e 20 62 79 74 65 73 20 69 66 20 4e 20 69 73  *N bytes if N is
13b00 20 6e 65 67 61 74 69 76 65 2c 20 2e 20 5e 49 66   negative, . ^If
13b10 20 61 64 64 69 74 69 6f 6e 61 6c 0a 2a 2a 20 70   additional.** p
13b20 61 67 65 20 63 61 63 68 65 20 6d 65 6d 6f 72 79  age cache memory
13b30 20 69 73 20 6e 65 65 64 65 64 20 62 65 79 6f 6e   is needed beyon
13b40 64 20 77 68 61 74 20 69 73 20 70 72 6f 76 69 64  d what is provid
13b50 65 64 20 62 79 20 74 68 65 20 69 6e 69 74 69 61  ed by the initia
13b60 6c 0a 2a 2a 20 61 6c 6c 6f 63 61 74 69 6f 6e 2c  l.** allocation,
13b70 20 74 68 65 6e 20 53 51 4c 69 74 65 20 67 6f 65   then SQLite goe
13b80 73 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 6d 61  s to [sqlite3_ma
13b90 6c 6c 6f 63 28 29 5d 20 73 65 70 61 72 61 74 65  lloc()] separate
13ba0 6c 79 20 66 6f 72 20 65 61 63 68 0a 2a 2a 20 61  ly for each.** a
13bb0 64 64 69 74 69 6f 6e 61 6c 20 63 61 63 68 65 20  dditional cache 
13bc0 6c 69 6e 65 2e 20 3c 2f 64 64 3e 0a 2a 2a 0a 2a  line. </dd>.**.*
13bd0 2a 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49  * [[SQLITE_CONFI
13be0 47 5f 48 45 41 50 5d 5d 20 3c 64 74 3e 53 51 4c  G_HEAP]] <dt>SQL
13bf0 49 54 45 5f 43 4f 4e 46 49 47 5f 48 45 41 50 3c  ITE_CONFIG_HEAP<
13c00 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 54 68  /dt>.** <dd> ^Th
13c10 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  e SQLITE_CONFIG_
13c20 48 45 41 50 20 6f 70 74 69 6f 6e 20 73 70 65 63  HEAP option spec
13c30 69 66 69 65 73 20 61 20 73 74 61 74 69 63 20 6d  ifies a static m
13c40 65 6d 6f 72 79 20 62 75 66 66 65 72 20 0a 2a 2a  emory buffer .**
13c50 20 74 68 61 74 20 53 51 4c 69 74 65 20 77 69 6c   that SQLite wil
13c60 6c 20 75 73 65 20 66 6f 72 20 61 6c 6c 20 6f 66  l use for all of
13c70 20 69 74 73 20 64 79 6e 61 6d 69 63 20 6d 65 6d   its dynamic mem
13c80 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 6e  ory allocation n
13c90 65 65 64 73 0a 2a 2a 20 62 65 79 6f 6e 64 20 74  eeds.** beyond t
13ca0 68 6f 73 65 20 70 72 6f 76 69 64 65 64 20 66 6f  hose provided fo
13cb0 72 20 62 79 20 5b 53 51 4c 49 54 45 5f 43 4f 4e  r by [SQLITE_CON
13cc0 46 49 47 5f 53 43 52 41 54 43 48 5d 20 61 6e 64  FIG_SCRATCH] and
13cd0 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46  .** [SQLITE_CONF
13ce0 49 47 5f 50 41 47 45 43 41 43 48 45 5d 2e 0a 2a  IG_PAGECACHE]..*
13cf0 2a 20 5e 54 68 65 20 53 51 4c 49 54 45 5f 43 4f  * ^The SQLITE_CO
13d00 4e 46 49 47 5f 48 45 41 50 20 6f 70 74 69 6f 6e  NFIG_HEAP option
13d10 20 69 73 20 6f 6e 6c 79 20 61 76 61 69 6c 61 62   is only availab
13d20 6c 65 20 69 66 20 53 51 4c 69 74 65 20 69 73 20  le if SQLite is 
13d30 63 6f 6d 70 69 6c 65 64 0a 2a 2a 20 77 69 74 68  compiled.** with
13d40 20 65 69 74 68 65 72 20 5b 53 51 4c 49 54 45 5f   either [SQLITE_
13d50 45 4e 41 42 4c 45 5f 4d 45 4d 53 59 53 33 5d 20  ENABLE_MEMSYS3] 
13d60 6f 72 20 5b 53 51 4c 49 54 45 5f 45 4e 41 42 4c  or [SQLITE_ENABL
13d70 45 5f 4d 45 4d 53 59 53 35 5d 20 61 6e 64 20 72  E_MEMSYS5] and r
13d80 65 74 75 72 6e 73 0a 2a 2a 20 5b 53 51 4c 49 54  eturns.** [SQLIT
13d90 45 5f 45 52 52 4f 52 5d 20 69 66 20 69 6e 76 6f  E_ERROR] if invo
13da0 6b 65 64 20 6f 74 68 65 72 77 69 73 65 2e 0a 2a  ked otherwise..*
13db0 2a 20 5e 54 68 65 72 65 20 61 72 65 20 74 68 72  * ^There are thr
13dc0 65 65 20 61 72 67 75 6d 65 6e 74 73 20 74 6f 20  ee arguments to 
13dd0 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 48 45  SQLITE_CONFIG_HE
13de0 41 50 3a 0a 2a 2a 20 41 6e 20 38 2d 62 79 74 65  AP:.** An 8-byte
13df0 20 61 6c 69 67 6e 65 64 20 70 6f 69 6e 74 65 72   aligned pointer
13e00 20 74 6f 20 74 68 65 20 6d 65 6d 6f 72 79 2c 0a   to the memory,.
13e10 2a 2a 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  ** the number of
13e20 20 62 79 74 65 73 20 69 6e 20 74 68 65 20 6d 65   bytes in the me
13e30 6d 6f 72 79 20 62 75 66 66 65 72 2c 20 61 6e 64  mory buffer, and
13e40 20 74 68 65 20 6d 69 6e 69 6d 75 6d 20 61 6c 6c   the minimum all
13e50 6f 63 61 74 69 6f 6e 20 73 69 7a 65 2e 0a 2a 2a  ocation size..**
13e60 20 5e 49 66 20 74 68 65 20 66 69 72 73 74 20 70   ^If the first p
13e70 6f 69 6e 74 65 72 20 28 74 68 65 20 6d 65 6d 6f  ointer (the memo
13e80 72 79 20 70 6f 69 6e 74 65 72 29 20 69 73 20 4e  ry pointer) is N
13e90 55 4c 4c 2c 20 74 68 65 6e 20 53 51 4c 69 74 65  ULL, then SQLite
13ea0 20 72 65 76 65 72 74 73 0a 2a 2a 20 74 6f 20 75   reverts.** to u
13eb0 73 69 6e 67 20 69 74 73 20 64 65 66 61 75 6c 74  sing its default
13ec0 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f   memory allocato
13ed0 72 20 28 74 68 65 20 73 79 73 74 65 6d 20 6d 61  r (the system ma
13ee0 6c 6c 6f 63 28 29 20 69 6d 70 6c 65 6d 65 6e 74  lloc() implement
13ef0 61 74 69 6f 6e 29 2c 0a 2a 2a 20 75 6e 64 6f 69  ation),.** undoi
13f00 6e 67 20 61 6e 79 20 70 72 69 6f 72 20 69 6e 76  ng any prior inv
13f10 6f 63 61 74 69 6f 6e 20 6f 66 20 5b 53 51 4c 49  ocation of [SQLI
13f20 54 45 5f 43 4f 4e 46 49 47 5f 4d 41 4c 4c 4f 43  TE_CONFIG_MALLOC
13f30 5d 2e 20 20 5e 49 66 20 74 68 65 0a 2a 2a 20 6d  ].  ^If the.** m
13f40 65 6d 6f 72 79 20 70 6f 69 6e 74 65 72 20 69 73  emory pointer is
13f50 20 6e 6f 74 20 4e 55 4c 4c 20 74 68 65 6e 20 74   not NULL then t
13f60 68 65 20 61 6c 74 65 72 6e 61 74 69 76 65 20 6d  he alternative m
13f70 65 6d 6f 72 79 0a 2a 2a 20 61 6c 6c 6f 63 61 74  emory.** allocat
13f80 6f 72 20 69 73 20 65 6e 67 61 67 65 64 20 74 6f  or is engaged to
13f90 20 68 61 6e 64 6c 65 20 61 6c 6c 20 6f 66 20 53   handle all of S
13fa0 51 4c 69 74 65 73 20 6d 65 6d 6f 72 79 20 61 6c  QLites memory al
13fb0 6c 6f 63 61 74 69 6f 6e 20 6e 65 65 64 73 2e 0a  location needs..
13fc0 2a 2a 20 54 68 65 20 66 69 72 73 74 20 70 6f 69  ** The first poi
13fd0 6e 74 65 72 20 28 74 68 65 20 6d 65 6d 6f 72 79  nter (the memory
13fe0 20 70 6f 69 6e 74 65 72 29 20 6d 75 73 74 20 62   pointer) must b
13ff0 65 20 61 6c 69 67 6e 65 64 20 74 6f 20 61 6e 20  e aligned to an 
14000 38 2d 62 79 74 65 0a 2a 2a 20 62 6f 75 6e 64 61  8-byte.** bounda
14010 72 79 20 6f 72 20 73 75 62 73 65 71 75 65 6e 74  ry or subsequent
14020 20 62 65 68 61 76 69 6f 72 20 6f 66 20 53 51 4c   behavior of SQL
14030 69 74 65 20 77 69 6c 6c 20 62 65 20 75 6e 64 65  ite will be unde
14040 66 69 6e 65 64 2e 0a 2a 2a 20 54 68 65 20 6d 69  fined..** The mi
14050 6e 69 6d 75 6d 20 61 6c 6c 6f 63 61 74 69 6f 6e  nimum allocation
14060 20 73 69 7a 65 20 69 73 20 63 61 70 70 65 64 20   size is capped 
14070 61 74 20 32 2a 2a 31 32 2e 20 52 65 61 73 6f 6e  at 2**12. Reason
14080 61 62 6c 65 20 76 61 6c 75 65 73 0a 2a 2a 20 66  able values.** f
14090 6f 72 20 74 68 65 20 6d 69 6e 69 6d 75 6d 20 61  or the minimum a
140a0 6c 6c 6f 63 61 74 69 6f 6e 20 73 69 7a 65 20 61  llocation size a
140b0 72 65 20 32 2a 2a 35 20 74 68 72 6f 75 67 68 20  re 2**5 through 
140c0 32 2a 2a 38 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a  2**8.</dd>.**.**
140d0 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
140e0 5f 4d 55 54 45 58 5d 5d 20 3c 64 74 3e 53 51 4c  _MUTEX]] <dt>SQL
140f0 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 55 54 45 58  ITE_CONFIG_MUTEX
14100 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 28  </dt>.** <dd> ^(
14110 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  The SQLITE_CONFI
14120 47 5f 4d 55 54 45 58 20 6f 70 74 69 6f 6e 20 74  G_MUTEX option t
14130 61 6b 65 73 20 61 20 73 69 6e 67 6c 65 20 61 72  akes a single ar
14140 67 75 6d 65 6e 74 20 77 68 69 63 68 20 69 73 20  gument which is 
14150 61 0a 2a 2a 20 70 6f 69 6e 74 65 72 20 74 6f 20  a.** pointer to 
14160 61 6e 20 69 6e 73 74 61 6e 63 65 20 6f 66 20 74  an instance of t
14170 68 65 20 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65  he [sqlite3_mute
14180 78 5f 6d 65 74 68 6f 64 73 5d 20 73 74 72 75 63  x_methods] struc
14190 74 75 72 65 2e 0a 2a 2a 20 54 68 65 20 61 72 67  ture..** The arg
141a0 75 6d 65 6e 74 20 73 70 65 63 69 66 69 65 73 20  ument specifies 
141b0 61 6c 74 65 72 6e 61 74 69 76 65 20 6c 6f 77 2d  alternative low-
141c0 6c 65 76 65 6c 20 6d 75 74 65 78 20 72 6f 75 74  level mutex rout
141d0 69 6e 65 73 20 74 6f 20 62 65 20 75 73 65 64 0a  ines to be used.
141e0 2a 2a 20 69 6e 20 70 6c 61 63 65 20 74 68 65 20  ** in place the 
141f0 6d 75 74 65 78 20 72 6f 75 74 69 6e 65 73 20 62  mutex routines b
14200 75 69 6c 74 20 69 6e 74 6f 20 53 51 4c 69 74 65  uilt into SQLite
14210 2e 29 5e 20 20 5e 53 51 4c 69 74 65 20 6d 61 6b  .)^  ^SQLite mak
14220 65 73 20 61 20 63 6f 70 79 20 6f 66 0a 2a 2a 20  es a copy of.** 
14230 74 68 65 20 63 6f 6e 74 65 6e 74 20 6f 66 20 74  the content of t
14240 68 65 20 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65  he [sqlite3_mute
14250 78 5f 6d 65 74 68 6f 64 73 5d 20 73 74 72 75 63  x_methods] struc
14260 74 75 72 65 20 62 65 66 6f 72 65 20 74 68 65 20  ture before the 
14270 63 61 6c 6c 20 74 6f 0a 2a 2a 20 5b 73 71 6c 69  call to.** [sqli
14280 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d 20 72 65  te3_config()] re
14290 74 75 72 6e 73 2e 20 5e 49 66 20 53 51 4c 69 74  turns. ^If SQLit
142a0 65 20 69 73 20 63 6f 6d 70 69 6c 65 64 20 77 69  e is compiled wi
142b0 74 68 0a 2a 2a 20 74 68 65 20 5b 53 51 4c 49 54  th.** the [SQLIT
142c0 45 5f 54 48 52 45 41 44 53 41 46 45 20 7c 20 53  E_THREADSAFE | S
142d0 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45  QLITE_THREADSAFE
142e0 3d 30 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65  =0] compile-time
142f0 20 6f 70 74 69 6f 6e 20 74 68 65 6e 0a 2a 2a 20   option then.** 
14300 74 68 65 20 65 6e 74 69 72 65 20 6d 75 74 65 78  the entire mutex
14310 69 6e 67 20 73 75 62 73 79 73 74 65 6d 20 69 73  ing subsystem is
14320 20 6f 6d 69 74 74 65 64 20 66 72 6f 6d 20 74 68   omitted from th
14330 65 20 62 75 69 6c 64 20 61 6e 64 20 68 65 6e 63  e build and henc
14340 65 20 63 61 6c 6c 73 20 74 6f 0a 2a 2a 20 5b 73  e calls to.** [s
14350 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d  qlite3_config()]
14360 20 77 69 74 68 20 74 68 65 20 53 51 4c 49 54 45   with the SQLITE
14370 5f 43 4f 4e 46 49 47 5f 4d 55 54 45 58 20 63 6f  _CONFIG_MUTEX co
14380 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69  nfiguration opti
14390 6f 6e 20 77 69 6c 6c 0a 2a 2a 20 72 65 74 75 72  on will.** retur
143a0 6e 20 5b 53 51 4c 49 54 45 5f 45 52 52 4f 52 5d  n [SQLITE_ERROR]
143b0 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53  .</dd>.**.** [[S
143c0 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54  QLITE_CONFIG_GET
143d0 4d 55 54 45 58 5d 5d 20 3c 64 74 3e 53 51 4c 49  MUTEX]] <dt>SQLI
143e0 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 4d 55 54  TE_CONFIG_GETMUT
143f0 45 58 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20  EX</dt>.** <dd> 
14400 5e 28 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e  ^(The SQLITE_CON
14410 46 49 47 5f 47 45 54 4d 55 54 45 58 20 6f 70 74  FIG_GETMUTEX opt
14420 69 6f 6e 20 74 61 6b 65 73 20 61 20 73 69 6e 67  ion takes a sing
14430 6c 65 20 61 72 67 75 6d 65 6e 74 20 77 68 69 63  le argument whic
14440 68 0a 2a 2a 20 69 73 20 61 20 70 6f 69 6e 74 65  h.** is a pointe
14450 72 20 74 6f 20 61 6e 20 69 6e 73 74 61 6e 63 65  r to an instance
14460 20 6f 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33   of the [sqlite3
14470 5f 6d 75 74 65 78 5f 6d 65 74 68 6f 64 73 5d 20  _mutex_methods] 
14480 73 74 72 75 63 74 75 72 65 2e 20 20 54 68 65 0a  structure.  The.
14490 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65  ** [sqlite3_mute
144a0 78 5f 6d 65 74 68 6f 64 73 5d 0a 2a 2a 20 73 74  x_methods].** st
144b0 72 75 63 74 75 72 65 20 69 73 20 66 69 6c 6c 65  ructure is fille
144c0 64 20 77 69 74 68 20 74 68 65 20 63 75 72 72 65  d with the curre
144d0 6e 74 6c 79 20 64 65 66 69 6e 65 64 20 6d 75 74  ntly defined mut
144e0 65 78 20 72 6f 75 74 69 6e 65 73 2e 29 5e 0a 2a  ex routines.)^.*
144f0 2a 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 61  * This option ca
14500 6e 20 62 65 20 75 73 65 64 20 74 6f 20 6f 76 65  n be used to ove
14510 72 6c 6f 61 64 20 74 68 65 20 64 65 66 61 75 6c  rload the defaul
14520 74 20 6d 75 74 65 78 20 61 6c 6c 6f 63 61 74 69  t mutex allocati
14530 6f 6e 0a 2a 2a 20 72 6f 75 74 69 6e 65 73 20 77  on.** routines w
14540 69 74 68 20 61 20 77 72 61 70 70 65 72 20 75 73  ith a wrapper us
14550 65 64 20 74 6f 20 74 72 61 63 6b 20 6d 75 74 65  ed to track mute
14560 78 20 75 73 61 67 65 20 66 6f 72 20 70 65 72 66  x usage for perf
14570 6f 72 6d 61 6e 63 65 0a 2a 2a 20 70 72 6f 66 69  ormance.** profi
14580 6c 69 6e 67 20 6f 72 20 74 65 73 74 69 6e 67 2c  ling or testing,
14590 20 66 6f 72 20 65 78 61 6d 70 6c 65 2e 20 20 20   for example.   
145a0 5e 49 66 20 53 51 4c 69 74 65 20 69 73 20 63 6f  ^If SQLite is co
145b0 6d 70 69 6c 65 64 20 77 69 74 68 0a 2a 2a 20 74  mpiled with.** t
145c0 68 65 20 5b 53 51 4c 49 54 45 5f 54 48 52 45 41  he [SQLITE_THREA
145d0 44 53 41 46 45 20 7c 20 53 51 4c 49 54 45 5f 54  DSAFE | SQLITE_T
145e0 48 52 45 41 44 53 41 46 45 3d 30 5d 20 63 6f 6d  HREADSAFE=0] com
145f0 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e  pile-time option
14600 20 74 68 65 6e 0a 2a 2a 20 74 68 65 20 65 6e 74   then.** the ent
14610 69 72 65 20 6d 75 74 65 78 69 6e 67 20 73 75 62  ire mutexing sub
14620 73 79 73 74 65 6d 20 69 73 20 6f 6d 69 74 74 65  system is omitte
14630 64 20 66 72 6f 6d 20 74 68 65 20 62 75 69 6c 64  d from the build
14640 20 61 6e 64 20 68 65 6e 63 65 20 63 61 6c 6c 73   and hence calls
14650 20 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f   to.** [sqlite3_
14660 63 6f 6e 66 69 67 28 29 5d 20 77 69 74 68 20 74  config()] with t
14670 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47  he SQLITE_CONFIG
14680 5f 47 45 54 4d 55 54 45 58 20 63 6f 6e 66 69 67  _GETMUTEX config
14690 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 20 77  uration option w
146a0 69 6c 6c 0a 2a 2a 20 72 65 74 75 72 6e 20 5b 53  ill.** return [S
146b0 51 4c 49 54 45 5f 45 52 52 4f 52 5d 2e 3c 2f 64  QLITE_ERROR].</d
146c0 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  d>.**.** [[SQLIT
146d0 45 5f 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49  E_CONFIG_LOOKASI
146e0 44 45 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f  DE]] <dt>SQLITE_
146f0 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49 44 45  CONFIG_LOOKASIDE
14700 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 28  </dt>.** <dd> ^(
14710 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  The SQLITE_CONFI
14720 47 5f 4c 4f 4f 4b 41 53 49 44 45 20 6f 70 74 69  G_LOOKASIDE opti
14730 6f 6e 20 74 61 6b 65 73 20 74 77 6f 20 61 72 67  on takes two arg
14740 75 6d 65 6e 74 73 20 74 68 61 74 20 64 65 74 65  uments that dete
14750 72 6d 69 6e 65 0a 2a 2a 20 74 68 65 20 64 65 66  rmine.** the def
14760 61 75 6c 74 20 73 69 7a 65 20 6f 66 20 6c 6f 6f  ault size of loo
14770 6b 61 73 69 64 65 20 6d 65 6d 6f 72 79 20 6f 6e  kaside memory on
14780 20 65 61 63 68 20 5b 64 61 74 61 62 61 73 65 20   each [database 
14790 63 6f 6e 6e 65 63 74 69 6f 6e 5d 2e 0a 2a 2a 20  connection]..** 
147a0 54 68 65 20 66 69 72 73 74 20 61 72 67 75 6d 65  The first argume
147b0 6e 74 20 69 73 20 74 68 65 0a 2a 2a 20 73 69 7a  nt is the.** siz
147c0 65 20 6f 66 20 65 61 63 68 20 6c 6f 6f 6b 61 73  e of each lookas
147d0 69 64 65 20 62 75 66 66 65 72 20 73 6c 6f 74 20  ide buffer slot 
147e0 61 6e 64 20 74 68 65 20 73 65 63 6f 6e 64 20 69  and the second i
147f0 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 0a  s the number of.
14800 2a 2a 20 73 6c 6f 74 73 20 61 6c 6c 6f 63 61 74  ** slots allocat
14810 65 64 20 74 6f 20 65 61 63 68 20 64 61 74 61 62  ed to each datab
14820 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e 29  ase connection.)
14830 5e 20 20 5e 28 53 51 4c 49 54 45 5f 43 4f 4e 46  ^  ^(SQLITE_CONF
14840 49 47 5f 4c 4f 4f 4b 41 53 49 44 45 0a 2a 2a 20  IG_LOOKASIDE.** 
14850 73 65 74 73 20 74 68 65 20 3c 69 3e 64 65 66 61  sets the <i>defa
14860 75 6c 74 3c 2f 69 3e 20 6c 6f 6f 6b 61 73 69 64  ult</i> lookasid
14870 65 20 73 69 7a 65 2e 20 54 68 65 20 5b 53 51 4c  e size. The [SQL
14880 49 54 45 5f 44 42 43 4f 4e 46 49 47 5f 4c 4f 4f  ITE_DBCONFIG_LOO
14890 4b 41 53 49 44 45 5d 0a 2a 2a 20 6f 70 74 69 6f  KASIDE].** optio
148a0 6e 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 64 62  n to [sqlite3_db
148b0 5f 63 6f 6e 66 69 67 28 29 5d 20 63 61 6e 20 62  _config()] can b
148c0 65 20 75 73 65 64 20 74 6f 20 63 68 61 6e 67 65  e used to change
148d0 20 74 68 65 20 6c 6f 6f 6b 61 73 69 64 65 0a 2a   the lookaside.*
148e0 2a 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20  * configuration 
148f0 6f 6e 20 69 6e 64 69 76 69 64 75 61 6c 20 63 6f  on individual co
14900 6e 6e 65 63 74 69 6f 6e 73 2e 29 5e 20 3c 2f 64  nnections.)^ </d
14910 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  d>.**.** [[SQLIT
14920 45 5f 43 4f 4e 46 49 47 5f 50 43 41 43 48 45 32  E_CONFIG_PCACHE2
14930 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f  ]] <dt>SQLITE_CO
14940 4e 46 49 47 5f 50 43 41 43 48 45 32 3c 2f 64 74  NFIG_PCACHE2</dt
14950 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 28 54 68 65 20  >.** <dd> ^(The 
14960 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 43  SQLITE_CONFIG_PC
14970 41 43 48 45 32 20 6f 70 74 69 6f 6e 20 74 61 6b  ACHE2 option tak
14980 65 73 20 61 20 73 69 6e 67 6c 65 20 61 72 67 75  es a single argu
14990 6d 65 6e 74 20 77 68 69 63 68 20 69 73 20 0a 2a  ment which is .*
149a0 2a 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61  * a pointer to a
149b0 6e 20 5b 73 71 6c 69 74 65 33 5f 70 63 61 63 68  n [sqlite3_pcach
149c0 65 5f 6d 65 74 68 6f 64 73 32 5d 20 6f 62 6a 65  e_methods2] obje
149d0 63 74 2e 20 20 54 68 69 73 20 6f 62 6a 65 63 74  ct.  This object
149e0 20 73 70 65 63 69 66 69 65 73 0a 2a 2a 20 74 68   specifies.** th
149f0 65 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20 61  e interface to a
14a00 20 63 75 73 74 6f 6d 20 70 61 67 65 20 63 61 63   custom page cac
14a10 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f  he implementatio
14a20 6e 2e 29 5e 0a 2a 2a 20 5e 53 51 4c 69 74 65 20  n.)^.** ^SQLite 
14a30 6d 61 6b 65 73 20 61 20 63 6f 70 79 20 6f 66 20  makes a copy of 
14a40 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 70 63 61  the [sqlite3_pca
14a50 63 68 65 5f 6d 65 74 68 6f 64 73 32 5d 20 6f 62  che_methods2] ob
14a60 6a 65 63 74 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a  ject.</dd>.**.**
14a70 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
14a80 5f 47 45 54 50 43 41 43 48 45 32 5d 5d 20 3c 64  _GETPCACHE2]] <d
14a90 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  t>SQLITE_CONFIG_
14aa0 47 45 54 50 43 41 43 48 45 32 3c 2f 64 74 3e 0a  GETPCACHE2</dt>.
14ab0 2a 2a 20 3c 64 64 3e 20 5e 28 54 68 65 20 53 51  ** <dd> ^(The SQ
14ac0 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 50  LITE_CONFIG_GETP
14ad0 43 41 43 48 45 32 20 6f 70 74 69 6f 6e 20 74 61  CACHE2 option ta
14ae0 6b 65 73 20 61 20 73 69 6e 67 6c 65 20 61 72 67  kes a single arg
14af0 75 6d 65 6e 74 20 77 68 69 63 68 0a 2a 2a 20 69  ument which.** i
14b00 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61  s a pointer to a
14b10 6e 20 5b 73 71 6c 69 74 65 33 5f 70 63 61 63 68  n [sqlite3_pcach
14b20 65 5f 6d 65 74 68 6f 64 73 32 5d 20 6f 62 6a 65  e_methods2] obje
14b30 63 74 2e 20 20 53 51 4c 69 74 65 20 63 6f 70 69  ct.  SQLite copi
14b40 65 73 20 6f 66 0a 2a 2a 20 74 68 65 20 63 75 72  es of.** the cur
14b50 72 65 6e 74 20 70 61 67 65 20 63 61 63 68 65 20  rent page cache 
14b60 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 69  implementation i
14b70 6e 74 6f 20 74 68 61 74 20 6f 62 6a 65 63 74 2e  nto that object.
14b80 29 5e 20 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b  )^ </dd>.**.** [
14b90 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4c  [SQLITE_CONFIG_L
14ba0 4f 47 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f  OG]] <dt>SQLITE_
14bb0 43 4f 4e 46 49 47 5f 4c 4f 47 3c 2f 64 74 3e 0a  CONFIG_LOG</dt>.
14bc0 2a 2a 20 3c 64 64 3e 20 54 68 65 20 53 51 4c 49  ** <dd> The SQLI
14bd0 54 45 5f 43 4f 4e 46 49 47 5f 4c 4f 47 20 6f 70  TE_CONFIG_LOG op
14be0 74 69 6f 6e 20 69 73 20 75 73 65 64 20 74 6f 20  tion is used to 
14bf0 63 6f 6e 66 69 67 75 72 65 20 74 68 65 20 53 51  configure the SQ
14c00 4c 69 74 65 0a 2a 2a 20 67 6c 6f 62 61 6c 20 5b  Lite.** global [
14c10 65 72 72 6f 72 20 6c 6f 67 5d 2e 0a 2a 2a 20 28  error log]..** (
14c20 5e 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46  ^The SQLITE_CONF
14c30 49 47 5f 4c 4f 47 20 6f 70 74 69 6f 6e 20 74 61  IG_LOG option ta
14c40 6b 65 73 20 74 77 6f 20 61 72 67 75 6d 65 6e 74  kes two argument
14c50 73 3a 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20  s: a pointer to 
14c60 61 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 77 69  a.** function wi
14c70 74 68 20 61 20 63 61 6c 6c 20 73 69 67 6e 61 74  th a call signat
14c80 75 72 65 20 6f 66 20 76 6f 69 64 28 2a 29 28 76  ure of void(*)(v
14c90 6f 69 64 2a 2c 69 6e 74 2c 63 6f 6e 73 74 20 63  oid*,int,const c
14ca0 68 61 72 2a 29 2c 20 0a 2a 2a 20 61 6e 64 20 61  har*), .** and a
14cb0 20 70 6f 69 6e 74 65 72 20 74 6f 20 76 6f 69 64   pointer to void
14cc0 2e 20 5e 49 66 20 74 68 65 20 66 75 6e 63 74 69  . ^If the functi
14cd0 6f 6e 20 70 6f 69 6e 74 65 72 20 69 73 20 6e 6f  on pointer is no
14ce0 74 20 4e 55 4c 4c 2c 20 69 74 20 69 73 0a 2a 2a  t NULL, it is.**
14cf0 20 69 6e 76 6f 6b 65 64 20 62 79 20 5b 73 71 6c   invoked by [sql
14d00 69 74 65 33 5f 6c 6f 67 28 29 5d 20 74 6f 20 70  ite3_log()] to p
14d10 72 6f 63 65 73 73 20 65 61 63 68 20 6c 6f 67 67  rocess each logg
14d20 69 6e 67 20 65 76 65 6e 74 2e 20 20 5e 49 66 20  ing event.  ^If 
14d30 74 68 65 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20  the.** function 
14d40 70 6f 69 6e 74 65 72 20 69 73 20 4e 55 4c 4c 2c  pointer is NULL,
14d50 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 6c 6f   the [sqlite3_lo
14d60 67 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 62  g()] interface b
14d70 65 63 6f 6d 65 73 20 61 20 6e 6f 2d 6f 70 2e 0a  ecomes a no-op..
14d80 2a 2a 20 5e 54 68 65 20 76 6f 69 64 20 70 6f 69  ** ^The void poi
14d90 6e 74 65 72 20 74 68 61 74 20 69 73 20 74 68 65  nter that is the
14da0 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74   second argument
14db0 20 74 6f 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49   to SQLITE_CONFI
14dc0 47 5f 4c 4f 47 20 69 73 0a 2a 2a 20 70 61 73 73  G_LOG is.** pass
14dd0 65 64 20 74 68 72 6f 75 67 68 20 61 73 20 74 68  ed through as th
14de0 65 20 66 69 72 73 74 20 70 61 72 61 6d 65 74 65  e first paramete
14df0 72 20 74 6f 20 74 68 65 20 61 70 70 6c 69 63 61  r to the applica
14e00 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 6c 6f 67  tion-defined log
14e10 67 65 72 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20  ger.** function 
14e20 77 68 65 6e 65 76 65 72 20 74 68 61 74 20 66 75  whenever that fu
14e30 6e 63 74 69 6f 6e 20 69 73 20 69 6e 76 6f 6b 65  nction is invoke
14e40 64 2e 20 20 5e 54 68 65 20 73 65 63 6f 6e 64 20  d.  ^The second 
14e50 70 61 72 61 6d 65 74 65 72 20 74 6f 0a 2a 2a 20  parameter to.** 
14e60 74 68 65 20 6c 6f 67 67 65 72 20 66 75 6e 63 74  the logger funct
14e70 69 6f 6e 20 69 73 20 61 20 63 6f 70 79 20 6f 66  ion is a copy of
14e80 20 74 68 65 20 66 69 72 73 74 20 70 61 72 61 6d   the first param
14e90 65 74 65 72 20 74 6f 20 74 68 65 20 63 6f 72 72  eter to the corr
14ea0 65 73 70 6f 6e 64 69 6e 67 0a 2a 2a 20 5b 73 71  esponding.** [sq
14eb0 6c 69 74 65 33 5f 6c 6f 67 28 29 5d 20 63 61 6c  lite3_log()] cal
14ec0 6c 20 61 6e 64 20 69 73 20 69 6e 74 65 6e 64 65  l and is intende
14ed0 64 20 74 6f 20 62 65 20 61 20 5b 72 65 73 75 6c  d to be a [resul
14ee0 74 20 63 6f 64 65 5d 20 6f 72 20 61 6e 0a 2a 2a  t code] or an.**
14ef0 20 5b 65 78 74 65 6e 64 65 64 20 72 65 73 75 6c   [extended resul
14f00 74 20 63 6f 64 65 5d 2e 20 20 5e 54 68 65 20 74  t code].  ^The t
14f10 68 69 72 64 20 70 61 72 61 6d 65 74 65 72 20 70  hird parameter p
14f20 61 73 73 65 64 20 74 6f 20 74 68 65 20 6c 6f 67  assed to the log
14f30 67 65 72 20 69 73 0a 2a 2a 20 6c 6f 67 20 6d 65  ger is.** log me
14f40 73 73 61 67 65 20 61 66 74 65 72 20 66 6f 72 6d  ssage after form
14f50 61 74 74 69 6e 67 20 76 69 61 20 5b 73 71 6c 69  atting via [sqli
14f60 74 65 33 5f 73 6e 70 72 69 6e 74 66 28 29 5d 2e  te3_snprintf()].
14f70 0a 2a 2a 20 54 68 65 20 53 51 4c 69 74 65 20 6c  .** The SQLite l
14f80 6f 67 67 69 6e 67 20 69 6e 74 65 72 66 61 63 65  ogging interface
14f90 20 69 73 20 6e 6f 74 20 72 65 65 6e 74 72 61 6e   is not reentran
14fa0 74 3b 20 74 68 65 20 6c 6f 67 67 65 72 20 66 75  t; the logger fu
14fb0 6e 63 74 69 6f 6e 0a 2a 2a 20 73 75 70 70 6c 69  nction.** suppli
14fc0 65 64 20 62 79 20 74 68 65 20 61 70 70 6c 69 63  ed by the applic
14fd0 61 74 69 6f 6e 20 6d 75 73 74 20 6e 6f 74 20 69  ation must not i
14fe0 6e 76 6f 6b 65 20 61 6e 79 20 53 51 4c 69 74 65  nvoke any SQLite
14ff0 20 69 6e 74 65 72 66 61 63 65 2e 0a 2a 2a 20 49   interface..** I
15000 6e 20 61 20 6d 75 6c 74 69 2d 74 68 72 65 61 64  n a multi-thread
15010 65 64 20 61 70 70 6c 69 63 61 74 69 6f 6e 2c 20  ed application, 
15020 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d  the application-
15030 64 65 66 69 6e 65 64 20 6c 6f 67 67 65 72 0a 2a  defined logger.*
15040 2a 20 66 75 6e 63 74 69 6f 6e 20 6d 75 73 74 20  * function must 
15050 62 65 20 74 68 72 65 61 64 73 61 66 65 2e 20 3c  be threadsafe. <
15060 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c  /dd>.**.** [[SQL
15070 49 54 45 5f 43 4f 4e 46 49 47 5f 55 52 49 5d 5d  ITE_CONFIG_URI]]
15080 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46   <dt>SQLITE_CONF
15090 49 47 5f 55 52 49 0a 2a 2a 20 3c 64 64 3e 5e 28  IG_URI.** <dd>^(
150a0 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  The SQLITE_CONFI
150b0 47 5f 55 52 49 20 6f 70 74 69 6f 6e 20 74 61 6b  G_URI option tak
150c0 65 73 20 61 20 73 69 6e 67 6c 65 20 61 72 67 75  es a single argu
150d0 6d 65 6e 74 20 6f 66 20 74 79 70 65 20 69 6e 74  ment of type int
150e0 2e 0a 2a 2a 20 49 66 20 6e 6f 6e 2d 7a 65 72 6f  ..** If non-zero
150f0 2c 20 74 68 65 6e 20 55 52 49 20 68 61 6e 64 6c  , then URI handl
15100 69 6e 67 20 69 73 20 67 6c 6f 62 61 6c 6c 79 20  ing is globally 
15110 65 6e 61 62 6c 65 64 2e 20 49 66 20 74 68 65 20  enabled. If the 
15120 70 61 72 61 6d 65 74 65 72 20 69 73 20 7a 65 72  parameter is zer
15130 6f 2c 0a 2a 2a 20 74 68 65 6e 20 55 52 49 20 68  o,.** then URI h
15140 61 6e 64 6c 69 6e 67 20 69 73 20 67 6c 6f 62 61  andling is globa
15150 6c 6c 79 20 64 69 73 61 62 6c 65 64 2e 29 5e 20  lly disabled.)^ 
15160 5e 49 66 20 55 52 49 20 68 61 6e 64 6c 69 6e 67  ^If URI handling
15170 20 69 73 20 67 6c 6f 62 61 6c 6c 79 0a 2a 2a 20   is globally.** 
15180 65 6e 61 62 6c 65 64 2c 20 61 6c 6c 20 66 69 6c  enabled, all fil
15190 65 6e 61 6d 65 73 20 70 61 73 73 65 64 20 74 6f  enames passed to
151a0 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29   [sqlite3_open()
151b0 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e  ], [sqlite3_open
151c0 5f 76 32 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69  _v2()],.** [sqli
151d0 74 65 33 5f 6f 70 65 6e 31 36 28 29 5d 20 6f 72  te3_open16()] or
151e0 0a 2a 2a 20 73 70 65 63 69 66 69 65 64 20 61 73  .** specified as
151f0 20 70 61 72 74 20 6f 66 20 5b 41 54 54 41 43 48   part of [ATTACH
15200 5d 20 63 6f 6d 6d 61 6e 64 73 20 61 72 65 20 69  ] commands are i
15210 6e 74 65 72 70 72 65 74 65 64 20 61 73 20 55 52  nterpreted as UR
15220 49 73 2c 20 72 65 67 61 72 64 6c 65 73 73 0a 2a  Is, regardless.*
15230 2a 20 6f 66 20 77 68 65 74 68 65 72 20 6f 72 20  * of whether or 
15240 6e 6f 74 20 74 68 65 20 5b 53 51 4c 49 54 45 5f  not the [SQLITE_
15250 4f 50 45 4e 5f 55 52 49 5d 20 66 6c 61 67 20 69  OPEN_URI] flag i
15260 73 20 73 65 74 20 77 68 65 6e 20 74 68 65 20 64  s set when the d
15270 61 74 61 62 61 73 65 0a 2a 2a 20 63 6f 6e 6e 65  atabase.** conne
15280 63 74 69 6f 6e 20 69 73 20 6f 70 65 6e 65 64 2e  ction is opened.
15290 20 5e 49 66 20 69 74 20 69 73 20 67 6c 6f 62 61   ^If it is globa
152a0 6c 6c 79 20 64 69 73 61 62 6c 65 64 2c 20 66 69  lly disabled, fi
152b0 6c 65 6e 61 6d 65 73 20 61 72 65 0a 2a 2a 20 6f  lenames are.** o
152c0 6e 6c 79 20 69 6e 74 65 72 70 72 65 74 65 64 20  nly interpreted 
152d0 61 73 20 55 52 49 73 20 69 66 20 74 68 65 20 53  as URIs if the S
152e0 51 4c 49 54 45 5f 4f 50 45 4e 5f 55 52 49 20 66  QLITE_OPEN_URI f
152f0 6c 61 67 20 69 73 20 73 65 74 20 77 68 65 6e 20  lag is set when 
15300 74 68 65 0a 2a 2a 20 64 61 74 61 62 61 73 65 20  the.** database 
15310 63 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 6f 70  connection is op
15320 65 6e 65 64 2e 20 5e 28 42 79 20 64 65 66 61 75  ened. ^(By defau
15330 6c 74 2c 20 55 52 49 20 68 61 6e 64 6c 69 6e 67  lt, URI handling
15340 20 69 73 20 67 6c 6f 62 61 6c 6c 79 0a 2a 2a 20   is globally.** 
15350 64 69 73 61 62 6c 65 64 2e 20 54 68 65 20 64 65  disabled. The de
15360 66 61 75 6c 74 20 76 61 6c 75 65 20 6d 61 79 20  fault value may 
15370 62 65 20 63 68 61 6e 67 65 64 20 62 79 20 63 6f  be changed by co
15380 6d 70 69 6c 69 6e 67 20 77 69 74 68 20 74 68 65  mpiling with the
15390 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 55 53 45 5f  .** [SQLITE_USE_
153a0 55 52 49 5d 20 73 79 6d 62 6f 6c 20 64 65 66 69  URI] symbol defi
153b0 6e 65 64 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53  ned.)^.**.** [[S
153c0 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 43 4f 56  QLITE_CONFIG_COV
153d0 45 52 49 4e 47 5f 49 4e 44 45 58 5f 53 43 41 4e  ERING_INDEX_SCAN
153e0 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f  ]] <dt>SQLITE_CO
153f0 4e 46 49 47 5f 43 4f 56 45 52 49 4e 47 5f 49 4e  NFIG_COVERING_IN
15400 44 45 58 5f 53 43 41 4e 0a 2a 2a 20 3c 64 64 3e  DEX_SCAN.** <dd>
15410 5e 54 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46  ^The SQLITE_CONF
15420 49 47 5f 43 4f 56 45 52 49 4e 47 5f 49 4e 44 45  IG_COVERING_INDE
15430 58 5f 53 43 41 4e 20 6f 70 74 69 6f 6e 20 74 61  X_SCAN option ta
15440 6b 65 73 20 61 20 73 69 6e 67 6c 65 20 69 6e 74  kes a single int
15450 65 67 65 72 0a 2a 2a 20 61 72 67 75 6d 65 6e 74  eger.** argument
15460 20 77 68 69 63 68 20 69 73 20 69 6e 74 65 72 70   which is interp
15470 72 65 74 65 64 20 61 73 20 61 20 62 6f 6f 6c 65  reted as a boole
15480 61 6e 20 69 6e 20 6f 72 64 65 72 20 74 6f 20 65  an in order to e
15490 6e 61 62 6c 65 20 6f 72 20 64 69 73 61 62 6c 65  nable or disable
154a0 0a 2a 2a 20 74 68 65 20 75 73 65 20 6f 66 20 63  .** the use of c
154b0 6f 76 65 72 69 6e 67 20 69 6e 64 69 63 65 73 20  overing indices 
154c0 66 6f 72 20 66 75 6c 6c 20 74 61 62 6c 65 20 73  for full table s
154d0 63 61 6e 73 20 69 6e 20 74 68 65 20 71 75 65 72  cans in the quer
154e0 79 20 6f 70 74 69 6d 69 7a 65 72 2e 0a 2a 2a 20  y optimizer..** 
154f0 5e 54 68 65 20 64 65 66 61 75 6c 74 20 73 65 74  ^The default set
15500 74 69 6e 67 20 69 73 20 64 65 74 65 72 6d 69 6e  ting is determin
15510 65 64 0a 2a 2a 20 62 79 20 74 68 65 20 5b 53 51  ed.** by the [SQ
15520 4c 49 54 45 5f 41 4c 4c 4f 57 5f 43 4f 56 45 52  LITE_ALLOW_COVER
15530 49 4e 47 5f 49 4e 44 45 58 5f 53 43 41 4e 5d 20  ING_INDEX_SCAN] 
15540 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
15550 69 6f 6e 2c 20 6f 72 20 69 73 20 22 6f 6e 22 0a  ion, or is "on".
15560 2a 2a 20 69 66 20 74 68 61 74 20 63 6f 6d 70 69  ** if that compi
15570 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20 69  le-time option i
15580 73 20 6f 6d 69 74 74 65 64 2e 0a 2a 2a 20 54 68  s omitted..** Th
15590 65 20 61 62 69 6c 69 74 79 20 74 6f 20 64 69 73  e ability to dis
155a0 61 62 6c 65 20 74 68 65 20 75 73 65 20 6f 66 20  able the use of 
155b0 63 6f 76 65 72 69 6e 67 20 69 6e 64 69 63 65 73  covering indices
155c0 20 66 6f 72 20 66 75 6c 6c 20 74 61 62 6c 65 20   for full table 
155d0 73 63 61 6e 73 0a 2a 2a 20 69 73 20 62 65 63 61  scans.** is beca
155e0 75 73 65 20 73 6f 6d 65 20 69 6e 63 6f 72 72 65  use some incorre
155f0 63 74 6c 79 20 63 6f 64 65 64 20 6c 65 67 61 63  ctly coded legac
15600 79 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 6d  y applications m
15610 69 67 68 74 20 6d 61 6c 66 75 6e 63 74 69 6f 6e  ight malfunction
15620 0a 2a 2a 20 77 68 65 6e 20 74 68 65 20 6f 70 74  .** when the opt
15630 69 6d 69 7a 61 74 69 6f 6e 20 69 73 20 65 6e 61  imization is ena
15640 62 6c 65 64 2e 20 20 50 72 6f 76 69 64 69 6e 67  bled.  Providing
15650 20 74 68 65 20 61 62 69 6c 69 74 79 20 74 6f 0a   the ability to.
15660 2a 2a 20 64 69 73 61 62 6c 65 20 74 68 65 20 6f  ** disable the o
15670 70 74 69 6d 69 7a 61 74 69 6f 6e 20 61 6c 6c 6f  ptimization allo
15680 77 73 20 74 68 65 20 6f 6c 64 65 72 2c 20 62 75  ws the older, bu
15690 67 67 79 20 61 70 70 6c 69 63 61 74 69 6f 6e 20  ggy application 
156a0 63 6f 64 65 20 74 6f 20 77 6f 72 6b 0a 2a 2a 20  code to work.** 
156b0 77 69 74 68 6f 75 74 20 63 68 61 6e 67 65 20 65  without change e
156c0 76 65 6e 20 77 69 74 68 20 6e 65 77 65 72 20 76  ven with newer v
156d0 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74  ersions of SQLit
156e0 65 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  e..**.** [[SQLIT
156f0 45 5f 43 4f 4e 46 49 47 5f 50 43 41 43 48 45 5d  E_CONFIG_PCACHE]
15700 5d 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49  ] [[SQLITE_CONFI
15710 47 5f 47 45 54 50 43 41 43 48 45 5d 5d 0a 2a 2a  G_GETPCACHE]].**
15720 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46   <dt>SQLITE_CONF
15730 49 47 5f 50 43 41 43 48 45 20 61 6e 64 20 53 51  IG_PCACHE and SQ
15740 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 50  LITE_CONFIG_GETP
15750 43 41 43 48 45 0a 2a 2a 20 3c 64 64 3e 20 54 68  CACHE.** <dd> Th
15760 65 73 65 20 6f 70 74 69 6f 6e 73 20 61 72 65 20  ese options are 
15770 6f 62 73 6f 6c 65 74 65 20 61 6e 64 20 73 68 6f  obsolete and sho
15780 75 6c 64 20 6e 6f 74 20 62 65 20 75 73 65 64 20  uld not be used 
15790 62 79 20 6e 65 77 20 63 6f 64 65 2e 0a 2a 2a 20  by new code..** 
157a0 54 68 65 79 20 61 72 65 20 72 65 74 61 69 6e 65  They are retaine
157b0 64 20 66 6f 72 20 62 61 63 6b 77 61 72 64 73 20  d for backwards 
157c0 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 20 62 75  compatibility bu
157d0 74 20 61 72 65 20 6e 6f 77 20 6e 6f 2d 6f 70 73  t are now no-ops
157e0 2e 0a 2a 2a 20 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a  ..** </dd>.**.**
157f0 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
15800 5f 53 51 4c 4c 4f 47 5d 5d 0a 2a 2a 20 3c 64 74  _SQLLOG]].** <dt
15810 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53  >SQLITE_CONFIG_S
15820 51 4c 4c 4f 47 0a 2a 2a 20 3c 64 64 3e 54 68 69  QLLOG.** <dd>Thi
15830 73 20 6f 70 74 69 6f 6e 20 69 73 20 6f 6e 6c 79  s option is only
15840 20 61 76 61 69 6c 61 62 6c 65 20 69 66 20 73 71   available if sq
15850 6c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c 65 64  lite is compiled
15860 20 77 69 74 68 20 74 68 65 0a 2a 2a 20 5b 53 51   with the.** [SQ
15870 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 53 51 4c 4c  LITE_ENABLE_SQLL
15880 4f 47 5d 20 70 72 65 2d 70 72 6f 63 65 73 73 6f  OG] pre-processo
15890 72 20 6d 61 63 72 6f 20 64 65 66 69 6e 65 64 2e  r macro defined.
158a0 20 54 68 65 20 66 69 72 73 74 20 61 72 67 75 6d   The first argum
158b0 65 6e 74 20 73 68 6f 75 6c 64 0a 2a 2a 20 62 65  ent should.** be
158c0 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20   a pointer to a 
158d0 66 75 6e 63 74 69 6f 6e 20 6f 66 20 74 79 70 65  function of type
158e0 20 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a 2c 73   void(*)(void*,s
158f0 71 6c 69 74 65 33 2a 2c 63 6f 6e 73 74 20 63 68  qlite3*,const ch
15900 61 72 2a 2c 20 69 6e 74 29 2e 0a 2a 2a 20 54 68  ar*, int)..** Th
15910 65 20 73 65 63 6f 6e 64 20 73 68 6f 75 6c 64 20  e second should 
15920 62 65 20 6f 66 20 74 79 70 65 20 28 76 6f 69 64  be of type (void
15930 2a 29 2e 20 54 68 65 20 63 61 6c 6c 62 61 63 6b  *). The callback
15940 20 69 73 20 69 6e 76 6f 6b 65 64 20 62 79 20 74   is invoked by t
15950 68 65 20 6c 69 62 72 61 72 79 0a 2a 2a 20 69 6e  he library.** in
15960 20 74 68 72 65 65 20 73 65 70 61 72 61 74 65 20   three separate 
15970 63 69 72 63 75 6d 73 74 61 6e 63 65 73 2c 20 69  circumstances, i
15980 64 65 6e 74 69 66 69 65 64 20 62 79 20 74 68 65  dentified by the
15990 20 76 61 6c 75 65 20 70 61 73 73 65 64 20 61 73   value passed as
159a0 20 74 68 65 0a 2a 2a 20 66 6f 75 72 74 68 20 70   the.** fourth p
159b0 61 72 61 6d 65 74 65 72 2e 20 49 66 20 74 68 65  arameter. If the
159c0 20 66 6f 75 72 74 68 20 70 61 72 61 6d 65 74 65   fourth paramete
159d0 72 20 69 73 20 30 2c 20 74 68 65 6e 20 74 68 65  r is 0, then the
159e0 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63   database connec
159f0 74 69 6f 6e 0a 2a 2a 20 70 61 73 73 65 64 20 61  tion.** passed a
15a00 73 20 74 68 65 20 73 65 63 6f 6e 64 20 61 72 67  s the second arg
15a10 75 6d 65 6e 74 20 68 61 73 20 6a 75 73 74 20 62  ument has just b
15a20 65 65 6e 20 6f 70 65 6e 65 64 2e 20 54 68 65 20  een opened. The 
15a30 74 68 69 72 64 20 61 72 67 75 6d 65 6e 74 0a 2a  third argument.*
15a40 2a 20 70 6f 69 6e 74 73 20 74 6f 20 61 20 62 75  * points to a bu
15a50 66 66 65 72 20 63 6f 6e 74 61 69 6e 69 6e 67 20  ffer containing 
15a60 74 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20  the name of the 
15a70 6d 61 69 6e 20 64 61 74 61 62 61 73 65 20 66 69  main database fi
15a80 6c 65 2e 20 49 66 20 74 68 65 0a 2a 2a 20 66 6f  le. If the.** fo
15a90 75 72 74 68 20 70 61 72 61 6d 65 74 65 72 20 69  urth parameter i
15aa0 73 20 31 2c 20 74 68 65 6e 20 74 68 65 20 53 51  s 1, then the SQ
15ab0 4c 20 73 74 61 74 65 6d 65 6e 74 20 74 68 61 74  L statement that
15ac0 20 74 68 65 20 74 68 69 72 64 20 70 61 72 61 6d   the third param
15ad0 65 74 65 72 0a 2a 2a 20 70 6f 69 6e 74 73 20 74  eter.** points t
15ae0 6f 20 68 61 73 20 6a 75 73 74 20 62 65 65 6e 20  o has just been 
15af0 65 78 65 63 75 74 65 64 2e 20 4f 72 2c 20 69 66  executed. Or, if
15b00 20 74 68 65 20 66 6f 75 72 74 68 20 70 61 72 61   the fourth para
15b10 6d 65 74 65 72 20 69 73 20 32 2c 20 74 68 65 6e  meter is 2, then
15b20 0a 2a 2a 20 74 68 65 20 63 6f 6e 6e 65 63 74 69  .** the connecti
15b30 6f 6e 20 62 65 69 6e 67 20 70 61 73 73 65 64 20  on being passed 
15b40 61 73 20 74 68 65 20 73 65 63 6f 6e 64 20 70 61  as the second pa
15b50 72 61 6d 65 74 65 72 20 69 73 20 62 65 69 6e 67  rameter is being
15b60 20 63 6c 6f 73 65 64 2e 20 54 68 65 0a 2a 2a 20   closed. The.** 
15b70 74 68 69 72 64 20 70 61 72 61 6d 65 74 65 72 20  third parameter 
15b80 69 73 20 70 61 73 73 65 64 20 4e 55 4c 4c 20 49  is passed NULL I
15b90 6e 20 74 68 69 73 20 63 61 73 65 2e 20 20 41 6e  n this case.  An
15ba0 20 65 78 61 6d 70 6c 65 20 6f 66 20 75 73 69 6e   example of usin
15bb0 67 20 74 68 69 73 0a 2a 2a 20 63 6f 6e 66 69 67  g this.** config
15bc0 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 20 63  uration option c
15bd0 61 6e 20 62 65 20 73 65 65 6e 20 69 6e 20 74 68  an be seen in th
15be0 65 20 22 74 65 73 74 5f 73 71 6c 6c 6f 67 2e 63  e "test_sqllog.c
15bf0 22 20 73 6f 75 72 63 65 20 66 69 6c 65 20 69 6e  " source file in
15c00 0a 2a 2a 20 74 68 65 20 63 61 6e 6f 6e 69 63 61  .** the canonica
15c10 6c 20 53 51 4c 69 74 65 20 73 6f 75 72 63 65 20  l SQLite source 
15c20 74 72 65 65 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a  tree.</dd>.**.**
15c30 20 5b 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47   [[SQLITE_CONFIG
15c40 5f 4d 4d 41 50 5f 53 49 5a 45 5d 5d 0a 2a 2a 20  _MMAP_SIZE]].** 
15c50 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49  <dt>SQLITE_CONFI
15c60 47 5f 4d 4d 41 50 5f 53 49 5a 45 0a 2a 2a 20 3c  G_MMAP_SIZE.** <
15c70 64 64 3e 5e 53 51 4c 49 54 45 5f 43 4f 4e 46 49  dd>^SQLITE_CONFI
15c80 47 5f 4d 4d 41 50 5f 53 49 5a 45 20 74 61 6b 65  G_MMAP_SIZE take
15c90 73 20 74 77 6f 20 36 34 2d 62 69 74 20 69 6e 74  s two 64-bit int
15ca0 65 67 65 72 20 28 73 71 6c 69 74 65 33 5f 69 6e  eger (sqlite3_in
15cb0 74 36 34 29 20 76 61 6c 75 65 73 0a 2a 2a 20 74  t64) values.** t
15cc0 68 61 74 20 61 72 65 20 74 68 65 20 64 65 66 61  hat are the defa
15cd0 75 6c 74 20 6d 6d 61 70 20 73 69 7a 65 20 6c 69  ult mmap size li
15ce0 6d 69 74 20 28 74 68 65 20 64 65 66 61 75 6c 74  mit (the default
15cf0 20 73 65 74 74 69 6e 67 20 66 6f 72 0a 2a 2a 20   setting for.** 
15d00 5b 50 52 41 47 4d 41 20 6d 6d 61 70 5f 73 69 7a  [PRAGMA mmap_siz
15d10 65 5d 29 20 61 6e 64 20 74 68 65 20 6d 61 78 69  e]) and the maxi
15d20 6d 75 6d 20 61 6c 6c 6f 77 65 64 20 6d 6d 61 70  mum allowed mmap
15d30 20 73 69 7a 65 20 6c 69 6d 69 74 2e 0a 2a 2a 20   size limit..** 
15d40 5e 54 68 65 20 64 65 66 61 75 6c 74 20 73 65 74  ^The default set
15d50 74 69 6e 67 20 63 61 6e 20 62 65 20 6f 76 65 72  ting can be over
15d60 72 69 64 64 65 6e 20 62 79 20 65 61 63 68 20 64  ridden by each d
15d70 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
15d80 6f 6e 20 75 73 69 6e 67 0a 2a 2a 20 65 69 74 68  on using.** eith
15d90 65 72 20 74 68 65 20 5b 50 52 41 47 4d 41 20 6d  er the [PRAGMA m
15da0 6d 61 70 5f 73 69 7a 65 5d 20 63 6f 6d 6d 61 6e  map_size] comman
15db0 64 2c 20 6f 72 20 62 79 20 75 73 69 6e 67 20 74  d, or by using t
15dc0 68 65 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 46 43  he.** [SQLITE_FC
15dd0 4e 54 4c 5f 4d 4d 41 50 5f 53 49 5a 45 5d 20 66  NTL_MMAP_SIZE] f
15de0 69 6c 65 20 63 6f 6e 74 72 6f 6c 2e 20 20 5e 28  ile control.  ^(
15df0 54 68 65 20 6d 61 78 69 6d 75 6d 20 61 6c 6c 6f  The maximum allo
15e00 77 65 64 20 6d 6d 61 70 20 73 69 7a 65 0a 2a 2a  wed mmap size.**
15e10 20 77 69 6c 6c 20 62 65 20 73 69 6c 65 6e 74 6c   will be silentl
15e20 79 20 74 72 75 6e 63 61 74 65 64 20 69 66 20 6e  y truncated if n
15e30 65 63 65 73 73 61 72 79 20 73 6f 20 74 68 61 74  ecessary so that
15e40 20 69 74 20 64 6f 65 73 20 6e 6f 74 20 65 78 63   it does not exc
15e50 65 65 64 20 74 68 65 0a 2a 2a 20 63 6f 6d 70 69  eed the.** compi
15e60 6c 65 2d 74 69 6d 65 20 6d 61 78 69 6d 75 6d 20  le-time maximum 
15e70 6d 6d 61 70 20 73 69 7a 65 20 73 65 74 20 62 79  mmap size set by
15e80 20 74 68 65 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f   the.** [SQLITE_
15e90 4d 41 58 5f 4d 4d 41 50 5f 53 49 5a 45 5d 20 63  MAX_MMAP_SIZE] c
15ea0 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69  ompile-time opti
15eb0 6f 6e 2e 29 5e 0a 2a 2a 20 5e 49 66 20 65 69 74  on.)^.** ^If eit
15ec0 68 65 72 20 61 72 67 75 6d 65 6e 74 20 74 6f 20  her argument to 
15ed0 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 6e  this option is n
15ee0 65 67 61 74 69 76 65 2c 20 74 68 65 6e 20 74 68  egative, then th
15ef0 61 74 20 61 72 67 75 6d 65 6e 74 20 69 73 0a 2a  at argument is.*
15f00 2a 20 63 68 61 6e 67 65 64 20 74 6f 20 69 74 73  * changed to its
15f10 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 64 65   compile-time de
15f20 66 61 75 6c 74 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 53  fault..**.** [[S
15f30 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 57 49 4e  QLITE_CONFIG_WIN
15f40 33 32 5f 48 45 41 50 53 49 5a 45 5d 5d 0a 2a 2a  32_HEAPSIZE]].**
15f50 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46   <dt>SQLITE_CONF
15f60 49 47 5f 57 49 4e 33 32 5f 48 45 41 50 53 49 5a  IG_WIN32_HEAPSIZ
15f70 45 0a 2a 2a 20 3c 64 64 3e 5e 54 68 65 20 53 51  E.** <dd>^The SQ
15f80 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 57 49 4e 33  LITE_CONFIG_WIN3
15f90 32 5f 48 45 41 50 53 49 5a 45 20 6f 70 74 69 6f  2_HEAPSIZE optio
15fa0 6e 20 69 73 20 6f 6e 6c 79 20 61 76 61 69 6c 61  n is only availa
15fb0 62 6c 65 20 69 66 20 53 51 4c 69 74 65 20 69 73  ble if SQLite is
15fc0 0a 2a 2a 20 63 6f 6d 70 69 6c 65 64 20 66 6f 72  .** compiled for
15fd0 20 57 69 6e 64 6f 77 73 20 77 69 74 68 20 74 68   Windows with th
15fe0 65 20 5b 53 51 4c 49 54 45 5f 57 49 4e 33 32 5f  e [SQLITE_WIN32_
15ff0 4d 41 4c 4c 4f 43 5d 20 70 72 65 2d 70 72 6f 63  MALLOC] pre-proc
16000 65 73 73 6f 72 20 6d 61 63 72 6f 0a 2a 2a 20 64  essor macro.** d
16010 65 66 69 6e 65 64 2e 20 5e 53 51 4c 49 54 45 5f  efined. ^SQLITE_
16020 43 4f 4e 46 49 47 5f 57 49 4e 33 32 5f 48 45 41  CONFIG_WIN32_HEA
16030 50 53 49 5a 45 20 74 61 6b 65 73 20 61 20 33 32  PSIZE takes a 32
16040 2d 62 69 74 20 75 6e 73 69 67 6e 65 64 20 69 6e  -bit unsigned in
16050 74 65 67 65 72 20 76 61 6c 75 65 0a 2a 2a 20 74  teger value.** t
16060 68 61 74 20 73 70 65 63 69 66 69 65 73 20 74 68  hat specifies th
16070 65 20 6d 61 78 69 6d 75 6d 20 73 69 7a 65 20 6f  e maximum size o
16080 66 20 74 68 65 20 63 72 65 61 74 65 64 20 68 65  f the created he
16090 61 70 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49  ap..**.** [[SQLI
160a0 54 45 5f 43 4f 4e 46 49 47 5f 50 43 41 43 48 45  TE_CONFIG_PCACHE
160b0 5f 48 44 52 53 5a 5d 5d 0a 2a 2a 20 3c 64 74 3e  _HDRSZ]].** <dt>
160c0 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 43  SQLITE_CONFIG_PC
160d0 41 43 48 45 5f 48 44 52 53 5a 0a 2a 2a 20 3c 64  ACHE_HDRSZ.** <d
160e0 64 3e 5e 54 68 65 20 53 51 4c 49 54 45 5f 43 4f  d>^The SQLITE_CO
160f0 4e 46 49 47 5f 50 43 41 43 48 45 5f 48 44 52 53  NFIG_PCACHE_HDRS
16100 5a 20 6f 70 74 69 6f 6e 20 74 61 6b 65 73 20 61  Z option takes a
16110 20 73 69 6e 67 6c 65 20 70 61 72 61 6d 65 74 65   single paramete
16120 72 20 77 68 69 63 68 0a 2a 2a 20 69 73 20 61 20  r which.** is a 
16130 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 69 6e  pointer to an in
16140 74 65 67 65 72 20 61 6e 64 20 77 72 69 74 65 73  teger and writes
16150 20 69 6e 74 6f 20 74 68 61 74 20 69 6e 74 65 67   into that integ
16160 65 72 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  er the number of
16170 20 65 78 74 72 61 0a 2a 2a 20 62 79 74 65 73 20   extra.** bytes 
16180 70 65 72 20 70 61 67 65 20 72 65 71 75 69 72 65  per page require
16190 64 20 66 6f 72 20 65 61 63 68 20 70 61 67 65 20  d for each page 
161a0 69 6e 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49  in [SQLITE_CONFI
161b0 47 5f 50 41 47 45 43 41 43 48 45 5d 2e 0a 2a 2a  G_PAGECACHE]..**
161c0 20 54 68 65 20 61 6d 6f 75 6e 74 20 6f 66 20 65   The amount of e
161d0 78 74 72 61 20 73 70 61 63 65 20 72 65 71 75 69  xtra space requi
161e0 72 65 64 20 63 61 6e 20 63 68 61 6e 67 65 20 64  red can change d
161f0 65 70 65 6e 64 69 6e 67 20 6f 6e 20 74 68 65 20  epending on the 
16200 63 6f 6d 70 69 6c 65 72 2c 0a 2a 2a 20 74 61 72  compiler,.** tar
16210 67 65 74 20 70 6c 61 74 66 6f 72 6d 2c 20 61 6e  get platform, an
16220 64 20 53 51 4c 69 74 65 20 76 65 72 73 69 6f 6e  d SQLite version
16230 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45  ..**.** [[SQLITE
16240 5f 43 4f 4e 46 49 47 5f 50 4d 41 53 5a 5d 5d 0a  _CONFIG_PMASZ]].
16250 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f  ** <dt>SQLITE_CO
16260 4e 46 49 47 5f 50 4d 41 53 5a 0a 2a 2a 20 3c 64  NFIG_PMASZ.** <d
16270 64 3e 5e 54 68 65 20 53 51 4c 49 54 45 5f 43 4f  d>^The SQLITE_CO
16280 4e 46 49 47 5f 50 4d 41 53 5a 20 6f 70 74 69 6f  NFIG_PMASZ optio
16290 6e 20 74 61 6b 65 73 20 61 20 73 69 6e 67 6c 65  n takes a single
162a0 20 70 61 72 61 6d 65 74 65 72 20 77 68 69 63 68   parameter which
162b0 0a 2a 2a 20 69 73 20 61 6e 20 75 6e 73 69 67 6e  .** is an unsign
162c0 65 64 20 69 6e 74 65 67 65 72 20 61 6e 64 20 73  ed integer and s
162d0 65 74 73 20 74 68 65 20 22 4d 69 6e 69 6d 75 6d  ets the "Minimum
162e0 20 50 4d 41 20 53 69 7a 65 22 20 66 6f 72 20 74   PMA Size" for t
162f0 68 65 20 6d 75 6c 74 69 74 68 72 65 61 64 65 64  he multithreaded
16300 0a 2a 2a 20 73 6f 72 74 65 72 20 74 6f 20 74 68  .** sorter to th
16310 61 74 20 69 6e 74 65 67 65 72 2e 20 20 54 68 65  at integer.  The
16320 20 64 65 66 61 75 6c 74 20 6d 69 6e 69 6d 75 6d   default minimum
16330 20 50 4d 41 20 53 69 7a 65 20 69 73 20 73 65 74   PMA Size is set
16340 20 62 79 20 74 68 65 0a 2a 2a 20 5b 53 51 4c 49   by the.** [SQLI
16350 54 45 5f 53 4f 52 54 45 52 5f 50 4d 41 53 5a 5d  TE_SORTER_PMASZ]
16360 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70   compile-time op
16370 74 69 6f 6e 2e 20 20 4e 65 77 20 74 68 72 65 61  tion.  New threa
16380 64 73 20 61 72 65 20 6c 61 75 6e 63 68 65 64 0a  ds are launched.
16390 2a 2a 20 74 6f 20 68 65 6c 70 20 77 69 74 68 20  ** to help with 
163a0 73 6f 72 74 20 6f 70 65 72 61 74 69 6f 6e 73 20  sort operations 
163b0 77 68 65 6e 20 6d 75 6c 74 69 74 68 72 65 61 64  when multithread
163c0 65 64 20 73 6f 72 74 69 6e 67 0a 2a 2a 20 69 73  ed sorting.** is
163d0 20 65 6e 61 62 6c 65 64 20 28 75 73 69 6e 67 20   enabled (using 
163e0 74 68 65 20 5b 50 52 41 47 4d 41 20 74 68 72 65  the [PRAGMA thre
163f0 61 64 73 5d 20 63 6f 6d 6d 61 6e 64 29 20 61 6e  ads] command) an
16400 64 20 74 68 65 20 61 6d 6f 75 6e 74 20 6f 66 20  d the amount of 
16410 63 6f 6e 74 65 6e 74 0a 2a 2a 20 74 6f 20 62 65  content.** to be
16420 20 73 6f 72 74 65 64 20 65 78 63 65 65 64 73 20   sorted exceeds 
16430 74 68 65 20 70 61 67 65 20 73 69 7a 65 20 74 69  the page size ti
16440 6d 65 73 20 74 68 65 20 6d 69 6e 69 6d 75 6d 20  mes the minimum 
16450 6f 66 20 74 68 65 0a 2a 2a 20 5b 50 52 41 47 4d  of the.** [PRAGM
16460 41 20 63 61 63 68 65 5f 73 69 7a 65 5d 20 73 65  A cache_size] se
16470 74 74 69 6e 67 20 61 6e 64 20 74 68 69 73 20 76  tting and this v
16480 61 6c 75 65 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51  alue..**.** [[SQ
16490 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 54 4d 54  LITE_CONFIG_STMT
164a0 4a 52 4e 4c 5f 53 50 49 4c 4c 5d 5d 0a 2a 2a 20  JRNL_SPILL]].** 
164b0 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49  <dt>SQLITE_CONFI
164c0 47 5f 53 54 4d 54 4a 52 4e 4c 5f 53 50 49 4c 4c  G_STMTJRNL_SPILL
164d0 0a 2a 2a 20 3c 64 64 3e 5e 54 68 65 20 53 51 4c  .** <dd>^The SQL
164e0 49 54 45 5f 43 4f 4e 46 49 47 5f 53 54 4d 54 4a  ITE_CONFIG_STMTJ
164f0 52 4e 4c 5f 53 50 49 4c 4c 20 6f 70 74 69 6f 6e  RNL_SPILL option
16500 20 74 61 6b 65 73 20 61 20 73 69 6e 67 6c 65 20   takes a single 
16510 70 61 72 61 6d 65 74 65 72 20 77 68 69 63 68 0a  parameter which.
16520 2a 2a 20 62 65 63 6f 6d 65 73 20 74 68 65 20 5b  ** becomes the [
16530 73 74 61 74 65 6d 65 6e 74 20 6a 6f 75 72 6e 61  statement journa
16540 6c 5d 20 73 70 69 6c 6c 2d 74 6f 2d 64 69 73 6b  l] spill-to-disk
16550 20 74 68 72 65 73 68 6f 6c 64 2e 20 20 0a 2a 2a   threshold.  .**
16560 20 5b 53 74 61 74 65 6d 65 6e 74 20 6a 6f 75 72   [Statement jour
16570 6e 61 6c 73 5d 20 61 72 65 20 68 65 6c 64 20 69  nals] are held i
16580 6e 20 6d 65 6d 6f 72 79 20 75 6e 74 69 6c 20 74  n memory until t
16590 68 65 69 72 20 73 69 7a 65 20 28 69 6e 20 62 79  heir size (in by
165a0 74 65 73 29 0a 2a 2a 20 65 78 63 65 65 64 73 20  tes).** exceeds 
165b0 74 68 69 73 20 74 68 72 65 73 68 6f 6c 64 2c 20  this threshold, 
165c0 61 74 20 77 68 69 63 68 20 70 6f 69 6e 74 20 74  at which point t
165d0 68 65 79 20 61 72 65 20 77 72 69 74 74 65 6e 20  hey are written 
165e0 74 6f 20 64 69 73 6b 2e 0a 2a 2a 20 4f 72 20 69  to disk..** Or i
165f0 66 20 74 68 65 20 74 68 72 65 73 68 6f 6c 64 20  f the threshold 
16600 69 73 20 2d 31 2c 20 73 74 61 74 65 6d 65 6e 74  is -1, statement
16610 20 6a 6f 75 72 6e 61 6c 73 20 61 72 65 20 61 6c   journals are al
16620 77 61 79 73 20 68 65 6c 64 0a 2a 2a 20 65 78 63  ways held.** exc
16630 6c 75 73 69 76 65 6c 79 20 69 6e 20 6d 65 6d 6f  lusively in memo
16640 72 79 2e 0a 2a 2a 20 53 69 6e 63 65 20 6d 61 6e  ry..** Since man
16650 79 20 73 74 61 74 65 6d 65 6e 74 20 6a 6f 75 72  y statement jour
16660 6e 61 6c 73 20 6e 65 76 65 72 20 62 65 63 6f 6d  nals never becom
16670 65 20 6c 61 72 67 65 2c 20 73 65 74 74 69 6e 67  e large, setting
16680 20 74 68 65 20 73 70 69 6c 6c 0a 2a 2a 20 74 68   the spill.** th
16690 72 65 73 68 6f 6c 64 20 74 6f 20 61 20 76 61 6c  reshold to a val
166a0 75 65 20 73 75 63 68 20 61 73 20 36 34 4b 69 42  ue such as 64KiB
166b0 20 63 61 6e 20 67 72 65 61 74 6c 79 20 72 65 64   can greatly red
166c0 75 63 65 20 74 68 65 20 61 6d 6f 75 6e 74 20 6f  uce the amount o
166d0 66 0a 2a 2a 20 49 2f 4f 20 72 65 71 75 69 72 65  f.** I/O require
166e0 64 20 74 6f 20 73 75 70 70 6f 72 74 20 73 74 61  d to support sta
166f0 74 65 6d 65 6e 74 20 72 6f 6c 6c 62 61 63 6b 2e  tement rollback.
16700 0a 2a 2a 20 54 68 65 20 64 65 66 61 75 6c 74 20  .** The default 
16710 76 61 6c 75 65 20 66 6f 72 20 74 68 69 73 20 73  value for this s
16720 65 74 74 69 6e 67 20 69 73 20 63 6f 6e 74 72 6f  etting is contro
16730 6c 6c 65 64 20 62 79 20 74 68 65 0a 2a 2a 20 5b  lled by the.** [
16740 53 51 4c 49 54 45 5f 53 54 4d 54 4a 52 4e 4c 5f  SQLITE_STMTJRNL_
16750 53 50 49 4c 4c 5d 20 63 6f 6d 70 69 6c 65 2d 74  SPILL] compile-t
16760 69 6d 65 20 6f 70 74 69 6f 6e 2e 0a 2a 2a 20 3c  ime option..** <
16770 2f 64 6c 3e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20  /dl>.*/.#define 
16780 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 49  SQLITE_CONFIG_SI
16790 4e 47 4c 45 54 48 52 45 41 44 20 20 31 20 20 2f  NGLETHREAD  1  /
167a0 2a 20 6e 69 6c 20 2a 2f 0a 23 64 65 66 69 6e 65  * nil */.#define
167b0 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d   SQLITE_CONFIG_M
167c0 55 4c 54 49 54 48 52 45 41 44 20 20 20 32 20 20  ULTITHREAD   2  
167d0 2f 2a 20 6e 69 6c 20 2a 2f 0a 23 64 65 66 69 6e  /* nil */.#defin
167e0 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  e SQLITE_CONFIG_
167f0 53 45 52 49 41 4c 49 5a 45 44 20 20 20 20 33 20  SERIALIZED    3 
16800 20 2f 2a 20 6e 69 6c 20 2a 2f 0a 23 64 65 66 69   /* nil */.#defi
16810 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47  ne SQLITE_CONFIG
16820 5f 4d 41 4c 4c 4f 43 20 20 20 20 20 20 20 20 34  _MALLOC        4
16830 20 20 2f 2a 20 73 71 6c 69 74 65 33 5f 6d 65 6d    /* sqlite3_mem
16840 5f 6d 65 74 68 6f 64 73 2a 20 2a 2f 0a 23 64 65  _methods* */.#de
16850 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46  fine SQLITE_CONF
16860 49 47 5f 47 45 54 4d 41 4c 4c 4f 43 20 20 20 20  IG_GETMALLOC    
16870 20 35 20 20 2f 2a 20 73 71 6c 69 74 65 33 5f 6d   5  /* sqlite3_m
16880 65 6d 5f 6d 65 74 68 6f 64 73 2a 20 2a 2f 0a 23  em_methods* */.#
16890 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f  define SQLITE_CO
168a0 4e 46 49 47 5f 53 43 52 41 54 43 48 20 20 20 20  NFIG_SCRATCH    
168b0 20 20 20 36 20 20 2f 2a 20 76 6f 69 64 2a 2c 20     6  /* void*, 
168c0 69 6e 74 20 73 7a 2c 20 69 6e 74 20 4e 20 2a 2f  int sz, int N */
168d0 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
168e0 43 4f 4e 46 49 47 5f 50 41 47 45 43 41 43 48 45  CONFIG_PAGECACHE
168f0 20 20 20 20 20 37 20 20 2f 2a 20 76 6f 69 64 2a       7  /* void*
16900 2c 20 69 6e 74 20 73 7a 2c 20 69 6e 74 20 4e 20  , int sz, int N 
16910 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
16920 45 5f 43 4f 4e 46 49 47 5f 48 45 41 50 20 20 20  E_CONFIG_HEAP   
16930 20 20 20 20 20 20 20 38 20 20 2f 2a 20 76 6f 69         8  /* voi
16940 64 2a 2c 20 69 6e 74 20 6e 42 79 74 65 2c 20 69  d*, int nByte, i
16950 6e 74 20 6d 69 6e 20 2a 2f 0a 23 64 65 66 69 6e  nt min */.#defin
16960 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  e SQLITE_CONFIG_
16970 4d 45 4d 53 54 41 54 55 53 20 20 20 20 20 39 20  MEMSTATUS     9 
16980 20 2f 2a 20 62 6f 6f 6c 65 61 6e 20 2a 2f 0a 23   /* boolean */.#
16990 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f  define SQLITE_CO
169a0 4e 46 49 47 5f 4d 55 54 45 58 20 20 20 20 20 20  NFIG_MUTEX      
169b0 20 20 31 30 20 20 2f 2a 20 73 71 6c 69 74 65 33    10  /* sqlite3
169c0 5f 6d 75 74 65 78 5f 6d 65 74 68 6f 64 73 2a 20  _mutex_methods* 
169d0 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
169e0 45 5f 43 4f 4e 46 49 47 5f 47 45 54 4d 55 54 45  E_CONFIG_GETMUTE
169f0 58 20 20 20 20 20 31 31 20 20 2f 2a 20 73 71 6c  X     11  /* sql
16a00 69 74 65 33 5f 6d 75 74 65 78 5f 6d 65 74 68 6f  ite3_mutex_metho
16a10 64 73 2a 20 2a 2f 0a 2f 2a 20 70 72 65 76 69 6f  ds* */./* previo
16a20 75 73 6c 79 20 53 51 4c 49 54 45 5f 43 4f 4e 46  usly SQLITE_CONF
16a30 49 47 5f 43 48 55 4e 4b 41 4c 4c 4f 43 20 31 32  IG_CHUNKALLOC 12
16a40 20 77 68 69 63 68 20 69 73 20 6e 6f 77 20 75 6e   which is now un
16a50 75 73 65 64 2e 20 2a 2f 20 0a 23 64 65 66 69 6e  used. */ .#defin
16a60 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  e SQLITE_CONFIG_
16a70 4c 4f 4f 4b 41 53 49 44 45 20 20 20 20 31 33 20  LOOKASIDE    13 
16a80 20 2f 2a 20 69 6e 74 20 69 6e 74 20 2a 2f 0a 23   /* int int */.#
16a90 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f  define SQLITE_CO
16aa0 4e 46 49 47 5f 50 43 41 43 48 45 20 20 20 20 20  NFIG_PCACHE     
16ab0 20 20 31 34 20 20 2f 2a 20 6e 6f 2d 6f 70 20 2a    14  /* no-op *
16ac0 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
16ad0 5f 43 4f 4e 46 49 47 5f 47 45 54 50 43 41 43 48  _CONFIG_GETPCACH
16ae0 45 20 20 20 20 31 35 20 20 2f 2a 20 6e 6f 2d 6f  E    15  /* no-o
16af0 70 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  p */.#define SQL
16b00 49 54 45 5f 43 4f 4e 46 49 47 5f 4c 4f 47 20 20  ITE_CONFIG_LOG  
16b10 20 20 20 20 20 20 20 20 31 36 20 20 2f 2a 20 78          16  /* x
16b20 46 75 6e 63 2c 20 76 6f 69 64 2a 20 2a 2f 0a 23  Func, void* */.#
16b30 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f  define SQLITE_CO
16b40 4e 46 49 47 5f 55 52 49 20 20 20 20 20 20 20 20  NFIG_URI        
16b50 20 20 31 37 20 20 2f 2a 20 69 6e 74 20 2a 2f 0a    17  /* int */.
16b60 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43  #define SQLITE_C
16b70 4f 4e 46 49 47 5f 50 43 41 43 48 45 32 20 20 20  ONFIG_PCACHE2   
16b80 20 20 20 31 38 20 20 2f 2a 20 73 71 6c 69 74 65     18  /* sqlite
16b90 33 5f 70 63 61 63 68 65 5f 6d 65 74 68 6f 64 73  3_pcache_methods
16ba0 32 2a 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  2* */.#define SQ
16bb0 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 50  LITE_CONFIG_GETP
16bc0 43 41 43 48 45 32 20 20 20 31 39 20 20 2f 2a 20  CACHE2   19  /* 
16bd0 73 71 6c 69 74 65 33 5f 70 63 61 63 68 65 5f 6d  sqlite3_pcache_m
16be0 65 74 68 6f 64 73 32 2a 20 2a 2f 0a 23 64 65 66  ethods2* */.#def
16bf0 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  ine SQLITE_CONFI
16c00 47 5f 43 4f 56 45 52 49 4e 47 5f 49 4e 44 45 58  G_COVERING_INDEX
16c10 5f 53 43 41 4e 20 32 30 20 20 2f 2a 20 69 6e 74  _SCAN 20  /* int
16c20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
16c30 54 45 5f 43 4f 4e 46 49 47 5f 53 51 4c 4c 4f 47  TE_CONFIG_SQLLOG
16c40 20 20 20 20 20 20 20 32 31 20 20 2f 2a 20 78 53         21  /* xS
16c50 71 6c 6c 6f 67 2c 20 76 6f 69 64 2a 20 2a 2f 0a  qllog, void* */.
16c60 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43  #define SQLITE_C
16c70 4f 4e 46 49 47 5f 4d 4d 41 50 5f 53 49 5a 45 20  ONFIG_MMAP_SIZE 
16c80 20 20 20 32 32 20 20 2f 2a 20 73 71 6c 69 74 65     22  /* sqlite
16c90 33 5f 69 6e 74 36 34 2c 20 73 71 6c 69 74 65 33  3_int64, sqlite3
16ca0 5f 69 6e 74 36 34 20 2a 2f 0a 23 64 65 66 69 6e  _int64 */.#defin
16cb0 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  e SQLITE_CONFIG_
16cc0 57 49 4e 33 32 5f 48 45 41 50 53 49 5a 45 20 20  WIN32_HEAPSIZE  
16cd0 20 20 20 20 32 33 20 20 2f 2a 20 69 6e 74 20 6e      23  /* int n
16ce0 42 79 74 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20  Byte */.#define 
16cf0 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 43  SQLITE_CONFIG_PC
16d00 41 43 48 45 5f 48 44 52 53 5a 20 20 20 20 20 20  ACHE_HDRSZ      
16d10 20 20 32 34 20 20 2f 2a 20 69 6e 74 20 2a 70 73    24  /* int *ps
16d20 7a 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  z */.#define SQL
16d30 49 54 45 5f 43 4f 4e 46 49 47 5f 50 4d 41 53 5a  ITE_CONFIG_PMASZ
16d40 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 32                 2
16d50 35 20 20 2f 2a 20 75 6e 73 69 67 6e 65 64 20 69  5  /* unsigned i
16d60 6e 74 20 73 7a 50 6d 61 20 2a 2f 0a 23 64 65 66  nt szPma */.#def
16d70 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  ine SQLITE_CONFI
16d80 47 5f 53 54 4d 54 4a 52 4e 4c 5f 53 50 49 4c 4c  G_STMTJRNL_SPILL
16d90 20 20 20 20 20 20 32 36 20 20 2f 2a 20 69 6e 74        26  /* int
16da0 20 6e 42 79 74 65 20 2a 2f 0a 0a 2f 2a 0a 2a 2a   nByte */../*.**
16db0 20 43 41 50 49 33 52 45 46 3a 20 44 61 74 61 62   CAPI3REF: Datab
16dc0 61 73 65 20 43 6f 6e 6e 65 63 74 69 6f 6e 20 43  ase Connection C
16dd0 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 4f 70 74  onfiguration Opt
16de0 69 6f 6e 73 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65  ions.**.** These
16df0 20 63 6f 6e 73 74 61 6e 74 73 20 61 72 65 20 74   constants are t
16e00 68 65 20 61 76 61 69 6c 61 62 6c 65 20 69 6e 74  he available int
16e10 65 67 65 72 20 63 6f 6e 66 69 67 75 72 61 74 69  eger configurati
16e20 6f 6e 20 6f 70 74 69 6f 6e 73 20 74 68 61 74 0a  on options that.
16e30 2a 2a 20 63 61 6e 20 62 65 20 70 61 73 73 65 64  ** can be passed
16e40 20 61 73 20 74 68 65 20 73 65 63 6f 6e 64 20 61   as the second a
16e50 72 67 75 6d 65 6e 74 20 74 6f 20 74 68 65 20 5b  rgument to the [
16e60 73 71 6c 69 74 65 33 5f 64 62 5f 63 6f 6e 66 69  sqlite3_db_confi
16e70 67 28 29 5d 20 69 6e 74 65 72 66 61 63 65 2e 0a  g()] interface..
16e80 2a 2a 0a 2a 2a 20 4e 65 77 20 63 6f 6e 66 69 67  **.** New config
16e90 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 73 20  uration options 
16ea0 6d 61 79 20 62 65 20 61 64 64 65 64 20 69 6e 20  may be added in 
16eb0 66 75 74 75 72 65 20 72 65 6c 65 61 73 65 73 20  future releases 
16ec0 6f 66 20 53 51 4c 69 74 65 2e 0a 2a 2a 20 45 78  of SQLite..** Ex
16ed0 69 73 74 69 6e 67 20 63 6f 6e 66 69 67 75 72 61  isting configura
16ee0 74 69 6f 6e 20 6f 70 74 69 6f 6e 73 20 6d 69 67  tion options mig
16ef0 68 74 20 62 65 20 64 69 73 63 6f 6e 74 69 6e 75  ht be discontinu
16f00 65 64 2e 20 20 41 70 70 6c 69 63 61 74 69 6f 6e  ed.  Application
16f10 73 0a 2a 2a 20 73 68 6f 75 6c 64 20 63 68 65 63  s.** should chec
16f20 6b 20 74 68 65 20 72 65 74 75 72 6e 20 63 6f 64  k the return cod
16f30 65 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f  e from [sqlite3_
16f40 64 62 5f 63 6f 6e 66 69 67 28 29 5d 20 74 6f 20  db_config()] to 
16f50 6d 61 6b 65 20 73 75 72 65 20 74 68 61 74 0a 2a  make sure that.*
16f60 2a 20 74 68 65 20 63 61 6c 6c 20 77 6f 72 6b 65  * the call worke
16f70 64 2e 20 20 5e 54 68 65 20 5b 73 71 6c 69 74 65  d.  ^The [sqlite
16f80 33 5f 64 62 5f 63 6f 6e 66 69 67 28 29 5d 20 69  3_db_config()] i
16f90 6e 74 65 72 66 61 63 65 20 77 69 6c 6c 20 72 65  nterface will re
16fa0 74 75 72 6e 20 61 0a 2a 2a 20 6e 6f 6e 2d 7a 65  turn a.** non-ze
16fb0 72 6f 20 5b 65 72 72 6f 72 20 63 6f 64 65 5d 20  ro [error code] 
16fc0 69 66 20 61 20 64 69 73 63 6f 6e 74 69 6e 75 65  if a discontinue
16fd0 64 20 6f 72 20 75 6e 73 75 70 70 6f 72 74 65 64  d or unsupported
16fe0 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f   configuration o
16ff0 70 74 69 6f 6e 0a 2a 2a 20 69 73 20 69 6e 76 6f  ption.** is invo
17000 6b 65 64 2e 0a 2a 2a 0a 2a 2a 20 3c 64 6c 3e 0a  ked..**.** <dl>.
17010 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f 44 42  ** <dt>SQLITE_DB
17020 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49 44 45  CONFIG_LOOKASIDE
17030 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 54  </dt>.** <dd> ^T
17040 68 69 73 20 6f 70 74 69 6f 6e 20 74 61 6b 65 73  his option takes
17050 20 74 68 72 65 65 20 61 64 64 69 74 69 6f 6e 61   three additiona
17060 6c 20 61 72 67 75 6d 65 6e 74 73 20 74 68 61 74  l arguments that
17070 20 64 65 74 65 72 6d 69 6e 65 20 74 68 65 20 0a   determine the .
17080 2a 2a 20 5b 6c 6f 6f 6b 61 73 69 64 65 20 6d 65  ** [lookaside me
17090 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 5d 20  mory allocator] 
170a0 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 66 6f  configuration fo
170b0 72 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20  r the [database 
170c0 63 6f 6e 6e 65 63 74 69 6f 6e 5d 2e 0a 2a 2a 20  connection]..** 
170d0 5e 54 68 65 20 66 69 72 73 74 20 61 72 67 75 6d  ^The first argum
170e0 65 6e 74 20 28 74 68 65 20 74 68 69 72 64 20 70  ent (the third p
170f0 61 72 61 6d 65 74 65 72 20 74 6f 20 5b 73 71 6c  arameter to [sql
17100 69 74 65 33 5f 64 62 5f 63 6f 6e 66 69 67 28 29  ite3_db_config()
17110 5d 20 69 73 20 61 0a 2a 2a 20 70 6f 69 6e 74 65  ] is a.** pointe
17120 72 20 74 6f 20 61 20 6d 65 6d 6f 72 79 20 62 75  r to a memory bu
17130 66 66 65 72 20 74 6f 20 75 73 65 20 66 6f 72 20  ffer to use for 
17140 6c 6f 6f 6b 61 73 69 64 65 20 6d 65 6d 6f 72 79  lookaside memory
17150 2e 0a 2a 2a 20 5e 54 68 65 20 66 69 72 73 74 20  ..** ^The first 
17160 61 72 67 75 6d 65 6e 74 20 61 66 74 65 72 20 74  argument after t
17170 68 65 20 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46  he SQLITE_DBCONF
17180 49 47 5f 4c 4f 4f 4b 41 53 49 44 45 20 76 65 72  IG_LOOKASIDE ver
17190 62 0a 2a 2a 20 6d 61 79 20 62 65 20 4e 55 4c 4c  b.** may be NULL
171a0 20 69 6e 20 77 68 69 63 68 20 63 61 73 65 20 53   in which case S
171b0 51 4c 69 74 65 20 77 69 6c 6c 20 61 6c 6c 6f 63  QLite will alloc
171c0 61 74 65 20 74 68 65 0a 2a 2a 20 6c 6f 6f 6b 61  ate the.** looka
171d0 73 69 64 65 20 62 75 66 66 65 72 20 69 74 73 65  side buffer itse
171e0 6c 66 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65  lf using [sqlite
171f0 33 5f 6d 61 6c 6c 6f 63 28 29 5d 2e 20 5e 54 68  3_malloc()]. ^Th
17200 65 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e  e second argumen
17210 74 20 69 73 20 74 68 65 0a 2a 2a 20 73 69 7a 65  t is the.** size
17220 20 6f 66 20 65 61 63 68 20 6c 6f 6f 6b 61 73 69   of each lookasi
17230 64 65 20 62 75 66 66 65 72 20 73 6c 6f 74 2e 20  de buffer slot. 
17240 20 5e 54 68 65 20 74 68 69 72 64 20 61 72 67 75   ^The third argu
17250 6d 65 6e 74 20 69 73 20 74 68 65 20 6e 75 6d 62  ment is the numb
17260 65 72 20 6f 66 0a 2a 2a 20 73 6c 6f 74 73 2e 20  er of.** slots. 
17270 20 54 68 65 20 73 69 7a 65 20 6f 66 20 74 68 65   The size of the
17280 20 62 75 66 66 65 72 20 69 6e 20 74 68 65 20 66   buffer in the f
17290 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 6d 75  irst argument mu
172a0 73 74 20 62 65 20 67 72 65 61 74 65 72 20 74 68  st be greater th
172b0 61 6e 0a 2a 2a 20 6f 72 20 65 71 75 61 6c 20 74  an.** or equal t
172c0 6f 20 74 68 65 20 70 72 6f 64 75 63 74 20 6f 66  o the product of
172d0 20 74 68 65 20 73 65 63 6f 6e 64 20 61 6e 64 20   the second and 
172e0 74 68 69 72 64 20 61 72 67 75 6d 65 6e 74 73 2e  third arguments.
172f0 20 20 54 68 65 20 62 75 66 66 65 72 0a 2a 2a 20    The buffer.** 
17300 6d 75 73 74 20 62 65 20 61 6c 69 67 6e 65 64 20  must be aligned 
17310 74 6f 20 61 6e 20 38 2d 62 79 74 65 20 62 6f 75  to an 8-byte bou
17320 6e 64 61 72 79 2e 20 20 5e 49 66 20 74 68 65 20  ndary.  ^If the 
17330 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20  second argument 
17340 74 6f 0a 2a 2a 20 53 51 4c 49 54 45 5f 44 42 43  to.** SQLITE_DBC
17350 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49 44 45 20  ONFIG_LOOKASIDE 
17360 69 73 20 6e 6f 74 20 61 20 6d 75 6c 74 69 70 6c  is not a multipl
17370 65 20 6f 66 20 38 2c 20 69 74 20 69 73 20 69 6e  e of 8, it is in
17380 74 65 72 6e 61 6c 6c 79 0a 2a 2a 20 72 6f 75 6e  ternally.** roun
17390 64 65 64 20 64 6f 77 6e 20 74 6f 20 74 68 65 20  ded down to the 
173a0 6e 65 78 74 20 73 6d 61 6c 6c 65 72 20 6d 75 6c  next smaller mul
173b0 74 69 70 6c 65 20 6f 66 20 38 2e 20 20 5e 28 54  tiple of 8.  ^(T
173c0 68 65 20 6c 6f 6f 6b 61 73 69 64 65 20 6d 65 6d  he lookaside mem
173d0 6f 72 79 0a 2a 2a 20 63 6f 6e 66 69 67 75 72 61  ory.** configura
173e0 74 69 6f 6e 20 66 6f 72 20 61 20 64 61 74 61 62  tion for a datab
173f0 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 63  ase connection c
17400 61 6e 20 6f 6e 6c 79 20 62 65 20 63 68 61 6e 67  an only be chang
17410 65 64 20 77 68 65 6e 20 74 68 61 74 0a 2a 2a 20  ed when that.** 
17420 63 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 6e 6f  connection is no
17430 74 20 63 75 72 72 65 6e 74 6c 79 20 75 73 69 6e  t currently usin
17440 67 20 6c 6f 6f 6b 61 73 69 64 65 20 6d 65 6d 6f  g lookaside memo
17450 72 79 2c 20 6f 72 20 69 6e 20 6f 74 68 65 72 20  ry, or in other 
17460 77 6f 72 64 73 0a 2a 2a 20 77 68 65 6e 20 74 68  words.** when th
17470 65 20 22 63 75 72 72 65 6e 74 20 76 61 6c 75 65  e "current value
17480 22 20 72 65 74 75 72 6e 65 64 20 62 79 0a 2a 2a  " returned by.**
17490 20 5b 73 71 6c 69 74 65 33 5f 64 62 5f 73 74 61   [sqlite3_db_sta
174a0 74 75 73 5d 28 44 2c 5b 53 51 4c 49 54 45 5f 43  tus](D,[SQLITE_C
174b0 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49 44 45 5d  ONFIG_LOOKASIDE]
174c0 2c 2e 2e 2e 29 20 69 73 20 7a 65 72 6f 2e 0a 2a  ,...) is zero..*
174d0 2a 20 41 6e 79 20 61 74 74 65 6d 70 74 20 74 6f  * Any attempt to
174e0 20 63 68 61 6e 67 65 20 74 68 65 20 6c 6f 6f 6b   change the look
174f0 61 73 69 64 65 20 6d 65 6d 6f 72 79 20 63 6f 6e  aside memory con
17500 66 69 67 75 72 61 74 69 6f 6e 20 77 68 65 6e 20  figuration when 
17510 6c 6f 6f 6b 61 73 69 64 65 0a 2a 2a 20 6d 65 6d  lookaside.** mem
17520 6f 72 79 20 69 73 20 69 6e 20 75 73 65 20 6c 65  ory is in use le
17530 61 76 65 73 20 74 68 65 20 63 6f 6e 66 69 67 75  aves the configu
17540 72 61 74 69 6f 6e 20 75 6e 63 68 61 6e 67 65 64  ration unchanged
17550 20 61 6e 64 20 72 65 74 75 72 6e 73 20 0a 2a 2a   and returns .**
17560 20 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d 2e 29   [SQLITE_BUSY].)
17570 5e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 64 74  ^</dd>.**.** <dt
17580 3e 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46 49 47  >SQLITE_DBCONFIG
17590 5f 45 4e 41 42 4c 45 5f 46 4b 45 59 3c 2f 64 74  _ENABLE_FKEY</dt
175a0 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 54 68 69 73 20  >.** <dd> ^This 
175b0 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 20 74  option is used t
175c0 6f 20 65 6e 61 62 6c 65 20 6f 72 20 64 69 73 61  o enable or disa
175d0 62 6c 65 20 74 68 65 20 65 6e 66 6f 72 63 65 6d  ble the enforcem
175e0 65 6e 74 20 6f 66 0a 2a 2a 20 5b 66 6f 72 65 69  ent of.** [forei
175f0 67 6e 20 6b 65 79 20 63 6f 6e 73 74 72 61 69 6e  gn key constrain
17600 74 73 5d 2e 20 20 54 68 65 72 65 20 73 68 6f 75  ts].  There shou
17610 6c 64 20 62 65 20 74 77 6f 20 61 64 64 69 74 69  ld be two additi
17620 6f 6e 61 6c 20 61 72 67 75 6d 65 6e 74 73 2e 0a  onal arguments..
17630 2a 2a 20 54 68 65 20 66 69 72 73 74 20 61 72 67  ** The first arg
17640 75 6d 65 6e 74 20 69 73 20 61 6e 20 69 6e 74 65  ument is an inte
17650 67 65 72 20 77 68 69 63 68 20 69 73 20 30 20 74  ger which is 0 t
17660 6f 20 64 69 73 61 62 6c 65 20 46 4b 20 65 6e 66  o disable FK enf
17670 6f 72 63 65 6d 65 6e 74 2c 0a 2a 2a 20 70 6f 73  orcement,.** pos
17680 69 74 69 76 65 20 74 6f 20 65 6e 61 62 6c 65 20  itive to enable 
17690 46 4b 20 65 6e 66 6f 72 63 65 6d 65 6e 74 20 6f  FK enforcement o
176a0 72 20 6e 65 67 61 74 69 76 65 20 74 6f 20 6c 65  r negative to le
176b0 61 76 65 20 46 4b 20 65 6e 66 6f 72 63 65 6d 65  ave FK enforceme
176c0 6e 74 0a 2a 2a 20 75 6e 63 68 61 6e 67 65 64 2e  nt.** unchanged.
176d0 20 20 54 68 65 20 73 65 63 6f 6e 64 20 70 61 72    The second par
176e0 61 6d 65 74 65 72 20 69 73 20 61 20 70 6f 69 6e  ameter is a poin
176f0 74 65 72 20 74 6f 20 61 6e 20 69 6e 74 65 67 65  ter to an intege
17700 72 20 69 6e 74 6f 20 77 68 69 63 68 0a 2a 2a 20  r into which.** 
17710 69 73 20 77 72 69 74 74 65 6e 20 30 20 6f 72 20  is written 0 or 
17720 31 20 74 6f 20 69 6e 64 69 63 61 74 65 20 77 68  1 to indicate wh
17730 65 74 68 65 72 20 46 4b 20 65 6e 66 6f 72 63 65  ether FK enforce
17740 6d 65 6e 74 20 69 73 20 6f 66 66 20 6f 72 20 6f  ment is off or o
17750 6e 0a 2a 2a 20 66 6f 6c 6c 6f 77 69 6e 67 20 74  n.** following t
17760 68 69 73 20 63 61 6c 6c 2e 20 20 54 68 65 20 73  his call.  The s
17770 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20  econd parameter 
17780 6d 61 79 20 62 65 20 61 20 4e 55 4c 4c 20 70 6f  may be a NULL po
17790 69 6e 74 65 72 2c 20 69 6e 0a 2a 2a 20 77 68 69  inter, in.** whi
177a0 63 68 20 63 61 73 65 20 74 68 65 20 46 4b 20 65  ch case the FK e
177b0 6e 66 6f 72 63 65 6d 65 6e 74 20 73 65 74 74 69  nforcement setti
177c0 6e 67 20 69 73 20 6e 6f 74 20 72 65 70 6f 72 74  ng is not report
177d0 65 64 20 62 61 63 6b 2e 20 3c 2f 64 64 3e 0a 2a  ed back. </dd>.*
177e0 2a 0a 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f  *.** <dt>SQLITE_
177f0 44 42 43 4f 4e 46 49 47 5f 45 4e 41 42 4c 45 5f  DBCONFIG_ENABLE_
17800 54 52 49 47 47 45 52 3c 2f 64 74 3e 0a 2a 2a 20  TRIGGER</dt>.** 
17810 3c 64 64 3e 20 5e 54 68 69 73 20 6f 70 74 69 6f  <dd> ^This optio
17820 6e 20 69 73 20 75 73 65 64 20 74 6f 20 65 6e 61  n is used to ena
17830 62 6c 65 20 6f 72 20 64 69 73 61 62 6c 65 20 5b  ble or disable [
17840 43 52 45 41 54 45 20 54 52 49 47 47 45 52 20 7c  CREATE TRIGGER |
17850 20 74 72 69 67 67 65 72 73 5d 2e 0a 2a 2a 20 54   triggers]..** T
17860 68 65 72 65 20 73 68 6f 75 6c 64 20 62 65 20 74  here should be t
17870 77 6f 20 61 64 64 69 74 69 6f 6e 61 6c 20 61 72  wo additional ar
17880 67 75 6d 65 6e 74 73 2e 0a 2a 2a 20 54 68 65 20  guments..** The 
17890 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 69  first argument i
178a0 73 20 61 6e 20 69 6e 74 65 67 65 72 20 77 68 69  s an integer whi
178b0 63 68 20 69 73 20 30 20 74 6f 20 64 69 73 61 62  ch is 0 to disab
178c0 6c 65 20 74 72 69 67 67 65 72 73 2c 0a 2a 2a 20  le triggers,.** 
178d0 70 6f 73 69 74 69 76 65 20 74 6f 20 65 6e 61 62  positive to enab
178e0 6c 65 20 74 72 69 67 67 65 72 73 20 6f 72 20 6e  le triggers or n
178f0 65 67 61 74 69 76 65 20 74 6f 20 6c 65 61 76 65  egative to leave
17900 20 74 68 65 20 73 65 74 74 69 6e 67 20 75 6e 63   the setting unc
17910 68 61 6e 67 65 64 2e 0a 2a 2a 20 54 68 65 20 73  hanged..** The s
17920 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20  econd parameter 
17930 69 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20  is a pointer to 
17940 61 6e 20 69 6e 74 65 67 65 72 20 69 6e 74 6f 20  an integer into 
17950 77 68 69 63 68 0a 2a 2a 20 69 73 20 77 72 69 74  which.** is writ
17960 74 65 6e 20 30 20 6f 72 20 31 20 74 6f 20 69 6e  ten 0 or 1 to in
17970 64 69 63 61 74 65 20 77 68 65 74 68 65 72 20 74  dicate whether t
17980 72 69 67 67 65 72 73 20 61 72 65 20 64 69 73 61  riggers are disa
17990 62 6c 65 64 20 6f 72 20 65 6e 61 62 6c 65 64 0a  bled or enabled.
179a0 2a 2a 20 66 6f 6c 6c 6f 77 69 6e 67 20 74 68 69  ** following thi
179b0 73 20 63 61 6c 6c 2e 20 20 54 68 65 20 73 65 63  s call.  The sec
179c0 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20 6d 61  ond parameter ma
179d0 79 20 62 65 20 61 20 4e 55 4c 4c 20 70 6f 69 6e  y be a NULL poin
179e0 74 65 72 2c 20 69 6e 0a 2a 2a 20 77 68 69 63 68  ter, in.** which
179f0 20 63 61 73 65 20 74 68 65 20 74 72 69 67 67 65   case the trigge
17a00 72 20 73 65 74 74 69 6e 67 20 69 73 20 6e 6f 74  r setting is not
17a10 20 72 65 70 6f 72 74 65 64 20 62 61 63 6b 2e 20   reported back. 
17a20 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 64 74 3e  </dd>.**.** <dt>
17a30 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46 49 47 5f  SQLITE_DBCONFIG_
17a40 45 4e 41 42 4c 45 5f 46 54 53 33 5f 54 4f 4b 45  ENABLE_FTS3_TOKE
17a50 4e 49 5a 45 52 3c 2f 64 74 3e 0a 2a 2a 20 3c 64  NIZER</dt>.** <d
17a60 64 3e 20 5e 54 68 69 73 20 6f 70 74 69 6f 6e 20  d> ^This option 
17a70 69 73 20 75 73 65 64 20 74 6f 20 65 6e 61 62 6c  is used to enabl
17a80 65 20 6f 72 20 64 69 73 61 62 6c 65 20 74 68 65  e or disable the
17a90 20 74 77 6f 2d 61 72 67 75 6d 65 6e 74 0a 2a 2a   two-argument.**
17aa0 20 76 65 72 73 69 6f 6e 20 6f 66 20 74 68 65 20   version of the 
17ab0 5b 66 74 73 33 5f 74 6f 6b 65 6e 69 7a 65 72 28  [fts3_tokenizer(
17ac0 29 5d 20 66 75 6e 63 74 69 6f 6e 20 77 68 69 63  )] function whic
17ad0 68 20 69 73 20 70 61 72 74 20 6f 66 20 74 68 65  h is part of the
17ae0 0a 2a 2a 20 5b 46 54 53 33 5d 20 66 75 6c 6c 2d  .** [FTS3] full-
17af0 74 65 78 74 20 73 65 61 72 63 68 20 65 6e 67 69  text search engi
17b00 6e 65 20 65 78 74 65 6e 73 69 6f 6e 2e 0a 2a 2a  ne extension..**
17b10 20 54 68 65 72 65 20 73 68 6f 75 6c 64 20 62 65   There should be
17b20 20 74 77 6f 20 61 64 64 69 74 69 6f 6e 61 6c 20   two additional 
17b30 61 72 67 75 6d 65 6e 74 73 2e 0a 2a 2a 20 54 68  arguments..** Th
17b40 65 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74  e first argument
17b50 20 69 73 20 61 6e 20 69 6e 74 65 67 65 72 20 77   is an integer w
17b60 68 69 63 68 20 69 73 20 30 20 74 6f 20 64 69 73  hich is 0 to dis
17b70 61 62 6c 65 20 66 74 73 33 5f 74 6f 6b 65 6e 69  able fts3_tokeni
17b80 7a 65 72 28 29 20 6f 72 0a 2a 2a 20 70 6f 73 69  zer() or.** posi
17b90 74 69 76 65 20 74 6f 20 65 6e 61 62 6c 65 20 66  tive to enable f
17ba0 74 73 33 5f 74 6f 6b 65 6e 69 7a 65 72 28 29 20  ts3_tokenizer() 
17bb0 6f 72 20 6e 65 67 61 74 69 76 65 20 74 6f 20 6c  or negative to l
17bc0 65 61 76 65 20 74 68 65 20 73 65 74 74 69 6e 67  eave the setting
17bd0 0a 2a 2a 20 75 6e 63 68 61 6e 67 65 64 2e 0a 2a  .** unchanged..*
17be0 2a 20 54 68 65 20 73 65 63 6f 6e 64 20 70 61 72  * The second par
17bf0 61 6d 65 74 65 72 20 69 73 20 61 20 70 6f 69 6e  ameter is a poin
17c00 74 65 72 20 74 6f 20 61 6e 20 69 6e 74 65 67 65  ter to an intege
17c10 72 20 69 6e 74 6f 20 77 68 69 63 68 0a 2a 2a 20  r into which.** 
17c20 69 73 20 77 72 69 74 74 65 6e 20 30 20 6f 72 20  is written 0 or 
17c30 31 20 74 6f 20 69 6e 64 69 63 61 74 65 20 77 68  1 to indicate wh
17c40 65 74 68 65 72 20 66 74 73 33 5f 74 6f 6b 65 6e  ether fts3_token
17c50 69 7a 65 72 20 69 73 20 64 69 73 61 62 6c 65 64  izer is disabled
17c60 20 6f 72 20 65 6e 61 62 6c 65 64 0a 2a 2a 20 66   or enabled.** f
17c70 6f 6c 6c 6f 77 69 6e 67 20 74 68 69 73 20 63 61  ollowing this ca
17c80 6c 6c 2e 20 20 54 68 65 20 73 65 63 6f 6e 64 20  ll.  The second 
17c90 70 61 72 61 6d 65 74 65 72 20 6d 61 79 20 62 65  parameter may be
17ca0 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2c   a NULL pointer,
17cb0 20 69 6e 0a 2a 2a 20 77 68 69 63 68 20 63 61 73   in.** which cas
17cc0 65 20 74 68 65 20 6e 65 77 20 73 65 74 74 69 6e  e the new settin
17cd0 67 20 69 73 20 6e 6f 74 20 72 65 70 6f 72 74 65  g is not reporte
17ce0 64 20 62 61 63 6b 2e 20 3c 2f 64 64 3e 0a 2a 2a  d back. </dd>.**
17cf0 0a 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f 44  .** <dt>SQLITE_D
17d00 42 43 4f 4e 46 49 47 5f 45 4e 41 42 4c 45 5f 4c  BCONFIG_ENABLE_L
17d10 4f 41 44 5f 45 58 54 45 4e 53 49 4f 4e 3c 2f 64  OAD_EXTENSION</d
17d20 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 54 68 69 73  t>.** <dd> ^This
17d30 20 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 20   option is used 
17d40 74 6f 20 65 6e 61 62 6c 65 20 6f 72 20 64 69 73  to enable or dis
17d50 61 62 6c 65 20 74 68 65 20 5b 73 71 6c 69 74 65  able the [sqlite
17d60 33 5f 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f 6e  3_load_extension
17d70 28 29 5d 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65  ()].** interface
17d80 20 69 6e 64 65 70 65 6e 64 65 6e 74 6c 79 20 6f   independently o
17d90 66 20 74 68 65 20 5b 6c 6f 61 64 5f 65 78 74 65  f the [load_exte
17da0 6e 73 69 6f 6e 28 29 5d 20 53 51 4c 20 66 75 6e  nsion()] SQL fun
17db0 63 74 69 6f 6e 2e 0a 2a 2a 20 54 68 65 20 5b 73  ction..** The [s
17dc0 71 6c 69 74 65 33 5f 65 6e 61 62 6c 65 5f 6c 6f  qlite3_enable_lo
17dd0 61 64 5f 65 78 74 65 6e 73 69 6f 6e 28 29 5d 20  ad_extension()] 
17de0 41 50 49 20 65 6e 61 62 6c 65 73 20 6f 72 20 64  API enables or d
17df0 69 73 61 62 6c 65 73 20 62 6f 74 68 20 74 68 65  isables both the
17e00 0a 2a 2a 20 43 2d 41 50 49 20 5b 73 71 6c 69 74  .** C-API [sqlit
17e10 65 33 5f 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f  e3_load_extensio
17e20 6e 28 29 5d 20 61 6e 64 20 74 68 65 20 53 51 4c  n()] and the SQL
17e30 20 66 75 6e 63 74 69 6f 6e 20 5b 6c 6f 61 64 5f   function [load_
17e40 65 78 74 65 6e 73 69 6f 6e 28 29 5d 2e 0a 2a 2a  extension()]..**
17e50 20 54 68 65 72 65 20 73 68 6f 75 6c 64 20 62 65   There should be
17e60 20 74 77 6f 20 61 64 64 69 74 69 6f 6e 61 6c 20   two additional 
17e70 61 72 67 75 6d 65 6e 74 73 2e 0a 2a 2a 20 57 68  arguments..** Wh
17e80 65 6e 20 74 68 65 20 66 69 72 73 74 20 61 72 67  en the first arg
17e90 75 6d 65 6e 74 20 74 6f 20 74 68 69 73 20 69 6e  ument to this in
17ea0 74 65 72 66 61 63 65 20 69 73 20 31 2c 20 74 68  terface is 1, th
17eb0 65 6e 20 6f 6e 6c 79 20 74 68 65 20 43 2d 41 50  en only the C-AP
17ec0 49 20 69 73 0a 2a 2a 20 65 6e 61 62 6c 65 64 20  I is.** enabled 
17ed0 61 6e 64 20 74 68 65 20 53 51 4c 20 66 75 6e 63  and the SQL func
17ee0 74 69 6f 6e 20 72 65 6d 61 69 6e 73 20 64 69 73  tion remains dis
17ef0 61 62 6c 65 64 2e 20 20 49 66 20 74 68 65 20 66  abled.  If the f
17f00 69 72 73 74 20 61 72 67 6d 65 6e 74 20 74 6f 0a  irst argment to.
17f10 2a 2a 20 74 68 69 73 20 69 6e 74 65 72 66 61 63  ** this interfac
17f20 65 20 69 73 20 30 2c 20 74 68 65 6e 20 62 6f 74  e is 0, then bot
17f30 68 20 74 68 65 20 43 2d 41 50 49 20 61 6e 64 20  h the C-API and 
17f40 74 68 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  the SQL function
17f50 20 61 72 65 20 64 69 73 61 62 6c 65 64 2e 0a 2a   are disabled..*
17f60 2a 20 49 66 20 74 68 65 20 66 69 72 73 74 20 61  * If the first a
17f70 72 67 75 6d 65 6e 74 20 69 73 20 2d 31 2c 20 74  rgument is -1, t
17f80 68 65 6e 20 6e 6f 20 63 68 61 6e 67 65 73 20 61  hen no changes a
17f90 72 65 20 6d 61 64 65 20 74 6f 20 73 74 61 74 65  re made to state
17fa0 20 6f 66 20 65 69 74 68 65 72 20 74 68 65 0a 2a   of either the.*
17fb0 2a 20 43 2d 41 50 49 20 6f 72 20 74 68 65 20 53  * C-API or the S
17fc0 51 4c 20 66 75 6e 63 74 69 6f 6e 2e 0a 2a 2a 20  QL function..** 
17fd0 54 68 65 20 73 65 63 6f 6e 64 20 70 61 72 61 6d  The second param
17fe0 65 74 65 72 20 69 73 20 61 20 70 6f 69 6e 74 65  eter is a pointe
17ff0 72 20 74 6f 20 61 6e 20 69 6e 74 65 67 65 72 20  r to an integer 
18000 69 6e 74 6f 20 77 68 69 63 68 0a 2a 2a 20 69 73  into which.** is
18010 20 77 72 69 74 74 65 6e 20 30 20 6f 72 20 31 20   written 0 or 1 
18020 74 6f 20 69 6e 64 69 63 61 74 65 20 77 68 65 74  to indicate whet
18030 68 65 72 20 5b 73 71 6c 69 74 65 33 5f 6c 6f 61  her [sqlite3_loa
18040 64 5f 65 78 74 65 6e 73 69 6f 6e 28 29 5d 20 69  d_extension()] i
18050 6e 74 65 72 66 61 63 65 0a 2a 2a 20 69 73 20 64  nterface.** is d
18060 69 73 61 62 6c 65 64 20 6f 72 20 65 6e 61 62 6c  isabled or enabl
18070 65 64 20 66 6f 6c 6c 6f 77 69 6e 67 20 74 68 69  ed following thi
18080 73 20 63 61 6c 6c 2e 20 20 54 68 65 20 73 65 63  s call.  The sec
18090 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20 6d 61  ond parameter ma
180a0 79 0a 2a 2a 20 62 65 20 61 20 4e 55 4c 4c 20 70  y.** be a NULL p
180b0 6f 69 6e 74 65 72 2c 20 69 6e 20 77 68 69 63 68  ointer, in which
180c0 20 63 61 73 65 20 74 68 65 20 6e 65 77 20 73 65   case the new se
180d0 74 74 69 6e 67 20 69 73 20 6e 6f 74 20 72 65 70  tting is not rep
180e0 6f 72 74 65 64 20 62 61 63 6b 2e 0a 2a 2a 20 3c  orted back..** <
180f0 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 2f 64 6c 3e  /dd>.**.** </dl>
18100 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  .*/.#define SQLI
18110 54 45 5f 44 42 43 4f 4e 46 49 47 5f 4c 4f 4f 4b  TE_DBCONFIG_LOOK
18120 41 53 49 44 45 20 20 20 20 20 20 20 20 20 20 20  ASIDE           
18130 20 20 31 30 30 31 20 2f 2a 20 76 6f 69 64 2a 20    1001 /* void* 
18140 69 6e 74 20 69 6e 74 20 2a 2f 0a 23 64 65 66 69  int int */.#defi
18150 6e 65 20 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46  ne SQLITE_DBCONF
18160 49 47 5f 45 4e 41 42 4c 45 5f 46 4b 45 59 20 20  IG_ENABLE_FKEY  
18170 20 20 20 20 20 20 20 20 20 31 30 30 32 20 2f 2a           1002 /*
18180 20 69 6e 74 20 69 6e 74 2a 20 2a 2f 0a 23 64 65   int int* */.#de
18190 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 42 43 4f  fine SQLITE_DBCO
181a0 4e 46 49 47 5f 45 4e 41 42 4c 45 5f 54 52 49 47  NFIG_ENABLE_TRIG
181b0 47 45 52 20 20 20 20 20 20 20 20 31 30 30 33 20  GER        1003 
181c0 2f 2a 20 69 6e 74 20 69 6e 74 2a 20 2a 2f 0a 23  /* int int* */.#
181d0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 42  define SQLITE_DB
181e0 43 4f 4e 46 49 47 5f 45 4e 41 42 4c 45 5f 46 54  CONFIG_ENABLE_FT
181f0 53 33 5f 54 4f 4b 45 4e 49 5a 45 52 20 31 30 30  S3_TOKENIZER 100
18200 34 20 2f 2a 20 69 6e 74 20 69 6e 74 2a 20 2a 2f  4 /* int int* */
18210 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
18220 44 42 43 4f 4e 46 49 47 5f 45 4e 41 42 4c 45 5f  DBCONFIG_ENABLE_
18230 4c 4f 41 44 5f 45 58 54 45 4e 53 49 4f 4e 20 31  LOAD_EXTENSION 1
18240 30 30 35 20 2f 2a 20 69 6e 74 20 69 6e 74 2a 20  005 /* int int* 
18250 2a 2f 0a 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  */.../*.** CAPI3
18260 52 45 46 3a 20 45 6e 61 62 6c 65 20 4f 72 20 44  REF: Enable Or D
18270 69 73 61 62 6c 65 20 45 78 74 65 6e 64 65 64 20  isable Extended 
18280 52 65 73 75 6c 74 20 43 6f 64 65 73 0a 2a 2a 20  Result Codes.** 
18290 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a  METHOD: sqlite3.
182a0 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  **.** ^The sqlit
182b0 65 33 5f 65 78 74 65 6e 64 65 64 5f 72 65 73 75  e3_extended_resu
182c0 6c 74 5f 63 6f 64 65 73 28 29 20 72 6f 75 74 69  lt_codes() routi
182d0 6e 65 20 65 6e 61 62 6c 65 73 20 6f 72 20 64 69  ne enables or di
182e0 73 61 62 6c 65 73 20 74 68 65 0a 2a 2a 20 5b 65  sables the.** [e
182f0 78 74 65 6e 64 65 64 20 72 65 73 75 6c 74 20 63  xtended result c
18300 6f 64 65 73 5d 20 66 65 61 74 75 72 65 20 6f 66  odes] feature of
18310 20 53 51 4c 69 74 65 2e 20 5e 54 68 65 20 65 78   SQLite. ^The ex
18320 74 65 6e 64 65 64 20 72 65 73 75 6c 74 0a 2a 2a  tended result.**
18330 20 63 6f 64 65 73 20 61 72 65 20 64 69 73 61 62   codes are disab
18340 6c 65 64 20 62 79 20 64 65 66 61 75 6c 74 20 66  led by default f
18350 6f 72 20 68 69 73 74 6f 72 69 63 61 6c 20 63 6f  or historical co
18360 6d 70 61 74 69 62 69 6c 69 74 79 2e 0a 2a 2f 0a  mpatibility..*/.
18370 69 6e 74 20 73 71 6c 69 74 65 33 5f 65 78 74 65  int sqlite3_exte
18380 6e 64 65 64 5f 72 65 73 75 6c 74 5f 63 6f 64 65  nded_result_code
18390 73 28 73 71 6c 69 74 65 33 2a 2c 20 69 6e 74 20  s(sqlite3*, int 
183a0 6f 6e 6f 66 66 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43  onoff);../*.** C
183b0 41 50 49 33 52 45 46 3a 20 4c 61 73 74 20 49 6e  API3REF: Last In
183c0 73 65 72 74 20 52 6f 77 69 64 0a 2a 2a 20 4d 45  sert Rowid.** ME
183d0 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a 2a  THOD: sqlite3.**
183e0 0a 2a 2a 20 5e 45 61 63 68 20 65 6e 74 72 79 20  .** ^Each entry 
183f0 69 6e 20 6d 6f 73 74 20 53 51 4c 69 74 65 20 74  in most SQLite t
18400 61 62 6c 65 73 20 28 65 78 63 65 70 74 20 66 6f  ables (except fo
18410 72 20 5b 57 49 54 48 4f 55 54 20 52 4f 57 49 44  r [WITHOUT ROWID
18420 5d 20 74 61 62 6c 65 73 29 0a 2a 2a 20 68 61 73  ] tables).** has
18430 20 61 20 75 6e 69 71 75 65 20 36 34 2d 62 69 74   a unique 64-bit
18440 20 73 69 67 6e 65 64 0a 2a 2a 20 69 6e 74 65 67   signed.** integ
18450 65 72 20 6b 65 79 20 63 61 6c 6c 65 64 20 74 68  er key called th
18460 65 20 5b 52 4f 57 49 44 20 7c 20 22 72 6f 77 69  e [ROWID | "rowi
18470 64 22 5d 2e 20 5e 54 68 65 20 72 6f 77 69 64 20  d"]. ^The rowid 
18480 69 73 20 61 6c 77 61 79 73 20 61 76 61 69 6c 61  is always availa
18490 62 6c 65 0a 2a 2a 20 61 73 20 61 6e 20 75 6e 64  ble.** as an und
184a0 65 63 6c 61 72 65 64 20 63 6f 6c 75 6d 6e 20 6e  eclared column n
184b0 61 6d 65 64 20 52 4f 57 49 44 2c 20 4f 49 44 2c  amed ROWID, OID,
184c0 20 6f 72 20 5f 52 4f 57 49 44 5f 20 61 73 20 6c   or _ROWID_ as l
184d0 6f 6e 67 20 61 73 20 74 68 6f 73 65 0a 2a 2a 20  ong as those.** 
184e0 6e 61 6d 65 73 20 61 72 65 20 6e 6f 74 20 61 6c  names are not al
184f0 73 6f 20 75 73 65 64 20 62 79 20 65 78 70 6c 69  so used by expli
18500 63 69 74 6c 79 20 64 65 63 6c 61 72 65 64 20 63  citly declared c
18510 6f 6c 75 6d 6e 73 2e 20 5e 49 66 0a 2a 2a 20 74  olumns. ^If.** t
18520 68 65 20 74 61 62 6c 65 20 68 61 73 20 61 20 63  he table has a c
18530 6f 6c 75 6d 6e 20 6f 66 20 74 79 70 65 20 5b 49  olumn of type [I
18540 4e 54 45 47 45 52 20 50 52 49 4d 41 52 59 20 4b  NTEGER PRIMARY K
18550 45 59 5d 20 74 68 65 6e 20 74 68 61 74 20 63 6f  EY] then that co
18560 6c 75 6d 6e 0a 2a 2a 20 69 73 20 61 6e 6f 74 68  lumn.** is anoth
18570 65 72 20 61 6c 69 61 73 20 66 6f 72 20 74 68 65  er alias for the
18580 20 72 6f 77 69 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54   rowid..**.** ^T
18590 68 65 20 73 71 6c 69 74 65 33 5f 6c 61 73 74 5f  he sqlite3_last_
185a0 69 6e 73 65 72 74 5f 72 6f 77 69 64 28 44 29 20  insert_rowid(D) 
185b0 69 6e 74 65 72 66 61 63 65 20 72 65 74 75 72 6e  interface return
185c0 73 20 74 68 65 20 5b 72 6f 77 69 64 5d 20 6f 66  s the [rowid] of
185d0 20 74 68 65 20 0a 2a 2a 20 6d 6f 73 74 20 72 65   the .** most re
185e0 63 65 6e 74 20 73 75 63 63 65 73 73 66 75 6c 20  cent successful 
185f0 5b 49 4e 53 45 52 54 5d 20 69 6e 74 6f 20 61 20  [INSERT] into a 
18600 72 6f 77 69 64 20 74 61 62 6c 65 20 6f 72 20 5b  rowid table or [
18610 76 69 72 74 75 61 6c 20 74 61 62 6c 65 5d 0a 2a  virtual table].*
18620 2a 20 6f 6e 20 64 61 74 61 62 61 73 65 20 63 6f  * on database co
18630 6e 6e 65 63 74 69 6f 6e 20 44 2e 0a 2a 2a 20 5e  nnection D..** ^
18640 49 6e 73 65 72 74 73 20 69 6e 74 6f 20 5b 57 49  Inserts into [WI
18650 54 48 4f 55 54 20 52 4f 57 49 44 5d 20 74 61 62  THOUT ROWID] tab
18660 6c 65 73 20 61 72 65 20 6e 6f 74 20 72 65 63 6f  les are not reco
18670 72 64 65 64 2e 0a 2a 2a 20 5e 49 66 20 6e 6f 20  rded..** ^If no 
18680 73 75 63 63 65 73 73 66 75 6c 20 5b 49 4e 53 45  successful [INSE
18690 52 54 5d 73 20 69 6e 74 6f 20 72 6f 77 69 64 20  RT]s into rowid 
186a0 74 61 62 6c 65 73 0a 2a 2a 20 68 61 76 65 20 65  tables.** have e
186b0 76 65 72 20 6f 63 63 75 72 72 65 64 20 6f 6e 20  ver occurred on 
186c0 74 68 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e  the database con
186d0 6e 65 63 74 69 6f 6e 20 44 2c 20 0a 2a 2a 20 74  nection D, .** t
186e0 68 65 6e 20 73 71 6c 69 74 65 33 5f 6c 61 73 74  hen sqlite3_last
186f0 5f 69 6e 73 65 72 74 5f 72 6f 77 69 64 28 44 29  _insert_rowid(D)
18700 20 72 65 74 75 72 6e 73 20 7a 65 72 6f 2e 0a 2a   returns zero..*
18710 2a 0a 2a 2a 20 5e 28 49 66 20 61 6e 20 5b 49 4e  *.** ^(If an [IN
18720 53 45 52 54 5d 20 6f 63 63 75 72 73 20 77 69 74  SERT] occurs wit
18730 68 69 6e 20 61 20 74 72 69 67 67 65 72 20 6f 72  hin a trigger or
18740 20 77 69 74 68 69 6e 20 61 20 5b 76 69 72 74 75   within a [virtu
18750 61 6c 20 74 61 62 6c 65 5d 0a 2a 2a 20 6d 65 74  al table].** met
18760 68 6f 64 2c 20 74 68 65 6e 20 74 68 69 73 20 72  hod, then this r
18770 6f 75 74 69 6e 65 20 77 69 6c 6c 20 72 65 74 75  outine will retu
18780 72 6e 20 74 68 65 20 5b 72 6f 77 69 64 5d 20 6f  rn the [rowid] o
18790 66 20 74 68 65 20 69 6e 73 65 72 74 65 64 0a 2a  f the inserted.*
187a0 2a 20 72 6f 77 20 61 73 20 6c 6f 6e 67 20 61 73  * row as long as
187b0 20 74 68 65 20 74 72 69 67 67 65 72 20 6f 72 20   the trigger or 
187c0 76 69 72 74 75 61 6c 20 74 61 62 6c 65 20 6d 65  virtual table me
187d0 74 68 6f 64 20 69 73 20 72 75 6e 6e 69 6e 67 2e  thod is running.
187e0 0a 2a 2a 20 42 75 74 20 6f 6e 63 65 20 74 68 65  .** But once the
187f0 20 74 72 69 67 67 65 72 20 6f 72 20 76 69 72 74   trigger or virt
18800 75 61 6c 20 74 61 62 6c 65 20 6d 65 74 68 6f 64  ual table method
18810 20 65 6e 64 73 2c 20 74 68 65 20 76 61 6c 75 65   ends, the value
18820 20 72 65 74 75 72 6e 65 64 20 0a 2a 2a 20 62 79   returned .** by
18830 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 72 65   this routine re
18840 76 65 72 74 73 20 74 6f 20 77 68 61 74 20 69 74  verts to what it
18850 20 77 61 73 20 62 65 66 6f 72 65 20 74 68 65 20   was before the 
18860 74 72 69 67 67 65 72 20 6f 72 20 76 69 72 74 75  trigger or virtu
18870 61 6c 0a 2a 2a 20 74 61 62 6c 65 20 6d 65 74 68  al.** table meth
18880 6f 64 20 62 65 67 61 6e 2e 29 5e 0a 2a 2a 0a 2a  od began.)^.**.*
18890 2a 20 5e 41 6e 20 5b 49 4e 53 45 52 54 5d 20 74  * ^An [INSERT] t
188a0 68 61 74 20 66 61 69 6c 73 20 64 75 65 20 74 6f  hat fails due to
188b0 20 61 20 63 6f 6e 73 74 72 61 69 6e 74 20 76 69   a constraint vi
188c0 6f 6c 61 74 69 6f 6e 20 69 73 20 6e 6f 74 20 61  olation is not a
188d0 0a 2a 2a 20 73 75 63 63 65 73 73 66 75 6c 20 5b  .** successful [
188e0 49 4e 53 45 52 54 5d 20 61 6e 64 20 64 6f 65 73  INSERT] and does
188f0 20 6e 6f 74 20 63 68 61 6e 67 65 20 74 68 65 20   not change the 
18900 76 61 6c 75 65 20 72 65 74 75 72 6e 65 64 20 62  value returned b
18910 79 20 74 68 69 73 0a 2a 2a 20 72 6f 75 74 69 6e  y this.** routin
18920 65 2e 20 20 5e 54 68 75 73 20 49 4e 53 45 52 54  e.  ^Thus INSERT
18930 20 4f 52 20 46 41 49 4c 2c 20 49 4e 53 45 52 54   OR FAIL, INSERT
18940 20 4f 52 20 49 47 4e 4f 52 45 2c 20 49 4e 53 45   OR IGNORE, INSE
18950 52 54 20 4f 52 20 52 4f 4c 4c 42 41 43 4b 2c 0a  RT OR ROLLBACK,.
18960 2a 2a 20 61 6e 64 20 49 4e 53 45 52 54 20 4f 52  ** and INSERT OR
18970 20 41 42 4f 52 54 20 6d 61 6b 65 20 6e 6f 20 63   ABORT make no c
18980 68 61 6e 67 65 73 20 74 6f 20 74 68 65 20 72 65  hanges to the re
18990 74 75 72 6e 20 76 61 6c 75 65 20 6f 66 20 74 68  turn value of th
189a0 69 73 0a 2a 2a 20 72 6f 75 74 69 6e 65 20 77 68  is.** routine wh
189b0 65 6e 20 74 68 65 69 72 20 69 6e 73 65 72 74 69  en their inserti
189c0 6f 6e 20 66 61 69 6c 73 2e 20 20 5e 28 57 68 65  on fails.  ^(Whe
189d0 6e 20 49 4e 53 45 52 54 20 4f 52 20 52 45 50 4c  n INSERT OR REPL
189e0 41 43 45 0a 2a 2a 20 65 6e 63 6f 75 6e 74 65 72  ACE.** encounter
189f0 73 20 61 20 63 6f 6e 73 74 72 61 69 6e 74 20 76  s a constraint v
18a00 69 6f 6c 61 74 69 6f 6e 2c 20 69 74 20 64 6f 65  iolation, it doe
18a10 73 20 6e 6f 74 20 66 61 69 6c 2e 20 20 54 68 65  s not fail.  The
18a20 0a 2a 2a 20 49 4e 53 45 52 54 20 63 6f 6e 74 69  .** INSERT conti
18a30 6e 75 65 73 20 74 6f 20 63 6f 6d 70 6c 65 74 69  nues to completi
18a40 6f 6e 20 61 66 74 65 72 20 64 65 6c 65 74 69 6e  on after deletin
18a50 67 20 72 6f 77 73 20 74 68 61 74 20 63 61 75 73  g rows that caus
18a60 65 64 0a 2a 2a 20 74 68 65 20 63 6f 6e 73 74 72  ed.** the constr
18a70 61 69 6e 74 20 70 72 6f 62 6c 65 6d 20 73 6f 20  aint problem so 
18a80 49 4e 53 45 52 54 20 4f 52 20 52 45 50 4c 41 43  INSERT OR REPLAC
18a90 45 20 77 69 6c 6c 20 61 6c 77 61 79 73 20 63 68  E will always ch
18aa0 61 6e 67 65 0a 2a 2a 20 74 68 65 20 72 65 74 75  ange.** the retu
18ab0 72 6e 20 76 61 6c 75 65 20 6f 66 20 74 68 69 73  rn value of this
18ac0 20 69 6e 74 65 72 66 61 63 65 2e 29 5e 0a 2a 2a   interface.)^.**
18ad0 0a 2a 2a 20 5e 46 6f 72 20 74 68 65 20 70 75 72  .** ^For the pur
18ae0 70 6f 73 65 73 20 6f 66 20 74 68 69 73 20 72 6f  poses of this ro
18af0 75 74 69 6e 65 2c 20 61 6e 20 5b 49 4e 53 45 52  utine, an [INSER
18b00 54 5d 20 69 73 20 63 6f 6e 73 69 64 65 72 65 64  T] is considered
18b10 20 74 6f 0a 2a 2a 20 62 65 20 73 75 63 63 65 73   to.** be succes
18b20 73 66 75 6c 20 65 76 65 6e 20 69 66 20 69 74 20  sful even if it 
18b30 69 73 20 73 75 62 73 65 71 75 65 6e 74 6c 79 20  is subsequently 
18b40 72 6f 6c 6c 65 64 20 62 61 63 6b 2e 0a 2a 2a 0a  rolled back..**.
18b50 2a 2a 20 54 68 69 73 20 66 75 6e 63 74 69 6f 6e  ** This function
18b60 20 69 73 20 61 63 63 65 73 73 69 62 6c 65 20 74   is accessible t
18b70 6f 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73  o SQL statements
18b80 20 76 69 61 20 74 68 65 0a 2a 2a 20 5b 6c 61 73   via the.** [las
18b90 74 5f 69 6e 73 65 72 74 5f 72 6f 77 69 64 28 29  t_insert_rowid()
18ba0 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 5d 2e 0a   SQL function]..
18bb0 2a 2a 0a 2a 2a 20 49 66 20 61 20 73 65 70 61 72  **.** If a separ
18bc0 61 74 65 20 74 68 72 65 61 64 20 70 65 72 66 6f  ate thread perfo
18bd0 72 6d 73 20 61 20 6e 65 77 20 5b 49 4e 53 45 52  rms a new [INSER
18be0 54 5d 20 6f 6e 20 74 68 65 20 73 61 6d 65 0a 2a  T] on the same.*
18bf0 2a 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65  * database conne
18c00 63 74 69 6f 6e 20 77 68 69 6c 65 20 74 68 65 20  ction while the 
18c10 5b 73 71 6c 69 74 65 33 5f 6c 61 73 74 5f 69 6e  [sqlite3_last_in
18c20 73 65 72 74 5f 72 6f 77 69 64 28 29 5d 0a 2a 2a  sert_rowid()].**
18c30 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 72 75 6e   function is run
18c40 6e 69 6e 67 20 61 6e 64 20 74 68 75 73 20 63 68  ning and thus ch
18c50 61 6e 67 65 73 20 74 68 65 20 6c 61 73 74 20 69  anges the last i
18c60 6e 73 65 72 74 20 5b 72 6f 77 69 64 5d 2c 0a 2a  nsert [rowid],.*
18c70 2a 20 74 68 65 6e 20 74 68 65 20 76 61 6c 75 65  * then the value
18c80 20 72 65 74 75 72 6e 65 64 20 62 79 20 5b 73 71   returned by [sq
18c90 6c 69 74 65 33 5f 6c 61 73 74 5f 69 6e 73 65 72  lite3_last_inser
18ca0 74 5f 72 6f 77 69 64 28 29 5d 20 69 73 0a 2a 2a  t_rowid()] is.**
18cb0 20 75 6e 70 72 65 64 69 63 74 61 62 6c 65 20 61   unpredictable a
18cc0 6e 64 20 6d 69 67 68 74 20 6e 6f 74 20 65 71 75  nd might not equ
18cd0 61 6c 20 65 69 74 68 65 72 20 74 68 65 20 6f 6c  al either the ol
18ce0 64 20 6f 72 20 74 68 65 20 6e 65 77 0a 2a 2a 20  d or the new.** 
18cf0 6c 61 73 74 20 69 6e 73 65 72 74 20 5b 72 6f 77  last insert [row
18d00 69 64 5d 2e 0a 2a 2f 0a 73 71 6c 69 74 65 33 5f  id]..*/.sqlite3_
18d10 69 6e 74 36 34 20 73 71 6c 69 74 65 33 5f 6c 61  int64 sqlite3_la
18d20 73 74 5f 69 6e 73 65 72 74 5f 72 6f 77 69 64 28  st_insert_rowid(
18d30 73 71 6c 69 74 65 33 2a 29 3b 0a 0a 2f 2a 0a 2a  sqlite3*);../*.*
18d40 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6f 75 6e  * CAPI3REF: Coun
18d50 74 20 54 68 65 20 4e 75 6d 62 65 72 20 4f 66 20  t The Number Of 
18d60 52 6f 77 73 20 4d 6f 64 69 66 69 65 64 0a 2a 2a  Rows Modified.**
18d70 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33   METHOD: sqlite3
18d80 0a 2a 2a 0a 2a 2a 20 5e 54 68 69 73 20 66 75 6e  .**.** ^This fun
18d90 63 74 69 6f 6e 20 72 65 74 75 72 6e 73 20 74 68  ction returns th
18da0 65 20 6e 75 6d 62 65 72 20 6f 66 20 72 6f 77 73  e number of rows
18db0 20 6d 6f 64 69 66 69 65 64 2c 20 69 6e 73 65 72   modified, inser
18dc0 74 65 64 20 6f 72 0a 2a 2a 20 64 65 6c 65 74 65  ted or.** delete
18dd0 64 20 62 79 20 74 68 65 20 6d 6f 73 74 20 72 65  d by the most re
18de0 63 65 6e 74 6c 79 20 63 6f 6d 70 6c 65 74 65 64  cently completed
18df0 20 49 4e 53 45 52 54 2c 20 55 50 44 41 54 45 20   INSERT, UPDATE 
18e00 6f 72 20 44 45 4c 45 54 45 0a 2a 2a 20 73 74 61  or DELETE.** sta
18e10 74 65 6d 65 6e 74 20 6f 6e 20 74 68 65 20 64 61  tement on the da
18e20 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
18e30 6e 20 73 70 65 63 69 66 69 65 64 20 62 79 20 74  n specified by t
18e40 68 65 20 6f 6e 6c 79 20 70 61 72 61 6d 65 74 65  he only paramete
18e50 72 2e 0a 2a 2a 20 5e 45 78 65 63 75 74 69 6e 67  r..** ^Executing
18e60 20 61 6e 79 20 6f 74 68 65 72 20 74 79 70 65 20   any other type 
18e70 6f 66 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  of SQL statement
18e80 20 64 6f 65 73 20 6e 6f 74 20 6d 6f 64 69 66 79   does not modify
18e90 20 74 68 65 20 76 61 6c 75 65 0a 2a 2a 20 72 65   the value.** re
18ea0 74 75 72 6e 65 64 20 62 79 20 74 68 69 73 20 66  turned by this f
18eb0 75 6e 63 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e  unction..**.** ^
18ec0 4f 6e 6c 79 20 63 68 61 6e 67 65 73 20 6d 61 64  Only changes mad
18ed0 65 20 64 69 72 65 63 74 6c 79 20 62 79 20 74 68  e directly by th
18ee0 65 20 49 4e 53 45 52 54 2c 20 55 50 44 41 54 45  e INSERT, UPDATE
18ef0 20 6f 72 20 44 45 4c 45 54 45 20 73 74 61 74 65   or DELETE state
18f00 6d 65 6e 74 20 61 72 65 0a 2a 2a 20 63 6f 6e 73  ment are.** cons
18f10 69 64 65 72 65 64 20 2d 20 61 75 78 69 6c 69 61  idered - auxilia
18f20 72 79 20 63 68 61 6e 67 65 73 20 63 61 75 73 65  ry changes cause
18f30 64 20 62 79 20 5b 43 52 45 41 54 45 20 54 52 49  d by [CREATE TRI
18f40 47 47 45 52 20 7c 20 74 72 69 67 67 65 72 73 5d  GGER | triggers]
18f50 2c 20 0a 2a 2a 20 5b 66 6f 72 65 69 67 6e 20 6b  , .** [foreign k
18f60 65 79 20 61 63 74 69 6f 6e 73 5d 20 6f 72 20 5b  ey actions] or [
18f70 52 45 50 4c 41 43 45 5d 20 63 6f 6e 73 74 72 61  REPLACE] constra
18f80 69 6e 74 20 72 65 73 6f 6c 75 74 69 6f 6e 20 61  int resolution a
18f90 72 65 20 6e 6f 74 20 63 6f 75 6e 74 65 64 2e 0a  re not counted..
18fa0 2a 2a 20 0a 2a 2a 20 43 68 61 6e 67 65 73 20 74  ** .** Changes t
18fb0 6f 20 61 20 76 69 65 77 20 74 68 61 74 20 61 72  o a view that ar
18fc0 65 20 69 6e 74 65 72 63 65 70 74 65 64 20 62 79  e intercepted by
18fd0 20 0a 2a 2a 20 5b 49 4e 53 54 45 41 44 20 4f 46   .** [INSTEAD OF
18fe0 20 74 72 69 67 67 65 72 20 7c 20 49 4e 53 54 45   trigger | INSTE
18ff0 41 44 20 4f 46 20 74 72 69 67 67 65 72 73 5d 20  AD OF triggers] 
19000 61 72 65 20 6e 6f 74 20 63 6f 75 6e 74 65 64 2e  are not counted.
19010 20 5e 54 68 65 20 76 61 6c 75 65 20 0a 2a 2a 20   ^The value .** 
19020 72 65 74 75 72 6e 65 64 20 62 79 20 73 71 6c 69  returned by sqli
19030 74 65 33 5f 63 68 61 6e 67 65 73 28 29 20 69 6d  te3_changes() im
19040 6d 65 64 69 61 74 65 6c 79 20 61 66 74 65 72 20  mediately after 
19050 61 6e 20 49 4e 53 45 52 54 2c 20 55 50 44 41 54  an INSERT, UPDAT
19060 45 20 6f 72 20 0a 2a 2a 20 44 45 4c 45 54 45 20  E or .** DELETE 
19070 73 74 61 74 65 6d 65 6e 74 20 72 75 6e 20 6f 6e  statement run on
19080 20 61 20 76 69 65 77 20 69 73 20 61 6c 77 61 79   a view is alway
19090 73 20 7a 65 72 6f 2e 20 4f 6e 6c 79 20 63 68 61  s zero. Only cha
190a0 6e 67 65 73 20 6d 61 64 65 20 74 6f 20 72 65 61  nges made to rea
190b0 6c 20 0a 2a 2a 20 74 61 62 6c 65 73 20 61 72 65  l .** tables are
190c0 20 63 6f 75 6e 74 65 64 2e 0a 2a 2a 0a 2a 2a 20   counted..**.** 
190d0 54 68 69 6e 67 73 20 61 72 65 20 6d 6f 72 65 20  Things are more 
190e0 63 6f 6d 70 6c 69 63 61 74 65 64 20 69 66 20 74  complicated if t
190f0 68 65 20 73 71 6c 69 74 65 33 5f 63 68 61 6e 67  he sqlite3_chang
19100 65 73 28 29 20 66 75 6e 63 74 69 6f 6e 20 69 73  es() function is
19110 0a 2a 2a 20 65 78 65 63 75 74 65 64 20 77 68 69  .** executed whi
19120 6c 65 20 61 20 74 72 69 67 67 65 72 20 70 72 6f  le a trigger pro
19130 67 72 61 6d 20 69 73 20 72 75 6e 6e 69 6e 67 2e  gram is running.
19140 20 54 68 69 73 20 6d 61 79 20 68 61 70 70 65 6e   This may happen
19150 20 69 66 20 74 68 65 0a 2a 2a 20 70 72 6f 67 72   if the.** progr
19160 61 6d 20 75 73 65 73 20 74 68 65 20 5b 63 68 61  am uses the [cha
19170 6e 67 65 73 28 29 20 53 51 4c 20 66 75 6e 63 74  nges() SQL funct
19180 69 6f 6e 5d 2c 20 6f 72 20 69 66 20 73 6f 6d 65  ion], or if some
19190 20 6f 74 68 65 72 20 63 61 6c 6c 62 61 63 6b 0a   other callback.
191a0 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 69 6e 76 6f  ** function invo
191b0 6b 65 73 20 73 71 6c 69 74 65 33 5f 63 68 61 6e  kes sqlite3_chan
191c0 67 65 73 28 29 20 64 69 72 65 63 74 6c 79 2e 20  ges() directly. 
191d0 45 73 73 65 6e 74 69 61 6c 6c 79 3a 0a 2a 2a 20  Essentially:.** 
191e0 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 20 20 3c 6c  .** <ul>.**   <l
191f0 69 3e 20 5e 28 42 65 66 6f 72 65 20 65 6e 74 65  i> ^(Before ente
19200 72 69 6e 67 20 61 20 74 72 69 67 67 65 72 20 70  ring a trigger p
19210 72 6f 67 72 61 6d 20 74 68 65 20 76 61 6c 75 65  rogram the value
19220 20 72 65 74 75 72 6e 65 64 20 62 79 0a 2a 2a 20   returned by.** 
19230 20 20 20 20 20 20 20 73 71 6c 69 74 65 33 5f 63         sqlite3_c
19240 68 61 6e 67 65 73 28 29 20 66 75 6e 63 74 69 6f  hanges() functio
19250 6e 20 69 73 20 73 61 76 65 64 2e 20 41 66 74 65  n is saved. Afte
19260 72 20 74 68 65 20 74 72 69 67 67 65 72 20 70 72  r the trigger pr
19270 6f 67 72 61 6d 20 0a 2a 2a 20 20 20 20 20 20 20  ogram .**       
19280 20 68 61 73 20 66 69 6e 69 73 68 65 64 2c 20 74   has finished, t
19290 68 65 20 6f 72 69 67 69 6e 61 6c 20 76 61 6c 75  he original valu
192a0 65 20 69 73 20 72 65 73 74 6f 72 65 64 2e 29 5e  e is restored.)^
192b0 0a 2a 2a 20 0a 2a 2a 20 20 20 3c 6c 69 3e 20 5e  .** .**   <li> ^
192c0 28 57 69 74 68 69 6e 20 61 20 74 72 69 67 67 65  (Within a trigge
192d0 72 20 70 72 6f 67 72 61 6d 20 65 61 63 68 20 49  r program each I
192e0 4e 53 45 52 54 2c 20 55 50 44 41 54 45 20 61 6e  NSERT, UPDATE an
192f0 64 20 44 45 4c 45 54 45 20 0a 2a 2a 20 20 20 20  d DELETE .**    
19300 20 20 20 20 73 74 61 74 65 6d 65 6e 74 20 73 65      statement se
19310 74 73 20 74 68 65 20 76 61 6c 75 65 20 72 65 74  ts the value ret
19320 75 72 6e 65 64 20 62 79 20 73 71 6c 69 74 65 33  urned by sqlite3
19330 5f 63 68 61 6e 67 65 73 28 29 20 0a 2a 2a 20 20  _changes() .**  
19340 20 20 20 20 20 20 75 70 6f 6e 20 63 6f 6d 70 6c        upon compl
19350 65 74 69 6f 6e 20 61 73 20 6e 6f 72 6d 61 6c 2e  etion as normal.
19360 20 4f 66 20 63 6f 75 72 73 65 2c 20 74 68 69 73   Of course, this
19370 20 76 61 6c 75 65 20 77 69 6c 6c 20 6e 6f 74 20   value will not 
19380 69 6e 63 6c 75 64 65 20 0a 2a 2a 20 20 20 20 20  include .**     
19390 20 20 20 61 6e 79 20 63 68 61 6e 67 65 73 20 70     any changes p
193a0 65 72 66 6f 72 6d 65 64 20 62 79 20 73 75 62 2d  erformed by sub-
193b0 74 72 69 67 67 65 72 73 2c 20 61 73 20 74 68 65  triggers, as the
193c0 20 73 71 6c 69 74 65 33 5f 63 68 61 6e 67 65 73   sqlite3_changes
193d0 28 29 20 0a 2a 2a 20 20 20 20 20 20 20 20 76 61  () .**        va
193e0 6c 75 65 20 77 69 6c 6c 20 62 65 20 73 61 76 65  lue will be save
193f0 64 20 61 6e 64 20 72 65 73 74 6f 72 65 64 20 61  d and restored a
19400 66 74 65 72 20 65 61 63 68 20 73 75 62 2d 74 72  fter each sub-tr
19410 69 67 67 65 72 20 68 61 73 20 72 75 6e 2e 29 5e  igger has run.)^
19420 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 20 0a 2a 2a  .** </ul>.** .**
19430 20 5e 54 68 69 73 20 6d 65 61 6e 73 20 74 68 61   ^This means tha
19440 74 20 69 66 20 74 68 65 20 63 68 61 6e 67 65 73  t if the changes
19450 28 29 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20  () SQL function 
19460 28 6f 72 20 73 69 6d 69 6c 61 72 29 20 69 73 20  (or similar) is 
19470 75 73 65 64 0a 2a 2a 20 62 79 20 74 68 65 20 66  used.** by the f
19480 69 72 73 74 20 49 4e 53 45 52 54 2c 20 55 50 44  irst INSERT, UPD
19490 41 54 45 20 6f 72 20 44 45 4c 45 54 45 20 73 74  ATE or DELETE st
194a0 61 74 65 6d 65 6e 74 20 77 69 74 68 69 6e 20 61  atement within a
194b0 20 74 72 69 67 67 65 72 2c 20 69 74 20 0a 2a 2a   trigger, it .**
194c0 20 72 65 74 75 72 6e 73 20 74 68 65 20 76 61 6c   returns the val
194d0 75 65 20 61 73 20 73 65 74 20 77 68 65 6e 20 74  ue as set when t
194e0 68 65 20 63 61 6c 6c 69 6e 67 20 73 74 61 74 65  he calling state
194f0 6d 65 6e 74 20 62 65 67 61 6e 20 65 78 65 63 75  ment began execu
19500 74 69 6e 67 2e 0a 2a 2a 20 5e 49 66 20 69 74 20  ting..** ^If it 
19510 69 73 20 75 73 65 64 20 62 79 20 74 68 65 20 73  is used by the s
19520 65 63 6f 6e 64 20 6f 72 20 73 75 62 73 65 71 75  econd or subsequ
19530 65 6e 74 20 73 75 63 68 20 73 74 61 74 65 6d 65  ent such stateme
19540 6e 74 20 77 69 74 68 69 6e 20 61 20 74 72 69 67  nt within a trig
19550 67 65 72 20 0a 2a 2a 20 70 72 6f 67 72 61 6d 2c  ger .** program,
19560 20 74 68 65 20 76 61 6c 75 65 20 72 65 74 75 72   the value retur
19570 6e 65 64 20 72 65 66 6c 65 63 74 73 20 74 68 65  ned reflects the
19580 20 6e 75 6d 62 65 72 20 6f 66 20 72 6f 77 73 20   number of rows 
19590 6d 6f 64 69 66 69 65 64 20 62 79 20 74 68 65 20  modified by the 
195a0 0a 2a 2a 20 70 72 65 76 69 6f 75 73 20 49 4e 53  .** previous INS
195b0 45 52 54 2c 20 55 50 44 41 54 45 20 6f 72 20 44  ERT, UPDATE or D
195c0 45 4c 45 54 45 20 73 74 61 74 65 6d 65 6e 74 20  ELETE statement 
195d0 77 69 74 68 69 6e 20 74 68 65 20 73 61 6d 65 20  within the same 
195e0 74 72 69 67 67 65 72 2e 0a 2a 2a 0a 2a 2a 20 53  trigger..**.** S
195f0 65 65 20 61 6c 73 6f 20 74 68 65 20 5b 73 71 6c  ee also the [sql
19600 69 74 65 33 5f 74 6f 74 61 6c 5f 63 68 61 6e 67  ite3_total_chang
19610 65 73 28 29 5d 20 69 6e 74 65 72 66 61 63 65 2c  es()] interface,
19620 20 74 68 65 0a 2a 2a 20 5b 63 6f 75 6e 74 5f 63   the.** [count_c
19630 68 61 6e 67 65 73 20 70 72 61 67 6d 61 5d 2c 20  hanges pragma], 
19640 61 6e 64 20 74 68 65 20 5b 63 68 61 6e 67 65 73  and the [changes
19650 28 29 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 5d  () SQL function]
19660 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 61 20 73 65 70  ..**.** If a sep
19670 61 72 61 74 65 20 74 68 72 65 61 64 20 6d 61 6b  arate thread mak
19680 65 73 20 63 68 61 6e 67 65 73 20 6f 6e 20 74 68  es changes on th
19690 65 20 73 61 6d 65 20 64 61 74 61 62 61 73 65 20  e same database 
196a0 63 6f 6e 6e 65 63 74 69 6f 6e 0a 2a 2a 20 77 68  connection.** wh
196b0 69 6c 65 20 5b 73 71 6c 69 74 65 33 5f 63 68 61  ile [sqlite3_cha
196c0 6e 67 65 73 28 29 5d 20 69 73 20 72 75 6e 6e 69  nges()] is runni
196d0 6e 67 20 74 68 65 6e 20 74 68 65 20 76 61 6c 75  ng then the valu
196e0 65 20 72 65 74 75 72 6e 65 64 0a 2a 2a 20 69 73  e returned.** is
196f0 20 75 6e 70 72 65 64 69 63 74 61 62 6c 65 20 61   unpredictable a
19700 6e 64 20 6e 6f 74 20 6d 65 61 6e 69 6e 67 66 75  nd not meaningfu
19710 6c 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  l..*/.int sqlite
19720 33 5f 63 68 61 6e 67 65 73 28 73 71 6c 69 74 65  3_changes(sqlite
19730 33 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  3*);../*.** CAPI
19740 33 52 45 46 3a 20 54 6f 74 61 6c 20 4e 75 6d 62  3REF: Total Numb
19750 65 72 20 4f 66 20 52 6f 77 73 20 4d 6f 64 69 66  er Of Rows Modif
19760 69 65 64 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73  ied.** METHOD: s
19770 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 54 68  qlite3.**.** ^Th
19780 69 73 20 66 75 6e 63 74 69 6f 6e 20 72 65 74 75  is function retu
19790 72 6e 73 20 74 68 65 20 74 6f 74 61 6c 20 6e 75  rns the total nu
197a0 6d 62 65 72 20 6f 66 20 72 6f 77 73 20 69 6e 73  mber of rows ins
197b0 65 72 74 65 64 2c 20 6d 6f 64 69 66 69 65 64 20  erted, modified 
197c0 6f 72 0a 2a 2a 20 64 65 6c 65 74 65 64 20 62 79  or.** deleted by
197d0 20 61 6c 6c 20 5b 49 4e 53 45 52 54 5d 2c 20 5b   all [INSERT], [
197e0 55 50 44 41 54 45 5d 20 6f 72 20 5b 44 45 4c 45  UPDATE] or [DELE
197f0 54 45 5d 20 73 74 61 74 65 6d 65 6e 74 73 20 63  TE] statements c
19800 6f 6d 70 6c 65 74 65 64 0a 2a 2a 20 73 69 6e 63  ompleted.** sinc
19810 65 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63  e the database c
19820 6f 6e 6e 65 63 74 69 6f 6e 20 77 61 73 20 6f 70  onnection was op
19830 65 6e 65 64 2c 20 69 6e 63 6c 75 64 69 6e 67 20  ened, including 
19840 74 68 6f 73 65 20 65 78 65 63 75 74 65 64 20 61  those executed a
19850 73 0a 2a 2a 20 70 61 72 74 20 6f 66 20 74 72 69  s.** part of tri
19860 67 67 65 72 20 70 72 6f 67 72 61 6d 73 2e 20 5e  gger programs. ^
19870 45 78 65 63 75 74 69 6e 67 20 61 6e 79 20 6f 74  Executing any ot
19880 68 65 72 20 74 79 70 65 20 6f 66 20 53 51 4c 20  her type of SQL 
19890 73 74 61 74 65 6d 65 6e 74 0a 2a 2a 20 64 6f 65  statement.** doe
198a0 73 20 6e 6f 74 20 61 66 66 65 63 74 20 74 68 65  s not affect the
198b0 20 76 61 6c 75 65 20 72 65 74 75 72 6e 65 64 20   value returned 
198c0 62 79 20 73 71 6c 69 74 65 33 5f 74 6f 74 61 6c  by sqlite3_total
198d0 5f 63 68 61 6e 67 65 73 28 29 2e 0a 2a 2a 20 0a  _changes()..** .
198e0 2a 2a 20 5e 43 68 61 6e 67 65 73 20 6d 61 64 65  ** ^Changes made
198f0 20 61 73 20 70 61 72 74 20 6f 66 20 5b 66 6f 72   as part of [for
19900 65 69 67 6e 20 6b 65 79 20 61 63 74 69 6f 6e 73  eign key actions
19910 5d 20 61 72 65 20 69 6e 63 6c 75 64 65 64 20 69  ] are included i
19920 6e 20 74 68 65 0a 2a 2a 20 63 6f 75 6e 74 2c 20  n the.** count, 
19930 62 75 74 20 74 68 6f 73 65 20 6d 61 64 65 20 61  but those made a
19940 73 20 70 61 72 74 20 6f 66 20 52 45 50 4c 41 43  s part of REPLAC
19950 45 20 63 6f 6e 73 74 72 61 69 6e 74 20 72 65 73  E constraint res
19960 6f 6c 75 74 69 6f 6e 20 61 72 65 0a 2a 2a 20 6e  olution are.** n
19970 6f 74 2e 20 5e 43 68 61 6e 67 65 73 20 74 6f 20  ot. ^Changes to 
19980 61 20 76 69 65 77 20 74 68 61 74 20 61 72 65 20  a view that are 
19990 69 6e 74 65 72 63 65 70 74 65 64 20 62 79 20 49  intercepted by I
199a0 4e 53 54 45 41 44 20 4f 46 20 74 72 69 67 67 65  NSTEAD OF trigge
199b0 72 73 20 0a 2a 2a 20 61 72 65 20 6e 6f 74 20 63  rs .** are not c
199c0 6f 75 6e 74 65 64 2e 0a 2a 2a 20 0a 2a 2a 20 53  ounted..** .** S
199d0 65 65 20 61 6c 73 6f 20 74 68 65 20 5b 73 71 6c  ee also the [sql
199e0 69 74 65 33 5f 63 68 61 6e 67 65 73 28 29 5d 20  ite3_changes()] 
199f0 69 6e 74 65 72 66 61 63 65 2c 20 74 68 65 0a 2a  interface, the.*
19a00 2a 20 5b 63 6f 75 6e 74 5f 63 68 61 6e 67 65 73  * [count_changes
19a10 20 70 72 61 67 6d 61 5d 2c 20 61 6e 64 20 74 68   pragma], and th
19a20 65 20 5b 74 6f 74 61 6c 5f 63 68 61 6e 67 65 73  e [total_changes
19a30 28 29 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 5d  () SQL function]
19a40 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 61 20 73 65 70  ..**.** If a sep
19a50 61 72 61 74 65 20 74 68 72 65 61 64 20 6d 61 6b  arate thread mak
19a60 65 73 20 63 68 61 6e 67 65 73 20 6f 6e 20 74 68  es changes on th
19a70 65 20 73 61 6d 65 20 64 61 74 61 62 61 73 65 20  e same database 
19a80 63 6f 6e 6e 65 63 74 69 6f 6e 0a 2a 2a 20 77 68  connection.** wh
19a90 69 6c 65 20 5b 73 71 6c 69 74 65 33 5f 74 6f 74  ile [sqlite3_tot
19aa0 61 6c 5f 63 68 61 6e 67 65 73 28 29 5d 20 69 73  al_changes()] is
19ab0 20 72 75 6e 6e 69 6e 67 20 74 68 65 6e 20 74 68   running then th
19ac0 65 20 76 61 6c 75 65 0a 2a 2a 20 72 65 74 75 72  e value.** retur
19ad0 6e 65 64 20 69 73 20 75 6e 70 72 65 64 69 63 74  ned is unpredict
19ae0 61 62 6c 65 20 61 6e 64 20 6e 6f 74 20 6d 65 61  able and not mea
19af0 6e 69 6e 67 66 75 6c 2e 0a 2a 2f 0a 69 6e 74 20  ningful..*/.int 
19b00 73 71 6c 69 74 65 33 5f 74 6f 74 61 6c 5f 63 68  sqlite3_total_ch
19b10 61 6e 67 65 73 28 73 71 6c 69 74 65 33 2a 29 3b  anges(sqlite3*);
19b20 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
19b30 3a 20 49 6e 74 65 72 72 75 70 74 20 41 20 4c 6f  : Interrupt A Lo
19b40 6e 67 2d 52 75 6e 6e 69 6e 67 20 51 75 65 72 79  ng-Running Query
19b50 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69  .** METHOD: sqli
19b60 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 54 68 69 73 20  te3.**.** ^This 
19b70 66 75 6e 63 74 69 6f 6e 20 63 61 75 73 65 73 20  function causes 
19b80 61 6e 79 20 70 65 6e 64 69 6e 67 20 64 61 74 61  any pending data
19b90 62 61 73 65 20 6f 70 65 72 61 74 69 6f 6e 20 74  base operation t
19ba0 6f 20 61 62 6f 72 74 20 61 6e 64 0a 2a 2a 20 72  o abort and.** r
19bb0 65 74 75 72 6e 20 61 74 20 69 74 73 20 65 61 72  eturn at its ear
19bc0 6c 69 65 73 74 20 6f 70 70 6f 72 74 75 6e 69 74  liest opportunit
19bd0 79 2e 20 54 68 69 73 20 72 6f 75 74 69 6e 65 20  y. This routine 
19be0 69 73 20 74 79 70 69 63 61 6c 6c 79 0a 2a 2a 20  is typically.** 
19bf0 63 61 6c 6c 65 64 20 69 6e 20 72 65 73 70 6f 6e  called in respon
19c00 73 65 20 74 6f 20 61 20 75 73 65 72 20 61 63 74  se to a user act
19c10 69 6f 6e 20 73 75 63 68 20 61 73 20 70 72 65 73  ion such as pres
19c20 73 69 6e 67 20 22 43 61 6e 63 65 6c 22 0a 2a 2a  sing "Cancel".**
19c30 20 6f 72 20 43 74 72 6c 2d 43 20 77 68 65 72 65   or Ctrl-C where
19c40 20 74 68 65 20 75 73 65 72 20 77 61 6e 74 73 20   the user wants 
19c50 61 20 6c 6f 6e 67 20 71 75 65 72 79 20 6f 70 65  a long query ope
19c60 72 61 74 69 6f 6e 20 74 6f 20 68 61 6c 74 0a 2a  ration to halt.*
19c70 2a 20 69 6d 6d 65 64 69 61 74 65 6c 79 2e 0a 2a  * immediately..*
19c80 2a 0a 2a 2a 20 5e 49 74 20 69 73 20 73 61 66 65  *.** ^It is safe
19c90 20 74 6f 20 63 61 6c 6c 20 74 68 69 73 20 72 6f   to call this ro
19ca0 75 74 69 6e 65 20 66 72 6f 6d 20 61 20 74 68 72  utine from a thr
19cb0 65 61 64 20 64 69 66 66 65 72 65 6e 74 20 66 72  ead different fr
19cc0 6f 6d 20 74 68 65 0a 2a 2a 20 74 68 72 65 61 64  om the.** thread
19cd0 20 74 68 61 74 20 69 73 20 63 75 72 72 65 6e 74   that is current
19ce0 6c 79 20 72 75 6e 6e 69 6e 67 20 74 68 65 20 64  ly running the d
19cf0 61 74 61 62 61 73 65 20 6f 70 65 72 61 74 69 6f  atabase operatio
19d00 6e 2e 20 20 42 75 74 20 69 74 0a 2a 2a 20 69 73  n.  But it.** is
19d10 20 6e 6f 74 20 73 61 66 65 20 74 6f 20 63 61 6c   not safe to cal
19d20 6c 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 77  l this routine w
19d30 69 74 68 20 61 20 5b 64 61 74 61 62 61 73 65 20  ith a [database 
19d40 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 74 68 61 74  connection] that
19d50 0a 2a 2a 20 69 73 20 63 6c 6f 73 65 64 20 6f 72  .** is closed or
19d60 20 6d 69 67 68 74 20 63 6c 6f 73 65 20 62 65 66   might close bef
19d70 6f 72 65 20 73 71 6c 69 74 65 33 5f 69 6e 74 65  ore sqlite3_inte
19d80 72 72 75 70 74 28 29 20 72 65 74 75 72 6e 73 2e  rrupt() returns.
19d90 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 61 6e 20 53 51  .**.** ^If an SQ
19da0 4c 20 6f 70 65 72 61 74 69 6f 6e 20 69 73 20 76  L operation is v
19db0 65 72 79 20 6e 65 61 72 6c 79 20 66 69 6e 69 73  ery nearly finis
19dc0 68 65 64 20 61 74 20 74 68 65 20 74 69 6d 65 20  hed at the time 
19dd0 77 68 65 6e 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  when.** sqlite3_
19de0 69 6e 74 65 72 72 75 70 74 28 29 20 69 73 20 63  interrupt() is c
19df0 61 6c 6c 65 64 2c 20 74 68 65 6e 20 69 74 20 6d  alled, then it m
19e00 69 67 68 74 20 6e 6f 74 20 68 61 76 65 20 61 6e  ight not have an
19e10 20 6f 70 70 6f 72 74 75 6e 69 74 79 0a 2a 2a 20   opportunity.** 
19e20 74 6f 20 62 65 20 69 6e 74 65 72 72 75 70 74 65  to be interrupte
19e30 64 20 61 6e 64 20 6d 69 67 68 74 20 63 6f 6e 74  d and might cont
19e40 69 6e 75 65 20 74 6f 20 63 6f 6d 70 6c 65 74 69  inue to completi
19e50 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 41 6e 20 53 51  on..**.** ^An SQ
19e60 4c 20 6f 70 65 72 61 74 69 6f 6e 20 74 68 61 74  L operation that
19e70 20 69 73 20 69 6e 74 65 72 72 75 70 74 65 64 20   is interrupted 
19e80 77 69 6c 6c 20 72 65 74 75 72 6e 20 5b 53 51 4c  will return [SQL
19e90 49 54 45 5f 49 4e 54 45 52 52 55 50 54 5d 2e 0a  ITE_INTERRUPT]..
19ea0 2a 2a 20 5e 49 66 20 74 68 65 20 69 6e 74 65 72  ** ^If the inter
19eb0 72 75 70 74 65 64 20 53 51 4c 20 6f 70 65 72 61  rupted SQL opera
19ec0 74 69 6f 6e 20 69 73 20 61 6e 20 49 4e 53 45 52  tion is an INSER
19ed0 54 2c 20 55 50 44 41 54 45 2c 20 6f 72 20 44 45  T, UPDATE, or DE
19ee0 4c 45 54 45 0a 2a 2a 20 74 68 61 74 20 69 73 20  LETE.** that is 
19ef0 69 6e 73 69 64 65 20 61 6e 20 65 78 70 6c 69 63  inside an explic
19f00 69 74 20 74 72 61 6e 73 61 63 74 69 6f 6e 2c 20  it transaction, 
19f10 74 68 65 6e 20 74 68 65 20 65 6e 74 69 72 65 20  then the entire 
19f20 74 72 61 6e 73 61 63 74 69 6f 6e 0a 2a 2a 20 77  transaction.** w
19f30 69 6c 6c 20 62 65 20 72 6f 6c 6c 65 64 20 62 61  ill be rolled ba
19f40 63 6b 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79  ck automatically
19f50 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  ..**.** ^The sql
19f60 69 74 65 33 5f 69 6e 74 65 72 72 75 70 74 28 44  ite3_interrupt(D
19f70 29 20 63 61 6c 6c 20 69 73 20 69 6e 20 65 66 66  ) call is in eff
19f80 65 63 74 20 75 6e 74 69 6c 20 61 6c 6c 20 63 75  ect until all cu
19f90 72 72 65 6e 74 6c 79 20 72 75 6e 6e 69 6e 67 0a  rrently running.
19fa0 2a 2a 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  ** SQL statement
19fb0 73 20 6f 6e 20 5b 64 61 74 61 62 61 73 65 20 63  s on [database c
19fc0 6f 6e 6e 65 63 74 69 6f 6e 5d 20 44 20 63 6f 6d  onnection] D com
19fd0 70 6c 65 74 65 2e 20 20 5e 41 6e 79 20 6e 65 77  plete.  ^Any new
19fe0 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 0a   SQL statements.
19ff0 2a 2a 20 74 68 61 74 20 61 72 65 20 73 74 61 72  ** that are star
1a000 74 65 64 20 61 66 74 65 72 20 74 68 65 20 73 71  ted after the sq
1a010 6c 69 74 65 33 5f 69 6e 74 65 72 72 75 70 74 28  lite3_interrupt(
1a020 29 20 63 61 6c 6c 20 61 6e 64 20 62 65 66 6f 72  ) call and befor
1a030 65 20 74 68 65 20 0a 2a 2a 20 72 75 6e 6e 69 6e  e the .** runnin
1a040 67 20 73 74 61 74 65 6d 65 6e 74 73 20 72 65 61  g statements rea
1a050 63 68 65 73 20 7a 65 72 6f 20 61 72 65 20 69 6e  ches zero are in
1a060 74 65 72 72 75 70 74 65 64 20 61 73 20 69 66 20  terrupted as if 
1a070 74 68 65 79 20 68 61 64 20 62 65 65 6e 0a 2a 2a  they had been.**
1a080 20 72 75 6e 6e 69 6e 67 20 70 72 69 6f 72 20 74   running prior t
1a090 6f 20 74 68 65 20 73 71 6c 69 74 65 33 5f 69 6e  o the sqlite3_in
1a0a0 74 65 72 72 75 70 74 28 29 20 63 61 6c 6c 2e 20  terrupt() call. 
1a0b0 20 5e 4e 65 77 20 53 51 4c 20 73 74 61 74 65 6d   ^New SQL statem
1a0c0 65 6e 74 73 0a 2a 2a 20 74 68 61 74 20 61 72 65  ents.** that are
1a0d0 20 73 74 61 72 74 65 64 20 61 66 74 65 72 20 74   started after t
1a0e0 68 65 20 72 75 6e 6e 69 6e 67 20 73 74 61 74 65  he running state
1a0f0 6d 65 6e 74 20 63 6f 75 6e 74 20 72 65 61 63 68  ment count reach
1a100 65 73 20 7a 65 72 6f 20 61 72 65 0a 2a 2a 20 6e  es zero are.** n
1a110 6f 74 20 65 66 66 65 63 74 65 64 20 62 79 20 74  ot effected by t
1a120 68 65 20 73 71 6c 69 74 65 33 5f 69 6e 74 65 72  he sqlite3_inter
1a130 72 75 70 74 28 29 2e 0a 2a 2a 20 5e 41 20 63 61  rupt()..** ^A ca
1a140 6c 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f 69 6e  ll to sqlite3_in
1a150 74 65 72 72 75 70 74 28 44 29 20 74 68 61 74 20  terrupt(D) that 
1a160 6f 63 63 75 72 73 20 77 68 65 6e 20 74 68 65 72  occurs when ther
1a170 65 20 61 72 65 20 6e 6f 20 72 75 6e 6e 69 6e 67  e are no running
1a180 0a 2a 2a 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  .** SQL statemen
1a190 74 73 20 69 73 20 61 20 6e 6f 2d 6f 70 20 61 6e  ts is a no-op an
1a1a0 64 20 68 61 73 20 6e 6f 20 65 66 66 65 63 74 20  d has no effect 
1a1b0 6f 6e 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  on SQL statement
1a1c0 73 0a 2a 2a 20 74 68 61 74 20 61 72 65 20 73 74  s.** that are st
1a1d0 61 72 74 65 64 20 61 66 74 65 72 20 74 68 65 20  arted after the 
1a1e0 73 71 6c 69 74 65 33 5f 69 6e 74 65 72 72 75 70  sqlite3_interrup
1a1f0 74 28 29 20 63 61 6c 6c 20 72 65 74 75 72 6e 73  t() call returns
1a200 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 74 68 65 20 64  ..**.** If the d
1a210 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
1a220 6f 6e 20 63 6c 6f 73 65 73 20 77 68 69 6c 65 20  on closes while 
1a230 5b 73 71 6c 69 74 65 33 5f 69 6e 74 65 72 72 75  [sqlite3_interru
1a240 70 74 28 29 5d 0a 2a 2a 20 69 73 20 72 75 6e 6e  pt()].** is runn
1a250 69 6e 67 20 74 68 65 6e 20 62 61 64 20 74 68 69  ing then bad thi
1a260 6e 67 73 20 77 69 6c 6c 20 6c 69 6b 65 6c 79 20  ngs will likely 
1a270 68 61 70 70 65 6e 2e 0a 2a 2f 0a 76 6f 69 64 20  happen..*/.void 
1a280 73 71 6c 69 74 65 33 5f 69 6e 74 65 72 72 75 70  sqlite3_interrup
1a290 74 28 73 71 6c 69 74 65 33 2a 29 3b 0a 0a 2f 2a  t(sqlite3*);../*
1a2a0 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 44 65  .** CAPI3REF: De
1a2b0 74 65 72 6d 69 6e 65 20 49 66 20 41 6e 20 53 51  termine If An SQ
1a2c0 4c 20 53 74 61 74 65 6d 65 6e 74 20 49 73 20 43  L Statement Is C
1a2d0 6f 6d 70 6c 65 74 65 0a 2a 2a 0a 2a 2a 20 54 68  omplete.**.** Th
1a2e0 65 73 65 20 72 6f 75 74 69 6e 65 73 20 61 72 65  ese routines are
1a2f0 20 75 73 65 66 75 6c 20 64 75 72 69 6e 67 20 63   useful during c
1a300 6f 6d 6d 61 6e 64 2d 6c 69 6e 65 20 69 6e 70 75  ommand-line inpu
1a310 74 20 74 6f 20 64 65 74 65 72 6d 69 6e 65 20 69  t to determine i
1a320 66 20 74 68 65 0a 2a 2a 20 63 75 72 72 65 6e 74  f the.** current
1a330 6c 79 20 65 6e 74 65 72 65 64 20 74 65 78 74 20  ly entered text 
1a340 73 65 65 6d 73 20 74 6f 20 66 6f 72 6d 20 61 20  seems to form a 
1a350 63 6f 6d 70 6c 65 74 65 20 53 51 4c 20 73 74 61  complete SQL sta
1a360 74 65 6d 65 6e 74 20 6f 72 0a 2a 2a 20 69 66 20  tement or.** if 
1a370 61 64 64 69 74 69 6f 6e 61 6c 20 69 6e 70 75 74  additional input
1a380 20 69 73 20 6e 65 65 64 65 64 20 62 65 66 6f 72   is needed befor
1a390 65 20 73 65 6e 64 69 6e 67 20 74 68 65 20 74 65  e sending the te
1a3a0 78 74 20 69 6e 74 6f 0a 2a 2a 20 53 51 4c 69 74  xt into.** SQLit
1a3b0 65 20 66 6f 72 20 70 61 72 73 69 6e 67 2e 20 20  e for parsing.  
1a3c0 5e 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20  ^These routines 
1a3d0 72 65 74 75 72 6e 20 31 20 69 66 20 74 68 65 20  return 1 if the 
1a3e0 69 6e 70 75 74 20 73 74 72 69 6e 67 0a 2a 2a 20  input string.** 
1a3f0 61 70 70 65 61 72 73 20 74 6f 20 62 65 20 61 20  appears to be a 
1a400 63 6f 6d 70 6c 65 74 65 20 53 51 4c 20 73 74 61  complete SQL sta
1a410 74 65 6d 65 6e 74 2e 20 20 5e 41 20 73 74 61 74  tement.  ^A stat
1a420 65 6d 65 6e 74 20 69 73 20 6a 75 64 67 65 64 20  ement is judged 
1a430 74 6f 20 62 65 0a 2a 2a 20 63 6f 6d 70 6c 65 74  to be.** complet
1a440 65 20 69 66 20 69 74 20 65 6e 64 73 20 77 69 74  e if it ends wit
1a450 68 20 61 20 73 65 6d 69 63 6f 6c 6f 6e 20 74 6f  h a semicolon to
1a460 6b 65 6e 20 61 6e 64 20 69 73 20 6e 6f 74 20 61  ken and is not a
1a470 20 70 72 65 66 69 78 20 6f 66 20 61 0a 2a 2a 20   prefix of a.** 
1a480 77 65 6c 6c 2d 66 6f 72 6d 65 64 20 43 52 45 41  well-formed CREA
1a490 54 45 20 54 52 49 47 47 45 52 20 73 74 61 74 65  TE TRIGGER state
1a4a0 6d 65 6e 74 2e 20 20 5e 53 65 6d 69 63 6f 6c 6f  ment.  ^Semicolo
1a4b0 6e 73 20 74 68 61 74 20 61 72 65 20 65 6d 62 65  ns that are embe
1a4c0 64 64 65 64 20 77 69 74 68 69 6e 0a 2a 2a 20 73  dded within.** s
1a4d0 74 72 69 6e 67 20 6c 69 74 65 72 61 6c 73 20 6f  tring literals o
1a4e0 72 20 71 75 6f 74 65 64 20 69 64 65 6e 74 69 66  r quoted identif
1a4f0 69 65 72 20 6e 61 6d 65 73 20 6f 72 20 63 6f 6d  ier names or com
1a500 6d 65 6e 74 73 20 61 72 65 20 6e 6f 74 0a 2a 2a  ments are not.**
1a510 20 69 6e 64 65 70 65 6e 64 65 6e 74 20 74 6f 6b   independent tok
1a520 65 6e 73 20 28 74 68 65 79 20 61 72 65 20 70 61  ens (they are pa
1a530 72 74 20 6f 66 20 74 68 65 20 74 6f 6b 65 6e 20  rt of the token 
1a540 69 6e 20 77 68 69 63 68 20 74 68 65 79 20 61 72  in which they ar
1a550 65 0a 2a 2a 20 65 6d 62 65 64 64 65 64 29 20 61  e.** embedded) a
1a560 6e 64 20 74 68 75 73 20 64 6f 20 6e 6f 74 20 63  nd thus do not c
1a570 6f 75 6e 74 20 61 73 20 61 20 73 74 61 74 65 6d  ount as a statem
1a580 65 6e 74 20 74 65 72 6d 69 6e 61 74 6f 72 2e 20  ent terminator. 
1a590 20 5e 57 68 69 74 65 73 70 61 63 65 0a 2a 2a 20   ^Whitespace.** 
1a5a0 61 6e 64 20 63 6f 6d 6d 65 6e 74 73 20 74 68 61  and comments tha
1a5b0 74 20 66 6f 6c 6c 6f 77 20 74 68 65 20 66 69 6e  t follow the fin
1a5c0 61 6c 20 73 65 6d 69 63 6f 6c 6f 6e 20 61 72 65  al semicolon are
1a5d0 20 69 67 6e 6f 72 65 64 2e 0a 2a 2a 0a 2a 2a 20   ignored..**.** 
1a5e0 5e 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20  ^These routines 
1a5f0 72 65 74 75 72 6e 20 30 20 69 66 20 74 68 65 20  return 0 if the 
1a600 73 74 61 74 65 6d 65 6e 74 20 69 73 20 69 6e 63  statement is inc
1a610 6f 6d 70 6c 65 74 65 2e 20 20 5e 49 66 20 61 0a  omplete.  ^If a.
1a620 2a 2a 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  ** memory alloca
1a630 74 69 6f 6e 20 66 61 69 6c 73 2c 20 74 68 65 6e  tion fails, then
1a640 20 53 51 4c 49 54 45 5f 4e 4f 4d 45 4d 20 69 73   SQLITE_NOMEM is
1a650 20 72 65 74 75 72 6e 65 64 2e 0a 2a 2a 0a 2a 2a   returned..**.**
1a660 20 5e 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73   ^These routines
1a670 20 64 6f 20 6e 6f 74 20 70 61 72 73 65 20 74 68   do not parse th
1a680 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73  e SQL statements
1a690 20 74 68 75 73 0a 2a 2a 20 77 69 6c 6c 20 6e 6f   thus.** will no
1a6a0 74 20 64 65 74 65 63 74 20 73 79 6e 74 61 63 74  t detect syntact
1a6b0 69 63 61 6c 6c 79 20 69 6e 63 6f 72 72 65 63 74  ically incorrect
1a6c0 20 53 51 4c 2e 0a 2a 2a 0a 2a 2a 20 5e 28 49 66   SQL..**.** ^(If
1a6d0 20 53 51 4c 69 74 65 20 68 61 73 20 6e 6f 74 20   SQLite has not 
1a6e0 62 65 65 6e 20 69 6e 69 74 69 61 6c 69 7a 65 64  been initialized
1a6f0 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f   using [sqlite3_
1a700 69 6e 69 74 69 61 6c 69 7a 65 28 29 5d 20 70 72  initialize()] pr
1a710 69 6f 72 20 0a 2a 2a 20 74 6f 20 69 6e 76 6f 6b  ior .** to invok
1a720 69 6e 67 20 73 71 6c 69 74 65 33 5f 63 6f 6d 70  ing sqlite3_comp
1a730 6c 65 74 65 31 36 28 29 20 74 68 65 6e 20 73 71  lete16() then sq
1a740 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65  lite3_initialize
1a750 28 29 20 69 73 20 69 6e 76 6f 6b 65 64 0a 2a 2a  () is invoked.**
1a760 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 62   automatically b
1a770 79 20 73 71 6c 69 74 65 33 5f 63 6f 6d 70 6c 65  y sqlite3_comple
1a780 74 65 31 36 28 29 2e 20 20 49 66 20 74 68 61 74  te16().  If that
1a790 20 69 6e 69 74 69 61 6c 69 7a 61 74 69 6f 6e 20   initialization 
1a7a0 66 61 69 6c 73 2c 0a 2a 2a 20 74 68 65 6e 20 74  fails,.** then t
1a7b0 68 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 20  he return value 
1a7c0 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f 63 6f 6d  from sqlite3_com
1a7d0 70 6c 65 74 65 31 36 28 29 20 77 69 6c 6c 20 62  plete16() will b
1a7e0 65 20 6e 6f 6e 2d 7a 65 72 6f 0a 2a 2a 20 72 65  e non-zero.** re
1a7f0 67 61 72 64 6c 65 73 73 20 6f 66 20 77 68 65 74  gardless of whet
1a800 68 65 72 20 6f 72 20 6e 6f 74 20 74 68 65 20 69  her or not the i
1a810 6e 70 75 74 20 53 51 4c 20 69 73 20 63 6f 6d 70  nput SQL is comp
1a820 6c 65 74 65 2e 29 5e 0a 2a 2a 0a 2a 2a 20 54 68  lete.)^.**.** Th
1a830 65 20 69 6e 70 75 74 20 74 6f 20 5b 73 71 6c 69  e input to [sqli
1a840 74 65 33 5f 63 6f 6d 70 6c 65 74 65 28 29 5d 20  te3_complete()] 
1a850 6d 75 73 74 20 62 65 20 61 20 7a 65 72 6f 2d 74  must be a zero-t
1a860 65 72 6d 69 6e 61 74 65 64 0a 2a 2a 20 55 54 46  erminated.** UTF
1a870 2d 38 20 73 74 72 69 6e 67 2e 0a 2a 2a 0a 2a 2a  -8 string..**.**
1a880 20 54 68 65 20 69 6e 70 75 74 20 74 6f 20 5b 73   The input to [s
1a890 71 6c 69 74 65 33 5f 63 6f 6d 70 6c 65 74 65 31  qlite3_complete1
1a8a0 36 28 29 5d 20 6d 75 73 74 20 62 65 20 61 20 7a  6()] must be a z
1a8b0 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 0a 2a  ero-terminated.*
1a8c0 2a 20 55 54 46 2d 31 36 20 73 74 72 69 6e 67 20  * UTF-16 string 
1a8d0 69 6e 20 6e 61 74 69 76 65 20 62 79 74 65 20 6f  in native byte o
1a8e0 72 64 65 72 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c  rder..*/.int sql
1a8f0 69 74 65 33 5f 63 6f 6d 70 6c 65 74 65 28 63 6f  ite3_complete(co
1a900 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 29 3b 0a  nst char *sql);.
1a910 69 6e 74 20 73 71 6c 69 74 65 33 5f 63 6f 6d 70  int sqlite3_comp
1a920 6c 65 74 65 31 36 28 63 6f 6e 73 74 20 76 6f 69  lete16(const voi
1a930 64 20 2a 73 71 6c 29 3b 0a 0a 2f 2a 0a 2a 2a 20  d *sql);../*.** 
1a940 43 41 50 49 33 52 45 46 3a 20 52 65 67 69 73 74  CAPI3REF: Regist
1a950 65 72 20 41 20 43 61 6c 6c 62 61 63 6b 20 54 6f  er A Callback To
1a960 20 48 61 6e 64 6c 65 20 53 51 4c 49 54 45 5f 42   Handle SQLITE_B
1a970 55 53 59 20 45 72 72 6f 72 73 0a 2a 2a 20 4b 45  USY Errors.** KE
1a980 59 57 4f 52 44 53 3a 20 7b 62 75 73 79 2d 68 61  YWORDS: {busy-ha
1a990 6e 64 6c 65 72 20 63 61 6c 6c 62 61 63 6b 7d 20  ndler callback} 
1a9a0 7b 62 75 73 79 20 68 61 6e 64 6c 65 72 7d 0a 2a  {busy handler}.*
1a9b0 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65  * METHOD: sqlite
1a9c0 33 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  3.**.** ^The sql
1a9d0 69 74 65 33 5f 62 75 73 79 5f 68 61 6e 64 6c 65  ite3_busy_handle
1a9e0 72 28 44 2c 58 2c 50 29 20 72 6f 75 74 69 6e 65  r(D,X,P) routine
1a9f0 20 73 65 74 73 20 61 20 63 61 6c 6c 62 61 63 6b   sets a callback
1aa00 20 66 75 6e 63 74 69 6f 6e 20 58 0a 2a 2a 20 74   function X.** t
1aa10 68 61 74 20 6d 69 67 68 74 20 62 65 20 69 6e 76  hat might be inv
1aa20 6f 6b 65 64 20 77 69 74 68 20 61 72 67 75 6d 65  oked with argume
1aa30 6e 74 20 50 20 77 68 65 6e 65 76 65 72 0a 2a 2a  nt P whenever.**
1aa40 20 61 6e 20 61 74 74 65 6d 70 74 20 69 73 20 6d   an attempt is m
1aa50 61 64 65 20 74 6f 20 61 63 63 65 73 73 20 61 20  ade to access a 
1aa60 64 61 74 61 62 61 73 65 20 74 61 62 6c 65 20 61  database table a
1aa70 73 73 6f 63 69 61 74 65 64 20 77 69 74 68 0a 2a  ssociated with.*
1aa80 2a 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  * [database conn
1aa90 65 63 74 69 6f 6e 5d 20 44 20 77 68 65 6e 20 61  ection] D when a
1aaa0 6e 6f 74 68 65 72 20 74 68 72 65 61 64 0a 2a 2a  nother thread.**
1aab0 20 6f 72 20 70 72 6f 63 65 73 73 20 68 61 73 20   or process has 
1aac0 74 68 65 20 74 61 62 6c 65 20 6c 6f 63 6b 65 64  the table locked
1aad0 2e 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65 33  ..** The sqlite3
1aae0 5f 62 75 73 79 5f 68 61 6e 64 6c 65 72 28 29 20  _busy_handler() 
1aaf0 69 6e 74 65 72 66 61 63 65 20 69 73 20 75 73 65  interface is use
1ab00 64 20 74 6f 20 69 6d 70 6c 65 6d 65 6e 74 0a 2a  d to implement.*
1ab10 2a 20 5b 73 71 6c 69 74 65 33 5f 62 75 73 79 5f  * [sqlite3_busy_
1ab20 74 69 6d 65 6f 75 74 28 29 5d 20 61 6e 64 20 5b  timeout()] and [
1ab30 50 52 41 47 4d 41 20 62 75 73 79 5f 74 69 6d 65  PRAGMA busy_time
1ab40 6f 75 74 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20  out]..**.** ^If 
1ab50 74 68 65 20 62 75 73 79 20 63 61 6c 6c 62 61 63  the busy callbac
1ab60 6b 20 69 73 20 4e 55 4c 4c 2c 20 74 68 65 6e 20  k is NULL, then 
1ab70 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d 0a 2a 2a  [SQLITE_BUSY].**
1ab80 20 69 73 20 72 65 74 75 72 6e 65 64 20 69 6d 6d   is returned imm
1ab90 65 64 69 61 74 65 6c 79 20 75 70 6f 6e 20 65 6e  ediately upon en
1aba0 63 6f 75 6e 74 65 72 69 6e 67 20 74 68 65 20 6c  countering the l
1abb0 6f 63 6b 2e 20 20 5e 49 66 20 74 68 65 20 62 75  ock.  ^If the bu
1abc0 73 79 20 63 61 6c 6c 62 61 63 6b 0a 2a 2a 20 69  sy callback.** i
1abd0 73 20 6e 6f 74 20 4e 55 4c 4c 2c 20 74 68 65 6e  s not NULL, then
1abe0 20 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 6d 69   the callback mi
1abf0 67 68 74 20 62 65 20 69 6e 76 6f 6b 65 64 20 77  ght be invoked w
1ac00 69 74 68 20 74 77 6f 20 61 72 67 75 6d 65 6e 74  ith two argument
1ac10 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66 69  s..**.** ^The fi
1ac20 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f 20  rst argument to 
1ac30 74 68 65 20 62 75 73 79 20 68 61 6e 64 6c 65 72  the busy handler
1ac40 20 69 73 20 61 20 63 6f 70 79 20 6f 66 20 74 68   is a copy of th
1ac50 65 20 76 6f 69 64 2a 20 70 6f 69 6e 74 65 72 20  e void* pointer 
1ac60 77 68 69 63 68 0a 2a 2a 20 69 73 20 74 68 65 20  which.** is the 
1ac70 74 68 69 72 64 20 61 72 67 75 6d 65 6e 74 20 74  third argument t
1ac80 6f 20 73 71 6c 69 74 65 33 5f 62 75 73 79 5f 68  o sqlite3_busy_h
1ac90 61 6e 64 6c 65 72 28 29 2e 20 20 5e 54 68 65 20  andler().  ^The 
1aca0 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20  second argument 
1acb0 74 6f 0a 2a 2a 20 74 68 65 20 62 75 73 79 20 68  to.** the busy h
1acc0 61 6e 64 6c 65 72 20 63 61 6c 6c 62 61 63 6b 20  andler callback 
1acd0 69 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  is the number of
1ace0 20 74 69 6d 65 73 20 74 68 61 74 20 74 68 65 20   times that the 
1acf0 62 75 73 79 20 68 61 6e 64 6c 65 72 20 68 61 73  busy handler has
1ad00 0a 2a 2a 20 62 65 65 6e 20 69 6e 76 6f 6b 65 64  .** been invoked
1ad10 20 70 72 65 76 69 6f 75 73 6c 79 20 66 6f 72 20   previously for 
1ad20 74 68 65 20 73 61 6d 65 20 6c 6f 63 6b 69 6e 67  the same locking
1ad30 20 65 76 65 6e 74 2e 20 20 5e 49 66 20 74 68 65   event.  ^If the
1ad40 0a 2a 2a 20 62 75 73 79 20 63 61 6c 6c 62 61 63  .** busy callbac
1ad50 6b 20 72 65 74 75 72 6e 73 20 30 2c 20 74 68 65  k returns 0, the
1ad60 6e 20 6e 6f 20 61 64 64 69 74 69 6f 6e 61 6c 20  n no additional 
1ad70 61 74 74 65 6d 70 74 73 20 61 72 65 20 6d 61 64  attempts are mad
1ad80 65 20 74 6f 0a 2a 2a 20 61 63 63 65 73 73 20 74  e to.** access t
1ad90 68 65 20 64 61 74 61 62 61 73 65 20 61 6e 64 20  he database and 
1ada0 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d 20 69 73  [SQLITE_BUSY] is
1adb0 20 72 65 74 75 72 6e 65 64 0a 2a 2a 20 74 6f 20   returned.** to 
1adc0 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 2e  the application.
1add0 0a 2a 2a 20 5e 49 66 20 74 68 65 20 63 61 6c 6c  .** ^If the call
1ade0 62 61 63 6b 20 72 65 74 75 72 6e 73 20 6e 6f 6e  back returns non
1adf0 2d 7a 65 72 6f 2c 20 74 68 65 6e 20 61 6e 6f 74  -zero, then anot
1ae00 68 65 72 20 61 74 74 65 6d 70 74 0a 2a 2a 20 69  her attempt.** i
1ae10 73 20 6d 61 64 65 20 74 6f 20 61 63 63 65 73 73  s made to access
1ae20 20 74 68 65 20 64 61 74 61 62 61 73 65 20 61 6e   the database an
1ae30 64 20 74 68 65 20 63 79 63 6c 65 20 72 65 70 65  d the cycle repe
1ae40 61 74 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 70  ats..**.** The p
1ae50 72 65 73 65 6e 63 65 20 6f 66 20 61 20 62 75 73  resence of a bus
1ae60 79 20 68 61 6e 64 6c 65 72 20 64 6f 65 73 20 6e  y handler does n
1ae70 6f 74 20 67 75 61 72 61 6e 74 65 65 20 74 68 61  ot guarantee tha
1ae80 74 20 69 74 20 77 69 6c 6c 20 62 65 20 69 6e 76  t it will be inv
1ae90 6f 6b 65 64 0a 2a 2a 20 77 68 65 6e 20 74 68 65  oked.** when the
1aea0 72 65 20 69 73 20 6c 6f 63 6b 20 63 6f 6e 74 65  re is lock conte
1aeb0 6e 74 69 6f 6e 2e 20 5e 49 66 20 53 51 4c 69 74  ntion. ^If SQLit
1aec0 65 20 64 65 74 65 72 6d 69 6e 65 73 20 74 68 61  e determines tha
1aed0 74 20 69 6e 76 6f 6b 69 6e 67 20 74 68 65 20 62  t invoking the b
1aee0 75 73 79 0a 2a 2a 20 68 61 6e 64 6c 65 72 20 63  usy.** handler c
1aef0 6f 75 6c 64 20 72 65 73 75 6c 74 20 69 6e 20 61  ould result in a
1af00 20 64 65 61 64 6c 6f 63 6b 2c 20 69 74 20 77 69   deadlock, it wi
1af10 6c 6c 20 67 6f 20 61 68 65 61 64 20 61 6e 64 20  ll go ahead and 
1af20 72 65 74 75 72 6e 20 5b 53 51 4c 49 54 45 5f 42  return [SQLITE_B
1af30 55 53 59 5d 0a 2a 2a 20 74 6f 20 74 68 65 20 61  USY].** to the a
1af40 70 70 6c 69 63 61 74 69 6f 6e 20 69 6e 73 74 65  pplication inste
1af50 61 64 20 6f 66 20 69 6e 76 6f 6b 69 6e 67 20 74  ad of invoking t
1af60 68 65 20 0a 2a 2a 20 62 75 73 79 20 68 61 6e 64  he .** busy hand
1af70 6c 65 72 2e 0a 2a 2a 20 43 6f 6e 73 69 64 65 72  ler..** Consider
1af80 20 61 20 73 63 65 6e 61 72 69 6f 20 77 68 65 72   a scenario wher
1af90 65 20 6f 6e 65 20 70 72 6f 63 65 73 73 20 69 73  e one process is
1afa0 20 68 6f 6c 64 69 6e 67 20 61 20 72 65 61 64 20   holding a read 
1afb0 6c 6f 63 6b 20 74 68 61 74 0a 2a 2a 20 69 74 20  lock that.** it 
1afc0 69 73 20 74 72 79 69 6e 67 20 74 6f 20 70 72 6f  is trying to pro
1afd0 6d 6f 74 65 20 74 6f 20 61 20 72 65 73 65 72 76  mote to a reserv
1afe0 65 64 20 6c 6f 63 6b 20 61 6e 64 0a 2a 2a 20 61  ed lock and.** a
1aff0 20 73 65 63 6f 6e 64 20 70 72 6f 63 65 73 73 20   second process 
1b000 69 73 20 68 6f 6c 64 69 6e 67 20 61 20 72 65 73  is holding a res
1b010 65 72 76 65 64 20 6c 6f 63 6b 20 74 68 61 74 20  erved lock that 
1b020 69 74 20 69 73 20 74 72 79 69 6e 67 0a 2a 2a 20  it is trying.** 
1b030 74 6f 20 70 72 6f 6d 6f 74 65 20 74 6f 20 61 6e  to promote to an
1b040 20 65 78 63 6c 75 73 69 76 65 20 6c 6f 63 6b 2e   exclusive lock.
1b050 20 20 54 68 65 20 66 69 72 73 74 20 70 72 6f 63    The first proc
1b060 65 73 73 20 63 61 6e 6e 6f 74 20 70 72 6f 63 65  ess cannot proce
1b070 65 64 0a 2a 2a 20 62 65 63 61 75 73 65 20 69 74  ed.** because it
1b080 20 69 73 20 62 6c 6f 63 6b 65 64 20 62 79 20 74   is blocked by t
1b090 68 65 20 73 65 63 6f 6e 64 20 61 6e 64 20 74 68  he second and th
1b0a0 65 20 73 65 63 6f 6e 64 20 70 72 6f 63 65 73 73  e second process
1b0b0 20 63 61 6e 6e 6f 74 0a 2a 2a 20 70 72 6f 63 65   cannot.** proce
1b0c0 65 64 20 62 65 63 61 75 73 65 20 69 74 20 69 73  ed because it is
1b0d0 20 62 6c 6f 63 6b 65 64 20 62 79 20 74 68 65 20   blocked by the 
1b0e0 66 69 72 73 74 2e 20 20 49 66 20 62 6f 74 68 20  first.  If both 
1b0f0 70 72 6f 63 65 73 73 65 73 0a 2a 2a 20 69 6e 76  processes.** inv
1b100 6f 6b 65 20 74 68 65 20 62 75 73 79 20 68 61 6e  oke the busy han
1b110 64 6c 65 72 73 2c 20 6e 65 69 74 68 65 72 20 77  dlers, neither w
1b120 69 6c 6c 20 6d 61 6b 65 20 61 6e 79 20 70 72 6f  ill make any pro
1b130 67 72 65 73 73 2e 20 20 54 68 65 72 65 66 6f 72  gress.  Therefor
1b140 65 2c 0a 2a 2a 20 53 51 4c 69 74 65 20 72 65 74  e,.** SQLite ret
1b150 75 72 6e 73 20 5b 53 51 4c 49 54 45 5f 42 55 53  urns [SQLITE_BUS
1b160 59 5d 20 66 6f 72 20 74 68 65 20 66 69 72 73 74  Y] for the first
1b170 20 70 72 6f 63 65 73 73 2c 20 68 6f 70 69 6e 67   process, hoping
1b180 20 74 68 61 74 20 74 68 69 73 0a 2a 2a 20 77 69   that this.** wi
1b190 6c 6c 20 69 6e 64 75 63 65 20 74 68 65 20 66 69  ll induce the fi
1b1a0 72 73 74 20 70 72 6f 63 65 73 73 20 74 6f 20 72  rst process to r
1b1b0 65 6c 65 61 73 65 20 69 74 73 20 72 65 61 64 20  elease its read 
1b1c0 6c 6f 63 6b 20 61 6e 64 20 61 6c 6c 6f 77 0a 2a  lock and allow.*
1b1d0 2a 20 74 68 65 20 73 65 63 6f 6e 64 20 70 72 6f  * the second pro
1b1e0 63 65 73 73 20 74 6f 20 70 72 6f 63 65 65 64 2e  cess to proceed.
1b1f0 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 64 65 66 61  .**.** ^The defa
1b200 75 6c 74 20 62 75 73 79 20 63 61 6c 6c 62 61 63  ult busy callbac
1b210 6b 20 69 73 20 4e 55 4c 4c 2e 0a 2a 2a 0a 2a 2a  k is NULL..**.**
1b220 20 5e 28 54 68 65 72 65 20 63 61 6e 20 6f 6e 6c   ^(There can onl
1b230 79 20 62 65 20 61 20 73 69 6e 67 6c 65 20 62 75  y be a single bu
1b240 73 79 20 68 61 6e 64 6c 65 72 20 64 65 66 69 6e  sy handler defin
1b250 65 64 20 66 6f 72 20 65 61 63 68 0a 2a 2a 20 5b  ed for each.** [
1b260 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
1b270 69 6f 6e 5d 2e 20 20 53 65 74 74 69 6e 67 20 61  ion].  Setting a
1b280 20 6e 65 77 20 62 75 73 79 20 68 61 6e 64 6c 65   new busy handle
1b290 72 20 63 6c 65 61 72 73 20 61 6e 79 0a 2a 2a 20  r clears any.** 
1b2a0 70 72 65 76 69 6f 75 73 6c 79 20 73 65 74 20 68  previously set h
1b2b0 61 6e 64 6c 65 72 2e 29 5e 20 20 5e 4e 6f 74 65  andler.)^  ^Note
1b2c0 20 74 68 61 74 20 63 61 6c 6c 69 6e 67 20 5b 73   that calling [s
1b2d0 71 6c 69 74 65 33 5f 62 75 73 79 5f 74 69 6d 65  qlite3_busy_time
1b2e0 6f 75 74 28 29 5d 0a 2a 2a 20 6f 72 20 65 76 61  out()].** or eva
1b2f0 6c 75 61 74 69 6e 67 20 5b 50 52 41 47 4d 41 20  luating [PRAGMA 
1b300 62 75 73 79 5f 74 69 6d 65 6f 75 74 3d 4e 5d 20  busy_timeout=N] 
1b310 77 69 6c 6c 20 63 68 61 6e 67 65 20 74 68 65 0a  will change the.
1b320 2a 2a 20 62 75 73 79 20 68 61 6e 64 6c 65 72 20  ** busy handler 
1b330 61 6e 64 20 74 68 75 73 20 63 6c 65 61 72 20 61  and thus clear a
1b340 6e 79 20 70 72 65 76 69 6f 75 73 6c 79 20 73 65  ny previously se
1b350 74 20 62 75 73 79 20 68 61 6e 64 6c 65 72 2e 0a  t busy handler..
1b360 2a 2a 0a 2a 2a 20 54 68 65 20 62 75 73 79 20 63  **.** The busy c
1b370 61 6c 6c 62 61 63 6b 20 73 68 6f 75 6c 64 20 6e  allback should n
1b380 6f 74 20 74 61 6b 65 20 61 6e 79 20 61 63 74 69  ot take any acti
1b390 6f 6e 73 20 77 68 69 63 68 20 6d 6f 64 69 66 79  ons which modify
1b3a0 20 74 68 65 0a 2a 2a 20 64 61 74 61 62 61 73 65   the.** database
1b3b0 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 68 61 74   connection that
1b3c0 20 69 6e 76 6f 6b 65 64 20 74 68 65 20 62 75 73   invoked the bus
1b3d0 79 20 68 61 6e 64 6c 65 72 2e 20 20 49 6e 20 6f  y handler.  In o
1b3e0 74 68 65 72 20 77 6f 72 64 73 2c 0a 2a 2a 20 74  ther words,.** t
1b3f0 68 65 20 62 75 73 79 20 68 61 6e 64 6c 65 72 20  he busy handler 
1b400 69 73 20 6e 6f 74 20 72 65 65 6e 74 72 61 6e 74  is not reentrant
1b410 2e 20 20 41 6e 79 20 73 75 63 68 20 61 63 74 69  .  Any such acti
1b420 6f 6e 73 0a 2a 2a 20 72 65 73 75 6c 74 20 69 6e  ons.** result in
1b430 20 75 6e 64 65 66 69 6e 65 64 20 62 65 68 61 76   undefined behav
1b440 69 6f 72 2e 0a 2a 2a 20 0a 2a 2a 20 41 20 62 75  ior..** .** A bu
1b450 73 79 20 68 61 6e 64 6c 65 72 20 6d 75 73 74 20  sy handler must 
1b460 6e 6f 74 20 63 6c 6f 73 65 20 74 68 65 20 64 61  not close the da
1b470 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
1b480 6e 0a 2a 2a 20 6f 72 20 5b 70 72 65 70 61 72 65  n.** or [prepare
1b490 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 74 68 61  d statement] tha
1b4a0 74 20 69 6e 76 6f 6b 65 64 20 74 68 65 20 62 75  t invoked the bu
1b4b0 73 79 20 68 61 6e 64 6c 65 72 2e 0a 2a 2f 0a 69  sy handler..*/.i
1b4c0 6e 74 20 73 71 6c 69 74 65 33 5f 62 75 73 79 5f  nt sqlite3_busy_
1b4d0 68 61 6e 64 6c 65 72 28 73 71 6c 69 74 65 33 2a  handler(sqlite3*
1b4e0 2c 20 69 6e 74 28 2a 29 28 76 6f 69 64 2a 2c 69  , int(*)(void*,i
1b4f0 6e 74 29 2c 20 76 6f 69 64 2a 29 3b 0a 0a 2f 2a  nt), void*);../*
1b500 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 53 65  .** CAPI3REF: Se
1b510 74 20 41 20 42 75 73 79 20 54 69 6d 65 6f 75 74  t A Busy Timeout
1b520 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69  .** METHOD: sqli
1b530 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 54 68 69 73 20  te3.**.** ^This 
1b540 72 6f 75 74 69 6e 65 20 73 65 74 73 20 61 20 5b  routine sets a [
1b550 73 71 6c 69 74 65 33 5f 62 75 73 79 5f 68 61 6e  sqlite3_busy_han
1b560 64 6c 65 72 20 7c 20 62 75 73 79 20 68 61 6e 64  dler | busy hand
1b570 6c 65 72 5d 20 74 68 61 74 20 73 6c 65 65 70 73  ler] that sleeps
1b580 0a 2a 2a 20 66 6f 72 20 61 20 73 70 65 63 69 66  .** for a specif
1b590 69 65 64 20 61 6d 6f 75 6e 74 20 6f 66 20 74 69  ied amount of ti
1b5a0 6d 65 20 77 68 65 6e 20 61 20 74 61 62 6c 65 20  me when a table 
1b5b0 69 73 20 6c 6f 63 6b 65 64 2e 20 20 5e 54 68 65  is locked.  ^The
1b5c0 20 68 61 6e 64 6c 65 72 0a 2a 2a 20 77 69 6c 6c   handler.** will
1b5d0 20 73 6c 65 65 70 20 6d 75 6c 74 69 70 6c 65 20   sleep multiple 
1b5e0 74 69 6d 65 73 20 75 6e 74 69 6c 20 61 74 20 6c  times until at l
1b5f0 65 61 73 74 20 22 6d 73 22 20 6d 69 6c 6c 69 73  east "ms" millis
1b600 65 63 6f 6e 64 73 20 6f 66 20 73 6c 65 65 70 69  econds of sleepi
1b610 6e 67 0a 2a 2a 20 68 61 76 65 20 61 63 63 75 6d  ng.** have accum
1b620 75 6c 61 74 65 64 2e 20 20 5e 41 66 74 65 72 20  ulated.  ^After 
1b630 61 74 20 6c 65 61 73 74 20 22 6d 73 22 20 6d 69  at least "ms" mi
1b640 6c 6c 69 73 65 63 6f 6e 64 73 20 6f 66 20 73 6c  lliseconds of sl
1b650 65 65 70 69 6e 67 2c 0a 2a 2a 20 74 68 65 20 68  eeping,.** the h
1b660 61 6e 64 6c 65 72 20 72 65 74 75 72 6e 73 20 30  andler returns 0
1b670 20 77 68 69 63 68 20 63 61 75 73 65 73 20 5b 73   which causes [s
1b680 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 74  qlite3_step()] t
1b690 6f 20 72 65 74 75 72 6e 0a 2a 2a 20 5b 53 51 4c  o return.** [SQL
1b6a0 49 54 45 5f 42 55 53 59 5d 2e 0a 2a 2a 0a 2a 2a  ITE_BUSY]..**.**
1b6b0 20 5e 43 61 6c 6c 69 6e 67 20 74 68 69 73 20 72   ^Calling this r
1b6c0 6f 75 74 69 6e 65 20 77 69 74 68 20 61 6e 20 61  outine with an a
1b6d0 72 67 75 6d 65 6e 74 20 6c 65 73 73 20 74 68 61  rgument less tha
1b6e0 6e 20 6f 72 20 65 71 75 61 6c 20 74 6f 20 7a 65  n or equal to ze
1b6f0 72 6f 0a 2a 2a 20 74 75 72 6e 73 20 6f 66 66 20  ro.** turns off 
1b700 61 6c 6c 20 62 75 73 79 20 68 61 6e 64 6c 65 72  all busy handler
1b710 73 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 65 72 65  s..**.** ^(There
1b720 20 63 61 6e 20 6f 6e 6c 79 20 62 65 20 61 20 73   can only be a s
1b730 69 6e 67 6c 65 20 62 75 73 79 20 68 61 6e 64 6c  ingle busy handl
1b740 65 72 20 66 6f 72 20 61 20 70 61 72 74 69 63 75  er for a particu
1b750 6c 61 72 0a 2a 2a 20 5b 64 61 74 61 62 61 73 65  lar.** [database
1b760 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 61 74 20   connection] at 
1b770 61 6e 79 20 67 69 76 65 6e 20 6d 6f 6d 65 6e 74  any given moment
1b780 2e 20 20 49 66 20 61 6e 6f 74 68 65 72 20 62 75  .  If another bu
1b790 73 79 20 68 61 6e 64 6c 65 72 0a 2a 2a 20 77 61  sy handler.** wa
1b7a0 73 20 64 65 66 69 6e 65 64 20 20 28 75 73 69 6e  s defined  (usin
1b7b0 67 20 5b 73 71 6c 69 74 65 33 5f 62 75 73 79 5f  g [sqlite3_busy_
1b7c0 68 61 6e 64 6c 65 72 28 29 5d 29 20 70 72 69 6f  handler()]) prio
1b7d0 72 20 74 6f 20 63 61 6c 6c 69 6e 67 0a 2a 2a 20  r to calling.** 
1b7e0 74 68 69 73 20 72 6f 75 74 69 6e 65 2c 20 74 68  this routine, th
1b7f0 61 74 20 6f 74 68 65 72 20 62 75 73 79 20 68 61  at other busy ha
1b800 6e 64 6c 65 72 20 69 73 20 63 6c 65 61 72 65 64  ndler is cleared
1b810 2e 29 5e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c  .)^.**.** See al
1b820 73 6f 3a 20 20 5b 50 52 41 47 4d 41 20 62 75 73  so:  [PRAGMA bus
1b830 79 5f 74 69 6d 65 6f 75 74 5d 0a 2a 2f 0a 69 6e  y_timeout].*/.in
1b840 74 20 73 71 6c 69 74 65 33 5f 62 75 73 79 5f 74  t sqlite3_busy_t
1b850 69 6d 65 6f 75 74 28 73 71 6c 69 74 65 33 2a 2c  imeout(sqlite3*,
1b860 20 69 6e 74 20 6d 73 29 3b 0a 0a 2f 2a 0a 2a 2a   int ms);../*.**
1b870 20 43 41 50 49 33 52 45 46 3a 20 43 6f 6e 76 65   CAPI3REF: Conve
1b880 6e 69 65 6e 63 65 20 52 6f 75 74 69 6e 65 73 20  nience Routines 
1b890 46 6f 72 20 52 75 6e 6e 69 6e 67 20 51 75 65 72  For Running Quer
1b8a0 69 65 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73  ies.** METHOD: s
1b8b0 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 54 68 69  qlite3.**.** Thi
1b8c0 73 20 69 73 20 61 20 6c 65 67 61 63 79 20 69 6e  s is a legacy in
1b8d0 74 65 72 66 61 63 65 20 74 68 61 74 20 69 73 20  terface that is 
1b8e0 70 72 65 73 65 72 76 65 64 20 66 6f 72 20 62 61  preserved for ba
1b8f0 63 6b 77 61 72 64 73 20 63 6f 6d 70 61 74 69 62  ckwards compatib
1b900 69 6c 69 74 79 2e 0a 2a 2a 20 55 73 65 20 6f 66  ility..** Use of
1b910 20 74 68 69 73 20 69 6e 74 65 72 66 61 63 65 20   this interface 
1b920 69 73 20 6e 6f 74 20 72 65 63 6f 6d 6d 65 6e 64  is not recommend
1b930 65 64 2e 0a 2a 2a 0a 2a 2a 20 44 65 66 69 6e 69  ed..**.** Defini
1b940 74 69 6f 6e 3a 20 41 20 3c 62 3e 72 65 73 75 6c  tion: A <b>resul
1b950 74 20 74 61 62 6c 65 3c 2f 62 3e 20 69 73 20 6d  t table</b> is m
1b960 65 6d 6f 72 79 20 64 61 74 61 20 73 74 72 75 63  emory data struc
1b970 74 75 72 65 20 63 72 65 61 74 65 64 20 62 79 20  ture created by 
1b980 74 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  the.** [sqlite3_
1b990 67 65 74 5f 74 61 62 6c 65 28 29 5d 20 69 6e 74  get_table()] int
1b9a0 65 72 66 61 63 65 2e 20 20 41 20 72 65 73 75 6c  erface.  A resul
1b9b0 74 20 74 61 62 6c 65 20 72 65 63 6f 72 64 73 20  t table records 
1b9c0 74 68 65 0a 2a 2a 20 63 6f 6d 70 6c 65 74 65 20  the.** complete 
1b9d0 71 75 65 72 79 20 72 65 73 75 6c 74 73 20 66 72  query results fr
1b9e0 6f 6d 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 20 71  om one or more q
1b9f0 75 65 72 69 65 73 2e 0a 2a 2a 0a 2a 2a 20 54 68  ueries..**.** Th
1ba00 65 20 74 61 62 6c 65 20 63 6f 6e 63 65 70 74 75  e table conceptu
1ba10 61 6c 6c 79 20 68 61 73 20 61 20 6e 75 6d 62 65  ally has a numbe
1ba20 72 20 6f 66 20 72 6f 77 73 20 61 6e 64 20 63 6f  r of rows and co
1ba30 6c 75 6d 6e 73 2e 20 20 42 75 74 0a 2a 2a 20 74  lumns.  But.** t
1ba40 68 65 73 65 20 6e 75 6d 62 65 72 73 20 61 72 65  hese numbers are
1ba50 20 6e 6f 74 20 70 61 72 74 20 6f 66 20 74 68 65   not part of the
1ba60 20 72 65 73 75 6c 74 20 74 61 62 6c 65 20 69 74   result table it
1ba70 73 65 6c 66 2e 20 20 54 68 65 73 65 0a 2a 2a 20  self.  These.** 
1ba80 6e 75 6d 62 65 72 73 20 61 72 65 20 6f 62 74 61  numbers are obta
1ba90 69 6e 65 64 20 73 65 70 61 72 61 74 65 6c 79 2e  ined separately.
1baa0 20 20 4c 65 74 20 4e 20 62 65 20 74 68 65 20 6e    Let N be the n
1bab0 75 6d 62 65 72 20 6f 66 20 72 6f 77 73 0a 2a 2a  umber of rows.**
1bac0 20 61 6e 64 20 4d 20 62 65 20 74 68 65 20 6e 75   and M be the nu
1bad0 6d 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 2e  mber of columns.
1bae0 0a 2a 2a 0a 2a 2a 20 41 20 72 65 73 75 6c 74 20  .**.** A result 
1baf0 74 61 62 6c 65 20 69 73 20 61 6e 20 61 72 72 61  table is an arra
1bb00 79 20 6f 66 20 70 6f 69 6e 74 65 72 73 20 74 6f  y of pointers to
1bb10 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64   zero-terminated
1bb20 20 55 54 46 2d 38 20 73 74 72 69 6e 67 73 2e 0a   UTF-8 strings..
1bb30 2a 2a 20 54 68 65 72 65 20 61 72 65 20 28 4e 2b  ** There are (N+
1bb40 31 29 2a 4d 20 65 6c 65 6d 65 6e 74 73 20 69 6e  1)*M elements in
1bb50 20 74 68 65 20 61 72 72 61 79 2e 20 20 54 68 65   the array.  The
1bb60 20 66 69 72 73 74 20 4d 20 70 6f 69 6e 74 65 72   first M pointer
1bb70 73 20 70 6f 69 6e 74 0a 2a 2a 20 74 6f 20 7a 65  s point.** to ze
1bb80 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 20 73 74  ro-terminated st
1bb90 72 69 6e 67 73 20 74 68 61 74 20 20 63 6f 6e 74  rings that  cont
1bba0 61 69 6e 20 74 68 65 20 6e 61 6d 65 73 20 6f 66  ain the names of
1bbb0 20 74 68 65 20 63 6f 6c 75 6d 6e 73 2e 0a 2a 2a   the columns..**
1bbc0 20 54 68 65 20 72 65 6d 61 69 6e 69 6e 67 20 65   The remaining e
1bbd0 6e 74 72 69 65 73 20 61 6c 6c 20 70 6f 69 6e 74  ntries all point
1bbe0 20 74 6f 20 71 75 65 72 79 20 72 65 73 75 6c 74   to query result
1bbf0 73 2e 20 20 4e 55 4c 4c 20 76 61 6c 75 65 73 20  s.  NULL values 
1bc00 72 65 73 75 6c 74 0a 2a 2a 20 69 6e 20 4e 55 4c  result.** in NUL
1bc10 4c 20 70 6f 69 6e 74 65 72 73 2e 20 20 41 6c 6c  L pointers.  All
1bc20 20 6f 74 68 65 72 20 76 61 6c 75 65 73 20 61 72   other values ar
1bc30 65 20 69 6e 20 74 68 65 69 72 20 55 54 46 2d 38  e in their UTF-8
1bc40 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64   zero-terminated
1bc50 0a 2a 2a 20 73 74 72 69 6e 67 20 72 65 70 72 65  .** string repre
1bc60 73 65 6e 74 61 74 69 6f 6e 20 61 73 20 72 65 74  sentation as ret
1bc70 75 72 6e 65 64 20 62 79 20 5b 73 71 6c 69 74 65  urned by [sqlite
1bc80 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 29 5d  3_column_text()]
1bc90 2e 0a 2a 2a 0a 2a 2a 20 41 20 72 65 73 75 6c 74  ..**.** A result
1bca0 20 74 61 62 6c 65 20 6d 69 67 68 74 20 63 6f 6e   table might con
1bcb0 73 69 73 74 20 6f 66 20 6f 6e 65 20 6f 72 20 6d  sist of one or m
1bcc0 6f 72 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  ore memory alloc
1bcd0 61 74 69 6f 6e 73 2e 0a 2a 2a 20 49 74 20 69 73  ations..** It is
1bce0 20 6e 6f 74 20 73 61 66 65 20 74 6f 20 70 61 73   not safe to pas
1bcf0 73 20 61 20 72 65 73 75 6c 74 20 74 61 62 6c 65  s a result table
1bd00 20 64 69 72 65 63 74 6c 79 20 74 6f 20 5b 73 71   directly to [sq
1bd10 6c 69 74 65 33 5f 66 72 65 65 28 29 5d 2e 0a 2a  lite3_free()]..*
1bd20 2a 20 41 20 72 65 73 75 6c 74 20 74 61 62 6c 65  * A result table
1bd30 20 73 68 6f 75 6c 64 20 62 65 20 64 65 61 6c 6c   should be deall
1bd40 6f 63 61 74 65 64 20 75 73 69 6e 67 20 5b 73 71  ocated using [sq
1bd50 6c 69 74 65 33 5f 66 72 65 65 5f 74 61 62 6c 65  lite3_free_table
1bd60 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 28 41 73 20  ()]..**.** ^(As 
1bd70 61 6e 20 65 78 61 6d 70 6c 65 20 6f 66 20 74 68  an example of th
1bd80 65 20 72 65 73 75 6c 74 20 74 61 62 6c 65 20 66  e result table f
1bd90 6f 72 6d 61 74 2c 20 73 75 70 70 6f 73 65 20 61  ormat, suppose a
1bda0 20 71 75 65 72 79 20 72 65 73 75 6c 74 0a 2a 2a   query result.**
1bdb0 20 69 73 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a   is as follows:.
1bdc0 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74  **.** <blockquot
1bdd0 65 3e 3c 70 72 65 3e 0a 2a 2a 20 20 20 20 20 20  e><pre>.**      
1bde0 20 20 4e 61 6d 65 20 20 20 20 20 20 20 20 7c 20    Name        | 
1bdf0 41 67 65 0a 2a 2a 20 20 20 20 20 20 20 20 2d 2d  Age.**        --
1be00 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
1be10 2d 2d 2d 2d 2d 0a 2a 2a 20 20 20 20 20 20 20 20  -----.**        
1be20 41 6c 69 63 65 20 20 20 20 20 20 20 7c 20 34 33  Alice       | 43
1be30 0a 2a 2a 20 20 20 20 20 20 20 20 42 6f 62 20 20  .**        Bob  
1be40 20 20 20 20 20 20 20 7c 20 32 38 0a 2a 2a 20 20         | 28.**  
1be50 20 20 20 20 20 20 43 69 6e 64 79 20 20 20 20 20        Cindy     
1be60 20 20 7c 20 32 31 0a 2a 2a 20 3c 2f 70 72 65 3e    | 21.** </pre>
1be70 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 2a 2a  </blockquote>.**
1be80 0a 2a 2a 20 54 68 65 72 65 20 61 72 65 20 74 77  .** There are tw
1be90 6f 20 63 6f 6c 75 6d 6e 20 28 4d 3d 3d 32 29 20  o column (M==2) 
1bea0 61 6e 64 20 74 68 72 65 65 20 72 6f 77 73 20 28  and three rows (
1beb0 4e 3d 3d 33 29 2e 20 20 54 68 75 73 20 74 68 65  N==3).  Thus the
1bec0 0a 2a 2a 20 72 65 73 75 6c 74 20 74 61 62 6c 65  .** result table
1bed0 20 68 61 73 20 38 20 65 6e 74 72 69 65 73 2e 20   has 8 entries. 
1bee0 20 53 75 70 70 6f 73 65 20 74 68 65 20 72 65 73   Suppose the res
1bef0 75 6c 74 20 74 61 62 6c 65 20 69 73 20 73 74 6f  ult table is sto
1bf00 72 65 64 0a 2a 2a 20 69 6e 20 61 6e 20 61 72 72  red.** in an arr
1bf10 61 79 20 6e 61 6d 65 73 20 61 7a 52 65 73 75 6c  ay names azResul
1bf20 74 2e 20 20 54 68 65 6e 20 61 7a 52 65 73 75 6c  t.  Then azResul
1bf30 74 20 68 6f 6c 64 73 20 74 68 69 73 20 63 6f 6e  t holds this con
1bf40 74 65 6e 74 3a 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f  tent:.**.** <blo
1bf50 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 2a 2a  ckquote><pre>.**
1bf60 20 20 20 20 20 20 20 20 61 7a 52 65 73 75 6c 74          azResult
1bf70 26 23 39 31 3b 30 5d 20 3d 20 22 4e 61 6d 65 22  &#91;0] = "Name"
1bf80 3b 0a 2a 2a 20 20 20 20 20 20 20 20 61 7a 52 65  ;.**        azRe
1bf90 73 75 6c 74 26 23 39 31 3b 31 5d 20 3d 20 22 41  sult&#91;1] = "A
1bfa0 67 65 22 3b 0a 2a 2a 20 20 20 20 20 20 20 20 61  ge";.**        a
1bfb0 7a 52 65 73 75 6c 74 26 23 39 31 3b 32 5d 20 3d  zResult&#91;2] =
1bfc0 20 22 41 6c 69 63 65 22 3b 0a 2a 2a 20 20 20 20   "Alice";.**    
1bfd0 20 20 20 20 61 7a 52 65 73 75 6c 74 26 23 39 31      azResult&#91
1bfe0 3b 33 5d 20 3d 20 22 34 33 22 3b 0a 2a 2a 20 20  ;3] = "43";.**  
1bff0 20 20 20 20 20 20 61 7a 52 65 73 75 6c 74 26 23        azResult&#
1c000 39 31 3b 34 5d 20 3d 20 22 42 6f 62 22 3b 0a 2a  91;4] = "Bob";.*
1c010 2a 20 20 20 20 20 20 20 20 61 7a 52 65 73 75 6c  *        azResul
1c020 74 26 23 39 31 3b 35 5d 20 3d 20 22 32 38 22 3b  t&#91;5] = "28";
1c030 0a 2a 2a 20 20 20 20 20 20 20 20 61 7a 52 65 73  .**        azRes
1c040 75 6c 74 26 23 39 31 3b 36 5d 20 3d 20 22 43 69  ult&#91;6] = "Ci
1c050 6e 64 79 22 3b 0a 2a 2a 20 20 20 20 20 20 20 20  ndy";.**        
1c060 61 7a 52 65 73 75 6c 74 26 23 39 31 3b 37 5d 20  azResult&#91;7] 
1c070 3d 20 22 32 31 22 3b 0a 2a 2a 20 3c 2f 70 72 65  = "21";.** </pre
1c080 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 29 5e  ></blockquote>)^
1c090 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69  .**.** ^The sqli
1c0a0 74 65 33 5f 67 65 74 5f 74 61 62 6c 65 28 29 20  te3_get_table() 
1c0b0 66 75 6e 63 74 69 6f 6e 20 65 76 61 6c 75 61 74  function evaluat
1c0c0 65 73 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 0a 2a  es one or more.*
1c0d0 2a 20 73 65 6d 69 63 6f 6c 6f 6e 2d 73 65 70 61  * semicolon-sepa
1c0e0 72 61 74 65 64 20 53 51 4c 20 73 74 61 74 65 6d  rated SQL statem
1c0f0 65 6e 74 73 20 69 6e 20 74 68 65 20 7a 65 72 6f  ents in the zero
1c100 2d 74 65 72 6d 69 6e 61 74 65 64 20 55 54 46 2d  -terminated UTF-
1c110 38 0a 2a 2a 20 73 74 72 69 6e 67 20 6f 66 20 69  8.** string of i
1c120 74 73 20 32 6e 64 20 70 61 72 61 6d 65 74 65 72  ts 2nd parameter
1c130 20 61 6e 64 20 72 65 74 75 72 6e 73 20 61 20 72   and returns a r
1c140 65 73 75 6c 74 20 74 61 62 6c 65 20 74 6f 20 74  esult table to t
1c150 68 65 0a 2a 2a 20 70 6f 69 6e 74 65 72 20 67 69  he.** pointer gi
1c160 76 65 6e 20 69 6e 20 69 74 73 20 33 72 64 20 70  ven in its 3rd p
1c170 61 72 61 6d 65 74 65 72 2e 0a 2a 2a 0a 2a 2a 20  arameter..**.** 
1c180 41 66 74 65 72 20 74 68 65 20 61 70 70 6c 69 63  After the applic
1c190 61 74 69 6f 6e 20 68 61 73 20 66 69 6e 69 73 68  ation has finish
1c1a0 65 64 20 77 69 74 68 20 74 68 65 20 72 65 73 75  ed with the resu
1c1b0 6c 74 20 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f  lt from sqlite3_
1c1c0 67 65 74 5f 74 61 62 6c 65 28 29 2c 0a 2a 2a 20  get_table(),.** 
1c1d0 69 74 20 6d 75 73 74 20 70 61 73 73 20 74 68 65  it must pass the
1c1e0 20 72 65 73 75 6c 74 20 74 61 62 6c 65 20 70 6f   result table po
1c1f0 69 6e 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33  inter to sqlite3
1c200 5f 66 72 65 65 5f 74 61 62 6c 65 28 29 20 69 6e  _free_table() in
1c210 20 6f 72 64 65 72 20 74 6f 0a 2a 2a 20 72 65 6c   order to.** rel
1c220 65 61 73 65 20 74 68 65 20 6d 65 6d 6f 72 79 20  ease the memory 
1c230 74 68 61 74 20 77 61 73 20 6d 61 6c 6c 6f 63 65  that was malloce
1c240 64 2e 20 20 42 65 63 61 75 73 65 20 6f 66 20 74  d.  Because of t
1c250 68 65 20 77 61 79 20 74 68 65 0a 2a 2a 20 5b 73  he way the.** [s
1c260 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d  qlite3_malloc()]
1c270 20 68 61 70 70 65 6e 73 20 77 69 74 68 69 6e 20   happens within 
1c280 73 71 6c 69 74 65 33 5f 67 65 74 5f 74 61 62 6c  sqlite3_get_tabl
1c290 65 28 29 2c 20 74 68 65 20 63 61 6c 6c 69 6e 67  e(), the calling
1c2a0 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 6d 75 73  .** function mus
1c2b0 74 20 6e 6f 74 20 74 72 79 20 74 6f 20 63 61 6c  t not try to cal
1c2c0 6c 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 28  l [sqlite3_free(
1c2d0 29 5d 20 64 69 72 65 63 74 6c 79 2e 20 20 4f 6e  )] directly.  On
1c2e0 6c 79 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 66  ly.** [sqlite3_f
1c2f0 72 65 65 5f 74 61 62 6c 65 28 29 5d 20 69 73 20  ree_table()] is 
1c300 61 62 6c 65 20 74 6f 20 72 65 6c 65 61 73 65 20  able to release 
1c310 74 68 65 20 6d 65 6d 6f 72 79 20 70 72 6f 70 65  the memory prope
1c320 72 6c 79 20 61 6e 64 20 73 61 66 65 6c 79 2e 0a  rly and safely..
1c330 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65  **.** The sqlite
1c340 33 5f 67 65 74 5f 74 61 62 6c 65 28 29 20 69 6e  3_get_table() in
1c350 74 65 72 66 61 63 65 20 69 73 20 69 6d 70 6c 65  terface is imple
1c360 6d 65 6e 74 65 64 20 61 73 20 61 20 77 72 61 70  mented as a wrap
1c370 70 65 72 20 61 72 6f 75 6e 64 0a 2a 2a 20 5b 73  per around.** [s
1c380 71 6c 69 74 65 33 5f 65 78 65 63 28 29 5d 2e 20  qlite3_exec()]. 
1c390 20 54 68 65 20 73 71 6c 69 74 65 33 5f 67 65 74   The sqlite3_get
1c3a0 5f 74 61 62 6c 65 28 29 20 72 6f 75 74 69 6e 65  _table() routine
1c3b0 20 64 6f 65 73 20 6e 6f 74 20 68 61 76 65 20 61   does not have a
1c3c0 63 63 65 73 73 0a 2a 2a 20 74 6f 20 61 6e 79 20  ccess.** to any 
1c3d0 69 6e 74 65 72 6e 61 6c 20 64 61 74 61 20 73 74  internal data st
1c3e0 72 75 63 74 75 72 65 73 20 6f 66 20 53 51 4c 69  ructures of SQLi
1c3f0 74 65 2e 20 20 49 74 20 75 73 65 73 20 6f 6e 6c  te.  It uses onl
1c400 79 20 74 68 65 20 70 75 62 6c 69 63 0a 2a 2a 20  y the public.** 
1c410 69 6e 74 65 72 66 61 63 65 20 64 65 66 69 6e 65  interface define
1c420 64 20 68 65 72 65 2e 20 20 41 73 20 61 20 63 6f  d here.  As a co
1c430 6e 73 65 71 75 65 6e 63 65 2c 20 65 72 72 6f 72  nsequence, error
1c440 73 20 74 68 61 74 20 6f 63 63 75 72 20 69 6e 20  s that occur in 
1c450 74 68 65 0a 2a 2a 20 77 72 61 70 70 65 72 20 6c  the.** wrapper l
1c460 61 79 65 72 20 6f 75 74 73 69 64 65 20 6f 66 20  ayer outside of 
1c470 74 68 65 20 69 6e 74 65 72 6e 61 6c 20 5b 73 71  the internal [sq
1c480 6c 69 74 65 33 5f 65 78 65 63 28 29 5d 20 63 61  lite3_exec()] ca
1c490 6c 6c 20 61 72 65 20 6e 6f 74 0a 2a 2a 20 72 65  ll are not.** re
1c4a0 66 6c 65 63 74 65 64 20 69 6e 20 73 75 62 73 65  flected in subse
1c4b0 71 75 65 6e 74 20 63 61 6c 6c 73 20 74 6f 20 5b  quent calls to [
1c4c0 73 71 6c 69 74 65 33 5f 65 72 72 63 6f 64 65 28  sqlite3_errcode(
1c4d0 29 5d 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69 74 65  )] or.** [sqlite
1c4e0 33 5f 65 72 72 6d 73 67 28 29 5d 2e 0a 2a 2f 0a  3_errmsg()]..*/.
1c4f0 69 6e 74 20 73 71 6c 69 74 65 33 5f 67 65 74 5f  int sqlite3_get_
1c500 74 61 62 6c 65 28 0a 20 20 73 71 6c 69 74 65 33  table(.  sqlite3
1c510 20 2a 64 62 2c 20 20 20 20 20 20 20 20 20 20 2f   *db,          /
1c520 2a 20 41 6e 20 6f 70 65 6e 20 64 61 74 61 62 61  * An open databa
1c530 73 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 63 68  se */.  const ch
1c540 61 72 20 2a 7a 53 71 6c 2c 20 20 20 20 20 2f 2a  ar *zSql,     /*
1c550 20 53 51 4c 20 74 6f 20 62 65 20 65 76 61 6c 75   SQL to be evalu
1c560 61 74 65 64 20 2a 2f 0a 20 20 63 68 61 72 20 2a  ated */.  char *
1c570 2a 2a 70 61 7a 52 65 73 75 6c 74 2c 20 20 20 20  **pazResult,    
1c580 2f 2a 20 52 65 73 75 6c 74 73 20 6f 66 20 74 68  /* Results of th
1c590 65 20 71 75 65 72 79 20 2a 2f 0a 20 20 69 6e 74  e query */.  int
1c5a0 20 2a 70 6e 52 6f 77 2c 20 20 20 20 20 20 20 20   *pnRow,        
1c5b0 20 20 20 2f 2a 20 4e 75 6d 62 65 72 20 6f 66 20     /* Number of 
1c5c0 72 65 73 75 6c 74 20 72 6f 77 73 20 77 72 69 74  result rows writ
1c5d0 74 65 6e 20 68 65 72 65 20 2a 2f 0a 20 20 69 6e  ten here */.  in
1c5e0 74 20 2a 70 6e 43 6f 6c 75 6d 6e 2c 20 20 20 20  t *pnColumn,    
1c5f0 20 20 20 20 2f 2a 20 4e 75 6d 62 65 72 20 6f 66      /* Number of
1c600 20 72 65 73 75 6c 74 20 63 6f 6c 75 6d 6e 73 20   result columns 
1c610 77 72 69 74 74 65 6e 20 68 65 72 65 20 2a 2f 0a  written here */.
1c620 20 20 63 68 61 72 20 2a 2a 70 7a 45 72 72 6d 73    char **pzErrms
1c630 67 20 20 20 20 20 20 20 2f 2a 20 45 72 72 6f 72  g       /* Error
1c640 20 6d 73 67 20 77 72 69 74 74 65 6e 20 68 65 72   msg written her
1c650 65 20 2a 2f 0a 29 3b 0a 76 6f 69 64 20 73 71 6c  e */.);.void sql
1c660 69 74 65 33 5f 66 72 65 65 5f 74 61 62 6c 65 28  ite3_free_table(
1c670 63 68 61 72 20 2a 2a 72 65 73 75 6c 74 29 3b 0a  char **result);.
1c680 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
1c690 20 46 6f 72 6d 61 74 74 65 64 20 53 74 72 69 6e   Formatted Strin
1c6a0 67 20 50 72 69 6e 74 69 6e 67 20 46 75 6e 63 74  g Printing Funct
1c6b0 69 6f 6e 73 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65  ions.**.** These
1c6c0 20 72 6f 75 74 69 6e 65 73 20 61 72 65 20 77 6f   routines are wo
1c6d0 72 6b 2d 61 6c 69 6b 65 73 20 6f 66 20 74 68 65  rk-alikes of the
1c6e0 20 22 70 72 69 6e 74 66 28 29 22 20 66 61 6d 69   "printf()" fami
1c6f0 6c 79 20 6f 66 20 66 75 6e 63 74 69 6f 6e 73 0a  ly of functions.
1c700 2a 2a 20 66 72 6f 6d 20 74 68 65 20 73 74 61 6e  ** from the stan
1c710 64 61 72 64 20 43 20 6c 69 62 72 61 72 79 2e 0a  dard C library..
1c720 2a 2a 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65  ** These routine
1c730 73 20 75 6e 64 65 72 73 74 61 6e 64 20 6d 6f 73  s understand mos
1c740 74 20 6f 66 20 74 68 65 20 63 6f 6d 6d 6f 6e 20  t of the common 
1c750 4b 26 52 20 66 6f 72 6d 61 74 74 69 6e 67 20 6f  K&R formatting o
1c760 70 74 69 6f 6e 73 2c 0a 2a 2a 20 70 6c 75 73 20  ptions,.** plus 
1c770 73 6f 6d 65 20 61 64 64 69 74 69 6f 6e 61 6c 20  some additional 
1c780 6e 6f 6e 2d 73 74 61 6e 64 61 72 64 20 66 6f 72  non-standard for
1c790 6d 61 74 73 2c 20 64 65 74 61 69 6c 65 64 20 62  mats, detailed b
1c7a0 65 6c 6f 77 2e 0a 2a 2a 20 4e 6f 74 65 20 74 68  elow..** Note th
1c7b0 61 74 20 73 6f 6d 65 20 6f 66 20 74 68 65 20 6d  at some of the m
1c7c0 6f 72 65 20 6f 62 73 63 75 72 65 20 66 6f 72 6d  ore obscure form
1c7d0 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e 73 20 66  atting options f
1c7e0 72 6f 6d 20 72 65 63 65 6e 74 0a 2a 2a 20 43 2d  rom recent.** C-
1c7f0 6c 69 62 72 61 72 79 20 73 74 61 6e 64 61 72 64  library standard
1c800 73 20 61 72 65 20 6f 6d 69 74 74 65 64 20 66 72  s are omitted fr
1c810 6f 6d 20 74 68 69 73 20 69 6d 70 6c 65 6d 65 6e  om this implemen
1c820 74 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 54  tation..**.** ^T
1c830 68 65 20 73 71 6c 69 74 65 33 5f 6d 70 72 69 6e  he sqlite3_mprin
1c840 74 66 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33  tf() and sqlite3
1c850 5f 76 6d 70 72 69 6e 74 66 28 29 20 72 6f 75 74  _vmprintf() rout
1c860 69 6e 65 73 20 77 72 69 74 65 20 74 68 65 69 72  ines write their
1c870 0a 2a 2a 20 72 65 73 75 6c 74 73 20 69 6e 74 6f  .** results into
1c880 20 6d 65 6d 6f 72 79 20 6f 62 74 61 69 6e 65 64   memory obtained
1c890 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 6d   from [sqlite3_m
1c8a0 61 6c 6c 6f 63 28 29 5d 2e 0a 2a 2a 20 54 68 65  alloc()]..** The
1c8b0 20 73 74 72 69 6e 67 73 20 72 65 74 75 72 6e 65   strings returne
1c8c0 64 20 62 79 20 74 68 65 73 65 20 74 77 6f 20 72  d by these two r
1c8d0 6f 75 74 69 6e 65 73 20 73 68 6f 75 6c 64 20 62  outines should b
1c8e0 65 0a 2a 2a 20 72 65 6c 65 61 73 65 64 20 62 79  e.** released by
1c8f0 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29   [sqlite3_free()
1c900 5d 2e 20 20 5e 42 6f 74 68 20 72 6f 75 74 69 6e  ].  ^Both routin
1c910 65 73 20 72 65 74 75 72 6e 20 61 0a 2a 2a 20 4e  es return a.** N
1c920 55 4c 4c 20 70 6f 69 6e 74 65 72 20 69 66 20 5b  ULL pointer if [
1c930 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29  sqlite3_malloc()
1c940 5d 20 69 73 20 75 6e 61 62 6c 65 20 74 6f 20 61  ] is unable to a
1c950 6c 6c 6f 63 61 74 65 20 65 6e 6f 75 67 68 0a 2a  llocate enough.*
1c960 2a 20 6d 65 6d 6f 72 79 20 74 6f 20 68 6f 6c 64  * memory to hold
1c970 20 74 68 65 20 72 65 73 75 6c 74 69 6e 67 20 73   the resulting s
1c980 74 72 69 6e 67 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54  tring..**.** ^(T
1c990 68 65 20 73 71 6c 69 74 65 33 5f 73 6e 70 72 69  he sqlite3_snpri
1c9a0 6e 74 66 28 29 20 72 6f 75 74 69 6e 65 20 69 73  ntf() routine is
1c9b0 20 73 69 6d 69 6c 61 72 20 74 6f 20 22 73 6e 70   similar to "snp
1c9c0 72 69 6e 74 66 28 29 22 20 66 72 6f 6d 0a 2a 2a  rintf()" from.**
1c9d0 20 74 68 65 20 73 74 61 6e 64 61 72 64 20 43 20   the standard C 
1c9e0 6c 69 62 72 61 72 79 2e 20 20 54 68 65 20 72 65  library.  The re
1c9f0 73 75 6c 74 20 69 73 20 77 72 69 74 74 65 6e 20  sult is written 
1ca00 69 6e 74 6f 20 74 68 65 0a 2a 2a 20 62 75 66 66  into the.** buff
1ca10 65 72 20 73 75 70 70 6c 69 65 64 20 61 73 20 74  er supplied as t
1ca20 68 65 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65  he second parame
1ca30 74 65 72 20 77 68 6f 73 65 20 73 69 7a 65 20 69  ter whose size i
1ca40 73 20 67 69 76 65 6e 20 62 79 0a 2a 2a 20 74 68  s given by.** th
1ca50 65 20 66 69 72 73 74 20 70 61 72 61 6d 65 74 65  e first paramete
1ca60 72 2e 20 4e 6f 74 65 20 74 68 61 74 20 74 68 65  r. Note that the
1ca70 20 6f 72 64 65 72 20 6f 66 20 74 68 65 0a 2a 2a   order of the.**
1ca80 20 66 69 72 73 74 20 74 77 6f 20 70 61 72 61 6d   first two param
1ca90 65 74 65 72 73 20 69 73 20 72 65 76 65 72 73 65  eters is reverse
1caa0 64 20 66 72 6f 6d 20 73 6e 70 72 69 6e 74 66 28  d from snprintf(
1cab0 29 2e 29 5e 20 20 54 68 69 73 20 69 73 20 61 6e  ).)^  This is an
1cac0 0a 2a 2a 20 68 69 73 74 6f 72 69 63 61 6c 20 61  .** historical a
1cad0 63 63 69 64 65 6e 74 20 74 68 61 74 20 63 61 6e  ccident that can
1cae0 6e 6f 74 20 62 65 20 66 69 78 65 64 20 77 69 74  not be fixed wit
1caf0 68 6f 75 74 20 62 72 65 61 6b 69 6e 67 0a 2a 2a  hout breaking.**
1cb00 20 62 61 63 6b 77 61 72 64 73 20 63 6f 6d 70 61   backwards compa
1cb10 74 69 62 69 6c 69 74 79 2e 20 20 5e 28 4e 6f 74  tibility.  ^(Not
1cb20 65 20 61 6c 73 6f 20 74 68 61 74 20 73 71 6c 69  e also that sqli
1cb30 74 65 33 5f 73 6e 70 72 69 6e 74 66 28 29 0a 2a  te3_snprintf().*
1cb40 2a 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69 6e  * returns a poin
1cb50 74 65 72 20 74 6f 20 69 74 73 20 62 75 66 66 65  ter to its buffe
1cb60 72 20 69 6e 73 74 65 61 64 20 6f 66 20 74 68 65  r instead of the
1cb70 20 6e 75 6d 62 65 72 20 6f 66 0a 2a 2a 20 63 68   number of.** ch
1cb80 61 72 61 63 74 65 72 73 20 61 63 74 75 61 6c 6c  aracters actuall
1cb90 79 20 77 72 69 74 74 65 6e 20 69 6e 74 6f 20 74  y written into t
1cba0 68 65 20 62 75 66 66 65 72 2e 29 5e 20 20 57 65  he buffer.)^  We
1cbb0 20 61 64 6d 69 74 20 74 68 61 74 0a 2a 2a 20 74   admit that.** t
1cbc0 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 63 68 61  he number of cha
1cbd0 72 61 63 74 65 72 73 20 77 72 69 74 74 65 6e 20  racters written 
1cbe0 77 6f 75 6c 64 20 62 65 20 61 20 6d 6f 72 65 20  would be a more 
1cbf0 75 73 65 66 75 6c 20 72 65 74 75 72 6e 0a 2a 2a  useful return.**
1cc00 20 76 61 6c 75 65 20 62 75 74 20 77 65 20 63 61   value but we ca
1cc10 6e 6e 6f 74 20 63 68 61 6e 67 65 20 74 68 65 20  nnot change the 
1cc20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 6f  implementation o
1cc30 66 20 73 71 6c 69 74 65 33 5f 73 6e 70 72 69 6e  f sqlite3_snprin
1cc40 74 66 28 29 0a 2a 2a 20 6e 6f 77 20 77 69 74 68  tf().** now with
1cc50 6f 75 74 20 62 72 65 61 6b 69 6e 67 20 63 6f 6d  out breaking com
1cc60 70 61 74 69 62 69 6c 69 74 79 2e 0a 2a 2a 0a 2a  patibility..**.*
1cc70 2a 20 5e 41 73 20 6c 6f 6e 67 20 61 73 20 74 68  * ^As long as th
1cc80 65 20 62 75 66 66 65 72 20 73 69 7a 65 20 69 73  e buffer size is
1cc90 20 67 72 65 61 74 65 72 20 74 68 61 6e 20 7a 65   greater than ze
1cca0 72 6f 2c 20 73 71 6c 69 74 65 33 5f 73 6e 70 72  ro, sqlite3_snpr
1ccb0 69 6e 74 66 28 29 0a 2a 2a 20 67 75 61 72 61 6e  intf().** guaran
1ccc0 74 65 65 73 20 74 68 61 74 20 74 68 65 20 62 75  tees that the bu
1ccd0 66 66 65 72 20 69 73 20 61 6c 77 61 79 73 20 7a  ffer is always z
1cce0 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 2e 20  ero-terminated. 
1ccf0 20 5e 54 68 65 20 66 69 72 73 74 0a 2a 2a 20 70   ^The first.** p
1cd00 61 72 61 6d 65 74 65 72 20 22 6e 22 20 69 73 20  arameter "n" is 
1cd10 74 68 65 20 74 6f 74 61 6c 20 73 69 7a 65 20 6f  the total size o
1cd20 66 20 74 68 65 20 62 75 66 66 65 72 2c 20 69 6e  f the buffer, in
1cd30 63 6c 75 64 69 6e 67 20 73 70 61 63 65 20 66 6f  cluding space fo
1cd40 72 0a 2a 2a 20 74 68 65 20 7a 65 72 6f 20 74 65  r.** the zero te
1cd50 72 6d 69 6e 61 74 6f 72 2e 20 20 53 6f 20 74 68  rminator.  So th
1cd60 65 20 6c 6f 6e 67 65 73 74 20 73 74 72 69 6e 67  e longest string
1cd70 20 74 68 61 74 20 63 61 6e 20 62 65 20 63 6f 6d   that can be com
1cd80 70 6c 65 74 65 6c 79 0a 2a 2a 20 77 72 69 74 74  pletely.** writt
1cd90 65 6e 20 77 69 6c 6c 20 62 65 20 6e 2d 31 20 63  en will be n-1 c
1cda0 68 61 72 61 63 74 65 72 73 2e 0a 2a 2a 0a 2a 2a  haracters..**.**
1cdb0 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 76 73   ^The sqlite3_vs
1cdc0 6e 70 72 69 6e 74 66 28 29 20 72 6f 75 74 69 6e  nprintf() routin
1cdd0 65 20 69 73 20 61 20 76 61 72 61 72 67 73 20 76  e is a varargs v
1cde0 65 72 73 69 6f 6e 20 6f 66 20 73 71 6c 69 74 65  ersion of sqlite
1cdf0 33 5f 73 6e 70 72 69 6e 74 66 28 29 2e 0a 2a 2a  3_snprintf()..**
1ce00 0a 2a 2a 20 54 68 65 73 65 20 72 6f 75 74 69 6e  .** These routin
1ce10 65 73 20 61 6c 6c 20 69 6d 70 6c 65 6d 65 6e 74  es all implement
1ce20 20 73 6f 6d 65 20 61 64 64 69 74 69 6f 6e 61 6c   some additional
1ce30 20 66 6f 72 6d 61 74 74 69 6e 67 0a 2a 2a 20 6f   formatting.** o
1ce40 70 74 69 6f 6e 73 20 74 68 61 74 20 61 72 65 20  ptions that are 
1ce50 75 73 65 66 75 6c 20 66 6f 72 20 63 6f 6e 73 74  useful for const
1ce60 72 75 63 74 69 6e 67 20 53 51 4c 20 73 74 61 74  ructing SQL stat
1ce70 65 6d 65 6e 74 73 2e 0a 2a 2a 20 41 6c 6c 20 6f  ements..** All o
1ce80 66 20 74 68 65 20 75 73 75 61 6c 20 70 72 69 6e  f the usual prin
1ce90 74 66 28 29 20 66 6f 72 6d 61 74 74 69 6e 67 20  tf() formatting 
1cea0 6f 70 74 69 6f 6e 73 20 61 70 70 6c 79 2e 20 20  options apply.  
1ceb0 49 6e 20 61 64 64 69 74 69 6f 6e 2c 20 74 68 65  In addition, the
1cec0 72 65 0a 2a 2a 20 69 73 20 61 72 65 20 22 25 71  re.** is are "%q
1ced0 22 2c 20 22 25 51 22 2c 20 22 25 77 22 20 61 6e  ", "%Q", "%w" an
1cee0 64 20 22 25 7a 22 20 6f 70 74 69 6f 6e 73 2e 0a  d "%z" options..
1cef0 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20 25 71 20 6f  **.** ^(The %q o
1cf00 70 74 69 6f 6e 20 77 6f 72 6b 73 20 6c 69 6b 65  ption works like
1cf10 20 25 73 20 69 6e 20 74 68 61 74 20 69 74 20 73   %s in that it s
1cf20 75 62 73 74 69 74 75 74 65 73 20 61 20 6e 75 6c  ubstitutes a nul
1cf30 2d 74 65 72 6d 69 6e 61 74 65 64 0a 2a 2a 20 73  -terminated.** s
1cf40 74 72 69 6e 67 20 66 72 6f 6d 20 74 68 65 20 61  tring from the a
1cf50 72 67 75 6d 65 6e 74 20 6c 69 73 74 2e 20 20 42  rgument list.  B
1cf60 75 74 20 25 71 20 61 6c 73 6f 20 64 6f 75 62 6c  ut %q also doubl
1cf70 65 73 20 65 76 65 72 79 20 27 5c 27 27 20 63 68  es every '\'' ch
1cf80 61 72 61 63 74 65 72 2e 0a 2a 2a 20 25 71 20 69  aracter..** %q i
1cf90 73 20 64 65 73 69 67 6e 65 64 20 66 6f 72 20 75  s designed for u
1cfa0 73 65 20 69 6e 73 69 64 65 20 61 20 73 74 72 69  se inside a stri
1cfb0 6e 67 20 6c 69 74 65 72 61 6c 2e 29 5e 20 20 42  ng literal.)^  B
1cfc0 79 20 64 6f 75 62 6c 69 6e 67 20 65 61 63 68 20  y doubling each 
1cfd0 27 5c 27 27 0a 2a 2a 20 63 68 61 72 61 63 74 65  '\''.** characte
1cfe0 72 20 69 74 20 65 73 63 61 70 65 73 20 74 68 61  r it escapes tha
1cff0 74 20 63 68 61 72 61 63 74 65 72 20 61 6e 64 20  t character and 
1d000 61 6c 6c 6f 77 73 20 69 74 20 74 6f 20 62 65 20  allows it to be 
1d010 69 6e 73 65 72 74 65 64 20 69 6e 74 6f 0a 2a 2a  inserted into.**
1d020 20 74 68 65 20 73 74 72 69 6e 67 2e 0a 2a 2a 0a   the string..**.
1d030 2a 2a 20 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20  ** For example, 
1d040 61 73 73 75 6d 65 20 74 68 65 20 73 74 72 69 6e  assume the strin
1d050 67 20 76 61 72 69 61 62 6c 65 20 7a 54 65 78 74  g variable zText
1d060 20 63 6f 6e 74 61 69 6e 73 20 74 65 78 74 20 61   contains text a
1d070 73 20 66 6f 6c 6c 6f 77 73 3a 0a 2a 2a 0a 2a 2a  s follows:.**.**
1d080 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72   <blockquote><pr
1d090 65 3e 0a 2a 2a 20 20 63 68 61 72 20 2a 7a 54 65  e>.**  char *zTe
1d0a0 78 74 20 3d 20 22 49 74 27 73 20 61 20 68 61 70  xt = "It's a hap
1d0b0 70 79 20 64 61 79 21 22 3b 0a 2a 2a 20 3c 2f 70  py day!";.** </p
1d0c0 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e  re></blockquote>
1d0d0 0a 2a 2a 0a 2a 2a 20 4f 6e 65 20 63 61 6e 20 75  .**.** One can u
1d0e0 73 65 20 74 68 69 73 20 74 65 78 74 20 69 6e 20  se this text in 
1d0f0 61 6e 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  an SQL statement
1d100 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a 2a 2a 0a   as follows:.**.
1d110 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c  ** <blockquote><
1d120 70 72 65 3e 0a 2a 2a 20 20 63 68 61 72 20 2a 7a  pre>.**  char *z
1d130 53 51 4c 20 3d 20 73 71 6c 69 74 65 33 5f 6d 70  SQL = sqlite3_mp
1d140 72 69 6e 74 66 28 22 49 4e 53 45 52 54 20 49 4e  rintf("INSERT IN
1d150 54 4f 20 74 61 62 6c 65 20 56 41 4c 55 45 53 28  TO table VALUES(
1d160 27 25 71 27 29 22 2c 20 7a 54 65 78 74 29 3b 0a  '%q')", zText);.
1d170 2a 2a 20 20 73 71 6c 69 74 65 33 5f 65 78 65 63  **  sqlite3_exec
1d180 28 64 62 2c 20 7a 53 51 4c 2c 20 30 2c 20 30 2c  (db, zSQL, 0, 0,
1d190 20 30 29 3b 0a 2a 2a 20 20 73 71 6c 69 74 65 33   0);.**  sqlite3
1d1a0 5f 66 72 65 65 28 7a 53 51 4c 29 3b 0a 2a 2a 20  _free(zSQL);.** 
1d1b0 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f  </pre></blockquo
1d1c0 74 65 3e 0a 2a 2a 0a 2a 2a 20 42 65 63 61 75 73  te>.**.** Becaus
1d1d0 65 20 74 68 65 20 25 71 20 66 6f 72 6d 61 74 20  e the %q format 
1d1e0 73 74 72 69 6e 67 20 69 73 20 75 73 65 64 2c 20  string is used, 
1d1f0 74 68 65 20 27 5c 27 27 20 63 68 61 72 61 63 74  the '\'' charact
1d200 65 72 20 69 6e 20 7a 54 65 78 74 0a 2a 2a 20 69  er in zText.** i
1d210 73 20 65 73 63 61 70 65 64 20 61 6e 64 20 74 68  s escaped and th
1d220 65 20 53 51 4c 20 67 65 6e 65 72 61 74 65 64 20  e SQL generated 
1d230 69 73 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a 2a  is as follows:.*
1d240 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74 65  *.** <blockquote
1d250 3e 3c 70 72 65 3e 0a 2a 2a 20 20 49 4e 53 45 52  ><pre>.**  INSER
1d260 54 20 49 4e 54 4f 20 74 61 62 6c 65 31 20 56 41  T INTO table1 VA
1d270 4c 55 45 53 28 27 49 74 27 27 73 20 61 20 68 61  LUES('It''s a ha
1d280 70 70 79 20 64 61 79 21 27 29 0a 2a 2a 20 3c 2f  ppy day!').** </
1d290 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65  pre></blockquote
1d2a0 3e 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 69 73 20  >.**.** This is 
1d2b0 63 6f 72 72 65 63 74 2e 20 20 48 61 64 20 77 65  correct.  Had we
1d2c0 20 75 73 65 64 20 25 73 20 69 6e 73 74 65 61 64   used %s instead
1d2d0 20 6f 66 20 25 71 2c 20 74 68 65 20 67 65 6e 65   of %q, the gene
1d2e0 72 61 74 65 64 20 53 51 4c 0a 2a 2a 20 77 6f 75  rated SQL.** wou
1d2f0 6c 64 20 68 61 76 65 20 6c 6f 6f 6b 65 64 20 6c  ld have looked l
1d300 69 6b 65 20 74 68 69 73 3a 0a 2a 2a 0a 2a 2a 20  ike this:.**.** 
1d310 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65  <blockquote><pre
1d320 3e 0a 2a 2a 20 20 49 4e 53 45 52 54 20 49 4e 54  >.**  INSERT INT
1d330 4f 20 74 61 62 6c 65 31 20 56 41 4c 55 45 53 28  O table1 VALUES(
1d340 27 49 74 27 73 20 61 20 68 61 70 70 79 20 64 61  'It's a happy da
1d350 79 21 27 29 3b 0a 2a 2a 20 3c 2f 70 72 65 3e 3c  y!');.** </pre><
1d360 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 2a 2a 0a  /blockquote>.**.
1d370 2a 2a 20 54 68 69 73 20 73 65 63 6f 6e 64 20 65  ** This second e
1d380 78 61 6d 70 6c 65 20 69 73 20 61 6e 20 53 51 4c  xample is an SQL
1d390 20 73 79 6e 74 61 78 20 65 72 72 6f 72 2e 20 20   syntax error.  
1d3a0 41 73 20 61 20 67 65 6e 65 72 61 6c 20 72 75 6c  As a general rul
1d3b0 65 20 79 6f 75 20 73 68 6f 75 6c 64 0a 2a 2a 20  e you should.** 
1d3c0 61 6c 77 61 79 73 20 75 73 65 20 25 71 20 69 6e  always use %q in
1d3d0 73 74 65 61 64 20 6f 66 20 25 73 20 77 68 65 6e  stead of %s when
1d3e0 20 69 6e 73 65 72 74 69 6e 67 20 74 65 78 74 20   inserting text 
1d3f0 69 6e 74 6f 20 61 20 73 74 72 69 6e 67 20 6c 69  into a string li
1d400 74 65 72 61 6c 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54  teral..**.** ^(T
1d410 68 65 20 25 51 20 6f 70 74 69 6f 6e 20 77 6f 72  he %Q option wor
1d420 6b 73 20 6c 69 6b 65 20 25 71 20 65 78 63 65 70  ks like %q excep
1d430 74 20 69 74 20 61 6c 73 6f 20 61 64 64 73 20 73  t it also adds s
1d440 69 6e 67 6c 65 20 71 75 6f 74 65 73 20 61 72 6f  ingle quotes aro
1d450 75 6e 64 0a 2a 2a 20 74 68 65 20 6f 75 74 73 69  und.** the outsi
1d460 64 65 20 6f 66 20 74 68 65 20 74 6f 74 61 6c 20  de of the total 
1d470 73 74 72 69 6e 67 2e 20 20 41 64 64 69 74 69 6f  string.  Additio
1d480 6e 61 6c 6c 79 2c 20 69 66 20 74 68 65 20 70 61  nally, if the pa
1d490 72 61 6d 65 74 65 72 20 69 6e 20 74 68 65 0a 2a  rameter in the.*
1d4a0 2a 20 61 72 67 75 6d 65 6e 74 20 6c 69 73 74 20  * argument list 
1d4b0 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  is a NULL pointe
1d4c0 72 2c 20 25 51 20 73 75 62 73 74 69 74 75 74 65  r, %Q substitute
1d4d0 73 20 74 68 65 20 74 65 78 74 20 22 4e 55 4c 4c  s the text "NULL
1d4e0 22 20 28 77 69 74 68 6f 75 74 0a 2a 2a 20 73 69  " (without.** si
1d4f0 6e 67 6c 65 20 71 75 6f 74 65 73 29 2e 29 5e 20  ngle quotes).)^ 
1d500 20 53 6f 2c 20 66 6f 72 20 65 78 61 6d 70 6c 65   So, for example
1d510 2c 20 6f 6e 65 20 63 6f 75 6c 64 20 73 61 79 3a  , one could say:
1d520 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f  .**.** <blockquo
1d530 74 65 3e 3c 70 72 65 3e 0a 2a 2a 20 20 63 68 61  te><pre>.**  cha
1d540 72 20 2a 7a 53 51 4c 20 3d 20 73 71 6c 69 74 65  r *zSQL = sqlite
1d550 33 5f 6d 70 72 69 6e 74 66 28 22 49 4e 53 45 52  3_mprintf("INSER
1d560 54 20 49 4e 54 4f 20 74 61 62 6c 65 20 56 41 4c  T INTO table VAL
1d570 55 45 53 28 25 51 29 22 2c 20 7a 54 65 78 74 29  UES(%Q)", zText)
1d580 3b 0a 2a 2a 20 20 73 71 6c 69 74 65 33 5f 65 78  ;.**  sqlite3_ex
1d590 65 63 28 64 62 2c 20 7a 53 51 4c 2c 20 30 2c 20  ec(db, zSQL, 0, 
1d5a0 30 2c 20 30 29 3b 0a 2a 2a 20 20 73 71 6c 69 74  0, 0);.**  sqlit
1d5b0 65 33 5f 66 72 65 65 28 7a 53 51 4c 29 3b 0a 2a  e3_free(zSQL);.*
1d5c0 2a 20 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71  * </pre></blockq
1d5d0 75 6f 74 65 3e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  uote>.**.** The 
1d5e0 63 6f 64 65 20 61 62 6f 76 65 20 77 69 6c 6c 20  code above will 
1d5f0 72 65 6e 64 65 72 20 61 20 63 6f 72 72 65 63 74  render a correct
1d600 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 69   SQL statement i
1d610 6e 20 74 68 65 20 7a 53 51 4c 0a 2a 2a 20 76 61  n the zSQL.** va
1d620 72 69 61 62 6c 65 20 65 76 65 6e 20 69 66 20 74  riable even if t
1d630 68 65 20 7a 54 65 78 74 20 76 61 72 69 61 62 6c  he zText variabl
1d640 65 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e  e is a NULL poin
1d650 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 65  ter..**.** ^(The
1d660 20 22 25 77 22 20 66 6f 72 6d 61 74 74 69 6e 67   "%w" formatting
1d670 20 6f 70 74 69 6f 6e 20 69 73 20 6c 69 6b 65 20   option is like 
1d680 22 25 71 22 20 65 78 63 65 70 74 20 74 68 61 74  "%q" except that
1d690 20 69 74 20 65 78 70 65 63 74 73 20 74 6f 0a 2a   it expects to.*
1d6a0 2a 20 62 65 20 63 6f 6e 74 61 69 6e 65 64 20 77  * be contained w
1d6b0 69 74 68 69 6e 20 64 6f 75 62 6c 65 2d 71 75 6f  ithin double-quo
1d6c0 74 65 73 20 69 6e 73 74 65 61 64 20 6f 66 20 73  tes instead of s
1d6d0 69 6e 67 6c 65 20 71 75 6f 74 65 73 2c 20 61 6e  ingle quotes, an
1d6e0 64 20 69 74 0a 2a 2a 20 65 73 63 61 70 65 73 20  d it.** escapes 
1d6f0 74 68 65 20 64 6f 75 62 6c 65 2d 71 75 6f 74 65  the double-quote
1d700 20 63 68 61 72 61 63 74 65 72 20 69 6e 73 74 65   character inste
1d710 61 64 20 6f 66 20 74 68 65 20 73 69 6e 67 6c 65  ad of the single
1d720 2d 71 75 6f 74 65 0a 2a 2a 20 63 68 61 72 61 63  -quote.** charac
1d730 74 65 72 2e 29 5e 20 20 54 68 65 20 22 25 77 22  ter.)^  The "%w"
1d740 20 66 6f 72 6d 61 74 74 69 6e 67 20 6f 70 74 69   formatting opti
1d750 6f 6e 20 69 73 20 69 6e 74 65 6e 64 65 64 20 66  on is intended f
1d760 6f 72 20 73 61 66 65 6c 79 20 69 6e 73 65 72 74  or safely insert
1d770 69 6e 67 0a 2a 2a 20 74 61 62 6c 65 20 61 6e 64  ing.** table and
1d780 20 63 6f 6c 75 6d 6e 20 6e 61 6d 65 73 20 69 6e   column names in
1d790 74 6f 20 61 20 63 6f 6e 73 74 72 75 63 74 65 64  to a constructed
1d7a0 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2e 0a   SQL statement..
1d7b0 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20 22 25 7a 22  **.** ^(The "%z"
1d7c0 20 66 6f 72 6d 61 74 74 69 6e 67 20 6f 70 74 69   formatting opti
1d7d0 6f 6e 20 77 6f 72 6b 73 20 6c 69 6b 65 20 22 25  on works like "%
1d7e0 73 22 20 62 75 74 20 77 69 74 68 20 74 68 65 0a  s" but with the.
1d7f0 2a 2a 20 61 64 64 69 74 69 6f 6e 20 74 68 61 74  ** addition that
1d800 20 61 66 74 65 72 20 74 68 65 20 73 74 72 69 6e   after the strin
1d810 67 20 68 61 73 20 62 65 65 6e 20 72 65 61 64 20  g has been read 
1d820 61 6e 64 20 63 6f 70 69 65 64 20 69 6e 74 6f 0a  and copied into.
1d830 2a 2a 20 74 68 65 20 72 65 73 75 6c 74 2c 20 5b  ** the result, [
1d840 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29 5d 20  sqlite3_free()] 
1d850 69 73 20 63 61 6c 6c 65 64 20 6f 6e 20 74 68 65  is called on the
1d860 20 69 6e 70 75 74 20 73 74 72 69 6e 67 2e 29 5e   input string.)^
1d870 0a 2a 2f 0a 63 68 61 72 20 2a 73 71 6c 69 74 65  .*/.char *sqlite
1d880 33 5f 6d 70 72 69 6e 74 66 28 63 6f 6e 73 74 20  3_mprintf(const 
1d890 63 68 61 72 2a 2c 2e 2e 2e 29 3b 0a 63 68 61 72  char*,...);.char
1d8a0 20 2a 73 71 6c 69 74 65 33 5f 76 6d 70 72 69 6e   *sqlite3_vmprin
1d8b0 74 66 28 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20  tf(const char*, 
1d8c0 76 61 5f 6c 69 73 74 29 3b 0a 63 68 61 72 20 2a  va_list);.char *
1d8d0 73 71 6c 69 74 65 33 5f 73 6e 70 72 69 6e 74 66  sqlite3_snprintf
1d8e0 28 69 6e 74 2c 63 68 61 72 2a 2c 63 6f 6e 73 74  (int,char*,const
1d8f0 20 63 68 61 72 2a 2c 20 2e 2e 2e 29 3b 0a 63 68   char*, ...);.ch
1d900 61 72 20 2a 73 71 6c 69 74 65 33 5f 76 73 6e 70  ar *sqlite3_vsnp
1d910 72 69 6e 74 66 28 69 6e 74 2c 63 68 61 72 2a 2c  rintf(int,char*,
1d920 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20 76 61 5f  const char*, va_
1d930 6c 69 73 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41  list);../*.** CA
1d940 50 49 33 52 45 46 3a 20 4d 65 6d 6f 72 79 20 41  PI3REF: Memory A
1d950 6c 6c 6f 63 61 74 69 6f 6e 20 53 75 62 73 79 73  llocation Subsys
1d960 74 65 6d 0a 2a 2a 0a 2a 2a 20 54 68 65 20 53 51  tem.**.** The SQ
1d970 4c 69 74 65 20 63 6f 72 65 20 75 73 65 73 20 74  Lite core uses t
1d980 68 65 73 65 20 74 68 72 65 65 20 72 6f 75 74 69  hese three routi
1d990 6e 65 73 20 66 6f 72 20 61 6c 6c 20 6f 66 20 69  nes for all of i
1d9a0 74 73 20 6f 77 6e 0a 2a 2a 20 69 6e 74 65 72 6e  ts own.** intern
1d9b0 61 6c 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  al memory alloca
1d9c0 74 69 6f 6e 20 6e 65 65 64 73 2e 20 22 43 6f 72  tion needs. "Cor
1d9d0 65 22 20 69 6e 20 74 68 65 20 70 72 65 76 69 6f  e" in the previo
1d9e0 75 73 20 73 65 6e 74 65 6e 63 65 0a 2a 2a 20 64  us sentence.** d
1d9f0 6f 65 73 20 6e 6f 74 20 69 6e 63 6c 75 64 65 20  oes not include 
1da00 6f 70 65 72 61 74 69 6e 67 2d 73 79 73 74 65 6d  operating-system
1da10 20 73 70 65 63 69 66 69 63 20 56 46 53 20 69 6d   specific VFS im
1da20 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 2e 20 20 54  plementation.  T
1da30 68 65 0a 2a 2a 20 57 69 6e 64 6f 77 73 20 56 46  he.** Windows VF
1da40 53 20 75 73 65 73 20 6e 61 74 69 76 65 20 6d 61  S uses native ma
1da50 6c 6c 6f 63 28 29 20 61 6e 64 20 66 72 65 65 28  lloc() and free(
1da60 29 20 66 6f 72 20 73 6f 6d 65 20 6f 70 65 72 61  ) for some opera
1da70 74 69 6f 6e 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  tions..**.** ^Th
1da80 65 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63  e sqlite3_malloc
1da90 28 29 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72  () routine retur
1daa0 6e 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20  ns a pointer to 
1dab0 61 20 62 6c 6f 63 6b 0a 2a 2a 20 6f 66 20 6d 65  a block.** of me
1dac0 6d 6f 72 79 20 61 74 20 6c 65 61 73 74 20 4e 20  mory at least N 
1dad0 62 79 74 65 73 20 69 6e 20 6c 65 6e 67 74 68 2c  bytes in length,
1dae0 20 77 68 65 72 65 20 4e 20 69 73 20 74 68 65 20   where N is the 
1daf0 70 61 72 61 6d 65 74 65 72 2e 0a 2a 2a 20 5e 49  parameter..** ^I
1db00 66 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63  f sqlite3_malloc
1db10 28 29 20 69 73 20 75 6e 61 62 6c 65 20 74 6f 20  () is unable to 
1db20 6f 62 74 61 69 6e 20 73 75 66 66 69 63 69 65 6e  obtain sufficien
1db30 74 20 66 72 65 65 0a 2a 2a 20 6d 65 6d 6f 72 79  t free.** memory
1db40 2c 20 69 74 20 72 65 74 75 72 6e 73 20 61 20 4e  , it returns a N
1db50 55 4c 4c 20 70 6f 69 6e 74 65 72 2e 20 20 5e 49  ULL pointer.  ^I
1db60 66 20 74 68 65 20 70 61 72 61 6d 65 74 65 72 20  f the parameter 
1db70 4e 20 74 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  N to.** sqlite3_
1db80 6d 61 6c 6c 6f 63 28 29 20 69 73 20 7a 65 72 6f  malloc() is zero
1db90 20 6f 72 20 6e 65 67 61 74 69 76 65 20 74 68 65   or negative the
1dba0 6e 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63  n sqlite3_malloc
1dbb0 28 29 20 72 65 74 75 72 6e 73 0a 2a 2a 20 61 20  () returns.** a 
1dbc0 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2e 0a 2a 2a  NULL pointer..**
1dbd0 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33  .** ^The sqlite3
1dbe0 5f 6d 61 6c 6c 6f 63 36 34 28 4e 29 20 72 6f 75  _malloc64(N) rou
1dbf0 74 69 6e 65 20 77 6f 72 6b 73 20 6a 75 73 74 20  tine works just 
1dc00 6c 69 6b 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  like.** sqlite3_
1dc10 6d 61 6c 6c 6f 63 28 4e 29 20 65 78 63 65 70 74  malloc(N) except
1dc20 20 74 68 61 74 20 4e 20 69 73 20 61 6e 20 75 6e   that N is an un
1dc30 73 69 67 6e 65 64 20 36 34 2d 62 69 74 20 69 6e  signed 64-bit in
1dc40 74 65 67 65 72 20 69 6e 73 74 65 61 64 0a 2a 2a  teger instead.**
1dc50 20 6f 66 20 61 20 73 69 67 6e 65 64 20 33 32 2d   of a signed 32-
1dc60 62 69 74 20 69 6e 74 65 67 65 72 2e 0a 2a 2a 0a  bit integer..**.
1dc70 2a 2a 20 5e 43 61 6c 6c 69 6e 67 20 73 71 6c 69  ** ^Calling sqli
1dc80 74 65 33 5f 66 72 65 65 28 29 20 77 69 74 68 20  te3_free() with 
1dc90 61 20 70 6f 69 6e 74 65 72 20 70 72 65 76 69 6f  a pointer previo
1dca0 75 73 6c 79 20 72 65 74 75 72 6e 65 64 0a 2a 2a  usly returned.**
1dcb0 20 62 79 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c   by sqlite3_mall
1dcc0 6f 63 28 29 20 6f 72 20 73 71 6c 69 74 65 33 5f  oc() or sqlite3_
1dcd0 72 65 61 6c 6c 6f 63 28 29 20 72 65 6c 65 61 73  realloc() releas
1dce0 65 73 20 74 68 61 74 20 6d 65 6d 6f 72 79 20 73  es that memory s
1dcf0 6f 0a 2a 2a 20 74 68 61 74 20 69 74 20 6d 69 67  o.** that it mig
1dd00 68 74 20 62 65 20 72 65 75 73 65 64 2e 20 20 5e  ht be reused.  ^
1dd10 54 68 65 20 73 71 6c 69 74 65 33 5f 66 72 65 65  The sqlite3_free
1dd20 28 29 20 72 6f 75 74 69 6e 65 20 69 73 0a 2a 2a  () routine is.**
1dd30 20 61 20 6e 6f 2d 6f 70 20 69 66 20 69 73 20 63   a no-op if is c
1dd40 61 6c 6c 65 64 20 77 69 74 68 20 61 20 4e 55 4c  alled with a NUL
1dd50 4c 20 70 6f 69 6e 74 65 72 2e 20 20 50 61 73 73  L pointer.  Pass
1dd60 69 6e 67 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74  ing a NULL point
1dd70 65 72 0a 2a 2a 20 74 6f 20 73 71 6c 69 74 65 33  er.** to sqlite3
1dd80 5f 66 72 65 65 28 29 20 69 73 20 68 61 72 6d 6c  _free() is harml
1dd90 65 73 73 2e 20 20 41 66 74 65 72 20 62 65 69 6e  ess.  After bein
1dda0 67 20 66 72 65 65 64 2c 20 6d 65 6d 6f 72 79 0a  g freed, memory.
1ddb0 2a 2a 20 73 68 6f 75 6c 64 20 6e 65 69 74 68 65  ** should neithe
1ddc0 72 20 62 65 20 72 65 61 64 20 6e 6f 72 20 77 72  r be read nor wr
1ddd0 69 74 74 65 6e 2e 20 20 45 76 65 6e 20 72 65 61  itten.  Even rea
1dde0 64 69 6e 67 20 70 72 65 76 69 6f 75 73 6c 79 20  ding previously 
1ddf0 66 72 65 65 64 0a 2a 2a 20 6d 65 6d 6f 72 79 20  freed.** memory 
1de00 6d 69 67 68 74 20 72 65 73 75 6c 74 20 69 6e 20  might result in 
1de10 61 20 73 65 67 6d 65 6e 74 61 74 69 6f 6e 20 66  a segmentation f
1de20 61 75 6c 74 20 6f 72 20 6f 74 68 65 72 20 73 65  ault or other se
1de30 76 65 72 65 20 65 72 72 6f 72 2e 0a 2a 2a 20 4d  vere error..** M
1de40 65 6d 6f 72 79 20 63 6f 72 72 75 70 74 69 6f 6e  emory corruption
1de50 2c 20 61 20 73 65 67 6d 65 6e 74 61 74 69 6f 6e  , a segmentation
1de60 20 66 61 75 6c 74 2c 20 6f 72 20 6f 74 68 65 72   fault, or other
1de70 20 73 65 76 65 72 65 20 65 72 72 6f 72 0a 2a 2a   severe error.**
1de80 20 6d 69 67 68 74 20 72 65 73 75 6c 74 20 69 66   might result if
1de90 20 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29 20   sqlite3_free() 
1dea0 69 73 20 63 61 6c 6c 65 64 20 77 69 74 68 20 61  is called with a
1deb0 20 6e 6f 6e 2d 4e 55 4c 4c 20 70 6f 69 6e 74 65   non-NULL pointe
1dec0 72 20 74 68 61 74 0a 2a 2a 20 77 61 73 20 6e 6f  r that.** was no
1ded0 74 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20  t obtained from 
1dee0 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29  sqlite3_malloc()
1def0 20 6f 72 20 73 71 6c 69 74 65 33 5f 72 65 61 6c   or sqlite3_real
1df00 6c 6f 63 28 29 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  loc()..**.** ^Th
1df10 65 20 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f  e sqlite3_reallo
1df20 63 28 58 2c 4e 29 20 69 6e 74 65 72 66 61 63 65  c(X,N) interface
1df30 20 61 74 74 65 6d 70 74 73 20 74 6f 20 72 65 73   attempts to res
1df40 69 7a 65 20 61 0a 2a 2a 20 70 72 69 6f 72 20 6d  ize a.** prior m
1df50 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e  emory allocation
1df60 20 58 20 74 6f 20 62 65 20 61 74 20 6c 65 61 73   X to be at leas
1df70 74 20 4e 20 62 79 74 65 73 2e 0a 2a 2a 20 5e 49  t N bytes..** ^I
1df80 66 20 74 68 65 20 58 20 70 61 72 61 6d 65 74 65  f the X paramete
1df90 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 72 65 61  r to sqlite3_rea
1dfa0 6c 6c 6f 63 28 58 2c 4e 29 0a 2a 2a 20 69 73 20  lloc(X,N).** is 
1dfb0 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 74  a NULL pointer t
1dfc0 68 65 6e 20 69 74 73 20 62 65 68 61 76 69 6f 72  hen its behavior
1dfd0 20 69 73 20 69 64 65 6e 74 69 63 61 6c 20 74 6f   is identical to
1dfe0 20 63 61 6c 6c 69 6e 67 0a 2a 2a 20 73 71 6c 69   calling.** sqli
1dff0 74 65 33 5f 6d 61 6c 6c 6f 63 28 4e 29 2e 0a 2a  te3_malloc(N)..*
1e000 2a 20 5e 49 66 20 74 68 65 20 4e 20 70 61 72 61  * ^If the N para
1e010 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33  meter to sqlite3
1e020 5f 72 65 61 6c 6c 6f 63 28 58 2c 4e 29 20 69 73  _realloc(X,N) is
1e030 20 7a 65 72 6f 20 6f 72 0a 2a 2a 20 6e 65 67 61   zero or.** nega
1e040 74 69 76 65 20 74 68 65 6e 20 74 68 65 20 62 65  tive then the be
1e050 68 61 76 69 6f 72 20 69 73 20 65 78 61 63 74 6c  havior is exactl
1e060 79 20 74 68 65 20 73 61 6d 65 20 61 73 20 63 61  y the same as ca
1e070 6c 6c 69 6e 67 0a 2a 2a 20 73 71 6c 69 74 65 33  lling.** sqlite3
1e080 5f 66 72 65 65 28 58 29 2e 0a 2a 2a 20 5e 73 71  _free(X)..** ^sq
1e090 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63 28 58 2c  lite3_realloc(X,
1e0a0 4e 29 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69  N) returns a poi
1e0b0 6e 74 65 72 20 74 6f 20 61 20 6d 65 6d 6f 72 79  nter to a memory
1e0c0 20 61 6c 6c 6f 63 61 74 69 6f 6e 0a 2a 2a 20 6f   allocation.** o
1e0d0 66 20 61 74 20 6c 65 61 73 74 20 4e 20 62 79 74  f at least N byt
1e0e0 65 73 20 69 6e 20 73 69 7a 65 20 6f 72 20 4e 55  es in size or NU
1e0f0 4c 4c 20 69 66 20 69 6e 73 75 66 66 69 63 69 65  LL if insufficie
1e100 6e 74 20 6d 65 6d 6f 72 79 20 69 73 20 61 76 61  nt memory is ava
1e110 69 6c 61 62 6c 65 2e 0a 2a 2a 20 5e 49 66 20 4d  ilable..** ^If M
1e120 20 69 73 20 74 68 65 20 73 69 7a 65 20 6f 66 20   is the size of 
1e130 74 68 65 20 70 72 69 6f 72 20 61 6c 6c 6f 63 61  the prior alloca
1e140 74 69 6f 6e 2c 20 74 68 65 6e 20 6d 69 6e 28 4e  tion, then min(N
1e150 2c 4d 29 20 62 79 74 65 73 0a 2a 2a 20 6f 66 20  ,M) bytes.** of 
1e160 74 68 65 20 70 72 69 6f 72 20 61 6c 6c 6f 63 61  the prior alloca
1e170 74 69 6f 6e 20 61 72 65 20 63 6f 70 69 65 64 20  tion are copied 
1e180 69 6e 74 6f 20 74 68 65 20 62 65 67 69 6e 6e 69  into the beginni
1e190 6e 67 20 6f 66 20 62 75 66 66 65 72 20 72 65 74  ng of buffer ret
1e1a0 75 72 6e 65 64 0a 2a 2a 20 62 79 20 73 71 6c 69  urned.** by sqli
1e1b0 74 65 33 5f 72 65 61 6c 6c 6f 63 28 58 2c 4e 29  te3_realloc(X,N)
1e1c0 20 61 6e 64 20 74 68 65 20 70 72 69 6f 72 20 61   and the prior a
1e1d0 6c 6c 6f 63 61 74 69 6f 6e 20 69 73 20 66 72 65  llocation is fre
1e1e0 65 64 2e 0a 2a 2a 20 5e 49 66 20 73 71 6c 69 74  ed..** ^If sqlit
1e1f0 65 33 5f 72 65 61 6c 6c 6f 63 28 58 2c 4e 29 20  e3_realloc(X,N) 
1e200 72 65 74 75 72 6e 73 20 4e 55 4c 4c 20 61 6e 64  returns NULL and
1e210 20 4e 20 69 73 20 70 6f 73 69 74 69 76 65 2c 20   N is positive, 
1e220 74 68 65 6e 20 74 68 65 0a 2a 2a 20 70 72 69 6f  then the.** prio
1e230 72 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 69 73 20  r allocation is 
1e240 6e 6f 74 20 66 72 65 65 64 2e 0a 2a 2a 0a 2a 2a  not freed..**.**
1e250 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 72 65   ^The sqlite3_re
1e260 61 6c 6c 6f 63 36 34 28 58 2c 4e 29 20 69 6e 74  alloc64(X,N) int
1e270 65 72 66 61 63 65 73 20 77 6f 72 6b 73 20 74 68  erfaces works th
1e280 65 20 73 61 6d 65 20 61 73 0a 2a 2a 20 73 71 6c  e same as.** sql
1e290 69 74 65 33 5f 72 65 61 6c 6c 6f 63 28 58 2c 4e  ite3_realloc(X,N
1e2a0 29 20 65 78 63 65 70 74 20 74 68 61 74 20 4e 20  ) except that N 
1e2b0 69 73 20 61 20 36 34 2d 62 69 74 20 75 6e 73 69  is a 64-bit unsi
1e2c0 67 6e 65 64 20 69 6e 74 65 67 65 72 20 69 6e 73  gned integer ins
1e2d0 74 65 61 64 0a 2a 2a 20 6f 66 20 61 20 33 32 2d  tead.** of a 32-
1e2e0 62 69 74 20 73 69 67 6e 65 64 20 69 6e 74 65 67  bit signed integ
1e2f0 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 58 20  er..**.** ^If X 
1e300 69 73 20 61 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f  is a memory allo
1e310 63 61 74 69 6f 6e 20 70 72 65 76 69 6f 75 73 6c  cation previousl
1e320 79 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20  y obtained from 
1e330 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29  sqlite3_malloc()
1e340 2c 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 6d 61 6c  ,.** sqlite3_mal
1e350 6c 6f 63 36 34 28 29 2c 20 73 71 6c 69 74 65 33  loc64(), sqlite3
1e360 5f 72 65 61 6c 6c 6f 63 28 29 2c 20 6f 72 20 73  _realloc(), or s
1e370 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63 36 34  qlite3_realloc64
1e380 28 29 2c 20 74 68 65 6e 0a 2a 2a 20 73 71 6c 69  (), then.** sqli
1e390 74 65 33 5f 6d 73 69 7a 65 28 58 29 20 72 65 74  te3_msize(X) ret
1e3a0 75 72 6e 73 20 74 68 65 20 73 69 7a 65 20 6f 66  urns the size of
1e3b0 20 74 68 61 74 20 6d 65 6d 6f 72 79 20 61 6c 6c   that memory all
1e3c0 6f 63 61 74 69 6f 6e 20 69 6e 20 62 79 74 65 73  ocation in bytes
1e3d0 2e 0a 2a 2a 20 5e 54 68 65 20 76 61 6c 75 65 20  ..** ^The value 
1e3e0 72 65 74 75 72 6e 65 64 20 62 79 20 73 71 6c 69  returned by sqli
1e3f0 74 65 33 5f 6d 73 69 7a 65 28 58 29 20 6d 69 67  te3_msize(X) mig
1e400 68 74 20 62 65 20 6c 61 72 67 65 72 20 74 68 61  ht be larger tha
1e410 6e 20 74 68 65 20 6e 75 6d 62 65 72 0a 2a 2a 20  n the number.** 
1e420 6f 66 20 62 79 74 65 73 20 72 65 71 75 65 73 74  of bytes request
1e430 65 64 20 77 68 65 6e 20 58 20 77 61 73 20 61 6c  ed when X was al
1e440 6c 6f 63 61 74 65 64 2e 20 20 5e 49 66 20 58 20  located.  ^If X 
1e450 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  is a NULL pointe
1e460 72 20 74 68 65 6e 0a 2a 2a 20 73 71 6c 69 74 65  r then.** sqlite
1e470 33 5f 6d 73 69 7a 65 28 58 29 20 72 65 74 75 72  3_msize(X) retur
1e480 6e 73 20 7a 65 72 6f 2e 20 20 49 66 20 58 20 70  ns zero.  If X p
1e490 6f 69 6e 74 73 20 74 6f 20 73 6f 6d 65 74 68 69  oints to somethi
1e4a0 6e 67 20 74 68 61 74 20 69 73 20 6e 6f 74 0a 2a  ng that is not.*
1e4b0 2a 20 74 68 65 20 62 65 67 69 6e 6e 69 6e 67 20  * the beginning 
1e4c0 6f 66 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  of memory alloca
1e4d0 74 69 6f 6e 2c 20 6f 72 20 69 66 20 69 74 20 70  tion, or if it p
1e4e0 6f 69 6e 74 73 20 74 6f 20 61 20 66 6f 72 6d 65  oints to a forme
1e4f0 72 6c 79 0a 2a 2a 20 76 61 6c 69 64 20 6d 65 6d  rly.** valid mem
1e500 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 74  ory allocation t
1e510 68 61 74 20 68 61 73 20 6e 6f 77 20 62 65 65 6e  hat has now been
1e520 20 66 72 65 65 64 2c 20 74 68 65 6e 20 74 68 65   freed, then the
1e530 20 62 65 68 61 76 69 6f 72 0a 2a 2a 20 6f 66 20   behavior.** of 
1e540 73 71 6c 69 74 65 33 5f 6d 73 69 7a 65 28 58 29  sqlite3_msize(X)
1e550 20 69 73 20 75 6e 64 65 66 69 6e 65 64 20 61 6e   is undefined an
1e560 64 20 70 6f 73 73 69 62 6c 79 20 68 61 72 6d 66  d possibly harmf
1e570 75 6c 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 6d  ul..**.** ^The m
1e580 65 6d 6f 72 79 20 72 65 74 75 72 6e 65 64 20 62  emory returned b
1e590 79 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63  y sqlite3_malloc
1e5a0 28 29 2c 20 73 71 6c 69 74 65 33 5f 72 65 61 6c  (), sqlite3_real
1e5b0 6c 6f 63 28 29 2c 0a 2a 2a 20 73 71 6c 69 74 65  loc(),.** sqlite
1e5c0 33 5f 6d 61 6c 6c 6f 63 36 34 28 29 2c 20 61 6e  3_malloc64(), an
1e5d0 64 20 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f  d sqlite3_reallo
1e5e0 63 36 34 28 29 0a 2a 2a 20 69 73 20 61 6c 77 61  c64().** is alwa
1e5f0 79 73 20 61 6c 69 67 6e 65 64 20 74 6f 20 61 74  ys aligned to at
1e600 20 6c 65 61 73 74 20 61 6e 20 38 20 62 79 74 65   least an 8 byte
1e610 20 62 6f 75 6e 64 61 72 79 2c 20 6f 72 20 74 6f   boundary, or to
1e620 20 61 0a 2a 2a 20 34 20 62 79 74 65 20 62 6f 75   a.** 4 byte bou
1e630 6e 64 61 72 79 20 69 66 20 74 68 65 20 5b 53 51  ndary if the [SQ
1e640 4c 49 54 45 5f 34 5f 42 59 54 45 5f 41 4c 49 47  LITE_4_BYTE_ALIG
1e650 4e 45 44 5f 4d 41 4c 4c 4f 43 5d 20 63 6f 6d 70  NED_MALLOC] comp
1e660 69 6c 65 2d 74 69 6d 65 0a 2a 2a 20 6f 70 74 69  ile-time.** opti
1e670 6f 6e 20 69 73 20 75 73 65 64 2e 0a 2a 2a 0a 2a  on is used..**.*
1e680 2a 20 49 6e 20 53 51 4c 69 74 65 20 76 65 72 73  * In SQLite vers
1e690 69 6f 6e 20 33 2e 35 2e 30 20 61 6e 64 20 33 2e  ion 3.5.0 and 3.
1e6a0 35 2e 31 2c 20 69 74 20 77 61 73 20 70 6f 73 73  5.1, it was poss
1e6b0 69 62 6c 65 20 74 6f 20 64 65 66 69 6e 65 0a 2a  ible to define.*
1e6c0 2a 20 74 68 65 20 53 51 4c 49 54 45 5f 4f 4d 49  * the SQLITE_OMI
1e6d0 54 5f 4d 45 4d 4f 52 59 5f 41 4c 4c 4f 43 41 54  T_MEMORY_ALLOCAT
1e6e0 49 4f 4e 20 77 68 69 63 68 20 77 6f 75 6c 64 20  ION which would 
1e6f0 63 61 75 73 65 20 74 68 65 20 62 75 69 6c 74 2d  cause the built-
1e700 69 6e 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e 74 61  in.** implementa
1e710 74 69 6f 6e 20 6f 66 20 74 68 65 73 65 20 72 6f  tion of these ro
1e720 75 74 69 6e 65 73 20 74 6f 20 62 65 20 6f 6d 69  utines to be omi
1e730 74 74 65 64 2e 20 20 54 68 61 74 20 63 61 70 61  tted.  That capa
1e740 62 69 6c 69 74 79 0a 2a 2a 20 69 73 20 6e 6f 20  bility.** is no 
1e750 6c 6f 6e 67 65 72 20 70 72 6f 76 69 64 65 64 2e  longer provided.
1e760 20 20 4f 6e 6c 79 20 62 75 69 6c 74 2d 69 6e 20    Only built-in 
1e770 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72  memory allocator
1e780 73 20 63 61 6e 20 62 65 20 75 73 65 64 2e 0a 2a  s can be used..*
1e790 2a 0a 2a 2a 20 50 72 69 6f 72 20 74 6f 20 53 51  *.** Prior to SQ
1e7a0 4c 69 74 65 20 76 65 72 73 69 6f 6e 20 33 2e 37  Lite version 3.7
1e7b0 2e 31 30 2c 20 74 68 65 20 57 69 6e 64 6f 77 73  .10, the Windows
1e7c0 20 4f 53 20 69 6e 74 65 72 66 61 63 65 20 6c 61   OS interface la
1e7d0 79 65 72 20 63 61 6c 6c 65 64 0a 2a 2a 20 74 68  yer called.** th
1e7e0 65 20 73 79 73 74 65 6d 20 6d 61 6c 6c 6f 63 28  e system malloc(
1e7f0 29 20 61 6e 64 20 66 72 65 65 28 29 20 64 69 72  ) and free() dir
1e800 65 63 74 6c 79 20 77 68 65 6e 20 63 6f 6e 76 65  ectly when conve
1e810 72 74 69 6e 67 0a 2a 2a 20 66 69 6c 65 6e 61 6d  rting.** filenam
1e820 65 73 20 62 65 74 77 65 65 6e 20 74 68 65 20 55  es between the U
1e830 54 46 2d 38 20 65 6e 63 6f 64 69 6e 67 20 75 73  TF-8 encoding us
1e840 65 64 20 62 79 20 53 51 4c 69 74 65 0a 2a 2a 20  ed by SQLite.** 
1e850 61 6e 64 20 77 68 61 74 65 76 65 72 20 66 69 6c  and whatever fil
1e860 65 6e 61 6d 65 20 65 6e 63 6f 64 69 6e 67 20 69  ename encoding i
1e870 73 20 75 73 65 64 20 62 79 20 74 68 65 20 70 61  s used by the pa
1e880 72 74 69 63 75 6c 61 72 20 57 69 6e 64 6f 77 73  rticular Windows
1e890 0a 2a 2a 20 69 6e 73 74 61 6c 6c 61 74 69 6f 6e  .** installation
1e8a0 2e 20 20 4d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  .  Memory alloca
1e8b0 74 69 6f 6e 20 65 72 72 6f 72 73 20 77 65 72 65  tion errors were
1e8c0 20 64 65 74 65 63 74 65 64 2c 20 62 75 74 0a 2a   detected, but.*
1e8d0 2a 20 74 68 65 79 20 77 65 72 65 20 72 65 70 6f  * they were repo
1e8e0 72 74 65 64 20 62 61 63 6b 20 61 73 20 5b 53 51  rted back as [SQ
1e8f0 4c 49 54 45 5f 43 41 4e 54 4f 50 45 4e 5d 20 6f  LITE_CANTOPEN] o
1e900 72 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 49 4f 45  r.** [SQLITE_IOE
1e910 52 52 5d 20 72 61 74 68 65 72 20 74 68 61 6e 20  RR] rather than 
1e920 5b 53 51 4c 49 54 45 5f 4e 4f 4d 45 4d 5d 2e 0a  [SQLITE_NOMEM]..
1e930 2a 2a 0a 2a 2a 20 54 68 65 20 70 6f 69 6e 74 65  **.** The pointe
1e940 72 20 61 72 67 75 6d 65 6e 74 73 20 74 6f 20 5b  r arguments to [
1e950 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29 5d 20  sqlite3_free()] 
1e960 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 72 65 61  and [sqlite3_rea
1e970 6c 6c 6f 63 28 29 5d 0a 2a 2a 20 6d 75 73 74 20  lloc()].** must 
1e980 62 65 20 65 69 74 68 65 72 20 4e 55 4c 4c 20 6f  be either NULL o
1e990 72 20 65 6c 73 65 20 70 6f 69 6e 74 65 72 73 20  r else pointers 
1e9a0 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 61 20  obtained from a 
1e9b0 70 72 69 6f 72 0a 2a 2a 20 69 6e 76 6f 63 61 74  prior.** invocat
1e9c0 69 6f 6e 20 6f 66 20 5b 73 71 6c 69 74 65 33 5f  ion of [sqlite3_
1e9d0 6d 61 6c 6c 6f 63 28 29 5d 20 6f 72 20 5b 73 71  malloc()] or [sq
1e9e0 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63 28 29 5d  lite3_realloc()]
1e9f0 20 74 68 61 74 20 68 61 76 65 0a 2a 2a 20 6e 6f   that have.** no
1ea00 74 20 79 65 74 20 62 65 65 6e 20 72 65 6c 65 61  t yet been relea
1ea10 73 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 61  sed..**.** The a
1ea20 70 70 6c 69 63 61 74 69 6f 6e 20 6d 75 73 74 20  pplication must 
1ea30 6e 6f 74 20 72 65 61 64 20 6f 72 20 77 72 69 74  not read or writ
1ea40 65 20 61 6e 79 20 70 61 72 74 20 6f 66 0a 2a 2a  e any part of.**
1ea50 20 61 20 62 6c 6f 63 6b 20 6f 66 20 6d 65 6d 6f   a block of memo
1ea60 72 79 20 61 66 74 65 72 20 69 74 20 68 61 73 20  ry after it has 
1ea70 62 65 65 6e 20 72 65 6c 65 61 73 65 64 20 75 73  been released us
1ea80 69 6e 67 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  ing.** [sqlite3_
1ea90 66 72 65 65 28 29 5d 20 6f 72 20 5b 73 71 6c 69  free()] or [sqli
1eaa0 74 65 33 5f 72 65 61 6c 6c 6f 63 28 29 5d 2e 0a  te3_realloc()]..
1eab0 2a 2f 0a 76 6f 69 64 20 2a 73 71 6c 69 74 65 33  */.void *sqlite3
1eac0 5f 6d 61 6c 6c 6f 63 28 69 6e 74 29 3b 0a 76 6f  _malloc(int);.vo
1ead0 69 64 20 2a 73 71 6c 69 74 65 33 5f 6d 61 6c 6c  id *sqlite3_mall
1eae0 6f 63 36 34 28 73 71 6c 69 74 65 33 5f 75 69 6e  oc64(sqlite3_uin
1eaf0 74 36 34 29 3b 0a 76 6f 69 64 20 2a 73 71 6c 69  t64);.void *sqli
1eb00 74 65 33 5f 72 65 61 6c 6c 6f 63 28 76 6f 69 64  te3_realloc(void
1eb10 2a 2c 20 69 6e 74 29 3b 0a 76 6f 69 64 20 2a 73  *, int);.void *s
1eb20 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63 36 34  qlite3_realloc64
1eb30 28 76 6f 69 64 2a 2c 20 73 71 6c 69 74 65 33 5f  (void*, sqlite3_
1eb40 75 69 6e 74 36 34 29 3b 0a 76 6f 69 64 20 73 71  uint64);.void sq
1eb50 6c 69 74 65 33 5f 66 72 65 65 28 76 6f 69 64 2a  lite3_free(void*
1eb60 29 3b 0a 73 71 6c 69 74 65 33 5f 75 69 6e 74 36  );.sqlite3_uint6
1eb70 34 20 73 71 6c 69 74 65 33 5f 6d 73 69 7a 65 28  4 sqlite3_msize(
1eb80 76 6f 69 64 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43  void*);../*.** C
1eb90 41 50 49 33 52 45 46 3a 20 4d 65 6d 6f 72 79 20  API3REF: Memory 
1eba0 41 6c 6c 6f 63 61 74 6f 72 20 53 74 61 74 69 73  Allocator Statis
1ebb0 74 69 63 73 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74  tics.**.** SQLit
1ebc0 65 20 70 72 6f 76 69 64 65 73 20 74 68 65 73 65  e provides these
1ebd0 20 74 77 6f 20 69 6e 74 65 72 66 61 63 65 73 20   two interfaces 
1ebe0 66 6f 72 20 72 65 70 6f 72 74 69 6e 67 20 6f 6e  for reporting on
1ebf0 20 74 68 65 20 73 74 61 74 75 73 0a 2a 2a 20 6f   the status.** o
1ec00 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 6d  f the [sqlite3_m
1ec10 61 6c 6c 6f 63 28 29 5d 2c 20 5b 73 71 6c 69 74  alloc()], [sqlit
1ec20 65 33 5f 66 72 65 65 28 29 5d 2c 20 61 6e 64 20  e3_free()], and 
1ec30 5b 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63  [sqlite3_realloc
1ec40 28 29 5d 0a 2a 2a 20 72 6f 75 74 69 6e 65 73 2c  ()].** routines,
1ec50 20 77 68 69 63 68 20 66 6f 72 6d 20 74 68 65 20   which form the 
1ec60 62 75 69 6c 74 2d 69 6e 20 6d 65 6d 6f 72 79 20  built-in memory 
1ec70 61 6c 6c 6f 63 61 74 69 6f 6e 20 73 75 62 73 79  allocation subsy
1ec80 73 74 65 6d 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  stem..**.** ^The
1ec90 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d 6f 72 79   [sqlite3_memory
1eca0 5f 75 73 65 64 28 29 5d 20 72 6f 75 74 69 6e 65  _used()] routine
1ecb0 20 72 65 74 75 72 6e 73 20 74 68 65 20 6e 75 6d   returns the num
1ecc0 62 65 72 20 6f 66 20 62 79 74 65 73 0a 2a 2a 20  ber of bytes.** 
1ecd0 6f 66 20 6d 65 6d 6f 72 79 20 63 75 72 72 65 6e  of memory curren
1ece0 74 6c 79 20 6f 75 74 73 74 61 6e 64 69 6e 67 20  tly outstanding 
1ecf0 28 6d 61 6c 6c 6f 63 65 64 20 62 75 74 20 6e 6f  (malloced but no
1ed00 74 20 66 72 65 65 64 29 2e 0a 2a 2a 20 5e 54 68  t freed)..** ^Th
1ed10 65 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d 6f 72  e [sqlite3_memor
1ed20 79 5f 68 69 67 68 77 61 74 65 72 28 29 5d 20 72  y_highwater()] r
1ed30 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73 20 74  outine returns t
1ed40 68 65 20 6d 61 78 69 6d 75 6d 0a 2a 2a 20 76 61  he maximum.** va
1ed50 6c 75 65 20 6f 66 20 5b 73 71 6c 69 74 65 33 5f  lue of [sqlite3_
1ed60 6d 65 6d 6f 72 79 5f 75 73 65 64 28 29 5d 20 73  memory_used()] s
1ed70 69 6e 63 65 20 74 68 65 20 68 69 67 68 2d 77 61  ince the high-wa
1ed80 74 65 72 20 6d 61 72 6b 0a 2a 2a 20 77 61 73 20  ter mark.** was 
1ed90 6c 61 73 74 20 72 65 73 65 74 2e 20 20 5e 54 68  last reset.  ^Th
1eda0 65 20 76 61 6c 75 65 73 20 72 65 74 75 72 6e 65  e values returne
1edb0 64 20 62 79 20 5b 73 71 6c 69 74 65 33 5f 6d 65  d by [sqlite3_me
1edc0 6d 6f 72 79 5f 75 73 65 64 28 29 5d 20 61 6e 64  mory_used()] and
1edd0 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d  .** [sqlite3_mem
1ede0 6f 72 79 5f 68 69 67 68 77 61 74 65 72 28 29 5d  ory_highwater()]
1edf0 20 69 6e 63 6c 75 64 65 20 61 6e 79 20 6f 76 65   include any ove
1ee00 72 68 65 61 64 0a 2a 2a 20 61 64 64 65 64 20 62  rhead.** added b
1ee10 79 20 53 51 4c 69 74 65 20 69 6e 20 69 74 73 20  y SQLite in its 
1ee20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 6f  implementation o
1ee30 66 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f  f [sqlite3_mallo
1ee40 63 28 29 5d 2c 0a 2a 2a 20 62 75 74 20 6e 6f 74  c()],.** but not
1ee50 20 6f 76 65 72 68 65 61 64 20 61 64 64 65 64 20   overhead added 
1ee60 62 79 20 74 68 65 20 61 6e 79 20 75 6e 64 65 72  by the any under
1ee70 6c 79 69 6e 67 20 73 79 73 74 65 6d 20 6c 69 62  lying system lib
1ee80 72 61 72 79 0a 2a 2a 20 72 6f 75 74 69 6e 65 73  rary.** routines
1ee90 20 74 68 61 74 20 5b 73 71 6c 69 74 65 33 5f 6d   that [sqlite3_m
1eea0 61 6c 6c 6f 63 28 29 5d 20 6d 61 79 20 63 61 6c  alloc()] may cal
1eeb0 6c 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 6d 65  l..**.** ^The me
1eec0 6d 6f 72 79 20 68 69 67 68 2d 77 61 74 65 72 20  mory high-water 
1eed0 6d 61 72 6b 20 69 73 20 72 65 73 65 74 20 74 6f  mark is reset to
1eee0 20 74 68 65 20 63 75 72 72 65 6e 74 20 76 61 6c   the current val
1eef0 75 65 20 6f 66 0a 2a 2a 20 5b 73 71 6c 69 74 65  ue of.** [sqlite
1ef00 33 5f 6d 65 6d 6f 72 79 5f 75 73 65 64 28 29 5d  3_memory_used()]
1ef10 20 69 66 20 61 6e 64 20 6f 6e 6c 79 20 69 66 20   if and only if 
1ef20 74 68 65 20 70 61 72 61 6d 65 74 65 72 20 74 6f  the parameter to
1ef30 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d  .** [sqlite3_mem
1ef40 6f 72 79 5f 68 69 67 68 77 61 74 65 72 28 29 5d  ory_highwater()]
1ef50 20 69 73 20 74 72 75 65 2e 20 20 5e 54 68 65 20   is true.  ^The 
1ef60 76 61 6c 75 65 20 72 65 74 75 72 6e 65 64 0a 2a  value returned.*
1ef70 2a 20 62 79 20 5b 73 71 6c 69 74 65 33 5f 6d 65  * by [sqlite3_me
1ef80 6d 6f 72 79 5f 68 69 67 68 77 61 74 65 72 28 31  mory_highwater(1
1ef90 29 5d 20 69 73 20 74 68 65 20 68 69 67 68 2d 77  )] is the high-w
1efa0 61 74 65 72 20 6d 61 72 6b 0a 2a 2a 20 70 72 69  ater mark.** pri
1efb0 6f 72 20 74 6f 20 74 68 65 20 72 65 73 65 74 2e  or to the reset.
1efc0 0a 2a 2f 0a 73 71 6c 69 74 65 33 5f 69 6e 74 36  .*/.sqlite3_int6
1efd0 34 20 73 71 6c 69 74 65 33 5f 6d 65 6d 6f 72 79  4 sqlite3_memory
1efe0 5f 75 73 65 64 28 76 6f 69 64 29 3b 0a 73 71 6c  _used(void);.sql
1eff0 69 74 65 33 5f 69 6e 74 36 34 20 73 71 6c 69 74  ite3_int64 sqlit
1f000 65 33 5f 6d 65 6d 6f 72 79 5f 68 69 67 68 77 61  e3_memory_highwa
1f010 74 65 72 28 69 6e 74 20 72 65 73 65 74 46 6c 61  ter(int resetFla
1f020 67 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  g);../*.** CAPI3
1f030 52 45 46 3a 20 50 73 65 75 64 6f 2d 52 61 6e 64  REF: Pseudo-Rand
1f040 6f 6d 20 4e 75 6d 62 65 72 20 47 65 6e 65 72 61  om Number Genera
1f050 74 6f 72 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74 65  tor.**.** SQLite
1f060 20 63 6f 6e 74 61 69 6e 73 20 61 20 68 69 67 68   contains a high
1f070 2d 71 75 61 6c 69 74 79 20 70 73 65 75 64 6f 2d  -quality pseudo-
1f080 72 61 6e 64 6f 6d 20 6e 75 6d 62 65 72 20 67 65  random number ge
1f090 6e 65 72 61 74 6f 72 20 28 50 52 4e 47 29 20 75  nerator (PRNG) u
1f0a0 73 65 64 20 74 6f 0a 2a 2a 20 73 65 6c 65 63 74  sed to.** select
1f0b0 20 72 61 6e 64 6f 6d 20 5b 52 4f 57 49 44 20 7c   random [ROWID |
1f0c0 20 52 4f 57 49 44 73 5d 20 77 68 65 6e 20 69 6e   ROWIDs] when in
1f0d0 73 65 72 74 69 6e 67 20 6e 65 77 20 72 65 63 6f  serting new reco
1f0e0 72 64 73 20 69 6e 74 6f 20 61 20 74 61 62 6c 65  rds into a table
1f0f0 20 74 68 61 74 0a 2a 2a 20 61 6c 72 65 61 64 79   that.** already
1f100 20 75 73 65 73 20 74 68 65 20 6c 61 72 67 65 73   uses the larges
1f110 74 20 70 6f 73 73 69 62 6c 65 20 5b 52 4f 57 49  t possible [ROWI
1f120 44 5d 2e 20 20 54 68 65 20 50 52 4e 47 20 69 73  D].  The PRNG is
1f130 20 61 6c 73 6f 20 75 73 65 64 20 66 6f 72 0a 2a   also used for.*
1f140 2a 20 74 68 65 20 62 75 69 6c 64 2d 69 6e 20 72  * the build-in r
1f150 61 6e 64 6f 6d 28 29 20 61 6e 64 20 72 61 6e 64  andom() and rand
1f160 6f 6d 62 6c 6f 62 28 29 20 53 51 4c 20 66 75 6e  omblob() SQL fun
1f170 63 74 69 6f 6e 73 2e 20 20 54 68 69 73 20 69 6e  ctions.  This in
1f180 74 65 72 66 61 63 65 20 61 6c 6c 6f 77 73 0a 2a  terface allows.*
1f190 2a 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 74  * applications t
1f1a0 6f 20 61 63 63 65 73 73 20 74 68 65 20 73 61 6d  o access the sam
1f1b0 65 20 50 52 4e 47 20 66 6f 72 20 6f 74 68 65 72  e PRNG for other
1f1c0 20 70 75 72 70 6f 73 65 73 2e 0a 2a 2a 0a 2a 2a   purposes..**.**
1f1d0 20 5e 41 20 63 61 6c 6c 20 74 6f 20 74 68 69 73   ^A call to this
1f1e0 20 72 6f 75 74 69 6e 65 20 73 74 6f 72 65 73 20   routine stores 
1f1f0 4e 20 62 79 74 65 73 20 6f 66 20 72 61 6e 64 6f  N bytes of rando
1f200 6d 6e 65 73 73 20 69 6e 74 6f 20 62 75 66 66 65  mness into buffe
1f210 72 20 50 2e 0a 2a 2a 20 5e 54 68 65 20 50 20 70  r P..** ^The P p
1f220 61 72 61 6d 65 74 65 72 20 63 61 6e 20 62 65 20  arameter can be 
1f230 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2e 0a  a NULL pointer..
1f240 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 69 73 20 72  **.** ^If this r
1f250 6f 75 74 69 6e 65 20 68 61 73 20 6e 6f 74 20 62  outine has not b
1f260 65 65 6e 20 70 72 65 76 69 6f 75 73 6c 79 20 63  een previously c
1f270 61 6c 6c 65 64 20 6f 72 20 69 66 20 74 68 65 20  alled or if the 
1f280 70 72 65 76 69 6f 75 73 0a 2a 2a 20 63 61 6c 6c  previous.** call
1f290 20 68 61 64 20 4e 20 6c 65 73 73 20 74 68 61 6e   had N less than
1f2a0 20 6f 6e 65 20 6f 72 20 61 20 4e 55 4c 4c 20 70   one or a NULL p
1f2b0 6f 69 6e 74 65 72 20 66 6f 72 20 50 2c 20 74 68  ointer for P, th
1f2c0 65 6e 20 74 68 65 20 50 52 4e 47 20 69 73 0a 2a  en the PRNG is.*
1f2d0 2a 20 73 65 65 64 65 64 20 75 73 69 6e 67 20 72  * seeded using r
1f2e0 61 6e 64 6f 6d 6e 65 73 73 20 6f 62 74 61 69 6e  andomness obtain
1f2f0 65 64 20 66 72 6f 6d 20 74 68 65 20 78 52 61 6e  ed from the xRan
1f300 64 6f 6d 6e 65 73 73 20 6d 65 74 68 6f 64 20 6f  domness method o
1f310 66 0a 2a 2a 20 74 68 65 20 64 65 66 61 75 6c 74  f.** the default
1f320 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5d 20 6f   [sqlite3_vfs] o
1f330 62 6a 65 63 74 2e 0a 2a 2a 20 5e 49 66 20 74 68  bject..** ^If th
1f340 65 20 70 72 65 76 69 6f 75 73 20 63 61 6c 6c 20  e previous call 
1f350 74 6f 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20  to this routine 
1f360 68 61 64 20 61 6e 20 4e 20 6f 66 20 31 20 6f 72  had an N of 1 or
1f370 20 6d 6f 72 65 20 61 6e 64 20 61 0a 2a 2a 20 6e   more and a.** n
1f380 6f 6e 2d 4e 55 4c 4c 20 50 20 74 68 65 6e 20 74  on-NULL P then t
1f390 68 65 20 70 73 65 75 64 6f 2d 72 61 6e 64 6f 6d  he pseudo-random
1f3a0 6e 65 73 73 20 69 73 20 67 65 6e 65 72 61 74 65  ness is generate
1f3b0 64 0a 2a 2a 20 69 6e 74 65 72 6e 61 6c 6c 79 20  d.** internally 
1f3c0 61 6e 64 20 77 69 74 68 6f 75 74 20 72 65 63 6f  and without reco
1f3d0 75 72 73 65 20 74 6f 20 74 68 65 20 5b 73 71 6c  urse to the [sql
1f3e0 69 74 65 33 5f 76 66 73 5d 20 78 52 61 6e 64 6f  ite3_vfs] xRando
1f3f0 6d 6e 65 73 73 0a 2a 2a 20 6d 65 74 68 6f 64 2e  mness.** method.
1f400 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33  .*/.void sqlite3
1f410 5f 72 61 6e 64 6f 6d 6e 65 73 73 28 69 6e 74 20  _randomness(int 
1f420 4e 2c 20 76 6f 69 64 20 2a 50 29 3b 0a 0a 2f 2a  N, void *P);../*
1f430 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6f  .** CAPI3REF: Co
1f440 6d 70 69 6c 65 2d 54 69 6d 65 20 41 75 74 68 6f  mpile-Time Autho
1f450 72 69 7a 61 74 69 6f 6e 20 43 61 6c 6c 62 61 63  rization Callbac
1f460 6b 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  ks.** METHOD: sq
1f470 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 54 68 69  lite3.**.** ^Thi
1f480 73 20 72 6f 75 74 69 6e 65 20 72 65 67 69 73 74  s routine regist
1f490 65 72 73 20 61 6e 20 61 75 74 68 6f 72 69 7a 65  ers an authorize
1f4a0 72 20 63 61 6c 6c 62 61 63 6b 20 77 69 74 68 20  r callback with 
1f4b0 61 20 70 61 72 74 69 63 75 6c 61 72 0a 2a 2a 20  a particular.** 
1f4c0 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63  [database connec
1f4d0 74 69 6f 6e 5d 2c 20 73 75 70 70 6c 69 65 64 20  tion], supplied 
1f4e0 69 6e 20 74 68 65 20 66 69 72 73 74 20 61 72 67  in the first arg
1f4f0 75 6d 65 6e 74 2e 0a 2a 2a 20 5e 54 68 65 20 61  ument..** ^The a
1f500 75 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61  uthorizer callba
1f510 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20 61 73  ck is invoked as
1f520 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 20   SQL statements 
1f530 61 72 65 20 62 65 69 6e 67 20 63 6f 6d 70 69 6c  are being compil
1f540 65 64 0a 2a 2a 20 62 79 20 5b 73 71 6c 69 74 65  ed.** by [sqlite
1f550 33 5f 70 72 65 70 61 72 65 28 29 5d 20 6f 72 20  3_prepare()] or 
1f560 69 74 73 20 76 61 72 69 61 6e 74 73 20 5b 73 71  its variants [sq
1f570 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76 32  lite3_prepare_v2
1f580 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  ()],.** [sqlite3
1f590 5f 70 72 65 70 61 72 65 31 36 28 29 5d 20 61 6e  _prepare16()] an
1f5a0 64 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61  d [sqlite3_prepa
1f5b0 72 65 31 36 5f 76 32 28 29 5d 2e 20 20 5e 41 74  re16_v2()].  ^At
1f5c0 20 76 61 72 69 6f 75 73 0a 2a 2a 20 70 6f 69 6e   various.** poin
1f5d0 74 73 20 64 75 72 69 6e 67 20 74 68 65 20 63 6f  ts during the co
1f5e0 6d 70 69 6c 61 74 69 6f 6e 20 70 72 6f 63 65 73  mpilation proces
1f5f0 73 2c 20 61 73 20 6c 6f 67 69 63 20 69 73 20 62  s, as logic is b
1f600 65 69 6e 67 20 63 72 65 61 74 65 64 0a 2a 2a 20  eing created.** 
1f610 74 6f 20 70 65 72 66 6f 72 6d 20 76 61 72 69 6f  to perform vario
1f620 75 73 20 61 63 74 69 6f 6e 73 2c 20 74 68 65 20  us actions, the 
1f630 61 75 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62  authorizer callb
1f640 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20 74  ack is invoked t
1f650 6f 0a 2a 2a 20 73 65 65 20 69 66 20 74 68 6f 73  o.** see if thos
1f660 65 20 61 63 74 69 6f 6e 73 20 61 72 65 20 61 6c  e actions are al
1f670 6c 6f 77 65 64 2e 20 20 5e 54 68 65 20 61 75 74  lowed.  ^The aut
1f680 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61 63 6b  horizer callback
1f690 20 73 68 6f 75 6c 64 0a 2a 2a 20 72 65 74 75 72   should.** retur
1f6a0 6e 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 74 6f  n [SQLITE_OK] to
1f6b0 20 61 6c 6c 6f 77 20 74 68 65 20 61 63 74 69 6f   allow the actio
1f6c0 6e 2c 20 5b 53 51 4c 49 54 45 5f 49 47 4e 4f 52  n, [SQLITE_IGNOR
1f6d0 45 5d 20 74 6f 20 64 69 73 61 6c 6c 6f 77 20 74  E] to disallow t
1f6e0 68 65 0a 2a 2a 20 73 70 65 63 69 66 69 63 20 61  he.** specific a
1f6f0 63 74 69 6f 6e 20 62 75 74 20 61 6c 6c 6f 77 20  ction but allow 
1f700 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  the SQL statemen
1f710 74 20 74 6f 20 63 6f 6e 74 69 6e 75 65 20 74 6f  t to continue to
1f720 20 62 65 0a 2a 2a 20 63 6f 6d 70 69 6c 65 64 2c   be.** compiled,
1f730 20 6f 72 20 5b 53 51 4c 49 54 45 5f 44 45 4e 59   or [SQLITE_DENY
1f740 5d 20 74 6f 20 63 61 75 73 65 20 74 68 65 20 65  ] to cause the e
1f750 6e 74 69 72 65 20 53 51 4c 20 73 74 61 74 65 6d  ntire SQL statem
1f760 65 6e 74 20 74 6f 20 62 65 0a 2a 2a 20 72 65 6a  ent to be.** rej
1f770 65 63 74 65 64 20 77 69 74 68 20 61 6e 20 65 72  ected with an er
1f780 72 6f 72 2e 20 20 5e 49 66 20 74 68 65 20 61 75  ror.  ^If the au
1f790 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61 63  thorizer callbac
1f7a0 6b 20 72 65 74 75 72 6e 73 0a 2a 2a 20 61 6e 79  k returns.** any
1f7b0 20 76 61 6c 75 65 20 6f 74 68 65 72 20 74 68 61   value other tha
1f7c0 6e 20 5b 53 51 4c 49 54 45 5f 49 47 4e 4f 52 45  n [SQLITE_IGNORE
1f7d0 5d 2c 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 2c 20  ], [SQLITE_OK], 
1f7e0 6f 72 20 5b 53 51 4c 49 54 45 5f 44 45 4e 59 5d  or [SQLITE_DENY]
1f7f0 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20 5b 73 71  .** then the [sq
1f800 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76 32  lite3_prepare_v2
1f810 28 29 5d 20 6f 72 20 65 71 75 69 76 61 6c 65 6e  ()] or equivalen
1f820 74 20 63 61 6c 6c 20 74 68 61 74 20 74 72 69 67  t call that trig
1f830 67 65 72 65 64 0a 2a 2a 20 74 68 65 20 61 75 74  gered.** the aut
1f840 68 6f 72 69 7a 65 72 20 77 69 6c 6c 20 66 61 69  horizer will fai
1f850 6c 20 77 69 74 68 20 61 6e 20 65 72 72 6f 72 20  l with an error 
1f860 6d 65 73 73 61 67 65 2e 0a 2a 2a 0a 2a 2a 20 57  message..**.** W
1f870 68 65 6e 20 74 68 65 20 63 61 6c 6c 62 61 63 6b  hen the callback
1f880 20 72 65 74 75 72 6e 73 20 5b 53 51 4c 49 54 45   returns [SQLITE
1f890 5f 4f 4b 5d 2c 20 74 68 61 74 20 6d 65 61 6e 73  _OK], that means
1f8a0 20 74 68 65 20 6f 70 65 72 61 74 69 6f 6e 0a 2a   the operation.*
1f8b0 2a 20 72 65 71 75 65 73 74 65 64 20 69 73 20 6f  * requested is o
1f8c0 6b 2e 20 20 5e 57 68 65 6e 20 74 68 65 20 63 61  k.  ^When the ca
1f8d0 6c 6c 62 61 63 6b 20 72 65 74 75 72 6e 73 20 5b  llback returns [
1f8e0 53 51 4c 49 54 45 5f 44 45 4e 59 5d 2c 20 74 68  SQLITE_DENY], th
1f8f0 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 70 72  e.** [sqlite3_pr
1f900 65 70 61 72 65 5f 76 32 28 29 5d 20 6f 72 20 65  epare_v2()] or e
1f910 71 75 69 76 61 6c 65 6e 74 20 63 61 6c 6c 20 74  quivalent call t
1f920 68 61 74 20 74 72 69 67 67 65 72 65 64 20 74 68  hat triggered th
1f930 65 0a 2a 2a 20 61 75 74 68 6f 72 69 7a 65 72 20  e.** authorizer 
1f940 77 69 6c 6c 20 66 61 69 6c 20 77 69 74 68 20 61  will fail with a
1f950 6e 20 65 72 72 6f 72 20 6d 65 73 73 61 67 65 20  n error message 
1f960 65 78 70 6c 61 69 6e 69 6e 67 20 74 68 61 74 0a  explaining that.
1f970 2a 2a 20 61 63 63 65 73 73 20 69 73 20 64 65 6e  ** access is den
1f980 69 65 64 2e 20 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  ied. .**.** ^The
1f990 20 66 69 72 73 74 20 70 61 72 61 6d 65 74 65 72   first parameter
1f9a0 20 74 6f 20 74 68 65 20 61 75 74 68 6f 72 69 7a   to the authoriz
1f9b0 65 72 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 61  er callback is a
1f9c0 20 63 6f 70 79 20 6f 66 20 74 68 65 20 74 68 69   copy of the thi
1f9d0 72 64 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72 20  rd.** parameter 
1f9e0 74 6f 20 74 68 65 20 73 71 6c 69 74 65 33 5f 73  to the sqlite3_s
1f9f0 65 74 5f 61 75 74 68 6f 72 69 7a 65 72 28 29 20  et_authorizer() 
1fa00 69 6e 74 65 72 66 61 63 65 2e 20 5e 54 68 65 20  interface. ^The 
1fa10 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72  second parameter
1fa20 0a 2a 2a 20 74 6f 20 74 68 65 20 63 61 6c 6c 62  .** to the callb
1fa30 61 63 6b 20 69 73 20 61 6e 20 69 6e 74 65 67 65  ack is an intege
1fa40 72 20 5b 53 51 4c 49 54 45 5f 43 4f 50 59 20 7c  r [SQLITE_COPY |
1fa50 20 61 63 74 69 6f 6e 20 63 6f 64 65 5d 20 74 68   action code] th
1fa60 61 74 20 73 70 65 63 69 66 69 65 73 0a 2a 2a 20  at specifies.** 
1fa70 74 68 65 20 70 61 72 74 69 63 75 6c 61 72 20 61  the particular a
1fa80 63 74 69 6f 6e 20 74 6f 20 62 65 20 61 75 74 68  ction to be auth
1fa90 6f 72 69 7a 65 64 2e 20 5e 54 68 65 20 74 68 69  orized. ^The thi
1faa0 72 64 20 74 68 72 6f 75 67 68 20 73 69 78 74 68  rd through sixth
1fab0 20 70 61 72 61 6d 65 74 65 72 73 0a 2a 2a 20 74   parameters.** t
1fac0 6f 20 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 61  o the callback a
1fad0 72 65 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74  re zero-terminat
1fae0 65 64 20 73 74 72 69 6e 67 73 20 74 68 61 74 20  ed strings that 
1faf0 63 6f 6e 74 61 69 6e 20 61 64 64 69 74 69 6f 6e  contain addition
1fb00 61 6c 0a 2a 2a 20 64 65 74 61 69 6c 73 20 61 62  al.** details ab
1fb10 6f 75 74 20 74 68 65 20 61 63 74 69 6f 6e 20 74  out the action t
1fb20 6f 20 62 65 20 61 75 74 68 6f 72 69 7a 65 64 2e  o be authorized.
1fb30 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 61  .**.** ^If the a
1fb40 63 74 69 6f 6e 20 63 6f 64 65 20 69 73 20 5b 53  ction code is [S
1fb50 51 4c 49 54 45 5f 52 45 41 44 5d 0a 2a 2a 20 61  QLITE_READ].** a
1fb60 6e 64 20 74 68 65 20 63 61 6c 6c 62 61 63 6b 20  nd the callback 
1fb70 72 65 74 75 72 6e 73 20 5b 53 51 4c 49 54 45 5f  returns [SQLITE_
1fb80 49 47 4e 4f 52 45 5d 20 74 68 65 6e 20 74 68 65  IGNORE] then the
1fb90 0a 2a 2a 20 5b 70 72 65 70 61 72 65 64 20 73 74  .** [prepared st
1fba0 61 74 65 6d 65 6e 74 5d 20 73 74 61 74 65 6d 65  atement] stateme
1fbb0 6e 74 20 69 73 20 63 6f 6e 73 74 72 75 63 74 65  nt is constructe
1fbc0 64 20 74 6f 20 73 75 62 73 74 69 74 75 74 65 0a  d to substitute.
1fbd0 2a 2a 20 61 20 4e 55 4c 4c 20 76 61 6c 75 65 20  ** a NULL value 
1fbe0 69 6e 20 70 6c 61 63 65 20 6f 66 20 74 68 65 20  in place of the 
1fbf0 74 61 62 6c 65 20 63 6f 6c 75 6d 6e 20 74 68 61  table column tha
1fc00 74 20 77 6f 75 6c 64 20 68 61 76 65 0a 2a 2a 20  t would have.** 
1fc10 62 65 65 6e 20 72 65 61 64 20 69 66 20 5b 53 51  been read if [SQ
1fc20 4c 49 54 45 5f 4f 4b 5d 20 68 61 64 20 62 65 65  LITE_OK] had bee
1fc30 6e 20 72 65 74 75 72 6e 65 64 2e 20 20 54 68 65  n returned.  The
1fc40 20 5b 53 51 4c 49 54 45 5f 49 47 4e 4f 52 45 5d   [SQLITE_IGNORE]
1fc50 0a 2a 2a 20 72 65 74 75 72 6e 20 63 61 6e 20 62  .** return can b
1fc60 65 20 75 73 65 64 20 74 6f 20 64 65 6e 79 20 61  e used to deny a
1fc70 6e 20 75 6e 74 72 75 73 74 65 64 20 75 73 65 72  n untrusted user
1fc80 20 61 63 63 65 73 73 20 74 6f 20 69 6e 64 69 76   access to indiv
1fc90 69 64 75 61 6c 0a 2a 2a 20 63 6f 6c 75 6d 6e 73  idual.** columns
1fca0 20 6f 66 20 61 20 74 61 62 6c 65 2e 0a 2a 2a 20   of a table..** 
1fcb0 5e 49 66 20 74 68 65 20 61 63 74 69 6f 6e 20 63  ^If the action c
1fcc0 6f 64 65 20 69 73 20 5b 53 51 4c 49 54 45 5f 44  ode is [SQLITE_D
1fcd0 45 4c 45 54 45 5d 20 61 6e 64 20 74 68 65 20 63  ELETE] and the c
1fce0 61 6c 6c 62 61 63 6b 20 72 65 74 75 72 6e 73 0a  allback returns.
1fcf0 2a 2a 20 5b 53 51 4c 49 54 45 5f 49 47 4e 4f 52  ** [SQLITE_IGNOR
1fd00 45 5d 20 74 68 65 6e 20 74 68 65 20 5b 44 45 4c  E] then the [DEL
1fd10 45 54 45 5d 20 6f 70 65 72 61 74 69 6f 6e 20 70  ETE] operation p
1fd20 72 6f 63 65 65 64 73 20 62 75 74 20 74 68 65 0a  roceeds but the.
1fd30 2a 2a 20 5b 74 72 75 6e 63 61 74 65 20 6f 70 74  ** [truncate opt
1fd40 69 6d 69 7a 61 74 69 6f 6e 5d 20 69 73 20 64 69  imization] is di
1fd50 73 61 62 6c 65 64 20 61 6e 64 20 61 6c 6c 20 72  sabled and all r
1fd60 6f 77 73 20 61 72 65 20 64 65 6c 65 74 65 64 20  ows are deleted 
1fd70 69 6e 64 69 76 69 64 75 61 6c 6c 79 2e 0a 2a 2a  individually..**
1fd80 0a 2a 2a 20 41 6e 20 61 75 74 68 6f 72 69 7a 65  .** An authorize
1fd90 72 20 69 73 20 75 73 65 64 20 77 68 65 6e 20 5b  r is used when [
1fda0 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 20  sqlite3_prepare 
1fdb0 7c 20 70 72 65 70 61 72 69 6e 67 5d 0a 2a 2a 20  | preparing].** 
1fdc0 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 20 66  SQL statements f
1fdd0 72 6f 6d 20 61 6e 20 75 6e 74 72 75 73 74 65 64  rom an untrusted
1fde0 20 73 6f 75 72 63 65 2c 20 74 6f 20 65 6e 73 75   source, to ensu
1fdf0 72 65 20 74 68 61 74 20 74 68 65 20 53 51 4c 20  re that the SQL 
1fe00 73 74 61 74 65 6d 65 6e 74 73 0a 2a 2a 20 64 6f  statements.** do
1fe10 20 6e 6f 74 20 74 72 79 20 74 6f 20 61 63 63 65   not try to acce
1fe20 73 73 20 64 61 74 61 20 74 68 65 79 20 61 72 65  ss data they are
1fe30 20 6e 6f 74 20 61 6c 6c 6f 77 65 64 20 74 6f 20   not allowed to 
1fe40 73 65 65 2c 20 6f 72 20 74 68 61 74 20 74 68 65  see, or that the
1fe50 79 20 64 6f 20 6e 6f 74 0a 2a 2a 20 74 72 79 20  y do not.** try 
1fe60 74 6f 20 65 78 65 63 75 74 65 20 6d 61 6c 69 63  to execute malic
1fe70 69 6f 75 73 20 73 74 61 74 65 6d 65 6e 74 73 20  ious statements 
1fe80 74 68 61 74 20 64 61 6d 61 67 65 20 74 68 65 20  that damage the 
1fe90 64 61 74 61 62 61 73 65 2e 20 20 46 6f 72 0a 2a  database.  For.*
1fea0 2a 20 65 78 61 6d 70 6c 65 2c 20 61 6e 20 61 70  * example, an ap
1feb0 70 6c 69 63 61 74 69 6f 6e 20 6d 61 79 20 61 6c  plication may al
1fec0 6c 6f 77 20 61 20 75 73 65 72 20 74 6f 20 65 6e  low a user to en
1fed0 74 65 72 20 61 72 62 69 74 72 61 72 79 0a 2a 2a  ter arbitrary.**
1fee0 20 53 51 4c 20 71 75 65 72 69 65 73 20 66 6f 72   SQL queries for
1fef0 20 65 76 61 6c 75 61 74 69 6f 6e 20 62 79 20 61   evaluation by a
1ff00 20 64 61 74 61 62 61 73 65 2e 20 20 42 75 74 20   database.  But 
1ff10 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20  the application 
1ff20 64 6f 65 73 0a 2a 2a 20 6e 6f 74 20 77 61 6e 74  does.** not want
1ff30 20 74 68 65 20 75 73 65 72 20 74 6f 20 62 65 20   the user to be 
1ff40 61 62 6c 65 20 74 6f 20 6d 61 6b 65 20 61 72 62  able to make arb
1ff50 69 74 72 61 72 79 20 63 68 61 6e 67 65 73 20 74  itrary changes t
1ff60 6f 20 74 68 65 0a 2a 2a 20 64 61 74 61 62 61 73  o the.** databas
1ff70 65 2e 20 20 41 6e 20 61 75 74 68 6f 72 69 7a 65  e.  An authorize
1ff80 72 20 63 6f 75 6c 64 20 74 68 65 6e 20 62 65 20  r could then be 
1ff90 70 75 74 20 69 6e 20 70 6c 61 63 65 20 77 68 69  put in place whi
1ffa0 6c 65 20 74 68 65 0a 2a 2a 20 75 73 65 72 2d 65  le the.** user-e
1ffb0 6e 74 65 72 65 64 20 53 51 4c 20 69 73 20 62 65  ntered SQL is be
1ffc0 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 70 72 65  ing [sqlite3_pre
1ffd0 70 61 72 65 20 7c 20 70 72 65 70 61 72 65 64 5d  pare | prepared]
1ffe0 20 74 68 61 74 0a 2a 2a 20 64 69 73 61 6c 6c 6f   that.** disallo
1fff0 77 73 20 65 76 65 72 79 74 68 69 6e 67 20 65 78  ws everything ex
20000 63 65 70 74 20 5b 53 45 4c 45 43 54 5d 20 73 74  cept [SELECT] st
20010 61 74 65 6d 65 6e 74 73 2e 0a 2a 2a 0a 2a 2a 20  atements..**.** 
20020 41 70 70 6c 69 63 61 74 69 6f 6e 73 20 74 68 61  Applications tha
20030 74 20 6e 65 65 64 20 74 6f 20 70 72 6f 63 65 73  t need to proces
20040 73 20 53 51 4c 20 66 72 6f 6d 20 75 6e 74 72 75  s SQL from untru
20050 73 74 65 64 20 73 6f 75 72 63 65 73 0a 2a 2a 20  sted sources.** 
20060 6d 69 67 68 74 20 61 6c 73 6f 20 63 6f 6e 73 69  might also consi
20070 64 65 72 20 6c 6f 77 65 72 69 6e 67 20 72 65 73  der lowering res
20080 6f 75 72 63 65 20 6c 69 6d 69 74 73 20 75 73 69  ource limits usi
20090 6e 67 20 5b 73 71 6c 69 74 65 33 5f 6c 69 6d 69  ng [sqlite3_limi
200a0 74 28 29 5d 0a 2a 2a 20 61 6e 64 20 6c 69 6d 69  t()].** and limi
200b0 74 69 6e 67 20 64 61 74 61 62 61 73 65 20 73 69  ting database si
200c0 7a 65 20 75 73 69 6e 67 20 74 68 65 20 5b 6d 61  ze using the [ma
200d0 78 5f 70 61 67 65 5f 63 6f 75 6e 74 5d 20 5b 50  x_page_count] [P
200e0 52 41 47 4d 41 5d 0a 2a 2a 20 69 6e 20 61 64 64  RAGMA].** in add
200f0 69 74 69 6f 6e 20 74 6f 20 75 73 69 6e 67 20 61  ition to using a
20100 6e 20 61 75 74 68 6f 72 69 7a 65 72 2e 0a 2a 2a  n authorizer..**
20110 0a 2a 2a 20 5e 28 4f 6e 6c 79 20 61 20 73 69 6e  .** ^(Only a sin
20120 67 6c 65 20 61 75 74 68 6f 72 69 7a 65 72 20 63  gle authorizer c
20130 61 6e 20 62 65 20 69 6e 20 70 6c 61 63 65 20 6f  an be in place o
20140 6e 20 61 20 64 61 74 61 62 61 73 65 20 63 6f 6e  n a database con
20150 6e 65 63 74 69 6f 6e 0a 2a 2a 20 61 74 20 61 20  nection.** at a 
20160 74 69 6d 65 2e 20 20 45 61 63 68 20 63 61 6c 6c  time.  Each call
20170 20 74 6f 20 73 71 6c 69 74 65 33 5f 73 65 74 5f   to sqlite3_set_
20180 61 75 74 68 6f 72 69 7a 65 72 20 6f 76 65 72 72  authorizer overr
20190 69 64 65 73 20 74 68 65 0a 2a 2a 20 70 72 65 76  ides the.** prev
201a0 69 6f 75 73 20 63 61 6c 6c 2e 29 5e 20 20 5e 44  ious call.)^  ^D
201b0 69 73 61 62 6c 65 20 74 68 65 20 61 75 74 68 6f  isable the autho
201c0 72 69 7a 65 72 20 62 79 20 69 6e 73 74 61 6c 6c  rizer by install
201d0 69 6e 67 20 61 20 4e 55 4c 4c 20 63 61 6c 6c 62  ing a NULL callb
201e0 61 63 6b 2e 0a 2a 2a 20 54 68 65 20 61 75 74 68  ack..** The auth
201f0 6f 72 69 7a 65 72 20 69 73 20 64 69 73 61 62 6c  orizer is disabl
20200 65 64 20 62 79 20 64 65 66 61 75 6c 74 2e 0a 2a  ed by default..*
20210 2a 0a 2a 2a 20 54 68 65 20 61 75 74 68 6f 72 69  *.** The authori
20220 7a 65 72 20 63 61 6c 6c 62 61 63 6b 20 6d 75 73  zer callback mus
20230 74 20 6e 6f 74 20 64 6f 20 61 6e 79 74 68 69 6e  t not do anythin
20240 67 20 74 68 61 74 20 77 69 6c 6c 20 6d 6f 64 69  g that will modi
20250 66 79 0a 2a 2a 20 74 68 65 20 64 61 74 61 62 61  fy.** the databa
20260 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 68  se connection th
20270 61 74 20 69 6e 76 6f 6b 65 64 20 74 68 65 20 61  at invoked the a
20280 75 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61  uthorizer callba
20290 63 6b 2e 0a 2a 2a 20 4e 6f 74 65 20 74 68 61 74  ck..** Note that
202a0 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72   [sqlite3_prepar
202b0 65 5f 76 32 28 29 5d 20 61 6e 64 20 5b 73 71 6c  e_v2()] and [sql
202c0 69 74 65 33 5f 73 74 65 70 28 29 5d 20 62 6f 74  ite3_step()] bot
202d0 68 20 6d 6f 64 69 66 79 20 74 68 65 69 72 0a 2a  h modify their.*
202e0 2a 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65  * database conne
202f0 63 74 69 6f 6e 73 20 66 6f 72 20 74 68 65 20 6d  ctions for the m
20300 65 61 6e 69 6e 67 20 6f 66 20 22 6d 6f 64 69 66  eaning of "modif
20310 79 22 20 69 6e 20 74 68 69 73 20 70 61 72 61 67  y" in this parag
20320 72 61 70 68 2e 0a 2a 2a 0a 2a 2a 20 5e 57 68 65  raph..**.** ^Whe
20330 6e 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61  n [sqlite3_prepa
20340 72 65 5f 76 32 28 29 5d 20 69 73 20 75 73 65 64  re_v2()] is used
20350 20 74 6f 20 70 72 65 70 61 72 65 20 61 20 73 74   to prepare a st
20360 61 74 65 6d 65 6e 74 2c 20 74 68 65 0a 2a 2a 20  atement, the.** 
20370 73 74 61 74 65 6d 65 6e 74 20 6d 69 67 68 74 20  statement might 
20380 62 65 20 72 65 2d 70 72 65 70 61 72 65 64 20 64  be re-prepared d
20390 75 72 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 73  uring [sqlite3_s
203a0 74 65 70 28 29 5d 20 64 75 65 20 74 6f 20 61 20  tep()] due to a 
203b0 0a 2a 2a 20 73 63 68 65 6d 61 20 63 68 61 6e 67  .** schema chang
203c0 65 2e 20 20 48 65 6e 63 65 2c 20 74 68 65 20 61  e.  Hence, the a
203d0 70 70 6c 69 63 61 74 69 6f 6e 20 73 68 6f 75 6c  pplication shoul
203e0 64 20 65 6e 73 75 72 65 20 74 68 61 74 20 74 68  d ensure that th
203f0 65 0a 2a 2a 20 63 6f 72 72 65 63 74 20 61 75 74  e.** correct aut
20400 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61 63 6b  horizer callback
20410 20 72 65 6d 61 69 6e 73 20 69 6e 20 70 6c 61 63   remains in plac
20420 65 20 64 75 72 69 6e 67 20 74 68 65 20 5b 73 71  e during the [sq
20430 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 2e 0a 2a  lite3_step()]..*
20440 2a 0a 2a 2a 20 5e 4e 6f 74 65 20 74 68 61 74 20  *.** ^Note that 
20450 74 68 65 20 61 75 74 68 6f 72 69 7a 65 72 20 63  the authorizer c
20460 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f 6b  allback is invok
20470 65 64 20 6f 6e 6c 79 20 64 75 72 69 6e 67 0a 2a  ed only during.*
20480 2a 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61  * [sqlite3_prepa
20490 72 65 28 29 5d 20 6f 72 20 69 74 73 20 76 61 72  re()] or its var
204a0 69 61 6e 74 73 2e 20 20 41 75 74 68 6f 72 69 7a  iants.  Authoriz
204b0 61 74 69 6f 6e 20 69 73 20 6e 6f 74 0a 2a 2a 20  ation is not.** 
204c0 70 65 72 66 6f 72 6d 65 64 20 64 75 72 69 6e 67  performed during
204d0 20 73 74 61 74 65 6d 65 6e 74 20 65 76 61 6c 75   statement evalu
204e0 61 74 69 6f 6e 20 69 6e 20 5b 73 71 6c 69 74 65  ation in [sqlite
204f0 33 5f 73 74 65 70 28 29 5d 2c 20 75 6e 6c 65 73  3_step()], unles
20500 73 0a 2a 2a 20 61 73 20 73 74 61 74 65 64 20 69  s.** as stated i
20510 6e 20 74 68 65 20 70 72 65 76 69 6f 75 73 20 70  n the previous p
20520 61 72 61 67 72 61 70 68 2c 20 73 71 6c 69 74 65  aragraph, sqlite
20530 33 5f 73 74 65 70 28 29 20 69 6e 76 6f 6b 65 73  3_step() invokes
20540 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 70 72 65 70  .** sqlite3_prep
20550 61 72 65 5f 76 32 28 29 20 74 6f 20 72 65 70 72  are_v2() to repr
20560 65 70 61 72 65 20 61 20 73 74 61 74 65 6d 65 6e  epare a statemen
20570 74 20 61 66 74 65 72 20 61 20 73 63 68 65 6d 61  t after a schema
20580 20 63 68 61 6e 67 65 2e 0a 2a 2f 0a 69 6e 74 20   change..*/.int 
20590 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 74 68  sqlite3_set_auth
205a0 6f 72 69 7a 65 72 28 0a 20 20 73 71 6c 69 74 65  orizer(.  sqlite
205b0 33 2a 2c 0a 20 20 69 6e 74 20 28 2a 78 41 75 74  3*,.  int (*xAut
205c0 68 29 28 76 6f 69 64 2a 2c 69 6e 74 2c 63 6f 6e  h)(void*,int,con
205d0 73 74 20 63 68 61 72 2a 2c 63 6f 6e 73 74 20 63  st char*,const c
205e0 68 61 72 2a 2c 63 6f 6e 73 74 20 63 68 61 72 2a  har*,const char*
205f0 2c 63 6f 6e 73 74 20 63 68 61 72 2a 29 2c 0a 20  ,const char*),. 
20600 20 76 6f 69 64 20 2a 70 55 73 65 72 44 61 74 61   void *pUserData
20610 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  .);../*.** CAPI3
20620 52 45 46 3a 20 41 75 74 68 6f 72 69 7a 65 72 20  REF: Authorizer 
20630 52 65 74 75 72 6e 20 43 6f 64 65 73 0a 2a 2a 0a  Return Codes.**.
20640 2a 2a 20 54 68 65 20 5b 73 71 6c 69 74 65 33 5f  ** The [sqlite3_
20650 73 65 74 5f 61 75 74 68 6f 72 69 7a 65 72 20 7c  set_authorizer |
20660 20 61 75 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c   authorizer call
20670 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 5d 20 6d  back function] m
20680 75 73 74 0a 2a 2a 20 72 65 74 75 72 6e 20 65 69  ust.** return ei
20690 74 68 65 72 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d  ther [SQLITE_OK]
206a0 20 6f 72 20 6f 6e 65 20 6f 66 20 74 68 65 73 65   or one of these
206b0 20 74 77 6f 20 63 6f 6e 73 74 61 6e 74 73 20 69   two constants i
206c0 6e 20 6f 72 64 65 72 0a 2a 2a 20 74 6f 20 73 69  n order.** to si
206d0 67 6e 61 6c 20 53 51 4c 69 74 65 20 77 68 65 74  gnal SQLite whet
206e0 68 65 72 20 6f 72 20 6e 6f 74 20 74 68 65 20 61  her or not the a
206f0 63 74 69 6f 6e 20 69 73 20 70 65 72 6d 69 74 74  ction is permitt
20700 65 64 2e 20 20 53 65 65 20 74 68 65 0a 2a 2a 20  ed.  See the.** 
20710 5b 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 74  [sqlite3_set_aut
20720 68 6f 72 69 7a 65 72 20 7c 20 61 75 74 68 6f 72  horizer | author
20730 69 7a 65 72 20 64 6f 63 75 6d 65 6e 74 61 74 69  izer documentati
20740 6f 6e 5d 20 66 6f 72 20 61 64 64 69 74 69 6f 6e  on] for addition
20750 61 6c 0a 2a 2a 20 69 6e 66 6f 72 6d 61 74 69 6f  al.** informatio
20760 6e 2e 0a 2a 2a 0a 2a 2a 20 4e 6f 74 65 20 74 68  n..**.** Note th
20770 61 74 20 53 51 4c 49 54 45 5f 49 47 4e 4f 52 45  at SQLITE_IGNORE
20780 20 69 73 20 61 6c 73 6f 20 75 73 65 64 20 61 73   is also used as
20790 20 61 20 5b 63 6f 6e 66 6c 69 63 74 20 72 65 73   a [conflict res
207a0 6f 6c 75 74 69 6f 6e 20 6d 6f 64 65 5d 0a 2a 2a  olution mode].**
207b0 20 72 65 74 75 72 6e 65 64 20 66 72 6f 6d 20 74   returned from t
207c0 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 74 61 62  he [sqlite3_vtab
207d0 5f 6f 6e 5f 63 6f 6e 66 6c 69 63 74 28 29 5d 20  _on_conflict()] 
207e0 69 6e 74 65 72 66 61 63 65 2e 0a 2a 2f 0a 23 64  interface..*/.#d
207f0 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 45 4e  efine SQLITE_DEN
20800 59 20 20 20 31 20 20 20 2f 2a 20 41 62 6f 72 74  Y   1   /* Abort
20810 20 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65   the SQL stateme
20820 6e 74 20 77 69 74 68 20 61 6e 20 65 72 72 6f 72  nt with an error
20830 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
20840 54 45 5f 49 47 4e 4f 52 45 20 32 20 20 20 2f 2a  TE_IGNORE 2   /*
20850 20 44 6f 6e 27 74 20 61 6c 6c 6f 77 20 61 63 63   Don't allow acc
20860 65 73 73 2c 20 62 75 74 20 64 6f 6e 27 74 20 67  ess, but don't g
20870 65 6e 65 72 61 74 65 20 61 6e 20 65 72 72 6f 72  enerate an error
20880 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33   */../*.** CAPI3
20890 52 45 46 3a 20 41 75 74 68 6f 72 69 7a 65 72 20  REF: Authorizer 
208a0 41 63 74 69 6f 6e 20 43 6f 64 65 73 0a 2a 2a 0a  Action Codes.**.
208b0 2a 2a 20 54 68 65 20 5b 73 71 6c 69 74 65 33 5f  ** The [sqlite3_
208c0 73 65 74 5f 61 75 74 68 6f 72 69 7a 65 72 28 29  set_authorizer()
208d0 5d 20 69 6e 74 65 72 66 61 63 65 20 72 65 67 69  ] interface regi
208e0 73 74 65 72 73 20 61 20 63 61 6c 6c 62 61 63 6b  sters a callback
208f0 20 66 75 6e 63 74 69 6f 6e 0a 2a 2a 20 74 68 61   function.** tha
20900 74 20 69 73 20 69 6e 76 6f 6b 65 64 20 74 6f 20  t is invoked to 
20910 61 75 74 68 6f 72 69 7a 65 20 63 65 72 74 61 69  authorize certai
20920 6e 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20  n SQL statement 
20930 61 63 74 69 6f 6e 73 2e 20 20 54 68 65 0a 2a 2a  actions.  The.**
20940 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65   second paramete
20950 72 20 74 6f 20 74 68 65 20 63 61 6c 6c 62 61 63  r to the callbac
20960 6b 20 69 73 20 61 6e 20 69 6e 74 65 67 65 72 20  k is an integer 
20970 63 6f 64 65 20 74 68 61 74 20 73 70 65 63 69 66  code that specif
20980 69 65 73 0a 2a 2a 20 77 68 61 74 20 61 63 74 69  ies.** what acti
20990 6f 6e 20 69 73 20 62 65 69 6e 67 20 61 75 74 68  on is being auth
209a0 6f 72 69 7a 65 64 2e 20 20 54 68 65 73 65 20 61  orized.  These a
209b0 72 65 20 74 68 65 20 69 6e 74 65 67 65 72 20 61  re the integer a
209c0 63 74 69 6f 6e 20 63 6f 64 65 73 20 74 68 61 74  ction codes that
209d0 0a 2a 2a 20 74 68 65 20 61 75 74 68 6f 72 69 7a  .** the authoriz
209e0 65 72 20 63 61 6c 6c 62 61 63 6b 20 6d 61 79 20  er callback may 
209f0 62 65 20 70 61 73 73 65 64 2e 0a 2a 2a 0a 2a 2a  be passed..**.**
20a00 20 54 68 65 73 65 20 61 63 74 69 6f 6e 20 63 6f   These action co
20a10 64 65 20 76 61 6c 75 65 73 20 73 69 67 6e 69 66  de values signif
20a20 79 20 77 68 61 74 20 6b 69 6e 64 20 6f 66 20 6f  y what kind of o
20a30 70 65 72 61 74 69 6f 6e 20 69 73 20 74 6f 20 62  peration is to b
20a40 65 0a 2a 2a 20 61 75 74 68 6f 72 69 7a 65 64 2e  e.** authorized.
20a50 20 20 54 68 65 20 33 72 64 20 61 6e 64 20 34 74    The 3rd and 4t
20a60 68 20 70 61 72 61 6d 65 74 65 72 73 20 74 6f 20  h parameters to 
20a70 74 68 65 20 61 75 74 68 6f 72 69 7a 61 74 69 6f  the authorizatio
20a80 6e 0a 2a 2a 20 63 61 6c 6c 62 61 63 6b 20 66 75  n.** callback fu
20a90 6e 63 74 69 6f 6e 20 77 69 6c 6c 20 62 65 20 70  nction will be p
20aa0 61 72 61 6d 65 74 65 72 73 20 6f 72 20 4e 55 4c  arameters or NUL
20ab0 4c 20 64 65 70 65 6e 64 69 6e 67 20 6f 6e 20 77  L depending on w
20ac0 68 69 63 68 20 6f 66 20 74 68 65 73 65 0a 2a 2a  hich of these.**
20ad0 20 63 6f 64 65 73 20 69 73 20 75 73 65 64 20 61   codes is used a
20ae0 73 20 74 68 65 20 73 65 63 6f 6e 64 20 70 61 72  s the second par
20af0 61 6d 65 74 65 72 2e 20 20 5e 28 54 68 65 20 35  ameter.  ^(The 5
20b00 74 68 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20  th parameter to 
20b10 74 68 65 0a 2a 2a 20 61 75 74 68 6f 72 69 7a 65  the.** authorize
20b20 72 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 74 68  r callback is th
20b30 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 64 61  e name of the da
20b40 74 61 62 61 73 65 20 28 22 6d 61 69 6e 22 2c 20  tabase ("main", 
20b50 22 74 65 6d 70 22 2c 0a 2a 2a 20 65 74 63 2e 29  "temp",.** etc.)
20b60 20 69 66 20 61 70 70 6c 69 63 61 62 6c 65 2e 29   if applicable.)
20b70 5e 20 20 5e 54 68 65 20 36 74 68 20 70 61 72 61  ^  ^The 6th para
20b80 6d 65 74 65 72 20 74 6f 20 74 68 65 20 61 75 74  meter to the aut
20b90 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61 63 6b  horizer callback
20ba0 0a 2a 2a 20 69 73 20 74 68 65 20 6e 61 6d 65 20  .** is the name 
20bb0 6f 66 20 74 68 65 20 69 6e 6e 65 72 2d 6d 6f 73  of the inner-mos
20bc0 74 20 74 72 69 67 67 65 72 20 6f 72 20 76 69 65  t trigger or vie
20bd0 77 20 74 68 61 74 20 69 73 20 72 65 73 70 6f 6e  w that is respon
20be0 73 69 62 6c 65 20 66 6f 72 0a 2a 2a 20 74 68 65  sible for.** the
20bf0 20 61 63 63 65 73 73 20 61 74 74 65 6d 70 74 20   access attempt 
20c00 6f 72 20 4e 55 4c 4c 20 69 66 20 74 68 69 73 20  or NULL if this 
20c10 61 63 63 65 73 73 20 61 74 74 65 6d 70 74 20 69  access attempt i
20c20 73 20 64 69 72 65 63 74 6c 79 20 66 72 6f 6d 0a  s directly from.
20c30 2a 2a 20 74 6f 70 2d 6c 65 76 65 6c 20 53 51 4c  ** top-level SQL
20c40 20 63 6f 64 65 2e 0a 2a 2f 0a 2f 2a 2a 2a 2a 2a   code..*/./*****
20c50 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
20c60 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
20c70 2a 2a 2a 2a 2a 2a 20 33 72 64 20 2a 2a 2a 2a 2a  ****** 3rd *****
20c80 2a 2a 2a 2a 2a 2a 2a 20 34 74 68 20 2a 2a 2a 2a  ******* 4th ****
20c90 2a 2a 2a 2a 2a 2a 2a 2f 0a 23 64 65 66 69 6e 65  *******/.#define
20ca0 20 53 51 4c 49 54 45 5f 43 52 45 41 54 45 5f 49   SQLITE_CREATE_I
20cb0 4e 44 45 58 20 20 20 20 20 20 20 20 20 20 31 20  NDEX          1 
20cc0 20 20 2f 2a 20 49 6e 64 65 78 20 4e 61 6d 65 20    /* Index Name 
20cd0 20 20 20 20 20 54 61 62 6c 65 20 4e 61 6d 65 20       Table Name 
20ce0 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20       */.#define 
20cf0 53 51 4c 49 54 45 5f 43 52 45 41 54 45 5f 54 41  SQLITE_CREATE_TA
20d00 42 4c 45 20 20 20 20 20 20 20 20 20 20 32 20 20  BLE          2  
20d10 20 2f 2a 20 54 61 62 6c 65 20 4e 61 6d 65 20 20   /* Table Name  
20d20 20 20 20 20 4e 55 4c 4c 20 20 20 20 20 20 20 20      NULL        
20d30 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53      */.#define S
20d40 51 4c 49 54 45 5f 43 52 45 41 54 45 5f 54 45 4d  QLITE_CREATE_TEM
20d50 50 5f 49 4e 44 45 58 20 20 20 20 20 33 20 20 20  P_INDEX     3   
20d60 2f 2a 20 49 6e 64 65 78 20 4e 61 6d 65 20 20 20  /* Index Name   
20d70 20 20 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20     Table Name   
20d80 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51     */.#define SQ
20d90 4c 49 54 45 5f 43 52 45 41 54 45 5f 54 45 4d 50  LITE_CREATE_TEMP
20da0 5f 54 41 42 4c 45 20 20 20 20 20 34 20 20 20 2f  _TABLE     4   /
20db0 2a 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20 20  * Table Name    
20dc0 20 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20    NULL          
20dd0 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c    */.#define SQL
20de0 49 54 45 5f 43 52 45 41 54 45 5f 54 45 4d 50 5f  ITE_CREATE_TEMP_
20df0 54 52 49 47 47 45 52 20 20 20 35 20 20 20 2f 2a  TRIGGER   5   /*
20e00 20 54 72 69 67 67 65 72 20 4e 61 6d 65 20 20 20   Trigger Name   
20e10 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20   Table Name     
20e20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
20e30 54 45 5f 43 52 45 41 54 45 5f 54 45 4d 50 5f 56  TE_CREATE_TEMP_V
20e40 49 45 57 20 20 20 20 20 20 36 20 20 20 2f 2a 20  IEW      6   /* 
20e50 56 69 65 77 20 4e 61 6d 65 20 20 20 20 20 20 20  View Name       
20e60 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20 20  NULL            
20e70 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
20e80 45 5f 43 52 45 41 54 45 5f 54 52 49 47 47 45 52  E_CREATE_TRIGGER
20e90 20 20 20 20 20 20 20 20 37 20 20 20 2f 2a 20 54          7   /* T
20ea0 72 69 67 67 65 72 20 4e 61 6d 65 20 20 20 20 54  rigger Name    T
20eb0 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 2a  able Name      *
20ec0 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
20ed0 5f 43 52 45 41 54 45 5f 56 49 45 57 20 20 20 20  _CREATE_VIEW    
20ee0 20 20 20 20 20 20 20 38 20 20 20 2f 2a 20 56 69         8   /* Vi
20ef0 65 77 20 4e 61 6d 65 20 20 20 20 20 20 20 4e 55  ew Name       NU
20f00 4c 4c 20 20 20 20 20 20 20 20 20 20 20 20 2a 2f  LL            */
20f10 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
20f20 44 45 4c 45 54 45 20 20 20 20 20 20 20 20 20 20  DELETE          
20f30 20 20 20 20 20 20 39 20 20 20 2f 2a 20 54 61 62        9   /* Tab
20f40 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 4e 55 4c  le Name      NUL
20f50 4c 20 20 20 20 20 20 20 20 20 20 20 20 2a 2f 0a  L            */.
20f60 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44  #define SQLITE_D
20f70 52 4f 50 5f 49 4e 44 45 58 20 20 20 20 20 20 20  ROP_INDEX       
20f80 20 20 20 20 31 30 20 20 20 2f 2a 20 49 6e 64 65      10   /* Inde
20f90 78 20 4e 61 6d 65 20 20 20 20 20 20 54 61 62 6c  x Name      Tabl
20fa0 65 20 4e 61 6d 65 20 20 20 20 20 20 2a 2f 0a 23  e Name      */.#
20fb0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 52  define SQLITE_DR
20fc0 4f 50 5f 54 41 42 4c 45 20 20 20 20 20 20 20 20  OP_TABLE        
20fd0 20 20 20 31 31 20 20 20 2f 2a 20 54 61 62 6c 65     11   /* Table
20fe0 20 4e 61 6d 65 20 20 20 20 20 20 4e 55 4c 4c 20   Name      NULL 
20ff0 20 20 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64             */.#d
21000 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 52 4f  efine SQLITE_DRO
21010 50 5f 54 45 4d 50 5f 49 4e 44 45 58 20 20 20 20  P_TEMP_INDEX    
21020 20 20 31 32 20 20 20 2f 2a 20 49 6e 64 65 78 20    12   /* Index 
21030 4e 61 6d 65 20 20 20 20 20 20 54 61 62 6c 65 20  Name      Table 
21040 4e 61 6d 65 20 20 20 20 20 20 2a 2f 0a 23 64 65  Name      */.#de
21050 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 52 4f 50  fine SQLITE_DROP
21060 5f 54 45 4d 50 5f 54 41 42 4c 45 20 20 20 20 20  _TEMP_TABLE     
21070 20 31 33 20 20 20 2f 2a 20 54 61 62 6c 65 20 4e   13   /* Table N
21080 61 6d 65 20 20 20 20 20 20 4e 55 4c 4c 20 20 20  ame      NULL   
21090 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64 65 66           */.#def
210a0 69 6e 65 20 53 51 4c 49 54 45 5f 44 52 4f 50 5f  ine SQLITE_DROP_
210b0 54 45 4d 50 5f 54 52 49 47 47 45 52 20 20 20 20  TEMP_TRIGGER    
210c0 31 34 20 20 20 2f 2a 20 54 72 69 67 67 65 72 20  14   /* Trigger 
210d0 4e 61 6d 65 20 20 20 20 54 61 62 6c 65 20 4e 61  Name    Table Na
210e0 6d 65 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69  me      */.#defi
210f0 6e 65 20 53 51 4c 49 54 45 5f 44 52 4f 50 5f 54  ne SQLITE_DROP_T
21100 45 4d 50 5f 56 49 45 57 20 20 20 20 20 20 20 31  EMP_VIEW       1
21110 35 20 20 20 2f 2a 20 56 69 65 77 20 4e 61 6d 65  5   /* View Name
21120 20 20 20 20 20 20 20 4e 55 4c 4c 20 20 20 20 20         NULL     
21130 20 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e         */.#defin
21140 65 20 53 51 4c 49 54 45 5f 44 52 4f 50 5f 54 52  e SQLITE_DROP_TR
21150 49 47 47 45 52 20 20 20 20 20 20 20 20 20 31 36  IGGER         16
21160 20 20 20 2f 2a 20 54 72 69 67 67 65 72 20 4e 61     /* Trigger Na
21170 6d 65 20 20 20 20 54 61 62 6c 65 20 4e 61 6d 65  me    Table Name
21180 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65        */.#define
21190 20 53 51 4c 49 54 45 5f 44 52 4f 50 5f 56 49 45   SQLITE_DROP_VIE
211a0 57 20 20 20 20 20 20 20 20 20 20 20 20 31 37 20  W            17 
211b0 20 20 2f 2a 20 56 69 65 77 20 4e 61 6d 65 20 20    /* View Name  
211c0 20 20 20 20 20 4e 55 4c 4c 20 20 20 20 20 20 20       NULL       
211d0 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20       */.#define 
211e0 53 51 4c 49 54 45 5f 49 4e 53 45 52 54 20 20 20  SQLITE_INSERT   
211f0 20 20 20 20 20 20 20 20 20 20 20 20 31 38 20 20              18  
21200 20 2f 2a 20 54 61 62 6c 65 20 4e 61 6d 65 20 20   /* Table Name  
21210 20 20 20 20 4e 55 4c 4c 20 20 20 20 20 20 20 20      NULL        
21220 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53      */.#define S
21230 51 4c 49 54 45 5f 50 52 41 47 4d 41 20 20 20 20  QLITE_PRAGMA    
21240 20 20 20 20 20 20 20 20 20 20 20 31 39 20 20 20             19   
21250 2f 2a 20 50 72 61 67 6d 61 20 4e 61 6d 65 20 20  /* Pragma Name  
21260 20 20 20 31 73 74 20 61 72 67 20 6f 72 20 4e 55     1st arg or NU
21270 4c 4c 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  LL */.#define SQ
21280 4c 49 54 45 5f 52 45 41 44 20 20 20 20 20 20 20  LITE_READ       
21290 20 20 20 20 20 20 20 20 20 20 32 30 20 20 20 2f            20   /
212a0 2a 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20 20  * Table Name    
212b0 20 20 43 6f 6c 75 6d 6e 20 4e 61 6d 65 20 20 20    Column Name   
212c0 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c    */.#define SQL
212d0 49 54 45 5f 53 45 4c 45 43 54 20 20 20 20 20 20  ITE_SELECT      
212e0 20 20 20 20 20 20 20 20 20 32 31 20 20 20 2f 2a           21   /*
212f0 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20   NULL           
21300 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20   NULL           
21310 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
21320 54 45 5f 54 52 41 4e 53 41 43 54 49 4f 4e 20 20  TE_TRANSACTION  
21330 20 20 20 20 20 20 20 20 32 32 20 20 20 2f 2a 20          22   /* 
21340 4f 70 65 72 61 74 69 6f 6e 20 20 20 20 20 20 20  Operation       
21350 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20 20  NULL            
21360 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
21370 45 5f 55 50 44 41 54 45 20 20 20 20 20 20 20 20  E_UPDATE        
21380 20 20 20 20 20 20 20 32 33 20 20 20 2f 2a 20 54         23   /* T
21390 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 43  able Name      C
213a0 6f 6c 75 6d 6e 20 4e 61 6d 65 20 20 20 20 20 2a  olumn Name     *
213b0 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
213c0 5f 41 54 54 41 43 48 20 20 20 20 20 20 20 20 20  _ATTACH         
213d0 20 20 20 20 20 20 32 34 20 20 20 2f 2a 20 46 69        24   /* Fi
213e0 6c 65 6e 61 6d 65 20 20 20 20 20 20 20 20 4e 55  lename        NU
213f0 4c 4c 20 20 20 20 20 20 20 20 20 20 20 20 2a 2f  LL            */
21400 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
21410 44 45 54 41 43 48 20 20 20 20 20 20 20 20 20 20  DETACH          
21420 20 20 20 20 20 32 35 20 20 20 2f 2a 20 44 61 74       25   /* Dat
21430 61 62 61 73 65 20 4e 61 6d 65 20 20 20 4e 55 4c  abase Name   NUL
21440 4c 20 20 20 20 20 20 20 20 20 20 20 20 2a 2f 0a  L            */.
21450 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41  #define SQLITE_A
21460 4c 54 45 52 5f 54 41 42 4c 45 20 20 20 20 20 20  LTER_TABLE      
21470 20 20 20 20 32 36 20 20 20 2f 2a 20 44 61 74 61      26   /* Data
21480 62 61 73 65 20 4e 61 6d 65 20 20 20 54 61 62 6c  base Name   Tabl
21490 65 20 4e 61 6d 65 20 20 20 20 20 20 2a 2f 0a 23  e Name      */.#
214a0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 52 45  define SQLITE_RE
214b0 49 4e 44 45 58 20 20 20 20 20 20 20 20 20 20 20  INDEX           
214c0 20 20 20 32 37 20 20 20 2f 2a 20 49 6e 64 65 78     27   /* Index
214d0 20 4e 61 6d 65 20 20 20 20 20 20 4e 55 4c 4c 20   Name      NULL 
214e0 20 20 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64             */.#d
214f0 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41 4e 41  efine SQLITE_ANA
21500 4c 59 5a 45 20 20 20 20 20 20 20 20 20 20 20 20  LYZE            
21510 20 20 32 38 20 20 20 2f 2a 20 54 61 62 6c 65 20    28   /* Table 
21520 4e 61 6d 65 20 20 20 20 20 20 4e 55 4c 4c 20 20  Name      NULL  
21530 20 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64 65            */.#de
21540 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 52 45 41  fine SQLITE_CREA
21550 54 45 5f 56 54 41 42 4c 45 20 20 20 20 20 20 20  TE_VTABLE       
21560 20 32 39 20 20 20 2f 2a 20 54 61 62 6c 65 20 4e   29   /* Table N
21570 61 6d 65 20 20 20 20 20 20 4d 6f 64 75 6c 65 20  ame      Module 
21580 4e 61 6d 65 20 20 20 20 20 2a 2f 0a 23 64 65 66  Name     */.#def
21590 69 6e 65 20 53 51 4c 49 54 45 5f 44 52 4f 50 5f  ine SQLITE_DROP_
215a0 56 54 41 42 4c 45 20 20 20 20 20 20 20 20 20 20  VTABLE          
215b0 33 30 20 20 20 2f 2a 20 54 61 62 6c 65 20 4e 61  30   /* Table Na
215c0 6d 65 20 20 20 20 20 20 4d 6f 64 75 6c 65 20 4e  me      Module N
215d0 61 6d 65 20 20 20 20 20 2a 2f 0a 23 64 65 66 69  ame     */.#defi
215e0 6e 65 20 53 51 4c 49 54 45 5f 46 55 4e 43 54 49  ne SQLITE_FUNCTI
215f0 4f 4e 20 20 20 20 20 20 20 20 20 20 20 20 20 33  ON             3
21600 31 20 20 20 2f 2a 20 4e 55 4c 4c 20 20 20 20 20  1   /* NULL     
21610 20 20 20 20 20 20 20 46 75 6e 63 74 69 6f 6e 20         Function 
21620 4e 61 6d 65 20 20 20 2a 2f 0a 23 64 65 66 69 6e  Name   */.#defin
21630 65 20 53 51 4c 49 54 45 5f 53 41 56 45 50 4f 49  e SQLITE_SAVEPOI
21640 4e 54 20 20 20 20 20 20 20 20 20 20 20 20 33 32  NT            32
21650 20 20 20 2f 2a 20 4f 70 65 72 61 74 69 6f 6e 20     /* Operation 
21660 20 20 20 20 20 20 53 61 76 65 70 6f 69 6e 74 20        Savepoint 
21670 4e 61 6d 65 20 20 2a 2f 0a 23 64 65 66 69 6e 65  Name  */.#define
21680 20 53 51 4c 49 54 45 5f 43 4f 50 59 20 20 20 20   SQLITE_COPY    
21690 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 20                0 
216a0 20 20 2f 2a 20 4e 6f 20 6c 6f 6e 67 65 72 20 75    /* No longer u
216b0 73 65 64 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  sed */.#define S
216c0 51 4c 49 54 45 5f 52 45 43 55 52 53 49 56 45 20  QLITE_RECURSIVE 
216d0 20 20 20 20 20 20 20 20 20 20 20 33 33 20 20 20             33   
216e0 2f 2a 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20  /* NULL         
216f0 20 20 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20     NULL         
21700 20 20 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 43 41 50     */../*.** CAP
21710 49 33 52 45 46 3a 20 54 72 61 63 69 6e 67 20 41  I3REF: Tracing A
21720 6e 64 20 50 72 6f 66 69 6c 69 6e 67 20 46 75 6e  nd Profiling Fun
21730 63 74 69 6f 6e 73 0a 2a 2a 20 4d 45 54 48 4f 44  ctions.** METHOD
21740 3a 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20  : sqlite3.**.** 
21750 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 61  These routines a
21760 72 65 20 64 65 70 72 65 63 61 74 65 64 2e 20 55  re deprecated. U
21770 73 65 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  se the [sqlite3_
21780 74 72 61 63 65 5f 76 32 28 29 5d 20 69 6e 74 65  trace_v2()] inte
21790 72 66 61 63 65 0a 2a 2a 20 69 6e 73 74 65 61 64  rface.** instead
217a0 20 6f 66 20 74 68 65 20 72 6f 75 74 69 6e 65 73   of the routines
217b0 20 64 65 73 63 72 69 62 65 64 20 68 65 72 65 2e   described here.
217c0 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72 6f 75  .**.** These rou
217d0 74 69 6e 65 73 20 72 65 67 69 73 74 65 72 20 63  tines register c
217e0 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e  allback function
217f0 73 20 74 68 61 74 20 63 61 6e 20 62 65 20 75 73  s that can be us
21800 65 64 20 66 6f 72 0a 2a 2a 20 74 72 61 63 69 6e  ed for.** tracin
21810 67 20 61 6e 64 20 70 72 6f 66 69 6c 69 6e 67 20  g and profiling 
21820 74 68 65 20 65 78 65 63 75 74 69 6f 6e 20 6f 66  the execution of
21830 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 2e   SQL statements.
21840 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 63 61 6c 6c  .**.** ^The call
21850 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 20 72 65  back function re
21860 67 69 73 74 65 72 65 64 20 62 79 20 73 71 6c 69  gistered by sqli
21870 74 65 33 5f 74 72 61 63 65 28 29 20 69 73 20 69  te3_trace() is i
21880 6e 76 6f 6b 65 64 20 61 74 0a 2a 2a 20 76 61 72  nvoked at.** var
21890 69 6f 75 73 20 74 69 6d 65 73 20 77 68 65 6e 20  ious times when 
218a0 61 6e 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  an SQL statement
218b0 20 69 73 20 62 65 69 6e 67 20 72 75 6e 20 62 79   is being run by
218c0 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29   [sqlite3_step()
218d0 5d 2e 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  ]..** ^The sqlit
218e0 65 33 5f 74 72 61 63 65 28 29 20 63 61 6c 6c 62  e3_trace() callb
218f0 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20 77  ack is invoked w
21900 69 74 68 20 61 20 55 54 46 2d 38 20 72 65 6e 64  ith a UTF-8 rend
21910 65 72 69 6e 67 20 6f 66 20 74 68 65 0a 2a 2a 20  ering of the.** 
21920 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 74 65  SQL statement te
21930 78 74 20 61 73 20 74 68 65 20 73 74 61 74 65 6d  xt as the statem
21940 65 6e 74 20 66 69 72 73 74 20 62 65 67 69 6e 73  ent first begins
21950 20 65 78 65 63 75 74 69 6e 67 2e 0a 2a 2a 20 5e   executing..** ^
21960 28 41 64 64 69 74 69 6f 6e 61 6c 20 73 71 6c 69  (Additional sqli
21970 74 65 33 5f 74 72 61 63 65 28 29 20 63 61 6c 6c  te3_trace() call
21980 62 61 63 6b 73 20 6d 69 67 68 74 20 6f 63 63 75  backs might occu
21990 72 0a 2a 2a 20 61 73 20 65 61 63 68 20 74 72 69  r.** as each tri
219a0 67 67 65 72 65 64 20 73 75 62 70 72 6f 67 72 61  ggered subprogra
219b0 6d 20 69 73 20 65 6e 74 65 72 65 64 2e 20 20 54  m is entered.  T
219c0 68 65 20 63 61 6c 6c 62 61 63 6b 73 20 66 6f 72  he callbacks for
219d0 20 74 72 69 67 67 65 72 73 0a 2a 2a 20 63 6f 6e   triggers.** con
219e0 74 61 69 6e 20 61 20 55 54 46 2d 38 20 53 51 4c  tain a UTF-8 SQL
219f0 20 63 6f 6d 6d 65 6e 74 20 74 68 61 74 20 69 64   comment that id
21a00 65 6e 74 69 66 69 65 73 20 74 68 65 20 74 72 69  entifies the tri
21a10 67 67 65 72 2e 29 5e 0a 2a 2a 0a 2a 2a 20 54 68  gger.)^.**.** Th
21a20 65 20 5b 53 51 4c 49 54 45 5f 54 52 41 43 45 5f  e [SQLITE_TRACE_
21a30 53 49 5a 45 5f 4c 49 4d 49 54 5d 20 63 6f 6d 70  SIZE_LIMIT] comp
21a40 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20  ile-time option 
21a50 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20 6c  can be used to l
21a60 69 6d 69 74 0a 2a 2a 20 74 68 65 20 6c 65 6e 67  imit.** the leng
21a70 74 68 20 6f 66 20 5b 62 6f 75 6e 64 20 70 61 72  th of [bound par
21a80 61 6d 65 74 65 72 5d 20 65 78 70 61 6e 73 69 6f  ameter] expansio
21a90 6e 20 69 6e 20 74 68 65 20 6f 75 74 70 75 74 20  n in the output 
21aa0 6f 66 20 73 71 6c 69 74 65 33 5f 74 72 61 63 65  of sqlite3_trace
21ab0 28 29 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 63  ()..**.** ^The c
21ac0 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e  allback function
21ad0 20 72 65 67 69 73 74 65 72 65 64 20 62 79 20 73   registered by s
21ae0 71 6c 69 74 65 33 5f 70 72 6f 66 69 6c 65 28 29  qlite3_profile()
21af0 20 69 73 20 69 6e 76 6f 6b 65 64 0a 2a 2a 20 61   is invoked.** a
21b00 73 20 65 61 63 68 20 53 51 4c 20 73 74 61 74 65  s each SQL state
21b10 6d 65 6e 74 20 66 69 6e 69 73 68 65 73 2e 20 20  ment finishes.  
21b20 5e 54 68 65 20 70 72 6f 66 69 6c 65 20 63 61 6c  ^The profile cal
21b30 6c 62 61 63 6b 20 63 6f 6e 74 61 69 6e 73 0a 2a  lback contains.*
21b40 2a 20 74 68 65 20 6f 72 69 67 69 6e 61 6c 20 73  * the original s
21b50 74 61 74 65 6d 65 6e 74 20 74 65 78 74 20 61 6e  tatement text an
21b60 64 20 61 6e 20 65 73 74 69 6d 61 74 65 20 6f 66  d an estimate of
21b70 20 77 61 6c 6c 2d 63 6c 6f 63 6b 20 74 69 6d 65   wall-clock time
21b80 0a 2a 2a 20 6f 66 20 68 6f 77 20 6c 6f 6e 67 20  .** of how long 
21b90 74 68 61 74 20 73 74 61 74 65 6d 65 6e 74 20 74  that statement t
21ba0 6f 6f 6b 20 74 6f 20 72 75 6e 2e 20 20 5e 54 68  ook to run.  ^Th
21bb0 65 20 70 72 6f 66 69 6c 65 20 63 61 6c 6c 62 61  e profile callba
21bc0 63 6b 0a 2a 2a 20 74 69 6d 65 20 69 73 20 69 6e  ck.** time is in
21bd0 20 75 6e 69 74 73 20 6f 66 20 6e 61 6e 6f 73 65   units of nanose
21be0 63 6f 6e 64 73 2c 20 68 6f 77 65 76 65 72 20 74  conds, however t
21bf0 68 65 20 63 75 72 72 65 6e 74 20 69 6d 70 6c 65  he current imple
21c00 6d 65 6e 74 61 74 69 6f 6e 0a 2a 2a 20 69 73 20  mentation.** is 
21c10 6f 6e 6c 79 20 63 61 70 61 62 6c 65 20 6f 66 20  only capable of 
21c20 6d 69 6c 6c 69 73 65 63 6f 6e 64 20 72 65 73 6f  millisecond reso
21c30 6c 75 74 69 6f 6e 20 73 6f 20 74 68 65 20 73 69  lution so the si
21c40 78 20 6c 65 61 73 74 20 73 69 67 6e 69 66 69 63  x least signific
21c50 61 6e 74 0a 2a 2a 20 64 69 67 69 74 73 20 69 6e  ant.** digits in
21c60 20 74 68 65 20 74 69 6d 65 20 61 72 65 20 6d 65   the time are me
21c70 61 6e 69 6e 67 6c 65 73 73 2e 20 20 46 75 74 75  aningless.  Futu
21c80 72 65 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 53  re versions of S
21c90 51 4c 69 74 65 0a 2a 2a 20 6d 69 67 68 74 20 70  QLite.** might p
21ca0 72 6f 76 69 64 65 20 67 72 65 61 74 65 72 20 72  rovide greater r
21cb0 65 73 6f 6c 75 74 69 6f 6e 20 6f 6e 20 74 68 65  esolution on the
21cc0 20 70 72 6f 66 69 6c 65 72 20 63 61 6c 6c 62 61   profiler callba
21cd0 63 6b 2e 20 20 54 68 65 0a 2a 2a 20 73 71 6c 69  ck.  The.** sqli
21ce0 74 65 33 5f 70 72 6f 66 69 6c 65 28 29 20 66 75  te3_profile() fu
21cf0 6e 63 74 69 6f 6e 20 69 73 20 63 6f 6e 73 69 64  nction is consid
21d00 65 72 65 64 20 65 78 70 65 72 69 6d 65 6e 74 61  ered experimenta
21d10 6c 20 61 6e 64 20 69 73 0a 2a 2a 20 73 75 62 6a  l and is.** subj
21d20 65 63 74 20 74 6f 20 63 68 61 6e 67 65 20 69 6e  ect to change in
21d30 20 66 75 74 75 72 65 20 76 65 72 73 69 6f 6e 73   future versions
21d40 20 6f 66 20 53 51 4c 69 74 65 2e 0a 2a 2f 0a 53   of SQLite..*/.S
21d50 51 4c 49 54 45 5f 44 45 50 52 45 43 41 54 45 44  QLITE_DEPRECATED
21d60 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 74   void *sqlite3_t
21d70 72 61 63 65 28 73 71 6c 69 74 65 33 2a 2c 0a 20  race(sqlite3*,. 
21d80 20 20 76 6f 69 64 28 2a 78 54 72 61 63 65 29 28    void(*xTrace)(
21d90 76 6f 69 64 2a 2c 63 6f 6e 73 74 20 63 68 61 72  void*,const char
21da0 2a 29 2c 20 76 6f 69 64 2a 29 3b 0a 53 51 4c 49  *), void*);.SQLI
21db0 54 45 5f 44 45 50 52 45 43 41 54 45 44 20 76 6f  TE_DEPRECATED vo
21dc0 69 64 20 2a 73 71 6c 69 74 65 33 5f 70 72 6f 66  id *sqlite3_prof
21dd0 69 6c 65 28 73 71 6c 69 74 65 33 2a 2c 0a 20 20  ile(sqlite3*,.  
21de0 20 76 6f 69 64 28 2a 78 50 72 6f 66 69 6c 65 29   void(*xProfile)
21df0 28 76 6f 69 64 2a 2c 63 6f 6e 73 74 20 63 68 61  (void*,const cha
21e00 72 2a 2c 73 71 6c 69 74 65 33 5f 75 69 6e 74 36  r*,sqlite3_uint6
21e10 34 29 2c 20 76 6f 69 64 2a 29 3b 0a 0a 2f 2a 0a  4), void*);../*.
21e20 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 53 51 4c  ** CAPI3REF: SQL
21e30 20 54 72 61 63 65 20 45 76 65 6e 74 20 43 6f 64   Trace Event Cod
21e40 65 73 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20  es.** KEYWORDS: 
21e50 53 51 4c 49 54 45 5f 54 52 41 43 45 0a 2a 2a 0a  SQLITE_TRACE.**.
21e60 2a 2a 20 54 68 65 73 65 20 63 6f 6e 73 74 61 6e  ** These constan
21e70 74 73 20 69 64 65 6e 74 69 66 79 20 63 6c 61 73  ts identify clas
21e80 73 65 73 20 6f 66 20 65 76 65 6e 74 73 20 74 68  ses of events th
21e90 61 74 20 63 61 6e 20 62 65 20 6d 6f 6e 69 74 6f  at can be monito
21ea0 72 65 64 0a 2a 2a 20 75 73 69 6e 67 20 74 68 65  red.** using the
21eb0 20 5b 73 71 6c 69 74 65 33 5f 74 72 61 63 65 5f   [sqlite3_trace_
21ec0 76 32 28 29 5d 20 74 72 61 63 69 6e 67 20 6c 6f  v2()] tracing lo
21ed0 67 69 63 2e 20 20 54 68 65 20 74 68 69 72 64 20  gic.  The third 
21ee0 61 72 67 75 6d 65 6e 74 0a 2a 2a 20 74 6f 20 5b  argument.** to [
21ef0 73 71 6c 69 74 65 33 5f 74 72 61 63 65 5f 76 32  sqlite3_trace_v2
21f00 28 29 5d 20 69 73 20 61 6e 20 4f 52 2d 65 64 20  ()] is an OR-ed 
21f10 63 6f 6d 62 69 6e 61 74 69 6f 6e 20 6f 66 20 6f  combination of o
21f20 6e 65 20 6f 72 20 6d 6f 72 65 20 6f 66 0a 2a 2a  ne or more of.**
21f30 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 63   the following c
21f40 6f 6e 73 74 61 6e 74 73 2e 20 20 54 68 65 20 66  onstants.  The f
21f50 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f  irst argument to
21f60 20 74 68 65 20 74 72 61 63 65 20 63 61 6c 6c 62   the trace callb
21f70 61 63 6b 0a 2a 2a 20 69 73 20 6f 6e 65 20 6f 66  ack.** is one of
21f80 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 63   the following c
21f90 6f 6e 73 74 61 6e 74 73 2e 0a 2a 2a 0a 2a 2a 20  onstants..**.** 
21fa0 4e 65 77 20 74 72 61 63 69 6e 67 20 63 6f 6e 73  New tracing cons
21fb0 74 61 6e 74 73 20 6d 61 79 20 62 65 20 61 64 64  tants may be add
21fc0 65 64 20 69 6e 20 66 75 74 75 72 65 20 72 65 6c  ed in future rel
21fd0 65 61 73 65 73 2e 0a 2a 2a 0a 2a 2a 20 41 20 74  eases..**.** A t
21fe0 72 61 63 65 20 63 61 6c 6c 62 61 63 6b 20 68 61  race callback ha
21ff0 73 20 66 6f 75 72 20 61 72 67 75 6d 65 6e 74 73  s four arguments
22000 3a 20 78 43 61 6c 6c 62 61 63 6b 28 54 2c 43 2c  : xCallback(T,C,
22010 50 2c 58 29 2e 0a 2a 2a 20 54 68 65 20 54 20 61  P,X)..** The T a
22020 72 67 75 6d 65 6e 74 20 69 73 20 6f 6e 65 20 6f  rgument is one o
22030 66 20 74 68 65 20 69 6e 74 65 67 65 72 20 74 79  f the integer ty
22040 70 65 20 63 6f 64 65 73 20 61 62 6f 76 65 2e 0a  pe codes above..
22050 2a 2a 20 54 68 65 20 43 20 61 72 67 75 6d 65 6e  ** The C argumen
22060 74 20 69 73 20 61 20 63 6f 70 79 20 6f 66 20 74  t is a copy of t
22070 68 65 20 63 6f 6e 74 65 78 74 20 70 6f 69 6e 74  he context point
22080 65 72 20 70 61 73 73 65 64 20 69 6e 20 61 73 20  er passed in as 
22090 74 68 65 0a 2a 2a 20 66 6f 75 72 74 68 20 61 72  the.** fourth ar
220a0 67 75 6d 65 6e 74 20 74 6f 20 5b 73 71 6c 69 74  gument to [sqlit
220b0 65 33 5f 74 72 61 63 65 5f 76 32 28 29 5d 2e 0a  e3_trace_v2()]..
220c0 2a 2a 20 54 68 65 20 50 20 61 72 67 75 6d 65 6e  ** The P argumen
220d0 74 20 69 73 20 61 20 70 6f 69 6e 74 65 72 20 77  t is a pointer w
220e0 68 6f 73 65 20 6d 65 61 6e 69 6e 67 20 64 65 70  hose meaning dep
220f0 65 6e 64 73 20 6f 6e 20 54 2e 0a 2a 2a 20 54 68  ends on T..** Th
22100 65 20 58 20 61 72 67 75 6d 65 6e 74 20 69 73 20  e X argument is 
22110 61 6e 20 75 6e 73 69 67 6e 65 64 20 36 34 2d 62  an unsigned 64-b
22120 69 74 20 69 6e 74 65 67 65 72 20 77 68 6f 73 65  it integer whose
22130 20 6d 65 61 6e 69 6e 67 20 61 6c 73 6f 0a 2a 2a   meaning also.**
22140 20 64 65 70 65 6e 64 73 20 6f 6e 20 54 2e 0a 2a   depends on T..*
22150 2a 0a 2a 2a 20 3c 64 6c 3e 0a 2a 2a 20 5b 5b 53  *.** <dl>.** [[S
22160 51 4c 49 54 45 5f 54 52 41 43 45 5f 53 51 4c 5d  QLITE_TRACE_SQL]
22170 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f 54 52 41  ] <dt>SQLITE_TRA
22180 43 45 5f 53 51 4c 3c 2f 64 74 3e 0a 2a 2a 20 3c  CE_SQL</dt>.** <
22190 64 64 3e 41 6e 20 53 51 4c 49 54 45 5f 54 52 41  dd>An SQLITE_TRA
221a0 43 45 5f 53 51 4c 20 63 61 6c 6c 62 61 63 6b 20  CE_SQL callback 
221b0 70 72 6f 76 69 64 65 73 20 74 68 65 20 73 61 6d  provides the sam
221c0 65 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74 79 0a  e functionality.
221d0 2a 2a 20 61 73 20 74 68 65 20 6c 65 67 61 63 79  ** as the legacy
221e0 20 5b 73 71 6c 69 74 65 33 5f 74 72 61 63 65 28   [sqlite3_trace(
221f0 29 5d 20 63 61 6c 6c 62 61 63 6b 2e 0a 2a 2a 20  )] callback..** 
22200 54 68 65 20 50 20 61 72 67 75 6d 65 6e 74 20 69  The P argument i
22210 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74  s a pointer to t
22220 68 65 20 63 6f 6e 73 74 61 6e 74 20 55 54 46 2d  he constant UTF-
22230 38 20 73 74 72 69 6e 67 20 74 68 61 74 20 69 73  8 string that is
22240 20 74 65 78 74 0a 2a 2a 20 64 65 73 63 72 69 62   text.** describ
22250 69 6e 67 20 61 6e 20 53 51 4c 20 73 74 61 74 65  ing an SQL state
22260 6d 65 6e 74 20 74 68 61 74 20 69 73 20 73 74 61  ment that is sta
22270 72 74 69 6e 67 20 74 6f 20 72 75 6e 20 77 69 74  rting to run wit
22280 68 20 61 6c 6c 0a 2a 2a 20 5b 62 6f 75 6e 64 20  h all.** [bound 
22290 70 61 72 61 6d 65 74 65 72 5d 20 65 78 70 61 6e  parameter] expan
222a0 64 65 64 2e 20 20 54 68 65 20 58 20 61 72 67 75  ded.  The X argu
222b0 6d 65 6e 74 20 69 73 20 75 6e 75 73 65 64 2e 20  ment is unused. 
222c0 20 54 68 65 20 73 69 7a 65 0a 2a 2a 20 6f 66 20   The size.** of 
222d0 74 68 65 20 65 78 70 61 6e 73 69 6f 6e 20 6f 66  the expansion of
222e0 20 5b 62 6f 75 6e 64 20 70 61 72 61 6d 65 74 65   [bound paramete
222f0 72 73 5d 20 69 73 20 6c 69 6d 69 74 65 64 20 62  rs] is limited b
22300 79 20 74 68 65 0a 2a 2a 20 5b 53 51 4c 49 54 45  y the.** [SQLITE
22310 5f 54 52 41 43 45 5f 53 49 5a 45 5f 4c 49 4d 49  _TRACE_SIZE_LIMI
22320 54 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20  T] compile-time 
22330 6f 70 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5b 5b  option..**.** [[
22340 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 53 54 4d  SQLITE_TRACE_STM
22350 54 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f 54  T]] <dt>SQLITE_T
22360 52 41 43 45 5f 53 54 4d 54 3c 2f 64 74 3e 0a 2a  RACE_STMT</dt>.*
22370 2a 20 3c 64 64 3e 41 6e 20 53 51 4c 49 54 45 5f  * <dd>An SQLITE_
22380 54 52 41 43 45 5f 53 54 4d 54 20 63 61 6c 6c 62  TRACE_STMT callb
22390 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20 6f  ack is invoked o
223a0 6e 20 74 68 65 20 73 61 6d 65 20 6f 63 63 61 73  n the same occas
223b0 69 6f 6e 73 0a 2a 2a 20 61 73 20 53 51 4c 49 54  ions.** as SQLIT
223c0 45 5f 54 52 41 43 45 5f 53 51 4c 2e 20 20 54 68  E_TRACE_SQL.  Th
223d0 65 20 64 69 66 66 65 72 65 6e 63 65 20 69 73 20  e difference is 
223e0 74 68 61 74 20 74 68 65 20 50 20 61 72 67 75 6d  that the P argum
223f0 65 6e 74 20 69 73 20 61 0a 2a 2a 20 70 6f 69 6e  ent is a.** poin
22400 74 65 72 20 74 6f 20 74 68 65 20 5b 70 72 65 70  ter to the [prep
22410 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20  ared statement] 
22420 72 61 74 68 65 72 20 74 68 61 6e 20 61 6e 20 53  rather than an S
22430 51 4c 20 73 74 72 69 6e 67 2e 0a 2a 2a 20 54 68  QL string..** Th
22440 65 20 58 20 61 72 67 75 6d 65 6e 74 20 69 73 20  e X argument is 
22450 75 6e 75 73 65 64 2e 0a 2a 2a 0a 2a 2a 20 5b 5b  unused..**.** [[
22460 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 50 52 4f  SQLITE_TRACE_PRO
22470 46 49 4c 45 5d 5d 20 3c 64 74 3e 53 51 4c 49 54  FILE]] <dt>SQLIT
22480 45 5f 54 52 41 43 45 5f 50 52 4f 46 49 4c 45 3c  E_TRACE_PROFILE<
22490 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 41 6e 20 53  /dt>.** <dd>An S
224a0 51 4c 49 54 45 5f 54 52 41 43 45 5f 50 52 4f 46  QLITE_TRACE_PROF
224b0 49 4c 45 20 63 61 6c 6c 62 61 63 6b 20 70 72 6f  ILE callback pro
224c0 76 69 64 65 73 20 61 70 70 72 6f 78 69 6d 61 74  vides approximat
224d0 65 6c 79 20 74 68 65 20 73 61 6d 65 0a 2a 2a 20  ely the same.** 
224e0 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 61 73 20 69  information as i
224f0 73 20 70 72 6f 76 69 64 65 64 20 62 79 20 74 68  s provided by th
22500 65 20 5b 73 71 6c 69 74 65 33 5f 70 72 6f 66 69  e [sqlite3_profi
22510 6c 65 28 29 5d 20 63 61 6c 6c 62 61 63 6b 2e 0a  le()] callback..
22520 2a 2a 20 54 68 65 20 50 20 61 72 67 75 6d 65 6e  ** The P argumen
22530 74 20 69 73 20 61 20 70 6f 69 6e 74 65 72 20 74  t is a pointer t
22540 6f 20 74 68 65 20 5b 70 72 65 70 61 72 65 64 20  o the [prepared 
22550 73 74 61 74 65 6d 65 6e 74 5d 20 61 6e 64 20 74  statement] and t
22560 68 65 0a 2a 2a 20 58 20 61 72 67 75 6d 65 6e 74  he.** X argument
22570 20 69 73 20 61 6e 20 65 73 74 69 6d 61 74 65 20   is an estimate 
22580 6f 66 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  of the number of
22590 20 6e 61 6e 6f 73 65 63 6f 6e 64 20 66 6f 72 20   nanosecond for 
225a0 77 68 69 63 68 0a 2a 2a 20 74 68 65 20 70 72 65  which.** the pre
225b0 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 20  pared statement 
225c0 72 61 6e 2e 20 20 54 68 65 20 53 51 4c 49 54 45  ran.  The SQLITE
225d0 5f 54 52 41 43 45 5f 50 52 4f 46 49 4c 45 20 63  _TRACE_PROFILE c
225e0 61 6c 6c 62 61 63 6b 20 69 73 0a 2a 2a 20 69 6e  allback is.** in
225f0 76 6f 6b 65 64 20 77 68 65 6e 20 74 68 65 20 73  voked when the s
22600 74 61 74 65 6d 65 6e 74 20 66 69 6e 69 73 68 65  tatement finishe
22610 73 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  s..**.** [[SQLIT
22620 45 5f 54 52 41 43 45 5f 52 4f 57 5d 5d 20 3c 64  E_TRACE_ROW]] <d
22630 74 3e 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 52  t>SQLITE_TRACE_R
22640 4f 57 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 41  OW</dt>.** <dd>A
22650 6e 20 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 52  n SQLITE_TRACE_R
22660 4f 57 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 69  OW callback is i
22670 6e 76 6f 6b 65 64 20 77 68 65 6e 65 76 65 72 20  nvoked whenever 
22680 61 20 70 72 65 70 61 72 65 64 0a 2a 2a 20 73 74  a prepared.** st
22690 61 74 65 6d 65 6e 74 20 67 65 6e 65 72 61 74 65  atement generate
226a0 73 20 61 20 73 69 6e 67 6c 65 20 72 6f 77 20 6f  s a single row o
226b0 66 20 72 65 73 75 6c 74 2e 20 20 0a 2a 2a 20 54  f result.  .** T
226c0 68 65 20 50 20 61 72 67 75 6d 65 6e 74 20 69 73  he P argument is
226d0 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68   a pointer to th
226e0 65 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74  e [prepared stat
226f0 65 6d 65 6e 74 5d 20 61 6e 64 20 74 68 65 0a 2a  ement] and the.*
22700 2a 20 58 20 61 72 67 75 6d 65 6e 74 20 69 73 20  * X argument is 
22710 75 6e 75 73 65 64 2e 0a 2a 2a 0a 2a 2a 20 5b 5b  unused..**.** [[
22720 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 43 4c 4f  SQLITE_TRACE_CLO
22730 53 45 5d 5d 20 3c 64 74 3e 53 51 4c 49 54 45 5f  SE]] <dt>SQLITE_
22740 54 52 41 43 45 5f 43 4c 4f 53 45 3c 2f 64 74 3e  TRACE_CLOSE</dt>
22750 0a 2a 2a 20 3c 64 64 3e 41 6e 20 53 51 4c 49 54  .** <dd>An SQLIT
22760 45 5f 54 52 41 43 45 5f 43 4c 4f 53 45 20 63 61  E_TRACE_CLOSE ca
22770 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65  llback is invoke
22780 64 20 77 68 65 6e 20 61 20 64 61 74 61 62 61 73  d when a databas
22790 65 0a 2a 2a 20 63 6f 6e 6e 65 63 74 69 6f 6e 20  e.** connection 
227a0 63 6c 6f 73 65 73 2e 0a 2a 2a 20 54 68 65 20 50  closes..** The P
227b0 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 20 70   argument is a p
227c0 6f 69 6e 74 65 72 20 74 6f 20 74 68 65 20 5b 64  ointer to the [d
227d0 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
227e0 6f 6e 5d 20 6f 62 6a 65 63 74 0a 2a 2a 20 61 6e  on] object.** an
227f0 64 20 74 68 65 20 58 20 61 72 67 75 6d 65 6e 74  d the X argument
22800 20 69 73 20 75 6e 75 73 65 64 2e 0a 2a 2a 20 3c   is unused..** <
22810 2f 64 6c 3e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20  /dl>.*/.#define 
22820 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 53 51 4c  SQLITE_TRACE_SQL
22830 20 20 20 20 20 20 20 20 30 78 30 30 30 31 0a 23          0x0001.#
22840 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 54 52  define SQLITE_TR
22850 41 43 45 5f 53 54 4d 54 20 20 20 20 20 20 20 30  ACE_STMT       0
22860 78 30 30 30 32 0a 23 64 65 66 69 6e 65 20 53 51  x0002.#define SQ
22870 4c 49 54 45 5f 54 52 41 43 45 5f 50 52 4f 46 49  LITE_TRACE_PROFI
22880 4c 45 20 20 20 20 30 78 30 30 30 34 0a 23 64 65  LE    0x0004.#de
22890 66 69 6e 65 20 53 51 4c 49 54 45 5f 54 52 41 43  fine SQLITE_TRAC
228a0 45 5f 52 4f 57 20 20 20 20 20 20 20 20 30 78 30  E_ROW        0x0
228b0 30 30 38 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  008.#define SQLI
228c0 54 45 5f 54 52 41 43 45 5f 43 4c 4f 53 45 20 20  TE_TRACE_CLOSE  
228d0 20 20 20 20 30 78 30 30 31 30 0a 0a 2f 2a 0a 2a      0x0010../*.*
228e0 2a 20 43 41 50 49 33 52 45 46 3a 20 53 51 4c 20  * CAPI3REF: SQL 
228f0 54 72 61 63 65 20 48 6f 6f 6b 0a 2a 2a 20 4d 45  Trace Hook.** ME
22900 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a 2a  THOD: sqlite3.**
22910 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65 33 5f  .** The sqlite3_
22920 74 72 61 63 65 5f 76 32 28 44 2c 58 2c 4d 2c 50  trace_v2(D,X,M,P
22930 29 20 69 6e 74 65 72 66 61 63 65 20 72 65 67 69  ) interface regi
22940 73 74 65 72 73 20 61 20 74 72 61 63 65 20 63 61  sters a trace ca
22950 6c 6c 62 61 63 6b 0a 2a 2a 20 66 75 6e 63 74 69  llback.** functi
22960 6f 6e 20 58 20 61 67 61 69 6e 73 74 20 5b 64 61  on X against [da
22970 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
22980 6e 5d 20 44 2c 20 75 73 69 6e 67 20 70 72 6f 70  n] D, using prop
22990 65 72 74 79 20 6d 61 73 6b 20 4d 0a 2a 2a 20 61  erty mask M.** a
229a0 6e 64 20 63 6f 6e 74 65 78 74 20 70 6f 69 6e 74  nd context point
229b0 65 72 20 50 2e 20 20 49 66 20 74 68 65 20 58 20  er P.  If the X 
229c0 63 61 6c 6c 62 61 63 6b 20 69 73 0a 2a 2a 20 4e  callback is.** N
229d0 55 4c 4c 20 6f 72 20 69 66 20 74 68 65 20 4d 20  ULL or if the M 
229e0 6d 61 73 6b 20 69 73 20 7a 65 72 6f 2c 20 74 68  mask is zero, th
229f0 65 6e 20 74 72 61 63 69 6e 67 20 69 73 20 64 69  en tracing is di
22a00 73 61 62 6c 65 64 2e 20 20 54 68 65 0a 2a 2a 20  sabled.  The.** 
22a10 4d 20 61 72 67 75 6d 65 6e 74 20 6d 75 73 74 20  M argument must 
22a20 62 65 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 20 6f  be one or more o
22a30 66 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 54 52  f the [SQLITE_TR
22a40 41 43 45 5d 0a 2a 2a 20 63 6f 6e 73 74 61 6e 74  ACE].** constant
22a50 73 2e 0a 2a 2a 0a 2a 2a 20 45 61 63 68 20 63 61  s..**.** Each ca
22a60 6c 6c 20 74 6f 20 65 69 74 68 65 72 20 73 71 6c  ll to either sql
22a70 69 74 65 33 5f 74 72 61 63 65 28 29 20 6f 72 20  ite3_trace() or 
22a80 73 71 6c 69 74 65 33 5f 74 72 61 63 65 5f 76 32  sqlite3_trace_v2
22a90 28 29 20 6f 76 65 72 72 69 64 65 73 20 0a 2a 2a  () overrides .**
22aa0 20 28 63 61 6e 63 65 6c 73 29 20 61 6e 79 20 70   (cancels) any p
22ab0 72 69 6f 72 20 63 61 6c 6c 73 20 74 6f 20 73 71  rior calls to sq
22ac0 6c 69 74 65 33 5f 74 72 61 63 65 28 29 20 6f 72  lite3_trace() or
22ad0 20 73 71 6c 69 74 65 33 5f 74 72 61 63 65 5f 76   sqlite3_trace_v
22ae0 32 28 29 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 58  2()..**.** The X
22af0 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76   callback is inv
22b00 6f 6b 65 64 20 77 68 65 6e 65 76 65 72 20 61 6e  oked whenever an
22b10 79 20 6f 66 20 74 68 65 20 65 76 65 6e 74 73 20  y of the events 
22b20 69 64 65 6e 74 69 66 69 65 64 20 62 79 20 0a 2a  identified by .*
22b30 2a 20 6d 61 73 6b 20 4d 20 6f 63 63 75 72 2e 20  * mask M occur. 
22b40 20 54 68 65 20 69 6e 74 65 67 65 72 20 72 65 74   The integer ret
22b50 75 72 6e 20 76 61 6c 75 65 20 66 72 6f 6d 20 74  urn value from t
22b60 68 65 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 63  he callback is c
22b70 75 72 72 65 6e 74 6c 79 0a 2a 2a 20 69 67 6e 6f  urrently.** igno
22b80 72 65 64 2c 20 74 68 6f 75 67 68 20 74 68 69 73  red, though this
22b90 20 6d 61 79 20 63 68 61 6e 67 65 20 69 6e 20 66   may change in f
22ba0 75 74 75 72 65 20 72 65 6c 65 61 73 65 73 2e 20  uture releases. 
22bb0 20 43 61 6c 6c 62 61 63 6b 0a 2a 2a 20 69 6d 70   Callback.** imp
22bc0 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20 73 68 6f  lementations sho
22bd0 75 6c 64 20 72 65 74 75 72 6e 20 7a 65 72 6f 20  uld return zero 
22be0 74 6f 20 65 6e 73 75 72 65 20 66 75 74 75 72 65  to ensure future
22bf0 20 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 2e 0a   compatibility..
22c00 2a 2a 0a 2a 2a 20 41 20 74 72 61 63 65 20 63 61  **.** A trace ca
22c10 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65  llback is invoke
22c20 64 20 77 69 74 68 20 66 6f 75 72 20 61 72 67 75  d with four argu
22c30 6d 65 6e 74 73 3a 20 63 61 6c 6c 62 61 63 6b 28  ments: callback(
22c40 54 2c 43 2c 50 2c 58 29 2e 0a 2a 2a 20 54 68 65  T,C,P,X)..** The
22c50 20 54 20 61 72 67 75 6d 65 6e 74 20 69 73 20 6f   T argument is o
22c60 6e 65 20 6f 66 20 74 68 65 20 5b 53 51 4c 49 54  ne of the [SQLIT
22c70 45 5f 54 52 41 43 45 5d 0a 2a 2a 20 63 6f 6e 73  E_TRACE].** cons
22c80 74 61 6e 74 73 20 74 6f 20 69 6e 64 69 63 61 74  tants to indicat
22c90 65 20 77 68 79 20 74 68 65 20 63 61 6c 6c 62 61  e why the callba
22ca0 63 6b 20 77 61 73 20 69 6e 76 6f 6b 65 64 2e 0a  ck was invoked..
22cb0 2a 2a 20 54 68 65 20 43 20 61 72 67 75 6d 65 6e  ** The C argumen
22cc0 74 20 69 73 20 61 20 63 6f 70 79 20 6f 66 20 74  t is a copy of t
22cd0 68 65 20 63 6f 6e 74 65 78 74 20 70 6f 69 6e 74  he context point
22ce0 65 72 2e 0a 2a 2a 20 54 68 65 20 50 20 61 6e 64  er..** The P and
22cf0 20 58 20 61 72 67 75 6d 65 6e 74 73 20 61 72 65   X arguments are
22d00 20 61 20 70 6f 69 6e 74 65 72 20 61 6e 64 20 61   a pointer and a
22d10 6e 20 75 6e 73 69 67 6e 65 64 20 36 34 2d 62 69  n unsigned 64-bi
22d20 74 20 69 6e 74 65 67 65 72 0a 2a 2a 20 77 68 6f  t integer.** who
22d30 73 65 20 6d 65 61 6e 69 6e 67 73 20 64 65 70 65  se meanings depe
22d40 6e 64 20 6f 6e 20 54 2e 0a 2a 2a 0a 2a 2a 20 54  nd on T..**.** T
22d50 68 65 20 73 71 6c 69 74 65 33 5f 74 72 61 63 65  he sqlite3_trace
22d60 5f 76 32 28 29 20 69 6e 74 65 72 66 61 63 65 20  _v2() interface 
22d70 69 73 20 69 6e 74 65 6e 64 65 64 20 74 6f 20 72  is intended to r
22d80 65 70 6c 61 63 65 20 74 68 65 20 6c 65 67 61 63  eplace the legac
22d90 79 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 73 20  y.** interfaces 
22da0 5b 73 71 6c 69 74 65 33 5f 74 72 61 63 65 28 29  [sqlite3_trace()
22db0 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 70  ] and [sqlite3_p
22dc0 72 6f 66 69 6c 65 28 29 5d 2c 20 62 6f 74 68 20  rofile()], both 
22dd0 6f 66 20 77 68 69 63 68 0a 2a 2a 20 61 72 65 20  of which.** are 
22de0 64 65 70 72 65 63 61 74 65 64 2e 0a 2a 2f 0a 69  deprecated..*/.i
22df0 6e 74 20 73 71 6c 69 74 65 33 5f 74 72 61 63 65  nt sqlite3_trace
22e00 5f 76 32 28 0a 20 20 73 71 6c 69 74 65 33 2a 2c  _v2(.  sqlite3*,
22e10 0a 20 20 69 6e 74 28 2a 78 43 61 6c 6c 62 61 63  .  int(*xCallbac
22e20 6b 29 28 75 6e 73 69 67 6e 65 64 2c 76 6f 69 64  k)(unsigned,void
22e30 2a 2c 76 6f 69 64 2a 2c 73 71 6c 69 74 65 33 5f  *,void*,sqlite3_
22e40 75 69 6e 74 36 34 29 2c 0a 20 20 75 6e 73 69 67  uint64),.  unsig
22e50 6e 65 64 20 75 4d 61 73 6b 2c 0a 20 20 76 6f 69  ned uMask,.  voi
22e60 64 20 2a 70 43 74 78 0a 29 3b 0a 0a 2f 2a 0a 2a  d *pCtx.);../*.*
22e70 2a 20 43 41 50 49 33 52 45 46 3a 20 51 75 65 72  * CAPI3REF: Quer
22e80 79 20 50 72 6f 67 72 65 73 73 20 43 61 6c 6c 62  y Progress Callb
22e90 61 63 6b 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20  acks.** METHOD: 
22ea0 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 54  sqlite3.**.** ^T
22eb0 68 65 20 73 71 6c 69 74 65 33 5f 70 72 6f 67 72  he sqlite3_progr
22ec0 65 73 73 5f 68 61 6e 64 6c 65 72 28 44 2c 4e 2c  ess_handler(D,N,
22ed0 58 2c 50 29 20 69 6e 74 65 72 66 61 63 65 20 63  X,P) interface c
22ee0 61 75 73 65 73 20 74 68 65 20 63 61 6c 6c 62 61  auses the callba
22ef0 63 6b 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 58  ck.** function X
22f00 20 74 6f 20 62 65 20 69 6e 76 6f 6b 65 64 20 70   to be invoked p
22f10 65 72 69 6f 64 69 63 61 6c 6c 79 20 64 75 72 69  eriodically duri
22f20 6e 67 20 6c 6f 6e 67 20 72 75 6e 6e 69 6e 67 20  ng long running 
22f30 63 61 6c 6c 73 20 74 6f 0a 2a 2a 20 5b 73 71 6c  calls to.** [sql
22f40 69 74 65 33 5f 65 78 65 63 28 29 5d 2c 20 5b 73  ite3_exec()], [s
22f50 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 61  qlite3_step()] a
22f60 6e 64 20 5b 73 71 6c 69 74 65 33 5f 67 65 74 5f  nd [sqlite3_get_
22f70 74 61 62 6c 65 28 29 5d 20 66 6f 72 0a 2a 2a 20  table()] for.** 
22f80 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
22f90 69 6f 6e 20 44 2e 20 20 41 6e 20 65 78 61 6d 70  ion D.  An examp
22fa0 6c 65 20 75 73 65 20 66 6f 72 20 74 68 69 73 0a  le use for this.
22fb0 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 69 73 20  ** interface is 
22fc0 74 6f 20 6b 65 65 70 20 61 20 47 55 49 20 75 70  to keep a GUI up
22fd0 64 61 74 65 64 20 64 75 72 69 6e 67 20 61 20 6c  dated during a l
22fe0 61 72 67 65 20 71 75 65 72 79 2e 0a 2a 2a 0a 2a  arge query..**.*
22ff0 2a 20 5e 54 68 65 20 70 61 72 61 6d 65 74 65 72  * ^The parameter
23000 20 50 20 69 73 20 70 61 73 73 65 64 20 74 68 72   P is passed thr
23010 6f 75 67 68 20 61 73 20 74 68 65 20 6f 6e 6c 79  ough as the only
23020 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 74 68   parameter to th
23030 65 20 0a 2a 2a 20 63 61 6c 6c 62 61 63 6b 20 66  e .** callback f
23040 75 6e 63 74 69 6f 6e 20 58 2e 20 20 5e 54 68 65  unction X.  ^The
23050 20 70 61 72 61 6d 65 74 65 72 20 4e 20 69 73 20   parameter N is 
23060 74 68 65 20 61 70 70 72 6f 78 69 6d 61 74 65 20  the approximate 
23070 6e 75 6d 62 65 72 20 6f 66 20 0a 2a 2a 20 5b 76  number of .** [v
23080 69 72 74 75 61 6c 20 6d 61 63 68 69 6e 65 20 69  irtual machine i
23090 6e 73 74 72 75 63 74 69 6f 6e 73 5d 20 74 68 61  nstructions] tha
230a0 74 20 61 72 65 20 65 76 61 6c 75 61 74 65 64 20  t are evaluated 
230b0 62 65 74 77 65 65 6e 20 73 75 63 63 65 73 73 69  between successi
230c0 76 65 0a 2a 2a 20 69 6e 76 6f 63 61 74 69 6f 6e  ve.** invocation
230d0 73 20 6f 66 20 74 68 65 20 63 61 6c 6c 62 61 63  s of the callbac
230e0 6b 20 58 2e 20 20 5e 49 66 20 4e 20 69 73 20 6c  k X.  ^If N is l
230f0 65 73 73 20 74 68 61 6e 20 6f 6e 65 20 74 68 65  ess than one the
23100 6e 20 74 68 65 20 70 72 6f 67 72 65 73 73 0a 2a  n the progress.*
23110 2a 20 68 61 6e 64 6c 65 72 20 69 73 20 64 69 73  * handler is dis
23120 61 62 6c 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 4f 6e  abled..**.** ^On
23130 6c 79 20 61 20 73 69 6e 67 6c 65 20 70 72 6f 67  ly a single prog
23140 72 65 73 73 20 68 61 6e 64 6c 65 72 20 6d 61 79  ress handler may
23150 20 62 65 20 64 65 66 69 6e 65 64 20 61 74 20 6f   be defined at o
23160 6e 65 20 74 69 6d 65 20 70 65 72 0a 2a 2a 20 5b  ne time per.** [
23170 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
23180 69 6f 6e 5d 3b 20 73 65 74 74 69 6e 67 20 61 20  ion]; setting a 
23190 6e 65 77 20 70 72 6f 67 72 65 73 73 20 68 61 6e  new progress han
231a0 64 6c 65 72 20 63 61 6e 63 65 6c 73 20 74 68 65  dler cancels the
231b0 0a 2a 2a 20 6f 6c 64 20 6f 6e 65 2e 20 20 5e 53  .** old one.  ^S
231c0 65 74 74 69 6e 67 20 70 61 72 61 6d 65 74 65 72  etting parameter
231d0 20 58 20 74 6f 20 4e 55 4c 4c 20 64 69 73 61 62   X to NULL disab
231e0 6c 65 73 20 74 68 65 20 70 72 6f 67 72 65 73 73  les the progress
231f0 20 68 61 6e 64 6c 65 72 2e 0a 2a 2a 20 5e 54 68   handler..** ^Th
23200 65 20 70 72 6f 67 72 65 73 73 20 68 61 6e 64 6c  e progress handl
23210 65 72 20 69 73 20 61 6c 73 6f 20 64 69 73 61 62  er is also disab
23220 6c 65 64 20 62 79 20 73 65 74 74 69 6e 67 20 4e  led by setting N
23230 20 74 6f 20 61 20 76 61 6c 75 65 20 6c 65 73 73   to a value less
23240 0a 2a 2a 20 74 68 61 6e 20 31 2e 0a 2a 2a 0a 2a  .** than 1..**.*
23250 2a 20 5e 49 66 20 74 68 65 20 70 72 6f 67 72 65  * ^If the progre
23260 73 73 20 63 61 6c 6c 62 61 63 6b 20 72 65 74 75  ss callback retu
23270 72 6e 73 20 6e 6f 6e 2d 7a 65 72 6f 2c 20 74 68  rns non-zero, th
23280 65 20 6f 70 65 72 61 74 69 6f 6e 20 69 73 0a 2a  e operation is.*
23290 2a 20 69 6e 74 65 72 72 75 70 74 65 64 2e 20 20  * interrupted.  
232a0 54 68 69 73 20 66 65 61 74 75 72 65 20 63 61 6e  This feature can
232b0 20 62 65 20 75 73 65 64 20 74 6f 20 69 6d 70 6c   be used to impl
232c0 65 6d 65 6e 74 20 61 0a 2a 2a 20 22 43 61 6e 63  ement a.** "Canc
232d0 65 6c 22 20 62 75 74 74 6f 6e 20 6f 6e 20 61 20  el" button on a 
232e0 47 55 49 20 70 72 6f 67 72 65 73 73 20 64 69 61  GUI progress dia
232f0 6c 6f 67 20 62 6f 78 2e 0a 2a 2a 0a 2a 2a 20 54  log box..**.** T
23300 68 65 20 70 72 6f 67 72 65 73 73 20 68 61 6e 64  he progress hand
23310 6c 65 72 20 63 61 6c 6c 62 61 63 6b 20 6d 75 73  ler callback mus
23320 74 20 6e 6f 74 20 64 6f 20 61 6e 79 74 68 69 6e  t not do anythin
23330 67 20 74 68 61 74 20 77 69 6c 6c 20 6d 6f 64 69  g that will modi
23340 66 79 0a 2a 2a 20 74 68 65 20 64 61 74 61 62 61  fy.** the databa
23350 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 68  se connection th
23360 61 74 20 69 6e 76 6f 6b 65 64 20 74 68 65 20 70  at invoked the p
23370 72 6f 67 72 65 73 73 20 68 61 6e 64 6c 65 72 2e  rogress handler.
23380 0a 2a 2a 20 4e 6f 74 65 20 74 68 61 74 20 5b 73  .** Note that [s
23390 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76  qlite3_prepare_v
233a0 32 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65  2()] and [sqlite
233b0 33 5f 73 74 65 70 28 29 5d 20 62 6f 74 68 20 6d  3_step()] both m
233c0 6f 64 69 66 79 20 74 68 65 69 72 0a 2a 2a 20 64  odify their.** d
233d0 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
233e0 6f 6e 73 20 66 6f 72 20 74 68 65 20 6d 65 61 6e  ons for the mean
233f0 69 6e 67 20 6f 66 20 22 6d 6f 64 69 66 79 22 20  ing of "modify" 
23400 69 6e 20 74 68 69 73 20 70 61 72 61 67 72 61 70  in this paragrap
23410 68 2e 0a 2a 2a 0a 2a 2f 0a 76 6f 69 64 20 73 71  h..**.*/.void sq
23420 6c 69 74 65 33 5f 70 72 6f 67 72 65 73 73 5f 68  lite3_progress_h
23430 61 6e 64 6c 65 72 28 73 71 6c 69 74 65 33 2a 2c  andler(sqlite3*,
23440 20 69 6e 74 2c 20 69 6e 74 28 2a 29 28 76 6f 69   int, int(*)(voi
23450 64 2a 29 2c 20 76 6f 69 64 2a 29 3b 0a 0a 2f 2a  d*), void*);../*
23460 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4f 70  .** CAPI3REF: Op
23470 65 6e 69 6e 67 20 41 20 4e 65 77 20 44 61 74 61  ening A New Data
23480 62 61 73 65 20 43 6f 6e 6e 65 63 74 69 6f 6e 0a  base Connection.
23490 2a 2a 20 43 4f 4e 53 54 52 55 43 54 4f 52 3a 20  ** CONSTRUCTOR: 
234a0 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 54  sqlite3.**.** ^T
234b0 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 6f 70  hese routines op
234c0 65 6e 20 61 6e 20 53 51 4c 69 74 65 20 64 61 74  en an SQLite dat
234d0 61 62 61 73 65 20 66 69 6c 65 20 61 73 20 73 70  abase file as sp
234e0 65 63 69 66 69 65 64 20 62 79 20 74 68 65 20 0a  ecified by the .
234f0 2a 2a 20 66 69 6c 65 6e 61 6d 65 20 61 72 67 75  ** filename argu
23500 6d 65 6e 74 2e 20 5e 54 68 65 20 66 69 6c 65 6e  ment. ^The filen
23510 61 6d 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20  ame argument is 
23520 69 6e 74 65 72 70 72 65 74 65 64 20 61 73 20 55  interpreted as U
23530 54 46 2d 38 20 66 6f 72 0a 2a 2a 20 73 71 6c 69  TF-8 for.** sqli
23540 74 65 33 5f 6f 70 65 6e 28 29 20 61 6e 64 20 73  te3_open() and s
23550 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29  qlite3_open_v2()
23560 20 61 6e 64 20 61 73 20 55 54 46 2d 31 36 20 69   and as UTF-16 i
23570 6e 20 74 68 65 20 6e 61 74 69 76 65 20 62 79 74  n the native byt
23580 65 0a 2a 2a 20 6f 72 64 65 72 20 66 6f 72 20 73  e.** order for s
23590 71 6c 69 74 65 33 5f 6f 70 65 6e 31 36 28 29 2e  qlite3_open16().
235a0 20 5e 28 41 20 5b 64 61 74 61 62 61 73 65 20 63   ^(A [database c
235b0 6f 6e 6e 65 63 74 69 6f 6e 5d 20 68 61 6e 64 6c  onnection] handl
235c0 65 20 69 73 20 75 73 75 61 6c 6c 79 0a 2a 2a 20  e is usually.** 
235d0 72 65 74 75 72 6e 65 64 20 69 6e 20 2a 70 70 44  returned in *ppD
235e0 62 2c 20 65 76 65 6e 20 69 66 20 61 6e 20 65 72  b, even if an er
235f0 72 6f 72 20 6f 63 63 75 72 73 2e 20 20 54 68 65  ror occurs.  The
23600 20 6f 6e 6c 79 20 65 78 63 65 70 74 69 6f 6e 20   only exception 
23610 69 73 20 74 68 61 74 0a 2a 2a 20 69 66 20 53 51  is that.** if SQ
23620 4c 69 74 65 20 69 73 20 75 6e 61 62 6c 65 20 74  Lite is unable t
23630 6f 20 61 6c 6c 6f 63 61 74 65 20 6d 65 6d 6f 72  o allocate memor
23640 79 20 74 6f 20 68 6f 6c 64 20 74 68 65 20 5b 73  y to hold the [s
23650 71 6c 69 74 65 33 5d 20 6f 62 6a 65 63 74 2c 0a  qlite3] object,.
23660 2a 2a 20 61 20 4e 55 4c 4c 20 77 69 6c 6c 20 62  ** a NULL will b
23670 65 20 77 72 69 74 74 65 6e 20 69 6e 74 6f 20 2a  e written into *
23680 70 70 44 62 20 69 6e 73 74 65 61 64 20 6f 66 20  ppDb instead of 
23690 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68 65  a pointer to the
236a0 20 5b 73 71 6c 69 74 65 33 5d 0a 2a 2a 20 6f 62   [sqlite3].** ob
236b0 6a 65 63 74 2e 29 5e 20 5e 28 49 66 20 74 68 65  ject.)^ ^(If the
236c0 20 64 61 74 61 62 61 73 65 20 69 73 20 6f 70 65   database is ope
236d0 6e 65 64 20 28 61 6e 64 2f 6f 72 20 63 72 65 61  ned (and/or crea
236e0 74 65 64 29 20 73 75 63 63 65 73 73 66 75 6c 6c  ted) successfull
236f0 79 2c 20 74 68 65 6e 0a 2a 2a 20 5b 53 51 4c 49  y, then.** [SQLI
23700 54 45 5f 4f 4b 5d 20 69 73 20 72 65 74 75 72 6e  TE_OK] is return
23710 65 64 2e 20 20 4f 74 68 65 72 77 69 73 65 20 61  ed.  Otherwise a
23720 6e 20 5b 65 72 72 6f 72 20 63 6f 64 65 5d 20 69  n [error code] i
23730 73 20 72 65 74 75 72 6e 65 64 2e 29 5e 20 5e 54  s returned.)^ ^T
23740 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 65  he.** [sqlite3_e
23750 72 72 6d 73 67 28 29 5d 20 6f 72 20 5b 73 71 6c  rrmsg()] or [sql
23760 69 74 65 33 5f 65 72 72 6d 73 67 31 36 28 29 5d  ite3_errmsg16()]
23770 20 72 6f 75 74 69 6e 65 73 20 63 61 6e 20 62 65   routines can be
23780 20 75 73 65 64 20 74 6f 20 6f 62 74 61 69 6e 0a   used to obtain.
23790 2a 2a 20 61 6e 20 45 6e 67 6c 69 73 68 20 6c 61  ** an English la
237a0 6e 67 75 61 67 65 20 64 65 73 63 72 69 70 74 69  nguage descripti
237b0 6f 6e 20 6f 66 20 74 68 65 20 65 72 72 6f 72 20  on of the error 
237c0 66 6f 6c 6c 6f 77 69 6e 67 20 61 20 66 61 69 6c  following a fail
237d0 75 72 65 20 6f 66 20 61 6e 79 0a 2a 2a 20 6f 66  ure of any.** of
237e0 20 74 68 65 20 73 71 6c 69 74 65 33 5f 6f 70 65   the sqlite3_ope
237f0 6e 28 29 20 72 6f 75 74 69 6e 65 73 2e 0a 2a 2a  n() routines..**
23800 0a 2a 2a 20 5e 54 68 65 20 64 65 66 61 75 6c 74  .** ^The default
23810 20 65 6e 63 6f 64 69 6e 67 20 77 69 6c 6c 20 62   encoding will b
23820 65 20 55 54 46 2d 38 20 66 6f 72 20 64 61 74 61  e UTF-8 for data
23830 62 61 73 65 73 20 63 72 65 61 74 65 64 20 75 73  bases created us
23840 69 6e 67 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 6f  ing.** sqlite3_o
23850 70 65 6e 28 29 20 6f 72 20 73 71 6c 69 74 65 33  pen() or sqlite3
23860 5f 6f 70 65 6e 5f 76 32 28 29 2e 20 20 5e 54 68  _open_v2().  ^Th
23870 65 20 64 65 66 61 75 6c 74 20 65 6e 63 6f 64 69  e default encodi
23880 6e 67 20 66 6f 72 20 64 61 74 61 62 61 73 65 73  ng for databases
23890 0a 2a 2a 20 63 72 65 61 74 65 64 20 75 73 69 6e  .** created usin
238a0 67 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31 36  g sqlite3_open16
238b0 28 29 20 77 69 6c 6c 20 62 65 20 55 54 46 2d 31  () will be UTF-1
238c0 36 20 69 6e 20 74 68 65 20 6e 61 74 69 76 65 20  6 in the native 
238d0 62 79 74 65 20 6f 72 64 65 72 2e 0a 2a 2a 0a 2a  byte order..**.*
238e0 2a 20 57 68 65 74 68 65 72 20 6f 72 20 6e 6f 74  * Whether or not
238f0 20 61 6e 20 65 72 72 6f 72 20 6f 63 63 75 72 73   an error occurs
23900 20 77 68 65 6e 20 69 74 20 69 73 20 6f 70 65 6e   when it is open
23910 65 64 2c 20 72 65 73 6f 75 72 63 65 73 0a 2a 2a  ed, resources.**
23920 20 61 73 73 6f 63 69 61 74 65 64 20 77 69 74 68   associated with
23930 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20 63   the [database c
23940 6f 6e 6e 65 63 74 69 6f 6e 5d 20 68 61 6e 64 6c  onnection] handl
23950 65 20 73 68 6f 75 6c 64 20 62 65 20 72 65 6c 65  e should be rele
23960 61 73 65 64 20 62 79 0a 2a 2a 20 70 61 73 73 69  ased by.** passi
23970 6e 67 20 69 74 20 74 6f 20 5b 73 71 6c 69 74 65  ng it to [sqlite
23980 33 5f 63 6c 6f 73 65 28 29 5d 20 77 68 65 6e 20  3_close()] when 
23990 69 74 20 69 73 20 6e 6f 20 6c 6f 6e 67 65 72 20  it is no longer 
239a0 72 65 71 75 69 72 65 64 2e 0a 2a 2a 0a 2a 2a 20  required..**.** 
239b0 54 68 65 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e  The sqlite3_open
239c0 5f 76 32 28 29 20 69 6e 74 65 72 66 61 63 65 20  _v2() interface 
239d0 77 6f 72 6b 73 20 6c 69 6b 65 20 73 71 6c 69 74  works like sqlit
239e0 65 33 5f 6f 70 65 6e 28 29 0a 2a 2a 20 65 78 63  e3_open().** exc
239f0 65 70 74 20 74 68 61 74 20 69 74 20 61 63 63 65  ept that it acce
23a00 70 74 73 20 74 77 6f 20 61 64 64 69 74 69 6f 6e  pts two addition
23a10 61 6c 20 70 61 72 61 6d 65 74 65 72 73 20 66 6f  al parameters fo
23a20 72 20 61 64 64 69 74 69 6f 6e 61 6c 20 63 6f 6e  r additional con
23a30 74 72 6f 6c 0a 2a 2a 20 6f 76 65 72 20 74 68 65  trol.** over the
23a40 20 6e 65 77 20 64 61 74 61 62 61 73 65 20 63 6f   new database co
23a50 6e 6e 65 63 74 69 6f 6e 2e 20 20 5e 28 54 68 65  nnection.  ^(The
23a60 20 66 6c 61 67 73 20 70 61 72 61 6d 65 74 65 72   flags parameter
23a70 20 74 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 6f   to.** sqlite3_o
23a80 70 65 6e 5f 76 32 28 29 20 63 61 6e 20 74 61 6b  pen_v2() can tak
23a90 65 20 6f 6e 65 20 6f 66 0a 2a 2a 20 74 68 65 20  e one of.** the 
23aa0 66 6f 6c 6c 6f 77 69 6e 67 20 74 68 72 65 65 20  following three 
23ab0 76 61 6c 75 65 73 2c 20 6f 70 74 69 6f 6e 61 6c  values, optional
23ac0 6c 79 20 63 6f 6d 62 69 6e 65 64 20 77 69 74 68  ly combined with
23ad0 20 74 68 65 20 0a 2a 2a 20 5b 53 51 4c 49 54 45   the .** [SQLITE
23ae0 5f 4f 50 45 4e 5f 4e 4f 4d 55 54 45 58 5d 2c 20  _OPEN_NOMUTEX], 
23af0 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 46 55 4c  [SQLITE_OPEN_FUL
23b00 4c 4d 55 54 45 58 5d 2c 20 5b 53 51 4c 49 54 45  LMUTEX], [SQLITE
23b10 5f 4f 50 45 4e 5f 53 48 41 52 45 44 43 41 43 48  _OPEN_SHAREDCACH
23b20 45 5d 2c 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 4f  E],.** [SQLITE_O
23b30 50 45 4e 5f 50 52 49 56 41 54 45 43 41 43 48 45  PEN_PRIVATECACHE
23b40 5d 2c 20 61 6e 64 2f 6f 72 20 5b 53 51 4c 49 54  ], and/or [SQLIT
23b50 45 5f 4f 50 45 4e 5f 55 52 49 5d 20 66 6c 61 67  E_OPEN_URI] flag
23b60 73 3a 29 5e 0a 2a 2a 0a 2a 2a 20 3c 64 6c 3e 0a  s:)^.**.** <dl>.
23b70 2a 2a 20 5e 28 3c 64 74 3e 5b 53 51 4c 49 54 45  ** ^(<dt>[SQLITE
23b80 5f 4f 50 45 4e 5f 52 45 41 44 4f 4e 4c 59 5d 3c  _OPEN_READONLY]<
23b90 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20  /dt>.** <dd>The 
23ba0 64 61 74 61 62 61 73 65 20 69 73 20 6f 70 65 6e  database is open
23bb0 65 64 20 69 6e 20 72 65 61 64 2d 6f 6e 6c 79 20  ed in read-only 
23bc0 6d 6f 64 65 2e 20 20 49 66 20 74 68 65 20 64 61  mode.  If the da
23bd0 74 61 62 61 73 65 20 64 6f 65 73 20 6e 6f 74 0a  tabase does not.
23be0 2a 2a 20 61 6c 72 65 61 64 79 20 65 78 69 73 74  ** already exist
23bf0 2c 20 61 6e 20 65 72 72 6f 72 20 69 73 20 72 65  , an error is re
23c00 74 75 72 6e 65 64 2e 3c 2f 64 64 3e 29 5e 0a 2a  turned.</dd>)^.*
23c10 2a 0a 2a 2a 20 5e 28 3c 64 74 3e 5b 53 51 4c 49  *.** ^(<dt>[SQLI
23c20 54 45 5f 4f 50 45 4e 5f 52 45 41 44 57 52 49 54  TE_OPEN_READWRIT
23c30 45 5d 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54  E]</dt>.** <dd>T
23c40 68 65 20 64 61 74 61 62 61 73 65 20 69 73 20 6f  he database is o
23c50 70 65 6e 65 64 20 66 6f 72 20 72 65 61 64 69 6e  pened for readin
23c60 67 20 61 6e 64 20 77 72 69 74 69 6e 67 20 69 66  g and writing if
23c70 20 70 6f 73 73 69 62 6c 65 2c 20 6f 72 20 72 65   possible, or re
23c80 61 64 69 6e 67 0a 2a 2a 20 6f 6e 6c 79 20 69 66  ading.** only if
23c90 20 74 68 65 20 66 69 6c 65 20 69 73 20 77 72 69   the file is wri
23ca0 74 65 20 70 72 6f 74 65 63 74 65 64 20 62 79 20  te protected by 
23cb0 74 68 65 20 6f 70 65 72 61 74 69 6e 67 20 73 79  the operating sy
23cc0 73 74 65 6d 2e 20 20 49 6e 20 65 69 74 68 65 72  stem.  In either
23cd0 0a 2a 2a 20 63 61 73 65 20 74 68 65 20 64 61 74  .** case the dat
23ce0 61 62 61 73 65 20 6d 75 73 74 20 61 6c 72 65 61  abase must alrea
23cf0 64 79 20 65 78 69 73 74 2c 20 6f 74 68 65 72 77  dy exist, otherw
23d00 69 73 65 20 61 6e 20 65 72 72 6f 72 20 69 73 20  ise an error is 
23d10 72 65 74 75 72 6e 65 64 2e 3c 2f 64 64 3e 29 5e  returned.</dd>)^
23d20 0a 2a 2a 0a 2a 2a 20 5e 28 3c 64 74 3e 5b 53 51  .**.** ^(<dt>[SQ
23d30 4c 49 54 45 5f 4f 50 45 4e 5f 52 45 41 44 57 52  LITE_OPEN_READWR
23d40 49 54 45 5d 20 7c 20 5b 53 51 4c 49 54 45 5f 4f  ITE] | [SQLITE_O
23d50 50 45 4e 5f 43 52 45 41 54 45 5d 3c 2f 64 74 3e  PEN_CREATE]</dt>
23d60 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 64 61 74 61  .** <dd>The data
23d70 62 61 73 65 20 69 73 20 6f 70 65 6e 65 64 20 66  base is opened f
23d80 6f 72 20 72 65 61 64 69 6e 67 20 61 6e 64 20 77  or reading and w
23d90 72 69 74 69 6e 67 2c 20 61 6e 64 20 69 73 20 63  riting, and is c
23da0 72 65 61 74 65 64 20 69 66 0a 2a 2a 20 69 74 20  reated if.** it 
23db0 64 6f 65 73 20 6e 6f 74 20 61 6c 72 65 61 64 79  does not already
23dc0 20 65 78 69 73 74 2e 20 54 68 69 73 20 69 73 20   exist. This is 
23dd0 74 68 65 20 62 65 68 61 76 69 6f 72 20 74 68 61  the behavior tha
23de0 74 20 69 73 20 61 6c 77 61 79 73 20 75 73 65 64  t is always used
23df0 20 66 6f 72 0a 2a 2a 20 73 71 6c 69 74 65 33 5f   for.** sqlite3_
23e00 6f 70 65 6e 28 29 20 61 6e 64 20 73 71 6c 69 74  open() and sqlit
23e10 65 33 5f 6f 70 65 6e 31 36 28 29 2e 3c 2f 64 64  e3_open16().</dd
23e20 3e 29 5e 0a 2a 2a 20 3c 2f 64 6c 3e 0a 2a 2a 0a  >)^.** </dl>.**.
23e30 2a 2a 20 49 66 20 74 68 65 20 33 72 64 20 70 61  ** If the 3rd pa
23e40 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74  rameter to sqlit
23e50 65 33 5f 6f 70 65 6e 5f 76 32 28 29 20 69 73 20  e3_open_v2() is 
23e60 6e 6f 74 20 6f 6e 65 20 6f 66 20 74 68 65 0a 2a  not one of the.*
23e70 2a 20 63 6f 6d 62 69 6e 61 74 69 6f 6e 73 20 73  * combinations s
23e80 68 6f 77 6e 20 61 62 6f 76 65 20 6f 70 74 69 6f  hown above optio
23e90 6e 61 6c 6c 79 20 63 6f 6d 62 69 6e 65 64 20 77  nally combined w
23ea0 69 74 68 20 6f 74 68 65 72 0a 2a 2a 20 5b 53 51  ith other.** [SQ
23eb0 4c 49 54 45 5f 4f 50 45 4e 5f 52 45 41 44 4f 4e  LITE_OPEN_READON
23ec0 4c 59 20 7c 20 53 51 4c 49 54 45 5f 4f 50 45 4e  LY | SQLITE_OPEN
23ed0 5f 2a 20 62 69 74 73 5d 0a 2a 2a 20 74 68 65 6e  _* bits].** then
23ee0 20 74 68 65 20 62 65 68 61 76 69 6f 72 20 69 73   the behavior is
23ef0 20 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a   undefined..**.*
23f00 2a 20 5e 49 66 20 74 68 65 20 5b 53 51 4c 49 54  * ^If the [SQLIT
23f10 45 5f 4f 50 45 4e 5f 4e 4f 4d 55 54 45 58 5d 20  E_OPEN_NOMUTEX] 
23f20 66 6c 61 67 20 69 73 20 73 65 74 2c 20 74 68 65  flag is set, the
23f30 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63  n the database c
23f40 6f 6e 6e 65 63 74 69 6f 6e 0a 2a 2a 20 6f 70 65  onnection.** ope
23f50 6e 73 20 69 6e 20 74 68 65 20 6d 75 6c 74 69 2d  ns in the multi-
23f60 74 68 72 65 61 64 20 5b 74 68 72 65 61 64 69 6e  thread [threadin
23f70 67 20 6d 6f 64 65 5d 20 61 73 20 6c 6f 6e 67 20  g mode] as long 
23f80 61 73 20 74 68 65 20 73 69 6e 67 6c 65 2d 74 68  as the single-th
23f90 72 65 61 64 0a 2a 2a 20 6d 6f 64 65 20 68 61 73  read.** mode has
23fa0 20 6e 6f 74 20 62 65 65 6e 20 73 65 74 20 61 74   not been set at
23fb0 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 72   compile-time or
23fc0 20 73 74 61 72 74 2d 74 69 6d 65 2e 20 20 5e 49   start-time.  ^I
23fd0 66 20 74 68 65 0a 2a 2a 20 5b 53 51 4c 49 54 45  f the.** [SQLITE
23fe0 5f 4f 50 45 4e 5f 46 55 4c 4c 4d 55 54 45 58 5d  _OPEN_FULLMUTEX]
23ff0 20 66 6c 61 67 20 69 73 20 73 65 74 20 74 68 65   flag is set the
24000 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63  n the database c
24010 6f 6e 6e 65 63 74 69 6f 6e 20 6f 70 65 6e 73 0a  onnection opens.
24020 2a 2a 20 69 6e 20 74 68 65 20 73 65 72 69 61 6c  ** in the serial
24030 69 7a 65 64 20 5b 74 68 72 65 61 64 69 6e 67 20  ized [threading 
24040 6d 6f 64 65 5d 20 75 6e 6c 65 73 73 20 73 69 6e  mode] unless sin
24050 67 6c 65 2d 74 68 72 65 61 64 20 77 61 73 0a 2a  gle-thread was.*
24060 2a 20 70 72 65 76 69 6f 75 73 6c 79 20 73 65 6c  * previously sel
24070 65 63 74 65 64 20 61 74 20 63 6f 6d 70 69 6c 65  ected at compile
24080 2d 74 69 6d 65 20 6f 72 20 73 74 61 72 74 2d 74  -time or start-t
24090 69 6d 65 2e 0a 2a 2a 20 5e 54 68 65 20 5b 53 51  ime..** ^The [SQ
240a0 4c 49 54 45 5f 4f 50 45 4e 5f 53 48 41 52 45 44  LITE_OPEN_SHARED
240b0 43 41 43 48 45 5d 20 66 6c 61 67 20 63 61 75 73  CACHE] flag caus
240c0 65 73 20 74 68 65 20 64 61 74 61 62 61 73 65 20  es the database 
240d0 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 6f 20 62 65  connection to be
240e0 0a 2a 2a 20 65 6c 69 67 69 62 6c 65 20 74 6f 20  .** eligible to 
240f0 75 73 65 20 5b 73 68 61 72 65 64 20 63 61 63 68  use [shared cach
24100 65 20 6d 6f 64 65 5d 2c 20 72 65 67 61 72 64 6c  e mode], regardl
24110 65 73 73 20 6f 66 20 77 68 65 74 68 65 72 20 6f  ess of whether o
24120 72 20 6e 6f 74 20 73 68 61 72 65 64 0a 2a 2a 20  r not shared.** 
24130 63 61 63 68 65 20 69 73 20 65 6e 61 62 6c 65 64  cache is enabled
24140 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f   using [sqlite3_
24150 65 6e 61 62 6c 65 5f 73 68 61 72 65 64 5f 63 61  enable_shared_ca
24160 63 68 65 28 29 5d 2e 20 20 5e 54 68 65 0a 2a 2a  che()].  ^The.**
24170 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 50 52   [SQLITE_OPEN_PR
24180 49 56 41 54 45 43 41 43 48 45 5d 20 66 6c 61 67  IVATECACHE] flag
24190 20 63 61 75 73 65 73 20 74 68 65 20 64 61 74 61   causes the data
241a0 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20  base connection 
241b0 74 6f 20 6e 6f 74 0a 2a 2a 20 70 61 72 74 69 63  to not.** partic
241c0 69 70 61 74 65 20 69 6e 20 5b 73 68 61 72 65 64  ipate in [shared
241d0 20 63 61 63 68 65 20 6d 6f 64 65 5d 20 65 76 65   cache mode] eve
241e0 6e 20 69 66 20 69 74 20 69 73 20 65 6e 61 62 6c  n if it is enabl
241f0 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66  ed..**.** ^The f
24200 6f 75 72 74 68 20 70 61 72 61 6d 65 74 65 72 20  ourth parameter 
24210 74 6f 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f  to sqlite3_open_
24220 76 32 28 29 20 69 73 20 74 68 65 20 6e 61 6d 65  v2() is the name
24230 20 6f 66 20 74 68 65 0a 2a 2a 20 5b 73 71 6c 69   of the.** [sqli
24240 74 65 33 5f 76 66 73 5d 20 6f 62 6a 65 63 74 20  te3_vfs] object 
24250 74 68 61 74 20 64 65 66 69 6e 65 73 20 74 68 65  that defines the
24260 20 6f 70 65 72 61 74 69 6e 67 20 73 79 73 74 65   operating syste
24270 6d 20 69 6e 74 65 72 66 61 63 65 20 74 68 61 74  m interface that
24280 0a 2a 2a 20 74 68 65 20 6e 65 77 20 64 61 74 61  .** the new data
24290 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20  base connection 
242a0 73 68 6f 75 6c 64 20 75 73 65 2e 20 20 5e 49 66  should use.  ^If
242b0 20 74 68 65 20 66 6f 75 72 74 68 20 70 61 72 61   the fourth para
242c0 6d 65 74 65 72 20 69 73 0a 2a 2a 20 61 20 4e 55  meter is.** a NU
242d0 4c 4c 20 70 6f 69 6e 74 65 72 20 74 68 65 6e 20  LL pointer then 
242e0 74 68 65 20 64 65 66 61 75 6c 74 20 5b 73 71 6c  the default [sql
242f0 69 74 65 33 5f 76 66 73 5d 20 6f 62 6a 65 63 74  ite3_vfs] object
24300 20 69 73 20 75 73 65 64 2e 0a 2a 2a 0a 2a 2a 20   is used..**.** 
24310 5e 49 66 20 74 68 65 20 66 69 6c 65 6e 61 6d 65  ^If the filename
24320 20 69 73 20 22 3a 6d 65 6d 6f 72 79 3a 22 2c 20   is ":memory:", 
24330 74 68 65 6e 20 61 20 70 72 69 76 61 74 65 2c 20  then a private, 
24340 74 65 6d 70 6f 72 61 72 79 20 69 6e 2d 6d 65 6d  temporary in-mem
24350 6f 72 79 20 64 61 74 61 62 61 73 65 0a 2a 2a 20  ory database.** 
24360 69 73 20 63 72 65 61 74 65 64 20 66 6f 72 20 74  is created for t
24370 68 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e 20 20  he connection.  
24380 5e 54 68 69 73 20 69 6e 2d 6d 65 6d 6f 72 79 20  ^This in-memory 
24390 64 61 74 61 62 61 73 65 20 77 69 6c 6c 20 76 61  database will va
243a0 6e 69 73 68 20 77 68 65 6e 0a 2a 2a 20 74 68 65  nish when.** the
243b0 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63   database connec
243c0 74 69 6f 6e 20 69 73 20 63 6c 6f 73 65 64 2e 20  tion is closed. 
243d0 20 46 75 74 75 72 65 20 76 65 72 73 69 6f 6e 73   Future versions
243e0 20 6f 66 20 53 51 4c 69 74 65 20 6d 69 67 68 74   of SQLite might
243f0 0a 2a 2a 20 6d 61 6b 65 20 75 73 65 20 6f 66 20  .** make use of 
24400 61 64 64 69 74 69 6f 6e 61 6c 20 73 70 65 63 69  additional speci
24410 61 6c 20 66 69 6c 65 6e 61 6d 65 73 20 74 68 61  al filenames tha
24420 74 20 62 65 67 69 6e 20 77 69 74 68 20 74 68 65  t begin with the
24430 20 22 3a 22 20 63 68 61 72 61 63 74 65 72 2e 0a   ":" character..
24440 2a 2a 20 49 74 20 69 73 20 72 65 63 6f 6d 6d 65  ** It is recomme
24450 6e 64 65 64 20 74 68 61 74 20 77 68 65 6e 20 61  nded that when a
24460 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 6e 61   database filena
24470 6d 65 20 61 63 74 75 61 6c 6c 79 20 64 6f 65 73  me actually does
24480 20 62 65 67 69 6e 20 77 69 74 68 0a 2a 2a 20 61   begin with.** a
24490 20 22 3a 22 20 63 68 61 72 61 63 74 65 72 20 79   ":" character y
244a0 6f 75 20 73 68 6f 75 6c 64 20 70 72 65 66 69 78  ou should prefix
244b0 20 74 68 65 20 66 69 6c 65 6e 61 6d 65 20 77 69   the filename wi
244c0 74 68 20 61 20 70 61 74 68 6e 61 6d 65 20 73 75  th a pathname su
244d0 63 68 20 61 73 0a 2a 2a 20 22 2e 2f 22 20 74 6f  ch as.** "./" to
244e0 20 61 76 6f 69 64 20 61 6d 62 69 67 75 69 74 79   avoid ambiguity
244f0 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20  ..**.** ^If the 
24500 66 69 6c 65 6e 61 6d 65 20 69 73 20 61 6e 20 65  filename is an e
24510 6d 70 74 79 20 73 74 72 69 6e 67 2c 20 74 68 65  mpty string, the
24520 6e 20 61 20 70 72 69 76 61 74 65 2c 20 74 65 6d  n a private, tem
24530 70 6f 72 61 72 79 0a 2a 2a 20 6f 6e 2d 64 69 73  porary.** on-dis
24540 6b 20 64 61 74 61 62 61 73 65 20 77 69 6c 6c 20  k database will 
24550 62 65 20 63 72 65 61 74 65 64 2e 20 20 5e 54 68  be created.  ^Th
24560 69 73 20 70 72 69 76 61 74 65 20 64 61 74 61 62  is private datab
24570 61 73 65 20 77 69 6c 6c 20 62 65 0a 2a 2a 20 61  ase will be.** a
24580 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 64 65 6c  utomatically del
24590 65 74 65 64 20 61 73 20 73 6f 6f 6e 20 61 73 20  eted as soon as 
245a0 74 68 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e  the database con
245b0 6e 65 63 74 69 6f 6e 20 69 73 20 63 6c 6f 73 65  nection is close
245c0 64 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 55 52 49 20 66  d..**.** [[URI f
245d0 69 6c 65 6e 61 6d 65 73 20 69 6e 20 73 71 6c 69  ilenames in sqli
245e0 74 65 33 5f 6f 70 65 6e 28 29 5d 5d 20 3c 68 33  te3_open()]] <h3
245f0 3e 55 52 49 20 46 69 6c 65 6e 61 6d 65 73 3c 2f  >URI Filenames</
24600 68 33 3e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 5b 55  h3>.**.** ^If [U
24610 52 49 20 66 69 6c 65 6e 61 6d 65 5d 20 69 6e 74  RI filename] int
24620 65 72 70 72 65 74 61 74 69 6f 6e 20 69 73 20 65  erpretation is e
24630 6e 61 62 6c 65 64 2c 20 61 6e 64 20 74 68 65 20  nabled, and the 
24640 66 69 6c 65 6e 61 6d 65 20 61 72 67 75 6d 65 6e  filename argumen
24650 74 0a 2a 2a 20 62 65 67 69 6e 73 20 77 69 74 68  t.** begins with
24660 20 22 66 69 6c 65 3a 22 2c 20 74 68 65 6e 20 74   "file:", then t
24670 68 65 20 66 69 6c 65 6e 61 6d 65 20 69 73 20 69  he filename is i
24680 6e 74 65 72 70 72 65 74 65 64 20 61 73 20 61 20  nterpreted as a 
24690 55 52 49 2e 20 5e 55 52 49 0a 2a 2a 20 66 69 6c  URI. ^URI.** fil
246a0 65 6e 61 6d 65 20 69 6e 74 65 72 70 72 65 74 61  ename interpreta
246b0 74 69 6f 6e 20 69 73 20 65 6e 61 62 6c 65 64 20  tion is enabled 
246c0 69 66 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 4f  if the [SQLITE_O
246d0 50 45 4e 5f 55 52 49 5d 20 66 6c 61 67 20 69 73  PEN_URI] flag is
246e0 0a 2a 2a 20 73 65 74 20 69 6e 20 74 68 65 20 66  .** set in the f
246f0 6f 75 72 74 68 20 61 72 67 75 6d 65 6e 74 20 74  ourth argument t
24700 6f 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76  o sqlite3_open_v
24710 32 28 29 2c 20 6f 72 20 69 66 20 69 74 20 68 61  2(), or if it ha
24720 73 0a 2a 2a 20 62 65 65 6e 20 65 6e 61 62 6c 65  s.** been enable
24730 64 20 67 6c 6f 62 61 6c 6c 79 20 75 73 69 6e 67  d globally using
24740 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 43 4f 4e   the [SQLITE_CON
24750 46 49 47 5f 55 52 49 5d 20 6f 70 74 69 6f 6e 20  FIG_URI] option 
24760 77 69 74 68 20 74 68 65 0a 2a 2a 20 5b 73 71 6c  with the.** [sql
24770 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d 20 6d  ite3_config()] m
24780 65 74 68 6f 64 20 6f 72 20 62 79 20 74 68 65 20  ethod or by the 
24790 5b 53 51 4c 49 54 45 5f 55 53 45 5f 55 52 49 5d  [SQLITE_USE_URI]
247a0 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70   compile-time op
247b0 74 69 6f 6e 2e 0a 2a 2a 20 41 73 20 6f 66 20 53  tion..** As of S
247c0 51 4c 69 74 65 20 76 65 72 73 69 6f 6e 20 33 2e  QLite version 3.
247d0 37 2e 37 2c 20 55 52 49 20 66 69 6c 65 6e 61 6d  7.7, URI filenam
247e0 65 20 69 6e 74 65 72 70 72 65 74 61 74 69 6f 6e  e interpretation
247f0 20 69 73 20 74 75 72 6e 65 64 20 6f 66 66 0a 2a   is turned off.*
24800 2a 20 62 79 20 64 65 66 61 75 6c 74 2c 20 62 75  * by default, bu
24810 74 20 66 75 74 75 72 65 20 72 65 6c 65 61 73 65  t future release
24820 73 20 6f 66 20 53 51 4c 69 74 65 20 6d 69 67 68  s of SQLite migh
24830 74 20 65 6e 61 62 6c 65 20 55 52 49 20 66 69 6c  t enable URI fil
24840 65 6e 61 6d 65 0a 2a 2a 20 69 6e 74 65 72 70 72  ename.** interpr
24850 65 74 61 74 69 6f 6e 20 62 79 20 64 65 66 61 75  etation by defau
24860 6c 74 2e 20 20 53 65 65 20 22 5b 55 52 49 20 66  lt.  See "[URI f
24870 69 6c 65 6e 61 6d 65 73 5d 22 20 66 6f 72 20 61  ilenames]" for a
24880 64 64 69 74 69 6f 6e 61 6c 0a 2a 2a 20 69 6e 66  dditional.** inf
24890 6f 72 6d 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20  ormation..**.** 
248a0 55 52 49 20 66 69 6c 65 6e 61 6d 65 73 20 61 72  URI filenames ar
248b0 65 20 70 61 72 73 65 64 20 61 63 63 6f 72 64 69  e parsed accordi
248c0 6e 67 20 74 6f 20 52 46 43 20 33 39 38 36 2e 20  ng to RFC 3986. 
248d0 5e 49 66 20 74 68 65 20 55 52 49 20 63 6f 6e 74  ^If the URI cont
248e0 61 69 6e 73 20 61 6e 0a 2a 2a 20 61 75 74 68 6f  ains an.** autho
248f0 72 69 74 79 2c 20 74 68 65 6e 20 69 74 20 6d 75  rity, then it mu
24900 73 74 20 62 65 20 65 69 74 68 65 72 20 61 6e 20  st be either an 
24910 65 6d 70 74 79 20 73 74 72 69 6e 67 20 6f 72 20  empty string or 
24920 74 68 65 20 73 74 72 69 6e 67 20 0a 2a 2a 20 22  the string .** "
24930 6c 6f 63 61 6c 68 6f 73 74 22 2e 20 5e 49 66 20  localhost". ^If 
24940 74 68 65 20 61 75 74 68 6f 72 69 74 79 20 69 73  the authority is
24950 20 6e 6f 74 20 61 6e 20 65 6d 70 74 79 20 73 74   not an empty st
24960 72 69 6e 67 20 6f 72 20 22 6c 6f 63 61 6c 68 6f  ring or "localho
24970 73 74 22 2c 20 61 6e 20 0a 2a 2a 20 65 72 72 6f  st", an .** erro
24980 72 20 69 73 20 72 65 74 75 72 6e 65 64 20 74 6f  r is returned to
24990 20 74 68 65 20 63 61 6c 6c 65 72 2e 20 5e 54 68   the caller. ^Th
249a0 65 20 66 72 61 67 6d 65 6e 74 20 63 6f 6d 70 6f  e fragment compo
249b0 6e 65 6e 74 20 6f 66 20 61 20 55 52 49 2c 20 69  nent of a URI, i
249c0 66 20 0a 2a 2a 20 70 72 65 73 65 6e 74 2c 20 69  f .** present, i
249d0 73 20 69 67 6e 6f 72 65 64 2e 0a 2a 2a 0a 2a 2a  s ignored..**.**
249e0 20 5e 53 51 4c 69 74 65 20 75 73 65 73 20 74 68   ^SQLite uses th
249f0 65 20 70 61 74 68 20 63 6f 6d 70 6f 6e 65 6e 74  e path component
24a00 20 6f 66 20 74 68 65 20 55 52 49 20 61 73 20 74   of the URI as t
24a10 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 64  he name of the d
24a20 69 73 6b 20 66 69 6c 65 0a 2a 2a 20 77 68 69 63  isk file.** whic
24a30 68 20 63 6f 6e 74 61 69 6e 73 20 74 68 65 20 64  h contains the d
24a40 61 74 61 62 61 73 65 2e 20 5e 49 66 20 74 68 65  atabase. ^If the
24a50 20 70 61 74 68 20 62 65 67 69 6e 73 20 77 69 74   path begins wit
24a60 68 20 61 20 27 2f 27 20 63 68 61 72 61 63 74 65  h a '/' characte
24a70 72 2c 20 0a 2a 2a 20 74 68 65 6e 20 69 74 20 69  r, .** then it i
24a80 73 20 69 6e 74 65 72 70 72 65 74 65 64 20 61 73  s interpreted as
24a90 20 61 6e 20 61 62 73 6f 6c 75 74 65 20 70 61 74   an absolute pat
24aa0 68 2e 20 5e 49 66 20 74 68 65 20 70 61 74 68 20  h. ^If the path 
24ab0 64 6f 65 73 20 6e 6f 74 20 62 65 67 69 6e 20 0a  does not begin .
24ac0 2a 2a 20 77 69 74 68 20 61 20 27 2f 27 20 28 6d  ** with a '/' (m
24ad0 65 61 6e 69 6e 67 20 74 68 61 74 20 74 68 65 20  eaning that the 
24ae0 61 75 74 68 6f 72 69 74 79 20 73 65 63 74 69 6f  authority sectio
24af0 6e 20 69 73 20 6f 6d 69 74 74 65 64 20 66 72 6f  n is omitted fro
24b00 6d 20 74 68 65 20 55 52 49 29 0a 2a 2a 20 74 68  m the URI).** th
24b10 65 6e 20 74 68 65 20 70 61 74 68 20 69 73 20 69  en the path is i
24b20 6e 74 65 72 70 72 65 74 65 64 20 61 73 20 61 20  nterpreted as a 
24b30 72 65 6c 61 74 69 76 65 20 70 61 74 68 2e 20 0a  relative path. .
24b40 2a 2a 20 5e 28 4f 6e 20 77 69 6e 64 6f 77 73 2c  ** ^(On windows,
24b50 20 74 68 65 20 66 69 72 73 74 20 63 6f 6d 70 6f   the first compo
24b60 6e 65 6e 74 20 6f 66 20 61 6e 20 61 62 73 6f 6c  nent of an absol
24b70 75 74 65 20 70 61 74 68 20 0a 2a 2a 20 69 73 20  ute path .** is 
24b80 61 20 64 72 69 76 65 20 73 70 65 63 69 66 69 63  a drive specific
24b90 61 74 69 6f 6e 20 28 65 2e 67 2e 20 22 43 3a 22  ation (e.g. "C:"
24ba0 29 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 63 6f 72  ).)^.**.** [[cor
24bb0 65 20 55 52 49 20 71 75 65 72 79 20 70 61 72 61  e URI query para
24bc0 6d 65 74 65 72 73 5d 5d 0a 2a 2a 20 54 68 65 20  meters]].** The 
24bd0 71 75 65 72 79 20 63 6f 6d 70 6f 6e 65 6e 74 20  query component 
24be0 6f 66 20 61 20 55 52 49 20 6d 61 79 20 63 6f 6e  of a URI may con
24bf0 74 61 69 6e 20 70 61 72 61 6d 65 74 65 72 73 20  tain parameters 
24c00 74 68 61 74 20 61 72 65 20 69 6e 74 65 72 70 72  that are interpr
24c10 65 74 65 64 0a 2a 2a 20 65 69 74 68 65 72 20 62  eted.** either b
24c20 79 20 53 51 4c 69 74 65 20 69 74 73 65 6c 66 2c  y SQLite itself,
24c30 20 6f 72 20 62 79 20 61 20 5b 56 46 53 20 7c 20   or by a [VFS | 
24c40 63 75 73 74 6f 6d 20 56 46 53 20 69 6d 70 6c 65  custom VFS imple
24c50 6d 65 6e 74 61 74 69 6f 6e 5d 2e 0a 2a 2a 20 53  mentation]..** S
24c60 51 4c 69 74 65 20 61 6e 64 20 69 74 73 20 62 75  QLite and its bu
24c70 69 6c 74 2d 69 6e 20 5b 56 46 53 65 73 5d 20 69  ilt-in [VFSes] i
24c80 6e 74 65 72 70 72 65 74 20 74 68 65 0a 2a 2a 20  nterpret the.** 
24c90 66 6f 6c 6c 6f 77 69 6e 67 20 71 75 65 72 79 20  following query 
24ca0 70 61 72 61 6d 65 74 65 72 73 3a 0a 2a 2a 0a 2a  parameters:.**.*
24cb0 2a 20 3c 75 6c 3e 0a 2a 2a 20 20 20 3c 6c 69 3e  * <ul>.**   <li>
24cc0 20 3c 62 3e 76 66 73 3c 2f 62 3e 3a 20 5e 54 68   <b>vfs</b>: ^Th
24cd0 65 20 22 76 66 73 22 20 70 61 72 61 6d 65 74 65  e "vfs" paramete
24ce0 72 20 6d 61 79 20 62 65 20 75 73 65 64 20 74 6f  r may be used to
24cf0 20 73 70 65 63 69 66 79 20 74 68 65 20 6e 61 6d   specify the nam
24d00 65 20 6f 66 0a 2a 2a 20 20 20 20 20 61 20 56 46  e of.**     a VF
24d10 53 20 6f 62 6a 65 63 74 20 74 68 61 74 20 70 72  S object that pr
24d20 6f 76 69 64 65 73 20 74 68 65 20 6f 70 65 72 61  ovides the opera
24d30 74 69 6e 67 20 73 79 73 74 65 6d 20 69 6e 74 65  ting system inte
24d40 72 66 61 63 65 20 74 68 61 74 20 73 68 6f 75 6c  rface that shoul
24d50 64 0a 2a 2a 20 20 20 20 20 62 65 20 75 73 65 64  d.**     be used
24d60 20 74 6f 20 61 63 63 65 73 73 20 74 68 65 20 64   to access the d
24d70 61 74 61 62 61 73 65 20 66 69 6c 65 20 6f 6e 20  atabase file on 
24d80 64 69 73 6b 2e 20 5e 49 66 20 74 68 69 73 20 6f  disk. ^If this o
24d90 70 74 69 6f 6e 20 69 73 20 73 65 74 20 74 6f 0a  ption is set to.
24da0 2a 2a 20 20 20 20 20 61 6e 20 65 6d 70 74 79 20  **     an empty 
24db0 73 74 72 69 6e 67 20 74 68 65 20 64 65 66 61 75  string the defau
24dc0 6c 74 20 56 46 53 20 6f 62 6a 65 63 74 20 69 73  lt VFS object is
24dd0 20 75 73 65 64 2e 20 5e 53 70 65 63 69 66 79 69   used. ^Specifyi
24de0 6e 67 20 61 6e 20 75 6e 6b 6e 6f 77 6e 0a 2a 2a  ng an unknown.**
24df0 20 20 20 20 20 56 46 53 20 69 73 20 61 6e 20 65       VFS is an e
24e00 72 72 6f 72 2e 20 5e 49 66 20 73 71 6c 69 74 65  rror. ^If sqlite
24e10 33 5f 6f 70 65 6e 5f 76 32 28 29 20 69 73 20 75  3_open_v2() is u
24e20 73 65 64 20 61 6e 64 20 74 68 65 20 76 66 73 20  sed and the vfs 
24e30 6f 70 74 69 6f 6e 20 69 73 0a 2a 2a 20 20 20 20  option is.**    
24e40 20 70 72 65 73 65 6e 74 2c 20 74 68 65 6e 20 74   present, then t
24e50 68 65 20 56 46 53 20 73 70 65 63 69 66 69 65 64  he VFS specified
24e60 20 62 79 20 74 68 65 20 6f 70 74 69 6f 6e 20 74   by the option t
24e70 61 6b 65 73 20 70 72 65 63 65 64 65 6e 63 65 20  akes precedence 
24e80 6f 76 65 72 0a 2a 2a 20 20 20 20 20 74 68 65 20  over.**     the 
24e90 76 61 6c 75 65 20 70 61 73 73 65 64 20 61 73 20  value passed as 
24ea0 74 68 65 20 66 6f 75 72 74 68 20 70 61 72 61 6d  the fourth param
24eb0 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f  eter to sqlite3_
24ec0 6f 70 65 6e 5f 76 32 28 29 2e 0a 2a 2a 0a 2a 2a  open_v2()..**.**
24ed0 20 20 20 3c 6c 69 3e 20 3c 62 3e 6d 6f 64 65 3c     <li> <b>mode<
24ee0 2f 62 3e 3a 20 5e 28 54 68 65 20 6d 6f 64 65 20  /b>: ^(The mode 
24ef0 70 61 72 61 6d 65 74 65 72 20 6d 61 79 20 62 65  parameter may be
24f00 20 73 65 74 20 74 6f 20 65 69 74 68 65 72 20 22   set to either "
24f10 72 6f 22 2c 20 22 72 77 22 2c 0a 2a 2a 20 20 20  ro", "rw",.**   
24f20 20 20 22 72 77 63 22 2c 20 6f 72 20 22 6d 65 6d    "rwc", or "mem
24f30 6f 72 79 22 2e 20 41 74 74 65 6d 70 74 69 6e 67  ory". Attempting
24f40 20 74 6f 20 73 65 74 20 69 74 20 74 6f 20 61 6e   to set it to an
24f50 79 20 6f 74 68 65 72 20 76 61 6c 75 65 20 69 73  y other value is
24f60 0a 2a 2a 20 20 20 20 20 61 6e 20 65 72 72 6f 72  .**     an error
24f70 29 5e 2e 20 0a 2a 2a 20 20 20 20 20 5e 49 66 20  )^. .**     ^If 
24f80 22 72 6f 22 20 69 73 20 73 70 65 63 69 66 69 65  "ro" is specifie
24f90 64 2c 20 74 68 65 6e 20 74 68 65 20 64 61 74 61  d, then the data
24fa0 62 61 73 65 20 69 73 20 6f 70 65 6e 65 64 20 66  base is opened f
24fb0 6f 72 20 72 65 61 64 2d 6f 6e 6c 79 20 0a 2a 2a  or read-only .**
24fc0 20 20 20 20 20 61 63 63 65 73 73 2c 20 6a 75 73       access, jus
24fd0 74 20 61 73 20 69 66 20 74 68 65 20 5b 53 51 4c  t as if the [SQL
24fe0 49 54 45 5f 4f 50 45 4e 5f 52 45 41 44 4f 4e 4c  ITE_OPEN_READONL
24ff0 59 5d 20 66 6c 61 67 20 68 61 64 20 62 65 65 6e  Y] flag had been
25000 20 73 65 74 20 69 6e 20 74 68 65 20 0a 2a 2a 20   set in the .** 
25010 20 20 20 20 74 68 69 72 64 20 61 72 67 75 6d 65      third argume
25020 6e 74 20 74 6f 20 73 71 6c 69 74 65 33 5f 6f 70  nt to sqlite3_op
25030 65 6e 5f 76 32 28 29 2e 20 5e 49 66 20 74 68 65  en_v2(). ^If the
25040 20 6d 6f 64 65 20 6f 70 74 69 6f 6e 20 69 73 20   mode option is 
25050 73 65 74 20 74 6f 20 0a 2a 2a 20 20 20 20 20 22  set to .**     "
25060 72 77 22 2c 20 74 68 65 6e 20 74 68 65 20 64 61  rw", then the da
25070 74 61 62 61 73 65 20 69 73 20 6f 70 65 6e 65 64  tabase is opened
25080 20 66 6f 72 20 72 65 61 64 2d 77 72 69 74 65 20   for read-write 
25090 28 62 75 74 20 6e 6f 74 20 63 72 65 61 74 65 29  (but not create)
250a0 20 0a 2a 2a 20 20 20 20 20 61 63 63 65 73 73 2c   .**     access,
250b0 20 61 73 20 69 66 20 53 51 4c 49 54 45 5f 4f 50   as if SQLITE_OP
250c0 45 4e 5f 52 45 41 44 57 52 49 54 45 20 28 62 75  EN_READWRITE (bu
250d0 74 20 6e 6f 74 20 53 51 4c 49 54 45 5f 4f 50 45  t not SQLITE_OPE
250e0 4e 5f 43 52 45 41 54 45 29 20 68 61 64 20 0a 2a  N_CREATE) had .*
250f0 2a 20 20 20 20 20 62 65 65 6e 20 73 65 74 2e 20  *     been set. 
25100 5e 56 61 6c 75 65 20 22 72 77 63 22 20 69 73 20  ^Value "rwc" is 
25110 65 71 75 69 76 61 6c 65 6e 74 20 74 6f 20 73 65  equivalent to se
25120 74 74 69 6e 67 20 62 6f 74 68 20 0a 2a 2a 20 20  tting both .**  
25130 20 20 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 52     SQLITE_OPEN_R
25140 45 41 44 57 52 49 54 45 20 61 6e 64 20 53 51 4c  EADWRITE and SQL
25150 49 54 45 5f 4f 50 45 4e 5f 43 52 45 41 54 45 2e  ITE_OPEN_CREATE.
25160 20 20 5e 49 66 20 74 68 65 20 6d 6f 64 65 20 6f    ^If the mode o
25170 70 74 69 6f 6e 20 69 73 0a 2a 2a 20 20 20 20 20  ption is.**     
25180 73 65 74 20 74 6f 20 22 6d 65 6d 6f 72 79 22 20  set to "memory" 
25190 74 68 65 6e 20 61 20 70 75 72 65 20 5b 69 6e 2d  then a pure [in-
251a0 6d 65 6d 6f 72 79 20 64 61 74 61 62 61 73 65 5d  memory database]
251b0 20 74 68 61 74 20 6e 65 76 65 72 20 72 65 61 64   that never read
251c0 73 0a 2a 2a 20 20 20 20 20 6f 72 20 77 72 69 74  s.**     or writ
251d0 65 73 20 66 72 6f 6d 20 64 69 73 6b 20 69 73 20  es from disk is 
251e0 75 73 65 64 2e 20 5e 49 74 20 69 73 20 61 6e 20  used. ^It is an 
251f0 65 72 72 6f 72 20 74 6f 20 73 70 65 63 69 66 79  error to specify
25200 20 61 20 76 61 6c 75 65 20 66 6f 72 0a 2a 2a 20   a value for.** 
25210 20 20 20 20 74 68 65 20 6d 6f 64 65 20 70 61 72      the mode par
25220 61 6d 65 74 65 72 20 74 68 61 74 20 69 73 20 6c  ameter that is l
25230 65 73 73 20 72 65 73 74 72 69 63 74 69 76 65 20  ess restrictive 
25240 74 68 61 6e 20 74 68 61 74 20 73 70 65 63 69 66  than that specif
25250 69 65 64 20 62 79 0a 2a 2a 20 20 20 20 20 74 68  ied by.**     th
25260 65 20 66 6c 61 67 73 20 70 61 73 73 65 64 20 69  e flags passed i
25270 6e 20 74 68 65 20 74 68 69 72 64 20 70 61 72 61  n the third para
25280 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33  meter to sqlite3
25290 5f 6f 70 65 6e 5f 76 32 28 29 2e 0a 2a 2a 0a 2a  _open_v2()..**.*
252a0 2a 20 20 20 3c 6c 69 3e 20 3c 62 3e 63 61 63 68  *   <li> <b>cach
252b0 65 3c 2f 62 3e 3a 20 5e 54 68 65 20 63 61 63 68  e</b>: ^The cach
252c0 65 20 70 61 72 61 6d 65 74 65 72 20 6d 61 79 20  e parameter may 
252d0 62 65 20 73 65 74 20 74 6f 20 65 69 74 68 65 72  be set to either
252e0 20 22 73 68 61 72 65 64 22 20 6f 72 0a 2a 2a 20   "shared" or.** 
252f0 20 20 20 20 22 70 72 69 76 61 74 65 22 2e 20 5e      "private". ^
25300 53 65 74 74 69 6e 67 20 69 74 20 74 6f 20 22 73  Setting it to "s
25310 68 61 72 65 64 22 20 69 73 20 65 71 75 69 76 61  hared" is equiva
25320 6c 65 6e 74 20 74 6f 20 73 65 74 74 69 6e 67 20  lent to setting 
25330 74 68 65 0a 2a 2a 20 20 20 20 20 53 51 4c 49 54  the.**     SQLIT
25340 45 5f 4f 50 45 4e 5f 53 48 41 52 45 44 43 41 43  E_OPEN_SHAREDCAC
25350 48 45 20 62 69 74 20 69 6e 20 74 68 65 20 66 6c  HE bit in the fl
25360 61 67 73 20 61 72 67 75 6d 65 6e 74 20 70 61 73  ags argument pas
25370 73 65 64 20 74 6f 0a 2a 2a 20 20 20 20 20 73 71  sed to.**     sq
25380 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 2e  lite3_open_v2().
25390 20 5e 53 65 74 74 69 6e 67 20 74 68 65 20 63 61   ^Setting the ca
253a0 63 68 65 20 70 61 72 61 6d 65 74 65 72 20 74 6f  che parameter to
253b0 20 22 70 72 69 76 61 74 65 22 20 69 73 20 0a 2a   "private" is .*
253c0 2a 20 20 20 20 20 65 71 75 69 76 61 6c 65 6e 74  *     equivalent
253d0 20 74 6f 20 73 65 74 74 69 6e 67 20 74 68 65 20   to setting the 
253e0 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 50 52 49 56  SQLITE_OPEN_PRIV
253f0 41 54 45 43 41 43 48 45 20 62 69 74 2e 0a 2a 2a  ATECACHE bit..**
25400 20 20 20 20 20 5e 49 66 20 73 71 6c 69 74 65 33       ^If sqlite3
25410 5f 6f 70 65 6e 5f 76 32 28 29 20 69 73 20 75 73  _open_v2() is us
25420 65 64 20 61 6e 64 20 74 68 65 20 22 63 61 63 68  ed and the "cach
25430 65 22 20 70 61 72 61 6d 65 74 65 72 20 69 73 20  e" parameter is 
25440 70 72 65 73 65 6e 74 20 69 6e 0a 2a 2a 20 20 20  present in.**   
25450 20 20 61 20 55 52 49 20 66 69 6c 65 6e 61 6d 65    a URI filename
25460 2c 20 69 74 73 20 76 61 6c 75 65 20 6f 76 65 72  , its value over
25470 72 69 64 65 73 20 61 6e 79 20 62 65 68 61 76 69  rides any behavi
25480 6f 72 20 72 65 71 75 65 73 74 65 64 20 62 79 20  or requested by 
25490 73 65 74 74 69 6e 67 0a 2a 2a 20 20 20 20 20 53  setting.**     S
254a0 51 4c 49 54 45 5f 4f 50 45 4e 5f 50 52 49 56 41  QLITE_OPEN_PRIVA
254b0 54 45 43 41 43 48 45 20 6f 72 20 53 51 4c 49 54  TECACHE or SQLIT
254c0 45 5f 4f 50 45 4e 5f 53 48 41 52 45 44 43 41 43  E_OPEN_SHAREDCAC
254d0 48 45 20 66 6c 61 67 2e 0a 2a 2a 0a 2a 2a 20 20  HE flag..**.**  
254e0 3c 6c 69 3e 20 3c 62 3e 70 73 6f 77 3c 2f 62 3e  <li> <b>psow</b>
254f0 3a 20 5e 54 68 65 20 70 73 6f 77 20 70 61 72 61  : ^The psow para
25500 6d 65 74 65 72 20 69 6e 64 69 63 61 74 65 73 20  meter indicates 
25510 77 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20 74  whether or not t
25520 68 65 0a 2a 2a 20 20 20 20 20 5b 70 6f 77 65 72  he.**     [power
25530 73 61 66 65 20 6f 76 65 72 77 72 69 74 65 5d 20  safe overwrite] 
25540 70 72 6f 70 65 72 74 79 20 64 6f 65 73 20 6f 72  property does or
25550 20 64 6f 65 73 20 6e 6f 74 20 61 70 70 6c 79 20   does not apply 
25560 74 6f 20 74 68 65 0a 2a 2a 20 20 20 20 20 73 74  to the.**     st
25570 6f 72 61 67 65 20 6d 65 64 69 61 20 6f 6e 20 77  orage media on w
25580 68 69 63 68 20 74 68 65 20 64 61 74 61 62 61 73  hich the databas
25590 65 20 66 69 6c 65 20 72 65 73 69 64 65 73 2e 0a  e file resides..
255a0 2a 2a 0a 2a 2a 20 20 3c 6c 69 3e 20 3c 62 3e 6e  **.**  <li> <b>n
255b0 6f 6c 6f 63 6b 3c 2f 62 3e 3a 20 5e 54 68 65 20  olock</b>: ^The 
255c0 6e 6f 6c 6f 63 6b 20 70 61 72 61 6d 65 74 65 72  nolock parameter
255d0 20 69 73 20 61 20 62 6f 6f 6c 65 61 6e 20 71 75   is a boolean qu
255e0 65 72 79 20 70 61 72 61 6d 65 74 65 72 0a 2a 2a  ery parameter.**
255f0 20 20 20 20 20 77 68 69 63 68 20 69 66 20 73 65       which if se
25600 74 20 64 69 73 61 62 6c 65 73 20 66 69 6c 65 20  t disables file 
25610 6c 6f 63 6b 69 6e 67 20 69 6e 20 72 6f 6c 6c 62  locking in rollb
25620 61 63 6b 20 6a 6f 75 72 6e 61 6c 20 6d 6f 64 65  ack journal mode
25630 73 2e 20 20 54 68 69 73 0a 2a 2a 20 20 20 20 20  s.  This.**     
25640 69 73 20 75 73 65 66 75 6c 20 66 6f 72 20 61 63  is useful for ac
25650 63 65 73 73 69 6e 67 20 61 20 64 61 74 61 62 61  cessing a databa
25660 73 65 20 6f 6e 20 61 20 66 69 6c 65 73 79 73 74  se on a filesyst
25670 65 6d 20 74 68 61 74 20 64 6f 65 73 20 6e 6f 74  em that does not
25680 0a 2a 2a 20 20 20 20 20 73 75 70 70 6f 72 74 20  .**     support 
25690 6c 6f 63 6b 69 6e 67 2e 20 20 43 61 75 74 69 6f  locking.  Cautio
256a0 6e 3a 20 20 44 61 74 61 62 61 73 65 20 63 6f 72  n:  Database cor
256b0 72 75 70 74 69 6f 6e 20 6d 69 67 68 74 20 72 65  ruption might re
256c0 73 75 6c 74 20 69 66 20 74 77 6f 0a 2a 2a 20 20  sult if two.**  
256d0 20 20 20 6f 72 20 6d 6f 72 65 20 70 72 6f 63 65     or more proce
256e0 73 73 65 73 20 77 72 69 74 65 20 74 6f 20 74 68  sses write to th
256f0 65 20 73 61 6d 65 20 64 61 74 61 62 61 73 65 20  e same database 
25700 61 6e 64 20 61 6e 79 20 6f 6e 65 20 6f 66 20 74  and any one of t
25710 68 6f 73 65 0a 2a 2a 20 20 20 20 20 70 72 6f 63  hose.**     proc
25720 65 73 73 65 73 20 75 73 65 73 20 6e 6f 6c 6f 63  esses uses noloc
25730 6b 3d 31 2e 0a 2a 2a 0a 2a 2a 20 20 3c 6c 69 3e  k=1..**.**  <li>
25740 20 3c 62 3e 69 6d 6d 75 74 61 62 6c 65 3c 2f 62   <b>immutable</b
25750 3e 3a 20 5e 54 68 65 20 69 6d 6d 75 74 61 62 6c  >: ^The immutabl
25760 65 20 70 61 72 61 6d 65 74 65 72 20 69 73 20 61  e parameter is a
25770 20 62 6f 6f 6c 65 61 6e 20 71 75 65 72 79 0a 2a   boolean query.*
25780 2a 20 20 20 20 20 70 61 72 61 6d 65 74 65 72 20  *     parameter 
25790 74 68 61 74 20 69 6e 64 69 63 61 74 65 73 20 74  that indicates t
257a0 68 61 74 20 74 68 65 20 64 61 74 61 62 61 73 65  hat the database
257b0 20 66 69 6c 65 20 69 73 20 73 74 6f 72 65 64 20   file is stored 
257c0 6f 6e 0a 2a 2a 20 20 20 20 20 72 65 61 64 2d 6f  on.**     read-o
257d0 6e 6c 79 20 6d 65 64 69 61 2e 20 20 5e 57 68 65  nly media.  ^Whe
257e0 6e 20 69 6d 6d 75 74 61 62 6c 65 20 69 73 20 73  n immutable is s
257f0 65 74 2c 20 53 51 4c 69 74 65 20 61 73 73 75 6d  et, SQLite assum
25800 65 73 20 74 68 61 74 20 74 68 65 0a 2a 2a 20 20  es that the.**  
25810 20 20 20 64 61 74 61 62 61 73 65 20 66 69 6c 65     database file
25820 20 63 61 6e 6e 6f 74 20 62 65 20 63 68 61 6e 67   cannot be chang
25830 65 64 2c 20 65 76 65 6e 20 62 79 20 61 20 70 72  ed, even by a pr
25840 6f 63 65 73 73 20 77 69 74 68 20 68 69 67 68 65  ocess with highe
25850 72 0a 2a 2a 20 20 20 20 20 70 72 69 76 69 6c 65  r.**     privile
25860 67 65 2c 20 61 6e 64 20 73 6f 20 74 68 65 20 64  ge, and so the d
25870 61 74 61 62 61 73 65 20 69 73 20 6f 70 65 6e 65  atabase is opene
25880 64 20 72 65 61 64 2d 6f 6e 6c 79 20 61 6e 64 20  d read-only and 
25890 61 6c 6c 20 6c 6f 63 6b 69 6e 67 0a 2a 2a 20 20  all locking.**  
258a0 20 20 20 61 6e 64 20 63 68 61 6e 67 65 20 64 65     and change de
258b0 74 65 63 74 69 6f 6e 20 69 73 20 64 69 73 61 62  tection is disab
258c0 6c 65 64 2e 20 20 43 61 75 74 69 6f 6e 3a 20 53  led.  Caution: S
258d0 65 74 74 69 6e 67 20 74 68 65 20 69 6d 6d 75 74  etting the immut
258e0 61 62 6c 65 0a 2a 2a 20 20 20 20 20 70 72 6f 70  able.**     prop
258f0 65 72 74 79 20 6f 6e 20 61 20 64 61 74 61 62 61  erty on a databa
25900 73 65 20 66 69 6c 65 20 74 68 61 74 20 64 6f 65  se file that doe
25910 73 20 69 6e 20 66 61 63 74 20 63 68 61 6e 67 65  s in fact change
25920 20 63 61 6e 20 72 65 73 75 6c 74 0a 2a 2a 20 20   can result.**  
25930 20 20 20 69 6e 20 69 6e 63 6f 72 72 65 63 74 20     in incorrect 
25940 71 75 65 72 79 20 72 65 73 75 6c 74 73 20 61 6e  query results an
25950 64 2f 6f 72 20 5b 53 51 4c 49 54 45 5f 43 4f 52  d/or [SQLITE_COR
25960 52 55 50 54 5d 20 65 72 72 6f 72 73 2e 0a 2a 2a  RUPT] errors..**
25970 20 20 20 20 20 53 65 65 20 61 6c 73 6f 3a 20 5b       See also: [
25980 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 49 4d 4d  SQLITE_IOCAP_IMM
25990 55 54 41 42 4c 45 5d 2e 0a 2a 2a 20 20 20 20 20  UTABLE]..**     
259a0 20 20 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 0a 2a    .** </ul>.**.*
259b0 2a 20 5e 53 70 65 63 69 66 79 69 6e 67 20 61 6e  * ^Specifying an
259c0 20 75 6e 6b 6e 6f 77 6e 20 70 61 72 61 6d 65 74   unknown paramet
259d0 65 72 20 69 6e 20 74 68 65 20 71 75 65 72 79 20  er in the query 
259e0 63 6f 6d 70 6f 6e 65 6e 74 20 6f 66 20 61 20 55  component of a U
259f0 52 49 20 69 73 20 6e 6f 74 20 61 6e 0a 2a 2a 20  RI is not an.** 
25a00 65 72 72 6f 72 2e 20 20 46 75 74 75 72 65 20 76  error.  Future v
25a10 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74  ersions of SQLit
25a20 65 20 6d 69 67 68 74 20 75 6e 64 65 72 73 74 61  e might understa
25a30 6e 64 20 61 64 64 69 74 69 6f 6e 61 6c 20 71 75  nd additional qu
25a40 65 72 79 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72  ery.** parameter
25a50 73 2e 20 20 53 65 65 20 22 5b 71 75 65 72 79 20  s.  See "[query 
25a60 70 61 72 61 6d 65 74 65 72 73 20 77 69 74 68 20  parameters with 
25a70 73 70 65 63 69 61 6c 20 6d 65 61 6e 69 6e 67 20  special meaning 
25a80 74 6f 20 53 51 4c 69 74 65 5d 22 20 66 6f 72 0a  to SQLite]" for.
25a90 2a 2a 20 61 64 64 69 74 69 6f 6e 61 6c 20 69 6e  ** additional in
25aa0 66 6f 72 6d 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a  formation..**.**
25ab0 20 5b 5b 55 52 49 20 66 69 6c 65 6e 61 6d 65 20   [[URI filename 
25ac0 65 78 61 6d 70 6c 65 73 5d 5d 20 3c 68 33 3e 55  examples]] <h3>U
25ad0 52 49 20 66 69 6c 65 6e 61 6d 65 20 65 78 61 6d  RI filename exam
25ae0 70 6c 65 73 3c 2f 68 33 3e 0a 2a 2a 0a 2a 2a 20  ples</h3>.**.** 
25af0 3c 74 61 62 6c 65 20 62 6f 72 64 65 72 3d 22 31  <table border="1
25b00 22 20 61 6c 69 67 6e 3d 63 65 6e 74 65 72 20 63  " align=center c
25b10 65 6c 6c 70 61 64 64 69 6e 67 3d 35 3e 0a 2a 2a  ellpadding=5>.**
25b20 20 3c 74 72 3e 3c 74 68 3e 20 55 52 49 20 66 69   <tr><th> URI fi
25b30 6c 65 6e 61 6d 65 73 20 3c 74 68 3e 20 52 65 73  lenames <th> Res
25b40 75 6c 74 73 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e  ults.** <tr><td>
25b50 20 66 69 6c 65 3a 64 61 74 61 2e 64 62 20 3c 74   file:data.db <t
25b60 64 3e 20 0a 2a 2a 20 20 20 20 20 20 20 20 20 20  d> .**          
25b70 4f 70 65 6e 20 74 68 65 20 66 69 6c 65 20 22 64  Open the file "d
25b80 61 74 61 2e 64 62 22 20 69 6e 20 74 68 65 20 63  ata.db" in the c
25b90 75 72 72 65 6e 74 20 64 69 72 65 63 74 6f 72 79  urrent directory
25ba0 2e 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 66 69  ..** <tr><td> fi
25bb0 6c 65 3a 2f 68 6f 6d 65 2f 66 72 65 64 2f 64 61  le:/home/fred/da
25bc0 74 61 2e 64 62 3c 62 72 3e 0a 2a 2a 20 20 20 20  ta.db<br>.**    
25bd0 20 20 20 20 20 20 66 69 6c 65 3a 2f 2f 2f 68 6f        file:///ho
25be0 6d 65 2f 66 72 65 64 2f 64 61 74 61 2e 64 62 20  me/fred/data.db 
25bf0 3c 62 72 3e 20 0a 2a 2a 20 20 20 20 20 20 20 20  <br> .**        
25c00 20 20 66 69 6c 65 3a 2f 2f 6c 6f 63 61 6c 68 6f    file://localho
25c10 73 74 2f 68 6f 6d 65 2f 66 72 65 64 2f 64 61 74  st/home/fred/dat
25c20 61 2e 64 62 20 3c 62 72 3e 20 3c 74 64 3e 20 0a  a.db <br> <td> .
25c30 2a 2a 20 20 20 20 20 20 20 20 20 20 4f 70 65 6e  **          Open
25c40 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69   the database fi
25c50 6c 65 20 22 2f 68 6f 6d 65 2f 66 72 65 64 2f 64  le "/home/fred/d
25c60 61 74 61 2e 64 62 22 2e 0a 2a 2a 20 3c 74 72 3e  ata.db"..** <tr>
25c70 3c 74 64 3e 20 66 69 6c 65 3a 2f 2f 64 61 72 6b  <td> file://dark
25c80 73 74 61 72 2f 68 6f 6d 65 2f 66 72 65 64 2f 64  star/home/fred/d
25c90 61 74 61 2e 64 62 20 3c 74 64 3e 20 0a 2a 2a 20  ata.db <td> .** 
25ca0 20 20 20 20 20 20 20 20 20 41 6e 20 65 72 72 6f           An erro
25cb0 72 2e 20 22 64 61 72 6b 73 74 61 72 22 20 69 73  r. "darkstar" is
25cc0 20 6e 6f 74 20 61 20 72 65 63 6f 67 6e 69 7a 65   not a recognize
25cd0 64 20 61 75 74 68 6f 72 69 74 79 2e 0a 2a 2a 20  d authority..** 
25ce0 3c 74 72 3e 3c 74 64 20 73 74 79 6c 65 3d 22 77  <tr><td style="w
25cf0 68 69 74 65 2d 73 70 61 63 65 3a 6e 6f 77 72 61  hite-space:nowra
25d00 70 22 3e 20 0a 2a 2a 20 20 20 20 20 20 20 20 20  p"> .**         
25d10 20 66 69 6c 65 3a 2f 2f 2f 43 3a 2f 44 6f 63 75   file:///C:/Docu
25d20 6d 65 6e 74 73 25 32 30 61 6e 64 25 32 30 53 65  ments%20and%20Se
25d30 74 74 69 6e 67 73 2f 66 72 65 64 2f 44 65 73 6b  ttings/fred/Desk
25d40 74 6f 70 2f 64 61 74 61 2e 64 62 0a 2a 2a 20 20  top/data.db.**  
25d50 20 20 20 3c 74 64 3e 20 57 69 6e 64 6f 77 73 20     <td> Windows 
25d60 6f 6e 6c 79 3a 20 4f 70 65 6e 20 74 68 65 20 66  only: Open the f
25d70 69 6c 65 20 22 64 61 74 61 2e 64 62 22 20 6f 6e  ile "data.db" on
25d80 20 66 72 65 64 27 73 20 64 65 73 6b 74 6f 70 20   fred's desktop 
25d90 6f 6e 20 64 72 69 76 65 0a 2a 2a 20 20 20 20 20  on drive.**     
25da0 20 20 20 20 20 43 3a 2e 20 4e 6f 74 65 20 74 68       C:. Note th
25db0 61 74 20 74 68 65 20 25 32 30 20 65 73 63 61 70  at the %20 escap
25dc0 69 6e 67 20 69 6e 20 74 68 69 73 20 65 78 61 6d  ing in this exam
25dd0 70 6c 65 20 69 73 20 6e 6f 74 20 73 74 72 69 63  ple is not stric
25de0 74 6c 79 20 0a 2a 2a 20 20 20 20 20 20 20 20 20  tly .**         
25df0 20 6e 65 63 65 73 73 61 72 79 20 2d 20 73 70 61   necessary - spa
25e00 63 65 20 63 68 61 72 61 63 74 65 72 73 20 63 61  ce characters ca
25e10 6e 20 62 65 20 75 73 65 64 20 6c 69 74 65 72 61  n be used litera
25e20 6c 6c 79 0a 2a 2a 20 20 20 20 20 20 20 20 20 20  lly.**          
25e30 69 6e 20 55 52 49 20 66 69 6c 65 6e 61 6d 65 73  in URI filenames
25e40 2e 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 66 69  ..** <tr><td> fi
25e50 6c 65 3a 64 61 74 61 2e 64 62 3f 6d 6f 64 65 3d  le:data.db?mode=
25e60 72 6f 26 63 61 63 68 65 3d 70 72 69 76 61 74 65  ro&cache=private
25e70 20 3c 74 64 3e 20 0a 2a 2a 20 20 20 20 20 20 20   <td> .**       
25e80 20 20 20 4f 70 65 6e 20 66 69 6c 65 20 22 64 61     Open file "da
25e90 74 61 2e 64 62 22 20 69 6e 20 74 68 65 20 63 75  ta.db" in the cu
25ea0 72 72 65 6e 74 20 64 69 72 65 63 74 6f 72 79 20  rrent directory 
25eb0 66 6f 72 20 72 65 61 64 2d 6f 6e 6c 79 20 61 63  for read-only ac
25ec0 63 65 73 73 2e 0a 2a 2a 20 20 20 20 20 20 20 20  cess..**        
25ed0 20 20 52 65 67 61 72 64 6c 65 73 73 20 6f 66 20    Regardless of 
25ee0 77 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20 73  whether or not s
25ef0 68 61 72 65 64 2d 63 61 63 68 65 20 6d 6f 64 65  hared-cache mode
25f00 20 69 73 20 65 6e 61 62 6c 65 64 20 62 79 0a 2a   is enabled by.*
25f10 2a 20 20 20 20 20 20 20 20 20 20 64 65 66 61 75  *          defau
25f20 6c 74 2c 20 75 73 65 20 61 20 70 72 69 76 61 74  lt, use a privat
25f30 65 20 63 61 63 68 65 2e 0a 2a 2a 20 3c 74 72 3e  e cache..** <tr>
25f40 3c 74 64 3e 20 66 69 6c 65 3a 2f 68 6f 6d 65 2f  <td> file:/home/
25f50 66 72 65 64 2f 64 61 74 61 2e 64 62 3f 76 66 73  fred/data.db?vfs
25f60 3d 75 6e 69 78 2d 64 6f 74 66 69 6c 65 20 3c 74  =unix-dotfile <t
25f70 64 3e 0a 2a 2a 20 20 20 20 20 20 20 20 20 20 4f  d>.**          O
25f80 70 65 6e 20 66 69 6c 65 20 22 2f 68 6f 6d 65 2f  pen file "/home/
25f90 66 72 65 64 2f 64 61 74 61 2e 64 62 22 2e 20 55  fred/data.db". U
25fa0 73 65 20 74 68 65 20 73 70 65 63 69 61 6c 20 56  se the special V
25fb0 46 53 20 22 75 6e 69 78 2d 64 6f 74 66 69 6c 65  FS "unix-dotfile
25fc0 22 0a 2a 2a 20 20 20 20 20 20 20 20 20 20 74 68  ".**          th
25fd0 61 74 20 75 73 65 73 20 64 6f 74 2d 66 69 6c 65  at uses dot-file
25fe0 73 20 69 6e 20 70 6c 61 63 65 20 6f 66 20 70 6f  s in place of po
25ff0 73 69 78 20 61 64 76 69 73 6f 72 79 20 6c 6f 63  six advisory loc
26000 6b 69 6e 67 2e 0a 2a 2a 20 3c 74 72 3e 3c 74 64  king..** <tr><td
26010 3e 20 66 69 6c 65 3a 64 61 74 61 2e 64 62 3f 6d  > file:data.db?m
26020 6f 64 65 3d 72 65 61 64 6f 6e 6c 79 20 3c 74 64  ode=readonly <td
26030 3e 20 0a 2a 2a 20 20 20 20 20 20 20 20 20 20 41  > .**          A
26040 6e 20 65 72 72 6f 72 2e 20 22 72 65 61 64 6f 6e  n error. "readon
26050 6c 79 22 20 69 73 20 6e 6f 74 20 61 20 76 61 6c  ly" is not a val
26060 69 64 20 6f 70 74 69 6f 6e 20 66 6f 72 20 74 68  id option for th
26070 65 20 22 6d 6f 64 65 22 20 70 61 72 61 6d 65 74  e "mode" paramet
26080 65 72 2e 0a 2a 2a 20 3c 2f 74 61 62 6c 65 3e 0a  er..** </table>.
26090 2a 2a 0a 2a 2a 20 5e 55 52 49 20 68 65 78 61 64  **.** ^URI hexad
260a0 65 63 69 6d 61 6c 20 65 73 63 61 70 65 20 73 65  ecimal escape se
260b0 71 75 65 6e 63 65 73 20 28 25 48 48 29 20 61 72  quences (%HH) ar
260c0 65 20 73 75 70 70 6f 72 74 65 64 20 77 69 74 68  e supported with
260d0 69 6e 20 74 68 65 20 70 61 74 68 20 61 6e 64 0a  in the path and.
260e0 2a 2a 20 71 75 65 72 79 20 63 6f 6d 70 6f 6e 65  ** query compone
260f0 6e 74 73 20 6f 66 20 61 20 55 52 49 2e 20 41 20  nts of a URI. A 
26100 68 65 78 61 64 65 63 69 6d 61 6c 20 65 73 63 61  hexadecimal esca
26110 70 65 20 73 65 71 75 65 6e 63 65 20 63 6f 6e 73  pe sequence cons
26120 69 73 74 73 20 6f 66 20 61 0a 2a 2a 20 70 65 72  ists of a.** per
26130 63 65 6e 74 20 73 69 67 6e 20 2d 20 22 25 22 20  cent sign - "%" 
26140 2d 20 66 6f 6c 6c 6f 77 65 64 20 62 79 20 65 78  - followed by ex
26150 61 63 74 6c 79 20 74 77 6f 20 68 65 78 61 64 65  actly two hexade
26160 63 69 6d 61 6c 20 64 69 67 69 74 73 20 0a 2a 2a  cimal digits .**
26170 20 73 70 65 63 69 66 79 69 6e 67 20 61 6e 20 6f   specifying an o
26180 63 74 65 74 20 76 61 6c 75 65 2e 20 5e 42 65 66  ctet value. ^Bef
26190 6f 72 65 20 74 68 65 20 70 61 74 68 20 6f 72 20  ore the path or 
261a0 71 75 65 72 79 20 63 6f 6d 70 6f 6e 65 6e 74 73  query components
261b0 20 6f 66 20 61 0a 2a 2a 20 55 52 49 20 66 69 6c   of a.** URI fil
261c0 65 6e 61 6d 65 20 61 72 65 20 69 6e 74 65 72 70  ename are interp
261d0 72 65 74 65 64 2c 20 74 68 65 79 20 61 72 65 20  reted, they are 
261e0 65 6e 63 6f 64 65 64 20 75 73 69 6e 67 20 55 54  encoded using UT
261f0 46 2d 38 20 61 6e 64 20 61 6c 6c 20 0a 2a 2a 20  F-8 and all .** 
26200 68 65 78 61 64 65 63 69 6d 61 6c 20 65 73 63 61  hexadecimal esca
26210 70 65 20 73 65 71 75 65 6e 63 65 73 20 72 65 70  pe sequences rep
26220 6c 61 63 65 64 20 62 79 20 61 20 73 69 6e 67 6c  laced by a singl
26230 65 20 62 79 74 65 20 63 6f 6e 74 61 69 6e 69 6e  e byte containin
26240 67 20 74 68 65 0a 2a 2a 20 63 6f 72 72 65 73 70  g the.** corresp
26250 6f 6e 64 69 6e 67 20 6f 63 74 65 74 2e 20 49 66  onding octet. If
26260 20 74 68 69 73 20 70 72 6f 63 65 73 73 20 67 65   this process ge
26270 6e 65 72 61 74 65 73 20 61 6e 20 69 6e 76 61 6c  nerates an inval
26280 69 64 20 55 54 46 2d 38 20 65 6e 63 6f 64 69 6e  id UTF-8 encodin
26290 67 2c 0a 2a 2a 20 74 68 65 20 72 65 73 75 6c 74  g,.** the result
262a0 73 20 61 72 65 20 75 6e 64 65 66 69 6e 65 64 2e  s are undefined.
262b0 0a 2a 2a 0a 2a 2a 20 3c 62 3e 4e 6f 74 65 20 74  .**.** <b>Note t
262c0 6f 20 57 69 6e 64 6f 77 73 20 75 73 65 72 73 3a  o Windows users:
262d0 3c 2f 62 3e 20 20 54 68 65 20 65 6e 63 6f 64 69  </b>  The encodi
262e0 6e 67 20 75 73 65 64 20 66 6f 72 20 74 68 65 20  ng used for the 
262f0 66 69 6c 65 6e 61 6d 65 20 61 72 67 75 6d 65 6e  filename argumen
26300 74 0a 2a 2a 20 6f 66 20 73 71 6c 69 74 65 33 5f  t.** of sqlite3_
26310 6f 70 65 6e 28 29 20 61 6e 64 20 73 71 6c 69 74  open() and sqlit
26320 65 33 5f 6f 70 65 6e 5f 76 32 28 29 20 6d 75 73  e3_open_v2() mus
26330 74 20 62 65 20 55 54 46 2d 38 2c 20 6e 6f 74 20  t be UTF-8, not 
26340 77 68 61 74 65 76 65 72 0a 2a 2a 20 63 6f 64 65  whatever.** code
26350 70 61 67 65 20 69 73 20 63 75 72 72 65 6e 74 6c  page is currentl
26360 79 20 64 65 66 69 6e 65 64 2e 20 20 46 69 6c 65  y defined.  File
26370 6e 61 6d 65 73 20 63 6f 6e 74 61 69 6e 69 6e 67  names containing
26380 20 69 6e 74 65 72 6e 61 74 69 6f 6e 61 6c 0a 2a   international.*
26390 2a 20 63 68 61 72 61 63 74 65 72 73 20 6d 75 73  * characters mus
263a0 74 20 62 65 20 63 6f 6e 76 65 72 74 65 64 20 74  t be converted t
263b0 6f 20 55 54 46 2d 38 20 70 72 69 6f 72 20 74 6f  o UTF-8 prior to
263c0 20 70 61 73 73 69 6e 67 20 74 68 65 6d 20 69 6e   passing them in
263d0 74 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 6f 70  to.** sqlite3_op
263e0 65 6e 28 29 20 6f 72 20 73 71 6c 69 74 65 33 5f  en() or sqlite3_
263f0 6f 70 65 6e 5f 76 32 28 29 2e 0a 2a 2a 0a 2a 2a  open_v2()..**.**
26400 20 3c 62 3e 4e 6f 74 65 20 74 6f 20 57 69 6e 64   <b>Note to Wind
26410 6f 77 73 20 52 75 6e 74 69 6d 65 20 75 73 65 72  ows Runtime user
26420 73 3a 3c 2f 62 3e 20 20 54 68 65 20 74 65 6d 70  s:</b>  The temp
26430 6f 72 61 72 79 20 64 69 72 65 63 74 6f 72 79 20  orary directory 
26440 6d 75 73 74 20 62 65 20 73 65 74 0a 2a 2a 20 70  must be set.** p
26450 72 69 6f 72 20 74 6f 20 63 61 6c 6c 69 6e 67 20  rior to calling 
26460 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 20 6f  sqlite3_open() o
26470 72 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76  r sqlite3_open_v
26480 32 28 29 2e 20 20 4f 74 68 65 72 77 69 73 65 2c  2().  Otherwise,
26490 20 76 61 72 69 6f 75 73 0a 2a 2a 20 66 65 61 74   various.** feat
264a0 75 72 65 73 20 74 68 61 74 20 72 65 71 75 69 72  ures that requir
264b0 65 20 74 68 65 20 75 73 65 20 6f 66 20 74 65 6d  e the use of tem
264c0 70 6f 72 61 72 79 20 66 69 6c 65 73 20 6d 61 79  porary files may
264d0 20 66 61 69 6c 2e 0a 2a 2a 0a 2a 2a 20 53 65 65   fail..**.** See
264e0 20 61 6c 73 6f 3a 20 5b 73 71 6c 69 74 65 33 5f   also: [sqlite3_
264f0 74 65 6d 70 5f 64 69 72 65 63 74 6f 72 79 5d 0a  temp_directory].
26500 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 6f  */.int sqlite3_o
26510 70 65 6e 28 0a 20 20 63 6f 6e 73 74 20 63 68 61  pen(.  const cha
26520 72 20 2a 66 69 6c 65 6e 61 6d 65 2c 20 20 20 2f  r *filename,   /
26530 2a 20 44 61 74 61 62 61 73 65 20 66 69 6c 65 6e  * Database filen
26540 61 6d 65 20 28 55 54 46 2d 38 29 20 2a 2f 0a 20  ame (UTF-8) */. 
26550 20 73 71 6c 69 74 65 33 20 2a 2a 70 70 44 62 20   sqlite3 **ppDb 
26560 20 20 20 20 20 20 20 20 20 2f 2a 20 4f 55 54 3a           /* OUT:
26570 20 53 51 4c 69 74 65 20 64 62 20 68 61 6e 64 6c   SQLite db handl
26580 65 20 2a 2f 0a 29 3b 0a 69 6e 74 20 73 71 6c 69  e */.);.int sqli
26590 74 65 33 5f 6f 70 65 6e 31 36 28 0a 20 20 63 6f  te3_open16(.  co
265a0 6e 73 74 20 76 6f 69 64 20 2a 66 69 6c 65 6e 61  nst void *filena
265b0 6d 65 2c 20 20 20 2f 2a 20 44 61 74 61 62 61 73  me,   /* Databas
265c0 65 20 66 69 6c 65 6e 61 6d 65 20 28 55 54 46 2d  e filename (UTF-
265d0 31 36 29 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33  16) */.  sqlite3
265e0 20 2a 2a 70 70 44 62 20 20 20 20 20 20 20 20 20   **ppDb         
265f0 20 2f 2a 20 4f 55 54 3a 20 53 51 4c 69 74 65 20   /* OUT: SQLite 
26600 64 62 20 68 61 6e 64 6c 65 20 2a 2f 0a 29 3b 0a  db handle */.);.
26610 69 6e 74 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e  int sqlite3_open
26620 5f 76 32 28 0a 20 20 63 6f 6e 73 74 20 63 68 61  _v2(.  const cha
26630 72 20 2a 66 69 6c 65 6e 61 6d 65 2c 20 20 20 2f  r *filename,   /
26640 2a 20 44 61 74 61 62 61 73 65 20 66 69 6c 65 6e  * Database filen
26650 61 6d 65 20 28 55 54 46 2d 38 29 20 2a 2f 0a 20  ame (UTF-8) */. 
26660 20 73 71 6c 69 74 65 33 20 2a 2a 70 70 44 62 2c   sqlite3 **ppDb,
26670 20 20 20 20 20 20 20 20 20 2f 2a 20 4f 55 54 3a           /* OUT:
26680 20 53 51 4c 69 74 65 20 64 62 20 68 61 6e 64 6c   SQLite db handl
26690 65 20 2a 2f 0a 20 20 69 6e 74 20 66 6c 61 67 73  e */.  int flags
266a0 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f  ,              /
266b0 2a 20 46 6c 61 67 73 20 2a 2f 0a 20 20 63 6f 6e  * Flags */.  con
266c0 73 74 20 63 68 61 72 20 2a 7a 56 66 73 20 20 20  st char *zVfs   
266d0 20 20 20 20 20 2f 2a 20 4e 61 6d 65 20 6f 66 20       /* Name of 
266e0 56 46 53 20 6d 6f 64 75 6c 65 20 74 6f 20 75 73  VFS module to us
266f0 65 20 2a 2f 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43  e */.);../*.** C
26700 41 50 49 33 52 45 46 3a 20 4f 62 74 61 69 6e 20  API3REF: Obtain 
26710 56 61 6c 75 65 73 20 46 6f 72 20 55 52 49 20 50  Values For URI P
26720 61 72 61 6d 65 74 65 72 73 0a 2a 2a 0a 2a 2a 20  arameters.**.** 
26730 54 68 65 73 65 20 61 72 65 20 75 74 69 6c 69 74  These are utilit
26740 79 20 72 6f 75 74 69 6e 65 73 2c 20 75 73 65 66  y routines, usef
26750 75 6c 20 74 6f 20 56 46 53 20 69 6d 70 6c 65 6d  ul to VFS implem
26760 65 6e 74 61 74 69 6f 6e 73 2c 20 74 68 61 74 20  entations, that 
26770 63 68 65 63 6b 0a 2a 2a 20 74 6f 20 73 65 65 20  check.** to see 
26780 69 66 20 61 20 64 61 74 61 62 61 73 65 20 66 69  if a database fi
26790 6c 65 20 77 61 73 20 61 20 55 52 49 20 74 68 61  le was a URI tha
267a0 74 20 63 6f 6e 74 61 69 6e 65 64 20 61 20 73 70  t contained a sp
267b0 65 63 69 66 69 63 20 71 75 65 72 79 20 0a 2a 2a  ecific query .**
267c0 20 70 61 72 61 6d 65 74 65 72 2c 20 61 6e 64 20   parameter, and 
267d0 69 66 20 73 6f 20 6f 62 74 61 69 6e 73 20 74 68  if so obtains th
267e0 65 20 76 61 6c 75 65 20 6f 66 20 74 68 61 74 20  e value of that 
267f0 71 75 65 72 79 20 70 61 72 61 6d 65 74 65 72 2e  query parameter.
26800 0a 2a 2a 0a 2a 2a 20 49 66 20 46 20 69 73 20 74  .**.** If F is t
26810 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65  he database file
26820 6e 61 6d 65 20 70 6f 69 6e 74 65 72 20 70 61 73  name pointer pas
26830 73 65 64 20 69 6e 74 6f 20 74 68 65 20 78 4f 70  sed into the xOp
26840 65 6e 28 29 20 6d 65 74 68 6f 64 20 6f 66 20 0a  en() method of .
26850 2a 2a 20 61 20 56 46 53 20 69 6d 70 6c 65 6d 65  ** a VFS impleme
26860 6e 74 61 74 69 6f 6e 20 77 68 65 6e 20 74 68 65  ntation when the
26870 20 66 6c 61 67 73 20 70 61 72 61 6d 65 74 65 72   flags parameter
26880 20 74 6f 20 78 4f 70 65 6e 28 29 20 68 61 73 20   to xOpen() has 
26890 6f 6e 65 20 6f 72 20 0a 2a 2a 20 6d 6f 72 65 20  one or .** more 
268a0 6f 66 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 4f  of the [SQLITE_O
268b0 50 45 4e 5f 55 52 49 5d 20 6f 72 20 5b 53 51 4c  PEN_URI] or [SQL
268c0 49 54 45 5f 4f 50 45 4e 5f 4d 41 49 4e 5f 44 42  ITE_OPEN_MAIN_DB
268d0 5d 20 62 69 74 73 20 73 65 74 20 61 6e 64 0a 2a  ] bits set and.*
268e0 2a 20 50 20 69 73 20 74 68 65 20 6e 61 6d 65 20  * P is the name 
268f0 6f 66 20 74 68 65 20 71 75 65 72 79 20 70 61 72  of the query par
26900 61 6d 65 74 65 72 2c 20 74 68 65 6e 0a 2a 2a 20  ameter, then.** 
26910 73 71 6c 69 74 65 33 5f 75 72 69 5f 70 61 72 61  sqlite3_uri_para
26920 6d 65 74 65 72 28 46 2c 50 29 20 72 65 74 75 72  meter(F,P) retur
26930 6e 73 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20  ns the value of 
26940 74 68 65 20 50 0a 2a 2a 20 70 61 72 61 6d 65 74  the P.** paramet
26950 65 72 20 69 66 20 69 74 20 65 78 69 73 74 73 20  er if it exists 
26960 6f 72 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  or a NULL pointe
26970 72 20 69 66 20 50 20 64 6f 65 73 20 6e 6f 74 20  r if P does not 
26980 61 70 70 65 61 72 20 61 73 20 61 20 0a 2a 2a 20  appear as a .** 
26990 71 75 65 72 79 20 70 61 72 61 6d 65 74 65 72 20  query parameter 
269a0 6f 6e 20 46 2e 20 20 49 66 20 50 20 69 73 20 61  on F.  If P is a
269b0 20 71 75 65 72 79 20 70 61 72 61 6d 65 74 65 72   query parameter
269c0 20 6f 66 20 46 0a 2a 2a 20 68 61 73 20 6e 6f 20   of F.** has no 
269d0 65 78 70 6c 69 63 69 74 20 76 61 6c 75 65 2c 20  explicit value, 
269e0 74 68 65 6e 20 73 71 6c 69 74 65 33 5f 75 72 69  then sqlite3_uri
269f0 5f 70 61 72 61 6d 65 74 65 72 28 46 2c 50 29 20  _parameter(F,P) 
26a00 72 65 74 75 72 6e 73 0a 2a 2a 20 61 20 70 6f 69  returns.** a poi
26a10 6e 74 65 72 20 74 6f 20 61 6e 20 65 6d 70 74 79  nter to an empty
26a20 20 73 74 72 69 6e 67 2e 0a 2a 2a 0a 2a 2a 20 54   string..**.** T
26a30 68 65 20 73 71 6c 69 74 65 33 5f 75 72 69 5f 62  he sqlite3_uri_b
26a40 6f 6f 6c 65 61 6e 28 46 2c 50 2c 42 29 20 72 6f  oolean(F,P,B) ro
26a50 75 74 69 6e 65 20 61 73 73 75 6d 65 73 20 74 68  utine assumes th
26a60 61 74 20 50 20 69 73 20 61 20 62 6f 6f 6c 65 61  at P is a boolea
26a70 6e 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72 20 61  n.** parameter a
26a80 6e 64 20 72 65 74 75 72 6e 73 20 74 72 75 65 20  nd returns true 
26a90 28 31 29 20 6f 72 20 66 61 6c 73 65 20 28 30 29  (1) or false (0)
26aa0 20 61 63 63 6f 72 64 69 6e 67 20 74 6f 20 74 68   according to th
26ab0 65 20 76 61 6c 75 65 0a 2a 2a 20 6f 66 20 50 2e  e value.** of P.
26ac0 20 20 54 68 65 20 73 71 6c 69 74 65 33 5f 75 72    The sqlite3_ur
26ad0 69 5f 62 6f 6f 6c 65 61 6e 28 46 2c 50 2c 42 29  i_boolean(F,P,B)
26ae0 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73   routine returns
26af0 20 74 72 75 65 20 28 31 29 20 69 66 20 74 68 65   true (1) if the
26b00 0a 2a 2a 20 76 61 6c 75 65 20 6f 66 20 71 75 65  .** value of que
26b10 72 79 20 70 61 72 61 6d 65 74 65 72 20 50 20 69  ry parameter P i
26b20 73 20 6f 6e 65 20 6f 66 20 22 79 65 73 22 2c 20  s one of "yes", 
26b30 22 74 72 75 65 22 2c 20 6f 72 20 22 6f 6e 22 20  "true", or "on" 
26b40 69 6e 20 61 6e 79 0a 2a 2a 20 63 61 73 65 20 6f  in any.** case o
26b50 72 20 69 66 20 74 68 65 20 76 61 6c 75 65 20 62  r if the value b
26b60 65 67 69 6e 73 20 77 69 74 68 20 61 20 6e 6f 6e  egins with a non
26b70 2d 7a 65 72 6f 20 6e 75 6d 62 65 72 2e 20 20 54  -zero number.  T
26b80 68 65 20 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 75  he .** sqlite3_u
26b90 72 69 5f 62 6f 6f 6c 65 61 6e 28 46 2c 50 2c 42  ri_boolean(F,P,B
26ba0 29 20 72 6f 75 74 69 6e 65 73 20 72 65 74 75 72  ) routines retur
26bb0 6e 73 20 66 61 6c 73 65 20 28 30 29 20 69 66 20  ns false (0) if 
26bc0 74 68 65 20 76 61 6c 75 65 20 6f 66 0a 2a 2a 20  the value of.** 
26bd0 71 75 65 72 79 20 70 61 72 61 6d 65 74 65 72 20  query parameter 
26be0 50 20 69 73 20 6f 6e 65 20 6f 66 20 22 6e 6f 22  P is one of "no"
26bf0 2c 20 22 66 61 6c 73 65 22 2c 20 6f 72 20 22 6f  , "false", or "o
26c00 66 66 22 20 69 6e 20 61 6e 79 20 63 61 73 65 20  ff" in any case 
26c10 6f 72 0a 2a 2a 20 69 66 20 74 68 65 20 76 61 6c  or.** if the val
26c20 75 65 20 62 65 67 69 6e 73 20 77 69 74 68 20 61  ue begins with a
26c30 20 6e 75 6d 65 72 69 63 20 7a 65 72 6f 2e 20 20   numeric zero.  
26c40 49 66 20 50 20 69 73 20 6e 6f 74 20 61 20 71 75  If P is not a qu
26c50 65 72 79 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72  ery.** parameter
26c60 20 6f 6e 20 46 20 6f 72 20 69 66 20 74 68 65 20   on F or if the 
26c70 76 61 6c 75 65 20 6f 66 20 50 20 69 73 20 64 6f  value of P is do
26c80 65 73 20 6e 6f 74 20 6d 61 74 63 68 20 61 6e 79  es not match any
26c90 20 6f 66 20 74 68 65 0a 2a 2a 20 61 62 6f 76 65   of the.** above
26ca0 2c 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f 75  , then sqlite3_u
26cb0 72 69 5f 62 6f 6f 6c 65 61 6e 28 46 2c 50 2c 42  ri_boolean(F,P,B
26cc0 29 20 72 65 74 75 72 6e 73 20 28 42 21 3d 30 29  ) returns (B!=0)
26cd0 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69  ..**.** The sqli
26ce0 74 65 33 5f 75 72 69 5f 69 6e 74 36 34 28 46 2c  te3_uri_int64(F,
26cf0 50 2c 44 29 20 72 6f 75 74 69 6e 65 20 63 6f 6e  P,D) routine con
26d00 76 65 72 74 73 20 74 68 65 20 76 61 6c 75 65 20  verts the value 
26d10 6f 66 20 50 20 69 6e 74 6f 20 61 0a 2a 2a 20 36  of P into a.** 6
26d20 34 2d 62 69 74 20 73 69 67 6e 65 64 20 69 6e 74  4-bit signed int
26d30 65 67 65 72 20 61 6e 64 20 72 65 74 75 72 6e 73  eger and returns
26d40 20 74 68 61 74 20 69 6e 74 65 67 65 72 2c 20 6f   that integer, o
26d50 72 20 44 20 69 66 20 50 20 64 6f 65 73 20 6e 6f  r D if P does no
26d60 74 0a 2a 2a 20 65 78 69 73 74 2e 20 20 49 66 20  t.** exist.  If 
26d70 74 68 65 20 76 61 6c 75 65 20 6f 66 20 50 20 69  the value of P i
26d80 73 20 73 6f 6d 65 74 68 69 6e 67 20 6f 74 68 65  s something othe
26d90 72 20 74 68 61 6e 20 61 6e 20 69 6e 74 65 67 65  r than an intege
26da0 72 2c 20 74 68 65 6e 0a 2a 2a 20 7a 65 72 6f 20  r, then.** zero 
26db0 69 73 20 72 65 74 75 72 6e 65 64 2e 0a 2a 2a 20  is returned..** 
26dc0 0a 2a 2a 20 49 66 20 46 20 69 73 20 61 20 4e 55  .** If F is a NU
26dd0 4c 4c 20 70 6f 69 6e 74 65 72 2c 20 74 68 65 6e  LL pointer, then
26de0 20 73 71 6c 69 74 65 33 5f 75 72 69 5f 70 61 72   sqlite3_uri_par
26df0 61 6d 65 74 65 72 28 46 2c 50 29 20 72 65 74 75  ameter(F,P) retu
26e00 72 6e 73 20 4e 55 4c 4c 20 61 6e 64 0a 2a 2a 20  rns NULL and.** 
26e10 73 71 6c 69 74 65 33 5f 75 72 69 5f 62 6f 6f 6c  sqlite3_uri_bool
26e20 65 61 6e 28 46 2c 50 2c 42 29 20 72 65 74 75 72  ean(F,P,B) retur
26e30 6e 73 20 42 2e 20 20 49 66 20 46 20 69 73 20 6e  ns B.  If F is n
26e40 6f 74 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  ot a NULL pointe
26e50 72 20 61 6e 64 0a 2a 2a 20 69 73 20 6e 6f 74 20  r and.** is not 
26e60 61 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20  a database file 
26e70 70 61 74 68 6e 61 6d 65 20 70 6f 69 6e 74 65 72  pathname pointer
26e80 20 74 68 61 74 20 53 51 4c 69 74 65 20 70 61 73   that SQLite pas
26e90 73 65 64 20 69 6e 74 6f 20 74 68 65 20 78 4f 70  sed into the xOp
26ea0 65 6e 0a 2a 2a 20 56 46 53 20 6d 65 74 68 6f 64  en.** VFS method
26eb0 2c 20 74 68 65 6e 20 74 68 65 20 62 65 68 61 76  , then the behav
26ec0 69 6f 72 20 6f 66 20 74 68 69 73 20 72 6f 75 74  ior of this rout
26ed0 69 6e 65 20 69 73 20 75 6e 64 65 66 69 6e 65 64  ine is undefined
26ee0 20 61 6e 64 20 70 72 6f 62 61 62 6c 79 0a 2a 2a   and probably.**
26ef0 20 75 6e 64 65 73 69 72 61 62 6c 65 2e 0a 2a 2f   undesirable..*/
26f00 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 71 6c  .const char *sql
26f10 69 74 65 33 5f 75 72 69 5f 70 61 72 61 6d 65 74  ite3_uri_paramet
26f20 65 72 28 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a  er(const char *z
26f30 46 69 6c 65 6e 61 6d 65 2c 20 63 6f 6e 73 74 20  Filename, const 
26f40 63 68 61 72 20 2a 7a 50 61 72 61 6d 29 3b 0a 69  char *zParam);.i
26f50 6e 74 20 73 71 6c 69 74 65 33 5f 75 72 69 5f 62  nt sqlite3_uri_b
26f60 6f 6f 6c 65 61 6e 28 63 6f 6e 73 74 20 63 68 61  oolean(const cha
26f70 72 20 2a 7a 46 69 6c 65 2c 20 63 6f 6e 73 74 20  r *zFile, const 
26f80 63 68 61 72 20 2a 7a 50 61 72 61 6d 2c 20 69 6e  char *zParam, in
26f90 74 20 62 44 65 66 61 75 6c 74 29 3b 0a 73 71 6c  t bDefault);.sql
26fa0 69 74 65 33 5f 69 6e 74 36 34 20 73 71 6c 69 74  ite3_int64 sqlit
26fb0 65 33 5f 75 72 69 5f 69 6e 74 36 34 28 63 6f 6e  e3_uri_int64(con
26fc0 73 74 20 63 68 61 72 2a 2c 20 63 6f 6e 73 74 20  st char*, const 
26fd0 63 68 61 72 2a 2c 20 73 71 6c 69 74 65 33 5f 69  char*, sqlite3_i
26fe0 6e 74 36 34 29 3b 0a 0a 0a 2f 2a 0a 2a 2a 20 43  nt64);.../*.** C
26ff0 41 50 49 33 52 45 46 3a 20 45 72 72 6f 72 20 43  API3REF: Error C
27000 6f 64 65 73 20 41 6e 64 20 4d 65 73 73 61 67 65  odes And Message
27010 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c  s.** METHOD: sql
27020 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74  ite3.**.** ^If t
27030 68 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 20 73  he most recent s
27040 71 6c 69 74 65 33 5f 2a 20 41 50 49 20 63 61 6c  qlite3_* API cal
27050 6c 20 61 73 73 6f 63 69 61 74 65 64 20 77 69 74  l associated wit
27060 68 20 0a 2a 2a 20 5b 64 61 74 61 62 61 73 65 20  h .** [database 
27070 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 44 20 66 61  connection] D fa
27080 69 6c 65 64 2c 20 74 68 65 6e 20 74 68 65 20 73  iled, then the s
27090 71 6c 69 74 65 33 5f 65 72 72 63 6f 64 65 28 44  qlite3_errcode(D
270a0 29 20 69 6e 74 65 72 66 61 63 65 0a 2a 2a 20 72  ) interface.** r
270b0 65 74 75 72 6e 73 20 74 68 65 20 6e 75 6d 65 72  eturns the numer
270c0 69 63 20 5b 72 65 73 75 6c 74 20 63 6f 64 65 5d  ic [result code]
270d0 20 6f 72 20 5b 65 78 74 65 6e 64 65 64 20 72 65   or [extended re
270e0 73 75 6c 74 20 63 6f 64 65 5d 20 66 6f 72 20 74  sult code] for t
270f0 68 61 74 0a 2a 2a 20 41 50 49 20 63 61 6c 6c 2e  hat.** API call.
27100 0a 2a 2a 20 49 66 20 74 68 65 20 6d 6f 73 74 20  .** If the most 
27110 72 65 63 65 6e 74 20 41 50 49 20 63 61 6c 6c 20  recent API call 
27120 77 61 73 20 73 75 63 63 65 73 73 66 75 6c 2c 0a  was successful,.
27130 2a 2a 20 74 68 65 6e 20 74 68 65 20 72 65 74 75  ** then the retu
27140 72 6e 20 76 61 6c 75 65 20 66 72 6f 6d 20 73 71  rn value from sq
27150 6c 69 74 65 33 5f 65 72 72 63 6f 64 65 28 29 20  lite3_errcode() 
27160 69 73 20 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a  is undefined..**
27170 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 65 78   ^The sqlite3_ex
27180 74 65 6e 64 65 64 5f 65 72 72 63 6f 64 65 28 29  tended_errcode()
27190 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 69 73  .** interface is
271a0 20 74 68 65 20 73 61 6d 65 20 65 78 63 65 70 74   the same except
271b0 20 74 68 61 74 20 69 74 20 61 6c 77 61 79 73 20   that it always 
271c0 72 65 74 75 72 6e 73 20 74 68 65 20 0a 2a 2a 20  returns the .** 
271d0 5b 65 78 74 65 6e 64 65 64 20 72 65 73 75 6c 74  [extended result
271e0 20 63 6f 64 65 5d 20 65 76 65 6e 20 77 68 65 6e   code] even when
271f0 20 65 78 74 65 6e 64 65 64 20 72 65 73 75 6c 74   extended result
27200 20 63 6f 64 65 73 20 61 72 65 0a 2a 2a 20 64 69   codes are.** di
27210 73 61 62 6c 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54  sabled..**.** ^T
27220 68 65 20 73 71 6c 69 74 65 33 5f 65 72 72 6d 73  he sqlite3_errms
27230 67 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f  g() and sqlite3_
27240 65 72 72 6d 73 67 31 36 28 29 20 72 65 74 75 72  errmsg16() retur
27250 6e 20 45 6e 67 6c 69 73 68 2d 6c 61 6e 67 75 61  n English-langua
27260 67 65 0a 2a 2a 20 74 65 78 74 20 74 68 61 74 20  ge.** text that 
27270 64 65 73 63 72 69 62 65 73 20 74 68 65 20 65 72  describes the er
27280 72 6f 72 2c 20 61 73 20 65 69 74 68 65 72 20 55  ror, as either U
27290 54 46 2d 38 20 6f 72 20 55 54 46 2d 31 36 20 72  TF-8 or UTF-16 r
272a0 65 73 70 65 63 74 69 76 65 6c 79 2e 0a 2a 2a 20  espectively..** 
272b0 5e 28 4d 65 6d 6f 72 79 20 74 6f 20 68 6f 6c 64  ^(Memory to hold
272c0 20 74 68 65 20 65 72 72 6f 72 20 6d 65 73 73 61   the error messa
272d0 67 65 20 73 74 72 69 6e 67 20 69 73 20 6d 61 6e  ge string is man
272e0 61 67 65 64 20 69 6e 74 65 72 6e 61 6c 6c 79 2e  aged internally.
272f0 0a 2a 2a 20 54 68 65 20 61 70 70 6c 69 63 61 74  .** The applicat
27300 69 6f 6e 20 64 6f 65 73 20 6e 6f 74 20 6e 65 65  ion does not nee
27310 64 20 74 6f 20 77 6f 72 72 79 20 61 62 6f 75 74  d to worry about
27320 20 66 72 65 65 69 6e 67 20 74 68 65 20 72 65 73   freeing the res
27330 75 6c 74 2e 0a 2a 2a 20 48 6f 77 65 76 65 72 2c  ult..** However,
27340 20 74 68 65 20 65 72 72 6f 72 20 73 74 72 69 6e   the error strin
27350 67 20 6d 69 67 68 74 20 62 65 20 6f 76 65 72 77  g might be overw
27360 72 69 74 74 65 6e 20 6f 72 20 64 65 61 6c 6c 6f  ritten or deallo
27370 63 61 74 65 64 20 62 79 0a 2a 2a 20 73 75 62 73  cated by.** subs
27380 65 71 75 65 6e 74 20 63 61 6c 6c 73 20 74 6f 20  equent calls to 
27390 6f 74 68 65 72 20 53 51 4c 69 74 65 20 69 6e 74  other SQLite int
273a0 65 72 66 61 63 65 20 66 75 6e 63 74 69 6f 6e 73  erface functions
273b0 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  .)^.**.** ^The s
273c0 71 6c 69 74 65 33 5f 65 72 72 73 74 72 28 29 20  qlite3_errstr() 
273d0 69 6e 74 65 72 66 61 63 65 20 72 65 74 75 72 6e  interface return
273e0 73 20 74 68 65 20 45 6e 67 6c 69 73 68 2d 6c 61  s the English-la
273f0 6e 67 75 61 67 65 20 74 65 78 74 0a 2a 2a 20 74  nguage text.** t
27400 68 61 74 20 64 65 73 63 72 69 62 65 73 20 74 68  hat describes th
27410 65 20 5b 72 65 73 75 6c 74 20 63 6f 64 65 5d 2c  e [result code],
27420 20 61 73 20 55 54 46 2d 38 2e 0a 2a 2a 20 5e 28   as UTF-8..** ^(
27430 4d 65 6d 6f 72 79 20 74 6f 20 68 6f 6c 64 20 74  Memory to hold t
27440 68 65 20 65 72 72 6f 72 20 6d 65 73 73 61 67 65  he error message
27450 20 73 74 72 69 6e 67 20 69 73 20 6d 61 6e 61 67   string is manag
27460 65 64 20 69 6e 74 65 72 6e 61 6c 6c 79 0a 2a 2a  ed internally.**
27470 20 61 6e 64 20 6d 75 73 74 20 6e 6f 74 20 62 65   and must not be
27480 20 66 72 65 65 64 20 62 79 20 74 68 65 20 61 70   freed by the ap
27490 70 6c 69 63 61 74 69 6f 6e 29 5e 2e 0a 2a 2a 0a  plication)^..**.
274a0 2a 2a 20 57 68 65 6e 20 74 68 65 20 73 65 72 69  ** When the seri
274b0 61 6c 69 7a 65 64 20 5b 74 68 72 65 61 64 69 6e  alized [threadin
274c0 67 20 6d 6f 64 65 5d 20 69 73 20 69 6e 20 75 73  g mode] is in us
274d0 65 2c 20 69 74 20 6d 69 67 68 74 20 62 65 20 74  e, it might be t
274e0 68 65 0a 2a 2a 20 63 61 73 65 20 74 68 61 74 20  he.** case that 
274f0 61 20 73 65 63 6f 6e 64 20 65 72 72 6f 72 20 6f  a second error o
27500 63 63 75 72 73 20 6f 6e 20 61 20 73 65 70 61 72  ccurs on a separ
27510 61 74 65 20 74 68 72 65 61 64 20 69 6e 20 62 65  ate thread in be
27520 74 77 65 65 6e 0a 2a 2a 20 74 68 65 20 74 69 6d  tween.** the tim
27530 65 20 6f 66 20 74 68 65 20 66 69 72 73 74 20 65  e of the first e
27540 72 72 6f 72 20 61 6e 64 20 74 68 65 20 63 61 6c  rror and the cal
27550 6c 20 74 6f 20 74 68 65 73 65 20 69 6e 74 65 72  l to these inter
27560 66 61 63 65 73 2e 0a 2a 2a 20 57 68 65 6e 20 74  faces..** When t
27570 68 61 74 20 68 61 70 70 65 6e 73 2c 20 74 68 65  hat happens, the
27580 20 73 65 63 6f 6e 64 20 65 72 72 6f 72 20 77 69   second error wi
27590 6c 6c 20 62 65 20 72 65 70 6f 72 74 65 64 20 73  ll be reported s
275a0 69 6e 63 65 20 74 68 65 73 65 0a 2a 2a 20 69 6e  ince these.** in
275b0 74 65 72 66 61 63 65 73 20 61 6c 77 61 79 73 20  terfaces always 
275c0 72 65 70 6f 72 74 20 74 68 65 20 6d 6f 73 74 20  report the most 
275d0 72 65 63 65 6e 74 20 72 65 73 75 6c 74 2e 20 20  recent result.  
275e0 54 6f 20 61 76 6f 69 64 0a 2a 2a 20 74 68 69 73  To avoid.** this
275f0 2c 20 65 61 63 68 20 74 68 72 65 61 64 20 63 61  , each thread ca
27600 6e 20 6f 62 74 61 69 6e 20 65 78 63 6c 75 73 69  n obtain exclusi
27610 76 65 20 75 73 65 20 6f 66 20 74 68 65 20 5b 64  ve use of the [d
27620 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
27630 6f 6e 5d 20 44 0a 2a 2a 20 62 79 20 69 6e 76 6f  on] D.** by invo
27640 6b 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 6d 75  king [sqlite3_mu
27650 74 65 78 5f 65 6e 74 65 72 5d 28 5b 73 71 6c 69  tex_enter]([sqli
27660 74 65 33 5f 64 62 5f 6d 75 74 65 78 5d 28 44 29  te3_db_mutex](D)
27670 29 20 62 65 66 6f 72 65 20 62 65 67 69 6e 6e 69  ) before beginni
27680 6e 67 0a 2a 2a 20 74 6f 20 75 73 65 20 44 20 61  ng.** to use D a
27690 6e 64 20 69 6e 76 6f 6b 69 6e 67 20 5b 73 71 6c  nd invoking [sql
276a0 69 74 65 33 5f 6d 75 74 65 78 5f 6c 65 61 76 65  ite3_mutex_leave
276b0 5d 28 5b 73 71 6c 69 74 65 33 5f 64 62 5f 6d 75  ]([sqlite3_db_mu
276c0 74 65 78 5d 28 44 29 29 20 61 66 74 65 72 0a 2a  tex](D)) after.*
276d0 2a 20 61 6c 6c 20 63 61 6c 6c 73 20 74 6f 20 74  * all calls to t
276e0 68 65 20 69 6e 74 65 72 66 61 63 65 73 20 6c 69  he interfaces li
276f0 73 74 65 64 20 68 65 72 65 20 61 72 65 20 63 6f  sted here are co
27700 6d 70 6c 65 74 65 64 2e 0a 2a 2a 0a 2a 2a 20 49  mpleted..**.** I
27710 66 20 61 6e 20 69 6e 74 65 72 66 61 63 65 20 66  f an interface f
27720 61 69 6c 73 20 77 69 74 68 20 53 51 4c 49 54 45  ails with SQLITE
27730 5f 4d 49 53 55 53 45 2c 20 74 68 61 74 20 6d 65  _MISUSE, that me
27740 61 6e 73 20 74 68 65 20 69 6e 74 65 72 66 61 63  ans the interfac
27750 65 0a 2a 2a 20 77 61 73 20 69 6e 76 6f 6b 65 64  e.** was invoked
27760 20 69 6e 63 6f 72 72 65 63 74 6c 79 20 62 79 20   incorrectly by 
27770 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 2e  the application.
27780 20 20 49 6e 20 74 68 61 74 20 63 61 73 65 2c 20    In that case, 
27790 74 68 65 0a 2a 2a 20 65 72 72 6f 72 20 63 6f 64  the.** error cod
277a0 65 20 61 6e 64 20 6d 65 73 73 61 67 65 20 6d 61  e and message ma
277b0 79 20 6f 72 20 6d 61 79 20 6e 6f 74 20 62 65 20  y or may not be 
277c0 73 65 74 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69  set..*/.int sqli
277d0 74 65 33 5f 65 72 72 63 6f 64 65 28 73 71 6c 69  te3_errcode(sqli
277e0 74 65 33 20 2a 64 62 29 3b 0a 69 6e 74 20 73 71  te3 *db);.int sq
277f0 6c 69 74 65 33 5f 65 78 74 65 6e 64 65 64 5f 65  lite3_extended_e
27800 72 72 63 6f 64 65 28 73 71 6c 69 74 65 33 20 2a  rrcode(sqlite3 *
27810 64 62 29 3b 0a 63 6f 6e 73 74 20 63 68 61 72 20  db);.const char 
27820 2a 73 71 6c 69 74 65 33 5f 65 72 72 6d 73 67 28  *sqlite3_errmsg(
27830 73 71 6c 69 74 65 33 2a 29 3b 0a 63 6f 6e 73 74  sqlite3*);.const
27840 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 65   void *sqlite3_e
27850 72 72 6d 73 67 31 36 28 73 71 6c 69 74 65 33 2a  rrmsg16(sqlite3*
27860 29 3b 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a 73  );.const char *s
27870 71 6c 69 74 65 33 5f 65 72 72 73 74 72 28 69 6e  qlite3_errstr(in
27880 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  t);../*.** CAPI3
27890 52 45 46 3a 20 50 72 65 70 61 72 65 64 20 53 74  REF: Prepared St
278a0 61 74 65 6d 65 6e 74 20 4f 62 6a 65 63 74 0a 2a  atement Object.*
278b0 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b 70 72 65  * KEYWORDS: {pre
278c0 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 7d  pared statement}
278d0 20 7b 70 72 65 70 61 72 65 64 20 73 74 61 74 65   {prepared state
278e0 6d 65 6e 74 73 7d 0a 2a 2a 0a 2a 2a 20 41 6e 20  ments}.**.** An 
278f0 69 6e 73 74 61 6e 63 65 20 6f 66 20 74 68 69 73  instance of this
27900 20 6f 62 6a 65 63 74 20 72 65 70 72 65 73 65 6e   object represen
27910 74 73 20 61 20 73 69 6e 67 6c 65 20 53 51 4c 20  ts a single SQL 
27920 73 74 61 74 65 6d 65 6e 74 20 74 68 61 74 0a 2a  statement that.*
27930 2a 20 68 61 73 20 62 65 65 6e 20 63 6f 6d 70 69  * has been compi
27940 6c 65 64 20 69 6e 74 6f 20 62 69 6e 61 72 79 20  led into binary 
27950 66 6f 72 6d 20 61 6e 64 20 69 73 20 72 65 61 64  form and is read
27960 79 20 74 6f 20 62 65 20 65 76 61 6c 75 61 74 65  y to be evaluate
27970 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 6e 6b 20 6f  d..**.** Think o
27980 66 20 65 61 63 68 20 53 51 4c 20 73 74 61 74 65  f each SQL state
27990 6d 65 6e 74 20 61 73 20 61 20 73 65 70 61 72 61  ment as a separa
279a0 74 65 20 63 6f 6d 70 75 74 65 72 20 70 72 6f 67  te computer prog
279b0 72 61 6d 2e 20 20 54 68 65 0a 2a 2a 20 6f 72 69  ram.  The.** ori
279c0 67 69 6e 61 6c 20 53 51 4c 20 74 65 78 74 20 69  ginal SQL text i
279d0 73 20 73 6f 75 72 63 65 20 63 6f 64 65 2e 20 20  s source code.  
279e0 41 20 70 72 65 70 61 72 65 64 20 73 74 61 74 65  A prepared state
279f0 6d 65 6e 74 20 6f 62 6a 65 63 74 20 0a 2a 2a 20  ment object .** 
27a00 69 73 20 74 68 65 20 63 6f 6d 70 69 6c 65 64 20  is the compiled 
27a10 6f 62 6a 65 63 74 20 63 6f 64 65 2e 20 20 41 6c  object code.  Al
27a20 6c 20 53 51 4c 20 6d 75 73 74 20 62 65 20 63 6f  l SQL must be co
27a30 6e 76 65 72 74 65 64 20 69 6e 74 6f 20 61 0a 2a  nverted into a.*
27a40 2a 20 70 72 65 70 61 72 65 64 20 73 74 61 74 65  * prepared state
27a50 6d 65 6e 74 20 62 65 66 6f 72 65 20 69 74 20 63  ment before it c
27a60 61 6e 20 62 65 20 72 75 6e 2e 0a 2a 2a 0a 2a 2a  an be run..**.**
27a70 20 54 68 65 20 6c 69 66 65 2d 63 79 63 6c 65 20   The life-cycle 
27a80 6f 66 20 61 20 70 72 65 70 61 72 65 64 20 73 74  of a prepared st
27a90 61 74 65 6d 65 6e 74 20 6f 62 6a 65 63 74 20 75  atement object u
27aa0 73 75 61 6c 6c 79 20 67 6f 65 73 20 6c 69 6b 65  sually goes like
27ab0 20 74 68 69 73 3a 0a 2a 2a 0a 2a 2a 20 3c 6f 6c   this:.**.** <ol
27ac0 3e 0a 2a 2a 20 3c 6c 69 3e 20 43 72 65 61 74 65  >.** <li> Create
27ad0 20 74 68 65 20 70 72 65 70 61 72 65 64 20 73 74   the prepared st
27ae0 61 74 65 6d 65 6e 74 20 6f 62 6a 65 63 74 20 75  atement object u
27af0 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 70 72  sing [sqlite3_pr
27b00 65 70 61 72 65 5f 76 32 28 29 5d 2e 0a 2a 2a 20  epare_v2()]..** 
27b10 3c 6c 69 3e 20 42 69 6e 64 20 76 61 6c 75 65 73  <li> Bind values
27b20 20 74 6f 20 5b 70 61 72 61 6d 65 74 65 72 73 5d   to [parameters]
27b30 20 75 73 69 6e 67 20 74 68 65 20 73 71 6c 69 74   using the sqlit
27b40 65 33 5f 62 69 6e 64 5f 2a 28 29 0a 2a 2a 20 20  e3_bind_*().**  
27b50 20 20 20 20 69 6e 74 65 72 66 61 63 65 73 2e 0a      interfaces..
27b60 2a 2a 20 3c 6c 69 3e 20 52 75 6e 20 74 68 65 20  ** <li> Run the 
27b70 53 51 4c 20 62 79 20 63 61 6c 6c 69 6e 67 20 5b  SQL by calling [
27b80 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20  sqlite3_step()] 
27b90 6f 6e 65 20 6f 72 20 6d 6f 72 65 20 74 69 6d 65  one or more time
27ba0 73 2e 0a 2a 2a 20 3c 6c 69 3e 20 52 65 73 65 74  s..** <li> Reset
27bb0 20 74 68 65 20 70 72 65 70 61 72 65 64 20 73 74   the prepared st
27bc0 61 74 65 6d 65 6e 74 20 75 73 69 6e 67 20 5b 73  atement using [s
27bd0 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20  qlite3_reset()] 
27be0 74 68 65 6e 20 67 6f 20 62 61 63 6b 0a 2a 2a 20  then go back.** 
27bf0 20 20 20 20 20 74 6f 20 73 74 65 70 20 32 2e 20       to step 2. 
27c00 20 44 6f 20 74 68 69 73 20 7a 65 72 6f 20 6f 72   Do this zero or
27c10 20 6d 6f 72 65 20 74 69 6d 65 73 2e 0a 2a 2a 20   more times..** 
27c20 3c 6c 69 3e 20 44 65 73 74 72 6f 79 20 74 68 65  <li> Destroy the
27c30 20 6f 62 6a 65 63 74 20 75 73 69 6e 67 20 5b 73   object using [s
27c40 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28  qlite3_finalize(
27c50 29 5d 2e 0a 2a 2a 20 3c 2f 6f 6c 3e 0a 2a 2f 0a  )]..** </ol>.*/.
27c60 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20 73  typedef struct s
27c70 71 6c 69 74 65 33 5f 73 74 6d 74 20 73 71 6c 69  qlite3_stmt sqli
27c80 74 65 33 5f 73 74 6d 74 3b 0a 0a 2f 2a 0a 2a 2a  te3_stmt;../*.**
27c90 20 43 41 50 49 33 52 45 46 3a 20 52 75 6e 2d 74   CAPI3REF: Run-t
27ca0 69 6d 65 20 4c 69 6d 69 74 73 0a 2a 2a 20 4d 45  ime Limits.** ME
27cb0 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a 2a  THOD: sqlite3.**
27cc0 0a 2a 2a 20 5e 28 54 68 69 73 20 69 6e 74 65 72  .** ^(This inter
27cd0 66 61 63 65 20 61 6c 6c 6f 77 73 20 74 68 65 20  face allows the 
27ce0 73 69 7a 65 20 6f 66 20 76 61 72 69 6f 75 73 20  size of various 
27cf0 63 6f 6e 73 74 72 75 63 74 73 20 74 6f 20 62 65  constructs to be
27d00 20 6c 69 6d 69 74 65 64 0a 2a 2a 20 6f 6e 20 61   limited.** on a
27d10 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 62 79 20 63   connection by c
27d20 6f 6e 6e 65 63 74 69 6f 6e 20 62 61 73 69 73 2e  onnection basis.
27d30 20 20 54 68 65 20 66 69 72 73 74 20 70 61 72 61    The first para
27d40 6d 65 74 65 72 20 69 73 20 74 68 65 0a 2a 2a 20  meter is the.** 
27d50 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63  [database connec
27d60 74 69 6f 6e 5d 20 77 68 6f 73 65 20 6c 69 6d 69  tion] whose limi
27d70 74 20 69 73 20 74 6f 20 62 65 20 73 65 74 20 6f  t is to be set o
27d80 72 20 71 75 65 72 69 65 64 2e 20 20 54 68 65 0a  r queried.  The.
27d90 2a 2a 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65  ** second parame
27da0 74 65 72 20 69 73 20 6f 6e 65 20 6f 66 20 74 68  ter is one of th
27db0 65 20 5b 6c 69 6d 69 74 20 63 61 74 65 67 6f 72  e [limit categor
27dc0 69 65 73 5d 20 74 68 61 74 20 64 65 66 69 6e 65  ies] that define
27dd0 20 61 0a 2a 2a 20 63 6c 61 73 73 20 6f 66 20 63   a.** class of c
27de0 6f 6e 73 74 72 75 63 74 73 20 74 6f 20 62 65 20  onstructs to be 
27df0 73 69 7a 65 20 6c 69 6d 69 74 65 64 2e 20 20 54  size limited.  T
27e00 68 65 20 74 68 69 72 64 20 70 61 72 61 6d 65 74  he third paramet
27e10 65 72 20 69 73 20 74 68 65 0a 2a 2a 20 6e 65 77  er is the.** new
27e20 20 6c 69 6d 69 74 20 66 6f 72 20 74 68 61 74 20   limit for that 
27e30 63 6f 6e 73 74 72 75 63 74 2e 29 5e 0a 2a 2a 0a  construct.)^.**.
27e40 2a 2a 20 5e 49 66 20 74 68 65 20 6e 65 77 20 6c  ** ^If the new l
27e50 69 6d 69 74 20 69 73 20 61 20 6e 65 67 61 74 69  imit is a negati
27e60 76 65 20 6e 75 6d 62 65 72 2c 20 74 68 65 20 6c  ve number, the l
27e70 69 6d 69 74 20 69 73 20 75 6e 63 68 61 6e 67 65  imit is unchange
27e80 64 2e 0a 2a 2a 20 5e 28 46 6f 72 20 65 61 63 68  d..** ^(For each
27e90 20 6c 69 6d 69 74 20 63 61 74 65 67 6f 72 79 20   limit category 
27ea0 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 3c 69 3e  SQLITE_LIMIT_<i>
27eb0 4e 41 4d 45 3c 2f 69 3e 20 74 68 65 72 65 20 69  NAME</i> there i
27ec0 73 20 61 20 0a 2a 2a 20 5b 6c 69 6d 69 74 73 20  s a .** [limits 
27ed0 7c 20 68 61 72 64 20 75 70 70 65 72 20 62 6f 75  | hard upper bou
27ee0 6e 64 5d 0a 2a 2a 20 73 65 74 20 61 74 20 63 6f  nd].** set at co
27ef0 6d 70 69 6c 65 2d 74 69 6d 65 20 62 79 20 61 20  mpile-time by a 
27f00 43 20 70 72 65 70 72 6f 63 65 73 73 6f 72 20 6d  C preprocessor m
27f10 61 63 72 6f 20 63 61 6c 6c 65 64 0a 2a 2a 20 5b  acro called.** [
27f20 6c 69 6d 69 74 73 20 7c 20 53 51 4c 49 54 45 5f  limits | SQLITE_
27f30 4d 41 58 5f 3c 69 3e 4e 41 4d 45 3c 2f 69 3e 5d  MAX_<i>NAME</i>]
27f40 2e 0a 2a 2a 20 28 54 68 65 20 22 5f 4c 49 4d 49  ..** (The "_LIMI
27f50 54 5f 22 20 69 6e 20 74 68 65 20 6e 61 6d 65 20  T_" in the name 
27f60 69 73 20 63 68 61 6e 67 65 64 20 74 6f 20 22 5f  is changed to "_
27f70 4d 41 58 5f 22 2e 29 29 5e 0a 2a 2a 20 5e 41 74  MAX_".))^.** ^At
27f80 74 65 6d 70 74 73 20 74 6f 20 69 6e 63 72 65 61  tempts to increa
27f90 73 65 20 61 20 6c 69 6d 69 74 20 61 62 6f 76 65  se a limit above
27fa0 20 69 74 73 20 68 61 72 64 20 75 70 70 65 72 20   its hard upper 
27fb0 62 6f 75 6e 64 20 61 72 65 0a 2a 2a 20 73 69 6c  bound are.** sil
27fc0 65 6e 74 6c 79 20 74 72 75 6e 63 61 74 65 64 20  ently truncated 
27fd0 74 6f 20 74 68 65 20 68 61 72 64 20 75 70 70 65  to the hard uppe
27fe0 72 20 62 6f 75 6e 64 2e 0a 2a 2a 0a 2a 2a 20 5e  r bound..**.** ^
27ff0 52 65 67 61 72 64 6c 65 73 73 20 6f 66 20 77 68  Regardless of wh
28000 65 74 68 65 72 20 6f 72 20 6e 6f 74 20 74 68 65  ether or not the
28010 20 6c 69 6d 69 74 20 77 61 73 20 63 68 61 6e 67   limit was chang
28020 65 64 2c 20 74 68 65 20 0a 2a 2a 20 5b 73 71 6c  ed, the .** [sql
28030 69 74 65 33 5f 6c 69 6d 69 74 28 29 5d 20 69 6e  ite3_limit()] in
28040 74 65 72 66 61 63 65 20 72 65 74 75 72 6e 73 20  terface returns 
28050 74 68 65 20 70 72 69 6f 72 20 76 61 6c 75 65 20  the prior value 
28060 6f 66 20 74 68 65 20 6c 69 6d 69 74 2e 0a 2a 2a  of the limit..**
28070 20 5e 48 65 6e 63 65 2c 20 74 6f 20 66 69 6e 64   ^Hence, to find
28080 20 74 68 65 20 63 75 72 72 65 6e 74 20 76 61 6c   the current val
28090 75 65 20 6f 66 20 61 20 6c 69 6d 69 74 20 77 69  ue of a limit wi
280a0 74 68 6f 75 74 20 63 68 61 6e 67 69 6e 67 20 69  thout changing i
280b0 74 2c 0a 2a 2a 20 73 69 6d 70 6c 79 20 69 6e 76  t,.** simply inv
280c0 6f 6b 65 20 74 68 69 73 20 69 6e 74 65 72 66 61  oke this interfa
280d0 63 65 20 77 69 74 68 20 74 68 65 20 74 68 69 72  ce with the thir
280e0 64 20 70 61 72 61 6d 65 74 65 72 20 73 65 74 20  d parameter set 
280f0 74 6f 20 2d 31 2e 0a 2a 2a 0a 2a 2a 20 52 75 6e  to -1..**.** Run
28100 2d 74 69 6d 65 20 6c 69 6d 69 74 73 20 61 72 65  -time limits are
28110 20 69 6e 74 65 6e 64 65 64 20 66 6f 72 20 75 73   intended for us
28120 65 20 69 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e  e in application
28130 73 20 74 68 61 74 20 6d 61 6e 61 67 65 0a 2a 2a  s that manage.**
28140 20 62 6f 74 68 20 74 68 65 69 72 20 6f 77 6e 20   both their own 
28150 69 6e 74 65 72 6e 61 6c 20 64 61 74 61 62 61 73  internal databas
28160 65 20 61 6e 64 20 61 6c 73 6f 20 64 61 74 61 62  e and also datab
28170 61 73 65 73 20 74 68 61 74 20 61 72 65 20 63 6f  ases that are co
28180 6e 74 72 6f 6c 6c 65 64 0a 2a 2a 20 62 79 20 75  ntrolled.** by u
28190 6e 74 72 75 73 74 65 64 20 65 78 74 65 72 6e 61  ntrusted externa
281a0 6c 20 73 6f 75 72 63 65 73 2e 20 20 41 6e 20 65  l sources.  An e
281b0 78 61 6d 70 6c 65 20 61 70 70 6c 69 63 61 74 69  xample applicati
281c0 6f 6e 20 6d 69 67 68 74 20 62 65 20 61 0a 2a 2a  on might be a.**
281d0 20 77 65 62 20 62 72 6f 77 73 65 72 20 74 68 61   web browser tha
281e0 74 20 68 61 73 20 69 74 73 20 6f 77 6e 20 64 61  t has its own da
281f0 74 61 62 61 73 65 73 20 66 6f 72 20 73 74 6f 72  tabases for stor
28200 69 6e 67 20 68 69 73 74 6f 72 79 20 61 6e 64 0a  ing history and.
28210 2a 2a 20 73 65 70 61 72 61 74 65 20 64 61 74 61  ** separate data
28220 62 61 73 65 73 20 63 6f 6e 74 72 6f 6c 6c 65 64  bases controlled
28230 20 62 79 20 4a 61 76 61 53 63 72 69 70 74 20 61   by JavaScript a
28240 70 70 6c 69 63 61 74 69 6f 6e 73 20 64 6f 77 6e  pplications down
28250 6c 6f 61 64 65 64 0a 2a 2a 20 6f 66 66 20 74 68  loaded.** off th
28260 65 20 49 6e 74 65 72 6e 65 74 2e 20 20 54 68 65  e Internet.  The
28270 20 69 6e 74 65 72 6e 61 6c 20 64 61 74 61 62 61   internal databa
28280 73 65 73 20 63 61 6e 20 62 65 20 67 69 76 65 6e  ses can be given
28290 20 74 68 65 0a 2a 2a 20 6c 61 72 67 65 2c 20 64   the.** large, d
282a0 65 66 61 75 6c 74 20 6c 69 6d 69 74 73 2e 20 20  efault limits.  
282b0 44 61 74 61 62 61 73 65 73 20 6d 61 6e 61 67 65  Databases manage
282c0 64 20 62 79 20 65 78 74 65 72 6e 61 6c 20 73 6f  d by external so
282d0 75 72 63 65 73 20 63 61 6e 0a 2a 2a 20 62 65 20  urces can.** be 
282e0 67 69 76 65 6e 20 6d 75 63 68 20 73 6d 61 6c 6c  given much small
282f0 65 72 20 6c 69 6d 69 74 73 20 64 65 73 69 67 6e  er limits design
28300 65 64 20 74 6f 20 70 72 65 76 65 6e 74 20 61 20  ed to prevent a 
28310 64 65 6e 69 61 6c 20 6f 66 20 73 65 72 76 69 63  denial of servic
28320 65 0a 2a 2a 20 61 74 74 61 63 6b 2e 20 20 44 65  e.** attack.  De
28330 76 65 6c 6f 70 65 72 73 20 6d 69 67 68 74 20 61  velopers might a
28340 6c 73 6f 20 77 61 6e 74 20 74 6f 20 75 73 65 20  lso want to use 
28350 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 65 74  the [sqlite3_set
28360 5f 61 75 74 68 6f 72 69 7a 65 72 28 29 5d 0a 2a  _authorizer()].*
28370 2a 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20 66  * interface to f
28380 75 72 74 68 65 72 20 63 6f 6e 74 72 6f 6c 20 75  urther control u
28390 6e 74 72 75 73 74 65 64 20 53 51 4c 2e 20 20 54  ntrusted SQL.  T
283a0 68 65 20 73 69 7a 65 20 6f 66 20 74 68 65 20 64  he size of the d
283b0 61 74 61 62 61 73 65 0a 2a 2a 20 63 72 65 61 74  atabase.** creat
283c0 65 64 20 62 79 20 61 6e 20 75 6e 74 72 75 73 74  ed by an untrust
283d0 65 64 20 73 63 72 69 70 74 20 63 61 6e 20 62 65  ed script can be
283e0 20 63 6f 6e 74 61 69 6e 65 64 20 75 73 69 6e 67   contained using
283f0 20 74 68 65 0a 2a 2a 20 5b 6d 61 78 5f 70 61 67   the.** [max_pag
28400 65 5f 63 6f 75 6e 74 5d 20 5b 50 52 41 47 4d 41  e_count] [PRAGMA
28410 5d 2e 0a 2a 2a 0a 2a 2a 20 4e 65 77 20 72 75 6e  ]..**.** New run
28420 2d 74 69 6d 65 20 6c 69 6d 69 74 20 63 61 74 65  -time limit cate
28430 67 6f 72 69 65 73 20 6d 61 79 20 62 65 20 61 64  gories may be ad
28440 64 65 64 20 69 6e 20 66 75 74 75 72 65 20 72 65  ded in future re
28450 6c 65 61 73 65 73 2e 0a 2a 2f 0a 69 6e 74 20 73  leases..*/.int s
28460 71 6c 69 74 65 33 5f 6c 69 6d 69 74 28 73 71 6c  qlite3_limit(sql
28470 69 74 65 33 2a 2c 20 69 6e 74 20 69 64 2c 20 69  ite3*, int id, i
28480 6e 74 20 6e 65 77 56 61 6c 29 3b 0a 0a 2f 2a 0a  nt newVal);../*.
28490 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 52 75 6e  ** CAPI3REF: Run
284a0 2d 54 69 6d 65 20 4c 69 6d 69 74 20 43 61 74 65  -Time Limit Cate
284b0 67 6f 72 69 65 73 0a 2a 2a 20 4b 45 59 57 4f 52  gories.** KEYWOR
284c0 44 53 3a 20 7b 6c 69 6d 69 74 20 63 61 74 65 67  DS: {limit categ
284d0 6f 72 79 7d 20 7b 2a 6c 69 6d 69 74 20 63 61 74  ory} {*limit cat
284e0 65 67 6f 72 69 65 73 7d 0a 2a 2a 0a 2a 2a 20 54  egories}.**.** T
284f0 68 65 73 65 20 63 6f 6e 73 74 61 6e 74 73 20 64  hese constants d
28500 65 66 69 6e 65 20 76 61 72 69 6f 75 73 20 70 65  efine various pe
28510 72 66 6f 72 6d 61 6e 63 65 20 6c 69 6d 69 74 73  rformance limits
28520 0a 2a 2a 20 74 68 61 74 20 63 61 6e 20 62 65 20  .** that can be 
28530 6c 6f 77 65 72 65 64 20 61 74 20 72 75 6e 2d 74  lowered at run-t
28540 69 6d 65 20 75 73 69 6e 67 20 5b 73 71 6c 69 74  ime using [sqlit
28550 65 33 5f 6c 69 6d 69 74 28 29 5d 2e 0a 2a 2a 20  e3_limit()]..** 
28560 54 68 65 20 73 79 6e 6f 70 73 69 73 20 6f 66 20  The synopsis of 
28570 74 68 65 20 6d 65 61 6e 69 6e 67 73 20 6f 66 20  the meanings of 
28580 74 68 65 20 76 61 72 69 6f 75 73 20 6c 69 6d 69  the various limi
28590 74 73 20 69 73 20 73 68 6f 77 6e 20 62 65 6c 6f  ts is shown belo
285a0 77 2e 0a 2a 2a 20 41 64 64 69 74 69 6f 6e 61 6c  w..** Additional
285b0 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 69 73 20   information is 
285c0 61 76 61 69 6c 61 62 6c 65 20 61 74 20 5b 6c 69  available at [li
285d0 6d 69 74 73 20 7c 20 4c 69 6d 69 74 73 20 69 6e  mits | Limits in
285e0 20 53 51 4c 69 74 65 5d 2e 0a 2a 2a 0a 2a 2a 20   SQLite]..**.** 
285f0 3c 64 6c 3e 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45  <dl>.** [[SQLITE
28600 5f 4c 49 4d 49 54 5f 4c 45 4e 47 54 48 5d 5d 20  _LIMIT_LENGTH]] 
28610 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d  ^(<dt>SQLITE_LIM
28620 49 54 5f 4c 45 4e 47 54 48 3c 2f 64 74 3e 0a 2a  IT_LENGTH</dt>.*
28630 2a 20 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d 75  * <dd>The maximu
28640 6d 20 73 69 7a 65 20 6f 66 20 61 6e 79 20 73 74  m size of any st
28650 72 69 6e 67 20 6f 72 20 42 4c 4f 42 20 6f 72 20  ring or BLOB or 
28660 74 61 62 6c 65 20 72 6f 77 2c 20 69 6e 20 62 79  table row, in by
28670 74 65 73 2e 3c 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a  tes.<dd>)^.**.**
28680 20 5b 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f   [[SQLITE_LIMIT_
28690 53 51 4c 5f 4c 45 4e 47 54 48 5d 5d 20 5e 28 3c  SQL_LENGTH]] ^(<
286a0 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f  dt>SQLITE_LIMIT_
286b0 53 51 4c 5f 4c 45 4e 47 54 48 3c 2f 64 74 3e 0a  SQL_LENGTH</dt>.
286c0 2a 2a 20 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d  ** <dd>The maxim
286d0 75 6d 20 6c 65 6e 67 74 68 20 6f 66 20 61 6e 20  um length of an 
286e0 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2c 20 69  SQL statement, i
286f0 6e 20 62 79 74 65 73 2e 3c 2f 64 64 3e 29 5e 0a  n bytes.</dd>)^.
28700 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 4c  **.** [[SQLITE_L
28710 49 4d 49 54 5f 43 4f 4c 55 4d 4e 5d 5d 20 5e 28  IMIT_COLUMN]] ^(
28720 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54  <dt>SQLITE_LIMIT
28730 5f 43 4f 4c 55 4d 4e 3c 2f 64 74 3e 0a 2a 2a 20  _COLUMN</dt>.** 
28740 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20  <dd>The maximum 
28750 6e 75 6d 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e  number of column
28760 73 20 69 6e 20 61 20 74 61 62 6c 65 20 64 65 66  s in a table def
28770 69 6e 69 74 69 6f 6e 20 6f 72 20 69 6e 20 74 68  inition or in th
28780 65 0a 2a 2a 20 72 65 73 75 6c 74 20 73 65 74 20  e.** result set 
28790 6f 66 20 61 20 5b 53 45 4c 45 43 54 5d 20 6f 72  of a [SELECT] or
287a0 20 74 68 65 20 6d 61 78 69 6d 75 6d 20 6e 75 6d   the maximum num
287b0 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 20 69  ber of columns i
287c0 6e 20 61 6e 20 69 6e 64 65 78 0a 2a 2a 20 6f 72  n an index.** or
287d0 20 69 6e 20 61 6e 20 4f 52 44 45 52 20 42 59 20   in an ORDER BY 
287e0 6f 72 20 47 52 4f 55 50 20 42 59 20 63 6c 61 75  or GROUP BY clau
287f0 73 65 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a  se.</dd>)^.**.**
28800 20 5b 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f   [[SQLITE_LIMIT_
28810 45 58 50 52 5f 44 45 50 54 48 5d 5d 20 5e 28 3c  EXPR_DEPTH]] ^(<
28820 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f  dt>SQLITE_LIMIT_
28830 45 58 50 52 5f 44 45 50 54 48 3c 2f 64 74 3e 0a  EXPR_DEPTH</dt>.
28840 2a 2a 20 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d  ** <dd>The maxim
28850 75 6d 20 64 65 70 74 68 20 6f 66 20 74 68 65 20  um depth of the 
28860 70 61 72 73 65 20 74 72 65 65 20 6f 6e 20 61 6e  parse tree on an
28870 79 20 65 78 70 72 65 73 73 69 6f 6e 2e 3c 2f 64  y expression.</d
28880 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c  d>)^.**.** [[SQL
28890 49 54 45 5f 4c 49 4d 49 54 5f 43 4f 4d 50 4f 55  ITE_LIMIT_COMPOU
288a0 4e 44 5f 53 45 4c 45 43 54 5d 5d 20 5e 28 3c 64  ND_SELECT]] ^(<d
288b0 74 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 43  t>SQLITE_LIMIT_C
288c0 4f 4d 50 4f 55 4e 44 5f 53 45 4c 45 43 54 3c 2f  OMPOUND_SELECT</
288d0 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 6d  dt>.** <dd>The m
288e0 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f 66  aximum number of
288f0 20 74 65 72 6d 73 20 69 6e 20 61 20 63 6f 6d 70   terms in a comp
28900 6f 75 6e 64 20 53 45 4c 45 43 54 20 73 74 61 74  ound SELECT stat
28910 65 6d 65 6e 74 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a  ement.</dd>)^.**
28920 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 4c 49 4d  .** [[SQLITE_LIM
28930 49 54 5f 56 44 42 45 5f 4f 50 5d 5d 20 5e 28 3c  IT_VDBE_OP]] ^(<
28940 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f  dt>SQLITE_LIMIT_
28950 56 44 42 45 5f 4f 50 3c 2f 64 74 3e 0a 2a 2a 20  VDBE_OP</dt>.** 
28960 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20  <dd>The maximum 
28970 6e 75 6d 62 65 72 20 6f 66 20 69 6e 73 74 72 75  number of instru
28980 63 74 69 6f 6e 73 20 69 6e 20 61 20 76 69 72 74  ctions in a virt
28990 75 61 6c 20 6d 61 63 68 69 6e 65 20 70 72 6f 67  ual machine prog
289a0 72 61 6d 0a 2a 2a 20 75 73 65 64 20 74 6f 20 69  ram.** used to i
289b0 6d 70 6c 65 6d 65 6e 74 20 61 6e 20 53 51 4c 20  mplement an SQL 
289c0 73 74 61 74 65 6d 65 6e 74 2e 20 20 54 68 69 73  statement.  This
289d0 20 6c 69 6d 69 74 20 69 73 20 6e 6f 74 20 63 75   limit is not cu
289e0 72 72 65 6e 74 6c 79 0a 2a 2a 20 65 6e 66 6f 72  rrently.** enfor
289f0 63 65 64 2c 20 74 68 6f 75 67 68 20 74 68 61 74  ced, though that
28a00 20 6d 69 67 68 74 20 62 65 20 61 64 64 65 64 20   might be added 
28a10 69 6e 20 73 6f 6d 65 20 66 75 74 75 72 65 20 72  in some future r
28a20 65 6c 65 61 73 65 20 6f 66 0a 2a 2a 20 53 51 4c  elease of.** SQL
28a30 69 74 65 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 0a 2a  ite.</dd>)^.**.*
28a40 2a 20 5b 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54  * [[SQLITE_LIMIT
28a50 5f 46 55 4e 43 54 49 4f 4e 5f 41 52 47 5d 5d 20  _FUNCTION_ARG]] 
28a60 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d  ^(<dt>SQLITE_LIM
28a70 49 54 5f 46 55 4e 43 54 49 4f 4e 5f 41 52 47 3c  IT_FUNCTION_ARG<
28a80 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20  /dt>.** <dd>The 
28a90 6d 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f  maximum number o
28aa0 66 20 61 72 67 75 6d 65 6e 74 73 20 6f 6e 20 61  f arguments on a
28ab0 20 66 75 6e 63 74 69 6f 6e 2e 3c 2f 64 64 3e 29   function.</dd>)
28ac0 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45  ^.**.** [[SQLITE
28ad0 5f 4c 49 4d 49 54 5f 41 54 54 41 43 48 45 44 5d  _LIMIT_ATTACHED]
28ae0 5d 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f 4c  ] ^(<dt>SQLITE_L
28af0 49 4d 49 54 5f 41 54 54 41 43 48 45 44 3c 2f 64  IMIT_ATTACHED</d
28b00 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 6d 61  t>.** <dd>The ma
28b10 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f 66 20  ximum number of 
28b20 5b 41 54 54 41 43 48 20 7c 20 61 74 74 61 63 68  [ATTACH | attach
28b30 65 64 20 64 61 74 61 62 61 73 65 73 5d 2e 29 5e  ed databases].)^
28b40 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51  </dd>.**.** [[SQ
28b50 4c 49 54 45 5f 4c 49 4d 49 54 5f 4c 49 4b 45 5f  LITE_LIMIT_LIKE_
28b60 50 41 54 54 45 52 4e 5f 4c 45 4e 47 54 48 5d 5d  PATTERN_LENGTH]]
28b70 0a 2a 2a 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45  .** ^(<dt>SQLITE
28b80 5f 4c 49 4d 49 54 5f 4c 49 4b 45 5f 50 41 54 54  _LIMIT_LIKE_PATT
28b90 45 52 4e 5f 4c 45 4e 47 54 48 3c 2f 64 74 3e 0a  ERN_LENGTH</dt>.
28ba0 2a 2a 20 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d  ** <dd>The maxim
28bb0 75 6d 20 6c 65 6e 67 74 68 20 6f 66 20 74 68 65  um length of the
28bc0 20 70 61 74 74 65 72 6e 20 61 72 67 75 6d 65 6e   pattern argumen
28bd0 74 20 74 6f 20 74 68 65 20 5b 4c 49 4b 45 5d 20  t to the [LIKE] 
28be0 6f 72 0a 2a 2a 20 5b 47 4c 4f 42 5d 20 6f 70 65  or.** [GLOB] ope
28bf0 72 61 74 6f 72 73 2e 3c 2f 64 64 3e 29 5e 0a 2a  rators.</dd>)^.*
28c00 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 4c 49  *.** [[SQLITE_LI
28c10 4d 49 54 5f 56 41 52 49 41 42 4c 45 5f 4e 55 4d  MIT_VARIABLE_NUM
28c20 42 45 52 5d 5d 0a 2a 2a 20 5e 28 3c 64 74 3e 53  BER]].** ^(<dt>S
28c30 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 56 41 52 49  QLITE_LIMIT_VARI
28c40 41 42 4c 45 5f 4e 55 4d 42 45 52 3c 2f 64 74 3e  ABLE_NUMBER</dt>
28c50 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 6d 61 78 69  .** <dd>The maxi
28c60 6d 75 6d 20 69 6e 64 65 78 20 6e 75 6d 62 65 72  mum index number
28c70 20 6f 66 20 61 6e 79 20 5b 70 61 72 61 6d 65 74   of any [paramet
28c80 65 72 5d 20 69 6e 20 61 6e 20 53 51 4c 20 73 74  er] in an SQL st
28c90 61 74 65 6d 65 6e 74 2e 29 5e 0a 2a 2a 0a 2a 2a  atement.)^.**.**
28ca0 20 5b 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f   [[SQLITE_LIMIT_
28cb0 54 52 49 47 47 45 52 5f 44 45 50 54 48 5d 5d 20  TRIGGER_DEPTH]] 
28cc0 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d  ^(<dt>SQLITE_LIM
28cd0 49 54 5f 54 52 49 47 47 45 52 5f 44 45 50 54 48  IT_TRIGGER_DEPTH
28ce0 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65  </dt>.** <dd>The
28cf0 20 6d 61 78 69 6d 75 6d 20 64 65 70 74 68 20 6f   maximum depth o
28d00 66 20 72 65 63 75 72 73 69 6f 6e 20 66 6f 72 20  f recursion for 
28d10 74 72 69 67 67 65 72 73 2e 3c 2f 64 64 3e 29 5e  triggers.</dd>)^
28d20 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f  .**.** [[SQLITE_
28d30 4c 49 4d 49 54 5f 57 4f 52 4b 45 52 5f 54 48 52  LIMIT_WORKER_THR
28d40 45 41 44 53 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c  EADS]] ^(<dt>SQL
28d50 49 54 45 5f 4c 49 4d 49 54 5f 57 4f 52 4b 45 52  ITE_LIMIT_WORKER
28d60 5f 54 48 52 45 41 44 53 3c 2f 64 74 3e 0a 2a 2a  _THREADS</dt>.**
28d70 20 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d   <dd>The maximum
28d80 20 6e 75 6d 62 65 72 20 6f 66 20 61 75 78 69 6c   number of auxil
28d90 69 61 72 79 20 77 6f 72 6b 65 72 20 74 68 72 65  iary worker thre
28da0 61 64 73 20 74 68 61 74 20 61 20 73 69 6e 67 6c  ads that a singl
28db0 65 0a 2a 2a 20 5b 70 72 65 70 61 72 65 64 20 73  e.** [prepared s
28dc0 74 61 74 65 6d 65 6e 74 5d 20 6d 61 79 20 73 74  tatement] may st
28dd0 61 72 74 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 20 3c  art.</dd>)^.** <
28de0 2f 64 6c 3e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20  /dl>.*/.#define 
28df0 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 4c 45 4e  SQLITE_LIMIT_LEN
28e00 47 54 48 20 20 20 20 20 20 20 20 20 20 20 20 20  GTH             
28e10 20 20 20 20 20 20 20 30 0a 23 64 65 66 69 6e 65         0.#define
28e20 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 53 51   SQLITE_LIMIT_SQ
28e30 4c 5f 4c 45 4e 47 54 48 20 20 20 20 20 20 20 20  L_LENGTH        
28e40 20 20 20 20 20 20 20 20 31 0a 23 64 65 66 69 6e          1.#defin
28e50 65 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 43  e SQLITE_LIMIT_C
28e60 4f 4c 55 4d 4e 20 20 20 20 20 20 20 20 20 20 20  OLUMN           
28e70 20 20 20 20 20 20 20 20 20 32 0a 23 64 65 66 69           2.#defi
28e80 6e 65 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f  ne SQLITE_LIMIT_
28e90 45 58 50 52 5f 44 45 50 54 48 20 20 20 20 20 20  EXPR_DEPTH      
28ea0 20 20 20 20 20 20 20 20 20 20 33 0a 23 64 65 66            3.#def
28eb0 69 6e 65 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54  ine SQLITE_LIMIT
28ec0 5f 43 4f 4d 50 4f 55 4e 44 5f 53 45 4c 45 43 54  _COMPOUND_SELECT
28ed0 20 20 20 20 20 20 20 20 20 20 20 34 0a 23 64 65             4.#de
28ee0 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c 49 4d 49  fine SQLITE_LIMI
28ef0 54 5f 56 44 42 45 5f 4f 50 20 20 20 20 20 20 20  T_VDBE_OP       
28f00 20 20 20 20 20 20 20 20 20 20 20 20 35 0a 23 64              5.#d
28f10 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c 49 4d  efine SQLITE_LIM
28f20 49 54 5f 46 55 4e 43 54 49 4f 4e 5f 41 52 47 20  IT_FUNCTION_ARG 
28f30 20 20 20 20 20 20 20 20 20 20 20 20 20 36 0a 23               6.#
28f40 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c 49  define SQLITE_LI
28f50 4d 49 54 5f 41 54 54 41 43 48 45 44 20 20 20 20  MIT_ATTACHED    
28f60 20 20 20 20 20 20 20 20 20 20 20 20 20 20 37 0a                7.
28f70 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c  #define SQLITE_L
28f80 49 4d 49 54 5f 4c 49 4b 45 5f 50 41 54 54 45 52  IMIT_LIKE_PATTER
28f90 4e 5f 4c 45 4e 47 54 48 20 20 20 20 20 20 20 38  N_LENGTH       8
28fa0 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
28fb0 4c 49 4d 49 54 5f 56 41 52 49 41 42 4c 45 5f 4e  LIMIT_VARIABLE_N
28fc0 55 4d 42 45 52 20 20 20 20 20 20 20 20 20 20 20  UMBER           
28fd0 39 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  9.#define SQLITE
28fe0 5f 4c 49 4d 49 54 5f 54 52 49 47 47 45 52 5f 44  _LIMIT_TRIGGER_D
28ff0 45 50 54 48 20 20 20 20 20 20 20 20 20 20 20 20  EPTH            
29000 31 30 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  10.#define SQLIT
29010 45 5f 4c 49 4d 49 54 5f 57 4f 52 4b 45 52 5f 54  E_LIMIT_WORKER_T
29020 48 52 45 41 44 53 20 20 20 20 20 20 20 20 20 20  HREADS          
29030 20 31 31 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33   11../*.** CAPI3
29040 52 45 46 3a 20 43 6f 6d 70 69 6c 69 6e 67 20 41  REF: Compiling A
29050 6e 20 53 51 4c 20 53 74 61 74 65 6d 65 6e 74 0a  n SQL Statement.
29060 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b 53 51  ** KEYWORDS: {SQ
29070 4c 20 73 74 61 74 65 6d 65 6e 74 20 63 6f 6d 70  L statement comp
29080 69 6c 65 72 7d 0a 2a 2a 20 4d 45 54 48 4f 44 3a  iler}.** METHOD:
29090 20 73 71 6c 69 74 65 33 0a 2a 2a 20 43 4f 4e 53   sqlite3.** CONS
290a0 54 52 55 43 54 4f 52 3a 20 73 71 6c 69 74 65 33  TRUCTOR: sqlite3
290b0 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 54 6f 20 65  _stmt.**.** To e
290c0 78 65 63 75 74 65 20 61 6e 20 53 51 4c 20 71 75  xecute an SQL qu
290d0 65 72 79 2c 20 69 74 20 6d 75 73 74 20 66 69 72  ery, it must fir
290e0 73 74 20 62 65 20 63 6f 6d 70 69 6c 65 64 20 69  st be compiled i
290f0 6e 74 6f 20 61 20 62 79 74 65 2d 63 6f 64 65 0a  nto a byte-code.
29100 2a 2a 20 70 72 6f 67 72 61 6d 20 75 73 69 6e 67  ** program using
29110 20 6f 6e 65 20 6f 66 20 74 68 65 73 65 20 72 6f   one of these ro
29120 75 74 69 6e 65 73 2e 0a 2a 2a 0a 2a 2a 20 54 68  utines..**.** Th
29130 65 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74  e first argument
29140 2c 20 22 64 62 22 2c 20 69 73 20 61 20 5b 64 61  , "db", is a [da
29150 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
29160 6e 5d 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d  n] obtained from
29170 20 61 0a 2a 2a 20 70 72 69 6f 72 20 73 75 63 63   a.** prior succ
29180 65 73 73 66 75 6c 20 63 61 6c 6c 20 74 6f 20 5b  essful call to [
29190 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 5d 2c  sqlite3_open()],
291a0 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76   [sqlite3_open_v
291b0 32 28 29 5d 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69  2()] or.** [sqli
291c0 74 65 33 5f 6f 70 65 6e 31 36 28 29 5d 2e 20 20  te3_open16()].  
291d0 54 68 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e  The database con
291e0 6e 65 63 74 69 6f 6e 20 6d 75 73 74 20 6e 6f 74  nection must not
291f0 20 68 61 76 65 20 62 65 65 6e 20 63 6c 6f 73 65   have been close
29200 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 65 63  d..**.** The sec
29210 6f 6e 64 20 61 72 67 75 6d 65 6e 74 2c 20 22 7a  ond argument, "z
29220 53 71 6c 22 2c 20 69 73 20 74 68 65 20 73 74 61  Sql", is the sta
29230 74 65 6d 65 6e 74 20 74 6f 20 62 65 20 63 6f 6d  tement to be com
29240 70 69 6c 65 64 2c 20 65 6e 63 6f 64 65 64 0a 2a  piled, encoded.*
29250 2a 20 61 73 20 65 69 74 68 65 72 20 55 54 46 2d  * as either UTF-
29260 38 20 6f 72 20 55 54 46 2d 31 36 2e 20 20 54 68  8 or UTF-16.  Th
29270 65 20 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72  e sqlite3_prepar
29280 65 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f  e() and sqlite3_
29290 70 72 65 70 61 72 65 5f 76 32 28 29 0a 2a 2a 20  prepare_v2().** 
292a0 69 6e 74 65 72 66 61 63 65 73 20 75 73 65 20 55  interfaces use U
292b0 54 46 2d 38 2c 20 61 6e 64 20 73 71 6c 69 74 65  TF-8, and sqlite
292c0 33 5f 70 72 65 70 61 72 65 31 36 28 29 20 61 6e  3_prepare16() an
292d0 64 20 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72  d sqlite3_prepar
292e0 65 31 36 5f 76 32 28 29 0a 2a 2a 20 75 73 65 20  e16_v2().** use 
292f0 55 54 46 2d 31 36 2e 0a 2a 2a 0a 2a 2a 20 5e 49  UTF-16..**.** ^I
29300 66 20 74 68 65 20 6e 42 79 74 65 20 61 72 67 75  f the nByte argu
29310 6d 65 6e 74 20 69 73 20 6e 65 67 61 74 69 76 65  ment is negative
29320 2c 20 74 68 65 6e 20 7a 53 71 6c 20 69 73 20 72  , then zSql is r
29330 65 61 64 20 75 70 20 74 6f 20 74 68 65 0a 2a 2a  ead up to the.**
29340 20 66 69 72 73 74 20 7a 65 72 6f 20 74 65 72 6d   first zero term
29350 69 6e 61 74 6f 72 2e 20 5e 49 66 20 6e 42 79 74  inator. ^If nByt
29360 65 20 69 73 20 70 6f 73 69 74 69 76 65 2c 20 74  e is positive, t
29370 68 65 6e 20 69 74 20 69 73 20 74 68 65 0a 2a 2a  hen it is the.**
29380 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73   number of bytes
29390 20 72 65 61 64 20 66 72 6f 6d 20 7a 53 71 6c 2e   read from zSql.
293a0 20 20 5e 49 66 20 6e 42 79 74 65 20 69 73 20 7a    ^If nByte is z
293b0 65 72 6f 2c 20 74 68 65 6e 20 6e 6f 20 70 72 65  ero, then no pre
293c0 70 61 72 65 64 0a 2a 2a 20 73 74 61 74 65 6d 65  pared.** stateme
293d0 6e 74 20 69 73 20 67 65 6e 65 72 61 74 65 64 2e  nt is generated.
293e0 0a 2a 2a 20 49 66 20 74 68 65 20 63 61 6c 6c 65  .** If the calle
293f0 72 20 6b 6e 6f 77 73 20 74 68 61 74 20 74 68 65  r knows that the
29400 20 73 75 70 70 6c 69 65 64 20 73 74 72 69 6e 67   supplied string
29410 20 69 73 20 6e 75 6c 2d 74 65 72 6d 69 6e 61 74   is nul-terminat
29420 65 64 2c 20 74 68 65 6e 0a 2a 2a 20 74 68 65 72  ed, then.** ther
29430 65 20 69 73 20 61 20 73 6d 61 6c 6c 20 70 65 72  e is a small per
29440 66 6f 72 6d 61 6e 63 65 20 61 64 76 61 6e 74 61  formance advanta
29450 67 65 20 74 6f 20 70 61 73 73 69 6e 67 20 61 6e  ge to passing an
29460 20 6e 42 79 74 65 20 70 61 72 61 6d 65 74 65 72   nByte parameter
29470 20 74 68 61 74 0a 2a 2a 20 69 73 20 74 68 65 20   that.** is the 
29480 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73 20  number of bytes 
29490 69 6e 20 74 68 65 20 69 6e 70 75 74 20 73 74 72  in the input str
294a0 69 6e 67 20 3c 69 3e 69 6e 63 6c 75 64 69 6e 67  ing <i>including
294b0 3c 2f 69 3e 0a 2a 2a 20 74 68 65 20 6e 75 6c 2d  </i>.** the nul-
294c0 74 65 72 6d 69 6e 61 74 6f 72 2e 0a 2a 2a 0a 2a  terminator..**.*
294d0 2a 20 5e 49 66 20 70 7a 54 61 69 6c 20 69 73 20  * ^If pzTail is 
294e0 6e 6f 74 20 4e 55 4c 4c 20 74 68 65 6e 20 2a 70  not NULL then *p
294f0 7a 54 61 69 6c 20 69 73 20 6d 61 64 65 20 74 6f  zTail is made to
29500 20 70 6f 69 6e 74 20 74 6f 20 74 68 65 20 66 69   point to the fi
29510 72 73 74 20 62 79 74 65 0a 2a 2a 20 70 61 73 74  rst byte.** past
29520 20 74 68 65 20 65 6e 64 20 6f 66 20 74 68 65 20   the end of the 
29530 66 69 72 73 74 20 53 51 4c 20 73 74 61 74 65 6d  first SQL statem
29540 65 6e 74 20 69 6e 20 7a 53 71 6c 2e 20 20 54 68  ent in zSql.  Th
29550 65 73 65 20 72 6f 75 74 69 6e 65 73 20 6f 6e 6c  ese routines onl
29560 79 0a 2a 2a 20 63 6f 6d 70 69 6c 65 20 74 68 65  y.** compile the
29570 20 66 69 72 73 74 20 73 74 61 74 65 6d 65 6e 74   first statement
29580 20 69 6e 20 7a 53 71 6c 2c 20 73 6f 20 2a 70 7a   in zSql, so *pz
29590 54 61 69 6c 20 69 73 20 6c 65 66 74 20 70 6f 69  Tail is left poi
295a0 6e 74 69 6e 67 20 74 6f 0a 2a 2a 20 77 68 61 74  nting to.** what
295b0 20 72 65 6d 61 69 6e 73 20 75 6e 63 6f 6d 70 69   remains uncompi
295c0 6c 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 2a 70 70 53  led..**.** ^*ppS
295d0 74 6d 74 20 69 73 20 6c 65 66 74 20 70 6f 69 6e  tmt is left poin
295e0 74 69 6e 67 20 74 6f 20 61 20 63 6f 6d 70 69 6c  ting to a compil
295f0 65 64 20 5b 70 72 65 70 61 72 65 64 20 73 74 61  ed [prepared sta
29600 74 65 6d 65 6e 74 5d 20 74 68 61 74 20 63 61 6e  tement] that can
29610 20 62 65 0a 2a 2a 20 65 78 65 63 75 74 65 64 20   be.** executed 
29620 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 73  using [sqlite3_s
29630 74 65 70 28 29 5d 2e 20 20 5e 49 66 20 74 68 65  tep()].  ^If the
29640 72 65 20 69 73 20 61 6e 20 65 72 72 6f 72 2c 20  re is an error, 
29650 2a 70 70 53 74 6d 74 20 69 73 20 73 65 74 0a 2a  *ppStmt is set.*
29660 2a 20 74 6f 20 4e 55 4c 4c 2e 20 20 5e 49 66 20  * to NULL.  ^If 
29670 74 68 65 20 69 6e 70 75 74 20 74 65 78 74 20 63  the input text c
29680 6f 6e 74 61 69 6e 73 20 6e 6f 20 53 51 4c 20 28  ontains no SQL (
29690 69 66 20 74 68 65 20 69 6e 70 75 74 20 69 73 20  if the input is 
296a0 61 6e 20 65 6d 70 74 79 0a 2a 2a 20 73 74 72 69  an empty.** stri
296b0 6e 67 20 6f 72 20 61 20 63 6f 6d 6d 65 6e 74 29  ng or a comment)
296c0 20 74 68 65 6e 20 2a 70 70 53 74 6d 74 20 69 73   then *ppStmt is
296d0 20 73 65 74 20 74 6f 20 4e 55 4c 4c 2e 0a 2a 2a   set to NULL..**
296e0 20 54 68 65 20 63 61 6c 6c 69 6e 67 20 70 72 6f   The calling pro
296f0 63 65 64 75 72 65 20 69 73 20 72 65 73 70 6f 6e  cedure is respon
29700 73 69 62 6c 65 20 66 6f 72 20 64 65 6c 65 74 69  sible for deleti
29710 6e 67 20 74 68 65 20 63 6f 6d 70 69 6c 65 64 0a  ng the compiled.
29720 2a 2a 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  ** SQL statement
29730 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f   using [sqlite3_
29740 66 69 6e 61 6c 69 7a 65 28 29 5d 20 61 66 74 65  finalize()] afte
29750 72 20 69 74 20 68 61 73 20 66 69 6e 69 73 68 65  r it has finishe
29760 64 20 77 69 74 68 20 69 74 2e 0a 2a 2a 20 70 70  d with it..** pp
29770 53 74 6d 74 20 6d 61 79 20 6e 6f 74 20 62 65 20  Stmt may not be 
29780 4e 55 4c 4c 2e 0a 2a 2a 0a 2a 2a 20 5e 4f 6e 20  NULL..**.** ^On 
29790 73 75 63 63 65 73 73 2c 20 74 68 65 20 73 71 6c  success, the sql
297a0 69 74 65 33 5f 70 72 65 70 61 72 65 28 29 20 66  ite3_prepare() f
297b0 61 6d 69 6c 79 20 6f 66 20 72 6f 75 74 69 6e 65  amily of routine
297c0 73 20 72 65 74 75 72 6e 20 5b 53 51 4c 49 54 45  s return [SQLITE
297d0 5f 4f 4b 5d 3b 0a 2a 2a 20 6f 74 68 65 72 77 69  _OK];.** otherwi
297e0 73 65 20 61 6e 20 5b 65 72 72 6f 72 20 63 6f 64  se an [error cod
297f0 65 5d 20 69 73 20 72 65 74 75 72 6e 65 64 2e 0a  e] is returned..
29800 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65  **.** The sqlite
29810 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29 20 61  3_prepare_v2() a
29820 6e 64 20 73 71 6c 69 74 65 33 5f 70 72 65 70 61  nd sqlite3_prepa
29830 72 65 31 36 5f 76 32 28 29 20 69 6e 74 65 72 66  re16_v2() interf
29840 61 63 65 73 20 61 72 65 0a 2a 2a 20 72 65 63 6f  aces are.** reco
29850 6d 6d 65 6e 64 65 64 20 66 6f 72 20 61 6c 6c 20  mmended for all 
29860 6e 65 77 20 70 72 6f 67 72 61 6d 73 2e 20 54 68  new programs. Th
29870 65 20 74 77 6f 20 6f 6c 64 65 72 20 69 6e 74 65  e two older inte
29880 72 66 61 63 65 73 20 61 72 65 20 72 65 74 61 69  rfaces are retai
29890 6e 65 64 0a 2a 2a 20 66 6f 72 20 62 61 63 6b 77  ned.** for backw
298a0 61 72 64 73 20 63 6f 6d 70 61 74 69 62 69 6c 69  ards compatibili
298b0 74 79 2c 20 62 75 74 20 74 68 65 69 72 20 75 73  ty, but their us
298c0 65 20 69 73 20 64 69 73 63 6f 75 72 61 67 65 64  e is discouraged
298d0 2e 0a 2a 2a 20 5e 49 6e 20 74 68 65 20 22 76 32  ..** ^In the "v2
298e0 22 20 69 6e 74 65 72 66 61 63 65 73 2c 20 74 68  " interfaces, th
298f0 65 20 70 72 65 70 61 72 65 64 20 73 74 61 74 65  e prepared state
29900 6d 65 6e 74 0a 2a 2a 20 74 68 61 74 20 69 73 20  ment.** that is 
29910 72 65 74 75 72 6e 65 64 20 28 74 68 65 20 5b 73  returned (the [s
29920 71 6c 69 74 65 33 5f 73 74 6d 74 5d 20 6f 62 6a  qlite3_stmt] obj
29930 65 63 74 29 20 63 6f 6e 74 61 69 6e 73 20 61 20  ect) contains a 
29940 63 6f 70 79 20 6f 66 20 74 68 65 0a 2a 2a 20 6f  copy of the.** o
29950 72 69 67 69 6e 61 6c 20 53 51 4c 20 74 65 78 74  riginal SQL text
29960 2e 20 54 68 69 73 20 63 61 75 73 65 73 20 74 68  . This causes th
29970 65 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28  e [sqlite3_step(
29980 29 5d 20 69 6e 74 65 72 66 61 63 65 20 74 6f 0a  )] interface to.
29990 2a 2a 20 62 65 68 61 76 65 20 64 69 66 66 65 72  ** behave differ
299a0 65 6e 74 6c 79 20 69 6e 20 74 68 72 65 65 20 77  ently in three w
299b0 61 79 73 3a 0a 2a 2a 0a 2a 2a 20 3c 6f 6c 3e 0a  ays:.**.** <ol>.
299c0 2a 2a 20 3c 6c 69 3e 0a 2a 2a 20 5e 49 66 20 74  ** <li>.** ^If t
299d0 68 65 20 64 61 74 61 62 61 73 65 20 73 63 68 65  he database sche
299e0 6d 61 20 63 68 61 6e 67 65 73 2c 20 69 6e 73 74  ma changes, inst
299f0 65 61 64 20 6f 66 20 72 65 74 75 72 6e 69 6e 67  ead of returning
29a00 20 5b 53 51 4c 49 54 45 5f 53 43 48 45 4d 41 5d   [SQLITE_SCHEMA]
29a10 20 61 73 20 69 74 0a 2a 2a 20 61 6c 77 61 79 73   as it.** always
29a20 20 75 73 65 64 20 74 6f 20 64 6f 2c 20 5b 73 71   used to do, [sq
29a30 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 77 69  lite3_step()] wi
29a40 6c 6c 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79  ll automatically
29a50 20 72 65 63 6f 6d 70 69 6c 65 20 74 68 65 20 53   recompile the S
29a60 51 4c 0a 2a 2a 20 73 74 61 74 65 6d 65 6e 74 20  QL.** statement 
29a70 61 6e 64 20 74 72 79 20 74 6f 20 72 75 6e 20 69  and try to run i
29a80 74 20 61 67 61 69 6e 2e 20 41 73 20 6d 61 6e 79  t again. As many
29a90 20 61 73 20 5b 53 51 4c 49 54 45 5f 4d 41 58 5f   as [SQLITE_MAX_
29aa0 53 43 48 45 4d 41 5f 52 45 54 52 59 5d 0a 2a 2a  SCHEMA_RETRY].**
29ab0 20 72 65 74 72 69 65 73 20 77 69 6c 6c 20 6f 63   retries will oc
29ac0 63 75 72 20 62 65 66 6f 72 65 20 73 71 6c 69 74  cur before sqlit
29ad0 65 33 5f 73 74 65 70 28 29 20 67 69 76 65 73 20  e3_step() gives 
29ae0 75 70 20 61 6e 64 20 72 65 74 75 72 6e 73 20 61  up and returns a
29af0 6e 20 65 72 72 6f 72 2e 0a 2a 2a 20 3c 2f 6c 69  n error..** </li
29b00 3e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 0a 2a 2a 20  >.**.** <li>.** 
29b10 5e 57 68 65 6e 20 61 6e 20 65 72 72 6f 72 20 6f  ^When an error o
29b20 63 63 75 72 73 2c 20 5b 73 71 6c 69 74 65 33 5f  ccurs, [sqlite3_
29b30 73 74 65 70 28 29 5d 20 77 69 6c 6c 20 72 65 74  step()] will ret
29b40 75 72 6e 20 6f 6e 65 20 6f 66 20 74 68 65 20 64  urn one of the d
29b50 65 74 61 69 6c 65 64 0a 2a 2a 20 5b 65 72 72 6f  etailed.** [erro
29b60 72 20 63 6f 64 65 73 5d 20 6f 72 20 5b 65 78 74  r codes] or [ext
29b70 65 6e 64 65 64 20 65 72 72 6f 72 20 63 6f 64 65  ended error code
29b80 73 5d 2e 20 20 5e 54 68 65 20 6c 65 67 61 63 79  s].  ^The legacy
29b90 20 62 65 68 61 76 69 6f 72 20 77 61 73 20 74 68   behavior was th
29ba0 61 74 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 73  at.** [sqlite3_s
29bb0 74 65 70 28 29 5d 20 77 6f 75 6c 64 20 6f 6e 6c  tep()] would onl
29bc0 79 20 72 65 74 75 72 6e 20 61 20 67 65 6e 65 72  y return a gener
29bd0 69 63 20 5b 53 51 4c 49 54 45 5f 45 52 52 4f 52  ic [SQLITE_ERROR
29be0 5d 20 72 65 73 75 6c 74 20 63 6f 64 65 0a 2a 2a  ] result code.**
29bf0 20 61 6e 64 20 74 68 65 20 61 70 70 6c 69 63 61   and the applica
29c00 74 69 6f 6e 20 77 6f 75 6c 64 20 68 61 76 65 20  tion would have 
29c10 74 6f 20 6d 61 6b 65 20 61 20 73 65 63 6f 6e 64  to make a second
29c20 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 65   call to [sqlite
29c30 33 5f 72 65 73 65 74 28 29 5d 0a 2a 2a 20 69 6e  3_reset()].** in
29c40 20 6f 72 64 65 72 20 74 6f 20 66 69 6e 64 20 74   order to find t
29c50 68 65 20 75 6e 64 65 72 6c 79 69 6e 67 20 63 61  he underlying ca
29c60 75 73 65 20 6f 66 20 74 68 65 20 70 72 6f 62 6c  use of the probl
29c70 65 6d 2e 20 57 69 74 68 20 74 68 65 20 22 76 32  em. With the "v2
29c80 22 20 70 72 65 70 61 72 65 0a 2a 2a 20 69 6e 74  " prepare.** int
29c90 65 72 66 61 63 65 73 2c 20 74 68 65 20 75 6e 64  erfaces, the und
29ca0 65 72 6c 79 69 6e 67 20 72 65 61 73 6f 6e 20 66  erlying reason f
29cb0 6f 72 20 74 68 65 20 65 72 72 6f 72 20 69 73 20  or the error is 
29cc0 72 65 74 75 72 6e 65 64 20 69 6d 6d 65 64 69 61  returned immedia
29cd0 74 65 6c 79 2e 0a 2a 2a 20 3c 2f 6c 69 3e 0a 2a  tely..** </li>.*
29ce0 2a 0a 2a 2a 20 3c 6c 69 3e 0a 2a 2a 20 5e 49 66  *.** <li>.** ^If
29cf0 20 74 68 65 20 73 70 65 63 69 66 69 63 20 76 61   the specific va
29d00 6c 75 65 20 62 6f 75 6e 64 20 74 6f 20 5b 70 61  lue bound to [pa
29d10 72 61 6d 65 74 65 72 20 7c 20 68 6f 73 74 20 70  rameter | host p
29d20 61 72 61 6d 65 74 65 72 5d 20 69 6e 20 74 68 65  arameter] in the
29d30 20 0a 2a 2a 20 57 48 45 52 45 20 63 6c 61 75 73   .** WHERE claus
29d40 65 20 6d 69 67 68 74 20 69 6e 66 6c 75 65 6e 63  e might influenc
29d50 65 20 74 68 65 20 63 68 6f 69 63 65 20 6f 66 20  e the choice of 
29d60 71 75 65 72 79 20 70 6c 61 6e 20 66 6f 72 20 61  query plan for a
29d70 20 73 74 61 74 65 6d 65 6e 74 2c 0a 2a 2a 20 74   statement,.** t
29d80 68 65 6e 20 74 68 65 20 73 74 61 74 65 6d 65 6e  hen the statemen
29d90 74 20 77 69 6c 6c 20 62 65 20 61 75 74 6f 6d 61  t will be automa
29da0 74 69 63 61 6c 6c 79 20 72 65 63 6f 6d 70 69 6c  tically recompil
29db0 65 64 2c 20 61 73 20 69 66 20 74 68 65 72 65 20  ed, as if there 
29dc0 68 61 64 20 62 65 65 6e 20 0a 2a 2a 20 61 20 73  had been .** a s
29dd0 63 68 65 6d 61 20 63 68 61 6e 67 65 2c 20 6f 6e  chema change, on
29de0 20 74 68 65 20 66 69 72 73 74 20 20 5b 73 71 6c   the first  [sql
29df0 69 74 65 33 5f 73 74 65 70 28 29 5d 20 63 61 6c  ite3_step()] cal
29e00 6c 20 66 6f 6c 6c 6f 77 69 6e 67 20 61 6e 79 20  l following any 
29e10 63 68 61 6e 67 65 0a 2a 2a 20 74 6f 20 74 68 65  change.** to the
29e20 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74   [sqlite3_bind_t
29e30 65 78 74 20 7c 20 62 69 6e 64 69 6e 67 73 5d 20  ext | bindings] 
29e40 6f 66 20 74 68 61 74 20 5b 70 61 72 61 6d 65 74  of that [paramet
29e50 65 72 5d 2e 20 0a 2a 2a 20 5e 54 68 65 20 73 70  er]. .** ^The sp
29e60 65 63 69 66 69 63 20 76 61 6c 75 65 20 6f 66 20  ecific value of 
29e70 57 48 45 52 45 2d 63 6c 61 75 73 65 20 5b 70 61  WHERE-clause [pa
29e80 72 61 6d 65 74 65 72 5d 20 6d 69 67 68 74 20 69  rameter] might i
29e90 6e 66 6c 75 65 6e 63 65 20 74 68 65 20 0a 2a 2a  nfluence the .**
29ea0 20 63 68 6f 69 63 65 20 6f 66 20 71 75 65 72 79   choice of query
29eb0 20 70 6c 61 6e 20 69 66 20 74 68 65 20 70 61 72   plan if the par
29ec0 61 6d 65 74 65 72 20 69 73 20 74 68 65 20 6c 65  ameter is the le
29ed0 66 74 2d 68 61 6e 64 20 73 69 64 65 20 6f 66 20  ft-hand side of 
29ee0 61 20 5b 4c 49 4b 45 5d 0a 2a 2a 20 6f 72 20 5b  a [LIKE].** or [
29ef0 47 4c 4f 42 5d 20 6f 70 65 72 61 74 6f 72 20 6f  GLOB] operator o
29f00 72 20 69 66 20 74 68 65 20 70 61 72 61 6d 65 74  r if the paramet
29f10 65 72 20 69 73 20 63 6f 6d 70 61 72 65 64 20 74  er is compared t
29f20 6f 20 61 6e 20 69 6e 64 65 78 65 64 20 63 6f 6c  o an indexed col
29f30 75 6d 6e 0a 2a 2a 20 61 6e 64 20 74 68 65 20 5b  umn.** and the [
29f40 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 53 54  SQLITE_ENABLE_ST
29f50 41 54 33 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d  AT3] compile-tim
29f60 65 20 6f 70 74 69 6f 6e 20 69 73 20 65 6e 61 62  e option is enab
29f70 6c 65 64 2e 0a 2a 2a 20 3c 2f 6c 69 3e 0a 2a 2a  led..** </li>.**
29f80 20 3c 2f 6f 6c 3e 0a 2a 2f 0a 69 6e 74 20 73 71   </ol>.*/.int sq
29f90 6c 69 74 65 33 5f 70 72 65 70 61 72 65 28 0a 20  lite3_prepare(. 
29fa0 20 73 71 6c 69 74 65 33 20 2a 64 62 2c 20 20 20   sqlite3 *db,   
29fb0 20 20 20 20 20 20 20 20 20 2f 2a 20 44 61 74 61           /* Data
29fc0 62 61 73 65 20 68 61 6e 64 6c 65 20 2a 2f 0a 20  base handle */. 
29fd0 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 53 71   const char *zSq
29fe0 6c 2c 20 20 20 20 20 20 20 2f 2a 20 53 51 4c 20  l,       /* SQL 
29ff0 73 74 61 74 65 6d 65 6e 74 2c 20 55 54 46 2d 38  statement, UTF-8
2a000 20 65 6e 63 6f 64 65 64 20 2a 2f 0a 20 20 69 6e   encoded */.  in
2a010 74 20 6e 42 79 74 65 2c 20 20 20 20 20 20 20 20  t nByte,        
2a020 20 20 20 20 20 20 2f 2a 20 4d 61 78 69 6d 75 6d        /* Maximum
2a030 20 6c 65 6e 67 74 68 20 6f 66 20 7a 53 71 6c 20   length of zSql 
2a040 69 6e 20 62 79 74 65 73 2e 20 2a 2f 0a 20 20 73  in bytes. */.  s
2a050 71 6c 69 74 65 33 5f 73 74 6d 74 20 2a 2a 70 70  qlite3_stmt **pp
2a060 53 74 6d 74 2c 20 20 2f 2a 20 4f 55 54 3a 20 53  Stmt,  /* OUT: S
2a070 74 61 74 65 6d 65 6e 74 20 68 61 6e 64 6c 65 20  tatement handle 
2a080 2a 2f 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20  */.  const char 
2a090 2a 2a 70 7a 54 61 69 6c 20 20 20 20 20 2f 2a 20  **pzTail     /* 
2a0a0 4f 55 54 3a 20 50 6f 69 6e 74 65 72 20 74 6f 20  OUT: Pointer to 
2a0b0 75 6e 75 73 65 64 20 70 6f 72 74 69 6f 6e 20 6f  unused portion o
2a0c0 66 20 7a 53 71 6c 20 2a 2f 0a 29 3b 0a 69 6e 74  f zSql */.);.int
2a0d0 20 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65   sqlite3_prepare
2a0e0 5f 76 32 28 0a 20 20 73 71 6c 69 74 65 33 20 2a  _v2(.  sqlite3 *
2a0f0 64 62 2c 20 20 20 20 20 20 20 20 20 20 20 20 2f  db,            /
2a100 2a 20 44 61 74 61 62 61 73 65 20 68 61 6e 64 6c  * Database handl
2a110 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 63 68 61  e */.  const cha
2a120 72 20 2a 7a 53 71 6c 2c 20 20 20 20 20 20 20 2f  r *zSql,       /
2a130 2a 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2c  * SQL statement,
2a140 20 55 54 46 2d 38 20 65 6e 63 6f 64 65 64 20 2a   UTF-8 encoded *
2a150 2f 0a 20 20 69 6e 74 20 6e 42 79 74 65 2c 20 20  /.  int nByte,  
2a160 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 4d              /* M
2a170 61 78 69 6d 75 6d 20 6c 65 6e 67 74 68 20 6f 66  aximum length of
2a180 20 7a 53 71 6c 20 69 6e 20 62 79 74 65 73 2e 20   zSql in bytes. 
2a190 2a 2f 0a 20 20 73 71 6c 69 74 65 33 5f 73 74 6d  */.  sqlite3_stm
2a1a0 74 20 2a 2a 70 70 53 74 6d 74 2c 20 20 2f 2a 20  t **ppStmt,  /* 
2a1b0 4f 55 54 3a 20 53 74 61 74 65 6d 65 6e 74 20 68  OUT: Statement h
2a1c0 61 6e 64 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73 74  andle */.  const
2a1d0 20 63 68 61 72 20 2a 2a 70 7a 54 61 69 6c 20 20   char **pzTail  
2a1e0 20 20 20 2f 2a 20 4f 55 54 3a 20 50 6f 69 6e 74     /* OUT: Point
2a1f0 65 72 20 74 6f 20 75 6e 75 73 65 64 20 70 6f 72  er to unused por
2a200 74 69 6f 6e 20 6f 66 20 7a 53 71 6c 20 2a 2f 0a  tion of zSql */.
2a210 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 70  );.int sqlite3_p
2a220 72 65 70 61 72 65 31 36 28 0a 20 20 73 71 6c 69  repare16(.  sqli
2a230 74 65 33 20 2a 64 62 2c 20 20 20 20 20 20 20 20  te3 *db,        
2a240 20 20 20 20 2f 2a 20 44 61 74 61 62 61 73 65 20      /* Database 
2a250 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73  handle */.  cons
2a260 74 20 76 6f 69 64 20 2a 7a 53 71 6c 2c 20 20 20  t void *zSql,   
2a270 20 20 20 20 2f 2a 20 53 51 4c 20 73 74 61 74 65      /* SQL state
2a280 6d 65 6e 74 2c 20 55 54 46 2d 31 36 20 65 6e 63  ment, UTF-16 enc
2a290 6f 64 65 64 20 2a 2f 0a 20 20 69 6e 74 20 6e 42  oded */.  int nB
2a2a0 79 74 65 2c 20 20 20 20 20 20 20 20 20 20 20 20  yte,            
2a2b0 20 20 2f 2a 20 4d 61 78 69 6d 75 6d 20 6c 65 6e    /* Maximum len
2a2c0 67 74 68 20 6f 66 20 7a 53 71 6c 20 69 6e 20 62  gth of zSql in b
2a2d0 79 74 65 73 2e 20 2a 2f 0a 20 20 73 71 6c 69 74  ytes. */.  sqlit
2a2e0 65 33 5f 73 74 6d 74 20 2a 2a 70 70 53 74 6d 74  e3_stmt **ppStmt
2a2f0 2c 20 20 2f 2a 20 4f 55 54 3a 20 53 74 61 74 65  ,  /* OUT: State
2a300 6d 65 6e 74 20 68 61 6e 64 6c 65 20 2a 2f 0a 20  ment handle */. 
2a310 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a 2a 70 7a   const void **pz
2a320 54 61 69 6c 20 20 20 20 20 2f 2a 20 4f 55 54 3a  Tail     /* OUT:
2a330 20 50 6f 69 6e 74 65 72 20 74 6f 20 75 6e 75 73   Pointer to unus
2a340 65 64 20 70 6f 72 74 69 6f 6e 20 6f 66 20 7a 53  ed portion of zS
2a350 71 6c 20 2a 2f 0a 29 3b 0a 69 6e 74 20 73 71 6c  ql */.);.int sql
2a360 69 74 65 33 5f 70 72 65 70 61 72 65 31 36 5f 76  ite3_prepare16_v
2a370 32 28 0a 20 20 73 71 6c 69 74 65 33 20 2a 64 62  2(.  sqlite3 *db
2a380 2c 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20  ,            /* 
2a390 44 61 74 61 62 61 73 65 20 68 61 6e 64 6c 65 20  Database handle 
2a3a0 2a 2f 0a 20 20 63 6f 6e 73 74 20 76 6f 69 64 20  */.  const void 
2a3b0 2a 7a 53 71 6c 2c 20 20 20 20 20 20 20 2f 2a 20  *zSql,       /* 
2a3c0 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2c 20 55  SQL statement, U
2a3d0 54 46 2d 31 36 20 65 6e 63 6f 64 65 64 20 2a 2f  TF-16 encoded */
2a3e0 0a 20 20 69 6e 74 20 6e 42 79 74 65 2c 20 20 20  .  int nByte,   
2a3f0 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 4d 61             /* Ma
2a400 78 69 6d 75 6d 20 6c 65 6e 67 74 68 20 6f 66 20  ximum length of 
2a410 7a 53 71 6c 20 69 6e 20 62 79 74 65 73 2e 20 2a  zSql in bytes. *
2a420 2f 0a 20 20 73 71 6c 69 74 65 33 5f 73 74 6d 74  /.  sqlite3_stmt
2a430 20 2a 2a 70 70 53 74 6d 74 2c 20 20 2f 2a 20 4f   **ppStmt,  /* O
2a440 55 54 3a 20 53 74 61 74 65 6d 65 6e 74 20 68 61  UT: Statement ha
2a450 6e 64 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20  ndle */.  const 
2a460 76 6f 69 64 20 2a 2a 70 7a 54 61 69 6c 20 20 20  void **pzTail   
2a470 20 20 2f 2a 20 4f 55 54 3a 20 50 6f 69 6e 74 65    /* OUT: Pointe
2a480 72 20 74 6f 20 75 6e 75 73 65 64 20 70 6f 72 74  r to unused port
2a490 69 6f 6e 20 6f 66 20 7a 53 71 6c 20 2a 2f 0a 29  ion of zSql */.)
2a4a0 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
2a4b0 46 3a 20 52 65 74 72 69 65 76 69 6e 67 20 53 74  F: Retrieving St
2a4c0 61 74 65 6d 65 6e 74 20 53 51 4c 0a 2a 2a 20 4d  atement SQL.** M
2a4d0 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73  ETHOD: sqlite3_s
2a4e0 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 69 73 20  tmt.**.** ^This 
2a4f0 69 6e 74 65 72 66 61 63 65 20 63 61 6e 20 62 65  interface can be
2a500 20 75 73 65 64 20 74 6f 20 72 65 74 72 69 65 76   used to retriev
2a510 65 20 61 20 73 61 76 65 64 20 63 6f 70 79 20 6f  e a saved copy o
2a520 66 20 74 68 65 20 6f 72 69 67 69 6e 61 6c 0a 2a  f the original.*
2a530 2a 20 53 51 4c 20 74 65 78 74 20 75 73 65 64 20  * SQL text used 
2a540 74 6f 20 63 72 65 61 74 65 20 61 20 5b 70 72 65  to create a [pre
2a550 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d  pared statement]
2a560 20 69 66 20 74 68 61 74 20 73 74 61 74 65 6d 65   if that stateme
2a570 6e 74 20 77 61 73 0a 2a 2a 20 63 6f 6d 70 69 6c  nt was.** compil
2a580 65 64 20 75 73 69 6e 67 20 65 69 74 68 65 72 20  ed using either 
2a590 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65  [sqlite3_prepare
2a5a0 5f 76 32 28 29 5d 20 6f 72 20 5b 73 71 6c 69 74  _v2()] or [sqlit
2a5b0 65 33 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28  e3_prepare16_v2(
2a5c0 29 5d 2e 0a 2a 2f 0a 63 6f 6e 73 74 20 63 68 61  )]..*/.const cha
2a5d0 72 20 2a 73 71 6c 69 74 65 33 5f 73 71 6c 28 73  r *sqlite3_sql(s
2a5e0 71 6c 69 74 65 33 5f 73 74 6d 74 20 2a 70 53 74  qlite3_stmt *pSt
2a5f0 6d 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  mt);../*.** CAPI
2a600 33 52 45 46 3a 20 44 65 74 65 72 6d 69 6e 65 20  3REF: Determine 
2a610 49 66 20 41 6e 20 53 51 4c 20 53 74 61 74 65 6d  If An SQL Statem
2a620 65 6e 74 20 57 72 69 74 65 73 20 54 68 65 20 44  ent Writes The D
2a630 61 74 61 62 61 73 65 0a 2a 2a 20 4d 45 54 48 4f  atabase.** METHO
2a640 44 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 0a  D: sqlite3_stmt.
2a650 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  **.** ^The sqlit
2a660 65 33 5f 73 74 6d 74 5f 72 65 61 64 6f 6e 6c 79  e3_stmt_readonly
2a670 28 58 29 20 69 6e 74 65 72 66 61 63 65 20 72 65  (X) interface re
2a680 74 75 72 6e 73 20 74 72 75 65 20 28 6e 6f 6e 2d  turns true (non-
2a690 7a 65 72 6f 29 20 69 66 0a 2a 2a 20 61 6e 64 20  zero) if.** and 
2a6a0 6f 6e 6c 79 20 69 66 20 74 68 65 20 5b 70 72 65  only if the [pre
2a6b0 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d  pared statement]
2a6c0 20 58 20 6d 61 6b 65 73 20 6e 6f 20 64 69 72 65   X makes no dire
2a6d0 63 74 20 63 68 61 6e 67 65 73 20 74 6f 0a 2a 2a  ct changes to.**
2a6e0 20 74 68 65 20 63 6f 6e 74 65 6e 74 20 6f 66 20   the content of 
2a6f0 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c  the database fil
2a700 65 2e 0a 2a 2a 0a 2a 2a 20 4e 6f 74 65 20 74 68  e..**.** Note th
2a710 61 74 20 5b 61 70 70 6c 69 63 61 74 69 6f 6e 2d  at [application-
2a720 64 65 66 69 6e 65 64 20 53 51 4c 20 66 75 6e 63  defined SQL func
2a730 74 69 6f 6e 73 5d 20 6f 72 0a 2a 2a 20 5b 76 69  tions] or.** [vi
2a740 72 74 75 61 6c 20 74 61 62 6c 65 73 5d 20 6d 69  rtual tables] mi
2a750 67 68 74 20 63 68 61 6e 67 65 20 74 68 65 20 64  ght change the d
2a760 61 74 61 62 61 73 65 20 69 6e 64 69 72 65 63 74  atabase indirect
2a770 6c 79 20 61 73 20 61 20 73 69 64 65 20 65 66 66  ly as a side eff
2a780 65 63 74 2e 20 20 0a 2a 2a 20 5e 28 46 6f 72 20  ect.  .** ^(For 
2a790 65 78 61 6d 70 6c 65 2c 20 69 66 20 61 6e 20 61  example, if an a
2a7a0 70 70 6c 69 63 61 74 69 6f 6e 20 64 65 66 69 6e  pplication defin
2a7b0 65 73 20 61 20 66 75 6e 63 74 69 6f 6e 20 22 65  es a function "e
2a7c0 76 61 6c 28 29 22 20 74 68 61 74 20 0a 2a 2a 20  val()" that .** 
2a7d0 63 61 6c 6c 73 20 5b 73 71 6c 69 74 65 33 5f 65  calls [sqlite3_e
2a7e0 78 65 63 28 29 5d 2c 20 74 68 65 6e 20 74 68 65  xec()], then the
2a7f0 20 66 6f 6c 6c 6f 77 69 6e 67 20 53 51 4c 20 73   following SQL s
2a800 74 61 74 65 6d 65 6e 74 20 77 6f 75 6c 64 0a 2a  tatement would.*
2a810 2a 20 63 68 61 6e 67 65 20 74 68 65 20 64 61 74  * change the dat
2a820 61 62 61 73 65 20 66 69 6c 65 20 74 68 72 6f 75  abase file throu
2a830 67 68 20 73 69 64 65 2d 65 66 66 65 63 74 73 3a  gh side-effects:
2a840 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f  .**.** <blockquo
2a850 74 65 3e 3c 70 72 65 3e 0a 2a 2a 20 20 20 20 53  te><pre>.**    S
2a860 45 4c 45 43 54 20 65 76 61 6c 28 27 44 45 4c 45  ELECT eval('DELE
2a870 54 45 20 46 52 4f 4d 20 74 31 27 29 20 46 52 4f  TE FROM t1') FRO
2a880 4d 20 74 32 3b 0a 2a 2a 20 3c 2f 70 72 65 3e 3c  M t2;.** </pre><
2a890 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 2a 2a 0a  /blockquote>.**.
2a8a0 2a 2a 20 42 75 74 20 62 65 63 61 75 73 65 20 74  ** But because t
2a8b0 68 65 20 5b 53 45 4c 45 43 54 5d 20 73 74 61 74  he [SELECT] stat
2a8c0 65 6d 65 6e 74 20 64 6f 65 73 20 6e 6f 74 20 63  ement does not c
2a8d0 68 61 6e 67 65 20 74 68 65 20 64 61 74 61 62 61  hange the databa
2a8e0 73 65 20 66 69 6c 65 0a 2a 2a 20 64 69 72 65 63  se file.** direc
2a8f0 74 6c 79 2c 20 73 71 6c 69 74 65 33 5f 73 74 6d  tly, sqlite3_stm
2a900 74 5f 72 65 61 64 6f 6e 6c 79 28 29 20 77 6f 75  t_readonly() wou
2a910 6c 64 20 73 74 69 6c 6c 20 72 65 74 75 72 6e 20  ld still return 
2a920 74 72 75 65 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 54  true.)^.**.** ^T
2a930 72 61 6e 73 61 63 74 69 6f 6e 20 63 6f 6e 74 72  ransaction contr
2a940 6f 6c 20 73 74 61 74 65 6d 65 6e 74 73 20 73 75  ol statements su
2a950 63 68 20 61 73 20 5b 42 45 47 49 4e 5d 2c 20 5b  ch as [BEGIN], [
2a960 43 4f 4d 4d 49 54 5d 2c 20 5b 52 4f 4c 4c 42 41  COMMIT], [ROLLBA
2a970 43 4b 5d 2c 0a 2a 2a 20 5b 53 41 56 45 50 4f 49  CK],.** [SAVEPOI
2a980 4e 54 5d 2c 20 61 6e 64 20 5b 52 45 4c 45 41 53  NT], and [RELEAS
2a990 45 5d 20 63 61 75 73 65 20 73 71 6c 69 74 65 33  E] cause sqlite3
2a9a0 5f 73 74 6d 74 5f 72 65 61 64 6f 6e 6c 79 28 29  _stmt_readonly()
2a9b0 20 74 6f 20 72 65 74 75 72 6e 20 74 72 75 65 2c   to return true,
2a9c0 0a 2a 2a 20 73 69 6e 63 65 20 74 68 65 20 73 74  .** since the st
2a9d0 61 74 65 6d 65 6e 74 73 20 74 68 65 6d 73 65 6c  atements themsel
2a9e0 76 65 73 20 64 6f 20 6e 6f 74 20 61 63 74 75 61  ves do not actua
2a9f0 6c 6c 79 20 6d 6f 64 69 66 79 20 74 68 65 20 64  lly modify the d
2aa00 61 74 61 62 61 73 65 20 62 75 74 0a 2a 2a 20 72  atabase but.** r
2aa10 61 74 68 65 72 20 74 68 65 79 20 63 6f 6e 74 72  ather they contr
2aa20 6f 6c 20 74 68 65 20 74 69 6d 69 6e 67 20 6f 66  ol the timing of
2aa30 20 77 68 65 6e 20 6f 74 68 65 72 20 73 74 61 74   when other stat
2aa40 65 6d 65 6e 74 73 20 6d 6f 64 69 66 79 20 74 68  ements modify th
2aa50 65 20 0a 2a 2a 20 64 61 74 61 62 61 73 65 2e 20  e .** database. 
2aa60 20 5e 54 68 65 20 5b 41 54 54 41 43 48 5d 20 61   ^The [ATTACH] a
2aa70 6e 64 20 5b 44 45 54 41 43 48 5d 20 73 74 61 74  nd [DETACH] stat
2aa80 65 6d 65 6e 74 73 20 61 6c 73 6f 20 63 61 75 73  ements also caus
2aa90 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 73 74 6d  e.** sqlite3_stm
2aaa0 74 5f 72 65 61 64 6f 6e 6c 79 28 29 20 74 6f 20  t_readonly() to 
2aab0 72 65 74 75 72 6e 20 74 72 75 65 20 73 69 6e 63  return true sinc
2aac0 65 2c 20 77 68 69 6c 65 20 74 68 6f 73 65 20 73  e, while those s
2aad0 74 61 74 65 6d 65 6e 74 73 0a 2a 2a 20 63 68 61  tatements.** cha
2aae0 6e 67 65 20 74 68 65 20 63 6f 6e 66 69 67 75 72  nge the configur
2aaf0 61 74 69 6f 6e 20 6f 66 20 61 20 64 61 74 61 62  ation of a datab
2ab00 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 2c 20  ase connection, 
2ab10 74 68 65 79 20 64 6f 20 6e 6f 74 20 6d 61 6b 65  they do not make
2ab20 20 0a 2a 2a 20 63 68 61 6e 67 65 73 20 74 6f 20   .** changes to 
2ab30 74 68 65 20 63 6f 6e 74 65 6e 74 20 6f 66 20 74  the content of t
2ab40 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65  he database file
2ab50 73 20 6f 6e 20 64 69 73 6b 2e 0a 2a 2f 0a 69 6e  s on disk..*/.in
2ab60 74 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 5f 72  t sqlite3_stmt_r
2ab70 65 61 64 6f 6e 6c 79 28 73 71 6c 69 74 65 33 5f  eadonly(sqlite3_
2ab80 73 74 6d 74 20 2a 70 53 74 6d 74 29 3b 0a 0a 2f  stmt *pStmt);../
2ab90 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 44  *.** CAPI3REF: D
2aba0 65 74 65 72 6d 69 6e 65 20 49 66 20 41 20 50 72  etermine If A Pr
2abb0 65 70 61 72 65 64 20 53 74 61 74 65 6d 65 6e 74  epared Statement
2abc0 20 48 61 73 20 42 65 65 6e 20 52 65 73 65 74 0a   Has Been Reset.
2abd0 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74  ** METHOD: sqlit
2abe0 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54  e3_stmt.**.** ^T
2abf0 68 65 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 5f  he sqlite3_stmt_
2ac00 62 75 73 79 28 53 29 20 69 6e 74 65 72 66 61 63  busy(S) interfac
2ac10 65 20 72 65 74 75 72 6e 73 20 74 72 75 65 20 28  e returns true (
2ac20 6e 6f 6e 2d 7a 65 72 6f 29 20 69 66 20 74 68 65  non-zero) if the
2ac30 0a 2a 2a 20 5b 70 72 65 70 61 72 65 64 20 73 74  .** [prepared st
2ac40 61 74 65 6d 65 6e 74 5d 20 53 20 68 61 73 20 62  atement] S has b
2ac50 65 65 6e 20 73 74 65 70 70 65 64 20 61 74 20 6c  een stepped at l
2ac60 65 61 73 74 20 6f 6e 63 65 20 75 73 69 6e 67 20  east once using 
2ac70 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 73 74 65  .** [sqlite3_ste
2ac80 70 28 53 29 5d 20 62 75 74 20 68 61 73 20 6e 65  p(S)] but has ne
2ac90 69 74 68 65 72 20 72 75 6e 20 74 6f 20 63 6f 6d  ither run to com
2aca0 70 6c 65 74 69 6f 6e 20 28 72 65 74 75 72 6e 65  pletion (returne
2acb0 64 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 44 4f 4e  d.** [SQLITE_DON
2acc0 45 5d 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33  E] from [sqlite3
2acd0 5f 73 74 65 70 28 53 29 5d 29 20 6e 6f 72 0a 2a  _step(S)]) nor.*
2ace0 2a 20 62 65 65 6e 20 72 65 73 65 74 20 75 73 69  * been reset usi
2acf0 6e 67 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65  ng [sqlite3_rese
2ad00 74 28 53 29 5d 2e 20 20 5e 54 68 65 20 73 71 6c  t(S)].  ^The sql
2ad10 69 74 65 33 5f 73 74 6d 74 5f 62 75 73 79 28 53  ite3_stmt_busy(S
2ad20 29 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 72  ).** interface r
2ad30 65 74 75 72 6e 73 20 66 61 6c 73 65 20 69 66 20  eturns false if 
2ad40 53 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e  S is a NULL poin
2ad50 74 65 72 2e 20 20 49 66 20 53 20 69 73 20 6e 6f  ter.  If S is no
2ad60 74 20 61 20 0a 2a 2a 20 4e 55 4c 4c 20 70 6f 69  t a .** NULL poi
2ad70 6e 74 65 72 20 61 6e 64 20 69 73 20 6e 6f 74 20  nter and is not 
2ad80 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20 76  a pointer to a v
2ad90 61 6c 69 64 20 5b 70 72 65 70 61 72 65 64 20 73  alid [prepared s
2ada0 74 61 74 65 6d 65 6e 74 5d 0a 2a 2a 20 6f 62 6a  tatement].** obj
2adb0 65 63 74 2c 20 74 68 65 6e 20 74 68 65 20 62 65  ect, then the be
2adc0 68 61 76 69 6f 72 20 69 73 20 75 6e 64 65 66 69  havior is undefi
2add0 6e 65 64 20 61 6e 64 20 70 72 6f 62 61 62 6c 79  ned and probably
2ade0 20 75 6e 64 65 73 69 72 61 62 6c 65 2e 0a 2a 2a   undesirable..**
2adf0 0a 2a 2a 20 54 68 69 73 20 69 6e 74 65 72 66 61  .** This interfa
2ae00 63 65 20 63 61 6e 20 62 65 20 75 73 65 64 20 69  ce can be used i
2ae10 6e 20 63 6f 6d 62 69 6e 61 74 69 6f 6e 20 5b 73  n combination [s
2ae20 71 6c 69 74 65 33 5f 6e 65 78 74 5f 73 74 6d 74  qlite3_next_stmt
2ae30 28 29 5d 0a 2a 2a 20 74 6f 20 6c 6f 63 61 74 65  ()].** to locate
2ae40 20 61 6c 6c 20 70 72 65 70 61 72 65 64 20 73 74   all prepared st
2ae50 61 74 65 6d 65 6e 74 73 20 61 73 73 6f 63 69 61  atements associa
2ae60 74 65 64 20 77 69 74 68 20 61 20 64 61 74 61 62  ted with a datab
2ae70 61 73 65 20 0a 2a 2a 20 63 6f 6e 6e 65 63 74 69  ase .** connecti
2ae80 6f 6e 20 74 68 61 74 20 61 72 65 20 69 6e 20 6e  on that are in n
2ae90 65 65 64 20 6f 66 20 62 65 69 6e 67 20 72 65 73  eed of being res
2aea0 65 74 2e 20 20 54 68 69 73 20 63 61 6e 20 62 65  et.  This can be
2aeb0 20 75 73 65 64 2c 0a 2a 2a 20 66 6f 72 20 65 78   used,.** for ex
2aec0 61 6d 70 6c 65 2c 20 69 6e 20 64 69 61 67 6e 6f  ample, in diagno
2aed0 73 74 69 63 20 72 6f 75 74 69 6e 65 73 20 74 6f  stic routines to
2aee0 20 73 65 61 72 63 68 20 66 6f 72 20 70 72 65 70   search for prep
2aef0 61 72 65 64 20 0a 2a 2a 20 73 74 61 74 65 6d 65  ared .** stateme
2af00 6e 74 73 20 74 68 61 74 20 61 72 65 20 68 6f 6c  nts that are hol
2af10 64 69 6e 67 20 61 20 74 72 61 6e 73 61 63 74 69  ding a transacti
2af20 6f 6e 20 6f 70 65 6e 2e 0a 2a 2f 0a 69 6e 74 20  on open..*/.int 
2af30 73 71 6c 69 74 65 33 5f 73 74 6d 74 5f 62 75 73  sqlite3_stmt_bus
2af40 79 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 29  y(sqlite3_stmt*)
2af50 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
2af60 46 3a 20 44 79 6e 61 6d 69 63 61 6c 6c 79 20 54  F: Dynamically T
2af70 79 70 65 64 20 56 61 6c 75 65 20 4f 62 6a 65 63  yped Value Objec
2af80 74 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b  t.** KEYWORDS: {
2af90 70 72 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65  protected sqlite
2afa0 33 5f 76 61 6c 75 65 7d 20 7b 75 6e 70 72 6f 74  3_value} {unprot
2afb0 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76 61  ected sqlite3_va
2afc0 6c 75 65 7d 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74  lue}.**.** SQLit
2afd0 65 20 75 73 65 73 20 74 68 65 20 73 71 6c 69 74  e uses the sqlit
2afe0 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65 63 74 20  e3_value object 
2aff0 74 6f 20 72 65 70 72 65 73 65 6e 74 20 61 6c 6c  to represent all
2b000 20 76 61 6c 75 65 73 0a 2a 2a 20 74 68 61 74 20   values.** that 
2b010 63 61 6e 20 62 65 20 73 74 6f 72 65 64 20 69 6e  can be stored in
2b020 20 61 20 64 61 74 61 62 61 73 65 20 74 61 62 6c   a database tabl
2b030 65 2e 20 53 51 4c 69 74 65 20 75 73 65 73 20 64  e. SQLite uses d
2b040 79 6e 61 6d 69 63 20 74 79 70 69 6e 67 0a 2a 2a  ynamic typing.**
2b050 20 66 6f 72 20 74 68 65 20 76 61 6c 75 65 73 20   for the values 
2b060 69 74 20 73 74 6f 72 65 73 2e 20 20 5e 56 61 6c  it stores.  ^Val
2b070 75 65 73 20 73 74 6f 72 65 64 20 69 6e 20 73 71  ues stored in sq
2b080 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65  lite3_value obje
2b090 63 74 73 0a 2a 2a 20 63 61 6e 20 62 65 20 69 6e  cts.** can be in
2b0a0 74 65 67 65 72 73 2c 20 66 6c 6f 61 74 69 6e 67  tegers, floating
2b0b0 20 70 6f 69 6e 74 20 76 61 6c 75 65 73 2c 20 73   point values, s
2b0c0 74 72 69 6e 67 73 2c 20 42 4c 4f 42 73 2c 20 6f  trings, BLOBs, o
2b0d0 72 20 4e 55 4c 4c 2e 0a 2a 2a 0a 2a 2a 20 41 6e  r NULL..**.** An
2b0e0 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f   sqlite3_value o
2b0f0 62 6a 65 63 74 20 6d 61 79 20 62 65 20 65 69 74  bject may be eit
2b100 68 65 72 20 22 70 72 6f 74 65 63 74 65 64 22 20  her "protected" 
2b110 6f 72 20 22 75 6e 70 72 6f 74 65 63 74 65 64 22  or "unprotected"
2b120 2e 0a 2a 2a 20 53 6f 6d 65 20 69 6e 74 65 72 66  ..** Some interf
2b130 61 63 65 73 20 72 65 71 75 69 72 65 20 61 20 70  aces require a p
2b140 72 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65 33  rotected sqlite3
2b150 5f 76 61 6c 75 65 2e 20 20 4f 74 68 65 72 20 69  _value.  Other i
2b160 6e 74 65 72 66 61 63 65 73 0a 2a 2a 20 77 69 6c  nterfaces.** wil
2b170 6c 20 61 63 63 65 70 74 20 65 69 74 68 65 72 20  l accept either 
2b180 61 20 70 72 6f 74 65 63 74 65 64 20 6f 72 20 61  a protected or a
2b190 6e 20 75 6e 70 72 6f 74 65 63 74 65 64 20 73 71  n unprotected sq
2b1a0 6c 69 74 65 33 5f 76 61 6c 75 65 2e 0a 2a 2a 20  lite3_value..** 
2b1b0 45 76 65 72 79 20 69 6e 74 65 72 66 61 63 65 20  Every interface 
2b1c0 74 68 61 74 20 61 63 63 65 70 74 73 20 73 71 6c  that accepts sql
2b1d0 69 74 65 33 5f 76 61 6c 75 65 20 61 72 67 75 6d  ite3_value argum
2b1e0 65 6e 74 73 20 73 70 65 63 69 66 69 65 73 0a 2a  ents specifies.*
2b1f0 2a 20 77 68 65 74 68 65 72 20 6f 72 20 6e 6f 74  * whether or not
2b200 20 69 74 20 72 65 71 75 69 72 65 73 20 61 20 70   it requires a p
2b210 72 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65 33  rotected sqlite3
2b220 5f 76 61 6c 75 65 2e 20 20 54 68 65 0a 2a 2a 20  _value.  The.** 
2b230 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 64  [sqlite3_value_d
2b240 75 70 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20  up()] interface 
2b250 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20 63  can be used to c
2b260 6f 6e 73 74 72 75 63 74 20 61 20 6e 65 77 20 0a  onstruct a new .
2b270 2a 2a 20 70 72 6f 74 65 63 74 65 64 20 73 71 6c  ** protected sql
2b280 69 74 65 33 5f 76 61 6c 75 65 20 66 72 6f 6d 20  ite3_value from 
2b290 61 6e 20 75 6e 70 72 6f 74 65 63 74 65 64 20 73  an unprotected s
2b2a0 71 6c 69 74 65 33 5f 76 61 6c 75 65 2e 0a 2a 2a  qlite3_value..**
2b2b0 0a 2a 2a 20 54 68 65 20 74 65 72 6d 73 20 22 70  .** The terms "p
2b2c0 72 6f 74 65 63 74 65 64 22 20 61 6e 64 20 22 75  rotected" and "u
2b2d0 6e 70 72 6f 74 65 63 74 65 64 22 20 72 65 66 65  nprotected" refe
2b2e0 72 20 74 6f 20 77 68 65 74 68 65 72 20 6f 72 20  r to whether or 
2b2f0 6e 6f 74 0a 2a 2a 20 61 20 6d 75 74 65 78 20 69  not.** a mutex i
2b300 73 20 68 65 6c 64 2e 20 20 41 6e 20 69 6e 74 65  s held.  An inte
2b310 72 6e 61 6c 20 6d 75 74 65 78 20 69 73 20 68 65  rnal mutex is he
2b320 6c 64 20 66 6f 72 20 61 20 70 72 6f 74 65 63 74  ld for a protect
2b330 65 64 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 76 61  ed.** sqlite3_va
2b340 6c 75 65 20 6f 62 6a 65 63 74 20 62 75 74 20 6e  lue object but n
2b350 6f 20 6d 75 74 65 78 20 69 73 20 68 65 6c 64 20  o mutex is held 
2b360 66 6f 72 20 61 6e 20 75 6e 70 72 6f 74 65 63 74  for an unprotect
2b370 65 64 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 76 61  ed.** sqlite3_va
2b380 6c 75 65 20 6f 62 6a 65 63 74 2e 20 20 49 66 20  lue object.  If 
2b390 53 51 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c  SQLite is compil
2b3a0 65 64 20 74 6f 20 62 65 20 73 69 6e 67 6c 65 2d  ed to be single-
2b3b0 74 68 72 65 61 64 65 64 0a 2a 2a 20 28 77 69 74  threaded.** (wit
2b3c0 68 20 5b 53 51 4c 49 54 45 5f 54 48 52 45 41 44  h [SQLITE_THREAD
2b3d0 53 41 46 45 3d 30 5d 20 61 6e 64 20 77 69 74 68  SAFE=0] and with
2b3e0 20 5b 73 71 6c 69 74 65 33 5f 74 68 72 65 61 64   [sqlite3_thread
2b3f0 73 61 66 65 28 29 5d 20 72 65 74 75 72 6e 69 6e  safe()] returnin
2b400 67 20 30 29 0a 2a 2a 20 6f 72 20 69 66 20 53 51  g 0).** or if SQ
2b410 4c 69 74 65 20 69 73 20 72 75 6e 20 69 6e 20 6f  Lite is run in o
2b420 6e 65 20 6f 66 20 72 65 64 75 63 65 64 20 6d 75  ne of reduced mu
2b430 74 65 78 20 6d 6f 64 65 73 20 0a 2a 2a 20 5b 53  tex modes .** [S
2b440 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 49 4e  QLITE_CONFIG_SIN
2b450 47 4c 45 54 48 52 45 41 44 5d 20 6f 72 20 5b 53  GLETHREAD] or [S
2b460 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 55 4c  QLITE_CONFIG_MUL
2b470 54 49 54 48 52 45 41 44 5d 0a 2a 2a 20 74 68 65  TITHREAD].** the
2b480 6e 20 74 68 65 72 65 20 69 73 20 6e 6f 20 64 69  n there is no di
2b490 73 74 69 6e 63 74 69 6f 6e 20 62 65 74 77 65 65  stinction betwee
2b4a0 6e 20 70 72 6f 74 65 63 74 65 64 20 61 6e 64 20  n protected and 
2b4b0 75 6e 70 72 6f 74 65 63 74 65 64 0a 2a 2a 20 73  unprotected.** s
2b4c0 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a  qlite3_value obj
2b4d0 65 63 74 73 20 61 6e 64 20 74 68 65 79 20 63 61  ects and they ca
2b4e0 6e 20 62 65 20 75 73 65 64 20 69 6e 74 65 72 63  n be used interc
2b4f0 68 61 6e 67 65 61 62 6c 79 2e 20 20 48 6f 77 65  hangeably.  Howe
2b500 76 65 72 2c 0a 2a 2a 20 66 6f 72 20 6d 61 78 69  ver,.** for maxi
2b510 6d 75 6d 20 63 6f 64 65 20 70 6f 72 74 61 62 69  mum code portabi
2b520 6c 69 74 79 20 69 74 20 69 73 20 72 65 63 6f 6d  lity it is recom
2b530 6d 65 6e 64 65 64 20 74 68 61 74 20 61 70 70 6c  mended that appl
2b540 69 63 61 74 69 6f 6e 73 0a 2a 2a 20 73 74 69 6c  ications.** stil
2b550 6c 20 6d 61 6b 65 20 74 68 65 20 64 69 73 74 69  l make the disti
2b560 6e 63 74 69 6f 6e 20 62 65 74 77 65 65 6e 20 70  nction between p
2b570 72 6f 74 65 63 74 65 64 20 61 6e 64 20 75 6e 70  rotected and unp
2b580 72 6f 74 65 63 74 65 64 0a 2a 2a 20 73 71 6c 69  rotected.** sqli
2b590 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65 63 74  te3_value object
2b5a0 73 20 65 76 65 6e 20 77 68 65 6e 20 6e 6f 74 20  s even when not 
2b5b0 73 74 72 69 63 74 6c 79 20 72 65 71 75 69 72 65  strictly require
2b5c0 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71  d..**.** ^The sq
2b5d0 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65  lite3_value obje
2b5e0 63 74 73 20 74 68 61 74 20 61 72 65 20 70 61 73  cts that are pas
2b5f0 73 65 64 20 61 73 20 70 61 72 61 6d 65 74 65 72  sed as parameter
2b600 73 20 69 6e 74 6f 20 74 68 65 0a 2a 2a 20 69 6d  s into the.** im
2b610 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20  plementation of 
2b620 5b 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66  [application-def
2b630 69 6e 65 64 20 53 51 4c 20 66 75 6e 63 74 69 6f  ined SQL functio
2b640 6e 73 5d 20 61 72 65 20 70 72 6f 74 65 63 74 65  ns] are protecte
2b650 64 2e 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  d..** ^The sqlit
2b660 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65 63 74 20  e3_value object 
2b670 72 65 74 75 72 6e 65 64 20 62 79 0a 2a 2a 20 5b  returned by.** [
2b680 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 76  sqlite3_column_v
2b690 61 6c 75 65 28 29 5d 20 69 73 20 75 6e 70 72 6f  alue()] is unpro
2b6a0 74 65 63 74 65 64 2e 0a 2a 2a 20 55 6e 70 72 6f  tected..** Unpro
2b6b0 74 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76  tected sqlite3_v
2b6c0 61 6c 75 65 20 6f 62 6a 65 63 74 73 20 6d 61 79  alue objects may
2b6d0 20 6f 6e 6c 79 20 62 65 20 75 73 65 64 20 77 69   only be used wi
2b6e0 74 68 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 72  th.** [sqlite3_r
2b6f0 65 73 75 6c 74 5f 76 61 6c 75 65 28 29 5d 20 61  esult_value()] a
2b700 6e 64 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64  nd [sqlite3_bind
2b710 5f 76 61 6c 75 65 28 29 5d 2e 0a 2a 2a 20 54 68  _value()]..** Th
2b720 65 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  e [sqlite3_value
2b730 5f 62 6c 6f 62 20 7c 20 73 71 6c 69 74 65 33 5f  _blob | sqlite3_
2b740 76 61 6c 75 65 5f 74 79 70 65 28 29 5d 20 66 61  value_type()] fa
2b750 6d 69 6c 79 20 6f 66 0a 2a 2a 20 69 6e 74 65 72  mily of.** inter
2b760 66 61 63 65 73 20 72 65 71 75 69 72 65 20 70 72  faces require pr
2b770 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f  otected sqlite3_
2b780 76 61 6c 75 65 20 6f 62 6a 65 63 74 73 2e 0a 2a  value objects..*
2b790 2f 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74  /.typedef struct
2b7a0 20 4d 65 6d 20 73 71 6c 69 74 65 33 5f 76 61 6c   Mem sqlite3_val
2b7b0 75 65 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  ue;../*.** CAPI3
2b7c0 52 45 46 3a 20 53 51 4c 20 46 75 6e 63 74 69 6f  REF: SQL Functio
2b7d0 6e 20 43 6f 6e 74 65 78 74 20 4f 62 6a 65 63 74  n Context Object
2b7e0 0a 2a 2a 0a 2a 2a 20 54 68 65 20 63 6f 6e 74 65  .**.** The conte
2b7f0 78 74 20 69 6e 20 77 68 69 63 68 20 61 6e 20 53  xt in which an S
2b800 51 4c 20 66 75 6e 63 74 69 6f 6e 20 65 78 65 63  QL function exec
2b810 75 74 65 73 20 69 73 20 73 74 6f 72 65 64 20 69  utes is stored i
2b820 6e 20 61 6e 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  n an.** sqlite3_
2b830 63 6f 6e 74 65 78 74 20 6f 62 6a 65 63 74 2e 20  context object. 
2b840 20 5e 41 20 70 6f 69 6e 74 65 72 20 74 6f 20 61   ^A pointer to a
2b850 6e 20 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78  n sqlite3_contex
2b860 74 20 6f 62 6a 65 63 74 0a 2a 2a 20 69 73 20 61  t object.** is a
2b870 6c 77 61 79 73 20 66 69 72 73 74 20 70 61 72 61  lways first para
2b880 6d 65 74 65 72 20 74 6f 20 5b 61 70 70 6c 69 63  meter to [applic
2b890 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51  ation-defined SQ
2b8a0 4c 20 66 75 6e 63 74 69 6f 6e 73 5d 2e 0a 2a 2a  L functions]..**
2b8b0 20 54 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   The application
2b8c0 2d 64 65 66 69 6e 65 64 20 53 51 4c 20 66 75 6e  -defined SQL fun
2b8d0 63 74 69 6f 6e 20 69 6d 70 6c 65 6d 65 6e 74 61  ction implementa
2b8e0 74 69 6f 6e 20 77 69 6c 6c 20 70 61 73 73 20 74  tion will pass t
2b8f0 68 69 73 0a 2a 2a 20 70 6f 69 6e 74 65 72 20 74  his.** pointer t
2b900 68 72 6f 75 67 68 20 69 6e 74 6f 20 63 61 6c 6c  hrough into call
2b910 73 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 72 65  s to [sqlite3_re
2b920 73 75 6c 74 5f 69 6e 74 20 7c 20 73 71 6c 69 74  sult_int | sqlit
2b930 65 33 5f 72 65 73 75 6c 74 28 29 5d 2c 0a 2a 2a  e3_result()],.**
2b940 20 5b 73 71 6c 69 74 65 33 5f 61 67 67 72 65 67   [sqlite3_aggreg
2b950 61 74 65 5f 63 6f 6e 74 65 78 74 28 29 5d 2c 20  ate_context()], 
2b960 5b 73 71 6c 69 74 65 33 5f 75 73 65 72 5f 64 61  [sqlite3_user_da
2b970 74 61 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74  ta()],.** [sqlit
2b980 65 33 5f 63 6f 6e 74 65 78 74 5f 64 62 5f 68 61  e3_context_db_ha
2b990 6e 64 6c 65 28 29 5d 2c 20 5b 73 71 6c 69 74 65  ndle()], [sqlite
2b9a0 33 5f 67 65 74 5f 61 75 78 64 61 74 61 28 29 5d  3_get_auxdata()]
2b9b0 2c 0a 2a 2a 20 61 6e 64 2f 6f 72 20 5b 73 71 6c  ,.** and/or [sql
2b9c0 69 74 65 33 5f 73 65 74 5f 61 75 78 64 61 74 61  ite3_set_auxdata
2b9d0 28 29 5d 2e 0a 2a 2f 0a 74 79 70 65 64 65 66 20  ()]..*/.typedef 
2b9e0 73 74 72 75 63 74 20 73 71 6c 69 74 65 33 5f 63  struct sqlite3_c
2b9f0 6f 6e 74 65 78 74 20 73 71 6c 69 74 65 33 5f 63  ontext sqlite3_c
2ba00 6f 6e 74 65 78 74 3b 0a 0a 2f 2a 0a 2a 2a 20 43  ontext;../*.** C
2ba10 41 50 49 33 52 45 46 3a 20 42 69 6e 64 69 6e 67  API3REF: Binding
2ba20 20 56 61 6c 75 65 73 20 54 6f 20 50 72 65 70 61   Values To Prepa
2ba30 72 65 64 20 53 74 61 74 65 6d 65 6e 74 73 0a 2a  red Statements.*
2ba40 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b 68 6f 73  * KEYWORDS: {hos
2ba50 74 20 70 61 72 61 6d 65 74 65 72 7d 20 7b 68 6f  t parameter} {ho
2ba60 73 74 20 70 61 72 61 6d 65 74 65 72 73 7d 20 7b  st parameters} {
2ba70 68 6f 73 74 20 70 61 72 61 6d 65 74 65 72 20 6e  host parameter n
2ba80 61 6d 65 7d 0a 2a 2a 20 4b 45 59 57 4f 52 44 53  ame}.** KEYWORDS
2ba90 3a 20 7b 53 51 4c 20 70 61 72 61 6d 65 74 65 72  : {SQL parameter
2baa0 7d 20 7b 53 51 4c 20 70 61 72 61 6d 65 74 65 72  } {SQL parameter
2bab0 73 7d 20 7b 70 61 72 61 6d 65 74 65 72 20 62 69  s} {parameter bi
2bac0 6e 64 69 6e 67 7d 0a 2a 2a 20 4d 45 54 48 4f 44  nding}.** METHOD
2bad0 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 0a 2a  : sqlite3_stmt.*
2bae0 2a 0a 2a 2a 20 5e 28 49 6e 20 74 68 65 20 53 51  *.** ^(In the SQ
2baf0 4c 20 73 74 61 74 65 6d 65 6e 74 20 74 65 78 74  L statement text
2bb00 20 69 6e 70 75 74 20 74 6f 20 5b 73 71 6c 69 74   input to [sqlit
2bb10 65 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d  e3_prepare_v2()]
2bb20 20 61 6e 64 20 69 74 73 20 76 61 72 69 61 6e 74   and its variant
2bb30 73 2c 0a 2a 2a 20 6c 69 74 65 72 61 6c 73 20 6d  s,.** literals m
2bb40 61 79 20 62 65 20 72 65 70 6c 61 63 65 64 20 62  ay be replaced b
2bb50 79 20 61 20 5b 70 61 72 61 6d 65 74 65 72 5d 20  y a [parameter] 
2bb60 74 68 61 74 20 6d 61 74 63 68 65 73 20 6f 6e 65  that matches one
2bb70 20 6f 66 20 66 6f 6c 6c 6f 77 69 6e 67 0a 2a 2a   of following.**
2bb80 20 74 65 6d 70 6c 61 74 65 73 3a 0a 2a 2a 0a 2a   templates:.**.*
2bb90 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20 20  * <ul>.** <li>  
2bba0 3f 0a 2a 2a 20 3c 6c 69 3e 20 20 3f 4e 4e 4e 0a  ?.** <li>  ?NNN.
2bbb0 2a 2a 20 3c 6c 69 3e 20 20 3a 56 56 56 0a 2a 2a  ** <li>  :VVV.**
2bbc0 20 3c 6c 69 3e 20 20 40 56 56 56 0a 2a 2a 20 3c   <li>  @VVV.** <
2bbd0 6c 69 3e 20 20 24 56 56 56 0a 2a 2a 20 3c 2f 75  li>  $VVV.** </u
2bbe0 6c 3e 0a 2a 2a 0a 2a 2a 20 49 6e 20 74 68 65 20  l>.**.** In the 
2bbf0 74 65 6d 70 6c 61 74 65 73 20 61 62 6f 76 65 2c  templates above,
2bc00 20 4e 4e 4e 20 72 65 70 72 65 73 65 6e 74 73 20   NNN represents 
2bc10 61 6e 20 69 6e 74 65 67 65 72 20 6c 69 74 65 72  an integer liter
2bc20 61 6c 2c 0a 2a 2a 20 61 6e 64 20 56 56 56 20 72  al,.** and VVV r
2bc30 65 70 72 65 73 65 6e 74 73 20 61 6e 20 61 6c 70  epresents an alp
2bc40 68 61 6e 75 6d 65 72 69 63 20 69 64 65 6e 74 69  hanumeric identi
2bc50 66 69 65 72 2e 29 5e 20 20 5e 54 68 65 20 76 61  fier.)^  ^The va
2bc60 6c 75 65 73 20 6f 66 20 74 68 65 73 65 0a 2a 2a  lues of these.**
2bc70 20 70 61 72 61 6d 65 74 65 72 73 20 28 61 6c 73   parameters (als
2bc80 6f 20 63 61 6c 6c 65 64 20 22 68 6f 73 74 20 70  o called "host p
2bc90 61 72 61 6d 65 74 65 72 20 6e 61 6d 65 73 22 20  arameter names" 
2bca0 6f 72 20 22 53 51 4c 20 70 61 72 61 6d 65 74 65  or "SQL paramete
2bcb0 72 73 22 29 0a 2a 2a 20 63 61 6e 20 62 65 20 73  rs").** can be s
2bcc0 65 74 20 75 73 69 6e 67 20 74 68 65 20 73 71 6c  et using the sql
2bcd0 69 74 65 33 5f 62 69 6e 64 5f 2a 28 29 20 72 6f  ite3_bind_*() ro
2bce0 75 74 69 6e 65 73 20 64 65 66 69 6e 65 64 20 68  utines defined h
2bcf0 65 72 65 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  ere..**.** ^The 
2bd00 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74  first argument t
2bd10 6f 20 74 68 65 20 73 71 6c 69 74 65 33 5f 62 69  o the sqlite3_bi
2bd20 6e 64 5f 2a 28 29 20 72 6f 75 74 69 6e 65 73 20  nd_*() routines 
2bd30 69 73 20 61 6c 77 61 79 73 0a 2a 2a 20 61 20 70  is always.** a p
2bd40 6f 69 6e 74 65 72 20 74 6f 20 74 68 65 20 5b 73  ointer to the [s
2bd50 71 6c 69 74 65 33 5f 73 74 6d 74 5d 20 6f 62 6a  qlite3_stmt] obj
2bd60 65 63 74 20 72 65 74 75 72 6e 65 64 20 66 72 6f  ect returned fro
2bd70 6d 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 70 72  m.** [sqlite3_pr
2bd80 65 70 61 72 65 5f 76 32 28 29 5d 20 6f 72 20 69  epare_v2()] or i
2bd90 74 73 20 76 61 72 69 61 6e 74 73 2e 0a 2a 2a 0a  ts variants..**.
2bda0 2a 2a 20 5e 54 68 65 20 73 65 63 6f 6e 64 20 61  ** ^The second a
2bdb0 72 67 75 6d 65 6e 74 20 69 73 20 74 68 65 20 69  rgument is the i
2bdc0 6e 64 65 78 20 6f 66 20 74 68 65 20 53 51 4c 20  ndex of the SQL 
2bdd0 70 61 72 61 6d 65 74 65 72 20 74 6f 20 62 65 20  parameter to be 
2bde0 73 65 74 2e 0a 2a 2a 20 5e 54 68 65 20 6c 65 66  set..** ^The lef
2bdf0 74 6d 6f 73 74 20 53 51 4c 20 70 61 72 61 6d 65  tmost SQL parame
2be00 74 65 72 20 68 61 73 20 61 6e 20 69 6e 64 65 78  ter has an index
2be10 20 6f 66 20 31 2e 20 20 5e 57 68 65 6e 20 74 68   of 1.  ^When th
2be20 65 20 73 61 6d 65 20 6e 61 6d 65 64 0a 2a 2a 20  e same named.** 
2be30 53 51 4c 20 70 61 72 61 6d 65 74 65 72 20 69 73  SQL parameter is
2be40 20 75 73 65 64 20 6d 6f 72 65 20 74 68 61 6e 20   used more than 
2be50 6f 6e 63 65 2c 20 73 65 63 6f 6e 64 20 61 6e 64  once, second and
2be60 20 73 75 62 73 65 71 75 65 6e 74 0a 2a 2a 20 6f   subsequent.** o
2be70 63 63 75 72 72 65 6e 63 65 73 20 68 61 76 65 20  ccurrences have 
2be80 74 68 65 20 73 61 6d 65 20 69 6e 64 65 78 20 61  the same index a
2be90 73 20 74 68 65 20 66 69 72 73 74 20 6f 63 63 75  s the first occu
2bea0 72 72 65 6e 63 65 2e 0a 2a 2a 20 5e 54 68 65 20  rrence..** ^The 
2beb0 69 6e 64 65 78 20 66 6f 72 20 6e 61 6d 65 64 20  index for named 
2bec0 70 61 72 61 6d 65 74 65 72 73 20 63 61 6e 20 62  parameters can b
2bed0 65 20 6c 6f 6f 6b 65 64 20 75 70 20 75 73 69 6e  e looked up usin
2bee0 67 20 74 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65  g the.** [sqlite
2bef0 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65 72  3_bind_parameter
2bf00 5f 69 6e 64 65 78 28 29 5d 20 41 50 49 20 69 66  _index()] API if
2bf10 20 64 65 73 69 72 65 64 2e 20 20 5e 54 68 65 20   desired.  ^The 
2bf20 69 6e 64 65 78 0a 2a 2a 20 66 6f 72 20 22 3f 4e  index.** for "?N
2bf30 4e 4e 22 20 70 61 72 61 6d 65 74 65 72 73 20 69  NN" parameters i
2bf40 73 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20 4e  s the value of N
2bf50 4e 4e 2e 0a 2a 2a 20 5e 54 68 65 20 4e 4e 4e 20  NN..** ^The NNN 
2bf60 76 61 6c 75 65 20 6d 75 73 74 20 62 65 20 62 65  value must be be
2bf70 74 77 65 65 6e 20 31 20 61 6e 64 20 74 68 65 20  tween 1 and the 
2bf80 5b 73 71 6c 69 74 65 33 5f 6c 69 6d 69 74 28 29  [sqlite3_limit()
2bf90 5d 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72 20 5b  ].** parameter [
2bfa0 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 56 41 52  SQLITE_LIMIT_VAR
2bfb0 49 41 42 4c 45 5f 4e 55 4d 42 45 52 5d 20 28 64  IABLE_NUMBER] (d
2bfc0 65 66 61 75 6c 74 20 76 61 6c 75 65 3a 20 39 39  efault value: 99
2bfd0 39 29 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 74  9)..**.** ^The t
2bfe0 68 69 72 64 20 61 72 67 75 6d 65 6e 74 20 69 73  hird argument is
2bff0 20 74 68 65 20 76 61 6c 75 65 20 74 6f 20 62 69   the value to bi
2c000 6e 64 20 74 6f 20 74 68 65 20 70 61 72 61 6d 65  nd to the parame
2c010 74 65 72 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20  ter..** ^If the 
2c020 74 68 69 72 64 20 70 61 72 61 6d 65 74 65 72 20  third parameter 
2c030 74 6f 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  to sqlite3_bind_
2c040 74 65 78 74 28 29 20 6f 72 20 73 71 6c 69 74 65  text() or sqlite
2c050 33 5f 62 69 6e 64 5f 74 65 78 74 31 36 28 29 0a  3_bind_text16().
2c060 2a 2a 20 6f 72 20 73 71 6c 69 74 65 33 5f 62 69  ** or sqlite3_bi
2c070 6e 64 5f 62 6c 6f 62 28 29 20 69 73 20 61 20 4e  nd_blob() is a N
2c080 55 4c 4c 20 70 6f 69 6e 74 65 72 20 74 68 65 6e  ULL pointer then
2c090 20 74 68 65 20 66 6f 75 72 74 68 20 70 61 72 61   the fourth para
2c0a0 6d 65 74 65 72 0a 2a 2a 20 69 73 20 69 67 6e 6f  meter.** is igno
2c0b0 72 65 64 20 61 6e 64 20 74 68 65 20 65 6e 64 20  red and the end 
2c0c0 72 65 73 75 6c 74 20 69 73 20 74 68 65 20 73 61  result is the sa
2c0d0 6d 65 20 61 73 20 73 71 6c 69 74 65 33 5f 62 69  me as sqlite3_bi
2c0e0 6e 64 5f 6e 75 6c 6c 28 29 2e 0a 2a 2a 0a 2a 2a  nd_null()..**.**
2c0f0 20 5e 28 49 6e 20 74 68 6f 73 65 20 72 6f 75 74   ^(In those rout
2c100 69 6e 65 73 20 74 68 61 74 20 68 61 76 65 20 61  ines that have a
2c110 20 66 6f 75 72 74 68 20 61 72 67 75 6d 65 6e 74   fourth argument
2c120 2c 20 69 74 73 20 76 61 6c 75 65 20 69 73 20 74  , its value is t
2c130 68 65 0a 2a 2a 20 6e 75 6d 62 65 72 20 6f 66 20  he.** number of 
2c140 62 79 74 65 73 20 69 6e 20 74 68 65 20 70 61 72  bytes in the par
2c150 61 6d 65 74 65 72 2e 20 20 54 6f 20 62 65 20 63  ameter.  To be c
2c160 6c 65 61 72 3a 20 74 68 65 20 76 61 6c 75 65 20  lear: the value 
2c170 69 73 20 74 68 65 0a 2a 2a 20 6e 75 6d 62 65 72  is the.** number
2c180 20 6f 66 20 3c 75 3e 62 79 74 65 73 3c 2f 75 3e   of <u>bytes</u>
2c190 20 69 6e 20 74 68 65 20 76 61 6c 75 65 2c 20 6e   in the value, n
2c1a0 6f 74 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  ot the number of
2c1b0 20 63 68 61 72 61 63 74 65 72 73 2e 29 5e 0a 2a   characters.)^.*
2c1c0 2a 20 5e 49 66 20 74 68 65 20 66 6f 75 72 74 68  * ^If the fourth
2c1d0 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71   parameter to sq
2c1e0 6c 69 74 65 33 5f 62 69 6e 64 5f 74 65 78 74 28  lite3_bind_text(
2c1f0 29 20 6f 72 20 73 71 6c 69 74 65 33 5f 62 69 6e  ) or sqlite3_bin
2c200 64 5f 74 65 78 74 31 36 28 29 0a 2a 2a 20 69 73  d_text16().** is
2c210 20 6e 65 67 61 74 69 76 65 2c 20 74 68 65 6e 20   negative, then 
2c220 74 68 65 20 6c 65 6e 67 74 68 20 6f 66 20 74 68  the length of th
2c230 65 20 73 74 72 69 6e 67 20 69 73 0a 2a 2a 20 74  e string is.** t
2c240 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74  he number of byt
2c250 65 73 20 75 70 20 74 6f 20 74 68 65 20 66 69 72  es up to the fir
2c260 73 74 20 7a 65 72 6f 20 74 65 72 6d 69 6e 61 74  st zero terminat
2c270 6f 72 2e 0a 2a 2a 20 49 66 20 74 68 65 20 66 6f  or..** If the fo
2c280 75 72 74 68 20 70 61 72 61 6d 65 74 65 72 20 74  urth parameter t
2c290 6f 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 62  o sqlite3_bind_b
2c2a0 6c 6f 62 28 29 20 69 73 20 6e 65 67 61 74 69 76  lob() is negativ
2c2b0 65 2c 20 74 68 65 6e 0a 2a 2a 20 74 68 65 20 62  e, then.** the b
2c2c0 65 68 61 76 69 6f 72 20 69 73 20 75 6e 64 65 66  ehavior is undef
2c2d0 69 6e 65 64 2e 0a 2a 2a 20 49 66 20 61 20 6e 6f  ined..** If a no
2c2e0 6e 2d 6e 65 67 61 74 69 76 65 20 66 6f 75 72 74  n-negative fourt
2c2f0 68 20 70 61 72 61 6d 65 74 65 72 20 69 73 20 70  h parameter is p
2c300 72 6f 76 69 64 65 64 20 74 6f 20 73 71 6c 69 74  rovided to sqlit
2c310 65 33 5f 62 69 6e 64 5f 74 65 78 74 28 29 0a 2a  e3_bind_text().*
2c320 2a 20 6f 72 20 73 71 6c 69 74 65 33 5f 62 69 6e  * or sqlite3_bin
2c330 64 5f 74 65 78 74 31 36 28 29 20 6f 72 20 73 71  d_text16() or sq
2c340 6c 69 74 65 33 5f 62 69 6e 64 5f 74 65 78 74 36  lite3_bind_text6
2c350 34 28 29 20 74 68 65 6e 0a 2a 2a 20 74 68 61 74  4() then.** that
2c360 20 70 61 72 61 6d 65 74 65 72 20 6d 75 73 74 20   parameter must 
2c370 62 65 20 74 68 65 20 62 79 74 65 20 6f 66 66 73  be the byte offs
2c380 65 74 0a 2a 2a 20 77 68 65 72 65 20 74 68 65 20  et.** where the 
2c390 4e 55 4c 20 74 65 72 6d 69 6e 61 74 6f 72 20 77  NUL terminator w
2c3a0 6f 75 6c 64 20 6f 63 63 75 72 20 61 73 73 75 6d  ould occur assum
2c3b0 69 6e 67 20 74 68 65 20 73 74 72 69 6e 67 20 77  ing the string w
2c3c0 65 72 65 20 4e 55 4c 0a 2a 2a 20 74 65 72 6d 69  ere NUL.** termi
2c3d0 6e 61 74 65 64 2e 20 20 49 66 20 61 6e 79 20 4e  nated.  If any N
2c3e0 55 4c 20 63 68 61 72 61 63 74 65 72 73 20 6f 63  UL characters oc
2c3f0 63 75 72 20 61 74 20 62 79 74 65 20 6f 66 66 73  cur at byte offs
2c400 65 74 73 20 6c 65 73 73 20 74 68 61 6e 20 0a 2a  ets less than .*
2c410 2a 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20 74  * the value of t
2c420 68 65 20 66 6f 75 72 74 68 20 70 61 72 61 6d 65  he fourth parame
2c430 74 65 72 20 74 68 65 6e 20 74 68 65 20 72 65 73  ter then the res
2c440 75 6c 74 69 6e 67 20 73 74 72 69 6e 67 20 76 61  ulting string va
2c450 6c 75 65 20 77 69 6c 6c 0a 2a 2a 20 63 6f 6e 74  lue will.** cont
2c460 61 69 6e 20 65 6d 62 65 64 64 65 64 20 4e 55 4c  ain embedded NUL
2c470 73 2e 20 20 54 68 65 20 72 65 73 75 6c 74 20 6f  s.  The result o
2c480 66 20 65 78 70 72 65 73 73 69 6f 6e 73 20 69 6e  f expressions in
2c490 76 6f 6c 76 69 6e 67 20 73 74 72 69 6e 67 73 0a  volving strings.
2c4a0 2a 2a 20 77 69 74 68 20 65 6d 62 65 64 64 65 64  ** with embedded
2c4b0 20 4e 55 4c 73 20 69 73 20 75 6e 64 65 66 69 6e   NULs is undefin
2c4c0 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66  ed..**.** ^The f
2c4d0 69 66 74 68 20 61 72 67 75 6d 65 6e 74 20 74 6f  ifth argument to
2c4e0 20 74 68 65 20 42 4c 4f 42 20 61 6e 64 20 73 74   the BLOB and st
2c4f0 72 69 6e 67 20 62 69 6e 64 69 6e 67 20 69 6e 74  ring binding int
2c500 65 72 66 61 63 65 73 0a 2a 2a 20 69 73 20 61 20  erfaces.** is a 
2c510 64 65 73 74 72 75 63 74 6f 72 20 75 73 65 64 20  destructor used 
2c520 74 6f 20 64 69 73 70 6f 73 65 20 6f 66 20 74 68  to dispose of th
2c530 65 20 42 4c 4f 42 20 6f 72 0a 2a 2a 20 73 74 72  e BLOB or.** str
2c540 69 6e 67 20 61 66 74 65 72 20 53 51 4c 69 74 65  ing after SQLite
2c550 20 68 61 73 20 66 69 6e 69 73 68 65 64 20 77 69   has finished wi
2c560 74 68 20 69 74 2e 20 20 5e 54 68 65 20 64 65 73  th it.  ^The des
2c570 74 72 75 63 74 6f 72 20 69 73 20 63 61 6c 6c 65  tructor is calle
2c580 64 0a 2a 2a 20 74 6f 20 64 69 73 70 6f 73 65 20  d.** to dispose 
2c590 6f 66 20 74 68 65 20 42 4c 4f 42 20 6f 72 20 73  of the BLOB or s
2c5a0 74 72 69 6e 67 20 65 76 65 6e 20 69 66 20 74 68  tring even if th
2c5b0 65 20 63 61 6c 6c 20 74 6f 20 62 69 6e 64 20 41  e call to bind A
2c5c0 50 49 20 66 61 69 6c 73 2e 0a 2a 2a 20 5e 49 66  PI fails..** ^If
2c5d0 20 74 68 65 20 66 69 66 74 68 20 61 72 67 75 6d   the fifth argum
2c5e0 65 6e 74 20 69 73 0a 2a 2a 20 74 68 65 20 73 70  ent is.** the sp
2c5f0 65 63 69 61 6c 20 76 61 6c 75 65 20 5b 53 51 4c  ecial value [SQL
2c600 49 54 45 5f 53 54 41 54 49 43 5d 2c 20 74 68 65  ITE_STATIC], the
2c610 6e 20 53 51 4c 69 74 65 20 61 73 73 75 6d 65 73  n SQLite assumes
2c620 20 74 68 61 74 20 74 68 65 0a 2a 2a 20 69 6e 66   that the.** inf
2c630 6f 72 6d 61 74 69 6f 6e 20 69 73 20 69 6e 20 73  ormation is in s
2c640 74 61 74 69 63 2c 20 75 6e 6d 61 6e 61 67 65 64  tatic, unmanaged
2c650 20 73 70 61 63 65 20 61 6e 64 20 64 6f 65 73 20   space and does 
2c660 6e 6f 74 20 6e 65 65 64 20 74 6f 20 62 65 20 66  not need to be f
2c670 72 65 65 64 2e 0a 2a 2a 20 5e 49 66 20 74 68 65  reed..** ^If the
2c680 20 66 69 66 74 68 20 61 72 67 75 6d 65 6e 74 20   fifth argument 
2c690 68 61 73 20 74 68 65 20 76 61 6c 75 65 20 5b 53  has the value [S
2c6a0 51 4c 49 54 45 5f 54 52 41 4e 53 49 45 4e 54 5d  QLITE_TRANSIENT]
2c6b0 2c 20 74 68 65 6e 0a 2a 2a 20 53 51 4c 69 74 65  , then.** SQLite
2c6c0 20 6d 61 6b 65 73 20 69 74 73 20 6f 77 6e 20 70   makes its own p
2c6d0 72 69 76 61 74 65 20 63 6f 70 79 20 6f 66 20 74  rivate copy of t
2c6e0 68 65 20 64 61 74 61 20 69 6d 6d 65 64 69 61 74  he data immediat
2c6f0 65 6c 79 2c 20 62 65 66 6f 72 65 0a 2a 2a 20 74  ely, before.** t
2c700 68 65 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  he sqlite3_bind_
2c710 2a 28 29 20 72 6f 75 74 69 6e 65 20 72 65 74 75  *() routine retu
2c720 72 6e 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  rns..**.** ^The 
2c730 73 69 78 74 68 20 61 72 67 75 6d 65 6e 74 20 74  sixth argument t
2c740 6f 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74  o sqlite3_bind_t
2c750 65 78 74 36 34 28 29 20 6d 75 73 74 20 62 65 20  ext64() must be 
2c760 6f 6e 65 20 6f 66 0a 2a 2a 20 5b 53 51 4c 49 54  one of.** [SQLIT
2c770 45 5f 55 54 46 38 5d 2c 20 5b 53 51 4c 49 54 45  E_UTF8], [SQLITE
2c780 5f 55 54 46 31 36 5d 2c 20 5b 53 51 4c 49 54 45  _UTF16], [SQLITE
2c790 5f 55 54 46 31 36 42 45 5d 2c 20 6f 72 20 5b 53  _UTF16BE], or [S
2c7a0 51 4c 49 54 45 5f 55 54 46 31 36 4c 45 5d 0a 2a  QLITE_UTF16LE].*
2c7b0 2a 20 74 6f 20 73 70 65 63 69 66 79 20 74 68 65  * to specify the
2c7c0 20 65 6e 63 6f 64 69 6e 67 20 6f 66 20 74 68 65   encoding of the
2c7d0 20 74 65 78 74 20 69 6e 20 74 68 65 20 74 68 69   text in the thi
2c7e0 72 64 20 70 61 72 61 6d 65 74 65 72 2e 20 20 49  rd parameter.  I
2c7f0 66 0a 2a 2a 20 74 68 65 20 73 69 78 74 68 20 61  f.** the sixth a
2c800 72 67 75 6d 65 6e 74 20 74 6f 20 73 71 6c 69 74  rgument to sqlit
2c810 65 33 5f 62 69 6e 64 5f 74 65 78 74 36 34 28 29  e3_bind_text64()
2c820 20 69 73 20 6e 6f 74 20 6f 6e 65 20 6f 66 20 74   is not one of t
2c830 68 65 0a 2a 2a 20 61 6c 6c 6f 77 65 64 20 76 61  he.** allowed va
2c840 6c 75 65 73 20 73 68 6f 77 6e 20 61 62 6f 76 65  lues shown above
2c850 2c 20 6f 72 20 69 66 20 74 68 65 20 74 65 78 74  , or if the text
2c860 20 65 6e 63 6f 64 69 6e 67 20 69 73 20 64 69 66   encoding is dif
2c870 66 65 72 65 6e 74 0a 2a 2a 20 66 72 6f 6d 20 74  ferent.** from t
2c880 68 65 20 65 6e 63 6f 64 69 6e 67 20 73 70 65 63  he encoding spec
2c890 69 66 69 65 64 20 62 79 20 74 68 65 20 73 69 78  ified by the six
2c8a0 74 68 20 70 61 72 61 6d 65 74 65 72 2c 20 74 68  th parameter, th
2c8b0 65 6e 20 74 68 65 20 62 65 68 61 76 69 6f 72 0a  en the behavior.
2c8c0 2a 2a 20 69 73 20 75 6e 64 65 66 69 6e 65 64 2e  ** is undefined.
2c8d0 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69  .**.** ^The sqli
2c8e0 74 65 33 5f 62 69 6e 64 5f 7a 65 72 6f 62 6c 6f  te3_bind_zeroblo
2c8f0 62 28 29 20 72 6f 75 74 69 6e 65 20 62 69 6e 64  b() routine bind
2c900 73 20 61 20 42 4c 4f 42 20 6f 66 20 6c 65 6e 67  s a BLOB of leng
2c910 74 68 20 4e 20 74 68 61 74 0a 2a 2a 20 69 73 20  th N that.** is 
2c920 66 69 6c 6c 65 64 20 77 69 74 68 20 7a 65 72 6f  filled with zero
2c930 65 73 2e 20 20 5e 41 20 7a 65 72 6f 62 6c 6f 62  es.  ^A zeroblob
2c940 20 75 73 65 73 20 61 20 66 69 78 65 64 20 61 6d   uses a fixed am
2c950 6f 75 6e 74 20 6f 66 20 6d 65 6d 6f 72 79 0a 2a  ount of memory.*
2c960 2a 20 28 6a 75 73 74 20 61 6e 20 69 6e 74 65 67  * (just an integ
2c970 65 72 20 74 6f 20 68 6f 6c 64 20 69 74 73 20 73  er to hold its s
2c980 69 7a 65 29 20 77 68 69 6c 65 20 69 74 20 69 73  ize) while it is
2c990 20 62 65 69 6e 67 20 70 72 6f 63 65 73 73 65 64   being processed
2c9a0 2e 0a 2a 2a 20 5a 65 72 6f 62 6c 6f 62 73 20 61  ..** Zeroblobs a
2c9b0 72 65 20 69 6e 74 65 6e 64 65 64 20 74 6f 20 73  re intended to s
2c9c0 65 72 76 65 20 61 73 20 70 6c 61 63 65 68 6f 6c  erve as placehol
2c9d0 64 65 72 73 20 66 6f 72 20 42 4c 4f 42 73 20 77  ders for BLOBs w
2c9e0 68 6f 73 65 0a 2a 2a 20 63 6f 6e 74 65 6e 74 20  hose.** content 
2c9f0 69 73 20 6c 61 74 65 72 20 77 72 69 74 74 65 6e  is later written
2ca00 20 75 73 69 6e 67 0a 2a 2a 20 5b 73 71 6c 69 74   using.** [sqlit
2ca10 65 33 5f 62 6c 6f 62 5f 6f 70 65 6e 20 7c 20 69  e3_blob_open | i
2ca20 6e 63 72 65 6d 65 6e 74 61 6c 20 42 4c 4f 42 20  ncremental BLOB 
2ca30 49 2f 4f 5d 20 72 6f 75 74 69 6e 65 73 2e 0a 2a  I/O] routines..*
2ca40 2a 20 5e 41 20 6e 65 67 61 74 69 76 65 20 76 61  * ^A negative va
2ca50 6c 75 65 20 66 6f 72 20 74 68 65 20 7a 65 72 6f  lue for the zero
2ca60 62 6c 6f 62 20 72 65 73 75 6c 74 73 20 69 6e 20  blob results in 
2ca70 61 20 7a 65 72 6f 2d 6c 65 6e 67 74 68 20 42 4c  a zero-length BL
2ca80 4f 42 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 61 6e  OB..**.** ^If an
2ca90 79 20 6f 66 20 74 68 65 20 73 71 6c 69 74 65 33  y of the sqlite3
2caa0 5f 62 69 6e 64 5f 2a 28 29 20 72 6f 75 74 69 6e  _bind_*() routin
2cab0 65 73 20 61 72 65 20 63 61 6c 6c 65 64 20 77 69  es are called wi
2cac0 74 68 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  th a NULL pointe
2cad0 72 0a 2a 2a 20 66 6f 72 20 74 68 65 20 5b 70 72  r.** for the [pr
2cae0 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
2caf0 5d 20 6f 72 20 77 69 74 68 20 61 20 70 72 65 70  ] or with a prep
2cb00 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 20 66  ared statement f
2cb10 6f 72 20 77 68 69 63 68 0a 2a 2a 20 5b 73 71 6c  or which.** [sql
2cb20 69 74 65 33 5f 73 74 65 70 28 29 5d 20 68 61 73  ite3_step()] has
2cb30 20 62 65 65 6e 20 63 61 6c 6c 65 64 20 6d 6f 72   been called mor
2cb40 65 20 72 65 63 65 6e 74 6c 79 20 74 68 61 6e 20  e recently than 
2cb50 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29  [sqlite3_reset()
2cb60 5d 2c 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20 63  ],.** then the c
2cb70 61 6c 6c 20 77 69 6c 6c 20 72 65 74 75 72 6e 20  all will return 
2cb80 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 5d 2e  [SQLITE_MISUSE].
2cb90 20 20 49 66 20 61 6e 79 20 73 71 6c 69 74 65 33    If any sqlite3
2cba0 5f 62 69 6e 64 5f 28 29 0a 2a 2a 20 72 6f 75 74  _bind_().** rout
2cbb0 69 6e 65 20 69 73 20 70 61 73 73 65 64 20 61 20  ine is passed a 
2cbc0 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d  [prepared statem
2cbd0 65 6e 74 5d 20 74 68 61 74 20 68 61 73 20 62 65  ent] that has be
2cbe0 65 6e 20 66 69 6e 61 6c 69 7a 65 64 2c 20 74 68  en finalized, th
2cbf0 65 0a 2a 2a 20 72 65 73 75 6c 74 20 69 73 20 75  e.** result is u
2cc00 6e 64 65 66 69 6e 65 64 20 61 6e 64 20 70 72 6f  ndefined and pro
2cc10 62 61 62 6c 79 20 68 61 72 6d 66 75 6c 2e 0a 2a  bably harmful..*
2cc20 2a 0a 2a 2a 20 5e 42 69 6e 64 69 6e 67 73 20 61  *.** ^Bindings a
2cc30 72 65 20 6e 6f 74 20 63 6c 65 61 72 65 64 20 62  re not cleared b
2cc40 79 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 72  y the [sqlite3_r
2cc50 65 73 65 74 28 29 5d 20 72 6f 75 74 69 6e 65 2e  eset()] routine.
2cc60 0a 2a 2a 20 5e 55 6e 62 6f 75 6e 64 20 70 61 72  .** ^Unbound par
2cc70 61 6d 65 74 65 72 73 20 61 72 65 20 69 6e 74 65  ameters are inte
2cc80 72 70 72 65 74 65 64 20 61 73 20 4e 55 4c 4c 2e  rpreted as NULL.
2cc90 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69  .**.** ^The sqli
2cca0 74 65 33 5f 62 69 6e 64 5f 2a 20 72 6f 75 74 69  te3_bind_* routi
2ccb0 6e 65 73 20 72 65 74 75 72 6e 20 5b 53 51 4c 49  nes return [SQLI
2ccc0 54 45 5f 4f 4b 5d 20 6f 6e 20 73 75 63 63 65 73  TE_OK] on succes
2ccd0 73 20 6f 72 20 61 6e 0a 2a 2a 20 5b 65 72 72 6f  s or an.** [erro
2cce0 72 20 63 6f 64 65 5d 20 69 66 20 61 6e 79 74 68  r code] if anyth
2ccf0 69 6e 67 20 67 6f 65 73 20 77 72 6f 6e 67 2e 0a  ing goes wrong..
2cd00 2a 2a 20 5e 5b 53 51 4c 49 54 45 5f 54 4f 4f 42  ** ^[SQLITE_TOOB
2cd10 49 47 5d 20 6d 69 67 68 74 20 62 65 20 72 65 74  IG] might be ret
2cd20 75 72 6e 65 64 20 69 66 20 74 68 65 20 73 69 7a  urned if the siz
2cd30 65 20 6f 66 20 61 20 73 74 72 69 6e 67 20 6f 72  e of a string or
2cd40 20 42 4c 4f 42 0a 2a 2a 20 65 78 63 65 65 64 73   BLOB.** exceeds
2cd50 20 6c 69 6d 69 74 73 20 69 6d 70 6f 73 65 64 20   limits imposed 
2cd60 62 79 20 5b 73 71 6c 69 74 65 33 5f 6c 69 6d 69  by [sqlite3_limi
2cd70 74 5d 28 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54  t]([SQLITE_LIMIT
2cd80 5f 4c 45 4e 47 54 48 5d 29 20 6f 72 0a 2a 2a 20  _LENGTH]) or.** 
2cd90 5b 53 51 4c 49 54 45 5f 4d 41 58 5f 4c 45 4e 47  [SQLITE_MAX_LENG
2cda0 54 48 5d 2e 0a 2a 2a 20 5e 5b 53 51 4c 49 54 45  TH]..** ^[SQLITE
2cdb0 5f 52 41 4e 47 45 5d 20 69 73 20 72 65 74 75 72  _RANGE] is retur
2cdc0 6e 65 64 20 69 66 20 74 68 65 20 70 61 72 61 6d  ned if the param
2cdd0 65 74 65 72 0a 2a 2a 20 69 6e 64 65 78 20 69 73  eter.** index is
2cde0 20 6f 75 74 20 6f 66 20 72 61 6e 67 65 2e 20 20   out of range.  
2cdf0 5e 5b 53 51 4c 49 54 45 5f 4e 4f 4d 45 4d 5d 20  ^[SQLITE_NOMEM] 
2ce00 69 73 20 72 65 74 75 72 6e 65 64 20 69 66 20 6d  is returned if m
2ce10 61 6c 6c 6f 63 28 29 20 66 61 69 6c 73 2e 0a 2a  alloc() fails..*
2ce20 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 3a 20 5b  *.** See also: [
2ce30 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61 72  sqlite3_bind_par
2ce40 61 6d 65 74 65 72 5f 63 6f 75 6e 74 28 29 5d 2c  ameter_count()],
2ce50 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e  .** [sqlite3_bin
2ce60 64 5f 70 61 72 61 6d 65 74 65 72 5f 6e 61 6d 65  d_parameter_name
2ce70 28 29 5d 2c 20 61 6e 64 20 5b 73 71 6c 69 74 65  ()], and [sqlite
2ce80 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65 72  3_bind_parameter
2ce90 5f 69 6e 64 65 78 28 29 5d 2e 0a 2a 2f 0a 69 6e  _index()]..*/.in
2cea0 74 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 62  t sqlite3_bind_b
2ceb0 6c 6f 62 28 73 71 6c 69 74 65 33 5f 73 74 6d 74  lob(sqlite3_stmt
2cec0 2a 2c 20 69 6e 74 2c 20 63 6f 6e 73 74 20 76 6f  *, int, const vo
2ced0 69 64 2a 2c 20 69 6e 74 20 6e 2c 20 76 6f 69 64  id*, int n, void
2cee0 28 2a 29 28 76 6f 69 64 2a 29 29 3b 0a 69 6e 74  (*)(void*));.int
2cef0 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 62 6c   sqlite3_bind_bl
2cf00 6f 62 36 34 28 73 71 6c 69 74 65 33 5f 73 74 6d  ob64(sqlite3_stm
2cf10 74 2a 2c 20 69 6e 74 2c 20 63 6f 6e 73 74 20 76  t*, int, const v
2cf20 6f 69 64 2a 2c 20 73 71 6c 69 74 65 33 5f 75 69  oid*, sqlite3_ui
2cf30 6e 74 36 34 2c 0a 20 20 20 20 20 20 20 20 20 20  nt64,.          
2cf40 20 20 20 20 20 20 20 20 20 20 20 20 20 20 76 6f                vo
2cf50 69 64 28 2a 29 28 76 6f 69 64 2a 29 29 3b 0a 69  id(*)(void*));.i
2cf60 6e 74 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  nt sqlite3_bind_
2cf70 64 6f 75 62 6c 65 28 73 71 6c 69 74 65 33 5f 73  double(sqlite3_s
2cf80 74 6d 74 2a 2c 20 69 6e 74 2c 20 64 6f 75 62 6c  tmt*, int, doubl
2cf90 65 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  e);.int sqlite3_
2cfa0 62 69 6e 64 5f 69 6e 74 28 73 71 6c 69 74 65 33  bind_int(sqlite3
2cfb0 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c 20 69 6e 74  _stmt*, int, int
2cfc0 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62  );.int sqlite3_b
2cfd0 69 6e 64 5f 69 6e 74 36 34 28 73 71 6c 69 74 65  ind_int64(sqlite
2cfe0 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c 20 73 71  3_stmt*, int, sq
2cff0 6c 69 74 65 33 5f 69 6e 74 36 34 29 3b 0a 69 6e  lite3_int64);.in
2d000 74 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 6e  t sqlite3_bind_n
2d010 75 6c 6c 28 73 71 6c 69 74 65 33 5f 73 74 6d 74  ull(sqlite3_stmt
2d020 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c  *, int);.int sql
2d030 69 74 65 33 5f 62 69 6e 64 5f 74 65 78 74 28 73  ite3_bind_text(s
2d040 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 69 6e 74  qlite3_stmt*,int
2d050 2c 63 6f 6e 73 74 20 63 68 61 72 2a 2c 69 6e 74  ,const char*,int
2d060 2c 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a 29 29  ,void(*)(void*))
2d070 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62 69  ;.int sqlite3_bi
2d080 6e 64 5f 74 65 78 74 31 36 28 73 71 6c 69 74 65  nd_text16(sqlite
2d090 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c 20 63 6f  3_stmt*, int, co
2d0a0 6e 73 74 20 76 6f 69 64 2a 2c 20 69 6e 74 2c 20  nst void*, int, 
2d0b0 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a 29 29 3b  void(*)(void*));
2d0c0 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62 69 6e  .int sqlite3_bin
2d0d0 64 5f 74 65 78 74 36 34 28 73 71 6c 69 74 65 33  d_text64(sqlite3
2d0e0 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c 20 63 6f 6e  _stmt*, int, con
2d0f0 73 74 20 63 68 61 72 2a 2c 20 73 71 6c 69 74 65  st char*, sqlite
2d100 33 5f 75 69 6e 74 36 34 2c 0a 20 20 20 20 20 20  3_uint64,.      
2d110 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2d120 20 20 20 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a     void(*)(void*
2d130 29 2c 20 75 6e 73 69 67 6e 65 64 20 63 68 61 72  ), unsigned char
2d140 20 65 6e 63 6f 64 69 6e 67 29 3b 0a 69 6e 74 20   encoding);.int 
2d150 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 76 61 6c  sqlite3_bind_val
2d160 75 65 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a  ue(sqlite3_stmt*
2d170 2c 20 69 6e 74 2c 20 63 6f 6e 73 74 20 73 71 6c  , int, const sql
2d180 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 69 6e  ite3_value*);.in
2d190 74 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 7a  t sqlite3_bind_z
2d1a0 65 72 6f 62 6c 6f 62 28 73 71 6c 69 74 65 33 5f  eroblob(sqlite3_
2d1b0 73 74 6d 74 2a 2c 20 69 6e 74 2c 20 69 6e 74 20  stmt*, int, int 
2d1c0 6e 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  n);.int sqlite3_
2d1d0 62 69 6e 64 5f 7a 65 72 6f 62 6c 6f 62 36 34 28  bind_zeroblob64(
2d1e0 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69  sqlite3_stmt*, i
2d1f0 6e 74 2c 20 73 71 6c 69 74 65 33 5f 75 69 6e 74  nt, sqlite3_uint
2d200 36 34 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  64);../*.** CAPI
2d210 33 52 45 46 3a 20 4e 75 6d 62 65 72 20 4f 66 20  3REF: Number Of 
2d220 53 51 4c 20 50 61 72 61 6d 65 74 65 72 73 0a 2a  SQL Parameters.*
2d230 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65  * METHOD: sqlite
2d240 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54 68  3_stmt.**.** ^Th
2d250 69 73 20 72 6f 75 74 69 6e 65 20 63 61 6e 20 62  is routine can b
2d260 65 20 75 73 65 64 20 74 6f 20 66 69 6e 64 20 74  e used to find t
2d270 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 5b 53 51  he number of [SQ
2d280 4c 20 70 61 72 61 6d 65 74 65 72 73 5d 0a 2a 2a  L parameters].**
2d290 20 69 6e 20 61 20 5b 70 72 65 70 61 72 65 64 20   in a [prepared 
2d2a0 73 74 61 74 65 6d 65 6e 74 5d 2e 20 20 53 51 4c  statement].  SQL
2d2b0 20 70 61 72 61 6d 65 74 65 72 73 20 61 72 65 20   parameters are 
2d2c0 74 6f 6b 65 6e 73 20 6f 66 20 74 68 65 0a 2a 2a  tokens of the.**
2d2d0 20 66 6f 72 6d 20 22 3f 22 2c 20 22 3f 4e 4e 4e   form "?", "?NNN
2d2e0 22 2c 20 22 3a 41 41 41 22 2c 20 22 24 41 41 41  ", ":AAA", "$AAA
2d2f0 22 2c 20 6f 72 20 22 40 41 41 41 22 20 74 68 61  ", or "@AAA" tha
2d300 74 20 73 65 72 76 65 20 61 73 0a 2a 2a 20 70 6c  t serve as.** pl
2d310 61 63 65 68 6f 6c 64 65 72 73 20 66 6f 72 20 76  aceholders for v
2d320 61 6c 75 65 73 20 74 68 61 74 20 61 72 65 20 5b  alues that are [
2d330 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 62 6c 6f  sqlite3_bind_blo
2d340 62 20 7c 20 62 6f 75 6e 64 5d 0a 2a 2a 20 74 6f  b | bound].** to
2d350 20 74 68 65 20 70 61 72 61 6d 65 74 65 72 73 20   the parameters 
2d360 61 74 20 61 20 6c 61 74 65 72 20 74 69 6d 65 2e  at a later time.
2d370 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 69 73 20 72 6f  .**.** ^(This ro
2d380 75 74 69 6e 65 20 61 63 74 75 61 6c 6c 79 20 72  utine actually r
2d390 65 74 75 72 6e 73 20 74 68 65 20 69 6e 64 65 78  eturns the index
2d3a0 20 6f 66 20 74 68 65 20 6c 61 72 67 65 73 74 20   of the largest 
2d3b0 28 72 69 67 68 74 6d 6f 73 74 29 0a 2a 2a 20 70  (rightmost).** p
2d3c0 61 72 61 6d 65 74 65 72 2e 20 46 6f 72 20 61 6c  arameter. For al
2d3d0 6c 20 66 6f 72 6d 73 20 65 78 63 65 70 74 20 3f  l forms except ?
2d3e0 4e 4e 4e 2c 20 74 68 69 73 20 77 69 6c 6c 20 63  NNN, this will c
2d3f0 6f 72 72 65 73 70 6f 6e 64 20 74 6f 20 74 68 65  orrespond to the
2d400 0a 2a 2a 20 6e 75 6d 62 65 72 20 6f 66 20 75 6e  .** number of un
2d410 69 71 75 65 20 70 61 72 61 6d 65 74 65 72 73 2e  ique parameters.
2d420 20 20 49 66 20 70 61 72 61 6d 65 74 65 72 73 20    If parameters 
2d430 6f 66 20 74 68 65 20 3f 4e 4e 4e 20 66 6f 72 6d  of the ?NNN form
2d440 20 61 72 65 20 75 73 65 64 2c 0a 2a 2a 20 74 68   are used,.** th
2d450 65 72 65 20 6d 61 79 20 62 65 20 67 61 70 73 20  ere may be gaps 
2d460 69 6e 20 74 68 65 20 6c 69 73 74 2e 29 5e 0a 2a  in the list.)^.*
2d470 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 3a 20 5b  *.** See also: [
2d480 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 62 6c 6f  sqlite3_bind_blo
2d490 62 7c 73 71 6c 69 74 65 33 5f 62 69 6e 64 28 29  b|sqlite3_bind()
2d4a0 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62  ],.** [sqlite3_b
2d4b0 69 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f 6e 61  ind_parameter_na
2d4c0 6d 65 28 29 5d 2c 20 61 6e 64 0a 2a 2a 20 5b 73  me()], and.** [s
2d4d0 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61 72 61  qlite3_bind_para
2d4e0 6d 65 74 65 72 5f 69 6e 64 65 78 28 29 5d 2e 0a  meter_index()]..
2d4f0 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62  */.int sqlite3_b
2d500 69 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f 63 6f  ind_parameter_co
2d510 75 6e 74 28 73 71 6c 69 74 65 33 5f 73 74 6d 74  unt(sqlite3_stmt
2d520 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  *);../*.** CAPI3
2d530 52 45 46 3a 20 4e 61 6d 65 20 4f 66 20 41 20 48  REF: Name Of A H
2d540 6f 73 74 20 50 61 72 61 6d 65 74 65 72 0a 2a 2a  ost Parameter.**
2d550 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33   METHOD: sqlite3
2d560 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  _stmt.**.** ^The
2d570 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61   sqlite3_bind_pa
2d580 72 61 6d 65 74 65 72 5f 6e 61 6d 65 28 50 2c 4e  rameter_name(P,N
2d590 29 20 69 6e 74 65 72 66 61 63 65 20 72 65 74 75  ) interface retu
2d5a0 72 6e 73 0a 2a 2a 20 74 68 65 20 6e 61 6d 65 20  rns.** the name 
2d5b0 6f 66 20 74 68 65 20 4e 2d 74 68 20 5b 53 51 4c  of the N-th [SQL
2d5c0 20 70 61 72 61 6d 65 74 65 72 5d 20 69 6e 20 74   parameter] in t
2d5d0 68 65 20 5b 70 72 65 70 61 72 65 64 20 73 74 61  he [prepared sta
2d5e0 74 65 6d 65 6e 74 5d 20 50 2e 0a 2a 2a 20 5e 28  tement] P..** ^(
2d5f0 53 51 4c 20 70 61 72 61 6d 65 74 65 72 73 20 6f  SQL parameters o
2d600 66 20 74 68 65 20 66 6f 72 6d 20 22 3f 4e 4e 4e  f the form "?NNN
2d610 22 20 6f 72 20 22 3a 41 41 41 22 20 6f 72 20 22  " or ":AAA" or "
2d620 40 41 41 41 22 20 6f 72 20 22 24 41 41 41 22 0a  @AAA" or "$AAA".
2d630 2a 2a 20 68 61 76 65 20 61 20 6e 61 6d 65 20 77  ** have a name w
2d640 68 69 63 68 20 69 73 20 74 68 65 20 73 74 72 69  hich is the stri
2d650 6e 67 20 22 3f 4e 4e 4e 22 20 6f 72 20 22 3a 41  ng "?NNN" or ":A
2d660 41 41 22 20 6f 72 20 22 40 41 41 41 22 20 6f 72  AA" or "@AAA" or
2d670 20 22 24 41 41 41 22 0a 2a 2a 20 72 65 73 70 65   "$AAA".** respe
2d680 63 74 69 76 65 6c 79 2e 0a 2a 2a 20 49 6e 20 6f  ctively..** In o
2d690 74 68 65 72 20 77 6f 72 64 73 2c 20 74 68 65 20  ther words, the 
2d6a0 69 6e 69 74 69 61 6c 20 22 3a 22 20 6f 72 20 22  initial ":" or "
2d6b0 24 22 20 6f 72 20 22 40 22 20 6f 72 20 22 3f 22  $" or "@" or "?"
2d6c0 0a 2a 2a 20 69 73 20 69 6e 63 6c 75 64 65 64 20  .** is included 
2d6d0 61 73 20 70 61 72 74 20 6f 66 20 74 68 65 20 6e  as part of the n
2d6e0 61 6d 65 2e 29 5e 0a 2a 2a 20 5e 50 61 72 61 6d  ame.)^.** ^Param
2d6f0 65 74 65 72 73 20 6f 66 20 74 68 65 20 66 6f 72  eters of the for
2d700 6d 20 22 3f 22 20 77 69 74 68 6f 75 74 20 61 20  m "?" without a 
2d710 66 6f 6c 6c 6f 77 69 6e 67 20 69 6e 74 65 67 65  following intege
2d720 72 20 68 61 76 65 20 6e 6f 20 6e 61 6d 65 0a 2a  r have no name.*
2d730 2a 20 61 6e 64 20 61 72 65 20 72 65 66 65 72 72  * and are referr
2d740 65 64 20 74 6f 20 61 73 20 22 6e 61 6d 65 6c 65  ed to as "namele
2d750 73 73 22 20 6f 72 20 22 61 6e 6f 6e 79 6d 6f 75  ss" or "anonymou
2d760 73 20 70 61 72 61 6d 65 74 65 72 73 22 2e 0a 2a  s parameters"..*
2d770 2a 0a 2a 2a 20 5e 54 68 65 20 66 69 72 73 74 20  *.** ^The first 
2d780 68 6f 73 74 20 70 61 72 61 6d 65 74 65 72 20 68  host parameter h
2d790 61 73 20 61 6e 20 69 6e 64 65 78 20 6f 66 20 31  as an index of 1
2d7a0 2c 20 6e 6f 74 20 30 2e 0a 2a 2a 0a 2a 2a 20 5e  , not 0..**.** ^
2d7b0 49 66 20 74 68 65 20 76 61 6c 75 65 20 4e 20 69  If the value N i
2d7c0 73 20 6f 75 74 20 6f 66 20 72 61 6e 67 65 20 6f  s out of range o
2d7d0 72 20 69 66 20 74 68 65 20 4e 2d 74 68 20 70 61  r if the N-th pa
2d7e0 72 61 6d 65 74 65 72 20 69 73 0a 2a 2a 20 6e 61  rameter is.** na
2d7f0 6d 65 6c 65 73 73 2c 20 74 68 65 6e 20 4e 55 4c  meless, then NUL
2d800 4c 20 69 73 20 72 65 74 75 72 6e 65 64 2e 20 20  L is returned.  
2d810 5e 54 68 65 20 72 65 74 75 72 6e 65 64 20 73 74  ^The returned st
2d820 72 69 6e 67 20 69 73 0a 2a 2a 20 61 6c 77 61 79  ring is.** alway
2d830 73 20 69 6e 20 55 54 46 2d 38 20 65 6e 63 6f 64  s in UTF-8 encod
2d840 69 6e 67 20 65 76 65 6e 20 69 66 20 74 68 65 20  ing even if the 
2d850 6e 61 6d 65 64 20 70 61 72 61 6d 65 74 65 72 20  named parameter 
2d860 77 61 73 0a 2a 2a 20 6f 72 69 67 69 6e 61 6c 6c  was.** originall
2d870 79 20 73 70 65 63 69 66 69 65 64 20 61 73 20 55  y specified as U
2d880 54 46 2d 31 36 20 69 6e 20 5b 73 71 6c 69 74 65  TF-16 in [sqlite
2d890 33 5f 70 72 65 70 61 72 65 31 36 28 29 5d 20 6f  3_prepare16()] o
2d8a0 72 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 70 72  r.** [sqlite3_pr
2d8b0 65 70 61 72 65 31 36 5f 76 32 28 29 5d 2e 0a 2a  epare16_v2()]..*
2d8c0 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 3a 20 5b  *.** See also: [
2d8d0 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 62 6c 6f  sqlite3_bind_blo
2d8e0 62 7c 73 71 6c 69 74 65 33 5f 62 69 6e 64 28 29  b|sqlite3_bind()
2d8f0 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62  ],.** [sqlite3_b
2d900 69 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f 63 6f  ind_parameter_co
2d910 75 6e 74 28 29 5d 2c 20 61 6e 64 0a 2a 2a 20 5b  unt()], and.** [
2d920 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61 72  sqlite3_bind_par
2d930 61 6d 65 74 65 72 5f 69 6e 64 65 78 28 29 5d 2e  ameter_index()].
2d940 0a 2a 2f 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a  .*/.const char *
2d950 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61 72  sqlite3_bind_par
2d960 61 6d 65 74 65 72 5f 6e 61 6d 65 28 73 71 6c 69  ameter_name(sqli
2d970 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 29 3b  te3_stmt*, int);
2d980 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
2d990 3a 20 49 6e 64 65 78 20 4f 66 20 41 20 50 61 72  : Index Of A Par
2d9a0 61 6d 65 74 65 72 20 57 69 74 68 20 41 20 47 69  ameter With A Gi
2d9b0 76 65 6e 20 4e 61 6d 65 0a 2a 2a 20 4d 45 54 48  ven Name.** METH
2d9c0 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d 74  OD: sqlite3_stmt
2d9d0 0a 2a 2a 0a 2a 2a 20 5e 52 65 74 75 72 6e 20 74  .**.** ^Return t
2d9e0 68 65 20 69 6e 64 65 78 20 6f 66 20 61 6e 20 53  he index of an S
2d9f0 51 4c 20 70 61 72 61 6d 65 74 65 72 20 67 69 76  QL parameter giv
2da00 65 6e 20 69 74 73 20 6e 61 6d 65 2e 20 20 5e 54  en its name.  ^T
2da10 68 65 0a 2a 2a 20 69 6e 64 65 78 20 76 61 6c 75  he.** index valu
2da20 65 20 72 65 74 75 72 6e 65 64 20 69 73 20 73 75  e returned is su
2da30 69 74 61 62 6c 65 20 66 6f 72 20 75 73 65 20 61  itable for use a
2da40 73 20 74 68 65 20 73 65 63 6f 6e 64 0a 2a 2a 20  s the second.** 
2da50 70 61 72 61 6d 65 74 65 72 20 74 6f 20 5b 73 71  parameter to [sq
2da60 6c 69 74 65 33 5f 62 69 6e 64 5f 62 6c 6f 62 7c  lite3_bind_blob|
2da70 73 71 6c 69 74 65 33 5f 62 69 6e 64 28 29 5d 2e  sqlite3_bind()].
2da80 20 20 5e 41 20 7a 65 72 6f 0a 2a 2a 20 69 73 20    ^A zero.** is 
2da90 72 65 74 75 72 6e 65 64 20 69 66 20 6e 6f 20 6d  returned if no m
2daa0 61 74 63 68 69 6e 67 20 70 61 72 61 6d 65 74 65  atching paramete
2dab0 72 20 69 73 20 66 6f 75 6e 64 2e 20 20 5e 54 68  r is found.  ^Th
2dac0 65 20 70 61 72 61 6d 65 74 65 72 0a 2a 2a 20 6e  e parameter.** n
2dad0 61 6d 65 20 6d 75 73 74 20 62 65 20 67 69 76 65  ame must be give
2dae0 6e 20 69 6e 20 55 54 46 2d 38 20 65 76 65 6e 20  n in UTF-8 even 
2daf0 69 66 20 74 68 65 20 6f 72 69 67 69 6e 61 6c 20  if the original 
2db00 73 74 61 74 65 6d 65 6e 74 0a 2a 2a 20 77 61 73  statement.** was
2db10 20 70 72 65 70 61 72 65 64 20 66 72 6f 6d 20 55   prepared from U
2db20 54 46 2d 31 36 20 74 65 78 74 20 75 73 69 6e 67  TF-16 text using
2db30 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72   [sqlite3_prepar
2db40 65 31 36 5f 76 32 28 29 5d 2e 0a 2a 2a 0a 2a 2a  e16_v2()]..**.**
2db50 20 53 65 65 20 61 6c 73 6f 3a 20 5b 73 71 6c 69   See also: [sqli
2db60 74 65 33 5f 62 69 6e 64 5f 62 6c 6f 62 7c 73 71  te3_bind_blob|sq
2db70 6c 69 74 65 33 5f 62 69 6e 64 28 29 5d 2c 0a 2a  lite3_bind()],.*
2db80 2a 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  * [sqlite3_bind_
2db90 70 61 72 61 6d 65 74 65 72 5f 63 6f 75 6e 74 28  parameter_count(
2dba0 29 5d 2c 20 61 6e 64 0a 2a 2a 20 5b 73 71 6c 69  )], and.** [sqli
2dbb0 74 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74  te3_bind_paramet
2dbc0 65 72 5f 6e 61 6d 65 28 29 5d 2e 0a 2a 2f 0a 69  er_name()]..*/.i
2dbd0 6e 74 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  nt sqlite3_bind_
2dbe0 70 61 72 61 6d 65 74 65 72 5f 69 6e 64 65 78 28  parameter_index(
2dbf0 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 63  sqlite3_stmt*, c
2dc00 6f 6e 73 74 20 63 68 61 72 20 2a 7a 4e 61 6d 65  onst char *zName
2dc10 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
2dc20 45 46 3a 20 52 65 73 65 74 20 41 6c 6c 20 42 69  EF: Reset All Bi
2dc30 6e 64 69 6e 67 73 20 4f 6e 20 41 20 50 72 65 70  ndings On A Prep
2dc40 61 72 65 64 20 53 74 61 74 65 6d 65 6e 74 0a 2a  ared Statement.*
2dc50 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65  * METHOD: sqlite
2dc60 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 43 6f  3_stmt.**.** ^Co
2dc70 6e 74 72 61 72 79 20 74 6f 20 74 68 65 20 69 6e  ntrary to the in
2dc80 74 75 69 74 69 6f 6e 20 6f 66 20 6d 61 6e 79 2c  tuition of many,
2dc90 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28   [sqlite3_reset(
2dca0 29 5d 20 64 6f 65 73 20 6e 6f 74 20 72 65 73 65  )] does not rese
2dcb0 74 0a 2a 2a 20 74 68 65 20 5b 73 71 6c 69 74 65  t.** the [sqlite
2dcc0 33 5f 62 69 6e 64 5f 62 6c 6f 62 20 7c 20 62 69  3_bind_blob | bi
2dcd0 6e 64 69 6e 67 73 5d 20 6f 6e 20 61 20 5b 70 72  ndings] on a [pr
2dce0 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
2dcf0 5d 2e 0a 2a 2a 20 5e 55 73 65 20 74 68 69 73 20  ]..** ^Use this 
2dd00 72 6f 75 74 69 6e 65 20 74 6f 20 72 65 73 65 74  routine to reset
2dd10 20 61 6c 6c 20 68 6f 73 74 20 70 61 72 61 6d 65   all host parame
2dd20 74 65 72 73 20 74 6f 20 4e 55 4c 4c 2e 0a 2a 2f  ters to NULL..*/
2dd30 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 63 6c 65  .int sqlite3_cle
2dd40 61 72 5f 62 69 6e 64 69 6e 67 73 28 73 71 6c 69  ar_bindings(sqli
2dd50 74 65 33 5f 73 74 6d 74 2a 29 3b 0a 0a 2f 2a 0a  te3_stmt*);../*.
2dd60 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4e 75 6d  ** CAPI3REF: Num
2dd70 62 65 72 20 4f 66 20 43 6f 6c 75 6d 6e 73 20 49  ber Of Columns I
2dd80 6e 20 41 20 52 65 73 75 6c 74 20 53 65 74 0a 2a  n A Result Set.*
2dd90 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65  * METHOD: sqlite
2dda0 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 52 65  3_stmt.**.** ^Re
2ddb0 74 75 72 6e 20 74 68 65 20 6e 75 6d 62 65 72 20  turn the number 
2ddc0 6f 66 20 63 6f 6c 75 6d 6e 73 20 69 6e 20 74 68  of columns in th
2ddd0 65 20 72 65 73 75 6c 74 20 73 65 74 20 72 65 74  e result set ret
2dde0 75 72 6e 65 64 20 62 79 20 74 68 65 0a 2a 2a 20  urned by the.** 
2ddf0 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d  [prepared statem
2de00 65 6e 74 5d 2e 20 5e 54 68 69 73 20 72 6f 75 74  ent]. ^This rout
2de10 69 6e 65 20 72 65 74 75 72 6e 73 20 30 20 69 66  ine returns 0 if
2de20 20 70 53 74 6d 74 20 69 73 20 61 6e 20 53 51 4c   pStmt is an SQL
2de30 0a 2a 2a 20 73 74 61 74 65 6d 65 6e 74 20 74 68  .** statement th
2de40 61 74 20 64 6f 65 73 20 6e 6f 74 20 72 65 74 75  at does not retu
2de50 72 6e 20 64 61 74 61 20 28 66 6f 72 20 65 78 61  rn data (for exa
2de60 6d 70 6c 65 20 61 6e 20 5b 55 50 44 41 54 45 5d  mple an [UPDATE]
2de70 29 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73  )..**.** See als
2de80 6f 3a 20 5b 73 71 6c 69 74 65 33 5f 64 61 74 61  o: [sqlite3_data
2de90 5f 63 6f 75 6e 74 28 29 5d 0a 2a 2f 0a 69 6e 74  _count()].*/.int
2dea0 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
2deb0 63 6f 75 6e 74 28 73 71 6c 69 74 65 33 5f 73 74  count(sqlite3_st
2dec0 6d 74 20 2a 70 53 74 6d 74 29 3b 0a 0a 2f 2a 0a  mt *pStmt);../*.
2ded0 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6f 6c  ** CAPI3REF: Col
2dee0 75 6d 6e 20 4e 61 6d 65 73 20 49 6e 20 41 20 52  umn Names In A R
2def0 65 73 75 6c 74 20 53 65 74 0a 2a 2a 20 4d 45 54  esult Set.** MET
2df00 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d  HOD: sqlite3_stm
2df10 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 73 65 20 72  t.**.** ^These r
2df20 6f 75 74 69 6e 65 73 20 72 65 74 75 72 6e 20 74  outines return t
2df30 68 65 20 6e 61 6d 65 20 61 73 73 69 67 6e 65 64  he name assigned
2df40 20 74 6f 20 61 20 70 61 72 74 69 63 75 6c 61 72   to a particular
2df50 20 63 6f 6c 75 6d 6e 0a 2a 2a 20 69 6e 20 74 68   column.** in th
2df60 65 20 72 65 73 75 6c 74 20 73 65 74 20 6f 66 20  e result set of 
2df70 61 20 5b 53 45 4c 45 43 54 5d 20 73 74 61 74 65  a [SELECT] state
2df80 6d 65 6e 74 2e 20 20 5e 54 68 65 20 73 71 6c 69  ment.  ^The sqli
2df90 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6e 61 6d 65 28  te3_column_name(
2dfa0 29 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 72  ).** interface r
2dfb0 65 74 75 72 6e 73 20 61 20 70 6f 69 6e 74 65 72  eturns a pointer
2dfc0 20 74 6f 20 61 20 7a 65 72 6f 2d 74 65 72 6d 69   to a zero-termi
2dfd0 6e 61 74 65 64 20 55 54 46 2d 38 20 73 74 72 69  nated UTF-8 stri
2dfe0 6e 67 0a 2a 2a 20 61 6e 64 20 73 71 6c 69 74 65  ng.** and sqlite
2dff0 33 5f 63 6f 6c 75 6d 6e 5f 6e 61 6d 65 31 36 28  3_column_name16(
2e000 29 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69 6e  ) returns a poin
2e010 74 65 72 20 74 6f 20 61 20 7a 65 72 6f 2d 74 65  ter to a zero-te
2e020 72 6d 69 6e 61 74 65 64 0a 2a 2a 20 55 54 46 2d  rminated.** UTF-
2e030 31 36 20 73 74 72 69 6e 67 2e 20 20 5e 54 68 65  16 string.  ^The
2e040 20 66 69 72 73 74 20 70 61 72 61 6d 65 74 65 72   first parameter
2e050 20 69 73 20 74 68 65 20 5b 70 72 65 70 61 72 65   is the [prepare
2e060 64 20 73 74 61 74 65 6d 65 6e 74 5d 0a 2a 2a 20  d statement].** 
2e070 74 68 61 74 20 69 6d 70 6c 65 6d 65 6e 74 73 20  that implements 
2e080 74 68 65 20 5b 53 45 4c 45 43 54 5d 20 73 74 61  the [SELECT] sta
2e090 74 65 6d 65 6e 74 2e 20 5e 54 68 65 20 73 65 63  tement. ^The sec
2e0a0 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20 69 73  ond parameter is
2e0b0 20 74 68 65 0a 2a 2a 20 63 6f 6c 75 6d 6e 20 6e   the.** column n
2e0c0 75 6d 62 65 72 2e 20 20 5e 54 68 65 20 6c 65 66  umber.  ^The lef
2e0d0 74 6d 6f 73 74 20 63 6f 6c 75 6d 6e 20 69 73 20  tmost column is 
2e0e0 6e 75 6d 62 65 72 20 30 2e 0a 2a 2a 0a 2a 2a 20  number 0..**.** 
2e0f0 5e 54 68 65 20 72 65 74 75 72 6e 65 64 20 73 74  ^The returned st
2e100 72 69 6e 67 20 70 6f 69 6e 74 65 72 20 69 73 20  ring pointer is 
2e110 76 61 6c 69 64 20 75 6e 74 69 6c 20 65 69 74 68  valid until eith
2e120 65 72 20 74 68 65 20 5b 70 72 65 70 61 72 65 64  er the [prepared
2e130 20 73 74 61 74 65 6d 65 6e 74 5d 0a 2a 2a 20 69   statement].** i
2e140 73 20 64 65 73 74 72 6f 79 65 64 20 62 79 20 5b  s destroyed by [
2e150 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65  sqlite3_finalize
2e160 28 29 5d 20 6f 72 20 75 6e 74 69 6c 20 74 68 65  ()] or until the
2e170 20 73 74 61 74 65 6d 65 6e 74 20 69 73 20 61 75   statement is au
2e180 74 6f 6d 61 74 69 63 61 6c 6c 79 0a 2a 2a 20 72  tomatically.** r
2e190 65 70 72 65 70 61 72 65 64 20 62 79 20 74 68 65  eprepared by the
2e1a0 20 66 69 72 73 74 20 63 61 6c 6c 20 74 6f 20 5b   first call to [
2e1b0 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20  sqlite3_step()] 
2e1c0 66 6f 72 20 61 20 70 61 72 74 69 63 75 6c 61 72  for a particular
2e1d0 20 72 75 6e 0a 2a 2a 20 6f 72 20 75 6e 74 69 6c   run.** or until
2e1e0 20 74 68 65 20 6e 65 78 74 20 63 61 6c 6c 20 74   the next call t
2e1f0 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63 6f 6c  o.** sqlite3_col
2e200 75 6d 6e 5f 6e 61 6d 65 28 29 20 6f 72 20 73 71  umn_name() or sq
2e210 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6e 61 6d  lite3_column_nam
2e220 65 31 36 28 29 20 6f 6e 20 74 68 65 20 73 61 6d  e16() on the sam
2e230 65 20 63 6f 6c 75 6d 6e 2e 0a 2a 2a 0a 2a 2a 20  e column..**.** 
2e240 5e 49 66 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c  ^If sqlite3_mall
2e250 6f 63 28 29 20 66 61 69 6c 73 20 64 75 72 69 6e  oc() fails durin
2e260 67 20 74 68 65 20 70 72 6f 63 65 73 73 69 6e 67  g the processing
2e270 20 6f 66 20 65 69 74 68 65 72 20 72 6f 75 74 69   of either routi
2e280 6e 65 0a 2a 2a 20 28 66 6f 72 20 65 78 61 6d 70  ne.** (for examp
2e290 6c 65 20 64 75 72 69 6e 67 20 61 20 63 6f 6e 76  le during a conv
2e2a0 65 72 73 69 6f 6e 20 66 72 6f 6d 20 55 54 46 2d  ersion from UTF-
2e2b0 38 20 74 6f 20 55 54 46 2d 31 36 29 20 74 68 65  8 to UTF-16) the
2e2c0 6e 20 61 0a 2a 2a 20 4e 55 4c 4c 20 70 6f 69 6e  n a.** NULL poin
2e2d0 74 65 72 20 69 73 20 72 65 74 75 72 6e 65 64 2e  ter is returned.
2e2e0 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 6e 61 6d 65  .**.** ^The name
2e2f0 20 6f 66 20 61 20 72 65 73 75 6c 74 20 63 6f 6c   of a result col
2e300 75 6d 6e 20 69 73 20 74 68 65 20 76 61 6c 75 65  umn is the value
2e310 20 6f 66 20 74 68 65 20 22 41 53 22 20 63 6c 61   of the "AS" cla
2e320 75 73 65 20 66 6f 72 0a 2a 2a 20 74 68 61 74 20  use for.** that 
2e330 63 6f 6c 75 6d 6e 2c 20 69 66 20 74 68 65 72 65  column, if there
2e340 20 69 73 20 61 6e 20 41 53 20 63 6c 61 75 73 65   is an AS clause
2e350 2e 20 20 49 66 20 74 68 65 72 65 20 69 73 20 6e  .  If there is n
2e360 6f 20 41 53 20 63 6c 61 75 73 65 0a 2a 2a 20 74  o AS clause.** t
2e370 68 65 6e 20 74 68 65 20 6e 61 6d 65 20 6f 66 20  hen the name of 
2e380 74 68 65 20 63 6f 6c 75 6d 6e 20 69 73 20 75 6e  the column is un
2e390 73 70 65 63 69 66 69 65 64 20 61 6e 64 20 6d 61  specified and ma
2e3a0 79 20 63 68 61 6e 67 65 20 66 72 6f 6d 0a 2a 2a  y change from.**
2e3b0 20 6f 6e 65 20 72 65 6c 65 61 73 65 20 6f 66 20   one release of 
2e3c0 53 51 4c 69 74 65 20 74 6f 20 74 68 65 20 6e 65  SQLite to the ne
2e3d0 78 74 2e 0a 2a 2f 0a 63 6f 6e 73 74 20 63 68 61  xt..*/.const cha
2e3e0 72 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  r *sqlite3_colum
2e3f0 6e 5f 6e 61 6d 65 28 73 71 6c 69 74 65 33 5f 73  n_name(sqlite3_s
2e400 74 6d 74 2a 2c 20 69 6e 74 20 4e 29 3b 0a 63 6f  tmt*, int N);.co
2e410 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c 69 74 65  nst void *sqlite
2e420 33 5f 63 6f 6c 75 6d 6e 5f 6e 61 6d 65 31 36 28  3_column_name16(
2e430 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69  sqlite3_stmt*, i
2e440 6e 74 20 4e 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41  nt N);../*.** CA
2e450 50 49 33 52 45 46 3a 20 53 6f 75 72 63 65 20 4f  PI3REF: Source O
2e460 66 20 44 61 74 61 20 49 6e 20 41 20 51 75 65 72  f Data In A Quer
2e470 79 20 52 65 73 75 6c 74 0a 2a 2a 20 4d 45 54 48  y Result.** METH
2e480 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d 74  OD: sqlite3_stmt
2e490 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 73 65 20 72 6f  .**.** ^These ro
2e4a0 75 74 69 6e 65 73 20 70 72 6f 76 69 64 65 20 61  utines provide a
2e4b0 20 6d 65 61 6e 73 20 74 6f 20 64 65 74 65 72 6d   means to determ
2e4c0 69 6e 65 20 74 68 65 20 64 61 74 61 62 61 73 65  ine the database
2e4d0 2c 20 74 61 62 6c 65 2c 20 61 6e 64 0a 2a 2a 20  , table, and.** 
2e4e0 74 61 62 6c 65 20 63 6f 6c 75 6d 6e 20 74 68 61  table column tha
2e4f0 74 20 69 73 20 74 68 65 20 6f 72 69 67 69 6e 20  t is the origin 
2e500 6f 66 20 61 20 70 61 72 74 69 63 75 6c 61 72 20  of a particular 
2e510 72 65 73 75 6c 74 20 63 6f 6c 75 6d 6e 20 69 6e  result column in
2e520 0a 2a 2a 20 5b 53 45 4c 45 43 54 5d 20 73 74 61  .** [SELECT] sta
2e530 74 65 6d 65 6e 74 2e 0a 2a 2a 20 5e 54 68 65 20  tement..** ^The 
2e540 6e 61 6d 65 20 6f 66 20 74 68 65 20 64 61 74 61  name of the data
2e550 62 61 73 65 20 6f 72 20 74 61 62 6c 65 20 6f 72  base or table or
2e560 20 63 6f 6c 75 6d 6e 20 63 61 6e 20 62 65 20 72   column can be r
2e570 65 74 75 72 6e 65 64 20 61 73 0a 2a 2a 20 65 69  eturned as.** ei
2e580 74 68 65 72 20 61 20 55 54 46 2d 38 20 6f 72 20  ther a UTF-8 or 
2e590 55 54 46 2d 31 36 20 73 74 72 69 6e 67 2e 20 20  UTF-16 string.  
2e5a0 5e 54 68 65 20 5f 64 61 74 61 62 61 73 65 5f 20  ^The _database_ 
2e5b0 72 6f 75 74 69 6e 65 73 20 72 65 74 75 72 6e 0a  routines return.
2e5c0 2a 2a 20 74 68 65 20 64 61 74 61 62 61 73 65 20  ** the database 
2e5d0 6e 61 6d 65 2c 20 74 68 65 20 5f 74 61 62 6c 65  name, the _table
2e5e0 5f 20 72 6f 75 74 69 6e 65 73 20 72 65 74 75 72  _ routines retur
2e5f0 6e 20 74 68 65 20 74 61 62 6c 65 20 6e 61 6d 65  n the table name
2e600 2c 20 61 6e 64 0a 2a 2a 20 74 68 65 20 6f 72 69  , and.** the ori
2e610 67 69 6e 5f 20 72 6f 75 74 69 6e 65 73 20 72 65  gin_ routines re
2e620 74 75 72 6e 20 74 68 65 20 63 6f 6c 75 6d 6e 20  turn the column 
2e630 6e 61 6d 65 2e 0a 2a 2a 20 5e 54 68 65 20 72 65  name..** ^The re
2e640 74 75 72 6e 65 64 20 73 74 72 69 6e 67 20 69 73  turned string is
2e650 20 76 61 6c 69 64 20 75 6e 74 69 6c 20 74 68 65   valid until the
2e660 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65   [prepared state
2e670 6d 65 6e 74 5d 20 69 73 20 64 65 73 74 72 6f 79  ment] is destroy
2e680 65 64 0a 2a 2a 20 75 73 69 6e 67 20 5b 73 71 6c  ed.** using [sql
2e690 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28 29 5d  ite3_finalize()]
2e6a0 20 6f 72 20 75 6e 74 69 6c 20 74 68 65 20 73 74   or until the st
2e6b0 61 74 65 6d 65 6e 74 20 69 73 20 61 75 74 6f 6d  atement is autom
2e6c0 61 74 69 63 61 6c 6c 79 0a 2a 2a 20 72 65 70 72  atically.** repr
2e6d0 65 70 61 72 65 64 20 62 79 20 74 68 65 20 66 69  epared by the fi
2e6e0 72 73 74 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c  rst call to [sql
2e6f0 69 74 65 33 5f 73 74 65 70 28 29 5d 20 66 6f 72  ite3_step()] for
2e700 20 61 20 70 61 72 74 69 63 75 6c 61 72 20 72 75   a particular ru
2e710 6e 0a 2a 2a 20 6f 72 20 75 6e 74 69 6c 20 74 68  n.** or until th
2e720 65 20 73 61 6d 65 20 69 6e 66 6f 72 6d 61 74 69  e same informati
2e730 6f 6e 20 69 73 20 72 65 71 75 65 73 74 65 64 0a  on is requested.
2e740 2a 2a 20 61 67 61 69 6e 20 69 6e 20 61 20 64 69  ** again in a di
2e750 66 66 65 72 65 6e 74 20 65 6e 63 6f 64 69 6e 67  fferent encoding
2e760 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 6e 61 6d  ..**.** ^The nam
2e770 65 73 20 72 65 74 75 72 6e 65 64 20 61 72 65 20  es returned are 
2e780 74 68 65 20 6f 72 69 67 69 6e 61 6c 20 75 6e 2d  the original un-
2e790 61 6c 69 61 73 65 64 20 6e 61 6d 65 73 20 6f 66  aliased names of
2e7a0 20 74 68 65 0a 2a 2a 20 64 61 74 61 62 61 73 65   the.** database
2e7b0 2c 20 74 61 62 6c 65 2c 20 61 6e 64 20 63 6f 6c  , table, and col
2e7c0 75 6d 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  umn..**.** ^The 
2e7d0 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74  first argument t
2e7e0 6f 20 74 68 65 73 65 20 69 6e 74 65 72 66 61 63  o these interfac
2e7f0 65 73 20 69 73 20 61 20 5b 70 72 65 70 61 72 65  es is a [prepare
2e800 64 20 73 74 61 74 65 6d 65 6e 74 5d 2e 0a 2a 2a  d statement]..**
2e810 20 5e 54 68 65 73 65 20 66 75 6e 63 74 69 6f 6e   ^These function
2e820 73 20 72 65 74 75 72 6e 20 69 6e 66 6f 72 6d 61  s return informa
2e830 74 69 6f 6e 20 61 62 6f 75 74 20 74 68 65 20 4e  tion about the N
2e840 74 68 20 72 65 73 75 6c 74 20 63 6f 6c 75 6d 6e  th result column
2e850 20 72 65 74 75 72 6e 65 64 20 62 79 0a 2a 2a 20   returned by.** 
2e860 74 68 65 20 73 74 61 74 65 6d 65 6e 74 2c 20 77  the statement, w
2e870 68 65 72 65 20 4e 20 69 73 20 74 68 65 20 73 65  here N is the se
2e880 63 6f 6e 64 20 66 75 6e 63 74 69 6f 6e 20 61 72  cond function ar
2e890 67 75 6d 65 6e 74 2e 0a 2a 2a 20 5e 54 68 65 20  gument..** ^The 
2e8a0 6c 65 66 74 2d 6d 6f 73 74 20 63 6f 6c 75 6d 6e  left-most column
2e8b0 20 69 73 20 63 6f 6c 75 6d 6e 20 30 20 66 6f 72   is column 0 for
2e8c0 20 74 68 65 73 65 20 72 6f 75 74 69 6e 65 73 2e   these routines.
2e8d0 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 4e  .**.** ^If the N
2e8e0 74 68 20 63 6f 6c 75 6d 6e 20 72 65 74 75 72 6e  th column return
2e8f0 65 64 20 62 79 20 74 68 65 20 73 74 61 74 65 6d  ed by the statem
2e900 65 6e 74 20 69 73 20 61 6e 20 65 78 70 72 65 73  ent is an expres
2e910 73 69 6f 6e 20 6f 72 0a 2a 2a 20 73 75 62 71 75  sion or.** subqu
2e920 65 72 79 20 61 6e 64 20 69 73 20 6e 6f 74 20 61  ery and is not a
2e930 20 63 6f 6c 75 6d 6e 20 76 61 6c 75 65 2c 20 74   column value, t
2e940 68 65 6e 20 61 6c 6c 20 6f 66 20 74 68 65 73 65  hen all of these
2e950 20 66 75 6e 63 74 69 6f 6e 73 20 72 65 74 75 72   functions retur
2e960 6e 0a 2a 2a 20 4e 55 4c 4c 2e 20 20 5e 54 68 65  n.** NULL.  ^The
2e970 73 65 20 72 6f 75 74 69 6e 65 20 6d 69 67 68 74  se routine might
2e980 20 61 6c 73 6f 20 72 65 74 75 72 6e 20 4e 55 4c   also return NUL
2e990 4c 20 69 66 20 61 20 6d 65 6d 6f 72 79 20 61 6c  L if a memory al
2e9a0 6c 6f 63 61 74 69 6f 6e 20 65 72 72 6f 72 0a 2a  location error.*
2e9b0 2a 20 6f 63 63 75 72 73 2e 20 20 5e 4f 74 68 65  * occurs.  ^Othe
2e9c0 72 77 69 73 65 2c 20 74 68 65 79 20 72 65 74 75  rwise, they retu
2e9d0 72 6e 20 74 68 65 20 6e 61 6d 65 20 6f 66 20 74  rn the name of t
2e9e0 68 65 20 61 74 74 61 63 68 65 64 20 64 61 74 61  he attached data
2e9f0 62 61 73 65 2c 20 74 61 62 6c 65 2c 0a 2a 2a 20  base, table,.** 
2ea00 6f 72 20 63 6f 6c 75 6d 6e 20 74 68 61 74 20 71  or column that q
2ea10 75 65 72 79 20 72 65 73 75 6c 74 20 63 6f 6c 75  uery result colu
2ea20 6d 6e 20 77 61 73 20 65 78 74 72 61 63 74 65 64  mn was extracted
2ea30 20 66 72 6f 6d 2e 0a 2a 2a 0a 2a 2a 20 5e 41 73   from..**.** ^As
2ea40 20 77 69 74 68 20 61 6c 6c 20 6f 74 68 65 72 20   with all other 
2ea50 53 51 4c 69 74 65 20 41 50 49 73 2c 20 74 68 6f  SQLite APIs, tho
2ea60 73 65 20 77 68 6f 73 65 20 6e 61 6d 65 73 20 65  se whose names e
2ea70 6e 64 20 77 69 74 68 20 22 31 36 22 20 72 65 74  nd with "16" ret
2ea80 75 72 6e 0a 2a 2a 20 55 54 46 2d 31 36 20 65 6e  urn.** UTF-16 en
2ea90 63 6f 64 65 64 20 73 74 72 69 6e 67 73 20 61 6e  coded strings an
2eaa0 64 20 74 68 65 20 6f 74 68 65 72 20 66 75 6e 63  d the other func
2eab0 74 69 6f 6e 73 20 72 65 74 75 72 6e 20 55 54 46  tions return UTF
2eac0 2d 38 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 73 65  -8..**.** ^These
2ead0 20 41 50 49 73 20 61 72 65 20 6f 6e 6c 79 20 61   APIs are only a
2eae0 76 61 69 6c 61 62 6c 65 20 69 66 20 74 68 65 20  vailable if the 
2eaf0 6c 69 62 72 61 72 79 20 77 61 73 20 63 6f 6d 70  library was comp
2eb00 69 6c 65 64 20 77 69 74 68 20 74 68 65 0a 2a 2a  iled with the.**
2eb10 20 5b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f   [SQLITE_ENABLE_
2eb20 43 4f 4c 55 4d 4e 5f 4d 45 54 41 44 41 54 41 5d  COLUMN_METADATA]
2eb30 20 43 2d 70 72 65 70 72 6f 63 65 73 73 6f 72 20   C-preprocessor 
2eb40 73 79 6d 62 6f 6c 2e 0a 2a 2a 0a 2a 2a 20 49 66  symbol..**.** If
2eb50 20 74 77 6f 20 6f 72 20 6d 6f 72 65 20 74 68 72   two or more thr
2eb60 65 61 64 73 20 63 61 6c 6c 20 6f 6e 65 20 6f 72  eads call one or
2eb70 20 6d 6f 72 65 20 6f 66 20 74 68 65 73 65 20 72   more of these r
2eb80 6f 75 74 69 6e 65 73 20 61 67 61 69 6e 73 74 20  outines against 
2eb90 74 68 65 20 73 61 6d 65 0a 2a 2a 20 70 72 65 70  the same.** prep
2eba0 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 20 61  ared statement a
2ebb0 6e 64 20 63 6f 6c 75 6d 6e 20 61 74 20 74 68 65  nd column at the
2ebc0 20 73 61 6d 65 20 74 69 6d 65 20 74 68 65 6e 20   same time then 
2ebd0 74 68 65 20 72 65 73 75 6c 74 73 20 61 72 65 0a  the results are.
2ebe0 2a 2a 20 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a  ** undefined..**
2ebf0 0a 2a 2a 20 49 66 20 74 77 6f 20 6f 72 20 6d 6f  .** If two or mo
2ec00 72 65 20 74 68 72 65 61 64 73 20 63 61 6c 6c 20  re threads call 
2ec10 6f 6e 65 20 6f 72 20 6d 6f 72 65 0a 2a 2a 20 5b  one or more.** [
2ec20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 64  sqlite3_column_d
2ec30 61 74 61 62 61 73 65 5f 6e 61 6d 65 20 7c 20 63  atabase_name | c
2ec40 6f 6c 75 6d 6e 20 6d 65 74 61 64 61 74 61 20 69  olumn metadata i
2ec50 6e 74 65 72 66 61 63 65 73 5d 0a 2a 2a 20 66 6f  nterfaces].** fo
2ec60 72 20 74 68 65 20 73 61 6d 65 20 5b 70 72 65 70  r the same [prep
2ec70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20  ared statement] 
2ec80 61 6e 64 20 72 65 73 75 6c 74 20 63 6f 6c 75 6d  and result colum
2ec90 6e 0a 2a 2a 20 61 74 20 74 68 65 20 73 61 6d 65  n.** at the same
2eca0 20 74 69 6d 65 20 74 68 65 6e 20 74 68 65 20 72   time then the r
2ecb0 65 73 75 6c 74 73 20 61 72 65 20 75 6e 64 65 66  esults are undef
2ecc0 69 6e 65 64 2e 0a 2a 2f 0a 63 6f 6e 73 74 20 63  ined..*/.const c
2ecd0 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c  har *sqlite3_col
2ece0 75 6d 6e 5f 64 61 74 61 62 61 73 65 5f 6e 61 6d  umn_database_nam
2ecf0 65 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c  e(sqlite3_stmt*,
2ed00 69 6e 74 29 3b 0a 63 6f 6e 73 74 20 76 6f 69 64  int);.const void
2ed10 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e   *sqlite3_column
2ed20 5f 64 61 74 61 62 61 73 65 5f 6e 61 6d 65 31 36  _database_name16
2ed30 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 69  (sqlite3_stmt*,i
2ed40 6e 74 29 3b 0a 63 6f 6e 73 74 20 63 68 61 72 20  nt);.const char 
2ed50 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f  *sqlite3_column_
2ed60 74 61 62 6c 65 5f 6e 61 6d 65 28 73 71 6c 69 74  table_name(sqlit
2ed70 65 33 5f 73 74 6d 74 2a 2c 69 6e 74 29 3b 0a 63  e3_stmt*,int);.c
2ed80 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c 69 74  onst void *sqlit
2ed90 65 33 5f 63 6f 6c 75 6d 6e 5f 74 61 62 6c 65 5f  e3_column_table_
2eda0 6e 61 6d 65 31 36 28 73 71 6c 69 74 65 33 5f 73  name16(sqlite3_s
2edb0 74 6d 74 2a 2c 69 6e 74 29 3b 0a 63 6f 6e 73 74  tmt*,int);.const
2edc0 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 63   char *sqlite3_c
2edd0 6f 6c 75 6d 6e 5f 6f 72 69 67 69 6e 5f 6e 61 6d  olumn_origin_nam
2ede0 65 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c  e(sqlite3_stmt*,
2edf0 69 6e 74 29 3b 0a 63 6f 6e 73 74 20 76 6f 69 64  int);.const void
2ee00 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e   *sqlite3_column
2ee10 5f 6f 72 69 67 69 6e 5f 6e 61 6d 65 31 36 28 73  _origin_name16(s
2ee20 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 69 6e 74  qlite3_stmt*,int
2ee30 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
2ee40 45 46 3a 20 44 65 63 6c 61 72 65 64 20 44 61 74  EF: Declared Dat
2ee50 61 74 79 70 65 20 4f 66 20 41 20 51 75 65 72 79  atype Of A Query
2ee60 20 52 65 73 75 6c 74 0a 2a 2a 20 4d 45 54 48 4f   Result.** METHO
2ee70 44 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 0a  D: sqlite3_stmt.
2ee80 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20 66 69 72 73  **.** ^(The firs
2ee90 74 20 70 61 72 61 6d 65 74 65 72 20 69 73 20 61  t parameter is a
2eea0 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65   [prepared state
2eeb0 6d 65 6e 74 5d 2e 0a 2a 2a 20 49 66 20 74 68 69  ment]..** If thi
2eec0 73 20 73 74 61 74 65 6d 65 6e 74 20 69 73 20 61  s statement is a
2eed0 20 5b 53 45 4c 45 43 54 5d 20 73 74 61 74 65 6d   [SELECT] statem
2eee0 65 6e 74 20 61 6e 64 20 74 68 65 20 4e 74 68 20  ent and the Nth 
2eef0 63 6f 6c 75 6d 6e 20 6f 66 20 74 68 65 0a 2a 2a  column of the.**
2ef00 20 72 65 74 75 72 6e 65 64 20 72 65 73 75 6c 74   returned result
2ef10 20 73 65 74 20 6f 66 20 74 68 61 74 20 5b 53 45   set of that [SE
2ef20 4c 45 43 54 5d 20 69 73 20 61 20 74 61 62 6c 65  LECT] is a table
2ef30 20 63 6f 6c 75 6d 6e 20 28 6e 6f 74 20 61 6e 0a   column (not an.
2ef40 2a 2a 20 65 78 70 72 65 73 73 69 6f 6e 20 6f 72  ** expression or
2ef50 20 73 75 62 71 75 65 72 79 29 20 74 68 65 6e 20   subquery) then 
2ef60 74 68 65 20 64 65 63 6c 61 72 65 64 20 74 79 70  the declared typ
2ef70 65 20 6f 66 20 74 68 65 20 74 61 62 6c 65 0a 2a  e of the table.*
2ef80 2a 20 63 6f 6c 75 6d 6e 20 69 73 20 72 65 74 75  * column is retu
2ef90 72 6e 65 64 2e 29 5e 20 20 5e 49 66 20 74 68 65  rned.)^  ^If the
2efa0 20 4e 74 68 20 63 6f 6c 75 6d 6e 20 6f 66 20 74   Nth column of t
2efb0 68 65 20 72 65 73 75 6c 74 20 73 65 74 20 69 73  he result set is
2efc0 20 61 6e 0a 2a 2a 20 65 78 70 72 65 73 73 69 6f   an.** expressio
2efd0 6e 20 6f 72 20 73 75 62 71 75 65 72 79 2c 20 74  n or subquery, t
2efe0 68 65 6e 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74  hen a NULL point
2eff0 65 72 20 69 73 20 72 65 74 75 72 6e 65 64 2e 0a  er is returned..
2f000 2a 2a 20 5e 54 68 65 20 72 65 74 75 72 6e 65 64  ** ^The returned
2f010 20 73 74 72 69 6e 67 20 69 73 20 61 6c 77 61 79   string is alway
2f020 73 20 55 54 46 2d 38 20 65 6e 63 6f 64 65 64 2e  s UTF-8 encoded.
2f030 0a 2a 2a 0a 2a 2a 20 5e 28 46 6f 72 20 65 78 61  .**.** ^(For exa
2f040 6d 70 6c 65 2c 20 67 69 76 65 6e 20 74 68 65 20  mple, given the 
2f050 64 61 74 61 62 61 73 65 20 73 63 68 65 6d 61 3a  database schema:
2f060 0a 2a 2a 0a 2a 2a 20 43 52 45 41 54 45 20 54 41  .**.** CREATE TA
2f070 42 4c 45 20 74 31 28 63 31 20 56 41 52 49 41 4e  BLE t1(c1 VARIAN
2f080 54 29 3b 0a 2a 2a 0a 2a 2a 20 61 6e 64 20 74 68  T);.**.** and th
2f090 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 73 74 61 74  e following stat
2f0a0 65 6d 65 6e 74 20 74 6f 20 62 65 20 63 6f 6d 70  ement to be comp
2f0b0 69 6c 65 64 3a 0a 2a 2a 0a 2a 2a 20 53 45 4c 45  iled:.**.** SELE
2f0c0 43 54 20 63 31 20 2b 20 31 2c 20 63 31 20 46 52  CT c1 + 1, c1 FR
2f0d0 4f 4d 20 74 31 3b 0a 2a 2a 0a 2a 2a 20 74 68 69  OM t1;.**.** thi
2f0e0 73 20 72 6f 75 74 69 6e 65 20 77 6f 75 6c 64 20  s routine would 
2f0f0 72 65 74 75 72 6e 20 74 68 65 20 73 74 72 69 6e  return the strin
2f100 67 20 22 56 41 52 49 41 4e 54 22 20 66 6f 72 20  g "VARIANT" for 
2f110 74 68 65 20 73 65 63 6f 6e 64 20 72 65 73 75 6c  the second resul
2f120 74 0a 2a 2a 20 63 6f 6c 75 6d 6e 20 28 69 3d 3d  t.** column (i==
2f130 31 29 2c 20 61 6e 64 20 61 20 4e 55 4c 4c 20 70  1), and a NULL p
2f140 6f 69 6e 74 65 72 20 66 6f 72 20 74 68 65 20 66  ointer for the f
2f150 69 72 73 74 20 72 65 73 75 6c 74 20 63 6f 6c 75  irst result colu
2f160 6d 6e 20 28 69 3d 3d 30 29 2e 29 5e 0a 2a 2a 0a  mn (i==0).)^.**.
2f170 2a 2a 20 5e 53 51 4c 69 74 65 20 75 73 65 73 20  ** ^SQLite uses 
2f180 64 79 6e 61 6d 69 63 20 72 75 6e 2d 74 69 6d 65  dynamic run-time
2f190 20 74 79 70 69 6e 67 2e 20 20 5e 53 6f 20 6a 75   typing.  ^So ju
2f1a0 73 74 20 62 65 63 61 75 73 65 20 61 20 63 6f 6c  st because a col
2f1b0 75 6d 6e 0a 2a 2a 20 69 73 20 64 65 63 6c 61 72  umn.** is declar
2f1c0 65 64 20 74 6f 20 63 6f 6e 74 61 69 6e 20 61 20  ed to contain a 
2f1d0 70 61 72 74 69 63 75 6c 61 72 20 74 79 70 65 20  particular type 
2f1e0 64 6f 65 73 20 6e 6f 74 20 6d 65 61 6e 20 74 68  does not mean th
2f1f0 61 74 20 74 68 65 0a 2a 2a 20 64 61 74 61 20 73  at the.** data s
2f200 74 6f 72 65 64 20 69 6e 20 74 68 61 74 20 63 6f  tored in that co
2f210 6c 75 6d 6e 20 69 73 20 6f 66 20 74 68 65 20 64  lumn is of the d
2f220 65 63 6c 61 72 65 64 20 74 79 70 65 2e 20 20 53  eclared type.  S
2f230 51 4c 69 74 65 20 69 73 0a 2a 2a 20 73 74 72 6f  QLite is.** stro
2f240 6e 67 6c 79 20 74 79 70 65 64 2c 20 62 75 74 20  ngly typed, but 
2f250 74 68 65 20 74 79 70 69 6e 67 20 69 73 20 64 79  the typing is dy
2f260 6e 61 6d 69 63 20 6e 6f 74 20 73 74 61 74 69 63  namic not static
2f270 2e 20 20 5e 54 79 70 65 0a 2a 2a 20 69 73 20 61  .  ^Type.** is a
2f280 73 73 6f 63 69 61 74 65 64 20 77 69 74 68 20 69  ssociated with i
2f290 6e 64 69 76 69 64 75 61 6c 20 76 61 6c 75 65 73  ndividual values
2f2a0 2c 20 6e 6f 74 20 77 69 74 68 20 74 68 65 20 63  , not with the c
2f2b0 6f 6e 74 61 69 6e 65 72 73 0a 2a 2a 20 75 73 65  ontainers.** use
2f2c0 64 20 74 6f 20 68 6f 6c 64 20 74 68 6f 73 65 20  d to hold those 
2f2d0 76 61 6c 75 65 73 2e 0a 2a 2f 0a 63 6f 6e 73 74  values..*/.const
2f2e0 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 63   char *sqlite3_c
2f2f0 6f 6c 75 6d 6e 5f 64 65 63 6c 74 79 70 65 28 73  olumn_decltype(s
2f300 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 69 6e 74  qlite3_stmt*,int
2f310 29 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73  );.const void *s
2f320 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 64 65  qlite3_column_de
2f330 63 6c 74 79 70 65 31 36 28 73 71 6c 69 74 65 33  cltype16(sqlite3
2f340 5f 73 74 6d 74 2a 2c 69 6e 74 29 3b 0a 0a 2f 2a  _stmt*,int);../*
2f350 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 45 76  .** CAPI3REF: Ev
2f360 61 6c 75 61 74 65 20 41 6e 20 53 51 4c 20 53 74  aluate An SQL St
2f370 61 74 65 6d 65 6e 74 0a 2a 2a 20 4d 45 54 48 4f  atement.** METHO
2f380 44 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 0a  D: sqlite3_stmt.
2f390 2a 2a 0a 2a 2a 20 41 66 74 65 72 20 61 20 5b 70  **.** After a [p
2f3a0 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e  repared statemen
2f3b0 74 5d 20 68 61 73 20 62 65 65 6e 20 70 72 65 70  t] has been prep
2f3c0 61 72 65 64 20 75 73 69 6e 67 20 65 69 74 68 65  ared using eithe
2f3d0 72 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 70 72  r.** [sqlite3_pr
2f3e0 65 70 61 72 65 5f 76 32 28 29 5d 20 6f 72 20 5b  epare_v2()] or [
2f3f0 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 31  sqlite3_prepare1
2f400 36 5f 76 32 28 29 5d 20 6f 72 20 6f 6e 65 20 6f  6_v2()] or one o
2f410 66 20 74 68 65 20 6c 65 67 61 63 79 0a 2a 2a 20  f the legacy.** 
2f420 69 6e 74 65 72 66 61 63 65 73 20 5b 73 71 6c 69  interfaces [sqli
2f430 74 65 33 5f 70 72 65 70 61 72 65 28 29 5d 20 6f  te3_prepare()] o
2f440 72 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61  r [sqlite3_prepa
2f450 72 65 31 36 28 29 5d 2c 20 74 68 69 73 20 66 75  re16()], this fu
2f460 6e 63 74 69 6f 6e 0a 2a 2a 20 6d 75 73 74 20 62  nction.** must b
2f470 65 20 63 61 6c 6c 65 64 20 6f 6e 65 20 6f 72 20  e called one or 
2f480 6d 6f 72 65 20 74 69 6d 65 73 20 74 6f 20 65 76  more times to ev
2f490 61 6c 75 61 74 65 20 74 68 65 20 73 74 61 74 65  aluate the state
2f4a0 6d 65 6e 74 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  ment..**.** The 
2f4b0 64 65 74 61 69 6c 73 20 6f 66 20 74 68 65 20 62  details of the b
2f4c0 65 68 61 76 69 6f 72 20 6f 66 20 74 68 65 20 73  ehavior of the s
2f4d0 71 6c 69 74 65 33 5f 73 74 65 70 28 29 20 69 6e  qlite3_step() in
2f4e0 74 65 72 66 61 63 65 20 64 65 70 65 6e 64 0a 2a  terface depend.*
2f4f0 2a 20 6f 6e 20 77 68 65 74 68 65 72 20 74 68 65  * on whether the
2f500 20 73 74 61 74 65 6d 65 6e 74 20 77 61 73 20 70   statement was p
2f510 72 65 70 61 72 65 64 20 75 73 69 6e 67 20 74 68  repared using th
2f520 65 20 6e 65 77 65 72 20 22 76 32 22 20 69 6e 74  e newer "v2" int
2f530 65 72 66 61 63 65 0a 2a 2a 20 5b 73 71 6c 69 74  erface.** [sqlit
2f540 65 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d  e3_prepare_v2()]
2f550 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 70 72   and [sqlite3_pr
2f560 65 70 61 72 65 31 36 5f 76 32 28 29 5d 20 6f 72  epare16_v2()] or
2f570 20 74 68 65 20 6f 6c 64 65 72 20 6c 65 67 61 63   the older legac
2f580 79 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 5b  y.** interface [
2f590 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 28  sqlite3_prepare(
2f5a0 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f  )] and [sqlite3_
2f5b0 70 72 65 70 61 72 65 31 36 28 29 5d 2e 20 20 54  prepare16()].  T
2f5c0 68 65 20 75 73 65 20 6f 66 20 74 68 65 0a 2a 2a  he use of the.**
2f5d0 20 6e 65 77 20 22 76 32 22 20 69 6e 74 65 72 66   new "v2" interf
2f5e0 61 63 65 20 69 73 20 72 65 63 6f 6d 6d 65 6e 64  ace is recommend
2f5f0 65 64 20 66 6f 72 20 6e 65 77 20 61 70 70 6c 69  ed for new appli
2f600 63 61 74 69 6f 6e 73 20 62 75 74 20 74 68 65 20  cations but the 
2f610 6c 65 67 61 63 79 0a 2a 2a 20 69 6e 74 65 72 66  legacy.** interf
2f620 61 63 65 20 77 69 6c 6c 20 63 6f 6e 74 69 6e 75  ace will continu
2f630 65 20 74 6f 20 62 65 20 73 75 70 70 6f 72 74 65  e to be supporte
2f640 64 2e 0a 2a 2a 0a 2a 2a 20 5e 49 6e 20 74 68 65  d..**.** ^In the
2f650 20 6c 65 67 61 63 79 20 69 6e 74 65 72 66 61 63   legacy interfac
2f660 65 2c 20 74 68 65 20 72 65 74 75 72 6e 20 76 61  e, the return va
2f670 6c 75 65 20 77 69 6c 6c 20 62 65 20 65 69 74 68  lue will be eith
2f680 65 72 20 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d  er [SQLITE_BUSY]
2f690 2c 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 44 4f 4e  ,.** [SQLITE_DON
2f6a0 45 5d 2c 20 5b 53 51 4c 49 54 45 5f 52 4f 57 5d  E], [SQLITE_ROW]
2f6b0 2c 20 5b 53 51 4c 49 54 45 5f 45 52 52 4f 52 5d  , [SQLITE_ERROR]
2f6c0 2c 20 6f 72 20 5b 53 51 4c 49 54 45 5f 4d 49 53  , or [SQLITE_MIS
2f6d0 55 53 45 5d 2e 0a 2a 2a 20 5e 57 69 74 68 20 74  USE]..** ^With t
2f6e0 68 65 20 22 76 32 22 20 69 6e 74 65 72 66 61 63  he "v2" interfac
2f6f0 65 2c 20 61 6e 79 20 6f 66 20 74 68 65 20 6f 74  e, any of the ot
2f700 68 65 72 20 5b 72 65 73 75 6c 74 20 63 6f 64 65  her [result code
2f710 73 5d 20 6f 72 0a 2a 2a 20 5b 65 78 74 65 6e 64  s] or.** [extend
2f720 65 64 20 72 65 73 75 6c 74 20 63 6f 64 65 73 5d  ed result codes]
2f730 20 6d 69 67 68 74 20 62 65 20 72 65 74 75 72 6e   might be return
2f740 65 64 20 61 73 20 77 65 6c 6c 2e 0a 2a 2a 0a 2a  ed as well..**.*
2f750 2a 20 5e 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d  * ^[SQLITE_BUSY]
2f760 20 6d 65 61 6e 73 20 74 68 61 74 20 74 68 65 20   means that the 
2f770 64 61 74 61 62 61 73 65 20 65 6e 67 69 6e 65 20  database engine 
2f780 77 61 73 20 75 6e 61 62 6c 65 20 74 6f 20 61 63  was unable to ac
2f790 71 75 69 72 65 20 74 68 65 0a 2a 2a 20 64 61 74  quire the.** dat
2f7a0 61 62 61 73 65 20 6c 6f 63 6b 73 20 69 74 20 6e  abase locks it n
2f7b0 65 65 64 73 20 74 6f 20 64 6f 20 69 74 73 20 6a  eeds to do its j
2f7c0 6f 62 2e 20 20 5e 49 66 20 74 68 65 20 73 74 61  ob.  ^If the sta
2f7d0 74 65 6d 65 6e 74 20 69 73 20 61 20 5b 43 4f 4d  tement is a [COM
2f7e0 4d 49 54 5d 0a 2a 2a 20 6f 72 20 6f 63 63 75 72  MIT].** or occur
2f7f0 73 20 6f 75 74 73 69 64 65 20 6f 66 20 61 6e 20  s outside of an 
2f800 65 78 70 6c 69 63 69 74 20 74 72 61 6e 73 61 63  explicit transac
2f810 74 69 6f 6e 2c 20 74 68 65 6e 20 79 6f 75 20 63  tion, then you c
2f820 61 6e 20 72 65 74 72 79 20 74 68 65 0a 2a 2a 20  an retry the.** 
2f830 73 74 61 74 65 6d 65 6e 74 2e 20 20 49 66 20 74  statement.  If t
2f840 68 65 20 73 74 61 74 65 6d 65 6e 74 20 69 73 20  he statement is 
2f850 6e 6f 74 20 61 20 5b 43 4f 4d 4d 49 54 5d 20 61  not a [COMMIT] a
2f860 6e 64 20 6f 63 63 75 72 73 20 77 69 74 68 69 6e  nd occurs within
2f870 20 61 6e 0a 2a 2a 20 65 78 70 6c 69 63 69 74 20   an.** explicit 
2f880 74 72 61 6e 73 61 63 74 69 6f 6e 20 74 68 65 6e  transaction then
2f890 20 79 6f 75 20 73 68 6f 75 6c 64 20 72 6f 6c 6c   you should roll
2f8a0 62 61 63 6b 20 74 68 65 20 74 72 61 6e 73 61 63  back the transac
2f8b0 74 69 6f 6e 20 62 65 66 6f 72 65 0a 2a 2a 20 63  tion before.** c
2f8c0 6f 6e 74 69 6e 75 69 6e 67 2e 0a 2a 2a 0a 2a 2a  ontinuing..**.**
2f8d0 20 5e 5b 53 51 4c 49 54 45 5f 44 4f 4e 45 5d 20   ^[SQLITE_DONE] 
2f8e0 6d 65 61 6e 73 20 74 68 61 74 20 74 68 65 20 73  means that the s
2f8f0 74 61 74 65 6d 65 6e 74 20 68 61 73 20 66 69 6e  tatement has fin
2f900 69 73 68 65 64 20 65 78 65 63 75 74 69 6e 67 0a  ished executing.
2f910 2a 2a 20 73 75 63 63 65 73 73 66 75 6c 6c 79 2e  ** successfully.
2f920 20 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29    sqlite3_step()
2f930 20 73 68 6f 75 6c 64 20 6e 6f 74 20 62 65 20 63   should not be c
2f940 61 6c 6c 65 64 20 61 67 61 69 6e 20 6f 6e 20 74  alled again on t
2f950 68 69 73 20 76 69 72 74 75 61 6c 0a 2a 2a 20 6d  his virtual.** m
2f960 61 63 68 69 6e 65 20 77 69 74 68 6f 75 74 20 66  achine without f
2f970 69 72 73 74 20 63 61 6c 6c 69 6e 67 20 5b 73 71  irst calling [sq
2f980 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20 74  lite3_reset()] t
2f990 6f 20 72 65 73 65 74 20 74 68 65 20 76 69 72 74  o reset the virt
2f9a0 75 61 6c 0a 2a 2a 20 6d 61 63 68 69 6e 65 20 62  ual.** machine b
2f9b0 61 63 6b 20 74 6f 20 69 74 73 20 69 6e 69 74 69  ack to its initi
2f9c0 61 6c 20 73 74 61 74 65 2e 0a 2a 2a 0a 2a 2a 20  al state..**.** 
2f9d0 5e 49 66 20 74 68 65 20 53 51 4c 20 73 74 61 74  ^If the SQL stat
2f9e0 65 6d 65 6e 74 20 62 65 69 6e 67 20 65 78 65 63  ement being exec
2f9f0 75 74 65 64 20 72 65 74 75 72 6e 73 20 61 6e 79  uted returns any
2fa00 20 64 61 74 61 2c 20 74 68 65 6e 20 5b 53 51 4c   data, then [SQL
2fa10 49 54 45 5f 52 4f 57 5d 0a 2a 2a 20 69 73 20 72  ITE_ROW].** is r
2fa20 65 74 75 72 6e 65 64 20 65 61 63 68 20 74 69 6d  eturned each tim
2fa30 65 20 61 20 6e 65 77 20 72 6f 77 20 6f 66 20 64  e a new row of d
2fa40 61 74 61 20 69 73 20 72 65 61 64 79 20 66 6f 72  ata is ready for
2fa50 20 70 72 6f 63 65 73 73 69 6e 67 20 62 79 20 74   processing by t
2fa60 68 65 0a 2a 2a 20 63 61 6c 6c 65 72 2e 20 54 68  he.** caller. Th
2fa70 65 20 76 61 6c 75 65 73 20 6d 61 79 20 62 65 20  e values may be 
2fa80 61 63 63 65 73 73 65 64 20 75 73 69 6e 67 20 74  accessed using t
2fa90 68 65 20 5b 63 6f 6c 75 6d 6e 20 61 63 63 65 73  he [column acces
2faa0 73 20 66 75 6e 63 74 69 6f 6e 73 5d 2e 0a 2a 2a  s functions]..**
2fab0 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 20   sqlite3_step() 
2fac0 69 73 20 63 61 6c 6c 65 64 20 61 67 61 69 6e 20  is called again 
2fad0 74 6f 20 72 65 74 72 69 65 76 65 20 74 68 65 20  to retrieve the 
2fae0 6e 65 78 74 20 72 6f 77 20 6f 66 20 64 61 74 61  next row of data
2faf0 2e 0a 2a 2a 0a 2a 2a 20 5e 5b 53 51 4c 49 54 45  ..**.** ^[SQLITE
2fb00 5f 45 52 52 4f 52 5d 20 6d 65 61 6e 73 20 74 68  _ERROR] means th
2fb10 61 74 20 61 20 72 75 6e 2d 74 69 6d 65 20 65 72  at a run-time er
2fb20 72 6f 72 20 28 73 75 63 68 20 61 73 20 61 20 63  ror (such as a c
2fb30 6f 6e 73 74 72 61 69 6e 74 0a 2a 2a 20 76 69 6f  onstraint.** vio
2fb40 6c 61 74 69 6f 6e 29 20 68 61 73 20 6f 63 63 75  lation) has occu
2fb50 72 72 65 64 2e 20 20 73 71 6c 69 74 65 33 5f 73  rred.  sqlite3_s
2fb60 74 65 70 28 29 20 73 68 6f 75 6c 64 20 6e 6f 74  tep() should not
2fb70 20 62 65 20 63 61 6c 6c 65 64 20 61 67 61 69 6e   be called again
2fb80 20 6f 6e 0a 2a 2a 20 74 68 65 20 56 4d 2e 20 4d   on.** the VM. M
2fb90 6f 72 65 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20  ore information 
2fba0 6d 61 79 20 62 65 20 66 6f 75 6e 64 20 62 79 20  may be found by 
2fbb0 63 61 6c 6c 69 6e 67 20 5b 73 71 6c 69 74 65 33  calling [sqlite3
2fbc0 5f 65 72 72 6d 73 67 28 29 5d 2e 0a 2a 2a 20 5e  _errmsg()]..** ^
2fbd0 57 69 74 68 20 74 68 65 20 6c 65 67 61 63 79 20  With the legacy 
2fbe0 69 6e 74 65 72 66 61 63 65 2c 20 61 20 6d 6f 72  interface, a mor
2fbf0 65 20 73 70 65 63 69 66 69 63 20 65 72 72 6f 72  e specific error
2fc00 20 63 6f 64 65 20 28 66 6f 72 20 65 78 61 6d 70   code (for examp
2fc10 6c 65 2c 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 49  le,.** [SQLITE_I
2fc20 4e 54 45 52 52 55 50 54 5d 2c 20 5b 53 51 4c 49  NTERRUPT], [SQLI
2fc30 54 45 5f 53 43 48 45 4d 41 5d 2c 20 5b 53 51 4c  TE_SCHEMA], [SQL
2fc40 49 54 45 5f 43 4f 52 52 55 50 54 5d 2c 20 61 6e  ITE_CORRUPT], an
2fc50 64 20 73 6f 20 66 6f 72 74 68 29 0a 2a 2a 20 63  d so forth).** c
2fc60 61 6e 20 62 65 20 6f 62 74 61 69 6e 65 64 20 62  an be obtained b
2fc70 79 20 63 61 6c 6c 69 6e 67 20 5b 73 71 6c 69 74  y calling [sqlit
2fc80 65 33 5f 72 65 73 65 74 28 29 5d 20 6f 6e 20 74  e3_reset()] on t
2fc90 68 65 0a 2a 2a 20 5b 70 72 65 70 61 72 65 64 20  he.** [prepared 
2fca0 73 74 61 74 65 6d 65 6e 74 5d 2e 20 20 5e 49 6e  statement].  ^In
2fcb0 20 74 68 65 20 22 76 32 22 20 69 6e 74 65 72 66   the "v2" interf
2fcc0 61 63 65 2c 0a 2a 2a 20 74 68 65 20 6d 6f 72 65  ace,.** the more
2fcd0 20 73 70 65 63 69 66 69 63 20 65 72 72 6f 72 20   specific error 
2fce0 63 6f 64 65 20 69 73 20 72 65 74 75 72 6e 65 64  code is returned
2fcf0 20 64 69 72 65 63 74 6c 79 20 62 79 20 73 71 6c   directly by sql
2fd00 69 74 65 33 5f 73 74 65 70 28 29 2e 0a 2a 2a 0a  ite3_step()..**.
2fd10 2a 2a 20 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53  ** [SQLITE_MISUS
2fd20 45 5d 20 6d 65 61 6e 73 20 74 68 61 74 20 74 68  E] means that th
2fd30 65 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 77  e this routine w
2fd40 61 73 20 63 61 6c 6c 65 64 20 69 6e 61 70 70 72  as called inappr
2fd50 6f 70 72 69 61 74 65 6c 79 2e 0a 2a 2a 20 50 65  opriately..** Pe
2fd60 72 68 61 70 73 20 69 74 20 77 61 73 20 63 61 6c  rhaps it was cal
2fd70 6c 65 64 20 6f 6e 20 61 20 5b 70 72 65 70 61 72  led on a [prepar
2fd80 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 74 68  ed statement] th
2fd90 61 74 20 68 61 73 0a 2a 2a 20 61 6c 72 65 61 64  at has.** alread
2fda0 79 20 62 65 65 6e 20 5b 73 71 6c 69 74 65 33 5f  y been [sqlite3_
2fdb0 66 69 6e 61 6c 69 7a 65 20 7c 20 66 69 6e 61 6c  finalize | final
2fdc0 69 7a 65 64 5d 20 6f 72 20 6f 6e 20 6f 6e 65 20  ized] or on one 
2fdd0 74 68 61 74 20 68 61 64 0a 2a 2a 20 70 72 65 76  that had.** prev
2fde0 69 6f 75 73 6c 79 20 72 65 74 75 72 6e 65 64 20  iously returned 
2fdf0 5b 53 51 4c 49 54 45 5f 45 52 52 4f 52 5d 20 6f  [SQLITE_ERROR] o
2fe00 72 20 5b 53 51 4c 49 54 45 5f 44 4f 4e 45 5d 2e  r [SQLITE_DONE].
2fe10 20 20 4f 72 20 69 74 20 63 6f 75 6c 64 0a 2a 2a    Or it could.**
2fe20 20 62 65 20 74 68 65 20 63 61 73 65 20 74 68 61   be the case tha
2fe30 74 20 74 68 65 20 73 61 6d 65 20 64 61 74 61 62  t the same datab
2fe40 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 69  ase connection i
2fe50 73 20 62 65 69 6e 67 20 75 73 65 64 20 62 79 20  s being used by 
2fe60 74 77 6f 20 6f 72 0a 2a 2a 20 6d 6f 72 65 20 74  two or.** more t
2fe70 68 72 65 61 64 73 20 61 74 20 74 68 65 20 73 61  hreads at the sa
2fe80 6d 65 20 6d 6f 6d 65 6e 74 20 69 6e 20 74 69 6d  me moment in tim
2fe90 65 2e 0a 2a 2a 0a 2a 2a 20 46 6f 72 20 61 6c 6c  e..**.** For all
2fea0 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c   versions of SQL
2feb0 69 74 65 20 75 70 20 74 6f 20 61 6e 64 20 69 6e  ite up to and in
2fec0 63 6c 75 64 69 6e 67 20 33 2e 36 2e 32 33 2e 31  cluding 3.6.23.1
2fed0 2c 20 61 20 63 61 6c 6c 20 74 6f 0a 2a 2a 20 5b  , a call to.** [
2fee0 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d  sqlite3_reset()]
2fef0 20 77 61 73 20 72 65 71 75 69 72 65 64 20 61 66   was required af
2ff00 74 65 72 20 73 71 6c 69 74 65 33 5f 73 74 65 70  ter sqlite3_step
2ff10 28 29 20 72 65 74 75 72 6e 65 64 20 61 6e 79 74  () returned anyt
2ff20 68 69 6e 67 0a 2a 2a 20 6f 74 68 65 72 20 74 68  hing.** other th
2ff30 61 6e 20 5b 53 51 4c 49 54 45 5f 52 4f 57 5d 20  an [SQLITE_ROW] 
2ff40 62 65 66 6f 72 65 20 61 6e 79 20 73 75 62 73 65  before any subse
2ff50 71 75 65 6e 74 20 69 6e 76 6f 63 61 74 69 6f 6e  quent invocation
2ff60 20 6f 66 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 73   of.** sqlite3_s
2ff70 74 65 70 28 29 2e 20 20 46 61 69 6c 75 72 65 20  tep().  Failure 
2ff80 74 6f 20 72 65 73 65 74 20 74 68 65 20 70 72 65  to reset the pre
2ff90 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 20  pared statement 
2ffa0 75 73 69 6e 67 20 0a 2a 2a 20 5b 73 71 6c 69 74  using .** [sqlit
2ffb0 65 33 5f 72 65 73 65 74 28 29 5d 20 77 6f 75 6c  e3_reset()] woul
2ffc0 64 20 72 65 73 75 6c 74 20 69 6e 20 61 6e 20 5b  d result in an [
2ffd0 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 5d 20 72  SQLITE_MISUSE] r
2ffe0 65 74 75 72 6e 20 66 72 6f 6d 0a 2a 2a 20 73 71  eturn from.** sq
2fff0 6c 69 74 65 33 5f 73 74 65 70 28 29 2e 20 20 42  lite3_step().  B
30000 75 74 20 61 66 74 65 72 20 76 65 72 73 69 6f 6e  ut after version
30010 20 33 2e 36 2e 32 33 2e 31 2c 20 73 71 6c 69 74   3.6.23.1, sqlit
30020 65 33 5f 73 74 65 70 28 29 20 62 65 67 61 6e 0a  e3_step() began.
30030 2a 2a 20 63 61 6c 6c 69 6e 67 20 5b 73 71 6c 69  ** calling [sqli
30040 74 65 33 5f 72 65 73 65 74 28 29 5d 20 61 75 74  te3_reset()] aut
30050 6f 6d 61 74 69 63 61 6c 6c 79 20 69 6e 20 74 68  omatically in th
30060 69 73 20 63 69 72 63 75 6d 73 74 61 6e 63 65 20  is circumstance 
30070 72 61 74 68 65 72 0a 2a 2a 20 74 68 61 6e 20 72  rather.** than r
30080 65 74 75 72 6e 69 6e 67 20 5b 53 51 4c 49 54 45  eturning [SQLITE
30090 5f 4d 49 53 55 53 45 5d 2e 20 20 54 68 69 73 20  _MISUSE].  This 
300a0 69 73 20 6e 6f 74 20 63 6f 6e 73 69 64 65 72 65  is not considere
300b0 64 20 61 20 63 6f 6d 70 61 74 69 62 69 6c 69 74  d a compatibilit
300c0 79 0a 2a 2a 20 62 72 65 61 6b 20 62 65 63 61 75  y.** break becau
300d0 73 65 20 61 6e 79 20 61 70 70 6c 69 63 61 74 69  se any applicati
300e0 6f 6e 20 74 68 61 74 20 65 76 65 72 20 72 65 63  on that ever rec
300f0 65 69 76 65 73 20 61 6e 20 53 51 4c 49 54 45 5f  eives an SQLITE_
30100 4d 49 53 55 53 45 20 65 72 72 6f 72 0a 2a 2a 20  MISUSE error.** 
30110 69 73 20 62 72 6f 6b 65 6e 20 62 79 20 64 65 66  is broken by def
30120 69 6e 69 74 69 6f 6e 2e 20 20 54 68 65 20 5b 53  inition.  The [S
30130 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 55 54 4f 52  QLITE_OMIT_AUTOR
30140 45 53 45 54 5d 20 63 6f 6d 70 69 6c 65 2d 74 69  ESET] compile-ti
30150 6d 65 20 6f 70 74 69 6f 6e 0a 2a 2a 20 63 61 6e  me option.** can
30160 20 62 65 20 75 73 65 64 20 74 6f 20 72 65 73 74   be used to rest
30170 6f 72 65 20 74 68 65 20 6c 65 67 61 63 79 20 62  ore the legacy b
30180 65 68 61 76 69 6f 72 2e 0a 2a 2a 0a 2a 2a 20 3c  ehavior..**.** <
30190 62 3e 47 6f 6f 66 79 20 49 6e 74 65 72 66 61 63  b>Goofy Interfac
301a0 65 20 41 6c 65 72 74 3a 3c 2f 62 3e 20 49 6e 20  e Alert:</b> In 
301b0 74 68 65 20 6c 65 67 61 63 79 20 69 6e 74 65 72  the legacy inter
301c0 66 61 63 65 2c 20 74 68 65 20 73 71 6c 69 74 65  face, the sqlite
301d0 33 5f 73 74 65 70 28 29 0a 2a 2a 20 41 50 49 20  3_step().** API 
301e0 61 6c 77 61 79 73 20 72 65 74 75 72 6e 73 20 61  always returns a
301f0 20 67 65 6e 65 72 69 63 20 65 72 72 6f 72 20 63   generic error c
30200 6f 64 65 2c 20 5b 53 51 4c 49 54 45 5f 45 52 52  ode, [SQLITE_ERR
30210 4f 52 5d 2c 20 66 6f 6c 6c 6f 77 69 6e 67 20 61  OR], following a
30220 6e 79 0a 2a 2a 20 65 72 72 6f 72 20 6f 74 68 65  ny.** error othe
30230 72 20 74 68 61 6e 20 5b 53 51 4c 49 54 45 5f 42  r than [SQLITE_B
30240 55 53 59 5d 20 61 6e 64 20 5b 53 51 4c 49 54 45  USY] and [SQLITE
30250 5f 4d 49 53 55 53 45 5d 2e 20 20 59 6f 75 20 6d  _MISUSE].  You m
30260 75 73 74 20 63 61 6c 6c 0a 2a 2a 20 5b 73 71 6c  ust call.** [sql
30270 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20 6f 72  ite3_reset()] or
30280 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69   [sqlite3_finali
30290 7a 65 28 29 5d 20 69 6e 20 6f 72 64 65 72 20 74  ze()] in order t
302a0 6f 20 66 69 6e 64 20 6f 6e 65 20 6f 66 20 74 68  o find one of th
302b0 65 0a 2a 2a 20 73 70 65 63 69 66 69 63 20 5b 65  e.** specific [e
302c0 72 72 6f 72 20 63 6f 64 65 73 5d 20 74 68 61 74  rror codes] that
302d0 20 62 65 74 74 65 72 20 64 65 73 63 72 69 62 65   better describe
302e0 73 20 74 68 65 20 65 72 72 6f 72 2e 0a 2a 2a 20  s the error..** 
302f0 57 65 20 61 64 6d 69 74 20 74 68 61 74 20 74 68  We admit that th
30300 69 73 20 69 73 20 61 20 67 6f 6f 66 79 20 64 65  is is a goofy de
30310 73 69 67 6e 2e 20 20 54 68 65 20 70 72 6f 62 6c  sign.  The probl
30320 65 6d 20 68 61 73 20 62 65 65 6e 20 66 69 78 65  em has been fixe
30330 64 0a 2a 2a 20 77 69 74 68 20 74 68 65 20 22 76  d.** with the "v
30340 32 22 20 69 6e 74 65 72 66 61 63 65 2e 20 20 49  2" interface.  I
30350 66 20 79 6f 75 20 70 72 65 70 61 72 65 20 61 6c  f you prepare al
30360 6c 20 6f 66 20 79 6f 75 72 20 53 51 4c 20 73 74  l of your SQL st
30370 61 74 65 6d 65 6e 74 73 0a 2a 2a 20 75 73 69 6e  atements.** usin
30380 67 20 65 69 74 68 65 72 20 5b 73 71 6c 69 74 65  g either [sqlite
30390 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d 20  3_prepare_v2()] 
303a0 6f 72 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70  or [sqlite3_prep
303b0 61 72 65 31 36 5f 76 32 28 29 5d 20 69 6e 73 74  are16_v2()] inst
303c0 65 61 64 0a 2a 2a 20 6f 66 20 74 68 65 20 6c 65  ead.** of the le
303d0 67 61 63 79 20 5b 73 71 6c 69 74 65 33 5f 70 72  gacy [sqlite3_pr
303e0 65 70 61 72 65 28 29 5d 20 61 6e 64 20 5b 73 71  epare()] and [sq
303f0 6c 69 74 65 33 5f 70 72 65 70 61 72 65 31 36 28  lite3_prepare16(
30400 29 5d 20 69 6e 74 65 72 66 61 63 65 73 2c 0a 2a  )] interfaces,.*
30410 2a 20 74 68 65 6e 20 74 68 65 20 6d 6f 72 65 20  * then the more 
30420 73 70 65 63 69 66 69 63 20 5b 65 72 72 6f 72 20  specific [error 
30430 63 6f 64 65 73 5d 20 61 72 65 20 72 65 74 75 72  codes] are retur
30440 6e 65 64 20 64 69 72 65 63 74 6c 79 0a 2a 2a 20  ned directly.** 
30450 62 79 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28  by sqlite3_step(
30460 29 2e 20 20 54 68 65 20 75 73 65 20 6f 66 20 74  ).  The use of t
30470 68 65 20 22 76 32 22 20 69 6e 74 65 72 66 61 63  he "v2" interfac
30480 65 20 69 73 20 72 65 63 6f 6d 6d 65 6e 64 65 64  e is recommended
30490 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  ..*/.int sqlite3
304a0 5f 73 74 65 70 28 73 71 6c 69 74 65 33 5f 73 74  _step(sqlite3_st
304b0 6d 74 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  mt*);../*.** CAP
304c0 49 33 52 45 46 3a 20 4e 75 6d 62 65 72 20 6f 66  I3REF: Number of
304d0 20 63 6f 6c 75 6d 6e 73 20 69 6e 20 61 20 72 65   columns in a re
304e0 73 75 6c 74 20 73 65 74 0a 2a 2a 20 4d 45 54 48  sult set.** METH
304f0 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d 74  OD: sqlite3_stmt
30500 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69  .**.** ^The sqli
30510 74 65 33 5f 64 61 74 61 5f 63 6f 75 6e 74 28 50  te3_data_count(P
30520 29 20 69 6e 74 65 72 66 61 63 65 20 72 65 74 75  ) interface retu
30530 72 6e 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f  rns the number o
30540 66 20 63 6f 6c 75 6d 6e 73 20 69 6e 20 74 68 65  f columns in the
30550 0a 2a 2a 20 63 75 72 72 65 6e 74 20 72 6f 77 20  .** current row 
30560 6f 66 20 74 68 65 20 72 65 73 75 6c 74 20 73 65  of the result se
30570 74 20 6f 66 20 5b 70 72 65 70 61 72 65 64 20 73  t of [prepared s
30580 74 61 74 65 6d 65 6e 74 5d 20 50 2e 0a 2a 2a 20  tatement] P..** 
30590 5e 49 66 20 70 72 65 70 61 72 65 64 20 73 74 61  ^If prepared sta
305a0 74 65 6d 65 6e 74 20 50 20 64 6f 65 73 20 6e 6f  tement P does no
305b0 74 20 68 61 76 65 20 72 65 73 75 6c 74 73 20 72  t have results r
305c0 65 61 64 79 20 74 6f 20 72 65 74 75 72 6e 0a 2a  eady to return.*
305d0 2a 20 28 76 69 61 20 63 61 6c 6c 73 20 74 6f 20  * (via calls to 
305e0 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c  the [sqlite3_col
305f0 75 6d 6e 5f 69 6e 74 20 7c 20 73 71 6c 69 74 65  umn_int | sqlite
30600 33 5f 63 6f 6c 75 6d 6e 5f 2a 28 29 5d 20 6f 66  3_column_*()] of
30610 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 73 29 20  .** interfaces) 
30620 74 68 65 6e 20 73 71 6c 69 74 65 33 5f 64 61 74  then sqlite3_dat
30630 61 5f 63 6f 75 6e 74 28 50 29 20 72 65 74 75 72  a_count(P) retur
30640 6e 73 20 30 2e 0a 2a 2a 20 5e 54 68 65 20 73 71  ns 0..** ^The sq
30650 6c 69 74 65 33 5f 64 61 74 61 5f 63 6f 75 6e 74  lite3_data_count
30660 28 50 29 20 72 6f 75 74 69 6e 65 20 61 6c 73 6f  (P) routine also
30670 20 72 65 74 75 72 6e 73 20 30 20 69 66 20 50 20   returns 0 if P 
30680 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  is a NULL pointe
30690 72 2e 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  r..** ^The sqlit
306a0 65 33 5f 64 61 74 61 5f 63 6f 75 6e 74 28 50 29  e3_data_count(P)
306b0 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73   routine returns
306c0 20 30 20 69 66 20 74 68 65 20 70 72 65 76 69 6f   0 if the previo
306d0 75 73 20 63 61 6c 6c 20 74 6f 0a 2a 2a 20 5b 73  us call to.** [s
306e0 71 6c 69 74 65 33 5f 73 74 65 70 5d 28 50 29 20  qlite3_step](P) 
306f0 72 65 74 75 72 6e 65 64 20 5b 53 51 4c 49 54 45  returned [SQLITE
30700 5f 44 4f 4e 45 5d 2e 20 20 5e 54 68 65 20 73 71  _DONE].  ^The sq
30710 6c 69 74 65 33 5f 64 61 74 61 5f 63 6f 75 6e 74  lite3_data_count
30720 28 50 29 0a 2a 2a 20 77 69 6c 6c 20 72 65 74 75  (P).** will retu
30730 72 6e 20 6e 6f 6e 2d 7a 65 72 6f 20 69 66 20 70  rn non-zero if p
30740 72 65 76 69 6f 75 73 20 63 61 6c 6c 20 74 6f 20  revious call to 
30750 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 5d 28 50  [sqlite3_step](P
30760 29 20 72 65 74 75 72 6e 65 64 0a 2a 2a 20 5b 53  ) returned.** [S
30770 51 4c 49 54 45 5f 52 4f 57 5d 2c 20 65 78 63 65  QLITE_ROW], exce
30780 70 74 20 69 6e 20 74 68 65 20 63 61 73 65 20 6f  pt in the case o
30790 66 20 74 68 65 20 5b 50 52 41 47 4d 41 20 69 6e  f the [PRAGMA in
307a0 63 72 65 6d 65 6e 74 61 6c 5f 76 61 63 75 75 6d  cremental_vacuum
307b0 5d 0a 2a 2a 20 77 68 65 72 65 20 69 74 20 61 6c  ].** where it al
307c0 77 61 79 73 20 72 65 74 75 72 6e 73 20 7a 65 72  ways returns zer
307d0 6f 20 73 69 6e 63 65 20 65 61 63 68 20 73 74 65  o since each ste
307e0 70 20 6f 66 20 74 68 61 74 20 6d 75 6c 74 69 2d  p of that multi-
307f0 73 74 65 70 0a 2a 2a 20 70 72 61 67 6d 61 20 72  step.** pragma r
30800 65 74 75 72 6e 73 20 30 20 63 6f 6c 75 6d 6e 73  eturns 0 columns
30810 20 6f 66 20 64 61 74 61 2e 0a 2a 2a 0a 2a 2a 20   of data..**.** 
30820 53 65 65 20 61 6c 73 6f 3a 20 5b 73 71 6c 69 74  See also: [sqlit
30830 65 33 5f 63 6f 6c 75 6d 6e 5f 63 6f 75 6e 74 28  e3_column_count(
30840 29 5d 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  )].*/.int sqlite
30850 33 5f 64 61 74 61 5f 63 6f 75 6e 74 28 73 71 6c  3_data_count(sql
30860 69 74 65 33 5f 73 74 6d 74 20 2a 70 53 74 6d 74  ite3_stmt *pStmt
30870 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
30880 45 46 3a 20 46 75 6e 64 61 6d 65 6e 74 61 6c 20  EF: Fundamental 
30890 44 61 74 61 74 79 70 65 73 0a 2a 2a 20 4b 45 59  Datatypes.** KEY
308a0 57 4f 52 44 53 3a 20 53 51 4c 49 54 45 5f 54 45  WORDS: SQLITE_TE
308b0 58 54 0a 2a 2a 0a 2a 2a 20 5e 28 45 76 65 72 79  XT.**.** ^(Every
308c0 20 76 61 6c 75 65 20 69 6e 20 53 51 4c 69 74 65   value in SQLite
308d0 20 68 61 73 20 6f 6e 65 20 6f 66 20 66 69 76 65   has one of five
308e0 20 66 75 6e 64 61 6d 65 6e 74 61 6c 20 64 61 74   fundamental dat
308f0 61 74 79 70 65 73 3a 0a 2a 2a 0a 2a 2a 20 3c 75  atypes:.**.** <u
30900 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20 36 34 2d 62 69  l>.** <li> 64-bi
30910 74 20 73 69 67 6e 65 64 20 69 6e 74 65 67 65 72  t signed integer
30920 0a 2a 2a 20 3c 6c 69 3e 20 36 34 2d 62 69 74 20  .** <li> 64-bit 
30930 49 45 45 45 20 66 6c 6f 61 74 69 6e 67 20 70 6f  IEEE floating po
30940 69 6e 74 20 6e 75 6d 62 65 72 0a 2a 2a 20 3c 6c  int number.** <l
30950 69 3e 20 73 74 72 69 6e 67 0a 2a 2a 20 3c 6c 69  i> string.** <li
30960 3e 20 42 4c 4f 42 0a 2a 2a 20 3c 6c 69 3e 20 4e  > BLOB.** <li> N
30970 55 4c 4c 0a 2a 2a 20 3c 2f 75 6c 3e 29 5e 0a 2a  ULL.** </ul>)^.*
30980 2a 0a 2a 2a 20 54 68 65 73 65 20 63 6f 6e 73 74  *.** These const
30990 61 6e 74 73 20 61 72 65 20 63 6f 64 65 73 20 66  ants are codes f
309a0 6f 72 20 65 61 63 68 20 6f 66 20 74 68 6f 73 65  or each of those
309b0 20 74 79 70 65 73 2e 0a 2a 2a 0a 2a 2a 20 4e 6f   types..**.** No
309c0 74 65 20 74 68 61 74 20 74 68 65 20 53 51 4c 49  te that the SQLI
309d0 54 45 5f 54 45 58 54 20 63 6f 6e 73 74 61 6e 74  TE_TEXT constant
309e0 20 77 61 73 20 61 6c 73 6f 20 75 73 65 64 20 69   was also used i
309f0 6e 20 53 51 4c 69 74 65 20 76 65 72 73 69 6f 6e  n SQLite version
30a00 20 32 0a 2a 2a 20 66 6f 72 20 61 20 63 6f 6d 70   2.** for a comp
30a10 6c 65 74 65 6c 79 20 64 69 66 66 65 72 65 6e 74  letely different
30a20 20 6d 65 61 6e 69 6e 67 2e 20 20 53 6f 66 74 77   meaning.  Softw
30a30 61 72 65 20 74 68 61 74 20 6c 69 6e 6b 73 20 61  are that links a
30a40 67 61 69 6e 73 74 20 62 6f 74 68 0a 2a 2a 20 53  gainst both.** S
30a50 51 4c 69 74 65 20 76 65 72 73 69 6f 6e 20 32 20  QLite version 2 
30a60 61 6e 64 20 53 51 4c 69 74 65 20 76 65 72 73 69  and SQLite versi
30a70 6f 6e 20 33 20 73 68 6f 75 6c 64 20 75 73 65 20  on 3 should use 
30a80 53 51 4c 49 54 45 33 5f 54 45 58 54 2c 20 6e 6f  SQLITE3_TEXT, no
30a90 74 0a 2a 2a 20 53 51 4c 49 54 45 5f 54 45 58 54  t.** SQLITE_TEXT
30aa0 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  ..*/.#define SQL
30ab0 49 54 45 5f 49 4e 54 45 47 45 52 20 20 31 0a 23  ITE_INTEGER  1.#
30ac0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 4c  define SQLITE_FL
30ad0 4f 41 54 20 20 20 20 32 0a 23 64 65 66 69 6e 65  OAT    2.#define
30ae0 20 53 51 4c 49 54 45 5f 42 4c 4f 42 20 20 20 20   SQLITE_BLOB    
30af0 20 34 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54   4.#define SQLIT
30b00 45 5f 4e 55 4c 4c 20 20 20 20 20 35 0a 23 69 66  E_NULL     5.#if
30b10 64 65 66 20 53 51 4c 49 54 45 5f 54 45 58 54 0a  def SQLITE_TEXT.
30b20 23 20 75 6e 64 65 66 20 53 51 4c 49 54 45 5f 54  # undef SQLITE_T
30b30 45 58 54 0a 23 65 6c 73 65 0a 23 20 64 65 66 69  EXT.#else.# defi
30b40 6e 65 20 53 51 4c 49 54 45 5f 54 45 58 54 20 20  ne SQLITE_TEXT  
30b50 20 20 20 33 0a 23 65 6e 64 69 66 0a 23 64 65 66     3.#endif.#def
30b60 69 6e 65 20 53 51 4c 49 54 45 33 5f 54 45 58 54  ine SQLITE3_TEXT
30b70 20 20 20 20 20 33 0a 0a 2f 2a 0a 2a 2a 20 43 41       3../*.** CA
30b80 50 49 33 52 45 46 3a 20 52 65 73 75 6c 74 20 56  PI3REF: Result V
30b90 61 6c 75 65 73 20 46 72 6f 6d 20 41 20 51 75 65  alues From A Que
30ba0 72 79 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20  ry.** KEYWORDS: 
30bb0 7b 63 6f 6c 75 6d 6e 20 61 63 63 65 73 73 20 66  {column access f
30bc0 75 6e 63 74 69 6f 6e 73 7d 0a 2a 2a 20 4d 45 54  unctions}.** MET
30bd0 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d  HOD: sqlite3_stm
30be0 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 73 65 20 72  t.**.** ^These r
30bf0 6f 75 74 69 6e 65 73 20 72 65 74 75 72 6e 20 69  outines return i
30c00 6e 66 6f 72 6d 61 74 69 6f 6e 20 61 62 6f 75 74  nformation about
30c10 20 61 20 73 69 6e 67 6c 65 20 63 6f 6c 75 6d 6e   a single column
30c20 20 6f 66 20 74 68 65 20 63 75 72 72 65 6e 74 0a   of the current.
30c30 2a 2a 20 72 65 73 75 6c 74 20 72 6f 77 20 6f 66  ** result row of
30c40 20 61 20 71 75 65 72 79 2e 20 20 5e 49 6e 20 65   a query.  ^In e
30c50 76 65 72 79 20 63 61 73 65 20 74 68 65 20 66 69  very case the fi
30c60 72 73 74 20 61 72 67 75 6d 65 6e 74 20 69 73 20  rst argument is 
30c70 61 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 74 6f 20  a pointer.** to 
30c80 74 68 65 20 5b 70 72 65 70 61 72 65 64 20 73 74  the [prepared st
30c90 61 74 65 6d 65 6e 74 5d 20 74 68 61 74 20 69 73  atement] that is
30ca0 20 62 65 69 6e 67 20 65 76 61 6c 75 61 74 65 64   being evaluated
30cb0 20 28 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 73   (the [sqlite3_s
30cc0 74 6d 74 2a 5d 0a 2a 2a 20 74 68 61 74 20 77 61  tmt*].** that wa
30cd0 73 20 72 65 74 75 72 6e 65 64 20 66 72 6f 6d 20  s returned from 
30ce0 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65  [sqlite3_prepare
30cf0 5f 76 32 28 29 5d 20 6f 72 20 6f 6e 65 20 6f 66  _v2()] or one of
30d00 20 69 74 73 20 76 61 72 69 61 6e 74 73 29 0a 2a   its variants).*
30d10 2a 20 61 6e 64 20 74 68 65 20 73 65 63 6f 6e 64  * and the second
30d20 20 61 72 67 75 6d 65 6e 74 20 69 73 20 74 68 65   argument is the
30d30 20 69 6e 64 65 78 20 6f 66 20 74 68 65 20 63 6f   index of the co
30d40 6c 75 6d 6e 20 66 6f 72 20 77 68 69 63 68 20 69  lumn for which i
30d50 6e 66 6f 72 6d 61 74 69 6f 6e 0a 2a 2a 20 73 68  nformation.** sh
30d60 6f 75 6c 64 20 62 65 20 72 65 74 75 72 6e 65 64  ould be returned
30d70 2e 20 5e 54 68 65 20 6c 65 66 74 6d 6f 73 74 20  . ^The leftmost 
30d80 63 6f 6c 75 6d 6e 20 6f 66 20 74 68 65 20 72 65  column of the re
30d90 73 75 6c 74 20 73 65 74 20 68 61 73 20 74 68 65  sult set has the
30da0 20 69 6e 64 65 78 20 30 2e 0a 2a 2a 20 5e 54 68   index 0..** ^Th
30db0 65 20 6e 75 6d 62 65 72 20 6f 66 20 63 6f 6c 75  e number of colu
30dc0 6d 6e 73 20 69 6e 20 74 68 65 20 72 65 73 75 6c  mns in the resul
30dd0 74 20 63 61 6e 20 62 65 20 64 65 74 65 72 6d 69  t can be determi
30de0 6e 65 64 20 75 73 69 6e 67 0a 2a 2a 20 5b 73 71  ned using.** [sq
30df0 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 63 6f 75  lite3_column_cou
30e00 6e 74 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 49 66 20  nt()]..**.** If 
30e10 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  the SQL statemen
30e20 74 20 64 6f 65 73 20 6e 6f 74 20 63 75 72 72 65  t does not curre
30e30 6e 74 6c 79 20 70 6f 69 6e 74 20 74 6f 20 61 20  ntly point to a 
30e40 76 61 6c 69 64 20 72 6f 77 2c 20 6f 72 20 69 66  valid row, or if
30e50 20 74 68 65 0a 2a 2a 20 63 6f 6c 75 6d 6e 20 69   the.** column i
30e60 6e 64 65 78 20 69 73 20 6f 75 74 20 6f 66 20 72  ndex is out of r
30e70 61 6e 67 65 2c 20 74 68 65 20 72 65 73 75 6c 74  ange, the result
30e80 20 69 73 20 75 6e 64 65 66 69 6e 65 64 2e 0a 2a   is undefined..*
30e90 2a 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73  * These routines
30ea0 20 6d 61 79 20 6f 6e 6c 79 20 62 65 20 63 61 6c   may only be cal
30eb0 6c 65 64 20 77 68 65 6e 20 74 68 65 20 6d 6f 73  led when the mos
30ec0 74 20 72 65 63 65 6e 74 20 63 61 6c 6c 20 74 6f  t recent call to
30ed0 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 73 74 65  .** [sqlite3_ste
30ee0 70 28 29 5d 20 68 61 73 20 72 65 74 75 72 6e 65  p()] has returne
30ef0 64 20 5b 53 51 4c 49 54 45 5f 52 4f 57 5d 20 61  d [SQLITE_ROW] a
30f00 6e 64 20 6e 65 69 74 68 65 72 0a 2a 2a 20 5b 73  nd neither.** [s
30f10 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20  qlite3_reset()] 
30f20 6e 6f 72 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e  nor [sqlite3_fin
30f30 61 6c 69 7a 65 28 29 5d 20 68 61 76 65 20 62 65  alize()] have be
30f40 65 6e 20 63 61 6c 6c 65 64 20 73 75 62 73 65 71  en called subseq
30f50 75 65 6e 74 6c 79 2e 0a 2a 2a 20 49 66 20 61 6e  uently..** If an
30f60 79 20 6f 66 20 74 68 65 73 65 20 72 6f 75 74 69  y of these routi
30f70 6e 65 73 20 61 72 65 20 63 61 6c 6c 65 64 20 61  nes are called a
30f80 66 74 65 72 20 5b 73 71 6c 69 74 65 33 5f 72 65  fter [sqlite3_re
30f90 73 65 74 28 29 5d 20 6f 72 0a 2a 2a 20 5b 73 71  set()] or.** [sq
30fa0 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28 29  lite3_finalize()
30fb0 5d 20 6f 72 20 61 66 74 65 72 20 5b 73 71 6c 69  ] or after [sqli
30fc0 74 65 33 5f 73 74 65 70 28 29 5d 20 68 61 73 20  te3_step()] has 
30fd0 72 65 74 75 72 6e 65 64 0a 2a 2a 20 73 6f 6d 65  returned.** some
30fe0 74 68 69 6e 67 20 6f 74 68 65 72 20 74 68 61 6e  thing other than
30ff0 20 5b 53 51 4c 49 54 45 5f 52 4f 57 5d 2c 20 74   [SQLITE_ROW], t
31000 68 65 20 72 65 73 75 6c 74 73 20 61 72 65 20 75  he results are u
31010 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a 20 49 66 20  ndefined..** If 
31020 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d  [sqlite3_step()]
31030 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f 72 65 73   or [sqlite3_res
31040 65 74 28 29 5d 20 6f 72 20 5b 73 71 6c 69 74 65  et()] or [sqlite
31050 33 5f 66 69 6e 61 6c 69 7a 65 28 29 5d 0a 2a 2a  3_finalize()].**
31060 20 61 72 65 20 63 61 6c 6c 65 64 20 66 72 6f 6d   are called from
31070 20 61 20 64 69 66 66 65 72 65 6e 74 20 74 68 72   a different thr
31080 65 61 64 20 77 68 69 6c 65 20 61 6e 79 20 6f 66  ead while any of
31090 20 74 68 65 73 65 20 72 6f 75 74 69 6e 65 73 0a   these routines.
310a0 2a 2a 20 61 72 65 20 70 65 6e 64 69 6e 67 2c 20  ** are pending, 
310b0 74 68 65 6e 20 74 68 65 20 72 65 73 75 6c 74 73  then the results
310c0 20 61 72 65 20 75 6e 64 65 66 69 6e 65 64 2e 0a   are undefined..
310d0 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  **.** ^The sqlit
310e0 65 33 5f 63 6f 6c 75 6d 6e 5f 74 79 70 65 28 29  e3_column_type()
310f0 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73   routine returns
31100 20 74 68 65 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f   the.** [SQLITE_
31110 49 4e 54 45 47 45 52 20 7c 20 64 61 74 61 74 79  INTEGER | dataty
31120 70 65 20 63 6f 64 65 5d 20 66 6f 72 20 74 68 65  pe code] for the
31130 20 69 6e 69 74 69 61 6c 20 64 61 74 61 20 74 79   initial data ty
31140 70 65 0a 2a 2a 20 6f 66 20 74 68 65 20 72 65 73  pe.** of the res
31150 75 6c 74 20 63 6f 6c 75 6d 6e 2e 20 20 5e 54 68  ult column.  ^Th
31160 65 20 72 65 74 75 72 6e 65 64 20 76 61 6c 75 65  e returned value
31170 20 69 73 20 6f 6e 65 20 6f 66 20 5b 53 51 4c 49   is one of [SQLI
31180 54 45 5f 49 4e 54 45 47 45 52 5d 2c 0a 2a 2a 20  TE_INTEGER],.** 
31190 5b 53 51 4c 49 54 45 5f 46 4c 4f 41 54 5d 2c 20  [SQLITE_FLOAT], 
311a0 5b 53 51 4c 49 54 45 5f 54 45 58 54 5d 2c 20 5b  [SQLITE_TEXT], [
311b0 53 51 4c 49 54 45 5f 42 4c 4f 42 5d 2c 20 6f 72  SQLITE_BLOB], or
311c0 20 5b 53 51 4c 49 54 45 5f 4e 55 4c 4c 5d 2e 20   [SQLITE_NULL]. 
311d0 20 54 68 65 20 76 61 6c 75 65 0a 2a 2a 20 72 65   The value.** re
311e0 74 75 72 6e 65 64 20 62 79 20 73 71 6c 69 74 65  turned by sqlite
311f0 33 5f 63 6f 6c 75 6d 6e 5f 74 79 70 65 28 29 20  3_column_type() 
31200 69 73 20 6f 6e 6c 79 20 6d 65 61 6e 69 6e 67 66  is only meaningf
31210 75 6c 20 69 66 20 6e 6f 20 74 79 70 65 0a 2a 2a  ul if no type.**
31220 20 63 6f 6e 76 65 72 73 69 6f 6e 73 20 68 61 76   conversions hav
31230 65 20 6f 63 63 75 72 72 65 64 20 61 73 20 64 65  e occurred as de
31240 73 63 72 69 62 65 64 20 62 65 6c 6f 77 2e 20 20  scribed below.  
31250 41 66 74 65 72 20 61 20 74 79 70 65 20 63 6f 6e  After a type con
31260 76 65 72 73 69 6f 6e 2c 0a 2a 2a 20 74 68 65 20  version,.** the 
31270 76 61 6c 75 65 20 72 65 74 75 72 6e 65 64 20 62  value returned b
31280 79 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  y sqlite3_column
31290 5f 74 79 70 65 28 29 20 69 73 20 75 6e 64 65 66  _type() is undef
312a0 69 6e 65 64 2e 20 20 46 75 74 75 72 65 0a 2a 2a  ined.  Future.**
312b0 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c   versions of SQL
312c0 69 74 65 20 6d 61 79 20 63 68 61 6e 67 65 20 74  ite may change t
312d0 68 65 20 62 65 68 61 76 69 6f 72 20 6f 66 20 73  he behavior of s
312e0 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 79  qlite3_column_ty
312f0 70 65 28 29 0a 2a 2a 20 66 6f 6c 6c 6f 77 69 6e  pe().** followin
31300 67 20 61 20 74 79 70 65 20 63 6f 6e 76 65 72 73  g a type convers
31310 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74  ion..**.** ^If t
31320 68 65 20 72 65 73 75 6c 74 20 69 73 20 61 20 42  he result is a B
31330 4c 4f 42 20 6f 72 20 55 54 46 2d 38 20 73 74 72  LOB or UTF-8 str
31340 69 6e 67 20 74 68 65 6e 20 74 68 65 20 73 71 6c  ing then the sql
31350 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65  ite3_column_byte
31360 73 28 29 0a 2a 2a 20 72 6f 75 74 69 6e 65 20 72  s().** routine r
31370 65 74 75 72 6e 73 20 74 68 65 20 6e 75 6d 62 65  eturns the numbe
31380 72 20 6f 66 20 62 79 74 65 73 20 69 6e 20 74 68  r of bytes in th
31390 61 74 20 42 4c 4f 42 20 6f 72 20 73 74 72 69 6e  at BLOB or strin
313a0 67 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 72 65  g..** ^If the re
313b0 73 75 6c 74 20 69 73 20 61 20 55 54 46 2d 31 36  sult is a UTF-16
313c0 20 73 74 72 69 6e 67 2c 20 74 68 65 6e 20 73 71   string, then sq
313d0 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74  lite3_column_byt
313e0 65 73 28 29 20 63 6f 6e 76 65 72 74 73 0a 2a 2a  es() converts.**
313f0 20 74 68 65 20 73 74 72 69 6e 67 20 74 6f 20 55   the string to U
31400 54 46 2d 38 20 61 6e 64 20 74 68 65 6e 20 72 65  TF-8 and then re
31410 74 75 72 6e 73 20 74 68 65 20 6e 75 6d 62 65 72  turns the number
31420 20 6f 66 20 62 79 74 65 73 2e 0a 2a 2a 20 5e 49   of bytes..** ^I
31430 66 20 74 68 65 20 72 65 73 75 6c 74 20 69 73 20  f the result is 
31440 61 20 6e 75 6d 65 72 69 63 20 76 61 6c 75 65 20  a numeric value 
31450 74 68 65 6e 20 73 71 6c 69 74 65 33 5f 63 6f 6c  then sqlite3_col
31460 75 6d 6e 5f 62 79 74 65 73 28 29 20 75 73 65 73  umn_bytes() uses
31470 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 73 6e 70  .** [sqlite3_snp
31480 72 69 6e 74 66 28 29 5d 20 74 6f 20 63 6f 6e 76  rintf()] to conv
31490 65 72 74 20 74 68 61 74 20 76 61 6c 75 65 20 74  ert that value t
314a0 6f 20 61 20 55 54 46 2d 38 20 73 74 72 69 6e 67  o a UTF-8 string
314b0 20 61 6e 64 20 72 65 74 75 72 6e 73 0a 2a 2a 20   and returns.** 
314c0 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 62 79  the number of by
314d0 74 65 73 20 69 6e 20 74 68 61 74 20 73 74 72 69  tes in that stri
314e0 6e 67 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 72  ng..** ^If the r
314f0 65 73 75 6c 74 20 69 73 20 4e 55 4c 4c 2c 20 74  esult is NULL, t
31500 68 65 6e 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75  hen sqlite3_colu
31510 6d 6e 5f 62 79 74 65 73 28 29 20 72 65 74 75 72  mn_bytes() retur
31520 6e 73 20 7a 65 72 6f 2e 0a 2a 2a 0a 2a 2a 20 5e  ns zero..**.** ^
31530 49 66 20 74 68 65 20 72 65 73 75 6c 74 20 69 73  If the result is
31540 20 61 20 42 4c 4f 42 20 6f 72 20 55 54 46 2d 31   a BLOB or UTF-1
31550 36 20 73 74 72 69 6e 67 20 74 68 65 6e 20 74 68  6 string then th
31560 65 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  e sqlite3_column
31570 5f 62 79 74 65 73 31 36 28 29 0a 2a 2a 20 72 6f  _bytes16().** ro
31580 75 74 69 6e 65 20 72 65 74 75 72 6e 73 20 74 68  utine returns th
31590 65 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65  e number of byte
315a0 73 20 69 6e 20 74 68 61 74 20 42 4c 4f 42 20 6f  s in that BLOB o
315b0 72 20 73 74 72 69 6e 67 2e 0a 2a 2a 20 5e 49 66  r string..** ^If
315c0 20 74 68 65 20 72 65 73 75 6c 74 20 69 73 20 61   the result is a
315d0 20 55 54 46 2d 38 20 73 74 72 69 6e 67 2c 20 74   UTF-8 string, t
315e0 68 65 6e 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75  hen sqlite3_colu
315f0 6d 6e 5f 62 79 74 65 73 31 36 28 29 20 63 6f 6e  mn_bytes16() con
31600 76 65 72 74 73 0a 2a 2a 20 74 68 65 20 73 74 72  verts.** the str
31610 69 6e 67 20 74 6f 20 55 54 46 2d 31 36 20 61 6e  ing to UTF-16 an
31620 64 20 74 68 65 6e 20 72 65 74 75 72 6e 73 20 74  d then returns t
31630 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74  he number of byt
31640 65 73 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 72  es..** ^If the r
31650 65 73 75 6c 74 20 69 73 20 61 20 6e 75 6d 65 72  esult is a numer
31660 69 63 20 76 61 6c 75 65 20 74 68 65 6e 20 73 71  ic value then sq
31670 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74  lite3_column_byt
31680 65 73 31 36 28 29 20 75 73 65 73 0a 2a 2a 20 5b  es16() uses.** [
31690 73 71 6c 69 74 65 33 5f 73 6e 70 72 69 6e 74 66  sqlite3_snprintf
316a0 28 29 5d 20 74 6f 20 63 6f 6e 76 65 72 74 20 74  ()] to convert t
316b0 68 61 74 20 76 61 6c 75 65 20 74 6f 20 61 20 55  hat value to a U
316c0 54 46 2d 31 36 20 73 74 72 69 6e 67 20 61 6e 64  TF-16 string and
316d0 20 72 65 74 75 72 6e 73 0a 2a 2a 20 74 68 65 20   returns.** the 
316e0 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73 20  number of bytes 
316f0 69 6e 20 74 68 61 74 20 73 74 72 69 6e 67 2e 0a  in that string..
31700 2a 2a 20 5e 49 66 20 74 68 65 20 72 65 73 75 6c  ** ^If the resul
31710 74 20 69 73 20 4e 55 4c 4c 2c 20 74 68 65 6e 20  t is NULL, then 
31720 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62  sqlite3_column_b
31730 79 74 65 73 31 36 28 29 20 72 65 74 75 72 6e 73  ytes16() returns
31740 20 7a 65 72 6f 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68   zero..**.** ^Th
31750 65 20 76 61 6c 75 65 73 20 72 65 74 75 72 6e 65  e values returne
31760 64 20 62 79 20 5b 73 71 6c 69 74 65 33 5f 63 6f  d by [sqlite3_co
31770 6c 75 6d 6e 5f 62 79 74 65 73 28 29 5d 20 61 6e  lumn_bytes()] an
31780 64 20 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63  d .** [sqlite3_c
31790 6f 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28 29 5d  olumn_bytes16()]
317a0 20 64 6f 20 6e 6f 74 20 69 6e 63 6c 75 64 65 20   do not include 
317b0 74 68 65 20 7a 65 72 6f 20 74 65 72 6d 69 6e 61  the zero termina
317c0 74 6f 72 73 20 61 74 20 74 68 65 20 65 6e 64 0a  tors at the end.
317d0 2a 2a 20 6f 66 20 74 68 65 20 73 74 72 69 6e 67  ** of the string
317e0 2e 20 20 5e 46 6f 72 20 63 6c 61 72 69 74 79 3a  .  ^For clarity:
317f0 20 74 68 65 20 76 61 6c 75 65 73 20 72 65 74 75   the values retu
31800 72 6e 65 64 20 62 79 0a 2a 2a 20 5b 73 71 6c 69  rned by.** [sqli
31810 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73  te3_column_bytes
31820 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 33  ()] and [sqlite3
31830 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28  _column_bytes16(
31840 29 5d 20 61 72 65 20 74 68 65 20 6e 75 6d 62 65  )] are the numbe
31850 72 20 6f 66 0a 2a 2a 20 62 79 74 65 73 20 69 6e  r of.** bytes in
31860 20 74 68 65 20 73 74 72 69 6e 67 2c 20 6e 6f 74   the string, not
31870 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 63   the number of c
31880 68 61 72 61 63 74 65 72 73 2e 0a 2a 2a 0a 2a 2a  haracters..**.**
31890 20 5e 53 74 72 69 6e 67 73 20 72 65 74 75 72 6e   ^Strings return
318a0 65 64 20 62 79 20 73 71 6c 69 74 65 33 5f 63 6f  ed by sqlite3_co
318b0 6c 75 6d 6e 5f 74 65 78 74 28 29 20 61 6e 64 20  lumn_text() and 
318c0 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74  sqlite3_column_t
318d0 65 78 74 31 36 28 29 2c 0a 2a 2a 20 65 76 65 6e  ext16(),.** even
318e0 20 65 6d 70 74 79 20 73 74 72 69 6e 67 73 2c 20   empty strings, 
318f0 61 72 65 20 61 6c 77 61 79 73 20 7a 65 72 6f 2d  are always zero-
31900 74 65 72 6d 69 6e 61 74 65 64 2e 20 20 5e 54 68  terminated.  ^Th
31910 65 20 72 65 74 75 72 6e 0a 2a 2a 20 76 61 6c 75  e return.** valu
31920 65 20 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f 63  e from sqlite3_c
31930 6f 6c 75 6d 6e 5f 62 6c 6f 62 28 29 20 66 6f 72  olumn_blob() for
31940 20 61 20 7a 65 72 6f 2d 6c 65 6e 67 74 68 20 42   a zero-length B
31950 4c 4f 42 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f  LOB is a NULL po
31960 69 6e 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 3c 62 3e  inter..**.** <b>
31970 57 61 72 6e 69 6e 67 3a 3c 2f 62 3e 20 5e 54 68  Warning:</b> ^Th
31980 65 20 6f 62 6a 65 63 74 20 72 65 74 75 72 6e 65  e object returne
31990 64 20 62 79 20 5b 73 71 6c 69 74 65 33 5f 63 6f  d by [sqlite3_co
319a0 6c 75 6d 6e 5f 76 61 6c 75 65 28 29 5d 20 69 73  lumn_value()] is
319b0 20 61 6e 0a 2a 2a 20 5b 75 6e 70 72 6f 74 65 63   an.** [unprotec
319c0 74 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75  ted sqlite3_valu
319d0 65 5d 20 6f 62 6a 65 63 74 2e 20 20 49 6e 20 61  e] object.  In a
319e0 20 6d 75 6c 74 69 74 68 72 65 61 64 65 64 20 65   multithreaded e
319f0 6e 76 69 72 6f 6e 6d 65 6e 74 2c 0a 2a 2a 20 61  nvironment,.** a
31a00 6e 20 75 6e 70 72 6f 74 65 63 74 65 64 20 73 71  n unprotected sq
31a10 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65  lite3_value obje
31a20 63 74 20 6d 61 79 20 6f 6e 6c 79 20 62 65 20 75  ct may only be u
31a30 73 65 64 20 73 61 66 65 6c 79 20 77 69 74 68 0a  sed safely with.
31a40 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64  ** [sqlite3_bind
31a50 5f 76 61 6c 75 65 28 29 5d 20 61 6e 64 20 5b 73  _value()] and [s
31a60 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 76 61  qlite3_result_va
31a70 6c 75 65 28 29 5d 2e 0a 2a 2a 20 49 66 20 74 68  lue()]..** If th
31a80 65 20 5b 75 6e 70 72 6f 74 65 63 74 65 64 20 73  e [unprotected s
31a90 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62  qlite3_value] ob
31aa0 6a 65 63 74 20 72 65 74 75 72 6e 65 64 20 62 79  ject returned by
31ab0 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c  .** [sqlite3_col
31ac0 75 6d 6e 5f 76 61 6c 75 65 28 29 5d 20 69 73 20  umn_value()] is 
31ad0 75 73 65 64 20 69 6e 20 61 6e 79 20 6f 74 68 65  used in any othe
31ae0 72 20 77 61 79 2c 20 69 6e 63 6c 75 64 69 6e 67  r way, including
31af0 20 63 61 6c 6c 73 0a 2a 2a 20 74 6f 20 72 6f 75   calls.** to rou
31b00 74 69 6e 65 73 20 6c 69 6b 65 20 5b 73 71 6c 69  tines like [sqli
31b10 74 65 33 5f 76 61 6c 75 65 5f 69 6e 74 28 29 5d  te3_value_int()]
31b20 2c 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  , [sqlite3_value
31b30 5f 74 65 78 74 28 29 5d 2c 0a 2a 2a 20 6f 72 20  _text()],.** or 
31b40 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 62  [sqlite3_value_b
31b50 79 74 65 73 28 29 5d 2c 20 74 68 65 20 62 65 68  ytes()], the beh
31b60 61 76 69 6f 72 20 69 73 20 6e 6f 74 20 74 68 72  avior is not thr
31b70 65 61 64 73 61 66 65 2e 0a 2a 2a 0a 2a 2a 20 54  eadsafe..**.** T
31b80 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 61 74  hese routines at
31b90 74 65 6d 70 74 20 74 6f 20 63 6f 6e 76 65 72 74  tempt to convert
31ba0 20 74 68 65 20 76 61 6c 75 65 20 77 68 65 72 65   the value where
31bb0 20 61 70 70 72 6f 70 72 69 61 74 65 2e 20 20 5e   appropriate.  ^
31bc0 46 6f 72 0a 2a 2a 20 65 78 61 6d 70 6c 65 2c 20  For.** example, 
31bd0 69 66 20 74 68 65 20 69 6e 74 65 72 6e 61 6c 20  if the internal 
31be0 72 65 70 72 65 73 65 6e 74 61 74 69 6f 6e 20 69  representation i
31bf0 73 20 46 4c 4f 41 54 20 61 6e 64 20 61 20 74 65  s FLOAT and a te
31c00 78 74 20 72 65 73 75 6c 74 0a 2a 2a 20 69 73 20  xt result.** is 
31c10 72 65 71 75 65 73 74 65 64 2c 20 5b 73 71 6c 69  requested, [sqli
31c20 74 65 33 5f 73 6e 70 72 69 6e 74 66 28 29 5d 20  te3_snprintf()] 
31c30 69 73 20 75 73 65 64 20 69 6e 74 65 72 6e 61 6c  is used internal
31c40 6c 79 20 74 6f 20 70 65 72 66 6f 72 6d 20 74 68  ly to perform th
31c50 65 0a 2a 2a 20 63 6f 6e 76 65 72 73 69 6f 6e 20  e.** conversion 
31c60 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 2e 20 20  automatically.  
31c70 5e 28 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20  ^(The following 
31c80 74 61 62 6c 65 20 64 65 74 61 69 6c 73 20 74 68  table details th
31c90 65 20 63 6f 6e 76 65 72 73 69 6f 6e 73 0a 2a 2a  e conversions.**
31ca0 20 74 68 61 74 20 61 72 65 20 61 70 70 6c 69 65   that are applie
31cb0 64 3a 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71  d:.**.** <blockq
31cc0 75 6f 74 65 3e 0a 2a 2a 20 3c 74 61 62 6c 65 20  uote>.** <table 
31cd0 62 6f 72 64 65 72 3d 22 31 22 3e 0a 2a 2a 20 3c  border="1">.** <
31ce0 74 72 3e 3c 74 68 3e 20 49 6e 74 65 72 6e 61 6c  tr><th> Internal
31cf0 3c 62 72 3e 54 79 70 65 20 3c 74 68 3e 20 52 65  <br>Type <th> Re
31d00 71 75 65 73 74 65 64 3c 62 72 3e 54 79 70 65 20  quested<br>Type 
31d10 3c 74 68 3e 20 20 43 6f 6e 76 65 72 73 69 6f 6e  <th>  Conversion
31d20 0a 2a 2a 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20  .**.** <tr><td> 
31d30 20 4e 55 4c 4c 20 20 20 20 3c 74 64 3e 20 49 4e   NULL    <td> IN
31d40 54 45 47 45 52 20 20 20 3c 74 64 3e 20 52 65 73  TEGER   <td> Res
31d50 75 6c 74 20 69 73 20 30 0a 2a 2a 20 3c 74 72 3e  ult is 0.** <tr>
31d60 3c 74 64 3e 20 20 4e 55 4c 4c 20 20 20 20 3c 74  <td>  NULL    <t
31d70 64 3e 20 20 46 4c 4f 41 54 20 20 20 20 3c 74 64  d>  FLOAT    <td
31d80 3e 20 52 65 73 75 6c 74 20 69 73 20 30 2e 30 0a  > Result is 0.0.
31d90 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 4e 55 4c  ** <tr><td>  NUL
31da0 4c 20 20 20 20 3c 74 64 3e 20 20 20 54 45 58 54  L    <td>   TEXT
31db0 20 20 20 20 3c 74 64 3e 20 52 65 73 75 6c 74 20      <td> Result 
31dc0 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  is a NULL pointe
31dd0 72 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 4e  r.** <tr><td>  N
31de0 55 4c 4c 20 20 20 20 3c 74 64 3e 20 20 20 42 4c  ULL    <td>   BL
31df0 4f 42 20 20 20 20 3c 74 64 3e 20 52 65 73 75 6c  OB    <td> Resul
31e00 74 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e  t is a NULL poin
31e10 74 65 72 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20  ter.** <tr><td> 
31e20 49 4e 54 45 47 45 52 20 20 3c 74 64 3e 20 20 46  INTEGER  <td>  F
31e30 4c 4f 41 54 20 20 20 20 3c 74 64 3e 20 43 6f 6e  LOAT    <td> Con
31e40 76 65 72 74 20 66 72 6f 6d 20 69 6e 74 65 67 65  vert from intege
31e50 72 20 74 6f 20 66 6c 6f 61 74 0a 2a 2a 20 3c 74  r to float.** <t
31e60 72 3e 3c 74 64 3e 20 49 4e 54 45 47 45 52 20 20  r><td> INTEGER  
31e70 3c 74 64 3e 20 20 20 54 45 58 54 20 20 20 20 3c  <td>   TEXT    <
31e80 74 64 3e 20 41 53 43 49 49 20 72 65 6e 64 65 72  td> ASCII render
31e90 69 6e 67 20 6f 66 20 74 68 65 20 69 6e 74 65 67  ing of the integ
31ea0 65 72 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 49  er.** <tr><td> I
31eb0 4e 54 45 47 45 52 20 20 3c 74 64 3e 20 20 20 42  NTEGER  <td>   B
31ec0 4c 4f 42 20 20 20 20 3c 74 64 3e 20 53 61 6d 65  LOB    <td> Same
31ed0 20 61 73 20 49 4e 54 45 47 45 52 2d 3e 54 45 58   as INTEGER->TEX
31ee0 54 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 46  T.** <tr><td>  F
31ef0 4c 4f 41 54 20 20 20 3c 74 64 3e 20 49 4e 54 45  LOAT   <td> INTE
31f00 47 45 52 20 20 20 3c 74 64 3e 20 5b 43 41 53 54  GER   <td> [CAST
31f10 5d 20 74 6f 20 49 4e 54 45 47 45 52 0a 2a 2a 20  ] to INTEGER.** 
31f20 3c 74 72 3e 3c 74 64 3e 20 20 46 4c 4f 41 54 20  <tr><td>  FLOAT 
31f30 20 20 3c 74 64 3e 20 20 20 54 45 58 54 20 20 20    <td>   TEXT   
31f40 20 3c 74 64 3e 20 41 53 43 49 49 20 72 65 6e 64   <td> ASCII rend
31f50 65 72 69 6e 67 20 6f 66 20 74 68 65 20 66 6c 6f  ering of the flo
31f60 61 74 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20  at.** <tr><td>  
31f70 46 4c 4f 41 54 20 20 20 3c 74 64 3e 20 20 20 42  FLOAT   <td>   B
31f80 4c 4f 42 20 20 20 20 3c 74 64 3e 20 5b 43 41 53  LOB    <td> [CAS
31f90 54 5d 20 74 6f 20 42 4c 4f 42 0a 2a 2a 20 3c 74  T] to BLOB.** <t
31fa0 72 3e 3c 74 64 3e 20 20 54 45 58 54 20 20 20 20  r><td>  TEXT    
31fb0 3c 74 64 3e 20 49 4e 54 45 47 45 52 20 20 20 3c  <td> INTEGER   <
31fc0 74 64 3e 20 5b 43 41 53 54 5d 20 74 6f 20 49 4e  td> [CAST] to IN
31fd0 54 45 47 45 52 0a 2a 2a 20 3c 74 72 3e 3c 74 64  TEGER.** <tr><td
31fe0 3e 20 20 54 45 58 54 20 20 20 20 3c 74 64 3e 20  >  TEXT    <td> 
31ff0 20 46 4c 4f 41 54 20 20 20 20 3c 74 64 3e 20 5b   FLOAT    <td> [
32000 43 41 53 54 5d 20 74 6f 20 52 45 41 4c 0a 2a 2a  CAST] to REAL.**
32010 20 3c 74 72 3e 3c 74 64 3e 20 20 54 45 58 54 20   <tr><td>  TEXT 
32020 20 20 20 3c 74 64 3e 20 20 20 42 4c 4f 42 20 20     <td>   BLOB  
32030 20 20 3c 74 64 3e 20 4e 6f 20 63 68 61 6e 67 65    <td> No change
32040 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 42 4c  .** <tr><td>  BL
32050 4f 42 20 20 20 20 3c 74 64 3e 20 49 4e 54 45 47  OB    <td> INTEG
32060 45 52 20 20 20 3c 74 64 3e 20 5b 43 41 53 54 5d  ER   <td> [CAST]
32070 20 74 6f 20 49 4e 54 45 47 45 52 0a 2a 2a 20 3c   to INTEGER.** <
32080 74 72 3e 3c 74 64 3e 20 20 42 4c 4f 42 20 20 20  tr><td>  BLOB   
32090 20 3c 74 64 3e 20 20 46 4c 4f 41 54 20 20 20 20   <td>  FLOAT    
320a0 3c 74 64 3e 20 5b 43 41 53 54 5d 20 74 6f 20 52  <td> [CAST] to R
320b0 45 41 4c 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20  EAL.** <tr><td> 
320c0 20 42 4c 4f 42 20 20 20 20 3c 74 64 3e 20 20 20   BLOB    <td>   
320d0 54 45 58 54 20 20 20 20 3c 74 64 3e 20 41 64 64  TEXT    <td> Add
320e0 20 61 20 7a 65 72 6f 20 74 65 72 6d 69 6e 61 74   a zero terminat
320f0 6f 72 20 69 66 20 6e 65 65 64 65 64 0a 2a 2a 20  or if needed.** 
32100 3c 2f 74 61 62 6c 65 3e 0a 2a 2a 20 3c 2f 62 6c  </table>.** </bl
32110 6f 63 6b 71 75 6f 74 65 3e 29 5e 0a 2a 2a 0a 2a  ockquote>)^.**.*
32120 2a 20 4e 6f 74 65 20 74 68 61 74 20 77 68 65 6e  * Note that when
32130 20 74 79 70 65 20 63 6f 6e 76 65 72 73 69 6f 6e   type conversion
32140 73 20 6f 63 63 75 72 2c 20 70 6f 69 6e 74 65 72  s occur, pointer
32150 73 20 72 65 74 75 72 6e 65 64 20 62 79 20 70 72  s returned by pr
32160 69 6f 72 0a 2a 2a 20 63 61 6c 6c 73 20 74 6f 20  ior.** calls to 
32170 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62  sqlite3_column_b
32180 6c 6f 62 28 29 2c 20 73 71 6c 69 74 65 33 5f 63  lob(), sqlite3_c
32190 6f 6c 75 6d 6e 5f 74 65 78 74 28 29 2c 20 61 6e  olumn_text(), an
321a0 64 2f 6f 72 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  d/or.** sqlite3_
321b0 63 6f 6c 75 6d 6e 5f 74 65 78 74 31 36 28 29 20  column_text16() 
321c0 6d 61 79 20 62 65 20 69 6e 76 61 6c 69 64 61 74  may be invalidat
321d0 65 64 2e 0a 2a 2a 20 54 79 70 65 20 63 6f 6e 76  ed..** Type conv
321e0 65 72 73 69 6f 6e 73 20 61 6e 64 20 70 6f 69 6e  ersions and poin
321f0 74 65 72 20 69 6e 76 61 6c 69 64 61 74 69 6f 6e  ter invalidation
32200 73 20 6d 69 67 68 74 20 6f 63 63 75 72 0a 2a 2a  s might occur.**
32210 20 69 6e 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e   in the followin
32220 67 20 63 61 73 65 73 3a 0a 2a 2a 0a 2a 2a 20 3c  g cases:.**.** <
32230 75 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20 54 68 65 20  ul>.** <li> The 
32240 69 6e 69 74 69 61 6c 20 63 6f 6e 74 65 6e 74 20  initial content 
32250 69 73 20 61 20 42 4c 4f 42 20 61 6e 64 20 73 71  is a BLOB and sq
32260 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78  lite3_column_tex
32270 74 28 29 20 6f 72 0a 2a 2a 20 20 20 20 20 20 73  t() or.**      s
32280 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65  qlite3_column_te
32290 78 74 31 36 28 29 20 69 73 20 63 61 6c 6c 65 64  xt16() is called
322a0 2e 20 20 41 20 7a 65 72 6f 2d 74 65 72 6d 69 6e  .  A zero-termin
322b0 61 74 6f 72 20 6d 69 67 68 74 0a 2a 2a 20 20 20  ator might.**   
322c0 20 20 20 6e 65 65 64 20 74 6f 20 62 65 20 61 64     need to be ad
322d0 64 65 64 20 74 6f 20 74 68 65 20 73 74 72 69 6e  ded to the strin
322e0 67 2e 3c 2f 6c 69 3e 0a 2a 2a 20 3c 6c 69 3e 20  g.</li>.** <li> 
322f0 54 68 65 20 69 6e 69 74 69 61 6c 20 63 6f 6e 74  The initial cont
32300 65 6e 74 20 69 73 20 55 54 46 2d 38 20 74 65 78  ent is UTF-8 tex
32310 74 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 63 6f  t and sqlite3_co
32320 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28 29 20 6f  lumn_bytes16() o
32330 72 0a 2a 2a 20 20 20 20 20 20 73 71 6c 69 74 65  r.**      sqlite
32340 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 31 36 28  3_column_text16(
32350 29 20 69 73 20 63 61 6c 6c 65 64 2e 20 20 54 68  ) is called.  Th
32360 65 20 63 6f 6e 74 65 6e 74 20 6d 75 73 74 20 62  e content must b
32370 65 20 63 6f 6e 76 65 72 74 65 64 0a 2a 2a 20 20  e converted.**  
32380 20 20 20 20 74 6f 20 55 54 46 2d 31 36 2e 3c 2f      to UTF-16.</
32390 6c 69 3e 0a 2a 2a 20 3c 6c 69 3e 20 54 68 65 20  li>.** <li> The 
323a0 69 6e 69 74 69 61 6c 20 63 6f 6e 74 65 6e 74 20  initial content 
323b0 69 73 20 55 54 46 2d 31 36 20 74 65 78 74 20 61  is UTF-16 text a
323c0 6e 64 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  nd sqlite3_colum
323d0 6e 5f 62 79 74 65 73 28 29 20 6f 72 0a 2a 2a 20  n_bytes() or.** 
323e0 20 20 20 20 20 73 71 6c 69 74 65 33 5f 63 6f 6c       sqlite3_col
323f0 75 6d 6e 5f 74 65 78 74 28 29 20 69 73 20 63 61  umn_text() is ca
32400 6c 6c 65 64 2e 20 20 54 68 65 20 63 6f 6e 74 65  lled.  The conte
32410 6e 74 20 6d 75 73 74 20 62 65 20 63 6f 6e 76 65  nt must be conve
32420 72 74 65 64 0a 2a 2a 20 20 20 20 20 20 74 6f 20  rted.**      to 
32430 55 54 46 2d 38 2e 3c 2f 6c 69 3e 0a 2a 2a 20 3c  UTF-8.</li>.** <
32440 2f 75 6c 3e 0a 2a 2a 0a 2a 2a 20 5e 43 6f 6e 76  /ul>.**.** ^Conv
32450 65 72 73 69 6f 6e 73 20 62 65 74 77 65 65 6e 20  ersions between 
32460 55 54 46 2d 31 36 62 65 20 61 6e 64 20 55 54 46  UTF-16be and UTF
32470 2d 31 36 6c 65 20 61 72 65 20 61 6c 77 61 79 73  -16le are always
32480 20 64 6f 6e 65 20 69 6e 20 70 6c 61 63 65 20 61   done in place a
32490 6e 64 20 64 6f 0a 2a 2a 20 6e 6f 74 20 69 6e 76  nd do.** not inv
324a0 61 6c 69 64 61 74 65 20 61 20 70 72 69 6f 72 20  alidate a prior 
324b0 70 6f 69 6e 74 65 72 2c 20 74 68 6f 75 67 68 20  pointer, though 
324c0 6f 66 20 63 6f 75 72 73 65 20 74 68 65 20 63 6f  of course the co
324d0 6e 74 65 6e 74 20 6f 66 20 74 68 65 20 62 75 66  ntent of the buf
324e0 66 65 72 0a 2a 2a 20 74 68 61 74 20 74 68 65 20  fer.** that the 
324f0 70 72 69 6f 72 20 70 6f 69 6e 74 65 72 20 72 65  prior pointer re
32500 66 65 72 65 6e 63 65 73 20 77 69 6c 6c 20 68 61  ferences will ha
32510 76 65 20 62 65 65 6e 20 6d 6f 64 69 66 69 65 64  ve been modified
32520 2e 20 20 4f 74 68 65 72 20 6b 69 6e 64 73 0a 2a  .  Other kinds.*
32530 2a 20 6f 66 20 63 6f 6e 76 65 72 73 69 6f 6e 20  * of conversion 
32540 61 72 65 20 64 6f 6e 65 20 69 6e 20 70 6c 61 63  are done in plac
32550 65 20 77 68 65 6e 20 69 74 20 69 73 20 70 6f 73  e when it is pos
32560 73 69 62 6c 65 2c 20 62 75 74 20 73 6f 6d 65 74  sible, but somet
32570 69 6d 65 73 20 74 68 65 79 0a 2a 2a 20 61 72 65  imes they.** are
32580 20 6e 6f 74 20 70 6f 73 73 69 62 6c 65 20 61 6e   not possible an
32590 64 20 69 6e 20 74 68 6f 73 65 20 63 61 73 65 73  d in those cases
325a0 20 70 72 69 6f 72 20 70 6f 69 6e 74 65 72 73 20   prior pointers 
325b0 61 72 65 20 69 6e 76 61 6c 69 64 61 74 65 64 2e  are invalidated.
325c0 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 61 66 65 73  .**.** The safes
325d0 74 20 70 6f 6c 69 63 79 20 69 73 20 74 6f 20 69  t policy is to i
325e0 6e 76 6f 6b 65 20 74 68 65 73 65 20 72 6f 75 74  nvoke these rout
325f0 69 6e 65 73 0a 2a 2a 20 69 6e 20 6f 6e 65 20 6f  ines.** in one o
32600 66 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20  f the following 
32610 77 61 79 73 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e  ways:.**.** <ul>
32620 0a 2a 2a 20 20 3c 6c 69 3e 73 71 6c 69 74 65 33  .**  <li>sqlite3
32630 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 29 20 66  _column_text() f
32640 6f 6c 6c 6f 77 65 64 20 62 79 20 73 71 6c 69 74  ollowed by sqlit
32650 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28  e3_column_bytes(
32660 29 3c 2f 6c 69 3e 0a 2a 2a 20 20 3c 6c 69 3e 73  )</li>.**  <li>s
32670 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 6c  qlite3_column_bl
32680 6f 62 28 29 20 66 6f 6c 6c 6f 77 65 64 20 62 79  ob() followed by
32690 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
326a0 62 79 74 65 73 28 29 3c 2f 6c 69 3e 0a 2a 2a 20  bytes()</li>.** 
326b0 20 3c 6c 69 3e 73 71 6c 69 74 65 33 5f 63 6f 6c   <li>sqlite3_col
326c0 75 6d 6e 5f 74 65 78 74 31 36 28 29 20 66 6f 6c  umn_text16() fol
326d0 6c 6f 77 65 64 20 62 79 20 73 71 6c 69 74 65 33  lowed by sqlite3
326e0 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28  _column_bytes16(
326f0 29 3c 2f 6c 69 3e 0a 2a 2a 20 3c 2f 75 6c 3e 0a  )</li>.** </ul>.
32700 2a 2a 0a 2a 2a 20 49 6e 20 6f 74 68 65 72 20 77  **.** In other w
32710 6f 72 64 73 2c 20 79 6f 75 20 73 68 6f 75 6c 64  ords, you should
32720 20 63 61 6c 6c 20 73 71 6c 69 74 65 33 5f 63 6f   call sqlite3_co
32730 6c 75 6d 6e 5f 74 65 78 74 28 29 2c 0a 2a 2a 20  lumn_text(),.** 
32740 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62  sqlite3_column_b
32750 6c 6f 62 28 29 2c 20 6f 72 20 73 71 6c 69 74 65  lob(), or sqlite
32760 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 31 36 28  3_column_text16(
32770 29 20 66 69 72 73 74 20 74 6f 20 66 6f 72 63 65  ) first to force
32780 20 74 68 65 20 72 65 73 75 6c 74 0a 2a 2a 20 69   the result.** i
32790 6e 74 6f 20 74 68 65 20 64 65 73 69 72 65 64 20  nto the desired 
327a0 66 6f 72 6d 61 74 2c 20 74 68 65 6e 20 69 6e 76  format, then inv
327b0 6f 6b 65 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75  oke sqlite3_colu
327c0 6d 6e 5f 62 79 74 65 73 28 29 20 6f 72 0a 2a 2a  mn_bytes() or.**
327d0 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
327e0 62 79 74 65 73 31 36 28 29 20 74 6f 20 66 69 6e  bytes16() to fin
327f0 64 20 74 68 65 20 73 69 7a 65 20 6f 66 20 74 68  d the size of th
32800 65 20 72 65 73 75 6c 74 2e 20 20 44 6f 20 6e 6f  e result.  Do no
32810 74 20 6d 69 78 20 63 61 6c 6c 73 0a 2a 2a 20 74  t mix calls.** t
32820 6f 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  o sqlite3_column
32830 5f 74 65 78 74 28 29 20 6f 72 20 73 71 6c 69 74  _text() or sqlit
32840 65 33 5f 63 6f 6c 75 6d 6e 5f 62 6c 6f 62 28 29  e3_column_blob()
32850 20 77 69 74 68 20 63 61 6c 6c 73 20 74 6f 0a 2a   with calls to.*
32860 2a 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  * sqlite3_column
32870 5f 62 79 74 65 73 31 36 28 29 2c 20 61 6e 64 20  _bytes16(), and 
32880 64 6f 20 6e 6f 74 20 6d 69 78 20 63 61 6c 6c 73  do not mix calls
32890 20 74 6f 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75   to sqlite3_colu
328a0 6d 6e 5f 74 65 78 74 31 36 28 29 0a 2a 2a 20 77  mn_text16().** w
328b0 69 74 68 20 63 61 6c 6c 73 20 74 6f 20 73 71 6c  ith calls to sql
328c0 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65  ite3_column_byte
328d0 73 28 29 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  s()..**.** ^The 
328e0 70 6f 69 6e 74 65 72 73 20 72 65 74 75 72 6e 65  pointers returne
328f0 64 20 61 72 65 20 76 61 6c 69 64 20 75 6e 74 69  d are valid unti
32900 6c 20 61 20 74 79 70 65 20 63 6f 6e 76 65 72 73  l a type convers
32910 69 6f 6e 20 6f 63 63 75 72 73 20 61 73 0a 2a 2a  ion occurs as.**
32920 20 64 65 73 63 72 69 62 65 64 20 61 62 6f 76 65   described above
32930 2c 20 6f 72 20 75 6e 74 69 6c 20 5b 73 71 6c 69  , or until [sqli
32940 74 65 33 5f 73 74 65 70 28 29 5d 20 6f 72 20 5b  te3_step()] or [
32950 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d  sqlite3_reset()]
32960 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f   or.** [sqlite3_
32970 66 69 6e 61 6c 69 7a 65 28 29 5d 20 69 73 20 63  finalize()] is c
32980 61 6c 6c 65 64 2e 20 20 5e 54 68 65 20 6d 65 6d  alled.  ^The mem
32990 6f 72 79 20 73 70 61 63 65 20 75 73 65 64 20 74  ory space used t
329a0 6f 20 68 6f 6c 64 20 73 74 72 69 6e 67 73 0a 2a  o hold strings.*
329b0 2a 20 61 6e 64 20 42 4c 4f 42 73 20 69 73 20 66  * and BLOBs is f
329c0 72 65 65 64 20 61 75 74 6f 6d 61 74 69 63 61 6c  reed automatical
329d0 6c 79 2e 20 20 44 6f 20 3c 65 6d 3e 6e 6f 74 3c  ly.  Do <em>not<
329e0 2f 65 6d 3e 20 70 61 73 73 20 74 68 65 20 70 6f  /em> pass the po
329f0 69 6e 74 65 72 73 20 72 65 74 75 72 6e 65 64 0a  inters returned.
32a00 2a 2a 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33  ** from [sqlite3
32a10 5f 63 6f 6c 75 6d 6e 5f 62 6c 6f 62 28 29 5d 2c  _column_blob()],
32a20 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e   [sqlite3_column
32a30 5f 74 65 78 74 28 29 5d 2c 20 65 74 63 2e 20 69  _text()], etc. i
32a40 6e 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  nto.** [sqlite3_
32a50 66 72 65 65 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 5e  free()]..**.** ^
32a60 28 49 66 20 61 20 6d 65 6d 6f 72 79 20 61 6c 6c  (If a memory all
32a70 6f 63 61 74 69 6f 6e 20 65 72 72 6f 72 20 6f 63  ocation error oc
32a80 63 75 72 73 20 64 75 72 69 6e 67 20 74 68 65 20  curs during the 
32a90 65 76 61 6c 75 61 74 69 6f 6e 20 6f 66 20 61 6e  evaluation of an
32aa0 79 0a 2a 2a 20 6f 66 20 74 68 65 73 65 20 72 6f  y.** of these ro
32ab0 75 74 69 6e 65 73 2c 20 61 20 64 65 66 61 75 6c  utines, a defaul
32ac0 74 20 76 61 6c 75 65 20 69 73 20 72 65 74 75 72  t value is retur
32ad0 6e 65 64 2e 20 20 54 68 65 20 64 65 66 61 75 6c  ned.  The defaul
32ae0 74 20 76 61 6c 75 65 0a 2a 2a 20 69 73 20 65 69  t value.** is ei
32af0 74 68 65 72 20 74 68 65 20 69 6e 74 65 67 65 72  ther the integer
32b00 20 30 2c 20 74 68 65 20 66 6c 6f 61 74 69 6e 67   0, the floating
32b10 20 70 6f 69 6e 74 20 6e 75 6d 62 65 72 20 30 2e   point number 0.
32b20 30 2c 20 6f 72 20 61 20 4e 55 4c 4c 0a 2a 2a 20  0, or a NULL.** 
32b30 70 6f 69 6e 74 65 72 2e 20 20 53 75 62 73 65 71  pointer.  Subseq
32b40 75 65 6e 74 20 63 61 6c 6c 73 20 74 6f 20 5b 73  uent calls to [s
32b50 71 6c 69 74 65 33 5f 65 72 72 63 6f 64 65 28 29  qlite3_errcode()
32b60 5d 20 77 69 6c 6c 20 72 65 74 75 72 6e 0a 2a 2a  ] will return.**
32b70 20 5b 53 51 4c 49 54 45 5f 4e 4f 4d 45 4d 5d 2e   [SQLITE_NOMEM].
32b80 29 5e 0a 2a 2f 0a 63 6f 6e 73 74 20 76 6f 69 64  )^.*/.const void
32b90 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e   *sqlite3_column
32ba0 5f 62 6c 6f 62 28 73 71 6c 69 74 65 33 5f 73 74  _blob(sqlite3_st
32bb0 6d 74 2a 2c 20 69 6e 74 20 69 43 6f 6c 29 3b 0a  mt*, int iCol);.
32bc0 69 6e 74 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75  int sqlite3_colu
32bd0 6d 6e 5f 62 79 74 65 73 28 73 71 6c 69 74 65 33  mn_bytes(sqlite3
32be0 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43 6f 6c  _stmt*, int iCol
32bf0 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 63  );.int sqlite3_c
32c00 6f 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28 73 71  olumn_bytes16(sq
32c10 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74  lite3_stmt*, int
32c20 20 69 43 6f 6c 29 3b 0a 64 6f 75 62 6c 65 20 73   iCol);.double s
32c30 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 64 6f  qlite3_column_do
32c40 75 62 6c 65 28 73 71 6c 69 74 65 33 5f 73 74 6d  uble(sqlite3_stm
32c50 74 2a 2c 20 69 6e 74 20 69 43 6f 6c 29 3b 0a 69  t*, int iCol);.i
32c60 6e 74 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  nt sqlite3_colum
32c70 6e 5f 69 6e 74 28 73 71 6c 69 74 65 33 5f 73 74  n_int(sqlite3_st
32c80 6d 74 2a 2c 20 69 6e 74 20 69 43 6f 6c 29 3b 0a  mt*, int iCol);.
32c90 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 20 73 71  sqlite3_int64 sq
32ca0 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 69 6e 74  lite3_column_int
32cb0 36 34 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a  64(sqlite3_stmt*
32cc0 2c 20 69 6e 74 20 69 43 6f 6c 29 3b 0a 63 6f 6e  , int iCol);.con
32cd0 73 74 20 75 6e 73 69 67 6e 65 64 20 63 68 61 72  st unsigned char
32ce0 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e   *sqlite3_column
32cf0 5f 74 65 78 74 28 73 71 6c 69 74 65 33 5f 73 74  _text(sqlite3_st
32d00 6d 74 2a 2c 20 69 6e 74 20 69 43 6f 6c 29 3b 0a  mt*, int iCol);.
32d10 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c 69  const void *sqli
32d20 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 31  te3_column_text1
32d30 36 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c  6(sqlite3_stmt*,
32d40 20 69 6e 74 20 69 43 6f 6c 29 3b 0a 69 6e 74 20   int iCol);.int 
32d50 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74  sqlite3_column_t
32d60 79 70 65 28 73 71 6c 69 74 65 33 5f 73 74 6d 74  ype(sqlite3_stmt
32d70 2a 2c 20 69 6e 74 20 69 43 6f 6c 29 3b 0a 73 71  *, int iCol);.sq
32d80 6c 69 74 65 33 5f 76 61 6c 75 65 20 2a 73 71 6c  lite3_value *sql
32d90 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 76 61 6c 75  ite3_column_valu
32da0 65 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c  e(sqlite3_stmt*,
32db0 20 69 6e 74 20 69 43 6f 6c 29 3b 0a 0a 2f 2a 0a   int iCol);../*.
32dc0 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 44 65 73  ** CAPI3REF: Des
32dd0 74 72 6f 79 20 41 20 50 72 65 70 61 72 65 64 20  troy A Prepared 
32de0 53 74 61 74 65 6d 65 6e 74 20 4f 62 6a 65 63 74  Statement Object
32df0 0a 2a 2a 20 44 45 53 54 52 55 43 54 4f 52 3a 20  .** DESTRUCTOR: 
32e00 73 71 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a  sqlite3_stmt.**.
32e10 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  ** ^The sqlite3_
32e20 66 69 6e 61 6c 69 7a 65 28 29 20 66 75 6e 63 74  finalize() funct
32e30 69 6f 6e 20 69 73 20 63 61 6c 6c 65 64 20 74 6f  ion is called to
32e40 20 64 65 6c 65 74 65 20 61 20 5b 70 72 65 70 61   delete a [prepa
32e50 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 2e 0a  red statement]..
32e60 2a 2a 20 5e 49 66 20 74 68 65 20 6d 6f 73 74 20  ** ^If the most 
32e70 72 65 63 65 6e 74 20 65 76 61 6c 75 61 74 69 6f  recent evaluatio
32e80 6e 20 6f 66 20 74 68 65 20 73 74 61 74 65 6d 65  n of the stateme
32e90 6e 74 20 65 6e 63 6f 75 6e 74 65 72 65 64 20 6e  nt encountered n
32ea0 6f 20 65 72 72 6f 72 73 0a 2a 2a 20 6f 72 20 69  o errors.** or i
32eb0 66 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20  f the statement 
32ec0 69 73 20 6e 65 76 65 72 20 62 65 65 6e 20 65 76  is never been ev
32ed0 61 6c 75 61 74 65 64 2c 20 74 68 65 6e 20 73 71  aluated, then sq
32ee0 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28 29  lite3_finalize()
32ef0 20 72 65 74 75 72 6e 73 0a 2a 2a 20 53 51 4c 49   returns.** SQLI
32f00 54 45 5f 4f 4b 2e 20 20 5e 49 66 20 74 68 65 20  TE_OK.  ^If the 
32f10 6d 6f 73 74 20 72 65 63 65 6e 74 20 65 76 61 6c  most recent eval
32f20 75 61 74 69 6f 6e 20 6f 66 20 73 74 61 74 65 6d  uation of statem
32f30 65 6e 74 20 53 20 66 61 69 6c 65 64 2c 20 74 68  ent S failed, th
32f40 65 6e 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 66 69  en.** sqlite3_fi
32f50 6e 61 6c 69 7a 65 28 53 29 20 72 65 74 75 72 6e  nalize(S) return
32f60 73 20 74 68 65 20 61 70 70 72 6f 70 72 69 61 74  s the appropriat
32f70 65 20 5b 65 72 72 6f 72 20 63 6f 64 65 5d 20 6f  e [error code] o
32f80 72 0a 2a 2a 20 5b 65 78 74 65 6e 64 65 64 20 65  r.** [extended e
32f90 72 72 6f 72 20 63 6f 64 65 5d 2e 0a 2a 2a 0a 2a  rror code]..**.*
32fa0 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 66  * ^The sqlite3_f
32fb0 69 6e 61 6c 69 7a 65 28 53 29 20 72 6f 75 74 69  inalize(S) routi
32fc0 6e 65 20 63 61 6e 20 62 65 20 63 61 6c 6c 65 64  ne can be called
32fd0 20 61 74 20 61 6e 79 20 70 6f 69 6e 74 20 64 75   at any point du
32fe0 72 69 6e 67 0a 2a 2a 20 74 68 65 20 6c 69 66 65  ring.** the life
32ff0 20 63 79 63 6c 65 20 6f 66 20 5b 70 72 65 70 61   cycle of [prepa
33000 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 53  red statement] S
33010 3a 0a 2a 2a 20 62 65 66 6f 72 65 20 73 74 61 74  :.** before stat
33020 65 6d 65 6e 74 20 53 20 69 73 20 65 76 65 72 20  ement S is ever 
33030 65 76 61 6c 75 61 74 65 64 2c 20 61 66 74 65 72  evaluated, after
33040 0a 2a 2a 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 20  .** one or more 
33050 63 61 6c 6c 73 20 74 6f 20 5b 73 71 6c 69 74 65  calls to [sqlite
33060 33 5f 72 65 73 65 74 28 29 5d 2c 20 6f 72 20 61  3_reset()], or a
33070 66 74 65 72 20 61 6e 79 20 63 61 6c 6c 0a 2a 2a  fter any call.**
33080 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 73 74 65   to [sqlite3_ste
33090 70 28 29 5d 20 72 65 67 61 72 64 6c 65 73 73 20  p()] regardless 
330a0 6f 66 20 77 68 65 74 68 65 72 20 6f 72 20 6e 6f  of whether or no
330b0 74 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20  t the statement 
330c0 68 61 73 0a 2a 2a 20 63 6f 6d 70 6c 65 74 65 64  has.** completed
330d0 20 65 78 65 63 75 74 69 6f 6e 2e 0a 2a 2a 0a 2a   execution..**.*
330e0 2a 20 5e 49 6e 76 6f 6b 69 6e 67 20 73 71 6c 69  * ^Invoking sqli
330f0 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28 29 20 6f  te3_finalize() o
33100 6e 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72  n a NULL pointer
33110 20 69 73 20 61 20 68 61 72 6d 6c 65 73 73 20 6e   is a harmless n
33120 6f 2d 6f 70 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  o-op..**.** The 
33130 61 70 70 6c 69 63 61 74 69 6f 6e 20 6d 75 73 74  application must
33140 20 66 69 6e 61 6c 69 7a 65 20 65 76 65 72 79 20   finalize every 
33150 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d  [prepared statem
33160 65 6e 74 5d 20 69 6e 20 6f 72 64 65 72 20 74 6f  ent] in order to
33170 20 61 76 6f 69 64 0a 2a 2a 20 72 65 73 6f 75 72   avoid.** resour
33180 63 65 20 6c 65 61 6b 73 2e 20 20 49 74 20 69 73  ce leaks.  It is
33190 20 61 20 67 72 69 65 76 6f 75 73 20 65 72 72 6f   a grievous erro
331a0 72 20 66 6f 72 20 74 68 65 20 61 70 70 6c 69 63  r for the applic
331b0 61 74 69 6f 6e 20 74 6f 20 74 72 79 20 74 6f 20  ation to try to 
331c0 75 73 65 0a 2a 2a 20 61 20 70 72 65 70 61 72 65  use.** a prepare
331d0 64 20 73 74 61 74 65 6d 65 6e 74 20 61 66 74 65  d statement afte
331e0 72 20 69 74 20 68 61 73 20 62 65 65 6e 20 66 69  r it has been fi
331f0 6e 61 6c 69 7a 65 64 2e 20 20 41 6e 79 20 75 73  nalized.  Any us
33200 65 20 6f 66 20 61 20 70 72 65 70 61 72 65 64 0a  e of a prepared.
33210 2a 2a 20 73 74 61 74 65 6d 65 6e 74 20 61 66 74  ** statement aft
33220 65 72 20 69 74 20 68 61 73 20 62 65 65 6e 20 66  er it has been f
33230 69 6e 61 6c 69 7a 65 64 20 63 61 6e 20 72 65 73  inalized can res
33240 75 6c 74 20 69 6e 20 75 6e 64 65 66 69 6e 65 64  ult in undefined
33250 20 61 6e 64 0a 2a 2a 20 75 6e 64 65 73 69 72 61   and.** undesira
33260 62 6c 65 20 62 65 68 61 76 69 6f 72 20 73 75 63  ble behavior suc
33270 68 20 61 73 20 73 65 67 66 61 75 6c 74 73 20 61  h as segfaults a
33280 6e 64 20 68 65 61 70 20 63 6f 72 72 75 70 74 69  nd heap corrupti
33290 6f 6e 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  on..*/.int sqlit
332a0 65 33 5f 66 69 6e 61 6c 69 7a 65 28 73 71 6c 69  e3_finalize(sqli
332b0 74 65 33 5f 73 74 6d 74 20 2a 70 53 74 6d 74 29  te3_stmt *pStmt)
332c0 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
332d0 46 3a 20 52 65 73 65 74 20 41 20 50 72 65 70 61  F: Reset A Prepa
332e0 72 65 64 20 53 74 61 74 65 6d 65 6e 74 20 4f 62  red Statement Ob
332f0 6a 65 63 74 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20  ject.** METHOD: 
33300 73 71 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a  sqlite3_stmt.**.
33310 2a 2a 20 54 68 65 20 73 71 6c 69 74 65 33 5f 72  ** The sqlite3_r
33320 65 73 65 74 28 29 20 66 75 6e 63 74 69 6f 6e 20  eset() function 
33330 69 73 20 63 61 6c 6c 65 64 20 74 6f 20 72 65 73  is called to res
33340 65 74 20 61 20 5b 70 72 65 70 61 72 65 64 20 73  et a [prepared s
33350 74 61 74 65 6d 65 6e 74 5d 0a 2a 2a 20 6f 62 6a  tatement].** obj
33360 65 63 74 20 62 61 63 6b 20 74 6f 20 69 74 73 20  ect back to its 
33370 69 6e 69 74 69 61 6c 20 73 74 61 74 65 2c 20 72  initial state, r
33380 65 61 64 79 20 74 6f 20 62 65 20 72 65 2d 65 78  eady to be re-ex
33390 65 63 75 74 65 64 2e 0a 2a 2a 20 5e 41 6e 79 20  ecuted..** ^Any 
333a0 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 76 61  SQL statement va
333b0 72 69 61 62 6c 65 73 20 74 68 61 74 20 68 61 64  riables that had
333c0 20 76 61 6c 75 65 73 20 62 6f 75 6e 64 20 74 6f   values bound to
333d0 20 74 68 65 6d 20 75 73 69 6e 67 0a 2a 2a 20 74   them using.** t
333e0 68 65 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64  he [sqlite3_bind
333f0 5f 62 6c 6f 62 20 7c 20 73 71 6c 69 74 65 33 5f  _blob | sqlite3_
33400 62 69 6e 64 5f 2a 28 29 20 41 50 49 5d 20 72 65  bind_*() API] re
33410 74 61 69 6e 20 74 68 65 69 72 20 76 61 6c 75 65  tain their value
33420 73 2e 0a 2a 2a 20 55 73 65 20 5b 73 71 6c 69 74  s..** Use [sqlit
33430 65 33 5f 63 6c 65 61 72 5f 62 69 6e 64 69 6e 67  e3_clear_binding
33440 73 28 29 5d 20 74 6f 20 72 65 73 65 74 20 74 68  s()] to reset th
33450 65 20 62 69 6e 64 69 6e 67 73 2e 0a 2a 2a 0a 2a  e bindings..**.*
33460 2a 20 5e 54 68 65 20 5b 73 71 6c 69 74 65 33 5f  * ^The [sqlite3_
33470 72 65 73 65 74 28 53 29 5d 20 69 6e 74 65 72 66  reset(S)] interf
33480 61 63 65 20 72 65 73 65 74 73 20 74 68 65 20 5b  ace resets the [
33490 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
334a0 6e 74 5d 20 53 0a 2a 2a 20 62 61 63 6b 20 74 6f  nt] S.** back to
334b0 20 74 68 65 20 62 65 67 69 6e 6e 69 6e 67 20 6f   the beginning o
334c0 66 20 69 74 73 20 70 72 6f 67 72 61 6d 2e 0a 2a  f its program..*
334d0 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 6d 6f 73  *.** ^If the mos
334e0 74 20 72 65 63 65 6e 74 20 63 61 6c 6c 20 74 6f  t recent call to
334f0 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 53   [sqlite3_step(S
33500 29 5d 20 66 6f 72 20 74 68 65 0a 2a 2a 20 5b 70  )] for the.** [p
33510 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e  repared statemen
33520 74 5d 20 53 20 72 65 74 75 72 6e 65 64 20 5b 53  t] S returned [S
33530 51 4c 49 54 45 5f 52 4f 57 5d 20 6f 72 20 5b 53  QLITE_ROW] or [S
33540 51 4c 49 54 45 5f 44 4f 4e 45 5d 2c 0a 2a 2a 20  QLITE_DONE],.** 
33550 6f 72 20 69 66 20 5b 73 71 6c 69 74 65 33 5f 73  or if [sqlite3_s
33560 74 65 70 28 53 29 5d 20 68 61 73 20 6e 65 76 65  tep(S)] has neve
33570 72 20 62 65 66 6f 72 65 20 62 65 65 6e 20 63 61  r before been ca
33580 6c 6c 65 64 20 6f 6e 20 53 2c 0a 2a 2a 20 74 68  lled on S,.** th
33590 65 6e 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65  en [sqlite3_rese
335a0 74 28 53 29 5d 20 72 65 74 75 72 6e 73 20 5b 53  t(S)] returns [S
335b0 51 4c 49 54 45 5f 4f 4b 5d 2e 0a 2a 2a 0a 2a 2a  QLITE_OK]..**.**
335c0 20 5e 49 66 20 74 68 65 20 6d 6f 73 74 20 72 65   ^If the most re
335d0 63 65 6e 74 20 63 61 6c 6c 20 74 6f 20 5b 73 71  cent call to [sq
335e0 6c 69 74 65 33 5f 73 74 65 70 28 53 29 5d 20 66  lite3_step(S)] f
335f0 6f 72 20 74 68 65 0a 2a 2a 20 5b 70 72 65 70 61  or the.** [prepa
33600 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 53  red statement] S
33610 20 69 6e 64 69 63 61 74 65 64 20 61 6e 20 65 72   indicated an er
33620 72 6f 72 2c 20 74 68 65 6e 0a 2a 2a 20 5b 73 71  ror, then.** [sq
33630 6c 69 74 65 33 5f 72 65 73 65 74 28 53 29 5d 20  lite3_reset(S)] 
33640 72 65 74 75 72 6e 73 20 61 6e 20 61 70 70 72 6f  returns an appro
33650 70 72 69 61 74 65 20 5b 65 72 72 6f 72 20 63 6f  priate [error co
33660 64 65 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  de]..**.** ^The 
33670 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 53  [sqlite3_reset(S
33680 29 5d 20 69 6e 74 65 72 66 61 63 65 20 64 6f 65  )] interface doe
33690 73 20 6e 6f 74 20 63 68 61 6e 67 65 20 74 68 65  s not change the
336a0 20 76 61 6c 75 65 73 0a 2a 2a 20 6f 66 20 61 6e   values.** of an
336b0 79 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  y [sqlite3_bind_
336c0 62 6c 6f 62 7c 62 69 6e 64 69 6e 67 73 5d 20 6f  blob|bindings] o
336d0 6e 20 74 68 65 20 5b 70 72 65 70 61 72 65 64 20  n the [prepared 
336e0 73 74 61 74 65 6d 65 6e 74 5d 20 53 2e 0a 2a 2f  statement] S..*/
336f0 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 72 65 73  .int sqlite3_res
33700 65 74 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 20  et(sqlite3_stmt 
33710 2a 70 53 74 6d 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20  *pStmt);../*.** 
33720 43 41 50 49 33 52 45 46 3a 20 43 72 65 61 74 65  CAPI3REF: Create
33730 20 4f 72 20 52 65 64 65 66 69 6e 65 20 53 51 4c   Or Redefine SQL
33740 20 46 75 6e 63 74 69 6f 6e 73 0a 2a 2a 20 4b 45   Functions.** KE
33750 59 57 4f 52 44 53 3a 20 7b 66 75 6e 63 74 69 6f  YWORDS: {functio
33760 6e 20 63 72 65 61 74 69 6f 6e 20 72 6f 75 74 69  n creation routi
33770 6e 65 73 7d 0a 2a 2a 20 4b 45 59 57 4f 52 44 53  nes}.** KEYWORDS
33780 3a 20 7b 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64  : {application-d
33790 65 66 69 6e 65 64 20 53 51 4c 20 66 75 6e 63 74  efined SQL funct
337a0 69 6f 6e 7d 0a 2a 2a 20 4b 45 59 57 4f 52 44 53  ion}.** KEYWORDS
337b0 3a 20 7b 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64  : {application-d
337c0 65 66 69 6e 65 64 20 53 51 4c 20 66 75 6e 63 74  efined SQL funct
337d0 69 6f 6e 73 7d 0a 2a 2a 20 4d 45 54 48 4f 44 3a  ions}.** METHOD:
337e0 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e   sqlite3.**.** ^
337f0 54 68 65 73 65 20 66 75 6e 63 74 69 6f 6e 73 20  These functions 
33800 28 63 6f 6c 6c 65 63 74 69 76 65 6c 79 20 6b 6e  (collectively kn
33810 6f 77 6e 20 61 73 20 22 66 75 6e 63 74 69 6f 6e  own as "function
33820 20 63 72 65 61 74 69 6f 6e 20 72 6f 75 74 69 6e   creation routin
33830 65 73 22 29 0a 2a 2a 20 61 72 65 20 75 73 65 64  es").** are used
33840 20 74 6f 20 61 64 64 20 53 51 4c 20 66 75 6e 63   to add SQL func
33850 74 69 6f 6e 73 20 6f 72 20 61 67 67 72 65 67 61  tions or aggrega
33860 74 65 73 20 6f 72 20 74 6f 20 72 65 64 65 66 69  tes or to redefi
33870 6e 65 20 74 68 65 20 62 65 68 61 76 69 6f 72 0a  ne the behavior.
33880 2a 2a 20 6f 66 20 65 78 69 73 74 69 6e 67 20 53  ** of existing S
33890 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20 6f 72 20  QL functions or 
338a0 61 67 67 72 65 67 61 74 65 73 2e 20 20 54 68 65  aggregates.  The
338b0 20 6f 6e 6c 79 20 64 69 66 66 65 72 65 6e 63 65   only difference
338c0 73 20 62 65 74 77 65 65 6e 0a 2a 2a 20 74 68 65  s between.** the
338d0 73 65 20 72 6f 75 74 69 6e 65 73 20 61 72 65 20  se routines are 
338e0 74 68 65 20 74 65 78 74 20 65 6e 63 6f 64 69 6e  the text encodin
338f0 67 20 65 78 70 65 63 74 65 64 20 66 6f 72 0a 2a  g expected for.*
33900 2a 20 74 68 65 20 73 65 63 6f 6e 64 20 70 61 72  * the second par
33910 61 6d 65 74 65 72 20 28 74 68 65 20 6e 61 6d 65  ameter (the name
33920 20 6f 66 20 74 68 65 20 66 75 6e 63 74 69 6f 6e   of the function
33930 20 62 65 69 6e 67 20 63 72 65 61 74 65 64 29 0a   being created).
33940 2a 2a 20 61 6e 64 20 74 68 65 20 70 72 65 73 65  ** and the prese
33950 6e 63 65 20 6f 72 20 61 62 73 65 6e 63 65 20 6f  nce or absence o
33960 66 20 61 20 64 65 73 74 72 75 63 74 6f 72 20 63  f a destructor c
33970 61 6c 6c 62 61 63 6b 20 66 6f 72 0a 2a 2a 20 74  allback for.** t
33980 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 64  he application d
33990 61 74 61 20 70 6f 69 6e 74 65 72 2e 0a 2a 2a 0a  ata pointer..**.
339a0 2a 2a 20 5e 54 68 65 20 66 69 72 73 74 20 70 61  ** ^The first pa
339b0 72 61 6d 65 74 65 72 20 69 73 20 74 68 65 20 5b  rameter is the [
339c0 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
339d0 69 6f 6e 5d 20 74 6f 20 77 68 69 63 68 20 74 68  ion] to which th
339e0 65 20 53 51 4c 0a 2a 2a 20 66 75 6e 63 74 69 6f  e SQL.** functio
339f0 6e 20 69 73 20 74 6f 20 62 65 20 61 64 64 65 64  n is to be added
33a00 2e 20 20 5e 49 66 20 61 6e 20 61 70 70 6c 69 63  .  ^If an applic
33a10 61 74 69 6f 6e 20 75 73 65 73 20 6d 6f 72 65 20  ation uses more 
33a20 74 68 61 6e 20 6f 6e 65 20 64 61 74 61 62 61 73  than one databas
33a30 65 0a 2a 2a 20 63 6f 6e 6e 65 63 74 69 6f 6e 20  e.** connection 
33a40 74 68 65 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e  then application
33a50 2d 64 65 66 69 6e 65 64 20 53 51 4c 20 66 75 6e  -defined SQL fun
33a60 63 74 69 6f 6e 73 20 6d 75 73 74 20 62 65 20 61  ctions must be a
33a70 64 64 65 64 0a 2a 2a 20 74 6f 20 65 61 63 68 20  dded.** to each 
33a80 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
33a90 69 6f 6e 20 73 65 70 61 72 61 74 65 6c 79 2e 0a  ion separately..
33aa0 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 65 63 6f 6e  **.** ^The secon
33ab0 64 20 70 61 72 61 6d 65 74 65 72 20 69 73 20 74  d parameter is t
33ac0 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 53  he name of the S
33ad0 51 4c 20 66 75 6e 63 74 69 6f 6e 20 74 6f 20 62  QL function to b
33ae0 65 20 63 72 65 61 74 65 64 20 6f 72 0a 2a 2a 20  e created or.** 
33af0 72 65 64 65 66 69 6e 65 64 2e 20 20 5e 54 68 65  redefined.  ^The
33b00 20 6c 65 6e 67 74 68 20 6f 66 20 74 68 65 20 6e   length of the n
33b10 61 6d 65 20 69 73 20 6c 69 6d 69 74 65 64 20 74  ame is limited t
33b20 6f 20 32 35 35 20 62 79 74 65 73 20 69 6e 20 61  o 255 bytes in a
33b30 20 55 54 46 2d 38 0a 2a 2a 20 72 65 70 72 65 73   UTF-8.** repres
33b40 65 6e 74 61 74 69 6f 6e 2c 20 65 78 63 6c 75 73  entation, exclus
33b50 69 76 65 20 6f 66 20 74 68 65 20 7a 65 72 6f 2d  ive of the zero-
33b60 74 65 72 6d 69 6e 61 74 6f 72 2e 20 20 5e 4e 6f  terminator.  ^No
33b70 74 65 20 74 68 61 74 20 74 68 65 20 6e 61 6d 65  te that the name
33b80 0a 2a 2a 20 6c 65 6e 67 74 68 20 6c 69 6d 69 74  .** length limit
33b90 20 69 73 20 69 6e 20 55 54 46 2d 38 20 62 79 74   is in UTF-8 byt
33ba0 65 73 2c 20 6e 6f 74 20 63 68 61 72 61 63 74 65  es, not characte
33bb0 72 73 20 6e 6f 72 20 55 54 46 2d 31 36 20 62 79  rs nor UTF-16 by
33bc0 74 65 73 2e 20 20 0a 2a 2a 20 5e 41 6e 79 20 61  tes.  .** ^Any a
33bd0 74 74 65 6d 70 74 20 74 6f 20 63 72 65 61 74 65  ttempt to create
33be0 20 61 20 66 75 6e 63 74 69 6f 6e 20 77 69 74 68   a function with
33bf0 20 61 20 6c 6f 6e 67 65 72 20 6e 61 6d 65 0a 2a   a longer name.*
33c00 2a 20 77 69 6c 6c 20 72 65 73 75 6c 74 20 69 6e  * will result in
33c10 20 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 5d   [SQLITE_MISUSE]
33c20 20 62 65 69 6e 67 20 72 65 74 75 72 6e 65 64 2e   being returned.
33c30 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 74 68 69 72  .**.** ^The thir
33c40 64 20 70 61 72 61 6d 65 74 65 72 20 28 6e 41 72  d parameter (nAr
33c50 67 29 0a 2a 2a 20 69 73 20 74 68 65 20 6e 75 6d  g).** is the num
33c60 62 65 72 20 6f 66 20 61 72 67 75 6d 65 6e 74 73  ber of arguments
33c70 20 74 68 61 74 20 74 68 65 20 53 51 4c 20 66 75   that the SQL fu
33c80 6e 63 74 69 6f 6e 20 6f 72 0a 2a 2a 20 61 67 67  nction or.** agg
33c90 72 65 67 61 74 65 20 74 61 6b 65 73 2e 20 5e 49  regate takes. ^I
33ca0 66 20 74 68 69 73 20 70 61 72 61 6d 65 74 65 72  f this parameter
33cb0 20 69 73 20 2d 31 2c 20 74 68 65 6e 20 74 68 65   is -1, then the
33cc0 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 6f 72   SQL function or
33cd0 0a 2a 2a 20 61 67 67 72 65 67 61 74 65 20 6d 61  .** aggregate ma
33ce0 79 20 74 61 6b 65 20 61 6e 79 20 6e 75 6d 62 65  y take any numbe
33cf0 72 20 6f 66 20 61 72 67 75 6d 65 6e 74 73 20 62  r of arguments b
33d00 65 74 77 65 65 6e 20 30 20 61 6e 64 20 74 68 65  etween 0 and the
33d10 20 6c 69 6d 69 74 0a 2a 2a 20 73 65 74 20 62 79   limit.** set by
33d20 20 5b 73 71 6c 69 74 65 33 5f 6c 69 6d 69 74 5d   [sqlite3_limit]
33d30 28 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 46  ([SQLITE_LIMIT_F
33d40 55 4e 43 54 49 4f 4e 5f 41 52 47 5d 29 2e 20 20  UNCTION_ARG]).  
33d50 49 66 20 74 68 65 20 74 68 69 72 64 0a 2a 2a 20  If the third.** 
33d60 70 61 72 61 6d 65 74 65 72 20 69 73 20 6c 65 73  parameter is les
33d70 73 20 74 68 61 6e 20 2d 31 20 6f 72 20 67 72 65  s than -1 or gre
33d80 61 74 65 72 20 74 68 61 6e 20 31 32 37 20 74 68  ater than 127 th
33d90 65 6e 20 74 68 65 20 62 65 68 61 76 69 6f 72 20  en the behavior 
33da0 69 73 0a 2a 2a 20 75 6e 64 65 66 69 6e 65 64 2e  is.** undefined.
33db0 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66 6f 75 72  .**.** ^The four
33dc0 74 68 20 70 61 72 61 6d 65 74 65 72 2c 20 65 54  th parameter, eT
33dd0 65 78 74 52 65 70 2c 20 73 70 65 63 69 66 69 65  extRep, specifie
33de0 73 20 77 68 61 74 0a 2a 2a 20 5b 53 51 4c 49 54  s what.** [SQLIT
33df0 45 5f 55 54 46 38 20 7c 20 74 65 78 74 20 65 6e  E_UTF8 | text en
33e00 63 6f 64 69 6e 67 5d 20 74 68 69 73 20 53 51 4c  coding] this SQL
33e10 20 66 75 6e 63 74 69 6f 6e 20 70 72 65 66 65 72   function prefer
33e20 73 20 66 6f 72 0a 2a 2a 20 69 74 73 20 70 61 72  s for.** its par
33e30 61 6d 65 74 65 72 73 2e 20 20 54 68 65 20 61 70  ameters.  The ap
33e40 70 6c 69 63 61 74 69 6f 6e 20 73 68 6f 75 6c 64  plication should
33e50 20 73 65 74 20 74 68 69 73 20 70 61 72 61 6d 65   set this parame
33e60 74 65 72 20 74 6f 0a 2a 2a 20 5b 53 51 4c 49 54  ter to.** [SQLIT
33e70 45 5f 55 54 46 31 36 4c 45 5d 20 69 66 20 74 68  E_UTF16LE] if th
33e80 65 20 66 75 6e 63 74 69 6f 6e 20 69 6d 70 6c 65  e function imple
33e90 6d 65 6e 74 61 74 69 6f 6e 20 69 6e 76 6f 6b 65  mentation invoke
33ea0 73 20 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 76  s .** [sqlite3_v
33eb0 61 6c 75 65 5f 74 65 78 74 31 36 6c 65 28 29 5d  alue_text16le()]
33ec0 20 6f 6e 20 61 6e 20 69 6e 70 75 74 2c 20 6f 72   on an input, or
33ed0 20 5b 53 51 4c 49 54 45 5f 55 54 46 31 36 42 45   [SQLITE_UTF16BE
33ee0 5d 20 69 66 20 74 68 65 0a 2a 2a 20 69 6d 70 6c  ] if the.** impl
33ef0 65 6d 65 6e 74 61 74 69 6f 6e 20 69 6e 76 6f 6b  ementation invok
33f00 65 73 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75  es [sqlite3_valu
33f10 65 5f 74 65 78 74 31 36 62 65 28 29 5d 20 6f 6e  e_text16be()] on
33f20 20 61 6e 20 69 6e 70 75 74 2c 20 6f 72 0a 2a 2a   an input, or.**
33f30 20 5b 53 51 4c 49 54 45 5f 55 54 46 31 36 5d 20   [SQLITE_UTF16] 
33f40 69 66 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75  if [sqlite3_valu
33f50 65 5f 74 65 78 74 31 36 28 29 5d 20 69 73 20 75  e_text16()] is u
33f60 73 65 64 2c 20 6f 72 20 5b 53 51 4c 49 54 45 5f  sed, or [SQLITE_
33f70 55 54 46 38 5d 0a 2a 2a 20 6f 74 68 65 72 77 69  UTF8].** otherwi
33f80 73 65 2e 20 20 5e 54 68 65 20 73 61 6d 65 20 53  se.  ^The same S
33f90 51 4c 20 66 75 6e 63 74 69 6f 6e 20 6d 61 79 20  QL function may 
33fa0 62 65 20 72 65 67 69 73 74 65 72 65 64 20 6d 75  be registered mu
33fb0 6c 74 69 70 6c 65 20 74 69 6d 65 73 20 75 73 69  ltiple times usi
33fc0 6e 67 0a 2a 2a 20 64 69 66 66 65 72 65 6e 74 20  ng.** different 
33fd0 70 72 65 66 65 72 72 65 64 20 74 65 78 74 20 65  preferred text e
33fe0 6e 63 6f 64 69 6e 67 73 2c 20 77 69 74 68 20 64  ncodings, with d
33ff0 69 66 66 65 72 65 6e 74 20 69 6d 70 6c 65 6d 65  ifferent impleme
34000 6e 74 61 74 69 6f 6e 73 20 66 6f 72 0a 2a 2a 20  ntations for.** 
34010 65 61 63 68 20 65 6e 63 6f 64 69 6e 67 2e 0a 2a  each encoding..*
34020 2a 20 5e 57 68 65 6e 20 6d 75 6c 74 69 70 6c 65  * ^When multiple
34030 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73   implementations
34040 20 6f 66 20 74 68 65 20 73 61 6d 65 20 66 75 6e   of the same fun
34050 63 74 69 6f 6e 20 61 72 65 20 61 76 61 69 6c 61  ction are availa
34060 62 6c 65 2c 20 53 51 4c 69 74 65 0a 2a 2a 20 77  ble, SQLite.** w
34070 69 6c 6c 20 70 69 63 6b 20 74 68 65 20 6f 6e 65  ill pick the one
34080 20 74 68 61 74 20 69 6e 76 6f 6c 76 65 73 20 74   that involves t
34090 68 65 20 6c 65 61 73 74 20 61 6d 6f 75 6e 74 20  he least amount 
340a0 6f 66 20 64 61 74 61 20 63 6f 6e 76 65 72 73 69  of data conversi
340b0 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66  on..**.** ^The f
340c0 6f 75 72 74 68 20 70 61 72 61 6d 65 74 65 72 20  ourth parameter 
340d0 6d 61 79 20 6f 70 74 69 6f 6e 61 6c 6c 79 20 62  may optionally b
340e0 65 20 4f 52 65 64 20 77 69 74 68 20 5b 53 51 4c  e ORed with [SQL
340f0 49 54 45 5f 44 45 54 45 52 4d 49 4e 49 53 54 49  ITE_DETERMINISTI
34100 43 5d 0a 2a 2a 20 74 6f 20 73 69 67 6e 61 6c 20  C].** to signal 
34110 74 68 61 74 20 74 68 65 20 66 75 6e 63 74 69 6f  that the functio
34120 6e 20 77 69 6c 6c 20 61 6c 77 61 79 73 20 72 65  n will always re
34130 74 75 72 6e 20 74 68 65 20 73 61 6d 65 20 72 65  turn the same re
34140 73 75 6c 74 20 67 69 76 65 6e 0a 2a 2a 20 74 68  sult given.** th
34150 65 20 73 61 6d 65 20 69 6e 70 75 74 73 20 77 69  e same inputs wi
34160 74 68 69 6e 20 61 20 73 69 6e 67 6c 65 20 53 51  thin a single SQ
34170 4c 20 73 74 61 74 65 6d 65 6e 74 2e 20 20 4d 6f  L statement.  Mo
34180 73 74 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73  st SQL functions
34190 20 61 72 65 0a 2a 2a 20 64 65 74 65 72 6d 69 6e   are.** determin
341a0 69 73 74 69 63 2e 20 20 54 68 65 20 62 75 69 6c  istic.  The buil
341b0 74 2d 69 6e 20 5b 72 61 6e 64 6f 6d 28 29 5d 20  t-in [random()] 
341c0 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 69 73 20  SQL function is 
341d0 61 6e 20 65 78 61 6d 70 6c 65 20 6f 66 20 61 0a  an example of a.
341e0 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 74 68 61 74  ** function that
341f0 20 69 73 20 6e 6f 74 20 64 65 74 65 72 6d 69 6e   is not determin
34200 69 73 74 69 63 2e 20 20 54 68 65 20 53 51 4c 69  istic.  The SQLi
34210 74 65 20 71 75 65 72 79 20 70 6c 61 6e 6e 65 72  te query planner
34220 20 69 73 20 61 62 6c 65 20 74 6f 0a 2a 2a 20 70   is able to.** p
34230 65 72 66 6f 72 6d 20 61 64 64 69 74 69 6f 6e 61  erform additiona
34240 6c 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e 73 20  l optimizations 
34250 6f 6e 20 64 65 74 65 72 6d 69 6e 69 73 74 69 63  on deterministic
34260 20 66 75 6e 63 74 69 6f 6e 73 2c 20 73 6f 20 75   functions, so u
34270 73 65 0a 2a 2a 20 6f 66 20 74 68 65 20 5b 53 51  se.** of the [SQ
34280 4c 49 54 45 5f 44 45 54 45 52 4d 49 4e 49 53 54  LITE_DETERMINIST
34290 49 43 5d 20 66 6c 61 67 20 69 73 20 72 65 63 6f  IC] flag is reco
342a0 6d 6d 65 6e 64 65 64 20 77 68 65 72 65 20 70 6f  mmended where po
342b0 73 73 69 62 6c 65 2e 0a 2a 2a 0a 2a 2a 20 5e 28  ssible..**.** ^(
342c0 54 68 65 20 66 69 66 74 68 20 70 61 72 61 6d 65  The fifth parame
342d0 74 65 72 20 69 73 20 61 6e 20 61 72 62 69 74 72  ter is an arbitr
342e0 61 72 79 20 70 6f 69 6e 74 65 72 2e 20 20 54 68  ary pointer.  Th
342f0 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  e implementation
34300 20 6f 66 20 74 68 65 0a 2a 2a 20 66 75 6e 63 74   of the.** funct
34310 69 6f 6e 20 63 61 6e 20 67 61 69 6e 20 61 63 63  ion can gain acc
34320 65 73 73 20 74 6f 20 74 68 69 73 20 70 6f 69 6e  ess to this poin
34330 74 65 72 20 75 73 69 6e 67 20 5b 73 71 6c 69 74  ter using [sqlit
34340 65 33 5f 75 73 65 72 5f 64 61 74 61 28 29 5d 2e  e3_user_data()].
34350 29 5e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 69  )^.**.** ^The si
34360 78 74 68 2c 20 73 65 76 65 6e 74 68 20 61 6e 64  xth, seventh and
34370 20 65 69 67 68 74 68 20 70 61 72 61 6d 65 74 65   eighth paramete
34380 72 73 2c 20 78 46 75 6e 63 2c 20 78 53 74 65 70  rs, xFunc, xStep
34390 20 61 6e 64 20 78 46 69 6e 61 6c 2c 20 61 72 65   and xFinal, are
343a0 0a 2a 2a 20 70 6f 69 6e 74 65 72 73 20 74 6f 20  .** pointers to 
343b0 43 2d 6c 61 6e 67 75 61 67 65 20 66 75 6e 63 74  C-language funct
343c0 69 6f 6e 73 20 74 68 61 74 20 69 6d 70 6c 65 6d  ions that implem
343d0 65 6e 74 20 74 68 65 20 53 51 4c 20 66 75 6e 63  ent the SQL func
343e0 74 69 6f 6e 20 6f 72 0a 2a 2a 20 61 67 67 72 65  tion or.** aggre
343f0 67 61 74 65 2e 20 5e 41 20 73 63 61 6c 61 72 20  gate. ^A scalar 
34400 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 72 65 71  SQL function req
34410 75 69 72 65 73 20 61 6e 20 69 6d 70 6c 65 6d 65  uires an impleme
34420 6e 74 61 74 69 6f 6e 20 6f 66 20 74 68 65 20 78  ntation of the x
34430 46 75 6e 63 0a 2a 2a 20 63 61 6c 6c 62 61 63 6b  Func.** callback
34440 20 6f 6e 6c 79 3b 20 4e 55 4c 4c 20 70 6f 69 6e   only; NULL poin
34450 74 65 72 73 20 6d 75 73 74 20 62 65 20 70 61 73  ters must be pas
34460 73 65 64 20 61 73 20 74 68 65 20 78 53 74 65 70  sed as the xStep
34470 20 61 6e 64 20 78 46 69 6e 61 6c 0a 2a 2a 20 70   and xFinal.** p
34480 61 72 61 6d 65 74 65 72 73 2e 20 5e 41 6e 20 61  arameters. ^An a
34490 67 67 72 65 67 61 74 65 20 53 51 4c 20 66 75 6e  ggregate SQL fun
344a0 63 74 69 6f 6e 20 72 65 71 75 69 72 65 73 20 61  ction requires a
344b0 6e 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  n implementation
344c0 20 6f 66 20 78 53 74 65 70 0a 2a 2a 20 61 6e 64   of xStep.** and
344d0 20 78 46 69 6e 61 6c 20 61 6e 64 20 4e 55 4c 4c   xFinal and NULL
344e0 20 70 6f 69 6e 74 65 72 20 6d 75 73 74 20 62 65   pointer must be
344f0 20 70 61 73 73 65 64 20 66 6f 72 20 78 46 75 6e   passed for xFun
34500 63 2e 20 5e 54 6f 20 64 65 6c 65 74 65 20 61 6e  c. ^To delete an
34510 20 65 78 69 73 74 69 6e 67 0a 2a 2a 20 53 51 4c   existing.** SQL
34520 20 66 75 6e 63 74 69 6f 6e 20 6f 72 20 61 67 67   function or agg
34530 72 65 67 61 74 65 2c 20 70 61 73 73 20 4e 55 4c  regate, pass NUL
34540 4c 20 70 6f 69 6e 74 65 72 73 20 66 6f 72 20 61  L pointers for a
34550 6c 6c 20 74 68 72 65 65 20 66 75 6e 63 74 69 6f  ll three functio
34560 6e 0a 2a 2a 20 63 61 6c 6c 62 61 63 6b 73 2e 0a  n.** callbacks..
34570 2a 2a 0a 2a 2a 20 5e 28 49 66 20 74 68 65 20 6e  **.** ^(If the n
34580 69 6e 74 68 20 70 61 72 61 6d 65 74 65 72 20 74  inth parameter t
34590 6f 20 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65  o sqlite3_create
345a0 5f 66 75 6e 63 74 69 6f 6e 5f 76 32 28 29 20 69  _function_v2() i
345b0 73 20 6e 6f 74 20 4e 55 4c 4c 2c 0a 2a 2a 20 74  s not NULL,.** t
345c0 68 65 6e 20 69 74 20 69 73 20 64 65 73 74 72 75  hen it is destru
345d0 63 74 6f 72 20 66 6f 72 20 74 68 65 20 61 70 70  ctor for the app
345e0 6c 69 63 61 74 69 6f 6e 20 64 61 74 61 20 70 6f  lication data po
345f0 69 6e 74 65 72 2e 20 0a 2a 2a 20 54 68 65 20 64  inter. .** The d
34600 65 73 74 72 75 63 74 6f 72 20 69 73 20 69 6e 76  estructor is inv
34610 6f 6b 65 64 20 77 68 65 6e 20 74 68 65 20 66 75  oked when the fu
34620 6e 63 74 69 6f 6e 20 69 73 20 64 65 6c 65 74 65  nction is delete
34630 64 2c 20 65 69 74 68 65 72 20 62 79 20 62 65 69  d, either by bei
34640 6e 67 0a 2a 2a 20 6f 76 65 72 6c 6f 61 64 65 64  ng.** overloaded
34650 20 6f 72 20 77 68 65 6e 20 74 68 65 20 64 61 74   or when the dat
34660 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
34670 20 63 6c 6f 73 65 73 2e 29 5e 0a 2a 2a 20 5e 54   closes.)^.** ^T
34680 68 65 20 64 65 73 74 72 75 63 74 6f 72 20 69 73  he destructor is
34690 20 61 6c 73 6f 20 69 6e 76 6f 6b 65 64 20 69 66   also invoked if
346a0 20 74 68 65 20 63 61 6c 6c 20 74 6f 0a 2a 2a 20   the call to.** 
346b0 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 66  sqlite3_create_f
346c0 75 6e 63 74 69 6f 6e 5f 76 32 28 29 20 66 61 69  unction_v2() fai
346d0 6c 73 2e 0a 2a 2a 20 5e 57 68 65 6e 20 74 68 65  ls..** ^When the
346e0 20 64 65 73 74 72 75 63 74 6f 72 20 63 61 6c 6c   destructor call
346f0 62 61 63 6b 20 6f 66 20 74 68 65 20 74 65 6e 74  back of the tent
34700 68 20 70 61 72 61 6d 65 74 65 72 20 69 73 20 69  h parameter is i
34710 6e 76 6f 6b 65 64 2c 20 69 74 0a 2a 2a 20 69 73  nvoked, it.** is
34720 20 70 61 73 73 65 64 20 61 20 73 69 6e 67 6c 65   passed a single
34730 20 61 72 67 75 6d 65 6e 74 20 77 68 69 63 68 20   argument which 
34740 69 73 20 61 20 63 6f 70 79 20 6f 66 20 74 68 65  is a copy of the
34750 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 64 61 74   application dat
34760 61 20 0a 2a 2a 20 70 6f 69 6e 74 65 72 20 77 68  a .** pointer wh
34770 69 63 68 20 77 61 73 20 74 68 65 20 66 69 66 74  ich was the fift
34780 68 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73  h parameter to s
34790 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75  qlite3_create_fu
347a0 6e 63 74 69 6f 6e 5f 76 32 28 29 2e 0a 2a 2a 0a  nction_v2()..**.
347b0 2a 2a 20 5e 49 74 20 69 73 20 70 65 72 6d 69 74  ** ^It is permit
347c0 74 65 64 20 74 6f 20 72 65 67 69 73 74 65 72 20  ted to register 
347d0 6d 75 6c 74 69 70 6c 65 20 69 6d 70 6c 65 6d 65  multiple impleme
347e0 6e 74 61 74 69 6f 6e 73 20 6f 66 20 74 68 65 20  ntations of the 
347f0 73 61 6d 65 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e  same.** function
34800 73 20 77 69 74 68 20 74 68 65 20 73 61 6d 65 20  s with the same 
34810 6e 61 6d 65 20 62 75 74 20 77 69 74 68 20 65 69  name but with ei
34820 74 68 65 72 20 64 69 66 66 65 72 69 6e 67 20 6e  ther differing n
34830 75 6d 62 65 72 73 20 6f 66 0a 2a 2a 20 61 72 67  umbers of.** arg
34840 75 6d 65 6e 74 73 20 6f 72 20 64 69 66 66 65 72  uments or differ
34850 69 6e 67 20 70 72 65 66 65 72 72 65 64 20 74 65  ing preferred te
34860 78 74 20 65 6e 63 6f 64 69 6e 67 73 2e 20 20 5e  xt encodings.  ^
34870 53 51 4c 69 74 65 20 77 69 6c 6c 20 75 73 65 0a  SQLite will use.
34880 2a 2a 20 74 68 65 20 69 6d 70 6c 65 6d 65 6e 74  ** the implement
34890 61 74 69 6f 6e 20 74 68 61 74 20 6d 6f 73 74 20  ation that most 
348a0 63 6c 6f 73 65 6c 79 20 6d 61 74 63 68 65 73 20  closely matches 
348b0 74 68 65 20 77 61 79 20 69 6e 20 77 68 69 63 68  the way in which
348c0 20 74 68 65 0a 2a 2a 20 53 51 4c 20 66 75 6e 63   the.** SQL func
348d0 74 69 6f 6e 20 69 73 20 75 73 65 64 2e 20 20 5e  tion is used.  ^
348e0 41 20 66 75 6e 63 74 69 6f 6e 20 69 6d 70 6c 65  A function imple
348f0 6d 65 6e 74 61 74 69 6f 6e 20 77 69 74 68 20 61  mentation with a
34900 20 6e 6f 6e 2d 6e 65 67 61 74 69 76 65 0a 2a 2a   non-negative.**
34910 20 6e 41 72 67 20 70 61 72 61 6d 65 74 65 72 20   nArg parameter 
34920 69 73 20 61 20 62 65 74 74 65 72 20 6d 61 74 63  is a better matc
34930 68 20 74 68 61 6e 20 61 20 66 75 6e 63 74 69 6f  h than a functio
34940 6e 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  n implementation
34950 20 77 69 74 68 0a 2a 2a 20 61 20 6e 65 67 61 74   with.** a negat
34960 69 76 65 20 6e 41 72 67 2e 20 20 5e 41 20 66 75  ive nArg.  ^A fu
34970 6e 63 74 69 6f 6e 20 77 68 65 72 65 20 74 68 65  nction where the
34980 20 70 72 65 66 65 72 72 65 64 20 74 65 78 74 20   preferred text 
34990 65 6e 63 6f 64 69 6e 67 0a 2a 2a 20 6d 61 74 63  encoding.** matc
349a0 68 65 73 20 74 68 65 20 64 61 74 61 62 61 73 65  hes the database
349b0 20 65 6e 63 6f 64 69 6e 67 20 69 73 20 61 20 62   encoding is a b
349c0 65 74 74 65 72 0a 2a 2a 20 6d 61 74 63 68 20 74  etter.** match t
349d0 68 61 6e 20 61 20 66 75 6e 63 74 69 6f 6e 20 77  han a function w
349e0 68 65 72 65 20 74 68 65 20 65 6e 63 6f 64 69 6e  here the encodin
349f0 67 20 69 73 20 64 69 66 66 65 72 65 6e 74 2e 20  g is different. 
34a00 20 0a 2a 2a 20 5e 41 20 66 75 6e 63 74 69 6f 6e   .** ^A function
34a10 20 77 68 65 72 65 20 74 68 65 20 65 6e 63 6f 64   where the encod
34a20 69 6e 67 20 64 69 66 66 65 72 65 6e 63 65 20 69  ing difference i
34a30 73 20 62 65 74 77 65 65 6e 20 55 54 46 31 36 6c  s between UTF16l
34a40 65 20 61 6e 64 20 55 54 46 31 36 62 65 0a 2a 2a  e and UTF16be.**
34a50 20 69 73 20 61 20 63 6c 6f 73 65 72 20 6d 61 74   is a closer mat
34a60 63 68 20 74 68 61 6e 20 61 20 66 75 6e 63 74 69  ch than a functi
34a70 6f 6e 20 77 68 65 72 65 20 74 68 65 20 65 6e 63  on where the enc
34a80 6f 64 69 6e 67 20 64 69 66 66 65 72 65 6e 63 65  oding difference
34a90 20 69 73 0a 2a 2a 20 62 65 74 77 65 65 6e 20 55   is.** between U
34aa0 54 46 38 20 61 6e 64 20 55 54 46 31 36 2e 0a 2a  TF8 and UTF16..*
34ab0 2a 0a 2a 2a 20 5e 42 75 69 6c 74 2d 69 6e 20 66  *.** ^Built-in f
34ac0 75 6e 63 74 69 6f 6e 73 20 6d 61 79 20 62 65 20  unctions may be 
34ad0 6f 76 65 72 6c 6f 61 64 65 64 20 62 79 20 6e 65  overloaded by ne
34ae0 77 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65  w application-de
34af0 66 69 6e 65 64 20 66 75 6e 63 74 69 6f 6e 73 2e  fined functions.
34b00 0a 2a 2a 0a 2a 2a 20 5e 41 6e 20 61 70 70 6c 69  .**.** ^An appli
34b10 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 66  cation-defined f
34b20 75 6e 63 74 69 6f 6e 20 69 73 20 70 65 72 6d 69  unction is permi
34b30 74 74 65 64 20 74 6f 20 63 61 6c 6c 20 6f 74 68  tted to call oth
34b40 65 72 0a 2a 2a 20 53 51 4c 69 74 65 20 69 6e 74  er.** SQLite int
34b50 65 72 66 61 63 65 73 2e 20 20 48 6f 77 65 76 65  erfaces.  Howeve
34b60 72 2c 20 73 75 63 68 20 63 61 6c 6c 73 20 6d 75  r, such calls mu
34b70 73 74 20 6e 6f 74 0a 2a 2a 20 63 6c 6f 73 65 20  st not.** close 
34b80 74 68 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e  the database con
34b90 6e 65 63 74 69 6f 6e 20 6e 6f 72 20 66 69 6e 61  nection nor fina
34ba0 6c 69 7a 65 20 6f 72 20 72 65 73 65 74 20 74 68  lize or reset th
34bb0 65 20 70 72 65 70 61 72 65 64 0a 2a 2a 20 73 74  e prepared.** st
34bc0 61 74 65 6d 65 6e 74 20 69 6e 20 77 68 69 63 68  atement in which
34bd0 20 74 68 65 20 66 75 6e 63 74 69 6f 6e 20 69 73   the function is
34be0 20 72 75 6e 6e 69 6e 67 2e 0a 2a 2f 0a 69 6e 74   running..*/.int
34bf0 20 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f   sqlite3_create_
34c00 66 75 6e 63 74 69 6f 6e 28 0a 20 20 73 71 6c 69  function(.  sqli
34c10 74 65 33 20 2a 64 62 2c 0a 20 20 63 6f 6e 73 74  te3 *db,.  const
34c20 20 63 68 61 72 20 2a 7a 46 75 6e 63 74 69 6f 6e   char *zFunction
34c30 4e 61 6d 65 2c 0a 20 20 69 6e 74 20 6e 41 72 67  Name,.  int nArg
34c40 2c 0a 20 20 69 6e 74 20 65 54 65 78 74 52 65 70  ,.  int eTextRep
34c50 2c 0a 20 20 76 6f 69 64 20 2a 70 41 70 70 2c 0a  ,.  void *pApp,.
34c60 20 20 76 6f 69 64 20 28 2a 78 46 75 6e 63 29 28    void (*xFunc)(
34c70 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a  sqlite3_context*
34c80 2c 69 6e 74 2c 73 71 6c 69 74 65 33 5f 76 61 6c  ,int,sqlite3_val
34c90 75 65 2a 2a 29 2c 0a 20 20 76 6f 69 64 20 28 2a  ue**),.  void (*
34ca0 78 53 74 65 70 29 28 73 71 6c 69 74 65 33 5f 63  xStep)(sqlite3_c
34cb0 6f 6e 74 65 78 74 2a 2c 69 6e 74 2c 73 71 6c 69  ontext*,int,sqli
34cc0 74 65 33 5f 76 61 6c 75 65 2a 2a 29 2c 0a 20 20  te3_value**),.  
34cd0 76 6f 69 64 20 28 2a 78 46 69 6e 61 6c 29 28 73  void (*xFinal)(s
34ce0 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 29  qlite3_context*)
34cf0 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .);.int sqlite3_
34d00 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 31  create_function1
34d10 36 28 0a 20 20 73 71 6c 69 74 65 33 20 2a 64 62  6(.  sqlite3 *db
34d20 2c 0a 20 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a  ,.  const void *
34d30 7a 46 75 6e 63 74 69 6f 6e 4e 61 6d 65 2c 0a 20  zFunctionName,. 
34d40 20 69 6e 74 20 6e 41 72 67 2c 0a 20 20 69 6e 74   int nArg,.  int
34d50 20 65 54 65 78 74 52 65 70 2c 0a 20 20 76 6f 69   eTextRep,.  voi
34d60 64 20 2a 70 41 70 70 2c 0a 20 20 76 6f 69 64 20  d *pApp,.  void 
34d70 28 2a 78 46 75 6e 63 29 28 73 71 6c 69 74 65 33  (*xFunc)(sqlite3
34d80 5f 63 6f 6e 74 65 78 74 2a 2c 69 6e 74 2c 73 71  _context*,int,sq
34d90 6c 69 74 65 33 5f 76 61 6c 75 65 2a 2a 29 2c 0a  lite3_value**),.
34da0 20 20 76 6f 69 64 20 28 2a 78 53 74 65 70 29 28    void (*xStep)(
34db0 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a  sqlite3_context*
34dc0 2c 69 6e 74 2c 73 71 6c 69 74 65 33 5f 76 61 6c  ,int,sqlite3_val
34dd0 75 65 2a 2a 29 2c 0a 20 20 76 6f 69 64 20 28 2a  ue**),.  void (*
34de0 78 46 69 6e 61 6c 29 28 73 71 6c 69 74 65 33 5f  xFinal)(sqlite3_
34df0 63 6f 6e 74 65 78 74 2a 29 0a 29 3b 0a 69 6e 74  context*).);.int
34e00 20 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f   sqlite3_create_
34e10 66 75 6e 63 74 69 6f 6e 5f 76 32 28 0a 20 20 73  function_v2(.  s
34e20 71 6c 69 74 65 33 20 2a 64 62 2c 0a 20 20 63 6f  qlite3 *db,.  co
34e30 6e 73 74 20 63 68 61 72 20 2a 7a 46 75 6e 63 74  nst char *zFunct
34e40 69 6f 6e 4e 61 6d 65 2c 0a 20 20 69 6e 74 20 6e  ionName,.  int n
34e50 41 72 67 2c 0a 20 20 69 6e 74 20 65 54 65 78 74  Arg,.  int eText
34e60 52 65 70 2c 0a 20 20 76 6f 69 64 20 2a 70 41 70  Rep,.  void *pAp
34e70 70 2c 0a 20 20 76 6f 69 64 20 28 2a 78 46 75 6e  p,.  void (*xFun
34e80 63 29 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65  c)(sqlite3_conte
34e90 78 74 2a 2c 69 6e 74 2c 73 71 6c 69 74 65 33 5f  xt*,int,sqlite3_
34ea0 76 61 6c 75 65 2a 2a 29 2c 0a 20 20 76 6f 69 64  value**),.  void
34eb0 20 28 2a 78 53 74 65 70 29 28 73 71 6c 69 74 65   (*xStep)(sqlite
34ec0 33 5f 63 6f 6e 74 65 78 74 2a 2c 69 6e 74 2c 73  3_context*,int,s
34ed0 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 2a 29 2c  qlite3_value**),
34ee0 0a 20 20 76 6f 69 64 20 28 2a 78 46 69 6e 61 6c  .  void (*xFinal
34ef0 29 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78  )(sqlite3_contex
34f00 74 2a 29 2c 0a 20 20 76 6f 69 64 28 2a 78 44 65  t*),.  void(*xDe
34f10 73 74 72 6f 79 29 28 76 6f 69 64 2a 29 0a 29 3b  stroy)(void*).);
34f20 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
34f30 3a 20 54 65 78 74 20 45 6e 63 6f 64 69 6e 67 73  : Text Encodings
34f40 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 63 6f 6e  .**.** These con
34f50 73 74 61 6e 74 20 64 65 66 69 6e 65 20 69 6e 74  stant define int
34f60 65 67 65 72 20 63 6f 64 65 73 20 74 68 61 74 20  eger codes that 
34f70 72 65 70 72 65 73 65 6e 74 20 74 68 65 20 76 61  represent the va
34f80 72 69 6f 75 73 0a 2a 2a 20 74 65 78 74 20 65 6e  rious.** text en
34f90 63 6f 64 69 6e 67 73 20 73 75 70 70 6f 72 74 65  codings supporte
34fa0 64 20 62 79 20 53 51 4c 69 74 65 2e 0a 2a 2f 0a  d by SQLite..*/.
34fb0 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 55  #define SQLITE_U
34fc0 54 46 38 20 20 20 20 20 20 20 20 20 20 20 31 20  TF8           1 
34fd0 20 20 20 2f 2a 20 49 4d 50 3a 20 52 2d 33 37 35     /* IMP: R-375
34fe0 31 34 2d 33 35 35 36 36 20 2a 2f 0a 23 64 65 66  14-35566 */.#def
34ff0 69 6e 65 20 53 51 4c 49 54 45 5f 55 54 46 31 36  ine SQLITE_UTF16
35000 4c 45 20 20 20 20 20 20 20 20 32 20 20 20 20 2f  LE        2    /
35010 2a 20 49 4d 50 3a 20 52 2d 30 33 33 37 31 2d 33  * IMP: R-03371-3
35020 37 36 33 37 20 2a 2f 0a 23 64 65 66 69 6e 65 20  7637 */.#define 
35030 53 51 4c 49 54 45 5f 55 54 46 31 36 42 45 20 20  SQLITE_UTF16BE  
35040 20 20 20 20 20 20 33 20 20 20 20 2f 2a 20 49 4d        3    /* IM
35050 50 3a 20 52 2d 35 31 39 37 31 2d 33 34 31 35 34  P: R-51971-34154
35060 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
35070 54 45 5f 55 54 46 31 36 20 20 20 20 20 20 20 20  TE_UTF16        
35080 20 20 34 20 20 20 20 2f 2a 20 55 73 65 20 6e 61    4    /* Use na
35090 74 69 76 65 20 62 79 74 65 20 6f 72 64 65 72 20  tive byte order 
350a0 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
350b0 45 5f 41 4e 59 20 20 20 20 20 20 20 20 20 20 20  E_ANY           
350c0 20 35 20 20 20 20 2f 2a 20 44 65 70 72 65 63 61   5    /* Depreca
350d0 74 65 64 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ted */.#define S
350e0 51 4c 49 54 45 5f 55 54 46 31 36 5f 41 4c 49 47  QLITE_UTF16_ALIG
350f0 4e 45 44 20 20 38 20 20 20 20 2f 2a 20 73 71 6c  NED  8    /* sql
35100 69 74 65 33 5f 63 72 65 61 74 65 5f 63 6f 6c 6c  ite3_create_coll
35110 61 74 69 6f 6e 20 6f 6e 6c 79 20 2a 2f 0a 0a 2f  ation only */../
35120 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 46  *.** CAPI3REF: F
35130 75 6e 63 74 69 6f 6e 20 46 6c 61 67 73 0a 2a 2a  unction Flags.**
35140 0a 2a 2a 20 54 68 65 73 65 20 63 6f 6e 73 74 61  .** These consta
35150 6e 74 73 20 6d 61 79 20 62 65 20 4f 52 65 64 20  nts may be ORed 
35160 74 6f 67 65 74 68 65 72 20 77 69 74 68 20 74 68  together with th
35170 65 20 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 55 54  e .** [SQLITE_UT
35180 46 38 20 7c 20 70 72 65 66 65 72 72 65 64 20 74  F8 | preferred t
35190 65 78 74 20 65 6e 63 6f 64 69 6e 67 5d 20 61 73  ext encoding] as
351a0 20 74 68 65 20 66 6f 75 72 74 68 20 61 72 67 75   the fourth argu
351b0 6d 65 6e 74 0a 2a 2a 20 74 6f 20 5b 73 71 6c 69  ment.** to [sqli
351c0 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74  te3_create_funct
351d0 69 6f 6e 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33  ion()], [sqlite3
351e0 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e  _create_function
351f0 31 36 28 29 5d 2c 20 6f 72 0a 2a 2a 20 5b 73 71  16()], or.** [sq
35200 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e  lite3_create_fun
35210 63 74 69 6f 6e 5f 76 32 28 29 5d 2e 0a 2a 2f 0a  ction_v2()]..*/.
35220 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 44  #define SQLITE_D
35230 45 54 45 52 4d 49 4e 49 53 54 49 43 20 20 20 20  ETERMINISTIC    
35240 30 78 38 30 30 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  0x800../*.** CAP
35250 49 33 52 45 46 3a 20 44 65 70 72 65 63 61 74 65  I3REF: Deprecate
35260 64 20 46 75 6e 63 74 69 6f 6e 73 0a 2a 2a 20 44  d Functions.** D
35270 45 50 52 45 43 41 54 45 44 0a 2a 2a 0a 2a 2a 20  EPRECATED.**.** 
35280 54 68 65 73 65 20 66 75 6e 63 74 69 6f 6e 73 20  These functions 
35290 61 72 65 20 5b 64 65 70 72 65 63 61 74 65 64 5d  are [deprecated]
352a0 2e 20 20 49 6e 20 6f 72 64 65 72 20 74 6f 20 6d  .  In order to m
352b0 61 69 6e 74 61 69 6e 0a 2a 2a 20 62 61 63 6b 77  aintain.** backw
352c0 61 72 64 73 20 63 6f 6d 70 61 74 69 62 69 6c 69  ards compatibili
352d0 74 79 20 77 69 74 68 20 6f 6c 64 65 72 20 63 6f  ty with older co
352e0 64 65 2c 20 74 68 65 73 65 20 66 75 6e 63 74 69  de, these functi
352f0 6f 6e 73 20 63 6f 6e 74 69 6e 75 65 20 0a 2a 2a  ons continue .**
35300 20 74 6f 20 62 65 20 73 75 70 70 6f 72 74 65 64   to be supported
35310 2e 20 20 48 6f 77 65 76 65 72 2c 20 6e 65 77 20  .  However, new 
35320 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 73 68 6f  applications sho
35330 75 6c 64 20 61 76 6f 69 64 0a 2a 2a 20 74 68 65  uld avoid.** the
35340 20 75 73 65 20 6f 66 20 74 68 65 73 65 20 66 75   use of these fu
35350 6e 63 74 69 6f 6e 73 2e 20 20 54 6f 20 65 6e 63  nctions.  To enc
35360 6f 75 72 61 67 65 20 70 72 6f 67 72 61 6d 6d 65  ourage programme
35370 72 73 20 74 6f 20 61 76 6f 69 64 0a 2a 2a 20 74  rs to avoid.** t
35380 68 65 73 65 20 66 75 6e 63 74 69 6f 6e 73 2c 20  hese functions, 
35390 77 65 20 77 69 6c 6c 20 6e 6f 74 20 65 78 70 6c  we will not expl
353a0 61 69 6e 20 77 68 61 74 20 74 68 65 79 20 64 6f  ain what they do
353b0 2e 0a 2a 2f 0a 23 69 66 6e 64 65 66 20 53 51 4c  ..*/.#ifndef SQL
353c0 49 54 45 5f 4f 4d 49 54 5f 44 45 50 52 45 43 41  ITE_OMIT_DEPRECA
353d0 54 45 44 0a 53 51 4c 49 54 45 5f 44 45 50 52 45  TED.SQLITE_DEPRE
353e0 43 41 54 45 44 20 69 6e 74 20 73 71 6c 69 74 65  CATED int sqlite
353f0 33 5f 61 67 67 72 65 67 61 74 65 5f 63 6f 75 6e  3_aggregate_coun
35400 74 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78  t(sqlite3_contex
35410 74 2a 29 3b 0a 53 51 4c 49 54 45 5f 44 45 50 52  t*);.SQLITE_DEPR
35420 45 43 41 54 45 44 20 69 6e 74 20 73 71 6c 69 74  ECATED int sqlit
35430 65 33 5f 65 78 70 69 72 65 64 28 73 71 6c 69 74  e3_expired(sqlit
35440 65 33 5f 73 74 6d 74 2a 29 3b 0a 53 51 4c 49 54  e3_stmt*);.SQLIT
35450 45 5f 44 45 50 52 45 43 41 54 45 44 20 69 6e 74  E_DEPRECATED int
35460 20 73 71 6c 69 74 65 33 5f 74 72 61 6e 73 66 65   sqlite3_transfe
35470 72 5f 62 69 6e 64 69 6e 67 73 28 73 71 6c 69 74  r_bindings(sqlit
35480 65 33 5f 73 74 6d 74 2a 2c 20 73 71 6c 69 74 65  e3_stmt*, sqlite
35490 33 5f 73 74 6d 74 2a 29 3b 0a 53 51 4c 49 54 45  3_stmt*);.SQLITE
354a0 5f 44 45 50 52 45 43 41 54 45 44 20 69 6e 74 20  _DEPRECATED int 
354b0 73 71 6c 69 74 65 33 5f 67 6c 6f 62 61 6c 5f 72  sqlite3_global_r
354c0 65 63 6f 76 65 72 28 76 6f 69 64 29 3b 0a 53 51  ecover(void);.SQ
354d0 4c 49 54 45 5f 44 45 50 52 45 43 41 54 45 44 20  LITE_DEPRECATED 
354e0 76 6f 69 64 20 73 71 6c 69 74 65 33 5f 74 68 72  void sqlite3_thr
354f0 65 61 64 5f 63 6c 65 61 6e 75 70 28 76 6f 69 64  ead_cleanup(void
35500 29 3b 0a 53 51 4c 49 54 45 5f 44 45 50 52 45 43  );.SQLITE_DEPREC
35510 41 54 45 44 20 69 6e 74 20 73 71 6c 69 74 65 33  ATED int sqlite3
35520 5f 6d 65 6d 6f 72 79 5f 61 6c 61 72 6d 28 76 6f  _memory_alarm(vo
35530 69 64 28 2a 29 28 76 6f 69 64 2a 2c 73 71 6c 69  id(*)(void*,sqli
35540 74 65 33 5f 69 6e 74 36 34 2c 69 6e 74 29 2c 0a  te3_int64,int),.
35550 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
35560 20 20 20 20 20 20 76 6f 69 64 2a 2c 73 71 6c 69        void*,sqli
35570 74 65 33 5f 69 6e 74 36 34 29 3b 0a 23 65 6e 64  te3_int64);.#end
35580 69 66 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  if../*.** CAPI3R
35590 45 46 3a 20 4f 62 74 61 69 6e 69 6e 67 20 53 51  EF: Obtaining SQ
355a0 4c 20 56 61 6c 75 65 73 0a 2a 2a 20 4d 45 54 48  L Values.** METH
355b0 4f 44 3a 20 73 71 6c 69 74 65 33 5f 76 61 6c 75  OD: sqlite3_valu
355c0 65 0a 2a 2a 0a 2a 2a 20 54 68 65 20 43 2d 6c 61  e.**.** The C-la
355d0 6e 67 75 61 67 65 20 69 6d 70 6c 65 6d 65 6e 74  nguage implement
355e0 61 74 69 6f 6e 20 6f 66 20 53 51 4c 20 66 75 6e  ation of SQL fun
355f0 63 74 69 6f 6e 73 20 61 6e 64 20 61 67 67 72 65  ctions and aggre
35600 67 61 74 65 73 20 75 73 65 73 0a 2a 2a 20 74 68  gates uses.** th
35610 69 73 20 73 65 74 20 6f 66 20 69 6e 74 65 72 66  is set of interf
35620 61 63 65 20 72 6f 75 74 69 6e 65 73 20 74 6f 20  ace routines to 
35630 61 63 63 65 73 73 20 74 68 65 20 70 61 72 61 6d  access the param
35640 65 74 65 72 20 76 61 6c 75 65 73 20 6f 6e 0a 2a  eter values on.*
35650 2a 20 74 68 65 20 66 75 6e 63 74 69 6f 6e 20 6f  * the function o
35660 72 20 61 67 67 72 65 67 61 74 65 2e 20 20 0a 2a  r aggregate.  .*
35670 2a 0a 2a 2a 20 54 68 65 20 78 46 75 6e 63 20 28  *.** The xFunc (
35680 66 6f 72 20 73 63 61 6c 61 72 20 66 75 6e 63 74  for scalar funct
35690 69 6f 6e 73 29 20 6f 72 20 78 53 74 65 70 20 28  ions) or xStep (
356a0 66 6f 72 20 61 67 67 72 65 67 61 74 65 73 29 20  for aggregates) 
356b0 70 61 72 61 6d 65 74 65 72 73 0a 2a 2a 20 74 6f  parameters.** to
356c0 20 5b 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65   [sqlite3_create
356d0 5f 66 75 6e 63 74 69 6f 6e 28 29 5d 20 61 6e 64  _function()] and
356e0 20 5b 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65   [sqlite3_create
356f0 5f 66 75 6e 63 74 69 6f 6e 31 36 28 29 5d 0a 2a  _function16()].*
35700 2a 20 64 65 66 69 6e 65 20 63 61 6c 6c 62 61 63  * define callbac
35710 6b 73 20 74 68 61 74 20 69 6d 70 6c 65 6d 65 6e  ks that implemen
35720 74 20 74 68 65 20 53 51 4c 20 66 75 6e 63 74 69  t the SQL functi
35730 6f 6e 73 20 61 6e 64 20 61 67 67 72 65 67 61 74  ons and aggregat
35740 65 73 2e 0a 2a 2a 20 54 68 65 20 33 72 64 20 70  es..** The 3rd p
35750 61 72 61 6d 65 74 65 72 20 74 6f 20 74 68 65 73  arameter to thes
35760 65 20 63 61 6c 6c 62 61 63 6b 73 20 69 73 20 61  e callbacks is a
35770 6e 20 61 72 72 61 79 20 6f 66 20 70 6f 69 6e 74  n array of point
35780 65 72 73 20 74 6f 0a 2a 2a 20 5b 70 72 6f 74 65  ers to.** [prote
35790 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c  cted sqlite3_val
357a0 75 65 5d 20 6f 62 6a 65 63 74 73 2e 20 20 54 68  ue] objects.  Th
357b0 65 72 65 20 69 73 20 6f 6e 65 20 5b 73 71 6c 69  ere is one [sqli
357c0 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62 6a 65 63  te3_value] objec
357d0 74 20 66 6f 72 0a 2a 2a 20 65 61 63 68 20 70 61  t for.** each pa
357e0 72 61 6d 65 74 65 72 20 74 6f 20 74 68 65 20 53  rameter to the S
357f0 51 4c 20 66 75 6e 63 74 69 6f 6e 2e 20 20 54 68  QL function.  Th
35800 65 73 65 20 72 6f 75 74 69 6e 65 73 20 61 72 65  ese routines are
35810 20 75 73 65 64 20 74 6f 0a 2a 2a 20 65 78 74 72   used to.** extr
35820 61 63 74 20 76 61 6c 75 65 73 20 66 72 6f 6d 20  act values from 
35830 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c  the [sqlite3_val
35840 75 65 5d 20 6f 62 6a 65 63 74 73 2e 0a 2a 2a 0a  ue] objects..**.
35850 2a 2a 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65  ** These routine
35860 73 20 77 6f 72 6b 20 6f 6e 6c 79 20 77 69 74 68  s work only with
35870 20 5b 70 72 6f 74 65 63 74 65 64 20 73 71 6c 69   [protected sqli
35880 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62 6a 65 63  te3_value] objec
35890 74 73 2e 0a 2a 2a 20 41 6e 79 20 61 74 74 65 6d  ts..** Any attem
358a0 70 74 20 74 6f 20 75 73 65 20 74 68 65 73 65 20  pt to use these 
358b0 72 6f 75 74 69 6e 65 73 20 6f 6e 20 61 6e 20 5b  routines on an [
358c0 75 6e 70 72 6f 74 65 63 74 65 64 20 73 71 6c 69  unprotected sqli
358d0 74 65 33 5f 76 61 6c 75 65 5d 0a 2a 2a 20 6f 62  te3_value].** ob
358e0 6a 65 63 74 20 72 65 73 75 6c 74 73 20 69 6e 20  ject results in 
358f0 75 6e 64 65 66 69 6e 65 64 20 62 65 68 61 76 69  undefined behavi
35900 6f 72 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 73 65  or..**.** ^These
35910 20 72 6f 75 74 69 6e 65 73 20 77 6f 72 6b 20 6a   routines work j
35920 75 73 74 20 6c 69 6b 65 20 74 68 65 20 63 6f 72  ust like the cor
35930 72 65 73 70 6f 6e 64 69 6e 67 20 5b 63 6f 6c 75  responding [colu
35940 6d 6e 20 61 63 63 65 73 73 20 66 75 6e 63 74 69  mn access functi
35950 6f 6e 73 5d 0a 2a 2a 20 65 78 63 65 70 74 20 74  ons].** except t
35960 68 61 74 20 74 68 65 73 65 20 72 6f 75 74 69 6e  hat these routin
35970 65 73 20 74 61 6b 65 20 61 20 73 69 6e 67 6c 65  es take a single
35980 20 5b 70 72 6f 74 65 63 74 65 64 20 73 71 6c 69   [protected sqli
35990 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62 6a 65 63  te3_value] objec
359a0 74 0a 2a 2a 20 70 6f 69 6e 74 65 72 20 69 6e 73  t.** pointer ins
359b0 74 65 61 64 20 6f 66 20 61 20 5b 73 71 6c 69 74  tead of a [sqlit
359c0 65 33 5f 73 74 6d 74 2a 5d 20 70 6f 69 6e 74 65  e3_stmt*] pointe
359d0 72 20 61 6e 64 20 61 6e 20 69 6e 74 65 67 65 72  r and an integer
359e0 20 63 6f 6c 75 6d 6e 20 6e 75 6d 62 65 72 2e 0a   column number..
359f0 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  **.** ^The sqlit
35a00 65 33 5f 76 61 6c 75 65 5f 74 65 78 74 31 36 28  e3_value_text16(
35a10 29 20 69 6e 74 65 72 66 61 63 65 20 65 78 74 72  ) interface extr
35a20 61 63 74 73 20 61 20 55 54 46 2d 31 36 20 73 74  acts a UTF-16 st
35a30 72 69 6e 67 0a 2a 2a 20 69 6e 20 74 68 65 20 6e  ring.** in the n
35a40 61 74 69 76 65 20 62 79 74 65 2d 6f 72 64 65 72  ative byte-order
35a50 20 6f 66 20 74 68 65 20 68 6f 73 74 20 6d 61 63   of the host mac
35a60 68 69 6e 65 2e 20 20 5e 54 68 65 0a 2a 2a 20 73  hine.  ^The.** s
35a70 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 65 78  qlite3_value_tex
35a80 74 31 36 62 65 28 29 20 61 6e 64 20 73 71 6c 69  t16be() and sqli
35a90 74 65 33 5f 76 61 6c 75 65 5f 74 65 78 74 31 36  te3_value_text16
35aa0 6c 65 28 29 20 69 6e 74 65 72 66 61 63 65 73 0a  le() interfaces.
35ab0 2a 2a 20 65 78 74 72 61 63 74 20 55 54 46 2d 31  ** extract UTF-1
35ac0 36 20 73 74 72 69 6e 67 73 20 61 73 20 62 69 67  6 strings as big
35ad0 2d 65 6e 64 69 61 6e 20 61 6e 64 20 6c 69 74 74  -endian and litt
35ae0 6c 65 2d 65 6e 64 69 61 6e 20 72 65 73 70 65 63  le-endian respec
35af0 74 69 76 65 6c 79 2e 0a 2a 2a 0a 2a 2a 20 5e 28  tively..**.** ^(
35b00 54 68 65 20 73 71 6c 69 74 65 33 5f 76 61 6c 75  The sqlite3_valu
35b10 65 5f 6e 75 6d 65 72 69 63 5f 74 79 70 65 28 29  e_numeric_type()
35b20 20 69 6e 74 65 72 66 61 63 65 20 61 74 74 65 6d   interface attem
35b30 70 74 73 20 74 6f 20 61 70 70 6c 79 0a 2a 2a 20  pts to apply.** 
35b40 6e 75 6d 65 72 69 63 20 61 66 66 69 6e 69 74 79  numeric affinity
35b50 20 74 6f 20 74 68 65 20 76 61 6c 75 65 2e 20 20   to the value.  
35b60 54 68 69 73 20 6d 65 61 6e 73 20 74 68 61 74 20  This means that 
35b70 61 6e 20 61 74 74 65 6d 70 74 20 69 73 0a 2a 2a  an attempt is.**
35b80 20 6d 61 64 65 20 74 6f 20 63 6f 6e 76 65 72 74   made to convert
35b90 20 74 68 65 20 76 61 6c 75 65 20 74 6f 20 61 6e   the value to an
35ba0 20 69 6e 74 65 67 65 72 20 6f 72 20 66 6c 6f 61   integer or floa
35bb0 74 69 6e 67 20 70 6f 69 6e 74 2e 20 20 49 66 0a  ting point.  If.
35bc0 2a 2a 20 73 75 63 68 20 61 20 63 6f 6e 76 65 72  ** such a conver
35bd0 73 69 6f 6e 20 69 73 20 70 6f 73 73 69 62 6c 65  sion is possible
35be0 20 77 69 74 68 6f 75 74 20 6c 6f 73 73 20 6f 66   without loss of
35bf0 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 28 69 6e   information (in
35c00 20 6f 74 68 65 72 0a 2a 2a 20 77 6f 72 64 73 2c   other.** words,
35c10 20 69 66 20 74 68 65 20 76 61 6c 75 65 20 69 73   if the value is
35c20 20 61 20 73 74 72 69 6e 67 20 74 68 61 74 20 6c   a string that l
35c30 6f 6f 6b 73 20 6c 69 6b 65 20 61 20 6e 75 6d 62  ooks like a numb
35c40 65 72 29 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20  er).** then the 
35c50 63 6f 6e 76 65 72 73 69 6f 6e 20 69 73 20 70 65  conversion is pe
35c60 72 66 6f 72 6d 65 64 2e 20 20 4f 74 68 65 72 77  rformed.  Otherw
35c70 69 73 65 20 6e 6f 20 63 6f 6e 76 65 72 73 69 6f  ise no conversio
35c80 6e 20 6f 63 63 75 72 73 2e 0a 2a 2a 20 54 68 65  n occurs..** The
35c90 20 5b 53 51 4c 49 54 45 5f 49 4e 54 45 47 45 52   [SQLITE_INTEGER
35ca0 20 7c 20 64 61 74 61 74 79 70 65 5d 20 61 66 74   | datatype] aft
35cb0 65 72 20 63 6f 6e 76 65 72 73 69 6f 6e 20 69 73  er conversion is
35cc0 20 72 65 74 75 72 6e 65 64 2e 29 5e 0a 2a 2a 0a   returned.)^.**.
35cd0 2a 2a 20 50 6c 65 61 73 65 20 70 61 79 20 70 61  ** Please pay pa
35ce0 72 74 69 63 75 6c 61 72 20 61 74 74 65 6e 74 69  rticular attenti
35cf0 6f 6e 20 74 6f 20 74 68 65 20 66 61 63 74 20 74  on to the fact t
35d00 68 61 74 20 74 68 65 20 70 6f 69 6e 74 65 72 20  hat the pointer 
35d10 72 65 74 75 72 6e 65 64 0a 2a 2a 20 66 72 6f 6d  returned.** from
35d20 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f   [sqlite3_value_
35d30 62 6c 6f 62 28 29 5d 2c 20 5b 73 71 6c 69 74 65  blob()], [sqlite
35d40 33 5f 76 61 6c 75 65 5f 74 65 78 74 28 29 5d 2c  3_value_text()],
35d50 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f   or.** [sqlite3_
35d60 76 61 6c 75 65 5f 74 65 78 74 31 36 28 29 5d 20  value_text16()] 
35d70 63 61 6e 20 62 65 20 69 6e 76 61 6c 69 64 61 74  can be invalidat
35d80 65 64 20 62 79 20 61 20 73 75 62 73 65 71 75 65  ed by a subseque
35d90 6e 74 20 63 61 6c 6c 20 74 6f 0a 2a 2a 20 5b 73  nt call to.** [s
35da0 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 62 79 74  qlite3_value_byt
35db0 65 73 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f  es()], [sqlite3_
35dc0 76 61 6c 75 65 5f 62 79 74 65 73 31 36 28 29 5d  value_bytes16()]
35dd0 2c 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  , [sqlite3_value
35de0 5f 74 65 78 74 28 29 5d 2c 0a 2a 2a 20 6f 72 20  _text()],.** or 
35df0 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74  [sqlite3_value_t
35e00 65 78 74 31 36 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20  ext16()]..**.** 
35e10 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 6d  These routines m
35e20 75 73 74 20 62 65 20 63 61 6c 6c 65 64 20 66 72  ust be called fr
35e30 6f 6d 20 74 68 65 20 73 61 6d 65 20 74 68 72 65  om the same thre
35e40 61 64 20 61 73 0a 2a 2a 20 74 68 65 20 53 51 4c  ad as.** the SQL
35e50 20 66 75 6e 63 74 69 6f 6e 20 74 68 61 74 20 73   function that s
35e60 75 70 70 6c 69 65 64 20 74 68 65 20 5b 73 71 6c  upplied the [sql
35e70 69 74 65 33 5f 76 61 6c 75 65 2a 5d 20 70 61 72  ite3_value*] par
35e80 61 6d 65 74 65 72 73 2e 0a 2a 2f 0a 63 6f 6e 73  ameters..*/.cons
35e90 74 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f  t void *sqlite3_
35ea0 76 61 6c 75 65 5f 62 6c 6f 62 28 73 71 6c 69 74  value_blob(sqlit
35eb0 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 69 6e 74 20  e3_value*);.int 
35ec0 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 62 79  sqlite3_value_by
35ed0 74 65 73 28 73 71 6c 69 74 65 33 5f 76 61 6c 75  tes(sqlite3_valu
35ee0 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  e*);.int sqlite3
35ef0 5f 76 61 6c 75 65 5f 62 79 74 65 73 31 36 28 73  _value_bytes16(s
35f00 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a  qlite3_value*);.
35f10 64 6f 75 62 6c 65 20 73 71 6c 69 74 65 33 5f 76  double sqlite3_v
35f20 61 6c 75 65 5f 64 6f 75 62 6c 65 28 73 71 6c 69  alue_double(sqli
35f30 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 69 6e 74  te3_value*);.int
35f40 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 69   sqlite3_value_i
35f50 6e 74 28 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  nt(sqlite3_value
35f60 2a 29 3b 0a 73 71 6c 69 74 65 33 5f 69 6e 74 36  *);.sqlite3_int6
35f70 34 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f  4 sqlite3_value_
35f80 69 6e 74 36 34 28 73 71 6c 69 74 65 33 5f 76 61  int64(sqlite3_va
35f90 6c 75 65 2a 29 3b 0a 63 6f 6e 73 74 20 75 6e 73  lue*);.const uns
35fa0 69 67 6e 65 64 20 63 68 61 72 20 2a 73 71 6c 69  igned char *sqli
35fb0 74 65 33 5f 76 61 6c 75 65 5f 74 65 78 74 28 73  te3_value_text(s
35fc0 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a  qlite3_value*);.
35fd0 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c 69  const void *sqli
35fe0 74 65 33 5f 76 61 6c 75 65 5f 74 65 78 74 31 36  te3_value_text16
35ff0 28 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29  (sqlite3_value*)
36000 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71  ;.const void *sq
36010 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 65 78 74  lite3_value_text
36020 31 36 6c 65 28 73 71 6c 69 74 65 33 5f 76 61 6c  16le(sqlite3_val
36030 75 65 2a 29 3b 0a 63 6f 6e 73 74 20 76 6f 69 64  ue*);.const void
36040 20 2a 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f   *sqlite3_value_
36050 74 65 78 74 31 36 62 65 28 73 71 6c 69 74 65 33  text16be(sqlite3
36060 5f 76 61 6c 75 65 2a 29 3b 0a 69 6e 74 20 73 71  _value*);.int sq
36070 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 79 70 65  lite3_value_type
36080 28 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29  (sqlite3_value*)
36090 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 76 61  ;.int sqlite3_va
360a0 6c 75 65 5f 6e 75 6d 65 72 69 63 5f 74 79 70 65  lue_numeric_type
360b0 28 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29  (sqlite3_value*)
360c0 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
360d0 46 3a 20 46 69 6e 64 69 6e 67 20 54 68 65 20 53  F: Finding The S
360e0 75 62 74 79 70 65 20 4f 66 20 53 51 4c 20 56 61  ubtype Of SQL Va
360f0 6c 75 65 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20  lues.** METHOD: 
36100 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 0a 2a 2a  sqlite3_value.**
36110 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65 33 5f  .** The sqlite3_
36120 76 61 6c 75 65 5f 73 75 62 74 79 70 65 28 56 29  value_subtype(V)
36130 20 66 75 6e 63 74 69 6f 6e 20 72 65 74 75 72 6e   function return
36140 73 20 74 68 65 20 73 75 62 74 79 70 65 20 66 6f  s the subtype fo
36150 72 0a 2a 2a 20 61 6e 20 5b 61 70 70 6c 69 63 61  r.** an [applica
36160 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51 4c  tion-defined SQL
36170 20 66 75 6e 63 74 69 6f 6e 5d 20 61 72 67 75 6d   function] argum
36180 65 6e 74 20 56 2e 20 20 54 68 65 20 73 75 62 74  ent V.  The subt
36190 79 70 65 0a 2a 2a 20 69 6e 66 6f 72 6d 61 74 69  ype.** informati
361a0 6f 6e 20 63 61 6e 20 62 65 20 75 73 65 64 20 74  on can be used t
361b0 6f 20 70 61 73 73 20 61 20 6c 69 6d 69 74 65 64  o pass a limited
361c0 20 61 6d 6f 75 6e 74 20 6f 66 20 63 6f 6e 74 65   amount of conte
361d0 78 74 20 66 72 6f 6d 0a 2a 2a 20 6f 6e 65 20 53  xt from.** one S
361e0 51 4c 20 66 75 6e 63 74 69 6f 6e 20 74 6f 20 61  QL function to a
361f0 6e 6f 74 68 65 72 2e 20 20 55 73 65 20 74 68 65  nother.  Use the
36200 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74   [sqlite3_result
36210 5f 73 75 62 74 79 70 65 28 29 5d 0a 2a 2a 20 72  _subtype()].** r
36220 6f 75 74 69 6e 65 20 74 6f 20 73 65 74 20 74 68  outine to set th
36230 65 20 73 75 62 74 79 70 65 20 66 6f 72 20 74 68  e subtype for th
36240 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 20 6f  e return value o
36250 66 20 61 6e 20 53 51 4c 20 66 75 6e 63 74 69 6f  f an SQL functio
36260 6e 2e 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74 65 20  n..**.** SQLite 
36270 6d 61 6b 65 73 20 6e 6f 20 75 73 65 20 6f 66 20  makes no use of 
36280 73 75 62 74 79 70 65 20 69 74 73 65 6c 66 2e 20  subtype itself. 
36290 20 49 74 20 6d 65 72 65 6c 79 20 70 61 73 73 65   It merely passe
362a0 73 20 74 68 65 20 73 75 62 74 79 70 65 0a 2a 2a  s the subtype.**
362b0 20 66 72 6f 6d 20 74 68 65 20 72 65 73 75 6c 74   from the result
362c0 20 6f 66 20 6f 6e 65 20 5b 61 70 70 6c 69 63 61   of one [applica
362d0 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51 4c  tion-defined SQL
362e0 20 66 75 6e 63 74 69 6f 6e 5d 20 69 6e 74 6f 20   function] into 
362f0 74 68 65 0a 2a 2a 20 69 6e 70 75 74 20 6f 66 20  the.** input of 
36300 61 6e 6f 74 68 65 72 2e 0a 2a 2f 0a 75 6e 73 69  another..*/.unsi
36310 67 6e 65 64 20 69 6e 74 20 73 71 6c 69 74 65 33  gned int sqlite3
36320 5f 76 61 6c 75 65 5f 73 75 62 74 79 70 65 28 73  _value_subtype(s
36330 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a  qlite3_value*);.
36340 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
36350 20 43 6f 70 79 20 41 6e 64 20 46 72 65 65 20 53   Copy And Free S
36360 51 4c 20 56 61 6c 75 65 73 0a 2a 2a 20 4d 45 54  QL Values.** MET
36370 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f 76 61 6c  HOD: sqlite3_val
36380 75 65 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71  ue.**.** ^The sq
36390 6c 69 74 65 33 5f 76 61 6c 75 65 5f 64 75 70 28  lite3_value_dup(
363a0 56 29 20 69 6e 74 65 72 66 61 63 65 20 6d 61 6b  V) interface mak
363b0 65 73 20 61 20 63 6f 70 79 20 6f 66 20 74 68 65  es a copy of the
363c0 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d   [sqlite3_value]
363d0 0a 2a 2a 20 6f 62 6a 65 63 74 20 44 20 61 6e 64  .** object D and
363e0 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69 6e 74   returns a point
363f0 65 72 20 74 6f 20 74 68 61 74 20 63 6f 70 79 2e  er to that copy.
36400 20 20 5e 54 68 65 20 5b 73 71 6c 69 74 65 33 5f    ^The [sqlite3_
36410 76 61 6c 75 65 5d 20 72 65 74 75 72 6e 65 64 0a  value] returned.
36420 2a 2a 20 69 73 20 61 20 5b 70 72 6f 74 65 63 74  ** is a [protect
36430 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  ed sqlite3_value
36440 5d 20 6f 62 6a 65 63 74 20 65 76 65 6e 20 69 66  ] object even if
36450 20 74 68 65 20 69 6e 70 75 74 20 69 73 20 6e 6f   the input is no
36460 74 2e 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  t..** ^The sqlit
36470 65 33 5f 76 61 6c 75 65 5f 64 75 70 28 56 29 20  e3_value_dup(V) 
36480 69 6e 74 65 72 66 61 63 65 20 72 65 74 75 72 6e  interface return
36490 73 20 4e 55 4c 4c 20 69 66 20 56 20 69 73 20 4e  s NULL if V is N
364a0 55 4c 4c 20 6f 72 20 69 66 20 61 0a 2a 2a 20 6d  ULL or if a.** m
364b0 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e  emory allocation
364c0 20 66 61 69 6c 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54   fails..**.** ^T
364d0 68 65 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  he sqlite3_value
364e0 5f 66 72 65 65 28 56 29 20 69 6e 74 65 72 66 61  _free(V) interfa
364f0 63 65 20 66 72 65 65 73 20 61 6e 20 5b 73 71 6c  ce frees an [sql
36500 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62 6a 65  ite3_value] obje
36510 63 74 0a 2a 2a 20 70 72 65 76 69 6f 75 73 6c 79  ct.** previously
36520 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 5b   obtained from [
36530 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 64 75  sqlite3_value_du
36540 70 28 29 5d 2e 20 20 5e 49 66 20 56 20 69 73 20  p()].  ^If V is 
36550 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 0a 2a  a NULL pointer.*
36560 2a 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f 76  * then sqlite3_v
36570 61 6c 75 65 5f 66 72 65 65 28 56 29 20 69 73 20  alue_free(V) is 
36580 61 20 68 61 72 6d 6c 65 73 73 20 6e 6f 2d 6f 70  a harmless no-op
36590 2e 0a 2a 2f 0a 73 71 6c 69 74 65 33 5f 76 61 6c  ..*/.sqlite3_val
365a0 75 65 20 2a 73 71 6c 69 74 65 33 5f 76 61 6c 75  ue *sqlite3_valu
365b0 65 5f 64 75 70 28 63 6f 6e 73 74 20 73 71 6c 69  e_dup(const sqli
365c0 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 76 6f 69  te3_value*);.voi
365d0 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f  d sqlite3_value_
365e0 66 72 65 65 28 73 71 6c 69 74 65 33 5f 76 61 6c  free(sqlite3_val
365f0 75 65 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  ue*);../*.** CAP
36600 49 33 52 45 46 3a 20 4f 62 74 61 69 6e 20 41 67  I3REF: Obtain Ag
36610 67 72 65 67 61 74 65 20 46 75 6e 63 74 69 6f 6e  gregate Function
36620 20 43 6f 6e 74 65 78 74 0a 2a 2a 20 4d 45 54 48   Context.** METH
36630 4f 44 3a 20 73 71 6c 69 74 65 33 5f 63 6f 6e 74  OD: sqlite3_cont
36640 65 78 74 0a 2a 2a 0a 2a 2a 20 49 6d 70 6c 65 6d  ext.**.** Implem
36650 65 6e 74 61 74 69 6f 6e 73 20 6f 66 20 61 67 67  entations of agg
36660 72 65 67 61 74 65 20 53 51 4c 20 66 75 6e 63 74  regate SQL funct
36670 69 6f 6e 73 20 75 73 65 20 74 68 69 73 0a 2a 2a  ions use this.**
36680 20 72 6f 75 74 69 6e 65 20 74 6f 20 61 6c 6c 6f   routine to allo
36690 63 61 74 65 20 6d 65 6d 6f 72 79 20 66 6f 72 20  cate memory for 
366a0 73 74 6f 72 69 6e 67 20 74 68 65 69 72 20 73 74  storing their st
366b0 61 74 65 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  ate..**.** ^The 
366c0 66 69 72 73 74 20 74 69 6d 65 20 74 68 65 20 73  first time the s
366d0 71 6c 69 74 65 33 5f 61 67 67 72 65 67 61 74 65  qlite3_aggregate
366e0 5f 63 6f 6e 74 65 78 74 28 43 2c 4e 29 20 72 6f  _context(C,N) ro
366f0 75 74 69 6e 65 20 69 73 20 63 61 6c 6c 65 64 20  utine is called 
36700 0a 2a 2a 20 66 6f 72 20 61 20 70 61 72 74 69 63  .** for a partic
36710 75 6c 61 72 20 61 67 67 72 65 67 61 74 65 20 66  ular aggregate f
36720 75 6e 63 74 69 6f 6e 2c 20 53 51 4c 69 74 65 0a  unction, SQLite.
36730 2a 2a 20 61 6c 6c 6f 63 61 74 65 73 20 4e 20 6f  ** allocates N o
36740 66 20 6d 65 6d 6f 72 79 2c 20 7a 65 72 6f 65 73  f memory, zeroes
36750 20 6f 75 74 20 74 68 61 74 20 6d 65 6d 6f 72 79   out that memory
36760 2c 20 61 6e 64 20 72 65 74 75 72 6e 73 20 61 20  , and returns a 
36770 70 6f 69 6e 74 65 72 0a 2a 2a 20 74 6f 20 74 68  pointer.** to th
36780 65 20 6e 65 77 20 6d 65 6d 6f 72 79 2e 20 5e 4f  e new memory. ^O
36790 6e 20 73 65 63 6f 6e 64 20 61 6e 64 20 73 75 62  n second and sub
367a0 73 65 71 75 65 6e 74 20 63 61 6c 6c 73 20 74 6f  sequent calls to
367b0 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 61 67 67 72  .** sqlite3_aggr
367c0 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28 29 20  egate_context() 
367d0 66 6f 72 20 74 68 65 20 73 61 6d 65 20 61 67 67  for the same agg
367e0 72 65 67 61 74 65 20 66 75 6e 63 74 69 6f 6e 20  regate function 
367f0 69 6e 73 74 61 6e 63 65 2c 0a 2a 2a 20 74 68 65  instance,.** the
36800 20 73 61 6d 65 20 62 75 66 66 65 72 20 69 73 20   same buffer is 
36810 72 65 74 75 72 6e 65 64 2e 20 20 53 71 6c 69 74  returned.  Sqlit
36820 65 33 5f 61 67 67 72 65 67 61 74 65 5f 63 6f 6e  e3_aggregate_con
36830 74 65 78 74 28 29 20 69 73 20 6e 6f 72 6d 61 6c  text() is normal
36840 6c 79 0a 2a 2a 20 63 61 6c 6c 65 64 20 6f 6e 63  ly.** called onc
36850 65 20 66 6f 72 20 65 61 63 68 20 69 6e 76 6f 63  e for each invoc
36860 61 74 69 6f 6e 20 6f 66 20 74 68 65 20 78 53 74  ation of the xSt
36870 65 70 20 63 61 6c 6c 62 61 63 6b 20 61 6e 64 20  ep callback and 
36880 74 68 65 6e 20 6f 6e 65 0a 2a 2a 20 6c 61 73 74  then one.** last
36890 20 74 69 6d 65 20 77 68 65 6e 20 74 68 65 20 78   time when the x
368a0 46 69 6e 61 6c 20 63 61 6c 6c 62 61 63 6b 20 69  Final callback i
368b0 73 20 69 6e 76 6f 6b 65 64 2e 20 20 5e 28 57 68  s invoked.  ^(Wh
368c0 65 6e 20 6e 6f 20 72 6f 77 73 20 6d 61 74 63 68  en no rows match
368d0 0a 2a 2a 20 61 6e 20 61 67 67 72 65 67 61 74 65  .** an aggregate
368e0 20 71 75 65 72 79 2c 20 74 68 65 20 78 53 74 65   query, the xSte
368f0 70 28 29 20 63 61 6c 6c 62 61 63 6b 20 6f 66 20  p() callback of 
36900 74 68 65 20 61 67 67 72 65 67 61 74 65 20 66 75  the aggregate fu
36910 6e 63 74 69 6f 6e 0a 2a 2a 20 69 6d 70 6c 65 6d  nction.** implem
36920 65 6e 74 61 74 69 6f 6e 20 69 73 20 6e 65 76 65  entation is neve
36930 72 20 63 61 6c 6c 65 64 20 61 6e 64 20 78 46 69  r called and xFi
36940 6e 61 6c 28 29 20 69 73 20 63 61 6c 6c 65 64 20  nal() is called 
36950 65 78 61 63 74 6c 79 20 6f 6e 63 65 2e 0a 2a 2a  exactly once..**
36960 20 49 6e 20 74 68 6f 73 65 20 63 61 73 65 73 2c   In those cases,
36970 20 73 71 6c 69 74 65 33 5f 61 67 67 72 65 67 61   sqlite3_aggrega
36980 74 65 5f 63 6f 6e 74 65 78 74 28 29 20 6d 69 67  te_context() mig
36990 68 74 20 62 65 20 63 61 6c 6c 65 64 20 66 6f 72  ht be called for
369a0 20 74 68 65 0a 2a 2a 20 66 69 72 73 74 20 74 69   the.** first ti
369b0 6d 65 20 66 72 6f 6d 20 77 69 74 68 69 6e 20 78  me from within x
369c0 46 69 6e 61 6c 28 29 2e 29 5e 0a 2a 2a 0a 2a 2a  Final().)^.**.**
369d0 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 61 67   ^The sqlite3_ag
369e0 67 72 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28  gregate_context(
369f0 43 2c 4e 29 20 72 6f 75 74 69 6e 65 20 72 65 74  C,N) routine ret
36a00 75 72 6e 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e  urns a NULL poin
36a10 74 65 72 20 0a 2a 2a 20 77 68 65 6e 20 66 69 72  ter .** when fir
36a20 73 74 20 63 61 6c 6c 65 64 20 69 66 20 4e 20 69  st called if N i
36a30 73 20 6c 65 73 73 20 74 68 61 6e 20 6f 72 20 65  s less than or e
36a40 71 75 61 6c 20 74 6f 20 7a 65 72 6f 20 6f 72 20  qual to zero or 
36a50 69 66 20 61 20 6d 65 6d 6f 72 79 0a 2a 2a 20 61  if a memory.** a
36a60 6c 6c 6f 63 61 74 65 20 65 72 72 6f 72 20 6f 63  llocate error oc
36a70 63 75 72 73 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68  curs..**.** ^(Th
36a80 65 20 61 6d 6f 75 6e 74 20 6f 66 20 73 70 61 63  e amount of spac
36a90 65 20 61 6c 6c 6f 63 61 74 65 64 20 62 79 20 73  e allocated by s
36aa0 71 6c 69 74 65 33 5f 61 67 67 72 65 67 61 74 65  qlite3_aggregate
36ab0 5f 63 6f 6e 74 65 78 74 28 43 2c 4e 29 20 69 73  _context(C,N) is
36ac0 0a 2a 2a 20 64 65 74 65 72 6d 69 6e 65 64 20 62  .** determined b
36ad0 79 20 74 68 65 20 4e 20 70 61 72 61 6d 65 74 65  y the N paramete
36ae0 72 20 6f 6e 20 66 69 72 73 74 20 73 75 63 63 65  r on first succe
36af0 73 73 66 75 6c 20 63 61 6c 6c 2e 20 20 43 68 61  ssful call.  Cha
36b00 6e 67 69 6e 67 20 74 68 65 0a 2a 2a 20 76 61 6c  nging the.** val
36b10 75 65 20 6f 66 20 4e 20 69 6e 20 73 75 62 73 65  ue of N in subse
36b20 71 75 65 6e 74 20 63 61 6c 6c 20 74 6f 20 73 71  quent call to sq
36b30 6c 69 74 65 33 5f 61 67 67 72 65 67 61 74 65 5f  lite3_aggregate_
36b40 63 6f 6e 74 65 78 74 28 29 20 77 69 74 68 69 6e  context() within
36b50 0a 2a 2a 20 74 68 65 20 73 61 6d 65 20 61 67 67  .** the same agg
36b60 72 65 67 61 74 65 20 66 75 6e 63 74 69 6f 6e 20  regate function 
36b70 69 6e 73 74 61 6e 63 65 20 77 69 6c 6c 20 6e 6f  instance will no
36b80 74 20 72 65 73 69 7a 65 20 74 68 65 20 6d 65 6d  t resize the mem
36b90 6f 72 79 0a 2a 2a 20 61 6c 6c 6f 63 61 74 69 6f  ory.** allocatio
36ba0 6e 2e 29 5e 20 20 57 69 74 68 69 6e 20 74 68 65  n.)^  Within the
36bb0 20 78 46 69 6e 61 6c 20 63 61 6c 6c 62 61 63 6b   xFinal callback
36bc0 2c 20 69 74 20 69 73 20 63 75 73 74 6f 6d 61 72  , it is customar
36bd0 79 20 74 6f 20 73 65 74 0a 2a 2a 20 4e 3d 30 20  y to set.** N=0 
36be0 69 6e 20 63 61 6c 6c 73 20 74 6f 20 73 71 6c 69  in calls to sqli
36bf0 74 65 33 5f 61 67 67 72 65 67 61 74 65 5f 63 6f  te3_aggregate_co
36c00 6e 74 65 78 74 28 43 2c 4e 29 20 73 6f 20 74 68  ntext(C,N) so th
36c10 61 74 20 6e 6f 20 0a 2a 2a 20 70 6f 69 6e 74 6c  at no .** pointl
36c20 65 73 73 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  ess memory alloc
36c30 61 74 69 6f 6e 73 20 6f 63 63 75 72 2e 0a 2a 2a  ations occur..**
36c40 0a 2a 2a 20 5e 53 51 4c 69 74 65 20 61 75 74 6f  .** ^SQLite auto
36c50 6d 61 74 69 63 61 6c 6c 79 20 66 72 65 65 73 20  matically frees 
36c60 74 68 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  the memory alloc
36c70 61 74 65 64 20 62 79 20 0a 2a 2a 20 73 71 6c 69  ated by .** sqli
36c80 74 65 33 5f 61 67 67 72 65 67 61 74 65 5f 63 6f  te3_aggregate_co
36c90 6e 74 65 78 74 28 29 20 77 68 65 6e 20 74 68 65  ntext() when the
36ca0 20 61 67 67 72 65 67 61 74 65 20 71 75 65 72 79   aggregate query
36cb0 20 63 6f 6e 63 6c 75 64 65 73 2e 0a 2a 2a 0a 2a   concludes..**.*
36cc0 2a 20 54 68 65 20 66 69 72 73 74 20 70 61 72 61  * The first para
36cd0 6d 65 74 65 72 20 6d 75 73 74 20 62 65 20 61 20  meter must be a 
36ce0 63 6f 70 79 20 6f 66 20 74 68 65 0a 2a 2a 20 5b  copy of the.** [
36cf0 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 20  sqlite3_context 
36d00 7c 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 63  | SQL function c
36d10 6f 6e 74 65 78 74 5d 20 74 68 61 74 20 69 73 20  ontext] that is 
36d20 74 68 65 20 66 69 72 73 74 20 70 61 72 61 6d 65  the first parame
36d30 74 65 72 0a 2a 2a 20 74 6f 20 74 68 65 20 78 53  ter.** to the xS
36d40 74 65 70 20 6f 72 20 78 46 69 6e 61 6c 20 63 61  tep or xFinal ca
36d50 6c 6c 62 61 63 6b 20 72 6f 75 74 69 6e 65 20 74  llback routine t
36d60 68 61 74 20 69 6d 70 6c 65 6d 65 6e 74 73 20 74  hat implements t
36d70 68 65 20 61 67 67 72 65 67 61 74 65 0a 2a 2a 20  he aggregate.** 
36d80 66 75 6e 63 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20  function..**.** 
36d90 54 68 69 73 20 72 6f 75 74 69 6e 65 20 6d 75 73  This routine mus
36da0 74 20 62 65 20 63 61 6c 6c 65 64 20 66 72 6f 6d  t be called from
36db0 20 74 68 65 20 73 61 6d 65 20 74 68 72 65 61 64   the same thread
36dc0 20 69 6e 20 77 68 69 63 68 0a 2a 2a 20 74 68 65   in which.** the
36dd0 20 61 67 67 72 65 67 61 74 65 20 53 51 4c 20 66   aggregate SQL f
36de0 75 6e 63 74 69 6f 6e 20 69 73 20 72 75 6e 6e 69  unction is runni
36df0 6e 67 2e 0a 2a 2f 0a 76 6f 69 64 20 2a 73 71 6c  ng..*/.void *sql
36e00 69 74 65 33 5f 61 67 67 72 65 67 61 74 65 5f 63  ite3_aggregate_c
36e10 6f 6e 74 65 78 74 28 73 71 6c 69 74 65 33 5f 63  ontext(sqlite3_c
36e20 6f 6e 74 65 78 74 2a 2c 20 69 6e 74 20 6e 42 79  ontext*, int nBy
36e30 74 65 73 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  tes);../*.** CAP
36e40 49 33 52 45 46 3a 20 55 73 65 72 20 44 61 74 61  I3REF: User Data
36e50 20 46 6f 72 20 46 75 6e 63 74 69 6f 6e 73 0a 2a   For Functions.*
36e60 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65  * METHOD: sqlite
36e70 33 5f 63 6f 6e 74 65 78 74 0a 2a 2a 0a 2a 2a 20  3_context.**.** 
36e80 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 75 73 65  ^The sqlite3_use
36e90 72 5f 64 61 74 61 28 29 20 69 6e 74 65 72 66 61  r_data() interfa
36ea0 63 65 20 72 65 74 75 72 6e 73 20 61 20 63 6f 70  ce returns a cop
36eb0 79 20 6f 66 0a 2a 2a 20 74 68 65 20 70 6f 69 6e  y of.** the poin
36ec0 74 65 72 20 74 68 61 74 20 77 61 73 20 74 68 65  ter that was the
36ed0 20 70 55 73 65 72 44 61 74 61 20 70 61 72 61 6d   pUserData param
36ee0 65 74 65 72 20 28 74 68 65 20 35 74 68 20 70 61  eter (the 5th pa
36ef0 72 61 6d 65 74 65 72 29 0a 2a 2a 20 6f 66 20 74  rameter).** of t
36f00 68 65 20 5b 73 71 6c 69 74 65 33 5f 63 72 65 61  he [sqlite3_crea
36f10 74 65 5f 66 75 6e 63 74 69 6f 6e 28 29 5d 0a 2a  te_function()].*
36f20 2a 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 63  * and [sqlite3_c
36f30 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 31 36  reate_function16
36f40 28 29 5d 20 72 6f 75 74 69 6e 65 73 20 74 68 61  ()] routines tha
36f50 74 20 6f 72 69 67 69 6e 61 6c 6c 79 0a 2a 2a 20  t originally.** 
36f60 72 65 67 69 73 74 65 72 65 64 20 74 68 65 20 61  registered the a
36f70 70 70 6c 69 63 61 74 69 6f 6e 20 64 65 66 69 6e  pplication defin
36f80 65 64 20 66 75 6e 63 74 69 6f 6e 2e 0a 2a 2a 0a  ed function..**.
36f90 2a 2a 20 54 68 69 73 20 72 6f 75 74 69 6e 65 20  ** This routine 
36fa0 6d 75 73 74 20 62 65 20 63 61 6c 6c 65 64 20 66  must be called f
36fb0 72 6f 6d 20 74 68 65 20 73 61 6d 65 20 74 68 72  rom the same thr
36fc0 65 61 64 20 69 6e 20 77 68 69 63 68 0a 2a 2a 20  ead in which.** 
36fd0 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d  the application-
36fe0 64 65 66 69 6e 65 64 20 66 75 6e 63 74 69 6f 6e  defined function
36ff0 20 69 73 20 72 75 6e 6e 69 6e 67 2e 0a 2a 2f 0a   is running..*/.
37000 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 75 73  void *sqlite3_us
37010 65 72 5f 64 61 74 61 28 73 71 6c 69 74 65 33 5f  er_data(sqlite3_
37020 63 6f 6e 74 65 78 74 2a 29 3b 0a 0a 2f 2a 0a 2a  context*);../*.*
37030 2a 20 43 41 50 49 33 52 45 46 3a 20 44 61 74 61  * CAPI3REF: Data
37040 62 61 73 65 20 43 6f 6e 6e 65 63 74 69 6f 6e 20  base Connection 
37050 46 6f 72 20 46 75 6e 63 74 69 6f 6e 73 0a 2a 2a  For Functions.**
37060 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33   METHOD: sqlite3
37070 5f 63 6f 6e 74 65 78 74 0a 2a 2a 0a 2a 2a 20 5e  _context.**.** ^
37080 54 68 65 20 73 71 6c 69 74 65 33 5f 63 6f 6e 74  The sqlite3_cont
37090 65 78 74 5f 64 62 5f 68 61 6e 64 6c 65 28 29 20  ext_db_handle() 
370a0 69 6e 74 65 72 66 61 63 65 20 72 65 74 75 72 6e  interface return
370b0 73 20 61 20 63 6f 70 79 20 6f 66 0a 2a 2a 20 74  s a copy of.** t
370c0 68 65 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68  he pointer to th
370d0 65 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  e [database conn
370e0 65 63 74 69 6f 6e 5d 20 28 74 68 65 20 31 73 74  ection] (the 1st
370f0 20 70 61 72 61 6d 65 74 65 72 29 0a 2a 2a 20 6f   parameter).** o
37100 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 63  f the [sqlite3_c
37110 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 28 29  reate_function()
37120 5d 0a 2a 2a 20 61 6e 64 20 5b 73 71 6c 69 74 65  ].** and [sqlite
37130 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f  3_create_functio
37140 6e 31 36 28 29 5d 20 72 6f 75 74 69 6e 65 73 20  n16()] routines 
37150 74 68 61 74 20 6f 72 69 67 69 6e 61 6c 6c 79 0a  that originally.
37160 2a 2a 20 72 65 67 69 73 74 65 72 65 64 20 74 68  ** registered th
37170 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 64 65  e application de
37180 66 69 6e 65 64 20 66 75 6e 63 74 69 6f 6e 2e 0a  fined function..
37190 2a 2f 0a 73 71 6c 69 74 65 33 20 2a 73 71 6c 69  */.sqlite3 *sqli
371a0 74 65 33 5f 63 6f 6e 74 65 78 74 5f 64 62 5f 68  te3_context_db_h
371b0 61 6e 64 6c 65 28 73 71 6c 69 74 65 33 5f 63 6f  andle(sqlite3_co
371c0 6e 74 65 78 74 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20  ntext*);../*.** 
371d0 43 41 50 49 33 52 45 46 3a 20 46 75 6e 63 74 69  CAPI3REF: Functi
371e0 6f 6e 20 41 75 78 69 6c 69 61 72 79 20 44 61 74  on Auxiliary Dat
371f0 61 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c  a.** METHOD: sql
37200 69 74 65 33 5f 63 6f 6e 74 65 78 74 0a 2a 2a 0a  ite3_context.**.
37210 2a 2a 20 54 68 65 73 65 20 66 75 6e 63 74 69 6f  ** These functio
37220 6e 73 20 6d 61 79 20 62 65 20 75 73 65 64 20 62  ns may be used b
37230 79 20 28 6e 6f 6e 2d 61 67 67 72 65 67 61 74 65  y (non-aggregate
37240 29 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20  ) SQL functions 
37250 74 6f 0a 2a 2a 20 61 73 73 6f 63 69 61 74 65 20  to.** associate 
37260 6d 65 74 61 64 61 74 61 20 77 69 74 68 20 61 72  metadata with ar
37270 67 75 6d 65 6e 74 20 76 61 6c 75 65 73 2e 20 49  gument values. I
37280 66 20 74 68 65 20 73 61 6d 65 20 76 61 6c 75 65  f the same value
37290 20 69 73 20 70 61 73 73 65 64 20 74 6f 0a 2a 2a   is passed to.**
372a0 20 6d 75 6c 74 69 70 6c 65 20 69 6e 76 6f 63 61   multiple invoca
372b0 74 69 6f 6e 73 20 6f 66 20 74 68 65 20 73 61 6d  tions of the sam
372c0 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 64  e SQL function d
372d0 75 72 69 6e 67 20 71 75 65 72 79 20 65 78 65 63  uring query exec
372e0 75 74 69 6f 6e 2c 20 75 6e 64 65 72 0a 2a 2a 20  ution, under.** 
372f0 73 6f 6d 65 20 63 69 72 63 75 6d 73 74 61 6e 63  some circumstanc
37300 65 73 20 74 68 65 20 61 73 73 6f 63 69 61 74 65  es the associate
37310 64 20 6d 65 74 61 64 61 74 61 20 6d 61 79 20 62  d metadata may b
37320 65 20 70 72 65 73 65 72 76 65 64 2e 20 20 41 6e  e preserved.  An
37330 20 65 78 61 6d 70 6c 65 0a 2a 2a 20 6f 66 20 77   example.** of w
37340 68 65 72 65 20 74 68 69 73 20 6d 69 67 68 74 20  here this might 
37350 62 65 20 75 73 65 66 75 6c 20 69 73 20 69 6e 20  be useful is in 
37360 61 20 72 65 67 75 6c 61 72 2d 65 78 70 72 65 73  a regular-expres
37370 73 69 6f 6e 20 6d 61 74 63 68 69 6e 67 0a 2a 2a  sion matching.**
37380 20 66 75 6e 63 74 69 6f 6e 2e 20 54 68 65 20 63   function. The c
37390 6f 6d 70 69 6c 65 64 20 76 65 72 73 69 6f 6e 20  ompiled version 
373a0 6f 66 20 74 68 65 20 72 65 67 75 6c 61 72 20 65  of the regular e
373b0 78 70 72 65 73 73 69 6f 6e 20 63 61 6e 20 62 65  xpression can be
373c0 20 73 74 6f 72 65 64 20 61 73 0a 2a 2a 20 6d 65   stored as.** me
373d0 74 61 64 61 74 61 20 61 73 73 6f 63 69 61 74 65  tadata associate
373e0 64 20 77 69 74 68 20 74 68 65 20 70 61 74 74 65  d with the patte
373f0 72 6e 20 73 74 72 69 6e 67 2e 20 20 0a 2a 2a 20  rn string.  .** 
37400 54 68 65 6e 20 61 73 20 6c 6f 6e 67 20 61 73 20  Then as long as 
37410 74 68 65 20 70 61 74 74 65 72 6e 20 73 74 72 69  the pattern stri
37420 6e 67 20 72 65 6d 61 69 6e 73 20 74 68 65 20 73  ng remains the s
37430 61 6d 65 2c 0a 2a 2a 20 74 68 65 20 63 6f 6d 70  ame,.** the comp
37440 69 6c 65 64 20 72 65 67 75 6c 61 72 20 65 78 70  iled regular exp
37450 72 65 73 73 69 6f 6e 20 63 61 6e 20 62 65 20 72  ression can be r
37460 65 75 73 65 64 20 6f 6e 20 6d 75 6c 74 69 70 6c  eused on multipl
37470 65 0a 2a 2a 20 69 6e 76 6f 63 61 74 69 6f 6e 73  e.** invocations
37480 20 6f 66 20 74 68 65 20 73 61 6d 65 20 66 75 6e   of the same fun
37490 63 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  ction..**.** ^Th
374a0 65 20 73 71 6c 69 74 65 33 5f 67 65 74 5f 61 75  e sqlite3_get_au
374b0 78 64 61 74 61 28 29 20 69 6e 74 65 72 66 61 63  xdata() interfac
374c0 65 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69 6e  e returns a poin
374d0 74 65 72 20 74 6f 20 74 68 65 20 6d 65 74 61 64  ter to the metad
374e0 61 74 61 0a 2a 2a 20 61 73 73 6f 63 69 61 74 65  ata.** associate
374f0 64 20 62 79 20 74 68 65 20 73 71 6c 69 74 65 33  d by the sqlite3
37500 5f 73 65 74 5f 61 75 78 64 61 74 61 28 29 20 66  _set_auxdata() f
37510 75 6e 63 74 69 6f 6e 20 77 69 74 68 20 74 68 65  unction with the
37520 20 4e 74 68 20 61 72 67 75 6d 65 6e 74 0a 2a 2a   Nth argument.**
37530 20 76 61 6c 75 65 20 74 6f 20 74 68 65 20 61 70   value to the ap
37540 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65  plication-define
37550 64 20 66 75 6e 63 74 69 6f 6e 2e 20 5e 49 66 20  d function. ^If 
37560 74 68 65 72 65 20 69 73 20 6e 6f 20 6d 65 74 61  there is no meta
37570 64 61 74 61 0a 2a 2a 20 61 73 73 6f 63 69 61 74  data.** associat
37580 65 64 20 77 69 74 68 20 74 68 65 20 66 75 6e 63  ed with the func
37590 74 69 6f 6e 20 61 72 67 75 6d 65 6e 74 2c 20 74  tion argument, t
375a0 68 69 73 20 73 71 6c 69 74 65 33 5f 67 65 74 5f  his sqlite3_get_
375b0 61 75 78 64 61 74 61 28 29 20 69 6e 74 65 72 66  auxdata() interf
375c0 61 63 65 0a 2a 2a 20 72 65 74 75 72 6e 73 20 61  ace.** returns a
375d0 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2e 0a 2a   NULL pointer..*
375e0 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65  *.** ^The sqlite
375f0 33 5f 73 65 74 5f 61 75 78 64 61 74 61 28 43 2c  3_set_auxdata(C,
37600 4e 2c 50 2c 58 29 20 69 6e 74 65 72 66 61 63 65  N,P,X) interface
37610 20 73 61 76 65 73 20 50 20 61 73 20 6d 65 74 61   saves P as meta
37620 64 61 74 61 20 66 6f 72 20 74 68 65 20 4e 2d 74  data for the N-t
37630 68 0a 2a 2a 20 61 72 67 75 6d 65 6e 74 20 6f 66  h.** argument of
37640 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   the application
37650 2d 64 65 66 69 6e 65 64 20 66 75 6e 63 74 69 6f  -defined functio
37660 6e 2e 20 20 5e 53 75 62 73 65 71 75 65 6e 74 0a  n.  ^Subsequent.
37670 2a 2a 20 63 61 6c 6c 73 20 74 6f 20 73 71 6c 69  ** calls to sqli
37680 74 65 33 5f 67 65 74 5f 61 75 78 64 61 74 61 28  te3_get_auxdata(
37690 43 2c 4e 29 20 72 65 74 75 72 6e 20 50 20 66 72  C,N) return P fr
376a0 6f 6d 20 74 68 65 20 6d 6f 73 74 20 72 65 63 65  om the most rece
376b0 6e 74 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 73 65  nt.** sqlite3_se
376c0 74 5f 61 75 78 64 61 74 61 28 43 2c 4e 2c 50 2c  t_auxdata(C,N,P,
376d0 58 29 20 63 61 6c 6c 20 69 66 20 74 68 65 20 6d  X) call if the m
376e0 65 74 61 64 61 74 61 20 69 73 20 73 74 69 6c 6c  etadata is still
376f0 20 76 61 6c 69 64 20 6f 72 0a 2a 2a 20 4e 55 4c   valid or.** NUL
37700 4c 20 69 66 20 74 68 65 20 6d 65 74 61 64 61 74  L if the metadat
37710 61 20 68 61 73 20 62 65 65 6e 20 64 69 73 63 61  a has been disca
37720 72 64 65 64 2e 0a 2a 2a 20 5e 41 66 74 65 72 20  rded..** ^After 
37730 65 61 63 68 20 63 61 6c 6c 20 74 6f 20 73 71 6c  each call to sql
37740 69 74 65 33 5f 73 65 74 5f 61 75 78 64 61 74 61  ite3_set_auxdata
37750 28 43 2c 4e 2c 50 2c 58 29 20 77 68 65 72 65 20  (C,N,P,X) where 
37760 58 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 2c 0a 2a  X is not NULL,.*
37770 2a 20 53 51 4c 69 74 65 20 77 69 6c 6c 20 69 6e  * SQLite will in
37780 76 6f 6b 65 20 74 68 65 20 64 65 73 74 72 75 63  voke the destruc
37790 74 6f 72 20 66 75 6e 63 74 69 6f 6e 20 58 20 77  tor function X w
377a0 69 74 68 20 70 61 72 61 6d 65 74 65 72 20 50 20  ith parameter P 
377b0 65 78 61 63 74 6c 79 0a 2a 2a 20 6f 6e 63 65 2c  exactly.** once,
377c0 20 77 68 65 6e 20 74 68 65 20 6d 65 74 61 64 61   when the metada
377d0 74 61 20 69 73 20 64 69 73 63 61 72 64 65 64 2e  ta is discarded.
377e0 0a 2a 2a 20 53 51 4c 69 74 65 20 69 73 20 66 72  .** SQLite is fr
377f0 65 65 20 74 6f 20 64 69 73 63 61 72 64 20 74 68  ee to discard th
37800 65 20 6d 65 74 61 64 61 74 61 20 61 74 20 61 6e  e metadata at an
37810 79 20 74 69 6d 65 2c 20 69 6e 63 6c 75 64 69 6e  y time, includin
37820 67 3a 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20  g: <ul>.** <li> 
37830 77 68 65 6e 20 74 68 65 20 63 6f 72 72 65 73 70  when the corresp
37840 6f 6e 64 69 6e 67 20 66 75 6e 63 74 69 6f 6e 20  onding function 
37850 70 61 72 61 6d 65 74 65 72 20 63 68 61 6e 67 65  parameter change
37860 73 2c 20 6f 72 0a 2a 2a 20 3c 6c 69 3e 20 77 68  s, or.** <li> wh
37870 65 6e 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65  en [sqlite3_rese
37880 74 28 29 5d 20 6f 72 20 5b 73 71 6c 69 74 65 33  t()] or [sqlite3
37890 5f 66 69 6e 61 6c 69 7a 65 28 29 5d 20 69 73 20  _finalize()] is 
378a0 63 61 6c 6c 65 64 20 66 6f 72 20 74 68 65 0a 2a  called for the.*
378b0 2a 20 20 20 20 20 20 53 51 4c 20 73 74 61 74 65  *      SQL state
378c0 6d 65 6e 74 2c 20 6f 72 0a 2a 2a 20 3c 6c 69 3e  ment, or.** <li>
378d0 20 77 68 65 6e 20 73 71 6c 69 74 65 33 5f 73 65   when sqlite3_se
378e0 74 5f 61 75 78 64 61 74 61 28 29 20 69 73 20 69  t_auxdata() is i
378f0 6e 76 6f 6b 65 64 20 61 67 61 69 6e 20 6f 6e 20  nvoked again on 
37900 74 68 65 20 73 61 6d 65 20 70 61 72 61 6d 65 74  the same paramet
37910 65 72 2c 20 6f 72 0a 2a 2a 20 3c 6c 69 3e 20 64  er, or.** <li> d
37920 75 72 69 6e 67 20 74 68 65 20 6f 72 69 67 69 6e  uring the origin
37930 61 6c 20 73 71 6c 69 74 65 33 5f 73 65 74 5f 61  al sqlite3_set_a
37940 75 78 64 61 74 61 28 29 20 63 61 6c 6c 20 77 68  uxdata() call wh
37950 65 6e 20 61 20 6d 65 6d 6f 72 79 20 0a 2a 2a 20  en a memory .** 
37960 20 20 20 20 20 61 6c 6c 6f 63 61 74 69 6f 6e 20       allocation 
37970 65 72 72 6f 72 20 6f 63 63 75 72 73 2e 20 3c 2f  error occurs. </
37980 75 6c 3e 29 5e 0a 2a 2a 0a 2a 2a 20 4e 6f 74 65  ul>)^.**.** Note
37990 20 74 68 65 20 6c 61 73 74 20 62 75 6c 6c 65 74   the last bullet
379a0 20 69 6e 20 70 61 72 74 69 63 75 6c 61 72 2e 20   in particular. 
379b0 20 54 68 65 20 64 65 73 74 72 75 63 74 6f 72 20   The destructor 
379c0 58 20 69 6e 20 0a 2a 2a 20 73 71 6c 69 74 65 33  X in .** sqlite3
379d0 5f 73 65 74 5f 61 75 78 64 61 74 61 28 43 2c 4e  _set_auxdata(C,N
379e0 2c 50 2c 58 29 20 6d 69 67 68 74 20 62 65 20 63  ,P,X) might be c
379f0 61 6c 6c 65 64 20 69 6d 6d 65 64 69 61 74 65 6c  alled immediatel
37a00 79 2c 20 62 65 66 6f 72 65 20 74 68 65 0a 2a 2a  y, before the.**
37a10 20 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78   sqlite3_set_aux
37a20 64 61 74 61 28 29 20 69 6e 74 65 72 66 61 63 65  data() interface
37a30 20 65 76 65 6e 20 72 65 74 75 72 6e 73 2e 20 20   even returns.  
37a40 48 65 6e 63 65 20 73 71 6c 69 74 65 33 5f 73 65  Hence sqlite3_se
37a50 74 5f 61 75 78 64 61 74 61 28 29 0a 2a 2a 20 73  t_auxdata().** s
37a60 68 6f 75 6c 64 20 62 65 20 63 61 6c 6c 65 64 20  hould be called 
37a70 6e 65 61 72 20 74 68 65 20 65 6e 64 20 6f 66 20  near the end of 
37a80 74 68 65 20 66 75 6e 63 74 69 6f 6e 20 69 6d 70  the function imp
37a90 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 61 6e 64 20  lementation and 
37aa0 74 68 65 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20  the.** function 
37ab0 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 73  implementation s
37ac0 68 6f 75 6c 64 20 6e 6f 74 20 6d 61 6b 65 20 61  hould not make a
37ad0 6e 79 20 75 73 65 20 6f 66 20 50 20 61 66 74 65  ny use of P afte
37ae0 72 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 73 65 74  r.** sqlite3_set
37af0 5f 61 75 78 64 61 74 61 28 29 20 68 61 73 20 62  _auxdata() has b
37b00 65 65 6e 20 63 61 6c 6c 65 64 2e 0a 2a 2a 0a 2a  een called..**.*
37b10 2a 20 5e 28 49 6e 20 70 72 61 63 74 69 63 65 2c  * ^(In practice,
37b20 20 6d 65 74 61 64 61 74 61 20 69 73 20 70 72 65   metadata is pre
37b30 73 65 72 76 65 64 20 62 65 74 77 65 65 6e 20 66  served between f
37b40 75 6e 63 74 69 6f 6e 20 63 61 6c 6c 73 20 66 6f  unction calls fo
37b50 72 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 70 61  r.** function pa
37b60 72 61 6d 65 74 65 72 73 20 74 68 61 74 20 61 72  rameters that ar
37b70 65 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 63  e compile-time c
37b80 6f 6e 73 74 61 6e 74 73 2c 20 69 6e 63 6c 75 64  onstants, includ
37b90 69 6e 67 20 6c 69 74 65 72 61 6c 0a 2a 2a 20 76  ing literal.** v
37ba0 61 6c 75 65 73 20 61 6e 64 20 5b 70 61 72 61 6d  alues and [param
37bb0 65 74 65 72 73 5d 20 61 6e 64 20 65 78 70 72 65  eters] and expre
37bc0 73 73 69 6f 6e 73 20 63 6f 6d 70 6f 73 65 64 20  ssions composed 
37bd0 66 72 6f 6d 20 74 68 65 20 73 61 6d 65 2e 29 5e  from the same.)^
37be0 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72 6f 75  .**.** These rou
37bf0 74 69 6e 65 73 20 6d 75 73 74 20 62 65 20 63 61  tines must be ca
37c00 6c 6c 65 64 20 66 72 6f 6d 20 74 68 65 20 73 61  lled from the sa
37c10 6d 65 20 74 68 72 65 61 64 20 69 6e 20 77 68 69  me thread in whi
37c20 63 68 0a 2a 2a 20 74 68 65 20 53 51 4c 20 66 75  ch.** the SQL fu
37c30 6e 63 74 69 6f 6e 20 69 73 20 72 75 6e 6e 69 6e  nction is runnin
37c40 67 2e 0a 2a 2f 0a 76 6f 69 64 20 2a 73 71 6c 69  g..*/.void *sqli
37c50 74 65 33 5f 67 65 74 5f 61 75 78 64 61 74 61 28  te3_get_auxdata(
37c60 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a  sqlite3_context*
37c70 2c 20 69 6e 74 20 4e 29 3b 0a 76 6f 69 64 20 73  , int N);.void s
37c80 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78 64 61  qlite3_set_auxda
37c90 74 61 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65  ta(sqlite3_conte
37ca0 78 74 2a 2c 20 69 6e 74 20 4e 2c 20 76 6f 69 64  xt*, int N, void
37cb0 2a 2c 20 76 6f 69 64 20 28 2a 29 28 76 6f 69 64  *, void (*)(void
37cc0 2a 29 29 3b 0a 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  *));.../*.** CAP
37cd0 49 33 52 45 46 3a 20 43 6f 6e 73 74 61 6e 74 73  I3REF: Constants
37ce0 20 44 65 66 69 6e 69 6e 67 20 53 70 65 63 69 61   Defining Specia
37cf0 6c 20 44 65 73 74 72 75 63 74 6f 72 20 42 65 68  l Destructor Beh
37d00 61 76 69 6f 72 0a 2a 2a 0a 2a 2a 20 54 68 65 73  avior.**.** Thes
37d10 65 20 61 72 65 20 73 70 65 63 69 61 6c 20 76 61  e are special va
37d20 6c 75 65 73 20 66 6f 72 20 74 68 65 20 64 65 73  lues for the des
37d30 74 72 75 63 74 6f 72 20 74 68 61 74 20 69 73 20  tructor that is 
37d40 70 61 73 73 65 64 20 69 6e 20 61 73 20 74 68 65  passed in as the
37d50 0a 2a 2a 20 66 69 6e 61 6c 20 61 72 67 75 6d 65  .** final argume
37d60 6e 74 20 74 6f 20 72 6f 75 74 69 6e 65 73 20 6c  nt to routines l
37d70 69 6b 65 20 5b 73 71 6c 69 74 65 33 5f 72 65 73  ike [sqlite3_res
37d80 75 6c 74 5f 62 6c 6f 62 28 29 5d 2e 20 20 5e 49  ult_blob()].  ^I
37d90 66 20 74 68 65 20 64 65 73 74 72 75 63 74 6f 72  f the destructor
37da0 0a 2a 2a 20 61 72 67 75 6d 65 6e 74 20 69 73 20  .** argument is 
37db0 53 51 4c 49 54 45 5f 53 54 41 54 49 43 2c 20 69  SQLITE_STATIC, i
37dc0 74 20 6d 65 61 6e 73 20 74 68 61 74 20 74 68 65  t means that the
37dd0 20 63 6f 6e 74 65 6e 74 20 70 6f 69 6e 74 65 72   content pointer
37de0 20 69 73 20 63 6f 6e 73 74 61 6e 74 0a 2a 2a 20   is constant.** 
37df0 61 6e 64 20 77 69 6c 6c 20 6e 65 76 65 72 20 63  and will never c
37e00 68 61 6e 67 65 2e 20 20 49 74 20 64 6f 65 73 20  hange.  It does 
37e10 6e 6f 74 20 6e 65 65 64 20 74 6f 20 62 65 20 64  not need to be d
37e20 65 73 74 72 6f 79 65 64 2e 20 20 5e 54 68 65 0a  estroyed.  ^The.
37e30 2a 2a 20 53 51 4c 49 54 45 5f 54 52 41 4e 53 49  ** SQLITE_TRANSI
37e40 45 4e 54 20 76 61 6c 75 65 20 6d 65 61 6e 73 20  ENT value means 
37e50 74 68 61 74 20 74 68 65 20 63 6f 6e 74 65 6e 74  that the content
37e60 20 77 69 6c 6c 20 6c 69 6b 65 6c 79 20 63 68 61   will likely cha
37e70 6e 67 65 20 69 6e 0a 2a 2a 20 74 68 65 20 6e 65  nge in.** the ne
37e80 61 72 20 66 75 74 75 72 65 20 61 6e 64 20 74 68  ar future and th
37e90 61 74 20 53 51 4c 69 74 65 20 73 68 6f 75 6c 64  at SQLite should
37ea0 20 6d 61 6b 65 20 69 74 73 20 6f 77 6e 20 70 72   make its own pr
37eb0 69 76 61 74 65 20 63 6f 70 79 20 6f 66 0a 2a 2a  ivate copy of.**
37ec0 20 74 68 65 20 63 6f 6e 74 65 6e 74 20 62 65 66   the content bef
37ed0 6f 72 65 20 72 65 74 75 72 6e 69 6e 67 2e 0a 2a  ore returning..*
37ee0 2a 0a 2a 2a 20 54 68 65 20 74 79 70 65 64 65 66  *.** The typedef
37ef0 20 69 73 20 6e 65 63 65 73 73 61 72 79 20 74 6f   is necessary to
37f00 20 77 6f 72 6b 20 61 72 6f 75 6e 64 20 70 72 6f   work around pro
37f10 62 6c 65 6d 73 20 69 6e 20 63 65 72 74 61 69 6e  blems in certain
37f20 0a 2a 2a 20 43 2b 2b 20 63 6f 6d 70 69 6c 65 72  .** C++ compiler
37f30 73 2e 0a 2a 2f 0a 74 79 70 65 64 65 66 20 76 6f  s..*/.typedef vo
37f40 69 64 20 28 2a 73 71 6c 69 74 65 33 5f 64 65 73  id (*sqlite3_des
37f50 74 72 75 63 74 6f 72 5f 74 79 70 65 29 28 76 6f  tructor_type)(vo
37f60 69 64 2a 29 3b 0a 23 64 65 66 69 6e 65 20 53 51  id*);.#define SQ
37f70 4c 49 54 45 5f 53 54 41 54 49 43 20 20 20 20 20  LITE_STATIC     
37f80 20 28 28 73 71 6c 69 74 65 33 5f 64 65 73 74 72   ((sqlite3_destr
37f90 75 63 74 6f 72 5f 74 79 70 65 29 30 29 0a 23 64  uctor_type)0).#d
37fa0 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 54 52 41  efine SQLITE_TRA
37fb0 4e 53 49 45 4e 54 20 20 20 28 28 73 71 6c 69 74  NSIENT   ((sqlit
37fc0 65 33 5f 64 65 73 74 72 75 63 74 6f 72 5f 74 79  e3_destructor_ty
37fd0 70 65 29 2d 31 29 0a 0a 2f 2a 0a 2a 2a 20 43 41  pe)-1)../*.** CA
37fe0 50 49 33 52 45 46 3a 20 53 65 74 74 69 6e 67 20  PI3REF: Setting 
37ff0 54 68 65 20 52 65 73 75 6c 74 20 4f 66 20 41 6e  The Result Of An
38000 20 53 51 4c 20 46 75 6e 63 74 69 6f 6e 0a 2a 2a   SQL Function.**
38010 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33   METHOD: sqlite3
38020 5f 63 6f 6e 74 65 78 74 0a 2a 2a 0a 2a 2a 20 54  _context.**.** T
38030 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 61 72  hese routines ar
38040 65 20 75 73 65 64 20 62 79 20 74 68 65 20 78 46  e used by the xF
38050 75 6e 63 20 6f 72 20 78 46 69 6e 61 6c 20 63 61  unc or xFinal ca
38060 6c 6c 62 61 63 6b 73 20 74 68 61 74 0a 2a 2a 20  llbacks that.** 
38070 69 6d 70 6c 65 6d 65 6e 74 20 53 51 4c 20 66 75  implement SQL fu
38080 6e 63 74 69 6f 6e 73 20 61 6e 64 20 61 67 67 72  nctions and aggr
38090 65 67 61 74 65 73 2e 20 20 53 65 65 0a 2a 2a 20  egates.  See.** 
380a0 5b 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f  [sqlite3_create_
380b0 66 75 6e 63 74 69 6f 6e 28 29 5d 20 61 6e 64 20  function()] and 
380c0 5b 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f  [sqlite3_create_
380d0 66 75 6e 63 74 69 6f 6e 31 36 28 29 5d 0a 2a 2a  function16()].**
380e0 20 66 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c 20   for additional 
380f0 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 0a 2a 2a 0a  information..**.
38100 2a 2a 20 54 68 65 73 65 20 66 75 6e 63 74 69 6f  ** These functio
38110 6e 73 20 77 6f 72 6b 20 76 65 72 79 20 6d 75 63  ns work very muc
38120 68 20 6c 69 6b 65 20 74 68 65 20 5b 70 61 72 61  h like the [para
38130 6d 65 74 65 72 20 62 69 6e 64 69 6e 67 5d 20 66  meter binding] f
38140 61 6d 69 6c 79 20 6f 66 0a 2a 2a 20 66 75 6e 63  amily of.** func
38150 74 69 6f 6e 73 20 75 73 65 64 20 74 6f 20 62 69  tions used to bi
38160 6e 64 20 76 61 6c 75 65 73 20 74 6f 20 68 6f 73  nd values to hos
38170 74 20 70 61 72 61 6d 65 74 65 72 73 20 69 6e 20  t parameters in 
38180 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
38190 6e 74 73 2e 0a 2a 2a 20 52 65 66 65 72 20 74 6f  nts..** Refer to
381a0 20 74 68 65 20 5b 53 51 4c 20 70 61 72 61 6d 65   the [SQL parame
381b0 74 65 72 5d 20 64 6f 63 75 6d 65 6e 74 61 74 69  ter] documentati
381c0 6f 6e 20 66 6f 72 20 61 64 64 69 74 69 6f 6e 61  on for additiona
381d0 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 0a 2a  l information..*
381e0 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65  *.** ^The sqlite
381f0 33 5f 72 65 73 75 6c 74 5f 62 6c 6f 62 28 29 20  3_result_blob() 
38200 69 6e 74 65 72 66 61 63 65 20 73 65 74 73 20 74  interface sets t
38210 68 65 20 72 65 73 75 6c 74 20 66 72 6f 6d 0a 2a  he result from.*
38220 2a 20 61 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e  * an application
38230 2d 64 65 66 69 6e 65 64 20 66 75 6e 63 74 69 6f  -defined functio
38240 6e 20 74 6f 20 62 65 20 74 68 65 20 42 4c 4f 42  n to be the BLOB
38250 20 77 68 6f 73 65 20 63 6f 6e 74 65 6e 74 20 69   whose content i
38260 73 20 70 6f 69 6e 74 65 64 0a 2a 2a 20 74 6f 20  s pointed.** to 
38270 62 79 20 74 68 65 20 73 65 63 6f 6e 64 20 70 61  by the second pa
38280 72 61 6d 65 74 65 72 20 61 6e 64 20 77 68 69 63  rameter and whic
38290 68 20 69 73 20 4e 20 62 79 74 65 73 20 6c 6f 6e  h is N bytes lon
382a0 67 20 77 68 65 72 65 20 4e 20 69 73 20 74 68 65  g where N is the
382b0 0a 2a 2a 20 74 68 69 72 64 20 70 61 72 61 6d 65  .** third parame
382c0 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  ter..**.** ^The 
382d0 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 7a  sqlite3_result_z
382e0 65 72 6f 62 6c 6f 62 28 43 2c 4e 29 20 61 6e 64  eroblob(C,N) and
382f0 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f   sqlite3_result_
38300 7a 65 72 6f 62 6c 6f 62 36 34 28 43 2c 4e 29 0a  zeroblob64(C,N).
38310 2a 2a 20 69 6e 74 65 72 66 61 63 65 73 20 73 65  ** interfaces se
38320 74 20 74 68 65 20 72 65 73 75 6c 74 20 6f 66 20  t the result of 
38330 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d  the application-
38340 64 65 66 69 6e 65 64 20 66 75 6e 63 74 69 6f 6e  defined function
38350 20 74 6f 20 62 65 0a 2a 2a 20 61 20 42 4c 4f 42   to be.** a BLOB
38360 20 63 6f 6e 74 61 69 6e 69 6e 67 20 61 6c 6c 20   containing all 
38370 7a 65 72 6f 20 62 79 74 65 73 20 61 6e 64 20 4e  zero bytes and N
38380 20 62 79 74 65 73 20 69 6e 20 73 69 7a 65 2e 0a   bytes in size..
38390 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  **.** ^The sqlit
383a0 65 33 5f 72 65 73 75 6c 74 5f 64 6f 75 62 6c 65  e3_result_double
383b0 28 29 20 69 6e 74 65 72 66 61 63 65 20 73 65 74  () interface set
383c0 73 20 74 68 65 20 72 65 73 75 6c 74 20 66 72 6f  s the result fro
383d0 6d 0a 2a 2a 20 61 6e 20 61 70 70 6c 69 63 61 74  m.** an applicat
383e0 69 6f 6e 2d 64 65 66 69 6e 65 64 20 66 75 6e 63  ion-defined func
383f0 74 69 6f 6e 20 74 6f 20 62 65 20 61 20 66 6c 6f  tion to be a flo
38400 61 74 69 6e 67 20 70 6f 69 6e 74 20 76 61 6c 75  ating point valu
38410 65 20 73 70 65 63 69 66 69 65 64 0a 2a 2a 20 62  e specified.** b
38420 79 20 69 74 73 20 32 6e 64 20 61 72 67 75 6d 65  y its 2nd argume
38430 6e 74 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  nt..**.** ^The s
38440 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 65 72  qlite3_result_er
38450 72 6f 72 28 29 20 61 6e 64 20 73 71 6c 69 74 65  ror() and sqlite
38460 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f 72 31 36  3_result_error16
38470 28 29 20 66 75 6e 63 74 69 6f 6e 73 0a 2a 2a 20  () functions.** 
38480 63 61 75 73 65 20 74 68 65 20 69 6d 70 6c 65 6d  cause the implem
38490 65 6e 74 65 64 20 53 51 4c 20 66 75 6e 63 74 69  ented SQL functi
384a0 6f 6e 20 74 6f 20 74 68 72 6f 77 20 61 6e 20 65  on to throw an e
384b0 78 63 65 70 74 69 6f 6e 2e 0a 2a 2a 20 5e 53 51  xception..** ^SQ
384c0 4c 69 74 65 20 75 73 65 73 20 74 68 65 20 73 74  Lite uses the st
384d0 72 69 6e 67 20 70 6f 69 6e 74 65 64 20 74 6f 20  ring pointed to 
384e0 62 79 20 74 68 65 0a 2a 2a 20 32 6e 64 20 70 61  by the.** 2nd pa
384f0 72 61 6d 65 74 65 72 20 6f 66 20 73 71 6c 69 74  rameter of sqlit
38500 65 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f 72 28  e3_result_error(
38510 29 20 6f 72 20 73 71 6c 69 74 65 33 5f 72 65 73  ) or sqlite3_res
38520 75 6c 74 5f 65 72 72 6f 72 31 36 28 29 0a 2a 2a  ult_error16().**
38530 20 61 73 20 74 68 65 20 74 65 78 74 20 6f 66 20   as the text of 
38540 61 6e 20 65 72 72 6f 72 20 6d 65 73 73 61 67 65  an error message
38550 2e 20 20 5e 53 51 4c 69 74 65 20 69 6e 74 65 72  .  ^SQLite inter
38560 70 72 65 74 73 20 74 68 65 20 65 72 72 6f 72 0a  prets the error.
38570 2a 2a 20 6d 65 73 73 61 67 65 20 73 74 72 69 6e  ** message strin
38580 67 20 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f 72  g from sqlite3_r
38590 65 73 75 6c 74 5f 65 72 72 6f 72 28 29 20 61 73  esult_error() as
385a0 20 55 54 46 2d 38 2e 20 5e 53 51 4c 69 74 65 0a   UTF-8. ^SQLite.
385b0 2a 2a 20 69 6e 74 65 72 70 72 65 74 73 20 74 68  ** interprets th
385c0 65 20 73 74 72 69 6e 67 20 66 72 6f 6d 20 73 71  e string from sq
385d0 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 65 72 72  lite3_result_err
385e0 6f 72 31 36 28 29 20 61 73 20 55 54 46 2d 31 36  or16() as UTF-16
385f0 20 69 6e 20 6e 61 74 69 76 65 0a 2a 2a 20 62 79   in native.** by
38600 74 65 20 6f 72 64 65 72 2e 20 20 5e 49 66 20 74  te order.  ^If t
38610 68 65 20 74 68 69 72 64 20 70 61 72 61 6d 65 74  he third paramet
38620 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 72 65  er to sqlite3_re
38630 73 75 6c 74 5f 65 72 72 6f 72 28 29 0a 2a 2a 20  sult_error().** 
38640 6f 72 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c  or sqlite3_resul
38650 74 5f 65 72 72 6f 72 31 36 28 29 20 69 73 20 6e  t_error16() is n
38660 65 67 61 74 69 76 65 20 74 68 65 6e 20 53 51 4c  egative then SQL
38670 69 74 65 20 74 61 6b 65 73 20 61 73 20 74 68 65  ite takes as the
38680 20 65 72 72 6f 72 0a 2a 2a 20 6d 65 73 73 61 67   error.** messag
38690 65 20 61 6c 6c 20 74 65 78 74 20 75 70 20 74 68  e all text up th
386a0 72 6f 75 67 68 20 74 68 65 20 66 69 72 73 74 20  rough the first 
386b0 7a 65 72 6f 20 63 68 61 72 61 63 74 65 72 2e 0a  zero character..
386c0 2a 2a 20 5e 49 66 20 74 68 65 20 74 68 69 72 64  ** ^If the third
386d0 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71   parameter to sq
386e0 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 65 72 72  lite3_result_err
386f0 6f 72 28 29 20 6f 72 0a 2a 2a 20 73 71 6c 69 74  or() or.** sqlit
38700 65 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f 72 31  e3_result_error1
38710 36 28 29 20 69 73 20 6e 6f 6e 2d 6e 65 67 61 74  6() is non-negat
38720 69 76 65 20 74 68 65 6e 20 53 51 4c 69 74 65 20  ive then SQLite 
38730 74 61 6b 65 73 20 74 68 61 74 20 6d 61 6e 79 0a  takes that many.
38740 2a 2a 20 62 79 74 65 73 20 28 6e 6f 74 20 63 68  ** bytes (not ch
38750 61 72 61 63 74 65 72 73 29 20 66 72 6f 6d 20 74  aracters) from t
38760 68 65 20 32 6e 64 20 70 61 72 61 6d 65 74 65 72  he 2nd parameter
38770 20 61 73 20 74 68 65 20 65 72 72 6f 72 20 6d 65   as the error me
38780 73 73 61 67 65 2e 0a 2a 2a 20 5e 54 68 65 20 73  ssage..** ^The s
38790 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 65 72  qlite3_result_er
387a0 72 6f 72 28 29 20 61 6e 64 20 73 71 6c 69 74 65  ror() and sqlite
387b0 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f 72 31 36  3_result_error16
387c0 28 29 0a 2a 2a 20 72 6f 75 74 69 6e 65 73 20 6d  ().** routines m
387d0 61 6b 65 20 61 20 70 72 69 76 61 74 65 20 63 6f  ake a private co
387e0 70 79 20 6f 66 20 74 68 65 20 65 72 72 6f 72 20  py of the error 
387f0 6d 65 73 73 61 67 65 20 74 65 78 74 20 62 65 66  message text bef
38800 6f 72 65 0a 2a 2a 20 74 68