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: 54 45 4d 50 5f 43 41 43 48 45 5f 53 49 5a 45 3d TEMP_CACHE_SIZE=
2740: 3c 69 3e 26 6c 74 3b 70 61 67 65 73 26 67 74 3b <i><pages>
2750: 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 69 73 20 6d </i>} {. This m
2760: 61 63 72 6f 20 73 65 74 73 20 74 68 65 20 64 65 acro sets the de
2770: 66 61 75 6c 74 20 73 69 7a 65 20 6f 66 20 74 68 fault size of th
2780: 65 20 70 61 67 65 2d 63 61 63 68 65 20 66 6f 72 e page-cache for
2790: 20 74 65 6d 70 6f 72 61 72 79 20 66 69 6c 65 73 temporary files
27a0: 0a 20 20 63 72 65 61 74 65 64 20 62 79 20 53 51 . created by SQ
27b0: 4c 69 74 65 20 74 6f 20 73 74 6f 72 65 20 69 6e Lite to store in
27c0: 74 65 72 6d 65 64 69 61 74 65 20 72 65 73 75 6c termediate resul
27d0: 74 73 2c 20 69 6e 20 70 61 67 65 73 2e 20 49 74 ts, in pages. It
27e0: 20 64 6f 65 73 0a 20 20 6e 6f 74 20 61 66 66 65 does. not affe
27f0: 63 74 20 74 68 65 20 70 61 67 65 2d 63 61 63 68 ct the page-cach
2800: 65 20 66 6f 72 20 74 68 65 20 74 65 6d 70 20 64 e for the temp d
2810: 61 74 61 62 61 73 65 2c 20 77 68 65 72 65 20 74 atabase, where t
2820: 61 62 6c 65 73 20 63 72 65 61 74 65 64 0a 20 20 ables created.
2830: 75 73 69 6e 67 20 5b 43 52 45 41 54 45 20 54 41 using [CREATE TA
2840: 42 4c 45 20 7c 20 43 52 45 41 54 45 20 54 45 4d BLE | CREATE TEM
2850: 50 20 54 41 42 4c 45 5d 20 61 72 65 20 73 74 6f P TABLE] are sto
2860: 72 65 64 2e 20 54 68 65 20 64 65 66 61 75 6c 74 red. The default
2870: 20 76 61 6c 75 65 0a 20 20 69 73 20 35 30 30 2e value. is 500.
2880: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
2890: 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 45 46 41 55 ON {SQLITE_DEFAU
28a0: 4c 54 5f 57 41 4c 5f 41 55 54 4f 43 48 45 43 4b LT_WAL_AUTOCHECK
28b0: 50 4f 49 4e 54 3d 3c 69 3e 26 6c 74 3b 70 61 67 POINT=<i><pag
28c0: 65 73 26 67 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 es></i>} {.
28d0: 54 68 69 73 20 6d 61 63 72 6f 20 73 65 74 73 20 This macro sets
28e0: 74 68 65 20 64 65 66 61 75 6c 74 20 70 61 67 65 the default page
28f0: 20 63 6f 75 6e 74 20 66 6f 72 20 74 68 65 20 5b count for the [
2900: 57 41 4c 5d 0a 20 20 5b 63 68 65 63 6b 70 6f 69 WAL]. [checkpoi
2910: 6e 74 69 6e 67 20 7c 20 61 75 74 6f 6d 61 74 69 nting | automati
2920: 63 20 63 68 65 63 6b 70 6f 69 6e 74 69 6e 67 5d c checkpointing]
2930: 20 66 65 61 74 75 72 65 2e 20 20 49 66 20 75 6e feature. If un
2940: 73 70 65 63 69 66 69 65 64 2c 0a 20 20 74 68 65 specified,. the
2950: 20 64 65 66 61 75 6c 74 20 70 61 67 65 20 63 6f default page co
2960: 75 6e 74 20 69 73 20 31 30 30 30 2e 0a 7d 0a 0a unt is 1000..}..
2970: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
2980: 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f 57 SQLITE_DEFAULT_W
2990: 4f 52 4b 45 52 5f 54 48 52 45 41 44 53 3d 3c 69 ORKER_THREADS=<i
29a0: 3e 4e 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 69 73 >N</i>} {. This
29b0: 20 6d 61 63 72 6f 20 73 65 74 73 20 74 68 65 20 macro sets the
29c0: 64 65 66 61 75 6c 74 20 76 61 6c 75 65 20 66 6f default value fo
29d0: 72 0a 20 20 74 68 65 20 5b 53 51 4c 49 54 45 5f r. the [SQLITE_
29e0: 4c 49 4d 49 54 5f 57 4f 52 4b 45 52 5f 54 48 52 LIMIT_WORKER_THR
29f0: 45 41 44 53 5d 20 70 61 72 61 6d 65 74 65 72 2e EADS] parameter.
2a00: 20 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 4c 49 The [SQLITE_LI
2a10: 4d 49 54 5f 57 4f 52 4b 45 52 5f 54 48 52 45 41 MIT_WORKER_THREA
2a20: 44 53 5d 0a 20 20 70 61 72 61 6d 65 74 65 72 20 DS]. parameter
2a30: 73 65 74 73 20 74 68 65 20 6d 61 78 69 6d 75 6d sets the maximum
2a40: 20 6e 75 6d 62 65 72 20 6f 66 20 61 75 78 69 6c number of auxil
2a50: 69 61 72 79 20 74 68 72 65 61 64 73 20 74 68 61 iary threads tha
2a60: 74 20 61 20 73 69 6e 67 6c 65 0a 20 20 5b 70 72 t a single. [pr
2a70: 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 epared statement
2a80: 5d 20 77 69 6c 6c 20 6c 61 75 6e 63 68 20 74 6f ] will launch to
2a90: 20 61 73 73 69 73 74 20 69 74 20 77 69 74 68 20 assist it with
2aa0: 61 20 71 75 65 72 79 2e 20 20 49 66 20 6e 6f 74 a query. If not
2ab0: 20 73 70 65 63 69 66 69 65 64 2c 0a 20 20 74 68 specified,. th
2ac0: 65 20 64 65 66 61 75 6c 74 20 6d 61 78 69 6d 75 e default maximu
2ad0: 6d 20 69 73 20 30 2e 0a 20 20 54 68 65 20 76 61 m is 0.. The va
2ae0: 6c 75 65 20 73 65 74 20 68 65 72 65 20 63 61 6e lue set here can
2af0: 6e 6f 74 20 62 65 20 6d 6f 72 65 20 74 68 61 6e not be more than
2b00: 20 5b 53 51 4c 49 54 45 5f 4d 41 58 5f 57 4f 52 [SQLITE_MAX_WOR
2b10: 4b 45 52 5f 54 48 52 45 41 44 53 5d 2e 0a 7d 0a KER_THREADS]..}.
2b20: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
2b30: 7b 53 51 4c 49 54 45 5f 46 54 53 33 5f 4d 41 58 {SQLITE_FTS3_MAX
2b40: 5f 45 58 50 52 5f 44 45 50 54 48 3d 3c 69 3e 4e _EXPR_DEPTH=<i>N
2b50: 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 69 73 20 6d </i>} {. This m
2b60: 61 63 72 6f 20 73 65 74 73 20 74 68 65 20 6d 61 acro sets the ma
2b70: 78 69 6d 75 6d 20 64 65 70 74 68 20 6f 66 20 74 ximum depth of t
2b80: 68 65 20 73 65 61 72 63 68 20 74 72 65 65 20 74 he search tree t
2b90: 68 61 74 20 63 6f 72 72 65 73 70 6f 6e 64 73 20 hat corresponds
2ba0: 74 6f 0a 20 20 74 68 65 20 72 69 67 68 74 2d 68 to. the right-h
2bb0: 61 6e 64 20 73 69 64 65 20 6f 66 20 74 68 65 20 and side of the
2bc0: 4d 41 54 43 48 20 6f 70 65 72 61 74 6f 72 20 69 MATCH operator i
2bd0: 6e 20 61 6e 20 5b 46 54 53 33 5d 20 6f 72 20 5b n an [FTS3] or [
2be0: 46 54 53 34 5d 20 66 75 6c 6c 2d 74 65 78 74 0a FTS4] full-text.
2bf0: 20 20 69 6e 64 65 78 2e 20 20 54 68 65 20 66 75 index. The fu
2c00: 6c 6c 2d 74 65 78 74 20 73 65 61 72 63 68 20 75 ll-text search u
2c10: 73 65 73 20 61 20 72 65 63 75 72 73 69 76 65 20 ses a recursive
2c20: 61 6c 67 6f 72 69 74 68 6d 2c 20 73 6f 20 74 68 algorithm, so th
2c30: 65 20 64 65 70 74 68 20 6f 66 0a 20 20 74 68 65 e depth of. the
2c40: 20 74 72 65 65 20 69 73 20 6c 69 6d 69 74 65 64 tree is limited
2c50: 20 74 6f 20 70 72 65 76 65 6e 74 20 75 73 69 6e to prevent usin
2c60: 67 20 74 6f 6f 20 6d 75 63 68 20 73 74 61 63 6b g too much stack
2c70: 20 73 70 61 63 65 2e 20 20 54 68 65 20 64 65 66 space. The def
2c80: 61 75 6c 74 0a 20 20 6c 69 6d 69 74 20 69 73 20 ault. limit is
2c90: 31 32 2e 20 20 54 68 69 73 20 6c 69 6d 69 74 20 12. This limit
2ca0: 69 73 20 73 75 66 66 69 63 69 65 6e 74 20 66 6f is sufficient fo
2cb0: 72 20 75 70 20 74 6f 20 34 30 39 35 20 73 65 61 r up to 4095 sea
2cc0: 72 63 68 20 74 65 72 6d 73 20 6f 6e 20 74 68 65 rch terms on the
2cd0: 0a 20 20 72 69 67 68 74 2d 68 61 6e 64 20 73 69 . right-hand si
2ce0: 64 65 20 6f 66 20 74 68 65 20 4d 41 54 43 48 20 de of the MATCH
2cf0: 6f 70 65 72 61 74 6f 72 20 61 6e 64 20 69 74 20 operator and it
2d00: 68 6f 6c 64 73 20 73 74 61 63 6b 20 73 70 61 63 holds stack spac
2d10: 65 20 75 73 61 67 65 20 74 6f 20 0a 20 20 6c 65 e usage to . le
2d20: 73 73 20 74 68 61 6e 20 32 30 30 30 20 62 79 74 ss than 2000 byt
2d30: 65 73 2e 0a 20 20 3c 70 3e 0a 20 20 46 6f 72 20 es.. <p>. For
2d40: 6f 72 64 69 6e 61 72 79 20 46 54 53 33 2f 46 54 ordinary FTS3/FT
2d50: 53 34 20 71 75 65 72 69 65 73 2c 20 74 68 65 20 S4 queries, the
2d60: 73 65 61 72 63 68 20 74 72 65 65 20 64 65 70 74 search tree dept
2d70: 68 20 69 73 20 61 70 70 72 6f 78 69 6d 61 74 65 h is approximate
2d80: 6c 79 0a 20 20 74 68 65 20 62 61 73 65 2d 32 20 ly. the base-2
2d90: 6c 6f 67 61 72 69 74 68 6d 20 6f 66 20 74 68 65 logarithm of the
2da0: 20 6e 75 6d 62 65 72 20 6f 66 20 74 65 72 6d 73 number of terms
2db0: 20 69 6e 20 74 68 65 20 72 69 67 68 74 2d 68 61 in the right-ha
2dc0: 6e 64 20 73 69 64 65 20 6f 66 20 74 68 65 0a 20 nd side of the.
2dd0: 20 4d 41 54 43 48 20 6f 70 65 72 61 74 6f 72 2e MATCH operator.
2de0: 20 20 48 6f 77 65 76 65 72 2c 20 66 6f 72 20 5b However, for [
2df0: 70 68 72 61 73 65 20 71 75 65 72 69 65 73 5d 20 phrase queries]
2e00: 61 6e 64 20 5b 4e 45 41 52 20 71 75 65 72 69 65 and [NEAR querie
2e10: 73 5d 20 74 68 65 0a 20 20 73 65 61 72 63 68 20 s] the. search
2e20: 74 72 65 65 20 64 65 70 74 68 20 69 73 20 6c 69 tree depth is li
2e30: 6e 65 61 72 20 69 6e 20 74 68 65 20 6e 75 6d 62 near in the numb
2e40: 65 72 20 6f 66 20 72 69 67 68 74 2d 68 61 6e 64 er of right-hand
2e50: 20 73 69 64 65 20 74 65 72 6d 73 2e 0a 20 20 53 side terms.. S
2e60: 6f 20 74 68 65 20 64 65 66 61 75 6c 74 20 64 65 o the default de
2e70: 70 74 68 20 6c 69 6d 69 74 20 6f 66 20 31 32 20 pth limit of 12
2e80: 69 73 20 73 75 66 66 69 63 69 65 6e 74 20 66 6f is sufficient fo
2e90: 72 20 75 70 20 74 6f 20 34 30 39 35 20 6f 72 64 r up to 4095 ord
2ea0: 69 6e 61 72 79 0a 20 20 74 65 72 6d 73 20 6f 6e inary. terms on
2eb0: 20 61 20 4d 41 54 43 48 2c 20 69 74 20 69 73 20 a MATCH, it is
2ec0: 6f 6e 6c 79 20 73 75 66 66 69 63 69 65 6e 74 20 only sufficient
2ed0: 66 6f 72 20 31 31 20 6f 72 20 31 32 20 70 68 72 for 11 or 12 phr
2ee0: 61 73 65 20 6f 72 20 4e 45 41 52 0a 20 20 74 65 ase or NEAR. te
2ef0: 72 6d 73 2e 20 20 45 76 65 6e 20 73 6f 2c 20 74 rms. Even so, t
2f00: 68 65 20 64 65 66 61 75 6c 74 20 69 73 20 6d 6f he default is mo
2f10: 72 65 20 74 68 61 6e 20 65 6e 6f 75 67 68 20 66 re than enough f
2f20: 6f 72 20 6d 6f 73 74 20 61 70 70 6c 69 63 61 74 or most applicat
2f30: 69 6f 6e 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f ion..}..COMPILE_
2f40: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4d OPTION {SQLITE_M
2f50: 41 58 5f 4d 4d 41 50 5f 53 49 5a 45 3d 3c 69 3e AX_MMAP_SIZE=<i>
2f60: 4e 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 69 73 20 N</i>} {. This
2f70: 6d 61 63 72 6f 20 73 65 74 73 20 61 20 68 61 72 macro sets a har
2f80: 64 20 75 70 70 65 72 20 62 6f 75 6e 64 20 6f 6e d upper bound on
2f90: 20 74 68 65 20 61 6d 6f 75 6e 74 20 6f 66 20 61 the amount of a
2fa0: 64 64 72 65 73 73 20 73 70 61 63 65 20 74 68 61 ddress space tha
2fb0: 74 0a 20 20 63 61 6e 20 62 65 20 75 73 65 64 20 t. can be used
2fc0: 62 79 20 61 6e 79 20 73 69 6e 67 6c 65 20 64 61 by any single da
2fd0: 74 61 62 61 73 65 20 66 6f 72 20 6d 65 6d 6f 72 tabase for memor
2fe0: 79 2d 6d 61 70 70 65 64 20 49 2f 4f 2e 0a 20 20 y-mapped I/O..
2ff0: 53 65 74 74 69 6e 67 20 74 68 69 73 20 76 61 6c Setting this val
3000: 75 65 20 74 6f 20 30 20 63 6f 6d 70 6c 65 74 65 ue to 0 complete
3010: 6c 79 20 64 69 73 61 62 6c 65 73 20 6d 65 6d 6f ly disables memo
3020: 72 79 2d 6d 61 70 70 65 64 20 49 2f 4f 20 61 6e ry-mapped I/O an
3030: 64 0a 20 20 63 61 75 73 65 73 20 6c 6f 67 69 63 d. causes logic
3040: 20 61 73 73 6f 63 69 61 74 65 64 20 77 69 74 68 associated with
3050: 20 6d 65 6d 6f 72 79 2d 6d 61 70 70 65 64 20 49 memory-mapped I
3060: 2f 4f 20 74 6f 20 62 65 20 6f 6d 69 74 74 65 64 /O to be omitted
3070: 20 66 72 6f 6d 20 74 68 65 0a 20 20 62 75 69 6c from the. buil
3080: 64 2e 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 d. This option
3090: 64 6f 65 73 20 63 68 61 6e 67 65 20 74 68 65 20 does change the
30a0: 64 65 66 61 75 6c 74 20 6d 65 6d 6f 72 79 2d 6d default memory-m
30b0: 61 70 70 65 64 20 49 2f 4f 20 61 64 64 72 65 73 apped I/O addres
30c0: 73 0a 20 20 73 70 61 63 65 20 73 69 7a 65 20 28 s. space size (
30d0: 73 65 74 20 62 79 20 5b 53 51 4c 49 54 45 5f 44 set by [SQLITE_D
30e0: 45 46 41 55 4c 54 5f 4d 4d 41 50 5f 53 49 5a 45 EFAULT_MMAP_SIZE
30f0: 5d 20 6f 72 0a 20 20 73 71 6c 69 74 65 33 5f 63 ] or. sqlite3_c
3100: 6f 6e 66 69 67 28 5b 53 51 4c 49 54 45 5f 43 4f onfig([SQLITE_CO
3110: 4e 46 49 47 5f 4d 4d 41 50 5f 53 49 5a 45 5d 29 NFIG_MMAP_SIZE])
3120: 20 6f 72 20 74 68 65 0a 20 20 72 75 6e 2d 74 69 or the. run-ti
3130: 6d 65 20 6d 65 6d 6f 72 79 2d 6d 61 70 70 65 64 me memory-mapped
3140: 20 49 2f 4f 20 61 64 64 72 65 73 73 20 73 70 61 I/O address spa
3150: 63 65 20 73 69 7a 65 20 28 73 65 74 20 62 79 0a ce size (set by.
3160: 20 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 5f 63 sqlite3_file_c
3170: 6f 6e 74 72 6f 6c 28 5b 53 51 4c 49 54 45 5f 46 ontrol([SQLITE_F
3180: 43 4e 54 4c 5f 4d 4d 41 50 5f 53 49 5a 45 5d 29 CNTL_MMAP_SIZE])
3190: 20 6f 72 0a 20 20 5b 50 52 41 47 4d 41 20 6d 6d or. [PRAGMA mm
31a0: 61 70 5f 73 69 7a 65 5d 29 20 61 73 20 6c 6f 6e ap_size]) as lon
31b0: 67 20 61 73 20 74 68 6f 73 65 20 6f 74 68 65 72 g as those other
31c0: 20 73 65 74 74 69 6e 67 73 20 61 72 65 20 6c 65 settings are le
31d0: 73 73 20 74 68 61 6e 20 74 68 65 0a 20 20 6d 61 ss than the. ma
31e0: 78 69 6d 75 6d 20 76 61 6c 75 65 20 64 65 66 69 ximum value defi
31f0: 6e 65 64 20 68 65 72 65 2e 0a 7d 0a 0a 43 4f 4d ned here..}..COM
3200: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c PILE_OPTION {SQL
3210: 49 54 45 5f 4d 41 58 5f 53 43 48 45 4d 41 5f 52 ITE_MAX_SCHEMA_R
3220: 45 54 52 59 3d 3c 69 3e 4e 3c 2f 69 3e 7d 20 7b ETRY=<i>N</i>} {
3230: 0a 20 20 57 68 65 6e 65 76 65 72 20 74 68 65 20 . Whenever the
3240: 64 61 74 61 62 61 73 65 20 73 63 68 65 6d 61 20 database schema
3250: 63 68 61 6e 67 65 73 2c 20 70 72 65 70 61 72 65 changes, prepare
3260: 64 20 73 74 61 74 65 6d 65 6e 74 73 20 61 72 65 d statements are
3270: 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 0a 20 automatically.
3280: 20 72 65 70 72 65 70 61 72 65 64 20 74 6f 20 61 reprepared to a
3290: 63 63 6f 6d 6d 6f 64 61 74 65 20 74 68 65 20 6e ccommodate the n
32a0: 65 77 20 73 63 68 65 6d 61 2e 20 20 54 68 65 72 ew schema. Ther
32b0: 65 20 69 73 20 61 20 72 61 63 65 20 63 6f 6e 64 e is a race cond
32c0: 69 74 69 6f 6e 20 68 65 72 65 0a 20 20 69 6e 20 ition here. in
32d0: 74 68 61 74 20 69 66 20 6f 6e 65 20 74 68 72 65 that if one thre
32e0: 61 64 20 69 73 20 63 6f 6e 73 74 61 6e 74 6c 79 ad is constantly
32f0: 20 63 68 61 6e 67 69 6e 67 20 74 68 65 20 73 63 changing the sc
3300: 68 65 6d 61 2c 20 61 6e 6f 74 68 65 72 20 74 68 hema, another th
3310: 72 65 61 64 0a 20 20 6d 69 67 68 74 20 73 70 69 read. might spi
3320: 6e 20 6f 6e 20 72 65 70 61 72 73 65 73 20 61 6e n on reparses an
3330: 64 20 72 65 70 72 65 70 61 72 61 74 69 6f 6e 73 d repreparations
3340: 20 6f 66 20 61 20 70 72 65 70 61 72 65 64 20 73 of a prepared s
3350: 74 61 74 65 6d 65 6e 74 20 61 6e 64 0a 20 20 6e tatement and. n
3360: 65 76 65 72 20 67 65 74 20 61 6e 79 20 72 65 61 ever get any rea
3370: 6c 20 77 6f 72 6b 20 64 6f 6e 65 2e 20 20 54 68 l work done. Th
3380: 69 73 20 70 61 72 61 6d 65 74 65 72 20 70 72 65 is parameter pre
3390: 76 65 6e 74 73 20 61 6e 20 69 6e 66 69 6e 69 74 vents an infinit
33a0: 65 20 6c 6f 6f 70 0a 20 20 62 79 20 66 6f 72 63 e loop. by forc
33b0: 69 6e 67 20 74 68 65 20 73 70 69 6e 6e 69 6e 67 ing the spinning
33c0: 20 74 68 72 65 61 64 20 74 6f 20 67 69 76 65 20 thread to give
33d0: 75 70 20 61 66 74 65 72 20 61 20 66 69 78 65 64 up after a fixed
33e0: 20 6e 75 6d 62 65 72 20 6f 66 20 61 74 74 65 6d number of attem
33f0: 70 74 73 0a 20 20 61 74 20 72 65 63 6f 6d 70 69 pts. at recompi
3400: 6c 69 6e 67 20 74 68 65 20 70 72 65 70 61 72 65 ling the prepare
3410: 64 20 73 74 61 74 65 6d 65 6e 74 2e 20 20 54 68 d statement. Th
3420: 65 20 64 65 66 61 75 6c 74 20 73 65 74 74 69 6e e default settin
3430: 67 20 69 73 20 35 30 20 77 68 69 63 68 20 69 73 g is 50 which is
3440: 0a 20 20 6d 6f 72 65 20 74 68 61 6e 20 61 64 65 . more than ade
3450: 71 75 61 74 65 20 66 6f 72 20 6d 6f 73 74 20 61 quate for most a
3460: 70 70 6c 69 63 61 74 69 6f 6e 73 2e 0a 7d 0a 0a pplications..}..
3470: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
3480: 53 51 4c 49 54 45 5f 4d 41 58 5f 57 4f 52 4b 45 SQLITE_MAX_WORKE
3490: 52 5f 54 48 52 45 41 44 53 3d 3c 69 3e 4e 3c 2f R_THREADS=<i>N</
34a0: 69 3e 7d 20 7b 0a 20 20 53 65 74 20 61 6e 20 75 i>} {. Set an u
34b0: 70 70 65 72 20 62 6f 75 6e 64 20 6f 6e 20 74 68 pper bound on th
34c0: 65 20 5b 73 71 6c 69 74 65 33 5f 6c 69 6d 69 74 e [sqlite3_limit
34d0: 5d 28 64 62 2c 5b 53 51 4c 49 54 45 5f 4c 49 4d ](db,[SQLITE_LIM
34e0: 49 54 5f 57 4f 52 4b 45 52 5f 54 48 52 45 41 44 IT_WORKER_THREAD
34f0: 53 5d 2c 4e 29 0a 20 20 73 65 74 74 69 6e 67 20 S],N). setting
3500: 74 68 61 74 20 64 65 74 65 72 6d 69 6e 65 73 20 that determines
3510: 74 68 65 20 6d 61 78 69 6d 75 6d 20 6e 75 6d 62 the maximum numb
3520: 65 72 20 6f 66 20 61 75 78 69 6c 69 61 72 79 20 er of auxiliary
3530: 74 68 72 65 61 64 73 20 74 68 61 74 20 61 20 73 threads that a s
3540: 69 6e 67 6c 65 0a 20 20 5b 70 72 65 70 61 72 65 ingle. [prepare
3550: 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 77 69 6c d statement] wil
3560: 6c 20 75 73 65 20 74 6f 20 61 69 64 20 77 69 74 l use to aid wit
3570: 68 20 43 50 55 2d 69 6e 74 65 6e 73 69 76 65 20 h CPU-intensive
3580: 63 6f 6d 70 75 74 61 74 69 6f 6e 73 0a 20 20 28 computations. (
3590: 6d 6f 73 74 6c 79 20 73 6f 72 74 69 6e 67 29 2e mostly sorting).
35a0: 20 20 53 65 65 20 61 6c 73 6f 20 74 68 65 20 5b See also the [
35b0: 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f 57 SQLITE_DEFAULT_W
35c0: 4f 52 4b 45 52 5f 54 48 52 45 41 44 53 5d 20 6f ORKER_THREADS] o
35d0: 70 74 69 6f 6e 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 ptions..}..COMPI
35e0: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
35f0: 45 5f 4d 49 4e 49 4d 55 4d 5f 46 49 4c 45 5f 44 E_MINIMUM_FILE_D
3600: 45 53 43 52 49 50 54 4f 52 3d 3c 69 3e 4e 3c 2f ESCRIPTOR=<i>N</
3610: 69 3e 7d 20 7b 0a 20 20 54 68 65 20 75 6e 69 78 i>} {. The unix
3620: 20 5b 56 46 53 5d 20 77 69 6c 6c 20 6e 65 76 65 [VFS] will neve
3630: 72 20 75 73 65 20 61 20 66 69 6c 65 20 64 65 73 r use a file des
3640: 63 72 69 70 74 6f 72 20 6c 65 73 73 20 74 68 61 criptor less tha
3650: 6e 20 3c 69 3e 4e 3c 2f 69 3e 2e 20 20 54 68 65 n <i>N</i>. The
3660: 0a 20 20 64 65 66 61 75 6c 74 20 76 61 6c 75 65 . default value
3670: 20 6f 66 20 3c 69 3e 4e 3c 2f 69 3e 20 69 73 20 of <i>N</i> is
3680: 33 2e 0a 20 20 3c 70 3e 0a 20 20 41 76 6f 69 64 3.. <p>. Avoid
3690: 69 6e 67 20 74 68 65 20 75 73 65 20 6f 66 20 6c ing the use of l
36a0: 6f 77 2d 6e 75 6d 62 65 72 65 64 20 66 69 6c 65 ow-numbered file
36b0: 20 64 65 73 63 72 69 70 74 6f 72 73 20 69 73 20 descriptors is
36c0: 61 20 64 65 66 65 6e 73 65 20 61 67 61 69 6e 73 a defense agains
36d0: 74 0a 20 20 61 63 63 69 64 65 6e 74 61 6c 20 64 t. accidental d
36e0: 61 74 61 62 61 73 65 20 63 6f 72 72 75 70 74 69 atabase corrupti
36f0: 6f 6e 2e 20 20 49 66 20 61 20 64 61 74 61 62 61 on. If a databa
3700: 73 65 20 66 69 6c 65 20 77 61 73 20 6f 70 65 6e se file was open
3710: 65 64 20 75 73 69 6e 67 0a 20 20 66 69 6c 65 20 ed using. file
3720: 64 65 73 63 72 69 70 74 6f 72 20 32 2c 20 66 6f descriptor 2, fo
3730: 72 20 65 78 61 6d 70 6c 65 2c 20 61 6e 64 20 74 r example, and t
3740: 68 65 6e 20 61 6e 20 61 73 73 65 72 74 28 29 20 hen an assert()
3750: 66 61 69 6c 65 64 20 61 6e 64 20 69 6e 76 6f 6b failed and invok
3760: 65 64 0a 20 20 77 72 69 74 65 28 32 2c 2e 2e 2e ed. write(2,...
3770: 29 2c 20 74 68 61 74 20 77 6f 75 6c 64 20 6c 69 ), that would li
3780: 6b 65 6c 79 20 63 61 75 73 65 20 64 61 74 61 62 kely cause datab
3790: 61 73 65 20 63 6f 72 72 75 70 74 69 6f 6e 20 62 ase corruption b
37a0: 79 20 6f 76 65 72 77 72 69 74 69 6e 67 0a 20 20 y overwriting.
37b0: 70 61 72 74 20 6f 66 20 74 68 65 20 64 61 74 61 part of the data
37c0: 62 61 73 65 20 66 69 6c 65 20 77 69 74 68 20 74 base file with t
37d0: 68 65 20 61 73 73 65 72 74 69 6f 6e 20 65 72 72 he assertion err
37e0: 6f 72 20 6d 65 73 73 61 67 65 2e 20 20 55 73 69 or message. Usi
37f0: 6e 67 20 6f 6e 6c 79 0a 20 20 68 69 67 68 65 72 ng only. higher
3800: 2d 76 61 6c 75 65 64 20 66 69 6c 65 20 64 65 73 -valued file des
3810: 63 72 69 70 74 6f 72 73 20 61 76 6f 69 64 73 20 criptors avoids
3820: 74 68 69 73 20 70 6f 74 65 6e 74 69 61 6c 20 70 this potential p
3830: 72 6f 62 6c 65 6d 2e 20 20 54 68 65 20 0a 20 20 roblem. The .
3840: 70 72 6f 74 65 63 74 69 6f 6e 20 61 67 61 69 6e protection again
3850: 73 74 0a 20 20 75 73 69 6e 67 20 6c 6f 77 2d 6e st. using low-n
3860: 75 6d 62 65 72 65 64 20 66 69 6c 65 20 64 65 73 umbered file des
3870: 63 72 69 70 74 6f 72 73 20 63 61 6e 20 62 65 20 criptors can be
3880: 64 69 73 61 62 6c 65 64 20 62 79 20 73 65 74 74 disabled by sett
3890: 69 6e 67 20 74 68 69 73 0a 20 20 63 6f 6d 70 69 ing this. compi
38a0: 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20 74 le-time option t
38b0: 6f 20 30 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f o 0..}..COMPILE_
38c0: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 50 OPTION {SQLITE_P
38d0: 4f 57 45 52 53 41 46 45 5f 4f 56 45 52 57 52 49 OWERSAFE_OVERWRI
38e0: 54 45 3d 3c 69 3e 26 6c 74 3b 30 20 6f 72 20 31 TE=<i><0 or 1
38f0: 26 67 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 ></i>} {. Th
3900: 69 73 20 6f 70 74 69 6f 6e 20 63 68 61 6e 67 65 is option change
3910: 73 20 74 68 65 20 64 65 66 61 75 6c 74 20 61 73 s the default as
3920: 73 75 6d 70 74 69 6f 6e 20 61 62 6f 75 74 20 5b sumption about [
3930: 70 6f 77 65 72 73 61 66 65 20 6f 76 65 72 77 72 powersafe overwr
3940: 69 74 65 5d 0a 20 20 66 6f 72 20 74 68 65 20 75 ite]. for the u
3950: 6e 64 65 72 6c 79 69 6e 67 20 66 69 6c 65 73 79 nderlying filesy
3960: 73 74 65 6d 73 20 66 6f 72 20 74 68 65 20 75 6e stems for the un
3970: 69 78 20 61 6e 64 20 77 69 6e 64 6f 77 73 20 5b ix and windows [
3980: 56 46 53 65 73 5d 2e 0a 20 20 53 65 74 74 69 6e VFSes].. Settin
3990: 67 20 53 51 4c 49 54 45 5f 50 4f 57 45 52 53 41 g SQLITE_POWERSA
39a0: 46 45 5f 4f 56 45 52 57 52 49 54 45 20 74 6f 20 FE_OVERWRITE to
39b0: 31 20 63 61 75 73 65 73 20 53 51 4c 69 74 65 20 1 causes SQLite
39c0: 74 6f 20 61 73 73 75 6d 65 20 74 68 61 74 0a 20 to assume that.
39d0: 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d 6c 65 76 application-lev
39e0: 65 6c 20 77 72 69 74 65 73 20 63 61 6e 6e 6f 74 el writes cannot
39f0: 20 63 68 61 6e 67 65 73 20 62 79 74 65 73 20 6f changes bytes o
3a00: 75 74 73 69 64 65 20 74 68 65 20 72 61 6e 67 65 utside the range
3a10: 20 6f 66 0a 20 20 62 79 74 65 73 20 77 72 69 74 of. bytes writ
3a20: 74 65 6e 20 65 76 65 6e 20 69 66 20 74 68 65 20 ten even if the
3a30: 77 72 69 74 65 20 6f 63 63 75 72 73 20 6a 75 73 write occurs jus
3a40: 74 20 62 65 66 6f 72 65 20 61 20 70 6f 77 65 72 t before a power
3a50: 20 6c 6f 73 73 2e 0a 20 20 57 69 74 68 20 53 51 loss.. With SQ
3a60: 4c 49 54 45 5f 50 4f 57 45 52 53 41 46 45 5f 4f LITE_POWERSAFE_O
3a70: 56 45 52 57 52 49 54 45 20 73 65 74 20 74 6f 20 VERWRITE set to
3a80: 30 2c 20 53 51 4c 69 74 65 20 61 73 73 75 6d 65 0, SQLite assume
3a90: 73 20 74 68 61 74 20 6f 74 68 65 72 0a 20 20 62 s that other. b
3aa0: 79 74 65 73 20 69 6e 20 74 68 65 20 73 61 6d 65 ytes in the same
3ab0: 20 73 65 63 74 6f 72 20 77 69 74 68 20 61 20 77 sector with a w
3ac0: 72 69 74 74 65 6e 20 62 79 74 65 20 6d 69 67 68 ritten byte migh
3ad0: 74 20 62 65 20 63 68 61 6e 67 65 64 20 6f 72 20 t be changed or
3ae0: 0a 20 20 64 61 6d 61 67 65 64 20 62 79 20 61 20 . damaged by a
3af0: 70 6f 77 65 72 20 6c 6f 73 73 2e 0a 7d 0a 0a 43 power loss..}..C
3b00: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
3b10: 51 4c 49 54 45 5f 52 45 56 45 52 53 45 5f 55 4e QLITE_REVERSE_UN
3b20: 4f 52 44 45 52 45 44 5f 53 45 4c 45 43 54 53 7d ORDERED_SELECTS}
3b30: 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e {. This option
3b40: 20 63 61 75 73 65 73 20 74 68 65 20 5b 50 52 41 causes the [PRA
3b50: 47 4d 41 20 72 65 76 65 72 73 65 5f 75 6e 6f 72 GMA reverse_unor
3b60: 64 65 72 65 64 5f 73 65 6c 65 63 74 73 5d 20 73 dered_selects] s
3b70: 65 74 74 69 6e 67 20 74 6f 20 62 65 0a 20 20 65 etting to be. e
3b80: 6e 61 62 6c 65 64 20 62 79 20 64 65 66 61 75 6c nabled by defaul
3b90: 74 2e 20 20 57 68 65 6e 20 65 6e 61 62 6c 65 64 t. When enabled
3ba0: 2c 20 5b 53 45 4c 45 43 54 5d 20 73 74 61 74 65 , [SELECT] state
3bb0: 6d 65 6e 74 73 20 74 68 61 74 20 6c 61 63 6b 20 ments that lack
3bc0: 61 6e 0a 20 20 4f 52 44 45 52 20 42 59 20 63 6c an. ORDER BY cl
3bd0: 61 75 73 65 20 77 69 6c 6c 20 72 75 6e 20 69 6e ause will run in
3be0: 20 72 65 76 65 72 73 65 20 6f 72 64 65 72 2e 3c reverse order.<
3bf0: 70 3e 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e p>. This option
3c00: 20 69 73 20 75 73 65 66 75 6c 20 66 6f 72 20 64 is useful for d
3c10: 65 74 65 63 74 69 6e 67 20 77 68 65 6e 20 61 70 etecting when ap
3c20: 70 6c 69 63 61 74 69 6f 6e 73 20 28 69 6e 63 6f plications (inco
3c30: 72 72 65 63 74 6c 79 29 0a 20 20 61 73 73 75 6d rrectly). assum
3c40: 65 20 74 68 61 74 20 74 68 65 20 6f 72 64 65 72 e that the order
3c50: 20 6f 66 20 72 6f 77 73 20 69 6e 20 61 20 53 45 of rows in a SE
3c60: 4c 45 43 54 20 77 69 74 68 6f 75 74 20 61 6e 20 LECT without an
3c70: 4f 52 44 45 52 20 42 59 20 63 6c 61 75 73 65 0a ORDER BY clause.
3c80: 20 20 77 69 6c 6c 20 61 6c 77 61 79 73 20 62 65 will always be
3c90: 20 74 68 65 20 73 61 6d 65 2e 0a 7d 0a 0a 43 4f the same..}..CO
3ca0: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 MPILE_OPTION {SQ
3cb0: 4c 49 54 45 5f 53 4f 52 54 45 52 5f 50 4d 41 53 LITE_SORTER_PMAS
3cc0: 5a 3d 3c 69 3e 4e 3c 2f 69 3e 7d 20 7b 0a 20 20 Z=<i>N</i>} {.
3cd0: 49 66 20 6d 75 6c 74 69 2d 74 68 72 65 61 64 65 If multi-threade
3ce0: 64 20 70 72 6f 63 65 73 73 69 6e 67 20 69 73 20 d processing is
3cf0: 65 6e 61 62 6c 65 64 20 76 69 61 20 74 68 65 0a enabled via the.
3d00: 20 20 5b 50 52 41 47 4d 41 20 74 68 72 65 61 64 [PRAGMA thread
3d10: 73 5d 20 73 65 74 74 69 6e 67 2c 20 74 68 65 6e s] setting, then
3d20: 20 73 6f 72 74 20 6f 70 65 72 61 74 69 6f 6e 73 sort operations
3d30: 20 77 69 6c 6c 0a 20 20 61 74 74 65 6d 70 74 20 will. attempt
3d40: 74 6f 20 73 74 61 72 74 20 68 65 6c 70 65 72 20 to start helper
3d50: 74 68 72 65 61 64 73 20 77 68 65 6e 20 74 68 65 threads when the
3d60: 20 61 6d 6f 75 6e 74 20 6f 66 20 63 6f 6e 74 65 amount of conte
3d70: 6e 74 0a 20 20 74 6f 20 62 65 20 73 6f 72 74 65 nt. to be sorte
3d80: 64 20 65 78 63 65 65 64 73 20 74 68 65 20 6d 69 d exceeds the mi
3d90: 6e 69 6d 75 6d 20 6f 66 20 74 68 65 20 5b 63 61 nimum of the [ca
3da0: 63 68 65 5f 73 69 7a 65 5d 20 61 6e 64 20 50 4d che_size] and PM
3db0: 41 20 53 69 7a 65 0a 20 20 64 65 74 65 72 6d 69 A Size. determi
3dc0: 6e 65 64 20 62 79 20 74 68 65 20 5b 53 51 4c 49 ned by the [SQLI
3dd0: 54 45 5f 43 4f 4e 46 49 47 5f 50 4d 41 53 5a 5d TE_CONFIG_PMASZ]
3de0: 20 73 74 61 72 74 2d 74 69 6d 65 20 6f 70 74 69 start-time opti
3df0: 6f 6e 2e 0a 20 20 54 68 69 73 20 63 6f 6d 70 69 on.. This compi
3e00: 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20 73 le-time option s
3e10: 65 74 73 20 74 68 65 20 64 65 66 61 75 6c 74 20 ets the default
3e20: 76 61 6c 75 65 20 66 6f 72 20 74 68 65 0a 20 20 value for the.
3e30: 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 [SQLITE_CONFIG_P
3e40: 4d 41 53 5a 5d 20 73 74 61 72 74 2d 74 69 6d 65 MASZ] start-time
3e50: 20 6f 70 74 69 6f 6e 2e 0a 20 20 54 68 65 20 64 option.. The d
3e60: 65 66 61 75 6c 74 20 76 61 6c 75 65 20 69 73 20 efault value is
3e70: 32 35 30 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 250..}..COMPILE_
3e80: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 57 OPTION {SQLITE_W
3e90: 49 4e 33 32 5f 4d 41 4c 4c 4f 43 7d 20 7b 0a 20 IN32_MALLOC} {.
3ea0: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 65 6e 61 This option ena
3eb0: 62 6c 65 73 20 74 68 65 20 75 73 65 20 6f 66 20 bles the use of
3ec0: 74 68 65 20 57 69 6e 64 6f 77 73 20 48 65 61 70 the Windows Heap
3ed0: 20 41 50 49 20 66 75 6e 63 74 69 6f 6e 73 20 66 API functions f
3ee0: 6f 72 20 6d 65 6d 6f 72 79 0a 20 20 61 6c 6c 6f or memory. allo
3ef0: 63 61 74 69 6f 6e 20 69 6e 73 74 65 61 64 20 6f cation instead o
3f00: 66 20 74 68 65 20 73 74 61 6e 64 61 72 64 20 6c f the standard l
3f10: 69 62 72 61 72 79 20 6d 61 6c 6c 6f 63 28 29 20 ibrary malloc()
3f20: 61 6e 64 20 66 72 65 65 28 29 20 72 6f 75 74 69 and free() routi
3f30: 6e 65 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f nes..}..COMPILE_
3f40: 4f 50 54 49 4f 4e 20 7b 59 59 53 54 41 43 4b 44 OPTION {YYSTACKD
3f50: 45 50 54 48 3d 3c 69 3e 26 6c 74 3b 6d 61 78 5f EPTH=<i><max_
3f60: 64 65 70 74 68 26 67 74 3b 3c 2f 69 3e 7d 20 7b depth></i>} {
3f70: 0a 20 20 54 68 69 73 20 6d 61 63 72 6f 20 73 65 . This macro se
3f80: 74 73 20 74 68 65 20 6d 61 78 69 6d 75 6d 20 64 ts the maximum d
3f90: 65 70 74 68 20 6f 66 20 74 68 65 20 4c 41 4c 52 epth of the LALR
3fa0: 28 31 29 20 73 74 61 63 6b 20 75 73 65 64 20 62 (1) stack used b
3fb0: 79 0a 20 20 74 68 65 20 53 51 4c 20 70 61 72 73 y. the SQL pars
3fc0: 65 72 20 77 69 74 68 69 6e 20 53 51 4c 69 74 65 er within SQLite
3fd0: 2e 20 20 54 68 65 20 64 65 66 61 75 6c 74 20 76 . The default v
3fe0: 61 6c 75 65 20 69 73 20 31 30 30 2e 20 20 41 20 alue is 100. A
3ff0: 74 79 70 69 63 61 6c 0a 20 20 61 70 70 6c 69 63 typical. applic
4000: 61 74 69 6f 6e 20 77 69 6c 6c 20 75 73 65 20 6c ation will use l
4010: 65 73 73 20 74 68 61 6e 20 61 62 6f 75 74 20 32 ess than about 2
4020: 30 20 6c 65 76 65 6c 73 20 6f 66 20 74 68 65 20 0 levels of the
4030: 73 74 61 63 6b 2e 0a 20 20 44 65 76 65 6c 6f 70 stack.. Develop
4040: 65 72 73 20 77 68 6f 73 65 20 61 70 70 6c 69 63 ers whose applic
4050: 61 74 69 6f 6e 73 20 63 6f 6e 74 61 69 6e 20 53 ations contain S
4060: 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 20 74 68 QL statements th
4070: 61 74 20 0a 20 20 6e 65 65 64 20 6d 6f 72 65 20 at . need more
4080: 74 68 61 6e 20 31 30 30 20 4c 41 4c 52 28 31 29 than 100 LALR(1)
4090: 20 73 74 61 63 6b 20 65 6e 74 72 69 65 73 20 73 stack entries s
40a0: 68 6f 75 6c 64 20 73 65 72 69 6f 75 73 6c 79 0a hould seriously.
40b0: 20 20 63 6f 6e 73 69 64 65 72 20 72 65 66 61 63 consider refac
40c0: 74 6f 72 69 6e 67 20 74 68 65 69 72 20 53 51 4c toring their SQL
40d0: 20 61 73 20 69 74 20 69 73 20 6c 69 6b 65 6c 79 as it is likely
40e0: 20 74 6f 20 62 65 20 77 65 6c 6c 20 62 65 79 6f to be well beyo
40f0: 6e 64 0a 20 20 74 68 65 20 61 62 69 6c 69 74 79 nd. the ability
4100: 20 6f 66 20 61 6e 79 20 68 75 6d 61 6e 20 74 6f of any human to
4110: 20 63 6f 6d 70 72 65 68 65 6e 64 2e 0a 7d 0a 3c comprehend..}.<
4120: 2f 74 63 6c 3e 0a 0a 3c 68 32 3e 31 2e 33 20 4f /tcl>..<h2>1.3 O
4130: 70 74 69 6f 6e 73 20 54 6f 20 53 65 74 20 53 69 ptions To Set Si
4140: 7a 65 20 4c 69 6d 69 74 73 3c 2f 68 32 3e 0a 0a ze Limits</h2>..
4150: 3c 70 3e 54 68 65 72 65 20 61 72 65 20 63 6f 6d <p>There are com
4160: 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e pile-time option
4170: 73 20 74 68 61 74 20 77 69 6c 6c 20 73 65 74 20 s that will set
4180: 75 70 70 65 72 20 62 6f 75 6e 64 73 0a 6f 6e 20 upper bounds.on
4190: 74 68 65 20 73 69 7a 65 73 20 6f 66 20 76 61 72 the sizes of var
41a0: 69 6f 75 73 20 73 74 72 75 63 74 75 72 65 73 20 ious structures
41b0: 69 6e 20 53 51 4c 69 74 65 2e 20 20 54 68 65 20 in SQLite. The
41c0: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 0a 6f 70 74 compile-time.opt
41d0: 69 6f 6e 73 20 6e 6f 72 6d 61 6c 6c 79 20 73 65 ions normally se
41e0: 74 20 61 20 68 61 72 64 20 75 70 70 65 72 20 62 t a hard upper b
41f0: 6f 75 6e 64 20 74 68 61 74 20 63 61 6e 20 62 65 ound that can be
4200: 20 63 68 61 6e 67 65 64 0a 61 74 20 72 75 6e 2d changed.at run-
4210: 74 69 6d 65 20 6f 6e 20 69 6e 64 69 76 69 64 75 time on individu
4220: 61 6c 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e al [database con
4230: 6e 65 63 74 69 6f 6e 73 5d 20 75 73 69 6e 67 20 nections] using
4240: 74 68 65 0a 5b 73 71 6c 69 74 65 33 5f 6c 69 6d the.[sqlite3_lim
4250: 69 74 28 29 5d 20 69 6e 74 65 72 66 61 63 65 2e it()] interface.
4260: 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 63 6f 6d </p>..<p>The com
4270: 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e pile-time option
4280: 73 20 66 6f 72 20 73 65 74 74 69 6e 67 20 75 70 s for setting up
4290: 70 65 72 20 62 6f 75 6e 64 73 20 61 72 65 0a 5b per bounds are.[
42a0: 6c 69 6d 69 74 73 20 7c 20 64 6f 63 75 6d 65 6e limits | documen
42b0: 74 65 64 20 73 65 70 61 72 61 74 65 6c 79 5d 2e ted separately].
42c0: 20 20 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 The following
42d0: 69 73 20 61 20 6c 69 73 74 20 6f 66 0a 74 68 65 is a list of.the
42e0: 20 61 76 61 69 6c 61 62 6c 65 20 73 65 74 74 69 available setti
42f0: 6e 67 73 3a 3c 2f 70 3e 0a 0a 3c 75 6c 3e 0a 3c ngs:</p>..<ul>.<
4300: 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4d 41 58 5f li> [SQLITE_MAX_
4310: 41 54 54 41 43 48 45 44 5d 20 20 3c 2f 6c 69 3e ATTACHED] </li>
4320: 0a 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4d 41 .<li> [SQLITE_MA
4330: 58 5f 43 4f 4c 55 4d 4e 5d 20 20 3c 2f 6c 69 3e X_COLUMN] </li>
4340: 0a 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4d 41 .<li> [SQLITE_MA
4350: 58 5f 43 4f 4d 50 4f 55 4e 44 5f 53 45 4c 45 43 X_COMPOUND_SELEC
4360: 54 5d 20 20 3c 2f 6c 69 3e 0a 3c 6c 69 3e 20 5b T] </li>.<li> [
4370: 53 51 4c 49 54 45 5f 4d 41 58 5f 45 58 50 52 5f SQLITE_MAX_EXPR_
4380: 44 45 50 54 48 5d 20 20 3c 2f 6c 69 3e 0a 3c 6c DEPTH] </li>.<l
4390: 69 3e 20 5b 53 51 4c 49 54 45 5f 4d 41 58 5f 46 i> [SQLITE_MAX_F
43a0: 55 4e 43 54 49 4f 4e 5f 41 52 47 5d 20 20 3c 2f UNCTION_ARG] </
43b0: 6c 69 3e 0a 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 li>.<li> [SQLITE
43c0: 5f 4d 41 58 5f 4c 45 4e 47 54 48 5d 20 20 3c 2f _MAX_LENGTH] </
43d0: 6c 69 3e 0a 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 li>.<li> [SQLITE
43e0: 5f 4d 41 58 5f 4c 49 4b 45 5f 50 41 54 54 45 52 _MAX_LIKE_PATTER
43f0: 4e 5f 4c 45 4e 47 54 48 5d 20 20 3c 2f 6c 69 3e N_LENGTH] </li>
4400: 0a 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4d 41 .<li> [SQLITE_MA
4410: 58 5f 50 41 47 45 5f 43 4f 55 4e 54 5d 20 20 3c X_PAGE_COUNT] <
4420: 2f 6c 69 3e 0a 3c 6c 69 3e 20 5b 53 51 4c 49 54 /li>.<li> [SQLIT
4430: 45 5f 4d 41 58 5f 53 51 4c 5f 4c 45 4e 47 54 48 E_MAX_SQL_LENGTH
4440: 5d 20 20 3c 2f 6c 69 3e 0a 3c 6c 69 3e 20 5b 53 ] </li>.<li> [S
4450: 51 4c 49 54 45 5f 4d 41 58 5f 56 41 52 49 41 42 QLITE_MAX_VARIAB
4460: 4c 45 5f 4e 55 4d 42 45 52 5d 20 20 3c 2f 6c 69 LE_NUMBER] </li
4470: 3e 0a 3c 2f 75 6c 3e 0a 0a 3c 61 20 6e 61 6d 65 >.</ul>..<a name
4480: 3d 22 63 6f 6e 74 72 6f 6c 66 65 61 74 75 72 65 ="controlfeature
4490: 73 22 3e 3c 2f 61 3e 0a 3c 68 32 3e 31 2e 34 20 s"></a>.<h2>1.4
44a0: 4f 70 74 69 6f 6e 73 20 54 6f 20 43 6f 6e 74 72 Options To Contr
44b0: 6f 6c 20 4f 70 65 72 61 74 69 6e 67 20 43 68 61 ol Operating Cha
44c0: 72 61 63 74 65 72 69 73 74 69 63 73 3c 2f 68 32 racteristics</h2
44d0: 3e 0a 0a 3c 74 63 6c 3e 0a 43 4f 4d 50 49 4c 45 >..<tcl>.COMPILE
44e0: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
44f0: 34 5f 42 59 54 45 5f 41 4c 49 47 4e 45 44 5f 4d 4_BYTE_ALIGNED_M
4500: 41 4c 4c 4f 43 7d 20 7b 0a 20 20 4f 6e 20 6d 6f ALLOC} {. On mo
4510: 73 74 20 73 79 73 74 65 6d 73 2c 20 74 68 65 20 st systems, the
4520: 6d 61 6c 6c 6f 63 28 29 20 73 79 73 74 65 6d 20 malloc() system
4530: 63 61 6c 6c 20 72 65 74 75 72 6e 73 20 61 20 62 call returns a b
4540: 75 66 66 65 72 20 74 68 61 74 20 69 73 0a 20 20 uffer that is.
4550: 61 6c 69 67 6e 65 64 20 74 6f 20 61 6e 20 38 2d aligned to an 8-
4560: 62 79 74 65 20 62 6f 75 6e 64 61 72 79 2e 20 20 byte boundary.
4570: 42 75 74 20 6f 6e 20 73 6f 6d 65 20 73 79 73 74 But on some syst
4580: 65 6d 73 20 28 65 78 3a 20 77 69 6e 64 6f 77 73 ems (ex: windows
4590: 29 20 6d 61 6c 6c 6f 63 28 29 0a 20 20 72 65 74 ) malloc(). ret
45a0: 75 72 6e 73 20 34 2d 62 79 74 65 20 61 6c 69 67 urns 4-byte alig
45b0: 6e 65 64 20 70 6f 69 6e 74 65 72 2e 20 20 54 68 ned pointer. Th
45c0: 69 73 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 is compile-time
45d0: 6f 70 74 69 6f 6e 20 6d 75 73 74 20 62 65 20 75 option must be u
45e0: 73 65 64 0a 20 20 6f 6e 20 73 79 73 74 65 6d 73 sed. on systems
45f0: 20 74 68 61 74 20 72 65 74 75 72 6e 20 34 2d 62 that return 4-b
4600: 79 74 65 20 61 6c 69 67 6e 65 64 20 70 6f 69 6e yte aligned poin
4610: 74 65 72 73 20 66 72 6f 6d 20 6d 61 6c 6c 6f 63 ters from malloc
4620: 28 29 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f ()..}..COMPILE_O
4630: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 43 41 PTION {SQLITE_CA
4640: 53 45 5f 53 45 4e 53 49 54 49 56 45 5f 4c 49 4b SE_SENSITIVE_LIK
4650: 45 7d 20 7b 0a 20 20 49 66 20 74 68 69 73 20 6f E} {. If this o
4660: 70 74 69 6f 6e 20 69 73 20 70 72 65 73 65 6e 74 ption is present
4670: 2c 20 74 68 65 6e 20 74 68 65 20 62 75 69 6c 74 , then the built
4680: 2d 69 6e 20 5b 4c 49 4b 45 5d 20 6f 70 65 72 61 -in [LIKE] opera
4690: 74 6f 72 20 77 69 6c 6c 20 62 65 0a 20 20 63 61 tor will be. ca
46a0: 73 65 20 73 65 6e 73 69 74 69 76 65 2e 20 20 54 se sensitive. T
46b0: 68 69 73 20 73 61 6d 65 20 65 66 66 65 63 74 20 his same effect
46c0: 63 61 6e 20 62 65 20 61 63 68 69 65 76 65 64 20 can be achieved
46d0: 61 74 20 72 75 6e 2d 74 69 6d 65 20 75 73 69 6e at run-time usin
46e0: 67 0a 20 20 74 68 65 20 5b 63 61 73 65 5f 73 65 g. the [case_se
46f0: 6e 73 69 74 69 76 65 5f 6c 69 6b 65 20 70 72 61 nsitive_like pra
4700: 67 6d 61 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 gma]..}..COMPILE
4710: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
4720: 44 49 52 45 43 54 5f 4f 56 45 52 46 4c 4f 57 5f DIRECT_OVERFLOW_
4730: 52 45 41 44 7d 20 7b 0a 20 20 57 68 65 6e 20 74 READ} {. When t
4740: 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 70 72 his option is pr
4750: 65 73 65 6e 74 2c 20 63 6f 6e 74 65 6e 74 20 63 esent, content c
4760: 6f 6e 74 61 69 6e 65 64 20 69 6e 0a 20 20 5b 6f ontained in. [o
4770: 76 65 72 66 6c 6f 77 20 70 61 67 65 73 5d 20 6f verflow pages] o
4780: 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66 f the database f
4790: 69 6c 65 20 69 73 20 72 65 61 64 20 64 69 72 65 ile is read dire
47a0: 63 74 6c 79 20 66 72 6f 6d 20 64 69 73 6b 2c 0a ctly from disk,.
47b0: 20 20 62 79 70 61 73 73 69 6e 67 20 74 68 65 20 bypassing the
47c0: 5b 70 61 67 65 20 63 61 63 68 65 5d 2c 20 64 75 [page cache], du
47d0: 72 69 6e 67 20 72 65 61 64 20 74 72 61 6e 73 61 ring read transa
47e0: 63 74 69 6f 6e 73 2e 20 20 49 6e 20 61 70 70 6c ctions. In appl
47f0: 69 63 61 74 69 6f 6e 73 0a 20 20 74 68 61 74 20 ications. that
4800: 64 6f 20 61 20 6c 6f 74 20 6f 66 20 72 65 61 64 do a lot of read
4810: 73 20 6f 66 20 6c 61 72 67 65 20 42 4c 4f 42 73 s of large BLOBs
4820: 2c 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 6d 69 , this option mi
4830: 67 68 74 20 69 6d 70 72 6f 76 65 20 72 65 61 64 ght improve read
4840: 0a 20 20 70 65 72 66 6f 72 6d 61 6e 63 65 2e 0a . performance..
4850: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
4860: 4e 20 7b 53 51 4c 49 54 45 5f 48 41 56 45 5f 49 N {SQLITE_HAVE_I
4870: 53 4e 41 4e 7d 20 7b 0a 20 20 49 66 20 74 68 69 SNAN} {. If thi
4880: 73 20 6f 70 74 69 6f 6e 20 69 73 20 70 72 65 73 s option is pres
4890: 65 6e 74 2c 20 74 68 65 6e 20 53 51 4c 69 74 65 ent, then SQLite
48a0: 20 77 69 6c 6c 20 75 73 65 20 74 68 65 20 69 73 will use the is
48b0: 6e 61 6e 28 29 20 66 75 6e 63 74 69 6f 6e 20 66 nan() function f
48c0: 72 6f 6d 0a 20 20 74 68 65 20 73 79 73 74 65 6d rom. the system
48d0: 20 6d 61 74 68 20 6c 69 62 72 61 72 79 2e 20 20 math library.
48e0: 54 68 69 73 20 69 73 20 61 6e 20 61 6c 69 61 73 This is an alias
48f0: 20 66 6f 72 20 74 68 65 20 5b 48 41 56 45 5f 49 for the [HAVE_I
4900: 53 4e 41 4e 5d 20 63 6f 6e 66 69 67 75 72 61 74 SNAN] configurat
4910: 69 6f 6e 0a 20 20 6f 70 74 69 6f 6e 2e 0a 7d 0a ion. option..}.
4920: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
4930: 7b 53 51 4c 49 54 45 5f 4f 53 5f 4f 54 48 45 52 {SQLITE_OS_OTHER
4940: 3d 3c 69 3e 26 6c 74 3b 30 20 6f 72 20 31 26 67 =<i><0 or 1&g
4950: 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 65 20 t;</i>} {. The
4960: 6f 70 74 69 6f 6e 20 63 61 75 73 65 73 20 53 51 option causes SQ
4970: 4c 69 74 65 20 74 6f 20 6f 6d 69 74 20 69 74 73 Lite to omit its
4980: 20 62 75 69 6c 74 2d 69 6e 20 6f 70 65 72 61 74 built-in operat
4990: 69 6e 67 20 73 79 73 74 65 6d 20 69 6e 74 65 72 ing system inter
49a0: 66 61 63 65 73 0a 20 20 66 6f 72 20 55 6e 69 78 faces. for Unix
49b0: 2c 20 57 69 6e 64 6f 77 73 2c 20 61 6e 64 20 4f , Windows, and O
49c0: 53 2f 32 2e 20 20 54 68 65 20 72 65 73 75 6c 74 S/2. The result
49d0: 69 6e 67 20 6c 69 62 72 61 72 79 20 77 69 6c 6c ing library will
49e0: 20 68 61 76 65 20 6e 6f 20 64 65 66 61 75 6c 74 have no default
49f0: 0a 20 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 20 . [sqlite3_vfs
4a00: 7c 20 6f 70 65 72 61 74 69 6e 67 20 73 79 73 74 | operating syst
4a10: 65 6d 20 69 6e 74 65 72 66 61 63 65 5d 2e 20 20 em interface].
4a20: 41 70 70 6c 69 63 61 74 69 6f 6e 73 20 6d 75 73 Applications mus
4a30: 74 20 75 73 65 0a 20 20 5b 73 71 6c 69 74 65 33 t use. [sqlite3
4a40: 5f 76 66 73 5f 72 65 67 69 73 74 65 72 28 29 5d _vfs_register()]
4a50: 20 74 6f 20 72 65 67 69 73 74 65 72 20 61 6e 20 to register an
4a60: 61 70 70 72 6f 70 72 69 61 74 65 20 69 6e 74 65 appropriate inte
4a70: 72 66 61 63 65 20 62 65 66 6f 72 65 0a 20 20 75 rface before. u
4a80: 73 69 6e 67 20 53 51 4c 69 74 65 2e 20 20 41 70 sing SQLite. Ap
4a90: 70 6c 69 63 61 74 69 6f 6e 73 20 6d 75 73 74 20 plications must
4aa0: 61 6c 73 6f 20 73 75 70 70 6c 79 20 69 6d 70 6c also supply impl
4ab0: 65 6d 65 6e 74 61 74 69 6f 6e 73 20 66 6f 72 20 ementations for
4ac0: 74 68 65 0a 20 20 5b 73 71 6c 69 74 65 33 5f 6f the. [sqlite3_o
4ad0: 73 5f 69 6e 69 74 28 29 5d 20 61 6e 64 20 5b 73 s_init()] and [s
4ae0: 71 6c 69 74 65 33 5f 6f 73 5f 65 6e 64 28 29 5d qlite3_os_end()]
4af0: 20 69 6e 74 65 72 66 61 63 65 73 2e 20 20 54 68 interfaces. Th
4b00: 65 20 75 73 75 61 6c 20 70 72 61 63 74 69 63 65 e usual practice
4b10: 0a 20 20 69 73 20 66 6f 72 20 74 68 65 20 73 75 . is for the su
4b20: 70 70 6c 69 65 64 20 5b 73 71 6c 69 74 65 33 5f pplied [sqlite3_
4b30: 6f 73 5f 69 6e 69 74 28 29 5d 20 74 6f 20 69 6e os_init()] to in
4b40: 76 6f 6b 65 20 5b 73 71 6c 69 74 65 33 5f 76 66 voke [sqlite3_vf
4b50: 73 5f 72 65 67 69 73 74 65 72 28 29 5d 2e 0a 20 s_register()]..
4b60: 20 53 51 4c 69 74 65 20 77 69 6c 6c 20 61 75 74 SQLite will aut
4b70: 6f 6d 61 74 69 63 61 6c 6c 79 20 69 6e 76 6f 6b omatically invok
4b80: 65 20 5b 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e e [sqlite3_os_in
4b90: 69 74 28 29 5d 20 77 68 65 6e 20 69 74 20 69 6e it()] when it in
4ba0: 69 74 69 61 6c 69 7a 65 73 2e 0a 0a 20 20 54 68 itializes... Th
4bb0: 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 74 79 70 is option is typ
4bc0: 69 63 61 6c 6c 79 20 75 73 65 64 20 77 68 65 6e ically used when
4bd0: 20 62 75 69 6c 64 69 6e 67 20 53 51 4c 69 74 65 building SQLite
4be0: 20 66 6f 72 20 61 6e 20 65 6d 62 65 64 64 65 64 for an embedded
4bf0: 0a 20 20 70 6c 61 74 66 6f 72 6d 20 77 69 74 68 . platform with
4c00: 20 61 20 63 75 73 74 6f 6d 20 6f 70 65 72 61 74 a custom operat
4c10: 69 6e 67 20 73 79 73 74 65 6d 2e 0a 7d 0a 0a 43 ing system..}..C
4c20: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
4c30: 51 4c 49 54 45 5f 53 45 43 55 52 45 5f 44 45 4c QLITE_SECURE_DEL
4c40: 45 54 45 7d 20 7b 0a 20 20 54 68 69 73 20 63 6f ETE} {. This co
4c50: 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f mpile-time optio
4c60: 6e 20 63 68 61 6e 67 65 73 20 74 68 65 20 64 65 n changes the de
4c70: 66 61 75 6c 74 20 73 65 74 74 69 6e 67 20 6f 66 fault setting of
4c80: 20 74 68 65 0a 20 20 5b 73 65 63 75 72 65 5f 64 the. [secure_d
4c90: 65 6c 65 74 65 20 70 72 61 67 6d 61 5d 2e 20 20 elete pragma].
4ca0: 57 68 65 6e 20 74 68 69 73 20 6f 70 74 69 6f 6e When this option
4cb0: 20 69 73 20 6e 6f 74 20 75 73 65 64 2c 20 73 65 is not used, se
4cc0: 63 75 72 65 5f 64 65 6c 65 74 65 20 64 65 66 61 cure_delete defa
4cd0: 75 6c 74 73 0a 20 20 74 6f 20 6f 66 66 2e 20 20 ults. to off.
4ce0: 57 68 65 6e 20 74 68 69 73 20 6f 70 74 69 6f 6e When this option
4cf0: 20 69 73 20 70 72 65 73 65 6e 74 2c 20 73 65 63 is present, sec
4d00: 75 72 65 5f 64 65 6c 65 74 65 20 64 65 66 61 75 ure_delete defau
4d10: 6c 74 73 20 74 6f 20 6f 6e 2e 0a 0a 20 20 54 68 lts to on... Th
4d20: 65 20 73 65 63 75 72 65 5f 64 65 6c 65 74 65 20 e secure_delete
4d30: 73 65 74 74 69 6e 67 20 63 61 75 73 65 73 20 64 setting causes d
4d40: 65 6c 65 74 65 64 20 63 6f 6e 74 65 6e 74 20 74 eleted content t
4d50: 6f 20 62 65 20 6f 76 65 72 77 72 69 74 74 65 6e o be overwritten
4d60: 20 77 69 74 68 0a 20 20 7a 65 72 6f 73 2e 20 20 with. zeros.
4d70: 54 68 65 72 65 20 69 73 20 61 20 73 6d 61 6c 6c There is a small
4d80: 20 70 65 72 66 6f 72 6d 61 6e 63 65 20 70 65 6e performance pen
4d90: 61 6c 74 79 20 66 6f 72 20 74 68 69 73 20 73 69 alty for this si
4da0: 6e 63 65 20 61 64 64 69 74 69 6f 6e 61 6c 20 49 nce additional I
4db0: 2f 4f 0a 20 20 6d 75 73 74 20 6f 63 63 75 72 2e /O. must occur.
4dc0: 20 20 4f 6e 20 74 68 65 20 6f 74 68 65 72 20 68 On the other h
4dd0: 61 6e 64 2c 20 73 65 63 75 72 65 5f 64 65 6c 65 and, secure_dele
4de0: 74 65 20 63 61 6e 20 70 72 65 76 65 6e 74 20 73 te can prevent s
4df0: 65 6e 73 69 74 69 76 65 20 0a 20 20 69 6e 66 6f ensitive . info
4e00: 72 6d 61 74 69 6f 6e 20 66 72 6f 6d 20 6c 69 6e rmation from lin
4e10: 67 65 72 69 6e 67 20 69 6e 20 75 6e 75 73 65 64 gering in unused
4e20: 20 70 61 72 74 73 20 6f 66 20 74 68 65 20 64 61 parts of the da
4e30: 74 61 62 61 73 65 20 66 69 6c 65 20 61 66 74 65 tabase file afte
4e40: 72 20 69 74 0a 20 20 68 61 73 20 61 6c 6c 65 67 r it. has alleg
4e50: 65 64 6c 79 20 62 65 65 6e 20 64 65 6c 65 74 65 edly been delete
4e60: 64 2e 20 20 53 65 65 20 74 68 65 20 64 6f 63 75 d. See the docu
4e70: 6d 65 6e 74 61 74 69 6f 6e 20 6f 6e 20 74 68 65 mentation on the
4e80: 0a 20 20 5b 73 65 63 75 72 65 5f 64 65 6c 65 74 . [secure_delet
4e90: 65 20 70 72 61 67 6d 61 5d 20 66 6f 72 20 61 64 e pragma] for ad
4ea0: 64 69 74 69 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61 ditional informa
4eb0: 74 69 6f 6e 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 tion..}..COMPILE
4ec0: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
4ed0: 54 48 52 45 41 44 53 41 46 45 3d 3c 69 3e 26 6c THREADSAFE=<i>&l
4ee0: 74 3b 30 20 6f 72 20 31 20 6f 72 20 32 26 67 74 t;0 or 1 or 2>
4ef0: 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 69 73 20 ;</i>} {. This
4f00: 6f 70 74 69 6f 6e 20 63 6f 6e 74 72 6f 6c 73 20 option controls
4f10: 77 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20 63 whether or not c
4f20: 6f 64 65 20 69 73 20 69 6e 63 6c 75 64 65 64 20 ode is included
4f30: 69 6e 20 53 51 4c 69 74 65 20 74 6f 0a 20 20 65 in SQLite to. e
4f40: 6e 61 62 6c 65 20 69 74 20 74 6f 20 6f 70 65 72 nable it to oper
4f50: 61 74 65 20 73 61 66 65 6c 79 20 69 6e 20 61 20 ate safely in a
4f60: 6d 75 6c 74 69 74 68 72 65 61 64 65 64 20 65 6e multithreaded en
4f70: 76 69 72 6f 6e 6d 65 6e 74 2e 20 20 54 68 65 0a vironment. The.
4f80: 20 20 64 65 66 61 75 6c 74 20 69 73 20 53 51 4c default is SQL
4f90: 49 54 45 5f 54 48 52 45 41 44 53 41 46 45 3d 31 ITE_THREADSAFE=1
4fa0: 20 77 68 69 63 68 20 69 73 20 73 61 66 65 20 66 which is safe f
4fb0: 6f 72 20 75 73 65 20 69 6e 20 61 20 6d 75 6c 74 or use in a mult
4fc0: 69 74 68 72 65 61 64 65 64 0a 20 20 65 6e 76 69 ithreaded. envi
4fd0: 72 6f 6e 6d 65 6e 74 2e 20 20 57 68 65 6e 20 63 ronment. When c
4fe0: 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 53 51 4c ompiled with SQL
4ff0: 49 54 45 5f 54 48 52 45 41 44 53 41 46 45 3d 30 ITE_THREADSAFE=0
5000: 20 61 6c 6c 20 6d 75 74 65 78 69 6e 67 20 63 6f all mutexing co
5010: 64 65 0a 20 20 69 73 20 6f 6d 69 74 74 65 64 20 de. is omitted
5020: 61 6e 64 20 69 74 20 69 73 20 75 6e 73 61 66 65 and it is unsafe
5030: 20 74 6f 20 75 73 65 20 53 51 4c 69 74 65 20 69 to use SQLite i
5040: 6e 20 61 20 6d 75 6c 74 69 74 68 72 65 61 64 65 n a multithreade
5050: 64 20 70 72 6f 67 72 61 6d 2e 0a 20 20 57 68 65 d program.. Whe
5060: 6e 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 n compiled with
5070: 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 SQLITE_THREADSAF
5080: 45 3d 32 2c 20 53 51 4c 69 74 65 20 63 61 6e 20 E=2, SQLite can
5090: 62 65 20 75 73 65 64 20 69 6e 20 61 20 6d 75 6c be used in a mul
50a0: 74 69 74 68 72 65 61 64 65 64 0a 20 20 70 72 6f tithreaded. pro
50b0: 67 72 61 6d 20 73 6f 20 6c 6f 6e 67 20 61 73 20 gram so long as
50c0: 6e 6f 20 74 77 6f 20 74 68 72 65 61 64 73 20 61 no two threads a
50d0: 74 74 65 6d 70 74 20 74 6f 20 75 73 65 20 74 68 ttempt to use th
50e0: 65 20 73 61 6d 65 0a 20 20 5b 64 61 74 61 62 61 e same. [databa
50f0: 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 28 se connection] (
5100: 6f 72 20 61 6e 79 20 5b 70 72 65 70 61 72 65 64 or any [prepared
5110: 20 73 74 61 74 65 6d 65 6e 74 73 5d 20 64 65 72 statements] der
5120: 69 76 65 64 20 66 72 6f 6d 0a 20 20 74 68 61 74 ived from. that
5130: 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 database connec
5140: 74 69 6f 6e 29 20 61 74 20 74 68 65 20 73 61 6d tion) at the sam
5150: 65 20 74 69 6d 65 2e 0a 0a 20 20 54 6f 20 70 75 e time... To pu
5160: 74 20 69 74 20 61 6e 6f 74 68 65 72 20 77 61 79 t it another way
5170: 2c 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 , SQLITE_THREADS
5180: 41 46 45 3d 31 20 73 65 74 73 20 74 68 65 20 64 AFE=1 sets the d
5190: 65 66 61 75 6c 74 0a 20 20 5b 74 68 72 65 61 64 efault. [thread
51a0: 69 6e 67 20 6d 6f 64 65 5d 20 74 6f 20 53 65 72 ing mode] to Ser
51b0: 69 61 6c 69 7a 65 64 2e 20 20 53 51 4c 49 54 45 ialized. SQLITE
51c0: 5f 54 48 52 45 41 44 53 41 46 45 3d 32 20 73 65 _THREADSAFE=2 se
51d0: 74 73 20 74 68 65 20 64 65 66 61 75 6c 74 0a 20 ts the default.
51e0: 20 5b 74 68 72 65 61 64 69 6e 67 20 6d 6f 64 65 [threading mode
51f0: 5d 20 74 6f 20 4d 75 6c 74 69 2d 74 68 72 65 61 ] to Multi-threa
5200: 64 65 64 2e 20 20 41 6e 64 20 53 51 4c 49 54 45 ded. And SQLITE
5210: 5f 54 48 52 45 41 44 53 41 46 45 3d 30 20 73 65 _THREADSAFE=0 se
5220: 74 73 20 74 68 65 0a 20 20 5b 74 68 72 65 61 64 ts the. [thread
5230: 69 6e 67 20 6d 6f 64 65 5d 20 74 6f 20 53 69 6e ing mode] to Sin
5240: 67 6c 65 2d 74 68 72 65 61 64 65 64 2e 0a 0a 20 gle-threaded...
5250: 20 54 68 65 20 76 61 6c 75 65 20 6f 66 20 53 51 The value of SQ
5260: 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45 20 LITE_THREADSAFE
5270: 63 61 6e 20 62 65 20 64 65 74 65 72 6d 69 6e 65 can be determine
5280: 64 20 61 74 20 72 75 6e 2d 74 69 6d 65 0a 20 20 d at run-time.
5290: 75 73 69 6e 67 20 74 68 65 20 5b 73 71 6c 69 74 using the [sqlit
52a0: 65 33 5f 74 68 72 65 61 64 73 61 66 65 28 29 5d e3_threadsafe()]
52b0: 20 69 6e 74 65 72 66 61 63 65 2e 0a 0a 20 20 57 interface... W
52c0: 68 65 6e 20 53 51 4c 69 74 65 20 68 61 73 20 62 hen SQLite has b
52d0: 65 65 6e 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 een compiled wit
52e0: 68 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 h SQLITE_THREADS
52f0: 41 46 45 3d 31 20 6f 72 0a 20 20 53 51 4c 49 54 AFE=1 or. SQLIT
5300: 45 5f 54 48 52 45 41 44 53 41 46 45 3d 32 20 74 E_THREADSAFE=2 t
5310: 68 65 6e 20 74 68 65 20 5b 74 68 72 65 61 64 69 hen the [threadi
5320: 6e 67 20 6d 6f 64 65 5d 0a 20 20 63 61 6e 20 62 ng mode]. can b
5330: 65 20 61 6c 74 65 72 65 64 20 61 74 20 72 75 6e e altered at run
5340: 2d 74 69 6d 65 20 75 73 69 6e 67 20 74 68 65 20 -time using the
5350: 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 [sqlite3_config(
5360: 29 5d 20 69 6e 74 65 72 66 61 63 65 20 74 6f 67 )] interface tog
5370: 65 74 68 65 72 0a 20 20 77 69 74 68 20 6f 6e 65 ether. with one
5380: 20 6f 66 20 74 68 65 73 65 20 76 65 72 62 73 3a of these verbs:
5390: 0a 0a 20 20 3c 75 6c 3e 0a 20 20 3c 6c 69 3e 5b .. <ul>. <li>[
53a0: 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 49 SQLITE_CONFIG_SI
53b0: 4e 47 4c 45 54 48 52 45 41 44 5d 0a 20 20 3c 6c NGLETHREAD]. <l
53c0: 69 3e 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 i>[SQLITE_CONFIG
53d0: 5f 4d 55 4c 54 49 54 48 52 45 41 44 5d 0a 20 20 _MULTITHREAD].
53e0: 3c 6c 69 3e 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 <li>[SQLITE_CONF
53f0: 49 47 5f 53 45 52 49 41 4c 49 5a 45 44 5d 0a 20 IG_SERIALIZED].
5400: 20 3c 2f 75 6c 3e 0a 0a 20 20 54 68 65 20 5b 53 </ul>.. The [S
5410: 51 4c 49 54 45 5f 4f 50 45 4e 5f 4e 4f 4d 55 54 QLITE_OPEN_NOMUT
5420: 45 58 5d 20 61 6e 64 0a 20 20 5b 53 51 4c 49 54 EX] and. [SQLIT
5430: 45 5f 4f 50 45 4e 5f 46 55 4c 4c 4d 55 54 45 58 E_OPEN_FULLMUTEX
5440: 5d 20 66 6c 61 67 73 20 74 6f 20 5b 73 71 6c 69 ] flags to [sqli
5450: 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 5d 20 63 te3_open_v2()] c
5460: 61 6e 20 61 6c 73 6f 20 62 65 20 75 73 65 64 0a an also be used.
5470: 20 20 74 6f 20 61 64 6a 75 73 74 20 74 68 65 20 to adjust the
5480: 5b 74 68 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d [threading mode]
5490: 20 6f 66 20 69 6e 64 69 76 69 64 75 61 6c 20 5b of individual [
54a0: 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 database connect
54b0: 69 6f 6e 73 5d 0a 20 20 61 74 20 72 75 6e 2d 74 ions]. at run-t
54c0: 69 6d 65 2e 0a 0a 20 20 4e 6f 74 65 20 74 68 61 ime... Note tha
54d0: 74 20 77 68 65 6e 20 53 51 4c 69 74 65 20 69 73 t when SQLite is
54e0: 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 53 compiled with S
54f0: 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45 QLITE_THREADSAFE
5500: 3d 30 2c 20 74 68 65 20 63 6f 64 65 0a 20 20 74 =0, the code. t
5510: 6f 20 6d 61 6b 65 20 53 51 4c 69 74 65 20 74 68 o make SQLite th
5520: 72 65 61 64 73 61 66 65 20 69 73 20 6f 6d 69 74 readsafe is omit
5530: 74 65 64 20 66 72 6f 6d 20 74 68 65 20 62 75 69 ted from the bui
5540: 6c 64 2e 20 20 57 68 65 6e 20 74 68 69 73 20 6f ld. When this o
5550: 63 63 75 72 73 2c 0a 20 20 69 74 20 69 73 20 69 ccurs,. it is i
5560: 6d 70 6f 73 73 69 62 6c 65 20 74 6f 20 63 68 61 mpossible to cha
5570: 6e 67 65 20 74 68 65 20 5b 74 68 72 65 61 64 69 nge the [threadi
5580: 6e 67 20 6d 6f 64 65 5d 20 61 74 20 73 74 61 72 ng mode] at star
5590: 74 2d 74 69 6d 65 20 6f 72 20 72 75 6e 2d 74 69 t-time or run-ti
55a0: 6d 65 2e 0a 0a 20 20 53 65 65 20 74 68 65 20 5b me... See the [
55b0: 74 68 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 threading mode]
55c0: 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 6f documentation fo
55d0: 72 20 61 64 64 69 74 69 6f 6e 61 6c 20 69 6e 66 r additional inf
55e0: 6f 72 6d 61 74 69 6f 6e 0a 20 20 6f 6e 20 61 73 ormation. on as
55f0: 70 65 63 74 73 20 6f 66 20 75 73 69 6e 67 20 53 pects of using S
5600: 51 4c 69 74 65 20 69 6e 20 61 20 6d 75 6c 74 69 QLite in a multi
5610: 74 68 72 65 61 64 65 64 20 65 6e 76 69 72 6f 6e threaded environ
5620: 6d 65 6e 74 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 ment..}..COMPILE
5630: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
5640: 54 45 4d 50 5f 53 54 4f 52 45 3d 3c 69 3e 26 6c TEMP_STORE=<i>&l
5650: 74 3b 30 20 74 68 72 6f 75 67 68 20 33 26 67 74 t;0 through 3>
5660: 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 69 73 20 ;</i>} {. This
5670: 6f 70 74 69 6f 6e 20 63 6f 6e 74 72 6f 6c 73 20 option controls
5680: 77 68 65 74 68 65 72 20 74 65 6d 70 6f 72 61 72 whether temporar
5690: 79 20 66 69 6c 65 73 20 61 72 65 20 73 74 6f 72 y files are stor
56a0: 65 64 20 6f 6e 20 64 69 73 6b 20 6f 72 0a 20 20 ed on disk or.
56b0: 69 6e 20 6d 65 6d 6f 72 79 2e 20 20 54 68 65 20 in memory. The
56c0: 6d 65 61 6e 69 6e 67 73 20 66 6f 72 20 76 61 72 meanings for var
56d0: 69 6f 75 73 20 73 65 74 74 69 6e 67 73 20 6f 66 ious settings of
56e0: 20 74 68 69 73 20 63 6f 6d 70 69 6c 65 2d 74 69 this compile-ti
56f0: 6d 65 0a 20 20 6f 70 74 69 6f 6e 20 61 72 65 20 me. option are
5700: 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a 0a 20 20 3c as follows:.. <
5710: 74 61 62 6c 65 20 63 65 6c 6c 70 61 64 64 69 6e table cellpaddin
5720: 67 3d 22 32 22 20 62 6f 72 64 65 72 3d 22 31 22 g="2" border="1"
5730: 3e 0a 20 20 3c 74 72 3e 3c 74 68 3e 53 51 4c 49 >. <tr><th>SQLI
5740: 54 45 5f 54 45 4d 50 5f 53 54 4f 52 45 3c 2f 74 TE_TEMP_STORE</t
5750: 68 3e 3c 74 68 3e 4d 65 61 6e 69 6e 67 3c 2f 74 h><th>Meaning</t
5760: 68 3e 3c 2f 74 72 3e 0a 20 20 3c 74 72 3e 3c 74 h></tr>. <tr><t
5770: 64 20 61 6c 69 67 6e 3d 22 63 65 6e 74 65 72 22 d align="center"
5780: 3e 30 3c 2f 74 64 3e 3c 74 64 3e 41 6c 77 61 79 >0</td><td>Alway
5790: 73 20 75 73 65 20 74 65 6d 70 6f 72 61 72 79 20 s use temporary
57a0: 66 69 6c 65 73 3c 2f 74 64 3e 3c 2f 74 72 3e 0a files</td></tr>.
57b0: 20 20 3c 74 72 3e 3c 74 64 20 61 6c 69 67 6e 3d <tr><td align=
57c0: 22 63 65 6e 74 65 72 22 3e 31 3c 2f 74 64 3e 3c "center">1</td><
57d0: 74 64 3e 55 73 65 20 66 69 6c 65 73 20 62 79 20 td>Use files by
57e0: 64 65 66 61 75 6c 74 20 62 75 74 20 61 6c 6c 6f default but allo
57f0: 77 20 74 68 65 0a 20 20 5b 50 52 41 47 4d 41 20 w the. [PRAGMA
5800: 74 65 6d 70 5f 73 74 6f 72 65 5d 20 63 6f 6d 6d temp_store] comm
5810: 61 6e 64 20 74 6f 20 6f 76 65 72 72 69 64 65 3c and to override<
5820: 2f 74 64 3e 3c 2f 74 72 3e 0a 20 20 3c 74 72 3e /td></tr>. <tr>
5830: 3c 74 64 20 61 6c 69 67 6e 3d 22 63 65 6e 74 65 <td align="cente
5840: 72 22 3e 32 3c 2f 74 64 3e 3c 74 64 3e 55 73 65 r">2</td><td>Use
5850: 20 6d 65 6d 6f 72 79 20 62 79 20 64 65 66 61 75 memory by defau
5860: 6c 74 20 62 75 74 20 61 6c 6c 6f 77 20 74 68 65 lt but allow the
5870: 0a 20 20 5b 50 52 41 47 4d 41 20 74 65 6d 70 5f . [PRAGMA temp_
5880: 73 74 6f 72 65 5d 20 63 6f 6d 6d 61 6e 64 20 74 store] command t
5890: 6f 20 6f 76 65 72 72 69 64 65 3c 2f 74 64 3e 3c o override</td><
58a0: 2f 74 72 3e 0a 20 20 3c 74 72 3e 3c 74 64 20 61 /tr>. <tr><td a
58b0: 6c 69 67 6e 3d 22 63 65 6e 74 65 72 22 3e 33 3c lign="center">3<
58c0: 2f 74 64 3e 3c 74 64 3e 41 6c 77 61 79 73 20 75 /td><td>Always u
58d0: 73 65 20 6d 65 6d 6f 72 79 3c 2f 74 64 3e 3c 2f se memory</td></
58e0: 74 72 3e 0a 20 20 3c 2f 74 61 62 6c 65 3e 0a 0a tr>. </table>..
58f0: 20 20 54 68 65 20 64 65 66 61 75 6c 74 20 73 65 The default se
5900: 74 74 69 6e 67 20 69 73 20 31 2e 20 20 0a 20 20 tting is 1. .
5910: 41 64 64 69 74 69 6f 6e 61 6c 20 69 6e 66 6f 72 Additional infor
5920: 6d 61 74 69 6f 6e 20 63 61 6e 20 62 65 20 66 6f mation can be fo
5930: 75 6e 64 20 69 6e 20 5b 74 65 6d 70 73 74 6f 72 und in [tempstor
5940: 65 20 7c 20 74 65 6d 70 66 69 6c 65 73 2e 68 74 e | tempfiles.ht
5950: 6d 6c 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f ml]..}..COMPILE_
5960: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 54 OPTION {SQLITE_T
5970: 52 41 43 45 5f 53 49 5a 45 5f 4c 49 4d 49 54 3d RACE_SIZE_LIMIT=
5980: 3c 69 3e 4e 3c 2f 69 3e 7d 20 7b 0a 20 20 49 66 <i>N</i>} {. If
5990: 20 74 68 69 73 20 6d 61 63 72 6f 20 69 73 20 64 this macro is d
59a0: 65 66 69 6e 65 64 20 74 6f 20 61 20 70 6f 73 69 efined to a posi
59b0: 74 69 76 65 20 69 6e 74 65 67 65 72 20 3c 69 3e tive integer <i>
59c0: 4e 3c 2f 69 3e 2c 20 74 68 65 6e 20 74 68 65 20 N</i>, then the
59d0: 6c 65 6e 67 74 68 20 6f 66 0a 20 20 73 74 72 69 length of. stri
59e0: 6e 67 73 20 61 6e 64 20 42 4c 4f 42 20 74 68 61 ngs and BLOB tha
59f0: 74 20 61 72 65 20 65 78 70 61 6e 64 65 64 20 69 t are expanded i
5a00: 6e 74 6f 20 70 61 72 61 6d 65 74 65 72 73 20 69 nto parameters i
5a10: 6e 20 74 68 65 20 6f 75 74 70 75 74 20 6f 66 0a n the output of.
5a20: 20 20 5b 73 71 6c 69 74 65 33 5f 74 72 61 63 65 [sqlite3_trace
5a30: 28 29 5d 20 69 73 20 6c 69 6d 69 74 65 64 20 74 ()] is limited t
5a40: 6f 20 3c 69 3e 4e 3c 2f 69 3e 20 62 79 74 65 73 o <i>N</i> bytes
5a50: 2e 20 20 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f . .}..COMPILE_O
5a60: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 55 53 PTION {SQLITE_US
5a70: 45 5f 55 52 49 7d 20 7b 0a 20 20 54 68 69 73 20 E_URI} {. This
5a80: 6f 70 74 69 6f 6e 20 63 61 75 73 65 73 20 74 68 option causes th
5a90: 65 20 5b 55 52 49 20 66 69 6c 65 6e 61 6d 65 5d e [URI filename]
5aa0: 20 70 72 6f 63 65 73 73 20 6c 6f 67 69 63 20 74 process logic t
5ab0: 6f 20 62 65 20 65 6e 61 62 6c 65 64 20 62 79 20 o be enabled by
5ac0: 0a 20 20 64 65 66 61 75 6c 74 2e 20 20 0a 7d 0a . default. .}.
5ad0: 0a 3c 2f 74 63 6c 3e 0a 0a 3c 61 20 6e 61 6d 65 .</tcl>..<a name
5ae0: 3d 22 65 6e 61 62 6c 65 66 65 61 74 75 72 65 73 ="enablefeatures
5af0: 22 3e 3c 2f 61 3e 0a 3c 68 32 3e 31 2e 35 20 4f "></a>.<h2>1.5 O
5b00: 70 74 69 6f 6e 73 20 54 6f 20 45 6e 61 62 6c 65 ptions To Enable
5b10: 20 46 65 61 74 75 72 65 73 20 4e 6f 72 6d 61 6c Features Normal
5b20: 6c 79 20 54 75 72 6e 65 64 20 4f 66 66 3c 2f 68 ly Turned Off</h
5b30: 32 3e 0a 0a 3c 74 63 6c 3e 0a 43 4f 4d 50 49 4c 2>..<tcl>.COMPIL
5b40: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
5b50: 5f 41 4c 4c 4f 57 5f 55 52 49 5f 41 55 54 48 4f _ALLOW_URI_AUTHO
5b60: 52 49 54 59 7d 20 7b 0a 20 20 5b 55 52 49 20 66 RITY} {. [URI f
5b70: 69 6c 65 6e 61 6d 65 73 5d 20 6e 6f 72 6d 61 6c ilenames] normal
5b80: 6c 79 20 74 68 72 6f 77 73 20 61 6e 20 65 72 72 ly throws an err
5b90: 6f 72 20 69 66 20 74 68 65 20 61 75 74 68 6f 72 or if the author
5ba0: 69 74 79 20 73 65 63 74 69 6f 6e 20 69 73 0a 20 ity section is.
5bb0: 20 6e 6f 74 20 65 69 74 68 65 72 20 65 6d 70 74 not either empt
5bc0: 79 20 6f 72 20 22 6c 6f 63 61 6c 68 6f 73 74 22 y or "localhost"
5bd0: 2e 20 20 48 6f 77 65 76 65 72 2c 20 69 66 20 53 . However, if S
5be0: 51 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c 65 QLite is compile
5bf0: 64 20 77 69 74 68 0a 20 20 74 68 65 20 53 51 4c d with. the SQL
5c00: 49 54 45 5f 41 4c 4c 4f 57 5f 55 52 49 5f 41 55 ITE_ALLOW_URI_AU
5c10: 54 48 4f 52 49 54 59 20 63 6f 6d 70 69 6c 65 2d THORITY compile-
5c20: 74 69 6d 65 20 6f 70 74 69 6f 6e 2c 20 74 68 65 time option, the
5c30: 6e 20 74 68 65 20 55 52 49 20 69 73 0a 20 20 63 n the URI is. c
5c40: 6f 6e 76 65 72 74 65 64 20 69 6e 74 6f 20 61 20 onverted into a
5c50: 55 6e 69 66 6f 72 6d 20 4e 61 6d 69 6e 67 20 43 Uniform Naming C
5c60: 6f 6e 76 65 6e 74 69 6f 6e 20 28 55 4e 43 29 20 onvention (UNC)
5c70: 66 69 6c 65 6e 61 6d 65 20 61 6e 64 20 70 61 73 filename and pas
5c80: 73 65 64 0a 20 20 64 6f 77 6e 20 74 6f 20 74 68 sed. down to th
5c90: 65 20 75 6e 64 65 72 6c 79 69 6e 67 20 6f 70 65 e underlying ope
5ca0: 72 61 74 69 6e 67 20 73 79 73 74 65 6d 20 74 68 rating system th
5cb0: 61 74 20 77 61 79 2e 20 20 0a 20 20 3c 70 3e 0a at way. . <p>.
5cc0: 20 20 53 6f 6d 65 20 66 75 74 75 72 65 20 76 65 Some future ve
5cd0: 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74 65 rsions of SQLite
5ce0: 20 6d 61 79 20 63 68 61 6e 67 65 20 74 6f 20 65 may change to e
5cf0: 6e 61 62 6c 65 20 74 68 69 73 20 66 65 61 74 75 nable this featu
5d00: 72 65 0a 20 20 62 79 20 64 65 66 61 75 6c 74 2e re. by default.
5d10: 0a 7d 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f .}.COMPILE_OPTIO
5d20: 4e 20 7b 53 51 4c 49 54 45 5f 41 4c 4c 4f 57 5f N {SQLITE_ALLOW_
5d30: 43 4f 56 45 52 49 4e 47 5f 49 4e 44 45 58 5f 53 COVERING_INDEX_S
5d40: 43 41 4e 3d 3c 69 3e 26 6c 74 3b 30 20 6f 72 20 CAN=<i><0 or
5d50: 31 26 67 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 1></i>} {. T
5d60: 68 69 73 20 43 2d 70 72 65 70 72 6f 63 65 73 73 his C-preprocess
5d70: 20 6d 61 63 72 6f 20 64 65 74 65 72 6d 69 6e 65 macro determine
5d80: 73 20 74 68 65 20 64 65 66 61 75 6c 74 20 73 65 s the default se
5d90: 74 74 69 6e 67 20 6f 66 20 74 68 65 0a 20 20 5b tting of the. [
5da0: 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 43 4f SQLITE_CONFIG_CO
5db0: 56 45 52 49 4e 47 5f 49 4e 44 45 58 5f 53 43 41 VERING_INDEX_SCA
5dc0: 4e 5d 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e N] configuration
5dd0: 20 73 65 74 74 69 6e 67 2e 20 20 49 74 20 64 65 setting. It de
5de0: 66 61 75 6c 74 73 0a 20 20 74 6f 20 31 20 28 6f faults. to 1 (o
5df0: 6e 29 20 77 68 69 63 68 20 6d 65 61 6e 73 20 74 n) which means t
5e00: 68 61 74 20 63 6f 76 65 72 69 6e 67 20 69 6e 64 hat covering ind
5e10: 69 63 65 73 20 61 72 65 20 75 73 65 64 20 66 6f ices are used fo
5e20: 72 20 66 75 6c 6c 20 74 61 62 6c 65 0a 20 20 73 r full table. s
5e30: 63 61 6e 73 20 77 68 65 72 65 20 70 6f 73 73 69 cans where possi
5e40: 62 6c 65 2c 20 69 6e 20 6f 72 64 65 72 20 74 6f ble, in order to
5e50: 20 72 65 64 75 63 65 20 49 2f 4f 20 61 6e 64 20 reduce I/O and
5e60: 69 6d 70 72 6f 76 65 20 70 65 72 66 6f 72 6d 61 improve performa
5e70: 6e 63 65 2e 0a 20 20 48 6f 77 65 76 65 72 2c 20 nce.. However,
5e80: 74 68 65 20 75 73 65 20 6f 66 20 61 20 63 6f 76 the use of a cov
5e90: 65 72 69 6e 67 20 69 6e 64 65 78 20 66 6f 72 20 ering index for
5ea0: 61 20 66 75 6c 6c 20 73 63 61 6e 20 77 69 6c 6c a full scan will
5eb0: 20 63 61 75 73 65 20 72 65 73 75 6c 74 73 0a 20 cause results.
5ec0: 20 74 6f 20 61 70 70 65 61 72 20 69 6e 20 61 20 to appear in a
5ed0: 64 69 66 66 65 72 65 6e 74 20 6f 72 64 65 72 20 different order
5ee0: 66 72 6f 6d 20 6c 65 67 61 63 79 2c 20 77 68 69 from legacy, whi
5ef0: 63 68 20 63 6f 75 6c 64 20 63 61 75 73 65 20 73 ch could cause s
5f00: 6f 6d 65 0a 20 20 28 69 6e 63 6f 72 72 65 63 74 ome. (incorrect
5f10: 6c 79 2d 63 6f 64 65 64 29 20 6c 65 67 61 63 79 ly-coded) legacy
5f20: 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 74 6f applications to
5f30: 20 62 72 65 61 6b 2e 20 20 48 65 6e 63 65 2c 20 break. Hence,
5f40: 74 68 65 20 63 6f 76 65 72 69 6e 67 0a 20 20 69 the covering. i
5f50: 6e 64 65 78 20 73 63 61 6e 20 6f 70 74 69 6f 6e ndex scan option
5f60: 20 63 61 6e 20 62 65 20 64 69 73 61 62 6c 65 64 can be disabled
5f70: 20 61 74 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 at compile-time
5f80: 20 6f 6e 20 73 79 73 74 65 6d 73 20 74 68 61 74 on systems that
5f90: 20 77 68 61 74 0a 20 20 74 6f 20 6d 69 6e 69 6d what. to minim
5fa0: 69 7a 65 20 74 68 65 69 72 20 72 69 73 6b 20 6f ize their risk o
5fb0: 66 20 65 78 70 6f 73 69 6e 67 20 65 72 72 6f 72 f exposing error
5fc0: 73 20 69 6e 20 6c 65 67 61 63 79 20 61 70 70 6c s in legacy appl
5fd0: 69 63 61 74 69 6f 6e 73 2e 0a 7d 0a 0a 43 4f 4d ications..}..COM
5fe0: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c PILE_OPTION {SQL
5ff0: 49 54 45 5f 45 4e 41 42 4c 45 5f 38 5f 33 5f 4e ITE_ENABLE_8_3_N
6000: 41 4d 45 53 3d 3c 69 3e 26 6c 74 3b 31 20 6f 72 AMES=<i><1 or
6010: 20 32 26 67 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 2></i>} {.
6020: 49 66 20 74 68 69 73 20 43 2d 70 72 65 70 72 6f If this C-prepro
6030: 63 65 73 73 6f 72 20 6d 61 63 72 6f 20 69 73 20 cessor macro is
6040: 64 65 66 69 6e 65 64 2c 20 74 68 65 6e 20 65 78 defined, then ex
6050: 74 72 61 20 63 6f 64 65 20 69 73 0a 20 20 69 6e tra code is. in
6060: 63 6c 75 64 65 64 20 74 68 61 74 20 61 6c 6c 6f cluded that allo
6070: 77 73 20 53 51 4c 69 74 65 20 74 6f 20 66 75 6e ws SQLite to fun
6080: 63 74 69 6f 6e 20 6f 6e 20 61 20 66 69 6c 65 73 ction on a files
6090: 79 73 74 65 6d 20 74 68 61 74 0a 20 20 6f 6e 6c ystem that. onl
60a0: 79 20 73 75 70 70 6f 72 74 20 38 2b 33 20 66 69 y support 8+3 fi
60b0: 6c 65 6e 61 6d 65 73 2e 20 20 49 66 20 74 68 65 lenames. If the
60c0: 20 76 61 6c 75 65 20 6f 66 20 74 68 69 73 20 6d value of this m
60d0: 61 63 72 6f 20 69 73 20 31 2c 0a 20 20 74 68 65 acro is 1,. the
60e0: 6e 20 74 68 65 20 64 65 66 61 75 6c 74 20 62 65 n the default be
60f0: 68 61 76 69 6f 72 20 69 73 20 74 6f 20 63 6f 6e havior is to con
6100: 74 69 6e 75 65 20 74 6f 20 75 73 65 20 6c 6f 6e tinue to use lon
6110: 67 20 66 69 6c 65 6e 61 6d 65 73 20 61 6e 64 0a g filenames and.
6120: 20 20 74 6f 20 6f 6e 6c 79 20 75 73 65 20 38 2b to only use 8+
6130: 33 20 66 69 6c 65 6e 61 6d 65 73 20 69 66 20 74 3 filenames if t
6140: 68 65 20 0a 20 20 64 61 74 61 62 61 73 65 20 63 he . database c
6150: 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 6f 70 65 onnection is ope
6160: 6e 65 64 20 75 73 69 6e 67 20 5b 55 52 49 20 66 ned using [URI f
6170: 69 6c 65 6e 61 6d 65 73 5d 20 77 69 74 68 0a 20 ilenames] with.
6180: 20 74 68 65 20 22 3c 74 74 3e 38 5f 33 5f 6e 61 the "<tt>8_3_na
6190: 6d 65 73 3d 31 3c 2f 74 74 3e 22 20 71 75 65 72 mes=1</tt>" quer
61a0: 79 20 70 61 72 61 6d 65 74 65 72 2e 20 20 49 66 y parameter. If
61b0: 20 74 68 65 20 76 61 6c 75 65 20 6f 66 0a 20 20 the value of.
61c0: 74 68 69 73 20 6d 61 63 72 6f 20 69 73 20 32 2c this macro is 2,
61d0: 20 74 68 65 6e 20 74 68 65 20 75 73 65 20 6f 66 then the use of
61e0: 20 38 2b 33 20 66 69 6c 65 6e 61 6d 65 73 20 62 8+3 filenames b
61f0: 65 63 6f 6d 65 73 20 74 68 65 20 64 65 66 61 75 ecomes the defau
6200: 6c 74 0a 20 20 62 75 74 20 6d 61 79 20 62 65 20 lt. but may be
6210: 64 69 73 61 62 6c 65 64 20 6f 6e 20 75 73 69 6e disabled on usin
6220: 67 20 74 68 65 20 3c 74 74 3e 38 5f 33 5f 6e 61 g the <tt>8_3_na
6230: 6d 65 73 3d 30 3c 2f 74 74 3e 20 71 75 65 72 79 mes=0</tt> query
6240: 20 70 61 72 61 6d 65 74 65 72 2e 0a 20 20 53 65 parameter.. Se
6250: 65 20 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 e .}..COMPILE_OP
6260: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 TION {SQLITE_ENA
6270: 42 4c 45 5f 41 50 49 5f 41 52 4d 4f 52 7d 20 7b BLE_API_ARMOR} {
6280: 0a 20 20 57 68 65 6e 20 64 65 66 69 6e 65 64 2c . When defined,
6290: 20 74 68 69 73 20 43 2d 70 72 65 70 72 6f 63 65 this C-preproce
62a0: 73 73 6f 72 20 6d 61 63 72 6f 20 61 63 74 69 76 ssor macro activ
62b0: 61 74 65 73 20 65 78 74 72 61 20 63 6f 64 65 20 ates extra code
62c0: 74 68 61 74 0a 20 20 61 74 74 65 6d 70 74 73 20 that. attempts
62d0: 74 6f 20 64 65 74 65 63 74 20 6d 69 73 75 73 65 to detect misuse
62e0: 20 6f 66 20 74 68 65 20 53 51 4c 69 74 65 20 41 of the SQLite A
62f0: 50 49 2c 20 73 75 63 68 20 61 73 20 70 61 73 73 PI, such as pass
6300: 69 6e 67 20 69 6e 20 4e 55 4c 4c 0a 20 20 70 6f ing in NULL. po
6310: 69 6e 74 65 72 73 20 74 6f 20 72 65 71 75 69 72 inters to requir
6320: 65 64 20 70 61 72 61 6d 65 74 65 72 73 20 6f 72 ed parameters or
6330: 20 75 73 69 6e 67 20 6f 62 6a 65 63 74 73 20 61 using objects a
6340: 66 74 65 72 20 74 68 65 79 20 68 61 76 65 20 62 fter they have b
6350: 65 65 6e 0a 20 20 64 65 73 74 72 6f 79 65 64 2e een. destroyed.
6360: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
6370: 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c ON {SQLITE_ENABL
6380: 45 5f 41 54 4f 4d 49 43 5f 57 52 49 54 45 7d 20 E_ATOMIC_WRITE}
6390: 7b 0a 20 20 49 66 20 74 68 69 73 20 43 2d 70 72 {. If this C-pr
63a0: 65 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f eprocessor macro
63b0: 20 69 73 20 64 65 66 69 6e 65 64 20 61 6e 64 20 is defined and
63c0: 69 66 20 74 68 65 0a 20 20 78 44 65 76 69 63 65 if the. xDevice
63d0: 43 68 61 72 61 63 74 65 72 69 73 74 69 63 73 20 Characteristics
63e0: 6d 65 74 68 6f 64 20 6f 66 20 5b 73 71 6c 69 74 method of [sqlit
63f0: 65 33 5f 69 6f 5f 6d 65 74 68 6f 64 73 5d 20 6f e3_io_methods] o
6400: 62 6a 65 63 74 20 66 6f 72 0a 20 20 61 20 64 61 bject for. a da
6410: 74 61 62 61 73 65 20 66 69 6c 65 20 72 65 70 6f tabase file repo
6420: 72 74 73 20 28 76 69 61 20 6f 6e 65 20 6f 66 20 rts (via one of
6430: 74 68 65 20 5b 53 51 4c 49 54 45 5f 49 4f 43 41 the [SQLITE_IOCA
6440: 50 5f 41 54 4f 4d 49 43 5d 20 62 69 74 73 29 0a P_ATOMIC] bits).
6450: 20 20 74 68 61 74 20 74 68 65 20 66 69 6c 65 73 that the files
6460: 79 73 74 65 6d 20 73 75 70 70 6f 72 74 73 20 61 ystem supports a
6470: 74 6f 6d 69 63 20 77 72 69 74 65 73 20 61 6e 64 tomic writes and
6480: 20 69 66 20 61 20 74 72 61 6e 73 61 63 74 69 6f if a transactio
6490: 6e 0a 20 20 69 6e 76 6f 6c 76 65 73 20 61 20 63 n. involves a c
64a0: 68 61 6e 67 65 20 74 6f 20 6f 6e 6c 79 20 61 20 hange to only a
64b0: 73 69 6e 67 6c 65 20 70 61 67 65 20 6f 66 20 74 single page of t
64c0: 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 he database file
64d0: 2c 0a 20 20 74 68 65 6e 20 74 68 65 20 74 72 61 ,. then the tra
64e0: 6e 73 61 63 74 69 6f 6e 20 63 6f 6d 6d 69 74 73 nsaction commits
64f0: 20 77 69 74 68 20 6a 75 73 74 20 61 20 73 69 6e with just a sin
6500: 67 6c 65 20 77 72 69 74 65 20 72 65 71 75 65 73 gle write reques
6510: 74 20 6f 66 0a 20 20 61 20 73 69 6e 67 6c 65 20 t of. a single
6520: 70 61 67 65 20 6f 66 20 74 68 65 20 64 61 74 61 page of the data
6530: 62 61 73 65 20 61 6e 64 20 6e 6f 20 72 6f 6c 6c base and no roll
6540: 62 61 63 6b 20 6a 6f 75 72 6e 61 6c 20 69 73 20 back journal is
6550: 63 72 65 61 74 65 64 0a 20 20 6f 72 20 77 72 69 created. or wri
6560: 74 74 65 6e 2e 20 20 4f 6e 20 66 69 6c 65 73 79 tten. On filesy
6570: 73 74 65 6d 73 20 74 68 61 74 20 73 75 70 70 6f stems that suppo
6580: 72 74 20 61 74 6f 6d 69 63 20 77 72 69 74 65 73 rt atomic writes
6590: 2c 20 74 68 69 73 0a 20 20 6f 70 74 69 6d 69 7a , this. optimiz
65a0: 61 74 69 6f 6e 20 63 61 6e 20 72 65 73 75 6c 74 ation can result
65b0: 20 69 6e 20 73 69 67 6e 69 66 69 63 61 6e 74 20 in significant
65c0: 73 70 65 65 64 20 69 6d 70 72 6f 76 65 6d 65 6e speed improvemen
65d0: 74 73 20 66 6f 72 0a 20 20 73 6d 61 6c 6c 20 75 ts for. small u
65e0: 70 64 61 74 65 73 2e 20 20 48 6f 77 65 76 65 72 pdates. However
65f0: 2c 20 66 65 77 20 66 69 6c 65 73 79 73 74 65 6d , few filesystem
6600: 73 20 73 75 70 70 6f 72 74 20 74 68 69 73 20 63 s support this c
6610: 61 70 61 62 69 6c 69 74 79 0a 20 20 61 6e 64 20 apability. and
6620: 74 68 65 20 63 6f 64 65 20 70 61 74 68 73 20 74 the code paths t
6630: 68 61 74 20 63 68 65 63 6b 20 66 6f 72 20 74 68 hat check for th
6640: 69 73 20 63 61 70 61 62 69 6c 69 74 79 20 73 6c is capability sl
6650: 6f 77 20 64 6f 77 6e 20 77 72 69 74 65 0a 20 20 ow down write.
6660: 70 65 72 66 6f 72 6d 61 6e 63 65 20 6f 6e 20 73 performance on s
6670: 79 73 74 65 6d 73 20 74 68 61 74 20 6c 61 63 6b ystems that lack
6680: 20 61 74 6f 6d 69 63 20 77 72 69 74 65 20 63 61 atomic write ca
6690: 70 61 62 69 6c 69 74 79 2c 20 73 6f 20 74 68 69 pability, so thi
66a0: 73 0a 20 20 66 65 61 74 75 72 65 20 69 73 20 64 s. feature is d
66b0: 69 73 61 62 6c 65 64 20 62 79 20 64 65 66 61 75 isabled by defau
66c0: 6c 74 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f lt..}..COMPILE_O
66d0: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e PTION {SQLITE_EN
66e0: 41 42 4c 45 5f 43 4f 4c 55 4d 4e 5f 4d 45 54 41 ABLE_COLUMN_META
66f0: 44 41 54 41 7d 20 7b 0a 20 20 57 68 65 6e 20 74 DATA} {. When t
6700: 68 69 73 20 43 2d 70 72 65 70 72 6f 63 65 73 73 his C-preprocess
6710: 6f 72 20 6d 61 63 72 6f 20 69 73 20 64 65 66 69 or macro is defi
6720: 6e 65 64 2c 20 53 51 4c 69 74 65 20 69 6e 63 6c ned, SQLite incl
6730: 75 64 65 73 20 73 6f 6d 65 0a 20 20 61 64 64 69 udes some. addi
6740: 74 69 6f 6e 61 6c 20 41 50 49 73 20 74 68 61 74 tional APIs that
6750: 20 70 72 6f 76 69 64 65 20 63 6f 6e 76 65 6e 69 provide conveni
6760: 65 6e 74 20 61 63 63 65 73 73 20 74 6f 20 6d 65 ent access to me
6770: 74 61 2d 64 61 74 61 20 61 62 6f 75 74 0a 20 20 ta-data about.
6780: 74 61 62 6c 65 73 20 61 6e 64 20 71 75 65 72 69 tables and queri
6790: 65 73 2e 20 20 54 68 65 20 41 50 49 73 20 74 68 es. The APIs th
67a0: 61 74 20 61 72 65 20 65 6e 61 62 6c 65 64 20 62 at are enabled b
67b0: 79 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 61 72 y this option ar
67c0: 65 3a 0a 0a 20 20 3c 75 6c 3e 0a 20 20 3c 6c 69 e:.. <ul>. <li
67d0: 3e 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d > [sqlite3_colum
67e0: 6e 5f 64 61 74 61 62 61 73 65 5f 6e 61 6d 65 28 n_database_name(
67f0: 29 5d 20 3c 2f 6c 69 3e 0a 20 20 3c 6c 69 3e 20 )] </li>. <li>
6800: 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f [sqlite3_column_
6810: 64 61 74 61 62 61 73 65 5f 6e 61 6d 65 31 36 28 database_name16(
6820: 29 5d 20 3c 2f 6c 69 3e 0a 20 20 3c 6c 69 3e 20 )] </li>. <li>
6830: 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f [sqlite3_column_
6840: 74 61 62 6c 65 5f 6e 61 6d 65 28 29 5d 20 3c 2f table_name()] </
6850: 6c 69 3e 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c 69 li>. <li> [sqli
6860: 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 61 62 6c 65 te3_column_table
6870: 5f 6e 61 6d 65 31 36 28 29 5d 20 3c 2f 6c 69 3e _name16()] </li>
6880: 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c 69 74 65 33 . <li> [sqlite3
6890: 5f 63 6f 6c 75 6d 6e 5f 6f 72 69 67 69 6e 5f 6e _column_origin_n
68a0: 61 6d 65 28 29 5d 20 3c 2f 6c 69 3e 0a 20 20 3c ame()] </li>. <
68b0: 6c 69 3e 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c li> [sqlite3_col
68c0: 75 6d 6e 5f 6f 72 69 67 69 6e 5f 6e 61 6d 65 31 umn_origin_name1
68d0: 36 28 29 5d 20 3c 2f 6c 69 3e 0a 20 20 3c 2f 75 6()] </li>. </u
68e0: 6c 3e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 l>.}..COMPILE_OP
68f0: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 TION {SQLITE_ENA
6900: 42 4c 45 5f 45 58 50 4c 41 49 4e 5f 43 4f 4d 4d BLE_EXPLAIN_COMM
6910: 45 4e 54 53 7d 20 7b 0a 20 20 54 68 69 73 20 6f ENTS} {. This o
6920: 70 74 69 6f 6e 20 61 64 64 73 20 65 78 74 72 61 ption adds extra
6930: 20 6c 6f 67 69 63 20 74 6f 20 53 51 4c 69 74 65 logic to SQLite
6940: 20 74 68 61 74 20 69 6e 73 65 72 74 73 20 63 6f that inserts co
6950: 6d 6d 65 6e 74 20 74 65 78 74 20 69 6e 74 6f 20 mment text into
6960: 74 68 65 0a 20 20 6f 75 74 70 75 74 20 6f 66 20 the. output of
6970: 5b 45 58 50 4c 41 49 4e 5d 2e 20 20 54 68 65 73 [EXPLAIN]. Thes
6980: 65 20 65 78 74 72 61 20 63 6f 6d 6d 65 6e 74 73 e extra comments
6990: 20 75 73 65 20 65 78 74 72 61 20 6d 65 6d 6f 72 use extra memor
69a0: 79 2c 20 74 68 75 73 0a 20 20 6d 61 6b 69 6e 67 y, thus. making
69b0: 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65 [prepared state
69c0: 6d 65 6e 74 73 5d 20 6c 61 72 67 65 72 20 61 6e ments] larger an
69d0: 64 20 76 65 72 79 20 73 6c 69 67 68 74 6c 79 20 d very slightly
69e0: 73 6c 6f 77 65 72 2c 20 61 6e 64 20 73 6f 20 74 slower, and so t
69f0: 68 65 79 20 61 72 65 0a 20 20 74 75 72 6e 65 64 hey are. turned
6a00: 20 6f 66 66 20 62 79 20 64 65 66 61 75 6c 74 20 off by default
6a10: 61 6e 64 20 69 6e 20 6d 6f 73 74 20 61 70 70 6c and in most appl
6a20: 69 63 61 74 69 6f 6e 2e 20 20 42 75 74 20 73 6f ication. But so
6a30: 6d 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 2c me applications,
6a40: 20 73 75 63 68 0a 20 20 61 73 20 74 68 65 20 5b such. as the [
6a50: 63 6f 6d 6d 61 6e 64 2d 6c 69 6e 65 20 73 68 65 command-line she
6a60: 6c 6c 5d 20 66 6f 72 20 53 51 4c 69 74 65 2c 20 ll] for SQLite,
6a70: 76 61 6c 75 65 20 63 6c 61 72 69 74 79 20 6f 66 value clarity of
6a80: 20 45 58 50 4c 41 49 4e 20 6f 75 74 70 75 74 0a EXPLAIN output.
6a90: 20 20 6f 76 65 72 20 72 61 77 20 70 65 72 66 6f over raw perfo
6aa0: 72 6d 61 6e 63 65 20 61 6e 64 20 73 6f 20 74 68 rmance and so th
6ab0: 69 73 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 is compile-time
6ac0: 6f 70 74 69 6f 6e 20 69 73 20 61 76 61 69 6c 61 option is availa
6ad0: 62 6c 65 20 74 6f 20 74 68 65 6d 2e 0a 20 20 54 ble to them.. T
6ae0: 68 65 20 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 he SQLITE_ENABLE
6af0: 5f 45 58 50 4c 41 49 4e 5f 43 4f 4d 4d 45 4e 54 _EXPLAIN_COMMENT
6b00: 53 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f S compile-time o
6b10: 70 74 69 6f 6e 20 69 73 20 61 6c 73 6f 20 65 6e ption is also en
6b20: 61 62 6c 65 64 0a 20 20 61 75 74 6f 6d 61 74 69 abled. automati
6b30: 63 61 6c 6c 79 20 69 66 20 5b 53 51 4c 49 54 45 cally if [SQLITE
6b40: 5f 44 45 42 55 47 5d 20 69 73 20 65 6e 61 62 6c _DEBUG] is enabl
6b50: 65 64 2e 0a 7d 0a 0a 0a 43 4f 4d 50 49 4c 45 5f ed..}...COMPILE_
6b60: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 OPTION {SQLITE_E
6b70: 4e 41 42 4c 45 5f 46 54 53 33 7d 20 7b 0a 20 20 NABLE_FTS3} {.
6b80: 57 68 65 6e 20 74 68 69 73 20 6f 70 74 69 6f 6e When this option
6b90: 20 69 73 20 64 65 66 69 6e 65 64 20 69 6e 20 74 is defined in t
6ba0: 68 65 20 5b 61 6d 61 6c 67 61 6d 61 74 69 6f 6e he [amalgamation
6bb0: 5d 2c 20 76 65 72 73 69 6f 6e 20 33 0a 20 20 6f ], version 3. o
6bc0: 66 20 74 68 65 20 66 75 6c 6c 2d 74 65 78 74 20 f the full-text
6bd0: 73 65 61 72 63 68 20 65 6e 67 69 6e 65 20 69 73 search engine is
6be0: 20 61 64 64 65 64 20 74 6f 20 74 68 65 20 62 75 added to the bu
6bf0: 69 6c 64 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c ild automaticall
6c00: 79 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 y..}..COMPILE_OP
6c10: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 TION {SQLITE_ENA
6c20: 42 4c 45 5f 46 54 53 33 5f 50 41 52 45 4e 54 48 BLE_FTS3_PARENTH
6c30: 45 53 49 53 7d 20 7b 0a 20 20 54 68 69 73 20 6f ESIS} {. This o
6c40: 70 74 69 6f 6e 20 6d 6f 64 69 66 69 65 73 20 74 ption modifies t
6c50: 68 65 20 71 75 65 72 79 20 70 61 74 74 65 72 6e he query pattern
6c60: 20 70 61 72 73 65 72 20 69 6e 20 46 54 53 33 20 parser in FTS3
6c70: 73 75 63 68 20 74 68 61 74 20 69 74 0a 20 20 73 such that it. s
6c80: 75 70 70 6f 72 74 73 20 6f 70 65 72 61 74 6f 72 upports operator
6c90: 73 20 41 4e 44 20 61 6e 64 20 4e 4f 54 20 28 69 s AND and NOT (i
6ca0: 6e 20 61 64 64 69 74 69 6f 6e 20 74 6f 20 74 68 n addition to th
6cb0: 65 20 75 73 75 61 6c 20 4f 52 20 61 6e 64 20 4e e usual OR and N
6cc0: 45 41 52 29 0a 20 20 61 6e 64 20 61 6c 73 6f 20 EAR). and also
6cd0: 61 6c 6c 6f 77 73 20 71 75 65 72 79 20 65 78 70 allows query exp
6ce0: 72 65 73 73 69 6f 6e 73 20 74 6f 20 63 6f 6e 74 ressions to cont
6cf0: 61 69 6e 20 6e 65 73 74 65 64 20 70 61 72 65 6e ain nested paren
6d00: 74 68 65 73 69 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 thesis..}..COMPI
6d10: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
6d20: 45 5f 45 4e 41 42 4c 45 5f 46 54 53 34 7d 20 7b E_ENABLE_FTS4} {
6d30: 0a 20 20 57 68 65 6e 20 74 68 69 73 20 6f 70 74 . When this opt
6d40: 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 20 69 ion is defined i
6d50: 6e 20 74 68 65 20 5b 61 6d 61 6c 67 61 6d 61 74 n the [amalgamat
6d60: 69 6f 6e 5d 2c 20 76 65 72 73 69 6f 6e 73 20 33 ion], versions 3
6d70: 20 61 6e 64 20 34 0a 20 20 6f 66 20 74 68 65 20 and 4. of the
6d80: 66 75 6c 6c 2d 74 65 78 74 20 73 65 61 72 63 68 full-text search
6d90: 20 65 6e 67 69 6e 65 20 69 73 20 61 64 64 65 64 engine is added
6da0: 20 74 6f 20 74 68 65 20 62 75 69 6c 64 20 61 75 to the build au
6db0: 74 6f 6d 61 74 69 63 61 6c 6c 79 2e 0a 7d 0a 0a tomatically..}..
6dc0: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
6dd0: 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 49 43 SQLITE_ENABLE_IC
6de0: 55 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 U} {. This opti
6df0: 6f 6e 20 63 61 75 73 65 73 20 74 68 65 20 0a 20 on causes the .
6e00: 20 5b 68 74 74 70 3a 2f 2f 77 77 77 2e 69 63 75 [http://www.icu
6e10: 2d 70 72 6f 6a 65 63 74 2e 6f 72 67 2f 20 7c 20 -project.org/ |
6e20: 49 6e 74 65 72 6e 61 74 69 6f 6e 61 6c 20 43 6f International Co
6e30: 6d 70 6f 6e 65 6e 74 73 20 66 6f 72 20 55 6e 69 mponents for Uni
6e40: 63 6f 64 65 5d 0a 20 20 6f 72 20 22 49 43 55 22 code]. or "ICU"
6e50: 20 65 78 74 65 6e 73 69 6f 6e 20 74 6f 20 53 51 extension to SQ
6e60: 4c 69 74 65 20 74 6f 20 62 65 20 61 64 64 65 64 Lite to be added
6e70: 20 74 6f 20 74 68 65 20 62 75 69 6c 64 2e 20 20 to the build.
6e80: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
6e90: 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c ON {SQLITE_ENABL
6ea0: 45 5f 49 4f 54 52 41 43 45 7d 20 7b 0a 20 20 57 E_IOTRACE} {. W
6eb0: 68 65 6e 20 62 6f 74 68 20 74 68 65 20 53 51 4c hen both the SQL
6ec0: 69 74 65 20 63 6f 72 65 20 61 6e 64 20 74 68 65 ite core and the
6ed0: 20 5b 43 6f 6d 6d 61 6e 64 20 4c 69 6e 65 20 49 [Command Line I
6ee0: 6e 74 65 72 66 61 63 65 5d 20 28 43 4c 49 29 20 nterface] (CLI)
6ef0: 61 72 65 20 62 6f 74 68 20 0a 20 20 63 6f 6d 70 are both . comp
6f00: 69 6c 65 64 20 77 69 74 68 20 74 68 69 73 20 6f iled with this o
6f10: 70 74 69 6f 6e 2c 20 74 68 65 6e 20 74 68 65 20 ption, then the
6f20: 43 4c 49 20 70 72 6f 76 69 64 65 73 20 61 6e 20 CLI provides an
6f30: 65 78 74 72 61 20 63 6f 6d 6d 61 6e 64 0a 20 20 extra command.
6f40: 6e 61 6d 65 64 20 22 2e 69 6f 74 72 61 63 65 22 named ".iotrace"
6f50: 20 74 68 61 74 20 70 72 6f 76 69 64 65 73 20 61 that provides a
6f60: 20 6c 6f 77 2d 6c 65 76 65 6c 20 6c 6f 67 20 6f low-level log o
6f70: 66 20 49 2f 4f 20 61 63 74 69 76 69 74 79 2e 0a f I/O activity..
6f80: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 This option is
6f90: 20 65 78 70 65 72 69 6d 65 6e 74 61 6c 20 61 6e experimental an
6fa0: 64 20 6d 61 79 20 62 65 20 64 69 73 63 6f 6e 74 d may be discont
6fb0: 69 6e 75 65 64 20 69 6e 20 61 20 66 75 74 75 72 inued in a futur
6fc0: 65 20 72 65 6c 65 61 73 65 2e 0a 7d 0a 0a 43 4f e release..}..CO
6fd0: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 MPILE_OPTION {SQ
6fe0: 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4c 4f 43 4b LITE_ENABLE_LOCK
6ff0: 49 4e 47 5f 53 54 59 4c 45 7d 20 7b 0a 20 20 54 ING_STYLE} {. T
7000: 68 69 73 20 6f 70 74 69 6f 6e 20 65 6e 61 62 6c his option enabl
7010: 65 73 20 61 64 64 69 74 69 6f 6e 61 6c 20 6c 6f es additional lo
7020: 67 69 63 20 69 6e 20 74 68 65 20 4f 53 20 69 6e gic in the OS in
7030: 74 65 72 66 61 63 65 20 6c 61 79 65 72 20 66 6f terface layer fo
7040: 72 0a 20 20 4d 61 63 20 4f 53 20 58 2e 20 54 68 r. Mac OS X. Th
7050: 65 20 61 64 64 69 74 69 6f 6e 61 6c 20 6c 6f 67 e additional log
7060: 69 63 20 61 74 74 65 6d 70 74 73 20 74 6f 20 64 ic attempts to d
7070: 65 74 65 72 6d 69 6e 65 20 74 68 65 20 74 79 70 etermine the typ
7080: 65 20 6f 66 20 74 68 65 0a 20 20 75 6e 64 65 72 e of the. under
7090: 6c 79 69 6e 67 20 66 69 6c 65 73 79 73 74 65 6d lying filesystem
70a0: 20 61 6e 64 20 63 68 6f 6f 73 65 20 61 6e 64 20 and choose and
70b0: 61 6c 74 65 72 6e 61 74 69 76 65 20 6c 6f 63 6b alternative lock
70c0: 69 6e 67 20 73 74 72 61 74 65 67 79 0a 20 20 74 ing strategy. t
70d0: 68 61 74 20 77 6f 72 6b 73 20 63 6f 72 72 65 63 hat works correc
70e0: 74 6c 79 20 66 6f 72 20 74 68 61 74 20 66 69 6c tly for that fil
70f0: 65 73 79 73 74 65 6d 20 74 79 70 65 2e 20 46 69 esystem type. Fi
7100: 76 65 20 6c 6f 63 6b 69 6e 67 20 73 74 72 61 74 ve locking strat
7110: 65 67 69 65 73 20 0a 20 20 61 72 65 20 61 76 61 egies . are ava
7120: 69 6c 61 62 6c 65 3a 0a 0a 20 20 3c 75 6c 3e 0a ilable:.. <ul>.
7130: 20 20 20 20 3c 6c 69 3e 20 50 4f 53 49 58 20 6c <li> POSIX l
7140: 6f 63 6b 69 6e 67 20 73 74 79 6c 65 2e 20 54 68 ocking style. Th
7150: 69 73 20 69 73 20 74 68 65 20 64 65 66 61 75 6c is is the defaul
7160: 74 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c 65 20 t locking style
7170: 61 6e 64 20 74 68 65 0a 20 20 20 20 20 20 20 20 and the.
7180: 20 73 74 79 6c 65 20 75 73 65 64 20 62 79 20 6f style used by o
7190: 74 68 65 72 20 28 6e 6f 6e 20 4d 61 63 20 4f 53 ther (non Mac OS
71a0: 20 58 29 20 55 6e 69 78 65 73 2e 20 4c 6f 63 6b X) Unixes. Lock
71b0: 73 20 61 72 65 20 6f 62 74 61 69 6e 65 64 20 61 s are obtained a
71c0: 6e 64 20 0a 20 20 20 20 20 20 20 20 20 72 65 6c nd . rel
71d0: 65 61 73 65 64 20 75 73 69 6e 67 20 74 68 65 20 eased using the
71e0: 66 63 6e 74 6c 28 29 20 73 79 73 74 65 6d 20 63 fcntl() system c
71f0: 61 6c 6c 2e 0a 0a 20 20 20 20 3c 6c 69 3e 20 41 all... <li> A
7200: 46 50 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c 65 FP locking style
7210: 2e 20 54 68 69 73 20 6c 6f 63 6b 69 6e 67 20 73 . This locking s
7220: 74 79 6c 65 20 69 73 20 75 73 65 64 20 66 6f 72 tyle is used for
7230: 20 6e 65 74 77 6f 72 6b 20 66 69 6c 65 20 0a 20 network file .
7240: 20 20 20 20 20 20 20 20 73 79 73 74 65 6d 73 20 systems
7250: 74 68 61 74 20 75 73 65 20 74 68 65 20 41 46 50 that use the AFP
7260: 20 28 41 70 70 6c 65 20 46 69 6c 69 6e 67 20 50 (Apple Filing P
7270: 72 6f 74 6f 63 6f 6c 29 20 70 72 6f 74 6f 63 6f rotocol) protoco
7280: 6c 2e 20 4c 6f 63 6b 73 0a 20 20 20 20 20 20 20 l. Locks.
7290: 20 20 61 72 65 20 6f 62 74 61 69 6e 65 64 20 62 are obtained b
72a0: 79 20 63 61 6c 6c 69 6e 67 20 74 68 65 20 6c 69 y calling the li
72b0: 62 72 61 72 79 20 66 75 6e 63 74 69 6f 6e 20 5f brary function _
72c0: 41 46 50 46 53 53 65 74 4c 6f 63 6b 28 29 2e 0a AFPFSSetLock()..
72d0: 0a 20 20 20 20 3c 6c 69 3e 20 46 6c 6f 63 6b 20 . <li> Flock
72e0: 6c 6f 63 6b 69 6e 67 20 73 74 79 6c 65 2e 20 54 locking style. T
72f0: 68 69 73 20 69 73 20 75 73 65 64 20 66 6f 72 20 his is used for
7300: 66 69 6c 65 2d 73 79 73 74 65 6d 73 20 74 68 61 file-systems tha
7310: 74 20 64 6f 20 6e 6f 74 0a 20 20 20 20 20 20 20 t do not.
7320: 20 20 73 75 70 70 6f 72 74 20 50 4f 53 49 58 20 support POSIX
7330: 6c 6f 63 6b 69 6e 67 20 73 74 79 6c 65 2e 20 4c locking style. L
7340: 6f 63 6b 73 20 61 72 65 20 6f 62 74 61 69 6e 65 ocks are obtaine
7350: 64 20 61 6e 64 20 72 65 6c 65 61 73 65 64 20 75 d and released u
7360: 73 69 6e 67 0a 20 20 20 20 20 20 20 20 20 74 68 sing. th
7370: 65 20 66 6c 6f 63 6b 28 29 20 73 79 73 74 65 6d e flock() system
7380: 20 63 61 6c 6c 2e 0a 0a 20 20 20 20 3c 6c 69 3e call... <li>
7390: 20 44 6f 74 2d 66 69 6c 65 20 6c 6f 63 6b 69 6e Dot-file lockin
73a0: 67 20 73 74 79 6c 65 2e 20 54 68 69 73 20 6c 6f g style. This lo
73b0: 63 6b 69 6e 67 20 73 74 79 6c 65 20 69 73 20 75 cking style is u
73c0: 73 65 64 20 77 68 65 6e 20 6e 65 69 74 68 65 72 sed when neither
73d0: 0a 20 20 20 20 20 20 20 20 20 66 6c 6f 63 6b 20 . flock
73e0: 6e 6f 72 20 50 4f 53 49 58 20 6c 6f 63 6b 69 6e nor POSIX lockin
73f0: 67 20 73 74 79 6c 65 73 20 61 72 65 20 73 75 70 g styles are sup
7400: 70 6f 72 74 65 64 20 62 79 20 74 68 65 20 66 69 ported by the fi
7410: 6c 65 20 73 79 73 74 65 6d 2e 0a 20 20 20 20 20 le system..
7420: 20 20 20 20 44 61 74 61 62 61 73 65 20 6c 6f 63 Database loc
7430: 6b 73 20 61 72 65 20 6f 62 74 61 69 6e 65 64 20 ks are obtained
7440: 62 79 20 63 72 65 61 74 69 6e 67 20 61 6e 64 20 by creating and
7450: 65 6e 74 72 79 20 69 6e 20 74 68 65 20 66 69 6c entry in the fil
7460: 65 2d 73 79 73 74 65 6d 0a 20 20 20 20 20 20 20 e-system.
7470: 20 20 61 74 20 61 20 77 65 6c 6c 2d 6b 6e 6f 77 at a well-know
7480: 6e 20 6c 6f 63 61 74 69 6f 6e 20 72 65 6c 61 74 n location relat
7490: 69 76 65 20 74 6f 20 74 68 65 20 64 61 74 61 62 ive to the datab
74a0: 61 73 65 20 66 69 6c 65 20 28 61 20 22 64 6f 74 ase file (a "dot
74b0: 2d 66 69 6c 65 22 29 0a 20 20 20 20 20 20 20 20 -file").
74c0: 20 61 6e 64 20 72 65 6c 69 6e 71 75 69 73 68 65 and relinquishe
74d0: 64 20 62 79 20 64 65 6c 65 74 69 6e 67 20 74 68 d by deleting th
74e0: 65 20 73 61 6d 65 20 66 69 6c 65 2e 0a 0a 20 20 e same file...
74f0: 20 20 3c 6c 69 3e 20 4e 6f 20 6c 6f 63 6b 69 6e <li> No lockin
7500: 67 20 73 74 79 6c 65 2e 20 49 66 20 6e 6f 6e 65 g style. If none
7510: 20 6f 66 20 74 68 65 20 61 62 6f 76 65 20 63 61 of the above ca
7520: 6e 20 62 65 20 73 75 70 70 6f 72 74 65 64 2c 20 n be supported,
7530: 74 68 69 73 20 0a 20 20 20 20 20 20 20 20 20 6c this . l
7540: 6f 63 6b 69 6e 67 20 73 74 79 6c 65 20 69 73 20 ocking style is
7550: 75 73 65 64 2e 20 4e 6f 20 64 61 74 61 62 61 73 used. No databas
7560: 65 20 6c 6f 63 6b 69 6e 67 20 6d 65 63 68 61 6e e locking mechan
7570: 69 73 6d 20 69 73 20 75 73 65 64 2e 20 57 68 65 ism is used. Whe
7580: 6e 0a 20 20 20 20 20 20 20 20 20 74 68 69 73 20 n. this
7590: 73 79 73 74 65 6d 20 69 73 20 75 73 65 64 20 69 system is used i
75a0: 74 20 69 73 20 6e 6f 74 20 73 61 66 65 20 66 6f t is not safe fo
75b0: 72 20 61 20 73 69 6e 67 6c 65 20 64 61 74 61 62 r a single datab
75c0: 61 73 65 20 74 6f 20 62 65 0a 20 20 20 20 20 20 ase to be.
75d0: 20 20 20 61 63 63 65 73 73 65 64 20 62 79 20 6d accessed by m
75e0: 75 6c 74 69 70 6c 65 20 63 6c 69 65 6e 74 73 2e ultiple clients.
75f0: 0a 20 20 3c 2f 75 6c 3e 0a 0a 20 20 41 64 64 69 . </ul>.. Addi
7600: 74 69 6f 6e 61 6c 6c 79 2c 20 66 69 76 65 20 65 tionally, five e
7610: 78 74 72 61 20 5b 56 46 53 5d 20 69 6d 70 6c 65 xtra [VFS] imple
7620: 6d 65 6e 74 61 74 69 6f 6e 73 20 61 72 65 20 70 mentations are p
7630: 72 6f 76 69 64 65 64 20 61 73 20 77 65 6c 6c 20 rovided as well
7640: 61 73 20 74 68 65 0a 20 20 64 65 66 61 75 6c 74 as the. default
7650: 2e 20 42 79 20 73 70 65 63 69 66 79 69 6e 67 20 . By specifying
7660: 6f 6e 65 20 6f 66 20 74 68 65 20 65 78 74 72 61 one of the extra
7670: 20 56 46 53 20 69 6d 70 6c 65 6d 65 6e 74 61 74 VFS implementat
7680: 69 6f 6e 73 20 0a 20 20 77 68 65 6e 20 63 61 6c ions . when cal
7690: 6c 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 6f 70 ling [sqlite3_op
76a0: 65 6e 5f 76 32 28 29 5d 2c 20 61 6e 20 61 70 70 en_v2()], an app
76b0: 6c 69 63 61 74 69 6f 6e 20 6d 61 79 20 62 79 70 lication may byp
76c0: 61 73 73 20 74 68 65 20 66 69 6c 65 2d 73 79 73 ass the file-sys
76d0: 74 65 6d 0a 20 20 64 65 74 65 63 74 69 6f 6e 20 tem. detection
76e0: 6c 6f 67 69 63 20 61 6e 64 20 65 78 70 6c 69 63 logic and explic
76f0: 69 74 6c 79 20 73 65 6c 65 63 74 20 6f 6e 65 20 itly select one
7700: 6f 66 20 74 68 65 20 61 62 6f 76 65 20 6c 6f 63 of the above loc
7710: 6b 69 6e 67 20 73 74 79 6c 65 73 2e 20 54 68 65 king styles. The
7720: 0a 20 20 66 69 76 65 20 65 78 74 72 61 20 5b 56 . five extra [V
7730: 46 53 5d 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 FS] implementati
7740: 6f 6e 73 20 61 72 65 20 63 61 6c 6c 65 64 20 22 ons are called "
7750: 75 6e 69 78 2d 70 6f 73 69 78 22 2c 20 22 75 6e unix-posix", "un
7760: 69 78 2d 61 66 70 22 2c 0a 20 20 22 75 6e 69 78 ix-afp",. "unix
7770: 2d 66 6c 6f 63 6b 22 2c 20 22 75 6e 69 78 2d 64 -flock", "unix-d
7780: 6f 74 66 69 6c 65 22 20 61 6e 64 20 22 75 6e 69 otfile" and "uni
7790: 78 2d 6e 6f 6e 65 22 2e 0a 7d 0a 0a 43 4f 4d 50 x-none"..}..COMP
77a0: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
77b0: 54 45 5f 45 4e 41 42 4c 45 5f 4d 45 4d 4f 52 59 TE_ENABLE_MEMORY
77c0: 5f 4d 41 4e 41 47 45 4d 45 4e 54 7d 20 7b 0a 20 _MANAGEMENT} {.
77d0: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 61 64 64 This option add
77e0: 73 20 65 78 74 72 61 20 6c 6f 67 69 63 20 74 6f s extra logic to
77f0: 20 53 51 4c 69 74 65 20 74 68 61 74 20 61 6c 6c SQLite that all
7800: 6f 77 73 20 69 74 20 74 6f 20 72 65 6c 65 61 73 ows it to releas
7810: 65 20 75 6e 75 73 65 64 0a 20 20 6d 65 6d 6f 72 e unused. memor
7820: 79 20 75 70 6f 6e 20 72 65 71 75 65 73 74 2e 20 y upon request.
7830: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 6d 75 73 This option mus
7840: 74 20 62 65 20 65 6e 61 62 6c 65 64 20 69 6e 20 t be enabled in
7850: 6f 72 64 65 72 20 66 6f 72 20 74 68 65 0a 20 20 order for the.
7860: 5b 73 71 6c 69 74 65 33 5f 72 65 6c 65 61 73 65 [sqlite3_release
7870: 5f 6d 65 6d 6f 72 79 28 29 5d 20 69 6e 74 65 72 _memory()] inter
7880: 66 61 63 65 20 74 6f 20 77 6f 72 6b 2e 20 20 49 face to work. I
7890: 66 20 74 68 69 73 20 63 6f 6d 70 69 6c 65 2d 74 f this compile-t
78a0: 69 6d 65 0a 20 20 6f 70 74 69 6f 6e 20 69 73 20 ime. option is
78b0: 6e 6f 74 20 75 73 65 64 2c 20 74 68 65 20 5b 73 not used, the [s
78c0: 71 6c 69 74 65 33 5f 72 65 6c 65 61 73 65 5f 6d qlite3_release_m
78d0: 65 6d 6f 72 79 28 29 5d 20 69 6e 74 65 72 66 61 emory()] interfa
78e0: 63 65 20 69 73 20 61 20 0a 20 20 6e 6f 2d 6f 70 ce is a . no-op
78f0: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
7900: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 ION {SQLITE_ENAB
7910: 4c 45 5f 4d 45 4d 53 59 53 33 7d 20 7b 0a 20 20 LE_MEMSYS3} {.
7920: 54 68 69 73 20 6f 70 74 69 6f 6e 20 69 6e 63 6c This option incl
7930: 75 64 65 73 20 63 6f 64 65 20 69 6e 20 53 51 4c udes code in SQL
7940: 69 74 65 20 74 68 61 74 20 69 6d 70 6c 65 6d 65 ite that impleme
7950: 6e 74 73 20 61 6e 20 61 6c 74 65 72 6e 61 74 69 nts an alternati
7960: 76 65 0a 20 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f ve. memory allo
7970: 63 61 74 6f 72 2e 20 20 54 68 69 73 20 61 6c 74 cator. This alt
7980: 65 72 6e 61 74 69 76 65 20 6d 65 6d 6f 72 79 20 ernative memory
7990: 61 6c 6c 6f 63 61 74 6f 72 20 69 73 20 6f 6e 6c allocator is onl
79a0: 79 20 65 6e 67 61 67 65 64 0a 20 20 77 68 65 6e y engaged. when
79b0: 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 43 4f 4e the [SQLITE_CON
79c0: 46 49 47 5f 48 45 41 50 5d 20 6f 70 74 69 6f 6e FIG_HEAP] option
79d0: 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e to [sqlite3_con
79e0: 66 69 67 28 29 5d 20 69 73 20 75 73 65 64 20 74 fig()] is used t
79f0: 6f 0a 20 20 73 75 70 70 6c 79 20 61 20 6c 61 72 o. supply a lar
7a00: 67 65 20 63 68 75 6e 6b 20 6f 66 20 6d 65 6d 6f ge chunk of memo
7a10: 72 79 20 66 72 6f 6d 20 77 68 69 63 68 20 61 6c ry from which al
7a20: 6c 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 l memory allocat
7a30: 69 6f 6e 73 20 61 72 65 0a 20 20 74 61 6b 65 6e ions are. taken
7a40: 2e 0a 20 20 54 68 65 20 4d 45 4d 53 59 53 33 20 .. The MEMSYS3
7a50: 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 memory allocator
7a60: 20 75 73 65 73 20 61 20 68 79 62 72 69 64 20 61 uses a hybrid a
7a70: 6c 6c 6f 63 61 74 69 6f 6e 20 61 6c 67 6f 72 69 llocation algori
7a80: 74 68 6d 20 0a 20 20 70 61 74 74 65 72 6e 65 64 thm . patterned
7a90: 20 61 66 74 65 72 20 64 6c 6d 61 6c 6c 6f 63 28 after dlmalloc(
7aa0: 29 2e 20 20 20 4f 6e 6c 79 20 6f 6e 65 20 6f 66 ). Only one of
7ab0: 20 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4d SQLITE_ENABLE_M
7ac0: 45 4d 53 59 53 33 20 61 6e 64 20 0a 20 20 53 51 EMSYS3 and . SQ
7ad0: 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4d 45 4d 53 LITE_ENABLE_MEMS
7ae0: 59 53 35 20 6d 61 79 20 62 65 20 65 6e 61 62 6c YS5 may be enabl
7af0: 65 64 20 61 74 20 6f 6e 63 65 2e 0a 7d 0a 0a 43 ed at once..}..C
7b00: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
7b10: 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4d 45 4d QLITE_ENABLE_MEM
7b20: 53 59 53 35 7d 20 7b 0a 20 20 54 68 69 73 20 6f SYS5} {. This o
7b30: 70 74 69 6f 6e 20 69 6e 63 6c 75 64 65 73 20 63 ption includes c
7b40: 6f 64 65 20 69 6e 20 53 51 4c 69 74 65 20 74 68 ode in SQLite th
7b50: 61 74 20 69 6d 70 6c 65 6d 65 6e 74 73 20 61 6e at implements an
7b60: 20 61 6c 74 65 72 6e 61 74 69 76 65 0a 20 20 6d alternative. m
7b70: 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 2e emory allocator.
7b80: 20 20 54 68 69 73 20 61 6c 74 65 72 6e 61 74 69 This alternati
7b90: 76 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 ve memory alloca
7ba0: 74 6f 72 20 69 73 20 6f 6e 6c 79 20 65 6e 67 61 tor is only enga
7bb0: 67 65 64 0a 20 20 77 68 65 6e 20 74 68 65 20 5b ged. when the [
7bc0: 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 48 45 SQLITE_CONFIG_HE
7bd0: 41 50 5d 20 6f 70 74 69 6f 6e 20 74 6f 20 5b 73 AP] option to [s
7be0: 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d qlite3_config()]
7bf0: 20 69 73 20 75 73 65 64 20 74 6f 0a 20 20 73 75 is used to. su
7c00: 70 70 6c 79 20 61 20 6c 61 72 67 65 20 63 68 75 pply a large chu
7c10: 6e 6b 20 6f 66 20 6d 65 6d 6f 72 79 20 66 72 6f nk of memory fro
7c20: 6d 20 77 68 69 63 68 20 61 6c 6c 20 6d 65 6d 6f m which all memo
7c30: 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 73 20 61 ry allocations a
7c40: 72 65 0a 20 20 74 61 6b 65 6e 2e 0a 20 20 54 68 re. taken.. Th
7c50: 65 20 4d 45 4d 53 59 53 35 20 6d 6f 64 75 6c 65 e MEMSYS5 module
7c60: 20 72 6f 75 6e 64 73 20 61 6c 6c 20 61 6c 6c 6f rounds all allo
7c70: 63 61 74 69 6f 6e 73 20 75 70 20 74 6f 20 74 68 cations up to th
7c80: 65 20 6e 65 78 74 20 70 6f 77 65 72 0a 20 20 6f e next power. o
7c90: 66 20 74 77 6f 20 61 6e 64 20 75 73 65 73 20 61 f two and uses a
7ca0: 20 66 69 72 73 74 2d 66 69 74 2c 20 62 75 64 64 first-fit, budd
7cb0: 79 2d 61 6c 6c 6f 63 61 74 6f 72 20 61 6c 67 6f y-allocator algo
7cc0: 72 69 74 68 6d 0a 20 20 74 68 61 74 20 70 72 6f rithm. that pro
7cd0: 76 69 64 65 73 20 73 74 72 6f 6e 67 20 67 75 61 vides strong gua
7ce0: 72 61 6e 74 65 65 73 20 61 67 61 69 6e 73 74 20 rantees against
7cf0: 66 72 61 67 6d 65 6e 74 61 74 69 6f 6e 20 61 6e fragmentation an
7d00: 64 20 62 72 65 61 6b 64 6f 77 6e 0a 20 20 73 75 d breakdown. su
7d10: 62 6a 65 63 74 20 74 6f 20 63 65 72 74 61 69 6e bject to certain
7d20: 20 6f 70 65 72 61 74 69 6e 67 20 63 6f 6e 73 74 operating const
7d30: 72 61 69 6e 74 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 raints..}..COMPI
7d40: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
7d50: 45 5f 45 4e 41 42 4c 45 5f 52 54 52 45 45 7d 20 E_ENABLE_RTREE}
7d60: 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 {. This option
7d70: 63 61 75 73 65 73 20 53 51 4c 69 74 65 20 74 6f causes SQLite to
7d80: 20 69 6e 63 6c 75 64 65 20 73 75 70 70 6f 72 74 include support
7d90: 20 66 6f 72 20 74 68 65 0a 20 20 5b 72 74 72 65 for the. [rtre
7da0: 65 20 7c 20 52 2a 54 72 65 65 20 69 6e 64 65 78 e | R*Tree index
7db0: 20 65 78 74 65 6e 73 69 6f 6e 5d 2e 0a 7d 0a 0a extension]..}..
7dc0: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
7dd0: 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 53 54 SQLITE_ENABLE_ST
7de0: 4d 54 5f 53 43 41 4e 53 54 41 54 55 53 7d 20 7b MT_SCANSTATUS} {
7df0: 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 65 . This option e
7e00: 6e 61 62 6c 65 73 20 74 68 65 20 5b 73 71 6c 69 nables the [sqli
7e10: 74 65 33 5f 73 74 6d 74 5f 73 63 61 6e 73 74 61 te3_stmt_scansta
7e20: 74 75 73 28 29 5d 20 69 6e 74 65 72 66 61 63 65 tus()] interface
7e30: 2e 20 20 54 68 65 0a 20 20 5b 73 71 6c 69 74 65 . The. [sqlite
7e40: 33 5f 73 74 6d 74 5f 73 63 61 6e 73 74 61 74 75 3_stmt_scanstatu
7e50: 73 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 69 s()] interface i
7e60: 73 20 6e 6f 72 6d 61 6c 6c 79 20 6f 6d 69 74 74 s normally omitt
7e70: 65 64 20 66 72 6f 6d 20 74 68 65 20 62 75 69 6c ed from the buil
7e80: 64 0a 20 20 62 65 63 61 75 73 65 20 69 74 20 69 d. because it i
7e90: 6d 70 6f 73 65 73 20 61 20 73 6d 61 6c 6c 20 70 mposes a small p
7ea0: 65 72 66 6f 72 6d 61 6e 63 65 20 70 65 6e 61 6c erformance penal
7eb0: 74 79 2c 20 65 76 65 6e 20 6f 6e 20 73 74 61 74 ty, even on stat
7ec0: 65 6d 65 6e 74 73 20 74 68 61 74 0a 20 20 64 6f ements that. do
7ed0: 20 6e 6f 74 20 75 73 65 20 74 68 65 20 66 65 61 not use the fea
7ee0: 74 75 72 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 ture..}..COMPILE
7ef0: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
7f00: 52 54 52 45 45 5f 49 4e 54 5f 4f 4e 4c 59 7d 20 RTREE_INT_ONLY}
7f10: 7b 0a 20 20 49 66 20 74 68 69 73 20 6f 70 74 69 {. If this opti
7f20: 6f 6e 20 69 73 20 75 73 65 64 20 74 6f 67 65 74 on is used toget
7f30: 68 65 72 20 77 69 74 68 20 5b 53 51 4c 49 54 45 her with [SQLITE
7f40: 5f 45 4e 41 42 4c 45 5f 52 54 52 45 45 5d 20 74 _ENABLE_RTREE] t
7f50: 68 65 6e 20 74 68 65 0a 20 20 5b 72 74 72 65 65 hen the. [rtree
7f60: 20 7c 20 52 2a 54 72 65 65 20 65 78 74 65 6e 73 | R*Tree extens
7f70: 69 6f 6e 5d 20 77 69 6c 6c 20 6f 6e 6c 79 20 73 ion] will only s
7f80: 74 6f 72 65 20 33 32 2d 62 69 74 20 73 69 67 6e tore 32-bit sign
7f90: 65 64 20 69 6e 74 65 67 65 72 0a 20 20 63 6f 6f ed integer. coo
7fa0: 72 64 69 6e 61 74 65 73 20 61 6e 64 20 61 6c 6c rdinates and all
7fb0: 20 69 6e 74 65 72 6e 61 6c 20 63 6f 6d 70 75 74 internal comput
7fc0: 61 74 69 6f 6e 73 20 77 69 6c 6c 20 62 65 20 64 ations will be d
7fd0: 6f 6e 65 20 75 73 69 6e 67 20 69 6e 74 65 67 65 one using intege
7fe0: 72 73 0a 20 20 69 6e 73 74 65 61 64 20 6f 66 20 rs. instead of
7ff0: 66 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 20 6e floating point n
8000: 75 6d 62 65 72 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 umbers..}..COMPI
8010: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
8020: 45 5f 45 4e 41 42 4c 45 5f 53 51 4c 4c 4f 47 7d E_ENABLE_SQLLOG}
8030: 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e {. This option
8040: 20 65 6e 61 62 6c 65 73 20 65 78 74 72 61 20 63 enables extra c
8050: 6f 64 65 20 28 65 73 70 65 63 69 61 6c 6c 79 20 ode (especially
8060: 74 68 65 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 the [SQLITE_CONF
8070: 49 47 5f 53 51 4c 4c 4f 47 5d 0a 20 20 6f 70 74 IG_SQLLOG]. opt
8080: 69 6f 6e 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f ion to [sqlite3_
8090: 63 6f 6e 66 69 67 28 29 5d 29 20 74 68 61 74 20 config()]) that
80a0: 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20 63 can be used to c
80b0: 72 65 61 74 65 20 6c 6f 67 73 20 6f 66 20 61 6c reate logs of al
80c0: 6c 0a 20 20 53 51 4c 69 74 65 20 70 72 6f 63 65 l. SQLite proce
80d0: 73 73 69 6e 67 20 70 65 72 66 6f 72 6d 65 64 20 ssing performed
80e0: 62 79 20 61 6e 20 61 70 70 6c 69 63 61 74 69 6f by an applicatio
80f0: 6e 2e 20 20 54 68 65 73 65 20 6c 6f 67 73 20 63 n. These logs c
8100: 61 6e 20 62 65 20 75 73 65 66 75 6c 0a 20 20 69 an be useful. i
8110: 6e 20 64 6f 69 6e 67 20 6f 66 66 2d 6c 69 6e 65 n doing off-line
8120: 20 61 6e 61 6c 79 73 69 73 20 6f 66 20 74 68 65 analysis of the
8130: 20 62 65 68 61 76 69 6f 72 20 6f 66 20 61 6e 20 behavior of an
8140: 61 70 70 6c 69 63 61 74 69 6f 6e 2c 20 61 6e 64 application, and
8150: 20 65 73 70 65 63 69 61 6c 6c 79 0a 20 20 66 6f especially. fo
8160: 72 20 70 65 72 66 6f 72 6d 61 6e 63 65 20 61 6e r performance an
8170: 61 6c 79 73 69 73 2e 20 20 49 6e 20 6f 72 64 65 alysis. In orde
8180: 72 20 66 6f 72 20 74 68 65 20 53 51 4c 49 54 45 r for the SQLITE
8190: 5f 45 4e 41 42 4c 45 5f 53 51 4c 4c 4f 47 20 6f _ENABLE_SQLLOG o
81a0: 70 74 69 6f 6e 20 74 6f 20 0a 20 20 62 65 20 75 ption to . be u
81b0: 73 65 66 75 6c 2c 20 73 6f 6d 65 20 65 78 74 72 seful, some extr
81c0: 61 20 63 6f 64 65 20 69 73 20 72 65 71 75 69 72 a code is requir
81d0: 65 64 2e 20 20 54 68 65 20 0a 20 20 3c 61 20 68 ed. The . <a h
81e0: 72 65 66 3d 22 68 74 74 70 3a 2f 2f 77 77 77 2e ref="http://www.
81f0: 73 71 6c 69 74 65 2e 6f 72 67 2f 73 72 63 2f 64 sqlite.org/src/d
8200: 6f 63 2f 74 72 75 6e 6b 2f 73 72 63 2f 74 65 73 oc/trunk/src/tes
8210: 74 5f 73 71 6c 6c 6f 67 2e 63 22 3e 22 74 65 73 t_sqllog.c">"tes
8220: 74 5f 73 71 6c 6c 6f 67 2e 63 22 3c 2f 61 3e 0a t_sqllog.c"</a>.
8230: 20 20 73 6f 75 72 63 65 20 63 6f 64 65 0a 20 20 source code.
8240: 66 69 6c 65 20 69 6e 20 74 68 65 20 53 51 4c 69 file in the SQLi
8250: 74 65 20 73 6f 75 72 63 65 20 74 72 65 65 20 69 te source tree i
8260: 73 20 61 20 77 6f 72 6b 69 6e 67 20 65 78 61 6d s a working exam
8270: 70 6c 65 20 6f 66 20 74 68 65 20 72 65 71 75 69 ple of the requi
8280: 72 65 64 20 65 78 74 72 61 0a 20 20 63 6f 64 65 red extra. code
8290: 2e 20 20 4f 6e 20 75 6e 69 78 20 61 6e 64 20 77 . On unix and w
82a0: 69 6e 64 6f 77 73 20 73 79 73 74 65 6d 73 2c 20 indows systems,
82b0: 61 20 64 65 76 65 6c 6f 70 65 72 20 63 61 6e 20 a developer can
82c0: 61 70 70 65 6e 64 20 74 68 65 20 74 65 78 74 20 append the text
82d0: 6f 66 20 74 68 65 0a 20 20 22 74 65 73 74 5f 73 of the. "test_s
82e0: 71 6c 6c 6f 67 2e 63 22 20 73 6f 75 72 63 65 20 qllog.c" source
82f0: 63 6f 64 65 20 66 69 6c 65 20 74 6f 20 74 68 65 code file to the
8300: 20 65 6e 64 20 6f 66 20 61 6e 20 22 73 71 6c 69 end of an "sqli
8310: 74 65 33 2e 63 22 20 61 6d 61 6c 67 61 6d 61 74 te3.c" amalgamat
8320: 69 6f 6e 2c 0a 20 20 72 65 63 6f 6d 70 69 6c 65 ion,. recompile
8330: 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e the application
8340: 20 75 73 69 6e 67 20 74 68 65 20 2d 44 53 51 4c using the -DSQL
8350: 49 54 45 5f 45 4e 41 42 4c 45 5f 53 51 4c 4c 4f ITE_ENABLE_SQLLO
8360: 47 20 6f 70 74 69 6f 6e 2c 20 74 68 65 6e 20 0a G option, then .
8370: 20 20 63 6f 6e 74 72 6f 6c 20 6c 6f 67 67 69 6e control loggin
8380: 67 20 75 73 69 6e 67 20 65 6e 76 69 72 6f 6e 6d g using environm
8390: 65 6e 74 20 76 61 72 69 61 62 6c 65 73 2e 20 20 ent variables.
83a0: 53 65 65 20 74 68 65 20 68 65 61 64 65 72 20 63 See the header c
83b0: 6f 6d 6d 65 6e 74 20 6f 6e 20 0a 20 20 74 68 65 omment on . the
83c0: 20 22 74 65 73 74 5f 73 71 6c 6c 6f 67 2e 63 22 "test_sqllog.c"
83d0: 20 73 6f 75 72 63 65 20 66 69 6c 65 20 66 6f 72 source file for
83e0: 20 61 64 64 69 74 69 6f 6e 61 6c 20 64 65 74 61 additional deta
83f0: 69 6c 2e 20 20 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 il. .}..COMPILE
8400: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
8410: 45 4e 41 42 4c 45 5f 53 54 41 54 32 7d 20 7b 0a ENABLE_STAT2} {.
8420: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 75 73 This option us
8430: 65 64 20 74 6f 20 63 61 75 73 65 20 74 68 65 20 ed to cause the
8440: 5b 41 4e 41 4c 59 5a 45 5d 20 63 6f 6d 6d 61 6e [ANALYZE] comman
8450: 64 20 74 6f 20 63 6f 6c 6c 65 63 74 0a 20 20 69 d to collect. i
8460: 6e 64 65 78 20 68 69 73 74 6f 67 72 61 6d 20 64 ndex histogram d
8470: 61 74 61 20 69 6e 20 74 68 65 20 3c 62 3e 73 71 ata in the <b>sq
8480: 6c 69 74 65 5f 73 74 61 74 32 3c 2f 62 3e 20 74 lite_stat2</b> t
8490: 61 62 6c 65 2e 20 20 42 75 74 20 74 68 61 74 0a able. But that.
84a0: 20 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74 79 20 functionality
84b0: 77 61 73 20 73 75 70 65 72 63 65 64 65 64 20 62 was superceded b
84c0: 79 20 5b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 y [SQLITE_ENABLE
84d0: 5f 53 54 41 54 33 5d 20 61 73 20 6f 66 0a 20 20 _STAT3] as of.
84e0: 53 51 4c 69 74 65 20 76 65 72 73 69 6f 6e 20 33 SQLite version 3
84f0: 2e 37 2e 39 2e 20 20 54 68 65 20 53 51 4c 49 54 .7.9. The SQLIT
8500: 45 5f 45 4e 41 42 4c 45 5f 53 54 41 54 32 20 63 E_ENABLE_STAT2 c
8510: 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 ompile-time opti
8520: 6f 6e 0a 20 20 69 73 20 6e 6f 77 20 61 20 6e 6f on. is now a no
8530: 2d 6f 70 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f -op..}..COMPILE_
8540: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 OPTION {SQLITE_E
8550: 4e 41 42 4c 45 5f 53 54 41 54 33 7d 20 7b 0a 20 NABLE_STAT3} {.
8560: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 61 64 64 This option add
8570: 73 20 61 64 64 69 74 69 6f 6e 61 6c 20 6c 6f 67 s additional log
8580: 69 63 20 74 6f 20 74 68 65 20 5b 41 4e 41 4c 59 ic to the [ANALY
8590: 5a 45 5d 20 63 6f 6d 6d 61 6e 64 20 61 6e 64 20 ZE] command and
85a0: 74 6f 0a 20 20 74 68 65 20 5b 71 75 65 72 79 20 to. the [query
85b0: 70 6c 61 6e 6e 65 72 5d 20 74 68 61 74 20 63 61 planner] that ca
85c0: 6e 20 68 65 6c 70 20 53 51 4c 69 74 65 20 74 6f n help SQLite to
85d0: 20 63 68 6f 73 65 20 61 20 62 65 74 74 65 72 20 chose a better
85e0: 71 75 65 72 79 20 70 6c 61 6e 0a 20 20 75 6e 64 query plan. und
85f0: 65 72 20 63 65 72 74 61 69 6e 20 73 69 74 75 61 er certain situa
8600: 74 69 6f 6e 73 2e 20 20 54 68 65 20 5b 41 4e 41 tions. The [ANA
8610: 4c 59 5a 45 5d 20 63 6f 6d 6d 61 6e 64 20 69 73 LYZE] command is
8620: 20 65 6e 68 61 6e 63 65 64 20 74 6f 20 63 6f 6c enhanced to col
8630: 6c 65 63 74 0a 20 20 68 69 73 74 6f 67 72 61 6d lect. histogram
8640: 20 64 61 74 61 20 66 72 6f 6d 20 74 68 65 20 6c data from the l
8650: 65 66 74 2d 6d 6f 73 74 20 63 6f 6c 75 6d 6e 20 eft-most column
8660: 6f 66 20 65 61 63 68 20 69 6e 64 65 78 20 61 6e of each index an
8670: 64 20 73 74 6f 72 65 20 74 68 61 74 20 64 61 74 d store that dat
8680: 61 0a 20 20 69 6e 20 74 68 65 20 5b 73 71 6c 69 a. in the [sqli
8690: 74 65 5f 73 74 61 74 33 5d 20 74 61 62 6c 65 2e te_stat3] table.
86a0: 20 20 54 68 65 20 71 75 65 72 79 20 70 6c 61 6e The query plan
86b0: 6e 65 72 20 77 69 6c 6c 20 74 68 65 6e 20 75 73 ner will then us
86c0: 65 20 74 68 65 0a 20 20 68 69 73 74 6f 67 72 61 e the. histogra
86d0: 6d 20 64 61 74 61 20 74 6f 20 68 65 6c 70 20 69 m data to help i
86e0: 74 20 6d 61 6b 65 20 62 65 74 74 65 72 20 69 6e t make better in
86f0: 64 65 78 20 63 68 6f 69 63 65 73 2e 20 20 4e 6f dex choices. No
8700: 74 65 2c 20 68 6f 77 65 76 65 72 2c 0a 20 20 74 te, however,. t
8710: 68 61 74 20 74 68 65 20 75 73 65 20 6f 66 20 68 hat the use of h
8720: 69 73 74 6f 67 72 61 6d 20 64 61 74 61 20 69 6e istogram data in
8730: 20 71 75 65 72 79 20 70 6c 61 6e 6e 65 72 20 76 query planner v
8740: 69 6f 6c 61 74 65 73 20 74 68 65 0a 20 20 5b 71 iolates the. [q
8750: 75 65 72 79 20 70 6c 61 6e 6e 65 72 20 73 74 61 uery planner sta
8760: 62 69 6c 69 74 79 20 67 75 61 72 61 6e 74 65 65 bility guarantee
8770: 5d 20 77 68 69 63 68 20 69 73 20 69 6d 70 6f 72 ] which is impor
8780: 74 61 6e 74 20 74 6f 20 73 6f 6d 65 20 61 70 70 tant to some app
8790: 6c 69 63 61 74 69 6f 6e 73 2e 0a 20 20 3c 70 3e lications.. <p>
87a0: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
87b0: 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c ON {SQLITE_ENABL
87c0: 45 5f 53 54 41 54 34 7d 20 7b 0a 20 20 54 68 69 E_STAT4} {. Thi
87d0: 73 20 6f 70 74 69 6f 6e 20 61 64 64 73 20 61 64 s option adds ad
87e0: 64 69 74 69 6f 6e 61 6c 20 6c 6f 67 69 63 20 74 ditional logic t
87f0: 6f 20 74 68 65 20 5b 41 4e 41 4c 59 5a 45 5d 20 o the [ANALYZE]
8800: 63 6f 6d 6d 61 6e 64 20 61 6e 64 20 74 6f 0a 20 command and to.
8810: 20 74 68 65 20 5b 71 75 65 72 79 20 70 6c 61 6e the [query plan
8820: 6e 65 72 5d 20 74 68 61 74 20 63 61 6e 20 68 65 ner] that can he
8830: 6c 70 20 53 51 4c 69 74 65 20 74 6f 20 63 68 6f lp SQLite to cho
8840: 73 65 20 61 20 62 65 74 74 65 72 20 71 75 65 72 se a better quer
8850: 79 20 70 6c 61 6e 0a 20 20 75 6e 64 65 72 20 63 y plan. under c
8860: 65 72 74 61 69 6e 20 73 69 74 75 61 74 69 6f 6e ertain situation
8870: 73 2e 20 20 54 68 65 20 5b 41 4e 41 4c 59 5a 45 s. The [ANALYZE
8880: 5d 20 63 6f 6d 6d 61 6e 64 20 69 73 20 65 6e 68 ] command is enh
8890: 61 6e 63 65 64 20 74 6f 20 63 6f 6c 6c 65 63 74 anced to collect
88a0: 0a 20 20 68 69 73 74 6f 67 72 61 6d 20 64 61 74 . histogram dat
88b0: 61 20 66 72 6f 6d 20 61 6c 6c 20 63 6f 6c 75 6d a from all colum
88c0: 6e 73 20 6f 66 20 65 76 65 72 79 20 69 6e 64 65 ns of every inde
88d0: 78 20 61 6e 64 20 73 74 6f 72 65 20 74 68 61 74 x and store that
88e0: 20 64 61 74 61 0a 20 20 69 6e 20 74 68 65 20 5b data. in the [
88f0: 73 71 6c 69 74 65 5f 73 74 61 74 34 5d 20 74 61 sqlite_stat4] ta
8900: 62 6c 65 2e 20 20 54 68 65 20 71 75 65 72 79 20 ble. The query
8910: 70 6c 61 6e 6e 65 72 20 77 69 6c 6c 20 74 68 65 planner will the
8920: 6e 20 75 73 65 20 74 68 65 0a 20 20 68 69 73 74 n use the. hist
8930: 6f 67 72 61 6d 20 64 61 74 61 20 74 6f 20 68 65 ogram data to he
8940: 6c 70 20 69 74 20 6d 61 6b 65 20 62 65 74 74 65 lp it make bette
8950: 72 20 69 6e 64 65 78 20 63 68 6f 69 63 65 73 2e r index choices.
8960: 20 20 54 68 65 20 64 6f 77 6e 73 69 64 65 20 6f The downside o
8970: 66 0a 20 20 74 68 69 73 20 63 6f 6d 70 69 6c 65 f. this compile
8980: 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20 69 73 20 -time option is
8990: 74 68 61 74 20 69 74 20 76 69 6f 6c 61 74 65 73 that it violates
89a0: 20 74 68 65 0a 20 20 5b 71 75 65 72 79 20 70 6c the. [query pl
89b0: 61 6e 6e 65 72 20 73 74 61 62 69 6c 69 74 79 20 anner stability
89c0: 67 75 61 72 61 6e 74 65 65 5d 20 6d 61 6b 69 6e guarantee] makin
89d0: 67 20 69 74 20 6d 6f 72 65 20 64 69 66 66 69 63 g it more diffic
89e0: 75 6c 74 20 74 6f 20 65 6e 73 75 72 65 0a 20 20 ult to ensure.
89f0: 63 6f 6e 73 69 73 74 65 6e 74 20 70 65 72 66 6f consistent perfo
8a00: 72 6d 61 6e 63 65 20 69 6e 20 6d 61 73 73 2d 70 rmance in mass-p
8a10: 72 6f 64 75 63 65 64 20 61 70 70 6c 69 63 61 74 roduced applicat
8a20: 69 6f 6e 73 2e 0a 20 20 3c 70 3e 0a 20 20 53 51 ions.. <p>. SQ
8a30: 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 53 54 41 54 LITE_ENABLE_STAT
8a40: 34 20 69 73 20 61 6e 20 65 6e 68 61 6e 63 65 6d 4 is an enhancem
8a50: 65 6e 74 20 6f 66 20 5b 53 51 4c 49 54 45 5f 45 ent of [SQLITE_E
8a60: 4e 41 42 4c 45 5f 53 54 41 54 33 5d 2e 20 20 53 NABLE_STAT3]. S
8a70: 54 41 54 33 0a 20 20 6f 6e 6c 79 20 72 65 63 6f TAT3. only reco
8a80: 72 64 65 64 20 68 69 73 74 6f 67 72 61 6d 20 64 rded histogram d
8a90: 61 74 61 20 66 6f 72 20 74 68 65 20 6c 65 66 74 ata for the left
8aa0: 2d 6d 6f 73 74 20 63 6f 6c 75 6d 6e 20 6f 66 20 -most column of
8ab0: 65 61 63 68 20 69 6e 64 65 78 0a 20 20 77 68 65 each index. whe
8ac0: 72 65 61 73 20 74 68 65 20 53 54 41 54 34 20 65 reas the STAT4 e
8ad0: 6e 68 61 6e 63 65 6d 65 6e 74 20 72 65 63 6f 72 nhancement recor
8ae0: 64 73 20 68 69 73 74 6f 67 72 61 6d 20 64 61 74 ds histogram dat
8af0: 61 20 66 72 6f 6d 20 61 6c 6c 20 63 6f 6c 75 6d a from all colum
8b00: 6e 73 0a 20 20 6f 66 20 65 61 63 68 20 69 6e 64 ns. of each ind
8b10: 65 78 2e 0a 20 20 54 68 65 20 5b 53 51 4c 49 54 ex.. The [SQLIT
8b20: 45 5f 45 4e 41 42 4c 45 5f 53 54 41 54 33 5d 20 E_ENABLE_STAT3]
8b30: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 compile-time opt
8b40: 69 6f 6e 20 69 73 20 61 20 6e 6f 2d 6f 70 20 61 ion is a no-op a
8b50: 6e 64 20 69 73 20 69 67 6e 6f 72 65 64 0a 20 20 nd is ignored.
8b60: 69 66 20 74 68 65 20 53 51 4c 49 54 45 5f 45 4e if the SQLITE_EN
8b70: 41 42 4c 45 5f 53 54 41 54 34 20 63 6f 6d 70 69 ABLE_STAT4 compi
8b80: 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20 69 le-time option i
8b90: 73 20 75 73 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 s used..}..COMPI
8ba0: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
8bb0: 45 5f 45 4e 41 42 4c 45 5f 54 52 45 45 5f 45 58 E_ENABLE_TREE_EX
8bc0: 50 4c 41 49 4e 7d 20 7b 0a 20 20 54 68 69 73 20 PLAIN} {. This
8bd0: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 compile-time opt
8be0: 69 6f 6e 20 69 73 20 6e 6f 20 6c 6f 6e 67 65 72 ion is no longer
8bf0: 20 75 73 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c used..}..COMPIL
8c00: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
8c10: 5f 45 4e 41 42 4c 45 5f 55 50 44 41 54 45 5f 44 _ENABLE_UPDATE_D
8c20: 45 4c 45 54 45 5f 4c 49 4d 49 54 7d 20 7b 0a 20 ELETE_LIMIT} {.
8c30: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 65 6e 61 This option ena
8c40: 62 6c 65 73 20 61 6e 20 6f 70 74 69 6f 6e 61 6c bles an optional
8c50: 20 4f 52 44 45 52 20 42 59 20 61 6e 64 20 4c 49 ORDER BY and LI
8c60: 4d 49 54 20 63 6c 61 75 73 65 20 6f 6e 20 0a 20 MIT clause on .
8c70: 20 5b 55 50 44 41 54 45 5d 20 61 6e 64 20 5b 44 [UPDATE] and [D
8c80: 45 4c 45 54 45 5d 20 73 74 61 74 65 6d 65 6e 74 ELETE] statement
8c90: 73 2e 0a 0a 20 20 3c 70 3e 49 66 20 74 68 69 73 s... <p>If this
8ca0: 20 6f 70 74 69 6f 6e 20 69 73 20 64 65 66 69 6e option is defin
8cb0: 65 64 2c 20 74 68 65 6e 20 69 74 20 6d 75 73 74 ed, then it must
8cc0: 20 61 6c 73 6f 20 62 65 20 0a 20 20 64 65 66 69 also be . defi
8cd0: 6e 65 64 20 77 68 65 6e 20 75 73 69 6e 67 20 74 ned when using t
8ce0: 68 65 20 27 6c 65 6d 6f 6e 27 20 74 6f 6f 6c 20 he 'lemon' tool
8cf0: 74 6f 20 67 65 6e 65 72 61 74 65 20 61 20 70 61 to generate a pa
8d00: 72 73 65 2e 63 0a 20 20 66 69 6c 65 2e 20 42 65 rse.c. file. Be
8d10: 63 61 75 73 65 20 6f 66 20 74 68 69 73 2c 20 74 cause of this, t
8d20: 68 69 73 20 6f 70 74 69 6f 6e 20 6d 61 79 20 6f his option may o
8d30: 6e 6c 79 20 62 65 20 75 73 65 64 20 77 68 65 6e nly be used when
8d40: 20 74 68 65 20 6c 69 62 72 61 72 79 20 69 73 20 the library is
8d50: 62 75 69 6c 74 0a 20 20 66 72 6f 6d 20 73 6f 75 built. from sou
8d60: 72 63 65 2c 20 6e 6f 74 20 66 72 6f 6d 20 74 68 rce, not from th
8d70: 65 20 5b 61 6d 61 6c 67 61 6d 61 74 69 6f 6e 5d e [amalgamation]
8d80: 20 6f 72 20 66 72 6f 6d 20 74 68 65 20 63 6f 6c or from the col
8d90: 6c 65 63 74 69 6f 6e 20 6f 66 0a 20 20 70 72 65 lection of. pre
8da0: 2d 70 61 63 6b 61 67 65 64 20 43 20 66 69 6c 65 -packaged C file
8db0: 73 20 70 72 6f 76 69 64 65 64 20 66 6f 72 20 6e s provided for n
8dc0: 6f 6e 2d 55 6e 69 78 20 6c 69 6b 65 20 70 6c 61 on-Unix like pla
8dd0: 74 66 6f 72 6d 73 20 6f 6e 20 74 68 65 20 77 65 tforms on the we
8de0: 62 73 69 74 65 2e 0a 20 20 3c 2f 70 3e 0a 7d 0a bsite.. </p>.}.
8df0: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
8e00: 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 55 {SQLITE_ENABLE_U
8e10: 4e 4c 4f 43 4b 5f 4e 4f 54 49 46 59 7d 20 7b 0a NLOCK_NOTIFY} {.
8e20: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 65 6e This option en
8e30: 61 62 6c 65 73 20 74 68 65 20 5b 73 71 6c 69 74 ables the [sqlit
8e40: 65 33 5f 75 6e 6c 6f 63 6b 5f 6e 6f 74 69 66 79 e3_unlock_notify
8e50: 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 61 6e ()] interface an
8e60: 64 0a 20 20 69 74 73 20 61 73 73 6f 63 69 61 74 d. its associat
8e70: 65 64 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74 79 ed functionality
8e80: 2e 20 20 53 65 65 20 74 68 65 20 64 6f 63 75 6d . See the docum
8e90: 65 6e 74 61 74 69 6f 6e 20 74 69 74 6c 65 64 0a entation titled.
8ea0: 20 20 5b 55 73 69 6e 67 20 74 68 65 20 53 51 4c [Using the SQL
8eb0: 69 74 65 20 55 6e 6c 6f 63 6b 20 4e 6f 74 69 66 ite Unlock Notif
8ec0: 69 63 61 74 69 6f 6e 20 46 65 61 74 75 72 65 5d ication Feature]
8ed0: 20 66 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c 0a for additional.
8ee0: 20 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 0a 7d information..}
8ef0: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
8f00: 20 7b 53 51 4c 49 54 45 5f 53 4f 55 4e 44 45 58 {SQLITE_SOUNDEX
8f10: 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f } {. This optio
8f20: 6e 20 65 6e 61 62 6c 65 73 20 74 68 65 20 5b 73 n enables the [s
8f30: 6f 75 6e 64 65 78 28 29 20 53 51 4c 20 66 75 6e oundex() SQL fun
8f40: 63 74 69 6f 6e 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 ction]..}..COMPI
8f50: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
8f60: 45 5f 55 53 45 5f 46 43 4e 54 4c 5f 54 52 41 43 E_USE_FCNTL_TRAC
8f70: 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 E} {. This opti
8f80: 6f 6e 20 63 61 75 73 65 73 20 53 51 4c 69 74 65 on causes SQLite
8f90: 20 74 6f 20 69 73 73 75 65 20 65 78 74 72 61 20 to issue extra
8fa0: 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f 54 52 [SQLITE_FCNTL_TR
8fb0: 41 43 45 5d 20 66 69 6c 65 20 63 6f 6e 74 72 6f ACE] file contro
8fc0: 6c 73 0a 20 20 74 6f 20 70 72 6f 76 69 64 65 20 ls. to provide
8fd0: 73 75 70 70 6c 65 6d 65 6e 74 61 72 79 20 69 6e supplementary in
8fe0: 66 6f 72 6d 61 74 69 6f 6e 20 74 6f 20 74 68 65 formation to the
8ff0: 20 56 46 53 2e 20 20 54 68 65 20 22 76 66 73 6c VFS. The "vfsl
9000: 6f 67 2e 63 22 20 65 78 74 65 6e 73 69 6f 6e 0a og.c" extension.
9010: 20 20 6d 61 6b 65 73 20 75 73 65 20 6f 66 20 74 makes use of t
9020: 68 69 73 20 74 6f 20 70 72 6f 76 69 64 65 20 65 his to provide e
9030: 6e 68 61 6e 63 65 64 20 6c 6f 67 73 20 6f 66 20 nhanced logs of
9040: 56 46 53 20 61 63 74 69 76 69 74 79 2e 0a 7d 0a VFS activity..}.
9050: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
9060: 7b 59 59 54 52 41 43 4b 4d 41 58 53 54 41 43 4b {YYTRACKMAXSTACK
9070: 44 45 50 54 48 7d 20 7b 0a 20 20 54 68 69 73 20 DEPTH} {. This
9080: 6f 70 74 69 6f 6e 20 63 61 75 73 65 73 20 74 68 option causes th
9090: 65 20 4c 41 4c 52 28 31 29 20 70 61 72 73 65 72 e LALR(1) parser
90a0: 20 73 74 61 63 6b 20 64 65 70 74 68 20 74 6f 20 stack depth to
90b0: 62 65 20 74 72 61 63 6b 65 64 0a 20 20 61 6e 64 be tracked. and
90c0: 20 72 65 70 6f 72 74 65 64 20 75 73 69 6e 67 20 reported using
90d0: 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 74 61 the [sqlite3_sta
90e0: 74 75 73 5d 28 5b 53 51 4c 49 54 45 5f 53 54 41 tus]([SQLITE_STA
90f0: 54 55 53 5f 50 41 52 53 45 52 5f 53 54 41 43 4b TUS_PARSER_STACK
9100: 5d 2c 2e 2e 2e 29 0a 20 20 69 6e 74 65 72 66 61 ],...). interfa
9110: 63 65 2e 20 20 53 51 4c 69 74 65 27 73 20 4c 41 ce. SQLite's LA
9120: 4c 52 28 31 29 20 70 61 72 73 65 72 20 68 61 73 LR(1) parser has
9130: 20 61 20 66 69 78 65 64 20 73 74 61 63 6b 20 64 a fixed stack d
9140: 65 70 74 68 0a 20 20 28 64 65 74 65 72 6d 69 6e epth. (determin
9150: 65 64 20 61 74 20 63 6f 6d 70 69 6c 65 2d 74 69 ed at compile-ti
9160: 6d 65 20 75 73 69 6e 67 20 74 68 65 20 5b 59 59 me using the [YY
9170: 53 54 41 43 4b 44 45 50 54 48 5d 20 6f 70 74 69 STACKDEPTH] opti
9180: 6f 6e 73 29 2e 0a 20 20 54 68 69 73 20 6f 70 74 ons).. This opt
9190: 69 6f 6e 20 63 61 6e 20 62 65 20 75 73 65 64 20 ion can be used
91a0: 74 6f 20 68 65 6c 70 20 64 65 74 65 72 6d 69 6e to help determin
91b0: 65 20 69 66 20 61 6e 20 61 70 70 6c 69 63 61 74 e if an applicat
91c0: 69 6f 6e 20 69 73 0a 20 20 67 65 74 74 69 6e 67 ion is. getting
91d0: 20 63 6c 6f 73 65 20 74 6f 20 65 78 63 65 65 64 close to exceed
91e0: 69 6e 67 20 74 68 65 20 6d 61 78 69 6d 75 6d 20 ing the maximum
91f0: 4c 41 4c 52 28 31 29 20 73 74 61 63 6b 20 64 65 LALR(1) stack de
9200: 70 74 68 2e 0a 7d 0a 3c 2f 74 63 6c 3e 0a 0a 3c pth..}.</tcl>..<
9210: 61 20 6e 61 6d 65 3d 22 64 69 73 61 62 6c 65 66 a name="disablef
9220: 65 61 74 75 72 65 73 22 3e 3c 2f 61 3e 0a 3c 68 eatures"></a>.<h
9230: 32 3e 31 2e 36 20 4f 70 74 69 6f 6e 73 20 54 6f 2>1.6 Options To
9240: 20 44 69 73 61 62 6c 65 20 46 65 61 74 75 72 65 Disable Feature
9250: 73 20 4e 6f 72 6d 61 6c 6c 79 20 54 75 72 6e 65 s Normally Turne
9260: 64 20 4f 6e 3c 2f 68 32 3e 0a 0a 3c 74 63 6c 3e d On</h2>..<tcl>
9270: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
9280: 7b 53 51 4c 49 54 45 5f 44 49 53 41 42 4c 45 5f {SQLITE_DISABLE_
9290: 4c 46 53 7d 20 7b 0a 20 20 49 66 20 74 68 69 73 LFS} {. If this
92a0: 20 43 2d 70 72 65 70 72 6f 63 65 73 73 6f 72 20 C-preprocessor
92b0: 6d 61 63 72 6f 20 69 73 20 64 65 66 69 6e 65 64 macro is defined
92c0: 2c 20 6c 61 72 67 65 20 66 69 6c 65 20 73 75 70 , large file sup
92d0: 70 6f 72 74 0a 20 20 69 73 20 64 69 73 61 62 6c port. is disabl
92e0: 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f ed..}..COMPILE_O
92f0: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 49 PTION {SQLITE_DI
9300: 53 41 42 4c 45 5f 44 49 52 53 59 4e 43 7d 20 7b SABLE_DIRSYNC} {
9310: 0a 20 20 49 66 20 74 68 69 73 20 43 2d 70 72 65 . If this C-pre
9320: 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f 20 processor macro
9330: 69 73 20 64 65 66 69 6e 65 64 2c 20 64 69 72 65 is defined, dire
9340: 63 74 6f 72 79 20 73 79 6e 63 73 0a 20 20 61 72 ctory syncs. ar
9350: 65 20 64 69 73 61 62 6c 65 64 2e 20 20 53 51 4c e disabled. SQL
9360: 69 74 65 20 74 79 70 69 63 61 6c 6c 79 20 61 74 ite typically at
9370: 74 65 6d 70 74 73 20 74 6f 20 73 79 6e 63 20 74 tempts to sync t
9380: 68 65 20 70 61 72 65 6e 74 0a 20 20 64 69 72 65 he parent. dire
9390: 63 74 6f 72 79 20 77 68 65 6e 20 61 20 66 69 6c ctory when a fil
93a0: 65 20 69 73 20 64 65 6c 65 74 65 64 20 74 6f 20 e is deleted to
93b0: 65 6e 73 75 72 65 20 74 68 65 20 64 69 72 65 63 ensure the direc
93c0: 74 6f 72 79 0a 20 20 65 6e 74 72 69 65 73 20 61 tory. entries a
93d0: 72 65 20 75 70 64 61 74 65 64 20 69 6d 6d 65 64 re updated immed
93e0: 69 61 74 65 6c 79 20 6f 6e 20 64 69 73 6b 2e 0a iately on disk..
93f0: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
9400: 4e 20 7b 53 51 4c 49 54 45 5f 44 49 53 41 42 4c N {SQLITE_DISABL
9410: 45 5f 46 54 53 33 5f 55 4e 49 43 4f 44 45 7d 20 E_FTS3_UNICODE}
9420: 7b 0a 20 20 49 66 20 74 68 69 73 20 43 2d 70 72 {. If this C-pr
9430: 65 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f eprocessor macro
9440: 20 69 73 20 64 65 66 69 6e 65 64 2c 20 74 68 65 is defined, the
9450: 20 5b 75 6e 69 63 6f 64 65 36 31 5d 20 74 6f 6b [unicode61] tok
9460: 65 6e 69 7a 65 72 0a 20 20 69 6e 20 5b 46 54 53 enizer. in [FTS
9470: 33 5d 20 69 73 20 6f 6d 69 74 74 65 64 20 66 72 3] is omitted fr
9480: 6f 6d 20 74 68 65 20 62 75 69 6c 64 20 61 6e 64 om the build and
9490: 20 69 73 20 75 6e 61 76 61 69 6c 61 62 6c 65 20 is unavailable
94a0: 74 6f 20 0a 20 20 61 70 70 6c 69 63 61 74 69 6f to . applicatio
94b0: 6e 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f ns..}..COMPILE_O
94c0: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 49 PTION {SQLITE_DI
94d0: 53 41 42 4c 45 5f 46 54 53 34 5f 44 45 46 45 52 SABLE_FTS4_DEFER
94e0: 52 45 44 7d 20 7b 0a 20 20 49 66 20 74 68 69 73 RED} {. If this
94f0: 20 43 2d 70 72 65 70 72 6f 63 65 73 73 6f 72 20 C-preprocessor
9500: 6d 61 63 72 6f 20 64 69 73 61 62 6c 65 73 20 74 macro disables t
9510: 68 65 20 22 64 65 66 65 72 72 65 64 20 74 6f 6b he "deferred tok
9520: 65 6e 22 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e en" optimization
9530: 0a 20 20 69 6e 20 5b 46 54 53 34 5d 2e 20 20 54 . in [FTS4]. T
9540: 68 65 20 22 64 65 66 65 72 72 65 64 20 74 6f 6b he "deferred tok
9550: 65 6e 22 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e en" optimization
9560: 20 61 76 6f 69 64 73 20 6c 6f 61 64 69 6e 67 20 avoids loading
9570: 6d 61 73 73 69 76 65 0a 20 20 70 6f 73 74 69 6e massive. postin
9580: 67 20 6c 69 73 74 73 20 66 6f 72 20 74 65 72 6d g lists for term
9590: 73 20 74 68 61 74 20 61 72 65 20 69 6e 20 6d 6f s that are in mo
95a0: 73 74 20 64 6f 63 75 6d 65 6e 74 73 20 6f 66 20 st documents of
95b0: 74 68 65 20 63 6f 6c 6c 65 63 74 69 6f 6e 0a 20 the collection.
95c0: 20 61 6e 64 20 69 6e 73 74 65 61 64 20 73 69 6d and instead sim
95d0: 70 6c 79 20 73 63 61 6e 73 20 66 6f 72 20 74 68 ply scans for th
95e0: 6f 73 65 20 74 6f 6b 65 6e 73 20 69 6e 20 74 68 ose tokens in th
95f0: 65 20 64 6f 63 75 6d 65 6e 74 20 73 6f 75 72 63 e document sourc
9600: 65 2e 20 20 5b 46 54 53 34 5d 0a 20 20 73 68 6f e. [FTS4]. sho
9610: 75 6c 64 20 67 65 74 20 65 78 61 63 74 6c 79 20 uld get exactly
9620: 74 68 65 20 73 61 6d 65 20 61 6e 73 77 65 72 20 the same answer
9630: 62 6f 74 68 20 77 69 74 68 20 61 6e 64 20 77 69 both with and wi
9640: 74 68 6f 75 74 20 74 68 69 73 20 6f 70 74 69 6d thout this optim
9650: 69 7a 61 74 69 6f 6e 2e 0a 7d 0a 3c 2f 74 63 6c ization..}.</tcl
9660: 3e 0a 0a 3c 74 63 6c 3e 0a 20 20 68 64 5f 66 72 >..<tcl>. hd_fr
9670: 61 67 6d 65 6e 74 20 22 6f 6d 69 74 66 65 61 74 agment "omitfeat
9680: 75 72 65 73 22 0a 20 20 68 64 5f 6b 65 79 77 6f ures". hd_keywo
9690: 72 64 73 20 22 6f 6d 69 74 66 65 61 74 75 72 65 rds "omitfeature
96a0: 73 22 0a 3c 2f 74 63 6c 3e 0a 3c 68 32 3e 31 2e s".</tcl>.<h2>1.
96b0: 37 20 4f 70 74 69 6f 6e 73 20 54 6f 20 4f 6d 69 7 Options To Omi
96c0: 74 20 46 65 61 74 75 72 65 73 3c 2f 68 32 3e 0a t Features</h2>.
96d0: 0a 3c 70 3e 54 68 65 20 66 6f 6c 6c 6f 77 69 6e .<p>The followin
96e0: 67 20 6f 70 74 69 6f 6e 73 20 63 61 6e 20 62 65 g options can be
96f0: 20 75 73 65 64 20 74 6f 20 0a 5b 72 65 6c 66 6f used to .[relfo
9700: 6f 74 70 72 69 6e 74 20 7c 20 72 65 64 75 63 65 otprint | reduce
9710: 20 74 68 65 20 73 69 7a 65 20 6f 66 20 74 68 65 the size of the
9720: 20 63 6f 6d 70 69 6c 65 64 20 6c 69 62 72 61 72 compiled librar
9730: 79 5d 0a 62 79 20 6f 6d 69 74 74 69 6e 67 20 75 y].by omitting u
9740: 6e 75 73 65 64 20 66 65 61 74 75 72 65 73 2e 20 nused features.
9750: 54 68 69 73 20 69 73 20 70 72 6f 62 61 62 6c 79 This is probably
9760: 20 6f 6e 6c 79 20 75 73 65 66 75 6c 0a 69 6e 20 only useful.in
9770: 65 6d 62 65 64 64 65 64 20 73 79 73 74 65 6d 73 embedded systems
9780: 20 77 68 65 72 65 20 73 70 61 63 65 20 69 73 20 where space is
9790: 65 73 70 65 63 69 61 6c 6c 79 20 74 69 67 68 74 especially tight
97a0: 2c 20 61 73 20 65 76 65 6e 20 77 69 74 68 20 61 , as even with a
97b0: 6c 6c 0a 66 65 61 74 75 72 65 73 20 69 6e 63 6c ll.features incl
97c0: 75 64 65 64 20 74 68 65 20 53 51 4c 69 74 65 20 uded the SQLite
97d0: 6c 69 62 72 61 72 79 20 69 73 20 72 65 6c 61 74 library is relat
97e0: 69 76 65 6c 79 20 73 6d 61 6c 6c 2e 20 44 6f 6e ively small. Don
97f0: 27 74 20 66 6f 72 67 65 74 0a 74 6f 20 74 65 6c 't forget.to tel
9800: 6c 20 79 6f 75 72 20 63 6f 6d 70 69 6c 65 72 20 l your compiler
9810: 74 6f 20 6f 70 74 69 6d 69 7a 65 20 66 6f 72 20 to optimize for
9820: 62 69 6e 61 72 79 20 73 69 7a 65 21 20 28 74 68 binary size! (th
9830: 65 20 2d 4f 73 20 6f 70 74 69 6f 6e 20 69 66 0a e -Os option if.
9840: 75 73 69 6e 67 20 47 43 43 29 2e 20 20 54 65 6c using GCC). Tel
9850: 6c 69 6e 67 20 79 6f 75 72 20 63 6f 6d 70 69 6c ling your compil
9860: 65 72 20 74 6f 20 6f 70 74 69 6d 69 7a 65 20 66 er to optimize f
9870: 6f 72 20 73 69 7a 65 20 75 73 75 61 6c 6c 79 20 or size usually
9880: 68 61 73 0a 61 20 6d 75 63 68 20 6c 61 72 67 65 has.a much large
9890: 72 20 69 6d 70 61 63 74 20 6f 6e 20 6c 69 62 72 r impact on libr
98a0: 61 72 79 20 66 6f 6f 74 70 72 69 6e 74 20 74 68 ary footprint th
98b0: 61 6e 20 65 6d 70 6c 6f 79 69 6e 67 20 61 6e 79 an employing any
98c0: 20 6f 66 20 74 68 65 73 65 0a 63 6f 6d 70 69 6c of these.compil
98d0: 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 73 2e 20 e-time options.
98e0: 20 59 6f 75 20 73 68 6f 75 6c 64 20 61 6c 73 6f You should also
98f0: 20 76 65 72 69 66 79 20 74 68 61 74 20 0a 3c 61 verify that .<a
9900: 20 68 72 65 66 3d 22 23 64 65 62 75 67 6f 70 74 href="#debugopt
9910: 69 6f 6e 73 22 3e 64 65 62 75 67 67 69 6e 67 20 ions">debugging
9920: 6f 70 74 69 6f 6e 73 3c 2f 61 3e 20 61 72 65 20 options</a> are
9930: 64 69 73 61 62 6c 65 64 2e 3c 2f 70 3e 0a 0a 3c disabled.</p>..<
9940: 70 3e 54 68 65 20 6d 61 63 72 6f 73 20 69 6e 20 p>The macros in
9950: 74 68 69 73 20 73 65 63 74 69 6f 6e 20 64 6f 20 this section do
9960: 6e 6f 74 20 72 65 71 75 69 72 65 20 76 61 6c 75 not require valu
9970: 65 73 2e 20 54 68 65 20 66 6f 6c 6c 6f 77 69 6e es. The followin
9980: 67 20 0a 63 6f 6d 70 69 6c 61 74 69 6f 6e 20 73 g .compilation s
9990: 77 69 74 63 68 65 73 20 61 6c 6c 20 68 61 76 65 witches all have
99a0: 20 74 68 65 20 73 61 6d 65 20 65 66 66 65 63 74 the same effect
99b0: 3a 3c 62 72 3e 0a 2d 44 53 51 4c 49 54 45 5f 4f :<br>.-DSQLITE_O
99c0: 4d 49 54 5f 41 4c 54 45 52 54 41 42 4c 45 3c 62 MIT_ALTERTABLE<b
99d0: 72 3e 0a 2d 44 53 51 4c 49 54 45 5f 4f 4d 49 54 r>.-DSQLITE_OMIT
99e0: 5f 41 4c 54 45 52 54 41 42 4c 45 3d 31 3c 62 72 _ALTERTABLE=1<br
99f0: 3e 0a 2d 44 53 51 4c 49 54 45 5f 4f 4d 49 54 5f >.-DSQLITE_OMIT_
9a00: 41 4c 54 45 52 54 41 42 4c 45 3d 30 0a 3c 2f 70 ALTERTABLE=0.</p
9a10: 3e 0a 0a 3c 70 3e 49 66 20 61 6e 79 20 6f 66 20 >..<p>If any of
9a20: 74 68 65 73 65 20 6f 70 74 69 6f 6e 73 20 61 72 these options ar
9a30: 65 20 64 65 66 69 6e 65 64 2c 20 74 68 65 6e 20 e defined, then
9a40: 74 68 65 20 73 61 6d 65 20 73 65 74 20 6f 66 20 the same set of
9a50: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 2a 0a 6f 70 SQLITE_OMIT_*.op
9a60: 74 69 6f 6e 73 20 6d 75 73 74 20 61 6c 73 6f 20 tions must also
9a70: 62 65 20 64 65 66 69 6e 65 64 20 77 68 65 6e 20 be defined when
9a80: 75 73 69 6e 67 20 74 68 65 20 27 6c 65 6d 6f 6e using the 'lemon
9a90: 27 20 74 6f 6f 6c 20 74 6f 20 67 65 6e 65 72 61 ' tool to genera
9aa0: 74 65 20 74 68 65 0a 70 61 72 73 65 2e 63 20 66 te the.parse.c f
9ab0: 69 6c 65 20 61 6e 64 20 77 68 65 6e 20 63 6f 6d ile and when com
9ac0: 70 69 6c 69 6e 67 20 74 68 65 20 27 6d 6b 6b 65 piling the 'mkke
9ad0: 79 77 6f 72 64 68 61 73 68 27 20 74 6f 6f 6c 20 ywordhash' tool
9ae0: 77 68 69 63 68 20 67 65 6e 65 72 61 74 65 73 20 which generates
9af0: 0a 74 68 65 20 6b 65 79 77 6f 72 64 68 61 73 68 .the keywordhash
9b00: 2e 68 20 66 69 6c 65 2e 0a 42 65 63 61 75 73 65 .h file..Because
9b10: 20 6f 66 20 74 68 69 73 2c 20 74 68 65 73 65 20 of this, these
9b20: 6f 70 74 69 6f 6e 73 20 6d 61 79 20 6f 6e 6c 79 options may only
9b30: 20 62 65 20 75 73 65 64 20 77 68 65 6e 20 74 68 be used when th
9b40: 65 20 6c 69 62 72 61 72 79 20 69 73 20 62 75 69 e library is bui
9b50: 6c 74 0a 66 72 6f 6d 20 63 61 6e 6f 6e 69 63 61 lt.from canonica
9b60: 6c 20 73 6f 75 72 63 65 2c 20 6e 6f 74 20 66 72 l source, not fr
9b70: 6f 6d 20 74 68 65 20 5b 61 6d 61 6c 67 61 6d 61 om the [amalgama
9b80: 74 69 6f 6e 5d 20 6f 72 20 66 72 6f 6d 20 74 68 tion] or from th
9b90: 65 20 63 6f 6c 6c 65 63 74 69 6f 6e 20 6f 66 0a e collection of.
9ba0: 70 72 65 2d 70 61 63 6b 61 67 65 64 20 43 20 66 pre-packaged C f
9bb0: 69 6c 65 73 20 70 72 6f 76 69 64 65 64 20 66 6f iles provided fo
9bc0: 72 20 6e 6f 6e 2d 55 6e 69 78 20 6c 69 6b 65 20 r non-Unix like
9bd0: 70 6c 61 74 66 6f 72 6d 73 20 6f 6e 20 74 68 65 platforms on the
9be0: 20 77 65 62 73 69 74 65 2e 0a 41 6e 79 20 53 51 website..Any SQ
9bf0: 4c 49 54 45 5f 4f 4d 49 54 5f 2a 20 6f 70 74 69 LITE_OMIT_* opti
9c00: 6f 6e 73 20 77 68 69 63 68 20 63 61 6e 20 62 65 ons which can be
9c10: 20 75 73 65 64 20 64 69 72 65 63 74 6c 79 20 77 used directly w
9c20: 69 74 68 20 74 68 65 20 5b 61 6d 61 6c 67 61 6d ith the [amalgam
9c30: 61 74 69 6f 6e 5d 20 0a 61 72 65 20 6c 69 73 74 ation] .are list
9c40: 65 64 20 62 65 6c 6f 77 2c 20 68 6f 77 65 76 65 ed below, howeve
9c50: 72 2c 20 74 68 65 20 77 61 72 6e 69 6e 67 73 20 r, the warnings
9c60: 69 6e 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 in the following
9c70: 20 70 61 72 61 67 72 61 70 68 20 73 68 6f 75 6c paragraph shoul
9c80: 64 20 62 65 20 6e 6f 74 65 64 2e 0a 3c 2f 70 3e d be noted..</p>
9c90: 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c ..<blockquote>.<
9ca0: 69 3e 3c 62 3e 49 6d 70 6f 72 74 61 6e 74 20 4e i><b>Important N
9cb0: 6f 74 65 3a 3c 2f 62 3e 20 54 68 65 20 53 51 4c ote:</b> The SQL
9cc0: 49 54 45 5f 4f 4d 49 54 5f 2a 20 6f 70 74 69 6f ITE_OMIT_* optio
9cd0: 6e 73 20 64 6f 20 6e 6f 74 20 77 6f 72 6b 20 77 ns do not work w
9ce0: 69 74 68 20 74 68 65 0a 5b 61 6d 61 6c 67 61 6d ith the.[amalgam
9cf0: 61 74 69 6f 6e 5d 20 6f 72 20 77 69 74 68 20 70 ation] or with p
9d00: 72 65 2d 70 61 63 6b 61 67 65 64 20 43 20 63 6f re-packaged C co
9d10: 64 65 20 66 69 6c 65 73 2e 20 20 53 51 4c 49 54 de files. SQLIT
9d20: 45 5f 4f 4d 49 54 5f 2a 20 63 6f 6d 70 69 6c 65 E_OMIT_* compile
9d30: 2d 74 69 6d 65 0a 6f 70 74 69 6f 6e 73 20 6f 6e -time.options on
9d40: 6c 79 20 77 6f 72 6b 20 63 6f 72 72 65 63 74 6c ly work correctl
9d50: 79 20 77 68 65 6e 20 53 51 4c 69 74 65 20 69 73 y when SQLite is
9d60: 20 62 75 69 6c 74 20 66 72 6f 6d 20 63 61 6e 6f built from cano
9d70: 6e 69 63 61 6c 20 73 6f 75 72 63 65 20 66 69 6c nical source fil
9d80: 65 73 2e 0a 3c 2f 69 3e 0a 3c 2f 62 6c 6f 63 6b es..</i>.</block
9d90: 71 75 6f 74 65 3e 0a 0a 0a 3c 70 3e 53 70 65 63 quote>...<p>Spec
9da0: 69 61 6c 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 ial versions of
9db0: 74 68 65 20 53 51 4c 69 74 65 20 61 6d 61 6c 67 the SQLite amalg
9dc0: 61 6d 61 74 69 6f 6e 20 74 68 61 74 20 64 6f 20 amation that do
9dd0: 77 6f 72 6b 20 77 69 74 68 20 61 0a 70 72 65 64 work with a.pred
9de0: 65 74 65 72 6d 69 6e 65 64 20 73 65 74 20 6f 66 etermined set of
9df0: 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 2a 20 6f SQLITE_OMIT_* o
9e00: 70 74 69 6f 6e 73 20 63 61 6e 20 62 65 20 67 65 ptions can be ge
9e10: 6e 65 72 61 74 65 64 2e 20 20 54 6f 20 64 6f 20 nerated. To do
9e20: 73 6f 2c 0a 6d 61 6b 65 20 61 20 63 6f 70 79 20 so,.make a copy
9e30: 6f 66 20 74 68 65 20 4d 61 6b 65 66 69 6c 65 2e of the Makefile.
9e40: 6c 69 6e 75 78 2d 67 63 63 20 6d 61 6b 65 66 69 linux-gcc makefi
9e50: 6c 65 20 74 65 6d 70 6c 61 74 65 20 69 6e 20 74 le template in t
9e60: 68 65 20 63 61 6e 6f 6e 69 63 61 6c 0a 73 6f 75 he canonical.sou
9e70: 72 63 65 20 63 6f 64 65 20 64 69 73 74 72 69 62 rce code distrib
9e80: 75 74 69 6f 6e 2e 20 20 43 68 61 6e 67 65 20 74 ution. Change t
9e90: 68 65 20 6e 61 6d 65 20 6f 66 20 79 6f 75 72 20 he name of your
9ea0: 63 6f 70 79 20 74 6f 20 73 69 6d 70 6c 79 20 22 copy to simply "
9eb0: 4d 61 6b 65 66 69 6c 65 22 2e 0a 54 68 65 6e 20 Makefile"..Then
9ec0: 65 64 69 74 20 22 4d 61 6b 65 66 69 6c 65 22 20 edit "Makefile"
9ed0: 74 6f 20 73 65 74 20 75 70 20 61 70 70 72 6f 70 to set up approp
9ee0: 72 69 61 74 65 20 63 6f 6d 70 69 6c 65 2d 74 69 riate compile-ti
9ef0: 6d 65 20 6f 70 74 69 6f 6e 73 2e 20 20 54 68 65 me options. The
9f00: 6e 0a 74 79 70 65 3a 0a 3c 62 6c 6f 63 6b 71 75 n.type:.<blockqu
9f10: 6f 74 65 3e 3c 74 74 3e 6d 61 6b 65 20 63 6c 65 ote><tt>make cle
9f20: 61 6e 3b 20 6d 61 6b 65 20 73 71 6c 69 74 65 33 an; make sqlite3
9f30: 2e 63 3c 2f 74 74 3e 3c 2f 62 6c 6f 63 6b 71 75 .c</tt></blockqu
9f40: 6f 74 65 3e 0a 54 68 65 20 72 65 73 75 6c 74 69 ote>.The resulti
9f50: 6e 67 20 22 73 71 6c 69 74 65 33 2e 63 22 20 61 ng "sqlite3.c" a
9f60: 6d 61 6c 67 61 6d 61 74 69 6f 6e 20 63 6f 64 65 malgamation code
9f70: 20 66 69 6c 65 20 28 61 6e 64 20 69 74 73 20 61 file (and its a
9f80: 73 73 6f 63 69 61 74 65 64 0a 68 65 61 64 65 72 ssociated.header
9f90: 20 66 69 6c 65 20 22 73 71 6c 69 74 65 33 2e 68 file "sqlite3.h
9fa0: 22 29 20 63 61 6e 20 74 68 65 6e 20 62 65 20 6d ") can then be m
9fb0: 6f 76 65 64 20 74 6f 20 61 20 6e 6f 6e 2d 75 6e oved to a non-un
9fc0: 69 78 20 70 6c 61 74 66 6f 72 6d 0a 66 6f 72 20 ix platform.for
9fd0: 66 69 6e 61 6c 20 63 6f 6d 70 69 6c 61 74 69 6f final compilatio
9fe0: 6e 20 75 73 69 6e 67 20 61 20 6e 61 74 69 76 65 n using a native
9ff0: 20 63 6f 6d 70 69 6c 65 72 2e 3c 2f 70 3e 0a 0a compiler.</p>..
a000: 3c 70 3e 41 6c 6c 20 6f 66 20 74 68 65 20 53 51 <p>All of the SQ
a010: 4c 49 54 45 5f 4f 4d 49 54 5f 2a 20 6f 70 74 69 LITE_OMIT_* opti
a020: 6f 6e 73 20 61 72 65 20 75 6e 73 75 70 70 6f 72 ons are unsuppor
a030: 74 65 64 2e 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b ted.</p>..<block
a040: 71 75 6f 74 65 3e 0a 3c 69 3e 3c 62 3e 49 6d 70 quote>.<i><b>Imp
a050: 6f 72 74 61 6e 74 20 4e 6f 74 65 3a 3c 2f 62 3e ortant Note:</b>
a060: 0a 54 68 65 20 53 51 4c 49 54 45 5f 4f 4d 49 54 .The SQLITE_OMIT
a070: 5f 2a 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 _* compile-time
a080: 6f 70 74 69 6f 6e 73 20 61 72 65 20 75 6e 73 75 options are unsu
a090: 70 70 6f 72 74 65 64 2e 0a 3c 2f 69 3e 3c 2f 62 pported..</i></b
a0a0: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 0a lockquote>..<p>.
a0b0: 54 68 65 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f The SQLITE_OMIT_
a0c0: 2a 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f * compile-time o
a0d0: 70 74 69 6f 6e 73 20 61 72 65 20 75 73 75 61 6c ptions are usual
a0e0: 6c 79 20 75 6e 74 65 73 74 65 64 20 61 6e 64 0a ly untested and.
a0f0: 61 72 65 20 61 6c 6d 6f 73 74 20 63 65 72 74 61 are almost certa
a100: 69 6e 6c 79 20 75 6e 74 65 73 74 65 64 20 69 6e inly untested in
a110: 20 63 6f 6d 62 69 6e 61 74 69 6f 6e 2e 0a 41 6e combination..An
a120: 79 20 6f 72 20 61 6c 6c 20 6f 66 20 74 68 65 73 y or all of thes
a130: 65 20 6f 70 74 69 6f 6e 73 20 6d 61 79 20 62 65 e options may be
a140: 20 72 65 6d 6f 76 65 64 20 66 72 6f 6d 20 74 68 removed from th
a150: 65 20 63 6f 64 65 20 69 6e 20 66 75 74 75 72 65 e code in future
a160: 20 72 65 6c 65 61 73 65 73 0a 61 6e 64 20 77 69 releases.and wi
a170: 74 68 6f 75 74 20 77 61 72 6e 69 6e 67 2e 20 20 thout warning.
a180: 46 6f 72 20 61 6e 79 20 70 61 72 74 69 63 75 6c For any particul
a190: 61 72 20 72 65 6c 65 61 73 65 2c 20 73 6f 6d 65 ar release, some
a1a0: 20 6f 66 20 74 68 65 73 65 0a 6f 70 74 69 6f 6e of these.option
a1b0: 73 20 6d 61 79 20 63 61 75 73 65 20 63 6f 6d 70 s may cause comp
a1c0: 69 6c 65 2d 74 69 6d 65 20 6f 72 20 72 75 6e 2d ile-time or run-
a1d0: 74 69 6d 65 20 66 61 69 6c 75 72 65 73 2c 20 70 time failures, p
a1e0: 61 72 74 69 63 75 6c 61 72 6c 79 0a 77 68 65 6e articularly.when
a1f0: 20 75 73 65 64 20 69 6e 20 63 6f 6d 62 69 6e 61 used in combina
a200: 74 69 6f 6e 20 77 69 74 68 20 6f 74 68 65 72 20 tion with other
a210: 6f 70 74 69 6f 6e 73 2e 3c 2f 70 3e 0a 0a 3c 74 options.</p>..<t
a220: 63 6c 3e 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 cl>.COMPILE_OPTI
a230: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
a240: 41 4c 54 45 52 54 41 42 4c 45 7d 20 7b 0a 20 20 ALTERTABLE} {.
a250: 57 68 65 6e 20 74 68 69 73 20 6f 70 74 69 6f 6e When this option
a260: 20 69 73 20 64 65 66 69 6e 65 64 2c 20 74 68 65 is defined, the
a270: 20 0a 20 20 5b 41 4c 54 45 52 20 54 41 42 4c 45 . [ALTER TABLE
a280: 5d 20 63 6f 6d 6d 61 6e 64 20 69 73 20 6e 6f 74 ] command is not
a290: 20 69 6e 63 6c 75 64 65 64 20 69 6e 20 74 68 65 included in the
a2a0: 20 0a 20 20 6c 69 62 72 61 72 79 2e 20 45 78 65 . library. Exe
a2b0: 63 75 74 69 6e 67 20 61 6e 20 5b 41 4c 54 45 52 cuting an [ALTER
a2c0: 20 54 41 42 4c 45 5d 20 73 74 61 74 65 6d 65 6e TABLE] statemen
a2d0: 74 20 63 61 75 73 65 73 20 61 20 70 61 72 73 65 t causes a parse
a2e0: 20 65 72 72 6f 72 2e 0a 7d 0a 0a 43 4f 4d 50 49 error..}..COMPI
a2f0: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
a300: 45 5f 4f 4d 49 54 5f 41 4e 41 4c 59 5a 45 7d 20 E_OMIT_ANALYZE}
a310: 7b 0a 20 20 57 68 65 6e 20 74 68 69 73 20 6f 70 {. When this op
a320: 74 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 2c tion is defined,
a330: 20 74 68 65 20 5b 41 4e 41 4c 59 5a 45 5d 20 63 the [ANALYZE] c
a340: 6f 6d 6d 61 6e 64 20 69 73 20 6f 6d 69 74 74 65 ommand is omitte
a350: 64 20 66 72 6f 6d 0a 20 20 74 68 65 20 62 75 69 d from. the bui
a360: 6c 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f ld..}..COMPILE_O
a370: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d PTION {SQLITE_OM
a380: 49 54 5f 41 54 54 41 43 48 7d 20 7b 0a 20 20 57 IT_ATTACH} {. W
a390: 68 65 6e 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 hen this option
a3a0: 69 73 20 64 65 66 69 6e 65 64 2c 20 74 68 65 20 is defined, the
a3b0: 5b 41 54 54 41 43 48 5d 20 61 6e 64 20 5b 44 45 [ATTACH] and [DE
a3c0: 54 41 43 48 5d 20 63 6f 6d 6d 61 6e 64 73 20 61 TACH] commands a
a3d0: 72 65 0a 20 20 6f 6d 69 74 74 65 64 20 66 72 6f re. omitted fro
a3e0: 6d 20 74 68 65 20 62 75 69 6c 64 2e 0a 7d 0a 0a m the build..}..
a3f0: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
a400: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 55 54 48 SQLITE_OMIT_AUTH
a410: 4f 52 49 5a 41 54 49 4f 4e 7d 20 7b 0a 20 20 44 ORIZATION} {. D
a420: 65 66 69 6e 69 6e 67 20 74 68 69 73 20 6f 70 74 efining this opt
a430: 69 6f 6e 20 6f 6d 69 74 73 20 74 68 65 20 61 75 ion omits the au
a440: 74 68 6f 72 69 7a 61 74 69 6f 6e 20 63 61 6c 6c thorization call
a450: 62 61 63 6b 20 66 65 61 74 75 72 65 20 66 72 6f back feature fro
a460: 6d 20 74 68 65 0a 20 20 6c 69 62 72 61 72 79 2e m the. library.
a470: 20 54 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 65 The [sqlite3_se
a480: 74 5f 61 75 74 68 6f 72 69 7a 65 72 28 29 5d 20 t_authorizer()]
a490: 41 50 49 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 API function is
a4a0: 6e 6f 74 20 70 72 65 73 65 6e 74 0a 20 20 69 6e not present. in
a4b0: 20 74 68 65 20 6c 69 62 72 61 72 79 2e 0a 7d 0a the library..}.
a4c0: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
a4d0: 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 55 54 {SQLITE_OMIT_AUT
a4e0: 4f 49 4e 43 52 45 4d 45 4e 54 7d 20 7b 0a 20 20 OINCREMENT} {.
a4f0: 54 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 75 This option is u
a500: 73 65 64 20 74 6f 20 6f 6d 69 74 20 74 68 65 20 sed to omit the
a510: 0a 20 20 5b 41 55 54 4f 49 4e 43 52 45 4d 45 4e . [AUTOINCREMEN
a520: 54 5d 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74 79 T] functionality
a530: 2e 20 57 68 65 6e 20 74 68 69 73 20 0a 20 20 69 . When this . i
a540: 73 20 6d 61 63 72 6f 20 69 73 20 64 65 66 69 6e s macro is defin
a550: 65 64 2c 20 63 6f 6c 75 6d 6e 73 20 64 65 63 6c ed, columns decl
a560: 61 72 65 64 20 61 73 20 0a 20 20 22 5b 49 4e 54 ared as . "[INT
a570: 45 47 45 52 20 50 52 49 4d 41 52 59 20 4b 45 59 EGER PRIMARY KEY
a580: 5d 20 41 55 54 4f 49 4e 43 52 45 4d 45 4e 54 22 ] AUTOINCREMENT"
a590: 0a 20 20 62 65 68 61 76 65 20 69 6e 20 74 68 65 . behave in the
a5a0: 20 73 61 6d 65 20 77 61 79 20 61 73 20 63 6f 6c same way as col
a5b0: 75 6d 6e 73 20 64 65 63 6c 61 72 65 64 20 61 73 umns declared as
a5c0: 20 22 5b 49 4e 54 45 47 45 52 20 50 52 49 4d 41 "[INTEGER PRIMA
a5d0: 52 59 20 4b 45 59 5d 22 20 77 68 65 6e 20 61 20 RY KEY]" when a
a5e0: 0a 20 20 4e 55 4c 4c 20 69 73 20 69 6e 73 65 72 . NULL is inser
a5f0: 74 65 64 2e 20 54 68 65 20 73 71 6c 69 74 65 5f ted. The sqlite_
a600: 73 65 71 75 65 6e 63 65 20 73 79 73 74 65 6d 20 sequence system
a610: 74 61 62 6c 65 20 69 73 20 6e 65 69 74 68 65 72 table is neither
a620: 20 63 72 65 61 74 65 64 2c 20 6e 6f 72 0a 20 20 created, nor.
a630: 72 65 73 70 65 63 74 65 64 20 69 66 20 69 74 20 respected if it
a640: 61 6c 72 65 61 64 79 20 65 78 69 73 74 73 2e 0a already exists..
a650: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
a660: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 N {SQLITE_OMIT_A
a670: 55 54 4f 49 4e 49 54 7d 20 7b 0a 20 20 46 6f 72 UTOINIT} {. For
a680: 20 62 61 63 6b 77 61 72 64 73 20 63 6f 6d 70 61 backwards compa
a690: 74 69 62 69 6c 69 74 79 20 77 69 74 68 20 6f 6c tibility with ol
a6a0: 64 65 72 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 der versions of
a6b0: 53 51 4c 69 74 65 20 74 68 61 74 20 6c 61 63 6b SQLite that lack
a6c0: 0a 20 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f . the [sqlite3_
a6d0: 69 6e 69 74 69 61 6c 69 7a 65 28 29 5d 20 69 6e initialize()] in
a6e0: 74 65 72 66 61 63 65 2c 20 74 68 65 20 5b 73 71 terface, the [sq
a6f0: 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 lite3_initialize
a700: 28 29 5d 20 69 6e 74 65 72 66 61 63 65 0a 20 20 ()] interface.
a710: 69 73 20 63 61 6c 6c 65 64 20 61 75 74 6f 6d 61 is called automa
a720: 74 69 63 61 6c 6c 79 20 75 70 6f 6e 20 65 6e 74 tically upon ent
a730: 72 79 20 74 6f 20 63 65 72 74 61 69 6e 20 6b 65 ry to certain ke
a740: 79 20 69 6e 74 65 72 66 61 63 65 73 20 73 75 63 y interfaces suc
a750: 68 20 61 73 0a 20 20 5b 73 71 6c 69 74 65 33 5f h as. [sqlite3_
a760: 6f 70 65 6e 28 29 5d 2c 20 5b 73 71 6c 69 74 65 open()], [sqlite
a770: 33 5f 76 66 73 5f 72 65 67 69 73 74 65 72 28 29 3_vfs_register()
a780: 5d 2c 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f ], and [sqlite3_
a790: 6d 70 72 69 6e 74 66 28 29 5d 2e 0a 20 20 54 68 mprintf()].. Th
a7a0: 65 20 6f 76 65 72 68 65 61 64 20 6f 66 20 69 6e e overhead of in
a7b0: 76 6f 6b 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f voking [sqlite3_
a7c0: 69 6e 69 74 69 61 6c 69 7a 65 28 29 5d 20 61 75 initialize()] au
a7d0: 74 6f 6d 61 74 69 63 61 6c 6c 79 20 69 6e 20 74 tomatically in t
a7e0: 68 69 73 0a 20 20 77 61 79 20 6d 61 79 20 62 65 his. way may be
a7f0: 20 6f 6d 69 74 74 65 64 20 62 79 20 62 75 69 6c omitted by buil
a800: 64 69 6e 67 20 53 51 4c 69 74 65 20 77 69 74 68 ding SQLite with
a810: 20 74 68 65 20 53 51 4c 49 54 45 5f 4f 4d 49 54 the SQLITE_OMIT
a820: 5f 41 55 54 4f 49 4e 49 54 0a 20 20 43 2d 70 72 _AUTOINIT. C-pr
a830: 65 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f eprocessor macro
a840: 2e 20 20 57 68 65 6e 20 62 75 69 6c 74 20 75 73 . When built us
a850: 69 6e 67 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ing SQLITE_OMIT_
a860: 41 55 54 4f 49 4e 49 54 2c 20 53 51 4c 69 74 65 AUTOINIT, SQLite
a870: 0a 20 20 77 69 6c 6c 20 6e 6f 74 20 61 75 74 6f . will not auto
a880: 6d 61 74 69 63 61 6c 6c 79 20 69 6e 69 74 69 61 matically initia
a890: 6c 69 7a 65 20 69 74 73 65 6c 66 20 61 6e 64 20 lize itself and
a8a0: 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 the application
a8b0: 69 73 20 72 65 71 75 69 72 65 64 0a 20 20 74 6f is required. to
a8c0: 20 69 6e 76 6f 6b 65 20 5b 73 71 6c 69 74 65 33 invoke [sqlite3
a8d0: 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 5d 20 64 _initialize()] d
a8e0: 69 72 65 63 74 6c 79 20 70 72 69 6f 72 20 74 6f irectly prior to
a8f0: 20 62 65 67 69 6e 6e 69 6e 67 20 75 73 65 20 6f beginning use o
a900: 66 20 74 68 65 0a 20 20 53 51 4c 69 74 65 20 6c f the. SQLite l
a910: 69 62 72 61 72 79 2e 0a 7d 0a 0a 43 4f 4d 50 49 ibrary..}..COMPI
a920: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
a930: 45 5f 4f 4d 49 54 5f 41 55 54 4f 4d 41 54 49 43 E_OMIT_AUTOMATIC
a940: 5f 49 4e 44 45 58 7d 20 7b 0a 20 20 54 68 69 73 _INDEX} {. This
a950: 20 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 20 option is used
a960: 74 6f 20 6f 6d 69 74 20 74 68 65 20 0a 20 20 5b to omit the . [
a970: 61 75 74 6f 6d 61 74 69 63 20 69 6e 64 65 78 69 automatic indexi
a980: 6e 67 5d 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74 ng] functionalit
a990: 79 2e 0a 20 20 53 65 65 20 61 6c 73 6f 3a 20 5b y.. See also: [
a9a0: 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f 41 SQLITE_DEFAULT_A
a9b0: 55 54 4f 4d 41 54 49 43 5f 49 4e 44 45 58 5d 2e UTOMATIC_INDEX].
a9c0: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
a9d0: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
a9e0: 41 55 54 4f 52 45 53 45 54 7d 20 7b 0a 20 20 42 AUTORESET} {. B
a9f0: 79 20 64 65 66 61 75 6c 74 2c 20 74 68 65 20 5b y default, the [
aa00: 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 sqlite3_step()]
aa10: 69 6e 74 65 72 66 61 63 65 20 77 69 6c 6c 20 61 interface will a
aa20: 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 69 6e 76 utomatically inv
aa30: 6f 6b 65 0a 20 20 5b 73 71 6c 69 74 65 33 5f 72 oke. [sqlite3_r
aa40: 65 73 65 74 28 29 5d 20 74 6f 20 72 65 73 65 74 eset()] to reset
aa50: 20 74 68 65 20 5b 70 72 65 70 61 72 65 64 20 73 the [prepared s
aa60: 74 61 74 65 6d 65 6e 74 5d 20 69 66 20 6e 65 63 tatement] if nec
aa70: 65 73 73 61 72 79 2e 20 20 54 68 69 73 0a 20 20 essary. This.
aa80: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 compile-time opt
aa90: 69 6f 6e 20 63 68 61 6e 67 65 73 20 74 68 61 74 ion changes that
aaa0: 20 62 65 68 61 76 69 6f 72 20 73 6f 20 74 68 61 behavior so tha
aab0: 74 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 t [sqlite3_step(
aac0: 29 5d 20 77 69 6c 6c 0a 20 20 72 65 74 75 72 6e )] will. return
aad0: 20 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 5d [SQLITE_MISUSE]
aae0: 20 69 66 20 69 74 20 63 61 6c 6c 65 64 20 61 67 if it called ag
aaf0: 61 69 6e 20 61 66 74 65 72 20 72 65 74 75 72 6e ain after return
ab00: 69 6e 67 20 61 6e 79 74 68 69 6e 67 20 6f 74 68 ing anything oth
ab10: 65 72 0a 20 20 74 68 61 6e 20 5b 53 51 4c 49 54 er. than [SQLIT
ab20: 45 5f 52 4f 57 5d 2c 20 5b 53 51 4c 49 54 45 5f E_ROW], [SQLITE_
ab30: 42 55 53 59 5d 2c 20 6f 72 20 5b 53 51 4c 49 54 BUSY], or [SQLIT
ab40: 45 5f 4c 4f 43 4b 45 44 5d 20 75 6e 6c 65 73 73 E_LOCKED] unless
ab50: 20 74 68 65 72 65 20 77 61 73 20 61 6e 0a 20 20 there was an.
ab60: 69 6e 74 65 72 76 65 6e 69 6e 67 20 63 61 6c 6c intervening call
ab70: 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 to [sqlite3_res
ab80: 65 74 28 29 5d 2e 0a 0a 20 20 49 6e 20 53 51 4c et()]... In SQL
ab90: 69 74 65 20 76 65 72 73 69 6f 6e 20 33 2e 36 2e ite version 3.6.
aba0: 32 33 2e 31 20 61 6e 64 20 65 61 72 6c 69 65 72 23.1 and earlier
abb0: 2c 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 , [sqlite3_step(
abc0: 29 5d 20 75 73 65 64 20 74 6f 20 61 6c 77 61 79 )] used to alway
abd0: 73 0a 20 20 72 65 74 75 72 6e 20 5b 53 51 4c 49 s. return [SQLI
abe0: 54 45 5f 4d 49 53 55 53 45 5d 20 69 66 20 69 74 TE_MISUSE] if it
abf0: 20 77 61 73 20 69 6e 76 6f 6b 65 64 20 61 67 61 was invoked aga
ac00: 69 6e 20 61 66 74 65 72 20 72 65 74 75 72 6e 69 in after returni
ac10: 6e 67 20 61 6e 79 74 68 69 6e 67 0a 20 20 6f 74 ng anything. ot
ac20: 68 65 72 20 74 68 61 6e 20 5b 53 51 4c 49 54 45 her than [SQLITE
ac30: 5f 52 4f 57 5d 20 77 69 74 68 6f 75 74 20 61 6e _ROW] without an
ac40: 20 69 6e 74 65 72 76 65 6e 69 6e 67 20 63 61 6c intervening cal
ac50: 6c 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 72 65 l to [sqlite3_re
ac60: 73 65 74 28 29 5d 2e 0a 20 20 54 68 69 73 20 63 set()].. This c
ac70: 61 75 73 65 64 20 70 72 6f 62 6c 65 6d 73 20 6f aused problems o
ac80: 6e 20 73 6f 6d 65 20 70 6f 6f 72 6c 79 20 77 72 n some poorly wr
ac90: 69 74 74 65 6e 20 73 6d 61 72 74 70 68 6f 6e 65 itten smartphone
aca0: 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 77 68 applications wh
acb0: 69 63 68 0a 20 20 64 69 64 20 6e 6f 74 20 63 6f ich. did not co
acc0: 72 72 65 63 74 6c 79 20 68 61 6e 64 6c 65 20 74 rrectly handle t
acd0: 68 65 20 5b 53 51 4c 49 54 45 5f 4c 4f 43 4b 45 he [SQLITE_LOCKE
ace0: 44 5d 20 61 6e 64 20 5b 53 51 4c 49 54 45 5f 42 D] and [SQLITE_B
acf0: 55 53 59 5d 20 65 72 72 6f 72 20 0a 20 20 72 65 USY] error . re
ad00: 74 75 72 6e 73 2e 20 20 52 61 74 68 65 72 20 74 turns. Rather t
ad10: 68 61 6e 20 66 69 78 20 74 68 65 20 6d 61 6e 79 han fix the many
ad20: 20 64 65 66 65 63 74 69 76 65 20 73 6d 61 72 74 defective smart
ad30: 70 68 6f 6e 65 20 61 70 70 6c 69 63 61 74 69 6f phone applicatio
ad40: 6e 73 2c 20 0a 20 20 74 68 65 20 62 65 68 61 76 ns, . the behav
ad50: 69 6f 72 20 6f 66 20 53 51 4c 69 74 65 20 77 61 ior of SQLite wa
ad60: 73 20 63 68 61 6e 67 65 64 20 69 6e 20 33 2e 36 s changed in 3.6
ad70: 2e 32 33 2e 32 20 74 6f 20 61 75 74 6f 6d 61 74 .23.2 to automat
ad80: 69 63 61 6c 6c 79 20 72 65 73 65 74 0a 20 20 74 ically reset. t
ad90: 68 65 20 70 72 65 70 61 72 65 64 20 73 74 61 74 he prepared stat
ada0: 65 6d 65 6e 74 2e 20 20 42 75 74 20 74 68 61 74 ement. But that
adb0: 20 63 68 61 6e 67 65 64 20 63 61 75 73 65 64 20 changed caused
adc0: 69 73 73 75 65 73 20 69 6e 20 6f 74 68 65 72 20 issues in other
add0: 0a 20 20 69 6d 70 72 6f 70 65 72 6c 79 20 69 6d . improperly im
ade0: 70 6c 65 6d 65 6e 74 65 64 20 61 70 70 6c 69 63 plemented applic
adf0: 61 74 69 6f 6e 73 20 74 68 61 74 20 77 65 72 65 ations that were
ae00: 20 61 63 74 75 61 6c 6c 79 20 6c 6f 6f 6b 69 6e actually lookin
ae10: 67 0a 20 20 66 6f 72 20 61 6e 20 5b 53 51 4c 49 g. for an [SQLI
ae20: 54 45 5f 4d 49 53 55 53 45 5d 20 72 65 74 75 72 TE_MISUSE] retur
ae30: 6e 20 74 6f 20 74 65 72 6d 69 6e 61 74 65 20 74 n to terminate t
ae40: 68 65 69 72 20 71 75 65 72 79 20 6c 6f 6f 70 73 heir query loops
ae50: 2e 20 20 28 41 6e 79 74 69 6d 65 0a 20 20 61 6e . (Anytime. an
ae60: 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 67 65 74 application get
ae70: 73 20 61 6e 20 53 51 4c 49 54 45 5f 4d 49 53 55 s an SQLITE_MISU
ae80: 53 45 20 65 72 72 6f 72 20 63 6f 64 65 20 66 72 SE error code fr
ae90: 6f 6d 20 53 51 4c 69 74 65 2c 20 74 68 61 74 20 om SQLite, that
aea0: 6d 65 61 6e 73 20 74 68 65 0a 20 20 61 70 70 6c means the. appl
aeb0: 69 63 61 74 69 6f 6e 20 69 73 20 6d 69 73 75 73 ication is misus
aec0: 69 6e 67 20 74 68 65 20 53 51 4c 69 74 65 20 69 ing the SQLite i
aed0: 6e 74 65 72 66 61 63 65 20 61 6e 64 20 69 73 20 nterface and is
aee0: 74 68 75 73 20 69 6e 63 6f 72 72 65 63 74 6c 79 thus incorrectly
aef0: 0a 20 20 69 6d 70 6c 65 6d 65 6e 74 65 64 2e 29 . implemented.)
af00: 20 20 54 68 65 20 53 51 4c 49 54 45 5f 4f 4d 49 The SQLITE_OMI
af10: 54 5f 41 55 54 4f 52 45 53 45 54 20 69 6e 74 65 T_AUTORESET inte
af20: 72 66 61 63 65 20 77 61 73 20 61 64 64 65 64 20 rface was added
af30: 74 6f 20 53 51 4c 69 74 65 0a 20 20 76 65 72 73 to SQLite. vers
af40: 69 6f 6e 20 33 2e 37 2e 35 20 69 6e 20 61 6e 20 ion 3.7.5 in an
af50: 65 66 66 6f 72 74 20 74 6f 20 67 65 74 20 61 6c effort to get al
af60: 6c 20 6f 66 20 74 68 65 20 28 62 72 6f 6b 65 6e l of the (broken
af70: 29 0a 20 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 ). applications
af80: 20 74 6f 20 77 6f 72 6b 20 61 67 61 69 6e 20 77 to work again w
af90: 69 74 68 6f 75 74 20 68 61 76 69 6e 67 20 74 6f ithout having to
afa0: 20 61 63 74 75 61 6c 6c 79 20 66 69 78 20 74 68 actually fix th
afb0: 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 2e 0a e applications..
afc0: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
afd0: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 N {SQLITE_OMIT_A
afe0: 55 54 4f 56 41 43 55 55 4d 7d 20 7b 0a 20 20 49 UTOVACUUM} {. I
aff0: 66 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 f this option is
b000: 20 64 65 66 69 6e 65 64 2c 20 74 68 65 20 6c 69 defined, the li
b010: 62 72 61 72 79 20 63 61 6e 6e 6f 74 20 63 72 65 brary cannot cre
b020: 61 74 65 20 6f 72 20 77 72 69 74 65 20 74 6f 20 ate or write to
b030: 0a 20 20 64 61 74 61 62 61 73 65 73 20 74 68 61 . databases tha
b040: 74 20 73 75 70 70 6f 72 74 20 5b 61 75 74 6f 5f t support [auto_
b050: 76 61 63 75 75 6d 5d 2e 0a 20 20 45 78 65 63 75 vacuum].. Execu
b060: 74 69 6e 67 20 61 20 5b 50 52 41 47 4d 41 20 61 ting a [PRAGMA a
b070: 75 74 6f 5f 76 61 63 75 75 6d 5d 20 73 74 61 74 uto_vacuum] stat
b080: 65 6d 65 6e 74 20 69 73 20 6e 6f 74 20 61 6e 20 ement is not an
b090: 65 72 72 6f 72 0a 20 20 28 73 69 6e 63 65 20 75 error. (since u
b0a0: 6e 6b 6e 6f 77 6e 20 50 52 41 47 4d 41 73 20 61 nknown PRAGMAs a
b0b0: 72 65 20 73 69 6c 65 6e 74 6c 79 20 69 67 6e 6f re silently igno
b0c0: 72 65 64 29 2c 20 62 75 74 20 64 6f 65 73 20 6e red), but does n
b0d0: 6f 74 20 72 65 74 75 72 6e 20 61 20 76 61 6c 75 ot return a valu
b0e0: 65 0a 20 20 6f 72 20 6d 6f 64 69 66 79 20 74 68 e. or modify th
b0f0: 65 20 61 75 74 6f 2d 76 61 63 75 75 6d 20 66 6c e auto-vacuum fl
b100: 61 67 20 69 6e 20 74 68 65 20 64 61 74 61 62 61 ag in the databa
b110: 73 65 20 66 69 6c 65 2e 20 49 66 20 61 20 64 61 se file. If a da
b120: 74 61 62 61 73 65 20 74 68 61 74 0a 20 20 73 75 tabase that. su
b130: 70 70 6f 72 74 73 20 61 75 74 6f 2d 76 61 63 75 pports auto-vacu
b140: 75 6d 20 69 73 20 6f 70 65 6e 65 64 20 62 79 20 um is opened by
b150: 61 20 6c 69 62 72 61 72 79 20 63 6f 6d 70 69 6c a library compil
b160: 65 64 20 77 69 74 68 20 74 68 69 73 20 6f 70 74 ed with this opt
b170: 69 6f 6e 2c 20 69 74 0a 20 20 69 73 20 61 75 74 ion, it. is aut
b180: 6f 6d 61 74 69 63 61 6c 6c 79 20 6f 70 65 6e 65 omatically opene
b190: 64 20 69 6e 20 72 65 61 64 2d 6f 6e 6c 79 20 6d d in read-only m
b1a0: 6f 64 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f ode..}..COMPILE_
b1b0: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f OPTION {SQLITE_O
b1c0: 4d 49 54 5f 42 45 54 57 45 45 4e 5f 4f 50 54 49 MIT_BETWEEN_OPTI
b1d0: 4d 49 5a 41 54 49 4f 4e 7d 20 7b 0a 20 20 54 68 MIZATION} {. Th
b1e0: 69 73 20 6f 70 74 69 6f 6e 20 64 69 73 61 62 6c is option disabl
b1f0: 65 73 20 74 68 65 20 75 73 65 20 6f 66 20 69 6e es the use of in
b200: 64 69 63 65 73 20 77 69 74 68 20 57 48 45 52 45 dices with WHERE
b210: 20 63 6c 61 75 73 65 20 74 65 72 6d 73 0a 20 20 clause terms.
b220: 74 68 61 74 20 65 6d 70 6c 6f 79 20 74 68 65 20 that employ the
b230: 42 45 54 57 45 45 4e 20 6f 70 65 72 61 74 6f 72 BETWEEN operator
b240: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
b250: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 ION {SQLITE_OMIT
b260: 5f 42 4c 4f 42 5f 4c 49 54 45 52 41 4c 7d 20 7b _BLOB_LITERAL} {
b270: 0a 20 20 57 68 65 6e 20 74 68 69 73 20 6f 70 74 . When this opt
b280: 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 2c 20 ion is defined,
b290: 69 74 20 69 73 20 6e 6f 74 20 70 6f 73 73 69 62 it is not possib
b2a0: 6c 65 20 74 6f 20 73 70 65 63 69 66 79 20 61 20 le to specify a
b2b0: 62 6c 6f 62 20 69 6e 0a 20 20 61 6e 20 53 51 4c blob in. an SQL
b2c0: 20 73 74 61 74 65 6d 65 6e 74 20 75 73 69 6e 67 statement using
b2d0: 20 74 68 65 20 58 27 41 42 43 44 27 20 73 79 6e the X'ABCD' syn
b2e0: 74 61 78 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f tax..}..COMPILE_
b2f0: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f OPTION {SQLITE_O
b300: 4d 49 54 5f 42 54 52 45 45 43 4f 55 4e 54 7d 20 MIT_BTREECOUNT}
b310: 7b 0a 20 20 57 68 65 6e 20 74 68 69 73 20 6f 70 {. When this op
b320: 74 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 2c tion is defined,
b330: 20 61 6e 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e an optimization
b340: 20 74 68 61 74 20 61 63 63 65 6c 65 72 61 74 65 that accelerate
b350: 73 20 63 6f 75 6e 74 69 6e 67 0a 20 20 61 6c 6c s counting. all
b360: 20 65 6e 74 72 69 65 73 20 69 6e 20 61 20 74 61 entries in a ta
b370: 62 6c 65 20 28 69 6e 20 6f 74 68 65 72 20 77 6f ble (in other wo
b380: 72 64 73 2c 20 61 6e 20 6f 70 74 69 6d 69 7a 61 rds, an optimiza
b390: 74 69 6f 6e 20 74 68 61 74 20 68 65 6c 70 73 0a tion that helps.
b3a0: 20 20 22 53 45 4c 45 43 54 20 63 6f 75 6e 74 28 "SELECT count(
b3b0: 2a 29 20 46 52 4f 4d 20 74 61 62 6c 65 22 20 72 *) FROM table" r
b3c0: 75 6e 20 66 61 73 74 65 72 29 20 69 73 20 6f 6d un faster) is om
b3d0: 69 74 74 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c itted..}..COMPIL
b3e0: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
b3f0: 5f 4f 4d 49 54 5f 42 55 49 4c 54 49 4e 5f 54 45 _OMIT_BUILTIN_TE
b400: 53 54 7d 20 7b 0a 20 20 41 20 73 74 61 6e 64 61 ST} {. A standa
b410: 72 64 20 53 51 4c 69 74 65 20 62 75 69 6c 64 20 rd SQLite build
b420: 69 6e 63 6c 75 64 65 73 20 61 20 73 6d 61 6c 6c includes a small
b430: 20 61 6d 6f 75 6e 74 20 6f 66 20 6c 6f 67 69 63 amount of logic
b440: 20 63 6f 6e 74 72 6f 6c 6c 65 64 0a 20 20 62 79 controlled. by
b450: 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 74 65 the [sqlite3_te
b460: 73 74 5f 63 6f 6e 74 72 6f 6c 28 29 5d 20 69 6e st_control()] in
b470: 74 65 72 66 61 63 65 20 74 68 61 74 20 69 73 20 terface that is
b480: 75 73 65 64 20 74 6f 20 65 78 65 72 63 69 73 65 used to exercise
b490: 0a 20 20 70 61 72 74 73 20 6f 66 20 74 68 65 20 . parts of the
b4a0: 53 51 4c 69 74 65 20 63 6f 72 65 20 74 68 61 74 SQLite core that
b4b0: 20 61 72 65 20 64 69 66 66 69 63 75 6c 74 20 74 are difficult t
b4c0: 6f 20 63 6f 6e 74 72 6f 6c 20 61 6e 64 20 6d 65 o control and me
b4d0: 61 73 75 72 65 20 75 73 69 6e 67 0a 20 20 74 68 asure using. th
b4e0: 65 20 73 74 61 6e 64 61 72 64 20 41 50 49 2e 20 e standard API.
b4f0: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 This option omi
b500: 74 73 20 74 68 61 74 20 62 75 69 6c 74 2d 69 6e ts that built-in
b510: 20 74 65 73 74 20 6c 6f 67 69 63 2e 0a 7d 0a 0a test logic..}..
b520: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
b530: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 43 41 53 54 SQLITE_OMIT_CAST
b540: 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f } {. This optio
b550: 6e 20 63 61 75 73 65 73 20 53 51 4c 69 74 65 20 n causes SQLite
b560: 74 6f 20 6f 6d 69 74 20 73 75 70 70 6f 72 74 20 to omit support
b570: 66 6f 72 20 74 68 65 20 43 41 53 54 20 6f 70 65 for the CAST ope
b580: 72 61 74 6f 72 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c rator..}..COMPIL
b590: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
b5a0: 5f 4f 4d 49 54 5f 43 48 45 43 4b 7d 20 7b 0a 20 _OMIT_CHECK} {.
b5b0: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 75 This option cau
b5c0: 73 65 73 20 53 51 4c 69 74 65 20 74 6f 20 6f 6d ses SQLite to om
b5d0: 69 74 20 73 75 70 70 6f 72 74 20 66 6f 72 20 43 it support for C
b5e0: 48 45 43 4b 20 63 6f 6e 73 74 72 61 69 6e 74 73 HECK constraints
b5f0: 2e 0a 20 20 54 68 65 20 70 61 72 73 65 72 20 77 .. The parser w
b600: 69 6c 6c 20 73 74 69 6c 6c 20 61 63 63 65 70 74 ill still accept
b610: 20 43 48 45 43 4b 20 63 6f 6e 73 74 72 61 69 6e CHECK constrain
b620: 74 73 20 69 6e 20 53 51 4c 20 73 74 61 74 65 6d ts in SQL statem
b630: 65 6e 74 73 2c 0a 20 20 74 68 65 79 20 77 69 6c ents,. they wil
b640: 6c 20 6a 75 73 74 20 6e 6f 74 20 62 65 20 65 6e l just not be en
b650: 66 6f 72 63 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 forced..}..COMPI
b660: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
b670: 45 5f 4f 4d 49 54 5f 43 4f 4d 50 49 4c 45 4f 50 E_OMIT_COMPILEOP
b680: 54 49 4f 4e 5f 44 49 41 47 53 7d 20 7b 0a 20 20 TION_DIAGS} {.
b690: 54 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 75 This option is u
b6a0: 73 65 64 20 74 6f 20 6f 6d 69 74 20 74 68 65 20 sed to omit the
b6b0: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 compile-time opt
b6c0: 69 6f 6e 20 64 69 61 67 6e 6f 73 74 69 63 73 20 ion diagnostics
b6d0: 61 76 61 69 6c 61 62 6c 65 0a 20 20 69 6e 20 53 available. in S
b6e0: 51 4c 69 74 65 2c 20 69 6e 63 6c 75 64 69 6e 67 QLite, including
b6f0: 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 63 6f the [sqlite3_co
b700: 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 75 73 65 64 mpileoption_used
b710: 28 29 5d 20 61 6e 64 0a 20 20 5b 73 71 6c 69 74 ()] and. [sqlit
b720: 65 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e e3_compileoption
b730: 5f 67 65 74 28 29 5d 20 43 2f 43 2b 2b 20 66 75 _get()] C/C++ fu
b740: 6e 63 74 69 6f 6e 73 2c 20 74 68 65 0a 20 20 5b nctions, the. [
b750: 73 71 6c 69 74 65 5f 63 6f 6d 70 69 6c 65 6f 70 sqlite_compileop
b760: 74 69 6f 6e 5f 75 73 65 64 28 29 5d 20 61 6e 64 tion_used()] and
b770: 20 5b 73 71 6c 69 74 65 5f 63 6f 6d 70 69 6c 65 [sqlite_compile
b780: 6f 70 74 69 6f 6e 5f 67 65 74 28 29 5d 20 53 51 option_get()] SQ
b790: 4c 20 66 75 6e 63 74 69 6f 6e 73 2c 0a 20 20 61 L functions,. a
b7a0: 6e 64 20 74 68 65 20 5b 63 6f 6d 70 69 6c 65 5f nd the [compile_
b7b0: 6f 70 74 69 6f 6e 73 20 70 72 61 67 6d 61 5d 2e options pragma].
b7c0: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
b7d0: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
b7e0: 43 4f 4d 50 4c 45 54 45 7d 20 7b 0a 20 20 54 68 COMPLETE} {. Th
b7f0: 69 73 20 6f 70 74 69 6f 6e 20 63 61 75 73 65 73 is option causes
b800: 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 63 6f the [sqlite3_co
b810: 6d 70 6c 65 74 65 28 29 5d 20 61 6e 64 20 5b 73 mplete()] and [s
b820: 71 6c 69 74 65 33 5f 63 6f 6d 70 6c 65 74 65 31 qlite3_complete1
b830: 36 28 29 5d 0a 20 20 69 6e 74 65 72 66 61 63 65 6()]. interface
b840: 73 20 74 6f 20 62 65 20 6f 6d 69 74 74 65 64 2e s to be omitted.
b850: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
b860: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
b870: 43 4f 4d 50 4f 55 4e 44 5f 53 45 4c 45 43 54 7d COMPOUND_SELECT}
b880: 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e {. This option
b890: 20 69 73 20 75 73 65 64 20 74 6f 20 6f 6d 69 74 is used to omit
b8a0: 20 74 68 65 20 63 6f 6d 70 6f 75 6e 64 20 5b 53 the compound [S
b8b0: 45 4c 45 43 54 5d 20 66 75 6e 63 74 69 6f 6e 61 ELECT] functiona
b8c0: 6c 69 74 79 2e 20 0a 20 20 5b 53 45 4c 45 43 54 lity. . [SELECT
b8d0: 5d 20 73 74 61 74 65 6d 65 6e 74 73 20 74 68 61 ] statements tha
b8e0: 74 20 75 73 65 20 74 68 65 20 0a 20 20 55 4e 49 t use the . UNI
b8f0: 4f 4e 2c 20 55 4e 49 4f 4e 20 41 4c 4c 2c 20 49 ON, UNION ALL, I
b900: 4e 54 45 52 53 45 43 54 20 6f 72 20 45 58 43 45 NTERSECT or EXCE
b910: 50 54 20 63 6f 6d 70 6f 75 6e 64 20 53 45 4c 45 PT compound SELE
b920: 43 54 20 6f 70 65 72 61 74 6f 72 73 20 77 69 6c CT operators wil
b930: 6c 20 0a 20 20 63 61 75 73 65 20 61 20 70 61 72 l . cause a par
b940: 73 65 20 65 72 72 6f 72 2e 0a 0a 20 20 41 6e 20 se error... An
b950: 5b 49 4e 53 45 52 54 5d 20 73 74 61 74 65 6d 65 [INSERT] stateme
b960: 6e 74 20 77 69 74 68 20 6d 75 6c 74 69 70 6c 65 nt with multiple
b970: 20 76 61 6c 75 65 73 20 69 6e 20 74 68 65 20 56 values in the V
b980: 41 4c 55 45 53 20 63 6c 61 75 73 65 20 69 73 0a ALUES clause is.
b990: 20 20 69 6d 70 6c 65 6d 65 6e 74 65 64 20 69 6e implemented in
b9a0: 74 65 72 6e 61 6c 6c 79 20 61 73 20 61 20 63 6f ternally as a co
b9b0: 6d 70 6f 75 6e 64 20 53 45 4c 45 43 54 2e 20 20 mpound SELECT.
b9c0: 48 65 6e 63 65 2c 20 74 68 69 73 20 6f 70 74 69 Hence, this opti
b9d0: 6f 6e 20 61 6c 73 6f 0a 20 20 64 69 73 61 62 6c on also. disabl
b9e0: 65 73 20 74 68 65 20 61 62 69 6c 69 74 79 20 74 es the ability t
b9f0: 6f 20 69 6e 73 65 72 74 20 6d 6f 72 65 20 74 68 o insert more th
ba00: 61 6e 20 61 20 73 69 6e 67 6c 65 20 72 6f 77 20 an a single row
ba10: 75 73 69 6e 67 20 61 6e 0a 20 20 49 4e 53 45 52 using an. INSER
ba20: 54 20 49 4e 54 4f 20 2e 2e 2e 20 56 41 4c 55 45 T INTO ... VALUE
ba30: 53 20 2e 2e 2e 20 73 74 61 74 65 6d 65 6e 74 2e S ... statement.
ba40: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
ba50: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
ba60: 43 54 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 CTE} {. This op
ba70: 74 69 6f 6e 20 63 61 75 73 65 73 20 73 75 70 70 tion causes supp
ba80: 6f 72 74 20 66 6f 72 20 5b 63 6f 6d 6d 6f 6e 20 ort for [common
ba90: 74 61 62 6c 65 20 65 78 70 72 65 73 73 69 6f 6e table expression
baa0: 73 5d 20 74 6f 20 62 65 20 6f 6d 69 74 74 65 64 s] to be omitted
bab0: 2e 0a 7d 0a 0a 0a 0a 43 4f 4d 50 49 4c 45 5f 4f ..}....COMPILE_O
bac0: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d PTION {SQLITE_OM
bad0: 49 54 5f 44 41 54 45 54 49 4d 45 5f 46 55 4e 43 IT_DATETIME_FUNC
bae0: 53 7d 20 7b 0a 20 20 49 66 20 74 68 69 73 20 6f S} {. If this o
baf0: 70 74 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 ption is defined
bb00: 2c 20 53 51 4c 69 74 65 27 73 20 62 75 69 6c 74 , SQLite's built
bb10: 2d 69 6e 20 64 61 74 65 20 61 6e 64 20 74 69 6d -in date and tim
bb20: 65 20 6d 61 6e 69 70 75 6c 61 74 69 6f 6e 0a 20 e manipulation.
bb30: 20 66 75 6e 63 74 69 6f 6e 73 20 61 72 65 20 6f functions are o
bb40: 6d 69 74 74 65 64 2e 20 53 70 65 63 69 66 69 63 mitted. Specific
bb50: 61 6c 6c 79 2c 20 74 68 65 20 53 51 4c 20 66 75 ally, the SQL fu
bb60: 6e 63 74 69 6f 6e 73 20 6a 75 6c 69 61 6e 64 61 nctions julianda
bb70: 79 28 29 2c 20 64 61 74 65 28 29 2c 0a 20 20 74 y(), date(),. t
bb80: 69 6d 65 28 29 2c 20 64 61 74 65 74 69 6d 65 28 ime(), datetime(
bb90: 29 20 61 6e 64 20 73 74 72 66 74 69 6d 65 28 29 ) and strftime()
bba0: 20 61 72 65 20 6e 6f 74 20 61 76 61 69 6c 61 62 are not availab
bbb0: 6c 65 2e 20 54 68 65 20 64 65 66 61 75 6c 74 20 le. The default
bbc0: 63 6f 6c 75 6d 6e 0a 20 20 76 61 6c 75 65 73 20 column. values
bbd0: 43 55 52 52 45 4e 54 5f 54 49 4d 45 2c 20 43 55 CURRENT_TIME, CU
bbe0: 52 52 45 4e 54 5f 44 41 54 45 20 61 6e 64 20 43 RRENT_DATE and C
bbf0: 55 52 52 45 4e 54 5f 54 49 4d 45 53 54 41 4d 50 URRENT_TIMESTAMP
bc00: 20 61 72 65 20 73 74 69 6c 6c 20 61 76 61 69 6c are still avail
bc10: 61 62 6c 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 able..}..COMPILE
bc20: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
bc30: 4f 4d 49 54 5f 44 45 43 4c 54 59 50 45 7d 20 7b OMIT_DECLTYPE} {
bc40: 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 . This option c
bc50: 61 75 73 65 73 20 53 51 4c 69 74 65 20 74 6f 20 auses SQLite to
bc60: 6f 6d 69 74 20 73 75 70 70 6f 72 74 20 66 6f 72 omit support for
bc70: 20 74 68 65 0a 20 20 5b 73 71 6c 69 74 65 33 5f the. [sqlite3_
bc80: 63 6f 6c 75 6d 6e 5f 64 65 63 6c 74 79 70 65 28 column_decltype(
bc90: 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f )] and [sqlite3_
bca0: 63 6f 6c 75 6d 6e 5f 64 65 63 6c 74 79 70 65 31 column_decltype1
bcb0: 36 28 29 5d 0a 20 20 69 6e 74 65 72 66 61 63 65 6()]. interface
bcc0: 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 s..}..COMPILE_OP
bcd0: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 TION {SQLITE_OMI
bce0: 54 5f 44 45 50 52 45 43 41 54 45 44 7d 20 7b 0a T_DEPRECATED} {.
bcf0: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 This option ca
bd00: 75 73 65 73 20 53 51 4c 69 74 65 20 74 6f 20 6f uses SQLite to o
bd10: 6d 69 74 20 73 75 70 70 6f 72 74 20 66 6f 72 20 mit support for
bd20: 69 6e 74 65 72 66 61 63 65 73 0a 20 20 6d 61 72 interfaces. mar
bd30: 6b 65 64 20 61 73 20 64 65 70 72 65 63 61 74 65 ked as deprecate
bd40: 64 2e 20 20 54 68 69 73 20 69 6e 63 6c 75 64 65 d. This include
bd50: 73 20 0a 20 20 5b 73 71 6c 69 74 65 33 5f 61 67 s . [sqlite3_ag
bd60: 67 72 65 67 61 74 65 5f 63 6f 75 6e 74 28 29 5d gregate_count()]
bd70: 2c 0a 20 20 5b 73 71 6c 69 74 65 33 5f 65 78 70 ,. [sqlite3_exp
bd80: 69 72 65 64 28 29 5d 2c 0a 20 20 5b 73 71 6c 69 ired()],. [sqli
bd90: 74 65 33 5f 74 72 61 6e 73 66 65 72 5f 62 69 6e te3_transfer_bin
bda0: 64 69 6e 67 73 28 29 5d 2c 0a 20 20 5b 73 71 6c dings()],. [sql
bdb0: 69 74 65 33 5f 67 6c 6f 62 61 6c 5f 72 65 63 6f ite3_global_reco
bdc0: 76 65 72 28 29 5d 2c 0a 20 20 5b 73 71 6c 69 74 ver()],. [sqlit
bdd0: 65 33 5f 74 68 72 65 61 64 5f 63 6c 65 61 6e 75 e3_thread_cleanu
bde0: 70 28 29 5d 20 61 6e 64 0a 20 20 5b 73 71 6c 69 p()] and. [sqli
bdf0: 74 65 33 5f 6d 65 6d 6f 72 79 5f 61 6c 61 72 6d te3_memory_alarm
be00: 28 29 5d 20 69 6e 74 65 72 66 61 63 65 73 2e 0a ()] interfaces..
be10: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
be20: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 44 N {SQLITE_OMIT_D
be30: 49 53 4b 49 4f 7d 20 7b 0a 20 20 54 68 69 73 20 ISKIO} {. This
be40: 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 61 6c 6c option omits all
be50: 20 73 75 70 70 6f 72 74 20 66 6f 72 20 77 72 69 support for wri
be60: 74 69 6e 67 20 74 6f 20 74 68 65 20 64 69 73 6b ting to the disk
be70: 20 61 6e 64 20 66 6f 72 63 65 73 0a 20 20 64 61 and forces. da
be80: 74 61 62 61 73 65 73 20 74 6f 20 65 78 69 73 74 tabases to exist
be90: 20 69 6e 20 6d 65 6d 6f 72 79 20 6f 6e 6c 79 2e in memory only.
bea0: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 68 61 This option ha
beb0: 73 20 6e 6f 74 20 62 65 65 6e 20 0a 20 20 6d 61 s not been . ma
bec0: 69 6e 74 61 69 6e 65 64 20 61 6e 64 20 70 72 6f intained and pro
bed0: 62 61 62 6c 79 20 64 6f 65 73 20 6e 6f 74 20 77 bably does not w
bee0: 6f 72 6b 20 77 69 74 68 20 6e 65 77 65 72 20 76 ork with newer v
bef0: 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74 ersions of SQLit
bf00: 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 e..}..COMPILE_OP
bf10: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 TION {SQLITE_OMI
bf20: 54 5f 45 58 50 4c 41 49 4e 7d 20 7b 0a 20 20 44 T_EXPLAIN} {. D
bf30: 65 66 69 6e 69 6e 67 20 74 68 69 73 20 6f 70 74 efining this opt
bf40: 69 6f 6e 20 63 61 75 73 65 73 20 74 68 65 20 5b ion causes the [
bf50: 45 58 50 4c 41 49 4e 5d 20 63 6f 6d 6d 61 6e 64 EXPLAIN] command
bf60: 20 74 6f 20 62 65 20 6f 6d 69 74 74 65 64 20 66 to be omitted f
bf70: 72 6f 6d 20 74 68 65 0a 20 20 6c 69 62 72 61 72 rom the. librar
bf80: 79 2e 20 41 74 74 65 6d 70 74 69 6e 67 20 74 6f y. Attempting to
bf90: 20 65 78 65 63 75 74 65 20 61 6e 20 5b 45 58 50 execute an [EXP
bfa0: 4c 41 49 4e 5d 20 73 74 61 74 65 6d 65 6e 74 20 LAIN] statement
bfb0: 77 69 6c 6c 20 63 61 75 73 65 20 61 20 70 61 72 will cause a par
bfc0: 73 65 0a 20 20 65 72 72 6f 72 2e 0a 7d 0a 0a 43 se. error..}..C
bfd0: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
bfe0: 51 4c 49 54 45 5f 4f 4d 49 54 5f 46 4c 41 47 5f QLITE_OMIT_FLAG_
bff0: 50 52 41 47 4d 41 53 7d 20 7b 0a 20 20 54 68 69 PRAGMAS} {. Thi
c000: 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 73 s option omits s
c010: 75 70 70 6f 72 74 20 66 6f 72 20 61 20 73 75 62 upport for a sub
c020: 73 65 74 20 6f 66 20 5b 50 52 41 47 4d 41 5d 20 set of [PRAGMA]
c030: 63 6f 6d 6d 61 6e 64 73 20 74 68 61 74 0a 20 20 commands that.
c040: 71 75 65 72 79 20 61 6e 64 20 73 65 74 20 62 6f query and set bo
c050: 6f 6c 65 61 6e 20 70 72 6f 70 65 72 74 69 65 73 olean properties
c060: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
c070: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 ION {SQLITE_OMIT
c080: 5f 46 4c 4f 41 54 49 4e 47 5f 50 4f 49 4e 54 7d _FLOATING_POINT}
c090: 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e {. This option
c0a0: 20 69 73 20 75 73 65 64 20 74 6f 20 6f 6d 69 74 is used to omit
c0b0: 20 66 6c 6f 61 74 69 6e 67 2d 70 6f 69 6e 74 20 floating-point
c0c0: 6e 75 6d 62 65 72 20 73 75 70 70 6f 72 74 20 66 number support f
c0d0: 72 6f 6d 20 74 68 65 20 53 51 4c 69 74 65 0a 20 rom the SQLite.
c0e0: 20 6c 69 62 72 61 72 79 2e 20 57 68 65 6e 20 73 library. When s
c0f0: 70 65 63 69 66 69 65 64 2c 20 73 70 65 63 69 66 pecified, specif
c100: 79 69 6e 67 20 61 20 66 6c 6f 61 74 69 6e 67 20 ying a floating
c110: 70 6f 69 6e 74 20 6e 75 6d 62 65 72 20 61 73 20 point number as
c120: 61 20 6c 69 74 65 72 61 6c 20 0a 20 20 28 69 2e a literal . (i.
c130: 65 2e 20 22 31 2e 30 31 22 29 20 72 65 73 75 6c e. "1.01") resul
c140: 74 73 20 69 6e 20 61 20 70 61 72 73 65 20 65 72 ts in a parse er
c150: 72 6f 72 2e 0a 0a 20 20 3c 70 3e 49 6e 20 74 68 ror... <p>In th
c160: 65 20 66 75 74 75 72 65 2c 20 74 68 69 73 20 6f e future, this o
c170: 70 74 69 6f 6e 20 6d 61 79 20 61 6c 73 6f 20 64 ption may also d
c180: 69 73 61 62 6c 65 20 6f 74 68 65 72 20 66 6c 6f isable other flo
c190: 61 74 69 6e 67 20 70 6f 69 6e 74 20 0a 20 20 66 ating point . f
c1a0: 75 6e 63 74 69 6f 6e 61 6c 69 74 79 2c 20 66 6f unctionality, fo
c1b0: 72 20 65 78 61 6d 70 6c 65 20 74 68 65 20 5b 73 r example the [s
c1c0: 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 64 6f qlite3_result_do
c1d0: 75 62 6c 65 28 29 5d 2c 20 0a 20 20 5b 73 71 6c uble()], . [sql
c1e0: 69 74 65 33 5f 62 69 6e 64 5f 64 6f 75 62 6c 65 ite3_bind_double
c1f0: 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 76 61 ()], [sqlite3_va
c200: 6c 75 65 5f 64 6f 75 62 6c 65 28 29 5d 20 61 6e lue_double()] an
c210: 64 0a 20 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c d. [sqlite3_col
c220: 75 6d 6e 5f 64 6f 75 62 6c 65 28 29 5d 20 41 50 umn_double()] AP
c230: 49 20 66 75 6e 63 74 69 6f 6e 73 2e 0a 20 20 3c I functions.. <
c240: 2f 70 3e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f /p>.}..COMPILE_O
c250: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d PTION {SQLITE_OM
c260: 49 54 5f 46 4f 52 45 49 47 4e 5f 4b 45 59 7d 20 IT_FOREIGN_KEY}
c270: 7b 0a 20 20 49 66 20 74 68 69 73 20 6f 70 74 69 {. If this opti
c280: 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 2c 20 74 on is defined, t
c290: 68 65 6e 20 5b 66 6f 72 65 69 67 6e 20 6b 65 79 hen [foreign key
c2a0: 20 63 6f 6e 73 74 72 61 69 6e 74 5d 20 73 79 6e constraint] syn
c2b0: 74 61 78 20 69 73 0a 20 20 6e 6f 74 20 72 65 63 tax is. not rec
c2c0: 6f 67 6e 69 7a 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 ognized..}..COMP
c2d0: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
c2e0: 54 45 5f 4f 4d 49 54 5f 47 45 54 5f 54 41 42 4c TE_OMIT_GET_TABL
c2f0: 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 E} {. This opti
c300: 6f 6e 20 63 61 75 73 65 73 20 73 75 70 70 6f 72 on causes suppor
c310: 74 20 66 6f 72 20 5b 73 71 6c 69 74 65 33 5f 67 t for [sqlite3_g
c320: 65 74 5f 74 61 62 6c 65 28 29 5d 20 61 6e 64 0a et_table()] and.
c330: 20 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 5f [sqlite3_free_
c340: 74 61 62 6c 65 28 29 5d 20 74 6f 20 62 65 20 6f table()] to be o
c350: 6d 69 74 74 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 mitted..}..COMPI
c360: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
c370: 45 5f 4f 4d 49 54 5f 49 4e 43 52 42 4c 4f 42 7d E_OMIT_INCRBLOB}
c380: 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e {. This option
c390: 20 63 61 75 73 65 73 20 73 75 70 70 6f 72 74 20 causes support
c3a0: 66 6f 72 20 5b 73 71 6c 69 74 65 33 5f 62 6c 6f for [sqlite3_blo
c3b0: 62 20 7c 20 69 6e 63 72 65 6d 65 6e 74 61 6c 20 b | incremental
c3c0: 42 4c 4f 42 20 49 2f 4f 5d 0a 20 20 74 6f 20 62 BLOB I/O]. to b
c3d0: 65 20 6f 6d 69 74 74 65 64 2e 0a 7d 0a 0a 43 4f e omitted..}..CO
c3e0: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 MPILE_OPTION {SQ
c3f0: 4c 49 54 45 5f 4f 4d 49 54 5f 49 4e 54 45 47 52 LITE_OMIT_INTEGR
c400: 49 54 59 5f 43 48 45 43 4b 7d 20 7b 0a 20 20 54 ITY_CHECK} {. T
c410: 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 his option omits
c420: 20 73 75 70 70 6f 72 74 20 66 6f 72 20 74 68 65 support for the
c430: 20 5b 69 6e 74 65 67 72 69 74 79 5f 63 68 65 63 [integrity_chec
c440: 6b 20 70 72 61 67 6d 61 5d 2e 0a 7d 0a 0a 43 4f k pragma]..}..CO
c450: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 MPILE_OPTION {SQ
c460: 4c 49 54 45 5f 4f 4d 49 54 5f 4c 49 4b 45 5f 4f LITE_OMIT_LIKE_O
c470: 50 54 49 4d 49 5a 41 54 49 4f 4e 7d 20 7b 0a 20 PTIMIZATION} {.
c480: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 64 69 73 This option dis
c490: 61 62 6c 65 73 20 74 68 65 20 61 62 69 6c 69 74 ables the abilit
c4a0: 79 20 6f 66 20 53 51 4c 69 74 65 20 74 6f 20 75 y of SQLite to u
c4b0: 73 65 20 69 6e 64 69 63 65 73 20 74 6f 20 68 65 se indices to he
c4c0: 6c 70 0a 20 20 72 65 73 6f 6c 76 65 20 5b 4c 49 lp. resolve [LI
c4d0: 4b 45 5d 20 61 6e 64 20 5b 47 4c 4f 42 5d 20 6f KE] and [GLOB] o
c4e0: 70 65 72 61 74 6f 72 73 20 69 6e 20 61 20 57 48 perators in a WH
c4f0: 45 52 45 20 63 6c 61 75 73 65 2e 0a 7d 0a 0a 43 ERE clause..}..C
c500: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
c510: 51 4c 49 54 45 5f 4f 4d 49 54 5f 4c 4f 41 44 5f QLITE_OMIT_LOAD_
c520: 45 58 54 45 4e 53 49 4f 4e 7d 20 7b 0a 20 20 54 EXTENSION} {. T
c530: 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 his option omits
c540: 20 74 68 65 20 65 6e 74 69 72 65 20 65 78 74 65 the entire exte
c550: 6e 73 69 6f 6e 20 6c 6f 61 64 69 6e 67 20 6d 65 nsion loading me
c560: 63 68 61 6e 69 73 6d 20 66 72 6f 6d 0a 20 20 53 chanism from. S
c570: 51 4c 69 74 65 2c 20 69 6e 63 6c 75 64 69 6e 67 QLite, including
c580: 20 5b 73 71 6c 69 74 65 33 5f 65 6e 61 62 6c 65 [sqlite3_enable
c590: 5f 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f 6e 28 _load_extension(
c5a0: 29 5d 20 61 6e 64 0a 20 20 5b 73 71 6c 69 74 65 )] and. [sqlite
c5b0: 33 5f 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f 6e 3_load_extension
c5c0: 28 29 5d 20 69 6e 74 65 72 66 61 63 65 73 2e 0a ()] interfaces..
c5d0: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
c5e0: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 4c N {SQLITE_OMIT_L
c5f0: 4f 43 41 4c 54 49 4d 45 7d 20 7b 0a 20 20 54 68 OCALTIME} {. Th
c600: 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 is option omits
c610: 74 68 65 20 22 6c 6f 63 61 6c 74 69 6d 65 22 20 the "localtime"
c620: 6d 6f 64 69 66 69 65 72 20 66 72 6f 6d 20 74 68 modifier from th
c630: 65 20 64 61 74 65 20 61 6e 64 20 74 69 6d 65 0a e date and time.
c640: 20 20 66 75 6e 63 74 69 6f 6e 73 2e 20 20 54 68 functions. Th
c650: 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 73 6f 6d is option is som
c660: 65 74 69 6d 65 73 20 75 73 65 66 75 6c 20 77 68 etimes useful wh
c670: 65 6e 20 74 72 79 69 6e 67 20 74 6f 20 63 6f 6d en trying to com
c680: 70 69 6c 65 0a 20 20 74 68 65 20 64 61 74 65 20 pile. the date
c690: 61 6e 64 20 74 69 6d 65 20 66 75 6e 63 74 69 6f and time functio
c6a0: 6e 73 20 6f 6e 20 61 20 70 6c 61 74 66 6f 72 6d ns on a platform
c6b0: 20 74 68 61 74 20 64 6f 65 73 20 6e 6f 74 20 73 that does not s
c6c0: 75 70 70 6f 72 74 20 74 68 65 0a 20 20 63 6f 6e upport the. con
c6d0: 63 65 70 74 20 6f 66 20 6c 6f 63 61 6c 20 74 69 cept of local ti
c6e0: 6d 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f me..}..COMPILE_O
c6f0: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d PTION {SQLITE_OM
c700: 49 54 5f 4c 4f 4f 4b 41 53 49 44 45 7d 20 7b 0a IT_LOOKASIDE} {.
c710: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d This option om
c720: 69 74 73 20 74 68 65 20 5b 6c 6f 6f 6b 61 73 69 its the [lookasi
c730: 64 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 de memory alloca
c740: 74 6f 72 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 tor]..}..COMPILE
c750: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
c760: 4f 4d 49 54 5f 4d 45 4d 4f 52 59 44 42 7d 20 7b OMIT_MEMORYDB} {
c770: 0a 20 20 57 68 65 6e 20 74 68 69 73 20 69 73 20 . When this is
c780: 64 65 66 69 6e 65 64 2c 20 74 68 65 20 6c 69 62 defined, the lib
c790: 72 61 72 79 20 64 6f 65 73 20 6e 6f 74 20 72 65 rary does not re
c7a0: 73 70 65 63 74 20 74 68 65 20 73 70 65 63 69 61 spect the specia
c7b0: 6c 20 64 61 74 61 62 61 73 65 0a 20 20 6e 61 6d l database. nam
c7c0: 65 20 22 3a 6d 65 6d 6f 72 79 3a 22 20 28 6e 6f e ":memory:" (no
c7d0: 72 6d 61 6c 6c 79 20 75 73 65 64 20 74 6f 20 63 rmally used to c
c7e0: 72 65 61 74 65 20 61 6e 20 5b 69 6e 2d 6d 65 6d reate an [in-mem
c7f0: 6f 72 79 20 64 61 74 61 62 61 73 65 5d 29 2e 20 ory database]).
c800: 49 66 20 0a 20 20 22 3a 6d 65 6d 6f 72 79 3a 22 If . ":memory:"
c810: 20 69 73 20 70 61 73 73 65 64 20 74 6f 20 5b 73 is passed to [s
c820: 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 5d 2c 20 qlite3_open()],
c830: 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31 36 28 [sqlite3_open16(
c840: 29 5d 2c 20 6f 72 0a 20 20 5b 73 71 6c 69 74 65 )], or. [sqlite
c850: 33 5f 6f 70 65 6e 5f 76 32 28 29 5d 2c 20 61 20 3_open_v2()], a
c860: 66 69 6c 65 20 77 69 74 68 20 74 68 69 73 20 6e file with this n
c870: 61 6d 65 20 77 69 6c 6c 20 62 65 20 0a 20 20 6f ame will be . o
c880: 70 65 6e 65 64 20 6f 72 20 63 72 65 61 74 65 64 pened or created
c890: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
c8a0: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 ION {SQLITE_OMIT
c8b0: 5f 4f 52 5f 4f 50 54 49 4d 49 5a 41 54 49 4f 4e _OR_OPTIMIZATION
c8c0: 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f } {. This optio
c8d0: 6e 20 64 69 73 61 62 6c 65 73 20 74 68 65 20 61 n disables the a
c8e0: 62 69 6c 69 74 79 20 6f 66 20 53 51 4c 69 74 65 bility of SQLite
c8f0: 20 74 6f 20 75 73 65 20 61 6e 20 69 6e 64 65 78 to use an index
c900: 20 74 6f 67 65 74 68 65 72 0a 20 20 77 69 74 68 together. with
c910: 20 74 65 72 6d 73 20 6f 66 20 61 20 57 48 45 52 terms of a WHER
c920: 45 20 63 6c 61 75 73 65 20 63 6f 6e 6e 65 63 74 E clause connect
c930: 65 64 20 62 79 20 74 68 65 20 4f 52 20 6f 70 65 ed by the OR ope
c940: 72 61 74 6f 72 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c rator..}..COMPIL
c950: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
c960: 5f 4f 4d 49 54 5f 50 41 47 45 52 5f 50 52 41 47 _OMIT_PAGER_PRAG
c970: 4d 41 53 7d 20 7b 0a 20 20 44 65 66 69 6e 69 6e MAS} {. Definin
c980: 67 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d g this option om
c990: 69 74 73 20 70 72 61 67 6d 61 73 20 72 65 6c 61 its pragmas rela
c9a0: 74 65 64 20 74 6f 20 74 68 65 20 70 61 67 65 72 ted to the pager
c9b0: 20 73 75 62 73 79 73 74 65 6d 20 66 72 6f 6d 20 subsystem from
c9c0: 0a 20 20 74 68 65 20 62 75 69 6c 64 2e 0a 7d 0a . the build..}.
c9d0: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
c9e0: 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 50 52 41 {SQLITE_OMIT_PRA
c9f0: 47 4d 41 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 GMA} {. This op
ca00: 74 69 6f 6e 20 69 73 20 75 73 65 64 20 74 6f 20 tion is used to
ca10: 6f 6d 69 74 20 74 68 65 20 5b 50 52 41 47 4d 41 omit the [PRAGMA
ca20: 5d 20 63 6f 6d 6d 61 6e 64 0a 20 20 66 72 6f 6d ] command. from
ca30: 20 74 68 65 20 6c 69 62 72 61 72 79 2e 20 4e 6f the library. No
ca40: 74 65 20 74 68 61 74 20 69 74 20 69 73 20 75 73 te that it is us
ca50: 65 66 75 6c 20 74 6f 20 64 65 66 69 6e 65 20 74 eful to define t
ca60: 68 65 20 6d 61 63 72 6f 73 20 74 68 61 74 20 6f he macros that o
ca70: 6d 69 74 0a 20 20 73 70 65 63 69 66 69 63 20 70 mit. specific p
ca80: 72 61 67 6d 61 73 20 69 6e 20 61 64 64 69 74 69 ragmas in additi
ca90: 6f 6e 20 74 6f 20 74 68 69 73 2c 20 61 73 20 74 on to this, as t
caa0: 68 65 79 20 6d 61 79 20 61 6c 73 6f 20 72 65 6d hey may also rem
cab0: 6f 76 65 20 73 75 70 70 6f 72 74 69 6e 67 20 63 ove supporting c
cac0: 6f 64 65 0a 20 20 69 6e 20 6f 74 68 65 72 20 73 ode. in other s
cad0: 75 62 2d 73 79 73 74 65 6d 73 2e 20 54 68 69 73 ub-systems. This
cae0: 20 6d 61 63 72 6f 20 72 65 6d 6f 76 65 73 20 74 macro removes t
caf0: 68 65 20 5b 50 52 41 47 4d 41 5d 20 63 6f 6d 6d he [PRAGMA] comm
cb00: 61 6e 64 20 6f 6e 6c 79 2e 0a 7d 0a 0a 43 4f 4d and only..}..COM
cb10: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c PILE_OPTION {SQL
cb20: 49 54 45 5f 4f 4d 49 54 5f 50 52 4f 47 52 45 53 ITE_OMIT_PROGRES
cb30: 53 5f 43 41 4c 4c 42 41 43 4b 7d 20 7b 0a 20 20 S_CALLBACK} {.
cb40: 54 68 69 73 20 6f 70 74 69 6f 6e 20 6d 61 79 20 This option may
cb50: 62 65 20 64 65 66 69 6e 65 64 20 74 6f 20 6f 6d be defined to om
cb60: 69 74 20 74 68 65 20 63 61 70 61 62 69 6c 69 74 it the capabilit
cb70: 79 20 74 6f 20 69 73 73 75 65 20 22 70 72 6f 67 y to issue "prog
cb80: 72 65 73 73 22 20 0a 20 20 63 61 6c 6c 62 61 63 ress" . callbac
cb90: 6b 73 20 64 75 72 69 6e 67 20 6c 6f 6e 67 2d 72 ks during long-r
cba0: 75 6e 6e 69 6e 67 20 53 51 4c 20 73 74 61 74 65 unning SQL state
cbb0: 6d 65 6e 74 73 2e 20 54 68 65 20 0a 20 20 5b 73 ments. The . [s
cbc0: 71 6c 69 74 65 33 5f 70 72 6f 67 72 65 73 73 5f qlite3_progress_
cbd0: 68 61 6e 64 6c 65 72 28 29 5d 0a 20 20 41 50 49 handler()]. API
cbe0: 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 6e 6f 74 function is not
cbf0: 20 70 72 65 73 65 6e 74 20 69 6e 20 74 68 65 20 present in the
cc00: 6c 69 62 72 61 72 79 2e 0a 7d 0a 0a 43 4f 4d 50 library..}..COMP
cc10: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
cc20: 54 45 5f 4f 4d 49 54 5f 51 55 49 43 4b 42 41 4c TE_OMIT_QUICKBAL
cc30: 41 4e 43 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f ANCE} {. This o
cc40: 70 74 69 6f 6e 20 6f 6d 69 74 73 20 61 6e 20 61 ption omits an a
cc50: 6c 74 65 72 6e 61 74 69 76 65 2c 20 66 61 73 74 lternative, fast
cc60: 65 72 20 42 2d 54 72 65 65 20 62 61 6c 61 6e 63 er B-Tree balanc
cc70: 69 6e 67 20 72 6f 75 74 69 6e 65 2e 0a 20 20 55 ing routine.. U
cc80: 73 69 6e 67 20 74 68 69 73 20 6f 70 74 69 6f 6e sing this option
cc90: 20 6d 61 6b 65 73 20 53 51 4c 69 74 65 20 73 6c makes SQLite sl
cca0: 69 67 68 74 6c 79 20 73 6d 61 6c 6c 65 72 20 61 ightly smaller a
ccb0: 74 20 74 68 65 20 65 78 70 65 6e 73 65 20 6f 66 t the expense of
ccc0: 0a 20 20 6d 61 6b 69 6e 67 20 69 74 20 72 75 6e . making it run
ccd0: 20 73 6c 69 67 68 74 6c 79 20 73 6c 6f 77 65 72 slightly slower
cce0: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
ccf0: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 ION {SQLITE_OMIT
cd00: 5f 52 45 49 4e 44 45 58 7d 20 7b 0a 20 20 57 68 _REINDEX} {. Wh
cd10: 65 6e 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 en this option i
cd20: 73 20 64 65 66 69 6e 65 64 2c 20 74 68 65 20 5b s defined, the [
cd30: 52 45 49 4e 44 45 58 5d 0a 20 20 63 6f 6d 6d 61 REINDEX]. comma
cd40: 6e 64 20 69 73 20 6e 6f 74 20 69 6e 63 6c 75 64 nd is not includ
cd50: 65 64 20 69 6e 20 74 68 65 20 6c 69 62 72 61 72 ed in the librar
cd60: 79 2e 0a 20 20 45 78 65 63 75 74 69 6e 67 20 61 y.. Executing a
cd70: 20 5b 52 45 49 4e 44 45 58 5d 20 73 74 61 74 65 [REINDEX] state
cd80: 6d 65 6e 74 20 63 61 75 73 65 73 20 0a 20 20 61 ment causes . a
cd90: 20 70 61 72 73 65 20 65 72 72 6f 72 2e 0a 7d 0a parse error..}.
cda0: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
cdb0: 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 53 43 48 {SQLITE_OMIT_SCH
cdc0: 45 4d 41 5f 50 52 41 47 4d 41 53 7d 20 7b 0a 20 EMA_PRAGMAS} {.
cdd0: 20 44 65 66 69 6e 69 6e 67 20 74 68 69 73 20 6f Defining this o
cde0: 70 74 69 6f 6e 20 6f 6d 69 74 73 20 70 72 61 67 ption omits prag
cdf0: 6d 61 73 20 66 6f 72 20 71 75 65 72 79 69 6e 67 mas for querying
ce00: 20 74 68 65 20 64 61 74 61 62 61 73 65 20 73 63 the database sc
ce10: 68 65 6d 61 20 66 72 6f 6d 20 0a 20 20 74 68 65 hema from . the
ce20: 20 62 75 69 6c 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 build..}..COMPI
ce30: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
ce40: 45 5f 4f 4d 49 54 5f 53 43 48 45 4d 41 5f 56 45 E_OMIT_SCHEMA_VE
ce50: 52 53 49 4f 4e 5f 50 52 41 47 4d 41 53 7d 20 7b RSION_PRAGMAS} {
ce60: 0a 20 20 44 65 66 69 6e 69 6e 67 20 74 68 69 73 . Defining this
ce70: 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 70 72 option omits pr
ce80: 61 67 6d 61 73 20 66 6f 72 20 71 75 65 72 79 69 agmas for queryi
ce90: 6e 67 20 61 6e 64 20 6d 6f 64 69 66 79 69 6e 67 ng and modifying
cea0: 20 74 68 65 20 0a 20 20 64 61 74 61 62 61 73 65 the . database
ceb0: 20 73 63 68 65 6d 61 20 76 65 72 73 69 6f 6e 20 schema version
cec0: 61 6e 64 20 75 73 65 72 20 76 65 72 73 69 6f 6e and user version
ced0: 20 66 72 6f 6d 20 74 68 65 20 62 75 69 6c 64 2e from the build.
cee0: 20 53 70 65 63 69 66 69 63 61 6c 6c 79 2c 20 74 Specifically, t
cef0: 68 65 20 0a 20 20 5b 73 63 68 65 6d 61 5f 76 65 he . [schema_ve
cf00: 72 73 69 6f 6e 5d 20 61 6e 64 20 5b 75 73 65 72 rsion] and [user
cf10: 5f 76 65 72 73 69 6f 6e 5d 20 50 52 41 47 4d 41 _version] PRAGMA
cf20: 73 20 61 72 65 20 6f 6d 69 74 74 65 64 2e 0a 7d s are omitted..}
cf30: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
cf40: 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 53 48 {SQLITE_OMIT_SH
cf50: 41 52 45 44 5f 43 41 43 48 45 7d 20 7b 0a 20 20 ARED_CACHE} {.
cf60: 54 68 69 73 20 6f 70 74 69 6f 6e 20 62 75 69 6c This option buil
cf70: 64 73 20 53 51 4c 69 74 65 20 77 69 74 68 6f 75 ds SQLite withou
cf80: 74 20 73 75 70 70 6f 72 74 20 66 6f 72 20 73 68 t support for sh
cf90: 61 72 65 64 2d 63 61 63 68 65 20 6d 6f 64 65 2e ared-cache mode.
cfa0: 0a 20 20 54 68 65 20 5b 73 71 6c 69 74 65 33 5f . The [sqlite3_
cfb0: 65 6e 61 62 6c 65 5f 73 68 61 72 65 64 5f 63 61 enable_shared_ca
cfc0: 63 68 65 28 29 5d 20 69 73 20 6f 6d 69 74 74 65 che()] is omitte
cfd0: 64 20 61 6c 6f 6e 67 20 77 69 74 68 20 61 20 66 d along with a f
cfe0: 61 69 72 0a 20 20 61 6d 6f 75 6e 74 20 6f 66 20 air. amount of
cff0: 6c 6f 67 69 63 20 77 69 74 68 69 6e 20 74 68 65 logic within the
d000: 20 42 2d 54 72 65 65 20 73 75 62 73 79 73 74 65 B-Tree subsyste
d010: 6d 20 61 73 73 6f 63 69 61 74 65 64 20 77 69 74 m associated wit
d020: 68 20 73 68 61 72 65 64 0a 20 20 63 61 63 68 65 h shared. cache
d030: 20 6d 61 6e 61 67 65 6d 65 6e 74 2e 0a 7d 0a 0a management..}..
d040: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
d050: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 53 55 42 51 SQLITE_OMIT_SUBQ
d060: 55 45 52 59 7d 20 7b 0a 20 20 49 66 20 64 65 66 UERY} {. If def
d070: 69 6e 65 64 2c 20 73 75 70 70 6f 72 74 20 66 6f ined, support fo
d080: 72 20 73 75 62 2d 73 65 6c 65 63 74 73 20 61 6e r sub-selects an
d090: 64 20 74 68 65 20 49 4e 28 29 20 6f 70 65 72 61 d the IN() opera
d0a0: 74 6f 72 20 61 72 65 20 6f 6d 69 74 74 65 64 2e tor are omitted.
d0b0: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
d0c0: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
d0d0: 54 43 4c 5f 56 41 52 49 41 42 4c 45 7d 20 7b 0a TCL_VARIABLE} {.
d0e0: 20 20 49 66 20 74 68 69 73 20 6d 61 63 72 6f 20 If this macro
d0f0: 69 73 20 64 65 66 69 6e 65 64 2c 20 74 68 65 6e is defined, then
d100: 20 74 68 65 20 73 70 65 63 69 61 6c 20 22 24 3c the special "$<
d110: 76 61 72 69 61 62 6c 65 2d 6e 61 6d 65 3e 22 20 variable-name>"
d120: 73 79 6e 74 61 78 0a 20 20 75 73 65 64 20 74 6f syntax. used to
d130: 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 62 automatically b
d140: 69 6e 64 20 53 51 4c 20 76 61 72 69 61 62 6c 65 ind SQL variable
d150: 73 20 74 6f 20 54 43 4c 20 76 61 72 69 61 62 6c s to TCL variabl
d160: 65 73 20 69 73 20 6f 6d 69 74 74 65 64 2e 0a 7d es is omitted..}
d170: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
d180: 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 54 45 {SQLITE_OMIT_TE
d190: 4d 50 44 42 7d 20 7b 0a 20 20 54 68 69 73 20 6f MPDB} {. This o
d1a0: 70 74 69 6f 6e 20 6f 6d 69 74 73 20 73 75 70 70 ption omits supp
d1b0: 6f 72 74 20 66 6f 72 20 54 45 4d 50 20 6f 72 20 ort for TEMP or
d1c0: 54 45 4d 50 4f 52 41 52 59 20 74 61 62 6c 65 73 TEMPORARY tables
d1d0: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
d1e0: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 ION {SQLITE_OMIT
d1f0: 5f 54 52 41 43 45 7d 20 7b 0a 20 20 54 68 69 73 _TRACE} {. This
d200: 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 73 75 option omits su
d210: 70 70 6f 72 74 20 66 6f 72 20 74 68 65 20 5b 73 pport for the [s
d220: 71 6c 69 74 65 33 5f 70 72 6f 66 69 6c 65 28 29 qlite3_profile()
d230: 5d 20 61 6e 64 0a 20 20 5b 73 71 6c 69 74 65 33 ] and. [sqlite3
d240: 5f 74 72 61 63 65 28 29 5d 20 69 6e 74 65 72 66 _trace()] interf
d250: 61 63 65 73 20 61 6e 64 20 74 68 65 69 72 20 61 aces and their a
d260: 73 73 6f 63 69 61 74 65 64 20 6c 6f 67 69 63 2e ssociated logic.
d270: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
d280: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
d290: 54 52 49 47 47 45 52 7d 20 7b 0a 20 20 44 65 66 TRIGGER} {. Def
d2a0: 69 6e 69 6e 67 20 74 68 69 73 20 6f 70 74 69 6f ining this optio
d2b0: 6e 20 6f 6d 69 74 73 20 73 75 70 70 6f 72 74 20 n omits support
d2c0: 66 6f 72 20 54 52 49 47 47 45 52 20 6f 62 6a 65 for TRIGGER obje
d2d0: 63 74 73 2e 20 4e 65 69 74 68 65 72 20 74 68 65 cts. Neither the
d2e0: 20 0a 20 20 5b 43 52 45 41 54 45 20 54 52 49 47 . [CREATE TRIG
d2f0: 47 45 52 5d 20 6f 72 20 5b 44 52 4f 50 20 54 52 GER] or [DROP TR
d300: 49 47 47 45 52 5d 0a 20 20 63 6f 6d 6d 61 6e 64 IGGER]. command
d310: 73 20 61 72 65 20 61 76 61 69 6c 61 62 6c 65 20 s are available
d320: 69 6e 20 74 68 69 73 20 63 61 73 65 2c 20 61 6e in this case, an
d330: 64 20 61 74 74 65 6d 70 74 69 6e 67 20 74 6f 20 d attempting to
d340: 65 78 65 63 75 74 65 0a 20 20 65 69 74 68 65 72 execute. either
d350: 20 77 69 6c 6c 20 72 65 73 75 6c 74 20 69 6e 20 will result in
d360: 61 20 70 61 72 73 65 20 65 72 72 6f 72 2e 0a 20 a parse error..
d370: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 61 6c 73 This option als
d380: 6f 20 64 69 73 61 62 6c 65 73 20 65 6e 66 6f 72 o disables enfor
d390: 63 65 6d 65 6e 74 20 6f 66 20 5b 66 6f 72 65 69 cement of [forei
d3a0: 67 6e 20 6b 65 79 20 63 6f 6e 73 74 72 61 69 6e gn key constrain
d3b0: 74 73 5d 2c 0a 20 20 73 69 6e 63 65 20 74 68 65 ts],. since the
d3c0: 20 63 6f 64 65 20 74 68 61 74 20 69 6d 70 6c 65 code that imple
d3d0: 6d 65 6e 74 73 20 74 72 69 67 67 65 72 73 20 61 ments triggers a
d3e0: 6e 64 20 77 68 69 63 68 20 69 73 20 6f 6d 69 74 nd which is omit
d3f0: 74 65 64 20 62 79 20 74 68 69 73 0a 20 20 6f 70 ted by this. op
d400: 74 69 6f 6e 20 69 73 20 61 6c 73 6f 20 75 73 65 tion is also use
d410: 64 20 74 6f 20 69 6d 70 6c 65 6d 65 6e 74 20 5b d to implement [
d420: 66 6f 72 65 69 67 6e 20 6b 65 79 20 61 63 74 69 foreign key acti
d430: 6f 6e 73 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 ons]..}..COMPILE
d440: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
d450: 4f 4d 49 54 5f 54 52 55 4e 43 41 54 45 5f 4f 50 OMIT_TRUNCATE_OP
d460: 54 49 4d 49 5a 41 54 49 4f 4e 7d 20 7b 0a 20 20 TIMIZATION} {.
d470: 41 20 64 65 66 61 75 6c 74 20 62 75 69 6c 64 20 A default build
d480: 6f 66 20 53 51 4c 69 74 65 2c 20 69 66 20 61 20 of SQLite, if a
d490: 5b 44 45 4c 45 54 45 5d 20 73 74 61 74 65 6d 65 [DELETE] stateme
d4a0: 6e 74 20 68 61 73 20 6e 6f 20 57 48 45 52 45 20 nt has no WHERE
d4b0: 63 6c 61 75 73 65 0a 20 20 61 6e 64 20 6f 70 65 clause. and ope
d4c0: 72 61 74 65 73 20 6f 6e 20 61 20 74 61 62 6c 65 rates on a table
d4d0: 20 77 69 74 68 20 6e 6f 20 74 72 69 67 67 65 72 with no trigger
d4e0: 73 2c 20 61 6e 20 6f 70 74 69 6d 69 7a 61 74 69 s, an optimizati
d4f0: 6f 6e 20 6f 63 63 75 72 73 20 74 68 61 74 0a 20 on occurs that.
d500: 20 63 61 75 73 65 73 20 74 68 65 20 44 45 4c 45 causes the DELE
d510: 54 45 20 74 6f 20 6f 63 63 75 72 20 62 79 20 64 TE to occur by d
d520: 72 6f 70 70 69 6e 67 20 61 6e 64 20 72 65 63 72 ropping and recr
d530: 65 61 74 69 6e 67 20 74 68 65 20 74 61 62 6c 65 eating the table
d540: 2e 20 20 0a 20 20 44 72 6f 70 70 69 6e 67 20 61 . . Dropping a
d550: 6e 64 20 72 65 63 72 65 61 74 69 6e 67 20 61 20 nd recreating a
d560: 74 61 62 6c 65 20 69 73 20 75 73 75 61 6c 6c 79 table is usually
d570: 20 6d 75 63 68 20 66 61 73 74 65 72 20 74 68 61 much faster tha
d580: 6e 20 64 65 6c 65 74 69 6e 67 0a 20 20 74 68 65 n deleting. the
d590: 20 74 61 62 6c 65 20 63 6f 6e 74 65 6e 74 20 72 table content r
d5a0: 6f 77 20 62 79 20 72 6f 77 2e 20 20 54 68 69 73 ow by row. This
d5b0: 20 69 73 20 74 68 65 20 22 74 72 75 6e 63 61 74 is the "truncat
d5c0: 65 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e 22 2e e optimization".
d5d0: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
d5e0: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
d5f0: 55 54 46 31 36 7d 20 7b 0a 20 20 54 68 69 73 20 UTF16} {. This
d600: 6d 61 63 72 6f 20 69 73 20 75 73 65 64 20 74 6f macro is used to
d610: 20 6f 6d 69 74 20 73 75 70 70 6f 72 74 20 66 6f omit support fo
d620: 72 20 55 54 46 31 36 20 74 65 78 74 20 65 6e 63 r UTF16 text enc
d630: 6f 64 69 6e 67 2e 20 57 68 65 6e 20 74 68 69 73 oding. When this
d640: 20 69 73 0a 20 20 64 65 66 69 6e 65 64 20 61 6c is. defined al
d650: 6c 20 41 50 49 20 66 75 6e 63 74 69 6f 6e 73 20 l API functions
d660: 74 68 61 74 20 72 65 74 75 72 6e 20 6f 72 20 61 that return or a
d670: 63 63 65 70 74 20 55 54 46 31 36 20 65 6e 63 6f ccept UTF16 enco
d680: 64 65 64 20 74 65 78 74 20 61 72 65 0a 20 20 75 ded text are. u
d690: 6e 61 76 61 69 6c 61 62 6c 65 2e 20 54 68 65 73 navailable. Thes
d6a0: 65 20 66 75 6e 63 74 69 6f 6e 73 20 63 61 6e 20 e functions can
d6b0: 62 65 20 69 64 65 6e 74 69 66 69 65 64 20 62 79 be identified by
d6c0: 20 74 68 65 20 66 61 63 74 20 74 68 61 74 20 74 the fact that t
d6d0: 68 65 79 20 65 6e 64 0a 20 20 77 69 74 68 20 27 hey end. with '
d6e0: 31 36 27 2c 20 66 6f 72 20 65 78 61 6d 70 6c 65 16', for example
d6f0: 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 [sqlite3_prepar
d700: 65 31 36 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 e16()], [sqlite3
d710: 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 31 36 28 29 _column_text16()
d720: 5d 20 61 6e 64 0a 20 20 5b 73 71 6c 69 74 65 33 ] and. [sqlite3
d730: 5f 62 69 6e 64 5f 74 65 78 74 31 36 28 29 5d 2e _bind_text16()].
d740: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
d750: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
d760: 56 41 43 55 55 4d 7d 20 7b 0a 20 20 57 68 65 6e VACUUM} {. When
d770: 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 this option is
d780: 64 65 66 69 6e 65 64 2c 20 74 68 65 20 5b 56 41 defined, the [VA
d790: 43 55 55 4d 5d 0a 20 20 63 6f 6d 6d 61 6e 64 20 CUUM]. command
d7a0: 69 73 20 6e 6f 74 20 69 6e 63 6c 75 64 65 64 20 is not included
d7b0: 69 6e 20 74 68 65 20 6c 69 62 72 61 72 79 2e 0a in the library..
d7c0: 20 20 45 78 65 63 75 74 69 6e 67 20 61 20 5b 56 Executing a [V
d7d0: 41 43 55 55 4d 5d 20 73 74 61 74 65 6d 65 6e 74 ACUUM] statement
d7e0: 20 63 61 75 73 65 73 20 0a 20 20 61 20 70 61 72 causes . a par
d7f0: 73 65 20 65 72 72 6f 72 2e 0a 7d 0a 0a 43 4f 4d se error..}..COM
d800: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c PILE_OPTION {SQL
d810: 49 54 45 5f 4f 4d 49 54 5f 56 49 45 57 7d 20 7b ITE_OMIT_VIEW} {
d820: 0a 20 20 44 65 66 69 6e 69 6e 67 20 74 68 69 73 . Defining this
d830: 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 73 75 option omits su
d840: 70 70 6f 72 74 20 66 6f 72 20 56 49 45 57 20 6f pport for VIEW o
d850: 62 6a 65 63 74 73 2e 20 4e 65 69 74 68 65 72 20 bjects. Neither
d860: 74 68 65 20 0a 20 20 5b 43 52 45 41 54 45 20 56 the . [CREATE V
d870: 49 45 57 5d 20 6e 6f 72 20 74 68 65 20 5b 44 52 IEW] nor the [DR
d880: 4f 50 20 56 49 45 57 5d 0a 20 20 63 6f 6d 6d 61 OP VIEW]. comma
d890: 6e 64 73 20 61 72 65 20 61 76 61 69 6c 61 62 6c nds are availabl
d8a0: 65 20 69 6e 20 74 68 69 73 20 63 61 73 65 2c 20 e in this case,
d8b0: 61 6e 64 0a 20 20 61 74 74 65 6d 70 74 69 6e 67 and. attempting
d8c0: 20 74 6f 20 65 78 65 63 75 74 65 20 65 69 74 68 to execute eith
d8d0: 65 72 20 77 69 6c 6c 20 72 65 73 75 6c 74 20 69 er will result i
d8e0: 6e 20 61 20 70 61 72 73 65 20 65 72 72 6f 72 2e n a parse error.
d8f0: 0a 0a 20 20 57 41 52 4e 49 4e 47 3a 20 49 66 20 .. WARNING: If
d900: 74 68 69 73 20 6d 61 63 72 6f 20 69 73 20 64 65 this macro is de
d910: 66 69 6e 65 64 2c 20 69 74 20 77 69 6c 6c 20 6e fined, it will n
d920: 6f 74 20 62 65 20 70 6f 73 73 69 62 6c 65 20 74 ot be possible t
d930: 6f 20 6f 70 65 6e 20 61 20 64 61 74 61 62 61 73 o open a databas
d940: 65 0a 20 20 66 6f 72 20 77 68 69 63 68 20 74 68 e. for which th
d950: 65 20 73 63 68 65 6d 61 20 63 6f 6e 74 61 69 6e e schema contain
d960: 73 20 56 49 45 57 20 6f 62 6a 65 63 74 73 2e 20 s VIEW objects.
d970: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
d980: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
d990: 56 49 52 54 55 41 4c 54 41 42 4c 45 7d 20 7b 0a VIRTUALTABLE} {.
d9a0: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d This option om
d9b0: 69 74 73 20 73 75 70 70 6f 72 74 20 66 6f 72 20 its support for
d9c0: 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 74 61 the [sqlite3_vta
d9d0: 62 20 7c 20 56 69 72 74 75 61 6c 20 54 61 62 6c b | Virtual Tabl
d9e0: 65 5d 0a 20 20 6d 65 63 68 61 6e 69 73 6d 20 69 e]. mechanism i
d9f0: 6e 20 53 51 4c 69 74 65 2e 0a 7d 0a 0a 43 4f 4d n SQLite..}..COM
da00: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c PILE_OPTION {SQL
da10: 49 54 45 5f 4f 4d 49 54 5f 57 41 4c 7d 20 7b 0a ITE_OMIT_WAL} {.
da20: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d This option om
da30: 69 74 73 20 74 68 65 20 22 5b 77 72 69 74 65 2d its the "[write-
da40: 61 68 65 61 64 20 6c 6f 67 5d 22 20 28 61 2e 6b ahead log]" (a.k
da50: 2e 61 2e 20 22 5b 57 41 4c 5d 22 29 20 63 61 70 .a. "[WAL]") cap
da60: 61 62 69 6c 69 74 79 2e 0a 7d 0a 0a 43 4f 4d 50 ability..}..COMP
da70: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
da80: 54 45 5f 4f 4d 49 54 5f 57 53 44 7d 20 7b 0a 20 TE_OMIT_WSD} {.
da90: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 62 75 69 This option bui
daa0: 6c 64 73 20 61 20 76 65 72 73 69 6f 6e 20 6f 66 lds a version of
dab0: 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62 72 the SQLite libr
dac0: 61 72 79 20 74 68 61 74 20 63 6f 6e 74 61 69 6e ary that contain
dad0: 73 20 6e 6f 0a 20 20 57 72 69 74 61 62 6c 65 20 s no. Writable
dae0: 53 74 61 74 69 63 20 44 61 74 61 20 28 57 53 44 Static Data (WSD
daf0: 29 2e 20 20 57 53 44 20 69 73 20 67 6c 6f 62 61 ). WSD is globa
db00: 6c 20 76 61 72 69 61 62 6c 65 73 20 61 6e 64 2f l variables and/
db10: 6f 72 20 73 74 61 74 69 63 0a 20 20 76 61 72 69 or static. vari
db20: 61 62 6c 65 73 2e 20 20 53 6f 6d 65 20 70 6c 61 ables. Some pla
db30: 74 66 6f 72 6d 73 20 64 6f 20 6e 6f 74 20 73 75 tforms do not su
db40: 70 70 6f 72 74 20 57 53 44 2c 20 61 6e 64 20 74 pport WSD, and t
db50: 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 6e 65 his option is ne
db60: 63 65 73 73 61 72 79 0a 20 20 69 6e 20 6f 72 64 cessary. in ord
db70: 65 72 20 66 6f 72 20 53 51 4c 69 74 65 20 74 6f er for SQLite to
db80: 20 77 6f 72 6b 20 74 68 6f 73 65 20 70 6c 61 74 work those plat
db90: 66 6f 72 6d 73 2e 20 20 0a 0a 20 20 55 6e 6c 69 forms. .. Unli
dba0: 6b 65 20 6f 74 68 65 72 20 4f 4d 49 54 20 6f 70 ke other OMIT op
dbb0: 74 69 6f 6e 73 20 77 68 69 63 68 20 6d 61 6b 65 tions which make
dbc0: 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62 72 the SQLite libr
dbd0: 61 72 79 20 73 6d 61 6c 6c 65 72 2c 0a 20 20 74 ary smaller,. t
dbe0: 68 69 73 20 6f 70 74 69 6f 6e 20 61 63 74 75 61 his option actua
dbf0: 6c 6c 79 20 69 6e 63 72 65 61 73 65 73 20 74 68 lly increases th
dc00: 65 20 73 69 7a 65 20 6f 66 20 53 51 4c 69 74 65 e size of SQLite
dc10: 20 61 6e 64 20 6d 61 6b 65 73 20 69 74 20 72 75 and makes it ru
dc20: 6e 0a 20 20 61 20 6c 69 74 74 6c 65 20 73 6c 6f n. a little slo
dc30: 77 65 72 2e 20 20 4f 6e 6c 79 20 75 73 65 20 74 wer. Only use t
dc40: 68 69 73 20 6f 70 74 69 6f 6e 20 69 66 20 53 51 his option if SQ
dc50: 4c 69 74 65 20 69 73 20 62 65 69 6e 67 20 62 75 Lite is being bu
dc60: 69 6c 74 20 66 6f 72 20 61 6e 0a 20 20 65 6d 62 ilt for an. emb
dc70: 65 64 64 65 64 20 74 61 72 67 65 74 20 74 68 61 edded target tha
dc80: 74 20 64 6f 65 73 20 6e 6f 74 20 73 75 70 70 6f t does not suppo
dc90: 72 74 20 57 53 44 2e 0a 7d 0a 0a 43 4f 4d 50 49 rt WSD..}..COMPI
dca0: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
dcb0: 45 5f 4f 4d 49 54 5f 58 46 45 52 5f 4f 50 54 7d E_OMIT_XFER_OPT}
dcc0: 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e {. This option
dcd0: 20 6f 6d 69 74 73 20 73 75 70 70 6f 72 74 20 66 omits support f
dce0: 6f 72 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e 73 or optimizations
dcf0: 20 74 68 61 74 20 68 65 6c 70 20 73 74 61 74 65 that help state
dd00: 6d 65 6e 74 73 0a 20 20 6f 66 20 74 68 65 20 66 ments. of the f
dd10: 6f 72 6d 20 22 49 4e 53 45 52 54 20 49 4e 54 4f orm "INSERT INTO
dd20: 20 2e 2e 2e 20 53 45 4c 45 43 54 20 2e 2e 2e 22 ... SELECT ..."
dd30: 20 72 75 6e 20 66 61 73 74 65 72 2e 0a 7d 0a 0a run faster..}..
dd40: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
dd50: 53 51 4c 49 54 45 5f 5a 45 52 4f 5f 4d 41 4c 4c SQLITE_ZERO_MALL
dd60: 4f 43 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 OC} {. This opt
dd70: 69 6f 6e 20 6f 6d 69 74 73 20 62 6f 74 68 20 74 ion omits both t
dd80: 68 65 20 5b 64 65 66 61 75 6c 74 20 6d 65 6d 6f he [default memo
dd90: 72 79 20 61 6c 6c 6f 63 61 74 6f 72 5d 20 61 6e ry allocator] an
dda0: 64 20 74 68 65 0a 20 20 5b 64 65 62 75 67 67 69 d the. [debuggi
ddb0: 6e 67 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 ng memory alloca
ddc0: 74 6f 72 5d 20 66 72 6f 6d 20 74 68 65 20 62 75 tor] from the bu
ddd0: 69 6c 64 20 61 6e 64 20 73 75 62 73 74 69 74 75 ild and substitu
dde0: 74 65 73 20 61 20 73 74 75 62 0a 20 20 6d 65 6d tes a stub. mem
ddf0: 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 20 74 68 ory allocator th
de00: 61 74 20 61 6c 77 61 79 73 20 66 61 69 6c 73 2e at always fails.
de10: 20 20 53 51 4c 69 74 65 20 77 69 6c 6c 20 6e 6f SQLite will no
de20: 74 20 72 75 6e 20 77 69 74 68 20 74 68 69 73 0a t run with this.
de30: 20 20 73 74 75 62 20 6d 65 6d 6f 72 79 20 61 6c stub memory al
de40: 6c 6f 63 61 74 6f 72 20 73 69 6e 63 65 20 69 74 locator since it
de50: 20 77 69 6c 6c 20 62 65 20 75 6e 61 62 6c 65 20 will be unable
de60: 74 6f 20 61 6c 6c 6f 63 61 74 65 20 6d 65 6d 6f to allocate memo
de70: 72 79 2e 20 20 42 75 74 0a 20 20 74 68 69 73 20 ry. But. this
de80: 73 74 75 62 20 63 61 6e 20 62 65 20 72 65 70 6c stub can be repl
de90: 61 63 65 64 20 61 74 20 73 74 61 72 74 2d 74 69 aced at start-ti
dea0: 6d 65 20 75 73 69 6e 67 0a 20 20 5b 73 71 6c 69 me using. [sqli
deb0: 74 65 33 5f 63 6f 6e 66 69 67 5d 28 5b 53 51 4c te3_config]([SQL
dec0: 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 41 4c 4c 4f ITE_CONFIG_MALLO
ded0: 43 5d 2c 2e 2e 2e 29 20 6f 72 0a 20 20 5b 73 71 C],...) or. [sq
dee0: 6c 69 74 65 33 5f 63 6f 6e 66 69 67 5d 28 5b 53 lite3_config]([S
def0: 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 48 45 41 QLITE_CONFIG_HEA
df00: 50 5d 2c 2e 2e 2e 29 2e 0a 20 20 53 6f 20 74 68 P],...).. So th
df10: 65 20 6e 65 74 20 65 66 66 65 63 74 20 6f 66 20 e net effect of
df20: 74 68 69 73 20 63 6f 6d 70 69 6c 65 2d 74 69 6d this compile-tim
df30: 65 20 6f 70 74 69 6f 6e 20 69 73 20 74 68 61 74 e option is that
df40: 20 69 74 20 61 6c 6c 6f 77 73 20 53 51 4c 69 74 it allows SQLit
df50: 65 0a 20 20 74 6f 20 62 65 20 63 6f 6d 70 69 6c e. to be compil
df60: 65 64 20 61 6e 64 20 6c 69 6e 6b 65 64 20 61 67 ed and linked ag
df70: 61 69 6e 73 74 20 61 20 73 79 73 74 65 6d 20 6c ainst a system l
df80: 69 62 72 61 72 79 20 74 68 61 74 20 64 6f 65 73 ibrary that does
df90: 20 6e 6f 74 20 73 75 70 70 6f 72 74 0a 20 20 6d not support. m
dfa0: 61 6c 6c 6f 63 28 29 2c 20 66 72 65 65 28 29 2c alloc(), free(),
dfb0: 20 61 6e 64 2f 6f 72 20 72 65 61 6c 6c 6f 63 28 and/or realloc(
dfc0: 29 2e 0a 7d 0a 0a 3c 2f 74 63 6c 3e 0a 3c 61 20 )..}..</tcl>.<a
dfd0: 6e 61 6d 65 3d 22 64 65 62 75 67 6f 70 74 69 6f name="debugoptio
dfe0: 6e 73 22 3e 3c 2f 61 3e 0a 3c 68 32 3e 31 2e 38 ns"></a>.<h2>1.8
dff0: 20 41 6e 61 6c 79 73 69 73 20 61 6e 64 20 44 65 Analysis and De
e000: 62 75 67 67 69 6e 67 20 4f 70 74 69 6f 6e 73 3c bugging Options<
e010: 2f 68 32 3e 0a 3c 74 63 6c 3e 0a 0a 43 4f 4d 50 /h2>.<tcl>..COMP
e020: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
e030: 54 45 5f 44 45 42 55 47 7d 20 7b 0a 20 20 54 68 TE_DEBUG} {. Th
e040: 65 20 53 51 4c 69 74 65 20 73 6f 75 72 63 65 20 e SQLite source
e050: 63 6f 64 65 20 63 6f 6e 74 61 69 6e 73 20 6c 69 code contains li
e060: 74 65 72 61 6c 6c 79 20 74 68 6f 75 73 61 6e 64 terally thousand
e070: 73 20 6f 66 20 61 73 73 65 72 74 28 29 20 73 74 s of assert() st
e080: 61 74 65 6d 65 6e 74 73 0a 20 20 75 73 65 64 20 atements. used
e090: 74 6f 20 76 65 72 69 66 79 20 69 6e 74 65 72 6e to verify intern
e0a0: 61 6c 20 61 73 73 75 6d 70 74 69 6f 6e 73 20 61 al assumptions a
e0b0: 6e 64 20 73 75 62 72 6f 75 74 69 6e 65 20 70 72 nd subroutine pr
e0c0: 65 63 6f 6e 64 69 74 69 6f 6e 73 20 61 6e 64 0a econditions and.
e0d0: 20 20 70 6f 73 74 63 6f 6e 64 69 74 69 6f 6e 73 postconditions
e0e0: 2e 20 20 54 68 65 73 65 20 61 73 73 65 72 74 28 . These assert(
e0f0: 29 20 73 74 61 74 65 6d 65 6e 74 73 20 61 72 65 ) statements are
e100: 20 6e 6f 72 6d 61 6c 6c 79 20 74 75 72 6e 65 64 normally turned
e110: 20 6f 66 66 0a 20 20 28 74 68 65 79 20 67 65 6e off. (they gen
e120: 65 72 61 74 65 20 6e 6f 20 63 6f 64 65 29 20 73 erate no code) s
e130: 69 6e 63 65 20 74 75 72 6e 69 6e 67 20 74 68 65 ince turning the
e140: 6d 20 6f 6e 20 6d 61 6b 65 73 20 53 51 4c 69 74 m on makes SQLit
e150: 65 20 72 75 6e 20 61 70 70 72 6f 78 69 6d 61 74 e run approximat
e160: 65 6c 79 0a 20 20 74 68 72 65 65 20 74 69 6d 65 ely. three time
e170: 73 20 73 6c 6f 77 65 72 2e 20 20 42 75 74 20 66 s slower. But f
e180: 6f 72 20 74 65 73 74 69 6e 67 20 61 6e 64 20 61 or testing and a
e190: 6e 61 6c 79 73 69 73 2c 20 69 74 20 69 73 20 75 nalysis, it is u
e1a0: 73 65 66 75 6c 20 74 6f 20 74 75 72 6e 0a 20 20 seful to turn.
e1b0: 74 68 65 20 61 73 73 65 72 74 28 29 20 73 74 61 the assert() sta
e1c0: 74 65 6d 65 6e 74 73 20 6f 6e 2e 20 20 54 68 65 tements on. The
e1d0: 20 53 51 4c 49 54 45 5f 44 45 42 55 47 20 63 6f SQLITE_DEBUG co
e1e0: 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f mpile-time optio
e1f0: 6e 20 64 6f 65 73 20 74 68 69 73 2e 0a 20 20 3c n does this.. <
e200: 70 3e 53 51 4c 49 54 45 5f 44 45 42 55 47 20 61 p>SQLITE_DEBUG a
e210: 6c 73 6f 20 65 6e 61 62 6c 65 73 20 73 6f 6d 65 lso enables some
e220: 20 6f 74 68 65 72 20 64 65 62 75 67 67 69 6e 67 other debugging
e230: 20 66 65 61 74 75 72 65 73 2c 20 73 75 63 68 20 features, such
e240: 61 73 0a 20 20 73 70 65 63 69 61 6c 20 5b 50 52 as. special [PR
e250: 41 47 4d 41 5d 20 73 74 61 74 65 6d 65 6e 74 73 AGMA] statements
e260: 20 74 68 61 74 20 74 75 72 6e 20 6f 6e 20 74 72 that turn on tr
e270: 61 63 69 6e 67 20 61 6e 64 20 6c 69 73 74 69 6e acing and listin
e280: 67 20 66 65 61 74 75 72 65 73 0a 20 20 75 73 65 g features. use
e290: 64 20 66 6f 72 20 74 72 6f 75 62 6c 65 73 68 6f d for troublesho
e2a0: 6f 74 69 6e 67 20 61 6e 64 20 61 6e 61 6c 79 73 oting and analys
e2b0: 69 73 20 6f 66 20 74 68 65 20 5b 56 44 42 45 5d is of the [VDBE]
e2c0: 20 61 6e 64 20 63 6f 64 65 20 67 65 6e 65 72 61 and code genera
e2d0: 74 6f 72 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f tor..}..COMPILE_
e2e0: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4d OPTION {SQLITE_M
e2f0: 45 4d 44 45 42 55 47 7d 20 7b 0a 20 20 54 68 65 EMDEBUG} {. The
e300: 20 53 51 4c 49 54 45 5f 4d 45 4d 44 45 42 55 47 SQLITE_MEMDEBUG
e310: 20 6f 70 74 69 6f 6e 20 63 61 75 73 65 73 20 61 option causes a
e320: 6e 20 69 6e 73 74 72 75 6d 65 6e 74 65 64 20 0a n instrumented .
e330: 20 20 5b 64 65 62 75 67 67 69 6e 67 20 6d 65 6d [debugging mem
e340: 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 5d 0a 20 ory allocator].
e350: 20 74 6f 20 62 65 20 75 73 65 64 20 61 73 20 74 to be used as t
e360: 68 65 20 64 65 66 61 75 6c 74 20 6d 65 6d 6f 72 he default memor
e370: 79 20 61 6c 6c 6f 63 61 74 6f 72 20 77 69 74 68 y allocator with
e380: 69 6e 20 53 51 4c 69 74 65 2e 20 20 54 68 65 0a in SQLite. The.
e390: 20 20 69 6e 73 74 72 75 6d 65 6e 74 65 64 20 6d instrumented m
e3a0: 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 20 emory allocator
e3b0: 63 68 65 63 6b 73 20 66 6f 72 20 6d 69 73 75 73 checks for misus
e3c0: 65 20 6f 66 20 64 79 6e 61 6d 69 63 61 6c 6c 79 e of dynamically
e3d0: 20 61 6c 6c 6f 63 61 74 65 64 0a 20 20 6d 65 6d allocated. mem
e3e0: 6f 72 79 2e 20 20 45 78 61 6d 70 6c 65 73 20 6f ory. Examples o
e3f0: 66 20 6d 69 73 75 73 65 20 69 6e 63 6c 75 64 65 f misuse include
e400: 20 75 73 69 6e 67 20 6d 65 6d 6f 72 79 20 61 66 using memory af
e410: 74 65 72 20 69 74 20 69 73 20 66 72 65 65 64 2c ter it is freed,
e420: 0a 20 20 77 72 69 74 69 6e 67 20 6f 66 66 20 74 . writing off t
e430: 68 65 20 65 6e 64 73 20 6f 66 20 61 20 6d 65 6d he ends of a mem
e440: 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 2c 20 ory allocation,
e450: 66 72 65 65 69 6e 67 20 6d 65 6d 6f 72 79 20 6e freeing memory n
e460: 6f 74 20 70 72 65 76 69 6f 75 73 6c 79 0a 20 20 ot previously.
e470: 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 74 68 obtained from th
e480: 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 e memory allocat
e490: 6f 72 2c 20 6f 72 20 66 61 69 6c 69 6e 67 20 74 or, or failing t
e4a0: 6f 20 69 6e 69 74 69 61 6c 69 7a 65 20 6e 65 77 o initialize new
e4b0: 6c 79 0a 20 20 61 6c 6c 6f 63 61 74 65 64 20 6d ly. allocated m
e4c0: 65 6d 6f 72 79 2e 0a 7d 0a 0a 3c 2f 74 63 6c 3e emory..}..</tcl>
e4d0: 0a 3c 61 20 6e 61 6d 65 3d 22 77 69 6e 33 32 6f .<a name="win32o
e4e0: 70 74 69 6f 6e 73 22 3e 3c 2f 61 3e 0a 3c 68 32 ptions"></a>.<h2
e4f0: 3e 31 2e 39 20 57 69 6e 64 6f 77 73 2d 53 70 65 >1.9 Windows-Spe
e500: 63 69 66 69 63 20 4f 70 74 69 6f 6e 73 3c 2f 68 cific Options</h
e510: 32 3e 0a 3c 74 63 6c 3e 0a 0a 43 4f 4d 50 49 4c 2>.<tcl>..COMPIL
e520: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
e530: 5f 57 49 4e 33 32 5f 48 45 41 50 5f 43 52 45 41 _WIN32_HEAP_CREA
e540: 54 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 TE} {. This opt
e550: 69 6f 6e 20 66 6f 72 63 65 73 20 74 68 65 20 57 ion forces the W
e560: 69 6e 33 32 20 6e 61 74 69 76 65 20 6d 65 6d 6f in32 native memo
e570: 72 79 20 61 6c 6c 6f 63 61 74 6f 72 2c 20 77 68 ry allocator, wh
e580: 65 6e 20 65 6e 61 62 6c 65 64 2c 20 74 6f 0a 20 en enabled, to.
e590: 20 63 72 65 61 74 65 20 61 20 70 72 69 76 61 74 create a privat
e5a0: 65 20 68 65 61 70 20 74 6f 20 68 6f 6c 64 20 61 e heap to hold a
e5b0: 6c 6c 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 ll memory alloca
e5c0: 74 69 6f 6e 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c tions..}..COMPIL
e5d0: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
e5e0: 5f 57 49 4e 33 32 5f 4d 41 4c 4c 4f 43 5f 56 41 _WIN32_MALLOC_VA
e5f0: 4c 49 44 41 54 45 7d 20 7b 0a 20 20 54 68 69 73 LIDATE} {. This
e600: 20 6f 70 74 69 6f 6e 20 66 6f 72 63 65 73 20 74 option forces t
e610: 68 65 20 57 69 6e 33 32 20 6e 61 74 69 76 65 20 he Win32 native
e620: 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 memory allocator
e630: 2c 20 77 68 65 6e 20 65 6e 61 62 6c 65 64 2c 20 , when enabled,
e640: 74 6f 0a 20 20 6d 61 6b 65 20 73 74 72 61 74 65 to. make strate
e650: 67 69 63 20 63 61 6c 6c 73 20 69 6e 74 6f 20 74 gic calls into t
e660: 68 65 20 48 65 61 70 56 61 6c 69 64 61 74 65 28 he HeapValidate(
e670: 29 20 66 75 6e 63 74 69 6f 6e 20 69 66 20 61 73 ) function if as
e680: 73 65 72 74 28 29 20 69 73 20 61 6c 73 6f 0a 20 sert() is also.
e690: 20 65 6e 61 62 6c 65 64 2e 0a 7d 0a 0a 3c 2f 74 enabled..}..</t
e6a0: 63 6c 3e 0a cl>.