/ Hex Artifact Content
Login

Artifact 59338ef6b9d6cff504659010a361e863f554b0ef:


0000: 23 0a 23 20 52 75 6e 20 74 68 69 73 20 54 63 6c  #.# Run this Tcl
0010: 20 73 63 72 69 70 74 20 74 6f 20 67 65 6e 65 72   script to gener
0020: 61 74 65 20 74 68 65 20 73 71 6c 69 74 65 2e 68  ate the sqlite.h
0030: 74 6d 6c 20 66 69 6c 65 2e 0a 23 0a 73 65 74 20  tml file..#.set 
0040: 72 63 73 69 64 20 7b 24 49 64 3a 20 63 5f 69 6e  rcsid {$Id: c_in
0050: 74 65 72 66 61 63 65 2e 74 63 6c 2c 76 20 31 2e  terface.tcl,v 1.
0060: 33 32 20 32 30 30 32 2f 30 37 2f 33 30 20 31 37  32 2002/07/30 17
0070: 3a 34 32 3a 31 30 20 64 72 68 20 45 78 70 20 24  :42:10 drh Exp $
0080: 7d 0a 0a 70 75 74 73 20 7b 3c 68 74 6d 6c 3e 0a  }..puts {<html>.
0090: 3c 68 65 61 64 3e 0a 20 20 3c 74 69 74 6c 65 3e  <head>.  <title>
00a0: 54 68 65 20 43 20 6c 61 6e 67 75 61 67 65 20 69  The C language i
00b0: 6e 74 65 72 66 61 63 65 20 74 6f 20 74 68 65 20  nterface to the 
00c0: 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79 3c 2f  SQLite library</
00d0: 74 69 74 6c 65 3e 0a 3c 2f 68 65 61 64 3e 0a 3c  title>.</head>.<
00e0: 62 6f 64 79 20 62 67 63 6f 6c 6f 72 3d 77 68 69  body bgcolor=whi
00f0: 74 65 3e 0a 3c 68 31 20 61 6c 69 67 6e 3d 63 65  te>.<h1 align=ce
0100: 6e 74 65 72 3e 0a 54 68 65 20 43 20 6c 61 6e 67  nter>.The C lang
0110: 75 61 67 65 20 69 6e 74 65 72 66 61 63 65 20 74  uage interface t
0120: 6f 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62  o the SQLite lib
0130: 72 61 72 79 0a 3c 2f 68 31 3e 7d 0a 70 75 74 73  rary.</h1>}.puts
0140: 20 22 3c 70 20 61 6c 69 67 6e 3d 63 65 6e 74 65   "<p align=cente
0150: 72 3e 0a 28 54 68 69 73 20 70 61 67 65 20 77 61  r>.(This page wa
0160: 73 20 6c 61 73 74 20 6d 6f 64 69 66 69 65 64 20  s last modified 
0170: 6f 6e 20 5b 6c 72 61 6e 67 65 20 24 72 63 73 69  on [lrange $rcsi
0180: 64 20 33 20 34 5d 20 55 54 43 29 0a 3c 2f 70 3e  d 3 4] UTC).</p>
0190: 22 0a 0a 70 75 74 73 20 7b 0a 3c 70 3e 54 68 65  "..puts {.<p>The
01a0: 20 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79 20   SQLite library 
01b0: 69 73 20 64 65 73 69 67 6e 65 64 20 74 6f 20 62  is designed to b
01c0: 65 20 76 65 72 79 20 65 61 73 79 20 74 6f 20 75  e very easy to u
01d0: 73 65 20 66 72 6f 6d 0a 61 20 43 20 6f 72 20 43  se from.a C or C
01e0: 2b 2b 20 70 72 6f 67 72 61 6d 2e 20 20 54 68 69  ++ program.  Thi
01f0: 73 20 64 6f 63 75 6d 65 6e 74 20 67 69 76 65 73  s document gives
0200: 20 61 6e 20 6f 76 65 72 76 69 65 77 20 6f 66 20   an overview of 
0210: 74 68 65 20 43 2f 43 2b 2b 0a 70 72 6f 67 72 61  the C/C++.progra
0220: 6d 6d 69 6e 67 20 69 6e 74 65 72 66 61 63 65 2e  mming interface.
0230: 3c 2f 70 3e 0a 0a 3c 68 32 3e 54 68 65 20 43 6f  </p>..<h2>The Co
0240: 72 65 20 41 50 49 3c 2f 68 32 3e 0a 0a 3c 70 3e  re API</h2>..<p>
0250: 54 68 65 20 69 6e 74 65 72 66 61 63 65 20 74 6f  The interface to
0260: 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62 72   the SQLite libr
0270: 61 72 79 20 63 6f 6e 73 69 73 74 73 20 6f 66 20  ary consists of 
0280: 74 68 72 65 65 20 63 6f 72 65 20 66 75 6e 63 74  three core funct
0290: 69 6f 6e 73 2c 0a 6f 6e 65 20 6f 70 61 71 75 65  ions,.one opaque
02a0: 20 64 61 74 61 20 73 74 72 75 63 74 75 72 65 2c   data structure,
02b0: 20 61 6e 64 20 73 6f 6d 65 20 63 6f 6e 73 74 61   and some consta
02c0: 6e 74 73 20 75 73 65 64 20 61 73 20 72 65 74 75  nts used as retu
02d0: 72 6e 20 76 61 6c 75 65 73 2e 0a 54 68 65 20 63  rn values..The c
02e0: 6f 72 65 20 69 6e 74 65 72 66 61 63 65 20 69 73  ore interface is
02f0: 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 3c 2f 70 3e   as follows:</p>
0300: 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70  ..<blockquote><p
0310: 72 65 3e 0a 74 79 70 65 64 65 66 20 73 74 72 75  re>.typedef stru
0320: 63 74 20 73 71 6c 69 74 65 20 73 71 6c 69 74 65  ct sqlite sqlite
0330: 3b 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  ;.#define SQLITE
0340: 5f 4f 4b 20 20 20 20 20 20 20 20 20 20 20 30 20  _OK           0 
0350: 20 20 2f 2a 20 53 75 63 63 65 73 73 66 75 6c 20    /* Successful 
0360: 72 65 73 75 6c 74 20 2a 2f 0a 0a 73 71 6c 69 74  result */..sqlit
0370: 65 20 2a 73 71 6c 69 74 65 5f 6f 70 65 6e 28 63  e *sqlite_open(c
0380: 6f 6e 73 74 20 63 68 61 72 20 2a 64 62 6e 61 6d  onst char *dbnam
0390: 65 2c 20 69 6e 74 20 6d 6f 64 65 2c 20 63 68 61  e, int mode, cha
03a0: 72 20 2a 2a 65 72 72 6d 73 67 29 3b 0a 0a 76 6f  r **errmsg);..vo
03b0: 69 64 20 73 71 6c 69 74 65 5f 63 6c 6f 73 65 28  id sqlite_close(
03c0: 73 71 6c 69 74 65 2a 29 3b 0a 0a 69 6e 74 20 73  sqlite*);..int s
03d0: 71 6c 69 74 65 5f 65 78 65 63 28 0a 20 20 73 71  qlite_exec(.  sq
03e0: 6c 69 74 65 2a 2c 0a 20 20 63 68 61 72 20 2a 73  lite*,.  char *s
03f0: 71 6c 2c 0a 20 20 69 6e 74 20 28 2a 29 28 76 6f  ql,.  int (*)(vo
0400: 69 64 2a 2c 69 6e 74 2c 63 68 61 72 2a 2a 2c 63  id*,int,char**,c
0410: 68 61 72 2a 2a 29 2c 0a 20 20 76 6f 69 64 2a 2c  har**),.  void*,
0420: 0a 20 20 63 68 61 72 20 2a 2a 65 72 72 6d 73 67  .  char **errmsg
0430: 0a 29 3b 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63  .);.</pre></bloc
0440: 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 0a 54 68 65  kquote>..<p>.The
0450: 20 61 62 6f 76 65 20 69 73 20 61 6c 6c 20 79 6f   above is all yo
0460: 75 20 72 65 61 6c 6c 79 20 6e 65 65 64 20 74 6f  u really need to
0470: 20 6b 6e 6f 77 20 69 6e 20 6f 72 64 65 72 20 74   know in order t
0480: 6f 20 75 73 65 20 53 51 4c 69 74 65 0a 69 6e 20  o use SQLite.in 
0490: 79 6f 75 72 20 43 20 6f 72 20 43 2b 2b 20 70 72  your C or C++ pr
04a0: 6f 67 72 61 6d 73 2e 20 20 54 68 65 72 65 20 61  ograms.  There a
04b0: 72 65 20 6f 74 68 65 72 20 63 6f 6e 76 65 6e 69  re other conveni
04c0: 65 6e 63 65 20 66 75 6e 63 74 69 6f 6e 73 0a 61  ence functions.a
04d0: 76 61 69 6c 61 62 6c 65 20 28 61 6e 64 20 64 65  vailable (and de
04e0: 73 63 72 69 62 65 64 20 62 65 6c 6f 77 29 20 62  scribed below) b
04f0: 75 74 20 77 65 20 77 69 6c 6c 20 62 65 67 69 6e  ut we will begin
0500: 20 62 79 20 64 65 73 63 72 69 62 69 6e 67 0a 74   by describing.t
0510: 68 65 20 63 6f 72 65 20 66 75 6e 63 74 69 6f 6e  he core function
0520: 73 20 73 68 6f 77 6e 20 61 62 6f 76 65 2e 0a 3c  s shown above..<
0530: 2f 70 3e 0a 3c 68 32 3e 4f 70 65 6e 69 6e 67 20  /p>.<h2>Opening 
0540: 61 20 64 61 74 61 62 61 73 65 3c 2f 68 32 3e 0a  a database</h2>.
0550: 0a 3c 70 3e 55 73 65 20 74 68 65 20 3c 62 3e 73  .<p>Use the <b>s
0560: 71 6c 69 74 65 5f 6f 70 65 6e 28 29 3c 2f 62 3e  qlite_open()</b>
0570: 20 66 75 6e 63 74 69 6f 6e 20 74 6f 20 6f 70 65   function to ope
0580: 6e 20 61 6e 20 65 78 69 73 74 69 6e 67 20 53 51  n an existing SQ
0590: 4c 69 74 65 0a 64 61 74 61 62 61 73 65 20 6f 72  Lite.database or
05a0: 20 74 6f 20 63 72 65 61 74 65 20 61 20 6e 65 77   to create a new
05b0: 20 53 51 4c 69 74 65 20 64 61 74 61 62 61 73 65   SQLite database
05c0: 2e 20 20 54 68 65 20 66 69 72 73 74 20 61 72 67  .  The first arg
05d0: 75 6d 65 6e 74 0a 69 73 20 74 68 65 20 64 61 74  ument.is the dat
05e0: 61 62 61 73 65 20 6e 61 6d 65 2e 20 20 54 68 65  abase name.  The
05f0: 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74   second argument
0600: 20 69 73 20 69 6e 74 65 6e 64 65 64 20 74 6f 20   is intended to 
0610: 73 69 67 6e 61 6c 0a 77 68 65 74 68 65 72 20 74  signal.whether t
0620: 68 65 20 64 61 74 61 62 61 73 65 20 69 73 20 67  he database is g
0630: 6f 69 6e 67 20 74 6f 20 62 65 20 75 73 65 64 20  oing to be used 
0640: 66 6f 72 20 72 65 61 64 69 6e 67 20 61 6e 64 20  for reading and 
0650: 77 72 69 74 69 6e 67 0a 6f 72 20 6a 75 73 74 20  writing.or just 
0660: 66 6f 72 20 72 65 61 64 69 6e 67 2e 20 20 42 75  for reading.  Bu
0670: 74 20 69 6e 20 74 68 65 20 63 75 72 72 65 6e 74  t in the current
0680: 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 2c   implementation,
0690: 20 74 68 65 0a 73 65 63 6f 6e 64 20 61 72 67 75   the.second argu
06a0: 6d 65 6e 74 20 74 6f 20 3c 62 3e 73 71 6c 69 74  ment to <b>sqlit
06b0: 65 5f 6f 70 65 6e 3c 2f 62 3e 20 69 73 20 69 67  e_open</b> is ig
06c0: 6e 6f 72 65 64 2e 0a 54 68 65 20 74 68 69 72 64  nored..The third
06d0: 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 20 70   argument is a p
06e0: 6f 69 6e 74 65 72 20 74 6f 20 61 20 73 74 72 69  ointer to a stri
06f0: 6e 67 20 70 6f 69 6e 74 65 72 2e 0a 49 66 20 74  ng pointer..If t
0700: 68 65 20 74 68 69 72 64 20 61 72 67 75 6d 65 6e  he third argumen
0710: 74 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 20 61 6e  t is not NULL an
0720: 64 20 61 6e 20 65 72 72 6f 72 20 6f 63 63 75 72  d an error occur
0730: 73 0a 77 68 69 6c 65 20 74 72 79 69 6e 67 20 74  s.while trying t
0740: 6f 20 6f 70 65 6e 20 74 68 65 20 64 61 74 61 62  o open the datab
0750: 61 73 65 2c 20 74 68 65 6e 20 61 6e 20 65 72 72  ase, then an err
0760: 6f 72 20 6d 65 73 73 61 67 65 20 77 69 6c 6c 20  or message will 
0770: 62 65 0a 77 72 69 74 74 65 6e 20 74 6f 20 6d 65  be.written to me
0780: 6d 6f 72 79 20 6f 62 74 61 69 6e 65 64 20 66 72  mory obtained fr
0790: 6f 6d 20 6d 61 6c 6c 6f 63 28 29 20 61 6e 64 20  om malloc() and 
07a0: 2a 65 72 72 6d 73 67 20 77 69 6c 6c 20 62 65 20  *errmsg will be 
07b0: 6d 61 64 65 0a 74 6f 20 70 6f 69 6e 74 20 74 6f  made.to point to
07c0: 20 74 68 69 73 20 65 72 72 6f 72 20 6d 65 73 73   this error mess
07d0: 61 67 65 2e 20 20 54 68 65 20 63 61 6c 6c 69 6e  age.  The callin
07e0: 67 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 72 65  g function is re
07f0: 73 70 6f 6e 73 69 62 6c 65 0a 66 6f 72 20 66 72  sponsible.for fr
0800: 65 65 69 6e 67 20 74 68 65 20 6d 65 6d 6f 72 79  eeing the memory
0810: 20 77 68 65 6e 20 69 74 20 68 61 73 20 66 69 6e   when it has fin
0820: 69 73 68 65 64 20 77 69 74 68 20 69 74 2e 3c 2f  ished with it.</
0830: 70 3e 0a 0a 3c 70 3e 54 68 65 20 6e 61 6d 65 20  p>..<p>The name 
0840: 6f 66 20 61 6e 20 53 51 4c 69 74 65 20 64 61 74  of an SQLite dat
0850: 61 62 61 73 65 20 69 73 20 74 68 65 20 6e 61 6d  abase is the nam
0860: 65 20 6f 66 20 61 20 66 69 6c 65 20 74 68 61 74  e of a file that
0870: 20 77 69 6c 6c 0a 63 6f 6e 74 61 69 6e 20 74 68   will.contain th
0880: 65 20 64 61 74 61 62 61 73 65 2e 20 20 49 66 20  e database.  If 
0890: 74 68 65 20 66 69 6c 65 20 64 6f 65 73 20 6e 6f  the file does no
08a0: 74 20 65 78 69 73 74 2c 20 53 51 4c 69 74 65 20  t exist, SQLite 
08b0: 61 74 74 65 6d 70 74 73 0a 74 6f 20 63 72 65 61  attempts.to crea
08c0: 74 65 20 61 6e 64 20 69 6e 69 74 69 61 6c 69 7a  te and initializ
08d0: 65 20 69 74 2e 20 20 49 66 20 74 68 65 20 66 69  e it.  If the fi
08e0: 6c 65 20 69 73 20 72 65 61 64 2d 6f 6e 6c 79 20  le is read-only 
08f0: 28 64 75 65 20 74 6f 0a 70 65 72 6d 69 73 73 69  (due to.permissi
0900: 6f 6e 20 62 69 74 73 20 6f 72 20 62 65 63 61 75  on bits or becau
0910: 73 65 20 69 74 20 69 73 20 6c 6f 63 61 74 65 64  se it is located
0920: 20 6f 6e 20 72 65 61 64 2d 6f 6e 6c 79 20 6d 65   on read-only me
0930: 64 69 61 20 6c 69 6b 65 0a 61 20 43 44 2d 52 4f  dia like.a CD-RO
0940: 4d 29 20 74 68 65 6e 20 53 51 4c 69 74 65 20 6f  M) then SQLite o
0950: 70 65 6e 73 20 74 68 65 20 64 61 74 61 62 61 73  pens the databas
0960: 65 20 66 6f 72 20 72 65 61 64 69 6e 67 20 6f 6e  e for reading on
0970: 6c 79 2e 20 20 54 68 65 0a 65 6e 74 69 72 65 20  ly.  The.entire 
0980: 53 51 4c 20 64 61 74 61 62 61 73 65 20 69 73 20  SQL database is 
0990: 73 74 6f 72 65 64 20 69 6e 20 61 20 73 69 6e 67  stored in a sing
09a0: 6c 65 20 66 69 6c 65 20 6f 6e 20 74 68 65 20 64  le file on the d
09b0: 69 73 6b 2e 20 20 42 75 74 0a 61 64 64 69 74 69  isk.  But.additi
09c0: 6f 6e 61 6c 20 74 65 6d 70 6f 72 61 72 79 20 66  onal temporary f
09d0: 69 6c 65 73 20 6d 61 79 20 62 65 20 63 72 65 61  iles may be crea
09e0: 74 65 64 20 64 75 72 69 6e 67 20 74 68 65 20 65  ted during the e
09f0: 78 65 63 75 74 69 6f 6e 20 6f 66 0a 61 6e 20 53  xecution of.an S
0a00: 51 4c 20 63 6f 6d 6d 61 6e 64 20 69 6e 20 6f 72  QL command in or
0a10: 64 65 72 20 74 6f 20 73 74 6f 72 65 20 74 68 65  der to store the
0a20: 20 64 61 74 61 62 61 73 65 20 72 6f 6c 6c 62 61   database rollba
0a30: 63 6b 20 6a 6f 75 72 6e 61 6c 20 6f 72 0a 74 65  ck journal or.te
0a40: 6d 70 6f 72 61 72 79 20 61 6e 64 20 69 6e 74 65  mporary and inte
0a50: 72 6d 65 64 69 61 74 65 20 72 65 73 75 6c 74 73  rmediate results
0a60: 20 6f 66 20 61 20 71 75 65 72 79 2e 3c 2f 70 3e   of a query.</p>
0a70: 0a 0a 3c 70 3e 54 68 65 20 72 65 74 75 72 6e 20  ..<p>The return 
0a80: 76 61 6c 75 65 20 6f 66 20 74 68 65 20 3c 62 3e  value of the <b>
0a90: 73 71 6c 69 74 65 5f 6f 70 65 6e 28 29 3c 2f 62  sqlite_open()</b
0aa0: 3e 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 61 0a  > function is a.
0ab0: 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 6f 70  pointer to an op
0ac0: 61 71 75 65 20 3c 62 3e 73 71 6c 69 74 65 3c 2f  aque <b>sqlite</
0ad0: 62 3e 20 73 74 72 75 63 74 75 72 65 2e 20 20 54  b> structure.  T
0ae0: 68 69 73 20 70 6f 69 6e 74 65 72 20 77 69 6c 6c  his pointer will
0af0: 0a 62 65 20 74 68 65 20 66 69 72 73 74 20 61 72  .be the first ar
0b00: 67 75 6d 65 6e 74 20 74 6f 20 61 6c 6c 20 73 75  gument to all su
0b10: 62 73 65 71 75 65 6e 74 20 53 51 4c 69 74 65 20  bsequent SQLite 
0b20: 66 75 6e 63 74 69 6f 6e 20 63 61 6c 6c 73 20 74  function calls t
0b30: 68 61 74 0a 64 65 61 6c 20 77 69 74 68 20 74 68  hat.deal with th
0b40: 65 20 73 61 6d 65 20 64 61 74 61 62 61 73 65 2e  e same database.
0b50: 20 20 4e 55 4c 4c 20 69 73 20 72 65 74 75 72 6e    NULL is return
0b60: 65 64 20 69 66 20 74 68 65 20 6f 70 65 6e 20 66  ed if the open f
0b70: 61 69 6c 73 0a 66 6f 72 20 61 6e 79 20 72 65 61  ails.for any rea
0b80: 73 6f 6e 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 43 6c  son.</p>..<h2>Cl
0b90: 6f 73 69 6e 67 20 74 68 65 20 64 61 74 61 62 61  osing the databa
0ba0: 73 65 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 6f 20 63  se</h2>..<p>To c
0bb0: 6c 6f 73 65 20 61 6e 20 53 51 4c 69 74 65 20 64  lose an SQLite d
0bc0: 61 74 61 62 61 73 65 2c 20 63 61 6c 6c 20 74 68  atabase, call th
0bd0: 65 20 3c 62 3e 73 71 6c 69 74 65 5f 63 6c 6f 73  e <b>sqlite_clos
0be0: 65 28 29 3c 2f 62 3e 0a 66 75 6e 63 74 69 6f 6e  e()</b>.function
0bf0: 20 70 61 73 73 69 6e 67 20 69 74 20 74 68 65 20   passing it the 
0c00: 73 71 6c 69 74 65 20 73 74 72 75 63 74 75 72 65  sqlite structure
0c10: 20 70 6f 69 6e 74 65 72 20 74 68 61 74 20 77 61   pointer that wa
0c20: 73 20 6f 62 74 61 69 6e 65 64 0a 66 72 6f 6d 20  s obtained.from 
0c30: 61 20 70 72 69 6f 72 20 63 61 6c 6c 20 74 6f 20  a prior call to 
0c40: 3c 62 3e 73 71 6c 69 74 65 5f 6f 70 65 6e 3c 2f  <b>sqlite_open</
0c50: 62 3e 2e 0a 49 66 20 61 20 74 72 61 6e 73 61 63  b>..If a transac
0c60: 74 69 6f 6e 20 69 73 20 61 63 74 69 76 65 20 77  tion is active w
0c70: 68 65 6e 20 74 68 65 20 64 61 74 61 62 61 73 65  hen the database
0c80: 20 69 73 20 63 6c 6f 73 65 64 2c 20 74 68 65 20   is closed, the 
0c90: 74 72 61 6e 73 61 63 74 69 6f 6e 0a 69 73 20 72  transaction.is r
0ca0: 6f 6c 6c 65 64 20 62 61 63 6b 2e 3c 2f 70 3e 0a  olled back.</p>.
0cb0: 0a 3c 68 32 3e 45 78 65 63 75 74 69 6e 67 20 53  .<h2>Executing S
0cc0: 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 3c 2f 68  QL statements</h
0cd0: 32 3e 0a 0a 3c 70 3e 54 68 65 20 3c 62 3e 73 71  2>..<p>The <b>sq
0ce0: 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e 20  lite_exec()</b> 
0cf0: 66 75 6e 63 74 69 6f 6e 20 69 73 20 75 73 65 64  function is used
0d00: 20 74 6f 20 70 72 6f 63 65 73 73 20 53 51 4c 20   to process SQL 
0d10: 73 74 61 74 65 6d 65 6e 74 73 0a 61 6e 64 20 71  statements.and q
0d20: 75 65 72 69 65 73 2e 20 20 54 68 69 73 20 66 75  ueries.  This fu
0d30: 6e 63 74 69 6f 6e 20 72 65 71 75 69 72 65 73 20  nction requires 
0d40: 35 20 70 61 72 61 6d 65 74 65 72 73 20 61 73 20  5 parameters as 
0d50: 66 6f 6c 6c 6f 77 73 3a 3c 2f 70 3e 0a 0a 3c 6f  follows:</p>..<o
0d60: 6c 3e 0a 3c 6c 69 3e 3c 70 3e 41 20 70 6f 69 6e  l>.<li><p>A poin
0d70: 74 65 72 20 74 6f 20 74 68 65 20 73 71 6c 69 74  ter to the sqlit
0d80: 65 20 73 74 72 75 63 74 75 72 65 20 6f 62 74 61  e structure obta
0d90: 69 6e 65 64 20 66 72 6f 6d 20 61 20 70 72 69 6f  ined from a prio
0da0: 72 20 63 61 6c 6c 0a 20 20 20 20 20 20 20 74 6f  r call.       to
0db0: 20 3c 62 3e 73 71 6c 69 74 65 5f 6f 70 65 6e 28   <b>sqlite_open(
0dc0: 29 3c 2f 62 3e 2e 3c 2f 70 3e 3c 2f 6c 69 3e 0a  )</b>.</p></li>.
0dd0: 3c 6c 69 3e 3c 70 3e 41 20 6e 75 6c 6c 2d 74 65  <li><p>A null-te
0de0: 72 6d 69 6e 61 74 65 64 20 73 74 72 69 6e 67 20  rminated string 
0df0: 63 6f 6e 74 61 69 6e 69 6e 67 20 74 68 65 20 74  containing the t
0e00: 65 78 74 20 6f 66 20 6f 6e 65 20 6f 72 20 6d 6f  ext of one or mo
0e10: 72 65 0a 20 20 20 20 20 20 20 53 51 4c 20 73 74  re.       SQL st
0e20: 61 74 65 6d 65 6e 74 73 20 61 6e 64 2f 6f 72 20  atements and/or 
0e30: 71 75 65 72 69 65 73 20 74 6f 20 62 65 20 70 72  queries to be pr
0e40: 6f 63 65 73 73 65 64 2e 3c 2f 70 3e 3c 2f 6c 69  ocessed.</p></li
0e50: 3e 0a 3c 6c 69 3e 3c 70 3e 41 20 70 6f 69 6e 74  >.<li><p>A point
0e60: 65 72 20 74 6f 20 61 20 63 61 6c 6c 62 61 63 6b  er to a callback
0e70: 20 66 75 6e 63 74 69 6f 6e 20 77 68 69 63 68 20   function which 
0e80: 69 73 20 69 6e 76 6f 6b 65 64 20 6f 6e 63 65 20  is invoked once 
0e90: 66 6f 72 20 65 61 63 68 0a 20 20 20 20 20 20 20  for each.       
0ea0: 72 6f 77 20 69 6e 20 74 68 65 20 72 65 73 75 6c  row in the resul
0eb0: 74 20 6f 66 20 61 20 71 75 65 72 79 2e 20 20 54  t of a query.  T
0ec0: 68 69 73 20 61 72 67 75 6d 65 6e 74 20 6d 61 79  his argument may
0ed0: 20 62 65 20 4e 55 4c 4c 2c 20 69 6e 20 77 68 69   be NULL, in whi
0ee0: 63 68 0a 20 20 20 20 20 20 20 63 61 73 65 20 6e  ch.       case n
0ef0: 6f 20 63 61 6c 6c 62 61 63 6b 73 20 77 69 6c 6c  o callbacks will
0f00: 20 65 76 65 72 20 62 65 20 69 6e 76 6f 6b 65 64   ever be invoked
0f10: 2e 3c 2f 70 3e 3c 2f 6c 69 3e 0a 3c 6c 69 3e 3c  .</p></li>.<li><
0f20: 70 3e 41 20 70 6f 69 6e 74 65 72 20 74 68 61 74  p>A pointer that
0f30: 20 69 73 20 66 6f 72 77 61 72 64 65 64 20 74 6f   is forwarded to
0f40: 20 62 65 63 6f 6d 65 20 74 68 65 20 66 69 72 73   become the firs
0f50: 74 20 61 72 67 75 6d 65 6e 74 0a 20 20 20 20 20  t argument.     
0f60: 20 20 74 6f 20 74 68 65 20 63 61 6c 6c 62 61 63    to the callbac
0f70: 6b 20 66 75 6e 63 74 69 6f 6e 2e 3c 2f 70 3e 3c  k function.</p><
0f80: 2f 6c 69 3e 0a 3c 6c 69 3e 3c 70 3e 41 20 70 6f  /li>.<li><p>A po
0f90: 69 6e 74 65 72 20 74 6f 20 61 6e 20 65 72 72 6f  inter to an erro
0fa0: 72 20 73 74 72 69 6e 67 2e 20 20 45 72 72 6f 72  r string.  Error
0fb0: 20 6d 65 73 73 61 67 65 73 20 61 72 65 20 77 72   messages are wr
0fc0: 69 74 74 65 6e 20 74 6f 20 73 70 61 63 65 0a 20  itten to space. 
0fd0: 20 20 20 20 20 20 6f 62 74 61 69 6e 65 64 20 66        obtained f
0fe0: 72 6f 6d 20 6d 61 6c 6c 6f 63 28 29 20 61 6e 64  rom malloc() and
0ff0: 20 74 68 65 20 65 72 72 6f 72 20 73 74 72 69 6e   the error strin
1000: 67 20 69 73 20 6d 61 64 65 20 74 6f 20 70 6f 69  g is made to poi
1010: 6e 74 20 74 6f 0a 20 20 20 20 20 20 20 74 68 65  nt to.       the
1020: 20 6d 61 6c 6c 6f 63 65 64 20 73 70 61 63 65 2e   malloced space.
1030: 20 20 54 68 65 20 63 61 6c 6c 69 6e 67 20 66 75    The calling fu
1040: 6e 63 74 69 6f 6e 20 69 73 20 72 65 73 70 6f 6e  nction is respon
1050: 73 69 62 6c 65 20 66 6f 72 20 66 72 65 65 69 6e  sible for freein
1060: 67 0a 20 20 20 20 20 20 20 74 68 69 73 20 73 70  g.       this sp
1070: 61 63 65 20 77 68 65 6e 20 69 74 20 68 61 73 20  ace when it has 
1080: 66 69 6e 69 73 68 65 64 20 77 69 74 68 20 69 74  finished with it
1090: 2e 0a 20 20 20 20 20 20 20 54 68 69 73 20 61 72  ..       This ar
10a0: 67 75 6d 65 6e 74 20 6d 61 79 20 62 65 20 4e 55  gument may be NU
10b0: 4c 4c 2c 20 69 6e 20 77 68 69 63 68 20 63 61 73  LL, in which cas
10c0: 65 20 65 72 72 6f 72 20 6d 65 73 73 61 67 65 73  e error messages
10d0: 20 61 72 65 20 6e 6f 74 0a 20 20 20 20 20 20 20   are not.       
10e0: 72 65 70 6f 72 74 65 64 20 62 61 63 6b 20 74 6f  reported back to
10f0: 20 74 68 65 20 63 61 6c 6c 69 6e 67 20 66 75 6e   the calling fun
1100: 63 74 69 6f 6e 2e 3c 2f 70 3e 3c 2f 6c 69 3e 0a  ction.</p></li>.
1110: 3c 2f 6f 6c 3e 0a 0a 3c 70 3e 0a 54 68 65 20 63  </ol>..<p>.The c
1120: 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e  allback function
1130: 20 69 73 20 75 73 65 64 20 74 6f 20 72 65 63 65   is used to rece
1140: 69 76 65 20 74 68 65 20 72 65 73 75 6c 74 73 20  ive the results 
1150: 6f 66 20 61 20 71 75 65 72 79 2e 20 20 41 0a 70  of a query.  A.p
1160: 72 6f 74 6f 74 79 70 65 20 66 6f 72 20 74 68 65  rototype for the
1170: 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69   callback functi
1180: 6f 6e 20 69 73 20 61 73 20 66 6f 6c 6c 6f 77 73  on is as follows
1190: 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f  :</p>..<blockquo
11a0: 74 65 3e 3c 70 72 65 3e 0a 69 6e 74 20 43 61 6c  te><pre>.int Cal
11b0: 6c 62 61 63 6b 28 76 6f 69 64 20 2a 70 41 72 67  lback(void *pArg
11c0: 2c 20 69 6e 74 20 61 72 67 63 2c 20 63 68 61 72  , int argc, char
11d0: 20 2a 2a 61 72 67 76 2c 20 63 68 61 72 20 2a 2a   **argv, char **
11e0: 63 6f 6c 75 6d 6e 4e 61 6d 65 73 29 7b 0a 20 20  columnNames){.  
11f0: 72 65 74 75 72 6e 20 30 3b 0a 7d 0a 3c 2f 70 72  return 0;.}.</pr
1200: 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  e></blockquote>.
1210: 0a 3c 70 3e 54 68 65 20 66 69 72 73 74 20 61 72  .<p>The first ar
1220: 67 75 6d 65 6e 74 20 74 6f 20 74 68 65 20 63 61  gument to the ca
1230: 6c 6c 62 61 63 6b 20 69 73 20 6a 75 73 74 20 61  llback is just a
1240: 20 63 6f 70 79 20 6f 66 20 74 68 65 20 66 6f 75   copy of the fou
1250: 72 74 68 20 61 72 67 75 6d 65 6e 74 0a 74 6f 20  rth argument.to 
1260: 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29  <b>sqlite_exec()
1270: 3c 2f 62 3e 20 20 54 68 69 73 20 70 61 72 61 6d  </b>  This param
1280: 65 74 65 72 20 63 61 6e 20 62 65 20 75 73 65 64  eter can be used
1290: 20 74 6f 20 70 61 73 73 20 61 72 62 69 74 72 61   to pass arbitra
12a0: 72 79 0a 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 74  ry.information t
12b0: 68 72 6f 75 67 68 20 74 6f 20 74 68 65 20 63 61  hrough to the ca
12c0: 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 20  llback function 
12d0: 66 72 6f 6d 20 63 6c 69 65 6e 74 20 63 6f 64 65  from client code
12e0: 2e 0a 54 68 65 20 73 65 63 6f 6e 64 20 61 72 67  ..The second arg
12f0: 75 6d 65 6e 74 20 69 73 20 74 68 65 20 6e 75 6d  ument is the num
1300: 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 20 69  ber of columns i
1310: 6e 20 74 68 65 20 71 75 65 72 79 20 72 65 73 75  n the query resu
1320: 6c 74 2e 0a 54 68 65 20 74 68 69 72 64 20 61 72  lt..The third ar
1330: 67 75 6d 65 6e 74 20 69 73 20 61 6e 20 61 72 72  gument is an arr
1340: 61 79 20 6f 66 20 70 6f 69 6e 74 65 72 73 20 74  ay of pointers t
1350: 6f 20 73 74 72 69 6e 67 73 20 77 68 65 72 65 20  o strings where 
1360: 65 61 63 68 20 73 74 72 69 6e 67 0a 69 73 20 61  each string.is a
1370: 20 73 69 6e 67 6c 65 20 63 6f 6c 75 6d 6e 20 6f   single column o
1380: 66 20 74 68 65 20 72 65 73 75 6c 74 20 66 6f 72  f the result for
1390: 20 74 68 61 74 20 72 65 63 6f 72 64 2e 20 20 4e   that record.  N
13a0: 6f 74 65 20 74 68 61 74 20 74 68 65 0a 63 61 6c  ote that the.cal
13b0: 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 20 72  lback function r
13c0: 65 70 6f 72 74 73 20 61 20 4e 55 4c 4c 20 76 61  eports a NULL va
13d0: 6c 75 65 20 69 6e 20 74 68 65 20 64 61 74 61 62  lue in the datab
13e0: 61 73 65 20 61 73 20 61 20 4e 55 4c 4c 20 70 6f  ase as a NULL po
13f0: 69 6e 74 65 72 2c 0a 77 68 69 63 68 20 69 73 20  inter,.which is 
1400: 76 65 72 79 20 64 69 66 66 65 72 65 6e 74 20 66  very different f
1410: 72 6f 6d 20 61 6e 20 65 6d 70 74 79 20 73 74 72  rom an empty str
1420: 69 6e 67 2e 20 20 49 66 20 74 68 65 20 69 2d 74  ing.  If the i-t
1430: 68 20 70 61 72 61 6d 65 74 65 72 0a 69 73 20 61  h parameter.is a
1440: 6e 20 65 6d 70 74 79 20 73 74 72 69 6e 67 2c 20  n empty string, 
1450: 77 65 20 77 69 6c 6c 20 67 65 74 3a 3c 2f 70 3e  we will get:</p>
1460: 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72  .<blockquote><pr
1470: 65 3e 0a 61 72 67 76 5b 69 5d 5b 30 5d 20 3d 3d  e>.argv[i][0] ==
1480: 20 30 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b   0.</pre></block
1490: 71 75 6f 74 65 3e 0a 3c 70 3e 42 75 74 20 69 66  quote>.<p>But if
14a0: 20 74 68 65 20 69 2d 74 68 20 70 61 72 61 6d 65   the i-th parame
14b0: 74 65 72 20 69 73 20 4e 55 4c 4c 20 77 65 20 77  ter is NULL we w
14c0: 69 6c 6c 20 67 65 74 3a 3c 2f 70 3e 0a 3c 62 6c  ill get:</p>.<bl
14d0: 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 61  ockquote><pre>.a
14e0: 72 67 76 5b 69 5d 20 3d 3d 20 30 0a 3c 2f 70 72  rgv[i] == 0.</pr
14f0: 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  e></blockquote>.
1500: 3c 70 3e 54 68 65 20 6e 61 6d 65 73 20 6f 66 20  <p>The names of 
1510: 74 68 65 20 63 6f 6c 75 6d 6e 73 20 61 72 65 20  the columns are 
1520: 63 6f 6e 74 61 69 6e 65 64 20 69 6e 20 74 68 65  contained in the
1530: 20 66 6f 75 72 74 68 20 61 72 67 75 6d 65 6e 74   fourth argument
1540: 2e 3c 2f 70 3e 0a 0a 3c 70 3e 49 66 20 74 68 65  .</p>..<p>If the
1550: 20 45 4d 50 54 59 5f 52 45 53 55 4c 54 5f 43 41   EMPTY_RESULT_CA
1560: 4c 4c 42 41 43 4b 53 20 70 72 61 67 6d 61 20 69  LLBACKS pragma i
1570: 73 20 73 65 74 20 74 6f 20 4f 4e 20 61 6e 64 20  s set to ON and 
1580: 74 68 65 20 72 65 73 75 6c 74 20 6f 66 0a 61 20  the result of.a 
1590: 71 75 65 72 79 20 69 73 20 61 6e 20 65 6d 70 74  query is an empt
15a0: 79 20 73 65 74 2c 20 74 68 65 6e 20 74 68 65 20  y set, then the 
15b0: 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f  callback is invo
15c0: 6b 65 64 20 6f 6e 63 65 20 77 69 74 68 20 74 68  ked once with th
15d0: 65 0a 74 68 69 72 64 20 70 61 72 61 6d 65 74 65  e.third paramete
15e0: 72 20 28 61 72 67 76 29 20 73 65 74 20 74 6f 20  r (argv) set to 
15f0: 30 2e 20 20 49 6e 20 6f 74 68 65 72 20 77 6f 72  0.  In other wor
1600: 64 73 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c  ds.<blockquote><
1610: 70 72 65 3e 0a 61 72 67 76 20 3d 3d 20 30 0a 3c  pre>.argv == 0.<
1620: 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74  /pre></blockquot
1630: 65 3e 0a 54 68 65 20 73 65 63 6f 6e 64 20 70 61  e>.The second pa
1640: 72 61 6d 65 74 65 72 20 28 61 72 67 63 29 0a 61  rameter (argc).a
1650: 6e 64 20 74 68 65 20 66 6f 75 72 74 68 20 70 61  nd the fourth pa
1660: 72 61 6d 65 74 65 72 20 28 63 6f 6c 75 6d 6e 4e  rameter (columnN
1670: 61 6d 65 73 29 20 61 72 65 20 73 74 69 6c 6c 20  ames) are still 
1680: 76 61 6c 69 64 0a 61 6e 64 20 63 61 6e 20 62 65  valid.and can be
1690: 20 75 73 65 64 20 74 6f 20 64 65 74 65 72 6d 69   used to determi
16a0: 6e 65 20 74 68 65 20 6e 75 6d 62 65 72 20 61 6e  ne the number an
16b0: 64 20 6e 61 6d 65 73 20 6f 66 20 74 68 65 20 72  d names of the r
16c0: 65 73 75 6c 74 0a 63 6f 6c 75 6d 6e 73 20 69 66  esult.columns if
16d0: 20 74 68 65 72 65 20 68 61 64 20 62 65 65 6e 20   there had been 
16e0: 61 20 72 65 73 75 6c 74 2e 0a 54 68 65 20 64 65  a result..The de
16f0: 66 61 75 6c 74 20 62 65 68 61 76 69 6f 72 20 69  fault behavior i
1700: 73 20 6e 6f 74 20 74 6f 20 69 6e 76 6f 6b 65 20  s not to invoke 
1710: 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 61 74 20  the callback at 
1720: 61 6c 6c 20 69 66 20 74 68 65 0a 72 65 73 75 6c  all if the.resul
1730: 74 20 73 65 74 20 69 73 20 65 6d 70 74 79 2e 3c  t set is empty.<
1740: 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 63 61 6c 6c  /p>..<p>The call
1750: 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 20 73 68  back function sh
1760: 6f 75 6c 64 20 6e 6f 72 6d 61 6c 6c 79 20 72 65  ould normally re
1770: 74 75 72 6e 20 30 2e 20 20 49 66 20 74 68 65 20  turn 0.  If the 
1780: 63 61 6c 6c 62 61 63 6b 0a 66 75 6e 63 74 69 6f  callback.functio
1790: 6e 20 72 65 74 75 72 6e 73 20 6e 6f 6e 2d 7a 65  n returns non-ze
17a0: 72 6f 2c 20 74 68 65 20 71 75 65 72 79 20 69 73  ro, the query is
17b0: 20 69 6d 6d 65 64 69 61 74 65 6c 79 20 61 62 6f   immediately abo
17c0: 72 74 65 64 20 61 6e 64 20 0a 3c 62 3e 73 71 6c  rted and .<b>sql
17d0: 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e 20 77  ite_exec()</b> w
17e0: 69 6c 6c 20 72 65 74 75 72 6e 20 53 51 4c 49 54  ill return SQLIT
17f0: 45 5f 41 42 4f 52 54 2e 3c 2f 70 3e 0a 0a 3c 68  E_ABORT.</p>..<h
1800: 32 3e 45 72 72 6f 72 20 43 6f 64 65 73 3c 2f 68  2>Error Codes</h
1810: 32 3e 0a 0a 3c 70 3e 0a 54 68 65 20 3c 62 3e 73  2>..<p>.The <b>s
1820: 71 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e  qlite_exec()</b>
1830: 20 66 75 6e 63 74 69 6f 6e 20 6e 6f 72 6d 61 6c   function normal
1840: 6c 79 20 72 65 74 75 72 6e 73 20 53 51 4c 49 54  ly returns SQLIT
1850: 45 5f 4f 4b 2e 20 20 42 75 74 0a 69 66 20 73 6f  E_OK.  But.if so
1860: 6d 65 74 68 69 6e 67 20 67 6f 65 73 20 77 72 6f  mething goes wro
1870: 6e 67 20 69 74 20 63 61 6e 20 72 65 74 75 72 6e  ng it can return
1880: 20 61 20 64 69 66 66 65 72 65 6e 74 20 76 61 6c   a different val
1890: 75 65 20 74 6f 20 69 6e 64 69 63 61 74 65 0a 74  ue to indicate.t
18a0: 68 65 20 74 79 70 65 20 6f 66 20 65 72 72 6f 72  he type of error
18b0: 2e 20 20 48 65 72 65 20 69 73 20 61 20 63 6f 6d  .  Here is a com
18c0: 70 6c 65 74 65 20 6c 69 73 74 20 6f 66 20 74 68  plete list of th
18d0: 65 20 72 65 74 75 72 6e 20 63 6f 64 65 73 3a 0a  e return codes:.
18e0: 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74  </p>..<blockquot
18f0: 65 3e 3c 70 72 65 3e 0a 23 64 65 66 69 6e 65 20  e><pre>.#define 
1900: 53 51 4c 49 54 45 5f 4f 4b 20 20 20 20 20 20 20  SQLITE_OK       
1910: 20 20 20 20 30 20 20 20 2f 2a 20 53 75 63 63 65      0   /* Succe
1920: 73 73 66 75 6c 20 72 65 73 75 6c 74 20 2a 2f 0a  ssful result */.
1930: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 45  #define SQLITE_E
1940: 52 52 4f 52 20 20 20 20 20 20 20 20 31 20 20 20  RROR        1   
1950: 2f 2a 20 53 51 4c 20 65 72 72 6f 72 20 6f 72 20  /* SQL error or 
1960: 6d 69 73 73 69 6e 67 20 64 61 74 61 62 61 73 65  missing database
1970: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
1980: 54 45 5f 49 4e 54 45 52 4e 41 4c 20 20 20 20 20  TE_INTERNAL     
1990: 32 20 20 20 2f 2a 20 41 6e 20 69 6e 74 65 72 6e  2   /* An intern
19a0: 61 6c 20 6c 6f 67 69 63 20 65 72 72 6f 72 20 69  al logic error i
19b0: 6e 20 53 51 4c 69 74 65 20 2a 2f 0a 23 64 65 66  n SQLite */.#def
19c0: 69 6e 65 20 53 51 4c 49 54 45 5f 50 45 52 4d 20  ine SQLITE_PERM 
19d0: 20 20 20 20 20 20 20 20 33 20 20 20 2f 2a 20 41          3   /* A
19e0: 63 63 65 73 73 20 70 65 72 6d 69 73 73 69 6f 6e  ccess permission
19f0: 20 64 65 6e 69 65 64 20 2a 2f 0a 23 64 65 66 69   denied */.#defi
1a00: 6e 65 20 53 51 4c 49 54 45 5f 41 42 4f 52 54 20  ne SQLITE_ABORT 
1a10: 20 20 20 20 20 20 20 34 20 20 20 2f 2a 20 43 61         4   /* Ca
1a20: 6c 6c 62 61 63 6b 20 72 6f 75 74 69 6e 65 20 72  llback routine r
1a30: 65 71 75 65 73 74 65 64 20 61 6e 20 61 62 6f 72  equested an abor
1a40: 74 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  t */.#define SQL
1a50: 49 54 45 5f 42 55 53 59 20 20 20 20 20 20 20 20  ITE_BUSY        
1a60: 20 35 20 20 20 2f 2a 20 54 68 65 20 64 61 74 61   5   /* The data
1a70: 62 61 73 65 20 66 69 6c 65 20 69 73 20 6c 6f 63  base file is loc
1a80: 6b 65 64 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ked */.#define S
1a90: 51 4c 49 54 45 5f 4c 4f 43 4b 45 44 20 20 20 20  QLITE_LOCKED    
1aa0: 20 20 20 36 20 20 20 2f 2a 20 41 20 74 61 62 6c     6   /* A tabl
1ab0: 65 20 69 6e 20 74 68 65 20 64 61 74 61 62 61 73  e in the databas
1ac0: 65 20 69 73 20 6c 6f 63 6b 65 64 20 2a 2f 0a 23  e is locked */.#
1ad0: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4e 4f  define SQLITE_NO
1ae0: 4d 45 4d 20 20 20 20 20 20 20 20 37 20 20 20 2f  MEM        7   /
1af0: 2a 20 41 20 6d 61 6c 6c 6f 63 28 29 20 66 61 69  * A malloc() fai
1b00: 6c 65 64 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  led */.#define S
1b10: 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c 59 20 20  QLITE_READONLY  
1b20: 20 20 20 38 20 20 20 2f 2a 20 41 74 74 65 6d 70     8   /* Attemp
1b30: 74 20 74 6f 20 77 72 69 74 65 20 61 20 72 65 61  t to write a rea
1b40: 64 6f 6e 6c 79 20 64 61 74 61 62 61 73 65 20 2a  donly database *
1b50: 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
1b60: 5f 49 4e 54 45 52 52 55 50 54 20 20 20 20 39 20  _INTERRUPT    9 
1b70: 20 20 2f 2a 20 4f 70 65 72 61 74 69 6f 6e 20 74    /* Operation t
1b80: 65 72 6d 69 6e 61 74 65 64 20 62 79 20 73 71 6c  erminated by sql
1b90: 69 74 65 5f 69 6e 74 65 72 72 75 70 74 28 29 20  ite_interrupt() 
1ba0: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
1bb0: 45 5f 49 4f 45 52 52 20 20 20 20 20 20 20 31 30  E_IOERR       10
1bc0: 20 20 20 2f 2a 20 53 6f 6d 65 20 6b 69 6e 64 20     /* Some kind 
1bd0: 6f 66 20 64 69 73 6b 20 49 2f 4f 20 65 72 72 6f  of disk I/O erro
1be0: 72 20 6f 63 63 75 72 72 65 64 20 2a 2f 0a 23 64  r occurred */.#d
1bf0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 52  efine SQLITE_COR
1c00: 52 55 50 54 20 20 20 20 20 31 31 20 20 20 2f 2a  RUPT     11   /*
1c10: 20 54 68 65 20 64 61 74 61 62 61 73 65 20 64 69   The database di
1c20: 73 6b 20 69 6d 61 67 65 20 69 73 20 6d 61 6c 66  sk image is malf
1c30: 6f 72 6d 65 64 20 2a 2f 0a 23 64 65 66 69 6e 65  ormed */.#define
1c40: 20 53 51 4c 49 54 45 5f 4e 4f 54 46 4f 55 4e 44   SQLITE_NOTFOUND
1c50: 20 20 20 20 31 32 20 20 20 2f 2a 20 28 49 6e 74      12   /* (Int
1c60: 65 72 6e 61 6c 20 4f 6e 6c 79 29 20 54 61 62 6c  ernal Only) Tabl
1c70: 65 20 6f 72 20 72 65 63 6f 72 64 20 6e 6f 74 20  e or record not 
1c80: 66 6f 75 6e 64 20 2a 2f 0a 23 64 65 66 69 6e 65  found */.#define
1c90: 20 53 51 4c 49 54 45 5f 46 55 4c 4c 20 20 20 20   SQLITE_FULL    
1ca0: 20 20 20 20 31 33 20 20 20 2f 2a 20 49 6e 73 65      13   /* Inse
1cb0: 72 74 69 6f 6e 20 66 61 69 6c 65 64 20 62 65 63  rtion failed bec
1cc0: 61 75 73 65 20 64 61 74 61 62 61 73 65 20 69 73  ause database is
1cd0: 20 66 75 6c 6c 20 2a 2f 0a 23 64 65 66 69 6e 65   full */.#define
1ce0: 20 53 51 4c 49 54 45 5f 43 41 4e 54 4f 50 45 4e   SQLITE_CANTOPEN
1cf0: 20 20 20 20 31 34 20 20 20 2f 2a 20 55 6e 61 62      14   /* Unab
1d00: 6c 65 20 74 6f 20 6f 70 65 6e 20 74 68 65 20 64  le to open the d
1d10: 61 74 61 62 61 73 65 20 66 69 6c 65 20 2a 2f 0a  atabase file */.
1d20: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 50  #define SQLITE_P
1d30: 52 4f 54 4f 43 4f 4c 20 20 20 20 31 35 20 20 20  ROTOCOL    15   
1d40: 2f 2a 20 44 61 74 61 62 61 73 65 20 6c 6f 63 6b  /* Database lock
1d50: 20 70 72 6f 74 6f 63 6f 6c 20 65 72 72 6f 72 20   protocol error 
1d60: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
1d70: 45 5f 45 4d 50 54 59 20 20 20 20 20 20 20 31 36  E_EMPTY       16
1d80: 20 20 20 2f 2a 20 28 49 6e 74 65 72 6e 61 6c 20     /* (Internal 
1d90: 4f 6e 6c 79 29 20 44 61 74 61 62 61 73 65 20 74  Only) Database t
1da0: 61 62 6c 65 20 69 73 20 65 6d 70 74 79 20 2a 2f  able is empty */
1db0: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
1dc0: 53 43 48 45 4d 41 20 20 20 20 20 20 31 37 20 20  SCHEMA      17  
1dd0: 20 2f 2a 20 54 68 65 20 64 61 74 61 62 61 73 65   /* The database
1de0: 20 73 63 68 65 6d 61 20 63 68 61 6e 67 65 64 20   schema changed 
1df0: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
1e00: 45 5f 54 4f 4f 42 49 47 20 20 20 20 20 20 31 38  E_TOOBIG      18
1e10: 20 20 20 2f 2a 20 54 6f 6f 20 6d 75 63 68 20 64     /* Too much d
1e20: 61 74 61 20 66 6f 72 20 6f 6e 65 20 72 6f 77 20  ata for one row 
1e30: 6f 66 20 61 20 74 61 62 6c 65 20 2a 2f 0a 23 64  of a table */.#d
1e40: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e  efine SQLITE_CON
1e50: 53 54 52 41 49 4e 54 20 20 31 39 20 20 20 2f 2a  STRAINT  19   /*
1e60: 20 41 62 6f 72 74 20 64 75 65 20 74 6f 20 63 6f   Abort due to co
1e70: 6e 74 72 61 69 6e 74 20 76 69 6f 6c 61 74 69 6f  ntraint violatio
1e80: 6e 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  n */.#define SQL
1e90: 49 54 45 5f 4d 49 53 4d 41 54 43 48 20 20 20 20  ITE_MISMATCH    
1ea0: 32 30 20 20 20 2f 2a 20 44 61 74 61 20 74 79 70  20   /* Data typ
1eb0: 65 20 6d 69 73 6d 61 74 63 68 20 2a 2f 0a 23 64  e mismatch */.#d
1ec0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4d 49 53  efine SQLITE_MIS
1ed0: 55 53 45 20 20 20 20 20 20 32 31 20 20 20 2f 2a  USE      21   /*
1ee0: 20 4c 69 62 72 61 72 79 20 75 73 65 64 20 69 6e   Library used in
1ef0: 63 6f 72 72 65 63 74 6c 79 20 2a 2f 0a 3c 2f 70  correctly */.</p
1f00: 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e  re></blockquote>
1f10: 0a 0a 3c 70 3e 0a 54 68 65 20 6d 65 61 6e 69 6e  ..<p>.The meanin
1f20: 67 73 20 6f 66 20 74 68 65 73 65 20 76 61 72 69  gs of these vari
1f30: 6f 75 73 20 72 65 74 75 72 6e 20 76 61 6c 75 65  ous return value
1f40: 73 20 61 72 65 20 61 73 20 66 6f 6c 6c 6f 77 73  s are as follows
1f50: 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75  :.</p>..<blockqu
1f60: 6f 74 65 3e 0a 3c 64 6c 3e 0a 3c 64 74 3e 53 51  ote>.<dl>.<dt>SQ
1f70: 4c 49 54 45 5f 4f 4b 3c 2f 64 74 3e 0a 3c 64 64  LITE_OK</dt>.<dd
1f80: 3e 3c 70 3e 54 68 69 73 20 76 61 6c 75 65 20 69  ><p>This value i
1f90: 73 20 72 65 74 75 72 6e 65 64 20 69 66 20 65 76  s returned if ev
1fa0: 65 72 79 74 68 69 6e 67 20 77 6f 72 6b 65 64 20  erything worked 
1fb0: 61 6e 64 20 74 68 65 72 65 20 77 65 72 65 20 6e  and there were n
1fc0: 6f 20 65 72 72 6f 72 73 2e 0a 3c 2f 70 3e 3c 2f  o errors..</p></
1fd0: 64 64 3e 0a 3c 64 74 3e 53 51 4c 49 54 45 5f 49  dd>.<dt>SQLITE_I
1fe0: 4e 54 45 52 4e 41 4c 3c 2f 64 74 3e 0a 3c 64 64  NTERNAL</dt>.<dd
1ff0: 3e 3c 70 3e 54 68 69 73 20 76 61 6c 75 65 20 69  ><p>This value i
2000: 6e 64 69 63 61 74 65 73 20 74 68 61 74 20 61 6e  ndicates that an
2010: 20 69 6e 74 65 72 6e 61 6c 20 63 6f 6e 73 69 73   internal consis
2020: 74 65 6e 63 79 20 63 68 65 63 6b 20 77 69 74 68  tency check with
2030: 69 6e 0a 74 68 65 20 53 51 4c 69 74 65 20 6c 69  in.the SQLite li
2040: 62 72 61 72 79 20 66 61 69 6c 65 64 2e 20 20 54  brary failed.  T
2050: 68 69 73 20 63 61 6e 20 6f 6e 6c 79 20 68 61 70  his can only hap
2060: 70 65 6e 20 69 66 20 74 68 65 72 65 20 69 73 20  pen if there is 
2070: 61 20 62 75 67 20 69 6e 0a 74 68 65 20 53 51 4c  a bug in.the SQL
2080: 69 74 65 20 6c 69 62 72 61 72 79 2e 20 20 49 66  ite library.  If
2090: 20 79 6f 75 20 65 76 65 72 20 67 65 74 20 61 6e   you ever get an
20a0: 20 53 51 4c 49 54 45 5f 49 4e 54 45 52 4e 41 4c   SQLITE_INTERNAL
20b0: 20 72 65 70 6c 79 20 66 72 6f 6d 0a 61 6e 20 3c   reply from.an <
20c0: 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c  b>sqlite_exec()<
20d0: 2f 62 3e 20 63 61 6c 6c 2c 20 70 6c 65 61 73 65  /b> call, please
20e0: 20 72 65 70 6f 72 74 20 74 68 65 20 70 72 6f 62   report the prob
20f0: 6c 65 6d 20 6f 6e 20 74 68 65 20 53 51 4c 69 74  lem on the SQLit
2100: 65 0a 6d 61 69 6c 69 6e 67 20 6c 69 73 74 2e 0a  e.mailing list..
2110: 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51  </p></dd>.<dt>SQ
2120: 4c 49 54 45 5f 45 52 52 4f 52 3c 2f 64 74 3e 0a  LITE_ERROR</dt>.
2130: 3c 64 64 3e 3c 70 3e 54 68 69 73 20 72 65 74 75  <dd><p>This retu
2140: 72 6e 20 76 61 6c 75 65 20 69 6e 64 69 63 61 74  rn value indicat
2150: 65 73 20 74 68 61 74 20 74 68 65 72 65 20 77 61  es that there wa
2160: 73 20 61 6e 20 65 72 72 6f 72 20 69 6e 20 74 68  s an error in th
2170: 65 20 53 51 4c 0a 74 68 61 74 20 77 61 73 20 70  e SQL.that was p
2180: 61 73 73 65 64 20 69 6e 74 6f 20 74 68 65 20 3c  assed into the <
2190: 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c  b>sqlite_exec()<
21a0: 2f 62 3e 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c  /b>..</p></dd>.<
21b0: 64 74 3e 53 51 4c 49 54 45 5f 50 45 52 4d 3c 2f  dt>SQLITE_PERM</
21c0: 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20  dt>.<dd><p>This 
21d0: 72 65 74 75 72 6e 20 76 61 6c 75 65 20 73 61 79  return value say
21e0: 73 20 74 68 61 74 20 74 68 65 20 61 63 63 65 73  s that the acces
21f0: 73 20 70 65 72 6d 69 73 73 69 6f 6e 73 20 6f 6e  s permissions on
2200: 20 74 68 65 20 64 61 74 61 62 61 73 65 0a 66 69   the database.fi
2210: 6c 65 20 61 72 65 20 73 75 63 68 20 74 68 61 74  le are such that
2220: 20 74 68 65 20 66 69 6c 65 20 63 61 6e 6e 6f 74   the file cannot
2230: 20 62 65 20 6f 70 65 6e 65 64 2e 0a 3c 2f 70 3e   be opened..</p>
2240: 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51 4c 49 54 45  </dd>.<dt>SQLITE
2250: 5f 41 42 4f 52 54 3c 2f 64 74 3e 0a 3c 64 64 3e  _ABORT</dt>.<dd>
2260: 3c 70 3e 54 68 69 73 20 76 61 6c 75 65 20 69 73  <p>This value is
2270: 20 72 65 74 75 72 6e 65 64 20 69 66 20 74 68 65   returned if the
2280: 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69   callback functi
2290: 6f 6e 20 72 65 74 75 72 6e 73 20 6e 6f 6e 2d 7a  on returns non-z
22a0: 65 72 6f 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c  ero..</p></dd>.<
22b0: 64 74 3e 53 51 4c 49 54 45 5f 42 55 53 59 3c 2f  dt>SQLITE_BUSY</
22c0: 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20  dt>.<dd><p>This 
22d0: 72 65 74 75 72 6e 20 63 6f 64 65 20 69 6e 64 69  return code indi
22e0: 63 61 74 65 73 20 74 68 61 74 20 61 6e 6f 74 68  cates that anoth
22f0: 65 72 20 70 72 6f 67 72 61 6d 20 6f 72 20 74 68  er program or th
2300: 72 65 61 64 20 68 61 73 0a 74 68 65 20 64 61 74  read has.the dat
2310: 61 62 61 73 65 20 6c 6f 63 6b 65 64 2e 20 20 53  abase locked.  S
2320: 51 4c 69 74 65 20 61 6c 6c 6f 77 73 20 74 77 6f  QLite allows two
2330: 20 6f 72 20 6d 6f 72 65 20 74 68 72 65 61 64 73   or more threads
2340: 20 74 6f 20 72 65 61 64 20 74 68 65 0a 64 61 74   to read the.dat
2350: 61 62 61 73 65 20 61 74 20 74 68 65 20 73 61 6d  abase at the sam
2360: 65 20 74 69 6d 65 2c 20 62 75 74 20 6f 6e 6c 79  e time, but only
2370: 20 6f 6e 65 20 74 68 72 65 61 64 20 63 61 6e 20   one thread can 
2380: 68 61 76 65 20 74 68 65 20 64 61 74 61 62 61 73  have the databas
2390: 65 0a 6f 70 65 6e 20 66 6f 72 20 77 72 69 74 69  e.open for writi
23a0: 6e 67 20 61 74 20 74 68 65 20 73 61 6d 65 20 74  ng at the same t
23b0: 69 6d 65 2e 20 20 4c 6f 63 6b 69 6e 67 20 69 6e  ime.  Locking in
23c0: 20 53 51 4c 69 74 65 20 69 73 20 6f 6e 20 74 68   SQLite is on th
23d0: 65 0a 65 6e 74 69 72 65 20 64 61 74 61 62 61 73  e.entire databas
23e0: 65 2e 3c 2f 70 3e 0a 3c 2f 70 3e 3c 2f 64 64 3e  e.</p>.</p></dd>
23f0: 0a 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 4f 43 4b  .<dt>SQLITE_LOCK
2400: 45 44 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54  ED</dt>.<dd><p>T
2410: 68 69 73 20 72 65 74 75 72 6e 20 63 6f 64 65 20  his return code 
2420: 69 73 20 73 69 6d 69 6c 61 72 20 74 6f 20 53 51  is similar to SQ
2430: 4c 49 54 45 5f 42 55 53 59 20 69 6e 20 74 68 61  LITE_BUSY in tha
2440: 74 20 69 74 20 69 6e 64 69 63 61 74 65 73 0a 74  t it indicates.t
2450: 68 61 74 20 74 68 65 20 64 61 74 61 62 61 73 65  hat the database
2460: 20 69 73 20 6c 6f 63 6b 65 64 2e 20 20 42 75 74   is locked.  But
2470: 20 74 68 65 20 73 6f 75 72 63 65 20 6f 66 20 74   the source of t
2480: 68 65 20 6c 6f 63 6b 20 69 73 20 61 20 72 65 63  he lock is a rec
2490: 75 72 73 69 76 65 0a 63 61 6c 6c 20 74 6f 20 3c  ursive.call to <
24a0: 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c  b>sqlite_exec()<
24b0: 2f 62 3e 2e 20 20 54 68 69 73 20 72 65 74 75 72  /b>.  This retur
24c0: 6e 20 63 61 6e 20 6f 6e 6c 79 20 6f 63 63 75 72  n can only occur
24d0: 20 69 66 20 79 6f 75 20 61 74 74 65 6d 70 74 0a   if you attempt.
24e0: 74 6f 20 69 6e 76 6f 6b 65 20 73 71 6c 69 74 65  to invoke sqlite
24f0: 5f 65 78 65 63 28 29 20 66 72 6f 6d 20 77 69 74  _exec() from wit
2500: 68 69 6e 20 61 20 63 61 6c 6c 62 61 63 6b 20 72  hin a callback r
2510: 6f 75 74 69 6e 65 20 6f 66 20 61 20 71 75 65 72  outine of a quer
2520: 79 0a 66 72 6f 6d 20 61 20 70 72 69 6f 72 20 69  y.from a prior i
2530: 6e 76 6f 63 61 74 69 6f 6e 20 6f 66 20 73 71 6c  nvocation of sql
2540: 69 74 65 5f 65 78 65 63 28 29 2e 20 20 52 65 63  ite_exec().  Rec
2550: 75 72 73 69 76 65 20 63 61 6c 6c 73 20 74 6f 0a  ursive calls to.
2560: 73 71 6c 69 74 65 5f 65 78 65 63 28 29 20 61 72  sqlite_exec() ar
2570: 65 20 61 6c 6c 6f 77 65 64 20 61 73 20 6c 6f 6e  e allowed as lon
2580: 67 20 61 73 20 74 68 65 79 20 64 6f 0a 6e 6f 74  g as they do.not
2590: 20 61 74 74 65 6d 70 74 20 74 6f 20 77 72 69 74   attempt to writ
25a0: 65 20 74 68 65 20 73 61 6d 65 20 74 61 62 6c 65  e the same table
25b0: 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e  ..</p></dd>.<dt>
25c0: 53 51 4c 49 54 45 5f 4e 4f 4d 45 4d 3c 2f 64 74  SQLITE_NOMEM</dt
25d0: 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 76 61  >.<dd><p>This va
25e0: 6c 75 65 20 69 73 20 72 65 74 75 72 6e 65 64 20  lue is returned 
25f0: 69 66 20 61 20 63 61 6c 6c 20 74 6f 20 3c 62 3e  if a call to <b>
2600: 6d 61 6c 6c 6f 63 28 29 3c 2f 62 3e 20 66 61 69  malloc()</b> fai
2610: 6c 73 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64  ls..</p></dd>.<d
2620: 74 3e 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c  t>SQLITE_READONL
2630: 59 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68  Y</dt>.<dd><p>Th
2640: 69 73 20 72 65 74 75 72 6e 20 63 6f 64 65 20 69  is return code i
2650: 6e 64 69 63 61 74 65 73 20 74 68 61 74 20 61 6e  ndicates that an
2660: 20 61 74 74 65 6d 70 74 20 77 61 73 20 6d 61 64   attempt was mad
2670: 65 20 74 6f 20 77 72 69 74 65 20 74 6f 0a 61 20  e to write to.a 
2680: 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 74 68  database file th
2690: 61 74 20 69 73 20 6f 70 65 6e 65 64 20 66 6f 72  at is opened for
26a0: 20 72 65 61 64 69 6e 67 20 6f 6e 6c 79 2e 0a 3c   reading only..<
26b0: 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51 4c  /p></dd>.<dt>SQL
26c0: 49 54 45 5f 49 4e 54 45 52 52 55 50 54 3c 2f 64  ITE_INTERRUPT</d
26d0: 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 76  t>.<dd><p>This v
26e0: 61 6c 75 65 20 69 73 20 72 65 74 75 72 6e 65 64  alue is returned
26f0: 20 69 66 20 61 20 63 61 6c 6c 20 74 6f 20 3c 62   if a call to <b
2700: 3e 73 71 6c 69 74 65 5f 69 6e 74 65 72 72 75 70  >sqlite_interrup
2710: 74 28 29 3c 2f 62 3e 0a 69 6e 74 65 72 72 75 70  t()</b>.interrup
2720: 74 73 20 61 20 64 61 74 61 62 61 73 65 20 6f 70  ts a database op
2730: 65 72 61 74 69 6f 6e 20 69 6e 20 70 72 6f 67 72  eration in progr
2740: 65 73 73 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c  ess..</p></dd>.<
2750: 64 74 3e 53 51 4c 49 54 45 5f 49 4f 45 52 52 3c  dt>SQLITE_IOERR<
2760: 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73  /dt>.<dd><p>This
2770: 20 76 61 6c 75 65 20 69 73 20 72 65 74 75 72 6e   value is return
2780: 65 64 20 69 66 20 74 68 65 20 6f 70 65 72 61 74  ed if the operat
2790: 69 6e 67 20 73 79 73 74 65 6d 20 69 6e 66 6f 72  ing system infor
27a0: 6d 73 20 53 51 4c 69 74 65 0a 74 68 61 74 20 69  ms SQLite.that i
27b0: 74 20 69 73 20 75 6e 61 62 6c 65 20 74 6f 20 70  t is unable to p
27c0: 65 72 66 6f 72 6d 20 73 6f 6d 65 20 64 69 73 6b  erform some disk
27d0: 20 49 2f 4f 20 6f 70 65 72 61 74 69 6f 6e 2e 20   I/O operation. 
27e0: 20 54 68 69 73 20 63 6f 75 6c 64 20 6d 65 61 6e   This could mean
27f0: 0a 74 68 61 74 20 74 68 65 72 65 20 69 73 20 6e  .that there is n
2800: 6f 20 6d 6f 72 65 20 73 70 61 63 65 20 6c 65 66  o more space lef
2810: 74 20 6f 6e 20 74 68 65 20 64 69 73 6b 2e 0a 3c  t on the disk..<
2820: 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51 4c  /p></dd>.<dt>SQL
2830: 49 54 45 5f 43 4f 52 52 55 50 54 3c 2f 64 74 3e  ITE_CORRUPT</dt>
2840: 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 76 61 6c  .<dd><p>This val
2850: 75 65 20 69 73 20 72 65 74 75 72 6e 65 64 20 69  ue is returned i
2860: 66 20 53 51 4c 69 74 65 20 64 65 74 65 63 74 73  f SQLite detects
2870: 20 74 68 61 74 20 74 68 65 20 64 61 74 61 62 61   that the databa
2880: 73 65 20 69 74 20 69 73 0a 77 6f 72 6b 69 6e 67  se it is.working
2890: 20 6f 6e 20 68 61 73 20 62 65 63 6f 6d 65 20 63   on has become c
28a0: 6f 72 72 75 70 74 65 64 2e 20 20 43 6f 72 72 75  orrupted.  Corru
28b0: 70 74 69 6f 6e 20 6d 69 67 68 74 20 6f 63 63 75  ption might occu
28c0: 72 20 64 75 65 20 74 6f 20 61 20 72 6f 67 75 65  r due to a rogue
28d0: 0a 70 72 6f 63 65 73 73 20 77 72 69 74 69 6e 67  .process writing
28e0: 20 74 6f 20 74 68 65 20 64 61 74 61 62 61 73 65   to the database
28f0: 20 66 69 6c 65 20 6f 72 20 69 74 20 6d 69 67 68   file or it migh
2900: 74 20 68 61 70 70 65 6e 20 64 75 65 20 74 6f 20  t happen due to 
2910: 61 6e 20 0a 70 65 72 76 69 6f 75 73 6c 79 20 75  an .perviously u
2920: 6e 64 65 74 65 63 74 65 64 20 6c 6f 67 69 63 20  ndetected logic 
2930: 65 72 72 6f 72 20 69 6e 20 6f 66 20 53 51 4c 69  error in of SQLi
2940: 74 65 2e 20 54 68 69 73 20 76 61 6c 75 65 20 69  te. This value i
2950: 73 20 61 6c 73 6f 0a 72 65 74 75 72 6e 65 64 20  s also.returned 
2960: 69 66 20 61 20 64 69 73 6b 20 49 2f 4f 20 65 72  if a disk I/O er
2970: 72 6f 72 20 6f 63 63 75 72 73 20 69 6e 20 73 75  ror occurs in su
2980: 63 68 20 61 20 77 61 79 20 74 68 61 74 20 53 51  ch a way that SQ
2990: 4c 69 74 65 20 69 73 20 66 6f 72 63 65 64 0a 74  Lite is forced.t
29a0: 6f 20 6c 65 61 76 65 20 74 68 65 20 64 61 74 61  o leave the data
29b0: 62 61 73 65 20 66 69 6c 65 20 69 6e 20 61 20 63  base file in a c
29c0: 6f 72 72 75 70 74 65 64 20 73 74 61 74 65 2e 20  orrupted state. 
29d0: 20 54 68 65 20 6c 61 74 74 65 72 20 73 68 6f 75   The latter shou
29e0: 6c 64 20 6f 6e 6c 79 0a 68 61 70 70 65 6e 20 64  ld only.happen d
29f0: 75 65 20 74 6f 20 61 20 68 61 72 64 77 61 72 65  ue to a hardware
2a00: 20 6f 72 20 6f 70 65 72 61 74 69 6e 67 20 73 79   or operating sy
2a10: 73 74 65 6d 20 6d 61 6c 66 75 6e 63 74 69 6f 6e  stem malfunction
2a20: 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e  ..</p></dd>.<dt>
2a30: 53 51 4c 49 54 45 5f 46 55 4c 4c 3c 2f 64 74 3e  SQLITE_FULL</dt>
2a40: 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 76 61 6c  .<dd><p>This val
2a50: 75 65 20 69 73 20 72 65 74 75 72 6e 65 64 20 69  ue is returned i
2a60: 66 20 61 6e 20 69 6e 73 65 72 74 69 6f 6e 20 66  f an insertion f
2a70: 61 69 6c 65 64 20 62 65 63 61 75 73 65 20 74 68  ailed because th
2a80: 65 72 65 20 69 73 0a 6e 6f 20 73 70 61 63 65 20  ere is.no space 
2a90: 6c 65 66 74 20 6f 6e 20 74 68 65 20 64 69 73 6b  left on the disk
2aa0: 2c 20 6f 72 20 74 68 65 20 64 61 74 61 62 61 73  , or the databas
2ab0: 65 20 69 73 20 74 6f 6f 20 62 69 67 20 74 6f 20  e is too big to 
2ac0: 68 6f 6c 64 20 61 6e 79 0a 6d 6f 72 65 20 69 6e  hold any.more in
2ad0: 66 6f 72 6d 61 74 69 6f 6e 2e 20 20 54 68 65 20  formation.  The 
2ae0: 6c 61 74 74 65 72 20 63 61 73 65 20 73 68 6f 75  latter case shou
2af0: 6c 64 20 6f 6e 6c 79 20 6f 63 63 75 72 20 66 6f  ld only occur fo
2b00: 72 20 64 61 74 61 62 61 73 65 73 0a 74 68 61 74  r databases.that
2b10: 20 61 72 65 20 6c 61 72 67 65 72 20 74 68 61 6e   are larger than
2b20: 20 32 47 42 20 69 6e 20 73 69 7a 65 2e 0a 3c 2f   2GB in size..</
2b30: 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51 4c 49  p></dd>.<dt>SQLI
2b40: 54 45 5f 43 41 4e 54 4f 50 45 4e 3c 2f 64 74 3e  TE_CANTOPEN</dt>
2b50: 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 76 61 6c  .<dd><p>This val
2b60: 75 65 20 69 73 20 72 65 74 75 72 6e 65 64 20 69  ue is returned i
2b70: 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66  f the database f
2b80: 69 6c 65 20 63 6f 75 6c 64 20 6e 6f 74 20 62 65  ile could not be
2b90: 20 6f 70 65 6e 65 64 0a 66 6f 72 20 73 6f 6d 65   opened.for some
2ba0: 20 72 65 61 73 6f 6e 2e 0a 3c 2f 70 3e 3c 2f 64   reason..</p></d
2bb0: 64 3e 0a 3c 64 74 3e 53 51 4c 49 54 45 5f 50 52  d>.<dt>SQLITE_PR
2bc0: 4f 54 4f 43 4f 4c 3c 2f 64 74 3e 0a 3c 64 64 3e  OTOCOL</dt>.<dd>
2bd0: 3c 70 3e 54 68 69 73 20 76 61 6c 75 65 20 69 73  <p>This value is
2be0: 20 72 65 74 75 72 6e 65 64 20 69 66 20 73 6f 6d   returned if som
2bf0: 65 20 6f 74 68 65 72 20 70 72 6f 63 65 73 73 20  e other process 
2c00: 69 73 20 6d 65 73 73 69 6e 67 20 77 69 74 68 0a  is messing with.
2c10: 66 69 6c 65 20 6c 6f 63 6b 73 20 61 6e 64 20 68  file locks and h
2c20: 61 73 20 76 69 6f 6c 61 74 65 64 20 74 68 65 20  as violated the 
2c30: 66 69 6c 65 20 6c 6f 63 6b 69 6e 67 20 70 72 6f  file locking pro
2c40: 74 6f 63 6f 6c 20 74 68 61 74 20 53 51 4c 69 74  tocol that SQLit
2c50: 65 20 75 73 65 73 0a 6f 6e 20 69 74 73 20 72 6f  e uses.on its ro
2c60: 6c 6c 62 61 63 6b 20 6a 6f 75 72 6e 61 6c 20 66  llback journal f
2c70: 69 6c 65 73 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a  iles..</p></dd>.
2c80: 3c 64 74 3e 53 51 4c 49 54 45 5f 53 43 48 45 4d  <dt>SQLITE_SCHEM
2c90: 41 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 57 68  A</dt>.<dd><p>Wh
2ca0: 65 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20  en the database 
2cb0: 66 69 72 73 74 20 6f 70 65 6e 65 64 2c 20 53 51  first opened, SQ
2cc0: 4c 69 74 65 20 72 65 61 64 73 20 74 68 65 20 64  Lite reads the d
2cd0: 61 74 61 62 61 73 65 20 73 63 68 65 6d 61 0a 69  atabase schema.i
2ce0: 6e 74 6f 20 6d 65 6d 6f 72 79 20 61 6e 64 20 75  nto memory and u
2cf0: 73 65 73 20 74 68 61 74 20 73 63 68 65 6d 61 20  ses that schema 
2d00: 74 6f 20 70 61 72 73 65 20 6e 65 77 20 53 51 4c  to parse new SQL
2d10: 20 73 74 61 74 65 6d 65 6e 74 73 2e 20 20 49 66   statements.  If
2d20: 20 61 6e 6f 74 68 65 72 0a 70 72 6f 63 65 73 73   another.process
2d30: 20 63 68 61 6e 67 65 73 20 74 68 65 20 73 63 68   changes the sch
2d40: 65 6d 61 2c 20 74 68 65 20 63 6f 6d 6d 61 6e 64  ema, the command
2d50: 20 63 75 72 72 65 6e 74 6c 79 20 62 65 69 6e 67   currently being
2d60: 20 70 72 6f 63 65 73 73 65 64 20 77 69 6c 6c 0a   processed will.
2d70: 61 62 6f 72 74 20 62 65 63 61 75 73 65 20 74 68  abort because th
2d80: 65 20 76 69 72 74 75 61 6c 20 6d 61 63 68 69 6e  e virtual machin
2d90: 65 20 63 6f 64 65 20 67 65 6e 65 72 61 74 65 64  e code generated
2da0: 20 61 73 73 75 6d 65 64 20 74 68 65 20 6f 6c 64   assumed the old
2db0: 0a 73 63 68 65 6d 61 2e 20 20 54 68 69 73 20 69  .schema.  This i
2dc0: 73 20 74 68 65 20 72 65 74 75 72 6e 20 63 6f 64  s the return cod
2dd0: 65 20 66 6f 72 20 73 75 63 68 20 63 61 73 65 73  e for such cases
2de0: 2e 20 20 52 65 74 72 79 69 6e 67 20 74 68 65 0a  .  Retrying the.
2df0: 63 6f 6d 6d 61 6e 64 20 75 73 75 61 6c 6c 79 20  command usually 
2e00: 77 69 6c 6c 20 63 6c 65 61 72 20 74 68 65 20 70  will clear the p
2e10: 72 6f 62 6c 65 6d 2e 0a 3c 2f 70 3e 3c 2f 64 64  roblem..</p></dd
2e20: 3e 0a 3c 64 74 3e 53 51 4c 49 54 45 5f 54 4f 4f  >.<dt>SQLITE_TOO
2e30: 42 49 47 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e  BIG</dt>.<dd><p>
2e40: 53 51 4c 69 74 65 20 77 69 6c 6c 20 6e 6f 74 20  SQLite will not 
2e50: 73 74 6f 72 65 20 6d 6f 72 65 20 74 68 61 6e 20  store more than 
2e60: 61 62 6f 75 74 20 31 20 6d 65 67 61 62 79 74 65  about 1 megabyte
2e70: 20 6f 66 20 64 61 74 61 20 69 6e 20 61 20 73 69   of data in a si
2e80: 6e 67 6c 65 0a 72 6f 77 20 6f 66 20 61 20 73 69  ngle.row of a si
2e90: 6e 67 6c 65 20 74 61 62 6c 65 2e 20 20 49 66 20  ngle table.  If 
2ea0: 79 6f 75 20 61 74 74 65 6d 70 74 20 74 6f 20 73  you attempt to s
2eb0: 74 6f 72 65 20 6d 6f 72 65 20 74 68 61 6e 20 31  tore more than 1
2ec0: 20 6d 65 67 61 62 79 74 65 0a 69 6e 20 61 20 73   megabyte.in a s
2ed0: 69 6e 67 6c 65 20 72 6f 77 2c 20 74 68 69 73 20  ingle row, this 
2ee0: 69 73 20 74 68 65 20 72 65 74 75 72 6e 20 63 6f  is the return co
2ef0: 64 65 20 79 6f 75 20 67 65 74 2e 0a 3c 2f 70 3e  de you get..</p>
2f00: 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51 4c 49 54 45  </dd>.<dt>SQLITE
2f10: 5f 43 4f 4e 53 54 52 41 49 4e 54 3c 2f 64 74 3e  _CONSTRAINT</dt>
2f20: 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 63 6f 6e  .<dd><p>This con
2f30: 73 74 61 6e 74 20 69 73 20 72 65 74 75 72 6e 65  stant is returne
2f40: 64 20 69 66 20 74 68 65 20 53 51 4c 20 73 74 61  d if the SQL sta
2f50: 74 65 6d 65 6e 74 20 77 6f 75 6c 64 20 68 61 76  tement would hav
2f60: 65 20 76 69 6f 6c 61 74 65 64 0a 61 20 64 61 74  e violated.a dat
2f70: 61 62 61 73 65 20 63 6f 6e 73 74 72 61 69 6e 74  abase constraint
2f80: 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e  ..</p></dd>.<dt>
2f90: 53 51 4c 49 54 45 5f 4d 49 53 4d 41 54 43 48 3c  SQLITE_MISMATCH<
2fa0: 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73  /dt>.<dd><p>This
2fb0: 20 65 72 72 6f 72 20 6f 63 63 75 72 73 20 77 68   error occurs wh
2fc0: 65 6e 20 74 68 65 72 65 20 69 73 20 61 6e 20 61  en there is an a
2fd0: 74 74 65 6d 70 74 20 74 6f 20 69 6e 73 65 72 74  ttempt to insert
2fe0: 20 6e 6f 6e 2d 69 6e 74 65 67 65 72 0a 64 61 74   non-integer.dat
2ff0: 61 20 69 6e 74 6f 20 61 20 63 6f 6c 75 6d 6e 20  a into a column 
3000: 6c 61 62 65 6c 65 64 20 49 4e 54 45 47 45 52 20  labeled INTEGER 
3010: 50 52 49 4d 41 52 59 20 4b 45 59 2e 20 20 46 6f  PRIMARY KEY.  Fo
3020: 72 20 6d 6f 73 74 20 63 6f 6c 75 6d 6e 73 2c 20  r most columns, 
3030: 53 51 4c 69 74 65 0a 69 67 6e 6f 72 65 73 20 74  SQLite.ignores t
3040: 68 65 20 64 61 74 61 20 74 79 70 65 20 61 6e 64  he data type and
3050: 20 61 6c 6c 6f 77 73 20 61 6e 79 20 6b 69 6e 64   allows any kind
3060: 20 6f 66 20 64 61 74 61 20 74 6f 20 62 65 20 73   of data to be s
3070: 74 6f 72 65 64 2e 20 20 42 75 74 0a 61 6e 20 49  tored.  But.an I
3080: 4e 54 45 47 45 52 20 50 52 49 4d 41 52 59 20 4b  NTEGER PRIMARY K
3090: 45 59 20 63 6f 6c 75 6d 6e 20 69 73 20 6f 6e 6c  EY column is onl
30a0: 79 20 61 6c 6c 6f 77 65 64 20 74 6f 20 73 74 6f  y allowed to sto
30b0: 72 65 20 69 6e 74 65 67 65 72 20 64 61 74 61 2e  re integer data.
30c0: 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53  .</p></dd>.<dt>S
30d0: 51 4c 49 54 45 5f 4d 49 53 55 53 45 3c 2f 64 74  QLITE_MISUSE</dt
30e0: 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 65 72  >.<dd><p>This er
30f0: 72 6f 72 20 6d 69 67 68 74 20 6f 63 63 75 72 20  ror might occur 
3100: 69 66 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 20 6f  if one or more o
3110: 66 20 74 68 65 20 53 51 4c 69 74 65 20 41 50 49  f the SQLite API
3120: 20 72 6f 75 74 69 6e 65 73 0a 69 73 20 75 73 65   routines.is use
3130: 64 20 69 6e 63 6f 72 72 65 63 74 6c 79 2e 20 20  d incorrectly.  
3140: 45 78 61 6d 70 6c 65 73 20 6f 66 20 69 6e 63 6f  Examples of inco
3150: 72 72 65 63 74 20 75 73 61 67 65 20 69 6e 63 6c  rrect usage incl
3160: 75 64 65 20 63 61 6c 6c 69 6e 67 0a 3c 62 3e 73  ude calling.<b>s
3170: 71 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e  qlite_exec()</b>
3180: 20 61 66 74 65 72 20 74 68 65 20 64 61 74 61 62   after the datab
3190: 61 73 65 20 68 61 73 20 62 65 65 6e 20 63 6c 6f  ase has been clo
31a0: 73 65 64 20 75 73 69 6e 67 0a 3c 62 3e 73 71 6c  sed using.<b>sql
31b0: 69 74 65 5f 63 6c 6f 73 65 28 29 3c 2f 62 3e 20  ite_close()</b> 
31c0: 6f 72 20 63 61 6c 6c 69 6e 67 20 3c 62 3e 73 71  or calling <b>sq
31d0: 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e 20  lite_exec()</b> 
31e0: 77 69 74 68 20 74 68 65 20 73 61 6d 65 0a 64 61  with the same.da
31f0: 74 61 62 61 73 65 20 70 6f 69 6e 74 65 72 20 73  tabase pointer s
3200: 69 6d 75 6c 74 61 6e 65 6f 75 73 6c 79 20 66 72  imultaneously fr
3210: 6f 6d 20 74 77 6f 20 73 65 70 61 72 61 74 65 20  om two separate 
3220: 74 68 72 65 61 64 73 2e 0a 54 68 69 73 20 65 72  threads..This er
3230: 72 6f 72 20 63 6f 64 65 20 77 69 6c 6c 20 61 6c  ror code will al
3240: 73 6f 20 62 65 20 72 65 74 75 72 6e 65 64 20 75  so be returned u
3250: 6e 64 65 72 20 55 6e 69 78 20 69 66 20 3c 62 3e  nder Unix if <b>
3260: 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62  sqlite_exec()</b
3270: 3e 0a 69 73 20 63 61 6c 6c 65 64 20 77 68 69 6c  >.is called whil
3280: 65 20 61 20 74 72 61 6e 73 61 63 74 69 6f 6e 20  e a transaction 
3290: 69 73 20 70 65 6e 64 69 6e 67 20 74 68 61 74 20  is pending that 
32a0: 77 61 73 20 73 74 61 72 74 65 64 20 69 6e 20 61  was started in a
32b0: 6e 6f 74 68 65 72 0a 70 72 6f 63 65 73 73 20 6f  nother.process o
32c0: 72 20 74 68 72 65 61 64 20 74 68 61 74 20 68 61  r thread that ha
32d0: 73 20 61 20 64 69 66 66 65 72 65 6e 74 20 70 72  s a different pr
32e0: 6f 63 65 73 73 20 49 44 2e 20 20 0a 3c 2f 70 3e  ocess ID.  .</p>
32f0: 3c 2f 64 64 3e 0a 3c 2f 64 6c 3e 0a 3c 2f 62 6c  </dd>.</dl>.</bl
3300: 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 68 32 3e 54  ockquote>..<h2>T
3310: 68 65 20 45 78 74 65 6e 64 65 64 20 41 50 49 3c  he Extended API<
3320: 2f 68 32 3e 0a 0a 3c 70 3e 4f 6e 6c 79 20 74 68  /h2>..<p>Only th
3330: 65 20 74 68 72 65 65 20 63 6f 72 65 20 72 6f 75  e three core rou
3340: 74 69 6e 65 73 20 73 68 6f 77 6e 20 61 62 6f 76  tines shown abov
3350: 65 20 61 72 65 20 72 65 71 75 69 72 65 64 20 74  e are required t
3360: 6f 20 75 73 65 0a 53 51 4c 69 74 65 2e 20 20 42  o use.SQLite.  B
3370: 75 74 20 74 68 65 72 65 20 61 72 65 20 6d 61 6e  ut there are man
3380: 79 20 6f 74 68 65 72 20 66 75 6e 63 74 69 6f 6e  y other function
3390: 73 20 74 68 61 74 20 70 72 6f 76 69 64 65 20 0a  s that provide .
33a0: 75 73 65 66 75 6c 20 69 6e 74 65 72 66 61 63 65  useful interface
33b0: 73 2e 20 20 54 68 65 73 65 20 65 78 74 65 6e 64  s.  These extend
33c0: 65 64 20 72 6f 75 74 69 6e 65 73 20 61 72 65 20  ed routines are 
33d0: 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a 3c 2f 70 3e  as follows:.</p>
33e0: 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70  ..<blockquote><p
33f0: 72 65 3e 0a 69 6e 74 20 73 71 6c 69 74 65 5f 6c  re>.int sqlite_l
3400: 61 73 74 5f 69 6e 73 65 72 74 5f 72 6f 77 69 64  ast_insert_rowid
3410: 28 73 71 6c 69 74 65 2a 29 3b 0a 0a 69 6e 74 20  (sqlite*);..int 
3420: 73 71 6c 69 74 65 5f 63 68 61 6e 67 65 73 28 73  sqlite_changes(s
3430: 71 6c 69 74 65 2a 29 3b 0a 0a 69 6e 74 20 73 71  qlite*);..int sq
3440: 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 28 0a  lite_get_table(.
3450: 20 20 73 71 6c 69 74 65 2a 2c 0a 20 20 63 68 61    sqlite*,.  cha
3460: 72 20 2a 73 71 6c 2c 0a 20 20 63 68 61 72 20 2a  r *sql,.  char *
3470: 2a 2a 72 65 73 75 6c 74 2c 0a 20 20 69 6e 74 20  **result,.  int 
3480: 2a 6e 72 6f 77 2c 0a 20 20 69 6e 74 20 2a 6e 63  *nrow,.  int *nc
3490: 6f 6c 75 6d 6e 2c 0a 20 20 63 68 61 72 20 2a 2a  olumn,.  char **
34a0: 65 72 72 6d 73 67 0a 29 3b 0a 0a 76 6f 69 64 20  errmsg.);..void 
34b0: 73 71 6c 69 74 65 5f 66 72 65 65 5f 74 61 62 6c  sqlite_free_tabl
34c0: 65 28 63 68 61 72 2a 2a 29 3b 0a 0a 76 6f 69 64  e(char**);..void
34d0: 20 73 71 6c 69 74 65 5f 69 6e 74 65 72 72 75 70   sqlite_interrup
34e0: 74 28 73 71 6c 69 74 65 2a 29 3b 0a 0a 69 6e 74  t(sqlite*);..int
34f0: 20 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74 65   sqlite_complete
3500: 28 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 71 6c  (const char *sql
3510: 29 3b 0a 0a 76 6f 69 64 20 73 71 6c 69 74 65 5f  );..void sqlite_
3520: 62 75 73 79 5f 68 61 6e 64 6c 65 72 28 73 71 6c  busy_handler(sql
3530: 69 74 65 2a 2c 20 69 6e 74 20 28 2a 29 28 76 6f  ite*, int (*)(vo
3540: 69 64 2a 2c 63 6f 6e 73 74 20 63 68 61 72 2a 2c  id*,const char*,
3550: 69 6e 74 29 2c 20 76 6f 69 64 2a 29 3b 0a 0a 76  int), void*);..v
3560: 6f 69 64 20 73 71 6c 69 74 65 5f 62 75 73 79 5f  oid sqlite_busy_
3570: 74 69 6d 65 6f 75 74 28 73 71 6c 69 74 65 2a 2c  timeout(sqlite*,
3580: 20 69 6e 74 20 6d 73 29 3b 0a 0a 63 6f 6e 73 74   int ms);..const
3590: 20 63 68 61 72 20 73 71 6c 69 74 65 5f 76 65 72   char sqlite_ver
35a0: 73 69 6f 6e 5b 5d 3b 0a 0a 63 6f 6e 73 74 20 63  sion[];..const c
35b0: 68 61 72 20 73 71 6c 69 74 65 5f 65 6e 63 6f 64  har sqlite_encod
35c0: 69 6e 67 5b 5d 3b 0a 0a 69 6e 74 20 73 71 6c 69  ing[];..int sqli
35d0: 74 65 5f 65 78 65 63 5f 70 72 69 6e 74 66 28 0a  te_exec_printf(.
35e0: 20 20 73 71 6c 69 74 65 2a 2c 0a 20 20 63 68 61    sqlite*,.  cha
35f0: 72 20 2a 73 71 6c 2c 0a 20 20 69 6e 74 20 28 2a  r *sql,.  int (*
3600: 29 28 76 6f 69 64 2a 2c 69 6e 74 2c 63 68 61 72  )(void*,int,char
3610: 2a 2a 2c 63 68 61 72 2a 2a 29 2c 0a 20 20 76 6f  **,char**),.  vo
3620: 69 64 2a 2c 0a 20 20 63 68 61 72 20 2a 2a 65 72  id*,.  char **er
3630: 72 6d 73 67 2c 0a 20 20 2e 2e 2e 0a 29 3b 0a 0a  rmsg,.  ....);..
3640: 69 6e 74 20 73 71 6c 69 74 65 5f 65 78 65 63 5f  int sqlite_exec_
3650: 76 70 72 69 6e 74 66 28 0a 20 20 73 71 6c 69 74  vprintf(.  sqlit
3660: 65 2a 2c 0a 20 20 63 68 61 72 20 2a 73 71 6c 2c  e*,.  char *sql,
3670: 0a 20 20 69 6e 74 20 28 2a 29 28 76 6f 69 64 2a  .  int (*)(void*
3680: 2c 69 6e 74 2c 63 68 61 72 2a 2a 2c 63 68 61 72  ,int,char**,char
3690: 2a 2a 29 2c 0a 20 20 76 6f 69 64 2a 2c 0a 20 20  **),.  void*,.  
36a0: 63 68 61 72 20 2a 2a 65 72 72 6d 73 67 2c 0a 20  char **errmsg,. 
36b0: 20 76 61 5f 6c 69 73 74 0a 29 3b 0a 0a 69 6e 74   va_list.);..int
36c0: 20 73 71 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c   sqlite_get_tabl
36d0: 65 5f 70 72 69 6e 74 66 28 0a 20 20 73 71 6c 69  e_printf(.  sqli
36e0: 74 65 2a 2c 0a 20 20 63 68 61 72 20 2a 73 71 6c  te*,.  char *sql
36f0: 2c 0a 20 20 63 68 61 72 20 2a 2a 2a 72 65 73 75  ,.  char ***resu
3700: 6c 74 2c 0a 20 20 69 6e 74 20 2a 6e 72 6f 77 2c  lt,.  int *nrow,
3710: 0a 20 20 69 6e 74 20 2a 6e 63 6f 6c 75 6d 6e 2c  .  int *ncolumn,
3720: 0a 20 20 63 68 61 72 20 2a 2a 65 72 72 6d 73 67  .  char **errmsg
3730: 2c 0a 20 20 2e 2e 2e 0a 29 3b 0a 0a 69 6e 74 20  ,.  ....);..int 
3740: 73 71 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65  sqlite_get_table
3750: 5f 76 70 72 69 6e 74 66 28 0a 20 20 73 71 6c 69  _vprintf(.  sqli
3760: 74 65 2a 2c 0a 20 20 63 68 61 72 20 2a 73 71 6c  te*,.  char *sql
3770: 2c 0a 20 20 63 68 61 72 20 2a 2a 2a 72 65 73 75  ,.  char ***resu
3780: 6c 74 2c 0a 20 20 69 6e 74 20 2a 6e 72 6f 77 2c  lt,.  int *nrow,
3790: 0a 20 20 69 6e 74 20 2a 6e 63 6f 6c 75 6d 6e 2c  .  int *ncolumn,
37a0: 0a 20 20 63 68 61 72 20 2a 2a 65 72 72 6d 73 67  .  char **errmsg
37b0: 2c 0a 20 20 76 61 5f 6c 69 73 74 0a 29 3b 0a 0a  ,.  va_list.);..
37c0: 63 68 61 72 20 2a 73 71 6c 69 74 65 5f 6d 70 72  char *sqlite_mpr
37d0: 69 6e 74 66 28 63 6f 6e 73 74 20 63 68 61 72 20  intf(const char 
37e0: 2a 7a 46 6f 72 6d 61 74 2c 20 2e 2e 2e 29 3b 0a  *zFormat, ...);.
37f0: 0a 63 68 61 72 20 2a 73 71 6c 69 74 65 5f 76 6d  .char *sqlite_vm
3800: 70 72 69 6e 74 66 28 63 6f 6e 73 74 20 63 68 61  printf(const cha
3810: 72 20 2a 7a 46 6f 72 6d 61 74 2c 20 76 61 5f 6c  r *zFormat, va_l
3820: 69 73 74 29 3b 0a 0a 76 6f 69 64 20 73 71 6c 69  ist);..void sqli
3830: 74 65 5f 66 72 65 65 6d 65 6d 28 63 68 61 72 2a  te_freemem(char*
3840: 29 3b 0a 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63  );..</pre></bloc
3850: 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 41 6c 6c 20  kquote>..<p>All 
3860: 6f 66 20 74 68 65 20 61 62 6f 76 65 20 64 65 66  of the above def
3870: 69 6e 69 74 69 6f 6e 73 20 61 72 65 20 69 6e 63  initions are inc
3880: 6c 75 64 65 64 20 69 6e 20 74 68 65 20 22 73 71  luded in the "sq
3890: 6c 69 74 65 2e 68 22 0a 68 65 61 64 65 72 20 66  lite.h".header f
38a0: 69 6c 65 20 74 68 61 74 20 63 6f 6d 65 73 20 69  ile that comes i
38b0: 6e 20 74 68 65 20 73 6f 75 72 63 65 20 74 72 65  n the source tre
38c0: 65 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 54 68 65 20  e.</p>..<h2>The 
38d0: 52 4f 57 49 44 20 6f 66 20 74 68 65 20 6d 6f 73  ROWID of the mos
38e0: 74 20 72 65 63 65 6e 74 20 69 6e 73 65 72 74 3c  t recent insert<
38f0: 2f 68 32 3e 0a 0a 3c 70 3e 45 76 65 72 79 20 72  /h2>..<p>Every r
3900: 6f 77 20 6f 66 20 61 6e 20 53 51 4c 69 74 65 20  ow of an SQLite 
3910: 74 61 62 6c 65 20 68 61 73 20 61 20 75 6e 69 71  table has a uniq
3920: 75 65 20 69 6e 74 65 67 65 72 20 6b 65 79 2e 20  ue integer key. 
3930: 20 49 66 20 74 68 65 0a 74 61 62 6c 65 20 68 61   If the.table ha
3940: 73 20 61 20 63 6f 6c 75 6d 6e 20 6c 61 62 65 6c  s a column label
3950: 65 64 20 49 4e 54 45 47 45 52 20 50 52 49 4d 41  ed INTEGER PRIMA
3960: 52 59 20 4b 45 59 2c 20 74 68 65 6e 20 74 68 61  RY KEY, then tha
3970: 74 20 63 6f 6c 75 6d 6e 0a 73 65 72 76 65 73 20  t column.serves 
3980: 61 73 20 74 68 65 20 6b 65 79 2e 20 20 49 66 20  as the key.  If 
3990: 74 68 65 72 65 20 69 73 20 6e 6f 20 49 4e 54 45  there is no INTE
39a0: 47 45 52 20 50 52 49 4d 41 52 59 20 4b 45 59 20  GER PRIMARY KEY 
39b0: 63 6f 6c 75 6d 6e 20 74 68 65 6e 0a 74 68 65 20  column then.the 
39c0: 6b 65 79 20 69 73 20 61 20 75 6e 69 71 75 65 20  key is a unique 
39d0: 69 6e 74 65 67 65 72 2e 20 20 54 68 65 20 6b 65  integer.  The ke
39e0: 79 20 66 6f 72 20 61 20 72 6f 77 20 63 61 6e 20  y for a row can 
39f0: 62 65 20 61 63 63 65 73 73 65 64 20 69 6e 0a 61  be accessed in.a
3a00: 20 53 45 4c 45 43 54 20 73 74 61 74 65 6d 65 6e   SELECT statemen
3a10: 74 20 6f 72 20 75 73 65 64 20 69 6e 20 61 20 57  t or used in a W
3a20: 48 45 52 45 20 6f 72 20 4f 52 44 45 52 20 42 59  HERE or ORDER BY
3a30: 20 63 6c 61 75 73 65 20 75 73 69 6e 67 20 61 6e   clause using an
3a40: 79 0a 6f 66 20 74 68 65 20 6e 61 6d 65 73 20 22  y.of the names "
3a50: 52 4f 57 49 44 22 2c 20 22 4f 49 44 22 2c 20 6f  ROWID", "OID", o
3a60: 72 20 22 5f 52 4f 57 49 44 5f 22 2e 3c 2f 70 3e  r "_ROWID_".</p>
3a70: 0a 0a 3c 70 3e 57 68 65 6e 20 79 6f 75 20 64 6f  ..<p>When you do
3a80: 20 61 6e 20 69 6e 73 65 72 74 20 69 6e 74 6f 20   an insert into 
3a90: 61 20 74 61 62 6c 65 20 74 68 61 74 20 64 6f 65  a table that doe
3aa0: 73 20 6e 6f 74 20 68 61 76 65 20 61 6e 20 49 4e  s not have an IN
3ab0: 54 45 47 45 52 20 50 52 49 4d 41 52 59 0a 4b 45  TEGER PRIMARY.KE
3ac0: 59 20 63 6f 6c 75 6d 6e 2c 20 6f 72 20 69 66 20  Y column, or if 
3ad0: 74 68 65 20 74 61 62 6c 65 20 64 6f 65 73 20 68  the table does h
3ae0: 61 76 65 20 61 6e 20 49 4e 54 45 47 45 52 20 50  ave an INTEGER P
3af0: 52 49 4d 41 52 59 20 4b 45 59 20 62 75 74 20 74  RIMARY KEY but t
3b00: 68 65 20 76 61 6c 75 65 0a 66 6f 72 20 74 68 61  he value.for tha
3b10: 74 20 63 6f 6c 75 6d 6e 20 69 73 20 6e 6f 74 20  t column is not 
3b20: 73 70 65 63 69 66 69 65 64 20 69 6e 20 74 68 65  specified in the
3b30: 20 56 41 4c 55 45 53 20 63 6c 61 75 73 65 20 6f   VALUES clause o
3b40: 66 20 74 68 65 20 69 6e 73 65 72 74 2c 20 74 68  f the insert, th
3b50: 65 6e 0a 74 68 65 20 6b 65 79 20 69 73 20 61 75  en.the key is au
3b60: 74 6f 6d 61 74 69 63 61 6c 6c 79 20 67 65 6e 65  tomatically gene
3b70: 72 61 74 65 64 2e 20 20 59 6f 75 20 63 61 6e 20  rated.  You can 
3b80: 66 69 6e 64 20 74 68 65 20 76 61 6c 75 65 20 6f  find the value o
3b90: 66 20 74 68 65 20 6b 65 79 0a 66 6f 72 20 74 68  f the key.for th
3ba0: 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 20 49 4e  e most recent IN
3bb0: 53 45 52 54 20 73 74 61 74 65 6d 65 6e 74 20 75  SERT statement u
3bc0: 73 69 6e 67 20 74 68 65 0a 3c 62 3e 73 71 6c 69  sing the.<b>sqli
3bd0: 74 65 5f 6c 61 73 74 5f 69 6e 73 65 72 74 5f 72  te_last_insert_r
3be0: 6f 77 69 64 28 29 3c 2f 62 3e 20 41 50 49 20 66  owid()</b> API f
3bf0: 75 6e 63 74 69 6f 6e 2e 3c 2f 70 3e 0a 0a 3c 68  unction.</p>..<h
3c00: 32 3e 54 68 65 20 6e 75 6d 62 65 72 20 6f 66 20  2>The number of 
3c10: 72 6f 77 73 20 74 68 61 74 20 63 68 61 6e 67 65  rows that change
3c20: 64 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65 20 3c  d</h2>..<p>The <
3c30: 62 3e 73 71 6c 69 74 65 5f 63 68 61 6e 67 65 73  b>sqlite_changes
3c40: 28 29 3c 2f 62 3e 20 41 50 49 20 66 75 6e 63 74  ()</b> API funct
3c50: 69 6f 6e 20 72 65 74 75 72 6e 73 20 74 68 65 20  ion returns the 
3c60: 6e 75 6d 62 65 72 20 6f 66 20 72 6f 77 73 0a 74  number of rows.t
3c70: 68 61 74 20 77 65 72 65 20 69 6e 73 65 72 74 65  hat were inserte
3c80: 64 2c 20 64 65 6c 65 74 65 64 2c 20 6f 72 20 6d  d, deleted, or m
3c90: 6f 64 69 66 69 65 64 20 64 75 72 69 6e 67 20 74  odified during t
3ca0: 68 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 0a 3c  he most recent.<
3cb0: 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c  b>sqlite_exec()<
3cc0: 2f 62 3e 20 63 61 6c 6c 2e 20 20 54 68 65 20 6e  /b> call.  The n
3cd0: 75 6d 62 65 72 20 72 65 70 6f 72 74 65 64 20 69  umber reported i
3ce0: 6e 63 6c 75 64 65 73 20 61 6e 79 20 63 68 61 6e  ncludes any chan
3cf0: 67 65 73 0a 74 68 61 74 20 77 65 72 65 20 6c 61  ges.that were la
3d00: 74 65 72 20 75 6e 64 6f 20 62 79 20 61 20 52 4f  ter undo by a RO
3d10: 4c 4c 42 41 43 4b 20 6f 72 20 41 42 4f 52 54 2e  LLBACK or ABORT.
3d20: 20 20 42 75 74 20 72 6f 77 73 20 74 68 61 74 20    But rows that 
3d30: 61 72 65 0a 64 65 6c 65 74 65 64 20 62 65 63 61  are.deleted beca
3d40: 75 73 65 20 6f 66 20 61 20 44 52 4f 50 20 54 41  use of a DROP TA
3d50: 42 4c 45 20 61 72 65 20 3c 65 6d 3e 6e 6f 74 3c  BLE are <em>not<
3d60: 2f 65 6d 3e 20 63 6f 75 6e 74 65 64 2e 3c 2f 70  /em> counted.</p
3d70: 3e 0a 0a 3c 70 3e 53 51 4c 69 74 65 20 69 6d 70  >..<p>SQLite imp
3d80: 6c 65 6d 65 6e 74 73 20 74 68 65 20 63 6f 6d 6d  lements the comm
3d90: 61 6e 64 20 22 3c 62 3e 44 45 4c 45 54 45 20 46  and "<b>DELETE F
3da0: 52 4f 4d 20 74 61 62 6c 65 3c 2f 62 3e 22 20 28  ROM table</b>" (
3db0: 77 69 74 68 6f 75 74 0a 61 20 57 48 45 52 45 20  without.a WHERE 
3dc0: 63 6c 61 75 73 65 29 20 62 79 20 64 72 6f 70 70  clause) by dropp
3dd0: 69 6e 67 20 74 68 65 20 74 61 62 6c 65 20 74 68  ing the table th
3de0: 65 6e 20 72 65 63 72 65 61 74 69 6e 67 20 69 74  en recreating it
3df0: 2e 20 20 0a 54 68 69 73 20 69 73 20 6d 75 63 68  .  .This is much
3e00: 20 66 61 73 74 65 72 20 74 68 61 6e 20 64 65 6c   faster than del
3e10: 65 74 69 6e 67 20 74 68 65 20 65 6c 65 6d 65 6e  eting the elemen
3e20: 74 73 20 6f 66 20 74 68 65 20 74 61 62 6c 65 20  ts of the table 
3e30: 69 6e 64 69 76 69 64 75 61 6c 6c 79 2e 0a 42 75  individually..Bu
3e40: 74 20 69 74 20 61 6c 73 6f 20 6d 65 61 6e 73 20  t it also means 
3e50: 74 68 61 74 20 74 68 65 20 76 61 6c 75 65 20 72  that the value r
3e60: 65 74 75 72 6e 65 64 20 66 72 6f 6d 20 3c 62 3e  eturned from <b>
3e70: 73 71 6c 69 74 65 5f 63 68 61 6e 67 65 73 28 29  sqlite_changes()
3e80: 3c 2f 62 3e 0a 77 69 6c 6c 20 62 65 20 7a 65 72  </b>.will be zer
3e90: 6f 20 72 65 67 61 72 64 6c 65 73 73 20 6f 66 20  o regardless of 
3ea0: 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 65 6c  the number of el
3eb0: 65 6d 65 6e 74 73 20 74 68 61 74 20 77 65 72 65  ements that were
3ec0: 20 6f 72 69 67 69 6e 61 6c 6c 79 0a 69 6e 20 74   originally.in t
3ed0: 68 65 20 74 61 62 6c 65 2e 20 20 49 66 20 61 6e  he table.  If an
3ee0: 20 61 63 63 75 72 61 74 65 20 63 6f 75 6e 74 20   accurate count 
3ef0: 6f 66 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  of the number of
3f00: 20 65 6c 65 6d 65 6e 74 73 20 64 65 6c 65 74 65   elements delete
3f10: 64 0a 69 73 20 6e 65 63 65 73 73 61 72 79 2c 20  d.is necessary, 
3f20: 75 73 65 20 22 3c 62 3e 44 45 4c 45 54 45 20 46  use "<b>DELETE F
3f30: 52 4f 4d 20 74 61 62 6c 65 20 57 48 45 52 45 20  ROM table WHERE 
3f40: 31 3c 2f 62 3e 22 20 69 6e 73 74 65 61 64 2e 3c  1</b>" instead.<
3f50: 2f 70 3e 0a 0a 3c 68 32 3e 51 75 65 72 79 69 6e  /p>..<h2>Queryin
3f60: 67 20 77 69 74 68 6f 75 74 20 75 73 69 6e 67 20  g without using 
3f70: 61 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74  a callback funct
3f80: 69 6f 6e 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65  ion</h2>..<p>The
3f90: 20 3c 62 3e 73 71 6c 69 74 65 5f 67 65 74 5f 74   <b>sqlite_get_t
3fa0: 61 62 6c 65 28 29 3c 2f 62 3e 20 66 75 6e 63 74  able()</b> funct
3fb0: 69 6f 6e 20 69 73 20 61 20 77 72 61 70 70 65 72  ion is a wrapper
3fc0: 20 61 72 6f 75 6e 64 0a 3c 62 3e 73 71 6c 69 74   around.<b>sqlit
3fd0: 65 5f 65 78 65 63 28 29 3c 2f 62 3e 20 74 68 61  e_exec()</b> tha
3fe0: 74 20 63 6f 6c 6c 65 63 74 73 20 61 6c 6c 20 74  t collects all t
3ff0: 68 65 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 66  he information f
4000: 72 6f 6d 20 73 75 63 63 65 73 73 69 76 65 0a 63  rom successive.c
4010: 61 6c 6c 62 61 63 6b 73 20 61 6e 64 20 77 72 69  allbacks and wri
4020: 74 65 20 69 74 20 69 6e 74 6f 20 6d 65 6d 6f 72  te it into memor
4030: 79 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20  y obtained from 
4040: 6d 61 6c 6c 6f 63 28 29 2e 20 20 54 68 69 73 0a  malloc().  This.
4050: 69 73 20 61 20 63 6f 6e 76 65 6e 69 65 6e 63 65  is a convenience
4060: 20 66 75 6e 63 74 69 6f 6e 20 74 68 61 74 20 61   function that a
4070: 6c 6c 6f 77 73 20 74 68 65 20 61 70 70 6c 69 63  llows the applic
4080: 61 74 69 6f 6e 20 74 6f 20 67 65 74 20 74 68 65  ation to get the
4090: 0a 65 6e 74 69 72 65 20 72 65 73 75 6c 74 20 6f  .entire result o
40a0: 66 20 61 20 64 61 74 61 62 61 73 65 20 71 75 65  f a database que
40b0: 72 79 20 77 69 74 68 20 61 20 73 69 6e 67 6c 65  ry with a single
40c0: 20 66 75 6e 63 74 69 6f 6e 20 63 61 6c 6c 2e 3c   function call.<
40d0: 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 6d 61 69 6e  /p>..<p>The main
40e0: 20 72 65 73 75 6c 74 20 66 72 6f 6d 20 3c 62 3e   result from <b>
40f0: 73 71 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65  sqlite_get_table
4100: 28 29 3c 2f 62 3e 20 69 73 20 61 6e 20 61 72 72  ()</b> is an arr
4110: 61 79 20 6f 66 20 70 6f 69 6e 74 65 72 73 0a 74  ay of pointers.t
4120: 6f 20 73 74 72 69 6e 67 73 2e 20 20 54 68 65 72  o strings.  Ther
4130: 65 20 69 73 20 6f 6e 65 20 65 6c 65 6d 65 6e 74  e is one element
4140: 20 69 6e 20 74 68 69 73 20 61 72 72 61 79 20 66   in this array f
4150: 6f 72 20 65 61 63 68 20 63 6f 6c 75 6d 6e 20 6f  or each column o
4160: 66 0a 65 61 63 68 20 72 6f 77 20 69 6e 20 74 68  f.each row in th
4170: 65 20 72 65 73 75 6c 74 2e 20 20 4e 55 4c 4c 20  e result.  NULL 
4180: 72 65 73 75 6c 74 73 20 61 72 65 20 72 65 70 72  results are repr
4190: 65 73 65 6e 74 65 64 20 62 79 20 61 20 4e 55 4c  esented by a NUL
41a0: 4c 0a 70 6f 69 6e 74 65 72 2e 20 49 6e 20 61 64  L.pointer. In ad
41b0: 64 69 74 69 6f 6e 20 74 6f 20 74 68 65 20 72 65  dition to the re
41c0: 67 75 6c 61 72 20 64 61 74 61 2c 20 74 68 65 72  gular data, ther
41d0: 65 20 69 73 20 61 6e 20 61 64 64 65 64 20 72 6f  e is an added ro
41e0: 77 20 61 74 20 74 68 65 20 0a 62 65 67 69 6e 6e  w at the .beginn
41f0: 69 6e 67 20 6f 66 20 74 68 65 20 61 72 72 61 79  ing of the array
4200: 20 74 68 61 74 20 63 6f 6e 74 61 69 6e 73 20 74   that contains t
4210: 68 65 20 6e 61 6d 65 73 20 6f 66 20 65 61 63 68  he names of each
4220: 20 63 6f 6c 75 6d 6e 20 6f 66 20 74 68 65 0a 72   column of the.r
4230: 65 73 75 6c 74 2e 3c 2f 70 3e 0a 0a 3c 70 3e 41  esult.</p>..<p>A
4240: 73 20 61 6e 20 65 78 61 6d 70 6c 65 2c 20 63 6f  s an example, co
4250: 6e 73 69 64 65 72 20 74 68 65 20 66 6f 6c 6c 6f  nsider the follo
4260: 77 69 6e 67 20 71 75 65 72 79 3a 3c 2f 70 3e 0a  wing query:</p>.
4270: 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 53 45  .<blockquote>.SE
4280: 4c 45 43 54 20 65 6d 70 6c 6f 79 65 65 5f 6e 61  LECT employee_na
4290: 6d 65 2c 20 6c 6f 67 69 6e 2c 20 68 6f 73 74 20  me, login, host 
42a0: 46 52 4f 4d 20 75 73 65 72 73 20 57 48 45 52 45  FROM users WHERE
42b0: 20 6c 6f 67 69 63 20 4c 49 4b 45 20 27 64 25 27   logic LIKE 'd%'
42c0: 3b 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  ;.</blockquote>.
42d0: 0a 3c 70 3e 54 68 69 73 20 71 75 65 72 79 20 77  .<p>This query w
42e0: 69 6c 6c 20 72 65 74 75 72 6e 20 74 68 65 20 6e  ill return the n
42f0: 61 6d 65 2c 20 6c 6f 67 69 6e 20 61 6e 64 20 68  ame, login and h
4300: 6f 73 74 20 63 6f 6d 70 75 74 65 72 20 6e 61 6d  ost computer nam
4310: 65 0a 66 6f 72 20 65 76 65 72 79 20 65 6d 70 6c  e.for every empl
4320: 6f 79 65 65 20 77 68 6f 73 65 20 6c 6f 67 69 6e  oyee whose login
4330: 20 62 65 67 69 6e 73 20 77 69 74 68 20 74 68 65   begins with the
4340: 20 6c 65 74 74 65 72 20 22 64 22 2e 20 20 49 66   letter "d".  If
4350: 20 74 68 69 73 0a 71 75 65 72 79 20 69 73 20 73   this.query is s
4360: 75 62 6d 69 74 74 65 64 20 74 6f 20 3c 62 3e 73  ubmitted to <b>s
4370: 71 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 28  qlite_get_table(
4380: 29 3c 2f 62 3e 20 74 68 65 20 72 65 73 75 6c 74  )</b> the result
4390: 20 6d 69 67 68 74 0a 6c 6f 6f 6b 20 6c 69 6b 65   might.look like
43a0: 20 74 68 69 73 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f   this:</p>..<blo
43b0: 63 6b 71 75 6f 74 65 3e 0a 6e 72 6f 77 20 3d 20  ckquote>.nrow = 
43c0: 32 3c 62 72 3e 0a 6e 63 6f 6c 75 6d 6e 20 3d 20  2<br>.ncolumn = 
43d0: 33 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 30 5d 20  3<br>.result[0] 
43e0: 3d 20 22 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65  = "employee_name
43f0: 22 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 31 5d 20  "<br>.result[1] 
4400: 3d 20 22 6c 6f 67 69 6e 22 3c 62 72 3e 0a 72 65  = "login"<br>.re
4410: 73 75 6c 74 5b 32 5d 20 3d 20 22 68 6f 73 74 22  sult[2] = "host"
4420: 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 33 5d 20 3d  <br>.result[3] =
4430: 20 22 64 75 6d 6d 79 22 3c 62 72 3e 0a 72 65 73   "dummy"<br>.res
4440: 75 6c 74 5b 34 5d 20 3d 20 22 4e 6f 20 73 75 63  ult[4] = "No suc
4450: 68 20 75 73 65 72 22 3c 62 72 3e 0a 72 65 73 75  h user"<br>.resu
4460: 6c 74 5b 35 5d 20 3d 20 30 3c 62 72 3e 0a 72 65  lt[5] = 0<br>.re
4470: 73 75 6c 74 5b 36 5d 20 3d 20 22 44 2e 20 52 69  sult[6] = "D. Ri
4480: 63 68 61 72 64 20 48 69 70 70 22 3c 62 72 3e 0a  chard Hipp"<br>.
4490: 72 65 73 75 6c 74 5b 37 5d 20 3d 20 22 64 72 68  result[7] = "drh
44a0: 22 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 38 5d 20  "<br>.result[8] 
44b0: 3d 20 22 7a 61 64 6f 6b 22 0a 3c 2f 62 6c 6f 63  = "zadok".</bloc
44c0: 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 4e 6f 74 69  kquote>..<p>Noti
44d0: 63 65 20 74 68 61 74 20 74 68 65 20 22 68 6f 73  ce that the "hos
44e0: 74 22 20 76 61 6c 75 65 20 66 6f 72 20 74 68 65  t" value for the
44f0: 20 22 64 75 6d 6d 79 22 20 72 65 63 6f 72 64 20   "dummy" record 
4500: 69 73 20 4e 55 4c 4c 20 73 6f 0a 74 68 65 20 72  is NULL so.the r
4510: 65 73 75 6c 74 5b 5d 20 61 72 72 61 79 20 63 6f  esult[] array co
4520: 6e 74 61 69 6e 73 20 61 20 4e 55 4c 4c 20 70 6f  ntains a NULL po
4530: 69 6e 74 65 72 20 61 74 20 74 68 61 74 20 73 6c  inter at that sl
4540: 6f 74 2e 3c 2f 70 3e 0a 0a 3c 70 3e 49 66 20 74  ot.</p>..<p>If t
4550: 68 65 20 72 65 73 75 6c 74 20 73 65 74 20 6f 66  he result set of
4560: 20 61 20 71 75 65 72 79 20 69 73 20 65 6d 70 74   a query is empt
4570: 79 2c 20 74 68 65 6e 20 62 79 20 64 65 66 61 75  y, then by defau
4580: 6c 74 0a 3c 62 3e 73 71 6c 69 74 65 5f 67 65 74  lt.<b>sqlite_get
4590: 5f 74 61 62 6c 65 28 29 3c 2f 62 3e 20 77 69 6c  _table()</b> wil
45a0: 6c 20 73 65 74 20 6e 72 6f 77 20 74 6f 20 30 20  l set nrow to 0 
45b0: 61 6e 64 20 6c 65 61 76 65 20 69 74 73 0a 72 65  and leave its.re
45c0: 73 75 6c 74 20 70 61 72 61 6d 65 74 65 72 20 69  sult parameter i
45d0: 73 20 73 65 74 20 74 6f 20 4e 55 4c 4c 2e 20 20  s set to NULL.  
45e0: 42 75 74 20 69 66 20 74 68 65 20 45 4d 50 54 59  But if the EMPTY
45f0: 5f 52 45 53 55 4c 54 5f 43 41 4c 4c 42 41 43 4b  _RESULT_CALLBACK
4600: 53 0a 70 72 61 67 6d 61 20 69 73 20 4f 4e 20 74  S.pragma is ON t
4610: 68 65 6e 20 74 68 65 20 72 65 73 75 6c 74 20 70  hen the result p
4620: 61 72 61 6d 65 74 65 72 20 69 73 20 69 6e 69 74  arameter is init
4630: 69 61 6c 69 7a 65 64 20 74 6f 20 74 68 65 20 6e  ialized to the n
4640: 61 6d 65 73 0a 6f 66 20 74 68 65 20 63 6f 6c 75  ames.of the colu
4650: 6d 6e 73 20 6f 6e 6c 79 2e 20 20 46 6f 72 20 65  mns only.  For e
4660: 78 61 6d 70 6c 65 2c 20 63 6f 6e 73 69 64 65 72  xample, consider
4670: 20 74 68 69 73 20 71 75 65 72 79 20 77 68 69 63   this query whic
4680: 68 20 68 61 73 0a 61 6e 20 65 6d 70 74 79 20 72  h has.an empty r
4690: 65 73 75 6c 74 20 73 65 74 3a 3c 2f 70 3e 0a 0a  esult set:</p>..
46a0: 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 53 45 4c  <blockquote>.SEL
46b0: 45 43 54 20 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d  ECT employee_nam
46c0: 65 2c 20 6c 6f 67 69 6e 2c 20 68 6f 73 74 20 46  e, login, host F
46d0: 52 4f 4d 20 75 73 65 72 73 20 57 48 45 52 45 20  ROM users WHERE 
46e0: 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65 20 49 53  employee_name IS
46f0: 20 4e 55 4c 4c 3b 0a 3c 2f 62 6c 6f 63 6b 71 75   NULL;.</blockqu
4700: 6f 74 65 3e 0a 0a 3c 70 3e 0a 54 68 65 20 64 65  ote>..<p>.The de
4710: 66 61 75 6c 74 20 62 65 68 61 76 69 6f 72 20 67  fault behavior g
4720: 69 76 65 73 20 74 68 69 73 20 72 65 73 75 6c 74  ives this result
4730: 73 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71  s:.</p>..<blockq
4740: 75 6f 74 65 3e 0a 6e 72 6f 77 20 3d 20 30 3c 62  uote>.nrow = 0<b
4750: 72 3e 0a 6e 63 6f 6c 75 6d 6e 20 3d 20 30 3c 62  r>.ncolumn = 0<b
4760: 72 3e 0a 72 65 73 75 6c 74 20 3d 20 30 3c 62 72  r>.result = 0<br
4770: 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  >.</blockquote>.
4780: 0a 3c 70 3e 0a 42 75 74 20 69 66 20 74 68 65 20  .<p>.But if the 
4790: 45 4d 50 54 59 5f 52 45 53 55 4c 54 5f 43 41 4c  EMPTY_RESULT_CAL
47a0: 4c 42 41 43 4b 53 20 70 72 61 67 6d 61 20 69 73  LBACKS pragma is
47b0: 20 4f 4e 2c 20 74 68 65 6e 20 74 68 65 20 66 6f   ON, then the fo
47c0: 6c 6c 6f 77 69 6e 67 0a 69 73 20 72 65 74 75 72  llowing.is retur
47d0: 6e 65 64 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63  ned:.</p>..<bloc
47e0: 6b 71 75 6f 74 65 3e 0a 6e 72 6f 77 20 3d 20 30  kquote>.nrow = 0
47f0: 3c 62 72 3e 0a 6e 63 6f 6c 75 6d 6e 20 3d 20 33  <br>.ncolumn = 3
4800: 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 30 5d 20 3d  <br>.result[0] =
4810: 20 22 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65 22   "employee_name"
4820: 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 31 5d 20 3d  <br>.result[1] =
4830: 20 22 6c 6f 67 69 6e 22 3c 62 72 3e 0a 72 65 73   "login"<br>.res
4840: 75 6c 74 5b 32 5d 20 3d 20 22 68 6f 73 74 22 3c  ult[2] = "host"<
4850: 62 72 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65  br>.</blockquote
4860: 3e 0a 0a 3c 70 3e 4d 65 6d 6f 72 79 20 74 6f 20  >..<p>Memory to 
4870: 68 6f 6c 64 20 74 68 65 20 69 6e 66 6f 72 6d 61  hold the informa
4880: 74 69 6f 6e 20 72 65 74 75 72 6e 65 64 20 62 79  tion returned by
4890: 20 3c 62 3e 73 71 6c 69 74 65 5f 67 65 74 5f 74   <b>sqlite_get_t
48a0: 61 62 6c 65 28 29 3c 2f 62 3e 0a 69 73 20 6f 62  able()</b>.is ob
48b0: 74 61 69 6e 65 64 20 66 72 6f 6d 20 6d 61 6c 6c  tained from mall
48c0: 6f 63 28 29 2e 20 20 42 75 74 20 74 68 65 20 63  oc().  But the c
48d0: 61 6c 6c 69 6e 67 20 66 75 6e 63 74 69 6f 6e 20  alling function 
48e0: 73 68 6f 75 6c 64 20 6e 6f 74 20 74 72 79 0a 74  should not try.t
48f0: 6f 20 66 72 65 65 20 74 68 69 73 20 69 6e 66 6f  o free this info
4900: 72 6d 61 74 69 6f 6e 20 64 69 72 65 63 74 6c 79  rmation directly
4910: 2e 20 20 49 6e 73 74 65 61 64 2c 20 70 61 73 73  .  Instead, pass
4920: 20 74 68 65 20 63 6f 6d 70 6c 65 74 65 20 74 61   the complete ta
4930: 62 6c 65 0a 74 6f 20 3c 62 3e 73 71 6c 69 74 65  ble.to <b>sqlite
4940: 5f 66 72 65 65 5f 74 61 62 6c 65 28 29 3c 2f 62  _free_table()</b
4950: 3e 20 77 68 65 6e 20 74 68 65 20 74 61 62 6c 65  > when the table
4960: 20 69 73 20 6e 6f 20 6c 6f 6e 67 65 72 20 6e 65   is no longer ne
4970: 65 64 65 64 2e 0a 49 74 20 69 73 20 73 61 66 65  eded..It is safe
4980: 20 74 6f 20 63 61 6c 6c 20 3c 62 3e 73 71 6c 69   to call <b>sqli
4990: 74 65 5f 66 72 65 65 5f 74 61 62 6c 65 28 29 3c  te_free_table()<
49a0: 2f 62 3e 20 77 69 74 68 20 61 20 4e 55 4c 4c 20  /b> with a NULL 
49b0: 70 6f 69 6e 74 65 72 20 73 75 63 68 0a 61 73 20  pointer such.as 
49c0: 77 6f 75 6c 64 20 62 65 20 72 65 74 75 72 6e 65  would be returne
49d0: 64 20 69 66 20 74 68 65 20 72 65 73 75 6c 74 20  d if the result 
49e0: 73 65 74 20 69 73 20 65 6d 70 74 79 2e 3c 2f 70  set is empty.</p
49f0: 3e 0a 0a 3c 70 3e 54 68 65 20 3c 62 3e 73 71 6c  >..<p>The <b>sql
4a00: 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 28 29 3c  ite_get_table()<
4a10: 2f 62 3e 20 72 6f 75 74 69 6e 65 20 72 65 74 75  /b> routine retu
4a20: 72 6e 73 20 74 68 65 20 73 61 6d 65 20 69 6e 74  rns the same int
4a30: 65 67 65 72 0a 72 65 73 75 6c 74 20 63 6f 64 65  eger.result code
4a40: 20 61 73 20 3c 62 3e 73 71 6c 69 74 65 5f 65 78   as <b>sqlite_ex
4a50: 65 63 28 29 3c 2f 62 3e 2e 3c 2f 70 3e 0a 0a 3c  ec()</b>.</p>..<
4a60: 68 32 3e 49 6e 74 65 72 72 75 70 74 69 6e 67 20  h2>Interrupting 
4a70: 61 6e 20 53 51 4c 69 74 65 20 6f 70 65 72 61 74  an SQLite operat
4a80: 69 6f 6e 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65  ion</h2>..<p>The
4a90: 20 3c 62 3e 73 71 6c 69 74 65 5f 69 6e 74 65 72   <b>sqlite_inter
4aa0: 72 75 70 74 28 29 3c 2f 62 3e 20 66 75 6e 63 74  rupt()</b> funct
4ab0: 69 6f 6e 20 63 61 6e 20 62 65 20 63 61 6c 6c 65  ion can be calle
4ac0: 64 20 66 72 6f 6d 20 61 0a 64 69 66 66 65 72 65  d from a.differe
4ad0: 6e 74 20 74 68 72 65 61 64 20 6f 72 20 66 72 6f  nt thread or fro
4ae0: 6d 20 61 20 73 69 67 6e 61 6c 20 68 61 6e 64 6c  m a signal handl
4af0: 65 72 20 74 6f 20 63 61 75 73 65 20 74 68 65 20  er to cause the 
4b00: 63 75 72 72 65 6e 74 20 64 61 74 61 62 61 73 65  current database
4b10: 0a 6f 70 65 72 61 74 69 6f 6e 20 74 6f 20 65 78  .operation to ex
4b20: 69 74 20 61 74 20 69 74 73 20 66 69 72 73 74 20  it at its first 
4b30: 6f 70 70 6f 72 74 75 6e 69 74 79 2e 20 20 57 68  opportunity.  Wh
4b40: 65 6e 20 74 68 69 73 20 68 61 70 70 65 6e 73 2c  en this happens,
4b50: 0a 74 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 65  .the <b>sqlite_e
4b60: 78 65 63 28 29 3c 2f 62 3e 20 72 6f 75 74 69 6e  xec()</b> routin
4b70: 65 20 28 6f 72 20 74 68 65 20 65 71 75 69 76 61  e (or the equiva
4b80: 6c 65 6e 74 29 20 74 68 61 74 20 73 74 61 72 74  lent) that start
4b90: 65 64 0a 74 68 65 20 64 61 74 61 62 61 73 65 20  ed.the database 
4ba0: 6f 70 65 72 61 74 69 6f 6e 20 77 69 6c 6c 20 72  operation will r
4bb0: 65 74 75 72 6e 20 53 51 4c 49 54 45 5f 49 4e 54  eturn SQLITE_INT
4bc0: 45 52 52 55 50 54 2e 3c 2f 70 3e 0a 0a 3c 68 32  ERRUPT.</p>..<h2
4bd0: 3e 54 65 73 74 69 6e 67 20 66 6f 72 20 61 20 63  >Testing for a c
4be0: 6f 6d 70 6c 65 74 65 20 53 51 4c 20 73 74 61 74  omplete SQL stat
4bf0: 65 6d 65 6e 74 3c 2f 68 32 3e 0a 0a 3c 70 3e 54  ement</h2>..<p>T
4c00: 68 65 20 6e 65 78 74 20 69 6e 74 65 72 66 61 63  he next interfac
4c10: 65 20 72 6f 75 74 69 6e 65 20 74 6f 20 53 51 4c  e routine to SQL
4c20: 69 74 65 20 69 73 20 61 20 63 6f 6e 76 65 6e 69  ite is a conveni
4c30: 65 6e 63 65 20 66 75 6e 63 74 69 6f 6e 20 75 73  ence function us
4c40: 65 64 0a 74 6f 20 74 65 73 74 20 77 68 65 74 68  ed.to test wheth
4c50: 65 72 20 6f 72 20 6e 6f 74 20 61 20 73 74 72 69  er or not a stri
4c60: 6e 67 20 66 6f 72 6d 73 20 61 20 63 6f 6d 70 6c  ng forms a compl
4c70: 65 74 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  ete SQL statemen
4c80: 74 2e 0a 49 66 20 74 68 65 20 3c 62 3e 73 71 6c  t..If the <b>sql
4c90: 69 74 65 5f 63 6f 6d 70 6c 65 74 65 28 29 3c 2f  ite_complete()</
4ca0: 62 3e 20 66 75 6e 63 74 69 6f 6e 20 72 65 74 75  b> function retu
4cb0: 72 6e 73 20 74 72 75 65 20 77 68 65 6e 20 69 74  rns true when it
4cc0: 73 20 69 6e 70 75 74 0a 69 73 20 61 20 73 74 72  s input.is a str
4cd0: 69 6e 67 2c 20 74 68 65 6e 20 74 68 65 20 61 72  ing, then the ar
4ce0: 67 75 6d 65 6e 74 20 66 6f 72 6d 73 20 61 20 63  gument forms a c
4cf0: 6f 6d 70 6c 65 74 65 20 53 51 4c 20 73 74 61 74  omplete SQL stat
4d00: 65 6d 65 6e 74 2e 0a 54 68 65 72 65 20 61 72 65  ement..There are
4d10: 20 6e 6f 20 67 75 61 72 61 6e 74 65 65 73 20 74   no guarantees t
4d20: 68 61 74 20 74 68 65 20 73 79 6e 74 61 78 20 6f  hat the syntax o
4d30: 66 20 74 68 61 74 20 73 74 61 74 65 6d 65 6e 74  f that statement
4d40: 20 69 73 20 63 6f 72 72 65 63 74 2c 0a 62 75 74   is correct,.but
4d50: 20 77 65 20 61 74 20 6c 65 61 73 74 20 6b 6e 6f   we at least kno
4d60: 77 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20  w the statement 
4d70: 69 73 20 63 6f 6d 70 6c 65 74 65 2e 20 20 49 66  is complete.  If
4d80: 20 3c 62 3e 73 71 6c 69 74 65 5f 63 6f 6d 70 6c   <b>sqlite_compl
4d90: 65 74 65 28 29 3c 2f 62 3e 0a 72 65 74 75 72 6e  ete()</b>.return
4da0: 73 20 66 61 6c 73 65 2c 20 74 68 65 6e 20 6d 6f  s false, then mo
4db0: 72 65 20 74 65 78 74 20 69 73 20 72 65 71 75 69  re text is requi
4dc0: 72 65 64 20 74 6f 20 63 6f 6d 70 6c 65 74 65 20  red to complete 
4dd0: 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  the SQL statemen
4de0: 74 2e 3c 2f 70 3e 0a 0a 3c 70 3e 46 6f 72 20 74  t.</p>..<p>For t
4df0: 68 65 20 70 75 72 70 6f 73 65 20 6f 66 20 74 68  he purpose of th
4e00: 65 20 3c 62 3e 73 71 6c 69 74 65 5f 63 6f 6d 70  e <b>sqlite_comp
4e10: 6c 65 74 65 28 29 3c 2f 62 3e 20 66 75 6e 63 74  lete()</b> funct
4e20: 69 6f 6e 2c 20 61 6e 20 53 51 4c 0a 73 74 61 74  ion, an SQL.stat
4e30: 65 6d 65 6e 74 20 69 73 20 63 6f 6d 70 6c 65 74  ement is complet
4e40: 65 20 69 66 20 69 74 20 65 6e 64 73 20 69 6e 20  e if it ends in 
4e50: 61 20 73 65 6d 69 63 6f 6c 6f 6e 2e 3c 2f 70 3e  a semicolon.</p>
4e60: 0a 0a 3c 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69  ..<p>The <b>sqli
4e70: 74 65 3c 2f 62 3e 20 63 6f 6d 6d 61 6e 64 2d 6c  te</b> command-l
4e80: 69 6e 65 20 75 74 69 6c 69 74 79 20 75 73 65 73  ine utility uses
4e90: 20 74 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 63   the <b>sqlite_c
4ea0: 6f 6d 70 6c 65 74 65 28 29 3c 2f 62 3e 0a 66 75  omplete()</b>.fu
4eb0: 6e 63 74 69 6f 6e 20 74 6f 20 6b 6e 6f 77 20 77  nction to know w
4ec0: 68 65 6e 20 69 74 20 6e 65 65 64 73 20 74 6f 20  hen it needs to 
4ed0: 63 61 6c 6c 20 3c 62 3e 73 71 6c 69 74 65 5f 65  call <b>sqlite_e
4ee0: 78 65 63 28 29 3c 2f 62 3e 2e 20 20 41 66 74 65  xec()</b>.  Afte
4ef0: 72 20 65 61 63 68 0a 6c 69 6e 65 20 6f 66 20 69  r each.line of i
4f00: 6e 70 75 74 20 69 73 20 72 65 63 65 69 76 65 64  nput is received
4f10: 2c 20 3c 62 3e 73 71 6c 69 74 65 3c 2f 62 3e 20  , <b>sqlite</b> 
4f20: 63 61 6c 6c 73 20 3c 62 3e 73 71 6c 69 74 65 5f  calls <b>sqlite_
4f30: 63 6f 6d 70 6c 65 74 65 28 29 3c 2f 62 3e 0a 6f  complete()</b>.o
4f40: 6e 20 61 6c 6c 20 69 6e 70 75 74 20 69 6e 20 69  n all input in i
4f50: 74 73 20 62 75 66 66 65 72 2e 20 20 49 66 20 3c  ts buffer.  If <
4f60: 62 3e 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74  b>sqlite_complet
4f70: 65 28 29 3c 2f 62 3e 20 72 65 74 75 72 6e 73 20  e()</b> returns 
4f80: 74 72 75 65 2c 20 0a 74 68 65 6e 20 3c 62 3e 73  true, .then <b>s
4f90: 71 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e  qlite_exec()</b>
4fa0: 20 69 73 20 63 61 6c 6c 65 64 20 61 6e 64 20 74   is called and t
4fb0: 68 65 20 69 6e 70 75 74 20 62 75 66 66 65 72 20  he input buffer 
4fc0: 69 73 20 72 65 73 65 74 2e 20 20 49 66 0a 3c 62  is reset.  If.<b
4fd0: 3e 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74 65  >sqlite_complete
4fe0: 28 29 3c 2f 62 3e 20 72 65 74 75 72 6e 73 20 66  ()</b> returns f
4ff0: 61 6c 73 65 2c 20 74 68 65 6e 20 74 68 65 20 70  alse, then the p
5000: 72 6f 6d 70 74 20 69 73 20 63 68 61 6e 67 65 64  rompt is changed
5010: 20 74 6f 0a 74 68 65 20 63 6f 6e 74 69 6e 75 61   to.the continua
5020: 74 69 6f 6e 20 70 72 6f 6d 70 74 20 61 6e 64 20  tion prompt and 
5030: 61 6e 6f 74 68 65 72 20 6c 69 6e 65 20 6f 66 20  another line of 
5040: 74 65 78 74 20 69 73 20 72 65 61 64 20 61 6e 64  text is read and
5050: 20 61 64 64 65 64 20 74 6f 0a 74 68 65 20 69 6e   added to.the in
5060: 70 75 74 20 62 75 66 66 65 72 2e 3c 2f 70 3e 0a  put buffer.</p>.
5070: 0a 3c 68 32 3e 4c 69 62 72 61 72 79 20 76 65 72  .<h2>Library ver
5080: 73 69 6f 6e 20 73 74 72 69 6e 67 3c 2f 68 32 3e  sion string</h2>
5090: 0a 0a 3c 70 3e 54 68 65 20 53 51 4c 69 74 65 20  ..<p>The SQLite 
50a0: 6c 69 62 72 61 72 79 20 65 78 70 6f 72 74 73 20  library exports 
50b0: 74 68 65 20 73 74 72 69 6e 67 20 63 6f 6e 73 74  the string const
50c0: 61 6e 74 20 6e 61 6d 65 64 0a 3c 62 3e 73 71 6c  ant named.<b>sql
50d0: 69 74 65 5f 76 65 72 73 69 6f 6e 3c 2f 62 3e 20  ite_version</b> 
50e0: 77 68 69 63 68 20 63 6f 6e 74 61 69 6e 73 20 74  which contains t
50f0: 68 65 20 76 65 72 73 69 6f 6e 20 6e 75 6d 62 65  he version numbe
5100: 72 20 6f 66 20 74 68 65 0a 6c 69 62 72 61 72 79  r of the.library
5110: 2e 20 20 54 68 65 20 68 65 61 64 65 72 20 66 69  .  The header fi
5120: 6c 65 20 63 6f 6e 74 61 69 6e 73 20 61 20 6d 61  le contains a ma
5130: 63 72 6f 20 53 51 4c 49 54 45 5f 56 45 52 53 49  cro SQLITE_VERSI
5140: 4f 4e 0a 77 69 74 68 20 74 68 65 20 73 61 6d 65  ON.with the same
5150: 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 20 20 49   information.  I
5160: 66 20 64 65 73 69 72 65 64 2c 20 61 20 70 72 6f  f desired, a pro
5170: 67 72 61 6d 20 63 61 6e 20 63 6f 6d 70 61 72 65  gram can compare
5180: 0a 74 68 65 20 53 51 4c 49 54 45 5f 56 45 52 53  .the SQLITE_VERS
5190: 49 4f 4e 20 6d 61 63 72 6f 20 61 67 61 69 6e 73  ION macro agains
51a0: 74 20 74 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f  t the <b>sqlite_
51b0: 76 65 72 73 69 6f 6e 3c 2f 62 3e 0a 73 74 72 69  version</b>.stri
51c0: 6e 67 20 63 6f 6e 73 74 61 6e 74 20 74 6f 20 76  ng constant to v
51d0: 65 72 69 66 79 20 74 68 61 74 20 74 68 65 20 76  erify that the v
51e0: 65 72 73 69 6f 6e 20 6e 75 6d 62 65 72 20 6f 66  ersion number of
51f0: 20 74 68 65 0a 68 65 61 64 65 72 20 66 69 6c 65   the.header file
5200: 20 61 6e 64 20 74 68 65 20 6c 69 62 72 61 72 79   and the library
5210: 20 6d 61 74 63 68 2e 3c 2f 70 3e 20 0a 0a 3c 68   match.</p> ..<h
5220: 32 3e 4c 69 62 72 61 72 79 20 63 68 61 72 61 63  2>Library charac
5230: 74 65 72 20 65 6e 63 6f 64 69 6e 67 3c 2f 68 32  ter encoding</h2
5240: 3e 0a 0a 3c 70 3e 42 79 20 64 65 66 61 75 6c 74  >..<p>By default
5250: 2c 20 53 51 4c 69 74 65 20 61 73 73 75 6d 65 73  , SQLite assumes
5260: 20 74 68 61 74 20 61 6c 6c 20 64 61 74 61 20 75   that all data u
5270: 73 65 73 20 61 20 66 69 78 65 64 2d 73 69 7a 65  ses a fixed-size
5280: 0a 38 2d 62 69 74 20 63 68 61 72 61 63 74 65 72  .8-bit character
5290: 20 28 69 73 6f 38 38 35 39 29 2e 20 20 42 75 74   (iso8859).  But
52a0: 20 69 66 20 79 6f 75 20 67 69 76 65 20 74 68 65   if you give the
52b0: 20 2d 2d 65 6e 61 62 6c 65 2d 75 74 66 38 20 6f   --enable-utf8 o
52c0: 70 74 69 6f 6e 0a 74 6f 20 74 68 65 20 63 6f 6e  ption.to the con
52d0: 66 69 67 75 72 65 20 73 63 72 69 70 74 2c 20 74  figure script, t
52e0: 68 65 6e 20 74 68 65 20 6c 69 62 72 61 72 79 20  hen the library 
52f0: 61 73 73 75 6d 65 73 20 55 54 46 2d 38 20 76 61  assumes UTF-8 va
5300: 72 69 61 62 6c 65 0a 73 69 7a 65 64 20 63 68 61  riable.sized cha
5310: 72 61 63 74 65 72 73 2e 20 20 54 68 69 73 20 6d  racters.  This m
5320: 61 6b 65 73 20 61 20 64 69 66 66 65 72 65 6e 63  akes a differenc
5330: 65 20 66 6f 72 20 74 68 65 20 4c 49 4b 45 20 61  e for the LIKE a
5340: 6e 64 20 47 4c 4f 42 0a 6f 70 65 72 61 74 6f 72  nd GLOB.operator
5350: 73 20 61 6e 64 20 74 68 65 20 4c 45 4e 47 54 48  s and the LENGTH
5360: 28 29 20 61 6e 64 20 53 55 42 53 54 52 28 29 20  () and SUBSTR() 
5370: 66 75 6e 63 74 69 6f 6e 73 2e 20 20 54 68 65 20  functions.  The 
5380: 73 74 61 74 69 63 0a 73 74 72 69 6e 67 20 3c 62  static.string <b
5390: 3e 73 71 6c 69 74 65 5f 65 6e 63 6f 64 69 6e 67  >sqlite_encoding
53a0: 3c 2f 62 3e 20 77 69 6c 6c 20 62 65 20 73 65 74  </b> will be set
53b0: 20 74 6f 20 65 69 74 68 65 72 20 22 55 54 46 2d   to either "UTF-
53c0: 38 22 20 6f 72 0a 22 69 73 6f 38 38 35 39 22 20  8" or."iso8859" 
53d0: 74 6f 20 69 6e 64 69 63 61 74 65 20 68 6f 77 20  to indicate how 
53e0: 74 68 65 20 6c 69 62 72 61 72 79 20 77 61 73 20  the library was 
53f0: 63 6f 6d 70 69 6c 65 64 2e 20 20 49 6e 20 61 64  compiled.  In ad
5400: 64 69 74 69 6f 6e 2c 0a 74 68 65 20 3c 62 3e 73  dition,.the <b>s
5410: 71 6c 69 74 65 2e 68 3c 2f 62 3e 20 68 65 61 64  qlite.h</b> head
5420: 65 72 20 66 69 6c 65 20 77 69 6c 6c 20 64 65 66  er file will def
5430: 69 6e 65 20 6f 6e 65 20 6f 66 20 74 68 65 0a 6d  ine one of the.m
5440: 61 63 72 6f 73 20 3c 62 3e 53 51 4c 49 54 45 5f  acros <b>SQLITE_
5450: 55 54 46 38 3c 2f 62 3e 20 6f 72 20 3c 62 3e 53  UTF8</b> or <b>S
5460: 51 4c 49 54 45 5f 49 53 4f 38 38 35 39 3c 2f 62  QLITE_ISO8859</b
5470: 3e 2c 20 61 73 20 61 70 70 72 6f 70 72 69 61 74  >, as appropriat
5480: 65 2e 3c 2f 70 3e 0a 0a 3c 70 3e 4e 6f 74 65 20  e.</p>..<p>Note 
5490: 74 68 61 74 20 74 68 65 20 63 68 61 72 61 63 74  that the charact
54a0: 65 72 20 65 6e 63 6f 64 69 6e 67 20 6d 65 63 68  er encoding mech
54b0: 61 6e 69 73 6d 20 75 73 65 64 20 62 79 20 53 51  anism used by SQ
54c0: 4c 69 74 65 20 63 61 6e 6e 6f 74 0a 62 65 20 63  Lite cannot.be c
54d0: 68 61 6e 67 65 64 20 61 74 20 72 75 6e 2d 74 69  hanged at run-ti
54e0: 6d 65 2e 20 20 54 68 69 73 20 69 73 20 61 20 63  me.  This is a c
54f0: 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69  ompile-time opti
5500: 6f 6e 20 6f 6e 6c 79 2e 20 20 54 68 65 0a 3c 62  on only.  The.<b
5510: 3e 73 71 6c 69 74 65 5f 65 6e 63 6f 64 69 6e 67  >sqlite_encoding
5520: 3c 2f 62 3e 20 63 68 61 72 61 63 74 65 72 20 73  </b> character s
5530: 74 72 69 6e 67 20 6a 75 73 74 20 74 65 6c 6c 73  tring just tells
5540: 20 79 6f 75 20 68 6f 77 20 74 68 65 20 6c 69 62   you how the lib
5550: 72 61 72 79 0a 77 61 73 20 63 6f 6d 70 69 6c 65  rary.was compile
5560: 64 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 43 68 61 6e  d.</p>..<h2>Chan
5570: 67 69 6e 67 20 74 68 65 20 6c 69 62 72 61 72 79  ging the library
5580: 27 73 20 72 65 73 70 6f 6e 73 65 20 74 6f 20 6c  's response to l
5590: 6f 63 6b 65 64 20 66 69 6c 65 73 3c 2f 68 32 3e  ocked files</h2>
55a0: 0a 0a 3c 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69  ..<p>The <b>sqli
55b0: 74 65 5f 62 75 73 79 5f 68 61 6e 64 6c 65 72 28  te_busy_handler(
55c0: 29 3c 2f 62 3e 20 70 72 6f 63 65 64 75 72 65 20  )</b> procedure 
55d0: 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20 72  can be used to r
55e0: 65 67 69 73 74 65 72 0a 61 20 62 75 73 79 20 63  egister.a busy c
55f0: 61 6c 6c 62 61 63 6b 20 77 69 74 68 20 61 6e 20  allback with an 
5600: 6f 70 65 6e 20 53 51 4c 69 74 65 20 64 61 74 61  open SQLite data
5610: 62 61 73 65 2e 20 20 54 68 65 20 62 75 73 79 20  base.  The busy 
5620: 63 61 6c 6c 62 61 63 6b 20 77 69 6c 6c 0a 62 65  callback will.be
5630: 20 69 6e 76 6f 6b 65 64 20 77 68 65 6e 65 76 65   invoked wheneve
5640: 72 20 53 51 4c 69 74 65 20 74 72 69 65 73 20 74  r SQLite tries t
5650: 6f 20 61 63 63 65 73 73 20 61 20 64 61 74 61 62  o access a datab
5660: 61 73 65 20 74 68 61 74 20 69 73 20 6c 6f 63 6b  ase that is lock
5670: 65 64 2e 0a 54 68 65 20 63 61 6c 6c 62 61 63 6b  ed..The callback
5680: 20 77 69 6c 6c 20 74 79 70 69 63 61 6c 6c 79 20   will typically 
5690: 64 6f 20 73 6f 6d 65 20 6f 74 68 65 72 20 75 73  do some other us
56a0: 65 66 75 6c 20 77 6f 72 6b 2c 20 6f 72 20 70 65  eful work, or pe
56b0: 72 68 61 70 73 20 73 6c 65 65 70 2c 0a 69 6e 20  rhaps sleep,.in 
56c0: 6f 72 64 65 72 20 74 6f 20 67 69 76 65 20 74 68  order to give th
56d0: 65 20 6c 6f 63 6b 20 61 20 63 68 61 6e 63 65 20  e lock a chance 
56e0: 74 6f 20 63 6c 65 61 72 2e 20 20 49 66 20 74 68  to clear.  If th
56f0: 65 20 63 61 6c 6c 62 61 63 6b 20 72 65 74 75 72  e callback retur
5700: 6e 73 0a 6e 6f 6e 2d 7a 65 72 6f 2c 20 74 68 65  ns.non-zero, the
5710: 6e 20 53 51 4c 69 74 65 20 74 72 69 65 73 20 61  n SQLite tries a
5720: 67 61 69 6e 20 74 6f 20 61 63 63 65 73 73 20 74  gain to access t
5730: 68 65 20 64 61 74 61 62 61 73 65 20 61 6e 64 20  he database and 
5740: 74 68 65 20 63 79 63 6c 65 0a 72 65 70 65 61 74  the cycle.repeat
5750: 73 2e 20 20 49 66 20 74 68 65 20 63 61 6c 6c 62  s.  If the callb
5760: 61 63 6b 20 72 65 74 75 72 6e 73 20 7a 65 72 6f  ack returns zero
5770: 2c 20 74 68 65 6e 20 53 51 4c 69 74 65 20 61 62  , then SQLite ab
5780: 6f 72 74 73 20 74 68 65 20 63 75 72 72 65 6e 74  orts the current
5790: 0a 6f 70 65 72 61 74 69 6f 6e 20 61 6e 64 20 72  .operation and r
57a0: 65 74 75 72 6e 73 20 53 51 4c 49 54 45 5f 42 55  eturns SQLITE_BU
57b0: 53 59 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20  SY.</p>..<p>The 
57c0: 61 72 67 75 6d 65 6e 74 73 20 74 6f 20 3c 62 3e  arguments to <b>
57d0: 73 71 6c 69 74 65 5f 62 75 73 79 5f 68 61 6e 64  sqlite_busy_hand
57e0: 6c 65 72 28 29 3c 2f 62 3e 20 61 72 65 20 74 68  ler()</b> are th
57f0: 65 20 6f 70 61 71 75 65 0a 73 74 72 75 63 74 75  e opaque.structu
5800: 72 65 20 72 65 74 75 72 6e 65 64 20 66 72 6f 6d  re returned from
5810: 20 3c 62 3e 73 71 6c 69 74 65 5f 6f 70 65 6e 28   <b>sqlite_open(
5820: 29 3c 2f 62 3e 2c 20 61 20 70 6f 69 6e 74 65 72  )</b>, a pointer
5830: 20 74 6f 20 74 68 65 20 62 75 73 79 0a 63 61 6c   to the busy.cal
5840: 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 2c 20  lback function, 
5850: 61 6e 64 20 61 20 67 65 6e 65 72 69 63 20 70 6f  and a generic po
5860: 69 6e 74 65 72 20 74 68 61 74 20 77 69 6c 6c 20  inter that will 
5870: 62 65 20 70 61 73 73 65 64 20 61 73 0a 74 68 65  be passed as.the
5880: 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20   first argument 
5890: 74 6f 20 74 68 65 20 62 75 73 79 20 63 61 6c 6c  to the busy call
58a0: 62 61 63 6b 2e 20 20 57 68 65 6e 20 53 51 4c 69  back.  When SQLi
58b0: 74 65 20 69 6e 76 6f 6b 65 73 20 74 68 65 0a 62  te invokes the.b
58c0: 75 73 79 20 63 61 6c 6c 62 61 63 6b 2c 20 69 74  usy callback, it
58d0: 20 73 65 6e 64 73 20 69 74 20 74 68 72 65 65 20   sends it three 
58e0: 61 72 67 75 6d 65 6e 74 73 3a 20 20 74 68 65 20  arguments:  the 
58f0: 67 65 6e 65 72 69 63 20 70 6f 69 6e 74 65 72 0a  generic pointer.
5900: 74 68 61 74 20 77 61 73 20 70 61 73 73 65 64 20  that was passed 
5910: 69 6e 20 61 73 20 74 68 65 20 74 68 69 72 64 20  in as the third 
5920: 61 72 67 75 6d 65 6e 74 20 74 6f 20 3c 62 3e 73  argument to <b>s
5930: 71 6c 69 74 65 5f 62 75 73 79 5f 68 61 6e 64 6c  qlite_busy_handl
5940: 65 72 3c 2f 62 3e 2c 0a 74 68 65 20 6e 61 6d 65  er</b>,.the name
5950: 20 6f 66 20 74 68 65 20 64 61 74 61 62 61 73 65   of the database
5960: 20 74 61 62 6c 65 20 6f 72 20 69 6e 64 65 78 20   table or index 
5970: 74 68 61 74 20 74 68 65 20 6c 69 62 72 61 72 79  that the library
5980: 20 69 73 20 74 72 79 69 6e 67 0a 74 6f 20 61 63   is trying.to ac
5990: 63 65 73 73 2c 20 61 6e 64 20 74 68 65 20 6e 75  cess, and the nu
59a0: 6d 62 65 72 20 6f 66 20 74 69 6d 65 73 20 74 68  mber of times th
59b0: 61 74 20 74 68 65 20 6c 69 62 72 61 72 79 20 68  at the library h
59c0: 61 73 20 61 74 74 65 6d 70 74 65 64 20 74 6f 0a  as attempted to.
59d0: 61 63 63 65 73 73 20 74 68 65 20 64 61 74 61 62  access the datab
59e0: 61 73 65 20 74 61 62 6c 65 20 6f 72 20 69 6e 64  ase table or ind
59f0: 65 78 2e 3c 2f 70 3e 0a 0a 3c 70 3e 46 6f 72 20  ex.</p>..<p>For 
5a00: 74 68 65 20 63 6f 6d 6d 6f 6e 20 63 61 73 65 20  the common case 
5a10: 77 68 65 72 65 20 77 65 20 77 61 6e 74 20 74 68  where we want th
5a20: 65 20 62 75 73 79 20 63 61 6c 6c 62 61 63 6b 20  e busy callback 
5a30: 74 6f 20 73 6c 65 65 70 2c 0a 74 68 65 20 53 51  to sleep,.the SQ
5a40: 4c 69 74 65 20 6c 69 62 72 61 72 79 20 70 72 6f  Lite library pro
5a50: 76 69 64 65 73 20 61 20 63 6f 6e 76 65 6e 69 65  vides a convenie
5a60: 6e 63 65 20 72 6f 75 74 69 6e 65 20 3c 62 3e 73  nce routine <b>s
5a70: 71 6c 69 74 65 5f 62 75 73 79 5f 74 69 6d 65 6f  qlite_busy_timeo
5a80: 75 74 28 29 3c 2f 62 3e 2e 0a 54 68 65 20 66 69  ut()</b>..The fi
5a90: 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f 20  rst argument to 
5aa0: 3c 62 3e 73 71 6c 69 74 65 5f 62 75 73 79 5f 74  <b>sqlite_busy_t
5ab0: 69 6d 65 6f 75 74 28 29 3c 2f 62 3e 20 69 73 20  imeout()</b> is 
5ac0: 61 20 70 6f 69 6e 74 65 72 20 74 6f 0a 61 6e 20  a pointer to.an 
5ad0: 6f 70 65 6e 20 53 51 4c 69 74 65 20 64 61 74 61  open SQLite data
5ae0: 62 61 73 65 20 61 6e 64 20 74 68 65 20 73 65 63  base and the sec
5af0: 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20 69 73 20  ond argument is 
5b00: 61 20 6e 75 6d 62 65 72 20 6f 66 20 6d 69 6c 6c  a number of mill
5b10: 69 73 65 63 6f 6e 64 73 2e 0a 41 66 74 65 72 20  iseconds..After 
5b20: 3c 62 3e 73 71 6c 69 74 65 5f 62 75 73 79 5f 74  <b>sqlite_busy_t
5b30: 69 6d 65 6f 75 74 28 29 3c 2f 62 3e 20 68 61 73  imeout()</b> has
5b40: 20 62 65 65 6e 20 65 78 65 63 75 74 65 64 2c 20   been executed, 
5b50: 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62 72 61  the SQLite libra
5b60: 72 79 0a 77 69 6c 6c 20 77 61 69 74 20 66 6f 72  ry.will wait for
5b70: 20 74 68 65 20 6c 6f 63 6b 20 74 6f 20 63 6c 65   the lock to cle
5b80: 61 72 20 66 6f 72 20 61 74 20 6c 65 61 73 74 20  ar for at least 
5b90: 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 6d 69  the number of mi
5ba0: 6c 6c 69 73 65 63 6f 6e 64 73 20 0a 73 70 65 63  lliseconds .spec
5bb0: 69 66 69 65 64 20 62 65 66 6f 72 65 20 69 74 20  ified before it 
5bc0: 72 65 74 75 72 6e 73 20 53 51 4c 49 54 45 5f 42  returns SQLITE_B
5bd0: 55 53 59 2e 20 20 53 70 65 63 69 66 79 69 6e 67  USY.  Specifying
5be0: 20 7a 65 72 6f 20 6d 69 6c 6c 69 73 65 63 6f 6e   zero millisecon
5bf0: 64 73 20 66 6f 72 0a 74 68 65 20 74 69 6d 65 6f  ds for.the timeo
5c00: 75 74 20 72 65 73 74 6f 72 65 73 20 74 68 65 20  ut restores the 
5c10: 64 65 66 61 75 6c 74 20 62 65 68 61 76 69 6f 72  default behavior
5c20: 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 55 73 69 6e 67  .</p>..<h2>Using
5c30: 20 74 68 65 20 3c 74 74 3e 5f 70 72 69 6e 74 66   the <tt>_printf
5c40: 28 29 3c 2f 74 74 3e 20 77 72 61 70 70 65 72 20  ()</tt> wrapper 
5c50: 66 75 6e 63 74 69 6f 6e 73 3c 2f 68 32 3e 0a 0a  functions</h2>..
5c60: 3c 70 3e 54 68 65 20 66 6f 75 72 20 75 74 69 6c  <p>The four util
5c70: 69 74 79 20 66 75 6e 63 74 69 6f 6e 73 3c 2f 70  ity functions</p
5c80: 3e 0a 0a 3c 70 3e 0a 3c 75 6c 3e 0a 3c 6c 69 3e  >..<p>.<ul>.<li>
5c90: 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 5f 70  <b>sqlite_exec_p
5ca0: 72 69 6e 74 66 28 29 3c 2f 62 3e 3c 2f 6c 69 3e  rintf()</b></li>
5cb0: 0a 3c 6c 69 3e 3c 62 3e 73 71 6c 69 74 65 5f 65  .<li><b>sqlite_e
5cc0: 78 65 63 5f 76 70 72 69 6e 74 66 28 29 3c 2f 62  xec_vprintf()</b
5cd0: 3e 3c 2f 6c 69 3e 0a 3c 6c 69 3e 3c 62 3e 73 71  ></li>.<li><b>sq
5ce0: 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 5f 70  lite_get_table_p
5cf0: 72 69 6e 74 66 28 29 3c 2f 62 3e 3c 2f 6c 69 3e  rintf()</b></li>
5d00: 0a 3c 6c 69 3e 3c 62 3e 73 71 6c 69 74 65 5f 67  .<li><b>sqlite_g
5d10: 65 74 5f 74 61 62 6c 65 5f 76 70 72 69 6e 74 66  et_table_vprintf
5d20: 28 29 3c 2f 62 3e 3c 2f 6c 69 3e 0a 3c 2f 75 6c  ()</b></li>.</ul
5d30: 3e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 69 6d 70 6c 65  >.</p>..<p>imple
5d40: 6d 65 6e 74 20 74 68 65 20 73 61 6d 65 20 71 75  ment the same qu
5d50: 65 72 79 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74  ery functionalit
5d60: 79 20 61 73 20 3c 62 3e 73 71 6c 69 74 65 5f 65  y as <b>sqlite_e
5d70: 78 65 63 28 29 3c 2f 62 3e 0a 61 6e 64 20 3c 62  xec()</b>.and <b
5d80: 3e 73 71 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c  >sqlite_get_tabl
5d90: 65 28 29 3c 2f 62 3e 2e 20 20 42 75 74 20 69 6e  e()</b>.  But in
5da0: 73 74 65 61 64 20 6f 66 20 74 61 6b 69 6e 67 20  stead of taking 
5db0: 61 20 63 6f 6d 70 6c 65 74 65 0a 53 51 4c 20 73  a complete.SQL s
5dc0: 74 61 74 65 6d 65 6e 74 20 61 73 20 74 68 65 69  tatement as thei
5dd0: 72 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e  r second argumen
5de0: 74 2c 20 74 68 65 20 66 6f 75 72 20 3c 62 3e 5f  t, the four <b>_
5df0: 70 72 69 6e 74 66 3c 2f 62 3e 0a 72 6f 75 74 69  printf</b>.routi
5e00: 6e 65 73 20 74 61 6b 65 20 61 20 70 72 69 6e 74  nes take a print
5e10: 66 2d 73 74 79 6c 65 20 66 6f 72 6d 61 74 20 73  f-style format s
5e20: 74 72 69 6e 67 2e 20 20 54 68 65 20 53 51 4c 20  tring.  The SQL 
5e30: 73 74 61 74 65 6d 65 6e 74 20 74 6f 0a 62 65 20  statement to.be 
5e40: 65 78 65 63 75 74 65 64 20 69 73 20 67 65 6e 65  executed is gene
5e50: 72 61 74 65 64 20 66 72 6f 6d 20 74 68 69 73 20  rated from this 
5e60: 66 6f 72 6d 61 74 20 73 74 72 69 6e 67 20 61 6e  format string an
5e70: 64 20 66 72 6f 6d 20 77 68 61 74 65 76 65 72 0a  d from whatever.
5e80: 61 64 64 69 74 69 6f 6e 61 6c 20 61 72 67 75 6d  additional argum
5e90: 65 6e 74 73 20 61 72 65 20 61 74 74 61 63 68 65  ents are attache
5ea0: 64 20 74 6f 20 74 68 65 20 65 6e 64 20 6f 66 20  d to the end of 
5eb0: 74 68 65 20 66 75 6e 63 74 69 6f 6e 20 63 61 6c  the function cal
5ec0: 6c 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 72 65  l.</p>..<p>There
5ed0: 20 61 72 65 20 74 77 6f 20 61 64 76 61 6e 74 61   are two advanta
5ee0: 67 65 73 20 74 6f 20 75 73 69 6e 67 20 74 68 65  ges to using the
5ef0: 20 53 51 4c 69 74 65 20 70 72 69 6e 74 66 0a 66   SQLite printf.f
5f00: 75 6e 63 74 69 6f 6e 73 20 69 6e 73 74 65 61 64  unctions instead
5f10: 20 6f 66 20 3c 62 3e 73 70 72 69 6e 74 66 28 29   of <b>sprintf()
5f20: 3c 2f 62 3e 2e 20 20 46 69 72 73 74 20 6f 66 20  </b>.  First of 
5f30: 61 6c 6c 2c 20 77 69 74 68 20 74 68 65 0a 53 51  all, with the.SQ
5f40: 4c 69 74 65 20 70 72 69 6e 74 66 20 72 6f 75 74  Lite printf rout
5f50: 69 6e 65 73 2c 20 74 68 65 72 65 20 69 73 20 6e  ines, there is n
5f60: 65 76 65 72 20 61 20 64 61 6e 67 65 72 20 6f 66  ever a danger of
5f70: 20 6f 76 65 72 66 6c 6f 77 69 6e 67 20 61 0a 73   overflowing a.s
5f80: 74 61 74 69 63 20 62 75 66 66 65 72 20 61 73 20  tatic buffer as 
5f90: 74 68 65 72 65 20 69 73 20 77 69 74 68 20 3c 62  there is with <b
5fa0: 3e 73 70 72 69 6e 74 66 28 29 3c 2f 62 3e 2e 20  >sprintf()</b>. 
5fb0: 20 54 68 65 20 53 51 4c 69 74 65 0a 70 72 69 6e   The SQLite.prin
5fc0: 74 66 20 72 6f 75 74 69 6e 65 73 20 61 75 74 6f  tf routines auto
5fd0: 6d 61 74 69 63 61 6c 6c 79 20 61 6c 6c 6f 63 61  matically alloca
5fe0: 74 65 20 28 61 6e 64 20 6c 61 74 65 72 20 66 72  te (and later fr
5ff0: 65 65 29 0a 61 73 20 6d 75 63 68 20 6d 65 6d 6f  ee).as much memo
6000: 72 79 20 61 73 20 69 73 20 0a 6e 65 63 65 73 73  ry as is .necess
6010: 61 72 79 20 74 6f 20 68 6f 6c 64 20 74 68 65 20  ary to hold the 
6020: 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 20 67  SQL statements g
6030: 65 6e 65 72 61 74 65 64 2e 3c 2f 70 3e 0a 0a 3c  enerated.</p>..<
6040: 70 3e 54 68 65 20 73 65 63 6f 6e 64 20 61 64 76  p>The second adv
6050: 61 6e 74 61 67 65 20 74 68 65 20 53 51 4c 69 74  antage the SQLit
6060: 65 20 70 72 69 6e 74 66 20 72 6f 75 74 69 6e 65  e printf routine
6070: 73 20 68 61 76 65 20 6f 76 65 72 0a 3c 62 3e 73  s have over.<b>s
6080: 70 72 69 6e 74 66 28 29 3c 2f 62 3e 20 61 72 65  printf()</b> are
6090: 20 74 77 6f 20 6e 65 77 20 66 6f 72 6d 61 74 74   two new formatt
60a0: 69 6e 67 20 6f 70 74 69 6f 6e 73 20 73 70 65 63  ing options spec
60b0: 69 66 69 63 61 6c 6c 79 20 64 65 73 69 67 6e 65  ifically designe
60c0: 64 0a 74 6f 20 73 75 70 70 6f 72 74 20 73 74 72  d.to support str
60d0: 69 6e 67 20 6c 69 74 65 72 61 6c 73 20 69 6e 20  ing literals in 
60e0: 53 51 4c 2e 20 20 57 69 74 68 69 6e 20 74 68 65  SQL.  Within the
60f0: 20 66 6f 72 6d 61 74 20 73 74 72 69 6e 67 2c 0a   format string,.
6100: 74 68 65 20 25 71 20 66 6f 72 6d 61 74 74 69 6e  the %q formattin
6110: 67 20 6f 70 74 69 6f 6e 20 77 6f 72 6b 73 20 76  g option works v
6120: 65 72 79 20 6d 75 63 68 20 6c 69 6b 65 20 25 73  ery much like %s
6130: 20 69 6e 20 74 68 61 74 20 69 74 0a 72 65 61 64   in that it.read
6140: 73 20 61 20 6e 75 6c 6c 2d 74 65 72 6d 69 6e 61  s a null-termina
6150: 74 65 64 20 73 74 72 69 6e 67 20 66 72 6f 6d 20  ted string from 
6160: 74 68 65 20 61 72 67 75 6d 65 6e 74 20 6c 69 73  the argument lis
6170: 74 20 61 6e 64 20 69 6e 73 65 72 74 73 0a 69 74  t and inserts.it
6180: 20 69 6e 74 6f 20 74 68 65 20 72 65 73 75 6c 74   into the result
6190: 2e 20 20 42 75 74 20 25 71 20 74 72 61 6e 73 6c  .  But %q transl
61a0: 61 74 65 73 20 74 68 65 20 69 6e 73 65 72 74 65  ates the inserte
61b0: 64 20 73 74 72 69 6e 67 20 62 79 0a 6d 61 6b 69  d string by.maki
61c0: 6e 67 20 74 77 6f 20 63 6f 70 69 65 73 20 6f 66  ng two copies of
61d0: 20 65 76 65 72 79 20 73 69 6e 67 6c 65 2d 71 75   every single-qu
61e0: 6f 74 65 20 28 27 29 20 63 68 61 72 61 63 74 65  ote (') characte
61f0: 72 20 69 6e 20 74 68 65 0a 73 75 62 73 74 69 74  r in the.substit
6200: 75 74 65 64 20 73 74 72 69 6e 67 2e 20 20 54 68  uted string.  Th
6210: 69 73 20 68 61 73 20 74 68 65 20 65 66 66 65 63  is has the effec
6220: 74 20 6f 66 20 65 73 63 61 70 69 6e 67 20 74 68  t of escaping th
6230: 65 20 65 6e 64 2d 6f 66 2d 73 74 72 69 6e 67 0a  e end-of-string.
6240: 6d 65 61 6e 69 6e 67 20 6f 66 20 73 69 6e 67 6c  meaning of singl
6250: 65 2d 71 75 6f 74 65 20 77 69 74 68 69 6e 20 61  e-quote within a
6260: 20 73 74 72 69 6e 67 20 6c 69 74 65 72 61 6c 2e   string literal.
6270: 20 54 68 65 20 25 51 20 66 6f 72 6d 61 74 74 69   The %Q formatti
6280: 6e 67 0a 6f 70 74 69 6f 6e 20 77 6f 72 6b 73 20  ng.option works 
6290: 73 69 6d 69 6c 61 72 3b 20 69 74 20 74 72 61 6e  similar; it tran
62a0: 73 6c 61 74 65 73 20 74 68 65 20 73 69 6e 67 6c  slates the singl
62b0: 65 2d 71 75 6f 74 65 73 20 6c 69 6b 65 20 25 71  e-quotes like %q
62c0: 20 61 6e 64 0a 61 64 64 69 74 69 6f 6e 61 6c 6c   and.additionall
62d0: 79 20 65 6e 63 6c 6f 73 65 73 20 74 68 65 20 72  y encloses the r
62e0: 65 73 75 6c 74 69 6e 67 20 73 74 72 69 6e 67 20  esulting string 
62f0: 69 6e 20 73 69 6e 67 6c 65 2d 71 75 6f 74 65 73  in single-quotes
6300: 2e 0a 49 66 20 74 68 65 20 61 72 67 75 6d 65 6e  ..If the argumen
6310: 74 20 66 6f 72 20 74 68 65 20 25 51 20 66 6f 72  t for the %Q for
6320: 6d 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e 73 20  matting options 
6330: 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  is a NULL pointe
6340: 72 2c 0a 74 68 65 20 72 65 73 75 6c 74 69 6e 67  r,.the resulting
6350: 20 73 74 72 69 6e 67 20 69 73 20 4e 55 4c 4c 20   string is NULL 
6360: 77 69 74 68 6f 75 74 20 73 69 6e 67 6c 65 20 71  without single q
6370: 75 6f 74 65 73 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e  uotes..</p>..<p>
6380: 43 6f 6e 73 69 64 65 72 20 61 6e 20 65 78 61 6d  Consider an exam
6390: 70 6c 65 2e 20 20 53 75 70 70 6f 73 65 20 79 6f  ple.  Suppose yo
63a0: 75 20 61 72 65 20 74 72 79 69 6e 67 20 74 6f 20  u are trying to 
63b0: 69 6e 73 65 72 74 20 61 20 73 74 72 69 6e 67 0a  insert a string.
63c0: 76 61 6c 75 65 20 69 6e 74 6f 20 61 20 64 61 74  value into a dat
63d0: 61 62 61 73 65 20 74 61 62 6c 65 20 77 68 65 72  abase table wher
63e0: 65 20 74 68 65 20 73 74 72 69 6e 67 20 76 61 6c  e the string val
63f0: 75 65 20 77 61 73 20 6f 62 74 61 69 6e 65 64 20  ue was obtained 
6400: 66 72 6f 6d 0a 75 73 65 72 20 69 6e 70 75 74 2e  from.user input.
6410: 20 20 53 75 70 70 6f 73 65 20 74 68 65 20 73 74    Suppose the st
6420: 72 69 6e 67 20 74 6f 20 62 65 20 69 6e 73 65 72  ring to be inser
6430: 74 65 64 20 69 73 20 73 74 6f 72 65 64 20 69 6e  ted is stored in
6440: 20 61 20 76 61 72 69 61 62 6c 65 0a 6e 61 6d 65   a variable.name
6450: 64 20 7a 53 74 72 69 6e 67 2e 20 20 54 68 65 20  d zString.  The 
6460: 63 6f 64 65 20 74 6f 20 64 6f 20 74 68 65 20 69  code to do the i
6470: 6e 73 65 72 74 69 6f 6e 20 6d 69 67 68 74 20 6c  nsertion might l
6480: 6f 6f 6b 20 6c 69 6b 65 20 74 68 69 73 3a 3c 2f  ook like this:</
6490: 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e  p>..<blockquote>
64a0: 3c 70 72 65 3e 0a 73 71 6c 69 74 65 5f 65 78 65  <pre>.sqlite_exe
64b0: 63 5f 70 72 69 6e 74 66 28 64 62 2c 0a 20 20 22  c_printf(db,.  "
64c0: 49 4e 53 45 52 54 20 49 4e 54 4f 20 74 61 62 6c  INSERT INTO tabl
64d0: 65 31 20 56 41 4c 55 45 53 28 27 25 73 27 29 22  e1 VALUES('%s')"
64e0: 2c 0a 20 20 30 2c 20 30 2c 20 30 2c 20 7a 53 74  ,.  0, 0, 0, zSt
64f0: 72 69 6e 67 29 3b 0a 3c 2f 70 72 65 3e 3c 2f 62  ring);.</pre></b
6500: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 49  lockquote>..<p>I
6510: 66 20 74 68 65 20 7a 53 74 72 69 6e 67 20 76 61  f the zString va
6520: 72 69 61 62 6c 65 20 68 6f 6c 64 73 20 74 65 78  riable holds tex
6530: 74 20 6c 69 6b 65 20 22 48 65 6c 6c 6f 22 2c 20  t like "Hello", 
6540: 74 68 65 6e 20 74 68 69 73 20 73 74 61 74 65 6d  then this statem
6550: 65 6e 74 0a 77 69 6c 6c 20 77 6f 72 6b 20 6a 75  ent.will work ju
6560: 73 74 20 66 69 6e 65 2e 20 20 42 75 74 20 73 75  st fine.  But su
6570: 70 70 6f 73 65 20 74 68 65 20 75 73 65 72 20 65  ppose the user e
6580: 6e 74 65 72 73 20 61 20 73 74 72 69 6e 67 20 6c  nters a string l
6590: 69 6b 65 20 0a 22 48 69 20 79 27 61 6c 6c 21 22  ike ."Hi y'all!"
65a0: 2e 20 20 54 68 65 20 53 51 4c 20 73 74 61 74 65  .  The SQL state
65b0: 6d 65 6e 74 20 67 65 6e 65 72 61 74 65 64 20 72  ment generated r
65c0: 65 61 64 73 20 61 73 20 66 6f 6c 6c 6f 77 73 3a  eads as follows:
65d0: 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70  ..<blockquote><p
65e0: 72 65 3e 0a 49 4e 53 45 52 54 20 49 4e 54 4f 20  re>.INSERT INTO 
65f0: 74 61 62 6c 65 31 20 56 41 4c 55 45 53 28 27 48  table1 VALUES('H
6600: 69 20 79 27 61 6c 6c 27 29 0a 3c 2f 70 72 65 3e  i y'all').</pre>
6610: 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c  </blockquote>..<
6620: 70 3e 54 68 69 73 20 69 73 20 6e 6f 74 20 76 61  p>This is not va
6630: 6c 69 64 20 53 51 4c 20 62 65 63 61 75 73 65 20  lid SQL because 
6640: 6f 66 20 74 68 65 20 61 70 6f 73 74 72 6f 70 68  of the apostroph
6650: 79 20 69 6e 20 74 68 65 20 77 6f 72 64 20 22 79  y in the word "y
6660: 27 61 6c 6c 22 2e 0a 42 75 74 20 69 66 20 74 68  'all"..But if th
6670: 65 20 25 71 20 66 6f 72 6d 61 74 74 69 6e 67 20  e %q formatting 
6680: 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 20 69  option is used i
6690: 6e 73 74 65 61 64 20 6f 66 20 25 73 2c 20 6c 69  nstead of %s, li
66a0: 6b 65 20 74 68 69 73 3a 3c 2f 70 3e 0a 0a 3c 62  ke this:</p>..<b
66b0: 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a  lockquote><pre>.
66c0: 73 71 6c 69 74 65 5f 65 78 65 63 5f 70 72 69 6e  sqlite_exec_prin
66d0: 74 66 28 64 62 2c 0a 20 20 22 49 4e 53 45 52 54  tf(db,.  "INSERT
66e0: 20 49 4e 54 4f 20 74 61 62 6c 65 31 20 56 41 4c   INTO table1 VAL
66f0: 55 45 53 28 27 25 71 27 29 22 2c 0a 20 20 30 2c  UES('%q')",.  0,
6700: 20 30 2c 20 30 2c 20 7a 53 74 72 69 6e 67 29 3b   0, 0, zString);
6710: 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75  .</pre></blockqu
6720: 6f 74 65 3e 0a 0a 3c 70 3e 54 68 65 6e 20 74 68  ote>..<p>Then th
6730: 65 20 67 65 6e 65 72 61 74 65 64 20 53 51 4c 20  e generated SQL 
6740: 77 69 6c 6c 20 6c 6f 6f 6b 20 6c 69 6b 65 20 74  will look like t
6750: 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 3a 3c 2f 70  he following:</p
6760: 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c  >..<blockquote><
6770: 70 72 65 3e 0a 49 4e 53 45 52 54 20 49 4e 54 4f  pre>.INSERT INTO
6780: 20 74 61 62 6c 65 31 20 56 41 4c 55 45 53 28 27   table1 VALUES('
6790: 48 69 20 79 27 27 61 6c 6c 27 29 0a 3c 2f 70 72  Hi y''all').</pr
67a0: 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  e></blockquote>.
67b0: 0a 3c 70 3e 48 65 72 65 20 74 68 65 20 61 70 6f  .<p>Here the apo
67c0: 73 74 72 6f 70 68 79 20 68 61 73 20 62 65 65 6e  strophy has been
67d0: 20 65 73 63 61 70 65 64 20 61 6e 64 20 74 68 65   escaped and the
67e0: 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 69   SQL statement i
67f0: 73 20 77 65 6c 6c 2d 66 6f 72 6d 65 64 2e 0a 57  s well-formed..W
6800: 68 65 6e 20 67 65 6e 65 72 61 74 69 6e 67 20 53  hen generating S
6810: 51 4c 20 6f 6e 2d 74 68 65 2d 66 6c 79 20 66 72  QL on-the-fly fr
6820: 6f 6d 20 64 61 74 61 20 74 68 61 74 20 6d 69 67  om data that mig
6830: 68 74 20 63 6f 6e 74 61 69 6e 20 61 0a 73 69 6e  ht contain a.sin
6840: 67 6c 65 2d 71 75 6f 74 65 20 63 68 61 72 61 63  gle-quote charac
6850: 74 65 72 20 28 27 29 2c 20 69 74 20 69 73 20 61  ter ('), it is a
6860: 6c 77 61 79 73 20 61 20 67 6f 6f 64 20 69 64 65  lways a good ide
6870: 61 20 74 6f 20 75 73 65 20 74 68 65 0a 53 51 4c  a to use the.SQL
6880: 69 74 65 20 70 72 69 6e 74 66 20 72 6f 75 74 69  ite printf routi
6890: 6e 65 73 20 61 6e 64 20 74 68 65 20 25 71 20 66  nes and the %q f
68a0: 6f 72 6d 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e  ormatting option
68b0: 20 69 6e 73 74 65 61 64 20 6f 66 20 3c 62 3e 73   instead of <b>s
68c0: 70 72 69 6e 74 66 3c 2f 62 3e 2e 0a 3c 2f 70 3e  printf</b>..</p>
68d0: 0a 0a 3c 70 3e 49 66 20 74 68 65 20 25 51 20 66  ..<p>If the %Q f
68e0: 6f 72 6d 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e  ormatting option
68f0: 20 69 73 20 75 73 65 64 20 69 6e 73 74 65 61 64   is used instead
6900: 20 6f 66 20 25 71 2c 20 6c 69 6b 65 20 74 68 69   of %q, like thi
6910: 73 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75  s:</p>..<blockqu
6920: 6f 74 65 3e 3c 70 72 65 3e 0a 73 71 6c 69 74 65  ote><pre>.sqlite
6930: 5f 65 78 65 63 5f 70 72 69 6e 74 66 28 64 62 2c  _exec_printf(db,
6940: 0a 20 20 22 49 4e 53 45 52 54 20 49 4e 54 4f 20  .  "INSERT INTO 
6950: 74 61 62 6c 65 31 20 56 41 4c 55 45 53 28 25 51  table1 VALUES(%Q
6960: 29 22 2c 0a 20 20 30 2c 20 30 2c 20 30 2c 20 7a  )",.  0, 0, 0, z
6970: 53 74 72 69 6e 67 29 3b 0a 3c 2f 70 72 65 3e 3c  String);.</pre><
6980: 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70  /blockquote>..<p
6990: 3e 54 68 65 6e 20 74 68 65 20 67 65 6e 65 72 61  >Then the genera
69a0: 74 65 64 20 53 51 4c 20 77 69 6c 6c 20 6c 6f 6f  ted SQL will loo
69b0: 6b 20 6c 69 6b 65 20 74 68 65 20 66 6f 6c 6c 6f  k like the follo
69c0: 77 69 6e 67 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63  wing:</p>..<bloc
69d0: 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 49 4e 53  kquote><pre>.INS
69e0: 45 52 54 20 49 4e 54 4f 20 74 61 62 6c 65 31 20  ERT INTO table1 
69f0: 56 41 4c 55 45 53 28 27 48 69 20 79 27 27 61 6c  VALUES('Hi y''al
6a00: 6c 27 29 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63  l').</pre></bloc
6a10: 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 49 66 20 74  kquote>..<p>If t
6a20: 68 65 20 76 61 6c 75 65 20 6f 66 20 74 68 65 20  he value of the 
6a30: 7a 53 74 72 69 6e 67 20 76 61 72 69 61 62 6c 65  zString variable
6a40: 20 69 73 20 4e 55 4c 4c 2c 20 74 68 65 20 67 65   is NULL, the ge
6a50: 6e 65 72 61 74 65 64 20 53 51 4c 0a 77 69 6c 6c  nerated SQL.will
6a60: 20 6c 6f 6f 6b 20 6c 69 6b 65 20 74 68 65 20 66   look like the f
6a70: 6f 6c 6c 6f 77 69 6e 67 3a 3c 2f 70 3e 0a 0a 3c  ollowing:</p>..<
6a80: 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e  blockquote><pre>
6a90: 0a 49 4e 53 45 52 54 20 49 4e 54 4f 20 74 61 62  .INSERT INTO tab
6aa0: 6c 65 31 20 56 41 4c 55 45 53 28 4e 55 4c 4c 29  le1 VALUES(NULL)
6ab0: 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75  .</pre></blockqu
6ac0: 6f 74 65 3e 0a 0a 3c 70 3e 41 6c 6c 20 6f 66 20  ote>..<p>All of 
6ad0: 74 68 65 20 5f 70 72 69 6e 74 66 28 29 20 72 6f  the _printf() ro
6ae0: 75 74 69 6e 65 73 20 61 62 6f 76 65 20 61 72 65  utines above are
6af0: 20 62 75 69 6c 74 20 61 72 6f 75 6e 64 20 74 68   built around th
6b00: 65 20 66 6f 6c 6c 6f 77 69 6e 67 0a 74 77 6f 20  e following.two 
6b10: 66 75 6e 63 74 69 6f 6e 73 3a 3c 2f 70 3e 0a 0a  functions:</p>..
6b20: 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65  <blockquote><pre
6b30: 3e 0a 63 68 61 72 20 2a 73 71 6c 69 74 65 5f 6d  >.char *sqlite_m
6b40: 70 72 69 6e 74 66 28 63 6f 6e 73 74 20 63 68 61  printf(const cha
6b50: 72 20 2a 7a 46 6f 72 6d 61 74 2c 20 2e 2e 2e 29  r *zFormat, ...)
6b60: 3b 0a 63 68 61 72 20 2a 73 71 6c 69 74 65 5f 76  ;.char *sqlite_v
6b70: 6d 70 72 69 6e 74 66 28 63 6f 6e 73 74 20 63 68  mprintf(const ch
6b80: 61 72 20 2a 7a 46 6f 72 6d 61 74 2c 20 76 61 5f  ar *zFormat, va_
6b90: 6c 69 73 74 29 3b 0a 3c 2f 70 72 65 3e 3c 2f 62  list);.</pre></b
6ba0: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 54  lockquote>..<p>T
6bb0: 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 6d 70 72  he <b>sqlite_mpr
6bc0: 69 6e 74 66 28 29 3c 2f 62 3e 20 72 6f 75 74 69  intf()</b> routi
6bd0: 6e 65 20 77 6f 72 6b 73 20 6c 69 6b 65 20 74 68  ne works like th
6be0: 65 20 74 68 65 20 73 74 61 6e 64 61 72 64 20 6c  e the standard l
6bf0: 69 62 72 61 72 79 0a 3c 62 3e 73 70 72 69 6e 74  ibrary.<b>sprint
6c00: 66 28 29 3c 2f 62 3e 20 65 78 63 65 70 74 20 74  f()</b> except t
6c10: 68 61 74 20 69 74 20 77 72 69 74 65 73 20 69 74  hat it writes it
6c20: 73 20 72 65 73 75 6c 74 73 20 69 6e 74 6f 20 6d  s results into m
6c30: 65 6d 6f 72 79 20 6f 62 74 61 69 6e 65 64 0a 66  emory obtained.f
6c40: 72 6f 6d 20 6d 61 6c 6c 6f 63 28 29 20 61 6e 64  rom malloc() and
6c50: 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69 6e 74   returns a point
6c60: 65 72 20 74 6f 20 74 68 65 20 6d 61 6c 6c 6f 63  er to the malloc
6c70: 65 64 20 62 75 66 66 65 72 2e 20 20 0a 3c 62 3e  ed buffer.  .<b>
6c80: 73 71 6c 69 74 65 5f 6d 70 72 69 6e 74 66 28 29  sqlite_mprintf()
6c90: 3c 2f 62 3e 20 61 6c 73 6f 20 75 6e 64 65 72 73  </b> also unders
6ca0: 74 61 6e 64 73 20 74 68 65 20 25 71 20 61 6e 64  tands the %q and
6cb0: 20 25 51 20 65 78 74 65 6e 73 69 6f 6e 73 20 64   %Q extensions d
6cc0: 65 73 63 72 69 62 65 64 0a 61 62 6f 76 65 2e 20  escribed.above. 
6cd0: 20 54 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 76   The <b>sqlite_v
6ce0: 6d 70 72 69 6e 74 66 28 29 3c 2f 62 3e 20 69 73  mprintf()</b> is
6cf0: 20 61 20 76 61 72 61 72 67 73 20 76 65 72 73 69   a varargs versi
6d00: 6f 6e 20 6f 66 20 74 68 65 20 73 61 6d 65 0a 72  on of the same.r
6d10: 6f 75 74 69 6e 65 2e 20 20 54 68 65 20 73 74 72  outine.  The str
6d20: 69 6e 67 20 70 6f 69 6e 74 65 72 20 74 68 61 74  ing pointer that
6d30: 20 74 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20   these routines 
6d40: 72 65 74 75 72 6e 20 73 68 6f 75 6c 64 20 62 65  return should be
6d50: 20 66 72 65 65 64 0a 62 79 20 70 61 73 73 69 6e   freed.by passin
6d60: 67 20 69 74 20 74 6f 20 3c 62 3e 73 71 6c 69 74  g it to <b>sqlit
6d70: 65 5f 66 72 65 65 6d 65 6d 28 29 3c 2f 62 3e 2e  e_freemem()</b>.
6d80: 0a 3c 2f 70 3e 0a 0a 3c 68 32 3e 41 64 64 69 6e  .</p>..<h2>Addin
6d90: 67 20 4e 65 77 20 53 51 4c 20 46 75 6e 63 74 69  g New SQL Functi
6da0: 6f 6e 73 3c 2f 68 32 3e 0a 0a 3c 70 3e 42 65 67  ons</h2>..<p>Beg
6db0: 69 6e 6e 69 6e 67 20 77 69 74 68 20 76 65 72 73  inning with vers
6dc0: 69 6f 6e 20 32 2e 34 2e 30 2c 20 53 51 4c 69 74  ion 2.4.0, SQLit
6dd0: 65 20 61 6c 6c 6f 77 73 20 74 68 65 20 53 51 4c  e allows the SQL
6de0: 20 6c 61 6e 67 75 61 67 65 20 74 6f 20 62 65 0a   language to be.
6df0: 65 78 74 65 6e 64 65 64 20 77 69 74 68 20 6e 65  extended with ne
6e00: 77 20 66 75 6e 63 74 69 6f 6e 73 20 69 6d 70 6c  w functions impl
6e10: 65 6d 65 6e 74 65 64 20 61 73 20 43 20 63 6f 64  emented as C cod
6e20: 65 2e 20 20 54 68 65 20 66 6f 6c 6c 6f 77 69 6e  e.  The followin
6e30: 67 20 69 6e 74 65 72 66 61 63 65 0a 69 73 20 75  g interface.is u
6e40: 73 65 64 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63  sed:.</p>..<bloc
6e50: 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 74 79 70  kquote><pre>.typ
6e60: 65 64 65 66 20 73 74 72 75 63 74 20 73 71 6c 69  edef struct sqli
6e70: 74 65 5f 66 75 6e 63 20 73 71 6c 69 74 65 5f 66  te_func sqlite_f
6e80: 75 6e 63 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65  unc;..int sqlite
6e90: 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e  _create_function
6ea0: 28 0a 20 20 73 71 6c 69 74 65 20 2a 64 62 2c 0a  (.  sqlite *db,.
6eb0: 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 4e    const char *zN
6ec0: 61 6d 65 2c 0a 20 20 69 6e 74 20 6e 41 72 67 2c  ame,.  int nArg,
6ed0: 0a 20 20 76 6f 69 64 20 28 2a 78 46 75 6e 63 29  .  void (*xFunc)
6ee0: 28 73 71 6c 69 74 65 5f 66 75 6e 63 2a 2c 69 6e  (sqlite_func*,in
6ef0: 74 2c 63 6f 6e 73 74 20 63 68 61 72 2a 2a 29 2c  t,const char**),
6f00: 0a 20 20 76 6f 69 64 20 2a 70 55 73 65 72 44 61  .  void *pUserDa
6f10: 74 61 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  ta.);.int sqlite
6f20: 5f 63 72 65 61 74 65 5f 61 67 67 72 65 67 61 74  _create_aggregat
6f30: 65 28 0a 20 20 73 71 6c 69 74 65 20 2a 64 62 2c  e(.  sqlite *db,
6f40: 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a  .  const char *z
6f50: 4e 61 6d 65 2c 0a 20 20 69 6e 74 20 6e 41 72 67  Name,.  int nArg
6f60: 2c 0a 20 20 76 6f 69 64 20 28 2a 78 53 74 65 70  ,.  void (*xStep
6f70: 29 28 73 71 6c 69 74 65 5f 66 75 6e 63 2a 2c 69  )(sqlite_func*,i
6f80: 6e 74 2c 63 6f 6e 73 74 20 63 68 61 72 2a 2a 29  nt,const char**)
6f90: 2c 0a 20 20 76 6f 69 64 20 28 2a 78 46 69 6e 61  ,.  void (*xFina
6fa0: 6c 69 7a 65 29 28 73 71 6c 69 74 65 5f 66 75 6e  lize)(sqlite_fun
6fb0: 63 2a 29 2c 0a 20 20 76 6f 69 64 20 2a 70 55 73  c*),.  void *pUs
6fc0: 65 72 44 61 74 61 0a 29 3b 0a 0a 63 68 61 72 20  erData.);..char 
6fd0: 2a 73 71 6c 69 74 65 5f 73 65 74 5f 72 65 73 75  *sqlite_set_resu
6fe0: 6c 74 5f 73 74 72 69 6e 67 28 73 71 6c 69 74 65  lt_string(sqlite
6ff0: 5f 66 75 6e 63 2a 2c 63 6f 6e 73 74 20 63 68 61  _func*,const cha
7000: 72 2a 2c 69 6e 74 29 3b 0a 76 6f 69 64 20 73 71  r*,int);.void sq
7010: 6c 69 74 65 5f 73 65 74 5f 72 65 73 75 6c 74 5f  lite_set_result_
7020: 69 6e 74 28 73 71 6c 69 74 65 5f 66 75 6e 63 2a  int(sqlite_func*
7030: 2c 69 6e 74 29 3b 0a 76 6f 69 64 20 73 71 6c 69  ,int);.void sqli
7040: 74 65 5f 73 65 74 5f 72 65 73 75 6c 74 5f 64 6f  te_set_result_do
7050: 75 62 6c 65 28 73 71 6c 69 74 65 5f 66 75 6e 63  uble(sqlite_func
7060: 2a 2c 64 6f 75 62 6c 65 29 3b 0a 76 6f 69 64 20  *,double);.void 
7070: 73 71 6c 69 74 65 5f 73 65 74 5f 72 65 73 75 6c  sqlite_set_resul
7080: 74 5f 65 72 72 6f 72 28 73 71 6c 69 74 65 5f 66  t_error(sqlite_f
7090: 75 6e 63 2a 2c 63 6f 6e 73 74 20 63 68 61 72 2a  unc*,const char*
70a0: 2c 69 6e 74 29 3b 0a 0a 76 6f 69 64 20 2a 73 71  ,int);..void *sq
70b0: 6c 69 74 65 5f 75 73 65 72 5f 64 61 74 61 28 73  lite_user_data(s
70c0: 71 6c 69 74 65 5f 66 75 6e 63 2a 29 3b 0a 76 6f  qlite_func*);.vo
70d0: 69 64 20 2a 73 71 6c 69 74 65 5f 61 67 67 72 65  id *sqlite_aggre
70e0: 67 61 74 65 5f 63 6f 6e 74 65 78 74 28 73 71 6c  gate_context(sql
70f0: 69 74 65 5f 66 75 6e 63 2a 2c 20 69 6e 74 20 6e  ite_func*, int n
7100: 42 79 74 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69  Bytes);.int sqli
7110: 74 65 5f 61 67 67 72 65 67 61 74 65 5f 63 6f 75  te_aggregate_cou
7120: 6e 74 28 73 71 6c 69 74 65 5f 66 75 6e 63 2a 29  nt(sqlite_func*)
7130: 3b 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71  ;.</pre></blockq
7140: 75 6f 74 65 3e 0a 0a 3c 70 3e 0a 54 68 65 20 3c  uote>..<p>.The <
7150: 62 3e 73 71 6c 69 74 65 5f 63 72 65 61 74 65 5f  b>sqlite_create_
7160: 66 75 6e 63 74 69 6f 6e 28 29 3c 2f 62 3e 20 69  function()</b> i
7170: 6e 74 65 72 66 61 63 65 20 69 73 20 75 73 65 64  nterface is used
7180: 20 74 6f 20 63 72 65 61 74 65 20 0a 72 65 67 75   to create .regu
7190: 6c 61 72 20 66 75 6e 63 74 69 6f 6e 73 20 61 6e  lar functions an
71a0: 64 20 3c 62 3e 73 71 6c 69 74 65 5f 63 72 65 61  d <b>sqlite_crea
71b0: 74 65 5f 61 67 67 72 65 67 61 74 65 28 29 3c 2f  te_aggregate()</
71c0: 62 3e 20 69 73 20 75 73 65 64 20 74 6f 0a 63 72  b> is used to.cr
71d0: 65 61 74 65 20 6e 65 77 20 61 67 67 72 65 67 61  eate new aggrega
71e0: 74 65 20 66 75 6e 63 74 69 6f 6e 73 2e 20 20 49  te functions.  I
71f0: 6e 20 62 6f 74 68 20 63 61 73 65 73 2c 20 74 68  n both cases, th
7200: 65 20 3c 62 3e 64 62 3c 2f 62 3e 0a 70 61 72 61  e <b>db</b>.para
7210: 6d 65 74 65 72 20 69 73 20 61 6e 20 6f 70 65 6e  meter is an open
7220: 20 53 51 4c 69 74 65 20 64 61 74 61 62 61 73 65   SQLite database
7230: 20 6f 6e 20 77 68 69 63 68 20 74 68 65 20 66 75   on which the fu
7240: 6e 63 74 69 6f 6e 73 20 73 68 6f 75 6c 64 0a 62  nctions should.b
7250: 65 20 72 65 67 69 73 74 65 72 65 64 2c 20 3c 62  e registered, <b
7260: 3e 7a 4e 61 6d 65 3c 2f 62 3e 20 69 73 20 74 68  >zName</b> is th
7270: 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 6e 65  e name of the ne
7280: 77 20 66 75 6e 63 74 69 6f 6e 2c 0a 3c 62 3e 6e  w function,.<b>n
7290: 41 72 67 3c 2f 62 3e 20 69 73 20 74 68 65 20 6e  Arg</b> is the n
72a0: 75 6d 62 65 72 20 6f 66 20 61 72 67 75 6d 65 6e  umber of argumen
72b0: 74 73 2c 20 61 6e 64 20 3c 62 3e 70 55 73 65 72  ts, and <b>pUser
72c0: 44 61 74 61 3c 2f 62 3e 20 69 73 0a 61 20 70 6f  Data</b> is.a po
72d0: 69 6e 74 65 72 20 77 68 69 63 68 20 69 73 20 70  inter which is p
72e0: 61 73 73 65 64 20 74 68 72 6f 75 67 68 20 75 6e  assed through un
72f0: 63 68 61 6e 67 65 64 20 74 6f 20 74 68 65 20 43  changed to the C
7300: 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 0a   implementation.
7310: 6f 66 20 74 68 65 20 66 75 6e 63 74 69 6f 6e 2e  of the function.
7320: 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 46 6f 72 20 72  .</p>..<p>.For r
7330: 65 67 75 6c 61 72 20 66 75 6e 63 74 69 6f 6e 73  egular functions
7340: 2c 20 74 68 65 20 3c 62 3e 78 46 75 6e 63 3c 2f  , the <b>xFunc</
7350: 62 3e 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 69  b> callback is i
7360: 6e 76 6f 6b 65 64 20 6f 6e 63 65 0a 66 6f 72 20  nvoked once.for 
7370: 65 61 63 68 20 66 75 6e 63 74 69 6f 6e 20 63 61  each function ca
7380: 6c 6c 2e 20 20 54 68 65 20 69 6d 70 6c 65 6d 65  ll.  The impleme
7390: 6e 74 61 74 69 6f 6e 20 6f 66 20 78 46 75 6e 63  ntation of xFunc
73a0: 20 73 68 6f 75 6c 64 20 63 61 6c 6c 0a 6f 6e 65   should call.one
73b0: 20 6f 66 20 74 68 65 20 3c 62 3e 73 71 6c 69 74   of the <b>sqlit
73c0: 65 5f 73 65 74 5f 72 65 73 75 6c 74 5f 2e 2e 2e  e_set_result_...
73d0: 3c 2f 62 3e 20 69 6e 74 65 72 66 61 63 65 73 20  </b> interfaces 
73e0: 74 6f 20 72 65 74 75 72 6e 20 69 74 73 0a 72 65  to return its.re
73f0: 73 75 6c 74 2e 20 20 54 68 65 20 3c 62 3e 73 71  sult.  The <b>sq
7400: 6c 69 74 65 5f 75 73 65 72 5f 64 61 74 61 28 29  lite_user_data()
7410: 3c 2f 62 3e 20 72 6f 75 74 69 6e 65 20 63 61 6e  </b> routine can
7420: 20 62 65 20 75 73 65 64 20 74 6f 0a 72 65 74 72   be used to.retr
7430: 69 65 76 65 20 74 68 65 20 3c 62 3e 70 55 73 65  ieve the <b>pUse
7440: 72 44 61 74 61 3c 2f 62 3e 20 70 6f 69 6e 74 65  rData</b> pointe
7450: 72 20 74 68 61 74 20 77 61 73 20 70 61 73 73 65  r that was passe
7460: 64 20 69 6e 20 77 68 65 6e 20 74 68 65 0a 66 75  d in when the.fu
7470: 6e 63 74 69 6f 6e 20 77 61 73 20 72 65 67 69 73  nction was regis
7480: 74 65 72 65 64 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e  tered..</p>..<p>
7490: 0a 46 6f 72 20 61 67 67 72 65 67 61 74 65 20 66  .For aggregate f
74a0: 75 6e 63 74 69 6f 6e 73 2c 20 74 68 65 20 3c 62  unctions, the <b
74b0: 3e 78 53 74 65 70 3c 2f 62 3e 20 63 61 6c 6c 62  >xStep</b> callb
74c0: 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20 6f  ack is invoked o
74d0: 6e 63 65 0a 66 6f 72 20 65 61 63 68 20 72 6f 77  nce.for each row
74e0: 20 69 6e 20 74 68 65 20 72 65 73 75 6c 74 20 61   in the result a
74f0: 6e 64 20 74 68 65 6e 20 3c 62 3e 78 46 69 6e 61  nd then <b>xFina
7500: 6c 69 7a 65 3c 2f 62 3e 20 69 73 20 69 6e 76 6f  lize</b> is invo
7510: 6b 65 64 20 61 74 20 74 68 65 0a 65 6e 64 20 74  ked at the.end t
7520: 6f 20 63 6f 6d 70 75 74 65 20 61 20 66 69 6e 61  o compute a fina
7530: 6c 20 61 6e 73 77 65 72 2e 20 20 54 68 65 20 78  l answer.  The x
7540: 53 74 65 70 20 72 6f 75 74 69 6e 65 20 63 61 6e  Step routine can
7550: 20 75 73 65 20 74 68 65 0a 3c 62 3e 73 71 6c 69   use the.<b>sqli
7560: 74 65 5f 61 67 67 72 65 67 61 74 65 5f 63 6f 6e  te_aggregate_con
7570: 74 65 78 74 28 29 3c 2f 62 3e 20 69 6e 74 65 72  text()</b> inter
7580: 66 61 63 65 20 74 6f 20 61 6c 6c 6f 63 61 74 65  face to allocate
7590: 20 6d 65 6d 6f 72 79 20 74 68 61 74 0a 77 69 6c   memory that.wil
75a0: 6c 20 62 65 20 75 6e 69 71 75 65 20 74 6f 20 74  l be unique to t
75b0: 68 61 74 20 70 61 72 74 69 63 75 6c 61 72 20 69  hat particular i
75c0: 6e 73 74 61 6e 63 65 20 6f 66 20 74 68 65 20 53  nstance of the S
75d0: 51 4c 20 66 75 6e 63 74 69 6f 6e 2e 0a 54 68 69  QL function..Thi
75e0: 73 20 6d 65 6d 6f 72 79 20 77 69 6c 6c 20 62 65  s memory will be
75f0: 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 64   automatically d
7600: 65 6c 65 74 65 64 20 61 66 74 65 72 20 78 46 69  eleted after xFi
7610: 6e 61 6c 69 7a 65 20 69 73 20 63 61 6c 6c 65 64  nalize is called
7620: 2e 0a 54 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f  ..The <b>sqlite_
7630: 61 67 67 72 65 67 61 74 65 5f 63 6f 75 6e 74 28  aggregate_count(
7640: 29 3c 2f 62 3e 20 72 6f 75 74 69 6e 65 20 63 61  )</b> routine ca
7650: 6e 20 62 65 20 75 73 65 64 20 74 6f 20 66 69 6e  n be used to fin
7660: 64 20 6f 75 74 0a 68 6f 77 20 6d 61 6e 79 20 72  d out.how many r
7670: 6f 77 73 20 6f 66 20 64 61 74 61 20 77 65 72 65  ows of data were
7680: 20 70 61 73 73 65 64 20 74 6f 20 74 68 65 20 61   passed to the a
7690: 67 67 72 65 67 61 74 65 2e 20 20 54 68 65 20 78  ggregate.  The x
76a0: 46 69 6e 61 6c 69 7a 65 0a 63 61 6c 6c 62 61 63  Finalize.callbac
76b0: 6b 20 73 68 6f 75 6c 64 20 69 6e 76 6f 6b 65 20  k should invoke 
76c0: 6f 6e 65 20 6f 66 20 74 68 65 20 3c 62 3e 73 71  one of the <b>sq
76d0: 6c 69 74 65 5f 73 65 74 5f 72 65 73 75 6c 74 5f  lite_set_result_
76e0: 2e 2e 2e 3c 2f 62 3e 0a 69 6e 74 65 72 66 61 63  ...</b>.interfac
76f0: 65 73 20 74 6f 20 73 65 74 20 74 68 65 20 66 69  es to set the fi
7700: 6e 61 6c 20 72 65 73 75 6c 74 20 6f 66 20 74 68  nal result of th
7710: 65 20 61 67 67 72 65 67 61 74 65 2e 0a 3c 2f 70  e aggregate..</p
7720: 3e 0a 0a 3c 70 3e 0a 53 51 4c 69 74 65 20 6e 6f  >..<p>.SQLite no
7730: 77 20 69 6d 70 6c 65 6d 65 6e 74 73 20 61 6c 6c  w implements all
7740: 20 6f 66 20 69 74 73 20 62 75 69 6c 74 2d 69 6e   of its built-in
7750: 20 66 75 6e 63 74 69 6f 6e 73 20 75 73 69 6e 67   functions using
7760: 20 74 68 69 73 0a 69 6e 74 65 72 66 61 63 65 2e   this.interface.
7770: 20 20 46 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c    For additional
7780: 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 61 6e 64   information and
7790: 20 65 78 61 6d 70 6c 65 73 20 6f 6e 20 68 6f 77   examples on how
77a0: 20 74 6f 20 63 72 65 61 74 65 0a 6e 65 77 20 53   to create.new S
77b0: 51 4c 20 66 75 6e 63 74 69 6f 6e 73 2c 20 72 65  QL functions, re
77c0: 76 69 65 77 20 74 68 65 20 53 51 4c 69 74 65 20  view the SQLite 
77d0: 73 6f 75 72 63 65 20 63 6f 64 65 20 69 6e 20 74  source code in t
77e0: 68 65 20 66 69 6c 65 0a 3c 62 3e 66 75 6e 63 2e  he file.<b>func.
77f0: 63 3c 2f 62 3e 2e 0a 3c 2f 70 3e 0a 0a 3c 68 32  c</b>..</p>..<h2
7800: 3e 4d 75 6c 74 69 2d 54 68 72 65 61 64 69 6e 67  >Multi-Threading
7810: 20 41 6e 64 20 53 51 4c 69 74 65 3c 2f 68 32 3e   And SQLite</h2>
7820: 0a 0a 3c 70 3e 0a 49 66 20 53 51 4c 69 74 65 20  ..<p>.If SQLite 
7830: 69 73 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68  is compiled with
7840: 20 74 68 65 20 54 48 52 45 41 44 53 41 46 45 20   the THREADSAFE 
7850: 70 72 65 70 72 6f 63 65 73 73 6f 72 20 6d 61 63  preprocessor mac
7860: 72 6f 20 73 65 74 20 74 6f 20 31 2c 0a 74 68 65  ro set to 1,.the
7870: 6e 20 69 74 20 69 73 20 73 61 66 65 20 74 6f 20  n it is safe to 
7880: 75 73 65 20 53 51 4c 69 74 65 20 66 72 6f 6d 20  use SQLite from 
7890: 74 77 6f 20 6f 72 20 6d 6f 72 65 20 74 68 72 65  two or more thre
78a0: 61 64 73 20 6f 66 20 74 68 65 20 73 61 6d 65 20  ads of the same 
78b0: 70 72 6f 63 65 73 73 0a 61 74 20 74 68 65 20 73  process.at the s
78c0: 61 6d 65 20 74 69 6d 65 2e 20 20 42 75 74 20 65  ame time.  But e
78d0: 61 63 68 20 74 68 72 65 61 64 20 73 68 6f 75 6c  ach thread shoul
78e0: 64 20 68 61 76 65 20 69 74 73 20 6f 77 6e 20 3c  d have its own <
78f0: 62 3e 73 71 6c 69 74 65 2a 3c 2f 62 3e 0a 70 6f  b>sqlite*</b>.po
7900: 69 6e 74 65 72 20 72 65 74 75 72 6e 65 64 20 66  inter returned f
7910: 72 6f 6d 20 3c 62 3e 73 71 6c 69 74 65 5f 6f 70  rom <b>sqlite_op
7920: 65 6e 28 29 3c 2f 62 3e 2e 20 20 49 74 20 69 73  en()</b>.  It is
7930: 20 6e 65 76 65 72 20 73 61 66 65 20 66 6f 72 20   never safe for 
7940: 74 77 6f 0a 6f 72 20 6d 6f 72 65 20 74 68 72 65  two.or more thre
7950: 61 64 73 20 74 6f 20 61 63 63 65 73 73 20 74 68  ads to access th
7960: 65 20 73 61 6d 65 20 3c 62 3e 73 71 6c 69 74 65  e same <b>sqlite
7970: 2a 3c 2f 62 3e 20 70 6f 69 6e 74 65 72 20 61 74  *</b> pointer at
7980: 20 74 68 65 20 73 61 6d 65 20 74 69 6d 65 2e 0a   the same time..
7990: 3c 2f 70 3e 0a 0a 3c 70 3e 0a 49 6e 20 70 72 65  </p>..<p>.In pre
79a0: 63 6f 6d 70 69 6c 65 64 20 53 51 4c 69 74 65 20  compiled SQLite 
79b0: 6c 69 62 72 61 72 69 65 73 20 61 76 61 69 6c 61  libraries availa
79c0: 62 6c 65 20 6f 6e 20 74 68 65 20 77 65 62 73 69  ble on the websi
79d0: 74 65 2c 20 74 68 65 20 55 6e 69 78 0a 76 65 72  te, the Unix.ver
79e0: 73 69 6f 6e 73 20 61 72 65 20 63 6f 6d 70 69 6c  sions are compil
79f0: 65 64 20 77 69 74 68 20 54 48 52 45 41 44 53 41  ed with THREADSA
7a00: 46 45 20 74 75 72 6e 65 64 20 6f 66 66 20 62 75  FE turned off bu
7a10: 74 20 74 68 65 20 77 69 6e 64 6f 77 73 0a 76 65  t the windows.ve
7a20: 72 73 69 6f 6e 73 20 61 72 65 20 63 6f 6d 70 69  rsions are compi
7a30: 6c 65 64 20 77 69 74 68 20 54 48 52 45 41 44 53  led with THREADS
7a40: 41 46 45 20 74 75 72 6e 65 64 20 6f 6e 2e 20 20  AFE turned on.  
7a50: 49 66 20 79 6f 75 20 6e 65 65 64 20 73 6f 6d 65  If you need some
7a60: 74 68 69 6e 67 0a 64 69 66 66 65 72 65 6e 74 20  thing.different 
7a70: 74 68 61 74 20 74 68 69 73 20 79 6f 75 20 77 69  that this you wi
7a80: 6c 6c 20 68 61 76 65 20 74 6f 20 72 65 63 6f 6d  ll have to recom
7a90: 70 69 6c 65 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a  pile..</p>..<p>.
7aa0: 55 6e 64 65 72 20 55 6e 69 78 2c 20 61 6e 20 3c  Under Unix, an <
7ab0: 62 3e 73 71 6c 69 74 65 2a 3c 2f 62 3e 20 70 6f  b>sqlite*</b> po
7ac0: 69 6e 74 65 72 20 73 68 6f 75 6c 64 20 6e 6f 74  inter should not
7ad0: 20 62 65 20 63 61 72 72 69 65 64 20 61 63 72 6f   be carried acro
7ae0: 73 73 20 61 0a 3c 62 3e 66 6f 72 6b 28 29 3c 2f  ss a.<b>fork()</
7af0: 62 3e 20 73 79 73 74 65 6d 20 63 61 6c 6c 20 69  b> system call i
7b00: 6e 74 6f 20 74 68 65 20 63 68 69 6c 64 20 70 72  nto the child pr
7b10: 6f 63 65 73 73 2e 20 20 54 68 65 20 63 68 69 6c  ocess.  The chil
7b20: 64 20 70 72 6f 63 65 73 73 0a 73 68 6f 75 6c 64  d process.should
7b30: 20 6f 70 65 6e 20 69 74 73 20 6f 77 6e 20 63 6f   open its own co
7b40: 70 79 20 6f 66 20 74 68 65 20 64 61 74 61 62 61  py of the databa
7b50: 73 65 20 61 66 74 65 72 20 74 68 65 20 3c 62 3e  se after the <b>
7b60: 66 6f 72 6b 28 29 3c 2f 62 3e 2e 0a 3c 2f 70 3e  fork()</b>..</p>
7b70: 0a 0a 3c 70 3e 0a 57 68 65 6e 20 75 73 69 6e 67  ..<p>.When using
7b80: 20 4c 69 6e 75 78 54 68 72 65 61 64 73 20 28 77   LinuxThreads (w
7b90: 68 65 72 65 20 65 61 63 68 20 74 68 72 65 61 64  here each thread
7ba0: 20 68 61 73 20 69 74 73 20 6f 77 6e 20 70 72 6f   has its own pro
7bb0: 63 65 73 73 20 49 44 29 0a 69 74 20 69 73 20 69  cess ID).it is i
7bc0: 6c 6c 65 67 61 6c 20 74 6f 20 73 74 61 72 74 20  llegal to start 
7bd0: 61 20 74 72 61 6e 73 61 63 74 69 6f 6e 20 69 6e  a transaction in
7be0: 20 6f 6e 65 20 74 68 72 65 61 64 20 61 6e 64 20   one thread and 
7bf0: 74 68 65 6e 20 61 74 74 65 6d 70 74 0a 74 6f 20  then attempt.to 
7c00: 72 65 61 64 20 6f 72 20 77 72 69 74 65 20 74 68  read or write th
7c10: 65 20 64 61 74 61 62 61 73 65 20 66 72 6f 6d 20  e database from 
7c20: 61 20 64 69 66 66 65 72 65 6e 74 20 74 68 72 65  a different thre
7c30: 61 64 2e 20 20 54 68 69 73 0a 72 65 73 74 72 69  ad.  This.restri
7c40: 63 74 69 6f 6e 20 64 6f 65 73 20 6e 6f 74 20 61  ction does not a
7c50: 70 70 6c 79 20 74 6f 20 50 6f 73 69 78 20 74 68  pply to Posix th
7c60: 72 65 61 64 73 20 77 68 65 72 65 20 61 6c 6c 20  reads where all 
7c70: 74 68 72 65 61 64 73 20 73 68 61 72 65 0a 74 68  threads share.th
7c80: 65 20 73 61 6d 65 20 70 72 6f 63 65 73 73 20 49  e same process I
7c90: 44 2e 0a 3c 2f 70 3e 0a 0a 3c 68 32 3e 55 73 61  D..</p>..<h2>Usa
7ca0: 67 65 20 45 78 61 6d 70 6c 65 73 3c 2f 68 32 3e  ge Examples</h2>
7cb0: 0a 0a 3c 70 3e 46 6f 72 20 65 78 61 6d 70 6c 65  ..<p>For example
7cc0: 73 20 6f 66 20 68 6f 77 20 74 68 65 20 53 51 4c  s of how the SQL
7cd0: 69 74 65 20 43 2f 43 2b 2b 20 69 6e 74 65 72 66  ite C/C++ interf
7ce0: 61 63 65 20 63 61 6e 20 62 65 20 75 73 65 64 2c  ace can be used,
7cf0: 0a 72 65 66 65 72 20 74 6f 20 74 68 65 20 73 6f  .refer to the so
7d00: 75 72 63 65 20 63 6f 64 65 20 66 6f 72 20 74 68  urce code for th
7d10: 65 20 3c 62 3e 73 71 6c 69 74 65 3c 2f 62 3e 20  e <b>sqlite</b> 
7d20: 70 72 6f 67 72 61 6d 20 69 6e 20 74 68 65 0a 66  program in the.f
7d30: 69 6c 65 20 3c 62 3e 73 72 63 2f 73 68 65 6c 6c  ile <b>src/shell
7d40: 2e 63 3c 2f 62 3e 20 6f 66 20 74 68 65 20 73 6f  .c</b> of the so
7d50: 75 72 63 65 20 74 72 65 65 2e 0a 41 64 64 69 74  urce tree..Addit
7d60: 69 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f  ional informatio
7d70: 6e 20 61 62 6f 75 74 20 73 71 6c 69 74 65 20 69  n about sqlite i
7d80: 73 20 61 76 61 69 6c 61 62 6c 65 20 61 74 0a 3c  s available at.<
7d90: 61 20 68 72 65 66 3d 22 73 71 6c 69 74 65 2e 68  a href="sqlite.h
7da0: 74 6d 6c 22 3e 73 71 6c 69 74 65 2e 68 74 6d 6c  tml">sqlite.html
7db0: 3c 2f 61 3e 2e 0a 53 65 65 20 61 6c 73 6f 20 74  </a>..See also t
7dc0: 68 65 20 73 6f 75 72 63 65 73 20 74 6f 20 74 68  he sources to th
7dd0: 65 20 54 63 6c 20 69 6e 74 65 72 66 61 63 65 20  e Tcl interface 
7de0: 66 6f 72 20 53 51 4c 69 74 65 20 69 6e 0a 74 68  for SQLite in.th
7df0: 65 20 73 6f 75 72 63 65 20 66 69 6c 65 20 3c 62  e source file <b
7e00: 3e 73 72 63 2f 74 63 6c 73 71 6c 69 74 65 2e 63  >src/tclsqlite.c
7e10: 3c 2f 62 3e 2e 3c 2f 70 3e 0a 7d 0a 0a 70 75 74  </b>.</p>.}..put
7e20: 73 20 7b 0a 3c 70 3e 3c 68 72 20 2f 3e 3c 2f 70  s {.<p><hr /></p
7e30: 3e 0a 3c 70 3e 3c 61 20 68 72 65 66 3d 22 69 6e  >.<p><a href="in
7e40: 64 65 78 2e 68 74 6d 6c 22 3e 3c 69 6d 67 20 73  dex.html"><img s
7e50: 72 63 3d 22 2f 67 6f 62 61 63 6b 2e 6a 70 67 22  rc="/goback.jpg"
7e60: 20 62 6f 72 64 65 72 3d 30 20 2f 3e 0a 42 61 63   border=0 />.Bac
7e70: 6b 20 74 6f 20 74 68 65 20 53 51 4c 69 74 65 20  k to the SQLite 
7e80: 48 6f 6d 65 20 50 61 67 65 3c 2f 61 3e 0a 3c 2f  Home Page</a>.</
7e90: 70 3e 0a 0a 3c 2f 62 6f 64 79 3e 3c 2f 68 74 6d  p>..</body></htm
7ea0: 6c 3e 7d 0a                                      l>}.