/ Hex Artifact Content
Login

Artifact d8c0cdd533a80fc6af480ad50a952c46423c1786:


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: 32 38 20 32 30 30 32 2f 30 35 2f 31 30 20 31 33  28 2002/05/10 13
0070: 3a 31 34 3a 30 38 20 64 72 68 20 45 78 70 20 24  :14:08 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 3c 2f 70   va_list.);..</p
3700: 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e  re></blockquote>
3710: 0a 0a 3c 70 3e 41 6c 6c 20 6f 66 20 74 68 65 20  ..<p>All of the 
3720: 61 62 6f 76 65 20 64 65 66 69 6e 69 74 69 6f 6e  above definition
3730: 73 20 61 72 65 20 69 6e 63 6c 75 64 65 64 20 69  s are included i
3740: 6e 20 74 68 65 20 22 73 71 6c 69 74 65 2e 68 22  n the "sqlite.h"
3750: 0a 68 65 61 64 65 72 20 66 69 6c 65 20 74 68 61  .header file tha
3760: 74 20 63 6f 6d 65 73 20 69 6e 20 74 68 65 20 73  t comes in the s
3770: 6f 75 72 63 65 20 74 72 65 65 2e 3c 2f 70 3e 0a  ource tree.</p>.
3780: 0a 3c 68 32 3e 54 68 65 20 52 4f 57 49 44 20 6f  .<h2>The ROWID o
3790: 66 20 74 68 65 20 6d 6f 73 74 20 72 65 63 65 6e  f the most recen
37a0: 74 20 69 6e 73 65 72 74 3c 2f 68 32 3e 0a 0a 3c  t insert</h2>..<
37b0: 70 3e 45 76 65 72 79 20 72 6f 77 20 6f 66 20 61  p>Every row of a
37c0: 6e 20 53 51 4c 69 74 65 20 74 61 62 6c 65 20 68  n SQLite table h
37d0: 61 73 20 61 20 75 6e 69 71 75 65 20 69 6e 74 65  as a unique inte
37e0: 67 65 72 20 6b 65 79 2e 20 20 49 66 20 74 68 65  ger key.  If the
37f0: 0a 74 61 62 6c 65 20 68 61 73 20 61 20 63 6f 6c  .table has a col
3800: 75 6d 6e 20 6c 61 62 65 6c 65 64 20 49 4e 54 45  umn labeled INTE
3810: 47 45 52 20 50 52 49 4d 41 52 59 20 4b 45 59 2c  GER PRIMARY KEY,
3820: 20 74 68 65 6e 20 74 68 61 74 20 63 6f 6c 75 6d   then that colum
3830: 6e 0a 73 65 72 76 65 72 73 20 61 73 20 74 68 65  n.servers as the
3840: 20 6b 65 79 2e 20 20 49 66 20 74 68 65 72 65 20   key.  If there 
3850: 69 73 20 6e 6f 20 49 4e 54 45 47 45 52 20 50 52  is no INTEGER PR
3860: 49 4d 41 52 59 20 4b 45 59 20 63 6f 6c 75 6d 6e  IMARY KEY column
3870: 20 74 68 65 6e 0a 74 68 65 20 6b 65 79 20 69 73   then.the key is
3880: 20 61 20 75 6e 69 71 75 65 20 69 6e 74 65 67 65   a unique intege
3890: 72 2e 20 20 54 68 65 20 6b 65 79 20 66 6f 72 20  r.  The key for 
38a0: 61 20 72 6f 77 20 63 61 6e 20 62 65 20 61 63 63  a row can be acc
38b0: 65 73 73 65 64 20 69 6e 0a 61 20 53 45 4c 45 43  essed in.a SELEC
38c0: 54 20 73 74 61 74 65 6d 65 6e 74 20 6f 72 20 75  T statement or u
38d0: 73 65 64 20 69 6e 20 61 20 57 48 45 52 45 20 6f  sed in a WHERE o
38e0: 72 20 4f 52 44 45 52 20 42 59 20 63 6c 61 75 73  r ORDER BY claus
38f0: 65 20 75 73 69 6e 67 20 61 6e 79 0a 6f 66 20 74  e using any.of t
3900: 68 65 20 6e 61 6d 65 73 20 22 52 4f 57 49 44 22  he names "ROWID"
3910: 2c 20 22 4f 49 44 22 2c 20 6f 72 20 22 5f 52 4f  , "OID", or "_RO
3920: 57 49 44 5f 22 2e 3c 2f 70 3e 0a 0a 3c 70 3e 57  WID_".</p>..<p>W
3930: 68 65 6e 20 79 6f 75 20 64 6f 20 61 6e 20 69 6e  hen you do an in
3940: 73 65 72 74 20 69 6e 74 6f 20 61 20 74 61 62 6c  sert into a tabl
3950: 65 20 74 68 61 74 20 64 6f 65 73 20 6e 6f 74 20  e that does not 
3960: 68 61 76 65 20 61 6e 20 49 4e 54 45 47 45 52 20  have an INTEGER 
3970: 50 52 49 4d 41 52 59 0a 4b 45 59 20 63 6f 6c 75  PRIMARY.KEY colu
3980: 6d 6e 2c 20 6f 72 20 69 66 20 74 68 65 20 74 61  mn, or if the ta
3990: 62 6c 65 20 64 6f 65 73 20 68 61 76 65 20 61 6e  ble does have an
39a0: 20 49 4e 54 45 47 45 52 20 50 52 49 4d 41 52 59   INTEGER PRIMARY
39b0: 20 4b 45 59 20 62 75 74 20 74 68 65 20 76 61 6c   KEY but the val
39c0: 75 65 0a 66 6f 72 20 74 68 61 74 20 63 6f 6c 75  ue.for that colu
39d0: 6d 6e 20 69 73 20 6e 6f 74 20 73 70 65 63 69 66  mn is not specif
39e0: 69 65 64 20 69 6e 20 74 68 65 20 56 41 4c 55 45  ied in the VALUE
39f0: 53 20 63 6c 61 75 73 65 20 6f 66 20 74 68 65 20  S clause of the 
3a00: 69 6e 73 65 72 74 2c 20 74 68 65 6e 0a 74 68 65  insert, then.the
3a10: 20 6b 65 79 20 69 73 20 61 75 74 6f 6d 61 74 69   key is automati
3a20: 63 61 6c 6c 79 20 67 65 6e 65 72 61 74 65 64 2e  cally generated.
3a30: 20 20 59 6f 75 20 63 61 6e 20 66 69 6e 64 20 74    You can find t
3a40: 68 65 20 76 61 6c 75 65 20 6f 66 20 74 68 65 20  he value of the 
3a50: 6b 65 79 0a 66 6f 72 20 74 68 65 20 6d 6f 73 74  key.for the most
3a60: 20 72 65 63 65 6e 74 20 49 4e 53 45 52 54 20 73   recent INSERT s
3a70: 74 61 74 65 6d 65 6e 74 20 75 73 69 6e 67 20 74  tatement using t
3a80: 68 65 0a 3c 62 3e 73 71 6c 69 74 65 5f 6c 61 73  he.<b>sqlite_las
3a90: 74 5f 69 6e 73 65 72 74 5f 72 6f 77 69 64 28 29  t_insert_rowid()
3aa0: 3c 2f 62 3e 20 41 50 49 20 66 75 6e 63 74 69 6f  </b> API functio
3ab0: 6e 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 54 68 65 20  n.</p>..<h2>The 
3ac0: 6e 75 6d 62 65 72 20 6f 66 20 72 6f 77 73 20 74  number of rows t
3ad0: 68 61 74 20 63 68 61 6e 67 65 64 3c 2f 68 32 3e  hat changed</h2>
3ae0: 0a 0a 3c 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69  ..<p>The <b>sqli
3af0: 74 65 5f 63 68 61 6e 67 65 73 28 29 3c 2f 62 3e  te_changes()</b>
3b00: 20 41 50 49 20 66 75 6e 63 74 69 6f 6e 20 72 65   API function re
3b10: 74 75 72 6e 73 20 74 68 65 20 6e 75 6d 62 65 72  turns the number
3b20: 20 6f 66 20 72 6f 77 73 0a 74 68 61 74 20 77 65   of rows.that we
3b30: 72 65 20 69 6e 73 65 72 74 65 64 2c 20 64 65 6c  re inserted, del
3b40: 65 74 65 64 2c 20 6f 72 20 6d 6f 64 69 66 69 65  eted, or modifie
3b50: 64 20 64 75 72 69 6e 67 20 74 68 65 20 6d 6f 73  d during the mos
3b60: 74 20 72 65 63 65 6e 74 0a 3c 62 3e 73 71 6c 69  t recent.<b>sqli
3b70: 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e 20 63 61  te_exec()</b> ca
3b80: 6c 6c 2e 20 20 54 68 65 20 6e 75 6d 62 65 72 20  ll.  The number 
3b90: 72 65 70 6f 72 74 65 64 20 69 6e 63 6c 75 64 65  reported include
3ba0: 73 20 61 6e 79 20 63 68 61 6e 67 65 73 0a 74 68  s any changes.th
3bb0: 61 74 20 77 65 72 65 20 6c 61 74 65 72 20 75 6e  at were later un
3bc0: 64 6f 20 62 79 20 61 20 52 4f 4c 4c 42 41 43 4b  do by a ROLLBACK
3bd0: 20 6f 72 20 41 42 4f 52 54 2e 20 20 42 75 74 20   or ABORT.  But 
3be0: 72 6f 77 73 20 74 68 61 74 20 61 72 65 0a 64 65  rows that are.de
3bf0: 6c 65 74 65 64 20 62 65 63 61 75 73 65 20 6f 66  leted because of
3c00: 20 61 20 44 52 4f 50 20 54 41 42 4c 45 20 61 72   a DROP TABLE ar
3c10: 65 20 3c 65 6d 3e 6e 6f 74 3c 2f 65 6d 3e 20 63  e <em>not</em> c
3c20: 6f 75 6e 74 65 64 2e 3c 2f 70 3e 0a 0a 3c 70 3e  ounted.</p>..<p>
3c30: 53 51 4c 69 74 65 20 69 6d 70 6c 65 6d 65 6e 74  SQLite implement
3c40: 73 20 74 68 65 20 63 6f 6d 6d 61 6e 64 20 22 3c  s the command "<
3c50: 62 3e 44 45 4c 45 54 45 20 46 52 4f 4d 20 74 61  b>DELETE FROM ta
3c60: 62 6c 65 3c 2f 62 3e 22 20 28 77 69 74 68 6f 75  ble</b>" (withou
3c70: 74 0a 61 20 57 48 45 52 45 20 63 6c 61 75 73 65  t.a WHERE clause
3c80: 29 20 62 79 20 64 72 6f 70 70 69 6e 67 20 74 68  ) by dropping th
3c90: 65 20 74 61 62 6c 65 20 74 68 65 6e 20 72 65 63  e table then rec
3ca0: 72 65 61 74 69 6e 67 20 69 74 2e 20 20 0a 54 68  reating it.  .Th
3cb0: 69 73 20 69 73 20 6d 75 63 68 20 66 61 73 74 65  is is much faste
3cc0: 72 20 74 68 61 6e 20 64 65 6c 65 74 69 6e 67 20  r than deleting 
3cd0: 74 68 65 20 65 6c 65 6d 65 6e 74 73 20 6f 66 20  the elements of 
3ce0: 74 68 65 20 74 61 62 6c 65 20 69 6e 64 69 76 69  the table indivi
3cf0: 64 75 61 6c 6c 79 2e 0a 42 75 74 20 69 74 20 61  dually..But it a
3d00: 6c 73 6f 20 6d 65 61 6e 73 20 74 68 61 74 20 74  lso means that t
3d10: 68 65 20 76 61 6c 75 65 20 72 65 74 75 72 6e 65  he value returne
3d20: 64 20 66 72 6f 6d 20 3c 62 3e 73 71 6c 69 74 65  d from <b>sqlite
3d30: 5f 63 68 61 6e 67 65 73 28 29 3c 2f 62 3e 0a 77  _changes()</b>.w
3d40: 69 6c 6c 20 62 65 20 7a 65 72 6f 20 72 65 67 61  ill be zero rega
3d50: 72 64 6c 65 73 73 20 6f 66 20 74 68 65 20 6e 75  rdless of the nu
3d60: 6d 62 65 72 20 6f 66 20 65 6c 65 6d 65 6e 74 73  mber of elements
3d70: 20 74 68 61 74 20 77 65 72 65 20 6f 72 69 67 69   that were origi
3d80: 6e 61 6c 6c 79 0a 69 6e 20 74 68 65 20 74 61 62  nally.in the tab
3d90: 6c 65 2e 20 20 49 66 20 61 6e 20 61 63 63 75 72  le.  If an accur
3da0: 61 74 65 20 63 6f 75 6e 74 20 6f 66 20 74 68 65  ate count of the
3db0: 20 6e 75 6d 62 65 72 20 6f 66 20 65 6c 65 6d 65   number of eleme
3dc0: 6e 74 73 20 64 65 6c 65 74 65 64 0a 69 73 20 6e  nts deleted.is n
3dd0: 65 63 65 73 73 61 72 79 2c 20 75 73 65 20 22 3c  ecessary, use "<
3de0: 62 3e 44 45 4c 45 54 45 20 46 52 4f 4d 20 74 61  b>DELETE FROM ta
3df0: 62 6c 65 20 57 48 45 52 45 20 31 3c 2f 62 3e 22  ble WHERE 1</b>"
3e00: 20 69 6e 73 74 65 61 64 2e 3c 2f 70 3e 0a 0a 3c   instead.</p>..<
3e10: 68 32 3e 51 75 65 72 79 69 6e 67 20 77 69 74 68  h2>Querying with
3e20: 6f 75 74 20 75 73 69 6e 67 20 61 20 63 61 6c 6c  out using a call
3e30: 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 3c 2f 68  back function</h
3e40: 32 3e 0a 0a 3c 70 3e 54 68 65 20 3c 62 3e 73 71  2>..<p>The <b>sq
3e50: 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 28 29  lite_get_table()
3e60: 3c 2f 62 3e 20 66 75 6e 63 74 69 6f 6e 20 69 73  </b> function is
3e70: 20 61 20 77 72 61 70 70 65 72 20 61 72 6f 75 6e   a wrapper aroun
3e80: 64 0a 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65 63  d.<b>sqlite_exec
3e90: 28 29 3c 2f 62 3e 20 74 68 61 74 20 63 6f 6c 6c  ()</b> that coll
3ea0: 65 63 74 73 20 61 6c 6c 20 74 68 65 20 69 6e 66  ects all the inf
3eb0: 6f 72 6d 61 74 69 6f 6e 20 66 72 6f 6d 20 73 75  ormation from su
3ec0: 63 63 65 73 73 69 76 65 0a 63 61 6c 6c 62 61 63  ccessive.callbac
3ed0: 6b 73 20 61 6e 64 20 77 72 69 74 65 20 69 74 20  ks and write it 
3ee0: 69 6e 74 6f 20 6d 65 6d 6f 72 79 20 6f 62 74 61  into memory obta
3ef0: 69 6e 65 64 20 66 72 6f 6d 20 6d 61 6c 6c 6f 63  ined from malloc
3f00: 28 29 2e 20 20 54 68 69 73 0a 69 73 20 61 20 63  ().  This.is a c
3f10: 6f 6e 76 65 6e 69 65 6e 63 65 20 66 75 6e 63 74  onvenience funct
3f20: 69 6f 6e 20 74 68 61 74 20 61 6c 6c 6f 77 73 20  ion that allows 
3f30: 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20  the application 
3f40: 74 6f 20 67 65 74 20 74 68 65 0a 65 6e 74 69 72  to get the.entir
3f50: 65 20 72 65 73 75 6c 74 20 6f 66 20 61 20 64 61  e result of a da
3f60: 74 61 62 61 73 65 20 71 75 65 72 79 20 77 69 74  tabase query wit
3f70: 68 20 61 20 73 69 6e 67 6c 65 20 66 75 6e 63 74  h a single funct
3f80: 69 6f 6e 20 63 61 6c 6c 2e 3c 2f 70 3e 0a 0a 3c  ion call.</p>..<
3f90: 70 3e 54 68 65 20 6d 61 69 6e 20 72 65 73 75 6c  p>The main resul
3fa0: 74 20 66 72 6f 6d 20 3c 62 3e 73 71 6c 69 74 65  t from <b>sqlite
3fb0: 5f 67 65 74 5f 74 61 62 6c 65 28 29 3c 2f 62 3e  _get_table()</b>
3fc0: 20 69 73 20 61 6e 20 61 72 72 61 79 20 6f 66 20   is an array of 
3fd0: 70 6f 69 6e 74 65 72 73 0a 74 6f 20 73 74 72 69  pointers.to stri
3fe0: 6e 67 73 2e 20 20 54 68 65 72 65 20 69 73 20 6f  ngs.  There is o
3ff0: 6e 65 20 65 6c 65 6d 65 6e 74 20 69 6e 20 74 68  ne element in th
4000: 69 73 20 61 72 72 61 79 20 66 6f 72 20 65 61 63  is array for eac
4010: 68 20 63 6f 6c 75 6d 6e 20 6f 66 0a 65 61 63 68  h column of.each
4020: 20 72 6f 77 20 69 6e 20 74 68 65 20 72 65 73 75   row in the resu
4030: 6c 74 2e 20 20 4e 55 4c 4c 20 72 65 73 75 6c 74  lt.  NULL result
4040: 73 20 61 72 65 20 72 65 70 72 65 73 65 6e 74 65  s are represente
4050: 64 20 62 79 20 61 20 4e 55 4c 4c 0a 70 6f 69 6e  d by a NULL.poin
4060: 74 65 72 2e 20 49 6e 20 61 64 64 69 74 69 6f 6e  ter. In addition
4070: 20 74 6f 20 74 68 65 20 72 65 67 75 6c 61 72 20   to the regular 
4080: 64 61 74 61 2c 20 74 68 65 72 65 20 69 73 20 61  data, there is a
4090: 6e 20 61 64 64 65 64 20 72 6f 77 20 61 74 20 74  n added row at t
40a0: 68 65 20 0a 62 65 67 69 6e 6e 69 6e 67 20 6f 66  he .beginning of
40b0: 20 74 68 65 20 61 72 72 61 79 20 74 68 61 74 20   the array that 
40c0: 63 6f 6e 74 61 69 6e 73 20 74 68 65 20 6e 61 6d  contains the nam
40d0: 65 73 20 6f 66 20 65 61 63 68 20 63 6f 6c 75 6d  es of each colum
40e0: 6e 20 6f 66 20 74 68 65 0a 72 65 73 75 6c 74 2e  n of the.result.
40f0: 3c 2f 70 3e 0a 0a 3c 70 3e 41 73 20 61 6e 20 65  </p>..<p>As an e
4100: 78 61 6d 70 6c 65 2c 20 63 6f 6e 73 69 64 65 72  xample, consider
4110: 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 71   the following q
4120: 75 65 72 79 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63  uery:</p>..<bloc
4130: 6b 71 75 6f 74 65 3e 0a 53 45 4c 45 43 54 20 65  kquote>.SELECT e
4140: 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65 2c 20 6c 6f  mployee_name, lo
4150: 67 69 6e 2c 20 68 6f 73 74 20 46 52 4f 4d 20 75  gin, host FROM u
4160: 73 65 72 73 20 57 48 45 52 45 20 6c 6f 67 69 63  sers WHERE logic
4170: 20 4c 49 4b 45 20 27 64 25 27 3b 0a 3c 2f 62 6c   LIKE 'd%';.</bl
4180: 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 54 68  ockquote>..<p>Th
4190: 69 73 20 71 75 65 72 79 20 77 69 6c 6c 20 72 65  is query will re
41a0: 74 75 72 6e 20 74 68 65 20 6e 61 6d 65 2c 20 6c  turn the name, l
41b0: 6f 67 69 6e 20 61 6e 64 20 68 6f 73 74 20 63 6f  ogin and host co
41c0: 6d 70 75 74 65 72 20 6e 61 6d 65 0a 66 6f 72 20  mputer name.for 
41d0: 65 76 65 72 79 20 65 6d 70 6c 6f 79 65 65 20 77  every employee w
41e0: 68 6f 73 65 20 6c 6f 67 69 6e 20 62 65 67 69 6e  hose login begin
41f0: 73 20 77 69 74 68 20 74 68 65 20 6c 65 74 74 65  s with the lette
4200: 72 20 22 64 22 2e 20 20 49 66 20 74 68 69 73 0a  r "d".  If this.
4210: 71 75 65 72 79 20 69 73 20 73 75 62 6d 69 74 74  query is submitt
4220: 65 64 20 74 6f 20 3c 62 3e 73 71 6c 69 74 65 5f  ed to <b>sqlite_
4230: 67 65 74 5f 74 61 62 6c 65 28 29 3c 2f 62 3e 20  get_table()</b> 
4240: 74 68 65 20 72 65 73 75 6c 74 20 6d 69 67 68 74  the result might
4250: 0a 6c 6f 6f 6b 20 6c 69 6b 65 20 74 68 69 73 3a  .look like this:
4260: 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74  </p>..<blockquot
4270: 65 3e 0a 6e 72 6f 77 20 3d 20 32 3c 62 72 3e 0a  e>.nrow = 2<br>.
4280: 6e 63 6f 6c 75 6d 6e 20 3d 20 33 3c 62 72 3e 0a  ncolumn = 3<br>.
4290: 72 65 73 75 6c 74 5b 30 5d 20 3d 20 22 65 6d 70  result[0] = "emp
42a0: 6c 6f 79 65 65 5f 6e 61 6d 65 22 3c 62 72 3e 0a  loyee_name"<br>.
42b0: 72 65 73 75 6c 74 5b 31 5d 20 3d 20 22 6c 6f 67  result[1] = "log
42c0: 69 6e 22 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 32  in"<br>.result[2
42d0: 5d 20 3d 20 22 68 6f 73 74 22 3c 62 72 3e 0a 72  ] = "host"<br>.r
42e0: 65 73 75 6c 74 5b 33 5d 20 3d 20 22 64 75 6d 6d  esult[3] = "dumm
42f0: 79 22 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 34 5d  y"<br>.result[4]
4300: 20 3d 20 22 4e 6f 20 73 75 63 68 20 75 73 65 72   = "No such user
4310: 22 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 35 5d 20  "<br>.result[5] 
4320: 3d 20 30 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 36  = 0<br>.result[6
4330: 5d 20 3d 20 22 44 2e 20 52 69 63 68 61 72 64 20  ] = "D. Richard 
4340: 48 69 70 70 22 3c 62 72 3e 0a 72 65 73 75 6c 74  Hipp"<br>.result
4350: 5b 37 5d 20 3d 20 22 64 72 68 22 3c 62 72 3e 0a  [7] = "drh"<br>.
4360: 72 65 73 75 6c 74 5b 38 5d 20 3d 20 22 7a 61 64  result[8] = "zad
4370: 6f 6b 22 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65  ok".</blockquote
4380: 3e 0a 0a 3c 70 3e 4e 6f 74 69 63 65 20 74 68 61  >..<p>Notice tha
4390: 74 20 74 68 65 20 22 68 6f 73 74 22 20 76 61 6c  t the "host" val
43a0: 75 65 20 66 6f 72 20 74 68 65 20 22 64 75 6d 6d  ue for the "dumm
43b0: 79 22 20 72 65 63 6f 72 64 20 69 73 20 4e 55 4c  y" record is NUL
43c0: 4c 20 73 6f 0a 74 68 65 20 72 65 73 75 6c 74 5b  L so.the result[
43d0: 5d 20 61 72 72 61 79 20 63 6f 6e 74 61 69 6e 73  ] array contains
43e0: 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20   a NULL pointer 
43f0: 61 74 20 74 68 61 74 20 73 6c 6f 74 2e 3c 2f 70  at that slot.</p
4400: 3e 0a 0a 3c 70 3e 49 66 20 74 68 65 20 72 65 73  >..<p>If the res
4410: 75 6c 74 20 73 65 74 20 6f 66 20 61 20 71 75 65  ult set of a que
4420: 72 79 20 69 73 20 65 6d 70 74 79 2c 20 74 68 65  ry is empty, the
4430: 6e 20 62 79 20 64 65 66 61 75 6c 74 0a 3c 62 3e  n by default.<b>
4440: 73 71 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65  sqlite_get_table
4450: 28 29 3c 2f 62 3e 20 77 69 6c 6c 20 73 65 74 20  ()</b> will set 
4460: 6e 72 6f 77 20 74 6f 20 30 20 61 6e 64 20 6c 65  nrow to 0 and le
4470: 61 76 65 20 69 74 73 0a 72 65 73 75 6c 74 20 70  ave its.result p
4480: 61 72 61 6d 65 74 65 72 20 69 73 20 73 65 74 20  arameter is set 
4490: 74 6f 20 4e 55 4c 4c 2e 20 20 42 75 74 20 69 66  to NULL.  But if
44a0: 20 74 68 65 20 45 4d 50 54 59 5f 52 45 53 55 4c   the EMPTY_RESUL
44b0: 54 5f 43 41 4c 4c 42 41 43 4b 53 0a 70 72 61 67  T_CALLBACKS.prag
44c0: 6d 61 20 69 73 20 4f 4e 20 74 68 65 6e 20 74 68  ma is ON then th
44d0: 65 20 72 65 73 75 6c 74 20 70 61 72 61 6d 65 74  e result paramet
44e0: 65 72 20 69 73 20 69 6e 69 74 69 61 6c 69 7a 65  er is initialize
44f0: 64 20 74 6f 20 74 68 65 20 6e 61 6d 65 73 0a 6f  d to the names.o
4500: 66 20 74 68 65 20 63 6f 6c 75 6d 6e 73 20 6f 6e  f the columns on
4510: 6c 79 2e 20 20 46 6f 72 20 65 78 61 6d 70 6c 65  ly.  For example
4520: 2c 20 63 6f 6e 73 69 64 65 72 20 74 68 69 73 20  , consider this 
4530: 71 75 65 72 79 20 77 68 69 63 68 20 68 61 73 0a  query which has.
4540: 61 6e 20 65 6d 70 74 79 20 72 65 73 75 6c 74 20  an empty result 
4550: 73 65 74 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b  set:</p>..<block
4560: 71 75 6f 74 65 3e 0a 53 45 4c 45 43 54 20 65 6d  quote>.SELECT em
4570: 70 6c 6f 79 65 65 5f 6e 61 6d 65 2c 20 6c 6f 67  ployee_name, log
4580: 69 6e 2c 20 68 6f 73 74 20 46 52 4f 4d 20 75 73  in, host FROM us
4590: 65 72 73 20 57 48 45 52 45 20 65 6d 70 6c 6f 79  ers WHERE employ
45a0: 65 65 5f 6e 61 6d 65 20 49 53 20 4e 55 4c 4c 3b  ee_name IS NULL;
45b0: 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a  .</blockquote>..
45c0: 3c 70 3e 0a 54 68 65 20 64 65 66 61 75 6c 74 20  <p>.The default 
45d0: 62 65 68 61 76 69 6f 72 20 67 69 76 65 73 20 74  behavior gives t
45e0: 68 69 73 20 72 65 73 75 6c 74 73 3a 0a 3c 2f 70  his results:.</p
45f0: 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  >..<blockquote>.
4600: 6e 72 6f 77 20 3d 20 30 3c 62 72 3e 0a 6e 63 6f  nrow = 0<br>.nco
4610: 6c 75 6d 6e 20 3d 20 30 3c 62 72 3e 0a 72 65 73  lumn = 0<br>.res
4620: 75 6c 74 20 3d 20 30 3c 62 72 3e 0a 3c 2f 62 6c  ult = 0<br>.</bl
4630: 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 0a 42  ockquote>..<p>.B
4640: 75 74 20 69 66 20 74 68 65 20 45 4d 50 54 59 5f  ut if the EMPTY_
4650: 52 45 53 55 4c 54 5f 43 41 4c 4c 42 41 43 4b 53  RESULT_CALLBACKS
4660: 20 70 72 61 67 6d 61 20 69 73 20 4f 4e 2c 20 74   pragma is ON, t
4670: 68 65 6e 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e  hen the followin
4680: 67 0a 69 73 20 72 65 74 75 72 6e 65 64 3a 0a 3c  g.is returned:.<
4690: 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65  /p>..<blockquote
46a0: 3e 0a 6e 72 6f 77 20 3d 20 30 3c 62 72 3e 0a 6e  >.nrow = 0<br>.n
46b0: 63 6f 6c 75 6d 6e 20 3d 20 33 3c 62 72 3e 0a 72  column = 3<br>.r
46c0: 65 73 75 6c 74 5b 30 5d 20 3d 20 22 65 6d 70 6c  esult[0] = "empl
46d0: 6f 79 65 65 5f 6e 61 6d 65 22 3c 62 72 3e 0a 72  oyee_name"<br>.r
46e0: 65 73 75 6c 74 5b 31 5d 20 3d 20 22 6c 6f 67 69  esult[1] = "logi
46f0: 6e 22 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 32 5d  n"<br>.result[2]
4700: 20 3d 20 22 68 6f 73 74 22 3c 62 72 3e 0a 3c 2f   = "host"<br>.</
4710: 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e  blockquote>..<p>
4720: 4d 65 6d 6f 72 79 20 74 6f 20 68 6f 6c 64 20 74  Memory to hold t
4730: 68 65 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 72  he information r
4740: 65 74 75 72 6e 65 64 20 62 79 20 3c 62 3e 73 71  eturned by <b>sq
4750: 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 28 29  lite_get_table()
4760: 3c 2f 62 3e 0a 69 73 20 6f 62 74 61 69 6e 65 64  </b>.is obtained
4770: 20 66 72 6f 6d 20 6d 61 6c 6c 6f 63 28 29 2e 20   from malloc(). 
4780: 20 42 75 74 20 74 68 65 20 63 61 6c 6c 69 6e 67   But the calling
4790: 20 66 75 6e 63 74 69 6f 6e 20 73 68 6f 75 6c 64   function should
47a0: 20 6e 6f 74 20 74 72 79 0a 74 6f 20 66 72 65 65   not try.to free
47b0: 20 74 68 69 73 20 69 6e 66 6f 72 6d 61 74 69 6f   this informatio
47c0: 6e 20 64 69 72 65 63 74 6c 79 2e 20 20 49 6e 73  n directly.  Ins
47d0: 74 65 61 64 2c 20 70 61 73 73 20 74 68 65 20 63  tead, pass the c
47e0: 6f 6d 70 6c 65 74 65 20 74 61 62 6c 65 0a 74 6f  omplete table.to
47f0: 20 3c 62 3e 73 71 6c 69 74 65 5f 66 72 65 65 5f   <b>sqlite_free_
4800: 74 61 62 6c 65 28 29 3c 2f 62 3e 20 77 68 65 6e  table()</b> when
4810: 20 74 68 65 20 74 61 62 6c 65 20 69 73 20 6e 6f   the table is no
4820: 20 6c 6f 6e 67 65 72 20 6e 65 65 64 65 64 2e 0a   longer needed..
4830: 49 74 20 69 73 20 73 61 66 65 20 74 6f 20 63 61  It is safe to ca
4840: 6c 6c 20 3c 62 3e 73 71 6c 69 74 65 5f 66 72 65  ll <b>sqlite_fre
4850: 65 5f 74 61 62 6c 65 28 29 3c 2f 62 3e 20 77 69  e_table()</b> wi
4860: 74 68 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  th a NULL pointe
4870: 72 20 73 75 63 68 0a 61 73 20 77 6f 75 6c 64 20  r such.as would 
4880: 62 65 20 72 65 74 75 72 6e 65 64 20 69 66 20 74  be returned if t
4890: 68 65 20 72 65 73 75 6c 74 20 73 65 74 20 69 73  he result set is
48a0: 20 65 6d 70 74 79 2e 3c 2f 70 3e 0a 0a 3c 70 3e   empty.</p>..<p>
48b0: 54 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 67 65  The <b>sqlite_ge
48c0: 74 5f 74 61 62 6c 65 28 29 3c 2f 62 3e 20 72 6f  t_table()</b> ro
48d0: 75 74 69 6e 65 20 72 65 74 75 72 6e 73 20 74 68  utine returns th
48e0: 65 20 73 61 6d 65 20 69 6e 74 65 67 65 72 0a 72  e same integer.r
48f0: 65 73 75 6c 74 20 63 6f 64 65 20 61 73 20 3c 62  esult code as <b
4900: 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f  >sqlite_exec()</
4910: 62 3e 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 49 6e 74  b>.</p>..<h2>Int
4920: 65 72 72 75 70 74 69 6e 67 20 61 6e 20 53 51 4c  errupting an SQL
4930: 69 74 65 20 6f 70 65 72 61 74 69 6f 6e 3c 2f 68  ite operation</h
4940: 32 3e 0a 0a 3c 70 3e 54 68 65 20 3c 62 3e 73 71  2>..<p>The <b>sq
4950: 6c 69 74 65 5f 69 6e 74 65 72 72 75 70 74 28 29  lite_interrupt()
4960: 3c 2f 62 3e 20 66 75 6e 63 74 69 6f 6e 20 63 61  </b> function ca
4970: 6e 20 62 65 20 63 61 6c 6c 65 64 20 66 72 6f 6d  n be called from
4980: 20 61 0a 64 69 66 66 65 72 65 6e 74 20 74 68 72   a.different thr
4990: 65 61 64 20 6f 72 20 66 72 6f 6d 20 61 20 73 69  ead or from a si
49a0: 67 6e 61 6c 20 68 61 6e 64 6c 65 72 20 74 6f 20  gnal handler to 
49b0: 63 61 75 73 65 20 74 68 65 20 63 75 72 72 65 6e  cause the curren
49c0: 74 20 64 61 74 61 62 61 73 65 0a 6f 70 65 72 61  t database.opera
49d0: 74 69 6f 6e 20 74 6f 20 65 78 69 74 20 61 74 20  tion to exit at 
49e0: 69 74 73 20 66 69 72 73 74 20 6f 70 70 6f 72 74  its first opport
49f0: 75 6e 69 74 79 2e 20 20 57 68 65 6e 20 74 68 69  unity.  When thi
4a00: 73 20 68 61 70 70 65 6e 73 2c 0a 74 68 65 20 3c  s happens,.the <
4a10: 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c  b>sqlite_exec()<
4a20: 2f 62 3e 20 72 6f 75 74 69 6e 65 20 28 6f 72 20  /b> routine (or 
4a30: 74 68 65 20 65 71 75 69 76 61 6c 65 6e 74 29 20  the equivalent) 
4a40: 74 68 61 74 20 73 74 61 72 74 65 64 0a 74 68 65  that started.the
4a50: 20 64 61 74 61 62 61 73 65 20 6f 70 65 72 61 74   database operat
4a60: 69 6f 6e 20 77 69 6c 6c 20 72 65 74 75 72 6e 20  ion will return 
4a70: 53 51 4c 49 54 45 5f 49 4e 54 45 52 52 55 50 54  SQLITE_INTERRUPT
4a80: 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 54 65 73 74 69  .</p>..<h2>Testi
4a90: 6e 67 20 66 6f 72 20 61 20 63 6f 6d 70 6c 65 74  ng for a complet
4aa0: 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 3c  e SQL statement<
4ab0: 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65 20 6e 65 78  /h2>..<p>The nex
4ac0: 74 20 69 6e 74 65 72 66 61 63 65 20 72 6f 75 74  t interface rout
4ad0: 69 6e 65 20 74 6f 20 53 51 4c 69 74 65 20 69 73  ine to SQLite is
4ae0: 20 61 20 63 6f 6e 76 65 6e 69 65 6e 63 65 20 66   a convenience f
4af0: 75 6e 63 74 69 6f 6e 20 75 73 65 64 0a 74 6f 20  unction used.to 
4b00: 74 65 73 74 20 77 68 65 74 68 65 72 20 6f 72 20  test whether or 
4b10: 6e 6f 74 20 61 20 73 74 72 69 6e 67 20 66 6f 72  not a string for
4b20: 6d 73 20 61 20 63 6f 6d 70 6c 65 74 65 20 53 51  ms a complete SQ
4b30: 4c 20 73 74 61 74 65 6d 65 6e 74 2e 0a 49 66 20  L statement..If 
4b40: 74 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 63 6f  the <b>sqlite_co
4b50: 6d 70 6c 65 74 65 28 29 3c 2f 62 3e 20 66 75 6e  mplete()</b> fun
4b60: 63 74 69 6f 6e 20 72 65 74 75 72 6e 73 20 74 72  ction returns tr
4b70: 75 65 20 77 68 65 6e 20 69 74 73 20 69 6e 70 75  ue when its inpu
4b80: 74 0a 69 73 20 61 20 73 74 72 69 6e 67 2c 20 74  t.is a string, t
4b90: 68 65 6e 20 74 68 65 20 61 72 67 75 6d 65 6e 74  hen the argument
4ba0: 20 66 6f 72 6d 73 20 61 20 63 6f 6d 70 6c 65 74   forms a complet
4bb0: 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2e  e SQL statement.
4bc0: 0a 54 68 65 72 65 20 61 72 65 20 6e 6f 20 67 75  .There are no gu
4bd0: 61 72 61 6e 74 65 65 73 20 74 68 61 74 20 74 68  arantees that th
4be0: 65 20 73 79 6e 74 61 78 20 6f 66 20 74 68 61 74  e syntax of that
4bf0: 20 73 74 61 74 65 6d 65 6e 74 20 69 73 20 63 6f   statement is co
4c00: 72 72 65 63 74 2c 0a 62 75 74 20 77 65 20 61 74  rrect,.but we at
4c10: 20 6c 65 61 73 74 20 6b 6e 6f 77 20 74 68 65 20   least know the 
4c20: 73 74 61 74 65 6d 65 6e 74 20 69 73 20 63 6f 6d  statement is com
4c30: 70 6c 65 74 65 2e 20 20 49 66 20 3c 62 3e 73 71  plete.  If <b>sq
4c40: 6c 69 74 65 5f 63 6f 6d 70 6c 65 74 65 28 29 3c  lite_complete()<
4c50: 2f 62 3e 0a 72 65 74 75 72 6e 73 20 66 61 6c 73  /b>.returns fals
4c60: 65 2c 20 74 68 65 6e 20 6d 6f 72 65 20 74 65 78  e, then more tex
4c70: 74 20 69 73 20 72 65 71 75 69 72 65 64 20 74 6f  t is required to
4c80: 20 63 6f 6d 70 6c 65 74 65 20 74 68 65 20 53 51   complete the SQ
4c90: 4c 20 73 74 61 74 65 6d 65 6e 74 2e 3c 2f 70 3e  L statement.</p>
4ca0: 0a 0a 3c 70 3e 46 6f 72 20 74 68 65 20 70 75 72  ..<p>For the pur
4cb0: 70 6f 73 65 20 6f 66 20 74 68 65 20 3c 62 3e 73  pose of the <b>s
4cc0: 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74 65 28 29  qlite_complete()
4cd0: 3c 2f 62 3e 20 66 75 6e 63 74 69 6f 6e 2c 20 61  </b> function, a
4ce0: 6e 20 53 51 4c 0a 73 74 61 74 65 6d 65 6e 74 20  n SQL.statement 
4cf0: 69 73 20 63 6f 6d 70 6c 65 74 65 20 69 66 20 69  is complete if i
4d00: 74 20 65 6e 64 73 20 69 6e 20 61 20 73 65 6d 69  t ends in a semi
4d10: 63 6f 6c 6f 6e 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54  colon.</p>..<p>T
4d20: 68 65 20 3c 62 3e 73 71 6c 69 74 65 3c 2f 62 3e  he <b>sqlite</b>
4d30: 20 63 6f 6d 6d 61 6e 64 2d 6c 69 6e 65 20 75 74   command-line ut
4d40: 69 6c 69 74 79 20 75 73 65 73 20 74 68 65 20 3c  ility uses the <
4d50: 62 3e 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74  b>sqlite_complet
4d60: 65 28 29 3c 2f 62 3e 0a 66 75 6e 63 74 69 6f 6e  e()</b>.function
4d70: 20 74 6f 20 6b 6e 6f 77 20 77 68 65 6e 20 69 74   to know when it
4d80: 20 6e 65 65 64 73 20 74 6f 20 63 61 6c 6c 20 3c   needs to call <
4d90: 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c  b>sqlite_exec()<
4da0: 2f 62 3e 2e 20 20 41 66 74 65 72 20 65 61 63 68  /b>.  After each
4db0: 0a 6c 69 6e 65 20 6f 66 20 69 6e 70 75 74 20 69  .line of input i
4dc0: 73 20 72 65 63 65 69 76 65 64 2c 20 3c 62 3e 73  s received, <b>s
4dd0: 71 6c 69 74 65 3c 2f 62 3e 20 63 61 6c 6c 73 20  qlite</b> calls 
4de0: 3c 62 3e 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65  <b>sqlite_comple
4df0: 74 65 28 29 3c 2f 62 3e 0a 6f 6e 20 61 6c 6c 20  te()</b>.on all 
4e00: 69 6e 70 75 74 20 69 6e 20 69 74 73 20 62 75 66  input in its buf
4e10: 66 65 72 2e 20 20 49 66 20 3c 62 3e 73 71 6c 69  fer.  If <b>sqli
4e20: 74 65 5f 63 6f 6d 70 6c 65 74 65 28 29 3c 2f 62  te_complete()</b
4e30: 3e 20 72 65 74 75 72 6e 73 20 74 72 75 65 2c 20  > returns true, 
4e40: 0a 74 68 65 6e 20 3c 62 3e 73 71 6c 69 74 65 5f  .then <b>sqlite_
4e50: 65 78 65 63 28 29 3c 2f 62 3e 20 69 73 20 63 61  exec()</b> is ca
4e60: 6c 6c 65 64 20 61 6e 64 20 74 68 65 20 69 6e 70  lled and the inp
4e70: 75 74 20 62 75 66 66 65 72 20 69 73 20 72 65 73  ut buffer is res
4e80: 65 74 2e 20 20 49 66 0a 3c 62 3e 73 71 6c 69 74  et.  If.<b>sqlit
4e90: 65 5f 63 6f 6d 70 6c 65 74 65 28 29 3c 2f 62 3e  e_complete()</b>
4ea0: 20 72 65 74 75 72 6e 73 20 66 61 6c 73 65 2c 20   returns false, 
4eb0: 74 68 65 6e 20 74 68 65 20 70 72 6f 6d 70 74 20  then the prompt 
4ec0: 69 73 20 63 68 61 6e 67 65 64 20 74 6f 0a 74 68  is changed to.th
4ed0: 65 20 63 6f 6e 74 69 6e 75 61 74 69 6f 6e 20 70  e continuation p
4ee0: 72 6f 6d 70 74 20 61 6e 64 20 61 6e 6f 74 68 65  rompt and anothe
4ef0: 72 20 6c 69 6e 65 20 6f 66 20 74 65 78 74 20 69  r line of text i
4f00: 73 20 72 65 61 64 20 61 6e 64 20 61 64 64 65 64  s read and added
4f10: 20 74 6f 0a 74 68 65 20 69 6e 70 75 74 20 62 75   to.the input bu
4f20: 66 66 65 72 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 4c  ffer.</p>..<h2>L
4f30: 69 62 72 61 72 79 20 76 65 72 73 69 6f 6e 20 73  ibrary version s
4f40: 74 72 69 6e 67 3c 2f 68 32 3e 0a 0a 3c 70 3e 54  tring</h2>..<p>T
4f50: 68 65 20 53 51 4c 69 74 65 20 6c 69 62 72 61 72  he SQLite librar
4f60: 79 20 65 78 70 6f 72 74 73 20 74 68 65 20 73 74  y exports the st
4f70: 72 69 6e 67 20 63 6f 6e 73 74 61 6e 74 20 6e 61  ring constant na
4f80: 6d 65 64 0a 3c 62 3e 73 71 6c 69 74 65 5f 76 65  med.<b>sqlite_ve
4f90: 72 73 69 6f 6e 3c 2f 62 3e 20 77 68 69 63 68 20  rsion</b> which 
4fa0: 63 6f 6e 74 61 69 6e 73 20 74 68 65 20 76 65 72  contains the ver
4fb0: 73 69 6f 6e 20 6e 75 6d 62 65 72 20 6f 66 20 74  sion number of t
4fc0: 68 65 0a 6c 69 62 72 61 72 79 2e 20 20 54 68 65  he.library.  The
4fd0: 20 68 65 61 64 65 72 20 66 69 6c 65 20 63 6f 6e   header file con
4fe0: 74 61 69 6e 73 20 61 20 6d 61 63 72 6f 20 53 51  tains a macro SQ
4ff0: 4c 49 54 45 5f 56 45 52 53 49 4f 4e 0a 77 69 74  LITE_VERSION.wit
5000: 68 20 74 68 65 20 73 61 6d 65 20 69 6e 66 6f 72  h the same infor
5010: 6d 61 74 69 6f 6e 2e 20 20 49 66 20 64 65 73 69  mation.  If desi
5020: 72 65 64 2c 20 61 20 70 72 6f 67 72 61 6d 20 63  red, a program c
5030: 61 6e 20 63 6f 6d 70 61 72 65 0a 74 68 65 20 53  an compare.the S
5040: 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e 20 6d 61  QLITE_VERSION ma
5050: 63 72 6f 20 61 67 61 69 6e 73 74 20 74 68 65 20  cro against the 
5060: 3c 62 3e 73 71 6c 69 74 65 5f 76 65 72 73 69 6f  <b>sqlite_versio
5070: 6e 3c 2f 62 3e 0a 73 74 72 69 6e 67 20 63 6f 6e  n</b>.string con
5080: 73 74 61 6e 74 20 74 6f 20 76 65 72 69 66 79 20  stant to verify 
5090: 74 68 61 74 20 74 68 65 20 76 65 72 73 69 6f 6e  that the version
50a0: 20 6e 75 6d 62 65 72 20 6f 66 20 74 68 65 0a 68   number of the.h
50b0: 65 61 64 65 72 20 66 69 6c 65 20 61 6e 64 20 74  eader file and t
50c0: 68 65 20 6c 69 62 72 61 72 79 20 6d 61 74 63 68  he library match
50d0: 2e 3c 2f 70 3e 20 0a 0a 3c 68 32 3e 4c 69 62 72  .</p> ..<h2>Libr
50e0: 61 72 79 20 63 68 61 72 61 63 74 65 72 20 65 6e  ary character en
50f0: 63 6f 64 69 6e 67 3c 2f 68 32 3e 0a 0a 3c 70 3e  coding</h2>..<p>
5100: 42 79 20 64 65 66 61 75 6c 74 2c 20 53 51 4c 69  By default, SQLi
5110: 74 65 20 61 73 73 75 6d 65 73 20 74 68 61 74 20  te assumes that 
5120: 61 6c 6c 20 64 61 74 61 20 75 73 65 73 20 61 20  all data uses a 
5130: 66 69 78 65 64 2d 73 69 7a 65 0a 38 2d 62 69 74  fixed-size.8-bit
5140: 20 63 68 61 72 61 63 74 65 72 20 28 69 73 6f 38   character (iso8
5150: 38 35 39 29 2e 20 20 42 75 74 20 69 66 20 79 6f  859).  But if yo
5160: 75 20 67 69 76 65 20 74 68 65 20 2d 2d 65 6e 61  u give the --ena
5170: 62 6c 65 2d 75 74 66 38 20 6f 70 74 69 6f 6e 0a  ble-utf8 option.
5180: 74 6f 20 74 68 65 20 63 6f 6e 66 69 67 75 72 65  to the configure
5190: 20 73 63 72 69 70 74 2c 20 74 68 65 6e 20 74 68   script, then th
51a0: 65 20 6c 69 62 72 61 72 79 20 61 73 73 75 6d 65  e library assume
51b0: 73 20 55 54 46 2d 38 20 76 61 72 69 61 62 6c 65  s UTF-8 variable
51c0: 0a 73 69 7a 65 64 20 63 68 61 72 61 63 74 65 72  .sized character
51d0: 73 2e 20 20 54 68 69 73 20 6d 61 6b 65 73 20 61  s.  This makes a
51e0: 20 64 69 66 66 65 72 65 6e 63 65 20 66 6f 72 20   difference for 
51f0: 74 68 65 20 4c 49 4b 45 20 61 6e 64 20 47 4c 4f  the LIKE and GLO
5200: 42 0a 6f 70 65 72 61 74 6f 72 73 20 61 6e 64 20  B.operators and 
5210: 74 68 65 20 4c 45 4e 47 54 48 28 29 20 61 6e 64  the LENGTH() and
5220: 20 53 55 42 53 54 52 28 29 20 66 75 6e 63 74 69   SUBSTR() functi
5230: 6f 6e 73 2e 20 20 54 68 65 20 73 74 61 74 69 63  ons.  The static
5240: 0a 73 74 72 69 6e 67 20 3c 62 3e 73 71 6c 69 74  .string <b>sqlit
5250: 65 5f 65 6e 63 6f 64 69 6e 67 3c 2f 62 3e 20 77  e_encoding</b> w
5260: 69 6c 6c 20 62 65 20 73 65 74 20 74 6f 20 65 69  ill be set to ei
5270: 74 68 65 72 20 22 55 54 46 2d 38 22 20 6f 72 0a  ther "UTF-8" or.
5280: 22 69 73 6f 38 38 35 39 22 20 74 6f 20 69 6e 64  "iso8859" to ind
5290: 69 63 61 74 65 20 68 6f 77 20 74 68 65 20 6c 69  icate how the li
52a0: 62 72 61 72 79 20 77 61 73 20 63 6f 6d 70 69 6c  brary was compil
52b0: 65 64 2e 20 20 49 6e 20 61 64 64 69 74 69 6f 6e  ed.  In addition
52c0: 2c 0a 74 68 65 20 3c 62 3e 73 71 6c 69 74 65 2e  ,.the <b>sqlite.
52d0: 68 3c 2f 62 3e 20 68 65 61 64 65 72 20 66 69 6c  h</b> header fil
52e0: 65 20 77 69 6c 6c 20 64 65 66 69 6e 65 20 6f 6e  e will define on
52f0: 65 20 6f 66 20 74 68 65 0a 6d 61 63 72 6f 73 20  e of the.macros 
5300: 3c 62 3e 53 51 4c 49 54 45 5f 55 54 46 38 3c 2f  <b>SQLITE_UTF8</
5310: 62 3e 20 6f 72 20 3c 62 3e 53 51 4c 49 54 45 5f  b> or <b>SQLITE_
5320: 49 53 4f 38 38 35 39 3c 2f 62 3e 2c 20 61 73 20  ISO8859</b>, as 
5330: 61 70 70 72 6f 70 72 69 61 74 65 2e 3c 2f 70 3e  appropriate.</p>
5340: 0a 0a 3c 70 3e 4e 6f 74 65 20 74 68 61 74 20 74  ..<p>Note that t
5350: 68 65 20 63 68 61 72 61 63 74 65 72 20 65 6e 63  he character enc
5360: 6f 64 69 6e 67 20 6d 65 63 68 61 6e 69 73 6d 20  oding mechanism 
5370: 75 73 65 64 20 62 79 20 53 51 4c 69 74 65 20 63  used by SQLite c
5380: 61 6e 6e 6f 74 0a 62 65 20 63 68 61 6e 67 65 64  annot.be changed
5390: 20 61 74 20 72 75 6e 2d 74 69 6d 65 2e 20 20 54   at run-time.  T
53a0: 68 69 73 20 69 73 20 61 20 63 6f 6d 70 69 6c 65  his is a compile
53b0: 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20 6f 6e 6c  -time option onl
53c0: 79 2e 20 20 54 68 65 0a 3c 62 3e 73 71 6c 69 74  y.  The.<b>sqlit
53d0: 65 5f 65 6e 63 6f 64 69 6e 67 3c 2f 62 3e 20 63  e_encoding</b> c
53e0: 68 61 72 61 63 74 65 72 20 73 74 72 69 6e 67 20  haracter string 
53f0: 6a 75 73 74 20 74 65 6c 6c 73 20 79 6f 75 20 68  just tells you h
5400: 6f 77 20 74 68 65 20 6c 69 62 72 61 72 79 0a 77  ow the library.w
5410: 61 73 20 63 6f 6d 70 69 6c 65 64 2e 3c 2f 70 3e  as compiled.</p>
5420: 0a 0a 3c 68 32 3e 43 68 61 6e 67 69 6e 67 20 74  ..<h2>Changing t
5430: 68 65 20 6c 69 62 72 61 72 79 27 73 20 72 65 73  he library's res
5440: 70 6f 6e 73 65 20 74 6f 20 6c 6f 63 6b 65 64 20  ponse to locked 
5450: 66 69 6c 65 73 3c 2f 68 32 3e 0a 0a 3c 70 3e 54  files</h2>..<p>T
5460: 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 62 75 73  he <b>sqlite_bus
5470: 79 5f 68 61 6e 64 6c 65 72 28 29 3c 2f 62 3e 20  y_handler()</b> 
5480: 70 72 6f 63 65 64 75 72 65 20 63 61 6e 20 62 65  procedure can be
5490: 20 75 73 65 64 20 74 6f 20 72 65 67 69 73 74 65   used to registe
54a0: 72 0a 61 20 62 75 73 79 20 63 61 6c 6c 62 61 63  r.a busy callbac
54b0: 6b 20 77 69 74 68 20 61 6e 20 6f 70 65 6e 20 53  k with an open S
54c0: 51 4c 69 74 65 20 64 61 74 61 62 61 73 65 2e 20  QLite database. 
54d0: 20 54 68 65 20 62 75 73 79 20 63 61 6c 6c 62 61   The busy callba
54e0: 63 6b 20 77 69 6c 6c 0a 62 65 20 69 6e 76 6f 6b  ck will.be invok
54f0: 65 64 20 77 68 65 6e 65 76 65 72 20 53 51 4c 69  ed whenever SQLi
5500: 74 65 20 74 72 69 65 73 20 74 6f 20 61 63 63 65  te tries to acce
5510: 73 73 20 61 20 64 61 74 61 62 61 73 65 20 74 68  ss a database th
5520: 61 74 20 69 73 20 6c 6f 63 6b 65 64 2e 0a 54 68  at is locked..Th
5530: 65 20 63 61 6c 6c 62 61 63 6b 20 77 69 6c 6c 20  e callback will 
5540: 74 79 70 69 63 61 6c 6c 79 20 64 6f 20 73 6f 6d  typically do som
5550: 65 20 6f 74 68 65 72 20 75 73 65 66 75 6c 20 77  e other useful w
5560: 6f 72 6b 2c 20 6f 72 20 70 65 72 68 61 70 73 20  ork, or perhaps 
5570: 73 6c 65 65 70 2c 0a 69 6e 20 6f 72 64 65 72 20  sleep,.in order 
5580: 74 6f 20 67 69 76 65 20 74 68 65 20 6c 6f 63 6b  to give the lock
5590: 20 61 20 63 68 61 6e 63 65 20 74 6f 20 63 6c 65   a chance to cle
55a0: 61 72 2e 20 20 49 66 20 74 68 65 20 63 61 6c 6c  ar.  If the call
55b0: 62 61 63 6b 20 72 65 74 75 72 6e 73 0a 6e 6f 6e  back returns.non
55c0: 2d 7a 65 72 6f 2c 20 74 68 65 6e 20 53 51 4c 69  -zero, then SQLi
55d0: 74 65 20 74 72 69 65 73 20 61 67 61 69 6e 20 74  te tries again t
55e0: 6f 20 61 63 63 65 73 73 20 74 68 65 20 64 61 74  o access the dat
55f0: 61 62 61 73 65 20 61 6e 64 20 74 68 65 20 63 79  abase and the cy
5600: 63 6c 65 0a 72 65 70 65 61 74 73 2e 20 20 49 66  cle.repeats.  If
5610: 20 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 72 65   the callback re
5620: 74 75 72 6e 73 20 7a 65 72 6f 2c 20 74 68 65 6e  turns zero, then
5630: 20 53 51 4c 69 74 65 20 61 62 6f 72 74 73 20 74   SQLite aborts t
5640: 68 65 20 63 75 72 72 65 6e 74 0a 6f 70 65 72 61  he current.opera
5650: 74 69 6f 6e 20 61 6e 64 20 72 65 74 75 72 6e 73  tion and returns
5660: 20 53 51 4c 49 54 45 5f 42 55 53 59 2e 3c 2f 70   SQLITE_BUSY.</p
5670: 3e 0a 0a 3c 70 3e 54 68 65 20 61 72 67 75 6d 65  >..<p>The argume
5680: 6e 74 73 20 74 6f 20 3c 62 3e 73 71 6c 69 74 65  nts to <b>sqlite
5690: 5f 62 75 73 79 5f 68 61 6e 64 6c 65 72 28 29 3c  _busy_handler()<
56a0: 2f 62 3e 20 61 72 65 20 74 68 65 20 6f 70 61 71  /b> are the opaq
56b0: 75 65 0a 73 74 72 75 63 74 75 72 65 20 72 65 74  ue.structure ret
56c0: 75 72 6e 65 64 20 66 72 6f 6d 20 3c 62 3e 73 71  urned from <b>sq
56d0: 6c 69 74 65 5f 6f 70 65 6e 28 29 3c 2f 62 3e 2c  lite_open()</b>,
56e0: 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68   a pointer to th
56f0: 65 20 62 75 73 79 0a 63 61 6c 6c 62 61 63 6b 20  e busy.callback 
5700: 66 75 6e 63 74 69 6f 6e 2c 20 61 6e 64 20 61 20  function, and a 
5710: 67 65 6e 65 72 69 63 20 70 6f 69 6e 74 65 72 20  generic pointer 
5720: 74 68 61 74 20 77 69 6c 6c 20 62 65 20 70 61 73  that will be pas
5730: 73 65 64 20 61 73 0a 74 68 65 20 66 69 72 73 74  sed as.the first
5740: 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 74 68 65   argument to the
5750: 20 62 75 73 79 20 63 61 6c 6c 62 61 63 6b 2e 20   busy callback. 
5760: 20 57 68 65 6e 20 53 51 4c 69 74 65 20 69 6e 76   When SQLite inv
5770: 6f 6b 65 73 20 74 68 65 0a 62 75 73 79 20 63 61  okes the.busy ca
5780: 6c 6c 62 61 63 6b 2c 20 69 74 20 73 65 6e 64 73  llback, it sends
5790: 20 69 74 20 74 68 72 65 65 20 61 72 67 75 6d 65   it three argume
57a0: 6e 74 73 3a 20 20 74 68 65 20 67 65 6e 65 72 69  nts:  the generi
57b0: 63 20 70 6f 69 6e 74 65 72 0a 74 68 61 74 20 77  c pointer.that w
57c0: 61 73 20 70 61 73 73 65 64 20 69 6e 20 61 73 20  as passed in as 
57d0: 74 68 65 20 74 68 69 72 64 20 61 72 67 75 6d 65  the third argume
57e0: 6e 74 20 74 6f 20 3c 62 3e 73 71 6c 69 74 65 5f  nt to <b>sqlite_
57f0: 62 75 73 79 5f 68 61 6e 64 6c 65 72 3c 2f 62 3e  busy_handler</b>
5800: 2c 0a 74 68 65 20 6e 61 6d 65 20 6f 66 20 74 68  ,.the name of th
5810: 65 20 64 61 74 61 62 61 73 65 20 74 61 62 6c 65  e database table
5820: 20 6f 72 20 69 6e 64 65 78 20 74 68 61 74 20 74   or index that t
5830: 68 65 20 6c 69 62 72 61 72 79 20 69 73 20 74 72  he library is tr
5840: 79 69 6e 67 0a 74 6f 20 61 63 63 65 73 73 2c 20  ying.to access, 
5850: 61 6e 64 20 74 68 65 20 6e 75 6d 62 65 72 20 6f  and the number o
5860: 66 20 74 69 6d 65 73 20 74 68 61 74 20 74 68 65  f times that the
5870: 20 6c 69 62 72 61 72 79 20 68 61 73 20 61 74 74   library has att
5880: 65 6d 70 74 65 64 20 74 6f 0a 61 63 63 65 73 73  empted to.access
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 2e 3c 2f 70  ble or index.</p
58b0: 3e 0a 0a 3c 70 3e 46 6f 72 20 74 68 65 20 63 6f  >..<p>For the co
58c0: 6d 6d 6f 6e 20 63 61 73 65 20 77 68 65 72 65 20  mmon case where 
58d0: 77 65 20 77 61 6e 74 20 74 68 65 20 62 75 73 79  we want the busy
58e0: 20 63 61 6c 6c 62 61 63 6b 20 74 6f 20 73 6c 65   callback to sle
58f0: 65 70 2c 0a 74 68 65 20 53 51 4c 69 74 65 20 6c  ep,.the SQLite l
5900: 69 62 72 61 72 79 20 70 72 6f 76 69 64 65 73 20  ibrary provides 
5910: 61 20 63 6f 6e 76 65 6e 69 65 6e 63 65 20 72 6f  a convenience ro
5920: 75 74 69 6e 65 20 3c 62 3e 73 71 6c 69 74 65 5f  utine <b>sqlite_
5930: 62 75 73 79 5f 74 69 6d 65 6f 75 74 28 29 3c 2f  busy_timeout()</
5940: 62 3e 2e 0a 54 68 65 20 66 69 72 73 74 20 61 72  b>..The first ar
5950: 67 75 6d 65 6e 74 20 74 6f 20 3c 62 3e 73 71 6c  gument to <b>sql
5960: 69 74 65 5f 62 75 73 79 5f 74 69 6d 65 6f 75 74  ite_busy_timeout
5970: 28 29 3c 2f 62 3e 20 69 73 20 61 20 70 6f 69 6e  ()</b> is a poin
5980: 74 65 72 20 74 6f 0a 61 6e 20 6f 70 65 6e 20 53  ter to.an open S
5990: 51 4c 69 74 65 20 64 61 74 61 62 61 73 65 20 61  QLite database a
59a0: 6e 64 20 74 68 65 20 73 65 63 6f 6e 64 20 61 72  nd the second ar
59b0: 67 75 6d 65 6e 74 20 69 73 20 61 20 6e 75 6d 62  gument is a numb
59c0: 65 72 20 6f 66 20 6d 69 6c 6c 69 73 65 63 6f 6e  er of millisecon
59d0: 64 73 2e 0a 41 66 74 65 72 20 3c 62 3e 73 71 6c  ds..After <b>sql
59e0: 69 74 65 5f 62 75 73 79 5f 74 69 6d 65 6f 75 74  ite_busy_timeout
59f0: 28 29 3c 2f 62 3e 20 68 61 73 20 62 65 65 6e 20  ()</b> has been 
5a00: 65 78 65 63 75 74 65 64 2c 20 74 68 65 20 53 51  executed, the SQ
5a10: 4c 69 74 65 20 6c 69 62 72 61 72 79 0a 77 69 6c  Lite library.wil
5a20: 6c 20 77 61 69 74 20 66 6f 72 20 74 68 65 20 6c  l wait for the l
5a30: 6f 63 6b 20 74 6f 20 63 6c 65 61 72 20 66 6f 72  ock to clear for
5a40: 20 61 74 20 6c 65 61 73 74 20 74 68 65 20 6e 75   at least the nu
5a50: 6d 62 65 72 20 6f 66 20 6d 69 6c 6c 69 73 65 63  mber of millisec
5a60: 6f 6e 64 73 20 0a 73 70 65 63 69 66 69 65 64 20  onds .specified 
5a70: 62 65 66 6f 72 65 20 69 74 20 72 65 74 75 72 6e  before it return
5a80: 73 20 53 51 4c 49 54 45 5f 42 55 53 59 2e 20 20  s SQLITE_BUSY.  
5a90: 53 70 65 63 69 66 79 69 6e 67 20 7a 65 72 6f 20  Specifying zero 
5aa0: 6d 69 6c 6c 69 73 65 63 6f 6e 64 73 20 66 6f 72  milliseconds for
5ab0: 0a 74 68 65 20 74 69 6d 65 6f 75 74 20 72 65 73  .the timeout res
5ac0: 74 6f 72 65 73 20 74 68 65 20 64 65 66 61 75 6c  tores the defaul
5ad0: 74 20 62 65 68 61 76 69 6f 72 2e 3c 2f 70 3e 0a  t behavior.</p>.
5ae0: 0a 3c 68 32 3e 55 73 69 6e 67 20 74 68 65 20 3c  .<h2>Using the <
5af0: 74 74 3e 5f 70 72 69 6e 74 66 28 29 3c 2f 74 74  tt>_printf()</tt
5b00: 3e 20 77 72 61 70 70 65 72 20 66 75 6e 63 74 69  > wrapper functi
5b10: 6f 6e 73 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65  ons</h2>..<p>The
5b20: 20 66 6f 75 72 20 75 74 69 6c 69 74 79 20 66 75   four utility fu
5b30: 6e 63 74 69 6f 6e 73 3c 2f 70 3e 0a 0a 3c 70 3e  nctions</p>..<p>
5b40: 0a 3c 75 6c 3e 0a 3c 6c 69 3e 3c 62 3e 73 71 6c  .<ul>.<li><b>sql
5b50: 69 74 65 5f 65 78 65 63 5f 70 72 69 6e 74 66 28  ite_exec_printf(
5b60: 29 3c 2f 62 3e 3c 2f 6c 69 3e 0a 3c 6c 69 3e 3c  )</b></li>.<li><
5b70: 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 5f 76 70  b>sqlite_exec_vp
5b80: 72 69 6e 74 66 28 29 3c 2f 62 3e 3c 2f 6c 69 3e  rintf()</b></li>
5b90: 0a 3c 6c 69 3e 3c 62 3e 73 71 6c 69 74 65 5f 67  .<li><b>sqlite_g
5ba0: 65 74 5f 74 61 62 6c 65 5f 70 72 69 6e 74 66 28  et_table_printf(
5bb0: 29 3c 2f 62 3e 3c 2f 6c 69 3e 0a 3c 6c 69 3e 3c  )</b></li>.<li><
5bc0: 62 3e 73 71 6c 69 74 65 5f 67 65 74 5f 74 61 62  b>sqlite_get_tab
5bd0: 6c 65 5f 76 70 72 69 6e 74 66 28 29 3c 2f 62 3e  le_vprintf()</b>
5be0: 3c 2f 6c 69 3e 0a 3c 2f 75 6c 3e 0a 3c 2f 70 3e  </li>.</ul>.</p>
5bf0: 0a 0a 3c 70 3e 69 6d 70 6c 65 6d 65 6e 74 20 74  ..<p>implement t
5c00: 68 65 20 73 61 6d 65 20 71 75 65 72 79 20 66 75  he same query fu
5c10: 6e 63 74 69 6f 6e 61 6c 69 74 79 20 61 73 20 3c  nctionality as <
5c20: 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c  b>sqlite_exec()<
5c30: 2f 62 3e 0a 61 6e 64 20 3c 62 3e 73 71 6c 69 74  /b>.and <b>sqlit
5c40: 65 5f 67 65 74 5f 74 61 62 6c 65 28 29 3c 2f 62  e_get_table()</b
5c50: 3e 2e 20 20 42 75 74 20 69 6e 73 74 65 61 64 20  >.  But instead 
5c60: 6f 66 20 74 61 6b 69 6e 67 20 61 20 63 6f 6d 70  of taking a comp
5c70: 6c 65 74 65 0a 53 51 4c 20 73 74 61 74 65 6d 65  lete.SQL stateme
5c80: 6e 74 20 61 73 20 74 68 65 69 72 20 73 65 63 6f  nt as their seco
5c90: 6e 64 20 61 72 67 75 6d 65 6e 74 2c 20 74 68 65  nd argument, the
5ca0: 20 66 6f 75 72 20 3c 62 3e 5f 70 72 69 6e 74 66   four <b>_printf
5cb0: 3c 2f 62 3e 0a 72 6f 75 74 69 6e 65 73 20 74 61  </b>.routines ta
5cc0: 6b 65 20 61 20 70 72 69 6e 74 66 2d 73 74 79 6c  ke a printf-styl
5cd0: 65 20 66 6f 72 6d 61 74 20 73 74 72 69 6e 67 2e  e format string.
5ce0: 20 20 54 68 65 20 53 51 4c 20 73 74 61 74 65 6d    The SQL statem
5cf0: 65 6e 74 20 74 6f 0a 62 65 20 65 78 65 63 75 74  ent to.be execut
5d00: 65 64 20 69 73 20 67 65 6e 65 72 61 74 65 64 20  ed is generated 
5d10: 66 72 6f 6d 20 74 68 69 73 20 66 6f 72 6d 61 74  from this format
5d20: 20 73 74 72 69 6e 67 20 61 6e 64 20 66 72 6f 6d   string and from
5d30: 20 77 68 61 74 65 76 65 72 0a 61 64 64 69 74 69   whatever.additi
5d40: 6f 6e 61 6c 20 61 72 67 75 6d 65 6e 74 73 20 61  onal arguments a
5d50: 72 65 20 61 74 74 61 63 68 65 64 20 74 6f 20 74  re attached to t
5d60: 68 65 20 65 6e 64 20 6f 66 20 74 68 65 20 66 75  he end of the fu
5d70: 6e 63 74 69 6f 6e 20 63 61 6c 6c 2e 3c 2f 70 3e  nction call.</p>
5d80: 0a 0a 3c 70 3e 54 68 65 72 65 20 61 72 65 20 74  ..<p>There are t
5d90: 77 6f 20 61 64 76 61 6e 74 61 67 65 73 20 74 6f  wo advantages to
5da0: 20 75 73 69 6e 67 20 74 68 65 20 53 51 4c 69 74   using the SQLit
5db0: 65 20 70 72 69 6e 74 66 0a 66 75 6e 63 74 69 6f  e printf.functio
5dc0: 6e 73 20 69 6e 73 74 65 61 64 20 6f 66 20 3c 62  ns instead of <b
5dd0: 3e 73 70 72 69 6e 74 66 28 29 3c 2f 62 3e 2e 20  >sprintf()</b>. 
5de0: 20 46 69 72 73 74 20 6f 66 20 61 6c 6c 2c 20 77   First of all, w
5df0: 69 74 68 20 74 68 65 0a 53 51 4c 69 74 65 20 70  ith the.SQLite p
5e00: 72 69 6e 74 66 20 72 6f 75 74 69 6e 65 73 2c 20  rintf routines, 
5e10: 74 68 65 72 65 20 69 73 20 6e 65 76 65 72 20 61  there is never a
5e20: 20 64 61 6e 67 65 72 20 6f 66 20 6f 76 65 72 66   danger of overf
5e30: 6c 6f 77 69 6e 67 20 61 0a 73 74 61 74 69 63 20  lowing a.static 
5e40: 62 75 66 66 65 72 20 61 73 20 74 68 65 72 65 20  buffer as there 
5e50: 69 73 20 77 69 74 68 20 3c 62 3e 73 70 72 69 6e  is with <b>sprin
5e60: 74 66 28 29 3c 2f 62 3e 2e 20 20 54 68 65 20 53  tf()</b>.  The S
5e70: 51 4c 69 74 65 0a 70 72 69 6e 74 66 20 72 6f 75  QLite.printf rou
5e80: 74 69 6e 65 73 20 61 75 74 6f 6d 61 74 69 63 61  tines automatica
5e90: 6c 6c 79 20 61 6c 6c 6f 63 61 74 65 20 28 61 6e  lly allocate (an
5ea0: 64 20 6c 61 74 65 72 20 66 72 65 65 29 0a 61 73  d later free).as
5eb0: 20 6d 75 63 68 20 6d 65 6d 6f 72 79 20 61 73 20   much memory as 
5ec0: 69 73 20 0a 6e 65 63 65 73 73 61 72 79 20 74 6f  is .necessary to
5ed0: 20 68 6f 6c 64 20 74 68 65 20 53 51 4c 20 73 74   hold the SQL st
5ee0: 61 74 65 6d 65 6e 74 73 20 67 65 6e 65 72 61 74  atements generat
5ef0: 65 64 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20  ed.</p>..<p>The 
5f00: 73 65 63 6f 6e 64 20 61 64 76 61 6e 74 61 67 65  second advantage
5f10: 20 74 68 65 20 53 51 4c 69 74 65 20 70 72 69 6e   the SQLite prin
5f20: 74 66 20 72 6f 75 74 69 6e 65 73 20 68 61 76 65  tf routines have
5f30: 20 6f 76 65 72 0a 3c 62 3e 73 70 72 69 6e 74 66   over.<b>sprintf
5f40: 28 29 3c 2f 62 3e 20 69 73 20 61 20 6e 65 77 20  ()</b> is a new 
5f50: 66 6f 72 6d 61 74 74 69 6e 67 20 6f 70 74 69 6f  formatting optio
5f60: 6e 20 73 70 65 63 69 66 69 63 61 6c 6c 79 20 64  n specifically d
5f70: 65 73 69 67 6e 65 64 0a 74 6f 20 73 75 70 70 6f  esigned.to suppo
5f80: 72 74 20 73 74 72 69 6e 67 20 6c 69 74 65 72 61  rt string litera
5f90: 6c 73 20 69 6e 20 53 51 4c 2e 20 20 57 69 74 68  ls in SQL.  With
5fa0: 69 6e 20 74 68 65 20 66 6f 72 6d 61 74 20 73 74  in the format st
5fb0: 72 69 6e 67 2c 0a 74 68 65 20 25 71 20 66 6f 72  ring,.the %q for
5fc0: 6d 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e 20 77  matting option w
5fd0: 6f 72 6b 73 20 76 65 72 79 20 6d 75 63 68 20 6c  orks very much l
5fe0: 69 6b 65 20 25 73 20 69 6e 20 74 68 61 74 20 69  ike %s in that i
5ff0: 74 0a 72 65 61 64 73 20 61 20 6e 75 6c 6c 2d 74  t.reads a null-t
6000: 65 72 6d 69 6e 61 74 65 64 20 73 74 72 69 6e 67  erminated string
6010: 20 66 72 6f 6d 20 74 68 65 20 61 72 67 75 6d 65   from the argume
6020: 6e 74 20 6c 69 73 74 20 61 6e 64 20 69 6e 73 65  nt list and inse
6030: 72 74 73 0a 69 74 20 69 6e 74 6f 20 74 68 65 20  rts.it into the 
6040: 72 65 73 75 6c 74 2e 20 20 42 75 74 20 25 71 20  result.  But %q 
6050: 74 72 61 6e 73 6c 61 74 65 73 20 74 68 65 20 69  translates the i
6060: 6e 73 65 72 74 65 64 20 73 74 72 69 6e 67 20 62  nserted string b
6070: 79 0a 6d 61 6b 69 6e 67 20 74 77 6f 20 63 6f 70  y.making two cop
6080: 69 65 73 20 6f 66 20 65 76 65 72 79 20 73 69 6e  ies of every sin
6090: 67 6c 65 2d 71 75 6f 74 65 20 28 27 29 20 63 68  gle-quote (') ch
60a0: 61 72 61 63 74 65 72 20 69 6e 20 74 68 65 0a 73  aracter in the.s
60b0: 75 62 73 74 69 74 75 74 65 64 20 73 74 72 69 6e  ubstituted strin
60c0: 67 2e 20 20 54 68 69 73 20 68 61 73 20 74 68 65  g.  This has the
60d0: 20 65 66 66 65 63 74 20 6f 66 20 65 73 63 61 70   effect of escap
60e0: 69 6e 67 20 74 68 65 20 65 6e 64 2d 6f 66 2d 73  ing the end-of-s
60f0: 74 72 69 6e 67 0a 6d 65 61 6e 69 6e 67 20 6f 66  tring.meaning of
6100: 20 73 69 6e 67 6c 65 2d 71 75 6f 74 65 20 77 69   single-quote wi
6110: 74 68 69 6e 20 61 20 73 74 72 69 6e 67 20 6c 69  thin a string li
6120: 74 65 72 61 6c 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e  teral..</p>..<p>
6130: 43 6f 6e 73 69 64 65 72 20 61 6e 20 65 78 61 6d  Consider an exam
6140: 70 6c 65 2e 20 20 53 75 70 70 6f 73 65 20 79 6f  ple.  Suppose yo
6150: 75 20 61 72 65 20 74 72 79 69 6e 67 20 74 6f 20  u are trying to 
6160: 69 6e 73 65 72 74 20 61 20 73 74 72 69 6e 67 0a  insert a string.
6170: 76 61 6c 75 65 20 69 6e 74 6f 20 61 20 64 61 74  value into a dat
6180: 61 62 61 73 65 20 74 61 62 6c 65 20 77 68 65 72  abase table wher
6190: 65 20 74 68 65 20 73 74 72 69 6e 67 20 76 61 6c  e the string val
61a0: 75 65 20 77 61 73 20 6f 62 74 61 69 6e 65 64 20  ue was obtained 
61b0: 66 72 6f 6d 0a 75 73 65 72 20 69 6e 70 75 74 2e  from.user input.
61c0: 20 20 53 75 70 70 6f 73 65 20 74 68 65 20 73 74    Suppose the st
61d0: 72 69 6e 67 20 74 6f 20 62 65 20 69 6e 73 65 72  ring to be inser
61e0: 74 65 64 20 69 73 20 73 74 6f 72 65 64 20 69 6e  ted is stored in
61f0: 20 61 20 76 61 72 69 61 62 6c 65 0a 6e 61 6d 65   a variable.name
6200: 64 20 7a 53 74 72 69 6e 67 2e 20 20 54 68 65 20  d zString.  The 
6210: 63 6f 64 65 20 74 6f 20 64 6f 20 74 68 65 20 69  code to do the i
6220: 6e 73 65 72 74 69 6f 6e 20 6d 69 67 68 74 20 6c  nsertion might l
6230: 6f 6f 6b 20 6c 69 6b 65 20 74 68 69 73 3a 3c 2f  ook like this:</
6240: 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e  p>..<blockquote>
6250: 3c 70 72 65 3e 0a 73 71 6c 69 74 65 5f 65 78 65  <pre>.sqlite_exe
6260: 63 5f 70 72 69 6e 74 66 28 64 62 2c 0a 20 20 22  c_printf(db,.  "
6270: 49 4e 53 45 52 54 20 49 4e 54 4f 20 74 61 62 6c  INSERT INTO tabl
6280: 65 31 20 56 41 4c 55 45 53 28 27 25 73 27 29 22  e1 VALUES('%s')"
6290: 2c 0a 20 20 30 2c 20 30 2c 20 30 2c 20 7a 53 74  ,.  0, 0, 0, zSt
62a0: 72 69 6e 67 29 3b 0a 3c 2f 70 72 65 3e 3c 2f 62  ring);.</pre></b
62b0: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 49  lockquote>..<p>I
62c0: 66 20 74 68 65 20 7a 53 74 72 69 6e 67 20 76 61  f the zString va
62d0: 72 69 61 62 6c 65 20 68 6f 6c 64 73 20 74 65 78  riable holds tex
62e0: 74 20 6c 69 6b 65 20 22 48 65 6c 6c 6f 22 2c 20  t like "Hello", 
62f0: 74 68 65 6e 20 74 68 69 73 20 73 74 61 74 65 6d  then this statem
6300: 65 6e 74 0a 77 69 6c 6c 20 77 6f 72 6b 20 6a 75  ent.will work ju
6310: 73 74 20 66 69 6e 65 2e 20 20 42 75 74 20 73 75  st fine.  But su
6320: 70 70 6f 73 65 20 74 68 65 20 75 73 65 72 20 65  ppose the user e
6330: 6e 74 65 72 73 20 61 20 73 74 72 69 6e 67 20 6c  nters a string l
6340: 69 6b 65 20 0a 22 48 69 20 79 27 61 6c 6c 21 22  ike ."Hi y'all!"
6350: 2e 20 20 54 68 65 20 53 51 4c 20 73 74 61 74 65  .  The SQL state
6360: 6d 65 6e 74 20 67 65 6e 65 72 61 74 65 64 20 72  ment generated r
6370: 65 61 64 73 20 61 73 20 66 6f 6c 6c 6f 77 73 3a  eads as follows:
6380: 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70  ..<blockquote><p
6390: 72 65 3e 0a 49 4e 53 45 52 54 20 49 4e 54 4f 20  re>.INSERT INTO 
63a0: 74 61 62 6c 65 31 20 56 41 4c 55 45 53 28 27 48  table1 VALUES('H
63b0: 69 20 79 27 61 6c 6c 27 29 0a 3c 2f 70 72 65 3e  i y'all').</pre>
63c0: 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c  </blockquote>..<
63d0: 70 3e 54 68 69 73 20 69 73 20 6e 6f 74 20 76 61  p>This is not va
63e0: 6c 69 64 20 53 51 4c 20 62 65 63 61 75 73 65 20  lid SQL because 
63f0: 6f 66 20 74 68 65 20 61 70 6f 73 74 72 6f 70 68  of the apostroph
6400: 79 20 69 6e 20 74 68 65 20 77 6f 72 64 20 22 79  y in the word "y
6410: 27 61 6c 6c 22 2e 0a 42 75 74 20 69 66 20 74 68  'all"..But if th
6420: 65 20 25 71 20 66 6f 72 6d 61 74 74 69 6e 67 20  e %q formatting 
6430: 6f 70 74 69 6f 6e 20 69 73 20 75 73 65 64 20 69  option is used i
6440: 6e 73 74 65 61 64 20 6f 66 20 25 73 2c 20 6c 69  nstead of %s, li
6450: 6b 65 20 74 68 69 73 3a 3c 2f 70 3e 0a 0a 3c 62  ke this:</p>..<b
6460: 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a  lockquote><pre>.
6470: 73 71 6c 69 74 65 5f 65 78 65 63 5f 70 72 69 6e  sqlite_exec_prin
6480: 74 66 28 64 62 2c 0a 20 20 22 49 4e 53 45 52 54  tf(db,.  "INSERT
6490: 20 49 4e 54 4f 20 74 61 62 6c 65 31 20 56 41 4c   INTO table1 VAL
64a0: 55 45 53 28 27 25 71 27 29 22 2c 0a 20 20 30 2c  UES('%q')",.  0,
64b0: 20 30 2c 20 30 2c 20 7a 53 74 72 69 6e 67 29 3b   0, 0, zString);
64c0: 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75  .</pre></blockqu
64d0: 6f 74 65 3e 0a 0a 3c 70 3e 54 68 65 6e 20 74 68  ote>..<p>Then th
64e0: 65 20 67 65 6e 65 72 61 74 65 64 20 53 51 4c 20  e generated SQL 
64f0: 77 69 6c 6c 20 6c 6f 6f 6b 20 6c 69 6b 65 20 74  will look like t
6500: 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 3a 3c 2f 70  he following:</p
6510: 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c  >..<blockquote><
6520: 70 72 65 3e 0a 49 4e 53 45 52 54 20 49 4e 54 4f  pre>.INSERT INTO
6530: 20 74 61 62 6c 65 31 20 56 41 4c 55 45 53 28 27   table1 VALUES('
6540: 48 69 20 79 27 27 61 6c 6c 27 29 0a 3c 2f 70 72  Hi y''all').</pr
6550: 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  e></blockquote>.
6560: 0a 3c 70 3e 48 65 72 65 20 74 68 65 20 61 70 6f  .<p>Here the apo
6570: 73 74 72 6f 70 68 79 20 68 61 73 20 62 65 65 6e  strophy has been
6580: 20 65 73 63 61 70 65 64 20 61 6e 64 20 74 68 65   escaped and the
6590: 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 69   SQL statement i
65a0: 73 20 77 65 6c 6c 2d 66 6f 72 6d 65 64 2e 0a 57  s well-formed..W
65b0: 68 65 6e 20 67 65 6e 65 72 61 74 69 6e 67 20 53  hen generating S
65c0: 51 4c 20 6f 6e 2d 74 68 65 2d 66 6c 79 20 66 72  QL on-the-fly fr
65d0: 6f 6d 20 64 61 74 61 20 74 68 61 74 20 6d 69 67  om data that mig
65e0: 68 74 20 63 6f 6e 74 61 69 6e 20 61 0a 73 69 6e  ht contain a.sin
65f0: 67 6c 65 2d 71 75 6f 74 65 20 63 68 61 72 61 63  gle-quote charac
6600: 74 65 72 20 28 27 29 2c 20 69 74 20 69 73 20 61  ter ('), it is a
6610: 6c 77 61 79 73 20 61 20 67 6f 6f 64 20 69 64 65  lways a good ide
6620: 61 20 74 6f 20 75 73 65 20 74 68 65 0a 53 51 4c  a to use the.SQL
6630: 69 74 65 20 70 72 69 6e 74 66 20 72 6f 75 74 69  ite printf routi
6640: 6e 65 73 20 61 6e 64 20 74 68 65 20 25 71 20 66  nes and the %q f
6650: 6f 72 6d 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e  ormatting option
6660: 20 69 6e 73 74 65 61 64 20 6f 66 20 3c 62 3e 73   instead of <b>s
6670: 70 72 69 6e 74 66 3c 2f 62 3e 2e 0a 3c 2f 70 3e  printf</b>..</p>
6680: 0a 0a 3c 68 32 3e 41 64 64 69 6e 67 20 4e 65 77  ..<h2>Adding New
6690: 20 53 51 4c 20 46 75 6e 63 74 69 6f 6e 73 3c 2f   SQL Functions</
66a0: 68 32 3e 0a 0a 3c 70 3e 42 65 67 69 6e 6e 69 6e  h2>..<p>Beginnin
66b0: 67 20 77 69 74 68 20 76 65 72 73 69 6f 6e 20 32  g with version 2
66c0: 2e 34 2e 30 2c 20 53 51 4c 69 74 65 20 61 6c 6c  .4.0, SQLite all
66d0: 6f 77 73 20 74 68 65 20 53 51 4c 20 6c 61 6e 67  ows the SQL lang
66e0: 75 61 67 65 20 74 6f 20 62 65 0a 65 78 74 65 6e  uage to be.exten
66f0: 64 65 64 20 77 69 74 68 20 6e 65 77 20 66 75 6e  ded with new fun
6700: 63 74 69 6f 6e 73 20 69 6d 70 6c 65 6d 65 6e 74  ctions implement
6710: 65 64 20 61 73 20 43 20 63 6f 64 65 2e 20 20 54  ed as C code.  T
6720: 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 69 6e 74  he following int
6730: 65 72 66 61 63 65 0a 69 73 20 75 73 65 64 3a 0a  erface.is used:.
6740: 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74  </p>..<blockquot
6750: 65 3e 3c 70 72 65 3e 0a 74 79 70 65 64 65 66 20  e><pre>.typedef 
6760: 73 74 72 75 63 74 20 73 71 6c 69 74 65 5f 66 75  struct sqlite_fu
6770: 6e 63 20 73 71 6c 69 74 65 5f 66 75 6e 63 3b 0a  nc sqlite_func;.
6780: 0a 69 6e 74 20 73 71 6c 69 74 65 5f 63 72 65 61  .int sqlite_crea
6790: 74 65 5f 66 75 6e 63 74 69 6f 6e 28 0a 20 20 73  te_function(.  s
67a0: 71 6c 69 74 65 20 2a 64 62 2c 0a 20 20 63 6f 6e  qlite *db,.  con
67b0: 73 74 20 63 68 61 72 20 2a 7a 4e 61 6d 65 2c 0a  st char *zName,.
67c0: 20 20 69 6e 74 20 6e 41 72 67 2c 0a 20 20 76 6f    int nArg,.  vo
67d0: 69 64 20 28 2a 78 46 75 6e 63 29 28 73 71 6c 69  id (*xFunc)(sqli
67e0: 74 65 5f 66 75 6e 63 2a 2c 69 6e 74 2c 63 6f 6e  te_func*,int,con
67f0: 73 74 20 63 68 61 72 2a 2a 29 2c 0a 20 20 76 6f  st char**),.  vo
6800: 69 64 20 2a 70 55 73 65 72 44 61 74 61 0a 29 3b  id *pUserData.);
6810: 0a 69 6e 74 20 73 71 6c 69 74 65 5f 63 72 65 61  .int sqlite_crea
6820: 74 65 5f 61 67 67 72 65 67 61 74 65 28 0a 20 20  te_aggregate(.  
6830: 73 71 6c 69 74 65 20 2a 64 62 2c 0a 20 20 63 6f  sqlite *db,.  co
6840: 6e 73 74 20 63 68 61 72 20 2a 7a 4e 61 6d 65 2c  nst char *zName,
6850: 0a 20 20 69 6e 74 20 6e 41 72 67 2c 0a 20 20 76  .  int nArg,.  v
6860: 6f 69 64 20 28 2a 78 53 74 65 70 29 28 73 71 6c  oid (*xStep)(sql
6870: 69 74 65 5f 66 75 6e 63 2a 2c 69 6e 74 2c 63 6f  ite_func*,int,co
6880: 6e 73 74 20 63 68 61 72 2a 2a 29 2c 0a 20 20 76  nst char**),.  v
6890: 6f 69 64 20 28 2a 78 46 69 6e 61 6c 69 7a 65 29  oid (*xFinalize)
68a0: 28 73 71 6c 69 74 65 5f 66 75 6e 63 2a 29 2c 0a  (sqlite_func*),.
68b0: 20 20 76 6f 69 64 20 2a 70 55 73 65 72 44 61 74    void *pUserDat
68c0: 61 0a 29 3b 0a 0a 63 68 61 72 20 2a 73 71 6c 69  a.);..char *sqli
68d0: 74 65 5f 73 65 74 5f 72 65 73 75 6c 74 5f 73 74  te_set_result_st
68e0: 72 69 6e 67 28 73 71 6c 69 74 65 5f 66 75 6e 63  ring(sqlite_func
68f0: 2a 2c 63 6f 6e 73 74 20 63 68 61 72 2a 2c 69 6e  *,const char*,in
6900: 74 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 5f  t);.void sqlite_
6910: 73 65 74 5f 72 65 73 75 6c 74 5f 69 6e 74 28 73  set_result_int(s
6920: 71 6c 69 74 65 5f 66 75 6e 63 2a 2c 69 6e 74 29  qlite_func*,int)
6930: 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 5f 73 65  ;.void sqlite_se
6940: 74 5f 72 65 73 75 6c 74 5f 64 6f 75 62 6c 65 28  t_result_double(
6950: 73 71 6c 69 74 65 5f 66 75 6e 63 2a 2c 64 6f 75  sqlite_func*,dou
6960: 62 6c 65 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74  ble);.void sqlit
6970: 65 5f 73 65 74 5f 72 65 73 75 6c 74 5f 65 72 72  e_set_result_err
6980: 6f 72 28 73 71 6c 69 74 65 5f 66 75 6e 63 2a 2c  or(sqlite_func*,
6990: 63 6f 6e 73 74 20 63 68 61 72 2a 2c 69 6e 74 29  const char*,int)
69a0: 3b 0a 0a 76 6f 69 64 20 2a 73 71 6c 69 74 65 5f  ;..void *sqlite_
69b0: 75 73 65 72 5f 64 61 74 61 28 73 71 6c 69 74 65  user_data(sqlite
69c0: 5f 66 75 6e 63 2a 29 3b 0a 76 6f 69 64 20 2a 73  _func*);.void *s
69d0: 71 6c 69 74 65 5f 61 67 67 72 65 67 61 74 65 5f  qlite_aggregate_
69e0: 63 6f 6e 74 65 78 74 28 73 71 6c 69 74 65 5f 66  context(sqlite_f
69f0: 75 6e 63 2a 2c 20 69 6e 74 20 6e 42 79 74 65 73  unc*, int nBytes
6a00: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 5f 61 67  );.int sqlite_ag
6a10: 67 72 65 67 61 74 65 5f 63 6f 75 6e 74 28 73 71  gregate_count(sq
6a20: 6c 69 74 65 5f 66 75 6e 63 2a 29 3b 0a 3c 2f 70  lite_func*);.</p
6a30: 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e  re></blockquote>
6a40: 0a 0a 3c 70 3e 0a 54 68 65 20 3c 62 3e 73 71 6c  ..<p>.The <b>sql
6a50: 69 74 65 5f 63 72 65 61 74 65 5f 66 75 6e 63 74  ite_create_funct
6a60: 69 6f 6e 28 29 3c 2f 62 3e 20 69 6e 74 65 72 66  ion()</b> interf
6a70: 61 63 65 20 69 73 20 75 73 65 64 20 74 6f 20 63  ace is used to c
6a80: 72 65 61 74 65 20 0a 72 65 67 75 6c 61 72 20 66  reate .regular f
6a90: 75 6e 63 74 69 6f 6e 73 20 61 6e 64 20 3c 62 3e  unctions and <b>
6aa0: 73 71 6c 69 74 65 5f 63 72 65 61 74 65 5f 61 67  sqlite_create_ag
6ab0: 67 72 65 67 61 74 65 28 29 3c 2f 62 3e 20 69 73  gregate()</b> is
6ac0: 20 75 73 65 64 20 74 6f 0a 63 72 65 61 74 65 20   used to.create 
6ad0: 6e 65 77 20 61 67 67 72 65 67 61 74 65 20 66 75  new aggregate fu
6ae0: 6e 63 74 69 6f 6e 73 2e 20 20 49 6e 20 62 6f 74  nctions.  In bot
6af0: 68 20 63 61 73 65 73 2c 20 74 68 65 20 3c 62 3e  h cases, the <b>
6b00: 64 62 3c 2f 62 3e 0a 70 61 72 61 6d 65 74 65 72  db</b>.parameter
6b10: 20 69 73 20 61 6e 20 6f 70 65 6e 20 53 51 4c 69   is an open SQLi
6b20: 74 65 20 64 61 74 61 62 61 73 65 20 6f 6e 20 77  te database on w
6b30: 68 69 63 68 20 74 68 65 20 66 75 6e 63 74 69 6f  hich the functio
6b40: 6e 73 20 73 68 6f 75 6c 64 0a 62 65 20 72 65 67  ns should.be reg
6b50: 69 73 74 65 72 65 64 2c 20 3c 62 3e 7a 4e 61 6d  istered, <b>zNam
6b60: 65 3c 2f 62 3e 20 69 73 20 74 68 65 20 6e 61 6d  e</b> is the nam
6b70: 65 20 6f 66 20 74 68 65 20 6e 65 77 20 66 75 6e  e of the new fun
6b80: 63 74 69 6f 6e 2c 0a 3c 62 3e 6e 41 72 67 3c 2f  ction,.<b>nArg</
6b90: 62 3e 20 69 73 20 74 68 65 20 6e 75 6d 62 65 72  b> is the number
6ba0: 20 6f 66 20 61 72 67 75 6d 65 6e 74 73 2c 20 61   of arguments, a
6bb0: 6e 64 20 3c 62 3e 70 55 73 65 72 44 61 74 61 3c  nd <b>pUserData<
6bc0: 2f 62 3e 20 69 73 0a 61 20 70 6f 69 6e 74 65 72  /b> is.a pointer
6bd0: 20 77 68 69 63 68 20 69 73 20 70 61 73 73 65 64   which is passed
6be0: 20 74 68 72 6f 75 67 68 20 75 6e 63 68 61 6e 67   through unchang
6bf0: 65 64 20 74 6f 20 74 68 65 20 43 20 69 6d 70 6c  ed to the C impl
6c00: 65 6d 65 6e 74 61 74 69 6f 6e 0a 6f 66 20 74 68  ementation.of th
6c10: 65 20 66 75 6e 63 74 69 6f 6e 2e 0a 3c 2f 70 3e  e function..</p>
6c20: 0a 0a 3c 70 3e 0a 46 6f 72 20 72 65 67 75 6c 61  ..<p>.For regula
6c30: 72 20 66 75 6e 63 74 69 6f 6e 73 2c 20 74 68 65  r functions, the
6c40: 20 3c 62 3e 78 46 75 6e 63 3c 2f 62 3e 20 63 61   <b>xFunc</b> ca
6c50: 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65  llback is invoke
6c60: 64 20 6f 6e 63 65 0a 66 6f 72 20 65 61 63 68 20  d once.for each 
6c70: 66 75 6e 63 74 69 6f 6e 20 63 61 6c 6c 2e 20 20  function call.  
6c80: 54 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  The implementati
6c90: 6f 6e 20 6f 66 20 78 46 75 6e 63 20 73 68 6f 75  on of xFunc shou
6ca0: 6c 64 20 63 61 6c 6c 0a 6f 6e 65 20 6f 66 20 74  ld call.one of t
6cb0: 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 73 65 74  he <b>sqlite_set
6cc0: 5f 72 65 73 75 6c 74 5f 2e 2e 2e 3c 2f 62 3e 20  _result_...</b> 
6cd0: 69 6e 74 65 72 66 61 63 65 73 20 74 6f 20 72 65  interfaces to re
6ce0: 74 75 72 6e 20 69 74 73 0a 72 65 73 75 6c 74 2e  turn its.result.
6cf0: 20 20 54 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f    The <b>sqlite_
6d00: 75 73 65 72 5f 64 61 74 61 28 29 3c 2f 62 3e 20  user_data()</b> 
6d10: 72 6f 75 74 69 6e 65 20 63 61 6e 20 62 65 20 75  routine can be u
6d20: 73 65 64 20 74 6f 0a 72 65 74 72 69 65 76 65 20  sed to.retrieve 
6d30: 74 68 65 20 3c 62 3e 70 55 73 65 72 44 61 74 61  the <b>pUserData
6d40: 3c 2f 62 3e 20 70 6f 69 6e 74 65 72 20 74 68 61  </b> pointer tha
6d50: 74 20 77 61 73 20 70 61 73 73 65 64 20 69 6e 20  t was passed in 
6d60: 77 68 65 6e 20 74 68 65 0a 66 75 6e 63 74 69 6f  when the.functio
6d70: 6e 20 77 61 73 20 72 65 67 69 73 74 65 72 65 64  n was registered
6d80: 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 46 6f 72 20  ..</p>..<p>.For 
6d90: 61 67 67 72 65 67 61 74 65 20 66 75 6e 63 74 69  aggregate functi
6da0: 6f 6e 73 2c 20 74 68 65 20 3c 62 3e 78 53 74 65  ons, the <b>xSte
6db0: 70 3c 2f 62 3e 20 63 61 6c 6c 62 61 63 6b 20 69  p</b> callback i
6dc0: 73 20 69 6e 76 6f 6b 65 64 20 6f 6e 63 65 0a 66  s invoked once.f
6dd0: 6f 72 20 65 61 63 68 20 72 6f 77 20 69 6e 20 74  or each row in t
6de0: 68 65 20 72 65 73 75 6c 74 20 61 6e 64 20 74 68  he result and th
6df0: 65 6e 20 3c 62 3e 78 46 69 6e 61 6c 69 7a 65 3c  en <b>xFinalize<
6e00: 2f 62 3e 20 69 73 20 69 6e 76 6f 6b 65 64 20 61  /b> is invoked a
6e10: 74 20 74 68 65 0a 65 6e 64 20 74 6f 20 63 6f 6d  t the.end to com
6e20: 70 75 74 65 20 61 20 66 69 6e 61 6c 20 61 6e 73  pute a final ans
6e30: 77 65 72 2e 20 20 54 68 65 20 78 53 74 65 70 20  wer.  The xStep 
6e40: 72 6f 75 74 69 6e 65 20 63 61 6e 20 75 73 65 20  routine can use 
6e50: 74 68 65 0a 3c 62 3e 73 71 6c 69 74 65 5f 61 67  the.<b>sqlite_ag
6e60: 67 72 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28  gregate_context(
6e70: 29 3c 2f 62 3e 20 69 6e 74 65 72 66 61 63 65 20  )</b> interface 
6e80: 74 6f 20 61 6c 6c 6f 63 61 74 65 20 6d 65 6d 6f  to allocate memo
6e90: 72 79 20 74 68 61 74 0a 77 69 6c 6c 20 62 65 20  ry that.will be 
6ea0: 75 6e 69 71 75 65 20 74 6f 20 74 68 61 74 20 70  unique to that p
6eb0: 61 72 74 69 63 75 6c 61 72 20 69 6e 73 74 61 6e  articular instan
6ec0: 63 65 20 6f 66 20 74 68 65 20 53 51 4c 20 66 75  ce of the SQL fu
6ed0: 6e 63 74 69 6f 6e 2e 0a 54 68 69 73 20 6d 65 6d  nction..This mem
6ee0: 6f 72 79 20 77 69 6c 6c 20 62 65 20 61 75 74 6f  ory will be auto
6ef0: 6d 61 74 69 63 61 6c 6c 79 20 64 65 6c 65 74 65  matically delete
6f00: 64 20 61 66 74 65 72 20 78 46 69 6e 61 6c 69 7a  d after xFinaliz
6f10: 65 20 69 73 20 63 61 6c 6c 65 64 2e 0a 54 68 65  e is called..The
6f20: 20 3c 62 3e 73 71 6c 69 74 65 5f 61 67 67 72 65   <b>sqlite_aggre
6f30: 67 61 74 65 5f 63 6f 75 6e 74 28 29 3c 2f 62 3e  gate_count()</b>
6f40: 20 72 6f 75 74 69 6e 65 20 63 61 6e 20 62 65 20   routine can be 
6f50: 75 73 65 64 20 74 6f 20 66 69 6e 64 20 6f 75 74  used to find out
6f60: 0a 68 6f 77 20 6d 61 6e 79 20 72 6f 77 73 20 6f  .how many rows o
6f70: 66 20 64 61 74 61 20 77 65 72 65 20 70 61 73 73  f data were pass
6f80: 65 64 20 74 6f 20 74 68 65 20 61 67 67 72 65 67  ed to the aggreg
6f90: 61 74 65 2e 20 20 54 68 65 20 78 46 69 6e 61 6c  ate.  The xFinal
6fa0: 69 7a 65 0a 63 61 6c 6c 62 61 63 6b 20 73 68 6f  ize.callback sho
6fb0: 75 6c 64 20 69 6e 76 6f 6b 65 20 6f 6e 65 20 6f  uld invoke one o
6fc0: 66 20 74 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f  f the <b>sqlite_
6fd0: 73 65 74 5f 72 65 73 75 6c 74 5f 2e 2e 2e 3c 2f  set_result_...</
6fe0: 62 3e 0a 69 6e 74 65 72 66 61 63 65 73 20 74 6f  b>.interfaces to
6ff0: 20 73 65 74 20 74 68 65 20 66 69 6e 61 6c 20 72   set the final r
7000: 65 73 75 6c 74 20 6f 66 20 74 68 65 20 61 67 67  esult of the agg
7010: 72 65 67 61 74 65 2e 0a 3c 2f 70 3e 0a 0a 3c 70  regate..</p>..<p
7020: 3e 0a 53 51 4c 69 74 65 20 6e 6f 77 20 69 6d 70  >.SQLite now imp
7030: 6c 65 6d 65 6e 74 73 20 61 6c 6c 20 6f 66 20 69  lements all of i
7040: 74 73 20 62 75 69 6c 74 2d 69 6e 20 66 75 6e 63  ts built-in func
7050: 74 69 6f 6e 73 20 75 73 69 6e 67 20 74 68 69 73  tions using this
7060: 0a 69 6e 74 65 72 66 61 63 65 2e 20 20 46 6f 72  .interface.  For
7070: 20 61 64 64 69 74 69 6f 6e 61 6c 20 69 6e 66 6f   additional info
7080: 72 6d 61 74 69 6f 6e 20 61 6e 64 20 65 78 61 6d  rmation and exam
7090: 70 6c 65 73 20 6f 6e 20 68 6f 77 20 74 6f 20 63  ples on how to c
70a0: 72 65 61 74 65 0a 6e 65 77 20 53 51 4c 20 66 75  reate.new SQL fu
70b0: 6e 63 74 69 6f 6e 73 2c 20 72 65 76 69 65 77 20  nctions, review 
70c0: 74 68 65 20 53 51 4c 69 74 65 20 73 6f 75 72 63  the SQLite sourc
70d0: 65 20 63 6f 64 65 20 69 6e 20 74 68 65 20 66 69  e code in the fi
70e0: 6c 65 0a 3c 62 3e 66 75 6e 63 2e 63 3c 2f 62 3e  le.<b>func.c</b>
70f0: 2e 0a 3c 2f 70 3e 0a 0a 3c 68 32 3e 55 73 61 67  ..</p>..<h2>Usag
7100: 65 20 45 78 61 6d 70 6c 65 73 3c 2f 68 32 3e 0a  e Examples</h2>.
7110: 0a 3c 70 3e 46 6f 72 20 65 78 61 6d 70 6c 65 73  .<p>For examples
7120: 20 6f 66 20 68 6f 77 20 74 68 65 20 53 51 4c 69   of how the SQLi
7130: 74 65 20 43 2f 43 2b 2b 20 69 6e 74 65 72 66 61  te C/C++ interfa
7140: 63 65 20 63 61 6e 20 62 65 20 75 73 65 64 2c 0a  ce can be used,.
7150: 72 65 66 65 72 20 74 6f 20 74 68 65 20 73 6f 75  refer to the sou
7160: 72 63 65 20 63 6f 64 65 20 66 6f 72 20 74 68 65  rce code for the
7170: 20 3c 62 3e 73 71 6c 69 74 65 3c 2f 62 3e 20 70   <b>sqlite</b> p
7180: 72 6f 67 72 61 6d 20 69 6e 20 74 68 65 0a 66 69  rogram in the.fi
7190: 6c 65 20 3c 62 3e 73 72 63 2f 73 68 65 6c 6c 2e  le <b>src/shell.
71a0: 63 3c 2f 62 3e 20 6f 66 20 74 68 65 20 73 6f 75  c</b> of the sou
71b0: 72 63 65 20 74 72 65 65 2e 0a 41 64 64 69 74 69  rce tree..Additi
71c0: 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e  onal information
71d0: 20 61 62 6f 75 74 20 73 71 6c 69 74 65 20 69 73   about sqlite is
71e0: 20 61 76 61 69 6c 61 62 6c 65 20 61 74 0a 3c 61   available at.<a
71f0: 20 68 72 65 66 3d 22 73 71 6c 69 74 65 2e 68 74   href="sqlite.ht
7200: 6d 6c 22 3e 73 71 6c 69 74 65 2e 68 74 6d 6c 3c  ml">sqlite.html<
7210: 2f 61 3e 2e 0a 53 65 65 20 61 6c 73 6f 20 74 68  /a>..See also th
7220: 65 20 73 6f 75 72 63 65 73 20 74 6f 20 74 68 65  e sources to the
7230: 20 54 63 6c 20 69 6e 74 65 72 66 61 63 65 20 66   Tcl interface f
7240: 6f 72 20 53 51 4c 69 74 65 20 69 6e 0a 74 68 65  or SQLite in.the
7250: 20 73 6f 75 72 63 65 20 66 69 6c 65 20 3c 62 3e   source file <b>
7260: 73 72 63 2f 74 63 6c 73 71 6c 69 74 65 2e 63 3c  src/tclsqlite.c<
7270: 2f 62 3e 2e 3c 2f 70 3e 0a 7d 0a 0a 70 75 74 73  /b>.</p>.}..puts
7280: 20 7b 0a 3c 70 3e 3c 68 72 20 2f 3e 3c 2f 70 3e   {.<p><hr /></p>
7290: 0a 3c 70 3e 3c 61 20 68 72 65 66 3d 22 69 6e 64  .<p><a href="ind
72a0: 65 78 2e 68 74 6d 6c 22 3e 3c 69 6d 67 20 73 72  ex.html"><img sr
72b0: 63 3d 22 2f 67 6f 62 61 63 6b 2e 6a 70 67 22 20  c="/goback.jpg" 
72c0: 62 6f 72 64 65 72 3d 30 20 2f 3e 0a 42 61 63 6b  border=0 />.Back
72d0: 20 74 6f 20 74 68 65 20 53 51 4c 69 74 65 20 48   to the SQLite H
72e0: 6f 6d 65 20 50 61 67 65 3c 2f 61 3e 0a 3c 2f 70  ome Page</a>.</p
72f0: 3e 0a 0a 3c 2f 62 6f 64 79 3e 3c 2f 68 74 6d 6c  >..</body></html
7300: 3e 7d 0a                                         >}.