/ Hex Artifact Content
Login

Artifact fbaddacc3fed376d4aebfddceb31a1fac00cf158:


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 37 20 32 30 30 32 2f 30 35 2f 31 30 20 30 35  27 2002/05/10 05
0070: 3a 34 34 3a 35 37 20 64 72 68 20 45 78 70 20 24  :44:57 drh Exp $
0080: 7d 0a 0a 70 75 74 73 20 7b 3c 68 74 6d 6c 3e 0a  }..puts {<html>.
0090: 3c 68 65 61 64 3e 0a 20 20 3c 74 69 74 6c 65 3e  <head>.  <title>
00a0: 54 68 65 20 43 20 6c 61 6e 67 75 61 67 65 20 69  The C language i
00b0: 6e 74 65 72 66 61 63 65 20 74 6f 20 74 68 65 20  nterface to the 
00c0: 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79 3c 2f  SQLite library</
00d0: 74 69 74 6c 65 3e 0a 3c 2f 68 65 61 64 3e 0a 3c  title>.</head>.<
00e0: 62 6f 64 79 20 62 67 63 6f 6c 6f 72 3d 77 68 69  body bgcolor=whi
00f0: 74 65 3e 0a 3c 68 31 20 61 6c 69 67 6e 3d 63 65  te>.<h1 align=ce
0100: 6e 74 65 72 3e 0a 54 68 65 20 43 20 6c 61 6e 67  nter>.The C lang
0110: 75 61 67 65 20 69 6e 74 65 72 66 61 63 65 20 74  uage interface t
0120: 6f 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62  o the SQLite lib
0130: 72 61 72 79 0a 3c 2f 68 31 3e 7d 0a 70 75 74 73  rary.</h1>}.puts
0140: 20 22 3c 70 20 61 6c 69 67 6e 3d 63 65 6e 74 65   "<p align=cente
0150: 72 3e 0a 28 54 68 69 73 20 70 61 67 65 20 77 61  r>.(This page wa
0160: 73 20 6c 61 73 74 20 6d 6f 64 69 66 69 65 64 20  s last modified 
0170: 6f 6e 20 5b 6c 72 61 6e 67 65 20 24 72 63 73 69  on [lrange $rcsi
0180: 64 20 33 20 34 5d 20 55 54 43 29 0a 3c 2f 70 3e  d 3 4] UTC).</p>
0190: 22 0a 0a 70 75 74 73 20 7b 0a 3c 70 3e 54 68 65  "..puts {.<p>The
01a0: 20 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79 20   SQLite library 
01b0: 69 73 20 64 65 73 69 67 6e 65 64 20 74 6f 20 62  is designed to b
01c0: 65 20 76 65 72 79 20 65 61 73 79 20 74 6f 20 75  e very easy to u
01d0: 73 65 20 66 72 6f 6d 0a 61 20 43 20 6f 72 20 43  se from.a C or C
01e0: 2b 2b 20 70 72 6f 67 72 61 6d 2e 20 20 54 68 69  ++ program.  Thi
01f0: 73 20 64 6f 63 75 6d 65 6e 74 20 67 69 76 65 73  s document gives
0200: 20 61 6e 20 6f 76 65 72 76 69 65 77 20 6f 66 20   an overview of 
0210: 74 68 65 20 43 2f 43 2b 2b 0a 70 72 6f 67 72 61  the C/C++.progra
0220: 6d 6d 69 6e 67 20 69 6e 74 65 72 66 61 63 65 2e  mming interface.
0230: 3c 2f 70 3e 0a 0a 3c 68 32 3e 54 68 65 20 43 6f  </p>..<h2>The Co
0240: 72 65 20 41 50 49 3c 2f 68 32 3e 0a 0a 3c 70 3e  re API</h2>..<p>
0250: 54 68 65 20 69 6e 74 65 72 66 61 63 65 20 74 6f  The interface to
0260: 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62 72   the SQLite libr
0270: 61 72 79 20 63 6f 6e 73 69 73 74 73 20 6f 66 20  ary consists of 
0280: 74 68 72 65 65 20 63 6f 72 65 20 66 75 6e 63 74  three core funct
0290: 69 6f 6e 73 2c 0a 6f 6e 65 20 6f 70 61 71 75 65  ions,.one opaque
02a0: 20 64 61 74 61 20 73 74 72 75 63 74 75 72 65 2c   data structure,
02b0: 20 61 6e 64 20 73 6f 6d 65 20 63 6f 6e 73 74 61   and some consta
02c0: 6e 74 73 20 75 73 65 64 20 61 73 20 72 65 74 75  nts used as retu
02d0: 72 6e 20 76 61 6c 75 65 73 2e 0a 54 68 65 20 63  rn values..The c
02e0: 6f 72 65 20 69 6e 74 65 72 66 61 63 65 20 69 73  ore interface is
02f0: 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 3c 2f 70 3e   as follows:</p>
0300: 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70  ..<blockquote><p
0310: 72 65 3e 0a 74 79 70 65 64 65 66 20 73 74 72 75  re>.typedef stru
0320: 63 74 20 73 71 6c 69 74 65 20 73 71 6c 69 74 65  ct sqlite sqlite
0330: 3b 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  ;.#define SQLITE
0340: 5f 4f 4b 20 20 20 20 20 20 20 20 20 20 20 30 20  _OK           0 
0350: 20 20 2f 2a 20 53 75 63 63 65 73 73 66 75 6c 20    /* Successful 
0360: 72 65 73 75 6c 74 20 2a 2f 0a 0a 73 71 6c 69 74  result */..sqlit
0370: 65 20 2a 73 71 6c 69 74 65 5f 6f 70 65 6e 28 63  e *sqlite_open(c
0380: 6f 6e 73 74 20 63 68 61 72 20 2a 64 62 6e 61 6d  onst char *dbnam
0390: 65 2c 20 69 6e 74 20 6d 6f 64 65 2c 20 63 68 61  e, int mode, cha
03a0: 72 20 2a 2a 65 72 72 6d 73 67 29 3b 0a 0a 76 6f  r **errmsg);..vo
03b0: 69 64 20 73 71 6c 69 74 65 5f 63 6c 6f 73 65 28  id sqlite_close(
03c0: 73 71 6c 69 74 65 2a 29 3b 0a 0a 69 6e 74 20 73  sqlite*);..int s
03d0: 71 6c 69 74 65 5f 65 78 65 63 28 0a 20 20 73 71  qlite_exec(.  sq
03e0: 6c 69 74 65 2a 2c 0a 20 20 63 68 61 72 20 2a 73  lite*,.  char *s
03f0: 71 6c 2c 0a 20 20 69 6e 74 20 28 2a 29 28 76 6f  ql,.  int (*)(vo
0400: 69 64 2a 2c 69 6e 74 2c 63 68 61 72 2a 2a 2c 63  id*,int,char**,c
0410: 68 61 72 2a 2a 29 2c 0a 20 20 76 6f 69 64 2a 2c  har**),.  void*,
0420: 0a 20 20 63 68 61 72 20 2a 2a 65 72 72 6d 73 67  .  char **errmsg
0430: 0a 29 3b 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63  .);.</pre></bloc
0440: 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 0a 54 68 65  kquote>..<p>.The
0450: 20 61 62 6f 76 65 20 69 73 20 61 6c 6c 20 79 6f   above is all yo
0460: 75 20 72 65 61 6c 6c 79 20 6e 65 65 64 20 74 6f  u really need to
0470: 20 6b 6e 6f 77 20 69 6e 20 6f 72 64 65 72 20 74   know in order t
0480: 6f 20 75 73 65 20 53 51 4c 69 74 65 0a 69 6e 20  o use SQLite.in 
0490: 79 6f 75 72 20 43 20 6f 72 20 43 2b 2b 20 70 72  your C or C++ pr
04a0: 6f 67 72 61 6d 73 2e 20 20 54 68 65 72 65 20 61  ograms.  There a
04b0: 72 65 20 6f 74 68 65 72 20 63 6f 6e 76 65 6e 69  re other conveni
04c0: 65 6e 63 65 20 66 75 6e 63 74 69 6f 6e 73 0a 61  ence functions.a
04d0: 76 61 69 6c 61 62 6c 65 20 28 61 6e 64 20 64 65  vailable (and de
04e0: 73 63 72 69 62 65 64 20 62 65 6c 6f 77 29 20 62  scribed below) b
04f0: 75 74 20 77 65 20 77 69 6c 6c 20 62 65 67 69 6e  ut we will begin
0500: 20 62 79 20 64 65 73 63 72 69 62 69 6e 67 0a 74   by describing.t
0510: 68 65 20 63 6f 72 65 20 66 75 6e 63 74 69 6f 6e  he core function
0520: 73 20 73 68 6f 77 6e 20 61 62 6f 76 65 2e 0a 3c  s shown above..<
0530: 2f 70 3e 0a 3c 68 32 3e 4f 70 65 6e 69 6e 67 20  /p>.<h2>Opening 
0540: 61 20 64 61 74 61 62 61 73 65 3c 2f 68 32 3e 0a  a database</h2>.
0550: 0a 3c 70 3e 55 73 65 20 74 68 65 20 3c 62 3e 73  .<p>Use the <b>s
0560: 71 6c 69 74 65 5f 6f 70 65 6e 28 29 3c 2f 62 3e  qlite_open()</b>
0570: 20 66 75 6e 63 74 69 6f 6e 20 74 6f 20 6f 70 65   function to ope
0580: 6e 20 61 6e 20 65 78 69 73 74 69 6e 67 20 53 51  n an existing SQ
0590: 4c 69 74 65 0a 64 61 74 61 62 61 73 65 20 6f 72  Lite.database or
05a0: 20 74 6f 20 63 72 65 61 74 65 20 61 20 6e 65 77   to create a new
05b0: 20 53 51 4c 69 74 65 20 64 61 74 61 62 61 73 65   SQLite database
05c0: 2e 20 20 54 68 65 20 66 69 72 73 74 20 61 72 67  .  The first arg
05d0: 75 6d 65 6e 74 0a 69 73 20 74 68 65 20 64 61 74  ument.is the dat
05e0: 61 62 61 73 65 20 6e 61 6d 65 2e 20 20 54 68 65  abase name.  The
05f0: 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74   second argument
0600: 20 69 73 20 69 6e 74 65 6e 64 65 64 20 74 6f 20   is intended to 
0610: 73 69 67 6e 61 6c 0a 77 68 65 74 68 65 72 20 74  signal.whether t
0620: 68 65 20 64 61 74 61 62 61 73 65 20 69 73 20 67  he database is g
0630: 6f 69 6e 67 20 74 6f 20 62 65 20 75 73 65 64 20  oing to be used 
0640: 66 6f 72 20 72 65 61 64 69 6e 67 20 61 6e 64 20  for reading and 
0650: 77 72 69 74 69 6e 67 0a 6f 72 20 6a 75 73 74 20  writing.or just 
0660: 66 6f 72 20 72 65 61 64 69 6e 67 2e 20 20 42 75  for reading.  Bu
0670: 74 20 69 6e 20 74 68 65 20 63 75 72 72 65 6e 74  t in the current
0680: 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 2c   implementation,
0690: 20 74 68 65 0a 73 65 63 6f 6e 64 20 61 72 67 75   the.second argu
06a0: 6d 65 6e 74 20 74 6f 20 3c 62 3e 73 71 6c 69 74  ment to <b>sqlit
06b0: 65 5f 6f 70 65 6e 3c 2f 62 3e 20 69 73 20 69 67  e_open</b> is ig
06c0: 6e 6f 72 65 64 2e 0a 54 68 65 20 74 68 69 72 64  nored..The third
06d0: 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 20 70   argument is a p
06e0: 6f 69 6e 74 65 72 20 74 6f 20 61 20 73 74 72 69  ointer to a stri
06f0: 6e 67 20 70 6f 69 6e 74 65 72 2e 0a 49 66 20 74  ng pointer..If t
0700: 68 65 20 74 68 69 72 64 20 61 72 67 75 6d 65 6e  he third argumen
0710: 74 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 20 61 6e  t is not NULL an
0720: 64 20 61 6e 20 65 72 72 6f 72 20 6f 63 63 75 72  d an error occur
0730: 73 0a 77 68 69 6c 65 20 74 72 79 69 6e 67 20 74  s.while trying t
0740: 6f 20 6f 70 65 6e 20 74 68 65 20 64 61 74 61 62  o open the datab
0750: 61 73 65 2c 20 74 68 65 6e 20 61 6e 20 65 72 72  ase, then an err
0760: 6f 72 20 6d 65 73 73 61 67 65 20 77 69 6c 6c 20  or message will 
0770: 62 65 0a 77 72 69 74 74 65 6e 20 74 6f 20 6d 65  be.written to me
0780: 6d 6f 72 79 20 6f 62 74 61 69 6e 65 64 20 66 72  mory obtained fr
0790: 6f 6d 20 6d 61 6c 6c 6f 63 28 29 20 61 6e 64 20  om malloc() and 
07a0: 2a 65 72 72 6d 73 67 20 77 69 6c 6c 20 62 65 20  *errmsg will be 
07b0: 6d 61 64 65 0a 74 6f 20 70 6f 69 6e 74 20 74 6f  made.to point to
07c0: 20 74 68 69 73 20 65 72 72 6f 72 20 6d 65 73 73   this error mess
07d0: 61 67 65 2e 20 20 54 68 65 20 63 61 6c 6c 69 6e  age.  The callin
07e0: 67 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 72 65  g function is re
07f0: 73 70 6f 6e 73 69 62 6c 65 0a 66 6f 72 20 66 72  sponsible.for fr
0800: 65 65 69 6e 67 20 74 68 65 20 6d 65 6d 6f 72 79  eeing the memory
0810: 20 77 68 65 6e 20 69 74 20 68 61 73 20 66 69 6e   when it has fin
0820: 69 73 68 65 64 20 77 69 74 68 20 69 74 2e 3c 2f  ished with it.</
0830: 70 3e 0a 0a 3c 70 3e 54 68 65 20 6e 61 6d 65 20  p>..<p>The name 
0840: 6f 66 20 61 6e 20 53 51 4c 69 74 65 20 64 61 74  of an SQLite dat
0850: 61 62 61 73 65 20 69 73 20 74 68 65 20 6e 61 6d  abase is the nam
0860: 65 20 6f 66 20 61 20 66 69 6c 65 20 74 68 61 74  e of a file that
0870: 20 77 69 6c 6c 0a 63 6f 6e 74 61 69 6e 20 74 68   will.contain th
0880: 65 20 64 61 74 61 62 61 73 65 2e 20 20 49 66 20  e database.  If 
0890: 74 68 65 20 66 69 6c 65 20 64 6f 65 73 20 6e 6f  the file does no
08a0: 74 20 65 78 69 73 74 2c 20 53 51 4c 69 74 65 20  t exist, SQLite 
08b0: 61 74 74 65 6d 70 74 73 0a 74 6f 20 63 72 65 61  attempts.to crea
08c0: 74 65 20 61 6e 64 20 69 6e 69 74 69 61 6c 69 7a  te and initializ
08d0: 65 20 69 74 2e 20 20 49 66 20 74 68 65 20 66 69  e it.  If the fi
08e0: 6c 65 20 69 73 20 72 65 61 64 2d 6f 6e 6c 79 20  le is read-only 
08f0: 28 64 75 65 20 74 6f 0a 70 65 72 6d 69 73 73 69  (due to.permissi
0900: 6f 6e 20 62 69 74 73 20 6f 72 20 62 65 63 61 75  on bits or becau
0910: 73 65 20 69 74 20 69 73 20 6c 6f 63 61 74 65 64  se it is located
0920: 20 6f 6e 20 72 65 61 64 2d 6f 6e 6c 79 20 6d 65   on read-only me
0930: 64 69 61 20 6c 69 6b 65 0a 61 20 43 44 2d 52 4f  dia like.a CD-RO
0940: 4d 29 20 74 68 65 6e 20 53 51 4c 69 74 65 20 6f  M) then SQLite o
0950: 70 65 6e 73 20 74 68 65 20 64 61 74 61 62 61 73  pens the databas
0960: 65 20 66 6f 72 20 72 65 61 64 69 6e 67 20 6f 6e  e for reading on
0970: 6c 79 2e 20 20 54 68 65 0a 65 6e 74 69 72 65 20  ly.  The.entire 
0980: 53 51 4c 20 64 61 74 61 62 61 73 65 20 69 73 20  SQL database is 
0990: 73 74 6f 72 65 64 20 69 6e 20 61 20 73 69 6e 67  stored in a sing
09a0: 6c 65 20 66 69 6c 65 20 6f 6e 20 74 68 65 20 64  le file on the d
09b0: 69 73 6b 2e 20 20 42 75 74 0a 61 64 64 69 74 69  isk.  But.additi
09c0: 6f 6e 61 6c 20 74 65 6d 70 6f 72 61 72 79 20 66  onal temporary f
09d0: 69 6c 65 73 20 6d 61 79 20 62 65 20 63 72 65 61  iles may be crea
09e0: 74 65 64 20 64 75 72 69 6e 67 20 74 68 65 20 65  ted during the e
09f0: 78 65 63 75 74 69 6f 6e 20 6f 66 0a 61 6e 20 53  xecution of.an S
0a00: 51 4c 20 63 6f 6d 6d 61 6e 64 20 69 6e 20 6f 72  QL command in or
0a10: 64 65 72 20 74 6f 20 73 74 6f 72 65 20 74 68 65  der to store the
0a20: 20 64 61 74 61 62 61 73 65 20 72 6f 6c 6c 62 61   database rollba
0a30: 63 6b 20 6a 6f 75 72 6e 61 6c 20 6f 72 0a 74 65  ck journal or.te
0a40: 6d 70 6f 72 61 72 79 20 61 6e 64 20 69 6e 74 65  mporary and inte
0a50: 72 6d 65 64 69 61 74 65 20 72 65 73 75 6c 74 73  rmediate results
0a60: 20 6f 66 20 61 20 71 75 65 72 79 2e 3c 2f 70 3e   of a query.</p>
0a70: 0a 0a 3c 70 3e 54 68 65 20 72 65 74 75 72 6e 20  ..<p>The return 
0a80: 76 61 6c 75 65 20 6f 66 20 74 68 65 20 3c 62 3e  value of the <b>
0a90: 73 71 6c 69 74 65 5f 6f 70 65 6e 28 29 3c 2f 62  sqlite_open()</b
0aa0: 3e 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 61 0a  > function is a.
0ab0: 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 6f 70  pointer to an op
0ac0: 61 71 75 65 20 3c 62 3e 73 71 6c 69 74 65 3c 2f  aque <b>sqlite</
0ad0: 62 3e 20 73 74 72 75 63 74 75 72 65 2e 20 20 54  b> structure.  T
0ae0: 68 69 73 20 70 6f 69 6e 74 65 72 20 77 69 6c 6c  his pointer will
0af0: 0a 62 65 20 74 68 65 20 66 69 72 73 74 20 61 72  .be the first ar
0b00: 67 75 6d 65 6e 74 20 74 6f 20 61 6c 6c 20 73 75  gument to all su
0b10: 62 73 65 71 75 65 6e 74 20 53 51 4c 69 74 65 20  bsequent SQLite 
0b20: 66 75 6e 63 74 69 6f 6e 20 63 61 6c 6c 73 20 74  function calls t
0b30: 68 61 74 0a 64 65 61 6c 20 77 69 74 68 20 74 68  hat.deal with th
0b40: 65 20 73 61 6d 65 20 64 61 74 61 62 61 73 65 2e  e same database.
0b50: 20 20 4e 55 4c 4c 20 69 73 20 72 65 74 75 72 6e    NULL is return
0b60: 65 64 20 69 66 20 74 68 65 20 6f 70 65 6e 20 66  ed if the open f
0b70: 61 69 6c 73 0a 66 6f 72 20 61 6e 79 20 72 65 61  ails.for any rea
0b80: 73 6f 6e 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 43 6c  son.</p>..<h2>Cl
0b90: 6f 73 69 6e 67 20 74 68 65 20 64 61 74 61 62 61  osing the databa
0ba0: 73 65 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 6f 20 63  se</h2>..<p>To c
0bb0: 6c 6f 73 65 20 61 6e 20 53 51 4c 69 74 65 20 64  lose an SQLite d
0bc0: 61 74 61 62 61 73 65 2c 20 63 61 6c 6c 20 74 68  atabase, call th
0bd0: 65 20 3c 62 3e 73 71 6c 69 74 65 5f 63 6c 6f 73  e <b>sqlite_clos
0be0: 65 28 29 3c 2f 62 3e 0a 66 75 6e 63 74 69 6f 6e  e()</b>.function
0bf0: 20 70 61 73 73 69 6e 67 20 69 74 20 74 68 65 20   passing it the 
0c00: 73 71 6c 69 74 65 20 73 74 72 75 63 74 75 72 65  sqlite structure
0c10: 20 70 6f 69 6e 74 65 72 20 74 68 61 74 20 77 61   pointer that wa
0c20: 73 20 6f 62 74 61 69 6e 65 64 0a 66 72 6f 6d 20  s obtained.from 
0c30: 61 20 70 72 69 6f 72 20 63 61 6c 6c 20 74 6f 20  a prior call to 
0c40: 3c 62 3e 73 71 6c 69 74 65 5f 6f 70 65 6e 3c 2f  <b>sqlite_open</
0c50: 62 3e 2e 0a 49 66 20 61 20 74 72 61 6e 73 61 63  b>..If a transac
0c60: 74 69 6f 6e 20 69 73 20 61 63 74 69 76 65 20 77  tion is active w
0c70: 68 65 6e 20 74 68 65 20 64 61 74 61 62 61 73 65  hen the database
0c80: 20 69 73 20 63 6c 6f 73 65 64 2c 20 74 68 65 20   is closed, the 
0c90: 74 72 61 6e 73 61 63 74 69 6f 6e 0a 69 73 20 72  transaction.is r
0ca0: 6f 6c 6c 65 64 20 62 61 63 6b 2e 3c 2f 70 3e 0a  olled back.</p>.
0cb0: 0a 3c 68 32 3e 45 78 65 63 75 74 69 6e 67 20 53  .<h2>Executing S
0cc0: 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 3c 2f 68  QL statements</h
0cd0: 32 3e 0a 0a 3c 70 3e 54 68 65 20 3c 62 3e 73 71  2>..<p>The <b>sq
0ce0: 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e 20  lite_exec()</b> 
0cf0: 66 75 6e 63 74 69 6f 6e 20 69 73 20 75 73 65 64  function is used
0d00: 20 74 6f 20 70 72 6f 63 65 73 73 20 53 51 4c 20   to process SQL 
0d10: 73 74 61 74 65 6d 65 6e 74 73 0a 61 6e 64 20 71  statements.and q
0d20: 75 65 72 69 65 73 2e 20 20 54 68 69 73 20 66 75  ueries.  This fu
0d30: 6e 63 74 69 6f 6e 20 72 65 71 75 69 72 65 73 20  nction requires 
0d40: 35 20 70 61 72 61 6d 65 74 65 72 73 20 61 73 20  5 parameters as 
0d50: 66 6f 6c 6c 6f 77 73 3a 3c 2f 70 3e 0a 0a 3c 6f  follows:</p>..<o
0d60: 6c 3e 0a 3c 6c 69 3e 3c 70 3e 41 20 70 6f 69 6e  l>.<li><p>A poin
0d70: 74 65 72 20 74 6f 20 74 68 65 20 73 71 6c 69 74  ter to the sqlit
0d80: 65 20 73 74 72 75 63 74 75 72 65 20 6f 62 74 61  e structure obta
0d90: 69 6e 65 64 20 66 72 6f 6d 20 61 20 70 72 69 6f  ined from a prio
0da0: 72 20 63 61 6c 6c 0a 20 20 20 20 20 20 20 74 6f  r call.       to
0db0: 20 3c 62 3e 73 71 6c 69 74 65 5f 6f 70 65 6e 28   <b>sqlite_open(
0dc0: 29 3c 2f 62 3e 2e 3c 2f 70 3e 3c 2f 6c 69 3e 0a  )</b>.</p></li>.
0dd0: 3c 6c 69 3e 3c 70 3e 41 20 6e 75 6c 6c 2d 74 65  <li><p>A null-te
0de0: 72 6d 69 6e 61 74 65 64 20 73 74 72 69 6e 67 20  rminated string 
0df0: 63 6f 6e 74 61 69 6e 69 6e 67 20 74 68 65 20 74  containing the t
0e00: 65 78 74 20 6f 66 20 6f 6e 65 20 6f 72 20 6d 6f  ext of one or mo
0e10: 72 65 0a 20 20 20 20 20 20 20 53 51 4c 20 73 74  re.       SQL st
0e20: 61 74 65 6d 65 6e 74 73 20 61 6e 64 2f 6f 72 20  atements and/or 
0e30: 71 75 65 72 69 65 73 20 74 6f 20 62 65 20 70 72  queries to be pr
0e40: 6f 63 65 73 73 65 64 2e 3c 2f 70 3e 3c 2f 6c 69  ocessed.</p></li
0e50: 3e 0a 3c 6c 69 3e 3c 70 3e 41 20 70 6f 69 6e 74  >.<li><p>A point
0e60: 65 72 20 74 6f 20 61 20 63 61 6c 6c 62 61 63 6b  er to a callback
0e70: 20 66 75 6e 63 74 69 6f 6e 20 77 68 69 63 68 20   function which 
0e80: 69 73 20 69 6e 76 6f 6b 65 64 20 6f 6e 63 65 20  is invoked once 
0e90: 66 6f 72 20 65 61 63 68 0a 20 20 20 20 20 20 20  for each.       
0ea0: 72 6f 77 20 69 6e 20 74 68 65 20 72 65 73 75 6c  row in the resul
0eb0: 74 20 6f 66 20 61 20 71 75 65 72 79 2e 20 20 54  t of a query.  T
0ec0: 68 69 73 20 61 72 67 75 6d 65 6e 74 20 6d 61 79  his argument may
0ed0: 20 62 65 20 4e 55 4c 4c 2c 20 69 6e 20 77 68 69   be NULL, in whi
0ee0: 63 68 0a 20 20 20 20 20 20 20 63 61 73 65 20 6e  ch.       case n
0ef0: 6f 20 63 61 6c 6c 62 61 63 6b 73 20 77 69 6c 6c  o callbacks will
0f00: 20 65 76 65 72 20 62 65 20 69 6e 76 6f 6b 65 64   ever be invoked
0f10: 2e 3c 2f 70 3e 3c 2f 6c 69 3e 0a 3c 6c 69 3e 3c  .</p></li>.<li><
0f20: 70 3e 41 20 70 6f 69 6e 74 65 72 20 74 68 61 74  p>A pointer that
0f30: 20 69 73 20 66 6f 72 77 61 72 64 65 64 20 74 6f   is forwarded to
0f40: 20 62 65 63 6f 6d 65 20 74 68 65 20 66 69 72 73   become the firs
0f50: 74 20 61 72 67 75 6d 65 6e 74 0a 20 20 20 20 20  t argument.     
0f60: 20 20 74 6f 20 74 68 65 20 63 61 6c 6c 62 61 63    to the callbac
0f70: 6b 20 66 75 6e 63 74 69 6f 6e 2e 3c 2f 70 3e 3c  k function.</p><
0f80: 2f 6c 69 3e 0a 3c 6c 69 3e 3c 70 3e 41 20 70 6f  /li>.<li><p>A po
0f90: 69 6e 74 65 72 20 74 6f 20 61 6e 20 65 72 72 6f  inter to an erro
0fa0: 72 20 73 74 72 69 6e 67 2e 20 20 45 72 72 6f 72  r string.  Error
0fb0: 20 6d 65 73 73 61 67 65 73 20 61 72 65 20 77 72   messages are wr
0fc0: 69 74 74 65 6e 20 74 6f 20 73 70 61 63 65 0a 20  itten to space. 
0fd0: 20 20 20 20 20 20 6f 62 74 61 69 6e 65 64 20 66        obtained f
0fe0: 72 6f 6d 20 6d 61 6c 6c 6f 63 28 29 20 61 6e 64  rom malloc() and
0ff0: 20 74 68 65 20 65 72 72 6f 72 20 73 74 72 69 6e   the error strin
1000: 67 20 69 73 20 6d 61 64 65 20 74 6f 20 70 6f 69  g is made to poi
1010: 6e 74 20 74 6f 0a 20 20 20 20 20 20 20 74 68 65  nt to.       the
1020: 20 6d 61 6c 6c 6f 63 65 64 20 73 70 61 63 65 2e   malloced space.
1030: 20 20 54 68 65 20 63 61 6c 6c 69 6e 67 20 66 75    The calling fu
1040: 6e 63 74 69 6f 6e 20 69 73 20 72 65 73 70 6f 6e  nction is respon
1050: 73 69 62 6c 65 20 66 6f 72 20 66 72 65 65 69 6e  sible for freein
1060: 67 0a 20 20 20 20 20 20 20 74 68 69 73 20 73 70  g.       this sp
1070: 61 63 65 20 77 68 65 6e 20 69 74 20 68 61 73 20  ace when it has 
1080: 66 69 6e 69 73 68 65 64 20 77 69 74 68 20 69 74  finished with it
1090: 2e 0a 20 20 20 20 20 20 20 54 68 69 73 20 61 72  ..       This ar
10a0: 67 75 6d 65 6e 74 20 6d 61 79 20 62 65 20 4e 55  gument may be NU
10b0: 4c 4c 2c 20 69 6e 20 77 68 69 63 68 20 63 61 73  LL, in which cas
10c0: 65 20 65 72 72 6f 72 20 6d 65 73 73 61 67 65 73  e error messages
10d0: 20 61 72 65 20 6e 6f 74 0a 20 20 20 20 20 20 20   are not.       
10e0: 72 65 70 6f 72 74 65 64 20 62 61 63 6b 20 74 6f  reported back to
10f0: 20 74 68 65 20 63 61 6c 6c 69 6e 67 20 66 75 6e   the calling fun
1100: 63 74 69 6f 6e 2e 3c 2f 70 3e 3c 2f 6c 69 3e 0a  ction.</p></li>.
1110: 3c 2f 6f 6c 3e 0a 0a 3c 70 3e 0a 54 68 65 20 63  </ol>..<p>.The c
1120: 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e  allback function
1130: 20 69 73 20 75 73 65 64 20 74 6f 20 72 65 63 65   is used to rece
1140: 69 76 65 20 74 68 65 20 72 65 73 75 6c 74 73 20  ive the results 
1150: 6f 66 20 61 20 71 75 65 72 79 2e 20 20 41 0a 70  of a query.  A.p
1160: 72 6f 74 6f 74 79 70 65 20 66 6f 72 20 74 68 65  rototype for the
1170: 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69   callback functi
1180: 6f 6e 20 69 73 20 61 73 20 66 6f 6c 6c 6f 77 73  on is as follows
1190: 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f  :</p>..<blockquo
11a0: 74 65 3e 3c 70 72 65 3e 0a 69 6e 74 20 43 61 6c  te><pre>.int Cal
11b0: 6c 62 61 63 6b 28 76 6f 69 64 20 2a 70 41 72 67  lback(void *pArg
11c0: 2c 20 69 6e 74 20 61 72 67 63 2c 20 63 68 61 72  , int argc, char
11d0: 20 2a 2a 61 72 67 76 2c 20 63 68 61 72 20 2a 2a   **argv, char **
11e0: 63 6f 6c 75 6d 6e 4e 61 6d 65 73 29 7b 0a 20 20  columnNames){.  
11f0: 72 65 74 75 72 6e 20 30 3b 0a 7d 0a 3c 2f 70 72  return 0;.}.</pr
1200: 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  e></blockquote>.
1210: 0a 3c 70 3e 54 68 65 20 66 69 72 73 74 20 61 72  .<p>The first ar
1220: 67 75 6d 65 6e 74 20 74 6f 20 74 68 65 20 63 61  gument to the ca
1230: 6c 6c 62 61 63 6b 20 69 73 20 6a 75 73 74 20 61  llback is just a
1240: 20 63 6f 70 79 20 6f 66 20 74 68 65 20 66 6f 75   copy of the fou
1250: 72 74 68 20 61 72 67 75 6d 65 6e 74 0a 74 6f 20  rth argument.to 
1260: 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29  <b>sqlite_exec()
1270: 3c 2f 62 3e 20 20 54 68 69 73 20 70 61 72 61 6d  </b>  This param
1280: 65 74 65 72 20 63 61 6e 20 62 65 20 75 73 65 64  eter can be used
1290: 20 74 6f 20 70 61 73 73 20 61 72 62 69 74 72 61   to pass arbitra
12a0: 72 79 0a 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 74  ry.information t
12b0: 68 72 6f 75 67 68 20 74 6f 20 74 68 65 20 63 61  hrough to the ca
12c0: 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 20  llback function 
12d0: 66 72 6f 6d 20 63 6c 69 65 6e 74 20 63 6f 64 65  from client code
12e0: 2e 0a 54 68 65 20 73 65 63 6f 6e 64 20 61 72 67  ..The second arg
12f0: 75 6d 65 6e 74 20 69 73 20 74 68 65 20 6e 75 6d  ument is the num
1300: 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 20 69  ber of columns i
1310: 6e 20 74 68 65 20 71 75 65 72 79 20 72 65 73 75  n the query resu
1320: 6c 74 2e 0a 54 68 65 20 74 68 69 72 64 20 61 72  lt..The third ar
1330: 67 75 6d 65 6e 74 20 69 73 20 61 6e 20 61 72 72  gument is an arr
1340: 61 79 20 6f 66 20 70 6f 69 6e 74 65 72 73 20 74  ay of pointers t
1350: 6f 20 73 74 72 69 6e 67 73 20 77 68 65 72 65 20  o strings where 
1360: 65 61 63 68 20 73 74 72 69 6e 67 0a 69 73 20 61  each string.is a
1370: 20 73 69 6e 67 6c 65 20 63 6f 6c 75 6d 6e 20 6f   single column o
1380: 66 20 74 68 65 20 72 65 73 75 6c 74 20 66 6f 72  f the result for
1390: 20 74 68 61 74 20 72 65 63 6f 72 64 2e 20 20 4e   that record.  N
13a0: 6f 74 65 20 74 68 61 74 20 74 68 65 0a 63 61 6c  ote that the.cal
13b0: 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 20 72  lback function r
13c0: 65 70 6f 72 74 73 20 61 20 4e 55 4c 4c 20 76 61  eports a NULL va
13d0: 6c 75 65 20 69 6e 20 74 68 65 20 64 61 74 61 62  lue in the datab
13e0: 61 73 65 20 61 73 20 61 20 4e 55 4c 4c 20 70 6f  ase as a NULL po
13f0: 69 6e 74 65 72 2c 0a 77 68 69 63 68 20 69 73 20  inter,.which is 
1400: 76 65 72 79 20 64 69 66 66 65 72 65 6e 74 20 66  very different f
1410: 72 6f 6d 20 61 6e 20 65 6d 70 74 79 20 73 74 72  rom an empty str
1420: 69 6e 67 2e 20 20 49 66 20 74 68 65 20 69 2d 74  ing.  If the i-t
1430: 68 20 70 61 72 61 6d 65 74 65 72 0a 69 73 20 61  h parameter.is a
1440: 6e 20 65 6d 70 74 79 20 73 74 72 69 6e 67 2c 20  n empty string, 
1450: 77 65 20 77 69 6c 6c 20 67 65 74 3a 3c 2f 70 3e  we will get:</p>
1460: 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72  .<blockquote><pr
1470: 65 3e 0a 61 72 67 76 5b 69 5d 5b 30 5d 20 3d 3d  e>.argv[i][0] ==
1480: 20 30 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b   0.</pre></block
1490: 71 75 6f 74 65 3e 0a 3c 70 3e 42 75 74 20 69 66  quote>.<p>But if
14a0: 20 74 68 65 20 69 2d 74 68 20 70 61 72 61 6d 65   the i-th parame
14b0: 74 65 72 20 69 73 20 4e 55 4c 4c 20 77 65 20 77  ter is NULL we w
14c0: 69 6c 6c 20 67 65 74 3a 3c 2f 70 3e 0a 3c 62 6c  ill get:</p>.<bl
14d0: 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 61  ockquote><pre>.a
14e0: 72 67 76 5b 69 5d 20 3d 3d 20 30 0a 3c 2f 70 72  rgv[i] == 0.</pr
14f0: 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  e></blockquote>.
1500: 3c 70 3e 54 68 65 20 6e 61 6d 65 73 20 6f 66 20  <p>The names of 
1510: 74 68 65 20 63 6f 6c 75 6d 6e 73 20 61 72 65 20  the columns are 
1520: 63 6f 6e 74 61 69 6e 65 64 20 69 6e 20 74 68 65  contained in the
1530: 20 66 6f 75 72 74 68 20 61 72 67 75 6d 65 6e 74   fourth argument
1540: 2e 3c 2f 70 3e 0a 0a 3c 70 3e 49 66 20 74 68 65  .</p>..<p>If the
1550: 20 45 4d 50 54 59 5f 52 45 53 55 4c 54 5f 43 41   EMPTY_RESULT_CA
1560: 4c 4c 42 41 43 4b 53 20 70 72 61 67 6d 61 20 69  LLBACKS pragma i
1570: 73 20 73 65 74 20 74 6f 20 4f 4e 20 61 6e 64 20  s set to ON and 
1580: 74 68 65 20 72 65 73 75 6c 74 20 6f 66 0a 61 20  the result of.a 
1590: 71 75 65 72 79 20 69 73 20 61 6e 20 65 6d 70 74  query is an empt
15a0: 79 20 73 65 74 2c 20 74 68 65 6e 20 74 68 65 20  y set, then the 
15b0: 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f  callback is invo
15c0: 6b 65 64 20 6f 6e 63 65 20 77 69 74 68 20 74 68  ked once with th
15d0: 65 0a 74 68 69 72 64 20 70 61 72 61 6d 65 74 65  e.third paramete
15e0: 72 20 28 61 72 67 76 29 20 73 65 74 20 74 6f 20  r (argv) set to 
15f0: 30 2e 20 20 49 6e 20 6f 74 68 65 72 20 77 6f 72  0.  In other wor
1600: 64 73 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c  ds.<blockquote><
1610: 70 72 65 3e 0a 61 72 67 76 20 3d 3d 20 30 0a 3c  pre>.argv == 0.<
1620: 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74  /pre></blockquot
1630: 65 3e 0a 54 68 65 20 73 65 63 6f 6e 64 20 70 61  e>.The second pa
1640: 72 61 6d 65 74 65 72 20 28 61 72 67 63 29 0a 61  rameter (argc).a
1650: 6e 64 20 74 68 65 20 66 6f 75 72 74 68 20 70 61  nd the fourth pa
1660: 72 61 6d 65 74 65 72 20 28 63 6f 6c 75 6d 6e 4e  rameter (columnN
1670: 61 6d 65 73 29 20 61 72 65 20 73 74 69 6c 6c 20  ames) are still 
1680: 76 61 6c 69 64 0a 61 6e 64 20 63 61 6e 20 62 65  valid.and can be
1690: 20 75 73 65 64 20 74 6f 20 64 65 74 65 72 6d 69   used to determi
16a0: 6e 65 20 74 68 65 20 6e 75 6d 62 65 72 20 61 6e  ne the number an
16b0: 64 20 6e 61 6d 65 73 20 6f 66 20 74 68 65 20 72  d names of the r
16c0: 65 73 75 6c 74 0a 63 6f 6c 75 6d 6e 73 20 69 66  esult.columns if
16d0: 20 74 68 65 72 65 20 68 61 64 20 62 65 65 6e 20   there had been 
16e0: 61 20 72 65 73 75 6c 74 2e 0a 54 68 65 20 64 65  a result..The de
16f0: 66 61 75 6c 74 20 62 65 68 61 76 69 6f 72 20 69  fault behavior i
1700: 73 20 6e 6f 74 20 74 6f 20 69 6e 76 6f 6b 65 20  s not to invoke 
1710: 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 61 74 20  the callback at 
1720: 61 6c 6c 20 69 66 20 74 68 65 0a 72 65 73 75 6c  all if the.resul
1730: 74 20 73 65 74 20 69 73 20 65 6d 70 74 79 2e 3c  t set is empty.<
1740: 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 63 61 6c 6c  /p>..<p>The call
1750: 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 20 73 68  back function sh
1760: 6f 75 6c 64 20 6e 6f 72 6d 61 6c 6c 79 20 72 65  ould normally re
1770: 74 75 72 6e 20 30 2e 20 20 49 66 20 74 68 65 20  turn 0.  If the 
1780: 63 61 6c 6c 62 61 63 6b 0a 66 75 6e 63 74 69 6f  callback.functio
1790: 6e 20 72 65 74 75 72 6e 73 20 6e 6f 6e 2d 7a 65  n returns non-ze
17a0: 72 6f 2c 20 74 68 65 20 71 75 65 72 79 20 69 73  ro, the query is
17b0: 20 69 6d 6d 65 64 69 61 74 65 6c 79 20 61 62 6f   immediately abo
17c0: 72 74 65 64 20 61 6e 64 20 0a 3c 62 3e 73 71 6c  rted and .<b>sql
17d0: 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e 20 77  ite_exec()</b> w
17e0: 69 6c 6c 20 72 65 74 75 72 6e 20 53 51 4c 49 54  ill return SQLIT
17f0: 45 5f 41 42 4f 52 54 2e 3c 2f 70 3e 0a 0a 3c 68  E_ABORT.</p>..<h
1800: 32 3e 45 72 72 6f 72 20 43 6f 64 65 73 3c 2f 68  2>Error Codes</h
1810: 32 3e 0a 0a 3c 70 3e 0a 54 68 65 20 3c 62 3e 73  2>..<p>.The <b>s
1820: 71 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e  qlite_exec()</b>
1830: 20 66 75 6e 63 74 69 6f 6e 20 6e 6f 72 6d 61 6c   function normal
1840: 6c 79 20 72 65 74 75 72 6e 73 20 53 51 4c 49 54  ly returns SQLIT
1850: 45 5f 4f 4b 2e 20 20 42 75 74 0a 69 66 20 73 6f  E_OK.  But.if so
1860: 6d 65 74 68 69 6e 67 20 67 6f 65 73 20 77 72 6f  mething goes wro
1870: 6e 67 20 69 74 20 63 61 6e 20 72 65 74 75 72 6e  ng it can return
1880: 20 61 20 64 69 66 66 65 72 65 6e 74 20 76 61 6c   a different val
1890: 75 65 20 74 6f 20 69 6e 64 69 63 61 74 65 0a 74  ue to indicate.t
18a0: 68 65 20 74 79 70 65 20 6f 66 20 65 72 72 6f 72  he type of error
18b0: 2e 20 20 48 65 72 65 20 69 73 20 61 20 63 6f 6d  .  Here is a com
18c0: 70 6c 65 74 65 20 6c 69 73 74 20 6f 66 20 74 68  plete list of th
18d0: 65 20 72 65 74 75 72 6e 20 63 6f 64 65 73 3a 0a  e return codes:.
18e0: 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74  </p>..<blockquot
18f0: 65 3e 3c 70 72 65 3e 0a 23 64 65 66 69 6e 65 20  e><pre>.#define 
1900: 53 51 4c 49 54 45 5f 4f 4b 20 20 20 20 20 20 20  SQLITE_OK       
1910: 20 20 20 20 30 20 20 20 2f 2a 20 53 75 63 63 65      0   /* Succe
1920: 73 73 66 75 6c 20 72 65 73 75 6c 74 20 2a 2f 0a  ssful result */.
1930: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 45  #define SQLITE_E
1940: 52 52 4f 52 20 20 20 20 20 20 20 20 31 20 20 20  RROR        1   
1950: 2f 2a 20 53 51 4c 20 65 72 72 6f 72 20 6f 72 20  /* SQL error or 
1960: 6d 69 73 73 69 6e 67 20 64 61 74 61 62 61 73 65  missing database
1970: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
1980: 54 45 5f 49 4e 54 45 52 4e 41 4c 20 20 20 20 20  TE_INTERNAL     
1990: 32 20 20 20 2f 2a 20 41 6e 20 69 6e 74 65 72 6e  2   /* An intern
19a0: 61 6c 20 6c 6f 67 69 63 20 65 72 72 6f 72 20 69  al logic error i
19b0: 6e 20 53 51 4c 69 74 65 20 2a 2f 0a 23 64 65 66  n SQLite */.#def
19c0: 69 6e 65 20 53 51 4c 49 54 45 5f 50 45 52 4d 20  ine SQLITE_PERM 
19d0: 20 20 20 20 20 20 20 20 33 20 20 20 2f 2a 20 41          3   /* A
19e0: 63 63 65 73 73 20 70 65 72 6d 69 73 73 69 6f 6e  ccess permission
19f0: 20 64 65 6e 69 65 64 20 2a 2f 0a 23 64 65 66 69   denied */.#defi
1a00: 6e 65 20 53 51 4c 49 54 45 5f 41 42 4f 52 54 20  ne SQLITE_ABORT 
1a10: 20 20 20 20 20 20 20 34 20 20 20 2f 2a 20 43 61         4   /* Ca
1a20: 6c 6c 62 61 63 6b 20 72 6f 75 74 69 6e 65 20 72  llback routine r
1a30: 65 71 75 65 73 74 65 64 20 61 6e 20 61 62 6f 72  equested an abor
1a40: 74 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  t */.#define SQL
1a50: 49 54 45 5f 42 55 53 59 20 20 20 20 20 20 20 20  ITE_BUSY        
1a60: 20 35 20 20 20 2f 2a 20 54 68 65 20 64 61 74 61   5   /* The data
1a70: 62 61 73 65 20 66 69 6c 65 20 69 73 20 6c 6f 63  base file is loc
1a80: 6b 65 64 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ked */.#define S
1a90: 51 4c 49 54 45 5f 4c 4f 43 4b 45 44 20 20 20 20  QLITE_LOCKED    
1aa0: 20 20 20 36 20 20 20 2f 2a 20 41 20 74 61 62 6c     6   /* A tabl
1ab0: 65 20 69 6e 20 74 68 65 20 64 61 74 61 62 61 73  e in the databas
1ac0: 65 20 69 73 20 6c 6f 63 6b 65 64 20 2a 2f 0a 23  e is locked */.#
1ad0: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4e 4f  define SQLITE_NO
1ae0: 4d 45 4d 20 20 20 20 20 20 20 20 37 20 20 20 2f  MEM        7   /
1af0: 2a 20 41 20 6d 61 6c 6c 6f 63 28 29 20 66 61 69  * A malloc() fai
1b00: 6c 65 64 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53  led */.#define S
1b10: 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c 59 20 20  QLITE_READONLY  
1b20: 20 20 20 38 20 20 20 2f 2a 20 41 74 74 65 6d 70     8   /* Attemp
1b30: 74 20 74 6f 20 77 72 69 74 65 20 61 20 72 65 61  t to write a rea
1b40: 64 6f 6e 6c 79 20 64 61 74 61 62 61 73 65 20 2a  donly database *
1b50: 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
1b60: 5f 49 4e 54 45 52 52 55 50 54 20 20 20 20 39 20  _INTERRUPT    9 
1b70: 20 20 2f 2a 20 4f 70 65 72 61 74 69 6f 6e 20 74    /* Operation t
1b80: 65 72 6d 69 6e 61 74 65 64 20 62 79 20 73 71 6c  erminated by sql
1b90: 69 74 65 5f 69 6e 74 65 72 72 75 70 74 28 29 20  ite_interrupt() 
1ba0: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
1bb0: 45 5f 49 4f 45 52 52 20 20 20 20 20 20 20 31 30  E_IOERR       10
1bc0: 20 20 20 2f 2a 20 53 6f 6d 65 20 6b 69 6e 64 20     /* Some kind 
1bd0: 6f 66 20 64 69 73 6b 20 49 2f 4f 20 65 72 72 6f  of disk I/O erro
1be0: 72 20 6f 63 63 75 72 72 65 64 20 2a 2f 0a 23 64  r occurred */.#d
1bf0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 52  efine SQLITE_COR
1c00: 52 55 50 54 20 20 20 20 20 31 31 20 20 20 2f 2a  RUPT     11   /*
1c10: 20 54 68 65 20 64 61 74 61 62 61 73 65 20 64 69   The database di
1c20: 73 6b 20 69 6d 61 67 65 20 69 73 20 6d 61 6c 66  sk image is malf
1c30: 6f 72 6d 65 64 20 2a 2f 0a 23 64 65 66 69 6e 65  ormed */.#define
1c40: 20 53 51 4c 49 54 45 5f 4e 4f 54 46 4f 55 4e 44   SQLITE_NOTFOUND
1c50: 20 20 20 20 31 32 20 20 20 2f 2a 20 28 49 6e 74      12   /* (Int
1c60: 65 72 6e 61 6c 20 4f 6e 6c 79 29 20 54 61 62 6c  ernal Only) Tabl
1c70: 65 20 6f 72 20 72 65 63 6f 72 64 20 6e 6f 74 20  e or record not 
1c80: 66 6f 75 6e 64 20 2a 2f 0a 23 64 65 66 69 6e 65  found */.#define
1c90: 20 53 51 4c 49 54 45 5f 46 55 4c 4c 20 20 20 20   SQLITE_FULL    
1ca0: 20 20 20 20 31 33 20 20 20 2f 2a 20 49 6e 73 65      13   /* Inse
1cb0: 72 74 69 6f 6e 20 66 61 69 6c 65 64 20 62 65 63  rtion failed bec
1cc0: 61 75 73 65 20 64 61 74 61 62 61 73 65 20 69 73  ause database is
1cd0: 20 66 75 6c 6c 20 2a 2f 0a 23 64 65 66 69 6e 65   full */.#define
1ce0: 20 53 51 4c 49 54 45 5f 43 41 4e 54 4f 50 45 4e   SQLITE_CANTOPEN
1cf0: 20 20 20 20 31 34 20 20 20 2f 2a 20 55 6e 61 62      14   /* Unab
1d00: 6c 65 20 74 6f 20 6f 70 65 6e 20 74 68 65 20 64  le to open the d
1d10: 61 74 61 62 61 73 65 20 66 69 6c 65 20 2a 2f 0a  atabase file */.
1d20: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 50  #define SQLITE_P
1d30: 52 4f 54 4f 43 4f 4c 20 20 20 20 31 35 20 20 20  ROTOCOL    15   
1d40: 2f 2a 20 44 61 74 61 62 61 73 65 20 6c 6f 63 6b  /* Database lock
1d50: 20 70 72 6f 74 6f 63 6f 6c 20 65 72 72 6f 72 20   protocol error 
1d60: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
1d70: 45 5f 45 4d 50 54 59 20 20 20 20 20 20 20 31 36  E_EMPTY       16
1d80: 20 20 20 2f 2a 20 28 49 6e 74 65 72 6e 61 6c 20     /* (Internal 
1d90: 4f 6e 6c 79 29 20 44 61 74 61 62 61 73 65 20 74  Only) Database t
1da0: 61 62 6c 65 20 69 73 20 65 6d 70 74 79 20 2a 2f  able is empty */
1db0: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
1dc0: 53 43 48 45 4d 41 20 20 20 20 20 20 31 37 20 20  SCHEMA      17  
1dd0: 20 2f 2a 20 54 68 65 20 64 61 74 61 62 61 73 65   /* The database
1de0: 20 73 63 68 65 6d 61 20 63 68 61 6e 67 65 64 20   schema changed 
1df0: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
1e00: 45 5f 54 4f 4f 42 49 47 20 20 20 20 20 20 31 38  E_TOOBIG      18
1e10: 20 20 20 2f 2a 20 54 6f 6f 20 6d 75 63 68 20 64     /* Too much d
1e20: 61 74 61 20 66 6f 72 20 6f 6e 65 20 72 6f 77 20  ata for one row 
1e30: 6f 66 20 61 20 74 61 62 6c 65 20 2a 2f 0a 23 64  of a table */.#d
1e40: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e  efine SQLITE_CON
1e50: 53 54 52 41 49 4e 54 20 20 31 39 20 20 20 2f 2a  STRAINT  19   /*
1e60: 20 41 62 6f 72 74 20 64 75 65 20 74 6f 20 63 6f   Abort due to co
1e70: 6e 74 72 61 69 6e 74 20 76 69 6f 6c 61 74 69 6f  ntraint violatio
1e80: 6e 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  n */.#define SQL
1e90: 49 54 45 5f 4d 49 53 4d 41 54 43 48 20 20 20 20  ITE_MISMATCH    
1ea0: 32 30 20 20 20 2f 2a 20 44 61 74 61 20 74 79 70  20   /* Data typ
1eb0: 65 20 6d 69 73 6d 61 74 63 68 20 2a 2f 0a 23 64  e mismatch */.#d
1ec0: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4d 49 53  efine SQLITE_MIS
1ed0: 55 53 45 20 20 20 20 20 20 32 31 20 20 20 2f 2a  USE      21   /*
1ee0: 20 4c 69 62 72 61 72 79 20 75 73 65 64 20 69 6e   Library used in
1ef0: 63 6f 72 72 65 63 74 6c 79 20 2a 2f 0a 3c 2f 70  correctly */.</p
1f00: 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e  re></blockquote>
1f10: 0a 0a 3c 70 3e 0a 54 68 65 20 6d 65 61 6e 69 6e  ..<p>.The meanin
1f20: 67 73 20 6f 66 20 74 68 65 73 65 20 76 61 72 69  gs of these vari
1f30: 6f 75 73 20 72 65 74 75 72 6e 20 76 61 6c 75 65  ous return value
1f40: 73 20 61 72 65 20 61 73 20 66 6f 6c 6c 6f 77 73  s are as follows
1f50: 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75  :.</p>..<blockqu
1f60: 6f 74 65 3e 0a 3c 64 6c 3e 0a 3c 64 74 3e 53 51  ote>.<dl>.<dt>SQ
1f70: 4c 49 54 45 5f 4f 4b 3c 2f 64 74 3e 0a 3c 64 64  LITE_OK</dt>.<dd
1f80: 3e 3c 70 3e 54 68 69 73 20 76 61 6c 75 65 20 69  ><p>This value i
1f90: 73 20 72 65 74 75 72 6e 65 64 20 69 66 20 65 76  s returned if ev
1fa0: 65 72 79 74 68 69 6e 67 20 77 6f 72 6b 65 64 20  erything worked 
1fb0: 61 6e 64 20 74 68 65 72 65 20 77 65 72 65 20 6e  and there were n
1fc0: 6f 20 65 72 72 6f 72 73 2e 0a 3c 2f 70 3e 3c 2f  o errors..</p></
1fd0: 64 64 3e 0a 3c 64 74 3e 53 51 4c 49 54 45 5f 49  dd>.<dt>SQLITE_I
1fe0: 4e 54 45 52 4e 41 4c 3c 2f 64 74 3e 0a 3c 64 64  NTERNAL</dt>.<dd
1ff0: 3e 3c 70 3e 54 68 69 73 20 76 61 6c 75 65 20 69  ><p>This value i
2000: 6e 64 69 63 61 74 65 73 20 74 68 61 74 20 61 6e  ndicates that an
2010: 20 69 6e 74 65 72 6e 61 6c 20 63 6f 6e 73 69 73   internal consis
2020: 74 65 6e 63 79 20 63 68 65 63 6b 20 77 69 74 68  tency check with
2030: 69 6e 0a 74 68 65 20 53 51 4c 69 74 65 20 6c 69  in.the SQLite li
2040: 62 72 61 72 79 20 66 61 69 6c 65 64 2e 20 20 54  brary failed.  T
2050: 68 69 73 20 63 61 6e 20 6f 6e 6c 79 20 68 61 70  his can only hap
2060: 70 65 6e 20 69 66 20 74 68 65 72 65 20 69 73 20  pen if there is 
2070: 61 20 62 75 67 20 69 6e 0a 74 68 65 20 53 51 4c  a bug in.the SQL
2080: 69 74 65 20 6c 69 62 72 61 72 79 2e 20 20 49 66  ite library.  If
2090: 20 79 6f 75 20 65 76 65 72 20 67 65 74 20 61 6e   you ever get an
20a0: 20 53 51 4c 49 54 45 5f 49 4e 54 45 52 4e 41 4c   SQLITE_INTERNAL
20b0: 20 72 65 70 6c 79 20 66 72 6f 6d 0a 61 6e 20 3c   reply from.an <
20c0: 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c  b>sqlite_exec()<
20d0: 2f 62 3e 20 63 61 6c 6c 2c 20 70 6c 65 61 73 65  /b> call, please
20e0: 20 72 65 70 6f 72 74 20 74 68 65 20 70 72 6f 62   report the prob
20f0: 6c 65 6d 20 6f 6e 20 74 68 65 20 53 51 4c 69 74  lem on the SQLit
2100: 65 0a 6d 61 69 6c 69 6e 67 20 6c 69 73 74 2e 0a  e.mailing list..
2110: 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51  </p></dd>.<dt>SQ
2120: 4c 49 54 45 5f 45 52 52 4f 52 3c 2f 64 74 3e 0a  LITE_ERROR</dt>.
2130: 3c 64 64 3e 3c 70 3e 54 68 69 73 20 72 65 74 75  <dd><p>This retu
2140: 72 6e 20 76 61 6c 75 65 20 69 6e 64 69 63 61 74  rn value indicat
2150: 65 73 20 74 68 61 74 20 74 68 65 72 65 20 77 61  es that there wa
2160: 73 20 61 6e 20 65 72 72 6f 72 20 69 6e 20 74 68  s an error in th
2170: 65 20 53 51 4c 0a 74 68 61 74 20 77 61 73 20 70  e SQL.that was p
2180: 61 73 73 65 64 20 69 6e 74 6f 20 74 68 65 20 3c  assed into the <
2190: 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c  b>sqlite_exec()<
21a0: 2f 62 3e 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c  /b>..</p></dd>.<
21b0: 64 74 3e 53 51 4c 49 54 45 5f 50 45 52 4d 3c 2f  dt>SQLITE_PERM</
21c0: 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20  dt>.<dd><p>This 
21d0: 72 65 74 75 72 6e 20 76 61 6c 75 65 20 73 61 79  return value say
21e0: 73 20 74 68 61 74 20 74 68 65 20 61 63 63 65 73  s that the acces
21f0: 73 20 70 65 72 6d 69 73 73 69 6f 6e 73 20 6f 6e  s permissions on
2200: 20 74 68 65 20 64 61 74 61 62 61 73 65 0a 66 69   the database.fi
2210: 6c 65 20 61 72 65 20 73 75 63 68 20 74 68 61 74  le are such that
2220: 20 74 68 65 20 66 69 6c 65 20 63 61 6e 6e 6f 74   the file cannot
2230: 20 62 65 20 6f 70 65 6e 65 64 2e 0a 3c 2f 70 3e   be opened..</p>
2240: 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51 4c 49 54 45  </dd>.<dt>SQLITE
2250: 5f 41 42 4f 52 54 3c 2f 64 74 3e 0a 3c 64 64 3e  _ABORT</dt>.<dd>
2260: 3c 70 3e 54 68 69 73 20 76 61 6c 75 65 20 69 73  <p>This value is
2270: 20 72 65 74 75 72 6e 65 64 20 69 66 20 74 68 65   returned if the
2280: 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69   callback functi
2290: 6f 6e 20 72 65 74 75 72 6e 73 20 6e 6f 6e 2d 7a  on returns non-z
22a0: 65 72 6f 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c  ero..</p></dd>.<
22b0: 64 74 3e 53 51 4c 49 54 45 5f 42 55 53 59 3c 2f  dt>SQLITE_BUSY</
22c0: 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20  dt>.<dd><p>This 
22d0: 72 65 74 75 72 6e 20 63 6f 64 65 20 69 6e 64 69  return code indi
22e0: 63 61 74 65 73 20 74 68 61 74 20 61 6e 6f 74 68  cates that anoth
22f0: 65 72 20 70 72 6f 67 72 61 6d 20 6f 72 20 74 68  er program or th
2300: 72 65 61 64 20 68 61 73 0a 74 68 65 20 64 61 74  read has.the dat
2310: 61 62 61 73 65 20 6c 6f 63 6b 65 64 2e 20 20 53  abase locked.  S
2320: 51 4c 69 74 65 20 61 6c 6c 6f 77 73 20 74 77 6f  QLite allows two
2330: 20 6f 72 20 6d 6f 72 65 20 74 68 72 65 61 64 73   or more threads
2340: 20 74 6f 20 72 65 61 64 20 74 68 65 0a 64 61 74   to read the.dat
2350: 61 62 61 73 65 20 61 74 20 74 68 65 20 73 61 6d  abase at the sam
2360: 65 20 74 69 6d 65 2c 20 62 75 74 20 6f 6e 6c 79  e time, but only
2370: 20 6f 6e 65 20 74 68 72 65 61 64 20 63 61 6e 20   one thread can 
2380: 68 61 76 65 20 74 68 65 20 64 61 74 61 62 61 73  have the databas
2390: 65 0a 6f 70 65 6e 20 66 6f 72 20 77 72 69 74 69  e.open for writi
23a0: 6e 67 20 61 74 20 74 68 65 20 73 61 6d 65 20 74  ng at the same t
23b0: 69 6d 65 2e 20 20 4c 6f 63 6b 69 6e 67 20 69 6e  ime.  Locking in
23c0: 20 53 51 4c 69 74 65 20 69 73 20 6f 6e 20 74 68   SQLite is on th
23d0: 65 0a 65 6e 74 69 72 65 20 64 61 74 61 62 61 73  e.entire databas
23e0: 65 2e 3c 2f 70 3e 0a 3c 2f 70 3e 3c 2f 64 64 3e  e.</p>.</p></dd>
23f0: 0a 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 4f 43 4b  .<dt>SQLITE_LOCK
2400: 45 44 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54  ED</dt>.<dd><p>T
2410: 68 69 73 20 72 65 74 75 72 6e 20 63 6f 64 65 20  his return code 
2420: 69 73 20 73 69 6d 69 6c 61 72 20 74 6f 20 53 51  is similar to SQ
2430: 4c 49 54 45 5f 42 55 53 59 20 69 6e 20 74 68 61  LITE_BUSY in tha
2440: 74 20 69 74 20 69 6e 64 69 63 61 74 65 73 0a 74  t it indicates.t
2450: 68 61 74 20 74 68 65 20 64 61 74 61 62 61 73 65  hat the database
2460: 20 69 73 20 6c 6f 63 6b 65 64 2e 20 20 42 75 74   is locked.  But
2470: 20 74 68 65 20 73 6f 75 72 63 65 20 6f 66 20 74   the source of t
2480: 68 65 20 6c 6f 63 6b 20 69 73 20 61 20 72 65 63  he lock is a rec
2490: 75 72 73 69 76 65 0a 63 61 6c 6c 20 74 6f 20 3c  ursive.call to <
24a0: 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c  b>sqlite_exec()<
24b0: 2f 62 3e 2e 20 20 54 68 69 73 20 72 65 74 75 72  /b>.  This retur
24c0: 6e 20 63 61 6e 20 6f 6e 6c 79 20 6f 63 63 75 72  n can only occur
24d0: 20 69 66 20 79 6f 75 20 61 74 74 65 6d 70 74 0a   if you attempt.
24e0: 74 6f 20 69 6e 76 6f 6b 65 20 73 71 6c 69 74 65  to invoke sqlite
24f0: 5f 65 78 65 63 28 29 20 66 72 6f 6d 20 77 69 74  _exec() from wit
2500: 68 69 6e 20 61 20 63 61 6c 6c 62 61 63 6b 20 72  hin a callback r
2510: 6f 75 74 69 6e 65 20 6f 66 20 61 20 71 75 65 72  outine of a quer
2520: 79 0a 66 72 6f 6d 20 61 20 70 72 69 6f 72 20 69  y.from a prior i
2530: 6e 76 6f 63 61 74 69 6f 6e 20 6f 66 20 73 71 6c  nvocation of sql
2540: 69 74 65 5f 65 78 65 63 28 29 2e 20 20 52 65 63  ite_exec().  Rec
2550: 75 72 73 69 76 65 20 63 61 6c 6c 73 20 74 6f 0a  ursive calls to.
2560: 73 71 6c 69 74 65 5f 65 78 65 63 28 29 20 61 72  sqlite_exec() ar
2570: 65 20 61 6c 6c 6f 77 65 64 20 61 73 20 6c 6f 6e  e allowed as lon
2580: 67 20 61 73 20 74 68 65 79 20 64 6f 0a 6e 6f 74  g as they do.not
2590: 20 61 74 74 65 6d 70 74 20 74 6f 20 77 72 69 74   attempt to writ
25a0: 65 20 74 68 65 20 73 61 6d 65 20 74 61 62 6c 65  e the same table
25b0: 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e  ..</p></dd>.<dt>
25c0: 53 51 4c 49 54 45 5f 4e 4f 4d 45 4d 3c 2f 64 74  SQLITE_NOMEM</dt
25d0: 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 76 61  >.<dd><p>This va
25e0: 6c 75 65 20 69 73 20 72 65 74 75 72 6e 65 64 20  lue is returned 
25f0: 69 66 20 61 20 63 61 6c 6c 20 74 6f 20 3c 62 3e  if a call to <b>
2600: 6d 61 6c 6c 6f 63 28 29 3c 2f 62 3e 20 66 61 69  malloc()</b> fai
2610: 6c 73 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64  ls..</p></dd>.<d
2620: 74 3e 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e 4c  t>SQLITE_READONL
2630: 59 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68  Y</dt>.<dd><p>Th
2640: 69 73 20 72 65 74 75 72 6e 20 63 6f 64 65 20 69  is return code i
2650: 6e 64 69 63 61 74 65 73 20 74 68 61 74 20 61 6e  ndicates that an
2660: 20 61 74 74 65 6d 70 74 20 77 61 73 20 6d 61 64   attempt was mad
2670: 65 20 74 6f 20 77 72 69 74 65 20 74 6f 0a 61 20  e to write to.a 
2680: 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 74 68  database file th
2690: 61 74 20 69 73 20 6f 70 65 6e 65 64 20 66 6f 72  at is opened for
26a0: 20 72 65 61 64 69 6e 67 20 6f 6e 6c 79 2e 0a 3c   reading only..<
26b0: 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51 4c  /p></dd>.<dt>SQL
26c0: 49 54 45 5f 49 4e 54 45 52 52 55 50 54 3c 2f 64  ITE_INTERRUPT</d
26d0: 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 76  t>.<dd><p>This v
26e0: 61 6c 75 65 20 69 73 20 72 65 74 75 72 6e 65 64  alue is returned
26f0: 20 69 66 20 61 20 63 61 6c 6c 20 74 6f 20 3c 62   if a call to <b
2700: 3e 73 71 6c 69 74 65 5f 69 6e 74 65 72 72 75 70  >sqlite_interrup
2710: 74 28 29 3c 2f 62 3e 0a 69 6e 74 65 72 72 75 70  t()</b>.interrup
2720: 74 73 20 61 20 64 61 74 61 62 61 73 65 20 6f 70  ts a database op
2730: 65 72 61 74 69 6f 6e 20 69 6e 20 70 72 6f 67 72  eration in progr
2740: 65 73 73 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c  ess..</p></dd>.<
2750: 64 74 3e 53 51 4c 49 54 45 5f 49 4f 45 52 52 3c  dt>SQLITE_IOERR<
2760: 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73  /dt>.<dd><p>This
2770: 20 76 61 6c 75 65 20 69 73 20 72 65 74 75 72 6e   value is return
2780: 65 64 20 69 66 20 74 68 65 20 6f 70 65 72 61 74  ed if the operat
2790: 69 6e 67 20 73 79 73 74 65 6d 20 69 6e 66 6f 72  ing system infor
27a0: 6d 73 20 53 51 4c 69 74 65 0a 74 68 61 74 20 69  ms SQLite.that i
27b0: 74 20 69 73 20 75 6e 61 62 6c 65 20 74 6f 20 70  t is unable to p
27c0: 65 72 66 6f 72 6d 20 73 6f 6d 65 20 64 69 73 6b  erform some disk
27d0: 20 49 2f 4f 20 6f 70 65 72 61 74 69 6f 6e 2e 20   I/O operation. 
27e0: 20 54 68 69 73 20 63 6f 75 6c 64 20 6d 65 61 6e   This could mean
27f0: 0a 74 68 61 74 20 74 68 65 72 65 20 69 73 20 6e  .that there is n
2800: 6f 20 6d 6f 72 65 20 73 70 61 63 65 20 6c 65 66  o more space lef
2810: 74 20 6f 6e 20 74 68 65 20 64 69 73 6b 2e 0a 3c  t on the disk..<
2820: 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51 4c  /p></dd>.<dt>SQL
2830: 49 54 45 5f 43 4f 52 52 55 50 54 3c 2f 64 74 3e  ITE_CORRUPT</dt>
2840: 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 76 61 6c  .<dd><p>This val
2850: 75 65 20 69 73 20 72 65 74 75 72 6e 65 64 20 69  ue is returned i
2860: 66 20 53 51 4c 69 74 65 20 64 65 74 65 63 74 73  f SQLite detects
2870: 20 74 68 61 74 20 74 68 65 20 64 61 74 61 62 61   that the databa
2880: 73 65 20 69 74 20 69 73 0a 77 6f 72 6b 69 6e 67  se it is.working
2890: 20 6f 6e 20 68 61 73 20 62 65 63 6f 6d 65 20 63   on has become c
28a0: 6f 72 72 75 70 74 65 64 2e 20 20 43 6f 72 72 75  orrupted.  Corru
28b0: 70 74 69 6f 6e 20 6d 69 67 68 74 20 6f 63 63 75  ption might occu
28c0: 72 20 64 75 65 20 74 6f 20 61 20 72 6f 67 75 65  r due to a rogue
28d0: 0a 70 72 6f 63 65 73 73 20 77 72 69 74 69 6e 67  .process writing
28e0: 20 74 6f 20 74 68 65 20 64 61 74 61 62 61 73 65   to the database
28f0: 20 66 69 6c 65 20 6f 72 20 69 74 20 6d 69 67 68   file or it migh
2900: 74 20 68 61 70 70 65 6e 20 64 75 65 20 74 6f 20  t happen due to 
2910: 61 6e 20 0a 70 65 72 76 69 6f 75 73 6c 79 20 75  an .perviously u
2920: 6e 64 65 74 65 63 74 65 64 20 6c 6f 67 69 63 20  ndetected logic 
2930: 65 72 72 6f 72 20 69 6e 20 6f 66 20 53 51 4c 69  error in of SQLi
2940: 74 65 2e 20 54 68 69 73 20 76 61 6c 75 65 20 69  te. This value i
2950: 73 20 61 6c 73 6f 0a 72 65 74 75 72 6e 65 64 20  s also.returned 
2960: 69 66 20 61 20 64 69 73 6b 20 49 2f 4f 20 65 72  if a disk I/O er
2970: 72 6f 72 20 6f 63 63 75 72 73 20 69 6e 20 73 75  ror occurs in su
2980: 63 68 20 61 20 77 61 79 20 74 68 61 74 20 53 51  ch a way that SQ
2990: 4c 69 74 65 20 69 73 20 66 6f 72 63 65 64 0a 74  Lite is forced.t
29a0: 6f 20 6c 65 61 76 65 20 74 68 65 20 64 61 74 61  o leave the data
29b0: 62 61 73 65 20 66 69 6c 65 20 69 6e 20 61 20 63  base file in a c
29c0: 6f 72 72 75 70 74 65 64 20 73 74 61 74 65 2e 20  orrupted state. 
29d0: 20 54 68 65 20 6c 61 74 74 65 72 20 73 68 6f 75   The latter shou
29e0: 6c 64 20 6f 6e 6c 79 0a 68 61 70 70 65 6e 20 64  ld only.happen d
29f0: 75 65 20 74 6f 20 61 20 68 61 72 64 77 61 72 65  ue to a hardware
2a00: 20 6f 72 20 6f 70 65 72 61 74 69 6e 67 20 73 79   or operating sy
2a10: 73 74 65 6d 20 6d 61 6c 66 75 6e 63 74 69 6f 6e  stem malfunction
2a20: 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e  ..</p></dd>.<dt>
2a30: 53 51 4c 49 54 45 5f 46 55 4c 4c 3c 2f 64 74 3e  SQLITE_FULL</dt>
2a40: 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 76 61 6c  .<dd><p>This val
2a50: 75 65 20 69 73 20 72 65 74 75 72 6e 65 64 20 69  ue is returned i
2a60: 66 20 61 6e 20 69 6e 73 65 72 74 69 6f 6e 20 66  f an insertion f
2a70: 61 69 6c 65 64 20 62 65 63 61 75 73 65 20 74 68  ailed because th
2a80: 65 72 65 20 69 73 0a 6e 6f 20 73 70 61 63 65 20  ere is.no space 
2a90: 6c 65 66 74 20 6f 6e 20 74 68 65 20 64 69 73 6b  left on the disk
2aa0: 2c 20 6f 72 20 74 68 65 20 64 61 74 61 62 61 73  , or the databas
2ab0: 65 20 69 73 20 74 6f 6f 20 62 69 67 20 74 6f 20  e is too big to 
2ac0: 68 6f 6c 64 20 61 6e 79 0a 6d 6f 72 65 20 69 6e  hold any.more in
2ad0: 66 6f 72 6d 61 74 69 6f 6e 2e 20 20 54 68 65 20  formation.  The 
2ae0: 6c 61 74 74 65 72 20 63 61 73 65 20 73 68 6f 75  latter case shou
2af0: 6c 64 20 6f 6e 6c 79 20 6f 63 63 75 72 20 66 6f  ld only occur fo
2b00: 72 20 64 61 74 61 62 61 73 65 73 0a 74 68 61 74  r databases.that
2b10: 20 61 72 65 20 6c 61 72 67 65 72 20 74 68 61 6e   are larger than
2b20: 20 32 47 42 20 69 6e 20 73 69 7a 65 2e 0a 3c 2f   2GB in size..</
2b30: 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51 4c 49  p></dd>.<dt>SQLI
2b40: 54 45 5f 43 41 4e 54 4f 50 45 4e 3c 2f 64 74 3e  TE_CANTOPEN</dt>
2b50: 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 76 61 6c  .<dd><p>This val
2b60: 75 65 20 69 73 20 72 65 74 75 72 6e 65 64 20 69  ue is returned i
2b70: 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66  f the database f
2b80: 69 6c 65 20 63 6f 75 6c 64 20 6e 6f 74 20 62 65  ile could not be
2b90: 20 6f 70 65 6e 65 64 0a 66 6f 72 20 73 6f 6d 65   opened.for some
2ba0: 20 72 65 61 73 6f 6e 2e 0a 3c 2f 70 3e 3c 2f 64   reason..</p></d
2bb0: 64 3e 0a 3c 64 74 3e 53 51 4c 49 54 45 5f 50 52  d>.<dt>SQLITE_PR
2bc0: 4f 54 4f 43 4f 4c 3c 2f 64 74 3e 0a 3c 64 64 3e  OTOCOL</dt>.<dd>
2bd0: 3c 70 3e 54 68 69 73 20 76 61 6c 75 65 20 69 73  <p>This value is
2be0: 20 72 65 74 75 72 6e 65 64 20 69 66 20 73 6f 6d   returned if som
2bf0: 65 20 6f 74 68 65 72 20 70 72 6f 63 65 73 73 20  e other process 
2c00: 69 73 20 6d 65 73 73 69 6e 67 20 77 69 74 68 0a  is messing with.
2c10: 66 69 6c 65 20 6c 6f 63 6b 73 20 61 6e 64 20 68  file locks and h
2c20: 61 73 20 76 69 6f 6c 61 74 65 64 20 74 68 65 20  as violated the 
2c30: 66 69 6c 65 20 6c 6f 63 6b 69 6e 67 20 70 72 6f  file locking pro
2c40: 74 6f 63 6f 6c 20 74 68 61 74 20 53 51 4c 69 74  tocol that SQLit
2c50: 65 20 75 73 65 73 0a 6f 6e 20 69 74 73 20 72 6f  e uses.on its ro
2c60: 6c 6c 62 61 63 6b 20 6a 6f 75 72 6e 61 6c 20 66  llback journal f
2c70: 69 6c 65 73 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a  iles..</p></dd>.
2c80: 3c 64 74 3e 53 51 4c 49 54 45 5f 53 43 48 45 4d  <dt>SQLITE_SCHEM
2c90: 41 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 57 68  A</dt>.<dd><p>Wh
2ca0: 65 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20  en the database 
2cb0: 66 69 72 73 74 20 6f 70 65 6e 65 64 2c 20 53 51  first opened, SQ
2cc0: 4c 69 74 65 20 72 65 61 64 73 20 74 68 65 20 64  Lite reads the d
2cd0: 61 74 61 62 61 73 65 20 73 63 68 65 6d 61 0a 69  atabase schema.i
2ce0: 6e 74 6f 20 6d 65 6d 6f 72 79 20 61 6e 64 20 75  nto memory and u
2cf0: 73 65 73 20 74 68 61 74 20 73 63 68 65 6d 61 20  ses that schema 
2d00: 74 6f 20 70 61 72 73 65 20 6e 65 77 20 53 51 4c  to parse new SQL
2d10: 20 73 74 61 74 65 6d 65 6e 74 73 2e 20 20 49 66   statements.  If
2d20: 20 61 6e 6f 74 68 65 72 0a 70 72 6f 63 65 73 73   another.process
2d30: 20 63 68 61 6e 67 65 73 20 74 68 65 20 73 63 68   changes the sch
2d40: 65 6d 61 2c 20 74 68 65 20 63 6f 6d 6d 61 6e 64  ema, the command
2d50: 20 63 75 72 72 65 6e 74 6c 79 20 62 65 69 6e 67   currently being
2d60: 20 70 72 6f 63 65 73 73 65 64 20 77 69 6c 6c 0a   processed will.
2d70: 61 62 6f 72 74 20 62 65 63 61 75 73 65 20 74 68  abort because th
2d80: 65 20 76 69 72 74 75 61 6c 20 6d 61 63 68 69 6e  e virtual machin
2d90: 65 20 63 6f 64 65 20 67 65 6e 65 72 61 74 65 64  e code generated
2da0: 20 61 73 73 75 6d 65 64 20 74 68 65 20 6f 6c 64   assumed the old
2db0: 0a 73 63 68 65 6d 61 2e 20 20 54 68 69 73 20 69  .schema.  This i
2dc0: 73 20 74 68 65 20 72 65 74 75 72 6e 20 63 6f 64  s the return cod
2dd0: 65 20 66 6f 72 20 73 75 63 68 20 63 61 73 65 73  e for such cases
2de0: 2e 20 20 52 65 74 72 79 69 6e 67 20 74 68 65 0a  .  Retrying the.
2df0: 63 6f 6d 6d 61 6e 64 20 75 73 75 61 6c 6c 79 20  command usually 
2e00: 77 69 6c 6c 20 63 6c 65 61 72 20 74 68 65 20 70  will clear the p
2e10: 72 6f 62 6c 65 6d 2e 0a 3c 2f 70 3e 3c 2f 64 64  roblem..</p></dd
2e20: 3e 0a 3c 64 74 3e 53 51 4c 49 54 45 5f 54 4f 4f  >.<dt>SQLITE_TOO
2e30: 42 49 47 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e  BIG</dt>.<dd><p>
2e40: 53 51 4c 69 74 65 20 77 69 6c 6c 20 6e 6f 74 20  SQLite will not 
2e50: 73 74 6f 72 65 20 6d 6f 72 65 20 74 68 61 6e 20  store more than 
2e60: 61 62 6f 75 74 20 31 20 6d 65 67 61 62 79 74 65  about 1 megabyte
2e70: 20 6f 66 20 64 61 74 61 20 69 6e 20 61 20 73 69   of data in a si
2e80: 6e 67 6c 65 0a 72 6f 77 20 6f 66 20 61 20 73 69  ngle.row of a si
2e90: 6e 67 6c 65 20 74 61 62 6c 65 2e 20 20 49 66 20  ngle table.  If 
2ea0: 79 6f 75 20 61 74 74 65 6d 70 74 20 74 6f 20 73  you attempt to s
2eb0: 74 6f 72 65 20 6d 6f 72 65 20 74 68 61 6e 20 31  tore more than 1
2ec0: 20 6d 65 67 61 62 79 74 65 0a 69 6e 20 61 20 73   megabyte.in a s
2ed0: 69 6e 67 6c 65 20 72 6f 77 2c 20 74 68 69 73 20  ingle row, this 
2ee0: 69 73 20 74 68 65 20 72 65 74 75 72 6e 20 63 6f  is the return co
2ef0: 64 65 20 79 6f 75 20 67 65 74 2e 0a 3c 2f 70 3e  de you get..</p>
2f00: 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51 4c 49 54 45  </dd>.<dt>SQLITE
2f10: 5f 43 4f 4e 53 54 52 41 49 4e 54 3c 2f 64 74 3e  _CONSTRAINT</dt>
2f20: 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 63 6f 6e  .<dd><p>This con
2f30: 73 74 61 6e 74 20 69 73 20 72 65 74 75 72 6e 65  stant is returne
2f40: 64 20 69 66 20 74 68 65 20 53 51 4c 20 73 74 61  d if the SQL sta
2f50: 74 65 6d 65 6e 74 20 77 6f 75 6c 64 20 68 61 76  tement would hav
2f60: 65 20 76 69 6f 6c 61 74 65 64 0a 61 20 64 61 74  e violated.a dat
2f70: 61 62 61 73 65 20 63 6f 6e 73 74 72 61 69 6e 74  abase constraint
2f80: 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e  ..</p></dd>.<dt>
2f90: 53 51 4c 49 54 45 5f 4d 49 53 4d 41 54 43 48 3c  SQLITE_MISMATCH<
2fa0: 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73  /dt>.<dd><p>This
2fb0: 20 65 72 72 6f 72 20 6f 63 63 75 72 73 20 77 68   error occurs wh
2fc0: 65 6e 20 74 68 65 72 65 20 69 73 20 61 6e 20 61  en there is an a
2fd0: 74 74 65 6d 70 74 20 74 6f 20 69 6e 73 65 72 74  ttempt to insert
2fe0: 20 6e 6f 6e 2d 69 6e 74 65 67 65 72 0a 64 61 74   non-integer.dat
2ff0: 61 20 69 6e 74 6f 20 61 20 63 6f 6c 75 6d 6e 20  a into a column 
3000: 6c 61 62 65 6c 65 64 20 49 4e 54 45 47 45 52 20  labeled INTEGER 
3010: 50 52 49 4d 41 52 59 20 4b 45 59 2e 20 20 46 6f  PRIMARY KEY.  Fo
3020: 72 20 6d 6f 73 74 20 63 6f 6c 75 6d 6e 73 2c 20  r most columns, 
3030: 53 51 4c 69 74 65 0a 69 67 6e 6f 72 65 73 20 74  SQLite.ignores t
3040: 68 65 20 64 61 74 61 20 74 79 70 65 20 61 6e 64  he data type and
3050: 20 61 6c 6c 6f 77 73 20 61 6e 79 20 6b 69 6e 64   allows any kind
3060: 20 6f 66 20 64 61 74 61 20 74 6f 20 62 65 20 73   of data to be s
3070: 74 6f 72 65 64 2e 20 20 42 75 74 0a 61 6e 20 49  tored.  But.an I
3080: 4e 54 45 47 45 52 20 50 52 49 4d 41 52 59 20 4b  NTEGER PRIMARY K
3090: 45 59 20 63 6f 6c 75 6d 6e 20 69 73 20 6f 6e 6c  EY column is onl
30a0: 79 20 61 6c 6c 6f 77 65 64 20 74 6f 20 73 74 6f  y allowed to sto
30b0: 72 65 20 69 6e 74 65 67 65 72 20 64 61 74 61 2e  re integer data.
30c0: 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53  .</p></dd>.<dt>S
30d0: 51 4c 49 54 45 5f 4d 49 53 55 53 45 3c 2f 64 74  QLITE_MISUSE</dt
30e0: 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 65 72  >.<dd><p>This er
30f0: 72 6f 72 20 6d 69 67 68 74 20 6f 63 63 75 72 20  ror might occur 
3100: 69 66 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 20 6f  if one or more o
3110: 66 20 74 68 65 20 53 51 4c 69 74 65 20 41 50 49  f the SQLite API
3120: 20 72 6f 75 74 69 6e 65 73 0a 69 73 20 75 73 65   routines.is use
3130: 64 20 69 6e 63 6f 72 72 65 63 74 6c 79 2e 20 20  d incorrectly.  
3140: 45 78 61 6d 70 6c 65 73 20 6f 66 20 69 6e 63 6f  Examples of inco
3150: 72 72 65 63 74 20 75 73 61 67 65 20 69 6e 63 6c  rrect usage incl
3160: 75 64 65 20 63 61 6c 6c 69 6e 67 0a 3c 62 3e 73  ude calling.<b>s
3170: 71 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e  qlite_exec()</b>
3180: 20 61 66 74 65 72 20 74 68 65 20 64 61 74 61 62   after the datab
3190: 61 73 65 20 68 61 73 20 62 65 65 6e 20 63 6c 6f  ase has been clo
31a0: 73 65 64 20 75 73 69 6e 67 0a 3c 62 3e 73 71 6c  sed using.<b>sql
31b0: 69 74 65 5f 63 6c 6f 73 65 28 29 3c 2f 62 3e 20  ite_close()</b> 
31c0: 6f 72 20 63 61 6c 6c 69 6e 67 20 3c 62 3e 73 71  or calling <b>sq
31d0: 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e 20  lite_exec()</b> 
31e0: 77 69 74 68 20 74 68 65 20 73 61 6d 65 0a 64 61  with the same.da
31f0: 74 61 62 61 73 65 20 70 6f 69 6e 74 65 72 20 73  tabase pointer s
3200: 69 6d 75 6c 74 61 6e 65 6f 75 73 6c 79 20 66 72  imultaneously fr
3210: 6f 6d 20 74 77 6f 20 73 65 70 61 72 61 74 65 20  om two separate 
3220: 74 68 72 65 61 64 73 2e 20 20 54 68 65 0a 6c 69  threads.  The.li
3230: 62 72 61 72 79 20 6d 61 6b 65 73 20 61 6e 20 65  brary makes an e
3240: 66 66 6f 72 74 20 74 6f 20 64 65 74 65 63 74 20  ffort to detect 
3250: 74 68 65 73 65 20 73 6f 72 74 73 20 6f 66 20 70  these sorts of p
3260: 72 6f 62 6c 65 6d 73 2c 20 62 75 74 20 69 74 0a  roblems, but it.
3270: 63 61 6e 6e 6f 74 20 64 65 74 65 63 74 20 74 68  cannot detect th
3280: 65 6d 20 77 69 74 68 20 31 30 30 25 20 61 63 63  em with 100% acc
3290: 75 72 61 63 79 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e  uracy..</p></dd>
32a0: 0a 3c 2f 64 6c 3e 0a 3c 2f 62 6c 6f 63 6b 71 75  .</dl>.</blockqu
32b0: 6f 74 65 3e 0a 0a 3c 68 32 3e 54 68 65 20 45 78  ote>..<h2>The Ex
32c0: 74 65 6e 64 65 64 20 41 50 49 3c 2f 68 32 3e 0a  tended API</h2>.
32d0: 0a 3c 70 3e 4f 6e 6c 79 20 74 68 65 20 74 68 72  .<p>Only the thr
32e0: 65 65 20 63 6f 72 65 20 72 6f 75 74 69 6e 65 73  ee core routines
32f0: 20 73 68 6f 77 6e 20 61 62 6f 76 65 20 61 72 65   shown above are
3300: 20 72 65 71 75 69 72 65 64 20 74 6f 20 75 73 65   required to use
3310: 0a 53 51 4c 69 74 65 2e 20 20 42 75 74 20 74 68  .SQLite.  But th
3320: 65 72 65 20 61 72 65 20 6d 61 6e 79 20 6f 74 68  ere are many oth
3330: 65 72 20 66 75 6e 63 74 69 6f 6e 73 20 74 68 61  er functions tha
3340: 74 20 70 72 6f 76 69 64 65 20 0a 75 73 65 66 75  t provide .usefu
3350: 6c 20 69 6e 74 65 72 66 61 63 65 73 2e 20 20 54  l interfaces.  T
3360: 68 65 73 65 20 65 78 74 65 6e 64 65 64 20 72 6f  hese extended ro
3370: 75 74 69 6e 65 73 20 61 72 65 20 61 73 20 66 6f  utines are as fo
3380: 6c 6c 6f 77 73 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c  llows:.</p>..<bl
3390: 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 69  ockquote><pre>.i
33a0: 6e 74 20 73 71 6c 69 74 65 5f 6c 61 73 74 5f 69  nt sqlite_last_i
33b0: 6e 73 65 72 74 5f 72 6f 77 69 64 28 73 71 6c 69  nsert_rowid(sqli
33c0: 74 65 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74  te*);..int sqlit
33d0: 65 5f 63 68 61 6e 67 65 73 28 73 71 6c 69 74 65  e_changes(sqlite
33e0: 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 5f  *);..int sqlite_
33f0: 67 65 74 5f 74 61 62 6c 65 28 0a 20 20 73 71 6c  get_table(.  sql
3400: 69 74 65 2a 2c 0a 20 20 63 68 61 72 20 2a 73 71  ite*,.  char *sq
3410: 6c 2c 0a 20 20 63 68 61 72 20 2a 2a 2a 72 65 73  l,.  char ***res
3420: 75 6c 74 2c 0a 20 20 69 6e 74 20 2a 6e 72 6f 77  ult,.  int *nrow
3430: 2c 0a 20 20 69 6e 74 20 2a 6e 63 6f 6c 75 6d 6e  ,.  int *ncolumn
3440: 2c 0a 20 20 63 68 61 72 20 2a 2a 65 72 72 6d 73  ,.  char **errms
3450: 67 0a 29 3b 0a 0a 76 6f 69 64 20 73 71 6c 69 74  g.);..void sqlit
3460: 65 5f 66 72 65 65 5f 74 61 62 6c 65 28 63 68 61  e_free_table(cha
3470: 72 2a 2a 29 3b 0a 0a 76 6f 69 64 20 73 71 6c 69  r**);..void sqli
3480: 74 65 5f 69 6e 74 65 72 72 75 70 74 28 73 71 6c  te_interrupt(sql
3490: 69 74 65 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69  ite*);..int sqli
34a0: 74 65 5f 63 6f 6d 70 6c 65 74 65 28 63 6f 6e 73  te_complete(cons
34b0: 74 20 63 68 61 72 20 2a 73 71 6c 29 3b 0a 0a 76  t char *sql);..v
34c0: 6f 69 64 20 73 71 6c 69 74 65 5f 62 75 73 79 5f  oid sqlite_busy_
34d0: 68 61 6e 64 6c 65 72 28 73 71 6c 69 74 65 2a 2c  handler(sqlite*,
34e0: 20 69 6e 74 20 28 2a 29 28 76 6f 69 64 2a 2c 63   int (*)(void*,c
34f0: 6f 6e 73 74 20 63 68 61 72 2a 2c 69 6e 74 29 2c  onst char*,int),
3500: 20 76 6f 69 64 2a 29 3b 0a 0a 76 6f 69 64 20 73   void*);..void s
3510: 71 6c 69 74 65 5f 62 75 73 79 5f 74 69 6d 65 6f  qlite_busy_timeo
3520: 75 74 28 73 71 6c 69 74 65 2a 2c 20 69 6e 74 20  ut(sqlite*, int 
3530: 6d 73 29 3b 0a 0a 63 6f 6e 73 74 20 63 68 61 72  ms);..const char
3540: 20 73 71 6c 69 74 65 5f 76 65 72 73 69 6f 6e 5b   sqlite_version[
3550: 5d 3b 0a 0a 63 6f 6e 73 74 20 63 68 61 72 20 73  ];..const char s
3560: 71 6c 69 74 65 5f 65 6e 63 6f 64 69 6e 67 5b 5d  qlite_encoding[]
3570: 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 5f 65 78  ;..int sqlite_ex
3580: 65 63 5f 70 72 69 6e 74 66 28 0a 20 20 73 71 6c  ec_printf(.  sql
3590: 69 74 65 2a 2c 0a 20 20 63 68 61 72 20 2a 73 71  ite*,.  char *sq
35a0: 6c 2c 0a 20 20 69 6e 74 20 28 2a 29 28 76 6f 69  l,.  int (*)(voi
35b0: 64 2a 2c 69 6e 74 2c 63 68 61 72 2a 2a 2c 63 68  d*,int,char**,ch
35c0: 61 72 2a 2a 29 2c 0a 20 20 76 6f 69 64 2a 2c 0a  ar**),.  void*,.
35d0: 20 20 63 68 61 72 20 2a 2a 65 72 72 6d 73 67 2c    char **errmsg,
35e0: 0a 20 20 2e 2e 2e 0a 29 3b 0a 0a 69 6e 74 20 73  .  ....);..int s
35f0: 71 6c 69 74 65 5f 65 78 65 63 5f 76 70 72 69 6e  qlite_exec_vprin
3600: 74 66 28 0a 20 20 73 71 6c 69 74 65 2a 2c 0a 20  tf(.  sqlite*,. 
3610: 20 63 68 61 72 20 2a 73 71 6c 2c 0a 20 20 69 6e   char *sql,.  in
3620: 74 20 28 2a 29 28 76 6f 69 64 2a 2c 69 6e 74 2c  t (*)(void*,int,
3630: 63 68 61 72 2a 2a 2c 63 68 61 72 2a 2a 29 2c 0a  char**,char**),.
3640: 20 20 76 6f 69 64 2a 2c 0a 20 20 63 68 61 72 20    void*,.  char 
3650: 2a 2a 65 72 72 6d 73 67 2c 0a 20 20 76 61 5f 6c  **errmsg,.  va_l
3660: 69 73 74 0a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69  ist.);..int sqli
3670: 74 65 5f 67 65 74 5f 74 61 62 6c 65 5f 70 72 69  te_get_table_pri
3680: 6e 74 66 28 0a 20 20 73 71 6c 69 74 65 2a 2c 0a  ntf(.  sqlite*,.
3690: 20 20 63 68 61 72 20 2a 73 71 6c 2c 0a 20 20 63    char *sql,.  c
36a0: 68 61 72 20 2a 2a 2a 72 65 73 75 6c 74 2c 0a 20  har ***result,. 
36b0: 20 69 6e 74 20 2a 6e 72 6f 77 2c 0a 20 20 69 6e   int *nrow,.  in
36c0: 74 20 2a 6e 63 6f 6c 75 6d 6e 2c 0a 20 20 63 68  t *ncolumn,.  ch
36d0: 61 72 20 2a 2a 65 72 72 6d 73 67 2c 0a 20 20 2e  ar **errmsg,.  .
36e0: 2e 2e 0a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74  ...);..int sqlit
36f0: 65 5f 67 65 74 5f 74 61 62 6c 65 5f 76 70 72 69  e_get_table_vpri
3700: 6e 74 66 28 0a 20 20 73 71 6c 69 74 65 2a 2c 0a  ntf(.  sqlite*,.
3710: 20 20 63 68 61 72 20 2a 73 71 6c 2c 0a 20 20 63    char *sql,.  c
3720: 68 61 72 20 2a 2a 2a 72 65 73 75 6c 74 2c 0a 20  har ***result,. 
3730: 20 69 6e 74 20 2a 6e 72 6f 77 2c 0a 20 20 69 6e   int *nrow,.  in
3740: 74 20 2a 6e 63 6f 6c 75 6d 6e 2c 0a 20 20 63 68  t *ncolumn,.  ch
3750: 61 72 20 2a 2a 65 72 72 6d 73 67 2c 0a 20 20 76  ar **errmsg,.  v
3760: 61 5f 6c 69 73 74 0a 29 3b 0a 0a 3c 2f 70 72 65  a_list.);..</pre
3770: 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a  ></blockquote>..
3780: 3c 70 3e 41 6c 6c 20 6f 66 20 74 68 65 20 61 62  <p>All of the ab
3790: 6f 76 65 20 64 65 66 69 6e 69 74 69 6f 6e 73 20  ove definitions 
37a0: 61 72 65 20 69 6e 63 6c 75 64 65 64 20 69 6e 20  are included in 
37b0: 74 68 65 20 22 73 71 6c 69 74 65 2e 68 22 0a 68  the "sqlite.h".h
37c0: 65 61 64 65 72 20 66 69 6c 65 20 74 68 61 74 20  eader file that 
37d0: 63 6f 6d 65 73 20 69 6e 20 74 68 65 20 73 6f 75  comes in the sou
37e0: 72 63 65 20 74 72 65 65 2e 3c 2f 70 3e 0a 0a 3c  rce tree.</p>..<
37f0: 68 32 3e 54 68 65 20 52 4f 57 49 44 20 6f 66 20  h2>The ROWID of 
3800: 74 68 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 20  the most recent 
3810: 69 6e 73 65 72 74 3c 2f 68 32 3e 0a 0a 3c 70 3e  insert</h2>..<p>
3820: 45 76 65 72 79 20 72 6f 77 20 6f 66 20 61 6e 20  Every row of an 
3830: 53 51 4c 69 74 65 20 74 61 62 6c 65 20 68 61 73  SQLite table has
3840: 20 61 20 75 6e 69 71 75 65 20 69 6e 74 65 67 65   a unique intege
3850: 72 20 6b 65 79 2e 20 20 49 66 20 74 68 65 0a 74  r key.  If the.t
3860: 61 62 6c 65 20 68 61 73 20 61 20 63 6f 6c 75 6d  able has a colum
3870: 6e 20 6c 61 62 65 6c 65 64 20 49 4e 54 45 47 45  n labeled INTEGE
3880: 52 20 50 52 49 4d 41 52 59 20 4b 45 59 2c 20 74  R PRIMARY KEY, t
3890: 68 65 6e 20 74 68 61 74 20 63 6f 6c 75 6d 6e 0a  hen that column.
38a0: 73 65 72 76 65 72 73 20 61 73 20 74 68 65 20 6b  servers as the k
38b0: 65 79 2e 20 20 49 66 20 74 68 65 72 65 20 69 73  ey.  If there is
38c0: 20 6e 6f 20 49 4e 54 45 47 45 52 20 50 52 49 4d   no INTEGER PRIM
38d0: 41 52 59 20 4b 45 59 20 63 6f 6c 75 6d 6e 20 74  ARY KEY column t
38e0: 68 65 6e 0a 74 68 65 20 6b 65 79 20 69 73 20 61  hen.the key is a
38f0: 20 75 6e 69 71 75 65 20 69 6e 74 65 67 65 72 2e   unique integer.
3900: 20 20 54 68 65 20 6b 65 79 20 66 6f 72 20 61 20    The key for a 
3910: 72 6f 77 20 63 61 6e 20 62 65 20 61 63 63 65 73  row can be acces
3920: 73 65 64 20 69 6e 0a 61 20 53 45 4c 45 43 54 20  sed in.a SELECT 
3930: 73 74 61 74 65 6d 65 6e 74 20 6f 72 20 75 73 65  statement or use
3940: 64 20 69 6e 20 61 20 57 48 45 52 45 20 6f 72 20  d in a WHERE or 
3950: 4f 52 44 45 52 20 42 59 20 63 6c 61 75 73 65 20  ORDER BY clause 
3960: 75 73 69 6e 67 20 61 6e 79 0a 6f 66 20 74 68 65  using any.of the
3970: 20 6e 61 6d 65 73 20 22 52 4f 57 49 44 22 2c 20   names "ROWID", 
3980: 22 4f 49 44 22 2c 20 6f 72 20 22 5f 52 4f 57 49  "OID", or "_ROWI
3990: 44 5f 22 2e 3c 2f 70 3e 0a 0a 3c 70 3e 57 68 65  D_".</p>..<p>Whe
39a0: 6e 20 79 6f 75 20 64 6f 20 61 6e 20 69 6e 73 65  n you do an inse
39b0: 72 74 20 69 6e 74 6f 20 61 20 74 61 62 6c 65 20  rt into a table 
39c0: 74 68 61 74 20 64 6f 65 73 20 6e 6f 74 20 68 61  that does not ha
39d0: 76 65 20 61 6e 20 49 4e 54 45 47 45 52 20 50 52  ve an INTEGER PR
39e0: 49 4d 41 52 59 0a 4b 45 59 20 63 6f 6c 75 6d 6e  IMARY.KEY column
39f0: 2c 20 6f 72 20 69 66 20 74 68 65 20 74 61 62 6c  , or if the tabl
3a00: 65 20 64 6f 65 73 20 68 61 76 65 20 61 6e 20 49  e does have an I
3a10: 4e 54 45 47 45 52 20 50 52 49 4d 41 52 59 20 4b  NTEGER PRIMARY K
3a20: 45 59 20 62 75 74 20 74 68 65 20 76 61 6c 75 65  EY but the value
3a30: 0a 66 6f 72 20 74 68 61 74 20 63 6f 6c 75 6d 6e  .for that column
3a40: 20 69 73 20 6e 6f 74 20 73 70 65 63 69 66 69 65   is not specifie
3a50: 64 20 69 6e 20 74 68 65 20 56 41 4c 55 45 53 20  d in the VALUES 
3a60: 63 6c 61 75 73 65 20 6f 66 20 74 68 65 20 69 6e  clause of the in
3a70: 73 65 72 74 2c 20 74 68 65 6e 0a 74 68 65 20 6b  sert, then.the k
3a80: 65 79 20 69 73 20 61 75 74 6f 6d 61 74 69 63 61  ey is automatica
3a90: 6c 6c 79 20 67 65 6e 65 72 61 74 65 64 2e 20 20  lly generated.  
3aa0: 59 6f 75 20 63 61 6e 20 66 69 6e 64 20 74 68 65  You can find the
3ab0: 20 76 61 6c 75 65 20 6f 66 20 74 68 65 20 6b 65   value of the ke
3ac0: 79 0a 66 6f 72 20 74 68 65 20 6d 6f 73 74 20 72  y.for the most r
3ad0: 65 63 65 6e 74 20 49 4e 53 45 52 54 20 73 74 61  ecent INSERT sta
3ae0: 74 65 6d 65 6e 74 20 75 73 69 6e 67 20 74 68 65  tement using the
3af0: 0a 3c 62 3e 73 71 6c 69 74 65 5f 6c 61 73 74 5f  .<b>sqlite_last_
3b00: 69 6e 73 65 72 74 5f 72 6f 77 69 64 28 29 3c 2f  insert_rowid()</
3b10: 62 3e 20 41 50 49 20 66 75 6e 63 74 69 6f 6e 2e  b> API function.
3b20: 3c 2f 70 3e 0a 0a 3c 68 32 3e 54 68 65 20 6e 75  </p>..<h2>The nu
3b30: 6d 62 65 72 20 6f 66 20 72 6f 77 73 20 74 68 61  mber of rows tha
3b40: 74 20 63 68 61 6e 67 65 64 3c 2f 68 32 3e 0a 0a  t changed</h2>..
3b50: 3c 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69 74 65  <p>The <b>sqlite
3b60: 5f 63 68 61 6e 67 65 73 28 29 3c 2f 62 3e 20 41  _changes()</b> A
3b70: 50 49 20 66 75 6e 63 74 69 6f 6e 20 72 65 74 75  PI function retu
3b80: 72 6e 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f  rns the number o
3b90: 66 20 72 6f 77 73 0a 74 68 61 74 20 77 65 72 65  f rows.that were
3ba0: 20 69 6e 73 65 72 74 65 64 2c 20 64 65 6c 65 74   inserted, delet
3bb0: 65 64 2c 20 6f 72 20 6d 6f 64 69 66 69 65 64 20  ed, or modified 
3bc0: 64 75 72 69 6e 67 20 74 68 65 20 6d 6f 73 74 20  during the most 
3bd0: 72 65 63 65 6e 74 0a 3c 62 3e 73 71 6c 69 74 65  recent.<b>sqlite
3be0: 5f 65 78 65 63 28 29 3c 2f 62 3e 20 63 61 6c 6c  _exec()</b> call
3bf0: 2e 20 20 54 68 65 20 6e 75 6d 62 65 72 20 72 65  .  The number re
3c00: 70 6f 72 74 65 64 20 69 6e 63 6c 75 64 65 73 20  ported includes 
3c10: 61 6e 79 20 63 68 61 6e 67 65 73 0a 74 68 61 74  any changes.that
3c20: 20 77 65 72 65 20 6c 61 74 65 72 20 75 6e 64 6f   were later undo
3c30: 20 62 79 20 61 20 52 4f 4c 4c 42 41 43 4b 20 6f   by a ROLLBACK o
3c40: 72 20 41 42 4f 52 54 2e 20 20 42 75 74 20 72 6f  r ABORT.  But ro
3c50: 77 73 20 74 68 61 74 20 61 72 65 0a 64 65 6c 65  ws that are.dele
3c60: 74 65 64 20 62 65 63 61 75 73 65 20 6f 66 20 61  ted because of a
3c70: 20 44 52 4f 50 20 54 41 42 4c 45 20 61 72 65 20   DROP TABLE are 
3c80: 3c 65 6d 3e 6e 6f 74 3c 2f 65 6d 3e 20 63 6f 75  <em>not</em> cou
3c90: 6e 74 65 64 2e 3c 2f 70 3e 0a 0a 3c 70 3e 53 51  nted.</p>..<p>SQ
3ca0: 4c 69 74 65 20 69 6d 70 6c 65 6d 65 6e 74 73 20  Lite implements 
3cb0: 74 68 65 20 63 6f 6d 6d 61 6e 64 20 22 3c 62 3e  the command "<b>
3cc0: 44 45 4c 45 54 45 20 46 52 4f 4d 20 74 61 62 6c  DELETE FROM tabl
3cd0: 65 3c 2f 62 3e 22 20 28 77 69 74 68 6f 75 74 0a  e</b>" (without.
3ce0: 61 20 57 48 45 52 45 20 63 6c 61 75 73 65 29 20  a WHERE clause) 
3cf0: 62 79 20 64 72 6f 70 70 69 6e 67 20 74 68 65 20  by dropping the 
3d00: 74 61 62 6c 65 20 74 68 65 6e 20 72 65 63 72 65  table then recre
3d10: 61 74 69 6e 67 20 69 74 2e 20 20 0a 54 68 69 73  ating it.  .This
3d20: 20 69 73 20 6d 75 63 68 20 66 61 73 74 65 72 20   is much faster 
3d30: 74 68 61 6e 20 64 65 6c 65 74 69 6e 67 20 74 68  than deleting th
3d40: 65 20 65 6c 65 6d 65 6e 74 73 20 6f 66 20 74 68  e elements of th
3d50: 65 20 74 61 62 6c 65 20 69 6e 64 69 76 69 64 75  e table individu
3d60: 61 6c 6c 79 2e 0a 42 75 74 20 69 74 20 61 6c 73  ally..But it als
3d70: 6f 20 6d 65 61 6e 73 20 74 68 61 74 20 74 68 65  o means that the
3d80: 20 76 61 6c 75 65 20 72 65 74 75 72 6e 65 64 20   value returned 
3d90: 66 72 6f 6d 20 3c 62 3e 73 71 6c 69 74 65 5f 63  from <b>sqlite_c
3da0: 68 61 6e 67 65 73 28 29 3c 2f 62 3e 0a 77 69 6c  hanges()</b>.wil
3db0: 6c 20 62 65 20 7a 65 72 6f 20 72 65 67 61 72 64  l be zero regard
3dc0: 6c 65 73 73 20 6f 66 20 74 68 65 20 6e 75 6d 62  less of the numb
3dd0: 65 72 20 6f 66 20 65 6c 65 6d 65 6e 74 73 20 74  er of elements t
3de0: 68 61 74 20 77 65 72 65 20 6f 72 69 67 69 6e 61  hat were origina
3df0: 6c 6c 79 0a 69 6e 20 74 68 65 20 74 61 62 6c 65  lly.in the table
3e00: 2e 20 20 49 66 20 61 6e 20 61 63 63 75 72 61 74  .  If an accurat
3e10: 65 20 63 6f 75 6e 74 20 6f 66 20 74 68 65 20 6e  e count of the n
3e20: 75 6d 62 65 72 20 6f 66 20 65 6c 65 6d 65 6e 74  umber of element
3e30: 73 20 64 65 6c 65 74 65 64 0a 69 73 20 6e 65 63  s deleted.is nec
3e40: 65 73 73 61 72 79 2c 20 75 73 65 20 22 3c 62 3e  essary, use "<b>
3e50: 44 45 4c 45 54 45 20 46 52 4f 4d 20 74 61 62 6c  DELETE FROM tabl
3e60: 65 20 57 48 45 52 45 20 31 3c 2f 62 3e 22 20 69  e WHERE 1</b>" i
3e70: 6e 73 74 65 61 64 2e 3c 2f 70 3e 0a 0a 3c 68 32  nstead.</p>..<h2
3e80: 3e 51 75 65 72 79 69 6e 67 20 77 69 74 68 6f 75  >Querying withou
3e90: 74 20 75 73 69 6e 67 20 61 20 63 61 6c 6c 62 61  t using a callba
3ea0: 63 6b 20 66 75 6e 63 74 69 6f 6e 3c 2f 68 32 3e  ck function</h2>
3eb0: 0a 0a 3c 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69  ..<p>The <b>sqli
3ec0: 74 65 5f 67 65 74 5f 74 61 62 6c 65 28 29 3c 2f  te_get_table()</
3ed0: 62 3e 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 61  b> function is a
3ee0: 20 77 72 61 70 70 65 72 20 61 72 6f 75 6e 64 0a   wrapper around.
3ef0: 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29  <b>sqlite_exec()
3f00: 3c 2f 62 3e 20 74 68 61 74 20 63 6f 6c 6c 65 63  </b> that collec
3f10: 74 73 20 61 6c 6c 20 74 68 65 20 69 6e 66 6f 72  ts all the infor
3f20: 6d 61 74 69 6f 6e 20 66 72 6f 6d 20 73 75 63 63  mation from succ
3f30: 65 73 73 69 76 65 0a 63 61 6c 6c 62 61 63 6b 73  essive.callbacks
3f40: 20 61 6e 64 20 77 72 69 74 65 20 69 74 20 69 6e   and write it in
3f50: 74 6f 20 6d 65 6d 6f 72 79 20 6f 62 74 61 69 6e  to memory obtain
3f60: 65 64 20 66 72 6f 6d 20 6d 61 6c 6c 6f 63 28 29  ed from malloc()
3f70: 2e 20 20 54 68 69 73 0a 69 73 20 61 20 63 6f 6e  .  This.is a con
3f80: 76 65 6e 69 65 6e 63 65 20 66 75 6e 63 74 69 6f  venience functio
3f90: 6e 20 74 68 61 74 20 61 6c 6c 6f 77 73 20 74 68  n that allows th
3fa0: 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 74 6f  e application to
3fb0: 20 67 65 74 20 74 68 65 0a 65 6e 74 69 72 65 20   get the.entire 
3fc0: 72 65 73 75 6c 74 20 6f 66 20 61 20 64 61 74 61  result of a data
3fd0: 62 61 73 65 20 71 75 65 72 79 20 77 69 74 68 20  base query with 
3fe0: 61 20 73 69 6e 67 6c 65 20 66 75 6e 63 74 69 6f  a single functio
3ff0: 6e 20 63 61 6c 6c 2e 3c 2f 70 3e 0a 0a 3c 70 3e  n call.</p>..<p>
4000: 54 68 65 20 6d 61 69 6e 20 72 65 73 75 6c 74 20  The main result 
4010: 66 72 6f 6d 20 3c 62 3e 73 71 6c 69 74 65 5f 67  from <b>sqlite_g
4020: 65 74 5f 74 61 62 6c 65 28 29 3c 2f 62 3e 20 69  et_table()</b> i
4030: 73 20 61 6e 20 61 72 72 61 79 20 6f 66 20 70 6f  s an array of po
4040: 69 6e 74 65 72 73 0a 74 6f 20 73 74 72 69 6e 67  inters.to string
4050: 73 2e 20 20 54 68 65 72 65 20 69 73 20 6f 6e 65  s.  There is one
4060: 20 65 6c 65 6d 65 6e 74 20 69 6e 20 74 68 69 73   element in this
4070: 20 61 72 72 61 79 20 66 6f 72 20 65 61 63 68 20   array for each 
4080: 63 6f 6c 75 6d 6e 20 6f 66 0a 65 61 63 68 20 72  column of.each r
4090: 6f 77 20 69 6e 20 74 68 65 20 72 65 73 75 6c 74  ow in the result
40a0: 2e 20 20 4e 55 4c 4c 20 72 65 73 75 6c 74 73 20  .  NULL results 
40b0: 61 72 65 20 72 65 70 72 65 73 65 6e 74 65 64 20  are represented 
40c0: 62 79 20 61 20 4e 55 4c 4c 0a 70 6f 69 6e 74 65  by a NULL.pointe
40d0: 72 2e 20 49 6e 20 61 64 64 69 74 69 6f 6e 20 74  r. In addition t
40e0: 6f 20 74 68 65 20 72 65 67 75 6c 61 72 20 64 61  o the regular da
40f0: 74 61 2c 20 74 68 65 72 65 20 69 73 20 61 6e 20  ta, there is an 
4100: 61 64 64 65 64 20 72 6f 77 20 61 74 20 74 68 65  added row at the
4110: 20 0a 62 65 67 69 6e 6e 69 6e 67 20 6f 66 20 74   .beginning of t
4120: 68 65 20 61 72 72 61 79 20 74 68 61 74 20 63 6f  he array that co
4130: 6e 74 61 69 6e 73 20 74 68 65 20 6e 61 6d 65 73  ntains the names
4140: 20 6f 66 20 65 61 63 68 20 63 6f 6c 75 6d 6e 20   of each column 
4150: 6f 66 20 74 68 65 0a 72 65 73 75 6c 74 2e 3c 2f  of the.result.</
4160: 70 3e 0a 0a 3c 70 3e 41 73 20 61 6e 20 65 78 61  p>..<p>As an exa
4170: 6d 70 6c 65 2c 20 63 6f 6e 73 69 64 65 72 20 74  mple, consider t
4180: 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 71 75 65  he following que
4190: 72 79 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71  ry:</p>..<blockq
41a0: 75 6f 74 65 3e 0a 53 45 4c 45 43 54 20 65 6d 70  uote>.SELECT emp
41b0: 6c 6f 79 65 65 5f 6e 61 6d 65 2c 20 6c 6f 67 69  loyee_name, logi
41c0: 6e 2c 20 68 6f 73 74 20 46 52 4f 4d 20 75 73 65  n, host FROM use
41d0: 72 73 20 57 48 45 52 45 20 6c 6f 67 69 63 20 4c  rs WHERE logic L
41e0: 49 4b 45 20 27 64 25 27 3b 0a 3c 2f 62 6c 6f 63  IKE 'd%';.</bloc
41f0: 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 54 68 69 73  kquote>..<p>This
4200: 20 71 75 65 72 79 20 77 69 6c 6c 20 72 65 74 75   query will retu
4210: 72 6e 20 74 68 65 20 6e 61 6d 65 2c 20 6c 6f 67  rn the name, log
4220: 69 6e 20 61 6e 64 20 68 6f 73 74 20 63 6f 6d 70  in and host comp
4230: 75 74 65 72 20 6e 61 6d 65 0a 66 6f 72 20 65 76  uter name.for ev
4240: 65 72 79 20 65 6d 70 6c 6f 79 65 65 20 77 68 6f  ery employee who
4250: 73 65 20 6c 6f 67 69 6e 20 62 65 67 69 6e 73 20  se login begins 
4260: 77 69 74 68 20 74 68 65 20 6c 65 74 74 65 72 20  with the letter 
4270: 22 64 22 2e 20 20 49 66 20 74 68 69 73 0a 71 75  "d".  If this.qu
4280: 65 72 79 20 69 73 20 73 75 62 6d 69 74 74 65 64  ery is submitted
4290: 20 74 6f 20 3c 62 3e 73 71 6c 69 74 65 5f 67 65   to <b>sqlite_ge
42a0: 74 5f 74 61 62 6c 65 28 29 3c 2f 62 3e 20 74 68  t_table()</b> th
42b0: 65 20 72 65 73 75 6c 74 20 6d 69 67 68 74 0a 6c  e result might.l
42c0: 6f 6f 6b 20 6c 69 6b 65 20 74 68 69 73 3a 3c 2f  ook like this:</
42d0: 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e  p>..<blockquote>
42e0: 0a 6e 72 6f 77 20 3d 20 32 3c 62 72 3e 0a 6e 63  .nrow = 2<br>.nc
42f0: 6f 6c 75 6d 6e 20 3d 20 33 3c 62 72 3e 0a 72 65  olumn = 3<br>.re
4300: 73 75 6c 74 5b 30 5d 20 3d 20 22 65 6d 70 6c 6f  sult[0] = "emplo
4310: 79 65 65 5f 6e 61 6d 65 22 3c 62 72 3e 0a 72 65  yee_name"<br>.re
4320: 73 75 6c 74 5b 31 5d 20 3d 20 22 6c 6f 67 69 6e  sult[1] = "login
4330: 22 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 32 5d 20  "<br>.result[2] 
4340: 3d 20 22 68 6f 73 74 22 3c 62 72 3e 0a 72 65 73  = "host"<br>.res
4350: 75 6c 74 5b 33 5d 20 3d 20 22 64 75 6d 6d 79 22  ult[3] = "dummy"
4360: 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 34 5d 20 3d  <br>.result[4] =
4370: 20 22 4e 6f 20 73 75 63 68 20 75 73 65 72 22 3c   "No such user"<
4380: 62 72 3e 0a 72 65 73 75 6c 74 5b 35 5d 20 3d 20  br>.result[5] = 
4390: 30 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 36 5d 20  0<br>.result[6] 
43a0: 3d 20 22 44 2e 20 52 69 63 68 61 72 64 20 48 69  = "D. Richard Hi
43b0: 70 70 22 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 37  pp"<br>.result[7
43c0: 5d 20 3d 20 22 64 72 68 22 3c 62 72 3e 0a 72 65  ] = "drh"<br>.re
43d0: 73 75 6c 74 5b 38 5d 20 3d 20 22 7a 61 64 6f 6b  sult[8] = "zadok
43e0: 22 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  ".</blockquote>.
43f0: 0a 3c 70 3e 4e 6f 74 69 63 65 20 74 68 61 74 20  .<p>Notice that 
4400: 74 68 65 20 22 68 6f 73 74 22 20 76 61 6c 75 65  the "host" value
4410: 20 66 6f 72 20 74 68 65 20 22 64 75 6d 6d 79 22   for the "dummy"
4420: 20 72 65 63 6f 72 64 20 69 73 20 4e 55 4c 4c 20   record is NULL 
4430: 73 6f 0a 74 68 65 20 72 65 73 75 6c 74 5b 5d 20  so.the result[] 
4440: 61 72 72 61 79 20 63 6f 6e 74 61 69 6e 73 20 61  array contains a
4450: 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 61 74   NULL pointer at
4460: 20 74 68 61 74 20 73 6c 6f 74 2e 3c 2f 70 3e 0a   that slot.</p>.
4470: 0a 3c 70 3e 49 66 20 74 68 65 20 72 65 73 75 6c  .<p>If the resul
4480: 74 20 73 65 74 20 6f 66 20 61 20 71 75 65 72 79  t set of a query
4490: 20 69 73 20 65 6d 70 74 79 2c 20 74 68 65 6e 20   is empty, then 
44a0: 62 79 20 64 65 66 61 75 6c 74 0a 3c 62 3e 73 71  by default.<b>sq
44b0: 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 28 29  lite_get_table()
44c0: 3c 2f 62 3e 20 77 69 6c 6c 20 73 65 74 20 6e 72  </b> will set nr
44d0: 6f 77 20 74 6f 20 30 20 61 6e 64 20 6c 65 61 76  ow to 0 and leav
44e0: 65 20 69 74 73 0a 72 65 73 75 6c 74 20 70 61 72  e its.result par
44f0: 61 6d 65 74 65 72 20 69 73 20 73 65 74 20 74 6f  ameter is set to
4500: 20 4e 55 4c 4c 2e 20 20 42 75 74 20 69 66 20 74   NULL.  But if t
4510: 68 65 20 45 4d 50 54 59 5f 52 45 53 55 4c 54 5f  he EMPTY_RESULT_
4520: 43 41 4c 4c 42 41 43 4b 53 0a 70 72 61 67 6d 61  CALLBACKS.pragma
4530: 20 69 73 20 4f 4e 20 74 68 65 6e 20 74 68 65 20   is ON then the 
4540: 72 65 73 75 6c 74 20 70 61 72 61 6d 65 74 65 72  result parameter
4550: 20 69 73 20 69 6e 69 74 69 61 6c 69 7a 65 64 20   is initialized 
4560: 74 6f 20 74 68 65 20 6e 61 6d 65 73 0a 6f 66 20  to the names.of 
4570: 74 68 65 20 63 6f 6c 75 6d 6e 73 20 6f 6e 6c 79  the columns only
4580: 2e 20 20 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20  .  For example, 
4590: 63 6f 6e 73 69 64 65 72 20 74 68 69 73 20 71 75  consider this qu
45a0: 65 72 79 20 77 68 69 63 68 20 68 61 73 0a 61 6e  ery which has.an
45b0: 20 65 6d 70 74 79 20 72 65 73 75 6c 74 20 73 65   empty result se
45c0: 74 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75  t:</p>..<blockqu
45d0: 6f 74 65 3e 0a 53 45 4c 45 43 54 20 65 6d 70 6c  ote>.SELECT empl
45e0: 6f 79 65 65 5f 6e 61 6d 65 2c 20 6c 6f 67 69 6e  oyee_name, login
45f0: 2c 20 68 6f 73 74 20 46 52 4f 4d 20 75 73 65 72  , host FROM user
4600: 73 20 57 48 45 52 45 20 65 6d 70 6c 6f 79 65 65  s WHERE employee
4610: 5f 6e 61 6d 65 20 49 53 20 4e 55 4c 4c 3b 0a 3c  _name IS NULL;.<
4620: 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70  /blockquote>..<p
4630: 3e 0a 54 68 65 20 64 65 66 61 75 6c 74 20 62 65  >.The default be
4640: 68 61 76 69 6f 72 20 67 69 76 65 73 20 74 68 69  havior gives thi
4650: 73 20 72 65 73 75 6c 74 73 3a 0a 3c 2f 70 3e 0a  s results:.</p>.
4660: 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 6e 72  .<blockquote>.nr
4670: 6f 77 20 3d 20 30 3c 62 72 3e 0a 6e 63 6f 6c 75  ow = 0<br>.ncolu
4680: 6d 6e 20 3d 20 30 3c 62 72 3e 0a 72 65 73 75 6c  mn = 0<br>.resul
4690: 74 20 3d 20 30 3c 62 72 3e 0a 3c 2f 62 6c 6f 63  t = 0<br>.</bloc
46a0: 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 0a 42 75 74  kquote>..<p>.But
46b0: 20 69 66 20 74 68 65 20 45 4d 50 54 59 5f 52 45   if the EMPTY_RE
46c0: 53 55 4c 54 5f 43 41 4c 4c 42 41 43 4b 53 20 70  SULT_CALLBACKS p
46d0: 72 61 67 6d 61 20 69 73 20 4f 4e 2c 20 74 68 65  ragma is ON, the
46e0: 6e 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 0a  n the following.
46f0: 69 73 20 72 65 74 75 72 6e 65 64 3a 0a 3c 2f 70  is returned:.</p
4700: 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  >..<blockquote>.
4710: 6e 72 6f 77 20 3d 20 30 3c 62 72 3e 0a 6e 63 6f  nrow = 0<br>.nco
4720: 6c 75 6d 6e 20 3d 20 33 3c 62 72 3e 0a 72 65 73  lumn = 3<br>.res
4730: 75 6c 74 5b 30 5d 20 3d 20 22 65 6d 70 6c 6f 79  ult[0] = "employ
4740: 65 65 5f 6e 61 6d 65 22 3c 62 72 3e 0a 72 65 73  ee_name"<br>.res
4750: 75 6c 74 5b 31 5d 20 3d 20 22 6c 6f 67 69 6e 22  ult[1] = "login"
4760: 3c 62 72 3e 0a 72 65 73 75 6c 74 5b 32 5d 20 3d  <br>.result[2] =
4770: 20 22 68 6f 73 74 22 3c 62 72 3e 0a 3c 2f 62 6c   "host"<br>.</bl
4780: 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 4d 65  ockquote>..<p>Me
4790: 6d 6f 72 79 20 74 6f 20 68 6f 6c 64 20 74 68 65  mory to hold the
47a0: 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 72 65 74   information ret
47b0: 75 72 6e 65 64 20 62 79 20 3c 62 3e 73 71 6c 69  urned by <b>sqli
47c0: 74 65 5f 67 65 74 5f 74 61 62 6c 65 28 29 3c 2f  te_get_table()</
47d0: 62 3e 0a 69 73 20 6f 62 74 61 69 6e 65 64 20 66  b>.is obtained f
47e0: 72 6f 6d 20 6d 61 6c 6c 6f 63 28 29 2e 20 20 42  rom malloc().  B
47f0: 75 74 20 74 68 65 20 63 61 6c 6c 69 6e 67 20 66  ut the calling f
4800: 75 6e 63 74 69 6f 6e 20 73 68 6f 75 6c 64 20 6e  unction should n
4810: 6f 74 20 74 72 79 0a 74 6f 20 66 72 65 65 20 74  ot try.to free t
4820: 68 69 73 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20  his information 
4830: 64 69 72 65 63 74 6c 79 2e 20 20 49 6e 73 74 65  directly.  Inste
4840: 61 64 2c 20 70 61 73 73 20 74 68 65 20 63 6f 6d  ad, pass the com
4850: 70 6c 65 74 65 20 74 61 62 6c 65 0a 74 6f 20 3c  plete table.to <
4860: 62 3e 73 71 6c 69 74 65 5f 66 72 65 65 5f 74 61  b>sqlite_free_ta
4870: 62 6c 65 28 29 3c 2f 62 3e 20 77 68 65 6e 20 74  ble()</b> when t
4880: 68 65 20 74 61 62 6c 65 20 69 73 20 6e 6f 20 6c  he table is no l
4890: 6f 6e 67 65 72 20 6e 65 65 64 65 64 2e 0a 49 74  onger needed..It
48a0: 20 69 73 20 73 61 66 65 20 74 6f 20 63 61 6c 6c   is safe to call
48b0: 20 3c 62 3e 73 71 6c 69 74 65 5f 66 72 65 65 5f   <b>sqlite_free_
48c0: 74 61 62 6c 65 28 29 3c 2f 62 3e 20 77 69 74 68  table()</b> with
48d0: 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20   a NULL pointer 
48e0: 73 75 63 68 0a 61 73 20 77 6f 75 6c 64 20 62 65  such.as would be
48f0: 20 72 65 74 75 72 6e 65 64 20 69 66 20 74 68 65   returned if the
4900: 20 72 65 73 75 6c 74 20 73 65 74 20 69 73 20 65   result set is e
4910: 6d 70 74 79 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68  mpty.</p>..<p>Th
4920: 65 20 3c 62 3e 73 71 6c 69 74 65 5f 67 65 74 5f  e <b>sqlite_get_
4930: 74 61 62 6c 65 28 29 3c 2f 62 3e 20 72 6f 75 74  table()</b> rout
4940: 69 6e 65 20 72 65 74 75 72 6e 73 20 74 68 65 20  ine returns the 
4950: 73 61 6d 65 20 69 6e 74 65 67 65 72 0a 72 65 73  same integer.res
4960: 75 6c 74 20 63 6f 64 65 20 61 73 20 3c 62 3e 73  ult code as <b>s
4970: 71 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e  qlite_exec()</b>
4980: 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 49 6e 74 65 72  .</p>..<h2>Inter
4990: 72 75 70 74 69 6e 67 20 61 6e 20 53 51 4c 69 74  rupting an SQLit
49a0: 65 20 6f 70 65 72 61 74 69 6f 6e 3c 2f 68 32 3e  e operation</h2>
49b0: 0a 0a 3c 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69  ..<p>The <b>sqli
49c0: 74 65 5f 69 6e 74 65 72 72 75 70 74 28 29 3c 2f  te_interrupt()</
49d0: 62 3e 20 66 75 6e 63 74 69 6f 6e 20 63 61 6e 20  b> function can 
49e0: 62 65 20 63 61 6c 6c 65 64 20 66 72 6f 6d 20 61  be called from a
49f0: 0a 64 69 66 66 65 72 65 6e 74 20 74 68 72 65 61  .different threa
4a00: 64 20 6f 72 20 66 72 6f 6d 20 61 20 73 69 67 6e  d or from a sign
4a10: 61 6c 20 68 61 6e 64 6c 65 72 20 74 6f 20 63 61  al handler to ca
4a20: 75 73 65 20 74 68 65 20 63 75 72 72 65 6e 74 20  use the current 
4a30: 64 61 74 61 62 61 73 65 0a 6f 70 65 72 61 74 69  database.operati
4a40: 6f 6e 20 74 6f 20 65 78 69 74 20 61 74 20 69 74  on to exit at it
4a50: 73 20 66 69 72 73 74 20 6f 70 70 6f 72 74 75 6e  s first opportun
4a60: 69 74 79 2e 20 20 57 68 65 6e 20 74 68 69 73 20  ity.  When this 
4a70: 68 61 70 70 65 6e 73 2c 0a 74 68 65 20 3c 62 3e  happens,.the <b>
4a80: 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62  sqlite_exec()</b
4a90: 3e 20 72 6f 75 74 69 6e 65 20 28 6f 72 20 74 68  > routine (or th
4aa0: 65 20 65 71 75 69 76 61 6c 65 6e 74 29 20 74 68  e equivalent) th
4ab0: 61 74 20 73 74 61 72 74 65 64 0a 74 68 65 20 64  at started.the d
4ac0: 61 74 61 62 61 73 65 20 6f 70 65 72 61 74 69 6f  atabase operatio
4ad0: 6e 20 77 69 6c 6c 20 72 65 74 75 72 6e 20 53 51  n will return SQ
4ae0: 4c 49 54 45 5f 49 4e 54 45 52 52 55 50 54 2e 3c  LITE_INTERRUPT.<
4af0: 2f 70 3e 0a 0a 3c 68 32 3e 54 65 73 74 69 6e 67  /p>..<h2>Testing
4b00: 20 66 6f 72 20 61 20 63 6f 6d 70 6c 65 74 65 20   for a complete 
4b10: 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 3c 2f 68  SQL statement</h
4b20: 32 3e 0a 0a 3c 70 3e 54 68 65 20 6e 65 78 74 20  2>..<p>The next 
4b30: 69 6e 74 65 72 66 61 63 65 20 72 6f 75 74 69 6e  interface routin
4b40: 65 20 74 6f 20 53 51 4c 69 74 65 20 69 73 20 61  e to SQLite is a
4b50: 20 63 6f 6e 76 65 6e 69 65 6e 63 65 20 66 75 6e   convenience fun
4b60: 63 74 69 6f 6e 20 75 73 65 64 0a 74 6f 20 74 65  ction used.to te
4b70: 73 74 20 77 68 65 74 68 65 72 20 6f 72 20 6e 6f  st whether or no
4b80: 74 20 61 20 73 74 72 69 6e 67 20 66 6f 72 6d 73  t a string forms
4b90: 20 61 20 63 6f 6d 70 6c 65 74 65 20 53 51 4c 20   a complete SQL 
4ba0: 73 74 61 74 65 6d 65 6e 74 2e 0a 49 66 20 74 68  statement..If th
4bb0: 65 20 3c 62 3e 73 71 6c 69 74 65 5f 63 6f 6d 70  e <b>sqlite_comp
4bc0: 6c 65 74 65 28 29 3c 2f 62 3e 20 66 75 6e 63 74  lete()</b> funct
4bd0: 69 6f 6e 20 72 65 74 75 72 6e 73 20 74 72 75 65  ion returns true
4be0: 20 77 68 65 6e 20 69 74 73 20 69 6e 70 75 74 0a   when its input.
4bf0: 69 73 20 61 20 73 74 72 69 6e 67 2c 20 74 68 65  is a string, the
4c00: 6e 20 74 68 65 20 61 72 67 75 6d 65 6e 74 20 66  n the argument f
4c10: 6f 72 6d 73 20 61 20 63 6f 6d 70 6c 65 74 65 20  orms a complete 
4c20: 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2e 0a 54  SQL statement..T
4c30: 68 65 72 65 20 61 72 65 20 6e 6f 20 67 75 61 72  here are no guar
4c40: 61 6e 74 65 65 73 20 74 68 61 74 20 74 68 65 20  antees that the 
4c50: 73 79 6e 74 61 78 20 6f 66 20 74 68 61 74 20 73  syntax of that s
4c60: 74 61 74 65 6d 65 6e 74 20 69 73 20 63 6f 72 72  tatement is corr
4c70: 65 63 74 2c 0a 62 75 74 20 77 65 20 61 74 20 6c  ect,.but we at l
4c80: 65 61 73 74 20 6b 6e 6f 77 20 74 68 65 20 73 74  east know the st
4c90: 61 74 65 6d 65 6e 74 20 69 73 20 63 6f 6d 70 6c  atement is compl
4ca0: 65 74 65 2e 20 20 49 66 20 3c 62 3e 73 71 6c 69  ete.  If <b>sqli
4cb0: 74 65 5f 63 6f 6d 70 6c 65 74 65 28 29 3c 2f 62  te_complete()</b
4cc0: 3e 0a 72 65 74 75 72 6e 73 20 66 61 6c 73 65 2c  >.returns false,
4cd0: 20 74 68 65 6e 20 6d 6f 72 65 20 74 65 78 74 20   then more text 
4ce0: 69 73 20 72 65 71 75 69 72 65 64 20 74 6f 20 63  is required to c
4cf0: 6f 6d 70 6c 65 74 65 20 74 68 65 20 53 51 4c 20  omplete the SQL 
4d00: 73 74 61 74 65 6d 65 6e 74 2e 3c 2f 70 3e 0a 0a  statement.</p>..
4d10: 3c 70 3e 46 6f 72 20 74 68 65 20 70 75 72 70 6f  <p>For the purpo
4d20: 73 65 20 6f 66 20 74 68 65 20 3c 62 3e 73 71 6c  se of the <b>sql
4d30: 69 74 65 5f 63 6f 6d 70 6c 65 74 65 28 29 3c 2f  ite_complete()</
4d40: 62 3e 20 66 75 6e 63 74 69 6f 6e 2c 20 61 6e 20  b> function, an 
4d50: 53 51 4c 0a 73 74 61 74 65 6d 65 6e 74 20 69 73  SQL.statement is
4d60: 20 63 6f 6d 70 6c 65 74 65 20 69 66 20 69 74 20   complete if it 
4d70: 65 6e 64 73 20 69 6e 20 61 20 73 65 6d 69 63 6f  ends in a semico
4d80: 6c 6f 6e 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65  lon.</p>..<p>The
4d90: 20 3c 62 3e 73 71 6c 69 74 65 3c 2f 62 3e 20 63   <b>sqlite</b> c
4da0: 6f 6d 6d 61 6e 64 2d 6c 69 6e 65 20 75 74 69 6c  ommand-line util
4db0: 69 74 79 20 75 73 65 73 20 74 68 65 20 3c 62 3e  ity uses the <b>
4dc0: 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74 65 28  sqlite_complete(
4dd0: 29 3c 2f 62 3e 0a 66 75 6e 63 74 69 6f 6e 20 74  )</b>.function t
4de0: 6f 20 6b 6e 6f 77 20 77 68 65 6e 20 69 74 20 6e  o know when it n
4df0: 65 65 64 73 20 74 6f 20 63 61 6c 6c 20 3c 62 3e  eeds to call <b>
4e00: 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62  sqlite_exec()</b
4e10: 3e 2e 20 20 41 66 74 65 72 20 65 61 63 68 0a 6c  >.  After each.l
4e20: 69 6e 65 20 6f 66 20 69 6e 70 75 74 20 69 73 20  ine of input is 
4e30: 72 65 63 65 69 76 65 64 2c 20 3c 62 3e 73 71 6c  received, <b>sql
4e40: 69 74 65 3c 2f 62 3e 20 63 61 6c 6c 73 20 3c 62  ite</b> calls <b
4e50: 3e 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74 65  >sqlite_complete
4e60: 28 29 3c 2f 62 3e 0a 6f 6e 20 61 6c 6c 20 69 6e  ()</b>.on all in
4e70: 70 75 74 20 69 6e 20 69 74 73 20 62 75 66 66 65  put in its buffe
4e80: 72 2e 20 20 49 66 20 3c 62 3e 73 71 6c 69 74 65  r.  If <b>sqlite
4e90: 5f 63 6f 6d 70 6c 65 74 65 28 29 3c 2f 62 3e 20  _complete()</b> 
4ea0: 72 65 74 75 72 6e 73 20 74 72 75 65 2c 20 0a 74  returns true, .t
4eb0: 68 65 6e 20 3c 62 3e 73 71 6c 69 74 65 5f 65 78  hen <b>sqlite_ex
4ec0: 65 63 28 29 3c 2f 62 3e 20 69 73 20 63 61 6c 6c  ec()</b> is call
4ed0: 65 64 20 61 6e 64 20 74 68 65 20 69 6e 70 75 74  ed and the input
4ee0: 20 62 75 66 66 65 72 20 69 73 20 72 65 73 65 74   buffer is reset
4ef0: 2e 20 20 49 66 0a 3c 62 3e 73 71 6c 69 74 65 5f  .  If.<b>sqlite_
4f00: 63 6f 6d 70 6c 65 74 65 28 29 3c 2f 62 3e 20 72  complete()</b> r
4f10: 65 74 75 72 6e 73 20 66 61 6c 73 65 2c 20 74 68  eturns false, th
4f20: 65 6e 20 74 68 65 20 70 72 6f 6d 70 74 20 69 73  en the prompt is
4f30: 20 63 68 61 6e 67 65 64 20 74 6f 0a 74 68 65 20   changed to.the 
4f40: 63 6f 6e 74 69 6e 75 61 74 69 6f 6e 20 70 72 6f  continuation pro
4f50: 6d 70 74 20 61 6e 64 20 61 6e 6f 74 68 65 72 20  mpt and another 
4f60: 6c 69 6e 65 20 6f 66 20 74 65 78 74 20 69 73 20  line of text is 
4f70: 72 65 61 64 20 61 6e 64 20 61 64 64 65 64 20 74  read and added t
4f80: 6f 0a 74 68 65 20 69 6e 70 75 74 20 62 75 66 66  o.the input buff
4f90: 65 72 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 4c 69 62  er.</p>..<h2>Lib
4fa0: 72 61 72 79 20 76 65 72 73 69 6f 6e 20 73 74 72  rary version str
4fb0: 69 6e 67 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65  ing</h2>..<p>The
4fc0: 20 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79 20   SQLite library 
4fd0: 65 78 70 6f 72 74 73 20 74 68 65 20 73 74 72 69  exports the stri
4fe0: 6e 67 20 63 6f 6e 73 74 61 6e 74 20 6e 61 6d 65  ng constant name
4ff0: 64 0a 3c 62 3e 73 71 6c 69 74 65 5f 76 65 72 73  d.<b>sqlite_vers
5000: 69 6f 6e 3c 2f 62 3e 20 77 68 69 63 68 20 63 6f  ion</b> which co
5010: 6e 74 61 69 6e 73 20 74 68 65 20 76 65 72 73 69  ntains the versi
5020: 6f 6e 20 6e 75 6d 62 65 72 20 6f 66 20 74 68 65  on number of the
5030: 0a 6c 69 62 72 61 72 79 2e 20 20 54 68 65 20 68  .library.  The h
5040: 65 61 64 65 72 20 66 69 6c 65 20 63 6f 6e 74 61  eader file conta
5050: 69 6e 73 20 61 20 6d 61 63 72 6f 20 53 51 4c 49  ins a macro SQLI
5060: 54 45 5f 56 45 52 53 49 4f 4e 0a 77 69 74 68 20  TE_VERSION.with 
5070: 74 68 65 20 73 61 6d 65 20 69 6e 66 6f 72 6d 61  the same informa
5080: 74 69 6f 6e 2e 20 20 49 66 20 64 65 73 69 72 65  tion.  If desire
5090: 64 2c 20 61 20 70 72 6f 67 72 61 6d 20 63 61 6e  d, a program can
50a0: 20 63 6f 6d 70 61 72 65 0a 74 68 65 20 53 51 4c   compare.the SQL
50b0: 49 54 45 5f 56 45 52 53 49 4f 4e 20 6d 61 63 72  ITE_VERSION macr
50c0: 6f 20 61 67 61 69 6e 73 74 20 74 68 65 20 3c 62  o against the <b
50d0: 3e 73 71 6c 69 74 65 5f 76 65 72 73 69 6f 6e 3c  >sqlite_version<
50e0: 2f 62 3e 0a 73 74 72 69 6e 67 20 63 6f 6e 73 74  /b>.string const
50f0: 61 6e 74 20 74 6f 20 76 65 72 69 66 79 20 74 68  ant to verify th
5100: 61 74 20 74 68 65 20 76 65 72 73 69 6f 6e 20 6e  at the version n
5110: 75 6d 62 65 72 20 6f 66 20 74 68 65 0a 68 65 61  umber of the.hea
5120: 64 65 72 20 66 69 6c 65 20 61 6e 64 20 74 68 65  der file and the
5130: 20 6c 69 62 72 61 72 79 20 6d 61 74 63 68 2e 3c   library match.<
5140: 2f 70 3e 20 0a 0a 3c 68 32 3e 4c 69 62 72 61 72  /p> ..<h2>Librar
5150: 79 20 63 68 61 72 61 63 74 65 72 20 65 6e 63 6f  y character enco
5160: 64 69 6e 67 3c 2f 68 32 3e 0a 0a 3c 70 3e 42 79  ding</h2>..<p>By
5170: 20 64 65 66 61 75 6c 74 2c 20 53 51 4c 69 74 65   default, SQLite
5180: 20 61 73 73 75 6d 65 73 20 74 68 61 74 20 61 6c   assumes that al
5190: 6c 20 64 61 74 61 20 75 73 65 73 20 61 20 66 69  l data uses a fi
51a0: 78 65 64 2d 73 69 7a 65 0a 38 2d 62 69 74 20 63  xed-size.8-bit c
51b0: 68 61 72 61 63 74 65 72 20 28 69 73 6f 38 38 35  haracter (iso885
51c0: 39 29 2e 20 20 42 75 74 20 69 66 20 79 6f 75 20  9).  But if you 
51d0: 67 69 76 65 20 74 68 65 20 2d 2d 65 6e 61 62 6c  give the --enabl
51e0: 65 2d 75 74 66 38 20 6f 70 74 69 6f 6e 0a 74 6f  e-utf8 option.to
51f0: 20 74 68 65 20 63 6f 6e 66 69 67 75 72 65 20 73   the configure s
5200: 63 72 69 70 74 2c 20 74 68 65 6e 20 74 68 65 20  cript, then the 
5210: 6c 69 62 72 61 72 79 20 61 73 73 75 6d 65 73 20  library assumes 
5220: 55 54 46 2d 38 20 76 61 72 69 61 62 6c 65 0a 73  UTF-8 variable.s
5230: 69 7a 65 64 20 63 68 61 72 61 63 74 65 72 73 2e  ized characters.
5240: 20 20 54 68 69 73 20 6d 61 6b 65 73 20 61 20 64    This makes a d
5250: 69 66 66 65 72 65 6e 63 65 20 66 6f 72 20 74 68  ifference for th
5260: 65 20 4c 49 4b 45 20 61 6e 64 20 47 4c 4f 42 0a  e LIKE and GLOB.
5270: 6f 70 65 72 61 74 6f 72 73 20 61 6e 64 20 74 68  operators and th
5280: 65 20 4c 45 4e 47 54 48 28 29 20 61 6e 64 20 53  e LENGTH() and S
5290: 55 42 53 54 52 28 29 20 66 75 6e 63 74 69 6f 6e  UBSTR() function
52a0: 73 2e 20 20 54 68 65 20 73 74 61 74 69 63 0a 73  s.  The static.s
52b0: 74 72 69 6e 67 20 3c 62 3e 73 71 6c 69 74 65 5f  tring <b>sqlite_
52c0: 65 6e 63 6f 64 69 6e 67 3c 2f 62 3e 20 77 69 6c  encoding</b> wil
52d0: 6c 20 62 65 20 73 65 74 20 74 6f 20 65 69 74 68  l be set to eith
52e0: 65 72 20 22 55 54 46 2d 38 22 20 6f 72 0a 22 69  er "UTF-8" or."i
52f0: 73 6f 38 38 35 39 22 20 74 6f 20 69 6e 64 69 63  so8859" to indic
5300: 61 74 65 20 68 6f 77 20 74 68 65 20 6c 69 62 72  ate how the libr
5310: 61 72 79 20 77 61 73 20 63 6f 6d 70 69 6c 65 64  ary was compiled
5320: 2e 20 20 49 6e 20 61 64 64 69 74 69 6f 6e 2c 0a  .  In addition,.
5330: 74 68 65 20 3c 62 3e 73 71 6c 69 74 65 2e 68 3c  the <b>sqlite.h<
5340: 2f 62 3e 20 68 65 61 64 65 72 20 66 69 6c 65 20  /b> header file 
5350: 77 69 6c 6c 20 64 65 66 69 6e 65 20 6f 6e 65 20  will define one 
5360: 6f 66 20 74 68 65 0a 6d 61 63 72 6f 73 20 3c 62  of the.macros <b
5370: 3e 53 51 4c 49 54 45 5f 55 54 46 38 3c 2f 62 3e  >SQLITE_UTF8</b>
5380: 20 6f 72 20 3c 62 3e 53 51 4c 49 54 45 5f 49 53   or <b>SQLITE_IS
5390: 4f 38 38 35 39 3c 2f 62 3e 2c 20 61 73 20 61 70  O8859</b>, as ap
53a0: 70 72 6f 70 72 69 61 74 65 2e 3c 2f 70 3e 0a 0a  propriate.</p>..
53b0: 3c 70 3e 4e 6f 74 65 20 74 68 61 74 20 74 68 65  <p>Note that the
53c0: 20 63 68 61 72 61 63 74 65 72 20 65 6e 63 6f 64   character encod
53d0: 69 6e 67 20 6d 65 63 68 61 6e 69 73 6d 20 75 73  ing mechanism us
53e0: 65 64 20 62 79 20 53 51 4c 69 74 65 20 63 61 6e  ed by SQLite can
53f0: 6e 6f 74 0a 62 65 20 63 68 61 6e 67 65 64 20 61  not.be changed a
5400: 74 20 72 75 6e 2d 74 69 6d 65 2e 20 20 54 68 69  t run-time.  Thi
5410: 73 20 69 73 20 61 20 63 6f 6d 70 69 6c 65 2d 74  s is a compile-t
5420: 69 6d 65 20 6f 70 74 69 6f 6e 20 6f 6e 6c 79 2e  ime option only.
5430: 20 20 54 68 65 0a 3c 62 3e 73 71 6c 69 74 65 5f    The.<b>sqlite_
5440: 65 6e 63 6f 64 69 6e 67 3c 2f 62 3e 20 63 68 61  encoding</b> cha
5450: 72 61 63 74 65 72 20 73 74 72 69 6e 67 20 6a 75  racter string ju
5460: 73 74 20 74 65 6c 6c 73 20 79 6f 75 20 68 6f 77  st tells you how
5470: 20 74 68 65 20 6c 69 62 72 61 72 79 0a 77 61 73   the library.was
5480: 20 63 6f 6d 70 69 6c 65 64 2e 3c 2f 70 3e 0a 0a   compiled.</p>..
5490: 3c 68 32 3e 43 68 61 6e 67 69 6e 67 20 74 68 65  <h2>Changing the
54a0: 20 6c 69 62 72 61 72 79 27 73 20 72 65 73 70 6f   library's respo
54b0: 6e 73 65 20 74 6f 20 6c 6f 63 6b 65 64 20 66 69  nse to locked fi
54c0: 6c 65 73 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65  les</h2>..<p>The
54d0: 20 3c 62 3e 73 71 6c 69 74 65 5f 62 75 73 79 5f   <b>sqlite_busy_
54e0: 68 61 6e 64 6c 65 72 28 29 3c 2f 62 3e 20 70 72  handler()</b> pr
54f0: 6f 63 65 64 75 72 65 20 63 61 6e 20 62 65 20 75  ocedure can be u
5500: 73 65 64 20 74 6f 20 72 65 67 69 73 74 65 72 0a  sed to register.
5510: 61 20 62 75 73 79 20 63 61 6c 6c 62 61 63 6b 20  a busy callback 
5520: 77 69 74 68 20 61 6e 20 6f 70 65 6e 20 53 51 4c  with an open SQL
5530: 69 74 65 20 64 61 74 61 62 61 73 65 2e 20 20 54  ite database.  T
5540: 68 65 20 62 75 73 79 20 63 61 6c 6c 62 61 63 6b  he busy callback
5550: 20 77 69 6c 6c 0a 62 65 20 69 6e 76 6f 6b 65 64   will.be invoked
5560: 20 77 68 65 6e 65 76 65 72 20 53 51 4c 69 74 65   whenever SQLite
5570: 20 74 72 69 65 73 20 74 6f 20 61 63 63 65 73 73   tries to access
5580: 20 61 20 64 61 74 61 62 61 73 65 20 74 68 61 74   a database that
5590: 20 69 73 20 6c 6f 63 6b 65 64 2e 0a 54 68 65 20   is locked..The 
55a0: 63 61 6c 6c 62 61 63 6b 20 77 69 6c 6c 20 74 79  callback will ty
55b0: 70 69 63 61 6c 6c 79 20 64 6f 20 73 6f 6d 65 20  pically do some 
55c0: 6f 74 68 65 72 20 75 73 65 66 75 6c 20 77 6f 72  other useful wor
55d0: 6b 2c 20 6f 72 20 70 65 72 68 61 70 73 20 73 6c  k, or perhaps sl
55e0: 65 65 70 2c 0a 69 6e 20 6f 72 64 65 72 20 74 6f  eep,.in order to
55f0: 20 67 69 76 65 20 74 68 65 20 6c 6f 63 6b 20 61   give the lock a
5600: 20 63 68 61 6e 63 65 20 74 6f 20 63 6c 65 61 72   chance to clear
5610: 2e 20 20 49 66 20 74 68 65 20 63 61 6c 6c 62 61  .  If the callba
5620: 63 6b 20 72 65 74 75 72 6e 73 0a 6e 6f 6e 2d 7a  ck returns.non-z
5630: 65 72 6f 2c 20 74 68 65 6e 20 53 51 4c 69 74 65  ero, then SQLite
5640: 20 74 72 69 65 73 20 61 67 61 69 6e 20 74 6f 20   tries again to 
5650: 61 63 63 65 73 73 20 74 68 65 20 64 61 74 61 62  access the datab
5660: 61 73 65 20 61 6e 64 20 74 68 65 20 63 79 63 6c  ase and the cycl
5670: 65 0a 72 65 70 65 61 74 73 2e 20 20 49 66 20 74  e.repeats.  If t
5680: 68 65 20 63 61 6c 6c 62 61 63 6b 20 72 65 74 75  he callback retu
5690: 72 6e 73 20 7a 65 72 6f 2c 20 74 68 65 6e 20 53  rns zero, then S
56a0: 51 4c 69 74 65 20 61 62 6f 72 74 73 20 74 68 65  QLite aborts the
56b0: 20 63 75 72 72 65 6e 74 0a 6f 70 65 72 61 74 69   current.operati
56c0: 6f 6e 20 61 6e 64 20 72 65 74 75 72 6e 73 20 53  on and returns S
56d0: 51 4c 49 54 45 5f 42 55 53 59 2e 3c 2f 70 3e 0a  QLITE_BUSY.</p>.
56e0: 0a 3c 70 3e 54 68 65 20 61 72 67 75 6d 65 6e 74  .<p>The argument
56f0: 73 20 74 6f 20 3c 62 3e 73 71 6c 69 74 65 5f 62  s to <b>sqlite_b
5700: 75 73 79 5f 68 61 6e 64 6c 65 72 28 29 3c 2f 62  usy_handler()</b
5710: 3e 20 61 72 65 20 74 68 65 20 6f 70 61 71 75 65  > are the opaque
5720: 0a 73 74 72 75 63 74 75 72 65 20 72 65 74 75 72  .structure retur
5730: 6e 65 64 20 66 72 6f 6d 20 3c 62 3e 73 71 6c 69  ned from <b>sqli
5740: 74 65 5f 6f 70 65 6e 28 29 3c 2f 62 3e 2c 20 61  te_open()</b>, a
5750: 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68 65 20   pointer to the 
5760: 62 75 73 79 0a 63 61 6c 6c 62 61 63 6b 20 66 75  busy.callback fu
5770: 6e 63 74 69 6f 6e 2c 20 61 6e 64 20 61 20 67 65  nction, and a ge
5780: 6e 65 72 69 63 20 70 6f 69 6e 74 65 72 20 74 68  neric pointer th
5790: 61 74 20 77 69 6c 6c 20 62 65 20 70 61 73 73 65  at will be passe
57a0: 64 20 61 73 0a 74 68 65 20 66 69 72 73 74 20 61  d as.the first a
57b0: 72 67 75 6d 65 6e 74 20 74 6f 20 74 68 65 20 62  rgument to the b
57c0: 75 73 79 20 63 61 6c 6c 62 61 63 6b 2e 20 20 57  usy callback.  W
57d0: 68 65 6e 20 53 51 4c 69 74 65 20 69 6e 76 6f 6b  hen SQLite invok
57e0: 65 73 20 74 68 65 0a 62 75 73 79 20 63 61 6c 6c  es the.busy call
57f0: 62 61 63 6b 2c 20 69 74 20 73 65 6e 64 73 20 69  back, it sends i
5800: 74 20 74 68 72 65 65 20 61 72 67 75 6d 65 6e 74  t three argument
5810: 73 3a 20 20 74 68 65 20 67 65 6e 65 72 69 63 20  s:  the generic 
5820: 70 6f 69 6e 74 65 72 0a 74 68 61 74 20 77 61 73  pointer.that was
5830: 20 70 61 73 73 65 64 20 69 6e 20 61 73 20 74 68   passed in as th
5840: 65 20 74 68 69 72 64 20 61 72 67 75 6d 65 6e 74  e third argument
5850: 20 74 6f 20 3c 62 3e 73 71 6c 69 74 65 5f 62 75   to <b>sqlite_bu
5860: 73 79 5f 68 61 6e 64 6c 65 72 3c 2f 62 3e 2c 0a  sy_handler</b>,.
5870: 74 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20  the name of the 
5880: 64 61 74 61 62 61 73 65 20 74 61 62 6c 65 20 6f  database table o
5890: 72 20 69 6e 64 65 78 20 74 68 61 74 20 74 68 65  r index that the
58a0: 20 6c 69 62 72 61 72 79 20 69 73 20 74 72 79 69   library is tryi
58b0: 6e 67 0a 74 6f 20 61 63 63 65 73 73 2c 20 61 6e  ng.to access, an
58c0: 64 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20  d the number of 
58d0: 74 69 6d 65 73 20 74 68 61 74 20 74 68 65 20 6c  times that the l
58e0: 69 62 72 61 72 79 20 68 61 73 20 61 74 74 65 6d  ibrary has attem
58f0: 70 74 65 64 20 74 6f 0a 61 63 63 65 73 73 20 74  pted to.access t
5900: 68 65 20 64 61 74 61 62 61 73 65 20 74 61 62 6c  he database tabl
5910: 65 20 6f 72 20 69 6e 64 65 78 2e 3c 2f 70 3e 0a  e or index.</p>.
5920: 0a 3c 70 3e 46 6f 72 20 74 68 65 20 63 6f 6d 6d  .<p>For the comm
5930: 6f 6e 20 63 61 73 65 20 77 68 65 72 65 20 77 65  on case where we
5940: 20 77 61 6e 74 20 74 68 65 20 62 75 73 79 20 63   want the busy c
5950: 61 6c 6c 62 61 63 6b 20 74 6f 20 73 6c 65 65 70  allback to sleep
5960: 2c 0a 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62  ,.the SQLite lib
5970: 72 61 72 79 20 70 72 6f 76 69 64 65 73 20 61 20  rary provides a 
5980: 63 6f 6e 76 65 6e 69 65 6e 63 65 20 72 6f 75 74  convenience rout
5990: 69 6e 65 20 3c 62 3e 73 71 6c 69 74 65 5f 62 75  ine <b>sqlite_bu
59a0: 73 79 5f 74 69 6d 65 6f 75 74 28 29 3c 2f 62 3e  sy_timeout()</b>
59b0: 2e 0a 54 68 65 20 66 69 72 73 74 20 61 72 67 75  ..The first argu
59c0: 6d 65 6e 74 20 74 6f 20 3c 62 3e 73 71 6c 69 74  ment to <b>sqlit
59d0: 65 5f 62 75 73 79 5f 74 69 6d 65 6f 75 74 28 29  e_busy_timeout()
59e0: 3c 2f 62 3e 20 69 73 20 61 20 70 6f 69 6e 74 65  </b> is a pointe
59f0: 72 20 74 6f 0a 61 6e 20 6f 70 65 6e 20 53 51 4c  r to.an open SQL
5a00: 69 74 65 20 64 61 74 61 62 61 73 65 20 61 6e 64  ite database and
5a10: 20 74 68 65 20 73 65 63 6f 6e 64 20 61 72 67 75   the second argu
5a20: 6d 65 6e 74 20 69 73 20 61 20 6e 75 6d 62 65 72  ment is a number
5a30: 20 6f 66 20 6d 69 6c 6c 69 73 65 63 6f 6e 64 73   of milliseconds
5a40: 2e 0a 41 66 74 65 72 20 3c 62 3e 73 71 6c 69 74  ..After <b>sqlit
5a50: 65 5f 62 75 73 79 5f 74 69 6d 65 6f 75 74 28 29  e_busy_timeout()
5a60: 3c 2f 62 3e 20 68 61 73 20 62 65 65 6e 20 65 78  </b> has been ex
5a70: 65 63 75 74 65 64 2c 20 74 68 65 20 53 51 4c 69  ecuted, the SQLi
5a80: 74 65 20 6c 69 62 72 61 72 79 0a 77 69 6c 6c 20  te library.will 
5a90: 77 61 69 74 20 66 6f 72 20 74 68 65 20 6c 6f 63  wait for the loc
5aa0: 6b 20 74 6f 20 63 6c 65 61 72 20 66 6f 72 20 61  k to clear for a
5ab0: 74 20 6c 65 61 73 74 20 74 68 65 20 6e 75 6d 62  t least the numb
5ac0: 65 72 20 6f 66 20 6d 69 6c 6c 69 73 65 63 6f 6e  er of millisecon
5ad0: 64 73 20 0a 73 70 65 63 69 66 69 65 64 20 62 65  ds .specified be
5ae0: 66 6f 72 65 20 69 74 20 72 65 74 75 72 6e 73 20  fore it returns 
5af0: 53 51 4c 49 54 45 5f 42 55 53 59 2e 20 20 53 70  SQLITE_BUSY.  Sp
5b00: 65 63 69 66 79 69 6e 67 20 7a 65 72 6f 20 6d 69  ecifying zero mi
5b10: 6c 6c 69 73 65 63 6f 6e 64 73 20 66 6f 72 0a 74  lliseconds for.t
5b20: 68 65 20 74 69 6d 65 6f 75 74 20 72 65 73 74 6f  he timeout resto
5b30: 72 65 73 20 74 68 65 20 64 65 66 61 75 6c 74 20  res the default 
5b40: 62 65 68 61 76 69 6f 72 2e 3c 2f 70 3e 0a 0a 3c  behavior.</p>..<
5b50: 68 32 3e 55 73 69 6e 67 20 74 68 65 20 3c 74 74  h2>Using the <tt
5b60: 3e 5f 70 72 69 6e 74 66 28 29 3c 2f 74 74 3e 20  >_printf()</tt> 
5b70: 77 72 61 70 70 65 72 20 66 75 6e 63 74 69 6f 6e  wrapper function
5b80: 73 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65 20 66  s</h2>..<p>The f
5b90: 6f 75 72 20 75 74 69 6c 69 74 79 20 66 75 6e 63  our utility func
5ba0: 74 69 6f 6e 73 3c 2f 70 3e 0a 0a 3c 70 3e 0a 3c  tions</p>..<p>.<
5bb0: 75 6c 3e 0a 3c 6c 69 3e 3c 62 3e 73 71 6c 69 74  ul>.<li><b>sqlit
5bc0: 65 5f 65 78 65 63 5f 70 72 69 6e 74 66 28 29 3c  e_exec_printf()<
5bd0: 2f 62 3e 3c 2f 6c 69 3e 0a 3c 6c 69 3e 3c 62 3e  /b></li>.<li><b>
5be0: 73 71 6c 69 74 65 5f 65 78 65 63 5f 76 70 72 69  sqlite_exec_vpri
5bf0: 6e 74 66 28 29 3c 2f 62 3e 3c 2f 6c 69 3e 0a 3c  ntf()</b></li>.<
5c00: 6c 69 3e 3c 62 3e 73 71 6c 69 74 65 5f 67 65 74  li><b>sqlite_get
5c10: 5f 74 61 62 6c 65 5f 70 72 69 6e 74 66 28 29 3c  _table_printf()<
5c20: 2f 62 3e 3c 2f 6c 69 3e 0a 3c 6c 69 3e 3c 62 3e  /b></li>.<li><b>
5c30: 73 71 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65  sqlite_get_table
5c40: 5f 76 70 72 69 6e 74 66 28 29 3c 2f 62 3e 3c 2f  _vprintf()</b></
5c50: 6c 69 3e 0a 3c 2f 75 6c 3e 0a 3c 2f 70 3e 0a 0a  li>.</ul>.</p>..
5c60: 3c 70 3e 69 6d 70 6c 65 6d 65 6e 74 20 74 68 65  <p>implement the
5c70: 20 73 61 6d 65 20 71 75 65 72 79 20 66 75 6e 63   same query func
5c80: 74 69 6f 6e 61 6c 69 74 79 20 61 73 20 3c 62 3e  tionality as <b>
5c90: 73 71 6c 69 74 65 5f 65 78 65 63 28 29 3c 2f 62  sqlite_exec()</b
5ca0: 3e 0a 61 6e 64 20 3c 62 3e 73 71 6c 69 74 65 5f  >.and <b>sqlite_
5cb0: 67 65 74 5f 74 61 62 6c 65 28 29 3c 2f 62 3e 2e  get_table()</b>.
5cc0: 20 20 42 75 74 20 69 6e 73 74 65 61 64 20 6f 66    But instead of
5cd0: 20 74 61 6b 69 6e 67 20 61 20 63 6f 6d 70 6c 65   taking a comple
5ce0: 74 65 0a 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  te.SQL statement
5cf0: 20 61 73 20 74 68 65 69 72 20 73 65 63 6f 6e 64   as their second
5d00: 20 61 72 67 75 6d 65 6e 74 2c 20 74 68 65 20 66   argument, the f
5d10: 6f 75 72 20 3c 62 3e 5f 70 72 69 6e 74 66 3c 2f  our <b>_printf</
5d20: 62 3e 0a 72 6f 75 74 69 6e 65 73 20 74 61 6b 65  b>.routines take
5d30: 20 61 20 70 72 69 6e 74 66 2d 73 74 79 6c 65 20   a printf-style 
5d40: 66 6f 72 6d 61 74 20 73 74 72 69 6e 67 2e 20 20  format string.  
5d50: 54 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  The SQL statemen
5d60: 74 20 74 6f 0a 62 65 20 65 78 65 63 75 74 65 64  t to.be executed
5d70: 20 69 73 20 67 65 6e 65 72 61 74 65 64 20 66 72   is generated fr
5d80: 6f 6d 20 74 68 69 73 20 66 6f 72 6d 61 74 20 73  om this format s
5d90: 74 72 69 6e 67 20 61 6e 64 20 66 72 6f 6d 20 77  tring and from w
5da0: 68 61 74 65 76 65 72 0a 61 64 64 69 74 69 6f 6e  hatever.addition
5db0: 61 6c 20 61 72 67 75 6d 65 6e 74 73 20 61 72 65  al arguments are
5dc0: 20 61 74 74 61 63 68 65 64 20 74 6f 20 74 68 65   attached to the
5dd0: 20 65 6e 64 20 6f 66 20 74 68 65 20 66 75 6e 63   end of the func
5de0: 74 69 6f 6e 20 63 61 6c 6c 2e 3c 2f 70 3e 0a 0a  tion call.</p>..
5df0: 3c 70 3e 54 68 65 72 65 20 61 72 65 20 74 77 6f  <p>There are two
5e00: 20 61 64 76 61 6e 74 61 67 65 73 20 74 6f 20 75   advantages to u
5e10: 73 69 6e 67 20 74 68 65 20 53 51 4c 69 74 65 20  sing the SQLite 
5e20: 70 72 69 6e 74 66 0a 66 75 6e 63 74 69 6f 6e 73  printf.functions
5e30: 20 69 6e 73 74 65 61 64 20 6f 66 20 3c 62 3e 73   instead of <b>s
5e40: 70 72 69 6e 74 66 28 29 3c 2f 62 3e 2e 20 20 46  printf()</b>.  F
5e50: 69 72 73 74 20 6f 66 20 61 6c 6c 2c 20 77 69 74  irst of all, wit
5e60: 68 20 74 68 65 0a 53 51 4c 69 74 65 20 70 72 69  h the.SQLite pri
5e70: 6e 74 66 20 72 6f 75 74 69 6e 65 73 2c 20 74 68  ntf routines, th
5e80: 65 72 65 20 69 73 20 6e 65 76 65 72 20 61 20 64  ere is never a d
5e90: 61 6e 67 65 72 20 6f 66 20 6f 76 65 72 66 6c 6f  anger of overflo
5ea0: 77 69 6e 67 20 61 0a 73 74 61 74 69 63 20 62 75  wing a.static bu
5eb0: 66 66 65 72 20 61 73 20 74 68 65 72 65 20 69 73  ffer as there is
5ec0: 20 77 69 74 68 20 3c 62 3e 73 70 72 69 6e 74 66   with <b>sprintf
5ed0: 28 29 3c 2f 62 3e 2e 20 20 54 68 65 20 53 51 4c  ()</b>.  The SQL
5ee0: 69 74 65 0a 70 72 69 6e 74 66 20 72 6f 75 74 69  ite.printf routi
5ef0: 6e 65 73 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c  nes automaticall
5f00: 79 20 61 6c 6c 6f 63 61 74 65 20 28 61 6e 64 20  y allocate (and 
5f10: 6c 61 74 65 72 20 66 72 65 65 29 0a 61 73 20 6d  later free).as m
5f20: 75 63 68 20 6d 65 6d 6f 72 79 20 61 73 20 69 73  uch memory as is
5f30: 20 0a 6e 65 63 65 73 73 61 72 79 20 74 6f 20 68   .necessary to h
5f40: 6f 6c 64 20 74 68 65 20 53 51 4c 20 73 74 61 74  old the SQL stat
5f50: 65 6d 65 6e 74 73 20 67 65 6e 65 72 61 74 65 64  ements generated
5f60: 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 73 65  .</p>..<p>The se
5f70: 63 6f 6e 64 20 61 64 76 61 6e 74 61 67 65 20 74  cond advantage t
5f80: 68 65 20 53 51 4c 69 74 65 20 70 72 69 6e 74 66  he SQLite printf
5f90: 20 72 6f 75 74 69 6e 65 73 20 68 61 76 65 20 6f   routines have o
5fa0: 76 65 72 0a 3c 62 3e 73 70 72 69 6e 74 66 28 29  ver.<b>sprintf()
5fb0: 3c 2f 62 3e 20 69 73 20 61 20 6e 65 77 20 66 6f  </b> is a new fo
5fc0: 72 6d 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e 20  rmatting option 
5fd0: 73 70 65 63 69 66 69 63 61 6c 6c 79 20 64 65 73  specifically des
5fe0: 69 67 6e 65 64 0a 74 6f 20 73 75 70 70 6f 72 74  igned.to support
5ff0: 20 73 74 72 69 6e 67 20 6c 69 74 65 72 61 6c 73   string literals
6000: 20 69 6e 20 53 51 4c 2e 20 20 57 69 74 68 69 6e   in SQL.  Within
6010: 20 74 68 65 20 66 6f 72 6d 61 74 20 73 74 72 69   the format stri
6020: 6e 67 2c 0a 74 68 65 20 25 71 20 66 6f 72 6d 61  ng,.the %q forma
6030: 74 74 69 6e 67 20 6f 70 74 69 6f 6e 20 77 6f 72  tting option wor
6040: 6b 73 20 76 65 72 79 20 6d 75 63 68 20 6c 69 6b  ks very much lik
6050: 65 20 25 73 20 69 6e 20 74 68 61 74 20 69 74 0a  e %s in that it.
6060: 72 65 61 64 73 20 61 20 6e 75 6c 6c 2d 74 65 72  reads a null-ter
6070: 6d 69 6e 61 74 65 64 20 73 74 72 69 6e 67 20 66  minated string f
6080: 72 6f 6d 20 74 68 65 20 61 72 67 75 6d 65 6e 74  rom the argument
6090: 20 6c 69 73 74 20 61 6e 64 20 69 6e 73 65 72 74   list and insert
60a0: 73 0a 69 74 20 69 6e 74 6f 20 74 68 65 20 72 65  s.it into the re
60b0: 73 75 6c 74 2e 20 20 42 75 74 20 25 71 20 74 72  sult.  But %q tr
60c0: 61 6e 73 6c 61 74 65 73 20 74 68 65 20 69 6e 73  anslates the ins
60d0: 65 72 74 65 64 20 73 74 72 69 6e 67 20 62 79 0a  erted string by.
60e0: 6d 61 6b 69 6e 67 20 74 77 6f 20 63 6f 70 69 65  making two copie
60f0: 73 20 6f 66 20 65 76 65 72 79 20 73 69 6e 67 6c  s of every singl
6100: 65 2d 71 75 6f 74 65 20 28 27 29 20 63 68 61 72  e-quote (') char
6110: 61 63 74 65 72 20 69 6e 20 74 68 65 0a 73 75 62  acter in the.sub
6120: 73 74 69 74 75 74 65 64 20 73 74 72 69 6e 67 2e  stituted string.
6130: 20 20 54 68 69 73 20 68 61 73 20 74 68 65 20 65    This has the e
6140: 66 66 65 63 74 20 6f 66 20 65 73 63 61 70 69 6e  ffect of escapin
6150: 67 20 74 68 65 20 65 6e 64 2d 6f 66 2d 73 74 72  g the end-of-str
6160: 69 6e 67 0a 6d 65 61 6e 69 6e 67 20 6f 66 20 73  ing.meaning of s
6170: 69 6e 67 6c 65 2d 71 75 6f 74 65 20 77 69 74 68  ingle-quote with
6180: 69 6e 20 61 20 73 74 72 69 6e 67 20 6c 69 74 65  in a string lite
6190: 72 61 6c 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 43 6f  ral..</p>..<p>Co
61a0: 6e 73 69 64 65 72 20 61 6e 20 65 78 61 6d 70 6c  nsider an exampl
61b0: 65 2e 20 20 53 75 70 70 6f 73 65 20 79 6f 75 20  e.  Suppose you 
61c0: 61 72 65 20 74 72 79 69 6e 67 20 74 6f 20 69 6e  are trying to in
61d0: 73 65 72 74 20 61 20 73 74 72 69 6e 67 0a 76 61  sert a string.va
61e0: 6c 75 65 20 69 6e 74 6f 20 61 20 64 61 74 61 62  lue into a datab
61f0: 61 73 65 20 74 61 62 6c 65 20 77 68 65 72 65 20  ase table where 
6200: 74 68 65 20 73 74 72 69 6e 67 20 76 61 6c 75 65  the string value
6210: 20 77 61 73 20 6f 62 74 61 69 6e 65 64 20 66 72   was obtained fr
6220: 6f 6d 0a 75 73 65 72 20 69 6e 70 75 74 2e 20 20  om.user input.  
6230: 53 75 70 70 6f 73 65 20 74 68 65 20 73 74 72 69  Suppose the stri
6240: 6e 67 20 74 6f 20 62 65 20 69 6e 73 65 72 74 65  ng to be inserte
6250: 64 20 69 73 20 73 74 6f 72 65 64 20 69 6e 20 61  d is stored in a
6260: 20 76 61 72 69 61 62 6c 65 0a 6e 61 6d 65 64 20   variable.named 
6270: 7a 53 74 72 69 6e 67 2e 20 20 54 68 65 20 63 6f  zString.  The co
6280: 64 65 20 74 6f 20 64 6f 20 74 68 65 20 69 6e 73  de to do the ins
6290: 65 72 74 69 6f 6e 20 6d 69 67 68 74 20 6c 6f 6f  ertion might loo
62a0: 6b 20 6c 69 6b 65 20 74 68 69 73 3a 3c 2f 70 3e  k like this:</p>
62b0: 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70  ..<blockquote><p
62c0: 72 65 3e 0a 73 71 6c 69 74 65 5f 65 78 65 63 5f  re>.sqlite_exec_
62d0: 70 72 69 6e 74 66 28 64 62 2c 0a 20 20 22 49 4e  printf(db,.  "IN
62e0: 53 45 52 54 20 49 4e 54 4f 20 74 61 62 6c 65 31  SERT INTO table1
62f0: 20 56 41 4c 55 45 53 28 27 25 73 27 29 22 2c 0a   VALUES('%s')",.
6300: 20 20 30 2c 20 30 2c 20 30 2c 20 7a 53 74 72 69    0, 0, 0, zStri
6310: 6e 67 29 3b 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f  ng);.</pre></blo
6320: 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 49 66 20  ckquote>..<p>If 
6330: 74 68 65 20 7a 53 74 72 69 6e 67 20 76 61 72 69  the zString vari
6340: 61 62 6c 65 20 68 6f 6c 64 73 20 74 65 78 74 20  able holds text 
6350: 6c 69 6b 65 20 22 48 65 6c 6c 6f 22 2c 20 74 68  like "Hello", th
6360: 65 6e 20 74 68 69 73 20 73 74 61 74 65 6d 65 6e  en this statemen
6370: 74 0a 77 69 6c 6c 20 77 6f 72 6b 20 6a 75 73 74  t.will work just
6380: 20 66 69 6e 65 2e 20 20 42 75 74 20 73 75 70 70   fine.  But supp
6390: 6f 73 65 20 74 68 65 20 75 73 65 72 20 65 6e 74  ose the user ent
63a0: 65 72 73 20 61 20 73 74 72 69 6e 67 20 6c 69 6b  ers a string lik
63b0: 65 20 0a 22 48 69 20 79 27 61 6c 6c 21 22 2e 20  e ."Hi y'all!". 
63c0: 20 54 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65   The SQL stateme
63d0: 6e 74 20 67 65 6e 65 72 61 74 65 64 20 72 65 61  nt generated rea
63e0: 64 73 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a 0a  ds as follows:..
63f0: 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65  <blockquote><pre
6400: 3e 0a 49 4e 53 45 52 54 20 49 4e 54 4f 20 74 61  >.INSERT INTO ta
6410: 62 6c 65 31 20 56 41 4c 55 45 53 28 27 48 69 20  ble1 VALUES('Hi 
6420: 79 27 61 6c 6c 27 29 0a 3c 2f 70 72 65 3e 3c 2f  y'all').</pre></
6430: 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e  blockquote>..<p>
6440: 54 68 69 73 20 69 73 20 6e 6f 74 20 76 61 6c 69  This is not vali
6450: 64 20 53 51 4c 20 62 65 63 61 75 73 65 20 6f 66  d SQL because of
6460: 20 74 68 65 20 61 70 6f 73 74 72 6f 70 68 79 20   the apostrophy 
6470: 69 6e 20 74 68 65 20 77 6f 72 64 20 22 79 27 61  in the word "y'a
6480: 6c 6c 22 2e 0a 42 75 74 20 69 66 20 74 68 65 20  ll"..But if the 
6490: 25 71 20 66 6f 72 6d 61 74 74 69 6e 67 20 6f 70  %q formatting op
64a0: 74 69 6f 6e 20 69 73 20 75 73 65 64 20 69 6e 73  tion is used ins
64b0: 74 65 61 64 20 6f 66 20 25 73 2c 20 6c 69 6b 65  tead of %s, like
64c0: 20 74 68 69 73 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f   this:</p>..<blo
64d0: 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 73 71  ckquote><pre>.sq
64e0: 6c 69 74 65 5f 65 78 65 63 5f 70 72 69 6e 74 66  lite_exec_printf
64f0: 28 64 62 2c 0a 20 20 22 49 4e 53 45 52 54 20 49  (db,.  "INSERT I
6500: 4e 54 4f 20 74 61 62 6c 65 31 20 56 41 4c 55 45  NTO table1 VALUE
6510: 53 28 27 25 71 27 29 22 2c 0a 20 20 30 2c 20 30  S('%q')",.  0, 0
6520: 2c 20 30 2c 20 7a 53 74 72 69 6e 67 29 3b 0a 3c  , 0, zString);.<
6530: 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74  /pre></blockquot
6540: 65 3e 0a 0a 3c 70 3e 54 68 65 6e 20 74 68 65 20  e>..<p>Then the 
6550: 67 65 6e 65 72 61 74 65 64 20 53 51 4c 20 77 69  generated SQL wi
6560: 6c 6c 20 6c 6f 6f 6b 20 6c 69 6b 65 20 74 68 65  ll look like the
6570: 20 66 6f 6c 6c 6f 77 69 6e 67 3a 3c 2f 70 3e 0a   following:</p>.
6580: 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72  .<blockquote><pr
6590: 65 3e 0a 49 4e 53 45 52 54 20 49 4e 54 4f 20 74  e>.INSERT INTO t
65a0: 61 62 6c 65 31 20 56 41 4c 55 45 53 28 27 48 69  able1 VALUES('Hi
65b0: 20 79 27 27 61 6c 6c 27 29 0a 3c 2f 70 72 65 3e   y''all').</pre>
65c0: 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c  </blockquote>..<
65d0: 70 3e 48 65 72 65 20 74 68 65 20 61 70 6f 73 74  p>Here the apost
65e0: 72 6f 70 68 79 20 68 61 73 20 62 65 65 6e 20 65  rophy has been e
65f0: 73 63 61 70 65 64 20 61 6e 64 20 74 68 65 20 53  scaped and the S
6600: 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 69 73 20  QL statement is 
6610: 77 65 6c 6c 2d 66 6f 72 6d 65 64 2e 0a 57 68 65  well-formed..Whe
6620: 6e 20 67 65 6e 65 72 61 74 69 6e 67 20 53 51 4c  n generating SQL
6630: 20 6f 6e 2d 74 68 65 2d 66 6c 79 20 66 72 6f 6d   on-the-fly from
6640: 20 64 61 74 61 20 74 68 61 74 20 6d 69 67 68 74   data that might
6650: 20 63 6f 6e 74 61 69 6e 20 61 0a 73 69 6e 67 6c   contain a.singl
6660: 65 2d 71 75 6f 74 65 20 63 68 61 72 61 63 74 65  e-quote characte
6670: 72 20 28 27 29 2c 20 69 74 20 69 73 20 61 6c 77  r ('), it is alw
6680: 61 79 73 20 61 20 67 6f 6f 64 20 69 64 65 61 20  ays a good idea 
6690: 74 6f 20 75 73 65 20 74 68 65 0a 53 51 4c 69 74  to use the.SQLit
66a0: 65 20 70 72 69 6e 74 66 20 72 6f 75 74 69 6e 65  e printf routine
66b0: 73 20 61 6e 64 20 74 68 65 20 25 71 20 66 6f 72  s and the %q for
66c0: 6d 61 74 74 69 6e 67 20 6f 70 74 69 6f 6e 20 69  matting option i
66d0: 6e 73 74 65 61 64 20 6f 66 20 3c 62 3e 73 70 72  nstead of <b>spr
66e0: 69 6e 74 66 3c 2f 62 3e 2e 0a 3c 2f 70 3e 0a 0a  intf</b>..</p>..
66f0: 3c 68 32 3e 41 64 64 69 6e 67 20 4e 65 77 20 53  <h2>Adding New S
6700: 51 4c 20 46 75 6e 63 74 69 6f 6e 73 3c 2f 68 32  QL Functions</h2
6710: 3e 0a 0a 3c 70 3e 42 65 67 69 6e 6e 69 6e 67 20  >..<p>Beginning 
6720: 77 69 74 68 20 76 65 72 73 69 6f 6e 20 32 2e 34  with version 2.4
6730: 2e 30 2c 20 53 51 4c 69 74 65 20 61 6c 6c 6f 77  .0, SQLite allow
6740: 73 20 74 68 65 20 53 51 4c 20 6c 61 6e 67 75 61  s the SQL langua
6750: 67 65 20 74 6f 20 62 65 0a 65 78 74 65 6e 64 65  ge to be.extende
6760: 64 20 77 69 74 68 20 6e 65 77 20 66 75 6e 63 74  d with new funct
6770: 69 6f 6e 73 20 69 6d 70 6c 65 6d 65 6e 74 65 64  ions implemented
6780: 20 61 73 20 43 20 63 6f 64 65 2e 20 20 54 68 65   as C code.  The
6790: 20 66 6f 6c 6c 6f 77 69 6e 67 20 69 6e 74 65 72   following inter
67a0: 66 61 63 65 0a 69 73 20 75 73 65 64 3a 0a 3c 2f  face.is used:.</
67b0: 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e  p>..<blockquote>
67c0: 3c 70 72 65 3e 0a 74 79 70 65 64 65 66 20 73 74  <pre>.typedef st
67d0: 72 75 63 74 20 73 71 6c 69 74 65 5f 66 75 6e 63  ruct sqlite_func
67e0: 20 73 71 6c 69 74 65 5f 66 75 6e 63 3b 0a 0a 69   sqlite_func;..i
67f0: 6e 74 20 73 71 6c 69 74 65 5f 63 72 65 61 74 65  nt sqlite_create
6800: 5f 66 75 6e 63 74 69 6f 6e 28 0a 20 20 73 71 6c  _function(.  sql
6810: 69 74 65 20 2a 64 62 2c 0a 20 20 63 6f 6e 73 74  ite *db,.  const
6820: 20 63 68 61 72 20 2a 7a 4e 61 6d 65 2c 0a 20 20   char *zName,.  
6830: 69 6e 74 20 6e 41 72 67 2c 0a 20 20 76 6f 69 64  int nArg,.  void
6840: 20 28 2a 78 46 75 6e 63 29 28 73 71 6c 69 74 65   (*xFunc)(sqlite
6850: 5f 66 75 6e 63 2a 2c 69 6e 74 2c 63 6f 6e 73 74  _func*,int,const
6860: 20 63 68 61 72 2a 2a 29 2c 0a 20 20 76 6f 69 64   char**),.  void
6870: 20 2a 70 55 73 65 72 44 61 74 61 0a 29 3b 0a 69   *pUserData.);.i
6880: 6e 74 20 73 71 6c 69 74 65 5f 63 72 65 61 74 65  nt sqlite_create
6890: 5f 61 67 67 72 65 67 61 74 65 28 0a 20 20 73 71  _aggregate(.  sq
68a0: 6c 69 74 65 20 2a 64 62 2c 0a 20 20 63 6f 6e 73  lite *db,.  cons
68b0: 74 20 63 68 61 72 20 2a 7a 4e 61 6d 65 2c 0a 20  t char *zName,. 
68c0: 20 69 6e 74 20 6e 41 72 67 2c 0a 20 20 76 6f 69   int nArg,.  voi
68d0: 64 20 28 2a 78 53 74 65 70 29 28 73 71 6c 69 74  d (*xStep)(sqlit
68e0: 65 5f 66 75 6e 63 2a 2c 69 6e 74 2c 63 6f 6e 73  e_func*,int,cons
68f0: 74 20 63 68 61 72 2a 2a 29 2c 0a 20 20 76 6f 69  t char**),.  voi
6900: 64 20 28 2a 78 46 69 6e 61 6c 69 7a 65 29 28 73  d (*xFinalize)(s
6910: 71 6c 69 74 65 5f 66 75 6e 63 2a 29 2c 0a 20 20  qlite_func*),.  
6920: 76 6f 69 64 20 2a 70 55 73 65 72 44 61 74 61 0a  void *pUserData.
6930: 29 3b 0a 0a 63 68 61 72 20 2a 73 71 6c 69 74 65  );..char *sqlite
6940: 5f 73 65 74 5f 72 65 73 75 6c 74 5f 73 74 72 69  _set_result_stri
6950: 6e 67 28 73 71 6c 69 74 65 5f 66 75 6e 63 2a 2c  ng(sqlite_func*,
6960: 63 6f 6e 73 74 20 63 68 61 72 2a 2c 69 6e 74 29  const char*,int)
6970: 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 5f 73 65  ;.void sqlite_se
6980: 74 5f 72 65 73 75 6c 74 5f 69 6e 74 28 73 71 6c  t_result_int(sql
6990: 69 74 65 5f 66 75 6e 63 2a 2c 69 6e 74 29 3b 0a  ite_func*,int);.
69a0: 76 6f 69 64 20 73 71 6c 69 74 65 5f 73 65 74 5f  void sqlite_set_
69b0: 72 65 73 75 6c 74 5f 64 6f 75 62 6c 65 28 73 71  result_double(sq
69c0: 6c 69 74 65 5f 66 75 6e 63 2a 2c 64 6f 75 62 6c  lite_func*,doubl
69d0: 65 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 5f  e);.void sqlite_
69e0: 73 65 74 5f 72 65 73 75 6c 74 5f 65 72 72 6f 72  set_result_error
69f0: 28 73 71 6c 69 74 65 5f 66 75 6e 63 2a 2c 63 6f  (sqlite_func*,co
6a00: 6e 73 74 20 63 68 61 72 2a 2c 69 6e 74 29 3b 0a  nst char*,int);.
6a10: 0a 76 6f 69 64 20 2a 73 71 6c 69 74 65 5f 75 73  .void *sqlite_us
6a20: 65 72 5f 64 61 74 61 28 73 71 6c 69 74 65 5f 66  er_data(sqlite_f
6a30: 75 6e 63 2a 29 3b 0a 76 6f 69 64 20 2a 73 71 6c  unc*);.void *sql
6a40: 69 74 65 5f 61 67 67 72 65 67 61 74 65 5f 63 6f  ite_aggregate_co
6a50: 6e 74 65 78 74 28 73 71 6c 69 74 65 5f 66 75 6e  ntext(sqlite_fun
6a60: 63 2a 2c 20 69 6e 74 20 6e 42 79 74 65 73 29 3b  c*, int nBytes);
6a70: 0a 69 6e 74 20 73 71 6c 69 74 65 5f 61 67 67 72  .int sqlite_aggr
6a80: 65 67 61 74 65 5f 63 6f 75 6e 74 28 73 71 6c 69  egate_count(sqli
6a90: 74 65 5f 66 75 6e 63 2a 29 3b 0a 3c 2f 70 72 65  te_func*);.</pre
6aa0: 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a  ></blockquote>..
6ab0: 3c 70 3e 0a 54 68 65 20 3c 62 3e 73 71 6c 69 74  <p>.The <b>sqlit
6ac0: 65 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f  e_create_functio
6ad0: 6e 28 29 3c 2f 62 3e 20 69 6e 74 65 72 66 61 63  n()</b> interfac
6ae0: 65 20 69 73 20 75 73 65 64 20 74 6f 20 63 72 65  e is used to cre
6af0: 61 74 65 20 0a 72 65 67 75 6c 61 72 20 66 75 6e  ate .regular fun
6b00: 63 74 69 6f 6e 73 20 61 6e 64 20 3c 62 3e 73 71  ctions and <b>sq
6b10: 6c 69 74 65 5f 63 72 65 61 74 65 5f 61 67 67 72  lite_create_aggr
6b20: 65 67 61 74 65 28 29 3c 2f 62 3e 20 69 73 20 75  egate()</b> is u
6b30: 73 65 64 20 74 6f 0a 63 72 65 61 74 65 20 6e 65  sed to.create ne
6b40: 77 20 61 67 67 72 65 67 61 74 65 20 66 75 6e 63  w aggregate func
6b50: 74 69 6f 6e 73 2e 20 20 49 6e 20 62 6f 74 68 20  tions.  In both 
6b60: 63 61 73 65 73 2c 20 74 68 65 20 3c 62 3e 64 62  cases, the <b>db
6b70: 3c 2f 62 3e 0a 70 61 72 61 6d 65 74 65 72 20 69  </b>.parameter i
6b80: 73 20 61 6e 20 6f 70 65 6e 20 53 51 4c 69 74 65  s an open SQLite
6b90: 20 64 61 74 61 62 61 73 65 20 6f 6e 20 77 68 69   database on whi
6ba0: 63 68 20 74 68 65 20 66 75 6e 63 74 69 6f 6e 73  ch the functions
6bb0: 20 73 68 6f 75 6c 64 0a 62 65 20 72 65 67 69 73   should.be regis
6bc0: 74 65 72 65 64 2c 20 3c 62 3e 7a 4e 61 6d 65 3c  tered, <b>zName<
6bd0: 2f 62 3e 20 69 73 20 74 68 65 20 6e 61 6d 65 20  /b> is the name 
6be0: 6f 66 20 74 68 65 20 6e 65 77 20 66 75 6e 63 74  of the new funct
6bf0: 69 6f 6e 2c 0a 3c 62 3e 6e 41 72 67 3c 2f 62 3e  ion,.<b>nArg</b>
6c00: 20 69 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f   is the number o
6c10: 66 20 61 72 67 75 6d 65 6e 74 73 2c 20 61 6e 64  f arguments, and
6c20: 20 3c 62 3e 70 55 73 65 72 44 61 74 61 3c 2f 62   <b>pUserData</b
6c30: 3e 20 69 73 0a 61 20 70 6f 69 6e 74 65 72 20 77  > is.a pointer w
6c40: 68 69 63 68 20 69 73 20 70 61 73 73 65 64 20 74  hich is passed t
6c50: 68 72 6f 75 67 68 20 75 6e 63 68 61 6e 67 65 64  hrough unchanged
6c60: 20 74 6f 20 74 68 65 20 43 20 69 6d 70 6c 65 6d   to the C implem
6c70: 65 6e 74 61 74 69 6f 6e 0a 6f 66 20 74 68 65 20  entation.of the 
6c80: 66 75 6e 63 74 69 6f 6e 2e 0a 3c 2f 70 3e 0a 0a  function..</p>..
6c90: 3c 70 3e 0a 46 6f 72 20 72 65 67 75 6c 61 72 20  <p>.For regular 
6ca0: 66 75 6e 63 74 69 6f 6e 73 2c 20 74 68 65 20 3c  functions, the <
6cb0: 62 3e 78 46 75 6e 63 3c 2f 62 3e 20 63 61 6c 6c  b>xFunc</b> call
6cc0: 62 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64 20  back is invoked 
6cd0: 6f 6e 63 65 0a 66 6f 72 20 65 61 63 68 20 66 75  once.for each fu
6ce0: 6e 63 74 69 6f 6e 20 63 61 6c 6c 2e 20 20 54 68  nction call.  Th
6cf0: 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  e implementation
6d00: 20 6f 66 20 78 46 75 6e 63 20 73 68 6f 75 6c 64   of xFunc should
6d10: 20 63 61 6c 6c 0a 6f 6e 65 20 6f 66 20 74 68 65   call.one of the
6d20: 20 3c 62 3e 73 71 6c 69 74 65 5f 73 65 74 5f 72   <b>sqlite_set_r
6d30: 65 73 75 6c 74 5f 2e 2e 2e 3c 2f 62 3e 20 69 6e  esult_...</b> in
6d40: 74 65 72 66 61 63 65 73 20 74 6f 20 72 65 74 75  terfaces to retu
6d50: 72 6e 20 69 74 73 0a 72 65 73 75 6c 74 2e 20 20  rn its.result.  
6d60: 54 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 75 73  The <b>sqlite_us
6d70: 65 72 5f 64 61 74 61 28 29 3c 2f 62 3e 20 72 6f  er_data()</b> ro
6d80: 75 74 69 6e 65 20 63 61 6e 20 62 65 20 75 73 65  utine can be use
6d90: 64 20 74 6f 0a 72 65 74 72 69 65 76 65 20 74 68  d to.retrieve th
6da0: 65 20 3c 62 3e 70 55 73 65 72 44 61 74 61 3c 2f  e <b>pUserData</
6db0: 62 3e 20 70 6f 69 6e 74 65 72 20 74 68 61 74 20  b> pointer that 
6dc0: 77 61 73 20 70 61 73 73 65 64 20 69 6e 20 77 68  was passed in wh
6dd0: 65 6e 20 74 68 65 0a 66 75 6e 63 74 69 6f 6e 20  en the.function 
6de0: 77 61 73 20 72 65 67 69 73 74 65 72 65 64 2e 0a  was registered..
6df0: 3c 2f 70 3e 0a 0a 3c 70 3e 0a 46 6f 72 20 61 67  </p>..<p>.For ag
6e00: 67 72 65 67 61 74 65 20 66 75 6e 63 74 69 6f 6e  gregate function
6e10: 73 2c 20 74 68 65 20 3c 62 3e 78 53 74 65 70 3c  s, the <b>xStep<
6e20: 2f 62 3e 20 63 61 6c 6c 62 61 63 6b 20 69 73 20  /b> callback is 
6e30: 69 6e 76 6f 6b 65 64 20 6f 6e 63 65 0a 66 6f 72  invoked once.for
6e40: 20 65 61 63 68 20 72 6f 77 20 69 6e 20 74 68 65   each row in the
6e50: 20 72 65 73 75 6c 74 20 61 6e 64 20 74 68 65 6e   result and then
6e60: 20 3c 62 3e 78 46 69 6e 61 6c 69 7a 65 3c 2f 62   <b>xFinalize</b
6e70: 3e 20 69 73 20 69 6e 76 6f 6b 65 64 20 61 74 20  > is invoked at 
6e80: 74 68 65 0a 65 6e 64 20 74 6f 20 63 6f 6d 70 75  the.end to compu
6e90: 74 65 20 61 20 66 69 6e 61 6c 20 61 6e 73 77 65  te a final answe
6ea0: 72 2e 20 20 54 68 65 20 78 53 74 65 70 20 72 6f  r.  The xStep ro
6eb0: 75 74 69 6e 65 20 63 61 6e 20 75 73 65 20 74 68  utine can use th
6ec0: 65 0a 3c 62 3e 73 71 6c 69 74 65 5f 61 67 67 72  e.<b>sqlite_aggr
6ed0: 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28 29 3c  egate_context()<
6ee0: 2f 62 3e 20 69 6e 74 65 72 66 61 63 65 20 74 6f  /b> interface to
6ef0: 20 61 6c 6c 6f 63 61 74 65 20 6d 65 6d 6f 72 79   allocate memory
6f00: 20 74 68 61 74 0a 77 69 6c 6c 20 62 65 20 75 6e   that.will be un
6f10: 69 71 75 65 20 74 6f 20 74 68 61 74 20 70 61 72  ique to that par
6f20: 74 69 63 75 6c 61 72 20 69 6e 73 74 61 6e 63 65  ticular instance
6f30: 20 6f 66 20 74 68 65 20 53 51 4c 20 66 75 6e 63   of the SQL func
6f40: 74 69 6f 6e 2e 0a 54 68 69 73 20 6d 65 6d 6f 72  tion..This memor
6f50: 79 20 77 69 6c 6c 20 62 65 20 61 75 74 6f 6d 61  y will be automa
6f60: 74 69 63 61 6c 6c 79 20 64 65 6c 65 74 65 64 20  tically deleted 
6f70: 61 66 74 65 72 20 78 46 69 6e 61 6c 69 7a 65 20  after xFinalize 
6f80: 69 73 20 63 61 6c 6c 65 64 2e 0a 54 68 65 20 3c  is called..The <
6f90: 62 3e 73 71 6c 69 74 65 5f 61 67 67 72 65 67 61  b>sqlite_aggrega
6fa0: 74 65 5f 63 6f 75 6e 74 28 29 3c 2f 62 3e 20 72  te_count()</b> r
6fb0: 6f 75 74 69 6e 65 20 63 61 6e 20 62 65 20 75 73  outine can be us
6fc0: 65 64 20 74 6f 20 66 69 6e 64 20 6f 75 74 0a 68  ed to find out.h
6fd0: 6f 77 20 6d 61 6e 79 20 72 6f 77 73 20 6f 66 20  ow many rows of 
6fe0: 64 61 74 61 20 77 65 72 65 20 70 61 73 73 65 64  data were passed
6ff0: 20 74 6f 20 74 68 65 20 61 67 67 72 65 67 61 74   to the aggregat
7000: 65 2e 20 20 54 68 65 20 78 46 69 6e 61 6c 69 7a  e.  The xFinaliz
7010: 65 0a 63 61 6c 6c 62 61 63 6b 20 73 68 6f 75 6c  e.callback shoul
7020: 64 20 69 6e 76 6f 6b 65 20 6f 6e 65 20 6f 66 20  d invoke one of 
7030: 74 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 73 65  the <b>sqlite_se
7040: 74 5f 72 65 73 75 6c 74 5f 2e 2e 2e 3c 2f 62 3e  t_result_...</b>
7050: 0a 69 6e 74 65 72 66 61 63 65 73 20 74 6f 20 73  .interfaces to s
7060: 65 74 20 74 68 65 20 66 69 6e 61 6c 20 72 65 73  et the final res
7070: 75 6c 74 20 6f 66 20 74 68 65 20 61 67 67 72 65  ult of the aggre
7080: 67 61 74 65 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a  gate..</p>..<p>.
7090: 53 51 4c 69 74 65 20 6e 6f 77 20 69 6d 70 6c 65  SQLite now imple
70a0: 6d 65 6e 74 73 20 61 6c 6c 20 6f 66 20 69 74 73  ments all of its
70b0: 20 62 75 69 6c 74 2d 69 6e 20 66 75 6e 63 74 69   built-in functi
70c0: 6f 6e 73 20 75 73 69 6e 67 20 74 68 69 73 0a 69  ons using this.i
70d0: 6e 74 65 72 66 61 63 65 2e 20 20 46 6f 72 20 61  nterface.  For a
70e0: 64 64 69 74 69 6f 6e 61 6c 20 69 6e 66 6f 72 6d  dditional inform
70f0: 61 74 69 6f 6e 20 61 6e 64 20 65 78 61 6d 70 6c  ation and exampl
7100: 65 73 20 6f 6e 20 68 6f 77 20 74 6f 20 63 72 65  es on how to cre
7110: 61 74 65 0a 6e 65 77 20 53 51 4c 20 66 75 6e 63  ate.new SQL func
7120: 74 69 6f 6e 73 2c 20 72 65 76 69 65 77 20 74 68  tions, review th
7130: 65 20 53 51 4c 69 74 65 20 73 6f 75 72 63 65 20  e SQLite source 
7140: 63 6f 64 65 20 69 6e 20 74 68 65 20 66 69 6c 65  code in the file
7150: 0a 3c 62 3e 66 75 6e 63 2e 63 3c 2f 62 3e 2e 0a  .<b>func.c</b>..
7160: 3c 2f 70 3e 0a 0a 3c 68 32 3e 55 73 61 67 65 20  </p>..<h2>Usage 
7170: 45 78 61 6d 70 6c 65 73 3c 2f 68 32 3e 0a 0a 3c  Examples</h2>..<
7180: 70 3e 46 6f 72 20 65 78 61 6d 70 6c 65 73 20 6f  p>For examples o
7190: 66 20 68 6f 77 20 74 68 65 20 53 51 4c 69 74 65  f how the SQLite
71a0: 20 43 2f 43 2b 2b 20 69 6e 74 65 72 66 61 63 65   C/C++ interface
71b0: 20 63 61 6e 20 62 65 20 75 73 65 64 2c 0a 72 65   can be used,.re
71c0: 66 65 72 20 74 6f 20 74 68 65 20 73 6f 75 72 63  fer to the sourc
71d0: 65 20 63 6f 64 65 20 66 6f 72 20 74 68 65 20 3c  e code for the <
71e0: 62 3e 73 71 6c 69 74 65 3c 2f 62 3e 20 70 72 6f  b>sqlite</b> pro
71f0: 67 72 61 6d 20 69 6e 20 74 68 65 0a 66 69 6c 65  gram in the.file
7200: 20 3c 62 3e 73 72 63 2f 73 68 65 6c 6c 2e 63 3c   <b>src/shell.c<
7210: 2f 62 3e 20 6f 66 20 74 68 65 20 73 6f 75 72 63  /b> of the sourc
7220: 65 20 74 72 65 65 2e 0a 41 64 64 69 74 69 6f 6e  e tree..Addition
7230: 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 61  al information a
7240: 62 6f 75 74 20 73 71 6c 69 74 65 20 69 73 20 61  bout sqlite is a
7250: 76 61 69 6c 61 62 6c 65 20 61 74 0a 3c 61 20 68  vailable at.<a h
7260: 72 65 66 3d 22 73 71 6c 69 74 65 2e 68 74 6d 6c  ref="sqlite.html
7270: 22 3e 73 71 6c 69 74 65 2e 68 74 6d 6c 3c 2f 61  ">sqlite.html</a
7280: 3e 2e 0a 53 65 65 20 61 6c 73 6f 20 74 68 65 20  >..See also the 
7290: 73 6f 75 72 63 65 73 20 74 6f 20 74 68 65 20 54  sources to the T
72a0: 63 6c 20 69 6e 74 65 72 66 61 63 65 20 66 6f 72  cl interface for
72b0: 20 53 51 4c 69 74 65 20 69 6e 0a 74 68 65 20 73   SQLite in.the s
72c0: 6f 75 72 63 65 20 66 69 6c 65 20 3c 62 3e 73 72  ource file <b>sr
72d0: 63 2f 74 63 6c 73 71 6c 69 74 65 2e 63 3c 2f 62  c/tclsqlite.c</b
72e0: 3e 2e 3c 2f 70 3e 0a 7d 0a 0a 70 75 74 73 20 7b  >.</p>.}..puts {
72f0: 0a 3c 70 3e 3c 68 72 20 2f 3e 3c 2f 70 3e 0a 3c  .<p><hr /></p>.<
7300: 70 3e 3c 61 20 68 72 65 66 3d 22 69 6e 64 65 78  p><a href="index
7310: 2e 68 74 6d 6c 22 3e 3c 69 6d 67 20 73 72 63 3d  .html"><img src=
7320: 22 2f 67 6f 62 61 63 6b 2e 6a 70 67 22 20 62 6f  "/goback.jpg" bo
7330: 72 64 65 72 3d 30 20 2f 3e 0a 42 61 63 6b 20 74  rder=0 />.Back t
7340: 6f 20 74 68 65 20 53 51 4c 69 74 65 20 48 6f 6d  o the SQLite Hom
7350: 65 20 50 61 67 65 3c 2f 61 3e 0a 3c 2f 70 3e 0a  e Page</a>.</p>.
7360: 0a 3c 2f 62 6f 64 79 3e 3c 2f 68 74 6d 6c 3e 7d  .</body></html>}
7370: 0a                                               .