/ Hex Artifact Content
Login

Artifact e76c9fd609326c34cd45cd040b508b0e21908800:


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 35 20 32 30 30 32 2f 30 38 2f 32 34 20 31 38  35 2002/08/24 18
0070: 3a 32 34 3a 35 37 20 64 72 68 20 45 78 70 20 24  :24:57 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 3c 2f 70 3e 3c 2f 64  threads..</p></d
3230: 64 3e 0a 3c 2f 64 6c 3e 0a 3c 2f 62 6c 6f 63 6b  d>.</dl>.</block
3240: 71 75 6f 74 65 3e 0a 0a 3c 68 32 3e 54 68 65 20  quote>..<h2>The 
3250: 45 78 74 65 6e 64 65 64 20 41 50 49 3c 2f 68 32  Extended API</h2
3260: 3e 0a 0a 3c 70 3e 4f 6e 6c 79 20 74 68 65 20 74  >..<p>Only the t
3270: 68 72 65 65 20 63 6f 72 65 20 72 6f 75 74 69 6e  hree core routin
3280: 65 73 20 73 68 6f 77 6e 20 61 62 6f 76 65 20 61  es shown above a
3290: 72 65 20 72 65 71 75 69 72 65 64 20 74 6f 20 75  re required to u
32a0: 73 65 0a 53 51 4c 69 74 65 2e 20 20 42 75 74 20  se.SQLite.  But 
32b0: 74 68 65 72 65 20 61 72 65 20 6d 61 6e 79 20 6f  there are many o
32c0: 74 68 65 72 20 66 75 6e 63 74 69 6f 6e 73 20 74  ther functions t
32d0: 68 61 74 20 70 72 6f 76 69 64 65 20 0a 75 73 65  hat provide .use
32e0: 66 75 6c 20 69 6e 74 65 72 66 61 63 65 73 2e 20  ful interfaces. 
32f0: 20 54 68 65 73 65 20 65 78 74 65 6e 64 65 64 20   These extended 
3300: 72 6f 75 74 69 6e 65 73 20 61 72 65 20 61 73 20  routines are as 
3310: 66 6f 6c 6c 6f 77 73 3a 0a 3c 2f 70 3e 0a 0a 3c  follows:.</p>..<
3320: 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e  blockquote><pre>
3330: 0a 69 6e 74 20 73 71 6c 69 74 65 5f 6c 61 73 74  .int sqlite_last
3340: 5f 69 6e 73 65 72 74 5f 72 6f 77 69 64 28 73 71  _insert_rowid(sq
3350: 6c 69 74 65 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c  lite*);..int sql
3360: 69 74 65 5f 63 68 61 6e 67 65 73 28 73 71 6c 69  ite_changes(sqli
3370: 74 65 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74  te*);..int sqlit
3380: 65 5f 67 65 74 5f 74 61 62 6c 65 28 0a 20 20 73  e_get_table(.  s
3390: 71 6c 69 74 65 2a 2c 0a 20 20 63 68 61 72 20 2a  qlite*,.  char *
33a0: 73 71 6c 2c 0a 20 20 63 68 61 72 20 2a 2a 2a 72  sql,.  char ***r
33b0: 65 73 75 6c 74 2c 0a 20 20 69 6e 74 20 2a 6e 72  esult,.  int *nr
33c0: 6f 77 2c 0a 20 20 69 6e 74 20 2a 6e 63 6f 6c 75  ow,.  int *ncolu
33d0: 6d 6e 2c 0a 20 20 63 68 61 72 20 2a 2a 65 72 72  mn,.  char **err
33e0: 6d 73 67 0a 29 3b 0a 0a 76 6f 69 64 20 73 71 6c  msg.);..void sql
33f0: 69 74 65 5f 66 72 65 65 5f 74 61 62 6c 65 28 63  ite_free_table(c
3400: 68 61 72 2a 2a 29 3b 0a 0a 76 6f 69 64 20 73 71  har**);..void sq
3410: 6c 69 74 65 5f 69 6e 74 65 72 72 75 70 74 28 73  lite_interrupt(s
3420: 71 6c 69 74 65 2a 29 3b 0a 0a 69 6e 74 20 73 71  qlite*);..int sq
3430: 6c 69 74 65 5f 63 6f 6d 70 6c 65 74 65 28 63 6f  lite_complete(co
3440: 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 29 3b 0a  nst char *sql);.
3450: 0a 76 6f 69 64 20 73 71 6c 69 74 65 5f 62 75 73  .void sqlite_bus
3460: 79 5f 68 61 6e 64 6c 65 72 28 73 71 6c 69 74 65  y_handler(sqlite
3470: 2a 2c 20 69 6e 74 20 28 2a 29 28 76 6f 69 64 2a  *, int (*)(void*
3480: 2c 63 6f 6e 73 74 20 63 68 61 72 2a 2c 69 6e 74  ,const char*,int
3490: 29 2c 20 76 6f 69 64 2a 29 3b 0a 0a 76 6f 69 64  ), void*);..void
34a0: 20 73 71 6c 69 74 65 5f 62 75 73 79 5f 74 69 6d   sqlite_busy_tim
34b0: 65 6f 75 74 28 73 71 6c 69 74 65 2a 2c 20 69 6e  eout(sqlite*, in
34c0: 74 20 6d 73 29 3b 0a 0a 63 6f 6e 73 74 20 63 68  t ms);..const ch
34d0: 61 72 20 73 71 6c 69 74 65 5f 76 65 72 73 69 6f  ar sqlite_versio
34e0: 6e 5b 5d 3b 0a 0a 63 6f 6e 73 74 20 63 68 61 72  n[];..const char
34f0: 20 73 71 6c 69 74 65 5f 65 6e 63 6f 64 69 6e 67   sqlite_encoding
3500: 5b 5d 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 5f  [];..int sqlite_
3510: 65 78 65 63 5f 70 72 69 6e 74 66 28 0a 20 20 73  exec_printf(.  s
3520: 71 6c 69 74 65 2a 2c 0a 20 20 63 68 61 72 20 2a  qlite*,.  char *
3530: 73 71 6c 2c 0a 20 20 69 6e 74 20 28 2a 29 28 76  sql,.  int (*)(v
3540: 6f 69 64 2a 2c 69 6e 74 2c 63 68 61 72 2a 2a 2c  oid*,int,char**,
3550: 63 68 61 72 2a 2a 29 2c 0a 20 20 76 6f 69 64 2a  char**),.  void*
3560: 2c 0a 20 20 63 68 61 72 20 2a 2a 65 72 72 6d 73  ,.  char **errms
3570: 67 2c 0a 20 20 2e 2e 2e 0a 29 3b 0a 0a 69 6e 74  g,.  ....);..int
3580: 20 73 71 6c 69 74 65 5f 65 78 65 63 5f 76 70 72   sqlite_exec_vpr
3590: 69 6e 74 66 28 0a 20 20 73 71 6c 69 74 65 2a 2c  intf(.  sqlite*,
35a0: 0a 20 20 63 68 61 72 20 2a 73 71 6c 2c 0a 20 20  .  char *sql,.  
35b0: 69 6e 74 20 28 2a 29 28 76 6f 69 64 2a 2c 69 6e  int (*)(void*,in
35c0: 74 2c 63 68 61 72 2a 2a 2c 63 68 61 72 2a 2a 29  t,char**,char**)
35d0: 2c 0a 20 20 76 6f 69 64 2a 2c 0a 20 20 63 68 61  ,.  void*,.  cha
35e0: 72 20 2a 2a 65 72 72 6d 73 67 2c 0a 20 20 76 61  r **errmsg,.  va
35f0: 5f 6c 69 73 74 0a 29 3b 0a 0a 69 6e 74 20 73 71  _list.);..int sq
3600: 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 5f 70  lite_get_table_p
3610: 72 69 6e 74 66 28 0a 20 20 73 71 6c 69 74 65 2a  rintf(.  sqlite*
3620: 2c 0a 20 20 63 68 61 72 20 2a 73 71 6c 2c 0a 20  ,.  char *sql,. 
3630: 20 63 68 61 72 20 2a 2a 2a 72 65 73 75 6c 74 2c   char ***result,
3640: 0a 20 20 69 6e 74 20 2a 6e 72 6f 77 2c 0a 20 20  .  int *nrow,.  
3650: 69 6e 74 20 2a 6e 63 6f 6c 75 6d 6e 2c 0a 20 20  int *ncolumn,.  
3660: 63 68 61 72 20 2a 2a 65 72 72 6d 73 67 2c 0a 20  char **errmsg,. 
3670: 20 2e 2e 2e 0a 29 3b 0a 0a 69 6e 74 20 73 71 6c   ....);..int sql
3680: 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 5f 76 70  ite_get_table_vp
3690: 72 69 6e 74 66 28 0a 20 20 73 71 6c 69 74 65 2a  rintf(.  sqlite*
36a0: 2c 0a 20 20 63 68 61 72 20 2a 73 71 6c 2c 0a 20  ,.  char *sql,. 
36b0: 20 63 68 61 72 20 2a 2a 2a 72 65 73 75 6c 74 2c   char ***result,
36c0: 0a 20 20 69 6e 74 20 2a 6e 72 6f 77 2c 0a 20 20  .  int *nrow,.  
36d0: 69 6e 74 20 2a 6e 63 6f 6c 75 6d 6e 2c 0a 20 20  int *ncolumn,.  
36e0: 63 68 61 72 20 2a 2a 65 72 72 6d 73 67 2c 0a 20  char **errmsg,. 
36f0: 20 76 61 5f 6c 69 73 74 0a 29 3b 0a 0a 63 68 61   va_list.);..cha
3700: 72 20 2a 73 71 6c 69 74 65 5f 6d 70 72 69 6e 74  r *sqlite_mprint
3710: 66 28 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 46  f(const char *zF
3720: 6f 72 6d 61 74 2c 20 2e 2e 2e 29 3b 0a 0a 63 68  ormat, ...);..ch
3730: 61 72 20 2a 73 71 6c 69 74 65 5f 76 6d 70 72 69  ar *sqlite_vmpri
3740: 6e 74 66 28 63 6f 6e 73 74 20 63 68 61 72 20 2a  ntf(const char *
3750: 7a 46 6f 72 6d 61 74 2c 20 76 61 5f 6c 69 73 74  zFormat, va_list
3760: 29 3b 0a 0a 76 6f 69 64 20 73 71 6c 69 74 65 5f  );..void sqlite_
3770: 66 72 65 65 6d 65 6d 28 63 68 61 72 2a 29 3b 0a  freemem(char*);.
3780: 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75  .</pre></blockqu
3790: 6f 74 65 3e 0a 0a 3c 70 3e 41 6c 6c 20 6f 66 20  ote>..<p>All of 
37a0: 74 68 65 20 61 62 6f 76 65 20 64 65 66 69 6e 69  the above defini
37b0: 74 69 6f 6e 73 20 61 72 65 20 69 6e 63 6c 75 64  tions are includ
37c0: 65 64 20 69 6e 20 74 68 65 20 22 73 71 6c 69 74  ed in the "sqlit
37d0: 65 2e 68 22 0a 68 65 61 64 65 72 20 66 69 6c 65  e.h".header file
37e0: 20 74 68 61 74 20 63 6f 6d 65 73 20 69 6e 20 74   that comes in t
37f0: 68 65 20 73 6f 75 72 63 65 20 74 72 65 65 2e 3c  he source tree.<
3800: 2f 70 3e 0a 0a 3c 68 32 3e 54 68 65 20 52 4f 57  /p>..<h2>The ROW
3810: 49 44 20 6f 66 20 74 68 65 20 6d 6f 73 74 20 72  ID of the most r
3820: 65 63 65 6e 74 20 69 6e 73 65 72 74 3c 2f 68 32  ecent insert</h2
3830: 3e 0a 0a 3c 70 3e 45 76 65 72 79 20 72 6f 77 20  >..<p>Every row 
3840: 6f 66 20 61 6e 20 53 51 4c 69 74 65 20 74 61 62  of an SQLite tab
3850: 6c 65 20 68 61 73 20 61 20 75 6e 69 71 75 65 20  le has a unique 
3860: 69 6e 74 65 67 65 72 20 6b 65 79 2e 20 20 49 66  integer key.  If
3870: 20 74 68 65 0a 74 61 62 6c 65 20 68 61 73 20 61   the.table has a
3880: 20 63 6f 6c 75 6d 6e 20 6c 61 62 65 6c 65 64 20   column labeled 
3890: 49 4e 54 45 47 45 52 20 50 52 49 4d 41 52 59 20  INTEGER PRIMARY 
38a0: 4b 45 59 2c 20 74 68 65 6e 20 74 68 61 74 20 63  KEY, then that c
38b0: 6f 6c 75 6d 6e 0a 73 65 72 76 65 73 20 61 73 20  olumn.serves as 
38c0: 74 68 65 20 6b 65 79 2e 20 20 49 66 20 74 68 65  the key.  If the
38d0: 72 65 20 69 73 20 6e 6f 20 49 4e 54 45 47 45 52  re is no INTEGER
38e0: 20 50 52 49 4d 41 52 59 20 4b 45 59 20 63 6f 6c   PRIMARY KEY col
38f0: 75 6d 6e 20 74 68 65 6e 0a 74 68 65 20 6b 65 79  umn then.the key
3900: 20 69 73 20 61 20 75 6e 69 71 75 65 20 69 6e 74   is a unique int
3910: 65 67 65 72 2e 20 20 54 68 65 20 6b 65 79 20 66  eger.  The key f
3920: 6f 72 20 61 20 72 6f 77 20 63 61 6e 20 62 65 20  or a row can be 
3930: 61 63 63 65 73 73 65 64 20 69 6e 0a 61 20 53 45  accessed in.a SE
3940: 4c 45 43 54 20 73 74 61 74 65 6d 65 6e 74 20 6f  LECT statement o
3950: 72 20 75 73 65 64 20 69 6e 20 61 20 57 48 45 52  r used in a WHER
3960: 45 20 6f 72 20 4f 52 44 45 52 20 42 59 20 63 6c  E or ORDER BY cl
3970: 61 75 73 65 20 75 73 69 6e 67 20 61 6e 79 0a 6f  ause using any.o
3980: 66 20 74 68 65 20 6e 61 6d 65 73 20 22 52 4f 57  f the names "ROW
3990: 49 44 22 2c 20 22 4f 49 44 22 2c 20 6f 72 20 22  ID", "OID", or "
39a0: 5f 52 4f 57 49 44 5f 22 2e 3c 2f 70 3e 0a 0a 3c  _ROWID_".</p>..<
39b0: 70 3e 57 68 65 6e 20 79 6f 75 20 64 6f 20 61 6e  p>When you do an
39c0: 20 69 6e 73 65 72 74 20 69 6e 74 6f 20 61 20 74   insert into a t
39d0: 61 62 6c 65 20 74 68 61 74 20 64 6f 65 73 20 6e  able that does n
39e0: 6f 74 20 68 61 76 65 20 61 6e 20 49 4e 54 45 47  ot have an INTEG
39f0: 45 52 20 50 52 49 4d 41 52 59 0a 4b 45 59 20 63  ER PRIMARY.KEY c
3a00: 6f 6c 75 6d 6e 2c 20 6f 72 20 69 66 20 74 68 65  olumn, or if the
3a10: 20 74 61 62 6c 65 20 64 6f 65 73 20 68 61 76 65   table does have
3a20: 20 61 6e 20 49 4e 54 45 47 45 52 20 50 52 49 4d   an INTEGER PRIM
3a30: 41 52 59 20 4b 45 59 20 62 75 74 20 74 68 65 20  ARY KEY but the 
3a40: 76 61 6c 75 65 0a 66 6f 72 20 74 68 61 74 20 63  value.for that c
3a50: 6f 6c 75 6d 6e 20 69 73 20 6e 6f 74 20 73 70 65  olumn is not spe
3a60: 63 69 66 69 65 64 20 69 6e 20 74 68 65 20 56 41  cified in the VA
3a70: 4c 55 45 53 20 63 6c 61 75 73 65 20 6f 66 20 74  LUES clause of t
3a80: 68 65 20 69 6e 73 65 72 74 2c 20 74 68 65 6e 0a  he insert, then.
3a90: 74 68 65 20 6b 65 79 20 69 73 20 61 75 74 6f 6d  the key is autom
3aa0: 61 74 69 63 61 6c 6c 79 20 67 65 6e 65 72 61 74  atically generat
3ab0: 65 64 2e 20 20 59 6f 75 20 63 61 6e 20 66 69 6e  ed.  You can fin
3ac0: 64 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20 74  d the value of t
3ad0: 68 65 20 6b 65 79 0a 66 6f 72 20 74 68 65 20 6d  he key.for the m
3ae0: 6f 73 74 20 72 65 63 65 6e 74 20 49 4e 53 45 52  ost recent INSER
3af0: 54 20 73 74 61 74 65 6d 65 6e 74 20 75 73 69 6e  T statement usin
3b00: 67 20 74 68 65 0a 3c 62 3e 73 71 6c 69 74 65 5f  g the.<b>sqlite_
3b10: 6c 61 73 74 5f 69 6e 73 65 72 74 5f 72 6f 77 69  last_insert_rowi
3b20: 64 28 29 3c 2f 62 3e 20 41 50 49 20 66 75 6e 63  d()</b> API func
3b30: 74 69 6f 6e 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 54  tion.</p>..<h2>T
3b40: 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 72 6f 77  he number of row
3b50: 73 20 74 68 61 74 20 63 68 61 6e 67 65 64 3c 2f  s that changed</
3b60: 68 32 3e 0a 0a 3c 70 3e 54 68 65 20 3c 62 3e 73  h2>..<p>The <b>s
3b70: 71 6c 69 74 65 5f 63 68 61 6e 67 65 73 28 29 3c  qlite_changes()<
3b80: 2f 62 3e 20 41 50 49 20 66 75 6e 63 74 69 6f 6e  /b> API function
3b90: 20 72 65 74 75 72 6e 73 20 74 68 65 20 6e 75 6d   returns the num
3ba0: 62 65 72 20 6f 66 20 72 6f 77 73 0a 74 68 61 74  ber of rows.that
3bb0: 20 77 65 72 65 20 69 6e 73 65 72 74 65 64 2c 20   were inserted, 
3bc0: 64 65 6c 65 74 65 64 2c 20 6f 72 20 6d 6f 64 69  deleted, or modi
3bd0: 66 69 65 64 20 64 75 72 69 6e 67 20 74 68 65 20  fied during the 
3be0: 6d 6f 73 74 20 72 65 63 65 6e 74 0a 3c 62 3e 73  most recent.<b>s
3bf0: 71 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e  qlite_exec()</b>
3c00: 20 63 61 6c 6c 2e 20 20 54 68 65 20 6e 75 6d 62   call.  The numb
3c10: 65 72 20 72 65 70 6f 72 74 65 64 20 69 6e 63 6c  er reported incl
3c20: 75 64 65 73 20 61 6e 79 20 63 68 61 6e 67 65 73  udes any changes
3c30: 0a 74 68 61 74 20 77 65 72 65 20 6c 61 74 65 72  .that were later
3c40: 20 75 6e 64 6f 6e 65 20 62 79 20 61 20 52 4f 4c   undone by a ROL
3c50: 4c 42 41 43 4b 20 6f 72 20 41 42 4f 52 54 2e 20  LBACK or ABORT. 
3c60: 20 42 75 74 20 72 6f 77 73 20 74 68 61 74 20 61   But rows that a
3c70: 72 65 0a 64 65 6c 65 74 65 64 20 62 65 63 61 75  re.deleted becau
3c80: 73 65 20 6f 66 20 61 20 44 52 4f 50 20 54 41 42  se of a DROP TAB
3c90: 4c 45 20 61 72 65 20 3c 65 6d 3e 6e 6f 74 3c 2f  LE are <em>not</
3ca0: 65 6d 3e 20 63 6f 75 6e 74 65 64 2e 3c 2f 70 3e  em> counted.</p>
3cb0: 0a 0a 3c 70 3e 53 51 4c 69 74 65 20 69 6d 70 6c  ..<p>SQLite impl
3cc0: 65 6d 65 6e 74 73 20 74 68 65 20 63 6f 6d 6d 61  ements the comma
3cd0: 6e 64 20 22 3c 62 3e 44 45 4c 45 54 45 20 46 52  nd "<b>DELETE FR
3ce0: 4f 4d 20 74 61 62 6c 65 3c 2f 62 3e 22 20 28 77  OM table</b>" (w
3cf0: 69 74 68 6f 75 74 0a 61 20 57 48 45 52 45 20 63  ithout.a WHERE c
3d00: 6c 61 75 73 65 29 20 62 79 20 64 72 6f 70 70 69  lause) by droppi
3d10: 6e 67 20 74 68 65 20 74 61 62 6c 65 20 74 68 65  ng the table the
3d20: 6e 20 72 65 63 72 65 61 74 69 6e 67 20 69 74 2e  n recreating it.
3d30: 20 20 0a 54 68 69 73 20 69 73 20 6d 75 63 68 20    .This is much 
3d40: 66 61 73 74 65 72 20 74 68 61 6e 20 64 65 6c 65  faster than dele
3d50: 74 69 6e 67 20 74 68 65 20 65 6c 65 6d 65 6e 74  ting the element
3d60: 73 20 6f 66 20 74 68 65 20 74 61 62 6c 65 20 69  s of the table i
3d70: 6e 64 69 76 69 64 75 61 6c 6c 79 2e 0a 42 75 74  ndividually..But
3d80: 20 69 74 20 61 6c 73 6f 20 6d 65 61 6e 73 20 74   it also means t
3d90: 68 61 74 20 74 68 65 20 76 61 6c 75 65 20 72 65  hat the value re
3da0: 74 75 72 6e 65 64 20 66 72 6f 6d 20 3c 62 3e 73  turned from <b>s
3db0: 71 6c 69 74 65 5f 63 68 61 6e 67 65 73 28 29 3c  qlite_changes()<
3dc0: 2f 62 3e 0a 77 69 6c 6c 20 62 65 20 7a 65 72 6f  /b>.will be zero
3dd0: 20 72 65 67 61 72 64 6c 65 73 73 20 6f 66 20 74   regardless of t
3de0: 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 65 6c 65  he number of ele
3df0: 6d 65 6e 74 73 20 74 68 61 74 20 77 65 72 65 20  ments that were 
3e00: 6f 72 69 67 69 6e 61 6c 6c 79 0a 69 6e 20 74 68  originally.in th
3e10: 65 20 74 61 62 6c 65 2e 20 20 49 66 20 61 6e 20  e table.  If an 
3e20: 61 63 63 75 72 61 74 65 20 63 6f 75 6e 74 20 6f  accurate count o
3e30: 66 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20  f the number of 
3e40: 65 6c 65 6d 65 6e 74 73 20 64 65 6c 65 74 65 64  elements deleted
3e50: 0a 69 73 20 6e 65 63 65 73 73 61 72 79 2c 20 75  .is necessary, u
3e60: 73 65 20 22 3c 62 3e 44 45 4c 45 54 45 20 46 52  se "<b>DELETE FR
3e70: 4f 4d 20 74 61 62 6c 65 20 57 48 45 52 45 20 31  OM table WHERE 1
3e80: 3c 2f 62 3e 22 20 69 6e 73 74 65 61 64 2e 3c 2f  </b>" instead.</
3e90: 70 3e 0a 0a 3c 68 32 3e 51 75 65 72 79 69 6e 67  p>..<h2>Querying
3ea0: 20 77 69 74 68 6f 75 74 20 75 73 69 6e 67 20 61   without using a
3eb0: 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69   callback functi
3ec0: 6f 6e 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65 20  on</h2>..<p>The 
3ed0: 3c 62 3e 73 71 6c 69 74 65 5f 67 65 74 5f 74 61  <b>sqlite_get_ta
3ee0: 62 6c 65 28 29 3c 2f 62 3e 20 66 75 6e 63 74 69  ble()</b> functi
3ef0: 6f 6e 20 69 73 20 61 20 77 72 61 70 70 65 72 20  on is a wrapper 
3f00: 61 72 6f 75 6e 64 0a 3c 62 3e 73 71 6c 69 74 65  around.<b>sqlite
3f10: 5f 65 78 65 63 28 29 3c 2f 62 3e 20 74 68 61 74  _exec()</b> that
3f20: 20 63 6f 6c 6c 65 63 74 73 20 61 6c 6c 20 74 68   collects all th
3f30: 65 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 66 72  e information fr
3f40: 6f 6d 20 73 75 63 63 65 73 73 69 76 65 0a 63 61  om successive.ca
3f50: 6c 6c 62 61 63 6b 73 20 61 6e 64 20 77 72 69 74  llbacks and writ
3f60: 65 73 20 69 74 20 69 6e 74 6f 20 6d 65 6d 6f 72  es it into memor
3f70: 79 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20  y obtained from 
3f80: 6d 61 6c 6c 6f 63 28 29 2e 20 20 54 68 69 73 0a  malloc().  This.
3f90: 69 73 20 61 20 63 6f 6e 76 65 6e 69 65 6e 63 65  is a convenience
3fa0: 20 66 75 6e 63 74 69 6f 6e 20 74 68 61 74 20 61   function that a
3fb0: 6c 6c 6f 77 73 20 74 68 65 20 61 70 70 6c 69 63  llows the applic
3fc0: 61 74 69 6f 6e 20 74 6f 20 67 65 74 20 74 68 65  ation to get the
3fd0: 0a 65 6e 74 69 72 65 20 72 65 73 75 6c 74 20 6f  .entire result o
3fe0: 66 20 61 20 64 61 74 61 62 61 73 65 20 71 75 65  f a database que
3ff0: 72 79 20 77 69 74 68 20 61 20 73 69 6e 67 6c 65  ry with a single
4000: 20 66 75 6e 63 74 69 6f 6e 20 63 61 6c 6c 2e 3c   function call.<
4010: 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 6d 61 69 6e  /p>..<p>The main
4020: 20 72 65 73 75 6c 74 20 66 72 6f 6d 20 3c 62 3e   result from <b>
4030: 73 71 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65  sqlite_get_table
4040: 28 29 3c 2f 62 3e 20 69 73 20 61 6e 20 61 72 72  ()</b> is an arr
4050: 61 79 20 6f 66 20 70 6f 69 6e 74 65 72 73 0a 74  ay of pointers.t
4060: 6f 20 73 74 72 69 6e 67 73 2e 20 20 54 68 65 72  o strings.  Ther
4070: 65 20 69 73 20 6f 6e 65 20 65 6c 65 6d 65 6e 74  e is one element
4080: 20 69 6e 20 74 68 69 73 20 61 72 72 61 79 20 66   in this array f
4090: 6f 72 20 65 61 63 68 20 63 6f 6c 75 6d 6e 20 6f  or each column o
40a0: 66 0a 65 61 63 68 20 72 6f 77 20 69 6e 20 74 68  f.each row in th
40b0: 65 20 72 65 73 75 6c 74 2e 20 20 4e 55 4c 4c 20  e result.  NULL 
40c0: 72 65 73 75 6c 74 73 20 61 72 65 20 72 65 70 72  results are repr
40d0: 65 73 65 6e 74 65 64 20 62 79 20 61 20 4e 55 4c  esented by a NUL
40e0: 4c 0a 70 6f 69 6e 74 65 72 2e 20 49 6e 20 61 64  L.pointer. In ad
40f0: 64 69 74 69 6f 6e 20 74 6f 20 74 68 65 20 72 65  dition to the re
4100: 67 75 6c 61 72 20 64 61 74 61 2c 20 74 68 65 72  gular data, ther
4110: 65 20 69 73 20 61 6e 20 61 64 64 65 64 20 72 6f  e is an added ro
4120: 77 20 61 74 20 74 68 65 20 0a 62 65 67 69 6e 6e  w at the .beginn
4130: 69 6e 67 20 6f 66 20 74 68 65 20 61 72 72 61 79  ing of the array
4140: 20 74 68 61 74 20 63 6f 6e 74 61 69 6e 73 20 74   that contains t
4150: 68 65 20 6e 61 6d 65 20 6f 66 20 65 61 63 68 20  he name of each 
4160: 63 6f 6c 75 6d 6e 20 6f 66 20 74 68 65 0a 72 65  column of the.re
4170: 73 75 6c 74 2e 3c 2f 70 3e 0a 0a 3c 70 3e 41 73  sult.</p>..<p>As
4180: 20 61 6e 20 65 78 61 6d 70 6c 65 2c 20 63 6f 6e   an example, con
4190: 73 69 64 65 72 20 74 68 65 20 66 6f 6c 6c 6f 77  sider the follow
41a0: 69 6e 67 20 71 75 65 72 79 3a 3c 2f 70 3e 0a 0a  ing query:</p>..
41b0: 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 53 45 4c  <blockquote>.SEL
41c0: 45 43 54 20 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d  ECT employee_nam
41d0: 65 2c 20 6c 6f 67 69 6e 2c 20 68 6f 73 74 20 46  e, login, host F
41e0: 52 4f 4d 20 75 73 65 72 73 20 57 48 45 52 45 20  ROM users WHERE 
41f0: 6c 6f 67 69 63 20 4c 49 4b 45 20 27 64 25 27 3b  logic LIKE 'd%';
4200: 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a  .</blockquote>..
4210: 3c 70 3e 54 68 69 73 20 71 75 65 72 79 20 77 69  <p>This query wi
4220: 6c 6c 20 72 65 74 75 72 6e 20 74 68 65 20 6e 61  ll return the na
4230: 6d 65 2c 20 6c 6f 67 69 6e 20 61 6e 64 20 68 6f  me, login and ho
4240: 73 74 20 63 6f 6d 70 75 74 65 72 20 6e 61 6d 65  st computer name
4250: 0a 66 6f 72 20 65 76 65 72 79 20 65 6d 70 6c 6f  .for every emplo
4260: 79 65 65 20 77 68 6f 73 65 20 6c 6f 67 69 6e 20  yee whose login 
4270: 62 65 67 69 6e 73 20 77 69 74 68 20 74 68 65 20  begins with the 
4280: 6c 65 74 74 65 72 20 22 64 22 2e 20 20 49 66 20  letter "d".  If 
4290: 74 68 69 73 0a 71 75 65 72 79 20 69 73 20 73 75  this.query is su
42a0: 62 6d 69 74 74 65 64 20 74 6f 20 3c 62 3e 73 71  bmitted to <b>sq
42b0: 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 28 29  lite_get_table()
42c0: 3c 2f 62 3e 20 74 68 65 20 72 65 73 75 6c 74 20  </b> the result 
42d0: 6d 69 67 68 74 0a 6c 6f 6f 6b 20 6c 69 6b 65 20  might.look like 
42e0: 74 68 69 73 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63  this:</p>..<bloc
42f0: 6b 71 75 6f 74 65 3e 0a 6e 72 6f 77 20 3d 20 32  kquote>.nrow = 2
4300: 3c 62 72 3e 0a 6e 63 6f 6c 75 6d 6e 20 3d 20 33  <br>.ncolumn = 3
4310: 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 30 5d 20 3d  <br>.result[0] =
4320: 20 22 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65 22   "employee_name"
4330: 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 31 5d 20 3d  <br>.result[1] =
4340: 20 22 6c 6f 67 69 6e 22 3c 62 72 3e 0a 72 65 73   "login"<br>.res
4350: 75 6c 74 5b 32 5d 20 3d 20 22 68 6f 73 74 22 3c  ult[2] = "host"<
4360: 62 72 3e 0a 72 65 73 75 6c 74 5b 33 5d 20 3d 20  br>.result[3] = 
4370: 22 64 75 6d 6d 79 22 3c 62 72 3e 0a 72 65 73 75  "dummy"<br>.resu
4380: 6c 74 5b 34 5d 20 3d 20 22 4e 6f 20 73 75 63 68  lt[4] = "No such
4390: 20 75 73 65 72 22 3c 62 72 3e 0a 72 65 73 75 6c   user"<br>.resul
43a0: 74 5b 35 5d 20 3d 20 30 3c 62 72 3e 0a 72 65 73  t[5] = 0<br>.res
43b0: 75 6c 74 5b 36 5d 20 3d 20 22 44 2e 20 52 69 63  ult[6] = "D. Ric
43c0: 68 61 72 64 20 48 69 70 70 22 3c 62 72 3e 0a 72  hard Hipp"<br>.r
43d0: 65 73 75 6c 74 5b 37 5d 20 3d 20 22 64 72 68 22  esult[7] = "drh"
43e0: 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 38 5d 20 3d  <br>.result[8] =
43f0: 20 22 7a 61 64 6f 6b 22 0a 3c 2f 62 6c 6f 63 6b   "zadok".</block
4400: 71 75 6f 74 65 3e 0a 0a 3c 70 3e 4e 6f 74 69 63  quote>..<p>Notic
4410: 65 20 74 68 61 74 20 74 68 65 20 22 68 6f 73 74  e that the "host
4420: 22 20 76 61 6c 75 65 20 66 6f 72 20 74 68 65 20  " value for the 
4430: 22 64 75 6d 6d 79 22 20 72 65 63 6f 72 64 20 69  "dummy" record i
4440: 73 20 4e 55 4c 4c 20 73 6f 0a 74 68 65 20 72 65  s NULL so.the re
4450: 73 75 6c 74 5b 5d 20 61 72 72 61 79 20 63 6f 6e  sult[] array con
4460: 74 61 69 6e 73 20 61 20 4e 55 4c 4c 20 70 6f 69  tains a NULL poi
4470: 6e 74 65 72 20 61 74 20 74 68 61 74 20 73 6c 6f  nter at that slo
4480: 74 2e 3c 2f 70 3e 0a 0a 3c 70 3e 49 66 20 74 68  t.</p>..<p>If th
4490: 65 20 72 65 73 75 6c 74 20 73 65 74 20 6f 66 20  e result set of 
44a0: 61 20 71 75 65 72 79 20 69 73 20 65 6d 70 74 79  a query is empty
44b0: 2c 20 74 68 65 6e 20 62 79 20 64 65 66 61 75 6c  , then by defaul
44c0: 74 0a 3c 62 3e 73 71 6c 69 74 65 5f 67 65 74 5f  t.<b>sqlite_get_
44d0: 74 61 62 6c 65 28 29 3c 2f 62 3e 20 77 69 6c 6c  table()</b> will
44e0: 20 73 65 74 20 6e 72 6f 77 20 74 6f 20 30 20 61   set nrow to 0 a
44f0: 6e 64 20 6c 65 61 76 65 20 69 74 73 0a 72 65 73  nd leave its.res
4500: 75 6c 74 20 70 61 72 61 6d 65 74 65 72 20 69 73  ult parameter is
4510: 20 73 65 74 20 74 6f 20 4e 55 4c 4c 2e 20 20 42   set to NULL.  B
4520: 75 74 20 69 66 20 74 68 65 20 45 4d 50 54 59 5f  ut if the EMPTY_
4530: 52 45 53 55 4c 54 5f 43 41 4c 4c 42 41 43 4b 53  RESULT_CALLBACKS
4540: 0a 70 72 61 67 6d 61 20 69 73 20 4f 4e 20 74 68  .pragma is ON th
4550: 65 6e 20 74 68 65 20 72 65 73 75 6c 74 20 70 61  en the result pa
4560: 72 61 6d 65 74 65 72 20 69 73 20 69 6e 69 74 69  rameter is initi
4570: 61 6c 69 7a 65 64 20 74 6f 20 74 68 65 20 6e 61  alized to the na
4580: 6d 65 73 0a 6f 66 20 74 68 65 20 63 6f 6c 75 6d  mes.of the colum
4590: 6e 73 20 6f 6e 6c 79 2e 20 20 46 6f 72 20 65 78  ns only.  For ex
45a0: 61 6d 70 6c 65 2c 20 63 6f 6e 73 69 64 65 72 20  ample, consider 
45b0: 74 68 69 73 20 71 75 65 72 79 20 77 68 69 63 68  this query which
45c0: 20 68 61 73 0a 61 6e 20 65 6d 70 74 79 20 72 65   has.an empty re
45d0: 73 75 6c 74 20 73 65 74 3a 3c 2f 70 3e 0a 0a 3c  sult set:</p>..<
45e0: 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 53 45 4c 45  blockquote>.SELE
45f0: 43 54 20 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65  CT employee_name
4600: 2c 20 6c 6f 67 69 6e 2c 20 68 6f 73 74 20 46 52  , login, host FR
4610: 4f 4d 20 75 73 65 72 73 20 57 48 45 52 45 20 65  OM users WHERE e
4620: 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65 20 49 53 20  mployee_name IS 
4630: 4e 55 4c 4c 3b 0a 3c 2f 62 6c 6f 63 6b 71 75 6f  NULL;.</blockquo
4640: 74 65 3e 0a 0a 3c 70 3e 0a 54 68 65 20 64 65 66  te>..<p>.The def
4650: 61 75 6c 74 20 62 65 68 61 76 69 6f 72 20 67 69  ault behavior gi
4660: 76 65 73 20 74 68 69 73 20 72 65 73 75 6c 74 73  ves this results
4670: 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75  :.</p>..<blockqu
4680: 6f 74 65 3e 0a 6e 72 6f 77 20 3d 20 30 3c 62 72  ote>.nrow = 0<br
4690: 3e 0a 6e 63 6f 6c 75 6d 6e 20 3d 20 30 3c 62 72  >.ncolumn = 0<br
46a0: 3e 0a 72 65 73 75 6c 74 20 3d 20 30 3c 62 72 3e  >.result = 0<br>
46b0: 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a  .</blockquote>..
46c0: 3c 70 3e 0a 42 75 74 20 69 66 20 74 68 65 20 45  <p>.But if the E
46d0: 4d 50 54 59 5f 52 45 53 55 4c 54 5f 43 41 4c 4c  MPTY_RESULT_CALL
46e0: 42 41 43 4b 53 20 70 72 61 67 6d 61 20 69 73 20  BACKS pragma is 
46f0: 4f 4e 2c 20 74 68 65 6e 20 74 68 65 20 66 6f 6c  ON, then the fol
4700: 6c 6f 77 69 6e 67 0a 69 73 20 72 65 74 75 72 6e  lowing.is return
4710: 65 64 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b  ed:.</p>..<block
4720: 71 75 6f 74 65 3e 0a 6e 72 6f 77 20 3d 20 30 3c  quote>.nrow = 0<
4730: 62 72 3e 0a 6e 63 6f 6c 75 6d 6e 20 3d 20 33 3c  br>.ncolumn = 3<
4740: 62 72 3e 0a 72 65 73 75 6c 74 5b 30 5d 20 3d 20  br>.result[0] = 
4750: 22 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65 22 3c  "employee_name"<
4760: 62 72 3e 0a 72 65 73 75 6c 74 5b 31 5d 20 3d 20  br>.result[1] = 
4770: 22 6c 6f 67 69 6e 22 3c 62 72 3e 0a 72 65 73 75  "login"<br>.resu
4780: 6c 74 5b 32 5d 20 3d 20 22 68 6f 73 74 22 3c 62  lt[2] = "host"<b
4790: 72 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e  r>.</blockquote>
47a0: 0a 0a 3c 70 3e 4d 65 6d 6f 72 79 20 74 6f 20 68  ..<p>Memory to h
47b0: 6f 6c 64 20 74 68 65 20 69 6e 66 6f 72 6d 61 74  old the informat
47c0: 69 6f 6e 20 72 65 74 75 72 6e 65 64 20 62 79 20  ion returned by 
47d0: 3c 62 3e 73 71 6c 69 74 65 5f 67 65 74 5f 74 61  <b>sqlite_get_ta
47e0: 62 6c 65 28 29 3c 2f 62 3e 0a 69 73 20 6f 62 74  ble()</b>.is obt
47f0: 61 69 6e 65 64 20 66 72 6f 6d 20 6d 61 6c 6c 6f  ained from mallo
4800: 63 28 29 2e 20 20 42 75 74 20 74 68 65 20 63 61  c().  But the ca
4810: 6c 6c 69 6e 67 20 66 75 6e 63 74 69 6f 6e 20 73  lling function s
4820: 68 6f 75 6c 64 20 6e 6f 74 20 74 72 79 0a 74 6f  hould not try.to
4830: 20 66 72 65 65 20 74 68 69 73 20 69 6e 66 6f 72   free this infor
4840: 6d 61 74 69 6f 6e 20 64 69 72 65 63 74 6c 79 2e  mation directly.
4850: 20 20 49 6e 73 74 65 61 64 2c 20 70 61 73 73 20    Instead, pass 
4860: 74 68 65 20 63 6f 6d 70 6c 65 74 65 20 74 61 62  the complete tab
4870: 6c 65 0a 74 6f 20 3c 62 3e 73 71 6c 69 74 65 5f  le.to <b>sqlite_
4880: 66 72 65 65 5f 74 61 62 6c 65 28 29 3c 2f 62 3e  free_table()</b>
4890: 20 77 68 65 6e 20 74 68 65 20 74 61 62 6c 65 20   when the table 
48a0: 69 73 20 6e 6f 20 6c 6f 6e 67 65 72 20 6e 65 65  is no longer nee
48b0: 64 65 64 2e 0a 49 74 20 69 73 20 73 61 66 65 20  ded..It is safe 
48c0: 74 6f 20 63 61 6c 6c 20 3c 62 3e 73 71 6c 69 74  to call <b>sqlit
48d0: 65 5f 66 72 65 65 5f 74 61 62 6c 65 28 29 3c 2f  e_free_table()</
48e0: 62 3e 20 77 69 74 68 20 61 20 4e 55 4c 4c 20 70  b> with a NULL p
48f0: 6f 69 6e 74 65 72 20 73 75 63 68 0a 61 73 20 77  ointer such.as w
4900: 6f 75 6c 64 20 62 65 20 72 65 74 75 72 6e 65 64  ould be returned
4910: 20 69 66 20 74 68 65 20 72 65 73 75 6c 74 20 73   if the result s
4920: 65 74 20 69 73 20 65 6d 70 74 79 2e 3c 2f 70 3e  et is empty.</p>
4930: 0a 0a 3c 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69  ..<p>The <b>sqli
4940: 74 65 5f 67 65 74 5f 74 61 62 6c 65 28 29 3c 2f  te_get_table()</
4950: 62 3e 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72  b> routine retur
4960: 6e 73 20 74 68 65 20 73 61 6d 65 20 69 6e 74 65  ns the same inte
4970: 67 65 72 0a 72 65 73 75 6c 74 20 63 6f 64 65 20  ger.result code 
4980: 61 73 20 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65  as <b>sqlite_exe
4990: 63 28 29 3c 2f 62 3e 2e 3c 2f 70 3e 0a 0a 3c 68  c()</b>.</p>..<h
49a0: 32 3e 49 6e 74 65 72 72 75 70 74 69 6e 67 20 61  2>Interrupting a
49b0: 6e 20 53 51 4c 69 74 65 20 6f 70 65 72 61 74 69  n SQLite operati
49c0: 6f 6e 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65 20  on</h2>..<p>The 
49d0: 3c 62 3e 73 71 6c 69 74 65 5f 69 6e 74 65 72 72  <b>sqlite_interr
49e0: 75 70 74 28 29 3c 2f 62 3e 20 66 75 6e 63 74 69  upt()</b> functi
49f0: 6f 6e 20 63 61 6e 20 62 65 20 63 61 6c 6c 65 64  on can be called
4a00: 20 66 72 6f 6d 20 61 0a 64 69 66 66 65 72 65 6e   from a.differen
4a10: 74 20 74 68 72 65 61 64 20 6f 72 20 66 72 6f 6d  t thread or from
4a20: 20 61 20 73 69 67 6e 61 6c 20 68 61 6e 64 6c 65   a signal handle
4a30: 72 20 74 6f 20 63 61 75 73 65 20 74 68 65 20 63  r to cause the c
4a40: 75 72 72 65 6e 74 20 64 61 74 61 62 61 73 65 0a  urrent database.
4a50: 6f 70 65 72 61 74 69 6f 6e 20 74 6f 20 65 78 69  operation to exi
4a60: 74 20 61 74 20 69 74 73 20 66 69 72 73 74 20 6f  t at its first o
4a70: 70 70 6f 72 74 75 6e 69 74 79 2e 20 20 57 68 65  pportunity.  Whe
4a80: 6e 20 74 68 69 73 20 68 61 70 70 65 6e 73 2c 0a  n this happens,.
4a90: 74 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 65 78  the <b>sqlite_ex
4aa0: 65 63 28 29 3c 2f 62 3e 20 72 6f 75 74 69 6e 65  ec()</b> routine
4ab0: 20 28 6f 72 20 74 68 65 20 65 71 75 69 76 61 6c   (or the equival
4ac0: 65 6e 74 29 20 74 68 61 74 20 73 74 61 72 74 65  ent) that starte
4ad0: 64 0a 74 68 65 20 64 61 74 61 62 61 73 65 20 6f  d.the database o
4ae0: 70 65 72 61 74 69 6f 6e 20 77 69 6c 6c 20 72 65  peration will re
4af0: 74 75 72 6e 20 53 51 4c 49 54 45 5f 49 4e 54 45  turn SQLITE_INTE
4b00: 52 52 55 50 54 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e  RRUPT.</p>..<h2>
4b10: 54 65 73 74 69 6e 67 20 66 6f 72 20 61 20 63 6f  Testing for a co
4b20: 6d 70 6c 65 74 65 20 53 51 4c 20 73 74 61 74 65  mplete SQL state
4b30: 6d 65 6e 74 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68  ment</h2>..<p>Th
4b40: 65 20 6e 65 78 74 20 69 6e 74 65 72 66 61 63 65  e next interface
4b50: 20 72 6f 75 74 69 6e 65 20 74 6f 20 53 51 4c 69   routine to SQLi
4b60: 74 65 20 69 73 20 61 20 63 6f 6e 76 65 6e 69 65  te is a convenie
4b70: 6e 63 65 20 66 75 6e 63 74 69 6f 6e 20 75 73 65  nce function use
4b80: 64 0a 74 6f 20 74 65 73 74 20 77 68 65 74 68 65  d.to test whethe
4b90: 72 20 6f 72 20 6e 6f 74 20 61 20 73 74 72 69 6e  r or not a strin
4ba0: 67 20 66 6f 72 6d 73 20 61 20 63 6f 6d 70 6c 65  g forms a comple
4bb0: 74 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  te SQL statement
4bc0: 2e 0a 49 66 20 74 68 65 20 3c 62 3e 73 71 6c 69  ..If the <b>sqli
4bd0: 74 65 5f 63 6f 6d 70 6c 65 74 65 28 29 3c 2f 62  te_complete()</b
4be0: 3e 20 66 75 6e 63 74 69 6f 6e 20 72 65 74 75 72  > function retur
4bf0: 6e 73 20 74 72 75 65 20 77 68 65 6e 20 69 74 73  ns true when its
4c00: 20 69 6e 70 75 74 0a 69 73 20 61 20 73 74 72 69   input.is a stri
4c10: 6e 67 2c 20 74 68 65 6e 20 74 68 65 20 61 72 67  ng, then the arg
4c20: 75 6d 65 6e 74 20 66 6f 72 6d 73 20 61 20 63 6f  ument forms a co
4c30: 6d 70 6c 65 74 65 20 53 51 4c 20 73 74 61 74 65  mplete SQL state
4c40: 6d 65 6e 74 2e 0a 54 68 65 72 65 20 61 72 65 20  ment..There are 
4c50: 6e 6f 20 67 75 61 72 61 6e 74 65 65 73 20 74 68  no guarantees th
4c60: 61 74 20 74 68 65 20 73 79 6e 74 61 78 20 6f 66  at the syntax of
4c70: 20 74 68 61 74 20 73 74 61 74 65 6d 65 6e 74 20   that statement 
4c80: 69 73 20 63 6f 72 72 65 63 74 2c 0a 62 75 74 20  is correct,.but 
4c90: 77 65 20 61 74 20 6c 65 61 73 74 20 6b 6e 6f 77  we at least know
4ca0: 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20 69   the statement i
4cb0: 73 20 63 6f 6d 70 6c 65 74 65 2e 20 20 49 66 20  s complete.  If 
4cc0: 3c 62 3e 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65  <b>sqlite_comple
4cd0: 74 65 28 29 3c 2f 62 3e 0a 72 65 74 75 72 6e 73  te()</b>.returns
4ce0: 20 66 61 6c 73 65 2c 20 74 68 65 6e 20 6d 6f 72   false, then mor
4cf0: 65 20 74 65 78 74 20 69 73 20 72 65 71 75 69 72  e text is requir
4d00: 65 64 20 74 6f 20 63 6f 6d 70 6c 65 74 65 20 74  ed to complete t
4d10: 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  he SQL statement
4d20: 2e 3c 2f 70 3e 0a 0a 3c 70 3e 46 6f 72 20 74 68  .</p>..<p>For th
4d30: 65 20 70 75 72 70 6f 73 65 20 6f 66 20 74 68 65  e purpose of the
4d40: 20 3c 62 3e 73 71 6c 69 74 65 5f 63 6f 6d 70 6c   <b>sqlite_compl
4d50: 65 74 65 28 29 3c 2f 62 3e 20 66 75 6e 63 74 69  ete()</b> functi
4d60: 6f 6e 2c 20 61 6e 20 53 51 4c 0a 73 74 61 74 65  on, an SQL.state
4d70: 6d 65 6e 74 20 69 73 20 63 6f 6d 70 6c 65 74 65  ment is complete
4d80: 20 69 66 20 69 74 20 65 6e 64 73 20 69 6e 20 61   if it ends in a
4d90: 20 73 65 6d 69 63 6f 6c 6f 6e 2e 3c 2f 70 3e 0a   semicolon.</p>.
4da0: 0a 3c 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69 74  .<p>The <b>sqlit
4db0: 65 3c 2f 62 3e 20 63 6f 6d 6d 61 6e 64 2d 6c 69  e</b> command-li
4dc0: 6e 65 20 75 74 69 6c 69 74 79 20 75 73 65 73 20  ne utility uses 
4dd0: 74 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 63 6f  the <b>sqlite_co
4de0: 6d 70 6c 65 74 65 28 29 3c 2f 62 3e 0a 66 75 6e  mplete()</b>.fun
4df0: 63 74 69 6f 6e 20 74 6f 20 6b 6e 6f 77 20 77 68  ction to know wh
4e00: 65 6e 20 69 74 20 6e 65 65 64 73 20 74 6f 20 63  en it needs to c
4e10: 61 6c 6c 20 3c 62 3e 73 71 6c 69 74 65 5f 65 78  all <b>sqlite_ex
4e20: 65 63 28 29 3c 2f 62 3e 2e 20 20 41 66 74 65 72  ec()</b>.  After
4e30: 20 65 61 63 68 0a 6c 69 6e 65 20 6f 66 20 69 6e   each.line of in
4e40: 70 75 74 20 69 73 20 72 65 63 65 69 76 65 64 2c  put is received,
4e50: 20 3c 62 3e 73 71 6c 69 74 65 3c 2f 62 3e 20 63   <b>sqlite</b> c
4e60: 61 6c 6c 73 20 3c 62 3e 73 71 6c 69 74 65 5f 63  alls <b>sqlite_c
4e70: 6f 6d 70 6c 65 74 65 28 29 3c 2f 62 3e 0a 6f 6e  omplete()</b>.on
4e80: 20 61 6c 6c 20 69 6e 70 75 74 20 69 6e 20 69 74   all input in it
4e90: 73 20 62 75 66 66 65 72 2e 20 20 49 66 20 3c 62  s buffer.  If <b
4ea0: 3e 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74 65  >sqlite_complete
4eb0: 28 29 3c 2f 62 3e 20 72 65 74 75 72 6e 73 20 74  ()</b> returns t
4ec0: 72 75 65 2c 20 0a 74 68 65 6e 20 3c 62 3e 73 71  rue, .then <b>sq
4ed0: 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e 20  lite_exec()</b> 
4ee0: 69 73 20 63 61 6c 6c 65 64 20 61 6e 64 20 74 68  is called and th
4ef0: 65 20 69 6e 70 75 74 20 62 75 66 66 65 72 20 69  e input buffer i
4f00: 73 20 72 65 73 65 74 2e 20 20 49 66 0a 3c 62 3e  s reset.  If.<b>
4f10: 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74 65 28  sqlite_complete(
4f20: 29 3c 2f 62 3e 20 72 65 74 75 72 6e 73 20 66 61  )</b> returns fa
4f30: 6c 73 65 2c 20 74 68 65 6e 20 74 68 65 20 70 72  lse, then the pr
4f40: 6f 6d 70 74 20 69 73 20 63 68 61 6e 67 65 64 20  ompt is changed 
4f50: 74 6f 0a 74 68 65 20 63 6f 6e 74 69 6e 75 61 74  to.the continuat
4f60: 69 6f 6e 20 70 72 6f 6d 70 74 20 61 6e 64 20 61  ion prompt and a
4f70: 6e 6f 74 68 65 72 20 6c 69 6e 65 20 6f 66 20 74  nother line of t
4f80: 65 78 74 20 69 73 20 72 65 61 64 20 61 6e 64 20  ext is read and 
4f90: 61 64 64 65 64 20 74 6f 0a 74 68 65 20 69 6e 70  added to.the inp
4fa0: 75 74 20 62 75 66 66 65 72 2e 3c 2f 70 3e 0a 0a  ut buffer.</p>..
4fb0: 3c 68 32 3e 4c 69 62 72 61 72 79 20 76 65 72 73  <h2>Library vers
4fc0: 69 6f 6e 20 73 74 72 69 6e 67 3c 2f 68 32 3e 0a  ion string</h2>.
4fd0: 0a 3c 70 3e 54 68 65 20 53 51 4c 69 74 65 20 6c  .<p>The SQLite l
4fe0: 69 62 72 61 72 79 20 65 78 70 6f 72 74 73 20 74  ibrary exports t
4ff0: 68 65 20 73 74 72 69 6e 67 20 63 6f 6e 73 74 61  he string consta
5000: 6e 74 20 6e 61 6d 65 64 0a 3c 62 3e 73 71 6c 69  nt named.<b>sqli
5010: 74 65 5f 76 65 72 73 69 6f 6e 3c 2f 62 3e 20 77  te_version</b> w
5020: 68 69 63 68 20 63 6f 6e 74 61 69 6e 73 20 74 68  hich contains th
5030: 65 20 76 65 72 73 69 6f 6e 20 6e 75 6d 62 65 72  e version number
5040: 20 6f 66 20 74 68 65 0a 6c 69 62 72 61 72 79 2e   of the.library.
5050: 20 20 54 68 65 20 68 65 61 64 65 72 20 66 69 6c    The header fil
5060: 65 20 63 6f 6e 74 61 69 6e 73 20 61 20 6d 61 63  e contains a mac
5070: 72 6f 20 53 51 4c 49 54 45 5f 56 45 52 53 49 4f  ro SQLITE_VERSIO
5080: 4e 0a 77 69 74 68 20 74 68 65 20 73 61 6d 65 20  N.with the same 
5090: 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 20 20 49 66  information.  If
50a0: 20 64 65 73 69 72 65 64 2c 20 61 20 70 72 6f 67   desired, a prog
50b0: 72 61 6d 20 63 61 6e 20 63 6f 6d 70 61 72 65 0a  ram can compare.
50c0: 74 68 65 20 53 51 4c 49 54 45 5f 56 45 52 53 49  the SQLITE_VERSI
50d0: 4f 4e 20 6d 61 63 72 6f 20 61 67 61 69 6e 73 74  ON macro against
50e0: 20 74 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 76   the <b>sqlite_v
50f0: 65 72 73 69 6f 6e 3c 2f 62 3e 0a 73 74 72 69 6e  ersion</b>.strin
5100: 67 20 63 6f 6e 73 74 61 6e 74 20 74 6f 20 76 65  g constant to ve
5110: 72 69 66 79 20 74 68 61 74 20 74 68 65 20 76 65  rify that the ve
5120: 72 73 69 6f 6e 20 6e 75 6d 62 65 72 20 6f 66 20  rsion number of 
5130: 74 68 65 0a 68 65 61 64 65 72 20 66 69 6c 65 20  the.header file 
5140: 61 6e 64 20 74 68 65 20 6c 69 62 72 61 72 79 20  and the library 
5150: 6d 61 74 63 68 2e 3c 2f 70 3e 20 0a 0a 3c 68 32  match.</p> ..<h2
5160: 3e 4c 69 62 72 61 72 79 20 63 68 61 72 61 63 74  >Library charact
5170: 65 72 20 65 6e 63 6f 64 69 6e 67 3c 2f 68 32 3e  er encoding</h2>
5180: 0a 0a 3c 70 3e 42 79 20 64 65 66 61 75 6c 74 2c  ..<p>By default,
5190: 20 53 51 4c 69 74 65 20 61 73 73 75 6d 65 73 20   SQLite assumes 
51a0: 74 68 61 74 20 61 6c 6c 20 64 61 74 61 20 75 73  that all data us
51b0: 65 73 20 61 20 66 69 78 65 64 2d 73 69 7a 65 0a  es a fixed-size.
51c0: 38 2d 62 69 74 20 63 68 61 72 61 63 74 65 72 20  8-bit character 
51d0: 28 69 73 6f 38 38 35 39 29 2e 20 20 42 75 74 20  (iso8859).  But 
51e0: 69 66 20 79 6f 75 20 67 69 76 65 20 74 68 65 20  if you give the 
51f0: 2d 2d 65 6e 61 62 6c 65 2d 75 74 66 38 20 6f 70  --enable-utf8 op
5200: 74 69 6f 6e 0a 74 6f 20 74 68 65 20 63 6f 6e 66  tion.to the conf
5210: 69 67 75 72 65 20 73 63 72 69 70 74 2c 20 74 68  igure script, th
5220: 65 6e 20 74 68 65 20 6c 69 62 72 61 72 79 20 61  en the library a
5230: 73 73 75 6d 65 73 20 55 54 46 2d 38 20 76 61 72  ssumes UTF-8 var
5240: 69 61 62 6c 65 0a 73 69 7a 65 64 20 63 68 61 72  iable.sized char
5250: 61 63 74 65 72 73 2e 20 20 54 68 69 73 20 6d 61  acters.  This ma
5260: 6b 65 73 20 61 20 64 69 66 66 65 72 65 6e 63 65  kes a difference
5270: 20 66 6f 72 20 74 68 65 20 4c 49 4b 45 20 61 6e   for the LIKE an
5280: 64 20 47 4c 4f 42 0a 6f 70 65 72 61 74 6f 72 73  d GLOB.operators
5290: 20 61 6e 64 20 74 68 65 20 4c 45 4e 47 54 48 28   and the LENGTH(
52a0: 29 20 61 6e 64 20 53 55 42 53 54 52 28 29 20 66  ) and SUBSTR() f
52b0: 75 6e 63 74 69 6f 6e 73 2e 20 20 54 68 65 20 73  unctions.  The s
52c0: 74 61 74 69 63 0a 73 74 72 69 6e 67 20 3c 62 3e  tatic.string <b>
52d0: 73 71 6c 69 74 65 5f 65 6e 63 6f 64 69 6e 67 3c  sqlite_encoding<
52e0: 2f 62 3e 20 77 69 6c 6c 20 62 65 20 73 65 74 20  /b> will be set 
52f0: 74 6f 20 65 69 74 68 65 72 20 22 55 54 46 2d 38  to either "UTF-8
5300: 22 20 6f 72 0a 22 69 73 6f 38 38 35 39 22 20 74  " or."iso8859" t
5310: 6f 20 69 6e 64 69 63 61 74 65 20 68 6f 77 20 74  o indicate how t
5320: 68 65 20 6c 69 62 72 61 72 79 20 77 61 73 20 63  he library was c
5330: 6f 6d 70 69 6c 65 64 2e 20 20 49 6e 20 61 64 64  ompiled.  In add
5340: 69 74 69 6f 6e 2c 0a 74 68 65 20 3c 62 3e 73 71  ition,.the <b>sq
5350: 6c 69 74 65 2e 68 3c 2f 62 3e 20 68 65 61 64 65  lite.h</b> heade
5360: 72 20 66 69 6c 65 20 77 69 6c 6c 20 64 65 66 69  r file will defi
5370: 6e 65 20 6f 6e 65 20 6f 66 20 74 68 65 0a 6d 61  ne one of the.ma
5380: 63 72 6f 73 20 3c 62 3e 53 51 4c 49 54 45 5f 55  cros <b>SQLITE_U
5390: 54 46 38 3c 2f 62 3e 20 6f 72 20 3c 62 3e 53 51  TF8</b> or <b>SQ
53a0: 4c 49 54 45 5f 49 53 4f 38 38 35 39 3c 2f 62 3e  LITE_ISO8859</b>
53b0: 2c 20 61 73 20 61 70 70 72 6f 70 72 69 61 74 65  , as appropriate
53c0: 2e 3c 2f 70 3e 0a 0a 3c 70 3e 4e 6f 74 65 20 74  .</p>..<p>Note t
53d0: 68 61 74 20 74 68 65 20 63 68 61 72 61 63 74 65  hat the characte
53e0: 72 20 65 6e 63 6f 64 69 6e 67 20 6d 65 63 68 61  r encoding mecha
53f0: 6e 69 73 6d 20 75 73 65 64 20 62 79 20 53 51 4c  nism used by SQL
5400: 69 74 65 20 63 61 6e 6e 6f 74 0a 62 65 20 63 68  ite cannot.be ch
5410: 61 6e 67 65 64 20 61 74 20 72 75 6e 2d 74 69 6d  anged at run-tim
5420: 65 2e 20 20 54 68 69 73 20 69 73 20 61 20 63 6f  e.  This is a co
5430: 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f  mpile-time optio
5440: 6e 20 6f 6e 6c 79 2e 20 20 54 68 65 0a 3c 62 3e  n only.  The.<b>
5450: 73 71 6c 69 74 65 5f 65 6e 63 6f 64 69 6e 67 3c  sqlite_encoding<
5460: 2f 62 3e 20 63 68 61 72 61 63 74 65 72 20 73 74  /b> character st
5470: 72 69 6e 67 20 6a 75 73 74 20 74 65 6c 6c 73 20  ring just tells 
5480: 79 6f 75 20 68 6f 77 20 74 68 65 20 6c 69 62 72  you how the libr
5490: 61 72 79 0a 77 61 73 20 63 6f 6d 70 69 6c 65 64  ary.was compiled
54a0: 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 43 68 61 6e 67  .</p>..<h2>Chang
54b0: 69 6e 67 20 74 68 65 20 6c 69 62 72 61 72 79 27  ing the library'
54c0: 73 20 72 65 73 70 6f 6e 73 65 20 74 6f 20 6c 6f  s response to lo
54d0: 63 6b 65 64 20 66 69 6c 65 73 3c 2f 68 32 3e 0a  cked files</h2>.
54e0: 0a 3c 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69 74  .<p>The <b>sqlit
54f0: 65 5f 62 75 73 79 5f 68 61 6e 64 6c 65 72 28 29  e_busy_handler()
5500: 3c 2f 62 3e 20 70 72 6f 63 65 64 75 72 65 20 63  </b> procedure c
5510: 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20 72 65  an be used to re
5520: 67 69 73 74 65 72 0a 61 20 62 75 73 79 20 63 61  gister.a busy ca
5530: 6c 6c 62 61 63 6b 20 77 69 74 68 20 61 6e 20 6f  llback with an o
5540: 70 65 6e 20 53 51 4c 69 74 65 20 64 61 74 61 62  pen SQLite datab
5550: 61 73 65 2e 20 20 54 68 65 20 62 75 73 79 20 63  ase.  The busy c
5560: 61 6c 6c 62 61 63 6b 20 77 69 6c 6c 0a 62 65 20  allback will.be 
5570: 69 6e 76 6f 6b 65 64 20 77 68 65 6e 65 76 65 72  invoked whenever
5580: 20 53 51 4c 69 74 65 20 74 72 69 65 73 20 74 6f   SQLite tries to
5590: 20 61 63 63 65 73 73 20 61 20 64 61 74 61 62 61   access a databa
55a0: 73 65 20 74 68 61 74 20 69 73 20 6c 6f 63 6b 65  se that is locke
55b0: 64 2e 0a 54 68 65 20 63 61 6c 6c 62 61 63 6b 20  d..The callback 
55c0: 77 69 6c 6c 20 74 79 70 69 63 61 6c 6c 79 20 64  will typically d
55d0: 6f 20 73 6f 6d 65 20 6f 74 68 65 72 20 75 73 65  o some other use
55e0: 66 75 6c 20 77 6f 72 6b 2c 20 6f 72 20 70 65 72  ful work, or per
55f0: 68 61 70 73 20 73 6c 65 65 70 2c 0a 69 6e 20 6f  haps sleep,.in o
5600: 72 64 65 72 20 74 6f 20 67 69 76 65 20 74 68 65  rder to give the
5610: 20 6c 6f 63 6b 20 61 20 63 68 61 6e 63 65 20 74   lock a chance t
5620: 6f 20 63 6c 65 61 72 2e 20 20 49 66 20 74 68 65  o clear.  If the
5630: 20 63 61 6c 6c 62 61 63 6b 20 72 65 74 75 72 6e   callback return
5640: 73 0a 6e 6f 6e 2d 7a 65 72 6f 2c 20 74 68 65 6e  s.non-zero, then
5650: 20 53 51 4c 69 74 65 20 74 72 69 65 73 20 61 67   SQLite tries ag
5660: 61 69 6e 20 74 6f 20 61 63 63 65 73 73 20 74 68  ain to access th
5670: 65 20 64 61 74 61 62 61 73 65 20 61 6e 64 20 74  e database and t
5680: 68 65 20 63 79 63 6c 65 0a 72 65 70 65 61 74 73  he cycle.repeats
5690: 2e 20 20 49 66 20 74 68 65 20 63 61 6c 6c 62 61  .  If the callba
56a0: 63 6b 20 72 65 74 75 72 6e 73 20 7a 65 72 6f 2c  ck returns zero,
56b0: 20 74 68 65 6e 20 53 51 4c 69 74 65 20 61 62 6f   then SQLite abo
56c0: 72 74 73 20 74 68 65 20 63 75 72 72 65 6e 74 0a  rts the current.
56d0: 6f 70 65 72 61 74 69 6f 6e 20 61 6e 64 20 72 65  operation and re
56e0: 74 75 72 6e 73 20 53 51 4c 49 54 45 5f 42 55 53  turns SQLITE_BUS
56f0: 59 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 61  Y.</p>..<p>The a
5700: 72 67 75 6d 65 6e 74 73 20 74 6f 20 3c 62 3e 73  rguments to <b>s
5710: 71 6c 69 74 65 5f 62 75 73 79 5f 68 61 6e 64 6c  qlite_busy_handl
5720: 65 72 28 29 3c 2f 62 3e 20 61 72 65 20 74 68 65  er()</b> are the
5730: 20 6f 70 61 71 75 65 0a 73 74 72 75 63 74 75 72   opaque.structur
5740: 65 20 72 65 74 75 72 6e 65 64 20 66 72 6f 6d 20  e returned from 
5750: 3c 62 3e 73 71 6c 69 74 65 5f 6f 70 65 6e 28 29  <b>sqlite_open()
5760: 3c 2f 62 3e 2c 20 61 20 70 6f 69 6e 74 65 72 20  </b>, a pointer 
5770: 74 6f 20 74 68 65 20 62 75 73 79 0a 63 61 6c 6c  to the busy.call
5780: 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 2c 20 61  back function, a
5790: 6e 64 20 61 20 67 65 6e 65 72 69 63 20 70 6f 69  nd a generic poi
57a0: 6e 74 65 72 20 74 68 61 74 20 77 69 6c 6c 20 62  nter that will b
57b0: 65 20 70 61 73 73 65 64 20 61 73 0a 74 68 65 20  e passed as.the 
57c0: 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74  first argument t
57d0: 6f 20 74 68 65 20 62 75 73 79 20 63 61 6c 6c 62  o the busy callb
57e0: 61 63 6b 2e 20 20 57 68 65 6e 20 53 51 4c 69 74  ack.  When SQLit
57f0: 65 20 69 6e 76 6f 6b 65 73 20 74 68 65 0a 62 75  e invokes the.bu
5800: 73 79 20 63 61 6c 6c 62 61 63 6b 2c 20 69 74 20  sy callback, it 
5810: 73 65 6e 64 73 20 69 74 20 74 68 72 65 65 20 61  sends it three a
5820: 72 67 75 6d 65 6e 74 73 3a 20 20 74 68 65 20 67  rguments:  the g
5830: 65 6e 65 72 69 63 20 70 6f 69 6e 74 65 72 0a 74  eneric pointer.t
5840: 68 61 74 20 77 61 73 20 70 61 73 73 65 64 20 69  hat was passed i
5850: 6e 20 61 73 20 74 68 65 20 74 68 69 72 64 20 61  n as the third a
5860: 72 67 75 6d 65 6e 74 20 74 6f 20 3c 62 3e 73 71  rgument to <b>sq
5870: 6c 69 74 65 5f 62 75 73 79 5f 68 61 6e 64 6c 65  lite_busy_handle
5880: 72 3c 2f 62 3e 2c 0a 74 68 65 20 6e 61 6d 65 20  r</b>,.the name 
5890: 6f 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20  of the database 
58a0: 74 61 62 6c 65 20 6f 72 20 69 6e 64 65 78 20 74  table or index t
58b0: 68 61 74 20 74 68 65 20 6c 69 62 72 61 72 79 20  hat the library 
58c0: 69 73 20 74 72 79 69 6e 67 0a 74 6f 20 61 63 63  is trying.to acc
58d0: 65 73 73 2c 20 61 6e 64 20 74 68 65 20 6e 75 6d  ess, and the num
58e0: 62 65 72 20 6f 66 20 74 69 6d 65 73 20 74 68 61  ber of times tha
58f0: 74 20 74 68 65 20 6c 69 62 72 61 72 79 20 68 61  t the library ha
5900: 73 20 61 74 74 65 6d 70 74 65 64 20 74 6f 0a 61  s attempted to.a
5910: 63 63 65 73 73 20 74 68 65 20 64 61 74 61 62 61  ccess the databa
5920: 73 65 20 74 61 62 6c 65 20 6f 72 20 69 6e 64 65  se table or inde
5930: 78 2e 3c 2f 70 3e 0a 0a 3c 70 3e 46 6f 72 20 74  x.</p>..<p>For t
5940: 68 65 20 63 6f 6d 6d 6f 6e 20 63 61 73 65 20 77  he common case w
5950: 68 65 72 65 20 77 65 20 77 61 6e 74 20 74 68 65  here we want the
5960: 20 62 75 73 79 20 63 61 6c 6c 62 61 63 6b 20 74   busy callback t
5970: 6f 20 73 6c 65 65 70 2c 0a 74 68 65 20 53 51 4c  o sleep,.the SQL
5980: 69 74 65 20 6c 69 62 72 61 72 79 20 70 72 6f 76  ite library prov
5990: 69 64 65 73 20 61 20 63 6f 6e 76 65 6e 69 65 6e  ides a convenien
59a0: 63 65 20 72 6f 75 74 69 6e 65 20 3c 62 3e 73 71  ce routine <b>sq
59b0: 6c 69 74 65 5f 62 75 73 79 5f 74 69 6d 65 6f 75  lite_busy_timeou
59c0: 74 28 29 3c 2f 62 3e 2e 0a 54 68 65 20 66 69 72  t()</b>..The fir
59d0: 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 3c  st argument to <
59e0: 62 3e 73 71 6c 69 74 65 5f 62 75 73 79 5f 74 69  b>sqlite_busy_ti
59f0: 6d 65 6f 75 74 28 29 3c 2f 62 3e 20 69 73 20 61  meout()</b> is a
5a00: 20 70 6f 69 6e 74 65 72 20 74 6f 0a 61 6e 20 6f   pointer to.an o
5a10: 70 65 6e 20 53 51 4c 69 74 65 20 64 61 74 61 62  pen SQLite datab
5a20: 61 73 65 20 61 6e 64 20 74 68 65 20 73 65 63 6f  ase and the seco
5a30: 6e 64 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61  nd argument is a
5a40: 20 6e 75 6d 62 65 72 20 6f 66 20 6d 69 6c 6c 69   number of milli
5a50: 73 65 63 6f 6e 64 73 2e 0a 41 66 74 65 72 20 3c  seconds..After <
5a60: 62 3e 73 71 6c 69 74 65 5f 62 75 73 79 5f 74 69  b>sqlite_busy_ti
5a70: 6d 65 6f 75 74 28 29 3c 2f 62 3e 20 68 61 73 20  meout()</b> has 
5a80: 62 65 65 6e 20 65 78 65 63 75 74 65 64 2c 20 74  been executed, t
5a90: 68 65 20 53 51 4c 69 74 65 20 6c 69 62 72 61 72  he SQLite librar
5aa0: 79 0a 77 69 6c 6c 20 77 61 69 74 20 66 6f 72 20  y.will wait for 
5ab0: 74 68 65 20 6c 6f 63 6b 20 74 6f 20 63 6c 65 61  the lock to clea
5ac0: 72 20 66 6f 72 20 61 74 20 6c 65 61 73 74 20 74  r for at least t
5ad0: 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 6d 69 6c  he number of mil
5ae0: 6c 69 73 65 63 6f 6e 64 73 20 0a 73 70 65 63 69  liseconds .speci
5af0: 66 69 65 64 20 62 65 66 6f 72 65 20 69 74 20 72  fied before it r
5b00: 65 74 75 72 6e 73 20 53 51 4c 49 54 45 5f 42 55  eturns SQLITE_BU
5b10: 53 59 2e 20 20 53 70 65 63 69 66 79 69 6e 67 20  SY.  Specifying 
5b20: 7a 65 72 6f 20 6d 69 6c 6c 69 73 65 63 6f 6e 64  zero millisecond
5b30: 73 20 66 6f 72 0a 74 68 65 20 74 69 6d 65 6f 75  s for.the timeou
5b40: 74 20 72 65 73 74 6f 72 65 73 20 74 68 65 20 64  t restores the d
5b50: 65 66 61 75 6c 74 20 62 65 68 61 76 69 6f 72 2e  efault behavior.
5b60: 3c 2f 70 3e 0a 0a 3c 68 32 3e 55 73 69 6e 67 20  </p>..<h2>Using 
5b70: 74 68 65 20 3c 74 74 3e 5f 70 72 69 6e 74 66 28  the <tt>_printf(
5b80: 29 3c 2f 74 74 3e 20 77 72 61 70 70 65 72 20 66  )</tt> wrapper f
5b90: 75 6e 63 74 69 6f 6e 73 3c 2f 68 32 3e 0a 0a 3c  unctions</h2>..<
5ba0: 70 3e 54 68 65 20 66 6f 75 72 20 75 74 69 6c 69  p>The four utili
5bb0: 74 79 20 66 75 6e 63 74 69 6f 6e 73 3c 2f 70 3e  ty functions</p>
5bc0: 0a 0a 3c 70 3e 0a 3c 75 6c 3e 0a 3c 6c 69 3e 3c  ..<p>.<ul>.<li><
5bd0: 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 5f 70 72  b>sqlite_exec_pr
5be0: 69 6e 74 66 28 29 3c 2f 62 3e 3c 2f 6c 69 3e 0a  intf()</b></li>.
5bf0: 3c 6c 69 3e 3c 62 3e 73 71 6c 69 74 65 5f 65 78  <li><b>sqlite_ex
5c00: 65 63 5f 76 70 72 69 6e 74 66 28 29 3c 2f 62 3e  ec_vprintf()</b>
5c10: 3c 2f 6c 69 3e 0a 3c 6c 69 3e 3c 62 3e 73 71 6c  </li>.<li><b>sql
5c20: 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 5f 70 72  ite_get_table_pr
5c30: 69 6e 74 66 28 29 3c 2f 62 3e 3c 2f 6c 69 3e 0a  intf()</b></li>.
5c40: 3c 6c 69 3e 3c 62 3e 73 71 6c 69 74 65 5f 67 65  <li><b>sqlite_ge
5c50: 74 5f 74 61 62 6c 65 5f 76 70 72 69 6e 74 66 28  t_table_vprintf(
5c60: 29 3c 2f 62 3e 3c 2f 6c 69 3e 0a 3c 2f 75 6c 3e  )</b></li>.</ul>
5c70: 0a 3c 2f 70 3e 0a 0a 3c 70 3e 69 6d 70 6c 65 6d  .</p>..<p>implem
5c80: 65 6e 74 20 74 68 65 20 73 61 6d 65 20 71 75 65  ent the same que
5c90: 72 79 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74 79  ry functionality
5ca0: 20 61 73 20 3c 62 3e 73 71 6c 69 74 65 5f 65 78   as <b>sqlite_ex
5cb0: 65 63 28 29 3c 2f 62 3e 0a 61 6e 64 20 3c 62 3e  ec()</b>.and <b>
5cc0: 73 71 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65  sqlite_get_table
5cd0: 28 29 3c 2f 62 3e 2e 20 20 42 75 74 20 69 6e 73  ()</b>.  But ins
5ce0: 74 65 61 64 20 6f 66 20 74 61 6b 69 6e 67 20 61  tead of taking a
5cf0: 20 63 6f 6d 70 6c 65 74 65 0a 53 51 4c 20 73 74   complete.SQL st
5d00: 61 74 65 6d 65 6e 74 20 61 73 20 74 68 65 69 72  atement as their
5d10: 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74   second argument
5d20: 2c 20 74 68 65 20 66 6f 75 72 20 3c 62 3e 5f 70  , the four <b>_p
5d30: 72 69 6e 74 66 3c 2f 62 3e 0a 72 6f 75 74 69 6e  rintf</b>.routin
5d40: 65 73 20 74 61 6b 65 20 61 20 70 72 69 6e 74 66  es take a printf
5d50: 2d 73 74 79 6c 65 20 66 6f 72 6d 61 74 20 73 74  -style format st
5d60: 72 69 6e 67 2e 20 20 54 68 65 20 53 51 4c 20 73  ring.  The SQL s
5d70: 74 61 74 65 6d 65 6e 74 20 74 6f 0a 62 65 20 65  tatement to.be e
5d80: 78 65 63 75 74 65 64 20 69 73 20 67 65 6e 65 72  xecuted is gener
5d90: 61 74 65 64 20 66 72 6f 6d 20 74 68 69 73 20 66  ated from this f
5da0: 6f 72 6d 61 74 20 73 74 72 69 6e 67 20 61 6e 64  ormat string and
5db0: 20 66 72 6f 6d 20 77 68 61 74 65 76 65 72 0a 61   from whatever.a
5dc0: 64 64 69 74 69 6f 6e 61 6c 20 61 72 67 75 6d 65  dditional argume
5dd0: 6e 74 73 20 61 72 65 20 61 74 74 61 63 68 65 64  nts are attached
5de0: 20 74 6f 20 74 68 65 20 65 6e 64 20 6f 66 20 74   to the end of t
5df0: 68 65 20 66 75 6e 63 74 69 6f 6e 20 63 61 6c 6c  he function call
5e00: 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 72 65 20  .</p>..<p>There 
5e10: 61 72 65 20 74 77 6f 20 61 64 76 61 6e 74 61 67  are two advantag
5e20: 65 73 20 74 6f 20 75 73 69 6e 67 20 74 68 65 20  es to using the 
5e30: 53 51 4c 69 74 65 20 70 72 69 6e 74 66 0a 66 75  SQLite printf.fu
5e40: 6e 63 74 69 6f 6e 73 20 69 6e 73 74 65 61 64 20  nctions instead 
5e50: 6f 66 20 3c 62 3e 73 70 72 69 6e 74 66 28 29 3c  of <b>sprintf()<
5e60: 2f 62 3e 2e 20 20 46 69 72 73 74 20 6f 66 20 61  /b>.  First of a
5e70: 6c 6c 2c 20 77 69 74 68 20 74 68 65 0a 53 51 4c  ll, with the.SQL
5e80: 69 74 65 20 70 72 69 6e 74 66 20 72 6f 75 74 69  ite printf routi
5e90: 6e 65 73 2c 20 74 68 65 72 65 20 69 73 20 6e 65  nes, there is ne
5ea0: 76 65 72 20 61 20 64 61 6e 67 65 72 20 6f 66 20  ver a danger of 
5eb0: 6f 76 65 72 66 6c 6f 77 69 6e 67 20 61 0a 73 74  overflowing a.st
5ec0: 61 74 69 63 20 62 75 66 66 65 72 20 61 73 20 74  atic buffer as t
5ed0: 68 65 72 65 20 69 73 20 77 69 74 68 20 3c 62 3e  here is with <b>
5ee0: 73 70 72 69 6e 74 66 28 29 3c 2f 62 3e 2e 20 20  sprintf()</b>.  
5ef0: 54 68 65 20 53 51 4c 69 74 65 0a 70 72 69 6e 74  The SQLite.print
5f00: 66 20 72 6f 75 74 69 6e 65 73 20 61 75 74 6f 6d  f routines autom
5f10: 61 74 69 63 61 6c 6c 79 20 61 6c 6c 6f 63 61 74  atically allocat
5f20: 65 20 28 61 6e 64 20 6c 61 74 65 72 20 66 72 65  e (and later fre
5f30: 65 73 29 0a 61 73 20 6d 75 63 68 20 6d 65 6d 6f  es).as much memo
5f40: 72 79 20 61 73 20 69 73 20 0a 6e 65 63 65 73 73  ry as is .necess
5f50: 61 72 79 20 74 6f 20 68 6f 6c 64 20 74 68 65 20  ary to hold the 
5f60: 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 20 67  SQL statements g
5f70: 65 6e 65 72 61 74 65 64 2e 3c 2f 70 3e 0a 0a 3c  enerated.</p>..<
5f80: 70 3e 54 68 65 20 73 65 63 6f 6e 64 20 61 64 76  p>The second adv
5f90: 61 6e 74 61 67 65 20 74 68 65 20 53 51 4c 69 74  antage the SQLit
5fa0: 65 20 70 72 69 6e 74 66 20 72 6f 75 74 69 6e 65  e printf routine
5fb0: 73 20 68 61 76 65 20 6f 76 65 72 0a 3c 62 3e 73  s have over.<b>s
5fc0: 70 72 69 6e 74 66 28 29 3c 2f 62 3e 20 61 72 65  printf()</b> are
5fd0: 20 74 77 6f 20 6e 65 77 20 66 6f 72 6d 61 74 74   two new formatt
5fe0: 69 6e 67 20 6f 70 74 69 6f 6e 73 20 73 70 65 63  ing options spec
5ff0: 69 66 69 63 61 6c 6c 79 20 64 65 73 69 67 6e 65  ifically designe
6000: 64 0a 74 6f 20 73 75 70 70 6f 72 74 20 73 74 72  d.to support str
6010: 69 6e 67 20 6c 69 74 65 72 61 6c 73 20 69 6e 20  ing literals in 
6020: 53 51 4c 2e 20 20 57 69 74 68 69 6e 20 74 68 65  SQL.  Within the
6030: 20 66 6f 72 6d 61 74 20 73 74 72 69 6e 67 2c 0a   format string,.
6040: 74 68 65 20 25 71 20 66 6f 72 6d 61 74 74 69 6e  the %q formattin
6050: 67 20 6f 70 74 69 6f 6e 20 77 6f 72 6b 73 20 76  g option works v
6060: 65 72 79 20 6d 75 63 68 20 6c 69 6b 65 20 25 73  ery much like %s
6070: 20 69 6e 20 74 68 61 74 20 69 74 0a 72 65 61 64   in that it.read
6080: 73 20 61 20 6e 75 6c 6c 2d 74 65 72 6d 69 6e 61  s a null-termina
6090: 74 65 64 20 73 74 72 69 6e 67 20 66 72 6f 6d 20  ted string from 
60a0: 74 68 65 20 61 72 67 75 6d 65 6e 74 20 6c 69 73  the argument lis
60b0: 74 20 61 6e 64 20 69 6e 73 65 72 74 73 0a 69 74  t and inserts.it
60c0: 20 69 6e 74 6f 20 74 68 65 20 72 65 73 75 6c 74   into the result
60d0: 2e 20 20 42 75 74 20 25 71 20 74 72 61 6e 73 6c  .  But %q transl
60e0: 61 74 65 73 20 74 68 65 20 69 6e 73 65 72 74 65  ates the inserte
60f0: 64 20 73 74 72 69 6e 67 20 62 79 0a 6d 61 6b 69  d string by.maki
6100: 6e 67 20 74 77 6f 20 63 6f 70 69 65 73 20 6f 66  ng two copies of
6110: 20 65 76 65 72 79 20 73 69 6e 67 6c 65 2d 71 75   every single-qu
6120: 6f 74 65 20 28 27 29 20 63 68 61 72 61 63 74 65  ote (') characte
6130: 72 20 69 6e 20 74 68 65 0a 73 75 62 73 74 69 74  r in the.substit
6140: 75 74 65 64 20 73 74 72 69 6e 67 2e 20 20 54 68  uted string.  Th
6150: 69 73 20 68 61 73 20 74 68 65 20 65 66 66 65 63  is has the effec
6160: 74 20 6f 66 20 65 73 63 61 70 69 6e 67 20 74 68  t of escaping th
6170: 65 20 65 6e 64 2d 6f 66 2d 73 74 72 69 6e 67 0a  e end-of-string.
6180: 6d 65 61 6e 69 6e 67 20 6f 66 20 73 69 6e 67 6c  meaning of singl
6190: 65 2d 71 75 6f 74 65 20 77 69 74 68 69 6e 20 61  e-quote within a
61a0: 20 73 74 72 69 6e 67 20 6c 69 74 65 72 61 6c 2e   string literal.
61b0: 20 54 68 65 20 25 51 20 66 6f 72 6d 61 74 74 69   The %Q formatti
61c0: 6e 67 0a 6f 70 74 69 6f 6e 20 77 6f 72 6b 73 20  ng.option works 
61d0: 73 69 6d 69 6c 61 72 3b 20 69 74 20 74 72 61 6e  similar; it tran
61e0: 73 6c 61 74 65 73 20 74 68 65 20 73 69 6e 67 6c  slates the singl
61f0: 65 2d 71 75 6f 74 65 73 20 6c 69 6b 65 20 25 71  e-quotes like %q
6200: 20 61 6e 64 0a 61 64 64 69 74 69 6f 6e 61 6c 6c   and.additionall
6210: 79 20 65 6e 63 6c 6f 73 65 73 20 74 68 65 20 72  y encloses the r
6220: 65 73 75 6c 74 69 6e 67 20 73 74 72 69 6e 67 20  esulting string 
6230: 69 6e 20 73 69 6e 67 6c 65 2d 71 75 6f 74 65 73  in single-quotes
6240: 2e 0a 49 66 20 74 68 65 20 61 72 67 75 6d 65 6e  ..If the argumen
6250: 74 20 66 6f 72 20 74 68 65 20 25 51 20 66 6f 72  t for the %Q for
6260: 6d 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e 73 20  matting options 
6270: 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  is a NULL pointe
6280: 72 2c 0a 74 68 65 20 72 65 73 75 6c 74 69 6e 67  r,.the resulting
6290: 20 73 74 72 69 6e 67 20 69 73 20 4e 55 4c 4c 20   string is NULL 
62a0: 77 69 74 68 6f 75 74 20 73 69 6e 67 6c 65 20 71  without single q
62b0: 75 6f 74 65 73 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e  uotes..</p>..<p>
62c0: 43 6f 6e 73 69 64 65 72 20 61 6e 20 65 78 61 6d  Consider an exam
62d0: 70 6c 65 2e 20 20 53 75 70 70 6f 73 65 20 79 6f  ple.  Suppose yo
62e0: 75 20 61 72 65 20 74 72 79 69 6e 67 20 74 6f 20  u are trying to 
62f0: 69 6e 73 65 72 74 20 61 20 73 74 72 69 6e 67 0a  insert a string.
6300: 76 61 6c 75 65 20 69 6e 74 6f 20 61 20 64 61 74  value into a dat
6310: 61 62 61 73 65 20 74 61 62 6c 65 20 77 68 65 72  abase table wher
6320: 65 20 74 68 65 20 73 74 72 69 6e 67 20 76 61 6c  e the string val
6330: 75 65 20 77 61 73 20 6f 62 74 61 69 6e 65 64 20  ue was obtained 
6340: 66 72 6f 6d 0a 75 73 65 72 20 69 6e 70 75 74 2e  from.user input.
6350: 20 20 53 75 70 70 6f 73 65 20 74 68 65 20 73 74    Suppose the st
6360: 72 69 6e 67 20 74 6f 20 62 65 20 69 6e 73 65 72  ring to be inser
6370: 74 65 64 20 69 73 20 73 74 6f 72 65 64 20 69 6e  ted is stored in
6380: 20 61 20 76 61 72 69 61 62 6c 65 0a 6e 61 6d 65   a variable.name
6390: 64 20 7a 53 74 72 69 6e 67 2e 20 20 54 68 65 20  d zString.  The 
63a0: 63 6f 64 65 20 74 6f 20 64 6f 20 74 68 65 20 69  code to do the i
63b0: 6e 73 65 72 74 69 6f 6e 20 6d 69 67 68 74 20 6c  nsertion might l
63c0: 6f 6f 6b 20 6c 69 6b 65 20 74 68 69 73 3a 3c 2f  ook like this:</
63d0: 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e  p>..<blockquote>
63e0: 3c 70 72 65 3e 0a 73 71 6c 69 74 65 5f 65 78 65  <pre>.sqlite_exe
63f0: 63 5f 70 72 69 6e 74 66 28 64 62 2c 0a 20 20 22  c_printf(db,.  "
6400: 49 4e 53 45 52 54 20 49 4e 54 4f 20 74 61 62 6c  INSERT INTO tabl
6410: 65 31 20 56 41 4c 55 45 53 28 27 25 73 27 29 22  e1 VALUES('%s')"
6420: 2c 0a 20 20 30 2c 20 30 2c 20 30 2c 20 7a 53 74  ,.  0, 0, 0, zSt
6430: 72 69 6e 67 29 3b 0a 3c 2f 70 72 65 3e 3c 2f 62  ring);.</pre></b
6440: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 49  lockquote>..<p>I
6450: 66 20 74 68 65 20 7a 53 74 72 69 6e 67 20 76 61  f the zString va
6460: 72 69 61 62 6c 65 20 68 6f 6c 64 73 20 74 65 78  riable holds tex
6470: 74 20 6c 69 6b 65 20 22 48 65 6c 6c 6f 22 2c 20  t like "Hello", 
6480: 74 68 65 6e 20 74 68 69 73 20 73 74 61 74 65 6d  then this statem
6490: 65 6e 74 0a 77 69 6c 6c 20 77 6f 72 6b 20 6a 75  ent.will work ju
64a0: 73 74 20 66 69 6e 65 2e 20 20 42 75 74 20 73 75  st fine.  But su
64b0: 70 70 6f 73 65 20 74 68 65 20 75 73 65 72 20 65  ppose the user e
64c0: 6e 74 65 72 73 20 61 20 73 74 72 69 6e 67 20 6c  nters a string l
64d0: 69 6b 65 20 0a 22 48 69 20 79 27 61 6c 6c 21 22  ike ."Hi y'all!"
64e0: 2e 20 20 54 68 65 20 53 51 4c 20 73 74 61 74 65  .  The SQL state
64f0: 6d 65 6e 74 20 67 65 6e 65 72 61 74 65 64 20 72  ment generated r
6500: 65 61 64 73 20 61 73 20 66 6f 6c 6c 6f 77 73 3a  eads as follows:
6510: 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70  ..<blockquote><p
6520: 72 65 3e 0a 49 4e 53 45 52 54 20 49 4e 54 4f 20  re>.INSERT INTO 
6530: 74 61 62 6c 65 31 20 56 41 4c 55 45 53 28 27 48  table1 VALUES('H
6540: 69 20 79 27 61 6c 6c 27 29 0a 3c 2f 70 72 65 3e  i y'all').</pre>
6550: 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c  </blockquote>..<
6560: 70 3e 54 68 69 73 20 69 73 20 6e 6f 74 20 76 61  p>This is not va
6570: 6c 69 64 20 53 51 4c 20 62 65 63 61 75 73 65 20  lid SQL because 
6580: 6f 66 20 74 68 65 20 61 70 6f 73 74 72 6f 70 68  of the apostroph
6590: 79 20 69 6e 20 74 68 65 20 77 6f 72 64 20 22 79  y in the word "y
65a0: 27 61 6c 6c 22 2e 0a 42 75 74 20 69 66 20 74 68  'all"..But if th
65b0: 65 20 25 71 20 66 6f 72 6d 61 74 74 69 6e 67 20  e %q formatting 
65c0: 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 20 69  option is used i
65d0: 6e 73 74 65 61 64 20 6f 66 20 25 73 2c 20 6c 69  nstead of %s, li
65e0: 6b 65 20 74 68 69 73 3a 3c 2f 70 3e 0a 0a 3c 62  ke this:</p>..<b
65f0: 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a  lockquote><pre>.
6600: 73 71 6c 69 74 65 5f 65 78 65 63 5f 70 72 69 6e  sqlite_exec_prin
6610: 74 66 28 64 62 2c 0a 20 20 22 49 4e 53 45 52 54  tf(db,.  "INSERT
6620: 20 49 4e 54 4f 20 74 61 62 6c 65 31 20 56 41 4c   INTO table1 VAL
6630: 55 45 53 28 27 25 71 27 29 22 2c 0a 20 20 30 2c  UES('%q')",.  0,
6640: 20 30 2c 20 30 2c 20 7a 53 74 72 69 6e 67 29 3b   0, 0, zString);
6650: 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75  .</pre></blockqu
6660: 6f 74 65 3e 0a 0a 3c 70 3e 54 68 65 6e 20 74 68  ote>..<p>Then th
6670: 65 20 67 65 6e 65 72 61 74 65 64 20 53 51 4c 20  e generated SQL 
6680: 77 69 6c 6c 20 6c 6f 6f 6b 20 6c 69 6b 65 20 74  will look like t
6690: 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 3a 3c 2f 70  he following:</p
66a0: 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c  >..<blockquote><
66b0: 70 72 65 3e 0a 49 4e 53 45 52 54 20 49 4e 54 4f  pre>.INSERT INTO
66c0: 20 74 61 62 6c 65 31 20 56 41 4c 55 45 53 28 27   table1 VALUES('
66d0: 48 69 20 79 27 27 61 6c 6c 27 29 0a 3c 2f 70 72  Hi y''all').</pr
66e0: 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  e></blockquote>.
66f0: 0a 3c 70 3e 48 65 72 65 20 74 68 65 20 61 70 6f  .<p>Here the apo
6700: 73 74 72 6f 70 68 79 20 68 61 73 20 62 65 65 6e  strophy has been
6710: 20 65 73 63 61 70 65 64 20 61 6e 64 20 74 68 65   escaped and the
6720: 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 69   SQL statement i
6730: 73 20 77 65 6c 6c 2d 66 6f 72 6d 65 64 2e 0a 57  s well-formed..W
6740: 68 65 6e 20 67 65 6e 65 72 61 74 69 6e 67 20 53  hen generating S
6750: 51 4c 20 6f 6e 2d 74 68 65 2d 66 6c 79 20 66 72  QL on-the-fly fr
6760: 6f 6d 20 64 61 74 61 20 74 68 61 74 20 6d 69 67  om data that mig
6770: 68 74 20 63 6f 6e 74 61 69 6e 20 61 0a 73 69 6e  ht contain a.sin
6780: 67 6c 65 2d 71 75 6f 74 65 20 63 68 61 72 61 63  gle-quote charac
6790: 74 65 72 20 28 27 29 2c 20 69 74 20 69 73 20 61  ter ('), it is a
67a0: 6c 77 61 79 73 20 61 20 67 6f 6f 64 20 69 64 65  lways a good ide
67b0: 61 20 74 6f 20 75 73 65 20 74 68 65 0a 53 51 4c  a to use the.SQL
67c0: 69 74 65 20 70 72 69 6e 74 66 20 72 6f 75 74 69  ite printf routi
67d0: 6e 65 73 20 61 6e 64 20 74 68 65 20 25 71 20 66  nes and the %q f
67e0: 6f 72 6d 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e  ormatting option
67f0: 20 69 6e 73 74 65 61 64 20 6f 66 20 3c 62 3e 73   instead of <b>s
6800: 70 72 69 6e 74 66 3c 2f 62 3e 2e 0a 3c 2f 70 3e  printf</b>..</p>
6810: 0a 0a 3c 70 3e 49 66 20 74 68 65 20 25 51 20 66  ..<p>If the %Q f
6820: 6f 72 6d 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e  ormatting option
6830: 20 69 73 20 75 73 65 64 20 69 6e 73 74 65 61 64   is used instead
6840: 20 6f 66 20 25 71 2c 20 6c 69 6b 65 20 74 68 69   of %q, like thi
6850: 73 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75  s:</p>..<blockqu
6860: 6f 74 65 3e 3c 70 72 65 3e 0a 73 71 6c 69 74 65  ote><pre>.sqlite
6870: 5f 65 78 65 63 5f 70 72 69 6e 74 66 28 64 62 2c  _exec_printf(db,
6880: 0a 20 20 22 49 4e 53 45 52 54 20 49 4e 54 4f 20  .  "INSERT INTO 
6890: 74 61 62 6c 65 31 20 56 41 4c 55 45 53 28 25 51  table1 VALUES(%Q
68a0: 29 22 2c 0a 20 20 30 2c 20 30 2c 20 30 2c 20 7a  )",.  0, 0, 0, z
68b0: 53 74 72 69 6e 67 29 3b 0a 3c 2f 70 72 65 3e 3c  String);.</pre><
68c0: 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70  /blockquote>..<p
68d0: 3e 54 68 65 6e 20 74 68 65 20 67 65 6e 65 72 61  >Then the genera
68e0: 74 65 64 20 53 51 4c 20 77 69 6c 6c 20 6c 6f 6f  ted SQL will loo
68f0: 6b 20 6c 69 6b 65 20 74 68 65 20 66 6f 6c 6c 6f  k like the follo
6900: 77 69 6e 67 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63  wing:</p>..<bloc
6910: 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 49 4e 53  kquote><pre>.INS
6920: 45 52 54 20 49 4e 54 4f 20 74 61 62 6c 65 31 20  ERT INTO table1 
6930: 56 41 4c 55 45 53 28 27 48 69 20 79 27 27 61 6c  VALUES('Hi y''al
6940: 6c 27 29 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63  l').</pre></bloc
6950: 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 49 66 20 74  kquote>..<p>If t
6960: 68 65 20 76 61 6c 75 65 20 6f 66 20 74 68 65 20  he value of the 
6970: 7a 53 74 72 69 6e 67 20 76 61 72 69 61 62 6c 65  zString variable
6980: 20 69 73 20 4e 55 4c 4c 2c 20 74 68 65 20 67 65   is NULL, the ge
6990: 6e 65 72 61 74 65 64 20 53 51 4c 0a 77 69 6c 6c  nerated SQL.will
69a0: 20 6c 6f 6f 6b 20 6c 69 6b 65 20 74 68 65 20 66   look like the f
69b0: 6f 6c 6c 6f 77 69 6e 67 3a 3c 2f 70 3e 0a 0a 3c  ollowing:</p>..<
69c0: 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e  blockquote><pre>
69d0: 0a 49 4e 53 45 52 54 20 49 4e 54 4f 20 74 61 62  .INSERT INTO tab
69e0: 6c 65 31 20 56 41 4c 55 45 53 28 4e 55 4c 4c 29  le1 VALUES(NULL)
69f0: 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75  .</pre></blockqu
6a00: 6f 74 65 3e 0a 0a 3c 70 3e 41 6c 6c 20 6f 66 20  ote>..<p>All of 
6a10: 74 68 65 20 5f 70 72 69 6e 74 66 28 29 20 72 6f  the _printf() ro
6a20: 75 74 69 6e 65 73 20 61 62 6f 76 65 20 61 72 65  utines above are
6a30: 20 62 75 69 6c 74 20 61 72 6f 75 6e 64 20 74 68   built around th
6a40: 65 20 66 6f 6c 6c 6f 77 69 6e 67 0a 74 77 6f 20  e following.two 
6a50: 66 75 6e 63 74 69 6f 6e 73 3a 3c 2f 70 3e 0a 0a  functions:</p>..
6a60: 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65  <blockquote><pre
6a70: 3e 0a 63 68 61 72 20 2a 73 71 6c 69 74 65 5f 6d  >.char *sqlite_m
6a80: 70 72 69 6e 74 66 28 63 6f 6e 73 74 20 63 68 61  printf(const cha
6a90: 72 20 2a 7a 46 6f 72 6d 61 74 2c 20 2e 2e 2e 29  r *zFormat, ...)
6aa0: 3b 0a 63 68 61 72 20 2a 73 71 6c 69 74 65 5f 76  ;.char *sqlite_v
6ab0: 6d 70 72 69 6e 74 66 28 63 6f 6e 73 74 20 63 68  mprintf(const ch
6ac0: 61 72 20 2a 7a 46 6f 72 6d 61 74 2c 20 76 61 5f  ar *zFormat, va_
6ad0: 6c 69 73 74 29 3b 0a 3c 2f 70 72 65 3e 3c 2f 62  list);.</pre></b
6ae0: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 54  lockquote>..<p>T
6af0: 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 6d 70 72  he <b>sqlite_mpr
6b00: 69 6e 74 66 28 29 3c 2f 62 3e 20 72 6f 75 74 69  intf()</b> routi
6b10: 6e 65 20 77 6f 72 6b 73 20 6c 69 6b 65 20 74 68  ne works like th
6b20: 65 20 74 68 65 20 73 74 61 6e 64 61 72 64 20 6c  e the standard l
6b30: 69 62 72 61 72 79 0a 3c 62 3e 73 70 72 69 6e 74  ibrary.<b>sprint
6b40: 66 28 29 3c 2f 62 3e 20 65 78 63 65 70 74 20 74  f()</b> except t
6b50: 68 61 74 20 69 74 20 77 72 69 74 65 73 20 69 74  hat it writes it
6b60: 73 20 72 65 73 75 6c 74 73 20 69 6e 74 6f 20 6d  s results into m
6b70: 65 6d 6f 72 79 20 6f 62 74 61 69 6e 65 64 0a 66  emory obtained.f
6b80: 72 6f 6d 20 6d 61 6c 6c 6f 63 28 29 20 61 6e 64  rom malloc() and
6b90: 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69 6e 74   returns a point
6ba0: 65 72 20 74 6f 20 74 68 65 20 6d 61 6c 6c 6f 63  er to the malloc
6bb0: 65 64 20 62 75 66 66 65 72 2e 20 20 0a 3c 62 3e  ed buffer.  .<b>
6bc0: 73 71 6c 69 74 65 5f 6d 70 72 69 6e 74 66 28 29  sqlite_mprintf()
6bd0: 3c 2f 62 3e 20 61 6c 73 6f 20 75 6e 64 65 72 73  </b> also unders
6be0: 74 61 6e 64 73 20 74 68 65 20 25 71 20 61 6e 64  tands the %q and
6bf0: 20 25 51 20 65 78 74 65 6e 73 69 6f 6e 73 20 64   %Q extensions d
6c00: 65 73 63 72 69 62 65 64 0a 61 62 6f 76 65 2e 20  escribed.above. 
6c10: 20 54 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 76   The <b>sqlite_v
6c20: 6d 70 72 69 6e 74 66 28 29 3c 2f 62 3e 20 69 73  mprintf()</b> is
6c30: 20 61 20 76 61 72 61 72 67 73 20 76 65 72 73 69   a varargs versi
6c40: 6f 6e 20 6f 66 20 74 68 65 20 73 61 6d 65 0a 72  on of the same.r
6c50: 6f 75 74 69 6e 65 2e 20 20 54 68 65 20 73 74 72  outine.  The str
6c60: 69 6e 67 20 70 6f 69 6e 74 65 72 20 74 68 61 74  ing pointer that
6c70: 20 74 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20   these routines 
6c80: 72 65 74 75 72 6e 20 73 68 6f 75 6c 64 20 62 65  return should be
6c90: 20 66 72 65 65 64 0a 62 79 20 70 61 73 73 69 6e   freed.by passin
6ca0: 67 20 69 74 20 74 6f 20 3c 62 3e 73 71 6c 69 74  g it to <b>sqlit
6cb0: 65 5f 66 72 65 65 6d 65 6d 28 29 3c 2f 62 3e 2e  e_freemem()</b>.
6cc0: 0a 3c 2f 70 3e 0a 0a 3c 61 20 6e 61 6d 65 3d 22  .</p>..<a name="
6cd0: 63 66 75 6e 63 22 3e 0a 3c 68 32 3e 41 64 64 69  cfunc">.<h2>Addi
6ce0: 6e 67 20 4e 65 77 20 53 51 4c 20 46 75 6e 63 74  ng New SQL Funct
6cf0: 69 6f 6e 73 3c 2f 68 32 3e 0a 0a 3c 70 3e 42 65  ions</h2>..<p>Be
6d00: 67 69 6e 6e 69 6e 67 20 77 69 74 68 20 76 65 72  ginning with ver
6d10: 73 69 6f 6e 20 32 2e 34 2e 30 2c 20 53 51 4c 69  sion 2.4.0, SQLi
6d20: 74 65 20 61 6c 6c 6f 77 73 20 74 68 65 20 53 51  te allows the SQ
6d30: 4c 20 6c 61 6e 67 75 61 67 65 20 74 6f 20 62 65  L language to be
6d40: 0a 65 78 74 65 6e 64 65 64 20 77 69 74 68 20 6e  .extended with n
6d50: 65 77 20 66 75 6e 63 74 69 6f 6e 73 20 69 6d 70  ew functions imp
6d60: 6c 65 6d 65 6e 74 65 64 20 61 73 20 43 20 63 6f  lemented as C co
6d70: 64 65 2e 20 20 54 68 65 20 66 6f 6c 6c 6f 77 69  de.  The followi
6d80: 6e 67 20 69 6e 74 65 72 66 61 63 65 0a 69 73 20  ng interface.is 
6d90: 75 73 65 64 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f  used:.</p>..<blo
6da0: 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 74 79  ckquote><pre>.ty
6db0: 70 65 64 65 66 20 73 74 72 75 63 74 20 73 71 6c  pedef struct sql
6dc0: 69 74 65 5f 66 75 6e 63 20 73 71 6c 69 74 65 5f  ite_func sqlite_
6dd0: 66 75 6e 63 3b 0a 0a 69 6e 74 20 73 71 6c 69 74  func;..int sqlit
6de0: 65 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f  e_create_functio
6df0: 6e 28 0a 20 20 73 71 6c 69 74 65 20 2a 64 62 2c  n(.  sqlite *db,
6e00: 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a  .  const char *z
6e10: 4e 61 6d 65 2c 0a 20 20 69 6e 74 20 6e 41 72 67  Name,.  int nArg
6e20: 2c 0a 20 20 76 6f 69 64 20 28 2a 78 46 75 6e 63  ,.  void (*xFunc
6e30: 29 28 73 71 6c 69 74 65 5f 66 75 6e 63 2a 2c 69  )(sqlite_func*,i
6e40: 6e 74 2c 63 6f 6e 73 74 20 63 68 61 72 2a 2a 29  nt,const char**)
6e50: 2c 0a 20 20 76 6f 69 64 20 2a 70 55 73 65 72 44  ,.  void *pUserD
6e60: 61 74 61 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74  ata.);.int sqlit
6e70: 65 5f 63 72 65 61 74 65 5f 61 67 67 72 65 67 61  e_create_aggrega
6e80: 74 65 28 0a 20 20 73 71 6c 69 74 65 20 2a 64 62  te(.  sqlite *db
6e90: 2c 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a  ,.  const char *
6ea0: 7a 4e 61 6d 65 2c 0a 20 20 69 6e 74 20 6e 41 72  zName,.  int nAr
6eb0: 67 2c 0a 20 20 76 6f 69 64 20 28 2a 78 53 74 65  g,.  void (*xSte
6ec0: 70 29 28 73 71 6c 69 74 65 5f 66 75 6e 63 2a 2c  p)(sqlite_func*,
6ed0: 69 6e 74 2c 63 6f 6e 73 74 20 63 68 61 72 2a 2a  int,const char**
6ee0: 29 2c 0a 20 20 76 6f 69 64 20 28 2a 78 46 69 6e  ),.  void (*xFin
6ef0: 61 6c 69 7a 65 29 28 73 71 6c 69 74 65 5f 66 75  alize)(sqlite_fu
6f00: 6e 63 2a 29 2c 0a 20 20 76 6f 69 64 20 2a 70 55  nc*),.  void *pU
6f10: 73 65 72 44 61 74 61 0a 29 3b 0a 0a 63 68 61 72  serData.);..char
6f20: 20 2a 73 71 6c 69 74 65 5f 73 65 74 5f 72 65 73   *sqlite_set_res
6f30: 75 6c 74 5f 73 74 72 69 6e 67 28 73 71 6c 69 74  ult_string(sqlit
6f40: 65 5f 66 75 6e 63 2a 2c 63 6f 6e 73 74 20 63 68  e_func*,const ch
6f50: 61 72 2a 2c 69 6e 74 29 3b 0a 76 6f 69 64 20 73  ar*,int);.void s
6f60: 71 6c 69 74 65 5f 73 65 74 5f 72 65 73 75 6c 74  qlite_set_result
6f70: 5f 69 6e 74 28 73 71 6c 69 74 65 5f 66 75 6e 63  _int(sqlite_func
6f80: 2a 2c 69 6e 74 29 3b 0a 76 6f 69 64 20 73 71 6c  *,int);.void sql
6f90: 69 74 65 5f 73 65 74 5f 72 65 73 75 6c 74 5f 64  ite_set_result_d
6fa0: 6f 75 62 6c 65 28 73 71 6c 69 74 65 5f 66 75 6e  ouble(sqlite_fun
6fb0: 63 2a 2c 64 6f 75 62 6c 65 29 3b 0a 76 6f 69 64  c*,double);.void
6fc0: 20 73 71 6c 69 74 65 5f 73 65 74 5f 72 65 73 75   sqlite_set_resu
6fd0: 6c 74 5f 65 72 72 6f 72 28 73 71 6c 69 74 65 5f  lt_error(sqlite_
6fe0: 66 75 6e 63 2a 2c 63 6f 6e 73 74 20 63 68 61 72  func*,const char
6ff0: 2a 2c 69 6e 74 29 3b 0a 0a 76 6f 69 64 20 2a 73  *,int);..void *s
7000: 71 6c 69 74 65 5f 75 73 65 72 5f 64 61 74 61 28  qlite_user_data(
7010: 73 71 6c 69 74 65 5f 66 75 6e 63 2a 29 3b 0a 76  sqlite_func*);.v
7020: 6f 69 64 20 2a 73 71 6c 69 74 65 5f 61 67 67 72  oid *sqlite_aggr
7030: 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28 73 71  egate_context(sq
7040: 6c 69 74 65 5f 66 75 6e 63 2a 2c 20 69 6e 74 20  lite_func*, int 
7050: 6e 42 79 74 65 73 29 3b 0a 69 6e 74 20 73 71 6c  nBytes);.int sql
7060: 69 74 65 5f 61 67 67 72 65 67 61 74 65 5f 63 6f  ite_aggregate_co
7070: 75 6e 74 28 73 71 6c 69 74 65 5f 66 75 6e 63 2a  unt(sqlite_func*
7080: 29 3b 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b  );.</pre></block
7090: 71 75 6f 74 65 3e 0a 0a 3c 70 3e 0a 54 68 65 20  quote>..<p>.The 
70a0: 3c 62 3e 73 71 6c 69 74 65 5f 63 72 65 61 74 65  <b>sqlite_create
70b0: 5f 66 75 6e 63 74 69 6f 6e 28 29 3c 2f 62 3e 20  _function()</b> 
70c0: 69 6e 74 65 72 66 61 63 65 20 69 73 20 75 73 65  interface is use
70d0: 64 20 74 6f 20 63 72 65 61 74 65 20 0a 72 65 67  d to create .reg
70e0: 75 6c 61 72 20 66 75 6e 63 74 69 6f 6e 73 20 61  ular functions a
70f0: 6e 64 20 3c 62 3e 73 71 6c 69 74 65 5f 63 72 65  nd <b>sqlite_cre
7100: 61 74 65 5f 61 67 67 72 65 67 61 74 65 28 29 3c  ate_aggregate()<
7110: 2f 62 3e 20 69 73 20 75 73 65 64 20 74 6f 0a 63  /b> is used to.c
7120: 72 65 61 74 65 20 6e 65 77 20 61 67 67 72 65 67  reate new aggreg
7130: 61 74 65 20 66 75 6e 63 74 69 6f 6e 73 2e 20 20  ate functions.  
7140: 49 6e 20 62 6f 74 68 20 63 61 73 65 73 2c 20 74  In both cases, t
7150: 68 65 20 3c 62 3e 64 62 3c 2f 62 3e 0a 70 61 72  he <b>db</b>.par
7160: 61 6d 65 74 65 72 20 69 73 20 61 6e 20 6f 70 65  ameter is an ope
7170: 6e 20 53 51 4c 69 74 65 20 64 61 74 61 62 61 73  n SQLite databas
7180: 65 20 6f 6e 20 77 68 69 63 68 20 74 68 65 20 66  e on which the f
7190: 75 6e 63 74 69 6f 6e 73 20 73 68 6f 75 6c 64 0a  unctions should.
71a0: 62 65 20 72 65 67 69 73 74 65 72 65 64 2c 20 3c  be registered, <
71b0: 62 3e 7a 4e 61 6d 65 3c 2f 62 3e 20 69 73 20 74  b>zName</b> is t
71c0: 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 6e  he name of the n
71d0: 65 77 20 66 75 6e 63 74 69 6f 6e 2c 0a 3c 62 3e  ew function,.<b>
71e0: 6e 41 72 67 3c 2f 62 3e 20 69 73 20 74 68 65 20  nArg</b> is the 
71f0: 6e 75 6d 62 65 72 20 6f 66 20 61 72 67 75 6d 65  number of argume
7200: 6e 74 73 2c 20 61 6e 64 20 3c 62 3e 70 55 73 65  nts, and <b>pUse
7210: 72 44 61 74 61 3c 2f 62 3e 20 69 73 0a 61 20 70  rData</b> is.a p
7220: 6f 69 6e 74 65 72 20 77 68 69 63 68 20 69 73 20  ointer which is 
7230: 70 61 73 73 65 64 20 74 68 72 6f 75 67 68 20 75  passed through u
7240: 6e 63 68 61 6e 67 65 64 20 74 6f 20 74 68 65 20  nchanged to the 
7250: 43 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  C implementation
7260: 0a 6f 66 20 74 68 65 20 66 75 6e 63 74 69 6f 6e  .of the function
7270: 2e 20 20 42 6f 74 68 20 72 6f 75 74 69 6e 65 73  .  Both routines
7280: 20 72 65 74 75 72 6e 20 30 20 6f 6e 20 73 75 63   return 0 on suc
7290: 63 65 73 73 20 61 6e 64 20 6e 6f 6e 2d 7a 65 72  cess and non-zer
72a0: 6f 0a 69 66 20 74 68 65 72 65 20 61 72 65 20 61  o.if there are a
72b0: 6e 79 20 65 72 72 6f 72 73 2e 0a 3c 2f 70 3e 0a  ny errors..</p>.
72c0: 0a 3c 70 3e 0a 54 68 65 20 6c 65 6e 67 74 68 20  .<p>.The length 
72d0: 6f 66 20 61 20 66 75 6e 63 74 69 6f 6e 20 6e 61  of a function na
72e0: 6d 65 20 6d 61 79 20 6e 6f 74 20 65 78 63 65 65  me may not excee
72f0: 64 20 32 35 35 20 63 68 61 72 61 63 74 65 72 73  d 255 characters
7300: 2e 0a 41 6e 79 20 61 74 74 65 6d 70 74 20 74 6f  ..Any attempt to
7310: 20 63 72 65 61 74 65 20 61 20 66 75 6e 63 74 69   create a functi
7320: 6f 6e 20 77 68 6f 73 65 20 6e 61 6d 65 20 65 78  on whose name ex
7330: 63 65 65 64 73 20 32 35 35 20 63 68 61 72 61 63  ceeds 255 charac
7340: 74 65 72 73 0a 69 6e 20 6c 65 6e 67 74 68 20 77  ters.in length w
7350: 69 6c 6c 20 72 65 73 75 6c 74 20 69 6e 20 61 6e  ill result in an
7360: 20 65 72 72 6f 72 2e 0a 3c 2f 70 3e 0a 0a 3c 70   error..</p>..<p
7370: 3e 0a 46 6f 72 20 72 65 67 75 6c 61 72 20 66 75  >.For regular fu
7380: 6e 63 74 69 6f 6e 73 2c 20 74 68 65 20 3c 62 3e  nctions, the <b>
7390: 78 46 75 6e 63 3c 2f 62 3e 20 63 61 6c 6c 62 61  xFunc</b> callba
73a0: 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20 6f 6e  ck is invoked on
73b0: 63 65 0a 66 6f 72 20 65 61 63 68 20 66 75 6e 63  ce.for each func
73c0: 74 69 6f 6e 20 63 61 6c 6c 2e 20 20 54 68 65 20  tion call.  The 
73d0: 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 6f  implementation o
73e0: 66 20 78 46 75 6e 63 20 73 68 6f 75 6c 64 20 63  f xFunc should c
73f0: 61 6c 6c 0a 6f 6e 65 20 6f 66 20 74 68 65 20 3c  all.one of the <
7400: 62 3e 73 71 6c 69 74 65 5f 73 65 74 5f 72 65 73  b>sqlite_set_res
7410: 75 6c 74 5f 2e 2e 2e 3c 2f 62 3e 20 69 6e 74 65  ult_...</b> inte
7420: 72 66 61 63 65 73 20 74 6f 20 72 65 74 75 72 6e  rfaces to return
7430: 20 69 74 73 0a 72 65 73 75 6c 74 2e 20 20 54 68   its.result.  Th
7440: 65 20 3c 62 3e 73 71 6c 69 74 65 5f 75 73 65 72  e <b>sqlite_user
7450: 5f 64 61 74 61 28 29 3c 2f 62 3e 20 72 6f 75 74  _data()</b> rout
7460: 69 6e 65 20 63 61 6e 20 62 65 20 75 73 65 64 20  ine can be used 
7470: 74 6f 0a 72 65 74 72 69 65 76 65 20 74 68 65 20  to.retrieve the 
7480: 3c 62 3e 70 55 73 65 72 44 61 74 61 3c 2f 62 3e  <b>pUserData</b>
7490: 20 70 6f 69 6e 74 65 72 20 74 68 61 74 20 77 61   pointer that wa
74a0: 73 20 70 61 73 73 65 64 20 69 6e 20 77 68 65 6e  s passed in when
74b0: 20 74 68 65 0a 66 75 6e 63 74 69 6f 6e 20 77 61   the.function wa
74c0: 73 20 72 65 67 69 73 74 65 72 65 64 2e 0a 3c 2f  s registered..</
74d0: 70 3e 0a 0a 3c 70 3e 0a 46 6f 72 20 61 67 67 72  p>..<p>.For aggr
74e0: 65 67 61 74 65 20 66 75 6e 63 74 69 6f 6e 73 2c  egate functions,
74f0: 20 74 68 65 20 3c 62 3e 78 53 74 65 70 3c 2f 62   the <b>xStep</b
7500: 3e 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e  > callback is in
7510: 76 6f 6b 65 64 20 6f 6e 63 65 0a 66 6f 72 20 65  voked once.for e
7520: 61 63 68 20 72 6f 77 20 69 6e 20 74 68 65 20 72  ach row in the r
7530: 65 73 75 6c 74 20 61 6e 64 20 74 68 65 6e 20 3c  esult and then <
7540: 62 3e 78 46 69 6e 61 6c 69 7a 65 3c 2f 62 3e 20  b>xFinalize</b> 
7550: 69 73 20 69 6e 76 6f 6b 65 64 20 61 74 20 74 68  is invoked at th
7560: 65 0a 65 6e 64 20 74 6f 20 63 6f 6d 70 75 74 65  e.end to compute
7570: 20 61 20 66 69 6e 61 6c 20 61 6e 73 77 65 72 2e   a final answer.
7580: 20 20 54 68 65 20 78 53 74 65 70 20 72 6f 75 74    The xStep rout
7590: 69 6e 65 20 63 61 6e 20 75 73 65 20 74 68 65 0a  ine can use the.
75a0: 3c 62 3e 73 71 6c 69 74 65 5f 61 67 67 72 65 67  <b>sqlite_aggreg
75b0: 61 74 65 5f 63 6f 6e 74 65 78 74 28 29 3c 2f 62  ate_context()</b
75c0: 3e 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20 61  > interface to a
75d0: 6c 6c 6f 63 61 74 65 20 6d 65 6d 6f 72 79 20 74  llocate memory t
75e0: 68 61 74 0a 77 69 6c 6c 20 62 65 20 75 6e 69 71  hat.will be uniq
75f0: 75 65 20 74 6f 20 74 68 61 74 20 70 61 72 74 69  ue to that parti
7600: 63 75 6c 61 72 20 69 6e 73 74 61 6e 63 65 20 6f  cular instance o
7610: 66 20 74 68 65 20 53 51 4c 20 66 75 6e 63 74 69  f the SQL functi
7620: 6f 6e 2e 0a 54 68 69 73 20 6d 65 6d 6f 72 79 20  on..This memory 
7630: 77 69 6c 6c 20 62 65 20 61 75 74 6f 6d 61 74 69  will be automati
7640: 63 61 6c 6c 79 20 64 65 6c 65 74 65 64 20 61 66  cally deleted af
7650: 74 65 72 20 78 46 69 6e 61 6c 69 7a 65 20 69 73  ter xFinalize is
7660: 20 63 61 6c 6c 65 64 2e 0a 54 68 65 20 3c 62 3e   called..The <b>
7670: 73 71 6c 69 74 65 5f 61 67 67 72 65 67 61 74 65  sqlite_aggregate
7680: 5f 63 6f 75 6e 74 28 29 3c 2f 62 3e 20 72 6f 75  _count()</b> rou
7690: 74 69 6e 65 20 63 61 6e 20 62 65 20 75 73 65 64  tine can be used
76a0: 20 74 6f 20 66 69 6e 64 20 6f 75 74 0a 68 6f 77   to find out.how
76b0: 20 6d 61 6e 79 20 72 6f 77 73 20 6f 66 20 64 61   many rows of da
76c0: 74 61 20 77 65 72 65 20 70 61 73 73 65 64 20 74  ta were passed t
76d0: 6f 20 74 68 65 20 61 67 67 72 65 67 61 74 65 2e  o the aggregate.
76e0: 20 20 54 68 65 20 78 46 69 6e 61 6c 69 7a 65 0a    The xFinalize.
76f0: 63 61 6c 6c 62 61 63 6b 20 73 68 6f 75 6c 64 20  callback should 
7700: 69 6e 76 6f 6b 65 20 6f 6e 65 20 6f 66 20 74 68  invoke one of th
7710: 65 20 3c 62 3e 73 71 6c 69 74 65 5f 73 65 74 5f  e <b>sqlite_set_
7720: 72 65 73 75 6c 74 5f 2e 2e 2e 3c 2f 62 3e 0a 69  result_...</b>.i
7730: 6e 74 65 72 66 61 63 65 73 20 74 6f 20 73 65 74  nterfaces to set
7740: 20 74 68 65 20 66 69 6e 61 6c 20 72 65 73 75 6c   the final resul
7750: 74 20 6f 66 20 74 68 65 20 61 67 67 72 65 67 61  t of the aggrega
7760: 74 65 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 53 51  te..</p>..<p>.SQ
7770: 4c 69 74 65 20 6e 6f 77 20 69 6d 70 6c 65 6d 65  Lite now impleme
7780: 6e 74 73 20 61 6c 6c 20 6f 66 20 69 74 73 20 62  nts all of its b
7790: 75 69 6c 74 2d 69 6e 20 66 75 6e 63 74 69 6f 6e  uilt-in function
77a0: 73 20 75 73 69 6e 67 20 74 68 69 73 0a 69 6e 74  s using this.int
77b0: 65 72 66 61 63 65 2e 20 20 46 6f 72 20 61 64 64  erface.  For add
77c0: 69 74 69 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61 74  itional informat
77d0: 69 6f 6e 20 61 6e 64 20 65 78 61 6d 70 6c 65 73  ion and examples
77e0: 20 6f 6e 20 68 6f 77 20 74 6f 20 63 72 65 61 74   on how to creat
77f0: 65 0a 6e 65 77 20 53 51 4c 20 66 75 6e 63 74 69  e.new SQL functi
7800: 6f 6e 73 2c 20 72 65 76 69 65 77 20 74 68 65 20  ons, review the 
7810: 53 51 4c 69 74 65 20 73 6f 75 72 63 65 20 63 6f  SQLite source co
7820: 64 65 20 69 6e 20 74 68 65 20 66 69 6c 65 0a 3c  de in the file.<
7830: 62 3e 66 75 6e 63 2e 63 3c 2f 62 3e 2e 0a 3c 2f  b>func.c</b>..</
7840: 70 3e 0a 0a 3c 68 32 3e 4d 75 6c 74 69 2d 54 68  p>..<h2>Multi-Th
7850: 72 65 61 64 69 6e 67 20 41 6e 64 20 53 51 4c 69  reading And SQLi
7860: 74 65 3c 2f 68 32 3e 0a 0a 3c 70 3e 0a 49 66 20  te</h2>..<p>.If 
7870: 53 51 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c  SQLite is compil
7880: 65 64 20 77 69 74 68 20 74 68 65 20 54 48 52 45  ed with the THRE
7890: 41 44 53 41 46 45 20 70 72 65 70 72 6f 63 65 73  ADSAFE preproces
78a0: 73 6f 72 20 6d 61 63 72 6f 20 73 65 74 20 74 6f  sor macro set to
78b0: 20 31 2c 0a 74 68 65 6e 20 69 74 20 69 73 20 73   1,.then it is s
78c0: 61 66 65 20 74 6f 20 75 73 65 20 53 51 4c 69 74  afe to use SQLit
78d0: 65 20 66 72 6f 6d 20 74 77 6f 20 6f 72 20 6d 6f  e from two or mo
78e0: 72 65 20 74 68 72 65 61 64 73 20 6f 66 20 74 68  re threads of th
78f0: 65 20 73 61 6d 65 20 70 72 6f 63 65 73 73 0a 61  e same process.a
7900: 74 20 74 68 65 20 73 61 6d 65 20 74 69 6d 65 2e  t the same time.
7910: 20 20 42 75 74 20 65 61 63 68 20 74 68 72 65 61    But each threa
7920: 64 20 73 68 6f 75 6c 64 20 68 61 76 65 20 69 74  d should have it
7930: 73 20 6f 77 6e 20 3c 62 3e 73 71 6c 69 74 65 2a  s own <b>sqlite*
7940: 3c 2f 62 3e 0a 70 6f 69 6e 74 65 72 20 72 65 74  </b>.pointer ret
7950: 75 72 6e 65 64 20 66 72 6f 6d 20 3c 62 3e 73 71  urned from <b>sq
7960: 6c 69 74 65 5f 6f 70 65 6e 28 29 3c 2f 62 3e 2e  lite_open()</b>.
7970: 20 20 49 74 20 69 73 20 6e 65 76 65 72 20 73 61    It is never sa
7980: 66 65 20 66 6f 72 20 74 77 6f 0a 6f 72 20 6d 6f  fe for two.or mo
7990: 72 65 20 74 68 72 65 61 64 73 20 74 6f 20 61 63  re threads to ac
79a0: 63 65 73 73 20 74 68 65 20 73 61 6d 65 20 3c 62  cess the same <b
79b0: 3e 73 71 6c 69 74 65 2a 3c 2f 62 3e 20 70 6f 69  >sqlite*</b> poi
79c0: 6e 74 65 72 20 61 74 20 74 68 65 20 73 61 6d 65  nter at the same
79d0: 20 74 69 6d 65 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e   time..</p>..<p>
79e0: 0a 49 6e 20 70 72 65 63 6f 6d 70 69 6c 65 64 20  .In precompiled 
79f0: 53 51 4c 69 74 65 20 6c 69 62 72 61 72 69 65 73  SQLite libraries
7a00: 20 61 76 61 69 6c 61 62 6c 65 20 6f 6e 20 74 68   available on th
7a10: 65 20 77 65 62 73 69 74 65 2c 20 74 68 65 20 55  e website, the U
7a20: 6e 69 78 0a 76 65 72 73 69 6f 6e 73 20 61 72 65  nix.versions are
7a30: 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 54   compiled with T
7a40: 48 52 45 41 44 53 41 46 45 20 74 75 72 6e 65 64  HREADSAFE turned
7a50: 20 6f 66 66 20 62 75 74 20 74 68 65 20 77 69 6e   off but the win
7a60: 64 6f 77 73 0a 76 65 72 73 69 6f 6e 73 20 61 72  dows.versions ar
7a70: 65 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 20  e compiled with 
7a80: 54 48 52 45 41 44 53 41 46 45 20 74 75 72 6e 65  THREADSAFE turne
7a90: 64 20 6f 6e 2e 20 20 49 66 20 79 6f 75 20 6e 65  d on.  If you ne
7aa0: 65 64 20 73 6f 6d 65 74 68 69 6e 67 0a 64 69 66  ed something.dif
7ab0: 66 65 72 65 6e 74 20 74 68 61 74 20 74 68 69 73  ferent that this
7ac0: 20 79 6f 75 20 77 69 6c 6c 20 68 61 76 65 20 74   you will have t
7ad0: 6f 20 72 65 63 6f 6d 70 69 6c 65 2e 0a 3c 2f 70  o recompile..</p
7ae0: 3e 0a 0a 3c 70 3e 0a 55 6e 64 65 72 20 55 6e 69  >..<p>.Under Uni
7af0: 78 2c 20 61 6e 20 3c 62 3e 73 71 6c 69 74 65 2a  x, an <b>sqlite*
7b00: 3c 2f 62 3e 20 70 6f 69 6e 74 65 72 20 73 68 6f  </b> pointer sho
7b10: 75 6c 64 20 6e 6f 74 20 62 65 20 63 61 72 72 69  uld not be carri
7b20: 65 64 20 61 63 72 6f 73 73 20 61 0a 3c 62 3e 66  ed across a.<b>f
7b30: 6f 72 6b 28 29 3c 2f 62 3e 20 73 79 73 74 65 6d  ork()</b> system
7b40: 20 63 61 6c 6c 20 69 6e 74 6f 20 74 68 65 20 63   call into the c
7b50: 68 69 6c 64 20 70 72 6f 63 65 73 73 2e 20 20 54  hild process.  T
7b60: 68 65 20 63 68 69 6c 64 20 70 72 6f 63 65 73 73  he child process
7b70: 0a 73 68 6f 75 6c 64 20 6f 70 65 6e 20 69 74 73  .should open its
7b80: 20 6f 77 6e 20 63 6f 70 79 20 6f 66 20 74 68 65   own copy of the
7b90: 20 64 61 74 61 62 61 73 65 20 61 66 74 65 72 20   database after 
7ba0: 74 68 65 20 3c 62 3e 66 6f 72 6b 28 29 3c 2f 62  the <b>fork()</b
7bb0: 3e 2e 0a 3c 2f 70 3e 0a 0a 3c 68 32 3e 55 73 61  >..</p>..<h2>Usa
7bc0: 67 65 20 45 78 61 6d 70 6c 65 73 3c 2f 68 32 3e  ge Examples</h2>
7bd0: 0a 0a 3c 70 3e 46 6f 72 20 65 78 61 6d 70 6c 65  ..<p>For example
7be0: 73 20 6f 66 20 68 6f 77 20 74 68 65 20 53 51 4c  s of how the SQL
7bf0: 69 74 65 20 43 2f 43 2b 2b 20 69 6e 74 65 72 66  ite C/C++ interf
7c00: 61 63 65 20 63 61 6e 20 62 65 20 75 73 65 64 2c  ace can be used,
7c10: 0a 72 65 66 65 72 20 74 6f 20 74 68 65 20 73 6f  .refer to the so
7c20: 75 72 63 65 20 63 6f 64 65 20 66 6f 72 20 74 68  urce code for th
7c30: 65 20 3c 62 3e 73 71 6c 69 74 65 3c 2f 62 3e 20  e <b>sqlite</b> 
7c40: 70 72 6f 67 72 61 6d 20 69 6e 20 74 68 65 0a 66  program in the.f
7c50: 69 6c 65 20 3c 62 3e 73 72 63 2f 73 68 65 6c 6c  ile <b>src/shell
7c60: 2e 63 3c 2f 62 3e 20 6f 66 20 74 68 65 20 73 6f  .c</b> of the so
7c70: 75 72 63 65 20 74 72 65 65 2e 0a 41 64 64 69 74  urce tree..Addit
7c80: 69 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f  ional informatio
7c90: 6e 20 61 62 6f 75 74 20 73 71 6c 69 74 65 20 69  n about sqlite i
7ca0: 73 20 61 76 61 69 6c 61 62 6c 65 20 61 74 0a 3c  s available at.<
7cb0: 61 20 68 72 65 66 3d 22 73 71 6c 69 74 65 2e 68  a href="sqlite.h
7cc0: 74 6d 6c 22 3e 73 71 6c 69 74 65 2e 68 74 6d 6c  tml">sqlite.html
7cd0: 3c 2f 61 3e 2e 0a 53 65 65 20 61 6c 73 6f 20 74  </a>..See also t
7ce0: 68 65 20 73 6f 75 72 63 65 73 20 74 6f 20 74 68  he sources to th
7cf0: 65 20 54 63 6c 20 69 6e 74 65 72 66 61 63 65 20  e Tcl interface 
7d00: 66 6f 72 20 53 51 4c 69 74 65 20 69 6e 0a 74 68  for SQLite in.th
7d10: 65 20 73 6f 75 72 63 65 20 66 69 6c 65 20 3c 62  e source file <b
7d20: 3e 73 72 63 2f 74 63 6c 73 71 6c 69 74 65 2e 63  >src/tclsqlite.c
7d30: 3c 2f 62 3e 2e 3c 2f 70 3e 0a 7d 0a 0a 70 75 74  </b>.</p>.}..put
7d40: 73 20 7b 0a 3c 70 3e 3c 68 72 20 2f 3e 3c 2f 70  s {.<p><hr /></p
7d50: 3e 0a 3c 70 3e 3c 61 20 68 72 65 66 3d 22 69 6e  >.<p><a href="in
7d60: 64 65 78 2e 68 74 6d 6c 22 3e 3c 69 6d 67 20 73  dex.html"><img s
7d70: 72 63 3d 22 2f 67 6f 62 61 63 6b 2e 6a 70 67 22  rc="/goback.jpg"
7d80: 20 62 6f 72 64 65 72 3d 30 20 2f 3e 0a 42 61 63   border=0 />.Bac
7d90: 6b 20 74 6f 20 74 68 65 20 53 51 4c 69 74 65 20  k to the SQLite 
7da0: 48 6f 6d 65 20 50 61 67 65 3c 2f 61 3e 0a 3c 2f  Home Page</a>.</
7db0: 70 3e 0a 0a 3c 2f 62 6f 64 79 3e 3c 2f 68 74 6d  p>..</body></htm
7dc0: 6c 3e 7d 0a                                      l>}.