/ Hex Artifact Content
Login

Artifact 580c03f096a16c0cf7ce18e0483daace4a602b46:


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 31 20 32 30 30 32 2f 30 37 2f 31 33 20 31 37  31 2002/07/13 17
0070: 3a 31 38 3a 33 37 20 64 72 68 20 45 78 70 20 24  :18:37 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 20 62 79 20 61 20 52 4f 4c 4c 42   undo by a ROLLB
3c50: 41 43 4b 20 6f 72 20 41 42 4f 52 54 2e 20 20 42  ACK or ABORT.  B
3c60: 75 74 20 72 6f 77 73 20 74 68 61 74 20 61 72 65  ut rows that are
3c70: 0a 64 65 6c 65 74 65 64 20 62 65 63 61 75 73 65  .deleted because
3c80: 20 6f 66 20 61 20 44 52 4f 50 20 54 41 42 4c 45   of a DROP TABLE
3c90: 20 61 72 65 20 3c 65 6d 3e 6e 6f 74 3c 2f 65 6d   are <em>not</em
3ca0: 3e 20 63 6f 75 6e 74 65 64 2e 3c 2f 70 3e 0a 0a  > counted.</p>..
3cb0: 3c 70 3e 53 51 4c 69 74 65 20 69 6d 70 6c 65 6d  <p>SQLite implem
3cc0: 65 6e 74 73 20 74 68 65 20 63 6f 6d 6d 61 6e 64  ents the command
3cd0: 20 22 3c 62 3e 44 45 4c 45 54 45 20 46 52 4f 4d   "<b>DELETE FROM
3ce0: 20 74 61 62 6c 65 3c 2f 62 3e 22 20 28 77 69 74   table</b>" (wit
3cf0: 68 6f 75 74 0a 61 20 57 48 45 52 45 20 63 6c 61  hout.a WHERE cla
3d00: 75 73 65 29 20 62 79 20 64 72 6f 70 70 69 6e 67  use) by dropping
3d10: 20 74 68 65 20 74 61 62 6c 65 20 74 68 65 6e 20   the table then 
3d20: 72 65 63 72 65 61 74 69 6e 67 20 69 74 2e 20 20  recreating it.  
3d30: 0a 54 68 69 73 20 69 73 20 6d 75 63 68 20 66 61  .This is much fa
3d40: 73 74 65 72 20 74 68 61 6e 20 64 65 6c 65 74 69  ster than deleti
3d50: 6e 67 20 74 68 65 20 65 6c 65 6d 65 6e 74 73 20  ng the elements 
3d60: 6f 66 20 74 68 65 20 74 61 62 6c 65 20 69 6e 64  of the table ind
3d70: 69 76 69 64 75 61 6c 6c 79 2e 0a 42 75 74 20 69  ividually..But i
3d80: 74 20 61 6c 73 6f 20 6d 65 61 6e 73 20 74 68 61  t also means tha
3d90: 74 20 74 68 65 20 76 61 6c 75 65 20 72 65 74 75  t the value retu
3da0: 72 6e 65 64 20 66 72 6f 6d 20 3c 62 3e 73 71 6c  rned from <b>sql
3db0: 69 74 65 5f 63 68 61 6e 67 65 73 28 29 3c 2f 62  ite_changes()</b
3dc0: 3e 0a 77 69 6c 6c 20 62 65 20 7a 65 72 6f 20 72  >.will be zero r
3dd0: 65 67 61 72 64 6c 65 73 73 20 6f 66 20 74 68 65  egardless of the
3de0: 20 6e 75 6d 62 65 72 20 6f 66 20 65 6c 65 6d 65   number of eleme
3df0: 6e 74 73 20 74 68 61 74 20 77 65 72 65 20 6f 72  nts that were or
3e00: 69 67 69 6e 61 6c 6c 79 0a 69 6e 20 74 68 65 20  iginally.in the 
3e10: 74 61 62 6c 65 2e 20 20 49 66 20 61 6e 20 61 63  table.  If an ac
3e20: 63 75 72 61 74 65 20 63 6f 75 6e 74 20 6f 66 20  curate count of 
3e30: 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 65 6c  the number of el
3e40: 65 6d 65 6e 74 73 20 64 65 6c 65 74 65 64 0a 69  ements deleted.i
3e50: 73 20 6e 65 63 65 73 73 61 72 79 2c 20 75 73 65  s necessary, use
3e60: 20 22 3c 62 3e 44 45 4c 45 54 45 20 46 52 4f 4d   "<b>DELETE FROM
3e70: 20 74 61 62 6c 65 20 57 48 45 52 45 20 31 3c 2f   table WHERE 1</
3e80: 62 3e 22 20 69 6e 73 74 65 61 64 2e 3c 2f 70 3e  b>" instead.</p>
3e90: 0a 0a 3c 68 32 3e 51 75 65 72 79 69 6e 67 20 77  ..<h2>Querying w
3ea0: 69 74 68 6f 75 74 20 75 73 69 6e 67 20 61 20 63  ithout using a c
3eb0: 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e  allback function
3ec0: 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65 20 3c 62  </h2>..<p>The <b
3ed0: 3e 73 71 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c  >sqlite_get_tabl
3ee0: 65 28 29 3c 2f 62 3e 20 66 75 6e 63 74 69 6f 6e  e()</b> function
3ef0: 20 69 73 20 61 20 77 72 61 70 70 65 72 20 61 72   is a wrapper ar
3f00: 6f 75 6e 64 0a 3c 62 3e 73 71 6c 69 74 65 5f 65  ound.<b>sqlite_e
3f10: 78 65 63 28 29 3c 2f 62 3e 20 74 68 61 74 20 63  xec()</b> that c
3f20: 6f 6c 6c 65 63 74 73 20 61 6c 6c 20 74 68 65 20  ollects all the 
3f30: 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 66 72 6f 6d  information from
3f40: 20 73 75 63 63 65 73 73 69 76 65 0a 63 61 6c 6c   successive.call
3f50: 62 61 63 6b 73 20 61 6e 64 20 77 72 69 74 65 20  backs and write 
3f60: 69 74 20 69 6e 74 6f 20 6d 65 6d 6f 72 79 20 6f  it into memory o
3f70: 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 6d 61 6c  btained from mal
3f80: 6c 6f 63 28 29 2e 20 20 54 68 69 73 0a 69 73 20  loc().  This.is 
3f90: 61 20 63 6f 6e 76 65 6e 69 65 6e 63 65 20 66 75  a convenience fu
3fa0: 6e 63 74 69 6f 6e 20 74 68 61 74 20 61 6c 6c 6f  nction that allo
3fb0: 77 73 20 74 68 65 20 61 70 70 6c 69 63 61 74 69  ws the applicati
3fc0: 6f 6e 20 74 6f 20 67 65 74 20 74 68 65 0a 65 6e  on to get the.en
3fd0: 74 69 72 65 20 72 65 73 75 6c 74 20 6f 66 20 61  tire result of a
3fe0: 20 64 61 74 61 62 61 73 65 20 71 75 65 72 79 20   database query 
3ff0: 77 69 74 68 20 61 20 73 69 6e 67 6c 65 20 66 75  with a single fu
4000: 6e 63 74 69 6f 6e 20 63 61 6c 6c 2e 3c 2f 70 3e  nction call.</p>
4010: 0a 0a 3c 70 3e 54 68 65 20 6d 61 69 6e 20 72 65  ..<p>The main re
4020: 73 75 6c 74 20 66 72 6f 6d 20 3c 62 3e 73 71 6c  sult from <b>sql
4030: 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 28 29 3c  ite_get_table()<
4040: 2f 62 3e 20 69 73 20 61 6e 20 61 72 72 61 79 20  /b> is an array 
4050: 6f 66 20 70 6f 69 6e 74 65 72 73 0a 74 6f 20 73  of pointers.to s
4060: 74 72 69 6e 67 73 2e 20 20 54 68 65 72 65 20 69  trings.  There i
4070: 73 20 6f 6e 65 20 65 6c 65 6d 65 6e 74 20 69 6e  s one element in
4080: 20 74 68 69 73 20 61 72 72 61 79 20 66 6f 72 20   this array for 
4090: 65 61 63 68 20 63 6f 6c 75 6d 6e 20 6f 66 0a 65  each column of.e
40a0: 61 63 68 20 72 6f 77 20 69 6e 20 74 68 65 20 72  ach row in the r
40b0: 65 73 75 6c 74 2e 20 20 4e 55 4c 4c 20 72 65 73  esult.  NULL res
40c0: 75 6c 74 73 20 61 72 65 20 72 65 70 72 65 73 65  ults are represe
40d0: 6e 74 65 64 20 62 79 20 61 20 4e 55 4c 4c 0a 70  nted by a NULL.p
40e0: 6f 69 6e 74 65 72 2e 20 49 6e 20 61 64 64 69 74  ointer. In addit
40f0: 69 6f 6e 20 74 6f 20 74 68 65 20 72 65 67 75 6c  ion to the regul
4100: 61 72 20 64 61 74 61 2c 20 74 68 65 72 65 20 69  ar data, there i
4110: 73 20 61 6e 20 61 64 64 65 64 20 72 6f 77 20 61  s an added row a
4120: 74 20 74 68 65 20 0a 62 65 67 69 6e 6e 69 6e 67  t the .beginning
4130: 20 6f 66 20 74 68 65 20 61 72 72 61 79 20 74 68   of the array th
4140: 61 74 20 63 6f 6e 74 61 69 6e 73 20 74 68 65 20  at contains the 
4150: 6e 61 6d 65 73 20 6f 66 20 65 61 63 68 20 63 6f  names of each co
4160: 6c 75 6d 6e 20 6f 66 20 74 68 65 0a 72 65 73 75  lumn of the.resu
4170: 6c 74 2e 3c 2f 70 3e 0a 0a 3c 70 3e 41 73 20 61  lt.</p>..<p>As a
4180: 6e 20 65 78 61 6d 70 6c 65 2c 20 63 6f 6e 73 69  n example, consi
4190: 64 65 72 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e  der the followin
41a0: 67 20 71 75 65 72 79 3a 3c 2f 70 3e 0a 0a 3c 62  g query:</p>..<b
41b0: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 53 45 4c 45 43  lockquote>.SELEC
41c0: 54 20 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65 2c  T employee_name,
41d0: 20 6c 6f 67 69 6e 2c 20 68 6f 73 74 20 46 52 4f   login, host FRO
41e0: 4d 20 75 73 65 72 73 20 57 48 45 52 45 20 6c 6f  M users WHERE lo
41f0: 67 69 63 20 4c 49 4b 45 20 27 64 25 27 3b 0a 3c  gic LIKE 'd%';.<
4200: 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70  /blockquote>..<p
4210: 3e 54 68 69 73 20 71 75 65 72 79 20 77 69 6c 6c  >This query will
4220: 20 72 65 74 75 72 6e 20 74 68 65 20 6e 61 6d 65   return the name
4230: 2c 20 6c 6f 67 69 6e 20 61 6e 64 20 68 6f 73 74  , login and host
4240: 20 63 6f 6d 70 75 74 65 72 20 6e 61 6d 65 0a 66   computer name.f
4250: 6f 72 20 65 76 65 72 79 20 65 6d 70 6c 6f 79 65  or every employe
4260: 65 20 77 68 6f 73 65 20 6c 6f 67 69 6e 20 62 65  e whose login be
4270: 67 69 6e 73 20 77 69 74 68 20 74 68 65 20 6c 65  gins with the le
4280: 74 74 65 72 20 22 64 22 2e 20 20 49 66 20 74 68  tter "d".  If th
4290: 69 73 0a 71 75 65 72 79 20 69 73 20 73 75 62 6d  is.query is subm
42a0: 69 74 74 65 64 20 74 6f 20 3c 62 3e 73 71 6c 69  itted to <b>sqli
42b0: 74 65 5f 67 65 74 5f 74 61 62 6c 65 28 29 3c 2f  te_get_table()</
42c0: 62 3e 20 74 68 65 20 72 65 73 75 6c 74 20 6d 69  b> the result mi
42d0: 67 68 74 0a 6c 6f 6f 6b 20 6c 69 6b 65 20 74 68  ght.look like th
42e0: 69 73 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71  is:</p>..<blockq
42f0: 75 6f 74 65 3e 0a 6e 72 6f 77 20 3d 20 32 3c 62  uote>.nrow = 2<b
4300: 72 3e 0a 6e 63 6f 6c 75 6d 6e 20 3d 20 33 3c 62  r>.ncolumn = 3<b
4310: 72 3e 0a 72 65 73 75 6c 74 5b 30 5d 20 3d 20 22  r>.result[0] = "
4320: 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65 22 3c 62  employee_name"<b
4330: 72 3e 0a 72 65 73 75 6c 74 5b 31 5d 20 3d 20 22  r>.result[1] = "
4340: 6c 6f 67 69 6e 22 3c 62 72 3e 0a 72 65 73 75 6c  login"<br>.resul
4350: 74 5b 32 5d 20 3d 20 22 68 6f 73 74 22 3c 62 72  t[2] = "host"<br
4360: 3e 0a 72 65 73 75 6c 74 5b 33 5d 20 3d 20 22 64  >.result[3] = "d
4370: 75 6d 6d 79 22 3c 62 72 3e 0a 72 65 73 75 6c 74  ummy"<br>.result
4380: 5b 34 5d 20 3d 20 22 4e 6f 20 73 75 63 68 20 75  [4] = "No such u
4390: 73 65 72 22 3c 62 72 3e 0a 72 65 73 75 6c 74 5b  ser"<br>.result[
43a0: 35 5d 20 3d 20 30 3c 62 72 3e 0a 72 65 73 75 6c  5] = 0<br>.resul
43b0: 74 5b 36 5d 20 3d 20 22 44 2e 20 52 69 63 68 61  t[6] = "D. Richa
43c0: 72 64 20 48 69 70 70 22 3c 62 72 3e 0a 72 65 73  rd Hipp"<br>.res
43d0: 75 6c 74 5b 37 5d 20 3d 20 22 64 72 68 22 3c 62  ult[7] = "drh"<b
43e0: 72 3e 0a 72 65 73 75 6c 74 5b 38 5d 20 3d 20 22  r>.result[8] = "
43f0: 7a 61 64 6f 6b 22 0a 3c 2f 62 6c 6f 63 6b 71 75  zadok".</blockqu
4400: 6f 74 65 3e 0a 0a 3c 70 3e 4e 6f 74 69 63 65 20  ote>..<p>Notice 
4410: 74 68 61 74 20 74 68 65 20 22 68 6f 73 74 22 20  that the "host" 
4420: 76 61 6c 75 65 20 66 6f 72 20 74 68 65 20 22 64  value for the "d
4430: 75 6d 6d 79 22 20 72 65 63 6f 72 64 20 69 73 20  ummy" record is 
4440: 4e 55 4c 4c 20 73 6f 0a 74 68 65 20 72 65 73 75  NULL so.the resu
4450: 6c 74 5b 5d 20 61 72 72 61 79 20 63 6f 6e 74 61  lt[] array conta
4460: 69 6e 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74  ins a NULL point
4470: 65 72 20 61 74 20 74 68 61 74 20 73 6c 6f 74 2e  er at that slot.
4480: 3c 2f 70 3e 0a 0a 3c 70 3e 49 66 20 74 68 65 20  </p>..<p>If the 
4490: 72 65 73 75 6c 74 20 73 65 74 20 6f 66 20 61 20  result set of a 
44a0: 71 75 65 72 79 20 69 73 20 65 6d 70 74 79 2c 20  query is empty, 
44b0: 74 68 65 6e 20 62 79 20 64 65 66 61 75 6c 74 0a  then by default.
44c0: 3c 62 3e 73 71 6c 69 74 65 5f 67 65 74 5f 74 61  <b>sqlite_get_ta
44d0: 62 6c 65 28 29 3c 2f 62 3e 20 77 69 6c 6c 20 73  ble()</b> will s
44e0: 65 74 20 6e 72 6f 77 20 74 6f 20 30 20 61 6e 64  et nrow to 0 and
44f0: 20 6c 65 61 76 65 20 69 74 73 0a 72 65 73 75 6c   leave its.resul
4500: 74 20 70 61 72 61 6d 65 74 65 72 20 69 73 20 73  t parameter is s
4510: 65 74 20 74 6f 20 4e 55 4c 4c 2e 20 20 42 75 74  et to NULL.  But
4520: 20 69 66 20 74 68 65 20 45 4d 50 54 59 5f 52 45   if the EMPTY_RE
4530: 53 55 4c 54 5f 43 41 4c 4c 42 41 43 4b 53 0a 70  SULT_CALLBACKS.p
4540: 72 61 67 6d 61 20 69 73 20 4f 4e 20 74 68 65 6e  ragma is ON then
4550: 20 74 68 65 20 72 65 73 75 6c 74 20 70 61 72 61   the result para
4560: 6d 65 74 65 72 20 69 73 20 69 6e 69 74 69 61 6c  meter is initial
4570: 69 7a 65 64 20 74 6f 20 74 68 65 20 6e 61 6d 65  ized to the name
4580: 73 0a 6f 66 20 74 68 65 20 63 6f 6c 75 6d 6e 73  s.of the columns
4590: 20 6f 6e 6c 79 2e 20 20 46 6f 72 20 65 78 61 6d   only.  For exam
45a0: 70 6c 65 2c 20 63 6f 6e 73 69 64 65 72 20 74 68  ple, consider th
45b0: 69 73 20 71 75 65 72 79 20 77 68 69 63 68 20 68  is query which h
45c0: 61 73 0a 61 6e 20 65 6d 70 74 79 20 72 65 73 75  as.an empty resu
45d0: 6c 74 20 73 65 74 3a 3c 2f 70 3e 0a 0a 3c 62 6c  lt set:</p>..<bl
45e0: 6f 63 6b 71 75 6f 74 65 3e 0a 53 45 4c 45 43 54  ockquote>.SELECT
45f0: 20 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65 2c 20   employee_name, 
4600: 6c 6f 67 69 6e 2c 20 68 6f 73 74 20 46 52 4f 4d  login, host FROM
4610: 20 75 73 65 72 73 20 57 48 45 52 45 20 65 6d 70   users WHERE emp
4620: 6c 6f 79 65 65 5f 6e 61 6d 65 20 49 53 20 4e 55  loyee_name IS NU
4630: 4c 4c 3b 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65  LL;.</blockquote
4640: 3e 0a 0a 3c 70 3e 0a 54 68 65 20 64 65 66 61 75  >..<p>.The defau
4650: 6c 74 20 62 65 68 61 76 69 6f 72 20 67 69 76 65  lt behavior give
4660: 73 20 74 68 69 73 20 72 65 73 75 6c 74 73 3a 0a  s this results:.
4670: 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74  </p>..<blockquot
4680: 65 3e 0a 6e 72 6f 77 20 3d 20 30 3c 62 72 3e 0a  e>.nrow = 0<br>.
4690: 6e 63 6f 6c 75 6d 6e 20 3d 20 30 3c 62 72 3e 0a  ncolumn = 0<br>.
46a0: 72 65 73 75 6c 74 20 3d 20 30 3c 62 72 3e 0a 3c  result = 0<br>.<
46b0: 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70  /blockquote>..<p
46c0: 3e 0a 42 75 74 20 69 66 20 74 68 65 20 45 4d 50  >.But if the EMP
46d0: 54 59 5f 52 45 53 55 4c 54 5f 43 41 4c 4c 42 41  TY_RESULT_CALLBA
46e0: 43 4b 53 20 70 72 61 67 6d 61 20 69 73 20 4f 4e  CKS pragma is ON
46f0: 2c 20 74 68 65 6e 20 74 68 65 20 66 6f 6c 6c 6f  , then the follo
4700: 77 69 6e 67 0a 69 73 20 72 65 74 75 72 6e 65 64  wing.is returned
4710: 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75  :.</p>..<blockqu
4720: 6f 74 65 3e 0a 6e 72 6f 77 20 3d 20 30 3c 62 72  ote>.nrow = 0<br
4730: 3e 0a 6e 63 6f 6c 75 6d 6e 20 3d 20 33 3c 62 72  >.ncolumn = 3<br
4740: 3e 0a 72 65 73 75 6c 74 5b 30 5d 20 3d 20 22 65  >.result[0] = "e
4750: 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65 22 3c 62 72  mployee_name"<br
4760: 3e 0a 72 65 73 75 6c 74 5b 31 5d 20 3d 20 22 6c  >.result[1] = "l
4770: 6f 67 69 6e 22 3c 62 72 3e 0a 72 65 73 75 6c 74  ogin"<br>.result
4780: 5b 32 5d 20 3d 20 22 68 6f 73 74 22 3c 62 72 3e  [2] = "host"<br>
4790: 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a  .</blockquote>..
47a0: 3c 70 3e 4d 65 6d 6f 72 79 20 74 6f 20 68 6f 6c  <p>Memory to hol
47b0: 64 20 74 68 65 20 69 6e 66 6f 72 6d 61 74 69 6f  d the informatio
47c0: 6e 20 72 65 74 75 72 6e 65 64 20 62 79 20 3c 62  n returned by <b
47d0: 3e 73 71 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c  >sqlite_get_tabl
47e0: 65 28 29 3c 2f 62 3e 0a 69 73 20 6f 62 74 61 69  e()</b>.is obtai
47f0: 6e 65 64 20 66 72 6f 6d 20 6d 61 6c 6c 6f 63 28  ned from malloc(
4800: 29 2e 20 20 42 75 74 20 74 68 65 20 63 61 6c 6c  ).  But the call
4810: 69 6e 67 20 66 75 6e 63 74 69 6f 6e 20 73 68 6f  ing function sho
4820: 75 6c 64 20 6e 6f 74 20 74 72 79 0a 74 6f 20 66  uld not try.to f
4830: 72 65 65 20 74 68 69 73 20 69 6e 66 6f 72 6d 61  ree this informa
4840: 74 69 6f 6e 20 64 69 72 65 63 74 6c 79 2e 20 20  tion directly.  
4850: 49 6e 73 74 65 61 64 2c 20 70 61 73 73 20 74 68  Instead, pass th
4860: 65 20 63 6f 6d 70 6c 65 74 65 20 74 61 62 6c 65  e complete table
4870: 0a 74 6f 20 3c 62 3e 73 71 6c 69 74 65 5f 66 72  .to <b>sqlite_fr
4880: 65 65 5f 74 61 62 6c 65 28 29 3c 2f 62 3e 20 77  ee_table()</b> w
4890: 68 65 6e 20 74 68 65 20 74 61 62 6c 65 20 69 73  hen the table is
48a0: 20 6e 6f 20 6c 6f 6e 67 65 72 20 6e 65 65 64 65   no longer neede
48b0: 64 2e 0a 49 74 20 69 73 20 73 61 66 65 20 74 6f  d..It is safe to
48c0: 20 63 61 6c 6c 20 3c 62 3e 73 71 6c 69 74 65 5f   call <b>sqlite_
48d0: 66 72 65 65 5f 74 61 62 6c 65 28 29 3c 2f 62 3e  free_table()</b>
48e0: 20 77 69 74 68 20 61 20 4e 55 4c 4c 20 70 6f 69   with a NULL poi
48f0: 6e 74 65 72 20 73 75 63 68 0a 61 73 20 77 6f 75  nter such.as wou
4900: 6c 64 20 62 65 20 72 65 74 75 72 6e 65 64 20 69  ld be returned i
4910: 66 20 74 68 65 20 72 65 73 75 6c 74 20 73 65 74  f the result set
4920: 20 69 73 20 65 6d 70 74 79 2e 3c 2f 70 3e 0a 0a   is empty.</p>..
4930: 3c 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69 74 65  <p>The <b>sqlite
4940: 5f 67 65 74 5f 74 61 62 6c 65 28 29 3c 2f 62 3e  _get_table()</b>
4950: 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73   routine returns
4960: 20 74 68 65 20 73 61 6d 65 20 69 6e 74 65 67 65   the same intege
4970: 72 0a 72 65 73 75 6c 74 20 63 6f 64 65 20 61 73  r.result code as
4980: 20 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28   <b>sqlite_exec(
4990: 29 3c 2f 62 3e 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e  )</b>.</p>..<h2>
49a0: 49 6e 74 65 72 72 75 70 74 69 6e 67 20 61 6e 20  Interrupting an 
49b0: 53 51 4c 69 74 65 20 6f 70 65 72 61 74 69 6f 6e  SQLite operation
49c0: 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65 20 3c 62  </h2>..<p>The <b
49d0: 3e 73 71 6c 69 74 65 5f 69 6e 74 65 72 72 75 70  >sqlite_interrup
49e0: 74 28 29 3c 2f 62 3e 20 66 75 6e 63 74 69 6f 6e  t()</b> function
49f0: 20 63 61 6e 20 62 65 20 63 61 6c 6c 65 64 20 66   can be called f
4a00: 72 6f 6d 20 61 0a 64 69 66 66 65 72 65 6e 74 20  rom a.different 
4a10: 74 68 72 65 61 64 20 6f 72 20 66 72 6f 6d 20 61  thread or from a
4a20: 20 73 69 67 6e 61 6c 20 68 61 6e 64 6c 65 72 20   signal handler 
4a30: 74 6f 20 63 61 75 73 65 20 74 68 65 20 63 75 72  to cause the cur
4a40: 72 65 6e 74 20 64 61 74 61 62 61 73 65 0a 6f 70  rent database.op
4a50: 65 72 61 74 69 6f 6e 20 74 6f 20 65 78 69 74 20  eration to exit 
4a60: 61 74 20 69 74 73 20 66 69 72 73 74 20 6f 70 70  at its first opp
4a70: 6f 72 74 75 6e 69 74 79 2e 20 20 57 68 65 6e 20  ortunity.  When 
4a80: 74 68 69 73 20 68 61 70 70 65 6e 73 2c 0a 74 68  this happens,.th
4a90: 65 20 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65 63  e <b>sqlite_exec
4aa0: 28 29 3c 2f 62 3e 20 72 6f 75 74 69 6e 65 20 28  ()</b> routine (
4ab0: 6f 72 20 74 68 65 20 65 71 75 69 76 61 6c 65 6e  or the equivalen
4ac0: 74 29 20 74 68 61 74 20 73 74 61 72 74 65 64 0a  t) that started.
4ad0: 74 68 65 20 64 61 74 61 62 61 73 65 20 6f 70 65  the database ope
4ae0: 72 61 74 69 6f 6e 20 77 69 6c 6c 20 72 65 74 75  ration will retu
4af0: 72 6e 20 53 51 4c 49 54 45 5f 49 4e 54 45 52 52  rn SQLITE_INTERR
4b00: 55 50 54 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 54 65  UPT.</p>..<h2>Te
4b10: 73 74 69 6e 67 20 66 6f 72 20 61 20 63 6f 6d 70  sting for a comp
4b20: 6c 65 74 65 20 53 51 4c 20 73 74 61 74 65 6d 65  lete SQL stateme
4b30: 6e 74 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65 20  nt</h2>..<p>The 
4b40: 6e 65 78 74 20 69 6e 74 65 72 66 61 63 65 20 72  next interface r
4b50: 6f 75 74 69 6e 65 20 74 6f 20 53 51 4c 69 74 65  outine to SQLite
4b60: 20 69 73 20 61 20 63 6f 6e 76 65 6e 69 65 6e 63   is a convenienc
4b70: 65 20 66 75 6e 63 74 69 6f 6e 20 75 73 65 64 0a  e function used.
4b80: 74 6f 20 74 65 73 74 20 77 68 65 74 68 65 72 20  to test whether 
4b90: 6f 72 20 6e 6f 74 20 61 20 73 74 72 69 6e 67 20  or not a string 
4ba0: 66 6f 72 6d 73 20 61 20 63 6f 6d 70 6c 65 74 65  forms a complete
4bb0: 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2e 0a   SQL statement..
4bc0: 49 66 20 74 68 65 20 3c 62 3e 73 71 6c 69 74 65  If the <b>sqlite
4bd0: 5f 63 6f 6d 70 6c 65 74 65 28 29 3c 2f 62 3e 20  _complete()</b> 
4be0: 66 75 6e 63 74 69 6f 6e 20 72 65 74 75 72 6e 73  function returns
4bf0: 20 74 72 75 65 20 77 68 65 6e 20 69 74 73 20 69   true when its i
4c00: 6e 70 75 74 0a 69 73 20 61 20 73 74 72 69 6e 67  nput.is a string
4c10: 2c 20 74 68 65 6e 20 74 68 65 20 61 72 67 75 6d  , then the argum
4c20: 65 6e 74 20 66 6f 72 6d 73 20 61 20 63 6f 6d 70  ent forms a comp
4c30: 6c 65 74 65 20 53 51 4c 20 73 74 61 74 65 6d 65  lete SQL stateme
4c40: 6e 74 2e 0a 54 68 65 72 65 20 61 72 65 20 6e 6f  nt..There are no
4c50: 20 67 75 61 72 61 6e 74 65 65 73 20 74 68 61 74   guarantees that
4c60: 20 74 68 65 20 73 79 6e 74 61 78 20 6f 66 20 74   the syntax of t
4c70: 68 61 74 20 73 74 61 74 65 6d 65 6e 74 20 69 73  hat statement is
4c80: 20 63 6f 72 72 65 63 74 2c 0a 62 75 74 20 77 65   correct,.but we
4c90: 20 61 74 20 6c 65 61 73 74 20 6b 6e 6f 77 20 74   at least know t
4ca0: 68 65 20 73 74 61 74 65 6d 65 6e 74 20 69 73 20  he statement is 
4cb0: 63 6f 6d 70 6c 65 74 65 2e 20 20 49 66 20 3c 62  complete.  If <b
4cc0: 3e 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74 65  >sqlite_complete
4cd0: 28 29 3c 2f 62 3e 0a 72 65 74 75 72 6e 73 20 66  ()</b>.returns f
4ce0: 61 6c 73 65 2c 20 74 68 65 6e 20 6d 6f 72 65 20  alse, then more 
4cf0: 74 65 78 74 20 69 73 20 72 65 71 75 69 72 65 64  text is required
4d00: 20 74 6f 20 63 6f 6d 70 6c 65 74 65 20 74 68 65   to complete the
4d10: 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2e 3c   SQL statement.<
4d20: 2f 70 3e 0a 0a 3c 70 3e 46 6f 72 20 74 68 65 20  /p>..<p>For the 
4d30: 70 75 72 70 6f 73 65 20 6f 66 20 74 68 65 20 3c  purpose of the <
4d40: 62 3e 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74  b>sqlite_complet
4d50: 65 28 29 3c 2f 62 3e 20 66 75 6e 63 74 69 6f 6e  e()</b> function
4d60: 2c 20 61 6e 20 53 51 4c 0a 73 74 61 74 65 6d 65  , an SQL.stateme
4d70: 6e 74 20 69 73 20 63 6f 6d 70 6c 65 74 65 20 69  nt is complete i
4d80: 66 20 69 74 20 65 6e 64 73 20 69 6e 20 61 20 73  f it ends in a s
4d90: 65 6d 69 63 6f 6c 6f 6e 2e 3c 2f 70 3e 0a 0a 3c  emicolon.</p>..<
4da0: 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69 74 65 3c  p>The <b>sqlite<
4db0: 2f 62 3e 20 63 6f 6d 6d 61 6e 64 2d 6c 69 6e 65  /b> command-line
4dc0: 20 75 74 69 6c 69 74 79 20 75 73 65 73 20 74 68   utility uses th
4dd0: 65 20 3c 62 3e 73 71 6c 69 74 65 5f 63 6f 6d 70  e <b>sqlite_comp
4de0: 6c 65 74 65 28 29 3c 2f 62 3e 0a 66 75 6e 63 74  lete()</b>.funct
4df0: 69 6f 6e 20 74 6f 20 6b 6e 6f 77 20 77 68 65 6e  ion to know when
4e00: 20 69 74 20 6e 65 65 64 73 20 74 6f 20 63 61 6c   it needs to cal
4e10: 6c 20 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65 63  l <b>sqlite_exec
4e20: 28 29 3c 2f 62 3e 2e 20 20 41 66 74 65 72 20 65  ()</b>.  After e
4e30: 61 63 68 0a 6c 69 6e 65 20 6f 66 20 69 6e 70 75  ach.line of inpu
4e40: 74 20 69 73 20 72 65 63 65 69 76 65 64 2c 20 3c  t is received, <
4e50: 62 3e 73 71 6c 69 74 65 3c 2f 62 3e 20 63 61 6c  b>sqlite</b> cal
4e60: 6c 73 20 3c 62 3e 73 71 6c 69 74 65 5f 63 6f 6d  ls <b>sqlite_com
4e70: 70 6c 65 74 65 28 29 3c 2f 62 3e 0a 6f 6e 20 61  plete()</b>.on a
4e80: 6c 6c 20 69 6e 70 75 74 20 69 6e 20 69 74 73 20  ll input in its 
4e90: 62 75 66 66 65 72 2e 20 20 49 66 20 3c 62 3e 73  buffer.  If <b>s
4ea0: 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74 65 28 29  qlite_complete()
4eb0: 3c 2f 62 3e 20 72 65 74 75 72 6e 73 20 74 72 75  </b> returns tru
4ec0: 65 2c 20 0a 74 68 65 6e 20 3c 62 3e 73 71 6c 69  e, .then <b>sqli
4ed0: 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e 20 69 73  te_exec()</b> is
4ee0: 20 63 61 6c 6c 65 64 20 61 6e 64 20 74 68 65 20   called and the 
4ef0: 69 6e 70 75 74 20 62 75 66 66 65 72 20 69 73 20  input buffer is 
4f00: 72 65 73 65 74 2e 20 20 49 66 0a 3c 62 3e 73 71  reset.  If.<b>sq
4f10: 6c 69 74 65 5f 63 6f 6d 70 6c 65 74 65 28 29 3c  lite_complete()<
4f20: 2f 62 3e 20 72 65 74 75 72 6e 73 20 66 61 6c 73  /b> returns fals
4f30: 65 2c 20 74 68 65 6e 20 74 68 65 20 70 72 6f 6d  e, then the prom
4f40: 70 74 20 69 73 20 63 68 61 6e 67 65 64 20 74 6f  pt is changed to
4f50: 0a 74 68 65 20 63 6f 6e 74 69 6e 75 61 74 69 6f  .the continuatio
4f60: 6e 20 70 72 6f 6d 70 74 20 61 6e 64 20 61 6e 6f  n prompt and ano
4f70: 74 68 65 72 20 6c 69 6e 65 20 6f 66 20 74 65 78  ther line of tex
4f80: 74 20 69 73 20 72 65 61 64 20 61 6e 64 20 61 64  t is read and ad
4f90: 64 65 64 20 74 6f 0a 74 68 65 20 69 6e 70 75 74  ded to.the input
4fa0: 20 62 75 66 66 65 72 2e 3c 2f 70 3e 0a 0a 3c 68   buffer.</p>..<h
4fb0: 32 3e 4c 69 62 72 61 72 79 20 76 65 72 73 69 6f  2>Library versio
4fc0: 6e 20 73 74 72 69 6e 67 3c 2f 68 32 3e 0a 0a 3c  n string</h2>..<
4fd0: 70 3e 54 68 65 20 53 51 4c 69 74 65 20 6c 69 62  p>The SQLite lib
4fe0: 72 61 72 79 20 65 78 70 6f 72 74 73 20 74 68 65  rary exports the
4ff0: 20 73 74 72 69 6e 67 20 63 6f 6e 73 74 61 6e 74   string constant
5000: 20 6e 61 6d 65 64 0a 3c 62 3e 73 71 6c 69 74 65   named.<b>sqlite
5010: 5f 76 65 72 73 69 6f 6e 3c 2f 62 3e 20 77 68 69  _version</b> whi
5020: 63 68 20 63 6f 6e 74 61 69 6e 73 20 74 68 65 20  ch contains the 
5030: 76 65 72 73 69 6f 6e 20 6e 75 6d 62 65 72 20 6f  version number o
5040: 66 20 74 68 65 0a 6c 69 62 72 61 72 79 2e 20 20  f the.library.  
5050: 54 68 65 20 68 65 61 64 65 72 20 66 69 6c 65 20  The header file 
5060: 63 6f 6e 74 61 69 6e 73 20 61 20 6d 61 63 72 6f  contains a macro
5070: 20 53 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e 0a   SQLITE_VERSION.
5080: 77 69 74 68 20 74 68 65 20 73 61 6d 65 20 69 6e  with the same in
5090: 66 6f 72 6d 61 74 69 6f 6e 2e 20 20 49 66 20 64  formation.  If d
50a0: 65 73 69 72 65 64 2c 20 61 20 70 72 6f 67 72 61  esired, a progra
50b0: 6d 20 63 61 6e 20 63 6f 6d 70 61 72 65 0a 74 68  m can compare.th
50c0: 65 20 53 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e  e SQLITE_VERSION
50d0: 20 6d 61 63 72 6f 20 61 67 61 69 6e 73 74 20 74   macro against t
50e0: 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 76 65 72  he <b>sqlite_ver
50f0: 73 69 6f 6e 3c 2f 62 3e 0a 73 74 72 69 6e 67 20  sion</b>.string 
5100: 63 6f 6e 73 74 61 6e 74 20 74 6f 20 76 65 72 69  constant to veri
5110: 66 79 20 74 68 61 74 20 74 68 65 20 76 65 72 73  fy that the vers
5120: 69 6f 6e 20 6e 75 6d 62 65 72 20 6f 66 20 74 68  ion number of th
5130: 65 0a 68 65 61 64 65 72 20 66 69 6c 65 20 61 6e  e.header file an
5140: 64 20 74 68 65 20 6c 69 62 72 61 72 79 20 6d 61  d the library ma
5150: 74 63 68 2e 3c 2f 70 3e 20 0a 0a 3c 68 32 3e 4c  tch.</p> ..<h2>L
5160: 69 62 72 61 72 79 20 63 68 61 72 61 63 74 65 72  ibrary character
5170: 20 65 6e 63 6f 64 69 6e 67 3c 2f 68 32 3e 0a 0a   encoding</h2>..
5180: 3c 70 3e 42 79 20 64 65 66 61 75 6c 74 2c 20 53  <p>By default, S
5190: 51 4c 69 74 65 20 61 73 73 75 6d 65 73 20 74 68  QLite assumes th
51a0: 61 74 20 61 6c 6c 20 64 61 74 61 20 75 73 65 73  at all data uses
51b0: 20 61 20 66 69 78 65 64 2d 73 69 7a 65 0a 38 2d   a fixed-size.8-
51c0: 62 69 74 20 63 68 61 72 61 63 74 65 72 20 28 69  bit character (i
51d0: 73 6f 38 38 35 39 29 2e 20 20 42 75 74 20 69 66  so8859).  But if
51e0: 20 79 6f 75 20 67 69 76 65 20 74 68 65 20 2d 2d   you give the --
51f0: 65 6e 61 62 6c 65 2d 75 74 66 38 20 6f 70 74 69  enable-utf8 opti
5200: 6f 6e 0a 74 6f 20 74 68 65 20 63 6f 6e 66 69 67  on.to the config
5210: 75 72 65 20 73 63 72 69 70 74 2c 20 74 68 65 6e  ure script, then
5220: 20 74 68 65 20 6c 69 62 72 61 72 79 20 61 73 73   the library ass
5230: 75 6d 65 73 20 55 54 46 2d 38 20 76 61 72 69 61  umes UTF-8 varia
5240: 62 6c 65 0a 73 69 7a 65 64 20 63 68 61 72 61 63  ble.sized charac
5250: 74 65 72 73 2e 20 20 54 68 69 73 20 6d 61 6b 65  ters.  This make
5260: 73 20 61 20 64 69 66 66 65 72 65 6e 63 65 20 66  s a difference f
5270: 6f 72 20 74 68 65 20 4c 49 4b 45 20 61 6e 64 20  or the LIKE and 
5280: 47 4c 4f 42 0a 6f 70 65 72 61 74 6f 72 73 20 61  GLOB.operators a
5290: 6e 64 20 74 68 65 20 4c 45 4e 47 54 48 28 29 20  nd the LENGTH() 
52a0: 61 6e 64 20 53 55 42 53 54 52 28 29 20 66 75 6e  and SUBSTR() fun
52b0: 63 74 69 6f 6e 73 2e 20 20 54 68 65 20 73 74 61  ctions.  The sta
52c0: 74 69 63 0a 73 74 72 69 6e 67 20 3c 62 3e 73 71  tic.string <b>sq
52d0: 6c 69 74 65 5f 65 6e 63 6f 64 69 6e 67 3c 2f 62  lite_encoding</b
52e0: 3e 20 77 69 6c 6c 20 62 65 20 73 65 74 20 74 6f  > will be set to
52f0: 20 65 69 74 68 65 72 20 22 55 54 46 2d 38 22 20   either "UTF-8" 
5300: 6f 72 0a 22 69 73 6f 38 38 35 39 22 20 74 6f 20  or."iso8859" to 
5310: 69 6e 64 69 63 61 74 65 20 68 6f 77 20 74 68 65  indicate how the
5320: 20 6c 69 62 72 61 72 79 20 77 61 73 20 63 6f 6d   library was com
5330: 70 69 6c 65 64 2e 20 20 49 6e 20 61 64 64 69 74  piled.  In addit
5340: 69 6f 6e 2c 0a 74 68 65 20 3c 62 3e 73 71 6c 69  ion,.the <b>sqli
5350: 74 65 2e 68 3c 2f 62 3e 20 68 65 61 64 65 72 20  te.h</b> header 
5360: 66 69 6c 65 20 77 69 6c 6c 20 64 65 66 69 6e 65  file will define
5370: 20 6f 6e 65 20 6f 66 20 74 68 65 0a 6d 61 63 72   one of the.macr
5380: 6f 73 20 3c 62 3e 53 51 4c 49 54 45 5f 55 54 46  os <b>SQLITE_UTF
5390: 38 3c 2f 62 3e 20 6f 72 20 3c 62 3e 53 51 4c 49  8</b> or <b>SQLI
53a0: 54 45 5f 49 53 4f 38 38 35 39 3c 2f 62 3e 2c 20  TE_ISO8859</b>, 
53b0: 61 73 20 61 70 70 72 6f 70 72 69 61 74 65 2e 3c  as appropriate.<
53c0: 2f 70 3e 0a 0a 3c 70 3e 4e 6f 74 65 20 74 68 61  /p>..<p>Note tha
53d0: 74 20 74 68 65 20 63 68 61 72 61 63 74 65 72 20  t the character 
53e0: 65 6e 63 6f 64 69 6e 67 20 6d 65 63 68 61 6e 69  encoding mechani
53f0: 73 6d 20 75 73 65 64 20 62 79 20 53 51 4c 69 74  sm used by SQLit
5400: 65 20 63 61 6e 6e 6f 74 0a 62 65 20 63 68 61 6e  e cannot.be chan
5410: 67 65 64 20 61 74 20 72 75 6e 2d 74 69 6d 65 2e  ged at run-time.
5420: 20 20 54 68 69 73 20 69 73 20 61 20 63 6f 6d 70    This is a comp
5430: 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20  ile-time option 
5440: 6f 6e 6c 79 2e 20 20 54 68 65 0a 3c 62 3e 73 71  only.  The.<b>sq
5450: 6c 69 74 65 5f 65 6e 63 6f 64 69 6e 67 3c 2f 62  lite_encoding</b
5460: 3e 20 63 68 61 72 61 63 74 65 72 20 73 74 72 69  > character stri
5470: 6e 67 20 6a 75 73 74 20 74 65 6c 6c 73 20 79 6f  ng just tells yo
5480: 75 20 68 6f 77 20 74 68 65 20 6c 69 62 72 61 72  u how the librar
5490: 79 0a 77 61 73 20 63 6f 6d 70 69 6c 65 64 2e 3c  y.was compiled.<
54a0: 2f 70 3e 0a 0a 3c 68 32 3e 43 68 61 6e 67 69 6e  /p>..<h2>Changin
54b0: 67 20 74 68 65 20 6c 69 62 72 61 72 79 27 73 20  g the library's 
54c0: 72 65 73 70 6f 6e 73 65 20 74 6f 20 6c 6f 63 6b  response to lock
54d0: 65 64 20 66 69 6c 65 73 3c 2f 68 32 3e 0a 0a 3c  ed files</h2>..<
54e0: 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f  p>The <b>sqlite_
54f0: 62 75 73 79 5f 68 61 6e 64 6c 65 72 28 29 3c 2f  busy_handler()</
5500: 62 3e 20 70 72 6f 63 65 64 75 72 65 20 63 61 6e  b> procedure can
5510: 20 62 65 20 75 73 65 64 20 74 6f 20 72 65 67 69   be used to regi
5520: 73 74 65 72 0a 61 20 62 75 73 79 20 63 61 6c 6c  ster.a busy call
5530: 62 61 63 6b 20 77 69 74 68 20 61 6e 20 6f 70 65  back with an ope
5540: 6e 20 53 51 4c 69 74 65 20 64 61 74 61 62 61 73  n SQLite databas
5550: 65 2e 20 20 54 68 65 20 62 75 73 79 20 63 61 6c  e.  The busy cal
5560: 6c 62 61 63 6b 20 77 69 6c 6c 0a 62 65 20 69 6e  lback will.be in
5570: 76 6f 6b 65 64 20 77 68 65 6e 65 76 65 72 20 53  voked whenever S
5580: 51 4c 69 74 65 20 74 72 69 65 73 20 74 6f 20 61  QLite tries to a
5590: 63 63 65 73 73 20 61 20 64 61 74 61 62 61 73 65  ccess a database
55a0: 20 74 68 61 74 20 69 73 20 6c 6f 63 6b 65 64 2e   that is locked.
55b0: 0a 54 68 65 20 63 61 6c 6c 62 61 63 6b 20 77 69  .The callback wi
55c0: 6c 6c 20 74 79 70 69 63 61 6c 6c 79 20 64 6f 20  ll typically do 
55d0: 73 6f 6d 65 20 6f 74 68 65 72 20 75 73 65 66 75  some other usefu
55e0: 6c 20 77 6f 72 6b 2c 20 6f 72 20 70 65 72 68 61  l work, or perha
55f0: 70 73 20 73 6c 65 65 70 2c 0a 69 6e 20 6f 72 64  ps sleep,.in ord
5600: 65 72 20 74 6f 20 67 69 76 65 20 74 68 65 20 6c  er to give the l
5610: 6f 63 6b 20 61 20 63 68 61 6e 63 65 20 74 6f 20  ock a chance to 
5620: 63 6c 65 61 72 2e 20 20 49 66 20 74 68 65 20 63  clear.  If the c
5630: 61 6c 6c 62 61 63 6b 20 72 65 74 75 72 6e 73 0a  allback returns.
5640: 6e 6f 6e 2d 7a 65 72 6f 2c 20 74 68 65 6e 20 53  non-zero, then S
5650: 51 4c 69 74 65 20 74 72 69 65 73 20 61 67 61 69  QLite tries agai
5660: 6e 20 74 6f 20 61 63 63 65 73 73 20 74 68 65 20  n to access the 
5670: 64 61 74 61 62 61 73 65 20 61 6e 64 20 74 68 65  database and the
5680: 20 63 79 63 6c 65 0a 72 65 70 65 61 74 73 2e 20   cycle.repeats. 
5690: 20 49 66 20 74 68 65 20 63 61 6c 6c 62 61 63 6b   If the callback
56a0: 20 72 65 74 75 72 6e 73 20 7a 65 72 6f 2c 20 74   returns zero, t
56b0: 68 65 6e 20 53 51 4c 69 74 65 20 61 62 6f 72 74  hen SQLite abort
56c0: 73 20 74 68 65 20 63 75 72 72 65 6e 74 0a 6f 70  s the current.op
56d0: 65 72 61 74 69 6f 6e 20 61 6e 64 20 72 65 74 75  eration and retu
56e0: 72 6e 73 20 53 51 4c 49 54 45 5f 42 55 53 59 2e  rns SQLITE_BUSY.
56f0: 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 61 72 67  </p>..<p>The arg
5700: 75 6d 65 6e 74 73 20 74 6f 20 3c 62 3e 73 71 6c  uments to <b>sql
5710: 69 74 65 5f 62 75 73 79 5f 68 61 6e 64 6c 65 72  ite_busy_handler
5720: 28 29 3c 2f 62 3e 20 61 72 65 20 74 68 65 20 6f  ()</b> are the o
5730: 70 61 71 75 65 0a 73 74 72 75 63 74 75 72 65 20  paque.structure 
5740: 72 65 74 75 72 6e 65 64 20 66 72 6f 6d 20 3c 62  returned from <b
5750: 3e 73 71 6c 69 74 65 5f 6f 70 65 6e 28 29 3c 2f  >sqlite_open()</
5760: 62 3e 2c 20 61 20 70 6f 69 6e 74 65 72 20 74 6f  b>, a pointer to
5770: 20 74 68 65 20 62 75 73 79 0a 63 61 6c 6c 62 61   the busy.callba
5780: 63 6b 20 66 75 6e 63 74 69 6f 6e 2c 20 61 6e 64  ck function, and
5790: 20 61 20 67 65 6e 65 72 69 63 20 70 6f 69 6e 74   a generic point
57a0: 65 72 20 74 68 61 74 20 77 69 6c 6c 20 62 65 20  er that will be 
57b0: 70 61 73 73 65 64 20 61 73 0a 74 68 65 20 66 69  passed as.the fi
57c0: 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f 20  rst argument to 
57d0: 74 68 65 20 62 75 73 79 20 63 61 6c 6c 62 61 63  the busy callbac
57e0: 6b 2e 20 20 57 68 65 6e 20 53 51 4c 69 74 65 20  k.  When SQLite 
57f0: 69 6e 76 6f 6b 65 73 20 74 68 65 0a 62 75 73 79  invokes the.busy
5800: 20 63 61 6c 6c 62 61 63 6b 2c 20 69 74 20 73 65   callback, it se
5810: 6e 64 73 20 69 74 20 74 68 72 65 65 20 61 72 67  nds it three arg
5820: 75 6d 65 6e 74 73 3a 20 20 74 68 65 20 67 65 6e  uments:  the gen
5830: 65 72 69 63 20 70 6f 69 6e 74 65 72 0a 74 68 61  eric pointer.tha
5840: 74 20 77 61 73 20 70 61 73 73 65 64 20 69 6e 20  t was passed in 
5850: 61 73 20 74 68 65 20 74 68 69 72 64 20 61 72 67  as the third arg
5860: 75 6d 65 6e 74 20 74 6f 20 3c 62 3e 73 71 6c 69  ument to <b>sqli
5870: 74 65 5f 62 75 73 79 5f 68 61 6e 64 6c 65 72 3c  te_busy_handler<
5880: 2f 62 3e 2c 0a 74 68 65 20 6e 61 6d 65 20 6f 66  /b>,.the name of
5890: 20 74 68 65 20 64 61 74 61 62 61 73 65 20 74 61   the database ta
58a0: 62 6c 65 20 6f 72 20 69 6e 64 65 78 20 74 68 61  ble or index tha
58b0: 74 20 74 68 65 20 6c 69 62 72 61 72 79 20 69 73  t the library is
58c0: 20 74 72 79 69 6e 67 0a 74 6f 20 61 63 63 65 73   trying.to acces
58d0: 73 2c 20 61 6e 64 20 74 68 65 20 6e 75 6d 62 65  s, and the numbe
58e0: 72 20 6f 66 20 74 69 6d 65 73 20 74 68 61 74 20  r of times that 
58f0: 74 68 65 20 6c 69 62 72 61 72 79 20 68 61 73 20  the library has 
5900: 61 74 74 65 6d 70 74 65 64 20 74 6f 0a 61 63 63  attempted to.acc
5910: 65 73 73 20 74 68 65 20 64 61 74 61 62 61 73 65  ess the database
5920: 20 74 61 62 6c 65 20 6f 72 20 69 6e 64 65 78 2e   table or index.
5930: 3c 2f 70 3e 0a 0a 3c 70 3e 46 6f 72 20 74 68 65  </p>..<p>For the
5940: 20 63 6f 6d 6d 6f 6e 20 63 61 73 65 20 77 68 65   common case whe
5950: 72 65 20 77 65 20 77 61 6e 74 20 74 68 65 20 62  re we want the b
5960: 75 73 79 20 63 61 6c 6c 62 61 63 6b 20 74 6f 20  usy callback to 
5970: 73 6c 65 65 70 2c 0a 74 68 65 20 53 51 4c 69 74  sleep,.the SQLit
5980: 65 20 6c 69 62 72 61 72 79 20 70 72 6f 76 69 64  e library provid
5990: 65 73 20 61 20 63 6f 6e 76 65 6e 69 65 6e 63 65  es a convenience
59a0: 20 72 6f 75 74 69 6e 65 20 3c 62 3e 73 71 6c 69   routine <b>sqli
59b0: 74 65 5f 62 75 73 79 5f 74 69 6d 65 6f 75 74 28  te_busy_timeout(
59c0: 29 3c 2f 62 3e 2e 0a 54 68 65 20 66 69 72 73 74  )</b>..The first
59d0: 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 3c 62 3e   argument to <b>
59e0: 73 71 6c 69 74 65 5f 62 75 73 79 5f 74 69 6d 65  sqlite_busy_time
59f0: 6f 75 74 28 29 3c 2f 62 3e 20 69 73 20 61 20 70  out()</b> is a p
5a00: 6f 69 6e 74 65 72 20 74 6f 0a 61 6e 20 6f 70 65  ointer to.an ope
5a10: 6e 20 53 51 4c 69 74 65 20 64 61 74 61 62 61 73  n SQLite databas
5a20: 65 20 61 6e 64 20 74 68 65 20 73 65 63 6f 6e 64  e and the second
5a30: 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 20 6e   argument is a n
5a40: 75 6d 62 65 72 20 6f 66 20 6d 69 6c 6c 69 73 65  umber of millise
5a50: 63 6f 6e 64 73 2e 0a 41 66 74 65 72 20 3c 62 3e  conds..After <b>
5a60: 73 71 6c 69 74 65 5f 62 75 73 79 5f 74 69 6d 65  sqlite_busy_time
5a70: 6f 75 74 28 29 3c 2f 62 3e 20 68 61 73 20 62 65  out()</b> has be
5a80: 65 6e 20 65 78 65 63 75 74 65 64 2c 20 74 68 65  en executed, the
5a90: 20 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79 0a   SQLite library.
5aa0: 77 69 6c 6c 20 77 61 69 74 20 66 6f 72 20 74 68  will wait for th
5ab0: 65 20 6c 6f 63 6b 20 74 6f 20 63 6c 65 61 72 20  e lock to clear 
5ac0: 66 6f 72 20 61 74 20 6c 65 61 73 74 20 74 68 65  for at least the
5ad0: 20 6e 75 6d 62 65 72 20 6f 66 20 6d 69 6c 6c 69   number of milli
5ae0: 73 65 63 6f 6e 64 73 20 0a 73 70 65 63 69 66 69  seconds .specifi
5af0: 65 64 20 62 65 66 6f 72 65 20 69 74 20 72 65 74  ed before it ret
5b00: 75 72 6e 73 20 53 51 4c 49 54 45 5f 42 55 53 59  urns SQLITE_BUSY
5b10: 2e 20 20 53 70 65 63 69 66 79 69 6e 67 20 7a 65  .  Specifying ze
5b20: 72 6f 20 6d 69 6c 6c 69 73 65 63 6f 6e 64 73 20  ro milliseconds 
5b30: 66 6f 72 0a 74 68 65 20 74 69 6d 65 6f 75 74 20  for.the timeout 
5b40: 72 65 73 74 6f 72 65 73 20 74 68 65 20 64 65 66  restores the def
5b50: 61 75 6c 74 20 62 65 68 61 76 69 6f 72 2e 3c 2f  ault behavior.</
5b60: 70 3e 0a 0a 3c 68 32 3e 55 73 69 6e 67 20 74 68  p>..<h2>Using th
5b70: 65 20 3c 74 74 3e 5f 70 72 69 6e 74 66 28 29 3c  e <tt>_printf()<
5b80: 2f 74 74 3e 20 77 72 61 70 70 65 72 20 66 75 6e  /tt> wrapper fun
5b90: 63 74 69 6f 6e 73 3c 2f 68 32 3e 0a 0a 3c 70 3e  ctions</h2>..<p>
5ba0: 54 68 65 20 66 6f 75 72 20 75 74 69 6c 69 74 79  The four utility
5bb0: 20 66 75 6e 63 74 69 6f 6e 73 3c 2f 70 3e 0a 0a   functions</p>..
5bc0: 3c 70 3e 0a 3c 75 6c 3e 0a 3c 6c 69 3e 3c 62 3e  <p>.<ul>.<li><b>
5bd0: 73 71 6c 69 74 65 5f 65 78 65 63 5f 70 72 69 6e  sqlite_exec_prin
5be0: 74 66 28 29 3c 2f 62 3e 3c 2f 6c 69 3e 0a 3c 6c  tf()</b></li>.<l
5bf0: 69 3e 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65 63  i><b>sqlite_exec
5c00: 5f 76 70 72 69 6e 74 66 28 29 3c 2f 62 3e 3c 2f  _vprintf()</b></
5c10: 6c 69 3e 0a 3c 6c 69 3e 3c 62 3e 73 71 6c 69 74  li>.<li><b>sqlit
5c20: 65 5f 67 65 74 5f 74 61 62 6c 65 5f 70 72 69 6e  e_get_table_prin
5c30: 74 66 28 29 3c 2f 62 3e 3c 2f 6c 69 3e 0a 3c 6c  tf()</b></li>.<l
5c40: 69 3e 3c 62 3e 73 71 6c 69 74 65 5f 67 65 74 5f  i><b>sqlite_get_
5c50: 74 61 62 6c 65 5f 76 70 72 69 6e 74 66 28 29 3c  table_vprintf()<
5c60: 2f 62 3e 3c 2f 6c 69 3e 0a 3c 2f 75 6c 3e 0a 3c  /b></li>.</ul>.<
5c70: 2f 70 3e 0a 0a 3c 70 3e 69 6d 70 6c 65 6d 65 6e  /p>..<p>implemen
5c80: 74 20 74 68 65 20 73 61 6d 65 20 71 75 65 72 79  t the same query
5c90: 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74 79 20 61   functionality a
5ca0: 73 20 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65 63  s <b>sqlite_exec
5cb0: 28 29 3c 2f 62 3e 0a 61 6e 64 20 3c 62 3e 73 71  ()</b>.and <b>sq
5cc0: 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 28 29  lite_get_table()
5cd0: 3c 2f 62 3e 2e 20 20 42 75 74 20 69 6e 73 74 65  </b>.  But inste
5ce0: 61 64 20 6f 66 20 74 61 6b 69 6e 67 20 61 20 63  ad of taking a c
5cf0: 6f 6d 70 6c 65 74 65 0a 53 51 4c 20 73 74 61 74  omplete.SQL stat
5d00: 65 6d 65 6e 74 20 61 73 20 74 68 65 69 72 20 73  ement as their s
5d10: 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 2c 20  econd argument, 
5d20: 74 68 65 20 66 6f 75 72 20 3c 62 3e 5f 70 72 69  the four <b>_pri
5d30: 6e 74 66 3c 2f 62 3e 0a 72 6f 75 74 69 6e 65 73  ntf</b>.routines
5d40: 20 74 61 6b 65 20 61 20 70 72 69 6e 74 66 2d 73   take a printf-s
5d50: 74 79 6c 65 20 66 6f 72 6d 61 74 20 73 74 72 69  tyle format stri
5d60: 6e 67 2e 20 20 54 68 65 20 53 51 4c 20 73 74 61  ng.  The SQL sta
5d70: 74 65 6d 65 6e 74 20 74 6f 0a 62 65 20 65 78 65  tement to.be exe
5d80: 63 75 74 65 64 20 69 73 20 67 65 6e 65 72 61 74  cuted is generat
5d90: 65 64 20 66 72 6f 6d 20 74 68 69 73 20 66 6f 72  ed from this for
5da0: 6d 61 74 20 73 74 72 69 6e 67 20 61 6e 64 20 66  mat string and f
5db0: 72 6f 6d 20 77 68 61 74 65 76 65 72 0a 61 64 64  rom whatever.add
5dc0: 69 74 69 6f 6e 61 6c 20 61 72 67 75 6d 65 6e 74  itional argument
5dd0: 73 20 61 72 65 20 61 74 74 61 63 68 65 64 20 74  s are attached t
5de0: 6f 20 74 68 65 20 65 6e 64 20 6f 66 20 74 68 65  o the end of the
5df0: 20 66 75 6e 63 74 69 6f 6e 20 63 61 6c 6c 2e 3c   function call.<
5e00: 2f 70 3e 0a 0a 3c 70 3e 54 68 65 72 65 20 61 72  /p>..<p>There ar
5e10: 65 20 74 77 6f 20 61 64 76 61 6e 74 61 67 65 73  e two advantages
5e20: 20 74 6f 20 75 73 69 6e 67 20 74 68 65 20 53 51   to using the SQ
5e30: 4c 69 74 65 20 70 72 69 6e 74 66 0a 66 75 6e 63  Lite printf.func
5e40: 74 69 6f 6e 73 20 69 6e 73 74 65 61 64 20 6f 66  tions instead of
5e50: 20 3c 62 3e 73 70 72 69 6e 74 66 28 29 3c 2f 62   <b>sprintf()</b
5e60: 3e 2e 20 20 46 69 72 73 74 20 6f 66 20 61 6c 6c  >.  First of all
5e70: 2c 20 77 69 74 68 20 74 68 65 0a 53 51 4c 69 74  , with the.SQLit
5e80: 65 20 70 72 69 6e 74 66 20 72 6f 75 74 69 6e 65  e printf routine
5e90: 73 2c 20 74 68 65 72 65 20 69 73 20 6e 65 76 65  s, there is neve
5ea0: 72 20 61 20 64 61 6e 67 65 72 20 6f 66 20 6f 76  r a danger of ov
5eb0: 65 72 66 6c 6f 77 69 6e 67 20 61 0a 73 74 61 74  erflowing a.stat
5ec0: 69 63 20 62 75 66 66 65 72 20 61 73 20 74 68 65  ic buffer as the
5ed0: 72 65 20 69 73 20 77 69 74 68 20 3c 62 3e 73 70  re is with <b>sp
5ee0: 72 69 6e 74 66 28 29 3c 2f 62 3e 2e 20 20 54 68  rintf()</b>.  Th
5ef0: 65 20 53 51 4c 69 74 65 0a 70 72 69 6e 74 66 20  e SQLite.printf 
5f00: 72 6f 75 74 69 6e 65 73 20 61 75 74 6f 6d 61 74  routines automat
5f10: 69 63 61 6c 6c 79 20 61 6c 6c 6f 63 61 74 65 20  ically allocate 
5f20: 28 61 6e 64 20 6c 61 74 65 72 20 66 72 65 65 29  (and later free)
5f30: 0a 61 73 20 6d 75 63 68 20 6d 65 6d 6f 72 79 20  .as much memory 
5f40: 61 73 20 69 73 20 0a 6e 65 63 65 73 73 61 72 79  as is .necessary
5f50: 20 74 6f 20 68 6f 6c 64 20 74 68 65 20 53 51 4c   to hold the SQL
5f60: 20 73 74 61 74 65 6d 65 6e 74 73 20 67 65 6e 65   statements gene
5f70: 72 61 74 65 64 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54  rated.</p>..<p>T
5f80: 68 65 20 73 65 63 6f 6e 64 20 61 64 76 61 6e 74  he second advant
5f90: 61 67 65 20 74 68 65 20 53 51 4c 69 74 65 20 70  age the SQLite p
5fa0: 72 69 6e 74 66 20 72 6f 75 74 69 6e 65 73 20 68  rintf routines h
5fb0: 61 76 65 20 6f 76 65 72 0a 3c 62 3e 73 70 72 69  ave over.<b>spri
5fc0: 6e 74 66 28 29 3c 2f 62 3e 20 61 72 65 20 74 77  ntf()</b> are tw
5fd0: 6f 20 6e 65 77 20 66 6f 72 6d 61 74 74 69 6e 67  o new formatting
5fe0: 20 6f 70 74 69 6f 6e 73 20 73 70 65 63 69 66 69   options specifi
5ff0: 63 61 6c 6c 79 20 64 65 73 69 67 6e 65 64 0a 74  cally designed.t
6000: 6f 20 73 75 70 70 6f 72 74 20 73 74 72 69 6e 67  o support string
6010: 20 6c 69 74 65 72 61 6c 73 20 69 6e 20 53 51 4c   literals in SQL
6020: 2e 20 20 57 69 74 68 69 6e 20 74 68 65 20 66 6f  .  Within the fo
6030: 72 6d 61 74 20 73 74 72 69 6e 67 2c 0a 74 68 65  rmat string,.the
6040: 20 25 71 20 66 6f 72 6d 61 74 74 69 6e 67 20 6f   %q formatting o
6050: 70 74 69 6f 6e 20 77 6f 72 6b 73 20 76 65 72 79  ption works very
6060: 20 6d 75 63 68 20 6c 69 6b 65 20 25 73 20 69 6e   much like %s in
6070: 20 74 68 61 74 20 69 74 0a 72 65 61 64 73 20 61   that it.reads a
6080: 20 6e 75 6c 6c 2d 74 65 72 6d 69 6e 61 74 65 64   null-terminated
6090: 20 73 74 72 69 6e 67 20 66 72 6f 6d 20 74 68 65   string from the
60a0: 20 61 72 67 75 6d 65 6e 74 20 6c 69 73 74 20 61   argument list a
60b0: 6e 64 20 69 6e 73 65 72 74 73 0a 69 74 20 69 6e  nd inserts.it in
60c0: 74 6f 20 74 68 65 20 72 65 73 75 6c 74 2e 20 20  to the result.  
60d0: 42 75 74 20 25 71 20 74 72 61 6e 73 6c 61 74 65  But %q translate
60e0: 73 20 74 68 65 20 69 6e 73 65 72 74 65 64 20 73  s the inserted s
60f0: 74 72 69 6e 67 20 62 79 0a 6d 61 6b 69 6e 67 20  tring by.making 
6100: 74 77 6f 20 63 6f 70 69 65 73 20 6f 66 20 65 76  two copies of ev
6110: 65 72 79 20 73 69 6e 67 6c 65 2d 71 75 6f 74 65  ery single-quote
6120: 20 28 27 29 20 63 68 61 72 61 63 74 65 72 20 69   (') character i
6130: 6e 20 74 68 65 0a 73 75 62 73 74 69 74 75 74 65  n the.substitute
6140: 64 20 73 74 72 69 6e 67 2e 20 20 54 68 69 73 20  d string.  This 
6150: 68 61 73 20 74 68 65 20 65 66 66 65 63 74 20 6f  has the effect o
6160: 66 20 65 73 63 61 70 69 6e 67 20 74 68 65 20 65  f escaping the e
6170: 6e 64 2d 6f 66 2d 73 74 72 69 6e 67 0a 6d 65 61  nd-of-string.mea
6180: 6e 69 6e 67 20 6f 66 20 73 69 6e 67 6c 65 2d 71  ning of single-q
6190: 75 6f 74 65 20 77 69 74 68 69 6e 20 61 20 73 74  uote within a st
61a0: 72 69 6e 67 20 6c 69 74 65 72 61 6c 2e 20 54 68  ring literal. Th
61b0: 65 20 25 51 20 66 6f 72 6d 61 74 74 69 6e 67 0a  e %Q formatting.
61c0: 6f 70 74 69 6f 6e 20 77 6f 72 6b 73 20 73 69 6d  option works sim
61d0: 69 6c 61 72 3b 20 69 74 20 74 72 61 6e 73 6c 61  ilar; it transla
61e0: 74 65 73 20 74 68 65 20 73 69 6e 67 6c 65 2d 71  tes the single-q
61f0: 75 6f 74 65 73 20 6c 69 6b 65 20 25 71 20 61 6e  uotes like %q an
6200: 64 0a 61 64 64 69 74 69 6f 6e 61 6c 6c 79 20 65  d.additionally e
6210: 6e 63 6c 6f 73 65 73 20 74 68 65 20 72 65 73 75  ncloses the resu
6220: 6c 74 69 6e 67 20 73 74 72 69 6e 67 20 69 6e 20  lting string in 
6230: 73 69 6e 67 6c 65 2d 71 75 6f 74 65 73 2e 0a 49  single-quotes..I
6240: 66 20 74 68 65 20 61 72 67 75 6d 65 6e 74 20 66  f the argument f
6250: 6f 72 20 74 68 65 20 25 51 20 66 6f 72 6d 61 74  or the %Q format
6260: 74 69 6e 67 20 6f 70 74 69 6f 6e 73 20 69 73 20  ting options is 
6270: 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 2c 0a  a NULL pointer,.
6280: 74 68 65 20 72 65 73 75 6c 74 69 6e 67 20 73 74  the resulting st
6290: 72 69 6e 67 20 69 73 20 4e 55 4c 4c 20 77 69 74  ring is NULL wit
62a0: 68 6f 75 74 20 73 69 6e 67 6c 65 20 71 75 6f 74  hout single quot
62b0: 65 73 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 43 6f 6e  es..</p>..<p>Con
62c0: 73 69 64 65 72 20 61 6e 20 65 78 61 6d 70 6c 65  sider an example
62d0: 2e 20 20 53 75 70 70 6f 73 65 20 79 6f 75 20 61  .  Suppose you a
62e0: 72 65 20 74 72 79 69 6e 67 20 74 6f 20 69 6e 73  re trying to ins
62f0: 65 72 74 20 61 20 73 74 72 69 6e 67 0a 76 61 6c  ert a string.val
6300: 75 65 20 69 6e 74 6f 20 61 20 64 61 74 61 62 61  ue into a databa
6310: 73 65 20 74 61 62 6c 65 20 77 68 65 72 65 20 74  se table where t
6320: 68 65 20 73 74 72 69 6e 67 20 76 61 6c 75 65 20  he string value 
6330: 77 61 73 20 6f 62 74 61 69 6e 65 64 20 66 72 6f  was obtained fro
6340: 6d 0a 75 73 65 72 20 69 6e 70 75 74 2e 20 20 53  m.user input.  S
6350: 75 70 70 6f 73 65 20 74 68 65 20 73 74 72 69 6e  uppose the strin
6360: 67 20 74 6f 20 62 65 20 69 6e 73 65 72 74 65 64  g to be inserted
6370: 20 69 73 20 73 74 6f 72 65 64 20 69 6e 20 61 20   is stored in a 
6380: 76 61 72 69 61 62 6c 65 0a 6e 61 6d 65 64 20 7a  variable.named z
6390: 53 74 72 69 6e 67 2e 20 20 54 68 65 20 63 6f 64  String.  The cod
63a0: 65 20 74 6f 20 64 6f 20 74 68 65 20 69 6e 73 65  e to do the inse
63b0: 72 74 69 6f 6e 20 6d 69 67 68 74 20 6c 6f 6f 6b  rtion might look
63c0: 20 6c 69 6b 65 20 74 68 69 73 3a 3c 2f 70 3e 0a   like this:</p>.
63d0: 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72  .<blockquote><pr
63e0: 65 3e 0a 73 71 6c 69 74 65 5f 65 78 65 63 5f 70  e>.sqlite_exec_p
63f0: 72 69 6e 74 66 28 64 62 2c 0a 20 20 22 49 4e 53  rintf(db,.  "INS
6400: 45 52 54 20 49 4e 54 4f 20 74 61 62 6c 65 31 20  ERT INTO table1 
6410: 56 41 4c 55 45 53 28 27 25 73 27 29 22 2c 0a 20  VALUES('%s')",. 
6420: 20 30 2c 20 30 2c 20 30 2c 20 7a 53 74 72 69 6e   0, 0, 0, zStrin
6430: 67 29 3b 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63  g);.</pre></bloc
6440: 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 49 66 20 74  kquote>..<p>If t
6450: 68 65 20 7a 53 74 72 69 6e 67 20 76 61 72 69 61  he zString varia
6460: 62 6c 65 20 68 6f 6c 64 73 20 74 65 78 74 20 6c  ble holds text l
6470: 69 6b 65 20 22 48 65 6c 6c 6f 22 2c 20 74 68 65  ike "Hello", the
6480: 6e 20 74 68 69 73 20 73 74 61 74 65 6d 65 6e 74  n this statement
6490: 0a 77 69 6c 6c 20 77 6f 72 6b 20 6a 75 73 74 20  .will work just 
64a0: 66 69 6e 65 2e 20 20 42 75 74 20 73 75 70 70 6f  fine.  But suppo
64b0: 73 65 20 74 68 65 20 75 73 65 72 20 65 6e 74 65  se the user ente
64c0: 72 73 20 61 20 73 74 72 69 6e 67 20 6c 69 6b 65  rs a string like
64d0: 20 0a 22 48 69 20 79 27 61 6c 6c 21 22 2e 20 20   ."Hi y'all!".  
64e0: 54 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  The SQL statemen
64f0: 74 20 67 65 6e 65 72 61 74 65 64 20 72 65 61 64  t generated read
6500: 73 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a 0a 3c  s as follows:..<
6510: 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e  blockquote><pre>
6520: 0a 49 4e 53 45 52 54 20 49 4e 54 4f 20 74 61 62  .INSERT INTO tab
6530: 6c 65 31 20 56 41 4c 55 45 53 28 27 48 69 20 79  le1 VALUES('Hi y
6540: 27 61 6c 6c 27 29 0a 3c 2f 70 72 65 3e 3c 2f 62  'all').</pre></b
6550: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 54  lockquote>..<p>T
6560: 68 69 73 20 69 73 20 6e 6f 74 20 76 61 6c 69 64  his is not valid
6570: 20 53 51 4c 20 62 65 63 61 75 73 65 20 6f 66 20   SQL because of 
6580: 74 68 65 20 61 70 6f 73 74 72 6f 70 68 79 20 69  the apostrophy i
6590: 6e 20 74 68 65 20 77 6f 72 64 20 22 79 27 61 6c  n the word "y'al
65a0: 6c 22 2e 0a 42 75 74 20 69 66 20 74 68 65 20 25  l"..But if the %
65b0: 71 20 66 6f 72 6d 61 74 74 69 6e 67 20 6f 70 74  q formatting opt
65c0: 69 6f 6e 20 69 73 20 75 73 65 64 20 69 6e 73 74  ion is used inst
65d0: 65 61 64 20 6f 66 20 25 73 2c 20 6c 69 6b 65 20  ead of %s, like 
65e0: 74 68 69 73 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63  this:</p>..<bloc
65f0: 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 73 71 6c  kquote><pre>.sql
6600: 69 74 65 5f 65 78 65 63 5f 70 72 69 6e 74 66 28  ite_exec_printf(
6610: 64 62 2c 0a 20 20 22 49 4e 53 45 52 54 20 49 4e  db,.  "INSERT IN
6620: 54 4f 20 74 61 62 6c 65 31 20 56 41 4c 55 45 53  TO table1 VALUES
6630: 28 27 25 71 27 29 22 2c 0a 20 20 30 2c 20 30 2c  ('%q')",.  0, 0,
6640: 20 30 2c 20 7a 53 74 72 69 6e 67 29 3b 0a 3c 2f   0, zString);.</
6650: 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65  pre></blockquote
6660: 3e 0a 0a 3c 70 3e 54 68 65 6e 20 74 68 65 20 67  >..<p>Then the g
6670: 65 6e 65 72 61 74 65 64 20 53 51 4c 20 77 69 6c  enerated SQL wil
6680: 6c 20 6c 6f 6f 6b 20 6c 69 6b 65 20 74 68 65 20  l look like the 
6690: 66 6f 6c 6c 6f 77 69 6e 67 3a 3c 2f 70 3e 0a 0a  following:</p>..
66a0: 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65  <blockquote><pre
66b0: 3e 0a 49 4e 53 45 52 54 20 49 4e 54 4f 20 74 61  >.INSERT INTO ta
66c0: 62 6c 65 31 20 56 41 4c 55 45 53 28 27 48 69 20  ble1 VALUES('Hi 
66d0: 79 27 27 61 6c 6c 27 29 0a 3c 2f 70 72 65 3e 3c  y''all').</pre><
66e0: 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70  /blockquote>..<p
66f0: 3e 48 65 72 65 20 74 68 65 20 61 70 6f 73 74 72  >Here the apostr
6700: 6f 70 68 79 20 68 61 73 20 62 65 65 6e 20 65 73  ophy has been es
6710: 63 61 70 65 64 20 61 6e 64 20 74 68 65 20 53 51  caped and the SQ
6720: 4c 20 73 74 61 74 65 6d 65 6e 74 20 69 73 20 77  L statement is w
6730: 65 6c 6c 2d 66 6f 72 6d 65 64 2e 0a 57 68 65 6e  ell-formed..When
6740: 20 67 65 6e 65 72 61 74 69 6e 67 20 53 51 4c 20   generating SQL 
6750: 6f 6e 2d 74 68 65 2d 66 6c 79 20 66 72 6f 6d 20  on-the-fly from 
6760: 64 61 74 61 20 74 68 61 74 20 6d 69 67 68 74 20  data that might 
6770: 63 6f 6e 74 61 69 6e 20 61 0a 73 69 6e 67 6c 65  contain a.single
6780: 2d 71 75 6f 74 65 20 63 68 61 72 61 63 74 65 72  -quote character
6790: 20 28 27 29 2c 20 69 74 20 69 73 20 61 6c 77 61   ('), it is alwa
67a0: 79 73 20 61 20 67 6f 6f 64 20 69 64 65 61 20 74  ys a good idea t
67b0: 6f 20 75 73 65 20 74 68 65 0a 53 51 4c 69 74 65  o use the.SQLite
67c0: 20 70 72 69 6e 74 66 20 72 6f 75 74 69 6e 65 73   printf routines
67d0: 20 61 6e 64 20 74 68 65 20 25 71 20 66 6f 72 6d   and the %q form
67e0: 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e 20 69 6e  atting option in
67f0: 73 74 65 61 64 20 6f 66 20 3c 62 3e 73 70 72 69  stead of <b>spri
6800: 6e 74 66 3c 2f 62 3e 2e 0a 3c 2f 70 3e 0a 0a 3c  ntf</b>..</p>..<
6810: 70 3e 49 66 20 74 68 65 20 25 51 20 66 6f 72 6d  p>If the %Q form
6820: 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e 20 69 73  atting option is
6830: 20 75 73 65 64 20 69 6e 73 74 65 61 64 20 6f 66   used instead of
6840: 20 25 71 2c 20 6c 69 6b 65 20 74 68 69 73 3a 3c   %q, like this:<
6850: 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65  /p>..<blockquote
6860: 3e 3c 70 72 65 3e 0a 73 71 6c 69 74 65 5f 65 78  ><pre>.sqlite_ex
6870: 65 63 5f 70 72 69 6e 74 66 28 64 62 2c 0a 20 20  ec_printf(db,.  
6880: 22 49 4e 53 45 52 54 20 49 4e 54 4f 20 74 61 62  "INSERT INTO tab
6890: 6c 65 31 20 56 41 4c 55 45 53 28 25 51 29 22 2c  le1 VALUES(%Q)",
68a0: 0a 20 20 30 2c 20 30 2c 20 30 2c 20 7a 53 74 72  .  0, 0, 0, zStr
68b0: 69 6e 67 29 3b 0a 3c 2f 70 72 65 3e 3c 2f 62 6c  ing);.</pre></bl
68c0: 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 54 68  ockquote>..<p>Th
68d0: 65 6e 20 74 68 65 20 67 65 6e 65 72 61 74 65 64  en the generated
68e0: 20 53 51 4c 20 77 69 6c 6c 20 6c 6f 6f 6b 20 6c   SQL will look l
68f0: 69 6b 65 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e  ike the followin
6900: 67 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75  g:</p>..<blockqu
6910: 6f 74 65 3e 3c 70 72 65 3e 0a 49 4e 53 45 52 54  ote><pre>.INSERT
6920: 20 49 4e 54 4f 20 74 61 62 6c 65 31 20 56 41 4c   INTO table1 VAL
6930: 55 45 53 28 27 48 69 20 79 27 27 61 6c 6c 27 29  UES('Hi y''all')
6940: 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75  .</pre></blockqu
6950: 6f 74 65 3e 0a 0a 3c 70 3e 49 66 20 74 68 65 20  ote>..<p>If the 
6960: 76 61 6c 75 65 20 6f 66 20 74 68 65 20 7a 53 74  value of the zSt
6970: 72 69 6e 67 20 76 61 72 69 61 62 6c 65 20 69 73  ring variable is
6980: 20 4e 55 4c 4c 2c 20 74 68 65 20 67 65 6e 65 72   NULL, the gener
6990: 61 74 65 64 20 53 51 4c 0a 77 69 6c 6c 20 6c 6f  ated SQL.will lo
69a0: 6f 6b 20 6c 69 6b 65 20 74 68 65 20 66 6f 6c 6c  ok like the foll
69b0: 6f 77 69 6e 67 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f  owing:</p>..<blo
69c0: 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 49 4e  ckquote><pre>.IN
69d0: 53 45 52 54 20 49 4e 54 4f 20 74 61 62 6c 65 31  SERT INTO table1
69e0: 20 56 41 4c 55 45 53 28 4e 55 4c 4c 29 0a 3c 2f   VALUES(NULL).</
69f0: 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65  pre></blockquote
6a00: 3e 0a 0a 3c 70 3e 41 6c 6c 20 6f 66 20 74 68 65  >..<p>All of the
6a10: 20 5f 70 72 69 6e 74 66 28 29 20 72 6f 75 74 69   _printf() routi
6a20: 6e 65 73 20 61 62 6f 76 65 20 61 72 65 20 62 75  nes above are bu
6a30: 69 6c 74 20 61 72 6f 75 6e 64 20 74 68 65 20 66  ilt around the f
6a40: 6f 6c 6c 6f 77 69 6e 67 0a 74 77 6f 20 66 75 6e  ollowing.two fun
6a50: 63 74 69 6f 6e 73 3a 3c 2f 70 3e 0a 0a 3c 62 6c  ctions:</p>..<bl
6a60: 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 63  ockquote><pre>.c
6a70: 68 61 72 20 2a 73 71 6c 69 74 65 5f 6d 70 72 69  har *sqlite_mpri
6a80: 6e 74 66 28 63 6f 6e 73 74 20 63 68 61 72 20 2a  ntf(const char *
6a90: 7a 46 6f 72 6d 61 74 2c 20 2e 2e 2e 29 3b 0a 63  zFormat, ...);.c
6aa0: 68 61 72 20 2a 73 71 6c 69 74 65 5f 76 6d 70 72  har *sqlite_vmpr
6ab0: 69 6e 74 66 28 63 6f 6e 73 74 20 63 68 61 72 20  intf(const char 
6ac0: 2a 7a 46 6f 72 6d 61 74 2c 20 76 61 5f 6c 69 73  *zFormat, va_lis
6ad0: 74 29 3b 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63  t);.</pre></bloc
6ae0: 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 54 68 65 20  kquote>..<p>The 
6af0: 3c 62 3e 73 71 6c 69 74 65 5f 6d 70 72 69 6e 74  <b>sqlite_mprint
6b00: 66 28 29 3c 2f 62 3e 20 72 6f 75 74 69 6e 65 20  f()</b> routine 
6b10: 77 6f 72 6b 73 20 6c 69 6b 65 20 74 68 65 20 74  works like the t
6b20: 68 65 20 73 74 61 6e 64 61 72 64 20 6c 69 62 72  he standard libr
6b30: 61 72 79 0a 3c 62 3e 73 70 72 69 6e 74 66 28 29  ary.<b>sprintf()
6b40: 3c 2f 62 3e 20 65 78 63 65 70 74 20 74 68 61 74  </b> except that
6b50: 20 69 74 20 77 72 69 74 65 73 20 69 74 73 20 72   it writes its r
6b60: 65 73 75 6c 74 73 20 69 6e 74 6f 20 6d 65 6d 6f  esults into memo
6b70: 72 79 20 6f 62 74 61 69 6e 65 64 0a 66 72 6f 6d  ry obtained.from
6b80: 20 6d 61 6c 6c 6f 63 28 29 20 61 6e 64 20 72 65   malloc() and re
6b90: 74 75 72 6e 73 20 61 20 70 6f 69 6e 74 65 72 20  turns a pointer 
6ba0: 74 6f 20 74 68 65 20 6d 61 6c 6c 6f 63 65 64 20  to the malloced 
6bb0: 62 75 66 66 65 72 2e 20 20 0a 3c 62 3e 73 71 6c  buffer.  .<b>sql
6bc0: 69 74 65 5f 6d 70 72 69 6e 74 66 28 29 3c 2f 62  ite_mprintf()</b
6bd0: 3e 20 61 6c 73 6f 20 75 6e 64 65 72 73 74 61 6e  > also understan
6be0: 64 73 20 74 68 65 20 25 71 20 61 6e 64 20 25 51  ds the %q and %Q
6bf0: 20 65 78 74 65 6e 73 69 6f 6e 73 20 64 65 73 63   extensions desc
6c00: 72 69 62 65 64 0a 61 62 6f 76 65 2e 20 20 54 68  ribed.above.  Th
6c10: 65 20 3c 62 3e 73 71 6c 69 74 65 5f 76 6d 70 72  e <b>sqlite_vmpr
6c20: 69 6e 74 66 28 29 3c 2f 62 3e 20 69 73 20 61 20  intf()</b> is a 
6c30: 76 61 72 61 72 67 73 20 76 65 72 73 69 6f 6e 20  varargs version 
6c40: 6f 66 20 74 68 65 20 73 61 6d 65 0a 72 6f 75 74  of the same.rout
6c50: 69 6e 65 2e 20 20 54 68 65 20 73 74 72 69 6e 67  ine.  The string
6c60: 20 70 6f 69 6e 74 65 72 20 74 68 61 74 20 74 68   pointer that th
6c70: 65 73 65 20 72 6f 75 74 69 6e 65 73 20 72 65 74  ese routines ret
6c80: 75 72 6e 20 73 68 6f 75 6c 64 20 62 65 20 66 72  urn should be fr
6c90: 65 65 64 0a 62 79 20 70 61 73 73 69 6e 67 20 69  eed.by passing i
6ca0: 74 20 74 6f 20 3c 62 3e 73 71 6c 69 74 65 5f 66  t to <b>sqlite_f
6cb0: 72 65 65 6d 65 6d 28 29 3c 2f 62 3e 2e 0a 3c 2f  reemem()</b>..</
6cc0: 70 3e 0a 0a 3c 68 32 3e 41 64 64 69 6e 67 20 4e  p>..<h2>Adding N
6cd0: 65 77 20 53 51 4c 20 46 75 6e 63 74 69 6f 6e 73  ew SQL Functions
6ce0: 3c 2f 68 32 3e 0a 0a 3c 70 3e 42 65 67 69 6e 6e  </h2>..<p>Beginn
6cf0: 69 6e 67 20 77 69 74 68 20 76 65 72 73 69 6f 6e  ing with version
6d00: 20 32 2e 34 2e 30 2c 20 53 51 4c 69 74 65 20 61   2.4.0, SQLite a
6d10: 6c 6c 6f 77 73 20 74 68 65 20 53 51 4c 20 6c 61  llows the SQL la
6d20: 6e 67 75 61 67 65 20 74 6f 20 62 65 0a 65 78 74  nguage to be.ext
6d30: 65 6e 64 65 64 20 77 69 74 68 20 6e 65 77 20 66  ended with new f
6d40: 75 6e 63 74 69 6f 6e 73 20 69 6d 70 6c 65 6d 65  unctions impleme
6d50: 6e 74 65 64 20 61 73 20 43 20 63 6f 64 65 2e 20  nted as C code. 
6d60: 20 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 69   The following i
6d70: 6e 74 65 72 66 61 63 65 0a 69 73 20 75 73 65 64  nterface.is used
6d80: 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75  :.</p>..<blockqu
6d90: 6f 74 65 3e 3c 70 72 65 3e 0a 74 79 70 65 64 65  ote><pre>.typede
6da0: 66 20 73 74 72 75 63 74 20 73 71 6c 69 74 65 5f  f struct sqlite_
6db0: 66 75 6e 63 20 73 71 6c 69 74 65 5f 66 75 6e 63  func sqlite_func
6dc0: 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 5f 63 72  ;..int sqlite_cr
6dd0: 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 28 0a 20  eate_function(. 
6de0: 20 73 71 6c 69 74 65 20 2a 64 62 2c 0a 20 20 63   sqlite *db,.  c
6df0: 6f 6e 73 74 20 63 68 61 72 20 2a 7a 4e 61 6d 65  onst char *zName
6e00: 2c 0a 20 20 69 6e 74 20 6e 41 72 67 2c 0a 20 20  ,.  int nArg,.  
6e10: 76 6f 69 64 20 28 2a 78 46 75 6e 63 29 28 73 71  void (*xFunc)(sq
6e20: 6c 69 74 65 5f 66 75 6e 63 2a 2c 69 6e 74 2c 63  lite_func*,int,c
6e30: 6f 6e 73 74 20 63 68 61 72 2a 2a 29 2c 0a 20 20  onst char**),.  
6e40: 76 6f 69 64 20 2a 70 55 73 65 72 44 61 74 61 0a  void *pUserData.
6e50: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 5f 63 72  );.int sqlite_cr
6e60: 65 61 74 65 5f 61 67 67 72 65 67 61 74 65 28 0a  eate_aggregate(.
6e70: 20 20 73 71 6c 69 74 65 20 2a 64 62 2c 0a 20 20    sqlite *db,.  
6e80: 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 4e 61 6d  const char *zNam
6e90: 65 2c 0a 20 20 69 6e 74 20 6e 41 72 67 2c 0a 20  e,.  int nArg,. 
6ea0: 20 76 6f 69 64 20 28 2a 78 53 74 65 70 29 28 73   void (*xStep)(s
6eb0: 71 6c 69 74 65 5f 66 75 6e 63 2a 2c 69 6e 74 2c  qlite_func*,int,
6ec0: 63 6f 6e 73 74 20 63 68 61 72 2a 2a 29 2c 0a 20  const char**),. 
6ed0: 20 76 6f 69 64 20 28 2a 78 46 69 6e 61 6c 69 7a   void (*xFinaliz
6ee0: 65 29 28 73 71 6c 69 74 65 5f 66 75 6e 63 2a 29  e)(sqlite_func*)
6ef0: 2c 0a 20 20 76 6f 69 64 20 2a 70 55 73 65 72 44  ,.  void *pUserD
6f00: 61 74 61 0a 29 3b 0a 0a 63 68 61 72 20 2a 73 71  ata.);..char *sq
6f10: 6c 69 74 65 5f 73 65 74 5f 72 65 73 75 6c 74 5f  lite_set_result_
6f20: 73 74 72 69 6e 67 28 73 71 6c 69 74 65 5f 66 75  string(sqlite_fu
6f30: 6e 63 2a 2c 63 6f 6e 73 74 20 63 68 61 72 2a 2c  nc*,const char*,
6f40: 69 6e 74 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74  int);.void sqlit
6f50: 65 5f 73 65 74 5f 72 65 73 75 6c 74 5f 69 6e 74  e_set_result_int
6f60: 28 73 71 6c 69 74 65 5f 66 75 6e 63 2a 2c 69 6e  (sqlite_func*,in
6f70: 74 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 5f  t);.void sqlite_
6f80: 73 65 74 5f 72 65 73 75 6c 74 5f 64 6f 75 62 6c  set_result_doubl
6f90: 65 28 73 71 6c 69 74 65 5f 66 75 6e 63 2a 2c 64  e(sqlite_func*,d
6fa0: 6f 75 62 6c 65 29 3b 0a 76 6f 69 64 20 73 71 6c  ouble);.void sql
6fb0: 69 74 65 5f 73 65 74 5f 72 65 73 75 6c 74 5f 65  ite_set_result_e
6fc0: 72 72 6f 72 28 73 71 6c 69 74 65 5f 66 75 6e 63  rror(sqlite_func
6fd0: 2a 2c 63 6f 6e 73 74 20 63 68 61 72 2a 2c 69 6e  *,const char*,in
6fe0: 74 29 3b 0a 0a 76 6f 69 64 20 2a 73 71 6c 69 74  t);..void *sqlit
6ff0: 65 5f 75 73 65 72 5f 64 61 74 61 28 73 71 6c 69  e_user_data(sqli
7000: 74 65 5f 66 75 6e 63 2a 29 3b 0a 76 6f 69 64 20  te_func*);.void 
7010: 2a 73 71 6c 69 74 65 5f 61 67 67 72 65 67 61 74  *sqlite_aggregat
7020: 65 5f 63 6f 6e 74 65 78 74 28 73 71 6c 69 74 65  e_context(sqlite
7030: 5f 66 75 6e 63 2a 2c 20 69 6e 74 20 6e 42 79 74  _func*, int nByt
7040: 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 5f  es);.int sqlite_
7050: 61 67 67 72 65 67 61 74 65 5f 63 6f 75 6e 74 28  aggregate_count(
7060: 73 71 6c 69 74 65 5f 66 75 6e 63 2a 29 3b 0a 3c  sqlite_func*);.<
7070: 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74  /pre></blockquot
7080: 65 3e 0a 0a 3c 70 3e 0a 54 68 65 20 3c 62 3e 73  e>..<p>.The <b>s
7090: 71 6c 69 74 65 5f 63 72 65 61 74 65 5f 66 75 6e  qlite_create_fun
70a0: 63 74 69 6f 6e 28 29 3c 2f 62 3e 20 69 6e 74 65  ction()</b> inte
70b0: 72 66 61 63 65 20 69 73 20 75 73 65 64 20 74 6f  rface is used to
70c0: 20 63 72 65 61 74 65 20 0a 72 65 67 75 6c 61 72   create .regular
70d0: 20 66 75 6e 63 74 69 6f 6e 73 20 61 6e 64 20 3c   functions and <
70e0: 62 3e 73 71 6c 69 74 65 5f 63 72 65 61 74 65 5f  b>sqlite_create_
70f0: 61 67 67 72 65 67 61 74 65 28 29 3c 2f 62 3e 20  aggregate()</b> 
7100: 69 73 20 75 73 65 64 20 74 6f 0a 63 72 65 61 74  is used to.creat
7110: 65 20 6e 65 77 20 61 67 67 72 65 67 61 74 65 20  e new aggregate 
7120: 66 75 6e 63 74 69 6f 6e 73 2e 20 20 49 6e 20 62  functions.  In b
7130: 6f 74 68 20 63 61 73 65 73 2c 20 74 68 65 20 3c  oth cases, the <
7140: 62 3e 64 62 3c 2f 62 3e 0a 70 61 72 61 6d 65 74  b>db</b>.paramet
7150: 65 72 20 69 73 20 61 6e 20 6f 70 65 6e 20 53 51  er is an open SQ
7160: 4c 69 74 65 20 64 61 74 61 62 61 73 65 20 6f 6e  Lite database on
7170: 20 77 68 69 63 68 20 74 68 65 20 66 75 6e 63 74   which the funct
7180: 69 6f 6e 73 20 73 68 6f 75 6c 64 0a 62 65 20 72  ions should.be r
7190: 65 67 69 73 74 65 72 65 64 2c 20 3c 62 3e 7a 4e  egistered, <b>zN
71a0: 61 6d 65 3c 2f 62 3e 20 69 73 20 74 68 65 20 6e  ame</b> is the n
71b0: 61 6d 65 20 6f 66 20 74 68 65 20 6e 65 77 20 66  ame of the new f
71c0: 75 6e 63 74 69 6f 6e 2c 0a 3c 62 3e 6e 41 72 67  unction,.<b>nArg
71d0: 3c 2f 62 3e 20 69 73 20 74 68 65 20 6e 75 6d 62  </b> is the numb
71e0: 65 72 20 6f 66 20 61 72 67 75 6d 65 6e 74 73 2c  er of arguments,
71f0: 20 61 6e 64 20 3c 62 3e 70 55 73 65 72 44 61 74   and <b>pUserDat
7200: 61 3c 2f 62 3e 20 69 73 0a 61 20 70 6f 69 6e 74  a</b> is.a point
7210: 65 72 20 77 68 69 63 68 20 69 73 20 70 61 73 73  er which is pass
7220: 65 64 20 74 68 72 6f 75 67 68 20 75 6e 63 68 61  ed through uncha
7230: 6e 67 65 64 20 74 6f 20 74 68 65 20 43 20 69 6d  nged to the C im
7240: 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 0a 6f 66 20  plementation.of 
7250: 74 68 65 20 66 75 6e 63 74 69 6f 6e 2e 0a 3c 2f  the function..</
7260: 70 3e 0a 0a 3c 70 3e 0a 46 6f 72 20 72 65 67 75  p>..<p>.For regu
7270: 6c 61 72 20 66 75 6e 63 74 69 6f 6e 73 2c 20 74  lar functions, t
7280: 68 65 20 3c 62 3e 78 46 75 6e 63 3c 2f 62 3e 20  he <b>xFunc</b> 
7290: 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f  callback is invo
72a0: 6b 65 64 20 6f 6e 63 65 0a 66 6f 72 20 65 61 63  ked once.for eac
72b0: 68 20 66 75 6e 63 74 69 6f 6e 20 63 61 6c 6c 2e  h function call.
72c0: 20 20 54 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61    The implementa
72d0: 74 69 6f 6e 20 6f 66 20 78 46 75 6e 63 20 73 68  tion of xFunc sh
72e0: 6f 75 6c 64 20 63 61 6c 6c 0a 6f 6e 65 20 6f 66  ould call.one of
72f0: 20 74 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 73   the <b>sqlite_s
7300: 65 74 5f 72 65 73 75 6c 74 5f 2e 2e 2e 3c 2f 62  et_result_...</b
7310: 3e 20 69 6e 74 65 72 66 61 63 65 73 20 74 6f 20  > interfaces to 
7320: 72 65 74 75 72 6e 20 69 74 73 0a 72 65 73 75 6c  return its.resul
7330: 74 2e 20 20 54 68 65 20 3c 62 3e 73 71 6c 69 74  t.  The <b>sqlit
7340: 65 5f 75 73 65 72 5f 64 61 74 61 28 29 3c 2f 62  e_user_data()</b
7350: 3e 20 72 6f 75 74 69 6e 65 20 63 61 6e 20 62 65  > routine can be
7360: 20 75 73 65 64 20 74 6f 0a 72 65 74 72 69 65 76   used to.retriev
7370: 65 20 74 68 65 20 3c 62 3e 70 55 73 65 72 44 61  e the <b>pUserDa
7380: 74 61 3c 2f 62 3e 20 70 6f 69 6e 74 65 72 20 74  ta</b> pointer t
7390: 68 61 74 20 77 61 73 20 70 61 73 73 65 64 20 69  hat was passed i
73a0: 6e 20 77 68 65 6e 20 74 68 65 0a 66 75 6e 63 74  n when the.funct
73b0: 69 6f 6e 20 77 61 73 20 72 65 67 69 73 74 65 72  ion was register
73c0: 65 64 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 46 6f  ed..</p>..<p>.Fo
73d0: 72 20 61 67 67 72 65 67 61 74 65 20 66 75 6e 63  r aggregate func
73e0: 74 69 6f 6e 73 2c 20 74 68 65 20 3c 62 3e 78 53  tions, the <b>xS
73f0: 74 65 70 3c 2f 62 3e 20 63 61 6c 6c 62 61 63 6b  tep</b> callback
7400: 20 69 73 20 69 6e 76 6f 6b 65 64 20 6f 6e 63 65   is invoked once
7410: 0a 66 6f 72 20 65 61 63 68 20 72 6f 77 20 69 6e  .for each row in
7420: 20 74 68 65 20 72 65 73 75 6c 74 20 61 6e 64 20   the result and 
7430: 74 68 65 6e 20 3c 62 3e 78 46 69 6e 61 6c 69 7a  then <b>xFinaliz
7440: 65 3c 2f 62 3e 20 69 73 20 69 6e 76 6f 6b 65 64  e</b> is invoked
7450: 20 61 74 20 74 68 65 0a 65 6e 64 20 74 6f 20 63   at the.end to c
7460: 6f 6d 70 75 74 65 20 61 20 66 69 6e 61 6c 20 61  ompute a final a
7470: 6e 73 77 65 72 2e 20 20 54 68 65 20 78 53 74 65  nswer.  The xSte
7480: 70 20 72 6f 75 74 69 6e 65 20 63 61 6e 20 75 73  p routine can us
7490: 65 20 74 68 65 0a 3c 62 3e 73 71 6c 69 74 65 5f  e the.<b>sqlite_
74a0: 61 67 67 72 65 67 61 74 65 5f 63 6f 6e 74 65 78  aggregate_contex
74b0: 74 28 29 3c 2f 62 3e 20 69 6e 74 65 72 66 61 63  t()</b> interfac
74c0: 65 20 74 6f 20 61 6c 6c 6f 63 61 74 65 20 6d 65  e to allocate me
74d0: 6d 6f 72 79 20 74 68 61 74 0a 77 69 6c 6c 20 62  mory that.will b
74e0: 65 20 75 6e 69 71 75 65 20 74 6f 20 74 68 61 74  e unique to that
74f0: 20 70 61 72 74 69 63 75 6c 61 72 20 69 6e 73 74   particular inst
7500: 61 6e 63 65 20 6f 66 20 74 68 65 20 53 51 4c 20  ance of the SQL 
7510: 66 75 6e 63 74 69 6f 6e 2e 0a 54 68 69 73 20 6d  function..This m
7520: 65 6d 6f 72 79 20 77 69 6c 6c 20 62 65 20 61 75  emory will be au
7530: 74 6f 6d 61 74 69 63 61 6c 6c 79 20 64 65 6c 65  tomatically dele
7540: 74 65 64 20 61 66 74 65 72 20 78 46 69 6e 61 6c  ted after xFinal
7550: 69 7a 65 20 69 73 20 63 61 6c 6c 65 64 2e 0a 54  ize is called..T
7560: 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 61 67 67  he <b>sqlite_agg
7570: 72 65 67 61 74 65 5f 63 6f 75 6e 74 28 29 3c 2f  regate_count()</
7580: 62 3e 20 72 6f 75 74 69 6e 65 20 63 61 6e 20 62  b> routine can b
7590: 65 20 75 73 65 64 20 74 6f 20 66 69 6e 64 20 6f  e used to find o
75a0: 75 74 0a 68 6f 77 20 6d 61 6e 79 20 72 6f 77 73  ut.how many rows
75b0: 20 6f 66 20 64 61 74 61 20 77 65 72 65 20 70 61   of data were pa
75c0: 73 73 65 64 20 74 6f 20 74 68 65 20 61 67 67 72  ssed to the aggr
75d0: 65 67 61 74 65 2e 20 20 54 68 65 20 78 46 69 6e  egate.  The xFin
75e0: 61 6c 69 7a 65 0a 63 61 6c 6c 62 61 63 6b 20 73  alize.callback s
75f0: 68 6f 75 6c 64 20 69 6e 76 6f 6b 65 20 6f 6e 65  hould invoke one
7600: 20 6f 66 20 74 68 65 20 3c 62 3e 73 71 6c 69 74   of the <b>sqlit
7610: 65 5f 73 65 74 5f 72 65 73 75 6c 74 5f 2e 2e 2e  e_set_result_...
7620: 3c 2f 62 3e 0a 69 6e 74 65 72 66 61 63 65 73 20  </b>.interfaces 
7630: 74 6f 20 73 65 74 20 74 68 65 20 66 69 6e 61 6c  to set the final
7640: 20 72 65 73 75 6c 74 20 6f 66 20 74 68 65 20 61   result of the a
7650: 67 67 72 65 67 61 74 65 2e 0a 3c 2f 70 3e 0a 0a  ggregate..</p>..
7660: 3c 70 3e 0a 53 51 4c 69 74 65 20 6e 6f 77 20 69  <p>.SQLite now i
7670: 6d 70 6c 65 6d 65 6e 74 73 20 61 6c 6c 20 6f 66  mplements all of
7680: 20 69 74 73 20 62 75 69 6c 74 2d 69 6e 20 66 75   its built-in fu
7690: 6e 63 74 69 6f 6e 73 20 75 73 69 6e 67 20 74 68  nctions using th
76a0: 69 73 0a 69 6e 74 65 72 66 61 63 65 2e 20 20 46  is.interface.  F
76b0: 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c 20 69 6e  or additional in
76c0: 66 6f 72 6d 61 74 69 6f 6e 20 61 6e 64 20 65 78  formation and ex
76d0: 61 6d 70 6c 65 73 20 6f 6e 20 68 6f 77 20 74 6f  amples on how to
76e0: 20 63 72 65 61 74 65 0a 6e 65 77 20 53 51 4c 20   create.new SQL 
76f0: 66 75 6e 63 74 69 6f 6e 73 2c 20 72 65 76 69 65  functions, revie
7700: 77 20 74 68 65 20 53 51 4c 69 74 65 20 73 6f 75  w the SQLite sou
7710: 72 63 65 20 63 6f 64 65 20 69 6e 20 74 68 65 20  rce code in the 
7720: 66 69 6c 65 0a 3c 62 3e 66 75 6e 63 2e 63 3c 2f  file.<b>func.c</
7730: 62 3e 2e 0a 3c 2f 70 3e 0a 0a 3c 68 32 3e 55 73  b>..</p>..<h2>Us
7740: 61 67 65 20 45 78 61 6d 70 6c 65 73 3c 2f 68 32  age Examples</h2
7750: 3e 0a 0a 3c 70 3e 46 6f 72 20 65 78 61 6d 70 6c  >..<p>For exampl
7760: 65 73 20 6f 66 20 68 6f 77 20 74 68 65 20 53 51  es of how the SQ
7770: 4c 69 74 65 20 43 2f 43 2b 2b 20 69 6e 74 65 72  Lite C/C++ inter
7780: 66 61 63 65 20 63 61 6e 20 62 65 20 75 73 65 64  face can be used
7790: 2c 0a 72 65 66 65 72 20 74 6f 20 74 68 65 20 73  ,.refer to the s
77a0: 6f 75 72 63 65 20 63 6f 64 65 20 66 6f 72 20 74  ource code for t
77b0: 68 65 20 3c 62 3e 73 71 6c 69 74 65 3c 2f 62 3e  he <b>sqlite</b>
77c0: 20 70 72 6f 67 72 61 6d 20 69 6e 20 74 68 65 0a   program in the.
77d0: 66 69 6c 65 20 3c 62 3e 73 72 63 2f 73 68 65 6c  file <b>src/shel
77e0: 6c 2e 63 3c 2f 62 3e 20 6f 66 20 74 68 65 20 73  l.c</b> of the s
77f0: 6f 75 72 63 65 20 74 72 65 65 2e 0a 41 64 64 69  ource tree..Addi
7800: 74 69 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61 74 69  tional informati
7810: 6f 6e 20 61 62 6f 75 74 20 73 71 6c 69 74 65 20  on about sqlite 
7820: 69 73 20 61 76 61 69 6c 61 62 6c 65 20 61 74 0a  is available at.
7830: 3c 61 20 68 72 65 66 3d 22 73 71 6c 69 74 65 2e  <a href="sqlite.
7840: 68 74 6d 6c 22 3e 73 71 6c 69 74 65 2e 68 74 6d  html">sqlite.htm
7850: 6c 3c 2f 61 3e 2e 0a 53 65 65 20 61 6c 73 6f 20  l</a>..See also 
7860: 74 68 65 20 73 6f 75 72 63 65 73 20 74 6f 20 74  the sources to t
7870: 68 65 20 54 63 6c 20 69 6e 74 65 72 66 61 63 65  he Tcl interface
7880: 20 66 6f 72 20 53 51 4c 69 74 65 20 69 6e 0a 74   for SQLite in.t
7890: 68 65 20 73 6f 75 72 63 65 20 66 69 6c 65 20 3c  he source file <
78a0: 62 3e 73 72 63 2f 74 63 6c 73 71 6c 69 74 65 2e  b>src/tclsqlite.
78b0: 63 3c 2f 62 3e 2e 3c 2f 70 3e 0a 7d 0a 0a 70 75  c</b>.</p>.}..pu
78c0: 74 73 20 7b 0a 3c 70 3e 3c 68 72 20 2f 3e 3c 2f  ts {.<p><hr /></
78d0: 70 3e 0a 3c 70 3e 3c 61 20 68 72 65 66 3d 22 69  p>.<p><a href="i
78e0: 6e 64 65 78 2e 68 74 6d 6c 22 3e 3c 69 6d 67 20  ndex.html"><img 
78f0: 73 72 63 3d 22 2f 67 6f 62 61 63 6b 2e 6a 70 67  src="/goback.jpg
7900: 22 20 62 6f 72 64 65 72 3d 30 20 2f 3e 0a 42 61  " border=0 />.Ba
7910: 63 6b 20 74 6f 20 74 68 65 20 53 51 4c 69 74 65  ck to the SQLite
7920: 20 48 6f 6d 65 20 50 61 67 65 3c 2f 61 3e 0a 3c   Home Page</a>.<
7930: 2f 70 3e 0a 0a 3c 2f 62 6f 64 79 3e 3c 2f 68 74  /p>..</body></ht
7940: 6d 6c 3e 7d 0a                                   ml>}.