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 73 6d 61 6c 6c 65 72 20 63 g in.a smaller c
0180: 6f 6d 70 69 6c 65 64 20 6c 69 62 72 61 72 79 20 ompiled library
0190: 73 69 7a 65 29 20 6f 72 20 74 6f 20 63 68 61 6e size) or to chan
01a0: 67 65 20 74 68 65 0a 3c 61 20 68 72 65 66 3d 22 ge the.<a href="
01b0: 23 64 65 66 61 75 6c 74 73 22 3e 64 65 66 61 75 #defaults">defau
01c0: 6c 74 20 76 61 6c 75 65 73 3c 2f 61 3e 20 6f 66 lt values</a> of
01d0: 20 73 6f 6d 65 20 70 61 72 61 6d 65 74 65 72 73 some parameters
01e0: 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 45 76 65 72 ..</p>..<p>.Ever
01f0: 79 20 65 66 66 6f 72 74 20 68 61 73 20 62 65 65 y effort has bee
0200: 6e 20 6d 61 64 65 20 74 6f 20 65 6e 73 75 72 65 n made to ensure
0210: 20 74 68 61 74 20 74 68 65 20 76 61 72 69 6f 75 that the variou
0220: 73 20 63 6f 6d 62 69 6e 61 74 69 6f 6e 73 0a 6f s combinations.o
0230: 66 20 63 6f 6d 70 69 6c 61 74 69 6f 6e 20 6f 70 f compilation op
0240: 74 69 6f 6e 73 20 77 6f 72 6b 20 68 61 72 6d 6f tions work harmo
0250: 6e 69 6f 75 73 6c 79 20 61 6e 64 20 70 72 6f 64 niously and prod
0260: 75 63 65 20 61 20 77 6f 72 6b 69 6e 67 20 6c 69 uce a working li
0270: 62 72 61 72 79 2e 0a 4e 65 76 65 72 74 68 65 6c brary..Neverthel
0280: 65 73 73 2c 20 69 74 20 69 73 20 73 74 72 6f 6e ess, it is stron
0290: 67 6c 79 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 gly recommended
02a0: 74 68 61 74 20 74 68 65 20 53 51 4c 69 74 65 20 that the SQLite
02b0: 74 65 73 74 2d 73 75 69 74 65 0a 62 65 20 65 78 test-suite.be ex
02c0: 65 63 75 74 65 64 20 74 6f 20 63 68 65 63 6b 20 ecuted to check
02d0: 66 6f 72 20 65 72 72 6f 72 73 20 62 65 66 6f 72 for errors befor
02e0: 65 20 75 73 69 6e 67 20 61 6e 20 53 51 4c 69 74 e using an SQLit
02f0: 65 20 6c 69 62 72 61 72 79 20 62 75 69 6c 74 0a e library built.
0300: 77 69 74 68 20 6e 6f 6e 2d 73 74 61 6e 64 61 72 with non-standar
0310: 64 20 63 6f 6d 70 69 6c 61 74 69 6f 6e 20 6f 70 d compilation op
0320: 74 69 6f 6e 73 2e 0a 3c 2f 70 3e 0a 3c 61 20 6e tions..</p>.<a n
0330: 61 6d 65 3d 22 64 65 66 61 75 6c 74 73 22 3e 3c ame="defaults"><
0340: 2f 61 3e 0a 3c 68 32 3e 31 2e 31 20 4f 70 74 69 /a>.<h2>1.1 Opti
0350: 6f 6e 73 20 54 6f 20 53 65 74 20 44 65 66 61 75 ons To Set Defau
0360: 6c 74 20 50 61 72 61 6d 65 74 65 72 20 56 61 6c lt Parameter Val
0370: 75 65 73 3c 2f 68 32 3e 0a 0a 3c 74 63 6c 3e 0a ues</h2>..<tcl>.
0380: 70 72 6f 63 20 43 4f 4d 50 49 4c 45 5f 4f 50 54 proc COMPILE_OPT
0390: 49 4f 4e 20 7b 6e 61 6d 65 20 74 65 78 74 7d 20 ION {name text}
03a0: 7b 0a 20 20 69 66 20 7b 5b 72 65 67 65 78 70 20 {. if {[regexp
03b0: 7b 53 51 4c 49 54 45 5f 28 5b 41 2d 5a 30 2d 39 {SQLITE_([A-Z0-9
03c0: 5f 5d 2b 29 7d 20 24 6e 61 6d 65 20 61 6c 6c 20 _]+)} $name all
03d0: 6c 61 62 65 6c 5d 7d 20 7b 0a 20 20 20 20 68 64 label]} {. hd
03e0: 5f 66 72 61 67 6d 65 6e 74 20 5b 73 74 72 69 6e _fragment [strin
03f0: 67 20 74 6f 6c 6f 77 65 72 20 24 6c 61 62 65 6c g tolower $label
0400: 5d 0a 20 20 20 20 68 64 5f 6b 65 79 77 6f 72 64 ]. hd_keyword
0410: 73 20 24 61 6c 6c 0a 20 20 7d 0a 20 20 69 66 20 s $all. }. if
0420: 7b 5b 72 65 67 65 78 70 20 7b 5e 59 59 28 5b 41 {[regexp {^YY([A
0430: 2d 5a 30 2d 39 5f 5d 2b 29 7d 20 24 6e 61 6d 65 -Z0-9_]+)} $name
0440: 20 61 6c 6c 20 6c 61 62 65 6c 5d 7d 20 7b 0a 20 all label]} {.
0450: 20 20 20 68 64 5f 66 72 61 67 6d 65 6e 74 20 5b hd_fragment [
0460: 73 74 72 69 6e 67 20 74 6f 6c 6f 77 65 72 20 24 string tolower $
0470: 61 6c 6c 5d 0a 20 20 20 20 68 64 5f 6b 65 79 77 all]. hd_keyw
0480: 6f 72 64 73 20 24 61 6c 6c 0a 20 20 7d 0a 20 20 ords $all. }.
0490: 68 64 5f 70 75 74 73 20 3c 70 3e 3c 62 3e 24 6e hd_puts <p><b>$n
04a0: 61 6d 65 3c 2f 62 3e 3c 2f 70 3e 0a 20 20 72 65 ame</b></p>. re
04b0: 67 73 75 62 20 2d 61 6c 6c 20 22 5c 6e 5c 5c 73 gsub -all "\n\\s
04c0: 2a 5c 6e 22 20 24 74 65 78 74 20 22 3c 2f 70 3e *\n" $text "</p>
04d0: 5c 6e 5c 6e 3c 70 3e 22 20 74 65 78 74 0a 20 20 \n\n<p>" text.
04e0: 68 64 5f 72 65 73 6f 6c 76 65 20 3c 62 6c 6f 63 hd_resolve <bloc
04f0: 6b 71 75 6f 74 65 3e 3c 70 3e 24 74 65 78 74 3c kquote><p>$text<
0500: 2f 70 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e /p></blockquote>
0510: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
0520: 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 45 46 41 55 ON {SQLITE_DEFAU
0530: 4c 54 5f 41 55 54 4f 56 41 43 55 55 4d 3d 3c 69 LT_AUTOVACUUM=<i
0540: 3e 26 6c 74 3b 30 20 6f 72 20 31 20 6f 72 20 32 ><0 or 1 or 2
0550: 26 67 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 ></i>} {. Th
0560: 69 73 20 6d 61 63 72 6f 20 64 65 74 65 72 6d 69 is macro determi
0570: 6e 65 73 20 69 66 20 53 51 4c 69 74 65 20 63 72 nes if SQLite cr
0580: 65 61 74 65 73 20 64 61 74 61 62 61 73 65 73 20 eates databases
0590: 77 69 74 68 20 74 68 65 20 0a 20 20 5b 61 75 74 with the . [aut
05a0: 6f 5f 76 61 63 75 75 6d 5d 20 66 6c 61 67 20 73 o_vacuum] flag s
05b0: 65 74 20 62 79 20 64 65 66 61 75 6c 74 20 74 6f et by default to
05c0: 20 4f 46 46 20 28 30 29 2c 20 46 55 4c 4c 20 28 OFF (0), FULL (
05d0: 31 29 2c 20 6f 72 0a 20 20 49 4e 43 52 45 4d 45 1), or. INCREME
05e0: 4e 54 41 4c 20 28 32 29 2e 20 54 68 65 20 64 65 NTAL (2). The de
05f0: 66 61 75 6c 74 20 76 61 6c 75 65 20 69 73 20 30 fault value is 0
0600: 20 6d 65 61 6e 69 6e 67 20 74 68 61 74 20 64 61 meaning that da
0610: 74 61 62 61 73 65 73 0a 20 20 61 72 65 20 63 72 tabases. are cr
0620: 65 61 74 65 64 20 77 69 74 68 20 61 75 74 6f 2d eated with auto-
0630: 76 61 63 75 75 6d 20 74 75 72 6e 65 64 20 6f 66 vacuum turned of
0640: 66 2e 0a 20 20 49 6e 20 61 6e 79 20 63 61 73 65 f.. In any case
0650: 20 74 68 65 20 63 6f 6d 70 69 6c 65 2d 74 69 6d the compile-tim
0660: 65 20 64 65 66 61 75 6c 74 20 6d 61 79 20 62 65 e default may be
0670: 20 6f 76 65 72 72 69 64 64 65 6e 20 62 79 20 74 overridden by t
0680: 68 65 20 0a 20 20 5b 50 52 41 47 4d 41 20 61 75 he . [PRAGMA au
0690: 74 6f 5f 76 61 63 75 75 6d 5d 20 63 6f 6d 6d 61 to_vacuum] comma
06a0: 6e 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f nd..}..COMPILE_O
06b0: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 45 PTION {SQLITE_DE
06c0: 46 41 55 4c 54 5f 43 41 43 48 45 5f 53 49 5a 45 FAULT_CACHE_SIZE
06d0: 3d 3c 69 3e 26 6c 74 3b 70 61 67 65 73 26 67 74 =<i><pages>
06e0: 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 69 73 20 ;</i>} {. This
06f0: 6d 61 63 72 6f 20 73 65 74 73 20 74 68 65 20 64 macro sets the d
0700: 65 66 61 75 6c 74 20 73 69 7a 65 20 6f 66 20 74 efault size of t
0710: 68 65 20 70 61 67 65 2d 63 61 63 68 65 20 66 6f he page-cache fo
0720: 72 20 65 61 63 68 20 61 74 74 61 63 68 65 64 0a r each attached.
0730: 20 20 64 61 74 61 62 61 73 65 2c 20 69 6e 20 70 database, in p
0740: 61 67 65 73 2e 20 54 68 69 73 20 63 61 6e 20 62 ages. This can b
0750: 65 20 6f 76 65 72 72 69 64 64 65 6e 20 62 79 20 e overridden by
0760: 74 68 65 20 0a 20 20 5b 50 52 41 47 4d 41 20 63 the . [PRAGMA c
0770: 61 63 68 65 5f 73 69 7a 65 5d 20 63 6f 6d 6d 61 ache_size] comma
0780: 6e 64 2e 20 54 68 65 20 64 65 66 61 75 6c 74 20 nd. The default
0790: 76 61 6c 75 65 20 69 73 20 32 30 30 30 2e 0a 7d value is 2000..}
07a0: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
07b0: 20 7b 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 {SQLITE_DEFAULT
07c0: 5f 46 49 4c 45 5f 46 4f 52 4d 41 54 3d 3c 69 3e _FILE_FORMAT=<i>
07d0: 26 6c 74 3b 31 20 6f 72 20 34 26 67 74 3b 3c 2f <1 or 4></
07e0: 69 3e 7d 20 7b 0a 20 20 54 68 65 20 64 65 66 61 i>} {. The defa
07f0: 75 6c 74 20 73 63 68 65 6d 61 2d 6c 65 76 65 6c ult schema-level
0800: 20 66 69 6c 65 20 66 6f 72 6d 61 74 20 75 73 65 file format use
0810: 64 20 62 79 20 53 51 4c 69 74 65 20 77 68 65 6e d by SQLite when
0820: 20 63 72 65 61 74 69 6e 67 0a 20 20 6e 65 77 20 creating. new
0830: 64 61 74 61 62 61 73 65 20 66 69 6c 65 73 20 69 database files i
0840: 73 20 73 65 74 20 62 79 20 74 68 69 73 20 6d 61 s set by this ma
0850: 63 72 6f 2e 20 20 54 68 65 20 66 69 6c 65 20 66 cro. The file f
0860: 6f 72 6d 61 74 73 20 61 72 65 20 61 6c 6c 0a 20 ormats are all.
0870: 20 76 65 72 79 20 73 69 6d 69 6c 61 72 2e 20 20 very similar.
0880: 54 68 65 20 64 69 66 66 65 72 65 6e 63 65 20 62 The difference b
0890: 65 74 77 65 65 6e 20 66 6f 72 6d 61 74 73 20 31 etween formats 1
08a0: 20 61 6e 64 20 34 20 69 73 20 74 68 61 74 20 66 and 4 is that f
08b0: 6f 72 6d 61 74 0a 20 20 34 20 75 6e 64 65 72 73 ormat. 4 unders
08c0: 74 61 6e 64 73 20 64 65 73 63 65 6e 64 69 6e 67 tands descending
08d0: 20 69 6e 64 69 63 65 73 20 61 6e 64 20 68 61 73 indices and has
08e0: 20 61 20 74 69 67 68 74 65 72 20 65 6e 63 6f 64 a tighter encod
08f0: 69 6e 67 20 66 6f 72 0a 20 20 62 6f 6f 6c 65 61 ing for. boolea
0900: 6e 20 76 61 6c 75 65 73 2e 0a 0a 20 20 53 51 4c n values... SQL
0910: 69 74 65 20 28 61 73 20 6f 66 20 5b 76 65 72 73 ite (as of [vers
0920: 69 6f 6e 20 33 2e 36 2e 30 5d 29 20 63 61 6e 20 ion 3.6.0]) can
0930: 72 65 61 64 20 61 6e 64 20 77 72 69 74 65 20 61 read and write a
0940: 6e 79 20 66 69 6c 65 20 66 6f 72 6d 61 74 0a 20 ny file format.
0950: 20 62 65 74 77 65 65 6e 20 31 20 61 6e 64 20 34 between 1 and 4
0960: 2e 20 20 42 75 74 20 6f 6c 64 65 72 20 76 65 72 . But older ver
0970: 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74 65 20 sions of SQLite
0980: 6d 69 67 68 74 20 6e 6f 74 20 62 65 20 61 62 6c might not be abl
0990: 65 20 74 6f 0a 20 20 72 65 61 64 20 66 6f 72 6d e to. read form
09a0: 61 74 73 20 67 72 65 61 74 65 72 20 74 68 61 6e ats greater than
09b0: 20 31 2e 20 20 53 6f 20 74 68 61 74 20 6f 6c 64 1. So that old
09c0: 65 72 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 53 er versions of S
09d0: 51 4c 69 74 65 20 77 69 6c 6c 0a 20 20 62 65 20 QLite will. be
09e0: 61 62 6c 65 20 74 6f 20 72 65 61 64 20 61 6e 64 able to read and
09f0: 20 77 72 69 74 65 20 64 61 74 61 62 61 73 65 20 write database
0a00: 66 69 6c 65 73 20 63 72 65 61 74 65 64 20 62 79 files created by
0a10: 20 6e 65 77 65 72 20 76 65 72 73 69 6f 6e 73 0a newer versions.
0a20: 20 20 6f 66 20 53 51 4c 69 74 65 2c 20 74 68 65 of SQLite, the
0a30: 20 64 65 66 61 75 6c 74 20 66 69 6c 65 20 66 6f default file fo
0a40: 72 6d 61 74 20 69 73 20 73 65 74 20 74 6f 20 31 rmat is set to 1
0a50: 20 66 6f 72 20 6d 61 78 69 6d 75 6d 0a 20 20 63 for maximum. c
0a60: 6f 6d 70 61 74 69 62 69 6c 69 74 79 2e 0a 0a 20 ompatibility...
0a70: 20 54 68 65 20 66 69 6c 65 20 66 6f 72 6d 61 74 The file format
0a80: 20 66 6f 72 20 61 20 6e 65 77 20 64 61 74 61 62 for a new datab
0a90: 61 73 65 20 63 61 6e 20 62 65 20 73 65 74 20 61 ase can be set a
0aa0: 74 20 72 75 6e 74 69 6d 65 20 75 73 69 6e 67 0a t runtime using.
0ab0: 20 20 74 68 65 20 5b 50 52 41 47 4d 41 20 6c 65 the [PRAGMA le
0ac0: 67 61 63 79 5f 66 69 6c 65 5f 66 6f 72 6d 61 74 gacy_file_format
0ad0: 5d 20 63 6f 6d 6d 61 6e 64 2e 0a 7d 0a 0a 43 4f ] command..}..CO
0ae0: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 MPILE_OPTION {SQ
0af0: 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f 46 4f 52 LITE_DEFAULT_FOR
0b00: 45 49 47 4e 5f 4b 45 59 53 3d 3c 69 3e 26 6c 74 EIGN_KEYS=<i><
0b10: 3b 30 20 6f 72 20 31 26 67 74 3b 3c 2f 69 3e 7d ;0 or 1></i>}
0b20: 20 7b 0a 20 20 54 68 69 73 20 6d 61 63 72 6f 20 {. This macro
0b30: 64 65 74 65 72 6d 69 6e 65 73 20 77 68 65 74 68 determines wheth
0b40: 65 72 20 65 6e 66 6f 72 63 65 6d 65 6e 74 20 6f er enforcement o
0b50: 66 20 0a 20 20 5b 66 6f 72 65 69 67 6e 20 6b 65 f . [foreign ke
0b60: 79 20 63 6f 6e 73 74 72 61 69 6e 74 73 5d 20 69 y constraints] i
0b70: 73 20 65 6e 61 62 6c 65 64 20 6f 72 20 64 69 73 s enabled or dis
0b80: 61 62 6c 65 64 20 62 79 20 64 65 66 61 75 6c 74 abled by default
0b90: 20 66 6f 72 0a 20 20 6e 65 77 20 64 61 74 61 62 for. new datab
0ba0: 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 2e ase connections.
0bb0: 20 20 45 61 63 68 20 64 61 74 61 62 61 73 65 20 Each database
0bc0: 63 6f 6e 6e 65 63 74 69 6f 6e 20 63 61 6e 20 61 connection can a
0bd0: 6c 77 61 79 73 20 74 75 72 6e 0a 20 20 65 6e 66 lways turn. enf
0be0: 6f 72 63 65 6d 65 6e 74 20 6f 66 20 66 6f 72 65 orcement of fore
0bf0: 69 67 6e 20 6b 65 79 20 63 6f 6e 73 74 72 61 69 ign key constrai
0c00: 6e 74 73 20 6f 6e 20 61 6e 64 20 6f 66 66 20 61 nts on and off a
0c10: 6e 64 20 72 75 6e 2d 74 69 6d 65 20 75 73 69 6e nd run-time usin
0c20: 67 0a 20 20 74 68 65 20 5b 66 6f 72 65 69 67 6e g. the [foreign
0c30: 5f 6b 65 79 73 20 70 72 61 67 6d 61 5d 2e 20 20 _keys pragma].
0c40: 45 6e 66 6f 72 63 65 6d 65 6e 74 20 6f 66 20 66 Enforcement of f
0c50: 6f 72 65 69 67 6e 20 6b 65 79 20 63 6f 6e 73 74 oreign key const
0c60: 72 61 69 6e 74 73 0a 20 20 69 73 20 6e 6f 72 6d raints. is norm
0c70: 61 6c 6c 79 20 6f 66 66 20 62 79 20 64 65 66 61 ally off by defa
0c80: 75 6c 74 2c 20 62 75 74 20 69 66 20 74 68 69 73 ult, but if this
0c90: 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 70 61 compile-time pa
0ca0: 72 61 6d 65 74 65 72 20 69 73 0a 20 20 73 65 74 rameter is. set
0cb0: 20 74 6f 20 31 2c 20 65 6e 66 6f 72 63 65 6d 65 to 1, enforceme
0cc0: 6e 74 20 6f 66 20 66 6f 72 65 69 67 6e 20 6b 65 nt of foreign ke
0cd0: 79 20 63 6f 6e 73 74 72 61 69 6e 74 73 20 77 69 y constraints wi
0ce0: 6c 6c 20 62 65 20 6f 6e 20 62 79 20 64 65 66 61 ll be on by defa
0cf0: 75 6c 74 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f ult..}..COMPILE_
0d00: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 OPTION {SQLITE_D
0d10: 45 46 41 55 4c 54 5f 4a 4f 55 52 4e 41 4c 5f 53 EFAULT_JOURNAL_S
0d20: 49 5a 45 5f 4c 49 4d 49 54 3d 3c 69 3e 26 6c 74 IZE_LIMIT=<i><
0d30: 3b 62 79 74 65 73 26 67 74 3b 3c 2f 69 3e 7d 20 ;bytes></i>}
0d40: 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 {. This option
0d50: 73 65 74 73 20 74 68 65 20 73 69 7a 65 20 6c 69 sets the size li
0d60: 6d 69 74 20 6f 6e 20 72 6f 6c 6c 62 61 63 6b 20 mit on rollback
0d70: 6a 6f 75 72 6e 61 6c 20 66 69 6c 65 73 20 69 6e journal files in
0d80: 0a 20 20 5b 6a 6f 75 72 6e 61 6c 5f 6d 6f 64 65 . [journal_mode
0d90: 20 70 72 61 67 6d 61 20 7c 20 70 65 72 73 69 73 pragma | persis
0da0: 74 65 6e 74 20 6a 6f 75 72 6e 61 6c 20 6d 6f 64 tent journal mod
0db0: 65 5d 2e 20 20 57 68 65 6e 20 74 68 69 73 20 0a e]. When this .
0dc0: 20 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f compile-time o
0dd0: 70 74 69 6f 6e 20 69 73 20 6f 6d 69 74 74 65 64 ption is omitted
0de0: 20 74 68 65 72 65 20 69 73 20 6e 6f 20 75 70 70 there is no upp
0df0: 65 72 20 62 6f 75 6e 64 20 6f 6e 20 74 68 65 0a er bound on the.
0e00: 20 20 73 69 7a 65 20 6f 66 20 74 68 65 20 72 6f size of the ro
0e10: 6c 6c 62 61 63 6b 20 6a 6f 75 72 6e 61 6c 20 66 llback journal f
0e20: 69 6c 65 2e 20 20 54 68 65 20 6a 6f 75 72 6e 61 ile. The journa
0e30: 6c 20 66 69 6c 65 20 73 69 7a 65 20 6c 69 6d 69 l file size limi
0e40: 74 0a 20 20 63 61 6e 20 62 65 20 63 68 61 6e 67 t. can be chang
0e50: 65 64 20 61 74 20 72 75 6e 2d 74 69 6d 65 20 75 ed at run-time u
0e60: 73 69 6e 67 20 74 68 65 20 5b 6a 6f 75 72 6e 61 sing the [journa
0e70: 6c 5f 73 69 7a 65 5f 6c 69 6d 69 74 20 70 72 61 l_size_limit pra
0e80: 67 6d 61 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 gma]..}..COMPILE
0e90: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
0ea0: 44 45 46 41 55 4c 54 5f 4d 45 4d 53 54 41 54 55 DEFAULT_MEMSTATU
0eb0: 53 3d 3c 69 3e 26 6c 74 3b 31 20 6f 72 20 30 26 S=<i><1 or 0&
0ec0: 67 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 69 gt;</i>} {. Thi
0ed0: 73 20 6d 61 63 72 6f 20 69 73 20 75 73 65 64 20 s macro is used
0ee0: 74 6f 20 64 65 74 65 72 6d 69 6e 65 20 77 68 65 to determine whe
0ef0: 74 68 65 72 20 6f 72 20 6e 6f 74 20 74 68 65 20 ther or not the
0f00: 66 65 61 74 75 72 65 73 20 65 6e 61 62 6c 65 64 features enabled
0f10: 20 61 6e 64 0a 20 20 64 69 73 61 62 6c 65 64 20 and. disabled
0f20: 75 73 69 6e 67 20 74 68 65 20 53 51 4c 49 54 45 using the SQLITE
0f30: 5f 43 4f 4e 46 49 47 5f 4d 45 4d 53 54 41 54 55 _CONFIG_MEMSTATU
0f40: 53 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 5b 73 S argument to [s
0f50: 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d qlite3_config()]
0f60: 0a 20 20 61 72 65 20 61 76 61 69 6c 61 62 6c 65 . are available
0f70: 20 62 79 20 64 65 66 61 75 6c 74 2e 20 54 68 65 by default. The
0f80: 20 64 65 66 61 75 6c 74 20 76 61 6c 75 65 20 69 default value i
0f90: 73 20 31 20 28 5b 53 51 4c 49 54 45 5f 43 4f 4e s 1 ([SQLITE_CON
0fa0: 46 49 47 5f 4d 45 4d 53 54 41 54 55 53 5d 0a 20 FIG_MEMSTATUS].
0fb0: 20 72 65 6c 61 74 65 64 20 66 65 61 74 75 72 65 related feature
0fc0: 73 20 65 6e 61 62 6c 65 64 29 2e 0a 7d 0a 0a 43 s enabled)..}..C
0fd0: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
0fe0: 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f 50 41 QLITE_DEFAULT_PA
0ff0: 47 45 5f 53 49 5a 45 3d 3c 69 3e 26 6c 74 3b 62 GE_SIZE=<i><b
1000: 79 74 65 73 26 67 74 3b 3c 2f 69 3e 7d 20 7b 0a ytes></i>} {.
1010: 20 20 54 68 69 73 20 6d 61 63 72 6f 20 69 73 20 This macro is
1020: 75 73 65 64 20 74 6f 20 73 65 74 20 74 68 65 20 used to set the
1030: 64 65 66 61 75 6c 74 20 70 61 67 65 2d 73 69 7a default page-siz
1040: 65 20 75 73 65 64 20 77 68 65 6e 20 61 0a 20 20 e used when a.
1050: 64 61 74 61 62 61 73 65 20 69 73 20 63 72 65 61 database is crea
1060: 74 65 64 2e 20 54 68 65 20 76 61 6c 75 65 20 61 ted. The value a
1070: 73 73 69 67 6e 65 64 20 6d 75 73 74 20 62 65 20 ssigned must be
1080: 61 20 70 6f 77 65 72 20 6f 66 20 32 2e 20 54 68 a power of 2. Th
1090: 65 0a 20 20 64 65 66 61 75 6c 74 20 76 61 6c 75 e. default valu
10a0: 65 20 69 73 20 31 30 32 34 2e 20 54 68 65 20 63 e is 1024. The c
10b0: 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 64 65 66 61 ompile-time defa
10c0: 75 6c 74 20 6d 61 79 20 62 65 20 6f 76 65 72 72 ult may be overr
10d0: 69 64 64 65 6e 20 61 74 20 0a 20 20 72 75 6e 74 idden at . runt
10e0: 69 6d 65 20 62 79 20 74 68 65 20 5b 50 52 41 47 ime by the [PRAG
10f0: 4d 41 20 70 61 67 65 5f 73 69 7a 65 5d 20 63 6f MA page_size] co
1100: 6d 6d 61 6e 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c mmand..}..COMPIL
1110: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
1120: 5f 44 45 46 41 55 4c 54 5f 54 45 4d 50 5f 43 41 _DEFAULT_TEMP_CA
1130: 43 48 45 5f 53 49 5a 45 3d 3c 69 3e 26 6c 74 3b CHE_SIZE=<i><
1140: 70 61 67 65 73 26 67 74 3b 3c 2f 69 3e 7d 20 7b pages></i>} {
1150: 0a 20 20 54 68 69 73 20 6d 61 63 72 6f 20 73 65 . This macro se
1160: 74 73 20 74 68 65 20 64 65 66 61 75 6c 74 20 73 ts the default s
1170: 69 7a 65 20 6f 66 20 74 68 65 20 70 61 67 65 2d ize of the page-
1180: 63 61 63 68 65 20 66 6f 72 20 74 65 6d 70 6f 72 cache for tempor
1190: 61 72 79 20 66 69 6c 65 73 0a 20 20 63 72 65 61 ary files. crea
11a0: 74 65 64 20 62 79 20 53 51 4c 69 74 65 20 74 6f ted by SQLite to
11b0: 20 73 74 6f 72 65 20 69 6e 74 65 72 6d 65 64 69 store intermedi
11c0: 61 74 65 20 72 65 73 75 6c 74 73 2c 20 69 6e 20 ate results, in
11d0: 70 61 67 65 73 2e 20 49 74 20 64 6f 65 73 0a 20 pages. It does.
11e0: 20 6e 6f 74 20 61 66 66 65 63 74 20 74 68 65 20 not affect the
11f0: 70 61 67 65 2d 63 61 63 68 65 20 66 6f 72 20 74 page-cache for t
1200: 68 65 20 74 65 6d 70 20 64 61 74 61 62 61 73 65 he temp database
1210: 2c 20 77 68 65 72 65 20 74 61 62 6c 65 73 20 63 , where tables c
1220: 72 65 61 74 65 64 0a 20 20 75 73 69 6e 67 20 5b reated. using [
1230: 43 52 45 41 54 45 20 54 41 42 4c 45 20 7c 20 43 CREATE TABLE | C
1240: 52 45 41 54 45 20 54 45 4d 50 20 54 41 42 4c 45 REATE TEMP TABLE
1250: 5d 20 61 72 65 20 73 74 6f 72 65 64 2e 20 54 68 ] are stored. Th
1260: 65 20 64 65 66 61 75 6c 74 20 76 61 6c 75 65 0a e default value.
1270: 20 20 69 73 20 35 30 30 2e 0a 7d 0a 0a 43 4f 4d is 500..}..COM
1280: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c PILE_OPTION {SQL
1290: 49 54 45 5f 44 45 46 41 55 4c 54 5f 57 41 4c 5f ITE_DEFAULT_WAL_
12a0: 41 55 54 4f 43 48 45 43 4b 50 4f 49 4e 54 3d 3c AUTOCHECKPOINT=<
12b0: 69 3e 26 6c 74 3b 70 61 67 65 73 26 67 74 3b 3c i><pages><
12c0: 2f 69 3e 7d 20 7b 0a 20 20 54 68 69 73 20 6d 61 /i>} {. This ma
12d0: 63 72 6f 20 73 65 74 73 20 74 68 65 20 64 65 66 cro sets the def
12e0: 61 75 6c 74 20 70 61 67 65 20 63 6f 75 6e 74 20 ault page count
12f0: 66 6f 72 20 74 68 65 20 5b 57 41 4c 5d 0a 20 20 for the [WAL].
1300: 5b 63 68 65 63 6b 70 6f 69 6e 74 69 6e 67 20 7c [checkpointing |
1310: 20 61 75 74 6f 6d 61 74 69 63 20 63 68 65 63 6b automatic check
1320: 70 6f 69 6e 74 69 6e 67 5d 20 66 65 61 74 75 72 pointing] featur
1330: 65 2e 20 20 49 66 20 75 6e 73 70 65 63 69 66 69 e. If unspecifi
1340: 65 64 2c 0a 20 20 74 68 65 20 64 65 66 61 75 6c ed,. the defaul
1350: 74 20 70 61 67 65 20 63 6f 75 6e 74 20 69 73 20 t page count is
1360: 31 30 30 30 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 1000..}..COMPILE
1370: 5f 4f 50 54 49 4f 4e 20 7b 59 59 53 54 41 43 4b _OPTION {YYSTACK
1380: 44 45 50 54 48 3d 3c 69 3e 26 6c 74 3b 6d 61 78 DEPTH=<i><max
1390: 5f 64 65 70 74 68 26 67 74 3b 3c 2f 69 3e 7d 20 _depth></i>}
13a0: 7b 0a 20 20 54 68 69 73 20 6d 61 63 72 6f 20 73 {. This macro s
13b0: 65 74 73 20 74 68 65 20 6d 61 78 69 6d 75 6d 20 ets the maximum
13c0: 64 65 70 74 68 20 6f 66 20 74 68 65 20 4c 41 4c depth of the LAL
13d0: 52 28 31 29 20 73 74 61 63 6b 20 75 73 65 64 20 R(1) stack used
13e0: 62 79 0a 20 20 74 68 65 20 53 51 4c 20 70 61 72 by. the SQL par
13f0: 73 65 72 20 77 69 74 68 69 6e 20 53 51 4c 69 74 ser within SQLit
1400: 65 2e 20 20 54 68 65 20 64 65 66 61 75 6c 74 20 e. The default
1410: 76 61 6c 75 65 20 69 73 20 31 30 30 2e 20 20 41 value is 100. A
1420: 20 74 79 70 69 63 61 6c 0a 20 20 61 70 70 6c 69 typical. appli
1430: 63 61 74 69 6f 6e 20 77 69 6c 6c 20 75 73 65 20 cation will use
1440: 6c 65 73 73 20 74 68 61 6e 20 61 62 6f 75 74 20 less than about
1450: 32 30 20 6c 65 76 65 6c 73 20 6f 66 20 74 68 65 20 levels of the
1460: 20 73 74 61 63 6b 2e 0a 20 20 44 65 76 65 6c 6f stack.. Develo
1470: 70 65 72 73 20 77 68 6f 73 65 20 61 70 70 6c 69 pers whose appli
1480: 63 61 74 69 6f 6e 73 20 63 6f 6e 74 61 69 6e 20 cations contain
1490: 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 20 74 SQL statements t
14a0: 68 61 74 20 0a 20 20 6e 65 65 64 20 6d 6f 72 65 hat . need more
14b0: 20 74 68 61 6e 20 31 30 30 20 4c 41 4c 52 28 31 than 100 LALR(1
14c0: 29 20 73 74 61 63 6b 20 65 6e 74 72 69 65 73 20 ) stack entries
14d0: 73 68 6f 75 6c 64 20 73 65 72 69 6f 75 73 6c 79 should seriously
14e0: 0a 20 20 63 6f 6e 73 69 64 65 72 20 72 65 66 61 . consider refa
14f0: 63 74 6f 72 69 6e 67 20 74 68 65 69 72 20 53 51 ctoring their SQ
1500: 4c 20 61 73 20 69 74 20 69 73 20 6c 69 6b 65 6c L as it is likel
1510: 79 20 74 6f 20 62 65 20 77 65 6c 6c 20 62 65 79 y to be well bey
1520: 6f 6e 64 0a 20 20 74 68 65 20 61 62 69 6c 69 74 ond. the abilit
1530: 79 20 6f 66 20 61 6e 79 20 68 75 6d 61 6e 20 74 y of any human t
1540: 6f 20 63 6f 6d 70 72 65 68 65 6e 64 2e 0a 7d 0a o comprehend..}.
1550: 3c 2f 74 63 6c 3e 0a 0a 3c 68 32 3e 31 2e 32 20 </tcl>..<h2>1.2
1560: 4f 70 74 69 6f 6e 73 20 54 6f 20 53 65 74 20 53 Options To Set S
1570: 69 7a 65 20 4c 69 6d 69 74 73 3c 2f 68 32 3e 0a ize Limits</h2>.
1580: 0a 3c 70 3e 54 68 65 72 65 20 61 72 65 20 63 6f .<p>There are co
1590: 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f mpile-time optio
15a0: 6e 73 20 74 68 61 74 20 77 69 6c 6c 20 73 65 74 ns that will set
15b0: 20 75 70 70 65 72 20 62 6f 75 6e 64 73 0a 6f 6e upper bounds.on
15c0: 20 74 68 65 20 73 69 7a 65 73 20 6f 66 20 76 61 the sizes of va
15d0: 72 69 6f 75 73 20 73 74 72 75 63 74 75 72 65 73 rious structures
15e0: 20 69 6e 20 53 51 4c 69 74 65 2e 20 20 54 68 65 in SQLite. The
15f0: 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 0a 6f 70 compile-time.op
1600: 74 69 6f 6e 73 20 6e 6f 72 6d 61 6c 6c 79 20 73 tions normally s
1610: 65 74 20 61 20 68 61 72 64 20 75 70 70 65 72 20 et a hard upper
1620: 62 6f 75 6e 64 20 74 68 61 74 20 63 61 6e 20 62 bound that can b
1630: 65 20 63 68 61 6e 67 65 64 0a 61 74 20 72 75 6e e changed.at run
1640: 2d 74 69 6d 65 20 6f 6e 20 69 6e 64 69 76 69 64 -time on individ
1650: 75 61 6c 20 5b 64 61 74 61 62 61 73 65 20 63 6f ual [database co
1660: 6e 6e 65 63 74 69 6f 6e 73 5d 20 75 73 69 6e 67 nnections] using
1670: 20 74 68 65 0a 5b 73 71 6c 69 74 65 33 5f 6c 69 the.[sqlite3_li
1680: 6d 69 74 28 29 5d 20 69 6e 74 65 72 66 61 63 65 mit()] interface
1690: 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 63 6f .</p>..<p>The co
16a0: 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f mpile-time optio
16b0: 6e 73 20 66 6f 72 20 73 65 74 74 69 6e 67 20 75 ns for setting u
16c0: 70 70 65 72 20 62 6f 75 6e 64 73 20 61 72 65 0a pper bounds are.
16d0: 5b 6c 69 6d 69 74 73 20 7c 20 64 6f 63 75 6d 65 [limits | docume
16e0: 6e 74 65 64 20 73 65 70 61 72 61 74 65 6c 79 5d nted separately]
16f0: 2e 20 20 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 . The following
1700: 20 69 73 20 61 20 6c 69 73 74 20 6f 66 0a 74 68 is a list of.th
1710: 65 20 61 76 61 69 6c 61 62 6c 65 20 73 65 74 74 e available sett
1720: 69 6e 67 73 3a 3c 2f 70 3e 0a 0a 3c 75 6c 3e 0a ings:</p>..<ul>.
1730: 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4d 41 58 <li> [SQLITE_MAX
1740: 5f 41 54 54 41 43 48 45 44 5d 20 20 3c 2f 6c 69 _ATTACHED] </li
1750: 3e 0a 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4d >.<li> [SQLITE_M
1760: 41 58 5f 43 4f 4c 55 4d 4e 5d 20 20 3c 2f 6c 69 AX_COLUMN] </li
1770: 3e 0a 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4d >.<li> [SQLITE_M
1780: 41 58 5f 43 4f 4d 50 4f 55 4e 44 5f 53 45 4c 45 AX_COMPOUND_SELE
1790: 43 54 5d 20 20 3c 2f 6c 69 3e 0a 3c 6c 69 3e 20 CT] </li>.<li>
17a0: 5b 53 51 4c 49 54 45 5f 4d 41 58 5f 45 58 50 52 [SQLITE_MAX_EXPR
17b0: 5f 44 45 50 54 48 5d 20 20 3c 2f 6c 69 3e 0a 3c _DEPTH] </li>.<
17c0: 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4d 41 58 5f li> [SQLITE_MAX_
17d0: 46 55 4e 43 54 49 4f 4e 5f 41 52 47 5d 20 20 3c FUNCTION_ARG] <
17e0: 2f 6c 69 3e 0a 3c 6c 69 3e 20 5b 53 51 4c 49 54 /li>.<li> [SQLIT
17f0: 45 5f 4d 41 58 5f 4c 45 4e 47 54 48 5d 20 20 3c E_MAX_LENGTH] <
1800: 2f 6c 69 3e 0a 3c 6c 69 3e 20 5b 53 51 4c 49 54 /li>.<li> [SQLIT
1810: 45 5f 4d 41 58 5f 4c 49 4b 45 5f 50 41 54 54 45 E_MAX_LIKE_PATTE
1820: 52 4e 5f 4c 45 4e 47 54 48 5d 20 20 3c 2f 6c 69 RN_LENGTH] </li
1830: 3e 0a 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4d >.<li> [SQLITE_M
1840: 41 58 5f 50 41 47 45 5f 43 4f 55 4e 54 5d 20 20 AX_PAGE_COUNT]
1850: 3c 2f 6c 69 3e 0a 3c 6c 69 3e 20 5b 53 51 4c 49 </li>.<li> [SQLI
1860: 54 45 5f 4d 41 58 5f 53 51 4c 5f 4c 45 4e 47 54 TE_MAX_SQL_LENGT
1870: 48 5d 20 20 3c 2f 6c 69 3e 0a 3c 6c 69 3e 20 5b H] </li>.<li> [
1880: 53 51 4c 49 54 45 5f 4d 41 58 5f 56 41 52 49 41 SQLITE_MAX_VARIA
1890: 42 4c 45 5f 4e 55 4d 42 45 52 5d 20 20 3c 2f 6c BLE_NUMBER] </l
18a0: 69 3e 0a 3c 2f 75 6c 3e 0a 0a 3c 61 20 6e 61 6d i>.</ul>..<a nam
18b0: 65 3d 22 63 6f 6e 74 72 6f 6c 66 65 61 74 75 72 e="controlfeatur
18c0: 65 73 22 3e 3c 2f 61 3e 0a 3c 68 32 3e 31 2e 33 es"></a>.<h2>1.3
18d0: 20 4f 70 74 69 6f 6e 73 20 54 6f 20 43 6f 6e 74 Options To Cont
18e0: 72 6f 6c 20 4f 70 65 72 61 74 69 6e 67 20 43 68 rol Operating Ch
18f0: 61 72 61 63 74 65 72 69 73 74 69 63 73 3c 2f 68 aracteristics</h
1900: 32 3e 0a 0a 3c 74 63 6c 3e 0a 43 4f 4d 50 49 4c 2>..<tcl>.COMPIL
1910: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
1920: 5f 34 5f 42 59 54 45 5f 41 4c 49 47 4e 45 44 5f _4_BYTE_ALIGNED_
1930: 4d 41 4c 4c 4f 43 7d 20 7b 0a 20 20 4f 6e 20 6d MALLOC} {. On m
1940: 6f 73 74 20 73 79 73 74 65 6d 73 2c 20 74 68 65 ost systems, the
1950: 20 6d 61 6c 6c 6f 63 28 29 20 73 79 73 74 65 6d malloc() system
1960: 20 63 61 6c 6c 20 72 65 74 75 72 6e 73 20 61 20 call returns a
1970: 62 75 66 66 65 72 20 74 68 61 74 20 69 73 0a 20 buffer that is.
1980: 20 61 6c 69 67 6e 65 64 20 74 6f 20 61 6e 20 38 aligned to an 8
1990: 2d 62 79 74 65 20 62 6f 75 6e 64 61 72 79 2e 20 -byte boundary.
19a0: 20 42 75 74 20 6f 6e 20 73 6f 6d 65 20 73 79 73 But on some sys
19b0: 74 65 6d 73 20 28 65 78 3a 20 77 69 6e 64 6f 77 tems (ex: window
19c0: 73 29 20 6d 61 6c 6c 6f 63 28 29 0a 20 20 72 65 s) malloc(). re
19d0: 74 75 72 6e 73 20 34 2d 62 79 74 65 20 61 6c 69 turns 4-byte ali
19e0: 67 6e 65 64 20 70 6f 69 6e 74 65 72 2e 20 20 54 gned pointer. T
19f0: 68 69 73 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 his compile-time
1a00: 20 6f 70 74 69 6f 6e 20 6d 75 73 74 20 62 65 20 option must be
1a10: 75 73 65 64 0a 20 20 6f 6e 20 73 79 73 74 65 6d used. on system
1a20: 73 20 74 68 61 74 20 72 65 74 75 72 6e 20 34 2d s that return 4-
1a30: 62 79 74 65 20 61 6c 69 67 6e 65 64 20 70 6f 69 byte aligned poi
1a40: 6e 74 65 72 73 20 66 72 6f 6d 20 6d 61 6c 6c 6f nters from mallo
1a50: 63 28 29 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f c()..}..COMPILE_
1a60: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 43 OPTION {SQLITE_C
1a70: 41 53 45 5f 53 45 4e 53 49 54 49 56 45 5f 4c 49 ASE_SENSITIVE_LI
1a80: 4b 45 7d 20 7b 0a 20 20 49 66 20 74 68 69 73 20 KE} {. If this
1a90: 6f 70 74 69 6f 6e 20 69 73 20 70 72 65 73 65 6e option is presen
1aa0: 74 2c 20 74 68 65 6e 20 74 68 65 20 62 75 69 6c t, then the buil
1ab0: 74 2d 69 6e 20 5b 4c 49 4b 45 5d 20 6f 70 65 72 t-in [LIKE] oper
1ac0: 61 74 6f 72 20 77 69 6c 6c 20 62 65 0a 20 20 63 ator will be. c
1ad0: 61 73 65 20 73 65 6e 73 69 74 69 76 65 2e 20 20 ase sensitive.
1ae0: 54 68 69 73 20 73 61 6d 65 20 65 66 66 65 63 74 This same effect
1af0: 20 63 61 6e 20 62 65 20 61 63 68 69 65 76 65 64 can be achieved
1b00: 20 61 74 20 72 75 6e 2d 74 69 6d 65 20 75 73 69 at run-time usi
1b10: 6e 67 0a 20 20 74 68 65 20 5b 63 61 73 65 5f 73 ng. the [case_s
1b20: 65 6e 73 69 74 69 76 65 5f 6c 69 6b 65 20 70 72 ensitive_like pr
1b30: 61 67 6d 61 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c agma]..}..COMPIL
1b40: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
1b50: 5f 48 41 56 45 5f 49 53 4e 41 4e 7d 20 7b 0a 20 _HAVE_ISNAN} {.
1b60: 20 49 66 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 If this option
1b70: 69 73 20 70 72 65 73 65 6e 74 2c 20 74 68 65 6e is present, then
1b80: 20 53 51 4c 69 74 65 20 77 69 6c 6c 20 75 73 65 SQLite will use
1b90: 20 74 68 65 20 69 73 6e 61 6e 28 29 20 66 75 6e the isnan() fun
1ba0: 63 74 69 6f 6e 20 66 72 6f 6d 0a 20 20 74 68 65 ction from. the
1bb0: 20 73 79 73 74 65 6d 20 6d 61 74 68 20 6c 69 62 system math lib
1bc0: 72 61 72 79 2e 20 20 57 69 74 68 6f 75 74 20 74 rary. Without t
1bd0: 68 69 73 20 6f 70 74 69 6f 6e 20 28 74 68 65 20 his option (the
1be0: 64 65 66 61 75 6c 74 20 62 65 68 61 76 69 6f 72 default behavior
1bf0: 29 0a 20 20 53 51 4c 69 74 65 20 75 73 65 73 20 ). SQLite uses
1c00: 69 74 73 20 6f 77 6e 20 69 6e 74 65 72 6e 61 6c its own internal
1c10: 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 implementation
1c20: 6f 66 20 69 73 6e 61 6e 28 29 2e 20 20 53 51 4c of isnan(). SQL
1c30: 69 74 65 20 75 73 65 73 0a 20 20 69 74 73 20 6f ite uses. its o
1c40: 77 6e 20 69 6e 74 65 72 6e 61 6c 20 69 73 6e 61 wn internal isna
1c50: 6e 28 29 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 n() implementati
1c60: 6f 6e 20 62 79 20 64 65 66 61 75 6c 74 20 62 65 on by default be
1c70: 63 61 75 73 65 20 6f 66 20 70 61 73 74 0a 20 20 cause of past.
1c80: 70 72 6f 62 6c 65 6d 73 20 77 69 74 68 20 73 79 problems with sy
1c90: 73 74 65 6d 20 69 73 6e 61 6e 28 29 20 66 75 6e stem isnan() fun
1ca0: 63 74 69 6f 6e 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 ctions..}..COMPI
1cb0: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
1cc0: 45 5f 4f 53 5f 4f 54 48 45 52 3d 3c 69 3e 26 6c E_OS_OTHER=<i>&l
1cd0: 74 3b 30 20 6f 72 20 31 26 67 74 3b 3c 2f 69 3e t;0 or 1></i>
1ce0: 7d 20 7b 0a 20 20 54 68 65 20 6f 70 74 69 6f 6e } {. The option
1cf0: 20 63 61 75 73 65 73 20 53 51 4c 69 74 65 20 74 causes SQLite t
1d00: 6f 20 6f 6d 69 74 20 69 74 73 20 62 75 69 6c 74 o omit its built
1d10: 2d 69 6e 20 6f 70 65 72 61 74 69 6e 67 20 73 79 -in operating sy
1d20: 73 74 65 6d 20 69 6e 74 65 72 66 61 63 65 73 0a stem interfaces.
1d30: 20 20 66 6f 72 20 55 6e 69 78 2c 20 57 69 6e 64 for Unix, Wind
1d40: 6f 77 73 2c 20 61 6e 64 20 4f 53 2f 32 2e 20 20 ows, and OS/2.
1d50: 54 68 65 20 72 65 73 75 6c 74 69 6e 67 20 6c 69 The resulting li
1d60: 62 72 61 72 79 20 77 69 6c 6c 20 68 61 76 65 20 brary will have
1d70: 6e 6f 20 64 65 66 61 75 6c 74 0a 20 20 5b 73 71 no default. [sq
1d80: 6c 69 74 65 33 5f 76 66 73 20 7c 20 6f 70 65 72 lite3_vfs | oper
1d90: 61 74 69 6e 67 20 73 79 73 74 65 6d 20 69 6e 74 ating system int
1da0: 65 72 66 61 63 65 5d 2e 20 20 41 70 70 6c 69 63 erface]. Applic
1db0: 61 74 69 6f 6e 73 20 6d 75 73 74 20 75 73 65 0a ations must use.
1dc0: 20 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5f 72 [sqlite3_vfs_r
1dd0: 65 67 69 73 74 65 72 28 29 5d 20 74 6f 20 72 65 egister()] to re
1de0: 67 69 73 74 65 72 20 61 6e 20 61 70 70 72 6f 70 gister an approp
1df0: 72 69 61 74 65 20 69 6e 74 65 72 66 61 63 65 20 riate interface
1e00: 62 65 66 6f 72 65 0a 20 20 75 73 69 6e 67 20 53 before. using S
1e10: 51 4c 69 74 65 2e 20 20 41 70 70 6c 69 63 61 74 QLite. Applicat
1e20: 69 6f 6e 73 20 6d 75 73 74 20 61 6c 73 6f 20 73 ions must also s
1e30: 75 70 70 6c 79 20 69 6d 70 6c 65 6d 65 6e 74 61 upply implementa
1e40: 74 69 6f 6e 73 20 66 6f 72 20 74 68 65 0a 20 20 tions for the.
1e50: 5b 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e 69 74 [sqlite3_os_init
1e60: 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 ()] and [sqlite3
1e70: 5f 6f 73 5f 65 6e 64 28 29 5d 20 69 6e 74 65 72 _os_end()] inter
1e80: 66 61 63 65 73 2e 20 20 54 68 65 20 75 73 75 61 faces. The usua
1e90: 6c 20 70 72 61 63 74 69 63 65 0a 20 20 69 73 20 l practice. is
1ea0: 66 6f 72 20 74 68 65 20 73 75 70 70 6c 69 65 64 for the supplied
1eb0: 20 5b 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e 69 [sqlite3_os_ini
1ec0: 74 28 29 5d 20 74 6f 20 69 6e 76 6f 6b 65 20 5b t()] to invoke [
1ed0: 73 71 6c 69 74 65 33 5f 76 66 73 5f 72 65 67 69 sqlite3_vfs_regi
1ee0: 73 74 65 72 28 29 5d 2e 0a 20 20 53 51 4c 69 74 ster()].. SQLit
1ef0: 65 20 77 69 6c 6c 20 61 75 74 6f 6d 61 74 69 63 e will automatic
1f00: 61 6c 6c 79 20 69 6e 76 6f 6b 65 20 5b 73 71 6c ally invoke [sql
1f10: 69 74 65 33 5f 6f 73 5f 69 6e 69 74 28 29 5d 20 ite3_os_init()]
1f20: 77 68 65 6e 20 69 74 20 69 6e 69 74 69 61 6c 69 when it initiali
1f30: 7a 65 73 2e 0a 0a 20 20 54 68 69 73 20 6f 70 74 zes... This opt
1f40: 69 6f 6e 20 69 73 20 74 79 70 69 63 61 6c 6c 79 ion is typically
1f50: 20 75 73 65 64 20 77 68 65 6e 20 62 75 69 6c 64 used when build
1f60: 69 6e 67 20 53 51 4c 69 74 65 20 66 6f 72 20 61 ing SQLite for a
1f70: 6e 20 65 6d 62 65 64 64 65 64 0a 20 20 70 6c 61 n embedded. pla
1f80: 74 66 6f 72 6d 20 77 69 74 68 20 61 20 63 75 73 tform with a cus
1f90: 74 6f 6d 20 6f 70 65 72 61 74 69 6e 67 20 73 79 tom operating sy
1fa0: 73 74 65 6d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 stem..}..COMPILE
1fb0: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
1fc0: 53 45 43 55 52 45 5f 44 45 4c 45 54 45 7d 20 7b SECURE_DELETE} {
1fd0: 0a 20 20 54 68 69 73 20 63 6f 6d 70 69 6c 65 2d . This compile-
1fe0: 74 69 6d 65 20 6f 70 74 69 6f 6e 20 63 68 61 6e time option chan
1ff0: 67 65 73 20 74 68 65 20 64 65 66 61 75 6c 74 20 ges the default
2000: 73 65 74 74 69 6e 67 20 6f 66 20 74 68 65 0a 20 setting of the.
2010: 20 5b 73 65 63 75 72 65 5f 64 65 6c 65 74 65 20 [secure_delete
2020: 70 72 61 67 6d 61 5d 2e 20 20 57 68 65 6e 20 74 pragma]. When t
2030: 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 6e 6f his option is no
2040: 74 20 75 73 65 64 2c 20 73 65 63 75 72 65 5f 64 t used, secure_d
2050: 65 6c 65 74 65 20 64 65 66 61 75 6c 74 73 0a 20 elete defaults.
2060: 20 74 6f 20 6f 66 66 2e 20 20 57 68 65 6e 20 74 to off. When t
2070: 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 70 72 his option is pr
2080: 65 73 65 6e 74 2c 20 73 65 63 75 72 65 5f 64 65 esent, secure_de
2090: 6c 65 74 65 20 64 65 66 61 75 6c 74 73 20 74 6f lete defaults to
20a0: 20 6f 6e 2e 0a 0a 20 20 54 68 65 20 73 65 63 75 on... The secu
20b0: 72 65 5f 64 65 6c 65 74 65 20 73 65 74 74 69 6e re_delete settin
20c0: 67 20 63 61 75 73 65 73 20 64 65 6c 65 74 65 64 g causes deleted
20d0: 20 63 6f 6e 74 65 6e 74 20 74 6f 20 62 65 20 6f content to be o
20e0: 76 65 72 77 72 69 74 74 65 6e 20 77 69 74 68 0a verwritten with.
20f0: 20 20 7a 65 72 6f 73 2e 20 20 54 68 65 72 65 20 zeros. There
2100: 69 73 20 61 20 73 6d 61 6c 6c 20 70 65 72 66 6f is a small perfo
2110: 72 6d 61 6e 63 65 20 70 65 6e 61 6c 74 79 20 66 rmance penalty f
2120: 6f 72 20 74 68 69 73 20 73 69 6e 63 65 20 61 64 or this since ad
2130: 64 69 74 69 6f 6e 61 6c 20 49 2f 4f 0a 20 20 6d ditional I/O. m
2140: 75 73 74 20 6f 63 63 75 72 2e 20 20 4f 6e 20 74 ust occur. On t
2150: 68 65 20 6f 74 68 65 72 20 68 61 6e 64 2c 20 73 he other hand, s
2160: 65 63 75 72 65 5f 64 65 6c 65 74 65 20 63 61 6e ecure_delete can
2170: 20 70 72 65 76 65 6e 74 20 73 65 6e 73 69 74 69 prevent sensiti
2180: 76 65 20 0a 20 20 69 6e 66 6f 72 6d 61 74 69 6f ve . informatio
2190: 6e 20 66 72 6f 6d 20 6c 69 6e 67 65 72 69 6e 67 n from lingering
21a0: 20 69 6e 20 75 6e 75 73 65 64 20 70 61 72 74 73 in unused parts
21b0: 20 6f 66 20 74 68 65 20 64 61 74 61 62 61 73 65 of the database
21c0: 20 66 69 6c 65 20 61 66 74 65 72 20 69 74 0a 20 file after it.
21d0: 20 68 61 73 20 61 6c 6c 65 67 65 64 6c 79 20 62 has allegedly b
21e0: 65 65 6e 20 64 65 6c 65 74 65 64 2e 20 20 53 65 een deleted. Se
21f0: 65 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 e the documentat
2200: 69 6f 6e 20 6f 6e 20 74 68 65 0a 20 20 5b 73 65 ion on the. [se
2210: 63 75 72 65 5f 64 65 6c 65 74 65 20 70 72 61 67 cure_delete prag
2220: 6d 61 5d 20 66 6f 72 20 61 64 64 69 74 69 6f 6e ma] for addition
2230: 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 0a al information..
2240: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
2250: 4e 20 7b 53 51 4c 49 54 45 5f 54 48 52 45 41 44 N {SQLITE_THREAD
2260: 53 41 46 45 3d 3c 69 3e 26 6c 74 3b 30 20 6f 72 SAFE=<i><0 or
2270: 20 31 20 6f 72 20 32 26 67 74 3b 3c 2f 69 3e 7d 1 or 2></i>}
2280: 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e {. This option
2290: 20 63 6f 6e 74 72 6f 6c 73 20 77 68 65 74 68 65 controls whethe
22a0: 72 20 6f 72 20 6e 6f 74 20 63 6f 64 65 20 69 73 r or not code is
22b0: 20 69 6e 63 6c 75 64 65 64 20 69 6e 20 53 51 4c included in SQL
22c0: 69 74 65 20 74 6f 0a 20 20 65 6e 61 62 6c 65 20 ite to. enable
22d0: 69 74 20 74 6f 20 6f 70 65 72 61 74 65 20 73 61 it to operate sa
22e0: 66 65 6c 79 20 69 6e 20 61 20 6d 75 6c 74 69 74 fely in a multit
22f0: 68 72 65 61 64 65 64 20 65 6e 76 69 72 6f 6e 6d hreaded environm
2300: 65 6e 74 2e 20 20 54 68 65 0a 20 20 64 65 66 61 ent. The. defa
2310: 75 6c 74 20 69 73 20 53 51 4c 49 54 45 5f 54 48 ult is SQLITE_TH
2320: 52 45 41 44 53 41 46 45 3d 31 20 77 68 69 63 68 READSAFE=1 which
2330: 20 69 73 20 73 61 66 65 20 66 6f 72 20 75 73 65 is safe for use
2340: 20 69 6e 20 61 20 6d 75 6c 74 69 74 68 72 65 61 in a multithrea
2350: 64 65 64 0a 20 20 65 6e 76 69 72 6f 6e 6d 65 6e ded. environmen
2360: 74 2e 20 20 57 68 65 6e 20 63 6f 6d 70 69 6c 65 t. When compile
2370: 64 20 77 69 74 68 20 53 51 4c 49 54 45 5f 54 48 d with SQLITE_TH
2380: 52 45 41 44 53 41 46 45 3d 30 20 61 6c 6c 20 6d READSAFE=0 all m
2390: 75 74 65 78 69 6e 67 20 63 6f 64 65 0a 20 20 69 utexing code. i
23a0: 73 20 6f 6d 69 74 74 65 64 20 61 6e 64 20 69 74 s omitted and it
23b0: 20 69 73 20 75 6e 73 61 66 65 20 74 6f 20 75 73 is unsafe to us
23c0: 65 20 53 51 4c 69 74 65 20 69 6e 20 61 20 6d 75 e SQLite in a mu
23d0: 6c 74 69 74 68 72 65 61 64 65 64 20 70 72 6f 67 ltithreaded prog
23e0: 72 61 6d 2e 0a 20 20 57 68 65 6e 20 63 6f 6d 70 ram.. When comp
23f0: 69 6c 65 64 20 77 69 74 68 20 53 51 4c 49 54 45 iled with SQLITE
2400: 5f 54 48 52 45 41 44 53 41 46 45 3d 32 2c 20 53 _THREADSAFE=2, S
2410: 51 4c 69 74 65 20 63 61 6e 20 62 65 20 75 73 65 QLite can be use
2420: 64 20 69 6e 20 61 20 6d 75 6c 74 69 74 68 72 65 d in a multithre
2430: 61 64 65 64 0a 20 20 70 72 6f 67 72 61 6d 20 73 aded. program s
2440: 6f 20 6c 6f 6e 67 20 61 73 20 6e 6f 20 74 77 6f o long as no two
2450: 20 74 68 72 65 61 64 73 20 61 74 74 65 6d 70 74 threads attempt
2460: 20 74 6f 20 75 73 65 20 74 68 65 20 73 61 6d 65 to use the same
2470: 0a 20 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e . [database con
2480: 6e 65 63 74 69 6f 6e 5d 20 61 74 20 74 68 65 20 nection] at the
2490: 73 61 6d 65 20 74 69 6d 65 2e 0a 0a 20 20 54 6f same time... To
24a0: 20 70 75 74 20 69 74 20 61 6e 6f 74 68 65 72 20 put it another
24b0: 77 61 79 2c 20 53 51 4c 49 54 45 5f 54 48 52 45 way, SQLITE_THRE
24c0: 41 44 53 41 46 45 3d 31 20 73 65 74 73 20 74 68 ADSAFE=1 sets th
24d0: 65 20 64 65 66 61 75 6c 74 0a 20 20 5b 74 68 72 e default. [thr
24e0: 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 74 6f 20 eading mode] to
24f0: 53 65 72 69 61 6c 69 7a 65 64 2e 20 20 53 51 4c Serialized. SQL
2500: 49 54 45 5f 54 48 52 45 41 44 53 41 46 45 3d 32 ITE_THREADSAFE=2
2510: 20 73 65 74 73 20 74 68 65 20 64 65 66 61 75 6c sets the defaul
2520: 74 0a 20 20 5b 74 68 72 65 61 64 69 6e 67 20 6d t. [threading m
2530: 6f 64 65 5d 20 74 6f 20 4d 75 6c 74 69 2d 74 68 ode] to Multi-th
2540: 72 65 61 64 65 64 2e 20 20 41 6e 64 20 53 51 4c readed. And SQL
2550: 49 54 45 5f 54 48 52 45 41 44 53 41 46 45 3d 30 ITE_THREADSAFE=0
2560: 20 73 65 74 73 20 74 68 65 0a 20 20 5b 74 68 72 sets the. [thr
2570: 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20 74 6f 20 eading mode] to
2580: 53 69 6e 67 6c 65 2d 74 68 72 65 61 64 65 64 2e Single-threaded.
2590: 0a 0a 20 20 54 68 65 20 76 61 6c 75 65 20 6f 66 .. The value of
25a0: 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 SQLITE_THREADSA
25b0: 46 45 20 63 61 6e 20 62 65 20 64 65 74 65 72 6d FE can be determ
25c0: 69 6e 65 64 20 61 74 20 72 75 6e 2d 74 69 6d 65 ined at run-time
25d0: 0a 20 20 75 73 69 6e 67 20 74 68 65 20 5b 73 71 . using the [sq
25e0: 6c 69 74 65 33 5f 74 68 72 65 61 64 73 61 66 65 lite3_threadsafe
25f0: 28 29 5d 20 69 6e 74 65 72 66 61 63 65 2e 0a 0a ()] interface...
2600: 20 20 57 68 65 6e 20 53 51 4c 69 74 65 20 68 61 When SQLite ha
2610: 73 20 62 65 65 6e 20 63 6f 6d 70 69 6c 65 64 20 s been compiled
2620: 77 69 74 68 20 53 51 4c 49 54 45 5f 54 48 52 45 with SQLITE_THRE
2630: 41 44 53 41 46 45 3d 31 20 6f 72 0a 20 20 53 51 ADSAFE=1 or. SQ
2640: 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45 3d LITE_THREADSAFE=
2650: 32 20 74 68 65 6e 20 74 68 65 20 5b 74 68 72 65 2 then the [thre
2660: 61 64 69 6e 67 20 6d 6f 64 65 5d 0a 20 20 63 61 ading mode]. ca
2670: 6e 20 62 65 20 61 6c 74 65 72 65 64 20 61 74 20 n be altered at
2680: 72 75 6e 2d 74 69 6d 65 20 75 73 69 6e 67 20 74 run-time using t
2690: 68 65 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66 he [sqlite3_conf
26a0: 69 67 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 ig()] interface
26b0: 74 6f 67 65 74 68 65 72 0a 20 20 77 69 74 68 20 together. with
26c0: 6f 6e 65 20 6f 66 20 74 68 65 73 65 20 76 65 72 one of these ver
26d0: 62 73 3a 0a 0a 20 20 3c 75 6c 3e 0a 20 20 3c 6c bs:.. <ul>. <l
26e0: 69 3e 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 i>[SQLITE_CONFIG
26f0: 5f 53 49 4e 47 4c 45 54 48 52 45 41 44 5d 0a 20 _SINGLETHREAD].
2700: 20 3c 6c 69 3e 5b 53 51 4c 49 54 45 5f 43 4f 4e <li>[SQLITE_CON
2710: 46 49 47 5f 4d 55 4c 54 49 54 48 52 45 41 44 5d FIG_MULTITHREAD]
2720: 0a 20 20 3c 6c 69 3e 5b 53 51 4c 49 54 45 5f 43 . <li>[SQLITE_C
2730: 4f 4e 46 49 47 5f 53 45 52 49 41 4c 49 5a 45 44 ONFIG_SERIALIZED
2740: 5d 0a 20 20 3c 2f 75 6c 3e 0a 0a 20 20 54 68 65 ]. </ul>.. The
2750: 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 4e 4f [SQLITE_OPEN_NO
2760: 4d 55 54 45 58 5d 20 61 6e 64 0a 20 20 5b 53 51 MUTEX] and. [SQ
2770: 4c 49 54 45 5f 4f 50 45 4e 5f 46 55 4c 4c 4d 55 LITE_OPEN_FULLMU
2780: 54 45 58 5d 20 66 6c 61 67 73 20 74 6f 20 5b 73 TEX] flags to [s
2790: 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 qlite3_open_v2()
27a0: 5d 20 63 61 6e 20 61 6c 73 6f 20 62 65 20 75 73 ] can also be us
27b0: 65 64 0a 20 20 74 6f 20 61 64 6a 75 73 74 20 74 ed. to adjust t
27c0: 68 65 20 5b 74 68 72 65 61 64 69 6e 67 20 6d 6f he [threading mo
27d0: 64 65 5d 20 6f 66 20 69 6e 64 69 76 69 64 75 61 de] of individua
27e0: 6c 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e l [database conn
27f0: 65 63 74 69 6f 6e 73 5d 0a 20 20 61 74 20 72 75 ections]. at ru
2800: 6e 2d 74 69 6d 65 2e 0a 0a 20 20 4e 6f 74 65 20 n-time... Note
2810: 74 68 61 74 20 77 68 65 6e 20 53 51 4c 69 74 65 that when SQLite
2820: 20 69 73 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 is compiled wit
2830: 68 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 h SQLITE_THREADS
2840: 41 46 45 3d 30 2c 20 74 68 65 20 63 6f 64 65 0a AFE=0, the code.
2850: 20 20 74 6f 20 6d 61 6b 65 20 53 51 4c 69 74 65 to make SQLite
2860: 20 74 68 72 65 61 64 73 61 66 65 20 69 73 20 6f threadsafe is o
2870: 6d 69 74 74 65 64 20 66 72 6f 6d 20 74 68 65 20 mitted from the
2880: 62 75 69 6c 64 2e 20 20 57 68 65 6e 20 74 68 69 build. When thi
2890: 73 20 6f 63 63 75 72 73 2c 0a 20 20 69 74 20 69 s occurs,. it i
28a0: 73 20 69 6d 70 6f 73 73 69 62 6c 65 20 74 6f 20 s impossible to
28b0: 63 68 61 6e 67 65 20 74 68 65 20 5b 74 68 72 65 change the [thre
28c0: 61 64 69 6e 67 20 6d 6f 64 65 5d 20 61 74 20 73 ading mode] at s
28d0: 74 61 72 74 2d 74 69 6d 65 20 6f 72 20 72 75 6e tart-time or run
28e0: 2d 74 69 6d 65 2e 0a 0a 20 20 53 65 65 20 74 68 -time... See th
28f0: 65 20 5b 74 68 72 65 61 64 69 6e 67 20 6d 6f 64 e [threading mod
2900: 65 5d 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e e] documentation
2910: 20 66 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c 20 for additional
2920: 69 6e 66 6f 72 6d 61 74 69 6f 6e 0a 20 20 6f 6e information. on
2930: 20 61 73 70 65 63 74 73 20 6f 66 20 75 73 69 6e aspects of usin
2940: 67 20 53 51 4c 69 74 65 20 69 6e 20 61 20 6d 75 g SQLite in a mu
2950: 6c 74 69 74 68 72 65 61 64 65 64 20 65 6e 76 69 ltithreaded envi
2960: 72 6f 6e 6d 65 6e 74 2e 0a 7d 0a 0a 43 4f 4d 50 ronment..}..COMP
2970: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
2980: 54 45 5f 54 45 4d 50 5f 53 54 4f 52 45 3d 3c 69 TE_TEMP_STORE=<i
2990: 3e 26 6c 74 3b 30 20 74 68 72 6f 75 67 68 20 33 ><0 through 3
29a0: 26 67 74 3b 3c 2f 69 3e 7d 20 7b 0a 20 20 54 68 ></i>} {. Th
29b0: 69 73 20 6f 70 74 69 6f 6e 20 63 6f 6e 74 72 6f is option contro
29c0: 6c 73 20 77 68 65 74 68 65 72 20 74 65 6d 70 6f ls whether tempo
29d0: 72 61 72 79 20 66 69 6c 65 73 20 61 72 65 20 73 rary files are s
29e0: 74 6f 72 65 64 20 6f 6e 20 64 69 73 6b 20 6f 72 tored on disk or
29f0: 0a 20 20 69 6e 20 6d 65 6d 6f 72 79 2e 20 20 54 . in memory. T
2a00: 68 65 20 6d 65 61 6e 69 6e 67 73 20 66 6f 72 20 he meanings for
2a10: 76 61 72 69 6f 75 73 20 73 65 74 74 69 6e 67 73 various settings
2a20: 20 6f 66 20 74 68 69 73 20 63 6f 6d 70 69 6c 65 of this compile
2a30: 2d 74 69 6d 65 0a 20 20 6f 70 74 69 6f 6e 20 61 -time. option a
2a40: 72 65 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a 0a re as follows:..
2a50: 20 20 3c 74 61 62 6c 65 20 63 65 6c 6c 70 61 64 <table cellpad
2a60: 64 69 6e 67 3d 22 32 22 20 62 6f 72 64 65 72 3d ding="2" border=
2a70: 22 31 22 3e 0a 20 20 3c 74 72 3e 3c 74 68 3e 53 "1">. <tr><th>S
2a80: 51 4c 49 54 45 5f 54 45 4d 50 5f 53 54 4f 52 45 QLITE_TEMP_STORE
2a90: 3c 2f 74 68 3e 3c 74 68 3e 4d 65 61 6e 69 6e 67 </th><th>Meaning
2aa0: 3c 2f 74 68 3e 3c 2f 74 72 3e 0a 20 20 3c 74 72 </th></tr>. <tr
2ab0: 3e 3c 74 64 20 61 6c 69 67 6e 3d 22 63 65 6e 74 ><td align="cent
2ac0: 65 72 22 3e 30 3c 2f 74 64 3e 3c 74 64 3e 41 6c er">0</td><td>Al
2ad0: 77 61 79 73 20 75 73 65 20 74 65 6d 70 6f 72 61 ways use tempora
2ae0: 72 79 20 66 69 6c 65 73 3c 2f 74 64 3e 3c 2f 74 ry files</td></t
2af0: 72 3e 0a 20 20 3c 74 72 3e 3c 74 64 20 61 6c 69 r>. <tr><td ali
2b00: 67 6e 3d 22 63 65 6e 74 65 72 22 3e 31 3c 2f 74 gn="center">1</t
2b10: 64 3e 3c 74 64 3e 55 73 65 20 66 69 6c 65 73 20 d><td>Use files
2b20: 62 79 20 64 65 66 61 75 6c 74 20 62 75 74 20 61 by default but a
2b30: 6c 6c 6f 77 20 74 68 65 0a 20 20 5b 50 52 41 47 llow the. [PRAG
2b40: 4d 41 20 74 65 6d 70 5f 73 74 6f 72 65 5d 20 63 MA temp_store] c
2b50: 6f 6d 6d 61 6e 64 20 74 6f 20 6f 76 65 72 72 69 ommand to overri
2b60: 64 65 3c 2f 74 64 3e 3c 2f 74 72 3e 0a 20 20 3c de</td></tr>. <
2b70: 74 72 3e 3c 74 64 20 61 6c 69 67 6e 3d 22 63 65 tr><td align="ce
2b80: 6e 74 65 72 22 3e 32 3c 2f 74 64 3e 3c 74 64 3e nter">2</td><td>
2b90: 55 73 65 20 6d 65 6d 6f 72 79 20 62 79 20 64 65 Use memory by de
2ba0: 66 61 75 6c 74 20 62 75 74 20 61 6c 6c 6f 77 20 fault but allow
2bb0: 74 68 65 0a 20 20 5b 50 52 41 47 4d 41 20 74 65 the. [PRAGMA te
2bc0: 6d 70 5f 73 74 6f 72 65 5d 20 63 6f 6d 6d 61 6e mp_store] comman
2bd0: 64 20 74 6f 20 6f 76 65 72 72 69 64 65 3c 2f 74 d to override</t
2be0: 64 3e 3c 2f 74 72 3e 0a 20 20 3c 74 72 3e 3c 74 d></tr>. <tr><t
2bf0: 64 20 61 6c 69 67 6e 3d 22 63 65 6e 74 65 72 22 d align="center"
2c00: 3e 33 3c 2f 74 64 3e 3c 74 64 3e 41 6c 77 61 79 >3</td><td>Alway
2c10: 73 20 75 73 65 20 6d 65 6d 6f 72 79 3c 2f 74 64 s use memory</td
2c20: 3e 3c 2f 74 72 3e 0a 20 20 3c 2f 74 61 62 6c 65 ></tr>. </table
2c30: 3e 0a 0a 20 20 54 68 65 20 64 65 66 61 75 6c 74 >.. The default
2c40: 20 73 65 74 74 69 6e 67 20 69 73 20 31 2e 20 20 setting is 1.
2c50: 0a 20 20 41 64 64 69 74 69 6f 6e 61 6c 20 69 6e . Additional in
2c60: 66 6f 72 6d 61 74 69 6f 6e 20 63 61 6e 20 62 65 formation can be
2c70: 20 66 6f 75 6e 64 20 69 6e 20 5b 74 65 6d 70 73 found in [temps
2c80: 74 6f 72 65 20 7c 20 74 65 6d 70 66 69 6c 65 73 tore | tempfiles
2c90: 2e 68 74 6d 6c 5d 2e 0a 7d 0a 3c 2f 74 63 6c 3e .html]..}.</tcl>
2ca0: 0a 0a 3c 61 20 6e 61 6d 65 3d 22 65 6e 61 62 6c ..<a name="enabl
2cb0: 65 66 65 61 74 75 72 65 73 22 3e 3c 2f 61 3e 0a efeatures"></a>.
2cc0: 3c 68 32 3e 31 2e 34 20 4f 70 74 69 6f 6e 73 20 <h2>1.4 Options
2cd0: 54 6f 20 45 6e 61 62 6c 65 20 46 65 61 74 75 72 To Enable Featur
2ce0: 65 73 20 4e 6f 72 6d 61 6c 6c 79 20 54 75 72 6e es Normally Turn
2cf0: 65 64 20 4f 66 66 3c 2f 68 32 3e 0a 0a 3c 74 63 ed Off</h2>..<tc
2d00: 6c 3e 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f l>.COMPILE_OPTIO
2d10: 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 N {SQLITE_ENABLE
2d20: 5f 41 54 4f 4d 49 43 5f 57 52 49 54 45 7d 20 7b _ATOMIC_WRITE} {
2d30: 0a 20 20 49 66 20 74 68 69 73 20 43 2d 70 72 65 . If this C-pre
2d40: 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f 20 processor macro
2d50: 69 73 20 64 65 66 69 6e 65 64 20 61 6e 64 20 69 is defined and i
2d60: 66 20 74 68 65 0a 20 20 78 44 65 76 69 63 65 43 f the. xDeviceC
2d70: 68 61 72 61 63 74 65 72 69 73 74 69 63 73 20 6d haracteristics m
2d80: 65 74 68 6f 64 20 6f 66 20 5b 73 71 6c 69 74 65 ethod of [sqlite
2d90: 33 5f 69 6f 5f 6d 65 74 68 6f 64 73 5d 20 6f 62 3_io_methods] ob
2da0: 6a 65 63 74 20 66 6f 72 0a 20 20 61 20 64 61 74 ject for. a dat
2db0: 61 62 61 73 65 20 66 69 6c 65 20 72 65 70 6f 72 abase file repor
2dc0: 74 73 20 28 76 69 61 20 6f 6e 65 20 6f 66 20 74 ts (via one of t
2dd0: 68 65 20 5b 53 51 4c 49 54 45 5f 49 4f 43 41 50 he [SQLITE_IOCAP
2de0: 5f 41 54 4f 4d 49 43 5d 20 62 69 74 73 29 0a 20 _ATOMIC] bits).
2df0: 20 74 68 61 74 20 74 68 65 20 66 69 6c 65 73 79 that the filesy
2e00: 73 74 65 6d 20 73 75 70 70 6f 72 74 73 20 61 74 stem supports at
2e10: 6f 6d 69 63 20 77 72 69 74 65 73 20 61 6e 64 20 omic writes and
2e20: 69 66 20 61 20 74 72 61 6e 73 61 63 74 69 6f 6e if a transaction
2e30: 0a 20 20 69 6e 76 6f 6c 76 65 73 20 61 20 63 68 . involves a ch
2e40: 61 6e 67 65 20 74 6f 20 6f 6e 6c 79 20 61 20 73 ange to only a s
2e50: 69 6e 67 6c 65 20 70 61 67 65 20 6f 66 20 74 68 ingle page of th
2e60: 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 2c e database file,
2e70: 0a 20 20 74 68 65 6e 20 74 68 65 20 74 72 61 6e . then the tran
2e80: 73 61 63 74 69 6f 6e 20 63 6f 6d 6d 69 74 73 20 saction commits
2e90: 77 69 74 68 20 6a 75 73 74 20 61 20 73 69 6e 67 with just a sing
2ea0: 6c 65 20 77 72 69 74 65 20 72 65 71 75 65 73 74 le write request
2eb0: 20 6f 66 0a 20 20 61 20 73 69 6e 67 6c 65 20 70 of. a single p
2ec0: 61 67 65 20 6f 66 20 74 68 65 20 64 61 74 61 62 age of the datab
2ed0: 61 73 65 20 61 6e 64 20 6e 6f 20 72 6f 6c 6c 62 ase and no rollb
2ee0: 61 63 6b 20 6a 6f 75 72 6e 61 6c 20 69 73 20 63 ack journal is c
2ef0: 72 65 61 74 65 64 0a 20 20 6f 72 20 77 72 69 74 reated. or writ
2f00: 74 65 6e 2e 20 20 4f 6e 20 66 69 6c 65 73 79 73 ten. On filesys
2f10: 74 65 6d 73 20 74 68 61 74 20 73 75 70 70 6f 72 tems that suppor
2f20: 74 20 61 74 6f 6d 69 63 20 77 72 69 74 65 73 2c t atomic writes,
2f30: 20 74 68 69 73 0a 20 20 6f 70 74 69 6d 69 7a 61 this. optimiza
2f40: 74 69 6f 6e 20 63 61 6e 20 72 65 73 75 6c 74 20 tion can result
2f50: 69 6e 20 73 69 67 6e 69 66 69 63 61 6e 74 20 73 in significant s
2f60: 70 65 65 64 20 69 6d 70 72 6f 76 65 6d 65 6e 74 peed improvement
2f70: 73 20 66 6f 72 0a 20 20 73 6d 61 6c 6c 20 75 70 s for. small up
2f80: 64 61 74 65 73 2e 20 20 48 6f 77 65 76 65 72 2c dates. However,
2f90: 20 66 65 77 20 66 69 6c 65 73 79 73 74 65 6d 73 few filesystems
2fa0: 20 73 75 70 70 6f 72 74 20 74 68 69 73 20 63 61 support this ca
2fb0: 70 61 62 69 6c 69 74 79 0a 20 20 61 6e 64 20 74 pability. and t
2fc0: 68 65 20 63 6f 64 65 20 70 61 74 68 73 20 74 68 he code paths th
2fd0: 61 74 20 63 68 65 63 6b 20 66 6f 72 20 74 68 69 at check for thi
2fe0: 73 20 63 61 70 61 62 69 6c 69 74 79 20 73 6c 6f s capability slo
2ff0: 77 20 64 6f 77 6e 20 77 72 69 74 65 0a 20 20 70 w down write. p
3000: 65 72 66 6f 72 6d 61 6e 63 65 20 6f 6e 20 73 79 erformance on sy
3010: 73 74 65 6d 73 20 74 68 61 74 20 6c 61 63 6b 20 stems that lack
3020: 61 74 6f 6d 69 63 20 77 72 69 74 65 20 63 61 70 atomic write cap
3030: 61 62 69 6c 69 74 79 2c 20 73 6f 20 74 68 69 73 ability, so this
3040: 0a 20 20 66 65 61 74 75 72 65 20 69 73 20 64 69 . feature is di
3050: 73 61 62 6c 65 64 20 62 79 20 64 65 66 61 75 6c sabled by defaul
3060: 74 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 t..}..COMPILE_OP
3070: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 TION {SQLITE_ENA
3080: 42 4c 45 5f 43 4f 4c 55 4d 4e 5f 4d 45 54 41 44 BLE_COLUMN_METAD
3090: 41 54 41 7d 20 7b 0a 20 20 57 68 65 6e 20 74 68 ATA} {. When th
30a0: 69 73 20 43 2d 70 72 65 70 72 6f 63 65 73 73 6f is C-preprocesso
30b0: 72 20 6d 61 63 72 6f 20 69 73 20 64 65 66 69 6e r macro is defin
30c0: 65 64 2c 20 53 51 4c 69 74 65 20 69 6e 63 6c 75 ed, SQLite inclu
30d0: 64 65 73 20 73 6f 6d 65 0a 20 20 61 64 64 69 74 des some. addit
30e0: 69 6f 6e 61 6c 20 41 50 49 73 20 74 68 61 74 20 ional APIs that
30f0: 70 72 6f 76 69 64 65 20 63 6f 6e 76 65 6e 69 65 provide convenie
3100: 6e 74 20 61 63 63 65 73 73 20 74 6f 20 6d 65 74 nt access to met
3110: 61 2d 64 61 74 61 20 61 62 6f 75 74 0a 20 20 74 a-data about. t
3120: 61 62 6c 65 73 20 61 6e 64 20 71 75 65 72 69 65 ables and querie
3130: 73 2e 20 20 54 68 65 20 41 50 49 73 20 74 68 61 s. The APIs tha
3140: 74 20 61 72 65 20 65 6e 61 62 6c 65 64 20 62 79 t are enabled by
3150: 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 61 72 65 this option are
3160: 3a 0a 0a 20 20 3c 75 6c 3e 0a 20 20 3c 6c 69 3e :.. <ul>. <li>
3170: 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e [sqlite3_column
3180: 5f 64 61 74 61 62 61 73 65 5f 6e 61 6d 65 28 29 _database_name()
3190: 5d 20 3c 2f 6c 69 3e 0a 20 20 3c 6c 69 3e 20 5b ] </li>. <li> [
31a0: 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 64 sqlite3_column_d
31b0: 61 74 61 62 61 73 65 5f 6e 61 6d 65 31 36 28 29 atabase_name16()
31c0: 5d 20 3c 2f 6c 69 3e 0a 20 20 3c 6c 69 3e 20 5b ] </li>. <li> [
31d0: 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 sqlite3_column_t
31e0: 61 62 6c 65 5f 6e 61 6d 65 28 29 5d 20 3c 2f 6c able_name()] </l
31f0: 69 3e 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c 69 74 i>. <li> [sqlit
3200: 65 33 5f 63 6f 6c 75 6d 6e 5f 74 61 62 6c 65 5f e3_column_table_
3210: 6e 61 6d 65 31 36 28 29 5d 20 3c 2f 6c 69 3e 0a name16()] </li>.
3220: 20 20 3c 6c 69 3e 20 5b 73 71 6c 69 74 65 33 5f <li> [sqlite3_
3230: 63 6f 6c 75 6d 6e 5f 6f 72 69 67 69 6e 5f 6e 61 column_origin_na
3240: 6d 65 28 29 5d 20 3c 2f 6c 69 3e 0a 20 20 3c 6c me()] </li>. <l
3250: 69 3e 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 i> [sqlite3_colu
3260: 6d 6e 5f 6f 72 69 67 69 6e 5f 6e 61 6d 65 31 36 mn_origin_name16
3270: 28 29 5d 20 3c 2f 6c 69 3e 0a 20 20 3c 6c 69 3e ()] </li>. <li>
3280: 20 5b 73 71 6c 69 74 65 33 5f 74 61 62 6c 65 5f [sqlite3_table_
3290: 63 6f 6c 75 6d 6e 5f 6d 65 74 61 64 61 74 61 28 column_metadata(
32a0: 29 5d 20 3c 2f 6c 69 3e 0a 20 20 3c 2f 75 6c 3e )] </li>. </ul>
32b0: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
32c0: 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c ON {SQLITE_ENABL
32d0: 45 5f 46 54 53 33 7d 20 7b 0a 20 20 57 68 65 6e E_FTS3} {. When
32e0: 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 this option is
32f0: 64 65 66 69 6e 65 64 20 69 6e 20 74 68 65 20 5b defined in the [
3300: 61 6d 61 6c 67 61 6d 61 74 69 6f 6e 5d 2c 20 76 amalgamation], v
3310: 65 72 73 69 6f 6e 20 33 0a 20 20 6f 66 20 74 68 ersion 3. of th
3320: 65 20 66 75 6c 6c 2d 74 65 78 74 20 73 65 61 72 e full-text sear
3330: 63 68 20 65 6e 67 69 6e 65 20 69 73 20 61 64 64 ch engine is add
3340: 65 64 20 74 6f 20 74 68 65 20 62 75 69 6c 64 20 ed to the build
3350: 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 2e 0a 7d automatically..}
3360: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
3370: 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f {SQLITE_ENABLE_
3380: 46 54 53 33 5f 50 41 52 45 4e 54 48 45 53 49 53 FTS3_PARENTHESIS
3390: 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f } {. This optio
33a0: 6e 20 6d 6f 64 69 66 69 65 73 20 74 68 65 20 71 n modifies the q
33b0: 75 65 72 79 20 70 61 74 74 65 72 6e 20 70 61 72 uery pattern par
33c0: 73 65 72 20 69 6e 20 46 54 53 33 20 73 75 63 68 ser in FTS3 such
33d0: 20 74 68 61 74 20 69 74 0a 20 20 73 75 70 70 6f that it. suppo
33e0: 72 74 73 20 6f 70 65 72 61 74 6f 72 73 20 41 4e rts operators AN
33f0: 44 20 61 6e 64 20 4e 4f 54 20 28 69 6e 20 61 64 D and NOT (in ad
3400: 64 69 74 69 6f 6e 20 74 6f 20 74 68 65 20 75 73 dition to the us
3410: 75 61 6c 20 4f 52 20 61 6e 64 20 4e 45 41 52 29 ual OR and NEAR)
3420: 0a 20 20 61 6e 64 20 61 6c 73 6f 20 61 6c 6c 6f . and also allo
3430: 77 73 20 71 75 65 72 79 20 65 78 70 72 65 73 73 ws query express
3440: 69 6f 6e 73 20 74 6f 20 63 6f 6e 74 61 69 6e 20 ions to contain
3450: 6e 65 73 74 65 64 20 70 61 72 65 6e 74 68 65 73 nested parenthes
3460: 69 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f is..}..COMPILE_O
3470: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e PTION {SQLITE_EN
3480: 41 42 4c 45 5f 49 43 55 7d 20 7b 0a 20 20 54 68 ABLE_ICU} {. Th
3490: 69 73 20 6f 70 74 69 6f 6e 20 63 61 75 73 65 73 is option causes
34a0: 20 74 68 65 20 0a 20 20 5b 68 74 74 70 3a 2f 2f the . [http://
34b0: 77 77 77 2e 69 63 75 2d 70 72 6f 6a 65 63 74 2e www.icu-project.
34c0: 6f 72 67 2f 20 7c 20 49 6e 74 65 72 6e 61 74 69 org/ | Internati
34d0: 6f 6e 61 6c 20 43 6f 6d 70 6f 6e 65 6e 74 73 20 onal Components
34e0: 66 6f 72 20 55 6e 69 63 6f 64 65 5d 0a 20 20 6f for Unicode]. o
34f0: 72 20 22 49 43 55 22 20 65 78 74 65 6e 73 69 6f r "ICU" extensio
3500: 6e 20 74 6f 20 53 51 4c 69 74 65 20 74 6f 20 62 n to SQLite to b
3510: 65 20 61 64 64 65 64 20 74 6f 20 74 68 65 20 62 e added to the b
3520: 75 69 6c 64 2e 20 20 0a 7d 0a 0a 43 4f 4d 50 49 uild. .}..COMPI
3530: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
3540: 45 5f 45 4e 41 42 4c 45 5f 49 4f 54 52 41 43 45 E_ENABLE_IOTRACE
3550: 7d 20 7b 0a 20 20 57 68 65 6e 20 62 6f 74 68 20 } {. When both
3560: 74 68 65 20 53 51 4c 69 74 65 20 63 6f 72 65 20 the SQLite core
3570: 61 6e 64 20 74 68 65 20 5b 43 6f 6d 6d 61 6e 64 and the [Command
3580: 20 4c 69 6e 65 20 49 6e 74 65 72 66 61 63 65 5d Line Interface]
3590: 20 28 43 4c 49 29 20 61 72 65 20 62 6f 74 68 20 (CLI) are both
35a0: 0a 20 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 . compiled with
35b0: 20 74 68 69 73 20 6f 70 74 69 6f 6e 2c 20 74 68 this option, th
35c0: 65 6e 20 74 68 65 20 43 4c 49 20 70 72 6f 76 69 en the CLI provi
35d0: 64 65 73 20 61 6e 20 65 78 74 72 61 20 63 6f 6d des an extra com
35e0: 6d 61 6e 64 0a 20 20 6e 61 6d 65 64 20 22 2e 69 mand. named ".i
35f0: 6f 74 72 61 63 65 22 20 74 68 61 74 20 70 72 6f otrace" that pro
3600: 76 69 64 65 73 20 61 20 6c 6f 77 2d 6c 65 76 65 vides a low-leve
3610: 6c 20 6c 6f 67 20 6f 66 20 49 2f 4f 20 61 63 74 l log of I/O act
3620: 69 76 69 74 79 2e 0a 20 20 54 68 69 73 20 6f 70 ivity.. This op
3630: 74 69 6f 6e 20 69 73 20 65 78 70 65 72 69 6d 65 tion is experime
3640: 6e 74 61 6c 20 61 6e 64 20 6d 61 79 20 62 65 20 ntal and may be
3650: 64 69 73 63 6f 6e 74 69 6e 75 65 64 20 69 6e 20 discontinued in
3660: 61 20 66 75 74 75 72 65 20 72 65 6c 65 61 73 65 a future release
3670: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
3680: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 ION {SQLITE_ENAB
3690: 4c 45 5f 4c 4f 43 4b 49 4e 47 5f 53 54 59 4c 45 LE_LOCKING_STYLE
36a0: 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f } {. This optio
36b0: 6e 20 65 6e 61 62 6c 65 73 20 61 64 64 69 74 69 n enables additi
36c0: 6f 6e 61 6c 20 6c 6f 67 69 63 20 69 6e 20 74 68 onal logic in th
36d0: 65 20 4f 53 20 69 6e 74 65 72 66 61 63 65 20 6c e OS interface l
36e0: 61 79 65 72 20 66 6f 72 0a 20 20 4d 61 63 20 4f ayer for. Mac O
36f0: 53 20 58 2e 20 54 68 65 20 61 64 64 69 74 69 6f S X. The additio
3700: 6e 61 6c 20 6c 6f 67 69 63 20 61 74 74 65 6d 70 nal logic attemp
3710: 74 73 20 74 6f 20 64 65 74 65 72 6d 69 6e 65 20 ts to determine
3720: 74 68 65 20 74 79 70 65 20 6f 66 20 74 68 65 0a the type of the.
3730: 20 20 75 6e 64 65 72 6c 79 69 6e 67 20 66 69 6c underlying fil
3740: 65 73 79 73 74 65 6d 20 61 6e 64 20 63 68 6f 6f esystem and choo
3750: 73 65 20 61 6e 64 20 61 6c 74 65 72 6e 61 74 69 se and alternati
3760: 76 65 20 6c 6f 63 6b 69 6e 67 20 73 74 72 61 74 ve locking strat
3770: 65 67 79 0a 20 20 74 68 61 74 20 77 6f 72 6b 73 egy. that works
3780: 20 63 6f 72 72 65 63 74 6c 79 20 66 6f 72 20 74 correctly for t
3790: 68 61 74 20 66 69 6c 65 73 79 73 74 65 6d 20 74 hat filesystem t
37a0: 79 70 65 2e 20 46 69 76 65 20 6c 6f 63 6b 69 6e ype. Five lockin
37b0: 67 20 73 74 72 61 74 65 67 69 65 73 20 0a 20 20 g strategies .
37c0: 61 72 65 20 61 76 61 69 6c 61 62 6c 65 3a 0a 0a are available:..
37d0: 20 20 3c 75 6c 3e 0a 20 20 20 20 3c 6c 69 3e 20 <ul>. <li>
37e0: 50 4f 53 49 58 20 6c 6f 63 6b 69 6e 67 20 73 74 POSIX locking st
37f0: 79 6c 65 2e 20 54 68 69 73 20 69 73 20 74 68 65 yle. This is the
3800: 20 64 65 66 61 75 6c 74 20 6c 6f 63 6b 69 6e 67 default locking
3810: 20 73 74 79 6c 65 20 61 6e 64 20 74 68 65 0a 20 style and the.
3820: 20 20 20 20 20 20 20 20 73 74 79 6c 65 20 75 73 style us
3830: 65 64 20 62 79 20 6f 74 68 65 72 20 28 6e 6f 6e ed by other (non
3840: 20 4d 61 63 20 4f 53 20 58 29 20 55 6e 69 78 65 Mac OS X) Unixe
3850: 73 2e 20 4c 6f 63 6b 73 20 61 72 65 20 6f 62 74 s. Locks are obt
3860: 61 69 6e 65 64 20 61 6e 64 20 0a 20 20 20 20 20 ained and .
3870: 20 20 20 20 72 65 6c 65 61 73 65 64 20 75 73 69 released usi
3880: 6e 67 20 74 68 65 20 66 63 6e 74 6c 28 29 20 73 ng the fcntl() s
3890: 79 73 74 65 6d 20 63 61 6c 6c 2e 0a 0a 20 20 20 ystem call...
38a0: 20 3c 6c 69 3e 20 41 46 50 20 6c 6f 63 6b 69 6e <li> AFP lockin
38b0: 67 20 73 74 79 6c 65 2e 20 54 68 69 73 20 6c 6f g style. This lo
38c0: 63 6b 69 6e 67 20 73 74 79 6c 65 20 69 73 20 75 cking style is u
38d0: 73 65 64 20 66 6f 72 20 6e 65 74 77 6f 72 6b 20 sed for network
38e0: 66 69 6c 65 20 0a 20 20 20 20 20 20 20 20 20 73 file . s
38f0: 79 73 74 65 6d 73 20 74 68 61 74 20 75 73 65 20 ystems that use
3900: 74 68 65 20 41 46 50 20 28 41 70 70 6c 65 20 46 the AFP (Apple F
3910: 69 6c 69 6e 67 20 50 72 6f 74 6f 63 6f 6c 29 20 iling Protocol)
3920: 70 72 6f 74 6f 63 6f 6c 2e 20 4c 6f 63 6b 73 0a protocol. Locks.
3930: 20 20 20 20 20 20 20 20 20 61 72 65 20 6f 62 74 are obt
3940: 61 69 6e 65 64 20 62 79 20 63 61 6c 6c 69 6e 67 ained by calling
3950: 20 74 68 65 20 6c 69 62 72 61 72 79 20 66 75 6e the library fun
3960: 63 74 69 6f 6e 20 5f 41 46 50 46 53 53 65 74 4c ction _AFPFSSetL
3970: 6f 63 6b 28 29 2e 0a 0a 20 20 20 20 3c 6c 69 3e ock()... <li>
3980: 20 46 6c 6f 63 6b 20 6c 6f 63 6b 69 6e 67 20 73 Flock locking s
3990: 74 79 6c 65 2e 20 54 68 69 73 20 69 73 20 75 73 tyle. This is us
39a0: 65 64 20 66 6f 72 20 66 69 6c 65 2d 73 79 73 74 ed for file-syst
39b0: 65 6d 73 20 74 68 61 74 20 64 6f 20 6e 6f 74 0a ems that do not.
39c0: 20 20 20 20 20 20 20 20 20 73 75 70 70 6f 72 74 support
39d0: 20 50 4f 53 49 58 20 6c 6f 63 6b 69 6e 67 20 73 POSIX locking s
39e0: 74 79 6c 65 2e 20 4c 6f 63 6b 73 20 61 72 65 20 tyle. Locks are
39f0: 6f 62 74 61 69 6e 65 64 20 61 6e 64 20 72 65 6c obtained and rel
3a00: 65 61 73 65 64 20 75 73 69 6e 67 0a 20 20 20 20 eased using.
3a10: 20 20 20 20 20 74 68 65 20 66 6c 6f 63 6b 28 29 the flock()
3a20: 20 73 79 73 74 65 6d 20 63 61 6c 6c 2e 0a 0a 20 system call...
3a30: 20 20 20 3c 6c 69 3e 20 44 6f 74 2d 66 69 6c 65 <li> Dot-file
3a40: 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c 65 2e 20 locking style.
3a50: 54 68 69 73 20 6c 6f 63 6b 69 6e 67 20 73 74 79 This locking sty
3a60: 6c 65 20 69 73 20 75 73 65 64 20 77 68 65 6e 20 le is used when
3a70: 6e 65 69 74 68 65 72 0a 20 20 20 20 20 20 20 20 neither.
3a80: 20 66 6c 6f 63 6b 20 6e 6f 72 20 50 4f 53 49 58 flock nor POSIX
3a90: 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c 65 73 20 locking styles
3aa0: 61 72 65 20 73 75 70 70 6f 72 74 65 64 20 62 79 are supported by
3ab0: 20 74 68 65 20 66 69 6c 65 20 73 79 73 74 65 6d the file system
3ac0: 2e 0a 20 20 20 20 20 20 20 20 20 44 61 74 61 62 .. Datab
3ad0: 61 73 65 20 6c 6f 63 6b 73 20 61 72 65 20 6f 62 ase locks are ob
3ae0: 74 61 69 6e 65 64 20 62 79 20 63 72 65 61 74 69 tained by creati
3af0: 6e 67 20 61 6e 64 20 65 6e 74 72 79 20 69 6e 20 ng and entry in
3b00: 74 68 65 20 66 69 6c 65 2d 73 79 73 74 65 6d 0a the file-system.
3b10: 20 20 20 20 20 20 20 20 20 61 74 20 61 20 77 65 at a we
3b20: 6c 6c 2d 6b 6e 6f 77 6e 20 6c 6f 63 61 74 69 6f ll-known locatio
3b30: 6e 20 72 65 6c 61 74 69 76 65 20 74 6f 20 74 68 n relative to th
3b40: 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 e database file
3b50: 28 61 20 22 64 6f 74 2d 66 69 6c 65 22 29 0a 20 (a "dot-file").
3b60: 20 20 20 20 20 20 20 20 61 6e 64 20 72 65 6c 69 and reli
3b70: 6e 71 75 69 73 68 65 64 20 62 79 20 64 65 6c 65 nquished by dele
3b80: 74 69 6e 67 20 74 68 65 20 73 61 6d 65 20 66 69 ting the same fi
3b90: 6c 65 2e 0a 0a 20 20 20 20 3c 6c 69 3e 20 4e 6f le... <li> No
3ba0: 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c 65 2e 20 locking style.
3bb0: 49 66 20 6e 6f 6e 65 20 6f 66 20 74 68 65 20 61 If none of the a
3bc0: 62 6f 76 65 20 63 61 6e 20 62 65 20 73 75 70 70 bove can be supp
3bd0: 6f 72 74 65 64 2c 20 74 68 69 73 20 0a 20 20 20 orted, this .
3be0: 20 20 20 20 20 20 6c 6f 63 6b 69 6e 67 20 73 74 locking st
3bf0: 79 6c 65 20 69 73 20 75 73 65 64 2e 20 4e 6f 20 yle is used. No
3c00: 64 61 74 61 62 61 73 65 20 6c 6f 63 6b 69 6e 67 database locking
3c10: 20 6d 65 63 68 61 6e 69 73 6d 20 69 73 20 75 73 mechanism is us
3c20: 65 64 2e 20 57 68 65 6e 0a 20 20 20 20 20 20 20 ed. When.
3c30: 20 20 74 68 69 73 20 73 79 73 74 65 6d 20 69 73 this system is
3c40: 20 75 73 65 64 20 69 74 20 69 73 20 6e 6f 74 20 used it is not
3c50: 73 61 66 65 20 66 6f 72 20 61 20 73 69 6e 67 6c safe for a singl
3c60: 65 20 64 61 74 61 62 61 73 65 20 74 6f 20 62 65 e database to be
3c70: 0a 20 20 20 20 20 20 20 20 20 61 63 63 65 73 73 . access
3c80: 65 64 20 62 79 20 6d 75 6c 74 69 70 6c 65 20 63 ed by multiple c
3c90: 6c 69 65 6e 74 73 2e 0a 20 20 3c 2f 75 6c 3e 0a lients.. </ul>.
3ca0: 0a 20 20 41 64 64 69 74 69 6f 6e 61 6c 6c 79 2c . Additionally,
3cb0: 20 66 69 76 65 20 65 78 74 72 61 20 56 46 53 20 five extra VFS
3cc0: 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20 implementations
3cd0: 61 72 65 20 70 72 6f 76 69 64 65 64 20 61 73 20 are provided as
3ce0: 77 65 6c 6c 20 61 73 20 74 68 65 0a 20 20 64 65 well as the. de
3cf0: 66 61 75 6c 74 2e 20 42 79 20 73 70 65 63 69 66 fault. By specif
3d00: 79 69 6e 67 20 6f 6e 65 20 6f 66 20 74 68 65 20 ying one of the
3d10: 65 78 74 72 61 20 56 46 53 20 69 6d 70 6c 65 6d extra VFS implem
3d20: 65 6e 74 61 74 69 6f 6e 73 20 0a 20 20 77 68 65 entations . whe
3d30: 6e 20 63 61 6c 6c 69 6e 67 20 5b 73 71 6c 69 74 n calling [sqlit
3d40: 65 33 5f 6f 70 65 6e 5f 76 32 28 29 5d 2c 20 61 e3_open_v2()], a
3d50: 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 6d 61 n application ma
3d60: 79 20 62 79 70 61 73 73 20 74 68 65 20 66 69 6c y bypass the fil
3d70: 65 2d 73 79 73 74 65 6d 0a 20 20 64 65 74 65 63 e-system. detec
3d80: 74 69 6f 6e 20 6c 6f 67 69 63 20 61 6e 64 20 65 tion logic and e
3d90: 78 70 6c 69 63 69 74 6c 79 20 73 65 6c 65 63 74 xplicitly select
3da0: 20 6f 6e 65 20 6f 66 20 74 68 65 20 61 62 6f 76 one of the abov
3db0: 65 20 6c 6f 63 6b 69 6e 67 20 73 74 79 6c 65 73 e locking styles
3dc0: 2e 20 54 68 65 0a 20 20 66 69 76 65 20 65 78 74 . The. five ext
3dd0: 72 61 20 56 46 53 20 69 6d 70 6c 65 6d 65 6e 74 ra VFS implement
3de0: 61 74 69 6f 6e 73 20 61 72 65 20 63 61 6c 6c 65 ations are calle
3df0: 64 20 22 75 6e 69 78 2d 70 6f 73 69 78 22 2c 20 d "unix-posix",
3e00: 22 75 6e 69 78 2d 61 66 70 22 2c 0a 20 20 22 75 "unix-afp",. "u
3e10: 6e 69 78 2d 66 6c 6f 63 6b 22 2c 20 22 75 6e 69 nix-flock", "uni
3e20: 78 2d 64 6f 74 66 69 6c 65 22 20 61 6e 64 20 22 x-dotfile" and "
3e30: 75 6e 69 78 2d 6e 6f 6e 65 22 2e 0a 7d 0a 0a 43 unix-none"..}..C
3e40: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
3e50: 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4d 45 4d QLITE_ENABLE_MEM
3e60: 4f 52 59 5f 4d 41 4e 41 47 45 4d 45 4e 54 7d 20 ORY_MANAGEMENT}
3e70: 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 {. This option
3e80: 61 64 64 73 20 65 78 74 72 61 20 6c 6f 67 69 63 adds extra logic
3e90: 20 74 6f 20 53 51 4c 69 74 65 20 74 68 61 74 20 to SQLite that
3ea0: 61 6c 6c 6f 77 73 20 69 74 20 74 6f 20 72 65 6c allows it to rel
3eb0: 65 61 73 65 20 75 6e 75 73 65 64 0a 20 20 6d 65 ease unused. me
3ec0: 6d 6f 72 79 20 75 70 6f 6e 20 72 65 71 75 65 73 mory upon reques
3ed0: 74 2e 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 t. This option
3ee0: 6d 75 73 74 20 62 65 20 65 6e 61 62 6c 65 64 20 must be enabled
3ef0: 69 6e 20 6f 72 64 65 72 20 66 6f 72 20 74 68 65 in order for the
3f00: 0a 20 20 5b 73 71 6c 69 74 65 33 5f 72 65 6c 65 . [sqlite3_rele
3f10: 61 73 65 5f 6d 65 6d 6f 72 79 28 29 5d 20 69 6e ase_memory()] in
3f20: 74 65 72 66 61 63 65 20 74 6f 20 77 6f 72 6b 2e terface to work.
3f30: 20 20 49 66 20 74 68 69 73 20 63 6f 6d 70 69 6c If this compil
3f40: 65 2d 74 69 6d 65 0a 20 20 6f 70 74 69 6f 6e 20 e-time. option
3f50: 69 73 20 6e 6f 74 20 75 73 65 64 2c 20 74 68 65 is not used, the
3f60: 20 5b 73 71 6c 69 74 65 33 5f 72 65 6c 65 61 73 [sqlite3_releas
3f70: 65 5f 6d 65 6d 6f 72 79 28 29 5d 20 69 6e 74 65 e_memory()] inte
3f80: 72 66 61 63 65 20 69 73 20 61 20 0a 20 20 6e 6f rface is a . no
3f90: 2d 6f 70 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f -op..}..COMPILE_
3fa0: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 OPTION {SQLITE_E
3fb0: 4e 41 42 4c 45 5f 4d 45 4d 53 59 53 33 7d 20 7b NABLE_MEMSYS3} {
3fc0: 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 69 . This option i
3fd0: 6e 63 6c 75 64 65 73 20 63 6f 64 65 20 69 6e 20 ncludes code in
3fe0: 53 51 4c 69 74 65 20 74 68 61 74 20 69 6d 70 6c SQLite that impl
3ff0: 65 6d 65 6e 74 73 20 61 6e 20 61 6c 74 65 72 6e ements an altern
4000: 61 74 69 76 65 0a 20 20 6d 65 6d 6f 72 79 20 61 ative. memory a
4010: 6c 6c 6f 63 61 74 6f 72 2e 20 20 54 68 69 73 20 llocator. This
4020: 61 6c 74 65 72 6e 61 74 69 76 65 20 6d 65 6d 6f alternative memo
4030: 72 79 20 61 6c 6c 6f 63 61 74 6f 72 20 69 73 20 ry allocator is
4040: 6f 6e 6c 79 20 65 6e 67 61 67 65 64 0a 20 20 77 only engaged. w
4050: 68 65 6e 20 74 68 65 20 5b 53 51 4c 49 54 45 5f hen the [SQLITE_
4060: 43 4f 4e 46 49 47 5f 48 45 41 50 5d 20 6f 70 74 CONFIG_HEAP] opt
4070: 69 6f 6e 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f ion to [sqlite3_
4080: 63 6f 6e 66 69 67 28 29 5d 20 69 73 20 75 73 65 config()] is use
4090: 64 20 74 6f 0a 20 20 73 75 70 70 6c 79 20 61 20 d to. supply a
40a0: 6c 61 72 67 65 20 63 68 75 6e 6b 20 6f 66 20 6d large chunk of m
40b0: 65 6d 6f 72 79 20 66 72 6f 6d 20 77 68 69 63 68 emory from which
40c0: 20 61 6c 6c 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f all memory allo
40d0: 63 61 74 69 6f 6e 73 20 61 72 65 0a 20 20 74 61 cations are. ta
40e0: 6b 65 6e 2e 0a 20 20 54 68 65 20 4d 45 4d 53 59 ken.. The MEMSY
40f0: 53 33 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 S3 memory alloca
4100: 74 6f 72 20 75 73 65 73 20 61 20 68 79 62 72 69 tor uses a hybri
4110: 64 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 61 6c 67 d allocation alg
4120: 6f 72 69 74 68 6d 20 0a 20 20 70 61 74 74 65 72 orithm . patter
4130: 6e 65 64 20 61 66 74 65 72 20 64 6c 6d 61 6c 6c ned after dlmall
4140: 6f 63 28 29 2e 20 20 20 4f 6e 6c 79 20 6f 6e 65 oc(). Only one
4150: 20 6f 66 20 53 51 4c 49 54 45 5f 45 4e 41 42 4c of SQLITE_ENABL
4160: 45 5f 4d 45 4d 53 59 53 33 20 61 6e 64 20 0a 20 E_MEMSYS3 and .
4170: 20 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4d SQLITE_ENABLE_M
4180: 45 4d 53 59 53 35 20 6d 61 79 20 62 65 20 65 6e EMSYS5 may be en
4190: 61 62 6c 65 64 20 61 74 20 6f 6e 63 65 2e 0a 7d abled at once..}
41a0: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
41b0: 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f {SQLITE_ENABLE_
41c0: 4d 45 4d 53 59 53 35 7d 20 7b 0a 20 20 54 68 69 MEMSYS5} {. Thi
41d0: 73 20 6f 70 74 69 6f 6e 20 69 6e 63 6c 75 64 65 s option include
41e0: 73 20 63 6f 64 65 20 69 6e 20 53 51 4c 69 74 65 s code in SQLite
41f0: 20 74 68 61 74 20 69 6d 70 6c 65 6d 65 6e 74 73 that implements
4200: 20 61 6e 20 61 6c 74 65 72 6e 61 74 69 76 65 0a an alternative.
4210: 20 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 memory allocat
4220: 6f 72 2e 20 20 54 68 69 73 20 61 6c 74 65 72 6e or. This altern
4230: 61 74 69 76 65 20 6d 65 6d 6f 72 79 20 61 6c 6c ative memory all
4240: 6f 63 61 74 6f 72 20 69 73 20 6f 6e 6c 79 20 65 ocator is only e
4250: 6e 67 61 67 65 64 0a 20 20 77 68 65 6e 20 74 68 ngaged. when th
4260: 65 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 e [SQLITE_CONFIG
4270: 5f 48 45 41 50 5d 20 6f 70 74 69 6f 6e 20 74 6f _HEAP] option to
4280: 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 [sqlite3_config
4290: 28 29 5d 20 69 73 20 75 73 65 64 20 74 6f 0a 20 ()] is used to.
42a0: 20 73 75 70 70 6c 79 20 61 20 6c 61 72 67 65 20 supply a large
42b0: 63 68 75 6e 6b 20 6f 66 20 6d 65 6d 6f 72 79 20 chunk of memory
42c0: 66 72 6f 6d 20 77 68 69 63 68 20 61 6c 6c 20 6d from which all m
42d0: 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e emory allocation
42e0: 73 20 61 72 65 0a 20 20 74 61 6b 65 6e 2e 0a 20 s are. taken..
42f0: 20 54 68 65 20 4d 45 4d 53 59 53 35 20 6d 6f 64 The MEMSYS5 mod
4300: 75 6c 65 20 72 6f 75 6e 64 73 20 61 6c 6c 20 61 ule rounds all a
4310: 6c 6c 6f 63 61 74 69 6f 6e 73 20 75 70 20 74 6f llocations up to
4320: 20 74 68 65 20 6e 65 78 74 20 70 6f 77 65 72 0a the next power.
4330: 20 20 6f 66 20 74 77 6f 20 61 6e 64 20 75 73 65 of two and use
4340: 73 20 61 20 66 69 72 73 74 2d 66 69 74 2c 20 62 s a first-fit, b
4350: 75 64 64 79 2d 61 6c 6c 6f 63 61 74 6f 72 20 61 uddy-allocator a
4360: 6c 67 6f 72 69 74 68 6d 0a 20 20 74 68 61 74 20 lgorithm. that
4370: 70 72 6f 76 69 64 65 73 20 73 74 72 6f 6e 67 20 provides strong
4380: 67 75 61 72 61 6e 74 65 65 73 20 61 67 61 69 6e guarantees again
4390: 73 74 20 66 72 61 67 6d 65 6e 74 61 74 69 6f 6e st fragmentation
43a0: 20 61 6e 64 20 62 72 65 61 6b 64 6f 77 6e 0a 20 and breakdown.
43b0: 20 73 75 62 6a 65 63 74 20 74 6f 20 63 65 72 74 subject to cert
43c0: 61 69 6e 20 6f 70 65 72 61 74 69 6e 67 20 63 6f ain operating co
43d0: 6e 73 74 72 61 69 6e 74 73 2e 0a 7d 0a 0a 43 4f nstraints..}..CO
43e0: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 MPILE_OPTION {SQ
43f0: 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 52 54 52 45 LITE_ENABLE_RTRE
4400: 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 E} {. This opti
4410: 6f 6e 20 63 61 75 73 65 73 20 53 51 4c 69 74 65 on causes SQLite
4420: 20 74 6f 20 69 6e 63 6c 75 64 65 20 73 75 70 70 to include supp
4430: 6f 72 74 20 66 6f 72 20 74 68 65 0a 20 20 5b 72 ort for the. [r
4440: 74 72 65 65 20 7c 20 52 2a 54 72 65 65 20 69 6e tree | R*Tree in
4450: 64 65 78 20 65 78 74 65 6e 73 69 6f 6e 5d 2e 0a dex extension]..
4460: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
4470: 4e 20 7b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 N {SQLITE_ENABLE
4480: 5f 53 54 41 54 32 7d 20 7b 0a 20 20 54 68 69 73 _STAT2} {. This
4490: 20 6f 70 74 69 6f 6e 20 61 64 64 73 20 61 64 64 option adds add
44a0: 69 74 69 6f 6e 61 6c 20 6c 6f 67 69 63 20 74 6f itional logic to
44b0: 20 74 68 65 20 5b 41 4e 41 4c 59 5a 45 5d 20 63 the [ANALYZE] c
44c0: 6f 6d 6d 61 6e 64 20 61 6e 64 20 74 6f 0a 20 20 ommand and to.
44d0: 74 68 65 20 5b 71 75 65 72 79 20 70 6c 61 6e 6e the [query plann
44e0: 65 72 5d 20 74 68 61 74 20 63 61 6e 20 68 65 6c er] that can hel
44f0: 70 20 53 51 4c 69 74 65 20 74 6f 20 63 68 6f 73 p SQLite to chos
4500: 65 20 61 20 62 65 74 74 65 72 20 71 75 65 72 79 e a better query
4510: 20 70 6c 61 6e 0a 20 20 75 6e 64 65 72 20 63 65 plan. under ce
4520: 72 74 61 69 6e 20 73 69 74 75 61 74 69 6f 6e 73 rtain situations
4530: 2e 20 20 54 68 65 20 5b 41 4e 41 4c 59 5a 45 5d . The [ANALYZE]
4540: 20 63 6f 6d 6d 61 6e 64 20 69 73 20 65 6e 68 61 command is enha
4550: 6e 63 65 64 20 74 6f 20 63 6f 6c 6c 65 63 74 0a nced to collect.
4560: 20 20 61 20 31 30 2d 73 61 6d 70 6c 65 20 68 69 a 10-sample hi
4570: 73 74 6f 67 72 61 6d 20 6f 66 20 74 68 65 20 64 stogram of the d
4580: 61 74 61 20 69 6e 20 65 61 63 68 20 69 6e 64 65 ata in each inde
4590: 78 20 61 6e 64 20 73 74 6f 72 65 20 74 68 61 74 x and store that
45a0: 20 68 69 73 74 6f 67 72 61 6d 0a 20 20 69 6e 20 histogram. in
45b0: 74 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 73 74 the <b>sqlite_st
45c0: 61 74 32 3c 2f 62 3e 20 74 61 62 6c 65 2e 20 20 at2</b> table.
45d0: 54 68 65 20 71 75 65 72 79 20 70 6c 61 6e 6e 65 The query planne
45e0: 72 20 77 69 6c 6c 20 74 68 65 6e 20 75 73 65 20 r will then use
45f0: 74 68 65 0a 20 20 68 69 73 74 6f 67 72 61 6d 20 the. histogram
4600: 64 61 74 61 20 74 6f 20 68 65 6c 70 20 69 74 20 data to help it
4610: 65 73 74 69 6d 61 74 65 20 68 6f 77 20 6d 61 6e estimate how man
4620: 79 20 72 6f 77 73 20 77 69 6c 6c 20 62 65 20 73 y rows will be s
4630: 65 6c 65 63 74 65 64 20 62 79 20 61 0a 20 20 3c elected by a. <
4640: 61 20 68 72 65 66 3d 22 6f 70 74 6f 76 65 72 76 a href="optoverv
4650: 69 65 77 2e 68 74 6d 6c 23 72 61 6e 67 65 71 75 iew.html#rangequ
4660: 65 72 79 22 3e 72 61 6e 67 65 20 63 6f 6e 73 74 ery">range const
4670: 72 61 69 6e 74 3c 2f 61 3e 20 69 6e 20 61 20 57 raint</a> in a W
4680: 48 45 52 45 20 63 6c 61 75 73 65 2e 0a 7d 0a 0a HERE clause..}..
4690: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
46a0: 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 55 50 SQLITE_ENABLE_UP
46b0: 44 41 54 45 5f 44 45 4c 45 54 45 5f 4c 49 4d 49 DATE_DELETE_LIMI
46c0: 54 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 T} {. This opti
46d0: 6f 6e 20 65 6e 61 62 6c 65 73 20 61 6e 20 6f 70 on enables an op
46e0: 74 69 6f 6e 61 6c 20 4f 52 44 45 52 20 42 59 20 tional ORDER BY
46f0: 61 6e 64 20 4c 49 4d 49 54 20 63 6c 61 75 73 65 and LIMIT clause
4700: 20 6f 6e 20 0a 20 20 5b 55 50 44 41 54 45 5d 20 on . [UPDATE]
4710: 61 6e 64 20 5b 44 45 4c 45 54 45 5d 20 73 74 61 and [DELETE] sta
4720: 74 65 6d 65 6e 74 73 2e 0a 0a 20 20 3c 70 3e 49 tements... <p>I
4730: 66 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 f this option is
4740: 20 64 65 66 69 6e 65 64 2c 20 74 68 65 6e 20 69 defined, then i
4750: 74 20 6d 75 73 74 20 61 6c 73 6f 20 62 65 20 0a t must also be .
4760: 20 20 64 65 66 69 6e 65 64 20 77 68 65 6e 20 75 defined when u
4770: 73 69 6e 67 20 74 68 65 20 27 6c 65 6d 6f 6e 27 sing the 'lemon'
4780: 20 74 6f 6f 6c 20 74 6f 20 67 65 6e 65 72 61 74 tool to generat
4790: 65 20 61 20 70 61 72 73 65 2e 63 0a 20 20 66 69 e a parse.c. fi
47a0: 6c 65 2e 20 42 65 63 61 75 73 65 20 6f 66 20 74 le. Because of t
47b0: 68 69 73 2c 20 74 68 69 73 20 6f 70 74 69 6f 6e his, this option
47c0: 20 6d 61 79 20 6f 6e 6c 79 20 62 65 20 75 73 65 may only be use
47d0: 64 20 77 68 65 6e 20 74 68 65 20 6c 69 62 72 61 d when the libra
47e0: 72 79 20 69 73 20 62 75 69 6c 74 0a 20 20 66 72 ry is built. fr
47f0: 6f 6d 20 73 6f 75 72 63 65 2c 20 6e 6f 74 20 66 om source, not f
4800: 72 6f 6d 20 74 68 65 20 5b 61 6d 61 6c 67 61 6d rom the [amalgam
4810: 61 74 69 6f 6e 5d 20 6f 72 20 66 72 6f 6d 20 74 ation] or from t
4820: 68 65 20 63 6f 6c 6c 65 63 74 69 6f 6e 20 6f 66 he collection of
4830: 0a 20 20 70 72 65 2d 70 61 63 6b 61 67 65 64 20 . pre-packaged
4840: 43 20 66 69 6c 65 73 20 70 72 6f 76 69 64 65 64 C files provided
4850: 20 66 6f 72 20 6e 6f 6e 2d 55 6e 69 78 20 6c 69 for non-Unix li
4860: 6b 65 20 70 6c 61 74 66 6f 72 6d 73 20 6f 6e 20 ke platforms on
4870: 74 68 65 20 77 65 62 73 69 74 65 2e 0a 20 20 3c the website.. <
4880: 2f 70 3e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f /p>.}..COMPILE_O
4890: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 45 4e PTION {SQLITE_EN
48a0: 41 42 4c 45 5f 55 4e 4c 4f 43 4b 5f 4e 4f 54 49 ABLE_UNLOCK_NOTI
48b0: 46 59 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 FY} {. This opt
48c0: 69 6f 6e 20 65 6e 61 62 6c 65 73 20 74 68 65 20 ion enables the
48d0: 5b 73 71 6c 69 74 65 33 5f 75 6e 6c 6f 63 6b 5f [sqlite3_unlock_
48e0: 6e 6f 74 69 66 79 28 29 5d 20 69 6e 74 65 72 66 notify()] interf
48f0: 61 63 65 20 61 6e 64 0a 20 20 69 74 73 20 61 73 ace and. its as
4900: 73 6f 63 69 61 74 65 64 20 66 75 6e 63 74 69 6f sociated functio
4910: 6e 61 6c 69 74 79 2e 20 20 53 65 65 20 74 68 65 nality. See the
4920: 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 74 documentation t
4930: 69 74 6c 65 64 0a 20 20 5b 55 73 69 6e 67 20 74 itled. [Using t
4940: 68 65 20 53 51 4c 69 74 65 20 55 6e 6c 6f 63 6b he SQLite Unlock
4950: 20 4e 6f 74 69 66 69 63 61 74 69 6f 6e 20 46 65 Notification Fe
4960: 61 74 75 72 65 5d 20 66 6f 72 20 61 64 64 69 74 ature] for addit
4970: 69 6f 6e 61 6c 0a 20 20 69 6e 66 6f 72 6d 61 74 ional. informat
4980: 69 6f 6e 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f ion..}..COMPILE_
4990: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 53 OPTION {SQLITE_S
49a0: 4f 55 4e 44 45 58 7d 20 7b 0a 20 20 54 68 69 73 OUNDEX} {. This
49b0: 20 6f 70 74 69 6f 6e 20 65 6e 61 62 6c 65 73 20 option enables
49c0: 74 68 65 20 5b 73 6f 75 6e 64 65 78 28 29 20 53 the [soundex() S
49d0: 51 4c 20 66 75 6e 63 74 69 6f 6e 5d 2e 0a 7d 0a QL function]..}.
49e0: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
49f0: 7b 59 59 54 52 41 43 4b 4d 41 58 53 54 41 43 4b {YYTRACKMAXSTACK
4a00: 44 45 50 54 48 7d 20 7b 0a 20 20 54 68 69 73 20 DEPTH} {. This
4a10: 6f 70 74 69 6f 6e 20 63 61 75 73 65 73 20 74 68 option causes th
4a20: 65 20 4c 41 4c 52 28 31 29 20 70 61 72 73 65 72 e LALR(1) parser
4a30: 20 73 74 61 63 6b 20 64 65 70 74 68 20 74 6f 20 stack depth to
4a40: 62 65 20 74 72 61 63 6b 65 64 0a 20 20 61 6e 64 be tracked. and
4a50: 20 72 65 70 6f 72 74 65 64 20 75 73 69 6e 67 20 reported using
4a60: 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 74 61 the [sqlite3_sta
4a70: 74 75 73 5d 28 5b 53 51 4c 49 54 45 5f 53 54 41 tus]([SQLITE_STA
4a80: 54 55 53 5f 50 41 52 53 45 52 5f 53 54 41 43 4b TUS_PARSER_STACK
4a90: 5d 2c 2e 2e 2e 29 0a 20 20 69 6e 74 65 72 66 61 ],...). interfa
4aa0: 63 65 2e 20 20 53 51 4c 69 74 65 27 73 20 4c 41 ce. SQLite's LA
4ab0: 4c 52 28 31 29 20 70 61 72 73 65 72 20 68 61 73 LR(1) parser has
4ac0: 20 61 20 66 69 78 65 64 20 73 74 61 63 6b 20 64 a fixed stack d
4ad0: 65 70 74 68 0a 20 20 28 64 65 74 65 72 6d 69 6e epth. (determin
4ae0: 65 64 20 61 74 20 63 6f 6d 70 69 6c 65 2d 74 69 ed at compile-ti
4af0: 6d 65 20 75 73 69 6e 67 20 74 68 65 20 5b 59 59 me using the [YY
4b00: 53 54 41 43 4b 44 45 50 54 48 5d 20 6f 70 74 69 STACKDEPTH] opti
4b10: 6f 6e 73 29 2e 0a 20 20 54 68 69 73 20 6f 70 74 ons).. This opt
4b20: 69 6f 6e 20 63 61 6e 20 62 65 20 75 73 65 64 20 ion can be used
4b30: 74 6f 20 68 65 6c 70 20 64 65 74 65 72 6d 69 6e to help determin
4b40: 65 20 69 66 20 61 6e 20 61 70 70 6c 69 63 61 74 e if an applicat
4b50: 69 6f 6e 20 69 73 0a 20 20 67 65 74 74 69 6e 67 ion is. getting
4b60: 20 63 6c 6f 73 65 20 74 6f 20 65 78 63 65 65 64 close to exceed
4b70: 69 6e 67 20 74 68 65 20 6d 61 78 69 6d 75 6d 20 ing the maximum
4b80: 4c 41 4c 52 28 31 29 20 73 74 61 63 6b 20 64 65 LALR(1) stack de
4b90: 70 74 68 2e 0a 7d 0a 3c 2f 74 63 6c 3e 0a 0a 3c pth..}.</tcl>..<
4ba0: 61 20 6e 61 6d 65 3d 22 64 69 73 61 62 6c 65 66 a name="disablef
4bb0: 65 61 74 75 72 65 73 22 3e 3c 2f 61 3e 0a 3c 68 eatures"></a>.<h
4bc0: 32 3e 31 2e 35 20 4f 70 74 69 6f 6e 73 20 54 6f 2>1.5 Options To
4bd0: 20 44 69 73 61 62 6c 65 20 46 65 61 74 75 72 65 Disable Feature
4be0: 73 20 4e 6f 72 6d 61 6c 6c 79 20 54 75 72 6e 65 s Normally Turne
4bf0: 64 20 4f 6e 3c 2f 68 32 3e 0a 0a 3c 74 63 6c 3e d On</h2>..<tcl>
4c00: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
4c10: 7b 53 51 4c 49 54 45 5f 44 49 53 41 42 4c 45 5f {SQLITE_DISABLE_
4c20: 4c 46 53 7d 20 7b 0a 20 20 49 66 20 74 68 69 73 LFS} {. If this
4c30: 20 43 2d 70 72 65 70 72 6f 63 65 73 73 6f 72 20 C-preprocessor
4c40: 6d 61 63 72 6f 20 69 73 20 64 65 66 69 6e 65 64 macro is defined
4c50: 2c 20 6c 61 72 67 65 20 66 69 6c 65 20 73 75 70 , large file sup
4c60: 70 6f 72 74 0a 20 20 69 73 20 64 69 73 61 62 6c port. is disabl
4c70: 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f ed..}..COMPILE_O
4c80: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 49 PTION {SQLITE_DI
4c90: 53 41 42 4c 45 5f 44 49 52 53 59 4e 43 7d 20 7b SABLE_DIRSYNC} {
4ca0: 0a 20 20 49 66 20 74 68 69 73 20 43 2d 70 72 65 . If this C-pre
4cb0: 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f 20 processor macro
4cc0: 69 73 20 64 65 66 69 6e 65 64 2c 20 64 69 72 65 is defined, dire
4cd0: 63 74 6f 72 79 20 73 79 6e 63 73 0a 20 20 61 72 ctory syncs. ar
4ce0: 65 20 64 69 73 61 62 6c 65 64 2e 20 20 53 51 4c e disabled. SQL
4cf0: 69 74 65 20 74 79 70 69 63 61 6c 6c 79 20 61 74 ite typically at
4d00: 74 65 6d 70 74 73 20 74 6f 20 73 79 6e 63 20 74 tempts to sync t
4d10: 68 65 20 70 61 72 65 6e 74 0a 20 20 64 69 72 65 he parent. dire
4d20: 63 74 6f 72 79 20 77 68 65 6e 20 61 20 66 69 6c ctory when a fil
4d30: 65 20 69 73 20 64 65 6c 65 74 65 64 20 74 6f 20 e is deleted to
4d40: 65 6e 73 75 72 65 20 74 68 65 20 64 69 72 65 63 ensure the direc
4d50: 74 6f 72 79 0a 20 20 65 6e 74 72 69 65 73 20 61 tory. entries a
4d60: 72 65 20 75 70 64 61 74 65 64 20 69 6d 6d 65 64 re updated immed
4d70: 69 61 74 65 6c 79 20 6f 6e 20 64 69 73 6b 2e 0a iately on disk..
4d80: 7d 0a 3c 2f 74 63 6c 3e 0a 0a 3c 74 63 6c 3e 0a }.</tcl>..<tcl>.
4d90: 20 20 68 64 5f 66 72 61 67 6d 65 6e 74 20 22 6f hd_fragment "o
4da0: 6d 69 74 66 65 61 74 75 72 65 73 22 0a 20 20 68 mitfeatures". h
4db0: 64 5f 6b 65 79 77 6f 72 64 73 20 22 6f 6d 69 74 d_keywords "omit
4dc0: 66 65 61 74 75 72 65 73 22 0a 3c 2f 74 63 6c 3e features".</tcl>
4dd0: 0a 3c 68 32 3e 31 2e 36 20 4f 70 74 69 6f 6e 73 .<h2>1.6 Options
4de0: 20 54 6f 20 4f 6d 69 74 20 46 65 61 74 75 72 65 To Omit Feature
4df0: 73 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65 20 66 s</h2>..<p>The f
4e00: 6f 6c 6c 6f 77 69 6e 67 20 6f 70 74 69 6f 6e 73 ollowing options
4e10: 20 63 61 6e 20 75 73 65 64 20 74 6f 20 72 65 64 can used to red
4e20: 75 63 65 20 74 68 65 20 73 69 7a 65 20 6f 66 20 uce the size of
4e30: 74 68 65 20 63 6f 6d 70 69 6c 65 64 0a 6c 69 62 the compiled.lib
4e40: 72 61 72 79 20 62 79 20 6f 6d 69 74 74 69 6e 67 rary by omitting
4e50: 20 6f 70 74 69 6f 6e 61 6c 20 66 65 61 74 75 72 optional featur
4e60: 65 73 2e 20 54 68 69 73 20 69 73 20 70 72 6f 62 es. This is prob
4e70: 61 62 6c 79 20 6f 6e 6c 79 20 75 73 65 66 75 6c ably only useful
4e80: 0a 69 6e 20 65 6d 62 65 64 64 65 64 20 73 79 73 .in embedded sys
4e90: 74 65 6d 73 20 77 68 65 72 65 20 73 70 61 63 65 tems where space
4ea0: 20 69 73 20 65 73 70 65 63 69 61 6c 6c 79 20 74 is especially t
4eb0: 69 67 68 74 2c 20 61 73 20 65 76 65 6e 20 77 69 ight, as even wi
4ec0: 74 68 20 61 6c 6c 0a 66 65 61 74 75 72 65 73 20 th all.features
4ed0: 69 6e 63 6c 75 64 65 64 20 74 68 65 20 53 51 4c included the SQL
4ee0: 69 74 65 20 6c 69 62 72 61 72 79 20 69 73 20 72 ite library is r
4ef0: 65 6c 61 74 69 76 65 6c 79 20 73 6d 61 6c 6c 2e elatively small.
4f00: 20 44 6f 6e 27 74 20 66 6f 72 67 65 74 0a 74 6f Don't forget.to
4f10: 20 74 65 6c 6c 20 79 6f 75 72 20 63 6f 6d 70 69 tell your compi
4f20: 6c 65 72 20 74 6f 20 6f 70 74 69 6d 69 7a 65 20 ler to optimize
4f30: 66 6f 72 20 62 69 6e 61 72 79 20 73 69 7a 65 21 for binary size!
4f40: 20 28 74 68 65 20 2d 4f 73 20 6f 70 74 69 6f 6e (the -Os option
4f50: 20 69 66 0a 75 73 69 6e 67 20 47 43 43 29 2e 20 if.using GCC).
4f60: 20 54 65 6c 6c 69 6e 67 20 79 6f 75 72 20 63 6f Telling your co
4f70: 6d 70 69 6c 65 72 20 74 6f 20 6f 70 74 69 6d 69 mpiler to optimi
4f80: 7a 65 20 66 6f 72 20 73 69 7a 65 20 75 73 75 61 ze for size usua
4f90: 6c 6c 79 20 68 61 73 0a 61 20 6d 75 63 68 20 6c lly has.a much l
4fa0: 61 72 67 65 72 20 69 6d 70 61 63 74 20 6f 6e 20 arger impact on
4fb0: 6c 69 62 72 61 72 79 20 66 6f 6f 74 70 72 69 6e library footprin
4fc0: 74 20 74 68 61 6e 20 65 6d 70 6c 6f 79 69 6e 67 t than employing
4fd0: 20 61 6e 79 20 6f 66 20 74 68 65 73 65 0a 63 6f any of these.co
4fe0: 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f mpile-time optio
4ff0: 6e 73 2e 20 20 59 6f 75 20 73 68 6f 75 6c 64 20 ns. You should
5000: 61 6c 73 6f 20 76 65 72 69 66 79 20 74 68 61 74 also verify that
5010: 20 0a 3c 61 20 68 72 65 66 3d 22 23 64 65 62 75 .<a href="#debu
5020: 67 6f 70 74 69 6f 6e 73 22 3e 64 65 62 75 67 67 goptions">debugg
5030: 69 6e 67 20 6f 70 74 69 6f 6e 73 3c 2f 61 3e 20 ing options</a>
5040: 61 72 65 20 64 69 73 61 62 6c 65 64 2e 3c 2f 70 are disabled.</p
5050: 3e 0a 0a 3c 70 3e 54 68 65 20 6d 61 63 72 6f 73 >..<p>The macros
5060: 20 69 6e 20 74 68 69 73 20 73 65 63 74 69 6f 6e in this section
5070: 20 64 6f 20 6e 6f 74 20 72 65 71 75 69 72 65 20 do not require
5080: 76 61 6c 75 65 73 2e 20 54 68 65 20 66 6f 6c 6c values. The foll
5090: 6f 77 69 6e 67 20 0a 63 6f 6d 70 69 6c 61 74 69 owing .compilati
50a0: 6f 6e 20 73 77 69 74 63 68 65 73 20 61 6c 6c 20 on switches all
50b0: 68 61 76 65 20 74 68 65 20 73 61 6d 65 20 65 66 have the same ef
50c0: 66 65 63 74 3a 3c 62 72 3e 0a 2d 44 53 51 4c 49 fect:<br>.-DSQLI
50d0: 54 45 5f 4f 4d 49 54 5f 41 4c 54 45 52 54 41 42 TE_OMIT_ALTERTAB
50e0: 4c 45 3c 62 72 3e 0a 2d 44 53 51 4c 49 54 45 5f LE<br>.-DSQLITE_
50f0: 4f 4d 49 54 5f 41 4c 54 45 52 54 41 42 4c 45 3d OMIT_ALTERTABLE=
5100: 31 3c 62 72 3e 0a 2d 44 53 51 4c 49 54 45 5f 4f 1<br>.-DSQLITE_O
5110: 4d 49 54 5f 41 4c 54 45 52 54 41 42 4c 45 3d 30 MIT_ALTERTABLE=0
5120: 0a 3c 2f 70 3e 0a 0a 3c 70 3e 49 66 20 61 6e 79 .</p>..<p>If any
5130: 20 6f 66 20 74 68 65 73 65 20 6f 70 74 69 6f 6e of these option
5140: 73 20 61 72 65 20 64 65 66 69 6e 65 64 2c 20 74 s are defined, t
5150: 68 65 6e 20 74 68 65 20 73 61 6d 65 20 73 65 74 hen the same set
5160: 20 6f 66 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f of SQLITE_OMIT_
5170: 2a 0a 6f 70 74 69 6f 6e 73 20 6d 75 73 74 20 61 *.options must a
5180: 6c 73 6f 20 62 65 20 64 65 66 69 6e 65 64 20 77 lso be defined w
5190: 68 65 6e 20 75 73 69 6e 67 20 74 68 65 20 27 6c hen using the 'l
51a0: 65 6d 6f 6e 27 20 74 6f 6f 6c 20 74 6f 20 67 65 emon' tool to ge
51b0: 6e 65 72 61 74 65 20 74 68 65 0a 70 61 72 73 65 nerate the.parse
51c0: 2e 63 20 66 69 6c 65 20 61 6e 64 20 77 68 65 6e .c file and when
51d0: 20 63 6f 6d 70 69 6c 69 6e 67 20 74 68 65 20 27 compiling the '
51e0: 6d 6b 6b 65 79 77 6f 72 64 68 61 73 68 27 20 74 mkkeywordhash' t
51f0: 6f 6f 6c 20 77 68 69 63 68 20 67 65 6e 65 72 61 ool which genera
5200: 74 65 73 20 0a 74 68 65 20 6b 65 79 77 6f 72 64 tes .the keyword
5210: 68 61 73 68 2e 68 20 66 69 6c 65 2e 0a 42 65 63 hash.h file..Bec
5220: 61 75 73 65 20 6f 66 20 74 68 69 73 2c 20 74 68 ause of this, th
5230: 65 73 65 20 6f 70 74 69 6f 6e 73 20 6d 61 79 20 ese options may
5240: 6f 6e 6c 79 20 62 65 20 75 73 65 64 20 77 68 65 only be used whe
5250: 6e 20 74 68 65 20 6c 69 62 72 61 72 79 20 69 73 n the library is
5260: 20 62 75 69 6c 74 0a 66 72 6f 6d 20 63 61 6e 6f built.from cano
5270: 6e 69 63 61 6c 20 73 6f 75 72 63 65 2c 20 6e 6f nical source, no
5280: 74 20 66 72 6f 6d 20 74 68 65 20 5b 61 6d 61 6c t from the [amal
5290: 67 61 6d 61 74 69 6f 6e 5d 20 6f 72 20 66 72 6f gamation] or fro
52a0: 6d 20 74 68 65 20 63 6f 6c 6c 65 63 74 69 6f 6e m the collection
52b0: 20 6f 66 0a 70 72 65 2d 70 61 63 6b 61 67 65 64 of.pre-packaged
52c0: 20 43 20 66 69 6c 65 73 20 70 72 6f 76 69 64 65 C files provide
52d0: 64 20 66 6f 72 20 6e 6f 6e 2d 55 6e 69 78 20 6c d for non-Unix l
52e0: 69 6b 65 20 70 6c 61 74 66 6f 72 6d 73 20 6f 6e ike platforms on
52f0: 20 74 68 65 20 77 65 62 73 69 74 65 2e 0a 41 6e the website..An
5300: 79 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 2a 20 y SQLITE_OMIT_*
5310: 6f 70 74 69 6f 6e 73 20 77 68 69 63 68 20 63 61 options which ca
5320: 6e 20 62 65 20 75 73 65 64 20 64 69 72 65 63 74 n be used direct
5330: 6c 79 20 77 69 74 68 20 74 68 65 20 5b 61 6d 61 ly with the [ama
5340: 6c 67 61 6d 61 74 69 6f 6e 5d 20 0a 61 72 65 20 lgamation] .are
5350: 6c 69 73 74 65 64 20 62 65 6c 6f 77 2c 20 68 6f listed below, ho
5360: 77 65 76 65 72 2c 20 74 68 65 20 77 61 72 6e 69 wever, the warni
5370: 6e 67 73 20 69 6e 20 74 68 65 20 66 6f 6c 6c 6f ngs in the follo
5380: 77 69 6e 67 20 70 61 72 61 67 72 61 70 68 20 73 wing paragraph s
5390: 68 6f 75 6c 64 20 62 65 20 6e 6f 74 65 64 2e 0a hould be noted..
53a0: 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 </p>..<blockquot
53b0: 65 3e 0a 3c 69 3e 3c 62 3e 49 6d 70 6f 72 74 61 e>.<i><b>Importa
53c0: 6e 74 20 4e 6f 74 65 3a 3c 2f 62 3e 20 54 68 65 nt Note:</b> The
53d0: 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 2a 20 6f SQLITE_OMIT_* o
53e0: 70 74 69 6f 6e 73 20 64 6f 20 6e 6f 74 20 77 6f ptions do not wo
53f0: 72 6b 20 77 69 74 68 20 74 68 65 0a 5b 61 6d 61 rk with the.[ama
5400: 6c 67 61 6d 61 74 69 6f 6e 5d 20 6f 72 20 77 69 lgamation] or wi
5410: 74 68 20 70 72 65 2d 70 61 63 6b 61 67 65 64 20 th pre-packaged
5420: 43 20 63 6f 64 65 20 66 69 6c 65 73 2e 20 20 53 C code files. S
5430: 51 4c 49 54 45 5f 4f 4d 49 54 5f 2a 20 63 6f 6d QLITE_OMIT_* com
5440: 70 69 6c 65 2d 74 69 6d 65 0a 6f 70 74 69 6f 6e pile-time.option
5450: 73 20 6f 6e 6c 79 20 77 6f 72 6b 20 63 6f 72 72 s only work corr
5460: 65 63 74 6c 79 20 77 68 65 6e 20 53 51 4c 69 74 ectly when SQLit
5470: 65 20 69 73 20 62 75 69 6c 74 20 66 72 6f 6d 20 e is built from
5480: 63 61 6e 6f 6e 69 63 61 6c 20 73 6f 75 72 63 65 canonical source
5490: 20 66 69 6c 65 73 2e 0a 3c 2f 69 3e 0a 3c 2f 62 files..</i>.</b
54a0: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 0a 3c 70 3e lockquote>...<p>
54b0: 53 70 65 63 69 61 6c 20 76 65 72 73 69 6f 6e 73 Special versions
54c0: 20 6f 66 20 74 68 65 20 53 51 4c 69 74 65 20 61 of the SQLite a
54d0: 6d 61 6c 67 61 6d 61 74 69 6f 6e 20 74 68 61 74 malgamation that
54e0: 20 64 6f 20 77 6f 72 6b 20 77 69 74 68 20 61 0a do work with a.
54f0: 70 72 65 64 65 74 65 72 6d 69 6e 65 64 20 73 65 predetermined se
5500: 74 20 6f 66 20 53 51 4c 49 54 45 5f 4f 4d 49 54 t of SQLITE_OMIT
5510: 5f 2a 20 6f 70 74 69 6f 6e 73 20 63 61 6e 20 62 _* options can b
5520: 65 20 67 65 6e 65 72 61 74 65 64 2e 20 20 54 6f e generated. To
5530: 20 64 6f 20 73 6f 2c 0a 6d 61 6b 65 20 61 20 63 do so,.make a c
5540: 6f 70 79 20 6f 66 20 74 68 65 20 4d 61 6b 65 66 opy of the Makef
5550: 69 6c 65 2e 6c 69 6e 75 78 2d 67 63 63 20 6d 61 ile.linux-gcc ma
5560: 6b 65 66 69 6c 65 20 74 65 6d 70 6c 61 74 65 20 kefile template
5570: 69 6e 20 74 68 65 20 63 61 6e 6f 6e 69 63 61 6c in the canonical
5580: 0a 73 6f 75 72 63 65 20 63 6f 64 65 20 64 69 73 .source code dis
5590: 74 72 69 62 75 74 69 6f 6e 2e 20 20 43 68 61 6e tribution. Chan
55a0: 67 65 20 74 68 65 20 6e 61 6d 65 20 6f 66 20 79 ge the name of y
55b0: 6f 75 72 20 63 6f 70 79 20 74 6f 20 73 69 6d 70 our copy to simp
55c0: 6c 79 20 22 4d 61 6b 65 66 69 6c 65 22 2e 0a 54 ly "Makefile"..T
55d0: 68 65 6e 20 65 64 69 74 20 22 4d 61 6b 65 66 69 hen edit "Makefi
55e0: 6c 65 22 20 74 6f 20 73 65 74 20 75 70 20 61 70 le" to set up ap
55f0: 70 72 6f 70 72 69 61 74 65 20 63 6f 6d 70 69 6c propriate compil
5600: 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 73 2e 20 e-time options.
5610: 20 54 68 65 6e 0a 74 79 70 65 3a 0a 3c 62 6c 6f Then.type:.<blo
5620: 63 6b 71 75 6f 74 65 3e 3c 74 74 3e 6d 61 6b 65 ckquote><tt>make
5630: 20 63 6c 65 61 6e 3b 20 6d 61 6b 65 20 73 71 6c clean; make sql
5640: 69 74 65 33 2e 63 3c 2f 74 74 3e 3c 2f 62 6c 6f ite3.c</tt></blo
5650: 63 6b 71 75 6f 74 65 3e 0a 54 68 65 20 72 65 73 ckquote>.The res
5660: 75 6c 74 69 6e 67 20 22 73 71 6c 69 74 65 33 2e ulting "sqlite3.
5670: 63 22 20 61 6d 61 6c 67 61 6d 61 74 69 6f 6e 20 c" amalgamation
5680: 63 6f 64 65 20 66 69 6c 65 20 28 61 6e 64 20 69 code file (and i
5690: 74 73 20 61 73 73 6f 63 69 61 74 65 64 0a 68 65 ts associated.he
56a0: 61 64 65 72 20 66 69 6c 65 20 22 73 71 6c 69 74 ader file "sqlit
56b0: 65 33 2e 68 22 29 20 63 61 6e 20 74 68 65 6e 20 e3.h") can then
56c0: 62 65 20 6d 6f 76 65 64 20 74 6f 20 61 20 6e 6f be moved to a no
56d0: 6e 2d 75 6e 69 78 20 70 6c 61 74 66 6f 72 6d 0a n-unix platform.
56e0: 66 6f 72 20 66 69 6e 61 6c 20 63 6f 6d 70 69 6c for final compil
56f0: 61 74 69 6f 6e 20 75 73 69 6e 67 20 61 20 6e 61 ation using a na
5700: 74 69 76 65 20 63 6f 6d 70 69 6c 65 72 2e 3c 2f tive compiler.</
5710: 70 3e 0a 0a 3c 70 3e 41 6c 6c 20 6f 66 20 74 68 p>..<p>All of th
5720: 65 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 2a 20 e SQLITE_OMIT_*
5730: 6f 70 74 69 6f 6e 73 20 61 72 65 20 75 6e 73 75 options are unsu
5740: 70 70 6f 72 74 65 64 2e 3c 2f 70 3e 0a 0a 3c 62 pported.</p>..<b
5750: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c 69 3e 3c 62 lockquote>.<i><b
5760: 3e 49 6d 70 6f 72 74 61 6e 74 20 4e 6f 74 65 3a >Important Note:
5770: 3c 2f 62 3e 0a 54 68 65 20 53 51 4c 49 54 45 5f </b>.The SQLITE_
5780: 4f 4d 49 54 5f 2a 20 63 6f 6d 70 69 6c 65 2d 74 OMIT_* compile-t
5790: 69 6d 65 20 6f 70 74 69 6f 6e 73 20 61 72 65 20 ime options are
57a0: 75 6e 73 75 70 70 6f 72 74 65 64 2e 0a 3c 2f 69 unsupported..</i
57b0: 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a ></blockquote>..
57c0: 3c 70 3e 0a 54 68 65 20 53 51 4c 49 54 45 5f 4f <p>.The SQLITE_O
57d0: 4d 49 54 5f 2a 20 63 6f 6d 70 69 6c 65 2d 74 69 MIT_* compile-ti
57e0: 6d 65 20 6f 70 74 69 6f 6e 73 20 61 72 65 20 75 me options are u
57f0: 73 75 61 6c 6c 79 20 75 6e 74 65 73 74 65 64 20 sually untested
5800: 61 6e 64 0a 61 72 65 20 61 6c 6d 6f 73 74 20 63 and.are almost c
5810: 65 72 74 61 69 6e 6c 79 20 75 6e 74 65 73 74 65 ertainly unteste
5820: 64 20 69 6e 20 63 6f 6d 62 69 6e 61 74 69 6f 6e d in combination
5830: 2e 0a 41 6e 79 20 6f 72 20 61 6c 6c 20 6f 66 20 ..Any or all of
5840: 74 68 65 73 65 20 6f 70 74 69 6f 6e 73 20 6d 61 these options ma
5850: 79 20 62 65 20 72 65 6d 6f 76 65 64 20 66 72 6f y be removed fro
5860: 6d 20 74 68 65 20 63 6f 64 65 20 69 6e 20 66 75 m the code in fu
5870: 74 75 72 65 20 72 65 6c 65 61 73 65 73 0a 61 6e ture releases.an
5880: 64 20 77 69 74 68 6f 75 74 20 77 61 72 6e 69 6e d without warnin
5890: 67 2e 20 20 46 6f 72 20 61 6e 79 20 70 61 72 74 g. For any part
58a0: 69 63 75 6c 61 72 20 72 65 6c 65 61 73 65 2c 20 icular release,
58b0: 73 6f 6d 65 20 6f 66 20 74 68 65 73 65 0a 6f 70 some of these.op
58c0: 74 69 6f 6e 73 20 6d 61 79 20 63 61 75 73 65 20 tions may cause
58d0: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 72 20 compile-time or
58e0: 72 75 6e 2d 74 69 6d 65 20 66 61 69 6c 75 72 65 run-time failure
58f0: 73 2c 20 70 61 72 74 69 63 75 6c 61 72 6c 79 0a s, particularly.
5900: 77 68 65 6e 20 75 73 65 64 20 69 6e 20 63 6f 6d when used in com
5910: 62 69 6e 61 74 69 6f 6e 20 77 69 74 68 20 6f 74 bination with ot
5920: 68 65 72 20 6f 70 74 69 6f 6e 73 2e 3c 2f 70 3e her options.</p>
5930: 0a 0a 3c 74 63 6c 3e 0a 43 4f 4d 50 49 4c 45 5f ..<tcl>.COMPILE_
5940: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f OPTION {SQLITE_O
5950: 4d 49 54 5f 41 4c 54 45 52 54 41 42 4c 45 7d 20 MIT_ALTERTABLE}
5960: 7b 0a 20 20 57 68 65 6e 20 74 68 69 73 20 6f 70 {. When this op
5970: 74 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 2c tion is defined,
5980: 20 74 68 65 20 0a 20 20 5b 41 4c 54 45 52 20 54 the . [ALTER T
5990: 41 42 4c 45 5d 20 63 6f 6d 6d 61 6e 64 20 69 73 ABLE] command is
59a0: 20 6e 6f 74 20 69 6e 63 6c 75 64 65 64 20 69 6e not included in
59b0: 20 74 68 65 20 0a 20 20 6c 69 62 72 61 72 79 2e the . library.
59c0: 20 45 78 65 63 75 74 69 6e 67 20 61 6e 20 5b 41 Executing an [A
59d0: 4c 54 45 52 20 54 41 42 4c 45 5d 20 73 74 61 74 LTER TABLE] stat
59e0: 65 6d 65 6e 74 20 63 61 75 73 65 73 20 61 20 70 ement causes a p
59f0: 61 72 73 65 20 65 72 72 6f 72 2e 0a 7d 0a 0a 43 arse error..}..C
5a00: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
5a10: 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 4e 41 4c 59 QLITE_OMIT_ANALY
5a20: 5a 45 7d 20 7b 0a 20 20 57 68 65 6e 20 74 68 69 ZE} {. When thi
5a30: 73 20 6f 70 74 69 6f 6e 20 69 73 20 64 65 66 69 s option is defi
5a40: 6e 65 64 2c 20 74 68 65 20 5b 41 4e 41 4c 59 5a ned, the [ANALYZ
5a50: 45 5d 20 63 6f 6d 6d 61 6e 64 20 69 73 20 6f 6d E] command is om
5a60: 69 74 74 65 64 20 66 72 6f 6d 0a 20 20 74 68 65 itted from. the
5a70: 20 62 75 69 6c 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 build..}..COMPI
5a80: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
5a90: 45 5f 4f 4d 49 54 5f 41 54 54 41 43 48 7d 20 7b E_OMIT_ATTACH} {
5aa0: 0a 20 20 57 68 65 6e 20 74 68 69 73 20 6f 70 74 . When this opt
5ab0: 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 2c 20 ion is defined,
5ac0: 74 68 65 20 5b 41 54 54 41 43 48 5d 20 61 6e 64 the [ATTACH] and
5ad0: 20 5b 44 45 54 41 43 48 5d 20 63 6f 6d 6d 61 6e [DETACH] comman
5ae0: 64 73 20 61 72 65 0a 20 20 6f 6d 69 74 74 65 64 ds are. omitted
5af0: 20 66 72 6f 6d 20 74 68 65 20 62 75 69 6c 64 2e from the build.
5b00: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
5b10: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
5b20: 41 55 54 48 4f 52 49 5a 41 54 49 4f 4e 7d 20 7b AUTHORIZATION} {
5b30: 0a 20 20 44 65 66 69 6e 69 6e 67 20 74 68 69 73 . Defining this
5b40: 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 74 68 option omits th
5b50: 65 20 61 75 74 68 6f 72 69 7a 61 74 69 6f 6e 20 e authorization
5b60: 63 61 6c 6c 62 61 63 6b 20 66 65 61 74 75 72 65 callback feature
5b70: 20 66 72 6f 6d 20 74 68 65 0a 20 20 6c 69 62 72 from the. libr
5b80: 61 72 79 2e 20 54 68 65 20 5b 73 71 6c 69 74 65 ary. The [sqlite
5b90: 33 5f 73 65 74 5f 61 75 74 68 6f 72 69 7a 65 72 3_set_authorizer
5ba0: 28 29 5d 20 41 50 49 20 66 75 6e 63 74 69 6f 6e ()] API function
5bb0: 20 69 73 20 6e 6f 74 20 70 72 65 73 65 6e 74 0a is not present.
5bc0: 20 20 69 6e 20 74 68 65 20 6c 69 62 72 61 72 79 in the library
5bd0: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
5be0: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 ION {SQLITE_OMIT
5bf0: 5f 41 55 54 4f 49 4e 43 52 45 4d 45 4e 54 7d 20 _AUTOINCREMENT}
5c00: 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 {. This option
5c10: 69 73 20 75 73 65 64 20 74 6f 20 6f 6d 69 74 20 is used to omit
5c20: 74 68 65 20 0a 20 20 5b 41 55 54 4f 49 4e 43 52 the . [AUTOINCR
5c30: 45 4d 45 4e 54 5d 20 66 75 6e 63 74 69 6f 6e 61 EMENT] functiona
5c40: 6c 69 74 79 2e 20 57 68 65 6e 20 74 68 69 73 20 lity. When this
5c50: 0a 20 20 69 73 20 6d 61 63 72 6f 20 69 73 20 64 . is macro is d
5c60: 65 66 69 6e 65 64 2c 20 63 6f 6c 75 6d 6e 73 20 efined, columns
5c70: 64 65 63 6c 61 72 65 64 20 61 73 20 0a 20 20 22 declared as . "
5c80: 5b 49 4e 54 45 47 45 52 20 50 52 49 4d 41 52 59 [INTEGER PRIMARY
5c90: 20 4b 45 59 5d 20 41 55 54 4f 49 4e 43 52 45 4d KEY] AUTOINCREM
5ca0: 45 4e 54 22 0a 20 20 62 65 68 61 76 65 20 69 6e ENT". behave in
5cb0: 20 74 68 65 20 73 61 6d 65 20 77 61 79 20 61 73 the same way as
5cc0: 20 63 6f 6c 75 6d 6e 73 20 64 65 63 6c 61 72 65 columns declare
5cd0: 64 20 61 73 20 22 5b 49 4e 54 45 47 45 52 20 50 d as "[INTEGER P
5ce0: 52 49 4d 41 52 59 20 4b 45 59 5d 22 20 77 68 65 RIMARY KEY]" whe
5cf0: 6e 20 61 20 0a 20 20 4e 55 4c 4c 20 69 73 20 69 n a . NULL is i
5d00: 6e 73 65 72 74 65 64 2e 20 54 68 65 20 73 71 6c nserted. The sql
5d10: 69 74 65 5f 73 65 71 75 65 6e 63 65 20 73 79 73 ite_sequence sys
5d20: 74 65 6d 20 74 61 62 6c 65 20 69 73 20 6e 65 69 tem table is nei
5d30: 74 68 65 72 20 63 72 65 61 74 65 64 2c 20 6e 6f ther created, no
5d40: 72 0a 20 20 72 65 73 70 65 63 74 65 64 20 69 66 r. respected if
5d50: 20 69 74 20 61 6c 72 65 61 64 79 20 65 78 69 73 it already exis
5d60: 74 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f ts..}..COMPILE_O
5d70: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d PTION {SQLITE_OM
5d80: 49 54 5f 41 55 54 4f 4d 41 54 49 43 5f 49 4e 44 IT_AUTOMATIC_IND
5d90: 45 58 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 EX} {. This opt
5da0: 69 6f 6e 20 69 73 20 75 73 65 64 20 74 6f 20 6f ion is used to o
5db0: 6d 69 74 20 74 68 65 20 0a 20 20 5b 61 75 74 6f mit the . [auto
5dc0: 6d 61 74 69 63 20 69 6e 64 65 78 69 6e 67 5d 20 matic indexing]
5dd0: 66 75 6e 63 74 69 6f 6e 61 6c 69 74 79 2e 0a 7d functionality..}
5de0: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
5df0: 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 55 {SQLITE_OMIT_AU
5e00: 54 4f 49 4e 49 54 7d 20 7b 0a 20 20 46 6f 72 20 TOINIT} {. For
5e10: 62 61 63 6b 77 61 72 64 73 20 63 6f 6d 70 61 74 backwards compat
5e20: 69 62 69 6c 69 74 79 20 77 69 74 68 20 6f 6c 64 ibility with old
5e30: 65 72 20 76 65 72 73 69 6f 6e 73 20 6f 66 20 53 er versions of S
5e40: 51 4c 69 74 65 20 74 68 61 74 20 6c 61 63 6b 0a QLite that lack.
5e50: 20 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 69 the [sqlite3_i
5e60: 6e 69 74 69 61 6c 69 7a 65 28 29 5d 20 69 6e 74 nitialize()] int
5e70: 65 72 66 61 63 65 2c 20 74 68 65 20 5b 73 71 6c erface, the [sql
5e80: 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 ite3_initialize(
5e90: 29 5d 20 69 6e 74 65 72 66 61 63 65 0a 20 20 69 )] interface. i
5ea0: 73 20 63 61 6c 6c 65 64 20 61 75 74 6f 6d 61 74 s called automat
5eb0: 69 63 61 6c 6c 79 20 75 70 6f 6e 20 65 6e 74 72 ically upon entr
5ec0: 79 20 74 6f 20 63 65 72 74 61 69 6e 20 6b 65 79 y to certain key
5ed0: 20 69 6e 74 65 72 66 61 63 65 73 20 73 75 63 68 interfaces such
5ee0: 20 61 73 0a 20 20 5b 73 71 6c 69 74 65 33 5f 6f as. [sqlite3_o
5ef0: 70 65 6e 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 pen()], [sqlite3
5f00: 5f 76 66 73 5f 72 65 67 69 73 74 65 72 28 29 5d _vfs_register()]
5f10: 2c 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 6d , and [sqlite3_m
5f20: 70 72 69 6e 74 66 28 29 5d 2e 0a 20 20 54 68 65 printf()].. The
5f30: 20 6f 76 65 72 68 65 61 64 20 6f 66 20 69 6e 76 overhead of inv
5f40: 6f 6b 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 69 oking [sqlite3_i
5f50: 6e 69 74 69 61 6c 69 7a 65 28 29 5d 20 61 75 74 nitialize()] aut
5f60: 6f 6d 61 74 69 63 61 6c 6c 79 20 69 6e 20 74 68 omatically in th
5f70: 69 73 0a 20 20 77 61 79 20 6d 61 79 20 62 65 20 is. way may be
5f80: 6f 6d 69 74 74 65 64 20 62 79 20 62 75 69 6c 64 omitted by build
5f90: 69 6e 67 20 53 51 4c 69 74 65 20 77 69 74 68 20 ing SQLite with
5fa0: 74 68 65 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f the SQLITE_OMIT_
5fb0: 41 55 54 4f 49 4e 49 54 0a 20 20 43 2d 70 72 65 AUTOINIT. C-pre
5fc0: 70 72 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f 2e processor macro.
5fd0: 20 20 57 68 65 6e 20 62 75 69 6c 74 20 75 73 69 When built usi
5fe0: 6e 67 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41 ng SQLITE_OMIT_A
5ff0: 55 54 4f 49 4e 49 54 2c 20 53 51 4c 69 74 65 0a UTOINIT, SQLite.
6000: 20 20 77 69 6c 6c 20 6e 6f 74 20 61 75 74 6f 6d will not autom
6010: 61 74 69 63 61 6c 6c 79 20 69 6e 69 74 69 61 6c atically initial
6020: 69 7a 65 20 69 74 73 65 6c 66 20 61 6e 64 20 74 ize itself and t
6030: 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 69 he application i
6040: 73 20 72 65 71 75 69 72 65 64 0a 20 20 74 6f 20 s required. to
6050: 69 6e 76 6f 6b 65 20 5b 73 71 6c 69 74 65 33 5f invoke [sqlite3_
6060: 69 6e 69 74 69 61 6c 69 7a 65 28 29 5d 20 64 69 initialize()] di
6070: 72 65 63 74 6c 79 20 70 72 69 6f 72 20 74 6f 20 rectly prior to
6080: 62 65 67 69 6e 6e 69 6e 67 20 75 73 65 20 6f 66 beginning use of
6090: 20 74 68 65 0a 20 20 53 51 4c 69 74 65 20 6c 69 the. SQLite li
60a0: 62 72 61 72 79 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c brary..}..COMPIL
60b0: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
60c0: 5f 4f 4d 49 54 5f 41 55 54 4f 52 45 53 45 54 7d _OMIT_AUTORESET}
60d0: 20 7b 0a 20 20 42 79 20 64 65 66 61 75 6c 74 2c {. By default,
60e0: 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 74 the [sqlite3_st
60f0: 65 70 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 ep()] interface
6100: 77 69 6c 6c 20 61 75 74 6f 6d 61 74 69 63 61 6c will automatical
6110: 6c 79 20 69 6e 76 6f 6b 65 0a 20 20 5b 73 71 6c ly invoke. [sql
6120: 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20 74 6f ite3_reset()] to
6130: 20 72 65 73 65 74 20 74 68 65 20 5b 70 72 65 70 reset the [prep
6140: 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 ared statement]
6150: 69 66 20 6e 65 63 65 73 73 61 72 79 2e 20 20 54 if necessary. T
6160: 68 69 73 0a 20 20 63 6f 6d 70 69 6c 65 2d 74 69 his. compile-ti
6170: 6d 65 20 6f 70 74 69 6f 6e 20 63 68 61 6e 67 65 me option change
6180: 73 20 74 68 61 74 20 62 65 68 61 76 69 6f 72 20 s that behavior
6190: 73 6f 20 74 68 61 74 20 5b 73 71 6c 69 74 65 33 so that [sqlite3
61a0: 5f 73 74 65 70 28 29 5d 20 77 69 6c 6c 0a 20 20 _step()] will.
61b0: 72 65 74 75 72 6e 20 5b 53 51 4c 49 54 45 5f 4d return [SQLITE_M
61c0: 49 53 55 53 45 5d 20 69 66 20 69 74 20 63 61 6c ISUSE] if it cal
61d0: 6c 65 64 20 61 67 61 69 6e 20 61 66 74 65 72 20 led again after
61e0: 72 65 74 75 72 6e 69 6e 67 20 61 6e 79 74 68 69 returning anythi
61f0: 6e 67 20 6f 74 68 65 72 0a 20 20 74 68 61 6e 20 ng other. than
6200: 5b 53 51 4c 49 54 45 5f 52 4f 57 5d 2c 20 5b 53 [SQLITE_ROW], [S
6210: 51 4c 49 54 45 5f 42 55 53 59 5d 2c 20 6f 72 20 QLITE_BUSY], or
6220: 5b 53 51 4c 49 54 45 5f 4c 4f 43 4b 45 44 5d 20 [SQLITE_LOCKED]
6230: 75 6e 6c 65 73 73 20 74 68 65 72 65 20 77 61 73 unless there was
6240: 20 61 6e 0a 20 20 69 6e 74 65 72 76 65 6e 69 6e an. intervenin
6250: 67 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 g call to [sqlit
6260: 65 33 5f 72 65 73 65 74 28 29 5d 2e 0a 0a 20 20 e3_reset()]...
6270: 49 6e 20 53 51 4c 69 74 65 20 76 65 72 73 69 6f In SQLite versio
6280: 6e 20 33 2e 36 2e 32 33 2e 31 20 61 6e 64 20 65 n 3.6.23.1 and e
6290: 61 72 6c 69 65 72 2c 20 5b 73 71 6c 69 74 65 33 arlier, [sqlite3
62a0: 5f 73 74 65 70 28 29 5d 20 75 73 65 64 20 74 6f _step()] used to
62b0: 20 61 6c 77 61 79 73 0a 20 20 72 65 74 75 72 6e always. return
62c0: 20 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 5d [SQLITE_MISUSE]
62d0: 20 69 66 20 69 74 20 77 61 73 20 69 6e 76 6f 6b if it was invok
62e0: 65 64 20 61 67 61 69 6e 20 61 66 74 65 72 20 72 ed again after r
62f0: 65 74 75 72 6e 69 6e 67 20 61 6e 79 74 68 69 6e eturning anythin
6300: 67 0a 20 20 6f 74 68 65 72 20 74 68 61 6e 20 5b g. other than [
6310: 53 51 4c 49 54 45 5f 52 4f 57 5d 20 77 69 74 68 SQLITE_ROW] with
6320: 6f 75 74 20 61 6e 20 69 6e 74 65 72 76 65 6e 69 out an interveni
6330: 6e 67 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c 69 ng call to [sqli
6340: 74 65 33 5f 72 65 73 65 74 28 29 5d 2e 0a 20 20 te3_reset()]..
6350: 54 68 69 73 20 63 61 75 73 65 64 20 70 72 6f 62 This caused prob
6360: 6c 65 6d 73 20 6f 6e 20 73 6f 6d 65 20 70 6f 6f lems on some poo
6370: 72 6c 79 20 77 72 69 74 74 65 6e 20 73 6d 61 72 rly written smar
6380: 74 70 68 6f 6e 65 20 61 70 70 6c 69 63 61 74 69 tphone applicati
6390: 6f 6e 73 20 77 68 69 63 68 0a 20 20 64 69 64 20 ons which. did
63a0: 6e 6f 74 20 63 6f 72 72 65 63 74 6c 79 20 68 61 not correctly ha
63b0: 6e 64 6c 65 20 74 68 65 20 5b 53 51 4c 49 54 45 ndle the [SQLITE
63c0: 5f 4c 4f 43 4b 45 44 5d 20 61 6e 64 20 5b 53 51 _LOCKED] and [SQ
63d0: 4c 49 54 45 5f 42 55 53 59 5d 20 65 72 72 6f 72 LITE_BUSY] error
63e0: 20 0a 20 20 72 65 74 75 72 6e 73 2e 20 20 52 61 . returns. Ra
63f0: 74 68 65 72 20 74 68 61 6e 20 66 69 78 20 74 68 ther than fix th
6400: 65 20 6d 61 6e 79 20 64 65 66 65 63 74 69 76 65 e many defective
6410: 20 73 6d 61 72 74 70 68 6f 6e 65 20 61 70 70 6c smartphone appl
6420: 69 63 61 74 69 6f 6e 73 2c 20 0a 20 20 74 68 65 ications, . the
6430: 20 62 65 68 61 76 69 6f 72 20 6f 66 20 53 51 4c behavior of SQL
6440: 69 74 65 20 77 61 73 20 63 68 61 6e 67 65 64 20 ite was changed
6450: 69 6e 20 33 2e 36 2e 32 33 2e 32 20 74 6f 20 61 in 3.6.23.2 to a
6460: 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 72 65 73 utomatically res
6470: 65 74 0a 20 20 74 68 65 20 70 72 65 70 61 72 65 et. the prepare
6480: 64 20 73 74 61 74 65 6d 65 6e 74 2e 20 20 42 75 d statement. Bu
6490: 74 20 74 68 61 74 20 63 68 61 6e 67 65 64 20 63 t that changed c
64a0: 61 75 73 65 64 20 69 73 73 75 65 73 20 69 6e 20 aused issues in
64b0: 6f 74 68 65 72 20 0a 20 20 69 6d 70 72 6f 70 65 other . imprope
64c0: 72 6c 79 20 69 6d 70 6c 65 6d 65 6e 74 65 64 20 rly implemented
64d0: 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 74 68 61 applications tha
64e0: 74 20 77 65 72 65 20 61 63 74 75 61 6c 6c 79 20 t were actually
64f0: 6c 6f 6f 6b 69 6e 67 0a 20 20 66 6f 72 20 61 6e looking. for an
6500: 20 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 5d [SQLITE_MISUSE]
6510: 20 72 65 74 75 72 6e 20 74 6f 20 74 65 72 6d 69 return to termi
6520: 6e 61 74 65 20 74 68 65 69 72 20 71 75 65 72 79 nate their query
6530: 20 6c 6f 6f 70 73 2e 20 20 28 41 6e 79 74 69 6d loops. (Anytim
6540: 65 0a 20 20 61 6e 20 61 70 70 6c 69 63 61 74 69 e. an applicati
6550: 6f 6e 20 67 65 74 73 20 61 6e 20 53 51 4c 49 54 on gets an SQLIT
6560: 45 5f 4d 49 53 55 53 45 20 65 72 72 6f 72 20 63 E_MISUSE error c
6570: 6f 64 65 20 66 72 6f 6d 20 53 51 4c 69 74 65 2c ode from SQLite,
6580: 20 74 68 61 74 20 6d 65 61 6e 73 20 74 68 65 0a that means the.
6590: 20 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 69 73 application is
65a0: 20 6d 69 73 75 73 69 6e 67 20 74 68 65 20 53 51 misusing the SQ
65b0: 4c 69 74 65 20 69 6e 74 65 72 66 61 63 65 20 61 Lite interface a
65c0: 6e 64 20 69 73 20 74 68 75 73 20 69 6e 63 6f 72 nd is thus incor
65d0: 72 65 63 74 6c 79 0a 20 20 69 6d 70 6c 65 6d 65 rectly. impleme
65e0: 6e 74 65 64 2e 29 20 20 54 68 65 20 53 51 4c 49 nted.) The SQLI
65f0: 54 45 5f 4f 4d 49 54 5f 41 55 54 4f 52 45 53 45 TE_OMIT_AUTORESE
6600: 54 20 69 6e 74 65 72 66 61 63 65 20 77 61 73 20 T interface was
6610: 61 64 64 65 64 20 74 6f 20 53 51 4c 69 74 65 0a added to SQLite.
6620: 20 20 76 65 72 73 69 6f 6e 20 33 2e 37 2e 35 20 version 3.7.5
6630: 69 6e 20 61 6e 20 65 66 66 6f 72 74 20 74 6f 20 in an effort to
6640: 67 65 74 20 61 6c 6c 20 6f 66 20 74 68 65 20 28 get all of the (
6650: 62 72 6f 6b 65 6e 29 0a 20 20 61 70 70 6c 69 63 broken). applic
6660: 61 74 69 6f 6e 73 20 74 6f 20 77 6f 72 6b 20 61 ations to work a
6670: 67 61 69 6e 20 77 69 74 68 6f 75 74 20 68 61 76 gain without hav
6680: 69 6e 67 20 74 6f 20 61 63 74 75 61 6c 6c 79 20 ing to actually
6690: 66 69 78 20 74 68 65 20 61 70 70 6c 69 63 61 74 fix the applicat
66a0: 69 6f 6e 73 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 ions..}..COMPILE
66b0: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
66c0: 4f 4d 49 54 5f 41 55 54 4f 56 41 43 55 55 4d 7d OMIT_AUTOVACUUM}
66d0: 20 7b 0a 20 20 49 66 20 74 68 69 73 20 6f 70 74 {. If this opt
66e0: 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 2c 20 ion is defined,
66f0: 74 68 65 20 6c 69 62 72 61 72 79 20 63 61 6e 6e the library cann
6700: 6f 74 20 63 72 65 61 74 65 20 6f 72 20 77 72 69 ot create or wri
6710: 74 65 20 74 6f 20 0a 20 20 64 61 74 61 62 61 73 te to . databas
6720: 65 73 20 74 68 61 74 20 73 75 70 70 6f 72 74 20 es that support
6730: 5b 61 75 74 6f 5f 76 61 63 75 75 6d 5d 2e 0a 20 [auto_vacuum]..
6740: 20 45 78 65 63 75 74 69 6e 67 20 61 20 5b 50 52 Executing a [PR
6750: 41 47 4d 41 20 61 75 74 6f 5f 76 61 63 75 75 6d AGMA auto_vacuum
6760: 5d 20 73 74 61 74 65 6d 65 6e 74 20 69 73 20 6e ] statement is n
6770: 6f 74 20 61 6e 20 65 72 72 6f 72 0a 20 20 28 73 ot an error. (s
6780: 69 6e 63 65 20 75 6e 6b 6e 6f 77 6e 20 50 52 41 ince unknown PRA
6790: 47 4d 41 73 20 61 72 65 20 73 69 6c 65 6e 74 6c GMAs are silentl
67a0: 79 20 69 67 6e 6f 72 65 64 29 2c 20 62 75 74 20 y ignored), but
67b0: 64 6f 65 73 20 6e 6f 74 20 72 65 74 75 72 6e 20 does not return
67c0: 61 20 76 61 6c 75 65 0a 20 20 6f 72 20 6d 6f 64 a value. or mod
67d0: 69 66 79 20 74 68 65 20 61 75 74 6f 2d 76 61 63 ify the auto-vac
67e0: 75 75 6d 20 66 6c 61 67 20 69 6e 20 74 68 65 20 uum flag in the
67f0: 64 61 74 61 62 61 73 65 20 66 69 6c 65 2e 20 49 database file. I
6800: 66 20 61 20 64 61 74 61 62 61 73 65 20 74 68 61 f a database tha
6810: 74 0a 20 20 73 75 70 70 6f 72 74 73 20 61 75 74 t. supports aut
6820: 6f 2d 76 61 63 75 75 6d 20 69 73 20 6f 70 65 6e o-vacuum is open
6830: 65 64 20 62 79 20 61 20 6c 69 62 72 61 72 79 20 ed by a library
6840: 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 74 68 compiled with th
6850: 69 73 20 6f 70 74 69 6f 6e 2c 20 69 74 0a 20 20 is option, it.
6860: 69 73 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 is automatically
6870: 20 6f 70 65 6e 65 64 20 69 6e 20 72 65 61 64 2d opened in read-
6880: 6f 6e 6c 79 20 6d 6f 64 65 2e 0a 7d 0a 0a 43 4f only mode..}..CO
6890: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 MPILE_OPTION {SQ
68a0: 4c 49 54 45 5f 4f 4d 49 54 5f 42 45 54 57 45 45 LITE_OMIT_BETWEE
68b0: 4e 5f 4f 50 54 49 4d 49 5a 41 54 49 4f 4e 7d 20 N_OPTIMIZATION}
68c0: 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 {. This option
68d0: 64 69 73 61 62 6c 65 73 20 74 68 65 20 75 73 65 disables the use
68e0: 20 6f 66 20 69 6e 64 69 63 65 73 20 77 69 74 68 of indices with
68f0: 20 57 48 45 52 45 20 63 6c 61 75 73 65 20 74 65 WHERE clause te
6900: 72 6d 73 0a 20 20 74 68 61 74 20 65 6d 70 6c 6f rms. that emplo
6910: 79 20 74 68 65 20 42 45 54 57 45 45 4e 20 6f 70 y the BETWEEN op
6920: 65 72 61 74 6f 72 2e 0a 7d 0a 0a 43 4f 4d 50 49 erator..}..COMPI
6930: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
6940: 45 5f 4f 4d 49 54 5f 42 4c 4f 42 5f 4c 49 54 45 E_OMIT_BLOB_LITE
6950: 52 41 4c 7d 20 7b 0a 20 20 57 68 65 6e 20 74 68 RAL} {. When th
6960: 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 64 65 66 is option is def
6970: 69 6e 65 64 2c 20 69 74 20 69 73 20 6e 6f 74 20 ined, it is not
6980: 70 6f 73 73 69 62 6c 65 20 74 6f 20 73 70 65 63 possible to spec
6990: 69 66 79 20 61 20 62 6c 6f 62 20 69 6e 0a 20 20 ify a blob in.
69a0: 61 6e 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 an SQL statement
69b0: 20 75 73 69 6e 67 20 74 68 65 20 58 27 41 42 43 using the X'ABC
69c0: 44 27 20 73 79 6e 74 61 78 2e 0a 7d 0a 0a 43 4f D' syntax..}..CO
69d0: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 MPILE_OPTION {SQ
69e0: 4c 49 54 45 5f 4f 4d 49 54 5f 42 54 52 45 45 43 LITE_OMIT_BTREEC
69f0: 4f 55 4e 54 7d 20 7b 0a 20 20 57 68 65 6e 20 74 OUNT} {. When t
6a00: 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 64 65 his option is de
6a10: 66 69 6e 65 64 2c 20 61 6e 20 6f 70 74 69 6d 69 fined, an optimi
6a20: 7a 61 74 69 6f 6e 20 74 68 61 74 20 61 63 63 65 zation that acce
6a30: 6c 65 72 61 74 65 73 20 63 6f 75 6e 74 69 6e 67 lerates counting
6a40: 0a 20 20 61 6c 6c 20 65 6e 74 72 69 65 73 20 69 . all entries i
6a50: 6e 20 61 20 74 61 62 6c 65 20 28 69 6e 20 6f 74 n a table (in ot
6a60: 68 65 72 20 77 6f 72 64 73 2c 20 61 6e 20 6f 70 her words, an op
6a70: 74 69 6d 69 7a 61 74 69 6f 6e 20 74 68 61 74 20 timization that
6a80: 68 65 6c 70 73 0a 20 20 22 53 45 4c 45 43 54 20 helps. "SELECT
6a90: 63 6f 75 6e 74 28 2a 29 20 46 52 4f 4d 20 74 61 count(*) FROM ta
6aa0: 62 6c 65 22 20 72 75 6e 20 66 61 73 74 65 72 29 ble" run faster)
6ab0: 20 69 73 20 6f 6d 69 74 74 65 64 2e 0a 7d 0a 0a is omitted..}..
6ac0: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
6ad0: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 42 55 49 4c SQLITE_OMIT_BUIL
6ae0: 54 49 4e 5f 54 45 53 54 7d 20 7b 0a 20 20 41 20 TIN_TEST} {. A
6af0: 73 74 61 6e 64 61 72 64 20 53 51 4c 69 74 65 20 standard SQLite
6b00: 62 75 69 6c 64 20 69 6e 63 6c 75 64 65 73 20 61 build includes a
6b10: 20 73 6d 61 6c 6c 20 61 6d 6f 75 6e 74 20 6f 66 small amount of
6b20: 20 6c 6f 67 69 63 20 63 6f 6e 74 72 6f 6c 6c 65 logic controlle
6b30: 64 0a 20 20 62 79 20 74 68 65 20 5b 73 71 6c 69 d. by the [sqli
6b40: 74 65 33 5f 74 65 73 74 5f 63 6f 6e 74 72 6f 6c te3_test_control
6b50: 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 74 68 ()] interface th
6b60: 61 74 20 69 73 20 75 73 65 64 20 74 6f 20 65 78 at is used to ex
6b70: 65 72 63 69 73 65 0a 20 20 70 61 72 74 73 20 6f ercise. parts o
6b80: 66 20 74 68 65 20 53 51 4c 69 74 65 20 63 6f 72 f the SQLite cor
6b90: 65 20 74 68 61 74 20 61 72 65 20 64 69 66 66 69 e that are diffi
6ba0: 63 75 6c 74 20 74 6f 20 63 6f 6e 74 72 6f 6c 20 cult to control
6bb0: 61 6e 64 20 6d 65 61 73 75 72 65 20 75 73 69 6e and measure usin
6bc0: 67 0a 20 20 74 68 65 20 73 74 61 6e 64 61 72 64 g. the standard
6bd0: 20 41 50 49 2e 20 20 54 68 69 73 20 6f 70 74 69 API. This opti
6be0: 6f 6e 20 6f 6d 69 74 73 20 74 68 61 74 20 62 75 on omits that bu
6bf0: 69 6c 74 2d 69 6e 20 74 65 73 74 20 6c 6f 67 69 ilt-in test logi
6c00: 63 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 c..}..COMPILE_OP
6c10: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 TION {SQLITE_OMI
6c20: 54 5f 43 41 53 54 7d 20 7b 0a 20 20 54 68 69 73 T_CAST} {. This
6c30: 20 6f 70 74 69 6f 6e 20 63 61 75 73 65 73 20 53 option causes S
6c40: 51 4c 69 74 65 20 74 6f 20 6f 6d 69 74 20 73 75 QLite to omit su
6c50: 70 70 6f 72 74 20 66 6f 72 20 74 68 65 20 43 41 pport for the CA
6c60: 53 54 20 6f 70 65 72 61 74 6f 72 2e 0a 7d 0a 0a ST operator..}..
6c70: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
6c80: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 43 48 45 43 SQLITE_OMIT_CHEC
6c90: 4b 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 K} {. This opti
6ca0: 6f 6e 20 63 61 75 73 65 73 20 53 51 4c 69 74 65 on causes SQLite
6cb0: 20 74 6f 20 6f 6d 69 74 20 73 75 70 70 6f 72 74 to omit support
6cc0: 20 66 6f 72 20 43 48 45 43 4b 20 63 6f 6e 73 74 for CHECK const
6cd0: 72 61 69 6e 74 73 2e 0a 20 20 54 68 65 20 70 61 raints.. The pa
6ce0: 72 73 65 72 20 77 69 6c 6c 20 73 74 69 6c 6c 20 rser will still
6cf0: 61 63 63 65 70 74 20 43 48 45 43 4b 20 63 6f 6e accept CHECK con
6d00: 73 74 72 61 69 6e 74 73 20 69 6e 20 53 51 4c 20 straints in SQL
6d10: 73 74 61 74 65 6d 65 6e 74 73 2c 0a 20 20 74 68 statements,. th
6d20: 65 79 20 77 69 6c 6c 20 6a 75 73 74 20 6e 6f 74 ey will just not
6d30: 20 62 65 20 65 6e 66 6f 72 63 65 64 2e 0a 7d 0a be enforced..}.
6d40: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
6d50: 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 43 4f 4d {SQLITE_OMIT_COM
6d60: 50 49 4c 45 4f 50 54 49 4f 4e 5f 44 49 41 47 53 PILEOPTION_DIAGS
6d70: 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f } {. This optio
6d80: 6e 20 69 73 20 75 73 65 64 20 74 6f 20 6f 6d 69 n is used to omi
6d90: 74 20 74 68 65 20 63 6f 6d 70 69 6c 65 2d 74 69 t the compile-ti
6da0: 6d 65 20 6f 70 74 69 6f 6e 20 64 69 61 67 6e 6f me option diagno
6db0: 73 74 69 63 73 20 61 76 61 69 6c 61 62 6c 65 0a stics available.
6dc0: 20 20 69 6e 20 53 51 4c 69 74 65 2c 20 69 6e 63 in SQLite, inc
6dd0: 6c 75 64 69 6e 67 20 74 68 65 20 5b 73 71 6c 69 luding the [sqli
6de0: 74 65 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f te3_compileoptio
6df0: 6e 5f 75 73 65 64 28 29 5d 20 61 6e 64 0a 20 20 n_used()] and.
6e00: 5b 73 71 6c 69 74 65 33 5f 63 6f 6d 70 69 6c 65 [sqlite3_compile
6e10: 6f 70 74 69 6f 6e 5f 67 65 74 28 29 5d 20 43 2f option_get()] C/
6e20: 43 2b 2b 20 66 75 6e 63 74 69 6f 6e 73 2c 20 74 C++ functions, t
6e30: 68 65 0a 20 20 5b 73 71 6c 69 74 65 5f 63 6f 6d he. [sqlite_com
6e40: 70 69 6c 65 6f 70 74 69 6f 6e 5f 75 73 65 64 28 pileoption_used(
6e50: 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 5f 63 )] and [sqlite_c
6e60: 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 67 65 74 ompileoption_get
6e70: 28 29 5d 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e ()] SQL function
6e80: 73 2c 0a 20 20 61 6e 64 20 74 68 65 20 5b 63 6f s,. and the [co
6e90: 6d 70 69 6c 65 5f 6f 70 74 69 6f 6e 73 20 70 72 mpile_options pr
6ea0: 61 67 6d 61 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c agma]..}..COMPIL
6eb0: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
6ec0: 5f 4f 4d 49 54 5f 43 4f 4d 50 4c 45 54 45 7d 20 _OMIT_COMPLETE}
6ed0: 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 {. This option
6ee0: 63 61 75 73 65 73 20 74 68 65 20 5b 73 71 6c 69 causes the [sqli
6ef0: 74 65 33 5f 63 6f 6d 70 6c 65 74 65 28 29 5d 20 te3_complete()]
6f00: 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6d and [sqlite3_com
6f10: 70 6c 65 74 65 31 36 28 29 5d 0a 20 20 69 6e 74 plete16()]. int
6f20: 65 72 66 61 63 65 73 20 74 6f 20 62 65 20 6f 6d erfaces to be om
6f30: 69 74 74 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c itted..}..COMPIL
6f40: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
6f50: 5f 4f 4d 49 54 5f 43 4f 4d 50 4f 55 4e 44 5f 53 _OMIT_COMPOUND_S
6f60: 45 4c 45 43 54 7d 20 7b 0a 20 20 54 68 69 73 20 ELECT} {. This
6f70: 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 20 74 option is used t
6f80: 6f 20 6f 6d 69 74 20 74 68 65 20 63 6f 6d 70 6f o omit the compo
6f90: 75 6e 64 20 5b 53 45 4c 45 43 54 5d 20 66 75 6e und [SELECT] fun
6fa0: 63 74 69 6f 6e 61 6c 69 74 79 2e 20 0a 20 20 5b ctionality. . [
6fb0: 53 45 4c 45 43 54 5d 20 73 74 61 74 65 6d 65 6e SELECT] statemen
6fc0: 74 73 20 74 68 61 74 20 75 73 65 20 74 68 65 20 ts that use the
6fd0: 0a 20 20 55 4e 49 4f 4e 2c 20 55 4e 49 4f 4e 20 . UNION, UNION
6fe0: 41 4c 4c 2c 20 49 4e 54 45 52 53 45 43 54 20 6f ALL, INTERSECT o
6ff0: 72 20 45 58 43 45 50 54 20 63 6f 6d 70 6f 75 6e r EXCEPT compoun
7000: 64 20 53 45 4c 45 43 54 20 6f 70 65 72 61 74 6f d SELECT operato
7010: 72 73 20 77 69 6c 6c 20 0a 20 20 63 61 75 73 65 rs will . cause
7020: 20 61 20 70 61 72 73 65 20 65 72 72 6f 72 2e 0a a parse error..
7030: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
7040: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 43 N {SQLITE_OMIT_C
7050: 4f 4e 46 4c 49 43 54 5f 43 4c 41 55 53 45 7d 20 ONFLICT_CLAUSE}
7060: 7b 0a 20 20 49 6e 20 74 68 65 20 66 75 74 75 72 {. In the futur
7070: 65 2c 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 77 e, this option w
7080: 69 6c 6c 20 62 65 20 75 73 65 64 20 74 6f 20 6f ill be used to o
7090: 6d 69 74 20 74 68 65 20 0a 20 20 5b 4f 4e 20 43 mit the . [ON C
70a0: 4f 4e 46 4c 49 43 54 5d 20 63 6c 61 75 73 65 20 ONFLICT] clause
70b0: 66 72 6f 6d 20 74 68 65 20 6c 69 62 72 61 72 79 from the library
70c0: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
70d0: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 ION {SQLITE_OMIT
70e0: 5f 44 41 54 45 54 49 4d 45 5f 46 55 4e 43 53 7d _DATETIME_FUNCS}
70f0: 20 7b 0a 20 20 49 66 20 74 68 69 73 20 6f 70 74 {. If this opt
7100: 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 2c 20 ion is defined,
7110: 53 51 4c 69 74 65 27 73 20 62 75 69 6c 74 2d 69 SQLite's built-i
7120: 6e 20 64 61 74 65 20 61 6e 64 20 74 69 6d 65 20 n date and time
7130: 6d 61 6e 69 70 75 6c 61 74 69 6f 6e 0a 20 20 66 manipulation. f
7140: 75 6e 63 74 69 6f 6e 73 20 61 72 65 20 6f 6d 69 unctions are omi
7150: 74 74 65 64 2e 20 53 70 65 63 69 66 69 63 61 6c tted. Specifical
7160: 6c 79 2c 20 74 68 65 20 53 51 4c 20 66 75 6e 63 ly, the SQL func
7170: 74 69 6f 6e 73 20 6a 75 6c 69 61 6e 64 61 79 28 tions julianday(
7180: 29 2c 20 64 61 74 65 28 29 2c 0a 20 20 74 69 6d ), date(),. tim
7190: 65 28 29 2c 20 64 61 74 65 74 69 6d 65 28 29 20 e(), datetime()
71a0: 61 6e 64 20 73 74 72 66 74 69 6d 65 28 29 20 61 and strftime() a
71b0: 72 65 20 6e 6f 74 20 61 76 61 69 6c 61 62 6c 65 re not available
71c0: 2e 20 54 68 65 20 64 65 66 61 75 6c 74 20 63 6f . The default co
71d0: 6c 75 6d 6e 0a 20 20 76 61 6c 75 65 73 20 43 55 lumn. values CU
71e0: 52 52 45 4e 54 5f 54 49 4d 45 2c 20 43 55 52 52 RRENT_TIME, CURR
71f0: 45 4e 54 5f 44 41 54 45 20 61 6e 64 20 43 55 52 ENT_DATE and CUR
7200: 52 45 4e 54 5f 44 41 54 45 54 49 4d 45 20 61 72 RENT_DATETIME ar
7210: 65 20 73 74 69 6c 6c 20 61 76 61 69 6c 61 62 6c e still availabl
7220: 65 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 e..}..COMPILE_OP
7230: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 TION {SQLITE_OMI
7240: 54 5f 44 45 43 4c 54 59 50 45 7d 20 7b 0a 20 20 T_DECLTYPE} {.
7250: 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 75 73 This option caus
7260: 65 73 20 53 51 4c 69 74 65 20 74 6f 20 6f 6d 69 es SQLite to omi
7270: 74 20 73 75 70 70 6f 72 74 20 66 6f 72 20 74 68 t support for th
7280: 65 0a 20 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c e. [sqlite3_col
7290: 75 6d 6e 5f 64 65 63 6c 74 79 70 65 28 29 5d 20 umn_decltype()]
72a0: 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c and [sqlite3_col
72b0: 75 6d 6e 5f 64 65 63 6c 74 79 70 65 31 36 28 29 umn_decltype16()
72c0: 5d 0a 20 20 69 6e 74 65 72 66 61 63 65 73 2e 0a ]. interfaces..
72d0: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
72e0: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 44 N {SQLITE_OMIT_D
72f0: 45 50 52 45 43 41 54 45 44 7d 20 7b 0a 20 20 54 EPRECATED} {. T
7300: 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 75 73 65 his option cause
7310: 73 20 53 51 4c 69 74 65 20 74 6f 20 6f 6d 69 74 s SQLite to omit
7320: 20 73 75 70 70 6f 72 74 20 66 6f 72 20 69 6e 74 support for int
7330: 65 72 66 61 63 65 73 0a 20 20 6d 61 72 6b 65 64 erfaces. marked
7340: 20 61 73 20 64 65 70 72 65 63 61 74 65 64 2e 20 as deprecated.
7350: 20 54 68 69 73 20 69 6e 63 6c 75 64 65 73 20 0a This includes .
7360: 20 20 5b 73 71 6c 69 74 65 33 5f 61 67 67 72 65 [sqlite3_aggre
7370: 67 61 74 65 5f 63 6f 75 6e 74 28 29 5d 2c 0a 20 gate_count()],.
7380: 20 5b 73 71 6c 69 74 65 33 5f 65 78 70 69 72 65 [sqlite3_expire
7390: 64 28 29 5d 2c 0a 20 20 5b 73 71 6c 69 74 65 33 d()],. [sqlite3
73a0: 5f 74 72 61 6e 73 66 65 72 5f 62 69 6e 64 69 6e _transfer_bindin
73b0: 67 73 28 29 5d 2c 0a 20 20 5b 73 71 6c 69 74 65 gs()],. [sqlite
73c0: 33 5f 67 6c 6f 62 61 6c 5f 72 65 63 6f 76 65 72 3_global_recover
73d0: 28 29 5d 2c 0a 20 20 5b 73 71 6c 69 74 65 33 5f ()],. [sqlite3_
73e0: 74 68 72 65 61 64 5f 63 6c 65 61 6e 75 70 28 29 thread_cleanup()
73f0: 5d 20 61 6e 64 0a 20 20 5b 73 71 6c 69 74 65 33 ] and. [sqlite3
7400: 5f 6d 65 6d 6f 72 79 5f 61 6c 61 72 6d 28 29 5d _memory_alarm()]
7410: 20 69 6e 74 65 72 66 61 63 65 73 2e 0a 7d 0a 0a interfaces..}..
7420: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
7430: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 44 49 53 4b SQLITE_OMIT_DISK
7440: 49 4f 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 IO} {. This opt
7450: 69 6f 6e 20 6f 6d 69 74 73 20 61 6c 6c 20 73 75 ion omits all su
7460: 70 70 6f 72 74 20 66 6f 72 20 77 72 69 74 69 6e pport for writin
7470: 67 20 74 6f 20 74 68 65 20 64 69 73 6b 20 61 6e g to the disk an
7480: 64 20 66 6f 72 63 65 73 0a 20 20 64 61 74 61 62 d forces. datab
7490: 61 73 65 73 20 74 6f 20 65 78 69 73 74 20 69 6e ases to exist in
74a0: 20 6d 65 6d 6f 72 79 20 6f 6e 6c 79 2e 20 20 54 memory only. T
74b0: 68 69 73 20 6f 70 74 69 6f 6e 20 68 61 73 20 6e his option has n
74c0: 6f 74 20 62 65 65 6e 20 0a 20 20 6d 61 69 6e 74 ot been . maint
74d0: 61 69 6e 65 64 20 61 6e 64 20 70 72 6f 62 61 62 ained and probab
74e0: 6c 79 20 64 6f 65 73 20 6e 6f 74 20 77 6f 72 6b ly does not work
74f0: 20 77 69 74 68 20 6e 65 77 65 72 20 76 65 72 73 with newer vers
7500: 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74 65 2e 0a ions of SQLite..
7510: 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f }..COMPILE_OPTIO
7520: 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 45 N {SQLITE_OMIT_E
7530: 58 50 4c 41 49 4e 7d 20 7b 0a 20 20 44 65 66 69 XPLAIN} {. Defi
7540: 6e 69 6e 67 20 74 68 69 73 20 6f 70 74 69 6f 6e ning this option
7550: 20 63 61 75 73 65 73 20 74 68 65 20 5b 45 58 50 causes the [EXP
7560: 4c 41 49 4e 5d 20 63 6f 6d 6d 61 6e 64 20 74 6f LAIN] command to
7570: 20 62 65 20 6f 6d 69 74 74 65 64 20 66 72 6f 6d be omitted from
7580: 20 74 68 65 0a 20 20 6c 69 62 72 61 72 79 2e 20 the. library.
7590: 41 74 74 65 6d 70 74 69 6e 67 20 74 6f 20 65 78 Attempting to ex
75a0: 65 63 75 74 65 20 61 6e 20 5b 45 58 50 4c 41 49 ecute an [EXPLAI
75b0: 4e 5d 20 73 74 61 74 65 6d 65 6e 74 20 77 69 6c N] statement wil
75c0: 6c 20 63 61 75 73 65 20 61 20 70 61 72 73 65 0a l cause a parse.
75d0: 20 20 65 72 72 6f 72 2e 0a 7d 0a 0a 43 4f 4d 50 error..}..COMP
75e0: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
75f0: 54 45 5f 4f 4d 49 54 5f 46 4c 41 47 5f 50 52 41 TE_OMIT_FLAG_PRA
7600: 47 4d 41 53 7d 20 7b 0a 20 20 54 68 69 73 20 6f GMAS} {. This o
7610: 70 74 69 6f 6e 20 6f 6d 69 74 73 20 73 75 70 70 ption omits supp
7620: 6f 72 74 20 66 6f 72 20 61 20 73 75 62 73 65 74 ort for a subset
7630: 20 6f 66 20 5b 50 52 41 47 4d 41 5d 20 63 6f 6d of [PRAGMA] com
7640: 6d 61 6e 64 73 20 74 68 61 74 0a 20 20 71 75 65 mands that. que
7650: 72 79 20 61 6e 64 20 73 65 74 20 62 6f 6f 6c 65 ry and set boole
7660: 61 6e 20 70 72 6f 70 65 72 74 69 65 73 2e 0a 7d an properties..}
7670: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
7680: 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 46 4c {SQLITE_OMIT_FL
7690: 4f 41 54 49 4e 47 5f 50 4f 49 4e 54 7d 20 7b 0a OATING_POINT} {.
76a0: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 This option is
76b0: 20 75 73 65 64 20 74 6f 20 6f 6d 69 74 20 66 6c used to omit fl
76c0: 6f 61 74 69 6e 67 2d 70 6f 69 6e 74 20 6e 75 6d oating-point num
76d0: 62 65 72 20 73 75 70 70 6f 72 74 20 66 72 6f 6d ber support from
76e0: 20 74 68 65 20 53 51 4c 69 74 65 0a 20 20 6c 69 the SQLite. li
76f0: 62 72 61 72 79 2e 20 57 68 65 6e 20 73 70 65 63 brary. When spec
7700: 69 66 69 65 64 2c 20 73 70 65 63 69 66 79 69 6e ified, specifyin
7710: 67 20 61 20 66 6c 6f 61 74 69 6e 67 20 70 6f 69 g a floating poi
7720: 6e 74 20 6e 75 6d 62 65 72 20 61 73 20 61 20 6c nt number as a l
7730: 69 74 65 72 61 6c 20 0a 20 20 28 69 2e 65 2e 20 iteral . (i.e.
7740: 22 31 2e 30 31 22 29 20 72 65 73 75 6c 74 73 20 "1.01") results
7750: 69 6e 20 61 20 70 61 72 73 65 20 65 72 72 6f 72 in a parse error
7760: 2e 0a 0a 20 20 3c 70 3e 49 6e 20 74 68 65 20 66 ... <p>In the f
7770: 75 74 75 72 65 2c 20 74 68 69 73 20 6f 70 74 69 uture, this opti
7780: 6f 6e 20 6d 61 79 20 61 6c 73 6f 20 64 69 73 61 on may also disa
7790: 62 6c 65 20 6f 74 68 65 72 20 66 6c 6f 61 74 69 ble other floati
77a0: 6e 67 20 70 6f 69 6e 74 20 0a 20 20 66 75 6e 63 ng point . func
77b0: 74 69 6f 6e 61 6c 69 74 79 2c 20 66 6f 72 20 65 tionality, for e
77c0: 78 61 6d 70 6c 65 20 74 68 65 20 5b 73 71 6c 69 xample the [sqli
77d0: 74 65 33 5f 72 65 73 75 6c 74 5f 64 6f 75 62 6c te3_result_doubl
77e0: 65 28 29 5d 2c 20 0a 20 20 5b 73 71 6c 69 74 65 e()], . [sqlite
77f0: 33 5f 62 69 6e 64 5f 64 6f 75 62 6c 65 28 29 5d 3_bind_double()]
7800: 2c 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 , [sqlite3_value
7810: 5f 64 6f 75 62 6c 65 28 29 5d 20 61 6e 64 0a 20 _double()] and.
7820: 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e [sqlite3_column
7830: 5f 64 6f 75 62 6c 65 28 29 5d 20 41 50 49 20 66 _double()] API f
7840: 75 6e 63 74 69 6f 6e 73 2e 0a 20 20 3c 2f 70 3e unctions.. </p>
7850: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
7860: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
7870: 46 4f 52 45 49 47 4e 5f 4b 45 59 7d 20 7b 0a 20 FOREIGN_KEY} {.
7880: 20 49 66 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 If this option
7890: 69 73 20 64 65 66 69 6e 65 64 2c 20 74 68 65 6e is defined, then
78a0: 20 5b 66 6f 72 65 69 67 6e 20 6b 65 79 20 63 6f [foreign key co
78b0: 6e 73 74 72 61 69 6e 74 5d 20 73 79 6e 74 61 78 nstraint] syntax
78c0: 20 69 73 0a 20 20 6e 6f 74 20 72 65 63 6f 67 6e is. not recogn
78d0: 69 7a 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 ized..}..COMPILE
78e0: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
78f0: 4f 4d 49 54 5f 47 45 54 5f 54 41 42 4c 45 7d 20 OMIT_GET_TABLE}
7900: 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 {. This option
7910: 63 61 75 73 65 73 20 73 75 70 70 6f 72 74 20 66 causes support f
7920: 6f 72 20 5b 73 71 6c 69 74 65 33 5f 67 65 74 5f or [sqlite3_get_
7930: 74 61 62 6c 65 28 29 5d 20 61 6e 64 0a 20 20 5b table()] and. [
7940: 73 71 6c 69 74 65 33 5f 66 72 65 65 5f 74 61 62 sqlite3_free_tab
7950: 6c 65 28 29 5d 20 74 6f 20 62 65 20 6f 6d 69 74 le()] to be omit
7960: 74 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f ted..}..COMPILE_
7970: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f OPTION {SQLITE_O
7980: 4d 49 54 5f 49 4e 43 52 42 4c 4f 42 7d 20 7b 0a MIT_INCRBLOB} {.
7990: 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 This option ca
79a0: 75 73 65 73 20 73 75 70 70 6f 72 74 20 66 6f 72 uses support for
79b0: 20 5b 73 71 6c 69 74 65 33 5f 62 6c 6f 62 20 7c [sqlite3_blob |
79c0: 20 69 6e 63 72 65 6d 65 6e 74 61 6c 20 42 4c 4f incremental BLO
79d0: 42 20 49 2f 4f 5d 0a 20 20 74 6f 20 62 65 20 6f B I/O]. to be o
79e0: 6d 69 74 74 65 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 mitted..}..COMPI
79f0: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
7a00: 45 5f 4f 4d 49 54 5f 49 4e 54 45 47 52 49 54 59 E_OMIT_INTEGRITY
7a10: 5f 43 48 45 43 4b 7d 20 7b 0a 20 20 54 68 69 73 _CHECK} {. This
7a20: 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 73 75 option omits su
7a30: 70 70 6f 72 74 20 66 6f 72 20 74 68 65 20 5b 69 pport for the [i
7a40: 6e 74 65 67 72 69 74 79 5f 63 68 65 63 6b 20 70 ntegrity_check p
7a50: 72 61 67 6d 61 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 ragma]..}..COMPI
7a60: 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 LE_OPTION {SQLIT
7a70: 45 5f 4f 4d 49 54 5f 4c 49 4b 45 5f 4f 50 54 49 E_OMIT_LIKE_OPTI
7a80: 4d 49 5a 41 54 49 4f 4e 7d 20 7b 0a 20 20 54 68 MIZATION} {. Th
7a90: 69 73 20 6f 70 74 69 6f 6e 20 64 69 73 61 62 6c is option disabl
7aa0: 65 73 20 74 68 65 20 61 62 69 6c 69 74 79 20 6f es the ability o
7ab0: 66 20 53 51 4c 69 74 65 20 74 6f 20 75 73 65 20 f SQLite to use
7ac0: 69 6e 64 69 63 65 73 20 74 6f 20 68 65 6c 70 0a indices to help.
7ad0: 20 20 72 65 73 6f 6c 76 65 20 5b 4c 49 4b 45 5d resolve [LIKE]
7ae0: 20 61 6e 64 20 5b 47 4c 4f 42 5d 20 6f 70 65 72 and [GLOB] oper
7af0: 61 74 6f 72 73 20 69 6e 20 61 20 57 48 45 52 45 ators in a WHERE
7b00: 20 63 6c 61 75 73 65 2e 0a 7d 0a 0a 43 4f 4d 50 clause..}..COMP
7b10: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
7b20: 54 45 5f 4f 4d 49 54 5f 4c 4f 41 44 5f 45 58 54 TE_OMIT_LOAD_EXT
7b30: 45 4e 53 49 4f 4e 7d 20 7b 0a 20 20 54 68 69 73 ENSION} {. This
7b40: 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 74 68 option omits th
7b50: 65 20 65 6e 74 69 72 65 20 65 78 74 65 6e 73 69 e entire extensi
7b60: 6f 6e 20 6c 6f 61 64 69 6e 67 20 6d 65 63 68 61 on loading mecha
7b70: 6e 69 73 6d 20 66 72 6f 6d 0a 20 20 53 51 4c 69 nism from. SQLi
7b80: 74 65 2c 20 69 6e 63 6c 75 64 69 6e 67 20 5b 73 te, including [s
7b90: 71 6c 69 74 65 33 5f 65 6e 61 62 6c 65 5f 6c 6f qlite3_enable_lo
7ba0: 61 64 5f 65 78 74 65 6e 73 69 6f 6e 28 29 5d 20 ad_extension()]
7bb0: 61 6e 64 0a 20 20 5b 73 71 6c 69 74 65 33 5f 6c and. [sqlite3_l
7bc0: 6f 61 64 5f 65 78 74 65 6e 73 69 6f 6e 28 29 5d oad_extension()]
7bd0: 20 69 6e 74 65 72 66 61 63 65 73 2e 0a 7d 0a 0a interfaces..}..
7be0: 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b COMPILE_OPTION {
7bf0: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 4c 4f 43 41 SQLITE_OMIT_LOCA
7c00: 4c 54 49 4d 45 7d 20 7b 0a 20 20 54 68 69 73 20 LTIME} {. This
7c10: 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 74 68 65 option omits the
7c20: 20 22 6c 6f 63 61 6c 74 69 6d 65 22 20 6d 6f 64 "localtime" mod
7c30: 69 66 69 65 72 20 66 72 6f 6d 20 74 68 65 20 64 ifier from the d
7c40: 61 74 65 20 61 6e 64 20 74 69 6d 65 0a 20 20 66 ate and time. f
7c50: 75 6e 63 74 69 6f 6e 73 2e 20 20 54 68 69 73 20 unctions. This
7c60: 6f 70 74 69 6f 6e 20 69 73 20 73 6f 6d 65 74 69 option is someti
7c70: 6d 65 73 20 75 73 65 66 75 6c 20 77 68 65 6e 20 mes useful when
7c80: 74 72 79 69 6e 67 20 74 6f 20 63 6f 6d 70 69 6c trying to compil
7c90: 65 0a 20 20 74 68 65 20 64 61 74 65 20 61 6e 64 e. the date and
7ca0: 20 74 69 6d 65 20 66 75 6e 63 74 69 6f 6e 73 20 time functions
7cb0: 6f 6e 20 61 20 70 6c 61 74 66 6f 72 6d 20 74 68 on a platform th
7cc0: 61 74 20 64 6f 65 73 20 6e 6f 74 20 73 75 70 70 at does not supp
7cd0: 6f 72 74 20 74 68 65 0a 20 20 63 6f 6e 63 65 70 ort the. concep
7ce0: 74 20 6f 66 20 6c 6f 63 61 6c 20 74 69 6d 65 2e t of local time.
7cf0: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
7d00: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
7d10: 4c 4f 4f 4b 41 53 49 44 45 7d 20 7b 0a 20 20 54 LOOKASIDE} {. T
7d20: 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 his option omits
7d30: 20 74 68 65 20 5b 6c 6f 6f 6b 61 73 69 64 65 20 the [lookaside
7d40: 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 memory allocator
7d50: 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 ]..}..COMPILE_OP
7d60: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 TION {SQLITE_OMI
7d70: 54 5f 4d 45 4d 4f 52 59 44 42 7d 20 7b 0a 20 20 T_MEMORYDB} {.
7d80: 57 68 65 6e 20 74 68 69 73 20 69 73 20 64 65 66 When this is def
7d90: 69 6e 65 64 2c 20 74 68 65 20 6c 69 62 72 61 72 ined, the librar
7da0: 79 20 64 6f 65 73 20 6e 6f 74 20 72 65 73 70 65 y does not respe
7db0: 63 74 20 74 68 65 20 73 70 65 63 69 61 6c 20 64 ct the special d
7dc0: 61 74 61 62 61 73 65 0a 20 20 6e 61 6d 65 20 22 atabase. name "
7dd0: 3a 6d 65 6d 6f 72 79 3a 22 20 28 6e 6f 72 6d 61 :memory:" (norma
7de0: 6c 6c 79 20 75 73 65 64 20 74 6f 20 63 72 65 61 lly used to crea
7df0: 74 65 20 61 6e 20 5b 69 6e 2d 6d 65 6d 6f 72 79 te an [in-memory
7e00: 20 64 61 74 61 62 61 73 65 5d 29 2e 20 49 66 20 database]). If
7e10: 0a 20 20 22 3a 6d 65 6d 6f 72 79 3a 22 20 69 73 . ":memory:" is
7e20: 20 70 61 73 73 65 64 20 74 6f 20 5b 73 71 6c 69 passed to [sqli
7e30: 74 65 33 5f 6f 70 65 6e 28 29 5d 2c 20 5b 73 71 te3_open()], [sq
7e40: 6c 69 74 65 33 5f 6f 70 65 6e 31 36 28 29 5d 2c lite3_open16()],
7e50: 20 6f 72 0a 20 20 5b 73 71 6c 69 74 65 33 5f 6f or. [sqlite3_o
7e60: 70 65 6e 5f 76 32 28 29 5d 2c 20 61 20 66 69 6c pen_v2()], a fil
7e70: 65 20 77 69 74 68 20 74 68 69 73 20 6e 61 6d 65 e with this name
7e80: 20 77 69 6c 6c 20 62 65 20 0a 20 20 6f 70 65 6e will be . open
7e90: 65 64 20 6f 72 20 63 72 65 61 74 65 64 2e 0a 7d ed or created..}
7ea0: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
7eb0: 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 4f 52 {SQLITE_OMIT_OR
7ec0: 5f 4f 50 54 49 4d 49 5a 41 54 49 4f 4e 7d 20 7b _OPTIMIZATION} {
7ed0: 0a 20 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 64 . This option d
7ee0: 69 73 61 62 6c 65 73 20 74 68 65 20 61 62 69 6c isables the abil
7ef0: 69 74 79 20 6f 66 20 53 51 4c 69 74 65 20 74 6f ity of SQLite to
7f00: 20 75 73 65 20 61 6e 20 69 6e 64 65 78 20 74 6f use an index to
7f10: 67 65 74 68 65 72 0a 20 20 77 69 74 68 20 74 65 gether. with te
7f20: 72 6d 73 20 6f 66 20 61 20 57 48 45 52 45 20 63 rms of a WHERE c
7f30: 6c 61 75 73 65 20 63 6f 6e 6e 65 63 74 65 64 20 lause connected
7f40: 62 79 20 74 68 65 20 4f 52 20 6f 70 65 72 61 74 by the OR operat
7f50: 6f 72 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f or..}..COMPILE_O
7f60: 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d PTION {SQLITE_OM
7f70: 49 54 5f 50 41 47 45 52 5f 50 52 41 47 4d 41 53 IT_PAGER_PRAGMAS
7f80: 7d 20 7b 0a 20 20 44 65 66 69 6e 69 6e 67 20 74 } {. Defining t
7f90: 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 his option omits
7fa0: 20 70 72 61 67 6d 61 73 20 72 65 6c 61 74 65 64 pragmas related
7fb0: 20 74 6f 20 74 68 65 20 70 61 67 65 72 20 73 75 to the pager su
7fc0: 62 73 79 73 74 65 6d 20 66 72 6f 6d 20 0a 20 20 bsystem from .
7fd0: 74 68 65 20 62 75 69 6c 64 2e 0a 7d 0a 0a 43 4f the build..}..CO
7fe0: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 MPILE_OPTION {SQ
7ff0: 4c 49 54 45 5f 4f 4d 49 54 5f 50 52 41 47 4d 41 LITE_OMIT_PRAGMA
8000: 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 6f } {. This optio
8010: 6e 20 69 73 20 75 73 65 64 20 74 6f 20 6f 6d 69 n is used to omi
8020: 74 20 74 68 65 20 5b 50 52 41 47 4d 41 5d 20 63 t the [PRAGMA] c
8030: 6f 6d 6d 61 6e 64 0a 20 20 66 72 6f 6d 20 74 68 ommand. from th
8040: 65 20 6c 69 62 72 61 72 79 2e 20 4e 6f 74 65 20 e library. Note
8050: 74 68 61 74 20 69 74 20 69 73 20 75 73 65 66 75 that it is usefu
8060: 6c 20 74 6f 20 64 65 66 69 6e 65 20 74 68 65 20 l to define the
8070: 6d 61 63 72 6f 73 20 74 68 61 74 20 6f 6d 69 74 macros that omit
8080: 0a 20 20 73 70 65 63 69 66 69 63 20 70 72 61 67 . specific prag
8090: 6d 61 73 20 69 6e 20 61 64 64 69 74 69 6f 6e 20 mas in addition
80a0: 74 6f 20 74 68 69 73 2c 20 61 73 20 74 68 65 79 to this, as they
80b0: 20 6d 61 79 20 61 6c 73 6f 20 72 65 6d 6f 76 65 may also remove
80c0: 20 73 75 70 70 6f 72 74 69 6e 67 20 63 6f 64 65 supporting code
80d0: 0a 20 20 69 6e 20 6f 74 68 65 72 20 73 75 62 2d . in other sub-
80e0: 73 79 73 74 65 6d 73 2e 20 54 68 69 73 20 6d 61 systems. This ma
80f0: 63 72 6f 20 72 65 6d 6f 76 65 73 20 74 68 65 20 cro removes the
8100: 5b 50 52 41 47 4d 41 5d 20 63 6f 6d 6d 61 6e 64 [PRAGMA] command
8110: 20 6f 6e 6c 79 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c only..}..COMPIL
8120: 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 E_OPTION {SQLITE
8130: 5f 4f 4d 49 54 5f 50 52 4f 47 52 45 53 53 5f 43 _OMIT_PROGRESS_C
8140: 41 4c 4c 42 41 43 4b 7d 20 7b 0a 20 20 54 68 69 ALLBACK} {. Thi
8150: 73 20 6f 70 74 69 6f 6e 20 6d 61 79 20 62 65 20 s option may be
8160: 64 65 66 69 6e 65 64 20 74 6f 20 6f 6d 69 74 20 defined to omit
8170: 74 68 65 20 63 61 70 61 62 69 6c 69 74 79 20 74 the capability t
8180: 6f 20 69 73 73 75 65 20 22 70 72 6f 67 72 65 73 o issue "progres
8190: 73 22 20 0a 20 20 63 61 6c 6c 62 61 63 6b 73 20 s" . callbacks
81a0: 64 75 72 69 6e 67 20 6c 6f 6e 67 2d 72 75 6e 6e during long-runn
81b0: 69 6e 67 20 53 51 4c 20 73 74 61 74 65 6d 65 6e ing SQL statemen
81c0: 74 73 2e 20 54 68 65 20 0a 20 20 5b 73 71 6c 69 ts. The . [sqli
81d0: 74 65 33 5f 70 72 6f 67 72 65 73 73 5f 68 61 6e te3_progress_han
81e0: 64 6c 65 72 28 29 5d 0a 20 20 41 50 49 20 66 75 dler()]. API fu
81f0: 6e 63 74 69 6f 6e 20 69 73 20 6e 6f 74 20 70 72 nction is not pr
8200: 65 73 65 6e 74 20 69 6e 20 74 68 65 20 6c 69 62 esent in the lib
8210: 72 61 72 79 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 rary..}..COMPILE
8220: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
8230: 4f 4d 49 54 5f 51 55 49 43 4b 42 41 4c 41 4e 43 OMIT_QUICKBALANC
8240: 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 E} {. This opti
8250: 6f 6e 20 6f 6d 69 74 73 20 61 6e 20 61 6c 74 65 on omits an alte
8260: 72 6e 61 74 69 76 65 2c 20 66 61 73 74 65 72 20 rnative, faster
8270: 42 2d 54 72 65 65 20 62 61 6c 61 6e 63 69 6e 67 B-Tree balancing
8280: 20 72 6f 75 74 69 6e 65 2e 0a 20 20 55 73 69 6e routine.. Usin
8290: 67 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 6d 61 g this option ma
82a0: 6b 65 73 20 53 51 4c 69 74 65 20 73 6c 69 67 68 kes SQLite sligh
82b0: 74 6c 79 20 73 6d 61 6c 6c 65 72 20 61 74 20 74 tly smaller at t
82c0: 68 65 20 65 78 70 65 6e 73 65 20 6f 66 0a 20 20 he expense of.
82d0: 6d 61 6b 69 6e 67 20 69 74 20 72 75 6e 20 73 6c making it run sl
82e0: 69 67 68 74 6c 79 20 73 6c 6f 77 65 72 2e 0a 7d ightly slower..}
82f0: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
8300: 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 52 45 {SQLITE_OMIT_RE
8310: 49 4e 44 45 58 7d 20 7b 0a 20 20 57 68 65 6e 20 INDEX} {. When
8320: 74 68 69 73 20 6f 70 74 69 6f 6e 20 69 73 20 64 this option is d
8330: 65 66 69 6e 65 64 2c 20 74 68 65 20 5b 52 45 49 efined, the [REI
8340: 4e 44 45 58 5d 0a 20 20 63 6f 6d 6d 61 6e 64 20 NDEX]. command
8350: 69 73 20 6e 6f 74 20 69 6e 63 6c 75 64 65 64 20 is not included
8360: 69 6e 20 74 68 65 20 6c 69 62 72 61 72 79 2e 0a in the library..
8370: 20 20 45 78 65 63 75 74 69 6e 67 20 61 20 5b 52 Executing a [R
8380: 45 49 4e 44 45 58 5d 20 73 74 61 74 65 6d 65 6e EINDEX] statemen
8390: 74 20 63 61 75 73 65 73 20 0a 20 20 61 20 70 61 t causes . a pa
83a0: 72 73 65 20 65 72 72 6f 72 2e 0a 7d 0a 0a 43 4f rse error..}..CO
83b0: 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 MPILE_OPTION {SQ
83c0: 4c 49 54 45 5f 4f 4d 49 54 5f 53 43 48 45 4d 41 LITE_OMIT_SCHEMA
83d0: 5f 50 52 41 47 4d 41 53 7d 20 7b 0a 20 20 44 65 _PRAGMAS} {. De
83e0: 66 69 6e 69 6e 67 20 74 68 69 73 20 6f 70 74 69 fining this opti
83f0: 6f 6e 20 6f 6d 69 74 73 20 70 72 61 67 6d 61 73 on omits pragmas
8400: 20 66 6f 72 20 71 75 65 72 79 69 6e 67 20 74 68 for querying th
8410: 65 20 64 61 74 61 62 61 73 65 20 73 63 68 65 6d e database schem
8420: 61 20 66 72 6f 6d 20 0a 20 20 74 68 65 20 62 75 a from . the bu
8430: 69 6c 64 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f ild..}..COMPILE_
8440: 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f OPTION {SQLITE_O
8450: 4d 49 54 5f 53 43 48 45 4d 41 5f 56 45 52 53 49 MIT_SCHEMA_VERSI
8460: 4f 4e 5f 50 52 41 47 4d 41 53 7d 20 7b 0a 20 20 ON_PRAGMAS} {.
8470: 44 65 66 69 6e 69 6e 67 20 74 68 69 73 20 6f 70 Defining this op
8480: 74 69 6f 6e 20 6f 6d 69 74 73 20 70 72 61 67 6d tion omits pragm
8490: 61 73 20 66 6f 72 20 71 75 65 72 79 69 6e 67 20 as for querying
84a0: 61 6e 64 20 6d 6f 64 69 66 79 69 6e 67 20 74 68 and modifying th
84b0: 65 20 0a 20 20 64 61 74 61 62 61 73 65 20 73 63 e . database sc
84c0: 68 65 6d 61 20 76 65 72 73 69 6f 6e 20 61 6e 64 hema version and
84d0: 20 75 73 65 72 20 76 65 72 73 69 6f 6e 20 66 72 user version fr
84e0: 6f 6d 20 74 68 65 20 62 75 69 6c 64 2e 20 53 70 om the build. Sp
84f0: 65 63 69 66 69 63 61 6c 6c 79 2c 20 74 68 65 20 ecifically, the
8500: 0a 20 20 5b 73 63 68 65 6d 61 5f 76 65 72 73 69 . [schema_versi
8510: 6f 6e 5d 20 61 6e 64 20 5b 75 73 65 72 5f 76 65 on] and [user_ve
8520: 72 73 69 6f 6e 5d 20 50 52 41 47 4d 41 73 20 61 rsion] PRAGMAs a
8530: 72 65 20 6f 6d 69 74 74 65 64 2e 0a 7d 0a 0a 43 re omitted..}..C
8540: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
8550: 51 4c 49 54 45 5f 4f 4d 49 54 5f 53 48 41 52 45 QLITE_OMIT_SHARE
8560: 44 5f 43 41 43 48 45 7d 20 7b 0a 20 20 54 68 69 D_CACHE} {. Thi
8570: 73 20 6f 70 74 69 6f 6e 20 62 75 69 6c 64 73 20 s option builds
8580: 53 51 4c 69 74 65 20 77 69 74 68 6f 75 74 20 73 SQLite without s
8590: 75 70 70 6f 72 74 20 66 6f 72 20 73 68 61 72 65 upport for share
85a0: 64 2d 63 61 63 68 65 20 6d 6f 64 65 2e 0a 20 20 d-cache mode..
85b0: 54 68 65 20 5b 73 71 6c 69 74 65 33 5f 65 6e 61 The [sqlite3_ena
85c0: 62 6c 65 5f 73 68 61 72 65 64 5f 63 61 63 68 65 ble_shared_cache
85d0: 28 29 5d 20 69 73 20 6f 6d 69 74 74 65 64 20 61 ()] is omitted a
85e0: 6c 6f 6e 67 20 77 69 74 68 20 61 20 66 61 69 72 long with a fair
85f0: 0a 20 20 61 6d 6f 75 6e 74 20 6f 66 20 6c 6f 67 . amount of log
8600: 69 63 20 77 69 74 68 69 6e 20 74 68 65 20 42 2d ic within the B-
8610: 54 72 65 65 20 73 75 62 73 79 73 74 65 6d 20 61 Tree subsystem a
8620: 73 73 6f 63 69 61 74 65 64 20 77 69 74 68 20 73 ssociated with s
8630: 68 61 72 65 64 0a 20 20 63 61 63 68 65 20 6d 61 hared. cache ma
8640: 6e 61 67 65 6d 65 6e 74 2e 0a 7d 0a 0a 43 4f 4d nagement..}..COM
8650: 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c PILE_OPTION {SQL
8660: 49 54 45 5f 4f 4d 49 54 5f 53 55 42 51 55 45 52 ITE_OMIT_SUBQUER
8670: 59 7d 20 7b 0a 20 20 49 66 20 64 65 66 69 6e 65 Y} {. If define
8680: 64 2c 20 73 75 70 70 6f 72 74 20 66 6f 72 20 73 d, support for s
8690: 75 62 2d 73 65 6c 65 63 74 73 20 61 6e 64 20 74 ub-selects and t
86a0: 68 65 20 49 4e 28 29 20 6f 70 65 72 61 74 6f 72 he IN() operator
86b0: 20 61 72 65 20 6f 6d 69 74 74 65 64 2e 0a 7d 0a are omitted..}.
86c0: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
86d0: 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 54 43 4c {SQLITE_OMIT_TCL
86e0: 5f 56 41 52 49 41 42 4c 45 7d 20 7b 0a 20 20 49 _VARIABLE} {. I
86f0: 66 20 74 68 69 73 20 6d 61 63 72 6f 20 69 73 20 f this macro is
8700: 64 65 66 69 6e 65 64 2c 20 74 68 65 6e 20 74 68 defined, then th
8710: 65 20 73 70 65 63 69 61 6c 20 22 24 3c 76 61 72 e special "$<var
8720: 69 61 62 6c 65 2d 6e 61 6d 65 3e 22 20 73 79 6e iable-name>" syn
8730: 74 61 78 0a 20 20 75 73 65 64 20 74 6f 20 61 75 tax. used to au
8740: 74 6f 6d 61 74 69 63 61 6c 6c 79 20 62 69 6e 64 tomatically bind
8750: 20 53 51 4c 20 76 61 72 69 61 62 6c 65 73 20 74 SQL variables t
8760: 6f 20 54 43 4c 20 76 61 72 69 61 62 6c 65 73 20 o TCL variables
8770: 69 73 20 6f 6d 69 74 74 65 64 2e 0a 7d 0a 0a 43 is omitted..}..C
8780: 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 OMPILE_OPTION {S
8790: 51 4c 49 54 45 5f 4f 4d 49 54 5f 54 45 4d 50 44 QLITE_OMIT_TEMPD
87a0: 42 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 74 69 B} {. This opti
87b0: 6f 6e 20 6f 6d 69 74 73 20 73 75 70 70 6f 72 74 on omits support
87c0: 20 66 6f 72 20 54 45 4d 50 20 6f 72 20 54 45 4d for TEMP or TEM
87d0: 50 4f 52 41 52 59 20 74 61 62 6c 65 73 2e 0a 7d PORARY tables..}
87e0: 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e ..COMPILE_OPTION
87f0: 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 54 52 {SQLITE_OMIT_TR
8800: 41 43 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 ACE} {. This op
8810: 74 69 6f 6e 20 6f 6d 69 74 73 20 73 75 70 70 6f tion omits suppo
8820: 72 74 20 66 6f 72 20 74 68 65 20 5b 73 71 6c 69 rt for the [sqli
8830: 74 65 33 5f 70 72 6f 66 69 6c 65 28 29 5d 20 61 te3_profile()] a
8840: 6e 64 0a 20 20 5b 73 71 6c 69 74 65 33 5f 74 72 nd. [sqlite3_tr
8850: 61 63 65 28 29 5d 20 69 6e 74 65 72 66 61 63 65 ace()] interface
8860: 73 20 61 6e 64 20 74 68 65 69 72 20 61 73 73 6f s and their asso
8870: 63 69 61 74 65 64 20 6c 6f 67 69 63 2e 0a 7d 0a ciated logic..}.
8880: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
8890: 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 54 52 49 {SQLITE_OMIT_TRI
88a0: 47 47 45 52 7d 20 7b 0a 20 20 44 65 66 69 6e 69 GGER} {. Defini
88b0: 6e 67 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 6f ng this option o
88c0: 6d 69 74 73 20 73 75 70 70 6f 72 74 20 66 6f 72 mits support for
88d0: 20 54 52 49 47 47 45 52 20 6f 62 6a 65 63 74 73 TRIGGER objects
88e0: 2e 20 4e 65 69 74 68 65 72 20 74 68 65 20 0a 20 . Neither the .
88f0: 20 5b 43 52 45 41 54 45 20 54 52 49 47 47 45 52 [CREATE TRIGGER
8900: 5d 20 6f 72 20 5b 44 52 4f 50 20 54 52 49 47 47 ] or [DROP TRIGG
8910: 45 52 5d 0a 20 20 63 6f 6d 6d 61 6e 64 73 20 61 ER]. commands a
8920: 72 65 20 61 76 61 69 6c 61 62 6c 65 20 69 6e 20 re available in
8930: 74 68 69 73 20 63 61 73 65 2c 20 61 6e 64 20 61 this case, and a
8940: 74 74 65 6d 70 74 69 6e 67 20 74 6f 20 65 78 65 ttempting to exe
8950: 63 75 74 65 0a 20 20 65 69 74 68 65 72 20 77 69 cute. either wi
8960: 6c 6c 20 72 65 73 75 6c 74 20 69 6e 20 61 20 70 ll result in a p
8970: 61 72 73 65 20 65 72 72 6f 72 2e 0a 20 20 54 68 arse error.. Th
8980: 69 73 20 6f 70 74 69 6f 6e 20 61 6c 73 6f 20 64 is option also d
8990: 69 73 61 62 6c 65 73 20 65 6e 66 6f 72 63 65 6d isables enforcem
89a0: 65 6e 74 20 6f 66 20 5b 66 6f 72 65 69 67 6e 20 ent of [foreign
89b0: 6b 65 79 20 63 6f 6e 73 74 72 61 69 6e 74 73 5d key constraints]
89c0: 2c 0a 20 20 73 69 6e 63 65 20 74 68 65 20 63 6f ,. since the co
89d0: 64 65 20 74 68 61 74 20 69 6d 70 6c 65 6d 65 6e de that implemen
89e0: 74 73 20 74 72 69 67 67 65 72 73 20 61 6e 64 20 ts triggers and
89f0: 77 68 69 63 68 20 69 73 20 6f 6d 69 74 74 65 64 which is omitted
8a00: 20 62 79 20 74 68 69 73 0a 20 20 6f 70 74 69 6f by this. optio
8a10: 6e 20 69 73 20 61 6c 73 6f 20 75 73 65 64 20 74 n is also used t
8a20: 6f 20 69 6d 70 6c 65 6d 65 6e 74 20 5b 66 6f 72 o implement [for
8a30: 65 69 67 6e 20 6b 65 79 20 61 63 74 69 6f 6e 73 eign key actions
8a40: 5d 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 ]..}..COMPILE_OP
8a50: 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 TION {SQLITE_OMI
8a60: 54 5f 54 52 55 4e 43 41 54 45 5f 4f 50 54 49 4d T_TRUNCATE_OPTIM
8a70: 49 5a 41 54 49 4f 4e 7d 20 7b 0a 20 20 41 20 64 IZATION} {. A d
8a80: 65 66 61 75 6c 74 20 62 75 69 6c 64 20 6f 66 20 efault build of
8a90: 53 51 4c 69 74 65 2c 20 69 66 20 61 20 5b 44 45 SQLite, if a [DE
8aa0: 4c 45 54 45 5d 20 73 74 61 74 65 6d 65 6e 74 20 LETE] statement
8ab0: 68 61 73 20 6e 6f 20 57 48 45 52 45 20 63 6c 61 has no WHERE cla
8ac0: 75 73 65 0a 20 20 61 6e 64 20 6f 70 65 72 61 74 use. and operat
8ad0: 65 73 20 6f 6e 20 61 20 74 61 62 6c 65 20 77 69 es on a table wi
8ae0: 74 68 20 6e 6f 20 74 72 69 67 67 65 72 73 2c 20 th no triggers,
8af0: 61 6e 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e 20 an optimization
8b00: 6f 63 63 75 72 73 20 74 68 61 74 0a 20 20 63 61 occurs that. ca
8b10: 75 73 65 73 20 74 68 65 20 44 45 4c 45 54 45 20 uses the DELETE
8b20: 74 6f 20 6f 63 63 75 72 20 62 79 20 64 72 6f 70 to occur by drop
8b30: 70 69 6e 67 20 61 6e 64 20 72 65 63 72 65 61 74 ping and recreat
8b40: 69 6e 67 20 74 68 65 20 74 61 62 6c 65 2e 20 20 ing the table.
8b50: 0a 20 20 44 72 6f 70 70 69 6e 67 20 61 6e 64 20 . Dropping and
8b60: 72 65 63 72 65 61 74 69 6e 67 20 61 20 74 61 62 recreating a tab
8b70: 6c 65 20 69 73 20 75 73 75 61 6c 6c 79 20 6d 75 le is usually mu
8b80: 63 68 20 66 61 73 74 65 72 20 74 68 61 6e 20 64 ch faster than d
8b90: 65 6c 65 74 69 6e 67 0a 20 20 74 68 65 20 74 61 eleting. the ta
8ba0: 62 6c 65 20 63 6f 6e 74 65 6e 74 20 72 6f 77 20 ble content row
8bb0: 62 79 20 72 6f 77 2e 20 20 54 68 69 73 20 69 73 by row. This is
8bc0: 20 74 68 65 20 22 74 72 75 6e 63 61 74 65 20 6f the "truncate o
8bd0: 70 74 69 6d 69 7a 61 74 69 6f 6e 22 2e 0a 7d 0a ptimization"..}.
8be0: 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 4f 4e 20 .COMPILE_OPTION
8bf0: 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 55 4e 49 {SQLITE_OMIT_UNI
8c00: 51 55 45 5f 45 4e 46 4f 52 43 45 4d 45 4e 54 7d QUE_ENFORCEMENT}
8c10: 20 7b 0a 20 20 54 68 69 73 20 6d 61 63 72 6f 20 {. This macro
8c20: 69 73 20 75 73 65 64 20 74 6f 20 6f 6d 69 74 20 is used to omit
8c30: 73 75 70 70 6f 72 74 20 66 6f 72 20 65 6e 66 6f support for enfo
8c40: 72 63 69 6e 67 20 5b 55 4e 49 51 55 45 5d 20 63 rcing [UNIQUE] c
8c50: 6f 6e 73 74 72 61 69 6e 74 73 2e 0a 20 20 55 6e onstraints.. Un
8c60: 69 71 75 65 20 6f 6e 73 74 72 61 69 6e 74 73 20 ique onstraints
8c70: 6d 61 79 20 73 74 69 6c 6c 20 62 65 20 64 65 66 may still be def
8c80: 69 6e 65 64 2c 20 61 6e 64 20 61 6c 6c 20 63 6f ined, and all co
8c90: 64 65 20 61 6e 64 20 6f 70 74 69 6d 69 7a 61 74 de and optimizat
8ca0: 69 6f 6e 73 0a 20 20 66 75 6e 63 74 69 6f 6e 20 ions. function
8cb0: 61 73 20 69 66 20 74 68 65 79 20 61 72 65 20 65 as if they are e
8cc0: 6e 66 6f 72 63 65 64 2c 20 68 6f 77 65 76 65 72 nforced, however
8cd0: 2c 20 74 68 65 20 4f 50 5f 49 73 55 6e 69 71 75 , the OP_IsUniqu
8ce0: 65 20 56 44 42 45 20 0a 20 20 6f 70 63 6f 64 65 e VDBE . opcode
8cf0: 20 69 73 20 6e 6f 74 20 67 65 6e 65 72 61 74 65 is not generate
8d00: 64 2e 20 20 54 68 69 73 20 6d 61 79 20 62 65 20 d. This may be
8d10: 75 73 65 66 75 6c 20 66 6f 72 20 75 73 65 72 73 useful for users
8d20: 20 77 68 6f 20 63 61 6e 20 0a 20 20 67 75 61 72 who can . guar
8d30: 61 6e 74 65 65 20 75 6e 69 71 75 65 6e 65 73 73 antee uniqueness
8d40: 20 6f 66 20 69 6e 70 75 74 73 2c 20 6f 72 20 68 of inputs, or h
8d50: 61 76 65 20 6f 74 68 65 72 20 6d 65 61 6e 73 20 ave other means
8d60: 6f 66 20 65 6e 66 6f 72 63 69 6e 67 0a 20 20 74 of enforcing. t
8d70: 68 65 20 63 6f 6e 73 74 72 61 69 6e 74 2e 20 20 he constraint.
8d80: 53 65 65 20 61 6c 73 6f 20 5b 53 51 4c 49 54 45 See also [SQLITE
8d90: 5f 4f 4d 49 54 5f 43 48 45 43 4b 5d 2c 20 5b 45 _OMIT_CHECK], [E
8da0: 58 50 4c 41 49 4e 5d 2e 0a 7d 0a 0a 43 4f 4d 50 XPLAIN]..}..COMP
8db0: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
8dc0: 54 45 5f 4f 4d 49 54 5f 55 54 46 31 36 7d 20 7b TE_OMIT_UTF16} {
8dd0: 0a 20 20 54 68 69 73 20 6d 61 63 72 6f 20 69 73 . This macro is
8de0: 20 75 73 65 64 20 74 6f 20 6f 6d 69 74 20 73 75 used to omit su
8df0: 70 70 6f 72 74 20 66 6f 72 20 55 54 46 31 36 20 pport for UTF16
8e00: 74 65 78 74 20 65 6e 63 6f 64 69 6e 67 2e 20 57 text encoding. W
8e10: 68 65 6e 20 74 68 69 73 20 69 73 0a 20 20 64 65 hen this is. de
8e20: 66 69 6e 65 64 20 61 6c 6c 20 41 50 49 20 66 75 fined all API fu
8e30: 6e 63 74 69 6f 6e 73 20 74 68 61 74 20 72 65 74 nctions that ret
8e40: 75 72 6e 20 6f 72 20 61 63 63 65 70 74 20 55 54 urn or accept UT
8e50: 46 31 36 20 65 6e 63 6f 64 65 64 20 74 65 78 74 F16 encoded text
8e60: 20 61 72 65 0a 20 20 75 6e 61 76 61 69 6c 61 62 are. unavailab
8e70: 6c 65 2e 20 54 68 65 73 65 20 66 75 6e 63 74 69 le. These functi
8e80: 6f 6e 73 20 63 61 6e 20 62 65 20 69 64 65 6e 74 ons can be ident
8e90: 69 66 69 65 64 20 62 79 20 74 68 65 20 66 61 63 ified by the fac
8ea0: 74 20 74 68 61 74 20 74 68 65 79 20 65 6e 64 0a t that they end.
8eb0: 20 20 77 69 74 68 20 27 31 36 27 2c 20 66 6f 72 with '16', for
8ec0: 20 65 78 61 6d 70 6c 65 20 5b 73 71 6c 69 74 65 example [sqlite
8ed0: 33 5f 70 72 65 70 61 72 65 31 36 28 29 5d 2c 20 3_prepare16()],
8ee0: 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f [sqlite3_column_
8ef0: 74 65 78 74 31 36 28 29 5d 20 61 6e 64 0a 20 20 text16()] and.
8f00: 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74 65 [sqlite3_bind_te
8f10: 78 74 31 36 28 29 5d 2e 0a 7d 0a 0a 43 4f 4d 50 xt16()]..}..COMP
8f20: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
8f30: 54 45 5f 4f 4d 49 54 5f 56 41 43 55 55 4d 7d 20 TE_OMIT_VACUUM}
8f40: 7b 0a 20 20 57 68 65 6e 20 74 68 69 73 20 6f 70 {. When this op
8f50: 74 69 6f 6e 20 69 73 20 64 65 66 69 6e 65 64 2c tion is defined,
8f60: 20 74 68 65 20 5b 56 41 43 55 55 4d 5d 0a 20 20 the [VACUUM].
8f70: 63 6f 6d 6d 61 6e 64 20 69 73 20 6e 6f 74 20 69 command is not i
8f80: 6e 63 6c 75 64 65 64 20 69 6e 20 74 68 65 20 6c ncluded in the l
8f90: 69 62 72 61 72 79 2e 0a 20 20 45 78 65 63 75 74 ibrary.. Execut
8fa0: 69 6e 67 20 61 20 5b 56 41 43 55 55 4d 5d 20 73 ing a [VACUUM] s
8fb0: 74 61 74 65 6d 65 6e 74 20 63 61 75 73 65 73 20 tatement causes
8fc0: 0a 20 20 61 20 70 61 72 73 65 20 65 72 72 6f 72 . a parse error
8fd0: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
8fe0: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 ION {SQLITE_OMIT
8ff0: 5f 56 49 45 57 7d 20 7b 0a 20 20 44 65 66 69 6e _VIEW} {. Defin
9000: 69 6e 67 20 74 68 69 73 20 6f 70 74 69 6f 6e 20 ing this option
9010: 6f 6d 69 74 73 20 73 75 70 70 6f 72 74 20 66 6f omits support fo
9020: 72 20 56 49 45 57 20 6f 62 6a 65 63 74 73 2e 20 r VIEW objects.
9030: 4e 65 69 74 68 65 72 20 74 68 65 20 0a 20 20 5b Neither the . [
9040: 43 52 45 41 54 45 20 56 49 45 57 5d 20 6e 6f 72 CREATE VIEW] nor
9050: 20 74 68 65 20 5b 44 52 4f 50 20 56 49 45 57 5d the [DROP VIEW]
9060: 0a 20 20 63 6f 6d 6d 61 6e 64 73 20 61 72 65 20 . commands are
9070: 61 76 61 69 6c 61 62 6c 65 20 69 6e 20 74 68 69 available in thi
9080: 73 20 63 61 73 65 2c 20 61 6e 64 0a 20 20 61 74 s case, and. at
9090: 74 65 6d 70 74 69 6e 67 20 74 6f 20 65 78 65 63 tempting to exec
90a0: 75 74 65 20 65 69 74 68 65 72 20 77 69 6c 6c 20 ute either will
90b0: 72 65 73 75 6c 74 20 69 6e 20 61 20 70 61 72 73 result in a pars
90c0: 65 20 65 72 72 6f 72 2e 0a 0a 20 20 57 41 52 4e e error... WARN
90d0: 49 4e 47 3a 20 49 66 20 74 68 69 73 20 6d 61 63 ING: If this mac
90e0: 72 6f 20 69 73 20 64 65 66 69 6e 65 64 2c 20 69 ro is defined, i
90f0: 74 20 77 69 6c 6c 20 6e 6f 74 20 62 65 20 70 6f t will not be po
9100: 73 73 69 62 6c 65 20 74 6f 20 6f 70 65 6e 20 61 ssible to open a
9110: 20 64 61 74 61 62 61 73 65 0a 20 20 66 6f 72 20 database. for
9120: 77 68 69 63 68 20 74 68 65 20 73 63 68 65 6d 61 which the schema
9130: 20 63 6f 6e 74 61 69 6e 73 20 56 49 45 57 20 6f contains VIEW o
9140: 62 6a 65 63 74 73 2e 20 0a 7d 0a 0a 43 4f 4d 50 bjects. .}..COMP
9150: 49 4c 45 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 ILE_OPTION {SQLI
9160: 54 45 5f 4f 4d 49 54 5f 56 49 52 54 55 41 4c 54 TE_OMIT_VIRTUALT
9170: 41 42 4c 45 7d 20 7b 0a 20 20 54 68 69 73 20 6f ABLE} {. This o
9180: 70 74 69 6f 6e 20 6f 6d 69 74 73 20 73 75 70 70 ption omits supp
9190: 6f 72 74 20 66 6f 72 20 74 68 65 20 5b 73 71 6c ort for the [sql
91a0: 69 74 65 33 5f 76 74 61 62 20 7c 20 56 69 72 74 ite3_vtab | Virt
91b0: 75 61 6c 20 54 61 62 6c 65 5d 0a 20 20 6d 65 63 ual Table]. mec
91c0: 68 61 6e 69 73 6d 20 69 6e 20 53 51 4c 69 74 65 hanism in SQLite
91d0: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
91e0: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 ION {SQLITE_OMIT
91f0: 5f 57 41 4c 7d 20 7b 0a 20 20 54 68 69 73 20 6f _WAL} {. This o
9200: 70 74 69 6f 6e 20 6f 6d 69 74 73 20 74 68 65 20 ption omits the
9210: 22 5b 77 72 69 74 65 2d 61 68 65 61 64 20 6c 6f "[write-ahead lo
9220: 67 5d 22 20 28 61 2e 6b 2e 61 2e 20 22 5b 57 41 g]" (a.k.a. "[WA
9230: 4c 5d 22 29 20 63 61 70 61 62 69 6c 69 74 79 2e L]") capability.
9240: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
9250: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
9260: 57 53 44 7d 20 7b 0a 20 20 54 68 69 73 20 6f 70 WSD} {. This op
9270: 74 69 6f 6e 73 20 62 75 69 6c 64 73 20 61 20 76 tions builds a v
9280: 65 72 73 69 6f 6e 20 6f 66 20 74 68 65 20 53 51 ersion of the SQ
9290: 4c 69 74 65 20 6c 69 62 72 61 72 79 20 74 68 61 Lite library tha
92a0: 74 20 63 6f 6e 74 61 69 6e 73 20 6e 6f 0a 20 20 t contains no.
92b0: 57 72 69 74 61 62 6c 65 20 53 74 61 74 69 63 20 Writable Static
92c0: 44 61 74 61 20 28 57 53 44 29 2e 20 20 57 53 44 Data (WSD). WSD
92d0: 20 69 73 20 67 6c 6f 62 61 6c 20 76 61 72 69 61 is global varia
92e0: 62 6c 65 73 20 61 6e 64 2f 6f 72 20 73 74 61 74 bles and/or stat
92f0: 69 63 0a 20 20 76 61 72 69 61 62 6c 65 73 2e 20 ic. variables.
9300: 20 53 6f 6d 65 20 70 6c 61 74 66 6f 72 6d 73 20 Some platforms
9310: 64 6f 20 6e 6f 74 20 73 75 70 70 6f 72 74 20 57 do not support W
9320: 53 44 2c 20 61 6e 64 20 74 68 69 73 20 6f 70 74 SD, and this opt
9330: 69 6f 6e 20 69 73 20 6e 65 63 65 73 73 61 72 79 ion is necessary
9340: 0a 20 20 69 6e 20 6f 72 64 65 72 20 66 6f 72 20 . in order for
9350: 53 51 4c 69 74 65 20 74 6f 20 77 6f 72 6b 20 74 SQLite to work t
9360: 68 6f 73 65 20 70 6c 61 74 66 6f 72 6d 73 2e 20 hose platforms.
9370: 20 0a 0a 20 20 55 6e 6c 69 6b 65 20 6f 74 68 65 .. Unlike othe
9380: 72 20 4f 4d 49 54 20 6f 70 74 69 6f 6e 73 20 77 r OMIT options w
9390: 68 69 63 68 20 6d 61 6b 65 20 74 68 65 20 53 51 hich make the SQ
93a0: 4c 69 74 65 20 6c 69 62 72 61 72 79 20 73 6d 61 Lite library sma
93b0: 6c 6c 65 72 2c 0a 20 20 74 68 69 73 20 6f 70 74 ller,. this opt
93c0: 69 6f 6e 20 61 63 74 75 61 6c 6c 79 20 69 6e 63 ion actually inc
93d0: 72 65 61 73 65 73 20 74 68 65 20 73 69 7a 65 20 reases the size
93e0: 6f 66 20 53 51 4c 69 74 65 20 61 6e 64 20 6d 61 of SQLite and ma
93f0: 6b 65 73 20 69 74 20 72 75 6e 0a 20 20 61 20 6c kes it run. a l
9400: 69 74 74 6c 65 20 73 6c 6f 77 65 72 2e 20 20 4f ittle slower. O
9410: 6e 6c 79 20 75 73 65 20 74 68 69 73 20 6f 70 74 nly use this opt
9420: 69 6f 6e 20 69 66 20 53 51 4c 69 74 65 20 69 73 ion if SQLite is
9430: 20 62 65 69 6e 67 20 62 75 69 6c 74 20 66 6f 72 being built for
9440: 20 61 6e 0a 20 20 65 6d 62 65 64 64 65 64 20 74 an. embedded t
9450: 61 72 67 65 74 20 74 68 61 74 20 64 6f 65 73 20 arget that does
9460: 6e 6f 74 20 73 75 70 70 6f 72 74 20 57 53 44 2e not support WSD.
9470: 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 49 .}..COMPILE_OPTI
9480: 4f 4e 20 7b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f ON {SQLITE_OMIT_
9490: 58 46 45 52 5f 4f 50 54 7d 20 7b 0a 20 20 54 68 XFER_OPT} {. Th
94a0: 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 74 73 20 is option omits
94b0: 73 75 70 70 6f 72 74 20 66 6f 72 20 6f 70 74 69 support for opti
94c0: 6d 69 7a 61 74 69 6f 6e 73 20 74 68 61 74 20 68 mizations that h
94d0: 65 6c 70 20 73 74 61 74 65 6d 65 6e 74 73 0a 20 elp statements.
94e0: 20 6f 66 20 74 68 65 20 66 6f 72 6d 20 22 49 4e of the form "IN
94f0: 53 45 52 54 20 49 4e 54 4f 20 2e 2e 2e 20 53 45 SERT INTO ... SE
9500: 4c 45 43 54 20 2e 2e 2e 22 20 72 75 6e 20 66 61 LECT ..." run fa
9510: 73 74 65 72 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 ster..}..COMPILE
9520: 5f 4f 50 54 49 4f 4e 20 7b 53 51 4c 49 54 45 5f _OPTION {SQLITE_
9530: 5a 45 52 4f 5f 4d 41 4c 4c 4f 43 7d 20 7b 0a 20 ZERO_MALLOC} {.
9540: 20 54 68 69 73 20 6f 70 74 69 6f 6e 20 6f 6d 69 This option omi
9550: 74 73 20 62 6f 74 68 20 74 68 65 20 5b 64 65 66 ts both the [def
9560: 61 75 6c 74 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f ault memory allo
9570: 63 61 74 6f 72 5d 20 61 6e 64 20 74 68 65 0a 20 cator] and the.
9580: 20 5b 64 65 62 75 67 67 69 6e 67 20 6d 65 6d 6f [debugging memo
9590: 72 79 20 61 6c 6c 6f 63 61 74 6f 72 5d 20 66 72 ry allocator] fr
95a0: 6f 6d 20 74 68 65 20 62 75 69 6c 64 20 61 6e 64 om the build and
95b0: 20 73 75 62 73 74 69 74 75 74 65 73 20 61 20 73 substitutes a s
95c0: 74 75 62 0a 20 20 6d 65 6d 6f 72 79 20 61 6c 6c tub. memory all
95d0: 6f 63 61 74 6f 72 20 74 68 61 74 20 61 6c 77 61 ocator that alwa
95e0: 79 73 20 66 61 69 6c 73 2e 20 20 53 51 4c 69 74 ys fails. SQLit
95f0: 65 20 77 69 6c 6c 20 6e 6f 74 20 72 75 6e 20 77 e will not run w
9600: 69 74 68 20 74 68 69 73 0a 20 20 73 74 75 62 20 ith this. stub
9610: 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 memory allocator
9620: 20 73 69 6e 63 65 20 69 74 20 77 69 6c 6c 20 62 since it will b
9630: 65 20 75 6e 61 62 6c 65 20 74 6f 20 61 6c 6c 6f e unable to allo
9640: 63 61 74 65 20 6d 65 6d 6f 72 79 2e 20 20 42 75 cate memory. Bu
9650: 74 0a 20 20 74 68 69 73 20 73 74 75 62 20 63 61 t. this stub ca
9660: 6e 20 62 65 20 72 65 70 6c 61 63 65 64 20 61 74 n be replaced at
9670: 20 73 74 61 72 74 2d 74 69 6d 65 20 75 73 69 6e start-time usin
9680: 67 0a 20 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e g. [sqlite3_con
9690: 66 69 67 5d 28 5b 53 51 4c 49 54 45 5f 43 4f 4e fig]([SQLITE_CON
96a0: 46 49 47 5f 4d 41 4c 4c 4f 43 5d 2c 2e 2e 2e 29 FIG_MALLOC],...)
96b0: 20 6f 72 0a 20 20 5b 73 71 6c 69 74 65 33 5f 63 or. [sqlite3_c
96c0: 6f 6e 66 69 67 5d 28 5b 53 51 4c 49 54 45 5f 43 onfig]([SQLITE_C
96d0: 4f 4e 46 49 47 5f 48 45 41 50 5d 2c 2e 2e 2e 29 ONFIG_HEAP],...)
96e0: 2e 0a 20 20 53 6f 20 74 68 65 20 6e 65 74 20 65 .. So the net e
96f0: 66 66 65 63 74 20 6f 66 20 74 68 69 73 20 63 6f ffect of this co
9700: 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f mpile-time optio
9710: 6e 20 69 73 20 74 68 61 74 20 69 74 20 61 6c 6c n is that it all
9720: 6f 77 73 20 53 51 4c 69 74 65 0a 20 20 74 6f 20 ows SQLite. to
9730: 62 65 20 63 6f 6d 70 69 6c 65 64 20 61 6e 64 20 be compiled and
9740: 6c 69 6e 6b 65 64 20 61 67 61 69 6e 73 74 20 61 linked against a
9750: 20 73 79 73 74 65 6d 20 6c 69 62 72 61 72 79 20 system library
9760: 74 68 61 74 20 64 6f 65 73 20 6e 6f 74 20 73 75 that does not su
9770: 70 70 6f 72 74 0a 20 20 6d 61 6c 6c 6f 63 28 29 pport. malloc()
9780: 2c 20 66 72 65 65 28 29 2c 20 61 6e 64 2f 6f 72 , free(), and/or
9790: 20 72 65 61 6c 6c 6f 63 28 29 2e 0a 7d 0a 0a 3c realloc()..}..<
97a0: 2f 74 63 6c 3e 0a 3c 61 20 6e 61 6d 65 3d 22 64 /tcl>.<a name="d
97b0: 65 62 75 67 6f 70 74 69 6f 6e 73 22 3e 3c 2f 61 ebugoptions"></a
97c0: 3e 0a 3c 68 32 3e 31 2e 37 20 41 6e 61 6c 79 73 >.<h2>1.7 Analys
97d0: 69 73 20 61 6e 64 20 44 65 62 75 67 67 69 6e 67 is and Debugging
97e0: 20 4f 70 74 69 6f 6e 73 3c 2f 68 32 3e 0a 3c 74 Options</h2>.<t
97f0: 63 6c 3e 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 cl>..COMPILE_OPT
9800: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 44 45 42 55 ION {SQLITE_DEBU
9810: 47 7d 20 7b 0a 20 20 54 68 65 20 53 51 4c 69 74 G} {. The SQLit
9820: 65 20 73 6f 75 72 63 65 20 63 6f 64 65 20 63 6f e source code co
9830: 6e 74 61 69 6e 73 20 6c 69 74 65 72 61 6c 6c 79 ntains literally
9840: 20 74 68 6f 75 73 61 6e 64 73 20 6f 66 20 61 73 thousands of as
9850: 73 65 72 74 28 29 20 73 74 61 74 65 6d 65 6e 74 sert() statement
9860: 73 0a 20 20 75 73 65 64 20 74 6f 20 76 65 72 69 s. used to veri
9870: 66 79 20 69 6e 74 65 72 6e 61 6c 20 61 73 73 75 fy internal assu
9880: 6d 70 74 69 6f 6e 73 20 61 6e 64 20 73 75 62 72 mptions and subr
9890: 6f 75 74 69 6e 65 20 70 72 65 63 6f 6e 64 69 74 outine precondit
98a0: 69 6f 6e 73 20 61 6e 64 0a 20 20 70 6f 73 74 63 ions and. postc
98b0: 6f 6e 64 69 74 69 6f 6e 73 2e 20 20 54 68 65 73 onditions. Thes
98c0: 65 20 61 73 73 65 72 74 28 29 20 73 74 61 74 65 e assert() state
98d0: 6d 65 6e 74 73 20 61 72 65 20 6e 6f 72 6d 61 6c ments are normal
98e0: 6c 79 20 74 75 72 6e 65 64 20 6f 66 66 0a 20 20 ly turned off.
98f0: 28 74 68 65 79 20 67 65 6e 65 72 61 74 65 20 6e (they generate n
9900: 6f 20 63 6f 64 65 29 20 73 69 6e 63 65 20 74 75 o code) since tu
9910: 72 6e 69 6e 67 20 74 68 65 6d 20 6f 6e 20 6d 61 rning them on ma
9920: 6b 65 73 20 53 51 4c 69 74 65 20 72 75 6e 20 61 kes SQLite run a
9930: 70 70 72 6f 78 69 6d 61 74 65 6c 79 0a 20 20 74 pproximately. t
9940: 68 72 65 65 20 74 69 6d 65 73 20 73 6c 6f 77 65 hree times slowe
9950: 72 2e 20 20 42 75 74 20 66 6f 72 20 74 65 73 74 r. But for test
9960: 69 6e 67 20 61 6e 64 20 61 6e 61 6c 79 73 69 73 ing and analysis
9970: 2c 20 69 74 20 69 73 20 75 73 65 66 75 6c 20 74 , it is useful t
9980: 6f 20 74 75 72 6e 0a 20 20 74 68 65 20 61 73 73 o turn. the ass
9990: 65 72 74 28 29 20 73 74 61 74 65 6d 65 6e 74 73 ert() statements
99a0: 20 6f 6e 2e 20 20 54 68 65 20 53 51 4c 49 54 45 on. The SQLITE
99b0: 5f 44 45 42 55 47 20 63 6f 6d 70 69 6c 65 2d 74 _DEBUG compile-t
99c0: 69 6d 65 20 6f 70 74 69 6f 6e 20 64 6f 65 73 20 ime option does
99d0: 74 68 69 73 2e 0a 20 20 53 51 4c 49 54 45 5f 44 this.. SQLITE_D
99e0: 45 42 55 47 20 61 6c 73 6f 20 74 75 72 6e 73 20 EBUG also turns
99f0: 6f 6e 20 73 6f 6d 65 20 6f 74 68 65 72 20 64 65 on some other de
9a00: 62 75 67 67 69 6e 67 20 66 65 61 74 75 72 65 73 bugging features
9a10: 2e 0a 7d 0a 0a 43 4f 4d 50 49 4c 45 5f 4f 50 54 ..}..COMPILE_OPT
9a20: 49 4f 4e 20 7b 53 51 4c 49 54 45 5f 4d 45 4d 44 ION {SQLITE_MEMD
9a30: 45 42 55 47 7d 20 7b 0a 20 20 54 68 65 20 53 51 EBUG} {. The SQ
9a40: 4c 49 54 45 5f 4d 45 4d 44 45 42 55 47 20 6f 70 LITE_MEMDEBUG op
9a50: 74 69 6f 6e 20 63 61 75 73 65 73 20 61 6e 20 69 tion causes an i
9a60: 6e 73 74 72 75 6d 65 6e 74 65 64 20 0a 20 20 5b nstrumented . [
9a70: 64 65 62 75 67 67 69 6e 67 20 6d 65 6d 6f 72 79 debugging memory
9a80: 20 61 6c 6c 6f 63 61 74 6f 72 5d 0a 20 20 74 6f allocator]. to
9a90: 20 62 65 20 75 73 65 64 20 61 73 20 74 68 65 20 be used as the
9aa0: 64 65 66 61 75 6c 74 20 6d 65 6d 6f 72 79 20 61 default memory a
9ab0: 6c 6c 6f 63 61 74 6f 72 20 77 69 74 68 69 6e 20 llocator within
9ac0: 53 51 4c 69 74 65 2e 20 20 54 68 65 0a 20 20 69 SQLite. The. i
9ad0: 6e 73 74 72 75 6d 65 6e 74 65 64 20 6d 65 6d 6f nstrumented memo
9ae0: 72 79 20 61 6c 6c 6f 63 61 74 6f 72 20 63 68 65 ry allocator che
9af0: 63 6b 73 20 66 6f 72 20 6d 69 73 75 73 65 20 6f cks for misuse o
9b00: 66 20 64 79 6e 61 6d 69 63 61 6c 6c 79 20 61 6c f dynamically al
9b10: 6c 6f 63 61 74 65 64 0a 20 20 6d 65 6d 6f 72 79 located. memory
9b20: 2e 20 20 45 78 61 6d 70 6c 65 73 20 6f 66 20 6d . Examples of m
9b30: 69 73 75 73 65 20 69 6e 63 6c 75 64 65 20 75 73 isuse include us
9b40: 69 6e 67 20 6d 65 6d 6f 72 79 20 61 66 74 65 72 ing memory after
9b50: 20 69 74 20 69 73 20 66 72 65 65 64 2c 0a 20 20 it is freed,.
9b60: 77 72 69 74 69 6e 67 20 6f 66 66 20 74 68 65 20 writing off the
9b70: 65 6e 64 73 20 6f 66 20 61 20 6d 65 6d 6f 72 79 ends of a memory
9b80: 20 61 6c 6c 6f 63 61 74 69 6f 6e 2c 20 66 72 65 allocation, fre
9b90: 65 69 6e 67 20 6d 65 6d 6f 72 79 20 6e 6f 74 20 eing memory not
9ba0: 70 72 65 76 69 6f 75 73 6c 79 0a 20 20 6f 62 74 previously. obt
9bb0: 61 69 6e 65 64 20 66 72 6f 6d 20 74 68 65 20 6d ained from the m
9bc0: 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 2c emory allocator,
9bd0: 20 6f 72 20 66 61 69 6c 69 6e 67 20 74 6f 20 69 or failing to i
9be0: 6e 69 74 69 61 6c 69 7a 65 20 6e 65 77 6c 79 0a nitialize newly.
9bf0: 20 20 61 6c 6c 6f 63 61 74 65 64 20 6d 65 6d 6f allocated memo
9c00: 72 79 2e 0a 7d 0a 0a 3c 2f 74 63 6c 3e 0a ry..}..</tcl>.