/ Hex Artifact Content
Login

Artifact b9ba728c1083b7a8ab5f6a628b25cd2a00325fbf:


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 72  These routines r
21760 65 67 69 73 74 65 72 20 63 61 6c 6c 62 61 63 6b  egister callback
21770 20 66 75 6e 63 74 69 6f 6e 73 20 74 68 61 74 20   functions that 
21780 63 61 6e 20 62 65 20 75 73 65 64 20 66 6f 72 0a  can be used for.
21790 2a 2a 20 74 72 61 63 69 6e 67 20 61 6e 64 20 70  ** tracing and p
217a0 72 6f 66 69 6c 69 6e 67 20 74 68 65 20 65 78 65  rofiling the exe
217b0 63 75 74 69 6f 6e 20 6f 66 20 53 51 4c 20 73 74  cution of SQL st
217c0 61 74 65 6d 65 6e 74 73 2e 0a 2a 2a 0a 2a 2a 20  atements..**.** 
217d0 5e 54 68 65 20 63 61 6c 6c 62 61 63 6b 20 66 75  ^The callback fu
217e0 6e 63 74 69 6f 6e 20 72 65 67 69 73 74 65 72 65  nction registere
217f0 64 20 62 79 20 73 71 6c 69 74 65 33 5f 74 72 61  d by sqlite3_tra
21800 63 65 28 29 20 69 73 20 69 6e 76 6f 6b 65 64 20  ce() is invoked 
21810 61 74 0a 2a 2a 20 76 61 72 69 6f 75 73 20 74 69  at.** various ti
21820 6d 65 73 20 77 68 65 6e 20 61 6e 20 53 51 4c 20  mes when an SQL 
21830 73 74 61 74 65 6d 65 6e 74 20 69 73 20 62 65 69  statement is bei
21840 6e 67 20 72 75 6e 20 62 79 20 5b 73 71 6c 69 74  ng run by [sqlit
21850 65 33 5f 73 74 65 70 28 29 5d 2e 0a 2a 2a 20 5e  e3_step()]..** ^
21860 54 68 65 20 73 71 6c 69 74 65 33 5f 74 72 61 63  The sqlite3_trac
21870 65 28 29 20 63 61 6c 6c 62 61 63 6b 20 69 73 20  e() callback is 
21880 69 6e 76 6f 6b 65 64 20 77 69 74 68 20 61 20 55  invoked with a U
21890 54 46 2d 38 20 72 65 6e 64 65 72 69 6e 67 20 6f  TF-8 rendering o
218a0 66 20 74 68 65 0a 2a 2a 20 53 51 4c 20 73 74 61  f the.** SQL sta
218b0 74 65 6d 65 6e 74 20 74 65 78 74 20 61 73 20 74  tement text as t
218c0 68 65 20 73 74 61 74 65 6d 65 6e 74 20 66 69 72  he statement fir
218d0 73 74 20 62 65 67 69 6e 73 20 65 78 65 63 75 74  st begins execut
218e0 69 6e 67 2e 0a 2a 2a 20 5e 28 41 64 64 69 74 69  ing..** ^(Additi
218f0 6f 6e 61 6c 20 73 71 6c 69 74 65 33 5f 74 72 61  onal sqlite3_tra
21900 63 65 28 29 20 63 61 6c 6c 62 61 63 6b 73 20 6d  ce() callbacks m
21910 69 67 68 74 20 6f 63 63 75 72 0a 2a 2a 20 61 73  ight occur.** as
21920 20 65 61 63 68 20 74 72 69 67 67 65 72 65 64 20   each triggered 
21930 73 75 62 70 72 6f 67 72 61 6d 20 69 73 20 65 6e  subprogram is en
21940 74 65 72 65 64 2e 20 20 54 68 65 20 63 61 6c 6c  tered.  The call
21950 62 61 63 6b 73 20 66 6f 72 20 74 72 69 67 67 65  backs for trigge
21960 72 73 0a 2a 2a 20 63 6f 6e 74 61 69 6e 20 61 20  rs.** contain a 
21970 55 54 46 2d 38 20 53 51 4c 20 63 6f 6d 6d 65 6e  UTF-8 SQL commen
21980 74 20 74 68 61 74 20 69 64 65 6e 74 69 66 69 65  t that identifie
21990 73 20 74 68 65 20 74 72 69 67 67 65 72 2e 29 5e  s the trigger.)^
219a0 0a 2a 2a 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49  .**.** The [SQLI
219b0 54 45 5f 54 52 41 43 45 5f 53 49 5a 45 5f 4c 49  TE_TRACE_SIZE_LI
219c0 4d 49 54 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d  MIT] compile-tim
219d0 65 20 6f 70 74 69 6f 6e 20 63 61 6e 20 62 65 20  e option can be 
219e0 75 73 65 64 20 74 6f 20 6c 69 6d 69 74 0a 2a 2a  used to limit.**
219f0 20 74 68 65 20 6c 65 6e 67 74 68 20 6f 66 20 5b   the length of [
21a00 62 6f 75 6e 64 20 70 61 72 61 6d 65 74 65 72 5d  bound parameter]
21a10 20 65 78 70 61 6e 73 69 6f 6e 20 69 6e 20 74 68   expansion in th
21a20 65 20 6f 75 74 70 75 74 20 6f 66 20 73 71 6c 69  e output of sqli
21a30 74 65 33 5f 74 72 61 63 65 28 29 2e 0a 2a 2a 0a  te3_trace()..**.
21a40 2a 2a 20 5e 54 68 65 20 63 61 6c 6c 62 61 63 6b  ** ^The callback
21a50 20 66 75 6e 63 74 69 6f 6e 20 72 65 67 69 73 74   function regist
21a60 65 72 65 64 20 62 79 20 73 71 6c 69 74 65 33 5f  ered by sqlite3_
21a70 70 72 6f 66 69 6c 65 28 29 20 69 73 20 69 6e 76  profile() is inv
21a80 6f 6b 65 64 0a 2a 2a 20 61 73 20 65 61 63 68 20  oked.** as each 
21a90 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 66 69  SQL statement fi
21aa0 6e 69 73 68 65 73 2e 20 20 5e 54 68 65 20 70 72  nishes.  ^The pr
21ab0 6f 66 69 6c 65 20 63 61 6c 6c 62 61 63 6b 20 63  ofile callback c
21ac0 6f 6e 74 61 69 6e 73 0a 2a 2a 20 74 68 65 20 6f  ontains.** the o
21ad0 72 69 67 69 6e 61 6c 20 73 74 61 74 65 6d 65 6e  riginal statemen
21ae0 74 20 74 65 78 74 20 61 6e 64 20 61 6e 20 65 73  t text and an es
21af0 74 69 6d 61 74 65 20 6f 66 20 77 61 6c 6c 2d 63  timate of wall-c
21b00 6c 6f 63 6b 20 74 69 6d 65 0a 2a 2a 20 6f 66 20  lock time.** of 
21b10 68 6f 77 20 6c 6f 6e 67 20 74 68 61 74 20 73 74  how long that st
21b20 61 74 65 6d 65 6e 74 20 74 6f 6f 6b 20 74 6f 20  atement took to 
21b30 72 75 6e 2e 20 20 5e 54 68 65 20 70 72 6f 66 69  run.  ^The profi
21b40 6c 65 20 63 61 6c 6c 62 61 63 6b 0a 2a 2a 20 74  le callback.** t
21b50 69 6d 65 20 69 73 20 69 6e 20 75 6e 69 74 73 20  ime is in units 
21b60 6f 66 20 6e 61 6e 6f 73 65 63 6f 6e 64 73 2c 20  of nanoseconds, 
21b70 68 6f 77 65 76 65 72 20 74 68 65 20 63 75 72 72  however the curr
21b80 65 6e 74 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  ent implementati
21b90 6f 6e 0a 2a 2a 20 69 73 20 6f 6e 6c 79 20 63 61  on.** is only ca
21ba0 70 61 62 6c 65 20 6f 66 20 6d 69 6c 6c 69 73 65  pable of millise
21bb0 63 6f 6e 64 20 72 65 73 6f 6c 75 74 69 6f 6e 20  cond resolution 
21bc0 73 6f 20 74 68 65 20 73 69 78 20 6c 65 61 73 74  so the six least
21bd0 20 73 69 67 6e 69 66 69 63 61 6e 74 0a 2a 2a 20   significant.** 
21be0 64 69 67 69 74 73 20 69 6e 20 74 68 65 20 74 69  digits in the ti
21bf0 6d 65 20 61 72 65 20 6d 65 61 6e 69 6e 67 6c 65  me are meaningle
21c00 73 73 2e 20 20 46 75 74 75 72 65 20 76 65 72 73  ss.  Future vers
21c10 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74 65 0a 2a  ions of SQLite.*
21c20 2a 20 6d 69 67 68 74 20 70 72 6f 76 69 64 65 20  * might provide 
21c30 67 72 65 61 74 65 72 20 72 65 73 6f 6c 75 74 69  greater resoluti
21c40 6f 6e 20 6f 6e 20 74 68 65 20 70 72 6f 66 69 6c  on on the profil
21c50 65 72 20 63 61 6c 6c 62 61 63 6b 2e 20 20 54 68  er callback.  Th
21c60 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 70 72 6f  e.** sqlite3_pro
21c70 66 69 6c 65 28 29 20 66 75 6e 63 74 69 6f 6e 20  file() function 
21c80 69 73 20 63 6f 6e 73 69 64 65 72 65 64 20 65 78  is considered ex
21c90 70 65 72 69 6d 65 6e 74 61 6c 20 61 6e 64 20 69  perimental and i
21ca0 73 0a 2a 2a 20 73 75 62 6a 65 63 74 20 74 6f 20  s.** subject to 
21cb0 63 68 61 6e 67 65 20 69 6e 20 66 75 74 75 72 65  change in future
21cc0 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c   versions of SQL
21cd0 69 74 65 2e 0a 2a 2f 0a 76 6f 69 64 20 2a 73 71  ite..*/.void *sq
21ce0 6c 69 74 65 33 5f 74 72 61 63 65 28 73 71 6c 69  lite3_trace(sqli
21cf0 74 65 33 2a 2c 20 76 6f 69 64 28 2a 78 54 72 61  te3*, void(*xTra
21d00 63 65 29 28 76 6f 69 64 2a 2c 63 6f 6e 73 74 20  ce)(void*,const 
21d10 63 68 61 72 2a 29 2c 20 76 6f 69 64 2a 29 3b 0a  char*), void*);.
21d20 53 51 4c 49 54 45 5f 45 58 50 45 52 49 4d 45 4e  SQLITE_EXPERIMEN
21d30 54 41 4c 20 76 6f 69 64 20 2a 73 71 6c 69 74 65  TAL void *sqlite
21d40 33 5f 70 72 6f 66 69 6c 65 28 73 71 6c 69 74 65  3_profile(sqlite
21d50 33 2a 2c 0a 20 20 20 76 6f 69 64 28 2a 78 50 72  3*,.   void(*xPr
21d60 6f 66 69 6c 65 29 28 76 6f 69 64 2a 2c 63 6f 6e  ofile)(void*,con
21d70 73 74 20 63 68 61 72 2a 2c 73 71 6c 69 74 65 33  st char*,sqlite3
21d80 5f 75 69 6e 74 36 34 29 2c 20 76 6f 69 64 2a 29  _uint64), void*)
21d90 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
21da0 46 3a 20 51 75 65 72 79 20 50 72 6f 67 72 65 73  F: Query Progres
21db0 73 20 43 61 6c 6c 62 61 63 6b 73 0a 2a 2a 20 4d  s Callbacks.** M
21dc0 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a  ETHOD: sqlite3.*
21dd0 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65  *.** ^The sqlite
21de0 33 5f 70 72 6f 67 72 65 73 73 5f 68 61 6e 64 6c  3_progress_handl
21df0 65 72 28 44 2c 4e 2c 58 2c 50 29 20 69 6e 74 65  er(D,N,X,P) inte
21e00 72 66 61 63 65 20 63 61 75 73 65 73 20 74 68 65  rface causes the
21e10 20 63 61 6c 6c 62 61 63 6b 0a 2a 2a 20 66 75 6e   callback.** fun
21e20 63 74 69 6f 6e 20 58 20 74 6f 20 62 65 20 69 6e  ction X to be in
21e30 76 6f 6b 65 64 20 70 65 72 69 6f 64 69 63 61 6c  voked periodical
21e40 6c 79 20 64 75 72 69 6e 67 20 6c 6f 6e 67 20 72  ly during long r
21e50 75 6e 6e 69 6e 67 20 63 61 6c 6c 73 20 74 6f 0a  unning calls to.
21e60 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 65 78 65 63  ** [sqlite3_exec
21e70 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 73 74  ()], [sqlite3_st
21e80 65 70 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74  ep()] and [sqlit
21e90 65 33 5f 67 65 74 5f 74 61 62 6c 65 28 29 5d 20  e3_get_table()] 
21ea0 66 6f 72 0a 2a 2a 20 64 61 74 61 62 61 73 65 20  for.** database 
21eb0 63 6f 6e 6e 65 63 74 69 6f 6e 20 44 2e 20 20 41  connection D.  A
21ec0 6e 20 65 78 61 6d 70 6c 65 20 75 73 65 20 66 6f  n example use fo
21ed0 72 20 74 68 69 73 0a 2a 2a 20 69 6e 74 65 72 66  r this.** interf
21ee0 61 63 65 20 69 73 20 74 6f 20 6b 65 65 70 20 61  ace is to keep a
21ef0 20 47 55 49 20 75 70 64 61 74 65 64 20 64 75 72   GUI updated dur
21f00 69 6e 67 20 61 20 6c 61 72 67 65 20 71 75 65 72  ing a large quer
21f10 79 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 70 61  y..**.** ^The pa
21f20 72 61 6d 65 74 65 72 20 50 20 69 73 20 70 61 73  rameter P is pas
21f30 73 65 64 20 74 68 72 6f 75 67 68 20 61 73 20 74  sed through as t
21f40 68 65 20 6f 6e 6c 79 20 70 61 72 61 6d 65 74 65  he only paramete
21f50 72 20 74 6f 20 74 68 65 20 0a 2a 2a 20 63 61 6c  r to the .** cal
21f60 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 20 58  lback function X
21f70 2e 20 20 5e 54 68 65 20 70 61 72 61 6d 65 74 65  .  ^The paramete
21f80 72 20 4e 20 69 73 20 74 68 65 20 61 70 70 72 6f  r N is the appro
21f90 78 69 6d 61 74 65 20 6e 75 6d 62 65 72 20 6f 66  ximate number of
21fa0 20 0a 2a 2a 20 5b 76 69 72 74 75 61 6c 20 6d 61   .** [virtual ma
21fb0 63 68 69 6e 65 20 69 6e 73 74 72 75 63 74 69 6f  chine instructio
21fc0 6e 73 5d 20 74 68 61 74 20 61 72 65 20 65 76 61  ns] that are eva
21fd0 6c 75 61 74 65 64 20 62 65 74 77 65 65 6e 20 73  luated between s
21fe0 75 63 63 65 73 73 69 76 65 0a 2a 2a 20 69 6e 76  uccessive.** inv
21ff0 6f 63 61 74 69 6f 6e 73 20 6f 66 20 74 68 65 20  ocations of the 
22000 63 61 6c 6c 62 61 63 6b 20 58 2e 20 20 5e 49 66  callback X.  ^If
22010 20 4e 20 69 73 20 6c 65 73 73 20 74 68 61 6e 20   N is less than 
22020 6f 6e 65 20 74 68 65 6e 20 74 68 65 20 70 72 6f  one then the pro
22030 67 72 65 73 73 0a 2a 2a 20 68 61 6e 64 6c 65 72  gress.** handler
22040 20 69 73 20 64 69 73 61 62 6c 65 64 2e 0a 2a 2a   is disabled..**
22050 0a 2a 2a 20 5e 4f 6e 6c 79 20 61 20 73 69 6e 67  .** ^Only a sing
22060 6c 65 20 70 72 6f 67 72 65 73 73 20 68 61 6e 64  le progress hand
22070 6c 65 72 20 6d 61 79 20 62 65 20 64 65 66 69 6e  ler may be defin
22080 65 64 20 61 74 20 6f 6e 65 20 74 69 6d 65 20 70  ed at one time p
22090 65 72 0a 2a 2a 20 5b 64 61 74 61 62 61 73 65 20  er.** [database 
220a0 63 6f 6e 6e 65 63 74 69 6f 6e 5d 3b 20 73 65 74  connection]; set
220b0 74 69 6e 67 20 61 20 6e 65 77 20 70 72 6f 67 72  ting a new progr
220c0 65 73 73 20 68 61 6e 64 6c 65 72 20 63 61 6e 63  ess handler canc
220d0 65 6c 73 20 74 68 65 0a 2a 2a 20 6f 6c 64 20 6f  els the.** old o
220e0 6e 65 2e 20 20 5e 53 65 74 74 69 6e 67 20 70 61  ne.  ^Setting pa
220f0 72 61 6d 65 74 65 72 20 58 20 74 6f 20 4e 55 4c  rameter X to NUL
22100 4c 20 64 69 73 61 62 6c 65 73 20 74 68 65 20 70  L disables the p
22110 72 6f 67 72 65 73 73 20 68 61 6e 64 6c 65 72 2e  rogress handler.
22120 0a 2a 2a 20 5e 54 68 65 20 70 72 6f 67 72 65 73  .** ^The progres
22130 73 20 68 61 6e 64 6c 65 72 20 69 73 20 61 6c 73  s handler is als
22140 6f 20 64 69 73 61 62 6c 65 64 20 62 79 20 73 65  o disabled by se
22150 74 74 69 6e 67 20 4e 20 74 6f 20 61 20 76 61 6c  tting N to a val
22160 75 65 20 6c 65 73 73 0a 2a 2a 20 74 68 61 6e 20  ue less.** than 
22170 31 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65  1..**.** ^If the
22180 20 70 72 6f 67 72 65 73 73 20 63 61 6c 6c 62 61   progress callba
22190 63 6b 20 72 65 74 75 72 6e 73 20 6e 6f 6e 2d 7a  ck returns non-z
221a0 65 72 6f 2c 20 74 68 65 20 6f 70 65 72 61 74 69  ero, the operati
221b0 6f 6e 20 69 73 0a 2a 2a 20 69 6e 74 65 72 72 75  on is.** interru
221c0 70 74 65 64 2e 20 20 54 68 69 73 20 66 65 61 74  pted.  This feat
221d0 75 72 65 20 63 61 6e 20 62 65 20 75 73 65 64 20  ure can be used 
221e0 74 6f 20 69 6d 70 6c 65 6d 65 6e 74 20 61 0a 2a  to implement a.*
221f0 2a 20 22 43 61 6e 63 65 6c 22 20 62 75 74 74 6f  * "Cancel" butto
22200 6e 20 6f 6e 20 61 20 47 55 49 20 70 72 6f 67 72  n on a GUI progr
22210 65 73 73 20 64 69 61 6c 6f 67 20 62 6f 78 2e 0a  ess dialog box..
22220 2a 2a 0a 2a 2a 20 54 68 65 20 70 72 6f 67 72 65  **.** The progre
22230 73 73 20 68 61 6e 64 6c 65 72 20 63 61 6c 6c 62  ss handler callb
22240 61 63 6b 20 6d 75 73 74 20 6e 6f 74 20 64 6f 20  ack must not do 
22250 61 6e 79 74 68 69 6e 67 20 74 68 61 74 20 77 69  anything that wi
22260 6c 6c 20 6d 6f 64 69 66 79 0a 2a 2a 20 74 68 65  ll modify.** the
22270 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63   database connec
22280 74 69 6f 6e 20 74 68 61 74 20 69 6e 76 6f 6b 65  tion that invoke
22290 64 20 74 68 65 20 70 72 6f 67 72 65 73 73 20 68  d the progress h
222a0 61 6e 64 6c 65 72 2e 0a 2a 2a 20 4e 6f 74 65 20  andler..** Note 
222b0 74 68 61 74 20 5b 73 71 6c 69 74 65 33 5f 70 72  that [sqlite3_pr
222c0 65 70 61 72 65 5f 76 32 28 29 5d 20 61 6e 64 20  epare_v2()] and 
222d0 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d  [sqlite3_step()]
222e0 20 62 6f 74 68 20 6d 6f 64 69 66 79 20 74 68 65   both modify the
222f0 69 72 0a 2a 2a 20 64 61 74 61 62 61 73 65 20 63  ir.** database c
22300 6f 6e 6e 65 63 74 69 6f 6e 73 20 66 6f 72 20 74  onnections for t
22310 68 65 20 6d 65 61 6e 69 6e 67 20 6f 66 20 22 6d  he meaning of "m
22320 6f 64 69 66 79 22 20 69 6e 20 74 68 69 73 20 70  odify" in this p
22330 61 72 61 67 72 61 70 68 2e 0a 2a 2a 0a 2a 2f 0a  aragraph..**.*/.
22340 76 6f 69 64 20 73 71 6c 69 74 65 33 5f 70 72 6f  void sqlite3_pro
22350 67 72 65 73 73 5f 68 61 6e 64 6c 65 72 28 73 71  gress_handler(sq
22360 6c 69 74 65 33 2a 2c 20 69 6e 74 2c 20 69 6e 74  lite3*, int, int
22370 28 2a 29 28 76 6f 69 64 2a 29 2c 20 76 6f 69 64  (*)(void*), void
22380 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  *);../*.** CAPI3
22390 52 45 46 3a 20 4f 70 65 6e 69 6e 67 20 41 20 4e  REF: Opening A N
223a0 65 77 20 44 61 74 61 62 61 73 65 20 43 6f 6e 6e  ew Database Conn
223b0 65 63 74 69 6f 6e 0a 2a 2a 20 43 4f 4e 53 54 52  ection.** CONSTR
223c0 55 43 54 4f 52 3a 20 73 71 6c 69 74 65 33 0a 2a  UCTOR: sqlite3.*
223d0 2a 0a 2a 2a 20 5e 54 68 65 73 65 20 72 6f 75 74  *.** ^These rout
223e0 69 6e 65 73 20 6f 70 65 6e 20 61 6e 20 53 51 4c  ines open an SQL
223f0 69 74 65 20 64 61 74 61 62 61 73 65 20 66 69 6c  ite database fil
22400 65 20 61 73 20 73 70 65 63 69 66 69 65 64 20 62  e as specified b
22410 79 20 74 68 65 20 0a 2a 2a 20 66 69 6c 65 6e 61  y the .** filena
22420 6d 65 20 61 72 67 75 6d 65 6e 74 2e 20 5e 54 68  me argument. ^Th
22430 65 20 66 69 6c 65 6e 61 6d 65 20 61 72 67 75 6d  e filename argum
22440 65 6e 74 20 69 73 20 69 6e 74 65 72 70 72 65 74  ent is interpret
22450 65 64 20 61 73 20 55 54 46 2d 38 20 66 6f 72 0a  ed as UTF-8 for.
22460 2a 2a 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28  ** sqlite3_open(
22470 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 6f 70  ) and sqlite3_op
22480 65 6e 5f 76 32 28 29 20 61 6e 64 20 61 73 20 55  en_v2() and as U
22490 54 46 2d 31 36 20 69 6e 20 74 68 65 20 6e 61 74  TF-16 in the nat
224a0 69 76 65 20 62 79 74 65 0a 2a 2a 20 6f 72 64 65  ive byte.** orde
224b0 72 20 66 6f 72 20 73 71 6c 69 74 65 33 5f 6f 70  r for sqlite3_op
224c0 65 6e 31 36 28 29 2e 20 5e 28 41 20 5b 64 61 74  en16(). ^(A [dat
224d0 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
224e0 5d 20 68 61 6e 64 6c 65 20 69 73 20 75 73 75 61  ] handle is usua
224f0 6c 6c 79 0a 2a 2a 20 72 65 74 75 72 6e 65 64 20  lly.** returned 
22500 69 6e 20 2a 70 70 44 62 2c 20 65 76 65 6e 20 69  in *ppDb, even i
22510 66 20 61 6e 20 65 72 72 6f 72 20 6f 63 63 75 72  f an error occur
22520 73 2e 20 20 54 68 65 20 6f 6e 6c 79 20 65 78 63  s.  The only exc
22530 65 70 74 69 6f 6e 20 69 73 20 74 68 61 74 0a 2a  eption is that.*
22540 2a 20 69 66 20 53 51 4c 69 74 65 20 69 73 20 75  * if SQLite is u
22550 6e 61 62 6c 65 20 74 6f 20 61 6c 6c 6f 63 61 74  nable to allocat
22560 65 20 6d 65 6d 6f 72 79 20 74 6f 20 68 6f 6c 64  e memory to hold
22570 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5d 20 6f   the [sqlite3] o
22580 62 6a 65 63 74 2c 0a 2a 2a 20 61 20 4e 55 4c 4c  bject,.** a NULL
22590 20 77 69 6c 6c 20 62 65 20 77 72 69 74 74 65 6e   will be written
225a0 20 69 6e 74 6f 20 2a 70 70 44 62 20 69 6e 73 74   into *ppDb inst
225b0 65 61 64 20 6f 66 20 61 20 70 6f 69 6e 74 65 72  ead of a pointer
225c0 20 74 6f 20 74 68 65 20 5b 73 71 6c 69 74 65 33   to the [sqlite3
225d0 5d 0a 2a 2a 20 6f 62 6a 65 63 74 2e 29 5e 20 5e  ].** object.)^ ^
225e0 28 49 66 20 74 68 65 20 64 61 74 61 62 61 73 65  (If the database
225f0 20 69 73 20 6f 70 65 6e 65 64 20 28 61 6e 64 2f   is opened (and/
22600 6f 72 20 63 72 65 61 74 65 64 29 20 73 75 63 63  or created) succ
22610 65 73 73 66 75 6c 6c 79 2c 20 74 68 65 6e 0a 2a  essfully, then.*
22620 2a 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 69 73  * [SQLITE_OK] is
22630 20 72 65 74 75 72 6e 65 64 2e 20 20 4f 74 68 65   returned.  Othe
22640 72 77 69 73 65 20 61 6e 20 5b 65 72 72 6f 72 20  rwise an [error 
22650 63 6f 64 65 5d 20 69 73 20 72 65 74 75 72 6e 65  code] is returne
22660 64 2e 29 5e 20 5e 54 68 65 0a 2a 2a 20 5b 73 71  d.)^ ^The.** [sq
22670 6c 69 74 65 33 5f 65 72 72 6d 73 67 28 29 5d 20  lite3_errmsg()] 
22680 6f 72 20 5b 73 71 6c 69 74 65 33 5f 65 72 72 6d  or [sqlite3_errm
22690 73 67 31 36 28 29 5d 20 72 6f 75 74 69 6e 65 73  sg16()] routines
226a0 20 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20   can be used to 
226b0 6f 62 74 61 69 6e 0a 2a 2a 20 61 6e 20 45 6e 67  obtain.** an Eng
226c0 6c 69 73 68 20 6c 61 6e 67 75 61 67 65 20 64 65  lish language de
226d0 73 63 72 69 70 74 69 6f 6e 20 6f 66 20 74 68 65  scription of the
226e0 20 65 72 72 6f 72 20 66 6f 6c 6c 6f 77 69 6e 67   error following
226f0 20 61 20 66 61 69 6c 75 72 65 20 6f 66 20 61 6e   a failure of an
22700 79 0a 2a 2a 20 6f 66 20 74 68 65 20 73 71 6c 69  y.** of the sqli
22710 74 65 33 5f 6f 70 65 6e 28 29 20 72 6f 75 74 69  te3_open() routi
22720 6e 65 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  nes..**.** ^The 
22730 64 65 66 61 75 6c 74 20 65 6e 63 6f 64 69 6e 67  default encoding
22740 20 77 69 6c 6c 20 62 65 20 55 54 46 2d 38 20 66   will be UTF-8 f
22750 6f 72 20 64 61 74 61 62 61 73 65 73 20 63 72 65  or databases cre
22760 61 74 65 64 20 75 73 69 6e 67 0a 2a 2a 20 73 71  ated using.** sq
22770 6c 69 74 65 33 5f 6f 70 65 6e 28 29 20 6f 72 20  lite3_open() or 
22780 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28  sqlite3_open_v2(
22790 29 2e 20 20 5e 54 68 65 20 64 65 66 61 75 6c 74  ).  ^The default
227a0 20 65 6e 63 6f 64 69 6e 67 20 66 6f 72 20 64 61   encoding for da
227b0 74 61 62 61 73 65 73 0a 2a 2a 20 63 72 65 61 74  tabases.** creat
227c0 65 64 20 75 73 69 6e 67 20 73 71 6c 69 74 65 33  ed using sqlite3
227d0 5f 6f 70 65 6e 31 36 28 29 20 77 69 6c 6c 20 62  _open16() will b
227e0 65 20 55 54 46 2d 31 36 20 69 6e 20 74 68 65 20  e UTF-16 in the 
227f0 6e 61 74 69 76 65 20 62 79 74 65 20 6f 72 64 65  native byte orde
22800 72 2e 0a 2a 2a 0a 2a 2a 20 57 68 65 74 68 65 72  r..**.** Whether
22810 20 6f 72 20 6e 6f 74 20 61 6e 20 65 72 72 6f 72   or not an error
22820 20 6f 63 63 75 72 73 20 77 68 65 6e 20 69 74 20   occurs when it 
22830 69 73 20 6f 70 65 6e 65 64 2c 20 72 65 73 6f 75  is opened, resou
22840 72 63 65 73 0a 2a 2a 20 61 73 73 6f 63 69 61 74  rces.** associat
22850 65 64 20 77 69 74 68 20 74 68 65 20 5b 64 61 74  ed with the [dat
22860 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
22870 5d 20 68 61 6e 64 6c 65 20 73 68 6f 75 6c 64 20  ] handle should 
22880 62 65 20 72 65 6c 65 61 73 65 64 20 62 79 0a 2a  be released by.*
22890 2a 20 70 61 73 73 69 6e 67 20 69 74 20 74 6f 20  * passing it to 
228a0 5b 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 28 29  [sqlite3_close()
228b0 5d 20 77 68 65 6e 20 69 74 20 69 73 20 6e 6f 20  ] when it is no 
228c0 6c 6f 6e 67 65 72 20 72 65 71 75 69 72 65 64 2e  longer required.
228d0 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74  .**.** The sqlit
228e0 65 33 5f 6f 70 65 6e 5f 76 32 28 29 20 69 6e 74  e3_open_v2() int
228f0 65 72 66 61 63 65 20 77 6f 72 6b 73 20 6c 69 6b  erface works lik
22900 65 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29  e sqlite3_open()
22910 0a 2a 2a 20 65 78 63 65 70 74 20 74 68 61 74 20  .** except that 
22920 69 74 20 61 63 63 65 70 74 73 20 74 77 6f 20 61  it accepts two a
22930 64 64 69 74 69 6f 6e 61 6c 20 70 61 72 61 6d 65  dditional parame
22940 74 65 72 73 20 66 6f 72 20 61 64 64 69 74 69 6f  ters for additio
22950 6e 61 6c 20 63 6f 6e 74 72 6f 6c 0a 2a 2a 20 6f  nal control.** o
22960 76 65 72 20 74 68 65 20 6e 65 77 20 64 61 74 61  ver the new data
22970 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e  base connection.
22980 20 20 5e 28 54 68 65 20 66 6c 61 67 73 20 70 61    ^(The flags pa
22990 72 61 6d 65 74 65 72 20 74 6f 0a 2a 2a 20 73 71  rameter to.** sq
229a0 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 20  lite3_open_v2() 
229b0 63 61 6e 20 74 61 6b 65 20 6f 6e 65 20 6f 66 0a  can take one of.
229c0 2a 2a 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67  ** the following
229d0 20 74 68 72 65 65 20 76 61 6c 75 65 73 2c 20 6f   three values, o
229e0 70 74 69 6f 6e 61 6c 6c 79 20 63 6f 6d 62 69 6e  ptionally combin
229f0 65 64 20 77 69 74 68 20 74 68 65 20 0a 2a 2a 20  ed with the .** 
22a00 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 4e 4f 4d  [SQLITE_OPEN_NOM
22a10 55 54 45 58 5d 2c 20 5b 53 51 4c 49 54 45 5f 4f  UTEX], [SQLITE_O
22a20 50 45 4e 5f 46 55 4c 4c 4d 55 54 45 58 5d 2c 20  PEN_FULLMUTEX], 
22a30 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 53 48 41  [SQLITE_OPEN_SHA
22a40 52 45 44 43 41 43 48 45 5d 2c 0a 2a 2a 20 5b 53  REDCACHE],.** [S
22a50 51 4c 49 54 45 5f 4f 50 45 4e 5f 50 52 49 56 41  QLITE_OPEN_PRIVA
22a60 54 45 43 41 43 48 45 5d 2c 20 61 6e 64 2f 6f 72  TECACHE], and/or
22a70 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 55 52   [SQLITE_OPEN_UR
22a80 49 5d 20 66 6c 61 67 73 3a 29 5e 0a 2a 2a 0a 2a  I] flags:)^.**.*
22a90 2a 20 3c 64 6c 3e 0a 2a 2a 20 5e 28 3c 64 74 3e  * <dl>.** ^(<dt>
22aa0 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 52 45 41  [SQLITE_OPEN_REA
22ab0 44 4f 4e 4c 59 5d 3c 2f 64 74 3e 0a 2a 2a 20 3c  DONLY]</dt>.** <
22ac0 64 64 3e 54 68 65 20 64 61 74 61 62 61 73 65 20  dd>The database 
22ad0 69 73 20 6f 70 65 6e 65 64 20 69 6e 20 72 65 61  is opened in rea
22ae0 64 2d 6f 6e 6c 79 20 6d 6f 64 65 2e 20 20 49 66  d-only mode.  If
22af0 20 74 68 65 20 64 61 74 61 62 61 73 65 20 64 6f   the database do
22b00 65 73 20 6e 6f 74 0a 2a 2a 20 61 6c 72 65 61 64  es not.** alread
22b10 79 20 65 78 69 73 74 2c 20 61 6e 20 65 72 72 6f  y exist, an erro
22b20 72 20 69 73 20 72 65 74 75 72 6e 65 64 2e 3c 2f  r is returned.</
22b30 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 28 3c 64  dd>)^.**.** ^(<d
22b40 74 3e 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 52  t>[SQLITE_OPEN_R
22b50 45 41 44 57 52 49 54 45 5d 3c 2f 64 74 3e 0a 2a  EADWRITE]</dt>.*
22b60 2a 20 3c 64 64 3e 54 68 65 20 64 61 74 61 62 61  * <dd>The databa
22b70 73 65 20 69 73 20 6f 70 65 6e 65 64 20 66 6f 72  se is opened for
22b80 20 72 65 61 64 69 6e 67 20 61 6e 64 20 77 72 69   reading and wri
22b90 74 69 6e 67 20 69 66 20 70 6f 73 73 69 62 6c 65  ting if possible
22ba0 2c 20 6f 72 20 72 65 61 64 69 6e 67 0a 2a 2a 20  , or reading.** 
22bb0 6f 6e 6c 79 20 69 66 20 74 68 65 20 66 69 6c 65  only if the file
22bc0 20 69 73 20 77 72 69 74 65 20 70 72 6f 74 65 63   is write protec
22bd0 74 65 64 20 62 79 20 74 68 65 20 6f 70 65 72 61  ted by the opera
22be0 74 69 6e 67 20 73 79 73 74 65 6d 2e 20 20 49 6e  ting system.  In
22bf0 20 65 69 74 68 65 72 0a 2a 2a 20 63 61 73 65 20   either.** case 
22c00 74 68 65 20 64 61 74 61 62 61 73 65 20 6d 75 73  the database mus
22c10 74 20 61 6c 72 65 61 64 79 20 65 78 69 73 74 2c  t already exist,
22c20 20 6f 74 68 65 72 77 69 73 65 20 61 6e 20 65 72   otherwise an er
22c30 72 6f 72 20 69 73 20 72 65 74 75 72 6e 65 64 2e  ror is returned.
22c40 3c 2f 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 28  </dd>)^.**.** ^(
22c50 3c 64 74 3e 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  <dt>[SQLITE_OPEN
22c60 5f 52 45 41 44 57 52 49 54 45 5d 20 7c 20 5b 53  _READWRITE] | [S
22c70 51 4c 49 54 45 5f 4f 50 45 4e 5f 43 52 45 41 54  QLITE_OPEN_CREAT
22c80 45 5d 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54  E]</dt>.** <dd>T
22c90 68 65 20 64 61 74 61 62 61 73 65 20 69 73 20 6f  he database is o
22ca0 70 65 6e 65 64 20 66 6f 72 20 72 65 61 64 69 6e  pened for readin
22cb0 67 20 61 6e 64 20 77 72 69 74 69 6e 67 2c 20 61  g and writing, a
22cc0 6e 64 20 69 73 20 63 72 65 61 74 65 64 20 69 66  nd is created if
22cd0 0a 2a 2a 20 69 74 20 64 6f 65 73 20 6e 6f 74 20  .** it does not 
22ce0 61 6c 72 65 61 64 79 20 65 78 69 73 74 2e 20 54  already exist. T
22cf0 68 69 73 20 69 73 20 74 68 65 20 62 65 68 61 76  his is the behav
22d00 69 6f 72 20 74 68 61 74 20 69 73 20 61 6c 77 61  ior that is alwa
22d10 79 73 20 75 73 65 64 20 66 6f 72 0a 2a 2a 20 73  ys used for.** s
22d20 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 20 61 6e  qlite3_open() an
22d30 64 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31 36  d sqlite3_open16
22d40 28 29 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 20 3c 2f  ().</dd>)^.** </
22d50 64 6c 3e 0a 2a 2a 0a 2a 2a 20 49 66 20 74 68 65  dl>.**.** If the
22d60 20 33 72 64 20 70 61 72 61 6d 65 74 65 72 20 74   3rd parameter t
22d70 6f 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76  o sqlite3_open_v
22d80 32 28 29 20 69 73 20 6e 6f 74 20 6f 6e 65 20 6f  2() is not one o
22d90 66 20 74 68 65 0a 2a 2a 20 63 6f 6d 62 69 6e 61  f the.** combina
22da0 74 69 6f 6e 73 20 73 68 6f 77 6e 20 61 62 6f 76  tions shown abov
22db0 65 20 6f 70 74 69 6f 6e 61 6c 6c 79 20 63 6f 6d  e optionally com
22dc0 62 69 6e 65 64 20 77 69 74 68 20 6f 74 68 65 72  bined with other
22dd0 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  .** [SQLITE_OPEN
22de0 5f 52 45 41 44 4f 4e 4c 59 20 7c 20 53 51 4c 49  _READONLY | SQLI
22df0 54 45 5f 4f 50 45 4e 5f 2a 20 62 69 74 73 5d 0a  TE_OPEN_* bits].
22e00 2a 2a 20 74 68 65 6e 20 74 68 65 20 62 65 68 61  ** then the beha
22e10 76 69 6f 72 20 69 73 20 75 6e 64 65 66 69 6e 65  vior is undefine
22e20 64 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65  d..**.** ^If the
22e30 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 4e 4f   [SQLITE_OPEN_NO
22e40 4d 55 54 45 58 5d 20 66 6c 61 67 20 69 73 20 73  MUTEX] flag is s
22e50 65 74 2c 20 74 68 65 6e 20 74 68 65 20 64 61 74  et, then the dat
22e60 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
22e70 0a 2a 2a 20 6f 70 65 6e 73 20 69 6e 20 74 68 65  .** opens in the
22e80 20 6d 75 6c 74 69 2d 74 68 72 65 61 64 20 5b 74   multi-thread [t
22e90 68 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 61  hreading mode] a
22ea0 73 20 6c 6f 6e 67 20 61 73 20 74 68 65 20 73 69  s long as the si
22eb0 6e 67 6c 65 2d 74 68 72 65 61 64 0a 2a 2a 20 6d  ngle-thread.** m
22ec0 6f 64 65 20 68 61 73 20 6e 6f 74 20 62 65 65 6e  ode has not been
22ed0 20 73 65 74 20 61 74 20 63 6f 6d 70 69 6c 65 2d   set at compile-
22ee0 74 69 6d 65 20 6f 72 20 73 74 61 72 74 2d 74 69  time or start-ti
22ef0 6d 65 2e 20 20 5e 49 66 20 74 68 65 0a 2a 2a 20  me.  ^If the.** 
22f00 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 46 55 4c  [SQLITE_OPEN_FUL
22f10 4c 4d 55 54 45 58 5d 20 66 6c 61 67 20 69 73 20  LMUTEX] flag is 
22f20 73 65 74 20 74 68 65 6e 20 74 68 65 20 64 61 74  set then the dat
22f30 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
22f40 20 6f 70 65 6e 73 0a 2a 2a 20 69 6e 20 74 68 65   opens.** in the
22f50 20 73 65 72 69 61 6c 69 7a 65 64 20 5b 74 68 72   serialized [thr
22f60 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 75 6e 6c  eading mode] unl
22f70 65 73 73 20 73 69 6e 67 6c 65 2d 74 68 72 65 61  ess single-threa
22f80 64 20 77 61 73 0a 2a 2a 20 70 72 65 76 69 6f 75  d was.** previou
22f90 73 6c 79 20 73 65 6c 65 63 74 65 64 20 61 74 20  sly selected at 
22fa0 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 72 20  compile-time or 
22fb0 73 74 61 72 74 2d 74 69 6d 65 2e 0a 2a 2a 20 5e  start-time..** ^
22fc0 54 68 65 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  The [SQLITE_OPEN
22fd0 5f 53 48 41 52 45 44 43 41 43 48 45 5d 20 66 6c  _SHAREDCACHE] fl
22fe0 61 67 20 63 61 75 73 65 73 20 74 68 65 20 64 61  ag causes the da
22ff0 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
23000 6e 20 74 6f 20 62 65 0a 2a 2a 20 65 6c 69 67 69  n to be.** eligi
23010 62 6c 65 20 74 6f 20 75 73 65 20 5b 73 68 61 72  ble to use [shar
23020 65 64 20 63 61 63 68 65 20 6d 6f 64 65 5d 2c 20  ed cache mode], 
23030 72 65 67 61 72 64 6c 65 73 73 20 6f 66 20 77 68  regardless of wh
23040 65 74 68 65 72 20 6f 72 20 6e 6f 74 20 73 68 61  ether or not sha
23050 72 65 64 0a 2a 2a 20 63 61 63 68 65 20 69 73 20  red.** cache is 
23060 65 6e 61 62 6c 65 64 20 75 73 69 6e 67 20 5b 73  enabled using [s
23070 71 6c 69 74 65 33 5f 65 6e 61 62 6c 65 5f 73 68  qlite3_enable_sh
23080 61 72 65 64 5f 63 61 63 68 65 28 29 5d 2e 20 20  ared_cache()].  
23090 5e 54 68 65 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f  ^The.** [SQLITE_
230a0 4f 50 45 4e 5f 50 52 49 56 41 54 45 43 41 43 48  OPEN_PRIVATECACH
230b0 45 5d 20 66 6c 61 67 20 63 61 75 73 65 73 20 74  E] flag causes t
230c0 68 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  he database conn
230d0 65 63 74 69 6f 6e 20 74 6f 20 6e 6f 74 0a 2a 2a  ection to not.**
230e0 20 70 61 72 74 69 63 69 70 61 74 65 20 69 6e 20   participate in 
230f0 5b 73 68 61 72 65 64 20 63 61 63 68 65 20 6d 6f  [shared cache mo
23100 64 65 5d 20 65 76 65 6e 20 69 66 20 69 74 20 69  de] even if it i
23110 73 20 65 6e 61 62 6c 65 64 2e 0a 2a 2a 0a 2a 2a  s enabled..**.**
23120 20 5e 54 68 65 20 66 6f 75 72 74 68 20 70 61 72   ^The fourth par
23130 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65  ameter to sqlite
23140 33 5f 6f 70 65 6e 5f 76 32 28 29 20 69 73 20 74  3_open_v2() is t
23150 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 0a 2a  he name of the.*
23160 2a 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5d 20  * [sqlite3_vfs] 
23170 6f 62 6a 65 63 74 20 74 68 61 74 20 64 65 66 69  object that defi
23180 6e 65 73 20 74 68 65 20 6f 70 65 72 61 74 69 6e  nes the operatin
23190 67 20 73 79 73 74 65 6d 20 69 6e 74 65 72 66 61  g system interfa
231a0 63 65 20 74 68 61 74 0a 2a 2a 20 74 68 65 20 6e  ce that.** the n
231b0 65 77 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  ew database conn
231c0 65 63 74 69 6f 6e 20 73 68 6f 75 6c 64 20 75 73  ection should us
231d0 65 2e 20 20 5e 49 66 20 74 68 65 20 66 6f 75 72  e.  ^If the four
231e0 74 68 20 70 61 72 61 6d 65 74 65 72 20 69 73 0a  th parameter is.
231f0 2a 2a 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  ** a NULL pointe
23200 72 20 74 68 65 6e 20 74 68 65 20 64 65 66 61 75  r then the defau
23210 6c 74 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5d  lt [sqlite3_vfs]
23220 20 6f 62 6a 65 63 74 20 69 73 20 75 73 65 64 2e   object is used.
23230 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 66  .**.** ^If the f
23240 69 6c 65 6e 61 6d 65 20 69 73 20 22 3a 6d 65 6d  ilename is ":mem
23250 6f 72 79 3a 22 2c 20 74 68 65 6e 20 61 20 70 72  ory:", then a pr
23260 69 76 61 74 65 2c 20 74 65 6d 70 6f 72 61 72 79  ivate, temporary
23270 20 69 6e 2d 6d 65 6d 6f 72 79 20 64 61 74 61 62   in-memory datab
23280 61 73 65 0a 2a 2a 20 69 73 20 63 72 65 61 74 65  ase.** is create
23290 64 20 66 6f 72 20 74 68 65 20 63 6f 6e 6e 65 63  d for the connec
232a0 74 69 6f 6e 2e 20 20 5e 54 68 69 73 20 69 6e 2d  tion.  ^This in-
232b0 6d 65 6d 6f 72 79 20 64 61 74 61 62 61 73 65 20  memory database 
232c0 77 69 6c 6c 20 76 61 6e 69 73 68 20 77 68 65 6e  will vanish when
232d0 0a 2a 2a 20 74 68 65 20 64 61 74 61 62 61 73 65  .** the database
232e0 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 63   connection is c
232f0 6c 6f 73 65 64 2e 20 20 46 75 74 75 72 65 20 76  losed.  Future v
23300 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74  ersions of SQLit
23310 65 20 6d 69 67 68 74 0a 2a 2a 20 6d 61 6b 65 20  e might.** make 
23320 75 73 65 20 6f 66 20 61 64 64 69 74 69 6f 6e 61  use of additiona
23330 6c 20 73 70 65 63 69 61 6c 20 66 69 6c 65 6e 61  l special filena
23340 6d 65 73 20 74 68 61 74 20 62 65 67 69 6e 20 77  mes that begin w
23350 69 74 68 20 74 68 65 20 22 3a 22 20 63 68 61 72  ith the ":" char
23360 61 63 74 65 72 2e 0a 2a 2a 20 49 74 20 69 73 20  acter..** It is 
23370 72 65 63 6f 6d 6d 65 6e 64 65 64 20 74 68 61 74  recommended that
23380 20 77 68 65 6e 20 61 20 64 61 74 61 62 61 73 65   when a database
23390 20 66 69 6c 65 6e 61 6d 65 20 61 63 74 75 61 6c   filename actual
233a0 6c 79 20 64 6f 65 73 20 62 65 67 69 6e 20 77 69  ly does begin wi
233b0 74 68 0a 2a 2a 20 61 20 22 3a 22 20 63 68 61 72  th.** a ":" char
233c0 61 63 74 65 72 20 79 6f 75 20 73 68 6f 75 6c 64  acter you should
233d0 20 70 72 65 66 69 78 20 74 68 65 20 66 69 6c 65   prefix the file
233e0 6e 61 6d 65 20 77 69 74 68 20 61 20 70 61 74 68  name with a path
233f0 6e 61 6d 65 20 73 75 63 68 20 61 73 0a 2a 2a 20  name such as.** 
23400 22 2e 2f 22 20 74 6f 20 61 76 6f 69 64 20 61 6d  "./" to avoid am
23410 62 69 67 75 69 74 79 2e 0a 2a 2a 0a 2a 2a 20 5e  biguity..**.** ^
23420 49 66 20 74 68 65 20 66 69 6c 65 6e 61 6d 65 20  If the filename 
23430 69 73 20 61 6e 20 65 6d 70 74 79 20 73 74 72 69  is an empty stri
23440 6e 67 2c 20 74 68 65 6e 20 61 20 70 72 69 76 61  ng, then a priva
23450 74 65 2c 20 74 65 6d 70 6f 72 61 72 79 0a 2a 2a  te, temporary.**
23460 20 6f 6e 2d 64 69 73 6b 20 64 61 74 61 62 61 73   on-disk databas
23470 65 20 77 69 6c 6c 20 62 65 20 63 72 65 61 74 65  e will be create
23480 64 2e 20 20 5e 54 68 69 73 20 70 72 69 76 61 74  d.  ^This privat
23490 65 20 64 61 74 61 62 61 73 65 20 77 69 6c 6c 20  e database will 
234a0 62 65 0a 2a 2a 20 61 75 74 6f 6d 61 74 69 63 61  be.** automatica
234b0 6c 6c 79 20 64 65 6c 65 74 65 64 20 61 73 20 73  lly deleted as s
234c0 6f 6f 6e 20 61 73 20 74 68 65 20 64 61 74 61 62  oon as the datab
234d0 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 69  ase connection i
234e0 73 20 63 6c 6f 73 65 64 2e 0a 2a 2a 0a 2a 2a 20  s closed..**.** 
234f0 5b 5b 55 52 49 20 66 69 6c 65 6e 61 6d 65 73 20  [[URI filenames 
23500 69 6e 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28  in sqlite3_open(
23510 29 5d 5d 20 3c 68 33 3e 55 52 49 20 46 69 6c 65  )]] <h3>URI File
23520 6e 61 6d 65 73 3c 2f 68 33 3e 0a 2a 2a 0a 2a 2a  names</h3>.**.**
23530 20 5e 49 66 20 5b 55 52 49 20 66 69 6c 65 6e 61   ^If [URI filena
23540 6d 65 5d 20 69 6e 74 65 72 70 72 65 74 61 74 69  me] interpretati
23550 6f 6e 20 69 73 20 65 6e 61 62 6c 65 64 2c 20 61  on is enabled, a
23560 6e 64 20 74 68 65 20 66 69 6c 65 6e 61 6d 65 20  nd the filename 
23570 61 72 67 75 6d 65 6e 74 0a 2a 2a 20 62 65 67 69  argument.** begi
23580 6e 73 20 77 69 74 68 20 22 66 69 6c 65 3a 22 2c  ns with "file:",
23590 20 74 68 65 6e 20 74 68 65 20 66 69 6c 65 6e 61   then the filena
235a0 6d 65 20 69 73 20 69 6e 74 65 72 70 72 65 74 65  me is interprete
235b0 64 20 61 73 20 61 20 55 52 49 2e 20 5e 55 52 49  d as a URI. ^URI
235c0 0a 2a 2a 20 66 69 6c 65 6e 61 6d 65 20 69 6e 74  .** filename int
235d0 65 72 70 72 65 74 61 74 69 6f 6e 20 69 73 20 65  erpretation is e
235e0 6e 61 62 6c 65 64 20 69 66 20 74 68 65 20 5b 53  nabled if the [S
235f0 51 4c 49 54 45 5f 4f 50 45 4e 5f 55 52 49 5d 20  QLITE_OPEN_URI] 
23600 66 6c 61 67 20 69 73 0a 2a 2a 20 73 65 74 20 69  flag is.** set i
23610 6e 20 74 68 65 20 66 6f 75 72 74 68 20 61 72 67  n the fourth arg
23620 75 6d 65 6e 74 20 74 6f 20 73 71 6c 69 74 65 33  ument to sqlite3
23630 5f 6f 70 65 6e 5f 76 32 28 29 2c 20 6f 72 20 69  _open_v2(), or i
23640 66 20 69 74 20 68 61 73 0a 2a 2a 20 62 65 65 6e  f it has.** been
23650 20 65 6e 61 62 6c 65 64 20 67 6c 6f 62 61 6c 6c   enabled globall
23660 79 20 75 73 69 6e 67 20 74 68 65 20 5b 53 51 4c  y using the [SQL
23670 49 54 45 5f 43 4f 4e 46 49 47 5f 55 52 49 5d 20  ITE_CONFIG_URI] 
23680 6f 70 74 69 6f 6e 20 77 69 74 68 20 74 68 65 0a  option with the.
23690 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66  ** [sqlite3_conf
236a0 69 67 28 29 5d 20 6d 65 74 68 6f 64 20 6f 72 20  ig()] method or 
236b0 62 79 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 55  by the [SQLITE_U
236c0 53 45 5f 55 52 49 5d 20 63 6f 6d 70 69 6c 65 2d  SE_URI] compile-
236d0 74 69 6d 65 20 6f 70 74 69 6f 6e 2e 0a 2a 2a 20  time option..** 
236e0 41 73 20 6f 66 20 53 51 4c 69 74 65 20 76 65 72  As of SQLite ver
236f0 73 69 6f 6e 20 33 2e 37 2e 37 2c 20 55 52 49 20  sion 3.7.7, URI 
23700 66 69 6c 65 6e 61 6d 65 20 69 6e 74 65 72 70 72  filename interpr
23710 65 74 61 74 69 6f 6e 20 69 73 20 74 75 72 6e 65  etation is turne
23720 64 20 6f 66 66 0a 2a 2a 20 62 79 20 64 65 66 61  d off.** by defa
23730 75 6c 74 2c 20 62 75 74 20 66 75 74 75 72 65 20  ult, but future 
23740 72 65 6c 65 61 73 65 73 20 6f 66 20 53 51 4c 69  releases of SQLi
23750 74 65 20 6d 69 67 68 74 20 65 6e 61 62 6c 65 20  te might enable 
23760 55 52 49 20 66 69 6c 65 6e 61 6d 65 0a 2a 2a 20  URI filename.** 
23770 69 6e 74 65 72 70 72 65 74 61 74 69 6f 6e 20 62  interpretation b
23780 79 20 64 65 66 61 75 6c 74 2e 20 20 53 65 65 20  y default.  See 
23790 22 5b 55 52 49 20 66 69 6c 65 6e 61 6d 65 73 5d  "[URI filenames]
237a0 22 20 66 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c  " for additional
237b0 0a 2a 2a 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e  .** information.
237c0 0a 2a 2a 0a 2a 2a 20 55 52 49 20 66 69 6c 65 6e  .**.** URI filen
237d0 61 6d 65 73 20 61 72 65 20 70 61 72 73 65 64 20  ames are parsed 
237e0 61 63 63 6f 72 64 69 6e 67 20 74 6f 20 52 46 43  according to RFC
237f0 20 33 39 38 36 2e 20 5e 49 66 20 74 68 65 20 55   3986. ^If the U
23800 52 49 20 63 6f 6e 74 61 69 6e 73 20 61 6e 0a 2a  RI contains an.*
23810 2a 20 61 75 74 68 6f 72 69 74 79 2c 20 74 68 65  * authority, the
23820 6e 20 69 74 20 6d 75 73 74 20 62 65 20 65 69 74  n it must be eit
23830 68 65 72 20 61 6e 20 65 6d 70 74 79 20 73 74 72  her an empty str
23840 69 6e 67 20 6f 72 20 74 68 65 20 73 74 72 69 6e  ing or the strin
23850 67 20 0a 2a 2a 20 22 6c 6f 63 61 6c 68 6f 73 74  g .** "localhost
23860 22 2e 20 5e 49 66 20 74 68 65 20 61 75 74 68 6f  ". ^If the autho
23870 72 69 74 79 20 69 73 20 6e 6f 74 20 61 6e 20 65  rity is not an e
23880 6d 70 74 79 20 73 74 72 69 6e 67 20 6f 72 20 22  mpty string or "
23890 6c 6f 63 61 6c 68 6f 73 74 22 2c 20 61 6e 20 0a  localhost", an .
238a0 2a 2a 20 65 72 72 6f 72 20 69 73 20 72 65 74 75  ** error is retu
238b0 72 6e 65 64 20 74 6f 20 74 68 65 20 63 61 6c 6c  rned to the call
238c0 65 72 2e 20 5e 54 68 65 20 66 72 61 67 6d 65 6e  er. ^The fragmen
238d0 74 20 63 6f 6d 70 6f 6e 65 6e 74 20 6f 66 20 61  t component of a
238e0 20 55 52 49 2c 20 69 66 20 0a 2a 2a 20 70 72 65   URI, if .** pre
238f0 73 65 6e 74 2c 20 69 73 20 69 67 6e 6f 72 65 64  sent, is ignored
23900 2e 0a 2a 2a 0a 2a 2a 20 5e 53 51 4c 69 74 65 20  ..**.** ^SQLite 
23910 75 73 65 73 20 74 68 65 20 70 61 74 68 20 63 6f  uses the path co
23920 6d 70 6f 6e 65 6e 74 20 6f 66 20 74 68 65 20 55  mponent of the U
23930 52 49 20 61 73 20 74 68 65 20 6e 61 6d 65 20 6f  RI as the name o
23940 66 20 74 68 65 20 64 69 73 6b 20 66 69 6c 65 0a  f the disk file.
23950 2a 2a 20 77 68 69 63 68 20 63 6f 6e 74 61 69 6e  ** which contain
23960 73 20 74 68 65 20 64 61 74 61 62 61 73 65 2e 20  s the database. 
23970 5e 49 66 20 74 68 65 20 70 61 74 68 20 62 65 67  ^If the path beg
23980 69 6e 73 20 77 69 74 68 20 61 20 27 2f 27 20 63  ins with a '/' c
23990 68 61 72 61 63 74 65 72 2c 20 0a 2a 2a 20 74 68  haracter, .** th
239a0 65 6e 20 69 74 20 69 73 20 69 6e 74 65 72 70 72  en it is interpr
239b0 65 74 65 64 20 61 73 20 61 6e 20 61 62 73 6f 6c  eted as an absol
239c0 75 74 65 20 70 61 74 68 2e 20 5e 49 66 20 74 68  ute path. ^If th
239d0 65 20 70 61 74 68 20 64 6f 65 73 20 6e 6f 74 20  e path does not 
239e0 62 65 67 69 6e 20 0a 2a 2a 20 77 69 74 68 20 61  begin .** with a
239f0 20 27 2f 27 20 28 6d 65 61 6e 69 6e 67 20 74 68   '/' (meaning th
23a00 61 74 20 74 68 65 20 61 75 74 68 6f 72 69 74 79  at the authority
23a10 20 73 65 63 74 69 6f 6e 20 69 73 20 6f 6d 69 74   section is omit
23a20 74 65 64 20 66 72 6f 6d 20 74 68 65 20 55 52 49  ted from the URI
23a30 29 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20 70 61  ).** then the pa
23a40 74 68 20 69 73 20 69 6e 74 65 72 70 72 65 74 65  th is interprete
23a50 64 20 61 73 20 61 20 72 65 6c 61 74 69 76 65 20  d as a relative 
23a60 70 61 74 68 2e 20 0a 2a 2a 20 5e 28 4f 6e 20 77  path. .** ^(On w
23a70 69 6e 64 6f 77 73 2c 20 74 68 65 20 66 69 72 73  indows, the firs
23a80 74 20 63 6f 6d 70 6f 6e 65 6e 74 20 6f 66 20 61  t component of a
23a90 6e 20 61 62 73 6f 6c 75 74 65 20 70 61 74 68 20  n absolute path 
23aa0 0a 2a 2a 20 69 73 20 61 20 64 72 69 76 65 20 73  .** is a drive s
23ab0 70 65 63 69 66 69 63 61 74 69 6f 6e 20 28 65 2e  pecification (e.
23ac0 67 2e 20 22 43 3a 22 29 2e 29 5e 0a 2a 2a 0a 2a  g. "C:").)^.**.*
23ad0 2a 20 5b 5b 63 6f 72 65 20 55 52 49 20 71 75 65  * [[core URI que
23ae0 72 79 20 70 61 72 61 6d 65 74 65 72 73 5d 5d 0a  ry parameters]].
23af0 2a 2a 20 54 68 65 20 71 75 65 72 79 20 63 6f 6d  ** The query com
23b00 70 6f 6e 65 6e 74 20 6f 66 20 61 20 55 52 49 20  ponent of a URI 
23b10 6d 61 79 20 63 6f 6e 74 61 69 6e 20 70 61 72 61  may contain para
23b20 6d 65 74 65 72 73 20 74 68 61 74 20 61 72 65 20  meters that are 
23b30 69 6e 74 65 72 70 72 65 74 65 64 0a 2a 2a 20 65  interpreted.** e
23b40 69 74 68 65 72 20 62 79 20 53 51 4c 69 74 65 20  ither by SQLite 
23b50 69 74 73 65 6c 66 2c 20 6f 72 20 62 79 20 61 20  itself, or by a 
23b60 5b 56 46 53 20 7c 20 63 75 73 74 6f 6d 20 56 46  [VFS | custom VF
23b70 53 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  S implementation
23b80 5d 2e 0a 2a 2a 20 53 51 4c 69 74 65 20 61 6e 64  ]..** SQLite and
23b90 20 69 74 73 20 62 75 69 6c 74 2d 69 6e 20 5b 56   its built-in [V
23ba0 46 53 65 73 5d 20 69 6e 74 65 72 70 72 65 74 20  FSes] interpret 
23bb0 74 68 65 0a 2a 2a 20 66 6f 6c 6c 6f 77 69 6e 67  the.** following
23bc0 20 71 75 65 72 79 20 70 61 72 61 6d 65 74 65 72   query parameter
23bd0 73 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a  s:.**.** <ul>.**
23be0 20 20 20 3c 6c 69 3e 20 3c 62 3e 76 66 73 3c 2f     <li> <b>vfs</
23bf0 62 3e 3a 20 5e 54 68 65 20 22 76 66 73 22 20 70  b>: ^The "vfs" p
23c00 61 72 61 6d 65 74 65 72 20 6d 61 79 20 62 65 20  arameter may be 
23c10 75 73 65 64 20 74 6f 20 73 70 65 63 69 66 79 20  used to specify 
23c20 74 68 65 20 6e 61 6d 65 20 6f 66 0a 2a 2a 20 20  the name of.**  
23c30 20 20 20 61 20 56 46 53 20 6f 62 6a 65 63 74 20     a VFS object 
23c40 74 68 61 74 20 70 72 6f 76 69 64 65 73 20 74 68  that provides th
23c50 65 20 6f 70 65 72 61 74 69 6e 67 20 73 79 73 74  e operating syst
23c60 65 6d 20 69 6e 74 65 72 66 61 63 65 20 74 68 61  em interface tha
23c70 74 20 73 68 6f 75 6c 64 0a 2a 2a 20 20 20 20 20  t should.**     
23c80 62 65 20 75 73 65 64 20 74 6f 20 61 63 63 65 73  be used to acces
23c90 73 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66  s the database f
23ca0 69 6c 65 20 6f 6e 20 64 69 73 6b 2e 20 5e 49 66  ile on disk. ^If
23cb0 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20   this option is 
23cc0 73 65 74 20 74 6f 0a 2a 2a 20 20 20 20 20 61 6e  set to.**     an
23cd0 20 65 6d 70 74 79 20 73 74 72 69 6e 67 20 74 68   empty string th
23ce0 65 20 64 65 66 61 75 6c 74 20 56 46 53 20 6f 62  e default VFS ob
23cf0 6a 65 63 74 20 69 73 20 75 73 65 64 2e 20 5e 53  ject is used. ^S
23d00 70 65 63 69 66 79 69 6e 67 20 61 6e 20 75 6e 6b  pecifying an unk
23d10 6e 6f 77 6e 0a 2a 2a 20 20 20 20 20 56 46 53 20  nown.**     VFS 
23d20 69 73 20 61 6e 20 65 72 72 6f 72 2e 20 5e 49 66  is an error. ^If
23d30 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32   sqlite3_open_v2
23d40 28 29 20 69 73 20 75 73 65 64 20 61 6e 64 20 74  () is used and t
23d50 68 65 20 76 66 73 20 6f 70 74 69 6f 6e 20 69 73  he vfs option is
23d60 0a 2a 2a 20 20 20 20 20 70 72 65 73 65 6e 74 2c  .**     present,
23d70 20 74 68 65 6e 20 74 68 65 20 56 46 53 20 73 70   then the VFS sp
23d80 65 63 69 66 69 65 64 20 62 79 20 74 68 65 20 6f  ecified by the o
23d90 70 74 69 6f 6e 20 74 61 6b 65 73 20 70 72 65 63  ption takes prec
23da0 65 64 65 6e 63 65 20 6f 76 65 72 0a 2a 2a 20 20  edence over.**  
23db0 20 20 20 74 68 65 20 76 61 6c 75 65 20 70 61 73     the value pas
23dc0 73 65 64 20 61 73 20 74 68 65 20 66 6f 75 72 74  sed as the fourt
23dd0 68 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73  h parameter to s
23de0 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29  qlite3_open_v2()
23df0 2e 0a 2a 2a 0a 2a 2a 20 20 20 3c 6c 69 3e 20 3c  ..**.**   <li> <
23e00 62 3e 6d 6f 64 65 3c 2f 62 3e 3a 20 5e 28 54 68  b>mode</b>: ^(Th
23e10 65 20 6d 6f 64 65 20 70 61 72 61 6d 65 74 65 72  e mode parameter
23e20 20 6d 61 79 20 62 65 20 73 65 74 20 74 6f 20 65   may be set to e
23e30 69 74 68 65 72 20 22 72 6f 22 2c 20 22 72 77 22  ither "ro", "rw"
23e40 2c 0a 2a 2a 20 20 20 20 20 22 72 77 63 22 2c 20  ,.**     "rwc", 
23e50 6f 72 20 22 6d 65 6d 6f 72 79 22 2e 20 41 74 74  or "memory". Att
23e60 65 6d 70 74 69 6e 67 20 74 6f 20 73 65 74 20 69  empting to set i
23e70 74 20 74 6f 20 61 6e 79 20 6f 74 68 65 72 20 76  t to any other v
23e80 61 6c 75 65 20 69 73 0a 2a 2a 20 20 20 20 20 61  alue is.**     a
23e90 6e 20 65 72 72 6f 72 29 5e 2e 20 0a 2a 2a 20 20  n error)^. .**  
23ea0 20 20 20 5e 49 66 20 22 72 6f 22 20 69 73 20 73     ^If "ro" is s
23eb0 70 65 63 69 66 69 65 64 2c 20 74 68 65 6e 20 74  pecified, then t
23ec0 68 65 20 64 61 74 61 62 61 73 65 20 69 73 20 6f  he database is o
23ed0 70 65 6e 65 64 20 66 6f 72 20 72 65 61 64 2d 6f  pened for read-o
23ee0 6e 6c 79 20 0a 2a 2a 20 20 20 20 20 61 63 63 65  nly .**     acce
23ef0 73 73 2c 20 6a 75 73 74 20 61 73 20 69 66 20 74  ss, just as if t
23f00 68 65 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  he [SQLITE_OPEN_
23f10 52 45 41 44 4f 4e 4c 59 5d 20 66 6c 61 67 20 68  READONLY] flag h
23f20 61 64 20 62 65 65 6e 20 73 65 74 20 69 6e 20 74  ad been set in t
23f30 68 65 20 0a 2a 2a 20 20 20 20 20 74 68 69 72 64  he .**     third
23f40 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 73 71 6c   argument to sql
23f50 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 2e 20  ite3_open_v2(). 
23f60 5e 49 66 20 74 68 65 20 6d 6f 64 65 20 6f 70 74  ^If the mode opt
23f70 69 6f 6e 20 69 73 20 73 65 74 20 74 6f 20 0a 2a  ion is set to .*
23f80 2a 20 20 20 20 20 22 72 77 22 2c 20 74 68 65 6e  *     "rw", then
23f90 20 74 68 65 20 64 61 74 61 62 61 73 65 20 69 73   the database is
23fa0 20 6f 70 65 6e 65 64 20 66 6f 72 20 72 65 61 64   opened for read
23fb0 2d 77 72 69 74 65 20 28 62 75 74 20 6e 6f 74 20  -write (but not 
23fc0 63 72 65 61 74 65 29 20 0a 2a 2a 20 20 20 20 20  create) .**     
23fd0 61 63 63 65 73 73 2c 20 61 73 20 69 66 20 53 51  access, as if SQ
23fe0 4c 49 54 45 5f 4f 50 45 4e 5f 52 45 41 44 57 52  LITE_OPEN_READWR
23ff0 49 54 45 20 28 62 75 74 20 6e 6f 74 20 53 51 4c  ITE (but not SQL
24000 49 54 45 5f 4f 50 45 4e 5f 43 52 45 41 54 45 29  ITE_OPEN_CREATE)
24010 20 68 61 64 20 0a 2a 2a 20 20 20 20 20 62 65 65   had .**     bee
24020 6e 20 73 65 74 2e 20 5e 56 61 6c 75 65 20 22 72  n set. ^Value "r
24030 77 63 22 20 69 73 20 65 71 75 69 76 61 6c 65 6e  wc" is equivalen
24040 74 20 74 6f 20 73 65 74 74 69 6e 67 20 62 6f 74  t to setting bot
24050 68 20 0a 2a 2a 20 20 20 20 20 53 51 4c 49 54 45  h .**     SQLITE
24060 5f 4f 50 45 4e 5f 52 45 41 44 57 52 49 54 45 20  _OPEN_READWRITE 
24070 61 6e 64 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  and SQLITE_OPEN_
24080 43 52 45 41 54 45 2e 20 20 5e 49 66 20 74 68 65  CREATE.  ^If the
24090 20 6d 6f 64 65 20 6f 70 74 69 6f 6e 20 69 73 0a   mode option is.
240a0 2a 2a 20 20 20 20 20 73 65 74 20 74 6f 20 22 6d  **     set to "m
240b0 65 6d 6f 72 79 22 20 74 68 65 6e 20 61 20 70 75  emory" then a pu
240c0 72 65 20 5b 69 6e 2d 6d 65 6d 6f 72 79 20 64 61  re [in-memory da
240d0 74 61 62 61 73 65 5d 20 74 68 61 74 20 6e 65 76  tabase] that nev
240e0 65 72 20 72 65 61 64 73 0a 2a 2a 20 20 20 20 20  er reads.**     
240f0 6f 72 20 77 72 69 74 65 73 20 66 72 6f 6d 20 64  or writes from d
24100 69 73 6b 20 69 73 20 75 73 65 64 2e 20 5e 49 74  isk is used. ^It
24110 20 69 73 20 61 6e 20 65 72 72 6f 72 20 74 6f 20   is an error to 
24120 73 70 65 63 69 66 79 20 61 20 76 61 6c 75 65 20  specify a value 
24130 66 6f 72 0a 2a 2a 20 20 20 20 20 74 68 65 20 6d  for.**     the m
24140 6f 64 65 20 70 61 72 61 6d 65 74 65 72 20 74 68  ode parameter th
24150 61 74 20 69 73 20 6c 65 73 73 20 72 65 73 74 72  at is less restr
24160 69 63 74 69 76 65 20 74 68 61 6e 20 74 68 61 74  ictive than that
24170 20 73 70 65 63 69 66 69 65 64 20 62 79 0a 2a 2a   specified by.**
24180 20 20 20 20 20 74 68 65 20 66 6c 61 67 73 20 70       the flags p
24190 61 73 73 65 64 20 69 6e 20 74 68 65 20 74 68 69  assed in the thi
241a0 72 64 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20  rd parameter to 
241b0 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28  sqlite3_open_v2(
241c0 29 2e 0a 2a 2a 0a 2a 2a 20 20 20 3c 6c 69 3e 20  )..**.**   <li> 
241d0 3c 62 3e 63 61 63 68 65 3c 2f 62 3e 3a 20 5e 54  <b>cache</b>: ^T
241e0 68 65 20 63 61 63 68 65 20 70 61 72 61 6d 65 74  he cache paramet
241f0 65 72 20 6d 61 79 20 62 65 20 73 65 74 20 74 6f  er may be set to
24200 20 65 69 74 68 65 72 20 22 73 68 61 72 65 64 22   either "shared"
24210 20 6f 72 0a 2a 2a 20 20 20 20 20 22 70 72 69 76   or.**     "priv
24220 61 74 65 22 2e 20 5e 53 65 74 74 69 6e 67 20 69  ate". ^Setting i
24230 74 20 74 6f 20 22 73 68 61 72 65 64 22 20 69 73  t to "shared" is
24240 20 65 71 75 69 76 61 6c 65 6e 74 20 74 6f 20 73   equivalent to s
24250 65 74 74 69 6e 67 20 74 68 65 0a 2a 2a 20 20 20  etting the.**   
24260 20 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 53 48    SQLITE_OPEN_SH
24270 41 52 45 44 43 41 43 48 45 20 62 69 74 20 69 6e  AREDCACHE bit in
24280 20 74 68 65 20 66 6c 61 67 73 20 61 72 67 75 6d   the flags argum
24290 65 6e 74 20 70 61 73 73 65 64 20 74 6f 0a 2a 2a  ent passed to.**
242a0 20 20 20 20 20 73 71 6c 69 74 65 33 5f 6f 70 65       sqlite3_ope
242b0 6e 5f 76 32 28 29 2e 20 5e 53 65 74 74 69 6e 67  n_v2(). ^Setting
242c0 20 74 68 65 20 63 61 63 68 65 20 70 61 72 61 6d   the cache param
242d0 65 74 65 72 20 74 6f 20 22 70 72 69 76 61 74 65  eter to "private
242e0 22 20 69 73 20 0a 2a 2a 20 20 20 20 20 65 71 75  " is .**     equ
242f0 69 76 61 6c 65 6e 74 20 74 6f 20 73 65 74 74 69  ivalent to setti
24300 6e 67 20 74 68 65 20 53 51 4c 49 54 45 5f 4f 50  ng the SQLITE_OP
24310 45 4e 5f 50 52 49 56 41 54 45 43 41 43 48 45 20  EN_PRIVATECACHE 
24320 62 69 74 2e 0a 2a 2a 20 20 20 20 20 5e 49 66 20  bit..**     ^If 
24330 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28  sqlite3_open_v2(
24340 29 20 69 73 20 75 73 65 64 20 61 6e 64 20 74 68  ) is used and th
24350 65 20 22 63 61 63 68 65 22 20 70 61 72 61 6d 65  e "cache" parame
24360 74 65 72 20 69 73 20 70 72 65 73 65 6e 74 20 69  ter is present i
24370 6e 0a 2a 2a 20 20 20 20 20 61 20 55 52 49 20 66  n.**     a URI f
24380 69 6c 65 6e 61 6d 65 2c 20 69 74 73 20 76 61 6c  ilename, its val
24390 75 65 20 6f 76 65 72 72 69 64 65 73 20 61 6e 79  ue overrides any
243a0 20 62 65 68 61 76 69 6f 72 20 72 65 71 75 65 73   behavior reques
243b0 74 65 64 20 62 79 20 73 65 74 74 69 6e 67 0a 2a  ted by setting.*
243c0 2a 20 20 20 20 20 53 51 4c 49 54 45 5f 4f 50 45  *     SQLITE_OPE
243d0 4e 5f 50 52 49 56 41 54 45 43 41 43 48 45 20 6f  N_PRIVATECACHE o
243e0 72 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 53 48  r SQLITE_OPEN_SH
243f0 41 52 45 44 43 41 43 48 45 20 66 6c 61 67 2e 0a  AREDCACHE flag..
24400 2a 2a 0a 2a 2a 20 20 3c 6c 69 3e 20 3c 62 3e 70  **.**  <li> <b>p
24410 73 6f 77 3c 2f 62 3e 3a 20 5e 54 68 65 20 70 73  sow</b>: ^The ps
24420 6f 77 20 70 61 72 61 6d 65 74 65 72 20 69 6e 64  ow parameter ind
24430 69 63 61 74 65 73 20 77 68 65 74 68 65 72 20 6f  icates whether o
24440 72 20 6e 6f 74 20 74 68 65 0a 2a 2a 20 20 20 20  r not the.**    
24450 20 5b 70 6f 77 65 72 73 61 66 65 20 6f 76 65 72   [powersafe over
24460 77 72 69 74 65 5d 20 70 72 6f 70 65 72 74 79 20  write] property 
24470 64 6f 65 73 20 6f 72 20 64 6f 65 73 20 6e 6f 74  does or does not
24480 20 61 70 70 6c 79 20 74 6f 20 74 68 65 0a 2a 2a   apply to the.**
24490 20 20 20 20 20 73 74 6f 72 61 67 65 20 6d 65 64       storage med
244a0 69 61 20 6f 6e 20 77 68 69 63 68 20 74 68 65 20  ia on which the 
244b0 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 72 65  database file re
244c0 73 69 64 65 73 2e 0a 2a 2a 0a 2a 2a 20 20 3c 6c  sides..**.**  <l
244d0 69 3e 20 3c 62 3e 6e 6f 6c 6f 63 6b 3c 2f 62 3e  i> <b>nolock</b>
244e0 3a 20 5e 54 68 65 20 6e 6f 6c 6f 63 6b 20 70 61  : ^The nolock pa
244f0 72 61 6d 65 74 65 72 20 69 73 20 61 20 62 6f 6f  rameter is a boo
24500 6c 65 61 6e 20 71 75 65 72 79 20 70 61 72 61 6d  lean query param
24510 65 74 65 72 0a 2a 2a 20 20 20 20 20 77 68 69 63  eter.**     whic
24520 68 20 69 66 20 73 65 74 20 64 69 73 61 62 6c 65  h if set disable
24530 73 20 66 69 6c 65 20 6c 6f 63 6b 69 6e 67 20 69  s file locking i
24540 6e 20 72 6f 6c 6c 62 61 63 6b 20 6a 6f 75 72 6e  n rollback journ
24550 61 6c 20 6d 6f 64 65 73 2e 20 20 54 68 69 73 0a  al modes.  This.
24560 2a 2a 20 20 20 20 20 69 73 20 75 73 65 66 75 6c  **     is useful
24570 20 66 6f 72 20 61 63 63 65 73 73 69 6e 67 20 61   for accessing a
24580 20 64 61 74 61 62 61 73 65 20 6f 6e 20 61 20 66   database on a f
24590 69 6c 65 73 79 73 74 65 6d 20 74 68 61 74 20 64  ilesystem that d
245a0 6f 65 73 20 6e 6f 74 0a 2a 2a 20 20 20 20 20 73  oes not.**     s
245b0 75 70 70 6f 72 74 20 6c 6f 63 6b 69 6e 67 2e 20  upport locking. 
245c0 20 43 61 75 74 69 6f 6e 3a 20 20 44 61 74 61 62   Caution:  Datab
245d0 61 73 65 20 63 6f 72 72 75 70 74 69 6f 6e 20 6d  ase corruption m
245e0 69 67 68 74 20 72 65 73 75 6c 74 20 69 66 20 74  ight result if t
245f0 77 6f 0a 2a 2a 20 20 20 20 20 6f 72 20 6d 6f 72  wo.**     or mor
24600 65 20 70 72 6f 63 65 73 73 65 73 20 77 72 69 74  e processes writ
24610 65 20 74 6f 20 74 68 65 20 73 61 6d 65 20 64 61  e to the same da
24620 74 61 62 61 73 65 20 61 6e 64 20 61 6e 79 20 6f  tabase and any o
24630 6e 65 20 6f 66 20 74 68 6f 73 65 0a 2a 2a 20 20  ne of those.**  
24640 20 20 20 70 72 6f 63 65 73 73 65 73 20 75 73 65     processes use
24650 73 20 6e 6f 6c 6f 63 6b 3d 31 2e 0a 2a 2a 0a 2a  s nolock=1..**.*
24660 2a 20 20 3c 6c 69 3e 20 3c 62 3e 69 6d 6d 75 74  *  <li> <b>immut
24670 61 62 6c 65 3c 2f 62 3e 3a 20 5e 54 68 65 20 69  able</b>: ^The i
24680 6d 6d 75 74 61 62 6c 65 20 70 61 72 61 6d 65 74  mmutable paramet
24690 65 72 20 69 73 20 61 20 62 6f 6f 6c 65 61 6e 20  er is a boolean 
246a0 71 75 65 72 79 0a 2a 2a 20 20 20 20 20 70 61 72  query.**     par
246b0 61 6d 65 74 65 72 20 74 68 61 74 20 69 6e 64 69  ameter that indi
246c0 63 61 74 65 73 20 74 68 61 74 20 74 68 65 20 64  cates that the d
246d0 61 74 61 62 61 73 65 20 66 69 6c 65 20 69 73 20  atabase file is 
246e0 73 74 6f 72 65 64 20 6f 6e 0a 2a 2a 20 20 20 20  stored on.**    
246f0 20 72 65 61 64 2d 6f 6e 6c 79 20 6d 65 64 69 61   read-only media
24700 2e 20 20 5e 57 68 65 6e 20 69 6d 6d 75 74 61 62  .  ^When immutab
24710 6c 65 20 69 73 20 73 65 74 2c 20 53 51 4c 69 74  le is set, SQLit
24720 65 20 61 73 73 75 6d 65 73 20 74 68 61 74 20 74  e assumes that t
24730 68 65 0a 2a 2a 20 20 20 20 20 64 61 74 61 62 61  he.**     databa
24740 73 65 20 66 69 6c 65 20 63 61 6e 6e 6f 74 20 62  se file cannot b
24750 65 20 63 68 61 6e 67 65 64 2c 20 65 76 65 6e 20  e changed, even 
24760 62 79 20 61 20 70 72 6f 63 65 73 73 20 77 69 74  by a process wit
24770 68 20 68 69 67 68 65 72 0a 2a 2a 20 20 20 20 20  h higher.**     
24780 70 72 69 76 69 6c 65 67 65 2c 20 61 6e 64 20 73  privilege, and s
24790 6f 20 74 68 65 20 64 61 74 61 62 61 73 65 20 69  o the database i
247a0 73 20 6f 70 65 6e 65 64 20 72 65 61 64 2d 6f 6e  s opened read-on
247b0 6c 79 20 61 6e 64 20 61 6c 6c 20 6c 6f 63 6b 69  ly and all locki
247c0 6e 67 0a 2a 2a 20 20 20 20 20 61 6e 64 20 63 68  ng.**     and ch
247d0 61 6e 67 65 20 64 65 74 65 63 74 69 6f 6e 20 69  ange detection i
247e0 73 20 64 69 73 61 62 6c 65 64 2e 20 20 43 61 75  s disabled.  Cau
247f0 74 69 6f 6e 3a 20 53 65 74 74 69 6e 67 20 74 68  tion: Setting th
24800 65 20 69 6d 6d 75 74 61 62 6c 65 0a 2a 2a 20 20  e immutable.**  
24810 20 20 20 70 72 6f 70 65 72 74 79 20 6f 6e 20 61     property on a
24820 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 74   database file t
24830 68 61 74 20 64 6f 65 73 20 69 6e 20 66 61 63 74  hat does in fact
24840 20 63 68 61 6e 67 65 20 63 61 6e 20 72 65 73 75   change can resu
24850 6c 74 0a 2a 2a 20 20 20 20 20 69 6e 20 69 6e 63  lt.**     in inc
24860 6f 72 72 65 63 74 20 71 75 65 72 79 20 72 65 73  orrect query res
24870 75 6c 74 73 20 61 6e 64 2f 6f 72 20 5b 53 51 4c  ults and/or [SQL
24880 49 54 45 5f 43 4f 52 52 55 50 54 5d 20 65 72 72  ITE_CORRUPT] err
24890 6f 72 73 2e 0a 2a 2a 20 20 20 20 20 53 65 65 20  ors..**     See 
248a0 61 6c 73 6f 3a 20 5b 53 51 4c 49 54 45 5f 49 4f  also: [SQLITE_IO
248b0 43 41 50 5f 49 4d 4d 55 54 41 42 4c 45 5d 2e 0a  CAP_IMMUTABLE]..
248c0 2a 2a 20 20 20 20 20 20 20 0a 2a 2a 20 3c 2f 75  **       .** </u
248d0 6c 3e 0a 2a 2a 0a 2a 2a 20 5e 53 70 65 63 69 66  l>.**.** ^Specif
248e0 79 69 6e 67 20 61 6e 20 75 6e 6b 6e 6f 77 6e 20  ying an unknown 
248f0 70 61 72 61 6d 65 74 65 72 20 69 6e 20 74 68 65  parameter in the
24900 20 71 75 65 72 79 20 63 6f 6d 70 6f 6e 65 6e 74   query component
24910 20 6f 66 20 61 20 55 52 49 20 69 73 20 6e 6f 74   of a URI is not
24920 20 61 6e 0a 2a 2a 20 65 72 72 6f 72 2e 20 20 46   an.** error.  F
24930 75 74 75 72 65 20 76 65 72 73 69 6f 6e 73 20 6f  uture versions o
24940 66 20 53 51 4c 69 74 65 20 6d 69 67 68 74 20 75  f SQLite might u
24950 6e 64 65 72 73 74 61 6e 64 20 61 64 64 69 74 69  nderstand additi
24960 6f 6e 61 6c 20 71 75 65 72 79 0a 2a 2a 20 70 61  onal query.** pa
24970 72 61 6d 65 74 65 72 73 2e 20 20 53 65 65 20 22  rameters.  See "
24980 5b 71 75 65 72 79 20 70 61 72 61 6d 65 74 65 72  [query parameter
24990 73 20 77 69 74 68 20 73 70 65 63 69 61 6c 20 6d  s with special m
249a0 65 61 6e 69 6e 67 20 74 6f 20 53 51 4c 69 74 65  eaning to SQLite
249b0 5d 22 20 66 6f 72 0a 2a 2a 20 61 64 64 69 74 69  ]" for.** additi
249c0 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e  onal information
249d0 2e 0a 2a 2a 0a 2a 2a 20 5b 5b 55 52 49 20 66 69  ..**.** [[URI fi
249e0 6c 65 6e 61 6d 65 20 65 78 61 6d 70 6c 65 73 5d  lename examples]
249f0 5d 20 3c 68 33 3e 55 52 49 20 66 69 6c 65 6e 61  ] <h3>URI filena
24a00 6d 65 20 65 78 61 6d 70 6c 65 73 3c 2f 68 33 3e  me examples</h3>
24a10 0a 2a 2a 0a 2a 2a 20 3c 74 61 62 6c 65 20 62 6f  .**.** <table bo
24a20 72 64 65 72 3d 22 31 22 20 61 6c 69 67 6e 3d 63  rder="1" align=c
24a30 65 6e 74 65 72 20 63 65 6c 6c 70 61 64 64 69 6e  enter cellpaddin
24a40 67 3d 35 3e 0a 2a 2a 20 3c 74 72 3e 3c 74 68 3e  g=5>.** <tr><th>
24a50 20 55 52 49 20 66 69 6c 65 6e 61 6d 65 73 20 3c   URI filenames <
24a60 74 68 3e 20 52 65 73 75 6c 74 73 0a 2a 2a 20 3c  th> Results.** <
24a70 74 72 3e 3c 74 64 3e 20 66 69 6c 65 3a 64 61 74  tr><td> file:dat
24a80 61 2e 64 62 20 3c 74 64 3e 20 0a 2a 2a 20 20 20  a.db <td> .**   
24a90 20 20 20 20 20 20 20 4f 70 65 6e 20 74 68 65 20         Open the 
24aa0 66 69 6c 65 20 22 64 61 74 61 2e 64 62 22 20 69  file "data.db" i
24ab0 6e 20 74 68 65 20 63 75 72 72 65 6e 74 20 64 69  n the current di
24ac0 72 65 63 74 6f 72 79 2e 0a 2a 2a 20 3c 74 72 3e  rectory..** <tr>
24ad0 3c 74 64 3e 20 66 69 6c 65 3a 2f 68 6f 6d 65 2f  <td> file:/home/
24ae0 66 72 65 64 2f 64 61 74 61 2e 64 62 3c 62 72 3e  fred/data.db<br>
24af0 0a 2a 2a 20 20 20 20 20 20 20 20 20 20 66 69 6c  .**          fil
24b00 65 3a 2f 2f 2f 68 6f 6d 65 2f 66 72 65 64 2f 64  e:///home/fred/d
24b10 61 74 61 2e 64 62 20 3c 62 72 3e 20 0a 2a 2a 20  ata.db <br> .** 
24b20 20 20 20 20 20 20 20 20 20 66 69 6c 65 3a 2f 2f           file://
24b30 6c 6f 63 61 6c 68 6f 73 74 2f 68 6f 6d 65 2f 66  localhost/home/f
24b40 72 65 64 2f 64 61 74 61 2e 64 62 20 3c 62 72 3e  red/data.db <br>
24b50 20 3c 74 64 3e 20 0a 2a 2a 20 20 20 20 20 20 20   <td> .**       
24b60 20 20 20 4f 70 65 6e 20 74 68 65 20 64 61 74 61     Open the data
24b70 62 61 73 65 20 66 69 6c 65 20 22 2f 68 6f 6d 65  base file "/home
24b80 2f 66 72 65 64 2f 64 61 74 61 2e 64 62 22 2e 0a  /fred/data.db"..
24b90 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 66 69 6c 65  ** <tr><td> file
24ba0 3a 2f 2f 64 61 72 6b 73 74 61 72 2f 68 6f 6d 65  ://darkstar/home
24bb0 2f 66 72 65 64 2f 64 61 74 61 2e 64 62 20 3c 74  /fred/data.db <t
24bc0 64 3e 20 0a 2a 2a 20 20 20 20 20 20 20 20 20 20  d> .**          
24bd0 41 6e 20 65 72 72 6f 72 2e 20 22 64 61 72 6b 73  An error. "darks
24be0 74 61 72 22 20 69 73 20 6e 6f 74 20 61 20 72 65  tar" is not a re
24bf0 63 6f 67 6e 69 7a 65 64 20 61 75 74 68 6f 72 69  cognized authori
24c00 74 79 2e 0a 2a 2a 20 3c 74 72 3e 3c 74 64 20 73  ty..** <tr><td s
24c10 74 79 6c 65 3d 22 77 68 69 74 65 2d 73 70 61 63  tyle="white-spac
24c20 65 3a 6e 6f 77 72 61 70 22 3e 20 0a 2a 2a 20 20  e:nowrap"> .**  
24c30 20 20 20 20 20 20 20 20 66 69 6c 65 3a 2f 2f 2f          file:///
24c40 43 3a 2f 44 6f 63 75 6d 65 6e 74 73 25 32 30 61  C:/Documents%20a
24c50 6e 64 25 32 30 53 65 74 74 69 6e 67 73 2f 66 72  nd%20Settings/fr
24c60 65 64 2f 44 65 73 6b 74 6f 70 2f 64 61 74 61 2e  ed/Desktop/data.
24c70 64 62 0a 2a 2a 20 20 20 20 20 3c 74 64 3e 20 57  db.**     <td> W
24c80 69 6e 64 6f 77 73 20 6f 6e 6c 79 3a 20 4f 70 65  indows only: Ope
24c90 6e 20 74 68 65 20 66 69 6c 65 20 22 64 61 74 61  n the file "data
24ca0 2e 64 62 22 20 6f 6e 20 66 72 65 64 27 73 20 64  .db" on fred's d
24cb0 65 73 6b 74 6f 70 20 6f 6e 20 64 72 69 76 65 0a  esktop on drive.
24cc0 2a 2a 20 20 20 20 20 20 20 20 20 20 43 3a 2e 20  **          C:. 
24cd0 4e 6f 74 65 20 74 68 61 74 20 74 68 65 20 25 32  Note that the %2
24ce0 30 20 65 73 63 61 70 69 6e 67 20 69 6e 20 74 68  0 escaping in th
24cf0 69 73 20 65 78 61 6d 70 6c 65 20 69 73 20 6e 6f  is example is no
24d00 74 20 73 74 72 69 63 74 6c 79 20 0a 2a 2a 20 20  t strictly .**  
24d10 20 20 20 20 20 20 20 20 6e 65 63 65 73 73 61 72          necessar
24d20 79 20 2d 20 73 70 61 63 65 20 63 68 61 72 61 63  y - space charac
24d30 74 65 72 73 20 63 61 6e 20 62 65 20 75 73 65 64  ters can be used
24d40 20 6c 69 74 65 72 61 6c 6c 79 0a 2a 2a 20 20 20   literally.**   
24d50 20 20 20 20 20 20 20 69 6e 20 55 52 49 20 66 69         in URI fi
24d60 6c 65 6e 61 6d 65 73 2e 0a 2a 2a 20 3c 74 72 3e  lenames..** <tr>
24d70 3c 74 64 3e 20 66 69 6c 65 3a 64 61 74 61 2e 64  <td> file:data.d
24d80 62 3f 6d 6f 64 65 3d 72 6f 26 63 61 63 68 65 3d  b?mode=ro&cache=
24d90 70 72 69 76 61 74 65 20 3c 74 64 3e 20 0a 2a 2a  private <td> .**
24da0 20 20 20 20 20 20 20 20 20 20 4f 70 65 6e 20 66            Open f
24db0 69 6c 65 20 22 64 61 74 61 2e 64 62 22 20 69 6e  ile "data.db" in
24dc0 20 74 68 65 20 63 75 72 72 65 6e 74 20 64 69 72   the current dir
24dd0 65 63 74 6f 72 79 20 66 6f 72 20 72 65 61 64 2d  ectory for read-
24de0 6f 6e 6c 79 20 61 63 63 65 73 73 2e 0a 2a 2a 20  only access..** 
24df0 20 20 20 20 20 20 20 20 20 52 65 67 61 72 64 6c           Regardl
24e00 65 73 73 20 6f 66 20 77 68 65 74 68 65 72 20 6f  ess of whether o
24e10 72 20 6e 6f 74 20 73 68 61 72 65 64 2d 63 61 63  r not shared-cac
24e20 68 65 20 6d 6f 64 65 20 69 73 20 65 6e 61 62 6c  he mode is enabl
24e30 65 64 20 62 79 0a 2a 2a 20 20 20 20 20 20 20 20  ed by.**        
24e40 20 20 64 65 66 61 75 6c 74 2c 20 75 73 65 20 61    default, use a
24e50 20 70 72 69 76 61 74 65 20 63 61 63 68 65 2e 0a   private cache..
24e60 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 66 69 6c 65  ** <tr><td> file
24e70 3a 2f 68 6f 6d 65 2f 66 72 65 64 2f 64 61 74 61  :/home/fred/data
24e80 2e 64 62 3f 76 66 73 3d 75 6e 69 78 2d 64 6f 74  .db?vfs=unix-dot
24e90 66 69 6c 65 20 3c 74 64 3e 0a 2a 2a 20 20 20 20  file <td>.**    
24ea0 20 20 20 20 20 20 4f 70 65 6e 20 66 69 6c 65 20        Open file 
24eb0 22 2f 68 6f 6d 65 2f 66 72 65 64 2f 64 61 74 61  "/home/fred/data
24ec0 2e 64 62 22 2e 20 55 73 65 20 74 68 65 20 73 70  .db". Use the sp
24ed0 65 63 69 61 6c 20 56 46 53 20 22 75 6e 69 78 2d  ecial VFS "unix-
24ee0 64 6f 74 66 69 6c 65 22 0a 2a 2a 20 20 20 20 20  dotfile".**     
24ef0 20 20 20 20 20 74 68 61 74 20 75 73 65 73 20 64       that uses d
24f00 6f 74 2d 66 69 6c 65 73 20 69 6e 20 70 6c 61 63  ot-files in plac
24f10 65 20 6f 66 20 70 6f 73 69 78 20 61 64 76 69 73  e of posix advis
24f20 6f 72 79 20 6c 6f 63 6b 69 6e 67 2e 0a 2a 2a 20  ory locking..** 
24f30 3c 74 72 3e 3c 74 64 3e 20 66 69 6c 65 3a 64 61  <tr><td> file:da
24f40 74 61 2e 64 62 3f 6d 6f 64 65 3d 72 65 61 64 6f  ta.db?mode=reado
24f50 6e 6c 79 20 3c 74 64 3e 20 0a 2a 2a 20 20 20 20  nly <td> .**    
24f60 20 20 20 20 20 20 41 6e 20 65 72 72 6f 72 2e 20        An error. 
24f70 22 72 65 61 64 6f 6e 6c 79 22 20 69 73 20 6e 6f  "readonly" is no
24f80 74 20 61 20 76 61 6c 69 64 20 6f 70 74 69 6f 6e  t a valid option
24f90 20 66 6f 72 20 74 68 65 20 22 6d 6f 64 65 22 20   for the "mode" 
24fa0 70 61 72 61 6d 65 74 65 72 2e 0a 2a 2a 20 3c 2f  parameter..** </
24fb0 74 61 62 6c 65 3e 0a 2a 2a 0a 2a 2a 20 5e 55 52  table>.**.** ^UR
24fc0 49 20 68 65 78 61 64 65 63 69 6d 61 6c 20 65 73  I hexadecimal es
24fd0 63 61 70 65 20 73 65 71 75 65 6e 63 65 73 20 28  cape sequences (
24fe0 25 48 48 29 20 61 72 65 20 73 75 70 70 6f 72 74  %HH) are support
24ff0 65 64 20 77 69 74 68 69 6e 20 74 68 65 20 70 61  ed within the pa
25000 74 68 20 61 6e 64 0a 2a 2a 20 71 75 65 72 79 20  th and.** query 
25010 63 6f 6d 70 6f 6e 65 6e 74 73 20 6f 66 20 61 20  components of a 
25020 55 52 49 2e 20 41 20 68 65 78 61 64 65 63 69 6d  URI. A hexadecim
25030 61 6c 20 65 73 63 61 70 65 20 73 65 71 75 65 6e  al escape sequen
25040 63 65 20 63 6f 6e 73 69 73 74 73 20 6f 66 20 61  ce consists of a
25050 0a 2a 2a 20 70 65 72 63 65 6e 74 20 73 69 67 6e  .** percent sign
25060 20 2d 20 22 25 22 20 2d 20 66 6f 6c 6c 6f 77 65   - "%" - followe
25070 64 20 62 79 20 65 78 61 63 74 6c 79 20 74 77 6f  d by exactly two
25080 20 68 65 78 61 64 65 63 69 6d 61 6c 20 64 69 67   hexadecimal dig
25090 69 74 73 20 0a 2a 2a 20 73 70 65 63 69 66 79 69  its .** specifyi
250a0 6e 67 20 61 6e 20 6f 63 74 65 74 20 76 61 6c 75  ng an octet valu
250b0 65 2e 20 5e 42 65 66 6f 72 65 20 74 68 65 20 70  e. ^Before the p
250c0 61 74 68 20 6f 72 20 71 75 65 72 79 20 63 6f 6d  ath or query com
250d0 70 6f 6e 65 6e 74 73 20 6f 66 20 61 0a 2a 2a 20  ponents of a.** 
250e0 55 52 49 20 66 69 6c 65 6e 61 6d 65 20 61 72 65  URI filename are
250f0 20 69 6e 74 65 72 70 72 65 74 65 64 2c 20 74 68   interpreted, th
25100 65 79 20 61 72 65 20 65 6e 63 6f 64 65 64 20 75  ey are encoded u
25110 73 69 6e 67 20 55 54 46 2d 38 20 61 6e 64 20 61  sing UTF-8 and a
25120 6c 6c 20 0a 2a 2a 20 68 65 78 61 64 65 63 69 6d  ll .** hexadecim
25130 61 6c 20 65 73 63 61 70 65 20 73 65 71 75 65 6e  al escape sequen
25140 63 65 73 20 72 65 70 6c 61 63 65 64 20 62 79 20  ces replaced by 
25150 61 20 73 69 6e 67 6c 65 20 62 79 74 65 20 63 6f  a single byte co
25160 6e 74 61 69 6e 69 6e 67 20 74 68 65 0a 2a 2a 20  ntaining the.** 
25170 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20 6f 63  corresponding oc
25180 74 65 74 2e 20 49 66 20 74 68 69 73 20 70 72 6f  tet. If this pro
25190 63 65 73 73 20 67 65 6e 65 72 61 74 65 73 20 61  cess generates a
251a0 6e 20 69 6e 76 61 6c 69 64 20 55 54 46 2d 38 20  n invalid UTF-8 
251b0 65 6e 63 6f 64 69 6e 67 2c 0a 2a 2a 20 74 68 65  encoding,.** the
251c0 20 72 65 73 75 6c 74 73 20 61 72 65 20 75 6e 64   results are und
251d0 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 3c 62  efined..**.** <b
251e0 3e 4e 6f 74 65 20 74 6f 20 57 69 6e 64 6f 77 73  >Note to Windows
251f0 20 75 73 65 72 73 3a 3c 2f 62 3e 20 20 54 68 65   users:</b>  The
25200 20 65 6e 63 6f 64 69 6e 67 20 75 73 65 64 20 66   encoding used f
25210 6f 72 20 74 68 65 20 66 69 6c 65 6e 61 6d 65 20  or the filename 
25220 61 72 67 75 6d 65 6e 74 0a 2a 2a 20 6f 66 20 73  argument.** of s
25230 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 20 61 6e  qlite3_open() an
25240 64 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76  d sqlite3_open_v
25250 32 28 29 20 6d 75 73 74 20 62 65 20 55 54 46 2d  2() must be UTF-
25260 38 2c 20 6e 6f 74 20 77 68 61 74 65 76 65 72 0a  8, not whatever.
25270 2a 2a 20 63 6f 64 65 70 61 67 65 20 69 73 20 63  ** codepage is c
25280 75 72 72 65 6e 74 6c 79 20 64 65 66 69 6e 65 64  urrently defined
25290 2e 20 20 46 69 6c 65 6e 61 6d 65 73 20 63 6f 6e  .  Filenames con
252a0 74 61 69 6e 69 6e 67 20 69 6e 74 65 72 6e 61 74  taining internat
252b0 69 6f 6e 61 6c 0a 2a 2a 20 63 68 61 72 61 63 74  ional.** charact
252c0 65 72 73 20 6d 75 73 74 20 62 65 20 63 6f 6e 76  ers must be conv
252d0 65 72 74 65 64 20 74 6f 20 55 54 46 2d 38 20 70  erted to UTF-8 p
252e0 72 69 6f 72 20 74 6f 20 70 61 73 73 69 6e 67 20  rior to passing 
252f0 74 68 65 6d 20 69 6e 74 6f 0a 2a 2a 20 73 71 6c  them into.** sql
25300 69 74 65 33 5f 6f 70 65 6e 28 29 20 6f 72 20 73  ite3_open() or s
25310 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29  qlite3_open_v2()
25320 2e 0a 2a 2a 0a 2a 2a 20 3c 62 3e 4e 6f 74 65 20  ..**.** <b>Note 
25330 74 6f 20 57 69 6e 64 6f 77 73 20 52 75 6e 74 69  to Windows Runti
25340 6d 65 20 75 73 65 72 73 3a 3c 2f 62 3e 20 20 54  me users:</b>  T
25350 68 65 20 74 65 6d 70 6f 72 61 72 79 20 64 69 72  he temporary dir
25360 65 63 74 6f 72 79 20 6d 75 73 74 20 62 65 20 73  ectory must be s
25370 65 74 0a 2a 2a 20 70 72 69 6f 72 20 74 6f 20 63  et.** prior to c
25380 61 6c 6c 69 6e 67 20 73 71 6c 69 74 65 33 5f 6f  alling sqlite3_o
25390 70 65 6e 28 29 20 6f 72 20 73 71 6c 69 74 65 33  pen() or sqlite3
253a0 5f 6f 70 65 6e 5f 76 32 28 29 2e 20 20 4f 74 68  _open_v2().  Oth
253b0 65 72 77 69 73 65 2c 20 76 61 72 69 6f 75 73 0a  erwise, various.
253c0 2a 2a 20 66 65 61 74 75 72 65 73 20 74 68 61 74  ** features that
253d0 20 72 65 71 75 69 72 65 20 74 68 65 20 75 73 65   require the use
253e0 20 6f 66 20 74 65 6d 70 6f 72 61 72 79 20 66 69   of temporary fi
253f0 6c 65 73 20 6d 61 79 20 66 61 69 6c 2e 0a 2a 2a  les may fail..**
25400 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 3a 20 5b 73  .** See also: [s
25410 71 6c 69 74 65 33 5f 74 65 6d 70 5f 64 69 72 65  qlite3_temp_dire
25420 63 74 6f 72 79 5d 0a 2a 2f 0a 69 6e 74 20 73 71  ctory].*/.int sq
25430 6c 69 74 65 33 5f 6f 70 65 6e 28 0a 20 20 63 6f  lite3_open(.  co
25440 6e 73 74 20 63 68 61 72 20 2a 66 69 6c 65 6e 61  nst char *filena
25450 6d 65 2c 20 20 20 2f 2a 20 44 61 74 61 62 61 73  me,   /* Databas
25460 65 20 66 69 6c 65 6e 61 6d 65 20 28 55 54 46 2d  e filename (UTF-
25470 38 29 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33 20  8) */.  sqlite3 
25480 2a 2a 70 70 44 62 20 20 20 20 20 20 20 20 20 20  **ppDb          
25490 2f 2a 20 4f 55 54 3a 20 53 51 4c 69 74 65 20 64  /* OUT: SQLite d
254a0 62 20 68 61 6e 64 6c 65 20 2a 2f 0a 29 3b 0a 69  b handle */.);.i
254b0 6e 74 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31  nt sqlite3_open1
254c0 36 28 0a 20 20 63 6f 6e 73 74 20 76 6f 69 64 20  6(.  const void 
254d0 2a 66 69 6c 65 6e 61 6d 65 2c 20 20 20 2f 2a 20  *filename,   /* 
254e0 44 61 74 61 62 61 73 65 20 66 69 6c 65 6e 61 6d  Database filenam
254f0 65 20 28 55 54 46 2d 31 36 29 20 2a 2f 0a 20 20  e (UTF-16) */.  
25500 73 71 6c 69 74 65 33 20 2a 2a 70 70 44 62 20 20  sqlite3 **ppDb  
25510 20 20 20 20 20 20 20 20 2f 2a 20 4f 55 54 3a 20          /* OUT: 
25520 53 51 4c 69 74 65 20 64 62 20 68 61 6e 64 6c 65  SQLite db handle
25530 20 2a 2f 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74   */.);.int sqlit
25540 65 33 5f 6f 70 65 6e 5f 76 32 28 0a 20 20 63 6f  e3_open_v2(.  co
25550 6e 73 74 20 63 68 61 72 20 2a 66 69 6c 65 6e 61  nst char *filena
25560 6d 65 2c 20 20 20 2f 2a 20 44 61 74 61 62 61 73  me,   /* Databas
25570 65 20 66 69 6c 65 6e 61 6d 65 20 28 55 54 46 2d  e filename (UTF-
25580 38 29 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33 20  8) */.  sqlite3 
25590 2a 2a 70 70 44 62 2c 20 20 20 20 20 20 20 20 20  **ppDb,         
255a0 2f 2a 20 4f 55 54 3a 20 53 51 4c 69 74 65 20 64  /* OUT: SQLite d
255b0 62 20 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 69 6e  b handle */.  in
255c0 74 20 66 6c 61 67 73 2c 20 20 20 20 20 20 20 20  t flags,        
255d0 20 20 20 20 20 20 2f 2a 20 46 6c 61 67 73 20 2a        /* Flags *
255e0 2f 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a  /.  const char *
255f0 7a 56 66 73 20 20 20 20 20 20 20 20 2f 2a 20 4e  zVfs        /* N
25600 61 6d 65 20 6f 66 20 56 46 53 20 6d 6f 64 75 6c  ame of VFS modul
25610 65 20 74 6f 20 75 73 65 20 2a 2f 0a 29 3b 0a 0a  e to use */.);..
25620 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
25630 4f 62 74 61 69 6e 20 56 61 6c 75 65 73 20 46 6f  Obtain Values Fo
25640 72 20 55 52 49 20 50 61 72 61 6d 65 74 65 72 73  r URI Parameters
25650 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 61 72 65  .**.** These are
25660 20 75 74 69 6c 69 74 79 20 72 6f 75 74 69 6e 65   utility routine
25670 73 2c 20 75 73 65 66 75 6c 20 74 6f 20 56 46 53  s, useful to VFS
25680 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73   implementations
25690 2c 20 74 68 61 74 20 63 68 65 63 6b 0a 2a 2a 20  , that check.** 
256a0 74 6f 20 73 65 65 20 69 66 20 61 20 64 61 74 61  to see if a data
256b0 62 61 73 65 20 66 69 6c 65 20 77 61 73 20 61 20  base file was a 
256c0 55 52 49 20 74 68 61 74 20 63 6f 6e 74 61 69 6e  URI that contain
256d0 65 64 20 61 20 73 70 65 63 69 66 69 63 20 71 75  ed a specific qu
256e0 65 72 79 20 0a 2a 2a 20 70 61 72 61 6d 65 74 65  ery .** paramete
256f0 72 2c 20 61 6e 64 20 69 66 20 73 6f 20 6f 62 74  r, and if so obt
25700 61 69 6e 73 20 74 68 65 20 76 61 6c 75 65 20 6f  ains the value o
25710 66 20 74 68 61 74 20 71 75 65 72 79 20 70 61 72  f that query par
25720 61 6d 65 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 49 66  ameter..**.** If
25730 20 46 20 69 73 20 74 68 65 20 64 61 74 61 62 61   F is the databa
25740 73 65 20 66 69 6c 65 6e 61 6d 65 20 70 6f 69 6e  se filename poin
25750 74 65 72 20 70 61 73 73 65 64 20 69 6e 74 6f 20  ter passed into 
25760 74 68 65 20 78 4f 70 65 6e 28 29 20 6d 65 74 68  the xOpen() meth
25770 6f 64 20 6f 66 20 0a 2a 2a 20 61 20 56 46 53 20  od of .** a VFS 
25780 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 77  implementation w
25790 68 65 6e 20 74 68 65 20 66 6c 61 67 73 20 70 61  hen the flags pa
257a0 72 61 6d 65 74 65 72 20 74 6f 20 78 4f 70 65 6e  rameter to xOpen
257b0 28 29 20 68 61 73 20 6f 6e 65 20 6f 72 20 0a 2a  () has one or .*
257c0 2a 20 6d 6f 72 65 20 6f 66 20 74 68 65 20 5b 53  * more of the [S
257d0 51 4c 49 54 45 5f 4f 50 45 4e 5f 55 52 49 5d 20  QLITE_OPEN_URI] 
257e0 6f 72 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  or [SQLITE_OPEN_
257f0 4d 41 49 4e 5f 44 42 5d 20 62 69 74 73 20 73 65  MAIN_DB] bits se
25800 74 20 61 6e 64 0a 2a 2a 20 50 20 69 73 20 74 68  t and.** P is th
25810 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 71 75  e name of the qu
25820 65 72 79 20 70 61 72 61 6d 65 74 65 72 2c 20 74  ery parameter, t
25830 68 65 6e 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 75  hen.** sqlite3_u
25840 72 69 5f 70 61 72 61 6d 65 74 65 72 28 46 2c 50  ri_parameter(F,P
25850 29 20 72 65 74 75 72 6e 73 20 74 68 65 20 76 61  ) returns the va
25860 6c 75 65 20 6f 66 20 74 68 65 20 50 0a 2a 2a 20  lue of the P.** 
25870 70 61 72 61 6d 65 74 65 72 20 69 66 20 69 74 20  parameter if it 
25880 65 78 69 73 74 73 20 6f 72 20 61 20 4e 55 4c 4c  exists or a NULL
25890 20 70 6f 69 6e 74 65 72 20 69 66 20 50 20 64 6f   pointer if P do
258a0 65 73 20 6e 6f 74 20 61 70 70 65 61 72 20 61 73  es not appear as
258b0 20 61 20 0a 2a 2a 20 71 75 65 72 79 20 70 61 72   a .** query par
258c0 61 6d 65 74 65 72 20 6f 6e 20 46 2e 20 20 49 66  ameter on F.  If
258d0 20 50 20 69 73 20 61 20 71 75 65 72 79 20 70 61   P is a query pa
258e0 72 61 6d 65 74 65 72 20 6f 66 20 46 0a 2a 2a 20  rameter of F.** 
258f0 68 61 73 20 6e 6f 20 65 78 70 6c 69 63 69 74 20  has no explicit 
25900 76 61 6c 75 65 2c 20 74 68 65 6e 20 73 71 6c 69  value, then sqli
25910 74 65 33 5f 75 72 69 5f 70 61 72 61 6d 65 74 65  te3_uri_paramete
25920 72 28 46 2c 50 29 20 72 65 74 75 72 6e 73 0a 2a  r(F,P) returns.*
25930 2a 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61  * a pointer to a
25940 6e 20 65 6d 70 74 79 20 73 74 72 69 6e 67 2e 0a  n empty string..
25950 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65  **.** The sqlite
25960 33 5f 75 72 69 5f 62 6f 6f 6c 65 61 6e 28 46 2c  3_uri_boolean(F,
25970 50 2c 42 29 20 72 6f 75 74 69 6e 65 20 61 73 73  P,B) routine ass
25980 75 6d 65 73 20 74 68 61 74 20 50 20 69 73 20 61  umes that P is a
25990 20 62 6f 6f 6c 65 61 6e 0a 2a 2a 20 70 61 72 61   boolean.** para
259a0 6d 65 74 65 72 20 61 6e 64 20 72 65 74 75 72 6e  meter and return
259b0 73 20 74 72 75 65 20 28 31 29 20 6f 72 20 66 61  s true (1) or fa
259c0 6c 73 65 20 28 30 29 20 61 63 63 6f 72 64 69 6e  lse (0) accordin
259d0 67 20 74 6f 20 74 68 65 20 76 61 6c 75 65 0a 2a  g to the value.*
259e0 2a 20 6f 66 20 50 2e 20 20 54 68 65 20 73 71 6c  * of P.  The sql
259f0 69 74 65 33 5f 75 72 69 5f 62 6f 6f 6c 65 61 6e  ite3_uri_boolean
25a00 28 46 2c 50 2c 42 29 20 72 6f 75 74 69 6e 65 20  (F,P,B) routine 
25a10 72 65 74 75 72 6e 73 20 74 72 75 65 20 28 31 29  returns true (1)
25a20 20 69 66 20 74 68 65 0a 2a 2a 20 76 61 6c 75 65   if the.** value
25a30 20 6f 66 20 71 75 65 72 79 20 70 61 72 61 6d 65   of query parame
25a40 74 65 72 20 50 20 69 73 20 6f 6e 65 20 6f 66 20  ter P is one of 
25a50 22 79 65 73 22 2c 20 22 74 72 75 65 22 2c 20 6f  "yes", "true", o
25a60 72 20 22 6f 6e 22 20 69 6e 20 61 6e 79 0a 2a 2a  r "on" in any.**
25a70 20 63 61 73 65 20 6f 72 20 69 66 20 74 68 65 20   case or if the 
25a80 76 61 6c 75 65 20 62 65 67 69 6e 73 20 77 69 74  value begins wit
25a90 68 20 61 20 6e 6f 6e 2d 7a 65 72 6f 20 6e 75 6d  h a non-zero num
25aa0 62 65 72 2e 20 20 54 68 65 20 0a 2a 2a 20 73 71  ber.  The .** sq
25ab0 6c 69 74 65 33 5f 75 72 69 5f 62 6f 6f 6c 65 61  lite3_uri_boolea
25ac0 6e 28 46 2c 50 2c 42 29 20 72 6f 75 74 69 6e 65  n(F,P,B) routine
25ad0 73 20 72 65 74 75 72 6e 73 20 66 61 6c 73 65 20  s returns false 
25ae0 28 30 29 20 69 66 20 74 68 65 20 76 61 6c 75 65  (0) if the value
25af0 20 6f 66 0a 2a 2a 20 71 75 65 72 79 20 70 61 72   of.** query par
25b00 61 6d 65 74 65 72 20 50 20 69 73 20 6f 6e 65 20  ameter P is one 
25b10 6f 66 20 22 6e 6f 22 2c 20 22 66 61 6c 73 65 22  of "no", "false"
25b20 2c 20 6f 72 20 22 6f 66 66 22 20 69 6e 20 61 6e  , or "off" in an
25b30 79 20 63 61 73 65 20 6f 72 0a 2a 2a 20 69 66 20  y case or.** if 
25b40 74 68 65 20 76 61 6c 75 65 20 62 65 67 69 6e 73  the value begins
25b50 20 77 69 74 68 20 61 20 6e 75 6d 65 72 69 63 20   with a numeric 
25b60 7a 65 72 6f 2e 20 20 49 66 20 50 20 69 73 20 6e  zero.  If P is n
25b70 6f 74 20 61 20 71 75 65 72 79 0a 2a 2a 20 70 61  ot a query.** pa
25b80 72 61 6d 65 74 65 72 20 6f 6e 20 46 20 6f 72 20  rameter on F or 
25b90 69 66 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20  if the value of 
25ba0 50 20 69 73 20 64 6f 65 73 20 6e 6f 74 20 6d 61  P is does not ma
25bb0 74 63 68 20 61 6e 79 20 6f 66 20 74 68 65 0a 2a  tch any of the.*
25bc0 2a 20 61 62 6f 76 65 2c 20 74 68 65 6e 20 73 71  * above, then sq
25bd0 6c 69 74 65 33 5f 75 72 69 5f 62 6f 6f 6c 65 61  lite3_uri_boolea
25be0 6e 28 46 2c 50 2c 42 29 20 72 65 74 75 72 6e 73  n(F,P,B) returns
25bf0 20 28 42 21 3d 30 29 2e 0a 2a 2a 0a 2a 2a 20 54   (B!=0)..**.** T
25c00 68 65 20 73 71 6c 69 74 65 33 5f 75 72 69 5f 69  he sqlite3_uri_i
25c10 6e 74 36 34 28 46 2c 50 2c 44 29 20 72 6f 75 74  nt64(F,P,D) rout
25c20 69 6e 65 20 63 6f 6e 76 65 72 74 73 20 74 68 65  ine converts the
25c30 20 76 61 6c 75 65 20 6f 66 20 50 20 69 6e 74 6f   value of P into
25c40 20 61 0a 2a 2a 20 36 34 2d 62 69 74 20 73 69 67   a.** 64-bit sig
25c50 6e 65 64 20 69 6e 74 65 67 65 72 20 61 6e 64 20  ned integer and 
25c60 72 65 74 75 72 6e 73 20 74 68 61 74 20 69 6e 74  returns that int
25c70 65 67 65 72 2c 20 6f 72 20 44 20 69 66 20 50 20  eger, or D if P 
25c80 64 6f 65 73 20 6e 6f 74 0a 2a 2a 20 65 78 69 73  does not.** exis
25c90 74 2e 20 20 49 66 20 74 68 65 20 76 61 6c 75 65  t.  If the value
25ca0 20 6f 66 20 50 20 69 73 20 73 6f 6d 65 74 68 69   of P is somethi
25cb0 6e 67 20 6f 74 68 65 72 20 74 68 61 6e 20 61 6e  ng other than an
25cc0 20 69 6e 74 65 67 65 72 2c 20 74 68 65 6e 0a 2a   integer, then.*
25cd0 2a 20 7a 65 72 6f 20 69 73 20 72 65 74 75 72 6e  * zero is return
25ce0 65 64 2e 0a 2a 2a 20 0a 2a 2a 20 49 66 20 46 20  ed..** .** If F 
25cf0 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  is a NULL pointe
25d00 72 2c 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f  r, then sqlite3_
25d10 75 72 69 5f 70 61 72 61 6d 65 74 65 72 28 46 2c  uri_parameter(F,
25d20 50 29 20 72 65 74 75 72 6e 73 20 4e 55 4c 4c 20  P) returns NULL 
25d30 61 6e 64 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 75  and.** sqlite3_u
25d40 72 69 5f 62 6f 6f 6c 65 61 6e 28 46 2c 50 2c 42  ri_boolean(F,P,B
25d50 29 20 72 65 74 75 72 6e 73 20 42 2e 20 20 49 66  ) returns B.  If
25d60 20 46 20 69 73 20 6e 6f 74 20 61 20 4e 55 4c 4c   F is not a NULL
25d70 20 70 6f 69 6e 74 65 72 20 61 6e 64 0a 2a 2a 20   pointer and.** 
25d80 69 73 20 6e 6f 74 20 61 20 64 61 74 61 62 61 73  is not a databas
25d90 65 20 66 69 6c 65 20 70 61 74 68 6e 61 6d 65 20  e file pathname 
25da0 70 6f 69 6e 74 65 72 20 74 68 61 74 20 53 51 4c  pointer that SQL
25db0 69 74 65 20 70 61 73 73 65 64 20 69 6e 74 6f 20  ite passed into 
25dc0 74 68 65 20 78 4f 70 65 6e 0a 2a 2a 20 56 46 53  the xOpen.** VFS
25dd0 20 6d 65 74 68 6f 64 2c 20 74 68 65 6e 20 74 68   method, then th
25de0 65 20 62 65 68 61 76 69 6f 72 20 6f 66 20 74 68  e behavior of th
25df0 69 73 20 72 6f 75 74 69 6e 65 20 69 73 20 75 6e  is routine is un
25e00 64 65 66 69 6e 65 64 20 61 6e 64 20 70 72 6f 62  defined and prob
25e10 61 62 6c 79 0a 2a 2a 20 75 6e 64 65 73 69 72 61  ably.** undesira
25e20 62 6c 65 2e 0a 2a 2f 0a 63 6f 6e 73 74 20 63 68  ble..*/.const ch
25e30 61 72 20 2a 73 71 6c 69 74 65 33 5f 75 72 69 5f  ar *sqlite3_uri_
25e40 70 61 72 61 6d 65 74 65 72 28 63 6f 6e 73 74 20  parameter(const 
25e50 63 68 61 72 20 2a 7a 46 69 6c 65 6e 61 6d 65 2c  char *zFilename,
25e60 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 50 61   const char *zPa
25e70 72 61 6d 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  ram);.int sqlite
25e80 33 5f 75 72 69 5f 62 6f 6f 6c 65 61 6e 28 63 6f  3_uri_boolean(co
25e90 6e 73 74 20 63 68 61 72 20 2a 7a 46 69 6c 65 2c  nst char *zFile,
25ea0 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 50 61   const char *zPa
25eb0 72 61 6d 2c 20 69 6e 74 20 62 44 65 66 61 75 6c  ram, int bDefaul
25ec0 74 29 3b 0a 73 71 6c 69 74 65 33 5f 69 6e 74 36  t);.sqlite3_int6
25ed0 34 20 73 71 6c 69 74 65 33 5f 75 72 69 5f 69 6e  4 sqlite3_uri_in
25ee0 74 36 34 28 63 6f 6e 73 74 20 63 68 61 72 2a 2c  t64(const char*,
25ef0 20 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20 73 71   const char*, sq
25f00 6c 69 74 65 33 5f 69 6e 74 36 34 29 3b 0a 0a 0a  lite3_int64);...
25f10 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
25f20 45 72 72 6f 72 20 43 6f 64 65 73 20 41 6e 64 20  Error Codes And 
25f30 4d 65 73 73 61 67 65 73 0a 2a 2a 20 4d 45 54 48  Messages.** METH
25f40 4f 44 3a 20 73 71 6c 69 74 65 33 0a 2a 2a 0a 2a  OD: sqlite3.**.*
25f50 2a 20 5e 49 66 20 74 68 65 20 6d 6f 73 74 20 72  * ^If the most r
25f60 65 63 65 6e 74 20 73 71 6c 69 74 65 33 5f 2a 20  ecent sqlite3_* 
25f70 41 50 49 20 63 61 6c 6c 20 61 73 73 6f 63 69 61  API call associa
25f80 74 65 64 20 77 69 74 68 20 0a 2a 2a 20 5b 64 61  ted with .** [da
25f90 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
25fa0 6e 5d 20 44 20 66 61 69 6c 65 64 2c 20 74 68 65  n] D failed, the
25fb0 6e 20 74 68 65 20 73 71 6c 69 74 65 33 5f 65 72  n the sqlite3_er
25fc0 72 63 6f 64 65 28 44 29 20 69 6e 74 65 72 66 61  rcode(D) interfa
25fd0 63 65 0a 2a 2a 20 72 65 74 75 72 6e 73 20 74 68  ce.** returns th
25fe0 65 20 6e 75 6d 65 72 69 63 20 5b 72 65 73 75 6c  e numeric [resul
25ff0 74 20 63 6f 64 65 5d 20 6f 72 20 5b 65 78 74 65  t code] or [exte
26000 6e 64 65 64 20 72 65 73 75 6c 74 20 63 6f 64 65  nded result code
26010 5d 20 66 6f 72 20 74 68 61 74 0a 2a 2a 20 41 50  ] for that.** AP
26020 49 20 63 61 6c 6c 2e 0a 2a 2a 20 49 66 20 74 68  I call..** If th
26030 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 20 41 50  e most recent AP
26040 49 20 63 61 6c 6c 20 77 61 73 20 73 75 63 63 65  I call was succe
26050 73 73 66 75 6c 2c 0a 2a 2a 20 74 68 65 6e 20 74  ssful,.** then t
26060 68 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 20  he return value 
26070 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f 65 72 72  from sqlite3_err
26080 63 6f 64 65 28 29 20 69 73 20 75 6e 64 65 66 69  code() is undefi
26090 6e 65 64 2e 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  ned..** ^The sql
260a0 69 74 65 33 5f 65 78 74 65 6e 64 65 64 5f 65 72  ite3_extended_er
260b0 72 63 6f 64 65 28 29 0a 2a 2a 20 69 6e 74 65 72  rcode().** inter
260c0 66 61 63 65 20 69 73 20 74 68 65 20 73 61 6d 65  face is the same
260d0 20 65 78 63 65 70 74 20 74 68 61 74 20 69 74 20   except that it 
260e0 61 6c 77 61 79 73 20 72 65 74 75 72 6e 73 20 74  always returns t
260f0 68 65 20 0a 2a 2a 20 5b 65 78 74 65 6e 64 65 64  he .** [extended
26100 20 72 65 73 75 6c 74 20 63 6f 64 65 5d 20 65 76   result code] ev
26110 65 6e 20 77 68 65 6e 20 65 78 74 65 6e 64 65 64  en when extended
26120 20 72 65 73 75 6c 74 20 63 6f 64 65 73 20 61 72   result codes ar
26130 65 0a 2a 2a 20 64 69 73 61 62 6c 65 64 2e 0a 2a  e.** disabled..*
26140 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65  *.** ^The sqlite
26150 33 5f 65 72 72 6d 73 67 28 29 20 61 6e 64 20 73  3_errmsg() and s
26160 71 6c 69 74 65 33 5f 65 72 72 6d 73 67 31 36 28  qlite3_errmsg16(
26170 29 20 72 65 74 75 72 6e 20 45 6e 67 6c 69 73 68  ) return English
26180 2d 6c 61 6e 67 75 61 67 65 0a 2a 2a 20 74 65 78  -language.** tex
26190 74 20 74 68 61 74 20 64 65 73 63 72 69 62 65 73  t that describes
261a0 20 74 68 65 20 65 72 72 6f 72 2c 20 61 73 20 65   the error, as e
261b0 69 74 68 65 72 20 55 54 46 2d 38 20 6f 72 20 55  ither UTF-8 or U
261c0 54 46 2d 31 36 20 72 65 73 70 65 63 74 69 76 65  TF-16 respective
261d0 6c 79 2e 0a 2a 2a 20 5e 28 4d 65 6d 6f 72 79 20  ly..** ^(Memory 
261e0 74 6f 20 68 6f 6c 64 20 74 68 65 20 65 72 72 6f  to hold the erro
261f0 72 20 6d 65 73 73 61 67 65 20 73 74 72 69 6e 67  r message string
26200 20 69 73 20 6d 61 6e 61 67 65 64 20 69 6e 74 65   is managed inte
26210 72 6e 61 6c 6c 79 2e 0a 2a 2a 20 54 68 65 20 61  rnally..** The a
26220 70 70 6c 69 63 61 74 69 6f 6e 20 64 6f 65 73 20  pplication does 
26230 6e 6f 74 20 6e 65 65 64 20 74 6f 20 77 6f 72 72  not need to worr
26240 79 20 61 62 6f 75 74 20 66 72 65 65 69 6e 67 20  y about freeing 
26250 74 68 65 20 72 65 73 75 6c 74 2e 0a 2a 2a 20 48  the result..** H
26260 6f 77 65 76 65 72 2c 20 74 68 65 20 65 72 72 6f  owever, the erro
26270 72 20 73 74 72 69 6e 67 20 6d 69 67 68 74 20 62  r string might b
26280 65 20 6f 76 65 72 77 72 69 74 74 65 6e 20 6f 72  e overwritten or
26290 20 64 65 61 6c 6c 6f 63 61 74 65 64 20 62 79 0a   deallocated by.
262a0 2a 2a 20 73 75 62 73 65 71 75 65 6e 74 20 63 61  ** subsequent ca
262b0 6c 6c 73 20 74 6f 20 6f 74 68 65 72 20 53 51 4c  lls to other SQL
262c0 69 74 65 20 69 6e 74 65 72 66 61 63 65 20 66 75  ite interface fu
262d0 6e 63 74 69 6f 6e 73 2e 29 5e 0a 2a 2a 0a 2a 2a  nctions.)^.**.**
262e0 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 65 72   ^The sqlite3_er
262f0 72 73 74 72 28 29 20 69 6e 74 65 72 66 61 63 65  rstr() interface
26300 20 72 65 74 75 72 6e 73 20 74 68 65 20 45 6e 67   returns the Eng
26310 6c 69 73 68 2d 6c 61 6e 67 75 61 67 65 20 74 65  lish-language te
26320 78 74 0a 2a 2a 20 74 68 61 74 20 64 65 73 63 72  xt.** that descr
26330 69 62 65 73 20 74 68 65 20 5b 72 65 73 75 6c 74  ibes the [result
26340 20 63 6f 64 65 5d 2c 20 61 73 20 55 54 46 2d 38   code], as UTF-8
26350 2e 0a 2a 2a 20 5e 28 4d 65 6d 6f 72 79 20 74 6f  ..** ^(Memory to
26360 20 68 6f 6c 64 20 74 68 65 20 65 72 72 6f 72 20   hold the error 
26370 6d 65 73 73 61 67 65 20 73 74 72 69 6e 67 20 69  message string i
26380 73 20 6d 61 6e 61 67 65 64 20 69 6e 74 65 72 6e  s managed intern
26390 61 6c 6c 79 0a 2a 2a 20 61 6e 64 20 6d 75 73 74  ally.** and must
263a0 20 6e 6f 74 20 62 65 20 66 72 65 65 64 20 62 79   not be freed by
263b0 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   the application
263c0 29 5e 2e 0a 2a 2a 0a 2a 2a 20 57 68 65 6e 20 74  )^..**.** When t
263d0 68 65 20 73 65 72 69 61 6c 69 7a 65 64 20 5b 74  he serialized [t
263e0 68 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 69  hreading mode] i
263f0 73 20 69 6e 20 75 73 65 2c 20 69 74 20 6d 69 67  s in use, it mig
26400 68 74 20 62 65 20 74 68 65 0a 2a 2a 20 63 61 73  ht be the.** cas
26410 65 20 74 68 61 74 20 61 20 73 65 63 6f 6e 64 20  e that a second 
26420 65 72 72 6f 72 20 6f 63 63 75 72 73 20 6f 6e 20  error occurs on 
26430 61 20 73 65 70 61 72 61 74 65 20 74 68 72 65 61  a separate threa
26440 64 20 69 6e 20 62 65 74 77 65 65 6e 0a 2a 2a 20  d in between.** 
26450 74 68 65 20 74 69 6d 65 20 6f 66 20 74 68 65 20  the time of the 
26460 66 69 72 73 74 20 65 72 72 6f 72 20 61 6e 64 20  first error and 
26470 74 68 65 20 63 61 6c 6c 20 74 6f 20 74 68 65 73  the call to thes
26480 65 20 69 6e 74 65 72 66 61 63 65 73 2e 0a 2a 2a  e interfaces..**
26490 20 57 68 65 6e 20 74 68 61 74 20 68 61 70 70 65   When that happe
264a0 6e 73 2c 20 74 68 65 20 73 65 63 6f 6e 64 20 65  ns, the second e
264b0 72 72 6f 72 20 77 69 6c 6c 20 62 65 20 72 65 70  rror will be rep
264c0 6f 72 74 65 64 20 73 69 6e 63 65 20 74 68 65 73  orted since thes
264d0 65 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 73 20  e.** interfaces 
264e0 61 6c 77 61 79 73 20 72 65 70 6f 72 74 20 74 68  always report th
264f0 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 20 72 65  e most recent re
26500 73 75 6c 74 2e 20 20 54 6f 20 61 76 6f 69 64 0a  sult.  To avoid.
26510 2a 2a 20 74 68 69 73 2c 20 65 61 63 68 20 74 68  ** this, each th
26520 72 65 61 64 20 63 61 6e 20 6f 62 74 61 69 6e 20  read can obtain 
26530 65 78 63 6c 75 73 69 76 65 20 75 73 65 20 6f 66  exclusive use of
26540 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20 63   the [database c
26550 6f 6e 6e 65 63 74 69 6f 6e 5d 20 44 0a 2a 2a 20  onnection] D.** 
26560 62 79 20 69 6e 76 6f 6b 69 6e 67 20 5b 73 71 6c  by invoking [sql
26570 69 74 65 33 5f 6d 75 74 65 78 5f 65 6e 74 65 72  ite3_mutex_enter
26580 5d 28 5b 73 71 6c 69 74 65 33 5f 64 62 5f 6d 75  ]([sqlite3_db_mu
26590 74 65 78 5d 28 44 29 29 20 62 65 66 6f 72 65 20  tex](D)) before 
265a0 62 65 67 69 6e 6e 69 6e 67 0a 2a 2a 20 74 6f 20  beginning.** to 
265b0 75 73 65 20 44 20 61 6e 64 20 69 6e 76 6f 6b 69  use D and invoki
265c0 6e 67 20 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65  ng [sqlite3_mute
265d0 78 5f 6c 65 61 76 65 5d 28 5b 73 71 6c 69 74 65  x_leave]([sqlite
265e0 33 5f 64 62 5f 6d 75 74 65 78 5d 28 44 29 29 20  3_db_mutex](D)) 
265f0 61 66 74 65 72 0a 2a 2a 20 61 6c 6c 20 63 61 6c  after.** all cal
26600 6c 73 20 74 6f 20 74 68 65 20 69 6e 74 65 72 66  ls to the interf
26610 61 63 65 73 20 6c 69 73 74 65 64 20 68 65 72 65  aces listed here
26620 20 61 72 65 20 63 6f 6d 70 6c 65 74 65 64 2e 0a   are completed..
26630 2a 2a 0a 2a 2a 20 49 66 20 61 6e 20 69 6e 74 65  **.** If an inte
26640 72 66 61 63 65 20 66 61 69 6c 73 20 77 69 74 68  rface fails with
26650 20 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 2c 20   SQLITE_MISUSE, 
26660 74 68 61 74 20 6d 65 61 6e 73 20 74 68 65 20 69  that means the i
26670 6e 74 65 72 66 61 63 65 0a 2a 2a 20 77 61 73 20  nterface.** was 
26680 69 6e 76 6f 6b 65 64 20 69 6e 63 6f 72 72 65 63  invoked incorrec
26690 74 6c 79 20 62 79 20 74 68 65 20 61 70 70 6c 69  tly by the appli
266a0 63 61 74 69 6f 6e 2e 20 20 49 6e 20 74 68 61 74  cation.  In that
266b0 20 63 61 73 65 2c 20 74 68 65 0a 2a 2a 20 65 72   case, the.** er
266c0 72 6f 72 20 63 6f 64 65 20 61 6e 64 20 6d 65 73  ror code and mes
266d0 73 61 67 65 20 6d 61 79 20 6f 72 20 6d 61 79 20  sage may or may 
266e0 6e 6f 74 20 62 65 20 73 65 74 2e 0a 2a 2f 0a 69  not be set..*/.i
266f0 6e 74 20 73 71 6c 69 74 65 33 5f 65 72 72 63 6f  nt sqlite3_errco
26700 64 65 28 73 71 6c 69 74 65 33 20 2a 64 62 29 3b  de(sqlite3 *db);
26710 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 65 78 74  .int sqlite3_ext
26720 65 6e 64 65 64 5f 65 72 72 63 6f 64 65 28 73 71  ended_errcode(sq
26730 6c 69 74 65 33 20 2a 64 62 29 3b 0a 63 6f 6e 73  lite3 *db);.cons
26740 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f  t char *sqlite3_
26750 65 72 72 6d 73 67 28 73 71 6c 69 74 65 33 2a 29  errmsg(sqlite3*)
26760 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71  ;.const void *sq
26770 6c 69 74 65 33 5f 65 72 72 6d 73 67 31 36 28 73  lite3_errmsg16(s
26780 71 6c 69 74 65 33 2a 29 3b 0a 63 6f 6e 73 74 20  qlite3*);.const 
26790 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 65 72  char *sqlite3_er
267a0 72 73 74 72 28 69 6e 74 29 3b 0a 0a 2f 2a 0a 2a  rstr(int);../*.*
267b0 2a 20 43 41 50 49 33 52 45 46 3a 20 50 72 65 70  * CAPI3REF: Prep
267c0 61 72 65 64 20 53 74 61 74 65 6d 65 6e 74 20 4f  ared Statement O
267d0 62 6a 65 63 74 0a 2a 2a 20 4b 45 59 57 4f 52 44  bject.** KEYWORD
267e0 53 3a 20 7b 70 72 65 70 61 72 65 64 20 73 74 61  S: {prepared sta
267f0 74 65 6d 65 6e 74 7d 20 7b 70 72 65 70 61 72 65  tement} {prepare
26800 64 20 73 74 61 74 65 6d 65 6e 74 73 7d 0a 2a 2a  d statements}.**
26810 0a 2a 2a 20 41 6e 20 69 6e 73 74 61 6e 63 65 20  .** An instance 
26820 6f 66 20 74 68 69 73 20 6f 62 6a 65 63 74 20 72  of this object r
26830 65 70 72 65 73 65 6e 74 73 20 61 20 73 69 6e 67  epresents a sing
26840 6c 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  le SQL statement
26850 20 74 68 61 74 0a 2a 2a 20 68 61 73 20 62 65 65   that.** has bee
26860 6e 20 63 6f 6d 70 69 6c 65 64 20 69 6e 74 6f 20  n compiled into 
26870 62 69 6e 61 72 79 20 66 6f 72 6d 20 61 6e 64 20  binary form and 
26880 69 73 20 72 65 61 64 79 20 74 6f 20 62 65 20 65  is ready to be e
26890 76 61 6c 75 61 74 65 64 2e 0a 2a 2a 0a 2a 2a 20  valuated..**.** 
268a0 54 68 69 6e 6b 20 6f 66 20 65 61 63 68 20 53 51  Think of each SQ
268b0 4c 20 73 74 61 74 65 6d 65 6e 74 20 61 73 20 61  L statement as a
268c0 20 73 65 70 61 72 61 74 65 20 63 6f 6d 70 75 74   separate comput
268d0 65 72 20 70 72 6f 67 72 61 6d 2e 20 20 54 68 65  er program.  The
268e0 0a 2a 2a 20 6f 72 69 67 69 6e 61 6c 20 53 51 4c  .** original SQL
268f0 20 74 65 78 74 20 69 73 20 73 6f 75 72 63 65 20   text is source 
26900 63 6f 64 65 2e 20 20 41 20 70 72 65 70 61 72 65  code.  A prepare
26910 64 20 73 74 61 74 65 6d 65 6e 74 20 6f 62 6a 65  d statement obje
26920 63 74 20 0a 2a 2a 20 69 73 20 74 68 65 20 63 6f  ct .** is the co
26930 6d 70 69 6c 65 64 20 6f 62 6a 65 63 74 20 63 6f  mpiled object co
26940 64 65 2e 20 20 41 6c 6c 20 53 51 4c 20 6d 75 73  de.  All SQL mus
26950 74 20 62 65 20 63 6f 6e 76 65 72 74 65 64 20 69  t be converted i
26960 6e 74 6f 20 61 0a 2a 2a 20 70 72 65 70 61 72 65  nto a.** prepare
26970 64 20 73 74 61 74 65 6d 65 6e 74 20 62 65 66 6f  d statement befo
26980 72 65 20 69 74 20 63 61 6e 20 62 65 20 72 75 6e  re it can be run
26990 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 6c 69 66 65  ..**.** The life
269a0 2d 63 79 63 6c 65 20 6f 66 20 61 20 70 72 65 70  -cycle of a prep
269b0 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 20 6f  ared statement o
269c0 62 6a 65 63 74 20 75 73 75 61 6c 6c 79 20 67 6f  bject usually go
269d0 65 73 20 6c 69 6b 65 20 74 68 69 73 3a 0a 2a 2a  es like this:.**
269e0 0a 2a 2a 20 3c 6f 6c 3e 0a 2a 2a 20 3c 6c 69 3e  .** <ol>.** <li>
269f0 20 43 72 65 61 74 65 20 74 68 65 20 70 72 65 70   Create the prep
26a00 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 20 6f  ared statement o
26a10 62 6a 65 63 74 20 75 73 69 6e 67 20 5b 73 71 6c  bject using [sql
26a20 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76 32 28  ite3_prepare_v2(
26a30 29 5d 2e 0a 2a 2a 20 3c 6c 69 3e 20 42 69 6e 64  )]..** <li> Bind
26a40 20 76 61 6c 75 65 73 20 74 6f 20 5b 70 61 72 61   values to [para
26a50 6d 65 74 65 72 73 5d 20 75 73 69 6e 67 20 74 68  meters] using th
26a60 65 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 2a  e sqlite3_bind_*
26a70 28 29 0a 2a 2a 20 20 20 20 20 20 69 6e 74 65 72  ().**      inter
26a80 66 61 63 65 73 2e 0a 2a 2a 20 3c 6c 69 3e 20 52  faces..** <li> R
26a90 75 6e 20 74 68 65 20 53 51 4c 20 62 79 20 63 61  un the SQL by ca
26aa0 6c 6c 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 73  lling [sqlite3_s
26ab0 74 65 70 28 29 5d 20 6f 6e 65 20 6f 72 20 6d 6f  tep()] one or mo
26ac0 72 65 20 74 69 6d 65 73 2e 0a 2a 2a 20 3c 6c 69  re times..** <li
26ad0 3e 20 52 65 73 65 74 20 74 68 65 20 70 72 65 70  > Reset the prep
26ae0 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 20 75  ared statement u
26af0 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 72 65  sing [sqlite3_re
26b00 73 65 74 28 29 5d 20 74 68 65 6e 20 67 6f 20 62  set()] then go b
26b10 61 63 6b 0a 2a 2a 20 20 20 20 20 20 74 6f 20 73  ack.**      to s
26b20 74 65 70 20 32 2e 20 20 44 6f 20 74 68 69 73 20  tep 2.  Do this 
26b30 7a 65 72 6f 20 6f 72 20 6d 6f 72 65 20 74 69 6d  zero or more tim
26b40 65 73 2e 0a 2a 2a 20 3c 6c 69 3e 20 44 65 73 74  es..** <li> Dest
26b50 72 6f 79 20 74 68 65 20 6f 62 6a 65 63 74 20 75  roy the object u
26b60 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 66 69  sing [sqlite3_fi
26b70 6e 61 6c 69 7a 65 28 29 5d 2e 0a 2a 2a 20 3c 2f  nalize()]..** </
26b80 6f 6c 3e 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73  ol>.*/.typedef s
26b90 74 72 75 63 74 20 73 71 6c 69 74 65 33 5f 73 74  truct sqlite3_st
26ba0 6d 74 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 3b  mt sqlite3_stmt;
26bb0 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
26bc0 3a 20 52 75 6e 2d 74 69 6d 65 20 4c 69 6d 69 74  : Run-time Limit
26bd0 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c  s.** METHOD: sql
26be0 69 74 65 33 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 69  ite3.**.** ^(Thi
26bf0 73 20 69 6e 74 65 72 66 61 63 65 20 61 6c 6c 6f  s interface allo
26c00 77 73 20 74 68 65 20 73 69 7a 65 20 6f 66 20 76  ws the size of v
26c10 61 72 69 6f 75 73 20 63 6f 6e 73 74 72 75 63 74  arious construct
26c20 73 20 74 6f 20 62 65 20 6c 69 6d 69 74 65 64 0a  s to be limited.
26c30 2a 2a 20 6f 6e 20 61 20 63 6f 6e 6e 65 63 74 69  ** on a connecti
26c40 6f 6e 20 62 79 20 63 6f 6e 6e 65 63 74 69 6f 6e  on by connection
26c50 20 62 61 73 69 73 2e 20 20 54 68 65 20 66 69 72   basis.  The fir
26c60 73 74 20 70 61 72 61 6d 65 74 65 72 20 69 73 20  st parameter is 
26c70 74 68 65 0a 2a 2a 20 5b 64 61 74 61 62 61 73 65  the.** [database
26c80 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 77 68 6f   connection] who
26c90 73 65 20 6c 69 6d 69 74 20 69 73 20 74 6f 20 62  se limit is to b
26ca0 65 20 73 65 74 20 6f 72 20 71 75 65 72 69 65 64  e set or queried
26cb0 2e 20 20 54 68 65 0a 2a 2a 20 73 65 63 6f 6e 64  .  The.** second
26cc0 20 70 61 72 61 6d 65 74 65 72 20 69 73 20 6f 6e   parameter is on
26cd0 65 20 6f 66 20 74 68 65 20 5b 6c 69 6d 69 74 20  e of the [limit 
26ce0 63 61 74 65 67 6f 72 69 65 73 5d 20 74 68 61 74  categories] that
26cf0 20 64 65 66 69 6e 65 20 61 0a 2a 2a 20 63 6c 61   define a.** cla
26d00 73 73 20 6f 66 20 63 6f 6e 73 74 72 75 63 74 73  ss of constructs
26d10 20 74 6f 20 62 65 20 73 69 7a 65 20 6c 69 6d 69   to be size limi
26d20 74 65 64 2e 20 20 54 68 65 20 74 68 69 72 64 20  ted.  The third 
26d30 70 61 72 61 6d 65 74 65 72 20 69 73 20 74 68 65  parameter is the
26d40 0a 2a 2a 20 6e 65 77 20 6c 69 6d 69 74 20 66 6f  .** new limit fo
26d50 72 20 74 68 61 74 20 63 6f 6e 73 74 72 75 63 74  r that construct
26d60 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68  .)^.**.** ^If th
26d70 65 20 6e 65 77 20 6c 69 6d 69 74 20 69 73 20 61  e new limit is a
26d80 20 6e 65 67 61 74 69 76 65 20 6e 75 6d 62 65 72   negative number
26d90 2c 20 74 68 65 20 6c 69 6d 69 74 20 69 73 20 75  , the limit is u
26da0 6e 63 68 61 6e 67 65 64 2e 0a 2a 2a 20 5e 28 46  nchanged..** ^(F
26db0 6f 72 20 65 61 63 68 20 6c 69 6d 69 74 20 63 61  or each limit ca
26dc0 74 65 67 6f 72 79 20 53 51 4c 49 54 45 5f 4c 49  tegory SQLITE_LI
26dd0 4d 49 54 5f 3c 69 3e 4e 41 4d 45 3c 2f 69 3e 20  MIT_<i>NAME</i> 
26de0 74 68 65 72 65 20 69 73 20 61 20 0a 2a 2a 20 5b  there is a .** [
26df0 6c 69 6d 69 74 73 20 7c 20 68 61 72 64 20 75 70  limits | hard up
26e00 70 65 72 20 62 6f 75 6e 64 5d 0a 2a 2a 20 73 65  per bound].** se
26e10 74 20 61 74 20 63 6f 6d 70 69 6c 65 2d 74 69 6d  t at compile-tim
26e20 65 20 62 79 20 61 20 43 20 70 72 65 70 72 6f 63  e by a C preproc
26e30 65 73 73 6f 72 20 6d 61 63 72 6f 20 63 61 6c 6c  essor macro call
26e40 65 64 0a 2a 2a 20 5b 6c 69 6d 69 74 73 20 7c 20  ed.** [limits | 
26e50 53 51 4c 49 54 45 5f 4d 41 58 5f 3c 69 3e 4e 41  SQLITE_MAX_<i>NA
26e60 4d 45 3c 2f 69 3e 5d 2e 0a 2a 2a 20 28 54 68 65  ME</i>]..** (The
26e70 20 22 5f 4c 49 4d 49 54 5f 22 20 69 6e 20 74 68   "_LIMIT_" in th
26e80 65 20 6e 61 6d 65 20 69 73 20 63 68 61 6e 67 65  e name is change
26e90 64 20 74 6f 20 22 5f 4d 41 58 5f 22 2e 29 29 5e  d to "_MAX_".))^
26ea0 0a 2a 2a 20 5e 41 74 74 65 6d 70 74 73 20 74 6f  .** ^Attempts to
26eb0 20 69 6e 63 72 65 61 73 65 20 61 20 6c 69 6d 69   increase a limi
26ec0 74 20 61 62 6f 76 65 20 69 74 73 20 68 61 72 64  t above its hard
26ed0 20 75 70 70 65 72 20 62 6f 75 6e 64 20 61 72 65   upper bound are
26ee0 0a 2a 2a 20 73 69 6c 65 6e 74 6c 79 20 74 72 75  .** silently tru
26ef0 6e 63 61 74 65 64 20 74 6f 20 74 68 65 20 68 61  ncated to the ha
26f00 72 64 20 75 70 70 65 72 20 62 6f 75 6e 64 2e 0a  rd upper bound..
26f10 2a 2a 0a 2a 2a 20 5e 52 65 67 61 72 64 6c 65 73  **.** ^Regardles
26f20 73 20 6f 66 20 77 68 65 74 68 65 72 20 6f 72 20  s of whether or 
26f30 6e 6f 74 20 74 68 65 20 6c 69 6d 69 74 20 77 61  not the limit wa
26f40 73 20 63 68 61 6e 67 65 64 2c 20 74 68 65 20 0a  s changed, the .
26f50 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6c 69 6d 69  ** [sqlite3_limi
26f60 74 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 72  t()] interface r
26f70 65 74 75 72 6e 73 20 74 68 65 20 70 72 69 6f 72  eturns the prior
26f80 20 76 61 6c 75 65 20 6f 66 20 74 68 65 20 6c 69   value of the li
26f90 6d 69 74 2e 0a 2a 2a 20 5e 48 65 6e 63 65 2c 20  mit..** ^Hence, 
26fa0 74 6f 20 66 69 6e 64 20 74 68 65 20 63 75 72 72  to find the curr
26fb0 65 6e 74 20 76 61 6c 75 65 20 6f 66 20 61 20 6c  ent value of a l
26fc0 69 6d 69 74 20 77 69 74 68 6f 75 74 20 63 68 61  imit without cha
26fd0 6e 67 69 6e 67 20 69 74 2c 0a 2a 2a 20 73 69 6d  nging it,.** sim
26fe0 70 6c 79 20 69 6e 76 6f 6b 65 20 74 68 69 73 20  ply invoke this 
26ff0 69 6e 74 65 72 66 61 63 65 20 77 69 74 68 20 74  interface with t
27000 68 65 20 74 68 69 72 64 20 70 61 72 61 6d 65 74  he third paramet
27010 65 72 20 73 65 74 20 74 6f 20 2d 31 2e 0a 2a 2a  er set to -1..**
27020 0a 2a 2a 20 52 75 6e 2d 74 69 6d 65 20 6c 69 6d  .** Run-time lim
27030 69 74 73 20 61 72 65 20 69 6e 74 65 6e 64 65 64  its are intended
27040 20 66 6f 72 20 75 73 65 20 69 6e 20 61 70 70 6c   for use in appl
27050 69 63 61 74 69 6f 6e 73 20 74 68 61 74 20 6d 61  ications that ma
27060 6e 61 67 65 0a 2a 2a 20 62 6f 74 68 20 74 68 65  nage.** both the
27070 69 72 20 6f 77 6e 20 69 6e 74 65 72 6e 61 6c 20  ir own internal 
27080 64 61 74 61 62 61 73 65 20 61 6e 64 20 61 6c 73  database and als
27090 6f 20 64 61 74 61 62 61 73 65 73 20 74 68 61 74  o databases that
270a0 20 61 72 65 20 63 6f 6e 74 72 6f 6c 6c 65 64 0a   are controlled.
270b0 2a 2a 20 62 79 20 75 6e 74 72 75 73 74 65 64 20  ** by untrusted 
270c0 65 78 74 65 72 6e 61 6c 20 73 6f 75 72 63 65 73  external sources
270d0 2e 20 20 41 6e 20 65 78 61 6d 70 6c 65 20 61 70  .  An example ap
270e0 70 6c 69 63 61 74 69 6f 6e 20 6d 69 67 68 74 20  plication might 
270f0 62 65 20 61 0a 2a 2a 20 77 65 62 20 62 72 6f 77  be a.** web brow
27100 73 65 72 20 74 68 61 74 20 68 61 73 20 69 74 73  ser that has its
27110 20 6f 77 6e 20 64 61 74 61 62 61 73 65 73 20 66   own databases f
27120 6f 72 20 73 74 6f 72 69 6e 67 20 68 69 73 74 6f  or storing histo
27130 72 79 20 61 6e 64 0a 2a 2a 20 73 65 70 61 72 61  ry and.** separa
27140 74 65 20 64 61 74 61 62 61 73 65 73 20 63 6f 6e  te databases con
27150 74 72 6f 6c 6c 65 64 20 62 79 20 4a 61 76 61 53  trolled by JavaS
27160 63 72 69 70 74 20 61 70 70 6c 69 63 61 74 69 6f  cript applicatio
27170 6e 73 20 64 6f 77 6e 6c 6f 61 64 65 64 0a 2a 2a  ns downloaded.**
27180 20 6f 66 66 20 74 68 65 20 49 6e 74 65 72 6e 65   off the Interne
27190 74 2e 20 20 54 68 65 20 69 6e 74 65 72 6e 61 6c  t.  The internal
271a0 20 64 61 74 61 62 61 73 65 73 20 63 61 6e 20 62   databases can b
271b0 65 20 67 69 76 65 6e 20 74 68 65 0a 2a 2a 20 6c  e given the.** l
271c0 61 72 67 65 2c 20 64 65 66 61 75 6c 74 20 6c 69  arge, default li
271d0 6d 69 74 73 2e 20 20 44 61 74 61 62 61 73 65 73  mits.  Databases
271e0 20 6d 61 6e 61 67 65 64 20 62 79 20 65 78 74 65   managed by exte
271f0 72 6e 61 6c 20 73 6f 75 72 63 65 73 20 63 61 6e  rnal sources can
27200 0a 2a 2a 20 62 65 20 67 69 76 65 6e 20 6d 75 63  .** be given muc
27210 68 20 73 6d 61 6c 6c 65 72 20 6c 69 6d 69 74 73  h smaller limits
27220 20 64 65 73 69 67 6e 65 64 20 74 6f 20 70 72 65   designed to pre
27230 76 65 6e 74 20 61 20 64 65 6e 69 61 6c 20 6f 66  vent a denial of
27240 20 73 65 72 76 69 63 65 0a 2a 2a 20 61 74 74 61   service.** atta
27250 63 6b 2e 20 20 44 65 76 65 6c 6f 70 65 72 73 20  ck.  Developers 
27260 6d 69 67 68 74 20 61 6c 73 6f 20 77 61 6e 74 20  might also want 
27270 74 6f 20 75 73 65 20 74 68 65 20 5b 73 71 6c 69  to use the [sqli
27280 74 65 33 5f 73 65 74 5f 61 75 74 68 6f 72 69 7a  te3_set_authoriz
27290 65 72 28 29 5d 0a 2a 2a 20 69 6e 74 65 72 66 61  er()].** interfa
272a0 63 65 20 74 6f 20 66 75 72 74 68 65 72 20 63 6f  ce to further co
272b0 6e 74 72 6f 6c 20 75 6e 74 72 75 73 74 65 64 20  ntrol untrusted 
272c0 53 51 4c 2e 20 20 54 68 65 20 73 69 7a 65 20 6f  SQL.  The size o
272d0 66 20 74 68 65 20 64 61 74 61 62 61 73 65 0a 2a  f the database.*
272e0 2a 20 63 72 65 61 74 65 64 20 62 79 20 61 6e 20  * created by an 
272f0 75 6e 74 72 75 73 74 65 64 20 73 63 72 69 70 74  untrusted script
27300 20 63 61 6e 20 62 65 20 63 6f 6e 74 61 69 6e 65   can be containe
27310 64 20 75 73 69 6e 67 20 74 68 65 0a 2a 2a 20 5b  d using the.** [
27320 6d 61 78 5f 70 61 67 65 5f 63 6f 75 6e 74 5d 20  max_page_count] 
27330 5b 50 52 41 47 4d 41 5d 2e 0a 2a 2a 0a 2a 2a 20  [PRAGMA]..**.** 
27340 4e 65 77 20 72 75 6e 2d 74 69 6d 65 20 6c 69 6d  New run-time lim
27350 69 74 20 63 61 74 65 67 6f 72 69 65 73 20 6d 61  it categories ma
27360 79 20 62 65 20 61 64 64 65 64 20 69 6e 20 66 75  y be added in fu
27370 74 75 72 65 20 72 65 6c 65 61 73 65 73 2e 0a 2a  ture releases..*
27380 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 6c 69  /.int sqlite3_li
27390 6d 69 74 28 73 71 6c 69 74 65 33 2a 2c 20 69 6e  mit(sqlite3*, in
273a0 74 20 69 64 2c 20 69 6e 74 20 6e 65 77 56 61 6c  t id, int newVal
273b0 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
273c0 45 46 3a 20 52 75 6e 2d 54 69 6d 65 20 4c 69 6d  EF: Run-Time Lim
273d0 69 74 20 43 61 74 65 67 6f 72 69 65 73 0a 2a 2a  it Categories.**
273e0 20 4b 45 59 57 4f 52 44 53 3a 20 7b 6c 69 6d 69   KEYWORDS: {limi
273f0 74 20 63 61 74 65 67 6f 72 79 7d 20 7b 2a 6c 69  t category} {*li
27400 6d 69 74 20 63 61 74 65 67 6f 72 69 65 73 7d 0a  mit categories}.
27410 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 63 6f 6e 73  **.** These cons
27420 74 61 6e 74 73 20 64 65 66 69 6e 65 20 76 61 72  tants define var
27430 69 6f 75 73 20 70 65 72 66 6f 72 6d 61 6e 63 65  ious performance
27440 20 6c 69 6d 69 74 73 0a 2a 2a 20 74 68 61 74 20   limits.** that 
27450 63 61 6e 20 62 65 20 6c 6f 77 65 72 65 64 20 61  can be lowered a
27460 74 20 72 75 6e 2d 74 69 6d 65 20 75 73 69 6e 67  t run-time using
27470 20 5b 73 71 6c 69 74 65 33 5f 6c 69 6d 69 74 28   [sqlite3_limit(
27480 29 5d 2e 0a 2a 2a 20 54 68 65 20 73 79 6e 6f 70  )]..** The synop
27490 73 69 73 20 6f 66 20 74 68 65 20 6d 65 61 6e 69  sis of the meani
274a0 6e 67 73 20 6f 66 20 74 68 65 20 76 61 72 69 6f  ngs of the vario
274b0 75 73 20 6c 69 6d 69 74 73 20 69 73 20 73 68 6f  us limits is sho
274c0 77 6e 20 62 65 6c 6f 77 2e 0a 2a 2a 20 41 64 64  wn below..** Add
274d0 69 74 69 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61 74  itional informat
274e0 69 6f 6e 20 69 73 20 61 76 61 69 6c 61 62 6c 65  ion is available
274f0 20 61 74 20 5b 6c 69 6d 69 74 73 20 7c 20 4c 69   at [limits | Li
27500 6d 69 74 73 20 69 6e 20 53 51 4c 69 74 65 5d 2e  mits in SQLite].
27510 0a 2a 2a 0a 2a 2a 20 3c 64 6c 3e 0a 2a 2a 20 5b  .**.** <dl>.** [
27520 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 4c 45  [SQLITE_LIMIT_LE
27530 4e 47 54 48 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c  NGTH]] ^(<dt>SQL
27540 49 54 45 5f 4c 49 4d 49 54 5f 4c 45 4e 47 54 48  ITE_LIMIT_LENGTH
27550 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65  </dt>.** <dd>The
27560 20 6d 61 78 69 6d 75 6d 20 73 69 7a 65 20 6f 66   maximum size of
27570 20 61 6e 79 20 73 74 72 69 6e 67 20 6f 72 20 42   any string or B
27580 4c 4f 42 20 6f 72 20 74 61 62 6c 65 20 72 6f 77  LOB or table row
27590 2c 20 69 6e 20 62 79 74 65 73 2e 3c 64 64 3e 29  , in bytes.<dd>)
275a0 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45  ^.**.** [[SQLITE
275b0 5f 4c 49 4d 49 54 5f 53 51 4c 5f 4c 45 4e 47 54  _LIMIT_SQL_LENGT
275c0 48 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45  H]] ^(<dt>SQLITE
275d0 5f 4c 49 4d 49 54 5f 53 51 4c 5f 4c 45 4e 47 54  _LIMIT_SQL_LENGT
275e0 48 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68  H</dt>.** <dd>Th
275f0 65 20 6d 61 78 69 6d 75 6d 20 6c 65 6e 67 74 68  e maximum length
27600 20 6f 66 20 61 6e 20 53 51 4c 20 73 74 61 74 65   of an SQL state
27610 6d 65 6e 74 2c 20 69 6e 20 62 79 74 65 73 2e 3c  ment, in bytes.<
27620 2f 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53  /dd>)^.**.** [[S
27630 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 43 4f 4c 55  QLITE_LIMIT_COLU
27640 4d 4e 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c 49 54  MN]] ^(<dt>SQLIT
27650 45 5f 4c 49 4d 49 54 5f 43 4f 4c 55 4d 4e 3c 2f  E_LIMIT_COLUMN</
27660 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 6d  dt>.** <dd>The m
27670 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f 66  aximum number of
27680 20 63 6f 6c 75 6d 6e 73 20 69 6e 20 61 20 74 61   columns in a ta
27690 62 6c 65 20 64 65 66 69 6e 69 74 69 6f 6e 20 6f  ble definition o
276a0 72 20 69 6e 20 74 68 65 0a 2a 2a 20 72 65 73 75  r in the.** resu
276b0 6c 74 20 73 65 74 20 6f 66 20 61 20 5b 53 45 4c  lt set of a [SEL
276c0 45 43 54 5d 20 6f 72 20 74 68 65 20 6d 61 78 69  ECT] or the maxi
276d0 6d 75 6d 20 6e 75 6d 62 65 72 20 6f 66 20 63 6f  mum number of co
276e0 6c 75 6d 6e 73 20 69 6e 20 61 6e 20 69 6e 64 65  lumns in an inde
276f0 78 0a 2a 2a 20 6f 72 20 69 6e 20 61 6e 20 4f 52  x.** or in an OR
27700 44 45 52 20 42 59 20 6f 72 20 47 52 4f 55 50 20  DER BY or GROUP 
27710 42 59 20 63 6c 61 75 73 65 2e 3c 2f 64 64 3e 29  BY clause.</dd>)
27720 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45  ^.**.** [[SQLITE
27730 5f 4c 49 4d 49 54 5f 45 58 50 52 5f 44 45 50 54  _LIMIT_EXPR_DEPT
27740 48 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45  H]] ^(<dt>SQLITE
27750 5f 4c 49 4d 49 54 5f 45 58 50 52 5f 44 45 50 54  _LIMIT_EXPR_DEPT
27760 48 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68  H</dt>.** <dd>Th
27770 65 20 6d 61 78 69 6d 75 6d 20 64 65 70 74 68 20  e maximum depth 
27780 6f 66 20 74 68 65 20 70 61 72 73 65 20 74 72 65  of the parse tre
27790 65 20 6f 6e 20 61 6e 79 20 65 78 70 72 65 73 73  e on any express
277a0 69 6f 6e 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 0a 2a  ion.</dd>)^.**.*
277b0 2a 20 5b 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54  * [[SQLITE_LIMIT
277c0 5f 43 4f 4d 50 4f 55 4e 44 5f 53 45 4c 45 43 54  _COMPOUND_SELECT
277d0 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f  ]] ^(<dt>SQLITE_
277e0 4c 49 4d 49 54 5f 43 4f 4d 50 4f 55 4e 44 5f 53  LIMIT_COMPOUND_S
277f0 45 4c 45 43 54 3c 2f 64 74 3e 0a 2a 2a 20 3c 64  ELECT</dt>.** <d
27800 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20 6e 75  d>The maximum nu
27810 6d 62 65 72 20 6f 66 20 74 65 72 6d 73 20 69 6e  mber of terms in
27820 20 61 20 63 6f 6d 70 6f 75 6e 64 20 53 45 4c 45   a compound SELE
27830 43 54 20 73 74 61 74 65 6d 65 6e 74 2e 3c 2f 64  CT statement.</d
27840 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c  d>)^.**.** [[SQL
27850 49 54 45 5f 4c 49 4d 49 54 5f 56 44 42 45 5f 4f  ITE_LIMIT_VDBE_O
27860 50 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45  P]] ^(<dt>SQLITE
27870 5f 4c 49 4d 49 54 5f 56 44 42 45 5f 4f 50 3c 2f  _LIMIT_VDBE_OP</
27880 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 6d  dt>.** <dd>The m
27890 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f 66  aximum number of
278a0 20 69 6e 73 74 72 75 63 74 69 6f 6e 73 20 69 6e   instructions in
278b0 20 61 20 76 69 72 74 75 61 6c 20 6d 61 63 68 69   a virtual machi
278c0 6e 65 20 70 72 6f 67 72 61 6d 0a 2a 2a 20 75 73  ne program.** us
278d0 65 64 20 74 6f 20 69 6d 70 6c 65 6d 65 6e 74 20  ed to implement 
278e0 61 6e 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  an SQL statement
278f0 2e 20 20 54 68 69 73 20 6c 69 6d 69 74 20 69 73  .  This limit is
27900 20 6e 6f 74 20 63 75 72 72 65 6e 74 6c 79 0a 2a   not currently.*
27910 2a 20 65 6e 66 6f 72 63 65 64 2c 20 74 68 6f 75  * enforced, thou
27920 67 68 20 74 68 61 74 20 6d 69 67 68 74 20 62 65  gh that might be
27930 20 61 64 64 65 64 20 69 6e 20 73 6f 6d 65 20 66   added in some f
27940 75 74 75 72 65 20 72 65 6c 65 61 73 65 20 6f 66  uture release of
27950 0a 2a 2a 20 53 51 4c 69 74 65 2e 3c 2f 64 64 3e  .** SQLite.</dd>
27960 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54  )^.**.** [[SQLIT
27970 45 5f 4c 49 4d 49 54 5f 46 55 4e 43 54 49 4f 4e  E_LIMIT_FUNCTION
27980 5f 41 52 47 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c  _ARG]] ^(<dt>SQL
27990 49 54 45 5f 4c 49 4d 49 54 5f 46 55 4e 43 54 49  ITE_LIMIT_FUNCTI
279a0 4f 4e 5f 41 52 47 3c 2f 64 74 3e 0a 2a 2a 20 3c  ON_ARG</dt>.** <
279b0 64 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20 6e  dd>The maximum n
279c0 75 6d 62 65 72 20 6f 66 20 61 72 67 75 6d 65 6e  umber of argumen
279d0 74 73 20 6f 6e 20 61 20 66 75 6e 63 74 69 6f 6e  ts on a function
279e0 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5b  .</dd>)^.**.** [
279f0 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 41 54  [SQLITE_LIMIT_AT
27a00 54 41 43 48 45 44 5d 5d 20 5e 28 3c 64 74 3e 53  TACHED]] ^(<dt>S
27a10 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 41 54 54 41  QLITE_LIMIT_ATTA
27a20 43 48 45 44 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64  CHED</dt>.** <dd
27a30 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20 6e 75 6d  >The maximum num
27a40 62 65 72 20 6f 66 20 5b 41 54 54 41 43 48 20 7c  ber of [ATTACH |
27a50 20 61 74 74 61 63 68 65 64 20 64 61 74 61 62 61   attached databa
27a60 73 65 73 5d 2e 29 5e 3c 2f 64 64 3e 0a 2a 2a 0a  ses].)^</dd>.**.
27a70 2a 2a 20 5b 5b 53 51 4c 49 54 45 5f 4c 49 4d 49  ** [[SQLITE_LIMI
27a80 54 5f 4c 49 4b 45 5f 50 41 54 54 45 52 4e 5f 4c  T_LIKE_PATTERN_L
27a90 45 4e 47 54 48 5d 5d 0a 2a 2a 20 5e 28 3c 64 74  ENGTH]].** ^(<dt
27aa0 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 4c 49  >SQLITE_LIMIT_LI
27ab0 4b 45 5f 50 41 54 54 45 52 4e 5f 4c 45 4e 47 54  KE_PATTERN_LENGT
27ac0 48 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68  H</dt>.** <dd>Th
27ad0 65 20 6d 61 78 69 6d 75 6d 20 6c 65 6e 67 74 68  e maximum length
27ae0 20 6f 66 20 74 68 65 20 70 61 74 74 65 72 6e 20   of the pattern 
27af0 61 72 67 75 6d 65 6e 74 20 74 6f 20 74 68 65 20  argument to the 
27b00 5b 4c 49 4b 45 5d 20 6f 72 0a 2a 2a 20 5b 47 4c  [LIKE] or.** [GL
27b10 4f 42 5d 20 6f 70 65 72 61 74 6f 72 73 2e 3c 2f  OB] operators.</
27b20 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51  dd>)^.**.** [[SQ
27b30 4c 49 54 45 5f 4c 49 4d 49 54 5f 56 41 52 49 41  LITE_LIMIT_VARIA
27b40 42 4c 45 5f 4e 55 4d 42 45 52 5d 5d 0a 2a 2a 20  BLE_NUMBER]].** 
27b50 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d  ^(<dt>SQLITE_LIM
27b60 49 54 5f 56 41 52 49 41 42 4c 45 5f 4e 55 4d 42  IT_VARIABLE_NUMB
27b70 45 52 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54  ER</dt>.** <dd>T
27b80 68 65 20 6d 61 78 69 6d 75 6d 20 69 6e 64 65 78  he maximum index
27b90 20 6e 75 6d 62 65 72 20 6f 66 20 61 6e 79 20 5b   number of any [
27ba0 70 61 72 61 6d 65 74 65 72 5d 20 69 6e 20 61 6e  parameter] in an
27bb0 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2e 29   SQL statement.)
27bc0 5e 0a 2a 2a 0a 2a 2a 20 5b 5b 53 51 4c 49 54 45  ^.**.** [[SQLITE
27bd0 5f 4c 49 4d 49 54 5f 54 52 49 47 47 45 52 5f 44  _LIMIT_TRIGGER_D
27be0 45 50 54 48 5d 5d 20 5e 28 3c 64 74 3e 53 51 4c  EPTH]] ^(<dt>SQL
27bf0 49 54 45 5f 4c 49 4d 49 54 5f 54 52 49 47 47 45  ITE_LIMIT_TRIGGE
27c00 52 5f 44 45 50 54 48 3c 2f 64 74 3e 0a 2a 2a 20  R_DEPTH</dt>.** 
27c10 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20  <dd>The maximum 
27c20 64 65 70 74 68 20 6f 66 20 72 65 63 75 72 73 69  depth of recursi
27c30 6f 6e 20 66 6f 72 20 74 72 69 67 67 65 72 73 2e  on for triggers.
27c40 3c 2f 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5b 5b  </dd>)^.**.** [[
27c50 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 57 4f 52  SQLITE_LIMIT_WOR
27c60 4b 45 52 5f 54 48 52 45 41 44 53 5d 5d 20 5e 28  KER_THREADS]] ^(
27c70 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54  <dt>SQLITE_LIMIT
27c80 5f 57 4f 52 4b 45 52 5f 54 48 52 45 41 44 53 3c  _WORKER_THREADS<
27c90 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20  /dt>.** <dd>The 
27ca0 6d 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f  maximum number o
27cb0 66 20 61 75 78 69 6c 69 61 72 79 20 77 6f 72 6b  f auxiliary work
27cc0 65 72 20 74 68 72 65 61 64 73 20 74 68 61 74 20  er threads that 
27cd0 61 20 73 69 6e 67 6c 65 0a 2a 2a 20 5b 70 72 65  a single.** [pre
27ce0 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d  pared statement]
27cf0 20 6d 61 79 20 73 74 61 72 74 2e 3c 2f 64 64 3e   may start.</dd>
27d00 29 5e 0a 2a 2a 20 3c 2f 64 6c 3e 0a 2a 2f 0a 23  )^.** </dl>.*/.#
27d10 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c 49  define SQLITE_LI
27d20 4d 49 54 5f 4c 45 4e 47 54 48 20 20 20 20 20 20  MIT_LENGTH      
27d30 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30 0a                0.
27d40 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c  #define SQLITE_L
27d50 49 4d 49 54 5f 53 51 4c 5f 4c 45 4e 47 54 48 20  IMIT_SQL_LENGTH 
27d60 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 31                 1
27d70 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
27d80 4c 49 4d 49 54 5f 43 4f 4c 55 4d 4e 20 20 20 20  LIMIT_COLUMN    
27d90 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
27da0 32 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  2.#define SQLITE
27db0 5f 4c 49 4d 49 54 5f 45 58 50 52 5f 44 45 50 54  _LIMIT_EXPR_DEPT
27dc0 48 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  H               
27dd0 20 33 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54   3.#define SQLIT
27de0 45 5f 4c 49 4d 49 54 5f 43 4f 4d 50 4f 55 4e 44  E_LIMIT_COMPOUND
27df0 5f 53 45 4c 45 43 54 20 20 20 20 20 20 20 20 20  _SELECT         
27e00 20 20 34 0a 23 64 65 66 69 6e 65 20 53 51 4c 49    4.#define SQLI
27e10 54 45 5f 4c 49 4d 49 54 5f 56 44 42 45 5f 4f 50  TE_LIMIT_VDBE_OP
27e20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
27e30 20 20 20 35 0a 23 64 65 66 69 6e 65 20 53 51 4c     5.#define SQL
27e40 49 54 45 5f 4c 49 4d 49 54 5f 46 55 4e 43 54 49  ITE_LIMIT_FUNCTI
27e50 4f 4e 5f 41 52 47 20 20 20 20 20 20 20 20 20 20  ON_ARG          
27e60 20 20 20 20 36 0a 23 64 65 66 69 6e 65 20 53 51      6.#define SQ
27e70 4c 49 54 45 5f 4c 49 4d 49 54 5f 41 54 54 41 43  LITE_LIMIT_ATTAC
27e80 48 45 44 20 20 20 20 20 20 20 20 20 20 20 20 20  HED             
27e90 20 20 20 20 20 37 0a 23 64 65 66 69 6e 65 20 53       7.#define S
27ea0 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 4c 49 4b 45  QLITE_LIMIT_LIKE
27eb0 5f 50 41 54 54 45 52 4e 5f 4c 45 4e 47 54 48 20  _PATTERN_LENGTH 
27ec0 20 20 20 20 20 20 38 0a 23 64 65 66 69 6e 65 20        8.#define 
27ed0 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 56 41 52  SQLITE_LIMIT_VAR
27ee0 49 41 42 4c 45 5f 4e 55 4d 42 45 52 20 20 20 20  IABLE_NUMBER    
27ef0 20 20 20 20 20 20 20 39 0a 23 64 65 66 69 6e 65         9.#define
27f00 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 54 52   SQLITE_LIMIT_TR
27f10 49 47 47 45 52 5f 44 45 50 54 48 20 20 20 20 20  IGGER_DEPTH     
27f20 20 20 20 20 20 20 20 31 30 0a 23 64 65 66 69 6e         10.#defin
27f30 65 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 57  e SQLITE_LIMIT_W
27f40 4f 52 4b 45 52 5f 54 48 52 45 41 44 53 20 20 20  ORKER_THREADS   
27f50 20 20 20 20 20 20 20 20 31 31 0a 0a 2f 2a 0a 2a          11../*.*
27f60 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6f 6d 70  * CAPI3REF: Comp
27f70 69 6c 69 6e 67 20 41 6e 20 53 51 4c 20 53 74 61  iling An SQL Sta
27f80 74 65 6d 65 6e 74 0a 2a 2a 20 4b 45 59 57 4f 52  tement.** KEYWOR
27f90 44 53 3a 20 7b 53 51 4c 20 73 74 61 74 65 6d 65  DS: {SQL stateme
27fa0 6e 74 20 63 6f 6d 70 69 6c 65 72 7d 0a 2a 2a 20  nt compiler}.** 
27fb0 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a  METHOD: sqlite3.
27fc0 2a 2a 20 43 4f 4e 53 54 52 55 43 54 4f 52 3a 20  ** CONSTRUCTOR: 
27fd0 73 71 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a  sqlite3_stmt.**.
27fe0 2a 2a 20 54 6f 20 65 78 65 63 75 74 65 20 61 6e  ** To execute an
27ff0 20 53 51 4c 20 71 75 65 72 79 2c 20 69 74 20 6d   SQL query, it m
28000 75 73 74 20 66 69 72 73 74 20 62 65 20 63 6f 6d  ust first be com
28010 70 69 6c 65 64 20 69 6e 74 6f 20 61 20 62 79 74  piled into a byt
28020 65 2d 63 6f 64 65 0a 2a 2a 20 70 72 6f 67 72 61  e-code.** progra
28030 6d 20 75 73 69 6e 67 20 6f 6e 65 20 6f 66 20 74  m using one of t
28040 68 65 73 65 20 72 6f 75 74 69 6e 65 73 2e 0a 2a  hese routines..*
28050 2a 0a 2a 2a 20 54 68 65 20 66 69 72 73 74 20 61  *.** The first a
28060 72 67 75 6d 65 6e 74 2c 20 22 64 62 22 2c 20 69  rgument, "db", i
28070 73 20 61 20 5b 64 61 74 61 62 61 73 65 20 63 6f  s a [database co
28080 6e 6e 65 63 74 69 6f 6e 5d 20 6f 62 74 61 69 6e  nnection] obtain
28090 65 64 20 66 72 6f 6d 20 61 0a 2a 2a 20 70 72 69  ed from a.** pri
280a0 6f 72 20 73 75 63 63 65 73 73 66 75 6c 20 63 61  or successful ca
280b0 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 6f  ll to [sqlite3_o
280c0 70 65 6e 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33  pen()], [sqlite3
280d0 5f 6f 70 65 6e 5f 76 32 28 29 5d 20 6f 72 0a 2a  _open_v2()] or.*
280e0 2a 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31  * [sqlite3_open1
280f0 36 28 29 5d 2e 20 20 54 68 65 20 64 61 74 61 62  6()].  The datab
28100 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 6d  ase connection m
28110 75 73 74 20 6e 6f 74 20 68 61 76 65 20 62 65 65  ust not have bee
28120 6e 20 63 6c 6f 73 65 64 2e 0a 2a 2a 0a 2a 2a 20  n closed..**.** 
28130 54 68 65 20 73 65 63 6f 6e 64 20 61 72 67 75 6d  The second argum
28140 65 6e 74 2c 20 22 7a 53 71 6c 22 2c 20 69 73 20  ent, "zSql", is 
28150 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20 74 6f  the statement to
28160 20 62 65 20 63 6f 6d 70 69 6c 65 64 2c 20 65 6e   be compiled, en
28170 63 6f 64 65 64 0a 2a 2a 20 61 73 20 65 69 74 68  coded.** as eith
28180 65 72 20 55 54 46 2d 38 20 6f 72 20 55 54 46 2d  er UTF-8 or UTF-
28190 31 36 2e 20 20 54 68 65 20 73 71 6c 69 74 65 33  16.  The sqlite3
281a0 5f 70 72 65 70 61 72 65 28 29 20 61 6e 64 20 73  _prepare() and s
281b0 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76  qlite3_prepare_v
281c0 32 28 29 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65  2().** interface
281d0 73 20 75 73 65 20 55 54 46 2d 38 2c 20 61 6e 64  s use UTF-8, and
281e0 20 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65   sqlite3_prepare
281f0 31 36 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33  16() and sqlite3
28200 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28 29 0a  _prepare16_v2().
28210 2a 2a 20 75 73 65 20 55 54 46 2d 31 36 2e 0a 2a  ** use UTF-16..*
28220 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 6e 42 79  *.** ^If the nBy
28230 74 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20 6e  te argument is n
28240 65 67 61 74 69 76 65 2c 20 74 68 65 6e 20 7a 53  egative, then zS
28250 71 6c 20 69 73 20 72 65 61 64 20 75 70 20 74 6f  ql is read up to
28260 20 74 68 65 0a 2a 2a 20 66 69 72 73 74 20 7a 65   the.** first ze
28270 72 6f 20 74 65 72 6d 69 6e 61 74 6f 72 2e 20 5e  ro terminator. ^
28280 49 66 20 6e 42 79 74 65 20 69 73 20 70 6f 73 69  If nByte is posi
28290 74 69 76 65 2c 20 74 68 65 6e 20 69 74 20 69 73  tive, then it is
282a0 20 74 68 65 0a 2a 2a 20 6e 75 6d 62 65 72 20 6f   the.** number o
282b0 66 20 62 79 74 65 73 20 72 65 61 64 20 66 72 6f  f bytes read fro
282c0 6d 20 7a 53 71 6c 2e 20 20 5e 49 66 20 6e 42 79  m zSql.  ^If nBy
282d0 74 65 20 69 73 20 7a 65 72 6f 2c 20 74 68 65 6e  te is zero, then
282e0 20 6e 6f 20 70 72 65 70 61 72 65 64 0a 2a 2a 20   no prepared.** 
282f0 73 74 61 74 65 6d 65 6e 74 20 69 73 20 67 65 6e  statement is gen
28300 65 72 61 74 65 64 2e 0a 2a 2a 20 49 66 20 74 68  erated..** If th
28310 65 20 63 61 6c 6c 65 72 20 6b 6e 6f 77 73 20 74  e caller knows t
28320 68 61 74 20 74 68 65 20 73 75 70 70 6c 69 65 64  hat the supplied
28330 20 73 74 72 69 6e 67 20 69 73 20 6e 75 6c 2d 74   string is nul-t
28340 65 72 6d 69 6e 61 74 65 64 2c 20 74 68 65 6e 0a  erminated, then.
28350 2a 2a 20 74 68 65 72 65 20 69 73 20 61 20 73 6d  ** there is a sm
28360 61 6c 6c 20 70 65 72 66 6f 72 6d 61 6e 63 65 20  all performance 
28370 61 64 76 61 6e 74 61 67 65 20 74 6f 20 70 61 73  advantage to pas
28380 73 69 6e 67 20 61 6e 20 6e 42 79 74 65 20 70 61  sing an nByte pa
28390 72 61 6d 65 74 65 72 20 74 68 61 74 0a 2a 2a 20  rameter that.** 
283a0 69 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  is the number of
283b0 20 62 79 74 65 73 20 69 6e 20 74 68 65 20 69 6e   bytes in the in
283c0 70 75 74 20 73 74 72 69 6e 67 20 3c 69 3e 69 6e  put string <i>in
283d0 63 6c 75 64 69 6e 67 3c 2f 69 3e 0a 2a 2a 20 74  cluding</i>.** t
283e0 68 65 20 6e 75 6c 2d 74 65 72 6d 69 6e 61 74 6f  he nul-terminato
283f0 72 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 70 7a 54  r..**.** ^If pzT
28400 61 69 6c 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 20  ail is not NULL 
28410 74 68 65 6e 20 2a 70 7a 54 61 69 6c 20 69 73 20  then *pzTail is 
28420 6d 61 64 65 20 74 6f 20 70 6f 69 6e 74 20 74 6f  made to point to
28430 20 74 68 65 20 66 69 72 73 74 20 62 79 74 65 0a   the first byte.
28440 2a 2a 20 70 61 73 74 20 74 68 65 20 65 6e 64 20  ** past the end 
28450 6f 66 20 74 68 65 20 66 69 72 73 74 20 53 51 4c  of the first SQL
28460 20 73 74 61 74 65 6d 65 6e 74 20 69 6e 20 7a 53   statement in zS
28470 71 6c 2e 20 20 54 68 65 73 65 20 72 6f 75 74 69  ql.  These routi
28480 6e 65 73 20 6f 6e 6c 79 0a 2a 2a 20 63 6f 6d 70  nes only.** comp
28490 69 6c 65 20 74 68 65 20 66 69 72 73 74 20 73 74  ile the first st
284a0 61 74 65 6d 65 6e 74 20 69 6e 20 7a 53 71 6c 2c  atement in zSql,
284b0 20 73 6f 20 2a 70 7a 54 61 69 6c 20 69 73 20 6c   so *pzTail is l
284c0 65 66 74 20 70 6f 69 6e 74 69 6e 67 20 74 6f 0a  eft pointing to.
284d0 2a 2a 20 77 68 61 74 20 72 65 6d 61 69 6e 73 20  ** what remains 
284e0 75 6e 63 6f 6d 70 69 6c 65 64 2e 0a 2a 2a 0a 2a  uncompiled..**.*
284f0 2a 20 5e 2a 70 70 53 74 6d 74 20 69 73 20 6c 65  * ^*ppStmt is le
28500 66 74 20 70 6f 69 6e 74 69 6e 67 20 74 6f 20 61  ft pointing to a
28510 20 63 6f 6d 70 69 6c 65 64 20 5b 70 72 65 70 61   compiled [prepa
28520 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 74  red statement] t
28530 68 61 74 20 63 61 6e 20 62 65 0a 2a 2a 20 65 78  hat can be.** ex
28540 65 63 75 74 65 64 20 75 73 69 6e 67 20 5b 73 71  ecuted using [sq
28550 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 2e 20 20  lite3_step()].  
28560 5e 49 66 20 74 68 65 72 65 20 69 73 20 61 6e 20  ^If there is an 
28570 65 72 72 6f 72 2c 20 2a 70 70 53 74 6d 74 20 69  error, *ppStmt i
28580 73 20 73 65 74 0a 2a 2a 20 74 6f 20 4e 55 4c 4c  s set.** to NULL
28590 2e 20 20 5e 49 66 20 74 68 65 20 69 6e 70 75 74  .  ^If the input
285a0 20 74 65 78 74 20 63 6f 6e 74 61 69 6e 73 20 6e   text contains n
285b0 6f 20 53 51 4c 20 28 69 66 20 74 68 65 20 69 6e  o SQL (if the in
285c0 70 75 74 20 69 73 20 61 6e 20 65 6d 70 74 79 0a  put is an empty.
285d0 2a 2a 20 73 74 72 69 6e 67 20 6f 72 20 61 20 63  ** string or a c
285e0 6f 6d 6d 65 6e 74 29 20 74 68 65 6e 20 2a 70 70  omment) then *pp
285f0 53 74 6d 74 20 69 73 20 73 65 74 20 74 6f 20 4e  Stmt is set to N
28600 55 4c 4c 2e 0a 2a 2a 20 54 68 65 20 63 61 6c 6c  ULL..** The call
28610 69 6e 67 20 70 72 6f 63 65 64 75 72 65 20 69 73  ing procedure is
28620 20 72 65 73 70 6f 6e 73 69 62 6c 65 20 66 6f 72   responsible for
28630 20 64 65 6c 65 74 69 6e 67 20 74 68 65 20 63 6f   deleting the co
28640 6d 70 69 6c 65 64 0a 2a 2a 20 53 51 4c 20 73 74  mpiled.** SQL st
28650 61 74 65 6d 65 6e 74 20 75 73 69 6e 67 20 5b 73  atement using [s
28660 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28  qlite3_finalize(
28670 29 5d 20 61 66 74 65 72 20 69 74 20 68 61 73 20  )] after it has 
28680 66 69 6e 69 73 68 65 64 20 77 69 74 68 20 69 74  finished with it
28690 2e 0a 2a 2a 20 70 70 53 74 6d 74 20 6d 61 79 20  ..** ppStmt may 
286a0 6e 6f 74 20 62 65 20 4e 55 4c 4c 2e 0a 2a 2a 0a  not be NULL..**.
286b0 2a 2a 20 5e 4f 6e 20 73 75 63 63 65 73 73 2c 20  ** ^On success, 
286c0 74 68 65 20 73 71 6c 69 74 65 33 5f 70 72 65 70  the sqlite3_prep
286d0 61 72 65 28 29 20 66 61 6d 69 6c 79 20 6f 66 20  are() family of 
286e0 72 6f 75 74 69 6e 65 73 20 72 65 74 75 72 6e 20  routines return 
286f0 5b 53 51 4c 49 54 45 5f 4f 4b 5d 3b 0a 2a 2a 20  [SQLITE_OK];.** 
28700 6f 74 68 65 72 77 69 73 65 20 61 6e 20 5b 65 72  otherwise an [er
28710 72 6f 72 20 63 6f 64 65 5d 20 69 73 20 72 65 74  ror code] is ret
28720 75 72 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  urned..**.** The
28730 20 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65   sqlite3_prepare
28740 5f 76 32 28 29 20 61 6e 64 20 73 71 6c 69 74 65  _v2() and sqlite
28750 33 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28 29  3_prepare16_v2()
28760 20 69 6e 74 65 72 66 61 63 65 73 20 61 72 65 0a   interfaces are.
28770 2a 2a 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 66  ** recommended f
28780 6f 72 20 61 6c 6c 20 6e 65 77 20 70 72 6f 67 72  or all new progr
28790 61 6d 73 2e 20 54 68 65 20 74 77 6f 20 6f 6c 64  ams. The two old
287a0 65 72 20 69 6e 74 65 72 66 61 63 65 73 20 61 72  er interfaces ar
287b0 65 20 72 65 74 61 69 6e 65 64 0a 2a 2a 20 66 6f  e retained.** fo
287c0 72 20 62 61 63 6b 77 61 72 64 73 20 63 6f 6d 70  r backwards comp
287d0 61 74 69 62 69 6c 69 74 79 2c 20 62 75 74 20 74  atibility, but t
287e0 68 65 69 72 20 75 73 65 20 69 73 20 64 69 73 63  heir use is disc
287f0 6f 75 72 61 67 65 64 2e 0a 2a 2a 20 5e 49 6e 20  ouraged..** ^In 
28800 74 68 65 20 22 76 32 22 20 69 6e 74 65 72 66 61  the "v2" interfa
28810 63 65 73 2c 20 74 68 65 20 70 72 65 70 61 72 65  ces, the prepare
28820 64 20 73 74 61 74 65 6d 65 6e 74 0a 2a 2a 20 74  d statement.** t
28830 68 61 74 20 69 73 20 72 65 74 75 72 6e 65 64 20  hat is returned 
28840 28 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 74  (the [sqlite3_st
28850 6d 74 5d 20 6f 62 6a 65 63 74 29 20 63 6f 6e 74  mt] object) cont
28860 61 69 6e 73 20 61 20 63 6f 70 79 20 6f 66 20 74  ains a copy of t
28870 68 65 0a 2a 2a 20 6f 72 69 67 69 6e 61 6c 20 53  he.** original S
28880 51 4c 20 74 65 78 74 2e 20 54 68 69 73 20 63 61  QL text. This ca
28890 75 73 65 73 20 74 68 65 20 5b 73 71 6c 69 74 65  uses the [sqlite
288a0 33 5f 73 74 65 70 28 29 5d 20 69 6e 74 65 72 66  3_step()] interf
288b0 61 63 65 20 74 6f 0a 2a 2a 20 62 65 68 61 76 65  ace to.** behave
288c0 20 64 69 66 66 65 72 65 6e 74 6c 79 20 69 6e 20   differently in 
288d0 74 68 72 65 65 20 77 61 79 73 3a 0a 2a 2a 0a 2a  three ways:.**.*
288e0 2a 20 3c 6f 6c 3e 0a 2a 2a 20 3c 6c 69 3e 0a 2a  * <ol>.** <li>.*
288f0 2a 20 5e 49 66 20 74 68 65 20 64 61 74 61 62 61  * ^If the databa
28900 73 65 20 73 63 68 65 6d 61 20 63 68 61 6e 67 65  se schema change
28910 73 2c 20 69 6e 73 74 65 61 64 20 6f 66 20 72 65  s, instead of re
28920 74 75 72 6e 69 6e 67 20 5b 53 51 4c 49 54 45 5f  turning [SQLITE_
28930 53 43 48 45 4d 41 5d 20 61 73 20 69 74 0a 2a 2a  SCHEMA] as it.**
28940 20 61 6c 77 61 79 73 20 75 73 65 64 20 74 6f 20   always used to 
28950 64 6f 2c 20 5b 73 71 6c 69 74 65 33 5f 73 74 65  do, [sqlite3_ste
28960 70 28 29 5d 20 77 69 6c 6c 20 61 75 74 6f 6d 61  p()] will automa
28970 74 69 63 61 6c 6c 79 20 72 65 63 6f 6d 70 69 6c  tically recompil
28980 65 20 74 68 65 20 53 51 4c 0a 2a 2a 20 73 74 61  e the SQL.** sta
28990 74 65 6d 65 6e 74 20 61 6e 64 20 74 72 79 20 74  tement and try t
289a0 6f 20 72 75 6e 20 69 74 20 61 67 61 69 6e 2e 20  o run it again. 
289b0 41 73 20 6d 61 6e 79 20 61 73 20 5b 53 51 4c 49  As many as [SQLI
289c0 54 45 5f 4d 41 58 5f 53 43 48 45 4d 41 5f 52 45  TE_MAX_SCHEMA_RE
289d0 54 52 59 5d 0a 2a 2a 20 72 65 74 72 69 65 73 20  TRY].** retries 
289e0 77 69 6c 6c 20 6f 63 63 75 72 20 62 65 66 6f 72  will occur befor
289f0 65 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29  e sqlite3_step()
28a00 20 67 69 76 65 73 20 75 70 20 61 6e 64 20 72 65   gives up and re
28a10 74 75 72 6e 73 20 61 6e 20 65 72 72 6f 72 2e 0a  turns an error..
28a20 2a 2a 20 3c 2f 6c 69 3e 0a 2a 2a 0a 2a 2a 20 3c  ** </li>.**.** <
28a30 6c 69 3e 0a 2a 2a 20 5e 57 68 65 6e 20 61 6e 20  li>.** ^When an 
28a40 65 72 72 6f 72 20 6f 63 63 75 72 73 2c 20 5b 73  error occurs, [s
28a50 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 77  qlite3_step()] w
28a60 69 6c 6c 20 72 65 74 75 72 6e 20 6f 6e 65 20 6f  ill return one o
28a70 66 20 74 68 65 20 64 65 74 61 69 6c 65 64 0a 2a  f the detailed.*
28a80 2a 20 5b 65 72 72 6f 72 20 63 6f 64 65 73 5d 20  * [error codes] 
28a90 6f 72 20 5b 65 78 74 65 6e 64 65 64 20 65 72 72  or [extended err
28aa0 6f 72 20 63 6f 64 65 73 5d 2e 20 20 5e 54 68 65  or codes].  ^The
28ab0 20 6c 65 67 61 63 79 20 62 65 68 61 76 69 6f 72   legacy behavior
28ac0 20 77 61 73 20 74 68 61 74 0a 2a 2a 20 5b 73 71   was that.** [sq
28ad0 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 77 6f  lite3_step()] wo
28ae0 75 6c 64 20 6f 6e 6c 79 20 72 65 74 75 72 6e 20  uld only return 
28af0 61 20 67 65 6e 65 72 69 63 20 5b 53 51 4c 49 54  a generic [SQLIT
28b00 45 5f 45 52 52 4f 52 5d 20 72 65 73 75 6c 74 20  E_ERROR] result 
28b10 63 6f 64 65 0a 2a 2a 20 61 6e 64 20 74 68 65 20  code.** and the 
28b20 61 70 70 6c 69 63 61 74 69 6f 6e 20 77 6f 75 6c  application woul
28b30 64 20 68 61 76 65 20 74 6f 20 6d 61 6b 65 20 61  d have to make a
28b40 20 73 65 63 6f 6e 64 20 63 61 6c 6c 20 74 6f 20   second call to 
28b50 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29  [sqlite3_reset()
28b60 5d 0a 2a 2a 20 69 6e 20 6f 72 64 65 72 20 74 6f  ].** in order to
28b70 20 66 69 6e 64 20 74 68 65 20 75 6e 64 65 72 6c   find the underl
28b80 79 69 6e 67 20 63 61 75 73 65 20 6f 66 20 74 68  ying cause of th
28b90 65 20 70 72 6f 62 6c 65 6d 2e 20 57 69 74 68 20  e problem. With 
28ba0 74 68 65 20 22 76 32 22 20 70 72 65 70 61 72 65  the "v2" prepare
28bb0 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 73 2c 20  .** interfaces, 
28bc0 74 68 65 20 75 6e 64 65 72 6c 79 69 6e 67 20 72  the underlying r
28bd0 65 61 73 6f 6e 20 66 6f 72 20 74 68 65 20 65 72  eason for the er
28be0 72 6f 72 20 69 73 20 72 65 74 75 72 6e 65 64 20  ror is returned 
28bf0 69 6d 6d 65 64 69 61 74 65 6c 79 2e 0a 2a 2a 20  immediately..** 
28c00 3c 2f 6c 69 3e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e  </li>.**.** <li>
28c10 0a 2a 2a 20 5e 49 66 20 74 68 65 20 73 70 65 63  .** ^If the spec
28c20 69 66 69 63 20 76 61 6c 75 65 20 62 6f 75 6e 64  ific value bound
28c30 20 74 6f 20 5b 70 61 72 61 6d 65 74 65 72 20 7c   to [parameter |
28c40 20 68 6f 73 74 20 70 61 72 61 6d 65 74 65 72 5d   host parameter]
28c50 20 69 6e 20 74 68 65 20 0a 2a 2a 20 57 48 45 52   in the .** WHER
28c60 45 20 63 6c 61 75 73 65 20 6d 69 67 68 74 20 69  E clause might i
28c70 6e 66 6c 75 65 6e 63 65 20 74 68 65 20 63 68 6f  nfluence the cho
28c80 69 63 65 20 6f 66 20 71 75 65 72 79 20 70 6c 61  ice of query pla
28c90 6e 20 66 6f 72 20 61 20 73 74 61 74 65 6d 65 6e  n for a statemen
28ca0 74 2c 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20 73  t,.** then the s
28cb0 74 61 74 65 6d 65 6e 74 20 77 69 6c 6c 20 62 65  tatement will be
28cc0 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 72   automatically r
28cd0 65 63 6f 6d 70 69 6c 65 64 2c 20 61 73 20 69 66  ecompiled, as if
28ce0 20 74 68 65 72 65 20 68 61 64 20 62 65 65 6e 20   there had been 
28cf0 0a 2a 2a 20 61 20 73 63 68 65 6d 61 20 63 68 61  .** a schema cha
28d00 6e 67 65 2c 20 6f 6e 20 74 68 65 20 66 69 72 73  nge, on the firs
28d10 74 20 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70  t  [sqlite3_step
28d20 28 29 5d 20 63 61 6c 6c 20 66 6f 6c 6c 6f 77 69  ()] call followi
28d30 6e 67 20 61 6e 79 20 63 68 61 6e 67 65 0a 2a 2a  ng any change.**
28d40 20 74 6f 20 74 68 65 20 5b 73 71 6c 69 74 65 33   to the [sqlite3
28d50 5f 62 69 6e 64 5f 74 65 78 74 20 7c 20 62 69 6e  _bind_text | bin
28d60 64 69 6e 67 73 5d 20 6f 66 20 74 68 61 74 20 5b  dings] of that [
28d70 70 61 72 61 6d 65 74 65 72 5d 2e 20 0a 2a 2a 20  parameter]. .** 
28d80 5e 54 68 65 20 73 70 65 63 69 66 69 63 20 76 61  ^The specific va
28d90 6c 75 65 20 6f 66 20 57 48 45 52 45 2d 63 6c 61  lue of WHERE-cla
28da0 75 73 65 20 5b 70 61 72 61 6d 65 74 65 72 5d 20  use [parameter] 
28db0 6d 69 67 68 74 20 69 6e 66 6c 75 65 6e 63 65 20  might influence 
28dc0 74 68 65 20 0a 2a 2a 20 63 68 6f 69 63 65 20 6f  the .** choice o
28dd0 66 20 71 75 65 72 79 20 70 6c 61 6e 20 69 66 20  f query plan if 
28de0 74 68 65 20 70 61 72 61 6d 65 74 65 72 20 69 73  the parameter is
28df0 20 74 68 65 20 6c 65 66 74 2d 68 61 6e 64 20 73   the left-hand s
28e00 69 64 65 20 6f 66 20 61 20 5b 4c 49 4b 45 5d 0a  ide of a [LIKE].
28e10 2a 2a 20 6f 72 20 5b 47 4c 4f 42 5d 20 6f 70 65  ** or [GLOB] ope
28e20 72 61 74 6f 72 20 6f 72 20 69 66 20 74 68 65 20  rator or if the 
28e30 70 61 72 61 6d 65 74 65 72 20 69 73 20 63 6f 6d  parameter is com
28e40 70 61 72 65 64 20 74 6f 20 61 6e 20 69 6e 64 65  pared to an inde
28e50 78 65 64 20 63 6f 6c 75 6d 6e 0a 2a 2a 20 61 6e  xed column.** an
28e60 64 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 45 4e  d the [SQLITE_EN
28e70 41 42 4c 45 5f 53 54 41 54 33 5d 20 63 6f 6d 70  ABLE_STAT3] comp
28e80 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20  ile-time option 
28e90 69 73 20 65 6e 61 62 6c 65 64 2e 0a 2a 2a 20 3c  is enabled..** <
28ea0 2f 6c 69 3e 0a 2a 2a 20 3c 2f 6f 6c 3e 0a 2a 2f  /li>.** </ol>.*/
28eb0 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 70 72 65  .int sqlite3_pre
28ec0 70 61 72 65 28 0a 20 20 73 71 6c 69 74 65 33 20  pare(.  sqlite3 
28ed0 2a 64 62 2c 20 20 20 20 20 20 20 20 20 20 20 20  *db,            
28ee0 2f 2a 20 44 61 74 61 62 61 73 65 20 68 61 6e 64  /* Database hand
28ef0 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 63 68  le */.  const ch
28f00 61 72 20 2a 7a 53 71 6c 2c 20 20 20 20 20 20 20  ar *zSql,       
28f10 2f 2a 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  /* SQL statement
28f20 2c 20 55 54 46 2d 38 20 65 6e 63 6f 64 65 64 20  , UTF-8 encoded 
28f30 2a 2f 0a 20 20 69 6e 74 20 6e 42 79 74 65 2c 20  */.  int nByte, 
28f40 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
28f50 4d 61 78 69 6d 75 6d 20 6c 65 6e 67 74 68 20 6f  Maximum length o
28f60 66 20 7a 53 71 6c 20 69 6e 20 62 79 74 65 73 2e  f zSql in bytes.
28f70 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33 5f 73 74   */.  sqlite3_st
28f80 6d 74 20 2a 2a 70 70 53 74 6d 74 2c 20 20 2f 2a  mt **ppStmt,  /*
28f90 20 4f 55 54 3a 20 53 74 61 74 65 6d 65 6e 74 20   OUT: Statement 
28fa0 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73  handle */.  cons
28fb0 74 20 63 68 61 72 20 2a 2a 70 7a 54 61 69 6c 20  t char **pzTail 
28fc0 20 20 20 20 2f 2a 20 4f 55 54 3a 20 50 6f 69 6e      /* OUT: Poin
28fd0 74 65 72 20 74 6f 20 75 6e 75 73 65 64 20 70 6f  ter to unused po
28fe0 72 74 69 6f 6e 20 6f 66 20 7a 53 71 6c 20 2a 2f  rtion of zSql */
28ff0 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .);.int sqlite3_
29000 70 72 65 70 61 72 65 5f 76 32 28 0a 20 20 73 71  prepare_v2(.  sq
29010 6c 69 74 65 33 20 2a 64 62 2c 20 20 20 20 20 20  lite3 *db,      
29020 20 20 20 20 20 20 2f 2a 20 44 61 74 61 62 61 73        /* Databas
29030 65 20 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 63 6f  e handle */.  co
29040 6e 73 74 20 63 68 61 72 20 2a 7a 53 71 6c 2c 20  nst char *zSql, 
29050 20 20 20 20 20 20 2f 2a 20 53 51 4c 20 73 74 61        /* SQL sta
29060 74 65 6d 65 6e 74 2c 20 55 54 46 2d 38 20 65 6e  tement, UTF-8 en
29070 63 6f 64 65 64 20 2a 2f 0a 20 20 69 6e 74 20 6e  coded */.  int n
29080 42 79 74 65 2c 20 20 20 20 20 20 20 20 20 20 20  Byte,           
29090 20 20 20 2f 2a 20 4d 61 78 69 6d 75 6d 20 6c 65     /* Maximum le
290a0 6e 67 74 68 20 6f 66 20 7a 53 71 6c 20 69 6e 20  ngth of zSql in 
290b0 62 79 74 65 73 2e 20 2a 2f 0a 20 20 73 71 6c 69  bytes. */.  sqli
290c0 74 65 33 5f 73 74 6d 74 20 2a 2a 70 70 53 74 6d  te3_stmt **ppStm
290d0 74 2c 20 20 2f 2a 20 4f 55 54 3a 20 53 74 61 74  t,  /* OUT: Stat
290e0 65 6d 65 6e 74 20 68 61 6e 64 6c 65 20 2a 2f 0a  ement handle */.
290f0 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 2a 70    const char **p
29100 7a 54 61 69 6c 20 20 20 20 20 2f 2a 20 4f 55 54  zTail     /* OUT
29110 3a 20 50 6f 69 6e 74 65 72 20 74 6f 20 75 6e 75  : Pointer to unu
29120 73 65 64 20 70 6f 72 74 69 6f 6e 20 6f 66 20 7a  sed portion of z
29130 53 71 6c 20 2a 2f 0a 29 3b 0a 69 6e 74 20 73 71  Sql */.);.int sq
29140 6c 69 74 65 33 5f 70 72 65 70 61 72 65 31 36 28  lite3_prepare16(
29150 0a 20 20 73 71 6c 69 74 65 33 20 2a 64 62 2c 20  .  sqlite3 *db, 
29160 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 44 61             /* Da
29170 74 61 62 61 73 65 20 68 61 6e 64 6c 65 20 2a 2f  tabase handle */
29180 0a 20 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a 7a  .  const void *z
29190 53 71 6c 2c 20 20 20 20 20 20 20 2f 2a 20 53 51  Sql,       /* SQ
291a0 4c 20 73 74 61 74 65 6d 65 6e 74 2c 20 55 54 46  L statement, UTF
291b0 2d 31 36 20 65 6e 63 6f 64 65 64 20 2a 2f 0a 20  -16 encoded */. 
291c0 20 69 6e 74 20 6e 42 79 74 65 2c 20 20 20 20 20   int nByte,     
291d0 20 20 20 20 20 20 20 20 20 2f 2a 20 4d 61 78 69           /* Maxi
291e0 6d 75 6d 20 6c 65 6e 67 74 68 20 6f 66 20 7a 53  mum length of zS
291f0 71 6c 20 69 6e 20 62 79 74 65 73 2e 20 2a 2f 0a  ql in bytes. */.
29200 20 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 20 2a    sqlite3_stmt *
29210 2a 70 70 53 74 6d 74 2c 20 20 2f 2a 20 4f 55 54  *ppStmt,  /* OUT
29220 3a 20 53 74 61 74 65 6d 65 6e 74 20 68 61 6e 64  : Statement hand
29230 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 76 6f  le */.  const vo
29240 69 64 20 2a 2a 70 7a 54 61 69 6c 20 20 20 20 20  id **pzTail     
29250 2f 2a 20 4f 55 54 3a 20 50 6f 69 6e 74 65 72 20  /* OUT: Pointer 
29260 74 6f 20 75 6e 75 73 65 64 20 70 6f 72 74 69 6f  to unused portio
29270 6e 20 6f 66 20 7a 53 71 6c 20 2a 2f 0a 29 3b 0a  n of zSql */.);.
29280 69 6e 74 20 73 71 6c 69 74 65 33 5f 70 72 65 70  int sqlite3_prep
29290 61 72 65 31 36 5f 76 32 28 0a 20 20 73 71 6c 69  are16_v2(.  sqli
292a0 74 65 33 20 2a 64 62 2c 20 20 20 20 20 20 20 20  te3 *db,        
292b0 20 20 20 20 2f 2a 20 44 61 74 61 62 61 73 65 20      /* Database 
292c0 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73  handle */.  cons
292d0 74 20 76 6f 69 64 20 2a 7a 53 71 6c 2c 20 20 20  t void *zSql,   
292e0 20 20 20 20 2f 2a 20 53 51 4c 20 73 74 61 74 65      /* SQL state
292f0 6d 65 6e 74 2c 20 55 54 46 2d 31 36 20 65 6e 63  ment, UTF-16 enc
29300 6f 64 65 64 20 2a 2f 0a 20 20 69 6e 74 20 6e 42  oded */.  int nB
29310 79 74 65 2c 20 20 20 20 20 20 20 20 20 20 20 20  yte,            
29320 20 20 2f 2a 20 4d 61 78 69 6d 75 6d 20 6c 65 6e    /* Maximum len
29330 67 74 68 20 6f 66 20 7a 53 71 6c 20 69 6e 20 62  gth of zSql in b
29340 79 74 65 73 2e 20 2a 2f 0a 20 20 73 71 6c 69 74  ytes. */.  sqlit
29350 65 33 5f 73 74 6d 74 20 2a 2a 70 70 53 74 6d 74  e3_stmt **ppStmt
29360 2c 20 20 2f 2a 20 4f 55 54 3a 20 53 74 61 74 65  ,  /* OUT: State
29370 6d 65 6e 74 20 68 61 6e 64 6c 65 20 2a 2f 0a 20  ment handle */. 
29380 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a 2a 70 7a   const void **pz
29390 54 61 69 6c 20 20 20 20 20 2f 2a 20 4f 55 54 3a  Tail     /* OUT:
293a0 20 50 6f 69 6e 74 65 72 20 74 6f 20 75 6e 75 73   Pointer to unus
293b0 65 64 20 70 6f 72 74 69 6f 6e 20 6f 66 20 7a 53  ed portion of zS
293c0 71 6c 20 2a 2f 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20  ql */.);../*.** 
293d0 43 41 50 49 33 52 45 46 3a 20 52 65 74 72 69 65  CAPI3REF: Retrie
293e0 76 69 6e 67 20 53 74 61 74 65 6d 65 6e 74 20 53  ving Statement S
293f0 51 4c 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71  QL.** METHOD: sq
29400 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a  lite3_stmt.**.**
29410 20 5e 54 68 69 73 20 69 6e 74 65 72 66 61 63 65   ^This interface
29420 20 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20   can be used to 
29430 72 65 74 72 69 65 76 65 20 61 20 73 61 76 65 64  retrieve a saved
29440 20 63 6f 70 79 20 6f 66 20 74 68 65 20 6f 72 69   copy of the ori
29450 67 69 6e 61 6c 0a 2a 2a 20 53 51 4c 20 74 65 78  ginal.** SQL tex
29460 74 20 75 73 65 64 20 74 6f 20 63 72 65 61 74 65  t used to create
29470 20 61 20 5b 70 72 65 70 61 72 65 64 20 73 74 61   a [prepared sta
29480 74 65 6d 65 6e 74 5d 20 69 66 20 74 68 61 74 20  tement] if that 
29490 73 74 61 74 65 6d 65 6e 74 20 77 61 73 0a 2a 2a  statement was.**
294a0 20 63 6f 6d 70 69 6c 65 64 20 75 73 69 6e 67 20   compiled using 
294b0 65 69 74 68 65 72 20 5b 73 71 6c 69 74 65 33 5f  either [sqlite3_
294c0 70 72 65 70 61 72 65 5f 76 32 28 29 5d 20 6f 72  prepare_v2()] or
294d0 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72   [sqlite3_prepar
294e0 65 31 36 5f 76 32 28 29 5d 2e 0a 2a 2f 0a 63 6f  e16_v2()]..*/.co
294f0 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65  nst char *sqlite
29500 33 5f 73 71 6c 28 73 71 6c 69 74 65 33 5f 73 74  3_sql(sqlite3_st
29510 6d 74 20 2a 70 53 74 6d 74 29 3b 0a 0a 2f 2a 0a  mt *pStmt);../*.
29520 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 44 65 74  ** CAPI3REF: Det
29530 65 72 6d 69 6e 65 20 49 66 20 41 6e 20 53 51 4c  ermine If An SQL
29540 20 53 74 61 74 65 6d 65 6e 74 20 57 72 69 74 65   Statement Write
29550 73 20 54 68 65 20 44 61 74 61 62 61 73 65 0a 2a  s The Database.*
29560 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65  * METHOD: sqlite
29570 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54 68  3_stmt.**.** ^Th
29580 65 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 5f 72  e sqlite3_stmt_r
29590 65 61 64 6f 6e 6c 79 28 58 29 20 69 6e 74 65 72  eadonly(X) inter
295a0 66 61 63 65 20 72 65 74 75 72 6e 73 20 74 72 75  face returns tru
295b0 65 20 28 6e 6f 6e 2d 7a 65 72 6f 29 20 69 66 0a  e (non-zero) if.
295c0 2a 2a 20 61 6e 64 20 6f 6e 6c 79 20 69 66 20 74  ** and only if t
295d0 68 65 20 5b 70 72 65 70 61 72 65 64 20 73 74 61  he [prepared sta
295e0 74 65 6d 65 6e 74 5d 20 58 20 6d 61 6b 65 73 20  tement] X makes 
295f0 6e 6f 20 64 69 72 65 63 74 20 63 68 61 6e 67 65  no direct change
29600 73 20 74 6f 0a 2a 2a 20 74 68 65 20 63 6f 6e 74  s to.** the cont
29610 65 6e 74 20 6f 66 20 74 68 65 20 64 61 74 61 62  ent of the datab
29620 61 73 65 20 66 69 6c 65 2e 0a 2a 2a 0a 2a 2a 20  ase file..**.** 
29630 4e 6f 74 65 20 74 68 61 74 20 5b 61 70 70 6c 69  Note that [appli
29640 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53  cation-defined S
29650 51 4c 20 66 75 6e 63 74 69 6f 6e 73 5d 20 6f 72  QL functions] or
29660 0a 2a 2a 20 5b 76 69 72 74 75 61 6c 20 74 61 62  .** [virtual tab
29670 6c 65 73 5d 20 6d 69 67 68 74 20 63 68 61 6e 67  les] might chang
29680 65 20 74 68 65 20 64 61 74 61 62 61 73 65 20 69  e the database i
29690 6e 64 69 72 65 63 74 6c 79 20 61 73 20 61 20 73  ndirectly as a s
296a0 69 64 65 20 65 66 66 65 63 74 2e 20 20 0a 2a 2a  ide effect.  .**
296b0 20 5e 28 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20   ^(For example, 
296c0 69 66 20 61 6e 20 61 70 70 6c 69 63 61 74 69 6f  if an applicatio
296d0 6e 20 64 65 66 69 6e 65 73 20 61 20 66 75 6e 63  n defines a func
296e0 74 69 6f 6e 20 22 65 76 61 6c 28 29 22 20 74 68  tion "eval()" th
296f0 61 74 20 0a 2a 2a 20 63 61 6c 6c 73 20 5b 73 71  at .** calls [sq
29700 6c 69 74 65 33 5f 65 78 65 63 28 29 5d 2c 20 74  lite3_exec()], t
29710 68 65 6e 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e  hen the followin
29720 67 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20  g SQL statement 
29730 77 6f 75 6c 64 0a 2a 2a 20 63 68 61 6e 67 65 20  would.** change 
29740 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c  the database fil
29750 65 20 74 68 72 6f 75 67 68 20 73 69 64 65 2d 65  e through side-e
29760 66 66 65 63 74 73 3a 0a 2a 2a 0a 2a 2a 20 3c 62  ffects:.**.** <b
29770 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a  lockquote><pre>.
29780 2a 2a 20 20 20 20 53 45 4c 45 43 54 20 65 76 61  **    SELECT eva
29790 6c 28 27 44 45 4c 45 54 45 20 46 52 4f 4d 20 74  l('DELETE FROM t
297a0 31 27 29 20 46 52 4f 4d 20 74 32 3b 0a 2a 2a 20  1') FROM t2;.** 
297b0 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f  </pre></blockquo
297c0 74 65 3e 0a 2a 2a 0a 2a 2a 20 42 75 74 20 62 65  te>.**.** But be
297d0 63 61 75 73 65 20 74 68 65 20 5b 53 45 4c 45 43  cause the [SELEC
297e0 54 5d 20 73 74 61 74 65 6d 65 6e 74 20 64 6f 65  T] statement doe
297f0 73 20 6e 6f 74 20 63 68 61 6e 67 65 20 74 68 65  s not change the
29800 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 0a 2a   database file.*
29810 2a 20 64 69 72 65 63 74 6c 79 2c 20 73 71 6c 69  * directly, sqli
29820 74 65 33 5f 73 74 6d 74 5f 72 65 61 64 6f 6e 6c  te3_stmt_readonl
29830 79 28 29 20 77 6f 75 6c 64 20 73 74 69 6c 6c 20  y() would still 
29840 72 65 74 75 72 6e 20 74 72 75 65 2e 29 5e 0a 2a  return true.)^.*
29850 2a 0a 2a 2a 20 5e 54 72 61 6e 73 61 63 74 69 6f  *.** ^Transactio
29860 6e 20 63 6f 6e 74 72 6f 6c 20 73 74 61 74 65 6d  n control statem
29870 65 6e 74 73 20 73 75 63 68 20 61 73 20 5b 42 45  ents such as [BE
29880 47 49 4e 5d 2c 20 5b 43 4f 4d 4d 49 54 5d 2c 20  GIN], [COMMIT], 
29890 5b 52 4f 4c 4c 42 41 43 4b 5d 2c 0a 2a 2a 20 5b  [ROLLBACK],.** [
298a0 53 41 56 45 50 4f 49 4e 54 5d 2c 20 61 6e 64 20  SAVEPOINT], and 
298b0 5b 52 45 4c 45 41 53 45 5d 20 63 61 75 73 65 20  [RELEASE] cause 
298c0 73 71 6c 69 74 65 33 5f 73 74 6d 74 5f 72 65 61  sqlite3_stmt_rea
298d0 64 6f 6e 6c 79 28 29 20 74 6f 20 72 65 74 75 72  donly() to retur
298e0 6e 20 74 72 75 65 2c 0a 2a 2a 20 73 69 6e 63 65  n true,.** since
298f0 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74 73 20   the statements 
29900 74 68 65 6d 73 65 6c 76 65 73 20 64 6f 20 6e 6f  themselves do no
29910 74 20 61 63 74 75 61 6c 6c 79 20 6d 6f 64 69 66  t actually modif
29920 79 20 74 68 65 20 64 61 74 61 62 61 73 65 20 62  y the database b
29930 75 74 0a 2a 2a 20 72 61 74 68 65 72 20 74 68 65  ut.** rather the
29940 79 20 63 6f 6e 74 72 6f 6c 20 74 68 65 20 74 69  y control the ti
29950 6d 69 6e 67 20 6f 66 20 77 68 65 6e 20 6f 74 68  ming of when oth
29960 65 72 20 73 74 61 74 65 6d 65 6e 74 73 20 6d 6f  er statements mo
29970 64 69 66 79 20 74 68 65 20 0a 2a 2a 20 64 61 74  dify the .** dat
29980 61 62 61 73 65 2e 20 20 5e 54 68 65 20 5b 41 54  abase.  ^The [AT
29990 54 41 43 48 5d 20 61 6e 64 20 5b 44 45 54 41 43  TACH] and [DETAC
299a0 48 5d 20 73 74 61 74 65 6d 65 6e 74 73 20 61 6c  H] statements al
299b0 73 6f 20 63 61 75 73 65 0a 2a 2a 20 73 71 6c 69  so cause.** sqli
299c0 74 65 33 5f 73 74 6d 74 5f 72 65 61 64 6f 6e 6c  te3_stmt_readonl
299d0 79 28 29 20 74 6f 20 72 65 74 75 72 6e 20 74 72  y() to return tr
299e0 75 65 20 73 69 6e 63 65 2c 20 77 68 69 6c 65 20  ue since, while 
299f0 74 68 6f 73 65 20 73 74 61 74 65 6d 65 6e 74 73  those statements
29a00 0a 2a 2a 20 63 68 61 6e 67 65 20 74 68 65 20 63  .** change the c
29a10 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f 66 20  onfiguration of 
29a20 61 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65  a database conne
29a30 63 74 69 6f 6e 2c 20 74 68 65 79 20 64 6f 20 6e  ction, they do n
29a40 6f 74 20 6d 61 6b 65 20 0a 2a 2a 20 63 68 61 6e  ot make .** chan
29a50 67 65 73 20 74 6f 20 74 68 65 20 63 6f 6e 74 65  ges to the conte
29a60 6e 74 20 6f 66 20 74 68 65 20 64 61 74 61 62 61  nt of the databa
29a70 73 65 20 66 69 6c 65 73 20 6f 6e 20 64 69 73 6b  se files on disk
29a80 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  ..*/.int sqlite3
29a90 5f 73 74 6d 74 5f 72 65 61 64 6f 6e 6c 79 28 73  _stmt_readonly(s
29aa0 71 6c 69 74 65 33 5f 73 74 6d 74 20 2a 70 53 74  qlite3_stmt *pSt
29ab0 6d 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  mt);../*.** CAPI
29ac0 33 52 45 46 3a 20 44 65 74 65 72 6d 69 6e 65 20  3REF: Determine 
29ad0 49 66 20 41 20 50 72 65 70 61 72 65 64 20 53 74  If A Prepared St
29ae0 61 74 65 6d 65 6e 74 20 48 61 73 20 42 65 65 6e  atement Has Been
29af0 20 52 65 73 65 74 0a 2a 2a 20 4d 45 54 48 4f 44   Reset.** METHOD
29b00 3a 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 0a 2a  : sqlite3_stmt.*
29b10 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65  *.** ^The sqlite
29b20 33 5f 73 74 6d 74 5f 62 75 73 79 28 53 29 20 69  3_stmt_busy(S) i
29b30 6e 74 65 72 66 61 63 65 20 72 65 74 75 72 6e 73  nterface returns
29b40 20 74 72 75 65 20 28 6e 6f 6e 2d 7a 65 72 6f 29   true (non-zero)
29b50 20 69 66 20 74 68 65 0a 2a 2a 20 5b 70 72 65 70   if the.** [prep
29b60 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20  ared statement] 
29b70 53 20 68 61 73 20 62 65 65 6e 20 73 74 65 70 70  S has been stepp
29b80 65 64 20 61 74 20 6c 65 61 73 74 20 6f 6e 63 65  ed at least once
29b90 20 75 73 69 6e 67 20 0a 2a 2a 20 5b 73 71 6c 69   using .** [sqli
29ba0 74 65 33 5f 73 74 65 70 28 53 29 5d 20 62 75 74  te3_step(S)] but
29bb0 20 68 61 73 20 6e 65 69 74 68 65 72 20 72 75 6e   has neither run
29bc0 20 74 6f 20 63 6f 6d 70 6c 65 74 69 6f 6e 20 28   to completion (
29bd0 72 65 74 75 72 6e 65 64 0a 2a 2a 20 5b 53 51 4c  returned.** [SQL
29be0 49 54 45 5f 44 4f 4e 45 5d 20 66 72 6f 6d 20 5b  ITE_DONE] from [
29bf0 73 71 6c 69 74 65 33 5f 73 74 65 70 28 53 29 5d  sqlite3_step(S)]
29c00 29 20 6e 6f 72 0a 2a 2a 20 62 65 65 6e 20 72 65  ) nor.** been re
29c10 73 65 74 20 75 73 69 6e 67 20 5b 73 71 6c 69 74  set using [sqlit
29c20 65 33 5f 72 65 73 65 74 28 53 29 5d 2e 20 20 5e  e3_reset(S)].  ^
29c30 54 68 65 20 73 71 6c 69 74 65 33 5f 73 74 6d 74  The sqlite3_stmt
29c40 5f 62 75 73 79 28 53 29 0a 2a 2a 20 69 6e 74 65  _busy(S).** inte
29c50 72 66 61 63 65 20 72 65 74 75 72 6e 73 20 66 61  rface returns fa
29c60 6c 73 65 20 69 66 20 53 20 69 73 20 61 20 4e 55  lse if S is a NU
29c70 4c 4c 20 70 6f 69 6e 74 65 72 2e 20 20 49 66 20  LL pointer.  If 
29c80 53 20 69 73 20 6e 6f 74 20 61 20 0a 2a 2a 20 4e  S is not a .** N
29c90 55 4c 4c 20 70 6f 69 6e 74 65 72 20 61 6e 64 20  ULL pointer and 
29ca0 69 73 20 6e 6f 74 20 61 20 70 6f 69 6e 74 65 72  is not a pointer
29cb0 20 74 6f 20 61 20 76 61 6c 69 64 20 5b 70 72 65   to a valid [pre
29cc0 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d  pared statement]
29cd0 0a 2a 2a 20 6f 62 6a 65 63 74 2c 20 74 68 65 6e  .** object, then
29ce0 20 74 68 65 20 62 65 68 61 76 69 6f 72 20 69 73   the behavior is
29cf0 20 75 6e 64 65 66 69 6e 65 64 20 61 6e 64 20 70   undefined and p
29d00 72 6f 62 61 62 6c 79 20 75 6e 64 65 73 69 72 61  robably undesira
29d10 62 6c 65 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20  ble..**.** This 
29d20 69 6e 74 65 72 66 61 63 65 20 63 61 6e 20 62 65  interface can be
29d30 20 75 73 65 64 20 69 6e 20 63 6f 6d 62 69 6e 61   used in combina
29d40 74 69 6f 6e 20 5b 73 71 6c 69 74 65 33 5f 6e 65  tion [sqlite3_ne
29d50 78 74 5f 73 74 6d 74 28 29 5d 0a 2a 2a 20 74 6f  xt_stmt()].** to
29d60 20 6c 6f 63 61 74 65 20 61 6c 6c 20 70 72 65 70   locate all prep
29d70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 73 20  ared statements 
29d80 61 73 73 6f 63 69 61 74 65 64 20 77 69 74 68 20  associated with 
29d90 61 20 64 61 74 61 62 61 73 65 20 0a 2a 2a 20 63  a database .** c
29da0 6f 6e 6e 65 63 74 69 6f 6e 20 74 68 61 74 20 61  onnection that a
29db0 72 65 20 69 6e 20 6e 65 65 64 20 6f 66 20 62 65  re in need of be
29dc0 69 6e 67 20 72 65 73 65 74 2e 20 20 54 68 69 73  ing reset.  This
29dd0 20 63 61 6e 20 62 65 20 75 73 65 64 2c 0a 2a 2a   can be used,.**
29de0 20 66 6f 72 20 65 78 61 6d 70 6c 65 2c 20 69 6e   for example, in
29df0 20 64 69 61 67 6e 6f 73 74 69 63 20 72 6f 75 74   diagnostic rout
29e00 69 6e 65 73 20 74 6f 20 73 65 61 72 63 68 20 66  ines to search f
29e10 6f 72 20 70 72 65 70 61 72 65 64 20 0a 2a 2a 20  or prepared .** 
29e20 73 74 61 74 65 6d 65 6e 74 73 20 74 68 61 74 20  statements that 
29e30 61 72 65 20 68 6f 6c 64 69 6e 67 20 61 20 74 72  are holding a tr
29e40 61 6e 73 61 63 74 69 6f 6e 20 6f 70 65 6e 2e 0a  ansaction open..
29e50 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 73  */.int sqlite3_s
29e60 74 6d 74 5f 62 75 73 79 28 73 71 6c 69 74 65 33  tmt_busy(sqlite3
29e70 5f 73 74 6d 74 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20  _stmt*);../*.** 
29e80 43 41 50 49 33 52 45 46 3a 20 44 79 6e 61 6d 69  CAPI3REF: Dynami
29e90 63 61 6c 6c 79 20 54 79 70 65 64 20 56 61 6c 75  cally Typed Valu
29ea0 65 20 4f 62 6a 65 63 74 0a 2a 2a 20 4b 45 59 57  e Object.** KEYW
29eb0 4f 52 44 53 3a 20 7b 70 72 6f 74 65 63 74 65 64  ORDS: {protected
29ec0 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 7d 20   sqlite3_value} 
29ed0 7b 75 6e 70 72 6f 74 65 63 74 65 64 20 73 71 6c  {unprotected sql
29ee0 69 74 65 33 5f 76 61 6c 75 65 7d 0a 2a 2a 0a 2a  ite3_value}.**.*
29ef0 2a 20 53 51 4c 69 74 65 20 75 73 65 73 20 74 68  * SQLite uses th
29f00 65 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20  e sqlite3_value 
29f10 6f 62 6a 65 63 74 20 74 6f 20 72 65 70 72 65 73  object to repres
29f20 65 6e 74 20 61 6c 6c 20 76 61 6c 75 65 73 0a 2a  ent all values.*
29f30 2a 20 74 68 61 74 20 63 61 6e 20 62 65 20 73 74  * that can be st
29f40 6f 72 65 64 20 69 6e 20 61 20 64 61 74 61 62 61  ored in a databa
29f50 73 65 20 74 61 62 6c 65 2e 20 53 51 4c 69 74 65  se table. SQLite
29f60 20 75 73 65 73 20 64 79 6e 61 6d 69 63 20 74 79   uses dynamic ty
29f70 70 69 6e 67 0a 2a 2a 20 66 6f 72 20 74 68 65 20  ping.** for the 
29f80 76 61 6c 75 65 73 20 69 74 20 73 74 6f 72 65 73  values it stores
29f90 2e 20 20 5e 56 61 6c 75 65 73 20 73 74 6f 72 65  .  ^Values store
29fa0 64 20 69 6e 20 73 71 6c 69 74 65 33 5f 76 61 6c  d in sqlite3_val
29fb0 75 65 20 6f 62 6a 65 63 74 73 0a 2a 2a 20 63 61  ue objects.** ca
29fc0 6e 20 62 65 20 69 6e 74 65 67 65 72 73 2c 20 66  n be integers, f
29fd0 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 20 76 61  loating point va
29fe0 6c 75 65 73 2c 20 73 74 72 69 6e 67 73 2c 20 42  lues, strings, B
29ff0 4c 4f 42 73 2c 20 6f 72 20 4e 55 4c 4c 2e 0a 2a  LOBs, or NULL..*
2a000 2a 0a 2a 2a 20 41 6e 20 73 71 6c 69 74 65 33 5f  *.** An sqlite3_
2a010 76 61 6c 75 65 20 6f 62 6a 65 63 74 20 6d 61 79  value object may
2a020 20 62 65 20 65 69 74 68 65 72 20 22 70 72 6f 74   be either "prot
2a030 65 63 74 65 64 22 20 6f 72 20 22 75 6e 70 72 6f  ected" or "unpro
2a040 74 65 63 74 65 64 22 2e 0a 2a 2a 20 53 6f 6d 65  tected"..** Some
2a050 20 69 6e 74 65 72 66 61 63 65 73 20 72 65 71 75   interfaces requ
2a060 69 72 65 20 61 20 70 72 6f 74 65 63 74 65 64 20  ire a protected 
2a070 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2e 20 20  sqlite3_value.  
2a080 4f 74 68 65 72 20 69 6e 74 65 72 66 61 63 65 73  Other interfaces
2a090 0a 2a 2a 20 77 69 6c 6c 20 61 63 63 65 70 74 20  .** will accept 
2a0a0 65 69 74 68 65 72 20 61 20 70 72 6f 74 65 63 74  either a protect
2a0b0 65 64 20 6f 72 20 61 6e 20 75 6e 70 72 6f 74 65  ed or an unprote
2a0c0 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c  cted sqlite3_val
2a0d0 75 65 2e 0a 2a 2a 20 45 76 65 72 79 20 69 6e 74  ue..** Every int
2a0e0 65 72 66 61 63 65 20 74 68 61 74 20 61 63 63 65  erface that acce
2a0f0 70 74 73 20 73 71 6c 69 74 65 33 5f 76 61 6c 75  pts sqlite3_valu
2a100 65 20 61 72 67 75 6d 65 6e 74 73 20 73 70 65 63  e arguments spec
2a110 69 66 69 65 73 0a 2a 2a 20 77 68 65 74 68 65 72  ifies.** whether
2a120 20 6f 72 20 6e 6f 74 20 69 74 20 72 65 71 75 69   or not it requi
2a130 72 65 73 20 61 20 70 72 6f 74 65 63 74 65 64 20  res a protected 
2a140 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2e 20 20  sqlite3_value.  
2a150 54 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  The.** [sqlite3_
2a160 76 61 6c 75 65 5f 64 75 70 28 29 5d 20 69 6e 74  value_dup()] int
2a170 65 72 66 61 63 65 20 63 61 6e 20 62 65 20 75 73  erface can be us
2a180 65 64 20 74 6f 20 63 6f 6e 73 74 72 75 63 74 20  ed to construct 
2a190 61 20 6e 65 77 20 0a 2a 2a 20 70 72 6f 74 65 63  a new .** protec
2a1a0 74 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75  ted sqlite3_valu
2a1b0 65 20 66 72 6f 6d 20 61 6e 20 75 6e 70 72 6f 74  e from an unprot
2a1c0 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76 61  ected sqlite3_va
2a1d0 6c 75 65 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 74  lue..**.** The t
2a1e0 65 72 6d 73 20 22 70 72 6f 74 65 63 74 65 64 22  erms "protected"
2a1f0 20 61 6e 64 20 22 75 6e 70 72 6f 74 65 63 74 65   and "unprotecte
2a200 64 22 20 72 65 66 65 72 20 74 6f 20 77 68 65 74  d" refer to whet
2a210 68 65 72 20 6f 72 20 6e 6f 74 0a 2a 2a 20 61 20  her or not.** a 
2a220 6d 75 74 65 78 20 69 73 20 68 65 6c 64 2e 20 20  mutex is held.  
2a230 41 6e 20 69 6e 74 65 72 6e 61 6c 20 6d 75 74 65  An internal mute
2a240 78 20 69 73 20 68 65 6c 64 20 66 6f 72 20 61 20  x is held for a 
2a250 70 72 6f 74 65 63 74 65 64 0a 2a 2a 20 73 71 6c  protected.** sql
2a260 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65 63  ite3_value objec
2a270 74 20 62 75 74 20 6e 6f 20 6d 75 74 65 78 20 69  t but no mutex i
2a280 73 20 68 65 6c 64 20 66 6f 72 20 61 6e 20 75 6e  s held for an un
2a290 70 72 6f 74 65 63 74 65 64 0a 2a 2a 20 73 71 6c  protected.** sql
2a2a0 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65 63  ite3_value objec
2a2b0 74 2e 20 20 49 66 20 53 51 4c 69 74 65 20 69 73  t.  If SQLite is
2a2c0 20 63 6f 6d 70 69 6c 65 64 20 74 6f 20 62 65 20   compiled to be 
2a2d0 73 69 6e 67 6c 65 2d 74 68 72 65 61 64 65 64 0a  single-threaded.
2a2e0 2a 2a 20 28 77 69 74 68 20 5b 53 51 4c 49 54 45  ** (with [SQLITE
2a2f0 5f 54 48 52 45 41 44 53 41 46 45 3d 30 5d 20 61  _THREADSAFE=0] a
2a300 6e 64 20 77 69 74 68 20 5b 73 71 6c 69 74 65 33  nd with [sqlite3
2a310 5f 74 68 72 65 61 64 73 61 66 65 28 29 5d 20 72  _threadsafe()] r
2a320 65 74 75 72 6e 69 6e 67 20 30 29 0a 2a 2a 20 6f  eturning 0).** o
2a330 72 20 69 66 20 53 51 4c 69 74 65 20 69 73 20 72  r if SQLite is r
2a340 75 6e 20 69 6e 20 6f 6e 65 20 6f 66 20 72 65 64  un in one of red
2a350 75 63 65 64 20 6d 75 74 65 78 20 6d 6f 64 65 73  uced mutex modes
2a360 20 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 43 4f 4e   .** [SQLITE_CON
2a370 46 49 47 5f 53 49 4e 47 4c 45 54 48 52 45 41 44  FIG_SINGLETHREAD
2a380 5d 20 6f 72 20 5b 53 51 4c 49 54 45 5f 43 4f 4e  ] or [SQLITE_CON
2a390 46 49 47 5f 4d 55 4c 54 49 54 48 52 45 41 44 5d  FIG_MULTITHREAD]
2a3a0 0a 2a 2a 20 74 68 65 6e 20 74 68 65 72 65 20 69  .** then there i
2a3b0 73 20 6e 6f 20 64 69 73 74 69 6e 63 74 69 6f 6e  s no distinction
2a3c0 20 62 65 74 77 65 65 6e 20 70 72 6f 74 65 63 74   between protect
2a3d0 65 64 20 61 6e 64 20 75 6e 70 72 6f 74 65 63 74  ed and unprotect
2a3e0 65 64 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 76 61  ed.** sqlite3_va
2a3f0 6c 75 65 20 6f 62 6a 65 63 74 73 20 61 6e 64 20  lue objects and 
2a400 74 68 65 79 20 63 61 6e 20 62 65 20 75 73 65 64  they can be used
2a410 20 69 6e 74 65 72 63 68 61 6e 67 65 61 62 6c 79   interchangeably
2a420 2e 20 20 48 6f 77 65 76 65 72 2c 0a 2a 2a 20 66  .  However,.** f
2a430 6f 72 20 6d 61 78 69 6d 75 6d 20 63 6f 64 65 20  or maximum code 
2a440 70 6f 72 74 61 62 69 6c 69 74 79 20 69 74 20 69  portability it i
2a450 73 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 74 68  s recommended th
2a460 61 74 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 0a  at applications.
2a470 2a 2a 20 73 74 69 6c 6c 20 6d 61 6b 65 20 74 68  ** still make th
2a480 65 20 64 69 73 74 69 6e 63 74 69 6f 6e 20 62 65  e distinction be
2a490 74 77 65 65 6e 20 70 72 6f 74 65 63 74 65 64 20  tween protected 
2a4a0 61 6e 64 20 75 6e 70 72 6f 74 65 63 74 65 64 0a  and unprotected.
2a4b0 2a 2a 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  ** sqlite3_value
2a4c0 20 6f 62 6a 65 63 74 73 20 65 76 65 6e 20 77 68   objects even wh
2a4d0 65 6e 20 6e 6f 74 20 73 74 72 69 63 74 6c 79 20  en not strictly 
2a4e0 72 65 71 75 69 72 65 64 2e 0a 2a 2a 0a 2a 2a 20  required..**.** 
2a4f0 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 76 61 6c  ^The sqlite3_val
2a500 75 65 20 6f 62 6a 65 63 74 73 20 74 68 61 74 20  ue objects that 
2a510 61 72 65 20 70 61 73 73 65 64 20 61 73 20 70 61  are passed as pa
2a520 72 61 6d 65 74 65 72 73 20 69 6e 74 6f 20 74 68  rameters into th
2a530 65 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e 74 61 74  e.** implementat
2a540 69 6f 6e 20 6f 66 20 5b 61 70 70 6c 69 63 61 74  ion of [applicat
2a550 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51 4c 20  ion-defined SQL 
2a560 66 75 6e 63 74 69 6f 6e 73 5d 20 61 72 65 20 70  functions] are p
2a570 72 6f 74 65 63 74 65 64 2e 0a 2a 2a 20 5e 54 68  rotected..** ^Th
2a580 65 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20  e sqlite3_value 
2a590 6f 62 6a 65 63 74 20 72 65 74 75 72 6e 65 64 20  object returned 
2a5a0 62 79 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63  by.** [sqlite3_c
2a5b0 6f 6c 75 6d 6e 5f 76 61 6c 75 65 28 29 5d 20 69  olumn_value()] i
2a5c0 73 20 75 6e 70 72 6f 74 65 63 74 65 64 2e 0a 2a  s unprotected..*
2a5d0 2a 20 55 6e 70 72 6f 74 65 63 74 65 64 20 73 71  * Unprotected sq
2a5e0 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65  lite3_value obje
2a5f0 63 74 73 20 6d 61 79 20 6f 6e 6c 79 20 62 65 20  cts may only be 
2a600 75 73 65 64 20 77 69 74 68 0a 2a 2a 20 5b 73 71  used with.** [sq
2a610 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 76 61 6c  lite3_result_val
2a620 75 65 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74  ue()] and [sqlit
2a630 65 33 5f 62 69 6e 64 5f 76 61 6c 75 65 28 29 5d  e3_bind_value()]
2a640 2e 0a 2a 2a 20 54 68 65 20 5b 73 71 6c 69 74 65  ..** The [sqlite
2a650 33 5f 76 61 6c 75 65 5f 62 6c 6f 62 20 7c 20 73  3_value_blob | s
2a660 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 79 70  qlite3_value_typ
2a670 65 28 29 5d 20 66 61 6d 69 6c 79 20 6f 66 0a 2a  e()] family of.*
2a680 2a 20 69 6e 74 65 72 66 61 63 65 73 20 72 65 71  * interfaces req
2a690 75 69 72 65 20 70 72 6f 74 65 63 74 65 64 20 73  uire protected s
2a6a0 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a  qlite3_value obj
2a6b0 65 63 74 73 2e 0a 2a 2f 0a 74 79 70 65 64 65 66  ects..*/.typedef
2a6c0 20 73 74 72 75 63 74 20 4d 65 6d 20 73 71 6c 69   struct Mem sqli
2a6d0 74 65 33 5f 76 61 6c 75 65 3b 0a 0a 2f 2a 0a 2a  te3_value;../*.*
2a6e0 2a 20 43 41 50 49 33 52 45 46 3a 20 53 51 4c 20  * CAPI3REF: SQL 
2a6f0 46 75 6e 63 74 69 6f 6e 20 43 6f 6e 74 65 78 74  Function Context
2a700 20 4f 62 6a 65 63 74 0a 2a 2a 0a 2a 2a 20 54 68   Object.**.** Th
2a710 65 20 63 6f 6e 74 65 78 74 20 69 6e 20 77 68 69  e context in whi
2a720 63 68 20 61 6e 20 53 51 4c 20 66 75 6e 63 74 69  ch an SQL functi
2a730 6f 6e 20 65 78 65 63 75 74 65 73 20 69 73 20 73  on executes is s
2a740 74 6f 72 65 64 20 69 6e 20 61 6e 0a 2a 2a 20 73  tored in an.** s
2a750 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 20 6f  qlite3_context o
2a760 62 6a 65 63 74 2e 20 20 5e 41 20 70 6f 69 6e 74  bject.  ^A point
2a770 65 72 20 74 6f 20 61 6e 20 73 71 6c 69 74 65 33  er to an sqlite3
2a780 5f 63 6f 6e 74 65 78 74 20 6f 62 6a 65 63 74 0a  _context object.
2a790 2a 2a 20 69 73 20 61 6c 77 61 79 73 20 66 69 72  ** is always fir
2a7a0 73 74 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20  st parameter to 
2a7b0 5b 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66  [application-def
2a7c0 69 6e 65 64 20 53 51 4c 20 66 75 6e 63 74 69 6f  ined SQL functio
2a7d0 6e 73 5d 2e 0a 2a 2a 20 54 68 65 20 61 70 70 6c  ns]..** The appl
2a7e0 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20  ication-defined 
2a7f0 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 69 6d 70  SQL function imp
2a800 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 77 69 6c 6c  lementation will
2a810 20 70 61 73 73 20 74 68 69 73 0a 2a 2a 20 70 6f   pass this.** po
2a820 69 6e 74 65 72 20 74 68 72 6f 75 67 68 20 69 6e  inter through in
2a830 74 6f 20 63 61 6c 6c 73 20 74 6f 20 5b 73 71 6c  to calls to [sql
2a840 69 74 65 33 5f 72 65 73 75 6c 74 5f 69 6e 74 20  ite3_result_int 
2a850 7c 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74  | sqlite3_result
2a860 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  ()],.** [sqlite3
2a870 5f 61 67 67 72 65 67 61 74 65 5f 63 6f 6e 74 65  _aggregate_conte
2a880 78 74 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f  xt()], [sqlite3_
2a890 75 73 65 72 5f 64 61 74 61 28 29 5d 2c 0a 2a 2a  user_data()],.**
2a8a0 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78   [sqlite3_contex
2a8b0 74 5f 64 62 5f 68 61 6e 64 6c 65 28 29 5d 2c 20  t_db_handle()], 
2a8c0 5b 73 71 6c 69 74 65 33 5f 67 65 74 5f 61 75 78  [sqlite3_get_aux
2a8d0 64 61 74 61 28 29 5d 2c 0a 2a 2a 20 61 6e 64 2f  data()],.** and/
2a8e0 6f 72 20 5b 73 71 6c 69 74 65 33 5f 73 65 74 5f  or [sqlite3_set_
2a8f0 61 75 78 64 61 74 61 28 29 5d 2e 0a 2a 2f 0a 74  auxdata()]..*/.t
2a900 79 70 65 64 65 66 20 73 74 72 75 63 74 20 73 71  ypedef struct sq
2a910 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 20 73 71  lite3_context sq
2a920 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 3b 0a 0a  lite3_context;..
2a930 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
2a940 42 69 6e 64 69 6e 67 20 56 61 6c 75 65 73 20 54  Binding Values T
2a950 6f 20 50 72 65 70 61 72 65 64 20 53 74 61 74 65  o Prepared State
2a960 6d 65 6e 74 73 0a 2a 2a 20 4b 45 59 57 4f 52 44  ments.** KEYWORD
2a970 53 3a 20 7b 68 6f 73 74 20 70 61 72 61 6d 65 74  S: {host paramet
2a980 65 72 7d 20 7b 68 6f 73 74 20 70 61 72 61 6d 65  er} {host parame
2a990 74 65 72 73 7d 20 7b 68 6f 73 74 20 70 61 72 61  ters} {host para
2a9a0 6d 65 74 65 72 20 6e 61 6d 65 7d 0a 2a 2a 20 4b  meter name}.** K
2a9b0 45 59 57 4f 52 44 53 3a 20 7b 53 51 4c 20 70 61  EYWORDS: {SQL pa
2a9c0 72 61 6d 65 74 65 72 7d 20 7b 53 51 4c 20 70 61  rameter} {SQL pa
2a9d0 72 61 6d 65 74 65 72 73 7d 20 7b 70 61 72 61 6d  rameters} {param
2a9e0 65 74 65 72 20 62 69 6e 64 69 6e 67 7d 0a 2a 2a  eter binding}.**
2a9f0 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33   METHOD: sqlite3
2aa00 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 28 49 6e  _stmt.**.** ^(In
2aa10 20 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65   the SQL stateme
2aa20 6e 74 20 74 65 78 74 20 69 6e 70 75 74 20 74 6f  nt text input to
2aa30 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72   [sqlite3_prepar
2aa40 65 5f 76 32 28 29 5d 20 61 6e 64 20 69 74 73 20  e_v2()] and its 
2aa50 76 61 72 69 61 6e 74 73 2c 0a 2a 2a 20 6c 69 74  variants,.** lit
2aa60 65 72 61 6c 73 20 6d 61 79 20 62 65 20 72 65 70  erals may be rep
2aa70 6c 61 63 65 64 20 62 79 20 61 20 5b 70 61 72 61  laced by a [para
2aa80 6d 65 74 65 72 5d 20 74 68 61 74 20 6d 61 74 63  meter] that matc
2aa90 68 65 73 20 6f 6e 65 20 6f 66 20 66 6f 6c 6c 6f  hes one of follo
2aaa0 77 69 6e 67 0a 2a 2a 20 74 65 6d 70 6c 61 74 65  wing.** template
2aab0 73 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a  s:.**.** <ul>.**
2aac0 20 3c 6c 69 3e 20 20 3f 0a 2a 2a 20 3c 6c 69 3e   <li>  ?.** <li>
2aad0 20 20 3f 4e 4e 4e 0a 2a 2a 20 3c 6c 69 3e 20 20    ?NNN.** <li>  
2aae0 3a 56 56 56 0a 2a 2a 20 3c 6c 69 3e 20 20 40 56  :VVV.** <li>  @V
2aaf0 56 56 0a 2a 2a 20 3c 6c 69 3e 20 20 24 56 56 56  VV.** <li>  $VVV
2ab00 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 0a 2a 2a 20  .** </ul>.**.** 
2ab10 49 6e 20 74 68 65 20 74 65 6d 70 6c 61 74 65 73  In the templates
2ab20 20 61 62 6f 76 65 2c 20 4e 4e 4e 20 72 65 70 72   above, NNN repr
2ab30 65 73 65 6e 74 73 20 61 6e 20 69 6e 74 65 67 65  esents an intege
2ab40 72 20 6c 69 74 65 72 61 6c 2c 0a 2a 2a 20 61 6e  r literal,.** an
2ab50 64 20 56 56 56 20 72 65 70 72 65 73 65 6e 74 73  d VVV represents
2ab60 20 61 6e 20 61 6c 70 68 61 6e 75 6d 65 72 69 63   an alphanumeric
2ab70 20 69 64 65 6e 74 69 66 69 65 72 2e 29 5e 20 20   identifier.)^  
2ab80 5e 54 68 65 20 76 61 6c 75 65 73 20 6f 66 20 74  ^The values of t
2ab90 68 65 73 65 0a 2a 2a 20 70 61 72 61 6d 65 74 65  hese.** paramete
2aba0 72 73 20 28 61 6c 73 6f 20 63 61 6c 6c 65 64 20  rs (also called 
2abb0 22 68 6f 73 74 20 70 61 72 61 6d 65 74 65 72 20  "host parameter 
2abc0 6e 61 6d 65 73 22 20 6f 72 20 22 53 51 4c 20 70  names" or "SQL p
2abd0 61 72 61 6d 65 74 65 72 73 22 29 0a 2a 2a 20 63  arameters").** c
2abe0 61 6e 20 62 65 20 73 65 74 20 75 73 69 6e 67 20  an be set using 
2abf0 74 68 65 20 73 71 6c 69 74 65 33 5f 62 69 6e 64  the sqlite3_bind
2ac00 5f 2a 28 29 20 72 6f 75 74 69 6e 65 73 20 64 65  _*() routines de
2ac10 66 69 6e 65 64 20 68 65 72 65 2e 0a 2a 2a 0a 2a  fined here..**.*
2ac20 2a 20 5e 54 68 65 20 66 69 72 73 74 20 61 72 67  * ^The first arg
2ac30 75 6d 65 6e 74 20 74 6f 20 74 68 65 20 73 71 6c  ument to the sql
2ac40 69 74 65 33 5f 62 69 6e 64 5f 2a 28 29 20 72 6f  ite3_bind_*() ro
2ac50 75 74 69 6e 65 73 20 69 73 20 61 6c 77 61 79 73  utines is always
2ac60 0a 2a 2a 20 61 20 70 6f 69 6e 74 65 72 20 74 6f  .** a pointer to
2ac70 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 74   the [sqlite3_st
2ac80 6d 74 5d 20 6f 62 6a 65 63 74 20 72 65 74 75 72  mt] object retur
2ac90 6e 65 64 20 66 72 6f 6d 0a 2a 2a 20 5b 73 71 6c  ned from.** [sql
2aca0 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76 32 28  ite3_prepare_v2(
2acb0 29 5d 20 6f 72 20 69 74 73 20 76 61 72 69 61 6e  )] or its varian
2acc0 74 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  ts..**.** ^The s
2acd0 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20 69  econd argument i
2ace0 73 20 74 68 65 20 69 6e 64 65 78 20 6f 66 20 74  s the index of t
2acf0 68 65 20 53 51 4c 20 70 61 72 61 6d 65 74 65 72  he SQL parameter
2ad00 20 74 6f 20 62 65 20 73 65 74 2e 0a 2a 2a 20 5e   to be set..** ^
2ad10 54 68 65 20 6c 65 66 74 6d 6f 73 74 20 53 51 4c  The leftmost SQL
2ad20 20 70 61 72 61 6d 65 74 65 72 20 68 61 73 20 61   parameter has a
2ad30 6e 20 69 6e 64 65 78 20 6f 66 20 31 2e 20 20 5e  n index of 1.  ^
2ad40 57 68 65 6e 20 74 68 65 20 73 61 6d 65 20 6e 61  When the same na
2ad50 6d 65 64 0a 2a 2a 20 53 51 4c 20 70 61 72 61 6d  med.** SQL param
2ad60 65 74 65 72 20 69 73 20 75 73 65 64 20 6d 6f 72  eter is used mor
2ad70 65 20 74 68 61 6e 20 6f 6e 63 65 2c 20 73 65 63  e than once, sec
2ad80 6f 6e 64 20 61 6e 64 20 73 75 62 73 65 71 75 65  ond and subseque
2ad90 6e 74 0a 2a 2a 20 6f 63 63 75 72 72 65 6e 63 65  nt.** occurrence
2ada0 73 20 68 61 76 65 20 74 68 65 20 73 61 6d 65 20  s have the same 
2adb0 69 6e 64 65 78 20 61 73 20 74 68 65 20 66 69 72  index as the fir
2adc0 73 74 20 6f 63 63 75 72 72 65 6e 63 65 2e 0a 2a  st occurrence..*
2add0 2a 20 5e 54 68 65 20 69 6e 64 65 78 20 66 6f 72  * ^The index for
2ade0 20 6e 61 6d 65 64 20 70 61 72 61 6d 65 74 65 72   named parameter
2adf0 73 20 63 61 6e 20 62 65 20 6c 6f 6f 6b 65 64 20  s can be looked 
2ae00 75 70 20 75 73 69 6e 67 20 74 68 65 0a 2a 2a 20  up using the.** 
2ae10 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61  [sqlite3_bind_pa
2ae20 72 61 6d 65 74 65 72 5f 69 6e 64 65 78 28 29 5d  rameter_index()]
2ae30 20 41 50 49 20 69 66 20 64 65 73 69 72 65 64 2e   API if desired.
2ae40 20 20 5e 54 68 65 20 69 6e 64 65 78 0a 2a 2a 20    ^The index.** 
2ae50 66 6f 72 20 22 3f 4e 4e 4e 22 20 70 61 72 61 6d  for "?NNN" param
2ae60 65 74 65 72 73 20 69 73 20 74 68 65 20 76 61 6c  eters is the val
2ae70 75 65 20 6f 66 20 4e 4e 4e 2e 0a 2a 2a 20 5e 54  ue of NNN..** ^T
2ae80 68 65 20 4e 4e 4e 20 76 61 6c 75 65 20 6d 75 73  he NNN value mus
2ae90 74 20 62 65 20 62 65 74 77 65 65 6e 20 31 20 61  t be between 1 a
2aea0 6e 64 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  nd the [sqlite3_
2aeb0 6c 69 6d 69 74 28 29 5d 0a 2a 2a 20 70 61 72 61  limit()].** para
2aec0 6d 65 74 65 72 20 5b 53 51 4c 49 54 45 5f 4c 49  meter [SQLITE_LI
2aed0 4d 49 54 5f 56 41 52 49 41 42 4c 45 5f 4e 55 4d  MIT_VARIABLE_NUM
2aee0 42 45 52 5d 20 28 64 65 66 61 75 6c 74 20 76 61  BER] (default va
2aef0 6c 75 65 3a 20 39 39 39 29 2e 0a 2a 2a 0a 2a 2a  lue: 999)..**.**
2af00 20 5e 54 68 65 20 74 68 69 72 64 20 61 72 67 75   ^The third argu
2af10 6d 65 6e 74 20 69 73 20 74 68 65 20 76 61 6c 75  ment is the valu
2af20 65 20 74 6f 20 62 69 6e 64 20 74 6f 20 74 68 65  e to bind to the
2af30 20 70 61 72 61 6d 65 74 65 72 2e 0a 2a 2a 20 5e   parameter..** ^
2af40 49 66 20 74 68 65 20 74 68 69 72 64 20 70 61 72  If the third par
2af50 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65  ameter to sqlite
2af60 33 5f 62 69 6e 64 5f 74 65 78 74 28 29 20 6f 72  3_bind_text() or
2af70 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74 65   sqlite3_bind_te
2af80 78 74 31 36 28 29 0a 2a 2a 20 6f 72 20 73 71 6c  xt16().** or sql
2af90 69 74 65 33 5f 62 69 6e 64 5f 62 6c 6f 62 28 29  ite3_bind_blob()
2afa0 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74   is a NULL point
2afb0 65 72 20 74 68 65 6e 20 74 68 65 20 66 6f 75 72  er then the four
2afc0 74 68 20 70 61 72 61 6d 65 74 65 72 0a 2a 2a 20  th parameter.** 
2afd0 69 73 20 69 67 6e 6f 72 65 64 20 61 6e 64 20 74  is ignored and t
2afe0 68 65 20 65 6e 64 20 72 65 73 75 6c 74 20 69 73  he end result is
2aff0 20 74 68 65 20 73 61 6d 65 20 61 73 20 73 71 6c   the same as sql
2b000 69 74 65 33 5f 62 69 6e 64 5f 6e 75 6c 6c 28 29  ite3_bind_null()
2b010 2e 0a 2a 2a 0a 2a 2a 20 5e 28 49 6e 20 74 68 6f  ..**.** ^(In tho
2b020 73 65 20 72 6f 75 74 69 6e 65 73 20 74 68 61 74  se routines that
2b030 20 68 61 76 65 20 61 20 66 6f 75 72 74 68 20 61   have a fourth a
2b040 72 67 75 6d 65 6e 74 2c 20 69 74 73 20 76 61 6c  rgument, its val
2b050 75 65 20 69 73 20 74 68 65 0a 2a 2a 20 6e 75 6d  ue is the.** num
2b060 62 65 72 20 6f 66 20 62 79 74 65 73 20 69 6e 20  ber of bytes in 
2b070 74 68 65 20 70 61 72 61 6d 65 74 65 72 2e 20 20  the parameter.  
2b080 54 6f 20 62 65 20 63 6c 65 61 72 3a 20 74 68 65  To be clear: the
2b090 20 76 61 6c 75 65 20 69 73 20 74 68 65 0a 2a 2a   value is the.**
2b0a0 20 6e 75 6d 62 65 72 20 6f 66 20 3c 75 3e 62 79   number of <u>by
2b0b0 74 65 73 3c 2f 75 3e 20 69 6e 20 74 68 65 20 76  tes</u> in the v
2b0c0 61 6c 75 65 2c 20 6e 6f 74 20 74 68 65 20 6e 75  alue, not the nu
2b0d0 6d 62 65 72 20 6f 66 20 63 68 61 72 61 63 74 65  mber of characte
2b0e0 72 73 2e 29 5e 0a 2a 2a 20 5e 49 66 20 74 68 65  rs.)^.** ^If the
2b0f0 20 66 6f 75 72 74 68 20 70 61 72 61 6d 65 74 65   fourth paramete
2b100 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 62 69 6e  r to sqlite3_bin
2b110 64 5f 74 65 78 74 28 29 20 6f 72 20 73 71 6c 69  d_text() or sqli
2b120 74 65 33 5f 62 69 6e 64 5f 74 65 78 74 31 36 28  te3_bind_text16(
2b130 29 0a 2a 2a 20 69 73 20 6e 65 67 61 74 69 76 65  ).** is negative
2b140 2c 20 74 68 65 6e 20 74 68 65 20 6c 65 6e 67 74  , then the lengt
2b150 68 20 6f 66 20 74 68 65 20 73 74 72 69 6e 67 20  h of the string 
2b160 69 73 0a 2a 2a 20 74 68 65 20 6e 75 6d 62 65 72  is.** the number
2b170 20 6f 66 20 62 79 74 65 73 20 75 70 20 74 6f 20   of bytes up to 
2b180 74 68 65 20 66 69 72 73 74 20 7a 65 72 6f 20 74  the first zero t
2b190 65 72 6d 69 6e 61 74 6f 72 2e 0a 2a 2a 20 49 66  erminator..** If
2b1a0 20 74 68 65 20 66 6f 75 72 74 68 20 70 61 72 61   the fourth para
2b1b0 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33  meter to sqlite3
2b1c0 5f 62 69 6e 64 5f 62 6c 6f 62 28 29 20 69 73 20  _bind_blob() is 
2b1d0 6e 65 67 61 74 69 76 65 2c 20 74 68 65 6e 0a 2a  negative, then.*
2b1e0 2a 20 74 68 65 20 62 65 68 61 76 69 6f 72 20 69  * the behavior i
2b1f0 73 20 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a 20  s undefined..** 
2b200 49 66 20 61 20 6e 6f 6e 2d 6e 65 67 61 74 69 76  If a non-negativ
2b210 65 20 66 6f 75 72 74 68 20 70 61 72 61 6d 65 74  e fourth paramet
2b220 65 72 20 69 73 20 70 72 6f 76 69 64 65 64 20 74  er is provided t
2b230 6f 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74  o sqlite3_bind_t
2b240 65 78 74 28 29 0a 2a 2a 20 6f 72 20 73 71 6c 69  ext().** or sqli
2b250 74 65 33 5f 62 69 6e 64 5f 74 65 78 74 31 36 28  te3_bind_text16(
2b260 29 20 6f 72 20 73 71 6c 69 74 65 33 5f 62 69 6e  ) or sqlite3_bin
2b270 64 5f 74 65 78 74 36 34 28 29 20 74 68 65 6e 0a  d_text64() then.
2b280 2a 2a 20 74 68 61 74 20 70 61 72 61 6d 65 74 65  ** that paramete
2b290 72 20 6d 75 73 74 20 62 65 20 74 68 65 20 62 79  r must be the by
2b2a0 74 65 20 6f 66 66 73 65 74 0a 2a 2a 20 77 68 65  te offset.** whe
2b2b0 72 65 20 74 68 65 20 4e 55 4c 20 74 65 72 6d 69  re the NUL termi
2b2c0 6e 61 74 6f 72 20 77 6f 75 6c 64 20 6f 63 63 75  nator would occu
2b2d0 72 20 61 73 73 75 6d 69 6e 67 20 74 68 65 20 73  r assuming the s
2b2e0 74 72 69 6e 67 20 77 65 72 65 20 4e 55 4c 0a 2a  tring were NUL.*
2b2f0 2a 20 74 65 72 6d 69 6e 61 74 65 64 2e 20 20 49  * terminated.  I
2b300 66 20 61 6e 79 20 4e 55 4c 20 63 68 61 72 61 63  f any NUL charac
2b310 74 65 72 73 20 6f 63 63 75 72 20 61 74 20 62 79  ters occur at by
2b320 74 65 20 6f 66 66 73 65 74 73 20 6c 65 73 73 20  te offsets less 
2b330 74 68 61 6e 20 0a 2a 2a 20 74 68 65 20 76 61 6c  than .** the val
2b340 75 65 20 6f 66 20 74 68 65 20 66 6f 75 72 74 68  ue of the fourth
2b350 20 70 61 72 61 6d 65 74 65 72 20 74 68 65 6e 20   parameter then 
2b360 74 68 65 20 72 65 73 75 6c 74 69 6e 67 20 73 74  the resulting st
2b370 72 69 6e 67 20 76 61 6c 75 65 20 77 69 6c 6c 0a  ring value will.
2b380 2a 2a 20 63 6f 6e 74 61 69 6e 20 65 6d 62 65 64  ** contain embed
2b390 64 65 64 20 4e 55 4c 73 2e 20 20 54 68 65 20 72  ded NULs.  The r
2b3a0 65 73 75 6c 74 20 6f 66 20 65 78 70 72 65 73 73  esult of express
2b3b0 69 6f 6e 73 20 69 6e 76 6f 6c 76 69 6e 67 20 73  ions involving s
2b3c0 74 72 69 6e 67 73 0a 2a 2a 20 77 69 74 68 20 65  trings.** with e
2b3d0 6d 62 65 64 64 65 64 20 4e 55 4c 73 20 69 73 20  mbedded NULs is 
2b3e0 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a  undefined..**.**
2b3f0 20 5e 54 68 65 20 66 69 66 74 68 20 61 72 67 75   ^The fifth argu
2b400 6d 65 6e 74 20 74 6f 20 74 68 65 20 42 4c 4f 42  ment to the BLOB
2b410 20 61 6e 64 20 73 74 72 69 6e 67 20 62 69 6e 64   and string bind
2b420 69 6e 67 20 69 6e 74 65 72 66 61 63 65 73 0a 2a  ing interfaces.*
2b430 2a 20 69 73 20 61 20 64 65 73 74 72 75 63 74 6f  * is a destructo
2b440 72 20 75 73 65 64 20 74 6f 20 64 69 73 70 6f 73  r used to dispos
2b450 65 20 6f 66 20 74 68 65 20 42 4c 4f 42 20 6f 72  e of the BLOB or
2b460 0a 2a 2a 20 73 74 72 69 6e 67 20 61 66 74 65 72  .** string after
2b470 20 53 51 4c 69 74 65 20 68 61 73 20 66 69 6e 69   SQLite has fini
2b480 73 68 65 64 20 77 69 74 68 20 69 74 2e 20 20 5e  shed with it.  ^
2b490 54 68 65 20 64 65 73 74 72 75 63 74 6f 72 20 69  The destructor i
2b4a0 73 20 63 61 6c 6c 65 64 0a 2a 2a 20 74 6f 20 64  s called.** to d
2b4b0 69 73 70 6f 73 65 20 6f 66 20 74 68 65 20 42 4c  ispose of the BL
2b4c0 4f 42 20 6f 72 20 73 74 72 69 6e 67 20 65 76 65  OB or string eve
2b4d0 6e 20 69 66 20 74 68 65 20 63 61 6c 6c 20 74 6f  n if the call to
2b4e0 20 62 69 6e 64 20 41 50 49 20 66 61 69 6c 73 2e   bind API fails.
2b4f0 0a 2a 2a 20 5e 49 66 20 74 68 65 20 66 69 66 74  .** ^If the fift
2b500 68 20 61 72 67 75 6d 65 6e 74 20 69 73 0a 2a 2a  h argument is.**
2b510 20 74 68 65 20 73 70 65 63 69 61 6c 20 76 61 6c   the special val
2b520 75 65 20 5b 53 51 4c 49 54 45 5f 53 54 41 54 49  ue [SQLITE_STATI
2b530 43 5d 2c 20 74 68 65 6e 20 53 51 4c 69 74 65 20  C], then SQLite 
2b540 61 73 73 75 6d 65 73 20 74 68 61 74 20 74 68 65  assumes that the
2b550 0a 2a 2a 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20  .** information 
2b560 69 73 20 69 6e 20 73 74 61 74 69 63 2c 20 75 6e  is in static, un
2b570 6d 61 6e 61 67 65 64 20 73 70 61 63 65 20 61 6e  managed space an
2b580 64 20 64 6f 65 73 20 6e 6f 74 20 6e 65 65 64 20  d does not need 
2b590 74 6f 20 62 65 20 66 72 65 65 64 2e 0a 2a 2a 20  to be freed..** 
2b5a0 5e 49 66 20 74 68 65 20 66 69 66 74 68 20 61 72  ^If the fifth ar
2b5b0 67 75 6d 65 6e 74 20 68 61 73 20 74 68 65 20 76  gument has the v
2b5c0 61 6c 75 65 20 5b 53 51 4c 49 54 45 5f 54 52 41  alue [SQLITE_TRA
2b5d0 4e 53 49 45 4e 54 5d 2c 20 74 68 65 6e 0a 2a 2a  NSIENT], then.**
2b5e0 20 53 51 4c 69 74 65 20 6d 61 6b 65 73 20 69 74   SQLite makes it
2b5f0 73 20 6f 77 6e 20 70 72 69 76 61 74 65 20 63 6f  s own private co
2b600 70 79 20 6f 66 20 74 68 65 20 64 61 74 61 20 69  py of the data i
2b610 6d 6d 65 64 69 61 74 65 6c 79 2c 20 62 65 66 6f  mmediately, befo
2b620 72 65 0a 2a 2a 20 74 68 65 20 73 71 6c 69 74 65  re.** the sqlite
2b630 33 5f 62 69 6e 64 5f 2a 28 29 20 72 6f 75 74 69  3_bind_*() routi
2b640 6e 65 20 72 65 74 75 72 6e 73 2e 0a 2a 2a 0a 2a  ne returns..**.*
2b650 2a 20 5e 54 68 65 20 73 69 78 74 68 20 61 72 67  * ^The sixth arg
2b660 75 6d 65 6e 74 20 74 6f 20 73 71 6c 69 74 65 33  ument to sqlite3
2b670 5f 62 69 6e 64 5f 74 65 78 74 36 34 28 29 20 6d  _bind_text64() m
2b680 75 73 74 20 62 65 20 6f 6e 65 20 6f 66 0a 2a 2a  ust be one of.**
2b690 20 5b 53 51 4c 49 54 45 5f 55 54 46 38 5d 2c 20   [SQLITE_UTF8], 
2b6a0 5b 53 51 4c 49 54 45 5f 55 54 46 31 36 5d 2c 20  [SQLITE_UTF16], 
2b6b0 5b 53 51 4c 49 54 45 5f 55 54 46 31 36 42 45 5d  [SQLITE_UTF16BE]
2b6c0 2c 20 6f 72 20 5b 53 51 4c 49 54 45 5f 55 54 46  , or [SQLITE_UTF
2b6d0 31 36 4c 45 5d 0a 2a 2a 20 74 6f 20 73 70 65 63  16LE].** to spec
2b6e0 69 66 79 20 74 68 65 20 65 6e 63 6f 64 69 6e 67  ify the encoding
2b6f0 20 6f 66 20 74 68 65 20 74 65 78 74 20 69 6e 20   of the text in 
2b700 74 68 65 20 74 68 69 72 64 20 70 61 72 61 6d 65  the third parame
2b710 74 65 72 2e 20 20 49 66 0a 2a 2a 20 74 68 65 20  ter.  If.** the 
2b720 73 69 78 74 68 20 61 72 67 75 6d 65 6e 74 20 74  sixth argument t
2b730 6f 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74  o sqlite3_bind_t
2b740 65 78 74 36 34 28 29 20 69 73 20 6e 6f 74 20 6f  ext64() is not o
2b750 6e 65 20 6f 66 20 74 68 65 0a 2a 2a 20 61 6c 6c  ne of the.** all
2b760 6f 77 65 64 20 76 61 6c 75 65 73 20 73 68 6f 77  owed values show
2b770 6e 20 61 62 6f 76 65 2c 20 6f 72 20 69 66 20 74  n above, or if t
2b780 68 65 20 74 65 78 74 20 65 6e 63 6f 64 69 6e 67  he text encoding
2b790 20 69 73 20 64 69 66 66 65 72 65 6e 74 0a 2a 2a   is different.**
2b7a0 20 66 72 6f 6d 20 74 68 65 20 65 6e 63 6f 64 69   from the encodi
2b7b0 6e 67 20 73 70 65 63 69 66 69 65 64 20 62 79 20  ng specified by 
2b7c0 74 68 65 20 73 69 78 74 68 20 70 61 72 61 6d 65  the sixth parame
2b7d0 74 65 72 2c 20 74 68 65 6e 20 74 68 65 20 62 65  ter, then the be
2b7e0 68 61 76 69 6f 72 0a 2a 2a 20 69 73 20 75 6e 64  havior.** is und
2b7f0 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54  efined..**.** ^T
2b800 68 65 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  he sqlite3_bind_
2b810 7a 65 72 6f 62 6c 6f 62 28 29 20 72 6f 75 74 69  zeroblob() routi
2b820 6e 65 20 62 69 6e 64 73 20 61 20 42 4c 4f 42 20  ne binds a BLOB 
2b830 6f 66 20 6c 65 6e 67 74 68 20 4e 20 74 68 61 74  of length N that
2b840 0a 2a 2a 20 69 73 20 66 69 6c 6c 65 64 20 77 69  .** is filled wi
2b850 74 68 20 7a 65 72 6f 65 73 2e 20 20 5e 41 20 7a  th zeroes.  ^A z
2b860 65 72 6f 62 6c 6f 62 20 75 73 65 73 20 61 20 66  eroblob uses a f
2b870 69 78 65 64 20 61 6d 6f 75 6e 74 20 6f 66 20 6d  ixed amount of m
2b880 65 6d 6f 72 79 0a 2a 2a 20 28 6a 75 73 74 20 61  emory.** (just a
2b890 6e 20 69 6e 74 65 67 65 72 20 74 6f 20 68 6f 6c  n integer to hol
2b8a0 64 20 69 74 73 20 73 69 7a 65 29 20 77 68 69 6c  d its size) whil
2b8b0 65 20 69 74 20 69 73 20 62 65 69 6e 67 20 70 72  e it is being pr
2b8c0 6f 63 65 73 73 65 64 2e 0a 2a 2a 20 5a 65 72 6f  ocessed..** Zero
2b8d0 62 6c 6f 62 73 20 61 72 65 20 69 6e 74 65 6e 64  blobs are intend
2b8e0 65 64 20 74 6f 20 73 65 72 76 65 20 61 73 20 70  ed to serve as p
2b8f0 6c 61 63 65 68 6f 6c 64 65 72 73 20 66 6f 72 20  laceholders for 
2b900 42 4c 4f 42 73 20 77 68 6f 73 65 0a 2a 2a 20 63  BLOBs whose.** c
2b910 6f 6e 74 65 6e 74 20 69 73 20 6c 61 74 65 72 20  ontent is later 
2b920 77 72 69 74 74 65 6e 20 75 73 69 6e 67 0a 2a 2a  written using.**
2b930 20 5b 73 71 6c 69 74 65 33 5f 62 6c 6f 62 5f 6f   [sqlite3_blob_o
2b940 70 65 6e 20 7c 20 69 6e 63 72 65 6d 65 6e 74 61  pen | incrementa
2b950 6c 20 42 4c 4f 42 20 49 2f 4f 5d 20 72 6f 75 74  l BLOB I/O] rout
2b960 69 6e 65 73 2e 0a 2a 2a 20 5e 41 20 6e 65 67 61  ines..** ^A nega
2b970 74 69 76 65 20 76 61 6c 75 65 20 66 6f 72 20 74  tive value for t
2b980 68 65 20 7a 65 72 6f 62 6c 6f 62 20 72 65 73 75  he zeroblob resu
2b990 6c 74 73 20 69 6e 20 61 20 7a 65 72 6f 2d 6c 65  lts in a zero-le
2b9a0 6e 67 74 68 20 42 4c 4f 42 2e 0a 2a 2a 0a 2a 2a  ngth BLOB..**.**
2b9b0 20 5e 49 66 20 61 6e 79 20 6f 66 20 74 68 65 20   ^If any of the 
2b9c0 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 2a 28 29  sqlite3_bind_*()
2b9d0 20 72 6f 75 74 69 6e 65 73 20 61 72 65 20 63 61   routines are ca
2b9e0 6c 6c 65 64 20 77 69 74 68 20 61 20 4e 55 4c 4c  lled with a NULL
2b9f0 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 66 6f 72 20   pointer.** for 
2ba00 74 68 65 20 5b 70 72 65 70 61 72 65 64 20 73 74  the [prepared st
2ba10 61 74 65 6d 65 6e 74 5d 20 6f 72 20 77 69 74 68  atement] or with
2ba20 20 61 20 70 72 65 70 61 72 65 64 20 73 74 61 74   a prepared stat
2ba30 65 6d 65 6e 74 20 66 6f 72 20 77 68 69 63 68 0a  ement for which.
2ba40 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70  ** [sqlite3_step
2ba50 28 29 5d 20 68 61 73 20 62 65 65 6e 20 63 61 6c  ()] has been cal
2ba60 6c 65 64 20 6d 6f 72 65 20 72 65 63 65 6e 74 6c  led more recentl
2ba70 79 20 74 68 61 6e 20 5b 73 71 6c 69 74 65 33 5f  y than [sqlite3_
2ba80 72 65 73 65 74 28 29 5d 2c 0a 2a 2a 20 74 68 65  reset()],.** the
2ba90 6e 20 74 68 65 20 63 61 6c 6c 20 77 69 6c 6c 20  n the call will 
2baa0 72 65 74 75 72 6e 20 5b 53 51 4c 49 54 45 5f 4d  return [SQLITE_M
2bab0 49 53 55 53 45 5d 2e 20 20 49 66 20 61 6e 79 20  ISUSE].  If any 
2bac0 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 28 29 0a  sqlite3_bind_().
2bad0 2a 2a 20 72 6f 75 74 69 6e 65 20 69 73 20 70 61  ** routine is pa
2bae0 73 73 65 64 20 61 20 5b 70 72 65 70 61 72 65 64  ssed a [prepared
2baf0 20 73 74 61 74 65 6d 65 6e 74 5d 20 74 68 61 74   statement] that
2bb00 20 68 61 73 20 62 65 65 6e 20 66 69 6e 61 6c 69   has been finali
2bb10 7a 65 64 2c 20 74 68 65 0a 2a 2a 20 72 65 73 75  zed, the.** resu
2bb20 6c 74 20 69 73 20 75 6e 64 65 66 69 6e 65 64 20  lt is undefined 
2bb30 61 6e 64 20 70 72 6f 62 61 62 6c 79 20 68 61 72  and probably har
2bb40 6d 66 75 6c 2e 0a 2a 2a 0a 2a 2a 20 5e 42 69 6e  mful..**.** ^Bin
2bb50 64 69 6e 67 73 20 61 72 65 20 6e 6f 74 20 63 6c  dings are not cl
2bb60 65 61 72 65 64 20 62 79 20 74 68 65 20 5b 73 71  eared by the [sq
2bb70 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20 72  lite3_reset()] r
2bb80 6f 75 74 69 6e 65 2e 0a 2a 2a 20 5e 55 6e 62 6f  outine..** ^Unbo
2bb90 75 6e 64 20 70 61 72 61 6d 65 74 65 72 73 20 61  und parameters a
2bba0 72 65 20 69 6e 74 65 72 70 72 65 74 65 64 20 61  re interpreted a
2bbb0 73 20 4e 55 4c 4c 2e 0a 2a 2a 0a 2a 2a 20 5e 54  s NULL..**.** ^T
2bbc0 68 65 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  he sqlite3_bind_
2bbd0 2a 20 72 6f 75 74 69 6e 65 73 20 72 65 74 75 72  * routines retur
2bbe0 6e 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 6f 6e  n [SQLITE_OK] on
2bbf0 20 73 75 63 63 65 73 73 20 6f 72 20 61 6e 0a 2a   success or an.*
2bc00 2a 20 5b 65 72 72 6f 72 20 63 6f 64 65 5d 20 69  * [error code] i
2bc10 66 20 61 6e 79 74 68 69 6e 67 20 67 6f 65 73 20  f anything goes 
2bc20 77 72 6f 6e 67 2e 0a 2a 2a 20 5e 5b 53 51 4c 49  wrong..** ^[SQLI
2bc30 54 45 5f 54 4f 4f 42 49 47 5d 20 6d 69 67 68 74  TE_TOOBIG] might
2bc40 20 62 65 20 72 65 74 75 72 6e 65 64 20 69 66 20   be returned if 
2bc50 74 68 65 20 73 69 7a 65 20 6f 66 20 61 20 73 74  the size of a st
2bc60 72 69 6e 67 20 6f 72 20 42 4c 4f 42 0a 2a 2a 20  ring or BLOB.** 
2bc70 65 78 63 65 65 64 73 20 6c 69 6d 69 74 73 20 69  exceeds limits i
2bc80 6d 70 6f 73 65 64 20 62 79 20 5b 73 71 6c 69 74  mposed by [sqlit
2bc90 65 33 5f 6c 69 6d 69 74 5d 28 5b 53 51 4c 49 54  e3_limit]([SQLIT
2bca0 45 5f 4c 49 4d 49 54 5f 4c 45 4e 47 54 48 5d 29  E_LIMIT_LENGTH])
2bcb0 20 6f 72 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 4d   or.** [SQLITE_M
2bcc0 41 58 5f 4c 45 4e 47 54 48 5d 2e 0a 2a 2a 20 5e  AX_LENGTH]..** ^
2bcd0 5b 53 51 4c 49 54 45 5f 52 41 4e 47 45 5d 20 69  [SQLITE_RANGE] i
2bce0 73 20 72 65 74 75 72 6e 65 64 20 69 66 20 74 68  s returned if th
2bcf0 65 20 70 61 72 61 6d 65 74 65 72 0a 2a 2a 20 69  e parameter.** i
2bd00 6e 64 65 78 20 69 73 20 6f 75 74 20 6f 66 20 72  ndex is out of r
2bd10 61 6e 67 65 2e 20 20 5e 5b 53 51 4c 49 54 45 5f  ange.  ^[SQLITE_
2bd20 4e 4f 4d 45 4d 5d 20 69 73 20 72 65 74 75 72 6e  NOMEM] is return
2bd30 65 64 20 69 66 20 6d 61 6c 6c 6f 63 28 29 20 66  ed if malloc() f
2bd40 61 69 6c 73 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20  ails..**.** See 
2bd50 61 6c 73 6f 3a 20 5b 73 71 6c 69 74 65 33 5f 62  also: [sqlite3_b
2bd60 69 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f 63 6f  ind_parameter_co
2bd70 75 6e 74 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69  unt()],.** [sqli
2bd80 74 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74  te3_bind_paramet
2bd90 65 72 5f 6e 61 6d 65 28 29 5d 2c 20 61 6e 64 20  er_name()], and 
2bda0 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61  [sqlite3_bind_pa
2bdb0 72 61 6d 65 74 65 72 5f 69 6e 64 65 78 28 29 5d  rameter_index()]
2bdc0 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  ..*/.int sqlite3
2bdd0 5f 62 69 6e 64 5f 62 6c 6f 62 28 73 71 6c 69 74  _bind_blob(sqlit
2bde0 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c 20 63  e3_stmt*, int, c
2bdf0 6f 6e 73 74 20 76 6f 69 64 2a 2c 20 69 6e 74 20  onst void*, int 
2be00 6e 2c 20 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a  n, void(*)(void*
2be10 29 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  ));.int sqlite3_
2be20 62 69 6e 64 5f 62 6c 6f 62 36 34 28 73 71 6c 69  bind_blob64(sqli
2be30 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c 20  te3_stmt*, int, 
2be40 63 6f 6e 73 74 20 76 6f 69 64 2a 2c 20 73 71 6c  const void*, sql
2be50 69 74 65 33 5f 75 69 6e 74 36 34 2c 0a 20 20 20  ite3_uint64,.   
2be60 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2be70 20 20 20 20 20 76 6f 69 64 28 2a 29 28 76 6f 69       void(*)(voi
2be80 64 2a 29 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  d*));.int sqlite
2be90 33 5f 62 69 6e 64 5f 64 6f 75 62 6c 65 28 73 71  3_bind_double(sq
2bea0 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74  lite3_stmt*, int
2beb0 2c 20 64 6f 75 62 6c 65 29 3b 0a 69 6e 74 20 73  , double);.int s
2bec0 71 6c 69 74 65 33 5f 62 69 6e 64 5f 69 6e 74 28  qlite3_bind_int(
2bed0 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69  sqlite3_stmt*, i
2bee0 6e 74 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71  nt, int);.int sq
2bef0 6c 69 74 65 33 5f 62 69 6e 64 5f 69 6e 74 36 34  lite3_bind_int64
2bf00 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20  (sqlite3_stmt*, 
2bf10 69 6e 74 2c 20 73 71 6c 69 74 65 33 5f 69 6e 74  int, sqlite3_int
2bf20 36 34 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  64);.int sqlite3
2bf30 5f 62 69 6e 64 5f 6e 75 6c 6c 28 73 71 6c 69 74  _bind_null(sqlit
2bf40 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 29 3b 0a  e3_stmt*, int);.
2bf50 69 6e 74 20 73 71 6c 69 74 65 33 5f 62 69 6e 64  int sqlite3_bind
2bf60 5f 74 65 78 74 28 73 71 6c 69 74 65 33 5f 73 74  _text(sqlite3_st
2bf70 6d 74 2a 2c 69 6e 74 2c 63 6f 6e 73 74 20 63 68  mt*,int,const ch
2bf80 61 72 2a 2c 69 6e 74 2c 76 6f 69 64 28 2a 29 28  ar*,int,void(*)(
2bf90 76 6f 69 64 2a 29 29 3b 0a 69 6e 74 20 73 71 6c  void*));.int sql
2bfa0 69 74 65 33 5f 62 69 6e 64 5f 74 65 78 74 31 36  ite3_bind_text16
2bfb0 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20  (sqlite3_stmt*, 
2bfc0 69 6e 74 2c 20 63 6f 6e 73 74 20 76 6f 69 64 2a  int, const void*
2bfd0 2c 20 69 6e 74 2c 20 76 6f 69 64 28 2a 29 28 76  , int, void(*)(v
2bfe0 6f 69 64 2a 29 29 3b 0a 69 6e 74 20 73 71 6c 69  oid*));.int sqli
2bff0 74 65 33 5f 62 69 6e 64 5f 74 65 78 74 36 34 28  te3_bind_text64(
2c000 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69  sqlite3_stmt*, i
2c010 6e 74 2c 20 63 6f 6e 73 74 20 63 68 61 72 2a 2c  nt, const char*,
2c020 20 73 71 6c 69 74 65 33 5f 75 69 6e 74 36 34 2c   sqlite3_uint64,
2c030 0a 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  .               
2c040 20 20 20 20 20 20 20 20 20 20 76 6f 69 64 28 2a            void(*
2c050 29 28 76 6f 69 64 2a 29 2c 20 75 6e 73 69 67 6e  )(void*), unsign
2c060 65 64 20 63 68 61 72 20 65 6e 63 6f 64 69 6e 67  ed char encoding
2c070 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62  );.int sqlite3_b
2c080 69 6e 64 5f 76 61 6c 75 65 28 73 71 6c 69 74 65  ind_value(sqlite
2c090 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c 20 63 6f  3_stmt*, int, co
2c0a0 6e 73 74 20 73 71 6c 69 74 65 33 5f 76 61 6c 75  nst sqlite3_valu
2c0b0 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  e*);.int sqlite3
2c0c0 5f 62 69 6e 64 5f 7a 65 72 6f 62 6c 6f 62 28 73  _bind_zeroblob(s
2c0d0 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e  qlite3_stmt*, in
2c0e0 74 2c 20 69 6e 74 20 6e 29 3b 0a 69 6e 74 20 73  t, int n);.int s
2c0f0 71 6c 69 74 65 33 5f 62 69 6e 64 5f 7a 65 72 6f  qlite3_bind_zero
2c100 62 6c 6f 62 36 34 28 73 71 6c 69 74 65 33 5f 73  blob64(sqlite3_s
2c110 74 6d 74 2a 2c 20 69 6e 74 2c 20 73 71 6c 69 74  tmt*, int, sqlit
2c120 65 33 5f 75 69 6e 74 36 34 29 3b 0a 0a 2f 2a 0a  e3_uint64);../*.
2c130 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4e 75 6d  ** CAPI3REF: Num
2c140 62 65 72 20 4f 66 20 53 51 4c 20 50 61 72 61 6d  ber Of SQL Param
2c150 65 74 65 72 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a  eters.** METHOD:
2c160 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a   sqlite3_stmt.**
2c170 0a 2a 2a 20 5e 54 68 69 73 20 72 6f 75 74 69 6e  .** ^This routin
2c180 65 20 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f  e can be used to
2c190 20 66 69 6e 64 20 74 68 65 20 6e 75 6d 62 65 72   find the number
2c1a0 20 6f 66 20 5b 53 51 4c 20 70 61 72 61 6d 65 74   of [SQL paramet
2c1b0 65 72 73 5d 0a 2a 2a 20 69 6e 20 61 20 5b 70 72  ers].** in a [pr
2c1c0 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
2c1d0 5d 2e 20 20 53 51 4c 20 70 61 72 61 6d 65 74 65  ].  SQL paramete
2c1e0 72 73 20 61 72 65 20 74 6f 6b 65 6e 73 20 6f 66  rs are tokens of
2c1f0 20 74 68 65 0a 2a 2a 20 66 6f 72 6d 20 22 3f 22   the.** form "?"
2c200 2c 20 22 3f 4e 4e 4e 22 2c 20 22 3a 41 41 41 22  , "?NNN", ":AAA"
2c210 2c 20 22 24 41 41 41 22 2c 20 6f 72 20 22 40 41  , "$AAA", or "@A
2c220 41 41 22 20 74 68 61 74 20 73 65 72 76 65 20 61  AA" that serve a
2c230 73 0a 2a 2a 20 70 6c 61 63 65 68 6f 6c 64 65 72  s.** placeholder
2c240 73 20 66 6f 72 20 76 61 6c 75 65 73 20 74 68 61  s for values tha
2c250 74 20 61 72 65 20 5b 73 71 6c 69 74 65 33 5f 62  t are [sqlite3_b
2c260 69 6e 64 5f 62 6c 6f 62 20 7c 20 62 6f 75 6e 64  ind_blob | bound
2c270 5d 0a 2a 2a 20 74 6f 20 74 68 65 20 70 61 72 61  ].** to the para
2c280 6d 65 74 65 72 73 20 61 74 20 61 20 6c 61 74 65  meters at a late
2c290 72 20 74 69 6d 65 2e 0a 2a 2a 0a 2a 2a 20 5e 28  r time..**.** ^(
2c2a0 54 68 69 73 20 72 6f 75 74 69 6e 65 20 61 63 74  This routine act
2c2b0 75 61 6c 6c 79 20 72 65 74 75 72 6e 73 20 74 68  ually returns th
2c2c0 65 20 69 6e 64 65 78 20 6f 66 20 74 68 65 20 6c  e index of the l
2c2d0 61 72 67 65 73 74 20 28 72 69 67 68 74 6d 6f 73  argest (rightmos
2c2e0 74 29 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72 2e  t).** parameter.
2c2f0 20 46 6f 72 20 61 6c 6c 20 66 6f 72 6d 73 20 65   For all forms e
2c300 78 63 65 70 74 20 3f 4e 4e 4e 2c 20 74 68 69 73  xcept ?NNN, this
2c310 20 77 69 6c 6c 20 63 6f 72 72 65 73 70 6f 6e 64   will correspond
2c320 20 74 6f 20 74 68 65 0a 2a 2a 20 6e 75 6d 62 65   to the.** numbe
2c330 72 20 6f 66 20 75 6e 69 71 75 65 20 70 61 72 61  r of unique para
2c340 6d 65 74 65 72 73 2e 20 20 49 66 20 70 61 72 61  meters.  If para
2c350 6d 65 74 65 72 73 20 6f 66 20 74 68 65 20 3f 4e  meters of the ?N
2c360 4e 4e 20 66 6f 72 6d 20 61 72 65 20 75 73 65 64  NN form are used
2c370 2c 0a 2a 2a 20 74 68 65 72 65 20 6d 61 79 20 62  ,.** there may b
2c380 65 20 67 61 70 73 20 69 6e 20 74 68 65 20 6c 69  e gaps in the li
2c390 73 74 2e 29 5e 0a 2a 2a 0a 2a 2a 20 53 65 65 20  st.)^.**.** See 
2c3a0 61 6c 73 6f 3a 20 5b 73 71 6c 69 74 65 33 5f 62  also: [sqlite3_b
2c3b0 69 6e 64 5f 62 6c 6f 62 7c 73 71 6c 69 74 65 33  ind_blob|sqlite3
2c3c0 5f 62 69 6e 64 28 29 5d 2c 0a 2a 2a 20 5b 73 71  _bind()],.** [sq
2c3d0 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d  lite3_bind_param
2c3e0 65 74 65 72 5f 6e 61 6d 65 28 29 5d 2c 20 61 6e  eter_name()], an
2c3f0 64 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62 69  d.** [sqlite3_bi
2c400 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f 69 6e 64  nd_parameter_ind
2c410 65 78 28 29 5d 2e 0a 2a 2f 0a 69 6e 74 20 73 71  ex()]..*/.int sq
2c420 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d  lite3_bind_param
2c430 65 74 65 72 5f 63 6f 75 6e 74 28 73 71 6c 69 74  eter_count(sqlit
2c440 65 33 5f 73 74 6d 74 2a 29 3b 0a 0a 2f 2a 0a 2a  e3_stmt*);../*.*
2c450 2a 20 43 41 50 49 33 52 45 46 3a 20 4e 61 6d 65  * CAPI3REF: Name
2c460 20 4f 66 20 41 20 48 6f 73 74 20 50 61 72 61 6d   Of A Host Param
2c470 65 74 65 72 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20  eter.** METHOD: 
2c480 73 71 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a  sqlite3_stmt.**.
2c490 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  ** ^The sqlite3_
2c4a0 62 69 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f 6e  bind_parameter_n
2c4b0 61 6d 65 28 50 2c 4e 29 20 69 6e 74 65 72 66 61  ame(P,N) interfa
2c4c0 63 65 20 72 65 74 75 72 6e 73 0a 2a 2a 20 74 68  ce returns.** th
2c4d0 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 4e 2d  e name of the N-
2c4e0 74 68 20 5b 53 51 4c 20 70 61 72 61 6d 65 74 65  th [SQL paramete
2c4f0 72 5d 20 69 6e 20 74 68 65 20 5b 70 72 65 70 61  r] in the [prepa
2c500 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 50  red statement] P
2c510 2e 0a 2a 2a 20 5e 28 53 51 4c 20 70 61 72 61 6d  ..** ^(SQL param
2c520 65 74 65 72 73 20 6f 66 20 74 68 65 20 66 6f 72  eters of the for
2c530 6d 20 22 3f 4e 4e 4e 22 20 6f 72 20 22 3a 41 41  m "?NNN" or ":AA
2c540 41 22 20 6f 72 20 22 40 41 41 41 22 20 6f 72 20  A" or "@AAA" or 
2c550 22 24 41 41 41 22 0a 2a 2a 20 68 61 76 65 20 61  "$AAA".** have a
2c560 20 6e 61 6d 65 20 77 68 69 63 68 20 69 73 20 74   name which is t
2c570 68 65 20 73 74 72 69 6e 67 20 22 3f 4e 4e 4e 22  he string "?NNN"
2c580 20 6f 72 20 22 3a 41 41 41 22 20 6f 72 20 22 40   or ":AAA" or "@
2c590 41 41 41 22 20 6f 72 20 22 24 41 41 41 22 0a 2a  AAA" or "$AAA".*
2c5a0 2a 20 72 65 73 70 65 63 74 69 76 65 6c 79 2e 0a  * respectively..
2c5b0 2a 2a 20 49 6e 20 6f 74 68 65 72 20 77 6f 72 64  ** In other word
2c5c0 73 2c 20 74 68 65 20 69 6e 69 74 69 61 6c 20 22  s, the initial "
2c5d0 3a 22 20 6f 72 20 22 24 22 20 6f 72 20 22 40 22  :" or "$" or "@"
2c5e0 20 6f 72 20 22 3f 22 0a 2a 2a 20 69 73 20 69 6e   or "?".** is in
2c5f0 63 6c 75 64 65 64 20 61 73 20 70 61 72 74 20 6f  cluded as part o
2c600 66 20 74 68 65 20 6e 61 6d 65 2e 29 5e 0a 2a 2a  f the name.)^.**
2c610 20 5e 50 61 72 61 6d 65 74 65 72 73 20 6f 66 20   ^Parameters of 
2c620 74 68 65 20 66 6f 72 6d 20 22 3f 22 20 77 69 74  the form "?" wit
2c630 68 6f 75 74 20 61 20 66 6f 6c 6c 6f 77 69 6e 67  hout a following
2c640 20 69 6e 74 65 67 65 72 20 68 61 76 65 20 6e 6f   integer have no
2c650 20 6e 61 6d 65 0a 2a 2a 20 61 6e 64 20 61 72 65   name.** and are
2c660 20 72 65 66 65 72 72 65 64 20 74 6f 20 61 73 20   referred to as 
2c670 22 6e 61 6d 65 6c 65 73 73 22 20 6f 72 20 22 61  "nameless" or "a
2c680 6e 6f 6e 79 6d 6f 75 73 20 70 61 72 61 6d 65 74  nonymous paramet
2c690 65 72 73 22 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  ers"..**.** ^The
2c6a0 20 66 69 72 73 74 20 68 6f 73 74 20 70 61 72 61   first host para
2c6b0 6d 65 74 65 72 20 68 61 73 20 61 6e 20 69 6e 64  meter has an ind
2c6c0 65 78 20 6f 66 20 31 2c 20 6e 6f 74 20 30 2e 0a  ex of 1, not 0..
2c6d0 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 76 61  **.** ^If the va
2c6e0 6c 75 65 20 4e 20 69 73 20 6f 75 74 20 6f 66 20  lue N is out of 
2c6f0 72 61 6e 67 65 20 6f 72 20 69 66 20 74 68 65 20  range or if the 
2c700 4e 2d 74 68 20 70 61 72 61 6d 65 74 65 72 20 69  N-th parameter i
2c710 73 0a 2a 2a 20 6e 61 6d 65 6c 65 73 73 2c 20 74  s.** nameless, t
2c720 68 65 6e 20 4e 55 4c 4c 20 69 73 20 72 65 74 75  hen NULL is retu
2c730 72 6e 65 64 2e 20 20 5e 54 68 65 20 72 65 74 75  rned.  ^The retu
2c740 72 6e 65 64 20 73 74 72 69 6e 67 20 69 73 0a 2a  rned string is.*
2c750 2a 20 61 6c 77 61 79 73 20 69 6e 20 55 54 46 2d  * always in UTF-
2c760 38 20 65 6e 63 6f 64 69 6e 67 20 65 76 65 6e 20  8 encoding even 
2c770 69 66 20 74 68 65 20 6e 61 6d 65 64 20 70 61 72  if the named par
2c780 61 6d 65 74 65 72 20 77 61 73 0a 2a 2a 20 6f 72  ameter was.** or
2c790 69 67 69 6e 61 6c 6c 79 20 73 70 65 63 69 66 69  iginally specifi
2c7a0 65 64 20 61 73 20 55 54 46 2d 31 36 20 69 6e 20  ed as UTF-16 in 
2c7b0 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65  [sqlite3_prepare
2c7c0 31 36 28 29 5d 20 6f 72 0a 2a 2a 20 5b 73 71 6c  16()] or.** [sql
2c7d0 69 74 65 33 5f 70 72 65 70 61 72 65 31 36 5f 76  ite3_prepare16_v
2c7e0 32 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20  2()]..**.** See 
2c7f0 61 6c 73 6f 3a 20 5b 73 71 6c 69 74 65 33 5f 62  also: [sqlite3_b
2c800 69 6e 64 5f 62 6c 6f 62 7c 73 71 6c 69 74 65 33  ind_blob|sqlite3
2c810 5f 62 69 6e 64 28 29 5d 2c 0a 2a 2a 20 5b 73 71  _bind()],.** [sq
2c820 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d  lite3_bind_param
2c830 65 74 65 72 5f 63 6f 75 6e 74 28 29 5d 2c 20 61  eter_count()], a
2c840 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62  nd.** [sqlite3_b
2c850 69 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f 69 6e  ind_parameter_in
2c860 64 65 78 28 29 5d 2e 0a 2a 2f 0a 63 6f 6e 73 74  dex()]..*/.const
2c870 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 62   char *sqlite3_b
2c880 69 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f 6e 61  ind_parameter_na
2c890 6d 65 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a  me(sqlite3_stmt*
2c8a0 2c 20 69 6e 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43  , int);../*.** C
2c8b0 41 50 49 33 52 45 46 3a 20 49 6e 64 65 78 20 4f  API3REF: Index O
2c8c0 66 20 41 20 50 61 72 61 6d 65 74 65 72 20 57 69  f A Parameter Wi
2c8d0 74 68 20 41 20 47 69 76 65 6e 20 4e 61 6d 65 0a  th A Given Name.
2c8e0 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74  ** METHOD: sqlit
2c8f0 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 52  e3_stmt.**.** ^R
2c900 65 74 75 72 6e 20 74 68 65 20 69 6e 64 65 78 20  eturn the index 
2c910 6f 66 20 61 6e 20 53 51 4c 20 70 61 72 61 6d 65  of an SQL parame
2c920 74 65 72 20 67 69 76 65 6e 20 69 74 73 20 6e 61  ter given its na
2c930 6d 65 2e 20 20 5e 54 68 65 0a 2a 2a 20 69 6e 64  me.  ^The.** ind
2c940 65 78 20 76 61 6c 75 65 20 72 65 74 75 72 6e 65  ex value returne
2c950 64 20 69 73 20 73 75 69 74 61 62 6c 65 20 66 6f  d is suitable fo
2c960 72 20 75 73 65 20 61 73 20 74 68 65 20 73 65 63  r use as the sec
2c970 6f 6e 64 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72  ond.** parameter
2c980 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e   to [sqlite3_bin
2c990 64 5f 62 6c 6f 62 7c 73 71 6c 69 74 65 33 5f 62  d_blob|sqlite3_b
2c9a0 69 6e 64 28 29 5d 2e 20 20 5e 41 20 7a 65 72 6f  ind()].  ^A zero
2c9b0 0a 2a 2a 20 69 73 20 72 65 74 75 72 6e 65 64 20  .** is returned 
2c9c0 69 66 20 6e 6f 20 6d 61 74 63 68 69 6e 67 20 70  if no matching p
2c9d0 61 72 61 6d 65 74 65 72 20 69 73 20 66 6f 75 6e  arameter is foun
2c9e0 64 2e 20 20 5e 54 68 65 20 70 61 72 61 6d 65 74  d.  ^The paramet
2c9f0 65 72 0a 2a 2a 20 6e 61 6d 65 20 6d 75 73 74 20  er.** name must 
2ca00 62 65 20 67 69 76 65 6e 20 69 6e 20 55 54 46 2d  be given in UTF-
2ca10 38 20 65 76 65 6e 20 69 66 20 74 68 65 20 6f 72  8 even if the or
2ca20 69 67 69 6e 61 6c 20 73 74 61 74 65 6d 65 6e 74  iginal statement
2ca30 0a 2a 2a 20 77 61 73 20 70 72 65 70 61 72 65 64  .** was prepared
2ca40 20 66 72 6f 6d 20 55 54 46 2d 31 36 20 74 65 78   from UTF-16 tex
2ca50 74 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33  t using [sqlite3
2ca60 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28 29 5d  _prepare16_v2()]
2ca70 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f  ..**.** See also
2ca80 3a 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  : [sqlite3_bind_
2ca90 62 6c 6f 62 7c 73 71 6c 69 74 65 33 5f 62 69 6e  blob|sqlite3_bin
2caa0 64 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74 65  d()],.** [sqlite
2cab0 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65 72  3_bind_parameter
2cac0 5f 63 6f 75 6e 74 28 29 5d 2c 20 61 6e 64 0a 2a  _count()], and.*
2cad0 2a 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  * [sqlite3_bind_
2cae0 70 61 72 61 6d 65 74 65 72 5f 6e 61 6d 65 28 29  parameter_name()
2caf0 5d 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  ]..*/.int sqlite
2cb00 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65 72  3_bind_parameter
2cb10 5f 69 6e 64 65 78 28 73 71 6c 69 74 65 33 5f 73  _index(sqlite3_s
2cb20 74 6d 74 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72  tmt*, const char
2cb30 20 2a 7a 4e 61 6d 65 29 3b 0a 0a 2f 2a 0a 2a 2a   *zName);../*.**
2cb40 20 43 41 50 49 33 52 45 46 3a 20 52 65 73 65 74   CAPI3REF: Reset
2cb50 20 41 6c 6c 20 42 69 6e 64 69 6e 67 73 20 4f 6e   All Bindings On
2cb60 20 41 20 50 72 65 70 61 72 65 64 20 53 74 61 74   A Prepared Stat
2cb70 65 6d 65 6e 74 0a 2a 2a 20 4d 45 54 48 4f 44 3a  ement.** METHOD:
2cb80 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a   sqlite3_stmt.**
2cb90 0a 2a 2a 20 5e 43 6f 6e 74 72 61 72 79 20 74 6f  .** ^Contrary to
2cba0 20 74 68 65 20 69 6e 74 75 69 74 69 6f 6e 20 6f   the intuition o
2cbb0 66 20 6d 61 6e 79 2c 20 5b 73 71 6c 69 74 65 33  f many, [sqlite3
2cbc0 5f 72 65 73 65 74 28 29 5d 20 64 6f 65 73 20 6e  _reset()] does n
2cbd0 6f 74 20 72 65 73 65 74 0a 2a 2a 20 74 68 65 20  ot reset.** the 
2cbe0 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 62 6c  [sqlite3_bind_bl
2cbf0 6f 62 20 7c 20 62 69 6e 64 69 6e 67 73 5d 20 6f  ob | bindings] o
2cc00 6e 20 61 20 5b 70 72 65 70 61 72 65 64 20 73 74  n a [prepared st
2cc10 61 74 65 6d 65 6e 74 5d 2e 0a 2a 2a 20 5e 55 73  atement]..** ^Us
2cc20 65 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 74  e this routine t
2cc30 6f 20 72 65 73 65 74 20 61 6c 6c 20 68 6f 73 74  o reset all host
2cc40 20 70 61 72 61 6d 65 74 65 72 73 20 74 6f 20 4e   parameters to N
2cc50 55 4c 4c 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69  ULL..*/.int sqli
2cc60 74 65 33 5f 63 6c 65 61 72 5f 62 69 6e 64 69 6e  te3_clear_bindin
2cc70 67 73 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a  gs(sqlite3_stmt*
2cc80 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
2cc90 45 46 3a 20 4e 75 6d 62 65 72 20 4f 66 20 43 6f  EF: Number Of Co
2cca0 6c 75 6d 6e 73 20 49 6e 20 41 20 52 65 73 75 6c  lumns In A Resul
2ccb0 74 20 53 65 74 0a 2a 2a 20 4d 45 54 48 4f 44 3a  t Set.** METHOD:
2ccc0 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 0a 2a 2a   sqlite3_stmt.**
2ccd0 0a 2a 2a 20 5e 52 65 74 75 72 6e 20 74 68 65 20  .** ^Return the 
2cce0 6e 75 6d 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e  number of column
2ccf0 73 20 69 6e 20 74 68 65 20 72 65 73 75 6c 74 20  s in the result 
2cd00 73 65 74 20 72 65 74 75 72 6e 65 64 20 62 79 20  set returned by 
2cd10 74 68 65 0a 2a 2a 20 5b 70 72 65 70 61 72 65 64  the.** [prepared
2cd20 20 73 74 61 74 65 6d 65 6e 74 5d 2e 20 5e 54 68   statement]. ^Th
2cd30 69 73 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72  is routine retur
2cd40 6e 73 20 30 20 69 66 20 70 53 74 6d 74 20 69 73  ns 0 if pStmt is
2cd50 20 61 6e 20 53 51 4c 0a 2a 2a 20 73 74 61 74 65   an SQL.** state
2cd60 6d 65 6e 74 20 74 68 61 74 20 64 6f 65 73 20 6e  ment that does n
2cd70 6f 74 20 72 65 74 75 72 6e 20 64 61 74 61 20 28  ot return data (
2cd80 66 6f 72 20 65 78 61 6d 70 6c 65 20 61 6e 20 5b  for example an [
2cd90 55 50 44 41 54 45 5d 29 2e 0a 2a 2a 0a 2a 2a 20  UPDATE])..**.** 
2cda0 53 65 65 20 61 6c 73 6f 3a 20 5b 73 71 6c 69 74  See also: [sqlit
2cdb0 65 33 5f 64 61 74 61 5f 63 6f 75 6e 74 28 29 5d  e3_data_count()]
2cdc0 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .*/.int sqlite3_
2cdd0 63 6f 6c 75 6d 6e 5f 63 6f 75 6e 74 28 73 71 6c  column_count(sql
2cde0 69 74 65 33 5f 73 74 6d 74 20 2a 70 53 74 6d 74  ite3_stmt *pStmt
2cdf0 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
2ce00 45 46 3a 20 43 6f 6c 75 6d 6e 20 4e 61 6d 65 73  EF: Column Names
2ce10 20 49 6e 20 41 20 52 65 73 75 6c 74 20 53 65 74   In A Result Set
2ce20 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69  .** METHOD: sqli
2ce30 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e  te3_stmt.**.** ^
2ce40 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 72  These routines r
2ce50 65 74 75 72 6e 20 74 68 65 20 6e 61 6d 65 20 61  eturn the name a
2ce60 73 73 69 67 6e 65 64 20 74 6f 20 61 20 70 61 72  ssigned to a par
2ce70 74 69 63 75 6c 61 72 20 63 6f 6c 75 6d 6e 0a 2a  ticular column.*
2ce80 2a 20 69 6e 20 74 68 65 20 72 65 73 75 6c 74 20  * in the result 
2ce90 73 65 74 20 6f 66 20 61 20 5b 53 45 4c 45 43 54  set of a [SELECT
2cea0 5d 20 73 74 61 74 65 6d 65 6e 74 2e 20 20 5e 54  ] statement.  ^T
2ceb0 68 65 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  he sqlite3_colum
2cec0 6e 5f 6e 61 6d 65 28 29 0a 2a 2a 20 69 6e 74 65  n_name().** inte
2ced0 72 66 61 63 65 20 72 65 74 75 72 6e 73 20 61 20  rface returns a 
2cee0 70 6f 69 6e 74 65 72 20 74 6f 20 61 20 7a 65 72  pointer to a zer
2cef0 6f 2d 74 65 72 6d 69 6e 61 74 65 64 20 55 54 46  o-terminated UTF
2cf00 2d 38 20 73 74 72 69 6e 67 0a 2a 2a 20 61 6e 64  -8 string.** and
2cf10 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
2cf20 6e 61 6d 65 31 36 28 29 20 72 65 74 75 72 6e 73  name16() returns
2cf30 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20   a pointer to a 
2cf40 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 0a  zero-terminated.
2cf50 2a 2a 20 55 54 46 2d 31 36 20 73 74 72 69 6e 67  ** UTF-16 string
2cf60 2e 20 20 5e 54 68 65 20 66 69 72 73 74 20 70 61  .  ^The first pa
2cf70 72 61 6d 65 74 65 72 20 69 73 20 74 68 65 20 5b  rameter is the [
2cf80 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
2cf90 6e 74 5d 0a 2a 2a 20 74 68 61 74 20 69 6d 70 6c  nt].** that impl
2cfa0 65 6d 65 6e 74 73 20 74 68 65 20 5b 53 45 4c 45  ements the [SELE
2cfb0 43 54 5d 20 73 74 61 74 65 6d 65 6e 74 2e 20 5e  CT] statement. ^
2cfc0 54 68 65 20 73 65 63 6f 6e 64 20 70 61 72 61 6d  The second param
2cfd0 65 74 65 72 20 69 73 20 74 68 65 0a 2a 2a 20 63  eter is the.** c
2cfe0 6f 6c 75 6d 6e 20 6e 75 6d 62 65 72 2e 20 20 5e  olumn number.  ^
2cff0 54 68 65 20 6c 65 66 74 6d 6f 73 74 20 63 6f 6c  The leftmost col
2d000 75 6d 6e 20 69 73 20 6e 75 6d 62 65 72 20 30 2e  umn is number 0.
2d010 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 72 65 74 75  .**.** ^The retu
2d020 72 6e 65 64 20 73 74 72 69 6e 67 20 70 6f 69 6e  rned string poin
2d030 74 65 72 20 69 73 20 76 61 6c 69 64 20 75 6e 74  ter is valid unt
2d040 69 6c 20 65 69 74 68 65 72 20 74 68 65 20 5b 70  il either the [p
2d050 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e  repared statemen
2d060 74 5d 0a 2a 2a 20 69 73 20 64 65 73 74 72 6f 79  t].** is destroy
2d070 65 64 20 62 79 20 5b 73 71 6c 69 74 65 33 5f 66  ed by [sqlite3_f
2d080 69 6e 61 6c 69 7a 65 28 29 5d 20 6f 72 20 75 6e  inalize()] or un
2d090 74 69 6c 20 74 68 65 20 73 74 61 74 65 6d 65 6e  til the statemen
2d0a0 74 20 69 73 20 61 75 74 6f 6d 61 74 69 63 61 6c  t is automatical
2d0b0 6c 79 0a 2a 2a 20 72 65 70 72 65 70 61 72 65 64  ly.** reprepared
2d0c0 20 62 79 20 74 68 65 20 66 69 72 73 74 20 63 61   by the first ca
2d0d0 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 73  ll to [sqlite3_s
2d0e0 74 65 70 28 29 5d 20 66 6f 72 20 61 20 70 61 72  tep()] for a par
2d0f0 74 69 63 75 6c 61 72 20 72 75 6e 0a 2a 2a 20 6f  ticular run.** o
2d100 72 20 75 6e 74 69 6c 20 74 68 65 20 6e 65 78 74  r until the next
2d110 20 63 61 6c 6c 20 74 6f 0a 2a 2a 20 73 71 6c 69   call to.** sqli
2d120 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6e 61 6d 65 28  te3_column_name(
2d130 29 20 6f 72 20 73 71 6c 69 74 65 33 5f 63 6f 6c  ) or sqlite3_col
2d140 75 6d 6e 5f 6e 61 6d 65 31 36 28 29 20 6f 6e 20  umn_name16() on 
2d150 74 68 65 20 73 61 6d 65 20 63 6f 6c 75 6d 6e 2e  the same column.
2d160 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 73 71 6c 69 74  .**.** ^If sqlit
2d170 65 33 5f 6d 61 6c 6c 6f 63 28 29 20 66 61 69 6c  e3_malloc() fail
2d180 73 20 64 75 72 69 6e 67 20 74 68 65 20 70 72 6f  s during the pro
2d190 63 65 73 73 69 6e 67 20 6f 66 20 65 69 74 68 65  cessing of eithe
2d1a0 72 20 72 6f 75 74 69 6e 65 0a 2a 2a 20 28 66 6f  r routine.** (fo
2d1b0 72 20 65 78 61 6d 70 6c 65 20 64 75 72 69 6e 67  r example during
2d1c0 20 61 20 63 6f 6e 76 65 72 73 69 6f 6e 20 66 72   a conversion fr
2d1d0 6f 6d 20 55 54 46 2d 38 20 74 6f 20 55 54 46 2d  om UTF-8 to UTF-
2d1e0 31 36 29 20 74 68 65 6e 20 61 0a 2a 2a 20 4e 55  16) then a.** NU
2d1f0 4c 4c 20 70 6f 69 6e 74 65 72 20 69 73 20 72 65  LL pointer is re
2d200 74 75 72 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54  turned..**.** ^T
2d210 68 65 20 6e 61 6d 65 20 6f 66 20 61 20 72 65 73  he name of a res
2d220 75 6c 74 20 63 6f 6c 75 6d 6e 20 69 73 20 74 68  ult column is th
2d230 65 20 76 61 6c 75 65 20 6f 66 20 74 68 65 20 22  e value of the "
2d240 41 53 22 20 63 6c 61 75 73 65 20 66 6f 72 0a 2a  AS" clause for.*
2d250 2a 20 74 68 61 74 20 63 6f 6c 75 6d 6e 2c 20 69  * that column, i
2d260 66 20 74 68 65 72 65 20 69 73 20 61 6e 20 41 53  f there is an AS
2d270 20 63 6c 61 75 73 65 2e 20 20 49 66 20 74 68 65   clause.  If the
2d280 72 65 20 69 73 20 6e 6f 20 41 53 20 63 6c 61 75  re is no AS clau
2d290 73 65 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20 6e  se.** then the n
2d2a0 61 6d 65 20 6f 66 20 74 68 65 20 63 6f 6c 75 6d  ame of the colum
2d2b0 6e 20 69 73 20 75 6e 73 70 65 63 69 66 69 65 64  n is unspecified
2d2c0 20 61 6e 64 20 6d 61 79 20 63 68 61 6e 67 65 20   and may change 
2d2d0 66 72 6f 6d 0a 2a 2a 20 6f 6e 65 20 72 65 6c 65  from.** one rele
2d2e0 61 73 65 20 6f 66 20 53 51 4c 69 74 65 20 74 6f  ase of SQLite to
2d2f0 20 74 68 65 20 6e 65 78 74 2e 0a 2a 2f 0a 63 6f   the next..*/.co
2d300 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65  nst char *sqlite
2d310 33 5f 63 6f 6c 75 6d 6e 5f 6e 61 6d 65 28 73 71  3_column_name(sq
2d320 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74  lite3_stmt*, int
2d330 20 4e 29 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20   N);.const void 
2d340 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f  *sqlite3_column_
2d350 6e 61 6d 65 31 36 28 73 71 6c 69 74 65 33 5f 73  name16(sqlite3_s
2d360 74 6d 74 2a 2c 20 69 6e 74 20 4e 29 3b 0a 0a 2f  tmt*, int N);../
2d370 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 53  *.** CAPI3REF: S
2d380 6f 75 72 63 65 20 4f 66 20 44 61 74 61 20 49 6e  ource Of Data In
2d390 20 41 20 51 75 65 72 79 20 52 65 73 75 6c 74 0a   A Query Result.
2d3a0 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74  ** METHOD: sqlit
2d3b0 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54  e3_stmt.**.** ^T
2d3c0 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 70 72  hese routines pr
2d3d0 6f 76 69 64 65 20 61 20 6d 65 61 6e 73 20 74 6f  ovide a means to
2d3e0 20 64 65 74 65 72 6d 69 6e 65 20 74 68 65 20 64   determine the d
2d3f0 61 74 61 62 61 73 65 2c 20 74 61 62 6c 65 2c 20  atabase, table, 
2d400 61 6e 64 0a 2a 2a 20 74 61 62 6c 65 20 63 6f 6c  and.** table col
2d410 75 6d 6e 20 74 68 61 74 20 69 73 20 74 68 65 20  umn that is the 
2d420 6f 72 69 67 69 6e 20 6f 66 20 61 20 70 61 72 74  origin of a part
2d430 69 63 75 6c 61 72 20 72 65 73 75 6c 74 20 63 6f  icular result co
2d440 6c 75 6d 6e 20 69 6e 0a 2a 2a 20 5b 53 45 4c 45  lumn in.** [SELE
2d450 43 54 5d 20 73 74 61 74 65 6d 65 6e 74 2e 0a 2a  CT] statement..*
2d460 2a 20 5e 54 68 65 20 6e 61 6d 65 20 6f 66 20 74  * ^The name of t
2d470 68 65 20 64 61 74 61 62 61 73 65 20 6f 72 20 74  he database or t
2d480 61 62 6c 65 20 6f 72 20 63 6f 6c 75 6d 6e 20 63  able or column c
2d490 61 6e 20 62 65 20 72 65 74 75 72 6e 65 64 20 61  an be returned a
2d4a0 73 0a 2a 2a 20 65 69 74 68 65 72 20 61 20 55 54  s.** either a UT
2d4b0 46 2d 38 20 6f 72 20 55 54 46 2d 31 36 20 73 74  F-8 or UTF-16 st
2d4c0 72 69 6e 67 2e 20 20 5e 54 68 65 20 5f 64 61 74  ring.  ^The _dat
2d4d0 61 62 61 73 65 5f 20 72 6f 75 74 69 6e 65 73 20  abase_ routines 
2d4e0 72 65 74 75 72 6e 0a 2a 2a 20 74 68 65 20 64 61  return.** the da
2d4f0 74 61 62 61 73 65 20 6e 61 6d 65 2c 20 74 68 65  tabase name, the
2d500 20 5f 74 61 62 6c 65 5f 20 72 6f 75 74 69 6e 65   _table_ routine
2d510 73 20 72 65 74 75 72 6e 20 74 68 65 20 74 61 62  s return the tab
2d520 6c 65 20 6e 61 6d 65 2c 20 61 6e 64 0a 2a 2a 20  le name, and.** 
2d530 74 68 65 20 6f 72 69 67 69 6e 5f 20 72 6f 75 74  the origin_ rout
2d540 69 6e 65 73 20 72 65 74 75 72 6e 20 74 68 65 20  ines return the 
2d550 63 6f 6c 75 6d 6e 20 6e 61 6d 65 2e 0a 2a 2a 20  column name..** 
2d560 5e 54 68 65 20 72 65 74 75 72 6e 65 64 20 73 74  ^The returned st
2d570 72 69 6e 67 20 69 73 20 76 61 6c 69 64 20 75 6e  ring is valid un
2d580 74 69 6c 20 74 68 65 20 5b 70 72 65 70 61 72 65  til the [prepare
2d590 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 69 73 20  d statement] is 
2d5a0 64 65 73 74 72 6f 79 65 64 0a 2a 2a 20 75 73 69  destroyed.** usi
2d5b0 6e 67 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e 61  ng [sqlite3_fina
2d5c0 6c 69 7a 65 28 29 5d 20 6f 72 20 75 6e 74 69 6c  lize()] or until
2d5d0 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20 69   the statement i
2d5e0 73 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 0a  s automatically.
2d5f0 2a 2a 20 72 65 70 72 65 70 61 72 65 64 20 62 79  ** reprepared by
2d600 20 74 68 65 20 66 69 72 73 74 20 63 61 6c 6c 20   the first call 
2d610 74 6f 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70  to [sqlite3_step
2d620 28 29 5d 20 66 6f 72 20 61 20 70 61 72 74 69 63  ()] for a partic
2d630 75 6c 61 72 20 72 75 6e 0a 2a 2a 20 6f 72 20 75  ular run.** or u
2d640 6e 74 69 6c 20 74 68 65 20 73 61 6d 65 20 69 6e  ntil the same in
2d650 66 6f 72 6d 61 74 69 6f 6e 20 69 73 20 72 65 71  formation is req
2d660 75 65 73 74 65 64 0a 2a 2a 20 61 67 61 69 6e 20  uested.** again 
2d670 69 6e 20 61 20 64 69 66 66 65 72 65 6e 74 20 65  in a different e
2d680 6e 63 6f 64 69 6e 67 2e 0a 2a 2a 0a 2a 2a 20 5e  ncoding..**.** ^
2d690 54 68 65 20 6e 61 6d 65 73 20 72 65 74 75 72 6e  The names return
2d6a0 65 64 20 61 72 65 20 74 68 65 20 6f 72 69 67 69  ed are the origi
2d6b0 6e 61 6c 20 75 6e 2d 61 6c 69 61 73 65 64 20 6e  nal un-aliased n
2d6c0 61 6d 65 73 20 6f 66 20 74 68 65 0a 2a 2a 20 64  ames of the.** d
2d6d0 61 74 61 62 61 73 65 2c 20 74 61 62 6c 65 2c 20  atabase, table, 
2d6e0 61 6e 64 20 63 6f 6c 75 6d 6e 2e 0a 2a 2a 0a 2a  and column..**.*
2d6f0 2a 20 5e 54 68 65 20 66 69 72 73 74 20 61 72 67  * ^The first arg
2d700 75 6d 65 6e 74 20 74 6f 20 74 68 65 73 65 20 69  ument to these i
2d710 6e 74 65 72 66 61 63 65 73 20 69 73 20 61 20 5b  nterfaces is a [
2d720 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
2d730 6e 74 5d 2e 0a 2a 2a 20 5e 54 68 65 73 65 20 66  nt]..** ^These f
2d740 75 6e 63 74 69 6f 6e 73 20 72 65 74 75 72 6e 20  unctions return 
2d750 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 61 62 6f 75  information abou
2d760 74 20 74 68 65 20 4e 74 68 20 72 65 73 75 6c 74  t the Nth result
2d770 20 63 6f 6c 75 6d 6e 20 72 65 74 75 72 6e 65 64   column returned
2d780 20 62 79 0a 2a 2a 20 74 68 65 20 73 74 61 74 65   by.** the state
2d790 6d 65 6e 74 2c 20 77 68 65 72 65 20 4e 20 69 73  ment, where N is
2d7a0 20 74 68 65 20 73 65 63 6f 6e 64 20 66 75 6e 63   the second func
2d7b0 74 69 6f 6e 20 61 72 67 75 6d 65 6e 74 2e 0a 2a  tion argument..*
2d7c0 2a 20 5e 54 68 65 20 6c 65 66 74 2d 6d 6f 73 74  * ^The left-most
2d7d0 20 63 6f 6c 75 6d 6e 20 69 73 20 63 6f 6c 75 6d   column is colum
2d7e0 6e 20 30 20 66 6f 72 20 74 68 65 73 65 20 72 6f  n 0 for these ro
2d7f0 75 74 69 6e 65 73 2e 0a 2a 2a 0a 2a 2a 20 5e 49  utines..**.** ^I
2d800 66 20 74 68 65 20 4e 74 68 20 63 6f 6c 75 6d 6e  f the Nth column
2d810 20 72 65 74 75 72 6e 65 64 20 62 79 20 74 68 65   returned by the
2d820 20 73 74 61 74 65 6d 65 6e 74 20 69 73 20 61 6e   statement is an
2d830 20 65 78 70 72 65 73 73 69 6f 6e 20 6f 72 0a 2a   expression or.*
2d840 2a 20 73 75 62 71 75 65 72 79 20 61 6e 64 20 69  * subquery and i
2d850 73 20 6e 6f 74 20 61 20 63 6f 6c 75 6d 6e 20 76  s not a column v
2d860 61 6c 75 65 2c 20 74 68 65 6e 20 61 6c 6c 20 6f  alue, then all o
2d870 66 20 74 68 65 73 65 20 66 75 6e 63 74 69 6f 6e  f these function
2d880 73 20 72 65 74 75 72 6e 0a 2a 2a 20 4e 55 4c 4c  s return.** NULL
2d890 2e 20 20 5e 54 68 65 73 65 20 72 6f 75 74 69 6e  .  ^These routin
2d8a0 65 20 6d 69 67 68 74 20 61 6c 73 6f 20 72 65 74  e might also ret
2d8b0 75 72 6e 20 4e 55 4c 4c 20 69 66 20 61 20 6d 65  urn NULL if a me
2d8c0 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20  mory allocation 
2d8d0 65 72 72 6f 72 0a 2a 2a 20 6f 63 63 75 72 73 2e  error.** occurs.
2d8e0 20 20 5e 4f 74 68 65 72 77 69 73 65 2c 20 74 68    ^Otherwise, th
2d8f0 65 79 20 72 65 74 75 72 6e 20 74 68 65 20 6e 61  ey return the na
2d900 6d 65 20 6f 66 20 74 68 65 20 61 74 74 61 63 68  me of the attach
2d910 65 64 20 64 61 74 61 62 61 73 65 2c 20 74 61 62  ed database, tab
2d920 6c 65 2c 0a 2a 2a 20 6f 72 20 63 6f 6c 75 6d 6e  le,.** or column
2d930 20 74 68 61 74 20 71 75 65 72 79 20 72 65 73 75   that query resu
2d940 6c 74 20 63 6f 6c 75 6d 6e 20 77 61 73 20 65 78  lt column was ex
2d950 74 72 61 63 74 65 64 20 66 72 6f 6d 2e 0a 2a 2a  tracted from..**
2d960 0a 2a 2a 20 5e 41 73 20 77 69 74 68 20 61 6c 6c  .** ^As with all
2d970 20 6f 74 68 65 72 20 53 51 4c 69 74 65 20 41 50   other SQLite AP
2d980 49 73 2c 20 74 68 6f 73 65 20 77 68 6f 73 65 20  Is, those whose 
2d990 6e 61 6d 65 73 20 65 6e 64 20 77 69 74 68 20 22  names end with "
2d9a0 31 36 22 20 72 65 74 75 72 6e 0a 2a 2a 20 55 54  16" return.** UT
2d9b0 46 2d 31 36 20 65 6e 63 6f 64 65 64 20 73 74 72  F-16 encoded str
2d9c0 69 6e 67 73 20 61 6e 64 20 74 68 65 20 6f 74 68  ings and the oth
2d9d0 65 72 20 66 75 6e 63 74 69 6f 6e 73 20 72 65 74  er functions ret
2d9e0 75 72 6e 20 55 54 46 2d 38 2e 0a 2a 2a 0a 2a 2a  urn UTF-8..**.**
2d9f0 20 5e 54 68 65 73 65 20 41 50 49 73 20 61 72 65   ^These APIs are
2da00 20 6f 6e 6c 79 20 61 76 61 69 6c 61 62 6c 65 20   only available 
2da10 69 66 20 74 68 65 20 6c 69 62 72 61 72 79 20 77  if the library w
2da20 61 73 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68  as compiled with
2da30 20 74 68 65 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f   the.** [SQLITE_
2da40 45 4e 41 42 4c 45 5f 43 4f 4c 55 4d 4e 5f 4d 45  ENABLE_COLUMN_ME
2da50 54 41 44 41 54 41 5d 20 43 2d 70 72 65 70 72 6f  TADATA] C-prepro
2da60 63 65 73 73 6f 72 20 73 79 6d 62 6f 6c 2e 0a 2a  cessor symbol..*
2da70 2a 0a 2a 2a 20 49 66 20 74 77 6f 20 6f 72 20 6d  *.** If two or m
2da80 6f 72 65 20 74 68 72 65 61 64 73 20 63 61 6c 6c  ore threads call
2da90 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 20 6f 66 20   one or more of 
2daa0 74 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 61  these routines a
2dab0 67 61 69 6e 73 74 20 74 68 65 20 73 61 6d 65 0a  gainst the same.
2dac0 2a 2a 20 70 72 65 70 61 72 65 64 20 73 74 61 74  ** prepared stat
2dad0 65 6d 65 6e 74 20 61 6e 64 20 63 6f 6c 75 6d 6e  ement and column
2dae0 20 61 74 20 74 68 65 20 73 61 6d 65 20 74 69 6d   at the same tim
2daf0 65 20 74 68 65 6e 20 74 68 65 20 72 65 73 75 6c  e then the resul
2db00 74 73 20 61 72 65 0a 2a 2a 20 75 6e 64 65 66 69  ts are.** undefi
2db10 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 74 77  ned..**.** If tw
2db20 6f 20 6f 72 20 6d 6f 72 65 20 74 68 72 65 61 64  o or more thread
2db30 73 20 63 61 6c 6c 20 6f 6e 65 20 6f 72 20 6d 6f  s call one or mo
2db40 72 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63  re.** [sqlite3_c
2db50 6f 6c 75 6d 6e 5f 64 61 74 61 62 61 73 65 5f 6e  olumn_database_n
2db60 61 6d 65 20 7c 20 63 6f 6c 75 6d 6e 20 6d 65 74  ame | column met
2db70 61 64 61 74 61 20 69 6e 74 65 72 66 61 63 65 73  adata interfaces
2db80 5d 0a 2a 2a 20 66 6f 72 20 74 68 65 20 73 61 6d  ].** for the sam
2db90 65 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74  e [prepared stat
2dba0 65 6d 65 6e 74 5d 20 61 6e 64 20 72 65 73 75 6c  ement] and resul
2dbb0 74 20 63 6f 6c 75 6d 6e 0a 2a 2a 20 61 74 20 74  t column.** at t
2dbc0 68 65 20 73 61 6d 65 20 74 69 6d 65 20 74 68 65  he same time the
2dbd0 6e 20 74 68 65 20 72 65 73 75 6c 74 73 20 61 72  n the results ar
2dbe0 65 20 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2f 0a  e undefined..*/.
2dbf0 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 69  const char *sqli
2dc00 74 65 33 5f 63 6f 6c 75 6d 6e 5f 64 61 74 61 62  te3_column_datab
2dc10 61 73 65 5f 6e 61 6d 65 28 73 71 6c 69 74 65 33  ase_name(sqlite3
2dc20 5f 73 74 6d 74 2a 2c 69 6e 74 29 3b 0a 63 6f 6e  _stmt*,int);.con
2dc30 73 74 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33  st void *sqlite3
2dc40 5f 63 6f 6c 75 6d 6e 5f 64 61 74 61 62 61 73 65  _column_database
2dc50 5f 6e 61 6d 65 31 36 28 73 71 6c 69 74 65 33 5f  _name16(sqlite3_
2dc60 73 74 6d 74 2a 2c 69 6e 74 29 3b 0a 63 6f 6e 73  stmt*,int);.cons
2dc70 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f  t char *sqlite3_
2dc80 63 6f 6c 75 6d 6e 5f 74 61 62 6c 65 5f 6e 61 6d  column_table_nam
2dc90 65 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c  e(sqlite3_stmt*,
2dca0 69 6e 74 29 3b 0a 63 6f 6e 73 74 20 76 6f 69 64  int);.const void
2dcb0 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e   *sqlite3_column
2dcc0 5f 74 61 62 6c 65 5f 6e 61 6d 65 31 36 28 73 71  _table_name16(sq
2dcd0 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 69 6e 74 29  lite3_stmt*,int)
2dce0 3b 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 71  ;.const char *sq
2dcf0 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6f 72 69  lite3_column_ori
2dd00 67 69 6e 5f 6e 61 6d 65 28 73 71 6c 69 74 65 33  gin_name(sqlite3
2dd10 5f 73 74 6d 74 2a 2c 69 6e 74 29 3b 0a 63 6f 6e  _stmt*,int);.con
2dd20 73 74 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33  st void *sqlite3
2dd30 5f 63 6f 6c 75 6d 6e 5f 6f 72 69 67 69 6e 5f 6e  _column_origin_n
2dd40 61 6d 65 31 36 28 73 71 6c 69 74 65 33 5f 73 74  ame16(sqlite3_st
2dd50 6d 74 2a 2c 69 6e 74 29 3b 0a 0a 2f 2a 0a 2a 2a  mt*,int);../*.**
2dd60 20 43 41 50 49 33 52 45 46 3a 20 44 65 63 6c 61   CAPI3REF: Decla
2dd70 72 65 64 20 44 61 74 61 74 79 70 65 20 4f 66 20  red Datatype Of 
2dd80 41 20 51 75 65 72 79 20 52 65 73 75 6c 74 0a 2a  A Query Result.*
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 28 54  3_stmt.**.** ^(T
2ddb0 68 65 20 66 69 72 73 74 20 70 61 72 61 6d 65 74  he first paramet
2ddc0 65 72 20 69 73 20 61 20 5b 70 72 65 70 61 72 65  er is a [prepare
2ddd0 64 20 73 74 61 74 65 6d 65 6e 74 5d 2e 0a 2a 2a  d statement]..**
2dde0 20 49 66 20 74 68 69 73 20 73 74 61 74 65 6d 65   If this stateme
2ddf0 6e 74 20 69 73 20 61 20 5b 53 45 4c 45 43 54 5d  nt is a [SELECT]
2de00 20 73 74 61 74 65 6d 65 6e 74 20 61 6e 64 20 74   statement and t
2de10 68 65 20 4e 74 68 20 63 6f 6c 75 6d 6e 20 6f 66  he Nth column of
2de20 20 74 68 65 0a 2a 2a 20 72 65 74 75 72 6e 65 64   the.** returned
2de30 20 72 65 73 75 6c 74 20 73 65 74 20 6f 66 20 74   result set of t
2de40 68 61 74 20 5b 53 45 4c 45 43 54 5d 20 69 73 20  hat [SELECT] is 
2de50 61 20 74 61 62 6c 65 20 63 6f 6c 75 6d 6e 20 28  a table column (
2de60 6e 6f 74 20 61 6e 0a 2a 2a 20 65 78 70 72 65 73  not an.** expres
2de70 73 69 6f 6e 20 6f 72 20 73 75 62 71 75 65 72 79  sion or subquery
2de80 29 20 74 68 65 6e 20 74 68 65 20 64 65 63 6c 61  ) then the decla
2de90 72 65 64 20 74 79 70 65 20 6f 66 20 74 68 65 20  red type of the 
2dea0 74 61 62 6c 65 0a 2a 2a 20 63 6f 6c 75 6d 6e 20  table.** column 
2deb0 69 73 20 72 65 74 75 72 6e 65 64 2e 29 5e 20 20  is returned.)^  
2dec0 5e 49 66 20 74 68 65 20 4e 74 68 20 63 6f 6c 75  ^If the Nth colu
2ded0 6d 6e 20 6f 66 20 74 68 65 20 72 65 73 75 6c 74  mn of the result
2dee0 20 73 65 74 20 69 73 20 61 6e 0a 2a 2a 20 65 78   set is an.** ex
2def0 70 72 65 73 73 69 6f 6e 20 6f 72 20 73 75 62 71  pression or subq
2df00 75 65 72 79 2c 20 74 68 65 6e 20 61 20 4e 55 4c  uery, then a NUL
2df10 4c 20 70 6f 69 6e 74 65 72 20 69 73 20 72 65 74  L pointer is ret
2df20 75 72 6e 65 64 2e 0a 2a 2a 20 5e 54 68 65 20 72  urned..** ^The r
2df30 65 74 75 72 6e 65 64 20 73 74 72 69 6e 67 20 69  eturned string i
2df40 73 20 61 6c 77 61 79 73 20 55 54 46 2d 38 20 65  s always UTF-8 e
2df50 6e 63 6f 64 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 28  ncoded..**.** ^(
2df60 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20 67 69 76  For example, giv
2df70 65 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20  en the database 
2df80 73 63 68 65 6d 61 3a 0a 2a 2a 0a 2a 2a 20 43 52  schema:.**.** CR
2df90 45 41 54 45 20 54 41 42 4c 45 20 74 31 28 63 31  EATE TABLE t1(c1
2dfa0 20 56 41 52 49 41 4e 54 29 3b 0a 2a 2a 0a 2a 2a   VARIANT);.**.**
2dfb0 20 61 6e 64 20 74 68 65 20 66 6f 6c 6c 6f 77 69   and the followi
2dfc0 6e 67 20 73 74 61 74 65 6d 65 6e 74 20 74 6f 20  ng statement to 
2dfd0 62 65 20 63 6f 6d 70 69 6c 65 64 3a 0a 2a 2a 0a  be compiled:.**.
2dfe0 2a 2a 20 53 45 4c 45 43 54 20 63 31 20 2b 20 31  ** SELECT c1 + 1
2dff0 2c 20 63 31 20 46 52 4f 4d 20 74 31 3b 0a 2a 2a  , c1 FROM t1;.**
2e000 0a 2a 2a 20 74 68 69 73 20 72 6f 75 74 69 6e 65  .** this routine
2e010 20 77 6f 75 6c 64 20 72 65 74 75 72 6e 20 74 68   would return th
2e020 65 20 73 74 72 69 6e 67 20 22 56 41 52 49 41 4e  e string "VARIAN
2e030 54 22 20 66 6f 72 20 74 68 65 20 73 65 63 6f 6e  T" for the secon
2e040 64 20 72 65 73 75 6c 74 0a 2a 2a 20 63 6f 6c 75  d result.** colu
2e050 6d 6e 20 28 69 3d 3d 31 29 2c 20 61 6e 64 20 61  mn (i==1), and a
2e060 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 66 6f   NULL pointer fo
2e070 72 20 74 68 65 20 66 69 72 73 74 20 72 65 73 75  r the first resu
2e080 6c 74 20 63 6f 6c 75 6d 6e 20 28 69 3d 3d 30 29  lt column (i==0)
2e090 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 53 51 4c 69 74  .)^.**.** ^SQLit
2e0a0 65 20 75 73 65 73 20 64 79 6e 61 6d 69 63 20 72  e uses dynamic r
2e0b0 75 6e 2d 74 69 6d 65 20 74 79 70 69 6e 67 2e 20  un-time typing. 
2e0c0 20 5e 53 6f 20 6a 75 73 74 20 62 65 63 61 75 73   ^So just becaus
2e0d0 65 20 61 20 63 6f 6c 75 6d 6e 0a 2a 2a 20 69 73  e a column.** is
2e0e0 20 64 65 63 6c 61 72 65 64 20 74 6f 20 63 6f 6e   declared to con
2e0f0 74 61 69 6e 20 61 20 70 61 72 74 69 63 75 6c 61  tain a particula
2e100 72 20 74 79 70 65 20 64 6f 65 73 20 6e 6f 74 20  r type does not 
2e110 6d 65 61 6e 20 74 68 61 74 20 74 68 65 0a 2a 2a  mean that the.**
2e120 20 64 61 74 61 20 73 74 6f 72 65 64 20 69 6e 20   data stored in 
2e130 74 68 61 74 20 63 6f 6c 75 6d 6e 20 69 73 20 6f  that column is o
2e140 66 20 74 68 65 20 64 65 63 6c 61 72 65 64 20 74  f the declared t
2e150 79 70 65 2e 20 20 53 51 4c 69 74 65 20 69 73 0a  ype.  SQLite is.
2e160 2a 2a 20 73 74 72 6f 6e 67 6c 79 20 74 79 70 65  ** strongly type
2e170 64 2c 20 62 75 74 20 74 68 65 20 74 79 70 69 6e  d, but the typin
2e180 67 20 69 73 20 64 79 6e 61 6d 69 63 20 6e 6f 74  g is dynamic not
2e190 20 73 74 61 74 69 63 2e 20 20 5e 54 79 70 65 0a   static.  ^Type.
2e1a0 2a 2a 20 69 73 20 61 73 73 6f 63 69 61 74 65 64  ** is associated
2e1b0 20 77 69 74 68 20 69 6e 64 69 76 69 64 75 61 6c   with individual
2e1c0 20 76 61 6c 75 65 73 2c 20 6e 6f 74 20 77 69 74   values, not wit
2e1d0 68 20 74 68 65 20 63 6f 6e 74 61 69 6e 65 72 73  h the containers
2e1e0 0a 2a 2a 20 75 73 65 64 20 74 6f 20 68 6f 6c 64  .** used to hold
2e1f0 20 74 68 6f 73 65 20 76 61 6c 75 65 73 2e 0a 2a   those values..*
2e200 2f 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 71  /.const char *sq
2e210 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 64 65 63  lite3_column_dec
2e220 6c 74 79 70 65 28 73 71 6c 69 74 65 33 5f 73 74  ltype(sqlite3_st
2e230 6d 74 2a 2c 69 6e 74 29 3b 0a 63 6f 6e 73 74 20  mt*,int);.const 
2e240 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 63 6f  void *sqlite3_co
2e250 6c 75 6d 6e 5f 64 65 63 6c 74 79 70 65 31 36 28  lumn_decltype16(
2e260 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 69 6e  sqlite3_stmt*,in
2e270 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  t);../*.** CAPI3
2e280 52 45 46 3a 20 45 76 61 6c 75 61 74 65 20 41 6e  REF: Evaluate An
2e290 20 53 51 4c 20 53 74 61 74 65 6d 65 6e 74 0a 2a   SQL Statement.*
2e2a0 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65  * METHOD: sqlite
2e2b0 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 41 66 74  3_stmt.**.** Aft
2e2c0 65 72 20 61 20 5b 70 72 65 70 61 72 65 64 20 73  er a [prepared s
2e2d0 74 61 74 65 6d 65 6e 74 5d 20 68 61 73 20 62 65  tatement] has be
2e2e0 65 6e 20 70 72 65 70 61 72 65 64 20 75 73 69 6e  en prepared usin
2e2f0 67 20 65 69 74 68 65 72 0a 2a 2a 20 5b 73 71 6c  g either.** [sql
2e300 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76 32 28  ite3_prepare_v2(
2e310 29 5d 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f 70  )] or [sqlite3_p
2e320 72 65 70 61 72 65 31 36 5f 76 32 28 29 5d 20 6f  repare16_v2()] o
2e330 72 20 6f 6e 65 20 6f 66 20 74 68 65 20 6c 65 67  r one of the leg
2e340 61 63 79 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65  acy.** interface
2e350 73 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61  s [sqlite3_prepa
2e360 72 65 28 29 5d 20 6f 72 20 5b 73 71 6c 69 74 65  re()] or [sqlite
2e370 33 5f 70 72 65 70 61 72 65 31 36 28 29 5d 2c 20  3_prepare16()], 
2e380 74 68 69 73 20 66 75 6e 63 74 69 6f 6e 0a 2a 2a  this function.**
2e390 20 6d 75 73 74 20 62 65 20 63 61 6c 6c 65 64 20   must be called 
2e3a0 6f 6e 65 20 6f 72 20 6d 6f 72 65 20 74 69 6d 65  one or more time
2e3b0 73 20 74 6f 20 65 76 61 6c 75 61 74 65 20 74 68  s to evaluate th
2e3c0 65 20 73 74 61 74 65 6d 65 6e 74 2e 0a 2a 2a 0a  e statement..**.
2e3d0 2a 2a 20 54 68 65 20 64 65 74 61 69 6c 73 20 6f  ** The details o
2e3e0 66 20 74 68 65 20 62 65 68 61 76 69 6f 72 20 6f  f the behavior o
2e3f0 66 20 74 68 65 20 73 71 6c 69 74 65 33 5f 73 74  f the sqlite3_st
2e400 65 70 28 29 20 69 6e 74 65 72 66 61 63 65 20 64  ep() interface d
2e410 65 70 65 6e 64 0a 2a 2a 20 6f 6e 20 77 68 65 74  epend.** on whet
2e420 68 65 72 20 74 68 65 20 73 74 61 74 65 6d 65 6e  her the statemen
2e430 74 20 77 61 73 20 70 72 65 70 61 72 65 64 20 75  t was prepared u
2e440 73 69 6e 67 20 74 68 65 20 6e 65 77 65 72 20 22  sing the newer "
2e450 76 32 22 20 69 6e 74 65 72 66 61 63 65 0a 2a 2a  v2" interface.**
2e460 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72   [sqlite3_prepar
2e470 65 5f 76 32 28 29 5d 20 61 6e 64 20 5b 73 71 6c  e_v2()] and [sql
2e480 69 74 65 33 5f 70 72 65 70 61 72 65 31 36 5f 76  ite3_prepare16_v
2e490 32 28 29 5d 20 6f 72 20 74 68 65 20 6f 6c 64 65  2()] or the olde
2e4a0 72 20 6c 65 67 61 63 79 0a 2a 2a 20 69 6e 74 65  r legacy.** inte
2e4b0 72 66 61 63 65 20 5b 73 71 6c 69 74 65 33 5f 70  rface [sqlite3_p
2e4c0 72 65 70 61 72 65 28 29 5d 20 61 6e 64 20 5b 73  repare()] and [s
2e4d0 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 31 36  qlite3_prepare16
2e4e0 28 29 5d 2e 20 20 54 68 65 20 75 73 65 20 6f 66  ()].  The use of
2e4f0 20 74 68 65 0a 2a 2a 20 6e 65 77 20 22 76 32 22   the.** new "v2"
2e500 20 69 6e 74 65 72 66 61 63 65 20 69 73 20 72 65   interface is re
2e510 63 6f 6d 6d 65 6e 64 65 64 20 66 6f 72 20 6e 65  commended for ne
2e520 77 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 62  w applications b
2e530 75 74 20 74 68 65 20 6c 65 67 61 63 79 0a 2a 2a  ut the legacy.**
2e540 20 69 6e 74 65 72 66 61 63 65 20 77 69 6c 6c 20   interface will 
2e550 63 6f 6e 74 69 6e 75 65 20 74 6f 20 62 65 20 73  continue to be s
2e560 75 70 70 6f 72 74 65 64 2e 0a 2a 2a 0a 2a 2a 20  upported..**.** 
2e570 5e 49 6e 20 74 68 65 20 6c 65 67 61 63 79 20 69  ^In the legacy i
2e580 6e 74 65 72 66 61 63 65 2c 20 74 68 65 20 72 65  nterface, the re
2e590 74 75 72 6e 20 76 61 6c 75 65 20 77 69 6c 6c 20  turn value will 
2e5a0 62 65 20 65 69 74 68 65 72 20 5b 53 51 4c 49 54  be either [SQLIT
2e5b0 45 5f 42 55 53 59 5d 2c 0a 2a 2a 20 5b 53 51 4c  E_BUSY],.** [SQL
2e5c0 49 54 45 5f 44 4f 4e 45 5d 2c 20 5b 53 51 4c 49  ITE_DONE], [SQLI
2e5d0 54 45 5f 52 4f 57 5d 2c 20 5b 53 51 4c 49 54 45  TE_ROW], [SQLITE
2e5e0 5f 45 52 52 4f 52 5d 2c 20 6f 72 20 5b 53 51 4c  _ERROR], or [SQL
2e5f0 49 54 45 5f 4d 49 53 55 53 45 5d 2e 0a 2a 2a 20  ITE_MISUSE]..** 
2e600 5e 57 69 74 68 20 74 68 65 20 22 76 32 22 20 69  ^With the "v2" i
2e610 6e 74 65 72 66 61 63 65 2c 20 61 6e 79 20 6f 66  nterface, any of
2e620 20 74 68 65 20 6f 74 68 65 72 20 5b 72 65 73 75   the other [resu
2e630 6c 74 20 63 6f 64 65 73 5d 20 6f 72 0a 2a 2a 20  lt codes] or.** 
2e640 5b 65 78 74 65 6e 64 65 64 20 72 65 73 75 6c 74  [extended result
2e650 20 63 6f 64 65 73 5d 20 6d 69 67 68 74 20 62 65   codes] might be
2e660 20 72 65 74 75 72 6e 65 64 20 61 73 20 77 65 6c   returned as wel
2e670 6c 2e 0a 2a 2a 0a 2a 2a 20 5e 5b 53 51 4c 49 54  l..**.** ^[SQLIT
2e680 45 5f 42 55 53 59 5d 20 6d 65 61 6e 73 20 74 68  E_BUSY] means th
2e690 61 74 20 74 68 65 20 64 61 74 61 62 61 73 65 20  at the database 
2e6a0 65 6e 67 69 6e 65 20 77 61 73 20 75 6e 61 62 6c  engine was unabl
2e6b0 65 20 74 6f 20 61 63 71 75 69 72 65 20 74 68 65  e to acquire the
2e6c0 0a 2a 2a 20 64 61 74 61 62 61 73 65 20 6c 6f 63  .** database loc
2e6d0 6b 73 20 69 74 20 6e 65 65 64 73 20 74 6f 20 64  ks it needs to d
2e6e0 6f 20 69 74 73 20 6a 6f 62 2e 20 20 5e 49 66 20  o its job.  ^If 
2e6f0 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20 69 73  the statement is
2e700 20 61 20 5b 43 4f 4d 4d 49 54 5d 0a 2a 2a 20 6f   a [COMMIT].** o
2e710 72 20 6f 63 63 75 72 73 20 6f 75 74 73 69 64 65  r occurs outside
2e720 20 6f 66 20 61 6e 20 65 78 70 6c 69 63 69 74 20   of an explicit 
2e730 74 72 61 6e 73 61 63 74 69 6f 6e 2c 20 74 68 65  transaction, the
2e740 6e 20 79 6f 75 20 63 61 6e 20 72 65 74 72 79 20  n you can retry 
2e750 74 68 65 0a 2a 2a 20 73 74 61 74 65 6d 65 6e 74  the.** statement
2e760 2e 20 20 49 66 20 74 68 65 20 73 74 61 74 65 6d  .  If the statem
2e770 65 6e 74 20 69 73 20 6e 6f 74 20 61 20 5b 43 4f  ent is not a [CO
2e780 4d 4d 49 54 5d 20 61 6e 64 20 6f 63 63 75 72 73  MMIT] and occurs
2e790 20 77 69 74 68 69 6e 20 61 6e 0a 2a 2a 20 65 78   within an.** ex
2e7a0 70 6c 69 63 69 74 20 74 72 61 6e 73 61 63 74 69  plicit transacti
2e7b0 6f 6e 20 74 68 65 6e 20 79 6f 75 20 73 68 6f 75  on then you shou
2e7c0 6c 64 20 72 6f 6c 6c 62 61 63 6b 20 74 68 65 20  ld rollback the 
2e7d0 74 72 61 6e 73 61 63 74 69 6f 6e 20 62 65 66 6f  transaction befo
2e7e0 72 65 0a 2a 2a 20 63 6f 6e 74 69 6e 75 69 6e 67  re.** continuing
2e7f0 2e 0a 2a 2a 0a 2a 2a 20 5e 5b 53 51 4c 49 54 45  ..**.** ^[SQLITE
2e800 5f 44 4f 4e 45 5d 20 6d 65 61 6e 73 20 74 68 61  _DONE] means tha
2e810 74 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20  t the statement 
2e820 68 61 73 20 66 69 6e 69 73 68 65 64 20 65 78 65  has finished exe
2e830 63 75 74 69 6e 67 0a 2a 2a 20 73 75 63 63 65 73  cuting.** succes
2e840 73 66 75 6c 6c 79 2e 20 20 73 71 6c 69 74 65 33  sfully.  sqlite3
2e850 5f 73 74 65 70 28 29 20 73 68 6f 75 6c 64 20 6e  _step() should n
2e860 6f 74 20 62 65 20 63 61 6c 6c 65 64 20 61 67 61  ot be called aga
2e870 69 6e 20 6f 6e 20 74 68 69 73 20 76 69 72 74 75  in on this virtu
2e880 61 6c 0a 2a 2a 20 6d 61 63 68 69 6e 65 20 77 69  al.** machine wi
2e890 74 68 6f 75 74 20 66 69 72 73 74 20 63 61 6c 6c  thout first call
2e8a0 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 72 65 73  ing [sqlite3_res
2e8b0 65 74 28 29 5d 20 74 6f 20 72 65 73 65 74 20 74  et()] to reset t
2e8c0 68 65 20 76 69 72 74 75 61 6c 0a 2a 2a 20 6d 61  he virtual.** ma
2e8d0 63 68 69 6e 65 20 62 61 63 6b 20 74 6f 20 69 74  chine back to it
2e8e0 73 20 69 6e 69 74 69 61 6c 20 73 74 61 74 65 2e  s initial state.
2e8f0 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 53  .**.** ^If the S
2e900 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 62 65 69  QL statement bei
2e910 6e 67 20 65 78 65 63 75 74 65 64 20 72 65 74 75  ng executed retu
2e920 72 6e 73 20 61 6e 79 20 64 61 74 61 2c 20 74 68  rns any data, th
2e930 65 6e 20 5b 53 51 4c 49 54 45 5f 52 4f 57 5d 0a  en [SQLITE_ROW].
2e940 2a 2a 20 69 73 20 72 65 74 75 72 6e 65 64 20 65  ** is returned e
2e950 61 63 68 20 74 69 6d 65 20 61 20 6e 65 77 20 72  ach time a new r
2e960 6f 77 20 6f 66 20 64 61 74 61 20 69 73 20 72 65  ow of data is re
2e970 61 64 79 20 66 6f 72 20 70 72 6f 63 65 73 73 69  ady for processi
2e980 6e 67 20 62 79 20 74 68 65 0a 2a 2a 20 63 61 6c  ng by the.** cal
2e990 6c 65 72 2e 20 54 68 65 20 76 61 6c 75 65 73 20  ler. The values 
2e9a0 6d 61 79 20 62 65 20 61 63 63 65 73 73 65 64 20  may be accessed 
2e9b0 75 73 69 6e 67 20 74 68 65 20 5b 63 6f 6c 75 6d  using the [colum
2e9c0 6e 20 61 63 63 65 73 73 20 66 75 6e 63 74 69 6f  n access functio
2e9d0 6e 73 5d 2e 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  ns]..** sqlite3_
2e9e0 73 74 65 70 28 29 20 69 73 20 63 61 6c 6c 65 64  step() is called
2e9f0 20 61 67 61 69 6e 20 74 6f 20 72 65 74 72 69 65   again to retrie
2ea00 76 65 20 74 68 65 20 6e 65 78 74 20 72 6f 77 20  ve the next row 
2ea10 6f 66 20 64 61 74 61 2e 0a 2a 2a 0a 2a 2a 20 5e  of data..**.** ^
2ea20 5b 53 51 4c 49 54 45 5f 45 52 52 4f 52 5d 20 6d  [SQLITE_ERROR] m
2ea30 65 61 6e 73 20 74 68 61 74 20 61 20 72 75 6e 2d  eans that a run-
2ea40 74 69 6d 65 20 65 72 72 6f 72 20 28 73 75 63 68  time error (such
2ea50 20 61 73 20 61 20 63 6f 6e 73 74 72 61 69 6e 74   as a constraint
2ea60 0a 2a 2a 20 76 69 6f 6c 61 74 69 6f 6e 29 20 68  .** violation) h
2ea70 61 73 20 6f 63 63 75 72 72 65 64 2e 20 20 73 71  as occurred.  sq
2ea80 6c 69 74 65 33 5f 73 74 65 70 28 29 20 73 68 6f  lite3_step() sho
2ea90 75 6c 64 20 6e 6f 74 20 62 65 20 63 61 6c 6c 65  uld not be calle
2eaa0 64 20 61 67 61 69 6e 20 6f 6e 0a 2a 2a 20 74 68  d again on.** th
2eab0 65 20 56 4d 2e 20 4d 6f 72 65 20 69 6e 66 6f 72  e VM. More infor
2eac0 6d 61 74 69 6f 6e 20 6d 61 79 20 62 65 20 66 6f  mation may be fo
2ead0 75 6e 64 20 62 79 20 63 61 6c 6c 69 6e 67 20 5b  und by calling [
2eae0 73 71 6c 69 74 65 33 5f 65 72 72 6d 73 67 28 29  sqlite3_errmsg()
2eaf0 5d 2e 0a 2a 2a 20 5e 57 69 74 68 20 74 68 65 20  ]..** ^With the 
2eb00 6c 65 67 61 63 79 20 69 6e 74 65 72 66 61 63 65  legacy interface
2eb10 2c 20 61 20 6d 6f 72 65 20 73 70 65 63 69 66 69  , a more specifi
2eb20 63 20 65 72 72 6f 72 20 63 6f 64 65 20 28 66 6f  c error code (fo
2eb30 72 20 65 78 61 6d 70 6c 65 2c 0a 2a 2a 20 5b 53  r example,.** [S
2eb40 51 4c 49 54 45 5f 49 4e 54 45 52 52 55 50 54 5d  QLITE_INTERRUPT]
2eb50 2c 20 5b 53 51 4c 49 54 45 5f 53 43 48 45 4d 41  , [SQLITE_SCHEMA
2eb60 5d 2c 20 5b 53 51 4c 49 54 45 5f 43 4f 52 52 55  ], [SQLITE_CORRU
2eb70 50 54 5d 2c 20 61 6e 64 20 73 6f 20 66 6f 72 74  PT], and so fort
2eb80 68 29 0a 2a 2a 20 63 61 6e 20 62 65 20 6f 62 74  h).** can be obt
2eb90 61 69 6e 65 64 20 62 79 20 63 61 6c 6c 69 6e 67  ained by calling
2eba0 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28   [sqlite3_reset(
2ebb0 29 5d 20 6f 6e 20 74 68 65 0a 2a 2a 20 5b 70 72  )] on the.** [pr
2ebc0 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
2ebd0 5d 2e 20 20 5e 49 6e 20 74 68 65 20 22 76 32 22  ].  ^In the "v2"
2ebe0 20 69 6e 74 65 72 66 61 63 65 2c 0a 2a 2a 20 74   interface,.** t
2ebf0 68 65 20 6d 6f 72 65 20 73 70 65 63 69 66 69 63  he more specific
2ec00 20 65 72 72 6f 72 20 63 6f 64 65 20 69 73 20 72   error code is r
2ec10 65 74 75 72 6e 65 64 20 64 69 72 65 63 74 6c 79  eturned directly
2ec20 20 62 79 20 73 71 6c 69 74 65 33 5f 73 74 65 70   by sqlite3_step
2ec30 28 29 2e 0a 2a 2a 0a 2a 2a 20 5b 53 51 4c 49 54  ()..**.** [SQLIT
2ec40 45 5f 4d 49 53 55 53 45 5d 20 6d 65 61 6e 73 20  E_MISUSE] means 
2ec50 74 68 61 74 20 74 68 65 20 74 68 69 73 20 72 6f  that the this ro
2ec60 75 74 69 6e 65 20 77 61 73 20 63 61 6c 6c 65 64  utine was called
2ec70 20 69 6e 61 70 70 72 6f 70 72 69 61 74 65 6c 79   inappropriately
2ec80 2e 0a 2a 2a 20 50 65 72 68 61 70 73 20 69 74 20  ..** Perhaps it 
2ec90 77 61 73 20 63 61 6c 6c 65 64 20 6f 6e 20 61 20  was called on a 
2eca0 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d  [prepared statem
2ecb0 65 6e 74 5d 20 74 68 61 74 20 68 61 73 0a 2a 2a  ent] that has.**
2ecc0 20 61 6c 72 65 61 64 79 20 62 65 65 6e 20 5b 73   already been [s
2ecd0 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 20  qlite3_finalize 
2ece0 7c 20 66 69 6e 61 6c 69 7a 65 64 5d 20 6f 72 20  | finalized] or 
2ecf0 6f 6e 20 6f 6e 65 20 74 68 61 74 20 68 61 64 0a  on one that had.
2ed00 2a 2a 20 70 72 65 76 69 6f 75 73 6c 79 20 72 65  ** previously re
2ed10 74 75 72 6e 65 64 20 5b 53 51 4c 49 54 45 5f 45  turned [SQLITE_E
2ed20 52 52 4f 52 5d 20 6f 72 20 5b 53 51 4c 49 54 45  RROR] or [SQLITE
2ed30 5f 44 4f 4e 45 5d 2e 20 20 4f 72 20 69 74 20 63  _DONE].  Or it c
2ed40 6f 75 6c 64 0a 2a 2a 20 62 65 20 74 68 65 20 63  ould.** be the c
2ed50 61 73 65 20 74 68 61 74 20 74 68 65 20 73 61 6d  ase that the sam
2ed60 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65  e database conne
2ed70 63 74 69 6f 6e 20 69 73 20 62 65 69 6e 67 20 75  ction is being u
2ed80 73 65 64 20 62 79 20 74 77 6f 20 6f 72 0a 2a 2a  sed by two or.**
2ed90 20 6d 6f 72 65 20 74 68 72 65 61 64 73 20 61 74   more threads at
2eda0 20 74 68 65 20 73 61 6d 65 20 6d 6f 6d 65 6e 74   the same moment
2edb0 20 69 6e 20 74 69 6d 65 2e 0a 2a 2a 0a 2a 2a 20   in time..**.** 
2edc0 46 6f 72 20 61 6c 6c 20 76 65 72 73 69 6f 6e 73  For all versions
2edd0 20 6f 66 20 53 51 4c 69 74 65 20 75 70 20 74 6f   of SQLite up to
2ede0 20 61 6e 64 20 69 6e 63 6c 75 64 69 6e 67 20 33   and including 3
2edf0 2e 36 2e 32 33 2e 31 2c 20 61 20 63 61 6c 6c 20  .6.23.1, a call 
2ee00 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 72  to.** [sqlite3_r
2ee10 65 73 65 74 28 29 5d 20 77 61 73 20 72 65 71 75  eset()] was requ
2ee20 69 72 65 64 20 61 66 74 65 72 20 73 71 6c 69 74  ired after sqlit
2ee30 65 33 5f 73 74 65 70 28 29 20 72 65 74 75 72 6e  e3_step() return
2ee40 65 64 20 61 6e 79 74 68 69 6e 67 0a 2a 2a 20 6f  ed anything.** o
2ee50 74 68 65 72 20 74 68 61 6e 20 5b 53 51 4c 49 54  ther than [SQLIT
2ee60 45 5f 52 4f 57 5d 20 62 65 66 6f 72 65 20 61 6e  E_ROW] before an
2ee70 79 20 73 75 62 73 65 71 75 65 6e 74 20 69 6e 76  y subsequent inv
2ee80 6f 63 61 74 69 6f 6e 20 6f 66 0a 2a 2a 20 73 71  ocation of.** sq
2ee90 6c 69 74 65 33 5f 73 74 65 70 28 29 2e 20 20 46  lite3_step().  F
2eea0 61 69 6c 75 72 65 20 74 6f 20 72 65 73 65 74 20  ailure to reset 
2eeb0 74 68 65 20 70 72 65 70 61 72 65 64 20 73 74 61  the prepared sta
2eec0 74 65 6d 65 6e 74 20 75 73 69 6e 67 20 0a 2a 2a  tement using .**
2eed0 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28   [sqlite3_reset(
2eee0 29 5d 20 77 6f 75 6c 64 20 72 65 73 75 6c 74 20  )] would result 
2eef0 69 6e 20 61 6e 20 5b 53 51 4c 49 54 45 5f 4d 49  in an [SQLITE_MI
2ef00 53 55 53 45 5d 20 72 65 74 75 72 6e 20 66 72 6f  SUSE] return fro
2ef10 6d 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 73 74 65  m.** sqlite3_ste
2ef20 70 28 29 2e 20 20 42 75 74 20 61 66 74 65 72 20  p().  But after 
2ef30 76 65 72 73 69 6f 6e 20 33 2e 36 2e 32 33 2e 31  version 3.6.23.1
2ef40 2c 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29  , sqlite3_step()
2ef50 20 62 65 67 61 6e 0a 2a 2a 20 63 61 6c 6c 69 6e   began.** callin
2ef60 67 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74  g [sqlite3_reset
2ef70 28 29 5d 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c  ()] automaticall
2ef80 79 20 69 6e 20 74 68 69 73 20 63 69 72 63 75 6d  y in this circum
2ef90 73 74 61 6e 63 65 20 72 61 74 68 65 72 0a 2a 2a  stance rather.**
2efa0 20 74 68 61 6e 20 72 65 74 75 72 6e 69 6e 67 20   than returning 
2efb0 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 5d 2e  [SQLITE_MISUSE].
2efc0 20 20 54 68 69 73 20 69 73 20 6e 6f 74 20 63 6f    This is not co
2efd0 6e 73 69 64 65 72 65 64 20 61 20 63 6f 6d 70 61  nsidered a compa
2efe0 74 69 62 69 6c 69 74 79 0a 2a 2a 20 62 72 65 61  tibility.** brea
2eff0 6b 20 62 65 63 61 75 73 65 20 61 6e 79 20 61 70  k because any ap
2f000 70 6c 69 63 61 74 69 6f 6e 20 74 68 61 74 20 65  plication that e
2f010 76 65 72 20 72 65 63 65 69 76 65 73 20 61 6e 20  ver receives an 
2f020 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 20 65 72  SQLITE_MISUSE er
2f030 72 6f 72 0a 2a 2a 20 69 73 20 62 72 6f 6b 65 6e  ror.** is broken
2f040 20 62 79 20 64 65 66 69 6e 69 74 69 6f 6e 2e 20   by definition. 
2f050 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 4f 4d 49   The [SQLITE_OMI
2f060 54 5f 41 55 54 4f 52 45 53 45 54 5d 20 63 6f 6d  T_AUTORESET] com
2f070 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e  pile-time option
2f080 0a 2a 2a 20 63 61 6e 20 62 65 20 75 73 65 64 20  .** can be used 
2f090 74 6f 20 72 65 73 74 6f 72 65 20 74 68 65 20 6c  to restore the l
2f0a0 65 67 61 63 79 20 62 65 68 61 76 69 6f 72 2e 0a  egacy behavior..
2f0b0 2a 2a 0a 2a 2a 20 3c 62 3e 47 6f 6f 66 79 20 49  **.** <b>Goofy I
2f0c0 6e 74 65 72 66 61 63 65 20 41 6c 65 72 74 3a 3c  nterface Alert:<
2f0d0 2f 62 3e 20 49 6e 20 74 68 65 20 6c 65 67 61 63  /b> In the legac
2f0e0 79 20 69 6e 74 65 72 66 61 63 65 2c 20 74 68 65  y interface, the
2f0f0 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 0a   sqlite3_step().
2f100 2a 2a 20 41 50 49 20 61 6c 77 61 79 73 20 72 65  ** API always re
2f110 74 75 72 6e 73 20 61 20 67 65 6e 65 72 69 63 20  turns a generic 
2f120 65 72 72 6f 72 20 63 6f 64 65 2c 20 5b 53 51 4c  error code, [SQL
2f130 49 54 45 5f 45 52 52 4f 52 5d 2c 20 66 6f 6c 6c  ITE_ERROR], foll
2f140 6f 77 69 6e 67 20 61 6e 79 0a 2a 2a 20 65 72 72  owing any.** err
2f150 6f 72 20 6f 74 68 65 72 20 74 68 61 6e 20 5b 53  or other than [S
2f160 51 4c 49 54 45 5f 42 55 53 59 5d 20 61 6e 64 20  QLITE_BUSY] and 
2f170 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 5d 2e  [SQLITE_MISUSE].
2f180 20 20 59 6f 75 20 6d 75 73 74 20 63 61 6c 6c 0a    You must call.
2f190 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65  ** [sqlite3_rese
2f1a0 74 28 29 5d 20 6f 72 20 5b 73 71 6c 69 74 65 33  t()] or [sqlite3
2f1b0 5f 66 69 6e 61 6c 69 7a 65 28 29 5d 20 69 6e 20  _finalize()] in 
2f1c0 6f 72 64 65 72 20 74 6f 20 66 69 6e 64 20 6f 6e  order to find on
2f1d0 65 20 6f 66 20 74 68 65 0a 2a 2a 20 73 70 65 63  e of the.** spec
2f1e0 69 66 69 63 20 5b 65 72 72 6f 72 20 63 6f 64 65  ific [error code
2f1f0 73 5d 20 74 68 61 74 20 62 65 74 74 65 72 20 64  s] that better d
2f200 65 73 63 72 69 62 65 73 20 74 68 65 20 65 72 72  escribes the err
2f210 6f 72 2e 0a 2a 2a 20 57 65 20 61 64 6d 69 74 20  or..** We admit 
2f220 74 68 61 74 20 74 68 69 73 20 69 73 20 61 20 67  that this is a g
2f230 6f 6f 66 79 20 64 65 73 69 67 6e 2e 20 20 54 68  oofy design.  Th
2f240 65 20 70 72 6f 62 6c 65 6d 20 68 61 73 20 62 65  e problem has be
2f250 65 6e 20 66 69 78 65 64 0a 2a 2a 20 77 69 74 68  en fixed.** with
2f260 20 74 68 65 20 22 76 32 22 20 69 6e 74 65 72 66   the "v2" interf
2f270 61 63 65 2e 20 20 49 66 20 79 6f 75 20 70 72 65  ace.  If you pre
2f280 70 61 72 65 20 61 6c 6c 20 6f 66 20 79 6f 75 72  pare all of your
2f290 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 0a   SQL statements.
2f2a0 2a 2a 20 75 73 69 6e 67 20 65 69 74 68 65 72 20  ** using either 
2f2b0 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65  [sqlite3_prepare
2f2c0 5f 76 32 28 29 5d 20 6f 72 20 5b 73 71 6c 69 74  _v2()] or [sqlit
2f2d0 65 33 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28  e3_prepare16_v2(
2f2e0 29 5d 20 69 6e 73 74 65 61 64 0a 2a 2a 20 6f 66  )] instead.** of
2f2f0 20 74 68 65 20 6c 65 67 61 63 79 20 5b 73 71 6c   the legacy [sql
2f300 69 74 65 33 5f 70 72 65 70 61 72 65 28 29 5d 20  ite3_prepare()] 
2f310 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 70 72 65  and [sqlite3_pre
2f320 70 61 72 65 31 36 28 29 5d 20 69 6e 74 65 72 66  pare16()] interf
2f330 61 63 65 73 2c 0a 2a 2a 20 74 68 65 6e 20 74 68  aces,.** then th
2f340 65 20 6d 6f 72 65 20 73 70 65 63 69 66 69 63 20  e more specific 
2f350 5b 65 72 72 6f 72 20 63 6f 64 65 73 5d 20 61 72  [error codes] ar
2f360 65 20 72 65 74 75 72 6e 65 64 20 64 69 72 65 63  e returned direc
2f370 74 6c 79 0a 2a 2a 20 62 79 20 73 71 6c 69 74 65  tly.** by sqlite
2f380 33 5f 73 74 65 70 28 29 2e 20 20 54 68 65 20 75  3_step().  The u
2f390 73 65 20 6f 66 20 74 68 65 20 22 76 32 22 20 69  se of the "v2" i
2f3a0 6e 74 65 72 66 61 63 65 20 69 73 20 72 65 63 6f  nterface is reco
2f3b0 6d 6d 65 6e 64 65 64 2e 0a 2a 2f 0a 69 6e 74 20  mmended..*/.int 
2f3c0 73 71 6c 69 74 65 33 5f 73 74 65 70 28 73 71 6c  sqlite3_step(sql
2f3d0 69 74 65 33 5f 73 74 6d 74 2a 29 3b 0a 0a 2f 2a  ite3_stmt*);../*
2f3e0 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4e 75  .** CAPI3REF: Nu
2f3f0 6d 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 20  mber of columns 
2f400 69 6e 20 61 20 72 65 73 75 6c 74 20 73 65 74 0a  in a result set.
2f410 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74  ** METHOD: sqlit
2f420 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54  e3_stmt.**.** ^T
2f430 68 65 20 73 71 6c 69 74 65 33 5f 64 61 74 61 5f  he sqlite3_data_
2f440 63 6f 75 6e 74 28 50 29 20 69 6e 74 65 72 66 61  count(P) interfa
2f450 63 65 20 72 65 74 75 72 6e 73 20 74 68 65 20 6e  ce returns the n
2f460 75 6d 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73  umber of columns
2f470 20 69 6e 20 74 68 65 0a 2a 2a 20 63 75 72 72 65   in the.** curre
2f480 6e 74 20 72 6f 77 20 6f 66 20 74 68 65 20 72 65  nt row of the re
2f490 73 75 6c 74 20 73 65 74 20 6f 66 20 5b 70 72 65  sult set of [pre
2f4a0 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d  pared statement]
2f4b0 20 50 2e 0a 2a 2a 20 5e 49 66 20 70 72 65 70 61   P..** ^If prepa
2f4c0 72 65 64 20 73 74 61 74 65 6d 65 6e 74 20 50 20  red statement P 
2f4d0 64 6f 65 73 20 6e 6f 74 20 68 61 76 65 20 72 65  does not have re
2f4e0 73 75 6c 74 73 20 72 65 61 64 79 20 74 6f 20 72  sults ready to r
2f4f0 65 74 75 72 6e 0a 2a 2a 20 28 76 69 61 20 63 61  eturn.** (via ca
2f500 6c 6c 73 20 74 6f 20 74 68 65 20 5b 73 71 6c 69  lls to the [sqli
2f510 74 65 33 5f 63 6f 6c 75 6d 6e 5f 69 6e 74 20 7c  te3_column_int |
2f520 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
2f530 2a 28 29 5d 20 6f 66 0a 2a 2a 20 69 6e 74 65 72  *()] of.** inter
2f540 66 61 63 65 73 29 20 74 68 65 6e 20 73 71 6c 69  faces) then sqli
2f550 74 65 33 5f 64 61 74 61 5f 63 6f 75 6e 74 28 50  te3_data_count(P
2f560 29 20 72 65 74 75 72 6e 73 20 30 2e 0a 2a 2a 20  ) returns 0..** 
2f570 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 64 61 74  ^The sqlite3_dat
2f580 61 5f 63 6f 75 6e 74 28 50 29 20 72 6f 75 74 69  a_count(P) routi
2f590 6e 65 20 61 6c 73 6f 20 72 65 74 75 72 6e 73 20  ne also returns 
2f5a0 30 20 69 66 20 50 20 69 73 20 61 20 4e 55 4c 4c  0 if P is a NULL
2f5b0 20 70 6f 69 6e 74 65 72 2e 0a 2a 2a 20 5e 54 68   pointer..** ^Th
2f5c0 65 20 73 71 6c 69 74 65 33 5f 64 61 74 61 5f 63  e sqlite3_data_c
2f5d0 6f 75 6e 74 28 50 29 20 72 6f 75 74 69 6e 65 20  ount(P) routine 
2f5e0 72 65 74 75 72 6e 73 20 30 20 69 66 20 74 68 65  returns 0 if the
2f5f0 20 70 72 65 76 69 6f 75 73 20 63 61 6c 6c 20 74   previous call t
2f600 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 73 74  o.** [sqlite3_st
2f610 65 70 5d 28 50 29 20 72 65 74 75 72 6e 65 64 20  ep](P) returned 
2f620 5b 53 51 4c 49 54 45 5f 44 4f 4e 45 5d 2e 20 20  [SQLITE_DONE].  
2f630 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 64 61 74  ^The sqlite3_dat
2f640 61 5f 63 6f 75 6e 74 28 50 29 0a 2a 2a 20 77 69  a_count(P).** wi
2f650 6c 6c 20 72 65 74 75 72 6e 20 6e 6f 6e 2d 7a 65  ll return non-ze
2f660 72 6f 20 69 66 20 70 72 65 76 69 6f 75 73 20 63  ro if previous c
2f670 61 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f  all to [sqlite3_
2f680 73 74 65 70 5d 28 50 29 20 72 65 74 75 72 6e 65  step](P) returne
2f690 64 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 52 4f 57  d.** [SQLITE_ROW
2f6a0 5d 2c 20 65 78 63 65 70 74 20 69 6e 20 74 68 65  ], except in the
2f6b0 20 63 61 73 65 20 6f 66 20 74 68 65 20 5b 50 52   case of the [PR
2f6c0 41 47 4d 41 20 69 6e 63 72 65 6d 65 6e 74 61 6c  AGMA incremental
2f6d0 5f 76 61 63 75 75 6d 5d 0a 2a 2a 20 77 68 65 72  _vacuum].** wher
2f6e0 65 20 69 74 20 61 6c 77 61 79 73 20 72 65 74 75  e it always retu
2f6f0 72 6e 73 20 7a 65 72 6f 20 73 69 6e 63 65 20 65  rns zero since e
2f700 61 63 68 20 73 74 65 70 20 6f 66 20 74 68 61 74  ach step of that
2f710 20 6d 75 6c 74 69 2d 73 74 65 70 0a 2a 2a 20 70   multi-step.** p
2f720 72 61 67 6d 61 20 72 65 74 75 72 6e 73 20 30 20  ragma returns 0 
2f730 63 6f 6c 75 6d 6e 73 20 6f 66 20 64 61 74 61 2e  columns of data.
2f740 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 3a  .**.** See also:
2f750 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e   [sqlite3_column
2f760 5f 63 6f 75 6e 74 28 29 5d 0a 2a 2f 0a 69 6e 74  _count()].*/.int
2f770 20 73 71 6c 69 74 65 33 5f 64 61 74 61 5f 63 6f   sqlite3_data_co
2f780 75 6e 74 28 73 71 6c 69 74 65 33 5f 73 74 6d 74  unt(sqlite3_stmt
2f790 20 2a 70 53 74 6d 74 29 3b 0a 0a 2f 2a 0a 2a 2a   *pStmt);../*.**
2f7a0 20 43 41 50 49 33 52 45 46 3a 20 46 75 6e 64 61   CAPI3REF: Funda
2f7b0 6d 65 6e 74 61 6c 20 44 61 74 61 74 79 70 65 73  mental Datatypes
2f7c0 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20 53 51  .** KEYWORDS: SQ
2f7d0 4c 49 54 45 5f 54 45 58 54 0a 2a 2a 0a 2a 2a 20  LITE_TEXT.**.** 
2f7e0 5e 28 45 76 65 72 79 20 76 61 6c 75 65 20 69 6e  ^(Every value in
2f7f0 20 53 51 4c 69 74 65 20 68 61 73 20 6f 6e 65 20   SQLite has one 
2f800 6f 66 20 66 69 76 65 20 66 75 6e 64 61 6d 65 6e  of five fundamen
2f810 74 61 6c 20 64 61 74 61 74 79 70 65 73 3a 0a 2a  tal datatypes:.*
2f820 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c 69  *.** <ul>.** <li
2f830 3e 20 36 34 2d 62 69 74 20 73 69 67 6e 65 64 20  > 64-bit signed 
2f840 69 6e 74 65 67 65 72 0a 2a 2a 20 3c 6c 69 3e 20  integer.** <li> 
2f850 36 34 2d 62 69 74 20 49 45 45 45 20 66 6c 6f 61  64-bit IEEE floa
2f860 74 69 6e 67 20 70 6f 69 6e 74 20 6e 75 6d 62 65  ting point numbe
2f870 72 0a 2a 2a 20 3c 6c 69 3e 20 73 74 72 69 6e 67  r.** <li> string
2f880 0a 2a 2a 20 3c 6c 69 3e 20 42 4c 4f 42 0a 2a 2a  .** <li> BLOB.**
2f890 20 3c 6c 69 3e 20 4e 55 4c 4c 0a 2a 2a 20 3c 2f   <li> NULL.** </
2f8a0 75 6c 3e 29 5e 0a 2a 2a 0a 2a 2a 20 54 68 65 73  ul>)^.**.** Thes
2f8b0 65 20 63 6f 6e 73 74 61 6e 74 73 20 61 72 65 20  e constants are 
2f8c0 63 6f 64 65 73 20 66 6f 72 20 65 61 63 68 20 6f  codes for each o
2f8d0 66 20 74 68 6f 73 65 20 74 79 70 65 73 2e 0a 2a  f those types..*
2f8e0 2a 0a 2a 2a 20 4e 6f 74 65 20 74 68 61 74 20 74  *.** Note that t
2f8f0 68 65 20 53 51 4c 49 54 45 5f 54 45 58 54 20 63  he SQLITE_TEXT c
2f900 6f 6e 73 74 61 6e 74 20 77 61 73 20 61 6c 73 6f  onstant was also
2f910 20 75 73 65 64 20 69 6e 20 53 51 4c 69 74 65 20   used in SQLite 
2f920 76 65 72 73 69 6f 6e 20 32 0a 2a 2a 20 66 6f 72  version 2.** for
2f930 20 61 20 63 6f 6d 70 6c 65 74 65 6c 79 20 64 69   a completely di
2f940 66 66 65 72 65 6e 74 20 6d 65 61 6e 69 6e 67 2e  fferent meaning.
2f950 20 20 53 6f 66 74 77 61 72 65 20 74 68 61 74 20    Software that 
2f960 6c 69 6e 6b 73 20 61 67 61 69 6e 73 74 20 62 6f  links against bo
2f970 74 68 0a 2a 2a 20 53 51 4c 69 74 65 20 76 65 72  th.** SQLite ver
2f980 73 69 6f 6e 20 32 20 61 6e 64 20 53 51 4c 69 74  sion 2 and SQLit
2f990 65 20 76 65 72 73 69 6f 6e 20 33 20 73 68 6f 75  e version 3 shou
2f9a0 6c 64 20 75 73 65 20 53 51 4c 49 54 45 33 5f 54  ld use SQLITE3_T
2f9b0 45 58 54 2c 20 6e 6f 74 0a 2a 2a 20 53 51 4c 49  EXT, not.** SQLI
2f9c0 54 45 5f 54 45 58 54 2e 0a 2a 2f 0a 23 64 65 66  TE_TEXT..*/.#def
2f9d0 69 6e 65 20 53 51 4c 49 54 45 5f 49 4e 54 45 47  ine SQLITE_INTEG
2f9e0 45 52 20 20 31 0a 23 64 65 66 69 6e 65 20 53 51  ER  1.#define SQ
2f9f0 4c 49 54 45 5f 46 4c 4f 41 54 20 20 20 20 32 0a  LITE_FLOAT    2.
2fa00 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 42  #define SQLITE_B
2fa10 4c 4f 42 20 20 20 20 20 34 0a 23 64 65 66 69 6e  LOB     4.#defin
2fa20 65 20 53 51 4c 49 54 45 5f 4e 55 4c 4c 20 20 20  e SQLITE_NULL   
2fa30 20 20 35 0a 23 69 66 64 65 66 20 53 51 4c 49 54    5.#ifdef SQLIT
2fa40 45 5f 54 45 58 54 0a 23 20 75 6e 64 65 66 20 53  E_TEXT.# undef S
2fa50 51 4c 49 54 45 5f 54 45 58 54 0a 23 65 6c 73 65  QLITE_TEXT.#else
2fa60 0a 23 20 64 65 66 69 6e 65 20 53 51 4c 49 54 45  .# define SQLITE
2fa70 5f 54 45 58 54 20 20 20 20 20 33 0a 23 65 6e 64  _TEXT     3.#end
2fa80 69 66 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  if.#define SQLIT
2fa90 45 33 5f 54 45 58 54 20 20 20 20 20 33 0a 0a 2f  E3_TEXT     3../
2faa0 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 52  *.** CAPI3REF: R
2fab0 65 73 75 6c 74 20 56 61 6c 75 65 73 20 46 72 6f  esult Values Fro
2fac0 6d 20 41 20 51 75 65 72 79 0a 2a 2a 20 4b 45 59  m A Query.** KEY
2fad0 57 4f 52 44 53 3a 20 7b 63 6f 6c 75 6d 6e 20 61  WORDS: {column a
2fae0 63 63 65 73 73 20 66 75 6e 63 74 69 6f 6e 73 7d  ccess functions}
2faf0 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69  .** METHOD: sqli
2fb00 74 65 33 5f 73 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e  te3_stmt.**.** ^
2fb10 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 72  These routines r
2fb20 65 74 75 72 6e 20 69 6e 66 6f 72 6d 61 74 69 6f  eturn informatio
2fb30 6e 20 61 62 6f 75 74 20 61 20 73 69 6e 67 6c 65  n about a single
2fb40 20 63 6f 6c 75 6d 6e 20 6f 66 20 74 68 65 20 63   column of the c
2fb50 75 72 72 65 6e 74 0a 2a 2a 20 72 65 73 75 6c 74  urrent.** result
2fb60 20 72 6f 77 20 6f 66 20 61 20 71 75 65 72 79 2e   row of a query.
2fb70 20 20 5e 49 6e 20 65 76 65 72 79 20 63 61 73 65    ^In every case
2fb80 20 74 68 65 20 66 69 72 73 74 20 61 72 67 75 6d   the first argum
2fb90 65 6e 74 20 69 73 20 61 20 70 6f 69 6e 74 65 72  ent is a pointer
2fba0 0a 2a 2a 20 74 6f 20 74 68 65 20 5b 70 72 65 70  .** to the [prep
2fbb0 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20  ared statement] 
2fbc0 74 68 61 74 20 69 73 20 62 65 69 6e 67 20 65 76  that is being ev
2fbd0 61 6c 75 61 74 65 64 20 28 74 68 65 20 5b 73 71  aluated (the [sq
2fbe0 6c 69 74 65 33 5f 73 74 6d 74 2a 5d 0a 2a 2a 20  lite3_stmt*].** 
2fbf0 74 68 61 74 20 77 61 73 20 72 65 74 75 72 6e 65  that was returne
2fc00 64 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f  d from [sqlite3_
2fc10 70 72 65 70 61 72 65 5f 76 32 28 29 5d 20 6f 72  prepare_v2()] or
2fc20 20 6f 6e 65 20 6f 66 20 69 74 73 20 76 61 72 69   one of its vari
2fc30 61 6e 74 73 29 0a 2a 2a 20 61 6e 64 20 74 68 65  ants).** and the
2fc40 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74   second argument
2fc50 20 69 73 20 74 68 65 20 69 6e 64 65 78 20 6f 66   is the index of
2fc60 20 74 68 65 20 63 6f 6c 75 6d 6e 20 66 6f 72 20   the column for 
2fc70 77 68 69 63 68 20 69 6e 66 6f 72 6d 61 74 69 6f  which informatio
2fc80 6e 0a 2a 2a 20 73 68 6f 75 6c 64 20 62 65 20 72  n.** should be r
2fc90 65 74 75 72 6e 65 64 2e 20 5e 54 68 65 20 6c 65  eturned. ^The le
2fca0 66 74 6d 6f 73 74 20 63 6f 6c 75 6d 6e 20 6f 66  ftmost column of
2fcb0 20 74 68 65 20 72 65 73 75 6c 74 20 73 65 74 20   the result set 
2fcc0 68 61 73 20 74 68 65 20 69 6e 64 65 78 20 30 2e  has the index 0.
2fcd0 0a 2a 2a 20 5e 54 68 65 20 6e 75 6d 62 65 72 20  .** ^The number 
2fce0 6f 66 20 63 6f 6c 75 6d 6e 73 20 69 6e 20 74 68  of columns in th
2fcf0 65 20 72 65 73 75 6c 74 20 63 61 6e 20 62 65 20  e result can be 
2fd00 64 65 74 65 72 6d 69 6e 65 64 20 75 73 69 6e 67  determined using
2fd10 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c  .** [sqlite3_col
2fd20 75 6d 6e 5f 63 6f 75 6e 74 28 29 5d 2e 0a 2a 2a  umn_count()]..**
2fd30 0a 2a 2a 20 49 66 20 74 68 65 20 53 51 4c 20 73  .** If the SQL s
2fd40 74 61 74 65 6d 65 6e 74 20 64 6f 65 73 20 6e 6f  tatement does no
2fd50 74 20 63 75 72 72 65 6e 74 6c 79 20 70 6f 69 6e  t currently poin
2fd60 74 20 74 6f 20 61 20 76 61 6c 69 64 20 72 6f 77  t to a valid row
2fd70 2c 20 6f 72 20 69 66 20 74 68 65 0a 2a 2a 20 63  , or if the.** c
2fd80 6f 6c 75 6d 6e 20 69 6e 64 65 78 20 69 73 20 6f  olumn index is o
2fd90 75 74 20 6f 66 20 72 61 6e 67 65 2c 20 74 68 65  ut of range, the
2fda0 20 72 65 73 75 6c 74 20 69 73 20 75 6e 64 65 66   result is undef
2fdb0 69 6e 65 64 2e 0a 2a 2a 20 54 68 65 73 65 20 72  ined..** These r
2fdc0 6f 75 74 69 6e 65 73 20 6d 61 79 20 6f 6e 6c 79  outines may only
2fdd0 20 62 65 20 63 61 6c 6c 65 64 20 77 68 65 6e 20   be called when 
2fde0 74 68 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 20  the most recent 
2fdf0 63 61 6c 6c 20 74 6f 0a 2a 2a 20 5b 73 71 6c 69  call to.** [sqli
2fe00 74 65 33 5f 73 74 65 70 28 29 5d 20 68 61 73 20  te3_step()] has 
2fe10 72 65 74 75 72 6e 65 64 20 5b 53 51 4c 49 54 45  returned [SQLITE
2fe20 5f 52 4f 57 5d 20 61 6e 64 20 6e 65 69 74 68 65  _ROW] and neithe
2fe30 72 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 72 65  r.** [sqlite3_re
2fe40 73 65 74 28 29 5d 20 6e 6f 72 20 5b 73 71 6c 69  set()] nor [sqli
2fe50 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28 29 5d 20  te3_finalize()] 
2fe60 68 61 76 65 20 62 65 65 6e 20 63 61 6c 6c 65 64  have been called
2fe70 20 73 75 62 73 65 71 75 65 6e 74 6c 79 2e 0a 2a   subsequently..*
2fe80 2a 20 49 66 20 61 6e 79 20 6f 66 20 74 68 65 73  * If any of thes
2fe90 65 20 72 6f 75 74 69 6e 65 73 20 61 72 65 20 63  e routines are c
2fea0 61 6c 6c 65 64 20 61 66 74 65 72 20 5b 73 71 6c  alled after [sql
2feb0 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20 6f 72  ite3_reset()] or
2fec0 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e  .** [sqlite3_fin
2fed0 61 6c 69 7a 65 28 29 5d 20 6f 72 20 61 66 74 65  alize()] or afte
2fee0 72 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28  r [sqlite3_step(
2fef0 29 5d 20 68 61 73 20 72 65 74 75 72 6e 65 64 0a  )] has returned.
2ff00 2a 2a 20 73 6f 6d 65 74 68 69 6e 67 20 6f 74 68  ** something oth
2ff10 65 72 20 74 68 61 6e 20 5b 53 51 4c 49 54 45 5f  er than [SQLITE_
2ff20 52 4f 57 5d 2c 20 74 68 65 20 72 65 73 75 6c 74  ROW], the result
2ff30 73 20 61 72 65 20 75 6e 64 65 66 69 6e 65 64 2e  s are undefined.
2ff40 0a 2a 2a 20 49 66 20 5b 73 71 6c 69 74 65 33 5f  .** If [sqlite3_
2ff50 73 74 65 70 28 29 5d 20 6f 72 20 5b 73 71 6c 69  step()] or [sqli
2ff60 74 65 33 5f 72 65 73 65 74 28 29 5d 20 6f 72 20  te3_reset()] or 
2ff70 5b 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a  [sqlite3_finaliz
2ff80 65 28 29 5d 0a 2a 2a 20 61 72 65 20 63 61 6c 6c  e()].** are call
2ff90 65 64 20 66 72 6f 6d 20 61 20 64 69 66 66 65 72  ed from a differ
2ffa0 65 6e 74 20 74 68 72 65 61 64 20 77 68 69 6c 65  ent thread while
2ffb0 20 61 6e 79 20 6f 66 20 74 68 65 73 65 20 72 6f   any of these ro
2ffc0 75 74 69 6e 65 73 0a 2a 2a 20 61 72 65 20 70 65  utines.** are pe
2ffd0 6e 64 69 6e 67 2c 20 74 68 65 6e 20 74 68 65 20  nding, then the 
2ffe0 72 65 73 75 6c 74 73 20 61 72 65 20 75 6e 64 65  results are unde
2fff0 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  fined..**.** ^Th
30000 65 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  e sqlite3_column
30010 5f 74 79 70 65 28 29 20 72 6f 75 74 69 6e 65 20  _type() routine 
30020 72 65 74 75 72 6e 73 20 74 68 65 0a 2a 2a 20 5b  returns the.** [
30030 53 51 4c 49 54 45 5f 49 4e 54 45 47 45 52 20 7c  SQLITE_INTEGER |
30040 20 64 61 74 61 74 79 70 65 20 63 6f 64 65 5d 20   datatype code] 
30050 66 6f 72 20 74 68 65 20 69 6e 69 74 69 61 6c 20  for the initial 
30060 64 61 74 61 20 74 79 70 65 0a 2a 2a 20 6f 66 20  data type.** of 
30070 74 68 65 20 72 65 73 75 6c 74 20 63 6f 6c 75 6d  the result colum
30080 6e 2e 20 20 5e 54 68 65 20 72 65 74 75 72 6e 65  n.  ^The returne
30090 64 20 76 61 6c 75 65 20 69 73 20 6f 6e 65 20 6f  d value is one o
300a0 66 20 5b 53 51 4c 49 54 45 5f 49 4e 54 45 47 45  f [SQLITE_INTEGE
300b0 52 5d 2c 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 46  R],.** [SQLITE_F
300c0 4c 4f 41 54 5d 2c 20 5b 53 51 4c 49 54 45 5f 54  LOAT], [SQLITE_T
300d0 45 58 54 5d 2c 20 5b 53 51 4c 49 54 45 5f 42 4c  EXT], [SQLITE_BL
300e0 4f 42 5d 2c 20 6f 72 20 5b 53 51 4c 49 54 45 5f  OB], or [SQLITE_
300f0 4e 55 4c 4c 5d 2e 20 20 54 68 65 20 76 61 6c 75  NULL].  The valu
30100 65 0a 2a 2a 20 72 65 74 75 72 6e 65 64 20 62 79  e.** returned by
30110 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
30120 74 79 70 65 28 29 20 69 73 20 6f 6e 6c 79 20 6d  type() is only m
30130 65 61 6e 69 6e 67 66 75 6c 20 69 66 20 6e 6f 20  eaningful if no 
30140 74 79 70 65 0a 2a 2a 20 63 6f 6e 76 65 72 73 69  type.** conversi
30150 6f 6e 73 20 68 61 76 65 20 6f 63 63 75 72 72 65  ons have occurre
30160 64 20 61 73 20 64 65 73 63 72 69 62 65 64 20 62  d as described b
30170 65 6c 6f 77 2e 20 20 41 66 74 65 72 20 61 20 74  elow.  After a t
30180 79 70 65 20 63 6f 6e 76 65 72 73 69 6f 6e 2c 0a  ype conversion,.
30190 2a 2a 20 74 68 65 20 76 61 6c 75 65 20 72 65 74  ** the value ret
301a0 75 72 6e 65 64 20 62 79 20 73 71 6c 69 74 65 33  urned by sqlite3
301b0 5f 63 6f 6c 75 6d 6e 5f 74 79 70 65 28 29 20 69  _column_type() i
301c0 73 20 75 6e 64 65 66 69 6e 65 64 2e 20 20 46 75  s undefined.  Fu
301d0 74 75 72 65 0a 2a 2a 20 76 65 72 73 69 6f 6e 73  ture.** versions
301e0 20 6f 66 20 53 51 4c 69 74 65 20 6d 61 79 20 63   of SQLite may c
301f0 68 61 6e 67 65 20 74 68 65 20 62 65 68 61 76 69  hange the behavi
30200 6f 72 20 6f 66 20 73 71 6c 69 74 65 33 5f 63 6f  or of sqlite3_co
30210 6c 75 6d 6e 5f 74 79 70 65 28 29 0a 2a 2a 20 66  lumn_type().** f
30220 6f 6c 6c 6f 77 69 6e 67 20 61 20 74 79 70 65 20  ollowing a type 
30230 63 6f 6e 76 65 72 73 69 6f 6e 2e 0a 2a 2a 0a 2a  conversion..**.*
30240 2a 20 5e 49 66 20 74 68 65 20 72 65 73 75 6c 74  * ^If the result
30250 20 69 73 20 61 20 42 4c 4f 42 20 6f 72 20 55 54   is a BLOB or UT
30260 46 2d 38 20 73 74 72 69 6e 67 20 74 68 65 6e 20  F-8 string then 
30270 74 68 65 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75  the sqlite3_colu
30280 6d 6e 5f 62 79 74 65 73 28 29 0a 2a 2a 20 72 6f  mn_bytes().** ro
30290 75 74 69 6e 65 20 72 65 74 75 72 6e 73 20 74 68  utine returns th
302a0 65 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65  e number of byte
302b0 73 20 69 6e 20 74 68 61 74 20 42 4c 4f 42 20 6f  s in that BLOB o
302c0 72 20 73 74 72 69 6e 67 2e 0a 2a 2a 20 5e 49 66  r string..** ^If
302d0 20 74 68 65 20 72 65 73 75 6c 74 20 69 73 20 61   the result is a
302e0 20 55 54 46 2d 31 36 20 73 74 72 69 6e 67 2c 20   UTF-16 string, 
302f0 74 68 65 6e 20 73 71 6c 69 74 65 33 5f 63 6f 6c  then sqlite3_col
30300 75 6d 6e 5f 62 79 74 65 73 28 29 20 63 6f 6e 76  umn_bytes() conv
30310 65 72 74 73 0a 2a 2a 20 74 68 65 20 73 74 72 69  erts.** the stri
30320 6e 67 20 74 6f 20 55 54 46 2d 38 20 61 6e 64 20  ng to UTF-8 and 
30330 74 68 65 6e 20 72 65 74 75 72 6e 73 20 74 68 65  then returns the
30340 20 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73   number of bytes
30350 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 72 65 73  ..** ^If the res
30360 75 6c 74 20 69 73 20 61 20 6e 75 6d 65 72 69 63  ult is a numeric
30370 20 76 61 6c 75 65 20 74 68 65 6e 20 73 71 6c 69   value then sqli
30380 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73  te3_column_bytes
30390 28 29 20 75 73 65 73 0a 2a 2a 20 5b 73 71 6c 69  () uses.** [sqli
303a0 74 65 33 5f 73 6e 70 72 69 6e 74 66 28 29 5d 20  te3_snprintf()] 
303b0 74 6f 20 63 6f 6e 76 65 72 74 20 74 68 61 74 20  to convert that 
303c0 76 61 6c 75 65 20 74 6f 20 61 20 55 54 46 2d 38  value to a UTF-8
303d0 20 73 74 72 69 6e 67 20 61 6e 64 20 72 65 74 75   string and retu
303e0 72 6e 73 0a 2a 2a 20 74 68 65 20 6e 75 6d 62 65  rns.** the numbe
303f0 72 20 6f 66 20 62 79 74 65 73 20 69 6e 20 74 68  r of bytes in th
30400 61 74 20 73 74 72 69 6e 67 2e 0a 2a 2a 20 5e 49  at string..** ^I
30410 66 20 74 68 65 20 72 65 73 75 6c 74 20 69 73 20  f the result is 
30420 4e 55 4c 4c 2c 20 74 68 65 6e 20 73 71 6c 69 74  NULL, then sqlit
30430 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28  e3_column_bytes(
30440 29 20 72 65 74 75 72 6e 73 20 7a 65 72 6f 2e 0a  ) returns zero..
30450 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 72 65  **.** ^If the re
30460 73 75 6c 74 20 69 73 20 61 20 42 4c 4f 42 20 6f  sult is a BLOB o
30470 72 20 55 54 46 2d 31 36 20 73 74 72 69 6e 67 20  r UTF-16 string 
30480 74 68 65 6e 20 74 68 65 20 73 71 6c 69 74 65 33  then the sqlite3
30490 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28  _column_bytes16(
304a0 29 0a 2a 2a 20 72 6f 75 74 69 6e 65 20 72 65 74  ).** routine ret
304b0 75 72 6e 73 20 74 68 65 20 6e 75 6d 62 65 72 20  urns the number 
304c0 6f 66 20 62 79 74 65 73 20 69 6e 20 74 68 61 74  of bytes in that
304d0 20 42 4c 4f 42 20 6f 72 20 73 74 72 69 6e 67 2e   BLOB or string.
304e0 0a 2a 2a 20 5e 49 66 20 74 68 65 20 72 65 73 75  .** ^If the resu
304f0 6c 74 20 69 73 20 61 20 55 54 46 2d 38 20 73 74  lt is a UTF-8 st
30500 72 69 6e 67 2c 20 74 68 65 6e 20 73 71 6c 69 74  ring, then sqlit
30510 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31  e3_column_bytes1
30520 36 28 29 20 63 6f 6e 76 65 72 74 73 0a 2a 2a 20  6() converts.** 
30530 74 68 65 20 73 74 72 69 6e 67 20 74 6f 20 55 54  the string to UT
30540 46 2d 31 36 20 61 6e 64 20 74 68 65 6e 20 72 65  F-16 and then re
30550 74 75 72 6e 73 20 74 68 65 20 6e 75 6d 62 65 72  turns the number
30560 20 6f 66 20 62 79 74 65 73 2e 0a 2a 2a 20 5e 49   of bytes..** ^I
30570 66 20 74 68 65 20 72 65 73 75 6c 74 20 69 73 20  f the result is 
30580 61 20 6e 75 6d 65 72 69 63 20 76 61 6c 75 65 20  a numeric value 
30590 74 68 65 6e 20 73 71 6c 69 74 65 33 5f 63 6f 6c  then sqlite3_col
305a0 75 6d 6e 5f 62 79 74 65 73 31 36 28 29 20 75 73  umn_bytes16() us
305b0 65 73 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 73  es.** [sqlite3_s
305c0 6e 70 72 69 6e 74 66 28 29 5d 20 74 6f 20 63 6f  nprintf()] to co
305d0 6e 76 65 72 74 20 74 68 61 74 20 76 61 6c 75 65  nvert that value
305e0 20 74 6f 20 61 20 55 54 46 2d 31 36 20 73 74 72   to a UTF-16 str
305f0 69 6e 67 20 61 6e 64 20 72 65 74 75 72 6e 73 0a  ing and returns.
30600 2a 2a 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  ** the number of
30610 20 62 79 74 65 73 20 69 6e 20 74 68 61 74 20 73   bytes in that s
30620 74 72 69 6e 67 2e 0a 2a 2a 20 5e 49 66 20 74 68  tring..** ^If th
30630 65 20 72 65 73 75 6c 74 20 69 73 20 4e 55 4c 4c  e result is NULL
30640 2c 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f 63  , then sqlite3_c
30650 6f 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28 29 20  olumn_bytes16() 
30660 72 65 74 75 72 6e 73 20 7a 65 72 6f 2e 0a 2a 2a  returns zero..**
30670 0a 2a 2a 20 5e 54 68 65 20 76 61 6c 75 65 73 20  .** ^The values 
30680 72 65 74 75 72 6e 65 64 20 62 79 20 5b 73 71 6c  returned by [sql
30690 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65  ite3_column_byte
306a0 73 28 29 5d 20 61 6e 64 20 0a 2a 2a 20 5b 73 71  s()] and .** [sq
306b0 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74  lite3_column_byt
306c0 65 73 31 36 28 29 5d 20 64 6f 20 6e 6f 74 20 69  es16()] do not i
306d0 6e 63 6c 75 64 65 20 74 68 65 20 7a 65 72 6f 20  nclude the zero 
306e0 74 65 72 6d 69 6e 61 74 6f 72 73 20 61 74 20 74  terminators at t
306f0 68 65 20 65 6e 64 0a 2a 2a 20 6f 66 20 74 68 65  he end.** of the
30700 20 73 74 72 69 6e 67 2e 20 20 5e 46 6f 72 20 63   string.  ^For c
30710 6c 61 72 69 74 79 3a 20 74 68 65 20 76 61 6c 75  larity: the valu
30720 65 73 20 72 65 74 75 72 6e 65 64 20 62 79 0a 2a  es returned by.*
30730 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  * [sqlite3_colum
30740 6e 5f 62 79 74 65 73 28 29 5d 20 61 6e 64 20 5b  n_bytes()] and [
30750 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62  sqlite3_column_b
30760 79 74 65 73 31 36 28 29 5d 20 61 72 65 20 74 68  ytes16()] are th
30770 65 20 6e 75 6d 62 65 72 20 6f 66 0a 2a 2a 20 62  e number of.** b
30780 79 74 65 73 20 69 6e 20 74 68 65 20 73 74 72 69  ytes in the stri
30790 6e 67 2c 20 6e 6f 74 20 74 68 65 20 6e 75 6d 62  ng, not the numb
307a0 65 72 20 6f 66 20 63 68 61 72 61 63 74 65 72 73  er of characters
307b0 2e 0a 2a 2a 0a 2a 2a 20 5e 53 74 72 69 6e 67 73  ..**.** ^Strings
307c0 20 72 65 74 75 72 6e 65 64 20 62 79 20 73 71 6c   returned by sql
307d0 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74  ite3_column_text
307e0 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 63  () and sqlite3_c
307f0 6f 6c 75 6d 6e 5f 74 65 78 74 31 36 28 29 2c 0a  olumn_text16(),.
30800 2a 2a 20 65 76 65 6e 20 65 6d 70 74 79 20 73 74  ** even empty st
30810 72 69 6e 67 73 2c 20 61 72 65 20 61 6c 77 61 79  rings, are alway
30820 73 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65  s zero-terminate
30830 64 2e 20 20 5e 54 68 65 20 72 65 74 75 72 6e 0a  d.  ^The return.
30840 2a 2a 20 76 61 6c 75 65 20 66 72 6f 6d 20 73 71  ** value from sq
30850 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 6c 6f  lite3_column_blo
30860 62 28 29 20 66 6f 72 20 61 20 7a 65 72 6f 2d 6c  b() for a zero-l
30870 65 6e 67 74 68 20 42 4c 4f 42 20 69 73 20 61 20  ength BLOB is a 
30880 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2e 0a 2a 2a  NULL pointer..**
30890 0a 2a 2a 20 3c 62 3e 57 61 72 6e 69 6e 67 3a 3c  .** <b>Warning:<
308a0 2f 62 3e 20 5e 54 68 65 20 6f 62 6a 65 63 74 20  /b> ^The object 
308b0 72 65 74 75 72 6e 65 64 20 62 79 20 5b 73 71 6c  returned by [sql
308c0 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 76 61 6c 75  ite3_column_valu
308d0 65 28 29 5d 20 69 73 20 61 6e 0a 2a 2a 20 5b 75  e()] is an.** [u
308e0 6e 70 72 6f 74 65 63 74 65 64 20 73 71 6c 69 74  nprotected sqlit
308f0 65 33 5f 76 61 6c 75 65 5d 20 6f 62 6a 65 63 74  e3_value] object
30900 2e 20 20 49 6e 20 61 20 6d 75 6c 74 69 74 68 72  .  In a multithr
30910 65 61 64 65 64 20 65 6e 76 69 72 6f 6e 6d 65 6e  eaded environmen
30920 74 2c 0a 2a 2a 20 61 6e 20 75 6e 70 72 6f 74 65  t,.** an unprote
30930 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c  cted sqlite3_val
30940 75 65 20 6f 62 6a 65 63 74 20 6d 61 79 20 6f 6e  ue object may on
30950 6c 79 20 62 65 20 75 73 65 64 20 73 61 66 65 6c  ly be used safel
30960 79 20 77 69 74 68 0a 2a 2a 20 5b 73 71 6c 69 74  y with.** [sqlit
30970 65 33 5f 62 69 6e 64 5f 76 61 6c 75 65 28 29 5d  e3_bind_value()]
30980 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 72 65   and [sqlite3_re
30990 73 75 6c 74 5f 76 61 6c 75 65 28 29 5d 2e 0a 2a  sult_value()]..*
309a0 2a 20 49 66 20 74 68 65 20 5b 75 6e 70 72 6f 74  * If the [unprot
309b0 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76 61  ected sqlite3_va
309c0 6c 75 65 5d 20 6f 62 6a 65 63 74 20 72 65 74 75  lue] object retu
309d0 72 6e 65 64 20 62 79 0a 2a 2a 20 5b 73 71 6c 69  rned by.** [sqli
309e0 74 65 33 5f 63 6f 6c 75 6d 6e 5f 76 61 6c 75 65  te3_column_value
309f0 28 29 5d 20 69 73 20 75 73 65 64 20 69 6e 20 61  ()] is used in a
30a00 6e 79 20 6f 74 68 65 72 20 77 61 79 2c 20 69 6e  ny other way, in
30a10 63 6c 75 64 69 6e 67 20 63 61 6c 6c 73 0a 2a 2a  cluding calls.**
30a20 20 74 6f 20 72 6f 75 74 69 6e 65 73 20 6c 69 6b   to routines lik
30a30 65 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  e [sqlite3_value
30a40 5f 69 6e 74 28 29 5d 2c 20 5b 73 71 6c 69 74 65  _int()], [sqlite
30a50 33 5f 76 61 6c 75 65 5f 74 65 78 74 28 29 5d 2c  3_value_text()],
30a60 0a 2a 2a 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f  .** or [sqlite3_
30a70 76 61 6c 75 65 5f 62 79 74 65 73 28 29 5d 2c 20  value_bytes()], 
30a80 74 68 65 20 62 65 68 61 76 69 6f 72 20 69 73 20  the behavior is 
30a90 6e 6f 74 20 74 68 72 65 61 64 73 61 66 65 2e 0a  not threadsafe..
30aa0 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72 6f 75 74  **.** These rout
30ab0 69 6e 65 73 20 61 74 74 65 6d 70 74 20 74 6f 20  ines attempt to 
30ac0 63 6f 6e 76 65 72 74 20 74 68 65 20 76 61 6c 75  convert the valu
30ad0 65 20 77 68 65 72 65 20 61 70 70 72 6f 70 72 69  e where appropri
30ae0 61 74 65 2e 20 20 5e 46 6f 72 0a 2a 2a 20 65 78  ate.  ^For.** ex
30af0 61 6d 70 6c 65 2c 20 69 66 20 74 68 65 20 69 6e  ample, if the in
30b00 74 65 72 6e 61 6c 20 72 65 70 72 65 73 65 6e 74  ternal represent
30b10 61 74 69 6f 6e 20 69 73 20 46 4c 4f 41 54 20 61  ation is FLOAT a
30b20 6e 64 20 61 20 74 65 78 74 20 72 65 73 75 6c 74  nd a text result
30b30 0a 2a 2a 20 69 73 20 72 65 71 75 65 73 74 65 64  .** is requested
30b40 2c 20 5b 73 71 6c 69 74 65 33 5f 73 6e 70 72 69  , [sqlite3_snpri
30b50 6e 74 66 28 29 5d 20 69 73 20 75 73 65 64 20 69  ntf()] is used i
30b60 6e 74 65 72 6e 61 6c 6c 79 20 74 6f 20 70 65 72  nternally to per
30b70 66 6f 72 6d 20 74 68 65 0a 2a 2a 20 63 6f 6e 76  form the.** conv
30b80 65 72 73 69 6f 6e 20 61 75 74 6f 6d 61 74 69 63  ersion automatic
30b90 61 6c 6c 79 2e 20 20 5e 28 54 68 65 20 66 6f 6c  ally.  ^(The fol
30ba0 6c 6f 77 69 6e 67 20 74 61 62 6c 65 20 64 65 74  lowing table det
30bb0 61 69 6c 73 20 74 68 65 20 63 6f 6e 76 65 72 73  ails the convers
30bc0 69 6f 6e 73 0a 2a 2a 20 74 68 61 74 20 61 72 65  ions.** that are
30bd0 20 61 70 70 6c 69 65 64 3a 0a 2a 2a 0a 2a 2a 20   applied:.**.** 
30be0 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 2a 2a 20  <blockquote>.** 
30bf0 3c 74 61 62 6c 65 20 62 6f 72 64 65 72 3d 22 31  <table border="1
30c00 22 3e 0a 2a 2a 20 3c 74 72 3e 3c 74 68 3e 20 49  ">.** <tr><th> I
30c10 6e 74 65 72 6e 61 6c 3c 62 72 3e 54 79 70 65 20  nternal<br>Type 
30c20 3c 74 68 3e 20 52 65 71 75 65 73 74 65 64 3c 62  <th> Requested<b
30c30 72 3e 54 79 70 65 20 3c 74 68 3e 20 20 43 6f 6e  r>Type <th>  Con
30c40 76 65 72 73 69 6f 6e 0a 2a 2a 0a 2a 2a 20 3c 74  version.**.** <t
30c50 72 3e 3c 74 64 3e 20 20 4e 55 4c 4c 20 20 20 20  r><td>  NULL    
30c60 3c 74 64 3e 20 49 4e 54 45 47 45 52 20 20 20 3c  <td> INTEGER   <
30c70 74 64 3e 20 52 65 73 75 6c 74 20 69 73 20 30 0a  td> Result is 0.
30c80 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 4e 55 4c  ** <tr><td>  NUL
30c90 4c 20 20 20 20 3c 74 64 3e 20 20 46 4c 4f 41 54  L    <td>  FLOAT
30ca0 20 20 20 20 3c 74 64 3e 20 52 65 73 75 6c 74 20      <td> Result 
30cb0 69 73 20 30 2e 30 0a 2a 2a 20 3c 74 72 3e 3c 74  is 0.0.** <tr><t
30cc0 64 3e 20 20 4e 55 4c 4c 20 20 20 20 3c 74 64 3e  d>  NULL    <td>
30cd0 20 20 20 54 45 58 54 20 20 20 20 3c 74 64 3e 20     TEXT    <td> 
30ce0 52 65 73 75 6c 74 20 69 73 20 61 20 4e 55 4c 4c  Result is a NULL
30cf0 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 3c 74 72 3e   pointer.** <tr>
30d00 3c 74 64 3e 20 20 4e 55 4c 4c 20 20 20 20 3c 74  <td>  NULL    <t
30d10 64 3e 20 20 20 42 4c 4f 42 20 20 20 20 3c 74 64  d>   BLOB    <td
30d20 3e 20 52 65 73 75 6c 74 20 69 73 20 61 20 4e 55  > Result is a NU
30d30 4c 4c 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 3c 74  LL pointer.** <t
30d40 72 3e 3c 74 64 3e 20 49 4e 54 45 47 45 52 20 20  r><td> INTEGER  
30d50 3c 74 64 3e 20 20 46 4c 4f 41 54 20 20 20 20 3c  <td>  FLOAT    <
30d60 74 64 3e 20 43 6f 6e 76 65 72 74 20 66 72 6f 6d  td> Convert from
30d70 20 69 6e 74 65 67 65 72 20 74 6f 20 66 6c 6f 61   integer to floa
30d80 74 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 49 4e  t.** <tr><td> IN
30d90 54 45 47 45 52 20 20 3c 74 64 3e 20 20 20 54 45  TEGER  <td>   TE
30da0 58 54 20 20 20 20 3c 74 64 3e 20 41 53 43 49 49  XT    <td> ASCII
30db0 20 72 65 6e 64 65 72 69 6e 67 20 6f 66 20 74 68   rendering of th
30dc0 65 20 69 6e 74 65 67 65 72 0a 2a 2a 20 3c 74 72  e integer.** <tr
30dd0 3e 3c 74 64 3e 20 49 4e 54 45 47 45 52 20 20 3c  ><td> INTEGER  <
30de0 74 64 3e 20 20 20 42 4c 4f 42 20 20 20 20 3c 74  td>   BLOB    <t
30df0 64 3e 20 53 61 6d 65 20 61 73 20 49 4e 54 45 47  d> Same as INTEG
30e00 45 52 2d 3e 54 45 58 54 0a 2a 2a 20 3c 74 72 3e  ER->TEXT.** <tr>
30e10 3c 74 64 3e 20 20 46 4c 4f 41 54 20 20 20 3c 74  <td>  FLOAT   <t
30e20 64 3e 20 49 4e 54 45 47 45 52 20 20 20 3c 74 64  d> INTEGER   <td
30e30 3e 20 5b 43 41 53 54 5d 20 74 6f 20 49 4e 54 45  > [CAST] to INTE
30e40 47 45 52 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20  GER.** <tr><td> 
30e50 20 46 4c 4f 41 54 20 20 20 3c 74 64 3e 20 20 20   FLOAT   <td>   
30e60 54 45 58 54 20 20 20 20 3c 74 64 3e 20 41 53 43  TEXT    <td> ASC
30e70 49 49 20 72 65 6e 64 65 72 69 6e 67 20 6f 66 20  II rendering of 
30e80 74 68 65 20 66 6c 6f 61 74 0a 2a 2a 20 3c 74 72  the float.** <tr
30e90 3e 3c 74 64 3e 20 20 46 4c 4f 41 54 20 20 20 3c  ><td>  FLOAT   <
30ea0 74 64 3e 20 20 20 42 4c 4f 42 20 20 20 20 3c 74  td>   BLOB    <t
30eb0 64 3e 20 5b 43 41 53 54 5d 20 74 6f 20 42 4c 4f  d> [CAST] to BLO
30ec0 42 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 54  B.** <tr><td>  T
30ed0 45 58 54 20 20 20 20 3c 74 64 3e 20 49 4e 54 45  EXT    <td> INTE
30ee0 47 45 52 20 20 20 3c 74 64 3e 20 5b 43 41 53 54  GER   <td> [CAST
30ef0 5d 20 74 6f 20 49 4e 54 45 47 45 52 0a 2a 2a 20  ] to INTEGER.** 
30f00 3c 74 72 3e 3c 74 64 3e 20 20 54 45 58 54 20 20  <tr><td>  TEXT  
30f10 20 20 3c 74 64 3e 20 20 46 4c 4f 41 54 20 20 20    <td>  FLOAT   
30f20 20 3c 74 64 3e 20 5b 43 41 53 54 5d 20 74 6f 20   <td> [CAST] to 
30f30 52 45 41 4c 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e  REAL.** <tr><td>
30f40 20 20 54 45 58 54 20 20 20 20 3c 74 64 3e 20 20    TEXT    <td>  
30f50 20 42 4c 4f 42 20 20 20 20 3c 74 64 3e 20 4e 6f   BLOB    <td> No
30f60 20 63 68 61 6e 67 65 0a 2a 2a 20 3c 74 72 3e 3c   change.** <tr><
30f70 74 64 3e 20 20 42 4c 4f 42 20 20 20 20 3c 74 64  td>  BLOB    <td
30f80 3e 20 49 4e 54 45 47 45 52 20 20 20 3c 74 64 3e  > INTEGER   <td>
30f90 20 5b 43 41 53 54 5d 20 74 6f 20 49 4e 54 45 47   [CAST] to INTEG
30fa0 45 52 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20  ER.** <tr><td>  
30fb0 42 4c 4f 42 20 20 20 20 3c 74 64 3e 20 20 46 4c  BLOB    <td>  FL
30fc0 4f 41 54 20 20 20 20 3c 74 64 3e 20 5b 43 41 53  OAT    <td> [CAS
30fd0 54 5d 20 74 6f 20 52 45 41 4c 0a 2a 2a 20 3c 74  T] to REAL.** <t
30fe0 72 3e 3c 74 64 3e 20 20 42 4c 4f 42 20 20 20 20  r><td>  BLOB    
30ff0 3c 74 64 3e 20 20 20 54 45 58 54 20 20 20 20 3c  <td>   TEXT    <
31000 74 64 3e 20 41 64 64 20 61 20 7a 65 72 6f 20 74  td> Add a zero t
31010 65 72 6d 69 6e 61 74 6f 72 20 69 66 20 6e 65 65  erminator if nee
31020 64 65 64 0a 2a 2a 20 3c 2f 74 61 62 6c 65 3e 0a  ded.** </table>.
31030 2a 2a 20 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e  ** </blockquote>
31040 29 5e 0a 2a 2a 0a 2a 2a 20 4e 6f 74 65 20 74 68  )^.**.** Note th
31050 61 74 20 77 68 65 6e 20 74 79 70 65 20 63 6f 6e  at when type con
31060 76 65 72 73 69 6f 6e 73 20 6f 63 63 75 72 2c 20  versions occur, 
31070 70 6f 69 6e 74 65 72 73 20 72 65 74 75 72 6e 65  pointers returne
31080 64 20 62 79 20 70 72 69 6f 72 0a 2a 2a 20 63 61  d by prior.** ca
31090 6c 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 5f 63  lls to sqlite3_c
310a0 6f 6c 75 6d 6e 5f 62 6c 6f 62 28 29 2c 20 73 71  olumn_blob(), sq
310b0 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78  lite3_column_tex
310c0 74 28 29 2c 20 61 6e 64 2f 6f 72 0a 2a 2a 20 73  t(), and/or.** s
310d0 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65  qlite3_column_te
310e0 78 74 31 36 28 29 20 6d 61 79 20 62 65 20 69 6e  xt16() may be in
310f0 76 61 6c 69 64 61 74 65 64 2e 0a 2a 2a 20 54 79  validated..** Ty
31100 70 65 20 63 6f 6e 76 65 72 73 69 6f 6e 73 20 61  pe conversions a
31110 6e 64 20 70 6f 69 6e 74 65 72 20 69 6e 76 61 6c  nd pointer inval
31120 69 64 61 74 69 6f 6e 73 20 6d 69 67 68 74 20 6f  idations might o
31130 63 63 75 72 0a 2a 2a 20 69 6e 20 74 68 65 20 66  ccur.** in the f
31140 6f 6c 6c 6f 77 69 6e 67 20 63 61 73 65 73 3a 0a  ollowing cases:.
31150 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c  **.** <ul>.** <l
31160 69 3e 20 54 68 65 20 69 6e 69 74 69 61 6c 20 63  i> The initial c
31170 6f 6e 74 65 6e 74 20 69 73 20 61 20 42 4c 4f 42  ontent is a BLOB
31180 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 63 6f 6c   and sqlite3_col
31190 75 6d 6e 5f 74 65 78 74 28 29 20 6f 72 0a 2a 2a  umn_text() or.**
311a0 20 20 20 20 20 20 73 71 6c 69 74 65 33 5f 63 6f        sqlite3_co
311b0 6c 75 6d 6e 5f 74 65 78 74 31 36 28 29 20 69 73  lumn_text16() is
311c0 20 63 61 6c 6c 65 64 2e 20 20 41 20 7a 65 72 6f   called.  A zero
311d0 2d 74 65 72 6d 69 6e 61 74 6f 72 20 6d 69 67 68  -terminator migh
311e0 74 0a 2a 2a 20 20 20 20 20 20 6e 65 65 64 20 74  t.**      need t
311f0 6f 20 62 65 20 61 64 64 65 64 20 74 6f 20 74 68  o be added to th
31200 65 20 73 74 72 69 6e 67 2e 3c 2f 6c 69 3e 0a 2a  e string.</li>.*
31210 2a 20 3c 6c 69 3e 20 54 68 65 20 69 6e 69 74 69  * <li> The initi
31220 61 6c 20 63 6f 6e 74 65 6e 74 20 69 73 20 55 54  al content is UT
31230 46 2d 38 20 74 65 78 74 20 61 6e 64 20 73 71 6c  F-8 text and sql
31240 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65  ite3_column_byte
31250 73 31 36 28 29 20 6f 72 0a 2a 2a 20 20 20 20 20  s16() or.**     
31260 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
31270 74 65 78 74 31 36 28 29 20 69 73 20 63 61 6c 6c  text16() is call
31280 65 64 2e 20 20 54 68 65 20 63 6f 6e 74 65 6e 74  ed.  The content
31290 20 6d 75 73 74 20 62 65 20 63 6f 6e 76 65 72 74   must be convert
312a0 65 64 0a 2a 2a 20 20 20 20 20 20 74 6f 20 55 54  ed.**      to UT
312b0 46 2d 31 36 2e 3c 2f 6c 69 3e 0a 2a 2a 20 3c 6c  F-16.</li>.** <l
312c0 69 3e 20 54 68 65 20 69 6e 69 74 69 61 6c 20 63  i> The initial c
312d0 6f 6e 74 65 6e 74 20 69 73 20 55 54 46 2d 31 36  ontent is UTF-16
312e0 20 74 65 78 74 20 61 6e 64 20 73 71 6c 69 74 65   text and sqlite
312f0 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29  3_column_bytes()
31300 20 6f 72 0a 2a 2a 20 20 20 20 20 20 73 71 6c 69   or.**      sqli
31310 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28  te3_column_text(
31320 29 20 69 73 20 63 61 6c 6c 65 64 2e 20 20 54 68  ) is called.  Th
31330 65 20 63 6f 6e 74 65 6e 74 20 6d 75 73 74 20 62  e content must b
31340 65 20 63 6f 6e 76 65 72 74 65 64 0a 2a 2a 20 20  e converted.**  
31350 20 20 20 20 74 6f 20 55 54 46 2d 38 2e 3c 2f 6c      to UTF-8.</l
31360 69 3e 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 0a 2a  i>.** </ul>.**.*
31370 2a 20 5e 43 6f 6e 76 65 72 73 69 6f 6e 73 20 62  * ^Conversions b
31380 65 74 77 65 65 6e 20 55 54 46 2d 31 36 62 65 20  etween UTF-16be 
31390 61 6e 64 20 55 54 46 2d 31 36 6c 65 20 61 72 65  and UTF-16le are
313a0 20 61 6c 77 61 79 73 20 64 6f 6e 65 20 69 6e 20   always done in 
313b0 70 6c 61 63 65 20 61 6e 64 20 64 6f 0a 2a 2a 20  place and do.** 
313c0 6e 6f 74 20 69 6e 76 61 6c 69 64 61 74 65 20 61  not invalidate a
313d0 20 70 72 69 6f 72 20 70 6f 69 6e 74 65 72 2c 20   prior pointer, 
313e0 74 68 6f 75 67 68 20 6f 66 20 63 6f 75 72 73 65  though of course
313f0 20 74 68 65 20 63 6f 6e 74 65 6e 74 20 6f 66 20   the content of 
31400 74 68 65 20 62 75 66 66 65 72 0a 2a 2a 20 74 68  the buffer.** th
31410 61 74 20 74 68 65 20 70 72 69 6f 72 20 70 6f 69  at the prior poi
31420 6e 74 65 72 20 72 65 66 65 72 65 6e 63 65 73 20  nter references 
31430 77 69 6c 6c 20 68 61 76 65 20 62 65 65 6e 20 6d  will have been m
31440 6f 64 69 66 69 65 64 2e 20 20 4f 74 68 65 72 20  odified.  Other 
31450 6b 69 6e 64 73 0a 2a 2a 20 6f 66 20 63 6f 6e 76  kinds.** of conv
31460 65 72 73 69 6f 6e 20 61 72 65 20 64 6f 6e 65 20  ersion are done 
31470 69 6e 20 70 6c 61 63 65 20 77 68 65 6e 20 69 74  in place when it
31480 20 69 73 20 70 6f 73 73 69 62 6c 65 2c 20 62 75   is possible, bu
31490 74 20 73 6f 6d 65 74 69 6d 65 73 20 74 68 65 79  t sometimes they
314a0 0a 2a 2a 20 61 72 65 20 6e 6f 74 20 70 6f 73 73  .** are not poss
314b0 69 62 6c 65 20 61 6e 64 20 69 6e 20 74 68 6f 73  ible and in thos
314c0 65 20 63 61 73 65 73 20 70 72 69 6f 72 20 70 6f  e cases prior po
314d0 69 6e 74 65 72 73 20 61 72 65 20 69 6e 76 61 6c  inters are inval
314e0 69 64 61 74 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68  idated..**.** Th
314f0 65 20 73 61 66 65 73 74 20 70 6f 6c 69 63 79 20  e safest policy 
31500 69 73 20 74 6f 20 69 6e 76 6f 6b 65 20 74 68 65  is to invoke the
31510 73 65 20 72 6f 75 74 69 6e 65 73 0a 2a 2a 20 69  se routines.** i
31520 6e 20 6f 6e 65 20 6f 66 20 74 68 65 20 66 6f 6c  n one of the fol
31530 6c 6f 77 69 6e 67 20 77 61 79 73 3a 0a 2a 2a 0a  lowing ways:.**.
31540 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 20 3c 6c 69 3e  ** <ul>.**  <li>
31550 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74  sqlite3_column_t
31560 65 78 74 28 29 20 66 6f 6c 6c 6f 77 65 64 20 62  ext() followed b
31570 79 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  y sqlite3_column
31580 5f 62 79 74 65 73 28 29 3c 2f 6c 69 3e 0a 2a 2a  _bytes()</li>.**
31590 20 20 3c 6c 69 3e 73 71 6c 69 74 65 33 5f 63 6f    <li>sqlite3_co
315a0 6c 75 6d 6e 5f 62 6c 6f 62 28 29 20 66 6f 6c 6c  lumn_blob() foll
315b0 6f 77 65 64 20 62 79 20 73 71 6c 69 74 65 33 5f  owed by sqlite3_
315c0 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29 3c 2f  column_bytes()</
315d0 6c 69 3e 0a 2a 2a 20 20 3c 6c 69 3e 73 71 6c 69  li>.**  <li>sqli
315e0 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 31  te3_column_text1
315f0 36 28 29 20 66 6f 6c 6c 6f 77 65 64 20 62 79 20  6() followed by 
31600 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62  sqlite3_column_b
31610 79 74 65 73 31 36 28 29 3c 2f 6c 69 3e 0a 2a 2a  ytes16()</li>.**
31620 20 3c 2f 75 6c 3e 0a 2a 2a 0a 2a 2a 20 49 6e 20   </ul>.**.** In 
31630 6f 74 68 65 72 20 77 6f 72 64 73 2c 20 79 6f 75  other words, you
31640 20 73 68 6f 75 6c 64 20 63 61 6c 6c 20 73 71 6c   should call sql
31650 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74  ite3_column_text
31660 28 29 2c 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63  (),.** sqlite3_c
31670 6f 6c 75 6d 6e 5f 62 6c 6f 62 28 29 2c 20 6f 72  olumn_blob(), or
31680 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
31690 74 65 78 74 31 36 28 29 20 66 69 72 73 74 20 74  text16() first t
316a0 6f 20 66 6f 72 63 65 20 74 68 65 20 72 65 73 75  o force the resu
316b0 6c 74 0a 2a 2a 20 69 6e 74 6f 20 74 68 65 20 64  lt.** into the d
316c0 65 73 69 72 65 64 20 66 6f 72 6d 61 74 2c 20 74  esired format, t
316d0 68 65 6e 20 69 6e 76 6f 6b 65 20 73 71 6c 69 74  hen invoke sqlit
316e0 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28  e3_column_bytes(
316f0 29 20 6f 72 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  ) or.** sqlite3_
31700 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28 29  column_bytes16()
31710 20 74 6f 20 66 69 6e 64 20 74 68 65 20 73 69 7a   to find the siz
31720 65 20 6f 66 20 74 68 65 20 72 65 73 75 6c 74 2e  e of the result.
31730 20 20 44 6f 20 6e 6f 74 20 6d 69 78 20 63 61 6c    Do not mix cal
31740 6c 73 0a 2a 2a 20 74 6f 20 73 71 6c 69 74 65 33  ls.** to sqlite3
31750 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 29 20 6f  _column_text() o
31760 72 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  r sqlite3_column
31770 5f 62 6c 6f 62 28 29 20 77 69 74 68 20 63 61 6c  _blob() with cal
31780 6c 73 20 74 6f 0a 2a 2a 20 73 71 6c 69 74 65 33  ls to.** sqlite3
31790 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28  _column_bytes16(
317a0 29 2c 20 61 6e 64 20 64 6f 20 6e 6f 74 20 6d 69  ), and do not mi
317b0 78 20 63 61 6c 6c 73 20 74 6f 20 73 71 6c 69 74  x calls to sqlit
317c0 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 31 36  e3_column_text16
317d0 28 29 0a 2a 2a 20 77 69 74 68 20 63 61 6c 6c 73  ().** with calls
317e0 20 74 6f 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75   to sqlite3_colu
317f0 6d 6e 5f 62 79 74 65 73 28 29 2e 0a 2a 2a 0a 2a  mn_bytes()..**.*
31800 2a 20 5e 54 68 65 20 70 6f 69 6e 74 65 72 73 20  * ^The pointers 
31810 72 65 74 75 72 6e 65 64 20 61 72 65 20 76 61 6c  returned are val
31820 69 64 20 75 6e 74 69 6c 20 61 20 74 79 70 65 20  id until a type 
31830 63 6f 6e 76 65 72 73 69 6f 6e 20 6f 63 63 75 72  conversion occur
31840 73 20 61 73 0a 2a 2a 20 64 65 73 63 72 69 62 65  s as.** describe
31850 64 20 61 62 6f 76 65 2c 20 6f 72 20 75 6e 74 69  d above, or unti
31860 6c 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28  l [sqlite3_step(
31870 29 5d 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f 72  )] or [sqlite3_r
31880 65 73 65 74 28 29 5d 20 6f 72 0a 2a 2a 20 5b 73  eset()] or.** [s
31890 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28  qlite3_finalize(
318a0 29 5d 20 69 73 20 63 61 6c 6c 65 64 2e 20 20 5e  )] is called.  ^
318b0 54 68 65 20 6d 65 6d 6f 72 79 20 73 70 61 63 65  The memory space
318c0 20 75 73 65 64 20 74 6f 20 68 6f 6c 64 20 73 74   used to hold st
318d0 72 69 6e 67 73 0a 2a 2a 20 61 6e 64 20 42 4c 4f  rings.** and BLO
318e0 42 73 20 69 73 20 66 72 65 65 64 20 61 75 74 6f  Bs is freed auto
318f0 6d 61 74 69 63 61 6c 6c 79 2e 20 20 44 6f 20 3c  matically.  Do <
31900 65 6d 3e 6e 6f 74 3c 2f 65 6d 3e 20 70 61 73 73  em>not</em> pass
31910 20 74 68 65 20 70 6f 69 6e 74 65 72 73 20 72 65   the pointers re
31920 74 75 72 6e 65 64 0a 2a 2a 20 66 72 6f 6d 20 5b  turned.** from [
31930 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62  sqlite3_column_b
31940 6c 6f 62 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33  lob()], [sqlite3
31950 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 29 5d 2c  _column_text()],
31960 20 65 74 63 2e 20 69 6e 74 6f 0a 2a 2a 20 5b 73   etc. into.** [s
31970 71 6c 69 74 65 33 5f 66 72 65 65 28 29 5d 2e 0a  qlite3_free()]..
31980 2a 2a 0a 2a 2a 20 5e 28 49 66 20 61 20 6d 65 6d  **.** ^(If a mem
31990 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 65  ory allocation e
319a0 72 72 6f 72 20 6f 63 63 75 72 73 20 64 75 72 69  rror occurs duri
319b0 6e 67 20 74 68 65 20 65 76 61 6c 75 61 74 69 6f  ng the evaluatio
319c0 6e 20 6f 66 20 61 6e 79 0a 2a 2a 20 6f 66 20 74  n of any.** of t
319d0 68 65 73 65 20 72 6f 75 74 69 6e 65 73 2c 20 61  hese routines, a
319e0 20 64 65 66 61 75 6c 74 20 76 61 6c 75 65 20 69   default value i
319f0 73 20 72 65 74 75 72 6e 65 64 2e 20 20 54 68 65  s returned.  The
31a00 20 64 65 66 61 75 6c 74 20 76 61 6c 75 65 0a 2a   default value.*
31a10 2a 20 69 73 20 65 69 74 68 65 72 20 74 68 65 20  * is either the 
31a20 69 6e 74 65 67 65 72 20 30 2c 20 74 68 65 20 66  integer 0, the f
31a30 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 20 6e 75  loating point nu
31a40 6d 62 65 72 20 30 2e 30 2c 20 6f 72 20 61 20 4e  mber 0.0, or a N
31a50 55 4c 4c 0a 2a 2a 20 70 6f 69 6e 74 65 72 2e 20  ULL.** pointer. 
31a60 20 53 75 62 73 65 71 75 65 6e 74 20 63 61 6c 6c   Subsequent call
31a70 73 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 65 72  s to [sqlite3_er
31a80 72 63 6f 64 65 28 29 5d 20 77 69 6c 6c 20 72 65  rcode()] will re
31a90 74 75 72 6e 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f  turn.** [SQLITE_
31aa0 4e 4f 4d 45 4d 5d 2e 29 5e 0a 2a 2f 0a 63 6f 6e  NOMEM].)^.*/.con
31ab0 73 74 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33  st void *sqlite3
31ac0 5f 63 6f 6c 75 6d 6e 5f 62 6c 6f 62 28 73 71 6c  _column_blob(sql
31ad0 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20  ite3_stmt*, int 
31ae0 69 43 6f 6c 29 3b 0a 69 6e 74 20 73 71 6c 69 74  iCol);.int sqlit
31af0 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28  e3_column_bytes(
31b00 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69  sqlite3_stmt*, i
31b10 6e 74 20 69 43 6f 6c 29 3b 0a 69 6e 74 20 73 71  nt iCol);.int sq
31b20 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74  lite3_column_byt
31b30 65 73 31 36 28 73 71 6c 69 74 65 33 5f 73 74 6d  es16(sqlite3_stm
31b40 74 2a 2c 20 69 6e 74 20 69 43 6f 6c 29 3b 0a 64  t*, int iCol);.d
31b50 6f 75 62 6c 65 20 73 71 6c 69 74 65 33 5f 63 6f  ouble sqlite3_co
31b60 6c 75 6d 6e 5f 64 6f 75 62 6c 65 28 73 71 6c 69  lumn_double(sqli
31b70 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69  te3_stmt*, int i
31b80 43 6f 6c 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  Col);.int sqlite
31b90 33 5f 63 6f 6c 75 6d 6e 5f 69 6e 74 28 73 71 6c  3_column_int(sql
31ba0 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20  ite3_stmt*, int 
31bb0 69 43 6f 6c 29 3b 0a 73 71 6c 69 74 65 33 5f 69  iCol);.sqlite3_i
31bc0 6e 74 36 34 20 73 71 6c 69 74 65 33 5f 63 6f 6c  nt64 sqlite3_col
31bd0 75 6d 6e 5f 69 6e 74 36 34 28 73 71 6c 69 74 65  umn_int64(sqlite
31be0 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43 6f  3_stmt*, int iCo
31bf0 6c 29 3b 0a 63 6f 6e 73 74 20 75 6e 73 69 67 6e  l);.const unsign
31c00 65 64 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33  ed char *sqlite3
31c10 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 73 71 6c  _column_text(sql
31c20 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20  ite3_stmt*, int 
31c30 69 43 6f 6c 29 3b 0a 63 6f 6e 73 74 20 76 6f 69  iCol);.const voi
31c40 64 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  d *sqlite3_colum
31c50 6e 5f 74 65 78 74 31 36 28 73 71 6c 69 74 65 33  n_text16(sqlite3
31c60 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43 6f 6c  _stmt*, int iCol
31c70 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 63  );.int sqlite3_c
31c80 6f 6c 75 6d 6e 5f 74 79 70 65 28 73 71 6c 69 74  olumn_type(sqlit
31c90 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43  e3_stmt*, int iC
31ca0 6f 6c 29 3b 0a 73 71 6c 69 74 65 33 5f 76 61 6c  ol);.sqlite3_val
31cb0 75 65 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75  ue *sqlite3_colu
31cc0 6d 6e 5f 76 61 6c 75 65 28 73 71 6c 69 74 65 33  mn_value(sqlite3
31cd0 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43 6f 6c  _stmt*, int iCol
31ce0 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
31cf0 45 46 3a 20 44 65 73 74 72 6f 79 20 41 20 50 72  EF: Destroy A Pr
31d00 65 70 61 72 65 64 20 53 74 61 74 65 6d 65 6e 74  epared Statement
31d10 20 4f 62 6a 65 63 74 0a 2a 2a 20 44 45 53 54 52   Object.** DESTR
31d20 55 43 54 4f 52 3a 20 73 71 6c 69 74 65 33 5f 73  UCTOR: sqlite3_s
31d30 74 6d 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  tmt.**.** ^The s
31d40 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28  qlite3_finalize(
31d50 29 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 63 61  ) function is ca
31d60 6c 6c 65 64 20 74 6f 20 64 65 6c 65 74 65 20 61  lled to delete a
31d70 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65   [prepared state
31d80 6d 65 6e 74 5d 2e 0a 2a 2a 20 5e 49 66 20 74 68  ment]..** ^If th
31d90 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 20 65 76  e most recent ev
31da0 61 6c 75 61 74 69 6f 6e 20 6f 66 20 74 68 65 20  aluation of the 
31db0 73 74 61 74 65 6d 65 6e 74 20 65 6e 63 6f 75 6e  statement encoun
31dc0 74 65 72 65 64 20 6e 6f 20 65 72 72 6f 72 73 0a  tered no errors.
31dd0 2a 2a 20 6f 72 20 69 66 20 74 68 65 20 73 74 61  ** or if the sta
31de0 74 65 6d 65 6e 74 20 69 73 20 6e 65 76 65 72 20  tement is never 
31df0 62 65 65 6e 20 65 76 61 6c 75 61 74 65 64 2c 20  been evaluated, 
31e00 74 68 65 6e 20 73 71 6c 69 74 65 33 5f 66 69 6e  then sqlite3_fin
31e10 61 6c 69 7a 65 28 29 20 72 65 74 75 72 6e 73 0a  alize() returns.
31e20 2a 2a 20 53 51 4c 49 54 45 5f 4f 4b 2e 20 20 5e  ** SQLITE_OK.  ^
31e30 49 66 20 74 68 65 20 6d 6f 73 74 20 72 65 63 65  If the most rece
31e40 6e 74 20 65 76 61 6c 75 61 74 69 6f 6e 20 6f 66  nt evaluation of
31e50 20 73 74 61 74 65 6d 65 6e 74 20 53 20 66 61 69   statement S fai
31e60 6c 65 64 2c 20 74 68 65 6e 0a 2a 2a 20 73 71 6c  led, then.** sql
31e70 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28 53 29  ite3_finalize(S)
31e80 20 72 65 74 75 72 6e 73 20 74 68 65 20 61 70 70   returns the app
31e90 72 6f 70 72 69 61 74 65 20 5b 65 72 72 6f 72 20  ropriate [error 
31ea0 63 6f 64 65 5d 20 6f 72 0a 2a 2a 20 5b 65 78 74  code] or.** [ext
31eb0 65 6e 64 65 64 20 65 72 72 6f 72 20 63 6f 64 65  ended error code
31ec0 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71  ]..**.** ^The sq
31ed0 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28 53  lite3_finalize(S
31ee0 29 20 72 6f 75 74 69 6e 65 20 63 61 6e 20 62 65  ) routine can be
31ef0 20 63 61 6c 6c 65 64 20 61 74 20 61 6e 79 20 70   called at any p
31f00 6f 69 6e 74 20 64 75 72 69 6e 67 0a 2a 2a 20 74  oint during.** t
31f10 68 65 20 6c 69 66 65 20 63 79 63 6c 65 20 6f 66  he life cycle of
31f20 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65   [prepared state
31f30 6d 65 6e 74 5d 20 53 3a 0a 2a 2a 20 62 65 66 6f  ment] S:.** befo
31f40 72 65 20 73 74 61 74 65 6d 65 6e 74 20 53 20 69  re statement S i
31f50 73 20 65 76 65 72 20 65 76 61 6c 75 61 74 65 64  s ever evaluated
31f60 2c 20 61 66 74 65 72 0a 2a 2a 20 6f 6e 65 20 6f  , after.** one o
31f70 72 20 6d 6f 72 65 20 63 61 6c 6c 73 20 74 6f 20  r more calls to 
31f80 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29  [sqlite3_reset()
31f90 5d 2c 20 6f 72 20 61 66 74 65 72 20 61 6e 79 20  ], or after any 
31fa0 63 61 6c 6c 0a 2a 2a 20 74 6f 20 5b 73 71 6c 69  call.** to [sqli
31fb0 74 65 33 5f 73 74 65 70 28 29 5d 20 72 65 67 61  te3_step()] rega
31fc0 72 64 6c 65 73 73 20 6f 66 20 77 68 65 74 68 65  rdless of whethe
31fd0 72 20 6f 72 20 6e 6f 74 20 74 68 65 20 73 74 61  r or not the sta
31fe0 74 65 6d 65 6e 74 20 68 61 73 0a 2a 2a 20 63 6f  tement has.** co
31ff0 6d 70 6c 65 74 65 64 20 65 78 65 63 75 74 69 6f  mpleted executio
32000 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 49 6e 76 6f 6b 69  n..**.** ^Invoki
32010 6e 67 20 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c  ng sqlite3_final
32020 69 7a 65 28 29 20 6f 6e 20 61 20 4e 55 4c 4c 20  ize() on a NULL 
32030 70 6f 69 6e 74 65 72 20 69 73 20 61 20 68 61 72  pointer is a har
32040 6d 6c 65 73 73 20 6e 6f 2d 6f 70 2e 0a 2a 2a 0a  mless no-op..**.
32050 2a 2a 20 54 68 65 20 61 70 70 6c 69 63 61 74 69  ** The applicati
32060 6f 6e 20 6d 75 73 74 20 66 69 6e 61 6c 69 7a 65  on must finalize
32070 20 65 76 65 72 79 20 5b 70 72 65 70 61 72 65 64   every [prepared
32080 20 73 74 61 74 65 6d 65 6e 74 5d 20 69 6e 20 6f   statement] in o
32090 72 64 65 72 20 74 6f 20 61 76 6f 69 64 0a 2a 2a  rder to avoid.**
320a0 20 72 65 73 6f 75 72 63 65 20 6c 65 61 6b 73 2e   resource leaks.
320b0 20 20 49 74 20 69 73 20 61 20 67 72 69 65 76 6f    It is a grievo
320c0 75 73 20 65 72 72 6f 72 20 66 6f 72 20 74 68 65  us error for the
320d0 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 74 6f 20   application to 
320e0 74 72 79 20 74 6f 20 75 73 65 0a 2a 2a 20 61 20  try to use.** a 
320f0 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
32100 6e 74 20 61 66 74 65 72 20 69 74 20 68 61 73 20  nt after it has 
32110 62 65 65 6e 20 66 69 6e 61 6c 69 7a 65 64 2e 20  been finalized. 
32120 20 41 6e 79 20 75 73 65 20 6f 66 20 61 20 70 72   Any use of a pr
32130 65 70 61 72 65 64 0a 2a 2a 20 73 74 61 74 65 6d  epared.** statem
32140 65 6e 74 20 61 66 74 65 72 20 69 74 20 68 61 73  ent after it has
32150 20 62 65 65 6e 20 66 69 6e 61 6c 69 7a 65 64 20   been finalized 
32160 63 61 6e 20 72 65 73 75 6c 74 20 69 6e 20 75 6e  can result in un
32170 64 65 66 69 6e 65 64 20 61 6e 64 0a 2a 2a 20 75  defined and.** u
32180 6e 64 65 73 69 72 61 62 6c 65 20 62 65 68 61 76  ndesirable behav
32190 69 6f 72 20 73 75 63 68 20 61 73 20 73 65 67 66  ior such as segf
321a0 61 75 6c 74 73 20 61 6e 64 20 68 65 61 70 20 63  aults and heap c
321b0 6f 72 72 75 70 74 69 6f 6e 2e 0a 2a 2f 0a 69 6e  orruption..*/.in
321c0 74 20 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69  t sqlite3_finali
321d0 7a 65 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 20  ze(sqlite3_stmt 
321e0 2a 70 53 74 6d 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20  *pStmt);../*.** 
321f0 43 41 50 49 33 52 45 46 3a 20 52 65 73 65 74 20  CAPI3REF: Reset 
32200 41 20 50 72 65 70 61 72 65 64 20 53 74 61 74 65  A Prepared State
32210 6d 65 6e 74 20 4f 62 6a 65 63 74 0a 2a 2a 20 4d  ment Object.** M
32220 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f 73  ETHOD: sqlite3_s
32230 74 6d 74 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71  tmt.**.** The sq
32240 6c 69 74 65 33 5f 72 65 73 65 74 28 29 20 66 75  lite3_reset() fu
32250 6e 63 74 69 6f 6e 20 69 73 20 63 61 6c 6c 65 64  nction is called
32260 20 74 6f 20 72 65 73 65 74 20 61 20 5b 70 72 65   to reset a [pre
32270 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d  pared statement]
32280 0a 2a 2a 20 6f 62 6a 65 63 74 20 62 61 63 6b 20  .** object back 
32290 74 6f 20 69 74 73 20 69 6e 69 74 69 61 6c 20 73  to its initial s
322a0 74 61 74 65 2c 20 72 65 61 64 79 20 74 6f 20 62  tate, ready to b
322b0 65 20 72 65 2d 65 78 65 63 75 74 65 64 2e 0a 2a  e re-executed..*
322c0 2a 20 5e 41 6e 79 20 53 51 4c 20 73 74 61 74 65  * ^Any SQL state
322d0 6d 65 6e 74 20 76 61 72 69 61 62 6c 65 73 20 74  ment variables t
322e0 68 61 74 20 68 61 64 20 76 61 6c 75 65 73 20 62  hat had values b
322f0 6f 75 6e 64 20 74 6f 20 74 68 65 6d 20 75 73 69  ound to them usi
32300 6e 67 0a 2a 2a 20 74 68 65 20 5b 73 71 6c 69 74  ng.** the [sqlit
32310 65 33 5f 62 69 6e 64 5f 62 6c 6f 62 20 7c 20 73  e3_bind_blob | s
32320 71 6c 69 74 65 33 5f 62 69 6e 64 5f 2a 28 29 20  qlite3_bind_*() 
32330 41 50 49 5d 20 72 65 74 61 69 6e 20 74 68 65 69  API] retain thei
32340 72 20 76 61 6c 75 65 73 2e 0a 2a 2a 20 55 73 65  r values..** Use
32350 20 5b 73 71 6c 69 74 65 33 5f 63 6c 65 61 72 5f   [sqlite3_clear_
32360 62 69 6e 64 69 6e 67 73 28 29 5d 20 74 6f 20 72  bindings()] to r
32370 65 73 65 74 20 74 68 65 20 62 69 6e 64 69 6e 67  eset the binding
32380 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 5b 73  s..**.** ^The [s
32390 71 6c 69 74 65 33 5f 72 65 73 65 74 28 53 29 5d  qlite3_reset(S)]
323a0 20 69 6e 74 65 72 66 61 63 65 20 72 65 73 65 74   interface reset
323b0 73 20 74 68 65 20 5b 70 72 65 70 61 72 65 64 20  s the [prepared 
323c0 73 74 61 74 65 6d 65 6e 74 5d 20 53 0a 2a 2a 20  statement] S.** 
323d0 62 61 63 6b 20 74 6f 20 74 68 65 20 62 65 67 69  back to the begi
323e0 6e 6e 69 6e 67 20 6f 66 20 69 74 73 20 70 72 6f  nning of its pro
323f0 67 72 61 6d 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20  gram..**.** ^If 
32400 74 68 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 20  the most recent 
32410 63 61 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 65 33  call to [sqlite3
32420 5f 73 74 65 70 28 53 29 5d 20 66 6f 72 20 74 68  _step(S)] for th
32430 65 0a 2a 2a 20 5b 70 72 65 70 61 72 65 64 20 73  e.** [prepared s
32440 74 61 74 65 6d 65 6e 74 5d 20 53 20 72 65 74 75  tatement] S retu
32450 72 6e 65 64 20 5b 53 51 4c 49 54 45 5f 52 4f 57  rned [SQLITE_ROW
32460 5d 20 6f 72 20 5b 53 51 4c 49 54 45 5f 44 4f 4e  ] or [SQLITE_DON
32470 45 5d 2c 0a 2a 2a 20 6f 72 20 69 66 20 5b 73 71  E],.** or if [sq
32480 6c 69 74 65 33 5f 73 74 65 70 28 53 29 5d 20 68  lite3_step(S)] h
32490 61 73 20 6e 65 76 65 72 20 62 65 66 6f 72 65 20  as never before 
324a0 62 65 65 6e 20 63 61 6c 6c 65 64 20 6f 6e 20 53  been called on S
324b0 2c 0a 2a 2a 20 74 68 65 6e 20 5b 73 71 6c 69 74  ,.** then [sqlit
324c0 65 33 5f 72 65 73 65 74 28 53 29 5d 20 72 65 74  e3_reset(S)] ret
324d0 75 72 6e 73 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d  urns [SQLITE_OK]
324e0 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20  ..**.** ^If the 
324f0 6d 6f 73 74 20 72 65 63 65 6e 74 20 63 61 6c 6c  most recent call
32500 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 73 74 65   to [sqlite3_ste
32510 70 28 53 29 5d 20 66 6f 72 20 74 68 65 0a 2a 2a  p(S)] for the.**
32520 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65   [prepared state
32530 6d 65 6e 74 5d 20 53 20 69 6e 64 69 63 61 74 65  ment] S indicate
32540 64 20 61 6e 20 65 72 72 6f 72 2c 20 74 68 65 6e  d an error, then
32550 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 72 65 73  .** [sqlite3_res
32560 65 74 28 53 29 5d 20 72 65 74 75 72 6e 73 20 61  et(S)] returns a
32570 6e 20 61 70 70 72 6f 70 72 69 61 74 65 20 5b 65  n appropriate [e
32580 72 72 6f 72 20 63 6f 64 65 5d 2e 0a 2a 2a 0a 2a  rror code]..**.*
32590 2a 20 5e 54 68 65 20 5b 73 71 6c 69 74 65 33 5f  * ^The [sqlite3_
325a0 72 65 73 65 74 28 53 29 5d 20 69 6e 74 65 72 66  reset(S)] interf
325b0 61 63 65 20 64 6f 65 73 20 6e 6f 74 20 63 68 61  ace does not cha
325c0 6e 67 65 20 74 68 65 20 76 61 6c 75 65 73 0a 2a  nge the values.*
325d0 2a 20 6f 66 20 61 6e 79 20 5b 73 71 6c 69 74 65  * of any [sqlite
325e0 33 5f 62 69 6e 64 5f 62 6c 6f 62 7c 62 69 6e 64  3_bind_blob|bind
325f0 69 6e 67 73 5d 20 6f 6e 20 74 68 65 20 5b 70 72  ings] on the [pr
32600 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
32610 5d 20 53 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69  ] S..*/.int sqli
32620 74 65 33 5f 72 65 73 65 74 28 73 71 6c 69 74 65  te3_reset(sqlite
32630 33 5f 73 74 6d 74 20 2a 70 53 74 6d 74 29 3b 0a  3_stmt *pStmt);.
32640 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
32650 20 43 72 65 61 74 65 20 4f 72 20 52 65 64 65 66   Create Or Redef
32660 69 6e 65 20 53 51 4c 20 46 75 6e 63 74 69 6f 6e  ine SQL Function
32670 73 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b  s.** KEYWORDS: {
32680 66 75 6e 63 74 69 6f 6e 20 63 72 65 61 74 69 6f  function creatio
32690 6e 20 72 6f 75 74 69 6e 65 73 7d 0a 2a 2a 20 4b  n routines}.** K
326a0 45 59 57 4f 52 44 53 3a 20 7b 61 70 70 6c 69 63  EYWORDS: {applic
326b0 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51  ation-defined SQ
326c0 4c 20 66 75 6e 63 74 69 6f 6e 7d 0a 2a 2a 20 4b  L function}.** K
326d0 45 59 57 4f 52 44 53 3a 20 7b 61 70 70 6c 69 63  EYWORDS: {applic
326e0 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51  ation-defined SQ
326f0 4c 20 66 75 6e 63 74 69 6f 6e 73 7d 0a 2a 2a 20  L functions}.** 
32700 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 0a  METHOD: sqlite3.
32710 2a 2a 0a 2a 2a 20 5e 54 68 65 73 65 20 66 75 6e  **.** ^These fun
32720 63 74 69 6f 6e 73 20 28 63 6f 6c 6c 65 63 74 69  ctions (collecti
32730 76 65 6c 79 20 6b 6e 6f 77 6e 20 61 73 20 22 66  vely known as "f
32740 75 6e 63 74 69 6f 6e 20 63 72 65 61 74 69 6f 6e  unction creation
32750 20 72 6f 75 74 69 6e 65 73 22 29 0a 2a 2a 20 61   routines").** a
32760 72 65 20 75 73 65 64 20 74 6f 20 61 64 64 20 53  re used to add S
32770 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20 6f 72 20  QL functions or 
32780 61 67 67 72 65 67 61 74 65 73 20 6f 72 20 74 6f  aggregates or to
32790 20 72 65 64 65 66 69 6e 65 20 74 68 65 20 62 65   redefine the be
327a0 68 61 76 69 6f 72 0a 2a 2a 20 6f 66 20 65 78 69  havior.** of exi
327b0 73 74 69 6e 67 20 53 51 4c 20 66 75 6e 63 74 69  sting SQL functi
327c0 6f 6e 73 20 6f 72 20 61 67 67 72 65 67 61 74 65  ons or aggregate
327d0 73 2e 20 20 54 68 65 20 6f 6e 6c 79 20 64 69 66  s.  The only dif
327e0 66 65 72 65 6e 63 65 73 20 62 65 74 77 65 65 6e  ferences between
327f0 0a 2a 2a 20 74 68 65 73 65 20 72 6f 75 74 69 6e  .** these routin
32800 65 73 20 61 72 65 20 74 68 65 20 74 65 78 74 20  es are the text 
32810 65 6e 63 6f 64 69 6e 67 20 65 78 70 65 63 74 65  encoding expecte
32820 64 20 66 6f 72 0a 2a 2a 20 74 68 65 20 73 65 63  d for.** the sec
32830 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20 28 74  ond parameter (t
32840 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 66  he name of the f
32850 75 6e 63 74 69 6f 6e 20 62 65 69 6e 67 20 63 72  unction being cr
32860 65 61 74 65 64 29 0a 2a 2a 20 61 6e 64 20 74 68  eated).** and th
32870 65 20 70 72 65 73 65 6e 63 65 20 6f 72 20 61 62  e presence or ab
32880 73 65 6e 63 65 20 6f 66 20 61 20 64 65 73 74 72  sence of a destr
32890 75 63 74 6f 72 20 63 61 6c 6c 62 61 63 6b 20 66  uctor callback f
328a0 6f 72 0a 2a 2a 20 74 68 65 20 61 70 70 6c 69 63  or.** the applic
328b0 61 74 69 6f 6e 20 64 61 74 61 20 70 6f 69 6e 74  ation data point
328c0 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66  er..**.** ^The f
328d0 69 72 73 74 20 70 61 72 61 6d 65 74 65 72 20 69  irst parameter i
328e0 73 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20  s the [database 
328f0 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 74 6f 20 77  connection] to w
32900 68 69 63 68 20 74 68 65 20 53 51 4c 0a 2a 2a 20  hich the SQL.** 
32910 66 75 6e 63 74 69 6f 6e 20 69 73 20 74 6f 20 62  function is to b
32920 65 20 61 64 64 65 64 2e 20 20 5e 49 66 20 61 6e  e added.  ^If an
32930 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 75 73 65   application use
32940 73 20 6d 6f 72 65 20 74 68 61 6e 20 6f 6e 65 20  s more than one 
32950 64 61 74 61 62 61 73 65 0a 2a 2a 20 63 6f 6e 6e  database.** conn
32960 65 63 74 69 6f 6e 20 74 68 65 6e 20 61 70 70 6c  ection then appl
32970 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20  ication-defined 
32980 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20 6d 75  SQL functions mu
32990 73 74 20 62 65 20 61 64 64 65 64 0a 2a 2a 20 74  st be added.** t
329a0 6f 20 65 61 63 68 20 64 61 74 61 62 61 73 65 20  o each database 
329b0 63 6f 6e 6e 65 63 74 69 6f 6e 20 73 65 70 61 72  connection separ
329c0 61 74 65 6c 79 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  ately..**.** ^Th
329d0 65 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74  e second paramet
329e0 65 72 20 69 73 20 74 68 65 20 6e 61 6d 65 20 6f  er is the name o
329f0 66 20 74 68 65 20 53 51 4c 20 66 75 6e 63 74 69  f the SQL functi
32a00 6f 6e 20 74 6f 20 62 65 20 63 72 65 61 74 65 64  on to be created
32a10 20 6f 72 0a 2a 2a 20 72 65 64 65 66 69 6e 65 64   or.** redefined
32a20 2e 20 20 5e 54 68 65 20 6c 65 6e 67 74 68 20 6f  .  ^The length o
32a30 66 20 74 68 65 20 6e 61 6d 65 20 69 73 20 6c 69  f the name is li
32a40 6d 69 74 65 64 20 74 6f 20 32 35 35 20 62 79 74  mited to 255 byt
32a50 65 73 20 69 6e 20 61 20 55 54 46 2d 38 0a 2a 2a  es in a UTF-8.**
32a60 20 72 65 70 72 65 73 65 6e 74 61 74 69 6f 6e 2c   representation,
32a70 20 65 78 63 6c 75 73 69 76 65 20 6f 66 20 74 68   exclusive of th
32a80 65 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74 6f  e zero-terminato
32a90 72 2e 20 20 5e 4e 6f 74 65 20 74 68 61 74 20 74  r.  ^Note that t
32aa0 68 65 20 6e 61 6d 65 0a 2a 2a 20 6c 65 6e 67 74  he name.** lengt
32ab0 68 20 6c 69 6d 69 74 20 69 73 20 69 6e 20 55 54  h limit is in UT
32ac0 46 2d 38 20 62 79 74 65 73 2c 20 6e 6f 74 20 63  F-8 bytes, not c
32ad0 68 61 72 61 63 74 65 72 73 20 6e 6f 72 20 55 54  haracters nor UT
32ae0 46 2d 31 36 20 62 79 74 65 73 2e 20 20 0a 2a 2a  F-16 bytes.  .**
32af0 20 5e 41 6e 79 20 61 74 74 65 6d 70 74 20 74 6f   ^Any attempt to
32b00 20 63 72 65 61 74 65 20 61 20 66 75 6e 63 74 69   create a functi
32b10 6f 6e 20 77 69 74 68 20 61 20 6c 6f 6e 67 65 72  on with a longer
32b20 20 6e 61 6d 65 0a 2a 2a 20 77 69 6c 6c 20 72 65   name.** will re
32b30 73 75 6c 74 20 69 6e 20 5b 53 51 4c 49 54 45 5f  sult in [SQLITE_
32b40 4d 49 53 55 53 45 5d 20 62 65 69 6e 67 20 72 65  MISUSE] being re
32b50 74 75 72 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54  turned..**.** ^T
32b60 68 65 20 74 68 69 72 64 20 70 61 72 61 6d 65 74  he third paramet
32b70 65 72 20 28 6e 41 72 67 29 0a 2a 2a 20 69 73 20  er (nArg).** is 
32b80 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 61 72  the number of ar
32b90 67 75 6d 65 6e 74 73 20 74 68 61 74 20 74 68 65  guments that the
32ba0 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 6f 72   SQL function or
32bb0 0a 2a 2a 20 61 67 67 72 65 67 61 74 65 20 74 61  .** aggregate ta
32bc0 6b 65 73 2e 20 5e 49 66 20 74 68 69 73 20 70 61  kes. ^If this pa
32bd0 72 61 6d 65 74 65 72 20 69 73 20 2d 31 2c 20 74  rameter is -1, t
32be0 68 65 6e 20 74 68 65 20 53 51 4c 20 66 75 6e 63  hen the SQL func
32bf0 74 69 6f 6e 20 6f 72 0a 2a 2a 20 61 67 67 72 65  tion or.** aggre
32c00 67 61 74 65 20 6d 61 79 20 74 61 6b 65 20 61 6e  gate may take an
32c10 79 20 6e 75 6d 62 65 72 20 6f 66 20 61 72 67 75  y number of argu
32c20 6d 65 6e 74 73 20 62 65 74 77 65 65 6e 20 30 20  ments between 0 
32c30 61 6e 64 20 74 68 65 20 6c 69 6d 69 74 0a 2a 2a  and the limit.**
32c40 20 73 65 74 20 62 79 20 5b 73 71 6c 69 74 65 33   set by [sqlite3
32c50 5f 6c 69 6d 69 74 5d 28 5b 53 51 4c 49 54 45 5f  _limit]([SQLITE_
32c60 4c 49 4d 49 54 5f 46 55 4e 43 54 49 4f 4e 5f 41  LIMIT_FUNCTION_A
32c70 52 47 5d 29 2e 20 20 49 66 20 74 68 65 20 74 68  RG]).  If the th
32c80 69 72 64 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72  ird.** parameter
32c90 20 69 73 20 6c 65 73 73 20 74 68 61 6e 20 2d 31   is less than -1
32ca0 20 6f 72 20 67 72 65 61 74 65 72 20 74 68 61 6e   or greater than
32cb0 20 31 32 37 20 74 68 65 6e 20 74 68 65 20 62 65   127 then the be
32cc0 68 61 76 69 6f 72 20 69 73 0a 2a 2a 20 75 6e 64  havior is.** und
32cd0 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54  efined..**.** ^T
32ce0 68 65 20 66 6f 75 72 74 68 20 70 61 72 61 6d 65  he fourth parame
32cf0 74 65 72 2c 20 65 54 65 78 74 52 65 70 2c 20 73  ter, eTextRep, s
32d00 70 65 63 69 66 69 65 73 20 77 68 61 74 0a 2a 2a  pecifies what.**
32d10 20 5b 53 51 4c 49 54 45 5f 55 54 46 38 20 7c 20   [SQLITE_UTF8 | 
32d20 74 65 78 74 20 65 6e 63 6f 64 69 6e 67 5d 20 74  text encoding] t
32d30 68 69 73 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  his SQL function
32d40 20 70 72 65 66 65 72 73 20 66 6f 72 0a 2a 2a 20   prefers for.** 
32d50 69 74 73 20 70 61 72 61 6d 65 74 65 72 73 2e 20  its parameters. 
32d60 20 54 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   The application
32d70 20 73 68 6f 75 6c 64 20 73 65 74 20 74 68 69 73   should set this
32d80 20 70 61 72 61 6d 65 74 65 72 20 74 6f 0a 2a 2a   parameter to.**
32d90 20 5b 53 51 4c 49 54 45 5f 55 54 46 31 36 4c 45   [SQLITE_UTF16LE
32da0 5d 20 69 66 20 74 68 65 20 66 75 6e 63 74 69 6f  ] if the functio
32db0 6e 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  n implementation
32dc0 20 69 6e 76 6f 6b 65 73 20 0a 2a 2a 20 5b 73 71   invokes .** [sq
32dd0 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 65 78 74  lite3_value_text
32de0 31 36 6c 65 28 29 5d 20 6f 6e 20 61 6e 20 69 6e  16le()] on an in
32df0 70 75 74 2c 20 6f 72 20 5b 53 51 4c 49 54 45 5f  put, or [SQLITE_
32e00 55 54 46 31 36 42 45 5d 20 69 66 20 74 68 65 0a  UTF16BE] if the.
32e10 2a 2a 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f  ** implementatio
32e20 6e 20 69 6e 76 6f 6b 65 73 20 5b 73 71 6c 69 74  n invokes [sqlit
32e30 65 33 5f 76 61 6c 75 65 5f 74 65 78 74 31 36 62  e3_value_text16b
32e40 65 28 29 5d 20 6f 6e 20 61 6e 20 69 6e 70 75 74  e()] on an input
32e50 2c 20 6f 72 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f  , or.** [SQLITE_
32e60 55 54 46 31 36 5d 20 69 66 20 5b 73 71 6c 69 74  UTF16] if [sqlit
32e70 65 33 5f 76 61 6c 75 65 5f 74 65 78 74 31 36 28  e3_value_text16(
32e80 29 5d 20 69 73 20 75 73 65 64 2c 20 6f 72 20 5b  )] is used, or [
32e90 53 51 4c 49 54 45 5f 55 54 46 38 5d 0a 2a 2a 20  SQLITE_UTF8].** 
32ea0 6f 74 68 65 72 77 69 73 65 2e 20 20 5e 54 68 65  otherwise.  ^The
32eb0 20 73 61 6d 65 20 53 51 4c 20 66 75 6e 63 74 69   same SQL functi
32ec0 6f 6e 20 6d 61 79 20 62 65 20 72 65 67 69 73 74  on may be regist
32ed0 65 72 65 64 20 6d 75 6c 74 69 70 6c 65 20 74 69  ered multiple ti
32ee0 6d 65 73 20 75 73 69 6e 67 0a 2a 2a 20 64 69 66  mes using.** dif
32ef0 66 65 72 65 6e 74 20 70 72 65 66 65 72 72 65 64  ferent preferred
32f00 20 74 65 78 74 20 65 6e 63 6f 64 69 6e 67 73 2c   text encodings,
32f10 20 77 69 74 68 20 64 69 66 66 65 72 65 6e 74 20   with different 
32f20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20  implementations 
32f30 66 6f 72 0a 2a 2a 20 65 61 63 68 20 65 6e 63 6f  for.** each enco
32f40 64 69 6e 67 2e 0a 2a 2a 20 5e 57 68 65 6e 20 6d  ding..** ^When m
32f50 75 6c 74 69 70 6c 65 20 69 6d 70 6c 65 6d 65 6e  ultiple implemen
32f60 74 61 74 69 6f 6e 73 20 6f 66 20 74 68 65 20 73  tations of the s
32f70 61 6d 65 20 66 75 6e 63 74 69 6f 6e 20 61 72 65  ame function are
32f80 20 61 76 61 69 6c 61 62 6c 65 2c 20 53 51 4c 69   available, SQLi
32f90 74 65 0a 2a 2a 20 77 69 6c 6c 20 70 69 63 6b 20  te.** will pick 
32fa0 74 68 65 20 6f 6e 65 20 74 68 61 74 20 69 6e 76  the one that inv
32fb0 6f 6c 76 65 73 20 74 68 65 20 6c 65 61 73 74 20  olves the least 
32fc0 61 6d 6f 75 6e 74 20 6f 66 20 64 61 74 61 20 63  amount of data c
32fd0 6f 6e 76 65 72 73 69 6f 6e 2e 0a 2a 2a 0a 2a 2a  onversion..**.**
32fe0 20 5e 54 68 65 20 66 6f 75 72 74 68 20 70 61 72   ^The fourth par
32ff0 61 6d 65 74 65 72 20 6d 61 79 20 6f 70 74 69 6f  ameter may optio
33000 6e 61 6c 6c 79 20 62 65 20 4f 52 65 64 20 77 69  nally be ORed wi
33010 74 68 20 5b 53 51 4c 49 54 45 5f 44 45 54 45 52  th [SQLITE_DETER
33020 4d 49 4e 49 53 54 49 43 5d 0a 2a 2a 20 74 6f 20  MINISTIC].** to 
33030 73 69 67 6e 61 6c 20 74 68 61 74 20 74 68 65 20  signal that the 
33040 66 75 6e 63 74 69 6f 6e 20 77 69 6c 6c 20 61 6c  function will al
33050 77 61 79 73 20 72 65 74 75 72 6e 20 74 68 65 20  ways return the 
33060 73 61 6d 65 20 72 65 73 75 6c 74 20 67 69 76 65  same result give
33070 6e 0a 2a 2a 20 74 68 65 20 73 61 6d 65 20 69 6e  n.** the same in
33080 70 75 74 73 20 77 69 74 68 69 6e 20 61 20 73 69  puts within a si
33090 6e 67 6c 65 20 53 51 4c 20 73 74 61 74 65 6d 65  ngle SQL stateme
330a0 6e 74 2e 20 20 4d 6f 73 74 20 53 51 4c 20 66 75  nt.  Most SQL fu
330b0 6e 63 74 69 6f 6e 73 20 61 72 65 0a 2a 2a 20 64  nctions are.** d
330c0 65 74 65 72 6d 69 6e 69 73 74 69 63 2e 20 20 54  eterministic.  T
330d0 68 65 20 62 75 69 6c 74 2d 69 6e 20 5b 72 61 6e  he built-in [ran
330e0 64 6f 6d 28 29 5d 20 53 51 4c 20 66 75 6e 63 74  dom()] SQL funct
330f0 69 6f 6e 20 69 73 20 61 6e 20 65 78 61 6d 70 6c  ion is an exampl
33100 65 20 6f 66 20 61 0a 2a 2a 20 66 75 6e 63 74 69  e of a.** functi
33110 6f 6e 20 74 68 61 74 20 69 73 20 6e 6f 74 20 64  on that is not d
33120 65 74 65 72 6d 69 6e 69 73 74 69 63 2e 20 20 54  eterministic.  T
33130 68 65 20 53 51 4c 69 74 65 20 71 75 65 72 79 20  he SQLite query 
33140 70 6c 61 6e 6e 65 72 20 69 73 20 61 62 6c 65 20  planner is able 
33150 74 6f 0a 2a 2a 20 70 65 72 66 6f 72 6d 20 61 64  to.** perform ad
33160 64 69 74 69 6f 6e 61 6c 20 6f 70 74 69 6d 69 7a  ditional optimiz
33170 61 74 69 6f 6e 73 20 6f 6e 20 64 65 74 65 72 6d  ations on determ
33180 69 6e 69 73 74 69 63 20 66 75 6e 63 74 69 6f 6e  inistic function
33190 73 2c 20 73 6f 20 75 73 65 0a 2a 2a 20 6f 66 20  s, so use.** of 
331a0 74 68 65 20 5b 53 51 4c 49 54 45 5f 44 45 54 45  the [SQLITE_DETE
331b0 52 4d 49 4e 49 53 54 49 43 5d 20 66 6c 61 67 20  RMINISTIC] flag 
331c0 69 73 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 77  is recommended w
331d0 68 65 72 65 20 70 6f 73 73 69 62 6c 65 2e 0a 2a  here possible..*
331e0 2a 0a 2a 2a 20 5e 28 54 68 65 20 66 69 66 74 68  *.** ^(The fifth
331f0 20 70 61 72 61 6d 65 74 65 72 20 69 73 20 61 6e   parameter is an
33200 20 61 72 62 69 74 72 61 72 79 20 70 6f 69 6e 74   arbitrary point
33210 65 72 2e 20 20 54 68 65 20 69 6d 70 6c 65 6d 65  er.  The impleme
33220 6e 74 61 74 69 6f 6e 20 6f 66 20 74 68 65 0a 2a  ntation of the.*
33230 2a 20 66 75 6e 63 74 69 6f 6e 20 63 61 6e 20 67  * function can g
33240 61 69 6e 20 61 63 63 65 73 73 20 74 6f 20 74 68  ain access to th
33250 69 73 20 70 6f 69 6e 74 65 72 20 75 73 69 6e 67  is pointer using
33260 20 5b 73 71 6c 69 74 65 33 5f 75 73 65 72 5f 64   [sqlite3_user_d
33270 61 74 61 28 29 5d 2e 29 5e 0a 2a 2a 0a 2a 2a 20  ata()].)^.**.** 
33280 5e 54 68 65 20 73 69 78 74 68 2c 20 73 65 76 65  ^The sixth, seve
33290 6e 74 68 20 61 6e 64 20 65 69 67 68 74 68 20 70  nth and eighth p
332a0 61 72 61 6d 65 74 65 72 73 2c 20 78 46 75 6e 63  arameters, xFunc
332b0 2c 20 78 53 74 65 70 20 61 6e 64 20 78 46 69 6e  , xStep and xFin
332c0 61 6c 2c 20 61 72 65 0a 2a 2a 20 70 6f 69 6e 74  al, are.** point
332d0 65 72 73 20 74 6f 20 43 2d 6c 61 6e 67 75 61 67  ers to C-languag
332e0 65 20 66 75 6e 63 74 69 6f 6e 73 20 74 68 61 74  e functions that
332f0 20 69 6d 70 6c 65 6d 65 6e 74 20 74 68 65 20 53   implement the S
33300 51 4c 20 66 75 6e 63 74 69 6f 6e 20 6f 72 0a 2a  QL function or.*
33310 2a 20 61 67 67 72 65 67 61 74 65 2e 20 5e 41 20  * aggregate. ^A 
33320 73 63 61 6c 61 72 20 53 51 4c 20 66 75 6e 63 74  scalar SQL funct
33330 69 6f 6e 20 72 65 71 75 69 72 65 73 20 61 6e 20  ion requires an 
33340 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 6f  implementation o
33350 66 20 74 68 65 20 78 46 75 6e 63 0a 2a 2a 20 63  f the xFunc.** c
33360 61 6c 6c 62 61 63 6b 20 6f 6e 6c 79 3b 20 4e 55  allback only; NU
33370 4c 4c 20 70 6f 69 6e 74 65 72 73 20 6d 75 73 74  LL pointers must
33380 20 62 65 20 70 61 73 73 65 64 20 61 73 20 74 68   be passed as th
33390 65 20 78 53 74 65 70 20 61 6e 64 20 78 46 69 6e  e xStep and xFin
333a0 61 6c 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72 73  al.** parameters
333b0 2e 20 5e 41 6e 20 61 67 67 72 65 67 61 74 65 20  . ^An aggregate 
333c0 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 72 65 71  SQL function req
333d0 75 69 72 65 73 20 61 6e 20 69 6d 70 6c 65 6d 65  uires an impleme
333e0 6e 74 61 74 69 6f 6e 20 6f 66 20 78 53 74 65 70  ntation of xStep
333f0 0a 2a 2a 20 61 6e 64 20 78 46 69 6e 61 6c 20 61  .** and xFinal a
33400 6e 64 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20  nd NULL pointer 
33410 6d 75 73 74 20 62 65 20 70 61 73 73 65 64 20 66  must be passed f
33420 6f 72 20 78 46 75 6e 63 2e 20 5e 54 6f 20 64 65  or xFunc. ^To de
33430 6c 65 74 65 20 61 6e 20 65 78 69 73 74 69 6e 67  lete an existing
33440 0a 2a 2a 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  .** SQL function
33450 20 6f 72 20 61 67 67 72 65 67 61 74 65 2c 20 70   or aggregate, p
33460 61 73 73 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72  ass NULL pointer
33470 73 20 66 6f 72 20 61 6c 6c 20 74 68 72 65 65 20  s for all three 
33480 66 75 6e 63 74 69 6f 6e 0a 2a 2a 20 63 61 6c 6c  function.** call
33490 62 61 63 6b 73 2e 0a 2a 2a 0a 2a 2a 20 5e 28 49  backs..**.** ^(I
334a0 66 20 74 68 65 20 6e 69 6e 74 68 20 70 61 72 61  f the ninth para
334b0 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33  meter to sqlite3
334c0 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e  _create_function
334d0 5f 76 32 28 29 20 69 73 20 6e 6f 74 20 4e 55 4c  _v2() is not NUL
334e0 4c 2c 0a 2a 2a 20 74 68 65 6e 20 69 74 20 69 73  L,.** then it is
334f0 20 64 65 73 74 72 75 63 74 6f 72 20 66 6f 72 20   destructor for 
33500 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20  the application 
33510 64 61 74 61 20 70 6f 69 6e 74 65 72 2e 20 0a 2a  data pointer. .*
33520 2a 20 54 68 65 20 64 65 73 74 72 75 63 74 6f 72  * The destructor
33530 20 69 73 20 69 6e 76 6f 6b 65 64 20 77 68 65 6e   is invoked when
33540 20 74 68 65 20 66 75 6e 63 74 69 6f 6e 20 69 73   the function is
33550 20 64 65 6c 65 74 65 64 2c 20 65 69 74 68 65 72   deleted, either
33560 20 62 79 20 62 65 69 6e 67 0a 2a 2a 20 6f 76 65   by being.** ove
33570 72 6c 6f 61 64 65 64 20 6f 72 20 77 68 65 6e 20  rloaded or when 
33580 74 68 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e  the database con
33590 6e 65 63 74 69 6f 6e 20 63 6c 6f 73 65 73 2e 29  nection closes.)
335a0 5e 0a 2a 2a 20 5e 54 68 65 20 64 65 73 74 72 75  ^.** ^The destru
335b0 63 74 6f 72 20 69 73 20 61 6c 73 6f 20 69 6e 76  ctor is also inv
335c0 6f 6b 65 64 20 69 66 20 74 68 65 20 63 61 6c 6c  oked if the call
335d0 20 74 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63   to.** sqlite3_c
335e0 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 5f 76  reate_function_v
335f0 32 28 29 20 66 61 69 6c 73 2e 0a 2a 2a 20 5e 57  2() fails..** ^W
33600 68 65 6e 20 74 68 65 20 64 65 73 74 72 75 63 74  hen the destruct
33610 6f 72 20 63 61 6c 6c 62 61 63 6b 20 6f 66 20 74  or callback of t
33620 68 65 20 74 65 6e 74 68 20 70 61 72 61 6d 65 74  he tenth paramet
33630 65 72 20 69 73 20 69 6e 76 6f 6b 65 64 2c 20 69  er is invoked, i
33640 74 0a 2a 2a 20 69 73 20 70 61 73 73 65 64 20 61  t.** is passed a
33650 20 73 69 6e 67 6c 65 20 61 72 67 75 6d 65 6e 74   single argument
33660 20 77 68 69 63 68 20 69 73 20 61 20 63 6f 70 79   which is a copy
33670 20 6f 66 20 74 68 65 20 61 70 70 6c 69 63 61 74   of the applicat
33680 69 6f 6e 20 64 61 74 61 20 0a 2a 2a 20 70 6f 69  ion data .** poi
33690 6e 74 65 72 20 77 68 69 63 68 20 77 61 73 20 74  nter which was t
336a0 68 65 20 66 69 66 74 68 20 70 61 72 61 6d 65 74  he fifth paramet
336b0 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 63 72  er to sqlite3_cr
336c0 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 5f 76 32  eate_function_v2
336d0 28 29 2e 0a 2a 2a 0a 2a 2a 20 5e 49 74 20 69 73  ()..**.** ^It is
336e0 20 70 65 72 6d 69 74 74 65 64 20 74 6f 20 72 65   permitted to re
336f0 67 69 73 74 65 72 20 6d 75 6c 74 69 70 6c 65 20  gister multiple 
33700 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20  implementations 
33710 6f 66 20 74 68 65 20 73 61 6d 65 0a 2a 2a 20 66  of the same.** f
33720 75 6e 63 74 69 6f 6e 73 20 77 69 74 68 20 74 68  unctions with th
33730 65 20 73 61 6d 65 20 6e 61 6d 65 20 62 75 74 20  e same name but 
33740 77 69 74 68 20 65 69 74 68 65 72 20 64 69 66 66  with either diff
33750 65 72 69 6e 67 20 6e 75 6d 62 65 72 73 20 6f 66  ering numbers of
33760 0a 2a 2a 20 61 72 67 75 6d 65 6e 74 73 20 6f 72  .** arguments or
33770 20 64 69 66 66 65 72 69 6e 67 20 70 72 65 66 65   differing prefe
33780 72 72 65 64 20 74 65 78 74 20 65 6e 63 6f 64 69  rred text encodi
33790 6e 67 73 2e 20 20 5e 53 51 4c 69 74 65 20 77 69  ngs.  ^SQLite wi
337a0 6c 6c 20 75 73 65 0a 2a 2a 20 74 68 65 20 69 6d  ll use.** the im
337b0 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 74 68 61  plementation tha
337c0 74 20 6d 6f 73 74 20 63 6c 6f 73 65 6c 79 20 6d  t most closely m
337d0 61 74 63 68 65 73 20 74 68 65 20 77 61 79 20 69  atches the way i
337e0 6e 20 77 68 69 63 68 20 74 68 65 0a 2a 2a 20 53  n which the.** S
337f0 51 4c 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 75  QL function is u
33800 73 65 64 2e 20 20 5e 41 20 66 75 6e 63 74 69 6f  sed.  ^A functio
33810 6e 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  n implementation
33820 20 77 69 74 68 20 61 20 6e 6f 6e 2d 6e 65 67 61   with a non-nega
33830 74 69 76 65 0a 2a 2a 20 6e 41 72 67 20 70 61 72  tive.** nArg par
33840 61 6d 65 74 65 72 20 69 73 20 61 20 62 65 74 74  ameter is a bett
33850 65 72 20 6d 61 74 63 68 20 74 68 61 6e 20 61 20  er match than a 
33860 66 75 6e 63 74 69 6f 6e 20 69 6d 70 6c 65 6d 65  function impleme
33870 6e 74 61 74 69 6f 6e 20 77 69 74 68 0a 2a 2a 20  ntation with.** 
33880 61 20 6e 65 67 61 74 69 76 65 20 6e 41 72 67 2e  a negative nArg.
33890 20 20 5e 41 20 66 75 6e 63 74 69 6f 6e 20 77 68    ^A function wh
338a0 65 72 65 20 74 68 65 20 70 72 65 66 65 72 72 65  ere the preferre
338b0 64 20 74 65 78 74 20 65 6e 63 6f 64 69 6e 67 0a  d text encoding.
338c0 2a 2a 20 6d 61 74 63 68 65 73 20 74 68 65 20 64  ** matches the d
338d0 61 74 61 62 61 73 65 20 65 6e 63 6f 64 69 6e 67  atabase encoding
338e0 20 69 73 20 61 20 62 65 74 74 65 72 0a 2a 2a 20   is a better.** 
338f0 6d 61 74 63 68 20 74 68 61 6e 20 61 20 66 75 6e  match than a fun
33900 63 74 69 6f 6e 20 77 68 65 72 65 20 74 68 65 20  ction where the 
33910 65 6e 63 6f 64 69 6e 67 20 69 73 20 64 69 66 66  encoding is diff
33920 65 72 65 6e 74 2e 20 20 0a 2a 2a 20 5e 41 20 66  erent.  .** ^A f
33930 75 6e 63 74 69 6f 6e 20 77 68 65 72 65 20 74 68  unction where th
33940 65 20 65 6e 63 6f 64 69 6e 67 20 64 69 66 66 65  e encoding diffe
33950 72 65 6e 63 65 20 69 73 20 62 65 74 77 65 65 6e  rence is between
33960 20 55 54 46 31 36 6c 65 20 61 6e 64 20 55 54 46   UTF16le and UTF
33970 31 36 62 65 0a 2a 2a 20 69 73 20 61 20 63 6c 6f  16be.** is a clo
33980 73 65 72 20 6d 61 74 63 68 20 74 68 61 6e 20 61  ser match than a
33990 20 66 75 6e 63 74 69 6f 6e 20 77 68 65 72 65 20   function where 
339a0 74 68 65 20 65 6e 63 6f 64 69 6e 67 20 64 69 66  the encoding dif
339b0 66 65 72 65 6e 63 65 20 69 73 0a 2a 2a 20 62 65  ference is.** be
339c0 74 77 65 65 6e 20 55 54 46 38 20 61 6e 64 20 55  tween UTF8 and U
339d0 54 46 31 36 2e 0a 2a 2a 0a 2a 2a 20 5e 42 75 69  TF16..**.** ^Bui
339e0 6c 74 2d 69 6e 20 66 75 6e 63 74 69 6f 6e 73 20  lt-in functions 
339f0 6d 61 79 20 62 65 20 6f 76 65 72 6c 6f 61 64 65  may be overloade
33a00 64 20 62 79 20 6e 65 77 20 61 70 70 6c 69 63 61  d by new applica
33a10 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 66 75 6e  tion-defined fun
33a20 63 74 69 6f 6e 73 2e 0a 2a 2a 0a 2a 2a 20 5e 41  ctions..**.** ^A
33a30 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65  n application-de
33a40 66 69 6e 65 64 20 66 75 6e 63 74 69 6f 6e 20 69  fined function i
33a50 73 20 70 65 72 6d 69 74 74 65 64 20 74 6f 20 63  s permitted to c
33a60 61 6c 6c 20 6f 74 68 65 72 0a 2a 2a 20 53 51 4c  all other.** SQL
33a70 69 74 65 20 69 6e 74 65 72 66 61 63 65 73 2e 20  ite interfaces. 
33a80 20 48 6f 77 65 76 65 72 2c 20 73 75 63 68 20 63   However, such c
33a90 61 6c 6c 73 20 6d 75 73 74 20 6e 6f 74 0a 2a 2a  alls must not.**
33aa0 20 63 6c 6f 73 65 20 74 68 65 20 64 61 74 61 62   close the datab
33ab0 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 6e  ase connection n
33ac0 6f 72 20 66 69 6e 61 6c 69 7a 65 20 6f 72 20 72  or finalize or r
33ad0 65 73 65 74 20 74 68 65 20 70 72 65 70 61 72 65  eset the prepare
33ae0 64 0a 2a 2a 20 73 74 61 74 65 6d 65 6e 74 20 69  d.** statement i
33af0 6e 20 77 68 69 63 68 20 74 68 65 20 66 75 6e 63  n which the func
33b00 74 69 6f 6e 20 69 73 20 72 75 6e 6e 69 6e 67 2e  tion is running.
33b10 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .*/.int sqlite3_
33b20 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 28  create_function(
33b30 0a 20 20 73 71 6c 69 74 65 33 20 2a 64 62 2c 0a  .  sqlite3 *db,.
33b40 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 46    const char *zF
33b50 75 6e 63 74 69 6f 6e 4e 61 6d 65 2c 0a 20 20 69  unctionName,.  i
33b60 6e 74 20 6e 41 72 67 2c 0a 20 20 69 6e 74 20 65  nt nArg,.  int e
33b70 54 65 78 74 52 65 70 2c 0a 20 20 76 6f 69 64 20  TextRep,.  void 
33b80 2a 70 41 70 70 2c 0a 20 20 76 6f 69 64 20 28 2a  *pApp,.  void (*
33b90 78 46 75 6e 63 29 28 73 71 6c 69 74 65 33 5f 63  xFunc)(sqlite3_c
33ba0 6f 6e 74 65 78 74 2a 2c 69 6e 74 2c 73 71 6c 69  ontext*,int,sqli
33bb0 74 65 33 5f 76 61 6c 75 65 2a 2a 29 2c 0a 20 20  te3_value**),.  
33bc0 76 6f 69 64 20 28 2a 78 53 74 65 70 29 28 73 71  void (*xStep)(sq
33bd0 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 2c 69  lite3_context*,i
33be0 6e 74 2c 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  nt,sqlite3_value
33bf0 2a 2a 29 2c 0a 20 20 76 6f 69 64 20 28 2a 78 46  **),.  void (*xF
33c00 69 6e 61 6c 29 28 73 71 6c 69 74 65 33 5f 63 6f  inal)(sqlite3_co
33c10 6e 74 65 78 74 2a 29 0a 29 3b 0a 69 6e 74 20 73  ntext*).);.int s
33c20 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75  qlite3_create_fu
33c30 6e 63 74 69 6f 6e 31 36 28 0a 20 20 73 71 6c 69  nction16(.  sqli
33c40 74 65 33 20 2a 64 62 2c 0a 20 20 63 6f 6e 73 74  te3 *db,.  const
33c50 20 76 6f 69 64 20 2a 7a 46 75 6e 63 74 69 6f 6e   void *zFunction
33c60 4e 61 6d 65 2c 0a 20 20 69 6e 74 20 6e 41 72 67  Name,.  int nArg
33c70 2c 0a 20 20 69 6e 74 20 65 54 65 78 74 52 65 70  ,.  int eTextRep
33c80 2c 0a 20 20 76 6f 69 64 20 2a 70 41 70 70 2c 0a  ,.  void *pApp,.
33c90 20 20 76 6f 69 64 20 28 2a 78 46 75 6e 63 29 28    void (*xFunc)(
33ca0 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a  sqlite3_context*
33cb0 2c 69 6e 74 2c 73 71 6c 69 74 65 33 5f 76 61 6c  ,int,sqlite3_val
33cc0 75 65 2a 2a 29 2c 0a 20 20 76 6f 69 64 20 28 2a  ue**),.  void (*
33cd0 78 53 74 65 70 29 28 73 71 6c 69 74 65 33 5f 63  xStep)(sqlite3_c
33ce0 6f 6e 74 65 78 74 2a 2c 69 6e 74 2c 73 71 6c 69  ontext*,int,sqli
33cf0 74 65 33 5f 76 61 6c 75 65 2a 2a 29 2c 0a 20 20  te3_value**),.  
33d00 76 6f 69 64 20 28 2a 78 46 69 6e 61 6c 29 28 73  void (*xFinal)(s
33d10 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 29  qlite3_context*)
33d20 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .);.int sqlite3_
33d30 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 5f  create_function_
33d40 76 32 28 0a 20 20 73 71 6c 69 74 65 33 20 2a 64  v2(.  sqlite3 *d
33d50 62 2c 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20  b,.  const char 
33d60 2a 7a 46 75 6e 63 74 69 6f 6e 4e 61 6d 65 2c 0a  *zFunctionName,.
33d70 20 20 69 6e 74 20 6e 41 72 67 2c 0a 20 20 69 6e    int nArg,.  in
33d80 74 20 65 54 65 78 74 52 65 70 2c 0a 20 20 76 6f  t eTextRep,.  vo
33d90 69 64 20 2a 70 41 70 70 2c 0a 20 20 76 6f 69 64  id *pApp,.  void
33da0 20 28 2a 78 46 75 6e 63 29 28 73 71 6c 69 74 65   (*xFunc)(sqlite
33db0 33 5f 63 6f 6e 74 65 78 74 2a 2c 69 6e 74 2c 73  3_context*,int,s
33dc0 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 2a 29 2c  qlite3_value**),
33dd0 0a 20 20 76 6f 69 64 20 28 2a 78 53 74 65 70 29  .  void (*xStep)
33de0 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74  (sqlite3_context
33df0 2a 2c 69 6e 74 2c 73 71 6c 69 74 65 33 5f 76 61  *,int,sqlite3_va
33e00 6c 75 65 2a 2a 29 2c 0a 20 20 76 6f 69 64 20 28  lue**),.  void (
33e10 2a 78 46 69 6e 61 6c 29 28 73 71 6c 69 74 65 33  *xFinal)(sqlite3
33e20 5f 63 6f 6e 74 65 78 74 2a 29 2c 0a 20 20 76 6f  _context*),.  vo
33e30 69 64 28 2a 78 44 65 73 74 72 6f 79 29 28 76 6f  id(*xDestroy)(vo
33e40 69 64 2a 29 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43  id*).);../*.** C
33e50 41 50 49 33 52 45 46 3a 20 54 65 78 74 20 45 6e  API3REF: Text En
33e60 63 6f 64 69 6e 67 73 0a 2a 2a 0a 2a 2a 20 54 68  codings.**.** Th
33e70 65 73 65 20 63 6f 6e 73 74 61 6e 74 20 64 65 66  ese constant def
33e80 69 6e 65 20 69 6e 74 65 67 65 72 20 63 6f 64 65  ine integer code
33e90 73 20 74 68 61 74 20 72 65 70 72 65 73 65 6e 74  s that represent
33ea0 20 74 68 65 20 76 61 72 69 6f 75 73 0a 2a 2a 20   the various.** 
33eb0 74 65 78 74 20 65 6e 63 6f 64 69 6e 67 73 20 73  text encodings s
33ec0 75 70 70 6f 72 74 65 64 20 62 79 20 53 51 4c 69  upported by SQLi
33ed0 74 65 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53  te..*/.#define S
33ee0 51 4c 49 54 45 5f 55 54 46 38 20 20 20 20 20 20  QLITE_UTF8      
33ef0 20 20 20 20 20 31 20 20 20 20 2f 2a 20 49 4d 50       1    /* IMP
33f00 3a 20 52 2d 33 37 35 31 34 2d 33 35 35 36 36 20  : R-37514-35566 
33f10 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
33f20 45 5f 55 54 46 31 36 4c 45 20 20 20 20 20 20 20  E_UTF16LE       
33f30 20 32 20 20 20 20 2f 2a 20 49 4d 50 3a 20 52 2d   2    /* IMP: R-
33f40 30 33 33 37 31 2d 33 37 36 33 37 20 2a 2f 0a 23  03371-37637 */.#
33f50 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 55 54  define SQLITE_UT
33f60 46 31 36 42 45 20 20 20 20 20 20 20 20 33 20 20  F16BE        3  
33f70 20 20 2f 2a 20 49 4d 50 3a 20 52 2d 35 31 39 37    /* IMP: R-5197
33f80 31 2d 33 34 31 35 34 20 2a 2f 0a 23 64 65 66 69  1-34154 */.#defi
33f90 6e 65 20 53 51 4c 49 54 45 5f 55 54 46 31 36 20  ne SQLITE_UTF16 
33fa0 20 20 20 20 20 20 20 20 20 34 20 20 20 20 2f 2a           4    /*
33fb0 20 55 73 65 20 6e 61 74 69 76 65 20 62 79 74 65   Use native byte
33fc0 20 6f 72 64 65 72 20 2a 2f 0a 23 64 65 66 69 6e   order */.#defin
33fd0 65 20 53 51 4c 49 54 45 5f 41 4e 59 20 20 20 20  e SQLITE_ANY    
33fe0 20 20 20 20 20 20 20 20 35 20 20 20 20 2f 2a 20          5    /* 
33ff0 44 65 70 72 65 63 61 74 65 64 20 2a 2f 0a 23 64  Deprecated */.#d
34000 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 55 54 46  efine SQLITE_UTF
34010 31 36 5f 41 4c 49 47 4e 45 44 20 20 38 20 20 20  16_ALIGNED  8   
34020 20 2f 2a 20 73 71 6c 69 74 65 33 5f 63 72 65 61   /* sqlite3_crea
34030 74 65 5f 63 6f 6c 6c 61 74 69 6f 6e 20 6f 6e 6c  te_collation onl
34040 79 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  y */../*.** CAPI
34050 33 52 45 46 3a 20 46 75 6e 63 74 69 6f 6e 20 46  3REF: Function F
34060 6c 61 67 73 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65  lags.**.** These
34070 20 63 6f 6e 73 74 61 6e 74 73 20 6d 61 79 20 62   constants may b
34080 65 20 4f 52 65 64 20 74 6f 67 65 74 68 65 72 20  e ORed together 
34090 77 69 74 68 20 74 68 65 20 0a 2a 2a 20 5b 53 51  with the .** [SQ
340a0 4c 49 54 45 5f 55 54 46 38 20 7c 20 70 72 65 66  LITE_UTF8 | pref
340b0 65 72 72 65 64 20 74 65 78 74 20 65 6e 63 6f 64  erred text encod
340c0 69 6e 67 5d 20 61 73 20 74 68 65 20 66 6f 75 72  ing] as the four
340d0 74 68 20 61 72 67 75 6d 65 6e 74 0a 2a 2a 20 74  th argument.** t
340e0 6f 20 5b 73 71 6c 69 74 65 33 5f 63 72 65 61 74  o [sqlite3_creat
340f0 65 5f 66 75 6e 63 74 69 6f 6e 28 29 5d 2c 20 5b  e_function()], [
34100 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 66  sqlite3_create_f
34110 75 6e 63 74 69 6f 6e 31 36 28 29 5d 2c 20 6f 72  unction16()], or
34120 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63 72 65  .** [sqlite3_cre
34130 61 74 65 5f 66 75 6e 63 74 69 6f 6e 5f 76 32 28  ate_function_v2(
34140 29 5d 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53  )]..*/.#define S
34150 51 4c 49 54 45 5f 44 45 54 45 52 4d 49 4e 49 53  QLITE_DETERMINIS
34160 54 49 43 20 20 20 20 30 78 38 30 30 0a 0a 2f 2a  TIC    0x800../*
34170 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 44 65  .** CAPI3REF: De
34180 70 72 65 63 61 74 65 64 20 46 75 6e 63 74 69 6f  precated Functio
34190 6e 73 0a 2a 2a 20 44 45 50 52 45 43 41 54 45 44  ns.** DEPRECATED
341a0 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 66 75 6e  .**.** These fun
341b0 63 74 69 6f 6e 73 20 61 72 65 20 5b 64 65 70 72  ctions are [depr
341c0 65 63 61 74 65 64 5d 2e 20 20 49 6e 20 6f 72 64  ecated].  In ord
341d0 65 72 20 74 6f 20 6d 61 69 6e 74 61 69 6e 0a 2a  er to maintain.*
341e0 2a 20 62 61 63 6b 77 61 72 64 73 20 63 6f 6d 70  * backwards comp
341f0 61 74 69 62 69 6c 69 74 79 20 77 69 74 68 20 6f  atibility with o
34200 6c 64 65 72 20 63 6f 64 65 2c 20 74 68 65 73 65  lder code, these
34210 20 66 75 6e 63 74 69 6f 6e 73 20 63 6f 6e 74 69   functions conti
34220 6e 75 65 20 0a 2a 2a 20 74 6f 20 62 65 20 73 75  nue .** to be su
34230 70 70 6f 72 74 65 64 2e 20 20 48 6f 77 65 76 65  pported.  Howeve
34240 72 2c 20 6e 65 77 20 61 70 70 6c 69 63 61 74 69  r, new applicati
34250 6f 6e 73 20 73 68 6f 75 6c 64 20 61 76 6f 69 64  ons should avoid
34260 0a 2a 2a 20 74 68 65 20 75 73 65 20 6f 66 20 74  .** the use of t
34270 68 65 73 65 20 66 75 6e 63 74 69 6f 6e 73 2e 20  hese functions. 
34280 20 54 6f 20 65 6e 63 6f 75 72 61 67 65 20 70 72   To encourage pr
34290 6f 67 72 61 6d 6d 65 72 73 20 74 6f 20 61 76 6f  ogrammers to avo
342a0 69 64 0a 2a 2a 20 74 68 65 73 65 20 66 75 6e 63  id.** these func
342b0 74 69 6f 6e 73 2c 20 77 65 20 77 69 6c 6c 20 6e  tions, we will n
342c0 6f 74 20 65 78 70 6c 61 69 6e 20 77 68 61 74 20  ot explain what 
342d0 74 68 65 79 20 64 6f 2e 0a 2a 2f 0a 23 69 66 6e  they do..*/.#ifn
342e0 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  def SQLITE_OMIT_
342f0 44 45 50 52 45 43 41 54 45 44 0a 53 51 4c 49 54  DEPRECATED.SQLIT
34300 45 5f 44 45 50 52 45 43 41 54 45 44 20 69 6e 74  E_DEPRECATED int
34310 20 73 71 6c 69 74 65 33 5f 61 67 67 72 65 67 61   sqlite3_aggrega
34320 74 65 5f 63 6f 75 6e 74 28 73 71 6c 69 74 65 33  te_count(sqlite3
34330 5f 63 6f 6e 74 65 78 74 2a 29 3b 0a 53 51 4c 49  _context*);.SQLI
34340 54 45 5f 44 45 50 52 45 43 41 54 45 44 20 69 6e  TE_DEPRECATED in
34350 74 20 73 71 6c 69 74 65 33 5f 65 78 70 69 72 65  t sqlite3_expire
34360 64 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 29  d(sqlite3_stmt*)
34370 3b 0a 53 51 4c 49 54 45 5f 44 45 50 52 45 43 41  ;.SQLITE_DEPRECA
34380 54 45 44 20 69 6e 74 20 73 71 6c 69 74 65 33 5f  TED int sqlite3_
34390 74 72 61 6e 73 66 65 72 5f 62 69 6e 64 69 6e 67  transfer_binding
343a0 73 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c  s(sqlite3_stmt*,
343b0 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 29 3b   sqlite3_stmt*);
343c0 0a 53 51 4c 49 54 45 5f 44 45 50 52 45 43 41 54  .SQLITE_DEPRECAT
343d0 45 44 20 69 6e 74 20 73 71 6c 69 74 65 33 5f 67  ED int sqlite3_g
343e0 6c 6f 62 61 6c 5f 72 65 63 6f 76 65 72 28 76 6f  lobal_recover(vo
343f0 69 64 29 3b 0a 53 51 4c 49 54 45 5f 44 45 50 52  id);.SQLITE_DEPR
34400 45 43 41 54 45 44 20 76 6f 69 64 20 73 71 6c 69  ECATED void sqli
34410 74 65 33 5f 74 68 72 65 61 64 5f 63 6c 65 61 6e  te3_thread_clean
34420 75 70 28 76 6f 69 64 29 3b 0a 53 51 4c 49 54 45  up(void);.SQLITE
34430 5f 44 45 50 52 45 43 41 54 45 44 20 69 6e 74 20  _DEPRECATED int 
34440 73 71 6c 69 74 65 33 5f 6d 65 6d 6f 72 79 5f 61  sqlite3_memory_a
34450 6c 61 72 6d 28 76 6f 69 64 28 2a 29 28 76 6f 69  larm(void(*)(voi
34460 64 2a 2c 73 71 6c 69 74 65 33 5f 69 6e 74 36 34  d*,sqlite3_int64
34470 2c 69 6e 74 29 2c 0a 20 20 20 20 20 20 20 20 20  ,int),.         
34480 20 20 20 20 20 20 20 20 20 20 20 20 20 76 6f 69               voi
34490 64 2a 2c 73 71 6c 69 74 65 33 5f 69 6e 74 36 34  d*,sqlite3_int64
344a0 29 3b 0a 23 65 6e 64 69 66 0a 0a 2f 2a 0a 2a 2a  );.#endif../*.**
344b0 20 43 41 50 49 33 52 45 46 3a 20 4f 62 74 61 69   CAPI3REF: Obtai
344c0 6e 69 6e 67 20 53 51 4c 20 56 61 6c 75 65 73 0a  ning SQL Values.
344d0 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74  ** METHOD: sqlit
344e0 65 33 5f 76 61 6c 75 65 0a 2a 2a 0a 2a 2a 20 54  e3_value.**.** T
344f0 68 65 20 43 2d 6c 61 6e 67 75 61 67 65 20 69 6d  he C-language im
34500 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20  plementation of 
34510 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20 61 6e  SQL functions an
34520 64 20 61 67 67 72 65 67 61 74 65 73 20 75 73 65  d aggregates use
34530 73 0a 2a 2a 20 74 68 69 73 20 73 65 74 20 6f 66  s.** this set of
34540 20 69 6e 74 65 72 66 61 63 65 20 72 6f 75 74 69   interface routi
34550 6e 65 73 20 74 6f 20 61 63 63 65 73 73 20 74 68  nes to access th
34560 65 20 70 61 72 61 6d 65 74 65 72 20 76 61 6c 75  e parameter valu
34570 65 73 20 6f 6e 0a 2a 2a 20 74 68 65 20 66 75 6e  es on.** the fun
34580 63 74 69 6f 6e 20 6f 72 20 61 67 67 72 65 67 61  ction or aggrega
34590 74 65 2e 20 20 0a 2a 2a 0a 2a 2a 20 54 68 65 20  te.  .**.** The 
345a0 78 46 75 6e 63 20 28 66 6f 72 20 73 63 61 6c 61  xFunc (for scala
345b0 72 20 66 75 6e 63 74 69 6f 6e 73 29 20 6f 72 20  r functions) or 
345c0 78 53 74 65 70 20 28 66 6f 72 20 61 67 67 72 65  xStep (for aggre
345d0 67 61 74 65 73 29 20 70 61 72 61 6d 65 74 65 72  gates) parameter
345e0 73 0a 2a 2a 20 74 6f 20 5b 73 71 6c 69 74 65 33  s.** to [sqlite3
345f0 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e  _create_function
34600 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 33  ()] and [sqlite3
34610 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e  _create_function
34620 31 36 28 29 5d 0a 2a 2a 20 64 65 66 69 6e 65 20  16()].** define 
34630 63 61 6c 6c 62 61 63 6b 73 20 74 68 61 74 20 69  callbacks that i
34640 6d 70 6c 65 6d 65 6e 74 20 74 68 65 20 53 51 4c  mplement the SQL
34650 20 66 75 6e 63 74 69 6f 6e 73 20 61 6e 64 20 61   functions and a
34660 67 67 72 65 67 61 74 65 73 2e 0a 2a 2a 20 54 68  ggregates..** Th
34670 65 20 33 72 64 20 70 61 72 61 6d 65 74 65 72 20  e 3rd parameter 
34680 74 6f 20 74 68 65 73 65 20 63 61 6c 6c 62 61 63  to these callbac
34690 6b 73 20 69 73 20 61 6e 20 61 72 72 61 79 20 6f  ks is an array o
346a0 66 20 70 6f 69 6e 74 65 72 73 20 74 6f 0a 2a 2a  f pointers to.**
346b0 20 5b 70 72 6f 74 65 63 74 65 64 20 73 71 6c 69   [protected sqli
346c0 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62 6a 65 63  te3_value] objec
346d0 74 73 2e 20 20 54 68 65 72 65 20 69 73 20 6f 6e  ts.  There is on
346e0 65 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  e [sqlite3_value
346f0 5d 20 6f 62 6a 65 63 74 20 66 6f 72 0a 2a 2a 20  ] object for.** 
34700 65 61 63 68 20 70 61 72 61 6d 65 74 65 72 20 74  each parameter t
34710 6f 20 74 68 65 20 53 51 4c 20 66 75 6e 63 74 69  o the SQL functi
34720 6f 6e 2e 20 20 54 68 65 73 65 20 72 6f 75 74 69  on.  These routi
34730 6e 65 73 20 61 72 65 20 75 73 65 64 20 74 6f 0a  nes are used to.
34740 2a 2a 20 65 78 74 72 61 63 74 20 76 61 6c 75 65  ** extract value
34750 73 20 66 72 6f 6d 20 74 68 65 20 5b 73 71 6c 69  s from the [sqli
34760 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62 6a 65 63  te3_value] objec
34770 74 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20  ts..**.** These 
34780 72 6f 75 74 69 6e 65 73 20 77 6f 72 6b 20 6f 6e  routines work on
34790 6c 79 20 77 69 74 68 20 5b 70 72 6f 74 65 63 74  ly with [protect
347a0 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  ed sqlite3_value
347b0 5d 20 6f 62 6a 65 63 74 73 2e 0a 2a 2a 20 41 6e  ] objects..** An
347c0 79 20 61 74 74 65 6d 70 74 20 74 6f 20 75 73 65  y attempt to use
347d0 20 74 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20   these routines 
347e0 6f 6e 20 61 6e 20 5b 75 6e 70 72 6f 74 65 63 74  on an [unprotect
347f0 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  ed sqlite3_value
34800 5d 0a 2a 2a 20 6f 62 6a 65 63 74 20 72 65 73 75  ].** object resu
34810 6c 74 73 20 69 6e 20 75 6e 64 65 66 69 6e 65 64  lts in undefined
34820 20 62 65 68 61 76 69 6f 72 2e 0a 2a 2a 0a 2a 2a   behavior..**.**
34830 20 5e 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73   ^These routines
34840 20 77 6f 72 6b 20 6a 75 73 74 20 6c 69 6b 65 20   work just like 
34850 74 68 65 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e  the correspondin
34860 67 20 5b 63 6f 6c 75 6d 6e 20 61 63 63 65 73 73  g [column access
34870 20 66 75 6e 63 74 69 6f 6e 73 5d 0a 2a 2a 20 65   functions].** e
34880 78 63 65 70 74 20 74 68 61 74 20 74 68 65 73 65  xcept that these
34890 20 72 6f 75 74 69 6e 65 73 20 74 61 6b 65 20 61   routines take a
348a0 20 73 69 6e 67 6c 65 20 5b 70 72 6f 74 65 63 74   single [protect
348b0 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  ed sqlite3_value
348c0 5d 20 6f 62 6a 65 63 74 0a 2a 2a 20 70 6f 69 6e  ] object.** poin
348d0 74 65 72 20 69 6e 73 74 65 61 64 20 6f 66 20 61  ter instead of a
348e0 20 5b 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 5d   [sqlite3_stmt*]
348f0 20 70 6f 69 6e 74 65 72 20 61 6e 64 20 61 6e 20   pointer and an 
34900 69 6e 74 65 67 65 72 20 63 6f 6c 75 6d 6e 20 6e  integer column n
34910 75 6d 62 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  umber..**.** ^Th
34920 65 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f  e sqlite3_value_
34930 74 65 78 74 31 36 28 29 20 69 6e 74 65 72 66 61  text16() interfa
34940 63 65 20 65 78 74 72 61 63 74 73 20 61 20 55 54  ce extracts a UT
34950 46 2d 31 36 20 73 74 72 69 6e 67 0a 2a 2a 20 69  F-16 string.** i
34960 6e 20 74 68 65 20 6e 61 74 69 76 65 20 62 79 74  n the native byt
34970 65 2d 6f 72 64 65 72 20 6f 66 20 74 68 65 20 68  e-order of the h
34980 6f 73 74 20 6d 61 63 68 69 6e 65 2e 20 20 5e 54  ost machine.  ^T
34990 68 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 76 61  he.** sqlite3_va
349a0 6c 75 65 5f 74 65 78 74 31 36 62 65 28 29 20 61  lue_text16be() a
349b0 6e 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  nd sqlite3_value
349c0 5f 74 65 78 74 31 36 6c 65 28 29 20 69 6e 74 65  _text16le() inte
349d0 72 66 61 63 65 73 0a 2a 2a 20 65 78 74 72 61 63  rfaces.** extrac
349e0 74 20 55 54 46 2d 31 36 20 73 74 72 69 6e 67 73  t UTF-16 strings
349f0 20 61 73 20 62 69 67 2d 65 6e 64 69 61 6e 20 61   as big-endian a
34a00 6e 64 20 6c 69 74 74 6c 65 2d 65 6e 64 69 61 6e  nd little-endian
34a10 20 72 65 73 70 65 63 74 69 76 65 6c 79 2e 0a 2a   respectively..*
34a20 2a 0a 2a 2a 20 5e 28 54 68 65 20 73 71 6c 69 74  *.** ^(The sqlit
34a30 65 33 5f 76 61 6c 75 65 5f 6e 75 6d 65 72 69 63  e3_value_numeric
34a40 5f 74 79 70 65 28 29 20 69 6e 74 65 72 66 61 63  _type() interfac
34a50 65 20 61 74 74 65 6d 70 74 73 20 74 6f 20 61 70  e attempts to ap
34a60 70 6c 79 0a 2a 2a 20 6e 75 6d 65 72 69 63 20 61  ply.** numeric a
34a70 66 66 69 6e 69 74 79 20 74 6f 20 74 68 65 20 76  ffinity to the v
34a80 61 6c 75 65 2e 20 20 54 68 69 73 20 6d 65 61 6e  alue.  This mean
34a90 73 20 74 68 61 74 20 61 6e 20 61 74 74 65 6d 70  s that an attemp
34aa0 74 20 69 73 0a 2a 2a 20 6d 61 64 65 20 74 6f 20  t is.** made to 
34ab0 63 6f 6e 76 65 72 74 20 74 68 65 20 76 61 6c 75  convert the valu
34ac0 65 20 74 6f 20 61 6e 20 69 6e 74 65 67 65 72 20  e to an integer 
34ad0 6f 72 20 66 6c 6f 61 74 69 6e 67 20 70 6f 69 6e  or floating poin
34ae0 74 2e 20 20 49 66 0a 2a 2a 20 73 75 63 68 20 61  t.  If.** such a
34af0 20 63 6f 6e 76 65 72 73 69 6f 6e 20 69 73 20 70   conversion is p
34b00 6f 73 73 69 62 6c 65 20 77 69 74 68 6f 75 74 20  ossible without 
34b10 6c 6f 73 73 20 6f 66 20 69 6e 66 6f 72 6d 61 74  loss of informat
34b20 69 6f 6e 20 28 69 6e 20 6f 74 68 65 72 0a 2a 2a  ion (in other.**
34b30 20 77 6f 72 64 73 2c 20 69 66 20 74 68 65 20 76   words, if the v
34b40 61 6c 75 65 20 69 73 20 61 20 73 74 72 69 6e 67  alue is a string
34b50 20 74 68 61 74 20 6c 6f 6f 6b 73 20 6c 69 6b 65   that looks like
34b60 20 61 20 6e 75 6d 62 65 72 29 0a 2a 2a 20 74 68   a number).** th
34b70 65 6e 20 74 68 65 20 63 6f 6e 76 65 72 73 69 6f  en the conversio
34b80 6e 20 69 73 20 70 65 72 66 6f 72 6d 65 64 2e 20  n is performed. 
34b90 20 4f 74 68 65 72 77 69 73 65 20 6e 6f 20 63 6f   Otherwise no co
34ba0 6e 76 65 72 73 69 6f 6e 20 6f 63 63 75 72 73 2e  nversion occurs.
34bb0 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54 45 5f  .** The [SQLITE_
34bc0 49 4e 54 45 47 45 52 20 7c 20 64 61 74 61 74 79  INTEGER | dataty
34bd0 70 65 5d 20 61 66 74 65 72 20 63 6f 6e 76 65 72  pe] after conver
34be0 73 69 6f 6e 20 69 73 20 72 65 74 75 72 6e 65 64  sion is returned
34bf0 2e 29 5e 0a 2a 2a 0a 2a 2a 20 50 6c 65 61 73 65  .)^.**.** Please
34c00 20 70 61 79 20 70 61 72 74 69 63 75 6c 61 72 20   pay particular 
34c10 61 74 74 65 6e 74 69 6f 6e 20 74 6f 20 74 68 65  attention to the
34c20 20 66 61 63 74 20 74 68 61 74 20 74 68 65 20 70   fact that the p
34c30 6f 69 6e 74 65 72 20 72 65 74 75 72 6e 65 64 0a  ointer returned.
34c40 2a 2a 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33  ** from [sqlite3
34c50 5f 76 61 6c 75 65 5f 62 6c 6f 62 28 29 5d 2c 20  _value_blob()], 
34c60 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74  [sqlite3_value_t
34c70 65 78 74 28 29 5d 2c 20 6f 72 0a 2a 2a 20 5b 73  ext()], or.** [s
34c80 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 65 78  qlite3_value_tex
34c90 74 31 36 28 29 5d 20 63 61 6e 20 62 65 20 69 6e  t16()] can be in
34ca0 76 61 6c 69 64 61 74 65 64 20 62 79 20 61 20 73  validated by a s
34cb0 75 62 73 65 71 75 65 6e 74 20 63 61 6c 6c 20 74  ubsequent call t
34cc0 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 76 61  o.** [sqlite3_va
34cd0 6c 75 65 5f 62 79 74 65 73 28 29 5d 2c 20 5b 73  lue_bytes()], [s
34ce0 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 62 79 74  qlite3_value_byt
34cf0 65 73 31 36 28 29 5d 2c 20 5b 73 71 6c 69 74 65  es16()], [sqlite
34d00 33 5f 76 61 6c 75 65 5f 74 65 78 74 28 29 5d 2c  3_value_text()],
34d10 0a 2a 2a 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f  .** or [sqlite3_
34d20 76 61 6c 75 65 5f 74 65 78 74 31 36 28 29 5d 2e  value_text16()].
34d30 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72 6f 75  .**.** These rou
34d40 74 69 6e 65 73 20 6d 75 73 74 20 62 65 20 63 61  tines must be ca
34d50 6c 6c 65 64 20 66 72 6f 6d 20 74 68 65 20 73 61  lled from the sa
34d60 6d 65 20 74 68 72 65 61 64 20 61 73 0a 2a 2a 20  me thread as.** 
34d70 74 68 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  the SQL function
34d80 20 74 68 61 74 20 73 75 70 70 6c 69 65 64 20 74   that supplied t
34d90 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75  he [sqlite3_valu
34da0 65 2a 5d 20 70 61 72 61 6d 65 74 65 72 73 2e 0a  e*] parameters..
34db0 2a 2f 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73  */.const void *s
34dc0 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 62 6c 6f  qlite3_value_blo
34dd0 62 28 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a  b(sqlite3_value*
34de0 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 76  );.int sqlite3_v
34df0 61 6c 75 65 5f 62 79 74 65 73 28 73 71 6c 69 74  alue_bytes(sqlit
34e00 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 69 6e 74 20  e3_value*);.int 
34e10 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 62 79  sqlite3_value_by
34e20 74 65 73 31 36 28 73 71 6c 69 74 65 33 5f 76 61  tes16(sqlite3_va
34e30 6c 75 65 2a 29 3b 0a 64 6f 75 62 6c 65 20 73 71  lue*);.double sq
34e40 6c 69 74 65 33 5f 76 61 6c 75 65 5f 64 6f 75 62  lite3_value_doub
34e50 6c 65 28 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  le(sqlite3_value
34e60 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  *);.int sqlite3_
34e70 76 61 6c 75 65 5f 69 6e 74 28 73 71 6c 69 74 65  value_int(sqlite
34e80 33 5f 76 61 6c 75 65 2a 29 3b 0a 73 71 6c 69 74  3_value*);.sqlit
34e90 65 33 5f 69 6e 74 36 34 20 73 71 6c 69 74 65 33  e3_int64 sqlite3
34ea0 5f 76 61 6c 75 65 5f 69 6e 74 36 34 28 73 71 6c  _value_int64(sql
34eb0 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 63 6f  ite3_value*);.co
34ec0 6e 73 74 20 75 6e 73 69 67 6e 65 64 20 63 68 61  nst unsigned cha
34ed0 72 20 2a 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  r *sqlite3_value
34ee0 5f 74 65 78 74 28 73 71 6c 69 74 65 33 5f 76 61  _text(sqlite3_va
34ef0 6c 75 65 2a 29 3b 0a 63 6f 6e 73 74 20 76 6f 69  lue*);.const voi
34f00 64 20 2a 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  d *sqlite3_value
34f10 5f 74 65 78 74 31 36 28 73 71 6c 69 74 65 33 5f  _text16(sqlite3_
34f20 76 61 6c 75 65 2a 29 3b 0a 63 6f 6e 73 74 20 76  value*);.const v
34f30 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 76 61 6c  oid *sqlite3_val
34f40 75 65 5f 74 65 78 74 31 36 6c 65 28 73 71 6c 69  ue_text16le(sqli
34f50 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 63 6f 6e  te3_value*);.con
34f60 73 74 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33  st void *sqlite3
34f70 5f 76 61 6c 75 65 5f 74 65 78 74 31 36 62 65 28  _value_text16be(
34f80 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b  sqlite3_value*);
34f90 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 76 61 6c  .int sqlite3_val
34fa0 75 65 5f 74 79 70 65 28 73 71 6c 69 74 65 33 5f  ue_type(sqlite3_
34fb0 76 61 6c 75 65 2a 29 3b 0a 69 6e 74 20 73 71 6c  value*);.int sql
34fc0 69 74 65 33 5f 76 61 6c 75 65 5f 6e 75 6d 65 72  ite3_value_numer
34fd0 69 63 5f 74 79 70 65 28 73 71 6c 69 74 65 33 5f  ic_type(sqlite3_
34fe0 76 61 6c 75 65 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20  value*);../*.** 
34ff0 43 41 50 49 33 52 45 46 3a 20 46 69 6e 64 69 6e  CAPI3REF: Findin
35000 67 20 54 68 65 20 53 75 62 74 79 70 65 20 4f 66  g The Subtype Of
35010 20 53 51 4c 20 56 61 6c 75 65 73 0a 2a 2a 20 4d   SQL Values.** M
35020 45 54 48 4f 44 3a 20 73 71 6c 69 74 65 33 5f 76  ETHOD: sqlite3_v
35030 61 6c 75 65 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73  alue.**.** The s
35040 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 73 75 62  qlite3_value_sub
35050 74 79 70 65 28 56 29 20 66 75 6e 63 74 69 6f 6e  type(V) function
35060 20 72 65 74 75 72 6e 73 20 74 68 65 20 73 75 62   returns the sub
35070 74 79 70 65 20 66 6f 72 0a 2a 2a 20 61 6e 20 5b  type for.** an [
35080 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69  application-defi
35090 6e 65 64 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  ned SQL function
350a0 5d 20 61 72 67 75 6d 65 6e 74 20 56 2e 20 20 54  ] argument V.  T
350b0 68 65 20 73 75 62 74 79 70 65 0a 2a 2a 20 69 6e  he subtype.** in
350c0 66 6f 72 6d 61 74 69 6f 6e 20 63 61 6e 20 62 65  formation can be
350d0 20 75 73 65 64 20 74 6f 20 70 61 73 73 20 61 20   used to pass a 
350e0 6c 69 6d 69 74 65 64 20 61 6d 6f 75 6e 74 20 6f  limited amount o
350f0 66 20 63 6f 6e 74 65 78 74 20 66 72 6f 6d 0a 2a  f context from.*
35100 2a 20 6f 6e 65 20 53 51 4c 20 66 75 6e 63 74 69  * one SQL functi
35110 6f 6e 20 74 6f 20 61 6e 6f 74 68 65 72 2e 20 20  on to another.  
35120 55 73 65 20 74 68 65 20 5b 73 71 6c 69 74 65 33  Use the [sqlite3
35130 5f 72 65 73 75 6c 74 5f 73 75 62 74 79 70 65 28  _result_subtype(
35140 29 5d 0a 2a 2a 20 72 6f 75 74 69 6e 65 20 74 6f  )].** routine to
35150 20 73 65 74 20 74 68 65 20 73 75 62 74 79 70 65   set the subtype
35160 20 66 6f 72 20 74 68 65 20 72 65 74 75 72 6e 20   for the return 
35170 76 61 6c 75 65 20 6f 66 20 61 6e 20 53 51 4c 20  value of an SQL 
35180 66 75 6e 63 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20  function..**.** 
35190 53 51 4c 69 74 65 20 6d 61 6b 65 73 20 6e 6f 20  SQLite makes no 
351a0 75 73 65 20 6f 66 20 73 75 62 74 79 70 65 20 69  use of subtype i
351b0 74 73 65 6c 66 2e 20 20 49 74 20 6d 65 72 65 6c  tself.  It merel
351c0 79 20 70 61 73 73 65 73 20 74 68 65 20 73 75 62  y passes the sub
351d0 74 79 70 65 0a 2a 2a 20 66 72 6f 6d 20 74 68 65  type.** from the
351e0 20 72 65 73 75 6c 74 20 6f 66 20 6f 6e 65 20 5b   result of one [
351f0 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69  application-defi
35200 6e 65 64 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  ned SQL function
35210 5d 20 69 6e 74 6f 20 74 68 65 0a 2a 2a 20 69 6e  ] into the.** in
35220 70 75 74 20 6f 66 20 61 6e 6f 74 68 65 72 2e 0a  put of another..
35230 2a 2f 0a 75 6e 73 69 67 6e 65 64 20 69 6e 74 20  */.unsigned int 
35240 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 73 75  sqlite3_value_su
35250 62 74 79 70 65 28 73 71 6c 69 74 65 33 5f 76 61  btype(sqlite3_va
35260 6c 75 65 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41  lue*);../*.** CA
35270 50 49 33 52 45 46 3a 20 43 6f 70 79 20 41 6e 64  PI3REF: Copy And
35280 20 46 72 65 65 20 53 51 4c 20 56 61 6c 75 65 73   Free SQL Values
35290 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69  .** METHOD: sqli
352a0 74 65 33 5f 76 61 6c 75 65 0a 2a 2a 0a 2a 2a 20  te3_value.**.** 
352b0 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 76 61 6c  ^The sqlite3_val
352c0 75 65 5f 64 75 70 28 56 29 20 69 6e 74 65 72 66  ue_dup(V) interf
352d0 61 63 65 20 6d 61 6b 65 73 20 61 20 63 6f 70 79  ace makes a copy
352e0 20 6f 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33   of the [sqlite3
352f0 5f 76 61 6c 75 65 5d 0a 2a 2a 20 6f 62 6a 65 63  _value].** objec
35300 74 20 44 20 61 6e 64 20 72 65 74 75 72 6e 73 20  t D and returns 
35310 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68 61  a pointer to tha
35320 74 20 63 6f 70 79 2e 20 20 5e 54 68 65 20 5b 73  t copy.  ^The [s
35330 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20 72 65  qlite3_value] re
35340 74 75 72 6e 65 64 0a 2a 2a 20 69 73 20 61 20 5b  turned.** is a [
35350 70 72 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65  protected sqlite
35360 33 5f 76 61 6c 75 65 5d 20 6f 62 6a 65 63 74 20  3_value] object 
35370 65 76 65 6e 20 69 66 20 74 68 65 20 69 6e 70 75  even if the inpu
35380 74 20 69 73 20 6e 6f 74 2e 0a 2a 2a 20 5e 54 68  t is not..** ^Th
35390 65 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f  e sqlite3_value_
353a0 64 75 70 28 56 29 20 69 6e 74 65 72 66 61 63 65  dup(V) interface
353b0 20 72 65 74 75 72 6e 73 20 4e 55 4c 4c 20 69 66   returns NULL if
353c0 20 56 20 69 73 20 4e 55 4c 4c 20 6f 72 20 69 66   V is NULL or if
353d0 20 61 0a 2a 2a 20 6d 65 6d 6f 72 79 20 61 6c 6c   a.** memory all
353e0 6f 63 61 74 69 6f 6e 20 66 61 69 6c 73 2e 0a 2a  ocation fails..*
353f0 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65  *.** ^The sqlite
35400 33 5f 76 61 6c 75 65 5f 66 72 65 65 28 56 29 20  3_value_free(V) 
35410 69 6e 74 65 72 66 61 63 65 20 66 72 65 65 73 20  interface frees 
35420 61 6e 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75  an [sqlite3_valu
35430 65 5d 20 6f 62 6a 65 63 74 0a 2a 2a 20 70 72 65  e] object.** pre
35440 76 69 6f 75 73 6c 79 20 6f 62 74 61 69 6e 65 64  viously obtained
35450 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 76   from [sqlite3_v
35460 61 6c 75 65 5f 64 75 70 28 29 5d 2e 20 20 5e 49  alue_dup()].  ^I
35470 66 20 56 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f  f V is a NULL po
35480 69 6e 74 65 72 0a 2a 2a 20 74 68 65 6e 20 73 71  inter.** then sq
35490 6c 69 74 65 33 5f 76 61 6c 75 65 5f 66 72 65 65  lite3_value_free
354a0 28 56 29 20 69 73 20 61 20 68 61 72 6d 6c 65 73  (V) is a harmles
354b0 73 20 6e 6f 2d 6f 70 2e 0a 2a 2f 0a 73 71 6c 69  s no-op..*/.sqli
354c0 74 65 33 5f 76 61 6c 75 65 20 2a 73 71 6c 69 74  te3_value *sqlit
354d0 65 33 5f 76 61 6c 75 65 5f 64 75 70 28 63 6f 6e  e3_value_dup(con
354e0 73 74 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  st sqlite3_value
354f0 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33  *);.void sqlite3
35500 5f 76 61 6c 75 65 5f 66 72 65 65 28 73 71 6c 69  _value_free(sqli
35510 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 0a 2f 2a  te3_value*);../*
35520 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4f 62  .** CAPI3REF: Ob
35530 74 61 69 6e 20 41 67 67 72 65 67 61 74 65 20 46  tain Aggregate F
35540 75 6e 63 74 69 6f 6e 20 43 6f 6e 74 65 78 74 0a  unction Context.
35550 2a 2a 20 4d 45 54 48 4f 44 3a 20 73 71 6c 69 74  ** METHOD: sqlit
35560 65 33 5f 63 6f 6e 74 65 78 74 0a 2a 2a 0a 2a 2a  e3_context.**.**
35570 20 49 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73   Implementations
35580 20 6f 66 20 61 67 67 72 65 67 61 74 65 20 53 51   of aggregate SQ
35590 4c 20 66 75 6e 63 74 69 6f 6e 73 20 75 73 65 20  L functions use 
355a0 74 68 69 73 0a 2a 2a 20 72 6f 75 74 69 6e 65 20  this.** routine 
355b0 74 6f 20 61 6c 6c 6f 63 61 74 65 20 6d 65 6d 6f  to allocate memo
355c0 72 79 20 66 6f 72 20 73 74 6f 72 69 6e 67 20 74  ry for storing t
355d0 68 65 69 72 20 73 74 61 74 65 2e 0a 2a 2a 0a 2a  heir state..**.*
355e0 2a 20 5e 54 68 65 20 66 69 72 73 74 20 74 69 6d  * ^The first tim
355f0 65 20 74 68 65 20 73 71 6c 69 74 65 33 5f 61 67  e the sqlite3_ag
35600 67 72 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28  gregate_context(
35610 43 2c 4e 29 20 72 6f 75 74 69 6e 65 20 69 73 20  C,N) routine is 
35620 63 61 6c 6c 65 64 20 0a 2a 2a 20 66 6f 72 20 61  called .** for a
35630 20 70 61 72 74 69 63 75 6c 61 72 20 61 67 67 72   particular aggr
35640 65 67 61 74 65 20 66 75 6e 63 74 69 6f 6e 2c 20  egate function, 
35650 53 51 4c 69 74 65 0a 2a 2a 20 61 6c 6c 6f 63 61  SQLite.** alloca
35660 74 65 73 20 4e 20 6f 66 20 6d 65 6d 6f 72 79 2c  tes N of memory,
35670 20 7a 65 72 6f 65 73 20 6f 75 74 20 74 68 61 74   zeroes out that
35680 20 6d 65 6d 6f 72 79 2c 20 61 6e 64 20 72 65 74   memory, and ret
35690 75 72 6e 73 20 61 20 70 6f 69 6e 74 65 72 0a 2a  urns a pointer.*
356a0 2a 20 74 6f 20 74 68 65 20 6e 65 77 20 6d 65 6d  * to the new mem
356b0 6f 72 79 2e 20 5e 4f 6e 20 73 65 63 6f 6e 64 20  ory. ^On second 
356c0 61 6e 64 20 73 75 62 73 65 71 75 65 6e 74 20 63  and subsequent c
356d0 61 6c 6c 73 20 74 6f 0a 2a 2a 20 73 71 6c 69 74  alls to.** sqlit
356e0 65 33 5f 61 67 67 72 65 67 61 74 65 5f 63 6f 6e  e3_aggregate_con
356f0 74 65 78 74 28 29 20 66 6f 72 20 74 68 65 20 73  text() for the s
35700 61 6d 65 20 61 67 67 72 65 67 61 74 65 20 66 75  ame aggregate fu
35710 6e 63 74 69 6f 6e 20 69 6e 73 74 61 6e 63 65 2c  nction instance,
35720 0a 2a 2a 20 74 68 65 20 73 61 6d 65 20 62 75 66  .** the same buf
35730 66 65 72 20 69 73 20 72 65 74 75 72 6e 65 64 2e  fer is returned.
35740 20 20 53 71 6c 69 74 65 33 5f 61 67 67 72 65 67    Sqlite3_aggreg
35750 61 74 65 5f 63 6f 6e 74 65 78 74 28 29 20 69 73  ate_context() is
35760 20 6e 6f 72 6d 61 6c 6c 79 0a 2a 2a 20 63 61 6c   normally.** cal
35770 6c 65 64 20 6f 6e 63 65 20 66 6f 72 20 65 61 63  led once for eac
35780 68 20 69 6e 76 6f 63 61 74 69 6f 6e 20 6f 66 20  h invocation of 
35790 74 68 65 20 78 53 74 65 70 20 63 61 6c 6c 62 61  the xStep callba
357a0 63 6b 20 61 6e 64 20 74 68 65 6e 20 6f 6e 65 0a  ck and then one.
357b0 2a 2a 20 6c 61 73 74 20 74 69 6d 65 20 77 68 65  ** last time whe
357c0 6e 20 74 68 65 20 78 46 69 6e 61 6c 20 63 61 6c  n the xFinal cal
357d0 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64  lback is invoked
357e0 2e 20 20 5e 28 57 68 65 6e 20 6e 6f 20 72 6f 77  .  ^(When no row
357f0 73 20 6d 61 74 63 68 0a 2a 2a 20 61 6e 20 61 67  s match.** an ag
35800 67 72 65 67 61 74 65 20 71 75 65 72 79 2c 20 74  gregate query, t
35810 68 65 20 78 53 74 65 70 28 29 20 63 61 6c 6c 62  he xStep() callb
35820 61 63 6b 20 6f 66 20 74 68 65 20 61 67 67 72 65  ack of the aggre
35830 67 61 74 65 20 66 75 6e 63 74 69 6f 6e 0a 2a 2a  gate function.**
35840 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20   implementation 
35850 69 73 20 6e 65 76 65 72 20 63 61 6c 6c 65 64 20  is never called 
35860 61 6e 64 20 78 46 69 6e 61 6c 28 29 20 69 73 20  and xFinal() is 
35870 63 61 6c 6c 65 64 20 65 78 61 63 74 6c 79 20 6f  called exactly o
35880 6e 63 65 2e 0a 2a 2a 20 49 6e 20 74 68 6f 73 65  nce..** In those
35890 20 63 61 73 65 73 2c 20 73 71 6c 69 74 65 33 5f   cases, sqlite3_
358a0 61 67 67 72 65 67 61 74 65 5f 63 6f 6e 74 65 78  aggregate_contex
358b0 74 28 29 20 6d 69 67 68 74 20 62 65 20 63 61 6c  t() might be cal
358c0 6c 65 64 20 66 6f 72 20 74 68 65 0a 2a 2a 20 66  led for the.** f
358d0 69 72 73 74 20 74 69 6d 65 20 66 72 6f 6d 20 77  irst time from w
358e0 69 74 68 69 6e 20 78 46 69 6e 61 6c 28 29 2e 29  ithin xFinal().)
358f0 5e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  ^.**.** ^The sql
35900 69 74 65 33 5f 61 67 67 72 65 67 61 74 65 5f 63  ite3_aggregate_c
35910 6f 6e 74 65 78 74 28 43 2c 4e 29 20 72 6f 75 74  ontext(C,N) rout
35920 69 6e 65 20 72 65 74 75 72 6e 73 20 61 20 4e 55  ine returns a NU
35930 4c 4c 20 70 6f 69 6e 74 65 72 20 0a 2a 2a 20 77  LL pointer .** w
35940 68 65 6e 20 66 69 72 73 74 20 63 61 6c 6c 65 64  hen first called
35950 20 69 66 20 4e 20 69 73 20 6c 65 73 73 20 74 68   if N is less th
35960 61 6e 20 6f 72 20 65 71 75 61 6c 20 74 6f 20 7a  an or equal to z
35970 65 72 6f 20 6f 72 20 69 66 20 61 20 6d 65 6d 6f  ero or if a memo
35980 72 79 0a 2a 2a 20 61 6c 6c 6f 63 61 74 65 20 65  ry.** allocate e
35990 72 72 6f 72 20 6f 63 63 75 72 73 2e 0a 2a 2a 0a  rror occurs..**.
359a0 2a 2a 20 5e 28 54 68 65 20 61 6d 6f 75 6e 74 20  ** ^(The amount 
359b0 6f 66 20 73 70 61 63 65 20 61 6c 6c 6f 63 61 74  of space allocat
359c0 65 64 20 62 79 20 73 71 6c 69 74 65 33 5f 61 67  ed by sqlite3_ag
359d0 67 72 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28  gregate_context(
359e0 43 2c 4e 29 20 69 73 0a 2a 2a 20 64 65 74 65 72  C,N) is.** deter
359f0 6d 69 6e 65 64 20 62 79 20 74 68 65 20 4e 20 70  mined by the N p
35a00 61 72 61 6d 65 74 65 72 20 6f 6e 20 66 69 72 73  arameter on firs
35a10 74 20 73 75 63 63 65 73 73 66 75 6c 20 63 61 6c  t successful cal
35a20 6c 2e 20 20 43 68 61 6e 67 69 6e 67 20 74 68 65  l.  Changing the
35a30 0a 2a 2a 20 76 61 6c 75 65 20 6f 66 20 4e 20 69  .** value of N i
35a40 6e 20 73 75 62 73 65 71 75 65 6e 74 20 63 61 6c  n subsequent cal
35a50 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f 61 67 67  l to sqlite3_agg
35a60 72 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28 29  regate_context()
35a70 20 77 69 74 68 69 6e 0a 2a 2a 20 74 68 65 20 73   within.** the s
35a80 61 6d 65 20 61 67 67 72 65 67 61 74 65 20 66 75  ame aggregate fu
35a90 6e 63 74 69 6f 6e 20 69 6e 73 74 61 6e 63 65 20  nction instance 
35aa0 77 69 6c 6c 20 6e 6f 74 20 72 65 73 69 7a 65 20  will not resize 
35ab0 74 68 65 20 6d 65 6d 6f 72 79 0a 2a 2a 20 61 6c  the memory.** al
35ac0 6c 6f 63 61 74 69 6f 6e 2e 29 5e 20 20 57 69 74  location.)^  Wit
35ad0 68 69 6e 20 74 68 65 20 78 46 69 6e 61 6c 20 63  hin the xFinal c
35ae0 61 6c 6c 62 61 63 6b 2c 20 69 74 20 69 73 20 63  allback, it is c
35af0 75 73 74 6f 6d 61 72 79 20 74 6f 20 73 65 74 0a  ustomary to set.
35b00 2a 2a 20 4e 3d 30 20 69 6e 20 63 61 6c 6c 73 20  ** N=0 in calls 
35b10 74 6f 20 73 71 6c 69 74 65 33 5f 61 67 67 72 65  to sqlite3_aggre
35b20 67 61 74 65 5f 63 6f 6e 74 65 78 74 28 43 2c 4e  gate_context(C,N
35b30 29 20 73 6f 20 74 68 61 74 20 6e 6f 20 0a 2a 2a  ) so that no .**
35b40 20 70 6f 69 6e 74 6c 65 73 73 20 6d 65 6d 6f 72   pointless memor
35b50 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 73 20 6f 63  y allocations oc
35b60 63 75 72 2e 0a 2a 2a 0a 2a 2a 20 5e 53 51 4c 69  cur..**.** ^SQLi
35b70 74 65 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79  te automatically
35b80 20 66 72 65 65 73 20 74 68 65 20 6d 65 6d 6f 72   frees the memor
35b90 79 20 61 6c 6c 6f 63 61 74 65 64 20 62 79 20 0a  y allocated by .
35ba0 2a 2a 20 73 71 6c 69 74 65 33 5f 61 67 67 72 65  ** sqlite3_aggre
35bb0 67 61 74 65 5f 63 6f 6e 74 65 78 74 28 29 20 77  gate_context() w
35bc0 68 65 6e 20 74 68 65 20 61 67 67 72 65 67 61 74  hen the aggregat
35bd0 65 20 71 75 65 72 79 20 63 6f 6e 63 6c 75 64 65  e query conclude
35be0 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 66 69 72  s..**.** The fir
35bf0 73 74 20 70 61 72 61 6d 65 74 65 72 20 6d 75 73  st parameter mus
35c00 74 20 62 65 20 61 20 63 6f 70 79 20 6f 66 20 74  t be a copy of t
35c10 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63  he.** [sqlite3_c
35c20 6f 6e 74 65 78 74 20 7c 20 53 51 4c 20 66 75 6e  ontext | SQL fun
35c30 63 74 69 6f 6e 20 63 6f 6e 74 65 78 74 5d 20 74  ction context] t
35c40 68 61 74 20 69 73 20 74 68 65 20 66 69 72 73 74  hat is the first
35c50 20 70 61 72 61 6d 65 74 65 72 0a 2a 2a 20 74 6f   parameter.** to
35c60 20 74 68 65 20 78 53 74 65 70 20 6f 72 20 78 46   the xStep or xF
35c70 69 6e 61 6c 20 63 61 6c 6c 62 61 63 6b 20 72 6f  inal callback ro
35c80 75 74 69 6e 65 20 74 68 61 74 20 69 6d 70 6c 65  utine that imple
35c90 6d 65 6e 74 73 20 74 68 65 20 61 67 67 72 65 67  ments the aggreg
35ca0 61 74 65 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 2e  ate.** function.
35cb0 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 72 6f 75 74  .**.** This rout
35cc0 69 6e 65 20 6d 75 73 74 20 62 65 20 63 61 6c 6c  ine must be call
35cd0 65 64 20 66 72 6f 6d 20 74 68 65 20 73 61 6d 65  ed from the same
35ce0 20 74 68 72 65 61 64 20 69 6e 20 77 68 69 63 68   thread in which
35cf0 0a 2a 2a 20 74 68 65 20 61 67 67 72 65 67 61 74  .** the aggregat
35d00 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 69  e SQL function i
35d10 73 20 72 75 6e 6e 69 6e 67 2e 0a 2a 2f 0a 76 6f  s running..*/.vo
35d20 69 64 20 2a 73 71 6c 69 74 65 33 5f 61 67 67 72  id *sqlite3_aggr
35d30 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28 73 71  egate_context(sq
35d40 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 2c 20  lite3_context*, 
35d50 69 6e 74 20 6e 42 79 74 65 73 29 3b 0a 0a 2f 2a  int nBytes);../*
35d60 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 55 73  .** CAPI3REF: Us
35d70 65 72 20 44 61 74 61 20 46 6f 72 20 46 75 6e 63  er Data For Func
35d80 74 69 6f 6e 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a  tions.** METHOD:
35d90 20 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74   sqlite3_context
35da0 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69  .**.** ^The sqli
35db0 74 65 33 5f 75 73 65 72 5f 64 61 74 61 28 29 20  te3_user_data() 
35dc0 69 6e 74 65 72 66 61 63 65 20 72 65 74 75 72 6e  interface return
35dd0 73 20 61 20 63 6f 70 79 20 6f 66 0a 2a 2a 20 74  s a copy of.** t
35de0 68 65 20 70 6f 69 6e 74 65 72 20 74 68 61 74 20  he pointer that 
35df0 77 61 73 20 74 68 65 20 70 55 73 65 72 44 61 74  was the pUserDat
35e00 61 20 70 61 72 61 6d 65 74 65 72 20 28 74 68 65  a parameter (the
35e10 20 35 74 68 20 70 61 72 61 6d 65 74 65 72 29 0a   5th parameter).
35e20 2a 2a 20 6f 66 20 74 68 65 20 5b 73 71 6c 69 74  ** of the [sqlit
35e30 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69  e3_create_functi
35e40 6f 6e 28 29 5d 0a 2a 2a 20 61 6e 64 20 5b 73 71  on()].** and [sq
35e50 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e  lite3_create_fun
35e60 63 74 69 6f 6e 31 36 28 29 5d 20 72 6f 75 74 69  ction16()] routi
35e70 6e 65 73 20 74 68 61 74 20 6f 72 69 67 69 6e 61  nes that origina
35e80 6c 6c 79 0a 2a 2a 20 72 65 67 69 73 74 65 72 65  lly.** registere
35e90 64 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f  d the applicatio
35ea0 6e 20 64 65 66 69 6e 65 64 20 66 75 6e 63 74 69  n defined functi
35eb0 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 72  on..**.** This r
35ec0 6f 75 74 69 6e 65 20 6d 75 73 74 20 62 65 20 63  outine must be c
35ed0 61 6c 6c 65 64 20 66 72 6f 6d 20 74 68 65 20 73  alled from the s
35ee0 61 6d 65 20 74 68 72 65 61 64 20 69 6e 20 77 68  ame thread in wh
35ef0 69 63 68 0a 2a 2a 20 74 68 65 20 61 70 70 6c 69  ich.** the appli
35f00 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 66  cation-defined f
35f10 75 6e 63 74 69 6f 6e 20 69 73 20 72 75 6e 6e 69  unction is runni
35f20 6e 67 2e 0a 2a 2f 0a 76 6f 69 64 20 2a 73 71 6c  ng..*/.void *sql
35f30 69 74 65 33 5f 75 73 65 72 5f 64 61 74 61 28 73  ite3_user_data(s
35f40 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 29  qlite3_context*)
35f50 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
35f60 46 3a 20 44 61 74 61 62 61 73 65 20 43 6f 6e 6e  F: Database Conn
35f70 65 63 74 69 6f 6e 20 46 6f 72 20 46 75 6e 63 74  ection For Funct
35f80 69 6f 6e 73 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20  ions.** METHOD: 
35f90 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 0a  sqlite3_context.
35fa0 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  **.** ^The sqlit
35fb0 65 33 5f 63 6f 6e 74 65 78 74 5f 64 62 5f 68 61  e3_context_db_ha
35fc0 6e 64 6c 65 28 29 20 69 6e 74 65 72 66 61 63 65  ndle() interface
35fd0 20 72 65 74 75 72 6e 73 20 61 20 63 6f 70 79 20   returns a copy 
35fe0 6f 66 0a 2a 2a 20 74 68 65 20 70 6f 69 6e 74 65  of.** the pointe
35ff0 72 20 74 6f 20 74 68 65 20 5b 64 61 74 61 62 61  r to the [databa
36000 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 28  se connection] (
36010 74 68 65 20 31 73 74 20 70 61 72 61 6d 65 74 65  the 1st paramete
36020 72 29 0a 2a 2a 20 6f 66 20 74 68 65 20 5b 73 71  r).** of the [sq
36030 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e  lite3_create_fun
36040 63 74 69 6f 6e 28 29 5d 0a 2a 2a 20 61 6e 64 20  ction()].** and 
36050 5b 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f  [sqlite3_create_
36060 66 75 6e 63 74 69 6f 6e 31 36 28 29 5d 20 72 6f  function16()] ro
36070 75 74 69 6e 65 73 20 74 68 61 74 20 6f 72 69 67  utines that orig
36080 69 6e 61 6c 6c 79 0a 2a 2a 20 72 65 67 69 73 74  inally.** regist
36090 65 72 65 64 20 74 68 65 20 61 70 70 6c 69 63 61  ered the applica
360a0 74 69 6f 6e 20 64 65 66 69 6e 65 64 20 66 75 6e  tion defined fun
360b0 63 74 69 6f 6e 2e 0a 2a 2f 0a 73 71 6c 69 74 65  ction..*/.sqlite
360c0 33 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65  3 *sqlite3_conte
360d0 78 74 5f 64 62 5f 68 61 6e 64 6c 65 28 73 71 6c  xt_db_handle(sql
360e0 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 29 3b 0a  ite3_context*);.
360f0 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
36100 20 46 75 6e 63 74 69 6f 6e 20 41 75 78 69 6c 69   Function Auxili
36110 61 72 79 20 44 61 74 61 0a 2a 2a 20 4d 45 54 48  ary Data.** METH
36120 4f 44 3a 20 73 71 6c 69 74 65 33 5f 63 6f 6e 74  OD: sqlite3_cont
36130 65 78 74 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20  ext.**.** These 
36140 66 75 6e 63 74 69 6f 6e 73 20 6d 61 79 20 62 65  functions may be
36150 20 75 73 65 64 20 62 79 20 28 6e 6f 6e 2d 61 67   used by (non-ag
36160 67 72 65 67 61 74 65 29 20 53 51 4c 20 66 75 6e  gregate) SQL fun
36170 63 74 69 6f 6e 73 20 74 6f 0a 2a 2a 20 61 73 73  ctions to.** ass
36180 6f 63 69 61 74 65 20 6d 65 74 61 64 61 74 61 20  ociate metadata 
36190 77 69 74 68 20 61 72 67 75 6d 65 6e 74 20 76 61  with argument va
361a0 6c 75 65 73 2e 20 49 66 20 74 68 65 20 73 61 6d  lues. If the sam
361b0 65 20 76 61 6c 75 65 20 69 73 20 70 61 73 73 65  e value is passe
361c0 64 20 74 6f 0a 2a 2a 20 6d 75 6c 74 69 70 6c 65  d to.** multiple
361d0 20 69 6e 76 6f 63 61 74 69 6f 6e 73 20 6f 66 20   invocations of 
361e0 74 68 65 20 73 61 6d 65 20 53 51 4c 20 66 75 6e  the same SQL fun
361f0 63 74 69 6f 6e 20 64 75 72 69 6e 67 20 71 75 65  ction during que
36200 72 79 20 65 78 65 63 75 74 69 6f 6e 2c 20 75 6e  ry execution, un
36210 64 65 72 0a 2a 2a 20 73 6f 6d 65 20 63 69 72 63  der.** some circ
36220 75 6d 73 74 61 6e 63 65 73 20 74 68 65 20 61 73  umstances the as
36230 73 6f 63 69 61 74 65 64 20 6d 65 74 61 64 61 74  sociated metadat
36240 61 20 6d 61 79 20 62 65 20 70 72 65 73 65 72 76  a may be preserv
36250 65 64 2e 20 20 41 6e 20 65 78 61 6d 70 6c 65 0a  ed.  An example.
36260 2a 2a 20 6f 66 20 77 68 65 72 65 20 74 68 69 73  ** of where this
36270 20 6d 69 67 68 74 20 62 65 20 75 73 65 66 75 6c   might be useful
36280 20 69 73 20 69 6e 20 61 20 72 65 67 75 6c 61 72   is in a regular
36290 2d 65 78 70 72 65 73 73 69 6f 6e 20 6d 61 74 63  -expression matc
362a0 68 69 6e 67 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e  hing.** function
362b0 2e 20 54 68 65 20 63 6f 6d 70 69 6c 65 64 20 76  . The compiled v
362c0 65 72 73 69 6f 6e 20 6f 66 20 74 68 65 20 72 65  ersion of the re
362d0 67 75 6c 61 72 20 65 78 70 72 65 73 73 69 6f 6e  gular expression
362e0 20 63 61 6e 20 62 65 20 73 74 6f 72 65 64 20 61   can be stored a
362f0 73 0a 2a 2a 20 6d 65 74 61 64 61 74 61 20 61 73  s.** metadata as
36300 73 6f 63 69 61 74 65 64 20 77 69 74 68 20 74 68  sociated with th
36310 65 20 70 61 74 74 65 72 6e 20 73 74 72 69 6e 67  e pattern string
36320 2e 20 20 0a 2a 2a 20 54 68 65 6e 20 61 73 20 6c  .  .** Then as l
36330 6f 6e 67 20 61 73 20 74 68 65 20 70 61 74 74 65  ong as the patte
36340 72 6e 20 73 74 72 69 6e 67 20 72 65 6d 61 69 6e  rn string remain
36350 73 20 74 68 65 20 73 61 6d 65 2c 0a 2a 2a 20 74  s the same,.** t
36360 68 65 20 63 6f 6d 70 69 6c 65 64 20 72 65 67 75  he compiled regu
36370 6c 61 72 20 65 78 70 72 65 73 73 69 6f 6e 20 63  lar expression c
36380 61 6e 20 62 65 20 72 65 75 73 65 64 20 6f 6e 20  an be reused on 
36390 6d 75 6c 74 69 70 6c 65 0a 2a 2a 20 69 6e 76 6f  multiple.** invo
363a0 63 61 74 69 6f 6e 73 20 6f 66 20 74 68 65 20 73  cations of the s
363b0 61 6d 65 20 66 75 6e 63 74 69 6f 6e 2e 0a 2a 2a  ame function..**
363c0 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33  .** ^The sqlite3
363d0 5f 67 65 74 5f 61 75 78 64 61 74 61 28 29 20 69  _get_auxdata() i
363e0 6e 74 65 72 66 61 63 65 20 72 65 74 75 72 6e 73  nterface returns
363f0 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68   a pointer to th
36400 65 20 6d 65 74 61 64 61 74 61 0a 2a 2a 20 61 73  e metadata.** as
36410 73 6f 63 69 61 74 65 64 20 62 79 20 74 68 65 20  sociated by the 
36420 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78 64  sqlite3_set_auxd
36430 61 74 61 28 29 20 66 75 6e 63 74 69 6f 6e 20 77  ata() function w
36440 69 74 68 20 74 68 65 20 4e 74 68 20 61 72 67 75  ith the Nth argu
36450 6d 65 6e 74 0a 2a 2a 20 76 61 6c 75 65 20 74 6f  ment.** value to
36460 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   the application
36470 2d 64 65 66 69 6e 65 64 20 66 75 6e 63 74 69 6f  -defined functio
36480 6e 2e 20 5e 49 66 20 74 68 65 72 65 20 69 73 20  n. ^If there is 
36490 6e 6f 20 6d 65 74 61 64 61 74 61 0a 2a 2a 20 61  no metadata.** a
364a0 73 73 6f 63 69 61 74 65 64 20 77 69 74 68 20 74  ssociated with t
364b0 68 65 20 66 75 6e 63 74 69 6f 6e 20 61 72 67 75  he function argu
364c0 6d 65 6e 74 2c 20 74 68 69 73 20 73 71 6c 69 74  ment, this sqlit
364d0 65 33 5f 67 65 74 5f 61 75 78 64 61 74 61 28 29  e3_get_auxdata()
364e0 20 69 6e 74 65 72 66 61 63 65 0a 2a 2a 20 72 65   interface.** re
364f0 74 75 72 6e 73 20 61 20 4e 55 4c 4c 20 70 6f 69  turns a NULL poi
36500 6e 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  nter..**.** ^The
36510 20 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78   sqlite3_set_aux
36520 64 61 74 61 28 43 2c 4e 2c 50 2c 58 29 20 69 6e  data(C,N,P,X) in
36530 74 65 72 66 61 63 65 20 73 61 76 65 73 20 50 20  terface saves P 
36540 61 73 20 6d 65 74 61 64 61 74 61 20 66 6f 72 20  as metadata for 
36550 74 68 65 20 4e 2d 74 68 0a 2a 2a 20 61 72 67 75  the N-th.** argu
36560 6d 65 6e 74 20 6f 66 20 74 68 65 20 61 70 70 6c  ment of the appl
36570 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20  ication-defined 
36580 66 75 6e 63 74 69 6f 6e 2e 20 20 5e 53 75 62 73  function.  ^Subs
36590 65 71 75 65 6e 74 0a 2a 2a 20 63 61 6c 6c 73 20  equent.** calls 
365a0 74 6f 20 73 71 6c 69 74 65 33 5f 67 65 74 5f 61  to sqlite3_get_a
365b0 75 78 64 61 74 61 28 43 2c 4e 29 20 72 65 74 75  uxdata(C,N) retu
365c0 72 6e 20 50 20 66 72 6f 6d 20 74 68 65 20 6d 6f  rn P from the mo
365d0 73 74 20 72 65 63 65 6e 74 0a 2a 2a 20 73 71 6c  st recent.** sql
365e0 69 74 65 33 5f 73 65 74 5f 61 75 78 64 61 74 61  ite3_set_auxdata
365f0 28 43 2c 4e 2c 50 2c 58 29 20 63 61 6c 6c 20 69  (C,N,P,X) call i
36600 66 20 74 68 65 20 6d 65 74 61 64 61 74 61 20 69  f the metadata i
36610 73 20 73 74 69 6c 6c 20 76 61 6c 69 64 20 6f 72  s still valid or
36620 0a 2a 2a 20 4e 55 4c 4c 20 69 66 20 74 68 65 20  .** NULL if the 
36630 6d 65 74 61 64 61 74 61 20 68 61 73 20 62 65 65  metadata has bee
36640 6e 20 64 69 73 63 61 72 64 65 64 2e 0a 2a 2a 20  n discarded..** 
36650 5e 41 66 74 65 72 20 65 61 63 68 20 63 61 6c 6c  ^After each call
36660 20 74 6f 20 73 71 6c 69 74 65 33 5f 73 65 74 5f   to sqlite3_set_
36670 61 75 78 64 61 74 61 28 43 2c 4e 2c 50 2c 58 29  auxdata(C,N,P,X)
36680 20 77 68 65 72 65 20 58 20 69 73 20 6e 6f 74 20   where X is not 
36690 4e 55 4c 4c 2c 0a 2a 2a 20 53 51 4c 69 74 65 20  NULL,.** SQLite 
366a0 77 69 6c 6c 20 69 6e 76 6f 6b 65 20 74 68 65 20  will invoke the 
366b0 64 65 73 74 72 75 63 74 6f 72 20 66 75 6e 63 74  destructor funct
366c0 69 6f 6e 20 58 20 77 69 74 68 20 70 61 72 61 6d  ion X with param
366d0 65 74 65 72 20 50 20 65 78 61 63 74 6c 79 0a 2a  eter P exactly.*
366e0 2a 20 6f 6e 63 65 2c 20 77 68 65 6e 20 74 68 65  * once, when the
366f0 20 6d 65 74 61 64 61 74 61 20 69 73 20 64 69 73   metadata is dis
36700 63 61 72 64 65 64 2e 0a 2a 2a 20 53 51 4c 69 74  carded..** SQLit
36710 65 20 69 73 20 66 72 65 65 20 74 6f 20 64 69 73  e is free to dis
36720 63 61 72 64 20 74 68 65 20 6d 65 74 61 64 61 74  card the metadat
36730 61 20 61 74 20 61 6e 79 20 74 69 6d 65 2c 20 69  a at any time, i
36740 6e 63 6c 75 64 69 6e 67 3a 20 3c 75 6c 3e 0a 2a  ncluding: <ul>.*
36750 2a 20 3c 6c 69 3e 20 77 68 65 6e 20 74 68 65 20  * <li> when the 
36760 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20 66 75  corresponding fu
36770 6e 63 74 69 6f 6e 20 70 61 72 61 6d 65 74 65 72  nction parameter
36780 20 63 68 61 6e 67 65 73 2c 20 6f 72 0a 2a 2a 20   changes, or.** 
36790 3c 6c 69 3e 20 77 68 65 6e 20 5b 73 71 6c 69 74  <li> when [sqlit
367a0 65 33 5f 72 65 73 65 74 28 29 5d 20 6f 72 20 5b  e3_reset()] or [
367b0 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65  sqlite3_finalize
367c0 28 29 5d 20 69 73 20 63 61 6c 6c 65 64 20 66 6f  ()] is called fo
367d0 72 20 74 68 65 0a 2a 2a 20 20 20 20 20 20 53 51  r the.**      SQ
367e0 4c 20 73 74 61 74 65 6d 65 6e 74 2c 20 6f 72 0a  L statement, or.
367f0 2a 2a 20 3c 6c 69 3e 20 77 68 65 6e 20 73 71 6c  ** <li> when sql
36800 69 74 65 33 5f 73 65 74 5f 61 75 78 64 61 74 61  ite3_set_auxdata
36810 28 29 20 69 73 20 69 6e 76 6f 6b 65 64 20 61 67  () is invoked ag
36820 61 69 6e 20 6f 6e 20 74 68 65 20 73 61 6d 65 20  ain on the same 
36830 70 61 72 61 6d 65 74 65 72 2c 20 6f 72 0a 2a 2a  parameter, or.**
36840 20 3c 6c 69 3e 20 64 75 72 69 6e 67 20 74 68 65   <li> during the
36850 20 6f 72 69 67 69 6e 61 6c 20 73 71 6c 69 74 65   original sqlite
36860 33 5f 73 65 74 5f 61 75 78 64 61 74 61 28 29 20  3_set_auxdata() 
36870 63 61 6c 6c 20 77 68 65 6e 20 61 20 6d 65 6d 6f  call when a memo
36880 72 79 20 0a 2a 2a 20 20 20 20 20 20 61 6c 6c 6f  ry .**      allo
36890 63 61 74 69 6f 6e 20 65 72 72 6f 72 20 6f 63 63  cation error occ
368a0 75 72 73 2e 20 3c 2f 75 6c 3e 29 5e 0a 2a 2a 0a  urs. </ul>)^.**.
368b0 2a 2a 20 4e 6f 74 65 20 74 68 65 20 6c 61 73 74  ** Note the last
368c0 20 62 75 6c 6c 65 74 20 69 6e 20 70 61 72 74 69   bullet in parti
368d0 63 75 6c 61 72 2e 20 20 54 68 65 20 64 65 73 74  cular.  The dest
368e0 72 75 63 74 6f 72 20 58 20 69 6e 20 0a 2a 2a 20  ructor X in .** 
368f0 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78 64  sqlite3_set_auxd
36900 61 74 61 28 43 2c 4e 2c 50 2c 58 29 20 6d 69 67  ata(C,N,P,X) mig
36910 68 74 20 62 65 20 63 61 6c 6c 65 64 20 69 6d 6d  ht be called imm
36920 65 64 69 61 74 65 6c 79 2c 20 62 65 66 6f 72 65  ediately, before
36930 20 74 68 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f   the.** sqlite3_
36940 73 65 74 5f 61 75 78 64 61 74 61 28 29 20 69 6e  set_auxdata() in
36950 74 65 72 66 61 63 65 20 65 76 65 6e 20 72 65 74  terface even ret
36960 75 72 6e 73 2e 20 20 48 65 6e 63 65 20 73 71 6c  urns.  Hence sql
36970 69 74 65 33 5f 73 65 74 5f 61 75 78 64 61 74 61  ite3_set_auxdata
36980 28 29 0a 2a 2a 20 73 68 6f 75 6c 64 20 62 65 20  ().** should be 
36990 63 61 6c 6c 65 64 20 6e 65 61 72 20 74 68 65 20  called near the 
369a0 65 6e 64 20 6f 66 20 74 68 65 20 66 75 6e 63 74  end of the funct
369b0 69 6f 6e 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  ion implementati
369c0 6f 6e 20 61 6e 64 20 74 68 65 0a 2a 2a 20 66 75  on and the.** fu
369d0 6e 63 74 69 6f 6e 20 69 6d 70 6c 65 6d 65 6e 74  nction implement
369e0 61 74 69 6f 6e 20 73 68 6f 75 6c 64 20 6e 6f 74  ation should not
369f0 20 6d 61 6b 65 20 61 6e 79 20 75 73 65 20 6f 66   make any use of
36a00 20 50 20 61 66 74 65 72 0a 2a 2a 20 73 71 6c 69   P after.** sqli
36a10 74 65 33 5f 73 65 74 5f 61 75 78 64 61 74 61 28  te3_set_auxdata(
36a20 29 20 68 61 73 20 62 65 65 6e 20 63 61 6c 6c 65  ) has been calle
36a30 64 2e 0a 2a 2a 0a 2a 2a 20 5e 28 49 6e 20 70 72  d..**.** ^(In pr
36a40 61 63 74 69 63 65 2c 20 6d 65 74 61 64 61 74 61  actice, metadata
36a50 20 69 73 20 70 72 65 73 65 72 76 65 64 20 62 65   is preserved be
36a60 74 77 65 65 6e 20 66 75 6e 63 74 69 6f 6e 20 63  tween function c
36a70 61 6c 6c 73 20 66 6f 72 0a 2a 2a 20 66 75 6e 63  alls for.** func
36a80 74 69 6f 6e 20 70 61 72 61 6d 65 74 65 72 73 20  tion parameters 
36a90 74 68 61 74 20 61 72 65 20 63 6f 6d 70 69 6c 65  that are compile
36aa0 2d 74 69 6d 65 20 63 6f 6e 73 74 61 6e 74 73 2c  -time constants,
36ab0 20 69 6e 63 6c 75 64 69 6e 67 20 6c 69 74 65 72   including liter
36ac0 61 6c 0a 2a 2a 20 76 61 6c 75 65 73 20 61 6e 64  al.** values and
36ad0 20 5b 70 61 72 61 6d 65 74 65 72 73 5d 20 61 6e   [parameters] an
36ae0 64 20 65 78 70 72 65 73 73 69 6f 6e 73 20 63 6f  d expressions co
36af0 6d 70 6f 73 65 64 20 66 72 6f 6d 20 74 68 65 20  mposed from the 
36b00 73 61 6d 65 2e 29 5e 0a 2a 2a 0a 2a 2a 20 54 68  same.)^.**.** Th
36b10 65 73 65 20 72 6f 75 74 69 6e 65 73 20 6d 75 73  ese routines mus
36b20 74 20 62 65 20 63 61 6c 6c 65 64 20 66 72 6f 6d  t be called from
36b30 20 74 68 65 20 73 61 6d 65 20 74 68 72 65 61 64   the same thread
36b40 20 69 6e 20 77 68 69 63 68 0a 2a 2a 20 74 68 65   in which.** the
36b50 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 69 73   SQL function is
36b60 20 72 75 6e 6e 69 6e 67 2e 0a 2a 2f 0a 76 6f 69   running..*/.voi
36b70 64 20 2a 73 71 6c 69 74 65 33 5f 67 65 74 5f 61  d *sqlite3_get_a
36b80 75 78 64 61 74 61 28 73 71 6c 69 74 65 33 5f 63  uxdata(sqlite3_c
36b90 6f 6e 74 65 78 74 2a 2c 20 69 6e 74 20 4e 29 3b  ontext*, int N);
36ba0 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 5f 73 65  .void sqlite3_se
36bb0 74 5f 61 75 78 64 61 74 61 28 73 71 6c 69 74 65  t_auxdata(sqlite
36bc0 33 5f 63 6f 6e 74 65 78 74 2a 2c 20 69 6e 74 20  3_context*, int 
36bd0 4e 2c 20 76 6f 69 64 2a 2c 20 76 6f 69 64 20 28  N, void*, void (
36be0 2a 29 28 76 6f 69 64 2a 29 29 3b 0a 0a 0a 2f 2a  *)(void*));.../*
36bf0 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6f  .** CAPI3REF: Co
36c00 6e 73 74 61 6e 74 73 20 44 65 66 69 6e 69 6e 67  nstants Defining
36c10 20 53 70 65 63 69 61 6c 20 44 65 73 74 72 75 63   Special Destruc
36c20 74 6f 72 20 42 65 68 61 76 69 6f 72 0a 2a 2a 0a  tor Behavior.**.
36c30 2a 2a 20 54 68 65 73 65 20 61 72 65 20 73 70 65  ** These are spe
36c40 63 69 61 6c 20 76 61 6c 75 65 73 20 66 6f 72 20  cial values for 
36c50 74 68 65 20 64 65 73 74 72 75 63 74 6f 72 20 74  the destructor t
36c60 68 61 74 20 69 73 20 70 61 73 73 65 64 20 69 6e  hat is passed in
36c70 20 61 73 20 74 68 65 0a 2a 2a 20 66 69 6e 61 6c   as the.** final
36c80 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 72 6f 75   argument to rou
36c90 74 69 6e 65 73 20 6c 69 6b 65 20 5b 73 71 6c 69  tines like [sqli
36ca0 74 65 33 5f 72 65 73 75 6c 74 5f 62 6c 6f 62 28  te3_result_blob(
36cb0 29 5d 2e 20 20 5e 49 66 20 74 68 65 20 64 65 73  )].  ^If the des
36cc0 74 72 75 63 74 6f 72 0a 2a 2a 20 61 72 67 75 6d  tructor.** argum
36cd0 65 6e 74 20 69 73 20 53 51 4c 49 54 45 5f 53 54  ent is SQLITE_ST
36ce0 41 54 49 43 2c 20 69 74 20 6d 65 61 6e 73 20 74  ATIC, it means t
36cf0 68 61 74 20 74 68 65 20 63 6f 6e 74 65 6e 74 20  hat the content 
36d00 70 6f 69 6e 74 65 72 20 69 73 20 63 6f 6e 73 74  pointer is const
36d10 61 6e 74 0a 2a 2a 20 61 6e 64 20 77 69 6c 6c 20  ant.** and will 
36d20 6e 65 76 65 72 20 63 68 61 6e 67 65 2e 20 20 49  never change.  I
36d30 74 20 64 6f 65 73 20 6e 6f 74 20 6e 65 65 64 20  t does not need 
36d40 74 6f 20 62 65 20 64 65 73 74 72 6f 79 65 64 2e  to be destroyed.
36d50 20 20 5e 54 68 65 0a 2a 2a 20 53 51 4c 49 54 45    ^The.** SQLITE
36d60 5f 54 52 41 4e 53 49 45 4e 54 20 76 61 6c 75 65  _TRANSIENT value
36d70 20 6d 65 61 6e 73 20 74 68 61 74 20 74 68 65 20   means that the 
36d80 63 6f 6e 74 65 6e 74 20 77 69 6c 6c 20 6c 69 6b  content will lik
36d90 65 6c 79 20 63 68 61 6e 67 65 20 69 6e 0a 2a 2a  ely change in.**
36da0 20 74 68 65 20 6e 65 61 72 20 66 75 74 75 72 65   the near future
36db0 20 61 6e 64 20 74 68 61 74 20 53 51 4c 69 74 65   and that SQLite
36dc0 20 73 68 6f 75 6c 64 20 6d 61 6b 65 20 69 74 73   should make its
36dd0 20 6f 77 6e 20 70 72 69 76 61 74 65 20 63 6f 70   own private cop
36de0 79 20 6f 66 0a 2a 2a 20 74 68 65 20 63 6f 6e 74  y of.** the cont
36df0 65 6e 74 20 62 65 66 6f 72 65 20 72 65 74 75 72  ent before retur
36e00 6e 69 6e 67 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  ning..**.** The 
36e10 74 79 70 65 64 65 66 20 69 73 20 6e 65 63 65 73  typedef is neces
36e20 73 61 72 79 20 74 6f 20 77 6f 72 6b 20 61 72 6f  sary to work aro
36e30 75 6e 64 20 70 72 6f 62 6c 65 6d 73 20 69 6e 20  und problems in 
36e40 63 65 72 74 61 69 6e 0a 2a 2a 20 43 2b 2b 20 63  certain.** C++ c
36e50 6f 6d 70 69 6c 65 72 73 2e 0a 2a 2f 0a 74 79 70  ompilers..*/.typ
36e60 65 64 65 66 20 76 6f 69 64 20 28 2a 73 71 6c 69  edef void (*sqli
36e70 74 65 33 5f 64 65 73 74 72 75 63 74 6f 72 5f 74  te3_destructor_t
36e80 79 70 65 29 28 76 6f 69 64 2a 29 3b 0a 23 64 65  ype)(void*);.#de
36e90 66 69 6e 65 20 53 51 4c 49 54 45 5f 53 54 41 54  fine SQLITE_STAT
36ea0 49 43 20 20 20 20 20 20 28 28 73 71 6c 69 74 65  IC      ((sqlite
36eb0 33 5f 64 65 73 74 72 75 63 74 6f 72 5f 74 79 70  3_destructor_typ
36ec0 65 29 30 29 0a 23 64 65 66 69 6e 65 20 53 51 4c  e)0).#define SQL
36ed0 49 54 45 5f 54 52 41 4e 53 49 45 4e 54 20 20 20  ITE_TRANSIENT   
36ee0 28 28 73 71 6c 69 74 65 33 5f 64 65 73 74 72 75  ((sqlite3_destru
36ef0 63 74 6f 72 5f 74 79 70 65 29 2d 31 29 0a 0a 2f  ctor_type)-1)../
36f00 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 53  *.** CAPI3REF: S
36f10 65 74 74 69 6e 67 20 54 68 65 20 52 65 73 75 6c  etting The Resul
36f20 74 20 4f 66 20 41 6e 20 53 51 4c 20 46 75 6e 63  t Of An SQL Func
36f30 74 69 6f 6e 0a 2a 2a 20 4d 45 54 48 4f 44 3a 20  tion.** METHOD: 
36f40 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 0a  sqlite3_context.
36f50 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72 6f 75 74  **.** These rout
36f60 69 6e 65 73 20 61 72 65 20 75 73 65 64 20 62 79  ines are used by
36f70 20 74 68 65 20 78 46 75 6e 63 20 6f 72 20 78 46   the xFunc or xF
36f80 69 6e 61 6c 20 63 61 6c 6c 62 61 63 6b 73 20 74  inal callbacks t
36f90 68 61 74 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e 74  hat.** implement
36fa0 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20 61   SQL functions a
36fb0 6e 64 20 61 67 67 72 65 67 61 74 65 73 2e 20 20  nd aggregates.  
36fc0 53 65 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  See.** [sqlite3_
36fd0 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 28  create_function(
36fe0 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f  )] and [sqlite3_
36ff0 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 31  create_function1
37000 36 28 29 5d 0a 2a 2a 20 66 6f 72 20 61 64 64 69  6()].** for addi
37010 74 69 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61 74 69  tional informati
37020 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20  on..**.** These 
37030 66 75 6e 63 74 69 6f 6e 73 20 77 6f 72 6b 20 76  functions work v
37040 65 72 79 20 6d 75 63 68 20 6c 69 6b 65 20 74 68  ery much like th
37050 65 20 5b 70 61 72 61 6d 65 74 65 72 20 62 69 6e  e [parameter bin
37060 64 69 6e 67 5d 20 66 61 6d 69 6c 79 20 6f 66 0a  ding] family of.
37070 2a 2a 20 66 75 6e 63 74 69 6f 6e 73 20 75 73 65  ** functions use
37080 64 20 74 6f 20 62 69 6e 64 20 76 61 6c 75 65 73  d to bind values
37090 20 74 6f 20 68 6f 73 74 20 70 61 72 61 6d 65 74   to host paramet
370a0 65 72 73 20 69 6e 20 70 72 65 70 61 72 65 64 20  ers in prepared 
370b0 73 74 61 74 65 6d 65 6e 74 73 2e 0a 2a 2a 20 52  statements..** R
370c0 65 66 65 72 20 74 6f 20 74 68 65 20 5b 53 51 4c  efer to the [SQL
370d0 20 70 61 72 61 6d 65 74 65 72 5d 20 64 6f 63 75   parameter] docu
370e0 6d 65 6e 74 61 74 69 6f 6e 20 66 6f 72 20 61 64  mentation for ad
370f0 64 69 74 69 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61  ditional informa
37100 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  tion..**.** ^The
37110 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f   sqlite3_result_
37120 62 6c 6f 62 28 29 20 69 6e 74 65 72 66 61 63 65  blob() interface
37130 20 73 65 74 73 20 74 68 65 20 72 65 73 75 6c 74   sets the result
37140 20 66 72 6f 6d 0a 2a 2a 20 61 6e 20 61 70 70 6c   from.** an appl
37150 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20  ication-defined 
37160 66 75 6e 63 74 69 6f 6e 20 74 6f 20 62 65 20 74  function to be t
37170 68 65 20 42 4c 4f 42 20 77 68 6f 73 65 20 63 6f  he BLOB whose co
37180 6e 74 65 6e 74 20 69 73 20 70 6f 69 6e 74 65 64  ntent is pointed
37190 0a 2a 2a 20 74 6f 20 62 79 20 74 68 65 20 73 65  .** to by the se
371a0 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20 61  cond parameter a
371b0 6e 64 20 77 68 69 63 68 20 69 73 20 4e 20 62 79  nd which is N by
371c0 74 65 73 20 6c 6f 6e 67 20 77 68 65 72 65 20 4e  tes long where N
371d0 20 69 73 20 74 68 65 0a 2a 2a 20 74 68 69 72 64   is the.** third
371e0 20 70 61 72 61 6d 65 74 65 72 2e 0a 2a 2a 0a 2a   parameter..**.*
371f0 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 72  * ^The sqlite3_r
37200 65 73 75 6c 74 5f 7a 65 72 6f 62 6c 6f 62 28 43  esult_zeroblob(C
37210 2c 4e 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f  ,N) and sqlite3_
37220 72 65 73 75 6c 74 5f 7a 65 72 6f 62 6c 6f 62 36  result_zeroblob6
37230 34 28 43 2c 4e 29 0a 2a 2a 20 69 6e 74 65 72 66  4(C,N).** interf
37240 61 63 65 73 20 73 65 74 20 74 68 65 20 72 65 73  aces set the res
37250 75 6c 74 20 6f 66 20 74 68 65 20 61 70 70 6c 69  ult of the appli
37260 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 66  cation-defined f
37270 75 6e 63 74 69 6f 6e 20 74 6f 20 62 65 0a 2a 2a  unction to be.**
37280 20 61 20 42 4c 4f 42 20 63 6f 6e 74 61 69 6e 69   a BLOB containi
37290 6e 67 20 61 6c 6c 20 7a 65 72 6f 20 62 79 74 65  ng all zero byte
372a0 73 20 61 6e 64 20 4e 20 62 79 74 65 73 20 69 6e  s and N bytes in
372b0 20 73 69 7a 65 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68   size..**.** ^Th
372c0 65 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74  e sqlite3_result
372d0 5f 64 6f 75 62 6c 65 28 29 20 69 6e 74 65 72 66  _double() interf
372e0 61 63 65 20 73 65 74 73 20 74 68 65 20 72 65 73  ace sets the res
372f0 75 6c 74 20 66 72 6f 6d 0a 2a 2a 20 61 6e 20 61  ult from.** an a
37300 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e  pplication-defin
37310 65 64 20 66 75 6e 63 74 69 6f 6e 20 74 6f 20 62  ed function to b
37320 65 20 61 20 66 6c 6f 61 74 69 6e 67 20 70 6f 69  e a floating poi
37330 6e 74 20 76 61 6c 75 65 20 73 70 65 63 69 66 69  nt value specifi
37340 65 64 0a 2a 2a 20 62 79 20 69 74 73 20 32 6e 64  ed.** by its 2nd
37350 20 61 72 67 75 6d 65 6e 74 2e 0a 2a 2a 0a 2a 2a   argument..**.**
37360 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 72 65   ^The sqlite3_re
37370 73 75 6c 74 5f 65 72 72 6f 72 28 29 20 61 6e 64  sult_error() and
37380 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f   sqlite3_result_
37390 65 72 72 6f 72 31 36 28 29 20 66 75 6e 63 74 69  error16() functi
373a0 6f 6e 73 0a 2a 2a 20 63 61 75 73 65 20 74 68 65  ons.** cause the
373b0 20 69 6d 70 6c 65 6d 65 6e 74 65 64 20 53 51 4c   implemented SQL
373c0 20 66 75 6e 63 74 69 6f 6e 20 74 6f 20 74 68 72   function to thr
373d0 6f 77 20 61 6e 20 65 78 63 65 70 74 69 6f 6e 2e  ow an exception.
373e0 0a 2a 2a 20 5e 53 51 4c 69 74 65 20 75 73 65 73  .** ^SQLite uses
373f0 20 74 68 65 20 73 74 72 69 6e 67 20 70 6f 69 6e   the string poin
37400 74 65 64 20 74 6f 20 62 79 20 74 68 65 0a 2a 2a  ted to by the.**
37410 20 32 6e 64 20 70 61 72 61 6d 65 74 65 72 20 6f   2nd parameter o
37420 66 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74  f sqlite3_result
37430 5f 65 72 72 6f 72 28 29 20 6f 72 20 73 71 6c 69  _error() or sqli
37440 74 65 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f 72  te3_result_error
37450 31 36 28 29 0a 2a 2a 20 61 73 20 74 68 65 20 74  16().** as the t
37460 65 78 74 20 6f 66 20 61 6e 20 65 72 72 6f 72 20  ext of an error 
37470 6d 65 73 73 61 67 65 2e 20 20 5e 53 51 4c 69 74  message.  ^SQLit
37480 65 20 69 6e 74 65 72 70 72 65 74 73 20 74 68 65  e interprets the
37490 20 65 72 72 6f 72 0a 2a 2a 20 6d 65 73 73 61 67   error.** messag
374a0 65 20 73 74 72 69 6e 67 20 66 72 6f 6d 20 73 71  e string from sq
374b0 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 65 72 72  lite3_result_err
374c0 6f 72 28 29 20 61 73 20 55 54 46 2d 38 2e 20 5e  or() as UTF-8. ^
374d0 53 51 4c 69 74 65 0a 2a 2a 20 69 6e 74 65 72 70  SQLite.** interp
374e0 72 65 74 73 20 74 68 65 20 73 74 72 69 6e 67 20  rets the string 
374f0 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f 72 65 73  from sqlite3_res
37500 75 6c 74 5f 65 72 72 6f 72 31 36 28 29 20 61 73  ult_error16() as
37510 20 55 54 46 2d 31 36 20 69 6e 20 6e 61 74 69 76   UTF-16 in nativ
37520 65 0a 2a 2a 20 62 79 74 65 20 6f 72 64 65 72 2e  e.** byte order.
37530 20 20 5e 49 66 20 74 68 65 20 74 68 69 72 64 20    ^If the third 
37540 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c  parameter to sql
37550 69 74 65 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f  ite3_result_erro
37560 72 28 29 0a 2a 2a 20 6f 72 20 73 71 6c 69 74 65  r().** or sqlite
37570 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f 72 31 36  3_result_error16
37580 28 29 20 69 73 20 6e 65 67 61 74 69 76 65 20 74  () is negative t
37590 68 65 6e 20 53 51 4c 69 74 65 20 74 61 6b 65 73  hen SQLite takes
375a0 20 61 73 20 74 68 65 20 65 72 72 6f 72 0a 2a 2a   as the error.**
375b0 20 6d 65 73 73 61 67 65 20 61 6c 6c 20 74 65 78   message all tex
375c0 74 20 75 70 20 74 68 72 6f 75 67 68 20 74 68 65  t up through the
375d0 20 66 69 72 73 74 20 7a 65 72 6f 20 63 68 61 72   first zero char
375e0 61 63 74 65 72 2e 0a 2a 2a 20 5e 49 66 20 74 68  acter..** ^If th
375f0 65 20 74 68 69 72 64 20 70 61 72 61 6d 65 74 65  e third paramete
37600 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 72 65 73  r to sqlite3_res
37610 75 6c 74 5f 65 72 72 6f 72 28 29 20 6f 72 0a 2a  ult_error() or.*
37620 2a 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74  * sqlite3_result
37630 5f 65 72 72 6f 72 31 36 28 29 20 69 73 20 6e 6f  _error16() is no
37640 6e 2d 6e 65 67 61 74 69 76 65 20 74 68 65 6e 20  n-negative then 
37650 53 51 4c 69 74 65 20 74 61 6b 65 73 20 74 68 61  SQLite takes tha
37660 74 20 6d 61 6e 79 0a 2a 2a 20 62 79 74 65 73 20  t many.** bytes 
37670 28 6e 6f 74 20 63 68 61 72 61 63 74 65 72 73 29  (not characters)
37680 20 66 72 6f 6d 20 74 68 65 20 32 6e 64 20 70 61   from the 2nd pa
37690 72 61 6d 65 74 65 72 20 61 73 20 74 68 65 20 65  rameter as the e
376a0 72 72 6f 72 20 6d 65 73 73 61 67 65 2e 0a 2a 2a  rror message..**
376b0 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 72 65   ^The sqlite3_re
376c0 73 75 6c 74 5f 65 72 72 6f 72 28 29 20 61 6e 64  sult_error() and
376d0 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f   sqlite3_result_
376e0 65 72 72 6f 72 31 36 28 29 0a 2a 2a 20 72 6f 75  error16().** rou
376f0 74 69 6e 65 73 20 6d 61 6b 65 20 61 20 70 72 69  tines make a pri
37700 76 61 74 65 20 63 6f 70 79 20 6f 66 20 74 68 65  vate copy of the
37710 20 65 72 72 6f 72 20 6d 65 73 73 61 67 65 20 74   error message t
37720 65 78 74 20 62 65 66 6f 72 65 0a 2a 2a 20 74 68  ext before.** th
37730 65 79 20 72 65 74 75 72 6e 2e 20 20 48 65 6e 63  ey return.  Henc
37740 65 2c 20 74 68 65 20 63 61 6c 6c 69 6e 67 20 66  e, the calling f
37750 75 6e 63 74 69 6f 6e 20 63 61 6e 20 64 65 61 6c  unction can deal
37760 6c 6f 63 61 74 65 20 6f 72 0a 2a 2a 20 6d 6f 64  locate or.** mod
37770 69 66 79 20 74 68 65 20 74 65 78 74 20 61 66 74  ify the text aft
37780 65 72 20 74 68 65 79 20 72 65 74 75 72 6e 20 77  er they return w
37790 69 74 68 6f 75 74 20 68 61 72 6d 2e 0a 2a 2a 20  ithout harm..** 
377a0 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 72 65 73  ^The sqlite3_res
377b0 75 6c 74 5f 65 72 72 6f 72 5f 63 6f 64 65 28 29  ult_error_code()
377c0 20 66 75 6e 63 74 69 6f 6e 20 63 68 61 6e 67 65   function change
377d0 73 20 74 68 65 20 65 72 72 6f 72 20 63 6f 64 65  s the error code
377e0 0a 2a 2a 20 72 65 74 75 72 6e 65 64 20 62 79 20  .** returned by 
377f0 53 51 4c 69 74 65 20 61 73 20 61 20 72 65 73 75  SQLite as a resu
37800 6c 74 20 6f 66 20 61 6e 20 65 72 72 6f 72 20 69  lt of an error i
37810 6e 20 61 20 66 75 6e 63 74 69 6f 6e 2e 20 20 5e  n a function.  ^
37820 42 79 20 64 65 66 61 75 6c 74 2c 0a 2a 2a 20 74  By default,.** t
37830 68 65 20 65 72 72 6f 72 20 63 6f 64 65 20 69 73  he error code is
37840 20 53 51 4c 49 54 45 5f 45 52 52 4f 52 2e 20 20   SQLITE_ERROR.  
37850 5e 41 20 73 75 62 73 65 71 75 65 6e 74 20 63 61  ^A subsequent ca
37860 6c 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f 72 65  ll to sqlite3_re
37870 73 75 6c 74 5f 65 72 72 6f 72 28 29 0a 2a 2a 20  sult_error().** 
37880 6f 72 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c  or sqlite3_resul
37890 74 5f 65 72 72 6f 72 31 36 28 29 20 72 65 73 65  t_error16() rese
378a0 74 73 20 74 68 65 20 65 72 72 6f 72 20 63 6f 64  ts the error cod
378b0 65 20 74 6f 20 53 51 4c 49 54 45 5f 45 52 52 4f  e to SQLITE_ERRO
378c0 52 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71  R..**.** ^The sq
378d0 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 65 72 72  lite3_result_err
378e0 6f 72 5f 74 6f 6f 62 69 67 28 29 20 69 6e 74 65  or_toobig() inte
378f0 72 66 61 63 65 20 63 61 75 73 65 73 20 53 51 4c  rface causes SQL
37900 69 74 65 20 74 6f 20 74 68 72 6f 77 20 61 6e 0a  ite to throw an.
37910 2a 2a 20 65 72 72 6f 72 20 69 6e 64 69 63 61 74  ** error indicat
37920 69 6e 67 20 74 68 61 74 20 61 20 73 74 72 69 6e  ing that a strin
37930 67 20 6f 72 20 42 4c 4f 42 20 69 73 20 74 6f 6f  g or BLOB is too
37940 20 6c 6f 6e 67 20 74 6f 20 72 65 70 72 65 73 65   long to represe
37950 6e 74 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  nt..**.** ^The s
37960 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 65 72  qlite3_result_er
37970 72 6f 72 5f 6e 6f 6d 65 6d 28 29 20 69 6e 74 65  ror_nomem() inte
37980 72 66 61 63 65 20 63 61 75 73 65 73 20 53 51 4c  rface causes SQL
37990 69 74 65 20 74 6f 20 74 68 72 6f 77 20 61 6e 0a  ite to throw an.
379a0 2a 2a 20 65 72 72 6f 72 20 69 6e 64 69 63 61 74  ** error indicat
379b0 69 6e 67 20 74 68 61 74 20 61 20 6d 65 6d 6f 72  ing that a memor
379c0 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 66 61 69  y allocation fai
379d0 6c 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  led..**.** ^The 
379e0 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 69  sqlite3_result_i
379f0 6e 74 28 29 20 69 6e 74 65 72 66 61 63 65 20 73  nt() interface s
37a00 65 74 73 20 74 68 65 20 72 65 74 75 72 6e 20 76  ets the return v
37a10 61 6c 75 65 0a 2a 2a 20 6f 66 20 74 68 65 20 61  alue.** of the a
37a20 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e  pplication-defin
37a30 65 64 20 66 75 6e 63 74 69 6f 6e 20 74 6f 20 62  ed function to b
37a40 65 20 74 68 65 20 33 32 2d 62 69 74 20 73 69 67  e the 32-bit sig
37a50 6e 65 64 20 69 6e 74 65 67 65 72 0a 2a 2a 20 76  ned integer.** v
37a60 61 6c 75 65 20 67 69 76 65 6e 20 69 6e 20 74 68  alue given in th
37a70 65 20 32 6e 64 20 61 72 67 75 6d 65 6e 74 2e 0a  e 2nd argument..
37a80 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  ** ^The sqlite3_
37a90 72 65 73 75 6c 74 5f 69 6e 74 36 34 28 29 20 69  result_int64() i
37aa0 6e 74 65 72 66 61 63 65 20 73 65 74 73 20 74 68  nterface sets th
37ab0 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 0a 2a  e return value.*
37ac0 2a 20 6f 66 20 74 68 65 20 61 70 70 6c 69 63 61  * of the applica
37ad0 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 66 75 6e  tion-defined fun
37ae0 63 74 69 6f 6e 20 74 6f 20 62 65 20 74 68 65 20  ction to be the 
37af0 36 34 2d 62 69 74 20 73 69 67 6e 65 64 20 69 6e  64-bit signed in
37b00 74 65 67 65 72 0a 2a 2a 20 76 61 6c 75 65 20 67  teger.** value g
37b10 69 76 65 6e 20 69 6e 20 74 68 65 20 32 6e 64 20  iven in the 2nd 
37b20 61 72 67 75 6d 65 6e 74 2e 0a 2a 2a 0a 2a 2a 20  argument..**.** 
37b30 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 72 65 73  ^The sqlite3_res
37b40 75 6c 74 5f 6e 75 6c 6c 28 29 20 69 6e 74 65 72  ult_null() inter
37b50 66 61 63 65 20 73 65 74 73 20 74 68 65 20 72 65  face sets the re
37b60 74 75 72 6e 20 76 61 6c 75 65 0a 2a 2a 20 6f 66  turn value.** of
37b70 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   the application
37b80 2d 64 65 66 69 6e 65 64 20 66 75 6e 63 74 69 6f  -defined functio
37b90 6e 20 74 6f 20 62 65 20 4e 55 4c 4c 2e 0a 2a 2a  n to be NULL..**
37ba0 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33  .** ^The sqlite3
37bb0 5f 72 65 73 75 6c 74 5f 74 65 78 74 28 29 2c 20  _result_text(), 
37bc0 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 74  sqlite3_result_t
37bd0 65 78 74 31 36 28 29 2c 0a 2a 2a 20 73 71 6c 69  ext16(),.** sqli
37be0 74 65 33 5f 72 65 73 75 6c 74 5f 74 65 78 74 31  te3_result_text1
37bf0 36 6c 65 28 29 2c 20 61 6e 64 20 73 71 6c 69 74  6le(), and sqlit
37c00 65 33 5f 72 65 73 75 6c 74 5f 74 65 78 74 31 36  e3_result_text16
37c10 62 65 28 29 20 69 6e 74 65 72 66 61 63 65 73 0a  be() interfaces.
37c20 2a 2a 20 73 65 74 20 74 68 65 20 72 65 74 75 72  ** set the retur
37c30 6e 20 76 61 6c 75 65 20 6f 66 20 74 68 65 20 61  n value of the a
37c40 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e  pplication-defin
37c50 65 64 20 66 75 6e 63 74 69 6f 6e 20 74 6f 20 62  ed function to b
37c60 65 0a 2a 2a 20 61 20 74 65 78 74 20 73 74 72 69  e.** a text stri
37c70 6e 67 20 77 68 69 63 68 20 69 73 20 72 65 70 72  ng which is repr
37c80 65 73 65 6e 74 65 64 20 61 73 20 55 54 46 2d 38  esented as UTF-8
37c90 2c 20 55 54 46 2d 31 36 20 6e 61 74 69 76 65 20  , UTF-16 native 
37ca0 62 79 74 65 20 6f 72 64 65 72 2c 0a 2a 2a 20 55  byte order,.** U
37cb0 54 46 2d 31 36 20 6c 69 74 74 6c 65 20 65 6e 64  TF-16 little end
37cc0 69 61 6e 2c 20 6f 72 20 55 54 46 2d 31 36 20 62  ian, or UTF-16 b
37cd0 69 67 20 65 6e 64 69 61 6e 2c 20 72 65 73 70 65  ig endian, respe
37ce0 63 74 69 76 65 6c 79 2e 0a 2a 2a 20 5e 54 68 65  ctively..** ^The
37cf0 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f   sqlite3_result_
37d00 74 65 78 74 36 34 28 29 20 69 6e 74 65 72 66 61  text64() interfa
37d10 63 65 20 73 65 74 73 20 74 68 65 20 72 65 74 75  ce sets the retu
37d20 72 6e 20 76 61 6c 75 65 20 6f 66 20 61 6e 0a 2a  rn value of an.*
37d30 2a 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65  * application-de
37d40 66 69 6e 65 64 20 66 75 6e 63 74 69 6f 6e 20 74  fined function t
37d50 6f 20 62 65 20 61 20 74 65 78 74 20 73 74 72 69  o be a text stri
37d60 6e 67 20 69 6e 20 61 6e 20 65 6e 63 6f 64 69 6e  ng in an encodin
37d70 67 0a 2a 2a 20 73 70 65 63 69 66 69 65 64 20 62  g.** specified b
37d80 79 20 74 68 65 20 66 69 66 74 68 20 28 61 6e 64  y the fifth (and
37d90 20 6c 61 73 74 29 20 70 61 72 61 6d 65 74 65 72   last) parameter
37da0 2c 20 77 68 69 63 68 20 6d 75 73 74 20 62 65 20  , which must be 
37db0 6f 6e 65 0a 2a 2a 20 6f 66 20 5b 53 51 4c 49 54  one.** of [SQLIT
37dc0 45 5f 55 54 46 38 5d 2c 20 5b 53 51 4c 49 54 45  E_UTF8], [SQLITE
37dd0 5f 55 54 46 31 36 5d 2c 20 5b 53 51 4c 49 54 45  _UTF16], [SQLITE
37de0 5f 55 54 46 31 36 42 45 5d 2c 20 6f 72 20 5b 53  _UTF16BE], or [S
37df0 51 4c 49 54 45 5f 55 54 46 31 36 4c 45 5d 2e 0a  QLITE_UTF16LE]..
37e00 2a 2a 20 5e 53 51 4c 69 74 65 20 74 61 6b 65 73  ** ^SQLite takes
37e10 20 74 68 65 20 74 65 78 74 20 72 65 73 75 6c 74   the text result
37e20 20 66 72 6f 6d 20 74 68 65 20 61 70 70 6c 69 63   from the applic
37e30 61 74 69 6f 6e 20 66 72 6f 6d 0a 2a 2a 20 74 68  ation from.** th
37e40 65 20 32 6e 64 20 70 61 72 61 6d 65 74 65 72 20  e 2nd parameter 
37e50 6f 66 20 74 68 65 20 73 71 6c 69 74 65 33 5f 72  of the sqlite3_r
37e60 65 73 75 6c 74 5f 74 65 78 74 2a 20 69 6e 74 65  esult_text* inte
37e70 72 66 61 63 65 73 2e 0a 2a 2a 20 5e 49 66 20 74  rfaces..** ^If t
37e80 68 65 20 33 72 64 20 70 61 72 61 6d 65 74 65 72  he 3rd parameter
37e90 20 74 6f 20 74 68 65 20 73 71 6c 69 74 65 33 5f   to the sqlite3_
37ea0 72 65 73 75 6c 74 5f 74 65 78 74 2a 20 69 6e 74  result_text* int
37eb0 65 72 66 61 63 65 73 0a 2a 2a 20 69 73 20 6e 65  erfaces.** is ne
37ec0 67 61 74 69 76 65 2c 20 74 68 65 6e 20 53 51 4c  gative, then SQL
37ed0 69 74 65 20 74 61 6b 65 73 20 72 65 73 75 6c 74  ite takes result
37ee0 20 74 65 78 74 20 66 72 6f 6d 20 74 68 65 20 32   text from the 2
37ef0 6e 64 20 70 61 72 61 6d 65 74 65 72 0a 2a 2a 20  nd parameter.** 
37f00 74 68 72 6f 75 67 68 20 74 68 65 20 66 69 72 73  through the firs
37f10 74 20 7a 65 72 6f 20 63 68 61 72 61 63 74 65 72  t zero character
37f20 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 33 72 64  ..** ^If the 3rd
37f30 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 74 68   parameter to th
37f40 65 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74  e sqlite3_result
37f50 5f 74 65 78 74 2a 20 69 6e 74 65 72 66 61 63 65  _text* interface
37f60 73 0a 2a 2a 20 69 73 20 6e 6f 6e 2d 6e 65 67 61  s.** is non-nega
37f70 74 69 76 65 2c 20 74 68 65 6e 20 61 73 20 6d 61  tive, then as ma
37f80 6e 79 20 62 79 74 65 73 20 28 6e 6f 74 20 63 68  ny bytes (not ch
37f90 61 72 61 63 74 65 72 73 29 20 6f 66 20 74 68 65  aracters) of the
37fa0 20 74 65 78 74 0a 2a 2a 20 70 6f 69 6e 74 65 64   text.** pointed
37fb0 20 74 6f 20 62 79 20 74 68 65 20 32 6e 64 20 70   to by the 2nd p
37fc0 61 72 61 6d 65 74 65 72 20 61 72 65 20 74 61 6b  arameter are tak
37fd0 65 6e 20 61 73 20 74 68 65 20 61 70 70 6c 69 63  en as the applic
37fe0 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 0a 2a 2a  ation-defined.**
37ff0 20 66 75 6e 63 74 69 6f 6e 20 72 65 73 75 6c 74   function result
38000 2e 20 20 49 66 20 74 68 65 20 33 72 64 20 70 61  .  If the 3rd pa
38010 72 61 6d 65 74 65 72 20 69 73 20 6e 6f 6e 2d 6e  rameter is non-n
38020 65 67 61 74 69 76 65 2c 20 74 68 65 6e 20 69 74  egative, then it
38030 0a 2a 2a 20 6d 75 73 74 20 62 65 20 74 68 65 20  .** must be the 
38040 62 79 74 65 20 6f 66 66 73 65 74 20 69 6e 74 6f  byte offset into
38050 20 74 68 65 20 73 74 72 69 6e 67 20 77 68 65 72   the string wher
38060 65 20 74 68 65 20 4e 55 4c 20 74 65 72 6d 69 6e  e the NUL termin
38070 61 74 6f 72 20 77 6f 75 6c 64 0a 2a 2a 20 61 70  ator would.** ap
38080 70 65 61 72 20 69 66 20 74 68 65 20 73 74 72 69  pear if the stri
38090 6e 67 20 77 68 65 72 65 20 4e 55 4c 20 74 65 72  ng where NUL ter
380a0 6d 69 6e 61 74 65 64 2e 20 20 49 66 20 61 6e 79  minated.  If any
380b0 20 4e 55 4c 20 63 68 61 72 61 63 74 65 72 73 20   NUL characters 
380c0 6f 63 63 75 72 0a 2a 2a 20 69 6e 20 74 68 65 20  occur.** in the 
380d0 73 74 72 69 6e 67 20 61 74 20 61 20 62 79 74 65  string at a byte
380e0 20 6f 66 66 73 65 74 20 74 68 61 74 20 69 73 20   offset that is 
380f0 6c 65 73 73 20 74 68 61 6e 20 74 68 65 20 76 61  less than the va
38100 6c 75 65 20 6f 66 20 74 68 65 20 33 72 64 0a 2a  lue of the 3rd.*
38110 2a 20 70 61 72 61 6d 65 74 65 72 2c 20 74 68 65  * parameter, the
38120 6e 20 74 68 65 20 72 65 73 75 6c 74 69 6e 67 20  n the resulting 
38130 73 74 72 69 6e 67 20 77 69 6c 6c 20 63 6f 6e 74  string will cont
38140 61 69 6e 20 65 6d 62 65 64 64 65 64 20 4e 55 4c  ain embedded NUL
38150 73 20 61 6e 64 20 74 68 65 0a 2a 2a 20 72 65 73  s and the.** res
38160 75 6c 74 20 6f 66 20 65 78 70 72 65 73 73 69 6f  ult of expressio
38170 6e 73 20 6f 70 65 72 61 74 69 6e 67 20 6f 6e 20  ns operating on 
38180 73 74 72 69 6e 67 73 20 77 69 74 68 20 65 6d 62  strings with emb
38190 65 64 64 65 64 20 4e 55 4c 73 20 69 73 20 75 6e  edded NULs is un
381a0 64 65 66 69 6e 65 64 2e 0a 2a 2a 20 5e 49 66 20  defined..** ^If 
381b0 74 68 65 20 34 74 68 20 70 61 72 61 6d 65 74 65  the 4th paramete
381c0 72 20 74 6f 20 74 68 65 20 73 71 6c 69 74 65 33  r to the sqlite3
381d0 5f 72 65 73 75 6c 74 5f 74 65 78 74 2a 20 69 6e  _result_text* in
381e0 74 65 72 66 61 63 65 73 0a 2a 2a 20 6f 72 20 73  terfaces.** or s
381f0 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 62 6c  qlite3_result_bl
38200 6f 62 20 69 73 20 61 20 6e 6f 6e 2d 4e 55 4c 4c  ob is a non-NULL
38210 20 70 6f 69 6e 74 65 72 2c 20 74 68 65 6e 20 53   pointer, then S
38220 51 4c 69 74 65 20 63 61 6c 6c 73 20 74 68 61 74  QLite calls that
38230 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 61 73 20  .** function as 
38240 74 68 65 20 64 65 73 74 72 75 63 74 6f 72 20 6f  the destructor o
38250 6e 20 74 68 65 20 74 65 78 74 20 6f 72 20 42 4c  n the text or BL
38260 4f 42 20 72 65 73 75 6c 74 20 77 68 65 6e 20 69  OB result when i
38270 74 20 68 61 73 0a 2a 2a 20 66 69 6e 69 73 68 65  t has.** finishe
38280 64 20 75 73 69 6e 67 20 74 68 61 74 20 72 65 73  d using that res
38290 75 6c 74 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20  ult..** ^If the 
382a0 34 74 68 20 70 61 72 61 6d 65 74 65 72 20 74 6f  4th parameter to
382b0 20 74 68 65 20 73 71 6c 69 74 65 33 5f 72 65 73   the sqlite3_res
382c0 75 6c 74 5f 74 65 78 74 2a 20 69 6e 74 65 72 66  ult_text* interf
382d0 61 63 65 73 20 6f 72 20 74 6f 0a 2a 2a 20 73 71  aces or to.** sq
382e0 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 62 6c 6f  lite3_result_blo
382f0 62 20 69 73 20 74 68 65 20 73 70 65 63 69 61 6c  b is the special
38300 20 63 6f 6e 73 74 61 6e 74 20 53 51 4c 49 54 45   constant SQLITE
38310 5f 53 54 41 54 49 43 2c 20 74 68 65 6e 20 53 51  _STATIC, then SQ
38320 4c 69 74 65 0a 2a 2a 20 61 73 73 75 6d 65 73 20  Lite.** assumes 
38330 74 68 61 74 20 74 68 65 20 74 65 78 74 20 6f 72  that the text or
38340 20 42 4c 4f 42 20 72 65 73 75 6c 74 20 69 73 20   BLOB result is 
38350 69 6e 20 63 6f 6e 73 74 61 6e 74 20 73 70 61 63  in constant spac
38360 65 20 61 6e 64 20 64 6f 65 73 20 6e 6f 74 0a 2a  e and does not.*
38370 2a 20 63 6f 70 79 20 74 68 65 20 63 6f 6e 74 65  * copy the conte
38380 6e 74 20 6f 66 20 74 68 65 20 70 61 72 61 6d 65  nt of the parame
38390 74 65 72 20 6e 6f 72 20 63 61 6c 6c 20 61 20 64  ter nor call a d
383a0 65 73 74 72 75 63 74 6f 72 20 6f 6e 20 74 68 65  estructor on the
383b0 20 63 6f 6e 74 65 6e 74 0a 2a 2a 20 77 68 65 6e   content.** when
383c0 20 69 74 20 68 61 73 20 66 69 6e 69 73 68 65 64   it has finished
383d0 20 75 73 69 6e 67 20 74 68 61 74 20 72 65 73 75   using that resu
383e0 6c 74 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 34  lt..** ^If the 4
383f0 74 68 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20  th parameter to 
38400 74 68 65 20 73 71 6c 69 74 65 33 5f 72 65 73 75  the sqlite3_resu
38410 6c 74 5f 74 65 78 74 2a 20 69 6e 74 65 72 66 61  lt_text* interfa
38420 63 65 73 0a 2a 2a 20 6f 72 20 73 71 6c 69 74 65  ces.** or sqlite
38430 33 5f 72 65 73 75 6c 74 5f 62 6c 6f 62 20 69 73  3_result_blob is
38440 20 74 68 65 20 73 70 65 63 69 61 6c 20 63 6f 6e   the special con
38450 73 74 61 6e 74 20 53 51 4c 49 54 45 5f 54 52 41  stant SQLITE_TRA
38460 4e 53 49 45 4e 54 0a 2a 2a 20 74 68 65 6e 20 53  NSIENT.** then S
38470 51 4c 69 74 65 20 6d 61 6b 65 73 20 61 20 63 6f  QLite makes a co
38480 70 79 20 6f 66 20 74 68 65 20 72 65 73 75 6c 74  py of the result
38490 20 69 6e 74 6f 20 73 70 61 63 65 20 6f 62 74 61   into space obta
384a0 69 6e 65 64 20 66 72 6f 6d 0a 2a 2a 20 66 72 6f  ined from.** fro
384b0 6d 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f  m [sqlite3_mallo
384c0 63 28 29 5d 20 62 65 66 6f 72 65 20 69 74 20 72  c()] before it r
384d0 65 74 75 72 6e 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54  eturns..**.** ^T
384e0 68 65 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c  he sqlite3_resul
384f0 74 5f 76 61 6c 75 65 28 29 20 69 6e 74 65 72 66  t_value() interf
38500 61 63 65 20 73 65 74 73 20 74 68 65 20 72 65 73  ace sets the res
38510 75 6c 74 20 6f 66 0a 2a 2a 20 74 68 65 20 61 70  ult of.** the ap
38520 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65  plication-define
38530 64 20 66 75 6e 63 74 69 6f 6e 20 74 6f 20 62 65  d function to be
38540 20 61 20 63 6f 70 79 20 6f 66 20 74 68 65 0a 2a   a copy of the.*
38550 2a 20 5b 75 6e 70 72 6f 74 65 63 74 65 64 20 73  * [unprotected s
38560 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62  qlite3_value] ob
38570 6a 65 63 74 20 73 70 65 63 69 66 69 65 64 20 62  ject specified b
38580 79 20 74 68 65 20 32 6e 64 20 70 61 72 61 6d 65  y the 2nd parame
38590 74 65 72 2e 20 20 5e 54 68 65 0a 2a 2a 20 73 71  ter.  ^The.** sq
385a0 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 76 61 6c  lite3_result_val
385b0 75 65 28 29 20 69 6e 74 65 72 66 61 63 65 20 6d  ue() interface m
385c0 61 6b 65 73 20 61 20 63 6f 70 79 20 6f 66 20 74  akes a copy of t
385d0 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75  he [sqlite3_valu
385e0 65 5d 0a 2a 2a 20 73 6f 20 74 68 61 74 20 74 68  e].** so that th
385f0 65 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  e [sqlite3_value
38600 5d 20 73 70 65 63 69 66 69 65 64 20 69 6e 20 74  ] specified in t
38610 68 65 20 70 61 72 61 6d 65 74 65 72 20 6d 61 79  he parameter may
38620 20 63 68 61 6e 67 65 20 6f 72 0a 2a 2a 20 62 65   change or.** be
38630 20 64 65 61 6c 6c 6f 63 61 74 65 64 20 61 66 74   deallocated aft
38640 65 72 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c  er sqlite3_resul
38650 74 5f 76 61 6c 75 65 28 29 20 72 65 74 75 72 6e  t_value() return
38660 73 20 77 69 74 68 6f 75 74 20 68 61 72 6d 2e 0a  s without harm..
38670 2a 2a 20 5e 41 20 5b 70 72 6f 74 65 63 74 65 64  ** ^A [protected
38680 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20   sqlite3_value] 
38690 6f 62 6a 65 63 74 20 6d 61 79 20 61 6c 77 61 79  object may alway
386a0 73 20 62 65 20 75 73 65 64 20 77 68 65 72 65 20  s be used where 
386b0 61 6e 0a 2a 2a 20 5b 75 6e 70 72 6f 74 65 63 74  an.** [unprotect
386c0 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  ed sqlite3_value
386d0 5d 20 6f 62 6a 65 63 74 20 69 73 20 72 65 71 75  ] object is requ
386e0 69 72 65 64 2c 20 73 6f 20 65 69 74 68 65 72 0a  ired, so either.
386f0 2a 2a 20 6b 69 6e 64 20 6f 66 20 5b 73 71 6c 69  ** kind of [sqli
38700 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62 6a 65 63  te3_value] objec
38710 74 20 63 61 6e 20 62 65 20 75 73 65 64 20 77 69  t can be used wi
38720 74 68 20 74 68 69 73 20 69 6e 74 65 72 66 61 63  th this interfac
38730 65 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 74 68 65 73  e..**.** If thes
38740 65 20 72 6f 75 74 69 6e 65 73 20 61 72 65 20 63  e routines are c
38750 61 6c 6c 65 64 20 66 72 6f 6d 20 77 69 74 68 69  alled from withi
38760 6e 20 74 68 65 20 64 69 66 66 65 72 65 6e 74 20  n the different 
38770 74 68 72 65 61 64 0a 2a 2a 20 74 68 61 6e 20 74  thread.** than t
38780 68 65 20 6f 6e 65 20 63 6f 6e 74 61 69 6e 69 6e  he one containin
38790 67 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f  g the applicatio
387a0 6e 2d 64 65 66 69 6e 65 64 20 66 75 6e 63 74 69  n-defined functi
387b0 6f 6e 20 74 68 61 74 20 72 65 63 65 69 76 65 64  on that received
387c0 0a 2a 2a 20 74 68 65 20 5b 73 71 6c 69 74 65 33  .** the [sqlite3
387d0 5f 63 6f 6e 74 65 78 74 5d 20 70 6f 69 6e 74 65  _context] pointe
387e0 72 2c 20 74 68 65 20 72 65 73 75 6c 74 73 20 61  r, the results a
387f0 72 65 20 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2f  re undefined..*/
38800 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 5f 72 65  .void sqlite3_re
38810 73 75 6c 74 5f 62 6c 6f 62 28 73 71 6c 69 74 65  sult_blob(sqlite
38820 33 5f 63 6f 6e 74 65 78 74 2a 2c 20 63 6f 6e 73  3_context*, cons
38830 74 20 76 6f 69 64 2a 2c 20 69 6e 74 2c 20 76 6f  t void*, int, vo
38840 69 64 28 2a 29 28 76 6f 69 64 2a 29 29 3b 0a 76  id(*)(void*));.v
38850 6f 69 64 20 73 71 6c 69 74 6