Documentation Source Text

Hex Artifact Content
Login

Artifact e20de10172a32a139e7c730dbd4f279ef16fdfb73cbd8e02e72b7a3e0644d7a9:


0000: 3c 74 69 74 6c 65 3e 41 72 63 68 69 74 65 63 74  <title>Architect
0010: 75 72 65 20 6f 66 20 53 51 4c 69 74 65 3c 2f 74  ure of SQLite</t
0020: 69 74 6c 65 3e 0a 3c 66 61 6e 63 79 5f 66 6f 72  itle>.<fancy_for
0030: 6d 61 74 3e 0a 0a 3c 74 63 6c 3e 0a 70 72 6f 63  mat>..<tcl>.proc
0040: 20 72 65 6e 64 65 72 5f 61 72 63 68 20 7b 68 74   render_arch {ht
0050: 6d 6c 7d 20 7b 0a 20 20 72 65 67 73 75 62 20 2d  ml} {.  regsub -
0060: 61 6c 6c 20 7b 3c 66 69 6c 65 3e 28 5b 5e 3c 5d  all {<file>([^<]
0070: 2b 29 3c 2f 66 69 6c 65 3e 7d 20 24 68 74 6d 6c  +)</file>} $html
0080: 20 7b 3c 61 20 68 72 65 66 3d 27 68 74 74 70 73   {<a href='https
0090: 3a 2f 2f 73 71 6c 69 74 65 2e 6f 72 67 2f 73 72  ://sqlite.org/sr
00a0: 63 2f 66 69 6c 65 2f 73 72 63 2f 5c 31 27 3e 5c  c/file/src/\1'>\
00b0: 31 3c 2f 61 3e 7d 20 68 74 6d 6c 0a 20 20 68 64  1</a>} html.  hd
00c0: 5f 72 65 73 6f 6c 76 65 20 24 68 74 6d 6c 0a 7d  _resolve $html.}
00d0: 0a 72 65 6e 64 65 72 5f 61 72 63 68 20 7b 0a 3c  .render_arch {.<
00e0: 68 31 3e 49 6e 74 72 6f 64 75 63 74 69 6f 6e 3c  h1>Introduction<
00f0: 2f 68 31 3e 0a 0a 0a 3c 70 3e 54 68 69 73 20 64  /h1>...<p>This d
0100: 6f 63 75 6d 65 6e 74 20 64 65 73 63 72 69 62 65  ocument describe
0110: 73 20 74 68 65 20 61 72 63 68 69 74 65 63 74 75  s the architectu
0120: 72 65 20 6f 66 20 74 68 65 20 53 51 4c 69 74 65  re of the SQLite
0130: 20 6c 69 62 72 61 72 79 2e 0a 54 68 65 20 69 6e   library..The in
0140: 66 6f 72 6d 61 74 69 6f 6e 20 68 65 72 65 20 69  formation here i
0150: 73 20 75 73 65 66 75 6c 20 74 6f 20 74 68 6f 73  s useful to thos
0160: 65 20 77 68 6f 20 77 61 6e 74 20 74 6f 20 75 6e  e who want to un
0170: 64 65 72 73 74 61 6e 64 20 6f 72 0a 6d 6f 64 69  derstand or.modi
0180: 66 79 20 74 68 65 20 69 6e 6e 65 72 20 77 6f 72  fy the inner wor
0190: 6b 69 6e 67 73 20 6f 66 20 53 51 4c 69 74 65 2e  kings of SQLite.
01a0: 0a 3c 2f 70 3e 0a 0a 3c 64 69 76 20 63 6c 61 73  .</p>..<div clas
01b0: 73 3d 22 72 69 67 68 74 73 69 64 65 62 61 72 20  s="rightsidebar 
01c0: 62 6f 72 64 65 72 32 70 78 20 69 6d 67 63 6f 6e  border2px imgcon
01d0: 74 61 69 6e 65 72 22 3e 0a 3c 69 6d 67 20 73 72  tainer">.<img sr
01e0: 63 3d 22 69 6d 61 67 65 73 2f 61 72 63 68 32 2e  c="images/arch2.
01f0: 67 69 66 22 3e 3c 2f 69 6d 67 3e 0a 3c 2f 64 69  gif"></img>.</di
0200: 76 3e 0a 0a 3c 70 3e 0a 41 20 6e 65 61 72 62 79  v>..<p>.A nearby
0210: 20 64 69 61 67 72 61 6d 20 73 68 6f 77 73 20 74   diagram shows t
0220: 68 65 20 6d 61 69 6e 20 63 6f 6d 70 6f 6e 65 6e  he main componen
0230: 74 73 20 6f 66 20 53 51 4c 69 74 65 0a 61 6e 64  ts of SQLite.and
0240: 20 68 6f 77 20 74 68 65 79 20 69 6e 74 65 72 6f   how they intero
0250: 70 65 72 61 74 65 2e 20 20 54 68 65 20 74 65 78  perate.  The tex
0260: 74 20 62 65 6c 6f 77 0a 65 78 70 6c 61 69 6e 73  t below.explains
0270: 20 74 68 65 20 72 6f 6c 65 73 20 6f 66 20 74 68   the roles of th
0280: 65 20 76 61 72 69 6f 75 73 20 63 6f 6d 70 6f 6e  e various compon
0290: 65 6e 74 73 2e 0a 3c 2f 70 3e 0a 0a 3c 68 31 3e  ents..</p>..<h1>
02a0: 4f 76 65 72 76 69 65 77 3c 2f 68 31 3e 0a 0a 3c  Overview</h1>..<
02b0: 70 3e 53 51 4c 69 74 65 20 77 6f 72 6b 73 20 62  p>SQLite works b
02c0: 79 20 63 6f 6d 70 69 6c 69 6e 67 20 53 51 4c 20  y compiling SQL 
02d0: 74 65 78 74 20 69 6e 74 6f 20 5b 62 79 74 65 63  text into [bytec
02e0: 6f 64 65 5d 2c 20 74 68 65 6e 20 72 75 6e 6e 69  ode], then runni
02f0: 6e 67 0a 74 68 61 74 20 62 79 74 65 63 6f 64 65  ng.that bytecode
0300: 20 75 73 69 6e 67 20 61 20 76 69 72 74 75 61 6c   using a virtual
0310: 20 6d 61 63 68 69 6e 65 2e 0a 0a 3c 70 3e 54 68   machine...<p>Th
0320: 65 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61  e [sqlite3_prepa
0330: 72 65 5f 76 32 28 29 5d 20 61 6e 64 20 72 65 6c  re_v2()] and rel
0340: 61 74 65 64 20 69 6e 74 65 72 66 61 63 65 73 20  ated interfaces 
0350: 61 63 74 20 61 73 20 61 20 63 6f 6d 70 69 6c 65  act as a compile
0360: 72 0a 66 6f 72 20 63 6f 6e 76 65 72 74 69 6e 67  r.for converting
0370: 20 53 51 4c 20 74 65 78 74 20 69 6e 74 6f 20 62   SQL text into b
0380: 79 74 65 63 6f 64 65 2e 20 20 54 68 65 20 5b 73  ytecode.  The [s
0390: 71 6c 69 74 65 33 5f 73 74 6d 74 5d 20 6f 62 6a  qlite3_stmt] obj
03a0: 65 63 74 20 69 73 0a 61 20 63 6f 6e 74 61 69 6e  ect is.a contain
03b0: 65 72 20 66 6f 72 20 61 20 73 69 6e 67 6c 65 20  er for a single 
03c0: 62 79 74 65 63 6f 64 65 20 70 72 6f 67 72 61 6d  bytecode program
03d0: 20 75 73 69 6e 67 20 74 6f 20 69 6d 70 6c 65 6d   using to implem
03e0: 65 6e 74 20 61 20 73 69 6e 67 6c 65 0a 53 51 4c  ent a single.SQL
03f0: 20 73 74 61 74 65 6d 65 6e 74 2e 20 20 54 68 65   statement.  The
0400: 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29   [sqlite3_step()
0410: 5d 20 69 6e 74 65 72 66 61 63 65 20 70 61 73 73  ] interface pass
0420: 65 73 20 61 20 62 79 74 65 63 6f 64 65 20 70 72  es a bytecode pr
0430: 6f 67 72 61 6d 0a 69 6e 74 6f 20 74 68 65 20 76  ogram.into the v
0440: 69 72 74 75 61 6c 20 6d 61 63 68 69 6e 65 2c 20  irtual machine, 
0450: 61 6e 64 20 72 75 6e 73 20 74 68 65 20 70 72 6f  and runs the pro
0460: 67 72 61 6d 20 75 6e 74 69 6c 20 69 74 20 65 69  gram until it ei
0470: 74 68 65 72 20 63 6f 6d 70 6c 65 74 65 73 2c 0a  ther completes,.
0480: 6f 72 20 66 6f 72 6d 73 20 61 20 72 6f 77 20 6f  or forms a row o
0490: 66 20 72 65 73 75 6c 74 20 74 6f 20 62 65 20 72  f result to be r
04a0: 65 74 75 72 6e 65 64 2c 20 6f 72 20 68 69 74 73  eturned, or hits
04b0: 20 61 20 66 61 74 61 6c 20 65 72 72 6f 72 2c 20   a fatal error, 
04c0: 6f 72 20 69 73 0a 5b 73 71 6c 69 74 65 33 5f 69  or is.[sqlite3_i
04d0: 6e 74 65 72 72 75 70 74 28 29 7c 69 6e 74 65 72  nterrupt()|inter
04e0: 72 75 70 74 65 64 5d 2e 0a 0a 3c 68 31 3e 49 6e  rupted]...<h1>In
04f0: 74 65 72 66 61 63 65 3c 2f 68 31 3e 0a 0a 3c 70  terface</h1>..<p
0500: 3e 4d 75 63 68 20 6f 66 20 74 68 65 20 5b 43 2d  >Much of the [C-
0510: 6c 61 6e 67 75 61 67 65 20 49 6e 74 65 72 66 61  language Interfa
0520: 63 65 5d 20 69 73 20 66 6f 75 6e 64 20 69 6e 20  ce] is found in 
0530: 73 6f 75 72 63 65 0a 66 69 6c 65 73 20 3c 66 69  source.files <fi
0540: 6c 65 3e 6d 61 69 6e 2e 63 3c 2f 66 69 6c 65 3e  le>main.c</file>
0550: 2c 20 3c 66 69 6c 65 3e 6c 65 67 61 63 79 2e 63  , <file>legacy.c
0560: 3c 2f 66 69 6c 65 3e 2c 20 61 6e 64 0a 3c 66 69  </file>, and.<fi
0570: 6c 65 3e 76 64 62 65 61 70 69 2e 63 3c 2f 66 69  le>vdbeapi.c</fi
0580: 6c 65 3e 0a 74 68 6f 75 67 68 20 73 6f 6d 65 20  le>.though some 
0590: 72 6f 75 74 69 6e 65 73 20 61 72 65 0a 73 63 61  routines are.sca
05a0: 74 74 65 72 65 64 20 61 62 6f 75 74 20 69 6e 20  ttered about in 
05b0: 6f 74 68 65 72 20 66 69 6c 65 73 20 77 68 65 72  other files wher
05c0: 65 20 74 68 65 79 20 63 61 6e 20 68 61 76 65 20  e they can have 
05d0: 61 63 63 65 73 73 20 74 6f 20 64 61 74 61 20 0a  access to data .
05e0: 73 74 72 75 63 74 75 72 65 73 20 77 69 74 68 20  structures with 
05f0: 66 69 6c 65 20 73 63 6f 70 65 2e 20 20 0a 54 68  file scope.  .Th
0600: 65 20 5b 73 71 6c 69 74 65 33 5f 67 65 74 5f 74  e [sqlite3_get_t
0610: 61 62 6c 65 28 29 5d 20 72 6f 75 74 69 6e 65 20  able()] routine 
0620: 69 73 20 69 6d 70 6c 65 6d 65 6e 74 65 64 20 69  is implemented i
0630: 6e 20 3c 66 69 6c 65 3e 74 61 62 6c 65 2e 63 3c  n <file>table.c<
0640: 2f 66 69 6c 65 3e 2e 0a 54 68 65 20 5b 73 71 6c  /file>..The [sql
0650: 69 74 65 33 5f 6d 70 72 69 6e 74 66 28 29 5d 20  ite3_mprintf()] 
0660: 72 6f 75 74 69 6e 65 20 69 73 20 66 6f 75 6e 64  routine is found
0670: 20 69 6e 20 3c 66 69 6c 65 3e 70 72 69 6e 74 66   in <file>printf
0680: 2e 63 3c 2f 66 69 6c 65 3e 2e 0a 54 68 65 20 5b  .c</file>..The [
0690: 73 71 6c 69 74 65 33 5f 63 6f 6d 70 6c 65 74 65  sqlite3_complete
06a0: 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 69 73  ()] interface is
06b0: 20 69 6e 20 3c 66 69 6c 65 3e 63 6f 6d 70 6c 65   in <file>comple
06c0: 74 65 2e 63 3c 2f 66 69 6c 65 3e 2e 0a 54 68 65  te.c</file>..The
06d0: 20 5b 54 43 4c 20 49 6e 74 65 72 66 61 63 65 5d   [TCL Interface]
06e0: 20 69 73 20 69 6d 70 6c 65 6d 65 6e 74 65 64 20   is implemented 
06f0: 62 79 20 3c 66 69 6c 65 3e 74 63 6c 73 71 6c 69  by <file>tclsqli
0700: 74 65 2e 63 3c 2f 66 69 6c 65 3e 2e 0a 0a 3c 70  te.c</file>...<p
0710: 3e 54 6f 20 61 76 6f 69 64 20 6e 61 6d 65 20 63  >To avoid name c
0720: 6f 6c 6c 69 73 69 6f 6e 73 2c 20 61 6c 6c 20 65  ollisions, all e
0730: 78 74 65 72 6e 61 6c 0a 73 79 6d 62 6f 6c 73 20  xternal.symbols 
0740: 69 6e 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69  in the SQLite li
0750: 62 72 61 72 79 20 62 65 67 69 6e 20 77 69 74 68  brary begin with
0760: 20 74 68 65 20 70 72 65 66 69 78 20 3c 62 3e 73   the prefix <b>s
0770: 71 6c 69 74 65 33 3c 2f 62 3e 2e 0a 54 68 6f 73  qlite3</b>..Thos
0780: 65 20 73 79 6d 62 6f 6c 73 20 74 68 61 74 20 61  e symbols that a
0790: 72 65 20 69 6e 74 65 6e 64 65 64 20 66 6f 72 20  re intended for 
07a0: 65 78 74 65 72 6e 61 6c 20 75 73 65 20 28 69 6e  external use (in
07b0: 20 6f 74 68 65 72 20 77 6f 72 64 73 2c 0a 74 68   other words,.th
07c0: 6f 73 65 20 73 79 6d 62 6f 6c 73 20 77 68 69 63  ose symbols whic
07d0: 68 20 66 6f 72 6d 20 74 68 65 20 41 50 49 20 66  h form the API f
07e0: 6f 72 20 53 51 4c 69 74 65 29 20 61 64 64 20 61  or SQLite) add a
07f0: 6e 20 75 6e 64 65 72 73 63 6f 72 65 2c 20 61 6e  n underscore, an
0800: 64 0a 74 68 75 73 20 62 65 67 69 6e 20 77 69 74  d.thus begin wit
0810: 68 20 3c 62 3e 73 71 6c 69 74 65 33 5f 3c 2f 62  h <b>sqlite3_</b
0820: 3e 2e 20 20 45 78 74 65 6e 73 69 6f 6e 20 41 50  >.  Extension AP
0830: 49 73 20 73 6f 6d 65 74 69 6d 65 73 20 61 64 64  Is sometimes add
0840: 20 74 68 65 0a 65 78 74 65 6e 73 69 6f 6e 20 6e   the.extension n
0850: 61 6d 65 20 70 72 69 6f 72 20 74 6f 20 74 68 65  ame prior to the
0860: 20 75 6e 64 65 72 73 63 6f 72 65 3b 20 66 6f 72   underscore; for
0870: 20 65 78 61 6d 70 6c 65 3a 0a 3c 62 3e 73 71 6c   example:.<b>sql
0880: 69 74 65 33 72 62 75 5f 3c 2f 62 3e 20 6f 72 20  ite3rbu_</b> or 
0890: 3c 62 3e 73 71 6c 69 74 65 33 73 65 73 73 69 6f  <b>sqlite3sessio
08a0: 6e 5f 3c 2f 62 3e 2e 3c 2f 70 3e 0a 0a 3c 68 31  n_</b>.</p>..<h1
08b0: 3e 54 6f 6b 65 6e 69 7a 65 72 3c 2f 68 31 3e 0a  >Tokenizer</h1>.
08c0: 0a 3c 70 3e 57 68 65 6e 20 61 20 73 74 72 69 6e  .<p>When a strin
08d0: 67 20 63 6f 6e 74 61 69 6e 69 6e 67 20 53 51 4c  g containing SQL
08e0: 20 73 74 61 74 65 6d 65 6e 74 73 20 69 73 20 74   statements is t
08f0: 6f 20 62 65 20 65 76 61 6c 75 61 74 65 64 20 69  o be evaluated i
0900: 74 20 69 73 0a 66 69 72 73 74 20 73 65 6e 74 20  t is.first sent 
0910: 74 6f 20 74 68 65 20 74 6f 6b 65 6e 69 7a 65 72  to the tokenizer
0920: 2e 0a 54 68 65 20 74 6f 6b 65 6e 69 7a 65 72 20  ..The tokenizer 
0930: 62 72 65 61 6b 73 0a 74 68 65 20 53 51 4c 20 74  breaks.the SQL t
0940: 65 78 74 20 69 6e 74 6f 20 74 6f 6b 65 6e 73 20  ext into tokens 
0950: 61 6e 64 20 68 61 6e 64 73 20 74 68 6f 73 65 20  and hands those 
0960: 74 6f 6b 65 6e 73 0a 6f 6e 65 20 62 79 20 6f 6e  tokens.one by on
0970: 65 20 74 6f 20 74 68 65 20 70 61 72 73 65 72 2e  e to the parser.
0980: 20 20 54 68 65 20 74 6f 6b 65 6e 69 7a 65 72 20    The tokenizer 
0990: 69 73 20 68 61 6e 64 2d 63 6f 64 65 64 20 69 6e  is hand-coded in
09a0: 20 0a 74 68 65 20 66 69 6c 65 20 3c 66 69 6c 65   .the file <file
09b0: 3e 74 6f 6b 65 6e 69 7a 65 2e 63 3c 2f 62 3e 2e  >tokenize.c</b>.
09c0: 0a 0a 3c 70 3e 4e 6f 74 65 20 74 68 61 74 20 69  ..<p>Note that i
09d0: 6e 20 74 68 69 73 20 64 65 73 69 67 6e 2c 20 74  n this design, t
09e0: 68 65 20 74 6f 6b 65 6e 69 7a 65 72 20 63 61 6c  he tokenizer cal
09f0: 6c 73 20 74 68 65 20 70 61 72 73 65 72 2e 20 20  ls the parser.  
0a00: 50 65 6f 70 6c 65 0a 77 68 6f 20 61 72 65 20 66  People.who are f
0a10: 61 6d 69 6c 69 61 72 20 77 69 74 68 20 59 41 43  amiliar with YAC
0a20: 43 20 61 6e 64 20 42 49 53 4f 4e 20 6d 61 79 20  C and BISON may 
0a30: 62 65 20 61 63 63 75 73 74 6f 6d 65 64 20 74 6f  be accustomed to
0a40: 20 64 6f 69 6e 67 20 74 68 69 6e 67 73 20 74 68   doing things th
0a50: 65 0a 6f 74 68 65 72 20 77 61 79 20 61 72 6f 75  e.other way arou
0a60: 6e 64 20 26 6d 64 61 73 68 3b 20 68 61 76 69 6e  nd &mdash; havin
0a70: 67 20 74 68 65 20 70 61 72 73 65 72 20 63 61 6c  g the parser cal
0a80: 6c 20 74 68 65 20 74 6f 6b 65 6e 69 7a 65 72 2e  l the tokenizer.
0a90: 20 20 48 61 76 69 6e 67 0a 74 68 65 20 74 6f 6b    Having.the tok
0aa0: 65 6e 69 7a 65 72 20 63 61 6c 6c 20 74 68 65 20  enizer call the 
0ab0: 70 61 72 73 65 72 20 69 73 20 62 65 74 74 65 72  parser is better
0ac0: 2c 20 74 68 6f 75 67 68 2c 20 62 65 63 61 75 73  , though, becaus
0ad0: 65 20 69 74 20 63 61 6e 20 62 65 20 6d 61 64 65  e it can be made
0ae0: 0a 74 68 72 65 61 64 73 61 66 65 20 61 6e 64 20  .threadsafe and 
0af0: 69 74 20 72 75 6e 73 20 66 61 73 74 65 72 2e 3c  it runs faster.<
0b00: 2f 70 3e 0a 0a 3c 68 31 3e 50 61 72 73 65 72 3c  /p>..<h1>Parser<
0b10: 2f 68 31 3e 0a 0a 3c 70 3e 54 68 65 20 70 61 72  /h1>..<p>The par
0b20: 73 65 72 20 61 73 73 69 67 6e 73 20 6d 65 61 6e  ser assigns mean
0b30: 69 6e 67 20 74 6f 20 74 6f 6b 65 6e 73 20 62 61  ing to tokens ba
0b40: 73 65 64 20 6f 6e 0a 74 68 65 69 72 20 63 6f 6e  sed on.their con
0b50: 74 65 78 74 2e 20 20 54 68 65 20 70 61 72 73 65  text.  The parse
0b60: 72 20 66 6f 72 20 53 51 4c 69 74 65 20 69 73 20  r for SQLite is 
0b70: 67 65 6e 65 72 61 74 65 64 20 75 73 69 6e 67 20  generated using 
0b80: 74 68 65 0a 5b 4c 65 6d 6f 6e 20 70 61 72 73 65  the.[Lemon parse
0b90: 72 20 67 65 6e 65 72 61 74 6f 72 5d 2e 0a 4c 65  r generator]..Le
0ba0: 6d 6f 6e 20 64 6f 65 73 20 74 68 65 20 73 61 6d  mon does the sam
0bb0: 65 20 6a 6f 62 20 61 73 20 59 41 43 43 2f 42 49  e job as YACC/BI
0bc0: 53 4f 4e 2c 20 62 75 74 20 69 74 20 75 73 65 73  SON, but it uses
0bd0: 0a 61 20 64 69 66 66 65 72 65 6e 74 20 69 6e 70  .a different inp
0be0: 75 74 20 73 79 6e 74 61 78 20 77 68 69 63 68 20  ut syntax which 
0bf0: 69 73 20 6c 65 73 73 20 65 72 72 6f 72 2d 70 72  is less error-pr
0c00: 6f 6e 65 2e 0a 4c 65 6d 6f 6e 20 61 6c 73 6f 20  one..Lemon also 
0c10: 67 65 6e 65 72 61 74 65 73 20 61 20 70 61 72 73  generates a pars
0c20: 65 72 20 77 68 69 63 68 20 69 73 20 72 65 65 6e  er which is reen
0c30: 74 72 61 6e 74 20 61 6e 64 20 74 68 72 65 61 64  trant and thread
0c40: 2d 73 61 66 65 2e 0a 41 6e 64 20 4c 65 6d 6f 6e  -safe..And Lemon
0c50: 20 64 65 66 69 6e 65 73 20 74 68 65 20 63 6f 6e   defines the con
0c60: 63 65 70 74 20 6f 66 20 61 20 6e 6f 6e 2d 74 65  cept of a non-te
0c70: 72 6d 69 6e 61 6c 20 64 65 73 74 72 75 63 74 6f  rminal destructo
0c80: 72 20 73 6f 0a 74 68 61 74 20 69 74 20 64 6f 65  r so.that it doe
0c90: 73 20 6e 6f 74 20 6c 65 61 6b 20 6d 65 6d 6f 72  s not leak memor
0ca0: 79 20 77 68 65 6e 20 73 79 6e 74 61 78 20 65 72  y when syntax er
0cb0: 72 6f 72 73 20 61 72 65 20 65 6e 63 6f 75 6e 74  rors are encount
0cc0: 65 72 65 64 2e 0a 54 68 65 20 67 72 61 6d 6d 61  ered..The gramma
0cd0: 72 20 66 69 6c 65 20 74 68 61 74 20 64 72 69 76  r file that driv
0ce0: 65 73 20 4c 65 6d 6f 6e 20 61 6e 64 20 74 68 61  es Lemon and tha
0cf0: 74 20 64 65 66 69 6e 65 73 20 74 68 65 20 53 51  t defines the SQ
0d00: 4c 20 6c 61 6e 67 75 61 67 65 0a 74 68 61 74 20  L language.that 
0d10: 53 51 4c 69 74 65 20 75 6e 64 65 72 73 74 61 6e  SQLite understan
0d20: 64 73 20 69 73 20 66 6f 75 6e 64 20 69 6e 20 3c  ds is found in <
0d30: 66 69 6c 65 3e 70 61 72 73 65 2e 79 3c 2f 66 69  file>parse.y</fi
0d40: 6c 65 3e 2e 0a 0a 3c 70 3e 42 65 63 61 75 73 65  le>...<p>Because
0d50: 0a 4c 65 6d 6f 6e 20 69 73 20 61 20 70 72 6f 67  .Lemon is a prog
0d60: 72 61 6d 20 6e 6f 74 20 6e 6f 72 6d 61 6c 6c 79  ram not normally
0d70: 20 66 6f 75 6e 64 20 6f 6e 20 64 65 76 65 6c 6f   found on develo
0d80: 70 6d 65 6e 74 20 6d 61 63 68 69 6e 65 73 2c 20  pment machines, 
0d90: 74 68 65 0a 63 6f 6d 70 6c 65 74 65 20 73 6f 75  the.complete sou
0da0: 72 63 65 20 63 6f 64 65 20 74 6f 20 4c 65 6d 6f  rce code to Lemo
0db0: 6e 20 28 6a 75 73 74 20 6f 6e 65 20 43 20 66 69  n (just one C fi
0dc0: 6c 65 29 20 69 73 20 69 6e 63 6c 75 64 65 64 20  le) is included 
0dd0: 69 6e 20 74 68 65 0a 53 51 4c 69 74 65 20 64 69  in the.SQLite di
0de0: 73 74 72 69 62 75 74 69 6f 6e 20 69 6e 20 74 68  stribution in th
0df0: 65 20 22 74 6f 6f 6c 22 20 73 75 62 64 69 72 65  e "tool" subdire
0e00: 63 74 6f 72 79 2e 0a 3c 2f 70 3e 0a 0a 3c 68 31  ctory..</p>..<h1
0e10: 3e 43 6f 64 65 20 47 65 6e 65 72 61 74 6f 72 3c  >Code Generator<
0e20: 2f 68 31 3e 0a 0a 3c 70 3e 41 66 74 65 72 20 74  /h1>..<p>After t
0e30: 68 65 20 70 61 72 73 65 72 20 61 73 73 65 6d 62  he parser assemb
0e40: 6c 65 73 20 74 6f 6b 65 6e 73 20 69 6e 74 6f 20  les tokens into 
0e50: 61 20 70 61 72 73 65 20 74 72 65 65 2c 0a 74 68  a parse tree,.th
0e60: 65 20 63 6f 64 65 20 67 65 6e 65 72 61 74 6f 72  e code generator
0e70: 20 72 75 6e 73 20 74 6f 20 61 6e 61 6c 79 7a 65   runs to analyze
0e80: 20 74 68 65 20 70 61 72 73 65 72 20 74 72 65 65   the parser tree
0e90: 20 61 6e 64 20 67 65 6e 65 72 61 74 65 0a 5b 62   and generate.[b
0ea0: 79 74 65 63 6f 64 65 5d 20 74 68 61 74 20 70 65  ytecode] that pe
0eb0: 72 66 6f 72 6d 73 20 74 68 65 20 77 6f 72 6b 20  rforms the work 
0ec0: 6f 66 20 74 68 65 20 53 51 4c 20 73 74 61 74 65  of the SQL state
0ed0: 6d 65 6e 74 2e 0a 54 68 65 20 5b 70 72 65 70 61  ment..The [prepa
0ee0: 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 6f  red statement] o
0ef0: 62 6a 65 63 74 20 69 73 20 61 20 63 6f 6e 74 61  bject is a conta
0f00: 69 6e 65 72 20 66 6f 72 20 74 68 69 73 20 62 79  iner for this by
0f10: 74 65 63 6f 64 65 2e 0a 54 68 65 72 65 20 61 72  tecode..There ar
0f20: 65 20 6d 61 6e 79 20 66 69 6c 65 73 20 69 6e 20  e many files in 
0f30: 74 68 65 20 63 6f 64 65 20 67 65 6e 65 72 61 74  the code generat
0f40: 6f 72 2c 20 69 6e 63 6c 75 64 69 6e 67 3a 0a 3c  or, including:.<
0f50: 66 69 6c 65 3e 61 74 74 61 63 68 2e 63 3c 2f 66  file>attach.c</f
0f60: 69 6c 65 3e 2c 0a 3c 66 69 6c 65 3e 61 75 74 68  ile>,.<file>auth
0f70: 2e 63 3c 2f 66 69 6c 65 3e 2c 0a 3c 66 69 6c 65  .c</file>,.<file
0f80: 3e 62 75 69 6c 64 2e 63 3c 2f 66 69 6c 65 3e 2c  >build.c</file>,
0f90: 0a 3c 66 69 6c 65 3e 64 65 6c 65 74 65 2e 63 3c  .<file>delete.c<
0fa0: 2f 66 69 6c 65 3e 2c 0a 3c 66 69 6c 65 3e 65 78  /file>,.<file>ex
0fb0: 70 72 2e 63 3c 2f 66 69 6c 65 3e 2c 0a 3c 66 69  pr.c</file>,.<fi
0fc0: 6c 65 3e 69 6e 73 65 72 74 2e 63 3c 2f 66 69 6c  le>insert.c</fil
0fd0: 65 3e 2c 0a 3c 66 69 6c 65 3e 70 72 61 67 6d 61  e>,.<file>pragma
0fe0: 2e 63 3c 2f 66 69 6c 65 3e 2c 0a 3c 66 69 6c 65  .c</file>,.<file
0ff0: 3e 73 65 6c 65 63 74 2e 63 3c 2f 66 69 6c 65 3e  >select.c</file>
1000: 2c 0a 3c 66 69 6c 65 3e 74 72 69 67 67 65 72 2e  ,.<file>trigger.
1010: 63 3c 2f 66 69 6c 65 3e 2c 0a 3c 66 69 6c 65 3e  c</file>,.<file>
1020: 75 70 64 61 74 65 2e 63 3c 2f 66 69 6c 65 3e 2c  update.c</file>,
1030: 0a 3c 66 69 6c 65 3e 76 61 63 75 75 6d 2e 63 3c  .<file>vacuum.c<
1040: 2f 66 69 6c 65 3e 2c 0a 3c 66 69 6c 65 3e 77 68  /file>,.<file>wh
1050: 65 72 65 2e 63 3c 2f 66 69 6c 65 3e 2c 0a 3c 66  ere.c</file>,.<f
1060: 69 6c 65 3e 77 68 65 72 65 63 6f 64 65 2e 63 3c  ile>wherecode.c<
1070: 2f 66 69 6c 65 3e 2c 20 61 6e 64 0a 3c 66 69 6c  /file>, and.<fil
1080: 65 3e 77 68 65 72 65 65 78 70 72 2e 63 3c 2f 66  e>whereexpr.c</f
1090: 69 6c 65 3e 2e 0a 49 6e 20 74 68 65 73 65 20 66  ile>..In these f
10a0: 69 6c 65 73 20 69 73 20 77 68 65 72 65 20 6d 6f  iles is where mo
10b0: 73 74 20 6f 66 20 74 68 65 20 73 65 72 69 6f 75  st of the seriou
10c0: 73 20 6d 61 67 69 63 20 68 61 70 70 65 6e 73 2e  s magic happens.
10d0: 0a 3c 66 69 6c 65 3e 65 78 70 72 2e 63 3c 2f 66  .<file>expr.c</f
10e0: 69 6c 65 3e 20 68 61 6e 64 6c 65 73 20 63 6f 64  ile> handles cod
10f0: 65 20 67 65 6e 65 72 61 74 69 6f 6e 20 66 6f 72  e generation for
1100: 20 65 78 70 72 65 73 73 69 6f 6e 73 2e 0a 3c 62   expressions..<b
1110: 3e 77 68 65 72 65 2a 2e 63 3c 2f 62 3e 20 68 61  >where*.c</b> ha
1120: 6e 64 6c 65 73 20 63 6f 64 65 20 67 65 6e 65 72  ndles code gener
1130: 61 74 69 6f 6e 20 66 6f 72 20 57 48 45 52 45 20  ation for WHERE 
1140: 63 6c 61 75 73 65 73 20 6f 6e 0a 53 45 4c 45 43  clauses on.SELEC
1150: 54 2c 20 55 50 44 41 54 45 20 61 6e 64 20 44 45  T, UPDATE and DE
1160: 4c 45 54 45 20 73 74 61 74 65 6d 65 6e 74 73 2e  LETE statements.
1170: 20 20 54 68 65 20 66 69 6c 65 73 20 3c 66 69 6c    The files <fil
1180: 65 3e 61 74 74 61 63 68 2e 63 3c 2f 66 69 6c 65  e>attach.c</file
1190: 3e 2c 0a 3c 66 69 6c 65 3e 64 65 6c 65 74 65 2e  >,.<file>delete.
11a0: 63 3c 2f 66 69 6c 65 3e 2c 20 3c 66 69 6c 65 3e  c</file>, <file>
11b0: 69 6e 73 65 72 74 2e 63 3c 2f 66 69 6c 65 3e 2c  insert.c</file>,
11c0: 20 3c 66 69 6c 65 3e 73 65 6c 65 63 74 2e 63 3c   <file>select.c<
11d0: 2f 66 69 6c 65 3e 2c 20 0a 3c 66 69 6c 65 3e 74  /file>, .<file>t
11e0: 72 69 67 67 65 72 2e 63 3c 2f 66 69 6c 65 3e 0a  rigger.c</file>.
11f0: 3c 66 69 6c 65 3e 75 70 64 61 74 65 2e 63 3c 2f  <file>update.c</
1200: 66 69 6c 65 3e 2c 20 61 6e 64 20 3c 66 69 6c 65  file>, and <file
1210: 3e 76 61 63 75 75 6d 2e 63 3c 2f 66 69 6c 65 3e  >vacuum.c</file>
1220: 20 68 61 6e 64 6c 65 20 74 68 65 20 63 6f 64 65   handle the code
1230: 20 67 65 6e 65 72 61 74 69 6f 6e 0a 66 6f 72 20   generation.for 
1240: 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 20 77  SQL statements w
1250: 69 74 68 20 74 68 65 20 73 61 6d 65 20 6e 61 6d  ith the same nam
1260: 65 73 2e 20 20 28 45 61 63 68 20 6f 66 20 74 68  es.  (Each of th
1270: 65 73 65 20 66 69 6c 65 73 20 63 61 6c 6c 73 20  ese files calls 
1280: 72 6f 75 74 69 6e 65 73 0a 69 6e 20 3c 66 69 6c  routines.in <fil
1290: 65 3e 65 78 70 72 2e 63 3c 2f 66 69 6c 65 3e 20  e>expr.c</file> 
12a0: 61 6e 64 20 3c 66 69 6c 65 3e 77 68 65 72 65 2e  and <file>where.
12b0: 63 3c 2f 66 69 6c 65 3e 20 61 73 20 6e 65 63 65  c</file> as nece
12c0: 73 73 61 72 79 2e 29 20 20 41 6c 6c 20 6f 74 68  ssary.)  All oth
12d0: 65 72 0a 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  er.SQL statement
12e0: 73 20 61 72 65 20 63 6f 64 65 64 20 6f 75 74 20  s are coded out 
12f0: 6f 66 20 3c 66 69 6c 65 3e 62 75 69 6c 64 2e 63  of <file>build.c
1300: 3c 2f 66 69 6c 65 3e 2e 0a 54 68 65 20 3c 66 69  </file>..The <fi
1310: 6c 65 3e 61 75 74 68 2e 63 3c 2f 66 69 6c 65 3e  le>auth.c</file>
1320: 20 66 69 6c 65 20 69 6d 70 6c 65 6d 65 6e 74 73   file implements
1330: 20 74 68 65 20 66 75 6e 63 74 69 6f 6e 61 6c 69   the functionali
1340: 74 79 20 6f 66 0a 5b 73 71 6c 69 74 65 33 5f 73  ty of.[sqlite3_s
1350: 65 74 5f 61 75 74 68 6f 72 69 7a 65 72 28 29 5d  et_authorizer()]
1360: 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 63 6f  .</p>..<p>The co
1370: 64 65 20 67 65 6e 65 72 61 74 6f 72 2c 20 61 6e  de generator, an
1380: 64 20 65 73 70 65 63 69 61 6c 6c 79 20 74 68 65  d especially the
1390: 20 6c 6f 67 69 63 20 69 6e 20 3c 62 3e 77 68 65   logic in <b>whe
13a0: 72 65 2a 2e 63 3c 2f 62 3e 0a 61 6e 64 20 69 6e  re*.c</b>.and in
13b0: 20 3c 66 69 6c 65 3e 73 65 6c 65 63 74 2e 63 3c   <file>select.c<
13c0: 2f 66 69 6c 65 3e 2c 20 69 73 20 73 6f 6d 65 74  /file>, is somet
13d0: 69 6d 65 73 20 63 61 6c 6c 65 64 20 74 68 65 0a  imes called the.
13e0: 5b 71 75 65 72 79 20 70 6c 61 6e 6e 65 72 5d 2e  [query planner].
13f0: 20 20 46 6f 72 20 61 6e 79 20 70 61 72 74 69 63    For any partic
1400: 75 6c 61 72 20 53 51 4c 20 73 74 61 74 65 6d 65  ular SQL stateme
1410: 6e 74 2c 20 74 68 65 72 65 20 6d 69 67 68 74 20  nt, there might 
1420: 62 65 0a 68 75 6e 64 72 65 64 73 2c 20 74 68 6f  be.hundreds, tho
1430: 75 73 61 6e 64 73 2c 20 6f 72 20 6d 69 6c 6c 69  usands, or milli
1440: 6f 6e 73 20 6f 66 20 64 69 66 66 65 72 65 6e 74  ons of different
1450: 20 61 6c 67 6f 72 69 74 68 6d 73 20 74 6f 20 63   algorithms to c
1460: 6f 6d 70 75 74 65 0a 74 68 65 20 61 6e 73 77 65  ompute.the answe
1470: 72 2e 20 20 54 68 65 20 71 75 65 72 79 20 70 6c  r.  The query pl
1480: 61 6e 6e 65 72 20 69 73 20 61 6e 20 41 49 20 74  anner is an AI t
1490: 68 61 74 20 73 74 72 69 76 65 73 20 74 6f 20 73  hat strives to s
14a0: 65 6c 65 63 74 20 74 68 65 0a 62 65 73 74 20 61  elect the.best a
14b0: 6c 67 6f 72 69 74 68 6d 20 66 72 6f 6d 20 74 68  lgorithm from th
14c0: 65 73 65 20 6d 69 6c 6c 69 6f 6e 73 20 6f 66 20  ese millions of 
14d0: 63 68 6f 69 63 65 73 2e 0a 0a 3c 68 31 3e 42 79  choices...<h1>By
14e0: 74 65 63 6f 64 65 20 45 6e 67 69 6e 65 3c 2f 68  tecode Engine</h
14f0: 31 3e 0a 0a 3c 70 3e 54 68 65 20 5b 62 79 74 65  1>..<p>The [byte
1500: 63 6f 64 65 5d 20 70 72 6f 67 72 61 6d 20 63 72  code] program cr
1510: 65 61 74 65 64 20 62 79 20 74 68 65 20 63 6f 64  eated by the cod
1520: 65 20 67 65 6e 65 72 61 74 6f 72 20 69 73 20 72  e generator is r
1530: 75 6e 20 62 79 0a 61 20 76 69 72 74 75 61 6c 20  un by.a virtual 
1540: 6d 61 63 68 69 6e 65 2e 0a 0a 3c 70 3e 54 68 65  machine...<p>The
1550: 20 76 69 72 74 75 61 6c 20 6d 61 63 68 69 6e 65   virtual machine
1560: 20 69 74 73 65 6c 66 20 69 73 20 65 6e 74 69 72   itself is entir
1570: 65 6c 79 20 63 6f 6e 74 61 69 6e 65 64 20 69 6e  ely contained in
1580: 20 61 20 73 69 6e 67 6c 65 0a 73 6f 75 72 63 65   a single.source
1590: 20 66 69 6c 65 20 3c 66 69 6c 65 3e 76 64 62 65   file <file>vdbe
15a0: 2e 63 3c 2f 66 69 6c 65 3e 2e 20 20 54 68 65 0a  .c</file>.  The.
15b0: 3c 66 69 6c 65 3e 76 64 62 65 2e 68 3c 2f 66 69  <file>vdbe.h</fi
15c0: 6c 65 3e 20 68 65 61 64 65 72 20 66 69 6c 65 20  le> header file 
15d0: 64 65 66 69 6e 65 73 20 61 6e 20 69 6e 74 65 72  defines an inter
15e0: 66 61 63 65 0a 62 65 74 77 65 65 6e 20 74 68 65  face.between the
15f0: 20 76 69 72 74 75 61 6c 20 6d 61 63 68 69 6e 65   virtual machine
1600: 20 61 6e 64 20 74 68 65 20 72 65 73 74 20 6f 66   and the rest of
1610: 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62 72   the SQLite libr
1620: 61 72 79 20 61 6e 64 0a 3c 66 69 6c 65 3e 76 64  ary and.<file>vd
1630: 62 65 49 6e 74 2e 68 3c 2f 66 69 6c 65 3e 20 77  beInt.h</file> w
1640: 68 69 63 68 20 64 65 66 69 6e 65 73 20 73 74 72  hich defines str
1650: 75 63 74 75 72 65 73 20 61 6e 64 20 69 6e 74 65  uctures and inte
1660: 72 66 61 63 65 73 20 74 68 61 74 0a 61 72 65 20  rfaces that.are 
1670: 70 72 69 76 61 74 65 20 74 68 65 20 76 69 72 74  private the virt
1680: 75 61 6c 20 6d 61 63 68 69 6e 65 20 69 74 73 65  ual machine itse
1690: 6c 66 2e 0a 56 61 72 69 6f 75 73 20 6f 74 68 65  lf..Various othe
16a0: 72 20 3c 62 3e 76 64 62 65 2a 2e 63 3c 2f 62 3e  r <b>vdbe*.c</b>
16b0: 20 66 69 6c 65 73 20 61 72 65 20 68 65 6c 70 65   files are helpe
16c0: 72 73 20 74 6f 20 74 68 65 20 76 69 72 74 75 61  rs to the virtua
16d0: 6c 20 6d 61 63 68 69 6e 65 2e 0a 54 68 65 20 3c  l machine..The <
16e0: 66 69 6c 65 3e 76 64 62 65 61 75 78 2e 63 3c 2f  file>vdbeaux.c</
16f0: 66 69 6c 65 3e 20 66 69 6c 65 20 63 6f 6e 74 61  file> file conta
1700: 69 6e 73 20 75 74 69 6c 69 74 69 65 73 20 75 73  ins utilities us
1710: 65 64 20 62 79 20 74 68 65 20 76 69 72 74 75 61  ed by the virtua
1720: 6c 0a 6d 61 63 68 69 6e 65 20 61 6e 64 20 69 6e  l.machine and in
1730: 74 65 72 66 61 63 65 20 6d 6f 64 75 6c 65 73 20  terface modules 
1740: 75 73 65 64 20 62 79 20 74 68 65 20 72 65 73 74  used by the rest
1750: 20 6f 66 20 74 68 65 20 6c 69 62 72 61 72 79 20   of the library 
1760: 74 6f 0a 63 6f 6e 73 74 72 75 63 74 20 56 4d 20  to.construct VM 
1770: 70 72 6f 67 72 61 6d 73 2e 20 20 54 68 65 20 3c  programs.  The <
1780: 66 69 6c 65 3e 76 64 62 65 61 70 69 2e 63 3c 2f  file>vdbeapi.c</
1790: 66 69 6c 65 3e 20 66 69 6c 65 20 63 6f 6e 74 61  file> file conta
17a0: 69 6e 73 20 65 78 74 65 72 6e 61 6c 0a 69 6e 74  ins external.int
17b0: 65 72 66 61 63 65 73 20 74 6f 20 74 68 65 20 76  erfaces to the v
17c0: 69 72 74 75 61 6c 20 6d 61 63 68 69 6e 65 20 73  irtual machine s
17d0: 75 63 68 20 61 73 20 74 68 65 20 0a 5b 73 71 6c  uch as the .[sql
17e0: 69 74 65 33 5f 62 69 6e 64 5f 69 6e 74 28 29 5d  ite3_bind_int()]
17f0: 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 73 74   and [sqlite3_st
1800: 65 70 28 29 5d 2e 20 20 49 6e 64 69 76 69 64 75  ep()].  Individu
1810: 61 6c 20 76 61 6c 75 65 73 0a 28 73 74 72 69 6e  al values.(strin
1820: 67 73 2c 20 69 6e 74 65 67 65 72 2c 20 66 6c 6f  gs, integer, flo
1830: 61 74 69 6e 67 20 70 6f 69 6e 74 20 6e 75 6d 62  ating point numb
1840: 65 72 73 2c 20 61 6e 64 20 42 4c 4f 42 73 29 20  ers, and BLOBs) 
1850: 61 72 65 20 73 74 6f 72 65 64 0a 69 6e 20 61 6e  are stored.in an
1860: 20 69 6e 74 65 72 6e 61 6c 20 6f 62 6a 65 63 74   internal object
1870: 20 6e 61 6d 65 64 20 22 4d 65 6d 22 20 77 68 69   named "Mem" whi
1880: 63 68 20 69 73 20 69 6d 70 6c 65 6d 65 6e 74 65  ch is implemente
1890: 64 20 62 79 0a 3c 66 69 6c 65 3e 76 64 62 65 6d  d by.<file>vdbem
18a0: 65 6d 2e 63 3c 2f 66 69 6c 65 3e 2e 3c 2f 70 3e  em.c</file>.</p>
18b0: 0a 0a 3c 70 3e 0a 53 51 4c 69 74 65 20 69 6d 70  ..<p>.SQLite imp
18c0: 6c 65 6d 65 6e 74 73 20 53 51 4c 20 66 75 6e 63  lements SQL func
18d0: 74 69 6f 6e 73 20 75 73 69 6e 67 20 63 61 6c 6c  tions using call
18e0: 62 61 63 6b 73 20 74 6f 20 43 2d 6c 61 6e 67 75  backs to C-langu
18f0: 61 67 65 20 72 6f 75 74 69 6e 65 73 2e 0a 45 76  age routines..Ev
1900: 65 6e 20 74 68 65 20 62 75 69 6c 74 2d 69 6e 20  en the built-in 
1910: 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20 61 72  SQL functions ar
1920: 65 20 69 6d 70 6c 65 6d 65 6e 74 65 64 20 74 68  e implemented th
1930: 69 73 20 77 61 79 2e 20 20 4d 6f 73 74 20 6f 66  is way.  Most of
1940: 0a 74 68 65 20 62 75 69 6c 74 2d 69 6e 20 53 51  .the built-in SQ
1950: 4c 20 66 75 6e 63 74 69 6f 6e 73 20 28 65 78 3a  L functions (ex:
1960: 20 5b 61 62 73 28 29 5d 2c 20 5b 63 6f 75 6e 74   [abs()], [count
1970: 28 29 5d 2c 0a 5b 73 75 62 73 74 72 28 29 5d 2c  ()],.[substr()],
1980: 20 61 6e 64 20 73 6f 20 66 6f 72 74 68 29 20 63   and so forth) c
1990: 61 6e 20 62 65 20 66 6f 75 6e 64 20 69 6e 20 3c  an be found in <
19a0: 66 69 6c 65 3e 66 75 6e 63 2e 63 3c 2f 66 69 6c  file>func.c</fil
19b0: 65 3e 20 73 6f 75 72 63 65 0a 66 69 6c 65 2e 0a  e> source.file..
19c0: 44 61 74 65 20 61 6e 64 20 74 69 6d 65 20 63 6f  Date and time co
19d0: 6e 76 65 72 73 69 6f 6e 20 66 75 6e 63 74 69 6f  nversion functio
19e0: 6e 73 20 61 72 65 20 66 6f 75 6e 64 20 69 6e 20  ns are found in 
19f0: 3c 66 69 6c 65 3e 64 61 74 65 2e 63 3c 2f 66 69  <file>date.c</fi
1a00: 6c 65 3e 2e 0a 53 6f 6d 65 20 66 75 6e 63 74 69  le>..Some functi
1a10: 6f 6e 73 20 73 75 63 68 20 61 73 20 5b 63 6f 61  ons such as [coa
1a20: 6c 65 73 63 65 28 29 5d 20 61 6e 64 20 5b 74 79  lesce()] and [ty
1a30: 70 65 6f 66 28 29 5d 20 61 72 65 20 69 6d 70 6c  peof()] are impl
1a40: 65 6d 65 6e 74 65 64 0a 61 73 20 62 79 74 65 63  emented.as bytec
1a50: 6f 64 65 20 64 69 72 65 63 74 6c 79 20 62 79 20  ode directly by 
1a60: 74 68 65 20 63 6f 64 65 20 67 65 6e 65 72 61 74  the code generat
1a70: 6f 72 2e 0a 3c 2f 70 3e 0a 0a 3c 68 31 3e 42 2d  or..</p>..<h1>B-
1a80: 54 72 65 65 3c 2f 68 31 3e 0a 0a 3c 70 3e 41 6e  Tree</h1>..<p>An
1a90: 20 53 51 4c 69 74 65 20 64 61 74 61 62 61 73 65   SQLite database
1aa0: 20 69 73 20 6d 61 69 6e 74 61 69 6e 65 64 20 6f   is maintained o
1ab0: 6e 20 64 69 73 6b 20 75 73 69 6e 67 20 61 20 42  n disk using a B
1ac0: 2d 74 72 65 65 20 69 6d 70 6c 65 6d 65 6e 74 61  -tree implementa
1ad0: 74 69 6f 6e 0a 66 6f 75 6e 64 20 69 6e 20 74 68  tion.found in th
1ae0: 65 20 3c 66 69 6c 65 3e 62 74 72 65 65 2e 63 3c  e <file>btree.c<
1af0: 2f 66 69 6c 65 3e 20 73 6f 75 72 63 65 20 66 69  /file> source fi
1b00: 6c 65 2e 20 20 41 20 73 65 70 61 72 61 74 65 20  le.  A separate 
1b10: 42 2d 74 72 65 65 20 69 73 20 75 73 65 64 20 66  B-tree is used f
1b20: 6f 72 0a 65 61 63 68 20 74 61 62 6c 65 20 61 6e  or.each table an
1b30: 64 20 69 6e 64 65 78 20 69 6e 20 74 68 65 20 64  d index in the d
1b40: 61 74 61 62 61 73 65 2e 20 20 41 6c 6c 20 42 2d  atabase.  All B-
1b50: 74 72 65 65 73 20 61 72 65 20 73 74 6f 72 65 64  trees are stored
1b60: 20 69 6e 20 74 68 65 0a 73 61 6d 65 20 64 69 73   in the.same dis
1b70: 6b 20 66 69 6c 65 2e 20 20 54 68 65 20 5b 66 69  k file.  The [fi
1b80: 6c 65 20 66 6f 72 6d 61 74 5d 20 64 65 74 61 69  le format] detai
1b90: 6c 73 20 61 72 65 20 73 74 61 62 6c 65 20 61 6e  ls are stable an
1ba0: 64 20 77 65 6c 6c 2d 64 65 66 69 6e 65 64 20 61  d well-defined a
1bb0: 6e 64 0a 61 72 65 20 67 75 61 72 61 6e 74 65 65  nd.are guarantee
1bc0: 64 20 74 6f 20 62 65 20 63 6f 6d 70 61 74 69 62  d to be compatib
1bd0: 6c 65 20 6d 6f 76 69 6e 67 20 66 6f 72 77 61 72  le moving forwar
1be0: 64 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 69  d.</p>..<p>The i
1bf0: 6e 74 65 72 66 61 63 65 20 74 6f 20 74 68 65 20  nterface to the 
1c00: 42 2d 74 72 65 65 20 73 75 62 73 79 73 74 65 6d  B-tree subsystem
1c10: 20 61 6e 64 20 74 68 65 20 72 65 73 74 20 6f 66   and the rest of
1c20: 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62 72   the SQLite libr
1c30: 61 72 79 0a 69 73 20 64 65 66 69 6e 65 64 20 62  ary.is defined b
1c40: 79 20 74 68 65 20 68 65 61 64 65 72 20 66 69 6c  y the header fil
1c50: 65 20 3c 66 69 6c 65 3e 62 74 72 65 65 2e 68 3c  e <file>btree.h<
1c60: 2f 66 69 6c 65 3e 2e 0a 3c 2f 70 3e 0a 0a 3c 68  /file>..</p>..<h
1c70: 31 3e 50 61 67 65 20 43 61 63 68 65 3c 2f 68 31  1>Page Cache</h1
1c80: 3e 0a 0a 3c 70 3e 54 68 65 20 42 2d 74 72 65 65  >..<p>The B-tree
1c90: 20 6d 6f 64 75 6c 65 20 72 65 71 75 65 73 74 73   module requests
1ca0: 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 66 72 6f   information fro
1cb0: 6d 20 74 68 65 20 64 69 73 6b 20 69 6e 20 66 69  m the disk in fi
1cc0: 78 65 64 2d 73 69 7a 65 0a 70 61 67 65 73 2e 20  xed-size.pages. 
1cd0: 20 54 68 65 20 64 65 66 61 75 6c 74 20 5b 70 61   The default [pa
1ce0: 67 65 5f 73 69 7a 65 5d 20 69 73 20 34 30 39 36  ge_size] is 4096
1cf0: 20 62 79 74 65 73 20 62 75 74 20 63 61 6e 20 62   bytes but can b
1d00: 65 20 61 6e 79 20 70 6f 77 65 72 20 6f 66 0a 74  e any power of.t
1d10: 77 6f 20 62 65 74 77 65 65 6e 20 35 31 32 20 61  wo between 512 a
1d20: 6e 64 20 36 35 35 33 36 20 62 79 74 65 73 2e 0a  nd 65536 bytes..
1d30: 54 68 65 20 70 61 67 65 20 63 61 63 68 65 20 69  The page cache i
1d40: 73 20 72 65 73 70 6f 6e 73 69 62 6c 65 20 66 6f  s responsible fo
1d50: 72 20 72 65 61 64 69 6e 67 2c 20 77 72 69 74 69  r reading, writi
1d60: 6e 67 2c 20 61 6e 64 0a 63 61 63 68 69 6e 67 20  ng, and.caching 
1d70: 74 68 65 73 65 20 70 61 67 65 73 2e 0a 54 68 65  these pages..The
1d80: 20 70 61 67 65 20 63 61 63 68 65 20 61 6c 73 6f   page cache also
1d90: 20 70 72 6f 76 69 64 65 73 20 74 68 65 20 72 6f   provides the ro
1da0: 6c 6c 62 61 63 6b 20 61 6e 64 20 61 74 6f 6d 69  llback and atomi
1db0: 63 20 63 6f 6d 6d 69 74 20 61 62 73 74 72 61 63  c commit abstrac
1dc0: 74 69 6f 6e 0a 61 6e 64 20 74 61 6b 65 73 20 63  tion.and takes c
1dd0: 61 72 65 20 6f 66 20 6c 6f 63 6b 69 6e 67 20 6f  are of locking o
1de0: 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66  f the database f
1df0: 69 6c 65 2e 20 20 54 68 65 0a 42 2d 74 72 65 65  ile.  The.B-tree
1e00: 20 64 72 69 76 65 72 20 72 65 71 75 65 73 74 73   driver requests
1e10: 20 70 61 72 74 69 63 75 6c 61 72 20 70 61 67 65   particular page
1e20: 73 20 66 72 6f 6d 20 74 68 65 20 70 61 67 65 20  s from the page 
1e30: 63 61 63 68 65 20 61 6e 64 20 6e 6f 74 69 66 69  cache and notifi
1e40: 65 73 0a 74 68 65 20 70 61 67 65 20 63 61 63 68  es.the page cach
1e50: 65 20 77 68 65 6e 20 69 74 20 77 61 6e 74 73 20  e when it wants 
1e60: 74 6f 20 6d 6f 64 69 66 79 20 70 61 67 65 73 20  to modify pages 
1e70: 6f 72 20 63 6f 6d 6d 69 74 20 6f 72 20 72 6f 6c  or commit or rol
1e80: 6c 62 61 63 6b 0a 63 68 61 6e 67 65 73 2e 20 54  lback.changes. T
1e90: 68 65 20 70 61 67 65 20 63 61 63 68 65 20 68 61  he page cache ha
1ea0: 6e 64 6c 65 73 20 61 6c 6c 20 74 68 65 20 6d 65  ndles all the me
1eb0: 73 73 79 20 64 65 74 61 69 6c 73 20 6f 66 20 6d  ssy details of m
1ec0: 61 6b 69 6e 67 20 73 75 72 65 0a 74 68 65 20 72  aking sure.the r
1ed0: 65 71 75 65 73 74 73 20 61 72 65 20 68 61 6e 64  equests are hand
1ee0: 6c 65 64 20 71 75 69 63 6b 6c 79 2c 20 73 61 66  led quickly, saf
1ef0: 65 6c 79 2c 20 61 6e 64 20 65 66 66 69 63 69 65  ely, and efficie
1f00: 6e 74 6c 79 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68  ntly.</p>..<p>Th
1f10: 65 20 70 72 69 6d 61 72 79 20 70 61 67 65 20 63  e primary page c
1f20: 61 63 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74  ache implementat
1f30: 69 6f 6e 20 69 73 20 69 6e 20 74 68 65 0a 3c 66  ion is in the.<f
1f40: 69 6c 65 3e 70 61 67 65 72 2e 63 3c 2f 66 69 6c  ile>pager.c</fil
1f50: 65 3e 20 66 69 6c 65 2e 20 20 5b 57 41 4c 20 6d  e> file.  [WAL m
1f60: 6f 64 65 5d 20 6c 6f 67 69 63 20 69 73 20 69 6e  ode] logic is in
1f70: 20 74 68 65 20 73 65 70 61 72 61 74 65 0a 3c 66   the separate.<f
1f80: 69 6c 65 3e 77 61 6c 2e 63 3c 2f 66 69 6c 65 3e  ile>wal.c</file>
1f90: 2e 20 20 49 6e 2d 6d 65 6d 6f 72 79 20 63 61 63  .  In-memory cac
1fa0: 68 69 6e 67 20 69 73 20 69 6d 70 6c 65 6d 65 6e  hing is implemen
1fb0: 74 65 64 20 62 79 20 74 68 65 0a 3c 66 69 6c 65  ted by the.<file
1fc0: 3e 70 63 61 63 68 65 2e 63 3c 2f 66 69 6c 65 3e  >pcache.c</file>
1fd0: 20 61 6e 64 20 3c 66 69 6c 65 3e 70 63 61 63 68   and <file>pcach
1fe0: 65 31 2e 63 3c 2f 66 69 6c 65 3e 20 66 69 6c 65  e1.c</file> file
1ff0: 73 2e 0a 54 68 65 20 69 6e 74 65 72 66 61 63 65  s..The interface
2000: 20 62 65 74 77 65 65 6e 20 70 61 67 65 20 63 61   between page ca
2010: 63 68 65 20 73 75 62 73 79 73 74 65 6d 0a 61 6e  che subsystem.an
2020: 64 20 74 68 65 20 72 65 73 74 20 6f 66 20 53 51  d the rest of SQ
2030: 4c 69 74 65 20 69 73 20 64 65 66 69 6e 65 64 20  Lite is defined 
2040: 62 79 20 74 68 65 20 68 65 61 64 65 72 20 66 69  by the header fi
2050: 6c 65 20 3c 66 69 6c 65 3e 70 61 67 65 72 2e 68  le <file>pager.h
2060: 3c 2f 66 69 6c 65 3e 2e 0a 3c 2f 70 3e 0a 0a 3c  </file>..</p>..<
2070: 68 31 3e 4f 53 20 49 6e 74 65 72 66 61 63 65 3c  h1>OS Interface<
2080: 2f 68 31 3e 0a 0a 3c 70 3e 0a 49 6e 20 6f 72 64  /h1>..<p>.In ord
2090: 65 72 20 74 6f 20 70 72 6f 76 69 64 65 20 70 6f  er to provide po
20a0: 72 74 61 62 69 6c 69 74 79 20 62 65 74 77 65 65  rtability betwee
20b0: 6e 20 61 63 72 6f 73 73 20 6f 70 65 72 61 74 69  n across operati
20c0: 6e 67 20 73 79 73 74 65 6d 73 2c 0a 53 51 4c 69  ng systems,.SQLi
20d0: 74 65 20 75 73 65 73 20 61 62 73 74 72 61 63 74  te uses abstract
20e0: 20 6f 62 6a 65 63 74 20 63 61 6c 6c 65 64 20 74   object called t
20f0: 68 65 20 5b 56 46 53 5d 2e 20 20 45 61 63 68 20  he [VFS].  Each 
2100: 56 46 53 20 70 72 6f 76 69 64 65 73 20 6d 65 74  VFS provides met
2110: 68 6f 64 73 0a 66 6f 72 20 6f 70 65 6e 69 6e 67  hods.for opening
2120: 2c 20 72 65 61 64 2c 20 77 72 69 74 69 6e 67 2c  , read, writing,
2130: 20 61 6e 64 20 63 6c 6f 73 69 6e 67 20 66 69 6c   and closing fil
2140: 65 73 20 6f 6e 20 64 69 73 6b 2c 20 61 6e 64 20  es on disk, and 
2150: 66 6f 72 20 6f 74 68 65 72 0a 4f 53 2d 73 70 65  for other.OS-spe
2160: 63 69 66 69 63 20 74 61 73 6b 20 73 75 63 68 20  cific task such 
2170: 61 73 20 66 69 6e 64 69 6e 67 20 74 68 65 20 63  as finding the c
2180: 75 72 72 65 6e 74 20 74 69 6d 65 2c 20 6f 72 20  urrent time, or 
2190: 6f 62 74 61 69 6e 69 6e 67 20 72 61 6e 64 6f 6d  obtaining random
21a0: 6e 65 73 73 0a 74 6f 20 69 6e 69 74 69 61 6c 69  ness.to initiali
21b0: 7a 65 20 74 68 65 20 62 75 69 6c 74 2d 69 6e 20  ze the built-in 
21c0: 70 73 65 75 64 6f 2d 72 61 6e 64 6f 6d 20 6e 75  pseudo-random nu
21d0: 6d 62 65 72 20 67 65 6e 65 72 61 74 6f 72 2e 0a  mber generator..
21e0: 53 51 4c 69 74 65 20 63 75 72 72 65 6e 74 6c 79  SQLite currently
21f0: 20 70 72 6f 76 69 64 65 73 20 56 46 53 65 73 20   provides VFSes 
2200: 66 6f 72 20 75 6e 69 78 20 28 69 6e 20 74 68 65  for unix (in the
2210: 20 3c 66 69 6c 65 3e 6f 73 5f 75 6e 69 78 2e 63   <file>os_unix.c
2220: 3c 2f 66 69 6c 65 3e 0a 66 69 6c 65 29 20 61 6e  </file>.file) an
2230: 64 20 57 69 6e 64 6f 77 73 20 28 69 6e 20 74 68  d Windows (in th
2240: 65 20 3c 66 69 6c 65 3e 6f 73 5f 77 69 6e 2e 63  e <file>os_win.c
2250: 3c 2f 66 69 6c 65 3e 20 66 69 6c 65 29 2e 0a 3c  </file> file)..<
2260: 2f 70 3e 0a 0a 3c 68 31 3e 55 74 69 6c 69 74 69  /p>..<h1>Utiliti
2270: 65 73 3c 2f 68 31 3e 0a 0a 3c 70 3e 0a 4d 65 6d  es</h1>..<p>.Mem
2280: 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 2c 20  ory allocation, 
2290: 63 61 73 65 6c 65 73 73 20 73 74 72 69 6e 67 20  caseless string 
22a0: 63 6f 6d 70 61 72 69 73 6f 6e 20 72 6f 75 74 69  comparison routi
22b0: 6e 65 73 2c 20 0a 70 6f 72 74 61 62 6c 65 20 74  nes, .portable t
22c0: 65 78 74 2d 74 6f 2d 6e 75 6d 62 65 72 20 63 6f  ext-to-number co
22d0: 6e 76 65 72 73 69 6f 6e 20 72 6f 75 74 69 6e 65  nversion routine
22e0: 73 2c 20 61 6e 64 20 6f 74 68 65 72 20 75 74 69  s, and other uti
22f0: 6c 69 74 69 65 73 0a 61 72 65 20 6c 6f 63 61 74  lities.are locat
2300: 65 64 20 69 6e 20 3c 66 69 6c 65 3e 75 74 69 6c  ed in <file>util
2310: 2e 63 3c 2f 66 69 6c 65 3e 2e 0a 53 79 6d 62 6f  .c</file>..Symbo
2320: 6c 20 74 61 62 6c 65 73 20 75 73 65 64 20 62 79  l tables used by
2330: 20 74 68 65 20 70 61 72 73 65 72 20 61 72 65 20   the parser are 
2340: 6d 61 69 6e 74 61 69 6e 65 64 20 62 79 20 68 61  maintained by ha
2350: 73 68 20 74 61 62 6c 65 73 20 66 6f 75 6e 64 0a  sh tables found.
2360: 69 6e 20 3c 66 69 6c 65 3e 68 61 73 68 2e 63 3c  in <file>hash.c<
2370: 2f 66 69 6c 65 3e 2e 20 20 54 68 65 20 3c 66 69  /file>.  The <fi
2380: 6c 65 3e 75 74 66 2e 63 3c 2f 66 69 6c 65 3e 20  le>utf.c</file> 
2390: 73 6f 75 72 63 65 20 66 69 6c 65 20 63 6f 6e 74  source file cont
23a0: 61 69 6e 73 20 55 6e 69 63 6f 64 65 0a 63 6f 6e  ains Unicode.con
23b0: 76 65 72 73 69 6f 6e 20 73 75 62 72 6f 75 74 69  version subrouti
23c0: 6e 65 73 2e 0a 53 51 4c 69 74 65 20 68 61 73 20  nes..SQLite has 
23d0: 69 74 73 20 6f 77 6e 20 70 72 69 76 61 74 65 20  its own private 
23e0: 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 6f  implementation o
23f0: 66 20 0a 5b 62 75 69 6c 74 2d 69 6e 20 70 72 69  f .[built-in pri
2400: 6e 74 66 7c 70 72 69 6e 74 66 28 29 5d 20 28 77  ntf|printf()] (w
2410: 69 74 68 0a 73 6f 6d 65 20 65 78 74 65 6e 73 69  ith.some extensi
2420: 6f 6e 73 29 20 69 6e 20 3c 66 69 6c 65 3e 70 72  ons) in <file>pr
2430: 69 6e 74 66 2e 63 3c 2f 66 69 6c 65 3e 20 61 6e  intf.c</file> an
2440: 64 20 69 74 73 20 6f 77 6e 0a 70 73 65 75 64 6f  d its own.pseudo
2450: 2d 72 61 6e 64 6f 6d 20 6e 75 6d 62 65 72 20 67  -random number g
2460: 65 6e 65 72 61 74 6f 72 20 28 50 52 4e 47 29 20  enerator (PRNG) 
2470: 69 6e 20 3c 66 69 6c 65 3e 72 61 6e 64 6f 6d 2e  in <file>random.
2480: 63 3c 2f 66 69 6c 65 3e 2e 0a 3c 2f 70 3e 0a 0a  c</file>..</p>..
2490: 3c 68 31 3e 54 65 73 74 20 43 6f 64 65 3c 2f 68  <h1>Test Code</h
24a0: 31 3e 0a 0a 3c 70 3e 0a 46 69 6c 65 73 20 69 6e  1>..<p>.Files in
24b0: 20 74 68 65 20 22 73 72 63 2f 22 20 66 6f 6c 64   the "src/" fold
24c0: 65 72 20 6f 66 20 74 68 65 20 73 6f 75 72 63 65  er of the source
24d0: 20 74 72 65 65 20 77 68 6f 73 65 20 6e 61 6d 65   tree whose name
24e0: 73 20 62 65 67 69 6e 20 77 69 74 68 0a 3c 62 3e  s begin with.<b>
24f0: 74 65 73 74 3c 2f 62 3e 20 61 72 65 20 66 6f 72  test</b> are for
2500: 20 74 65 73 74 69 6e 67 20 6f 6e 6c 79 20 61 6e   testing only an
2510: 64 20 61 72 65 20 6e 6f 74 20 69 6e 63 6c 75 64  d are not includ
2520: 65 64 20 69 6e 20 61 20 73 74 61 6e 64 61 72 64  ed in a standard
2530: 0a 62 75 69 6c 64 20 6f 66 20 74 68 65 20 6c 69  .build of the li
2540: 62 72 61 72 79 2e 0a 3c 2f 70 3e 0a 7d 0a 3c 2f  brary..</p>.}.</
2550: 74 63 6c 3e 0a                                   tcl>.