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 ><0 or 1><
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 <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><pages>
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></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><0 or 1
1e00: 26 67 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 ></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><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></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><
24c0: 31 20 6f 72 20 30 26 67 74 3b 3c 2f 69 3e 7d 20 1 or 0></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><bytes><
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><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><0 or 1>
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><max_dep
3df0: 74 68 26 67 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 th></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 ><0 or 1><
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><0 or 1
4d70: 20 6f 72 20 32 26 67 74 3b 3c 2f 69 3e 7d 20 7b or 2></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><0 thro
54e0: 75 67 68 20 33 26 67 74 3b 3c 2f 69 3e 7d 20 7b ugh 3></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></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 <1 or 2></
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 49 43 55 7d 20 7b 0a 20 _ENABLE_ICU} {.
6cd0: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 75 This option cau
6ce0: 73 65 73 20 74 68 65 20 0a 20 20 5b 68 74 74 70 ses the . [http
6cf0: 3a 2f 2f 77 77 77 2e 69 63 75 2d 70 72 6f 6a 65 ://www.icu-proje
6d00: 63 74 2e 6f 72 67 2f 20 7c 20 49 6e 74 65 72 6e ct.org/ | Intern
6d10: 61 74 69 6f 6e 61 6c 20 43 6f 6d 70 6f 6e 65 6e ational Componen
6d20: 74 73 20 66 6f 72 20 55 6e 69 63 6f 64 65 5d 0a ts for Unicode].
6d30: 20 20 6f 72 20 22 49 43 55 22 20 65 78 74 65 6e or "ICU" exten
6d40: 73 69 6f 6e 20 74 6f 20 53 51 4c 69 74 65 20 74 sion to SQLite t
6d50: 6f 20 62 65 20 61 64 64 65 64 20 74 6f 20 74 68 o be added to th
6d60: 65 20 62 75 69 6c 64 2e 20 20 0a 7d 0a 0a 43 4f e build. .}..CO
6d70: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 MPILE_OPTION {SQ
6d80: 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 49 4f 54 52 LITE_ENABLE_IOTR
6d90: 41 43 45 7d 20 7b 0a 20 20 57 68 65 6e 20 62 6f ACE} {. When bo
6da0: 74 68 20 74 68 65 20 53 51 4c 69 74 65 20 63 6f th the SQLite co
6db0: 72 65 20 61 6e 64 20 74 68 65 20 5b 43 6f 6d 6d re and the [Comm
6dc0: 61 6e 64 20 4c 69 6e 65 20 49 6e 74 65 72 66 61 and Line Interfa
6dd0: 63 65 5d 20 28 43 4c 49 29 20 61 72 65 20 62 6f ce] (CLI) are bo
6de0: 74 68 20 0a 20 20 63 6f 6d 70 69 6c 65 64 20 77 th . compiled w
6df0: 69 74 68 20 74 68 69 73 20 6f 70 74 69 6f 6e 2c ith this option,
6e00: 20 74 68 65 6e 20 74 68 65 20 43 4c 49 20 70 72 then the CLI pr
6e10: 6f 76 69 64 65 73 20 61 6e 20 65 78 74 72 61 20 ovides an extra
6e20: 63 6f 6d 6d 61 6e 64 0a 20 20 6e 61 6d 65 64 20 command. named
6e30: 22 2e 69 6f 74 72 61 63 65 22 20 74 68 61 74 20 ".iotrace" that
6e40: 70 72 6f 76 69 64 65 73 20 61 20 6c 6f 77 2d 6c provides a low-l
6e50: 65 76 65 6c 20 6c 6f 67 20 6f 66 20 49 2f 4f 20 evel log of I/O
6e60: 61 63 74 69 76 69 74 79 2e 0a 20 20 54 68 69 73 activity.. This
6e70: 20 6f 70 74 69 6f 6e 20 69 73 20 65 78 70 65 72 option is exper
6e80: 69 6d 65 6e 74 61 6c 20 61 6e 64 20 6d 61 79 20 imental and may
6e90: 62 65 20 64 69 73 63 6f 6e 74 69 6e 75 65 64 20 be discontinued
6ea0: 69 6e 20 61 20 66 75 74 75 72 65 20 72 65 6c 65 in a future rele
6eb0: 61 73 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f ase..}..COMPILE_
6ec0: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 OPTION {SQLITE_E
6ed0: 4e 41 42 4c 45 5f 4c 4f 43 4b 49 4e 47 5f 53 54 NABLE_LOCKING_ST
6ee0: 59 4c 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 YLE} {. This op
6ef0: 74 69 6f 6e 20 65 6e 61 62 6c 65 73 20 61 64 64 tion enables add
6f00: 69 74 69 6f 6e 61 6c 20 6c 6f 67 69 63 20 69 6e itional logic in
6f10: 20 74 68 65 20 4f 53 20 69 6e 74 65 72 66 61 63 the OS interfac
6f20: 65 20 6c 61 79 65 72 20 66 6f 72 0a 20 20 4d 61 e layer for. Ma
6f30: 63 20 4f 53 20 58 2e 20 54 68 65 20 61 64 64 69 c OS X. The addi
6f40: 74 69 6f 6e 61 6c 20 6c 6f 67 69 63 20 61 74 74 tional logic att
6f50: 65 6d 70 74 73 20 74 6f 20 64 65 74 65 72 6d 69 empts to determi
6f60: 6e 65 20 74 68 65 20 74 79 70 65 20 6f 66 20 74 ne the type of t
6f70: 68 65 0a 20 20 75 6e 64 65 72 6c 79 69 6e 67 20 he. underlying
6f80: 66 69 6c 65 73 79 73 74 65 6d 20 61 6e 64 20 63 filesystem and c
6f90: 68 6f 6f 73 65 20 61 6e 64 20 61 6c 74 65 72 6e hoose and altern
6fa0: 61 74 69 76 65 20 6c 6f 63 6b 69 6e 67 20 73 74 ative locking st
6fb0: 72 61 74 65 67 79 0a 20 20 74 68 61 74 20 77 6f rategy. that wo
6fc0: 72 6b 73 20 63 6f 72 72 65 63 74 6c 79 20 66 6f rks correctly fo
6fd0: 72 20 74 68 61 74 20 66 69 6c 65 73 79 73 74 65 r that filesyste
6fe0: 6d 20 74 79 70 65 2e 20 46 69 76 65 20 6c 6f 63 m type. Five loc
6ff0: 6b 69 6e 67 20 73 74 72 61 74 65 67 69 65 73 20 king strategies
7000: 0a 20 20 61 72 65 20 61 76 61 69 6c 61 62 6c 65 . are available
7010: 3a 0a 0a 20 20 3c 75 6c 3e 0a 20 20 20 20 3c 6c :.. <ul>. <l
7020: 69 3e 20 50 4f 53 49 58 20 6c 6f 63 6b 69 6e 67 i> POSIX locking
7030: 20 73 74 79 6c 65 2e 20 54 68 69 73 20 69 73 20 style. This is
7040: 74 68 65 20 64 65 66 61 75 6c 74 20 6c 6f 63 6b the default lock
7050: 69 6e 67 20 73 74 79 6c 65 20 61 6e 64 20 74 68 ing style and th
7060: 65 0a 20 20 20 20 20 20 20 20 20 73 74 79 6c 65 e. style
7070: 20 75 73 65 64 20 62 79 20 6f 74 68 65 72 20 28 used by other (
7080: 6e 6f 6e 20 4d 61 63 20 4f 53 20 58 29 20 55 6e non Mac OS X) Un
7090: 69 78 65 73 2e 20 4c 6f 63 6b 73 20 61 72 65 20 ixes. Locks are
70a0: 6f 62 74 61 69 6e 65 64 20 61 6e 64 20 0a 20 20 obtained and .
70b0: 20 20 20 20 20 20 20 72 65 6c 65 61 73 65 64 20 released
70c0: 75 73 69 6e 67 20 74 68 65 20 66 63 6e 74 6c 28 using the fcntl(
70d0: 29 20 73 79 73 74 65 6d 20 63 61 6c 6c 2e 0a 0a ) system call...
70e0: 20 20 20 20 3c 6c 69 3e 20 41 46 50 20 6c 6f 63 <li> AFP loc
70f0: 6b 69 6e 67 20 73 74 79 6c 65 2e 20 54 68 69 73 king style. This
7100: 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c 65 20 69 locking style i
7110: 73 20 75 73 65 64 20 66 6f 72 20 6e 65 74 77 6f s used for netwo
7120: 72 6b 20 66 69 6c 65 20 0a 20 20 20 20 20 20 20 rk file .
7130: 20 20 73 79 73 74 65 6d 73 20 74 68 61 74 20 75 systems that u
7140: 73 65 20 74 68 65 20 41 46 50 20 28 41 70 70 6c se the AFP (Appl
7150: 65 20 46 69 6c 69 6e 67 20 50 72 6f 74 6f 63 6f e Filing Protoco
7160: 6c 29 20 70 72 6f 74 6f 63 6f 6c 2e 20 4c 6f 63 l) protocol. Loc
7170: 6b 73 0a 20 20 20 20 20 20 20 20 20 61 72 65 20 ks. are
7180: 6f 62 74 61 69 6e 65 64 20 62 79 20 63 61 6c 6c obtained by call
7190: 69 6e 67 20 74 68 65 20 6c 69 62 72 61 72 79 20 ing the library
71a0: 66 75 6e 63 74 69 6f 6e 20 5f 41 46 50 46 53 53 function _AFPFSS
71b0: 65 74 4c 6f 63 6b 28 29 2e 0a 0a 20 20 20 20 3c etLock()... <
71c0: 6c 69 3e 20 46 6c 6f 63 6b 20 6c 6f 63 6b 69 6e li> Flock lockin
71d0: 67 20 73 74 79 6c 65 2e 20 54 68 69 73 20 69 73 g style. This is
71e0: 20 75 73 65 64 20 66 6f 72 20 66 69 6c 65 2d 73 used for file-s
71f0: 79 73 74 65 6d 73 20 74 68 61 74 20 64 6f 20 6e ystems that do n
7200: 6f 74 0a 20 20 20 20 20 20 20 20 20 73 75 70 70 ot. supp
7210: 6f 72 74 20 50 4f 53 49 58 20 6c 6f 63 6b 69 6e ort POSIX lockin
7220: 67 20 73 74 79 6c 65 2e 20 4c 6f 63 6b 73 20 61 g style. Locks a
7230: 72 65 20 6f 62 74 61 69 6e 65 64 20 61 6e 64 20 re obtained and
7240: 72 65 6c 65 61 73 65 64 20 75 73 69 6e 67 0a 20 released using.
7250: 20 20 20 20 20 20 20 20 74 68 65 20 66 6c 6f 63 the floc
7260: 6b 28 29 20 73 79 73 74 65 6d 20 63 61 6c 6c 2e k() system call.
7270: 0a 0a 20 20 20 20 3c 6c 69 3e 20 44 6f 74 2d 66 .. <li> Dot-f
7280: 69 6c 65 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c ile locking styl
7290: 65 2e 20 54 68 69 73 20 6c 6f 63 6b 69 6e 67 20 e. This locking
72a0: 73 74 79 6c 65 20 69 73 20 75 73 65 64 20 77 68 style is used wh
72b0: 65 6e 20 6e 65 69 74 68 65 72 0a 20 20 20 20 20 en neither.
72c0: 20 20 20 20 66 6c 6f 63 6b 20 6e 6f 72 20 50 4f flock nor PO
72d0: 53 49 58 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c SIX locking styl
72e0: 65 73 20 61 72 65 20 73 75 70 70 6f 72 74 65 64 es are supported
72f0: 20 62 79 20 74 68 65 20 66 69 6c 65 20 73 79 73 by the file sys
7300: 74 65 6d 2e 0a 20 20 20 20 20 20 20 20 20 44 61 tem.. Da
7310: 74 61 62 61 73 65 20 6c 6f 63 6b 73 20 61 72 65 tabase locks are
7320: 20 6f 62 74 61 69 6e 65 64 20 62 79 20 63 72 65 obtained by cre
7330: 61 74 69 6e 67 20 61 6e 64 20 65 6e 74 72 79 20 ating and entry
7340: 69 6e 20 74 68 65 20 66 69 6c 65 2d 73 79 73 74 in the file-syst
7350: 65 6d 0a 20 20 20 20 20 20 20 20 20 61 74 20 61 em. at a
7360: 20 77 65 6c 6c 2d 6b 6e 6f 77 6e 20 6c 6f 63 61 well-known loca
7370: 74 69 6f 6e 20 72 65 6c 61 74 69 76 65 20 74 6f tion relative to
7380: 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69 the database fi
7390: 6c 65 20 28 61 20 22 64 6f 74 2d 66 69 6c 65 22 le (a "dot-file"
73a0: 29 0a 20 20 20 20 20 20 20 20 20 61 6e 64 20 72 ). and r
73b0: 65 6c 69 6e 71 75 69 73 68 65 64 20 62 79 20 64 elinquished by d
73c0: 65 6c 65 74 69 6e 67 20 74 68 65 20 73 61 6d 65 eleting the same
73d0: 20 66 69 6c 65 2e 0a 0a 20 20 20 20 3c 6c 69 3e file... <li>
73e0: 20 4e 6f 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c No locking styl
73f0: 65 2e 20 49 66 20 6e 6f 6e 65 20 6f 66 20 74 68 e. If none of th
7400: 65 20 61 62 6f 76 65 20 63 61 6e 20 62 65 20 73 e above can be s
7410: 75 70 70 6f 72 74 65 64 2c 20 74 68 69 73 20 0a upported, this .
7420: 20 20 20 20 20 20 20 20 20 6c 6f 63 6b 69 6e 67 locking
7430: 20 73 74 79 6c 65 20 69 73 20 75 73 65 64 2e 20 style is used.
7440: 4e 6f 20 64 61 74 61 62 61 73 65 20 6c 6f 63 6b No database lock
7450: 69 6e 67 20 6d 65 63 68 61 6e 69 73 6d 20 69 73 ing mechanism is
7460: 20 75 73 65 64 2e 20 57 68 65 6e 0a 20 20 20 20 used. When.
7470: 20 20 20 20 20 74 68 69 73 20 73 79 73 74 65 6d this system
7480: 20 69 73 20 75 73 65 64 20 69 74 20 69 73 20 6e is used it is n
7490: 6f 74 20 73 61 66 65 20 66 6f 72 20 61 20 73 69 ot safe for a si
74a0: 6e 67 6c 65 20 64 61 74 61 62 61 73 65 20 74 6f ngle database to
74b0: 20 62 65 0a 20 20 20 20 20 20 20 20 20 61 63 63 be. acc
74c0: 65 73 73 65 64 20 62 79 20 6d 75 6c 74 69 70 6c essed by multipl
74d0: 65 20 63 6c 69 65 6e 74 73 2e 0a 20 20 3c 2f 75 e clients.. </u
74e0: 6c 3e 0a 0a 20 20 41 64 64 69 74 69 6f 6e 61 6c l>.. Additional
74f0: 6c 79 2c 20 66 69 76 65 20 65 78 74 72 61 20 5b ly, five extra [
7500: 56 46 53 5d 20 69 6d 70 6c 65 6d 65 6e 74 61 74 VFS] implementat
7510: 69 6f 6e 73 20 61 72 65 20 70 72 6f 76 69 64 65 ions are provide
7520: 64 20 61 73 20 77 65 6c 6c 20 61 73 20 74 68 65 d as well as the
7530: 0a 20 20 64 65 66 61 75 6c 74 2e 20 42 79 20 73 . default. By s
7540: 70 65 63 69 66 79 69 6e 67 20 6f 6e 65 20 6f 66 pecifying one of
7550: 20 74 68 65 20 65 78 74 72 61 20 56 46 53 20 69 the extra VFS i
7560: 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20 0a mplementations .
7570: 20 20 77 68 65 6e 20 63 61 6c 6c 69 6e 67 20 5b when calling [
7580: 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 sqlite3_open_v2(
7590: 29 5d 2c 20 61 6e 20 61 70 70 6c 69 63 61 74 69 )], an applicati
75a0: 6f 6e 20 6d 61 79 20 62 79 70 61 73 73 20 74 68 on may bypass th
75b0: 65 20 66 69 6c 65 2d 73 79 73 74 65 6d 0a 20 20 e file-system.
75c0: 64 65 74 65 63 74 69 6f 6e 20 6c 6f 67 69 63 20 detection logic
75d0: 61 6e 64 20 65 78 70 6c 69 63 69 74 6c 79 20 73 and explicitly s
75e0: 65 6c 65 63 74 20 6f 6e 65 20 6f 66 20 74 68 65 elect one of the
75f0: 20 61 62 6f 76 65 20 6c 6f 63 6b 69 6e 67 20 73 above locking s
7600: 74 79 6c 65 73 2e 20 54 68 65 0a 20 20 66 69 76 tyles. The. fiv
7610: 65 20 65 78 74 72 61 20 5b 56 46 53 5d 20 69 6d e extra [VFS] im
7620: 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20 61 72 plementations ar
7630: 65 20 63 61 6c 6c 65 64 20 22 75 6e 69 78 2d 70 e called "unix-p
7640: 6f 73 69 78 22 2c 20 22 75 6e 69 78 2d 61 66 70 osix", "unix-afp
7650: 22 2c 0a 20 20 22 75 6e 69 78 2d 66 6c 6f 63 6b ",. "unix-flock
7660: 22 2c 20 22 75 6e 69 78 2d 64 6f 74 66 69 6c 65 ", "unix-dotfile
7670: 22 20 61 6e 64 20 22 75 6e 69 78 2d 6e 6f 6e 65 " and "unix-none
7680: 22 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 "..}..COMPILE_OP
7690: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 TION {SQLITE_ENA
76a0: 42 4c 45 5f 4d 45 4d 4f 52 59 5f 4d 41 4e 41 47 BLE_MEMORY_MANAG
76b0: 45 4d 45 4e 54 7d 20 7b 0a 20 20 54 68 69 73 20 EMENT} {. This
76c0: 6f 70 74 69 6f 6e 20 61 64 64 73 20 65 78 74 72 option adds extr
76d0: 61 20 6c 6f 67 69 63 20 74 6f 20 53 51 4c 69 74 a logic to SQLit
76e0: 65 20 74 68 61 74 20 61 6c 6c 6f 77 73 20 69 74 e that allows it
76f0: 20 74 6f 20 72 65 6c 65 61 73 65 20 75 6e 75 73 to release unus
7700: 65 64 0a 20 20 6d 65 6d 6f 72 79 20 75 70 6f 6e ed. memory upon
7710: 20 72 65 71 75 65 73 74 2e 20 20 54 68 69 73 20 request. This
7720: 6f 70 74 69 6f 6e 20 6d 75 73 74 20 62 65 20 65 option must be e
7730: 6e 61 62 6c 65 64 20 69 6e 20 6f 72 64 65 72 20 nabled in order
7740: 66 6f 72 20 74 68 65 0a 20 20 5b 73 71 6c 69 74 for the. [sqlit
7750: 65 33 5f 72 65 6c 65 61 73 65 5f 6d 65 6d 6f 72 e3_release_memor
7760: 79 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 74 y()] interface t
7770: 6f 20 77 6f 72 6b 2e 20 20 49 66 20 74 68 69 73 o work. If this
7780: 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 0a 20 20 compile-time.
7790: 6f 70 74 69 6f 6e 20 69 73 20 6e 6f 74 20 75 73 option is not us
77a0: 65 64 2c 20 74 68 65 20 5b 73 71 6c 69 74 65 33 ed, the [sqlite3
77b0: 5f 72 65 6c 65 61 73 65 5f 6d 65 6d 6f 72 79 28 _release_memory(
77c0: 29 5d 20 69 6e 74 65 72 66 61 63 65 20 69 73 20 )] interface is
77d0: 61 20 0a 20 20 6e 6f 2d 6f 70 2e 0a 7d 0a 0a 43 a . no-op..}..C
77e0: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
77f0: 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4d 45 4d QLITE_ENABLE_MEM
7800: 53 59 53 33 7d 20 7b 0a 20 20 54 68 69 73 20 6f SYS3} {. This o
7810: 70 74 69 6f 6e 20 69 6e 63 6c 75 64 65 73 20 63 ption includes c
7820: 6f 64 65 20 69 6e 20 53 51 4c 69 74 65 20 74 68 ode in SQLite th
7830: 61 74 20 69 6d 70 6c 65 6d 65 6e 74 73 20 61 6e at implements an
7840: 20 61 6c 74 65 72 6e 61 74 69 76 65 0a 20 20 6d alternative. m
7850: 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 2e emory allocator.
7860: 20 20 54 68 69 73 20 61 6c 74 65 72 6e 61 74 69 This alternati
7870: 76 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 ve memory alloca
7880: 74 6f 72 20 69 73 20 6f 6e 6c 79 20 65 6e 67 61 tor is only enga
7890: 67 65 64 0a 20 20 77 68 65 6e 20 74 68 65 20 5b ged. when the [
78a0: 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 48 45 SQLITE_CONFIG_HE
78b0: 41 50 5d 20 6f 70 74 69 6f 6e 20 74 6f 20 5b 73 AP] option to [s
78c0: 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d qlite3_config()]
78d0: 20 69 73 20 75 73 65 64 20 74 6f 0a 20 20 73 75 is used to. su
78e0: 70 70 6c 79 20 61 20 6c 61 72 67 65 20 63 68 75 pply a large chu
78f0: 6e 6b 20 6f 66 20 6d 65 6d 6f 72 79 20 66 72 6f nk of memory fro
7900: 6d 20 77 68 69 63 68 20 61 6c 6c 20 6d 65 6d 6f m which all memo
7910: 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 73 20 61 ry allocations a
7920: 72 65 0a 20 20 74 61 6b 65 6e 2e 0a 20 20 54 68 re. taken.. Th
7930: 65 20 4d 45 4d 53 59 53 33 20 6d 65 6d 6f 72 79 e MEMSYS3 memory
7940: 20 61 6c 6c 6f 63 61 74 6f 72 20 75 73 65 73 20 allocator uses
7950: 61 20 68 79 62 72 69 64 20 61 6c 6c 6f 63 61 74 a hybrid allocat
7960: 69 6f 6e 20 61 6c 67 6f 72 69 74 68 6d 20 0a 20 ion algorithm .
7970: 20 70 61 74 74 65 72 6e 65 64 20 61 66 74 65 72 patterned after
7980: 20 64 6c 6d 61 6c 6c 6f 63 28 29 2e 20 20 20 4f dlmalloc(). O
7990: 6e 6c 79 20 6f 6e 65 20 6f 66 20 53 51 4c 49 54 nly one of SQLIT
79a0: 45 5f 45 4e 41 42 4c 45 5f 4d 45 4d 53 59 53 33 E_ENABLE_MEMSYS3
79b0: 20 61 6e 64 20 0a 20 20 53 51 4c 49 54 45 5f 45 and . SQLITE_E
79c0: 4e 41 42 4c 45 5f 4d 45 4d 53 59 53 35 20 6d 61 NABLE_MEMSYS5 ma
79d0: 79 20 62 65 20 65 6e 61 62 6c 65 64 20 61 74 20 y be enabled at
79e0: 6f 6e 63 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 once..}..COMPILE
79f0: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
7a00: 45 4e 41 42 4c 45 5f 4d 45 4d 53 59 53 35 7d 20 ENABLE_MEMSYS5}
7a10: 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 {. This option
7a20: 69 6e 63 6c 75 64 65 73 20 63 6f 64 65 20 69 6e includes code in
7a30: 20 53 51 4c 69 74 65 20 74 68 61 74 20 69 6d 70 SQLite that imp
7a40: 6c 65 6d 65 6e 74 73 20 61 6e 20 61 6c 74 65 72 lements an alter
7a50: 6e 61 74 69 76 65 0a 20 20 6d 65 6d 6f 72 79 20 native. memory
7a60: 61 6c 6c 6f 63 61 74 6f 72 2e 20 20 54 68 69 73 allocator. This
7a70: 20 61 6c 74 65 72 6e 61 74 69 76 65 20 6d 65 6d alternative mem
7a80: 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 20 69 73 ory allocator is
7a90: 20 6f 6e 6c 79 20 65 6e 67 61 67 65 64 0a 20 20 only engaged.
7aa0: 77 68 65 6e 20 74 68 65 20 5b 53 51 4c 49 54 45 when the [SQLITE
7ab0: 5f 43 4f 4e 46 49 47 5f 48 45 41 50 5d 20 6f 70 _CONFIG_HEAP] op
7ac0: 74 69 6f 6e 20 74 6f 20 5b 73 71 6c 69 74 65 33 tion to [sqlite3
7ad0: 5f 63 6f 6e 66 69 67 28 29 5d 20 69 73 20 75 73 _config()] is us
7ae0: 65 64 20 74 6f 0a 20 20 73 75 70 70 6c 79 20 61 ed to. supply a
7af0: 20 6c 61 72 67 65 20 63 68 75 6e 6b 20 6f 66 20 large chunk of
7b00: 6d 65 6d 6f 72 79 20 66 72 6f 6d 20 77 68 69 63 memory from whic
7b10: 68 20 61 6c 6c 20 6d 65 6d 6f 72 79 20 61 6c 6c h all memory all
7b20: 6f 63 61 74 69 6f 6e 73 20 61 72 65 0a 20 20 74 ocations are. t
7b30: 61 6b 65 6e 2e 0a 20 20 54 68 65 20 4d 45 4d 53 aken.. The MEMS
7b40: 59 53 35 20 6d 6f 64 75 6c 65 20 72 6f 75 6e 64 YS5 module round
7b50: 73 20 61 6c 6c 20 61 6c 6c 6f 63 61 74 69 6f 6e s all allocation
7b60: 73 20 75 70 20 74 6f 20 74 68 65 20 6e 65 78 74 s up to the next
7b70: 20 70 6f 77 65 72 0a 20 20 6f 66 20 74 77 6f 20 power. of two
7b80: 61 6e 64 20 75 73 65 73 20 61 20 66 69 72 73 74 and uses a first
7b90: 2d 66 69 74 2c 20 62 75 64 64 79 2d 61 6c 6c 6f -fit, buddy-allo
7ba0: 63 61 74 6f 72 20 61 6c 67 6f 72 69 74 68 6d 0a cator algorithm.
7bb0: 20 20 74 68 61 74 20 70 72 6f 76 69 64 65 73 20 that provides
7bc0: 73 74 72 6f 6e 67 20 67 75 61 72 61 6e 74 65 65 strong guarantee
7bd0: 73 20 61 67 61 69 6e 73 74 20 66 72 61 67 6d 65 s against fragme
7be0: 6e 74 61 74 69 6f 6e 20 61 6e 64 20 62 72 65 61 ntation and brea
7bf0: 6b 64 6f 77 6e 0a 20 20 73 75 62 6a 65 63 74 20 kdown. subject
7c00: 74 6f 20 63 65 72 74 61 69 6e 20 6f 70 65 72 61 to certain opera
7c10: 74 69 6e 67 20 63 6f 6e 73 74 72 61 69 6e 74 73 ting constraints
7c20: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
7c30: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 ION {SQLITE_ENAB
7c40: 4c 45 5f 4f 54 41 7d 20 7b 0a 20 20 45 6e 61 62 LE_OTA} {. Enab
7c50: 6c 65 20 74 68 65 20 63 6f 64 65 20 74 68 65 20 le the code the
7c60: 69 6d 70 6c 65 6d 65 6e 74 73 20 74 68 65 20 5b implements the [
7c70: 4f 54 41 20 65 78 74 65 6e 73 69 6f 6e 5d 2e 0a OTA extension]..
7c80: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
7c90: 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 N {SQLITE_ENABLE
7ca0: 5f 52 54 52 45 45 7d 20 7b 0a 20 20 54 68 69 73 _RTREE} {. This
7cb0: 20 6f 70 74 69 6f 6e 20 63 61 75 73 65 73 20 53 option causes S
7cc0: 51 4c 69 74 65 20 74 6f 20 69 6e 63 6c 75 64 65 QLite to include
7cd0: 20 73 75 70 70 6f 72 74 20 66 6f 72 20 74 68 65 support for the
7ce0: 0a 20 20 5b 72 74 72 65 65 20 7c 20 52 2a 54 72 . [rtree | R*Tr
7cf0: 65 65 20 69 6e 64 65 78 20 65 78 74 65 6e 73 69 ee index extensi
7d00: 6f 6e 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f on]..}..COMPILE_
7d10: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 OPTION {SQLITE_E
7d20: 4e 41 42 4c 45 5f 53 54 4d 54 5f 53 43 41 4e 53 NABLE_STMT_SCANS
7d30: 54 41 54 55 53 7d 20 7b 0a 20 20 54 68 69 73 20 TATUS} {. This
7d40: 6f 70 74 69 6f 6e 20 65 6e 61 62 6c 65 73 20 74 option enables t
7d50: 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 74 6d 74 he [sqlite3_stmt
7d60: 5f 73 63 61 6e 73 74 61 74 75 73 28 29 5d 20 69 _scanstatus()] i
7d70: 6e 74 65 72 66 61 63 65 2e 20 20 54 68 65 0a 20 nterface. The.
7d80: 20 5b 73 71 6c 69 74 65 33 5f 73 74 6d 74 5f 73 [sqlite3_stmt_s
7d90: 63 61 6e 73 74 61 74 75 73 28 29 5d 20 69 6e 74 canstatus()] int
7da0: 65 72 66 61 63 65 20 69 73 20 6e 6f 72 6d 61 6c erface is normal
7db0: 6c 79 20 6f 6d 69 74 74 65 64 20 66 72 6f 6d 20 ly omitted from
7dc0: 74 68 65 20 62 75 69 6c 64 0a 20 20 62 65 63 61 the build. beca
7dd0: 75 73 65 20 69 74 20 69 6d 70 6f 73 65 73 20 61 use it imposes a
7de0: 20 73 6d 61 6c 6c 20 70 65 72 66 6f 72 6d 61 6e small performan
7df0: 63 65 20 70 65 6e 61 6c 74 79 2c 20 65 76 65 6e ce penalty, even
7e00: 20 6f 6e 20 73 74 61 74 65 6d 65 6e 74 73 20 74 on statements t
7e10: 68 61 74 0a 20 20 64 6f 20 6e 6f 74 20 75 73 65 hat. do not use
7e20: 20 74 68 65 20 66 65 61 74 75 72 65 2e 0a 7d 0a the feature..}.
7e30: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
7e40: 7b 53 51 4c 49 54 45 5f 52 54 52 45 45 5f 49 4e {SQLITE_RTREE_IN
7e50: 54 5f 4f 4e 4c 59 7d 20 7b 0a 20 20 49 66 20 74 T_ONLY} {. If t
7e60: 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 75 73 his option is us
7e70: 65 64 20 74 6f 67 65 74 68 65 72 20 77 69 74 68 ed together with
7e80: 20 5b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f [SQLITE_ENABLE_
7e90: 52 54 52 45 45 5d 20 74 68 65 6e 20 74 68 65 0a RTREE] then the.
7ea0: 20 20 5b 72 74 72 65 65 20 7c 20 52 2a 54 72 65 [rtree | R*Tre
7eb0: 65 20 65 78 74 65 6e 73 69 6f 6e 5d 20 77 69 6c e extension] wil
7ec0: 6c 20 6f 6e 6c 79 20 73 74 6f 72 65 20 33 32 2d l only store 32-
7ed0: 62 69 74 20 73 69 67 6e 65 64 20 69 6e 74 65 67 bit signed integ
7ee0: 65 72 0a 20 20 63 6f 6f 72 64 69 6e 61 74 65 73 er. coordinates
7ef0: 20 61 6e 64 20 61 6c 6c 20 69 6e 74 65 72 6e 61 and all interna
7f00: 6c 20 63 6f 6d 70 75 74 61 74 69 6f 6e 73 20 77 l computations w
7f10: 69 6c 6c 20 62 65 20 64 6f 6e 65 20 75 73 69 6e ill be done usin
7f20: 67 20 69 6e 74 65 67 65 72 73 0a 20 20 69 6e 73 g integers. ins
7f30: 74 65 61 64 20 6f 66 20 66 6c 6f 61 74 69 6e 67 tead of floating
7f40: 20 70 6f 69 6e 74 20 6e 75 6d 62 65 72 73 2e 0a point numbers..
7f50: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
7f60: 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 N {SQLITE_ENABLE
7f70: 5f 53 51 4c 4c 4f 47 7d 20 7b 0a 20 20 54 68 69 _SQLLOG} {. Thi
7f80: 73 20 6f 70 74 69 6f 6e 20 65 6e 61 62 6c 65 73 s option enables
7f90: 20 65 78 74 72 61 20 63 6f 64 65 20 28 65 73 70 extra code (esp
7fa0: 65 63 69 61 6c 6c 79 20 74 68 65 20 5b 53 51 4c ecially the [SQL
7fb0: 49 54 45 5f 43 4f 4e 46 49 47 5f 53 51 4c 4c 4f ITE_CONFIG_SQLLO
7fc0: 47 5d 0a 20 20 6f 70 74 69 6f 6e 20 74 6f 20 5b G]. option to [
7fd0: 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 sqlite3_config()
7fe0: 5d 29 20 74 68 61 74 20 63 61 6e 20 62 65 20 75 ]) that can be u
7ff0: 73 65 64 20 74 6f 20 63 72 65 61 74 65 20 6c 6f sed to create lo
8000: 67 73 20 6f 66 20 61 6c 6c 0a 20 20 53 51 4c 69 gs of all. SQLi
8010: 74 65 20 70 72 6f 63 65 73 73 69 6e 67 20 70 65 te processing pe
8020: 72 66 6f 72 6d 65 64 20 62 79 20 61 6e 20 61 70 rformed by an ap
8030: 70 6c 69 63 61 74 69 6f 6e 2e 20 20 54 68 65 73 plication. Thes
8040: 65 20 6c 6f 67 73 20 63 61 6e 20 62 65 20 75 73 e logs can be us
8050: 65 66 75 6c 0a 20 20 69 6e 20 64 6f 69 6e 67 20 eful. in doing
8060: 6f 66 66 2d 6c 69 6e 65 20 61 6e 61 6c 79 73 69 off-line analysi
8070: 73 20 6f 66 20 74 68 65 20 62 65 68 61 76 69 6f s of the behavio
8080: 72 20 6f 66 20 61 6e 20 61 70 70 6c 69 63 61 74 r of an applicat
8090: 69 6f 6e 2c 20 61 6e 64 20 65 73 70 65 63 69 61 ion, and especia
80a0: 6c 6c 79 0a 20 20 66 6f 72 20 70 65 72 66 6f 72 lly. for perfor
80b0: 6d 61 6e 63 65 20 61 6e 61 6c 79 73 69 73 2e 20 mance analysis.
80c0: 20 49 6e 20 6f 72 64 65 72 20 66 6f 72 20 74 68 In order for th
80d0: 65 20 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f e SQLITE_ENABLE_
80e0: 53 51 4c 4c 4f 47 20 6f 70 74 69 6f 6e 20 74 6f SQLLOG option to
80f0: 20 0a 20 20 62 65 20 75 73 65 66 75 6c 2c 20 73 . be useful, s
8100: 6f 6d 65 20 65 78 74 72 61 20 63 6f 64 65 20 69 ome extra code i
8110: 73 20 72 65 71 75 69 72 65 64 2e 20 20 54 68 65 s required. The
8120: 20 0a 20 20 3c 61 20 68 72 65 66 3d 22 68 74 74 . <a href="htt
8130: 70 3a 2f 2f 77 77 77 2e 73 71 6c 69 74 65 2e 6f p://www.sqlite.o
8140: 72 67 2f 73 72 63 2f 64 6f 63 2f 74 72 75 6e 6b rg/src/doc/trunk
8150: 2f 73 72 63 2f 74 65 73 74 5f 73 71 6c 6c 6f 67 /src/test_sqllog
8160: 2e 63 22 3e 22 74 65 73 74 5f 73 71 6c 6c 6f 67 .c">"test_sqllog
8170: 2e 63 22 3c 2f 61 3e 0a 20 20 73 6f 75 72 63 65 .c"</a>. source
8180: 20 63 6f 64 65 0a 20 20 66 69 6c 65 20 69 6e 20 code. file in
8190: 74 68 65 20 53 51 4c 69 74 65 20 73 6f 75 72 63 the SQLite sourc
81a0: 65 20 74 72 65 65 20 69 73 20 61 20 77 6f 72 6b e tree is a work
81b0: 69 6e 67 20 65 78 61 6d 70 6c 65 20 6f 66 20 74 ing example of t
81c0: 68 65 20 72 65 71 75 69 72 65 64 20 65 78 74 72 he required extr
81d0: 61 0a 20 20 63 6f 64 65 2e 20 20 4f 6e 20 75 6e a. code. On un
81e0: 69 78 20 61 6e 64 20 77 69 6e 64 6f 77 73 20 73 ix and windows s
81f0: 79 73 74 65 6d 73 2c 20 61 20 64 65 76 65 6c 6f ystems, a develo
8200: 70 65 72 20 63 61 6e 20 61 70 70 65 6e 64 20 74 per can append t
8210: 68 65 20 74 65 78 74 20 6f 66 20 74 68 65 0a 20 he text of the.
8220: 20 22 74 65 73 74 5f 73 71 6c 6c 6f 67 2e 63 22 "test_sqllog.c"
8230: 20 73 6f 75 72 63 65 20 63 6f 64 65 20 66 69 6c source code fil
8240: 65 20 74 6f 20 74 68 65 20 65 6e 64 20 6f 66 20 e to the end of
8250: 61 6e 20 22 73 71 6c 69 74 65 33 2e 63 22 20 61 an "sqlite3.c" a
8260: 6d 61 6c 67 61 6d 61 74 69 6f 6e 2c 0a 20 20 72 malgamation,. r
8270: 65 63 6f 6d 70 69 6c 65 20 74 68 65 20 61 70 70 ecompile the app
8280: 6c 69 63 61 74 69 6f 6e 20 75 73 69 6e 67 20 74 lication using t
8290: 68 65 20 2d 44 53 51 4c 49 54 45 5f 45 4e 41 42 he -DSQLITE_ENAB
82a0: 4c 45 5f 53 51 4c 4c 4f 47 20 6f 70 74 69 6f 6e LE_SQLLOG option
82b0: 2c 20 74 68 65 6e 20 0a 20 20 63 6f 6e 74 72 6f , then . contro
82c0: 6c 20 6c 6f 67 67 69 6e 67 20 75 73 69 6e 67 20 l logging using
82d0: 65 6e 76 69 72 6f 6e 6d 65 6e 74 20 76 61 72 69 environment vari
82e0: 61 62 6c 65 73 2e 20 20 53 65 65 20 74 68 65 20 ables. See the
82f0: 68 65 61 64 65 72 20 63 6f 6d 6d 65 6e 74 20 6f header comment o
8300: 6e 20 0a 20 20 74 68 65 20 22 74 65 73 74 5f 73 n . the "test_s
8310: 71 6c 6c 6f 67 2e 63 22 20 73 6f 75 72 63 65 20 qllog.c" source
8320: 66 69 6c 65 20 66 6f 72 20 61 64 64 69 74 69 6f file for additio
8330: 6e 61 6c 20 64 65 74 61 69 6c 2e 20 20 0a 7d 0a nal detail. .}.
8340: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
8350: 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 53 {SQLITE_ENABLE_S
8360: 54 41 54 32 7d 20 7b 0a 20 20 54 68 69 73 20 6f TAT2} {. This o
8370: 70 74 69 6f 6e 20 75 73 65 64 20 74 6f 20 63 61 ption used to ca
8380: 75 73 65 20 74 68 65 20 5b 41 4e 41 4c 59 5a 45 use the [ANALYZE
8390: 5d 20 63 6f 6d 6d 61 6e 64 20 74 6f 20 63 6f 6c ] command to col
83a0: 6c 65 63 74 0a 20 20 69 6e 64 65 78 20 68 69 73 lect. index his
83b0: 74 6f 67 72 61 6d 20 64 61 74 61 20 69 6e 20 74 togram data in t
83c0: 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 73 74 61 he <b>sqlite_sta
83d0: 74 32 3c 2f 62 3e 20 74 61 62 6c 65 2e 20 20 42 t2</b> table. B
83e0: 75 74 20 74 68 61 74 0a 20 20 66 75 6e 63 74 69 ut that. functi
83f0: 6f 6e 61 6c 69 74 79 20 77 61 73 20 73 75 70 65 onality was supe
8400: 72 63 65 64 65 64 20 62 79 20 5b 53 51 4c 49 54 rceded by [SQLIT
8410: 45 5f 45 4e 41 42 4c 45 5f 53 54 41 54 33 5d 20 E_ENABLE_STAT3]
8420: 61 73 20 6f 66 0a 20 20 53 51 4c 69 74 65 20 76 as of. SQLite v
8430: 65 72 73 69 6f 6e 20 33 2e 37 2e 39 2e 20 20 54 ersion 3.7.9. T
8440: 68 65 20 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 he SQLITE_ENABLE
8450: 5f 53 54 41 54 32 20 63 6f 6d 70 69 6c 65 2d 74 _STAT2 compile-t
8460: 69 6d 65 20 6f 70 74 69 6f 6e 0a 20 20 69 73 20 ime option. is
8470: 6e 6f 77 20 61 20 6e 6f 2d 6f 70 2e 0a 7d 0a 0a now a no-op..}..
8480: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
8490: 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 53 54 SQLITE_ENABLE_ST
84a0: 41 54 33 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 AT3} {. This op
84b0: 74 69 6f 6e 20 61 64 64 73 20 61 64 64 69 74 69 tion adds additi
84c0: 6f 6e 61 6c 20 6c 6f 67 69 63 20 74 6f 20 74 68 onal logic to th
84d0: 65 20 5b 41 4e 41 4c 59 5a 45 5d 20 63 6f 6d 6d e [ANALYZE] comm
84e0: 61 6e 64 20 61 6e 64 20 74 6f 0a 20 20 74 68 65 and and to. the
84f0: 20 5b 71 75 65 72 79 20 70 6c 61 6e 6e 65 72 5d [query planner]
8500: 20 74 68 61 74 20 63 61 6e 20 68 65 6c 70 20 53 that can help S
8510: 51 4c 69 74 65 20 74 6f 20 63 68 6f 73 65 20 61 QLite to chose a
8520: 20 62 65 74 74 65 72 20 71 75 65 72 79 20 70 6c better query pl
8530: 61 6e 0a 20 20 75 6e 64 65 72 20 63 65 72 74 61 an. under certa
8540: 69 6e 20 73 69 74 75 61 74 69 6f 6e 73 2e 20 20 in situations.
8550: 54 68 65 20 5b 41 4e 41 4c 59 5a 45 5d 20 63 6f The [ANALYZE] co
8560: 6d 6d 61 6e 64 20 69 73 20 65 6e 68 61 6e 63 65 mmand is enhance
8570: 64 20 74 6f 20 63 6f 6c 6c 65 63 74 0a 20 20 68 d to collect. h
8580: 69 73 74 6f 67 72 61 6d 20 64 61 74 61 20 66 72 istogram data fr
8590: 6f 6d 20 74 68 65 20 6c 65 66 74 2d 6d 6f 73 74 om the left-most
85a0: 20 63 6f 6c 75 6d 6e 20 6f 66 20 65 61 63 68 20 column of each
85b0: 69 6e 64 65 78 20 61 6e 64 20 73 74 6f 72 65 20 index and store
85c0: 74 68 61 74 20 64 61 74 61 0a 20 20 69 6e 20 74 that data. in t
85d0: 68 65 20 5b 73 71 6c 69 74 65 5f 73 74 61 74 33 he [sqlite_stat3
85e0: 5d 20 74 61 62 6c 65 2e 20 20 54 68 65 20 71 75 ] table. The qu
85f0: 65 72 79 20 70 6c 61 6e 6e 65 72 20 77 69 6c 6c ery planner will
8600: 20 74 68 65 6e 20 75 73 65 20 74 68 65 0a 20 20 then use the.
8610: 68 69 73 74 6f 67 72 61 6d 20 64 61 74 61 20 74 histogram data t
8620: 6f 20 68 65 6c 70 20 69 74 20 6d 61 6b 65 20 62 o help it make b
8630: 65 74 74 65 72 20 69 6e 64 65 78 20 63 68 6f 69 etter index choi
8640: 63 65 73 2e 20 20 4e 6f 74 65 2c 20 68 6f 77 65 ces. Note, howe
8650: 76 65 72 2c 0a 20 20 74 68 61 74 20 74 68 65 20 ver,. that the
8660: 75 73 65 20 6f 66 20 68 69 73 74 6f 67 72 61 6d use of histogram
8670: 20 64 61 74 61 20 69 6e 20 71 75 65 72 79 20 70 data in query p
8680: 6c 61 6e 6e 65 72 20 76 69 6f 6c 61 74 65 73 20 lanner violates
8690: 74 68 65 0a 20 20 5b 71 75 65 72 79 20 70 6c 61 the. [query pla
86a0: 6e 6e 65 72 20 73 74 61 62 69 6c 69 74 79 20 67 nner stability g
86b0: 75 61 72 61 6e 74 65 65 5d 20 77 68 69 63 68 20 uarantee] which
86c0: 69 73 20 69 6d 70 6f 72 74 61 6e 74 20 74 6f 20 is important to
86d0: 73 6f 6d 65 20 61 70 70 6c 69 63 61 74 69 6f 6e some application
86e0: 73 2e 0a 20 20 3c 70 3e 0a 7d 0a 0a 43 4f 4d 50 s.. <p>.}..COMP
86f0: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
8700: 54 45 5f 45 4e 41 42 4c 45 5f 53 54 41 54 34 7d TE_ENABLE_STAT4}
8710: 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e {. This option
8720: 20 61 64 64 73 20 61 64 64 69 74 69 6f 6e 61 6c adds additional
8730: 20 6c 6f 67 69 63 20 74 6f 20 74 68 65 20 5b 41 logic to the [A
8740: 4e 41 4c 59 5a 45 5d 20 63 6f 6d 6d 61 6e 64 20 NALYZE] command
8750: 61 6e 64 20 74 6f 0a 20 20 74 68 65 20 5b 71 75 and to. the [qu
8760: 65 72 79 20 70 6c 61 6e 6e 65 72 5d 20 74 68 61 ery planner] tha
8770: 74 20 63 61 6e 20 68 65 6c 70 20 53 51 4c 69 74 t can help SQLit
8780: 65 20 74 6f 20 63 68 6f 73 65 20 61 20 62 65 74 e to chose a bet
8790: 74 65 72 20 71 75 65 72 79 20 70 6c 61 6e 0a 20 ter query plan.
87a0: 20 75 6e 64 65 72 20 63 65 72 74 61 69 6e 20 73 under certain s
87b0: 69 74 75 61 74 69 6f 6e 73 2e 20 20 54 68 65 20 ituations. The
87c0: 5b 41 4e 41 4c 59 5a 45 5d 20 63 6f 6d 6d 61 6e [ANALYZE] comman
87d0: 64 20 69 73 20 65 6e 68 61 6e 63 65 64 20 74 6f d is enhanced to
87e0: 20 63 6f 6c 6c 65 63 74 0a 20 20 68 69 73 74 6f collect. histo
87f0: 67 72 61 6d 20 64 61 74 61 20 66 72 6f 6d 20 61 gram data from a
8800: 6c 6c 20 63 6f 6c 75 6d 6e 73 20 6f 66 20 65 76 ll columns of ev
8810: 65 72 79 20 69 6e 64 65 78 20 61 6e 64 20 73 74 ery index and st
8820: 6f 72 65 20 74 68 61 74 20 64 61 74 61 0a 20 20 ore that data.
8830: 69 6e 20 74 68 65 20 5b 73 71 6c 69 74 65 5f 73 in the [sqlite_s
8840: 74 61 74 34 5d 20 74 61 62 6c 65 2e 20 20 54 68 tat4] table. Th
8850: 65 20 71 75 65 72 79 20 70 6c 61 6e 6e 65 72 20 e query planner
8860: 77 69 6c 6c 20 74 68 65 6e 20 75 73 65 20 74 68 will then use th
8870: 65 0a 20 20 68 69 73 74 6f 67 72 61 6d 20 64 61 e. histogram da
8880: 74 61 20 74 6f 20 68 65 6c 70 20 69 74 20 6d 61 ta to help it ma
8890: 6b 65 20 62 65 74 74 65 72 20 69 6e 64 65 78 20 ke better index
88a0: 63 68 6f 69 63 65 73 2e 20 20 54 68 65 20 64 6f choices. The do
88b0: 77 6e 73 69 64 65 20 6f 66 0a 20 20 74 68 69 73 wnside of. this
88c0: 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 compile-time op
88d0: 74 69 6f 6e 20 69 73 20 74 68 61 74 20 69 74 20 tion is that it
88e0: 76 69 6f 6c 61 74 65 73 20 74 68 65 0a 20 20 5b violates the. [
88f0: 71 75 65 72 79 20 70 6c 61 6e 6e 65 72 20 73 74 query planner st
8900: 61 62 69 6c 69 74 79 20 67 75 61 72 61 6e 74 65 ability guarante
8910: 65 5d 20 6d 61 6b 69 6e 67 20 69 74 20 6d 6f 72 e] making it mor
8920: 65 20 64 69 66 66 69 63 75 6c 74 20 74 6f 20 65 e difficult to e
8930: 6e 73 75 72 65 0a 20 20 63 6f 6e 73 69 73 74 65 nsure. consiste
8940: 6e 74 20 70 65 72 66 6f 72 6d 61 6e 63 65 20 69 nt performance i
8950: 6e 20 6d 61 73 73 2d 70 72 6f 64 75 63 65 64 20 n mass-produced
8960: 61 70 70 6c 69 63 61 74 69 6f 6e 73 2e 0a 20 20 applications..
8970: 3c 70 3e 0a 20 20 53 51 4c 49 54 45 5f 45 4e 41 <p>. SQLITE_ENA
8980: 42 4c 45 5f 53 54 41 54 34 20 69 73 20 61 6e 20 BLE_STAT4 is an
8990: 65 6e 68 61 6e 63 65 6d 65 6e 74 20 6f 66 20 5b enhancement of [
89a0: 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 53 54 SQLITE_ENABLE_ST
89b0: 41 54 33 5d 2e 20 20 53 54 41 54 33 0a 20 20 6f AT3]. STAT3. o
89c0: 6e 6c 79 20 72 65 63 6f 72 64 65 64 20 68 69 73 nly recorded his
89d0: 74 6f 67 72 61 6d 20 64 61 74 61 20 66 6f 72 20 togram data for
89e0: 74 68 65 20 6c 65 66 74 2d 6d 6f 73 74 20 63 6f the left-most co
89f0: 6c 75 6d 6e 20 6f 66 20 65 61 63 68 20 69 6e 64 lumn of each ind
8a00: 65 78 0a 20 20 77 68 65 72 65 61 73 20 74 68 65 ex. whereas the
8a10: 20 53 54 41 54 34 20 65 6e 68 61 6e 63 65 6d 65 STAT4 enhanceme
8a20: 6e 74 20 72 65 63 6f 72 64 73 20 68 69 73 74 6f nt records histo
8a30: 67 72 61 6d 20 64 61 74 61 20 66 72 6f 6d 20 61 gram data from a
8a40: 6c 6c 20 63 6f 6c 75 6d 6e 73 0a 20 20 6f 66 20 ll columns. of
8a50: 65 61 63 68 20 69 6e 64 65 78 2e 0a 20 20 54 68 each index.. Th
8a60: 65 20 5b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 e [SQLITE_ENABLE
8a70: 5f 53 54 41 54 33 5d 20 63 6f 6d 70 69 6c 65 2d _STAT3] compile-
8a80: 74 69 6d 65 20 6f 70 74 69 6f 6e 20 69 73 20 61 time option is a
8a90: 20 6e 6f 2d 6f 70 20 61 6e 64 20 69 73 20 69 67 no-op and is ig
8aa0: 6e 6f 72 65 64 0a 20 20 69 66 20 74 68 65 20 53 nored. if the S
8ab0: 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 53 54 41 QLITE_ENABLE_STA
8ac0: 54 34 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 T4 compile-time
8ad0: 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 2e 0a option is used..
8ae0: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
8af0: 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 N {SQLITE_ENABLE
8b00: 5f 54 52 45 45 5f 45 58 50 4c 41 49 4e 7d 20 7b _TREE_EXPLAIN} {
8b10: 0a 20 20 54 68 69 73 20 63 6f 6d 70 69 6c 65 2d . This compile-
8b20: 74 69 6d 65 20 6f 70 74 69 6f 6e 20 69 73 20 6e time option is n
8b30: 6f 20 6c 6f 6e 67 65 72 20 75 73 65 64 2e 0a 7d o longer used..}
8b40: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
8b50: 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f {SQLITE_ENABLE_
8b60: 55 50 44 41 54 45 5f 44 45 4c 45 54 45 5f 4c 49 UPDATE_DELETE_LI
8b70: 4d 49 54 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 MIT} {. This op
8b80: 74 69 6f 6e 20 65 6e 61 62 6c 65 73 20 61 6e 20 tion enables an
8b90: 6f 70 74 69 6f 6e 61 6c 20 4f 52 44 45 52 20 42 optional ORDER B
8ba0: 59 20 61 6e 64 20 4c 49 4d 49 54 20 63 6c 61 75 Y and LIMIT clau
8bb0: 73 65 20 6f 6e 20 0a 20 20 5b 55 50 44 41 54 45 se on . [UPDATE
8bc0: 5d 20 61 6e 64 20 5b 44 45 4c 45 54 45 5d 20 73 ] and [DELETE] s
8bd0: 74 61 74 65 6d 65 6e 74 73 2e 0a 0a 20 20 3c 70 tatements... <p
8be0: 3e 49 66 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 >If this option
8bf0: 69 73 20 64 65 66 69 6e 65 64 2c 20 74 68 65 6e is defined, then
8c00: 20 69 74 20 6d 75 73 74 20 61 6c 73 6f 20 62 65 it must also be
8c10: 20 0a 20 20 64 65 66 69 6e 65 64 20 77 68 65 6e . defined when
8c20: 20 75 73 69 6e 67 20 74 68 65 20 27 6c 65 6d 6f using the 'lemo
8c30: 6e 27 20 74 6f 6f 6c 20 74 6f 20 67 65 6e 65 72 n' tool to gener
8c40: 61 74 65 20 61 20 70 61 72 73 65 2e 63 0a 20 20 ate a parse.c.
8c50: 66 69 6c 65 2e 20 42 65 63 61 75 73 65 20 6f 66 file. Because of
8c60: 20 74 68 69 73 2c 20 74 68 69 73 20 6f 70 74 69 this, this opti
8c70: 6f 6e 20 6d 61 79 20 6f 6e 6c 79 20 62 65 20 75 on may only be u
8c80: 73 65 64 20 77 68 65 6e 20 74 68 65 20 6c 69 62 sed when the lib
8c90: 72 61 72 79 20 69 73 20 62 75 69 6c 74 0a 20 20 rary is built.
8ca0: 66 72 6f 6d 20 73 6f 75 72 63 65 2c 20 6e 6f 74 from source, not
8cb0: 20 66 72 6f 6d 20 74 68 65 20 5b 61 6d 61 6c 67 from the [amalg
8cc0: 61 6d 61 74 69 6f 6e 5d 20 6f 72 20 66 72 6f 6d amation] or from
8cd0: 20 74 68 65 20 63 6f 6c 6c 65 63 74 69 6f 6e 20 the collection
8ce0: 6f 66 0a 20 20 70 72 65 2d 70 61 63 6b 61 67 65 of. pre-package
8cf0: 64 20 43 20 66 69 6c 65 73 20 70 72 6f 76 69 64 d C files provid
8d00: 65 64 20 66 6f 72 20 6e 6f 6e 2d 55 6e 69 78 20 ed for non-Unix
8d10: 6c 69 6b 65 20 70 6c 61 74 66 6f 72 6d 73 20 6f like platforms o
8d20: 6e 20 74 68 65 20 77 65 62 73 69 74 65 2e 0a 20 n the website..
8d30: 20 3c 2f 70 3e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 </p>.}..COMPILE
8d40: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
8d50: 45 4e 41 42 4c 45 5f 55 4e 4c 4f 43 4b 5f 4e 4f ENABLE_UNLOCK_NO
8d60: 54 49 46 59 7d 20 7b 0a 20 20 54 68 69 73 20 6f TIFY} {. This o
8d70: 70 74 69 6f 6e 20 65 6e 61 62 6c 65 73 20 74 68 ption enables th
8d80: 65 20 5b 73 71 6c 69 74 65 33 5f 75 6e 6c 6f 63 e [sqlite3_unloc
8d90: 6b 5f 6e 6f 74 69 66 79 28 29 5d 20 69 6e 74 65 k_notify()] inte
8da0: 72 66 61 63 65 20 61 6e 64 0a 20 20 69 74 73 20 rface and. its
8db0: 61 73 73 6f 63 69 61 74 65 64 20 66 75 6e 63 74 associated funct
8dc0: 69 6f 6e 61 6c 69 74 79 2e 20 20 53 65 65 20 74 ionality. See t
8dd0: 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e he documentation
8de0: 20 74 69 74 6c 65 64 0a 20 20 5b 55 73 69 6e 67 titled. [Using
8df0: 20 74 68 65 20 53 51 4c 69 74 65 20 55 6e 6c 6f the SQLite Unlo
8e00: 63 6b 20 4e 6f 74 69 66 69 63 61 74 69 6f 6e 20 ck Notification
8e10: 46 65 61 74 75 72 65 5d 20 66 6f 72 20 61 64 64 Feature] for add
8e20: 69 74 69 6f 6e 61 6c 0a 20 20 69 6e 66 6f 72 6d itional. inform
8e30: 61 74 69 6f 6e 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c ation..}..COMPIL
8e40: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
8e50: 5f 53 4f 55 4e 44 45 58 7d 20 7b 0a 20 20 54 68 _SOUNDEX} {. Th
8e60: 69 73 20 6f 70 74 69 6f 6e 20 65 6e 61 62 6c 65 is option enable
8e70: 73 20 74 68 65 20 5b 73 6f 75 6e 64 65 78 28 29 s the [soundex()
8e80: 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 5d 2e 0a SQL function]..
8e90: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
8ea0: 4e 20 7b 53 51 4c 49 54 45 5f 55 53 45 5f 46 43 N {SQLITE_USE_FC
8eb0: 4e 54 4c 5f 54 52 41 43 45 7d 20 7b 0a 20 20 54 NTL_TRACE} {. T
8ec0: 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 75 73 65 his option cause
8ed0: 73 20 53 51 4c 69 74 65 20 74 6f 20 69 73 73 75 s SQLite to issu
8ee0: 65 20 65 78 74 72 61 20 5b 53 51 4c 49 54 45 5f e extra [SQLITE_
8ef0: 46 43 4e 54 4c 5f 54 52 41 43 45 5d 20 66 69 6c FCNTL_TRACE] fil
8f00: 65 20 63 6f 6e 74 72 6f 6c 73 0a 20 20 74 6f 20 e controls. to
8f10: 70 72 6f 76 69 64 65 20 73 75 70 70 6c 65 6d 65 provide suppleme
8f20: 6e 74 61 72 79 20 69 6e 66 6f 72 6d 61 74 69 6f ntary informatio
8f30: 6e 20 74 6f 20 74 68 65 20 56 46 53 2e 20 20 54 n to the VFS. T
8f40: 68 65 20 22 76 66 73 6c 6f 67 2e 63 22 20 65 78 he "vfslog.c" ex
8f50: 74 65 6e 73 69 6f 6e 0a 20 20 6d 61 6b 65 73 20 tension. makes
8f60: 75 73 65 20 6f 66 20 74 68 69 73 20 74 6f 20 70 use of this to p
8f70: 72 6f 76 69 64 65 20 65 6e 68 61 6e 63 65 64 20 rovide enhanced
8f80: 6c 6f 67 73 20 6f 66 20 56 46 53 20 61 63 74 69 logs of VFS acti
8f90: 76 69 74 79 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 vity..}..COMPILE
8fa0: 5f 4f 50 54 49 4f 4e 20 7b 59 59 54 52 41 43 4b _OPTION {YYTRACK
8fb0: 4d 41 58 53 54 41 43 4b 44 45 50 54 48 7d 20 7b MAXSTACKDEPTH} {
8fc0: 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 . This option c
8fd0: 61 75 73 65 73 20 74 68 65 20 4c 41 4c 52 28 31 auses the LALR(1
8fe0: 29 20 70 61 72 73 65 72 20 73 74 61 63 6b 20 64 ) parser stack d
8ff0: 65 70 74 68 20 74 6f 20 62 65 20 74 72 61 63 6b epth to be track
9000: 65 64 0a 20 20 61 6e 64 20 72 65 70 6f 72 74 65 ed. and reporte
9010: 64 20 75 73 69 6e 67 20 74 68 65 20 5b 73 71 6c d using the [sql
9020: 69 74 65 33 5f 73 74 61 74 75 73 5d 28 5b 53 51 ite3_status]([SQ
9030: 4c 49 54 45 5f 53 54 41 54 55 53 5f 50 41 52 53 LITE_STATUS_PARS
9040: 45 52 5f 53 54 41 43 4b 5d 2c 2e 2e 2e 29 0a 20 ER_STACK],...).
9050: 20 69 6e 74 65 72 66 61 63 65 2e 20 20 53 51 4c interface. SQL
9060: 69 74 65 27 73 20 4c 41 4c 52 28 31 29 20 70 61 ite's LALR(1) pa
9070: 72 73 65 72 20 68 61 73 20 61 20 66 69 78 65 64 rser has a fixed
9080: 20 73 74 61 63 6b 20 64 65 70 74 68 0a 20 20 28 stack depth. (
9090: 64 65 74 65 72 6d 69 6e 65 64 20 61 74 20 63 6f determined at co
90a0: 6d 70 69 6c 65 2d 74 69 6d 65 20 75 73 69 6e 67 mpile-time using
90b0: 20 74 68 65 20 5b 59 59 53 54 41 43 4b 44 45 50 the [YYSTACKDEP
90c0: 54 48 5d 20 6f 70 74 69 6f 6e 73 29 2e 0a 20 20 TH] options)..
90d0: 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 6e 20 This option can
90e0: 62 65 20 75 73 65 64 20 74 6f 20 68 65 6c 70 20 be used to help
90f0: 64 65 74 65 72 6d 69 6e 65 20 69 66 20 61 6e 20 determine if an
9100: 61 70 70 6c 69 63 61 74 69 6f 6e 20 69 73 0a 20 application is.
9110: 20 67 65 74 74 69 6e 67 20 63 6c 6f 73 65 20 74 getting close t
9120: 6f 20 65 78 63 65 65 64 69 6e 67 20 74 68 65 20 o exceeding the
9130: 6d 61 78 69 6d 75 6d 20 4c 41 4c 52 28 31 29 20 maximum LALR(1)
9140: 73 74 61 63 6b 20 64 65 70 74 68 2e 0a 7d 0a 3c stack depth..}.<
9150: 2f 74 63 6c 3e 0a 0a 3c 61 20 6e 61 6d 65 3d 22 /tcl>..<a name="
9160: 64 69 73 61 62 6c 65 66 65 61 74 75 72 65 73 22 disablefeatures"
9170: 3e 3c 2f 61 3e 0a 3c 68 32 3e 31 2e 36 20 4f 70 ></a>.<h2>1.6 Op
9180: 74 69 6f 6e 73 20 54 6f 20 44 69 73 61 62 6c 65 tions To Disable
9190: 20 46 65 61 74 75 72 65 73 20 4e 6f 72 6d 61 6c Features Normal
91a0: 6c 79 20 54 75 72 6e 65 64 20 4f 6e 3c 2f 68 32 ly Turned On</h2
91b0: 3e 0a 0a 3c 74 63 6c 3e 0a 43 4f 4d 50 49 4c 45 >..<tcl>.COMPILE
91c0: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
91d0: 44 49 53 41 42 4c 45 5f 4c 46 53 7d 20 7b 0a 20 DISABLE_LFS} {.
91e0: 20 49 66 20 74 68 69 73 20 43 2d 70 72 65 70 72 If this C-prepr
91f0: 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f 20 69 73 ocessor macro is
9200: 20 64 65 66 69 6e 65 64 2c 20 6c 61 72 67 65 20 defined, large
9210: 66 69 6c 65 20 73 75 70 70 6f 72 74 0a 20 20 69 file support. i
9220: 73 20 64 69 73 61 62 6c 65 64 2e 0a 7d 0a 0a 43 s disabled..}..C
9230: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
9240: 51 4c 49 54 45 5f 44 49 53 41 42 4c 45 5f 44 49 QLITE_DISABLE_DI
9250: 52 53 59 4e 43 7d 20 7b 0a 20 20 49 66 20 74 68 RSYNC} {. If th
9260: 69 73 20 43 2d 70 72 65 70 72 6f 63 65 73 73 6f is C-preprocesso
9270: 72 20 6d 61 63 72 6f 20 69 73 20 64 65 66 69 6e r macro is defin
9280: 65 64 2c 20 64 69 72 65 63 74 6f 72 79 20 73 79 ed, directory sy
9290: 6e 63 73 0a 20 20 61 72 65 20 64 69 73 61 62 6c ncs. are disabl
92a0: 65 64 2e 20 20 53 51 4c 69 74 65 20 74 79 70 69 ed. SQLite typi
92b0: 63 61 6c 6c 79 20 61 74 74 65 6d 70 74 73 20 74 cally attempts t
92c0: 6f 20 73 79 6e 63 20 74 68 65 20 70 61 72 65 6e o sync the paren
92d0: 74 0a 20 20 64 69 72 65 63 74 6f 72 79 20 77 68 t. directory wh
92e0: 65 6e 20 61 20 66 69 6c 65 20 69 73 20 64 65 6c en a file is del
92f0: 65 74 65 64 20 74 6f 20 65 6e 73 75 72 65 20 74 eted to ensure t
9300: 68 65 20 64 69 72 65 63 74 6f 72 79 0a 20 20 65 he directory. e
9310: 6e 74 72 69 65 73 20 61 72 65 20 75 70 64 61 74 ntries are updat
9320: 65 64 20 69 6d 6d 65 64 69 61 74 65 6c 79 20 6f ed immediately o
9330: 6e 20 64 69 73 6b 2e 0a 7d 0a 0a 43 4f 4d 50 49 n disk..}..COMPI
9340: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
9350: 45 5f 44 49 53 41 42 4c 45 5f 46 54 53 33 5f 55 E_DISABLE_FTS3_U
9360: 4e 49 43 4f 44 45 7d 20 7b 0a 20 20 49 66 20 74 NICODE} {. If t
9370: 68 69 73 20 43 2d 70 72 65 70 72 6f 63 65 73 73 his C-preprocess
9380: 6f 72 20 6d 61 63 72 6f 20 69 73 20 64 65 66 69 or macro is defi
9390: 6e 65 64 2c 20 74 68 65 20 5b 75 6e 69 63 6f 64 ned, the [unicod
93a0: 65 36 31 5d 20 74 6f 6b 65 6e 69 7a 65 72 0a 20 e61] tokenizer.
93b0: 20 69 6e 20 5b 46 54 53 33 5d 20 69 73 20 6f 6d in [FTS3] is om
93c0: 69 74 74 65 64 20 66 72 6f 6d 20 74 68 65 20 62 itted from the b
93d0: 75 69 6c 64 20 61 6e 64 20 69 73 20 75 6e 61 76 uild and is unav
93e0: 61 69 6c 61 62 6c 65 20 74 6f 20 0a 20 20 61 70 ailable to . ap
93f0: 70 6c 69 63 61 74 69 6f 6e 73 2e 0a 7d 0a 0a 43 plications..}..C
9400: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
9410: 51 4c 49 54 45 5f 44 49 53 41 42 4c 45 5f 46 54 QLITE_DISABLE_FT
9420: 53 34 5f 44 45 46 45 52 52 45 44 7d 20 7b 0a 20 S4_DEFERRED} {.
9430: 20 49 66 20 74 68 69 73 20 43 2d 70 72 65 70 72 If this C-prepr
9440: 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f 20 64 69 ocessor macro di
9450: 73 61 62 6c 65 73 20 74 68 65 20 22 64 65 66 65 sables the "defe
9460: 72 72 65 64 20 74 6f 6b 65 6e 22 20 6f 70 74 69 rred token" opti
9470: 6d 69 7a 61 74 69 6f 6e 0a 20 20 69 6e 20 5b 46 mization. in [F
9480: 54 53 34 5d 2e 20 20 54 68 65 20 22 64 65 66 65 TS4]. The "defe
9490: 72 72 65 64 20 74 6f 6b 65 6e 22 20 6f 70 74 69 rred token" opti
94a0: 6d 69 7a 61 74 69 6f 6e 20 61 76 6f 69 64 73 20 mization avoids
94b0: 6c 6f 61 64 69 6e 67 20 6d 61 73 73 69 76 65 0a loading massive.
94c0: 20 20 70 6f 73 74 69 6e 67 20 6c 69 73 74 73 20 posting lists
94d0: 66 6f 72 20 74 65 72 6d 73 20 74 68 61 74 20 61 for terms that a
94e0: 72 65 20 69 6e 20 6d 6f 73 74 20 64 6f 63 75 6d re in most docum
94f0: 65 6e 74 73 20 6f 66 20 74 68 65 20 63 6f 6c 6c ents of the coll
9500: 65 63 74 69 6f 6e 0a 20 20 61 6e 64 20 69 6e 73 ection. and ins
9510: 74 65 61 64 20 73 69 6d 70 6c 79 20 73 63 61 6e tead simply scan
9520: 73 20 66 6f 72 20 74 68 6f 73 65 20 74 6f 6b 65 s for those toke
9530: 6e 73 20 69 6e 20 74 68 65 20 64 6f 63 75 6d 65 ns in the docume
9540: 6e 74 20 73 6f 75 72 63 65 2e 20 20 5b 46 54 53 nt source. [FTS
9550: 34 5d 0a 20 20 73 68 6f 75 6c 64 20 67 65 74 20 4]. should get
9560: 65 78 61 63 74 6c 79 20 74 68 65 20 73 61 6d 65 exactly the same
9570: 20 61 6e 73 77 65 72 20 62 6f 74 68 20 77 69 74 answer both wit
9580: 68 20 61 6e 64 20 77 69 74 68 6f 75 74 20 74 68 h and without th
9590: 69 73 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e 2e is optimization.
95a0: 0a 7d 0a 3c 2f 74 63 6c 3e 0a 0a 3c 74 63 6c 3e .}.</tcl>..<tcl>
95b0: 0a 20 20 68 64 5f 66 72 61 67 6d 65 6e 74 20 22 . hd_fragment "
95c0: 6f 6d 69 74 66 65 61 74 75 72 65 73 22 0a 20 20 omitfeatures".
95d0: 68 64 5f 6b 65 79 77 6f 72 64 73 20 22 6f 6d 69 hd_keywords "omi
95e0: 74 66 65 61 74 75 72 65 73 22 0a 3c 2f 74 63 6c tfeatures".</tcl
95f0: 3e 0a 3c 68 32 3e 31 2e 37 20 4f 70 74 69 6f 6e >.<h2>1.7 Option
9600: 73 20 54 6f 20 4f 6d 69 74 20 46 65 61 74 75 72 s To Omit Featur
9610: 65 73 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65 20 es</h2>..<p>The
9620: 66 6f 6c 6c 6f 77 69 6e 67 20 6f 70 74 69 6f 6e following option
9630: 73 20 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f s can be used to
9640: 20 0a 5b 72 65 6c 66 6f 6f 74 70 72 69 6e 74 20 .[relfootprint
9650: 7c 20 72 65 64 75 63 65 20 74 68 65 20 73 69 7a | reduce the siz
9660: 65 20 6f 66 20 74 68 65 20 63 6f 6d 70 69 6c 65 e of the compile
9670: 64 20 6c 69 62 72 61 72 79 5d 0a 62 79 20 6f 6d d library].by om
9680: 69 74 74 69 6e 67 20 75 6e 75 73 65 64 20 66 65 itting unused fe
9690: 61 74 75 72 65 73 2e 20 54 68 69 73 20 69 73 20 atures. This is
96a0: 70 72 6f 62 61 62 6c 79 20 6f 6e 6c 79 20 75 73 probably only us
96b0: 65 66 75 6c 0a 69 6e 20 65 6d 62 65 64 64 65 64 eful.in embedded
96c0: 20 73 79 73 74 65 6d 73 20 77 68 65 72 65 20 73 systems where s
96d0: 70 61 63 65 20 69 73 20 65 73 70 65 63 69 61 6c pace is especial
96e0: 6c 79 20 74 69 67 68 74 2c 20 61 73 20 65 76 65 ly tight, as eve
96f0: 6e 20 77 69 74 68 20 61 6c 6c 0a 66 65 61 74 75 n with all.featu
9700: 72 65 73 20 69 6e 63 6c 75 64 65 64 20 74 68 65 res included the
9710: 20 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79 20 SQLite library
9720: 69 73 20 72 65 6c 61 74 69 76 65 6c 79 20 73 6d is relatively sm
9730: 61 6c 6c 2e 20 44 6f 6e 27 74 20 66 6f 72 67 65 all. Don't forge
9740: 74 0a 74 6f 20 74 65 6c 6c 20 79 6f 75 72 20 63 t.to tell your c
9750: 6f 6d 70 69 6c 65 72 20 74 6f 20 6f 70 74 69 6d ompiler to optim
9760: 69 7a 65 20 66 6f 72 20 62 69 6e 61 72 79 20 73 ize for binary s
9770: 69 7a 65 21 20 28 74 68 65 20 2d 4f 73 20 6f 70 ize! (the -Os op
9780: 74 69 6f 6e 20 69 66 0a 75 73 69 6e 67 20 47 43 tion if.using GC
9790: 43 29 2e 20 20 54 65 6c 6c 69 6e 67 20 79 6f 75 C). Telling you
97a0: 72 20 63 6f 6d 70 69 6c 65 72 20 74 6f 20 6f 70 r compiler to op
97b0: 74 69 6d 69 7a 65 20 66 6f 72 20 73 69 7a 65 20 timize for size
97c0: 75 73 75 61 6c 6c 79 20 68 61 73 0a 61 20 6d 75 usually has.a mu
97d0: 63 68 20 6c 61 72 67 65 72 20 69 6d 70 61 63 74 ch larger impact
97e0: 20 6f 6e 20 6c 69 62 72 61 72 79 20 66 6f 6f 74 on library foot
97f0: 70 72 69 6e 74 20 74 68 61 6e 20 65 6d 70 6c 6f print than emplo
9800: 79 69 6e 67 20 61 6e 79 20 6f 66 20 74 68 65 73 ying any of thes
9810: 65 0a 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f e.compile-time o
9820: 70 74 69 6f 6e 73 2e 20 20 59 6f 75 20 73 68 6f ptions. You sho
9830: 75 6c 64 20 61 6c 73 6f 20 76 65 72 69 66 79 20 uld also verify
9840: 74 68 61 74 20 0a 3c 61 20 68 72 65 66 3d 22 23 that .<a href="#
9850: 64 65 62 75 67 6f 70 74 69 6f 6e 73 22 3e 64 65 debugoptions">de
9860: 62 75 67 67 69 6e 67 20 6f 70 74 69 6f 6e 73 3c bugging options<
9870: 2f 61 3e 20 61 72 65 20 64 69 73 61 62 6c 65 64 /a> are disabled
9880: 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 6d 61 .</p>..<p>The ma
9890: 63 72 6f 73 20 69 6e 20 74 68 69 73 20 73 65 63 cros in this sec
98a0: 74 69 6f 6e 20 64 6f 20 6e 6f 74 20 72 65 71 75 tion do not requ
98b0: 69 72 65 20 76 61 6c 75 65 73 2e 20 54 68 65 20 ire values. The
98c0: 66 6f 6c 6c 6f 77 69 6e 67 20 0a 63 6f 6d 70 69 following .compi
98d0: 6c 61 74 69 6f 6e 20 73 77 69 74 63 68 65 73 20 lation switches
98e0: 61 6c 6c 20 68 61 76 65 20 74 68 65 20 73 61 6d all have the sam
98f0: 65 20 65 66 66 65 63 74 3a 3c 62 72 3e 0a 2d 44 e effect:<br>.-D
9900: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 4c 54 45 SQLITE_OMIT_ALTE
9910: 52 54 41 42 4c 45 3c 62 72 3e 0a 2d 44 53 51 4c RTABLE<br>.-DSQL
9920: 49 54 45 5f 4f 4d 49 54 5f 41 4c 54 45 52 54 41 ITE_OMIT_ALTERTA
9930: 42 4c 45 3d 31 3c 62 72 3e 0a 2d 44 53 51 4c 49 BLE=1<br>.-DSQLI
9940: 54 45 5f 4f 4d 49 54 5f 41 4c 54 45 52 54 41 42 TE_OMIT_ALTERTAB
9950: 4c 45 3d 30 0a 3c 2f 70 3e 0a 0a 3c 70 3e 49 66 LE=0.</p>..<p>If
9960: 20 61 6e 79 20 6f 66 20 74 68 65 73 65 20 6f 70 any of these op
9970: 74 69 6f 6e 73 20 61 72 65 20 64 65 66 69 6e 65 tions are define
9980: 64 2c 20 74 68 65 6e 20 74 68 65 20 73 61 6d 65 d, then the same
9990: 20 73 65 74 20 6f 66 20 53 51 4c 49 54 45 5f 4f set of SQLITE_O
99a0: 4d 49 54 5f 2a 0a 6f 70 74 69 6f 6e 73 20 6d 75 MIT_*.options mu
99b0: 73 74 20 61 6c 73 6f 20 62 65 20 64 65 66 69 6e st also be defin
99c0: 65 64 20 77 68 65 6e 20 75 73 69 6e 67 20 74 68 ed when using th
99d0: 65 20 27 6c 65 6d 6f 6e 27 20 74 6f 6f 6c 20 74 e 'lemon' tool t
99e0: 6f 20 67 65 6e 65 72 61 74 65 20 74 68 65 0a 70 o generate the.p
99f0: 61 72 73 65 2e 63 20 66 69 6c 65 20 61 6e 64 20 arse.c file and
9a00: 77 68 65 6e 20 63 6f 6d 70 69 6c 69 6e 67 20 74 when compiling t
9a10: 68 65 20 27 6d 6b 6b 65 79 77 6f 72 64 68 61 73 he 'mkkeywordhas
9a20: 68 27 20 74 6f 6f 6c 20 77 68 69 63 68 20 67 65 h' tool which ge
9a30: 6e 65 72 61 74 65 73 20 0a 74 68 65 20 6b 65 79 nerates .the key
9a40: 77 6f 72 64 68 61 73 68 2e 68 20 66 69 6c 65 2e wordhash.h file.
9a50: 0a 42 65 63 61 75 73 65 20 6f 66 20 74 68 69 73 .Because of this
9a60: 2c 20 74 68 65 73 65 20 6f 70 74 69 6f 6e 73 20 , these options
9a70: 6d 61 79 20 6f 6e 6c 79 20 62 65 20 75 73 65 64 may only be used
9a80: 20 77 68 65 6e 20 74 68 65 20 6c 69 62 72 61 72 when the librar
9a90: 79 20 69 73 20 62 75 69 6c 74 0a 66 72 6f 6d 20 y is built.from
9aa0: 63 61 6e 6f 6e 69 63 61 6c 20 73 6f 75 72 63 65 canonical source
9ab0: 2c 20 6e 6f 74 20 66 72 6f 6d 20 74 68 65 20 5b , not from the [
9ac0: 61 6d 61 6c 67 61 6d 61 74 69 6f 6e 5d 20 6f 72 amalgamation] or
9ad0: 20 66 72 6f 6d 20 74 68 65 20 63 6f 6c 6c 65 63 from the collec
9ae0: 74 69 6f 6e 20 6f 66 0a 70 72 65 2d 70 61 63 6b tion of.pre-pack
9af0: 61 67 65 64 20 43 20 66 69 6c 65 73 20 70 72 6f aged C files pro
9b00: 76 69 64 65 64 20 66 6f 72 20 6e 6f 6e 2d 55 6e vided for non-Un
9b10: 69 78 20 6c 69 6b 65 20 70 6c 61 74 66 6f 72 6d ix like platform
9b20: 73 20 6f 6e 20 74 68 65 20 77 65 62 73 69 74 65 s on the website
9b30: 2e 0a 41 6e 79 20 53 51 4c 49 54 45 5f 4f 4d 49 ..Any SQLITE_OMI
9b40: 54 5f 2a 20 6f 70 74 69 6f 6e 73 20 77 68 69 63 T_* options whic
9b50: 68 20 63 61 6e 20 62 65 20 75 73 65 64 20 64 69 h can be used di
9b60: 72 65 63 74 6c 79 20 77 69 74 68 20 74 68 65 20 rectly with the
9b70: 5b 61 6d 61 6c 67 61 6d 61 74 69 6f 6e 5d 20 0a [amalgamation] .
9b80: 61 72 65 20 6c 69 73 74 65 64 20 62 65 6c 6f 77 are listed below
9b90: 2c 20 68 6f 77 65 76 65 72 2c 20 74 68 65 20 77 , however, the w
9ba0: 61 72 6e 69 6e 67 73 20 69 6e 20 74 68 65 20 66 arnings in the f
9bb0: 6f 6c 6c 6f 77 69 6e 67 20 70 61 72 61 67 72 61 ollowing paragra
9bc0: 70 68 20 73 68 6f 75 6c 64 20 62 65 20 6e 6f 74 ph should be not
9bd0: 65 64 2e 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b ed..</p>..<block
9be0: 71 75 6f 74 65 3e 0a 3c 69 3e 3c 62 3e 49 6d 70 quote>.<i><b>Imp
9bf0: 6f 72 74 61 6e 74 20 4e 6f 74 65 3a 3c 2f 62 3e ortant Note:</b>
9c00: 20 54 68 65 20 53 51 4c 49 54 45 5f 4f 4d 49 54 The SQLITE_OMIT
9c10: 5f 2a 20 6f 70 74 69 6f 6e 73 20 64 6f 20 6e 6f _* options do no
9c20: 74 20 77 6f 72 6b 20 77 69 74 68 20 74 68 65 0a t work with the.
9c30: 5b 61 6d 61 6c 67 61 6d 61 74 69 6f 6e 5d 20 6f [amalgamation] o
9c40: 72 20 77 69 74 68 20 70 72 65 2d 70 61 63 6b 61 r with pre-packa
9c50: 67 65 64 20 43 20 63 6f 64 65 20 66 69 6c 65 73 ged C code files
9c60: 2e 20 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 2a . SQLITE_OMIT_*
9c70: 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 0a 6f 70 compile-time.op
9c80: 74 69 6f 6e 73 20 6f 6e 6c 79 20 77 6f 72 6b 20 tions only work
9c90: 63 6f 72 72 65 63 74 6c 79 20 77 68 65 6e 20 53 correctly when S
9ca0: 51 4c 69 74 65 20 69 73 20 62 75 69 6c 74 20 66 QLite is built f
9cb0: 72 6f 6d 20 63 61 6e 6f 6e 69 63 61 6c 20 73 6f rom canonical so
9cc0: 75 72 63 65 20 66 69 6c 65 73 2e 0a 3c 2f 69 3e urce files..</i>
9cd0: 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a .</blockquote>..
9ce0: 0a 3c 70 3e 53 70 65 63 69 61 6c 20 76 65 72 73 .<p>Special vers
9cf0: 69 6f 6e 73 20 6f 66 20 74 68 65 20 53 51 4c 69 ions of the SQLi
9d00: 74 65 20 61 6d 61 6c 67 61 6d 61 74 69 6f 6e 20 te amalgamation
9d10: 74 68 61 74 20 64 6f 20 77 6f 72 6b 20 77 69 74 that do work wit
9d20: 68 20 61 0a 70 72 65 64 65 74 65 72 6d 69 6e 65 h a.predetermine
9d30: 64 20 73 65 74 20 6f 66 20 53 51 4c 49 54 45 5f d set of SQLITE_
9d40: 4f 4d 49 54 5f 2a 20 6f 70 74 69 6f 6e 73 20 63 OMIT_* options c
9d50: 61 6e 20 62 65 20 67 65 6e 65 72 61 74 65 64 2e an be generated.
9d60: 20 20 54 6f 20 64 6f 20 73 6f 2c 0a 6d 61 6b 65 To do so,.make
9d70: 20 61 20 63 6f 70 79 20 6f 66 20 74 68 65 20 4d a copy of the M
9d80: 61 6b 65 66 69 6c 65 2e 6c 69 6e 75 78 2d 67 63 akefile.linux-gc
9d90: 63 20 6d 61 6b 65 66 69 6c 65 20 74 65 6d 70 6c c makefile templ
9da0: 61 74 65 20 69 6e 20 74 68 65 20 63 61 6e 6f 6e ate in the canon
9db0: 69 63 61 6c 0a 73 6f 75 72 63 65 20 63 6f 64 65 ical.source code
9dc0: 20 64 69 73 74 72 69 62 75 74 69 6f 6e 2e 20 20 distribution.
9dd0: 43 68 61 6e 67 65 20 74 68 65 20 6e 61 6d 65 20 Change the name
9de0: 6f 66 20 79 6f 75 72 20 63 6f 70 79 20 74 6f 20 of your copy to
9df0: 73 69 6d 70 6c 79 20 22 4d 61 6b 65 66 69 6c 65 simply "Makefile
9e00: 22 2e 0a 54 68 65 6e 20 65 64 69 74 20 22 4d 61 "..Then edit "Ma
9e10: 6b 65 66 69 6c 65 22 20 74 6f 20 73 65 74 20 75 kefile" to set u
9e20: 70 20 61 70 70 72 6f 70 72 69 61 74 65 20 63 6f p appropriate co
9e30: 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f mpile-time optio
9e40: 6e 73 2e 20 20 54 68 65 6e 0a 74 79 70 65 3a 0a ns. Then.type:.
9e50: 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 74 74 3e <blockquote><tt>
9e60: 6d 61 6b 65 20 63 6c 65 61 6e 3b 20 6d 61 6b 65 make clean; make
9e70: 20 73 71 6c 69 74 65 33 2e 63 3c 2f 74 74 3e 3c sqlite3.c</tt><
9e80: 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 54 68 65 /blockquote>.The
9e90: 20 72 65 73 75 6c 74 69 6e 67 20 22 73 71 6c 69 resulting "sqli
9ea0: 74 65 33 2e 63 22 20 61 6d 61 6c 67 61 6d 61 74 te3.c" amalgamat
9eb0: 69 6f 6e 20 63 6f 64 65 20 66 69 6c 65 20 28 61 ion code file (a
9ec0: 6e 64 20 69 74 73 20 61 73 73 6f 63 69 61 74 65 nd its associate
9ed0: 64 0a 68 65 61 64 65 72 20 66 69 6c 65 20 22 73 d.header file "s
9ee0: 71 6c 69 74 65 33 2e 68 22 29 20 63 61 6e 20 74 qlite3.h") can t
9ef0: 68 65 6e 20 62 65 20 6d 6f 76 65 64 20 74 6f 20 hen be moved to
9f00: 61 20 6e 6f 6e 2d 75 6e 69 78 20 70 6c 61 74 66 a non-unix platf
9f10: 6f 72 6d 0a 66 6f 72 20 66 69 6e 61 6c 20 63 6f orm.for final co
9f20: 6d 70 69 6c 61 74 69 6f 6e 20 75 73 69 6e 67 20 mpilation using
9f30: 61 20 6e 61 74 69 76 65 20 63 6f 6d 70 69 6c 65 a native compile
9f40: 72 2e 3c 2f 70 3e 0a 0a 3c 70 3e 41 6c 6c 20 6f r.</p>..<p>All o
9f50: 66 20 74 68 65 20 53 51 4c 49 54 45 5f 4f 4d 49 f the SQLITE_OMI
9f60: 54 5f 2a 20 6f 70 74 69 6f 6e 73 20 61 72 65 20 T_* options are
9f70: 75 6e 73 75 70 70 6f 72 74 65 64 2e 3c 2f 70 3e unsupported.</p>
9f80: 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c ..<blockquote>.<
9f90: 69 3e 3c 62 3e 49 6d 70 6f 72 74 61 6e 74 20 4e i><b>Important N
9fa0: 6f 74 65 3a 3c 2f 62 3e 0a 54 68 65 20 53 51 4c ote:</b>.The SQL
9fb0: 49 54 45 5f 4f 4d 49 54 5f 2a 20 63 6f 6d 70 69 ITE_OMIT_* compi
9fc0: 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 73 20 le-time options
9fd0: 61 72 65 20 75 6e 73 75 70 70 6f 72 74 65 64 2e are unsupported.
9fe0: 0a 3c 2f 69 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 .</i></blockquot
9ff0: 65 3e 0a 0a 3c 70 3e 0a 54 68 65 20 53 51 4c 49 e>..<p>.The SQLI
a000: 54 45 5f 4f 4d 49 54 5f 2a 20 63 6f 6d 70 69 6c TE_OMIT_* compil
a010: 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 73 20 61 e-time options a
a020: 72 65 20 75 73 75 61 6c 6c 79 20 75 6e 74 65 73 re usually untes
a030: 74 65 64 20 61 6e 64 0a 61 72 65 20 61 6c 6d 6f ted and.are almo
a040: 73 74 20 63 65 72 74 61 69 6e 6c 79 20 75 6e 74 st certainly unt
a050: 65 73 74 65 64 20 69 6e 20 63 6f 6d 62 69 6e 61 ested in combina
a060: 74 69 6f 6e 2e 0a 41 6e 79 20 6f 72 20 61 6c 6c tion..Any or all
a070: 20 6f 66 20 74 68 65 73 65 20 6f 70 74 69 6f 6e of these option
a080: 73 20 6d 61 79 20 62 65 20 72 65 6d 6f 76 65 64 s may be removed
a090: 20 66 72 6f 6d 20 74 68 65 20 63 6f 64 65 20 69 from the code i
a0a0: 6e 20 66 75 74 75 72 65 20 72 65 6c 65 61 73 65 n future release
a0b0: 73 0a 61 6e 64 20 77 69 74 68 6f 75 74 20 77 61 s.and without wa
a0c0: 72 6e 69 6e 67 2e 20 20 46 6f 72 20 61 6e 79 20 rning. For any
a0d0: 70 61 72 74 69 63 75 6c 61 72 20 72 65 6c 65 61 particular relea
a0e0: 73 65 2c 20 73 6f 6d 65 20 6f 66 20 74 68 65 73 se, some of thes
a0f0: 65 0a 6f 70 74 69 6f 6e 73 20 6d 61 79 20 63 61 e.options may ca
a100: 75 73 65 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 use compile-time
a110: 20 6f 72 20 72 75 6e 2d 74 69 6d 65 20 66 61 69 or run-time fai
a120: 6c 75 72 65 73 2c 20 70 61 72 74 69 63 75 6c 61 lures, particula
a130: 72 6c 79 0a 77 68 65 6e 20 75 73 65 64 20 69 6e rly.when used in
a140: 20 63 6f 6d 62 69 6e 61 74 69 6f 6e 20 77 69 74 combination wit
a150: 68 20 6f 74 68 65 72 20 6f 70 74 69 6f 6e 73 2e h other options.
a160: 3c 2f 70 3e 0a 0a 3c 74 63 6c 3e 0a 43 4f 4d 50 </p>..<tcl>.COMP
a170: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
a180: 54 45 5f 4f 4d 49 54 5f 41 4c 54 45 52 54 41 42 TE_OMIT_ALTERTAB
a190: 4c 45 7d 20 7b 0a 20 20 57 68 65 6e 20 74 68 69 LE} {. When thi
a1a0: 73 20 6f 70 74 69 6f 6e 20 69 73 20 64 65 66 69 s option is defi
a1b0: 6e 65 64 2c 20 74 68 65 20 0a 20 20 5b 41 4c 54 ned, the . [ALT
a1c0: 45 52 20 54 41 42 4c 45 5d 20 63 6f 6d 6d 61 6e ER TABLE] comman
a1d0: 64 20 69 73 20 6e 6f 74 20 69 6e 63 6c 75 64 65 d is not include
a1e0: 64 20 69 6e 20 74 68 65 20 0a 20 20 6c 69 62 72 d in the . libr
a1f0: 61 72 79 2e 20 45 78 65 63 75 74 69 6e 67 20 61 ary. Executing a
a200: 6e 20 5b 41 4c 54 45 52 20 54 41 42 4c 45 5d 20 n [ALTER TABLE]
a210: 73 74 61 74 65 6d 65 6e 74 20 63 61 75 73 65 73 statement causes
a220: 20 61 20 70 61 72 73 65 20 65 72 72 6f 72 2e 0a a parse error..
a230: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
a240: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 N {SQLITE_OMIT_A
a250: 4e 41 4c 59 5a 45 7d 20 7b 0a 20 20 57 68 65 6e NALYZE} {. When
a260: 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 this option is
a270: 64 65 66 69 6e 65 64 2c 20 74 68 65 20 5b 41 4e defined, the [AN
a280: 41 4c 59 5a 45 5d 20 63 6f 6d 6d 61 6e 64 20 69 ALYZE] command i
a290: 73 20 6f 6d 69 74 74 65 64 20 66 72 6f 6d 0a 20 s omitted from.
a2a0: 20 74 68 65 20 62 75 69 6c 64 2e 0a 7d 0a 0a 43 the build..}..C
a2b0: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
a2c0: 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 54 54 41 43 QLITE_OMIT_ATTAC
a2d0: 48 7d 20 7b 0a 20 20 57 68 65 6e 20 74 68 69 73 H} {. When this
a2e0: 20 6f 70 74 69 6f 6e 20 69 73 20 64 65 66 69 6e option is defin
a2f0: 65 64 2c 20 74 68 65 20 5b 41 54 54 41 43 48 5d ed, the [ATTACH]
a300: 20 61 6e 64 20 5b 44 45 54 41 43 48 5d 20 63 6f and [DETACH] co
a310: 6d 6d 61 6e 64 73 20 61 72 65 0a 20 20 6f 6d 69 mmands are. omi
a320: 74 74 65 64 20 66 72 6f 6d 20 74 68 65 20 62 75 tted from the bu
a330: 69 6c 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f ild..}..COMPILE_
a340: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f OPTION {SQLITE_O
a350: 4d 49 54 5f 41 55 54 48 4f 52 49 5a 41 54 49 4f MIT_AUTHORIZATIO
a360: 4e 7d 20 7b 0a 20 20 44 65 66 69 6e 69 6e 67 20 N} {. Defining
a370: 74 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 this option omit
a380: 73 20 74 68 65 20 61 75 74 68 6f 72 69 7a 61 74 s the authorizat
a390: 69 6f 6e 20 63 61 6c 6c 62 61 63 6b 20 66 65 61 ion callback fea
a3a0: 74 75 72 65 20 66 72 6f 6d 20 74 68 65 0a 20 20 ture from the.
a3b0: 6c 69 62 72 61 72 79 2e 20 54 68 65 20 5b 73 71 library. The [sq
a3c0: 6c 69 74 65 33 5f 73 65 74 5f 61 75 74 68 6f 72 lite3_set_author
a3d0: 69 7a 65 72 28 29 5d 20 41 50 49 20 66 75 6e 63 izer()] API func
a3e0: 74 69 6f 6e 20 69 73 20 6e 6f 74 20 70 72 65 73 tion is not pres
a3f0: 65 6e 74 0a 20 20 69 6e 20 74 68 65 20 6c 69 62 ent. in the lib
a400: 72 61 72 79 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 rary..}..COMPILE
a410: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
a420: 4f 4d 49 54 5f 41 55 54 4f 49 4e 43 52 45 4d 45 OMIT_AUTOINCREME
a430: 4e 54 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 NT} {. This opt
a440: 69 6f 6e 20 69 73 20 75 73 65 64 20 74 6f 20 6f ion is used to o
a450: 6d 69 74 20 74 68 65 20 0a 20 20 5b 41 55 54 4f mit the . [AUTO
a460: 49 4e 43 52 45 4d 45 4e 54 5d 20 66 75 6e 63 74 INCREMENT] funct
a470: 69 6f 6e 61 6c 69 74 79 2e 20 57 68 65 6e 20 74 ionality. When t
a480: 68 69 73 20 0a 20 20 69 73 20 6d 61 63 72 6f 20 his . is macro
a490: 69 73 20 64 65 66 69 6e 65 64 2c 20 63 6f 6c 75 is defined, colu
a4a0: 6d 6e 73 20 64 65 63 6c 61 72 65 64 20 61 73 20 mns declared as
a4b0: 0a 20 20 22 5b 49 4e 54 45 47 45 52 20 50 52 49 . "[INTEGER PRI
a4c0: 4d 41 52 59 20 4b 45 59 5d 20 41 55 54 4f 49 4e MARY KEY] AUTOIN
a4d0: 43 52 45 4d 45 4e 54 22 0a 20 20 62 65 68 61 76 CREMENT". behav
a4e0: 65 20 69 6e 20 74 68 65 20 73 61 6d 65 20 77 61 e in the same wa
a4f0: 79 20 61 73 20 63 6f 6c 75 6d 6e 73 20 64 65 63 y as columns dec
a500: 6c 61 72 65 64 20 61 73 20 22 5b 49 4e 54 45 47 lared as "[INTEG
a510: 45 52 20 50 52 49 4d 41 52 59 20 4b 45 59 5d 22 ER PRIMARY KEY]"
a520: 20 77 68 65 6e 20 61 20 0a 20 20 4e 55 4c 4c 20 when a . NULL
a530: 69 73 20 69 6e 73 65 72 74 65 64 2e 20 54 68 65 is inserted. The
a540: 20 73 71 6c 69 74 65 5f 73 65 71 75 65 6e 63 65 sqlite_sequence
a550: 20 73 79 73 74 65 6d 20 74 61 62 6c 65 20 69 73 system table is
a560: 20 6e 65 69 74 68 65 72 20 63 72 65 61 74 65 64 neither created
a570: 2c 20 6e 6f 72 0a 20 20 72 65 73 70 65 63 74 65 , nor. respecte
a580: 64 20 69 66 20 69 74 20 61 6c 72 65 61 64 79 20 d if it already
a590: 65 78 69 73 74 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 exists..}..COMPI
a5a0: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
a5b0: 45 5f 4f 4d 49 54 5f 41 55 54 4f 49 4e 49 54 7d E_OMIT_AUTOINIT}
a5c0: 20 7b 0a 20 20 46 6f 72 20 62 61 63 6b 77 61 72 {. For backwar
a5d0: 64 73 20 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 ds compatibility
a5e0: 20 77 69 74 68 20 6f 6c 64 65 72 20 76 65 72 73 with older vers
a5f0: 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74 65 20 74 ions of SQLite t
a600: 68 61 74 20 6c 61 63 6b 0a 20 20 74 68 65 20 5b hat lack. the [
a610: 73 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 sqlite3_initiali
a620: 7a 65 28 29 5d 20 69 6e 74 65 72 66 61 63 65 2c ze()] interface,
a630: 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 69 6e the [sqlite3_in
a640: 69 74 69 61 6c 69 7a 65 28 29 5d 20 69 6e 74 65 itialize()] inte
a650: 72 66 61 63 65 0a 20 20 69 73 20 63 61 6c 6c 65 rface. is calle
a660: 64 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 d automatically
a670: 75 70 6f 6e 20 65 6e 74 72 79 20 74 6f 20 63 65 upon entry to ce
a680: 72 74 61 69 6e 20 6b 65 79 20 69 6e 74 65 72 66 rtain key interf
a690: 61 63 65 73 20 73 75 63 68 20 61 73 0a 20 20 5b aces such as. [
a6a0: 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 5d 2c sqlite3_open()],
a6b0: 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5f 72 65 [sqlite3_vfs_re
a6c0: 67 69 73 74 65 72 28 29 5d 2c 20 61 6e 64 20 5b gister()], and [
a6d0: 73 71 6c 69 74 65 33 5f 6d 70 72 69 6e 74 66 28 sqlite3_mprintf(
a6e0: 29 5d 2e 0a 20 20 54 68 65 20 6f 76 65 72 68 65 )].. The overhe
a6f0: 61 64 20 6f 66 20 69 6e 76 6f 6b 69 6e 67 20 5b ad of invoking [
a700: 73 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 sqlite3_initiali
a710: 7a 65 28 29 5d 20 61 75 74 6f 6d 61 74 69 63 61 ze()] automatica
a720: 6c 6c 79 20 69 6e 20 74 68 69 73 0a 20 20 77 61 lly in this. wa
a730: 79 20 6d 61 79 20 62 65 20 6f 6d 69 74 74 65 64 y may be omitted
a740: 20 62 79 20 62 75 69 6c 64 69 6e 67 20 53 51 4c by building SQL
a750: 69 74 65 20 77 69 74 68 20 74 68 65 20 53 51 4c ite with the SQL
a760: 49 54 45 5f 4f 4d 49 54 5f 41 55 54 4f 49 4e 49 ITE_OMIT_AUTOINI
a770: 54 0a 20 20 43 2d 70 72 65 70 72 6f 63 65 73 73 T. C-preprocess
a780: 6f 72 20 6d 61 63 72 6f 2e 20 20 57 68 65 6e 20 or macro. When
a790: 62 75 69 6c 74 20 75 73 69 6e 67 20 53 51 4c 49 built using SQLI
a7a0: 54 45 5f 4f 4d 49 54 5f 41 55 54 4f 49 4e 49 54 TE_OMIT_AUTOINIT
a7b0: 2c 20 53 51 4c 69 74 65 0a 20 20 77 69 6c 6c 20 , SQLite. will
a7c0: 6e 6f 74 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c not automaticall
a7d0: 79 20 69 6e 69 74 69 61 6c 69 7a 65 20 69 74 73 y initialize its
a7e0: 65 6c 66 20 61 6e 64 20 74 68 65 20 61 70 70 6c elf and the appl
a7f0: 69 63 61 74 69 6f 6e 20 69 73 20 72 65 71 75 69 ication is requi
a800: 72 65 64 0a 20 20 74 6f 20 69 6e 76 6f 6b 65 20 red. to invoke
a810: 5b 73 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c [sqlite3_initial
a820: 69 7a 65 28 29 5d 20 64 69 72 65 63 74 6c 79 20 ize()] directly
a830: 70 72 69 6f 72 20 74 6f 20 62 65 67 69 6e 6e 69 prior to beginni
a840: 6e 67 20 75 73 65 20 6f 66 20 74 68 65 0a 20 20 ng use of the.
a850: 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79 2e 0a SQLite library..
a860: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
a870: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 N {SQLITE_OMIT_A
a880: 55 54 4f 4d 41 54 49 43 5f 49 4e 44 45 58 7d 20 UTOMATIC_INDEX}
a890: 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 {. This option
a8a0: 69 73 20 75 73 65 64 20 74 6f 20 6f 6d 69 74 20 is used to omit
a8b0: 74 68 65 20 0a 20 20 5b 61 75 74 6f 6d 61 74 69 the . [automati
a8c0: 63 20 69 6e 64 65 78 69 6e 67 5d 20 66 75 6e 63 c indexing] func
a8d0: 74 69 6f 6e 61 6c 69 74 79 2e 0a 20 20 53 65 65 tionality.. See
a8e0: 20 61 6c 73 6f 3a 20 5b 53 51 4c 49 54 45 5f 44 also: [SQLITE_D
a8f0: 45 46 41 55 4c 54 5f 41 55 54 4f 4d 41 54 49 43 EFAULT_AUTOMATIC
a900: 5f 49 4e 44 45 58 5d 2e 0a 7d 0a 0a 43 4f 4d 50 _INDEX]..}..COMP
a910: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
a920: 54 45 5f 4f 4d 49 54 5f 41 55 54 4f 52 45 53 45 TE_OMIT_AUTORESE
a930: 54 7d 20 7b 0a 20 20 42 79 20 64 65 66 61 75 6c T} {. By defaul
a940: 74 2c 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f t, the [sqlite3_
a950: 73 74 65 70 28 29 5d 20 69 6e 74 65 72 66 61 63 step()] interfac
a960: 65 20 77 69 6c 6c 20 61 75 74 6f 6d 61 74 69 63 e will automatic
a970: 61 6c 6c 79 20 69 6e 76 6f 6b 65 0a 20 20 5b 73 ally invoke. [s
a980: 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20 qlite3_reset()]
a990: 74 6f 20 72 65 73 65 74 20 74 68 65 20 5b 70 72 to reset the [pr
a9a0: 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 epared statement
a9b0: 5d 20 69 66 20 6e 65 63 65 73 73 61 72 79 2e 20 ] if necessary.
a9c0: 20 54 68 69 73 0a 20 20 63 6f 6d 70 69 6c 65 2d This. compile-
a9d0: 74 69 6d 65 20 6f 70 74 69 6f 6e 20 63 68 61 6e time option chan
a9e0: 67 65 73 20 74 68 61 74 20 62 65 68 61 76 69 6f ges that behavio
a9f0: 72 20 73 6f 20 74 68 61 74 20 5b 73 71 6c 69 74 r so that [sqlit
aa00: 65 33 5f 73 74 65 70 28 29 5d 20 77 69 6c 6c 0a e3_step()] will.
aa10: 20 20 72 65 74 75 72 6e 20 5b 53 51 4c 49 54 45 return [SQLITE
aa20: 5f 4d 49 53 55 53 45 5d 20 69 66 20 69 74 20 63 _MISUSE] if it c
aa30: 61 6c 6c 65 64 20 61 67 61 69 6e 20 61 66 74 65 alled again afte
aa40: 72 20 72 65 74 75 72 6e 69 6e 67 20 61 6e 79 74 r returning anyt
aa50: 68 69 6e 67 20 6f 74 68 65 72 0a 20 20 74 68 61 hing other. tha
aa60: 6e 20 5b 53 51 4c 49 54 45 5f 52 4f 57 5d 2c 20 n [SQLITE_ROW],
aa70: 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d 2c 20 6f [SQLITE_BUSY], o
aa80: 72 20 5b 53 51 4c 49 54 45 5f 4c 4f 43 4b 45 44 r [SQLITE_LOCKED
aa90: 5d 20 75 6e 6c 65 73 73 20 74 68 65 72 65 20 77 ] unless there w
aaa0: 61 73 20 61 6e 0a 20 20 69 6e 74 65 72 76 65 6e as an. interven
aab0: 69 6e 67 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c ing call to [sql
aac0: 69 74 65 33 5f 72 65 73 65 74 28 29 5d 2e 0a 0a ite3_reset()]...
aad0: 20 20 49 6e 20 53 51 4c 69 74 65 20 76 65 72 73 In SQLite vers
aae0: 69 6f 6e 20 33 2e 36 2e 32 33 2e 31 20 61 6e 64 ion 3.6.23.1 and
aaf0: 20 65 61 72 6c 69 65 72 2c 20 5b 73 71 6c 69 74 earlier, [sqlit
ab00: 65 33 5f 73 74 65 70 28 29 5d 20 75 73 65 64 20 e3_step()] used
ab10: 74 6f 20 61 6c 77 61 79 73 0a 20 20 72 65 74 75 to always. retu
ab20: 72 6e 20 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53 rn [SQLITE_MISUS
ab30: 45 5d 20 69 66 20 69 74 20 77 61 73 20 69 6e 76 E] if it was inv
ab40: 6f 6b 65 64 20 61 67 61 69 6e 20 61 66 74 65 72 oked again after
ab50: 20 72 65 74 75 72 6e 69 6e 67 20 61 6e 79 74 68 returning anyth
ab60: 69 6e 67 0a 20 20 6f 74 68 65 72 20 74 68 61 6e ing. other than
ab70: 20 5b 53 51 4c 49 54 45 5f 52 4f 57 5d 20 77 69 [SQLITE_ROW] wi
ab80: 74 68 6f 75 74 20 61 6e 20 69 6e 74 65 72 76 65 thout an interve
ab90: 6e 69 6e 67 20 63 61 6c 6c 20 74 6f 20 5b 73 71 ning call to [sq
aba0: 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d 2e 0a lite3_reset()]..
abb0: 20 20 54 68 69 73 20 63 61 75 73 65 64 20 70 72 This caused pr
abc0: 6f 62 6c 65 6d 73 20 6f 6e 20 73 6f 6d 65 20 70 oblems on some p
abd0: 6f 6f 72 6c 79 20 77 72 69 74 74 65 6e 20 73 6d oorly written sm
abe0: 61 72 74 70 68 6f 6e 65 20 61 70 70 6c 69 63 61 artphone applica
abf0: 74 69 6f 6e 73 20 77 68 69 63 68 0a 20 20 64 69 tions which. di
ac00: 64 20 6e 6f 74 20 63 6f 72 72 65 63 74 6c 79 20 d not correctly
ac10: 68 61 6e 64 6c 65 20 74 68 65 20 5b 53 51 4c 49 handle the [SQLI
ac20: 54 45 5f 4c 4f 43 4b 45 44 5d 20 61 6e 64 20 5b TE_LOCKED] and [
ac30: 53 51 4c 49 54 45 5f 42 55 53 59 5d 20 65 72 72 SQLITE_BUSY] err
ac40: 6f 72 20 0a 20 20 72 65 74 75 72 6e 73 2e 20 20 or . returns.
ac50: 52 61 74 68 65 72 20 74 68 61 6e 20 66 69 78 20 Rather than fix
ac60: 74 68 65 20 6d 61 6e 79 20 64 65 66 65 63 74 69 the many defecti
ac70: 76 65 20 73 6d 61 72 74 70 68 6f 6e 65 20 61 70 ve smartphone ap
ac80: 70 6c 69 63 61 74 69 6f 6e 73 2c 20 0a 20 20 74 plications, . t
ac90: 68 65 20 62 65 68 61 76 69 6f 72 20 6f 66 20 53 he behavior of S
aca0: 51 4c 69 74 65 20 77 61 73 20 63 68 61 6e 67 65 QLite was change
acb0: 64 20 69 6e 20 33 2e 36 2e 32 33 2e 32 20 74 6f d in 3.6.23.2 to
acc0: 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 72 automatically r
acd0: 65 73 65 74 0a 20 20 74 68 65 20 70 72 65 70 61 eset. the prepa
ace0: 72 65 64 20 73 74 61 74 65 6d 65 6e 74 2e 20 20 red statement.
acf0: 42 75 74 20 74 68 61 74 20 63 68 61 6e 67 65 64 But that changed
ad00: 20 63 61 75 73 65 64 20 69 73 73 75 65 73 20 69 caused issues i
ad10: 6e 20 6f 74 68 65 72 20 0a 20 20 69 6d 70 72 6f n other . impro
ad20: 70 65 72 6c 79 20 69 6d 70 6c 65 6d 65 6e 74 65 perly implemente
ad30: 64 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 74 d applications t
ad40: 68 61 74 20 77 65 72 65 20 61 63 74 75 61 6c 6c hat were actuall
ad50: 79 20 6c 6f 6f 6b 69 6e 67 0a 20 20 66 6f 72 20 y looking. for
ad60: 61 6e 20 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53 an [SQLITE_MISUS
ad70: 45 5d 20 72 65 74 75 72 6e 20 74 6f 20 74 65 72 E] return to ter
ad80: 6d 69 6e 61 74 65 20 74 68 65 69 72 20 71 75 65 minate their que
ad90: 72 79 20 6c 6f 6f 70 73 2e 20 20 28 41 6e 79 74 ry loops. (Anyt
ada0: 69 6d 65 0a 20 20 61 6e 20 61 70 70 6c 69 63 61 ime. an applica
adb0: 74 69 6f 6e 20 67 65 74 73 20 61 6e 20 53 51 4c tion gets an SQL
adc0: 49 54 45 5f 4d 49 53 55 53 45 20 65 72 72 6f 72 ITE_MISUSE error
add0: 20 63 6f 64 65 20 66 72 6f 6d 20 53 51 4c 69 74 code from SQLit
ade0: 65 2c 20 74 68 61 74 20 6d 65 61 6e 73 20 74 68 e, that means th
adf0: 65 0a 20 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 e. application
ae00: 69 73 20 6d 69 73 75 73 69 6e 67 20 74 68 65 20 is misusing the
ae10: 53 51 4c 69 74 65 20 69 6e 74 65 72 66 61 63 65 SQLite interface
ae20: 20 61 6e 64 20 69 73 20 74 68 75 73 20 69 6e 63 and is thus inc
ae30: 6f 72 72 65 63 74 6c 79 0a 20 20 69 6d 70 6c 65 orrectly. imple
ae40: 6d 65 6e 74 65 64 2e 29 20 20 54 68 65 20 53 51 mented.) The SQ
ae50: 4c 49 54 45 5f 4f 4d 49 54 5f 41 55 54 4f 52 45 LITE_OMIT_AUTORE
ae60: 53 45 54 20 69 6e 74 65 72 66 61 63 65 20 77 61 SET interface wa
ae70: 73 20 61 64 64 65 64 20 74 6f 20 53 51 4c 69 74 s added to SQLit
ae80: 65 0a 20 20 76 65 72 73 69 6f 6e 20 33 2e 37 2e e. version 3.7.
ae90: 35 20 69 6e 20 61 6e 20 65 66 66 6f 72 74 20 74 5 in an effort t
aea0: 6f 20 67 65 74 20 61 6c 6c 20 6f 66 20 74 68 65 o get all of the
aeb0: 20 28 62 72 6f 6b 65 6e 29 0a 20 20 61 70 70 6c (broken). appl
aec0: 69 63 61 74 69 6f 6e 73 20 74 6f 20 77 6f 72 6b ications to work
aed0: 20 61 67 61 69 6e 20 77 69 74 68 6f 75 74 20 68 again without h
aee0: 61 76 69 6e 67 20 74 6f 20 61 63 74 75 61 6c 6c aving to actuall
aef0: 79 20 66 69 78 20 74 68 65 20 61 70 70 6c 69 63 y fix the applic
af00: 61 74 69 6f 6e 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 ations..}..COMPI
af10: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
af20: 45 5f 4f 4d 49 54 5f 41 55 54 4f 56 41 43 55 55 E_OMIT_AUTOVACUU
af30: 4d 7d 20 7b 0a 20 20 49 66 20 74 68 69 73 20 6f M} {. If this o
af40: 70 74 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 ption is defined
af50: 2c 20 74 68 65 20 6c 69 62 72 61 72 79 20 63 61 , the library ca
af60: 6e 6e 6f 74 20 63 72 65 61 74 65 20 6f 72 20 77 nnot create or w
af70: 72 69 74 65 20 74 6f 20 0a 20 20 64 61 74 61 62 rite to . datab
af80: 61 73 65 73 20 74 68 61 74 20 73 75 70 70 6f 72 ases that suppor
af90: 74 20 5b 61 75 74 6f 5f 76 61 63 75 75 6d 5d 2e t [auto_vacuum].
afa0: 0a 20 20 45 78 65 63 75 74 69 6e 67 20 61 20 5b . Executing a [
afb0: 50 52 41 47 4d 41 20 61 75 74 6f 5f 76 61 63 75 PRAGMA auto_vacu
afc0: 75 6d 5d 20 73 74 61 74 65 6d 65 6e 74 20 69 73 um] statement is
afd0: 20 6e 6f 74 20 61 6e 20 65 72 72 6f 72 0a 20 20 not an error.
afe0: 28 73 69 6e 63 65 20 75 6e 6b 6e 6f 77 6e 20 50 (since unknown P
aff0: 52 41 47 4d 41 73 20 61 72 65 20 73 69 6c 65 6e RAGMAs are silen
b000: 74 6c 79 20 69 67 6e 6f 72 65 64 29 2c 20 62 75 tly ignored), bu
b010: 74 20 64 6f 65 73 20 6e 6f 74 20 72 65 74 75 72 t does not retur
b020: 6e 20 61 20 76 61 6c 75 65 0a 20 20 6f 72 20 6d n a value. or m
b030: 6f 64 69 66 79 20 74 68 65 20 61 75 74 6f 2d 76 odify the auto-v
b040: 61 63 75 75 6d 20 66 6c 61 67 20 69 6e 20 74 68 acuum flag in th
b050: 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 2e e database file.
b060: 20 49 66 20 61 20 64 61 74 61 62 61 73 65 20 74 If a database t
b070: 68 61 74 0a 20 20 73 75 70 70 6f 72 74 73 20 61 hat. supports a
b080: 75 74 6f 2d 76 61 63 75 75 6d 20 69 73 20 6f 70 uto-vacuum is op
b090: 65 6e 65 64 20 62 79 20 61 20 6c 69 62 72 61 72 ened by a librar
b0a0: 79 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 y compiled with
b0b0: 74 68 69 73 20 6f 70 74 69 6f 6e 2c 20 69 74 0a this option, it.
b0c0: 20 20 69 73 20 61 75 74 6f 6d 61 74 69 63 61 6c is automatical
b0d0: 6c 79 20 6f 70 65 6e 65 64 20 69 6e 20 72 65 61 ly opened in rea
b0e0: 64 2d 6f 6e 6c 79 20 6d 6f 64 65 2e 0a 7d 0a 0a d-only mode..}..
b0f0: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
b100: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 42 45 54 57 SQLITE_OMIT_BETW
b110: 45 45 4e 5f 4f 50 54 49 4d 49 5a 41 54 49 4f 4e EEN_OPTIMIZATION
b120: 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f } {. This optio
b130: 6e 20 64 69 73 61 62 6c 65 73 20 74 68 65 20 75 n disables the u
b140: 73 65 20 6f 66 20 69 6e 64 69 63 65 73 20 77 69 se of indices wi
b150: 74 68 20 57 48 45 52 45 20 63 6c 61 75 73 65 20 th WHERE clause
b160: 74 65 72 6d 73 0a 20 20 74 68 61 74 20 65 6d 70 terms. that emp
b170: 6c 6f 79 20 74 68 65 20 42 45 54 57 45 45 4e 20 loy the BETWEEN
b180: 6f 70 65 72 61 74 6f 72 2e 0a 7d 0a 0a 43 4f 4d operator..}..COM
b190: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c PILE_OPTION {SQL
b1a0: 49 54 45 5f 4f 4d 49 54 5f 42 4c 4f 42 5f 4c 49 ITE_OMIT_BLOB_LI
b1b0: 54 45 52 41 4c 7d 20 7b 0a 20 20 57 68 65 6e 20 TERAL} {. When
b1c0: 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 64 this option is d
b1d0: 65 66 69 6e 65 64 2c 20 69 74 20 69 73 20 6e 6f efined, it is no
b1e0: 74 20 70 6f 73 73 69 62 6c 65 20 74 6f 20 73 70 t possible to sp
b1f0: 65 63 69 66 79 20 61 20 62 6c 6f 62 20 69 6e 0a ecify a blob in.
b200: 20 20 61 6e 20 53 51 4c 20 73 74 61 74 65 6d 65 an SQL stateme
b210: 6e 74 20 75 73 69 6e 67 20 74 68 65 20 58 27 41 nt using the X'A
b220: 42 43 44 27 20 73 79 6e 74 61 78 2e 0a 7d 0a 0a BCD' syntax..}..
b230: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
b240: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 42 54 52 45 SQLITE_OMIT_BTRE
b250: 45 43 4f 55 4e 54 7d 20 7b 0a 20 20 57 68 65 6e ECOUNT} {. When
b260: 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 this option is
b270: 64 65 66 69 6e 65 64 2c 20 61 6e 20 6f 70 74 69 defined, an opti
b280: 6d 69 7a 61 74 69 6f 6e 20 74 68 61 74 20 61 63 mization that ac
b290: 63 65 6c 65 72 61 74 65 73 20 63 6f 75 6e 74 69 celerates counti
b2a0: 6e 67 0a 20 20 61 6c 6c 20 65 6e 74 72 69 65 73 ng. all entries
b2b0: 20 69 6e 20 61 20 74 61 62 6c 65 20 28 69 6e 20 in a table (in
b2c0: 6f 74 68 65 72 20 77 6f 72 64 73 2c 20 61 6e 20 other words, an
b2d0: 6f 70 74 69 6d 69 7a 61 74 69 6f 6e 20 74 68 61 optimization tha
b2e0: 74 20 68 65 6c 70 73 0a 20 20 22 53 45 4c 45 43 t helps. "SELEC
b2f0: 54 20 63 6f 75 6e 74 28 2a 29 20 46 52 4f 4d 20 T count(*) FROM
b300: 74 61 62 6c 65 22 20 72 75 6e 20 66 61 73 74 65 table" run faste
b310: 72 29 20 69 73 20 6f 6d 69 74 74 65 64 2e 0a 7d r) is omitted..}
b320: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
b330: 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 42 55 {SQLITE_OMIT_BU
b340: 49 4c 54 49 4e 5f 54 45 53 54 7d 20 7b 0a 20 20 ILTIN_TEST} {.
b350: 41 20 73 74 61 6e 64 61 72 64 20 53 51 4c 69 74 A standard SQLit
b360: 65 20 62 75 69 6c 64 20 69 6e 63 6c 75 64 65 73 e build includes
b370: 20 61 20 73 6d 61 6c 6c 20 61 6d 6f 75 6e 74 20 a small amount
b380: 6f 66 20 6c 6f 67 69 63 20 63 6f 6e 74 72 6f 6c of logic control
b390: 6c 65 64 0a 20 20 62 79 20 74 68 65 20 5b 73 71 led. by the [sq
b3a0: 6c 69 74 65 33 5f 74 65 73 74 5f 63 6f 6e 74 72 lite3_test_contr
b3b0: 6f 6c 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 ol()] interface
b3c0: 74 68 61 74 20 69 73 20 75 73 65 64 20 74 6f 20 that is used to
b3d0: 65 78 65 72 63 69 73 65 0a 20 20 70 61 72 74 73 exercise. parts
b3e0: 20 6f 66 20 74 68 65 20 53 51 4c 69 74 65 20 63 of the SQLite c
b3f0: 6f 72 65 20 74 68 61 74 20 61 72 65 20 64 69 66 ore that are dif
b400: 66 69 63 75 6c 74 20 74 6f 20 63 6f 6e 74 72 6f ficult to contro
b410: 6c 20 61 6e 64 20 6d 65 61 73 75 72 65 20 75 73 l and measure us
b420: 69 6e 67 0a 20 20 74 68 65 20 73 74 61 6e 64 61 ing. the standa
b430: 72 64 20 41 50 49 2e 20 20 54 68 69 73 20 6f 70 rd API. This op
b440: 74 69 6f 6e 20 6f 6d 69 74 73 20 74 68 61 74 20 tion omits that
b450: 62 75 69 6c 74 2d 69 6e 20 74 65 73 74 20 6c 6f built-in test lo
b460: 67 69 63 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f gic..}..COMPILE_
b470: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f OPTION {SQLITE_O
b480: 4d 49 54 5f 43 41 53 54 7d 20 7b 0a 20 20 54 68 MIT_CAST} {. Th
b490: 69 73 20 6f 70 74 69 6f 6e 20 63 61 75 73 65 73 is option causes
b4a0: 20 53 51 4c 69 74 65 20 74 6f 20 6f 6d 69 74 20 SQLite to omit
b4b0: 73 75 70 70 6f 72 74 20 66 6f 72 20 74 68 65 20 support for the
b4c0: 43 41 53 54 20 6f 70 65 72 61 74 6f 72 2e 0a 7d CAST operator..}
b4d0: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
b4e0: 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 43 48 {SQLITE_OMIT_CH
b4f0: 45 43 4b 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 ECK} {. This op
b500: 74 69 6f 6e 20 63 61 75 73 65 73 20 53 51 4c 69 tion causes SQLi
b510: 74 65 20 74 6f 20 6f 6d 69 74 20 73 75 70 70 6f te to omit suppo
b520: 72 74 20 66 6f 72 20 43 48 45 43 4b 20 63 6f 6e rt for CHECK con
b530: 73 74 72 61 69 6e 74 73 2e 0a 20 20 54 68 65 20 straints.. The
b540: 70 61 72 73 65 72 20 77 69 6c 6c 20 73 74 69 6c parser will stil
b550: 6c 20 61 63 63 65 70 74 20 43 48 45 43 4b 20 63 l accept CHECK c
b560: 6f 6e 73 74 72 61 69 6e 74 73 20 69 6e 20 53 51 onstraints in SQ
b570: 4c 20 73 74 61 74 65 6d 65 6e 74 73 2c 0a 20 20 L statements,.
b580: 74 68 65 79 20 77 69 6c 6c 20 6a 75 73 74 20 6e they will just n
b590: 6f 74 20 62 65 20 65 6e 66 6f 72 63 65 64 2e 0a ot be enforced..
b5a0: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
b5b0: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 43 N {SQLITE_OMIT_C
b5c0: 4f 4d 50 49 4c 45 4f 50 54 49 4f 4e 5f 44 49 41 OMPILEOPTION_DIA
b5d0: 47 53 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 GS} {. This opt
b5e0: 69 6f 6e 20 69 73 20 75 73 65 64 20 74 6f 20 6f ion is used to o
b5f0: 6d 69 74 20 74 68 65 20 63 6f 6d 70 69 6c 65 2d mit the compile-
b600: 74 69 6d 65 20 6f 70 74 69 6f 6e 20 64 69 61 67 time option diag
b610: 6e 6f 73 74 69 63 73 20 61 76 61 69 6c 61 62 6c nostics availabl
b620: 65 0a 20 20 69 6e 20 53 51 4c 69 74 65 2c 20 69 e. in SQLite, i
b630: 6e 63 6c 75 64 69 6e 67 20 74 68 65 20 5b 73 71 ncluding the [sq
b640: 6c 69 74 65 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 lite3_compileopt
b650: 69 6f 6e 5f 75 73 65 64 28 29 5d 20 61 6e 64 0a ion_used()] and.
b660: 20 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6d 70 69 [sqlite3_compi
b670: 6c 65 6f 70 74 69 6f 6e 5f 67 65 74 28 29 5d 20 leoption_get()]
b680: 43 2f 43 2b 2b 20 66 75 6e 63 74 69 6f 6e 73 2c C/C++ functions,
b690: 20 74 68 65 0a 20 20 5b 73 71 6c 69 74 65 5f 63 the. [sqlite_c
b6a0: 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 75 73 65 ompileoption_use
b6b0: 64 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 d()] and [sqlite
b6c0: 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 67 _compileoption_g
b6d0: 65 74 28 29 5d 20 53 51 4c 20 66 75 6e 63 74 69 et()] SQL functi
b6e0: 6f 6e 73 2c 0a 20 20 61 6e 64 20 74 68 65 20 5b ons,. and the [
b6f0: 63 6f 6d 70 69 6c 65 5f 6f 70 74 69 6f 6e 73 20 compile_options
b700: 70 72 61 67 6d 61 5d 2e 0a 7d 0a 0a 43 4f 4d 50 pragma]..}..COMP
b710: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
b720: 54 45 5f 4f 4d 49 54 5f 43 4f 4d 50 4c 45 54 45 TE_OMIT_COMPLETE
b730: 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f } {. This optio
b740: 6e 20 63 61 75 73 65 73 20 74 68 65 20 5b 73 71 n causes the [sq
b750: 6c 69 74 65 33 5f 63 6f 6d 70 6c 65 74 65 28 29 lite3_complete()
b760: 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 63 ] and [sqlite3_c
b770: 6f 6d 70 6c 65 74 65 31 36 28 29 5d 0a 20 20 69 omplete16()]. i
b780: 6e 74 65 72 66 61 63 65 73 20 74 6f 20 62 65 20 nterfaces to be
b790: 6f 6d 69 74 74 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 omitted..}..COMP
b7a0: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
b7b0: 54 45 5f 4f 4d 49 54 5f 43 4f 4d 50 4f 55 4e 44 TE_OMIT_COMPOUND
b7c0: 5f 53 45 4c 45 43 54 7d 20 7b 0a 20 20 54 68 69 _SELECT} {. Thi
b7d0: 73 20 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 s option is used
b7e0: 20 74 6f 20 6f 6d 69 74 20 74 68 65 20 63 6f 6d to omit the com
b7f0: 70 6f 75 6e 64 20 5b 53 45 4c 45 43 54 5d 20 66 pound [SELECT] f
b800: 75 6e 63 74 69 6f 6e 61 6c 69 74 79 2e 20 0a 20 unctionality. .
b810: 20 5b 53 45 4c 45 43 54 5d 20 73 74 61 74 65 6d [SELECT] statem
b820: 65 6e 74 73 20 74 68 61 74 20 75 73 65 20 74 68 ents that use th
b830: 65 20 0a 20 20 55 4e 49 4f 4e 2c 20 55 4e 49 4f e . UNION, UNIO
b840: 4e 20 41 4c 4c 2c 20 49 4e 54 45 52 53 45 43 54 N ALL, INTERSECT
b850: 20 6f 72 20 45 58 43 45 50 54 20 63 6f 6d 70 6f or EXCEPT compo
b860: 75 6e 64 20 53 45 4c 45 43 54 20 6f 70 65 72 61 und SELECT opera
b870: 74 6f 72 73 20 77 69 6c 6c 20 0a 20 20 63 61 75 tors will . cau
b880: 73 65 20 61 20 70 61 72 73 65 20 65 72 72 6f 72 se a parse error
b890: 2e 0a 0a 20 20 41 6e 20 5b 49 4e 53 45 52 54 5d ... An [INSERT]
b8a0: 20 73 74 61 74 65 6d 65 6e 74 20 77 69 74 68 20 statement with
b8b0: 6d 75 6c 74 69 70 6c 65 20 76 61 6c 75 65 73 20 multiple values
b8c0: 69 6e 20 74 68 65 20 56 41 4c 55 45 53 20 63 6c in the VALUES cl
b8d0: 61 75 73 65 20 69 73 0a 20 20 69 6d 70 6c 65 6d ause is. implem
b8e0: 65 6e 74 65 64 20 69 6e 74 65 72 6e 61 6c 6c 79 ented internally
b8f0: 20 61 73 20 61 20 63 6f 6d 70 6f 75 6e 64 20 53 as a compound S
b900: 45 4c 45 43 54 2e 20 20 48 65 6e 63 65 2c 20 74 ELECT. Hence, t
b910: 68 69 73 20 6f 70 74 69 6f 6e 20 61 6c 73 6f 0a his option also.
b920: 20 20 64 69 73 61 62 6c 65 73 20 74 68 65 20 61 disables the a
b930: 62 69 6c 69 74 79 20 74 6f 20 69 6e 73 65 72 74 bility to insert
b940: 20 6d 6f 72 65 20 74 68 61 6e 20 61 20 73 69 6e more than a sin
b950: 67 6c 65 20 72 6f 77 20 75 73 69 6e 67 20 61 6e gle row using an
b960: 0a 20 20 49 4e 53 45 52 54 20 49 4e 54 4f 20 2e . INSERT INTO .
b970: 2e 2e 20 56 41 4c 55 45 53 20 2e 2e 2e 20 73 74 .. VALUES ... st
b980: 61 74 65 6d 65 6e 74 2e 0a 7d 0a 0a 43 4f 4d 50 atement..}..COMP
b990: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
b9a0: 54 45 5f 4f 4d 49 54 5f 43 54 45 7d 20 7b 0a 20 TE_OMIT_CTE} {.
b9b0: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 75 This option cau
b9c0: 73 65 73 20 73 75 70 70 6f 72 74 20 66 6f 72 20 ses support for
b9d0: 5b 63 6f 6d 6d 6f 6e 20 74 61 62 6c 65 20 65 78 [common table ex
b9e0: 70 72 65 73 73 69 6f 6e 73 5d 20 74 6f 20 62 65 pressions] to be
b9f0: 20 6f 6d 69 74 74 65 64 2e 0a 7d 0a 0a 0a 0a 43 omitted..}....C
ba00: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
ba10: 51 4c 49 54 45 5f 4f 4d 49 54 5f 44 41 54 45 54 QLITE_OMIT_DATET
ba20: 49 4d 45 5f 46 55 4e 43 53 7d 20 7b 0a 20 20 49 IME_FUNCS} {. I
ba30: 66 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 f this option is
ba40: 20 64 65 66 69 6e 65 64 2c 20 53 51 4c 69 74 65 defined, SQLite
ba50: 27 73 20 62 75 69 6c 74 2d 69 6e 20 64 61 74 65 's built-in date
ba60: 20 61 6e 64 20 74 69 6d 65 20 6d 61 6e 69 70 75 and time manipu
ba70: 6c 61 74 69 6f 6e 0a 20 20 66 75 6e 63 74 69 6f lation. functio
ba80: 6e 73 20 61 72 65 20 6f 6d 69 74 74 65 64 2e 20 ns are omitted.
ba90: 53 70 65 63 69 66 69 63 61 6c 6c 79 2c 20 74 68 Specifically, th
baa0: 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20 e SQL functions
bab0: 6a 75 6c 69 61 6e 64 61 79 28 29 2c 20 64 61 74 julianday(), dat
bac0: 65 28 29 2c 0a 20 20 74 69 6d 65 28 29 2c 20 64 e(),. time(), d
bad0: 61 74 65 74 69 6d 65 28 29 20 61 6e 64 20 73 74 atetime() and st
bae0: 72 66 74 69 6d 65 28 29 20 61 72 65 20 6e 6f 74 rftime() are not
baf0: 20 61 76 61 69 6c 61 62 6c 65 2e 20 54 68 65 20 available. The
bb00: 64 65 66 61 75 6c 74 20 63 6f 6c 75 6d 6e 0a 20 default column.
bb10: 20 76 61 6c 75 65 73 20 43 55 52 52 45 4e 54 5f values CURRENT_
bb20: 54 49 4d 45 2c 20 43 55 52 52 45 4e 54 5f 44 41 TIME, CURRENT_DA
bb30: 54 45 20 61 6e 64 20 43 55 52 52 45 4e 54 5f 54 TE and CURRENT_T
bb40: 49 4d 45 53 54 41 4d 50 20 61 72 65 20 73 74 69 IMESTAMP are sti
bb50: 6c 6c 20 61 76 61 69 6c 61 62 6c 65 2e 0a 7d 0a ll available..}.
bb60: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
bb70: 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 44 45 43 {SQLITE_OMIT_DEC
bb80: 4c 54 59 50 45 7d 20 7b 0a 20 20 54 68 69 73 20 LTYPE} {. This
bb90: 6f 70 74 69 6f 6e 20 63 61 75 73 65 73 20 53 51 option causes SQ
bba0: 4c 69 74 65 20 74 6f 20 6f 6d 69 74 20 73 75 70 Lite to omit sup
bbb0: 70 6f 72 74 20 66 6f 72 20 74 68 65 0a 20 20 5b port for the. [
bbc0: 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 64 sqlite3_column_d
bbd0: 65 63 6c 74 79 70 65 28 29 5d 20 61 6e 64 20 5b ecltype()] and [
bbe0: 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 64 sqlite3_column_d
bbf0: 65 63 6c 74 79 70 65 31 36 28 29 5d 0a 20 20 69 ecltype16()]. i
bc00: 6e 74 65 72 66 61 63 65 73 2e 0a 7d 0a 0a 43 4f nterfaces..}..CO
bc10: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 MPILE_OPTION {SQ
bc20: 4c 49 54 45 5f 4f 4d 49 54 5f 44 45 50 52 45 43 LITE_OMIT_DEPREC
bc30: 41 54 45 44 7d 20 7b 0a 20 20 54 68 69 73 20 6f ATED} {. This o
bc40: 70 74 69 6f 6e 20 63 61 75 73 65 73 20 53 51 4c ption causes SQL
bc50: 69 74 65 20 74 6f 20 6f 6d 69 74 20 73 75 70 70 ite to omit supp
bc60: 6f 72 74 20 66 6f 72 20 69 6e 74 65 72 66 61 63 ort for interfac
bc70: 65 73 0a 20 20 6d 61 72 6b 65 64 20 61 73 20 64 es. marked as d
bc80: 65 70 72 65 63 61 74 65 64 2e 20 20 54 68 69 73 eprecated. This
bc90: 20 69 6e 63 6c 75 64 65 73 20 0a 20 20 5b 73 71 includes . [sq
bca0: 6c 69 74 65 33 5f 61 67 67 72 65 67 61 74 65 5f lite3_aggregate_
bcb0: 63 6f 75 6e 74 28 29 5d 2c 0a 20 20 5b 73 71 6c count()],. [sql
bcc0: 69 74 65 33 5f 65 78 70 69 72 65 64 28 29 5d 2c ite3_expired()],
bcd0: 0a 20 20 5b 73 71 6c 69 74 65 33 5f 74 72 61 6e . [sqlite3_tran
bce0: 73 66 65 72 5f 62 69 6e 64 69 6e 67 73 28 29 5d sfer_bindings()]
bcf0: 2c 0a 20 20 5b 73 71 6c 69 74 65 33 5f 67 6c 6f ,. [sqlite3_glo
bd00: 62 61 6c 5f 72 65 63 6f 76 65 72 28 29 5d 2c 0a bal_recover()],.
bd10: 20 20 5b 73 71 6c 69 74 65 33 5f 74 68 72 65 61 [sqlite3_threa
bd20: 64 5f 63 6c 65 61 6e 75 70 28 29 5d 20 61 6e 64 d_cleanup()] and
bd30: 0a 20 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d 6f . [sqlite3_memo
bd40: 72 79 5f 61 6c 61 72 6d 28 29 5d 20 69 6e 74 65 ry_alarm()] inte
bd50: 72 66 61 63 65 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 rfaces..}..COMPI
bd60: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
bd70: 45 5f 4f 4d 49 54 5f 44 49 53 4b 49 4f 7d 20 7b E_OMIT_DISKIO} {
bd80: 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 6f . This option o
bd90: 6d 69 74 73 20 61 6c 6c 20 73 75 70 70 6f 72 74 mits all support
bda0: 20 66 6f 72 20 77 72 69 74 69 6e 67 20 74 6f 20 for writing to
bdb0: 74 68 65 20 64 69 73 6b 20 61 6e 64 20 66 6f 72 the disk and for
bdc0: 63 65 73 0a 20 20 64 61 74 61 62 61 73 65 73 20 ces. databases
bdd0: 74 6f 20 65 78 69 73 74 20 69 6e 20 6d 65 6d 6f to exist in memo
bde0: 72 79 20 6f 6e 6c 79 2e 20 20 54 68 69 73 20 6f ry only. This o
bdf0: 70 74 69 6f 6e 20 68 61 73 20 6e 6f 74 20 62 65 ption has not be
be00: 65 6e 20 0a 20 20 6d 61 69 6e 74 61 69 6e 65 64 en . maintained
be10: 20 61 6e 64 20 70 72 6f 62 61 62 6c 79 20 64 6f and probably do
be20: 65 73 20 6e 6f 74 20 77 6f 72 6b 20 77 69 74 68 es not work with
be30: 20 6e 65 77 65 72 20 76 65 72 73 69 6f 6e 73 20 newer versions
be40: 6f 66 20 53 51 4c 69 74 65 2e 0a 7d 0a 0a 43 4f of SQLite..}..CO
be50: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 MPILE_OPTION {SQ
be60: 4c 49 54 45 5f 4f 4d 49 54 5f 45 58 50 4c 41 49 LITE_OMIT_EXPLAI
be70: 4e 7d 20 7b 0a 20 20 44 65 66 69 6e 69 6e 67 20 N} {. Defining
be80: 74 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 75 73 this option caus
be90: 65 73 20 74 68 65 20 5b 45 58 50 4c 41 49 4e 5d es the [EXPLAIN]
bea0: 20 63 6f 6d 6d 61 6e 64 20 74 6f 20 62 65 20 6f command to be o
beb0: 6d 69 74 74 65 64 20 66 72 6f 6d 20 74 68 65 0a mitted from the.
bec0: 20 20 6c 69 62 72 61 72 79 2e 20 41 74 74 65 6d library. Attem
bed0: 70 74 69 6e 67 20 74 6f 20 65 78 65 63 75 74 65 pting to execute
bee0: 20 61 6e 20 5b 45 58 50 4c 41 49 4e 5d 20 73 74 an [EXPLAIN] st
bef0: 61 74 65 6d 65 6e 74 20 77 69 6c 6c 20 63 61 75 atement will cau
bf00: 73 65 20 61 20 70 61 72 73 65 0a 20 20 65 72 72 se a parse. err
bf10: 6f 72 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f or..}..COMPILE_O
bf20: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d PTION {SQLITE_OM
bf30: 49 54 5f 46 4c 41 47 5f 50 52 41 47 4d 41 53 7d IT_FLAG_PRAGMAS}
bf40: 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e {. This option
bf50: 20 6f 6d 69 74 73 20 73 75 70 70 6f 72 74 20 66 omits support f
bf60: 6f 72 20 61 20 73 75 62 73 65 74 20 6f 66 20 5b or a subset of [
bf70: 50 52 41 47 4d 41 5d 20 63 6f 6d 6d 61 6e 64 73 PRAGMA] commands
bf80: 20 74 68 61 74 0a 20 20 71 75 65 72 79 20 61 6e that. query an
bf90: 64 20 73 65 74 20 62 6f 6f 6c 65 61 6e 20 70 72 d set boolean pr
bfa0: 6f 70 65 72 74 69 65 73 2e 0a 7d 0a 0a 43 4f 4d operties..}..COM
bfb0: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c PILE_OPTION {SQL
bfc0: 49 54 45 5f 4f 4d 49 54 5f 46 4c 4f 41 54 49 4e ITE_OMIT_FLOATIN
bfd0: 47 5f 50 4f 49 4e 54 7d 20 7b 0a 20 20 54 68 69 G_POINT} {. Thi
bfe0: 73 20 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 s option is used
bff0: 20 74 6f 20 6f 6d 69 74 20 66 6c 6f 61 74 69 6e to omit floatin
c000: 67 2d 70 6f 69 6e 74 20 6e 75 6d 62 65 72 20 73 g-point number s
c010: 75 70 70 6f 72 74 20 66 72 6f 6d 20 74 68 65 20 upport from the
c020: 53 51 4c 69 74 65 0a 20 20 6c 69 62 72 61 72 79 SQLite. library
c030: 2e 20 57 68 65 6e 20 73 70 65 63 69 66 69 65 64 . When specified
c040: 2c 20 73 70 65 63 69 66 79 69 6e 67 20 61 20 66 , specifying a f
c050: 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 20 6e 75 loating point nu
c060: 6d 62 65 72 20 61 73 20 61 20 6c 69 74 65 72 61 mber as a litera
c070: 6c 20 0a 20 20 28 69 2e 65 2e 20 22 31 2e 30 31 l . (i.e. "1.01
c080: 22 29 20 72 65 73 75 6c 74 73 20 69 6e 20 61 20 ") results in a
c090: 70 61 72 73 65 20 65 72 72 6f 72 2e 0a 0a 20 20 parse error...
c0a0: 3c 70 3e 49 6e 20 74 68 65 20 66 75 74 75 72 65 <p>In the future
c0b0: 2c 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 6d 61 , this option ma
c0c0: 79 20 61 6c 73 6f 20 64 69 73 61 62 6c 65 20 6f y also disable o
c0d0: 74 68 65 72 20 66 6c 6f 61 74 69 6e 67 20 70 6f ther floating po
c0e0: 69 6e 74 20 0a 20 20 66 75 6e 63 74 69 6f 6e 61 int . functiona
c0f0: 6c 69 74 79 2c 20 66 6f 72 20 65 78 61 6d 70 6c lity, for exampl
c100: 65 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 72 e the [sqlite3_r
c110: 65 73 75 6c 74 5f 64 6f 75 62 6c 65 28 29 5d 2c esult_double()],
c120: 20 0a 20 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e . [sqlite3_bin
c130: 64 5f 64 6f 75 62 6c 65 28 29 5d 2c 20 5b 73 71 d_double()], [sq
c140: 6c 69 74 65 33 5f 76 61 6c 75 65 5f 64 6f 75 62 lite3_value_doub
c150: 6c 65 28 29 5d 20 61 6e 64 0a 20 20 5b 73 71 6c le()] and. [sql
c160: 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 64 6f 75 62 ite3_column_doub
c170: 6c 65 28 29 5d 20 41 50 49 20 66 75 6e 63 74 69 le()] API functi
c180: 6f 6e 73 2e 0a 20 20 3c 2f 70 3e 0a 7d 0a 0a 43 ons.. </p>.}..C
c190: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
c1a0: 51 4c 49 54 45 5f 4f 4d 49 54 5f 46 4f 52 45 49 QLITE_OMIT_FOREI
c1b0: 47 4e 5f 4b 45 59 7d 20 7b 0a 20 20 49 66 20 74 GN_KEY} {. If t
c1c0: 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 64 65 his option is de
c1d0: 66 69 6e 65 64 2c 20 74 68 65 6e 20 5b 66 6f 72 fined, then [for
c1e0: 65 69 67 6e 20 6b 65 79 20 63 6f 6e 73 74 72 61 eign key constra
c1f0: 69 6e 74 5d 20 73 79 6e 74 61 78 20 69 73 0a 20 int] syntax is.
c200: 20 6e 6f 74 20 72 65 63 6f 67 6e 69 7a 65 64 2e not recognized.
c210: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
c220: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
c230: 47 45 54 5f 54 41 42 4c 45 7d 20 7b 0a 20 20 54 GET_TABLE} {. T
c240: 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 75 73 65 his option cause
c250: 73 20 73 75 70 70 6f 72 74 20 66 6f 72 20 5b 73 s support for [s
c260: 71 6c 69 74 65 33 5f 67 65 74 5f 74 61 62 6c 65 qlite3_get_table
c270: 28 29 5d 20 61 6e 64 0a 20 20 5b 73 71 6c 69 74 ()] and. [sqlit
c280: 65 33 5f 66 72 65 65 5f 74 61 62 6c 65 28 29 5d e3_free_table()]
c290: 20 74 6f 20 62 65 20 6f 6d 69 74 74 65 64 2e 0a to be omitted..
c2a0: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
c2b0: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 49 N {SQLITE_OMIT_I
c2c0: 4e 43 52 42 4c 4f 42 7d 20 7b 0a 20 20 54 68 69 NCRBLOB} {. Thi
c2d0: 73 20 6f 70 74 69 6f 6e 20 63 61 75 73 65 73 20 s option causes
c2e0: 73 75 70 70 6f 72 74 20 66 6f 72 20 5b 73 71 6c support for [sql
c2f0: 69 74 65 33 5f 62 6c 6f 62 20 7c 20 69 6e 63 72 ite3_blob | incr
c300: 65 6d 65 6e 74 61 6c 20 42 4c 4f 42 20 49 2f 4f emental BLOB I/O
c310: 5d 0a 20 20 74 6f 20 62 65 20 6f 6d 69 74 74 65 ]. to be omitte
c320: 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 d..}..COMPILE_OP
c330: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 TION {SQLITE_OMI
c340: 54 5f 49 4e 54 45 47 52 49 54 59 5f 43 48 45 43 T_INTEGRITY_CHEC
c350: 4b 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 K} {. This opti
c360: 6f 6e 20 6f 6d 69 74 73 20 73 75 70 70 6f 72 74 on omits support
c370: 20 66 6f 72 20 74 68 65 20 5b 69 6e 74 65 67 72 for the [integr
c380: 69 74 79 5f 63 68 65 63 6b 20 70 72 61 67 6d 61 ity_check pragma
c390: 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 ]..}..COMPILE_OP
c3a0: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 TION {SQLITE_OMI
c3b0: 54 5f 4c 49 4b 45 5f 4f 50 54 49 4d 49 5a 41 54 T_LIKE_OPTIMIZAT
c3c0: 49 4f 4e 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 ION} {. This op
c3d0: 74 69 6f 6e 20 64 69 73 61 62 6c 65 73 20 74 68 tion disables th
c3e0: 65 20 61 62 69 6c 69 74 79 20 6f 66 20 53 51 4c e ability of SQL
c3f0: 69 74 65 20 74 6f 20 75 73 65 20 69 6e 64 69 63 ite to use indic
c400: 65 73 20 74 6f 20 68 65 6c 70 0a 20 20 72 65 73 es to help. res
c410: 6f 6c 76 65 20 5b 4c 49 4b 45 5d 20 61 6e 64 20 olve [LIKE] and
c420: 5b 47 4c 4f 42 5d 20 6f 70 65 72 61 74 6f 72 73 [GLOB] operators
c430: 20 69 6e 20 61 20 57 48 45 52 45 20 63 6c 61 75 in a WHERE clau
c440: 73 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f se..}..COMPILE_O
c450: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d PTION {SQLITE_OM
c460: 49 54 5f 4c 4f 41 44 5f 45 58 54 45 4e 53 49 4f IT_LOAD_EXTENSIO
c470: 4e 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 N} {. This opti
c480: 6f 6e 20 6f 6d 69 74 73 20 74 68 65 20 65 6e 74 on omits the ent
c490: 69 72 65 20 65 78 74 65 6e 73 69 6f 6e 20 6c 6f ire extension lo
c4a0: 61 64 69 6e 67 20 6d 65 63 68 61 6e 69 73 6d 20 ading mechanism
c4b0: 66 72 6f 6d 0a 20 20 53 51 4c 69 74 65 2c 20 69 from. SQLite, i
c4c0: 6e 63 6c 75 64 69 6e 67 20 5b 73 71 6c 69 74 65 ncluding [sqlite
c4d0: 33 5f 65 6e 61 62 6c 65 5f 6c 6f 61 64 5f 65 78 3_enable_load_ex
c4e0: 74 65 6e 73 69 6f 6e 28 29 5d 20 61 6e 64 0a 20 tension()] and.
c4f0: 20 5b 73 71 6c 69 74 65 33 5f 6c 6f 61 64 5f 65 [sqlite3_load_e
c500: 78 74 65 6e 73 69 6f 6e 28 29 5d 20 69 6e 74 65 xtension()] inte
c510: 72 66 61 63 65 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 rfaces..}..COMPI
c520: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
c530: 45 5f 4f 4d 49 54 5f 4c 4f 43 41 4c 54 49 4d 45 E_OMIT_LOCALTIME
c540: 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f } {. This optio
c550: 6e 20 6f 6d 69 74 73 20 74 68 65 20 22 6c 6f 63 n omits the "loc
c560: 61 6c 74 69 6d 65 22 20 6d 6f 64 69 66 69 65 72 altime" modifier
c570: 20 66 72 6f 6d 20 74 68 65 20 64 61 74 65 20 61 from the date a
c580: 6e 64 20 74 69 6d 65 0a 20 20 66 75 6e 63 74 69 nd time. functi
c590: 6f 6e 73 2e 20 20 54 68 69 73 20 6f 70 74 69 6f ons. This optio
c5a0: 6e 20 69 73 20 73 6f 6d 65 74 69 6d 65 73 20 75 n is sometimes u
c5b0: 73 65 66 75 6c 20 77 68 65 6e 20 74 72 79 69 6e seful when tryin
c5c0: 67 20 74 6f 20 63 6f 6d 70 69 6c 65 0a 20 20 74 g to compile. t
c5d0: 68 65 20 64 61 74 65 20 61 6e 64 20 74 69 6d 65 he date and time
c5e0: 20 66 75 6e 63 74 69 6f 6e 73 20 6f 6e 20 61 20 functions on a
c5f0: 70 6c 61 74 66 6f 72 6d 20 74 68 61 74 20 64 6f platform that do
c600: 65 73 20 6e 6f 74 20 73 75 70 70 6f 72 74 20 74 es not support t
c610: 68 65 0a 20 20 63 6f 6e 63 65 70 74 20 6f 66 20 he. concept of
c620: 6c 6f 63 61 6c 20 74 69 6d 65 2e 0a 7d 0a 0a 43 local time..}..C
c630: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
c640: 51 4c 49 54 45 5f 4f 4d 49 54 5f 4c 4f 4f 4b 41 QLITE_OMIT_LOOKA
c650: 53 49 44 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f SIDE} {. This o
c660: 70 74 69 6f 6e 20 6f 6d 69 74 73 20 74 68 65 20 ption omits the
c670: 5b 6c 6f 6f 6b 61 73 69 64 65 20 6d 65 6d 6f 72 [lookaside memor
c680: 79 20 61 6c 6c 6f 63 61 74 6f 72 5d 2e 0a 7d 0a y allocator]..}.
c690: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
c6a0: 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 4d 45 4d {SQLITE_OMIT_MEM
c6b0: 4f 52 59 44 42 7d 20 7b 0a 20 20 57 68 65 6e 20 ORYDB} {. When
c6c0: 74 68 69 73 20 69 73 20 64 65 66 69 6e 65 64 2c this is defined,
c6d0: 20 74 68 65 20 6c 69 62 72 61 72 79 20 64 6f 65 the library doe
c6e0: 73 20 6e 6f 74 20 72 65 73 70 65 63 74 20 74 68 s not respect th
c6f0: 65 20 73 70 65 63 69 61 6c 20 64 61 74 61 62 61 e special databa
c700: 73 65 0a 20 20 6e 61 6d 65 20 22 3a 6d 65 6d 6f se. name ":memo
c710: 72 79 3a 22 20 28 6e 6f 72 6d 61 6c 6c 79 20 75 ry:" (normally u
c720: 73 65 64 20 74 6f 20 63 72 65 61 74 65 20 61 6e sed to create an
c730: 20 5b 69 6e 2d 6d 65 6d 6f 72 79 20 64 61 74 61 [in-memory data
c740: 62 61 73 65 5d 29 2e 20 49 66 20 0a 20 20 22 3a base]). If . ":
c750: 6d 65 6d 6f 72 79 3a 22 20 69 73 20 70 61 73 73 memory:" is pass
c760: 65 64 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 6f ed to [sqlite3_o
c770: 70 65 6e 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 pen()], [sqlite3
c780: 5f 6f 70 65 6e 31 36 28 29 5d 2c 20 6f 72 0a 20 _open16()], or.
c790: 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 [sqlite3_open_v
c7a0: 32 28 29 5d 2c 20 61 20 66 69 6c 65 20 77 69 74 2()], a file wit
c7b0: 68 20 74 68 69 73 20 6e 61 6d 65 20 77 69 6c 6c h this name will
c7c0: 20 62 65 20 0a 20 20 6f 70 65 6e 65 64 20 6f 72 be . opened or
c7d0: 20 63 72 65 61 74 65 64 2e 0a 7d 0a 0a 43 4f 4d created..}..COM
c7e0: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c PILE_OPTION {SQL
c7f0: 49 54 45 5f 4f 4d 49 54 5f 4f 52 5f 4f 50 54 49 ITE_OMIT_OR_OPTI
c800: 4d 49 5a 41 54 49 4f 4e 7d 20 7b 0a 20 20 54 68 MIZATION} {. Th
c810: 69 73 20 6f 70 74 69 6f 6e 20 64 69 73 61 62 6c is option disabl
c820: 65 73 20 74 68 65 20 61 62 69 6c 69 74 79 20 6f es the ability o
c830: 66 20 53 51 4c 69 74 65 20 74 6f 20 75 73 65 20 f SQLite to use
c840: 61 6e 20 69 6e 64 65 78 20 74 6f 67 65 74 68 65 an index togethe
c850: 72 0a 20 20 77 69 74 68 20 74 65 72 6d 73 20 6f r. with terms o
c860: 66 20 61 20 57 48 45 52 45 20 63 6c 61 75 73 65 f a WHERE clause
c870: 20 63 6f 6e 6e 65 63 74 65 64 20 62 79 20 74 68 connected by th
c880: 65 20 4f 52 20 6f 70 65 72 61 74 6f 72 2e 0a 7d e OR operator..}
c890: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
c8a0: 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 50 41 {SQLITE_OMIT_PA
c8b0: 47 45 52 5f 50 52 41 47 4d 41 53 7d 20 7b 0a 20 GER_PRAGMAS} {.
c8c0: 20 44 65 66 69 6e 69 6e 67 20 74 68 69 73 20 6f Defining this o
c8d0: 70 74 69 6f 6e 20 6f 6d 69 74 73 20 70 72 61 67 ption omits prag
c8e0: 6d 61 73 20 72 65 6c 61 74 65 64 20 74 6f 20 74 mas related to t
c8f0: 68 65 20 70 61 67 65 72 20 73 75 62 73 79 73 74 he pager subsyst
c900: 65 6d 20 66 72 6f 6d 20 0a 20 20 74 68 65 20 62 em from . the b
c910: 75 69 6c 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 uild..}..COMPILE
c920: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
c930: 4f 4d 49 54 5f 50 52 41 47 4d 41 7d 20 7b 0a 20 OMIT_PRAGMA} {.
c940: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 This option is
c950: 75 73 65 64 20 74 6f 20 6f 6d 69 74 20 74 68 65 used to omit the
c960: 20 5b 50 52 41 47 4d 41 5d 20 63 6f 6d 6d 61 6e [PRAGMA] comman
c970: 64 0a 20 20 66 72 6f 6d 20 74 68 65 20 6c 69 62 d. from the lib
c980: 72 61 72 79 2e 20 4e 6f 74 65 20 74 68 61 74 20 rary. Note that
c990: 69 74 20 69 73 20 75 73 65 66 75 6c 20 74 6f 20 it is useful to
c9a0: 64 65 66 69 6e 65 20 74 68 65 20 6d 61 63 72 6f define the macro
c9b0: 73 20 74 68 61 74 20 6f 6d 69 74 0a 20 20 73 70 s that omit. sp
c9c0: 65 63 69 66 69 63 20 70 72 61 67 6d 61 73 20 69 ecific pragmas i
c9d0: 6e 20 61 64 64 69 74 69 6f 6e 20 74 6f 20 74 68 n addition to th
c9e0: 69 73 2c 20 61 73 20 74 68 65 79 20 6d 61 79 20 is, as they may
c9f0: 61 6c 73 6f 20 72 65 6d 6f 76 65 20 73 75 70 70 also remove supp
ca00: 6f 72 74 69 6e 67 20 63 6f 64 65 0a 20 20 69 6e orting code. in
ca10: 20 6f 74 68 65 72 20 73 75 62 2d 73 79 73 74 65 other sub-syste
ca20: 6d 73 2e 20 54 68 69 73 20 6d 61 63 72 6f 20 72 ms. This macro r
ca30: 65 6d 6f 76 65 73 20 74 68 65 20 5b 50 52 41 47 emoves the [PRAG
ca40: 4d 41 5d 20 63 6f 6d 6d 61 6e 64 20 6f 6e 6c 79 MA] command only
ca50: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
ca60: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 ION {SQLITE_OMIT
ca70: 5f 50 52 4f 47 52 45 53 53 5f 43 41 4c 4c 42 41 _PROGRESS_CALLBA
ca80: 43 4b 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 CK} {. This opt
ca90: 69 6f 6e 20 6d 61 79 20 62 65 20 64 65 66 69 6e ion may be defin
caa0: 65 64 20 74 6f 20 6f 6d 69 74 20 74 68 65 20 63 ed to omit the c
cab0: 61 70 61 62 69 6c 69 74 79 20 74 6f 20 69 73 73 apability to iss
cac0: 75 65 20 22 70 72 6f 67 72 65 73 73 22 20 0a 20 ue "progress" .
cad0: 20 63 61 6c 6c 62 61 63 6b 73 20 64 75 72 69 6e callbacks durin
cae0: 67 20 6c 6f 6e 67 2d 72 75 6e 6e 69 6e 67 20 53 g long-running S
caf0: 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 2e 20 54 QL statements. T
cb00: 68 65 20 0a 20 20 5b 73 71 6c 69 74 65 33 5f 70 he . [sqlite3_p
cb10: 72 6f 67 72 65 73 73 5f 68 61 6e 64 6c 65 72 28 rogress_handler(
cb20: 29 5d 0a 20 20 41 50 49 20 66 75 6e 63 74 69 6f )]. API functio
cb30: 6e 20 69 73 20 6e 6f 74 20 70 72 65 73 65 6e 74 n is not present
cb40: 20 69 6e 20 74 68 65 20 6c 69 62 72 61 72 79 2e in the library.
cb50: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
cb60: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
cb70: 51 55 49 43 4b 42 41 4c 41 4e 43 45 7d 20 7b 0a QUICKBALANCE} {.
cb80: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d This option om
cb90: 69 74 73 20 61 6e 20 61 6c 74 65 72 6e 61 74 69 its an alternati
cba0: 76 65 2c 20 66 61 73 74 65 72 20 42 2d 54 72 65 ve, faster B-Tre
cbb0: 65 20 62 61 6c 61 6e 63 69 6e 67 20 72 6f 75 74 e balancing rout
cbc0: 69 6e 65 2e 0a 20 20 55 73 69 6e 67 20 74 68 69 ine.. Using thi
cbd0: 73 20 6f 70 74 69 6f 6e 20 6d 61 6b 65 73 20 53 s option makes S
cbe0: 51 4c 69 74 65 20 73 6c 69 67 68 74 6c 79 20 73 QLite slightly s
cbf0: 6d 61 6c 6c 65 72 20 61 74 20 74 68 65 20 65 78 maller at the ex
cc00: 70 65 6e 73 65 20 6f 66 0a 20 20 6d 61 6b 69 6e pense of. makin
cc10: 67 20 69 74 20 72 75 6e 20 73 6c 69 67 68 74 6c g it run slightl
cc20: 79 20 73 6c 6f 77 65 72 2e 0a 7d 0a 0a 43 4f 4d y slower..}..COM
cc30: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c PILE_OPTION {SQL
cc40: 49 54 45 5f 4f 4d 49 54 5f 52 45 49 4e 44 45 58 ITE_OMIT_REINDEX
cc50: 7d 20 7b 0a 20 20 57 68 65 6e 20 74 68 69 73 20 } {. When this
cc60: 6f 70 74 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 option is define
cc70: 64 2c 20 74 68 65 20 5b 52 45 49 4e 44 45 58 5d d, the [REINDEX]
cc80: 0a 20 20 63 6f 6d 6d 61 6e 64 20 69 73 20 6e 6f . command is no
cc90: 74 20 69 6e 63 6c 75 64 65 64 20 69 6e 20 74 68 t included in th
cca0: 65 20 6c 69 62 72 61 72 79 2e 0a 20 20 45 78 65 e library.. Exe
ccb0: 63 75 74 69 6e 67 20 61 20 5b 52 45 49 4e 44 45 cuting a [REINDE
ccc0: 58 5d 20 73 74 61 74 65 6d 65 6e 74 20 63 61 75 X] statement cau
ccd0: 73 65 73 20 0a 20 20 61 20 70 61 72 73 65 20 65 ses . a parse e
cce0: 72 72 6f 72 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 rror..}..COMPILE
ccf0: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
cd00: 4f 4d 49 54 5f 53 43 48 45 4d 41 5f 50 52 41 47 OMIT_SCHEMA_PRAG
cd10: 4d 41 53 7d 20 7b 0a 20 20 44 65 66 69 6e 69 6e MAS} {. Definin
cd20: 67 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d g this option om
cd30: 69 74 73 20 70 72 61 67 6d 61 73 20 66 6f 72 20 its pragmas for
cd40: 71 75 65 72 79 69 6e 67 20 74 68 65 20 64 61 74 querying the dat
cd50: 61 62 61 73 65 20 73 63 68 65 6d 61 20 66 72 6f abase schema fro
cd60: 6d 20 0a 20 20 74 68 65 20 62 75 69 6c 64 2e 0a m . the build..
cd70: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
cd80: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 53 N {SQLITE_OMIT_S
cd90: 43 48 45 4d 41 5f 56 45 52 53 49 4f 4e 5f 50 52 CHEMA_VERSION_PR
cda0: 41 47 4d 41 53 7d 20 7b 0a 20 20 44 65 66 69 6e AGMAS} {. Defin
cdb0: 69 6e 67 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 ing this option
cdc0: 6f 6d 69 74 73 20 70 72 61 67 6d 61 73 20 66 6f omits pragmas fo
cdd0: 72 20 71 75 65 72 79 69 6e 67 20 61 6e 64 20 6d r querying and m
cde0: 6f 64 69 66 79 69 6e 67 20 74 68 65 20 0a 20 20 odifying the .
cdf0: 64 61 74 61 62 61 73 65 20 73 63 68 65 6d 61 20 database schema
ce00: 76 65 72 73 69 6f 6e 20 61 6e 64 20 75 73 65 72 version and user
ce10: 20 76 65 72 73 69 6f 6e 20 66 72 6f 6d 20 74 68 version from th
ce20: 65 20 62 75 69 6c 64 2e 20 53 70 65 63 69 66 69 e build. Specifi
ce30: 63 61 6c 6c 79 2c 20 74 68 65 20 0a 20 20 5b 73 cally, the . [s
ce40: 63 68 65 6d 61 5f 76 65 72 73 69 6f 6e 5d 20 61 chema_version] a
ce50: 6e 64 20 5b 75 73 65 72 5f 76 65 72 73 69 6f 6e nd [user_version
ce60: 5d 20 50 52 41 47 4d 41 73 20 61 72 65 20 6f 6d ] PRAGMAs are om
ce70: 69 74 74 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c itted..}..COMPIL
ce80: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
ce90: 5f 4f 4d 49 54 5f 53 48 41 52 45 44 5f 43 41 43 _OMIT_SHARED_CAC
cea0: 48 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 HE} {. This opt
ceb0: 69 6f 6e 20 62 75 69 6c 64 73 20 53 51 4c 69 74 ion builds SQLit
cec0: 65 20 77 69 74 68 6f 75 74 20 73 75 70 70 6f 72 e without suppor
ced0: 74 20 66 6f 72 20 73 68 61 72 65 64 2d 63 61 63 t for shared-cac
cee0: 68 65 20 6d 6f 64 65 2e 0a 20 20 54 68 65 20 5b he mode.. The [
cef0: 73 71 6c 69 74 65 33 5f 65 6e 61 62 6c 65 5f 73 sqlite3_enable_s
cf00: 68 61 72 65 64 5f 63 61 63 68 65 28 29 5d 20 69 hared_cache()] i
cf10: 73 20 6f 6d 69 74 74 65 64 20 61 6c 6f 6e 67 20 s omitted along
cf20: 77 69 74 68 20 61 20 66 61 69 72 0a 20 20 61 6d with a fair. am
cf30: 6f 75 6e 74 20 6f 66 20 6c 6f 67 69 63 20 77 69 ount of logic wi
cf40: 74 68 69 6e 20 74 68 65 20 42 2d 54 72 65 65 20 thin the B-Tree
cf50: 73 75 62 73 79 73 74 65 6d 20 61 73 73 6f 63 69 subsystem associ
cf60: 61 74 65 64 20 77 69 74 68 20 73 68 61 72 65 64 ated with shared
cf70: 0a 20 20 63 61 63 68 65 20 6d 61 6e 61 67 65 6d . cache managem
cf80: 65 6e 74 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f ent..}..COMPILE_
cf90: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f OPTION {SQLITE_O
cfa0: 4d 49 54 5f 53 55 42 51 55 45 52 59 7d 20 7b 0a MIT_SUBQUERY} {.
cfb0: 20 20 49 66 20 64 65 66 69 6e 65 64 2c 20 73 75 If defined, su
cfc0: 70 70 6f 72 74 20 66 6f 72 20 73 75 62 2d 73 65 pport for sub-se
cfd0: 6c 65 63 74 73 20 61 6e 64 20 74 68 65 20 49 4e lects and the IN
cfe0: 28 29 20 6f 70 65 72 61 74 6f 72 20 61 72 65 20 () operator are
cff0: 6f 6d 69 74 74 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 omitted..}..COMP
d000: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
d010: 54 45 5f 4f 4d 49 54 5f 54 43 4c 5f 56 41 52 49 TE_OMIT_TCL_VARI
d020: 41 42 4c 45 7d 20 7b 0a 20 20 49 66 20 74 68 69 ABLE} {. If thi
d030: 73 20 6d 61 63 72 6f 20 69 73 20 64 65 66 69 6e s macro is defin
d040: 65 64 2c 20 74 68 65 6e 20 74 68 65 20 73 70 65 ed, then the spe
d050: 63 69 61 6c 20 22 24 3c 76 61 72 69 61 62 6c 65 cial "$<variable
d060: 2d 6e 61 6d 65 3e 22 20 73 79 6e 74 61 78 0a 20 -name>" syntax.
d070: 20 75 73 65 64 20 74 6f 20 61 75 74 6f 6d 61 74 used to automat
d080: 69 63 61 6c 6c 79 20 62 69 6e 64 20 53 51 4c 20 ically bind SQL
d090: 76 61 72 69 61 62 6c 65 73 20 74 6f 20 54 43 4c variables to TCL
d0a0: 20 76 61 72 69 61 62 6c 65 73 20 69 73 20 6f 6d variables is om
d0b0: 69 74 74 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c itted..}..COMPIL
d0c0: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
d0d0: 5f 4f 4d 49 54 5f 54 45 4d 50 44 42 7d 20 7b 0a _OMIT_TEMPDB} {.
d0e0: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d This option om
d0f0: 69 74 73 20 73 75 70 70 6f 72 74 20 66 6f 72 20 its support for
d100: 54 45 4d 50 20 6f 72 20 54 45 4d 50 4f 52 41 52 TEMP or TEMPORAR
d110: 59 20 74 61 62 6c 65 73 2e 0a 7d 0a 0a 43 4f 4d Y tables..}..COM
d120: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c PILE_OPTION {SQL
d130: 49 54 45 5f 4f 4d 49 54 5f 54 52 41 43 45 7d 20 ITE_OMIT_TRACE}
d140: 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 {. This option
d150: 6f 6d 69 74 73 20 73 75 70 70 6f 72 74 20 66 6f omits support fo
d160: 72 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 70 r the [sqlite3_p
d170: 72 6f 66 69 6c 65 28 29 5d 20 61 6e 64 0a 20 20 rofile()] and.
d180: 5b 73 71 6c 69 74 65 33 5f 74 72 61 63 65 28 29 [sqlite3_trace()
d190: 5d 20 69 6e 74 65 72 66 61 63 65 73 20 61 6e 64 ] interfaces and
d1a0: 20 74 68 65 69 72 20 61 73 73 6f 63 69 61 74 65 their associate
d1b0: 64 20 6c 6f 67 69 63 2e 0a 7d 0a 0a 43 4f 4d 50 d logic..}..COMP
d1c0: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
d1d0: 54 45 5f 4f 4d 49 54 5f 54 52 49 47 47 45 52 7d TE_OMIT_TRIGGER}
d1e0: 20 7b 0a 20 20 44 65 66 69 6e 69 6e 67 20 74 68 {. Defining th
d1f0: 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 is option omits
d200: 73 75 70 70 6f 72 74 20 66 6f 72 20 54 52 49 47 support for TRIG
d210: 47 45 52 20 6f 62 6a 65 63 74 73 2e 20 4e 65 69 GER objects. Nei
d220: 74 68 65 72 20 74 68 65 20 0a 20 20 5b 43 52 45 ther the . [CRE
d230: 41 54 45 20 54 52 49 47 47 45 52 5d 20 6f 72 20 ATE TRIGGER] or
d240: 5b 44 52 4f 50 20 54 52 49 47 47 45 52 5d 0a 20 [DROP TRIGGER].
d250: 20 63 6f 6d 6d 61 6e 64 73 20 61 72 65 20 61 76 commands are av
d260: 61 69 6c 61 62 6c 65 20 69 6e 20 74 68 69 73 20 ailable in this
d270: 63 61 73 65 2c 20 61 6e 64 20 61 74 74 65 6d 70 case, and attemp
d280: 74 69 6e 67 20 74 6f 20 65 78 65 63 75 74 65 0a ting to execute.
d290: 20 20 65 69 74 68 65 72 20 77 69 6c 6c 20 72 65 either will re
d2a0: 73 75 6c 74 20 69 6e 20 61 20 70 61 72 73 65 20 sult in a parse
d2b0: 65 72 72 6f 72 2e 0a 20 20 54 68 69 73 20 6f 70 error.. This op
d2c0: 74 69 6f 6e 20 61 6c 73 6f 20 64 69 73 61 62 6c tion also disabl
d2d0: 65 73 20 65 6e 66 6f 72 63 65 6d 65 6e 74 20 6f es enforcement o
d2e0: 66 20 5b 66 6f 72 65 69 67 6e 20 6b 65 79 20 63 f [foreign key c
d2f0: 6f 6e 73 74 72 61 69 6e 74 73 5d 2c 0a 20 20 73 onstraints],. s
d300: 69 6e 63 65 20 74 68 65 20 63 6f 64 65 20 74 68 ince the code th
d310: 61 74 20 69 6d 70 6c 65 6d 65 6e 74 73 20 74 72 at implements tr
d320: 69 67 67 65 72 73 20 61 6e 64 20 77 68 69 63 68 iggers and which
d330: 20 69 73 20 6f 6d 69 74 74 65 64 20 62 79 20 74 is omitted by t
d340: 68 69 73 0a 20 20 6f 70 74 69 6f 6e 20 69 73 20 his. option is
d350: 61 6c 73 6f 20 75 73 65 64 20 74 6f 20 69 6d 70 also used to imp
d360: 6c 65 6d 65 6e 74 20 5b 66 6f 72 65 69 67 6e 20 lement [foreign
d370: 6b 65 79 20 61 63 74 69 6f 6e 73 5d 2e 0a 7d 0a key actions]..}.
d380: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
d390: 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 54 52 55 {SQLITE_OMIT_TRU
d3a0: 4e 43 41 54 45 5f 4f 50 54 49 4d 49 5a 41 54 49 NCATE_OPTIMIZATI
d3b0: 4f 4e 7d 20 7b 0a 20 20 41 20 64 65 66 61 75 6c ON} {. A defaul
d3c0: 74 20 62 75 69 6c 64 20 6f 66 20 53 51 4c 69 74 t build of SQLit
d3d0: 65 2c 20 69 66 20 61 20 5b 44 45 4c 45 54 45 5d e, if a [DELETE]
d3e0: 20 73 74 61 74 65 6d 65 6e 74 20 68 61 73 20 6e statement has n
d3f0: 6f 20 57 48 45 52 45 20 63 6c 61 75 73 65 0a 20 o WHERE clause.
d400: 20 61 6e 64 20 6f 70 65 72 61 74 65 73 20 6f 6e and operates on
d410: 20 61 20 74 61 62 6c 65 20 77 69 74 68 20 6e 6f a table with no
d420: 20 74 72 69 67 67 65 72 73 2c 20 61 6e 20 6f 70 triggers, an op
d430: 74 69 6d 69 7a 61 74 69 6f 6e 20 6f 63 63 75 72 timization occur
d440: 73 20 74 68 61 74 0a 20 20 63 61 75 73 65 73 20 s that. causes
d450: 74 68 65 20 44 45 4c 45 54 45 20 74 6f 20 6f 63 the DELETE to oc
d460: 63 75 72 20 62 79 20 64 72 6f 70 70 69 6e 67 20 cur by dropping
d470: 61 6e 64 20 72 65 63 72 65 61 74 69 6e 67 20 74 and recreating t
d480: 68 65 20 74 61 62 6c 65 2e 20 20 0a 20 20 44 72 he table. . Dr
d490: 6f 70 70 69 6e 67 20 61 6e 64 20 72 65 63 72 65 opping and recre
d4a0: 61 74 69 6e 67 20 61 20 74 61 62 6c 65 20 69 73 ating a table is
d4b0: 20 75 73 75 61 6c 6c 79 20 6d 75 63 68 20 66 61 usually much fa
d4c0: 73 74 65 72 20 74 68 61 6e 20 64 65 6c 65 74 69 ster than deleti
d4d0: 6e 67 0a 20 20 74 68 65 20 74 61 62 6c 65 20 63 ng. the table c
d4e0: 6f 6e 74 65 6e 74 20 72 6f 77 20 62 79 20 72 6f ontent row by ro
d4f0: 77 2e 20 20 54 68 69 73 20 69 73 20 74 68 65 20 w. This is the
d500: 22 74 72 75 6e 63 61 74 65 20 6f 70 74 69 6d 69 "truncate optimi
d510: 7a 61 74 69 6f 6e 22 2e 0a 7d 0a 0a 43 4f 4d 50 zation"..}..COMP
d520: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
d530: 54 45 5f 4f 4d 49 54 5f 55 54 46 31 36 7d 20 7b TE_OMIT_UTF16} {
d540: 0a 20 20 54 68 69 73 20 6d 61 63 72 6f 20 69 73 . This macro is
d550: 20 75 73 65 64 20 74 6f 20 6f 6d 69 74 20 73 75 used to omit su
d560: 70 70 6f 72 74 20 66 6f 72 20 55 54 46 31 36 20 pport for UTF16
d570: 74 65 78 74 20 65 6e 63 6f 64 69 6e 67 2e 20 57 text encoding. W
d580: 68 65 6e 20 74 68 69 73 20 69 73 0a 20 20 64 65 hen this is. de
d590: 66 69 6e 65 64 20 61 6c 6c 20 41 50 49 20 66 75 fined all API fu
d5a0: 6e 63 74 69 6f 6e 73 20 74 68 61 74 20 72 65 74 nctions that ret
d5b0: 75 72 6e 20 6f 72 20 61 63 63 65 70 74 20 55 54 urn or accept UT
d5c0: 46 31 36 20 65 6e 63 6f 64 65 64 20 74 65 78 74 F16 encoded text
d5d0: 20 61 72 65 0a 20 20 75 6e 61 76 61 69 6c 61 62 are. unavailab
d5e0: 6c 65 2e 20 54 68 65 73 65 20 66 75 6e 63 74 69 le. These functi
d5f0: 6f 6e 73 20 63 61 6e 20 62 65 20 69 64 65 6e 74 ons can be ident
d600: 69 66 69 65 64 20 62 79 20 74 68 65 20 66 61 63 ified by the fac
d610: 74 20 74 68 61 74 20 74 68 65 79 20 65 6e 64 0a t that they end.
d620: 20 20 77 69 74 68 20 27 31 36 27 2c 20 66 6f 72 with '16', for
d630: 20 65 78 61 6d 70 6c 65 20 5b 73 71 6c 69 74 65 example [sqlite
d640: 33 5f 70 72 65 70 61 72 65 31 36 28 29 5d 2c 20 3_prepare16()],
d650: 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f [sqlite3_column_
d660: 74 65 78 74 31 36 28 29 5d 20 61 6e 64 0a 20 20 text16()] and.
d670: 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74 65 [sqlite3_bind_te
d680: 78 74 31 36 28 29 5d 2e 0a 7d 0a 0a 43 4f 4d 50 xt16()]..}..COMP
d690: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
d6a0: 54 45 5f 4f 4d 49 54 5f 56 41 43 55 55 4d 7d 20 TE_OMIT_VACUUM}
d6b0: 7b 0a 20 20 57 68 65 6e 20 74 68 69 73 20 6f 70 {. When this op
d6c0: 74 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 2c tion is defined,
d6d0: 20 74 68 65 20 5b 56 41 43 55 55 4d 5d 0a 20 20 the [VACUUM].
d6e0: 63 6f 6d 6d 61 6e 64 20 69 73 20 6e 6f 74 20 69 command is not i
d6f0: 6e 63 6c 75 64 65 64 20 69 6e 20 74 68 65 20 6c ncluded in the l
d700: 69 62 72 61 72 79 2e 0a 20 20 45 78 65 63 75 74 ibrary.. Execut
d710: 69 6e 67 20 61 20 5b 56 41 43 55 55 4d 5d 20 73 ing a [VACUUM] s
d720: 74 61 74 65 6d 65 6e 74 20 63 61 75 73 65 73 20 tatement causes
d730: 0a 20 20 61 20 70 61 72 73 65 20 65 72 72 6f 72 . a parse error
d740: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
d750: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 ION {SQLITE_OMIT
d760: 5f 56 49 45 57 7d 20 7b 0a 20 20 44 65 66 69 6e _VIEW} {. Defin
d770: 69 6e 67 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 ing this option
d780: 6f 6d 69 74 73 20 73 75 70 70 6f 72 74 20 66 6f omits support fo
d790: 72 20 56 49 45 57 20 6f 62 6a 65 63 74 73 2e 20 r VIEW objects.
d7a0: 4e 65 69 74 68 65 72 20 74 68 65 20 0a 20 20 5b Neither the . [
d7b0: 43 52 45 41 54 45 20 56 49 45 57 5d 20 6e 6f 72 CREATE VIEW] nor
d7c0: 20 74 68 65 20 5b 44 52 4f 50 20 56 49 45 57 5d the [DROP VIEW]
d7d0: 0a 20 20 63 6f 6d 6d 61 6e 64 73 20 61 72 65 20 . commands are
d7e0: 61 76 61 69 6c 61 62 6c 65 20 69 6e 20 74 68 69 available in thi
d7f0: 73 20 63 61 73 65 2c 20 61 6e 64 0a 20 20 61 74 s case, and. at
d800: 74 65 6d 70 74 69 6e 67 20 74 6f 20 65 78 65 63 tempting to exec
d810: 75 74 65 20 65 69 74 68 65 72 20 77 69 6c 6c 20 ute either will
d820: 72 65 73 75 6c 74 20 69 6e 20 61 20 70 61 72 73 result in a pars
d830: 65 20 65 72 72 6f 72 2e 0a 0a 20 20 57 41 52 4e e error... WARN
d840: 49 4e 47 3a 20 49 66 20 74 68 69 73 20 6d 61 63 ING: If this mac
d850: 72 6f 20 69 73 20 64 65 66 69 6e 65 64 2c 20 69 ro is defined, i
d860: 74 20 77 69 6c 6c 20 6e 6f 74 20 62 65 20 70 6f t will not be po
d870: 73 73 69 62 6c 65 20 74 6f 20 6f 70 65 6e 20 61 ssible to open a
d880: 20 64 61 74 61 62 61 73 65 0a 20 20 66 6f 72 20 database. for
d890: 77 68 69 63 68 20 74 68 65 20 73 63 68 65 6d 61 which the schema
d8a0: 20 63 6f 6e 74 61 69 6e 73 20 56 49 45 57 20 6f contains VIEW o
d8b0: 62 6a 65 63 74 73 2e 20 0a 7d 0a 0a 43 4f 4d 50 bjects. .}..COMP
d8c0: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
d8d0: 54 45 5f 4f 4d 49 54 5f 56 49 52 54 55 41 4c 54 TE_OMIT_VIRTUALT
d8e0: 41 42 4c 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f ABLE} {. This o
d8f0: 70 74 69 6f 6e 20 6f 6d 69 74 73 20 73 75 70 70 ption omits supp
d900: 6f 72 74 20 66 6f 72 20 74 68 65 20 5b 73 71 6c ort for the [sql
d910: 69 74 65 33 5f 76 74 61 62 20 7c 20 56 69 72 74 ite3_vtab | Virt
d920: 75 61 6c 20 54 61 62 6c 65 5d 0a 20 20 6d 65 63 ual Table]. mec
d930: 68 61 6e 69 73 6d 20 69 6e 20 53 51 4c 69 74 65 hanism in SQLite
d940: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
d950: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 ION {SQLITE_OMIT
d960: 5f 57 41 4c 7d 20 7b 0a 20 20 54 68 69 73 20 6f _WAL} {. This o
d970: 70 74 69 6f 6e 20 6f 6d 69 74 73 20 74 68 65 20 ption omits the
d980: 22 5b 77 72 69 74 65 2d 61 68 65 61 64 20 6c 6f "[write-ahead lo
d990: 67 5d 22 20 28 61 2e 6b 2e 61 2e 20 22 5b 57 41 g]" (a.k.a. "[WA
d9a0: 4c 5d 22 29 20 63 61 70 61 62 69 6c 69 74 79 2e L]") capability.
d9b0: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
d9c0: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
d9d0: 57 53 44 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 WSD} {. This op
d9e0: 74 69 6f 6e 20 62 75 69 6c 64 73 20 61 20 76 65 tion builds a ve
d9f0: 72 73 69 6f 6e 20 6f 66 20 74 68 65 20 53 51 4c rsion of the SQL
da00: 69 74 65 20 6c 69 62 72 61 72 79 20 74 68 61 74 ite library that
da10: 20 63 6f 6e 74 61 69 6e 73 20 6e 6f 0a 20 20 57 contains no. W
da20: 72 69 74 61 62 6c 65 20 53 74 61 74 69 63 20 44 ritable Static D
da30: 61 74 61 20 28 57 53 44 29 2e 20 20 57 53 44 20 ata (WSD). WSD
da40: 69 73 20 67 6c 6f 62 61 6c 20 76 61 72 69 61 62 is global variab
da50: 6c 65 73 20 61 6e 64 2f 6f 72 20 73 74 61 74 69 les and/or stati
da60: 63 0a 20 20 76 61 72 69 61 62 6c 65 73 2e 20 20 c. variables.
da70: 53 6f 6d 65 20 70 6c 61 74 66 6f 72 6d 73 20 64 Some platforms d
da80: 6f 20 6e 6f 74 20 73 75 70 70 6f 72 74 20 57 53 o not support WS
da90: 44 2c 20 61 6e 64 20 74 68 69 73 20 6f 70 74 69 D, and this opti
daa0: 6f 6e 20 69 73 20 6e 65 63 65 73 73 61 72 79 0a on is necessary.
dab0: 20 20 69 6e 20 6f 72 64 65 72 20 66 6f 72 20 53 in order for S
dac0: 51 4c 69 74 65 20 74 6f 20 77 6f 72 6b 20 74 68 QLite to work th
dad0: 6f 73 65 20 70 6c 61 74 66 6f 72 6d 73 2e 20 20 ose platforms.
dae0: 0a 0a 20 20 55 6e 6c 69 6b 65 20 6f 74 68 65 72 .. Unlike other
daf0: 20 4f 4d 49 54 20 6f 70 74 69 6f 6e 73 20 77 68 OMIT options wh
db00: 69 63 68 20 6d 61 6b 65 20 74 68 65 20 53 51 4c ich make the SQL
db10: 69 74 65 20 6c 69 62 72 61 72 79 20 73 6d 61 6c ite library smal
db20: 6c 65 72 2c 0a 20 20 74 68 69 73 20 6f 70 74 69 ler,. this opti
db30: 6f 6e 20 61 63 74 75 61 6c 6c 79 20 69 6e 63 72 on actually incr
db40: 65 61 73 65 73 20 74 68 65 20 73 69 7a 65 20 6f eases the size o
db50: 66 20 53 51 4c 69 74 65 20 61 6e 64 20 6d 61 6b f SQLite and mak
db60: 65 73 20 69 74 20 72 75 6e 0a 20 20 61 20 6c 69 es it run. a li
db70: 74 74 6c 65 20 73 6c 6f 77 65 72 2e 20 20 4f 6e ttle slower. On
db80: 6c 79 20 75 73 65 20 74 68 69 73 20 6f 70 74 69 ly use this opti
db90: 6f 6e 20 69 66 20 53 51 4c 69 74 65 20 69 73 20 on if SQLite is
dba0: 62 65 69 6e 67 20 62 75 69 6c 74 20 66 6f 72 20 being built for
dbb0: 61 6e 0a 20 20 65 6d 62 65 64 64 65 64 20 74 61 an. embedded ta
dbc0: 72 67 65 74 20 74 68 61 74 20 64 6f 65 73 20 6e rget that does n
dbd0: 6f 74 20 73 75 70 70 6f 72 74 20 57 53 44 2e 0a ot support WSD..
dbe0: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
dbf0: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 58 N {SQLITE_OMIT_X
dc00: 46 45 52 5f 4f 50 54 7d 20 7b 0a 20 20 54 68 69 FER_OPT} {. Thi
dc10: 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 73 s option omits s
dc20: 75 70 70 6f 72 74 20 66 6f 72 20 6f 70 74 69 6d upport for optim
dc30: 69 7a 61 74 69 6f 6e 73 20 74 68 61 74 20 68 65 izations that he
dc40: 6c 70 20 73 74 61 74 65 6d 65 6e 74 73 0a 20 20 lp statements.
dc50: 6f 66 20 74 68 65 20 66 6f 72 6d 20 22 49 4e 53 of the form "INS
dc60: 45 52 54 20 49 4e 54 4f 20 2e 2e 2e 20 53 45 4c ERT INTO ... SEL
dc70: 45 43 54 20 2e 2e 2e 22 20 72 75 6e 20 66 61 73 ECT ..." run fas
dc80: 74 65 72 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f ter..}..COMPILE_
dc90: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 5a OPTION {SQLITE_Z
dca0: 45 52 4f 5f 4d 41 4c 4c 4f 43 7d 20 7b 0a 20 20 ERO_MALLOC} {.
dcb0: 54 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 This option omit
dcc0: 73 20 62 6f 74 68 20 74 68 65 20 5b 64 65 66 61 s both the [defa
dcd0: 75 6c 74 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 ult memory alloc
dce0: 61 74 6f 72 5d 20 61 6e 64 20 74 68 65 0a 20 20 ator] and the.
dcf0: 5b 64 65 62 75 67 67 69 6e 67 20 6d 65 6d 6f 72 [debugging memor
dd00: 79 20 61 6c 6c 6f 63 61 74 6f 72 5d 20 66 72 6f y allocator] fro
dd10: 6d 20 74 68 65 20 62 75 69 6c 64 20 61 6e 64 20 m the build and
dd20: 73 75 62 73 74 69 74 75 74 65 73 20 61 20 73 74 substitutes a st
dd30: 75 62 0a 20 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f ub. memory allo
dd40: 63 61 74 6f 72 20 74 68 61 74 20 61 6c 77 61 79 cator that alway
dd50: 73 20 66 61 69 6c 73 2e 20 20 53 51 4c 69 74 65 s fails. SQLite
dd60: 20 77 69 6c 6c 20 6e 6f 74 20 72 75 6e 20 77 69 will not run wi
dd70: 74 68 20 74 68 69 73 0a 20 20 73 74 75 62 20 6d th this. stub m
dd80: 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 20 emory allocator
dd90: 73 69 6e 63 65 20 69 74 20 77 69 6c 6c 20 62 65 since it will be
dda0: 20 75 6e 61 62 6c 65 20 74 6f 20 61 6c 6c 6f 63 unable to alloc
ddb0: 61 74 65 20 6d 65 6d 6f 72 79 2e 20 20 42 75 74 ate memory. But
ddc0: 0a 20 20 74 68 69 73 20 73 74 75 62 20 63 61 6e . this stub can
ddd0: 20 62 65 20 72 65 70 6c 61 63 65 64 20 61 74 20 be replaced at
dde0: 73 74 61 72 74 2d 74 69 6d 65 20 75 73 69 6e 67 start-time using
ddf0: 0a 20 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66 . [sqlite3_conf
de00: 69 67 5d 28 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 ig]([SQLITE_CONF
de10: 49 47 5f 4d 41 4c 4c 4f 43 5d 2c 2e 2e 2e 29 20 IG_MALLOC],...)
de20: 6f 72 0a 20 20 5b 73 71 6c 69 74 65 33 5f 63 6f or. [sqlite3_co
de30: 6e 66 69 67 5d 28 5b 53 51 4c 49 54 45 5f 43 4f nfig]([SQLITE_CO
de40: 4e 46 49 47 5f 48 45 41 50 5d 2c 2e 2e 2e 29 2e NFIG_HEAP],...).
de50: 0a 20 20 53 6f 20 74 68 65 20 6e 65 74 20 65 66 . So the net ef
de60: 66 65 63 74 20 6f 66 20 74 68 69 73 20 63 6f 6d fect of this com
de70: 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e pile-time option
de80: 20 69 73 20 74 68 61 74 20 69 74 20 61 6c 6c 6f is that it allo
de90: 77 73 20 53 51 4c 69 74 65 0a 20 20 74 6f 20 62 ws SQLite. to b
dea0: 65 20 63 6f 6d 70 69 6c 65 64 20 61 6e 64 20 6c e compiled and l
deb0: 69 6e 6b 65 64 20 61 67 61 69 6e 73 74 20 61 20 inked against a
dec0: 73 79 73 74 65 6d 20 6c 69 62 72 61 72 79 20 74 system library t
ded0: 68 61 74 20 64 6f 65 73 20 6e 6f 74 20 73 75 70 hat does not sup
dee0: 70 6f 72 74 0a 20 20 6d 61 6c 6c 6f 63 28 29 2c port. malloc(),
def0: 20 66 72 65 65 28 29 2c 20 61 6e 64 2f 6f 72 20 free(), and/or
df00: 72 65 61 6c 6c 6f 63 28 29 2e 0a 7d 0a 0a 3c 2f realloc()..}..</
df10: 74 63 6c 3e 0a 3c 61 20 6e 61 6d 65 3d 22 64 65 tcl>.<a name="de
df20: 62 75 67 6f 70 74 69 6f 6e 73 22 3e 3c 2f 61 3e bugoptions"></a>
df30: 0a 3c 68 32 3e 31 2e 38 20 41 6e 61 6c 79 73 69 .<h2>1.8 Analysi
df40: 73 20 61 6e 64 20 44 65 62 75 67 67 69 6e 67 20 s and Debugging
df50: 4f 70 74 69 6f 6e 73 3c 2f 68 32 3e 0a 3c 74 63 Options</h2>.<tc
df60: 6c 3e 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 l>..COMPILE_OPTI
df70: 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 45 42 55 47 ON {SQLITE_DEBUG
df80: 7d 20 7b 0a 20 20 54 68 65 20 53 51 4c 69 74 65 } {. The SQLite
df90: 20 73 6f 75 72 63 65 20 63 6f 64 65 20 63 6f 6e source code con
dfa0: 74 61 69 6e 73 20 6c 69 74 65 72 61 6c 6c 79 20 tains literally
dfb0: 74 68 6f 75 73 61 6e 64 73 20 6f 66 20 61 73 73 thousands of ass
dfc0: 65 72 74 28 29 20 73 74 61 74 65 6d 65 6e 74 73 ert() statements
dfd0: 0a 20 20 75 73 65 64 20 74 6f 20 76 65 72 69 66 . used to verif
dfe0: 79 20 69 6e 74 65 72 6e 61 6c 20 61 73 73 75 6d y internal assum
dff0: 70 74 69 6f 6e 73 20 61 6e 64 20 73 75 62 72 6f ptions and subro
e000: 75 74 69 6e 65 20 70 72 65 63 6f 6e 64 69 74 69 utine preconditi
e010: 6f 6e 73 20 61 6e 64 0a 20 20 70 6f 73 74 63 6f ons and. postco
e020: 6e 64 69 74 69 6f 6e 73 2e 20 20 54 68 65 73 65 nditions. These
e030: 20 61 73 73 65 72 74 28 29 20 73 74 61 74 65 6d assert() statem
e040: 65 6e 74 73 20 61 72 65 20 6e 6f 72 6d 61 6c 6c ents are normall
e050: 79 20 74 75 72 6e 65 64 20 6f 66 66 0a 20 20 28 y turned off. (
e060: 74 68 65 79 20 67 65 6e 65 72 61 74 65 20 6e 6f they generate no
e070: 20 63 6f 64 65 29 20 73 69 6e 63 65 20 74 75 72 code) since tur
e080: 6e 69 6e 67 20 74 68 65 6d 20 6f 6e 20 6d 61 6b ning them on mak
e090: 65 73 20 53 51 4c 69 74 65 20 72 75 6e 20 61 70 es SQLite run ap
e0a0: 70 72 6f 78 69 6d 61 74 65 6c 79 0a 20 20 74 68 proximately. th
e0b0: 72 65 65 20 74 69 6d 65 73 20 73 6c 6f 77 65 72 ree times slower
e0c0: 2e 20 20 42 75 74 20 66 6f 72 20 74 65 73 74 69 . But for testi
e0d0: 6e 67 20 61 6e 64 20 61 6e 61 6c 79 73 69 73 2c ng and analysis,
e0e0: 20 69 74 20 69 73 20 75 73 65 66 75 6c 20 74 6f it is useful to
e0f0: 20 74 75 72 6e 0a 20 20 74 68 65 20 61 73 73 65 turn. the asse
e100: 72 74 28 29 20 73 74 61 74 65 6d 65 6e 74 73 20 rt() statements
e110: 6f 6e 2e 20 20 54 68 65 20 53 51 4c 49 54 45 5f on. The SQLITE_
e120: 44 45 42 55 47 20 63 6f 6d 70 69 6c 65 2d 74 69 DEBUG compile-ti
e130: 6d 65 20 6f 70 74 69 6f 6e 20 64 6f 65 73 20 74 me option does t
e140: 68 69 73 2e 0a 20 20 3c 70 3e 53 51 4c 49 54 45 his.. <p>SQLITE
e150: 5f 44 45 42 55 47 20 61 6c 73 6f 20 65 6e 61 62 _DEBUG also enab
e160: 6c 65 73 20 73 6f 6d 65 20 6f 74 68 65 72 20 64 les some other d
e170: 65 62 75 67 67 69 6e 67 20 66 65 61 74 75 72 65 ebugging feature
e180: 73 2c 20 73 75 63 68 20 61 73 0a 20 20 73 70 65 s, such as. spe
e190: 63 69 61 6c 20 5b 50 52 41 47 4d 41 5d 20 73 74 cial [PRAGMA] st
e1a0: 61 74 65 6d 65 6e 74 73 20 74 68 61 74 20 74 75 atements that tu
e1b0: 72 6e 20 6f 6e 20 74 72 61 63 69 6e 67 20 61 6e rn on tracing an
e1c0: 64 20 6c 69 73 74 69 6e 67 20 66 65 61 74 75 72 d listing featur
e1d0: 65 73 0a 20 20 75 73 65 64 20 66 6f 72 20 74 72 es. used for tr
e1e0: 6f 75 62 6c 65 73 68 6f 6f 74 69 6e 67 20 61 6e oubleshooting an
e1f0: 64 20 61 6e 61 6c 79 73 69 73 20 6f 66 20 74 68 d analysis of th
e200: 65 20 5b 56 44 42 45 5d 20 61 6e 64 20 63 6f 64 e [VDBE] and cod
e210: 65 20 67 65 6e 65 72 61 74 6f 72 2e 0a 7d 0a 0a e generator..}..
e220: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
e230: 53 51 4c 49 54 45 5f 4d 45 4d 44 45 42 55 47 7d SQLITE_MEMDEBUG}
e240: 20 7b 0a 20 20 54 68 65 20 53 51 4c 49 54 45 5f {. The SQLITE_
e250: 4d 45 4d 44 45 42 55 47 20 6f 70 74 69 6f 6e 20 MEMDEBUG option
e260: 63 61 75 73 65 73 20 61 6e 20 69 6e 73 74 72 75 causes an instru
e270: 6d 65 6e 74 65 64 20 0a 20 20 5b 64 65 62 75 67 mented . [debug
e280: 67 69 6e 67 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f ging memory allo
e290: 63 61 74 6f 72 5d 0a 20 20 74 6f 20 62 65 20 75 cator]. to be u
e2a0: 73 65 64 20 61 73 20 74 68 65 20 64 65 66 61 75 sed as the defau
e2b0: 6c 74 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 lt memory alloca
e2c0: 74 6f 72 20 77 69 74 68 69 6e 20 53 51 4c 69 74 tor within SQLit
e2d0: 65 2e 20 20 54 68 65 0a 20 20 69 6e 73 74 72 75 e. The. instru
e2e0: 6d 65 6e 74 65 64 20 6d 65 6d 6f 72 79 20 61 6c mented memory al
e2f0: 6c 6f 63 61 74 6f 72 20 63 68 65 63 6b 73 20 66 locator checks f
e300: 6f 72 20 6d 69 73 75 73 65 20 6f 66 20 64 79 6e or misuse of dyn
e310: 61 6d 69 63 61 6c 6c 79 20 61 6c 6c 6f 63 61 74 amically allocat
e320: 65 64 0a 20 20 6d 65 6d 6f 72 79 2e 20 20 45 78 ed. memory. Ex
e330: 61 6d 70 6c 65 73 20 6f 66 20 6d 69 73 75 73 65 amples of misuse
e340: 20 69 6e 63 6c 75 64 65 20 75 73 69 6e 67 20 6d include using m
e350: 65 6d 6f 72 79 20 61 66 74 65 72 20 69 74 20 69 emory after it i
e360: 73 20 66 72 65 65 64 2c 0a 20 20 77 72 69 74 69 s freed,. writi
e370: 6e 67 20 6f 66 66 20 74 68 65 20 65 6e 64 73 20 ng off the ends
e380: 6f 66 20 61 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f of a memory allo
e390: 63 61 74 69 6f 6e 2c 20 66 72 65 65 69 6e 67 20 cation, freeing
e3a0: 6d 65 6d 6f 72 79 20 6e 6f 74 20 70 72 65 76 69 memory not previ
e3b0: 6f 75 73 6c 79 0a 20 20 6f 62 74 61 69 6e 65 64 ously. obtained
e3c0: 20 66 72 6f 6d 20 74 68 65 20 6d 65 6d 6f 72 79 from the memory
e3d0: 20 61 6c 6c 6f 63 61 74 6f 72 2c 20 6f 72 20 66 allocator, or f
e3e0: 61 69 6c 69 6e 67 20 74 6f 20 69 6e 69 74 69 61 ailing to initia
e3f0: 6c 69 7a 65 20 6e 65 77 6c 79 0a 20 20 61 6c 6c lize newly. all
e400: 6f 63 61 74 65 64 20 6d 65 6d 6f 72 79 2e 0a 7d ocated memory..}
e410: 0a 0a 3c 2f 74 63 6c 3e 0a 3c 61 20 6e 61 6d 65 ..</tcl>.<a name
e420: 3d 22 77 69 6e 33 32 6f 70 74 69 6f 6e 73 22 3e ="win32options">
e430: 3c 2f 61 3e 0a 3c 68 32 3e 31 2e 39 20 57 69 6e </a>.<h2>1.9 Win
e440: 64 6f 77 73 2d 53 70 65 63 69 66 69 63 20 4f 70 dows-Specific Op
e450: 74 69 6f 6e 73 3c 2f 68 32 3e 0a 3c 74 63 6c 3e tions</h2>.<tcl>
e460: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
e470: 20 7b 53 51 4c 49 54 45 5f 57 49 4e 33 32 5f 48 {SQLITE_WIN32_H
e480: 45 41 50 5f 43 52 45 41 54 45 7d 20 7b 0a 20 20 EAP_CREATE} {.
e490: 54 68 69 73 20 6f 70 74 69 6f 6e 20 66 6f 72 63 This option forc
e4a0: 65 73 20 74 68 65 20 57 69 6e 33 32 20 6e 61 74 es the Win32 nat
e4b0: 69 76 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 ive memory alloc
e4c0: 61 74 6f 72 2c 20 77 68 65 6e 20 65 6e 61 62 6c ator, when enabl
e4d0: 65 64 2c 20 74 6f 0a 20 20 63 72 65 61 74 65 20 ed, to. create
e4e0: 61 20 70 72 69 76 61 74 65 20 68 65 61 70 20 74 a private heap t
e4f0: 6f 20 68 6f 6c 64 20 61 6c 6c 20 6d 65 6d 6f 72 o hold all memor
e500: 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 73 2e 0a 7d y allocations..}
e510: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
e520: 20 7b 53 51 4c 49 54 45 5f 57 49 4e 33 32 5f 4d {SQLITE_WIN32_M
e530: 41 4c 4c 4f 43 5f 56 41 4c 49 44 41 54 45 7d 20 ALLOC_VALIDATE}
e540: 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 {. This option
e550: 66 6f 72 63 65 73 20 74 68 65 20 57 69 6e 33 32 forces the Win32
e560: 20 6e 61 74 69 76 65 20 6d 65 6d 6f 72 79 20 61 native memory a
e570: 6c 6c 6f 63 61 74 6f 72 2c 20 77 68 65 6e 20 65 llocator, when e
e580: 6e 61 62 6c 65 64 2c 20 74 6f 0a 20 20 6d 61 6b nabled, to. mak
e590: 65 20 73 74 72 61 74 65 67 69 63 20 63 61 6c 6c e strategic call
e5a0: 73 20 69 6e 74 6f 20 74 68 65 20 48 65 61 70 56 s into the HeapV
e5b0: 61 6c 69 64 61 74 65 28 29 20 66 75 6e 63 74 69 alidate() functi
e5c0: 6f 6e 20 69 66 20 61 73 73 65 72 74 28 29 20 69 on if assert() i
e5d0: 73 20 61 6c 73 6f 0a 20 20 65 6e 61 62 6c 65 64 s also. enabled
e5e0: 2e 0a 7d 0a 0a 3c 2f 74 63 6c 3e 0a ..}..</tcl>.