/ Hex Artifact Content
Login

Artifact 63efc40f09e2f0d8fea43d174103248b160fdf0e:


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 34 20 32 30 30 32 2f 30 32 2f 31 39 20 32 32  24 2002/02/19 22
0070: 3a 34 32 3a 30 36 20 64 72 68 20 45 78 70 20 24  :42:06 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 3c 2f  e mismatch */.</
1ec0: 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65  pre></blockquote
1ed0: 3e 0a 0a 3c 70 3e 0a 54 68 65 20 6d 65 61 6e 69  >..<p>.The meani
1ee0: 6e 67 73 20 6f 66 20 74 68 65 73 65 20 76 61 72  ngs of these var
1ef0: 69 6f 75 73 20 72 65 74 75 72 6e 20 76 61 6c 75  ious return valu
1f00: 65 73 20 61 72 65 20 61 73 20 66 6f 6c 6c 6f 77  es are as follow
1f10: 73 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71  s:.</p>..<blockq
1f20: 75 6f 74 65 3e 0a 3c 64 6c 3e 0a 3c 64 74 3e 53  uote>.<dl>.<dt>S
1f30: 51 4c 49 54 45 5f 4f 4b 3c 2f 64 74 3e 0a 3c 64  QLITE_OK</dt>.<d
1f40: 64 3e 3c 70 3e 54 68 69 73 20 76 61 6c 75 65 20  d><p>This value 
1f50: 69 73 20 72 65 74 75 72 6e 65 64 20 69 66 20 65  is returned if e
1f60: 76 65 72 79 74 68 69 6e 67 20 77 6f 72 6b 65 64  verything worked
1f70: 20 61 6e 64 20 74 68 65 72 65 20 77 65 72 65 20   and there were 
1f80: 6e 6f 20 65 72 72 6f 72 73 2e 0a 3c 2f 70 3e 3c  no errors..</p><
1f90: 2f 64 64 3e 0a 3c 64 74 3e 53 51 4c 49 54 45 5f  /dd>.<dt>SQLITE_
1fa0: 49 4e 54 45 52 4e 41 4c 3c 2f 64 74 3e 0a 3c 64  INTERNAL</dt>.<d
1fb0: 64 3e 3c 70 3e 54 68 69 73 20 76 61 6c 75 65 20  d><p>This value 
1fc0: 69 6e 64 69 63 61 74 65 73 20 74 68 61 74 20 61  indicates that a
1fd0: 6e 20 69 6e 74 65 72 6e 61 6c 20 63 6f 6e 73 69  n internal consi
1fe0: 73 74 65 6e 63 79 20 63 68 65 63 6b 20 77 69 74  stency check wit
1ff0: 68 69 6e 0a 74 68 65 20 53 51 4c 69 74 65 20 6c  hin.the SQLite l
2000: 69 62 72 61 72 79 20 66 61 69 6c 65 64 2e 20 20  ibrary failed.  
2010: 54 68 69 73 20 63 61 6e 20 6f 6e 6c 79 20 68 61  This can only ha
2020: 70 70 65 6e 20 69 66 20 74 68 65 72 65 20 69 73  ppen if there is
2030: 20 61 20 62 75 67 20 69 6e 0a 74 68 65 20 53 51   a bug in.the SQ
2040: 4c 69 74 65 20 6c 69 62 72 61 72 79 2e 20 20 49  Lite library.  I
2050: 66 20 79 6f 75 20 65 76 65 72 20 67 65 74 20 61  f you ever get a
2060: 6e 20 53 51 4c 49 54 45 5f 49 4e 54 45 52 4e 41  n SQLITE_INTERNA
2070: 4c 20 72 65 70 6c 79 20 66 72 6f 6d 0a 61 6e 20  L reply from.an 
2080: 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29  <b>sqlite_exec()
2090: 3c 2f 62 3e 20 63 61 6c 6c 2c 20 70 6c 65 61 73  </b> call, pleas
20a0: 65 20 72 65 70 6f 72 74 20 74 68 65 20 70 72 6f  e report the pro
20b0: 62 6c 65 6d 20 6f 6e 20 74 68 65 20 53 51 4c 69  blem on the SQLi
20c0: 74 65 0a 6d 61 69 6c 69 6e 67 20 6c 69 73 74 2e  te.mailing list.
20d0: 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53  .</p></dd>.<dt>S
20e0: 51 4c 49 54 45 5f 45 52 52 4f 52 3c 2f 64 74 3e  QLITE_ERROR</dt>
20f0: 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 72 65 74  .<dd><p>This ret
2100: 75 72 6e 20 76 61 6c 75 65 20 69 6e 64 69 63 61  urn value indica
2110: 74 65 73 20 74 68 61 74 20 74 68 65 72 65 20 77  tes that there w
2120: 61 73 20 61 6e 20 65 72 72 6f 72 20 69 6e 20 74  as an error in t
2130: 68 65 20 53 51 4c 0a 74 68 61 74 20 77 61 73 20  he SQL.that was 
2140: 70 61 73 73 65 64 20 69 6e 74 6f 20 74 68 65 20  passed into the 
2150: 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29  <b>sqlite_exec()
2160: 3c 2f 62 3e 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a  </b>..</p></dd>.
2170: 3c 64 74 3e 53 51 4c 49 54 45 5f 50 45 52 4d 3c  <dt>SQLITE_PERM<
2180: 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73  /dt>.<dd><p>This
2190: 20 72 65 74 75 72 6e 20 76 61 6c 75 65 20 73 61   return value sa
21a0: 79 73 20 74 68 61 74 20 74 68 65 20 61 63 63 65  ys that the acce
21b0: 73 73 20 70 65 72 6d 69 73 73 69 6f 6e 73 20 6f  ss permissions o
21c0: 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 0a 66  n the database.f
21d0: 69 6c 65 20 61 72 65 20 73 75 63 68 20 74 68 61  ile are such tha
21e0: 74 20 74 68 65 20 66 69 6c 65 20 63 61 6e 6e 6f  t the file canno
21f0: 74 20 62 65 20 6f 70 65 6e 65 64 2e 0a 3c 2f 70  t be opened..</p
2200: 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51 4c 49 54  ></dd>.<dt>SQLIT
2210: 45 5f 41 42 4f 52 54 3c 2f 64 74 3e 0a 3c 64 64  E_ABORT</dt>.<dd
2220: 3e 3c 70 3e 54 68 69 73 20 76 61 6c 75 65 20 69  ><p>This value i
2230: 73 20 72 65 74 75 72 6e 65 64 20 69 66 20 74 68  s returned if th
2240: 65 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74  e callback funct
2250: 69 6f 6e 20 72 65 74 75 72 6e 73 20 6e 6f 6e 2d  ion returns non-
2260: 7a 65 72 6f 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a  zero..</p></dd>.
2270: 3c 64 74 3e 53 51 4c 49 54 45 5f 42 55 53 59 3c  <dt>SQLITE_BUSY<
2280: 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73  /dt>.<dd><p>This
2290: 20 72 65 74 75 72 6e 20 63 6f 64 65 20 69 6e 64   return code ind
22a0: 69 63 61 74 65 73 20 74 68 61 74 20 61 6e 6f 74  icates that anot
22b0: 68 65 72 20 70 72 6f 67 72 61 6d 20 6f 72 20 74  her program or t
22c0: 68 72 65 61 64 20 68 61 73 0a 74 68 65 20 64 61  hread has.the da
22d0: 74 61 62 61 73 65 20 6c 6f 63 6b 65 64 2e 20 20  tabase locked.  
22e0: 53 51 4c 69 74 65 20 61 6c 6c 6f 77 73 20 74 77  SQLite allows tw
22f0: 6f 20 6f 72 20 6d 6f 72 65 20 74 68 72 65 61 64  o or more thread
2300: 73 20 74 6f 20 72 65 61 64 20 74 68 65 0a 64 61  s to read the.da
2310: 74 61 62 61 73 65 20 61 74 20 74 68 65 20 73 61  tabase at the sa
2320: 6d 65 20 74 69 6d 65 2c 20 62 75 74 20 6f 6e 6c  me time, but onl
2330: 79 20 6f 6e 65 20 74 68 72 65 61 64 20 63 61 6e  y one thread can
2340: 20 68 61 76 65 20 74 68 65 20 64 61 74 61 62 61   have the databa
2350: 73 65 0a 6f 70 65 6e 20 66 6f 72 20 77 72 69 74  se.open for writ
2360: 69 6e 67 20 61 74 20 74 68 65 20 73 61 6d 65 20  ing at the same 
2370: 74 69 6d 65 2e 20 20 4c 6f 63 6b 69 6e 67 20 69  time.  Locking i
2380: 6e 20 53 51 4c 69 74 65 20 69 73 20 6f 6e 20 74  n SQLite is on t
2390: 68 65 0a 65 6e 74 69 72 65 20 64 61 74 61 62 61  he.entire databa
23a0: 73 65 2e 3c 2f 70 3e 0a 3c 2f 70 3e 3c 2f 64 64  se.</p>.</p></dd
23b0: 3e 0a 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 4f 43  >.<dt>SQLITE_LOC
23c0: 4b 45 44 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e  KED</dt>.<dd><p>
23d0: 54 68 69 73 20 72 65 74 75 72 6e 20 63 6f 64 65  This return code
23e0: 20 69 73 20 73 69 6d 69 6c 61 72 20 74 6f 20 53   is similar to S
23f0: 51 4c 49 54 45 5f 42 55 53 59 20 69 6e 20 74 68  QLITE_BUSY in th
2400: 61 74 20 69 74 20 69 6e 64 69 63 61 74 65 73 0a  at it indicates.
2410: 74 68 61 74 20 74 68 65 20 64 61 74 61 62 61 73  that the databas
2420: 65 20 69 73 20 6c 6f 63 6b 65 64 2e 20 20 42 75  e is locked.  Bu
2430: 74 20 74 68 65 20 73 6f 75 72 63 65 20 6f 66 20  t the source of 
2440: 74 68 65 20 6c 6f 63 6b 20 69 73 20 61 20 72 65  the lock is a re
2450: 63 75 72 73 69 76 65 0a 63 61 6c 6c 20 74 6f 20  cursive.call to 
2460: 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65 63 28 29  <b>sqlite_exec()
2470: 3c 2f 62 3e 2e 20 20 54 68 69 73 20 72 65 74 75  </b>.  This retu
2480: 72 6e 20 63 61 6e 20 6f 6e 6c 79 20 6f 63 63 75  rn can only occu
2490: 72 20 69 66 20 79 6f 75 20 61 74 74 65 6d 70 74  r if you attempt
24a0: 0a 74 6f 20 69 6e 76 6f 6b 65 20 73 71 6c 69 74  .to invoke sqlit
24b0: 65 5f 65 78 65 63 28 29 20 66 72 6f 6d 20 77 69  e_exec() from wi
24c0: 74 68 69 6e 20 61 20 63 61 6c 6c 62 61 63 6b 20  thin a callback 
24d0: 72 6f 75 74 69 6e 65 20 6f 66 20 61 20 71 75 65  routine of a que
24e0: 72 79 0a 66 72 6f 6d 20 61 20 70 72 69 6f 72 20  ry.from a prior 
24f0: 69 6e 76 6f 63 61 74 69 6f 6e 20 6f 66 20 73 71  invocation of sq
2500: 6c 69 74 65 5f 65 78 65 63 28 29 2e 20 20 52 65  lite_exec().  Re
2510: 63 75 72 73 69 76 65 20 63 61 6c 6c 73 20 74 6f  cursive calls to
2520: 0a 73 71 6c 69 74 65 5f 65 78 65 63 28 29 20 61  .sqlite_exec() a
2530: 72 65 20 61 6c 6c 6f 77 65 64 20 61 73 20 6c 6f  re allowed as lo
2540: 6e 67 20 61 73 20 74 68 65 79 20 64 6f 0a 6e 6f  ng as they do.no
2550: 74 20 61 74 74 65 6d 70 74 20 74 6f 20 77 72 69  t attempt to wri
2560: 74 65 20 74 68 65 20 73 61 6d 65 20 74 61 62 6c  te the same tabl
2570: 65 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74  e..</p></dd>.<dt
2580: 3e 53 51 4c 49 54 45 5f 4e 4f 4d 45 4d 3c 2f 64  >SQLITE_NOMEM</d
2590: 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 76  t>.<dd><p>This v
25a0: 61 6c 75 65 20 69 73 20 72 65 74 75 72 6e 65 64  alue is returned
25b0: 20 69 66 20 61 20 63 61 6c 6c 20 74 6f 20 3c 62   if a call to <b
25c0: 3e 6d 61 6c 6c 6f 63 28 29 3c 2f 62 3e 20 66 61  >malloc()</b> fa
25d0: 69 6c 73 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c  ils..</p></dd>.<
25e0: 64 74 3e 53 51 4c 49 54 45 5f 52 45 41 44 4f 4e  dt>SQLITE_READON
25f0: 4c 59 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54  LY</dt>.<dd><p>T
2600: 68 69 73 20 72 65 74 75 72 6e 20 63 6f 64 65 20  his return code 
2610: 69 6e 64 69 63 61 74 65 73 20 74 68 61 74 20 61  indicates that a
2620: 6e 20 61 74 74 65 6d 70 74 20 77 61 73 20 6d 61  n attempt was ma
2630: 64 65 20 74 6f 20 77 72 69 74 65 20 74 6f 0a 61  de to write to.a
2640: 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 74   database file t
2650: 68 61 74 20 69 73 20 6f 70 65 6e 65 64 20 66 6f  hat is opened fo
2660: 72 20 72 65 61 64 69 6e 67 20 6f 6e 6c 79 2e 0a  r reading only..
2670: 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51  </p></dd>.<dt>SQ
2680: 4c 49 54 45 5f 49 4e 54 45 52 52 55 50 54 3c 2f  LITE_INTERRUPT</
2690: 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20  dt>.<dd><p>This 
26a0: 76 61 6c 75 65 20 69 73 20 72 65 74 75 72 6e 65  value is returne
26b0: 64 20 69 66 20 61 20 63 61 6c 6c 20 74 6f 20 3c  d if a call to <
26c0: 62 3e 73 71 6c 69 74 65 5f 69 6e 74 65 72 72 75  b>sqlite_interru
26d0: 70 74 28 29 3c 2f 62 3e 0a 69 6e 74 65 72 72 75  pt()</b>.interru
26e0: 70 74 73 20 61 20 64 61 74 61 62 61 73 65 20 6f  pts a database o
26f0: 70 65 72 61 74 69 6f 6e 20 69 6e 20 70 72 6f 67  peration in prog
2700: 72 65 73 73 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a  ress..</p></dd>.
2710: 3c 64 74 3e 53 51 4c 49 54 45 5f 49 4f 45 52 52  <dt>SQLITE_IOERR
2720: 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69  </dt>.<dd><p>Thi
2730: 73 20 76 61 6c 75 65 20 69 73 20 72 65 74 75 72  s value is retur
2740: 6e 65 64 20 69 66 20 74 68 65 20 6f 70 65 72 61  ned if the opera
2750: 74 69 6e 67 20 73 79 73 74 65 6d 20 69 6e 66 6f  ting system info
2760: 72 6d 73 20 53 51 4c 69 74 65 0a 74 68 61 74 20  rms SQLite.that 
2770: 69 74 20 69 73 20 75 6e 61 62 6c 65 20 74 6f 20  it is unable to 
2780: 70 65 72 66 6f 72 6d 20 73 6f 6d 65 20 64 69 73  perform some dis
2790: 6b 20 49 2f 4f 20 6f 70 65 72 61 74 69 6f 6e 2e  k I/O operation.
27a0: 20 20 54 68 69 73 20 63 6f 75 6c 64 20 6d 65 61    This could mea
27b0: 6e 0a 74 68 61 74 20 74 68 65 72 65 20 69 73 20  n.that there is 
27c0: 6e 6f 20 6d 6f 72 65 20 73 70 61 63 65 20 6c 65  no more space le
27d0: 66 74 20 6f 6e 20 74 68 65 20 64 69 73 6b 2e 0a  ft on the disk..
27e0: 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51  </p></dd>.<dt>SQ
27f0: 4c 49 54 45 5f 43 4f 52 52 55 50 54 3c 2f 64 74  LITE_CORRUPT</dt
2800: 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 76 61  >.<dd><p>This va
2810: 6c 75 65 20 69 73 20 72 65 74 75 72 6e 65 64 20  lue is returned 
2820: 69 66 20 53 51 4c 69 74 65 20 64 65 74 65 63 74  if SQLite detect
2830: 73 20 74 68 61 74 20 74 68 65 20 64 61 74 61 62  s that the datab
2840: 61 73 65 20 69 74 20 69 73 0a 77 6f 72 6b 69 6e  ase it is.workin
2850: 67 20 6f 6e 20 68 61 73 20 62 65 63 6f 6d 65 20  g on has become 
2860: 63 6f 72 72 75 70 74 65 64 2e 20 20 43 6f 72 72  corrupted.  Corr
2870: 75 70 74 69 6f 6e 20 6d 69 67 68 74 20 6f 63 63  uption might occ
2880: 75 72 20 64 75 65 20 74 6f 20 61 20 72 6f 67 75  ur due to a rogu
2890: 65 0a 70 72 6f 63 65 73 73 20 77 72 69 74 69 6e  e.process writin
28a0: 67 20 74 6f 20 74 68 65 20 64 61 74 61 62 61 73  g to the databas
28b0: 65 20 66 69 6c 65 20 6f 72 20 69 74 20 6d 69 67  e file or it mig
28c0: 68 74 20 68 61 70 70 65 6e 20 64 75 65 20 74 6f  ht happen due to
28d0: 20 61 6e 20 0a 70 65 72 76 69 6f 75 73 6c 79 20   an .perviously 
28e0: 75 6e 64 65 74 65 63 74 65 64 20 6c 6f 67 69 63  undetected logic
28f0: 20 65 72 72 6f 72 20 69 6e 20 6f 66 20 53 51 4c   error in of SQL
2900: 69 74 65 2e 20 54 68 69 73 20 76 61 6c 75 65 20  ite. This value 
2910: 69 73 20 61 6c 73 6f 0a 72 65 74 75 72 6e 65 64  is also.returned
2920: 20 69 66 20 61 20 64 69 73 6b 20 49 2f 4f 20 65   if a disk I/O e
2930: 72 72 6f 72 20 6f 63 63 75 72 73 20 69 6e 20 73  rror occurs in s
2940: 75 63 68 20 61 20 77 61 79 20 74 68 61 74 20 53  uch a way that S
2950: 51 4c 69 74 65 20 69 73 20 66 6f 72 63 65 64 0a  QLite is forced.
2960: 74 6f 20 6c 65 61 76 65 20 74 68 65 20 64 61 74  to leave the dat
2970: 61 62 61 73 65 20 66 69 6c 65 20 69 6e 20 61 20  abase file in a 
2980: 63 6f 72 72 75 70 74 65 64 20 73 74 61 74 65 2e  corrupted state.
2990: 20 20 54 68 65 20 6c 61 74 74 65 72 20 73 68 6f    The latter sho
29a0: 75 6c 64 20 6f 6e 6c 79 0a 68 61 70 70 65 6e 20  uld only.happen 
29b0: 64 75 65 20 74 6f 20 61 20 68 61 72 64 77 61 72  due to a hardwar
29c0: 65 20 6f 72 20 6f 70 65 72 61 74 69 6e 67 20 73  e or operating s
29d0: 79 73 74 65 6d 20 6d 61 6c 66 75 6e 63 74 69 6f  ystem malfunctio
29e0: 6e 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74  n..</p></dd>.<dt
29f0: 3e 53 51 4c 49 54 45 5f 46 55 4c 4c 3c 2f 64 74  >SQLITE_FULL</dt
2a00: 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 76 61  >.<dd><p>This va
2a10: 6c 75 65 20 69 73 20 72 65 74 75 72 6e 65 64 20  lue is returned 
2a20: 69 66 20 61 6e 20 69 6e 73 65 72 74 69 6f 6e 20  if an insertion 
2a30: 66 61 69 6c 65 64 20 62 65 63 61 75 73 65 20 74  failed because t
2a40: 68 65 72 65 20 69 73 0a 6e 6f 20 73 70 61 63 65  here is.no space
2a50: 20 6c 65 66 74 20 6f 6e 20 74 68 65 20 64 69 73   left on the dis
2a60: 6b 2c 20 6f 72 20 74 68 65 20 64 61 74 61 62 61  k, or the databa
2a70: 73 65 20 69 73 20 74 6f 6f 20 62 69 67 20 74 6f  se is too big to
2a80: 20 68 6f 6c 64 20 61 6e 79 0a 6d 6f 72 65 20 69   hold any.more i
2a90: 6e 66 6f 72 6d 61 74 69 6f 6e 2e 20 20 54 68 65  nformation.  The
2aa0: 20 6c 61 74 74 65 72 20 63 61 73 65 20 73 68 6f   latter case sho
2ab0: 75 6c 64 20 6f 6e 6c 79 20 6f 63 63 75 72 20 66  uld only occur f
2ac0: 6f 72 20 64 61 74 61 62 61 73 65 73 0a 74 68 61  or databases.tha
2ad0: 74 20 61 72 65 20 6c 61 72 67 65 72 20 74 68 61  t are larger tha
2ae0: 6e 20 32 47 42 20 69 6e 20 73 69 7a 65 2e 0a 3c  n 2GB in size..<
2af0: 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51 4c  /p></dd>.<dt>SQL
2b00: 49 54 45 5f 43 41 4e 54 4f 50 45 4e 3c 2f 64 74  ITE_CANTOPEN</dt
2b10: 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 76 61  >.<dd><p>This va
2b20: 6c 75 65 20 69 73 20 72 65 74 75 72 6e 65 64 20  lue is returned 
2b30: 69 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20  if the database 
2b40: 66 69 6c 65 20 63 6f 75 6c 64 20 6e 6f 74 20 62  file could not b
2b50: 65 20 6f 70 65 6e 65 64 0a 66 6f 72 20 73 6f 6d  e opened.for som
2b60: 65 20 72 65 61 73 6f 6e 2e 0a 3c 2f 70 3e 3c 2f  e reason..</p></
2b70: 64 64 3e 0a 3c 64 74 3e 53 51 4c 49 54 45 5f 50  dd>.<dt>SQLITE_P
2b80: 52 4f 54 4f 43 4f 4c 3c 2f 64 74 3e 0a 3c 64 64  ROTOCOL</dt>.<dd
2b90: 3e 3c 70 3e 54 68 69 73 20 76 61 6c 75 65 20 69  ><p>This value i
2ba0: 73 20 72 65 74 75 72 6e 65 64 20 69 66 20 73 6f  s returned if so
2bb0: 6d 65 20 6f 74 68 65 72 20 70 72 6f 63 65 73 73  me other process
2bc0: 20 69 73 20 6d 65 73 73 69 6e 67 20 77 69 74 68   is messing with
2bd0: 0a 66 69 6c 65 20 6c 6f 63 6b 73 20 61 6e 64 20  .file locks and 
2be0: 68 61 73 20 76 69 6f 6c 61 74 65 64 20 74 68 65  has violated the
2bf0: 20 66 69 6c 65 20 6c 6f 63 6b 69 6e 67 20 70 72   file locking pr
2c00: 6f 74 6f 63 6f 6c 20 74 68 61 74 20 53 51 4c 69  otocol that SQLi
2c10: 74 65 20 75 73 65 73 0a 6f 6e 20 69 74 73 20 72  te uses.on its r
2c20: 6f 6c 6c 62 61 63 6b 20 6a 6f 75 72 6e 61 6c 20  ollback journal 
2c30: 66 69 6c 65 73 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e  files..</p></dd>
2c40: 0a 3c 64 74 3e 53 51 4c 49 54 45 5f 53 43 48 45  .<dt>SQLITE_SCHE
2c50: 4d 41 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 57  MA</dt>.<dd><p>W
2c60: 68 65 6e 20 74 68 65 20 64 61 74 61 62 61 73 65  hen the database
2c70: 20 66 69 72 73 74 20 6f 70 65 6e 65 64 2c 20 53   first opened, S
2c80: 51 4c 69 74 65 20 72 65 61 64 73 20 74 68 65 20  QLite reads the 
2c90: 64 61 74 61 62 61 73 65 20 73 63 68 65 6d 61 0a  database schema.
2ca0: 69 6e 74 6f 20 6d 65 6d 6f 72 79 20 61 6e 64 20  into memory and 
2cb0: 75 73 65 73 20 74 68 61 74 20 73 63 68 65 6d 61  uses that schema
2cc0: 20 74 6f 20 70 61 72 73 65 20 6e 65 77 20 53 51   to parse new SQ
2cd0: 4c 20 73 74 61 74 65 6d 65 6e 74 73 2e 20 20 49  L statements.  I
2ce0: 66 20 61 6e 6f 74 68 65 72 0a 70 72 6f 63 65 73  f another.proces
2cf0: 73 20 63 68 61 6e 67 65 73 20 74 68 65 20 73 63  s changes the sc
2d00: 68 65 6d 61 2c 20 74 68 65 20 63 6f 6d 6d 61 6e  hema, the comman
2d10: 64 20 63 75 72 72 65 6e 74 6c 79 20 62 65 69 6e  d currently bein
2d20: 67 20 70 72 6f 63 65 73 73 65 64 20 77 69 6c 6c  g processed will
2d30: 0a 61 62 6f 72 74 20 62 65 63 61 75 73 65 20 74  .abort because t
2d40: 68 65 20 76 69 72 74 75 61 6c 20 6d 61 63 68 69  he virtual machi
2d50: 6e 65 20 63 6f 64 65 20 67 65 6e 65 72 61 74 65  ne code generate
2d60: 64 20 61 73 73 75 6d 65 64 20 74 68 65 20 6f 6c  d assumed the ol
2d70: 64 0a 73 63 68 65 6d 61 2e 20 20 54 68 69 73 20  d.schema.  This 
2d80: 69 73 20 74 68 65 20 72 65 74 75 72 6e 20 63 6f  is the return co
2d90: 64 65 20 66 6f 72 20 73 75 63 68 20 63 61 73 65  de for such case
2da0: 73 2e 20 20 52 65 74 72 79 69 6e 67 20 74 68 65  s.  Retrying the
2db0: 0a 63 6f 6d 6d 61 6e 64 20 75 73 75 61 6c 6c 79  .command usually
2dc0: 20 77 69 6c 6c 20 63 6c 65 61 72 20 74 68 65 20   will clear the 
2dd0: 70 72 6f 62 6c 65 6d 2e 0a 3c 2f 70 3e 3c 2f 64  problem..</p></d
2de0: 64 3e 0a 3c 64 74 3e 53 51 4c 49 54 45 5f 54 4f  d>.<dt>SQLITE_TO
2df0: 4f 42 49 47 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70  OBIG</dt>.<dd><p
2e00: 3e 53 51 4c 69 74 65 20 77 69 6c 6c 20 6e 6f 74  >SQLite will not
2e10: 20 73 74 6f 72 65 20 6d 6f 72 65 20 74 68 61 6e   store more than
2e20: 20 61 62 6f 75 74 20 31 20 6d 65 67 61 62 79 74   about 1 megabyt
2e30: 65 20 6f 66 20 64 61 74 61 20 69 6e 20 61 20 73  e of data in a s
2e40: 69 6e 67 6c 65 0a 72 6f 77 20 6f 66 20 61 20 73  ingle.row of a s
2e50: 69 6e 67 6c 65 20 74 61 62 6c 65 2e 20 20 49 66  ingle table.  If
2e60: 20 79 6f 75 20 61 74 74 65 6d 70 74 20 74 6f 20   you attempt to 
2e70: 73 74 6f 72 65 20 6d 6f 72 65 20 74 68 61 6e 20  store more than 
2e80: 31 20 6d 65 67 61 62 79 74 65 0a 69 6e 20 61 20  1 megabyte.in a 
2e90: 73 69 6e 67 6c 65 20 72 6f 77 2c 20 74 68 69 73  single row, this
2ea0: 20 69 73 20 74 68 65 20 72 65 74 75 72 6e 20 63   is the return c
2eb0: 6f 64 65 20 79 6f 75 20 67 65 74 2e 0a 3c 2f 70  ode you get..</p
2ec0: 3e 3c 2f 64 64 3e 0a 3c 64 74 3e 53 51 4c 49 54  ></dd>.<dt>SQLIT
2ed0: 45 5f 43 4f 4e 53 54 52 41 49 4e 54 3c 2f 64 74  E_CONSTRAINT</dt
2ee0: 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69 73 20 63 6f  >.<dd><p>This co
2ef0: 6e 73 74 61 6e 74 20 69 73 20 72 65 74 75 72 6e  nstant is return
2f00: 65 64 20 69 66 20 74 68 65 20 53 51 4c 20 73 74  ed if the SQL st
2f10: 61 74 65 6d 65 6e 74 20 77 6f 75 6c 64 20 68 61  atement would ha
2f20: 76 65 20 76 69 6f 6c 61 74 65 64 0a 61 20 64 61  ve violated.a da
2f30: 74 61 62 61 73 65 20 63 6f 6e 73 74 72 61 69 6e  tabase constrain
2f40: 74 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 64 74  t..</p></dd>.<dt
2f50: 3e 53 51 4c 49 54 45 5f 4d 49 53 4d 41 54 43 48  >SQLITE_MISMATCH
2f60: 3c 2f 64 74 3e 0a 3c 64 64 3e 3c 70 3e 54 68 69  </dt>.<dd><p>Thi
2f70: 73 20 65 72 72 6f 72 20 6f 63 63 75 72 73 20 77  s error occurs w
2f80: 68 65 6e 20 74 68 65 72 65 20 69 73 20 61 6e 20  hen there is an 
2f90: 61 74 74 65 6d 70 74 20 74 6f 20 69 6e 73 65 72  attempt to inser
2fa0: 74 20 6e 6f 6e 2d 69 6e 74 65 67 65 72 0a 64 61  t non-integer.da
2fb0: 74 61 20 69 6e 74 6f 20 61 20 63 6f 6c 75 6d 6e  ta into a column
2fc0: 20 6c 61 62 65 6c 65 64 20 49 4e 54 45 47 45 52   labeled INTEGER
2fd0: 20 50 52 49 4d 41 52 59 20 4b 45 59 2e 20 20 46   PRIMARY KEY.  F
2fe0: 6f 72 20 6d 6f 73 74 20 63 6f 6c 75 6d 6e 73 2c  or most columns,
2ff0: 20 53 51 4c 69 74 65 0a 69 67 6e 6f 72 65 73 20   SQLite.ignores 
3000: 74 68 65 20 64 61 74 61 20 74 79 70 65 20 61 6e  the data type an
3010: 64 20 61 6c 6c 6f 77 73 20 61 6e 79 20 6b 69 6e  d allows any kin
3020: 64 20 6f 66 20 64 61 74 61 20 74 6f 20 62 65 20  d of data to be 
3030: 73 74 6f 72 65 64 2e 20 20 42 75 74 0a 61 6e 20  stored.  But.an 
3040: 49 4e 54 45 47 45 52 20 50 52 49 4d 41 52 59 20  INTEGER PRIMARY 
3050: 4b 45 59 20 63 6f 6c 75 6d 6e 20 69 73 20 6f 6e  KEY column is on
3060: 6c 79 20 61 6c 6c 6f 77 65 64 20 74 6f 20 73 74  ly allowed to st
3070: 6f 72 65 20 69 6e 74 65 67 65 72 20 64 61 74 61  ore integer data
3080: 2e 0a 3c 2f 70 3e 3c 2f 64 64 3e 0a 3c 2f 64 6c  ..</p></dd>.</dl
3090: 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  >.</blockquote>.
30a0: 0a 3c 68 32 3e 54 68 65 20 45 78 74 65 6e 64 65  .<h2>The Extende
30b0: 64 20 41 50 49 3c 2f 68 32 3e 0a 0a 3c 70 3e 4f  d API</h2>..<p>O
30c0: 6e 6c 79 20 74 68 65 20 74 68 72 65 65 20 63 6f  nly the three co
30d0: 72 65 20 72 6f 75 74 69 6e 65 73 20 73 68 6f 77  re routines show
30e0: 6e 20 61 62 6f 76 65 20 61 72 65 20 72 65 71 75  n above are requ
30f0: 69 72 65 64 20 74 6f 20 75 73 65 0a 53 51 4c 69  ired to use.SQLi
3100: 74 65 2e 20 20 42 75 74 20 74 68 65 72 65 20 61  te.  But there a
3110: 72 65 20 6d 61 6e 79 20 6f 74 68 65 72 20 66 75  re many other fu
3120: 6e 63 74 69 6f 6e 73 20 74 68 61 74 20 70 72 6f  nctions that pro
3130: 76 69 64 65 20 0a 75 73 65 66 75 6c 20 69 6e 74  vide .useful int
3140: 65 72 66 61 63 65 73 2e 20 20 54 68 65 73 65 20  erfaces.  These 
3150: 65 78 74 65 6e 64 65 64 20 72 6f 75 74 69 6e 65  extended routine
3160: 73 20 61 72 65 20 61 73 20 66 6f 6c 6c 6f 77 73  s are as follows
3170: 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75  :.</p>..<blockqu
3180: 6f 74 65 3e 3c 70 72 65 3e 0a 69 6e 74 20 73 71  ote><pre>.int sq
3190: 6c 69 74 65 5f 6c 61 73 74 5f 69 6e 73 65 72 74  lite_last_insert
31a0: 5f 72 6f 77 69 64 28 73 71 6c 69 74 65 2a 29 3b  _rowid(sqlite*);
31b0: 0a 0a 69 6e 74 20 73 71 6c 69 74 65 5f 67 65 74  ..int sqlite_get
31c0: 5f 74 61 62 6c 65 28 0a 20 20 73 71 6c 69 74 65  _table(.  sqlite
31d0: 2a 2c 0a 20 20 63 68 61 72 20 2a 73 71 6c 2c 0a  *,.  char *sql,.
31e0: 20 20 63 68 61 72 20 2a 2a 2a 72 65 73 75 6c 74    char ***result
31f0: 2c 0a 20 20 69 6e 74 20 2a 6e 72 6f 77 2c 0a 20  ,.  int *nrow,. 
3200: 20 69 6e 74 20 2a 6e 63 6f 6c 75 6d 6e 2c 0a 20   int *ncolumn,. 
3210: 20 63 68 61 72 20 2a 2a 65 72 72 6d 73 67 0a 29   char **errmsg.)
3220: 3b 0a 0a 76 6f 69 64 20 73 71 6c 69 74 65 5f 66  ;..void sqlite_f
3230: 72 65 65 5f 74 61 62 6c 65 28 63 68 61 72 2a 2a  ree_table(char**
3240: 29 3b 0a 0a 76 6f 69 64 20 73 71 6c 69 74 65 5f  );..void sqlite_
3250: 69 6e 74 65 72 72 75 70 74 28 73 71 6c 69 74 65  interrupt(sqlite
3260: 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 5f  *);..int sqlite_
3270: 63 6f 6d 70 6c 65 74 65 28 63 6f 6e 73 74 20 63  complete(const c
3280: 68 61 72 20 2a 73 71 6c 29 3b 0a 0a 76 6f 69 64  har *sql);..void
3290: 20 73 71 6c 69 74 65 5f 62 75 73 79 5f 68 61 6e   sqlite_busy_han
32a0: 64 6c 65 72 28 73 71 6c 69 74 65 2a 2c 20 69 6e  dler(sqlite*, in
32b0: 74 20 28 2a 29 28 76 6f 69 64 2a 2c 63 6f 6e 73  t (*)(void*,cons
32c0: 74 20 63 68 61 72 2a 2c 69 6e 74 29 2c 20 76 6f  t char*,int), vo
32d0: 69 64 2a 29 3b 0a 0a 76 6f 69 64 20 73 71 6c 69  id*);..void sqli
32e0: 74 65 5f 62 75 73 79 5f 74 69 6d 65 6f 75 74 28  te_busy_timeout(
32f0: 73 71 6c 69 74 65 2a 2c 20 69 6e 74 20 6d 73 29  sqlite*, int ms)
3300: 3b 0a 0a 63 6f 6e 73 74 20 63 68 61 72 20 73 71  ;..const char sq
3310: 6c 69 74 65 5f 76 65 72 73 69 6f 6e 5b 5d 3b 0a  lite_version[];.
3320: 0a 63 6f 6e 73 74 20 63 68 61 72 20 73 71 6c 69  .const char sqli
3330: 74 65 5f 65 6e 63 6f 64 69 6e 67 5b 5d 3b 0a 0a  te_encoding[];..
3340: 69 6e 74 20 73 71 6c 69 74 65 5f 65 78 65 63 5f  int sqlite_exec_
3350: 70 72 69 6e 74 66 28 0a 20 20 73 71 6c 69 74 65  printf(.  sqlite
3360: 2a 2c 0a 20 20 63 68 61 72 20 2a 73 71 6c 2c 0a  *,.  char *sql,.
3370: 20 20 69 6e 74 20 28 2a 29 28 76 6f 69 64 2a 2c    int (*)(void*,
3380: 69 6e 74 2c 63 68 61 72 2a 2a 2c 63 68 61 72 2a  int,char**,char*
3390: 2a 29 2c 0a 20 20 76 6f 69 64 2a 2c 0a 20 20 63  *),.  void*,.  c
33a0: 68 61 72 20 2a 2a 65 72 72 6d 73 67 2c 0a 20 20  har **errmsg,.  
33b0: 2e 2e 2e 0a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69  ....);..int sqli
33c0: 74 65 5f 65 78 65 63 5f 76 70 72 69 6e 74 66 28  te_exec_vprintf(
33d0: 0a 20 20 73 71 6c 69 74 65 2a 2c 0a 20 20 63 68  .  sqlite*,.  ch
33e0: 61 72 20 2a 73 71 6c 2c 0a 20 20 69 6e 74 20 28  ar *sql,.  int (
33f0: 2a 29 28 76 6f 69 64 2a 2c 69 6e 74 2c 63 68 61  *)(void*,int,cha
3400: 72 2a 2a 2c 63 68 61 72 2a 2a 29 2c 0a 20 20 76  r**,char**),.  v
3410: 6f 69 64 2a 2c 0a 20 20 63 68 61 72 20 2a 2a 65  oid*,.  char **e
3420: 72 72 6d 73 67 2c 0a 20 20 76 61 5f 6c 69 73 74  rrmsg,.  va_list
3430: 0a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 5f  .);..int sqlite_
3440: 67 65 74 5f 74 61 62 6c 65 5f 70 72 69 6e 74 66  get_table_printf
3450: 28 0a 20 20 73 71 6c 69 74 65 2a 2c 0a 20 20 63  (.  sqlite*,.  c
3460: 68 61 72 20 2a 73 71 6c 2c 0a 20 20 63 68 61 72  har *sql,.  char
3470: 20 2a 2a 2a 72 65 73 75 6c 74 2c 0a 20 20 69 6e   ***result,.  in
3480: 74 20 2a 6e 72 6f 77 2c 0a 20 20 69 6e 74 20 2a  t *nrow,.  int *
3490: 6e 63 6f 6c 75 6d 6e 2c 0a 20 20 63 68 61 72 20  ncolumn,.  char 
34a0: 2a 2a 65 72 72 6d 73 67 2c 0a 20 20 2e 2e 2e 0a  **errmsg,.  ....
34b0: 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 5f 67  );..int sqlite_g
34c0: 65 74 5f 74 61 62 6c 65 5f 76 70 72 69 6e 74 66  et_table_vprintf
34d0: 28 0a 20 20 73 71 6c 69 74 65 2a 2c 0a 20 20 63  (.  sqlite*,.  c
34e0: 68 61 72 20 2a 73 71 6c 2c 0a 20 20 63 68 61 72  har *sql,.  char
34f0: 20 2a 2a 2a 72 65 73 75 6c 74 2c 0a 20 20 69 6e   ***result,.  in
3500: 74 20 2a 6e 72 6f 77 2c 0a 20 20 69 6e 74 20 2a  t *nrow,.  int *
3510: 6e 63 6f 6c 75 6d 6e 2c 0a 20 20 63 68 61 72 20  ncolumn,.  char 
3520: 2a 2a 65 72 72 6d 73 67 2c 0a 20 20 76 61 5f 6c  **errmsg,.  va_l
3530: 69 73 74 0a 29 3b 0a 0a 3c 2f 70 72 65 3e 3c 2f  ist.);..</pre></
3540: 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e  blockquote>..<p>
3550: 41 6c 6c 20 6f 66 20 74 68 65 20 61 62 6f 76 65  All of the above
3560: 20 64 65 66 69 6e 69 74 69 6f 6e 73 20 61 72 65   definitions are
3570: 20 69 6e 63 6c 75 64 65 64 20 69 6e 20 74 68 65   included in the
3580: 20 22 73 71 6c 69 74 65 2e 68 22 0a 68 65 61 64   "sqlite.h".head
3590: 65 72 20 66 69 6c 65 20 74 68 61 74 20 63 6f 6d  er file that com
35a0: 65 73 20 69 6e 20 74 68 65 20 73 6f 75 72 63 65  es in the source
35b0: 20 74 72 65 65 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e   tree.</p>..<h2>
35c0: 54 68 65 20 52 4f 57 49 44 20 6f 66 20 74 68 65  The ROWID of the
35d0: 20 6d 6f 73 74 20 72 65 63 65 6e 74 20 69 6e 73   most recent ins
35e0: 65 72 74 3c 2f 68 32 3e 0a 0a 3c 70 3e 45 76 65  ert</h2>..<p>Eve
35f0: 72 79 20 72 6f 77 20 6f 66 20 61 6e 20 53 51 4c  ry row of an SQL
3600: 69 74 65 20 74 61 62 6c 65 20 68 61 73 20 61 20  ite table has a 
3610: 75 6e 69 71 75 65 20 69 6e 74 65 67 65 72 20 6b  unique integer k
3620: 65 79 2e 20 20 49 66 20 74 68 65 0a 74 61 62 6c  ey.  If the.tabl
3630: 65 20 68 61 73 20 61 20 63 6f 6c 75 6d 6e 20 6c  e has a column l
3640: 61 62 65 6c 65 64 20 49 4e 54 45 47 45 52 20 50  abeled INTEGER P
3650: 52 49 4d 41 52 59 20 4b 45 59 2c 20 74 68 65 6e  RIMARY KEY, then
3660: 20 74 68 61 74 20 63 6f 6c 75 6d 6e 0a 73 65 72   that column.ser
3670: 76 65 72 73 20 61 73 20 74 68 65 20 6b 65 79 2e  vers as the key.
3680: 20 20 49 66 20 74 68 65 72 65 20 69 73 20 6e 6f    If there is no
3690: 20 49 4e 54 45 47 45 52 20 50 52 49 4d 41 52 59   INTEGER PRIMARY
36a0: 20 4b 45 59 20 63 6f 6c 75 6d 6e 20 74 68 65 6e   KEY column then
36b0: 0a 74 68 65 20 6b 65 79 20 69 73 20 61 20 75 6e  .the key is a un
36c0: 69 71 75 65 20 69 6e 74 65 67 65 72 2e 20 20 54  ique integer.  T
36d0: 68 65 20 6b 65 79 20 66 6f 72 20 61 20 72 6f 77  he key for a row
36e0: 20 63 61 6e 20 62 65 20 61 63 63 65 73 73 65 64   can be accessed
36f0: 20 69 6e 0a 61 20 53 45 4c 45 43 54 20 73 74 61   in.a SELECT sta
3700: 74 65 6d 65 6e 74 20 6f 72 20 75 73 65 64 20 69  tement or used i
3710: 6e 20 61 20 57 48 45 52 45 20 6f 72 20 4f 52 44  n a WHERE or ORD
3720: 45 52 20 42 59 20 63 6c 61 75 73 65 20 75 73 69  ER BY clause usi
3730: 6e 67 20 61 6e 79 0a 6f 66 20 74 68 65 20 6e 61  ng any.of the na
3740: 6d 65 73 20 22 52 4f 57 49 44 22 2c 20 22 4f 49  mes "ROWID", "OI
3750: 44 22 2c 20 6f 72 20 22 5f 52 4f 57 49 44 5f 22  D", or "_ROWID_"
3760: 2e 3c 2f 70 3e 0a 0a 3c 70 3e 57 68 65 6e 20 79  .</p>..<p>When y
3770: 6f 75 20 64 6f 20 61 6e 20 69 6e 73 65 72 74 20  ou do an insert 
3780: 69 6e 74 6f 20 61 20 74 61 62 6c 65 20 74 68 61  into a table tha
3790: 74 20 64 6f 65 73 20 6e 6f 74 20 68 61 76 65 20  t does not have 
37a0: 61 6e 20 49 4e 54 45 47 45 52 20 50 52 49 4d 41  an INTEGER PRIMA
37b0: 52 59 0a 4b 45 59 20 63 6f 6c 75 6d 6e 2c 20 6f  RY.KEY column, o
37c0: 72 20 69 66 20 74 68 65 20 74 61 62 6c 65 20 64  r if the table d
37d0: 6f 65 73 20 68 61 76 65 20 61 6e 20 49 4e 54 45  oes have an INTE
37e0: 47 45 52 20 50 52 49 4d 41 52 59 20 4b 45 59 20  GER PRIMARY KEY 
37f0: 62 75 74 20 74 68 65 20 76 61 6c 75 65 0a 66 6f  but the value.fo
3800: 72 20 74 68 61 74 20 63 6f 6c 75 6d 6e 20 69 73  r that column is
3810: 20 6e 6f 74 20 73 70 65 63 69 66 69 65 64 20 69   not specified i
3820: 6e 20 74 68 65 20 56 41 4c 55 45 53 20 63 6c 61  n the VALUES cla
3830: 75 73 65 20 6f 66 20 74 68 65 20 69 6e 73 65 72  use of the inser
3840: 74 2c 20 74 68 65 6e 0a 74 68 65 20 6b 65 79 20  t, then.the key 
3850: 69 73 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79  is automatically
3860: 20 67 65 6e 65 72 61 74 65 64 2e 20 20 59 6f 75   generated.  You
3870: 20 63 61 6e 20 66 69 6e 64 20 74 68 65 20 76 61   can find the va
3880: 6c 75 65 20 6f 66 20 74 68 65 20 6b 65 79 0a 66  lue of the key.f
3890: 6f 72 20 74 68 65 20 6d 6f 73 74 20 72 65 63 65  or the most rece
38a0: 6e 74 20 49 4e 53 45 52 54 20 73 74 61 74 65 6d  nt INSERT statem
38b0: 65 6e 74 20 75 73 69 6e 67 20 74 68 65 0a 3c 62  ent using the.<b
38c0: 3e 73 71 6c 69 74 65 5f 6c 61 73 74 5f 69 6e 73  >sqlite_last_ins
38d0: 65 72 74 5f 72 6f 77 69 64 28 29 3c 2f 62 3e 20  ert_rowid()</b> 
38e0: 41 50 49 20 66 75 6e 63 74 69 6f 6e 2e 3c 2f 70  API function.</p
38f0: 3e 0a 0a 3c 68 32 3e 51 75 65 72 79 69 6e 67 20  >..<h2>Querying 
3900: 77 69 74 68 6f 75 74 20 75 73 69 6e 67 20 61 20  without using a 
3910: 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f  callback functio
3920: 6e 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65 20 3c  n</h2>..<p>The <
3930: 62 3e 73 71 6c 69 74 65 5f 67 65 74 5f 74 61 62  b>sqlite_get_tab
3940: 6c 65 28 29 3c 2f 62 3e 20 66 75 6e 63 74 69 6f  le()</b> functio
3950: 6e 20 69 73 20 61 20 77 72 61 70 70 65 72 20 61  n is a wrapper a
3960: 72 6f 75 6e 64 0a 3c 62 3e 73 71 6c 69 74 65 5f  round.<b>sqlite_
3970: 65 78 65 63 28 29 3c 2f 62 3e 20 74 68 61 74 20  exec()</b> that 
3980: 63 6f 6c 6c 65 63 74 73 20 61 6c 6c 20 74 68 65  collects all the
3990: 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 66 72 6f   information fro
39a0: 6d 20 73 75 63 63 65 73 73 69 76 65 0a 63 61 6c  m successive.cal
39b0: 6c 62 61 63 6b 73 20 61 6e 64 20 77 72 69 74 65  lbacks and write
39c0: 20 69 74 20 69 6e 74 6f 20 6d 65 6d 6f 72 79 20   it into memory 
39d0: 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 6d 61  obtained from ma
39e0: 6c 6c 6f 63 28 29 2e 20 20 54 68 69 73 0a 69 73  lloc().  This.is
39f0: 20 61 20 63 6f 6e 76 65 6e 69 65 6e 63 65 20 66   a convenience f
3a00: 75 6e 63 74 69 6f 6e 20 74 68 61 74 20 61 6c 6c  unction that all
3a10: 6f 77 73 20 74 68 65 20 61 70 70 6c 69 63 61 74  ows the applicat
3a20: 69 6f 6e 20 74 6f 20 67 65 74 20 74 68 65 0a 65  ion to get the.e
3a30: 6e 74 69 72 65 20 72 65 73 75 6c 74 20 6f 66 20  ntire result of 
3a40: 61 20 64 61 74 61 62 61 73 65 20 71 75 65 72 79  a database query
3a50: 20 77 69 74 68 20 61 20 73 69 6e 67 6c 65 20 66   with a single f
3a60: 75 6e 63 74 69 6f 6e 20 63 61 6c 6c 2e 3c 2f 70  unction call.</p
3a70: 3e 0a 0a 3c 70 3e 54 68 65 20 6d 61 69 6e 20 72  >..<p>The main r
3a80: 65 73 75 6c 74 20 66 72 6f 6d 20 3c 62 3e 73 71  esult from <b>sq
3a90: 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 28 29  lite_get_table()
3aa0: 3c 2f 62 3e 20 69 73 20 61 6e 20 61 72 72 61 79  </b> is an array
3ab0: 20 6f 66 20 70 6f 69 6e 74 65 72 73 0a 74 6f 20   of pointers.to 
3ac0: 73 74 72 69 6e 67 73 2e 20 20 54 68 65 72 65 20  strings.  There 
3ad0: 69 73 20 6f 6e 65 20 65 6c 65 6d 65 6e 74 20 69  is one element i
3ae0: 6e 20 74 68 69 73 20 61 72 72 61 79 20 66 6f 72  n this array for
3af0: 20 65 61 63 68 20 63 6f 6c 75 6d 6e 20 6f 66 0a   each column of.
3b00: 65 61 63 68 20 72 6f 77 20 69 6e 20 74 68 65 20  each row in the 
3b10: 72 65 73 75 6c 74 2e 20 20 4e 55 4c 4c 20 72 65  result.  NULL re
3b20: 73 75 6c 74 73 20 61 72 65 20 72 65 70 72 65 73  sults are repres
3b30: 65 6e 74 65 64 20 62 79 20 61 20 4e 55 4c 4c 0a  ented by a NULL.
3b40: 70 6f 69 6e 74 65 72 2e 20 49 6e 20 61 64 64 69  pointer. In addi
3b50: 74 69 6f 6e 20 74 6f 20 74 68 65 20 72 65 67 75  tion to the regu
3b60: 6c 61 72 20 64 61 74 61 2c 20 74 68 65 72 65 20  lar data, there 
3b70: 69 73 20 61 6e 20 61 64 64 65 64 20 72 6f 77 20  is an added row 
3b80: 61 74 20 74 68 65 20 0a 62 65 67 69 6e 6e 69 6e  at the .beginnin
3b90: 67 20 6f 66 20 74 68 65 20 61 72 72 61 79 20 74  g of the array t
3ba0: 68 61 74 20 63 6f 6e 74 61 69 6e 73 20 74 68 65  hat contains the
3bb0: 20 6e 61 6d 65 73 20 6f 66 20 65 61 63 68 20 63   names of each c
3bc0: 6f 6c 75 6d 6e 20 6f 66 20 74 68 65 0a 72 65 73  olumn of the.res
3bd0: 75 6c 74 2e 3c 2f 70 3e 0a 0a 3c 70 3e 41 73 20  ult.</p>..<p>As 
3be0: 61 6e 20 65 78 61 6d 70 6c 65 2c 20 63 6f 6e 73  an example, cons
3bf0: 69 64 65 72 20 74 68 65 20 66 6f 6c 6c 6f 77 69  ider the followi
3c00: 6e 67 20 71 75 65 72 79 3a 3c 2f 70 3e 0a 0a 3c  ng query:</p>..<
3c10: 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 53 45 4c 45  blockquote>.SELE
3c20: 43 54 20 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65  CT employee_name
3c30: 2c 20 6c 6f 67 69 6e 2c 20 68 6f 73 74 20 46 52  , login, host FR
3c40: 4f 4d 20 75 73 65 72 73 20 57 48 45 52 45 20 6c  OM users WHERE l
3c50: 6f 67 69 63 20 4c 49 4b 45 20 27 64 25 27 3b 0a  ogic LIKE 'd%';.
3c60: 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c  </blockquote>..<
3c70: 70 3e 54 68 69 73 20 71 75 65 72 79 20 77 69 6c  p>This query wil
3c80: 6c 20 72 65 74 75 72 6e 20 74 68 65 20 6e 61 6d  l return the nam
3c90: 65 2c 20 6c 6f 67 69 6e 20 61 6e 64 20 68 6f 73  e, login and hos
3ca0: 74 20 63 6f 6d 70 75 74 65 72 20 6e 61 6d 65 0a  t computer name.
3cb0: 66 6f 72 20 65 76 65 72 79 20 65 6d 70 6c 6f 79  for every employ
3cc0: 65 65 20 77 68 6f 73 65 20 6c 6f 67 69 6e 20 62  ee whose login b
3cd0: 65 67 69 6e 73 20 77 69 74 68 20 74 68 65 20 6c  egins with the l
3ce0: 65 74 74 65 72 20 22 64 22 2e 20 20 49 66 20 74  etter "d".  If t
3cf0: 68 69 73 0a 71 75 65 72 79 20 69 73 20 73 75 62  his.query is sub
3d00: 6d 69 74 74 65 64 20 74 6f 20 3c 62 3e 73 71 6c  mitted to <b>sql
3d10: 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 28 29 3c  ite_get_table()<
3d20: 2f 62 3e 20 74 68 65 20 72 65 73 75 6c 74 20 6d  /b> the result m
3d30: 69 67 68 74 0a 6c 6f 6f 6b 20 6c 69 6b 65 20 74  ight.look like t
3d40: 68 69 73 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b  his:</p>..<block
3d50: 71 75 6f 74 65 3e 0a 6e 72 6f 77 20 3d 20 32 3c  quote>.nrow = 2<
3d60: 62 72 3e 0a 6e 63 6f 6c 75 6d 6e 20 3d 20 33 3c  br>.ncolumn = 3<
3d70: 62 72 3e 0a 72 65 73 75 6c 74 5b 30 5d 20 3d 20  br>.result[0] = 
3d80: 22 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65 22 3c  "employee_name"<
3d90: 62 72 3e 0a 72 65 73 75 6c 74 5b 31 5d 20 3d 20  br>.result[1] = 
3da0: 22 6c 6f 67 69 6e 22 3c 62 72 3e 0a 72 65 73 75  "login"<br>.resu
3db0: 6c 74 5b 32 5d 20 3d 20 22 68 6f 73 74 22 3c 62  lt[2] = "host"<b
3dc0: 72 3e 0a 72 65 73 75 6c 74 5b 33 5d 20 3d 20 22  r>.result[3] = "
3dd0: 64 75 6d 6d 79 22 3c 62 72 3e 0a 72 65 73 75 6c  dummy"<br>.resul
3de0: 74 5b 34 5d 20 3d 20 22 4e 6f 20 73 75 63 68 20  t[4] = "No such 
3df0: 75 73 65 72 22 3c 62 72 3e 0a 72 65 73 75 6c 74  user"<br>.result
3e00: 5b 35 5d 20 3d 20 30 3c 62 72 3e 0a 72 65 73 75  [5] = 0<br>.resu
3e10: 6c 74 5b 36 5d 20 3d 20 22 44 2e 20 52 69 63 68  lt[6] = "D. Rich
3e20: 61 72 64 20 48 69 70 70 22 3c 62 72 3e 0a 72 65  ard Hipp"<br>.re
3e30: 73 75 6c 74 5b 37 5d 20 3d 20 22 64 72 68 22 3c  sult[7] = "drh"<
3e40: 62 72 3e 0a 72 65 73 75 6c 74 5b 38 5d 20 3d 20  br>.result[8] = 
3e50: 22 7a 61 64 6f 6b 22 0a 3c 2f 62 6c 6f 63 6b 71  "zadok".</blockq
3e60: 75 6f 74 65 3e 0a 0a 3c 70 3e 4e 6f 74 69 63 65  uote>..<p>Notice
3e70: 20 74 68 61 74 20 74 68 65 20 22 68 6f 73 74 22   that the "host"
3e80: 20 76 61 6c 75 65 20 66 6f 72 20 74 68 65 20 22   value for the "
3e90: 64 75 6d 6d 79 22 20 72 65 63 6f 72 64 20 69 73  dummy" record is
3ea0: 20 4e 55 4c 4c 20 73 6f 0a 74 68 65 20 72 65 73   NULL so.the res
3eb0: 75 6c 74 5b 5d 20 61 72 72 61 79 20 63 6f 6e 74  ult[] array cont
3ec0: 61 69 6e 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e  ains a NULL poin
3ed0: 74 65 72 20 61 74 20 74 68 61 74 20 73 6c 6f 74  ter at that slot
3ee0: 2e 3c 2f 70 3e 0a 0a 3c 70 3e 49 66 20 74 68 65  .</p>..<p>If the
3ef0: 20 72 65 73 75 6c 74 20 73 65 74 20 6f 66 20 61   result set of a
3f00: 20 71 75 65 72 79 20 69 73 20 65 6d 70 74 79 2c   query is empty,
3f10: 20 74 68 65 6e 20 62 79 20 64 65 66 61 75 6c 74   then by default
3f20: 0a 3c 62 3e 73 71 6c 69 74 65 5f 67 65 74 5f 74  .<b>sqlite_get_t
3f30: 61 62 6c 65 28 29 3c 2f 62 3e 20 77 69 6c 6c 20  able()</b> will 
3f40: 73 65 74 20 6e 72 6f 77 20 74 6f 20 30 20 61 6e  set nrow to 0 an
3f50: 64 20 6c 65 61 76 65 20 69 74 73 0a 72 65 73 75  d leave its.resu
3f60: 6c 74 20 70 61 72 61 6d 65 74 65 72 20 69 73 20  lt parameter is 
3f70: 73 65 74 20 74 6f 20 4e 55 4c 4c 2e 20 20 42 75  set to NULL.  Bu
3f80: 74 20 69 66 20 74 68 65 20 45 4d 50 54 59 5f 52  t if the EMPTY_R
3f90: 45 53 55 4c 54 5f 43 41 4c 4c 42 41 43 4b 53 0a  ESULT_CALLBACKS.
3fa0: 70 72 61 67 6d 61 20 69 73 20 4f 4e 20 74 68 65  pragma is ON the
3fb0: 6e 20 74 68 65 20 72 65 73 75 6c 74 20 70 61 72  n the result par
3fc0: 61 6d 65 74 65 72 20 69 73 20 69 6e 69 74 69 61  ameter is initia
3fd0: 6c 69 7a 65 64 20 74 6f 20 74 68 65 20 6e 61 6d  lized to the nam
3fe0: 65 73 0a 6f 66 20 74 68 65 20 63 6f 6c 75 6d 6e  es.of the column
3ff0: 73 20 6f 6e 6c 79 2e 20 20 46 6f 72 20 65 78 61  s only.  For exa
4000: 6d 70 6c 65 2c 20 63 6f 6e 73 69 64 65 72 20 74  mple, consider t
4010: 68 69 73 20 71 75 65 72 79 20 77 68 69 63 68 20  his query which 
4020: 68 61 73 0a 61 6e 20 65 6d 70 74 79 20 72 65 73  has.an empty res
4030: 75 6c 74 20 73 65 74 3a 3c 2f 70 3e 0a 0a 3c 62  ult set:</p>..<b
4040: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 53 45 4c 45 43  lockquote>.SELEC
4050: 54 20 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65 2c  T employee_name,
4060: 20 6c 6f 67 69 6e 2c 20 68 6f 73 74 20 46 52 4f   login, host FRO
4070: 4d 20 75 73 65 72 73 20 57 48 45 52 45 20 65 6d  M users WHERE em
4080: 70 6c 6f 79 65 65 5f 6e 61 6d 65 20 49 53 20 4e  ployee_name IS N
4090: 55 4c 4c 3b 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74  ULL;.</blockquot
40a0: 65 3e 0a 0a 3c 70 3e 0a 54 68 65 20 64 65 66 61  e>..<p>.The defa
40b0: 75 6c 74 20 62 65 68 61 76 69 6f 72 20 67 69 76  ult behavior giv
40c0: 65 73 20 74 68 69 73 20 72 65 73 75 6c 74 73 3a  es this results:
40d0: 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f  .</p>..<blockquo
40e0: 74 65 3e 0a 6e 72 6f 77 20 3d 20 30 3c 62 72 3e  te>.nrow = 0<br>
40f0: 0a 6e 63 6f 6c 75 6d 6e 20 3d 20 30 3c 62 72 3e  .ncolumn = 0<br>
4100: 0a 72 65 73 75 6c 74 20 3d 20 30 3c 62 72 3e 0a  .result = 0<br>.
4110: 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a 3c  </blockquote>..<
4120: 70 3e 0a 42 75 74 20 69 66 20 74 68 65 20 45 4d  p>.But if the EM
4130: 50 54 59 5f 52 45 53 55 4c 54 5f 43 41 4c 4c 42  PTY_RESULT_CALLB
4140: 41 43 4b 53 20 70 72 61 67 6d 61 20 69 73 20 4f  ACKS pragma is O
4150: 4e 2c 20 74 68 65 6e 20 74 68 65 20 66 6f 6c 6c  N, then the foll
4160: 6f 77 69 6e 67 0a 69 73 20 72 65 74 75 72 6e 65  owing.is returne
4170: 64 3a 0a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71  d:.</p>..<blockq
4180: 75 6f 74 65 3e 0a 6e 72 6f 77 20 3d 20 30 3c 62  uote>.nrow = 0<b
4190: 72 3e 0a 6e 63 6f 6c 75 6d 6e 20 3d 20 33 3c 62  r>.ncolumn = 3<b
41a0: 72 3e 0a 72 65 73 75 6c 74 5b 30 5d 20 3d 20 22  r>.result[0] = "
41b0: 65 6d 70 6c 6f 79 65 65 5f 6e 61 6d 65 22 3c 62  employee_name"<b
41c0: 72 3e 0a 72 65 73 75 6c 74 5b 31 5d 20 3d 20 22  r>.result[1] = "
41d0: 6c 6f 67 69 6e 22 3c 62 72 3e 0a 72 65 73 75 6c  login"<br>.resul
41e0: 74 5b 32 5d 20 3d 20 22 68 6f 73 74 22 3c 62 72  t[2] = "host"<br
41f0: 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a  >.</blockquote>.
4200: 0a 3c 70 3e 4d 65 6d 6f 72 79 20 74 6f 20 68 6f  .<p>Memory to ho
4210: 6c 64 20 74 68 65 20 69 6e 66 6f 72 6d 61 74 69  ld the informati
4220: 6f 6e 20 72 65 74 75 72 6e 65 64 20 62 79 20 3c  on returned by <
4230: 62 3e 73 71 6c 69 74 65 5f 67 65 74 5f 74 61 62  b>sqlite_get_tab
4240: 6c 65 28 29 3c 2f 62 3e 0a 69 73 20 6f 62 74 61  le()</b>.is obta
4250: 69 6e 65 64 20 66 72 6f 6d 20 6d 61 6c 6c 6f 63  ined from malloc
4260: 28 29 2e 20 20 42 75 74 20 74 68 65 20 63 61 6c  ().  But the cal
4270: 6c 69 6e 67 20 66 75 6e 63 74 69 6f 6e 20 73 68  ling function sh
4280: 6f 75 6c 64 20 6e 6f 74 20 74 72 79 0a 74 6f 20  ould not try.to 
4290: 66 72 65 65 20 74 68 69 73 20 69 6e 66 6f 72 6d  free this inform
42a0: 61 74 69 6f 6e 20 64 69 72 65 63 74 6c 79 2e 20  ation directly. 
42b0: 20 49 6e 73 74 65 61 64 2c 20 70 61 73 73 20 74   Instead, pass t
42c0: 68 65 20 63 6f 6d 70 6c 65 74 65 20 74 61 62 6c  he complete tabl
42d0: 65 0a 74 6f 20 3c 62 3e 73 71 6c 69 74 65 5f 66  e.to <b>sqlite_f
42e0: 72 65 65 5f 74 61 62 6c 65 28 29 3c 2f 62 3e 20  ree_table()</b> 
42f0: 77 68 65 6e 20 74 68 65 20 74 61 62 6c 65 20 69  when the table i
4300: 73 20 6e 6f 20 6c 6f 6e 67 65 72 20 6e 65 65 64  s no longer need
4310: 65 64 2e 0a 49 74 20 69 73 20 73 61 66 65 20 74  ed..It is safe t
4320: 6f 20 63 61 6c 6c 20 3c 62 3e 73 71 6c 69 74 65  o call <b>sqlite
4330: 5f 66 72 65 65 5f 74 61 62 6c 65 28 29 3c 2f 62  _free_table()</b
4340: 3e 20 77 69 74 68 20 61 20 4e 55 4c 4c 20 70 6f  > with a NULL po
4350: 69 6e 74 65 72 20 73 75 63 68 0a 61 73 20 77 6f  inter such.as wo
4360: 75 6c 64 20 62 65 20 72 65 74 75 72 6e 65 64 20  uld be returned 
4370: 69 66 20 74 68 65 20 72 65 73 75 6c 74 20 73 65  if the result se
4380: 74 20 69 73 20 65 6d 70 74 79 2e 3c 2f 70 3e 0a  t is empty.</p>.
4390: 0a 3c 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69 74  .<p>The <b>sqlit
43a0: 65 5f 67 65 74 5f 74 61 62 6c 65 28 29 3c 2f 62  e_get_table()</b
43b0: 3e 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e  > routine return
43c0: 73 20 74 68 65 20 73 61 6d 65 20 69 6e 74 65 67  s the same integ
43d0: 65 72 0a 72 65 73 75 6c 74 20 63 6f 64 65 20 61  er.result code a
43e0: 73 20 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65 63  s <b>sqlite_exec
43f0: 28 29 3c 2f 62 3e 2e 3c 2f 70 3e 0a 0a 3c 68 32  ()</b>.</p>..<h2
4400: 3e 49 6e 74 65 72 72 75 70 74 69 6e 67 20 61 6e  >Interrupting an
4410: 20 53 51 4c 69 74 65 20 6f 70 65 72 61 74 69 6f   SQLite operatio
4420: 6e 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65 20 3c  n</h2>..<p>The <
4430: 62 3e 73 71 6c 69 74 65 5f 69 6e 74 65 72 72 75  b>sqlite_interru
4440: 70 74 28 29 3c 2f 62 3e 20 66 75 6e 63 74 69 6f  pt()</b> functio
4450: 6e 20 63 61 6e 20 62 65 20 63 61 6c 6c 65 64 20  n can be called 
4460: 66 72 6f 6d 20 61 0a 64 69 66 66 65 72 65 6e 74  from a.different
4470: 20 74 68 72 65 61 64 20 6f 72 20 66 72 6f 6d 20   thread or from 
4480: 61 20 73 69 67 6e 61 6c 20 68 61 6e 64 6c 65 72  a signal handler
4490: 20 74 6f 20 63 61 75 73 65 20 74 68 65 20 63 75   to cause the cu
44a0: 72 72 65 6e 74 20 64 61 74 61 62 61 73 65 0a 6f  rrent database.o
44b0: 70 65 72 61 74 69 6f 6e 20 74 6f 20 65 78 69 74  peration to exit
44c0: 20 61 74 20 69 74 73 20 66 69 72 73 74 20 6f 70   at its first op
44d0: 70 6f 72 74 75 6e 69 74 79 2e 20 20 57 68 65 6e  portunity.  When
44e0: 20 74 68 69 73 20 68 61 70 70 65 6e 73 2c 0a 74   this happens,.t
44f0: 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65  he <b>sqlite_exe
4500: 63 28 29 3c 2f 62 3e 20 72 6f 75 74 69 6e 65 20  c()</b> routine 
4510: 28 6f 72 20 74 68 65 20 65 71 75 69 76 61 6c 65  (or the equivale
4520: 6e 74 29 20 74 68 61 74 20 73 74 61 72 74 65 64  nt) that started
4530: 0a 74 68 65 20 64 61 74 61 62 61 73 65 20 6f 70  .the database op
4540: 65 72 61 74 69 6f 6e 20 77 69 6c 6c 20 72 65 74  eration will ret
4550: 75 72 6e 20 53 51 4c 49 54 45 5f 49 4e 54 45 52  urn SQLITE_INTER
4560: 52 55 50 54 2e 3c 2f 70 3e 0a 0a 3c 68 32 3e 54  RUPT.</p>..<h2>T
4570: 65 73 74 69 6e 67 20 66 6f 72 20 61 20 63 6f 6d  esting for a com
4580: 70 6c 65 74 65 20 53 51 4c 20 73 74 61 74 65 6d  plete SQL statem
4590: 65 6e 74 3c 2f 68 32 3e 0a 0a 3c 70 3e 54 68 65  ent</h2>..<p>The
45a0: 20 6e 65 78 74 20 69 6e 74 65 72 66 61 63 65 20   next interface 
45b0: 72 6f 75 74 69 6e 65 20 74 6f 20 53 51 4c 69 74  routine to SQLit
45c0: 65 20 69 73 20 61 20 63 6f 6e 76 65 6e 69 65 6e  e is a convenien
45d0: 63 65 20 66 75 6e 63 74 69 6f 6e 20 75 73 65 64  ce function used
45e0: 0a 74 6f 20 74 65 73 74 20 77 68 65 74 68 65 72  .to test whether
45f0: 20 6f 72 20 6e 6f 74 20 61 20 73 74 72 69 6e 67   or not a string
4600: 20 66 6f 72 6d 73 20 61 20 63 6f 6d 70 6c 65 74   forms a complet
4610: 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2e  e SQL statement.
4620: 0a 49 66 20 74 68 65 20 3c 62 3e 73 71 6c 69 74  .If the <b>sqlit
4630: 65 5f 63 6f 6d 70 6c 65 74 65 28 29 3c 2f 62 3e  e_complete()</b>
4640: 20 66 75 6e 63 74 69 6f 6e 20 72 65 74 75 72 6e   function return
4650: 73 20 74 72 75 65 20 77 68 65 6e 20 69 74 73 20  s true when its 
4660: 69 6e 70 75 74 0a 69 73 20 61 20 73 74 72 69 6e  input.is a strin
4670: 67 2c 20 74 68 65 6e 20 74 68 65 20 61 72 67 75  g, then the argu
4680: 6d 65 6e 74 20 66 6f 72 6d 73 20 61 20 63 6f 6d  ment forms a com
4690: 70 6c 65 74 65 20 53 51 4c 20 73 74 61 74 65 6d  plete SQL statem
46a0: 65 6e 74 2e 0a 54 68 65 72 65 20 61 72 65 20 6e  ent..There are n
46b0: 6f 20 67 75 61 72 61 6e 74 65 65 73 20 74 68 61  o guarantees tha
46c0: 74 20 74 68 65 20 73 79 6e 74 61 78 20 6f 66 20  t the syntax of 
46d0: 74 68 61 74 20 73 74 61 74 65 6d 65 6e 74 20 69  that statement i
46e0: 73 20 63 6f 72 72 65 63 74 2c 0a 62 75 74 20 77  s correct,.but w
46f0: 65 20 61 74 20 6c 65 61 73 74 20 6b 6e 6f 77 20  e at least know 
4700: 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20 69 73  the statement is
4710: 20 63 6f 6d 70 6c 65 74 65 2e 20 20 49 66 20 3c   complete.  If <
4720: 62 3e 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74  b>sqlite_complet
4730: 65 28 29 3c 2f 62 3e 0a 72 65 74 75 72 6e 73 20  e()</b>.returns 
4740: 66 61 6c 73 65 2c 20 74 68 65 6e 20 6d 6f 72 65  false, then more
4750: 20 74 65 78 74 20 69 73 20 72 65 71 75 69 72 65   text is require
4760: 64 20 74 6f 20 63 6f 6d 70 6c 65 74 65 20 74 68  d to complete th
4770: 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2e  e SQL statement.
4780: 3c 2f 70 3e 0a 0a 3c 70 3e 46 6f 72 20 74 68 65  </p>..<p>For the
4790: 20 70 75 72 70 6f 73 65 20 6f 66 20 74 68 65 20   purpose of the 
47a0: 3c 62 3e 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65  <b>sqlite_comple
47b0: 74 65 28 29 3c 2f 62 3e 20 66 75 6e 63 74 69 6f  te()</b> functio
47c0: 6e 2c 20 61 6e 20 53 51 4c 0a 73 74 61 74 65 6d  n, an SQL.statem
47d0: 65 6e 74 20 69 73 20 63 6f 6d 70 6c 65 74 65 20  ent is complete 
47e0: 69 66 20 69 74 20 65 6e 64 73 20 69 6e 20 61 20  if it ends in a 
47f0: 73 65 6d 69 63 6f 6c 6f 6e 2e 3c 2f 70 3e 0a 0a  semicolon.</p>..
4800: 3c 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69 74 65  <p>The <b>sqlite
4810: 3c 2f 62 3e 20 63 6f 6d 6d 61 6e 64 2d 6c 69 6e  </b> command-lin
4820: 65 20 75 74 69 6c 69 74 79 20 75 73 65 73 20 74  e utility uses t
4830: 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 63 6f 6d  he <b>sqlite_com
4840: 70 6c 65 74 65 28 29 3c 2f 62 3e 0a 66 75 6e 63  plete()</b>.func
4850: 74 69 6f 6e 20 74 6f 20 6b 6e 6f 77 20 77 68 65  tion to know whe
4860: 6e 20 69 74 20 6e 65 65 64 73 20 74 6f 20 63 61  n it needs to ca
4870: 6c 6c 20 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65  ll <b>sqlite_exe
4880: 63 28 29 3c 2f 62 3e 2e 20 20 41 66 74 65 72 20  c()</b>.  After 
4890: 65 61 63 68 0a 6c 69 6e 65 20 6f 66 20 69 6e 70  each.line of inp
48a0: 75 74 20 69 73 20 72 65 63 65 69 76 65 64 2c 20  ut is received, 
48b0: 3c 62 3e 73 71 6c 69 74 65 3c 2f 62 3e 20 63 61  <b>sqlite</b> ca
48c0: 6c 6c 73 20 3c 62 3e 73 71 6c 69 74 65 5f 63 6f  lls <b>sqlite_co
48d0: 6d 70 6c 65 74 65 28 29 3c 2f 62 3e 0a 6f 6e 20  mplete()</b>.on 
48e0: 61 6c 6c 20 69 6e 70 75 74 20 69 6e 20 69 74 73  all input in its
48f0: 20 62 75 66 66 65 72 2e 20 20 49 66 20 3c 62 3e   buffer.  If <b>
4900: 73 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74 65 28  sqlite_complete(
4910: 29 3c 2f 62 3e 20 72 65 74 75 72 6e 73 20 74 72  )</b> returns tr
4920: 75 65 2c 20 0a 74 68 65 6e 20 3c 62 3e 73 71 6c  ue, .then <b>sql
4930: 69 74 65 5f 65 78 65 63 28 29 3c 2f 62 3e 20 69  ite_exec()</b> i
4940: 73 20 63 61 6c 6c 65 64 20 61 6e 64 20 74 68 65  s called and the
4950: 20 69 6e 70 75 74 20 62 75 66 66 65 72 20 69 73   input buffer is
4960: 20 72 65 73 65 74 2e 20 20 49 66 0a 3c 62 3e 73   reset.  If.<b>s
4970: 71 6c 69 74 65 5f 63 6f 6d 70 6c 65 74 65 28 29  qlite_complete()
4980: 3c 2f 62 3e 20 72 65 74 75 72 6e 73 20 66 61 6c  </b> returns fal
4990: 73 65 2c 20 74 68 65 6e 20 74 68 65 20 70 72 6f  se, then the pro
49a0: 6d 70 74 20 69 73 20 63 68 61 6e 67 65 64 20 74  mpt is changed t
49b0: 6f 0a 74 68 65 20 63 6f 6e 74 69 6e 75 61 74 69  o.the continuati
49c0: 6f 6e 20 70 72 6f 6d 70 74 20 61 6e 64 20 61 6e  on prompt and an
49d0: 6f 74 68 65 72 20 6c 69 6e 65 20 6f 66 20 74 65  other line of te
49e0: 78 74 20 69 73 20 72 65 61 64 20 61 6e 64 20 61  xt is read and a
49f0: 64 64 65 64 20 74 6f 0a 74 68 65 20 69 6e 70 75  dded to.the inpu
4a00: 74 20 62 75 66 66 65 72 2e 3c 2f 70 3e 0a 0a 3c  t buffer.</p>..<
4a10: 68 32 3e 4c 69 62 72 61 72 79 20 76 65 72 73 69  h2>Library versi
4a20: 6f 6e 20 73 74 72 69 6e 67 3c 2f 68 32 3e 0a 0a  on string</h2>..
4a30: 3c 70 3e 54 68 65 20 53 51 4c 69 74 65 20 6c 69  <p>The SQLite li
4a40: 62 72 61 72 79 20 65 78 70 6f 72 74 73 20 74 68  brary exports th
4a50: 65 20 73 74 72 69 6e 67 20 63 6f 6e 73 74 61 6e  e string constan
4a60: 74 20 6e 61 6d 65 64 0a 3c 62 3e 73 71 6c 69 74  t named.<b>sqlit
4a70: 65 5f 76 65 72 73 69 6f 6e 3c 2f 62 3e 20 77 68  e_version</b> wh
4a80: 69 63 68 20 63 6f 6e 74 61 69 6e 73 20 74 68 65  ich contains the
4a90: 20 76 65 72 73 69 6f 6e 20 6e 75 6d 62 65 72 20   version number 
4aa0: 6f 66 20 74 68 65 0a 6c 69 62 72 61 72 79 2e 20  of the.library. 
4ab0: 20 54 68 65 20 68 65 61 64 65 72 20 66 69 6c 65   The header file
4ac0: 20 63 6f 6e 74 61 69 6e 73 20 61 20 6d 61 63 72   contains a macr
4ad0: 6f 20 53 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e  o SQLITE_VERSION
4ae0: 0a 77 69 74 68 20 74 68 65 20 73 61 6d 65 20 69  .with the same i
4af0: 6e 66 6f 72 6d 61 74 69 6f 6e 2e 20 20 49 66 20  nformation.  If 
4b00: 64 65 73 69 72 65 64 2c 20 61 20 70 72 6f 67 72  desired, a progr
4b10: 61 6d 20 63 61 6e 20 63 6f 6d 70 61 72 65 0a 74  am can compare.t
4b20: 68 65 20 53 51 4c 49 54 45 5f 56 45 52 53 49 4f  he SQLITE_VERSIO
4b30: 4e 20 6d 61 63 72 6f 20 61 67 61 69 6e 73 74 20  N macro against 
4b40: 74 68 65 20 3c 62 3e 73 71 6c 69 74 65 5f 76 65  the <b>sqlite_ve
4b50: 72 73 69 6f 6e 3c 2f 62 3e 0a 73 74 72 69 6e 67  rsion</b>.string
4b60: 20 63 6f 6e 73 74 61 6e 74 20 74 6f 20 76 65 72   constant to ver
4b70: 69 66 79 20 74 68 61 74 20 74 68 65 20 76 65 72  ify that the ver
4b80: 73 69 6f 6e 20 6e 75 6d 62 65 72 20 6f 66 20 74  sion number of t
4b90: 68 65 0a 68 65 61 64 65 72 20 66 69 6c 65 20 61  he.header file a
4ba0: 6e 64 20 74 68 65 20 6c 69 62 72 61 72 79 20 6d  nd the library m
4bb0: 61 74 63 68 2e 3c 2f 70 3e 20 0a 0a 3c 68 32 3e  atch.</p> ..<h2>
4bc0: 4c 69 62 72 61 72 79 20 63 68 61 72 61 63 74 65  Library characte
4bd0: 72 20 65 6e 63 6f 64 69 6e 67 3c 2f 68 32 3e 0a  r encoding</h2>.
4be0: 0a 3c 70 3e 42 79 20 64 65 66 61 75 6c 74 2c 20  .<p>By default, 
4bf0: 53 51 4c 69 74 65 20 61 73 73 75 6d 65 73 20 74  SQLite assumes t
4c00: 68 61 74 20 61 6c 6c 20 64 61 74 61 20 75 73 65  hat all data use
4c10: 73 20 61 20 66 69 78 65 64 2d 73 69 7a 65 0a 38  s a fixed-size.8
4c20: 2d 62 69 74 20 63 68 61 72 61 63 74 65 72 20 28  -bit character (
4c30: 69 73 6f 38 38 35 39 29 2e 20 20 42 75 74 20 69  iso8859).  But i
4c40: 66 20 79 6f 75 20 67 69 76 65 20 74 68 65 20 2d  f you give the -
4c50: 2d 65 6e 61 62 6c 65 2d 75 74 66 38 20 6f 70 74  -enable-utf8 opt
4c60: 69 6f 6e 0a 74 6f 20 74 68 65 20 63 6f 6e 66 69  ion.to the confi
4c70: 67 75 72 65 20 73 63 72 69 70 74 2c 20 74 68 65  gure script, the
4c80: 6e 20 74 68 65 20 6c 69 62 72 61 72 79 20 61 73  n the library as
4c90: 73 75 6d 65 73 20 55 54 46 2d 38 20 76 61 72 69  sumes UTF-8 vari
4ca0: 61 62 6c 65 0a 73 69 7a 65 64 20 63 68 61 72 61  able.sized chara
4cb0: 63 74 65 72 73 2e 20 20 54 68 69 73 20 6d 61 6b  cters.  This mak
4cc0: 65 73 20 61 20 64 69 66 66 65 72 65 6e 63 65 20  es a difference 
4cd0: 66 6f 72 20 74 68 65 20 4c 49 4b 45 20 61 6e 64  for the LIKE and
4ce0: 20 47 4c 4f 42 0a 6f 70 65 72 61 74 6f 72 73 20   GLOB.operators 
4cf0: 61 6e 64 20 74 68 65 20 4c 45 4e 47 54 48 28 29  and the LENGTH()
4d00: 20 61 6e 64 20 53 55 42 53 54 52 28 29 20 66 75   and SUBSTR() fu
4d10: 6e 63 74 69 6f 6e 73 2e 20 20 54 68 65 20 73 74  nctions.  The st
4d20: 61 74 69 63 0a 73 74 72 69 6e 67 20 3c 62 3e 73  atic.string <b>s
4d30: 71 6c 69 74 65 5f 65 6e 63 6f 64 69 6e 67 3c 2f  qlite_encoding</
4d40: 62 3e 20 77 69 6c 6c 20 62 65 20 73 65 74 20 74  b> will be set t
4d50: 6f 20 65 69 74 68 65 72 20 22 55 54 46 2d 38 22  o either "UTF-8"
4d60: 20 6f 72 0a 22 69 73 6f 38 38 35 39 22 20 74 6f   or."iso8859" to
4d70: 20 69 6e 64 69 63 61 74 65 20 68 6f 77 20 74 68   indicate how th
4d80: 65 20 6c 69 62 72 61 72 79 20 77 61 73 20 63 6f  e library was co
4d90: 6d 70 69 6c 65 64 2e 20 20 49 6e 20 61 64 64 69  mpiled.  In addi
4da0: 74 69 6f 6e 2c 0a 74 68 65 20 3c 62 3e 73 71 6c  tion,.the <b>sql
4db0: 69 74 65 2e 68 3c 2f 62 3e 20 68 65 61 64 65 72  ite.h</b> header
4dc0: 20 66 69 6c 65 20 77 69 6c 6c 20 64 65 66 69 6e   file will defin
4dd0: 65 20 6f 6e 65 20 6f 66 20 74 68 65 0a 6d 61 63  e one of the.mac
4de0: 72 6f 73 20 3c 62 3e 53 51 4c 49 54 45 5f 55 54  ros <b>SQLITE_UT
4df0: 46 38 3c 2f 62 3e 20 6f 72 20 3c 62 3e 53 51 4c  F8</b> or <b>SQL
4e00: 49 54 45 5f 49 53 4f 38 38 35 39 3c 2f 62 3e 2c  ITE_ISO8859</b>,
4e10: 20 61 73 20 61 70 70 72 6f 70 72 69 61 74 65 2e   as appropriate.
4e20: 3c 2f 70 3e 0a 0a 3c 70 3e 4e 6f 74 65 20 74 68  </p>..<p>Note th
4e30: 61 74 20 74 68 65 20 63 68 61 72 61 63 74 65 72  at the character
4e40: 20 65 6e 63 6f 64 69 6e 67 20 6d 65 63 68 61 6e   encoding mechan
4e50: 69 73 6d 20 75 73 65 64 20 62 79 20 53 51 4c 69  ism used by SQLi
4e60: 74 65 20 63 61 6e 6e 6f 74 0a 62 65 20 63 68 61  te cannot.be cha
4e70: 6e 67 65 64 20 61 74 20 72 75 6e 2d 74 69 6d 65  nged at run-time
4e80: 2e 20 20 54 68 69 73 20 69 73 20 61 20 63 6f 6d  .  This is a com
4e90: 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e  pile-time option
4ea0: 20 6f 6e 6c 79 2e 20 20 54 68 65 0a 3c 62 3e 73   only.  The.<b>s
4eb0: 71 6c 69 74 65 5f 65 6e 63 6f 64 69 6e 67 3c 2f  qlite_encoding</
4ec0: 62 3e 20 63 68 61 72 61 63 74 65 72 20 73 74 72  b> character str
4ed0: 69 6e 67 20 6a 75 73 74 20 74 65 6c 6c 73 20 79  ing just tells y
4ee0: 6f 75 20 68 6f 77 20 74 68 65 20 6c 69 62 72 61  ou how the libra
4ef0: 72 79 0a 77 61 73 20 63 6f 6d 70 69 6c 65 64 2e  ry.was compiled.
4f00: 3c 2f 70 3e 0a 0a 3c 68 32 3e 43 68 61 6e 67 69  </p>..<h2>Changi
4f10: 6e 67 20 74 68 65 20 6c 69 62 72 61 72 79 27 73  ng the library's
4f20: 20 72 65 73 70 6f 6e 73 65 20 74 6f 20 6c 6f 63   response to loc
4f30: 6b 65 64 20 66 69 6c 65 73 3c 2f 68 32 3e 0a 0a  ked files</h2>..
4f40: 3c 70 3e 54 68 65 20 3c 62 3e 73 71 6c 69 74 65  <p>The <b>sqlite
4f50: 5f 62 75 73 79 5f 68 61 6e 64 6c 65 72 28 29 3c  _busy_handler()<
4f60: 2f 62 3e 20 70 72 6f 63 65 64 75 72 65 20 63 61  /b> procedure ca
4f70: 6e 20 62 65 20 75 73 65 64 20 74 6f 20 72 65 67  n be used to reg
4f80: 69 73 74 65 72 0a 61 20 62 75 73 79 20 63 61 6c  ister.a busy cal
4f90: 6c 62 61 63 6b 20 77 69 74 68 20 61 6e 20 6f 70  lback with an op
4fa0: 65 6e 20 53 51 4c 69 74 65 20 64 61 74 61 62 61  en SQLite databa
4fb0: 73 65 2e 20 20 54 68 65 20 62 75 73 79 20 63 61  se.  The busy ca
4fc0: 6c 6c 62 61 63 6b 20 77 69 6c 6c 0a 62 65 20 69  llback will.be i
4fd0: 6e 76 6f 6b 65 64 20 77 68 65 6e 65 76 65 72 20  nvoked whenever 
4fe0: 53 51 4c 69 74 65 20 74 72 69 65 73 20 74 6f 20  SQLite tries to 
4ff0: 61 63 63 65 73 73 20 61 20 64 61 74 61 62 61 73  access a databas
5000: 65 20 74 68 61 74 20 69 73 20 6c 6f 63 6b 65 64  e that is locked
5010: 2e 0a 54 68 65 20 63 61 6c 6c 62 61 63 6b 20 77  ..The callback w
5020: 69 6c 6c 20 74 79 70 69 63 61 6c 6c 79 20 64 6f  ill typically do
5030: 20 73 6f 6d 65 20 6f 74 68 65 72 20 75 73 65 66   some other usef
5040: 75 6c 20 77 6f 72 6b 2c 20 6f 72 20 70 65 72 68  ul work, or perh
5050: 61 70 73 20 73 6c 65 65 70 2c 0a 69 6e 20 6f 72  aps sleep,.in or
5060: 64 65 72 20 74 6f 20 67 69 76 65 20 74 68 65 20  der to give the 
5070: 6c 6f 63 6b 20 61 20 63 68 61 6e 63 65 20 74 6f  lock a chance to
5080: 20 63 6c 65 61 72 2e 20 20 49 66 20 74 68 65 20   clear.  If the 
5090: 63 61 6c 6c 62 61 63 6b 20 72 65 74 75 72 6e 73  callback returns
50a0: 0a 6e 6f 6e 2d 7a 65 72 6f 2c 20 74 68 65 6e 20  .non-zero, then 
50b0: 53 51 4c 69 74 65 20 74 72 69 65 73 20 61 67 61  SQLite tries aga
50c0: 69 6e 20 74 6f 20 61 63 63 65 73 73 20 74 68 65  in to access the
50d0: 20 64 61 74 61 62 61 73 65 20 61 6e 64 20 74 68   database and th
50e0: 65 20 63 79 63 6c 65 0a 72 65 70 65 61 74 73 2e  e cycle.repeats.
50f0: 20 20 49 66 20 74 68 65 20 63 61 6c 6c 62 61 63    If the callbac
5100: 6b 20 72 65 74 75 72 6e 73 20 7a 65 72 6f 2c 20  k returns zero, 
5110: 74 68 65 6e 20 53 51 4c 69 74 65 20 61 62 6f 72  then SQLite abor
5120: 74 73 20 74 68 65 20 63 75 72 72 65 6e 74 0a 6f  ts the current.o
5130: 70 65 72 61 74 69 6f 6e 20 61 6e 64 20 72 65 74  peration and ret
5140: 75 72 6e 73 20 53 51 4c 49 54 45 5f 42 55 53 59  urns SQLITE_BUSY
5150: 2e 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 20 61 72  .</p>..<p>The ar
5160: 67 75 6d 65 6e 74 73 20 74 6f 20 3c 62 3e 73 71  guments to <b>sq
5170: 6c 69 74 65 5f 62 75 73 79 5f 68 61 6e 64 6c 65  lite_busy_handle
5180: 72 28 29 3c 2f 62 3e 20 61 72 65 20 74 68 65 20  r()</b> are the 
5190: 6f 70 61 71 75 65 0a 73 74 72 75 63 74 75 72 65  opaque.structure
51a0: 20 72 65 74 75 72 6e 65 64 20 66 72 6f 6d 20 3c   returned from <
51b0: 62 3e 73 71 6c 69 74 65 5f 6f 70 65 6e 28 29 3c  b>sqlite_open()<
51c0: 2f 62 3e 2c 20 61 20 70 6f 69 6e 74 65 72 20 74  /b>, a pointer t
51d0: 6f 20 74 68 65 20 62 75 73 79 0a 63 61 6c 6c 62  o the busy.callb
51e0: 61 63 6b 20 66 75 6e 63 74 69 6f 6e 2c 20 61 6e  ack function, an
51f0: 64 20 61 20 67 65 6e 65 72 69 63 20 70 6f 69 6e  d a generic poin
5200: 74 65 72 20 74 68 61 74 20 77 69 6c 6c 20 62 65  ter that will be
5210: 20 70 61 73 73 65 64 20 61 73 0a 74 68 65 20 66   passed as.the f
5220: 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f  irst argument to
5230: 20 74 68 65 20 62 75 73 79 20 63 61 6c 6c 62 61   the busy callba
5240: 63 6b 2e 20 20 57 68 65 6e 20 53 51 4c 69 74 65  ck.  When SQLite
5250: 20 69 6e 76 6f 6b 65 73 20 74 68 65 0a 62 75 73   invokes the.bus
5260: 79 20 63 61 6c 6c 62 61 63 6b 2c 20 69 74 20 73  y callback, it s
5270: 65 6e 64 73 20 69 74 20 74 68 72 65 65 20 61 72  ends it three ar
5280: 67 75 6d 65 6e 74 73 3a 20 20 74 68 65 20 67 65  guments:  the ge
5290: 6e 65 72 69 63 20 70 6f 69 6e 74 65 72 0a 74 68  neric pointer.th
52a0: 61 74 20 77 61 73 20 70 61 73 73 65 64 20 69 6e  at was passed in
52b0: 20 61 73 20 74 68 65 20 74 68 69 72 64 20 61 72   as the third ar
52c0: 67 75 6d 65 6e 74 20 74 6f 20 3c 62 3e 73 71 6c  gument to <b>sql
52d0: 69 74 65 5f 62 75 73 79 5f 68 61 6e 64 6c 65 72  ite_busy_handler
52e0: 3c 2f 62 3e 2c 0a 74 68 65 20 6e 61 6d 65 20 6f  </b>,.the name o
52f0: 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20 74  f the database t
5300: 61 62 6c 65 20 6f 72 20 69 6e 64 65 78 20 74 68  able or index th
5310: 61 74 20 74 68 65 20 6c 69 62 72 61 72 79 20 69  at the library i
5320: 73 20 74 72 79 69 6e 67 0a 74 6f 20 61 63 63 65  s trying.to acce
5330: 73 73 2c 20 61 6e 64 20 74 68 65 20 6e 75 6d 62  ss, and the numb
5340: 65 72 20 6f 66 20 74 69 6d 65 73 20 74 68 61 74  er of times that
5350: 20 74 68 65 20 6c 69 62 72 61 72 79 20 68 61 73   the library has
5360: 20 61 74 74 65 6d 70 74 65 64 20 74 6f 0a 61 63   attempted to.ac
5370: 63 65 73 73 20 74 68 65 20 64 61 74 61 62 61 73  cess the databas
5380: 65 20 74 61 62 6c 65 20 6f 72 20 69 6e 64 65 78  e table or index
5390: 2e 3c 2f 70 3e 0a 0a 3c 70 3e 46 6f 72 20 74 68  .</p>..<p>For th
53a0: 65 20 63 6f 6d 6d 6f 6e 20 63 61 73 65 20 77 68  e common case wh
53b0: 65 72 65 20 77 65 20 77 61 6e 74 20 74 68 65 20  ere we want the 
53c0: 62 75 73 79 20 63 61 6c 6c 62 61 63 6b 20 74 6f  busy callback to
53d0: 20 73 6c 65 65 70 2c 0a 74 68 65 20 53 51 4c 69   sleep,.the SQLi
53e0: 74 65 20 6c 69 62 72 61 72 79 20 70 72 6f 76 69  te library provi
53f0: 64 65 73 20 61 20 63 6f 6e 76 65 6e 69 65 6e 63  des a convenienc
5400: 65 20 72 6f 75 74 69 6e 65 20 3c 62 3e 73 71 6c  e routine <b>sql
5410: 69 74 65 5f 62 75 73 79 5f 74 69 6d 65 6f 75 74  ite_busy_timeout
5420: 28 29 3c 2f 62 3e 2e 0a 54 68 65 20 66 69 72 73  ()</b>..The firs
5430: 74 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 3c 62  t argument to <b
5440: 3e 73 71 6c 69 74 65 5f 62 75 73 79 5f 74 69 6d  >sqlite_busy_tim
5450: 65 6f 75 74 28 29 3c 2f 62 3e 20 69 73 20 61 20  eout()</b> is a 
5460: 70 6f 69 6e 74 65 72 20 74 6f 0a 61 6e 20 6f 70  pointer to.an op
5470: 65 6e 20 53 51 4c 69 74 65 20 64 61 74 61 62 61  en SQLite databa
5480: 73 65 20 61 6e 64 20 74 68 65 20 73 65 63 6f 6e  se and the secon
5490: 64 20 61 72 67 75 6d 65 6e 74 20 69 73 20 61 20  d argument is a 
54a0: 6e 75 6d 62 65 72 20 6f 66 20 6d 69 6c 6c 69 73  number of millis
54b0: 65 63 6f 6e 64 73 2e 0a 41 66 74 65 72 20 3c 62  econds..After <b
54c0: 3e 73 71 6c 69 74 65 5f 62 75 73 79 5f 74 69 6d  >sqlite_busy_tim
54d0: 65 6f 75 74 28 29 3c 2f 62 3e 20 68 61 73 20 62  eout()</b> has b
54e0: 65 65 6e 20 65 78 65 63 75 74 65 64 2c 20 74 68  een executed, th
54f0: 65 20 53 51 4c 69 74 65 20 6c 69 62 72 61 72 79  e SQLite library
5500: 0a 77 69 6c 6c 20 77 61 69 74 20 66 6f 72 20 74  .will wait for t
5510: 68 65 20 6c 6f 63 6b 20 74 6f 20 63 6c 65 61 72  he lock to clear
5520: 20 66 6f 72 20 61 74 20 6c 65 61 73 74 20 74 68   for at least th
5530: 65 20 6e 75 6d 62 65 72 20 6f 66 20 6d 69 6c 6c  e number of mill
5540: 69 73 65 63 6f 6e 64 73 20 0a 73 70 65 63 69 66  iseconds .specif
5550: 69 65 64 20 62 65 66 6f 72 65 20 69 74 20 72 65  ied before it re
5560: 74 75 72 6e 73 20 53 51 4c 49 54 45 5f 42 55 53  turns SQLITE_BUS
5570: 59 2e 20 20 53 70 65 63 69 66 79 69 6e 67 20 7a  Y.  Specifying z
5580: 65 72 6f 20 6d 69 6c 6c 69 73 65 63 6f 6e 64 73  ero milliseconds
5590: 20 66 6f 72 0a 74 68 65 20 74 69 6d 65 6f 75 74   for.the timeout
55a0: 20 72 65 73 74 6f 72 65 73 20 74 68 65 20 64 65   restores the de
55b0: 66 61 75 6c 74 20 62 65 68 61 76 69 6f 72 2e 3c  fault behavior.<
55c0: 2f 70 3e 0a 0a 3c 68 32 3e 55 73 69 6e 67 20 74  /p>..<h2>Using t
55d0: 68 65 20 3c 74 74 3e 5f 70 72 69 6e 74 66 28 29  he <tt>_printf()
55e0: 3c 2f 74 74 3e 20 77 72 61 70 70 65 72 20 66 75  </tt> wrapper fu
55f0: 6e 63 74 69 6f 6e 73 3c 2f 68 32 3e 0a 0a 3c 70  nctions</h2>..<p
5600: 3e 54 68 65 20 66 6f 75 72 20 75 74 69 6c 69 74  >The four utilit
5610: 79 20 66 75 6e 63 74 69 6f 6e 73 3c 2f 70 3e 0a  y functions</p>.
5620: 0a 3c 70 3e 0a 3c 75 6c 3e 0a 3c 6c 69 3e 3c 62  .<p>.<ul>.<li><b
5630: 3e 73 71 6c 69 74 65 5f 65 78 65 63 5f 70 72 69  >sqlite_exec_pri
5640: 6e 74 66 28 29 3c 2f 62 3e 3c 2f 6c 69 3e 0a 3c  ntf()</b></li>.<
5650: 6c 69 3e 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65  li><b>sqlite_exe
5660: 63 5f 76 70 72 69 6e 74 66 28 29 3c 2f 62 3e 3c  c_vprintf()</b><
5670: 2f 6c 69 3e 0a 3c 6c 69 3e 3c 62 3e 73 71 6c 69  /li>.<li><b>sqli
5680: 74 65 5f 67 65 74 5f 74 61 62 6c 65 5f 70 72 69  te_get_table_pri
5690: 6e 74 66 28 29 3c 2f 62 3e 3c 2f 6c 69 3e 0a 3c  ntf()</b></li>.<
56a0: 6c 69 3e 3c 62 3e 73 71 6c 69 74 65 5f 67 65 74  li><b>sqlite_get
56b0: 5f 74 61 62 6c 65 5f 76 70 72 69 6e 74 66 28 29  _table_vprintf()
56c0: 3c 2f 62 3e 3c 2f 6c 69 3e 0a 3c 2f 75 6c 3e 0a  </b></li>.</ul>.
56d0: 3c 2f 70 3e 0a 0a 3c 70 3e 69 6d 70 6c 65 6d 65  </p>..<p>impleme
56e0: 6e 74 20 74 68 65 20 73 61 6d 65 20 71 75 65 72  nt the same quer
56f0: 79 20 66 75 6e 63 74 69 6f 6e 61 6c 69 74 79 20  y functionality 
5700: 61 73 20 3c 62 3e 73 71 6c 69 74 65 5f 65 78 65  as <b>sqlite_exe
5710: 63 28 29 3c 2f 62 3e 0a 61 6e 64 20 3c 62 3e 73  c()</b>.and <b>s
5720: 71 6c 69 74 65 5f 67 65 74 5f 74 61 62 6c 65 28  qlite_get_table(
5730: 29 3c 2f 62 3e 2e 20 20 42 75 74 20 69 6e 73 74  )</b>.  But inst
5740: 65 61 64 20 6f 66 20 74 61 6b 69 6e 67 20 61 20  ead of taking a 
5750: 63 6f 6d 70 6c 65 74 65 0a 53 51 4c 20 73 74 61  complete.SQL sta
5760: 74 65 6d 65 6e 74 20 61 73 20 74 68 65 69 72 20  tement as their 
5770: 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 2c  second argument,
5780: 20 74 68 65 20 66 6f 75 72 20 3c 62 3e 5f 70 72   the four <b>_pr
5790: 69 6e 74 66 3c 2f 62 3e 0a 72 6f 75 74 69 6e 65  intf</b>.routine
57a0: 73 20 74 61 6b 65 20 61 20 70 72 69 6e 74 66 2d  s take a printf-
57b0: 73 74 79 6c 65 20 66 6f 72 6d 61 74 20 73 74 72  style format str
57c0: 69 6e 67 2e 20 20 54 68 65 20 53 51 4c 20 73 74  ing.  The SQL st
57d0: 61 74 65 6d 65 6e 74 20 74 6f 0a 62 65 20 65 78  atement to.be ex
57e0: 65 63 75 74 65 64 20 69 73 20 67 65 6e 65 72 61  ecuted is genera
57f0: 74 65 64 20 66 72 6f 6d 20 74 68 69 73 20 66 6f  ted from this fo
5800: 72 6d 61 74 20 73 74 72 69 6e 67 20 61 6e 64 20  rmat string and 
5810: 66 72 6f 6d 20 77 68 61 74 65 76 65 72 0a 61 64  from whatever.ad
5820: 64 69 74 69 6f 6e 61 6c 20 61 72 67 75 6d 65 6e  ditional argumen
5830: 74 73 20 61 72 65 20 61 74 74 61 63 68 65 64 20  ts are attached 
5840: 74 6f 20 74 68 65 20 65 6e 64 20 6f 66 20 74 68  to the end of th
5850: 65 20 66 75 6e 63 74 69 6f 6e 20 63 61 6c 6c 2e  e function call.
5860: 3c 2f 70 3e 0a 0a 3c 70 3e 54 68 65 72 65 20 61  </p>..<p>There a
5870: 72 65 20 74 77 6f 20 61 64 76 61 6e 74 61 67 65  re two advantage
5880: 73 20 74 6f 20 75 73 69 6e 67 20 74 68 65 20 53  s to using the S
5890: 51 4c 69 74 65 20 70 72 69 6e 74 66 0a 66 75 6e  QLite printf.fun
58a0: 63 74 69 6f 6e 73 20 69 6e 73 74 65 61 64 20 6f  ctions instead o
58b0: 66 20 3c 62 3e 73 70 72 69 6e 74 66 28 29 3c 2f  f <b>sprintf()</
58c0: 62 3e 2e 20 20 46 69 72 73 74 20 6f 66 20 61 6c  b>.  First of al
58d0: 6c 2c 20 77 69 74 68 20 74 68 65 0a 53 51 4c 69  l, with the.SQLi
58e0: 74 65 20 70 72 69 6e 74 66 20 72 6f 75 74 69 6e  te printf routin
58f0: 65 73 2c 20 74 68 65 72 65 20 69 73 20 6e 65 76  es, there is nev
5900: 65 72 20 61 20 64 61 6e 67 65 72 20 6f 66 20 6f  er a danger of o
5910: 76 65 72 66 6c 6f 77 69 6e 67 20 61 0a 73 74 61  verflowing a.sta
5920: 74 69 63 20 62 75 66 66 65 72 20 61 73 20 74 68  tic buffer as th
5930: 65 72 65 20 69 73 20 77 69 74 68 20 3c 62 3e 73  ere is with <b>s
5940: 70 72 69 6e 74 66 28 29 3c 2f 62 3e 2e 20 20 54  printf()</b>.  T
5950: 68 65 20 53 51 4c 69 74 65 0a 70 72 69 6e 74 66  he SQLite.printf
5960: 20 72 6f 75 74 69 6e 65 73 20 61 75 74 6f 6d 61   routines automa
5970: 74 69 63 61 6c 6c 79 20 61 6c 6c 6f 63 61 74 65  tically allocate
5980: 20 28 61 6e 64 20 6c 61 74 65 72 20 66 72 65 65   (and later free
5990: 29 0a 61 73 20 6d 75 63 68 20 6d 65 6d 6f 72 79  ).as much memory
59a0: 20 61 73 20 69 73 20 0a 6e 65 63 65 73 73 61 72   as is .necessar
59b0: 79 20 74 6f 20 68 6f 6c 64 20 74 68 65 20 53 51  y to hold the SQ
59c0: 4c 20 73 74 61 74 65 6d 65 6e 74 73 20 67 65 6e  L statements gen
59d0: 65 72 61 74 65 64 2e 3c 2f 70 3e 0a 0a 3c 70 3e  erated.</p>..<p>
59e0: 54 68 65 20 73 65 63 6f 6e 64 20 61 64 76 61 6e  The second advan
59f0: 74 61 67 65 20 74 68 65 20 53 51 4c 69 74 65 20  tage the SQLite 
5a00: 70 72 69 6e 74 66 20 72 6f 75 74 69 6e 65 73 20  printf routines 
5a10: 68 61 76 65 20 6f 76 65 72 0a 3c 62 3e 73 70 72  have over.<b>spr
5a20: 69 6e 74 66 28 29 3c 2f 62 3e 20 69 73 20 61 20  intf()</b> is a 
5a30: 6e 65 77 20 66 6f 72 6d 61 74 74 69 6e 67 20 6f  new formatting o
5a40: 70 74 69 6f 6e 20 73 70 65 63 69 66 69 63 61 6c  ption specifical
5a50: 6c 79 20 64 65 73 69 67 6e 65 64 0a 74 6f 20 73  ly designed.to s
5a60: 75 70 70 6f 72 74 20 73 74 72 69 6e 67 20 6c 69  upport string li
5a70: 74 65 72 61 6c 73 20 69 6e 20 53 51 4c 2e 20 20  terals in SQL.  
5a80: 57 69 74 68 69 6e 20 74 68 65 20 66 6f 72 6d 61  Within the forma
5a90: 74 20 73 74 72 69 6e 67 2c 0a 74 68 65 20 25 71  t string,.the %q
5aa0: 20 66 6f 72 6d 61 74 74 69 6e 67 20 6f 70 74 69   formatting opti
5ab0: 6f 6e 20 77 6f 72 6b 73 20 76 65 72 79 20 6d 75  on works very mu
5ac0: 63 68 20 6c 69 6b 65 20 25 73 20 69 6e 20 74 68  ch like %s in th
5ad0: 61 74 20 69 74 0a 72 65 61 64 73 20 61 20 6e 75  at it.reads a nu
5ae0: 6c 6c 2d 74 65 72 6d 69 6e 61 74 65 64 20 73 74  ll-terminated st
5af0: 72 69 6e 67 20 66 72 6f 6d 20 74 68 65 20 61 72  ring from the ar
5b00: 67 75 6d 65 6e 74 20 6c 69 73 74 20 61 6e 64 20  gument list and 
5b10: 69 6e 73 65 72 74 73 0a 69 74 20 69 6e 74 6f 20  inserts.it into 
5b20: 74 68 65 20 72 65 73 75 6c 74 2e 20 20 42 75 74  the result.  But
5b30: 20 25 71 20 74 72 61 6e 73 6c 61 74 65 73 20 74   %q translates t
5b40: 68 65 20 69 6e 73 65 72 74 65 64 20 73 74 72 69  he inserted stri
5b50: 6e 67 20 62 79 0a 6d 61 6b 69 6e 67 20 74 77 6f  ng by.making two
5b60: 20 63 6f 70 69 65 73 20 6f 66 20 65 76 65 72 79   copies of every
5b70: 20 73 69 6e 67 6c 65 2d 71 75 6f 74 65 20 28 27   single-quote ('
5b80: 29 20 63 68 61 72 61 63 74 65 72 20 69 6e 20 74  ) character in t
5b90: 68 65 0a 73 75 62 73 74 69 74 75 74 65 64 20 73  he.substituted s
5ba0: 74 72 69 6e 67 2e 20 20 54 68 69 73 20 68 61 73  tring.  This has
5bb0: 20 74 68 65 20 65 66 66 65 63 74 20 6f 66 20 65   the effect of e
5bc0: 73 63 61 70 69 6e 67 20 74 68 65 20 65 6e 64 2d  scaping the end-
5bd0: 6f 66 2d 73 74 72 69 6e 67 0a 6d 65 61 6e 69 6e  of-string.meanin
5be0: 67 20 6f 66 20 73 69 6e 67 6c 65 2d 71 75 6f 74  g of single-quot
5bf0: 65 20 77 69 74 68 69 6e 20 61 20 73 74 72 69 6e  e within a strin
5c00: 67 20 6c 69 74 65 72 61 6c 2e 0a 3c 2f 70 3e 0a  g literal..</p>.
5c10: 0a 3c 70 3e 43 6f 6e 73 69 64 65 72 20 61 6e 20  .<p>Consider an 
5c20: 65 78 61 6d 70 6c 65 2e 20 20 53 75 70 70 6f 73  example.  Suppos
5c30: 65 20 79 6f 75 20 61 72 65 20 74 72 79 69 6e 67  e you are trying
5c40: 20 74 6f 20 69 6e 73 65 72 74 20 61 20 73 74 72   to insert a str
5c50: 69 6e 67 0a 76 61 6c 75 65 20 69 6e 74 6f 20 61  ing.value into a
5c60: 20 64 61 74 61 62 61 73 65 20 74 61 62 6c 65 20   database table 
5c70: 77 68 65 72 65 20 74 68 65 20 73 74 72 69 6e 67  where the string
5c80: 20 76 61 6c 75 65 20 77 61 73 20 6f 62 74 61 69   value was obtai
5c90: 6e 65 64 20 66 72 6f 6d 0a 75 73 65 72 20 69 6e  ned from.user in
5ca0: 70 75 74 2e 20 20 53 75 70 70 6f 73 65 20 74 68  put.  Suppose th
5cb0: 65 20 73 74 72 69 6e 67 20 74 6f 20 62 65 20 69  e string to be i
5cc0: 6e 73 65 72 74 65 64 20 69 73 20 73 74 6f 72 65  nserted is store
5cd0: 64 20 69 6e 20 61 20 76 61 72 69 61 62 6c 65 0a  d in a variable.
5ce0: 6e 61 6d 65 64 20 7a 53 74 72 69 6e 67 2e 20 20  named zString.  
5cf0: 54 68 65 20 63 6f 64 65 20 74 6f 20 64 6f 20 74  The code to do t
5d00: 68 65 20 69 6e 73 65 72 74 69 6f 6e 20 6d 69 67  he insertion mig
5d10: 68 74 20 6c 6f 6f 6b 20 6c 69 6b 65 20 74 68 69  ht look like thi
5d20: 73 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75  s:</p>..<blockqu
5d30: 6f 74 65 3e 3c 70 72 65 3e 0a 73 71 6c 69 74 65  ote><pre>.sqlite
5d40: 5f 65 78 65 63 5f 70 72 69 6e 74 66 28 64 62 2c  _exec_printf(db,
5d50: 0a 20 20 22 49 4e 53 45 52 54 20 49 4e 54 4f 20  .  "INSERT INTO 
5d60: 74 61 62 6c 65 31 20 56 41 4c 55 45 53 28 27 25  table1 VALUES('%
5d70: 73 27 29 22 2c 0a 20 20 30 2c 20 30 2c 20 30 2c  s')",.  0, 0, 0,
5d80: 20 7a 53 74 72 69 6e 67 29 3b 0a 3c 2f 70 72 65   zString);.</pre
5d90: 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 0a  ></blockquote>..
5da0: 3c 70 3e 49 66 20 74 68 65 20 7a 53 74 72 69 6e  <p>If the zStrin
5db0: 67 20 76 61 72 69 61 62 6c 65 20 68 6f 6c 64 73  g variable holds
5dc0: 20 74 65 78 74 20 6c 69 6b 65 20 22 48 65 6c 6c   text like "Hell
5dd0: 6f 22 2c 20 74 68 65 6e 20 74 68 69 73 20 73 74  o", then this st
5de0: 61 74 65 6d 65 6e 74 0a 77 69 6c 6c 20 77 6f 72  atement.will wor
5df0: 6b 20 6a 75 73 74 20 66 69 6e 65 2e 20 20 42 75  k just fine.  Bu
5e00: 74 20 73 75 70 70 6f 73 65 20 74 68 65 20 75 73  t suppose the us
5e10: 65 72 20 65 6e 74 65 72 73 20 61 20 73 74 72 69  er enters a stri
5e20: 6e 67 20 6c 69 6b 65 20 0a 22 48 69 20 79 27 61  ng like ."Hi y'a
5e30: 6c 6c 21 22 2e 20 20 54 68 65 20 53 51 4c 20 73  ll!".  The SQL s
5e40: 74 61 74 65 6d 65 6e 74 20 67 65 6e 65 72 61 74  tatement generat
5e50: 65 64 20 72 65 61 64 73 20 61 73 20 66 6f 6c 6c  ed reads as foll
5e60: 6f 77 73 3a 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74  ows:..<blockquot
5e70: 65 3e 3c 70 72 65 3e 0a 49 4e 53 45 52 54 20 49  e><pre>.INSERT I
5e80: 4e 54 4f 20 74 61 62 6c 65 31 20 56 41 4c 55 45  NTO table1 VALUE
5e90: 53 28 27 48 69 20 79 27 61 6c 6c 27 29 0a 3c 2f  S('Hi y'all').</
5ea0: 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65  pre></blockquote
5eb0: 3e 0a 0a 3c 70 3e 54 68 69 73 20 69 73 20 6e 6f  >..<p>This is no
5ec0: 74 20 76 61 6c 69 64 20 53 51 4c 20 62 65 63 61  t valid SQL beca
5ed0: 75 73 65 20 6f 66 20 74 68 65 20 61 70 6f 73 74  use of the apost
5ee0: 72 6f 70 68 79 20 69 6e 20 74 68 65 20 77 6f 72  rophy in the wor
5ef0: 64 20 22 79 27 61 6c 6c 22 2e 0a 42 75 74 20 69  d "y'all"..But i
5f00: 66 20 74 68 65 20 25 71 20 66 6f 72 6d 61 74 74  f the %q formatt
5f10: 69 6e 67 20 6f 70 74 69 6f 6e 20 69 73 20 75 73  ing option is us
5f20: 65 64 20 69 6e 73 74 65 61 64 20 6f 66 20 25 73  ed instead of %s
5f30: 2c 20 6c 69 6b 65 20 74 68 69 73 3a 3c 2f 70 3e  , like this:</p>
5f40: 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70  ..<blockquote><p
5f50: 72 65 3e 0a 73 71 6c 69 74 65 5f 65 78 65 63 5f  re>.sqlite_exec_
5f60: 70 72 69 6e 74 66 28 64 62 2c 0a 20 20 22 49 4e  printf(db,.  "IN
5f70: 53 45 52 54 20 49 4e 54 4f 20 74 61 62 6c 65 31  SERT INTO table1
5f80: 20 56 41 4c 55 45 53 28 27 25 71 27 29 22 2c 0a   VALUES('%q')",.
5f90: 20 20 30 2c 20 30 2c 20 30 2c 20 7a 53 74 72 69    0, 0, 0, zStri
5fa0: 6e 67 29 3b 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f  ng);.</pre></blo
5fb0: 63 6b 71 75 6f 74 65 3e 0a 0a 3c 70 3e 54 68 65  ckquote>..<p>The
5fc0: 6e 20 74 68 65 20 67 65 6e 65 72 61 74 65 64 20  n the generated 
5fd0: 53 51 4c 20 77 69 6c 6c 20 6c 6f 6f 6b 20 6c 69  SQL will look li
5fe0: 6b 65 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67  ke the following
5ff0: 3a 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 75 6f  :</p>..<blockquo
6000: 74 65 3e 3c 70 72 65 3e 0a 49 4e 53 45 52 54 20  te><pre>.INSERT 
6010: 49 4e 54 4f 20 74 61 62 6c 65 31 20 56 41 4c 55  INTO table1 VALU
6020: 45 53 28 27 48 69 20 79 27 27 61 6c 6c 27 29 0a  ES('Hi y''all').
6030: 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f  </pre></blockquo
6040: 74 65 3e 0a 0a 3c 70 3e 48 65 72 65 20 74 68 65  te>..<p>Here the
6050: 20 61 70 6f 73 74 72 6f 70 68 79 20 68 61 73 20   apostrophy has 
6060: 62 65 65 6e 20 65 73 63 61 70 65 64 20 61 6e 64  been escaped and
6070: 20 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d 65   the SQL stateme
6080: 6e 74 20 69 73 20 77 65 6c 6c 2d 66 6f 72 6d 65  nt is well-forme
6090: 64 2e 0a 57 68 65 6e 20 67 65 6e 65 72 61 74 69  d..When generati
60a0: 6e 67 20 53 51 4c 20 6f 6e 2d 74 68 65 2d 66 6c  ng SQL on-the-fl
60b0: 79 20 66 72 6f 6d 20 64 61 74 61 20 74 68 61 74  y from data that
60c0: 20 6d 69 67 68 74 20 63 6f 6e 74 61 69 6e 20 61   might contain a
60d0: 0a 73 69 6e 67 6c 65 2d 71 75 6f 74 65 20 63 68  .single-quote ch
60e0: 61 72 61 63 74 65 72 20 28 27 29 2c 20 69 74 20  aracter ('), it 
60f0: 69 73 20 61 6c 77 61 79 73 20 61 20 67 6f 6f 64  is always a good
6100: 20 69 64 65 61 20 74 6f 20 75 73 65 20 74 68 65   idea to use the
6110: 0a 53 51 4c 69 74 65 20 70 72 69 6e 74 66 20 72  .SQLite printf r
6120: 6f 75 74 69 6e 65 73 20 61 6e 64 20 74 68 65 20  outines and the 
6130: 25 71 20 66 6f 72 6d 61 74 74 69 6e 67 20 6f 70  %q formatting op
6140: 74 69 6f 6e 20 69 6e 73 74 65 61 64 20 6f 66 20  tion instead of 
6150: 3c 62 3e 73 70 72 69 6e 74 66 3c 2f 62 3e 2e 0a  <b>sprintf</b>..
6160: 3c 2f 70 3e 0a 0a 3c 68 32 3e 55 73 61 67 65 20  </p>..<h2>Usage 
6170: 45 78 61 6d 70 6c 65 73 3c 2f 68 32 3e 0a 0a 3c  Examples</h2>..<
6180: 70 3e 46 6f 72 20 65 78 61 6d 70 6c 65 73 20 6f  p>For examples o
6190: 66 20 68 6f 77 20 74 68 65 20 53 51 4c 69 74 65  f how the SQLite
61a0: 20 43 2f 43 2b 2b 20 69 6e 74 65 72 66 61 63 65   C/C++ interface
61b0: 20 63 61 6e 20 62 65 20 75 73 65 64 2c 0a 72 65   can be used,.re
61c0: 66 65 72 20 74 6f 20 74 68 65 20 73 6f 75 72 63  fer to the sourc
61d0: 65 20 63 6f 64 65 20 66 6f 72 20 74 68 65 20 3c  e code for the <
61e0: 62 3e 73 71 6c 69 74 65 3c 2f 62 3e 20 70 72 6f  b>sqlite</b> pro
61f0: 67 72 61 6d 20 69 6e 20 74 68 65 0a 66 69 6c 65  gram in the.file
6200: 20 3c 62 3e 73 72 63 2f 73 68 65 6c 6c 2e 63 3c   <b>src/shell.c<
6210: 2f 62 3e 20 6f 66 20 74 68 65 20 73 6f 75 72 63  /b> of the sourc
6220: 65 20 74 72 65 65 2e 0a 41 64 64 69 74 69 6f 6e  e tree..Addition
6230: 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 61  al information a
6240: 62 6f 75 74 20 73 71 6c 69 74 65 20 69 73 20 61  bout sqlite is a
6250: 76 61 69 6c 61 62 6c 65 20 61 74 0a 3c 61 20 68  vailable at.<a h
6260: 72 65 66 3d 22 73 71 6c 69 74 65 2e 68 74 6d 6c  ref="sqlite.html
6270: 22 3e 73 71 6c 69 74 65 2e 68 74 6d 6c 3c 2f 61  ">sqlite.html</a
6280: 3e 2e 0a 53 65 65 20 61 6c 73 6f 20 74 68 65 20  >..See also the 
6290: 73 6f 75 72 63 65 73 20 74 6f 20 74 68 65 20 54  sources to the T
62a0: 63 6c 20 69 6e 74 65 72 66 61 63 65 20 66 6f 72  cl interface for
62b0: 20 53 51 4c 69 74 65 20 69 6e 0a 74 68 65 20 73   SQLite in.the s
62c0: 6f 75 72 63 65 20 66 69 6c 65 20 3c 62 3e 73 72  ource file <b>sr
62d0: 63 2f 74 63 6c 73 71 6c 69 74 65 2e 63 3c 2f 62  c/tclsqlite.c</b
62e0: 3e 2e 3c 2f 70 3e 0a 7d 0a 0a 70 75 74 73 20 7b  >.</p>.}..puts {
62f0: 0a 3c 70 3e 3c 68 72 20 2f 3e 3c 2f 70 3e 0a 3c  .<p><hr /></p>.<
6300: 70 3e 3c 61 20 68 72 65 66 3d 22 69 6e 64 65 78  p><a href="index
6310: 2e 68 74 6d 6c 22 3e 3c 69 6d 67 20 73 72 63 3d  .html"><img src=
6320: 22 2f 67 6f 62 61 63 6b 2e 6a 70 67 22 20 62 6f  "/goback.jpg" bo
6330: 72 64 65 72 3d 30 20 2f 3e 0a 42 61 63 6b 20 74  rder=0 />.Back t
6340: 6f 20 74 68 65 20 53 51 4c 69 74 65 20 48 6f 6d  o the SQLite Hom
6350: 65 20 50 61 67 65 3c 2f 61 3e 0a 3c 2f 70 3e 0a  e Page</a>.</p>.
6360: 0a 3c 2f 62 6f 64 79 3e 3c 2f 68 74 6d 6c 3e 7d  .</body></html>}
6370: 0a                                               .