Documentation Source Text

Hex Artifact Content
Login

Artifact 3b05ee703b9514ee7c2e1761fe6d3468957dd073a0fa8df1c178bb7fc9559451:


0000: 3c 74 69 74 6c 65 3e 54 68 65 20 54 63 6c 20 69  <title>The Tcl i
0010: 6e 74 65 72 66 61 63 65 20 74 6f 20 74 68 65 20  nterface to the 
0020: 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79 3c 2f  SQLite library</
0030: 74 69 74 6c 65 3e 0a 3c 74 63 6c 3e 0a 68 64 5f  title>.<tcl>.hd_
0040: 6b 65 79 77 6f 72 64 73 20 7b 54 63 6c 20 65 78  keywords {Tcl ex
0050: 74 65 6e 73 69 6f 6e 7d 20 7b 54 43 4c 20 49 6e  tension} {TCL In
0060: 74 65 72 66 61 63 65 7d 0a 70 72 6f 63 20 4d 45  terface}.proc ME
0070: 54 48 4f 44 20 7b 6e 61 6d 65 20 74 65 78 74 7d  THOD {name text}
0080: 20 7b 0a 20 20 68 64 5f 66 72 61 67 6d 65 6e 74   {.  hd_fragment
0090: 20 24 6e 61 6d 65 20 5b 6c 69 73 74 20 24 6e 61   $name [list $na
00a0: 6d 65 20 6d 65 74 68 6f 64 5d 20 5b 6c 69 73 74  me method] [list
00b0: 20 54 43 4c 20 69 6e 74 65 72 66 61 63 65 20 24   TCL interface $
00c0: 6e 61 6d 65 20 6d 65 74 68 6f 64 5d 0a 20 20 68  name method].  h
00d0: 64 5f 70 75 74 73 20 22 3c 68 33 3e 54 68 65 20  d_puts "<h3>The 
00e0: 5c 22 24 6e 61 6d 65 5c 22 20 6d 65 74 68 6f 64  \"$name\" method
00f0: 3c 2f 68 33 3e 5c 6e 22 0a 20 20 68 64 5f 72 65  </h3>\n".  hd_re
0100: 73 6f 6c 76 65 20 24 74 65 78 74 0a 7d 0a 3c 2f  solve $text.}.</
0110: 74 63 6c 3e 0a 0a 3c 68 31 20 61 6c 69 67 6e 3d  tcl>..<h1 align=
0120: 63 65 6e 74 65 72 3e 54 68 65 20 54 63 6c 20 69  center>The Tcl i
0130: 6e 74 65 72 66 61 63 65 20 74 6f 20 74 68 65 20  nterface to the 
0140: 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79 3c 2f  SQLite library</
0150: 68 31 3e 0a 0a 3c 70 3e 54 68 65 20 53 51 4c 69  h1>..<p>The SQLi
0160: 74 65 20 6c 69 62 72 61 72 79 20 69 73 20 64 65  te library is de
0170: 73 69 67 6e 65 64 20 74 6f 20 62 65 20 76 65 72  signed to be ver
0180: 79 20 65 61 73 79 20 74 6f 20 75 73 65 20 66 72  y easy to use fr
0190: 6f 6d 0a 61 20 5b 68 74 74 70 3a 2f 2f 77 77 77  om.a [http://www
01a0: 2e 74 63 6c 2d 6c 61 6e 67 2e 6f 72 67 20 7c 20  .tcl-lang.org | 
01b0: 54 63 6c 20 6f 72 20 54 63 6c 2f 54 6b 5d 20 73  Tcl or Tcl/Tk] s
01c0: 63 72 69 70 74 2e 20 20 53 51 4c 69 74 65 0a 62  cript.  SQLite.b
01d0: 65 67 61 6e 20 61 73 20 61 20 5b 68 74 74 70 3a  egan as a [http:
01e0: 2f 2f 77 77 77 2e 74 63 6c 2d 6c 61 6e 67 2e 6f  //www.tcl-lang.o
01f0: 72 67 2f 64 6f 63 2f 74 65 61 2f 20 7c 20 54 63  rg/doc/tea/ | Tc
0200: 6c 20 65 78 74 65 6e 73 69 6f 6e 5d 0a 61 6e 64  l extension].and
0210: 20 74 68 65 20 70 72 69 6d 61 72 79 20 5b 74 65   the primary [te
0220: 73 74 20 73 75 69 74 65 5d 20 66 6f 72 20 53 51  st suite] for SQ
0230: 4c 69 74 65 20 69 73 20 77 72 69 74 74 65 6e 20  Lite is written 
0240: 69 6e 20 54 43 4c 2e 20 20 53 51 4c 69 74 65 0a  in TCL.  SQLite.
0250: 63 61 6e 20 62 65 20 75 73 65 64 20 77 69 74 68  can be used with
0260: 20 61 6e 79 20 70 72 6f 67 72 61 6d 6d 69 6e 67   any programming
0270: 20 6c 61 6e 67 75 61 67 65 2c 20 62 75 74 20 69   language, but i
0280: 74 73 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 20 74  ts connections t
0290: 6f 0a 54 43 4c 20 72 75 6e 20 64 65 65 70 2e 3c  o.TCL run deep.<
02a0: 2f 70 3e 0a 0a 3c 70 3e 54 68 69 73 20 64 6f 63  /p>..<p>This doc
02b0: 75 6d 65 6e 74 20 67 69 76 65 73 20 61 6e 20 6f  ument gives an o
02c0: 76 65 72 76 69 65 77 20 6f 66 20 74 68 65 20 54  verview of the T
02d0: 63 6c 0a 70 72 6f 67 72 61 6d 6d 69 6e 67 20 69  cl.programming i
02e0: 6e 74 65 72 66 61 63 65 20 66 6f 72 20 53 51 4c  nterface for SQL
02f0: 69 74 65 2e 3c 2f 70 3e 0a 0a 3c 68 33 3e 54 68  ite.</p>..<h3>Th
0300: 65 20 41 50 49 3c 2f 68 33 3e 0a 0a 3c 70 3e 54  e API</h3>..<p>T
0310: 68 65 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20  he interface to 
0320: 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62 72 61  the SQLite libra
0330: 72 79 20 63 6f 6e 73 69 73 74 73 20 6f 66 20 73  ry consists of s
0340: 69 6e 67 6c 65 0a 74 63 6c 20 63 6f 6d 6d 61 6e  ingle.tcl comman
0350: 64 20 6e 61 6d 65 64 20 3c 62 3e 73 71 6c 69 74  d named <b>sqlit
0360: 65 33 3c 2f 62 3e 0a 42 65 63 61 75 73 65 20 74  e3</b>.Because t
0370: 68 65 72 65 20 69 73 20 6f 6e 6c 79 20 74 68 69  here is only thi
0380: 73 0a 6f 6e 65 20 63 6f 6d 6d 61 6e 64 2c 20 74  s.one command, t
0390: 68 65 20 69 6e 74 65 72 66 61 63 65 20 69 73 20  he interface is 
03a0: 6e 6f 74 20 70 6c 61 63 65 64 20 69 6e 20 61 20  not placed in a 
03b0: 73 65 70 61 72 61 74 65 0a 6e 61 6d 65 73 70 61  separate.namespa
03c0: 63 65 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20  ce.</p>..<p>The 
03d0: 3c 62 3e 73 71 6c 69 74 65 33 3c 2f 62 3e 20 63  <b>sqlite3</b> c
03e0: 6f 6d 6d 61 6e 64 20 69 73 20 75 73 65 64 20 61  ommand is used a
03f0: 73 20 66 6f 6c 6c 6f 77 73 3a 3c 2f 70 3e 0a 0a  s follows:</p>..
0400: 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c 62 3e  <blockquote>.<b>
0410: 73 71 6c 69 74 65 33 3c 2f 62 3e 26 6e 62 73 70  sqlite3</b>&nbsp
0420: 3b 26 6e 62 73 70 3b 3c 69 3e 64 62 63 6d 64 26  ;&nbsp;<i>dbcmd&
0430: 6e 62 73 70 3b 26 6e 62 73 70 3b 64 61 74 61 62  nbsp;&nbsp;datab
0440: 61 73 65 2d 6e 61 6d 65 26 6e 62 73 70 3b 26 6e  ase-name&nbsp;&n
0450: 62 73 70 3b 3f 6f 70 74 69 6f 6e 73 3f 3c 2f 69  bsp;?options?</i
0460: 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  >.</blockquote>.
0470: 0a 3c 70 3e 0a 54 68 65 20 3c 62 3e 73 71 6c 69  .<p>.The <b>sqli
0480: 74 65 33 3c 2f 62 3e 20 63 6f 6d 6d 61 6e 64 20  te3</b> command 
0490: 6f 70 65 6e 73 20 74 68 65 20 64 61 74 61 62 61  opens the databa
04a0: 73 65 20 6e 61 6d 65 64 20 69 6e 20 74 68 65 20  se named in the 
04b0: 73 65 63 6f 6e 64 0a 61 72 67 75 6d 65 6e 74 2e  second.argument.
04c0: 20 20 49 66 20 74 68 65 20 64 61 74 61 62 61 73    If the databas
04d0: 65 20 64 6f 65 73 20 6e 6f 74 20 61 6c 72 65 61  e does not alrea
04e0: 64 79 20 65 78 69 73 74 2c 20 74 68 65 20 64 65  dy exist, the de
04f0: 66 61 75 6c 74 20 62 65 68 61 76 69 6f 72 0a 69  fault behavior.i
0500: 73 20 66 6f 72 20 69 74 20 74 6f 20 62 65 20 63  s for it to be c
0510: 72 65 61 74 65 64 20 61 75 74 6f 6d 61 74 69 63  reated automatic
0520: 61 6c 6c 79 20 28 74 68 6f 75 67 68 20 74 68 69  ally (though thi
0530: 73 20 63 61 6e 20 62 65 20 63 68 61 6e 67 65 64  s can be changed
0540: 20 62 79 0a 75 73 69 6e 67 20 74 68 65 20 22 3c   by.using the "<
0550: 62 3e 2d 63 72 65 61 74 65 20 66 61 6c 73 65 3c  b>-create false<
0560: 2f 62 3e 22 20 6f 70 74 69 6f 6e 29 2e 0a 54 68  /b>" option)..Th
0570: 65 20 3c 62 3e 73 71 6c 69 74 65 33 3c 2f 62 3e  e <b>sqlite3</b>
0580: 20 63 6f 6d 6d 61 6e 64 20 61 6c 77 61 79 73 20   command always 
0590: 63 72 65 61 74 65 73 20 61 20 6e 65 77 20 54 63  creates a new Tc
05a0: 6c 0a 63 6f 6d 6d 61 6e 64 20 74 6f 20 63 6f 6e  l.command to con
05b0: 74 72 6f 6c 20 74 68 65 20 64 61 74 61 62 61 73  trol the databas
05c0: 65 2e 20 20 54 68 65 20 6e 61 6d 65 20 6f 66 20  e.  The name of 
05d0: 74 68 65 20 6e 65 77 20 54 63 6c 20 63 6f 6d 6d  the new Tcl comm
05e0: 61 6e 64 0a 69 73 20 67 69 76 65 6e 20 62 79 20  and.is given by 
05f0: 74 68 65 20 66 69 72 73 74 20 61 72 67 75 6d 65  the first argume
0600: 6e 74 2e 20 20 54 68 69 73 20 61 70 70 72 6f 61  nt.  This approa
0610: 63 68 20 69 73 20 73 69 6d 69 6c 61 72 20 74 6f  ch is similar to
0620: 20 74 68 65 0a 77 61 79 20 77 69 64 67 65 74 73   the.way widgets
0630: 20 61 72 65 20 63 72 65 61 74 65 64 20 69 6e 20   are created in 
0640: 54 6b 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 54 68  Tk..</p>..<p>.Th
0650: 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 64 61  e name of the da
0660: 74 61 62 61 73 65 20 69 73 20 75 73 75 61 6c 6c  tabase is usuall
0670: 79 20 6a 75 73 74 20 74 68 65 20 6e 61 6d 65 20  y just the name 
0680: 6f 66 20 61 20 64 69 73 6b 20 66 69 6c 65 20 69  of a disk file i
0690: 6e 20 77 68 69 63 68 0a 74 68 65 20 64 61 74 61  n which.the data
06a0: 62 61 73 65 20 69 73 20 73 74 6f 72 65 64 2e 20  base is stored. 
06b0: 20 49 66 20 74 68 65 20 6e 61 6d 65 20 6f 66 20   If the name of 
06c0: 74 68 65 20 64 61 74 61 62 61 73 65 20 69 73 20  the database is 
06d0: 0a 74 68 65 20 73 70 65 63 69 61 6c 20 6e 61 6d  .the special nam
06e0: 65 20 22 5b 3a 6d 65 6d 6f 72 79 3a 5d 22 20 74  e "[:memory:]" t
06f0: 68 65 6e 20 61 20 6e 65 77 20 64 61 74 61 62 61  hen a new databa
0700: 73 65 20 69 73 20 63 72 65 61 74 65 64 0a 69 6e  se is created.in
0710: 20 6d 65 6d 6f 72 79 2e 20 20 49 66 20 74 68 65   memory.  If the
0720: 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 64 61 74   name of the dat
0730: 61 62 61 73 65 20 69 73 20 61 6e 20 65 6d 70 74  abase is an empt
0740: 79 20 73 74 72 69 6e 67 2c 20 74 68 65 6e 0a 74  y string, then.t
0750: 68 65 20 64 61 74 61 62 61 73 65 20 69 73 20 63  he database is c
0760: 72 65 61 74 65 64 20 69 6e 20 61 6e 20 65 6d 70  reated in an emp
0770: 74 79 20 66 69 6c 65 20 74 68 61 74 20 69 73 20  ty file that is 
0780: 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 64 65  automatically de
0790: 6c 65 74 65 64 0a 77 68 65 6e 20 74 68 65 20 64  leted.when the d
07a0: 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
07b0: 6f 6e 20 63 6c 6f 73 65 73 2e 20 20 5b 55 52 49  on closes.  [URI
07c0: 20 66 69 6c 65 6e 61 6d 65 73 5d 20 63 61 6e 20   filenames] can 
07d0: 62 65 20 75 73 65 64 20 69 66 0a 74 68 65 20 22  be used if.the "
07e0: 3c 62 3e 2d 75 72 69 20 79 65 73 3c 2f 62 3e 22  <b>-uri yes</b>"
07f0: 20 6f 70 74 69 6f 6e 20 69 73 20 73 75 70 70 6c   option is suppl
0800: 69 65 64 20 6f 6e 20 74 68 65 20 3c 62 3e 73 71  ied on the <b>sq
0810: 6c 69 74 65 33 3c 2f 62 3e 20 63 6f 6d 6d 61 6e  lite3</b> comman
0820: 64 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 4f 70 74  d..</p>..<p>.Opt
0830: 69 6f 6e 73 20 75 6e 64 65 72 73 74 6f 6f 64 20  ions understood 
0840: 62 79 20 74 68 65 20 3c 62 3e 73 71 6c 69 74 65  by the <b>sqlite
0850: 33 3c 2f 62 3e 20 63 6f 6d 6d 61 6e 64 20 69 6e  3</b> command in
0860: 63 6c 75 64 65 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c  clude:.</p>..<bl
0870: 6f 63 6b 71 75 6f 74 65 3e 0a 3c 64 6c 3e 0a 0a  ockquote>.<dl>..
0880: 3c 64 74 3e 3c 62 3e 2d 63 72 65 61 74 65 3c 2f  <dt><b>-create</
0890: 62 3e 20 3c 69 3e 42 4f 4f 4c 45 41 4e 3c 2f 69  b> <i>BOOLEAN</i
08a0: 3e 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 0a 49  ></dt>.<dd><p>.I
08b0: 66 20 74 72 75 65 2c 20 74 68 65 6e 20 61 20 6e  f true, then a n
08c0: 65 77 20 64 61 74 61 62 61 73 65 20 69 73 20 63  ew database is c
08d0: 72 65 61 74 65 64 20 69 66 20 6f 6e 65 20 64 6f  reated if one do
08e0: 65 73 20 6e 6f 74 20 61 6c 72 65 61 64 79 20 65  es not already e
08f0: 78 69 73 74 2e 0a 49 66 20 66 61 6c 73 65 2c 20  xist..If false, 
0900: 74 68 65 6e 20 61 6e 20 61 74 74 65 6d 70 74 20  then an attempt 
0910: 74 6f 20 6f 70 65 6e 20 61 20 64 61 74 61 62 61  to open a databa
0920: 73 65 20 66 69 6c 65 20 74 68 61 74 20 64 6f 65  se file that doe
0930: 73 20 6e 6f 74 20 70 72 65 76 69 6f 75 73 6c 79  s not previously
0940: 0a 65 78 69 73 74 20 72 61 69 73 65 73 20 61 6e  .exist raises an
0950: 20 65 72 72 6f 72 2e 20 20 54 68 65 20 64 65 66   error.  The def
0960: 61 75 6c 74 20 62 65 68 61 76 69 6f 72 20 69 73  ault behavior is
0970: 20 22 74 72 75 65 22 2e 0a 3c 2f 70 3e 3c 2f 64   "true"..</p></d
0980: 64 3e 0a 0a 3c 64 74 3e 3c 62 3e 2d 6e 6f 6d 75  d>..<dt><b>-nomu
0990: 74 65 78 3c 2f 62 3e 20 3c 69 3e 42 4f 4f 4c 45  tex</b> <i>BOOLE
09a0: 41 4e 3c 2f 69 3e 3c 2f 64 74 3e 0a 3c 64 64 3e  AN</i></dt>.<dd>
09b0: 3c 70 3e 0a 49 66 20 74 72 75 65 2c 20 74 68 65  <p>.If true, the
09c0: 6e 20 61 6c 6c 20 6d 75 74 65 78 65 73 20 66 6f  n all mutexes fo
09d0: 72 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63  r the database c
09e0: 6f 6e 6e 65 63 74 69 6f 6e 20 61 72 65 20 64 69  onnection are di
09f0: 73 61 62 6c 65 64 2e 0a 54 68 69 73 20 70 72 6f  sabled..This pro
0a00: 76 69 64 65 73 20 61 20 73 6d 61 6c 6c 20 70 65  vides a small pe
0a10: 72 66 6f 72 6d 61 6e 63 65 20 62 6f 6f 73 74 20  rformance boost 
0a20: 69 6e 20 73 69 6e 67 6c 65 2d 74 68 72 65 61 64  in single-thread
0a30: 65 64 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 2e  ed applications.
0a40: 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 0a 3c 64 74 3e  .</p></dd>..<dt>
0a50: 3c 62 3e 2d 72 65 61 64 6f 6e 6c 79 3c 2f 62 3e  <b>-readonly</b>
0a60: 20 3c 69 3e 42 4f 4f 4c 45 41 4e 3c 2f 69 3e 3c   <i>BOOLEAN</i><
0a70: 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 0a 49 66 20  /dt>.<dd><p>.If 
0a80: 74 72 75 65 2c 20 74 68 65 6e 20 6f 70 65 6e 20  true, then open 
0a90: 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69 6c  the database fil
0aa0: 65 20 72 65 61 64 2d 6f 6e 6c 79 2e 20 20 49 66  e read-only.  If
0ab0: 20 66 61 6c 73 65 2c 20 74 68 65 6e 20 74 68 65   false, then the
0ac0: 0a 64 61 74 61 62 61 73 65 20 69 73 20 6f 70 65  .database is ope
0ad0: 6e 65 64 20 66 6f 72 20 62 6f 74 68 20 72 65 61  ned for both rea
0ae0: 64 69 6e 67 20 61 6e 64 20 77 72 69 74 69 6e 67  ding and writing
0af0: 20 69 66 20 66 69 6c 65 73 79 73 74 65 6d 20 70   if filesystem p
0b00: 65 72 6d 69 73 73 69 6f 6e 73 0a 61 6c 6c 6f 77  ermissions.allow
0b10: 2c 20 6f 72 20 66 6f 72 20 72 65 61 64 69 6e 67  , or for reading
0b20: 20 6f 6e 6c 79 20 69 66 20 66 69 6c 65 73 79 73   only if filesys
0b30: 74 65 6d 20 77 72 69 74 65 20 70 65 72 6d 69 73  tem write permis
0b40: 73 69 6f 6e 20 69 73 20 64 65 6e 69 65 64 0a 62  sion is denied.b
0b50: 79 20 74 68 65 20 6f 70 65 72 61 74 69 6e 67 20  y the operating 
0b60: 73 79 73 74 65 6d 2e 20 20 54 68 65 20 64 65 66  system.  The def
0b70: 61 75 6c 74 20 73 65 74 74 69 6e 67 20 69 73 20  ault setting is 
0b80: 22 66 61 6c 73 65 22 2e 20 20 4e 6f 74 65 20 74  "false".  Note t
0b90: 68 61 74 0a 69 66 20 74 68 65 20 70 72 65 76 69  hat.if the previ
0ba0: 6f 75 73 20 70 72 6f 63 65 73 73 20 74 6f 20 68  ous process to h
0bb0: 61 76 65 20 74 68 65 20 64 61 74 61 62 61 73 65  ave the database
0bc0: 20 64 69 64 20 6e 6f 74 20 65 78 69 74 20 63 6c   did not exit cl
0bd0: 65 61 6e 6c 79 0a 61 6e 64 20 6c 65 66 74 20 62  eanly.and left b
0be0: 65 68 69 6e 64 20 61 20 5b 68 6f 74 20 6a 6f 75  ehind a [hot jou
0bf0: 72 6e 61 6c 5d 2c 20 74 68 65 6e 20 74 68 65 20  rnal], then the 
0c00: 77 72 69 74 65 20 70 65 72 6d 69 73 73 69 6f 6e  write permission
0c10: 20 69 73 20 72 65 71 75 69 72 65 64 0a 74 6f 20   is required.to 
0c20: 72 65 63 6f 76 65 72 20 74 68 65 20 64 61 74 61  recover the data
0c30: 62 61 73 65 20 61 66 74 65 72 20 6f 70 65 6e 69  base after openi
0c40: 6e 67 2c 20 61 6e 64 20 74 68 65 20 64 61 74 61  ng, and the data
0c50: 62 61 73 65 20 63 61 6e 6e 6f 74 20 62 65 0a 6f  base cannot be.o
0c60: 70 65 6e 65 64 20 72 65 61 64 2d 6f 6e 6c 79 2e  pened read-only.
0c70: 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 0a 3c 64 74 3e  .</p></dd>..<dt>
0c80: 3c 62 3e 2d 75 72 69 3c 2f 62 3e 20 3c 69 3e 42  <b>-uri</b> <i>B
0c90: 4f 4f 4c 45 41 4e 3c 2f 69 3e 3c 2f 64 74 3e 0a  OOLEAN</i></dt>.
0ca0: 3c 64 64 3e 3c 70 3e 0a 49 66 20 74 72 75 65 2c  <dd><p>.If true,
0cb0: 20 74 68 65 6e 20 69 6e 74 65 72 70 72 65 74 20   then interpret 
0cc0: 74 68 65 20 66 69 6c 65 6e 61 6d 65 20 61 72 67  the filename arg
0cd0: 75 6d 65 6e 74 20 61 73 20 61 20 5b 55 52 49 20  ument as a [URI 
0ce0: 66 69 6c 65 6e 61 6d 65 5d 2e 20 20 49 66 0a 66  filename].  If.f
0cf0: 61 6c 73 65 2c 20 74 68 65 6e 20 74 68 65 20 61  alse, then the a
0d00: 72 67 75 6d 65 6e 74 20 69 73 20 61 20 6c 69 74  rgument is a lit
0d10: 65 72 61 6c 20 66 69 6c 65 6e 61 6d 65 2e 20 20  eral filename.  
0d20: 54 68 65 20 64 65 66 61 75 6c 74 20 76 61 6c 75  The default valu
0d30: 65 20 69 73 0a 22 66 61 6c 73 65 22 2e 0a 3c 2f  e is."false"..</
0d40: 70 3e 3c 2f 64 64 3e 0a 0a 3c 64 74 3e 3c 62 3e  p></dd>..<dt><b>
0d50: 2d 76 66 73 3c 2f 62 3e 20 3c 69 3e 56 46 53 4e  -vfs</b> <i>VFSN
0d60: 41 4d 45 3c 2f 69 3e 3c 2f 64 74 3e 0a 3c 64 64  AME</i></dt>.<dd
0d70: 3e 3c 70 3e 0a 55 73 65 20 61 6e 20 61 6c 74 65  ><p>.Use an alte
0d80: 72 6e 61 74 69 76 65 20 5b 56 46 53 5d 20 6e 61  rnative [VFS] na
0d90: 6d 65 64 20 62 79 20 74 68 65 20 61 72 67 75 6d  med by the argum
0da0: 65 6e 74 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 0a  ent..</p></dd>..
0db0: 3c 2f 64 6c 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f  </dl>.</blockquo
0dc0: 74 65 3e 0a 0a 3c 74 63 6c 3e 0a 73 65 74 20 6d  te>..<tcl>.set m
0dd0: 65 74 68 6f 64 5f 6c 69 73 74 20 5b 6c 73 6f 72  ethod_list [lsor
0de0: 74 20 7b 0a 20 61 75 74 68 6f 72 69 7a 65 72 0a  t {. authorizer.
0df0: 20 62 61 63 6b 75 70 0a 20 62 75 73 79 0a 20 63   backup. busy. c
0e00: 61 63 68 65 0a 20 63 68 61 6e 67 65 73 0a 20 63  ache. changes. c
0e10: 6c 6f 73 65 0a 20 63 6f 6c 6c 61 74 65 0a 20 63  lose. collate. c
0e20: 6f 6c 6c 61 74 69 6f 6e 5f 6e 65 65 64 65 64 0a  ollation_needed.
0e30: 20 63 6f 6d 6d 69 74 5f 68 6f 6f 6b 0a 20 63 6f   commit_hook. co
0e40: 6d 70 6c 65 74 65 0a 20 63 6f 70 79 0a 20 64 65  mplete. copy. de
0e50: 73 65 72 69 61 6c 69 7a 65 0a 20 65 6e 61 62 6c  serialize. enabl
0e60: 65 5f 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f 6e  e_load_extension
0e70: 0a 20 65 72 72 6f 72 63 6f 64 65 0a 20 65 76 61  . errorcode. eva
0e80: 6c 0a 20 65 78 69 73 74 73 0a 20 66 75 6e 63 74  l. exists. funct
0e90: 69 6f 6e 0a 20 69 6e 63 72 62 6c 6f 62 0a 20 69  ion. incrblob. i
0ea0: 6e 74 65 72 72 75 70 74 0a 20 6c 61 73 74 5f 69  nterrupt. last_i
0eb0: 6e 73 65 72 74 5f 72 6f 77 69 64 0a 20 6e 75 6c  nsert_rowid. nul
0ec0: 6c 76 61 6c 75 65 0a 20 6f 6e 65 63 6f 6c 75 6d  lvalue. onecolum
0ed0: 6e 0a 20 70 72 65 75 70 64 61 74 65 0a 20 70 72  n. preupdate. pr
0ee0: 6f 66 69 6c 65 0a 20 70 72 6f 67 72 65 73 73 0a  ofile. progress.
0ef0: 20 72 65 73 74 6f 72 65 0a 20 72 6f 6c 6c 62 61   restore. rollba
0f00: 63 6b 5f 68 6f 6f 6b 0a 20 73 65 72 69 61 6c 69  ck_hook. seriali
0f10: 7a 65 0a 20 73 74 61 74 75 73 0a 20 74 69 6d 65  ze. status. time
0f20: 6f 75 74 0a 20 74 6f 74 61 6c 5f 63 68 61 6e 67  out. total_chang
0f30: 65 73 0a 20 74 72 61 63 65 0a 20 74 72 61 63 65  es. trace. trace
0f40: 5f 76 32 0a 20 74 72 61 6e 73 61 63 74 69 6f 6e  _v2. transaction
0f50: 0a 20 75 6e 6c 6f 63 6b 5f 6e 6f 74 69 66 79 0a  . unlock_notify.
0f60: 20 75 70 64 61 74 65 5f 68 6f 6f 6b 0a 20 76 65   update_hook. ve
0f70: 72 73 69 6f 6e 0a 20 77 61 6c 5f 68 6f 6f 6b 0a  rsion. wal_hook.
0f80: 7d 5d 0a 3c 2f 74 63 6c 3e 0a 0a 3c 70 3e 0a 4f  }].</tcl>..<p>.O
0f90: 6e 63 65 20 61 6e 20 53 51 4c 69 74 65 20 64 61  nce an SQLite da
0fa0: 74 61 62 61 73 65 20 69 73 20 6f 70 65 6e 2c 20  tabase is open, 
0fb0: 69 74 20 63 61 6e 20 62 65 20 63 6f 6e 74 72 6f  it can be contro
0fc0: 6c 6c 65 64 20 75 73 69 6e 67 20 0a 6d 65 74 68  lled using .meth
0fd0: 6f 64 73 20 6f 66 20 74 68 65 20 3c 69 3e 64 62  ods of the <i>db
0fe0: 63 6d 64 3c 2f 69 3e 2e 0a 3c 74 63 6c 3e 0a 68  cmd</i>..<tcl>.h
0ff0: 64 5f 70 75 74 73 20 22 54 68 65 72 65 20 61 72  d_puts "There ar
1000: 65 20 63 75 72 72 65 6e 74 6c 79 20 5b 6c 6c 65  e currently [lle
1010: 6e 67 74 68 20 24 6d 65 74 68 6f 64 5f 6c 69 73  ngth $method_lis
1020: 74 5d 20 6d 65 74 68 6f 64 73 5c 6e 22 0a 68 64  t] methods\n".hd
1030: 5f 70 75 74 73 20 22 64 65 66 69 6e 65 64 2e 3c  _puts "defined.<
1040: 2f 70 3e 5c 6e 22 0a 3c 2f 74 63 6c 3e 0a 0a 3c  /p>\n".</tcl>..<
1050: 74 61 62 6c 65 20 62 6f 72 64 65 72 3d 30 20 63  table border=0 c
1060: 65 6c 6c 70 61 64 64 69 6e 67 3d 31 30 20 77 69  ellpadding=10 wi
1070: 64 74 68 3d 27 31 30 30 25 27 3e 0a 3c 74 72 3e  dth='100%'>.<tr>
1080: 3c 74 64 20 76 61 6c 69 67 6e 3d 27 74 6f 70 27  <td valign='top'
1090: 3e 3c 75 6c 3e 0a 3c 74 63 6c 3e 0a 73 65 74 20  ><ul>.<tcl>.set 
10a0: 6e 62 72 20 5b 65 78 70 72 20 7b 69 6e 74 28 28  nbr [expr {int((
10b0: 5b 6c 6c 65 6e 67 74 68 20 24 6d 65 74 68 6f 64  [llength $method
10c0: 5f 6c 69 73 74 5d 2b 32 29 2f 33 29 7d 5d 0a 73  _list]+2)/3)}].s
10d0: 65 74 20 69 20 2d 31 0a 66 6f 72 65 61 63 68 20  et i -1.foreach 
10e0: 6d 20 24 6d 65 74 68 6f 64 5f 6c 69 73 74 20 7b  m $method_list {
10f0: 0a 20 20 69 6e 63 72 20 69 0a 20 20 69 66 20 7b  .  incr i.  if {
1100: 24 69 3d 3d 24 6e 62 72 7d 20 7b 0a 20 20 20 20  $i==$nbr} {.    
1110: 68 64 5f 70 75 74 73 20 22 3c 2f 75 6c 3e 3c 2f  hd_puts "</ul></
1120: 74 64 3e 5c 6e 3c 74 64 20 76 61 6c 69 67 6e 3d  td>\n<td valign=
1130: 27 74 6f 70 27 3e 3c 75 6c 3e 5c 6e 22 0a 20 20  'top'><ul>\n".  
1140: 20 20 73 65 74 20 69 20 30 0a 20 20 7d 0a 20 20    set i 0.  }.  
1150: 68 64 5f 70 75 74 73 20 22 3c 6c 69 3e 3c 61 20  hd_puts "<li><a 
1160: 68 72 65 66 3d 5c 22 23 24 6d 5c 22 3e 24 6d 3c  href=\"#$m\">$m<
1170: 2f 61 3e 3c 2f 6c 69 3e 5c 6e 22 0a 7d 0a 3c 2f  /a></li>\n".}.</
1180: 74 63 6c 3e 0a 3c 2f 75 6c 3e 3c 2f 74 64 3e 3c  tcl>.</ul></td><
1190: 2f 74 72 3e 0a 3c 2f 74 61 62 6c 65 3e 0a 0a 0a  /tr>.</table>...
11a0: 3c 70 3e 54 68 65 20 75 73 65 20 6f 66 20 65 61  <p>The use of ea
11b0: 63 68 20 6f 66 20 74 68 65 73 65 20 6d 65 74 68  ch of these meth
11c0: 6f 64 73 20 77 69 6c 6c 20 62 65 20 65 78 70 6c  ods will be expl
11d0: 61 69 6e 65 64 20 69 6e 20 74 68 65 20 73 65 71  ained in the seq
11e0: 75 65 6c 2c 20 74 68 6f 75 67 68 0a 6e 6f 74 20  uel, though.not 
11f0: 69 6e 20 74 68 65 20 6f 72 64 65 72 20 73 68 6f  in the order sho
1200: 77 6e 20 61 62 6f 76 65 2e 3c 2f 70 3e 0a 0a 3c  wn above.</p>..<
1210: 74 63 6c 3e 0a 23 23 23 23 23 23 23 23 23 23 23  tcl>.###########
1220: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
1230: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
1240: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
1250: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
1260: 23 23 23 0a 4d 45 54 48 4f 44 20 65 76 61 6c 20  ###.METHOD eval 
1270: 7b 0a 3c 70 3e 0a 54 68 65 20 6d 6f 73 74 20 75  {.<p>.The most u
1280: 73 65 66 75 6c 20 3c 69 3e 64 62 63 6d 64 3c 2f  seful <i>dbcmd</
1290: 69 3e 20 6d 65 74 68 6f 64 20 69 73 20 22 65 76  i> method is "ev
12a0: 61 6c 22 2e 20 20 54 68 65 20 65 76 61 6c 20 6d  al".  The eval m
12b0: 65 74 68 6f 64 20 69 73 20 75 73 65 64 0a 74 6f  ethod is used.to
12c0: 20 65 78 65 63 75 74 65 20 53 51 4c 20 6f 6e 20   execute SQL on 
12d0: 74 68 65 20 64 61 74 61 62 61 73 65 2e 20 20 54  the database.  T
12e0: 68 65 20 73 79 6e 74 61 78 20 6f 66 20 74 68 65  he syntax of the
12f0: 20 65 76 61 6c 20 6d 65 74 68 6f 64 20 6c 6f 6f   eval method loo
1300: 6b 73 0a 6c 69 6b 65 20 74 68 69 73 3a 3c 2f 70  ks.like this:</p
1310: 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  >..<blockquote>.
1320: 3c 69 3e 64 62 63 6d 64 3c 2f 69 3e 26 6e 62 73  <i>dbcmd</i>&nbs
1330: 70 3b 26 6e 62 73 70 3b 3c 62 3e 65 76 61 6c 3c  p;&nbsp;<b>eval<
1340: 2f 62 3e 26 6e 62 73 70 3b 26 6e 62 73 70 3b 3f  /b>&nbsp;&nbsp;?
1350: 3c 69 3e 6f 70 74 69 6f 6e 73 3c 2f 69 3e 3f 26  <i>options</i>?&
1360: 6e 62 73 70 3b 26 6e 62 73 70 3b 3c 69 3e 73 71  nbsp;&nbsp;<i>sq
1370: 6c 3c 2f 69 3e 0a 26 6e 62 73 70 3b 26 6e 62 73  l</i>.&nbsp;&nbs
1380: 70 3b 3f 3c 69 3e 61 72 72 61 79 2d 6e 61 6d 65  p;?<i>array-name
1390: 3c 2f 69 3e 3f 26 6e 62 73 70 3b 26 6e 62 73 70  </i>?&nbsp;&nbsp
13a0: 3b 3f 3c 69 3e 73 63 72 69 70 74 3c 2f 69 3e 3f  ;?<i>script</i>?
13b0: 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a  .</blockquote>..
13c0: 3c 70 3e 0a 54 68 65 20 6a 6f 62 20 6f 66 20 74  <p>.The job of t
13d0: 68 65 20 65 76 61 6c 20 6d 65 74 68 6f 64 20 69  he eval method i
13e0: 73 20 74 6f 20 65 78 65 63 75 74 65 20 74 68 65  s to execute the
13f0: 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 6f   SQL statement o
1400: 72 20 73 74 61 74 65 6d 65 6e 74 73 0a 67 69 76  r statements.giv
1410: 65 6e 20 69 6e 20 74 68 65 20 73 65 63 6f 6e 64  en in the second
1420: 20 61 72 67 75 6d 65 6e 74 2e 20 20 46 6f 72 20   argument.  For 
1430: 65 78 61 6d 70 6c 65 2c 20 74 6f 20 63 72 65 61  example, to crea
1440: 74 65 20 61 20 6e 65 77 20 74 61 62 6c 65 20 69  te a new table i
1450: 6e 0a 61 20 64 61 74 61 62 61 73 65 2c 20 79 6f  n.a database, yo
1460: 75 20 63 61 6e 20 64 6f 20 74 68 69 73 3a 3c 2f  u can do this:</
1470: 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e  p>..<blockquote>
1480: 0a 3c 62 3e 73 71 6c 69 74 65 33 20 64 62 31 20  .<b>sqlite3 db1 
1490: 2e 2f 74 65 73 74 64 62 3c 62 72 3e 0a 64 62 31  ./testdb<br>.db1
14a0: 20 65 76 61 6c 20 7b 43 52 45 41 54 45 20 54 41   eval {CREATE TA
14b0: 42 4c 45 20 74 31 28 61 20 69 6e 74 2c 20 62 20  BLE t1(a int, b 
14c0: 74 65 78 74 29 7d 3c 2f 62 3e 0a 3c 2f 62 6c 6f  text)}</b>.</blo
14d0: 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 54 68 65  ckquote>..<p>The
14e0: 20 61 62 6f 76 65 20 63 6f 64 65 20 63 72 65 61   above code crea
14f0: 74 65 73 20 61 20 6e 65 77 20 74 61 62 6c 65 20  tes a new table 
1500: 6e 61 6d 65 64 20 3c 62 3e 74 31 3c 2f 62 3e 20  named <b>t1</b> 
1510: 77 69 74 68 20 63 6f 6c 75 6d 6e 73 0a 3c 62 3e  with columns.<b>
1520: 61 3c 2f 62 3e 20 61 6e 64 20 3c 62 3e 62 3c 2f  a</b> and <b>b</
1530: 62 3e 2e 20 20 57 68 61 74 20 63 6f 75 6c 64 20  b>.  What could 
1540: 62 65 20 73 69 6d 70 6c 65 72 3f 3c 2f 70 3e 0a  be simpler?</p>.
1550: 0a 3c 70 3e 51 75 65 72 79 20 72 65 73 75 6c 74  .<p>Query result
1560: 73 20 61 72 65 20 72 65 74 75 72 6e 65 64 20 61  s are returned a
1570: 73 20 61 20 6c 69 73 74 20 6f 66 20 63 6f 6c 75  s a list of colu
1580: 6d 6e 20 76 61 6c 75 65 73 2e 20 20 49 66 20 61  mn values.  If a
1590: 0a 71 75 65 72 79 20 72 65 71 75 65 73 74 73 20  .query requests 
15a0: 32 20 63 6f 6c 75 6d 6e 73 20 61 6e 64 20 74 68  2 columns and th
15b0: 65 72 65 20 61 72 65 20 33 20 72 6f 77 73 20 6d  ere are 3 rows m
15c0: 61 74 63 68 69 6e 67 20 74 68 65 20 71 75 65 72  atching the quer
15d0: 79 2c 0a 74 68 65 6e 20 74 68 65 20 72 65 74 75  y,.then the retu
15e0: 72 6e 65 64 20 6c 69 73 74 20 77 69 6c 6c 20 63  rned list will c
15f0: 6f 6e 74 61 69 6e 20 36 20 65 6c 65 6d 65 6e 74  ontain 6 element
1600: 73 2e 20 20 46 6f 72 20 65 78 61 6d 70 6c 65 3a  s.  For example:
1610: 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74  </p>..<blockquot
1620: 65 3e 0a 3c 62 3e 64 62 31 20 65 76 61 6c 20 7b  e>.<b>db1 eval {
1630: 49 4e 53 45 52 54 20 49 4e 54 4f 20 74 31 20 56  INSERT INTO t1 V
1640: 41 4c 55 45 53 28 31 2c 27 68 65 6c 6c 6f 27 29  ALUES(1,'hello')
1650: 7d 3c 62 72 3e 0a 64 62 31 20 65 76 61 6c 20 7b  }<br>.db1 eval {
1660: 49 4e 53 45 52 54 20 49 4e 54 4f 20 74 31 20 56  INSERT INTO t1 V
1670: 41 4c 55 45 53 28 32 2c 27 67 6f 6f 64 62 79 65  ALUES(2,'goodbye
1680: 27 29 7d 3c 62 72 3e 0a 64 62 31 20 65 76 61 6c  ')}<br>.db1 eval
1690: 20 7b 49 4e 53 45 52 54 20 49 4e 54 4f 20 74 31   {INSERT INTO t1
16a0: 20 56 41 4c 55 45 53 28 33 2c 27 68 6f 77 64 79   VALUES(3,'howdy
16b0: 21 27 29 7d 3c 62 72 3e 0a 73 65 74 20 78 20 26  !')}<br>.set x &
16c0: 23 39 31 3b 64 62 31 20 65 76 61 6c 20 7b 53 45  #91;db1 eval {SE
16d0: 4c 45 43 54 20 2a 20 46 52 4f 4d 20 74 31 20 4f  LECT * FROM t1 O
16e0: 52 44 45 52 20 42 59 20 61 7d 26 23 39 33 3b 3c  RDER BY a}&#93;<
16f0: 2f 62 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65  /b>.</blockquote
1700: 3e 0a 0a 3c 70 3e 54 68 65 20 76 61 72 69 61 62  >..<p>The variab
1710: 6c 65 20 3c 62 3e 24 78 3c 2f 62 3e 20 69 73 20  le <b>$x</b> is 
1720: 73 65 74 20 62 79 20 74 68 65 20 61 62 6f 76 65  set by the above
1730: 20 63 6f 64 65 20 74 6f 3c 2f 70 3e 0a 0a 3c 62   code to</p>..<b
1740: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c 62 3e 31 20  lockquote>.<b>1 
1750: 68 65 6c 6c 6f 20 32 20 67 6f 6f 64 62 79 65 20  hello 2 goodbye 
1760: 33 20 68 6f 77 64 79 21 3c 2f 62 3e 0a 3c 2f 62  3 howdy!</b>.</b
1770: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 59  lockquote>..<p>Y
1780: 6f 75 20 63 61 6e 20 61 6c 73 6f 20 70 72 6f 63  ou can also proc
1790: 65 73 73 20 74 68 65 20 72 65 73 75 6c 74 73 20  ess the results 
17a0: 6f 66 20 61 20 71 75 65 72 79 20 6f 6e 65 20 72  of a query one r
17b0: 6f 77 20 61 74 20 61 20 74 69 6d 65 0a 62 79 20  ow at a time.by 
17c0: 73 70 65 63 69 66 79 69 6e 67 20 74 68 65 20 6e  specifying the n
17d0: 61 6d 65 20 6f 66 20 61 6e 20 61 72 72 61 79 20  ame of an array 
17e0: 76 61 72 69 61 62 6c 65 20 61 6e 64 20 61 20 73  variable and a s
17f0: 63 72 69 70 74 20 66 6f 6c 6c 6f 77 69 6e 67 0a  cript following.
1800: 74 68 65 20 53 51 4c 20 63 6f 64 65 2e 20 20 46  the SQL code.  F
1810: 6f 72 20 65 61 63 68 20 72 6f 77 20 6f 66 20 74  or each row of t
1820: 68 65 20 71 75 65 72 79 20 72 65 73 75 6c 74 2c  he query result,
1830: 20 74 68 65 20 76 61 6c 75 65 73 20 6f 66 20 61   the values of a
1840: 6c 6c 0a 63 6f 6c 75 6d 6e 73 20 77 69 6c 6c 20  ll.columns will 
1850: 62 65 20 69 6e 73 65 72 74 65 64 20 69 6e 74 6f  be inserted into
1860: 20 74 68 65 20 61 72 72 61 79 20 76 61 72 69 61   the array varia
1870: 62 6c 65 20 61 6e 64 20 74 68 65 20 73 63 72 69  ble and the scri
1880: 70 74 20 77 69 6c 6c 0a 62 65 20 65 78 65 63 75  pt will.be execu
1890: 74 65 64 2e 20 20 46 6f 72 20 69 6e 73 74 61 6e  ted.  For instan
18a0: 63 65 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71  ce:</p>..<blockq
18b0: 75 6f 74 65 3e 0a 3c 62 3e 64 62 31 20 65 76 61  uote>.<b>db1 eva
18c0: 6c 20 7b 53 45 4c 45 43 54 20 2a 20 46 52 4f 4d  l {SELECT * FROM
18d0: 20 74 31 20 4f 52 44 45 52 20 42 59 20 61 7d 20   t1 ORDER BY a} 
18e0: 76 61 6c 75 65 73 20 7b 3c 62 72 3e 0a 26 6e 62  values {<br>.&nb
18f0: 73 70 3b 26 6e 62 73 70 3b 26 6e 62 73 70 3b 26  sp;&nbsp;&nbsp;&
1900: 6e 62 73 70 3b 70 61 72 72 61 79 20 76 61 6c 75  nbsp;parray valu
1910: 65 73 3c 62 72 3e 0a 26 6e 62 73 70 3b 26 6e 62  es<br>.&nbsp;&nb
1920: 73 70 3b 26 6e 62 73 70 3b 26 6e 62 73 70 3b 70  sp;&nbsp;&nbsp;p
1930: 75 74 73 20 22 22 3c 62 72 3e 0a 7d 3c 2f 62 3e  uts ""<br>.}</b>
1940: 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a  .</blockquote>..
1950: 3c 70 3e 54 68 69 73 20 6c 61 73 74 20 63 6f 64  <p>This last cod
1960: 65 20 77 69 6c 6c 20 67 69 76 65 20 74 68 65 20  e will give the 
1970: 66 6f 6c 6c 6f 77 69 6e 67 20 6f 75 74 70 75 74  following output
1980: 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f  :</p>..<blockquo
1990: 74 65 3e 3c 62 3e 0a 76 61 6c 75 65 73 28 2a 29  te><b>.values(*)
19a0: 20 3d 20 61 20 62 3c 62 72 3e 0a 76 61 6c 75 65   = a b<br>.value
19b0: 73 28 61 29 20 3d 20 31 3c 62 72 3e 0a 76 61 6c  s(a) = 1<br>.val
19c0: 75 65 73 28 62 29 20 3d 20 68 65 6c 6c 6f 3c 70  ues(b) = hello<p
19d0: 3e 0a 0a 76 61 6c 75 65 73 28 2a 29 20 3d 20 61  >..values(*) = a
19e0: 20 62 3c 62 72 3e 0a 76 61 6c 75 65 73 28 61 29   b<br>.values(a)
19f0: 20 3d 20 32 3c 62 72 3e 0a 76 61 6c 75 65 73 28   = 2<br>.values(
1a00: 62 29 20 3d 20 67 6f 6f 64 62 79 65 3c 70 3e 0a  b) = goodbye<p>.
1a10: 0a 76 61 6c 75 65 73 28 2a 29 20 3d 20 61 20 62  .values(*) = a b
1a20: 3c 62 72 3e 0a 76 61 6c 75 65 73 28 61 29 20 3d  <br>.values(a) =
1a30: 20 33 3c 62 72 3e 0a 76 61 6c 75 65 73 28 62 29   3<br>.values(b)
1a40: 20 3d 20 68 6f 77 64 79 21 3c 2f 62 3e 0a 3c 2f   = howdy!</b>.</
1a50: 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e  blockquote>..<p>
1a60: 0a 46 6f 72 20 65 61 63 68 20 63 6f 6c 75 6d 6e  .For each column
1a70: 20 69 6e 20 61 20 72 6f 77 20 6f 66 20 74 68 65   in a row of the
1a80: 20 72 65 73 75 6c 74 2c 20 74 68 65 20 6e 61 6d   result, the nam
1a90: 65 20 6f 66 20 74 68 61 74 20 63 6f 6c 75 6d 6e  e of that column
1aa0: 0a 69 73 20 75 73 65 64 20 61 73 20 61 6e 20 69  .is used as an i
1ab0: 6e 64 65 78 20 69 6e 20 74 6f 20 61 72 72 61 79  ndex in to array
1ac0: 20 61 6e 64 20 74 68 65 20 76 61 6c 75 65 20 6f   and the value o
1ad0: 66 20 74 68 65 20 63 6f 6c 75 6d 6e 20 69 73 20  f the column is 
1ae0: 73 74 6f 72 65 64 0a 69 6e 20 74 68 65 20 63 6f  stored.in the co
1af0: 72 72 65 73 70 6f 6e 64 69 6e 67 20 61 72 72 61  rresponding arra
1b00: 79 20 65 6e 74 72 79 2e 20 20 28 43 61 75 74 69  y entry.  (Cauti
1b10: 6f 6e 3a 20 20 49 66 20 74 77 6f 20 6f 72 20 6d  on:  If two or m
1b20: 6f 72 65 20 63 6f 6c 75 6d 6e 73 0a 69 6e 20 74  ore columns.in t
1b30: 68 65 20 72 65 73 75 6c 74 20 73 65 74 20 6f 66  he result set of
1b40: 20 61 20 71 75 65 72 79 20 68 61 76 65 20 74 68   a query have th
1b50: 65 20 73 61 6d 65 20 6e 61 6d 65 2c 20 74 68 65  e same name, the
1b60: 6e 20 74 68 65 20 6c 61 73 74 20 63 6f 6c 75 6d  n the last colum
1b70: 6e 0a 77 69 74 68 20 74 68 61 74 20 6e 61 6d 65  n.with that name
1b80: 20 77 69 6c 6c 20 6f 76 65 72 77 72 69 74 65 20   will overwrite 
1b90: 70 72 69 6f 72 20 76 61 6c 75 65 73 20 61 6e 64  prior values and
1ba0: 20 65 61 72 6c 69 65 72 20 63 6f 6c 75 6d 6e 73   earlier columns
1bb0: 20 77 69 74 68 20 74 68 65 0a 73 61 6d 65 20 6e   with the.same n
1bc0: 61 6d 65 20 77 69 6c 6c 20 62 65 20 69 6e 61 63  ame will be inac
1bd0: 63 65 73 73 69 62 6c 65 2e 29 20 54 68 65 20 73  cessible.) The s
1be0: 70 65 63 69 61 6c 20 61 72 72 61 79 20 69 6e 64  pecial array ind
1bf0: 65 78 20 2a 20 69 73 0a 75 73 65 64 20 74 6f 20  ex * is.used to 
1c00: 73 74 6f 72 65 20 61 20 6c 69 73 74 20 6f 66 20  store a list of 
1c10: 63 6f 6c 75 6d 6e 20 6e 61 6d 65 73 20 69 6e 20  column names in 
1c20: 74 68 65 20 6f 72 64 65 72 20 74 68 61 74 20 74  the order that t
1c30: 68 65 79 20 61 70 70 65 61 72 2e 0a 3c 2f 70 3e  hey appear..</p>
1c40: 0a 0a 3c 70 3e 0a 4e 6f 72 6d 61 6c 6c 79 2c 20  ..<p>.Normally, 
1c50: 4e 55 4c 4c 20 53 51 4c 20 72 65 73 75 6c 74 73  NULL SQL results
1c60: 20 61 72 65 20 73 74 6f 72 65 64 20 69 6e 20 74   are stored in t
1c70: 68 65 20 61 72 72 61 79 20 75 73 69 6e 67 20 74  he array using t
1c80: 68 65 0a 3c 61 20 68 72 65 66 3d 22 23 6e 75 6c  he.<a href="#nul
1c90: 6c 76 61 6c 75 65 22 3e 6e 75 6c 6c 76 61 6c 75  lvalue">nullvalu
1ca0: 65 3c 2f 61 3e 20 73 65 74 74 69 6e 67 2e 20 20  e</a> setting.  
1cb0: 48 6f 77 65 76 65 72 2c 20 69 66 0a 74 68 65 20  However, if.the 
1cc0: 3c 62 3e 2d 77 69 74 68 6f 75 74 6e 75 6c 6c 73  <b>-withoutnulls
1cd0: 3c 2f 62 3e 20 6f 70 74 69 6f 6e 20 69 73 20 75  </b> option is u
1ce0: 73 65 64 2c 20 74 68 65 6e 20 4e 55 4c 4c 20 53  sed, then NULL S
1cf0: 51 4c 20 76 61 6c 75 65 73 0a 63 61 75 73 65 20  QL values.cause 
1d00: 74 68 65 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e  the correspondin
1d10: 67 20 61 72 72 61 79 20 65 6c 65 6d 65 6e 74 20  g array element 
1d20: 74 6f 20 62 65 20 75 6e 73 65 74 20 69 6e 73 74  to be unset inst
1d30: 65 61 64 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 49  ead..</p>..<p>.I
1d40: 66 20 74 68 65 20 61 72 72 61 79 20 76 61 72 69  f the array vari
1d50: 61 62 6c 65 20 6e 61 6d 65 20 69 73 20 6f 6d 69  able name is omi
1d60: 74 74 65 64 20 6f 72 20 69 73 20 74 68 65 20 65  tted or is the e
1d70: 6d 70 74 79 20 73 74 72 69 6e 67 2c 20 74 68 65  mpty string, the
1d80: 6e 20 74 68 65 20 76 61 6c 75 65 20 6f 66 0a 65  n the value of.e
1d90: 61 63 68 20 63 6f 6c 75 6d 6e 20 69 73 20 73 74  ach column is st
1da0: 6f 72 65 64 20 69 6e 20 61 20 76 61 72 69 61 62  ored in a variab
1db0: 6c 65 20 77 69 74 68 20 74 68 65 20 73 61 6d 65  le with the same
1dc0: 20 6e 61 6d 65 20 61 73 20 74 68 65 20 63 6f 6c   name as the col
1dd0: 75 6d 6e 0a 69 74 73 65 6c 66 2e 20 20 46 6f 72  umn.itself.  For
1de0: 20 65 78 61 6d 70 6c 65 3a 0a 3c 2f 70 3e 0a 0a   example:.</p>..
1df0: 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c 62 3e  <blockquote>.<b>
1e00: 64 62 31 20 65 76 61 6c 20 7b 53 45 4c 45 43 54  db1 eval {SELECT
1e10: 20 2a 20 46 52 4f 4d 20 74 31 20 4f 52 44 45 52   * FROM t1 ORDER
1e20: 20 42 59 20 61 7d 20 7b 3c 62 72 3e 0a 26 6e 62   BY a} {<br>.&nb
1e30: 73 70 3b 26 6e 62 73 70 3b 26 6e 62 73 70 3b 26  sp;&nbsp;&nbsp;&
1e40: 6e 62 73 70 3b 70 75 74 73 20 22 61 3d 24 61 20  nbsp;puts "a=$a 
1e50: 62 3d 24 62 22 3c 62 72 3e 0a 7d 3c 2f 62 3e 0a  b=$b"<br>.}</b>.
1e60: 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c  </blockquote>..<
1e70: 70 3e 0a 46 72 6f 6d 20 74 68 69 73 20 77 65 20  p>.From this we 
1e80: 67 65 74 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e  get the followin
1e90: 67 20 6f 75 74 70 75 74 0a 3c 2f 70 3e 0a 0a 3c  g output.</p>..<
1ea0: 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 62 3e 0a 61  blockquote><b>.a
1eb0: 3d 31 20 62 3d 68 65 6c 6c 6f 3c 62 72 3e 0a 61  =1 b=hello<br>.a
1ec0: 3d 32 20 62 3d 67 6f 6f 64 62 79 65 3c 62 72 3e  =2 b=goodbye<br>
1ed0: 0a 61 3d 33 20 62 3d 68 6f 77 64 79 21 3c 2f 62  .a=3 b=howdy!</b
1ee0: 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  >.</blockquote>.
1ef0: 0a 3c 74 63 6c 3e 68 64 5f 66 72 61 67 6d 65 6e  .<tcl>hd_fragmen
1f00: 74 20 76 61 72 73 75 62 73 74 20 7b 54 43 4c 20  t varsubst {TCL 
1f10: 76 61 72 69 61 62 6c 65 20 73 75 62 73 74 69 74  variable substit
1f20: 75 74 69 6f 6e 7d 3c 2f 74 63 6c 3e 0a 3c 70 3e  ution}</tcl>.<p>
1f30: 0a 54 63 6c 20 76 61 72 69 61 62 6c 65 20 6e 61  .Tcl variable na
1f40: 6d 65 73 20 63 61 6e 20 61 70 70 65 61 72 20 69  mes can appear i
1f50: 6e 20 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d  n the SQL statem
1f60: 65 6e 74 20 6f 66 20 74 68 65 20 73 65 63 6f 6e  ent of the secon
1f70: 64 20 61 72 67 75 6d 65 6e 74 0a 69 6e 20 61 6e  d argument.in an
1f80: 79 20 70 6f 73 69 74 69 6f 6e 20 77 68 65 72 65  y position where
1f90: 20 69 74 20 69 73 20 6c 65 67 61 6c 20 74 6f 20   it is legal to 
1fa0: 70 75 74 20 61 20 73 74 72 69 6e 67 20 6f 72 20  put a string or 
1fb0: 6e 75 6d 62 65 72 20 6c 69 74 65 72 61 6c 2e 20  number literal. 
1fc0: 20 54 68 65 0a 76 61 6c 75 65 20 6f 66 20 74 68   The.value of th
1fd0: 65 20 76 61 72 69 61 62 6c 65 20 69 73 20 73 75  e variable is su
1fe0: 62 73 74 69 74 75 74 65 64 20 66 6f 72 20 74 68  bstituted for th
1ff0: 65 20 76 61 72 69 61 62 6c 65 20 6e 61 6d 65 2e  e variable name.
2000: 20 20 49 66 20 74 68 65 0a 76 61 72 69 61 62 6c    If the.variabl
2010: 65 20 64 6f 65 73 20 6e 6f 74 20 65 78 69 73 74  e does not exist
2020: 20 61 20 4e 55 4c 4c 20 76 61 6c 75 65 73 20 69   a NULL values i
2030: 73 20 75 73 65 64 2e 20 20 46 6f 72 20 65 78 61  s used.  For exa
2040: 6d 70 6c 65 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f  mple:.</p>..<blo
2050: 63 6b 71 75 6f 74 65 3e 3c 62 3e 0a 64 62 31 20  ckquote><b>.db1 
2060: 65 76 61 6c 20 7b 49 4e 53 45 52 54 20 49 4e 54  eval {INSERT INT
2070: 4f 20 74 31 20 56 41 4c 55 45 53 28 35 2c 24 62  O t1 VALUES(5,$b
2080: 69 67 73 74 72 69 6e 67 29 7d 0a 3c 2f 62 3e 3c  igstring)}.</b><
2090: 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70  /blockquote>..<p
20a0: 3e 0a 4e 6f 74 65 20 74 68 61 74 20 69 74 20 69  >.Note that it i
20b0: 73 20 6e 6f 74 20 6e 65 63 65 73 73 61 72 79 20  s not necessary 
20c0: 74 6f 20 71 75 6f 74 65 20 74 68 65 20 24 62 69  to quote the $bi
20d0: 67 73 74 72 69 6e 67 20 76 61 6c 75 65 2e 20 20  gstring value.  
20e0: 54 68 61 74 20 68 61 70 70 65 6e 73 0a 61 75 74  That happens.aut
20f0: 6f 6d 61 74 69 63 61 6c 6c 79 2e 20 20 49 66 20  omatically.  If 
2100: 24 62 69 67 73 74 72 69 6e 67 20 69 73 20 61 20  $bigstring is a 
2110: 6c 61 72 67 65 20 73 74 72 69 6e 67 20 6f 72 20  large string or 
2120: 62 69 6e 61 72 79 20 6f 62 6a 65 63 74 2c 20 74  binary object, t
2130: 68 69 73 0a 74 65 63 68 6e 69 71 75 65 20 69 73  his.technique is
2140: 20 6e 6f 74 20 6f 6e 6c 79 20 65 61 73 69 65 72   not only easier
2150: 20 74 6f 20 77 72 69 74 65 2c 20 69 74 20 69 73   to write, it is
2160: 20 61 6c 73 6f 20 6d 75 63 68 20 6d 6f 72 65 20   also much more 
2170: 65 66 66 69 63 69 65 6e 74 0a 73 69 6e 63 65 20  efficient.since 
2180: 69 74 20 61 76 6f 69 64 73 20 6d 61 6b 69 6e 67  it avoids making
2190: 20 61 20 63 6f 70 79 20 6f 66 20 74 68 65 20 63   a copy of the c
21a0: 6f 6e 74 65 6e 74 20 6f 66 20 24 62 69 67 73 74  ontent of $bigst
21b0: 72 69 6e 67 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a  ring..</p>..<p>.
21c0: 49 66 20 74 68 65 20 24 62 69 67 73 74 72 69 6e  If the $bigstrin
21d0: 67 20 76 61 72 69 61 62 6c 65 20 68 61 73 20 62  g variable has b
21e0: 6f 74 68 20 61 20 73 74 72 69 6e 67 20 61 6e 64  oth a string and
21f0: 20 61 20 22 62 79 74 65 61 72 72 61 79 22 20 72   a "bytearray" r
2200: 65 70 72 65 73 65 6e 74 61 74 69 6f 6e 2c 0a 74  epresentation,.t
2210: 68 65 6e 20 54 43 4c 20 69 6e 73 65 72 74 73 20  hen TCL inserts 
2220: 74 68 65 20 76 61 6c 75 65 20 61 73 20 61 20 73  the value as a s
2230: 74 72 69 6e 67 2e 20 20 49 66 20 69 74 20 68 61  tring.  If it ha
2240: 73 20 6f 6e 6c 79 20 61 20 22 62 79 74 65 61 72  s only a "bytear
2250: 72 61 79 22 0a 72 65 70 72 65 73 65 6e 74 61 74  ray".representat
2260: 69 6f 6e 2c 20 74 68 65 6e 20 74 68 65 20 76 61  ion, then the va
2270: 6c 75 65 20 69 73 20 69 6e 73 65 72 74 65 64 20  lue is inserted 
2280: 61 73 20 61 20 42 4c 4f 42 2e 20 20 54 6f 20 66  as a BLOB.  To f
2290: 6f 72 63 65 20 61 0a 76 61 6c 75 65 20 74 6f 20  orce a.value to 
22a0: 62 65 20 69 6e 73 65 72 74 65 64 20 61 73 20 61  be inserted as a
22b0: 20 42 4c 4f 42 20 65 76 65 6e 20 69 66 20 69 74   BLOB even if it
22c0: 20 61 6c 73 6f 20 68 61 73 20 61 20 74 65 78 74   also has a text
22d0: 20 72 65 70 72 65 73 65 6e 74 61 74 69 6f 6e 2c   representation,
22e0: 0a 75 73 65 20 61 20 22 40 22 20 63 68 61 72 61  .use a "@" chara
22f0: 63 74 65 72 20 74 6f 20 69 6e 20 70 6c 61 63 65  cter to in place
2300: 20 6f 66 20 74 68 65 20 22 24 22 2e 20 20 4c 69   of the "$".  Li
2310: 6b 65 20 74 68 69 73 3a 0a 3c 2f 70 3e 0a 0a 3c  ke this:.</p>..<
2320: 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 62 3e 0a 64  blockquote><b>.d
2330: 62 31 20 65 76 61 6c 20 7b 49 4e 53 45 52 54 20  b1 eval {INSERT 
2340: 49 4e 54 4f 20 74 31 20 56 41 4c 55 45 53 28 35  INTO t1 VALUES(5
2350: 2c 40 62 69 67 73 74 72 69 6e 67 29 7d 0a 3c 2f  ,@bigstring)}.</
2360: 62 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  b></blockquote>.
2370: 0a 3c 70 3e 0a 49 66 20 74 68 65 20 76 61 72 69  .<p>.If the vari
2380: 61 62 6c 65 20 64 6f 65 73 20 6e 6f 74 20 68 61  able does not ha
2390: 76 65 20 61 20 62 79 74 65 61 72 72 61 79 20 72  ve a bytearray r
23a0: 65 70 72 65 73 65 6e 74 61 74 69 6f 6e 2c 20 74  epresentation, t
23b0: 68 65 6e 20 22 40 22 20 77 6f 72 6b 73 0a 6a 75  hen "@" works.ju
23c0: 73 74 20 6c 69 6b 65 20 22 24 22 2e 20 20 4e 6f  st like "$".  No
23d0: 74 65 20 74 68 61 74 20 22 3a 22 20 77 6f 72 6b  te that ":" work
23e0: 73 20 6c 69 6b 65 20 22 24 22 20 69 6e 20 61 6c  s like "$" in al
23f0: 6c 20 63 61 73 65 73 20 73 6f 20 74 68 65 20 66  l cases so the f
2400: 6f 6c 6c 6f 77 69 6e 67 0a 69 73 20 61 6e 6f 74  ollowing.is anot
2410: 68 65 72 20 77 61 79 20 74 6f 20 65 78 70 72 65  her way to expre
2420: 73 73 20 74 68 65 20 73 61 6d 65 20 73 74 61 74  ss the same stat
2430: 65 6d 65 6e 74 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c  ement:.</p>..<bl
2440: 6f 63 6b 71 75 6f 74 65 3e 3c 62 3e 0a 64 62 31  ockquote><b>.db1
2450: 20 65 76 61 6c 20 7b 49 4e 53 45 52 54 20 49 4e   eval {INSERT IN
2460: 54 4f 20 74 31 20 56 41 4c 55 45 53 28 35 2c 3a  TO t1 VALUES(5,:
2470: 62 69 67 73 74 72 69 6e 67 29 7d 0a 3c 2f 62 3e  bigstring)}.</b>
2480: 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c  </blockquote>..<
2490: 70 3e 54 68 65 20 75 73 65 20 6f 66 20 22 3a 22  p>The use of ":"
24a0: 20 69 6e 73 74 65 61 64 20 6f 66 20 22 24 22 20   instead of "$" 
24b0: 62 65 66 6f 72 65 20 74 68 65 20 6e 61 6d 65 20  before the name 
24c0: 6f 66 20 61 20 76 61 72 69 61 62 6c 65 20 63 61  of a variable ca
24d0: 6e 20 0a 73 6f 6d 65 74 69 6d 65 73 20 62 65 20  n .sometimes be 
24e0: 75 73 65 66 75 6c 20 69 66 20 74 68 65 20 53 51  useful if the SQ
24f0: 4c 20 74 65 78 74 20 69 73 20 65 6e 63 6c 6f 73  L text is enclos
2500: 65 64 20 69 6e 20 64 6f 75 62 6c 65 2d 71 75 6f  ed in double-quo
2510: 74 65 73 20 22 2e 2e 2e 22 0a 69 6e 73 74 65 61  tes "...".instea
2520: 64 20 6f 66 20 63 75 72 6c 79 2d 62 72 61 63 65  d of curly-brace
2530: 73 20 7b 2e 2e 2e 7d 2e 20 20 0a 57 68 65 6e 20  s {...}.  .When 
2540: 74 68 65 20 53 51 4c 20 69 73 20 63 6f 6e 74 61  the SQL is conta
2550: 69 6e 65 64 20 77 69 74 68 69 6e 20 64 6f 75 62  ined within doub
2560: 6c 65 2d 71 75 6f 74 65 73 20 22 2e 2e 2e 22 20  le-quotes "..." 
2570: 74 68 65 6e 20 54 43 4c 20 77 69 6c 6c 20 64 6f  then TCL will do
2580: 0a 74 68 65 20 73 75 62 73 74 69 74 75 74 69 6f  .the substitutio
2590: 6e 20 6f 66 20 24 2d 76 61 72 69 61 62 6c 65 73  n of $-variables
25a0: 2c 20 77 68 69 63 68 20 63 61 6e 20 6c 65 61 64  , which can lead
25b0: 20 74 6f 20 53 51 4c 20 69 6e 6a 65 63 74 69 6f   to SQL injectio
25c0: 6e 20 69 66 0a 65 78 74 72 65 6d 65 20 63 61 72  n if.extreme car
25d0: 65 20 69 73 20 6e 6f 74 20 75 73 65 64 2e 20 20  e is not used.  
25e0: 42 75 74 20 54 43 4c 20 77 69 6c 6c 20 6e 65 76  But TCL will nev
25f0: 65 72 20 73 75 62 73 74 69 74 75 74 65 20 61 20  er substitute a 
2600: 3a 2d 76 61 72 69 61 62 6c 65 0a 72 65 67 61 72  :-variable.regar
2610: 64 6c 65 73 73 20 6f 66 20 77 68 65 74 68 65 72  dless of whether
2620: 20 64 6f 75 62 6c 65 2d 71 75 6f 74 65 73 20 22   double-quotes "
2630: 2e 2e 2e 22 20 6f 72 20 63 75 72 6c 79 2d 62 72  ..." or curly-br
2640: 61 63 65 73 20 7b 2e 2e 2e 7d 20 61 72 65 20 0a  aces {...} are .
2650: 75 73 65 64 20 74 6f 20 65 6e 63 6c 6f 73 65 20  used to enclose 
2660: 74 68 65 20 53 51 4c 2c 20 73 6f 20 74 68 65 20  the SQL, so the 
2670: 75 73 65 20 6f 66 20 3a 2d 76 61 72 69 61 62 6c  use of :-variabl
2680: 65 73 20 61 64 64 73 20 61 6e 20 65 78 74 72 61  es adds an extra
2690: 20 0a 6d 65 61 73 75 72 65 20 6f 66 20 64 65 66   .measure of def
26a0: 65 6e 73 65 20 61 67 61 69 6e 73 74 20 53 51 4c  ense against SQL
26b0: 0a 69 6e 6a 65 63 74 69 6f 6e 2e 0a 3c 2f 70 3e  .injection..</p>
26c0: 0a 0a 7d 0a 0a 23 23 23 23 23 23 23 23 23 23 23  ..}..###########
26d0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
26e0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
26f0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
2700: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
2710: 23 23 23 0a 4d 45 54 48 4f 44 20 63 6c 6f 73 65  ###.METHOD close
2720: 20 7b 0a 0a 3c 70 3e 0a 41 73 20 69 74 73 20 6e   {..<p>.As its n
2730: 61 6d 65 20 73 75 67 67 65 73 74 73 2c 20 74 68  ame suggests, th
2740: 65 20 22 63 6c 6f 73 65 22 20 6d 65 74 68 6f 64  e "close" method
2750: 20 74 6f 20 61 6e 20 53 51 4c 69 74 65 20 64 61   to an SQLite da
2760: 74 61 62 61 73 65 20 6a 75 73 74 0a 63 6c 6f 73  tabase just.clos
2770: 65 73 20 74 68 65 20 64 61 74 61 62 61 73 65 2e  es the database.
2780: 20 20 54 68 69 73 20 68 61 73 20 74 68 65 20 73    This has the s
2790: 69 64 65 2d 65 66 66 65 63 74 20 6f 66 20 64 65  ide-effect of de
27a0: 6c 65 74 69 6e 67 20 74 68 65 0a 3c 69 3e 64 62  leting the.<i>db
27b0: 63 6d 64 3c 2f 69 3e 20 54 63 6c 20 63 6f 6d 6d  cmd</i> Tcl comm
27c0: 61 6e 64 2e 20 20 48 65 72 65 20 69 73 20 61 6e  and.  Here is an
27d0: 20 65 78 61 6d 70 6c 65 20 6f 66 20 6f 70 65 6e   example of open
27e0: 69 6e 67 20 61 6e 64 20 74 68 65 6e 0a 69 6d 6d  ing and then.imm
27f0: 65 64 69 61 74 65 6c 79 20 63 6c 6f 73 69 6e 67  ediately closing
2800: 20 61 20 64 61 74 61 62 61 73 65 3a 0a 3c 2f 70   a database:.</p
2810: 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  >..<blockquote>.
2820: 3c 62 3e 73 71 6c 69 74 65 33 20 64 62 31 20 2e  <b>sqlite3 db1 .
2830: 2f 74 65 73 74 64 62 3c 62 72 3e 0a 64 62 31 20  /testdb<br>.db1 
2840: 63 6c 6f 73 65 3c 2f 62 3e 0a 3c 2f 62 6c 6f 63  close</b>.</bloc
2850: 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 0a 49 66 20  kquote>..<p>.If 
2860: 79 6f 75 20 64 65 6c 65 74 65 20 74 68 65 20 3c  you delete the <
2870: 69 3e 64 62 63 6d 64 3c 2f 69 3e 20 64 69 72 65  i>dbcmd</i> dire
2880: 63 74 6c 79 2c 20 74 68 61 74 20 68 61 73 20 74  ctly, that has t
2890: 68 65 20 73 61 6d 65 20 65 66 66 65 63 74 0a 61  he same effect.a
28a0: 73 20 69 6e 76 6f 6b 69 6e 67 20 74 68 65 20 22  s invoking the "
28b0: 63 6c 6f 73 65 22 20 6d 65 74 68 6f 64 2e 20 20  close" method.  
28c0: 53 6f 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67  So the following
28d0: 20 63 6f 64 65 20 69 73 20 65 71 75 69 76 61 6c   code is equival
28e0: 65 6e 74 0a 74 6f 20 74 68 65 20 70 72 65 76 69  ent.to the previ
28f0: 6f 75 73 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b  ous:</p>..<block
2900: 71 75 6f 74 65 3e 0a 3c 62 3e 73 71 6c 69 74 65  quote>.<b>sqlite
2910: 33 20 64 62 31 20 2e 2f 74 65 73 74 64 62 3c 62  3 db1 ./testdb<b
2920: 72 3e 0a 72 65 6e 61 6d 65 20 64 62 31 20 7b 7d  r>.rename db1 {}
2930: 3c 2f 62 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74  </b>.</blockquot
2940: 65 3e 0a 7d 0a 0a 23 23 23 23 23 23 23 23 23 23  e>.}..##########
2950: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
2960: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
2970: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
2980: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
2990: 23 23 23 23 0a 4d 45 54 48 4f 44 20 74 72 61 6e  ####.METHOD tran
29a0: 73 61 63 74 69 6f 6e 20 7b 0a 0a 3c 70 3e 0a 54  saction {..<p>.T
29b0: 68 65 20 22 74 72 61 6e 73 61 63 74 69 6f 6e 22  he "transaction"
29c0: 20 6d 65 74 68 6f 64 20 69 73 20 75 73 65 64 20   method is used 
29d0: 74 6f 20 65 78 65 63 75 74 65 20 61 20 54 43 4c  to execute a TCL
29e0: 20 73 63 72 69 70 74 20 69 6e 73 69 64 65 20 61   script inside a
29f0: 6e 20 53 51 4c 69 74 65 0a 64 61 74 61 62 61 73  n SQLite.databas
2a00: 65 20 74 72 61 6e 73 61 63 74 69 6f 6e 2e 20 20  e transaction.  
2a10: 54 68 65 20 74 72 61 6e 73 61 63 74 69 6f 6e 20  The transaction 
2a20: 69 73 20 63 6f 6d 6d 69 74 74 65 64 20 77 68 65  is committed whe
2a30: 6e 20 74 68 65 20 73 63 72 69 70 74 20 63 6f 6d  n the script com
2a40: 70 6c 65 74 65 73 2c 0a 6f 72 20 69 74 20 72 6f  pletes,.or it ro
2a50: 6c 6c 73 20 62 61 63 6b 20 69 66 20 74 68 65 20  lls back if the 
2a60: 73 63 72 69 70 74 20 66 61 69 6c 73 2e 20 20 49  script fails.  I
2a70: 66 20 74 68 65 20 74 72 61 6e 73 61 63 74 69 6f  f the transactio
2a80: 6e 20 6f 63 63 75 72 73 20 77 69 74 68 69 6e 0a  n occurs within.
2a90: 61 6e 6f 74 68 65 72 20 74 72 61 6e 73 61 63 74  another transact
2aa0: 69 6f 6e 20 28 65 76 65 6e 20 6f 6e 65 20 74 68  ion (even one th
2ab0: 61 74 20 69 73 20 73 74 61 72 74 65 64 20 6d 61  at is started ma
2ac0: 6e 75 61 6c 6c 79 20 75 73 69 6e 67 20 42 45 47  nually using BEG
2ad0: 49 4e 29 20 69 74 0a 69 73 20 61 20 6e 6f 2d 6f  IN) it.is a no-o
2ae0: 70 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 54 68 65  p..</p>..<p>.The
2af0: 20 74 72 61 6e 73 61 63 74 69 6f 6e 20 63 6f 6d   transaction com
2b00: 6d 61 6e 64 20 63 61 6e 20 62 65 20 75 73 65 64  mand can be used
2b10: 20 74 6f 20 67 72 6f 75 70 20 74 6f 67 65 74 68   to group togeth
2b20: 65 72 20 73 65 76 65 72 61 6c 20 53 51 4c 69 74  er several SQLit
2b30: 65 0a 63 6f 6d 6d 61 6e 64 73 20 69 6e 20 61 20  e.commands in a 
2b40: 73 61 66 65 20 77 61 79 2e 20 20 59 6f 75 20 63  safe way.  You c
2b50: 61 6e 20 61 6c 77 61 79 73 20 73 74 61 72 74 20  an always start 
2b60: 74 72 61 6e 73 61 63 74 69 6f 6e 73 20 6d 61 6e  transactions man
2b70: 75 61 6c 6c 79 20 75 73 69 6e 67 0a 42 45 47 49  ually using.BEGI
2b80: 4e 2c 20 6f 66 0a 63 6f 75 72 73 65 2e 20 20 42  N, of.course.  B
2b90: 75 74 20 69 66 20 61 6e 20 65 72 72 6f 72 20 6f  ut if an error o
2ba0: 63 63 75 72 73 20 73 6f 20 74 68 61 74 20 74 68  ccurs so that th
2bb0: 65 20 43 4f 4d 4d 49 54 20 6f 72 20 52 4f 4c 4c  e COMMIT or ROLL
2bc0: 42 41 43 4b 20 61 72 65 20 6e 65 76 65 72 0a 72  BACK are never.r
2bd0: 75 6e 2c 20 74 68 65 6e 20 74 68 65 20 64 61 74  un, then the dat
2be0: 61 62 61 73 65 20 77 69 6c 6c 20 72 65 6d 61 69  abase will remai
2bf0: 6e 20 6c 6f 63 6b 65 64 20 69 6e 64 65 66 69 6e  n locked indefin
2c00: 69 74 65 6c 79 2e 20 20 41 6c 73 6f 2c 20 42 45  itely.  Also, BE
2c10: 47 49 4e 0a 64 6f 65 73 20 6e 6f 74 20 6e 65 73  GIN.does not nes
2c20: 74 2c 20 73 6f 20 79 6f 75 20 68 61 76 65 20 74  t, so you have t
2c30: 6f 20 6d 61 6b 65 20 73 75 72 65 20 6e 6f 20 6f  o make sure no o
2c40: 74 68 65 72 20 74 72 61 6e 73 61 63 74 69 6f 6e  ther transaction
2c50: 73 20 61 72 65 20 61 63 74 69 76 65 0a 62 65 66  s are active.bef
2c60: 6f 72 65 20 73 74 61 72 74 69 6e 67 20 61 20 6e  ore starting a n
2c70: 65 77 20 6f 6e 65 2e 20 20 54 68 65 20 22 74 72  ew one.  The "tr
2c80: 61 6e 73 61 63 74 69 6f 6e 22 20 6d 65 74 68 6f  ansaction" metho
2c90: 64 20 74 61 6b 65 73 20 63 61 72 65 20 6f 66 0a  d takes care of.
2ca0: 61 6c 6c 20 6f 66 20 74 68 65 73 65 20 64 65 74  all of these det
2cb0: 61 69 6c 73 20 61 75 74 6f 6d 61 74 69 63 61 6c  ails automatical
2cc0: 6c 79 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 54 68  ly..</p>..<p>.Th
2cd0: 65 20 73 79 6e 74 61 78 20 6c 6f 6f 6b 73 20 6c  e syntax looks l
2ce0: 69 6b 65 20 74 68 69 73 3a 0a 3c 2f 70 3e 0a 0a  ike this:.</p>..
2cf0: 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c 69 3e  <blockquote>.<i>
2d00: 64 62 63 6d 64 3c 2f 69 3e 26 6e 62 73 70 3b 26  dbcmd</i>&nbsp;&
2d10: 6e 62 73 70 3b 3c 62 3e 74 72 61 6e 73 61 63 74  nbsp;<b>transact
2d20: 69 6f 6e 3c 2f 62 3e 26 6e 62 73 70 3b 26 6e 62  ion</b>&nbsp;&nb
2d30: 73 70 3b 3c 69 3e 3f 74 72 61 6e 73 61 63 74 69  sp;<i>?transacti
2d40: 6f 6e 2d 74 79 70 65 3f 3c 2f 69 3e 0a 26 6e 62  on-type?</i>.&nb
2d50: 73 70 3b 26 6e 62 73 70 3b 3c 69 3e 73 63 72 69  sp;&nbsp;<i>scri
2d60: 70 74 3c 2f 69 3e 0a 3c 2f 62 6c 6f 63 6b 71 75  pt</i>.</blockqu
2d70: 6f 74 65 3e 0a 0a 0a 3c 70 3e 0a 54 68 65 20 3c  ote>...<p>.The <
2d80: 69 3e 74 72 61 6e 73 61 63 74 69 6f 6e 2d 74 79  i>transaction-ty
2d90: 70 65 3c 2f 69 3e 20 63 61 6e 20 62 65 20 6f 6e  pe</i> can be on
2da0: 65 20 6f 66 20 3c 62 3e 64 65 66 65 72 72 65 64  e of <b>deferred
2db0: 3c 2f 62 3e 2c 0a 3c 62 3e 65 78 63 6c 75 73 69  </b>,.<b>exclusi
2dc0: 76 65 3c 2f 62 3e 20 6f 72 20 3c 62 3e 69 6d 6d  ve</b> or <b>imm
2dd0: 65 64 69 61 74 65 3c 2f 62 3e 2e 20 20 54 68 65  ediate</b>.  The
2de0: 20 64 65 66 61 75 6c 74 20 69 73 20 64 65 66 65   default is defe
2df0: 72 72 65 64 2e 0a 3c 2f 70 3e 0a 7d 0a 0a 23 23  rred..</p>.}..##
2e00: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
2e10: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
2e20: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
2e30: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
2e40: 23 23 23 23 23 23 23 23 23 23 23 23 0a 4d 45 54  ############.MET
2e50: 48 4f 44 20 63 61 63 68 65 20 7b 0a 0a 3c 70 3e  HOD cache {..<p>
2e60: 0a 54 68 65 20 22 65 76 61 6c 22 20 6d 65 74 68  .The "eval" meth
2e70: 6f 64 20 64 65 73 63 72 69 62 65 64 20 3c 61 20  od described <a 
2e80: 68 72 65 66 3d 22 23 65 76 61 6c 22 3e 61 62 6f  href="#eval">abo
2e90: 76 65 3c 2f 61 3e 20 6b 65 65 70 73 20 61 20 63  ve</a> keeps a c
2ea0: 61 63 68 65 20 6f 66 0a 3c 61 20 68 72 65 66 3d  ache of.<a href=
2eb0: 22 63 33 72 65 66 2f 70 72 65 70 61 72 65 2e 68  "c3ref/prepare.h
2ec0: 74 6d 6c 22 3e 70 72 65 70 61 72 65 64 20 73 74  tml">prepared st
2ed0: 61 74 65 6d 65 6e 74 73 3c 2f 61 3e 0a 66 6f 72  atements</a>.for
2ee0: 20 72 65 63 65 6e 74 6c 79 20 65 76 61 6c 75 61   recently evalua
2ef0: 74 65 64 20 53 51 4c 20 63 6f 6d 6d 61 6e 64 73  ted SQL commands
2f00: 2e 20 20 0a 54 68 65 20 22 63 61 63 68 65 22 20  .  .The "cache" 
2f10: 6d 65 74 68 6f 64 20 69 73 20 75 73 65 64 20 74  method is used t
2f20: 6f 20 63 6f 6e 74 72 6f 6c 20 74 68 69 73 20 63  o control this c
2f30: 61 63 68 65 2e 0a 54 68 65 20 66 69 72 73 74 20  ache..The first 
2f40: 66 6f 72 6d 20 6f 66 20 74 68 69 73 20 63 6f 6d  form of this com
2f50: 6d 61 6e 64 20 69 73 3a 3c 2f 70 3e 0a 0a 3c 62  mand is:</p>..<b
2f60: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c 69 3e 64 62  lockquote>.<i>db
2f70: 63 6d 64 3c 2f 69 3e 26 6e 62 73 70 3b 26 6e 62  cmd</i>&nbsp;&nb
2f80: 73 70 3b 3c 62 3e 63 61 63 68 65 20 73 69 7a 65  sp;<b>cache size
2f90: 3c 2f 62 3e 26 6e 62 73 70 3b 26 6e 62 73 70 3b  </b>&nbsp;&nbsp;
2fa0: 3c 69 3e 4e 3c 2f 69 3e 0a 3c 2f 62 6c 6f 63 6b  <i>N</i>.</block
2fb0: 71 75 6f 74 65 3e 0a 0a 3c 70 3e 54 68 69 73 20  quote>..<p>This 
2fc0: 73 65 74 73 20 74 68 65 20 6d 61 78 69 6d 75 6d  sets the maximum
2fd0: 20 6e 75 6d 62 65 72 20 6f 66 20 73 74 61 74 65   number of state
2fe0: 6d 65 6e 74 73 20 74 68 61 74 20 63 61 6e 20 62  ments that can b
2ff0: 65 20 63 61 63 68 65 64 2e 0a 54 68 65 20 75 70  e cached..The up
3000: 70 65 72 20 6c 69 6d 69 74 20 69 73 20 31 30 30  per limit is 100
3010: 2e 20 20 54 68 65 20 64 65 66 61 75 6c 74 20 69  .  The default i
3020: 73 20 31 30 2e 20 20 49 66 20 79 6f 75 20 73 65  s 10.  If you se
3030: 74 20 74 68 65 20 63 61 63 68 65 20 73 69 7a 65  t the cache size
3040: 0a 74 6f 20 30 2c 20 6e 6f 20 63 61 63 68 69 6e  .to 0, no cachin
3050: 67 20 69 73 20 64 6f 6e 65 2e 3c 2f 70 3e 0a 0a  g is done.</p>..
3060: 3c 70 3e 54 68 65 20 73 65 63 6f 6e 64 20 66 6f  <p>The second fo
3070: 72 6d 20 6f 66 20 74 68 65 20 63 6f 6d 6d 61 6e  rm of the comman
3080: 64 20 69 73 20 74 68 69 73 3a 3c 2f 70 3e 0a 0a  d is this:</p>..
3090: 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c 69  .<blockquote>.<i
30a0: 3e 64 62 63 6d 64 3c 2f 69 3e 26 6e 62 73 70 3b  >dbcmd</i>&nbsp;
30b0: 26 6e 62 73 70 3b 3c 62 3e 63 61 63 68 65 20 66  &nbsp;<b>cache f
30c0: 6c 75 73 68 3c 2f 62 3e 0a 3c 2f 62 6c 6f 63 6b  lush</b>.</block
30d0: 71 75 6f 74 65 3e 0a 0a 3c 70 3e 54 68 65 20 63  quote>..<p>The c
30e0: 61 63 68 65 2d 66 6c 75 73 68 20 6d 65 74 68 6f  ache-flush metho
30f0: 64 20 0a 3c 61 20 68 72 65 66 3d 22 63 33 72 65  d .<a href="c3re
3100: 66 2f 66 69 6e 61 6c 69 7a 65 2e 68 74 6d 6c 22  f/finalize.html"
3110: 3e 66 69 6e 61 6c 69 7a 65 73 3c 2f 61 3e 0a 61  >finalizes</a>.a
3120: 6c 6c 20 70 72 65 70 61 72 65 64 20 73 74 61 74  ll prepared stat
3130: 65 6d 65 6e 74 73 20 63 75 72 72 65 6e 74 6c 79  ements currently
3140: 0a 69 6e 20 74 68 65 20 63 61 63 68 65 2e 3c 2f  .in the cache.</
3150: 70 3e 0a 0a 7d 0a 0a 23 23 23 23 23 23 23 23 23  p>..}..#########
3160: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
3170: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
3180: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
3190: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
31a0: 23 23 23 23 23 0a 4d 45 54 48 4f 44 20 63 6f 6d  #####.METHOD com
31b0: 70 6c 65 74 65 20 7b 0a 0a 3c 70 3e 0a 54 68 65  plete {..<p>.The
31c0: 20 22 63 6f 6d 70 6c 65 74 65 22 20 6d 65 74 68   "complete" meth
31d0: 6f 64 20 74 61 6b 65 73 20 61 20 73 74 72 69 6e  od takes a strin
31e0: 67 20 6f 66 20 73 75 70 70 6f 73 65 64 20 53 51  g of supposed SQ
31f0: 4c 20 61 73 20 69 74 73 20 6f 6e 6c 79 20 61 72  L as its only ar
3200: 67 75 6d 65 6e 74 2e 0a 49 74 20 72 65 74 75 72  gument..It retur
3210: 6e 73 20 54 52 55 45 20 69 66 20 74 68 65 20 73  ns TRUE if the s
3220: 74 72 69 6e 67 20 69 73 20 61 20 63 6f 6d 70 6c  tring is a compl
3230: 65 74 65 20 73 74 61 74 65 6d 65 6e 74 20 6f 66  ete statement of
3240: 20 53 51 4c 20 61 6e 64 20 46 41 4c 53 45 20 69   SQL and FALSE i
3250: 66 0a 74 68 65 72 65 20 69 73 20 6d 6f 72 65 20  f.there is more 
3260: 74 6f 20 62 65 20 65 6e 74 65 72 65 64 2e 3c 2f  to be entered.</
3270: 70 3e 0a 0a 3c 70 3e 54 68 65 20 22 63 6f 6d 70  p>..<p>The "comp
3280: 6c 65 74 65 22 20 6d 65 74 68 6f 64 20 69 73 20  lete" method is 
3290: 75 73 65 66 75 6c 20 77 68 65 6e 20 62 75 69 6c  useful when buil
32a0: 64 69 6e 67 20 69 6e 74 65 72 61 63 74 69 76 65  ding interactive
32b0: 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 0a 69 6e   applications.in
32c0: 20 6f 72 64 65 72 20 74 6f 20 6b 6e 6f 77 20 77   order to know w
32d0: 68 65 6e 20 74 68 65 20 75 73 65 72 20 68 61 73  hen the user has
32e0: 20 66 69 6e 69 73 68 65 64 20 65 6e 74 65 72 69   finished enteri
32f0: 6e 67 20 61 20 6c 69 6e 65 20 6f 66 20 53 51 4c  ng a line of SQL
3300: 20 63 6f 64 65 2e 0a 54 68 69 73 20 69 73 20 72   code..This is r
3310: 65 61 6c 6c 79 20 6a 75 73 74 20 61 6e 20 69 6e  eally just an in
3320: 74 65 72 66 61 63 65 20 74 6f 20 74 68 65 20 0a  terface to the .
3330: 3c 61 20 68 72 65 66 3d 22 63 33 72 65 66 2f 63  <a href="c3ref/c
3340: 6f 6d 70 6c 65 74 65 2e 68 74 6d 6c 22 3e 3c 62  omplete.html"><b
3350: 3e 73 71 6c 69 74 65 33 5f 63 6f 6d 70 6c 65 74  >sqlite3_complet
3360: 65 28 29 3c 2f 62 3e 3c 2f 61 3e 20 43 0a 66 75  e()</b></a> C.fu
3370: 6e 63 74 69 6f 6e 2e 0a 7d 0a 0a 23 23 23 23 23  nction..}..#####
3380: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
3390: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
33a0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
33b0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
33c0: 23 23 23 23 23 23 23 23 23 0a 4d 45 54 48 4f 44  #########.METHOD
33d0: 20 63 6f 70 79 20 7b 0a 0a 3c 70 3e 0a 54 68 65   copy {..<p>.The
33e0: 20 22 63 6f 70 79 22 20 6d 65 74 68 6f 64 20 63   "copy" method c
33f0: 6f 70 69 65 73 20 64 61 74 61 20 66 72 6f 6d 20  opies data from 
3400: 61 20 66 69 6c 65 20 69 6e 74 6f 20 61 20 74 61  a file into a ta
3410: 62 6c 65 2e 0a 49 74 20 72 65 74 75 72 6e 73 20  ble..It returns 
3420: 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 72 6f  the number of ro
3430: 77 73 20 70 72 6f 63 65 73 73 65 64 20 73 75 63  ws processed suc
3440: 63 65 73 73 66 75 6c 6c 79 20 66 72 6f 6d 20 74  cessfully from t
3450: 68 65 20 66 69 6c 65 2e 0a 54 68 65 20 73 79 6e  he file..The syn
3460: 74 61 78 20 6f 66 20 74 68 65 20 63 6f 70 79 20  tax of the copy 
3470: 6d 65 74 68 6f 64 20 6c 6f 6f 6b 73 20 6c 69 6b  method looks lik
3480: 65 20 74 68 69 73 3a 3c 2f 70 3e 0a 0a 3c 62 6c  e this:</p>..<bl
3490: 6f 63 6b 71 75 6f 74 65 3e 0a 3c 69 3e 64 62 63  ockquote>.<i>dbc
34a0: 6d 64 3c 2f 69 3e 26 6e 62 73 70 3b 26 6e 62 73  md</i>&nbsp;&nbs
34b0: 70 3b 3c 62 3e 63 6f 70 79 3c 2f 62 3e 26 6e 62  p;<b>copy</b>&nb
34c0: 73 70 3b 26 6e 62 73 70 3b 3c 69 3e 63 6f 6e 66  sp;&nbsp;<i>conf
34d0: 6c 69 63 74 2d 61 6c 67 6f 72 69 74 68 6d 3c 2f  lict-algorithm</
34e0: 69 3e 0a 26 6e 62 73 70 3b 26 6e 62 73 70 3b 3c  i>.&nbsp;&nbsp;<
34f0: 69 3e 74 61 62 6c 65 2d 6e 61 6d 65 26 6e 62 73  i>table-name&nbs
3500: 70 3b 3c 2f 69 3e 26 6e 62 73 70 3b 26 6e 62 73  p;</i>&nbsp;&nbs
3510: 70 3b 3c 69 3e 66 69 6c 65 2d 6e 61 6d 65 26 6e  p;<i>file-name&n
3520: 62 73 70 3b 3c 2f 69 3e 0a 26 6e 62 73 70 3b 26  bsp;</i>.&nbsp;&
3530: 6e 62 73 70 3b 26 6e 62 73 70 3b 26 6e 62 73 70  nbsp;&nbsp;&nbsp
3540: 3b 3f 3c 69 3e 63 6f 6c 75 6d 6e 2d 73 65 70 61  ;?<i>column-sepa
3550: 72 61 74 6f 72 3c 2f 69 3e 3f 0a 26 6e 62 73 70  rator</i>?.&nbsp
3560: 3b 26 6e 62 73 70 3b 3f 3c 69 3e 6e 75 6c 6c 2d  ;&nbsp;?<i>null-
3570: 69 6e 64 69 63 61 74 6f 72 3c 2f 69 3e 3f 0a 3c  indicator</i>?.<
3580: 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70  /blockquote>..<p
3590: 3e 43 6f 6e 66 6c 69 63 74 2d 61 6c 67 6f 72 69  >Conflict-algori
35a0: 74 68 6d 20 6d 75 73 74 20 62 65 20 6f 6e 65 20  thm must be one 
35b0: 6f 66 20 74 68 65 20 53 51 4c 69 74 65 20 63 6f  of the SQLite co
35c0: 6e 66 6c 69 63 74 20 61 6c 67 6f 72 69 74 68 6d  nflict algorithm
35d0: 73 20 66 6f 72 0a 74 68 65 20 49 4e 53 45 52 54  s for.the INSERT
35e0: 20 73 74 61 74 65 6d 65 6e 74 3a 20 3c 69 3e 72   statement: <i>r
35f0: 6f 6c 6c 62 61 63 6b 3c 2f 69 3e 2c 20 3c 69 3e  ollback</i>, <i>
3600: 61 62 6f 72 74 3c 2f 69 3e 2c 0a 3c 69 3e 66 61  abort</i>,.<i>fa
3610: 69 6c 3c 2f 69 3e 2c 3c 69 3e 69 67 6e 6f 72 65  il</i>,<i>ignore
3620: 3c 2f 69 3e 2c 20 6f 72 20 3c 69 3e 72 65 70 6c  </i>, or <i>repl
3630: 61 63 65 3c 2f 69 3e 2e 20 53 65 65 20 74 68 65  ace</i>. See the
3640: 20 53 51 4c 69 74 65 20 4c 61 6e 67 75 61 67 65   SQLite Language
3650: 0a 73 65 63 74 69 6f 6e 20 66 6f 72 20 3c 61 20  .section for <a 
3660: 68 72 65 66 3d 22 6c 61 6e 67 2e 68 74 6d 6c 23  href="lang.html#
3670: 63 6f 6e 66 6c 69 63 74 22 3e 4f 4e 20 43 4f 4e  conflict">ON CON
3680: 46 4c 49 43 54 3c 2f 61 3e 20 66 6f 72 20 6d 6f  FLICT</a> for mo
3690: 72 65 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 0a  re information..
36a0: 54 68 65 20 63 6f 6e 66 6c 69 63 74 2d 61 6c 67  The conflict-alg
36b0: 6f 72 69 74 68 6d 20 6d 75 73 74 20 62 65 20 73  orithm must be s
36c0: 70 65 63 69 66 69 65 64 20 69 6e 20 6c 6f 77 65  pecified in lowe
36d0: 72 20 63 61 73 65 2e 0a 3c 2f 70 3e 0a 0a 3c 70  r case..</p>..<p
36e0: 3e 54 61 62 6c 65 2d 6e 61 6d 65 20 6d 75 73 74  >Table-name must
36f0: 20 61 6c 72 65 61 64 79 20 65 78 69 73 74 73 20   already exists 
3700: 61 73 20 61 20 74 61 62 6c 65 2e 20 20 46 69 6c  as a table.  Fil
3710: 65 2d 6e 61 6d 65 20 6d 75 73 74 20 65 78 69 73  e-name must exis
3720: 74 2c 20 61 6e 64 0a 65 61 63 68 20 72 6f 77 20  t, and.each row 
3730: 6d 75 73 74 20 63 6f 6e 74 61 69 6e 20 74 68 65  must contain the
3740: 20 73 61 6d 65 20 6e 75 6d 62 65 72 20 6f 66 20   same number of 
3750: 63 6f 6c 75 6d 6e 73 20 61 73 20 64 65 66 69 6e  columns as defin
3760: 65 64 20 69 6e 20 74 68 65 20 74 61 62 6c 65 2e  ed in the table.
3770: 0a 49 66 20 61 20 6c 69 6e 65 20 69 6e 20 74 68  .If a line in th
3780: 65 20 66 69 6c 65 20 63 6f 6e 74 61 69 6e 73 20  e file contains 
3790: 6d 6f 72 65 20 6f 72 20 6c 65 73 73 20 74 68 61  more or less tha
37a0: 6e 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20  n the number of 
37b0: 63 6f 6c 75 6d 6e 73 20 64 65 66 69 6e 65 64 2c  columns defined,
37c0: 0a 74 68 65 20 63 6f 70 79 20 6d 65 74 68 6f 64  .the copy method
37d0: 20 72 6f 6c 6c 62 61 63 6b 73 20 61 6e 79 20 69   rollbacks any i
37e0: 6e 73 65 72 74 73 2c 20 61 6e 64 20 72 65 74 75  nserts, and retu
37f0: 72 6e 73 20 61 6e 20 65 72 72 6f 72 2e 3c 2f 70  rns an error.</p
3800: 3e 0a 0a 3c 70 3e 43 6f 6c 75 6d 6e 2d 73 65 70  >..<p>Column-sep
3810: 61 72 61 74 6f 72 20 69 73 20 61 6e 20 6f 70 74  arator is an opt
3820: 69 6f 6e 61 6c 20 63 6f 6c 75 6d 6e 20 73 65 70  ional column sep
3830: 61 72 61 74 6f 72 20 73 74 72 69 6e 67 2e 20 20  arator string.  
3840: 54 68 65 20 64 65 66 61 75 6c 74 20 69 73 0a 74  The default is.t
3850: 68 65 20 41 53 43 49 49 20 74 61 62 20 63 68 61  he ASCII tab cha
3860: 72 61 63 74 65 72 20 5c 74 2e 20 3c 2f 70 3e 0a  racter \t. </p>.
3870: 0a 3c 70 3e 4e 75 6c 6c 2d 69 6e 64 69 63 61 74  .<p>Null-indicat
3880: 6f 72 20 69 73 20 61 6e 20 6f 70 74 69 6f 6e 61  or is an optiona
3890: 6c 20 73 74 72 69 6e 67 20 74 68 61 74 20 69 6e  l string that in
38a0: 64 69 63 61 74 65 73 20 61 20 63 6f 6c 75 6d 6e  dicates a column
38b0: 20 76 61 6c 75 65 20 69 73 20 6e 75 6c 6c 2e 0a   value is null..
38c0: 54 68 65 20 64 65 66 61 75 6c 74 20 69 73 20 61  The default is a
38d0: 6e 20 65 6d 70 74 79 20 73 74 72 69 6e 67 2e 20  n empty string. 
38e0: 20 4e 6f 74 65 20 74 68 61 74 20 63 6f 6c 75 6d   Note that colum
38f0: 6e 2d 73 65 70 61 72 61 74 6f 72 20 61 6e 64 0a  n-separator and.
3900: 6e 75 6c 6c 2d 69 6e 64 69 63 61 74 6f 72 20 61  null-indicator a
3910: 72 65 20 6f 70 74 69 6f 6e 61 6c 20 70 6f 73 69  re optional posi
3920: 74 69 6f 6e 61 6c 20 61 72 67 75 6d 65 6e 74 73  tional arguments
3930: 3b 20 69 66 20 6e 75 6c 6c 2d 69 6e 64 69 63 61  ; if null-indica
3940: 74 6f 72 0a 69 73 20 73 70 65 63 69 66 69 65 64  tor.is specified
3950: 2c 20 61 20 63 6f 6c 75 6d 6e 2d 73 65 70 61 72  , a column-separ
3960: 61 74 6f 72 20 61 72 67 75 6d 65 6e 74 20 6d 75  ator argument mu
3970: 73 74 20 62 65 20 73 70 65 63 69 66 69 65 64 20  st be specified 
3980: 61 6e 64 0a 70 72 65 63 65 64 65 20 74 68 65 20  and.precede the 
3990: 6e 75 6c 6c 2d 69 6e 64 69 63 61 74 6f 72 20 61  null-indicator a
39a0: 72 67 75 6d 65 6e 74 2e 3c 2f 70 3e 0a 0a 3c 70  rgument.</p>..<p
39b0: 3e 54 68 65 20 63 6f 70 79 20 6d 65 74 68 6f 64  >The copy method
39c0: 20 69 6d 70 6c 65 6d 65 6e 74 73 20 73 69 6d 69   implements simi
39d0: 6c 61 72 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74  lar functionalit
39e0: 79 20 74 6f 20 74 68 65 20 3c 62 3e 2e 69 6d 70  y to the <b>.imp
39f0: 6f 72 74 3c 2f 62 3e 0a 53 51 4c 69 74 65 20 73  ort</b>.SQLite s
3a00: 68 65 6c 6c 20 63 6f 6d 6d 61 6e 64 2e 20 0a 7d  hell command. .}
3a10: 0a 0a 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ..##############
3a20: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
3a30: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
3a40: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
3a50: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
3a60: 0a 4d 45 54 48 4f 44 20 74 69 6d 65 6f 75 74 20  .METHOD timeout 
3a70: 7b 0a 0a 3c 70 3e 54 68 65 20 22 74 69 6d 65 6f  {..<p>The "timeo
3a80: 75 74 22 20 6d 65 74 68 6f 64 20 69 73 20 75 73  ut" method is us
3a90: 65 64 20 74 6f 20 63 6f 6e 74 72 6f 6c 20 68 6f  ed to control ho
3aa0: 77 20 6c 6f 6e 67 20 74 68 65 20 53 51 4c 69 74  w long the SQLit
3ab0: 65 20 6c 69 62 72 61 72 79 0a 77 69 6c 6c 20 77  e library.will w
3ac0: 61 69 74 20 66 6f 72 20 6c 6f 63 6b 73 20 74 6f  ait for locks to
3ad0: 20 63 6c 65 61 72 20 62 65 66 6f 72 65 20 67 69   clear before gi
3ae0: 76 69 6e 67 20 75 70 20 6f 6e 20 61 20 64 61 74  ving up on a dat
3af0: 61 62 61 73 65 20 74 72 61 6e 73 61 63 74 69 6f  abase transactio
3b00: 6e 2e 0a 54 68 65 20 64 65 66 61 75 6c 74 20 74  n..The default t
3b10: 69 6d 65 6f 75 74 20 69 73 20 30 20 6d 69 6c 6c  imeout is 0 mill
3b20: 69 73 65 63 6f 6e 64 2e 20 20 28 49 6e 20 6f 74  isecond.  (In ot
3b30: 68 65 72 20 77 6f 72 64 73 2c 20 74 68 65 20 64  her words, the d
3b40: 65 66 61 75 6c 74 20 62 65 68 61 76 69 6f 72 0a  efault behavior.
3b50: 69 73 20 6e 6f 74 20 74 6f 20 77 61 69 74 20 61  is not to wait a
3b60: 74 20 61 6c 6c 2e 29 3c 2f 70 3e 0a 0a 3c 70 3e  t all.)</p>..<p>
3b70: 54 68 65 20 53 51 4c 69 74 65 20 64 61 74 61 62  The SQLite datab
3b80: 61 73 65 20 61 6c 6c 6f 77 73 20 6d 75 6c 74 69  ase allows multi
3b90: 70 6c 65 20 73 69 6d 75 6c 74 61 6e 65 6f 75 73  ple simultaneous
3ba0: 0a 72 65 61 64 65 72 73 20 6f 72 20 61 20 73 69  .readers or a si
3bb0: 6e 67 6c 65 20 77 72 69 74 65 72 20 62 75 74 20  ngle writer but 
3bc0: 6e 6f 74 20 62 6f 74 68 2e 20 20 49 66 20 61 6e  not both.  If an
3bd0: 79 20 70 72 6f 63 65 73 73 20 69 73 20 77 72 69  y process is wri
3be0: 74 69 6e 67 20 74 6f 0a 74 68 65 20 64 61 74 61  ting to.the data
3bf0: 62 61 73 65 20 6e 6f 20 6f 74 68 65 72 20 70 72  base no other pr
3c00: 6f 63 65 73 73 20 69 73 20 61 6c 6c 6f 77 73 20  ocess is allows 
3c10: 74 6f 20 72 65 61 64 20 6f 72 20 77 72 69 74 65  to read or write
3c20: 2e 20 20 49 66 20 61 6e 79 20 70 72 6f 63 65 73  .  If any proces
3c30: 73 0a 69 73 20 72 65 61 64 69 6e 67 20 74 68 65  s.is reading the
3c40: 20 64 61 74 61 62 61 73 65 20 6f 74 68 65 72 20   database other 
3c50: 70 72 6f 63 65 73 73 65 73 20 61 72 65 20 61 6c  processes are al
3c60: 6c 6f 77 65 64 20 74 6f 20 72 65 61 64 20 62 75  lowed to read bu
3c70: 74 20 6e 6f 74 20 77 72 69 74 65 2e 0a 54 68 65  t not write..The
3c80: 20 65 6e 74 69 72 65 20 64 61 74 61 62 61 73 65   entire database
3c90: 20 73 68 61 72 65 64 20 61 20 73 69 6e 67 6c 65   shared a single
3ca0: 20 6c 6f 63 6b 2e 3c 2f 70 3e 0a 0a 3c 70 3e 57   lock.</p>..<p>W
3cb0: 68 65 6e 20 53 51 4c 69 74 65 20 74 72 69 65 73  hen SQLite tries
3cc0: 20 74 6f 20 6f 70 65 6e 20 61 20 64 61 74 61 62   to open a datab
3cd0: 61 73 65 20 61 6e 64 20 66 69 6e 64 73 20 74 68  ase and finds th
3ce0: 61 74 20 69 74 20 69 73 20 6c 6f 63 6b 65 64 2c  at it is locked,
3cf0: 20 69 74 0a 63 61 6e 20 6f 70 74 69 6f 6e 61 6c   it.can optional
3d00: 6c 79 20 64 65 6c 61 79 20 66 6f 72 20 61 20 73  ly delay for a s
3d10: 68 6f 72 74 20 77 68 69 6c 65 20 61 6e 64 20 74  hort while and t
3d20: 72 79 20 74 6f 20 6f 70 65 6e 20 74 68 65 20 66  ry to open the f
3d30: 69 6c 65 20 61 67 61 69 6e 2e 0a 54 68 69 73 20  ile again..This 
3d40: 70 72 6f 63 65 73 73 20 72 65 70 65 61 74 73 20  process repeats 
3d50: 75 6e 74 69 6c 20 74 68 65 20 71 75 65 72 79 20  until the query 
3d60: 74 69 6d 65 73 20 6f 75 74 20 61 6e 64 20 53 51  times out and SQ
3d70: 4c 69 74 65 20 72 65 74 75 72 6e 73 20 61 0a 66  Lite returns a.f
3d80: 61 69 6c 75 72 65 2e 20 20 54 68 65 20 74 69 6d  ailure.  The tim
3d90: 65 6f 75 74 20 69 73 20 61 64 6a 75 73 74 61 62  eout is adjustab
3da0: 6c 65 2e 20 20 49 74 20 69 73 20 73 65 74 20 74  le.  It is set t
3db0: 6f 20 30 20 62 79 20 64 65 66 61 75 6c 74 20 73  o 0 by default s
3dc0: 6f 20 74 68 61 74 0a 69 66 20 74 68 65 20 64 61  o that.if the da
3dd0: 74 61 62 61 73 65 20 69 73 20 6c 6f 63 6b 65 64  tabase is locked
3de0: 2c 20 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d  , the SQL statem
3df0: 65 6e 74 20 66 61 69 6c 73 20 69 6d 6d 65 64 69  ent fails immedi
3e00: 61 74 65 6c 79 2e 20 20 42 75 74 20 79 6f 75 0a  ately.  But you.
3e10: 63 61 6e 20 75 73 65 20 74 68 65 20 22 74 69 6d  can use the "tim
3e20: 65 6f 75 74 22 20 6d 65 74 68 6f 64 20 74 6f 20  eout" method to 
3e30: 63 68 61 6e 67 65 20 74 68 65 20 74 69 6d 65 6f  change the timeo
3e40: 75 74 20 76 61 6c 75 65 20 74 6f 20 61 20 70 6f  ut value to a po
3e50: 73 69 74 69 76 65 0a 6e 75 6d 62 65 72 2e 20 20  sitive.number.  
3e60: 46 6f 72 20 65 78 61 6d 70 6c 65 3a 3c 2f 70 3e  For example:</p>
3e70: 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 62  ..<blockquote><b
3e80: 3e 64 62 31 20 74 69 6d 65 6f 75 74 20 32 30 30  >db1 timeout 200
3e90: 30 3c 2f 62 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74  0</b></blockquot
3ea0: 65 3e 0a 0a 3c 70 3e 54 68 65 20 61 72 67 75 6d  e>..<p>The argum
3eb0: 65 6e 74 20 74 6f 20 74 68 65 20 74 69 6d 65 6f  ent to the timeo
3ec0: 75 74 20 6d 65 74 68 6f 64 20 69 73 20 74 68 65  ut method is the
3ed0: 20 6d 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20   maximum number 
3ee0: 6f 66 20 6d 69 6c 6c 69 73 65 63 6f 6e 64 73 0a  of milliseconds.
3ef0: 74 6f 20 77 61 69 74 20 66 6f 72 20 74 68 65 20  to wait for the 
3f00: 6c 6f 63 6b 20 74 6f 20 63 6c 65 61 72 2e 20 20  lock to clear.  
3f10: 53 6f 20 69 6e 20 74 68 65 20 65 78 61 6d 70 6c  So in the exampl
3f20: 65 20 61 62 6f 76 65 2c 20 74 68 65 20 6d 61 78  e above, the max
3f30: 69 6d 75 6d 20 64 65 6c 61 79 0a 77 6f 75 6c 64  imum delay.would
3f40: 20 62 65 20 32 20 73 65 63 6f 6e 64 73 2e 3c 2f   be 2 seconds.</
3f50: 70 3e 0a 7d 0a 0a 23 23 23 23 23 23 23 23 23 23  p>.}..##########
3f60: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
3f70: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
3f80: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
3f90: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
3fa0: 23 23 23 23 0a 4d 45 54 48 4f 44 20 62 75 73 79  ####.METHOD busy
3fb0: 20 7b 0a 0a 3c 70 3e 54 68 65 20 22 62 75 73 79   {..<p>The "busy
3fc0: 22 20 6d 65 74 68 6f 64 2c 20 6c 69 6b 65 20 22  " method, like "
3fd0: 74 69 6d 65 6f 75 74 22 2c 20 6f 6e 6c 79 20 63  timeout", only c
3fe0: 6f 6d 65 73 20 69 6e 74 6f 20 70 6c 61 79 20 77  omes into play w
3ff0: 68 65 6e 20 74 68 65 0a 64 61 74 61 62 61 73 65  hen the.database
4000: 20 69 73 20 6c 6f 63 6b 65 64 2e 20 20 42 75 74   is locked.  But
4010: 20 74 68 65 20 22 62 75 73 79 22 20 6d 65 74 68   the "busy" meth
4020: 6f 64 20 67 69 76 65 73 20 74 68 65 20 70 72 6f  od gives the pro
4030: 67 72 61 6d 6d 65 72 20 6d 75 63 68 20 6d 6f 72  grammer much mor
4040: 65 0a 63 6f 6e 74 72 6f 6c 20 6f 76 65 72 20 77  e.control over w
4050: 68 61 74 20 61 63 74 69 6f 6e 20 74 6f 20 74 61  hat action to ta
4060: 6b 65 2e 20 20 54 68 65 20 22 62 75 73 79 22 20  ke.  The "busy" 
4070: 6d 65 74 68 6f 64 20 73 70 65 63 69 66 69 65 73  method specifies
4080: 20 61 20 63 61 6c 6c 62 61 63 6b 0a 54 63 6c 20   a callback.Tcl 
4090: 70 72 6f 63 65 64 75 72 65 20 74 68 61 74 20 69  procedure that i
40a0: 73 20 69 6e 76 6f 6b 65 64 20 77 68 65 6e 65 76  s invoked whenev
40b0: 65 72 20 53 51 4c 69 74 65 20 74 72 69 65 73 20  er SQLite tries 
40c0: 74 6f 20 6f 70 65 6e 20 61 20 6c 6f 63 6b 65 64  to open a locked
40d0: 0a 64 61 74 61 62 61 73 65 2e 20 20 41 20 73 69  .database.  A si
40e0: 6e 67 6c 65 20 69 6e 74 65 67 65 72 20 61 72 67  ngle integer arg
40f0: 75 6d 65 6e 74 20 69 73 20 61 70 70 65 6e 64 65  ument is appende
4100: 64 20 74 6f 20 74 68 65 20 63 61 6c 6c 62 61 63  d to the callbac
4110: 6b 20 62 65 66 6f 72 65 0a 69 74 20 69 73 20 69  k before.it is i
4120: 6e 76 6f 6b 65 2e 20 20 54 68 65 20 61 72 67 75  nvoke.  The argu
4130: 6d 65 6e 74 20 69 73 20 74 68 65 20 6e 75 6d 62  ment is the numb
4140: 65 72 20 6f 66 20 70 72 69 6f 72 20 63 61 6c 6c  er of prior call
4150: 73 20 74 6f 20 74 68 65 20 62 75 73 79 0a 63 61  s to the busy.ca
4160: 6c 6c 62 61 63 6b 20 66 6f 72 20 74 68 65 20 63  llback for the c
4170: 75 72 72 65 6e 74 20 6c 6f 63 6b 69 6e 67 20 65  urrent locking e
4180: 76 65 6e 74 2e 20 20 49 74 20 69 73 20 69 6e 74  vent.  It is int
4190: 65 6e 64 65 64 20 74 68 61 74 0a 74 68 65 20 63  ended that.the c
41a0: 61 6c 6c 62 61 63 6b 20 77 69 6c 6c 20 64 6f 20  allback will do 
41b0: 73 6f 6d 65 20 6f 74 68 65 72 20 75 73 65 66 75  some other usefu
41c0: 6c 20 77 6f 72 6b 20 66 6f 72 20 61 20 73 68 6f  l work for a sho
41d0: 72 74 20 77 68 69 6c 65 20 0a 28 73 75 63 68 20  rt while .(such 
41e0: 61 73 20 73 65 72 76 69 63 65 20 47 55 49 20 65  as service GUI e
41f0: 76 65 6e 74 73 29 20 74 68 65 6e 20 72 65 74 75  vents) then retu
4200: 72 6e 0a 73 6f 20 74 68 61 74 20 74 68 65 20 6c  rn.so that the l
4210: 6f 63 6b 20 63 61 6e 20 62 65 20 74 72 69 65 64  ock can be tried
4220: 20 61 67 61 69 6e 2e 20 20 54 68 65 20 63 61 6c   again.  The cal
4230: 6c 62 61 63 6b 20 70 72 6f 63 65 64 75 72 65 20  lback procedure 
4240: 73 68 6f 75 6c 64 0a 72 65 74 75 72 6e 20 22 30  should.return "0
4250: 22 20 69 66 20 69 74 20 77 61 6e 74 73 20 53 51  " if it wants SQ
4260: 4c 69 74 65 20 74 6f 20 74 72 79 20 61 67 61 69  Lite to try agai
4270: 6e 20 74 6f 20 6f 70 65 6e 20 74 68 65 20 64 61  n to open the da
4280: 74 61 62 61 73 65 20 61 6e 64 0a 73 68 6f 75 6c  tabase and.shoul
4290: 64 20 72 65 74 75 72 6e 20 22 31 22 20 69 66 20  d return "1" if 
42a0: 69 74 20 77 61 6e 74 73 20 53 51 4c 69 74 65 20  it wants SQLite 
42b0: 74 6f 20 61 62 61 6e 64 6f 6e 20 74 68 65 20 63  to abandon the c
42c0: 75 72 72 65 6e 74 20 6f 70 65 72 61 74 69 6f 6e  urrent operation
42d0: 2e 0a 7d 0a 0a 23 23 23 23 23 23 23 23 23 23 23  ..}..###########
42e0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
42f0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4300: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4310: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4320: 23 23 23 0a 4d 45 54 48 4f 44 20 65 6e 61 62 6c  ###.METHOD enabl
4330: 65 5f 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f 6e  e_load_extension
4340: 20 7b 0a 0a 3c 70 3e 54 68 65 20 65 78 74 65 6e   {..<p>The exten
4350: 73 69 6f 6e 20 6c 6f 61 64 69 6e 67 20 6d 65 63  sion loading mec
4360: 68 61 6e 69 73 6d 20 6f 66 20 53 51 4c 69 74 65  hanism of SQLite
4370: 20 28 61 63 63 65 73 73 65 64 20 75 73 69 6e 67   (accessed using
4380: 20 74 68 65 0a 5b 6c 6f 61 64 5f 65 78 74 65 6e   the.[load_exten
4390: 73 69 6f 6e 28 29 5d 20 53 51 4c 20 66 75 6e 63  sion()] SQL func
43a0: 74 69 6f 6e 29 20 69 73 20 74 75 72 6e 65 64 20  tion) is turned 
43b0: 6f 66 66 20 62 79 20 64 65 66 61 75 6c 74 2e 20  off by default. 
43c0: 20 54 68 69 73 20 69 73 0a 61 20 73 65 63 75 72   This is.a secur
43d0: 69 74 79 20 70 72 65 63 61 75 74 69 6f 6e 2e 20  ity precaution. 
43e0: 20 49 66 20 61 6e 20 61 70 70 6c 69 63 61 74 69   If an applicati
43f0: 6f 6e 20 77 61 6e 74 73 20 74 6f 20 6d 61 6b 65  on wants to make
4400: 20 75 73 65 20 6f 66 20 74 68 65 0a 5b 6c 6f 61   use of the.[loa
4410: 64 5f 65 78 74 65 6e 73 69 6f 6e 28 29 5d 20 66  d_extension()] f
4420: 75 6e 63 74 69 6f 6e 20 69 74 20 6d 75 73 74 20  unction it must 
4430: 66 69 72 73 74 20 74 75 72 6e 20 74 68 65 20 63  first turn the c
4440: 61 70 61 62 69 6c 69 74 79 20 6f 6e 20 75 73 69  apability on usi
4450: 6e 67 0a 74 68 69 73 20 6d 65 74 68 6f 64 2e 3c  ng.this method.<
4460: 2f 70 3e 0a 0a 3c 70 3e 54 68 69 73 20 6d 65 74  /p>..<p>This met
4470: 68 6f 64 20 74 61 6b 65 73 20 61 20 73 69 6e 67  hod takes a sing
4480: 6c 65 20 62 6f 6f 6c 65 61 6e 20 61 72 67 75 6d  le boolean argum
4490: 65 6e 74 20 77 68 69 63 68 20 77 69 6c 6c 20 74  ent which will t
44a0: 75 72 6e 20 74 68 65 0a 65 78 74 65 6e 73 69 6f  urn the.extensio
44b0: 6e 20 6c 6f 61 64 69 6e 67 20 66 75 6e 63 74 69  n loading functi
44c0: 6f 6e 61 6c 69 74 79 20 6f 6e 20 6f 72 20 6f 66  onality on or of
44d0: 66 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 69 73 20  f.</p>..<p>This 
44e0: 6d 65 74 68 6f 64 20 6d 61 70 73 20 74 6f 20 74  method maps to t
44f0: 68 65 20 5b 73 71 6c 69 74 65 33 5f 65 6e 61 62  he [sqlite3_enab
4500: 6c 65 5f 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f  le_load_extensio
4510: 6e 28 29 5d 20 43 2f 43 2b 2b 0a 69 6e 74 65 72  n()] C/C++.inter
4520: 66 61 63 65 2e 3c 2f 70 3e 0a 7d 0a 0a 23 23 23  face.</p>.}..###
4530: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4540: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4550: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4560: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4570: 23 23 23 23 23 23 23 23 23 23 23 0a 4d 45 54 48  ###########.METH
4580: 4f 44 20 65 78 69 73 74 73 20 7b 0a 0a 3c 70 3e  OD exists {..<p>
4590: 54 68 65 20 22 65 78 69 73 74 73 22 20 6d 65 74  The "exists" met
45a0: 68 6f 64 20 69 73 20 73 69 6d 69 6c 61 72 20 74  hod is similar t
45b0: 6f 20 22 6f 6e 65 63 6f 6c 75 6d 6e 22 20 61 6e  o "onecolumn" an
45c0: 64 20 22 65 76 61 6c 22 20 69 6e 20 74 68 61 74  d "eval" in that
45d0: 0a 69 74 20 65 78 65 63 75 74 65 73 20 53 51 4c  .it executes SQL
45e0: 20 73 74 61 74 65 6d 65 6e 74 73 2e 20 20 54 68   statements.  Th
45f0: 65 20 64 69 66 66 65 72 65 6e 63 65 20 69 73 20  e difference is 
4600: 74 68 61 74 20 74 68 65 20 22 65 78 69 73 74 73  that the "exists
4610: 22 20 6d 65 74 68 6f 64 0a 61 6c 77 61 79 73 20  " method.always 
4620: 72 65 74 75 72 6e 73 20 61 20 62 6f 6f 6c 65 61  returns a boolea
4630: 6e 20 76 61 6c 75 65 20 77 68 69 63 68 20 69 73  n value which is
4640: 20 54 52 55 45 20 69 66 20 61 20 71 75 65 72 79   TRUE if a query
4650: 20 69 6e 20 74 68 65 20 53 51 4c 0a 73 74 61 74   in the SQL.stat
4660: 65 6d 65 6e 74 20 69 74 20 65 78 65 63 75 74 65  ement it execute
4670: 73 20 72 65 74 75 72 6e 73 20 6f 6e 65 20 6f 72  s returns one or
4680: 20 6d 6f 72 65 20 72 6f 77 73 20 61 6e 64 20 46   more rows and F
4690: 41 4c 53 45 20 69 66 20 74 68 65 20 53 51 4c 0a  ALSE if the SQL.
46a0: 72 65 74 75 72 6e 73 20 61 6e 20 65 6d 70 74 79  returns an empty
46b0: 20 73 65 74 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68   set.</p>..<p>Th
46c0: 65 20 22 65 78 69 73 74 73 22 20 6d 65 74 68 6f  e "exists" metho
46d0: 64 20 69 73 20 6f 66 74 65 6e 20 75 73 65 64 20  d is often used 
46e0: 74 6f 20 74 65 73 74 20 66 6f 72 20 74 68 65 20  to test for the 
46f0: 65 78 69 73 74 65 6e 63 65 20 6f 66 0a 72 6f 77  existence of.row
4700: 73 20 69 6e 20 61 20 74 61 62 6c 65 2e 20 20 46  s in a table.  F
4710: 6f 72 20 65 78 61 6d 70 6c 65 3a 3c 2f 70 3e 0a  or example:</p>.
4720: 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 62 3e  .<blockquote><b>
4730: 0a 69 66 20 7b 26 23 39 31 3b 64 62 20 65 78 69  .if {&#91;db exi
4740: 73 74 73 20 7b 53 45 4c 45 43 54 20 31 20 46 52  sts {SELECT 1 FR
4750: 4f 4d 20 74 61 62 6c 65 31 20 57 48 45 52 45 20  OM table1 WHERE 
4760: 75 73 65 72 3d 24 75 73 65 72 7d 26 23 39 33 3b  user=$user}&#93;
4770: 7d 20 7b 3c 62 72 3e 0a 26 6e 62 73 70 3b 26 6e  } {<br>.&nbsp;&n
4780: 62 73 70 3b 26 6e 62 73 70 3b 23 20 50 72 6f 63  bsp;&nbsp;# Proc
4790: 65 73 73 69 6e 67 20 69 66 20 24 75 73 65 72 20  essing if $user 
47a0: 65 78 69 73 74 73 3c 62 72 3e 0a 7d 20 65 6c 73  exists<br>.} els
47b0: 65 20 7b 3c 62 72 3e 0a 26 6e 62 73 70 3b 26 6e  e {<br>.&nbsp;&n
47c0: 62 73 70 3b 26 6e 62 73 70 3b 23 20 50 72 6f 63  bsp;&nbsp;# Proc
47d0: 65 73 73 69 6e 67 20 69 66 20 24 75 73 65 72 20  essing if $user 
47e0: 64 6f 65 73 20 6e 6f 74 20 65 78 69 73 74 3c 62  does not exist<b
47f0: 72 3e 0a 7d 0a 3c 2f 62 3e 3c 2f 62 6c 6f 63 6b  r>.}.</b></block
4800: 71 75 6f 74 65 3e 0a 7d 0a 0a 0a 23 23 23 23 23  quote>.}...#####
4810: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4820: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4830: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4840: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4850: 23 23 23 23 23 23 23 23 23 0a 4d 45 54 48 4f 44  #########.METHOD
4860: 20 6c 61 73 74 5f 69 6e 73 65 72 74 5f 72 6f 77   last_insert_row
4870: 69 64 20 7b 0a 0a 3c 70 3e 54 68 65 20 22 6c 61  id {..<p>The "la
4880: 73 74 5f 69 6e 73 65 72 74 5f 72 6f 77 69 64 22  st_insert_rowid"
4890: 20 6d 65 74 68 6f 64 20 72 65 74 75 72 6e 73 20   method returns 
48a0: 61 6e 20 69 6e 74 65 67 65 72 20 77 68 69 63 68  an integer which
48b0: 20 69 73 20 74 68 65 20 52 4f 57 49 44 0a 6f 66   is the ROWID.of
48c0: 20 74 68 65 20 6d 6f 73 74 20 72 65 63 65 6e 74   the most recent
48d0: 6c 79 20 69 6e 73 65 72 74 65 64 20 64 61 74 61  ly inserted data
48e0: 62 61 73 65 20 72 6f 77 2e 3c 2f 70 3e 0a 7d 0a  base row.</p>.}.
48f0: 0a 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  .###############
4900: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4910: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4920: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4930: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 0a  ###############.
4940: 4d 45 54 48 4f 44 20 66 75 6e 63 74 69 6f 6e 20  METHOD function 
4950: 7b 0a 0a 3c 70 3e 54 68 65 20 22 66 75 6e 63 74  {..<p>The "funct
4960: 69 6f 6e 22 20 6d 65 74 68 6f 64 20 72 65 67 69  ion" method regi
4970: 73 74 65 72 73 20 6e 65 77 20 53 51 4c 20 66 75  sters new SQL fu
4980: 6e 63 74 69 6f 6e 73 20 77 69 74 68 20 74 68 65  nctions with the
4990: 20 53 51 4c 69 74 65 20 65 6e 67 69 6e 65 2e 0a   SQLite engine..
49a0: 54 68 65 20 61 72 67 75 6d 65 6e 74 73 20 61 72  The arguments ar
49b0: 65 20 74 68 65 20 6e 61 6d 65 20 6f 66 20 74 68  e the name of th
49c0: 65 20 6e 65 77 20 53 51 4c 20 66 75 6e 63 74 69  e new SQL functi
49d0: 6f 6e 20 61 6e 64 20 61 20 54 43 4c 20 63 6f 6d  on and a TCL com
49e0: 6d 61 6e 64 20 74 68 61 74 0a 69 6d 70 6c 65 6d  mand that.implem
49f0: 65 6e 74 73 20 74 68 61 74 20 66 75 6e 63 74 69  ents that functi
4a00: 6f 6e 2e 20 20 41 72 67 75 6d 65 6e 74 73 20 74  on.  Arguments t
4a10: 6f 20 74 68 65 20 66 75 6e 63 74 69 6f 6e 20 61  o the function a
4a20: 72 65 20 61 70 70 65 6e 64 65 64 20 74 6f 20 74  re appended to t
4a30: 68 65 0a 54 43 4c 20 63 6f 6d 6d 61 6e 64 20 62  he.TCL command b
4a40: 65 66 6f 72 65 20 69 74 20 69 73 20 69 6e 76 6f  efore it is invo
4a50: 6b 65 64 2e 3c 2f 70 3e 0a 0a 3c 70 3e 0a 54 68  ked.</p>..<p>.Th
4a60: 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 65 78 61 6d  e following exam
4a70: 70 6c 65 20 63 72 65 61 74 65 73 20 61 20 6e 65  ple creates a ne
4a80: 77 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 6e  w SQL function n
4a90: 61 6d 65 64 20 22 68 65 78 22 20 74 68 61 74 20  amed "hex" that 
4aa0: 63 6f 6e 76 65 72 74 73 0a 69 74 73 20 6e 75 6d  converts.its num
4ab0: 65 72 69 63 20 61 72 67 75 6d 65 6e 74 20 69 6e  eric argument in
4ac0: 20 74 6f 20 61 20 68 65 78 61 64 65 63 69 6d 61   to a hexadecima
4ad0: 6c 20 65 6e 63 6f 64 65 64 20 73 74 72 69 6e 67  l encoded string
4ae0: 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75  :.</p>..<blockqu
4af0: 6f 74 65 3e 3c 62 3e 0a 64 62 20 66 75 6e 63 74  ote><b>.db funct
4b00: 69 6f 6e 20 68 65 78 20 7b 66 6f 72 6d 61 74 20  ion hex {format 
4b10: 30 78 25 58 7d 0a 3c 2f 62 3e 3c 2f 62 6c 6f 63  0x%X}.</b></bloc
4b20: 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 54 68 65 20  kquote>..<p>The 
4b30: 22 66 75 6e 63 74 69 6f 6e 22 20 6d 65 74 68 6f  "function" metho
4b40: 64 20 61 63 63 65 70 74 73 20 74 68 65 20 66 6f  d accepts the fo
4b50: 6c 6c 6f 77 69 6e 67 20 6f 70 74 69 6f 6e 73 3a  llowing options:
4b60: 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c 64  .<blockquote>.<d
4b70: 6c 3e 0a 0a 3c 64 74 3e 3c 62 3e 2d 61 72 67 63  l>..<dt><b>-argc
4b80: 6f 75 6e 74 3c 2f 62 3e 20 3c 69 3e 49 4e 54 45  ount</b> <i>INTE
4b90: 47 45 52 3c 2f 69 3e 3c 2f 64 74 3e 0a 3c 64 64  GER</i></dt>.<dd
4ba0: 3e 3c 70 3e 0a 53 70 65 63 69 66 79 20 74 68 65  ><p>.Specify the
4bb0: 20 6e 75 6d 62 65 72 20 6f 66 20 61 72 67 75 6d   number of argum
4bc0: 65 6e 74 73 20 74 68 61 74 20 74 68 65 20 53 51  ents that the SQ
4bd0: 4c 20 66 75 6e 63 74 69 6f 6e 20 61 63 63 65 70  L function accep
4be0: 74 73 2e 20 20 54 68 65 20 64 65 66 61 75 6c 74  ts.  The default
4bf0: 0a 76 61 6c 75 65 20 6f 66 20 2d 31 20 6d 65 61  .value of -1 mea
4c00: 6e 73 20 61 6e 79 20 6e 75 6d 62 65 72 20 6f 66  ns any number of
4c10: 20 61 72 67 75 6d 65 6e 74 73 2e 0a 0a 3c 64 74   arguments...<dt
4c20: 3e 3c 62 3e 2d 64 65 74 65 72 6d 69 6e 69 73 74  ><b>-determinist
4c30: 69 63 3c 2f 62 3e 0a 3c 64 64 3e 3c 70 3e 0a 54  ic</b>.<dd><p>.T
4c40: 68 69 73 20 6f 70 74 69 6f 6e 20 69 6e 64 69 63  his option indic
4c50: 61 74 65 73 20 74 68 61 74 20 74 68 65 20 66 75  ates that the fu
4c60: 6e 63 74 69 6f 6e 20 77 69 6c 6c 20 61 6c 77 61  nction will alwa
4c70: 79 73 20 72 65 74 75 72 6e 20 74 68 65 20 73 61  ys return the sa
4c80: 6d 65 0a 61 6e 73 77 65 72 20 67 69 76 65 6e 20  me.answer given 
4c90: 74 68 65 20 73 61 6d 65 20 61 72 67 75 6d 65 6e  the same argumen
4ca0: 74 20 76 61 6c 75 65 73 2e 20 20 54 68 65 20 53  t values.  The S
4cb0: 51 4c 69 74 65 20 71 75 65 72 79 20 6f 70 74 69  QLite query opti
4cc0: 6d 69 7a 65 72 0a 75 73 65 73 20 74 68 69 73 20  mizer.uses this 
4cd0: 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 74 6f 20 63  information to c
4ce0: 61 63 68 65 20 61 6e 73 77 65 72 73 20 66 72 6f  ache answers fro
4cf0: 6d 20 66 75 6e 63 74 69 6f 6e 20 63 61 6c 6c 73  m function calls
4d00: 20 77 69 74 68 20 0a 63 6f 6e 73 74 61 6e 74 20   with .constant 
4d10: 69 6e 70 75 74 73 20 61 6e 64 20 72 65 75 73 65  inputs and reuse
4d20: 20 74 68 65 20 72 65 73 75 6c 74 20 72 61 74 68   the result rath
4d30: 65 72 20 74 68 61 6e 20 69 6e 76 6f 6b 65 20 74  er than invoke t
4d40: 68 65 20 66 75 6e 63 74 69 6f 6e 0a 72 65 70 65  he function.repe
4d50: 61 74 65 64 6c 79 2e 0a 3c 2f 64 6c 3e 0a 3c 2f  atedly..</dl>.</
4d60: 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 7d 0a 0a 23  blockquote>.}..#
4d70: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4d80: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4d90: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4da0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4db0: 23 23 23 23 23 23 23 23 23 23 23 23 23 0a 4d 45  #############.ME
4dc0: 54 48 4f 44 20 6e 75 6c 6c 76 61 6c 75 65 20 7b  THOD nullvalue {
4dd0: 0a 0a 3c 70 3e 0a 54 68 65 20 22 6e 75 6c 6c 76  ..<p>.The "nullv
4de0: 61 6c 75 65 22 20 6d 65 74 68 6f 64 20 63 68 61  alue" method cha
4df0: 6e 67 65 73 20 74 68 65 20 72 65 70 72 65 73 65  nges the represe
4e00: 6e 74 61 74 69 6f 6e 20 66 6f 72 20 4e 55 4c 4c  ntation for NULL
4e10: 20 72 65 74 75 72 6e 65 64 0a 61 73 20 72 65 73   returned.as res
4e20: 75 6c 74 20 6f 66 20 74 68 65 20 22 65 76 61 6c  ult of the "eval
4e30: 22 20 6d 65 74 68 6f 64 2e 3c 2f 70 3e 0a 0a 3c  " method.</p>..<
4e40: 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 62 3e 0a 64  blockquote><b>.d
4e50: 62 31 20 6e 75 6c 6c 76 61 6c 75 65 20 4e 55 4c  b1 nullvalue NUL
4e60: 4c 0a 3c 2f 62 3e 3c 2f 62 6c 6f 63 6b 71 75 6f  L.</b></blockquo
4e70: 74 65 3e 0a 0a 3c 70 3e 54 68 65 20 22 6e 75 6c  te>..<p>The "nul
4e80: 6c 76 61 6c 75 65 22 20 6d 65 74 68 6f 64 20 69  lvalue" method i
4e90: 73 20 75 73 65 66 75 6c 20 74 6f 20 64 69 66 66  s useful to diff
4ea0: 65 72 20 62 65 74 77 65 65 6e 20 4e 55 4c 4c 20  er between NULL 
4eb0: 61 6e 64 20 65 6d 70 74 79 0a 63 6f 6c 75 6d 6e  and empty.column
4ec0: 20 76 61 6c 75 65 73 20 61 73 20 54 63 6c 20 6c   values as Tcl l
4ed0: 61 63 6b 73 20 61 20 4e 55 4c 4c 20 72 65 70 72  acks a NULL repr
4ee0: 65 73 65 6e 74 61 74 69 6f 6e 2e 20 20 54 68 65  esentation.  The
4ef0: 20 64 65 66 61 75 6c 74 0a 72 65 70 72 65 73 65   default.represe
4f00: 6e 74 61 74 69 6f 6e 20 66 6f 72 20 4e 55 4c 4c  ntation for NULL
4f10: 20 76 61 6c 75 65 73 20 69 73 20 61 6e 20 65 6d   values is an em
4f20: 70 74 79 20 73 74 72 69 6e 67 2e 3c 2f 70 3e 0a  pty string.</p>.
4f30: 7d 0a 0a 0a 0a 23 23 23 23 23 23 23 23 23 23 23  }....###########
4f40: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4f50: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4f60: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4f70: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
4f80: 23 23 23 0a 4d 45 54 48 4f 44 20 6f 6e 65 63 6f  ###.METHOD oneco
4f90: 6c 75 6d 6e 20 7b 0a 0a 3c 70 3e 54 68 65 20 22  lumn {..<p>The "
4fa0: 6f 6e 65 63 6f 6c 75 6d 6e 22 20 6d 65 74 68 6f  onecolumn" metho
4fb0: 64 20 77 6f 72 6b 73 20 6c 69 6b 65 20 0a 22 3c  d works like ."<
4fc0: 61 20 68 72 65 66 3d 22 23 65 76 61 6c 22 3e 65  a href="#eval">e
4fd0: 76 61 6c 3c 2f 61 3e 22 20 69 6e 20 74 68 61 74  val</a>" in that
4fe0: 20 69 74 20 65 76 61 6c 75 61 74 65 73 20 74 68   it evaluates th
4ff0: 65 0a 53 51 4c 20 71 75 65 72 79 20 73 74 61 74  e.SQL query stat
5000: 65 6d 65 6e 74 20 67 69 76 65 6e 20 61 73 20 69  ement given as i
5010: 74 73 20 61 72 67 75 6d 65 6e 74 2e 20 20 54 68  ts argument.  Th
5020: 65 20 64 69 66 66 65 72 65 6e 63 65 20 69 73 20  e difference is 
5030: 74 68 61 74 0a 22 6f 6e 65 63 6f 6c 75 6d 6e 22  that."onecolumn"
5040: 20 72 65 74 75 72 6e 73 20 61 20 73 69 6e 67 6c   returns a singl
5050: 65 20 65 6c 65 6d 65 6e 74 20 77 68 69 63 68 20  e element which 
5060: 69 73 20 74 68 65 20 66 69 72 73 74 20 63 6f 6c  is the first col
5070: 75 6d 6e 20 6f 66 20 74 68 65 0a 66 69 72 73 74  umn of the.first
5080: 20 72 6f 77 20 6f 66 20 74 68 65 20 71 75 65 72   row of the quer
5090: 79 20 72 65 73 75 6c 74 2e 3c 2f 70 3e 0a 0a 3c  y result.</p>..<
50a0: 70 3e 54 68 69 73 20 69 73 20 61 20 63 6f 6e 76  p>This is a conv
50b0: 65 6e 69 65 6e 63 65 20 6d 65 74 68 6f 64 2e 20  enience method. 
50c0: 20 49 74 20 73 61 76 65 73 20 74 68 65 20 75 73   It saves the us
50d0: 65 72 20 66 72 6f 6d 20 68 61 76 69 6e 67 20 74  er from having t
50e0: 6f 0a 64 6f 20 61 20 22 3c 74 74 3e 26 23 39 31  o.do a "<tt>&#91
50f0: 3b 6c 69 6e 64 65 78 26 6e 62 73 70 3b 2e 2e 2e  ;lindex&nbsp;...
5100: 26 6e 62 73 70 3b 30 26 23 39 33 3b 3c 2f 74 74  &nbsp;0&#93;</tt
5110: 3e 22 20 6f 6e 20 74 68 65 20 72 65 73 75 6c 74  >" on the result
5120: 73 20 6f 66 20 61 6e 20 22 65 76 61 6c 22 0a 69  s of an "eval".i
5130: 6e 20 6f 72 64 65 72 20 74 6f 20 65 78 74 72 61  n order to extra
5140: 63 74 20 61 20 73 69 6e 67 6c 65 20 63 6f 6c 75  ct a single colu
5150: 6d 6e 20 72 65 73 75 6c 74 2e 3c 2f 70 3e 0a 7d  mn result.</p>.}
5160: 0a 0a 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ..##############
5170: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5180: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5190: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
51a0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
51b0: 0a 4d 45 54 48 4f 44 20 63 68 61 6e 67 65 73 20  .METHOD changes 
51c0: 7b 0a 0a 3c 70 3e 54 68 65 20 22 63 68 61 6e 67  {..<p>The "chang
51d0: 65 73 22 20 6d 65 74 68 6f 64 20 72 65 74 75 72  es" method retur
51e0: 6e 73 20 61 6e 20 69 6e 74 65 67 65 72 20 77 68  ns an integer wh
51f0: 69 63 68 20 69 73 20 74 68 65 20 6e 75 6d 62 65  ich is the numbe
5200: 72 20 6f 66 20 72 6f 77 73 0a 69 6e 20 74 68 65  r of rows.in the
5210: 20 64 61 74 61 62 61 73 65 20 74 68 61 74 20 77   database that w
5220: 65 72 65 20 69 6e 73 65 72 74 65 64 2c 20 64 65  ere inserted, de
5230: 6c 65 74 65 64 2c 20 61 6e 64 2f 6f 72 20 6d 6f  leted, and/or mo
5240: 64 69 66 69 65 64 20 62 79 20 74 68 65 20 6d 6f  dified by the mo
5250: 73 74 0a 72 65 63 65 6e 74 20 22 65 76 61 6c 22  st.recent "eval"
5260: 20 6d 65 74 68 6f 64 2e 3c 2f 70 3e 0a 7d 0a 0a   method.</p>.}..
5270: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5280: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5290: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
52a0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
52b0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 0a 4d  ##############.M
52c0: 45 54 48 4f 44 20 74 6f 74 61 6c 5f 63 68 61 6e  ETHOD total_chan
52d0: 67 65 73 20 7b 0a 0a 3c 70 3e 54 68 65 20 22 74  ges {..<p>The "t
52e0: 6f 74 61 6c 5f 63 68 61 6e 67 65 73 22 20 6d 65  otal_changes" me
52f0: 74 68 6f 64 20 72 65 74 75 72 6e 73 20 61 6e 20  thod returns an 
5300: 69 6e 74 65 67 65 72 20 77 68 69 63 68 20 69 73  integer which is
5310: 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 72   the number of r
5320: 6f 77 73 0a 69 6e 20 74 68 65 20 64 61 74 61 62  ows.in the datab
5330: 61 73 65 20 74 68 61 74 20 77 65 72 65 20 69 6e  ase that were in
5340: 73 65 72 74 65 64 2c 20 64 65 6c 65 74 65 64 2c  serted, deleted,
5350: 20 61 6e 64 2f 6f 72 20 6d 6f 64 69 66 69 65 64   and/or modified
5360: 20 73 69 6e 63 65 20 74 68 65 0a 63 75 72 72 65   since the.curre
5370: 6e 74 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  nt database conn
5380: 65 63 74 69 6f 6e 20 77 61 73 20 66 69 72 73 74  ection was first
5390: 20 6f 70 65 6e 65 64 2e 3c 2f 70 3e 0a 7d 0a 0a   opened.</p>.}..
53a0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
53b0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
53c0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
53d0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
53e0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 0a 4d  ##############.M
53f0: 45 54 48 4f 44 20 61 75 74 68 6f 72 69 7a 65 72  ETHOD authorizer
5400: 20 7b 0a 0a 3c 70 3e 54 68 65 20 22 61 75 74 68   {..<p>The "auth
5410: 6f 72 69 7a 65 72 22 20 6d 65 74 68 6f 64 20 70  orizer" method p
5420: 72 6f 76 69 64 65 73 20 61 63 63 65 73 73 20 74  rovides access t
5430: 6f 20 74 68 65 20 0a 3c 61 20 68 72 65 66 3d 22  o the .<a href="
5440: 63 33 72 65 66 2f 73 65 74 5f 61 75 74 68 6f 72  c3ref/set_author
5450: 69 7a 65 72 2e 68 74 6d 6c 22 3e 73 71 6c 69 74  izer.html">sqlit
5460: 65 33 5f 73 65 74 5f 61 75 74 68 6f 72 69 7a 65  e3_set_authorize
5470: 72 3c 2f 61 3e 0a 43 2f 43 2b 2b 20 69 6e 74 65  r</a>.C/C++ inte
5480: 72 66 61 63 65 2e 20 20 54 68 65 20 61 72 67 75  rface.  The argu
5490: 6d 65 6e 74 20 74 6f 20 61 75 74 68 6f 72 69 7a  ment to authoriz
54a0: 65 72 20 69 73 20 74 68 65 20 6e 61 6d 65 20 6f  er is the name o
54b0: 66 20 61 20 70 72 6f 63 65 64 75 72 65 20 74 68  f a procedure th
54c0: 61 74 0a 69 73 20 63 61 6c 6c 65 64 20 77 68 65  at.is called whe
54d0: 6e 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73  n SQL statements
54e0: 20 61 72 65 20 62 65 69 6e 67 20 63 6f 6d 70 69   are being compi
54f0: 6c 65 64 20 69 6e 20 6f 72 64 65 72 20 74 6f 20  led in order to 
5500: 61 75 74 68 6f 72 69 7a 65 0a 63 65 72 74 61 69  authorize.certai
5510: 6e 20 6f 70 65 72 61 74 69 6f 6e 73 2e 20 20 54  n operations.  T
5520: 68 65 20 63 61 6c 6c 62 61 63 6b 20 70 72 6f 63  he callback proc
5530: 65 64 75 72 65 20 74 61 6b 65 73 20 35 20 61 72  edure takes 5 ar
5540: 67 75 6d 65 6e 74 73 20 77 68 69 63 68 20 64 65  guments which de
5550: 73 63 72 69 62 65 0a 74 68 65 20 6f 70 65 72 61  scribe.the opera
5560: 74 69 6f 6e 20 62 65 69 6e 67 20 63 6f 64 65 64  tion being coded
5570: 2e 20 20 49 66 20 74 68 65 20 63 61 6c 6c 62 61  .  If the callba
5580: 63 6b 20 72 65 74 75 72 6e 73 20 74 68 65 20 74  ck returns the t
5590: 65 78 74 20 73 74 72 69 6e 67 0a 22 53 51 4c 49  ext string."SQLI
55a0: 54 45 5f 4f 4b 22 2c 20 74 68 65 6e 20 74 68 65  TE_OK", then the
55b0: 20 6f 70 65 72 61 74 69 6f 6e 20 69 73 20 61 6c   operation is al
55c0: 6c 6f 77 65 64 2e 20 20 49 66 20 69 74 20 72 65  lowed.  If it re
55d0: 74 75 72 6e 73 20 22 53 51 4c 49 54 45 5f 49 47  turns "SQLITE_IG
55e0: 4e 4f 52 45 22 2c 0a 74 68 65 6e 20 74 68 65 20  NORE",.then the 
55f0: 6f 70 65 72 61 74 69 6f 6e 20 69 73 20 73 69 6c  operation is sil
5600: 65 6e 74 6c 79 20 64 69 73 61 62 6c 65 64 2e 20  ently disabled. 
5610: 20 49 66 20 74 68 65 20 72 65 74 75 72 6e 20 69   If the return i
5620: 73 20 22 53 51 4c 49 54 45 5f 44 45 4e 59 22 0a  s "SQLITE_DENY".
5630: 74 68 65 6e 20 74 68 65 20 63 6f 6d 70 69 6c 61  then the compila
5640: 74 69 6f 6e 20 66 61 69 6c 73 20 77 69 74 68 20  tion fails with 
5650: 61 6e 20 65 72 72 6f 72 2e 0a 3c 2f 70 3e 0a 0a  an error..</p>..
5660: 3c 70 3e 49 66 20 74 68 65 20 61 72 67 75 6d 65  <p>If the argume
5670: 6e 74 20 69 73 20 61 6e 20 65 6d 70 74 79 20 73  nt is an empty s
5680: 74 72 69 6e 67 20 74 68 65 6e 20 74 68 65 20 61  tring then the a
5690: 75 74 68 6f 72 69 7a 65 72 20 69 73 20 64 69 73  uthorizer is dis
56a0: 61 62 6c 65 64 2e 0a 49 66 20 74 68 65 20 61 72  abled..If the ar
56b0: 67 75 6d 65 6e 74 20 69 73 20 6f 6d 69 74 74 65  gument is omitte
56c0: 64 2c 20 74 68 65 6e 20 74 68 65 20 63 75 72 72  d, then the curr
56d0: 65 6e 74 20 61 75 74 68 6f 72 69 7a 65 72 20 69  ent authorizer i
56e0: 73 20 72 65 74 75 72 6e 65 64 2e 3c 2f 70 3e 0a  s returned.</p>.
56f0: 7d 0a 0a 23 23 23 23 23 23 23 23 23 23 23 23 23  }..#############
5700: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5710: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5720: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5730: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5740: 23 0a 4d 45 54 48 4f 44 20 70 72 6f 67 72 65 73  #.METHOD progres
5750: 73 20 7b 0a 0a 3c 70 3e 54 68 69 73 20 6d 65 74  s {..<p>This met
5760: 68 6f 64 20 72 65 67 69 73 74 65 72 73 20 61 20  hod registers a 
5770: 63 61 6c 6c 62 61 63 6b 20 74 68 61 74 20 69 73  callback that is
5780: 20 69 6e 76 6f 6b 65 64 20 70 65 72 69 6f 64 69   invoked periodi
5790: 63 61 6c 6c 79 20 64 75 72 69 6e 67 0a 71 75 65  cally during.que
57a0: 72 79 20 70 72 6f 63 65 73 73 69 6e 67 2e 20 20  ry processing.  
57b0: 54 68 65 72 65 20 61 72 65 20 74 77 6f 20 61 72  There are two ar
57c0: 67 75 6d 65 6e 74 73 3a 20 74 68 65 20 6e 75 6d  guments: the num
57d0: 62 65 72 20 6f 66 20 53 51 4c 69 74 65 20 76 69  ber of SQLite vi
57e0: 72 74 75 61 6c 0a 6d 61 63 68 69 6e 65 20 6f 70  rtual.machine op
57f0: 63 6f 64 65 73 20 62 65 74 77 65 65 6e 20 69 6e  codes between in
5800: 76 6f 63 61 74 69 6f 6e 73 2c 20 61 6e 64 20 74  vocations, and t
5810: 68 65 20 54 43 4c 20 63 6f 6d 6d 61 6e 64 20 74  he TCL command t
5820: 6f 20 69 6e 76 6f 6b 65 2e 0a 53 65 74 74 69 6e  o invoke..Settin
5830: 67 20 74 68 65 20 70 72 6f 67 72 65 73 73 20 63  g the progress c
5840: 61 6c 6c 62 61 63 6b 20 74 6f 20 61 6e 20 65 6d  allback to an em
5850: 70 74 79 20 73 74 72 69 6e 67 20 64 69 73 61 62  pty string disab
5860: 6c 65 73 20 69 74 2e 3c 2f 70 3e 0a 0a 3c 70 3e  les it.</p>..<p>
5870: 54 68 65 20 70 72 6f 67 72 65 73 73 20 63 61 6c  The progress cal
5880: 6c 62 61 63 6b 20 63 61 6e 20 62 65 20 75 73 65  lback can be use
5890: 64 20 74 6f 20 64 69 73 70 6c 61 79 20 74 68 65  d to display the
58a0: 20 73 74 61 74 75 73 20 6f 66 20 61 20 6c 65 6e   status of a len
58b0: 67 74 68 79 0a 71 75 65 72 79 20 6f 72 20 74 6f  gthy.query or to
58c0: 20 70 72 6f 63 65 73 73 20 47 55 49 20 65 76 65   process GUI eve
58d0: 6e 74 73 20 64 75 72 69 6e 67 20 61 20 6c 65 6e  nts during a len
58e0: 67 74 68 79 20 71 75 65 72 79 2e 3c 2f 70 3e 0a  gthy query.</p>.
58f0: 7d 0a 0a 0a 23 23 23 23 23 23 23 23 23 23 23 23  }...############
5900: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5910: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5920: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5930: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5940: 23 23 0a 4d 45 54 48 4f 44 20 63 6f 6c 6c 61 74  ##.METHOD collat
5950: 65 20 7b 0a 0a 3c 70 3e 54 68 69 73 20 6d 65 74  e {..<p>This met
5960: 68 6f 64 20 72 65 67 69 73 74 65 72 73 20 6e 65  hod registers ne
5970: 77 20 74 65 78 74 20 63 6f 6c 6c 61 74 69 6e 67  w text collating
5980: 20 73 65 71 75 65 6e 63 65 73 2e 20 20 54 68 65   sequences.  The
5990: 72 65 20 61 72 65 0a 74 77 6f 20 61 72 67 75 6d  re are.two argum
59a0: 65 6e 74 73 3a 20 74 68 65 20 6e 61 6d 65 20 6f  ents: the name o
59b0: 66 20 74 68 65 20 63 6f 6c 6c 61 74 69 6e 67 20  f the collating 
59c0: 73 65 71 75 65 6e 63 65 20 61 6e 64 20 74 68 65  sequence and the
59d0: 20 6e 61 6d 65 20 6f 66 20 61 0a 54 43 4c 20 70   name of a.TCL p
59e0: 72 6f 63 65 64 75 72 65 20 74 68 61 74 20 69 6d  rocedure that im
59f0: 70 6c 65 6d 65 6e 74 73 20 61 20 63 6f 6d 70 61  plements a compa
5a00: 72 69 73 6f 6e 20 66 75 6e 63 74 69 6f 6e 20 66  rison function f
5a10: 6f 72 20 74 68 65 20 63 6f 6c 6c 61 74 69 6e 67  or the collating
5a20: 0a 73 65 71 75 65 6e 63 65 2e 0a 3c 2f 70 3e 0a  .sequence..</p>.
5a30: 0a 3c 70 3e 46 6f 72 20 65 78 61 6d 70 6c 65 2c  .<p>For example,
5a40: 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 63   the following c
5a50: 6f 64 65 20 69 6d 70 6c 65 6d 65 6e 74 73 20 61  ode implements a
5a60: 20 63 6f 6c 6c 61 74 69 6e 67 20 73 65 71 75 65   collating seque
5a70: 6e 63 65 20 63 61 6c 6c 65 64 0a 22 4e 4f 43 41  nce called."NOCA
5a80: 53 45 22 20 74 68 61 74 20 73 6f 72 74 73 20 69  SE" that sorts i
5a90: 6e 20 74 65 78 74 20 6f 72 64 65 72 20 77 69 74  n text order wit
5aa0: 68 6f 75 74 20 72 65 67 61 72 64 20 74 6f 20 63  hout regard to c
5ab0: 61 73 65 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63  ase:.</p>..<bloc
5ac0: 6b 71 75 6f 74 65 3e 3c 62 3e 0a 70 72 6f 63 20  kquote><b>.proc 
5ad0: 6e 6f 63 61 73 65 5f 63 6f 6d 70 61 72 65 20 7b  nocase_compare {
5ae0: 61 20 62 7d 20 7b 3c 62 72 3e 0a 26 6e 62 73 70  a b} {<br>.&nbsp
5af0: 3b 26 6e 62 73 70 3b 26 6e 62 73 70 3b 26 6e 62  ;&nbsp;&nbsp;&nb
5b00: 73 70 3b 72 65 74 75 72 6e 20 26 23 39 31 3b 73  sp;return &#91;s
5b10: 74 72 69 6e 67 20 63 6f 6d 70 61 72 65 20 26 23  tring compare &#
5b20: 39 31 3b 73 74 72 69 6e 67 20 74 6f 6c 6f 77 65  91;string tolowe
5b30: 72 20 24 61 26 23 39 33 3b 20 26 23 39 31 3b 73  r $a&#93; &#91;s
5b40: 74 72 69 6e 67 20 74 6f 6c 6f 77 65 72 20 24 62  tring tolower $b
5b50: 26 23 39 33 3b 26 23 39 33 3b 3c 62 72 3e 0a 7d  &#93;&#93;<br>.}
5b60: 3c 62 72 3e 0a 64 62 20 63 6f 6c 6c 61 74 65 20  <br>.db collate 
5b70: 4e 4f 43 41 53 45 20 6e 6f 63 61 73 65 5f 63 6f  NOCASE nocase_co
5b80: 6d 70 61 72 65 3c 62 72 3e 0a 3c 2f 62 3e 3c 2f  mpare<br>.</b></
5b90: 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 7d 0a 0a 23  blockquote>.}..#
5ba0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5bb0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5bc0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5bd0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5be0: 23 23 23 23 23 23 23 23 23 23 23 23 23 0a 4d 45  #############.ME
5bf0: 54 48 4f 44 20 63 6f 6c 6c 61 74 69 6f 6e 5f 6e  THOD collation_n
5c00: 65 65 64 65 64 20 7b 0a 0a 3c 70 3e 54 68 69 73  eeded {..<p>This
5c10: 20 6d 65 74 68 6f 64 20 72 65 67 69 73 74 65 72   method register
5c20: 73 20 61 20 63 61 6c 6c 62 61 63 6b 20 72 6f 75  s a callback rou
5c30: 74 69 6e 65 20 74 68 61 74 20 69 73 20 69 6e 76  tine that is inv
5c40: 6f 6b 65 64 20 77 68 65 6e 20 74 68 65 20 53 51  oked when the SQ
5c50: 4c 69 74 65 0a 65 6e 67 69 6e 65 20 6e 65 65 64  Lite.engine need
5c60: 73 20 61 20 70 61 72 74 69 63 75 6c 61 72 20 63  s a particular c
5c70: 6f 6c 6c 61 74 69 6e 67 20 73 65 71 75 65 6e 63  ollating sequenc
5c80: 65 20 62 75 74 20 64 6f 65 73 20 6e 6f 74 20 68  e but does not h
5c90: 61 76 65 20 74 68 61 74 0a 63 6f 6c 6c 61 74 69  ave that.collati
5ca0: 6e 67 20 73 65 71 75 65 6e 63 65 20 72 65 67 69  ng sequence regi
5cb0: 73 74 65 72 65 64 2e 20 20 54 68 65 20 63 61 6c  stered.  The cal
5cc0: 6c 62 61 63 6b 20 63 61 6e 20 72 65 67 69 73 74  lback can regist
5cd0: 65 72 20 74 68 65 20 63 6f 6c 6c 61 74 69 6e 67  er the collating
5ce0: 0a 73 65 71 75 65 6e 63 65 2e 20 20 54 68 65 20  .sequence.  The 
5cf0: 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f  callback is invo
5d00: 6b 65 64 20 77 69 74 68 20 61 20 73 69 6e 67 6c  ked with a singl
5d10: 65 20 70 61 72 61 6d 65 74 65 72 20 77 68 69 63  e parameter whic
5d20: 68 20 69 73 20 74 68 65 0a 6e 61 6d 65 20 6f 66  h is the.name of
5d30: 20 74 68 65 20 6e 65 65 64 65 64 20 63 6f 6c 6c   the needed coll
5d40: 61 74 69 6e 67 20 73 65 71 75 65 6e 63 65 2e 3c  ating sequence.<
5d50: 2f 70 3e 0a 7d 0a 0a 23 23 23 23 23 23 23 23 23  /p>.}..#########
5d60: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5d70: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5d80: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5d90: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5da0: 23 23 23 23 23 0a 4d 45 54 48 4f 44 20 63 6f 6d  #####.METHOD com
5db0: 6d 69 74 5f 68 6f 6f 6b 20 7b 0a 0a 3c 70 3e 54  mit_hook {..<p>T
5dc0: 68 69 73 20 6d 65 74 68 6f 64 20 72 65 67 69 73  his method regis
5dd0: 74 65 72 73 20 61 20 63 61 6c 6c 62 61 63 6b 20  ters a callback 
5de0: 72 6f 75 74 69 6e 65 20 74 68 61 74 20 69 73 20  routine that is 
5df0: 69 6e 76 6f 6b 65 64 20 6a 75 73 74 20 62 65 66  invoked just bef
5e00: 6f 72 65 0a 53 51 4c 69 74 65 20 74 72 69 65 73  ore.SQLite tries
5e10: 20 74 6f 20 63 6f 6d 6d 69 74 20 63 68 61 6e 67   to commit chang
5e20: 65 73 20 74 6f 20 61 20 64 61 74 61 62 61 73 65  es to a database
5e30: 2e 20 20 49 66 20 74 68 65 20 63 61 6c 6c 62 61  .  If the callba
5e40: 63 6b 20 74 68 72 6f 77 73 0a 61 6e 20 65 78 63  ck throws.an exc
5e50: 65 70 74 69 6f 6e 20 6f 72 20 72 65 74 75 72 6e  eption or return
5e60: 73 20 61 20 6e 6f 6e 2d 7a 65 72 6f 20 72 65 73  s a non-zero res
5e70: 75 6c 74 2c 20 74 68 65 6e 20 74 68 65 20 74 72  ult, then the tr
5e80: 61 6e 73 61 63 74 69 6f 6e 20 72 6f 6c 6c 73 20  ansaction rolls 
5e90: 62 61 63 6b 0a 72 61 74 68 65 72 20 74 68 61 6e  back.rather than
5ea0: 20 63 6f 6d 6d 69 74 2e 3c 2f 70 3e 0a 7d 0a 0a   commit.</p>.}..
5eb0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5ec0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5ed0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5ee0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5ef0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 0a 4d  ##############.M
5f00: 45 54 48 4f 44 20 72 6f 6c 6c 62 61 63 6b 5f 68  ETHOD rollback_h
5f10: 6f 6f 6b 20 7b 0a 0a 3c 70 3e 54 68 69 73 20 6d  ook {..<p>This m
5f20: 65 74 68 6f 64 20 72 65 67 69 73 74 65 72 73 20  ethod registers 
5f30: 61 20 63 61 6c 6c 62 61 63 6b 20 72 6f 75 74 69  a callback routi
5f40: 6e 65 20 74 68 61 74 20 69 73 20 69 6e 76 6f 6b  ne that is invok
5f50: 65 64 20 6a 75 73 74 20 62 65 66 6f 72 65 0a 53  ed just before.S
5f60: 51 4c 69 74 65 20 74 72 69 65 73 20 74 6f 20 64  QLite tries to d
5f70: 6f 20 61 20 72 6f 6c 6c 62 61 63 6b 2e 20 20 54  o a rollback.  T
5f80: 68 65 20 73 63 72 69 70 74 20 61 72 67 75 6d 65  he script argume
5f90: 6e 74 20 69 73 20 72 75 6e 20 77 69 74 68 6f 75  nt is run withou
5fa0: 74 20 63 68 61 6e 67 65 2e 3c 2f 70 3e 0a 7d 0a  t change.</p>.}.
5fb0: 0a 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  .###############
5fc0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5fd0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5fe0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
5ff0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 0a  ###############.
6000: 4d 45 54 48 4f 44 20 73 74 61 74 75 73 20 7b 0a  METHOD status {.
6010: 3c 70 3e 54 68 69 73 20 6d 65 74 68 6f 64 20 72  <p>This method r
6020: 65 74 75 72 6e 73 20 73 74 61 74 75 73 20 69 6e  eturns status in
6030: 66 6f 72 6d 61 74 69 6f 6e 20 66 72 6f 6d 20 74  formation from t
6040: 68 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 6c 79  he most recently
6050: 20 65 76 61 6c 75 61 74 65 64 0a 53 51 4c 20 73   evaluated.SQL s
6060: 74 61 74 65 6d 65 6e 74 2e 20 20 54 68 65 20 73  tatement.  The s
6070: 74 61 74 75 73 20 6d 65 74 68 6f 64 20 74 61 6b  tatus method tak
6080: 65 73 20 61 20 73 69 6e 67 6c 65 20 61 72 67 75  es a single argu
6090: 6d 65 6e 74 20 77 68 69 63 68 20 73 68 6f 75 6c  ment which shoul
60a0: 64 20 62 65 0a 65 69 74 68 65 72 20 22 73 74 65  d be.either "ste
60b0: 70 73 22 20 6f 72 20 22 73 6f 72 74 73 22 2e 20  ps" or "sorts". 
60c0: 20 49 66 20 74 68 65 20 61 72 67 75 6d 65 6e 74   If the argument
60d0: 20 69 73 20 22 73 74 65 70 73 22 2c 20 74 68 65   is "steps", the
60e0: 6e 20 74 68 65 20 6d 65 74 68 6f 64 0a 72 65 74  n the method.ret
60f0: 75 72 6e 73 20 74 68 65 20 6e 75 6d 62 65 72 20  urns the number 
6100: 6f 66 20 66 75 6c 6c 20 74 61 62 6c 65 20 73 63  of full table sc
6110: 61 6e 20 73 74 65 70 73 20 74 68 61 74 20 74 68  an steps that th
6120: 65 20 70 72 65 76 69 6f 75 73 20 53 51 4c 20 73  e previous SQL s
6130: 74 61 74 65 6d 65 6e 74 0a 65 76 61 6c 75 61 74  tatement.evaluat
6140: 65 64 2e 20 20 49 66 20 74 68 65 20 61 72 67 75  ed.  If the argu
6150: 6d 65 6e 74 20 69 73 20 22 73 6f 72 74 73 22 2c  ment is "sorts",
6160: 20 74 68 65 20 6d 65 74 68 6f 64 20 72 65 74 75   the method retu
6170: 72 6e 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f  rns the number o
6180: 66 0a 73 6f 72 74 20 6f 70 65 72 61 74 69 6f 6e  f.sort operation
6190: 73 2e 20 20 54 68 69 73 20 69 6e 66 6f 72 6d 61  s.  This informa
61a0: 74 69 6f 6e 20 63 61 6e 20 62 65 20 75 73 65 64  tion can be used
61b0: 20 74 6f 20 64 65 74 65 63 74 20 71 75 65 72 69   to detect queri
61c0: 65 73 20 74 68 61 74 20 61 72 65 0a 6e 6f 74 20  es that are.not 
61d0: 75 73 69 6e 67 20 69 6e 64 69 63 65 73 20 74 6f  using indices to
61e0: 20 73 70 65 65 64 20 73 65 61 72 63 68 20 6f 72   speed search or
61f0: 20 73 6f 72 74 69 6e 67 2e 3c 2f 70 3e 0a 0a 3c   sorting.</p>..<
6200: 70 3e 54 68 65 20 73 74 61 74 75 73 20 6d 65 74  p>The status met
6210: 68 6f 64 20 69 73 20 62 61 73 69 63 61 6c 6c 79  hod is basically
6220: 20 61 20 77 72 61 70 70 65 72 20 6f 6e 20 74 68   a wrapper on th
6230: 65 0a 5b 73 71 6c 69 74 65 33 5f 73 74 6d 74 5f  e.[sqlite3_stmt_
6240: 73 74 61 74 75 73 28 29 5d 20 43 2d 6c 61 6e 67  status()] C-lang
6250: 75 61 67 65 20 69 6e 74 65 72 66 61 63 65 2e 3c  uage interface.<
6260: 2f 70 3e 0a 7d 0a 0a 0a 23 23 23 23 23 23 23 23  /p>.}...########
6270: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6280: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6290: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
62a0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
62b0: 23 23 23 23 23 23 0a 4d 45 54 48 4f 44 20 75 70  ######.METHOD up
62c0: 64 61 74 65 5f 68 6f 6f 6b 20 7b 0a 0a 3c 70 3e  date_hook {..<p>
62d0: 54 68 69 73 20 6d 65 74 68 6f 64 20 72 65 67 69  This method regi
62e0: 73 74 65 72 73 20 61 20 63 61 6c 6c 62 61 63 6b  sters a callback
62f0: 20 72 6f 75 74 69 6e 65 20 74 68 61 74 20 69 73   routine that is
6300: 20 69 6e 76 6f 6b 65 64 20 6a 75 73 74 20 62 65   invoked just be
6310: 66 6f 72 65 0a 65 61 63 68 20 72 6f 77 20 69 73  fore.each row is
6320: 20 6d 6f 64 69 66 69 65 64 20 62 79 20 61 6e 20   modified by an 
6330: 55 50 44 41 54 45 2c 20 49 4e 53 45 52 54 2c 20  UPDATE, INSERT, 
6340: 6f 72 20 44 45 4c 45 54 45 20 73 74 61 74 65 6d  or DELETE statem
6350: 65 6e 74 2e 20 20 46 6f 75 72 0a 61 72 67 75 6d  ent.  Four.argum
6360: 65 6e 74 73 20 61 72 65 20 61 70 70 65 6e 64 65  ents are appende
6370: 64 20 74 6f 20 74 68 65 20 63 61 6c 6c 62 61 63  d to the callbac
6380: 6b 20 62 65 66 6f 72 65 20 69 74 20 69 73 20 69  k before it is i
6390: 6e 76 6f 6b 65 64 3a 3c 2f 70 3e 0a 0a 3c 75 6c  nvoked:</p>..<ul
63a0: 3e 0a 3c 6c 69 3e 54 68 65 20 6b 65 79 77 6f 72  >.<li>The keywor
63b0: 64 20 22 49 4e 53 45 52 54 22 2c 20 22 55 50 44  d "INSERT", "UPD
63c0: 41 54 45 22 2c 20 6f 72 20 22 44 45 4c 45 54 45  ATE", or "DELETE
63d0: 22 2c 20 61 73 20 61 70 70 72 6f 70 72 69 61 74  ", as appropriat
63e0: 65 3c 2f 6c 69 3e 0a 3c 6c 69 3e 54 68 65 20 6e  e</li>.<li>The n
63f0: 61 6d 65 20 6f 66 20 74 68 65 20 64 61 74 61 62  ame of the datab
6400: 61 73 65 20 77 68 69 63 68 20 69 73 20 62 65 69  ase which is bei
6410: 6e 67 20 63 68 61 6e 67 65 64 3c 2f 6c 69 3e 0a  ng changed</li>.
6420: 3c 6c 69 3e 54 68 65 20 74 61 62 6c 65 20 74 68  <li>The table th
6430: 61 74 20 69 73 20 62 65 69 6e 67 20 63 68 61 6e  at is being chan
6440: 67 65 64 3c 2f 6c 69 3e 0a 3c 6c 69 3e 54 68 65  ged</li>.<li>The
6450: 20 72 6f 77 69 64 20 6f 66 20 74 68 65 20 72 6f   rowid of the ro
6460: 77 20 69 6e 20 74 68 65 20 74 61 62 6c 65 20 62  w in the table b
6470: 65 69 6e 67 20 63 68 61 6e 67 65 64 3c 2f 6c 69  eing changed</li
6480: 3e 0a 3c 2f 75 6c 3e 0a 7d 0a 0a 23 23 23 23 23  >.</ul>.}..#####
6490: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
64a0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
64b0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
64c0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
64d0: 23 23 23 23 23 23 23 23 23 0a 4d 45 54 48 4f 44  #########.METHOD
64e0: 20 77 61 6c 5f 68 6f 6f 6b 20 7b 0a 0a 3c 70 3e   wal_hook {..<p>
64f0: 54 68 69 73 20 6d 65 74 68 6f 64 20 72 65 67 69  This method regi
6500: 73 74 65 72 73 20 61 20 63 61 6c 6c 62 61 63 6b  sters a callback
6510: 20 72 6f 75 74 69 6e 65 20 74 68 61 74 20 69 73   routine that is
6520: 20 69 6e 76 6f 6b 65 64 20 61 66 74 65 72 20 74   invoked after t
6530: 72 61 6e 73 61 63 74 69 6f 6e 0a 63 6f 6d 6d 69  ransaction.commi
6540: 74 20 77 68 65 6e 20 74 68 65 20 64 61 74 61 62  t when the datab
6550: 61 73 65 20 69 73 20 69 6e 20 5b 57 41 4c 20 6d  ase is in [WAL m
6560: 6f 64 65 5d 2e 20 20 54 77 6f 20 61 72 67 75 6d  ode].  Two argum
6570: 65 6e 74 73 20 61 72 65 20 61 70 70 65 6e 64 65  ents are appende
6580: 64 20 74 6f 20 74 68 65 0a 63 61 6c 6c 62 61 63  d to the.callbac
6590: 6b 20 63 6f 6d 6d 61 6e 64 20 62 65 66 6f 72 65  k command before
65a0: 20 69 74 20 69 73 20 69 6e 76 6f 6b 65 64 3a 3c   it is invoked:<
65b0: 2f 70 3e 0a 0a 3c 75 6c 3e 0a 3c 6c 69 3e 54 68  /p>..<ul>.<li>Th
65c0: 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 64 61  e name of the da
65d0: 74 61 62 61 73 65 20 6f 6e 20 77 68 69 63 68 20  tabase on which 
65e0: 74 68 65 20 74 72 61 6e 73 61 63 74 69 6f 6e 20  the transaction 
65f0: 77 61 73 20 63 6f 6d 6d 69 74 74 65 64 0a 3c 6c  was committed.<l
6600: 69 3e 54 68 65 20 6e 75 6d 62 65 72 20 6f 66 20  i>The number of 
6610: 65 6e 74 72 69 65 73 20 69 6e 20 74 68 65 20 77  entries in the w
6620: 72 69 74 65 2d 61 68 65 61 64 20 6c 6f 67 20 28  rite-ahead log (
6630: 57 41 4c 29 20 66 69 6c 65 20 66 6f 72 20 74 68  WAL) file for th
6640: 61 74 20 64 61 74 61 62 61 73 65 0a 3c 2f 75 6c  at database.</ul
6650: 3e 0a 0a 3c 70 3e 54 68 69 73 20 6d 65 74 68 6f  >..<p>This metho
6660: 64 20 6d 69 67 68 74 20 64 65 63 69 64 65 20 74  d might decide t
6670: 6f 20 72 75 6e 20 61 20 5b 63 68 65 63 6b 70 6f  o run a [checkpo
6680: 69 6e 74 5d 20 65 69 74 68 65 72 20 69 74 73 65  int] either itse
6690: 6c 66 20 6f 72 20 61 73 20 61 0a 73 75 62 73 65  lf or as a.subse
66a0: 71 75 65 6e 74 20 69 64 6c 65 20 63 61 6c 6c 62  quent idle callb
66b0: 61 63 6b 2e 20 20 4e 6f 74 65 20 74 68 61 74 20  ack.  Note that 
66c0: 53 51 4c 69 74 65 20 6f 6e 6c 79 20 61 6c 6c 6f  SQLite only allo
66d0: 77 73 20 61 20 73 69 6e 67 6c 65 20 57 41 4c 20  ws a single WAL 
66e0: 68 6f 6f 6b 2e 0a 42 79 20 64 65 66 61 75 6c 74  hook..By default
66f0: 20 74 68 69 73 20 73 69 6e 67 6c 65 20 57 41 4c   this single WAL
6700: 20 68 6f 6f 6b 20 69 73 20 75 73 65 64 20 66 6f   hook is used fo
6710: 72 20 74 68 65 20 61 75 74 6f 2d 63 68 65 63 6b  r the auto-check
6720: 70 6f 69 6e 74 69 6e 67 2e 20 20 49 66 20 79 6f  pointing.  If yo
6730: 75 0a 73 65 74 20 75 70 20 61 6e 20 65 78 70 6c  u.set up an expl
6740: 69 63 69 74 20 57 41 4c 20 68 6f 6f 6b 2c 20 74  icit WAL hook, t
6750: 68 65 6e 20 74 68 61 74 20 6f 6e 65 20 57 41 4c  hen that one WAL
6760: 20 68 6f 6f 6b 20 6d 75 73 74 20 65 6e 73 75 72   hook must ensur
6770: 65 20 74 68 61 74 20 63 68 65 63 6b 70 6f 69 6e  e that checkpoin
6780: 74 73 0a 61 72 65 20 6f 63 63 75 72 72 69 6e 67  ts.are occurring
6790: 20 73 69 6e 63 65 20 74 68 65 20 61 75 74 6f 2d   since the auto-
67a0: 63 68 65 63 6b 70 6f 69 6e 74 69 6e 67 20 6d 65  checkpointing me
67b0: 63 68 61 6e 69 73 6d 20 77 69 6c 6c 20 62 65 20  chanism will be 
67c0: 64 69 73 61 62 6c 65 64 2e 3c 2f 70 3e 0a 0a 3c  disabled.</p>..<
67d0: 70 3e 54 68 69 73 20 6d 65 74 68 6f 64 20 73 68  p>This method sh
67e0: 6f 75 6c 64 20 72 65 74 75 72 6e 20 61 6e 20 69  ould return an i
67f0: 6e 74 65 67 65 72 20 76 61 6c 75 65 20 74 68 61  nteger value tha
6800: 74 20 69 73 20 65 71 75 69 76 61 6c 65 6e 74 20  t is equivalent 
6810: 74 6f 20 61 6e 20 0a 53 51 4c 69 74 65 20 65 72  to an .SQLite er
6820: 72 6f 72 20 63 6f 64 65 20 28 75 73 75 61 6c 6c  ror code (usuall
6830: 79 20 30 20 66 6f 72 20 53 51 4c 49 54 45 5f 4f  y 0 for SQLITE_O
6840: 4b 20 69 6e 20 74 68 65 20 63 61 73 65 20 6f 66  K in the case of
6850: 20 73 75 63 63 65 73 73 20 6f 72 20 31 20 66 6f   success or 1 fo
6860: 72 0a 53 51 4c 49 54 45 5f 45 52 52 4f 52 20 69  r.SQLITE_ERROR i
6870: 66 20 73 6f 6d 65 20 65 72 72 6f 72 20 6f 63 63  f some error occ
6880: 75 72 73 29 2e 20 41 73 20 69 6e 20 5b 73 71 6c  urs). As in [sql
6890: 69 74 65 33 5f 77 61 6c 5f 68 6f 6f 6b 28 29 5d  ite3_wal_hook()]
68a0: 2c 20 74 68 65 20 72 65 73 75 6c 74 73 20 6f 66  , the results of
68b0: 0a 72 65 74 75 72 6e 69 6e 67 20 61 6e 20 69 6e  .returning an in
68c0: 74 65 67 65 72 20 74 68 61 74 20 64 6f 65 73 20  teger that does 
68d0: 6e 6f 74 20 63 6f 72 72 65 73 70 6f 6e 64 20 74  not correspond t
68e0: 6f 20 61 6e 20 53 51 4c 69 74 65 20 65 72 72 6f  o an SQLite erro
68f0: 72 20 63 6f 64 65 20 61 72 65 0a 75 6e 64 65 66  r code are.undef
6900: 69 6e 65 64 2e 20 49 66 20 74 68 65 20 76 61 6c  ined. If the val
6910: 75 65 20 72 65 74 75 72 6e 65 64 20 62 79 20 74  ue returned by t
6920: 68 65 20 73 63 72 69 70 74 20 63 61 6e 6e 6f 74  he script cannot
6930: 20 62 65 20 69 6e 74 65 72 70 72 65 74 65 64 20   be interpreted 
6940: 61 73 20 61 6e 0a 69 6e 74 65 67 65 72 20 76 61  as an.integer va
6950: 6c 75 65 2c 20 6f 72 20 69 66 20 74 68 65 20 73  lue, or if the s
6960: 63 72 69 70 74 20 74 68 72 6f 77 73 20 61 20 54  cript throws a T
6970: 63 6c 20 65 78 63 65 70 74 69 6f 6e 2c 20 6e 6f  cl exception, no
6980: 20 65 72 72 6f 72 20 69 73 20 72 65 74 75 72 6e   error is return
6990: 65 64 20 74 6f 0a 53 51 4c 69 74 65 20 62 75 74  ed to.SQLite but
69a0: 20 61 20 54 63 6c 20 62 61 63 6b 67 72 6f 75 6e   a Tcl backgroun
69b0: 64 2d 65 72 72 6f 72 20 69 73 20 72 61 69 73 65  d-error is raise
69c0: 64 2e 0a 7d 0a 0a 23 23 23 23 23 23 23 23 23 23  d..}..##########
69d0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
69e0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
69f0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6a00: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6a10: 23 23 23 23 0a 4d 45 54 48 4f 44 20 69 6e 63 72  ####.METHOD incr
6a20: 62 6c 6f 62 20 7b 0a 0a 3c 70 3e 54 68 69 73 20  blob {..<p>This 
6a30: 6d 65 74 68 6f 64 20 6f 70 65 6e 73 20 61 20 54  method opens a T
6a40: 43 4c 20 63 68 61 6e 6e 65 6c 20 74 68 61 74 20  CL channel that 
6a50: 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20 72  can be used to r
6a60: 65 61 64 20 6f 72 20 77 72 69 74 65 0a 69 6e 74  ead or write.int
6a70: 6f 20 61 20 70 72 65 65 78 69 73 74 69 6e 67 20  o a preexisting 
6a80: 42 4c 4f 42 20 69 6e 20 74 68 65 20 64 61 74 61  BLOB in the data
6a90: 62 61 73 65 2e 20 20 54 68 65 20 73 79 6e 74 61  base.  The synta
6aa0: 78 20 69 73 20 6c 69 6b 65 20 74 68 69 73 3a 3c  x is like this:<
6ab0: 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65  /p>..<blockquote
6ac0: 3e 0a 3c 69 3e 64 62 63 6d 64 3c 2f 69 3e 26 6e  >.<i>dbcmd</i>&n
6ad0: 62 73 70 3b 26 6e 62 73 70 3b 3c 62 3e 69 6e 63  bsp;&nbsp;<b>inc
6ae0: 72 62 6c 6f 62 3c 2f 62 3e 26 6e 62 73 70 3b 26  rblob</b>&nbsp;&
6af0: 6e 62 73 70 3b 3c 62 3e 3f 2d 72 65 61 64 6f 6e  nbsp;<b>?-readon
6b00: 6c 79 3f 3c 2f 62 3e 0a 26 6e 62 73 70 3b 26 6e  ly?</b>.&nbsp;&n
6b10: 62 73 70 3b 3c 69 3e 3f 44 42 3f 26 6e 62 73 70  bsp;<i>?DB?&nbsp
6b20: 3b 26 6e 62 73 70 3b 54 41 42 4c 45 26 6e 62 73  ;&nbsp;TABLE&nbs
6b30: 70 3b 26 6e 62 73 70 3b 43 4f 4c 55 4d 4e 26 6e  p;&nbsp;COLUMN&n
6b40: 62 73 70 3b 26 6e 62 73 70 3b 52 4f 57 49 44 3c  bsp;&nbsp;ROWID<
6b50: 2f 69 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65  /i>.</blockquote
6b60: 3e 0a 0a 3c 70 3e 0a 54 68 65 20 63 6f 6d 6d 61  >..<p>.The comma
6b70: 6e 64 20 72 65 74 75 72 6e 73 20 61 20 6e 65 77  nd returns a new
6b80: 20 54 43 4c 20 63 68 61 6e 6e 65 6c 20 66 6f 72   TCL channel for
6b90: 20 72 65 61 64 69 6e 67 20 6f 72 20 77 72 69 74   reading or writ
6ba0: 69 6e 67 20 74 6f 20 74 68 65 20 42 4c 4f 42 2e  ing to the BLOB.
6bb0: 0a 54 68 65 20 63 68 61 6e 6e 65 6c 20 69 73 20  .The channel is 
6bc0: 6f 70 65 6e 65 64 20 75 73 69 6e 67 20 74 68 65  opened using the
6bd0: 20 75 6e 64 65 72 6c 79 69 6e 67 20 0a 3c 61 20   underlying .<a 
6be0: 68 72 65 66 3d 22 63 33 72 65 66 2f 62 6c 6f 62  href="c3ref/blob
6bf0: 5f 6f 70 65 6e 2e 68 74 6d 6c 22 3e 73 71 6c 69  _open.html">sqli
6c00: 74 65 33 5f 62 6c 6f 62 5f 6f 70 65 6e 28 29 3c  te3_blob_open()<
6c10: 2f 61 3e 20 43 2d 6c 61 6e 67 75 61 67 65 0a 69  /a> C-language.i
6c20: 6e 74 65 72 66 61 63 65 2e 20 20 43 6c 6f 73 65  nterface.  Close
6c30: 20 74 68 65 20 63 68 61 6e 6e 65 6c 20 75 73 69   the channel usi
6c40: 6e 67 20 74 68 65 20 3c 62 3e 63 6c 6f 73 65 3c  ng the <b>close<
6c50: 2f 62 3e 20 63 6f 6d 6d 61 6e 64 20 6f 66 20 54  /b> command of T
6c60: 43 4c 2e 0a 3c 2f 70 3e 0a 7d 0a 0a 23 23 23 23  CL..</p>.}..####
6c70: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6c80: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6c90: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6ca0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6cb0: 23 23 23 23 23 23 23 23 23 23 0a 4d 45 54 48 4f  ##########.METHO
6cc0: 44 20 65 72 72 6f 72 63 6f 64 65 20 7b 0a 0a 3c  D errorcode {..<
6cd0: 70 3e 54 68 69 73 20 6d 65 74 68 6f 64 20 72 65  p>This method re
6ce0: 74 75 72 6e 73 20 74 68 65 20 6e 75 6d 65 72 69  turns the numeri
6cf0: 63 20 65 72 72 6f 72 20 63 6f 64 65 20 74 68 61  c error code tha
6d00: 74 20 72 65 73 75 6c 74 65 64 20 66 72 6f 6d 20  t resulted from 
6d10: 74 68 65 20 6d 6f 73 74 0a 72 65 63 65 6e 74 20  the most.recent 
6d20: 53 51 4c 69 74 65 20 6f 70 65 72 61 74 69 6f 6e  SQLite operation
6d30: 2e 3c 2f 70 3e 0a 7d 0a 0a 23 23 23 23 23 23 23  .</p>.}..#######
6d40: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6d50: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6d60: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6d70: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6d80: 23 23 23 23 23 23 23 0a 4d 45 54 48 4f 44 20 74  #######.METHOD t
6d90: 72 61 63 65 20 7b 0a 0a 3c 70 3e 54 68 65 20 22  race {..<p>The "
6da0: 74 72 61 63 65 22 20 6d 65 74 68 6f 64 20 72 65  trace" method re
6db0: 67 69 73 74 65 72 73 20 61 20 63 61 6c 6c 62 61  gisters a callba
6dc0: 63 6b 20 74 68 61 74 20 69 73 20 69 6e 76 6f 6b  ck that is invok
6dd0: 65 64 20 61 73 20 65 61 63 68 20 53 51 4c 0a 73  ed as each SQL.s
6de0: 74 61 74 65 6d 65 6e 74 20 69 73 20 63 6f 6d 70  tatement is comp
6df0: 69 6c 65 64 2e 20 20 54 68 65 20 74 65 78 74 20  iled.  The text 
6e00: 6f 66 20 74 68 65 20 53 51 4c 20 69 73 20 61 70  of the SQL is ap
6e10: 70 65 6e 64 65 64 20 61 73 20 61 20 73 69 6e 67  pended as a sing
6e20: 6c 65 20 73 74 72 69 6e 67 0a 74 6f 20 74 68 65  le string.to the
6e30: 20 63 6f 6d 6d 61 6e 64 20 62 65 66 6f 72 65 20   command before 
6e40: 69 74 20 69 73 20 69 6e 76 6f 6b 65 64 2e 20 20  it is invoked.  
6e50: 54 68 69 73 20 63 61 6e 20 62 65 20 75 73 65 64  This can be used
6e60: 20 28 66 6f 72 20 65 78 61 6d 70 6c 65 29 20 74   (for example) t
6e70: 6f 0a 6b 65 65 70 20 61 20 6c 6f 67 20 6f 66 20  o.keep a log of 
6e80: 61 6c 6c 20 53 51 4c 20 6f 70 65 72 61 74 69 6f  all SQL operatio
6e90: 6e 73 20 74 68 61 74 20 61 6e 20 61 70 70 6c 69  ns that an appli
6ea0: 63 61 74 69 6f 6e 20 70 65 72 66 6f 72 6d 73 2e  cation performs.
6eb0: 0a 3c 2f 70 3e 0a 7d 0a 0a 23 23 23 23 23 23 23  .</p>.}..#######
6ec0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6ed0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6ee0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6ef0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
6f00: 23 23 23 23 23 23 23 0a 4d 45 54 48 4f 44 20 74  #######.METHOD t
6f10: 72 61 63 65 5f 76 32 20 7b 0a 0a 3c 70 3e 54 68  race_v2 {..<p>Th
6f20: 65 20 22 74 72 61 63 65 5f 76 32 22 20 6d 65 74  e "trace_v2" met
6f30: 68 6f 64 20 72 65 67 69 73 74 65 72 73 20 61 20  hod registers a 
6f40: 63 61 6c 6c 62 61 63 6b 20 74 68 61 74 20 69 73  callback that is
6f50: 20 69 6e 76 6f 6b 65 64 20 61 73 20 65 61 63 68   invoked as each
6f60: 20 53 51 4c 0a 73 74 61 74 65 6d 65 6e 74 20 69   SQL.statement i
6f70: 73 20 63 6f 6d 70 69 6c 65 64 2e 20 54 68 65 20  s compiled. The 
6f80: 73 79 6e 74 61 78 20 69 73 20 61 73 20 66 6f 6c  syntax is as fol
6f90: 6c 6f 77 73 3a 0a 0a 0a 3c 62 6c 6f 63 6b 71 75  lows:...<blockqu
6fa0: 6f 74 65 3e 0a 3c 69 3e 64 62 63 6d 64 3c 2f 69  ote>.<i>dbcmd</i
6fb0: 3e 26 6e 62 73 70 3b 26 6e 62 73 70 3b 3c 62 3e  >&nbsp;&nbsp;<b>
6fc0: 74 72 61 63 65 5f 76 32 3c 2f 62 3e 26 6e 62 73  trace_v2</b>&nbs
6fd0: 70 3b 26 6e 62 73 70 3b 3f 3c 69 3e 63 61 6c 6c  p;&nbsp;?<i>call
6fe0: 62 61 63 6b 3c 2f 69 3e 3f 26 6e 62 73 70 3b 26  back</i>?&nbsp;&
6ff0: 6e 62 73 70 3b 3f 3c 69 3e 6d 61 73 6b 3c 2f 69  nbsp;?<i>mask</i
7000: 3e 3f 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e  >?.</blockquote>
7010: 0a 0a 3c 70 3e 54 68 69 73 20 63 6f 6d 6d 61 6e  ..<p>This comman
7020: 64 20 63 61 75 73 65 73 20 74 68 65 20 22 63 61  d causes the "ca
7030: 6c 6c 62 61 63 6b 22 20 73 63 72 69 70 74 20 74  llback" script t
7040: 6f 20 62 65 20 69 6e 76 6f 6b 65 64 20 77 68 65  o be invoked whe
7050: 6e 65 76 65 72 0a 63 65 72 74 61 69 6e 20 63 6f  never.certain co
7060: 6e 64 69 74 69 6f 6e 73 20 6f 63 63 75 72 73 2e  nditions occurs.
7070: 20 20 54 68 65 20 63 6f 6e 64 69 74 69 6f 6e 73    The conditions
7080: 20 61 72 65 20 64 65 74 65 72 6d 69 6e 65 64 20   are determined 
7090: 62 79 20 74 68 65 20 3c 69 3e 6d 61 73 6b 3c 2f  by the <i>mask</
70a0: 69 3e 0a 61 72 67 75 6d 65 6e 74 2c 20 77 68 69  i>.argument, whi
70b0: 63 68 20 73 68 6f 75 6c 64 20 62 65 20 61 20 54  ch should be a T
70c0: 43 4c 2d 6c 69 73 74 20 6f 66 20 7a 65 72 6f 20  CL-list of zero 
70d0: 6f 72 20 6d 6f 72 65 20 6f 66 20 74 68 65 20 66  or more of the f
70e0: 6f 6c 6c 6f 77 69 6e 67 0a 6b 65 79 77 6f 72 64  ollowing.keyword
70f0: 73 3a 0a 0a 3c 75 6c 3e 0a 3c 6c 69 3e 20 3c 62  s:..<ul>.<li> <b
7100: 3e 73 74 61 74 65 6d 65 6e 74 3c 2f 62 3e 0a 3c  >statement</b>.<
7110: 6c 69 3e 20 3c 62 3e 70 72 6f 66 69 6c 65 3c 2f  li> <b>profile</
7120: 62 3e 0a 3c 6c 69 3e 20 3c 62 3e 72 6f 77 3c 2f  b>.<li> <b>row</
7130: 62 3e 0a 3c 6c 69 3e 20 3c 62 3e 63 6c 6f 73 65  b>.<li> <b>close
7140: 3c 2f 62 3e 0a 3c 2f 75 6c 3e 0a 0a 3c 70 3e 54  </b>.</ul>..<p>T
7150: 72 61 63 65 73 20 66 6f 72 20 3c 62 3e 73 74 61  races for <b>sta
7160: 74 65 6d 65 6e 74 3c 2f 62 3e 20 69 6e 76 6f 6b  tement</b> invok
7170: 65 20 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 77  e the callback w
7180: 69 74 68 20 74 77 6f 20 61 72 67 75 6d 65 6e 74  ith two argument
7190: 73 0a 77 68 65 6e 65 76 65 72 20 61 20 6e 65 77  s.whenever a new
71a0: 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 69   SQL statement i
71b0: 73 20 72 75 6e 2e 0a 54 68 65 20 66 69 72 73 74  s run..The first
71c0: 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 6e 20   argument is an 
71d0: 69 6e 74 65 67 65 72 20 77 68 69 63 68 20 69 73  integer which is
71e0: 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20 74 68   the value of th
71f0: 65 20 70 6f 69 6e 74 65 72 0a 74 6f 20 74 68 65  e pointer.to the
7200: 20 75 6e 64 65 72 6c 79 69 6e 67 20 5b 73 71 6c   underlying [sql
7210: 69 74 65 33 5f 73 74 6d 74 5d 20 6f 62 6a 65 63  ite3_stmt] objec
7220: 74 2e 20 20 54 68 69 73 20 69 6e 74 65 67 65 72  t.  This integer
7230: 20 63 61 6e 20 62 65 20 75 73 65 64 0a 74 6f 20   can be used.to 
7240: 63 6f 72 72 65 6c 61 74 65 20 53 51 4c 20 73 74  correlate SQL st
7250: 61 74 65 6d 65 6e 74 20 74 65 78 74 20 77 69 74  atement text wit
7260: 68 20 74 68 65 20 72 65 73 75 6c 74 20 6f 66 20  h the result of 
7270: 61 20 3c 62 3e 70 72 6f 66 69 6c 65 3c 2f 62 3e  a <b>profile</b>
7280: 0a 6f 72 20 3c 62 3e 72 6f 77 3c 2f 62 3e 20 63  .or <b>row</b> c
7290: 61 6c 6c 62 61 63 6b 2e 20 54 68 65 20 73 65 63  allback. The sec
72a0: 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20 69 73 20  ond argument is 
72b0: 74 68 65 0a 75 6e 65 78 70 61 6e 64 65 64 20 74  the.unexpanded t
72c0: 65 78 74 20 6f 66 20 74 68 65 20 53 51 4c 20 73  ext of the SQL s
72d0: 74 61 74 65 6d 65 6e 74 20 62 65 69 6e 67 20 72  tatement being r
72e0: 75 6e 2e 20 20 42 79 20 22 75 6e 65 78 70 61 6e  un.  By "unexpan
72f0: 64 65 64 22 2c 20 77 65 0a 6d 65 61 6e 20 74 68  ded", we.mean th
7300: 61 74 20 76 61 72 69 61 62 6c 65 20 73 75 62 73  at variable subs
7310: 74 69 74 75 74 69 6f 6e 73 20 69 6e 20 74 68 65  titutions in the
7320: 20 74 65 78 74 20 61 72 65 20 6e 6f 74 20 65 78   text are not ex
7330: 70 61 6e 64 65 64 20 69 6e 74 6f 20 74 68 65 0a  panded into the.
7340: 76 61 72 69 61 62 6c 65 20 76 61 6c 75 65 73 2e  variable values.
7350: 20 20 54 68 69 73 20 69 73 20 64 69 66 66 65 72    This is differ
7360: 65 6e 74 20 66 72 6f 6d 20 74 68 65 20 62 65 68  ent from the beh
7370: 61 76 69 6f 72 20 6f 66 20 74 68 65 20 22 74 72  avior of the "tr
7380: 61 63 65 22 0a 6d 65 74 68 6f 64 20 77 68 69 63  ace".method whic
7390: 68 20 64 6f 65 73 20 65 78 70 61 6e 64 20 76 61  h does expand va
73a0: 72 69 61 62 6c 65 20 73 75 62 73 74 69 74 75 74  riable substitut
73b0: 69 6f 6e 73 2e 0a 0a 3c 70 3e 54 72 61 63 65 73  ions...<p>Traces
73c0: 20 66 6f 72 20 3c 62 3e 70 72 6f 66 69 6c 65 3c   for <b>profile<
73d0: 2f 62 3e 20 69 6e 76 6f 6b 65 20 74 68 65 20 63  /b> invoke the c
73e0: 61 6c 6c 62 61 63 6b 20 77 69 74 68 20 74 77 6f  allback with two
73f0: 20 61 72 67 75 6d 65 6e 74 73 0a 61 73 20 65 61   arguments.as ea
7400: 63 68 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  ch SQL statement
7410: 20 66 69 6e 69 73 68 65 73 2e 20 20 54 68 65 20   finishes.  The 
7420: 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 69  first argument i
7430: 73 20 61 6e 20 69 6e 74 65 67 65 72 20 77 68 69  s an integer whi
7440: 63 68 0a 69 73 20 74 68 65 20 76 61 6c 75 65 20  ch.is the value 
7450: 6f 66 20 74 68 65 20 75 6e 64 65 72 6c 79 69 6e  of the underlyin
7460: 67 20 5b 73 71 6c 69 74 65 33 5f 73 74 6d 74 5d  g [sqlite3_stmt]
7470: 20 6f 62 6a 65 63 74 2e 20 20 54 68 65 20 73 65   object.  The se
7480: 63 6f 6e 64 0a 61 72 67 75 6d 65 6e 74 20 69 73  cond.argument is
7490: 20 74 68 65 20 61 70 70 72 6f 78 69 6d 61 74 65   the approximate
74a0: 20 72 75 6e 2d 74 69 6d 65 20 66 6f 72 20 74 68   run-time for th
74b0: 65 20 73 74 61 74 65 6d 65 6e 74 20 69 6e 20 6e  e statement in n
74c0: 61 6e 6f 73 65 63 6f 6e 64 73 2e 0a 54 68 65 20  anoseconds..The 
74d0: 72 75 6e 2d 74 69 6d 65 20 69 73 20 74 68 65 20  run-time is the 
74e0: 62 65 73 74 20 65 73 74 69 6d 61 74 65 20 61 76  best estimate av
74f0: 61 69 6c 61 62 6c 65 20 64 65 70 65 6e 64 69 6e  ailable dependin
7500: 67 20 6f 6e 20 74 68 65 20 63 61 70 61 62 69 6c  g on the capabil
7510: 69 74 69 65 73 0a 6f 66 20 74 68 65 20 70 6c 61  ities.of the pla
7520: 74 66 6f 72 6d 20 6f 6e 20 77 68 69 63 68 20 74  tform on which t
7530: 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 69  he application i
7540: 73 20 72 75 6e 6e 69 6e 67 2e 0a 0a 3c 70 3e 54  s running...<p>T
7550: 72 61 63 65 73 20 66 6f 72 20 3c 62 3e 72 6f 77  races for <b>row
7560: 3c 2f 62 3e 20 69 6e 76 6f 6b 65 20 74 68 65 20  </b> invoke the 
7570: 63 61 6c 6c 62 61 63 6b 20 77 69 74 68 20 61 20  callback with a 
7580: 73 69 6e 67 6c 65 20 61 72 67 75 6d 65 6e 74 0a  single argument.
7590: 77 68 65 6e 65 76 65 72 20 61 20 6e 65 77 20 72  whenever a new r
75a0: 65 73 75 6c 74 20 72 6f 77 20 69 73 20 61 76 61  esult row is ava
75b0: 69 6c 61 62 6c 65 20 66 72 6f 6d 20 61 6e 20 53  ilable from an S
75c0: 51 4c 20 73 74 61 74 65 6d 65 6e 74 2e 0a 54 68  QL statement..Th
75d0: 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 6e  e argument is an
75e0: 20 69 6e 74 65 67 65 72 20 77 68 69 63 68 20 69   integer which i
75f0: 73 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20 74  s the value of t
7600: 68 65 20 75 6e 64 65 72 6c 79 69 6e 67 0a 5b 73  he underlying.[s
7610: 71 6c 69 74 65 33 5f 73 74 6d 74 5d 20 6f 62 6a  qlite3_stmt] obj
7620: 65 63 74 20 70 6f 69 6e 74 65 72 2e 0a 0a 3c 70  ect pointer...<p
7630: 3e 54 72 61 63 65 73 20 66 6f 72 20 3c 62 3e 63  >Traces for <b>c
7640: 6c 6f 73 65 3c 2f 62 3e 20 69 6e 76 6f 6b 65 20  lose</b> invoke 
7650: 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 77 69 74  the callback wit
7660: 68 20 61 20 73 69 6e 67 6c 65 20 61 72 67 75 6d  h a single argum
7670: 65 6e 74 0a 61 73 20 74 68 65 20 64 61 74 61 62  ent.as the datab
7680: 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 69  ase connection i
7690: 73 20 63 6c 6f 73 69 6e 67 2e 20 20 54 68 65 20  s closing.  The 
76a0: 61 72 67 75 6d 65 6e 74 20 69 73 20 61 6e 20 69  argument is an i
76b0: 6e 74 65 67 65 72 20 77 68 69 63 68 0a 69 73 20  nteger which.is 
76c0: 74 68 65 20 76 61 6c 75 65 20 6f 66 20 61 20 70  the value of a p
76d0: 6f 69 6e 74 65 72 20 74 6f 20 74 68 65 20 75 6e  ointer to the un
76e0: 64 65 72 6c 79 69 6e 67 20 5b 73 71 6c 69 74 65  derlying [sqlite
76f0: 33 5d 20 6f 62 6a 65 63 74 20 74 68 61 74 20 69  3] object that i
7700: 73 0a 63 6c 6f 73 69 6e 67 2e 0a 0a 3c 70 3e 54  s.closing...<p>T
7710: 68 65 72 65 20 63 61 6e 20 6f 6e 6c 79 20 62 65  here can only be
7720: 20 61 20 73 69 6e 67 6c 65 20 74 72 61 63 65 20   a single trace 
7730: 63 61 6c 6c 62 61 63 6b 20 72 65 67 69 73 74 65  callback registe
7740: 72 65 64 20 6f 6e 20 61 20 64 61 74 61 62 61 73  red on a databas
7750: 65 0a 63 6f 6e 6e 65 63 74 69 6f 6e 2e 20 20 45  e.connection.  E
7760: 61 63 68 20 75 73 65 20 6f 66 20 22 74 72 61 63  ach use of "trac
7770: 65 22 20 6f 72 20 22 74 72 61 63 65 5f 76 32 22  e" or "trace_v2"
7780: 20 63 61 6e 63 65 6c 73 20 61 6c 6c 20 70 72 69   cancels all pri
7790: 6f 72 0a 74 72 61 63 65 20 63 61 6c 6c 62 61 63  or.trace callbac
77a0: 6b 2e 0a 7d 0a 0a 23 23 23 23 23 23 23 23 23 23  k..}..##########
77b0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
77c0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
77d0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
77e0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
77f0: 23 23 23 23 0a 4d 45 54 48 4f 44 20 62 61 63 6b  ####.METHOD back
7800: 75 70 20 7b 0a 0a 3c 70 3e 54 68 65 20 22 62 61  up {..<p>The "ba
7810: 63 6b 75 70 22 20 6d 65 74 68 6f 64 20 6d 61 6b  ckup" method mak
7820: 65 73 20 61 20 62 61 63 6b 75 70 20 63 6f 70 79  es a backup copy
7830: 20 6f 66 20 61 20 6c 69 76 65 20 64 61 74 61 62   of a live datab
7840: 61 73 65 2e 20 20 54 68 65 0a 63 6f 6d 6d 61 6e  ase.  The.comman
7850: 64 20 73 79 6e 74 61 78 20 69 73 20 6c 69 6b 65  d syntax is like
7860: 20 74 68 69 73 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f   this:</p>..<blo
7870: 63 6b 71 75 6f 74 65 3e 0a 3c 69 3e 64 62 63 6d  ckquote>.<i>dbcm
7880: 64 3c 2f 69 3e 26 6e 62 73 70 3b 26 6e 62 73 70  d</i>&nbsp;&nbsp
7890: 3b 3c 62 3e 62 61 63 6b 75 70 3c 2f 62 3e 26 6e  ;<b>backup</b>&n
78a0: 62 73 70 3b 26 6e 62 73 70 3b 3f 3c 69 3e 73 6f  bsp;&nbsp;?<i>so
78b0: 75 72 63 65 2d 64 61 74 61 62 61 73 65 3c 2f 69  urce-database</i
78c0: 3e 3f 26 6e 62 73 70 3b 26 6e 62 73 70 3b 3c 69  >?&nbsp;&nbsp;<i
78d0: 3e 62 61 63 6b 75 70 2d 66 69 6c 65 6e 61 6d 65  >backup-filename
78e0: 3c 2f 69 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74  </i>.</blockquot
78f0: 65 3e 0a 0a 3c 70 3e 54 68 65 20 6f 70 74 69 6f  e>..<p>The optio
7900: 6e 61 6c 20 3c 69 3e 73 6f 75 72 63 65 2d 64 61  nal <i>source-da
7910: 74 61 62 61 73 65 3c 2f 69 3e 20 61 72 67 75 6d  tabase</i> argum
7920: 65 6e 74 20 74 65 6c 6c 73 20 77 68 69 63 68 20  ent tells which 
7930: 64 61 74 61 62 61 73 65 20 69 6e 0a 74 68 65 20  database in.the 
7940: 63 75 72 72 65 6e 74 20 63 6f 6e 6e 65 63 74 69  current connecti
7950: 6f 6e 20 73 68 6f 75 6c 64 20 62 65 20 62 61 63  on should be bac
7960: 6b 65 64 20 75 70 2e 20 20 54 68 65 20 64 65 66  ked up.  The def
7970: 61 75 6c 74 20 76 61 6c 75 65 20 69 73 20 3c 62  ault value is <b
7980: 3e 6d 61 69 6e 3c 2f 62 3e 0a 28 6f 72 2c 20 69  >main</b>.(or, i
7990: 6e 20 6f 74 68 65 72 20 77 6f 72 64 73 2c 20 74  n other words, t
79a0: 68 65 20 70 72 69 6d 61 72 79 20 64 61 74 61 62  he primary datab
79b0: 61 73 65 20 66 69 6c 65 29 2e 20 20 54 6f 20 62  ase file).  To b
79c0: 61 63 6b 20 75 70 20 54 45 4d 50 20 74 61 62 6c  ack up TEMP tabl
79d0: 65 73 0a 75 73 65 20 3c 62 3e 74 65 6d 70 3c 2f  es.use <b>temp</
79e0: 62 3e 2e 20 20 54 6f 20 62 61 63 6b 75 70 20 61  b>.  To backup a
79f0: 6e 20 61 75 78 69 6c 69 61 72 79 20 64 61 74 61  n auxiliary data
7a00: 62 61 73 65 20 61 64 64 65 64 20 74 6f 20 74 68  base added to th
7a10: 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 0a 75 73 69  e connection.usi
7a20: 6e 67 20 74 68 65 20 5b 41 54 54 41 43 48 5d 20  ng the [ATTACH] 
7a30: 63 6f 6d 6d 61 6e 64 2c 20 75 73 65 20 74 68 65  command, use the
7a40: 20 6e 61 6d 65 20 6f 66 20 74 68 61 74 20 64 61   name of that da
7a50: 74 61 62 61 73 65 20 61 73 20 69 74 20 77 61 73  tabase as it was
7a60: 20 61 73 73 69 67 6e 65 64 0a 69 6e 20 74 68 65   assigned.in the
7a70: 20 5b 41 54 54 41 43 48 5d 20 63 6f 6d 6d 61 6e   [ATTACH] comman
7a80: 64 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 3c  d.</p>..<p>The <
7a90: 69 3e 62 61 63 6b 75 70 2d 66 69 6c 65 6e 61 6d  i>backup-filenam
7aa0: 65 3c 2f 69 3e 20 69 73 20 74 68 65 20 6e 61 6d  e</i> is the nam
7ab0: 65 20 6f 66 20 61 20 66 69 6c 65 20 69 6e 74 6f  e of a file into
7ac0: 20 77 68 69 63 68 20 74 68 65 20 62 61 63 6b 75   which the backu
7ad0: 70 20 69 73 0a 77 72 69 74 74 65 6e 2e 20 20 3c  p is.written.  <
7ae0: 69 3e 42 61 63 6b 75 70 2d 66 69 6c 65 6e 61 6d  i>Backup-filenam
7af0: 65 3c 2f 69 3e 20 64 6f 65 73 20 6e 6f 74 20 68  e</i> does not h
7b00: 61 76 65 20 74 6f 20 65 78 69 73 74 20 61 68 65  ave to exist ahe
7b10: 61 64 20 6f 66 20 74 69 6d 65 2c 20 62 75 74 20  ad of time, but 
7b20: 69 66 0a 69 74 20 64 6f 65 73 2c 20 69 74 20 6d  if.it does, it m
7b30: 75 73 74 20 62 65 20 61 20 77 65 6c 6c 2d 66 6f  ust be a well-fo
7b40: 72 6d 65 64 20 53 51 4c 69 74 65 20 64 61 74 61  rmed SQLite data
7b50: 62 61 73 65 2e 3c 2f 70 3e 0a 7d 0a 0a 23 23 23  base.</p>.}..###
7b60: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
7b70: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
7b80: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
7b90: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
7ba0: 23 23 23 23 23 23 23 23 23 23 23 0a 4d 45 54 48  ###########.METH
7bb0: 4f 44 20 72 65 73 74 6f 72 65 20 7b 0a 0a 3c 70  OD restore {..<p
7bc0: 3e 54 68 65 20 22 72 65 73 74 6f 72 65 22 20 6d  >The "restore" m
7bd0: 65 74 68 6f 64 20 63 6f 70 69 65 73 20 74 68 65  ethod copies the
7be0: 20 63 6f 6e 74 65 6e 74 20 66 72 6f 6d 20 61 20   content from a 
7bf0: 73 65 70 61 72 61 74 65 20 64 61 74 61 62 61 73  separate databas
7c00: 65 20 66 69 6c 65 20 0a 69 6e 74 6f 20 74 68 65  e file .into the
7c10: 20 63 75 72 72 65 6e 74 20 64 61 74 61 62 61 73   current databas
7c20: 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 2c 20 6f 76  e connection, ov
7c30: 65 72 77 72 69 74 69 6e 67 20 61 6e 79 20 70 72  erwriting any pr
7c40: 65 65 78 69 73 74 69 6e 67 20 63 6f 6e 74 65 6e  eexisting conten
7c50: 74 2e 0a 54 68 65 20 63 6f 6d 6d 61 6e 64 20 73  t..The command s
7c60: 79 6e 74 61 78 20 69 73 20 6c 69 6b 65 20 74 68  yntax is like th
7c70: 69 73 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71  is:</p>..<blockq
7c80: 75 6f 74 65 3e 0a 3c 69 3e 64 62 63 6d 64 3c 2f  uote>.<i>dbcmd</
7c90: 69 3e 26 6e 62 73 70 3b 26 6e 62 73 70 3b 3c 62  i>&nbsp;&nbsp;<b
7ca0: 3e 72 65 73 74 6f 72 65 3c 2f 62 3e 26 6e 62 73  >restore</b>&nbs
7cb0: 70 3b 26 6e 62 73 70 3b 3f 3c 69 3e 74 61 72 67  p;&nbsp;?<i>targ
7cc0: 65 74 2d 64 61 74 61 62 61 73 65 3c 2f 69 3e 3f  et-database</i>?
7cd0: 26 6e 62 73 70 3b 26 6e 62 73 70 3b 3c 69 3e 73  &nbsp;&nbsp;<i>s
7ce0: 6f 75 72 63 65 2d 66 69 6c 65 6e 61 6d 65 3c 2f  ource-filename</
7cf0: 69 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e  i>.</blockquote>
7d00: 0a 0a 3c 70 3e 54 68 65 20 6f 70 74 69 6f 6e 61  ..<p>The optiona
7d10: 6c 20 3c 69 3e 74 61 72 67 65 74 2d 64 61 74 61  l <i>target-data
7d20: 62 61 73 65 3c 2f 69 3e 20 61 72 67 75 6d 65 6e  base</i> argumen
7d30: 74 20 74 65 6c 6c 73 20 77 68 69 63 68 20 64 61  t tells which da
7d40: 74 61 62 61 73 65 20 69 6e 0a 74 68 65 20 63 75  tabase in.the cu
7d50: 72 72 65 6e 74 20 63 6f 6e 6e 65 63 74 69 6f 6e  rrent connection
7d60: 20 73 68 6f 75 6c 64 20 62 65 20 6f 76 65 72 77   should be overw
7d70: 72 69 74 74 65 6e 20 77 69 74 68 20 6e 65 77 20  ritten with new 
7d80: 63 6f 6e 74 65 6e 74 2e 20 20 0a 54 68 65 20 64  content.  .The d
7d90: 65 66 61 75 6c 74 20 76 61 6c 75 65 20 69 73 20  efault value is 
7da0: 3c 62 3e 6d 61 69 6e 3c 2f 62 3e 20 0a 28 6f 72  <b>main</b> .(or
7db0: 2c 20 69 6e 20 6f 74 68 65 72 20 77 6f 72 64 73  , in other words
7dc0: 2c 20 74 68 65 20 70 72 69 6d 61 72 79 20 64 61  , the primary da
7dd0: 74 61 62 61 73 65 20 66 69 6c 65 29 2e 20 20 54  tabase file).  T
7de0: 6f 20 72 65 70 6f 70 75 6c 61 74 65 20 74 68 65  o repopulate the
7df0: 20 54 45 4d 50 20 74 61 62 6c 65 73 0a 75 73 65   TEMP tables.use
7e00: 20 3c 62 3e 74 65 6d 70 3c 2f 62 3e 2e 20 20 54   <b>temp</b>.  T
7e10: 6f 20 6f 76 65 72 77 72 69 74 65 20 61 6e 20 61  o overwrite an a
7e20: 75 78 69 6c 69 61 72 79 20 64 61 74 61 62 61 73  uxiliary databas
7e30: 65 20 61 64 64 65 64 20 74 6f 20 74 68 65 20 63  e added to the c
7e40: 6f 6e 6e 65 63 74 69 6f 6e 0a 75 73 69 6e 67 20  onnection.using 
7e50: 74 68 65 20 5b 41 54 54 41 43 48 5d 20 63 6f 6d  the [ATTACH] com
7e60: 6d 61 6e 64 2c 20 75 73 65 20 74 68 65 20 6e 61  mand, use the na
7e70: 6d 65 20 6f 66 20 74 68 61 74 20 64 61 74 61 62  me of that datab
7e80: 61 73 65 20 61 73 20 69 74 20 77 61 73 20 61 73  ase as it was as
7e90: 73 69 67 6e 65 64 0a 69 6e 20 74 68 65 20 5b 41  signed.in the [A
7ea0: 54 54 41 43 48 5d 20 63 6f 6d 6d 61 6e 64 2e 3c  TTACH] command.<
7eb0: 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 3c 69 3e 73  /p>..<p>The <i>s
7ec0: 6f 75 72 63 65 2d 66 69 6c 65 6e 61 6d 65 3c 2f  ource-filename</
7ed0: 69 3e 20 69 73 20 74 68 65 20 6e 61 6d 65 20 6f  i> is the name o
7ee0: 66 20 61 6e 20 65 78 69 73 74 69 6e 67 20 77 65  f an existing we
7ef0: 6c 6c 2d 66 6f 72 6d 65 64 20 53 51 4c 69 74 65  ll-formed SQLite
7f00: 0a 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 66  .database file f
7f10: 72 6f 6d 20 77 68 69 63 68 20 74 68 65 20 63 6f  rom which the co
7f20: 6e 74 65 6e 74 20 69 73 20 65 78 74 72 61 63 74  ntent is extract
7f30: 65 64 2e 3c 2f 70 3e 0a 7d 0a 0a 23 23 23 23 23  ed.</p>.}..#####
7f40: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
7f50: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
7f60: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
7f70: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
7f80: 23 23 23 23 23 23 23 23 23 0a 4d 45 54 48 4f 44  #########.METHOD
7f90: 20 73 65 72 69 61 6c 69 7a 65 20 7b 0a 0a 3c 70   serialize {..<p
7fa0: 3e 54 68 65 20 22 73 65 72 69 61 6c 69 7a 65 22  >The "serialize"
7fb0: 20 6d 65 74 68 6f 64 20 63 72 65 61 74 65 73 20   method creates 
7fc0: 61 20 42 4c 4f 42 20 77 68 69 63 68 20 69 73 20  a BLOB which is 
7fd0: 61 20 63 6f 6d 70 6c 65 74 65 20 63 6f 70 79 20  a complete copy 
7fe0: 6f 66 20 61 6e 0a 75 6e 64 65 72 6c 79 69 6e 67  of an.underlying
7ff0: 20 64 61 74 61 62 61 73 65 2e 20 20 54 68 65 20   database.  The 
8000: 73 79 6e 74 61 78 20 69 73 20 6c 69 6b 65 20 74  syntax is like t
8010: 68 69 73 3a 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74  his:..<blockquot
8020: 65 3e 0a 3c 69 3e 64 62 63 6d 64 3c 2f 69 3e 26  e>.<i>dbcmd</i>&
8030: 6e 62 73 70 3b 26 6e 62 73 70 3b 3c 62 3e 73 65  nbsp;&nbsp;<b>se
8040: 72 69 61 6c 69 7a 65 3c 2f 62 3e 26 6e 62 73 70  rialize</b>&nbsp
8050: 3b 26 6e 62 73 70 3b 3f 3c 69 3e 64 61 74 61 62  ;&nbsp;?<i>datab
8060: 61 73 65 3c 2f 69 3e 3f 0a 3c 2f 62 6c 6f 63 6b  ase</i>?.</block
8070: 71 75 6f 74 65 3e 0a 0a 3c 70 3e 54 68 65 20 6f  quote>..<p>The o
8080: 70 74 69 6f 6e 61 6c 20 61 72 67 75 6d 65 6e 74  ptional argument
8090: 20 69 73 20 74 68 65 20 6e 61 6d 65 20 6f 66 20   is the name of 
80a0: 74 68 65 20 73 63 68 65 6d 61 20 6f 72 20 64 61  the schema or da
80b0: 74 61 62 61 73 65 20 74 6f 20 62 65 20 73 65 72  tabase to be ser
80c0: 69 61 6c 69 7a 65 64 2e 0a 54 68 65 20 64 65 66  ialized..The def
80d0: 61 75 6c 74 20 76 61 6c 75 65 20 69 73 20 22 6d  ault value is "m
80e0: 61 69 6e 22 2e 0a 0a 3c 70 3e 54 68 69 73 20 72  ain"...<p>This r
80f0: 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73 20 61  outine returns a
8100: 20 54 43 4c 20 62 79 74 65 2d 61 72 72 61 79 20   TCL byte-array 
8110: 74 68 61 74 20 69 73 20 74 68 65 20 63 6f 6d 70  that is the comp
8120: 6c 65 74 65 20 63 6f 6e 74 65 6e 74 20 6f 66 0a  lete content of.
8130: 74 68 65 20 69 64 65 6e 74 69 66 69 65 64 20 64  the identified d
8140: 61 74 61 62 61 73 65 2e 20 20 54 68 69 73 20 62  atabase.  This b
8150: 79 74 65 2d 61 72 72 61 79 20 63 61 6e 20 62 65  yte-array can be
8160: 20 77 72 69 74 74 65 6e 20 69 6e 74 6f 20 61 20   written into a 
8170: 66 69 6c 65 20 61 6e 64 0a 74 68 65 6e 20 75 73  file and.then us
8180: 65 64 20 61 73 20 61 6e 20 6f 72 64 69 6e 61 72  ed as an ordinar
8190: 79 20 53 51 4c 69 74 65 20 64 61 74 61 62 61 73  y SQLite databas
81a0: 65 2c 20 6f 72 20 69 74 20 63 61 6e 20 62 65 20  e, or it can be 
81b0: 73 65 6e 74 20 6f 76 65 72 20 61 20 54 43 50 2f  sent over a TCP/
81c0: 49 50 0a 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 6f  IP.connection to
81d0: 20 73 6f 6d 65 20 6f 74 68 65 72 20 61 70 70 6c   some other appl
81e0: 69 63 61 74 69 6f 6e 2c 20 6f 72 20 70 61 73 73  ication, or pass
81f0: 65 64 20 74 6f 20 74 68 65 20 22 64 65 73 65 72  ed to the "deser
8200: 69 61 6c 69 7a 65 22 20 6d 65 74 68 6f 64 0a 6f  ialize" method.o
8210: 66 20 61 6e 6f 74 68 65 72 20 64 61 74 61 62 61  f another databa
8220: 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e 0a 0a  se connection...
8230: 3c 70 3e 54 68 69 73 20 6d 65 74 68 6f 64 20 6f  <p>This method o
8240: 6e 6c 79 20 66 75 6e 63 74 69 6f 6e 73 20 69 66  nly functions if
8250: 20 53 51 4c 69 74 65 20 69 73 20 63 6f 6d 70 69   SQLite is compi
8260: 6c 65 64 20 77 69 74 68 20 2d 44 53 51 4c 49 54  led with -DSQLIT
8270: 45 5f 45 4e 41 42 4c 45 5f 44 45 53 45 52 49 41  E_ENABLE_DESERIA
8280: 4c 49 5a 45 0a 7d 0a 0a 23 23 23 23 23 23 23 23  LIZE.}..########
8290: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
82a0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
82b0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
82c0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
82d0: 23 23 23 23 23 23 0a 4d 45 54 48 4f 44 20 64 65  ######.METHOD de
82e0: 73 65 72 69 61 6c 69 7a 65 20 7b 0a 3c 70 3e 54  serialize {.<p>T
82f0: 68 65 20 22 64 65 73 65 72 69 61 6c 69 7a 65 22  he "deserialize"
8300: 20 6d 65 74 68 6f 64 20 74 61 6b 65 73 20 61 20   method takes a 
8310: 54 43 4c 20 62 79 74 65 2d 61 72 72 61 79 20 74  TCL byte-array t
8320: 68 61 74 20 63 6f 6e 74 61 69 6e 73 20 61 6e 20  hat contains an 
8330: 53 51 4c 69 74 65 0a 64 61 74 61 62 61 73 65 20  SQLite.database 
8340: 66 69 6c 65 20 61 6e 64 20 61 64 64 73 20 69 74  file and adds it
8350: 20 74 6f 20 74 68 65 20 64 61 74 61 62 61 73 65   to the database
8360: 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e 20 20 54 68   connection.  Th
8370: 65 20 73 79 6e 74 61 78 20 69 73 3a 0a 0a 3c 62  e syntax is:..<b
8380: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c 69 3e 64 62  lockquote>.<i>db
8390: 63 6d 64 3c 2f 69 3e 26 6e 62 73 70 3b 26 6e 62  cmd</i>&nbsp;&nb
83a0: 73 70 3b 3c 62 3e 64 65 73 65 72 69 61 6c 69 7a  sp;<b>deserializ
83b0: 65 3c 2f 62 3e 26 6e 62 73 70 3b 26 6e 62 73 70  e</b>&nbsp;&nbsp
83c0: 3b 3f 3c 69 3e 64 61 74 61 62 61 73 65 3c 2f 69  ;?<i>database</i
83d0: 3e 3f 26 6e 62 73 70 3b 26 6e 62 73 70 3b 3c 69  >?&nbsp;&nbsp;<i
83e0: 3e 76 61 6c 75 65 3c 2f 69 3e 0a 3c 2f 62 6c 6f  >value</i>.</blo
83f0: 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 54 68 65  ckquote>..<p>The
8400: 20 6f 70 74 69 6f 6e 20 3c 69 3e 64 61 74 61 62   option <i>datab
8410: 61 73 65 3c 2f 69 3e 20 61 72 67 75 6d 65 6e 74  ase</i> argument
8420: 20 69 64 65 6e 74 69 66 69 65 73 20 77 68 69 63   identifies whic
8430: 68 20 61 74 74 61 63 68 65 64 20 64 61 74 61 62  h attached datab
8440: 61 73 65 0a 73 68 6f 75 6c 64 20 72 65 63 65 69  ase.should recei
8450: 76 65 20 74 68 65 20 64 65 73 65 72 69 61 6c 69  ve the deseriali
8460: 7a 61 74 69 6f 6e 2e 20 20 54 68 65 20 64 65 66  zation.  The def
8470: 61 75 6c 74 20 69 73 20 22 6d 61 69 6e 22 2e 0a  ault is "main"..
8480: 0a 3c 70 3e 54 68 69 73 20 63 6f 6d 6d 61 6e 64  .<p>This command
8490: 20 63 61 75 73 65 73 20 53 51 4c 69 74 65 20 74   causes SQLite t
84a0: 6f 20 64 69 73 63 6f 6e 6e 65 63 74 20 66 72 6f  o disconnect fro
84b0: 6d 20 74 68 65 20 70 72 65 76 69 6f 75 73 20 64  m the previous d
84c0: 61 74 61 62 61 73 65 20 61 6e 64 0a 72 65 61 74  atabase and.reat
84d0: 74 61 63 68 20 74 6f 20 61 6e 20 69 6e 2d 6d 65  tach to an in-me
84e0: 6d 6f 72 79 20 64 61 74 61 62 61 73 65 20 77 69  mory database wi
84f0: 74 68 20 74 68 65 20 63 6f 6e 74 65 6e 74 20 69  th the content i
8500: 6e 20 3c 69 3e 76 61 6c 75 65 3c 2f 69 3e 2e 20  n <i>value</i>. 
8510: 20 49 66 20 3c 69 3e 76 61 6c 75 65 3c 2f 69 3e   If <i>value</i>
8520: 0a 69 73 20 6e 6f 74 20 61 20 62 79 74 65 2d 61  .is not a byte-a
8530: 72 72 61 79 20 63 6f 6e 74 61 69 6e 69 6e 67 20  rray containing 
8540: 61 20 77 65 6c 6c 2d 64 65 66 69 6e 65 64 20 53  a well-defined S
8550: 51 4c 69 74 65 20 64 61 74 61 62 61 73 65 2c 20  QLite database, 
8560: 74 68 65 6e 20 73 75 62 73 65 71 75 65 6e 74 0a  then subsequent.
8570: 63 6f 6d 6d 61 6e 64 73 20 77 69 6c 6c 20 6c 69  commands will li
8580: 6b 65 6c 79 20 72 65 74 75 72 6e 20 5b 53 51 4c  kely return [SQL
8590: 49 54 45 5f 43 4f 52 52 55 50 54 5d 20 65 72 72  ITE_CORRUPT] err
85a0: 6f 72 73 2e 0a 0a 3c 70 3e 54 68 69 73 20 6d 65  ors...<p>This me
85b0: 74 68 6f 64 20 6f 6e 6c 79 20 66 75 6e 63 74 69  thod only functi
85c0: 6f 6e 73 20 69 66 20 53 51 4c 69 74 65 20 69 73  ons if SQLite is
85d0: 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 2d   compiled with -
85e0: 44 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 44  DSQLITE_ENABLE_D
85f0: 45 53 45 52 49 41 4c 49 5a 45 0a 7d 0a 0a 23 23  ESERIALIZE.}..##
8600: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
8610: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
8620: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
8630: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
8640: 23 23 23 23 23 23 23 23 23 23 23 23 0a 4d 45 54  ############.MET
8650: 48 4f 44 20 69 6e 74 65 72 72 75 70 74 20 7b 0a  HOD interrupt {.
8660: 3c 70 3e 54 68 65 20 22 69 6e 74 65 72 72 75 70  <p>The "interrup
8670: 74 22 20 6d 65 74 68 6f 64 20 69 6e 76 6f 6b 65  t" method invoke
8680: 73 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 69  s the [sqlite3_i
8690: 6e 74 65 72 72 75 70 74 28 29 5d 20 69 6e 74 65  nterrupt()] inte
86a0: 72 66 61 63 65 2c 20 63 61 75 73 69 6e 67 0a 61  rface, causing.a
86b0: 6e 79 20 70 65 6e 64 69 6e 67 20 71 75 65 72 69  ny pending queri
86c0: 65 73 20 74 6f 20 68 61 6c 74 2e 0a 7d 0a 0a 23  es to halt..}..#
86d0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
86e0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
86f0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
8700: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
8710: 23 23 23 23 23 23 23 23 23 23 23 23 23 0a 4d 45  #############.ME
8720: 54 48 4f 44 20 76 65 72 73 69 6f 6e 20 7b 0a 20  THOD version {. 
8730: 20 52 65 74 75 72 6e 20 74 68 65 20 63 75 72 72   Return the curr
8740: 65 6e 74 20 6c 69 62 72 61 72 79 20 76 65 72 73  ent library vers
8750: 69 6f 6e 2e 20 46 6f 72 20 65 78 61 6d 70 6c 65  ion. For example
8760: 2c 20 22 33 2e 32 33 2e 30 22 2e 0a 7d 0a 0a 23  , "3.23.0"..}..#
8770: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
8780: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
8790: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
87a0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
87b0: 23 23 23 23 23 23 23 23 23 23 23 23 23 0a 4d 45  #############.ME
87c0: 54 48 4f 44 20 70 72 6f 66 69 6c 65 20 7b 0a 3c  THOD profile {.<
87d0: 70 3e 54 68 69 73 20 6d 65 74 68 6f 64 20 69 73  p>This method is
87e0: 20 75 73 65 64 20 74 6f 20 70 72 6f 66 69 6c 65   used to profile
87f0: 20 74 68 65 20 65 78 65 63 75 74 69 6f 6e 20 6f   the execution o
8800: 66 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73  f SQL statements
8810: 20 72 75 6e 20 62 79 0a 20 20 20 74 68 65 20 61   run by.   the a
8820: 70 70 6c 69 63 61 74 69 6f 6e 2e 20 54 68 65 20  pplication. The 
8830: 73 79 6e 74 61 78 20 69 73 20 61 73 20 66 6f 6c  syntax is as fol
8840: 6c 6f 77 73 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f  lows:.</p>..<blo
8850: 63 6b 71 75 6f 74 65 3e 0a 3c 69 3e 64 62 63 6d  ckquote>.<i>dbcm
8860: 64 3c 2f 69 3e 26 6e 62 73 70 3b 26 6e 62 73 70  d</i>&nbsp;&nbsp
8870: 3b 3c 62 3e 70 72 6f 66 69 6c 65 3c 2f 62 3e 26  ;<b>profile</b>&
8880: 6e 62 73 70 3b 26 6e 62 73 70 3b 3f 3c 69 3e 73  nbsp;&nbsp;?<i>s
8890: 63 72 69 70 74 3c 2f 69 3e 3f 0a 3c 2f 62 6c 6f  cript</i>?.</blo
88a0: 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 55 6e 6c  ckquote>..<p>Unl
88b0: 65 73 73 20 3c 69 3e 73 63 72 69 70 74 3c 2f 69  ess <i>script</i
88c0: 3e 20 69 73 20 61 6e 20 65 6d 70 74 79 20 73 74  > is an empty st
88d0: 72 69 6e 67 2c 20 74 68 69 73 20 6d 65 74 68 6f  ring, this metho
88e0: 64 20 61 72 72 61 6e 67 65 73 20 66 6f 72 20 74  d arranges for t
88f0: 68 65 0a 3c 69 3e 73 63 72 69 70 74 3c 2f 69 3e  he.<i>script</i>
8900: 20 74 6f 20 62 65 20 65 76 61 6c 75 61 74 65 64   to be evaluated
8910: 20 61 66 74 65 72 20 74 68 65 20 65 78 65 63 75   after the execu
8920: 74 69 6f 6e 20 6f 66 20 65 61 63 68 20 53 51 4c  tion of each SQL
8930: 20 73 74 61 74 65 6d 65 6e 74 2e 0a 54 77 6f 20   statement..Two 
8940: 61 72 67 75 6d 65 6e 74 73 20 61 72 65 20 61 70  arguments are ap
8950: 70 65 6e 64 65 64 20 74 6f 20 3c 69 3e 73 63 72  pended to <i>scr
8960: 69 70 74 3c 2f 69 3e 20 62 65 66 6f 72 65 20 69  ipt</i> before i
8970: 74 20 69 73 20 69 6e 76 6f 6b 65 64 3a 20 74 68  t is invoked: th
8980: 65 0a 74 65 78 74 20 6f 66 20 74 68 65 20 53 51  e.text of the SQ
8990: 4c 20 73 74 61 74 65 6d 65 6e 74 20 65 78 65 63  L statement exec
89a0: 75 74 65 64 20 61 6e 64 20 74 68 65 20 74 69 6d  uted and the tim
89b0: 65 20 65 6c 61 70 73 65 64 20 77 68 69 6c 65 20  e elapsed while 
89c0: 65 78 65 63 75 74 69 6e 67 0a 74 68 65 20 73 74  executing.the st
89d0: 61 74 65 6d 65 6e 74 2c 20 69 6e 20 6e 61 6e 6f  atement, in nano
89e0: 73 65 63 6f 6e 64 73 2e 0a 3c 2f 70 3e 0a 3c 70  seconds..</p>.<p
89f0: 3e 41 20 64 61 74 61 62 61 73 65 20 68 61 6e 64  >A database hand
8a00: 6c 65 20 6d 61 79 20 6f 6e 6c 79 20 68 61 76 65  le may only have
8a10: 20 61 20 73 69 6e 67 6c 65 20 70 72 6f 66 69 6c   a single profil
8a20: 65 20 73 63 72 69 70 74 20 72 65 67 69 73 74 65  e script registe
8a30: 72 65 64 20 61 74 0a 61 6e 79 20 74 69 6d 65 2e  red at.any time.
8a40: 20 49 66 20 74 68 65 72 65 20 69 73 20 61 6c 72   If there is alr
8a50: 65 61 64 79 20 61 20 73 63 72 69 70 74 20 72 65  eady a script re
8a60: 67 69 73 74 65 72 65 64 20 77 68 65 6e 20 74 68  gistered when th
8a70: 65 20 70 72 6f 66 69 6c 65 20 6d 65 74 68 6f 64  e profile method
8a80: 0a 69 73 20 69 6e 76 6f 6b 65 64 2c 20 74 68 65  .is invoked, the
8a90: 20 70 72 65 76 69 6f 75 73 20 70 72 6f 66 69 6c   previous profil
8aa0: 65 20 73 63 72 69 70 74 20 69 73 20 72 65 70 6c  e script is repl
8ab0: 61 63 65 64 20 62 79 20 74 68 65 20 6e 65 77 20  aced by the new 
8ac0: 6f 6e 65 2e 20 49 66 20 74 68 65 20 0a 3c 69 3e  one. If the .<i>
8ad0: 73 63 72 69 70 74 3c 2f 69 3e 20 61 72 67 75 6d  script</i> argum
8ae0: 65 6e 74 20 69 73 20 61 6e 20 65 6d 70 74 79 20  ent is an empty 
8af0: 73 74 72 69 6e 67 2c 20 61 6e 79 20 70 72 65 76  string, any prev
8b00: 69 6f 75 73 6c 79 20 72 65 67 69 73 74 65 72 65  iously registere
8b10: 64 20 0a 70 72 6f 66 69 6c 65 20 63 61 6c 6c 62  d .profile callb
8b20: 61 63 6b 20 69 73 20 63 61 6e 63 65 6c 65 64 20  ack is canceled 
8b30: 62 75 74 20 6e 6f 20 6e 65 77 20 70 72 6f 66 69  but no new profi
8b40: 6c 65 20 73 63 72 69 70 74 20 69 73 20 72 65 67  le script is reg
8b50: 69 73 74 65 72 65 64 2e 0a 3c 2f 70 3e 0a 7d 0a  istered..</p>.}.
8b60: 0a 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  .###############
8b70: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
8b80: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
8b90: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
8ba0: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 0a  ###############.
8bb0: 4d 45 54 48 4f 44 20 75 6e 6c 6f 63 6b 5f 6e 6f  METHOD unlock_no
8bc0: 74 69 66 79 20 7b 0a 3c 70 3e 54 68 65 20 75 6e  tify {.<p>The un
8bd0: 6c 6f 63 6b 5f 6e 6f 74 69 66 79 20 6d 65 74 68  lock_notify meth
8be0: 6f 64 20 69 73 20 75 73 65 64 20 61 63 63 65 73  od is used acces
8bf0: 73 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 75  s the [sqlite3_u
8c00: 6e 6c 6f 63 6b 5f 6e 6f 74 69 66 79 28 29 5d 0a  nlock_notify()].
8c10: 20 20 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20     interface to 
8c20: 74 68 65 20 53 51 4c 69 74 65 20 63 6f 72 65 20  the SQLite core 
8c30: 6c 69 62 72 61 72 79 20 66 6f 72 20 74 65 73 74  library for test
8c40: 69 6e 67 20 70 75 72 70 6f 73 65 73 2e 20 20 54  ing purposes.  T
8c50: 68 65 20 75 73 65 20 6f 66 0a 20 20 20 74 68 69  he use of.   thi
8c60: 73 20 6d 65 74 68 6f 64 20 62 79 20 61 70 70 6c  s method by appl
8c70: 69 63 61 74 69 6f 6e 73 20 69 73 20 64 69 73 63  ications is disc
8c80: 6f 75 72 61 67 65 64 2e 0a 3c 2f 70 3e 0a 7d 0a  ouraged..</p>.}.
8c90: 0a 0a 0a 3c 2f 74 63 6c 3e 0a                    ...</tcl>.