Documentation Source Text

Hex Artifact Content
Login

Artifact aaff52eb28edcbfaf97817f50404bd22671a3397:


0000: 3c 74 69 74 6c 65 3e 43 6f 6d 70 69 6c 61 74 69  <title>Compilati
0010: 6f 6e 20 4f 70 74 69 6f 6e 73 20 46 6f 72 20 53  on Options For S
0020: 51 4c 69 74 65 3c 2f 74 69 74 6c 65 3e 0a 3c 74  QLite</title>.<t
0030: 63 6c 3e 68 64 5f 6b 65 79 77 6f 72 64 73 20 7b  cl>hd_keywords {
0040: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
0050: 69 6f 6e 73 7d 3c 2f 74 63 6c 3e 0a 0a 3c 68 31  ions}</tcl>..<h1
0060: 3e 31 2e 30 20 43 6f 6d 70 69 6c 61 74 69 6f 6e  >1.0 Compilation
0070: 20 4f 70 74 69 6f 6e 73 20 46 6f 72 20 53 51 4c   Options For SQL
0080: 69 74 65 3c 2f 68 31 3e 0a 0a 3c 70 3e 0a 46 6f  ite</h1>..<p>.Fo
0090: 72 20 6d 6f 73 74 20 70 75 72 70 6f 73 65 73 2c  r most purposes,
00a0: 20 53 51 4c 69 74 65 20 63 61 6e 20 62 65 20 62   SQLite can be b
00b0: 75 69 6c 74 20 6a 75 73 74 20 66 69 6e 65 20 75  uilt just fine u
00c0: 73 69 6e 67 20 74 68 65 20 64 65 66 61 75 6c 74  sing the default
00d0: 0a 63 6f 6d 70 69 6c 61 74 69 6f 6e 20 6f 70 74  .compilation opt
00e0: 69 6f 6e 73 2e 20 48 6f 77 65 76 65 72 2c 20 69  ions. However, i
00f0: 66 20 72 65 71 75 69 72 65 64 2c 20 74 68 65 20  f required, the 
0100: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
0110: 69 6f 6e 73 0a 64 6f 63 75 6d 65 6e 74 65 64 20  ions.documented 
0120: 62 65 6c 6f 77 20 63 61 6e 20 62 65 20 75 73 65  below can be use
0130: 64 20 74 6f 20 0a 3c 61 20 68 72 65 66 3d 22 23  d to .<a href="#
0140: 6f 6d 69 74 66 65 61 74 75 72 65 73 22 3e 6f 6d  omitfeatures">om
0150: 69 74 20 53 51 4c 69 74 65 20 66 65 61 74 75 72  it SQLite featur
0160: 65 73 3c 2f 61 3e 20 28 72 65 73 75 6c 74 69 6e  es</a> (resultin
0170: 67 20 69 6e 0a 61 20 5b 72 65 6c 66 6f 6f 74 70  g in.a [relfootp
0180: 72 69 6e 74 20 7c 20 73 6d 61 6c 6c 65 72 20 63  rint | smaller c
0190: 6f 6d 70 69 6c 65 64 20 6c 69 62 72 61 72 79 20  ompiled library 
01a0: 73 69 7a 65 5d 29 20 6f 72 20 74 6f 20 63 68 61  size]) or to cha
01b0: 6e 67 65 20 74 68 65 0a 3c 61 20 68 72 65 66 3d  nge the.<a href=
01c0: 22 23 64 65 66 61 75 6c 74 73 22 3e 64 65 66 61  "#defaults">defa
01d0: 75 6c 74 20 76 61 6c 75 65 73 3c 2f 61 3e 20 6f  ult values</a> o
01e0: 66 20 73 6f 6d 65 20 70 61 72 61 6d 65 74 65 72  f some parameter
01f0: 73 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 45 76 65  s..</p>..<p>.Eve
0200: 72 79 20 65 66 66 6f 72 74 20 68 61 73 20 62 65  ry effort has be
0210: 65 6e 20 6d 61 64 65 20 74 6f 20 65 6e 73 75 72  en made to ensur
0220: 65 20 74 68 61 74 20 74 68 65 20 76 61 72 69 6f  e that the vario
0230: 75 73 20 63 6f 6d 62 69 6e 61 74 69 6f 6e 73 0a  us combinations.
0240: 6f 66 20 63 6f 6d 70 69 6c 61 74 69 6f 6e 20 6f  of compilation o
0250: 70 74 69 6f 6e 73 20 77 6f 72 6b 20 68 61 72 6d  ptions work harm
0260: 6f 6e 69 6f 75 73 6c 79 20 61 6e 64 20 70 72 6f  oniously and pro
0270: 64 75 63 65 20 61 20 77 6f 72 6b 69 6e 67 20 6c  duce a working l
0280: 69 62 72 61 72 79 2e 0a 4e 65 76 65 72 74 68 65  ibrary..Neverthe
0290: 6c 65 73 73 2c 20 69 74 20 69 73 20 73 74 72 6f  less, it is stro
02a0: 6e 67 6c 79 20 72 65 63 6f 6d 6d 65 6e 64 65 64  ngly recommended
02b0: 20 74 68 61 74 20 74 68 65 20 53 51 4c 69 74 65   that the SQLite
02c0: 20 74 65 73 74 2d 73 75 69 74 65 0a 62 65 20 65   test-suite.be e
02d0: 78 65 63 75 74 65 64 20 74 6f 20 63 68 65 63 6b  xecuted to check
02e0: 20 66 6f 72 20 65 72 72 6f 72 73 20 62 65 66 6f   for errors befo
02f0: 72 65 20 75 73 69 6e 67 20 61 6e 20 53 51 4c 69  re using an SQLi
0300: 74 65 20 6c 69 62 72 61 72 79 20 62 75 69 6c 74  te library built
0310: 0a 77 69 74 68 20 6e 6f 6e 2d 73 74 61 6e 64 61  .with non-standa
0320: 72 64 20 63 6f 6d 70 69 6c 61 74 69 6f 6e 20 6f  rd compilation o
0330: 70 74 69 6f 6e 73 2e 0a 3c 2f 70 3e 0a 0a 3c 74  ptions..</p>..<t
0340: 63 6c 3e 0a 70 72 6f 63 20 43 4f 4d 50 49 4c 45  cl>.proc COMPILE
0350: 5f 4f 50 54 49 4f 4e 20 7b 6e 61 6d 65 20 74 65  _OPTION {name te
0360: 78 74 7d 20 7b 0a 20 20 69 66 20 7b 5b 72 65 67  xt} {.  if {[reg
0370: 65 78 70 20 7b 28 53 51 4c 49 54 45 7c 48 41 56  exp {(SQLITE|HAV
0380: 45 29 5f 28 5b 41 2d 5a 30 2d 39 5f 5d 2b 29 7d  E)_([A-Z0-9_]+)}
0390: 20 24 6e 61 6d 65 20 61 6c 6c 20 70 72 65 66 69   $name all prefi
03a0: 78 20 6c 61 62 65 6c 5d 7d 20 7b 0a 20 20 20 20  x label]} {.    
03b0: 68 64 5f 66 72 61 67 6d 65 6e 74 20 5b 73 74 72  hd_fragment [str
03c0: 69 6e 67 20 74 6f 6c 6f 77 65 72 20 24 6c 61 62  ing tolower $lab
03d0: 65 6c 5d 0a 20 20 20 20 68 64 5f 6b 65 79 77 6f  el].    hd_keywo
03e0: 72 64 73 20 24 61 6c 6c 0a 20 20 7d 0a 20 20 69  rds $all.  }.  i
03f0: 66 20 7b 5b 72 65 67 65 78 70 20 7b 5e 59 59 28  f {[regexp {^YY(
0400: 5b 41 2d 5a 30 2d 39 5f 5d 2b 29 7d 20 24 6e 61  [A-Z0-9_]+)} $na
0410: 6d 65 20 61 6c 6c 20 6c 61 62 65 6c 5d 7d 20 7b  me all label]} {
0420: 0a 20 20 20 20 68 64 5f 66 72 61 67 6d 65 6e 74  .    hd_fragment
0430: 20 5b 73 74 72 69 6e 67 20 74 6f 6c 6f 77 65 72   [string tolower
0440: 20 24 61 6c 6c 5d 0a 20 20 20 20 68 64 5f 6b 65   $all].    hd_ke
0450: 79 77 6f 72 64 73 20 24 61 6c 6c 0a 20 20 7d 0a  ywords $all.  }.
0460: 20 20 68 64 5f 70 75 74 73 20 3c 70 3e 3c 62 3e    hd_puts <p><b>
0470: 24 6e 61 6d 65 3c 2f 62 3e 3c 2f 70 3e 0a 20 20  $name</b></p>.  
0480: 72 65 67 73 75 62 20 2d 61 6c 6c 20 22 5c 6e 5c  regsub -all "\n\
0490: 5c 73 2a 5c 6e 22 20 24 74 65 78 74 20 22 3c 2f  \s*\n" $text "</
04a0: 70 3e 5c 6e 5c 6e 3c 70 3e 22 20 74 65 78 74 0a  p>\n\n<p>" text.
04b0: 20 20 68 64 5f 72 65 73 6f 6c 76 65 20 3c 62 6c    hd_resolve <bl
04c0: 6f 63 6b 71 75 6f 74 65 3e 3c 70 3e 24 74 65 78  ockquote><p>$tex
04d0: 74 3c 2f 70 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74  t</p></blockquot
04e0: 65 3e 0a 7d 0a 3c 2f 74 63 6c 3e 0a 0a 3c 61 20  e>.}.</tcl>..<a 
04f0: 6e 61 6d 65 3d 22 6f 73 63 6f 6e 66 69 67 22 3e  name="osconfig">
0500: 3c 2f 61 3e 0a 3c 68 32 3e 31 2e 31 20 50 6c 61  </a>.<h2>1.1 Pla
0510: 74 66 6f 72 6d 20 43 6f 6e 66 69 67 75 72 61 74  tform Configurat
0520: 69 6f 6e 3c 2f 68 32 3e 0a 0a 3c 74 63 6c 3e 0a  ion</h2>..<tcl>.
0530: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b  COMPILE_OPTION {
0540: 5f 48 41 56 45 5f 53 51 4c 49 54 45 5f 43 4f 4e  _HAVE_SQLITE_CON
0550: 46 49 47 5f 48 7d 20 7b 0a 20 20 49 66 20 74 68  FIG_H} {.  If th
0560: 65 20 5f 48 41 56 45 5f 53 51 4c 49 54 45 5f 43  e _HAVE_SQLITE_C
0570: 4f 4e 46 49 47 5f 48 20 6d 61 63 72 6f 20 69 73  ONFIG_H macro is
0580: 20 64 65 66 69 6e 65 64 0a 20 20 74 68 65 6e 20   defined.  then 
0590: 74 68 65 20 53 51 4c 69 74 65 20 73 6f 75 72 63  the SQLite sourc
05a0: 65 20 63 6f 64 65 20 77 69 6c 6c 20 61 74 74 65  e code will atte
05b0: 6d 70 74 20 74 6f 20 23 69 6e 63 6c 75 64 65 20  mpt to #include 
05c0: 61 20 66 69 6c 65 20 6e 61 6d 65 64 20 22 63 6f  a file named "co
05d0: 6e 66 69 67 2e 68 22 2e 0a 20 20 54 68 65 20 22  nfig.h"..  The "
05e0: 63 6f 6e 66 69 67 2e 68 22 20 66 69 6c 65 20 75  config.h" file u
05f0: 73 75 61 6c 6c 79 20 63 6f 6e 74 61 69 6e 73 20  sually contains 
0600: 6f 74 68 65 72 20 63 6f 6e 66 69 67 75 72 61 74  other configurat
0610: 69 6f 6e 20 6f 70 74 69 6f 6e 73 2c 20 65 73 70  ion options, esp
0620: 65 63 69 61 6c 6c 79 0a 20 20 22 48 41 56 45 5f  ecially.  "HAVE_
0630: 3c 69 3e 49 4e 54 45 52 46 41 43 45 3c 2f 69 3e  <i>INTERFACE</i>
0640: 22 20 74 79 70 65 20 6f 70 74 69 6f 6e 73 20 67  " type options g
0650: 65 6e 65 72 61 74 65 64 20 62 79 20 61 75 74 6f  enerated by auto
0660: 63 6f 6e 66 20 73 63 72 69 70 74 73 2e 0a 7d 0a  conf scripts..}.
0670: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20  .COMPILE_OPTION 
0680: 7b 48 41 56 45 5f 46 44 41 54 41 53 59 4e 43 7d  {HAVE_FDATASYNC}
0690: 20 7b 0a 20 20 49 66 20 74 68 65 20 48 41 56 45   {.  If the HAVE
06a0: 5f 46 44 41 54 41 53 59 4e 43 20 63 6f 6d 70 69  _FDATASYNC compi
06b0: 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20 69  le-time option i
06c0: 73 20 74 72 75 65 2c 20 74 68 65 6e 20 74 68 65  s true, then the
06d0: 20 64 65 66 61 75 6c 74 20 5b 56 46 53 5d 0a 20   default [VFS]. 
06e0: 20 66 6f 72 20 75 6e 69 78 20 73 79 73 74 65 6d   for unix system
06f0: 73 20 77 69 6c 6c 20 61 74 74 65 6d 70 74 20 74  s will attempt t
0700: 6f 20 75 73 65 20 66 64 61 74 61 73 79 6e 63 28  o use fdatasync(
0710: 29 20 69 6e 73 74 65 61 64 20 6f 66 20 66 73 79  ) instead of fsy
0720: 6e 63 28 29 20 77 68 65 72 65 0a 20 20 61 70 70  nc() where.  app
0730: 72 6f 70 72 69 61 74 65 2e 20 20 49 66 20 74 68  ropriate.  If th
0740: 69 73 20 66 6c 61 67 20 69 73 20 6d 69 73 73 69  is flag is missi
0750: 6e 67 20 6f 72 20 66 61 6c 73 65 2c 20 74 68 65  ng or false, the
0760: 6e 20 66 73 79 6e 63 28 29 20 69 73 20 61 6c 77  n fsync() is alw
0770: 61 79 73 20 75 73 65 64 2e 0a 7d 0a 0a 43 4f 4d  ays used..}..COM
0780: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 48 41 56  PILE_OPTION {HAV
0790: 45 5f 47 4d 54 49 4d 45 5f 52 7d 20 7b 0a 20 20  E_GMTIME_R} {.  
07a0: 49 66 20 74 68 65 20 48 41 56 45 5f 47 4d 54 49  If the HAVE_GMTI
07b0: 4d 45 5f 52 20 6f 70 74 69 6f 6e 20 69 73 20 74  ME_R option is t
07c0: 72 75 65 20 61 6e 64 20 69 66 20 5b 53 51 4c 49  rue and if [SQLI
07d0: 54 45 5f 4f 4d 49 54 5f 44 41 54 45 54 49 4d 45  TE_OMIT_DATETIME
07e0: 5f 46 55 4e 43 53 5d 20 69 73 20 74 72 75 65 2c  _FUNCS] is true,
07f0: 0a 20 20 74 68 65 6e 20 74 68 65 20 43 55 52 52  .  then the CURR
0800: 45 4e 54 5f 54 49 4d 45 2c 20 43 55 52 52 45 4e  ENT_TIME, CURREN
0810: 54 5f 44 41 54 45 2c 20 61 6e 64 20 43 55 52 52  T_DATE, and CURR
0820: 45 4e 54 5f 54 49 4d 45 53 54 41 4d 50 20 6b 65  ENT_TIMESTAMP ke
0830: 79 77 6f 72 64 73 20 77 69 6c 6c 20 75 73 65 0a  ywords will use.
0840: 20 20 74 68 65 20 74 68 72 65 61 64 73 61 66 65    the threadsafe
0850: 20 22 67 6d 74 69 6d 65 5f 72 28 29 22 20 69 6e   "gmtime_r()" in
0860: 74 65 72 66 61 63 65 20 72 61 74 68 65 72 20 74  terface rather t
0870: 68 61 6e 20 22 67 6d 74 69 6d 65 28 29 22 2e 20  han "gmtime()". 
0880: 20 49 6e 20 74 68 65 20 75 73 75 61 6c 20 63 61   In the usual ca
0890: 73 65 0a 20 20 77 68 65 72 65 20 5b 53 51 4c 49  se.  where [SQLI
08a0: 54 45 5f 4f 4d 49 54 5f 44 41 54 45 54 49 4d 45  TE_OMIT_DATETIME
08b0: 5f 46 55 4e 43 53 5d 20 69 73 20 6e 6f 74 20 64  _FUNCS] is not d
08c0: 65 66 69 6e 65 64 20 6f 72 20 69 73 20 66 61 6c  efined or is fal
08d0: 73 65 2c 20 74 68 65 6e 20 74 68 65 0a 20 20 62  se, then the.  b
08e0: 75 69 6c 74 2d 69 6e 20 5b 64 61 74 65 20 61 6e  uilt-in [date an
08f0: 64 20 74 69 6d 65 20 66 75 6e 63 74 69 6f 6e 73  d time functions
0900: 5d 20 61 72 65 20 75 73 65 64 20 74 6f 20 69 6d  ] are used to im
0910: 70 6c 65 6d 65 6e 74 20 74 68 65 20 43 55 52 52  plement the CURR
0920: 45 4e 54 5f 54 49 4d 45 2c 0a 20 20 43 55 52 52  ENT_TIME,.  CURR
0930: 45 4e 54 5f 44 41 54 45 2c 20 61 6e 64 20 43 55  ENT_DATE, and CU
0940: 52 52 45 4e 54 5f 54 49 4d 45 53 54 41 4d 50 20  RRENT_TIMESTAMP 
0950: 6b 65 79 77 6f 72 64 73 20 61 6e 64 20 6e 65 69  keywords and nei
0960: 74 68 65 72 20 67 6d 74 69 6d 65 5f 72 28 29 20  ther gmtime_r() 
0970: 6e 6f 72 0a 20 20 67 6d 74 69 6d 65 28 29 20 69  nor.  gmtime() i
0980: 73 20 65 76 65 72 20 63 61 6c 6c 65 64 2e 0a 7d  s ever called..}
0990: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e  ..COMPILE_OPTION
09a0: 20 7b 48 41 56 45 5f 49 53 4e 41 4e 7d 20 7b 0a   {HAVE_ISNAN} {.
09b0: 20 20 49 66 20 74 68 65 20 48 41 56 45 5f 49 53    If the HAVE_IS
09c0: 4e 41 4e 20 6f 70 74 69 6f 6e 20 69 73 20 74 72  NAN option is tr
09d0: 75 65 2c 20 74 68 65 6e 20 53 51 4c 69 74 65 20  ue, then SQLite 
09e0: 69 6e 76 6f 6b 65 73 20 74 68 65 20 73 79 73 74  invokes the syst
09f0: 65 6d 20 6c 69 62 72 61 72 79 20 69 73 6e 61 6e  em library isnan
0a00: 28 29 0a 20 20 66 75 6e 63 74 69 6f 6e 20 74 6f  ().  function to
0a10: 20 64 65 74 65 72 6d 69 6e 65 20 69 66 20 61 20   determine if a 
0a20: 64 6f 75 62 6c 65 2d 70 72 65 63 69 73 69 6f 6e  double-precision
0a30: 20 66 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 20   floating point 
0a40: 76 61 6c 75 65 20 69 73 20 61 20 4e 61 4e 2e 0a  value is a NaN..
0a50: 20 20 49 66 20 48 41 56 45 5f 49 53 4e 41 4e 20    If HAVE_ISNAN 
0a60: 69 73 20 75 6e 64 65 66 69 6e 65 64 20 6f 72 20  is undefined or 
0a70: 66 61 6c 73 65 2c 20 74 68 65 6e 20 53 51 4c 69  false, then SQLi
0a80: 74 65 20 73 75 62 73 74 69 74 75 74 65 73 20 69  te substitutes i
0a90: 74 73 20 6f 77 6e 20 68 6f 6d 65 2d 67 72 6f 77  ts own home-grow
0aa0: 6e 0a 20 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  n.  implementati
0ab0: 6f 6e 20 6f 66 20 69 73 6e 61 6e 28 29 2e 0a 7d  on of isnan()..}
0ac0: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e  ..COMPILE_OPTION
0ad0: 20 7b 48 41 56 45 5f 4c 4f 43 41 4c 54 49 4d 45   {HAVE_LOCALTIME
0ae0: 5f 52 7d 20 7b 0a 20 20 49 66 20 74 68 65 20 48  _R} {.  If the H
0af0: 41 56 45 5f 4c 4f 43 41 4c 54 49 4d 45 5f 52 20  AVE_LOCALTIME_R 
0b00: 6f 70 74 69 6f 6e 20 69 73 20 74 72 75 65 2c 20  option is true, 
0b10: 74 68 65 6e 20 53 51 4c 69 74 65 20 75 73 65 73  then SQLite uses
0b20: 20 74 68 65 20 74 68 72 65 61 64 73 61 66 65 0a   the threadsafe.
0b30: 20 20 6c 6f 63 61 6c 74 69 6d 65 5f 72 28 29 20    localtime_r() 
0b40: 6c 69 62 72 61 72 79 20 72 6f 75 74 69 6e 65 20  library routine 
0b50: 69 6e 73 74 65 61 64 20 6f 66 20 6c 6f 63 61 6c  instead of local
0b60: 74 69 6d 65 28 29 0a 20 20 74 6f 20 68 65 6c 70  time().  to help
0b70: 20 69 6d 70 6c 65 6d 65 6e 74 20 74 68 65 20 5b   implement the [
0b80: 6c 6f 63 61 6c 74 69 6d 65 20 6d 6f 64 69 66 69  localtime modifi
0b90: 65 72 5d 0a 20 20 74 6f 20 74 68 65 20 62 75 69  er].  to the bui
0ba0: 6c 74 2d 69 6e 20 5b 64 61 74 65 20 61 6e 64 20  lt-in [date and 
0bb0: 74 69 6d 65 20 66 75 6e 63 74 69 6f 6e 73 5d 2e  time functions].
0bc0: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49  .}..COMPILE_OPTI
0bd0: 4f 4e 20 7b 48 41 56 45 5f 4c 4f 43 41 4c 54 49  ON {HAVE_LOCALTI
0be0: 4d 45 5f 53 7d 20 7b 0a 20 20 49 66 20 74 68 65  ME_S} {.  If the
0bf0: 20 48 41 56 45 5f 4c 4f 43 41 4c 54 49 4d 45 5f   HAVE_LOCALTIME_
0c00: 53 20 6f 70 74 69 6f 6e 20 69 73 20 74 72 75 65  S option is true
0c10: 2c 20 74 68 65 6e 20 53 51 4c 69 74 65 20 75 73  , then SQLite us
0c20: 65 73 20 74 68 65 20 74 68 72 65 61 64 73 61 66  es the threadsaf
0c30: 65 0a 20 20 6c 6f 63 61 6c 74 69 6d 65 5f 73 28  e.  localtime_s(
0c40: 29 20 6c 69 62 72 61 72 79 20 72 6f 75 74 69 6e  ) library routin
0c50: 65 20 69 6e 73 74 65 61 64 20 6f 66 20 6c 6f 63  e instead of loc
0c60: 61 6c 74 69 6d 65 28 29 0a 20 20 74 6f 20 68 65  altime().  to he
0c70: 6c 70 20 69 6d 70 6c 65 6d 65 6e 74 20 74 68 65  lp implement the
0c80: 20 5b 6c 6f 63 61 6c 74 69 6d 65 20 6d 6f 64 69   [localtime modi
0c90: 66 69 65 72 5d 0a 20 20 74 6f 20 74 68 65 20 62  fier].  to the b
0ca0: 75 69 6c 74 2d 69 6e 20 5b 64 61 74 65 20 61 6e  uilt-in [date an
0cb0: 64 20 74 69 6d 65 20 66 75 6e 63 74 69 6f 6e 73  d time functions
0cc0: 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50  ]..}..COMPILE_OP
0cd0: 54 49 4f 4e 20 7b 48 41 56 45 5f 4d 41 4c 4c 4f  TION {HAVE_MALLO
0ce0: 43 5f 55 53 41 42 4c 45 5f 53 49 5a 45 7d 20 7b  C_USABLE_SIZE} {
0cf0: 0a 20 20 49 66 20 74 68 65 20 48 41 56 45 5f 4d  .  If the HAVE_M
0d00: 41 4c 4c 4f 43 5f 55 53 41 42 4c 45 5f 53 49 5a  ALLOC_USABLE_SIZ
0d10: 45 20 6f 70 74 69 6f 6e 20 69 73 20 74 72 75 65  E option is true
0d20: 2c 20 74 68 65 6e 20 53 51 4c 69 74 65 20 74 72  , then SQLite tr
0d30: 69 65 73 20 75 73 65 73 20 74 68 65 0a 20 20 6d  ies uses the.  m
0d40: 61 6c 6c 6f 63 5f 75 73 61 62 6c 65 5f 73 69 7a  alloc_usable_siz
0d50: 65 28 29 20 69 6e 74 65 72 66 61 63 65 20 74 6f  e() interface to
0d60: 20 66 69 6e 64 20 74 68 65 20 73 69 7a 65 20 6f   find the size o
0d70: 66 20 61 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  f a memory alloc
0d80: 61 74 69 6f 6e 20 6f 62 74 61 69 6e 65 64 0a 20  ation obtained. 
0d90: 20 66 72 6f 6d 20 74 68 65 20 73 74 61 6e 64 61   from the standa
0da0: 72 64 2d 6c 69 62 72 61 72 79 20 6d 61 6c 6c 6f  rd-library mallo
0db0: 63 28 29 20 6f 72 20 72 65 61 6c 6c 6f 63 28 29  c() or realloc()
0dc0: 20 72 6f 75 74 69 6e 65 73 2e 20 20 54 68 69 73   routines.  This
0dd0: 20 6f 70 74 69 6f 6e 20 69 73 20 6f 6e 6c 79 0a   option is only.
0de0: 20 20 61 70 70 6c 69 63 61 62 6c 65 20 69 66 20    applicable if 
0df0: 74 68 65 20 73 74 61 6e 64 61 72 64 2d 6c 69 62  the standard-lib
0e00: 72 61 72 79 20 6d 61 6c 6c 6f 63 28 29 20 69 73  rary malloc() is
0e10: 20 75 73 65 64 2e 20 20 4f 6e 20 41 70 70 6c 79   used.  On Apply
0e20: 20 73 79 73 74 65 6d 73 2c 0a 20 20 22 7a 6f 6e   systems,.  "zon
0e30: 65 20 6d 61 6c 6c 6f 63 22 20 69 73 20 75 73 65  e malloc" is use
0e40: 64 20 69 6e 73 74 65 61 64 2c 20 61 6e 64 20 73  d instead, and s
0e50: 6f 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73  o this option is
0e60: 20 6e 6f 74 20 61 70 70 6c 69 63 61 62 6c 65 2e   not applicable.
0e70: 20 20 41 6e 64 2c 20 6f 66 0a 20 20 63 6f 75 72    And, of.  cour
0e80: 73 65 2c 20 69 66 20 74 68 65 20 61 70 70 6c 69  se, if the appli
0e90: 63 61 74 69 6f 6e 20 73 75 70 70 6c 69 65 73 20  cation supplies 
0ea0: 69 74 73 20 6f 77 6e 20 6d 61 6c 6c 6f 63 20 69  its own malloc i
0eb0: 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 75 73  mplementation us
0ec0: 69 6e 67 0a 20 20 5b 53 51 4c 49 54 45 5f 43 4f  ing.  [SQLITE_CO
0ed0: 4e 46 49 47 5f 4d 41 4c 4c 4f 43 5d 20 74 68 65  NFIG_MALLOC] the
0ee0: 6e 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 68 61  n this option ha
0ef0: 73 20 6e 6f 20 65 66 66 65 63 74 2e 0a 20 20 3c  s no effect..  <
0f00: 70 3e 0a 20 20 49 66 20 74 68 65 20 48 41 56 45  p>.  If the HAVE
0f10: 5f 4d 41 4c 4c 4f 43 5f 55 53 41 42 4c 45 5f 53  _MALLOC_USABLE_S
0f20: 49 5a 45 20 6f 70 74 69 6f 6e 20 69 73 20 6f 6d  IZE option is om
0f30: 69 74 74 65 64 20 6f 72 20 69 73 20 66 61 6c 73  itted or is fals
0f40: 65 2c 20 74 68 65 6e 20 53 51 4c 69 74 65 20 0a  e, then SQLite .
0f50: 20 20 75 73 65 73 20 61 20 77 72 61 70 70 65 72    uses a wrapper
0f60: 20 61 72 6f 75 6e 64 20 73 79 73 74 65 6d 20 6d   around system m
0f70: 61 6c 6c 6f 63 28 29 20 61 6e 64 20 72 65 61 6c  alloc() and real
0f80: 6c 6f 63 28 29 20 74 68 61 74 20 65 6e 6c 61 72  loc() that enlar
0f90: 67 65 73 20 65 61 63 68 20 61 6c 6c 6f 63 61 74  ges each allocat
0fa0: 69 6f 6e 0a 20 20 62 79 20 38 20 62 79 74 65 73  ion.  by 8 bytes
0fb0: 20 61 6e 64 20 77 72 69 74 65 73 20 74 68 65 20   and writes the 
0fc0: 73 69 7a 65 20 6f 66 20 74 68 65 20 61 6c 6c 6f  size of the allo
0fd0: 63 61 74 69 6f 6e 20 69 6e 20 74 68 65 20 69 6e  cation in the in
0fe0: 69 74 69 61 6c 20 38 20 62 79 74 65 73 2c 20 61  itial 8 bytes, a
0ff0: 6e 64 0a 20 20 74 68 65 6e 20 53 51 4c 69 74 65  nd.  then SQLite
1000: 20 61 6c 73 6f 20 69 6d 70 6c 65 6d 65 6e 74 73   also implements
1010: 20 69 74 73 20 6f 77 6e 20 68 6f 6d 65 2d 67 72   its own home-gr
1020: 6f 77 6e 20 76 65 72 73 69 6f 6e 20 6f 66 20 6d  own version of m
1030: 61 6c 6c 6f 63 5f 75 73 61 62 6c 65 5f 73 69 7a  alloc_usable_siz
1040: 65 28 29 0a 20 20 74 68 61 74 20 63 6f 6e 73 75  e().  that consu
1050: 6c 74 73 20 74 68 61 74 20 38 2d 62 79 74 65 20  lts that 8-byte 
1060: 70 72 65 66 69 78 20 74 6f 20 66 69 6e 64 20 74  prefix to find t
1070: 68 65 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 73 69  he allocation si
1080: 7a 65 2e 20 20 54 68 69 73 20 61 70 70 72 6f 61  ze.  This approa
1090: 63 68 0a 20 20 77 6f 72 6b 73 20 62 75 74 20 69  ch.  works but i
10a0: 74 20 69 73 20 73 75 62 6f 70 74 69 6d 61 6c 2e  t is suboptimal.
10b0: 20 20 41 70 70 6c 69 63 61 74 69 6f 6e 73 20 61    Applications a
10c0: 72 65 20 65 6e 63 6f 75 72 61 67 65 64 20 74 6f  re encouraged to
10d0: 20 75 73 65 0a 20 20 48 41 56 45 5f 4d 41 4c 4c   use.  HAVE_MALL
10e0: 4f 43 5f 55 53 41 42 4c 45 5f 53 49 5a 45 20 77  OC_USABLE_SIZE w
10f0: 68 65 6e 65 76 65 72 20 70 6f 73 73 69 62 6c 65  henever possible
1100: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54  ..}..COMPILE_OPT
1110: 49 4f 4e 20 7b 48 41 56 45 5f 53 54 52 43 48 52  ION {HAVE_STRCHR
1120: 4e 55 4c 7d 20 7b 0a 20 20 49 66 20 74 68 65 20  NUL} {.  If the 
1130: 48 41 56 45 5f 53 54 52 43 48 52 4e 55 4c 20 6f  HAVE_STRCHRNUL o
1140: 70 74 69 6f 6e 20 69 73 20 74 72 75 65 2c 20 74  ption is true, t
1150: 68 65 6e 20 53 51 4c 69 74 65 20 75 73 65 73 20  hen SQLite uses 
1160: 74 68 65 20 73 74 72 63 68 72 6e 75 6c 28 29 20  the strchrnul() 
1170: 6c 69 62 72 61 72 79 0a 20 20 66 75 6e 63 74 69  library.  functi
1180: 6f 6e 2e 20 20 49 66 20 74 68 69 73 20 6f 70 74  on.  If this opt
1190: 69 6f 6e 20 69 73 20 6d 69 73 73 69 6e 67 20 6f  ion is missing o
11a0: 72 20 66 61 6c 73 65 2c 20 74 68 65 6e 20 53 51  r false, then SQ
11b0: 4c 69 74 65 20 73 75 62 73 74 69 74 75 74 65 73  Lite substitutes
11c0: 20 69 74 73 20 6f 77 6e 0a 20 20 68 6f 6d 65 2d   its own.  home-
11d0: 67 72 6f 77 6e 20 69 6d 70 6c 65 6d 65 6e 74 61  grown implementa
11e0: 74 69 6f 6e 20 6f 66 20 73 74 72 63 68 72 6e 75  tion of strchrnu
11f0: 6c 28 29 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f  l()..}..COMPILE_
1200: 4f 50 54 49 4f 4e 20 7b 48 41 56 45 5f 55 53 4c  OPTION {HAVE_USL
1210: 45 45 50 7d 20 7b 0a 20 20 49 66 20 74 68 65 20  EEP} {.  If the 
1220: 48 41 56 45 5f 55 53 4c 45 45 50 20 6f 70 74 69  HAVE_USLEEP opti
1230: 6f 6e 20 69 73 20 74 72 75 65 2c 20 74 68 65 6e  on is true, then
1240: 20 74 68 65 20 64 65 66 61 75 6c 74 20 75 6e 69   the default uni
1250: 78 20 56 46 53 20 75 73 65 73 20 74 68 65 0a 20  x VFS uses the. 
1260: 20 75 73 6c 65 65 70 28 29 20 73 79 73 74 65 6d   usleep() system
1270: 20 63 61 6c 6c 20 74 6f 20 69 6d 70 6c 65 6d 65   call to impleme
1280: 6e 74 20 74 68 65 20 78 53 6c 65 65 70 20 6d 65  nt the xSleep me
1290: 74 68 6f 64 2e 20 20 49 66 20 74 68 69 73 20 6f  thod.  If this o
12a0: 70 74 69 6f 6e 20 69 73 0a 20 20 75 6e 64 65 66  ption is.  undef
12b0: 69 6e 65 64 20 6f 72 20 66 61 6c 73 65 2c 20 74  ined or false, t
12c0: 68 65 6e 20 78 53 6c 65 65 70 20 6f 6e 20 75 6e  hen xSleep on un
12d0: 69 78 20 69 73 20 69 6d 70 6c 65 6d 65 6e 74 65  ix is implemente
12e0: 64 20 75 73 69 6e 67 20 73 6c 65 65 70 28 29 20  d using sleep() 
12f0: 77 68 69 63 68 0a 20 20 6d 65 61 6e 73 20 74 68  which.  means th
1300: 61 74 20 5b 73 71 6c 69 74 65 33 5f 73 6c 65 65  at [sqlite3_slee
1310: 70 28 29 5d 20 77 69 6c 6c 20 68 61 76 65 20 61  p()] will have a
1320: 20 6d 69 6e 69 6d 75 6d 20 77 61 69 74 20 69 6e   minimum wait in
1330: 74 65 72 76 61 6c 20 6f 66 20 31 30 30 30 0a 20  terval of 1000. 
1340: 20 6d 69 6c 6c 69 73 65 63 6f 6e 64 73 20 72 65   milliseconds re
1350: 67 61 72 64 6c 65 73 73 20 6f 66 20 69 74 73 20  gardless of its 
1360: 61 72 67 75 6d 65 6e 74 2e 20 20 0a 7d 0a 0a 43  argument.  .}..C
1370: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 48  OMPILE_OPTION {H
1380: 41 56 45 5f 55 54 49 4d 45 7d 20 7b 0a 20 20 49  AVE_UTIME} {.  I
1390: 66 20 74 68 65 20 48 41 56 45 5f 55 54 49 4d 45  f the HAVE_UTIME
13a0: 20 6f 70 74 69 6f 6e 20 69 73 20 74 72 75 65 2c   option is true,
13b0: 20 74 68 65 6e 20 74 68 65 20 62 75 69 6c 74 2d   then the built-
13c0: 69 6e 20 62 75 74 20 6e 6f 6e 2d 73 74 61 6e 64  in but non-stand
13d0: 61 72 64 0a 20 20 22 75 6e 69 78 2d 64 6f 74 66  ard.  "unix-dotf
13e0: 69 6c 65 22 20 56 46 53 20 77 69 6c 6c 20 75 73  ile" VFS will us
13f0: 65 20 74 68 65 20 75 74 69 6d 65 28 29 20 73 79  e the utime() sy
1400: 73 74 65 6d 20 63 61 6c 6c 2c 20 69 6e 73 74 65  stem call, inste
1410: 61 64 20 6f 66 20 75 74 69 6d 65 73 28 29 2c 0a  ad of utimes(),.
1420: 20 20 74 6f 20 73 65 74 20 74 68 65 20 6c 61 73    to set the las
1430: 74 20 61 63 63 65 73 73 20 74 69 6d 65 20 6f 6e  t access time on
1440: 20 74 68 65 20 6c 6f 63 6b 20 66 69 6c 65 2e 0a   the lock file..
1450: 7d 0a 3c 2f 74 63 6c 3e 0a 0a 3c 61 20 6e 61 6d  }.</tcl>..<a nam
1460: 65 3d 22 64 65 66 61 75 6c 74 73 22 3e 3c 2f 61  e="defaults"></a
1470: 3e 0a 3c 68 32 3e 31 2e 32 20 4f 70 74 69 6f 6e  >.<h2>1.2 Option
1480: 73 20 54 6f 20 53 65 74 20 44 65 66 61 75 6c 74  s To Set Default
1490: 20 50 61 72 61 6d 65 74 65 72 20 56 61 6c 75 65   Parameter Value
14a0: 73 3c 2f 68 32 3e 0a 0a 3c 74 63 6c 3e 0a 0a 43  s</h2>..<tcl>..C
14b0: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53  OMPILE_OPTION {S
14c0: 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f 41 55  QLITE_DEFAULT_AU
14d0: 54 4f 4d 41 54 49 43 5f 49 4e 44 45 58 3d 3c 69  TOMATIC_INDEX=<i
14e0: 3e 26 6c 74 3b 30 20 6f 72 20 31 26 67 74 3b 3c  >&lt;0 or 1&gt;<
14f0: 2f 69 3e 7d 20 7b 0a 20 20 54 68 69 73 20 6d 61  /i>} {.  This ma
1500: 63 72 6f 20 64 65 74 65 72 6d 69 6e 65 73 20 74  cro determines t
1510: 68 65 20 69 6e 69 74 69 61 6c 20 73 65 74 74 69  he initial setti
1520: 6e 67 20 66 6f 72 20 5b 50 52 41 47 4d 41 20 61  ng for [PRAGMA a
1530: 75 74 6f 6d 61 74 69 63 5f 69 6e 64 65 78 5d 0a  utomatic_index].
1540: 20 20 66 6f 72 20 6e 65 77 6c 79 20 6f 70 65 6e    for newly open
1550: 65 64 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e  ed [database con
1560: 6e 65 63 74 69 6f 6e 73 5d 2e 0a 20 20 46 6f 72  nections]..  For
1570: 20 61 6c 6c 20 76 65 72 73 69 6f 6e 73 20 6f 66   all versions of
1580: 20 53 51 4c 69 74 65 20 74 68 72 6f 75 67 68 20   SQLite through 
1590: 33 2e 37 2e 31 37 2c 0a 20 20 61 75 74 6f 6d 61  3.7.17,.  automa
15a0: 74 69 63 20 69 6e 64 69 63 65 73 20 61 72 65 20  tic indices are 
15b0: 6e 6f 72 6d 61 6c 6c 79 20 65 6e 61 62 6c 65 64  normally enabled
15c0: 20 66 6f 72 20 6e 65 77 20 64 61 74 61 62 61 73   for new databas
15d0: 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 20 69 66  e connections if
15e0: 0a 20 20 74 68 69 73 20 63 6f 6d 70 69 6c 65 2d  .  this compile-
15f0: 74 69 6d 65 20 6f 70 74 69 6f 6e 20 69 73 20 6f  time option is o
1600: 6d 69 74 74 65 64 2e 0a 20 20 48 6f 77 65 76 65  mitted..  Howeve
1610: 72 2c 20 74 68 61 74 20 6d 69 67 68 74 20 63 68  r, that might ch
1620: 61 6e 67 65 20 69 6e 20 66 75 74 75 72 65 20 72  ange in future r
1630: 65 6c 65 61 73 65 73 20 6f 66 20 53 51 4c 69 74  eleases of SQLit
1640: 65 2e 0a 20 20 3c 70 3e 53 65 65 20 61 6c 73 6f  e..  <p>See also
1650: 3a 20 5b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41  : [SQLITE_OMIT_A
1660: 55 54 4f 4d 41 54 49 43 5f 49 4e 44 45 58 5d 0a  UTOMATIC_INDEX].
1670: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f  }..COMPILE_OPTIO
1680: 4e 20 7b 53 51 4c 49 54 45 5f 44 45 46 41 55 4c  N {SQLITE_DEFAUL
1690: 54 5f 41 55 54 4f 56 41 43 55 55 4d 3d 3c 69 3e  T_AUTOVACUUM=<i>
16a0: 26 6c 74 3b 30 20 6f 72 20 31 20 6f 72 20 32 26  &lt;0 or 1 or 2&
16b0: 67 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 69  gt;</i>} {.  Thi
16c0: 73 20 6d 61 63 72 6f 20 64 65 74 65 72 6d 69 6e  s macro determin
16d0: 65 73 20 69 66 20 53 51 4c 69 74 65 20 63 72 65  es if SQLite cre
16e0: 61 74 65 73 20 64 61 74 61 62 61 73 65 73 20 77  ates databases w
16f0: 69 74 68 20 74 68 65 20 0a 20 20 5b 61 75 74 6f  ith the .  [auto
1700: 5f 76 61 63 75 75 6d 5d 20 66 6c 61 67 20 73 65  _vacuum] flag se
1710: 74 20 62 79 20 64 65 66 61 75 6c 74 20 74 6f 20  t by default to 
1720: 4f 46 46 20 28 30 29 2c 20 46 55 4c 4c 20 28 31  OFF (0), FULL (1
1730: 29 2c 20 6f 72 0a 20 20 49 4e 43 52 45 4d 45 4e  ), or.  INCREMEN
1740: 54 41 4c 20 28 32 29 2e 20 54 68 65 20 64 65 66  TAL (2). The def
1750: 61 75 6c 74 20 76 61 6c 75 65 20 69 73 20 30 20  ault value is 0 
1760: 6d 65 61 6e 69 6e 67 20 74 68 61 74 20 64 61 74  meaning that dat
1770: 61 62 61 73 65 73 0a 20 20 61 72 65 20 63 72 65  abases.  are cre
1780: 61 74 65 64 20 77 69 74 68 20 61 75 74 6f 2d 76  ated with auto-v
1790: 61 63 75 75 6d 20 74 75 72 6e 65 64 20 6f 66 66  acuum turned off
17a0: 2e 0a 20 20 49 6e 20 61 6e 79 20 63 61 73 65 20  ..  In any case 
17b0: 74 68 65 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65  the compile-time
17c0: 20 64 65 66 61 75 6c 74 20 6d 61 79 20 62 65 20   default may be 
17d0: 6f 76 65 72 72 69 64 64 65 6e 20 62 79 20 74 68  overridden by th
17e0: 65 20 0a 20 20 5b 50 52 41 47 4d 41 20 61 75 74  e .  [PRAGMA aut
17f0: 6f 5f 76 61 63 75 75 6d 5d 20 63 6f 6d 6d 61 6e  o_vacuum] comman
1800: 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50  d..}..COMPILE_OP
1810: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 45 46  TION {SQLITE_DEF
1820: 41 55 4c 54 5f 43 41 43 48 45 5f 53 49 5a 45 3d  AULT_CACHE_SIZE=
1830: 3c 69 3e 26 6c 74 3b 70 61 67 65 73 26 67 74 3b  <i>&lt;pages&gt;
1840: 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 69 73 20 6d  </i>} {.  This m
1850: 61 63 72 6f 20 73 65 74 73 20 74 68 65 20 64 65  acro sets the de
1860: 66 61 75 6c 74 20 73 69 7a 65 20 6f 66 20 74 68  fault size of th
1870: 65 20 70 61 67 65 2d 63 61 63 68 65 20 66 6f 72  e page-cache for
1880: 20 65 61 63 68 20 61 74 74 61 63 68 65 64 0a 20   each attached. 
1890: 20 64 61 74 61 62 61 73 65 2c 20 69 6e 20 70 61   database, in pa
18a0: 67 65 73 2e 20 54 68 69 73 20 63 61 6e 20 62 65  ges. This can be
18b0: 20 6f 76 65 72 72 69 64 64 65 6e 20 62 79 20 74   overridden by t
18c0: 68 65 20 0a 20 20 5b 50 52 41 47 4d 41 20 63 61  he .  [PRAGMA ca
18d0: 63 68 65 5f 73 69 7a 65 5d 20 63 6f 6d 6d 61 6e  che_size] comman
18e0: 64 2e 20 54 68 65 20 64 65 66 61 75 6c 74 20 76  d. The default v
18f0: 61 6c 75 65 20 69 73 20 32 30 30 30 2e 0a 7d 0a  alue is 2000..}.
1900: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20  .COMPILE_OPTION 
1910: 7b 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f  {SQLITE_DEFAULT_
1920: 46 49 4c 45 5f 46 4f 52 4d 41 54 3d 3c 69 3e 26  FILE_FORMAT=<i>&
1930: 6c 74 3b 31 20 6f 72 20 34 26 67 74 3b 3c 2f 69  lt;1 or 4&gt;</i
1940: 3e 7d 20 7b 0a 20 20 54 68 65 20 64 65 66 61 75  >} {.  The defau
1950: 6c 74 20 5b 73 63 68 65 6d 61 20 66 6f 72 6d 61  lt [schema forma
1960: 74 20 6e 75 6d 62 65 72 5d 20 75 73 65 64 20 62  t number] used b
1970: 79 20 53 51 4c 69 74 65 20 77 68 65 6e 20 63 72  y SQLite when cr
1980: 65 61 74 69 6e 67 0a 20 20 6e 65 77 20 64 61 74  eating.  new dat
1990: 61 62 61 73 65 20 66 69 6c 65 73 20 69 73 20 73  abase files is s
19a0: 65 74 20 62 79 20 74 68 69 73 20 6d 61 63 72 6f  et by this macro
19b0: 2e 20 20 54 68 65 20 73 63 68 65 6d 61 20 66 6f  .  The schema fo
19c0: 72 6d 61 74 73 20 61 72 65 20 61 6c 6c 0a 20 20  rmats are all.  
19d0: 76 65 72 79 20 73 69 6d 69 6c 61 72 2e 20 20 54  very similar.  T
19e0: 68 65 20 64 69 66 66 65 72 65 6e 63 65 20 62 65  he difference be
19f0: 74 77 65 65 6e 20 66 6f 72 6d 61 74 73 20 31 20  tween formats 1 
1a00: 61 6e 64 20 34 20 69 73 20 74 68 61 74 20 66 6f  and 4 is that fo
1a10: 72 6d 61 74 0a 20 20 34 20 75 6e 64 65 72 73 74  rmat.  4 underst
1a20: 61 6e 64 73 20 5b 64 65 73 63 65 6e 64 69 6e 67  ands [descending
1a30: 20 69 6e 64 69 63 65 73 5d 20 61 6e 64 20 68 61   indices] and ha
1a40: 73 20 61 20 74 69 67 68 74 65 72 20 65 6e 63 6f  s a tighter enco
1a50: 64 69 6e 67 20 66 6f 72 0a 20 20 62 6f 6f 6c 65  ding for.  boole
1a60: 61 6e 20 76 61 6c 75 65 73 2e 0a 0a 20 20 41 6c  an values...  Al
1a70: 6c 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 53 51  l versions of SQ
1a80: 4c 69 74 65 20 73 69 6e 63 65 20 33 2e 33 2e 30  Lite since 3.3.0
1a90: 20 28 32 30 30 36 2d 30 31 2d 31 30 29 0a 20 20   (2006-01-10).  
1aa0: 63 61 6e 20 72 65 61 64 20 61 6e 64 20 77 72 69  can read and wri
1ab0: 74 65 20 61 6e 79 20 73 63 68 65 6d 61 20 66 6f  te any schema fo
1ac0: 72 6d 61 74 0a 20 20 62 65 74 77 65 65 6e 20 31  rmat.  between 1
1ad0: 20 61 6e 64 20 34 2e 20 20 42 75 74 20 6f 6c 64   and 4.  But old
1ae0: 65 72 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 53  er versions of S
1af0: 51 4c 69 74 65 20 6d 69 67 68 74 20 6e 6f 74 20  QLite might not 
1b00: 62 65 20 61 62 6c 65 20 74 6f 0a 20 20 72 65 61  be able to.  rea
1b10: 64 20 66 6f 72 6d 61 74 73 20 67 72 65 61 74 65  d formats greate
1b20: 72 20 74 68 61 6e 20 31 2e 20 20 53 6f 20 74 68  r than 1.  So th
1b30: 61 74 20 6f 6c 64 65 72 20 76 65 72 73 69 6f 6e  at older version
1b40: 73 20 6f 66 20 53 51 4c 69 74 65 20 77 69 6c 6c  s of SQLite will
1b50: 0a 20 20 62 65 20 61 62 6c 65 20 74 6f 20 72 65  .  be able to re
1b60: 61 64 20 61 6e 64 20 77 72 69 74 65 20 64 61 74  ad and write dat
1b70: 61 62 61 73 65 20 66 69 6c 65 73 20 63 72 65 61  abase files crea
1b80: 74 65 64 20 62 79 20 6e 65 77 65 72 20 76 65 72  ted by newer ver
1b90: 73 69 6f 6e 73 0a 20 20 6f 66 20 53 51 4c 69 74  sions.  of SQLit
1ba0: 65 2c 20 74 68 65 20 64 65 66 61 75 6c 74 20 73  e, the default s
1bb0: 63 68 65 6d 61 20 66 6f 72 6d 61 74 20 77 61 73  chema format was
1bc0: 20 73 65 74 20 74 6f 20 31 20 66 6f 72 20 53 51   set to 1 for SQ
1bd0: 4c 69 74 65 20 76 65 72 73 69 6f 6e 73 0a 20 20  Lite versions.  
1be0: 74 68 72 6f 75 67 68 20 33 2e 37 2e 39 20 28 32  through 3.7.9 (2
1bf0: 30 31 31 2d 31 31 2d 30 31 29 2e 20 20 42 65 67  011-11-01).  Beg
1c00: 69 6e 6e 69 6e 67 20 77 69 74 68 20 76 65 72 73  inning with vers
1c10: 69 6f 6e 20 33 2e 37 2e 31 30 2c 20 74 68 65 20  ion 3.7.10, the 
1c20: 64 65 66 61 75 6c 74 0a 20 20 73 63 68 65 6d 61  default.  schema
1c30: 20 66 6f 72 6d 61 74 20 69 73 20 34 2e 0a 0a 20   format is 4... 
1c40: 20 54 68 65 20 73 63 68 65 6d 61 20 66 6f 72 6d   The schema form
1c50: 61 74 20 6e 75 6d 62 65 72 20 66 6f 72 20 61 20  at number for a 
1c60: 6e 65 77 20 64 61 74 61 62 61 73 65 20 63 61 6e  new database can
1c70: 20 62 65 20 73 65 74 20 61 74 20 72 75 6e 74 69   be set at runti
1c80: 6d 65 20 75 73 69 6e 67 0a 20 20 74 68 65 20 5b  me using.  the [
1c90: 50 52 41 47 4d 41 20 6c 65 67 61 63 79 5f 66 69  PRAGMA legacy_fi
1ca0: 6c 65 5f 66 6f 72 6d 61 74 5d 20 63 6f 6d 6d 61  le_format] comma
1cb0: 6e 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f  nd..}..COMPILE_O
1cc0: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 45  PTION {SQLITE_DE
1cd0: 46 41 55 4c 54 5f 46 49 4c 45 5f 50 45 52 4d 49  FAULT_FILE_PERMI
1ce0: 53 53 49 4f 4e 53 3d 3c 69 3e 4e 3c 2f 69 3e 7d  SSIONS=<i>N</i>}
1cf0: 20 7b 0a 20 20 54 68 65 20 64 65 66 61 75 6c 74   {.  The default
1d00: 20 6e 75 6d 65 72 69 63 20 66 69 6c 65 20 70 65   numeric file pe
1d10: 72 6d 69 73 73 69 6f 6e 73 20 66 6f 72 20 6e 65  rmissions for ne
1d20: 77 6c 79 20 63 72 65 61 74 65 64 20 64 61 74 61  wly created data
1d30: 62 61 73 65 20 66 69 6c 65 73 0a 20 20 75 6e 64  base files.  und
1d40: 65 72 20 75 6e 69 78 2e 20 20 49 66 20 6e 6f 74  er unix.  If not
1d50: 20 73 70 65 63 69 66 69 65 64 2c 20 74 68 65 20   specified, the 
1d60: 64 65 66 61 75 6c 74 20 69 73 20 30 36 34 34 20  default is 0644 
1d70: 77 68 69 63 68 20 6d 65 61 6e 73 20 74 68 61 74  which means that
1d80: 0a 20 20 74 68 65 20 66 69 6c 65 73 20 69 73 20  .  the files is 
1d90: 67 6c 6f 62 61 6c 6c 79 20 72 65 61 64 61 62 6c  globally readabl
1da0: 65 20 62 75 74 20 6f 6e 6c 79 20 77 72 69 74 61  e but only writa
1db0: 62 6c 65 20 62 79 20 74 68 65 20 63 72 65 61 74  ble by the creat
1dc0: 6f 72 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f  or..}..COMPILE_O
1dd0: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 45  PTION {SQLITE_DE
1de0: 46 41 55 4c 54 5f 46 4f 52 45 49 47 4e 5f 4b 45  FAULT_FOREIGN_KE
1df0: 59 53 3d 3c 69 3e 26 6c 74 3b 30 20 6f 72 20 31  YS=<i>&lt;0 or 1
1e00: 26 67 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68  &gt;</i>} {.  Th
1e10: 69 73 20 6d 61 63 72 6f 20 64 65 74 65 72 6d 69  is macro determi
1e20: 6e 65 73 20 77 68 65 74 68 65 72 20 65 6e 66 6f  nes whether enfo
1e30: 72 63 65 6d 65 6e 74 20 6f 66 20 0a 20 20 5b 66  rcement of .  [f
1e40: 6f 72 65 69 67 6e 20 6b 65 79 20 63 6f 6e 73 74  oreign key const
1e50: 72 61 69 6e 74 73 5d 20 69 73 20 65 6e 61 62 6c  raints] is enabl
1e60: 65 64 20 6f 72 20 64 69 73 61 62 6c 65 64 20 62  ed or disabled b
1e70: 79 20 64 65 66 61 75 6c 74 20 66 6f 72 0a 20 20  y default for.  
1e80: 6e 65 77 20 64 61 74 61 62 61 73 65 20 63 6f 6e  new database con
1e90: 6e 65 63 74 69 6f 6e 73 2e 20 20 45 61 63 68 20  nections.  Each 
1ea0: 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
1eb0: 69 6f 6e 20 63 61 6e 20 61 6c 77 61 79 73 20 74  ion can always t
1ec0: 75 72 6e 0a 20 20 65 6e 66 6f 72 63 65 6d 65 6e  urn.  enforcemen
1ed0: 74 20 6f 66 20 66 6f 72 65 69 67 6e 20 6b 65 79  t of foreign key
1ee0: 20 63 6f 6e 73 74 72 61 69 6e 74 73 20 6f 6e 20   constraints on 
1ef0: 61 6e 64 20 6f 66 66 20 61 6e 64 20 72 75 6e 2d  and off and run-
1f00: 74 69 6d 65 20 75 73 69 6e 67 0a 20 20 74 68 65  time using.  the
1f10: 20 5b 66 6f 72 65 69 67 6e 5f 6b 65 79 73 20 70   [foreign_keys p
1f20: 72 61 67 6d 61 5d 2e 20 20 45 6e 66 6f 72 63 65  ragma].  Enforce
1f30: 6d 65 6e 74 20 6f 66 20 66 6f 72 65 69 67 6e 20  ment of foreign 
1f40: 6b 65 79 20 63 6f 6e 73 74 72 61 69 6e 74 73 0a  key constraints.
1f50: 20 20 69 73 20 6e 6f 72 6d 61 6c 6c 79 20 6f 66    is normally of
1f60: 66 20 62 79 20 64 65 66 61 75 6c 74 2c 20 62 75  f by default, bu
1f70: 74 20 69 66 20 74 68 69 73 20 63 6f 6d 70 69 6c  t if this compil
1f80: 65 2d 74 69 6d 65 20 70 61 72 61 6d 65 74 65 72  e-time parameter
1f90: 20 69 73 0a 20 20 73 65 74 20 74 6f 20 31 2c 20   is.  set to 1, 
1fa0: 65 6e 66 6f 72 63 65 6d 65 6e 74 20 6f 66 20 66  enforcement of f
1fb0: 6f 72 65 69 67 6e 20 6b 65 79 20 63 6f 6e 73 74  oreign key const
1fc0: 72 61 69 6e 74 73 20 77 69 6c 6c 20 62 65 20 6f  raints will be o
1fd0: 6e 20 62 79 20 64 65 66 61 75 6c 74 2e 0a 7d 0a  n by default..}.
1fe0: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20  .COMPILE_OPTION 
1ff0: 7b 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f  {SQLITE_DEFAULT_
2000: 4d 4d 41 50 5f 53 49 5a 45 3d 3c 69 3e 4e 3c 2f  MMAP_SIZE=<i>N</
2010: 69 3e 7d 20 7b 0a 20 20 54 68 69 73 20 6d 61 63  i>} {.  This mac
2020: 72 6f 20 73 65 74 73 20 74 68 65 20 64 65 66 61  ro sets the defa
2030: 75 6c 74 20 6c 69 6d 69 74 20 6f 6e 20 74 68 65  ult limit on the
2040: 20 61 6d 6f 75 6e 74 20 6f 66 20 6d 65 6d 6f 72   amount of memor
2050: 79 20 74 68 61 74 0a 20 20 77 69 6c 6c 20 62 65  y that.  will be
2060: 20 75 73 65 64 20 66 6f 72 20 6d 65 6d 6f 72 79   used for memory
2070: 2d 6d 61 70 70 65 64 20 49 2f 4f 0a 20 20 66 6f  -mapped I/O.  fo
2080: 72 20 65 61 63 68 20 6f 70 65 6e 20 64 61 74 61  r each open data
2090: 62 61 73 65 20 66 69 6c 65 2e 20 20 49 66 20 74  base file.  If t
20a0: 68 65 20 3c 69 3e 4e 3c 2f 69 3e 0a 20 20 69 73  he <i>N</i>.  is
20b0: 20 7a 65 72 6f 2c 20 74 68 65 6e 20 6d 65 6d 6f   zero, then memo
20c0: 72 79 20 6d 61 70 70 65 64 20 49 2f 4f 20 69 73  ry mapped I/O is
20d0: 20 64 69 73 61 62 6c 65 64 20 62 79 20 64 65 66   disabled by def
20e0: 61 75 6c 74 2e 20 20 54 68 69 73 0a 20 20 63 6f  ault.  This.  co
20f0: 6d 70 69 6c 65 2d 74 69 6d 65 20 6c 69 6d 69 74  mpile-time limit
2100: 20 61 6e 64 20 74 68 65 20 5b 53 51 4c 49 54 45   and the [SQLITE
2110: 5f 4d 41 58 5f 4d 4d 41 50 5f 53 49 5a 45 5d 20  _MAX_MMAP_SIZE] 
2120: 63 61 6e 20 62 65 20 6d 6f 64 69 66 69 65 64 20  can be modified 
2130: 0a 20 20 61 74 20 73 74 61 72 74 2d 74 69 6d 65  .  at start-time
2140: 20 75 73 69 6e 67 20 74 68 65 0a 20 20 5b 73 71   using the.  [sq
2150: 6c 69 74 65 33 5f 63 6f 6e 66 69 67 5d 28 5b 53  lite3_config]([S
2160: 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 4d 41  QLITE_CONFIG_MMA
2170: 50 5f 53 49 5a 45 5d 29 20 63 61 6c 6c 2c 20 6f  P_SIZE]) call, o
2180: 72 20 61 74 20 72 75 6e 2d 74 69 6d 65 0a 20 20  r at run-time.  
2190: 75 73 69 6e 67 20 74 68 65 20 5b 6d 6d 61 70 5f  using the [mmap_
21a0: 73 69 7a 65 20 70 72 61 67 6d 61 5d 2e 0a 7d 0a  size pragma]..}.
21b0: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20  .COMPILE_OPTION 
21c0: 7b 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f  {SQLITE_DEFAULT_
21d0: 4a 4f 55 52 4e 41 4c 5f 53 49 5a 45 5f 4c 49 4d  JOURNAL_SIZE_LIM
21e0: 49 54 3d 3c 69 3e 26 6c 74 3b 62 79 74 65 73 26  IT=<i>&lt;bytes&
21f0: 67 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 69  gt;</i>} {.  Thi
2200: 73 20 6f 70 74 69 6f 6e 20 73 65 74 73 20 74 68  s option sets th
2210: 65 20 73 69 7a 65 20 6c 69 6d 69 74 20 6f 6e 20  e size limit on 
2220: 5b 72 6f 6c 6c 62 61 63 6b 20 6a 6f 75 72 6e 61  [rollback journa
2230: 6c 5d 20 66 69 6c 65 73 20 69 6e 0a 20 20 5b 6a  l] files in.  [j
2240: 6f 75 72 6e 61 6c 5f 6d 6f 64 65 20 70 72 61 67  ournal_mode prag
2250: 6d 61 20 7c 20 70 65 72 73 69 73 74 65 6e 74 20  ma | persistent 
2260: 6a 6f 75 72 6e 61 6c 20 6d 6f 64 65 5d 20 61 6e  journal mode] an
2270: 64 0a 20 20 5b 6c 6f 63 6b 69 6e 67 5f 6d 6f 64  d.  [locking_mod
2280: 65 20 7c 20 65 78 63 6c 75 73 69 76 65 20 6c 6f  e | exclusive lo
2290: 63 6b 69 6e 67 20 6d 6f 64 65 5d 20 61 6e 64 20  cking mode] and 
22a0: 6f 6e 20 74 68 65 20 73 69 7a 65 20 6f 66 20 74  on the size of t
22b0: 68 65 0a 20 20 77 72 69 74 65 2d 61 68 65 61 64  he.  write-ahead
22c0: 20 6c 6f 67 20 66 69 6c 65 20 69 6e 20 5b 57 41   log file in [WA
22d0: 4c 20 6d 6f 64 65 5d 2e 20 57 68 65 6e 20 74 68  L mode]. When th
22e0: 69 73 20 0a 20 20 63 6f 6d 70 69 6c 65 2d 74 69  is .  compile-ti
22f0: 6d 65 20 6f 70 74 69 6f 6e 20 69 73 20 6f 6d 69  me option is omi
2300: 74 74 65 64 20 74 68 65 72 65 20 69 73 20 6e 6f  tted there is no
2310: 20 75 70 70 65 72 20 62 6f 75 6e 64 20 6f 6e 20   upper bound on 
2320: 74 68 65 0a 20 20 73 69 7a 65 20 6f 66 20 74 68  the.  size of th
2330: 65 20 72 6f 6c 6c 62 61 63 6b 20 6a 6f 75 72 6e  e rollback journ
2340: 61 6c 73 20 6f 72 20 77 72 69 74 65 2d 61 68 65  als or write-ahe
2350: 61 64 20 6c 6f 67 73 2e 20 20 0a 20 20 54 68 65  ad logs.  .  The
2360: 20 6a 6f 75 72 6e 61 6c 20 66 69 6c 65 20 73 69   journal file si
2370: 7a 65 20 6c 69 6d 69 74 0a 20 20 63 61 6e 20 62  ze limit.  can b
2380: 65 20 63 68 61 6e 67 65 64 20 61 74 20 72 75 6e  e changed at run
2390: 2d 74 69 6d 65 20 75 73 69 6e 67 20 74 68 65 20  -time using the 
23a0: 5b 6a 6f 75 72 6e 61 6c 5f 73 69 7a 65 5f 6c 69  [journal_size_li
23b0: 6d 69 74 20 70 72 61 67 6d 61 5d 2e 0a 7d 0a 0a  mit pragma]..}..
23c0: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b  COMPILE_OPTION {
23d0: 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f 4c  SQLITE_DEFAULT_L
23e0: 4f 43 4b 49 4e 47 5f 4d 4f 44 45 3d 3c 69 3e 26  OCKING_MODE=<i>&
23f0: 6c 74 3b 31 20 6f 72 20 30 26 67 74 3b 3c 2f 69  lt;1 or 0&gt;</i
2400: 3e 7d 20 7b 0a 20 20 49 66 20 73 65 74 20 74 6f  >} {.  If set to
2410: 20 31 2c 20 74 68 65 6e 20 74 68 65 20 64 65 66   1, then the def
2420: 61 75 6c 74 20 5b 6c 6f 63 6b 69 6e 67 5f 6d 6f  ault [locking_mo
2430: 64 65 5d 20 69 73 20 73 65 74 20 74 6f 20 45 58  de] is set to EX
2440: 43 4c 55 53 49 56 45 2e 0a 20 20 49 66 20 6f 6d  CLUSIVE..  If om
2450: 69 74 74 65 64 20 6f 72 20 73 65 74 20 74 6f 20  itted or set to 
2460: 30 20 74 68 65 6e 20 74 68 65 20 64 65 66 61 75  0 then the defau
2470: 6c 74 20 5b 6c 6f 63 6b 69 6e 67 5f 6d 6f 64 65  lt [locking_mode
2480: 5d 20 69 73 20 4e 4f 52 4d 41 4c 2e 0a 7d 0a 0a  ] is NORMAL..}..
2490: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b  COMPILE_OPTION {
24a0: 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f 4d  SQLITE_DEFAULT_M
24b0: 45 4d 53 54 41 54 55 53 3d 3c 69 3e 26 6c 74 3b  EMSTATUS=<i>&lt;
24c0: 31 20 6f 72 20 30 26 67 74 3b 3c 2f 69 3e 7d 20  1 or 0&gt;</i>} 
24d0: 7b 0a 20 20 54 68 69 73 20 6d 61 63 72 6f 20 69  {.  This macro i
24e0: 73 20 75 73 65 64 20 74 6f 20 64 65 74 65 72 6d  s used to determ
24f0: 69 6e 65 20 77 68 65 74 68 65 72 20 6f 72 20 6e  ine whether or n
2500: 6f 74 20 74 68 65 20 66 65 61 74 75 72 65 73 20  ot the features 
2510: 65 6e 61 62 6c 65 64 20 61 6e 64 0a 20 20 64 69  enabled and.  di
2520: 73 61 62 6c 65 64 20 75 73 69 6e 67 20 74 68 65  sabled using the
2530: 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d   SQLITE_CONFIG_M
2540: 45 4d 53 54 41 54 55 53 20 61 72 67 75 6d 65 6e  EMSTATUS argumen
2550: 74 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 63 6f  t to [sqlite3_co
2560: 6e 66 69 67 28 29 5d 0a 20 20 61 72 65 20 61 76  nfig()].  are av
2570: 61 69 6c 61 62 6c 65 20 62 79 20 64 65 66 61 75  ailable by defau
2580: 6c 74 2e 20 54 68 65 20 64 65 66 61 75 6c 74 20  lt. The default 
2590: 76 61 6c 75 65 20 69 73 20 31 20 28 5b 53 51 4c  value is 1 ([SQL
25a0: 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 45 4d 53 54  ITE_CONFIG_MEMST
25b0: 41 54 55 53 5d 0a 20 20 72 65 6c 61 74 65 64 20  ATUS].  related 
25c0: 66 65 61 74 75 72 65 73 20 65 6e 61 62 6c 65 64  features enabled
25d0: 29 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50  )..}..COMPILE_OP
25e0: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 45 46  TION {SQLITE_DEF
25f0: 41 55 4c 54 5f 50 41 47 45 5f 53 49 5a 45 3d 3c  AULT_PAGE_SIZE=<
2600: 69 3e 26 6c 74 3b 62 79 74 65 73 26 67 74 3b 3c  i>&lt;bytes&gt;<
2610: 2f 69 3e 7d 20 7b 0a 20 20 54 68 69 73 20 6d 61  /i>} {.  This ma
2620: 63 72 6f 20 69 73 20 75 73 65 64 20 74 6f 20 73  cro is used to s
2630: 65 74 20 74 68 65 20 64 65 66 61 75 6c 74 20 70  et the default p
2640: 61 67 65 2d 73 69 7a 65 20 75 73 65 64 20 77 68  age-size used wh
2650: 65 6e 20 61 0a 20 20 64 61 74 61 62 61 73 65 20  en a.  database 
2660: 69 73 20 63 72 65 61 74 65 64 2e 20 54 68 65 20  is created. The 
2670: 76 61 6c 75 65 20 61 73 73 69 67 6e 65 64 20 6d  value assigned m
2680: 75 73 74 20 62 65 20 61 20 70 6f 77 65 72 20 6f  ust be a power o
2690: 66 20 32 2e 20 54 68 65 0a 20 20 64 65 66 61 75  f 2. The.  defau
26a0: 6c 74 20 76 61 6c 75 65 20 69 73 20 31 30 32 34  lt value is 1024
26b0: 2e 20 54 68 65 20 63 6f 6d 70 69 6c 65 2d 74 69  . The compile-ti
26c0: 6d 65 20 64 65 66 61 75 6c 74 20 6d 61 79 20 62  me default may b
26d0: 65 20 6f 76 65 72 72 69 64 64 65 6e 20 61 74 20  e overridden at 
26e0: 0a 20 20 72 75 6e 74 69 6d 65 20 62 79 20 74 68  .  runtime by th
26f0: 65 20 5b 50 52 41 47 4d 41 20 70 61 67 65 5f 73  e [PRAGMA page_s
2700: 69 7a 65 5d 20 63 6f 6d 6d 61 6e 64 2e 0a 7d 0a  ize] command..}.
2710: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20  .COMPILE_OPTION 
2720: 7b 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f  {SQLITE_DEFAULT_
2730: 57 41 4c 5f 41 55 54 4f 43 48 45 43 4b 50 4f 49  WAL_AUTOCHECKPOI
2740: 4e 54 3d 3c 69 3e 26 6c 74 3b 70 61 67 65 73 26  NT=<i>&lt;pages&
2750: 67 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 69  gt;</i>} {.  Thi
2760: 73 20 6d 61 63 72 6f 20 73 65 74 73 20 74 68 65  s macro sets the
2770: 20 64 65 66 61 75 6c 74 20 70 61 67 65 20 63 6f   default page co
2780: 75 6e 74 20 66 6f 72 20 74 68 65 20 5b 57 41 4c  unt for the [WAL
2790: 5d 0a 20 20 5b 63 68 65 63 6b 70 6f 69 6e 74 69  ].  [checkpointi
27a0: 6e 67 20 7c 20 61 75 74 6f 6d 61 74 69 63 20 63  ng | automatic c
27b0: 68 65 63 6b 70 6f 69 6e 74 69 6e 67 5d 20 66 65  heckpointing] fe
27c0: 61 74 75 72 65 2e 20 20 49 66 20 75 6e 73 70 65  ature.  If unspe
27d0: 63 69 66 69 65 64 2c 0a 20 20 74 68 65 20 64 65  cified,.  the de
27e0: 66 61 75 6c 74 20 70 61 67 65 20 63 6f 75 6e 74  fault page count
27f0: 20 69 73 20 31 30 30 30 2e 0a 7d 0a 0a 43 4f 4d   is 1000..}..COM
2800: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c  PILE_OPTION {SQL
2810: 49 54 45 5f 44 45 46 41 55 4c 54 5f 57 4f 52 4b  ITE_DEFAULT_WORK
2820: 45 52 5f 54 48 52 45 41 44 53 3d 3c 69 3e 4e 3c  ER_THREADS=<i>N<
2830: 2f 69 3e 7d 20 7b 0a 20 20 54 68 69 73 20 6d 61  /i>} {.  This ma
2840: 63 72 6f 20 73 65 74 73 20 74 68 65 20 64 65 66  cro sets the def
2850: 61 75 6c 74 20 76 61 6c 75 65 20 66 6f 72 0a 20  ault value for. 
2860: 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 4c 49 4d   the [SQLITE_LIM
2870: 49 54 5f 57 4f 52 4b 45 52 5f 54 48 52 45 41 44  IT_WORKER_THREAD
2880: 53 5d 20 70 61 72 61 6d 65 74 65 72 2e 20 20 54  S] parameter.  T
2890: 68 65 20 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54  he [SQLITE_LIMIT
28a0: 5f 57 4f 52 4b 45 52 5f 54 48 52 45 41 44 53 5d  _WORKER_THREADS]
28b0: 0a 20 20 70 61 72 61 6d 65 74 65 72 20 73 65 74  .  parameter set
28c0: 73 20 74 68 65 20 6d 61 78 69 6d 75 6d 20 6e 75  s the maximum nu
28d0: 6d 62 65 72 20 6f 66 20 61 75 78 69 6c 69 61 72  mber of auxiliar
28e0: 79 20 74 68 72 65 61 64 73 20 74 68 61 74 20 61  y threads that a
28f0: 20 73 69 6e 67 6c 65 0a 20 20 5b 70 72 65 70 61   single.  [prepa
2900: 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 77  red statement] w
2910: 69 6c 6c 20 6c 61 75 6e 63 68 20 74 6f 20 61 73  ill launch to as
2920: 73 69 73 74 20 69 74 20 77 69 74 68 20 61 20 71  sist it with a q
2930: 75 65 72 79 2e 20 20 49 66 20 6e 6f 74 20 73 70  uery.  If not sp
2940: 65 63 69 66 69 65 64 2c 0a 20 20 74 68 65 20 64  ecified,.  the d
2950: 65 66 61 75 6c 74 20 6d 61 78 69 6d 75 6d 20 69  efault maximum i
2960: 73 20 30 2e 0a 20 20 54 68 65 20 76 61 6c 75 65  s 0..  The value
2970: 20 73 65 74 20 68 65 72 65 20 63 61 6e 6e 6f 74   set here cannot
2980: 20 62 65 20 6d 6f 72 65 20 74 68 61 6e 20 5b 53   be more than [S
2990: 51 4c 49 54 45 5f 4d 41 58 5f 57 4f 52 4b 45 52  QLITE_MAX_WORKER
29a0: 5f 54 48 52 45 41 44 53 5d 2e 0a 7d 0a 0a 43 4f  _THREADS]..}..CO
29b0: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51  MPILE_OPTION {SQ
29c0: 4c 49 54 45 5f 46 54 53 33 5f 4d 41 58 5f 45 58  LITE_FTS3_MAX_EX
29d0: 50 52 5f 44 45 50 54 48 3d 3c 69 3e 4e 3c 2f 69  PR_DEPTH=<i>N</i
29e0: 3e 7d 20 7b 0a 20 20 54 68 69 73 20 6d 61 63 72  >} {.  This macr
29f0: 6f 20 73 65 74 73 20 74 68 65 20 6d 61 78 69 6d  o sets the maxim
2a00: 75 6d 20 64 65 70 74 68 20 6f 66 20 74 68 65 20  um depth of the 
2a10: 73 65 61 72 63 68 20 74 72 65 65 20 74 68 61 74  search tree that
2a20: 20 63 6f 72 72 65 73 70 6f 6e 64 73 20 74 6f 0a   corresponds to.
2a30: 20 20 74 68 65 20 72 69 67 68 74 2d 68 61 6e 64    the right-hand
2a40: 20 73 69 64 65 20 6f 66 20 74 68 65 20 4d 41 54   side of the MAT
2a50: 43 48 20 6f 70 65 72 61 74 6f 72 20 69 6e 20 61  CH operator in a
2a60: 6e 20 5b 46 54 53 33 5d 20 6f 72 20 5b 46 54 53  n [FTS3] or [FTS
2a70: 34 5d 20 66 75 6c 6c 2d 74 65 78 74 0a 20 20 69  4] full-text.  i
2a80: 6e 64 65 78 2e 20 20 54 68 65 20 66 75 6c 6c 2d  ndex.  The full-
2a90: 74 65 78 74 20 73 65 61 72 63 68 20 75 73 65 73  text search uses
2aa0: 20 61 20 72 65 63 75 72 73 69 76 65 20 61 6c 67   a recursive alg
2ab0: 6f 72 69 74 68 6d 2c 20 73 6f 20 74 68 65 20 64  orithm, so the d
2ac0: 65 70 74 68 20 6f 66 0a 20 20 74 68 65 20 74 72  epth of.  the tr
2ad0: 65 65 20 69 73 20 6c 69 6d 69 74 65 64 20 74 6f  ee is limited to
2ae0: 20 70 72 65 76 65 6e 74 20 75 73 69 6e 67 20 74   prevent using t
2af0: 6f 6f 20 6d 75 63 68 20 73 74 61 63 6b 20 73 70  oo much stack sp
2b00: 61 63 65 2e 20 20 54 68 65 20 64 65 66 61 75 6c  ace.  The defaul
2b10: 74 0a 20 20 6c 69 6d 69 74 20 69 73 20 31 32 2e  t.  limit is 12.
2b20: 20 20 54 68 69 73 20 6c 69 6d 69 74 20 69 73 20    This limit is 
2b30: 73 75 66 66 69 63 69 65 6e 74 20 66 6f 72 20 75  sufficient for u
2b40: 70 20 74 6f 20 34 30 39 35 20 73 65 61 72 63 68  p to 4095 search
2b50: 20 74 65 72 6d 73 20 6f 6e 20 74 68 65 0a 20 20   terms on the.  
2b60: 72 69 67 68 74 2d 68 61 6e 64 20 73 69 64 65 20  right-hand side 
2b70: 6f 66 20 74 68 65 20 4d 41 54 43 48 20 6f 70 65  of the MATCH ope
2b80: 72 61 74 6f 72 20 61 6e 64 20 69 74 20 68 6f 6c  rator and it hol
2b90: 64 73 20 73 74 61 63 6b 20 73 70 61 63 65 20 75  ds stack space u
2ba0: 73 61 67 65 20 74 6f 20 0a 20 20 6c 65 73 73 20  sage to .  less 
2bb0: 74 68 61 6e 20 32 30 30 30 20 62 79 74 65 73 2e  than 2000 bytes.
2bc0: 0a 20 20 3c 70 3e 0a 20 20 46 6f 72 20 6f 72 64  .  <p>.  For ord
2bd0: 69 6e 61 72 79 20 46 54 53 33 2f 46 54 53 34 20  inary FTS3/FTS4 
2be0: 71 75 65 72 69 65 73 2c 20 74 68 65 20 73 65 61  queries, the sea
2bf0: 72 63 68 20 74 72 65 65 20 64 65 70 74 68 20 69  rch tree depth i
2c00: 73 20 61 70 70 72 6f 78 69 6d 61 74 65 6c 79 0a  s approximately.
2c10: 20 20 74 68 65 20 62 61 73 65 2d 32 20 6c 6f 67    the base-2 log
2c20: 61 72 69 74 68 6d 20 6f 66 20 74 68 65 20 6e 75  arithm of the nu
2c30: 6d 62 65 72 20 6f 66 20 74 65 72 6d 73 20 69 6e  mber of terms in
2c40: 20 74 68 65 20 72 69 67 68 74 2d 68 61 6e 64 20   the right-hand 
2c50: 73 69 64 65 20 6f 66 20 74 68 65 0a 20 20 4d 41  side of the.  MA
2c60: 54 43 48 20 6f 70 65 72 61 74 6f 72 2e 20 20 48  TCH operator.  H
2c70: 6f 77 65 76 65 72 2c 20 66 6f 72 20 5b 70 68 72  owever, for [phr
2c80: 61 73 65 20 71 75 65 72 69 65 73 5d 20 61 6e 64  ase queries] and
2c90: 20 5b 4e 45 41 52 20 71 75 65 72 69 65 73 5d 20   [NEAR queries] 
2ca0: 74 68 65 0a 20 20 73 65 61 72 63 68 20 74 72 65  the.  search tre
2cb0: 65 20 64 65 70 74 68 20 69 73 20 6c 69 6e 65 61  e depth is linea
2cc0: 72 20 69 6e 20 74 68 65 20 6e 75 6d 62 65 72 20  r in the number 
2cd0: 6f 66 20 72 69 67 68 74 2d 68 61 6e 64 20 73 69  of right-hand si
2ce0: 64 65 20 74 65 72 6d 73 2e 0a 20 20 53 6f 20 74  de terms..  So t
2cf0: 68 65 20 64 65 66 61 75 6c 74 20 64 65 70 74 68  he default depth
2d00: 20 6c 69 6d 69 74 20 6f 66 20 31 32 20 69 73 20   limit of 12 is 
2d10: 73 75 66 66 69 63 69 65 6e 74 20 66 6f 72 20 75  sufficient for u
2d20: 70 20 74 6f 20 34 30 39 35 20 6f 72 64 69 6e 61  p to 4095 ordina
2d30: 72 79 0a 20 20 74 65 72 6d 73 20 6f 6e 20 61 20  ry.  terms on a 
2d40: 4d 41 54 43 48 2c 20 69 74 20 69 73 20 6f 6e 6c  MATCH, it is onl
2d50: 79 20 73 75 66 66 69 63 69 65 6e 74 20 66 6f 72  y sufficient for
2d60: 20 31 31 20 6f 72 20 31 32 20 70 68 72 61 73 65   11 or 12 phrase
2d70: 20 6f 72 20 4e 45 41 52 0a 20 20 74 65 72 6d 73   or NEAR.  terms
2d80: 2e 20 20 45 76 65 6e 20 73 6f 2c 20 74 68 65 20  .  Even so, the 
2d90: 64 65 66 61 75 6c 74 20 69 73 20 6d 6f 72 65 20  default is more 
2da0: 74 68 61 6e 20 65 6e 6f 75 67 68 20 66 6f 72 20  than enough for 
2db0: 6d 6f 73 74 20 61 70 70 6c 69 63 61 74 69 6f 6e  most application
2dc0: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54  ..}..COMPILE_OPT
2dd0: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4d 41 58 5f  ION {SQLITE_MAX_
2de0: 4d 4d 41 50 5f 53 49 5a 45 3d 3c 69 3e 4e 3c 2f  MMAP_SIZE=<i>N</
2df0: 69 3e 7d 20 7b 0a 20 20 54 68 69 73 20 6d 61 63  i>} {.  This mac
2e00: 72 6f 20 73 65 74 73 20 61 20 68 61 72 64 20 75  ro sets a hard u
2e10: 70 70 65 72 20 62 6f 75 6e 64 20 6f 6e 20 74 68  pper bound on th
2e20: 65 20 61 6d 6f 75 6e 74 20 6f 66 20 61 64 64 72  e amount of addr
2e30: 65 73 73 20 73 70 61 63 65 20 74 68 61 74 0a 20  ess space that. 
2e40: 20 63 61 6e 20 62 65 20 75 73 65 64 20 62 79 20   can be used by 
2e50: 61 6e 79 20 73 69 6e 67 6c 65 20 64 61 74 61 62  any single datab
2e60: 61 73 65 20 66 6f 72 20 6d 65 6d 6f 72 79 2d 6d  ase for memory-m
2e70: 61 70 70 65 64 20 49 2f 4f 2e 0a 20 20 53 65 74  apped I/O..  Set
2e80: 74 69 6e 67 20 74 68 69 73 20 76 61 6c 75 65 20  ting this value 
2e90: 74 6f 20 30 20 63 6f 6d 70 6c 65 74 65 6c 79 20  to 0 completely 
2ea0: 64 69 73 61 62 6c 65 73 20 6d 65 6d 6f 72 79 2d  disables memory-
2eb0: 6d 61 70 70 65 64 20 49 2f 4f 20 61 6e 64 0a 20  mapped I/O and. 
2ec0: 20 63 61 75 73 65 73 20 6c 6f 67 69 63 20 61 73   causes logic as
2ed0: 73 6f 63 69 61 74 65 64 20 77 69 74 68 20 6d 65  sociated with me
2ee0: 6d 6f 72 79 2d 6d 61 70 70 65 64 20 49 2f 4f 20  mory-mapped I/O 
2ef0: 74 6f 20 62 65 20 6f 6d 69 74 74 65 64 20 66 72  to be omitted fr
2f00: 6f 6d 20 74 68 65 0a 20 20 62 75 69 6c 64 2e 20  om the.  build. 
2f10: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 64 6f 65   This option doe
2f20: 73 20 63 68 61 6e 67 65 20 74 68 65 20 64 65 66  s change the def
2f30: 61 75 6c 74 20 6d 65 6d 6f 72 79 2d 6d 61 70 70  ault memory-mapp
2f40: 65 64 20 49 2f 4f 20 61 64 64 72 65 73 73 0a 20  ed I/O address. 
2f50: 20 73 70 61 63 65 20 73 69 7a 65 20 28 73 65 74   space size (set
2f60: 20 62 79 20 5b 53 51 4c 49 54 45 5f 44 45 46 41   by [SQLITE_DEFA
2f70: 55 4c 54 5f 4d 4d 41 50 5f 53 49 5a 45 5d 20 6f  ULT_MMAP_SIZE] o
2f80: 72 0a 20 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66  r.  sqlite3_conf
2f90: 69 67 28 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49  ig([SQLITE_CONFI
2fa0: 47 5f 4d 4d 41 50 5f 53 49 5a 45 5d 29 20 6f 72  G_MMAP_SIZE]) or
2fb0: 20 74 68 65 0a 20 20 72 75 6e 2d 74 69 6d 65 20   the.  run-time 
2fc0: 6d 65 6d 6f 72 79 2d 6d 61 70 70 65 64 20 49 2f  memory-mapped I/
2fd0: 4f 20 61 64 64 72 65 73 73 20 73 70 61 63 65 20  O address space 
2fe0: 73 69 7a 65 20 28 73 65 74 20 62 79 0a 20 20 73  size (set by.  s
2ff0: 71 6c 69 74 65 33 5f 66 69 6c 65 5f 63 6f 6e 74  qlite3_file_cont
3000: 72 6f 6c 28 5b 53 51 4c 49 54 45 5f 46 43 4e 54  rol([SQLITE_FCNT
3010: 4c 5f 4d 4d 41 50 5f 53 49 5a 45 5d 29 20 6f 72  L_MMAP_SIZE]) or
3020: 0a 20 20 5b 50 52 41 47 4d 41 20 6d 6d 61 70 5f  .  [PRAGMA mmap_
3030: 73 69 7a 65 5d 29 20 61 73 20 6c 6f 6e 67 20 61  size]) as long a
3040: 73 20 74 68 6f 73 65 20 6f 74 68 65 72 20 73 65  s those other se
3050: 74 74 69 6e 67 73 20 61 72 65 20 6c 65 73 73 20  ttings are less 
3060: 74 68 61 6e 20 74 68 65 0a 20 20 6d 61 78 69 6d  than the.  maxim
3070: 75 6d 20 76 61 6c 75 65 20 64 65 66 69 6e 65 64  um value defined
3080: 20 68 65 72 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c   here..}..COMPIL
3090: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45  E_OPTION {SQLITE
30a0: 5f 4d 41 58 5f 53 43 48 45 4d 41 5f 52 45 54 52  _MAX_SCHEMA_RETR
30b0: 59 3d 3c 69 3e 4e 3c 2f 69 3e 7d 20 7b 0a 20 20  Y=<i>N</i>} {.  
30c0: 57 68 65 6e 65 76 65 72 20 74 68 65 20 64 61 74  Whenever the dat
30d0: 61 62 61 73 65 20 73 63 68 65 6d 61 20 63 68 61  abase schema cha
30e0: 6e 67 65 73 2c 20 70 72 65 70 61 72 65 64 20 73  nges, prepared s
30f0: 74 61 74 65 6d 65 6e 74 73 20 61 72 65 20 61 75  tatements are au
3100: 74 6f 6d 61 74 69 63 61 6c 6c 79 0a 20 20 72 65  tomatically.  re
3110: 70 72 65 70 61 72 65 64 20 74 6f 20 61 63 63 6f  prepared to acco
3120: 6d 6d 6f 64 61 74 65 20 74 68 65 20 6e 65 77 20  mmodate the new 
3130: 73 63 68 65 6d 61 2e 20 20 54 68 65 72 65 20 69  schema.  There i
3140: 73 20 61 20 72 61 63 65 20 63 6f 6e 64 69 74 69  s a race conditi
3150: 6f 6e 20 68 65 72 65 0a 20 20 69 6e 20 74 68 61  on here.  in tha
3160: 74 20 69 66 20 6f 6e 65 20 74 68 72 65 61 64 20  t if one thread 
3170: 69 73 20 63 6f 6e 73 74 61 6e 74 6c 79 20 63 68  is constantly ch
3180: 61 6e 67 69 6e 67 20 74 68 65 20 73 63 68 65 6d  anging the schem
3190: 61 2c 20 61 6e 6f 74 68 65 72 20 74 68 72 65 61  a, another threa
31a0: 64 0a 20 20 6d 69 67 68 74 20 73 70 69 6e 20 6f  d.  might spin o
31b0: 6e 20 72 65 70 61 72 73 65 73 20 61 6e 64 20 72  n reparses and r
31c0: 65 70 72 65 70 61 72 61 74 69 6f 6e 73 20 6f 66  epreparations of
31d0: 20 61 20 70 72 65 70 61 72 65 64 20 73 74 61 74   a prepared stat
31e0: 65 6d 65 6e 74 20 61 6e 64 0a 20 20 6e 65 76 65  ement and.  neve
31f0: 72 20 67 65 74 20 61 6e 79 20 72 65 61 6c 20 77  r get any real w
3200: 6f 72 6b 20 64 6f 6e 65 2e 20 20 54 68 69 73 20  ork done.  This 
3210: 70 61 72 61 6d 65 74 65 72 20 70 72 65 76 65 6e  parameter preven
3220: 74 73 20 61 6e 20 69 6e 66 69 6e 69 74 65 20 6c  ts an infinite l
3230: 6f 6f 70 0a 20 20 62 79 20 66 6f 72 63 69 6e 67  oop.  by forcing
3240: 20 74 68 65 20 73 70 69 6e 6e 69 6e 67 20 74 68   the spinning th
3250: 72 65 61 64 20 74 6f 20 67 69 76 65 20 75 70 20  read to give up 
3260: 61 66 74 65 72 20 61 20 66 69 78 65 64 20 6e 75  after a fixed nu
3270: 6d 62 65 72 20 6f 66 20 61 74 74 65 6d 70 74 73  mber of attempts
3280: 0a 20 20 61 74 20 72 65 63 6f 6d 70 69 6c 69 6e  .  at recompilin
3290: 67 20 74 68 65 20 70 72 65 70 61 72 65 64 20 73  g the prepared s
32a0: 74 61 74 65 6d 65 6e 74 2e 20 20 54 68 65 20 64  tatement.  The d
32b0: 65 66 61 75 6c 74 20 73 65 74 74 69 6e 67 20 69  efault setting i
32c0: 73 20 35 30 20 77 68 69 63 68 20 69 73 0a 20 20  s 50 which is.  
32d0: 6d 6f 72 65 20 74 68 61 6e 20 61 64 65 71 75 61  more than adequa
32e0: 74 65 20 66 6f 72 20 6d 6f 73 74 20 61 70 70 6c  te for most appl
32f0: 69 63 61 74 69 6f 6e 73 2e 0a 7d 0a 0a 43 4f 4d  ications..}..COM
3300: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c  PILE_OPTION {SQL
3310: 49 54 45 5f 4d 41 58 5f 57 4f 52 4b 45 52 5f 54  ITE_MAX_WORKER_T
3320: 48 52 45 41 44 53 3d 3c 69 3e 4e 3c 2f 69 3e 7d  HREADS=<i>N</i>}
3330: 20 7b 0a 20 20 53 65 74 20 61 6e 20 75 70 70 65   {.  Set an uppe
3340: 72 20 62 6f 75 6e 64 20 6f 6e 20 74 68 65 20 5b  r bound on the [
3350: 73 71 6c 69 74 65 33 5f 6c 69 6d 69 74 5d 28 64  sqlite3_limit](d
3360: 62 2c 5b 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f  b,[SQLITE_LIMIT_
3370: 57 4f 52 4b 45 52 5f 54 48 52 45 41 44 53 5d 2c  WORKER_THREADS],
3380: 4e 29 0a 20 20 73 65 74 74 69 6e 67 20 74 68 61  N).  setting tha
3390: 74 20 64 65 74 65 72 6d 69 6e 65 73 20 74 68 65  t determines the
33a0: 20 6d 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20   maximum number 
33b0: 6f 66 20 61 75 78 69 6c 69 61 72 79 20 74 68 72  of auxiliary thr
33c0: 65 61 64 73 20 74 68 61 74 20 61 20 73 69 6e 67  eads that a sing
33d0: 6c 65 0a 20 20 5b 70 72 65 70 61 72 65 64 20 73  le.  [prepared s
33e0: 74 61 74 65 6d 65 6e 74 5d 20 77 69 6c 6c 20 75  tatement] will u
33f0: 73 65 20 74 6f 20 61 69 64 20 77 69 74 68 20 43  se to aid with C
3400: 50 55 2d 69 6e 74 65 6e 73 69 76 65 20 63 6f 6d  PU-intensive com
3410: 70 75 74 61 74 69 6f 6e 73 0a 20 20 28 6d 6f 73  putations.  (mos
3420: 74 6c 79 20 73 6f 72 74 69 6e 67 29 2e 20 20 53  tly sorting).  S
3430: 65 65 20 61 6c 73 6f 20 74 68 65 20 5b 53 51 4c  ee also the [SQL
3440: 49 54 45 5f 44 45 46 41 55 4c 54 5f 57 4f 52 4b  ITE_DEFAULT_WORK
3450: 45 52 5f 54 48 52 45 41 44 53 5d 20 6f 70 74 69  ER_THREADS] opti
3460: 6f 6e 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f  ons..}..COMPILE_
3470: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4d  OPTION {SQLITE_M
3480: 49 4e 49 4d 55 4d 5f 46 49 4c 45 5f 44 45 53 43  INIMUM_FILE_DESC
3490: 52 49 50 54 4f 52 3d 3c 69 3e 4e 3c 2f 69 3e 7d  RIPTOR=<i>N</i>}
34a0: 20 7b 0a 20 20 54 68 65 20 75 6e 69 78 20 5b 56   {.  The unix [V
34b0: 46 53 5d 20 77 69 6c 6c 20 6e 65 76 65 72 20 75  FS] will never u
34c0: 73 65 20 61 20 66 69 6c 65 20 64 65 73 63 72 69  se a file descri
34d0: 70 74 6f 72 20 6c 65 73 73 20 74 68 61 6e 20 3c  ptor less than <
34e0: 69 3e 4e 3c 2f 69 3e 2e 20 20 54 68 65 0a 20 20  i>N</i>.  The.  
34f0: 64 65 66 61 75 6c 74 20 76 61 6c 75 65 20 6f 66  default value of
3500: 20 3c 69 3e 4e 3c 2f 69 3e 20 69 73 20 33 2e 0a   <i>N</i> is 3..
3510: 20 20 3c 70 3e 0a 20 20 41 76 6f 69 64 69 6e 67    <p>.  Avoiding
3520: 20 74 68 65 20 75 73 65 20 6f 66 20 6c 6f 77 2d   the use of low-
3530: 6e 75 6d 62 65 72 65 64 20 66 69 6c 65 20 64 65  numbered file de
3540: 73 63 72 69 70 74 6f 72 73 20 69 73 20 61 20 64  scriptors is a d
3550: 65 66 65 6e 73 65 20 61 67 61 69 6e 73 74 0a 20  efense against. 
3560: 20 61 63 63 69 64 65 6e 74 61 6c 20 64 61 74 61   accidental data
3570: 62 61 73 65 20 63 6f 72 72 75 70 74 69 6f 6e 2e  base corruption.
3580: 20 20 49 66 20 61 20 64 61 74 61 62 61 73 65 20    If a database 
3590: 66 69 6c 65 20 77 61 73 20 6f 70 65 6e 65 64 20  file was opened 
35a0: 75 73 69 6e 67 0a 20 20 66 69 6c 65 20 64 65 73  using.  file des
35b0: 63 72 69 70 74 6f 72 20 32 2c 20 66 6f 72 20 65  criptor 2, for e
35c0: 78 61 6d 70 6c 65 2c 20 61 6e 64 20 74 68 65 6e  xample, and then
35d0: 20 61 6e 20 61 73 73 65 72 74 28 29 20 66 61 69   an assert() fai
35e0: 6c 65 64 20 61 6e 64 20 69 6e 76 6f 6b 65 64 0a  led and invoked.
35f0: 20 20 77 72 69 74 65 28 32 2c 2e 2e 2e 29 2c 20    write(2,...), 
3600: 74 68 61 74 20 77 6f 75 6c 64 20 6c 69 6b 65 6c  that would likel
3610: 79 20 63 61 75 73 65 20 64 61 74 61 62 61 73 65  y cause database
3620: 20 63 6f 72 72 75 70 74 69 6f 6e 20 62 79 20 6f   corruption by o
3630: 76 65 72 77 72 69 74 69 6e 67 0a 20 20 70 61 72  verwriting.  par
3640: 74 20 6f 66 20 74 68 65 20 64 61 74 61 62 61 73  t of the databas
3650: 65 20 66 69 6c 65 20 77 69 74 68 20 74 68 65 20  e file with the 
3660: 61 73 73 65 72 74 69 6f 6e 20 65 72 72 6f 72 20  assertion error 
3670: 6d 65 73 73 61 67 65 2e 20 20 55 73 69 6e 67 20  message.  Using 
3680: 6f 6e 6c 79 0a 20 20 68 69 67 68 65 72 2d 76 61  only.  higher-va
3690: 6c 75 65 64 20 66 69 6c 65 20 64 65 73 63 72 69  lued file descri
36a0: 70 74 6f 72 73 20 61 76 6f 69 64 73 20 74 68 69  ptors avoids thi
36b0: 73 20 70 6f 74 65 6e 74 69 61 6c 20 70 72 6f 62  s potential prob
36c0: 6c 65 6d 2e 20 20 54 68 65 20 0a 20 20 70 72 6f  lem.  The .  pro
36d0: 74 65 63 74 69 6f 6e 20 61 67 61 69 6e 73 74 0a  tection against.
36e0: 20 20 75 73 69 6e 67 20 6c 6f 77 2d 6e 75 6d 62    using low-numb
36f0: 65 72 65 64 20 66 69 6c 65 20 64 65 73 63 72 69  ered file descri
3700: 70 74 6f 72 73 20 63 61 6e 20 62 65 20 64 69 73  ptors can be dis
3710: 61 62 6c 65 64 20 62 79 20 73 65 74 74 69 6e 67  abled by setting
3720: 20 74 68 69 73 0a 20 20 63 6f 6d 70 69 6c 65 2d   this.  compile-
3730: 74 69 6d 65 20 6f 70 74 69 6f 6e 20 74 6f 20 30  time option to 0
3740: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54  ..}..COMPILE_OPT
3750: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 50 4f 57 45  ION {SQLITE_POWE
3760: 52 53 41 46 45 5f 4f 56 45 52 57 52 49 54 45 3d  RSAFE_OVERWRITE=
3770: 3c 69 3e 26 6c 74 3b 30 20 6f 72 20 31 26 67 74  <i>&lt;0 or 1&gt
3780: 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 69 73 20  ;</i>} {.  This 
3790: 6f 70 74 69 6f 6e 20 63 68 61 6e 67 65 73 20 74  option changes t
37a0: 68 65 20 64 65 66 61 75 6c 74 20 61 73 73 75 6d  he default assum
37b0: 70 74 69 6f 6e 20 61 62 6f 75 74 20 5b 70 6f 77  ption about [pow
37c0: 65 72 73 61 66 65 20 6f 76 65 72 77 72 69 74 65  ersafe overwrite
37d0: 5d 0a 20 20 66 6f 72 20 74 68 65 20 75 6e 64 65  ].  for the unde
37e0: 72 6c 79 69 6e 67 20 66 69 6c 65 73 79 73 74 65  rlying filesyste
37f0: 6d 73 20 66 6f 72 20 74 68 65 20 75 6e 69 78 20  ms for the unix 
3800: 61 6e 64 20 77 69 6e 64 6f 77 73 20 5b 56 46 53  and windows [VFS
3810: 65 73 5d 2e 0a 20 20 53 65 74 74 69 6e 67 20 53  es]..  Setting S
3820: 51 4c 49 54 45 5f 50 4f 57 45 52 53 41 46 45 5f  QLITE_POWERSAFE_
3830: 4f 56 45 52 57 52 49 54 45 20 74 6f 20 31 20 63  OVERWRITE to 1 c
3840: 61 75 73 65 73 20 53 51 4c 69 74 65 20 74 6f 20  auses SQLite to 
3850: 61 73 73 75 6d 65 20 74 68 61 74 0a 20 20 61 70  assume that.  ap
3860: 70 6c 69 63 61 74 69 6f 6e 2d 6c 65 76 65 6c 20  plication-level 
3870: 77 72 69 74 65 73 20 63 61 6e 6e 6f 74 20 63 68  writes cannot ch
3880: 61 6e 67 65 73 20 62 79 74 65 73 20 6f 75 74 73  anges bytes outs
3890: 69 64 65 20 74 68 65 20 72 61 6e 67 65 20 6f 66  ide the range of
38a0: 0a 20 20 62 79 74 65 73 20 77 72 69 74 74 65 6e  .  bytes written
38b0: 20 65 76 65 6e 20 69 66 20 74 68 65 20 77 72 69   even if the wri
38c0: 74 65 20 6f 63 63 75 72 73 20 6a 75 73 74 20 62  te occurs just b
38d0: 65 66 6f 72 65 20 61 20 70 6f 77 65 72 20 6c 6f  efore a power lo
38e0: 73 73 2e 0a 20 20 57 69 74 68 20 53 51 4c 49 54  ss..  With SQLIT
38f0: 45 5f 50 4f 57 45 52 53 41 46 45 5f 4f 56 45 52  E_POWERSAFE_OVER
3900: 57 52 49 54 45 20 73 65 74 20 74 6f 20 30 2c 20  WRITE set to 0, 
3910: 53 51 4c 69 74 65 20 61 73 73 75 6d 65 73 20 74  SQLite assumes t
3920: 68 61 74 20 6f 74 68 65 72 0a 20 20 62 79 74 65  hat other.  byte
3930: 73 20 69 6e 20 74 68 65 20 73 61 6d 65 20 73 65  s in the same se
3940: 63 74 6f 72 20 77 69 74 68 20 61 20 77 72 69 74  ctor with a writ
3950: 74 65 6e 20 62 79 74 65 20 6d 69 67 68 74 20 62  ten byte might b
3960: 65 20 63 68 61 6e 67 65 64 20 6f 72 20 0a 20 20  e changed or .  
3970: 64 61 6d 61 67 65 64 20 62 79 20 61 20 70 6f 77  damaged by a pow
3980: 65 72 20 6c 6f 73 73 2e 0a 7d 0a 0a 43 4f 4d 50  er loss..}..COMP
3990: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49  ILE_OPTION {SQLI
39a0: 54 45 5f 52 45 56 45 52 53 45 5f 55 4e 4f 52 44  TE_REVERSE_UNORD
39b0: 45 52 45 44 5f 53 45 4c 45 43 54 53 7d 20 7b 0a  ERED_SELECTS} {.
39c0: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 61    This option ca
39d0: 75 73 65 73 20 74 68 65 20 5b 50 52 41 47 4d 41  uses the [PRAGMA
39e0: 20 72 65 76 65 72 73 65 5f 75 6e 6f 72 64 65 72   reverse_unorder
39f0: 65 64 5f 73 65 6c 65 63 74 73 5d 20 73 65 74 74  ed_selects] sett
3a00: 69 6e 67 20 74 6f 20 62 65 0a 20 20 65 6e 61 62  ing to be.  enab
3a10: 6c 65 64 20 62 79 20 64 65 66 61 75 6c 74 2e 20  led by default. 
3a20: 20 57 68 65 6e 20 65 6e 61 62 6c 65 64 2c 20 5b   When enabled, [
3a30: 53 45 4c 45 43 54 5d 20 73 74 61 74 65 6d 65 6e  SELECT] statemen
3a40: 74 73 20 74 68 61 74 20 6c 61 63 6b 20 61 6e 0a  ts that lack an.
3a50: 20 20 4f 52 44 45 52 20 42 59 20 63 6c 61 75 73    ORDER BY claus
3a60: 65 20 77 69 6c 6c 20 72 75 6e 20 69 6e 20 72 65  e will run in re
3a70: 76 65 72 73 65 20 6f 72 64 65 72 2e 3c 70 3e 0a  verse order.<p>.
3a80: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 69 73    This option is
3a90: 20 75 73 65 66 75 6c 20 66 6f 72 20 64 65 74 65   useful for dete
3aa0: 63 74 69 6e 67 20 77 68 65 6e 20 61 70 70 6c 69  cting when appli
3ab0: 63 61 74 69 6f 6e 73 20 28 69 6e 63 6f 72 72 65  cations (incorre
3ac0: 63 74 6c 79 29 0a 20 20 61 73 73 75 6d 65 20 74  ctly).  assume t
3ad0: 68 61 74 20 74 68 65 20 6f 72 64 65 72 20 6f 66  hat the order of
3ae0: 20 72 6f 77 73 20 69 6e 20 61 20 53 45 4c 45 43   rows in a SELEC
3af0: 54 20 77 69 74 68 6f 75 74 20 61 6e 20 4f 52 44  T without an ORD
3b00: 45 52 20 42 59 20 63 6c 61 75 73 65 0a 20 20 77  ER BY clause.  w
3b10: 69 6c 6c 20 61 6c 77 61 79 73 20 62 65 20 74 68  ill always be th
3b20: 65 20 73 61 6d 65 2e 0a 7d 0a 0a 43 4f 4d 50 49  e same..}..COMPI
3b30: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54  LE_OPTION {SQLIT
3b40: 45 5f 53 4f 52 54 45 52 5f 50 4d 41 53 5a 3d 3c  E_SORTER_PMASZ=<
3b50: 69 3e 4e 3c 2f 69 3e 7d 20 7b 0a 20 20 49 66 20  i>N</i>} {.  If 
3b60: 6d 75 6c 74 69 2d 74 68 72 65 61 64 65 64 20 70  multi-threaded p
3b70: 72 6f 63 65 73 73 69 6e 67 20 69 73 20 65 6e 61  rocessing is ena
3b80: 62 6c 65 64 20 76 69 61 20 74 68 65 0a 20 20 5b  bled via the.  [
3b90: 50 52 41 47 4d 41 20 74 68 72 65 61 64 73 5d 20  PRAGMA threads] 
3ba0: 73 65 74 74 69 6e 67 2c 20 74 68 65 6e 20 73 6f  setting, then so
3bb0: 72 74 20 6f 70 65 72 61 74 69 6f 6e 73 20 77 69  rt operations wi
3bc0: 6c 6c 0a 20 20 61 74 74 65 6d 70 74 20 74 6f 20  ll.  attempt to 
3bd0: 73 74 61 72 74 20 68 65 6c 70 65 72 20 74 68 72  start helper thr
3be0: 65 61 64 73 20 77 68 65 6e 20 74 68 65 20 61 6d  eads when the am
3bf0: 6f 75 6e 74 20 6f 66 20 63 6f 6e 74 65 6e 74 0a  ount of content.
3c00: 20 20 74 6f 20 62 65 20 73 6f 72 74 65 64 20 65    to be sorted e
3c10: 78 63 65 65 64 73 20 74 68 65 20 6d 69 6e 69 6d  xceeds the minim
3c20: 75 6d 20 6f 66 20 74 68 65 20 5b 63 61 63 68 65  um of the [cache
3c30: 5f 73 69 7a 65 5d 20 61 6e 64 20 50 4d 41 20 53  _size] and PMA S
3c40: 69 7a 65 0a 20 20 64 65 74 65 72 6d 69 6e 65 64  ize.  determined
3c50: 20 62 79 20 74 68 65 20 5b 53 51 4c 49 54 45 5f   by the [SQLITE_
3c60: 43 4f 4e 46 49 47 5f 50 4d 41 53 5a 5d 20 73 74  CONFIG_PMASZ] st
3c70: 61 72 74 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 2e  art-time option.
3c80: 0a 20 20 54 68 69 73 20 63 6f 6d 70 69 6c 65 2d  .  This compile-
3c90: 74 69 6d 65 20 6f 70 74 69 6f 6e 20 73 65 74 73  time option sets
3ca0: 20 74 68 65 20 64 65 66 61 75 6c 74 20 76 61 6c   the default val
3cb0: 75 65 20 66 6f 72 20 74 68 65 0a 20 20 5b 53 51  ue for the.  [SQ
3cc0: 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 4d 41 53  LITE_CONFIG_PMAS
3cd0: 5a 5d 20 73 74 61 72 74 2d 74 69 6d 65 20 6f 70  Z] start-time op
3ce0: 74 69 6f 6e 2e 0a 20 20 54 68 65 20 64 65 66 61  tion..  The defa
3cf0: 75 6c 74 20 76 61 6c 75 65 20 69 73 20 32 35 30  ult value is 250
3d00: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54  ..}..COMPILE_OPT
3d10: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 57 49 4e 33  ION {SQLITE_WIN3
3d20: 32 5f 4d 41 4c 4c 4f 43 7d 20 7b 0a 20 20 54 68  2_MALLOC} {.  Th
3d30: 69 73 20 6f 70 74 69 6f 6e 20 65 6e 61 62 6c 65  is option enable
3d40: 73 20 74 68 65 20 75 73 65 20 6f 66 20 74 68 65  s the use of the
3d50: 20 57 69 6e 64 6f 77 73 20 48 65 61 70 20 41 50   Windows Heap AP
3d60: 49 20 66 75 6e 63 74 69 6f 6e 73 20 66 6f 72 20  I functions for 
3d70: 6d 65 6d 6f 72 79 0a 20 20 61 6c 6c 6f 63 61 74  memory.  allocat
3d80: 69 6f 6e 20 69 6e 73 74 65 61 64 20 6f 66 20 74  ion instead of t
3d90: 68 65 20 73 74 61 6e 64 61 72 64 20 6c 69 62 72  he standard libr
3da0: 61 72 79 20 6d 61 6c 6c 6f 63 28 29 20 61 6e 64  ary malloc() and
3db0: 20 66 72 65 65 28 29 20 72 6f 75 74 69 6e 65 73   free() routines
3dc0: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54  ..}..COMPILE_OPT
3dd0: 49 4f 4e 20 7b 59 59 53 54 41 43 4b 44 45 50 54  ION {YYSTACKDEPT
3de0: 48 3d 3c 69 3e 26 6c 74 3b 6d 61 78 5f 64 65 70  H=<i>&lt;max_dep
3df0: 74 68 26 67 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20  th&gt;</i>} {.  
3e00: 54 68 69 73 20 6d 61 63 72 6f 20 73 65 74 73 20  This macro sets 
3e10: 74 68 65 20 6d 61 78 69 6d 75 6d 20 64 65 70 74  the maximum dept
3e20: 68 20 6f 66 20 74 68 65 20 4c 41 4c 52 28 31 29  h of the LALR(1)
3e30: 20 73 74 61 63 6b 20 75 73 65 64 20 62 79 0a 20   stack used by. 
3e40: 20 74 68 65 20 53 51 4c 20 70 61 72 73 65 72 20   the SQL parser 
3e50: 77 69 74 68 69 6e 20 53 51 4c 69 74 65 2e 20 20  within SQLite.  
3e60: 54 68 65 20 64 65 66 61 75 6c 74 20 76 61 6c 75  The default valu
3e70: 65 20 69 73 20 31 30 30 2e 20 20 41 20 74 79 70  e is 100.  A typ
3e80: 69 63 61 6c 0a 20 20 61 70 70 6c 69 63 61 74 69  ical.  applicati
3e90: 6f 6e 20 77 69 6c 6c 20 75 73 65 20 6c 65 73 73  on will use less
3ea0: 20 74 68 61 6e 20 61 62 6f 75 74 20 32 30 20 6c   than about 20 l
3eb0: 65 76 65 6c 73 20 6f 66 20 74 68 65 20 73 74 61  evels of the sta
3ec0: 63 6b 2e 0a 20 20 44 65 76 65 6c 6f 70 65 72 73  ck..  Developers
3ed0: 20 77 68 6f 73 65 20 61 70 70 6c 69 63 61 74 69   whose applicati
3ee0: 6f 6e 73 20 63 6f 6e 74 61 69 6e 20 53 51 4c 20  ons contain SQL 
3ef0: 73 74 61 74 65 6d 65 6e 74 73 20 74 68 61 74 20  statements that 
3f00: 0a 20 20 6e 65 65 64 20 6d 6f 72 65 20 74 68 61  .  need more tha
3f10: 6e 20 31 30 30 20 4c 41 4c 52 28 31 29 20 73 74  n 100 LALR(1) st
3f20: 61 63 6b 20 65 6e 74 72 69 65 73 20 73 68 6f 75  ack entries shou
3f30: 6c 64 20 73 65 72 69 6f 75 73 6c 79 0a 20 20 63  ld seriously.  c
3f40: 6f 6e 73 69 64 65 72 20 72 65 66 61 63 74 6f 72  onsider refactor
3f50: 69 6e 67 20 74 68 65 69 72 20 53 51 4c 20 61 73  ing their SQL as
3f60: 20 69 74 20 69 73 20 6c 69 6b 65 6c 79 20 74 6f   it is likely to
3f70: 20 62 65 20 77 65 6c 6c 20 62 65 79 6f 6e 64 0a   be well beyond.
3f80: 20 20 74 68 65 20 61 62 69 6c 69 74 79 20 6f 66    the ability of
3f90: 20 61 6e 79 20 68 75 6d 61 6e 20 74 6f 20 63 6f   any human to co
3fa0: 6d 70 72 65 68 65 6e 64 2e 0a 7d 0a 3c 2f 74 63  mprehend..}.</tc
3fb0: 6c 3e 0a 0a 3c 68 32 3e 31 2e 33 20 4f 70 74 69  l>..<h2>1.3 Opti
3fc0: 6f 6e 73 20 54 6f 20 53 65 74 20 53 69 7a 65 20  ons To Set Size 
3fd0: 4c 69 6d 69 74 73 3c 2f 68 32 3e 0a 0a 3c 70 3e  Limits</h2>..<p>
3fe0: 54 68 65 72 65 20 61 72 65 20 63 6f 6d 70 69 6c  There are compil
3ff0: 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 73 20 74  e-time options t
4000: 68 61 74 20 77 69 6c 6c 20 73 65 74 20 75 70 70  hat will set upp
4010: 65 72 20 62 6f 75 6e 64 73 0a 6f 6e 20 74 68 65  er bounds.on the
4020: 20 73 69 7a 65 73 20 6f 66 20 76 61 72 69 6f 75   sizes of variou
4030: 73 20 73 74 72 75 63 74 75 72 65 73 20 69 6e 20  s structures in 
4040: 53 51 4c 69 74 65 2e 20 20 54 68 65 20 63 6f 6d  SQLite.  The com
4050: 70 69 6c 65 2d 74 69 6d 65 0a 6f 70 74 69 6f 6e  pile-time.option
4060: 73 20 6e 6f 72 6d 61 6c 6c 79 20 73 65 74 20 61  s normally set a
4070: 20 68 61 72 64 20 75 70 70 65 72 20 62 6f 75 6e   hard upper boun
4080: 64 20 74 68 61 74 20 63 61 6e 20 62 65 20 63 68  d that can be ch
4090: 61 6e 67 65 64 0a 61 74 20 72 75 6e 2d 74 69 6d  anged.at run-tim
40a0: 65 20 6f 6e 20 69 6e 64 69 76 69 64 75 61 6c 20  e on individual 
40b0: 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63  [database connec
40c0: 74 69 6f 6e 73 5d 20 75 73 69 6e 67 20 74 68 65  tions] using the
40d0: 0a 5b 73 71 6c 69 74 65 33 5f 6c 69 6d 69 74 28  .[sqlite3_limit(
40e0: 29 5d 20 69 6e 74 65 72 66 61 63 65 2e 3c 2f 70  )] interface.</p
40f0: 3e 0a 0a 3c 70 3e 54 68 65 20 63 6f 6d 70 69 6c  >..<p>The compil
4100: 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 73 20 66  e-time options f
4110: 6f 72 20 73 65 74 74 69 6e 67 20 75 70 70 65 72  or setting upper
4120: 20 62 6f 75 6e 64 73 20 61 72 65 0a 5b 6c 69 6d   bounds are.[lim
4130: 69 74 73 20 7c 20 64 6f 63 75 6d 65 6e 74 65 64  its | documented
4140: 20 73 65 70 61 72 61 74 65 6c 79 5d 2e 20 20 54   separately].  T
4150: 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 69 73 20  he following is 
4160: 61 20 6c 69 73 74 20 6f 66 0a 74 68 65 20 61 76  a list of.the av
4170: 61 69 6c 61 62 6c 65 20 73 65 74 74 69 6e 67 73  ailable settings
4180: 3a 3c 2f 70 3e 0a 0a 3c 75 6c 3e 0a 3c 6c 69 3e  :</p>..<ul>.<li>
4190: 20 5b 53 51 4c 49 54 45 5f 4d 41 58 5f 41 54 54   [SQLITE_MAX_ATT
41a0: 41 43 48 45 44 5d 20 20 3c 2f 6c 69 3e 0a 3c 6c  ACHED]  </li>.<l
41b0: 69 3e 20 5b 53 51 4c 49 54 45 5f 4d 41 58 5f 43  i> [SQLITE_MAX_C
41c0: 4f 4c 55 4d 4e 5d 20 20 3c 2f 6c 69 3e 0a 3c 6c  OLUMN]  </li>.<l
41d0: 69 3e 20 5b 53 51 4c 49 54 45 5f 4d 41 58 5f 43  i> [SQLITE_MAX_C
41e0: 4f 4d 50 4f 55 4e 44 5f 53 45 4c 45 43 54 5d 20  OMPOUND_SELECT] 
41f0: 20 3c 2f 6c 69 3e 0a 3c 6c 69 3e 20 5b 53 51 4c   </li>.<li> [SQL
4200: 49 54 45 5f 4d 41 58 5f 45 58 50 52 5f 44 45 50  ITE_MAX_EXPR_DEP
4210: 54 48 5d 20 20 3c 2f 6c 69 3e 0a 3c 6c 69 3e 20  TH]  </li>.<li> 
4220: 5b 53 51 4c 49 54 45 5f 4d 41 58 5f 46 55 4e 43  [SQLITE_MAX_FUNC
4230: 54 49 4f 4e 5f 41 52 47 5d 20 20 3c 2f 6c 69 3e  TION_ARG]  </li>
4240: 0a 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4d 41  .<li> [SQLITE_MA
4250: 58 5f 4c 45 4e 47 54 48 5d 20 20 3c 2f 6c 69 3e  X_LENGTH]  </li>
4260: 0a 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4d 41  .<li> [SQLITE_MA
4270: 58 5f 4c 49 4b 45 5f 50 41 54 54 45 52 4e 5f 4c  X_LIKE_PATTERN_L
4280: 45 4e 47 54 48 5d 20 20 3c 2f 6c 69 3e 0a 3c 6c  ENGTH]  </li>.<l
4290: 69 3e 20 5b 53 51 4c 49 54 45 5f 4d 41 58 5f 50  i> [SQLITE_MAX_P
42a0: 41 47 45 5f 43 4f 55 4e 54 5d 20 20 3c 2f 6c 69  AGE_COUNT]  </li
42b0: 3e 0a 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4d  >.<li> [SQLITE_M
42c0: 41 58 5f 53 51 4c 5f 4c 45 4e 47 54 48 5d 20 20  AX_SQL_LENGTH]  
42d0: 3c 2f 6c 69 3e 0a 3c 6c 69 3e 20 5b 53 51 4c 49  </li>.<li> [SQLI
42e0: 54 45 5f 4d 41 58 5f 56 41 52 49 41 42 4c 45 5f  TE_MAX_VARIABLE_
42f0: 4e 55 4d 42 45 52 5d 20 20 3c 2f 6c 69 3e 0a 3c  NUMBER]  </li>.<
4300: 2f 75 6c 3e 0a 0a 3c 61 20 6e 61 6d 65 3d 22 63  /ul>..<a name="c
4310: 6f 6e 74 72 6f 6c 66 65 61 74 75 72 65 73 22 3e  ontrolfeatures">
4320: 3c 2f 61 3e 0a 3c 68 32 3e 31 2e 34 20 4f 70 74  </a>.<h2>1.4 Opt
4330: 69 6f 6e 73 20 54 6f 20 43 6f 6e 74 72 6f 6c 20  ions To Control 
4340: 4f 70 65 72 61 74 69 6e 67 20 43 68 61 72 61 63  Operating Charac
4350: 74 65 72 69 73 74 69 63 73 3c 2f 68 32 3e 0a 0a  teristics</h2>..
4360: 3c 74 63 6c 3e 0a 43 4f 4d 50 49 4c 45 5f 4f 50  <tcl>.COMPILE_OP
4370: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 34 5f 42  TION {SQLITE_4_B
4380: 59 54 45 5f 41 4c 49 47 4e 45 44 5f 4d 41 4c 4c  YTE_ALIGNED_MALL
4390: 4f 43 7d 20 7b 0a 20 20 4f 6e 20 6d 6f 73 74 20  OC} {.  On most 
43a0: 73 79 73 74 65 6d 73 2c 20 74 68 65 20 6d 61 6c  systems, the mal
43b0: 6c 6f 63 28 29 20 73 79 73 74 65 6d 20 63 61 6c  loc() system cal
43c0: 6c 20 72 65 74 75 72 6e 73 20 61 20 62 75 66 66  l returns a buff
43d0: 65 72 20 74 68 61 74 20 69 73 0a 20 20 61 6c 69  er that is.  ali
43e0: 67 6e 65 64 20 74 6f 20 61 6e 20 38 2d 62 79 74  gned to an 8-byt
43f0: 65 20 62 6f 75 6e 64 61 72 79 2e 20 20 42 75 74  e boundary.  But
4400: 20 6f 6e 20 73 6f 6d 65 20 73 79 73 74 65 6d 73   on some systems
4410: 20 28 65 78 3a 20 77 69 6e 64 6f 77 73 29 20 6d   (ex: windows) m
4420: 61 6c 6c 6f 63 28 29 0a 20 20 72 65 74 75 72 6e  alloc().  return
4430: 73 20 34 2d 62 79 74 65 20 61 6c 69 67 6e 65 64  s 4-byte aligned
4440: 20 70 6f 69 6e 74 65 72 2e 20 20 54 68 69 73 20   pointer.  This 
4450: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
4460: 69 6f 6e 20 6d 75 73 74 20 62 65 20 75 73 65 64  ion must be used
4470: 0a 20 20 6f 6e 20 73 79 73 74 65 6d 73 20 74 68  .  on systems th
4480: 61 74 20 72 65 74 75 72 6e 20 34 2d 62 79 74 65  at return 4-byte
4490: 20 61 6c 69 67 6e 65 64 20 70 6f 69 6e 74 65 72   aligned pointer
44a0: 73 20 66 72 6f 6d 20 6d 61 6c 6c 6f 63 28 29 2e  s from malloc().
44b0: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49  .}..COMPILE_OPTI
44c0: 4f 4e 20 7b 53 51 4c 49 54 45 5f 43 41 53 45 5f  ON {SQLITE_CASE_
44d0: 53 45 4e 53 49 54 49 56 45 5f 4c 49 4b 45 7d 20  SENSITIVE_LIKE} 
44e0: 7b 0a 20 20 49 66 20 74 68 69 73 20 6f 70 74 69  {.  If this opti
44f0: 6f 6e 20 69 73 20 70 72 65 73 65 6e 74 2c 20 74  on is present, t
4500: 68 65 6e 20 74 68 65 20 62 75 69 6c 74 2d 69 6e  hen the built-in
4510: 20 5b 4c 49 4b 45 5d 20 6f 70 65 72 61 74 6f 72   [LIKE] operator
4520: 20 77 69 6c 6c 20 62 65 0a 20 20 63 61 73 65 20   will be.  case 
4530: 73 65 6e 73 69 74 69 76 65 2e 20 20 54 68 69 73  sensitive.  This
4540: 20 73 61 6d 65 20 65 66 66 65 63 74 20 63 61 6e   same effect can
4550: 20 62 65 20 61 63 68 69 65 76 65 64 20 61 74 20   be achieved at 
4560: 72 75 6e 2d 74 69 6d 65 20 75 73 69 6e 67 0a 20  run-time using. 
4570: 20 74 68 65 20 5b 63 61 73 65 5f 73 65 6e 73 69   the [case_sensi
4580: 74 69 76 65 5f 6c 69 6b 65 20 70 72 61 67 6d 61  tive_like pragma
4590: 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50  ]..}..COMPILE_OP
45a0: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 49 52  TION {SQLITE_DIR
45b0: 45 43 54 5f 4f 56 45 52 46 4c 4f 57 5f 52 45 41  ECT_OVERFLOW_REA
45c0: 44 7d 20 7b 0a 20 20 57 68 65 6e 20 74 68 69 73  D} {.  When this
45d0: 20 6f 70 74 69 6f 6e 20 69 73 20 70 72 65 73 65   option is prese
45e0: 6e 74 2c 20 63 6f 6e 74 65 6e 74 20 63 6f 6e 74  nt, content cont
45f0: 61 69 6e 65 64 20 69 6e 0a 20 20 5b 6f 76 65 72  ained in.  [over
4600: 66 6c 6f 77 20 70 61 67 65 73 5d 20 6f 66 20 74  flow pages] of t
4610: 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65  he database file
4620: 20 69 73 20 72 65 61 64 20 64 69 72 65 63 74 6c   is read directl
4630: 79 20 66 72 6f 6d 20 64 69 73 6b 2c 0a 20 20 62  y from disk,.  b
4640: 79 70 61 73 73 69 6e 67 20 74 68 65 20 5b 70 61  ypassing the [pa
4650: 67 65 20 63 61 63 68 65 5d 2c 20 64 75 72 69 6e  ge cache], durin
4660: 67 20 72 65 61 64 20 74 72 61 6e 73 61 63 74 69  g read transacti
4670: 6f 6e 73 2e 20 20 49 6e 20 61 70 70 6c 69 63 61  ons.  In applica
4680: 74 69 6f 6e 73 0a 20 20 74 68 61 74 20 64 6f 20  tions.  that do 
4690: 61 20 6c 6f 74 20 6f 66 20 72 65 61 64 73 20 6f  a lot of reads o
46a0: 66 20 6c 61 72 67 65 20 42 4c 4f 42 73 2c 20 74  f large BLOBs, t
46b0: 68 69 73 20 6f 70 74 69 6f 6e 20 6d 69 67 68 74  his option might
46c0: 20 69 6d 70 72 6f 76 65 20 72 65 61 64 0a 20 20   improve read.  
46d0: 70 65 72 66 6f 72 6d 61 6e 63 65 2e 0a 7d 0a 0a  performance..}..
46e0: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b  COMPILE_OPTION {
46f0: 53 51 4c 49 54 45 5f 48 41 56 45 5f 49 53 4e 41  SQLITE_HAVE_ISNA
4700: 4e 7d 20 7b 0a 20 20 49 66 20 74 68 69 73 20 6f  N} {.  If this o
4710: 70 74 69 6f 6e 20 69 73 20 70 72 65 73 65 6e 74  ption is present
4720: 2c 20 74 68 65 6e 20 53 51 4c 69 74 65 20 77 69  , then SQLite wi
4730: 6c 6c 20 75 73 65 20 74 68 65 20 69 73 6e 61 6e  ll use the isnan
4740: 28 29 20 66 75 6e 63 74 69 6f 6e 20 66 72 6f 6d  () function from
4750: 0a 20 20 74 68 65 20 73 79 73 74 65 6d 20 6d 61  .  the system ma
4760: 74 68 20 6c 69 62 72 61 72 79 2e 20 20 54 68 69  th library.  Thi
4770: 73 20 69 73 20 61 6e 20 61 6c 69 61 73 20 66 6f  s is an alias fo
4780: 72 20 74 68 65 20 5b 48 41 56 45 5f 49 53 4e 41  r the [HAVE_ISNA
4790: 4e 5d 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e  N] configuration
47a0: 0a 20 20 6f 70 74 69 6f 6e 2e 0a 7d 0a 0a 43 4f  .  option..}..CO
47b0: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51  MPILE_OPTION {SQ
47c0: 4c 49 54 45 5f 4f 53 5f 4f 54 48 45 52 3d 3c 69  LITE_OS_OTHER=<i
47d0: 3e 26 6c 74 3b 30 20 6f 72 20 31 26 67 74 3b 3c  >&lt;0 or 1&gt;<
47e0: 2f 69 3e 7d 20 7b 0a 20 20 54 68 65 20 6f 70 74  /i>} {.  The opt
47f0: 69 6f 6e 20 63 61 75 73 65 73 20 53 51 4c 69 74  ion causes SQLit
4800: 65 20 74 6f 20 6f 6d 69 74 20 69 74 73 20 62 75  e to omit its bu
4810: 69 6c 74 2d 69 6e 20 6f 70 65 72 61 74 69 6e 67  ilt-in operating
4820: 20 73 79 73 74 65 6d 20 69 6e 74 65 72 66 61 63   system interfac
4830: 65 73 0a 20 20 66 6f 72 20 55 6e 69 78 2c 20 57  es.  for Unix, W
4840: 69 6e 64 6f 77 73 2c 20 61 6e 64 20 4f 53 2f 32  indows, and OS/2
4850: 2e 20 20 54 68 65 20 72 65 73 75 6c 74 69 6e 67  .  The resulting
4860: 20 6c 69 62 72 61 72 79 20 77 69 6c 6c 20 68 61   library will ha
4870: 76 65 20 6e 6f 20 64 65 66 61 75 6c 74 0a 20 20  ve no default.  
4880: 5b 73 71 6c 69 74 65 33 5f 76 66 73 20 7c 20 6f  [sqlite3_vfs | o
4890: 70 65 72 61 74 69 6e 67 20 73 79 73 74 65 6d 20  perating system 
48a0: 69 6e 74 65 72 66 61 63 65 5d 2e 20 20 41 70 70  interface].  App
48b0: 6c 69 63 61 74 69 6f 6e 73 20 6d 75 73 74 20 75  lications must u
48c0: 73 65 0a 20 20 5b 73 71 6c 69 74 65 33 5f 76 66  se.  [sqlite3_vf
48d0: 73 5f 72 65 67 69 73 74 65 72 28 29 5d 20 74 6f  s_register()] to
48e0: 20 72 65 67 69 73 74 65 72 20 61 6e 20 61 70 70   register an app
48f0: 72 6f 70 72 69 61 74 65 20 69 6e 74 65 72 66 61  ropriate interfa
4900: 63 65 20 62 65 66 6f 72 65 0a 20 20 75 73 69 6e  ce before.  usin
4910: 67 20 53 51 4c 69 74 65 2e 20 20 41 70 70 6c 69  g SQLite.  Appli
4920: 63 61 74 69 6f 6e 73 20 6d 75 73 74 20 61 6c 73  cations must als
4930: 6f 20 73 75 70 70 6c 79 20 69 6d 70 6c 65 6d 65  o supply impleme
4940: 6e 74 61 74 69 6f 6e 73 20 66 6f 72 20 74 68 65  ntations for the
4950: 0a 20 20 5b 73 71 6c 69 74 65 33 5f 6f 73 5f 69  .  [sqlite3_os_i
4960: 6e 69 74 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69  nit()] and [sqli
4970: 74 65 33 5f 6f 73 5f 65 6e 64 28 29 5d 20 69 6e  te3_os_end()] in
4980: 74 65 72 66 61 63 65 73 2e 20 20 54 68 65 20 75  terfaces.  The u
4990: 73 75 61 6c 20 70 72 61 63 74 69 63 65 0a 20 20  sual practice.  
49a0: 69 73 20 66 6f 72 20 74 68 65 20 73 75 70 70 6c  is for the suppl
49b0: 69 65 64 20 5b 73 71 6c 69 74 65 33 5f 6f 73 5f  ied [sqlite3_os_
49c0: 69 6e 69 74 28 29 5d 20 74 6f 20 69 6e 76 6f 6b  init()] to invok
49d0: 65 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5f 72  e [sqlite3_vfs_r
49e0: 65 67 69 73 74 65 72 28 29 5d 2e 0a 20 20 53 51  egister()]..  SQ
49f0: 4c 69 74 65 20 77 69 6c 6c 20 61 75 74 6f 6d 61  Lite will automa
4a00: 74 69 63 61 6c 6c 79 20 69 6e 76 6f 6b 65 20 5b  tically invoke [
4a10: 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e 69 74 28  sqlite3_os_init(
4a20: 29 5d 20 77 68 65 6e 20 69 74 20 69 6e 69 74 69  )] when it initi
4a30: 61 6c 69 7a 65 73 2e 0a 0a 20 20 54 68 69 73 20  alizes...  This 
4a40: 6f 70 74 69 6f 6e 20 69 73 20 74 79 70 69 63 61  option is typica
4a50: 6c 6c 79 20 75 73 65 64 20 77 68 65 6e 20 62 75  lly used when bu
4a60: 69 6c 64 69 6e 67 20 53 51 4c 69 74 65 20 66 6f  ilding SQLite fo
4a70: 72 20 61 6e 20 65 6d 62 65 64 64 65 64 0a 20 20  r an embedded.  
4a80: 70 6c 61 74 66 6f 72 6d 20 77 69 74 68 20 61 20  platform with a 
4a90: 63 75 73 74 6f 6d 20 6f 70 65 72 61 74 69 6e 67  custom operating
4aa0: 20 73 79 73 74 65 6d 2e 0a 7d 0a 0a 43 4f 4d 50   system..}..COMP
4ab0: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49  ILE_OPTION {SQLI
4ac0: 54 45 5f 53 45 43 55 52 45 5f 44 45 4c 45 54 45  TE_SECURE_DELETE
4ad0: 7d 20 7b 0a 20 20 54 68 69 73 20 63 6f 6d 70 69  } {.  This compi
4ae0: 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20 63  le-time option c
4af0: 68 61 6e 67 65 73 20 74 68 65 20 64 65 66 61 75  hanges the defau
4b00: 6c 74 20 73 65 74 74 69 6e 67 20 6f 66 20 74 68  lt setting of th
4b10: 65 0a 20 20 5b 73 65 63 75 72 65 5f 64 65 6c 65  e.  [secure_dele
4b20: 74 65 20 70 72 61 67 6d 61 5d 2e 20 20 57 68 65  te pragma].  Whe
4b30: 6e 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73  n this option is
4b40: 20 6e 6f 74 20 75 73 65 64 2c 20 73 65 63 75 72   not used, secur
4b50: 65 5f 64 65 6c 65 74 65 20 64 65 66 61 75 6c 74  e_delete default
4b60: 73 0a 20 20 74 6f 20 6f 66 66 2e 20 20 57 68 65  s.  to off.  Whe
4b70: 6e 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73  n this option is
4b80: 20 70 72 65 73 65 6e 74 2c 20 73 65 63 75 72 65   present, secure
4b90: 5f 64 65 6c 65 74 65 20 64 65 66 61 75 6c 74 73  _delete defaults
4ba0: 20 74 6f 20 6f 6e 2e 0a 0a 20 20 54 68 65 20 73   to on...  The s
4bb0: 65 63 75 72 65 5f 64 65 6c 65 74 65 20 73 65 74  ecure_delete set
4bc0: 74 69 6e 67 20 63 61 75 73 65 73 20 64 65 6c 65  ting causes dele
4bd0: 74 65 64 20 63 6f 6e 74 65 6e 74 20 74 6f 20 62  ted content to b
4be0: 65 20 6f 76 65 72 77 72 69 74 74 65 6e 20 77 69  e overwritten wi
4bf0: 74 68 0a 20 20 7a 65 72 6f 73 2e 20 20 54 68 65  th.  zeros.  The
4c00: 72 65 20 69 73 20 61 20 73 6d 61 6c 6c 20 70 65  re is a small pe
4c10: 72 66 6f 72 6d 61 6e 63 65 20 70 65 6e 61 6c 74  rformance penalt
4c20: 79 20 73 69 6e 63 65 20 61 64 64 69 74 69 6f 6e  y since addition
4c30: 61 6c 20 49 2f 4f 0a 20 20 6d 75 73 74 20 6f 63  al I/O.  must oc
4c40: 63 75 72 2e 20 20 4f 6e 20 74 68 65 20 6f 74 68  cur.  On the oth
4c50: 65 72 20 68 61 6e 64 2c 20 73 65 63 75 72 65 5f  er hand, secure_
4c60: 64 65 6c 65 74 65 20 63 61 6e 20 70 72 65 76 65  delete can preve
4c70: 6e 74 20 66 72 61 67 6d 65 6e 74 73 20 6f 66 20  nt fragments of 
4c80: 0a 20 20 73 65 6e 73 69 74 69 76 65 20 69 6e 66  .  sensitive inf
4c90: 6f 72 6d 61 74 69 6f 6e 20 66 72 6f 6d 20 6c 69  ormation from li
4ca0: 6e 67 65 72 69 6e 67 20 69 6e 20 75 6e 75 73 65  ngering in unuse
4cb0: 64 20 70 61 72 74 73 20 6f 66 20 74 68 65 20 64  d parts of the d
4cc0: 61 74 61 62 61 73 65 20 66 69 6c 65 20 0a 20 20  atabase file .  
4cd0: 61 66 74 65 72 20 69 74 20 68 61 73 20 62 65 65  after it has bee
4ce0: 6e 20 64 65 6c 65 74 65 64 2e 20 20 53 65 65 20  n deleted.  See 
4cf0: 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f  the documentatio
4d00: 6e 20 6f 6e 20 74 68 65 0a 20 20 5b 73 65 63 75  n on the.  [secu
4d10: 72 65 5f 64 65 6c 65 74 65 20 70 72 61 67 6d 61  re_delete pragma
4d20: 5d 20 66 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c  ] for additional
4d30: 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 0a 7d 0a   information..}.
4d40: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20  .COMPILE_OPTION 
4d50: 7b 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41  {SQLITE_THREADSA
4d60: 46 45 3d 3c 69 3e 26 6c 74 3b 30 20 6f 72 20 31  FE=<i>&lt;0 or 1
4d70: 20 6f 72 20 32 26 67 74 3b 3c 2f 69 3e 7d 20 7b   or 2&gt;</i>} {
4d80: 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63  .  This option c
4d90: 6f 6e 74 72 6f 6c 73 20 77 68 65 74 68 65 72 20  ontrols whether 
4da0: 6f 72 20 6e 6f 74 20 63 6f 64 65 20 69 73 20 69  or not code is i
4db0: 6e 63 6c 75 64 65 64 20 69 6e 20 53 51 4c 69 74  ncluded in SQLit
4dc0: 65 20 74 6f 0a 20 20 65 6e 61 62 6c 65 20 69 74  e to.  enable it
4dd0: 20 74 6f 20 6f 70 65 72 61 74 65 20 73 61 66 65   to operate safe
4de0: 6c 79 20 69 6e 20 61 20 6d 75 6c 74 69 74 68 72  ly in a multithr
4df0: 65 61 64 65 64 20 65 6e 76 69 72 6f 6e 6d 65 6e  eaded environmen
4e00: 74 2e 20 20 54 68 65 0a 20 20 64 65 66 61 75 6c  t.  The.  defaul
4e10: 74 20 69 73 20 53 51 4c 49 54 45 5f 54 48 52 45  t is SQLITE_THRE
4e20: 41 44 53 41 46 45 3d 31 20 77 68 69 63 68 20 69  ADSAFE=1 which i
4e30: 73 20 73 61 66 65 20 66 6f 72 20 75 73 65 20 69  s safe for use i
4e40: 6e 20 61 20 6d 75 6c 74 69 74 68 72 65 61 64 65  n a multithreade
4e50: 64 0a 20 20 65 6e 76 69 72 6f 6e 6d 65 6e 74 2e  d.  environment.
4e60: 20 20 57 68 65 6e 20 63 6f 6d 70 69 6c 65 64 20    When compiled 
4e70: 77 69 74 68 20 53 51 4c 49 54 45 5f 54 48 52 45  with SQLITE_THRE
4e80: 41 44 53 41 46 45 3d 30 20 61 6c 6c 20 6d 75 74  ADSAFE=0 all mut
4e90: 65 78 69 6e 67 20 63 6f 64 65 0a 20 20 69 73 20  exing code.  is 
4ea0: 6f 6d 69 74 74 65 64 20 61 6e 64 20 69 74 20 69  omitted and it i
4eb0: 73 20 75 6e 73 61 66 65 20 74 6f 20 75 73 65 20  s unsafe to use 
4ec0: 53 51 4c 69 74 65 20 69 6e 20 61 20 6d 75 6c 74  SQLite in a mult
4ed0: 69 74 68 72 65 61 64 65 64 20 70 72 6f 67 72 61  ithreaded progra
4ee0: 6d 2e 0a 20 20 57 68 65 6e 20 63 6f 6d 70 69 6c  m..  When compil
4ef0: 65 64 20 77 69 74 68 20 53 51 4c 49 54 45 5f 54  ed with SQLITE_T
4f00: 48 52 45 41 44 53 41 46 45 3d 32 2c 20 53 51 4c  HREADSAFE=2, SQL
4f10: 69 74 65 20 63 61 6e 20 62 65 20 75 73 65 64 20  ite can be used 
4f20: 69 6e 20 61 20 6d 75 6c 74 69 74 68 72 65 61 64  in a multithread
4f30: 65 64 0a 20 20 70 72 6f 67 72 61 6d 20 73 6f 20  ed.  program so 
4f40: 6c 6f 6e 67 20 61 73 20 6e 6f 20 74 77 6f 20 74  long as no two t
4f50: 68 72 65 61 64 73 20 61 74 74 65 6d 70 74 20 74  hreads attempt t
4f60: 6f 20 75 73 65 20 74 68 65 20 73 61 6d 65 0a 20  o use the same. 
4f70: 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65   [database conne
4f80: 63 74 69 6f 6e 5d 20 28 6f 72 20 61 6e 79 20 5b  ction] (or any [
4f90: 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
4fa0: 6e 74 73 5d 20 64 65 72 69 76 65 64 20 66 72 6f  nts] derived fro
4fb0: 6d 0a 20 20 74 68 61 74 20 64 61 74 61 62 61 73  m.  that databas
4fc0: 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 29 20 61 74  e connection) at
4fd0: 20 74 68 65 20 73 61 6d 65 20 74 69 6d 65 2e 0a   the same time..
4fe0: 0a 20 20 54 6f 20 70 75 74 20 69 74 20 61 6e 6f  .  To put it ano
4ff0: 74 68 65 72 20 77 61 79 2c 20 53 51 4c 49 54 45  ther way, SQLITE
5000: 5f 54 48 52 45 41 44 53 41 46 45 3d 31 20 73 65  _THREADSAFE=1 se
5010: 74 73 20 74 68 65 20 64 65 66 61 75 6c 74 0a 20  ts the default. 
5020: 20 5b 74 68 72 65 61 64 69 6e 67 20 6d 6f 64 65   [threading mode
5030: 5d 20 74 6f 20 53 65 72 69 61 6c 69 7a 65 64 2e  ] to Serialized.
5040: 20 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53    SQLITE_THREADS
5050: 41 46 45 3d 32 20 73 65 74 73 20 74 68 65 20 64  AFE=2 sets the d
5060: 65 66 61 75 6c 74 0a 20 20 5b 74 68 72 65 61 64  efault.  [thread
5070: 69 6e 67 20 6d 6f 64 65 5d 20 74 6f 20 4d 75 6c  ing mode] to Mul
5080: 74 69 2d 74 68 72 65 61 64 65 64 2e 20 20 41 6e  ti-threaded.  An
5090: 64 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53  d SQLITE_THREADS
50a0: 41 46 45 3d 30 20 73 65 74 73 20 74 68 65 0a 20  AFE=0 sets the. 
50b0: 20 5b 74 68 72 65 61 64 69 6e 67 20 6d 6f 64 65   [threading mode
50c0: 5d 20 74 6f 20 53 69 6e 67 6c 65 2d 74 68 72 65  ] to Single-thre
50d0: 61 64 65 64 2e 0a 0a 20 20 54 68 65 20 76 61 6c  aded...  The val
50e0: 75 65 20 6f 66 20 53 51 4c 49 54 45 5f 54 48 52  ue of SQLITE_THR
50f0: 45 41 44 53 41 46 45 20 63 61 6e 20 62 65 20 64  EADSAFE can be d
5100: 65 74 65 72 6d 69 6e 65 64 20 61 74 20 72 75 6e  etermined at run
5110: 2d 74 69 6d 65 0a 20 20 75 73 69 6e 67 20 74 68  -time.  using th
5120: 65 20 5b 73 71 6c 69 74 65 33 5f 74 68 72 65 61  e [sqlite3_threa
5130: 64 73 61 66 65 28 29 5d 20 69 6e 74 65 72 66 61  dsafe()] interfa
5140: 63 65 2e 0a 0a 20 20 57 68 65 6e 20 53 51 4c 69  ce...  When SQLi
5150: 74 65 20 68 61 73 20 62 65 65 6e 20 63 6f 6d 70  te has been comp
5160: 69 6c 65 64 20 77 69 74 68 20 53 51 4c 49 54 45  iled with SQLITE
5170: 5f 54 48 52 45 41 44 53 41 46 45 3d 31 20 6f 72  _THREADSAFE=1 or
5180: 0a 20 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44  .  SQLITE_THREAD
5190: 53 41 46 45 3d 32 20 74 68 65 6e 20 74 68 65 20  SAFE=2 then the 
51a0: 5b 74 68 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d  [threading mode]
51b0: 0a 20 20 63 61 6e 20 62 65 20 61 6c 74 65 72 65  .  can be altere
51c0: 64 20 61 74 20 72 75 6e 2d 74 69 6d 65 20 75 73  d at run-time us
51d0: 69 6e 67 20 74 68 65 20 5b 73 71 6c 69 74 65 33  ing the [sqlite3
51e0: 5f 63 6f 6e 66 69 67 28 29 5d 20 69 6e 74 65 72  _config()] inter
51f0: 66 61 63 65 20 74 6f 67 65 74 68 65 72 0a 20 20  face together.  
5200: 77 69 74 68 20 6f 6e 65 20 6f 66 20 74 68 65 73  with one of thes
5210: 65 20 76 65 72 62 73 3a 0a 0a 20 20 3c 75 6c 3e  e verbs:..  <ul>
5220: 0a 20 20 3c 6c 69 3e 5b 53 51 4c 49 54 45 5f 43  .  <li>[SQLITE_C
5230: 4f 4e 46 49 47 5f 53 49 4e 47 4c 45 54 48 52 45  ONFIG_SINGLETHRE
5240: 41 44 5d 0a 20 20 3c 6c 69 3e 5b 53 51 4c 49 54  AD].  <li>[SQLIT
5250: 45 5f 43 4f 4e 46 49 47 5f 4d 55 4c 54 49 54 48  E_CONFIG_MULTITH
5260: 52 45 41 44 5d 0a 20 20 3c 6c 69 3e 5b 53 51 4c  READ].  <li>[SQL
5270: 49 54 45 5f 43 4f 4e 46 49 47 5f 53 45 52 49 41  ITE_CONFIG_SERIA
5280: 4c 49 5a 45 44 5d 0a 20 20 3c 2f 75 6c 3e 0a 0a  LIZED].  </ul>..
5290: 20 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 4f 50    The [SQLITE_OP
52a0: 45 4e 5f 4e 4f 4d 55 54 45 58 5d 20 61 6e 64 0a  EN_NOMUTEX] and.
52b0: 20 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 46    [SQLITE_OPEN_F
52c0: 55 4c 4c 4d 55 54 45 58 5d 20 66 6c 61 67 73 20  ULLMUTEX] flags 
52d0: 74 6f 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e  to [sqlite3_open
52e0: 5f 76 32 28 29 5d 20 63 61 6e 20 61 6c 73 6f 20  _v2()] can also 
52f0: 62 65 20 75 73 65 64 0a 20 20 74 6f 20 61 64 6a  be used.  to adj
5300: 75 73 74 20 74 68 65 20 5b 74 68 72 65 61 64 69  ust the [threadi
5310: 6e 67 20 6d 6f 64 65 5d 20 6f 66 20 69 6e 64 69  ng mode] of indi
5320: 76 69 64 75 61 6c 20 5b 64 61 74 61 62 61 73 65  vidual [database
5330: 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 5d 0a 20 20   connections].  
5340: 61 74 20 72 75 6e 2d 74 69 6d 65 2e 0a 0a 20 20  at run-time...  
5350: 4e 6f 74 65 20 74 68 61 74 20 77 68 65 6e 20 53  Note that when S
5360: 51 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c 65  QLite is compile
5370: 64 20 77 69 74 68 20 53 51 4c 49 54 45 5f 54 48  d with SQLITE_TH
5380: 52 45 41 44 53 41 46 45 3d 30 2c 20 74 68 65 20  READSAFE=0, the 
5390: 63 6f 64 65 0a 20 20 74 6f 20 6d 61 6b 65 20 53  code.  to make S
53a0: 51 4c 69 74 65 20 74 68 72 65 61 64 73 61 66 65  QLite threadsafe
53b0: 20 69 73 20 6f 6d 69 74 74 65 64 20 66 72 6f 6d   is omitted from
53c0: 20 74 68 65 20 62 75 69 6c 64 2e 20 20 57 68 65   the build.  Whe
53d0: 6e 20 74 68 69 73 20 6f 63 63 75 72 73 2c 0a 20  n this occurs,. 
53e0: 20 69 74 20 69 73 20 69 6d 70 6f 73 73 69 62 6c   it is impossibl
53f0: 65 20 74 6f 20 63 68 61 6e 67 65 20 74 68 65 20  e to change the 
5400: 5b 74 68 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d  [threading mode]
5410: 20 61 74 20 73 74 61 72 74 2d 74 69 6d 65 20 6f   at start-time o
5420: 72 20 72 75 6e 2d 74 69 6d 65 2e 0a 0a 20 20 53  r run-time...  S
5430: 65 65 20 74 68 65 20 5b 74 68 72 65 61 64 69 6e  ee the [threadin
5440: 67 20 6d 6f 64 65 5d 20 64 6f 63 75 6d 65 6e 74  g mode] document
5450: 61 74 69 6f 6e 20 66 6f 72 20 61 64 64 69 74 69  ation for additi
5460: 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e  onal information
5470: 0a 20 20 6f 6e 20 61 73 70 65 63 74 73 20 6f 66  .  on aspects of
5480: 20 75 73 69 6e 67 20 53 51 4c 69 74 65 20 69 6e   using SQLite in
5490: 20 61 20 6d 75 6c 74 69 74 68 72 65 61 64 65 64   a multithreaded
54a0: 20 65 6e 76 69 72 6f 6e 6d 65 6e 74 2e 0a 7d 0a   environment..}.
54b0: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20  .COMPILE_OPTION 
54c0: 7b 53 51 4c 49 54 45 5f 54 45 4d 50 5f 53 54 4f  {SQLITE_TEMP_STO
54d0: 52 45 3d 3c 69 3e 26 6c 74 3b 30 20 74 68 72 6f  RE=<i>&lt;0 thro
54e0: 75 67 68 20 33 26 67 74 3b 3c 2f 69 3e 7d 20 7b  ugh 3&gt;</i>} {
54f0: 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63  .  This option c
5500: 6f 6e 74 72 6f 6c 73 20 77 68 65 74 68 65 72 20  ontrols whether 
5510: 74 65 6d 70 6f 72 61 72 79 20 66 69 6c 65 73 20  temporary files 
5520: 61 72 65 20 73 74 6f 72 65 64 20 6f 6e 20 64 69  are stored on di
5530: 73 6b 20 6f 72 0a 20 20 69 6e 20 6d 65 6d 6f 72  sk or.  in memor
5540: 79 2e 20 20 54 68 65 20 6d 65 61 6e 69 6e 67 73  y.  The meanings
5550: 20 66 6f 72 20 76 61 72 69 6f 75 73 20 73 65 74   for various set
5560: 74 69 6e 67 73 20 6f 66 20 74 68 69 73 20 63 6f  tings of this co
5570: 6d 70 69 6c 65 2d 74 69 6d 65 0a 20 20 6f 70 74  mpile-time.  opt
5580: 69 6f 6e 20 61 72 65 20 61 73 20 66 6f 6c 6c 6f  ion are as follo
5590: 77 73 3a 0a 0a 20 20 3c 74 61 62 6c 65 20 63 65  ws:..  <table ce
55a0: 6c 6c 70 61 64 64 69 6e 67 3d 22 32 22 20 62 6f  llpadding="2" bo
55b0: 72 64 65 72 3d 22 31 22 3e 0a 20 20 3c 74 72 3e  rder="1">.  <tr>
55c0: 3c 74 68 3e 53 51 4c 49 54 45 5f 54 45 4d 50 5f  <th>SQLITE_TEMP_
55d0: 53 54 4f 52 45 3c 2f 74 68 3e 3c 74 68 3e 4d 65  STORE</th><th>Me
55e0: 61 6e 69 6e 67 3c 2f 74 68 3e 3c 2f 74 72 3e 0a  aning</th></tr>.
55f0: 20 20 3c 74 72 3e 3c 74 64 20 61 6c 69 67 6e 3d    <tr><td align=
5600: 22 63 65 6e 74 65 72 22 3e 30 3c 2f 74 64 3e 3c  "center">0</td><
5610: 74 64 3e 41 6c 77 61 79 73 20 75 73 65 20 74 65  td>Always use te
5620: 6d 70 6f 72 61 72 79 20 66 69 6c 65 73 3c 2f 74  mporary files</t
5630: 64 3e 3c 2f 74 72 3e 0a 20 20 3c 74 72 3e 3c 74  d></tr>.  <tr><t
5640: 64 20 61 6c 69 67 6e 3d 22 63 65 6e 74 65 72 22  d align="center"
5650: 3e 31 3c 2f 74 64 3e 3c 74 64 3e 55 73 65 20 66  >1</td><td>Use f
5660: 69 6c 65 73 20 62 79 20 64 65 66 61 75 6c 74 20  iles by default 
5670: 62 75 74 20 61 6c 6c 6f 77 20 74 68 65 0a 20 20  but allow the.  
5680: 5b 50 52 41 47 4d 41 20 74 65 6d 70 5f 73 74 6f  [PRAGMA temp_sto
5690: 72 65 5d 20 63 6f 6d 6d 61 6e 64 20 74 6f 20 6f  re] command to o
56a0: 76 65 72 72 69 64 65 3c 2f 74 64 3e 3c 2f 74 72  verride</td></tr
56b0: 3e 0a 20 20 3c 74 72 3e 3c 74 64 20 61 6c 69 67  >.  <tr><td alig
56c0: 6e 3d 22 63 65 6e 74 65 72 22 3e 32 3c 2f 74 64  n="center">2</td
56d0: 3e 3c 74 64 3e 55 73 65 20 6d 65 6d 6f 72 79 20  ><td>Use memory 
56e0: 62 79 20 64 65 66 61 75 6c 74 20 62 75 74 20 61  by default but a
56f0: 6c 6c 6f 77 20 74 68 65 0a 20 20 5b 50 52 41 47  llow the.  [PRAG
5700: 4d 41 20 74 65 6d 70 5f 73 74 6f 72 65 5d 20 63  MA temp_store] c
5710: 6f 6d 6d 61 6e 64 20 74 6f 20 6f 76 65 72 72 69  ommand to overri
5720: 64 65 3c 2f 74 64 3e 3c 2f 74 72 3e 0a 20 20 3c  de</td></tr>.  <
5730: 74 72 3e 3c 74 64 20 61 6c 69 67 6e 3d 22 63 65  tr><td align="ce
5740: 6e 74 65 72 22 3e 33 3c 2f 74 64 3e 3c 74 64 3e  nter">3</td><td>
5750: 41 6c 77 61 79 73 20 75 73 65 20 6d 65 6d 6f 72  Always use memor
5760: 79 3c 2f 74 64 3e 3c 2f 74 72 3e 0a 20 20 3c 2f  y</td></tr>.  </
5770: 74 61 62 6c 65 3e 0a 0a 20 20 54 68 65 20 64 65  table>..  The de
5780: 66 61 75 6c 74 20 73 65 74 74 69 6e 67 20 69 73  fault setting is
5790: 20 31 2e 20 20 0a 20 20 41 64 64 69 74 69 6f 6e   1.  .  Addition
57a0: 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 63  al information c
57b0: 61 6e 20 62 65 20 66 6f 75 6e 64 20 69 6e 20 5b  an be found in [
57c0: 74 65 6d 70 73 74 6f 72 65 20 7c 20 74 65 6d 70  tempstore | temp
57d0: 66 69 6c 65 73 2e 68 74 6d 6c 5d 2e 0a 7d 0a 0a  files.html]..}..
57e0: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b  COMPILE_OPTION {
57f0: 53 51 4c 49 54 45 5f 54 52 41 43 45 5f 53 49 5a  SQLITE_TRACE_SIZ
5800: 45 5f 4c 49 4d 49 54 3d 3c 69 3e 4e 3c 2f 69 3e  E_LIMIT=<i>N</i>
5810: 7d 20 7b 0a 20 20 49 66 20 74 68 69 73 20 6d 61  } {.  If this ma
5820: 63 72 6f 20 69 73 20 64 65 66 69 6e 65 64 20 74  cro is defined t
5830: 6f 20 61 20 70 6f 73 69 74 69 76 65 20 69 6e 74  o a positive int
5840: 65 67 65 72 20 3c 69 3e 4e 3c 2f 69 3e 2c 20 74  eger <i>N</i>, t
5850: 68 65 6e 20 74 68 65 20 6c 65 6e 67 74 68 20 6f  hen the length o
5860: 66 0a 20 20 73 74 72 69 6e 67 73 20 61 6e 64 20  f.  strings and 
5870: 42 4c 4f 42 20 74 68 61 74 20 61 72 65 20 65 78  BLOB that are ex
5880: 70 61 6e 64 65 64 20 69 6e 74 6f 20 70 61 72 61  panded into para
5890: 6d 65 74 65 72 73 20 69 6e 20 74 68 65 20 6f 75  meters in the ou
58a0: 74 70 75 74 20 6f 66 0a 20 20 5b 73 71 6c 69 74  tput of.  [sqlit
58b0: 65 33 5f 74 72 61 63 65 28 29 5d 20 69 73 20 6c  e3_trace()] is l
58c0: 69 6d 69 74 65 64 20 74 6f 20 3c 69 3e 4e 3c 2f  imited to <i>N</
58d0: 69 3e 20 62 79 74 65 73 2e 20 20 0a 7d 0a 0a 43  i> bytes.  .}..C
58e0: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53  OMPILE_OPTION {S
58f0: 51 4c 49 54 45 5f 55 53 45 5f 55 52 49 7d 20 7b  QLITE_USE_URI} {
5900: 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63  .  This option c
5910: 61 75 73 65 73 20 74 68 65 20 5b 55 52 49 20 66  auses the [URI f
5920: 69 6c 65 6e 61 6d 65 5d 20 70 72 6f 63 65 73 73  ilename] process
5930: 20 6c 6f 67 69 63 20 74 6f 20 62 65 20 65 6e 61   logic to be ena
5940: 62 6c 65 64 20 62 79 20 0a 20 20 64 65 66 61 75  bled by .  defau
5950: 6c 74 2e 20 20 0a 7d 0a 0a 3c 2f 74 63 6c 3e 0a  lt.  .}..</tcl>.
5960: 0a 3c 61 20 6e 61 6d 65 3d 22 65 6e 61 62 6c 65  .<a name="enable
5970: 66 65 61 74 75 72 65 73 22 3e 3c 2f 61 3e 0a 3c  features"></a>.<
5980: 68 32 3e 31 2e 35 20 4f 70 74 69 6f 6e 73 20 54  h2>1.5 Options T
5990: 6f 20 45 6e 61 62 6c 65 20 46 65 61 74 75 72 65  o Enable Feature
59a0: 73 20 4e 6f 72 6d 61 6c 6c 79 20 54 75 72 6e 65  s Normally Turne
59b0: 64 20 4f 66 66 3c 2f 68 32 3e 0a 0a 3c 74 63 6c  d Off</h2>..<tcl
59c0: 3e 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e  >.COMPILE_OPTION
59d0: 20 7b 53 51 4c 49 54 45 5f 41 4c 4c 4f 57 5f 55   {SQLITE_ALLOW_U
59e0: 52 49 5f 41 55 54 48 4f 52 49 54 59 7d 20 7b 0a  RI_AUTHORITY} {.
59f0: 20 20 5b 55 52 49 20 66 69 6c 65 6e 61 6d 65 73    [URI filenames
5a00: 5d 20 6e 6f 72 6d 61 6c 6c 79 20 74 68 72 6f 77  ] normally throw
5a10: 73 20 61 6e 20 65 72 72 6f 72 20 69 66 20 74 68  s an error if th
5a20: 65 20 61 75 74 68 6f 72 69 74 79 20 73 65 63 74  e authority sect
5a30: 69 6f 6e 20 69 73 0a 20 20 6e 6f 74 20 65 69 74  ion is.  not eit
5a40: 68 65 72 20 65 6d 70 74 79 20 6f 72 20 22 6c 6f  her empty or "lo
5a50: 63 61 6c 68 6f 73 74 22 2e 20 20 48 6f 77 65 76  calhost".  Howev
5a60: 65 72 2c 20 69 66 20 53 51 4c 69 74 65 20 69 73  er, if SQLite is
5a70: 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 0a 20   compiled with. 
5a80: 20 74 68 65 20 53 51 4c 49 54 45 5f 41 4c 4c 4f   the SQLITE_ALLO
5a90: 57 5f 55 52 49 5f 41 55 54 48 4f 52 49 54 59 20  W_URI_AUTHORITY 
5aa0: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
5ab0: 69 6f 6e 2c 20 74 68 65 6e 20 74 68 65 20 55 52  ion, then the UR
5ac0: 49 20 69 73 0a 20 20 63 6f 6e 76 65 72 74 65 64  I is.  converted
5ad0: 20 69 6e 74 6f 20 61 20 55 6e 69 66 6f 72 6d 20   into a Uniform 
5ae0: 4e 61 6d 69 6e 67 20 43 6f 6e 76 65 6e 74 69 6f  Naming Conventio
5af0: 6e 20 28 55 4e 43 29 20 66 69 6c 65 6e 61 6d 65  n (UNC) filename
5b00: 20 61 6e 64 20 70 61 73 73 65 64 0a 20 20 64 6f   and passed.  do
5b10: 77 6e 20 74 6f 20 74 68 65 20 75 6e 64 65 72 6c  wn to the underl
5b20: 79 69 6e 67 20 6f 70 65 72 61 74 69 6e 67 20 73  ying operating s
5b30: 79 73 74 65 6d 20 74 68 61 74 20 77 61 79 2e 20  ystem that way. 
5b40: 20 0a 20 20 3c 70 3e 0a 20 20 53 6f 6d 65 20 66   .  <p>.  Some f
5b50: 75 74 75 72 65 20 76 65 72 73 69 6f 6e 73 20 6f  uture versions o
5b60: 66 20 53 51 4c 69 74 65 20 6d 61 79 20 63 68 61  f SQLite may cha
5b70: 6e 67 65 20 74 6f 20 65 6e 61 62 6c 65 20 74 68  nge to enable th
5b80: 69 73 20 66 65 61 74 75 72 65 0a 20 20 62 79 20  is feature.  by 
5b90: 64 65 66 61 75 6c 74 2e 0a 7d 0a 43 4f 4d 50 49  default..}.COMPI
5ba0: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54  LE_OPTION {SQLIT
5bb0: 45 5f 41 4c 4c 4f 57 5f 43 4f 56 45 52 49 4e 47  E_ALLOW_COVERING
5bc0: 5f 49 4e 44 45 58 5f 53 43 41 4e 3d 3c 69 3e 26  _INDEX_SCAN=<i>&
5bd0: 6c 74 3b 30 20 6f 72 20 31 26 67 74 3b 3c 2f 69  lt;0 or 1&gt;</i
5be0: 3e 7d 20 7b 0a 20 20 54 68 69 73 20 43 2d 70 72  >} {.  This C-pr
5bf0: 65 70 72 6f 63 65 73 73 20 6d 61 63 72 6f 20 64  eprocess macro d
5c00: 65 74 65 72 6d 69 6e 65 73 20 74 68 65 20 64 65  etermines the de
5c10: 66 61 75 6c 74 20 73 65 74 74 69 6e 67 20 6f 66  fault setting of
5c20: 20 74 68 65 0a 20 20 5b 53 51 4c 49 54 45 5f 43   the.  [SQLITE_C
5c30: 4f 4e 46 49 47 5f 43 4f 56 45 52 49 4e 47 5f 49  ONFIG_COVERING_I
5c40: 4e 44 45 58 5f 53 43 41 4e 5d 20 63 6f 6e 66 69  NDEX_SCAN] confi
5c50: 67 75 72 61 74 69 6f 6e 20 73 65 74 74 69 6e 67  guration setting
5c60: 2e 20 20 49 74 20 64 65 66 61 75 6c 74 73 0a 20  .  It defaults. 
5c70: 20 74 6f 20 31 20 28 6f 6e 29 20 77 68 69 63 68   to 1 (on) which
5c80: 20 6d 65 61 6e 73 20 74 68 61 74 20 63 6f 76 65   means that cove
5c90: 72 69 6e 67 20 69 6e 64 69 63 65 73 20 61 72 65  ring indices are
5ca0: 20 75 73 65 64 20 66 6f 72 20 66 75 6c 6c 20 74   used for full t
5cb0: 61 62 6c 65 0a 20 20 73 63 61 6e 73 20 77 68 65  able.  scans whe
5cc0: 72 65 20 70 6f 73 73 69 62 6c 65 2c 20 69 6e 20  re possible, in 
5cd0: 6f 72 64 65 72 20 74 6f 20 72 65 64 75 63 65 20  order to reduce 
5ce0: 49 2f 4f 20 61 6e 64 20 69 6d 70 72 6f 76 65 20  I/O and improve 
5cf0: 70 65 72 66 6f 72 6d 61 6e 63 65 2e 0a 20 20 48  performance..  H
5d00: 6f 77 65 76 65 72 2c 20 74 68 65 20 75 73 65 20  owever, the use 
5d10: 6f 66 20 61 20 63 6f 76 65 72 69 6e 67 20 69 6e  of a covering in
5d20: 64 65 78 20 66 6f 72 20 61 20 66 75 6c 6c 20 73  dex for a full s
5d30: 63 61 6e 20 77 69 6c 6c 20 63 61 75 73 65 20 72  can will cause r
5d40: 65 73 75 6c 74 73 0a 20 20 74 6f 20 61 70 70 65  esults.  to appe
5d50: 61 72 20 69 6e 20 61 20 64 69 66 66 65 72 65 6e  ar in a differen
5d60: 74 20 6f 72 64 65 72 20 66 72 6f 6d 20 6c 65 67  t order from leg
5d70: 61 63 79 2c 20 77 68 69 63 68 20 63 6f 75 6c 64  acy, which could
5d80: 20 63 61 75 73 65 20 73 6f 6d 65 0a 20 20 28 69   cause some.  (i
5d90: 6e 63 6f 72 72 65 63 74 6c 79 2d 63 6f 64 65 64  ncorrectly-coded
5da0: 29 20 6c 65 67 61 63 79 20 61 70 70 6c 69 63 61  ) legacy applica
5db0: 74 69 6f 6e 73 20 74 6f 20 62 72 65 61 6b 2e 20  tions to break. 
5dc0: 20 48 65 6e 63 65 2c 20 74 68 65 20 63 6f 76 65   Hence, the cove
5dd0: 72 69 6e 67 0a 20 20 69 6e 64 65 78 20 73 63 61  ring.  index sca
5de0: 6e 20 6f 70 74 69 6f 6e 20 63 61 6e 20 62 65 20  n option can be 
5df0: 64 69 73 61 62 6c 65 64 20 61 74 20 63 6f 6d 70  disabled at comp
5e00: 69 6c 65 2d 74 69 6d 65 20 6f 6e 20 73 79 73 74  ile-time on syst
5e10: 65 6d 73 20 74 68 61 74 20 77 68 61 74 0a 20 20  ems that what.  
5e20: 74 6f 20 6d 69 6e 69 6d 69 7a 65 20 74 68 65 69  to minimize thei
5e30: 72 20 72 69 73 6b 20 6f 66 20 65 78 70 6f 73 69  r risk of exposi
5e40: 6e 67 20 65 72 72 6f 72 73 20 69 6e 20 6c 65 67  ng errors in leg
5e50: 61 63 79 20 61 70 70 6c 69 63 61 74 69 6f 6e 73  acy applications
5e60: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54  ..}..COMPILE_OPT
5e70: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42  ION {SQLITE_ENAB
5e80: 4c 45 5f 38 5f 33 5f 4e 41 4d 45 53 3d 3c 69 3e  LE_8_3_NAMES=<i>
5e90: 26 6c 74 3b 31 20 6f 72 20 32 26 67 74 3b 3c 2f  &lt;1 or 2&gt;</
5ea0: 69 3e 7d 20 7b 0a 20 20 49 66 20 74 68 69 73 20  i>} {.  If this 
5eb0: 43 2d 70 72 65 70 72 6f 63 65 73 73 6f 72 20 6d  C-preprocessor m
5ec0: 61 63 72 6f 20 69 73 20 64 65 66 69 6e 65 64 2c  acro is defined,
5ed0: 20 74 68 65 6e 20 65 78 74 72 61 20 63 6f 64 65   then extra code
5ee0: 20 69 73 0a 20 20 69 6e 63 6c 75 64 65 64 20 74   is.  included t
5ef0: 68 61 74 20 61 6c 6c 6f 77 73 20 53 51 4c 69 74  hat allows SQLit
5f00: 65 20 74 6f 20 66 75 6e 63 74 69 6f 6e 20 6f 6e  e to function on
5f10: 20 61 20 66 69 6c 65 73 79 73 74 65 6d 20 74 68   a filesystem th
5f20: 61 74 0a 20 20 6f 6e 6c 79 20 73 75 70 70 6f 72  at.  only suppor
5f30: 74 20 38 2b 33 20 66 69 6c 65 6e 61 6d 65 73 2e  t 8+3 filenames.
5f40: 20 20 49 66 20 74 68 65 20 76 61 6c 75 65 20 6f    If the value o
5f50: 66 20 74 68 69 73 20 6d 61 63 72 6f 20 69 73 20  f this macro is 
5f60: 31 2c 0a 20 20 74 68 65 6e 20 74 68 65 20 64 65  1,.  then the de
5f70: 66 61 75 6c 74 20 62 65 68 61 76 69 6f 72 20 69  fault behavior i
5f80: 73 20 74 6f 20 63 6f 6e 74 69 6e 75 65 20 74 6f  s to continue to
5f90: 20 75 73 65 20 6c 6f 6e 67 20 66 69 6c 65 6e 61   use long filena
5fa0: 6d 65 73 20 61 6e 64 0a 20 20 74 6f 20 6f 6e 6c  mes and.  to onl
5fb0: 79 20 75 73 65 20 38 2b 33 20 66 69 6c 65 6e 61  y use 8+3 filena
5fc0: 6d 65 73 20 69 66 20 74 68 65 20 0a 20 20 64 61  mes if the .  da
5fd0: 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
5fe0: 6e 20 69 73 20 6f 70 65 6e 65 64 20 75 73 69 6e  n is opened usin
5ff0: 67 20 5b 55 52 49 20 66 69 6c 65 6e 61 6d 65 73  g [URI filenames
6000: 5d 20 77 69 74 68 0a 20 20 74 68 65 20 22 3c 74  ] with.  the "<t
6010: 74 3e 38 5f 33 5f 6e 61 6d 65 73 3d 31 3c 2f 74  t>8_3_names=1</t
6020: 74 3e 22 20 71 75 65 72 79 20 70 61 72 61 6d 65  t>" query parame
6030: 74 65 72 2e 20 20 49 66 20 74 68 65 20 76 61 6c  ter.  If the val
6040: 75 65 20 6f 66 0a 20 20 74 68 69 73 20 6d 61 63  ue of.  this mac
6050: 72 6f 20 69 73 20 32 2c 20 74 68 65 6e 20 74 68  ro is 2, then th
6060: 65 20 75 73 65 20 6f 66 20 38 2b 33 20 66 69 6c  e use of 8+3 fil
6070: 65 6e 61 6d 65 73 20 62 65 63 6f 6d 65 73 20 74  enames becomes t
6080: 68 65 20 64 65 66 61 75 6c 74 0a 20 20 62 75 74  he default.  but
6090: 20 6d 61 79 20 62 65 20 64 69 73 61 62 6c 65 64   may be disabled
60a0: 20 6f 6e 20 75 73 69 6e 67 20 74 68 65 20 3c 74   on using the <t
60b0: 74 3e 38 5f 33 5f 6e 61 6d 65 73 3d 30 3c 2f 74  t>8_3_names=0</t
60c0: 74 3e 20 71 75 65 72 79 20 70 61 72 61 6d 65 74  t> query paramet
60d0: 65 72 2e 0a 20 20 53 65 65 20 0a 7d 0a 0a 43 4f  er..  See .}..CO
60e0: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51  MPILE_OPTION {SQ
60f0: 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 41 50 49 5f  LITE_ENABLE_API_
6100: 41 52 4d 4f 52 7d 20 7b 0a 20 20 57 68 65 6e 20  ARMOR} {.  When 
6110: 64 65 66 69 6e 65 64 2c 20 74 68 69 73 20 43 2d  defined, this C-
6120: 70 72 65 70 72 6f 63 65 73 73 6f 72 20 6d 61 63  preprocessor mac
6130: 72 6f 20 61 63 74 69 76 61 74 65 73 20 65 78 74  ro activates ext
6140: 72 61 20 63 6f 64 65 20 74 68 61 74 0a 20 20 61  ra code that.  a
6150: 74 74 65 6d 70 74 73 20 74 6f 20 64 65 74 65 63  ttempts to detec
6160: 74 20 6d 69 73 75 73 65 20 6f 66 20 74 68 65 20  t misuse of the 
6170: 53 51 4c 69 74 65 20 41 50 49 2c 20 73 75 63 68  SQLite API, such
6180: 20 61 73 20 70 61 73 73 69 6e 67 20 69 6e 20 4e   as passing in N
6190: 55 4c 4c 0a 20 20 70 6f 69 6e 74 65 72 73 20 74  ULL.  pointers t
61a0: 6f 20 72 65 71 75 69 72 65 64 20 70 61 72 61 6d  o required param
61b0: 65 74 65 72 73 20 6f 72 20 75 73 69 6e 67 20 6f  eters or using o
61c0: 62 6a 65 63 74 73 20 61 66 74 65 72 20 74 68 65  bjects after the
61d0: 79 20 68 61 76 65 20 62 65 65 6e 0a 20 20 64 65  y have been.  de
61e0: 73 74 72 6f 79 65 64 2e 0a 7d 0a 0a 43 4f 4d 50  stroyed..}..COMP
61f0: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49  ILE_OPTION {SQLI
6200: 54 45 5f 45 4e 41 42 4c 45 5f 41 54 4f 4d 49 43  TE_ENABLE_ATOMIC
6210: 5f 57 52 49 54 45 7d 20 7b 0a 20 20 49 66 20 74  _WRITE} {.  If t
6220: 68 69 73 20 43 2d 70 72 65 70 72 6f 63 65 73 73  his C-preprocess
6230: 6f 72 20 6d 61 63 72 6f 20 69 73 20 64 65 66 69  or macro is defi
6240: 6e 65 64 20 61 6e 64 20 69 66 20 74 68 65 0a 20  ned and if the. 
6250: 20 78 44 65 76 69 63 65 43 68 61 72 61 63 74 65   xDeviceCharacte
6260: 72 69 73 74 69 63 73 20 6d 65 74 68 6f 64 20 6f  ristics method o
6270: 66 20 5b 73 71 6c 69 74 65 33 5f 69 6f 5f 6d 65  f [sqlite3_io_me
6280: 74 68 6f 64 73 5d 20 6f 62 6a 65 63 74 20 66 6f  thods] object fo
6290: 72 0a 20 20 61 20 64 61 74 61 62 61 73 65 20 66  r.  a database f
62a0: 69 6c 65 20 72 65 70 6f 72 74 73 20 28 76 69 61  ile reports (via
62b0: 20 6f 6e 65 20 6f 66 20 74 68 65 20 5b 53 51 4c   one of the [SQL
62c0: 49 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43  ITE_IOCAP_ATOMIC
62d0: 5d 20 62 69 74 73 29 0a 20 20 74 68 61 74 20 74  ] bits).  that t
62e0: 68 65 20 66 69 6c 65 73 79 73 74 65 6d 20 73 75  he filesystem su
62f0: 70 70 6f 72 74 73 20 61 74 6f 6d 69 63 20 77 72  pports atomic wr
6300: 69 74 65 73 20 61 6e 64 20 69 66 20 61 20 74 72  ites and if a tr
6310: 61 6e 73 61 63 74 69 6f 6e 0a 20 20 69 6e 76 6f  ansaction.  invo
6320: 6c 76 65 73 20 61 20 63 68 61 6e 67 65 20 74 6f  lves a change to
6330: 20 6f 6e 6c 79 20 61 20 73 69 6e 67 6c 65 20 70   only a single p
6340: 61 67 65 20 6f 66 20 74 68 65 20 64 61 74 61 62  age of the datab
6350: 61 73 65 20 66 69 6c 65 2c 0a 20 20 74 68 65 6e  ase file,.  then
6360: 20 74 68 65 20 74 72 61 6e 73 61 63 74 69 6f 6e   the transaction
6370: 20 63 6f 6d 6d 69 74 73 20 77 69 74 68 20 6a 75   commits with ju
6380: 73 74 20 61 20 73 69 6e 67 6c 65 20 77 72 69 74  st a single writ
6390: 65 20 72 65 71 75 65 73 74 20 6f 66 0a 20 20 61  e request of.  a
63a0: 20 73 69 6e 67 6c 65 20 70 61 67 65 20 6f 66 20   single page of 
63b0: 74 68 65 20 64 61 74 61 62 61 73 65 20 61 6e 64  the database and
63c0: 20 6e 6f 20 72 6f 6c 6c 62 61 63 6b 20 6a 6f 75   no rollback jou
63d0: 72 6e 61 6c 20 69 73 20 63 72 65 61 74 65 64 0a  rnal is created.
63e0: 20 20 6f 72 20 77 72 69 74 74 65 6e 2e 20 20 4f    or written.  O
63f0: 6e 20 66 69 6c 65 73 79 73 74 65 6d 73 20 74 68  n filesystems th
6400: 61 74 20 73 75 70 70 6f 72 74 20 61 74 6f 6d 69  at support atomi
6410: 63 20 77 72 69 74 65 73 2c 20 74 68 69 73 0a 20  c writes, this. 
6420: 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e 20 63 61   optimization ca
6430: 6e 20 72 65 73 75 6c 74 20 69 6e 20 73 69 67 6e  n result in sign
6440: 69 66 69 63 61 6e 74 20 73 70 65 65 64 20 69 6d  ificant speed im
6450: 70 72 6f 76 65 6d 65 6e 74 73 20 66 6f 72 0a 20  provements for. 
6460: 20 73 6d 61 6c 6c 20 75 70 64 61 74 65 73 2e 20   small updates. 
6470: 20 48 6f 77 65 76 65 72 2c 20 66 65 77 20 66 69   However, few fi
6480: 6c 65 73 79 73 74 65 6d 73 20 73 75 70 70 6f 72  lesystems suppor
6490: 74 20 74 68 69 73 20 63 61 70 61 62 69 6c 69 74  t this capabilit
64a0: 79 0a 20 20 61 6e 64 20 74 68 65 20 63 6f 64 65  y.  and the code
64b0: 20 70 61 74 68 73 20 74 68 61 74 20 63 68 65 63   paths that chec
64c0: 6b 20 66 6f 72 20 74 68 69 73 20 63 61 70 61 62  k for this capab
64d0: 69 6c 69 74 79 20 73 6c 6f 77 20 64 6f 77 6e 20  ility slow down 
64e0: 77 72 69 74 65 0a 20 20 70 65 72 66 6f 72 6d 61  write.  performa
64f0: 6e 63 65 20 6f 6e 20 73 79 73 74 65 6d 73 20 74  nce on systems t
6500: 68 61 74 20 6c 61 63 6b 20 61 74 6f 6d 69 63 20  hat lack atomic 
6510: 77 72 69 74 65 20 63 61 70 61 62 69 6c 69 74 79  write capability
6520: 2c 20 73 6f 20 74 68 69 73 0a 20 20 66 65 61 74  , so this.  feat
6530: 75 72 65 20 69 73 20 64 69 73 61 62 6c 65 64 20  ure is disabled 
6540: 62 79 20 64 65 66 61 75 6c 74 2e 0a 7d 0a 0a 43  by default..}..C
6550: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53  OMPILE_OPTION {S
6560: 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 43 4f 4c  QLITE_ENABLE_COL
6570: 55 4d 4e 5f 4d 45 54 41 44 41 54 41 7d 20 7b 0a  UMN_METADATA} {.
6580: 20 20 57 68 65 6e 20 74 68 69 73 20 43 2d 70 72    When this C-pr
6590: 65 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f  eprocessor macro
65a0: 20 69 73 20 64 65 66 69 6e 65 64 2c 20 53 51 4c   is defined, SQL
65b0: 69 74 65 20 69 6e 63 6c 75 64 65 73 20 73 6f 6d  ite includes som
65c0: 65 0a 20 20 61 64 64 69 74 69 6f 6e 61 6c 20 41  e.  additional A
65d0: 50 49 73 20 74 68 61 74 20 70 72 6f 76 69 64 65  PIs that provide
65e0: 20 63 6f 6e 76 65 6e 69 65 6e 74 20 61 63 63 65   convenient acce
65f0: 73 73 20 74 6f 20 6d 65 74 61 2d 64 61 74 61 20  ss to meta-data 
6600: 61 62 6f 75 74 0a 20 20 74 61 62 6c 65 73 20 61  about.  tables a
6610: 6e 64 20 71 75 65 72 69 65 73 2e 20 20 54 68 65  nd queries.  The
6620: 20 41 50 49 73 20 74 68 61 74 20 61 72 65 20 65   APIs that are e
6630: 6e 61 62 6c 65 64 20 62 79 20 74 68 69 73 20 6f  nabled by this o
6640: 70 74 69 6f 6e 20 61 72 65 3a 0a 0a 20 20 3c 75  ption are:..  <u
6650: 6c 3e 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c 69 74  l>.  <li> [sqlit
6660: 65 33 5f 63 6f 6c 75 6d 6e 5f 64 61 74 61 62 61  e3_column_databa
6670: 73 65 5f 6e 61 6d 65 28 29 5d 20 3c 2f 6c 69 3e  se_name()] </li>
6680: 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c 69 74 65 33  .  <li> [sqlite3
6690: 5f 63 6f 6c 75 6d 6e 5f 64 61 74 61 62 61 73 65  _column_database
66a0: 5f 6e 61 6d 65 31 36 28 29 5d 20 3c 2f 6c 69 3e  _name16()] </li>
66b0: 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c 69 74 65 33  .  <li> [sqlite3
66c0: 5f 63 6f 6c 75 6d 6e 5f 74 61 62 6c 65 5f 6e 61  _column_table_na
66d0: 6d 65 28 29 5d 20 3c 2f 6c 69 3e 0a 20 20 3c 6c  me()] </li>.  <l
66e0: 69 3e 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75  i> [sqlite3_colu
66f0: 6d 6e 5f 74 61 62 6c 65 5f 6e 61 6d 65 31 36 28  mn_table_name16(
6700: 29 5d 20 3c 2f 6c 69 3e 0a 20 20 3c 6c 69 3e 20  )] </li>.  <li> 
6710: 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f  [sqlite3_column_
6720: 6f 72 69 67 69 6e 5f 6e 61 6d 65 28 29 5d 20 3c  origin_name()] <
6730: 2f 6c 69 3e 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c  /li>.  <li> [sql
6740: 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6f 72 69 67  ite3_column_orig
6750: 69 6e 5f 6e 61 6d 65 31 36 28 29 5d 20 3c 2f 6c  in_name16()] </l
6760: 69 3e 0a 20 20 3c 2f 75 6c 3e 0a 7d 0a 0a 43 4f  i>.  </ul>.}..CO
6770: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51  MPILE_OPTION {SQ
6780: 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 44 42 53 54  LITE_ENABLE_DBST
6790: 41 54 5f 56 54 41 42 7d 20 7b 0a 20 20 54 68 69  AT_VTAB} {.  Thi
67a0: 73 20 6f 70 74 69 6f 6e 20 65 6e 61 62 6c 65 73  s option enables
67b0: 20 74 68 65 20 5b 64 62 73 74 61 74 20 76 69 72   the [dbstat vir
67c0: 74 75 61 6c 20 74 61 62 6c 65 5d 2e 0a 7d 0a 0a  tual table]..}..
67d0: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b  COMPILE_OPTION {
67e0: 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 45 58  SQLITE_ENABLE_EX
67f0: 50 4c 41 49 4e 5f 43 4f 4d 4d 45 4e 54 53 7d 20  PLAIN_COMMENTS} 
6800: 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20  {.  This option 
6810: 61 64 64 73 20 65 78 74 72 61 20 6c 6f 67 69 63  adds extra logic
6820: 20 74 6f 20 53 51 4c 69 74 65 20 74 68 61 74 20   to SQLite that 
6830: 69 6e 73 65 72 74 73 20 63 6f 6d 6d 65 6e 74 20  inserts comment 
6840: 74 65 78 74 20 69 6e 74 6f 20 74 68 65 0a 20 20  text into the.  
6850: 6f 75 74 70 75 74 20 6f 66 20 5b 45 58 50 4c 41  output of [EXPLA
6860: 49 4e 5d 2e 20 20 54 68 65 73 65 20 65 78 74 72  IN].  These extr
6870: 61 20 63 6f 6d 6d 65 6e 74 73 20 75 73 65 20 65  a comments use e
6880: 78 74 72 61 20 6d 65 6d 6f 72 79 2c 20 74 68 75  xtra memory, thu
6890: 73 0a 20 20 6d 61 6b 69 6e 67 20 5b 70 72 65 70  s.  making [prep
68a0: 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 73 5d  ared statements]
68b0: 20 6c 61 72 67 65 72 20 61 6e 64 20 76 65 72 79   larger and very
68c0: 20 73 6c 69 67 68 74 6c 79 20 73 6c 6f 77 65 72   slightly slower
68d0: 2c 20 61 6e 64 20 73 6f 20 74 68 65 79 20 61 72  , and so they ar
68e0: 65 0a 20 20 74 75 72 6e 65 64 20 6f 66 66 20 62  e.  turned off b
68f0: 79 20 64 65 66 61 75 6c 74 20 61 6e 64 20 69 6e  y default and in
6900: 20 6d 6f 73 74 20 61 70 70 6c 69 63 61 74 69 6f   most applicatio
6910: 6e 2e 20 20 42 75 74 20 73 6f 6d 65 20 61 70 70  n.  But some app
6920: 6c 69 63 61 74 69 6f 6e 73 2c 20 73 75 63 68 0a  lications, such.
6930: 20 20 61 73 20 74 68 65 20 5b 63 6f 6d 6d 61 6e    as the [comman
6940: 64 2d 6c 69 6e 65 20 73 68 65 6c 6c 5d 20 66 6f  d-line shell] fo
6950: 72 20 53 51 4c 69 74 65 2c 20 76 61 6c 75 65 20  r SQLite, value 
6960: 63 6c 61 72 69 74 79 20 6f 66 20 45 58 50 4c 41  clarity of EXPLA
6970: 49 4e 20 6f 75 74 70 75 74 0a 20 20 6f 76 65 72  IN output.  over
6980: 20 72 61 77 20 70 65 72 66 6f 72 6d 61 6e 63 65   raw performance
6990: 20 61 6e 64 20 73 6f 20 74 68 69 73 20 63 6f 6d   and so this com
69a0: 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e  pile-time option
69b0: 20 69 73 20 61 76 61 69 6c 61 62 6c 65 20 74 6f   is available to
69c0: 20 74 68 65 6d 2e 0a 20 20 54 68 65 20 53 51 4c   them..  The SQL
69d0: 49 54 45 5f 45 4e 41 42 4c 45 5f 45 58 50 4c 41  ITE_ENABLE_EXPLA
69e0: 49 4e 5f 43 4f 4d 4d 45 4e 54 53 20 63 6f 6d 70  IN_COMMENTS comp
69f0: 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20  ile-time option 
6a00: 69 73 20 61 6c 73 6f 20 65 6e 61 62 6c 65 64 0a  is also enabled.
6a10: 20 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20    automatically 
6a20: 69 66 20 5b 53 51 4c 49 54 45 5f 44 45 42 55 47  if [SQLITE_DEBUG
6a30: 5d 20 69 73 20 65 6e 61 62 6c 65 64 2e 0a 7d 0a  ] is enabled..}.
6a40: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e  ..COMPILE_OPTION
6a50: 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f   {SQLITE_ENABLE_
6a60: 46 54 53 33 7d 20 7b 0a 20 20 57 68 65 6e 20 74  FTS3} {.  When t
6a70: 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 64 65  his option is de
6a80: 66 69 6e 65 64 20 69 6e 20 74 68 65 20 5b 61 6d  fined in the [am
6a90: 61 6c 67 61 6d 61 74 69 6f 6e 5d 2c 20 76 65 72  algamation], ver
6aa0: 73 69 6f 6e 20 33 0a 20 20 6f 66 20 74 68 65 20  sion 3.  of the 
6ab0: 66 75 6c 6c 2d 74 65 78 74 20 73 65 61 72 63 68  full-text search
6ac0: 20 65 6e 67 69 6e 65 20 69 73 20 61 64 64 65 64   engine is added
6ad0: 20 74 6f 20 74 68 65 20 62 75 69 6c 64 20 61 75   to the build au
6ae0: 74 6f 6d 61 74 69 63 61 6c 6c 79 2e 0a 7d 0a 0a  tomatically..}..
6af0: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b  COMPILE_OPTION {
6b00: 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 46 54  SQLITE_ENABLE_FT
6b10: 53 33 5f 50 41 52 45 4e 54 48 45 53 49 53 7d 20  S3_PARENTHESIS} 
6b20: 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20  {.  This option 
6b30: 6d 6f 64 69 66 69 65 73 20 74 68 65 20 71 75 65  modifies the que
6b40: 72 79 20 70 61 74 74 65 72 6e 20 70 61 72 73 65  ry pattern parse
6b50: 72 20 69 6e 20 46 54 53 33 20 73 75 63 68 20 74  r in FTS3 such t
6b60: 68 61 74 20 69 74 0a 20 20 73 75 70 70 6f 72 74  hat it.  support
6b70: 73 20 6f 70 65 72 61 74 6f 72 73 20 41 4e 44 20  s operators AND 
6b80: 61 6e 64 20 4e 4f 54 20 28 69 6e 20 61 64 64 69  and NOT (in addi
6b90: 74 69 6f 6e 20 74 6f 20 74 68 65 20 75 73 75 61  tion to the usua
6ba0: 6c 20 4f 52 20 61 6e 64 20 4e 45 41 52 29 0a 20  l OR and NEAR). 
6bb0: 20 61 6e 64 20 61 6c 73 6f 20 61 6c 6c 6f 77 73   and also allows
6bc0: 20 71 75 65 72 79 20 65 78 70 72 65 73 73 69 6f   query expressio
6bd0: 6e 73 20 74 6f 20 63 6f 6e 74 61 69 6e 20 6e 65  ns to contain ne
6be0: 73 74 65 64 20 70 61 72 65 6e 74 68 65 73 69 73  sted parenthesis
6bf0: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54  ..}..COMPILE_OPT
6c00: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42  ION {SQLITE_ENAB
6c10: 4c 45 5f 46 54 53 34 7d 20 7b 0a 20 20 57 68 65  LE_FTS4} {.  Whe
6c20: 6e 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73  n this option is
6c30: 20 64 65 66 69 6e 65 64 20 69 6e 20 74 68 65 20   defined in the 
6c40: 5b 61 6d 61 6c 67 61 6d 61 74 69 6f 6e 5d 2c 20  [amalgamation], 
6c50: 76 65 72 73 69 6f 6e 73 20 33 20 61 6e 64 20 34  versions 3 and 4
6c60: 0a 20 20 6f 66 20 74 68 65 20 66 75 6c 6c 2d 74  .  of the full-t
6c70: 65 78 74 20 73 65 61 72 63 68 20 65 6e 67 69 6e  ext search engin
6c80: 65 20 69 73 20 61 64 64 65 64 20 74 6f 20 74 68  e is added to th
6c90: 65 20 62 75 69 6c 64 20 61 75 74 6f 6d 61 74 69  e build automati
6ca0: 63 61 6c 6c 79 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c  cally..}..COMPIL
6cb0: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45  E_OPTION {SQLITE
6cc0: 5f 45 4e 41 42 4c 45 5f 46 54 53 35 7d 20 7b 0a  _ENABLE_FTS5} {.
6cd0: 20 20 57 68 65 6e 20 74 68 69 73 20 6f 70 74 69    When this opti
6ce0: 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 20 69 6e  on is defined in
6cf0: 20 74 68 65 20 5b 61 6d 61 6c 67 61 6d 61 74 69   the [amalgamati
6d00: 6f 6e 5d 2c 20 76 65 72 73 69 6f 6e 73 20 35 0a  on], versions 5.
6d10: 20 20 6f 66 20 74 68 65 20 66 75 6c 6c 2d 74 65    of the full-te
6d20: 78 74 20 73 65 61 72 63 68 20 65 6e 67 69 6e 65  xt search engine
6d30: 20 28 5b 66 74 73 35 5d 29 20 69 73 20 61 64 64   ([fts5]) is add
6d40: 65 64 20 74 6f 20 74 68 65 20 62 75 69 6c 64 20  ed to the build 
6d50: 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 2e 0a 7d  automatically..}
6d60: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e  ..COMPILE_OPTION
6d70: 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f   {SQLITE_ENABLE_
6d80: 49 43 55 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70  ICU} {.  This op
6d90: 74 69 6f 6e 20 63 61 75 73 65 73 20 74 68 65 20  tion causes the 
6da0: 0a 20 20 5b 68 74 74 70 3a 2f 2f 77 77 77 2e 69  .  [http://www.i
6db0: 63 75 2d 70 72 6f 6a 65 63 74 2e 6f 72 67 2f 20  cu-project.org/ 
6dc0: 7c 20 49 6e 74 65 72 6e 61 74 69 6f 6e 61 6c 20  | International 
6dd0: 43 6f 6d 70 6f 6e 65 6e 74 73 20 66 6f 72 20 55  Components for U
6de0: 6e 69 63 6f 64 65 5d 0a 20 20 6f 72 20 22 49 43  nicode].  or "IC
6df0: 55 22 20 65 78 74 65 6e 73 69 6f 6e 20 74 6f 20  U" extension to 
6e00: 53 51 4c 69 74 65 20 74 6f 20 62 65 20 61 64 64  SQLite to be add
6e10: 65 64 20 74 6f 20 74 68 65 20 62 75 69 6c 64 2e  ed to the build.
6e20: 20 20 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50    .}..COMPILE_OP
6e30: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41  TION {SQLITE_ENA
6e40: 42 4c 45 5f 49 4f 54 52 41 43 45 7d 20 7b 0a 20  BLE_IOTRACE} {. 
6e50: 20 57 68 65 6e 20 62 6f 74 68 20 74 68 65 20 53   When both the S
6e60: 51 4c 69 74 65 20 63 6f 72 65 20 61 6e 64 20 74  QLite core and t
6e70: 68 65 20 5b 43 6f 6d 6d 61 6e 64 20 4c 69 6e 65  he [Command Line
6e80: 20 49 6e 74 65 72 66 61 63 65 5d 20 28 43 4c 49   Interface] (CLI
6e90: 29 20 61 72 65 20 62 6f 74 68 20 0a 20 20 63 6f  ) are both .  co
6ea0: 6d 70 69 6c 65 64 20 77 69 74 68 20 74 68 69 73  mpiled with this
6eb0: 20 6f 70 74 69 6f 6e 2c 20 74 68 65 6e 20 74 68   option, then th
6ec0: 65 20 43 4c 49 20 70 72 6f 76 69 64 65 73 20 61  e CLI provides a
6ed0: 6e 20 65 78 74 72 61 20 63 6f 6d 6d 61 6e 64 0a  n extra command.
6ee0: 20 20 6e 61 6d 65 64 20 22 2e 69 6f 74 72 61 63    named ".iotrac
6ef0: 65 22 20 74 68 61 74 20 70 72 6f 76 69 64 65 73  e" that provides
6f00: 20 61 20 6c 6f 77 2d 6c 65 76 65 6c 20 6c 6f 67   a low-level log
6f10: 20 6f 66 20 49 2f 4f 20 61 63 74 69 76 69 74 79   of I/O activity
6f20: 2e 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20  ..  This option 
6f30: 69 73 20 65 78 70 65 72 69 6d 65 6e 74 61 6c 20  is experimental 
6f40: 61 6e 64 20 6d 61 79 20 62 65 20 64 69 73 63 6f  and may be disco
6f50: 6e 74 69 6e 75 65 64 20 69 6e 20 61 20 66 75 74  ntinued in a fut
6f60: 75 72 65 20 72 65 6c 65 61 73 65 2e 0a 7d 0a 0a  ure release..}..
6f70: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b  COMPILE_OPTION {
6f80: 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4a 53  SQLITE_ENABLE_JS
6f90: 4f 4e 31 7d 20 7b 0a 20 20 57 68 65 6e 20 74 68  ON1} {.  When th
6fa0: 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 64 65 66  is option is def
6fb0: 69 6e 65 64 20 69 6e 20 74 68 65 20 5b 61 6d 61  ined in the [ama
6fc0: 6c 67 61 6d 61 74 69 6f 6e 5d 2c 20 74 68 65 0a  lgamation], the.
6fd0: 20 20 5b 4a 53 4f 4e 20 53 51 4c 20 66 75 6e 63    [JSON SQL func
6fe0: 74 69 6f 6e 73 5d 20 61 72 65 20 61 64 64 65 64  tions] are added
6ff0: 20 74 6f 20 74 68 65 20 62 75 69 6c 64 20 61 75   to the build au
7000: 74 6f 6d 61 74 69 63 61 6c 6c 79 2e 0a 7d 0a 0a  tomatically..}..
7010: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b  COMPILE_OPTION {
7020: 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4c 4f  SQLITE_ENABLE_LO
7030: 43 4b 49 4e 47 5f 53 54 59 4c 45 7d 20 7b 0a 20  CKING_STYLE} {. 
7040: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 65 6e 61   This option ena
7050: 62 6c 65 73 20 61 64 64 69 74 69 6f 6e 61 6c 20  bles additional 
7060: 6c 6f 67 69 63 20 69 6e 20 74 68 65 20 4f 53 20  logic in the OS 
7070: 69 6e 74 65 72 66 61 63 65 20 6c 61 79 65 72 20  interface layer 
7080: 66 6f 72 0a 20 20 4d 61 63 20 4f 53 20 58 2e 20  for.  Mac OS X. 
7090: 54 68 65 20 61 64 64 69 74 69 6f 6e 61 6c 20 6c  The additional l
70a0: 6f 67 69 63 20 61 74 74 65 6d 70 74 73 20 74 6f  ogic attempts to
70b0: 20 64 65 74 65 72 6d 69 6e 65 20 74 68 65 20 74   determine the t
70c0: 79 70 65 20 6f 66 20 74 68 65 0a 20 20 75 6e 64  ype of the.  und
70d0: 65 72 6c 79 69 6e 67 20 66 69 6c 65 73 79 73 74  erlying filesyst
70e0: 65 6d 20 61 6e 64 20 63 68 6f 6f 73 65 20 61 6e  em and choose an
70f0: 64 20 61 6c 74 65 72 6e 61 74 69 76 65 20 6c 6f  d alternative lo
7100: 63 6b 69 6e 67 20 73 74 72 61 74 65 67 79 0a 20  cking strategy. 
7110: 20 74 68 61 74 20 77 6f 72 6b 73 20 63 6f 72 72   that works corr
7120: 65 63 74 6c 79 20 66 6f 72 20 74 68 61 74 20 66  ectly for that f
7130: 69 6c 65 73 79 73 74 65 6d 20 74 79 70 65 2e 20  ilesystem type. 
7140: 46 69 76 65 20 6c 6f 63 6b 69 6e 67 20 73 74 72  Five locking str
7150: 61 74 65 67 69 65 73 20 0a 20 20 61 72 65 20 61  ategies .  are a
7160: 76 61 69 6c 61 62 6c 65 3a 0a 0a 20 20 3c 75 6c  vailable:..  <ul
7170: 3e 0a 20 20 20 20 3c 6c 69 3e 20 50 4f 53 49 58  >.    <li> POSIX
7180: 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c 65 2e 20   locking style. 
7190: 54 68 69 73 20 69 73 20 74 68 65 20 64 65 66 61  This is the defa
71a0: 75 6c 74 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c  ult locking styl
71b0: 65 20 61 6e 64 20 74 68 65 0a 20 20 20 20 20 20  e and the.      
71c0: 20 20 20 73 74 79 6c 65 20 75 73 65 64 20 62 79     style used by
71d0: 20 6f 74 68 65 72 20 28 6e 6f 6e 20 4d 61 63 20   other (non Mac 
71e0: 4f 53 20 58 29 20 55 6e 69 78 65 73 2e 20 4c 6f  OS X) Unixes. Lo
71f0: 63 6b 73 20 61 72 65 20 6f 62 74 61 69 6e 65 64  cks are obtained
7200: 20 61 6e 64 20 0a 20 20 20 20 20 20 20 20 20 72   and .         r
7210: 65 6c 65 61 73 65 64 20 75 73 69 6e 67 20 74 68  eleased using th
7220: 65 20 66 63 6e 74 6c 28 29 20 73 79 73 74 65 6d  e fcntl() system
7230: 20 63 61 6c 6c 2e 0a 0a 20 20 20 20 3c 6c 69 3e   call...    <li>
7240: 20 41 46 50 20 6c 6f 63 6b 69 6e 67 20 73 74 79   AFP locking sty
7250: 6c 65 2e 20 54 68 69 73 20 6c 6f 63 6b 69 6e 67  le. This locking
7260: 20 73 74 79 6c 65 20 69 73 20 75 73 65 64 20 66   style is used f
7270: 6f 72 20 6e 65 74 77 6f 72 6b 20 66 69 6c 65 20  or network file 
7280: 0a 20 20 20 20 20 20 20 20 20 73 79 73 74 65 6d  .         system
7290: 73 20 74 68 61 74 20 75 73 65 20 74 68 65 20 41  s that use the A
72a0: 46 50 20 28 41 70 70 6c 65 20 46 69 6c 69 6e 67  FP (Apple Filing
72b0: 20 50 72 6f 74 6f 63 6f 6c 29 20 70 72 6f 74 6f   Protocol) proto
72c0: 63 6f 6c 2e 20 4c 6f 63 6b 73 0a 20 20 20 20 20  col. Locks.     
72d0: 20 20 20 20 61 72 65 20 6f 62 74 61 69 6e 65 64      are obtained
72e0: 20 62 79 20 63 61 6c 6c 69 6e 67 20 74 68 65 20   by calling the 
72f0: 6c 69 62 72 61 72 79 20 66 75 6e 63 74 69 6f 6e  library function
7300: 20 5f 41 46 50 46 53 53 65 74 4c 6f 63 6b 28 29   _AFPFSSetLock()
7310: 2e 0a 0a 20 20 20 20 3c 6c 69 3e 20 46 6c 6f 63  ...    <li> Floc
7320: 6b 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c 65 2e  k locking style.
7330: 20 54 68 69 73 20 69 73 20 75 73 65 64 20 66 6f   This is used fo
7340: 72 20 66 69 6c 65 2d 73 79 73 74 65 6d 73 20 74  r file-systems t
7350: 68 61 74 20 64 6f 20 6e 6f 74 0a 20 20 20 20 20  hat do not.     
7360: 20 20 20 20 73 75 70 70 6f 72 74 20 50 4f 53 49      support POSI
7370: 58 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c 65 2e  X locking style.
7380: 20 4c 6f 63 6b 73 20 61 72 65 20 6f 62 74 61 69   Locks are obtai
7390: 6e 65 64 20 61 6e 64 20 72 65 6c 65 61 73 65 64  ned and released
73a0: 20 75 73 69 6e 67 0a 20 20 20 20 20 20 20 20 20   using.         
73b0: 74 68 65 20 66 6c 6f 63 6b 28 29 20 73 79 73 74  the flock() syst
73c0: 65 6d 20 63 61 6c 6c 2e 0a 0a 20 20 20 20 3c 6c  em call...    <l
73d0: 69 3e 20 44 6f 74 2d 66 69 6c 65 20 6c 6f 63 6b  i> Dot-file lock
73e0: 69 6e 67 20 73 74 79 6c 65 2e 20 54 68 69 73 20  ing style. This 
73f0: 6c 6f 63 6b 69 6e 67 20 73 74 79 6c 65 20 69 73  locking style is
7400: 20 75 73 65 64 20 77 68 65 6e 20 6e 65 69 74 68   used when neith
7410: 65 72 0a 20 20 20 20 20 20 20 20 20 66 6c 6f 63  er.         floc
7420: 6b 20 6e 6f 72 20 50 4f 53 49 58 20 6c 6f 63 6b  k nor POSIX lock
7430: 69 6e 67 20 73 74 79 6c 65 73 20 61 72 65 20 73  ing styles are s
7440: 75 70 70 6f 72 74 65 64 20 62 79 20 74 68 65 20  upported by the 
7450: 66 69 6c 65 20 73 79 73 74 65 6d 2e 0a 20 20 20  file system..   
7460: 20 20 20 20 20 20 44 61 74 61 62 61 73 65 20 6c        Database l
7470: 6f 63 6b 73 20 61 72 65 20 6f 62 74 61 69 6e 65  ocks are obtaine
7480: 64 20 62 79 20 63 72 65 61 74 69 6e 67 20 61 6e  d by creating an
7490: 64 20 65 6e 74 72 79 20 69 6e 20 74 68 65 20 66  d entry in the f
74a0: 69 6c 65 2d 73 79 73 74 65 6d 0a 20 20 20 20 20  ile-system.     
74b0: 20 20 20 20 61 74 20 61 20 77 65 6c 6c 2d 6b 6e      at a well-kn
74c0: 6f 77 6e 20 6c 6f 63 61 74 69 6f 6e 20 72 65 6c  own location rel
74d0: 61 74 69 76 65 20 74 6f 20 74 68 65 20 64 61 74  ative to the dat
74e0: 61 62 61 73 65 20 66 69 6c 65 20 28 61 20 22 64  abase file (a "d
74f0: 6f 74 2d 66 69 6c 65 22 29 0a 20 20 20 20 20 20  ot-file").      
7500: 20 20 20 61 6e 64 20 72 65 6c 69 6e 71 75 69 73     and relinquis
7510: 68 65 64 20 62 79 20 64 65 6c 65 74 69 6e 67 20  hed by deleting 
7520: 74 68 65 20 73 61 6d 65 20 66 69 6c 65 2e 0a 0a  the same file...
7530: 20 20 20 20 3c 6c 69 3e 20 4e 6f 20 6c 6f 63 6b      <li> No lock
7540: 69 6e 67 20 73 74 79 6c 65 2e 20 49 66 20 6e 6f  ing style. If no
7550: 6e 65 20 6f 66 20 74 68 65 20 61 62 6f 76 65 20  ne of the above 
7560: 63 61 6e 20 62 65 20 73 75 70 70 6f 72 74 65 64  can be supported
7570: 2c 20 74 68 69 73 20 0a 20 20 20 20 20 20 20 20  , this .        
7580: 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c 65 20 69   locking style i
7590: 73 20 75 73 65 64 2e 20 4e 6f 20 64 61 74 61 62  s used. No datab
75a0: 61 73 65 20 6c 6f 63 6b 69 6e 67 20 6d 65 63 68  ase locking mech
75b0: 61 6e 69 73 6d 20 69 73 20 75 73 65 64 2e 20 57  anism is used. W
75c0: 68 65 6e 0a 20 20 20 20 20 20 20 20 20 74 68 69  hen.         thi
75d0: 73 20 73 79 73 74 65 6d 20 69 73 20 75 73 65 64  s system is used
75e0: 20 69 74 20 69 73 20 6e 6f 74 20 73 61 66 65 20   it is not safe 
75f0: 66 6f 72 20 61 20 73 69 6e 67 6c 65 20 64 61 74  for a single dat
7600: 61 62 61 73 65 20 74 6f 20 62 65 0a 20 20 20 20  abase to be.    
7610: 20 20 20 20 20 61 63 63 65 73 73 65 64 20 62 79       accessed by
7620: 20 6d 75 6c 74 69 70 6c 65 20 63 6c 69 65 6e 74   multiple client
7630: 73 2e 0a 20 20 3c 2f 75 6c 3e 0a 0a 20 20 41 64  s..  </ul>..  Ad
7640: 64 69 74 69 6f 6e 61 6c 6c 79 2c 20 66 69 76 65  ditionally, five
7650: 20 65 78 74 72 61 20 5b 56 46 53 5d 20 69 6d 70   extra [VFS] imp
7660: 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20 61 72 65  lementations are
7670: 20 70 72 6f 76 69 64 65 64 20 61 73 20 77 65 6c   provided as wel
7680: 6c 20 61 73 20 74 68 65 0a 20 20 64 65 66 61 75  l as the.  defau
7690: 6c 74 2e 20 42 79 20 73 70 65 63 69 66 79 69 6e  lt. By specifyin
76a0: 67 20 6f 6e 65 20 6f 66 20 74 68 65 20 65 78 74  g one of the ext
76b0: 72 61 20 56 46 53 20 69 6d 70 6c 65 6d 65 6e 74  ra VFS implement
76c0: 61 74 69 6f 6e 73 20 0a 20 20 77 68 65 6e 20 63  ations .  when c
76d0: 61 6c 6c 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f  alling [sqlite3_
76e0: 6f 70 65 6e 5f 76 32 28 29 5d 2c 20 61 6e 20 61  open_v2()], an a
76f0: 70 70 6c 69 63 61 74 69 6f 6e 20 6d 61 79 20 62  pplication may b
7700: 79 70 61 73 73 20 74 68 65 20 66 69 6c 65 2d 73  ypass the file-s
7710: 79 73 74 65 6d 0a 20 20 64 65 74 65 63 74 69 6f  ystem.  detectio
7720: 6e 20 6c 6f 67 69 63 20 61 6e 64 20 65 78 70 6c  n logic and expl
7730: 69 63 69 74 6c 79 20 73 65 6c 65 63 74 20 6f 6e  icitly select on
7740: 65 20 6f 66 20 74 68 65 20 61 62 6f 76 65 20 6c  e of the above l
7750: 6f 63 6b 69 6e 67 20 73 74 79 6c 65 73 2e 20 54  ocking styles. T
7760: 68 65 0a 20 20 66 69 76 65 20 65 78 74 72 61 20  he.  five extra 
7770: 5b 56 46 53 5d 20 69 6d 70 6c 65 6d 65 6e 74 61  [VFS] implementa
7780: 74 69 6f 6e 73 20 61 72 65 20 63 61 6c 6c 65 64  tions are called
7790: 20 22 75 6e 69 78 2d 70 6f 73 69 78 22 2c 20 22   "unix-posix", "
77a0: 75 6e 69 78 2d 61 66 70 22 2c 0a 20 20 22 75 6e  unix-afp",.  "un
77b0: 69 78 2d 66 6c 6f 63 6b 22 2c 20 22 75 6e 69 78  ix-flock", "unix
77c0: 2d 64 6f 74 66 69 6c 65 22 20 61 6e 64 20 22 75  -dotfile" and "u
77d0: 6e 69 78 2d 6e 6f 6e 65 22 2e 0a 7d 0a 0a 43 4f  nix-none"..}..CO
77e0: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51  MPILE_OPTION {SQ
77f0: 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4d 45 4d 4f  LITE_ENABLE_MEMO
7800: 52 59 5f 4d 41 4e 41 47 45 4d 45 4e 54 7d 20 7b  RY_MANAGEMENT} {
7810: 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 61  .  This option a
7820: 64 64 73 20 65 78 74 72 61 20 6c 6f 67 69 63 20  dds extra logic 
7830: 74 6f 20 53 51 4c 69 74 65 20 74 68 61 74 20 61  to SQLite that a
7840: 6c 6c 6f 77 73 20 69 74 20 74 6f 20 72 65 6c 65  llows it to rele
7850: 61 73 65 20 75 6e 75 73 65 64 0a 20 20 6d 65 6d  ase unused.  mem
7860: 6f 72 79 20 75 70 6f 6e 20 72 65 71 75 65 73 74  ory upon request
7870: 2e 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 6d  .  This option m
7880: 75 73 74 20 62 65 20 65 6e 61 62 6c 65 64 20 69  ust be enabled i
7890: 6e 20 6f 72 64 65 72 20 66 6f 72 20 74 68 65 0a  n order for the.
78a0: 20 20 5b 73 71 6c 69 74 65 33 5f 72 65 6c 65 61    [sqlite3_relea
78b0: 73 65 5f 6d 65 6d 6f 72 79 28 29 5d 20 69 6e 74  se_memory()] int
78c0: 65 72 66 61 63 65 20 74 6f 20 77 6f 72 6b 2e 20  erface to work. 
78d0: 20 49 66 20 74 68 69 73 20 63 6f 6d 70 69 6c 65   If this compile
78e0: 2d 74 69 6d 65 0a 20 20 6f 70 74 69 6f 6e 20 69  -time.  option i
78f0: 73 20 6e 6f 74 20 75 73 65 64 2c 20 74 68 65 20  s not used, the 
7900: 5b 73 71 6c 69 74 65 33 5f 72 65 6c 65 61 73 65  [sqlite3_release
7910: 5f 6d 65 6d 6f 72 79 28 29 5d 20 69 6e 74 65 72  _memory()] inter
7920: 66 61 63 65 20 69 73 20 61 20 0a 20 20 6e 6f 2d  face is a .  no-
7930: 6f 70 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f  op..}..COMPILE_O
7940: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e  PTION {SQLITE_EN
7950: 41 42 4c 45 5f 4d 45 4d 53 59 53 33 7d 20 7b 0a  ABLE_MEMSYS3} {.
7960: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 69 6e    This option in
7970: 63 6c 75 64 65 73 20 63 6f 64 65 20 69 6e 20 53  cludes code in S
7980: 51 4c 69 74 65 20 74 68 61 74 20 69 6d 70 6c 65  QLite that imple
7990: 6d 65 6e 74 73 20 61 6e 20 61 6c 74 65 72 6e 61  ments an alterna
79a0: 74 69 76 65 0a 20 20 6d 65 6d 6f 72 79 20 61 6c  tive.  memory al
79b0: 6c 6f 63 61 74 6f 72 2e 20 20 54 68 69 73 20 61  locator.  This a
79c0: 6c 74 65 72 6e 61 74 69 76 65 20 6d 65 6d 6f 72  lternative memor
79d0: 79 20 61 6c 6c 6f 63 61 74 6f 72 20 69 73 20 6f  y allocator is o
79e0: 6e 6c 79 20 65 6e 67 61 67 65 64 0a 20 20 77 68  nly engaged.  wh
79f0: 65 6e 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 43  en the [SQLITE_C
7a00: 4f 4e 46 49 47 5f 48 45 41 50 5d 20 6f 70 74 69  ONFIG_HEAP] opti
7a10: 6f 6e 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 63  on to [sqlite3_c
7a20: 6f 6e 66 69 67 28 29 5d 20 69 73 20 75 73 65 64  onfig()] is used
7a30: 20 74 6f 0a 20 20 73 75 70 70 6c 79 20 61 20 6c   to.  supply a l
7a40: 61 72 67 65 20 63 68 75 6e 6b 20 6f 66 20 6d 65  arge chunk of me
7a50: 6d 6f 72 79 20 66 72 6f 6d 20 77 68 69 63 68 20  mory from which 
7a60: 61 6c 6c 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  all memory alloc
7a70: 61 74 69 6f 6e 73 20 61 72 65 0a 20 20 74 61 6b  ations are.  tak
7a80: 65 6e 2e 0a 20 20 54 68 65 20 4d 45 4d 53 59 53  en..  The MEMSYS
7a90: 33 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  3 memory allocat
7aa0: 6f 72 20 75 73 65 73 20 61 20 68 79 62 72 69 64  or uses a hybrid
7ab0: 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 61 6c 67 6f   allocation algo
7ac0: 72 69 74 68 6d 20 0a 20 20 70 61 74 74 65 72 6e  rithm .  pattern
7ad0: 65 64 20 61 66 74 65 72 20 64 6c 6d 61 6c 6c 6f  ed after dlmallo
7ae0: 63 28 29 2e 20 20 20 4f 6e 6c 79 20 6f 6e 65 20  c().   Only one 
7af0: 6f 66 20 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45  of SQLITE_ENABLE
7b00: 5f 4d 45 4d 53 59 53 33 20 61 6e 64 20 0a 20 20  _MEMSYS3 and .  
7b10: 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4d 45  SQLITE_ENABLE_ME
7b20: 4d 53 59 53 35 20 6d 61 79 20 62 65 20 65 6e 61  MSYS5 may be ena
7b30: 62 6c 65 64 20 61 74 20 6f 6e 63 65 2e 0a 7d 0a  bled at once..}.
7b40: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20  .COMPILE_OPTION 
7b50: 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4d  {SQLITE_ENABLE_M
7b60: 45 4d 53 59 53 35 7d 20 7b 0a 20 20 54 68 69 73  EMSYS5} {.  This
7b70: 20 6f 70 74 69 6f 6e 20 69 6e 63 6c 75 64 65 73   option includes
7b80: 20 63 6f 64 65 20 69 6e 20 53 51 4c 69 74 65 20   code in SQLite 
7b90: 74 68 61 74 20 69 6d 70 6c 65 6d 65 6e 74 73 20  that implements 
7ba0: 61 6e 20 61 6c 74 65 72 6e 61 74 69 76 65 0a 20  an alternative. 
7bb0: 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f   memory allocato
7bc0: 72 2e 20 20 54 68 69 73 20 61 6c 74 65 72 6e 61  r.  This alterna
7bd0: 74 69 76 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f  tive memory allo
7be0: 63 61 74 6f 72 20 69 73 20 6f 6e 6c 79 20 65 6e  cator is only en
7bf0: 67 61 67 65 64 0a 20 20 77 68 65 6e 20 74 68 65  gaged.  when the
7c00: 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f   [SQLITE_CONFIG_
7c10: 48 45 41 50 5d 20 6f 70 74 69 6f 6e 20 74 6f 20  HEAP] option to 
7c20: 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28  [sqlite3_config(
7c30: 29 5d 20 69 73 20 75 73 65 64 20 74 6f 0a 20 20  )] is used to.  
7c40: 73 75 70 70 6c 79 20 61 20 6c 61 72 67 65 20 63  supply a large c
7c50: 68 75 6e 6b 20 6f 66 20 6d 65 6d 6f 72 79 20 66  hunk of memory f
7c60: 72 6f 6d 20 77 68 69 63 68 20 61 6c 6c 20 6d 65  rom which all me
7c70: 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 73  mory allocations
7c80: 20 61 72 65 0a 20 20 74 61 6b 65 6e 2e 0a 20 20   are.  taken..  
7c90: 54 68 65 20 4d 45 4d 53 59 53 35 20 6d 6f 64 75  The MEMSYS5 modu
7ca0: 6c 65 20 72 6f 75 6e 64 73 20 61 6c 6c 20 61 6c  le rounds all al
7cb0: 6c 6f 63 61 74 69 6f 6e 73 20 75 70 20 74 6f 20  locations up to 
7cc0: 74 68 65 20 6e 65 78 74 20 70 6f 77 65 72 0a 20  the next power. 
7cd0: 20 6f 66 20 74 77 6f 20 61 6e 64 20 75 73 65 73   of two and uses
7ce0: 20 61 20 66 69 72 73 74 2d 66 69 74 2c 20 62 75   a first-fit, bu
7cf0: 64 64 79 2d 61 6c 6c 6f 63 61 74 6f 72 20 61 6c  ddy-allocator al
7d00: 67 6f 72 69 74 68 6d 0a 20 20 74 68 61 74 20 70  gorithm.  that p
7d10: 72 6f 76 69 64 65 73 20 73 74 72 6f 6e 67 20 67  rovides strong g
7d20: 75 61 72 61 6e 74 65 65 73 20 61 67 61 69 6e 73  uarantees agains
7d30: 74 20 66 72 61 67 6d 65 6e 74 61 74 69 6f 6e 20  t fragmentation 
7d40: 61 6e 64 20 62 72 65 61 6b 64 6f 77 6e 0a 20 20  and breakdown.  
7d50: 73 75 62 6a 65 63 74 20 74 6f 20 63 65 72 74 61  subject to certa
7d60: 69 6e 20 6f 70 65 72 61 74 69 6e 67 20 63 6f 6e  in operating con
7d70: 73 74 72 61 69 6e 74 73 2e 0a 7d 0a 0a 43 4f 4d  straints..}..COM
7d80: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c  PILE_OPTION {SQL
7d90: 49 54 45 5f 45 4e 41 42 4c 45 5f 52 42 55 7d 20  ITE_ENABLE_RBU} 
7da0: 7b 0a 20 20 45 6e 61 62 6c 65 20 74 68 65 20 63  {.  Enable the c
7db0: 6f 64 65 20 74 68 65 20 69 6d 70 6c 65 6d 65 6e  ode the implemen
7dc0: 74 73 20 74 68 65 20 5b 52 42 55 20 65 78 74 65  ts the [RBU exte
7dd0: 6e 73 69 6f 6e 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49  nsion]..}..COMPI
7de0: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54  LE_OPTION {SQLIT
7df0: 45 5f 45 4e 41 42 4c 45 5f 52 54 52 45 45 7d 20  E_ENABLE_RTREE} 
7e00: 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20  {.  This option 
7e10: 63 61 75 73 65 73 20 53 51 4c 69 74 65 20 74 6f  causes SQLite to
7e20: 20 69 6e 63 6c 75 64 65 20 73 75 70 70 6f 72 74   include support
7e30: 20 66 6f 72 20 74 68 65 0a 20 20 5b 72 74 72 65   for the.  [rtre
7e40: 65 20 7c 20 52 2a 54 72 65 65 20 69 6e 64 65 78  e | R*Tree index
7e50: 20 65 78 74 65 6e 73 69 6f 6e 5d 2e 0a 7d 0a 0a   extension]..}..
7e60: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b  COMPILE_OPTION {
7e70: 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 53 54  SQLITE_ENABLE_ST
7e80: 4d 54 5f 53 43 41 4e 53 54 41 54 55 53 7d 20 7b  MT_SCANSTATUS} {
7e90: 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 65  .  This option e
7ea0: 6e 61 62 6c 65 73 20 74 68 65 20 5b 73 71 6c 69  nables the [sqli
7eb0: 74 65 33 5f 73 74 6d 74 5f 73 63 61 6e 73 74 61  te3_stmt_scansta
7ec0: 74 75 73 28 29 5d 20 69 6e 74 65 72 66 61 63 65  tus()] interface
7ed0: 2e 20 20 54 68 65 0a 20 20 5b 73 71 6c 69 74 65  .  The.  [sqlite
7ee0: 33 5f 73 74 6d 74 5f 73 63 61 6e 73 74 61 74 75  3_stmt_scanstatu
7ef0: 73 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 69  s()] interface i
7f00: 73 20 6e 6f 72 6d 61 6c 6c 79 20 6f 6d 69 74 74  s normally omitt
7f10: 65 64 20 66 72 6f 6d 20 74 68 65 20 62 75 69 6c  ed from the buil
7f20: 64 0a 20 20 62 65 63 61 75 73 65 20 69 74 20 69  d.  because it i
7f30: 6d 70 6f 73 65 73 20 61 20 73 6d 61 6c 6c 20 70  mposes a small p
7f40: 65 72 66 6f 72 6d 61 6e 63 65 20 70 65 6e 61 6c  erformance penal
7f50: 74 79 2c 20 65 76 65 6e 20 6f 6e 20 73 74 61 74  ty, even on stat
7f60: 65 6d 65 6e 74 73 20 74 68 61 74 0a 20 20 64 6f  ements that.  do
7f70: 20 6e 6f 74 20 75 73 65 20 74 68 65 20 66 65 61   not use the fea
7f80: 74 75 72 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45  ture..}..COMPILE
7f90: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f  _OPTION {SQLITE_
7fa0: 52 54 52 45 45 5f 49 4e 54 5f 4f 4e 4c 59 7d 20  RTREE_INT_ONLY} 
7fb0: 7b 0a 20 20 49 66 20 74 68 69 73 20 6f 70 74 69  {.  If this opti
7fc0: 6f 6e 20 69 73 20 75 73 65 64 20 74 6f 67 65 74  on is used toget
7fd0: 68 65 72 20 77 69 74 68 20 5b 53 51 4c 49 54 45  her with [SQLITE
7fe0: 5f 45 4e 41 42 4c 45 5f 52 54 52 45 45 5d 20 74  _ENABLE_RTREE] t
7ff0: 68 65 6e 20 74 68 65 0a 20 20 5b 72 74 72 65 65  hen the.  [rtree
8000: 20 7c 20 52 2a 54 72 65 65 20 65 78 74 65 6e 73   | R*Tree extens
8010: 69 6f 6e 5d 20 77 69 6c 6c 20 6f 6e 6c 79 20 73  ion] will only s
8020: 74 6f 72 65 20 33 32 2d 62 69 74 20 73 69 67 6e  tore 32-bit sign
8030: 65 64 20 69 6e 74 65 67 65 72 0a 20 20 63 6f 6f  ed integer.  coo
8040: 72 64 69 6e 61 74 65 73 20 61 6e 64 20 61 6c 6c  rdinates and all
8050: 20 69 6e 74 65 72 6e 61 6c 20 63 6f 6d 70 75 74   internal comput
8060: 61 74 69 6f 6e 73 20 77 69 6c 6c 20 62 65 20 64  ations will be d
8070: 6f 6e 65 20 75 73 69 6e 67 20 69 6e 74 65 67 65  one using intege
8080: 72 73 0a 20 20 69 6e 73 74 65 61 64 20 6f 66 20  rs.  instead of 
8090: 66 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 20 6e  floating point n
80a0: 75 6d 62 65 72 73 2e 0a 7d 0a 0a 43 4f 4d 50 49  umbers..}..COMPI
80b0: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54  LE_OPTION {SQLIT
80c0: 45 5f 45 4e 41 42 4c 45 5f 53 51 4c 4c 4f 47 7d  E_ENABLE_SQLLOG}
80d0: 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e   {.  This option
80e0: 20 65 6e 61 62 6c 65 73 20 65 78 74 72 61 20 63   enables extra c
80f0: 6f 64 65 20 28 65 73 70 65 63 69 61 6c 6c 79 20  ode (especially 
8100: 74 68 65 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46  the [SQLITE_CONF
8110: 49 47 5f 53 51 4c 4c 4f 47 5d 0a 20 20 6f 70 74  IG_SQLLOG].  opt
8120: 69 6f 6e 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f  ion to [sqlite3_
8130: 63 6f 6e 66 69 67 28 29 5d 29 20 74 68 61 74 20  config()]) that 
8140: 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20 63  can be used to c
8150: 72 65 61 74 65 20 6c 6f 67 73 20 6f 66 20 61 6c  reate logs of al
8160: 6c 0a 20 20 53 51 4c 69 74 65 20 70 72 6f 63 65  l.  SQLite proce
8170: 73 73 69 6e 67 20 70 65 72 66 6f 72 6d 65 64 20  ssing performed 
8180: 62 79 20 61 6e 20 61 70 70 6c 69 63 61 74 69 6f  by an applicatio
8190: 6e 2e 20 20 54 68 65 73 65 20 6c 6f 67 73 20 63  n.  These logs c
81a0: 61 6e 20 62 65 20 75 73 65 66 75 6c 0a 20 20 69  an be useful.  i
81b0: 6e 20 64 6f 69 6e 67 20 6f 66 66 2d 6c 69 6e 65  n doing off-line
81c0: 20 61 6e 61 6c 79 73 69 73 20 6f 66 20 74 68 65   analysis of the
81d0: 20 62 65 68 61 76 69 6f 72 20 6f 66 20 61 6e 20   behavior of an 
81e0: 61 70 70 6c 69 63 61 74 69 6f 6e 2c 20 61 6e 64  application, and
81f0: 20 65 73 70 65 63 69 61 6c 6c 79 0a 20 20 66 6f   especially.  fo
8200: 72 20 70 65 72 66 6f 72 6d 61 6e 63 65 20 61 6e  r performance an
8210: 61 6c 79 73 69 73 2e 20 20 49 6e 20 6f 72 64 65  alysis.  In orde
8220: 72 20 66 6f 72 20 74 68 65 20 53 51 4c 49 54 45  r for the SQLITE
8230: 5f 45 4e 41 42 4c 45 5f 53 51 4c 4c 4f 47 20 6f  _ENABLE_SQLLOG o
8240: 70 74 69 6f 6e 20 74 6f 20 0a 20 20 62 65 20 75  ption to .  be u
8250: 73 65 66 75 6c 2c 20 73 6f 6d 65 20 65 78 74 72  seful, some extr
8260: 61 20 63 6f 64 65 20 69 73 20 72 65 71 75 69 72  a code is requir
8270: 65 64 2e 20 20 54 68 65 20 0a 20 20 3c 61 20 68  ed.  The .  <a h
8280: 72 65 66 3d 22 68 74 74 70 3a 2f 2f 77 77 77 2e  ref="http://www.
8290: 73 71 6c 69 74 65 2e 6f 72 67 2f 73 72 63 2f 64  sqlite.org/src/d
82a0: 6f 63 2f 74 72 75 6e 6b 2f 73 72 63 2f 74 65 73  oc/trunk/src/tes
82b0: 74 5f 73 71 6c 6c 6f 67 2e 63 22 3e 22 74 65 73  t_sqllog.c">"tes
82c0: 74 5f 73 71 6c 6c 6f 67 2e 63 22 3c 2f 61 3e 0a  t_sqllog.c"</a>.
82d0: 20 20 73 6f 75 72 63 65 20 63 6f 64 65 0a 20 20    source code.  
82e0: 66 69 6c 65 20 69 6e 20 74 68 65 20 53 51 4c 69  file in the SQLi
82f0: 74 65 20 73 6f 75 72 63 65 20 74 72 65 65 20 69  te source tree i
8300: 73 20 61 20 77 6f 72 6b 69 6e 67 20 65 78 61 6d  s a working exam
8310: 70 6c 65 20 6f 66 20 74 68 65 20 72 65 71 75 69  ple of the requi
8320: 72 65 64 20 65 78 74 72 61 0a 20 20 63 6f 64 65  red extra.  code
8330: 2e 20 20 4f 6e 20 75 6e 69 78 20 61 6e 64 20 77  .  On unix and w
8340: 69 6e 64 6f 77 73 20 73 79 73 74 65 6d 73 2c 20  indows systems, 
8350: 61 20 64 65 76 65 6c 6f 70 65 72 20 63 61 6e 20  a developer can 
8360: 61 70 70 65 6e 64 20 74 68 65 20 74 65 78 74 20  append the text 
8370: 6f 66 20 74 68 65 0a 20 20 22 74 65 73 74 5f 73  of the.  "test_s
8380: 71 6c 6c 6f 67 2e 63 22 20 73 6f 75 72 63 65 20  qllog.c" source 
8390: 63 6f 64 65 20 66 69 6c 65 20 74 6f 20 74 68 65  code file to the
83a0: 20 65 6e 64 20 6f 66 20 61 6e 20 22 73 71 6c 69   end of an "sqli
83b0: 74 65 33 2e 63 22 20 61 6d 61 6c 67 61 6d 61 74  te3.c" amalgamat
83c0: 69 6f 6e 2c 0a 20 20 72 65 63 6f 6d 70 69 6c 65  ion,.  recompile
83d0: 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   the application
83e0: 20 75 73 69 6e 67 20 74 68 65 20 2d 44 53 51 4c   using the -DSQL
83f0: 49 54 45 5f 45 4e 41 42 4c 45 5f 53 51 4c 4c 4f  ITE_ENABLE_SQLLO
8400: 47 20 6f 70 74 69 6f 6e 2c 20 74 68 65 6e 20 0a  G option, then .
8410: 20 20 63 6f 6e 74 72 6f 6c 20 6c 6f 67 67 69 6e    control loggin
8420: 67 20 75 73 69 6e 67 20 65 6e 76 69 72 6f 6e 6d  g using environm
8430: 65 6e 74 20 76 61 72 69 61 62 6c 65 73 2e 20 20  ent variables.  
8440: 53 65 65 20 74 68 65 20 68 65 61 64 65 72 20 63  See the header c
8450: 6f 6d 6d 65 6e 74 20 6f 6e 20 0a 20 20 74 68 65  omment on .  the
8460: 20 22 74 65 73 74 5f 73 71 6c 6c 6f 67 2e 63 22   "test_sqllog.c"
8470: 20 73 6f 75 72 63 65 20 66 69 6c 65 20 66 6f 72   source file for
8480: 20 61 64 64 69 74 69 6f 6e 61 6c 20 64 65 74 61   additional deta
8490: 69 6c 2e 20 20 0a 7d 0a 0a 43 4f 4d 50 49 4c 45  il.  .}..COMPILE
84a0: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f  _OPTION {SQLITE_
84b0: 45 4e 41 42 4c 45 5f 53 54 41 54 32 7d 20 7b 0a  ENABLE_STAT2} {.
84c0: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 75 73    This option us
84d0: 65 64 20 74 6f 20 63 61 75 73 65 20 74 68 65 20  ed to cause the 
84e0: 5b 41 4e 41 4c 59 5a 45 5d 20 63 6f 6d 6d 61 6e  [ANALYZE] comman
84f0: 64 20 74 6f 20 63 6f 6c 6c 65 63 74 0a 20 20 69  d to collect.  i
8500: 6e 64 65 78 20 68 69 73 74 6f 67 72 61 6d 20 64  ndex histogram d
8510: 61 74 61 20 69 6e 20 74 68 65 20 3c 62 3e 73 71  ata in the <b>sq
8520: 6c 69 74 65 5f 73 74 61 74 32 3c 2f 62 3e 20 74  lite_stat2</b> t
8530: 61 62 6c 65 2e 20 20 42 75 74 20 74 68 61 74 0a  able.  But that.
8540: 20 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74 79 20    functionality 
8550: 77 61 73 20 73 75 70 65 72 63 65 64 65 64 20 62  was superceded b
8560: 79 20 5b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45  y [SQLITE_ENABLE
8570: 5f 53 54 41 54 33 5d 20 61 73 20 6f 66 0a 20 20  _STAT3] as of.  
8580: 53 51 4c 69 74 65 20 76 65 72 73 69 6f 6e 20 33  SQLite version 3
8590: 2e 37 2e 39 2e 20 20 54 68 65 20 53 51 4c 49 54  .7.9.  The SQLIT
85a0: 45 5f 45 4e 41 42 4c 45 5f 53 54 41 54 32 20 63  E_ENABLE_STAT2 c
85b0: 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69  ompile-time opti
85c0: 6f 6e 0a 20 20 69 73 20 6e 6f 77 20 61 20 6e 6f  on.  is now a no
85d0: 2d 6f 70 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f  -op..}..COMPILE_
85e0: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45  OPTION {SQLITE_E
85f0: 4e 41 42 4c 45 5f 53 54 41 54 33 7d 20 7b 0a 20  NABLE_STAT3} {. 
8600: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 61 64 64   This option add
8610: 73 20 61 64 64 69 74 69 6f 6e 61 6c 20 6c 6f 67  s additional log
8620: 69 63 20 74 6f 20 74 68 65 20 5b 41 4e 41 4c 59  ic to the [ANALY
8630: 5a 45 5d 20 63 6f 6d 6d 61 6e 64 20 61 6e 64 20  ZE] command and 
8640: 74 6f 0a 20 20 74 68 65 20 5b 71 75 65 72 79 20  to.  the [query 
8650: 70 6c 61 6e 6e 65 72 5d 20 74 68 61 74 20 63 61  planner] that ca
8660: 6e 20 68 65 6c 70 20 53 51 4c 69 74 65 20 74 6f  n help SQLite to
8670: 20 63 68 6f 73 65 20 61 20 62 65 74 74 65 72 20   chose a better 
8680: 71 75 65 72 79 20 70 6c 61 6e 0a 20 20 75 6e 64  query plan.  und
8690: 65 72 20 63 65 72 74 61 69 6e 20 73 69 74 75 61  er certain situa
86a0: 74 69 6f 6e 73 2e 20 20 54 68 65 20 5b 41 4e 41  tions.  The [ANA
86b0: 4c 59 5a 45 5d 20 63 6f 6d 6d 61 6e 64 20 69 73  LYZE] command is
86c0: 20 65 6e 68 61 6e 63 65 64 20 74 6f 20 63 6f 6c   enhanced to col
86d0: 6c 65 63 74 0a 20 20 68 69 73 74 6f 67 72 61 6d  lect.  histogram
86e0: 20 64 61 74 61 20 66 72 6f 6d 20 74 68 65 20 6c   data from the l
86f0: 65 66 74 2d 6d 6f 73 74 20 63 6f 6c 75 6d 6e 20  eft-most column 
8700: 6f 66 20 65 61 63 68 20 69 6e 64 65 78 20 61 6e  of each index an
8710: 64 20 73 74 6f 72 65 20 74 68 61 74 20 64 61 74  d store that dat
8720: 61 0a 20 20 69 6e 20 74 68 65 20 5b 73 71 6c 69  a.  in the [sqli
8730: 74 65 5f 73 74 61 74 33 5d 20 74 61 62 6c 65 2e  te_stat3] table.
8740: 20 20 54 68 65 20 71 75 65 72 79 20 70 6c 61 6e    The query plan
8750: 6e 65 72 20 77 69 6c 6c 20 74 68 65 6e 20 75 73  ner will then us
8760: 65 20 74 68 65 0a 20 20 68 69 73 74 6f 67 72 61  e the.  histogra
8770: 6d 20 64 61 74 61 20 74 6f 20 68 65 6c 70 20 69  m data to help i
8780: 74 20 6d 61 6b 65 20 62 65 74 74 65 72 20 69 6e  t make better in
8790: 64 65 78 20 63 68 6f 69 63 65 73 2e 20 20 4e 6f  dex choices.  No
87a0: 74 65 2c 20 68 6f 77 65 76 65 72 2c 0a 20 20 74  te, however,.  t
87b0: 68 61 74 20 74 68 65 20 75 73 65 20 6f 66 20 68  hat the use of h
87c0: 69 73 74 6f 67 72 61 6d 20 64 61 74 61 20 69 6e  istogram data in
87d0: 20 71 75 65 72 79 20 70 6c 61 6e 6e 65 72 20 76   query planner v
87e0: 69 6f 6c 61 74 65 73 20 74 68 65 0a 20 20 5b 71  iolates the.  [q
87f0: 75 65 72 79 20 70 6c 61 6e 6e 65 72 20 73 74 61  uery planner sta
8800: 62 69 6c 69 74 79 20 67 75 61 72 61 6e 74 65 65  bility guarantee
8810: 5d 20 77 68 69 63 68 20 69 73 20 69 6d 70 6f 72  ] which is impor
8820: 74 61 6e 74 20 74 6f 20 73 6f 6d 65 20 61 70 70  tant to some app
8830: 6c 69 63 61 74 69 6f 6e 73 2e 0a 20 20 3c 70 3e  lications..  <p>
8840: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49  .}..COMPILE_OPTI
8850: 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c  ON {SQLITE_ENABL
8860: 45 5f 53 54 41 54 34 7d 20 7b 0a 20 20 54 68 69  E_STAT4} {.  Thi
8870: 73 20 6f 70 74 69 6f 6e 20 61 64 64 73 20 61 64  s option adds ad
8880: 64 69 74 69 6f 6e 61 6c 20 6c 6f 67 69 63 20 74  ditional logic t
8890: 6f 20 74 68 65 20 5b 41 4e 41 4c 59 5a 45 5d 20  o the [ANALYZE] 
88a0: 63 6f 6d 6d 61 6e 64 20 61 6e 64 20 74 6f 0a 20  command and to. 
88b0: 20 74 68 65 20 5b 71 75 65 72 79 20 70 6c 61 6e   the [query plan
88c0: 6e 65 72 5d 20 74 68 61 74 20 63 61 6e 20 68 65  ner] that can he
88d0: 6c 70 20 53 51 4c 69 74 65 20 74 6f 20 63 68 6f  lp SQLite to cho
88e0: 73 65 20 61 20 62 65 74 74 65 72 20 71 75 65 72  se a better quer
88f0: 79 20 70 6c 61 6e 0a 20 20 75 6e 64 65 72 20 63  y plan.  under c
8900: 65 72 74 61 69 6e 20 73 69 74 75 61 74 69 6f 6e  ertain situation
8910: 73 2e 20 20 54 68 65 20 5b 41 4e 41 4c 59 5a 45  s.  The [ANALYZE
8920: 5d 20 63 6f 6d 6d 61 6e 64 20 69 73 20 65 6e 68  ] command is enh
8930: 61 6e 63 65 64 20 74 6f 20 63 6f 6c 6c 65 63 74  anced to collect
8940: 0a 20 20 68 69 73 74 6f 67 72 61 6d 20 64 61 74  .  histogram dat
8950: 61 20 66 72 6f 6d 20 61 6c 6c 20 63 6f 6c 75 6d  a from all colum
8960: 6e 73 20 6f 66 20 65 76 65 72 79 20 69 6e 64 65  ns of every inde
8970: 78 20 61 6e 64 20 73 74 6f 72 65 20 74 68 61 74  x and store that
8980: 20 64 61 74 61 0a 20 20 69 6e 20 74 68 65 20 5b   data.  in the [
8990: 73 71 6c 69 74 65 5f 73 74 61 74 34 5d 20 74 61  sqlite_stat4] ta
89a0: 62 6c 65 2e 20 20 54 68 65 20 71 75 65 72 79 20  ble.  The query 
89b0: 70 6c 61 6e 6e 65 72 20 77 69 6c 6c 20 74 68 65  planner will the
89c0: 6e 20 75 73 65 20 74 68 65 0a 20 20 68 69 73 74  n use the.  hist
89d0: 6f 67 72 61 6d 20 64 61 74 61 20 74 6f 20 68 65  ogram data to he
89e0: 6c 70 20 69 74 20 6d 61 6b 65 20 62 65 74 74 65  lp it make bette
89f0: 72 20 69 6e 64 65 78 20 63 68 6f 69 63 65 73 2e  r index choices.
8a00: 20 20 54 68 65 20 64 6f 77 6e 73 69 64 65 20 6f    The downside o
8a10: 66 0a 20 20 74 68 69 73 20 63 6f 6d 70 69 6c 65  f.  this compile
8a20: 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20 69 73 20  -time option is 
8a30: 74 68 61 74 20 69 74 20 76 69 6f 6c 61 74 65 73  that it violates
8a40: 20 74 68 65 0a 20 20 5b 71 75 65 72 79 20 70 6c   the.  [query pl
8a50: 61 6e 6e 65 72 20 73 74 61 62 69 6c 69 74 79 20  anner stability 
8a60: 67 75 61 72 61 6e 74 65 65 5d 20 6d 61 6b 69 6e  guarantee] makin
8a70: 67 20 69 74 20 6d 6f 72 65 20 64 69 66 66 69 63  g it more diffic
8a80: 75 6c 74 20 74 6f 20 65 6e 73 75 72 65 0a 20 20  ult to ensure.  
8a90: 63 6f 6e 73 69 73 74 65 6e 74 20 70 65 72 66 6f  consistent perfo
8aa0: 72 6d 61 6e 63 65 20 69 6e 20 6d 61 73 73 2d 70  rmance in mass-p
8ab0: 72 6f 64 75 63 65 64 20 61 70 70 6c 69 63 61 74  roduced applicat
8ac0: 69 6f 6e 73 2e 0a 20 20 3c 70 3e 0a 20 20 53 51  ions..  <p>.  SQ
8ad0: 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 53 54 41 54  LITE_ENABLE_STAT
8ae0: 34 20 69 73 20 61 6e 20 65 6e 68 61 6e 63 65 6d  4 is an enhancem
8af0: 65 6e 74 20 6f 66 20 5b 53 51 4c 49 54 45 5f 45  ent of [SQLITE_E
8b00: 4e 41 42 4c 45 5f 53 54 41 54 33 5d 2e 20 20 53  NABLE_STAT3].  S
8b10: 54 41 54 33 0a 20 20 6f 6e 6c 79 20 72 65 63 6f  TAT3.  only reco
8b20: 72 64 65 64 20 68 69 73 74 6f 67 72 61 6d 20 64  rded histogram d
8b30: 61 74 61 20 66 6f 72 20 74 68 65 20 6c 65 66 74  ata for the left
8b40: 2d 6d 6f 73 74 20 63 6f 6c 75 6d 6e 20 6f 66 20  -most column of 
8b50: 65 61 63 68 20 69 6e 64 65 78 0a 20 20 77 68 65  each index.  whe
8b60: 72 65 61 73 20 74 68 65 20 53 54 41 54 34 20 65  reas the STAT4 e
8b70: 6e 68 61 6e 63 65 6d 65 6e 74 20 72 65 63 6f 72  nhancement recor
8b80: 64 73 20 68 69 73 74 6f 67 72 61 6d 20 64 61 74  ds histogram dat
8b90: 61 20 66 72 6f 6d 20 61 6c 6c 20 63 6f 6c 75 6d  a from all colum
8ba0: 6e 73 0a 20 20 6f 66 20 65 61 63 68 20 69 6e 64  ns.  of each ind
8bb0: 65 78 2e 0a 20 20 54 68 65 20 5b 53 51 4c 49 54  ex..  The [SQLIT
8bc0: 45 5f 45 4e 41 42 4c 45 5f 53 54 41 54 33 5d 20  E_ENABLE_STAT3] 
8bd0: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
8be0: 69 6f 6e 20 69 73 20 61 20 6e 6f 2d 6f 70 20 61  ion is a no-op a
8bf0: 6e 64 20 69 73 20 69 67 6e 6f 72 65 64 0a 20 20  nd is ignored.  
8c00: 69 66 20 74 68 65 20 53 51 4c 49 54 45 5f 45 4e  if the SQLITE_EN
8c10: 41 42 4c 45 5f 53 54 41 54 34 20 63 6f 6d 70 69  ABLE_STAT4 compi
8c20: 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20 69  le-time option i
8c30: 73 20 75 73 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49  s used..}..COMPI
8c40: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54  LE_OPTION {SQLIT
8c50: 45 5f 45 4e 41 42 4c 45 5f 54 52 45 45 5f 45 58  E_ENABLE_TREE_EX
8c60: 50 4c 41 49 4e 7d 20 7b 0a 20 20 54 68 69 73 20  PLAIN} {.  This 
8c70: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
8c80: 69 6f 6e 20 69 73 20 6e 6f 20 6c 6f 6e 67 65 72  ion is no longer
8c90: 20 75 73 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c   used..}..COMPIL
8ca0: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45  E_OPTION {SQLITE
8cb0: 5f 45 4e 41 42 4c 45 5f 55 50 44 41 54 45 5f 44  _ENABLE_UPDATE_D
8cc0: 45 4c 45 54 45 5f 4c 49 4d 49 54 7d 20 7b 0a 20  ELETE_LIMIT} {. 
8cd0: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 65 6e 61   This option ena
8ce0: 62 6c 65 73 20 61 6e 20 6f 70 74 69 6f 6e 61 6c  bles an optional
8cf0: 20 4f 52 44 45 52 20 42 59 20 61 6e 64 20 4c 49   ORDER BY and LI
8d00: 4d 49 54 20 63 6c 61 75 73 65 20 6f 6e 20 0a 20  MIT clause on . 
8d10: 20 5b 55 50 44 41 54 45 5d 20 61 6e 64 20 5b 44   [UPDATE] and [D
8d20: 45 4c 45 54 45 5d 20 73 74 61 74 65 6d 65 6e 74  ELETE] statement
8d30: 73 2e 0a 0a 20 20 3c 70 3e 49 66 20 74 68 69 73  s...  <p>If this
8d40: 20 6f 70 74 69 6f 6e 20 69 73 20 64 65 66 69 6e   option is defin
8d50: 65 64 2c 20 74 68 65 6e 20 69 74 20 6d 75 73 74  ed, then it must
8d60: 20 61 6c 73 6f 20 62 65 20 0a 20 20 64 65 66 69   also be .  defi
8d70: 6e 65 64 20 77 68 65 6e 20 75 73 69 6e 67 20 74  ned when using t
8d80: 68 65 20 27 6c 65 6d 6f 6e 27 20 74 6f 6f 6c 20  he 'lemon' tool 
8d90: 74 6f 20 67 65 6e 65 72 61 74 65 20 61 20 70 61  to generate a pa
8da0: 72 73 65 2e 63 0a 20 20 66 69 6c 65 2e 20 42 65  rse.c.  file. Be
8db0: 63 61 75 73 65 20 6f 66 20 74 68 69 73 2c 20 74  cause of this, t
8dc0: 68 69 73 20 6f 70 74 69 6f 6e 20 6d 61 79 20 6f  his option may o
8dd0: 6e 6c 79 20 62 65 20 75 73 65 64 20 77 68 65 6e  nly be used when
8de0: 20 74 68 65 20 6c 69 62 72 61 72 79 20 69 73 20   the library is 
8df0: 62 75 69 6c 74 0a 20 20 66 72 6f 6d 20 73 6f 75  built.  from sou
8e00: 72 63 65 2c 20 6e 6f 74 20 66 72 6f 6d 20 74 68  rce, not from th
8e10: 65 20 5b 61 6d 61 6c 67 61 6d 61 74 69 6f 6e 5d  e [amalgamation]
8e20: 20 6f 72 20 66 72 6f 6d 20 74 68 65 20 63 6f 6c   or from the col
8e30: 6c 65 63 74 69 6f 6e 20 6f 66 0a 20 20 70 72 65  lection of.  pre
8e40: 2d 70 61 63 6b 61 67 65 64 20 43 20 66 69 6c 65  -packaged C file
8e50: 73 20 70 72 6f 76 69 64 65 64 20 66 6f 72 20 6e  s provided for n
8e60: 6f 6e 2d 55 6e 69 78 20 6c 69 6b 65 20 70 6c 61  on-Unix like pla
8e70: 74 66 6f 72 6d 73 20 6f 6e 20 74 68 65 20 77 65  tforms on the we
8e80: 62 73 69 74 65 2e 0a 20 20 3c 2f 70 3e 0a 7d 0a  bsite..  </p>.}.
8e90: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20  .COMPILE_OPTION 
8ea0: 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 55  {SQLITE_ENABLE_U
8eb0: 4e 4c 4f 43 4b 5f 4e 4f 54 49 46 59 7d 20 7b 0a  NLOCK_NOTIFY} {.
8ec0: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 65 6e    This option en
8ed0: 61 62 6c 65 73 20 74 68 65 20 5b 73 71 6c 69 74  ables the [sqlit
8ee0: 65 33 5f 75 6e 6c 6f 63 6b 5f 6e 6f 74 69 66 79  e3_unlock_notify
8ef0: 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 61 6e  ()] interface an
8f00: 64 0a 20 20 69 74 73 20 61 73 73 6f 63 69 61 74  d.  its associat
8f10: 65 64 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74 79  ed functionality
8f20: 2e 20 20 53 65 65 20 74 68 65 20 64 6f 63 75 6d  .  See the docum
8f30: 65 6e 74 61 74 69 6f 6e 20 74 69 74 6c 65 64 0a  entation titled.
8f40: 20 20 5b 55 73 69 6e 67 20 74 68 65 20 53 51 4c    [Using the SQL
8f50: 69 74 65 20 55 6e 6c 6f 63 6b 20 4e 6f 74 69 66  ite Unlock Notif
8f60: 69 63 61 74 69 6f 6e 20 46 65 61 74 75 72 65 5d  ication Feature]
8f70: 20 66 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c 0a   for additional.
8f80: 20 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 0a 7d    information..}
8f90: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e  ..COMPILE_OPTION
8fa0: 20 7b 53 51 4c 49 54 45 5f 53 4f 55 4e 44 45 58   {SQLITE_SOUNDEX
8fb0: 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f  } {.  This optio
8fc0: 6e 20 65 6e 61 62 6c 65 73 20 74 68 65 20 5b 73  n enables the [s
8fd0: 6f 75 6e 64 65 78 28 29 20 53 51 4c 20 66 75 6e  oundex() SQL fun
8fe0: 63 74 69 6f 6e 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49  ction]..}..COMPI
8ff0: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54  LE_OPTION {SQLIT
9000: 45 5f 55 53 45 5f 46 43 4e 54 4c 5f 54 52 41 43  E_USE_FCNTL_TRAC
9010: 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69  E} {.  This opti
9020: 6f 6e 20 63 61 75 73 65 73 20 53 51 4c 69 74 65  on causes SQLite
9030: 20 74 6f 20 69 73 73 75 65 20 65 78 74 72 61 20   to issue extra 
9040: 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 54 52  [SQLITE_FCNTL_TR
9050: 41 43 45 5d 20 66 69 6c 65 20 63 6f 6e 74 72 6f  ACE] file contro
9060: 6c 73 0a 20 20 74 6f 20 70 72 6f 76 69 64 65 20  ls.  to provide 
9070: 73 75 70 70 6c 65 6d 65 6e 74 61 72 79 20 69 6e  supplementary in
9080: 66 6f 72 6d 61 74 69 6f 6e 20 74 6f 20 74 68 65  formation to the
9090: 20 56 46 53 2e 20 20 54 68 65 20 22 76 66 73 6c   VFS.  The "vfsl
90a0: 6f 67 2e 63 22 20 65 78 74 65 6e 73 69 6f 6e 0a  og.c" extension.
90b0: 20 20 6d 61 6b 65 73 20 75 73 65 20 6f 66 20 74    makes use of t
90c0: 68 69 73 20 74 6f 20 70 72 6f 76 69 64 65 20 65  his to provide e
90d0: 6e 68 61 6e 63 65 64 20 6c 6f 67 73 20 6f 66 20  nhanced logs of 
90e0: 56 46 53 20 61 63 74 69 76 69 74 79 2e 0a 7d 0a  VFS activity..}.
90f0: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20  .COMPILE_OPTION 
9100: 7b 59 59 54 52 41 43 4b 4d 41 58 53 54 41 43 4b  {YYTRACKMAXSTACK
9110: 44 45 50 54 48 7d 20 7b 0a 20 20 54 68 69 73 20  DEPTH} {.  This 
9120: 6f 70 74 69 6f 6e 20 63 61 75 73 65 73 20 74 68  option causes th
9130: 65 20 4c 41 4c 52 28 31 29 20 70 61 72 73 65 72  e LALR(1) parser
9140: 20 73 74 61 63 6b 20 64 65 70 74 68 20 74 6f 20   stack depth to 
9150: 62 65 20 74 72 61 63 6b 65 64 0a 20 20 61 6e 64  be tracked.  and
9160: 20 72 65 70 6f 72 74 65 64 20 75 73 69 6e 67 20   reported using 
9170: 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 74 61  the [sqlite3_sta
9180: 74 75 73 5d 28 5b 53 51 4c 49 54 45 5f 53 54 41  tus]([SQLITE_STA
9190: 54 55 53 5f 50 41 52 53 45 52 5f 53 54 41 43 4b  TUS_PARSER_STACK
91a0: 5d 2c 2e 2e 2e 29 0a 20 20 69 6e 74 65 72 66 61  ],...).  interfa
91b0: 63 65 2e 20 20 53 51 4c 69 74 65 27 73 20 4c 41  ce.  SQLite's LA
91c0: 4c 52 28 31 29 20 70 61 72 73 65 72 20 68 61 73  LR(1) parser has
91d0: 20 61 20 66 69 78 65 64 20 73 74 61 63 6b 20 64   a fixed stack d
91e0: 65 70 74 68 0a 20 20 28 64 65 74 65 72 6d 69 6e  epth.  (determin
91f0: 65 64 20 61 74 20 63 6f 6d 70 69 6c 65 2d 74 69  ed at compile-ti
9200: 6d 65 20 75 73 69 6e 67 20 74 68 65 20 5b 59 59  me using the [YY
9210: 53 54 41 43 4b 44 45 50 54 48 5d 20 6f 70 74 69  STACKDEPTH] opti
9220: 6f 6e 73 29 2e 0a 20 20 54 68 69 73 20 6f 70 74  ons)..  This opt
9230: 69 6f 6e 20 63 61 6e 20 62 65 20 75 73 65 64 20  ion can be used 
9240: 74 6f 20 68 65 6c 70 20 64 65 74 65 72 6d 69 6e  to help determin
9250: 65 20 69 66 20 61 6e 20 61 70 70 6c 69 63 61 74  e if an applicat
9260: 69 6f 6e 20 69 73 0a 20 20 67 65 74 74 69 6e 67  ion is.  getting
9270: 20 63 6c 6f 73 65 20 74 6f 20 65 78 63 65 65 64   close to exceed
9280: 69 6e 67 20 74 68 65 20 6d 61 78 69 6d 75 6d 20  ing the maximum 
9290: 4c 41 4c 52 28 31 29 20 73 74 61 63 6b 20 64 65  LALR(1) stack de
92a0: 70 74 68 2e 0a 7d 0a 3c 2f 74 63 6c 3e 0a 0a 3c  pth..}.</tcl>..<
92b0: 61 20 6e 61 6d 65 3d 22 64 69 73 61 62 6c 65 66  a name="disablef
92c0: 65 61 74 75 72 65 73 22 3e 3c 2f 61 3e 0a 3c 68  eatures"></a>.<h
92d0: 32 3e 31 2e 36 20 4f 70 74 69 6f 6e 73 20 54 6f  2>1.6 Options To
92e0: 20 44 69 73 61 62 6c 65 20 46 65 61 74 75 72 65   Disable Feature
92f0: 73 20 4e 6f 72 6d 61 6c 6c 79 20 54 75 72 6e 65  s Normally Turne
9300: 64 20 4f 6e 3c 2f 68 32 3e 0a 0a 3c 74 63 6c 3e  d On</h2>..<tcl>
9310: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20  .COMPILE_OPTION 
9320: 7b 53 51 4c 49 54 45 5f 44 49 53 41 42 4c 45 5f  {SQLITE_DISABLE_
9330: 4c 46 53 7d 20 7b 0a 20 20 49 66 20 74 68 69 73  LFS} {.  If this
9340: 20 43 2d 70 72 65 70 72 6f 63 65 73 73 6f 72 20   C-preprocessor 
9350: 6d 61 63 72 6f 20 69 73 20 64 65 66 69 6e 65 64  macro is defined
9360: 2c 20 6c 61 72 67 65 20 66 69 6c 65 20 73 75 70  , large file sup
9370: 70 6f 72 74 0a 20 20 69 73 20 64 69 73 61 62 6c  port.  is disabl
9380: 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f  ed..}..COMPILE_O
9390: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 49  PTION {SQLITE_DI
93a0: 53 41 42 4c 45 5f 44 49 52 53 59 4e 43 7d 20 7b  SABLE_DIRSYNC} {
93b0: 0a 20 20 49 66 20 74 68 69 73 20 43 2d 70 72 65  .  If this C-pre
93c0: 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f 20  processor macro 
93d0: 69 73 20 64 65 66 69 6e 65 64 2c 20 64 69 72 65  is defined, dire
93e0: 63 74 6f 72 79 20 73 79 6e 63 73 0a 20 20 61 72  ctory syncs.  ar
93f0: 65 20 64 69 73 61 62 6c 65 64 2e 20 20 53 51 4c  e disabled.  SQL
9400: 69 74 65 20 74 79 70 69 63 61 6c 6c 79 20 61 74  ite typically at
9410: 74 65 6d 70 74 73 20 74 6f 20 73 79 6e 63 20 74  tempts to sync t
9420: 68 65 20 70 61 72 65 6e 74 0a 20 20 64 69 72 65  he parent.  dire
9430: 63 74 6f 72 79 20 77 68 65 6e 20 61 20 66 69 6c  ctory when a fil
9440: 65 20 69 73 20 64 65 6c 65 74 65 64 20 74 6f 20  e is deleted to 
9450: 65 6e 73 75 72 65 20 74 68 65 20 64 69 72 65 63  ensure the direc
9460: 74 6f 72 79 0a 20 20 65 6e 74 72 69 65 73 20 61  tory.  entries a
9470: 72 65 20 75 70 64 61 74 65 64 20 69 6d 6d 65 64  re updated immed
9480: 69 61 74 65 6c 79 20 6f 6e 20 64 69 73 6b 2e 0a  iately on disk..
9490: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f  }..COMPILE_OPTIO
94a0: 4e 20 7b 53 51 4c 49 54 45 5f 44 49 53 41 42 4c  N {SQLITE_DISABL
94b0: 45 5f 46 54 53 33 5f 55 4e 49 43 4f 44 45 7d 20  E_FTS3_UNICODE} 
94c0: 7b 0a 20 20 49 66 20 74 68 69 73 20 43 2d 70 72  {.  If this C-pr
94d0: 65 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f  eprocessor macro
94e0: 20 69 73 20 64 65 66 69 6e 65 64 2c 20 74 68 65   is defined, the
94f0: 20 5b 75 6e 69 63 6f 64 65 36 31 5d 20 74 6f 6b   [unicode61] tok
9500: 65 6e 69 7a 65 72 0a 20 20 69 6e 20 5b 46 54 53  enizer.  in [FTS
9510: 33 5d 20 69 73 20 6f 6d 69 74 74 65 64 20 66 72  3] is omitted fr
9520: 6f 6d 20 74 68 65 20 62 75 69 6c 64 20 61 6e 64  om the build and
9530: 20 69 73 20 75 6e 61 76 61 69 6c 61 62 6c 65 20   is unavailable 
9540: 74 6f 20 0a 20 20 61 70 70 6c 69 63 61 74 69 6f  to .  applicatio
9550: 6e 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f  ns..}..COMPILE_O
9560: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 49  PTION {SQLITE_DI
9570: 53 41 42 4c 45 5f 46 54 53 34 5f 44 45 46 45 52  SABLE_FTS4_DEFER
9580: 52 45 44 7d 20 7b 0a 20 20 49 66 20 74 68 69 73  RED} {.  If this
9590: 20 43 2d 70 72 65 70 72 6f 63 65 73 73 6f 72 20   C-preprocessor 
95a0: 6d 61 63 72 6f 20 64 69 73 61 62 6c 65 73 20 74  macro disables t
95b0: 68 65 20 22 64 65 66 65 72 72 65 64 20 74 6f 6b  he "deferred tok
95c0: 65 6e 22 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e  en" optimization
95d0: 0a 20 20 69 6e 20 5b 46 54 53 34 5d 2e 20 20 54  .  in [FTS4].  T
95e0: 68 65 20 22 64 65 66 65 72 72 65 64 20 74 6f 6b  he "deferred tok
95f0: 65 6e 22 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e  en" optimization
9600: 20 61 76 6f 69 64 73 20 6c 6f 61 64 69 6e 67 20   avoids loading 
9610: 6d 61 73 73 69 76 65 0a 20 20 70 6f 73 74 69 6e  massive.  postin
9620: 67 20 6c 69 73 74 73 20 66 6f 72 20 74 65 72 6d  g lists for term
9630: 73 20 74 68 61 74 20 61 72 65 20 69 6e 20 6d 6f  s that are in mo
9640: 73 74 20 64 6f 63 75 6d 65 6e 74 73 20 6f 66 20  st documents of 
9650: 74 68 65 20 63 6f 6c 6c 65 63 74 69 6f 6e 0a 20  the collection. 
9660: 20 61 6e 64 20 69 6e 73 74 65 61 64 20 73 69 6d   and instead sim
9670: 70 6c 79 20 73 63 61 6e 73 20 66 6f 72 20 74 68  ply scans for th
9680: 6f 73 65 20 74 6f 6b 65 6e 73 20 69 6e 20 74 68  ose tokens in th
9690: 65 20 64 6f 63 75 6d 65 6e 74 20 73 6f 75 72 63  e document sourc
96a0: 65 2e 20 20 5b 46 54 53 34 5d 0a 20 20 73 68 6f  e.  [FTS4].  sho
96b0: 75 6c 64 20 67 65 74 20 65 78 61 63 74 6c 79 20  uld get exactly 
96c0: 74 68 65 20 73 61 6d 65 20 61 6e 73 77 65 72 20  the same answer 
96d0: 62 6f 74 68 20 77 69 74 68 20 61 6e 64 20 77 69  both with and wi
96e0: 74 68 6f 75 74 20 74 68 69 73 20 6f 70 74 69 6d  thout this optim
96f0: 69 7a 61 74 69 6f 6e 2e 0a 7d 0a 3c 2f 74 63 6c  ization..}.</tcl
9700: 3e 0a 0a 3c 74 63 6c 3e 0a 20 20 68 64 5f 66 72  >..<tcl>.  hd_fr
9710: 61 67 6d 65 6e 74 20 22 6f 6d 69 74 66 65 61 74  agment "omitfeat
9720: 75 72 65 73 22 0a 20 20 68 64 5f 6b 65 79 77 6f  ures".  hd_keywo
9730: 72 64 73 20 22 6f 6d 69 74 66 65 61 74 75 72 65  rds "omitfeature
9740: 73 22 0a 3c 2f 74 63 6c 3e 0a 3c 68 32 3e 31 2e  s".</tcl>.<h2>1.
9750: 37 20 4f 70 74 69 6f 6e 73 20 54 6f 20 4f 6d 69  7 Options To Omi
9760: 74 20 46 65 61 74 75 72 65 73 3c 2f 68 32 3e 0a  t Features</h2>.
9770: 0a 3c 70 3e 54 68 65 20 66 6f 6c 6c 6f 77 69 6e  .<p>The followin
9780: 67 20 6f 70 74 69 6f 6e 73 20 63 61 6e 20 62 65  g options can be
9790: 20 75 73 65 64 20 74 6f 20 0a 5b 72 65 6c 66 6f   used to .[relfo
97a0: 6f 74 70 72 69 6e 74 20 7c 20 72 65 64 75 63 65  otprint | reduce
97b0: 20 74 68 65 20 73 69 7a 65 20 6f 66 20 74 68 65   the size of the
97c0: 20 63 6f 6d 70 69 6c 65 64 20 6c 69 62 72 61 72   compiled librar
97d0: 79 5d 0a 62 79 20 6f 6d 69 74 74 69 6e 67 20 75  y].by omitting u
97e0: 6e 75 73 65 64 20 66 65 61 74 75 72 65 73 2e 20  nused features. 
97f0: 54 68 69 73 20 69 73 20 70 72 6f 62 61 62 6c 79  This is probably
9800: 20 6f 6e 6c 79 20 75 73 65 66 75 6c 0a 69 6e 20   only useful.in 
9810: 65 6d 62 65 64 64 65 64 20 73 79 73 74 65 6d 73  embedded systems
9820: 20 77 68 65 72 65 20 73 70 61 63 65 20 69 73 20   where space is 
9830: 65 73 70 65 63 69 61 6c 6c 79 20 74 69 67 68 74  especially tight
9840: 2c 20 61 73 20 65 76 65 6e 20 77 69 74 68 20 61  , as even with a
9850: 6c 6c 0a 66 65 61 74 75 72 65 73 20 69 6e 63 6c  ll.features incl
9860: 75 64 65 64 20 74 68 65 20 53 51 4c 69 74 65 20  uded the SQLite 
9870: 6c 69 62 72 61 72 79 20 69 73 20 72 65 6c 61 74  library is relat
9880: 69 76 65 6c 79 20 73 6d 61 6c 6c 2e 20 44 6f 6e  ively small. Don
9890: 27 74 20 66 6f 72 67 65 74 0a 74 6f 20 74 65 6c  't forget.to tel
98a0: 6c 20 79 6f 75 72 20 63 6f 6d 70 69 6c 65 72 20  l your compiler 
98b0: 74 6f 20 6f 70 74 69 6d 69 7a 65 20 66 6f 72 20  to optimize for 
98c0: 62 69 6e 61 72 79 20 73 69 7a 65 21 20 28 74 68  binary size! (th
98d0: 65 20 2d 4f 73 20 6f 70 74 69 6f 6e 20 69 66 0a  e -Os option if.
98e0: 75 73 69 6e 67 20 47 43 43 29 2e 20 20 54 65 6c  using GCC).  Tel
98f0: 6c 69 6e 67 20 79 6f 75 72 20 63 6f 6d 70 69 6c  ling your compil
9900: 65 72 20 74 6f 20 6f 70 74 69 6d 69 7a 65 20 66  er to optimize f
9910: 6f 72 20 73 69 7a 65 20 75 73 75 61 6c 6c 79 20  or size usually 
9920: 68 61 73 0a 61 20 6d 75 63 68 20 6c 61 72 67 65  has.a much large
9930: 72 20 69 6d 70 61 63 74 20 6f 6e 20 6c 69 62 72  r impact on libr
9940: 61 72 79 20 66 6f 6f 74 70 72 69 6e 74 20 74 68  ary footprint th
9950: 61 6e 20 65 6d 70 6c 6f 79 69 6e 67 20 61 6e 79  an employing any
9960: 20 6f 66 20 74 68 65 73 65 0a 63 6f 6d 70 69 6c   of these.compil
9970: 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 73 2e 20  e-time options. 
9980: 20 59 6f 75 20 73 68 6f 75 6c 64 20 61 6c 73 6f   You should also
9990: 20 76 65 72 69 66 79 20 74 68 61 74 20 0a 3c 61   verify that .<a
99a0: 20 68 72 65 66 3d 22 23 64 65 62 75 67 6f 70 74   href="#debugopt
99b0: 69 6f 6e 73 22 3e 64 65 62 75 67 67 69 6e 67 20  ions">debugging 
99c0: 6f 70 74 69 6f 6e 73 3c 2f 61 3e 20 61 72 65 20  options</a> are 
99d0: 64 69 73 61 62 6c 65 64 2e 3c 2f 70 3e 0a 0a 3c  disabled.</p>..<
99e0: 70 3e 54 68 65 20 6d 61 63 72 6f 73 20 69 6e 20  p>The macros in 
99f0: 74 68 69 73 20 73 65 63 74 69 6f 6e 20 64 6f 20  this section do 
9a00: 6e 6f 74 20 72 65 71 75 69 72 65 20 76 61 6c 75  not require valu
9a10: 65 73 2e 20 54 68 65 20 66 6f 6c 6c 6f 77 69 6e  es. The followin
9a20: 67 20 0a 63 6f 6d 70 69 6c 61 74 69 6f 6e 20 73  g .compilation s
9a30: 77 69 74 63 68 65 73 20 61 6c 6c 20 68 61 76 65  witches all have
9a40: 20 74 68 65 20 73 61 6d 65 20 65 66 66 65 63 74   the same effect
9a50: 3a 3c 62 72 3e 0a 2d 44 53 51 4c 49 54 45 5f 4f  :<br>.-DSQLITE_O
9a60: 4d 49 54 5f 41 4c 54 45 52 54 41 42 4c 45 3c 62  MIT_ALTERTABLE<b
9a70: 72 3e 0a 2d 44 53 51 4c 49 54 45 5f 4f 4d 49 54  r>.-DSQLITE_OMIT
9a80: 5f 41 4c 54 45 52 54 41 42 4c 45 3d 31 3c 62 72  _ALTERTABLE=1<br
9a90: 3e 0a 2d 44 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  >.-DSQLITE_OMIT_
9aa0: 41 4c 54 45 52 54 41 42 4c 45 3d 30 0a 3c 2f 70  ALTERTABLE=0.</p
9ab0: 3e 0a 0a 3c 70 3e 49 66 20 61 6e 79 20 6f 66 20  >..<p>If any of 
9ac0: 74 68 65 73 65 20 6f 70 74 69 6f 6e 73 20 61 72  these options ar
9ad0: 65 20 64 65 66 69 6e 65 64 2c 20 74 68 65 6e 20  e defined, then 
9ae0: 74 68 65 20 73 61 6d 65 20 73 65 74 20 6f 66 20  the same set of 
9af0: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 2a 0a 6f 70  SQLITE_OMIT_*.op
9b00: 74 69 6f 6e 73 20 6d 75 73 74 20 61 6c 73 6f 20  tions must also 
9b10: 62 65 20 64 65 66 69 6e 65 64 20 77 68 65 6e 20  be defined when 
9b20: 75 73 69 6e 67 20 74 68 65 20 27 6c 65 6d 6f 6e  using the 'lemon
9b30: 27 20 74 6f 6f 6c 20 74 6f 20 67 65 6e 65 72 61  ' tool to genera
9b40: 74 65 20 74 68 65 0a 70 61 72 73 65 2e 63 20 66  te the.parse.c f
9b50: 69 6c 65 20 61 6e 64 20 77 68 65 6e 20 63 6f 6d  ile and when com
9b60: 70 69 6c 69 6e 67 20 74 68 65 20 27 6d 6b 6b 65  piling the 'mkke
9b70: 79 77 6f 72 64 68 61 73 68 27 20 74 6f 6f 6c 20  ywordhash' tool 
9b80: 77 68 69 63 68 20 67 65 6e 65 72 61 74 65 73 20  which generates 
9b90: 0a 74 68 65 20 6b 65 79 77 6f 72 64 68 61 73 68  .the keywordhash
9ba0: 2e 68 20 66 69 6c 65 2e 0a 42 65 63 61 75 73 65  .h file..Because
9bb0: 20 6f 66 20 74 68 69 73 2c 20 74 68 65 73 65 20   of this, these 
9bc0: 6f 70 74 69 6f 6e 73 20 6d 61 79 20 6f 6e 6c 79  options may only
9bd0: 20 62 65 20 75 73 65 64 20 77 68 65 6e 20 74 68   be used when th
9be0: 65 20 6c 69 62 72 61 72 79 20 69 73 20 62 75 69  e library is bui
9bf0: 6c 74 0a 66 72 6f 6d 20 63 61 6e 6f 6e 69 63 61  lt.from canonica
9c00: 6c 20 73 6f 75 72 63 65 2c 20 6e 6f 74 20 66 72  l source, not fr
9c10: 6f 6d 20 74 68 65 20 5b 61 6d 61 6c 67 61 6d 61  om the [amalgama
9c20: 74 69 6f 6e 5d 20 6f 72 20 66 72 6f 6d 20 74 68  tion] or from th
9c30: 65 20 63 6f 6c 6c 65 63 74 69 6f 6e 20 6f 66 0a  e collection of.
9c40: 70 72 65 2d 70 61 63 6b 61 67 65 64 20 43 20 66  pre-packaged C f
9c50: 69 6c 65 73 20 70 72 6f 76 69 64 65 64 20 66 6f  iles provided fo
9c60: 72 20 6e 6f 6e 2d 55 6e 69 78 20 6c 69 6b 65 20  r non-Unix like 
9c70: 70 6c 61 74 66 6f 72 6d 73 20 6f 6e 20 74 68 65  platforms on the
9c80: 20 77 65 62 73 69 74 65 2e 0a 41 6e 79 20 53 51   website..Any SQ
9c90: 4c 49 54 45 5f 4f 4d 49 54 5f 2a 20 6f 70 74 69  LITE_OMIT_* opti
9ca0: 6f 6e 73 20 77 68 69 63 68 20 63 61 6e 20 62 65  ons which can be
9cb0: 20 75 73 65 64 20 64 69 72 65 63 74 6c 79 20 77   used directly w
9cc0: 69 74 68 20 74 68 65 20 5b 61 6d 61 6c 67 61 6d  ith the [amalgam
9cd0: 61 74 69 6f 6e 5d 20 0a 61 72 65 20 6c 69 73 74  ation] .are list
9ce0: 65 64 20 62 65 6c 6f 77 2c 20 68 6f 77 65 76 65  ed below, howeve
9cf0: 72 2c 20 74 68 65 20 77 61 72 6e 69 6e 67 73 20  r, the warnings 
9d00: 69 6e 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67  in the following
9d10: 20 70 61 72 61 67 72 61 70 68 20 73 68 6f 75 6c   paragraph shoul
9d20: 64 20 62 65 20 6e 6f 74 65 64 2e 0a 3c 2f 70 3e  d be noted..</p>
9d30: 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c  ..<blockquote>.<
9d40: 69 3e 3c 62 3e 49 6d 70 6f 72 74 61 6e 74 20 4e  i><b>Important N
9d50: 6f 74 65 3a 3c 2f 62 3e 20 54 68 65 20 53 51 4c  ote:</b> The SQL
9d60: 49 54 45 5f 4f 4d 49 54 5f 2a 20 6f 70 74 69 6f  ITE_OMIT_* optio
9d70: 6e 73 20 64 6f 20 6e 6f 74 20 77 6f 72 6b 20 77  ns do not work w
9d80: 69 74 68 20 74 68 65 0a 5b 61 6d 61 6c 67 61 6d  ith the.[amalgam
9d90: 61 74 69 6f 6e 5d 20 6f 72 20 77 69 74 68 20 70  ation] or with p
9da0: 72 65 2d 70 61 63 6b 61 67 65 64 20 43 20 63 6f  re-packaged C co
9db0: 64 65 20 66 69 6c 65 73 2e 20 20 53 51 4c 49 54  de files.  SQLIT
9dc0: 45 5f 4f 4d 49 54 5f 2a 20 63 6f 6d 70 69 6c 65  E_OMIT_* compile
9dd0: 2d 74 69 6d 65 0a 6f 70 74 69 6f 6e 73 20 6f 6e  -time.options on
9de0: 6c 79 20 77 6f 72 6b 20 63 6f 72 72 65 63 74 6c  ly work correctl
9df0: 79 20 77 68 65 6e 20 53 51 4c 69 74 65 20 69 73  y when SQLite is
9e00: 20 62 75 69 6c 74 20 66 72 6f 6d 20 63 61 6e 6f   built from cano
9e10: 6e 69 63 61 6c 20 73 6f 75 72 63 65 20 66 69 6c  nical source fil
9e20: 65 73 2e 0a 3c 2f 69 3e 0a 3c 2f 62 6c 6f 63 6b  es..</i>.</block
9e30: 71 75 6f 74 65 3e 0a 0a 0a 3c 70 3e 53 70 65 63  quote>...<p>Spec
9e40: 69 61 6c 20 76 65 72 73 69 6f 6e 73 20 6f 66 20  ial versions of 
9e50: 74 68 65 20 53 51 4c 69 74 65 20 61 6d 61 6c 67  the SQLite amalg
9e60: 61 6d 61 74 69 6f 6e 20 74 68 61 74 20 64 6f 20  amation that do 
9e70: 77 6f 72 6b 20 77 69 74 68 20 61 0a 70 72 65 64  work with a.pred
9e80: 65 74 65 72 6d 69 6e 65 64 20 73 65 74 20 6f 66  etermined set of
9e90: 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 2a 20 6f   SQLITE_OMIT_* o
9ea0: 70 74 69 6f 6e 73 20 63 61 6e 20 62 65 20 67 65  ptions can be ge
9eb0: 6e 65 72 61 74 65 64 2e 20 20 54 6f 20 64 6f 20  nerated.  To do 
9ec0: 73 6f 2c 0a 6d 61 6b 65 20 61 20 63 6f 70 79 20  so,.make a copy 
9ed0: 6f 66 20 74 68 65 20 4d 61 6b 65 66 69 6c 65 2e  of the Makefile.
9ee0: 6c 69 6e 75 78 2d 67 63 63 20 6d 61 6b 65 66 69  linux-gcc makefi
9ef0: 6c 65 20 74 65 6d 70 6c 61 74 65 20 69 6e 20 74  le template in t
9f00: 68 65 20 63 61 6e 6f 6e 69 63 61 6c 0a 73 6f 75  he canonical.sou
9f10: 72 63 65 20 63 6f 64 65 20 64 69 73 74 72 69 62  rce code distrib
9f20: 75 74 69 6f 6e 2e 20 20 43 68 61 6e 67 65 20 74  ution.  Change t
9f30: 68 65 20 6e 61 6d 65 20 6f 66 20 79 6f 75 72 20  he name of your 
9f40: 63 6f 70 79 20 74 6f 20 73 69 6d 70 6c 79 20 22  copy to simply "
9f50: 4d 61 6b 65 66 69 6c 65 22 2e 0a 54 68 65 6e 20  Makefile"..Then 
9f60: 65 64 69 74 20 22 4d 61 6b 65 66 69 6c 65 22 20  edit "Makefile" 
9f70: 74 6f 20 73 65 74 20 75 70 20 61 70 70 72 6f 70  to set up approp
9f80: 72 69 61 74 65 20 63 6f 6d 70 69 6c 65 2d 74 69  riate compile-ti
9f90: 6d 65 20 6f 70 74 69 6f 6e 73 2e 20 20 54 68 65  me options.  The
9fa0: 6e 0a 74 79 70 65 3a 0a 3c 62 6c 6f 63 6b 71 75  n.type:.<blockqu
9fb0: 6f 74 65 3e 3c 74 74 3e 6d 61 6b 65 20 63 6c 65  ote><tt>make cle
9fc0: 61 6e 3b 20 6d 61 6b 65 20 73 71 6c 69 74 65 33  an; make sqlite3
9fd0: 2e 63 3c 2f 74 74 3e 3c 2f 62 6c 6f 63 6b 71 75  .c</tt></blockqu
9fe0: 6f 74 65 3e 0a 54 68 65 20 72 65 73 75 6c 74 69  ote>.The resulti
9ff0: 6e 67 20 22 73 71 6c 69 74 65 33 2e 63 22 20 61  ng "sqlite3.c" a
a000: 6d 61 6c 67 61 6d 61 74 69 6f 6e 20 63 6f 64 65  malgamation code
a010: 20 66 69 6c 65 20 28 61 6e 64 20 69 74 73 20 61   file (and its a
a020: 73 73 6f 63 69 61 74 65 64 0a 68 65 61 64 65 72  ssociated.header
a030: 20 66 69 6c 65 20 22 73 71 6c 69 74 65 33 2e 68   file "sqlite3.h
a040: 22 29 20 63 61 6e 20 74 68 65 6e 20 62 65 20 6d  ") can then be m
a050: 6f 76 65 64 20 74 6f 20 61 20 6e 6f 6e 2d 75 6e  oved to a non-un
a060: 69 78 20 70 6c 61 74 66 6f 72 6d 0a 66 6f 72 20  ix platform.for 
a070: 66 69 6e 61 6c 20 63 6f 6d 70 69 6c 61 74 69 6f  final compilatio
a080: 6e 20 75 73 69 6e 67 20 61 20 6e 61 74 69 76 65  n using a native
a090: 20 63 6f 6d 70 69 6c 65 72 2e 3c 2f 70 3e 0a 0a   compiler.</p>..
a0a0: 3c 70 3e 41 6c 6c 20 6f 66 20 74 68 65 20 53 51  <p>All of the SQ
a0b0: 4c 49 54 45 5f 4f 4d 49 54 5f 2a 20 6f 70 74 69  LITE_OMIT_* opti
a0c0: 6f 6e 73 20 61 72 65 20 75 6e 73 75 70 70 6f 72  ons are unsuppor
a0d0: 74 65 64 2e 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b  ted.</p>..<block
a0e0: 71 75 6f 74 65 3e 0a 3c 69 3e 3c 62 3e 49 6d 70  quote>.<i><b>Imp
a0f0: 6f 72 74 61 6e 74 20 4e 6f 74 65 3a 3c 2f 62 3e  ortant Note:</b>
a100: 0a 54 68 65 20 53 51 4c 49 54 45 5f 4f 4d 49 54  .The SQLITE_OMIT
a110: 5f 2a 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20  _* compile-time 
a120: 6f 70 74 69 6f 6e 73 20 61 72 65 20 75 6e 73 75  options are unsu
a130: 70 70 6f 72 74 65 64 2e 0a 3c 2f 69 3e 3c 2f 62  pported..</i></b
a140: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 0a  lockquote>..<p>.
a150: 54 68 65 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  The SQLITE_OMIT_
a160: 2a 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f  * compile-time o
a170: 70 74 69 6f 6e 73 20 61 72 65 20 75 73 75 61 6c  ptions are usual
a180: 6c 79 20 75 6e 74 65 73 74 65 64 20 61 6e 64 0a  ly untested and.
a190: 61 72 65 20 61 6c 6d 6f 73 74 20 63 65 72 74 61  are almost certa
a1a0: 69 6e 6c 79 20 75 6e 74 65 73 74 65 64 20 69 6e  inly untested in
a1b0: 20 63 6f 6d 62 69 6e 61 74 69 6f 6e 2e 0a 41 6e   combination..An
a1c0: 79 20 6f 72 20 61 6c 6c 20 6f 66 20 74 68 65 73  y or all of thes
a1d0: 65 20 6f 70 74 69 6f 6e 73 20 6d 61 79 20 62 65  e options may be
a1e0: 20 72 65 6d 6f 76 65 64 20 66 72 6f 6d 20 74 68   removed from th
a1f0: 65 20 63 6f 64 65 20 69 6e 20 66 75 74 75 72 65  e code in future
a200: 20 72 65 6c 65 61 73 65 73 0a 61 6e 64 20 77 69   releases.and wi
a210: 74 68 6f 75 74 20 77 61 72 6e 69 6e 67 2e 20 20  thout warning.  
a220: 46 6f 72 20 61 6e 79 20 70 61 72 74 69 63 75 6c  For any particul
a230: 61 72 20 72 65 6c 65 61 73 65 2c 20 73 6f 6d 65  ar release, some
a240: 20 6f 66 20 74 68 65 73 65 0a 6f 70 74 69 6f 6e   of these.option
a250: 73 20 6d 61 79 20 63 61 75 73 65 20 63 6f 6d 70  s may cause comp
a260: 69 6c 65 2d 74 69 6d 65 20 6f 72 20 72 75 6e 2d  ile-time or run-
a270: 74 69 6d 65 20 66 61 69 6c 75 72 65 73 2c 20 70  time failures, p
a280: 61 72 74 69 63 75 6c 61 72 6c 79 0a 77 68 65 6e  articularly.when
a290: 20 75 73 65 64 20 69 6e 20 63 6f 6d 62 69 6e 61   used in combina
a2a0: 74 69 6f 6e 20 77 69 74 68 20 6f 74 68 65 72 20  tion with other 
a2b0: 6f 70 74 69 6f 6e 73 2e 3c 2f 70 3e 0a 0a 3c 74  options.</p>..<t
a2c0: 63 6c 3e 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49  cl>.COMPILE_OPTI
a2d0: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  ON {SQLITE_OMIT_
a2e0: 41 4c 54 45 52 54 41 42 4c 45 7d 20 7b 0a 20 20  ALTERTABLE} {.  
a2f0: 57 68 65 6e 20 74 68 69 73 20 6f 70 74 69 6f 6e  When this option
a300: 20 69 73 20 64 65 66 69 6e 65 64 2c 20 74 68 65   is defined, the
a310: 20 0a 20 20 5b 41 4c 54 45 52 20 54 41 42 4c 45   .  [ALTER TABLE
a320: 5d 20 63 6f 6d 6d 61 6e 64 20 69 73 20 6e 6f 74  ] command is not
a330: 20 69 6e 63 6c 75 64 65 64 20 69 6e 20 74 68 65   included in the
a340: 20 0a 20 20 6c 69 62 72 61 72 79 2e 20 45 78 65   .  library. Exe
a350: 63 75 74 69 6e 67 20 61 6e 20 5b 41 4c 54 45 52  cuting an [ALTER
a360: 20 54 41 42 4c 45 5d 20 73 74 61 74 65 6d 65 6e   TABLE] statemen
a370: 74 20 63 61 75 73 65 73 20 61 20 70 61 72 73 65  t causes a parse
a380: 20 65 72 72 6f 72 2e 0a 7d 0a 0a 43 4f 4d 50 49   error..}..COMPI
a390: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54  LE_OPTION {SQLIT
a3a0: 45 5f 4f 4d 49 54 5f 41 4e 41 4c 59 5a 45 7d 20  E_OMIT_ANALYZE} 
a3b0: 7b 0a 20 20 57 68 65 6e 20 74 68 69 73 20 6f 70  {.  When this op
a3c0: 74 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 2c  tion is defined,
a3d0: 20 74 68 65 20 5b 41 4e 41 4c 59 5a 45 5d 20 63   the [ANALYZE] c
a3e0: 6f 6d 6d 61 6e 64 20 69 73 20 6f 6d 69 74 74 65  ommand is omitte
a3f0: 64 20 66 72 6f 6d 0a 20 20 74 68 65 20 62 75 69  d from.  the bui
a400: 6c 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f  ld..}..COMPILE_O
a410: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d  PTION {SQLITE_OM
a420: 49 54 5f 41 54 54 41 43 48 7d 20 7b 0a 20 20 57  IT_ATTACH} {.  W
a430: 68 65 6e 20 74 68 69 73 20 6f 70 74 69 6f 6e 20  hen this option 
a440: 69 73 20 64 65 66 69 6e 65 64 2c 20 74 68 65 20  is defined, the 
a450: 5b 41 54 54 41 43 48 5d 20 61 6e 64 20 5b 44 45  [ATTACH] and [DE
a460: 54 41 43 48 5d 20 63 6f 6d 6d 61 6e 64 73 20 61  TACH] commands a
a470: 72 65 0a 20 20 6f 6d 69 74 74 65 64 20 66 72 6f  re.  omitted fro
a480: 6d 20 74 68 65 20 62 75 69 6c 64 2e 0a 7d 0a 0a  m the build..}..
a490: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b  COMPILE_OPTION {
a4a0: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 55 54 48  SQLITE_OMIT_AUTH
a4b0: 4f 52 49 5a 41 54 49 4f 4e 7d 20 7b 0a 20 20 44  ORIZATION} {.  D
a4c0: 65 66 69 6e 69 6e 67 20 74 68 69 73 20 6f 70 74  efining this opt
a4d0: 69 6f 6e 20 6f 6d 69 74 73 20 74 68 65 20 61 75  ion omits the au
a4e0: 74 68 6f 72 69 7a 61 74 69 6f 6e 20 63 61 6c 6c  thorization call
a4f0: 62 61 63 6b 20 66 65 61 74 75 72 65 20 66 72 6f  back feature fro
a500: 6d 20 74 68 65 0a 20 20 6c 69 62 72 61 72 79 2e  m the.  library.
a510: 20 54 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 65   The [sqlite3_se
a520: 74 5f 61 75 74 68 6f 72 69 7a 65 72 28 29 5d 20  t_authorizer()] 
a530: 41 50 49 20 66 75 6e 63 74 69 6f 6e 20 69 73 20  API function is 
a540: 6e 6f 74 20 70 72 65 73 65 6e 74 0a 20 20 69 6e  not present.  in
a550: 20 74 68 65 20 6c 69 62 72 61 72 79 2e 0a 7d 0a   the library..}.
a560: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20  .COMPILE_OPTION 
a570: 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 55 54  {SQLITE_OMIT_AUT
a580: 4f 49 4e 43 52 45 4d 45 4e 54 7d 20 7b 0a 20 20  OINCREMENT} {.  
a590: 54 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 75  This option is u
a5a0: 73 65 64 20 74 6f 20 6f 6d 69 74 20 74 68 65 20  sed to omit the 
a5b0: 0a 20 20 5b 41 55 54 4f 49 4e 43 52 45 4d 45 4e  .  [AUTOINCREMEN
a5c0: 54 5d 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74 79  T] functionality
a5d0: 2e 20 57 68 65 6e 20 74 68 69 73 20 0a 20 20 69  . When this .  i
a5e0: 73 20 6d 61 63 72 6f 20 69 73 20 64 65 66 69 6e  s macro is defin
a5f0: 65 64 2c 20 63 6f 6c 75 6d 6e 73 20 64 65 63 6c  ed, columns decl
a600: 61 72 65 64 20 61 73 20 0a 20 20 22 5b 49 4e 54  ared as .  "[INT
a610: 45 47 45 52 20 50 52 49 4d 41 52 59 20 4b 45 59  EGER PRIMARY KEY
a620: 5d 20 41 55 54 4f 49 4e 43 52 45 4d 45 4e 54 22  ] AUTOINCREMENT"
a630: 0a 20 20 62 65 68 61 76 65 20 69 6e 20 74 68 65  .  behave in the
a640: 20 73 61 6d 65 20 77 61 79 20 61 73 20 63 6f 6c   same way as col
a650: 75 6d 6e 73 20 64 65 63 6c 61 72 65 64 20 61 73  umns declared as
a660: 20 22 5b 49 4e 54 45 47 45 52 20 50 52 49 4d 41   "[INTEGER PRIMA
a670: 52 59 20 4b 45 59 5d 22 20 77 68 65 6e 20 61 20  RY KEY]" when a 
a680: 0a 20 20 4e 55 4c 4c 20 69 73 20 69 6e 73 65 72  .  NULL is inser
a690: 74 65 64 2e 20 54 68 65 20 73 71 6c 69 74 65 5f  ted. The sqlite_
a6a0: 73 65 71 75 65 6e 63 65 20 73 79 73 74 65 6d 20  sequence system 
a6b0: 74 61 62 6c 65 20 69 73 20 6e 65 69 74 68 65 72  table is neither
a6c0: 20 63 72 65 61 74 65 64 2c 20 6e 6f 72 0a 20 20   created, nor.  
a6d0: 72 65 73 70 65 63 74 65 64 20 69 66 20 69 74 20  respected if it 
a6e0: 61 6c 72 65 61 64 79 20 65 78 69 73 74 73 2e 0a  already exists..
a6f0: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f  }..COMPILE_OPTIO
a700: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41  N {SQLITE_OMIT_A
a710: 55 54 4f 49 4e 49 54 7d 20 7b 0a 20 20 46 6f 72  UTOINIT} {.  For
a720: 20 62 61 63 6b 77 61 72 64 73 20 63 6f 6d 70 61   backwards compa
a730: 74 69 62 69 6c 69 74 79 20 77 69 74 68 20 6f 6c  tibility with ol
a740: 64 65 72 20 76 65 72 73 69 6f 6e 73 20 6f 66 20  der versions of 
a750: 53 51 4c 69 74 65 20 74 68 61 74 20 6c 61 63 6b  SQLite that lack
a760: 0a 20 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  .  the [sqlite3_
a770: 69 6e 69 74 69 61 6c 69 7a 65 28 29 5d 20 69 6e  initialize()] in
a780: 74 65 72 66 61 63 65 2c 20 74 68 65 20 5b 73 71  terface, the [sq
a790: 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65  lite3_initialize
a7a0: 28 29 5d 20 69 6e 74 65 72 66 61 63 65 0a 20 20  ()] interface.  
a7b0: 69 73 20 63 61 6c 6c 65 64 20 61 75 74 6f 6d 61  is called automa
a7c0: 74 69 63 61 6c 6c 79 20 75 70 6f 6e 20 65 6e 74  tically upon ent
a7d0: 72 79 20 74 6f 20 63 65 72 74 61 69 6e 20 6b 65  ry to certain ke
a7e0: 79 20 69 6e 74 65 72 66 61 63 65 73 20 73 75 63  y interfaces suc
a7f0: 68 20 61 73 0a 20 20 5b 73 71 6c 69 74 65 33 5f  h as.  [sqlite3_
a800: 6f 70 65 6e 28 29 5d 2c 20 5b 73 71 6c 69 74 65  open()], [sqlite
a810: 33 5f 76 66 73 5f 72 65 67 69 73 74 65 72 28 29  3_vfs_register()
a820: 5d 2c 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f  ], and [sqlite3_
a830: 6d 70 72 69 6e 74 66 28 29 5d 2e 0a 20 20 54 68  mprintf()]..  Th
a840: 65 20 6f 76 65 72 68 65 61 64 20 6f 66 20 69 6e  e overhead of in
a850: 76 6f 6b 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f  voking [sqlite3_
a860: 69 6e 69 74 69 61 6c 69 7a 65 28 29 5d 20 61 75  initialize()] au
a870: 74 6f 6d 61 74 69 63 61 6c 6c 79 20 69 6e 20 74  tomatically in t
a880: 68 69 73 0a 20 20 77 61 79 20 6d 61 79 20 62 65  his.  way may be
a890: 20 6f 6d 69 74 74 65 64 20 62 79 20 62 75 69 6c   omitted by buil
a8a0: 64 69 6e 67 20 53 51 4c 69 74 65 20 77 69 74 68  ding SQLite with
a8b0: 20 74 68 65 20 53 51 4c 49 54 45 5f 4f 4d 49 54   the SQLITE_OMIT
a8c0: 5f 41 55 54 4f 49 4e 49 54 0a 20 20 43 2d 70 72  _AUTOINIT.  C-pr
a8d0: 65 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f  eprocessor macro
a8e0: 2e 20 20 57 68 65 6e 20 62 75 69 6c 74 20 75 73  .  When built us
a8f0: 69 6e 67 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  ing SQLITE_OMIT_
a900: 41 55 54 4f 49 4e 49 54 2c 20 53 51 4c 69 74 65  AUTOINIT, SQLite
a910: 0a 20 20 77 69 6c 6c 20 6e 6f 74 20 61 75 74 6f  .  will not auto
a920: 6d 61 74 69 63 61 6c 6c 79 20 69 6e 69 74 69 61  matically initia
a930: 6c 69 7a 65 20 69 74 73 65 6c 66 20 61 6e 64 20  lize itself and 
a940: 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20  the application 
a950: 69 73 20 72 65 71 75 69 72 65 64 0a 20 20 74 6f  is required.  to
a960: 20 69 6e 76 6f 6b 65 20 5b 73 71 6c 69 74 65 33   invoke [sqlite3
a970: 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 5d 20 64  _initialize()] d
a980: 69 72 65 63 74 6c 79 20 70 72 69 6f 72 20 74 6f  irectly prior to
a990: 20 62 65 67 69 6e 6e 69 6e 67 20 75 73 65 20 6f   beginning use o
a9a0: 66 20 74 68 65 0a 20 20 53 51 4c 69 74 65 20 6c  f the.  SQLite l
a9b0: 69 62 72 61 72 79 2e 0a 7d 0a 0a 43 4f 4d 50 49  ibrary..}..COMPI
a9c0: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54  LE_OPTION {SQLIT
a9d0: 45 5f 4f 4d 49 54 5f 41 55 54 4f 4d 41 54 49 43  E_OMIT_AUTOMATIC
a9e0: 5f 49 4e 44 45 58 7d 20 7b 0a 20 20 54 68 69 73  _INDEX} {.  This
a9f0: 20 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 20   option is used 
aa00: 74 6f 20 6f 6d 69 74 20 74 68 65 20 0a 20 20 5b  to omit the .  [
aa10: 61 75 74 6f 6d 61 74 69 63 20 69 6e 64 65 78 69  automatic indexi
aa20: 6e 67 5d 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74  ng] functionalit
aa30: 79 2e 0a 20 20 53 65 65 20 61 6c 73 6f 3a 20 5b  y..  See also: [
aa40: 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f 41  SQLITE_DEFAULT_A
aa50: 55 54 4f 4d 41 54 49 43 5f 49 4e 44 45 58 5d 2e  UTOMATIC_INDEX].
aa60: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49  .}..COMPILE_OPTI
aa70: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  ON {SQLITE_OMIT_
aa80: 41 55 54 4f 52 45 53 45 54 7d 20 7b 0a 20 20 42  AUTORESET} {.  B
aa90: 79 20 64 65 66 61 75 6c 74 2c 20 74 68 65 20 5b  y default, the [
aaa0: 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20  sqlite3_step()] 
aab0: 69 6e 74 65 72 66 61 63 65 20 77 69 6c 6c 20 61  interface will a
aac0: 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 69 6e 76  utomatically inv
aad0: 6f 6b 65 0a 20 20 5b 73 71 6c 69 74 65 33 5f 72  oke.  [sqlite3_r
aae0: 65 73 65 74 28 29 5d 20 74 6f 20 72 65 73 65 74  eset()] to reset
aaf0: 20 74 68 65 20 5b 70 72 65 70 61 72 65 64 20 73   the [prepared s
ab00: 74 61 74 65 6d 65 6e 74 5d 20 69 66 20 6e 65 63  tatement] if nec
ab10: 65 73 73 61 72 79 2e 20 20 54 68 69 73 0a 20 20  essary.  This.  
ab20: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
ab30: 69 6f 6e 20 63 68 61 6e 67 65 73 20 74 68 61 74  ion changes that
ab40: 20 62 65 68 61 76 69 6f 72 20 73 6f 20 74 68 61   behavior so tha
ab50: 74 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28  t [sqlite3_step(
ab60: 29 5d 20 77 69 6c 6c 0a 20 20 72 65 74 75 72 6e  )] will.  return
ab70: 20 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 5d   [SQLITE_MISUSE]
ab80: 20 69 66 20 69 74 20 63 61 6c 6c 65 64 20 61 67   if it called ag
ab90: 61 69 6e 20 61 66 74 65 72 20 72 65 74 75 72 6e  ain after return
aba0: 69 6e 67 20 61 6e 79 74 68 69 6e 67 20 6f 74 68  ing anything oth
abb0: 65 72 0a 20 20 74 68 61 6e 20 5b 53 51 4c 49 54  er.  than [SQLIT
abc0: 45 5f 52 4f 57 5d 2c 20 5b 53 51 4c 49 54 45 5f  E_ROW], [SQLITE_
abd0: 42 55 53 59 5d 2c 20 6f 72 20 5b 53 51 4c 49 54  BUSY], or [SQLIT
abe0: 45 5f 4c 4f 43 4b 45 44 5d 20 75 6e 6c 65 73 73  E_LOCKED] unless
abf0: 20 74 68 65 72 65 20 77 61 73 20 61 6e 0a 20 20   there was an.  
ac00: 69 6e 74 65 72 76 65 6e 69 6e 67 20 63 61 6c 6c  intervening call
ac10: 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 72 65 73   to [sqlite3_res
ac20: 65 74 28 29 5d 2e 0a 0a 20 20 49 6e 20 53 51 4c  et()]...  In SQL
ac30: 69 74 65 20 76 65 72 73 69 6f 6e 20 33 2e 36 2e  ite version 3.6.
ac40: 32 33 2e 31 20 61 6e 64 20 65 61 72 6c 69 65 72  23.1 and earlier
ac50: 2c 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28  , [sqlite3_step(
ac60: 29 5d 20 75 73 65 64 20 74 6f 20 61 6c 77 61 79  )] used to alway
ac70: 73 0a 20 20 72 65 74 75 72 6e 20 5b 53 51 4c 49  s.  return [SQLI
ac80: 54 45 5f 4d 49 53 55 53 45 5d 20 69 66 20 69 74  TE_MISUSE] if it
ac90: 20 77 61 73 20 69 6e 76 6f 6b 65 64 20 61 67 61   was invoked aga
aca0: 69 6e 20 61 66 74 65 72 20 72 65 74 75 72 6e 69  in after returni
acb0: 6e 67 20 61 6e 79 74 68 69 6e 67 0a 20 20 6f 74  ng anything.  ot
acc0: 68 65 72 20 74 68 61 6e 20 5b 53 51 4c 49 54 45  her than [SQLITE
acd0: 5f 52 4f 57 5d 20 77 69 74 68 6f 75 74 20 61 6e  _ROW] without an
ace0: 20 69 6e 74 65 72 76 65 6e 69 6e 67 20 63 61 6c   intervening cal
acf0: 6c 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 72 65  l to [sqlite3_re
ad00: 73 65 74 28 29 5d 2e 0a 20 20 54 68 69 73 20 63  set()]..  This c
ad10: 61 75 73 65 64 20 70 72 6f 62 6c 65 6d 73 20 6f  aused problems o
ad20: 6e 20 73 6f 6d 65 20 70 6f 6f 72 6c 79 20 77 72  n some poorly wr
ad30: 69 74 74 65 6e 20 73 6d 61 72 74 70 68 6f 6e 65  itten smartphone
ad40: 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 77 68   applications wh
ad50: 69 63 68 0a 20 20 64 69 64 20 6e 6f 74 20 63 6f  ich.  did not co
ad60: 72 72 65 63 74 6c 79 20 68 61 6e 64 6c 65 20 74  rrectly handle t
ad70: 68 65 20 5b 53 51 4c 49 54 45 5f 4c 4f 43 4b 45  he [SQLITE_LOCKE
ad80: 44 5d 20 61 6e 64 20 5b 53 51 4c 49 54 45 5f 42  D] and [SQLITE_B
ad90: 55 53 59 5d 20 65 72 72 6f 72 20 0a 20 20 72 65  USY] error .  re
ada0: 74 75 72 6e 73 2e 20 20 52 61 74 68 65 72 20 74  turns.  Rather t
adb0: 68 61 6e 20 66 69 78 20 74 68 65 20 6d 61 6e 79  han fix the many
adc0: 20 64 65 66 65 63 74 69 76 65 20 73 6d 61 72 74   defective smart
add0: 70 68 6f 6e 65 20 61 70 70 6c 69 63 61 74 69 6f  phone applicatio
ade0: 6e 73 2c 20 0a 20 20 74 68 65 20 62 65 68 61 76  ns, .  the behav
adf0: 69 6f 72 20 6f 66 20 53 51 4c 69 74 65 20 77 61  ior of SQLite wa
ae00: 73 20 63 68 61 6e 67 65 64 20 69 6e 20 33 2e 36  s changed in 3.6
ae10: 2e 32 33 2e 32 20 74 6f 20 61 75 74 6f 6d 61 74  .23.2 to automat
ae20: 69 63 61 6c 6c 79 20 72 65 73 65 74 0a 20 20 74  ically reset.  t
ae30: 68 65 20 70 72 65 70 61 72 65 64 20 73 74 61 74  he prepared stat
ae40: 65 6d 65 6e 74 2e 20 20 42 75 74 20 74 68 61 74  ement.  But that
ae50: 20 63 68 61 6e 67 65 64 20 63 61 75 73 65 64 20   changed caused 
ae60: 69 73 73 75 65 73 20 69 6e 20 6f 74 68 65 72 20  issues in other 
ae70: 0a 20 20 69 6d 70 72 6f 70 65 72 6c 79 20 69 6d  .  improperly im
ae80: 70 6c 65 6d 65 6e 74 65 64 20 61 70 70 6c 69 63  plemented applic
ae90: 61 74 69 6f 6e 73 20 74 68 61 74 20 77 65 72 65  ations that were
aea0: 20 61 63 74 75 61 6c 6c 79 20 6c 6f 6f 6b 69 6e   actually lookin
aeb0: 67 0a 20 20 66 6f 72 20 61 6e 20 5b 53 51 4c 49  g.  for an [SQLI
aec0: 54 45 5f 4d 49 53 55 53 45 5d 20 72 65 74 75 72  TE_MISUSE] retur
aed0: 6e 20 74 6f 20 74 65 72 6d 69 6e 61 74 65 20 74  n to terminate t
aee0: 68 65 69 72 20 71 75 65 72 79 20 6c 6f 6f 70 73  heir query loops
aef0: 2e 20 20 28 41 6e 79 74 69 6d 65 0a 20 20 61 6e  .  (Anytime.  an
af00: 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 67 65 74   application get
af10: 73 20 61 6e 20 53 51 4c 49 54 45 5f 4d 49 53 55  s an SQLITE_MISU
af20: 53 45 20 65 72 72 6f 72 20 63 6f 64 65 20 66 72  SE error code fr
af30: 6f 6d 20 53 51 4c 69 74 65 2c 20 74 68 61 74 20  om SQLite, that 
af40: 6d 65 61 6e 73 20 74 68 65 0a 20 20 61 70 70 6c  means the.  appl
af50: 69 63 61 74 69 6f 6e 20 69 73 20 6d 69 73 75 73  ication is misus
af60: 69 6e 67 20 74 68 65 20 53 51 4c 69 74 65 20 69  ing the SQLite i
af70: 6e 74 65 72 66 61 63 65 20 61 6e 64 20 69 73 20  nterface and is 
af80: 74 68 75 73 20 69 6e 63 6f 72 72 65 63 74 6c 79  thus incorrectly
af90: 0a 20 20 69 6d 70 6c 65 6d 65 6e 74 65 64 2e 29  .  implemented.)
afa0: 20 20 54 68 65 20 53 51 4c 49 54 45 5f 4f 4d 49    The SQLITE_OMI
afb0: 54 5f 41 55 54 4f 52 45 53 45 54 20 69 6e 74 65  T_AUTORESET inte
afc0: 72 66 61 63 65 20 77 61 73 20 61 64 64 65 64 20  rface was added 
afd0: 74 6f 20 53 51 4c 69 74 65 0a 20 20 76 65 72 73  to SQLite.  vers
afe0: 69 6f 6e 20 33 2e 37 2e 35 20 69 6e 20 61 6e 20  ion 3.7.5 in an 
aff0: 65 66 66 6f 72 74 20 74 6f 20 67 65 74 20 61 6c  effort to get al
b000: 6c 20 6f 66 20 74 68 65 20 28 62 72 6f 6b 65 6e  l of the (broken
b010: 29 0a 20 20 61 70 70 6c 69 63 61 74 69 6f 6e 73  ).  applications
b020: 20 74 6f 20 77 6f 72 6b 20 61 67 61 69 6e 20 77   to work again w
b030: 69 74 68 6f 75 74 20 68 61 76 69 6e 67 20 74 6f  ithout having to
b040: 20 61 63 74 75 61 6c 6c 79 20 66 69 78 20 74 68   actually fix th
b050: 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 2e 0a  e applications..
b060: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f  }..COMPILE_OPTIO
b070: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41  N {SQLITE_OMIT_A
b080: 55 54 4f 56 41 43 55 55 4d 7d 20 7b 0a 20 20 49  UTOVACUUM} {.  I
b090: 66 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73  f this option is
b0a0: 20 64 65 66 69 6e 65 64 2c 20 74 68 65 20 6c 69   defined, the li
b0b0: 62 72 61 72 79 20 63 61 6e 6e 6f 74 20 63 72 65  brary cannot cre
b0c0: 61 74 65 20 6f 72 20 77 72 69 74 65 20 74 6f 20  ate or write to 
b0d0: 0a 20 20 64 61 74 61 62 61 73 65 73 20 74 68 61  .  databases tha
b0e0: 74 20 73 75 70 70 6f 72 74 20 5b 61 75 74 6f 5f  t support [auto_
b0f0: 76 61 63 75 75 6d 5d 2e 0a 20 20 45 78 65 63 75  vacuum]..  Execu
b100: 74 69 6e 67 20 61 20 5b 50 52 41 47 4d 41 20 61  ting a [PRAGMA a
b110: 75 74 6f 5f 76 61 63 75 75 6d 5d 20 73 74 61 74  uto_vacuum] stat
b120: 65 6d 65 6e 74 20 69 73 20 6e 6f 74 20 61 6e 20  ement is not an 
b130: 65 72 72 6f 72 0a 20 20 28 73 69 6e 63 65 20 75  error.  (since u
b140: 6e 6b 6e 6f 77 6e 20 50 52 41 47 4d 41 73 20 61  nknown PRAGMAs a
b150: 72 65 20 73 69 6c 65 6e 74 6c 79 20 69 67 6e 6f  re silently igno
b160: 72 65 64 29 2c 20 62 75 74 20 64 6f 65 73 20 6e  red), but does n
b170: 6f 74 20 72 65 74 75 72 6e 20 61 20 76 61 6c 75  ot return a valu
b180: 65 0a 20 20 6f 72 20 6d 6f 64 69 66 79 20 74 68  e.  or modify th
b190: 65 20 61 75 74 6f 2d 76 61 63 75 75 6d 20 66 6c  e auto-vacuum fl
b1a0: 61 67 20 69 6e 20 74 68 65 20 64 61 74 61 62 61  ag in the databa
b1b0: 73 65 20 66 69 6c 65 2e 20 49 66 20 61 20 64 61  se file. If a da
b1c0: 74 61 62 61 73 65 20 74 68 61 74 0a 20 20 73 75  tabase that.  su
b1d0: 70 70 6f 72 74 73 20 61 75 74 6f 2d 76 61 63 75  pports auto-vacu
b1e0: 75 6d 20 69 73 20 6f 70 65 6e 65 64 20 62 79 20  um is opened by 
b1f0: 61 20 6c 69 62 72 61 72 79 20 63 6f 6d 70 69 6c  a library compil
b200: 65 64 20 77 69 74 68 20 74 68 69 73 20 6f 70 74  ed with this opt
b210: 69 6f 6e 2c 20 69 74 0a 20 20 69 73 20 61 75 74  ion, it.  is aut
b220: 6f 6d 61 74 69 63 61 6c 6c 79 20 6f 70 65 6e 65  omatically opene
b230: 64 20 69 6e 20 72 65 61 64 2d 6f 6e 6c 79 20 6d  d in read-only m
b240: 6f 64 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f  ode..}..COMPILE_
b250: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f  OPTION {SQLITE_O
b260: 4d 49 54 5f 42 45 54 57 45 45 4e 5f 4f 50 54 49  MIT_BETWEEN_OPTI
b270: 4d 49 5a 41 54 49 4f 4e 7d 20 7b 0a 20 20 54 68  MIZATION} {.  Th
b280: 69 73 20 6f 70 74 69 6f 6e 20 64 69 73 61 62 6c  is option disabl
b290: 65 73 20 74 68 65 20 75 73 65 20 6f 66 20 69 6e  es the use of in
b2a0: 64 69 63 65 73 20 77 69 74 68 20 57 48 45 52 45  dices with WHERE
b2b0: 20 63 6c 61 75 73 65 20 74 65 72 6d 73 0a 20 20   clause terms.  
b2c0: 74 68 61 74 20 65 6d 70 6c 6f 79 20 74 68 65 20  that employ the 
b2d0: 42 45 54 57 45 45 4e 20 6f 70 65 72 61 74 6f 72  BETWEEN operator
b2e0: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54  ..}..COMPILE_OPT
b2f0: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54  ION {SQLITE_OMIT
b300: 5f 42 4c 4f 42 5f 4c 49 54 45 52 41 4c 7d 20 7b  _BLOB_LITERAL} {
b310: 0a 20 20 57 68 65 6e 20 74 68 69 73 20 6f 70 74  .  When this opt
b320: 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 2c 20  ion is defined, 
b330: 69 74 20 69 73 20 6e 6f 74 20 70 6f 73 73 69 62  it is not possib
b340: 6c 65 20 74 6f 20 73 70 65 63 69 66 79 20 61 20  le to specify a 
b350: 62 6c 6f 62 20 69 6e 0a 20 20 61 6e 20 53 51 4c  blob in.  an SQL
b360: 20 73 74 61 74 65 6d 65 6e 74 20 75 73 69 6e 67   statement using
b370: 20 74 68 65 20 58 27 41 42 43 44 27 20 73 79 6e   the X'ABCD' syn
b380: 74 61 78 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f  tax..}..COMPILE_
b390: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f  OPTION {SQLITE_O
b3a0: 4d 49 54 5f 42 54 52 45 45 43 4f 55 4e 54 7d 20  MIT_BTREECOUNT} 
b3b0: 7b 0a 20 20 57 68 65 6e 20 74 68 69 73 20 6f 70  {.  When this op
b3c0: 74 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 2c  tion is defined,
b3d0: 20 61 6e 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e   an optimization
b3e0: 20 74 68 61 74 20 61 63 63 65 6c 65 72 61 74 65   that accelerate
b3f0: 73 20 63 6f 75 6e 74 69 6e 67 0a 20 20 61 6c 6c  s counting.  all
b400: 20 65 6e 74 72 69 65 73 20 69 6e 20 61 20 74 61   entries in a ta
b410: 62 6c 65 20 28 69 6e 20 6f 74 68 65 72 20 77 6f  ble (in other wo
b420: 72 64 73 2c 20 61 6e 20 6f 70 74 69 6d 69 7a 61  rds, an optimiza
b430: 74 69 6f 6e 20 74 68 61 74 20 68 65 6c 70 73 0a  tion that helps.
b440: 20 20 22 53 45 4c 45 43 54 20 63 6f 75 6e 74 28    "SELECT count(
b450: 2a 29 20 46 52 4f 4d 20 74 61 62 6c 65 22 20 72  *) FROM table" r
b460: 75 6e 20 66 61 73 74 65 72 29 20 69 73 20 6f 6d  un faster) is om
b470: 69 74 74 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c  itted..}..COMPIL
b480: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45  E_OPTION {SQLITE
b490: 5f 4f 4d 49 54 5f 42 55 49 4c 54 49 4e 5f 54 45  _OMIT_BUILTIN_TE
b4a0: 53 54 7d 20 7b 0a 20 20 41 20 73 74 61 6e 64 61  ST} {.  A standa
b4b0: 72 64 20 53 51 4c 69 74 65 20 62 75 69 6c 64 20  rd SQLite build 
b4c0: 69 6e 63 6c 75 64 65 73 20 61 20 73 6d 61 6c 6c  includes a small
b4d0: 20 61 6d 6f 75 6e 74 20 6f 66 20 6c 6f 67 69 63   amount of logic
b4e0: 20 63 6f 6e 74 72 6f 6c 6c 65 64 0a 20 20 62 79   controlled.  by
b4f0: 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 74 65   the [sqlite3_te
b500: 73 74 5f 63 6f 6e 74 72 6f 6c 28 29 5d 20 69 6e  st_control()] in
b510: 74 65 72 66 61 63 65 20 74 68 61 74 20 69 73 20  terface that is 
b520: 75 73 65 64 20 74 6f 20 65 78 65 72 63 69 73 65  used to exercise
b530: 0a 20 20 70 61 72 74 73 20 6f 66 20 74 68 65 20  .  parts of the 
b540: 53 51 4c 69 74 65 20 63 6f 72 65 20 74 68 61 74  SQLite core that
b550: 20 61 72 65 20 64 69 66 66 69 63 75 6c 74 20 74   are difficult t
b560: 6f 20 63 6f 6e 74 72 6f 6c 20 61 6e 64 20 6d 65  o control and me
b570: 61 73 75 72 65 20 75 73 69 6e 67 0a 20 20 74 68  asure using.  th
b580: 65 20 73 74 61 6e 64 61 72 64 20 41 50 49 2e 20  e standard API. 
b590: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69   This option omi
b5a0: 74 73 20 74 68 61 74 20 62 75 69 6c 74 2d 69 6e  ts that built-in
b5b0: 20 74 65 73 74 20 6c 6f 67 69 63 2e 0a 7d 0a 0a   test logic..}..
b5c0: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b  COMPILE_OPTION {
b5d0: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 43 41 53 54  SQLITE_OMIT_CAST
b5e0: 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f  } {.  This optio
b5f0: 6e 20 63 61 75 73 65 73 20 53 51 4c 69 74 65 20  n causes SQLite 
b600: 74 6f 20 6f 6d 69 74 20 73 75 70 70 6f 72 74 20  to omit support 
b610: 66 6f 72 20 74 68 65 20 43 41 53 54 20 6f 70 65  for the CAST ope
b620: 72 61 74 6f 72 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c  rator..}..COMPIL
b630: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45  E_OPTION {SQLITE
b640: 5f 4f 4d 49 54 5f 43 48 45 43 4b 7d 20 7b 0a 20  _OMIT_CHECK} {. 
b650: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 75   This option cau
b660: 73 65 73 20 53 51 4c 69 74 65 20 74 6f 20 6f 6d  ses SQLite to om
b670: 69 74 20 73 75 70 70 6f 72 74 20 66 6f 72 20 43  it support for C
b680: 48 45 43 4b 20 63 6f 6e 73 74 72 61 69 6e 74 73  HECK constraints
b690: 2e 0a 20 20 54 68 65 20 70 61 72 73 65 72 20 77  ..  The parser w
b6a0: 69 6c 6c 20 73 74 69 6c 6c 20 61 63 63 65 70 74  ill still accept
b6b0: 20 43 48 45 43 4b 20 63 6f 6e 73 74 72 61 69 6e   CHECK constrain
b6c0: 74 73 20 69 6e 20 53 51 4c 20 73 74 61 74 65 6d  ts in SQL statem
b6d0: 65 6e 74 73 2c 0a 20 20 74 68 65 79 20 77 69 6c  ents,.  they wil
b6e0: 6c 20 6a 75 73 74 20 6e 6f 74 20 62 65 20 65 6e  l just not be en
b6f0: 66 6f 72 63 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49  forced..}..COMPI
b700: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54  LE_OPTION {SQLIT
b710: 45 5f 4f 4d 49 54 5f 43 4f 4d 50 49 4c 45 4f 50  E_OMIT_COMPILEOP
b720: 54 49 4f 4e 5f 44 49 41 47 53 7d 20 7b 0a 20 20  TION_DIAGS} {.  
b730: 54 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 75  This option is u
b740: 73 65 64 20 74 6f 20 6f 6d 69 74 20 74 68 65 20  sed to omit the 
b750: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
b760: 69 6f 6e 20 64 69 61 67 6e 6f 73 74 69 63 73 20  ion diagnostics 
b770: 61 76 61 69 6c 61 62 6c 65 0a 20 20 69 6e 20 53  available.  in S
b780: 51 4c 69 74 65 2c 20 69 6e 63 6c 75 64 69 6e 67  QLite, including
b790: 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 63 6f   the [sqlite3_co
b7a0: 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 75 73 65 64  mpileoption_used
b7b0: 28 29 5d 20 61 6e 64 0a 20 20 5b 73 71 6c 69 74  ()] and.  [sqlit
b7c0: 65 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e  e3_compileoption
b7d0: 5f 67 65 74 28 29 5d 20 43 2f 43 2b 2b 20 66 75  _get()] C/C++ fu
b7e0: 6e 63 74 69 6f 6e 73 2c 20 74 68 65 0a 20 20 5b  nctions, the.  [
b7f0: 73 71 6c 69 74 65 5f 63 6f 6d 70 69 6c 65 6f 70  sqlite_compileop
b800: 74 69 6f 6e 5f 75 73 65 64 28 29 5d 20 61 6e 64  tion_used()] and
b810: 20 5b 73 71 6c 69 74 65 5f 63 6f 6d 70 69 6c 65   [sqlite_compile
b820: 6f 70 74 69 6f 6e 5f 67 65 74 28 29 5d 20 53 51  option_get()] SQ
b830: 4c 20 66 75 6e 63 74 69 6f 6e 73 2c 0a 20 20 61  L functions,.  a
b840: 6e 64 20 74 68 65 20 5b 63 6f 6d 70 69 6c 65 5f  nd the [compile_
b850: 6f 70 74 69 6f 6e 73 20 70 72 61 67 6d 61 5d 2e  options pragma].
b860: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49  .}..COMPILE_OPTI
b870: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  ON {SQLITE_OMIT_
b880: 43 4f 4d 50 4c 45 54 45 7d 20 7b 0a 20 20 54 68  COMPLETE} {.  Th
b890: 69 73 20 6f 70 74 69 6f 6e 20 63 61 75 73 65 73  is option causes
b8a0: 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 63 6f   the [sqlite3_co
b8b0: 6d 70 6c 65 74 65 28 29 5d 20 61 6e 64 20 5b 73  mplete()] and [s
b8c0: 71 6c 69 74 65 33 5f 63 6f 6d 70 6c 65 74 65 31  qlite3_complete1
b8d0: 36 28 29 5d 0a 20 20 69 6e 74 65 72 66 61 63 65  6()].  interface
b8e0: 73 20 74 6f 20 62 65 20 6f 6d 69 74 74 65 64 2e  s to be omitted.
b8f0: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49  .}..COMPILE_OPTI
b900: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  ON {SQLITE_OMIT_
b910: 43 4f 4d 50 4f 55 4e 44 5f 53 45 4c 45 43 54 7d  COMPOUND_SELECT}
b920: 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e   {.  This option
b930: 20 69 73 20 75 73 65 64 20 74 6f 20 6f 6d 69 74   is used to omit
b940: 20 74 68 65 20 63 6f 6d 70 6f 75 6e 64 20 5b 53   the compound [S
b950: 45 4c 45 43 54 5d 20 66 75 6e 63 74 69 6f 6e 61  ELECT] functiona
b960: 6c 69 74 79 2e 20 0a 20 20 5b 53 45 4c 45 43 54  lity. .  [SELECT
b970: 5d 20 73 74 61 74 65 6d 65 6e 74 73 20 74 68 61  ] statements tha
b980: 74 20 75 73 65 20 74 68 65 20 0a 20 20 55 4e 49  t use the .  UNI
b990: 4f 4e 2c 20 55 4e 49 4f 4e 20 41 4c 4c 2c 20 49  ON, UNION ALL, I
b9a0: 4e 54 45 52 53 45 43 54 20 6f 72 20 45 58 43 45  NTERSECT or EXCE
b9b0: 50 54 20 63 6f 6d 70 6f 75 6e 64 20 53 45 4c 45  PT compound SELE
b9c0: 43 54 20 6f 70 65 72 61 74 6f 72 73 20 77 69 6c  CT operators wil
b9d0: 6c 20 0a 20 20 63 61 75 73 65 20 61 20 70 61 72  l .  cause a par
b9e0: 73 65 20 65 72 72 6f 72 2e 0a 0a 20 20 41 6e 20  se error...  An 
b9f0: 5b 49 4e 53 45 52 54 5d 20 73 74 61 74 65 6d 65  [INSERT] stateme
ba00: 6e 74 20 77 69 74 68 20 6d 75 6c 74 69 70 6c 65  nt with multiple
ba10: 20 76 61 6c 75 65 73 20 69 6e 20 74 68 65 20 56   values in the V
ba20: 41 4c 55 45 53 20 63 6c 61 75 73 65 20 69 73 0a  ALUES clause is.
ba30: 20 20 69 6d 70 6c 65 6d 65 6e 74 65 64 20 69 6e    implemented in
ba40: 74 65 72 6e 61 6c 6c 79 20 61 73 20 61 20 63 6f  ternally as a co
ba50: 6d 70 6f 75 6e 64 20 53 45 4c 45 43 54 2e 20 20  mpound SELECT.  
ba60: 48 65 6e 63 65 2c 20 74 68 69 73 20 6f 70 74 69  Hence, this opti
ba70: 6f 6e 20 61 6c 73 6f 0a 20 20 64 69 73 61 62 6c  on also.  disabl
ba80: 65 73 20 74 68 65 20 61 62 69 6c 69 74 79 20 74  es the ability t
ba90: 6f 20 69 6e 73 65 72 74 20 6d 6f 72 65 20 74 68  o insert more th
baa0: 61 6e 20 61 20 73 69 6e 67 6c 65 20 72 6f 77 20  an a single row 
bab0: 75 73 69 6e 67 20 61 6e 0a 20 20 49 4e 53 45 52  using an.  INSER
bac0: 54 20 49 4e 54 4f 20 2e 2e 2e 20 56 41 4c 55 45  T INTO ... VALUE
bad0: 53 20 2e 2e 2e 20 73 74 61 74 65 6d 65 6e 74 2e  S ... statement.
bae0: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49  .}..COMPILE_OPTI
baf0: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  ON {SQLITE_OMIT_
bb00: 43 54 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70  CTE} {.  This op
bb10: 74 69 6f 6e 20 63 61 75 73 65 73 20 73 75 70 70  tion causes supp
bb20: 6f 72 74 20 66 6f 72 20 5b 63 6f 6d 6d 6f 6e 20  ort for [common 
bb30: 74 61 62 6c 65 20 65 78 70 72 65 73 73 69 6f 6e  table expression
bb40: 73 5d 20 74 6f 20 62 65 20 6f 6d 69 74 74 65 64  s] to be omitted
bb50: 2e 0a 7d 0a 0a 0a 0a 43 4f 4d 50 49 4c 45 5f 4f  ..}....COMPILE_O
bb60: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d  PTION {SQLITE_OM
bb70: 49 54 5f 44 41 54 45 54 49 4d 45 5f 46 55 4e 43  IT_DATETIME_FUNC
bb80: 53 7d 20 7b 0a 20 20 49 66 20 74 68 69 73 20 6f  S} {.  If this o
bb90: 70 74 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64  ption is defined
bba0: 2c 20 53 51 4c 69 74 65 27 73 20 62 75 69 6c 74  , SQLite's built
bbb0: 2d 69 6e 20 64 61 74 65 20 61 6e 64 20 74 69 6d  -in date and tim
bbc0: 65 20 6d 61 6e 69 70 75 6c 61 74 69 6f 6e 0a 20  e manipulation. 
bbd0: 20 66 75 6e 63 74 69 6f 6e 73 20 61 72 65 20 6f   functions are o
bbe0: 6d 69 74 74 65 64 2e 20 53 70 65 63 69 66 69 63  mitted. Specific
bbf0: 61 6c 6c 79 2c 20 74 68 65 20 53 51 4c 20 66 75  ally, the SQL fu
bc00: 6e 63 74 69 6f 6e 73 20 6a 75 6c 69 61 6e 64 61  nctions julianda
bc10: 79 28 29 2c 20 64 61 74 65 28 29 2c 0a 20 20 74  y(), date(),.  t
bc20: 69 6d 65 28 29 2c 20 64 61 74 65 74 69 6d 65 28  ime(), datetime(
bc30: 29 20 61 6e 64 20 73 74 72 66 74 69 6d 65 28 29  ) and strftime()
bc40: 20 61 72 65 20 6e 6f 74 20 61 76 61 69 6c 61 62   are not availab
bc50: 6c 65 2e 20 54 68 65 20 64 65 66 61 75 6c 74 20  le. The default 
bc60: 63 6f 6c 75 6d 6e 0a 20 20 76 61 6c 75 65 73 20  column.  values 
bc70: 43 55 52 52 45 4e 54 5f 54 49 4d 45 2c 20 43 55  CURRENT_TIME, CU
bc80: 52 52 45 4e 54 5f 44 41 54 45 20 61 6e 64 20 43  RRENT_DATE and C
bc90: 55 52 52 45 4e 54 5f 54 49 4d 45 53 54 41 4d 50  URRENT_TIMESTAMP
bca0: 20 61 72 65 20 73 74 69 6c 6c 20 61 76 61 69 6c   are still avail
bcb0: 61 62 6c 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45  able..}..COMPILE
bcc0: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f  _OPTION {SQLITE_
bcd0: 4f 4d 49 54 5f 44 45 43 4c 54 59 50 45 7d 20 7b  OMIT_DECLTYPE} {
bce0: 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63  .  This option c
bcf0: 61 75 73 65 73 20 53 51 4c 69 74 65 20 74 6f 20  auses SQLite to 
bd00: 6f 6d 69 74 20 73 75 70 70 6f 72 74 20 66 6f 72  omit support for
bd10: 20 74 68 65 0a 20 20 5b 73 71 6c 69 74 65 33 5f   the.  [sqlite3_
bd20: 63 6f 6c 75 6d 6e 5f 64 65 63 6c 74 79 70 65 28  column_decltype(
bd30: 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f  )] and [sqlite3_
bd40: 63 6f 6c 75 6d 6e 5f 64 65 63 6c 74 79 70 65 31  column_decltype1
bd50: 36 28 29 5d 0a 20 20 69 6e 74 65 72 66 61 63 65  6()].  interface
bd60: 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50  s..}..COMPILE_OP
bd70: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49  TION {SQLITE_OMI
bd80: 54 5f 44 45 50 52 45 43 41 54 45 44 7d 20 7b 0a  T_DEPRECATED} {.
bd90: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 61    This option ca
bda0: 75 73 65 73 20 53 51 4c 69 74 65 20 74 6f 20 6f  uses SQLite to o
bdb0: 6d 69 74 20 73 75 70 70 6f 72 74 20 66 6f 72 20  mit support for 
bdc0: 69 6e 74 65 72 66 61 63 65 73 0a 20 20 6d 61 72  interfaces.  mar
bdd0: 6b 65 64 20 61 73 20 64 65 70 72 65 63 61 74 65  ked as deprecate
bde0: 64 2e 20 20 54 68 69 73 20 69 6e 63 6c 75 64 65  d.  This include
bdf0: 73 20 0a 20 20 5b 73 71 6c 69 74 65 33 5f 61 67  s .  [sqlite3_ag
be00: 67 72 65 67 61 74 65 5f 63 6f 75 6e 74 28 29 5d  gregate_count()]
be10: 2c 0a 20 20 5b 73 71 6c 69 74 65 33 5f 65 78 70  ,.  [sqlite3_exp
be20: 69 72 65 64 28 29 5d 2c 0a 20 20 5b 73 71 6c 69  ired()],.  [sqli
be30: 74 65 33 5f 74 72 61 6e 73 66 65 72 5f 62 69 6e  te3_transfer_bin
be40: 64 69 6e 67 73 28 29 5d 2c 0a 20 20 5b 73 71 6c  dings()],.  [sql
be50: 69 74 65 33 5f 67 6c 6f 62 61 6c 5f 72 65 63 6f  ite3_global_reco
be60: 76 65 72 28 29 5d 2c 0a 20 20 5b 73 71 6c 69 74  ver()],.  [sqlit
be70: 65 33 5f 74 68 72 65 61 64 5f 63 6c 65 61 6e 75  e3_thread_cleanu
be80: 70 28 29 5d 20 61 6e 64 0a 20 20 5b 73 71 6c 69  p()] and.  [sqli
be90: 74 65 33 5f 6d 65 6d 6f 72 79 5f 61 6c 61 72 6d  te3_memory_alarm
bea0: 28 29 5d 20 69 6e 74 65 72 66 61 63 65 73 2e 0a  ()] interfaces..
beb0: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f  }..COMPILE_OPTIO
bec0: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 44  N {SQLITE_OMIT_D
bed0: 49 53 4b 49 4f 7d 20 7b 0a 20 20 54 68 69 73 20  ISKIO} {.  This 
bee0: 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 61 6c 6c  option omits all
bef0: 20 73 75 70 70 6f 72 74 20 66 6f 72 20 77 72 69   support for wri
bf00: 74 69 6e 67 20 74 6f 20 74 68 65 20 64 69 73 6b  ting to the disk
bf10: 20 61 6e 64 20 66 6f 72 63 65 73 0a 20 20 64 61   and forces.  da
bf20: 74 61 62 61 73 65 73 20 74 6f 20 65 78 69 73 74  tabases to exist
bf30: 20 69 6e 20 6d 65 6d 6f 72 79 20 6f 6e 6c 79 2e   in memory only.
bf40: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 68 61    This option ha
bf50: 73 20 6e 6f 74 20 62 65 65 6e 20 0a 20 20 6d 61  s not been .  ma
bf60: 69 6e 74 61 69 6e 65 64 20 61 6e 64 20 70 72 6f  intained and pro
bf70: 62 61 62 6c 79 20 64 6f 65 73 20 6e 6f 74 20 77  bably does not w
bf80: 6f 72 6b 20 77 69 74 68 20 6e 65 77 65 72 20 76  ork with newer v
bf90: 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74  ersions of SQLit
bfa0: 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50  e..}..COMPILE_OP
bfb0: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49  TION {SQLITE_OMI
bfc0: 54 5f 45 58 50 4c 41 49 4e 7d 20 7b 0a 20 20 44  T_EXPLAIN} {.  D
bfd0: 65 66 69 6e 69 6e 67 20 74 68 69 73 20 6f 70 74  efining this opt
bfe0: 69 6f 6e 20 63 61 75 73 65 73 20 74 68 65 20 5b  ion causes the [
bff0: 45 58 50 4c 41 49 4e 5d 20 63 6f 6d 6d 61 6e 64  EXPLAIN] command
c000: 20 74 6f 20 62 65 20 6f 6d 69 74 74 65 64 20 66   to be omitted f
c010: 72 6f 6d 20 74 68 65 0a 20 20 6c 69 62 72 61 72  rom the.  librar
c020: 79 2e 20 41 74 74 65 6d 70 74 69 6e 67 20 74 6f  y. Attempting to
c030: 20 65 78 65 63 75 74 65 20 61 6e 20 5b 45 58 50   execute an [EXP
c040: 4c 41 49 4e 5d 20 73 74 61 74 65 6d 65 6e 74 20  LAIN] statement 
c050: 77 69 6c 6c 20 63 61 75 73 65 20 61 20 70 61 72  will cause a par
c060: 73 65 0a 20 20 65 72 72 6f 72 2e 0a 7d 0a 0a 43  se.  error..}..C
c070: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53  OMPILE_OPTION {S
c080: 51 4c 49 54 45 5f 4f 4d 49 54 5f 46 4c 41 47 5f  QLITE_OMIT_FLAG_
c090: 50 52 41 47 4d 41 53 7d 20 7b 0a 20 20 54 68 69  PRAGMAS} {.  Thi
c0a0: 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 73  s option omits s
c0b0: 75 70 70 6f 72 74 20 66 6f 72 20 61 20 73 75 62  upport for a sub
c0c0: 73 65 74 20 6f 66 20 5b 50 52 41 47 4d 41 5d 20  set of [PRAGMA] 
c0d0: 63 6f 6d 6d 61 6e 64 73 20 74 68 61 74 0a 20 20  commands that.  
c0e0: 71 75 65 72 79 20 61 6e 64 20 73 65 74 20 62 6f  query and set bo
c0f0: 6f 6c 65 61 6e 20 70 72 6f 70 65 72 74 69 65 73  olean properties
c100: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54  ..}..COMPILE_OPT
c110: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54  ION {SQLITE_OMIT
c120: 5f 46 4c 4f 41 54 49 4e 47 5f 50 4f 49 4e 54 7d  _FLOATING_POINT}
c130: 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e   {.  This option
c140: 20 69 73 20 75 73 65 64 20 74 6f 20 6f 6d 69 74   is used to omit
c150: 20 66 6c 6f 61 74 69 6e 67 2d 70 6f 69 6e 74 20   floating-point 
c160: 6e 75 6d 62 65 72 20 73 75 70 70 6f 72 74 20 66  number support f
c170: 72 6f 6d 20 74 68 65 20 53 51 4c 69 74 65 0a 20  rom the SQLite. 
c180: 20 6c 69 62 72 61 72 79 2e 20 57 68 65 6e 20 73   library. When s
c190: 70 65 63 69 66 69 65 64 2c 20 73 70 65 63 69 66  pecified, specif
c1a0: 79 69 6e 67 20 61 20 66 6c 6f 61 74 69 6e 67 20  ying a floating 
c1b0: 70 6f 69 6e 74 20 6e 75 6d 62 65 72 20 61 73 20  point number as 
c1c0: 61 20 6c 69 74 65 72 61 6c 20 0a 20 20 28 69 2e  a literal .  (i.
c1d0: 65 2e 20 22 31 2e 30 31 22 29 20 72 65 73 75 6c  e. "1.01") resul
c1e0: 74 73 20 69 6e 20 61 20 70 61 72 73 65 20 65 72  ts in a parse er
c1f0: 72 6f 72 2e 0a 0a 20 20 3c 70 3e 49 6e 20 74 68  ror...  <p>In th
c200: 65 20 66 75 74 75 72 65 2c 20 74 68 69 73 20 6f  e future, this o
c210: 70 74 69 6f 6e 20 6d 61 79 20 61 6c 73 6f 20 64  ption may also d
c220: 69 73 61 62 6c 65 20 6f 74 68 65 72 20 66 6c 6f  isable other flo
c230: 61 74 69 6e 67 20 70 6f 69 6e 74 20 0a 20 20 66  ating point .  f
c240: 75 6e 63 74 69 6f 6e 61 6c 69 74 79 2c 20 66 6f  unctionality, fo
c250: 72 20 65 78 61 6d 70 6c 65 20 74 68 65 20 5b 73  r example the [s
c260: 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 64 6f  qlite3_result_do
c270: 75 62 6c 65 28 29 5d 2c 20 0a 20 20 5b 73 71 6c  uble()], .  [sql
c280: 69 74 65 33 5f 62 69 6e 64 5f 64 6f 75 62 6c 65  ite3_bind_double
c290: 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 76 61  ()], [sqlite3_va
c2a0: 6c 75 65 5f 64 6f 75 62 6c 65 28 29 5d 20 61 6e  lue_double()] an
c2b0: 64 0a 20 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c  d.  [sqlite3_col
c2c0: 75 6d 6e 5f 64 6f 75 62 6c 65 28 29 5d 20 41 50  umn_double()] AP
c2d0: 49 20 66 75 6e 63 74 69 6f 6e 73 2e 0a 20 20 3c  I functions..  <
c2e0: 2f 70 3e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f  /p>.}..COMPILE_O
c2f0: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d  PTION {SQLITE_OM
c300: 49 54 5f 46 4f 52 45 49 47 4e 5f 4b 45 59 7d 20  IT_FOREIGN_KEY} 
c310: 7b 0a 20 20 49 66 20 74 68 69 73 20 6f 70 74 69  {.  If this opti
c320: 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 2c 20 74  on is defined, t
c330: 68 65 6e 20 5b 66 6f 72 65 69 67 6e 20 6b 65 79  hen [foreign key
c340: 20 63 6f 6e 73 74 72 61 69 6e 74 5d 20 73 79 6e   constraint] syn
c350: 74 61 78 20 69 73 0a 20 20 6e 6f 74 20 72 65 63  tax is.  not rec
c360: 6f 67 6e 69 7a 65 64 2e 0a 7d 0a 0a 43 4f 4d 50  ognized..}..COMP
c370: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49  ILE_OPTION {SQLI
c380: 54 45 5f 4f 4d 49 54 5f 47 45 54 5f 54 41 42 4c  TE_OMIT_GET_TABL
c390: 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69  E} {.  This opti
c3a0: 6f 6e 20 63 61 75 73 65 73 20 73 75 70 70 6f 72  on causes suppor
c3b0: 74 20 66 6f 72 20 5b 73 71 6c 69 74 65 33 5f 67  t for [sqlite3_g
c3c0: 65 74 5f 74 61 62 6c 65 28 29 5d 20 61 6e 64 0a  et_table()] and.
c3d0: 20 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 5f    [sqlite3_free_
c3e0: 74 61 62 6c 65 28 29 5d 20 74 6f 20 62 65 20 6f  table()] to be o
c3f0: 6d 69 74 74 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49  mitted..}..COMPI
c400: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54  LE_OPTION {SQLIT
c410: 45 5f 4f 4d 49 54 5f 49 4e 43 52 42 4c 4f 42 7d  E_OMIT_INCRBLOB}
c420: 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e   {.  This option
c430: 20 63 61 75 73 65 73 20 73 75 70 70 6f 72 74 20   causes support 
c440: 66 6f 72 20 5b 73 71 6c 69 74 65 33 5f 62 6c 6f  for [sqlite3_blo
c450: 62 20 7c 20 69 6e 63 72 65 6d 65 6e 74 61 6c 20  b | incremental 
c460: 42 4c 4f 42 20 49 2f 4f 5d 0a 20 20 74 6f 20 62  BLOB I/O].  to b
c470: 65 20 6f 6d 69 74 74 65 64 2e 0a 7d 0a 0a 43 4f  e omitted..}..CO
c480: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51  MPILE_OPTION {SQ
c490: 4c 49 54 45 5f 4f 4d 49 54 5f 49 4e 54 45 47 52  LITE_OMIT_INTEGR
c4a0: 49 54 59 5f 43 48 45 43 4b 7d 20 7b 0a 20 20 54  ITY_CHECK} {.  T
c4b0: 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73  his option omits
c4c0: 20 73 75 70 70 6f 72 74 20 66 6f 72 20 74 68 65   support for the
c4d0: 20 5b 69 6e 74 65 67 72 69 74 79 5f 63 68 65 63   [integrity_chec
c4e0: 6b 20 70 72 61 67 6d 61 5d 2e 0a 7d 0a 0a 43 4f  k pragma]..}..CO
c4f0: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51  MPILE_OPTION {SQ
c500: 4c 49 54 45 5f 4f 4d 49 54 5f 4c 49 4b 45 5f 4f  LITE_OMIT_LIKE_O
c510: 50 54 49 4d 49 5a 41 54 49 4f 4e 7d 20 7b 0a 20  PTIMIZATION} {. 
c520: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 64 69 73   This option dis
c530: 61 62 6c 65 73 20 74 68 65 20 61 62 69 6c 69 74  ables the abilit
c540: 79 20 6f 66 20 53 51 4c 69 74 65 20 74 6f 20 75  y of SQLite to u
c550: 73 65 20 69 6e 64 69 63 65 73 20 74 6f 20 68 65  se indices to he
c560: 6c 70 0a 20 20 72 65 73 6f 6c 76 65 20 5b 4c 49  lp.  resolve [LI
c570: 4b 45 5d 20 61 6e 64 20 5b 47 4c 4f 42 5d 20 6f  KE] and [GLOB] o
c580: 70 65 72 61 74 6f 72 73 20 69 6e 20 61 20 57 48  perators in a WH
c590: 45 52 45 20 63 6c 61 75 73 65 2e 0a 7d 0a 0a 43  ERE clause..}..C
c5a0: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53  OMPILE_OPTION {S
c5b0: 51 4c 49 54 45 5f 4f 4d 49 54 5f 4c 4f 41 44 5f  QLITE_OMIT_LOAD_
c5c0: 45 58 54 45 4e 53 49 4f 4e 7d 20 7b 0a 20 20 54  EXTENSION} {.  T
c5d0: 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73  his option omits
c5e0: 20 74 68 65 20 65 6e 74 69 72 65 20 65 78 74 65   the entire exte
c5f0: 6e 73 69 6f 6e 20 6c 6f 61 64 69 6e 67 20 6d 65  nsion loading me
c600: 63 68 61 6e 69 73 6d 20 66 72 6f 6d 0a 20 20 53  chanism from.  S
c610: 51 4c 69 74 65 2c 20 69 6e 63 6c 75 64 69 6e 67  QLite, including
c620: 20 5b 73 71 6c 69 74 65 33 5f 65 6e 61 62 6c 65   [sqlite3_enable
c630: 5f 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f 6e 28  _load_extension(
c640: 29 5d 20 61 6e 64 0a 20 20 5b 73 71 6c 69 74 65  )] and.  [sqlite
c650: 33 5f 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f 6e  3_load_extension
c660: 28 29 5d 20 69 6e 74 65 72 66 61 63 65 73 2e 0a  ()] interfaces..
c670: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f  }..COMPILE_OPTIO
c680: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 4c  N {SQLITE_OMIT_L
c690: 4f 43 41 4c 54 49 4d 45 7d 20 7b 0a 20 20 54 68  OCALTIME} {.  Th
c6a0: 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20  is option omits 
c6b0: 74 68 65 20 22 6c 6f 63 61 6c 74 69 6d 65 22 20  the "localtime" 
c6c0: 6d 6f 64 69 66 69 65 72 20 66 72 6f 6d 20 74 68  modifier from th
c6d0: 65 20 64 61 74 65 20 61 6e 64 20 74 69 6d 65 0a  e date and time.
c6e0: 20 20 66 75 6e 63 74 69 6f 6e 73 2e 20 20 54 68    functions.  Th
c6f0: 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 73 6f 6d  is option is som
c700: 65 74 69 6d 65 73 20 75 73 65 66 75 6c 20 77 68  etimes useful wh
c710: 65 6e 20 74 72 79 69 6e 67 20 74 6f 20 63 6f 6d  en trying to com
c720: 70 69 6c 65 0a 20 20 74 68 65 20 64 61 74 65 20  pile.  the date 
c730: 61 6e 64 20 74 69 6d 65 20 66 75 6e 63 74 69 6f  and time functio
c740: 6e 73 20 6f 6e 20 61 20 70 6c 61 74 66 6f 72 6d  ns on a platform
c750: 20 74 68 61 74 20 64 6f 65 73 20 6e 6f 74 20 73   that does not s
c760: 75 70 70 6f 72 74 20 74 68 65 0a 20 20 63 6f 6e  upport the.  con
c770: 63 65 70 74 20 6f 66 20 6c 6f 63 61 6c 20 74 69  cept of local ti
c780: 6d 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f  me..}..COMPILE_O
c790: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d  PTION {SQLITE_OM
c7a0: 49 54 5f 4c 4f 4f 4b 41 53 49 44 45 7d 20 7b 0a  IT_LOOKASIDE} {.
c7b0: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d    This option om
c7c0: 69 74 73 20 74 68 65 20 5b 6c 6f 6f 6b 61 73 69  its the [lookasi
c7d0: 64 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  de memory alloca
c7e0: 74 6f 72 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45  tor]..}..COMPILE
c7f0: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f  _OPTION {SQLITE_
c800: 4f 4d 49 54 5f 4d 45 4d 4f 52 59 44 42 7d 20 7b  OMIT_MEMORYDB} {
c810: 0a 20 20 57 68 65 6e 20 74 68 69 73 20 69 73 20  .  When this is 
c820: 64 65 66 69 6e 65 64 2c 20 74 68 65 20 6c 69 62  defined, the lib
c830: 72 61 72 79 20 64 6f 65 73 20 6e 6f 74 20 72 65  rary does not re
c840: 73 70 65 63 74 20 74 68 65 20 73 70 65 63 69 61  spect the specia
c850: 6c 20 64 61 74 61 62 61 73 65 0a 20 20 6e 61 6d  l database.  nam
c860: 65 20 22 3a 6d 65 6d 6f 72 79 3a 22 20 28 6e 6f  e ":memory:" (no
c870: 72 6d 61 6c 6c 79 20 75 73 65 64 20 74 6f 20 63  rmally used to c
c880: 72 65 61 74 65 20 61 6e 20 5b 69 6e 2d 6d 65 6d  reate an [in-mem
c890: 6f 72 79 20 64 61 74 61 62 61 73 65 5d 29 2e 20  ory database]). 
c8a0: 49 66 20 0a 20 20 22 3a 6d 65 6d 6f 72 79 3a 22  If .  ":memory:"
c8b0: 20 69 73 20 70 61 73 73 65 64 20 74 6f 20 5b 73   is passed to [s
c8c0: 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 5d 2c 20  qlite3_open()], 
c8d0: 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31 36 28  [sqlite3_open16(
c8e0: 29 5d 2c 20 6f 72 0a 20 20 5b 73 71 6c 69 74 65  )], or.  [sqlite
c8f0: 33 5f 6f 70 65 6e 5f 76 32 28 29 5d 2c 20 61 20  3_open_v2()], a 
c900: 66 69 6c 65 20 77 69 74 68 20 74 68 69 73 20 6e  file with this n
c910: 61 6d 65 20 77 69 6c 6c 20 62 65 20 0a 20 20 6f  ame will be .  o
c920: 70 65 6e 65 64 20 6f 72 20 63 72 65 61 74 65 64  pened or created
c930: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54  ..}..COMPILE_OPT
c940: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54  ION {SQLITE_OMIT
c950: 5f 4f 52 5f 4f 50 54 49 4d 49 5a 41 54 49 4f 4e  _OR_OPTIMIZATION
c960: 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f  } {.  This optio
c970: 6e 20 64 69 73 61 62 6c 65 73 20 74 68 65 20 61  n disables the a
c980: 62 69 6c 69 74 79 20 6f 66 20 53 51 4c 69 74 65  bility of SQLite
c990: 20 74 6f 20 75 73 65 20 61 6e 20 69 6e 64 65 78   to use an index
c9a0: 20 74 6f 67 65 74 68 65 72 0a 20 20 77 69 74 68   together.  with
c9b0: 20 74 65 72 6d 73 20 6f 66 20 61 20 57 48 45 52   terms of a WHER
c9c0: 45 20 63 6c 61 75 73 65 20 63 6f 6e 6e 65 63 74  E clause connect
c9d0: 65 64 20 62 79 20 74 68 65 20 4f 52 20 6f 70 65  ed by the OR ope
c9e0: 72 61 74 6f 72 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c  rator..}..COMPIL
c9f0: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45  E_OPTION {SQLITE
ca00: 5f 4f 4d 49 54 5f 50 41 47 45 52 5f 50 52 41 47  _OMIT_PAGER_PRAG
ca10: 4d 41 53 7d 20 7b 0a 20 20 44 65 66 69 6e 69 6e  MAS} {.  Definin
ca20: 67 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d  g this option om
ca30: 69 74 73 20 70 72 61 67 6d 61 73 20 72 65 6c 61  its pragmas rela
ca40: 74 65 64 20 74 6f 20 74 68 65 20 70 61 67 65 72  ted to the pager
ca50: 20 73 75 62 73 79 73 74 65 6d 20 66 72 6f 6d 20   subsystem from 
ca60: 0a 20 20 74 68 65 20 62 75 69 6c 64 2e 0a 7d 0a  .  the build..}.
ca70: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20  .COMPILE_OPTION 
ca80: 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 50 52 41  {SQLITE_OMIT_PRA
ca90: 47 4d 41 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70  GMA} {.  This op
caa0: 74 69 6f 6e 20 69 73 20 75 73 65 64 20 74 6f 20  tion is used to 
cab0: 6f 6d 69 74 20 74 68 65 20 5b 50 52 41 47 4d 41  omit the [PRAGMA
cac0: 5d 20 63 6f 6d 6d 61 6e 64 0a 20 20 66 72 6f 6d  ] command.  from
cad0: 20 74 68 65 20 6c 69 62 72 61 72 79 2e 20 4e 6f   the library. No
cae0: 74 65 20 74 68 61 74 20 69 74 20 69 73 20 75 73  te that it is us
caf0: 65 66 75 6c 20 74 6f 20 64 65 66 69 6e 65 20 74  eful to define t
cb00: 68 65 20 6d 61 63 72 6f 73 20 74 68 61 74 20 6f  he macros that o
cb10: 6d 69 74 0a 20 20 73 70 65 63 69 66 69 63 20 70  mit.  specific p
cb20: 72 61 67 6d 61 73 20 69 6e 20 61 64 64 69 74 69  ragmas in additi
cb30: 6f 6e 20 74 6f 20 74 68 69 73 2c 20 61 73 20 74  on to this, as t
cb40: 68 65 79 20 6d 61 79 20 61 6c 73 6f 20 72 65 6d  hey may also rem
cb50: 6f 76 65 20 73 75 70 70 6f 72 74 69 6e 67 20 63  ove supporting c
cb60: 6f 64 65 0a 20 20 69 6e 20 6f 74 68 65 72 20 73  ode.  in other s
cb70: 75 62 2d 73 79 73 74 65 6d 73 2e 20 54 68 69 73  ub-systems. This
cb80: 20 6d 61 63 72 6f 20 72 65 6d 6f 76 65 73 20 74   macro removes t
cb90: 68 65 20 5b 50 52 41 47 4d 41 5d 20 63 6f 6d 6d  he [PRAGMA] comm
cba0: 61 6e 64 20 6f 6e 6c 79 2e 0a 7d 0a 0a 43 4f 4d  and only..}..COM
cbb0: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c  PILE_OPTION {SQL
cbc0: 49 54 45 5f 4f 4d 49 54 5f 50 52 4f 47 52 45 53  ITE_OMIT_PROGRES
cbd0: 53 5f 43 41 4c 4c 42 41 43 4b 7d 20 7b 0a 20 20  S_CALLBACK} {.  
cbe0: 54 68 69 73 20 6f 70 74 69 6f 6e 20 6d 61 79 20  This option may 
cbf0: 62 65 20 64 65 66 69 6e 65 64 20 74 6f 20 6f 6d  be defined to om
cc00: 69 74 20 74 68 65 20 63 61 70 61 62 69 6c 69 74  it the capabilit
cc10: 79 20 74 6f 20 69 73 73 75 65 20 22 70 72 6f 67  y to issue "prog
cc20: 72 65 73 73 22 20 0a 20 20 63 61 6c 6c 62 61 63  ress" .  callbac
cc30: 6b 73 20 64 75 72 69 6e 67 20 6c 6f 6e 67 2d 72  ks during long-r
cc40: 75 6e 6e 69 6e 67 20 53 51 4c 20 73 74 61 74 65  unning SQL state
cc50: 6d 65 6e 74 73 2e 20 54 68 65 20 0a 20 20 5b 73  ments. The .  [s
cc60: 71 6c 69 74 65 33 5f 70 72 6f 67 72 65 73 73 5f  qlite3_progress_
cc70: 68 61 6e 64 6c 65 72 28 29 5d 0a 20 20 41 50 49  handler()].  API
cc80: 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 6e 6f 74   function is not
cc90: 20 70 72 65 73 65 6e 74 20 69 6e 20 74 68 65 20   present in the 
cca0: 6c 69 62 72 61 72 79 2e 0a 7d 0a 0a 43 4f 4d 50  library..}..COMP
ccb0: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49  ILE_OPTION {SQLI
ccc0: 54 45 5f 4f 4d 49 54 5f 51 55 49 43 4b 42 41 4c  TE_OMIT_QUICKBAL
ccd0: 41 4e 43 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f  ANCE} {.  This o
cce0: 70 74 69 6f 6e 20 6f 6d 69 74 73 20 61 6e 20 61  ption omits an a
ccf0: 6c 74 65 72 6e 61 74 69 76 65 2c 20 66 61 73 74  lternative, fast
cd00: 65 72 20 42 2d 54 72 65 65 20 62 61 6c 61 6e 63  er B-Tree balanc
cd10: 69 6e 67 20 72 6f 75 74 69 6e 65 2e 0a 20 20 55  ing routine..  U
cd20: 73 69 6e 67 20 74 68 69 73 20 6f 70 74 69 6f 6e  sing this option
cd30: 20 6d 61 6b 65 73 20 53 51 4c 69 74 65 20 73 6c   makes SQLite sl
cd40: 69 67 68 74 6c 79 20 73 6d 61 6c 6c 65 72 20 61  ightly smaller a
cd50: 74 20 74 68 65 20 65 78 70 65 6e 73 65 20 6f 66  t the expense of
cd60: 0a 20 20 6d 61 6b 69 6e 67 20 69 74 20 72 75 6e  .  making it run
cd70: 20 73 6c 69 67 68 74 6c 79 20 73 6c 6f 77 65 72   slightly slower
cd80: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54  ..}..COMPILE_OPT
cd90: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54  ION {SQLITE_OMIT
cda0: 5f 52 45 49 4e 44 45 58 7d 20 7b 0a 20 20 57 68  _REINDEX} {.  Wh
cdb0: 65 6e 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69  en this option i
cdc0: 73 20 64 65 66 69 6e 65 64 2c 20 74 68 65 20 5b  s defined, the [
cdd0: 52 45 49 4e 44 45 58 5d 0a 20 20 63 6f 6d 6d 61  REINDEX].  comma
cde0: 6e 64 20 69 73 20 6e 6f 74 20 69 6e 63 6c 75 64  nd is not includ
cdf0: 65 64 20 69 6e 20 74 68 65 20 6c 69 62 72 61 72  ed in the librar
ce00: 79 2e 0a 20 20 45 78 65 63 75 74 69 6e 67 20 61  y..  Executing a
ce10: 20 5b 52 45 49 4e 44 45 58 5d 20 73 74 61 74 65   [REINDEX] state
ce20: 6d 65 6e 74 20 63 61 75 73 65 73 20 0a 20 20 61  ment causes .  a
ce30: 20 70 61 72 73 65 20 65 72 72 6f 72 2e 0a 7d 0a   parse error..}.
ce40: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20  .COMPILE_OPTION 
ce50: 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 53 43 48  {SQLITE_OMIT_SCH
ce60: 45 4d 41 5f 50 52 41 47 4d 41 53 7d 20 7b 0a 20  EMA_PRAGMAS} {. 
ce70: 20 44 65 66 69 6e 69 6e 67 20 74 68 69 73 20 6f   Defining this o
ce80: 70 74 69 6f 6e 20 6f 6d 69 74 73 20 70 72 61 67  ption omits prag
ce90: 6d 61 73 20 66 6f 72 20 71 75 65 72 79 69 6e 67  mas for querying
cea0: 20 74 68 65 20 64 61 74 61 62 61 73 65 20 73 63   the database sc
ceb0: 68 65 6d 61 20 66 72 6f 6d 20 0a 20 20 74 68 65  hema from .  the
cec0: 20 62 75 69 6c 64 2e 0a 7d 0a 0a 43 4f 4d 50 49   build..}..COMPI
ced0: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54  LE_OPTION {SQLIT
cee0: 45 5f 4f 4d 49 54 5f 53 43 48 45 4d 41 5f 56 45  E_OMIT_SCHEMA_VE
cef0: 52 53 49 4f 4e 5f 50 52 41 47 4d 41 53 7d 20 7b  RSION_PRAGMAS} {
cf00: 0a 20 20 44 65 66 69 6e 69 6e 67 20 74 68 69 73  .  Defining this
cf10: 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 70 72   option omits pr
cf20: 61 67 6d 61 73 20 66 6f 72 20 71 75 65 72 79 69  agmas for queryi
cf30: 6e 67 20 61 6e 64 20 6d 6f 64 69 66 79 69 6e 67  ng and modifying
cf40: 20 74 68 65 20 0a 20 20 64 61 74 61 62 61 73 65   the .  database
cf50: 20 73 63 68 65 6d 61 20 76 65 72 73 69 6f 6e 20   schema version 
cf60: 61 6e 64 20 75 73 65 72 20 76 65 72 73 69 6f 6e  and user version
cf70: 20 66 72 6f 6d 20 74 68 65 20 62 75 69 6c 64 2e   from the build.
cf80: 20 53 70 65 63 69 66 69 63 61 6c 6c 79 2c 20 74   Specifically, t
cf90: 68 65 20 0a 20 20 5b 73 63 68 65 6d 61 5f 76 65  he .  [schema_ve
cfa0: 72 73 69 6f 6e 5d 20 61 6e 64 20 5b 75 73 65 72  rsion] and [user
cfb0: 5f 76 65 72 73 69 6f 6e 5d 20 50 52 41 47 4d 41  _version] PRAGMA
cfc0: 73 20 61 72 65 20 6f 6d 69 74 74 65 64 2e 0a 7d  s are omitted..}
cfd0: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e  ..COMPILE_OPTION
cfe0: 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 53 48   {SQLITE_OMIT_SH
cff0: 41 52 45 44 5f 43 41 43 48 45 7d 20 7b 0a 20 20  ARED_CACHE} {.  
d000: 54 68 69 73 20 6f 70 74 69 6f 6e 20 62 75 69 6c  This option buil
d010: 64 73 20 53 51 4c 69 74 65 20 77 69 74 68 6f 75  ds SQLite withou
d020: 74 20 73 75 70 70 6f 72 74 20 66 6f 72 20 73 68  t support for sh
d030: 61 72 65 64 2d 63 61 63 68 65 20 6d 6f 64 65 2e  ared-cache mode.
d040: 0a 20 20 54 68 65 20 5b 73 71 6c 69 74 65 33 5f  .  The [sqlite3_
d050: 65 6e 61 62 6c 65 5f 73 68 61 72 65 64 5f 63 61  enable_shared_ca
d060: 63 68 65 28 29 5d 20 69 73 20 6f 6d 69 74 74 65  che()] is omitte
d070: 64 20 61 6c 6f 6e 67 20 77 69 74 68 20 61 20 66  d along with a f
d080: 61 69 72 0a 20 20 61 6d 6f 75 6e 74 20 6f 66 20  air.  amount of 
d090: 6c 6f 67 69 63 20 77 69 74 68 69 6e 20 74 68 65  logic within the
d0a0: 20 42 2d 54 72 65 65 20 73 75 62 73 79 73 74 65   B-Tree subsyste
d0b0: 6d 20 61 73 73 6f 63 69 61 74 65 64 20 77 69 74  m associated wit
d0c0: 68 20 73 68 61 72 65 64 0a 20 20 63 61 63 68 65  h shared.  cache
d0d0: 20 6d 61 6e 61 67 65 6d 65 6e 74 2e 0a 7d 0a 0a   management..}..
d0e0: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b  COMPILE_OPTION {
d0f0: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 53 55 42 51  SQLITE_OMIT_SUBQ
d100: 55 45 52 59 7d 20 7b 0a 20 20 49 66 20 64 65 66  UERY} {.  If def
d110: 69 6e 65 64 2c 20 73 75 70 70 6f 72 74 20 66 6f  ined, support fo
d120: 72 20 73 75 62 2d 73 65 6c 65 63 74 73 20 61 6e  r sub-selects an
d130: 64 20 74 68 65 20 49 4e 28 29 20 6f 70 65 72 61  d the IN() opera
d140: 74 6f 72 20 61 72 65 20 6f 6d 69 74 74 65 64 2e  tor are omitted.
d150: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49  .}..COMPILE_OPTI
d160: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  ON {SQLITE_OMIT_
d170: 54 43 4c 5f 56 41 52 49 41 42 4c 45 7d 20 7b 0a  TCL_VARIABLE} {.
d180: 20 20 49 66 20 74 68 69 73 20 6d 61 63 72 6f 20    If this macro 
d190: 69 73 20 64 65 66 69 6e 65 64 2c 20 74 68 65 6e  is defined, then
d1a0: 20 74 68 65 20 73 70 65 63 69 61 6c 20 22 24 3c   the special "$<
d1b0: 76 61 72 69 61 62 6c 65 2d 6e 61 6d 65 3e 22 20  variable-name>" 
d1c0: 73 79 6e 74 61 78 0a 20 20 75 73 65 64 20 74 6f  syntax.  used to
d1d0: 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 62   automatically b
d1e0: 69 6e 64 20 53 51 4c 20 76 61 72 69 61 62 6c 65  ind SQL variable
d1f0: 73 20 74 6f 20 54 43 4c 20 76 61 72 69 61 62 6c  s to TCL variabl
d200: 65 73 20 69 73 20 6f 6d 69 74 74 65 64 2e 0a 7d  es is omitted..}
d210: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e  ..COMPILE_OPTION
d220: 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 54 45   {SQLITE_OMIT_TE
d230: 4d 50 44 42 7d 20 7b 0a 20 20 54 68 69 73 20 6f  MPDB} {.  This o
d240: 70 74 69 6f 6e 20 6f 6d 69 74 73 20 73 75 70 70  ption omits supp
d250: 6f 72 74 20 66 6f 72 20 54 45 4d 50 20 6f 72 20  ort for TEMP or 
d260: 54 45 4d 50 4f 52 41 52 59 20 74 61 62 6c 65 73  TEMPORARY tables
d270: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54  ..}..COMPILE_OPT
d280: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54  ION {SQLITE_OMIT
d290: 5f 54 52 41 43 45 7d 20 7b 0a 20 20 54 68 69 73  _TRACE} {.  This
d2a0: 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 73 75   option omits su
d2b0: 70 70 6f 72 74 20 66 6f 72 20 74 68 65 20 5b 73  pport for the [s
d2c0: 71 6c 69 74 65 33 5f 70 72 6f 66 69 6c 65 28 29  qlite3_profile()
d2d0: 5d 20 61 6e 64 0a 20 20 5b 73 71 6c 69 74 65 33  ] and.  [sqlite3
d2e0: 5f 74 72 61 63 65 28 29 5d 20 69 6e 74 65 72 66  _trace()] interf
d2f0: 61 63 65 73 20 61 6e 64 20 74 68 65 69 72 20 61  aces and their a
d300: 73 73 6f 63 69 61 74 65 64 20 6c 6f 67 69 63 2e  ssociated logic.
d310: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49  .}..COMPILE_OPTI
d320: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  ON {SQLITE_OMIT_
d330: 54 52 49 47 47 45 52 7d 20 7b 0a 20 20 44 65 66  TRIGGER} {.  Def
d340: 69 6e 69 6e 67 20 74 68 69 73 20 6f 70 74 69 6f  ining this optio
d350: 6e 20 6f 6d 69 74 73 20 73 75 70 70 6f 72 74 20  n omits support 
d360: 66 6f 72 20 54 52 49 47 47 45 52 20 6f 62 6a 65  for TRIGGER obje
d370: 63 74 73 2e 20 4e 65 69 74 68 65 72 20 74 68 65  cts. Neither the
d380: 20 0a 20 20 5b 43 52 45 41 54 45 20 54 52 49 47   .  [CREATE TRIG
d390: 47 45 52 5d 20 6f 72 20 5b 44 52 4f 50 20 54 52  GER] or [DROP TR
d3a0: 49 47 47 45 52 5d 0a 20 20 63 6f 6d 6d 61 6e 64  IGGER].  command
d3b0: 73 20 61 72 65 20 61 76 61 69 6c 61 62 6c 65 20  s are available 
d3c0: 69 6e 20 74 68 69 73 20 63 61 73 65 2c 20 61 6e  in this case, an
d3d0: 64 20 61 74 74 65 6d 70 74 69 6e 67 20 74 6f 20  d attempting to 
d3e0: 65 78 65 63 75 74 65 0a 20 20 65 69 74 68 65 72  execute.  either
d3f0: 20 77 69 6c 6c 20 72 65 73 75 6c 74 20 69 6e 20   will result in 
d400: 61 20 70 61 72 73 65 20 65 72 72 6f 72 2e 0a 20  a parse error.. 
d410: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 61 6c 73   This option als
d420: 6f 20 64 69 73 61 62 6c 65 73 20 65 6e 66 6f 72  o disables enfor
d430: 63 65 6d 65 6e 74 20 6f 66 20 5b 66 6f 72 65 69  cement of [forei
d440: 67 6e 20 6b 65 79 20 63 6f 6e 73 74 72 61 69 6e  gn key constrain
d450: 74 73 5d 2c 0a 20 20 73 69 6e 63 65 20 74 68 65  ts],.  since the
d460: 20 63 6f 64 65 20 74 68 61 74 20 69 6d 70 6c 65   code that imple
d470: 6d 65 6e 74 73 20 74 72 69 67 67 65 72 73 20 61  ments triggers a
d480: 6e 64 20 77 68 69 63 68 20 69 73 20 6f 6d 69 74  nd which is omit
d490: 74 65 64 20 62 79 20 74 68 69 73 0a 20 20 6f 70  ted by this.  op
d4a0: 74 69 6f 6e 20 69 73 20 61 6c 73 6f 20 75 73 65  tion is also use
d4b0: 64 20 74 6f 20 69 6d 70 6c 65 6d 65 6e 74 20 5b  d to implement [
d4c0: 66 6f 72 65 69 67 6e 20 6b 65 79 20 61 63 74 69  foreign key acti
d4d0: 6f 6e 73 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45  ons]..}..COMPILE
d4e0: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f  _OPTION {SQLITE_
d4f0: 4f 4d 49 54 5f 54 52 55 4e 43 41 54 45 5f 4f 50  OMIT_TRUNCATE_OP
d500: 54 49 4d 49 5a 41 54 49 4f 4e 7d 20 7b 0a 20 20  TIMIZATION} {.  
d510: 41 20 64 65 66 61 75 6c 74 20 62 75 69 6c 64 20  A default build 
d520: 6f 66 20 53 51 4c 69 74 65 2c 20 69 66 20 61 20  of SQLite, if a 
d530: 5b 44 45 4c 45 54 45 5d 20 73 74 61 74 65 6d 65  [DELETE] stateme
d540: 6e 74 20 68 61 73 20 6e 6f 20 57 48 45 52 45 20  nt has no WHERE 
d550: 63 6c 61 75 73 65 0a 20 20 61 6e 64 20 6f 70 65  clause.  and ope
d560: 72 61 74 65 73 20 6f 6e 20 61 20 74 61 62 6c 65  rates on a table
d570: 20 77 69 74 68 20 6e 6f 20 74 72 69 67 67 65 72   with no trigger
d580: 73 2c 20 61 6e 20 6f 70 74 69 6d 69 7a 61 74 69  s, an optimizati
d590: 6f 6e 20 6f 63 63 75 72 73 20 74 68 61 74 0a 20  on occurs that. 
d5a0: 20 63 61 75 73 65 73 20 74 68 65 20 44 45 4c 45   causes the DELE
d5b0: 54 45 20 74 6f 20 6f 63 63 75 72 20 62 79 20 64  TE to occur by d
d5c0: 72 6f 70 70 69 6e 67 20 61 6e 64 20 72 65 63 72  ropping and recr
d5d0: 65 61 74 69 6e 67 20 74 68 65 20 74 61 62 6c 65  eating the table
d5e0: 2e 20 20 0a 20 20 44 72 6f 70 70 69 6e 67 20 61  .  .  Dropping a
d5f0: 6e 64 20 72 65 63 72 65 61 74 69 6e 67 20 61 20  nd recreating a 
d600: 74 61 62 6c 65 20 69 73 20 75 73 75 61 6c 6c 79  table is usually
d610: 20 6d 75 63 68 20 66 61 73 74 65 72 20 74 68 61   much faster tha
d620: 6e 20 64 65 6c 65 74 69 6e 67 0a 20 20 74 68 65  n deleting.  the
d630: 20 74 61 62 6c 65 20 63 6f 6e 74 65 6e 74 20 72   table content r
d640: 6f 77 20 62 79 20 72 6f 77 2e 20 20 54 68 69 73  ow by row.  This
d650: 20 69 73 20 74 68 65 20 22 74 72 75 6e 63 61 74   is the "truncat
d660: 65 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e 22 2e  e optimization".
d670: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49  .}..COMPILE_OPTI
d680: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  ON {SQLITE_OMIT_
d690: 55 54 46 31 36 7d 20 7b 0a 20 20 54 68 69 73 20  UTF16} {.  This 
d6a0: 6d 61 63 72 6f 20 69 73 20 75 73 65 64 20 74 6f  macro is used to
d6b0: 20 6f 6d 69 74 20 73 75 70 70 6f 72 74 20 66 6f   omit support fo
d6c0: 72 20 55 54 46 31 36 20 74 65 78 74 20 65 6e 63  r UTF16 text enc
d6d0: 6f 64 69 6e 67 2e 20 57 68 65 6e 20 74 68 69 73  oding. When this
d6e0: 20 69 73 0a 20 20 64 65 66 69 6e 65 64 20 61 6c   is.  defined al
d6f0: 6c 20 41 50 49 20 66 75 6e 63 74 69 6f 6e 73 20  l API functions 
d700: 74 68 61 74 20 72 65 74 75 72 6e 20 6f 72 20 61  that return or a
d710: 63 63 65 70 74 20 55 54 46 31 36 20 65 6e 63 6f  ccept UTF16 enco
d720: 64 65 64 20 74 65 78 74 20 61 72 65 0a 20 20 75  ded text are.  u
d730: 6e 61 76 61 69 6c 61 62 6c 65 2e 20 54 68 65 73  navailable. Thes
d740: 65 20 66 75 6e 63 74 69 6f 6e 73 20 63 61 6e 20  e functions can 
d750: 62 65 20 69 64 65 6e 74 69 66 69 65 64 20 62 79  be identified by
d760: 20 74 68 65 20 66 61 63 74 20 74 68 61 74 20 74   the fact that t
d770: 68 65 79 20 65 6e 64 0a 20 20 77 69 74 68 20 27  hey end.  with '
d780: 31 36 27 2c 20 66 6f 72 20 65 78 61 6d 70 6c 65  16', for example
d790: 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72   [sqlite3_prepar
d7a0: 65 31 36 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33  e16()], [sqlite3
d7b0: 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 31 36 28 29  _column_text16()
d7c0: 5d 20 61 6e 64 0a 20 20 5b 73 71 6c 69 74 65 33  ] and.  [sqlite3
d7d0: 5f 62 69 6e 64 5f 74 65 78 74 31 36 28 29 5d 2e  _bind_text16()].
d7e0: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49  .}..COMPILE_OPTI
d7f0: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  ON {SQLITE_OMIT_
d800: 56 41 43 55 55 4d 7d 20 7b 0a 20 20 57 68 65 6e  VACUUM} {.  When
d810: 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20   this option is 
d820: 64 65 66 69 6e 65 64 2c 20 74 68 65 20 5b 56 41  defined, the [VA
d830: 43 55 55 4d 5d 0a 20 20 63 6f 6d 6d 61 6e 64 20  CUUM].  command 
d840: 69 73 20 6e 6f 74 20 69 6e 63 6c 75 64 65 64 20  is not included 
d850: 69 6e 20 74 68 65 20 6c 69 62 72 61 72 79 2e 0a  in the library..
d860: 20 20 45 78 65 63 75 74 69 6e 67 20 61 20 5b 56    Executing a [V
d870: 41 43 55 55 4d 5d 20 73 74 61 74 65 6d 65 6e 74  ACUUM] statement
d880: 20 63 61 75 73 65 73 20 0a 20 20 61 20 70 61 72   causes .  a par
d890: 73 65 20 65 72 72 6f 72 2e 0a 7d 0a 0a 43 4f 4d  se error..}..COM
d8a0: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c  PILE_OPTION {SQL
d8b0: 49 54 45 5f 4f 4d 49 54 5f 56 49 45 57 7d 20 7b  ITE_OMIT_VIEW} {
d8c0: 0a 20 20 44 65 66 69 6e 69 6e 67 20 74 68 69 73  .  Defining this
d8d0: 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 73 75   option omits su
d8e0: 70 70 6f 72 74 20 66 6f 72 20 56 49 45 57 20 6f  pport for VIEW o
d8f0: 62 6a 65 63 74 73 2e 20 4e 65 69 74 68 65 72 20  bjects. Neither 
d900: 74 68 65 20 0a 20 20 5b 43 52 45 41 54 45 20 56  the .  [CREATE V
d910: 49 45 57 5d 20 6e 6f 72 20 74 68 65 20 5b 44 52  IEW] nor the [DR
d920: 4f 50 20 56 49 45 57 5d 0a 20 20 63 6f 6d 6d 61  OP VIEW].  comma
d930: 6e 64 73 20 61 72 65 20 61 76 61 69 6c 61 62 6c  nds are availabl
d940: 65 20 69 6e 20 74 68 69 73 20 63 61 73 65 2c 20  e in this case, 
d950: 61 6e 64 0a 20 20 61 74 74 65 6d 70 74 69 6e 67  and.  attempting
d960: 20 74 6f 20 65 78 65 63 75 74 65 20 65 69 74 68   to execute eith
d970: 65 72 20 77 69 6c 6c 20 72 65 73 75 6c 74 20 69  er will result i
d980: 6e 20 61 20 70 61 72 73 65 20 65 72 72 6f 72 2e  n a parse error.
d990: 0a 0a 20 20 57 41 52 4e 49 4e 47 3a 20 49 66 20  ..  WARNING: If 
d9a0: 74 68 69 73 20 6d 61 63 72 6f 20 69 73 20 64 65  this macro is de
d9b0: 66 69 6e 65 64 2c 20 69 74 20 77 69 6c 6c 20 6e  fined, it will n
d9c0: 6f 74 20 62 65 20 70 6f 73 73 69 62 6c 65 20 74  ot be possible t
d9d0: 6f 20 6f 70 65 6e 20 61 20 64 61 74 61 62 61 73  o open a databas
d9e0: 65 0a 20 20 66 6f 72 20 77 68 69 63 68 20 74 68  e.  for which th
d9f0: 65 20 73 63 68 65 6d 61 20 63 6f 6e 74 61 69 6e  e schema contain
da00: 73 20 56 49 45 57 20 6f 62 6a 65 63 74 73 2e 20  s VIEW objects. 
da10: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49  .}..COMPILE_OPTI
da20: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  ON {SQLITE_OMIT_
da30: 56 49 52 54 55 41 4c 54 41 42 4c 45 7d 20 7b 0a  VIRTUALTABLE} {.
da40: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d    This option om
da50: 69 74 73 20 73 75 70 70 6f 72 74 20 66 6f 72 20  its support for 
da60: 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 74 61  the [sqlite3_vta
da70: 62 20 7c 20 56 69 72 74 75 61 6c 20 54 61 62 6c  b | Virtual Tabl
da80: 65 5d 0a 20 20 6d 65 63 68 61 6e 69 73 6d 20 69  e].  mechanism i
da90: 6e 20 53 51 4c 69 74 65 2e 0a 7d 0a 0a 43 4f 4d  n SQLite..}..COM
daa0: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c  PILE_OPTION {SQL
dab0: 49 54 45 5f 4f 4d 49 54 5f 57 41 4c 7d 20 7b 0a  ITE_OMIT_WAL} {.
dac0: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d    This option om
dad0: 69 74 73 20 74 68 65 20 22 5b 77 72 69 74 65 2d  its the "[write-
dae0: 61 68 65 61 64 20 6c 6f 67 5d 22 20 28 61 2e 6b  ahead log]" (a.k
daf0: 2e 61 2e 20 22 5b 57 41 4c 5d 22 29 20 63 61 70  .a. "[WAL]") cap
db00: 61 62 69 6c 69 74 79 2e 0a 7d 0a 0a 43 4f 4d 50  ability..}..COMP
db10: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49  ILE_OPTION {SQLI
db20: 54 45 5f 4f 4d 49 54 5f 57 53 44 7d 20 7b 0a 20  TE_OMIT_WSD} {. 
db30: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 62 75 69   This option bui
db40: 6c 64 73 20 61 20 76 65 72 73 69 6f 6e 20 6f 66  lds a version of
db50: 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62 72   the SQLite libr
db60: 61 72 79 20 74 68 61 74 20 63 6f 6e 74 61 69 6e  ary that contain
db70: 73 20 6e 6f 0a 20 20 57 72 69 74 61 62 6c 65 20  s no.  Writable 
db80: 53 74 61 74 69 63 20 44 61 74 61 20 28 57 53 44  Static Data (WSD
db90: 29 2e 20 20 57 53 44 20 69 73 20 67 6c 6f 62 61  ).  WSD is globa
dba0: 6c 20 76 61 72 69 61 62 6c 65 73 20 61 6e 64 2f  l variables and/
dbb0: 6f 72 20 73 74 61 74 69 63 0a 20 20 76 61 72 69  or static.  vari
dbc0: 61 62 6c 65 73 2e 20 20 53 6f 6d 65 20 70 6c 61  ables.  Some pla
dbd0: 74 66 6f 72 6d 73 20 64 6f 20 6e 6f 74 20 73 75  tforms do not su
dbe0: 70 70 6f 72 74 20 57 53 44 2c 20 61 6e 64 20 74  pport WSD, and t
dbf0: 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 6e 65  his option is ne
dc00: 63 65 73 73 61 72 79 0a 20 20 69 6e 20 6f 72 64  cessary.  in ord
dc10: 65 72 20 66 6f 72 20 53 51 4c 69 74 65 20 74 6f  er for SQLite to
dc20: 20 77 6f 72 6b 20 74 68 6f 73 65 20 70 6c 61 74   work those plat
dc30: 66 6f 72 6d 73 2e 20 20 0a 0a 20 20 55 6e 6c 69  forms.  ..  Unli
dc40: 6b 65 20 6f 74 68 65 72 20 4f 4d 49 54 20 6f 70  ke other OMIT op
dc50: 74 69 6f 6e 73 20 77 68 69 63 68 20 6d 61 6b 65  tions which make
dc60: 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62 72   the SQLite libr
dc70: 61 72 79 20 73 6d 61 6c 6c 65 72 2c 0a 20 20 74  ary smaller,.  t
dc80: 68 69 73 20 6f 70 74 69 6f 6e 20 61 63 74 75 61  his option actua
dc90: 6c 6c 79 20 69 6e 63 72 65 61 73 65 73 20 74 68  lly increases th
dca0: 65 20 73 69 7a 65 20 6f 66 20 53 51 4c 69 74 65  e size of SQLite
dcb0: 20 61 6e 64 20 6d 61 6b 65 73 20 69 74 20 72 75   and makes it ru
dcc0: 6e 0a 20 20 61 20 6c 69 74 74 6c 65 20 73 6c 6f  n.  a little slo
dcd0: 77 65 72 2e 20 20 4f 6e 6c 79 20 75 73 65 20 74  wer.  Only use t
dce0: 68 69 73 20 6f 70 74 69 6f 6e 20 69 66 20 53 51  his option if SQ
dcf0: 4c 69 74 65 20 69 73 20 62 65 69 6e 67 20 62 75  Lite is being bu
dd00: 69 6c 74 20 66 6f 72 20 61 6e 0a 20 20 65 6d 62  ilt for an.  emb
dd10: 65 64 64 65 64 20 74 61 72 67 65 74 20 74 68 61  edded target tha
dd20: 74 20 64 6f 65 73 20 6e 6f 74 20 73 75 70 70 6f  t does not suppo
dd30: 72 74 20 57 53 44 2e 0a 7d 0a 0a 43 4f 4d 50 49  rt WSD..}..COMPI
dd40: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54  LE_OPTION {SQLIT
dd50: 45 5f 4f 4d 49 54 5f 58 46 45 52 5f 4f 50 54 7d  E_OMIT_XFER_OPT}
dd60: 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e   {.  This option
dd70: 20 6f 6d 69 74 73 20 73 75 70 70 6f 72 74 20 66   omits support f
dd80: 6f 72 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e 73  or optimizations
dd90: 20 74 68 61 74 20 68 65 6c 70 20 73 74 61 74 65   that help state
dda0: 6d 65 6e 74 73 0a 20 20 6f 66 20 74 68 65 20 66  ments.  of the f
ddb0: 6f 72 6d 20 22 49 4e 53 45 52 54 20 49 4e 54 4f  orm "INSERT INTO
ddc0: 20 2e 2e 2e 20 53 45 4c 45 43 54 20 2e 2e 2e 22   ... SELECT ..."
ddd0: 20 72 75 6e 20 66 61 73 74 65 72 2e 0a 7d 0a 0a   run faster..}..
dde0: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b  COMPILE_OPTION {
ddf0: 53 51 4c 49 54 45 5f 5a 45 52 4f 5f 4d 41 4c 4c  SQLITE_ZERO_MALL
de00: 4f 43 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74  OC} {.  This opt
de10: 69 6f 6e 20 6f 6d 69 74 73 20 62 6f 74 68 20 74  ion omits both t
de20: 68 65 20 5b 64 65 66 61 75 6c 74 20 6d 65 6d 6f  he [default memo
de30: 72 79 20 61 6c 6c 6f 63 61 74 6f 72 5d 20 61 6e  ry allocator] an
de40: 64 20 74 68 65 0a 20 20 5b 64 65 62 75 67 67 69  d the.  [debuggi
de50: 6e 67 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  ng memory alloca
de60: 74 6f 72 5d 20 66 72 6f 6d 20 74 68 65 20 62 75  tor] from the bu
de70: 69 6c 64 20 61 6e 64 20 73 75 62 73 74 69 74 75  ild and substitu
de80: 74 65 73 20 61 20 73 74 75 62 0a 20 20 6d 65 6d  tes a stub.  mem
de90: 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 20 74 68  ory allocator th
dea0: 61 74 20 61 6c 77 61 79 73 20 66 61 69 6c 73 2e  at always fails.
deb0: 20 20 53 51 4c 69 74 65 20 77 69 6c 6c 20 6e 6f    SQLite will no
dec0: 74 20 72 75 6e 20 77 69 74 68 20 74 68 69 73 0a  t run with this.
ded0: 20 20 73 74 75 62 20 6d 65 6d 6f 72 79 20 61 6c    stub memory al
dee0: 6c 6f 63 61 74 6f 72 20 73 69 6e 63 65 20 69 74  locator since it
def0: 20 77 69 6c 6c 20 62 65 20 75 6e 61 62 6c 65 20   will be unable 
df00: 74 6f 20 61 6c 6c 6f 63 61 74 65 20 6d 65 6d 6f  to allocate memo
df10: 72 79 2e 20 20 42 75 74 0a 20 20 74 68 69 73 20  ry.  But.  this 
df20: 73 74 75 62 20 63 61 6e 20 62 65 20 72 65 70 6c  stub can be repl
df30: 61 63 65 64 20 61 74 20 73 74 61 72 74 2d 74 69  aced at start-ti
df40: 6d 65 20 75 73 69 6e 67 0a 20 20 5b 73 71 6c 69  me using.  [sqli
df50: 74 65 33 5f 63 6f 6e 66 69 67 5d 28 5b 53 51 4c  te3_config]([SQL
df60: 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 41 4c 4c 4f  ITE_CONFIG_MALLO
df70: 43 5d 2c 2e 2e 2e 29 20 6f 72 0a 20 20 5b 73 71  C],...) or.  [sq
df80: 6c 69 74 65 33 5f 63 6f 6e 66 69 67 5d 28 5b 53  lite3_config]([S
df90: 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 48 45 41  QLITE_CONFIG_HEA
dfa0: 50 5d 2c 2e 2e 2e 29 2e 0a 20 20 53 6f 20 74 68  P],...)..  So th
dfb0: 65 20 6e 65 74 20 65 66 66 65 63 74 20 6f 66 20  e net effect of 
dfc0: 74 68 69 73 20 63 6f 6d 70 69 6c 65 2d 74 69 6d  this compile-tim
dfd0: 65 20 6f 70 74 69 6f 6e 20 69 73 20 74 68 61 74  e option is that
dfe0: 20 69 74 20 61 6c 6c 6f 77 73 20 53 51 4c 69 74   it allows SQLit
dff0: 65 0a 20 20 74 6f 20 62 65 20 63 6f 6d 70 69 6c  e.  to be compil
e000: 65 64 20 61 6e 64 20 6c 69 6e 6b 65 64 20 61 67  ed and linked ag
e010: 61 69 6e 73 74 20 61 20 73 79 73 74 65 6d 20 6c  ainst a system l
e020: 69 62 72 61 72 79 20 74 68 61 74 20 64 6f 65 73  ibrary that does
e030: 20 6e 6f 74 20 73 75 70 70 6f 72 74 0a 20 20 6d   not support.  m
e040: 61 6c 6c 6f 63 28 29 2c 20 66 72 65 65 28 29 2c  alloc(), free(),
e050: 20 61 6e 64 2f 6f 72 20 72 65 61 6c 6c 6f 63 28   and/or realloc(
e060: 29 2e 0a 7d 0a 0a 3c 2f 74 63 6c 3e 0a 3c 61 20  )..}..</tcl>.<a 
e070: 6e 61 6d 65 3d 22 64 65 62 75 67 6f 70 74 69 6f  name="debugoptio
e080: 6e 73 22 3e 3c 2f 61 3e 0a 3c 68 32 3e 31 2e 38  ns"></a>.<h2>1.8
e090: 20 41 6e 61 6c 79 73 69 73 20 61 6e 64 20 44 65   Analysis and De
e0a0: 62 75 67 67 69 6e 67 20 4f 70 74 69 6f 6e 73 3c  bugging Options<
e0b0: 2f 68 32 3e 0a 3c 74 63 6c 3e 0a 0a 43 4f 4d 50  /h2>.<tcl>..COMP
e0c0: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49  ILE_OPTION {SQLI
e0d0: 54 45 5f 44 45 42 55 47 7d 20 7b 0a 20 20 54 68  TE_DEBUG} {.  Th
e0e0: 65 20 53 51 4c 69 74 65 20 73 6f 75 72 63 65 20  e SQLite source 
e0f0: 63 6f 64 65 20 63 6f 6e 74 61 69 6e 73 20 6c 69  code contains li
e100: 74 65 72 61 6c 6c 79 20 74 68 6f 75 73 61 6e 64  terally thousand
e110: 73 20 6f 66 20 61 73 73 65 72 74 28 29 20 73 74  s of assert() st
e120: 61 74 65 6d 65 6e 74 73 0a 20 20 75 73 65 64 20  atements.  used 
e130: 74 6f 20 76 65 72 69 66 79 20 69 6e 74 65 72 6e  to verify intern
e140: 61 6c 20 61 73 73 75 6d 70 74 69 6f 6e 73 20 61  al assumptions a
e150: 6e 64 20 73 75 62 72 6f 75 74 69 6e 65 20 70 72  nd subroutine pr
e160: 65 63 6f 6e 64 69 74 69 6f 6e 73 20 61 6e 64 0a  econditions and.
e170: 20 20 70 6f 73 74 63 6f 6e 64 69 74 69 6f 6e 73    postconditions
e180: 2e 20 20 54 68 65 73 65 20 61 73 73 65 72 74 28  .  These assert(
e190: 29 20 73 74 61 74 65 6d 65 6e 74 73 20 61 72 65  ) statements are
e1a0: 20 6e 6f 72 6d 61 6c 6c 79 20 74 75 72 6e 65 64   normally turned
e1b0: 20 6f 66 66 0a 20 20 28 74 68 65 79 20 67 65 6e   off.  (they gen
e1c0: 65 72 61 74 65 20 6e 6f 20 63 6f 64 65 29 20 73  erate no code) s
e1d0: 69 6e 63 65 20 74 75 72 6e 69 6e 67 20 74 68 65  ince turning the
e1e0: 6d 20 6f 6e 20 6d 61 6b 65 73 20 53 51 4c 69 74  m on makes SQLit
e1f0: 65 20 72 75 6e 20 61 70 70 72 6f 78 69 6d 61 74  e run approximat
e200: 65 6c 79 0a 20 20 74 68 72 65 65 20 74 69 6d 65  ely.  three time
e210: 73 20 73 6c 6f 77 65 72 2e 20 20 42 75 74 20 66  s slower.  But f
e220: 6f 72 20 74 65 73 74 69 6e 67 20 61 6e 64 20 61  or testing and a
e230: 6e 61 6c 79 73 69 73 2c 20 69 74 20 69 73 20 75  nalysis, it is u
e240: 73 65 66 75 6c 20 74 6f 20 74 75 72 6e 0a 20 20  seful to turn.  
e250: 74 68 65 20 61 73 73 65 72 74 28 29 20 73 74 61  the assert() sta
e260: 74 65 6d 65 6e 74 73 20 6f 6e 2e 20 20 54 68 65  tements on.  The
e270: 20 53 51 4c 49 54 45 5f 44 45 42 55 47 20 63 6f   SQLITE_DEBUG co
e280: 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f  mpile-time optio
e290: 6e 20 64 6f 65 73 20 74 68 69 73 2e 0a 20 20 3c  n does this..  <
e2a0: 70 3e 53 51 4c 49 54 45 5f 44 45 42 55 47 20 61  p>SQLITE_DEBUG a
e2b0: 6c 73 6f 20 65 6e 61 62 6c 65 73 20 73 6f 6d 65  lso enables some
e2c0: 20 6f 74 68 65 72 20 64 65 62 75 67 67 69 6e 67   other debugging
e2d0: 20 66 65 61 74 75 72 65 73 2c 20 73 75 63 68 20   features, such 
e2e0: 61 73 0a 20 20 73 70 65 63 69 61 6c 20 5b 50 52  as.  special [PR
e2f0: 41 47 4d 41 5d 20 73 74 61 74 65 6d 65 6e 74 73  AGMA] statements
e300: 20 74 68 61 74 20 74 75 72 6e 20 6f 6e 20 74 72   that turn on tr
e310: 61 63 69 6e 67 20 61 6e 64 20 6c 69 73 74 69 6e  acing and listin
e320: 67 20 66 65 61 74 75 72 65 73 0a 20 20 75 73 65  g features.  use
e330: 64 20 66 6f 72 20 74 72 6f 75 62 6c 65 73 68 6f  d for troublesho
e340: 6f 74 69 6e 67 20 61 6e 64 20 61 6e 61 6c 79 73  oting and analys
e350: 69 73 20 6f 66 20 74 68 65 20 5b 56 44 42 45 5d  is of the [VDBE]
e360: 20 61 6e 64 20 63 6f 64 65 20 67 65 6e 65 72 61   and code genera
e370: 74 6f 72 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f  tor..}..COMPILE_
e380: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4d  OPTION {SQLITE_M
e390: 45 4d 44 45 42 55 47 7d 20 7b 0a 20 20 54 68 65  EMDEBUG} {.  The
e3a0: 20 53 51 4c 49 54 45 5f 4d 45 4d 44 45 42 55 47   SQLITE_MEMDEBUG
e3b0: 20 6f 70 74 69 6f 6e 20 63 61 75 73 65 73 20 61   option causes a
e3c0: 6e 20 69 6e 73 74 72 75 6d 65 6e 74 65 64 20 0a  n instrumented .
e3d0: 20 20 5b 64 65 62 75 67 67 69 6e 67 20 6d 65 6d    [debugging mem
e3e0: 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 5d 0a 20  ory allocator]. 
e3f0: 20 74 6f 20 62 65 20 75 73 65 64 20 61 73 20 74   to be used as t
e400: 68 65 20 64 65 66 61 75 6c 74 20 6d 65 6d 6f 72  he default memor
e410: 79 20 61 6c 6c 6f 63 61 74 6f 72 20 77 69 74 68  y allocator with
e420: 69 6e 20 53 51 4c 69 74 65 2e 20 20 54 68 65 0a  in SQLite.  The.
e430: 20 20 69 6e 73 74 72 75 6d 65 6e 74 65 64 20 6d    instrumented m
e440: 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 20  emory allocator 
e450: 63 68 65 63 6b 73 20 66 6f 72 20 6d 69 73 75 73  checks for misus
e460: 65 20 6f 66 20 64 79 6e 61 6d 69 63 61 6c 6c 79  e of dynamically
e470: 20 61 6c 6c 6f 63 61 74 65 64 0a 20 20 6d 65 6d   allocated.  mem
e480: 6f 72 79 2e 20 20 45 78 61 6d 70 6c 65 73 20 6f  ory.  Examples o
e490: 66 20 6d 69 73 75 73 65 20 69 6e 63 6c 75 64 65  f misuse include
e4a0: 20 75 73 69 6e 67 20 6d 65 6d 6f 72 79 20 61 66   using memory af
e4b0: 74 65 72 20 69 74 20 69 73 20 66 72 65 65 64 2c  ter it is freed,
e4c0: 0a 20 20 77 72 69 74 69 6e 67 20 6f 66 66 20 74  .  writing off t
e4d0: 68 65 20 65 6e 64 73 20 6f 66 20 61 20 6d 65 6d  he ends of a mem
e4e0: 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 2c 20  ory allocation, 
e4f0: 66 72 65 65 69 6e 67 20 6d 65 6d 6f 72 79 20 6e  freeing memory n
e500: 6f 74 20 70 72 65 76 69 6f 75 73 6c 79 0a 20 20  ot previously.  
e510: 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 74 68  obtained from th
e520: 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  e memory allocat
e530: 6f 72 2c 20 6f 72 20 66 61 69 6c 69 6e 67 20 74  or, or failing t
e540: 6f 20 69 6e 69 74 69 61 6c 69 7a 65 20 6e 65 77  o initialize new
e550: 6c 79 0a 20 20 61 6c 6c 6f 63 61 74 65 64 20 6d  ly.  allocated m
e560: 65 6d 6f 72 79 2e 0a 7d 0a 0a 3c 2f 74 63 6c 3e  emory..}..</tcl>
e570: 0a 3c 61 20 6e 61 6d 65 3d 22 77 69 6e 33 32 6f  .<a name="win32o
e580: 70 74 69 6f 6e 73 22 3e 3c 2f 61 3e 0a 3c 68 32  ptions"></a>.<h2
e590: 3e 31 2e 39 20 57 69 6e 64 6f 77 73 2d 53 70 65  >1.9 Windows-Spe
e5a0: 63 69 66 69 63 20 4f 70 74 69 6f 6e 73 3c 2f 68  cific Options</h
e5b0: 32 3e 0a 3c 74 63 6c 3e 0a 0a 43 4f 4d 50 49 4c  2>.<tcl>..COMPIL
e5c0: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45  E_OPTION {SQLITE
e5d0: 5f 57 49 4e 33 32 5f 48 45 41 50 5f 43 52 45 41  _WIN32_HEAP_CREA
e5e0: 54 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74  TE} {.  This opt
e5f0: 69 6f 6e 20 66 6f 72 63 65 73 20 74 68 65 20 57  ion forces the W
e600: 69 6e 33 32 20 6e 61 74 69 76 65 20 6d 65 6d 6f  in32 native memo
e610: 72 79 20 61 6c 6c 6f 63 61 74 6f 72 2c 20 77 68  ry allocator, wh
e620: 65 6e 20 65 6e 61 62 6c 65 64 2c 20 74 6f 0a 20  en enabled, to. 
e630: 20 63 72 65 61 74 65 20 61 20 70 72 69 76 61 74   create a privat
e640: 65 20 68 65 61 70 20 74 6f 20 68 6f 6c 64 20 61  e heap to hold a
e650: 6c 6c 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  ll memory alloca
e660: 74 69 6f 6e 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c  tions..}..COMPIL
e670: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45  E_OPTION {SQLITE
e680: 5f 57 49 4e 33 32 5f 4d 41 4c 4c 4f 43 5f 56 41  _WIN32_MALLOC_VA
e690: 4c 49 44 41 54 45 7d 20 7b 0a 20 20 54 68 69 73  LIDATE} {.  This
e6a0: 20 6f 70 74 69 6f 6e 20 66 6f 72 63 65 73 20 74   option forces t
e6b0: 68 65 20 57 69 6e 33 32 20 6e 61 74 69 76 65 20  he Win32 native 
e6c0: 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72  memory allocator
e6d0: 2c 20 77 68 65 6e 20 65 6e 61 62 6c 65 64 2c 20  , when enabled, 
e6e0: 74 6f 0a 20 20 6d 61 6b 65 20 73 74 72 61 74 65  to.  make strate
e6f0: 67 69 63 20 63 61 6c 6c 73 20 69 6e 74 6f 20 74  gic calls into t
e700: 68 65 20 48 65 61 70 56 61 6c 69 64 61 74 65 28  he HeapValidate(
e710: 29 20 66 75 6e 63 74 69 6f 6e 20 69 66 20 61 73  ) function if as
e720: 73 65 72 74 28 29 20 69 73 20 61 6c 73 6f 0a 20  sert() is also. 
e730: 20 65 6e 61 62 6c 65 64 2e 0a 7d 0a 0a 3c 2f 74   enabled..}..</t
e740: 63 6c 3e 0a                                      cl>.