Documentation Source Text

Hex Artifact Content
Login

Artifact 03e18ffd46366310e47a8e10d6bdf93bdb4966cb:


0000: 3c 74 69 74 6c 65 3e 41 6e 20 49 6e 74 72 6f 64  <title>An Introd
0010: 75 63 74 69 6f 6e 20 54 6f 20 54 68 65 20 53 51  uction To The SQ
0020: 4c 69 74 65 20 43 2f 43 2b 2b 20 49 6e 74 65 72  Lite C/C++ Inter
0030: 66 61 63 65 3c 2f 74 69 74 6c 65 3e 0a 3c 74 63  face</title>.<tc
0040: 6c 3e 0a 70 72 6f 63 20 43 4f 44 45 20 7b 74 65  l>.proc CODE {te
0050: 78 74 7d 20 7b 0a 20 20 68 64 5f 70 75 74 73 20  xt} {.  hd_puts 
0060: 22 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72  "<blockquote><pr
0070: 65 3e 22 0a 20 20 68 64 5f 70 75 74 73 20 24 74  e>".  hd_puts $t
0080: 65 78 74 0a 20 20 68 64 5f 70 75 74 73 20 22 3c  ext.  hd_puts "<
0090: 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74  /pre></blockquot
00a0: 65 3e 22 0a 7d 0a 70 72 6f 63 20 50 41 52 41 47  e>".}.proc PARAG
00b0: 52 41 50 48 20 7b 74 65 78 74 7d 20 7b 0a 20 20  RAPH {text} {.  
00c0: 68 64 5f 72 65 73 6f 6c 76 65 20 3c 70 3e 24 74  hd_resolve <p>$t
00d0: 65 78 74 3c 2f 70 3e 5c 6e 0a 7d 0a 73 65 74 20  ext</p>\n.}.set 
00e0: 6c 65 76 65 6c 28 30 29 20 30 0a 73 65 74 20 6c  level(0) 0.set l
00f0: 65 76 65 6c 28 31 29 20 30 0a 70 72 6f 63 20 48  evel(1) 0.proc H
0100: 45 41 44 49 4e 47 20 7b 6e 20 6e 61 6d 65 20 7b  EADING {n name {
0110: 74 61 67 20 7b 7d 7d 7d 20 7b 0a 20 20 69 66 20  tag {}}} {.  if 
0120: 7b 24 74 61 67 21 3d 22 22 7d 20 7b 0a 20 20 20  {$tag!=""} {.   
0130: 20 68 64 5f 66 72 61 67 6d 65 6e 74 20 24 74 61   hd_fragment $ta
0140: 67 0a 20 20 7d 0a 20 20 67 6c 6f 62 61 6c 20 6c  g.  }.  global l
0150: 65 76 65 6c 0a 20 20 69 6e 63 72 20 6c 65 76 65  evel.  incr leve
0160: 6c 28 24 6e 29 0a 20 20 66 6f 72 20 7b 73 65 74  l($n).  for {set
0170: 20 69 20 5b 65 78 70 72 20 7b 24 6e 2b 31 7d 5d   i [expr {$n+1}]
0180: 7d 20 7b 24 69 3c 31 30 7d 20 7b 69 6e 63 72 20  } {$i<10} {incr 
0190: 69 7d 20 7b 0a 20 20 20 20 73 65 74 20 6c 65 76  i} {.    set lev
01a0: 65 6c 28 24 69 29 20 30 0a 20 20 7d 0a 20 20 69  el($i) 0.  }.  i
01b0: 66 20 7b 24 6e 3d 3d 30 7d 20 7b 0a 20 20 20 20  f {$n==0} {.    
01c0: 68 64 5f 70 75 74 73 20 22 3c 68 31 20 61 6c 69  hd_puts "<h1 ali
01d0: 67 6e 3d 63 65 6e 74 65 72 3e 24 6e 61 6d 65 3c  gn=center>$name<
01e0: 2f 68 31 3e 22 0a 20 20 20 20 72 65 74 75 72 6e  /h1>".    return
01f0: 0a 20 20 7d 20 65 6c 73 65 69 66 20 7b 24 6e 3d  .  } elseif {$n=
0200: 3d 31 7d 20 7b 0a 20 20 20 20 73 65 74 20 6e 75  =1} {.    set nu
0210: 6d 20 24 6c 65 76 65 6c 28 31 29 2e 30 0a 20 20  m $level(1).0.  
0220: 7d 20 65 6c 73 65 20 7b 0a 20 20 20 20 73 65 74  } else {.    set
0230: 20 6e 75 6d 20 24 6c 65 76 65 6c 28 31 29 0a 20   num $level(1). 
0240: 20 20 20 66 6f 72 20 7b 73 65 74 20 69 20 32 7d     for {set i 2}
0250: 20 7b 24 69 3c 3d 24 6e 7d 20 7b 69 6e 63 72 20   {$i<=$n} {incr 
0260: 69 7d 20 7b 0a 20 20 20 20 20 20 61 70 70 65 6e  i} {.      appen
0270: 64 20 6e 75 6d 20 2e 24 6c 65 76 65 6c 28 24 69  d num .$level($i
0280: 29 0a 20 20 20 20 7d 0a 20 20 7d 0a 20 20 69 6e  ).    }.  }.  in
0290: 63 72 20 6e 20 31 0a 20 20 68 64 5f 70 75 74 73  cr n 1.  hd_puts
02a0: 20 22 3c 68 24 6e 3e 24 6e 75 6d 20 24 6e 61 6d   "<h$n>$num $nam
02b0: 65 3c 2f 68 24 6e 3e 22 0a 7d 0a 0a 68 64 5f 6b  e</h$n>".}..hd_k
02c0: 65 79 77 6f 72 64 73 20 7b 2a 63 69 6e 74 72 6f  eywords {*cintro
02d0: 7d 0a 48 45 41 44 49 4e 47 20 30 20 7b 41 6e 20  }.HEADING 0 {An 
02e0: 49 6e 74 72 6f 64 75 63 74 69 6f 6e 20 54 6f 20  Introduction To 
02f0: 54 68 65 20 53 51 4c 69 74 65 20 43 2f 43 2b 2b  The SQLite C/C++
0300: 20 49 6e 74 65 72 66 61 63 65 7d 0a 3c 2f 74 63   Interface}.</tc
0310: 6c 3e 0a 0a 3c 70 3e 0a 20 20 54 68 69 73 20 61  l>..<p>.  This a
0320: 72 74 69 63 6c 65 20 70 72 6f 76 69 64 65 73 20  rticle provides 
0330: 61 6e 20 6f 76 65 72 76 69 65 77 20 61 6e 64 20  an overview and 
0340: 72 6f 61 64 6d 61 70 20 74 6f 20 74 68 65 20 43  roadmap to the C
0350: 2f 43 2b 2b 20 69 6e 74 65 72 66 61 63 65 0a 20  /C++ interface. 
0360: 20 74 6f 20 53 51 4c 69 74 65 2e 0a 3c 2f 70 3e   to SQLite..</p>
0370: 0a 0a 3c 70 3e 0a 20 20 45 61 72 6c 79 20 76 65  ..<p>.  Early ve
0380: 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74 65  rsions of SQLite
0390: 20 77 65 72 65 20 76 65 72 79 20 65 61 73 79 20   were very easy 
03a0: 74 6f 20 6c 65 61 72 6e 20 73 69 6e 63 65 20 74  to learn since t
03b0: 68 65 79 20 6f 6e 6c 79 0a 20 20 73 75 70 70 6f  hey only.  suppo
03c0: 72 74 65 64 20 35 20 43 2f 43 2b 2b 20 69 6e 74  rted 5 C/C++ int
03d0: 65 72 66 61 63 65 73 2e 20 20 42 75 74 20 61 73  erfaces.  But as
03e0: 20 53 51 4c 69 74 65 20 68 61 73 20 67 72 6f 77   SQLite has grow
03f0: 6e 20 69 6e 20 63 61 70 61 62 69 6c 69 74 79 2c  n in capability,
0400: 0a 20 20 6e 65 77 20 43 2f 43 2b 2b 20 69 6e 74  .  new C/C++ int
0410: 65 72 66 61 63 65 73 20 68 61 76 65 20 62 65 65  erfaces have bee
0420: 6e 20 61 64 64 65 64 20 73 6f 20 74 68 61 74 20  n added so that 
0430: 6e 6f 77 20 74 68 65 72 65 0a 20 20 61 72 65 20  now there.  are 
0440: 6f 76 65 72 20 31 38 35 20 64 69 73 74 69 6e 63  over 185 distinc
0450: 74 20 41 50 49 73 2e 20 20 54 68 69 73 20 63 61  t APIs.  This ca
0460: 6e 20 62 65 20 6f 76 65 72 77 68 65 6c 6d 69 6e  n be overwhelmin
0470: 67 20 74 6f 20 61 20 6e 65 77 20 70 72 6f 67 72  g to a new progr
0480: 61 6d 6d 65 72 2e 0a 20 20 46 6f 72 74 75 6e 61  ammer..  Fortuna
0490: 74 65 6c 79 2c 20 6d 6f 73 74 20 6f 66 20 74 68  tely, most of th
04a0: 65 20 43 2f 43 2b 2b 20 69 6e 74 65 72 66 61 63  e C/C++ interfac
04b0: 65 73 20 69 6e 20 53 51 4c 69 74 65 20 61 72 65  es in SQLite are
04c0: 20 76 65 72 79 20 73 70 65 63 69 61 6c 69 7a 65   very specialize
04d0: 64 0a 20 20 61 6e 64 20 6e 65 76 65 72 20 6e 65  d.  and never ne
04e0: 65 64 20 74 6f 20 62 65 20 75 73 65 64 2e 20 20  ed to be used.  
04f0: 44 65 73 70 69 74 65 20 68 61 76 69 6e 67 20 73  Despite having s
0500: 6f 20 6d 61 6e 79 0a 20 20 65 6e 74 72 79 20 70  o many.  entry p
0510: 6f 69 6e 74 73 2c 20 74 68 65 20 63 6f 72 65 20  oints, the core 
0520: 41 50 49 20 69 73 20 73 74 69 6c 6c 20 72 65 6c  API is still rel
0530: 61 74 69 76 65 6c 79 20 73 69 6d 70 6c 65 20 61  atively simple a
0540: 6e 64 20 65 61 73 79 20 74 6f 20 63 6f 64 65 20  nd easy to code 
0550: 74 6f 2e 0a 20 20 54 68 69 73 20 61 72 74 69 63  to..  This artic
0560: 6c 65 20 61 69 6d 73 20 74 6f 20 70 72 6f 76 69  le aims to provi
0570: 64 65 20 61 6c 6c 20 6f 66 20 74 68 65 20 62 61  de all of the ba
0580: 63 6b 67 72 6f 75 6e 64 20 69 6e 66 6f 72 6d 61  ckground informa
0590: 74 69 6f 6e 20 6e 65 65 64 65 64 20 74 6f 0a 20  tion needed to. 
05a0: 20 65 61 73 69 6c 79 20 75 6e 64 65 72 73 74 61   easily understa
05b0: 6e 64 20 68 6f 77 20 53 51 4c 69 74 65 20 77 6f  nd how SQLite wo
05c0: 72 6b 73 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 20  rks..</p>..<p>. 
05d0: 20 41 20 73 65 70 61 72 61 74 65 20 64 6f 63 75   A separate docu
05e0: 6d 65 6e 74 2c 20 5b 63 61 70 69 33 72 65 66 20  ment, [capi3ref 
05f0: 7c 20 54 68 65 20 53 51 4c 69 74 65 20 43 2f 43  | The SQLite C/C
0600: 2b 2b 20 49 6e 74 65 72 66 61 63 65 5d 2c 0a 20  ++ Interface],. 
0610: 20 70 72 6f 76 69 64 65 73 20 64 65 74 61 69 6c   provides detail
0620: 65 64 0a 20 20 73 70 65 63 69 66 69 63 61 74 69  ed.  specificati
0630: 6f 6e 73 20 66 6f 72 20 61 6c 6c 20 6f 66 20 74  ons for all of t
0640: 68 65 20 76 61 72 69 6f 75 73 20 43 2f 43 2b 2b  he various C/C++
0650: 20 41 50 49 73 20 66 6f 72 20 53 51 4c 69 74 65   APIs for SQLite
0660: 2e 20 20 4f 6e 63 65 0a 20 20 74 68 65 20 72 65  .  Once.  the re
0670: 61 64 65 72 0a 20 20 75 6e 64 65 72 73 74 61 6e  ader.  understan
0680: 64 73 20 74 68 65 20 62 61 73 69 63 20 70 72 69  ds the basic pri
0690: 6e 63 69 70 6c 65 73 20 6f 66 20 6f 70 65 72 61  nciples of opera
06a0: 74 69 6f 6e 20 66 6f 72 20 53 51 4c 69 74 65 2c  tion for SQLite,
06b0: 20 0a 20 20 5b 63 61 70 69 33 72 65 66 20 7c 20   .  [capi3ref | 
06c0: 74 68 61 74 20 64 6f 63 75 6d 65 6e 74 5d 20 73  that document] s
06d0: 68 6f 75 6c 64 20 62 65 20 75 73 65 64 20 61 73  hould be used as
06e0: 20 61 20 72 65 66 65 72 65 6e 63 65 0a 20 20 67   a reference.  g
06f0: 75 69 64 65 2e 20 20 54 68 69 73 20 61 72 74 69  uide.  This arti
0700: 63 6c 65 20 69 73 20 69 6e 74 65 6e 64 65 64 20  cle is intended 
0710: 61 73 20 69 6e 74 72 6f 64 75 63 74 69 6f 6e 20  as introduction 
0720: 6f 6e 6c 79 20 61 6e 64 20 69 73 20 6e 65 69 74  only and is neit
0730: 68 65 72 20 61 0a 20 20 63 6f 6d 70 6c 65 74 65  her a.  complete
0740: 20 6e 6f 72 20 61 75 74 68 6f 72 69 74 61 74 69   nor authoritati
0750: 76 65 20 72 65 66 65 72 65 6e 63 65 20 66 6f 72  ve reference for
0760: 20 74 68 65 20 53 51 4c 69 74 65 20 41 50 49 2e   the SQLite API.
0770: 0a 3c 2f 70 3e 0a 0a 3c 74 63 6c 3e 48 45 41 44  .</p>..<tcl>HEAD
0780: 49 4e 47 20 31 20 7b 43 6f 72 65 20 4f 62 6a 65  ING 1 {Core Obje
0790: 63 74 73 20 41 6e 64 20 49 6e 74 65 72 66 61 63  cts And Interfac
07a0: 65 73 7d 3c 2f 74 63 6c 3e 0a 0a 3c 70 3e 0a 20  es}</tcl>..<p>. 
07b0: 20 54 68 65 20 70 72 69 6e 63 69 70 61 6c 20 74   The principal t
07c0: 61 73 6b 20 6f 66 20 61 6e 20 53 51 4c 20 64 61  ask of an SQL da
07d0: 74 61 62 61 73 65 20 65 6e 67 69 6e 65 20 69 73  tabase engine is
07e0: 20 74 6f 20 65 76 61 6c 75 61 74 65 20 73 74 61   to evaluate sta
07f0: 74 65 6d 65 6e 74 73 0a 20 20 6f 66 20 53 51 4c  tements.  of SQL
0800: 2e 20 20 49 6e 20 6f 72 64 65 72 20 74 6f 20 61  .  In order to a
0810: 63 63 6f 6d 70 6c 69 73 68 20 74 68 69 73 20 70  ccomplish this p
0820: 75 72 70 6f 73 65 2c 20 74 68 65 20 64 65 76 65  urpose, the deve
0830: 6c 6f 70 65 72 20 6e 65 65 64 73 0a 20 20 74 6f  loper needs.  to
0840: 20 6b 6e 6f 77 20 61 62 6f 75 74 20 74 77 6f 20   know about two 
0850: 6f 62 6a 65 63 74 73 3a 0a 3c 2f 70 3e 0a 0a 3c  objects:.</p>..<
0860: 70 3e 3c 75 6c 3e 0a 20 20 3c 6c 69 3e 20 54 68  p><ul>.  <li> Th
0870: 65 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  e [database conn
0880: 65 63 74 69 6f 6e 5d 20 6f 62 6a 65 63 74 3a 20  ection] object: 
0890: 73 71 6c 69 74 65 33 20 3c 2f 6c 69 3e 0a 20 20  sqlite3 </li>.  
08a0: 3c 6c 69 3e 20 54 68 65 20 5b 70 72 65 70 61 72  <li> The [prepar
08b0: 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 6f 62  ed statement] ob
08c0: 6a 65 63 74 3a 20 73 71 6c 69 74 65 33 5f 73 74  ject: sqlite3_st
08d0: 6d 74 20 3c 2f 6c 69 3e 0a 3c 2f 75 6c 3e 3c 2f  mt </li>.</ul></
08e0: 70 3e 0a 0a 3c 70 3e 0a 20 20 53 74 72 69 63 74  p>..<p>.  Strict
08f0: 6c 79 20 73 70 65 61 6b 69 6e 67 2c 20 74 68 65  ly speaking, the
0900: 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65   [prepared state
0910: 6d 65 6e 74 5d 20 6f 62 6a 65 63 74 20 69 73 20  ment] object is 
0920: 6e 6f 74 20 72 65 71 75 69 72 65 64 20 73 69 6e  not required sin
0930: 63 65 0a 20 20 74 68 65 20 63 6f 6e 76 65 6e 69  ce.  the conveni
0940: 65 6e 63 65 20 77 72 61 70 70 65 72 20 69 6e 74  ence wrapper int
0950: 65 72 66 61 63 65 73 2c 20 5b 73 71 6c 69 74 65  erfaces, [sqlite
0960: 33 5f 65 78 65 63 5d 20 6f 72 0a 20 20 5b 73 71  3_exec] or.  [sq
0970: 6c 69 74 65 33 5f 67 65 74 5f 74 61 62 6c 65 5d  lite3_get_table]
0980: 2c 20 63 61 6e 20 62 65 20 75 73 65 64 20 61 6e  , can be used an
0990: 64 20 74 68 65 73 65 20 63 6f 6e 76 65 6e 69 65  d these convenie
09a0: 6e 63 65 20 77 72 61 70 70 65 72 73 0a 20 20 65  nce wrappers.  e
09b0: 6e 63 61 70 73 75 6c 61 74 65 20 61 6e 64 20 68  ncapsulate and h
09c0: 69 64 65 20 74 68 65 20 5b 70 72 65 70 61 72 65  ide the [prepare
09d0: 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 6f 62 6a  d statement] obj
09e0: 65 63 74 2e 0a 20 20 4e 65 76 65 72 74 68 65 6c  ect..  Neverthel
09f0: 65 73 73 2c 20 61 6e 20 75 6e 64 65 72 73 74 61  ess, an understa
0a00: 6e 64 69 6e 67 20 6f 66 0a 20 20 5b 70 72 65 70  nding of.  [prep
0a10: 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 73 5d  ared statements]
0a20: 20 69 73 20 6e 65 65 64 65 64 20 74 6f 20 6d 61   is needed to ma
0a30: 6b 65 20 66 75 6c 6c 20 75 73 65 20 6f 66 20 53  ke full use of S
0a40: 51 4c 69 74 65 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e  QLite..</p>..<p>
0a50: 0a 20 20 54 68 65 20 5b 64 61 74 61 62 61 73 65  .  The [database
0a60: 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 61 6e 64   connection] and
0a70: 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65   [prepared state
0a80: 6d 65 6e 74 5d 20 6f 62 6a 65 63 74 73 20 61 72  ment] objects ar
0a90: 65 20 63 6f 6e 74 72 6f 6c 6c 65 64 0a 20 20 62  e controlled.  b
0aa0: 79 20 61 20 73 6d 61 6c 6c 20 73 65 74 20 6f 66  y a small set of
0ab0: 20 43 2f 43 2b 2b 20 69 6e 74 65 72 66 61 63 65   C/C++ interface
0ac0: 20 72 6f 75 74 69 6e 65 20 6c 69 73 74 65 64 20   routine listed 
0ad0: 62 65 6c 6f 77 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e  below..</p>..<p>
0ae0: 3c 75 6c 3e 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c  <ul>.  <li> [sql
0af0: 69 74 65 33 5f 6f 70 65 6e 28 29 5d 20 3c 2f 6c  ite3_open()] </l
0b00: 69 3e 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c 69 74  i>.  <li> [sqlit
0b10: 65 33 5f 70 72 65 70 61 72 65 28 29 5d 20 3c 2f  e3_prepare()] </
0b20: 6c 69 3e 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c 69  li>.  <li> [sqli
0b30: 74 65 33 5f 73 74 65 70 28 29 5d 20 3c 2f 6c 69  te3_step()] </li
0b40: 3e 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c 69 74 65  >.  <li> [sqlite
0b50: 33 5f 63 6f 6c 75 6d 6e 5f 69 6e 74 20 7c 20 73  3_column_int | s
0b60: 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 28 29 5d  qlite3_column()]
0b70: 20 3c 2f 6c 69 3e 0a 20 20 3c 6c 69 3e 20 5b 73   </li>.  <li> [s
0b80: 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28  qlite3_finalize(
0b90: 29 5d 20 3c 2f 6c 69 3e 0a 20 20 3c 6c 69 3e 20  )] </li>.  <li> 
0ba0: 5b 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 28 29  [sqlite3_close()
0bb0: 5d 20 3c 2f 6c 69 3e 0a 3c 2f 75 6c 3e 3c 2f 70  ] </li>.</ul></p
0bc0: 3e 0a 0a 3c 70 3e 0a 20 20 54 68 65 20 73 69 78  >..<p>.  The six
0bd0: 20 43 2f 43 2b 2b 20 69 6e 74 65 72 66 61 63 65   C/C++ interface
0be0: 20 72 6f 75 74 69 6e 65 73 20 61 6e 64 20 74 77   routines and tw
0bf0: 6f 20 6f 62 6a 65 63 74 73 20 6c 69 73 74 65 64  o objects listed
0c00: 20 61 62 6f 76 65 20 66 6f 72 6d 20 74 68 65 20   above form the 
0c10: 63 6f 72 65 0a 20 20 66 75 6e 63 74 69 6f 6e 61  core.  functiona
0c20: 6c 69 74 79 20 6f 66 20 53 51 4c 69 74 65 2e 20  lity of SQLite. 
0c30: 20 54 68 65 20 64 65 76 65 6c 6f 70 65 72 20 77   The developer w
0c40: 68 6f 20 75 6e 64 65 72 73 74 61 6e 64 73 20 74  ho understands t
0c50: 68 65 6d 0a 20 20 77 69 6c 6c 20 68 61 76 65 20  hem.  will have 
0c60: 61 20 67 6f 6f 64 20 66 6f 75 6e 64 61 74 69 6f  a good foundatio
0c70: 6e 20 66 6f 72 20 75 73 69 6e 67 20 53 51 4c 69  n for using SQLi
0c80: 74 65 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 20 20  te..</p>..<p>.  
0c90: 4e 6f 74 65 20 74 68 61 74 20 74 68 65 20 6c 69  Note that the li
0ca0: 73 74 20 6f 66 20 72 6f 75 74 69 6e 65 73 20 69  st of routines i
0cb0: 73 20 63 6f 6e 63 65 70 74 75 61 6c 20 72 61 74  s conceptual rat
0cc0: 68 65 72 20 74 68 61 6e 20 61 63 74 75 61 6c 2e  her than actual.
0cd0: 0a 20 20 4d 61 6e 79 20 6f 66 20 74 68 65 73 65  .  Many of these
0ce0: 20 72 6f 75 74 69 6e 65 73 20 63 6f 6d 65 20 69   routines come i
0cf0: 6e 20 6d 75 6c 74 69 70 6c 65 20 76 65 72 73 69  n multiple versi
0d00: 6f 6e 73 2e 0a 20 20 46 6f 72 20 65 78 61 6d 70  ons..  For examp
0d10: 6c 65 2c 20 74 68 65 20 6c 69 73 74 20 61 62 6f  le, the list abo
0d20: 76 65 20 73 68 6f 77 73 20 61 20 73 69 6e 67 6c  ve shows a singl
0d30: 65 20 72 6f 75 74 69 6e 65 0a 20 20 6e 61 6d 65  e routine.  name
0d40: 64 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28  d [sqlite3_open(
0d50: 29 5d 20 77 68 65 6e 20 69 6e 20 66 61 63 74 20  )] when in fact 
0d60: 74 68 65 72 65 20 61 72 65 20 74 68 72 65 65 20  there are three 
0d70: 73 65 70 61 72 61 74 65 20 72 6f 75 74 69 6e 65  separate routine
0d80: 73 0a 20 20 74 68 61 74 20 61 63 63 6f 6d 70 6c  s.  that accompl
0d90: 69 73 68 20 74 68 65 20 73 61 6d 65 20 74 68 69  ish the same thi
0da0: 6e 67 20 69 6e 20 73 6c 69 67 68 74 6c 79 20 64  ng in slightly d
0db0: 69 66 66 65 72 65 6e 74 20 77 61 79 73 3a 0a 20  ifferent ways:. 
0dc0: 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29   [sqlite3_open()
0dd0: 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e  ], [sqlite3_open
0de0: 31 36 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74  16()] and [sqlit
0df0: 65 33 5f 6f 70 65 6e 5f 76 32 28 29 5d 2e 0a 20  e3_open_v2()].. 
0e00: 20 54 68 65 20 6c 69 73 74 20 6d 65 6e 74 69 6f   The list mentio
0e10: 6e 73 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75  ns [sqlite3_colu
0e20: 6d 6e 5f 69 6e 74 20 7c 20 73 71 6c 69 74 65 33  mn_int | sqlite3
0e30: 5f 63 6f 6c 75 6d 6e 28 29 5d 0a 20 20 77 68 65  _column()].  whe
0e40: 6e 20 69 6e 20 66 61 63 74 20 6e 6f 20 73 75 63  n in fact no suc
0e50: 68 20 72 6f 75 74 69 6e 65 20 65 78 69 73 74 73  h routine exists
0e60: 2e 0a 20 20 54 68 65 20 22 73 71 6c 69 74 65 33  ..  The "sqlite3
0e70: 5f 63 6f 6c 75 6d 6e 28 29 22 20 73 68 6f 77 6e  _column()" shown
0e80: 20 69 6e 20 74 68 65 20 6c 69 73 74 20 69 73 20   in the list is 
0e90: 70 6c 61 63 65 20 68 6f 6c 64 65 72 73 20 66 6f  place holders fo
0ea0: 72 0a 20 20 61 6e 20 65 6e 74 69 72 65 20 66 61  r.  an entire fa
0eb0: 6d 69 6c 79 20 6f 66 20 72 6f 75 74 69 6e 65 73  mily of routines
0ec0: 20 74 6f 20 62 65 20 75 73 65 64 20 66 6f 72 20   to be used for 
0ed0: 65 78 74 72 61 63 74 69 6e 67 20 63 6f 6c 75 6d  extracting colum
0ee0: 6e 0a 20 20 64 61 74 61 20 69 6e 20 76 61 72 69  n.  data in vari
0ef0: 6f 75 73 20 64 61 74 61 74 79 70 65 73 2e 0a 3c  ous datatypes..<
0f00: 2f 70 3e 0a 0a 3c 70 3e 0a 20 20 48 65 72 65 20  /p>..<p>.  Here 
0f10: 69 73 20 61 20 73 75 6d 6d 61 72 79 20 6f 66 20  is a summary of 
0f20: 77 68 61 74 20 74 68 65 20 63 6f 72 65 20 69 6e  what the core in
0f30: 74 65 72 66 61 63 65 73 20 64 6f 3a 0a 3c 2f 70  terfaces do:.</p
0f40: 3e 0a 0a 3c 74 61 62 6c 65 20 62 6f 72 64 65 72  >..<table border
0f50: 3d 22 30 22 20 63 65 6c 6c 73 70 61 63 69 6e 67  ="0" cellspacing
0f60: 3d 22 31 35 22 3e 0a 0a 3c 74 72 3e 3c 74 64 20  ="15">..<tr><td 
0f70: 76 61 6c 69 67 6e 3d 22 74 6f 70 22 20 61 6c 69  valign="top" ali
0f80: 67 6e 3d 22 72 69 67 68 74 22 3e 5b 73 71 6c 69  gn="right">[sqli
0f90: 74 65 33 5f 6f 70 65 6e 28 29 5d 3c 2f 74 64 3e  te3_open()]</td>
0fa0: 0a 3c 74 64 20 76 61 6c 69 67 6e 3d 22 74 6f 70  .<td valign="top
0fb0: 22 3e 0a 20 20 54 68 69 73 20 72 6f 75 74 69 6e  ">.  This routin
0fc0: 65 20 0a 20 20 6f 70 65 6e 73 20 61 20 63 6f 6e  e .  opens a con
0fd0: 6e 65 63 74 69 6f 6e 20 74 6f 20 61 6e 20 53 51  nection to an SQ
0fe0: 4c 69 74 65 20 64 61 74 61 62 61 73 65 20 66 69  Lite database fi
0ff0: 6c 65 20 61 6e 64 20 72 65 74 75 72 6e 73 20 61  le and returns a
1000: 0a 20 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e  .  [database con
1010: 6e 65 63 74 69 6f 6e 5d 20 6f 62 6a 65 63 74 2e  nection] object.
1020: 20 20 54 68 69 73 20 69 73 20 6f 66 74 65 6e 20    This is often 
1030: 74 68 65 20 66 69 72 73 74 20 53 51 4c 69 74 65  the first SQLite
1040: 20 41 50 49 0a 20 20 63 61 6c 6c 20 74 68 61 74   API.  call that
1050: 20 61 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 20   an application 
1060: 6d 61 6b 65 73 20 61 6e 64 20 69 73 20 61 20 70  makes and is a p
1070: 72 65 72 65 71 75 69 73 69 74 65 20 66 6f 72 20  rerequisite for 
1080: 6d 6f 73 74 20 6f 74 68 65 72 0a 20 20 53 51 4c  most other.  SQL
1090: 69 74 65 20 41 50 49 73 2e 20 20 4d 61 6e 79 20  ite APIs.  Many 
10a0: 53 51 4c 69 74 65 20 69 6e 74 65 72 66 61 63 65  SQLite interface
10b0: 73 20 72 65 71 75 69 72 65 20 61 20 70 6f 69 6e  s require a poin
10c0: 74 65 72 20 74 6f 0a 20 20 74 68 65 20 5b 64 61  ter to.  the [da
10d0: 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
10e0: 6e 5d 20 6f 62 6a 65 63 74 20 61 73 20 74 68 65  n] object as the
10f0: 69 72 20 66 69 72 73 74 20 70 61 72 61 6d 65 74  ir first paramet
1100: 65 72 20 61 6e 64 20 63 61 6e 0a 20 20 62 65 20  er and can.  be 
1110: 74 68 6f 75 67 68 74 20 6f 66 20 61 73 20 6d 65  thought of as me
1120: 74 68 6f 64 73 20 6f 6e 20 74 68 65 20 5b 64 61  thods on the [da
1130: 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
1140: 6e 5d 20 6f 62 6a 65 63 74 2e 0a 20 20 54 68 69  n] object..  Thi
1150: 73 20 72 6f 75 74 69 6e 65 20 69 73 20 74 68 65  s routine is the
1160: 20 63 6f 6e 73 74 72 75 63 74 6f 72 20 66 6f 72   constructor for
1170: 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20 63   the [database c
1180: 6f 6e 6e 65 63 74 69 6f 6e 5d 20 6f 62 6a 65 63  onnection] objec
1190: 74 2e 0a 3c 2f 74 64 3e 0a 0a 3c 74 72 3e 3c 74  t..</td>..<tr><t
11a0: 64 20 76 61 6c 69 67 6e 3d 22 74 6f 70 22 20 61  d valign="top" a
11b0: 6c 69 67 6e 3d 22 72 69 67 68 74 22 3e 5b 73 71  lign="right">[sq
11c0: 6c 69 74 65 33 5f 70 72 65 70 61 72 65 28 29 5d  lite3_prepare()]
11d0: 3c 2f 74 64 3e 0a 3c 74 64 20 76 61 6c 69 67 6e  </td>.<td valign
11e0: 3d 22 74 6f 70 22 3e 0a 20 20 54 68 69 73 20 72  ="top">.  This r
11f0: 6f 75 74 69 6e 65 0a 20 20 63 6f 6e 76 65 72 74  outine.  convert
1200: 73 20 53 51 4c 20 74 65 78 74 20 69 6e 74 6f 20  s SQL text into 
1210: 61 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74  a [prepared stat
1220: 65 6d 65 6e 74 5d 20 6f 62 6a 65 63 74 20 61 6e  ement] object an
1230: 64 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69 6e  d returns a poin
1240: 74 65 72 0a 20 20 74 6f 20 74 68 61 74 20 6f 62  ter.  to that ob
1250: 6a 65 63 74 2e 20 20 54 68 69 73 20 69 6e 74 65  ject.  This inte
1260: 72 66 61 63 65 20 72 65 71 75 69 72 65 73 20 61  rface requires a
1270: 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65   [database conne
1280: 63 74 69 6f 6e 5d 20 70 6f 69 6e 74 65 72 0a 20  ction] pointer. 
1290: 20 63 72 65 61 74 65 64 20 62 79 20 61 20 70 72   created by a pr
12a0: 69 6f 72 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c  ior call to [sql
12b0: 69 74 65 33 5f 6f 70 65 6e 28 29 5d 20 61 6e 64  ite3_open()] and
12c0: 20 61 20 74 65 78 74 20 73 74 72 69 6e 67 20 63   a text string c
12d0: 6f 6e 74 61 69 6e 69 6e 67 0a 20 20 74 68 65 20  ontaining.  the 
12e0: 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 74 6f  SQL statement to
12f0: 20 62 65 20 70 72 65 70 61 72 65 64 2e 20 20 54   be prepared.  T
1300: 68 69 73 20 41 50 49 20 64 6f 65 73 20 6e 6f 74  his API does not
1310: 20 61 63 74 75 61 6c 6c 79 20 65 76 61 6c 75 61   actually evalua
1320: 74 65 0a 20 20 74 68 65 20 53 51 4c 20 73 74 61  te.  the SQL sta
1330: 74 65 6d 65 6e 74 2e 20 20 49 74 20 6d 65 72 65  tement.  It mere
1340: 6c 79 20 70 72 65 70 61 72 65 73 20 74 68 65 20  ly prepares the 
1350: 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 66 6f  SQL statement fo
1360: 72 20 65 76 61 6c 75 61 74 69 6f 6e 2e 0a 0a 20  r evaluation... 
1370: 20 3c 70 3e 4e 6f 74 65 20 74 68 61 74 20 74 68   <p>Note that th
1380: 65 20 75 73 65 20 6f 66 20 5b 73 71 6c 69 74 65  e use of [sqlite
1390: 33 5f 70 72 65 70 61 72 65 28 29 5d 20 69 73 20  3_prepare()] is 
13a0: 6e 6f 74 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20  not recommended 
13b0: 66 6f 72 20 6e 65 77 0a 20 20 61 70 70 6c 69 63  for new.  applic
13c0: 61 74 69 6f 6e 73 2e 20 20 54 68 65 20 61 6c 74  ations.  The alt
13d0: 65 72 6e 61 74 69 76 65 20 72 6f 75 74 69 6e 65  ernative routine
13e0: 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72   [sqlite3_prepar
13f0: 65 5f 76 32 28 29 5d 20 73 68 6f 75 6c 64 0a 20  e_v2()] should. 
1400: 20 62 65 20 75 73 65 64 20 69 6e 73 74 65 61 64   be used instead
1410: 2e 3c 2f 70 3e 0a 3c 2f 74 64 3e 0a 0a 3c 74 72  .</p>.</td>..<tr
1420: 3e 3c 74 64 20 76 61 6c 69 67 6e 3d 22 74 6f 70  ><td valign="top
1430: 22 20 61 6c 69 67 6e 3d 22 72 69 67 68 74 22 3e  " align="right">
1440: 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d  [sqlite3_step()]
1450: 3c 2f 74 64 3e 0a 3c 74 64 20 76 61 6c 69 67 6e  </td>.<td valign
1460: 3d 22 74 6f 70 22 3e 0a 20 20 54 68 69 73 20 72  ="top">.  This r
1470: 6f 75 74 69 6e 65 20 69 73 20 75 73 65 64 20 74  outine is used t
1480: 6f 20 65 76 61 6c 75 61 74 65 20 61 20 5b 70 72  o evaluate a [pr
1490: 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
14a0: 5d 20 74 68 61 74 20 68 61 73 20 62 65 65 6e 0a  ] that has been.
14b0: 20 20 70 72 65 76 69 6f 75 73 6c 79 20 63 72 65    previously cre
14c0: 61 74 65 64 20 62 79 20 74 68 65 20 5b 73 71 6c  ated by the [sql
14d0: 69 74 65 33 5f 70 72 65 70 61 72 65 28 29 5d 20  ite3_prepare()] 
14e0: 69 6e 74 65 72 66 61 63 65 2e 20 20 54 68 65 20  interface.  The 
14f0: 73 74 61 74 65 6d 65 6e 74 0a 20 20 69 73 20 65  statement.  is e
1500: 76 61 6c 75 61 74 65 64 20 75 70 20 74 6f 20 74  valuated up to t
1510: 68 65 20 70 6f 69 6e 74 20 77 68 65 72 65 20 74  he point where t
1520: 68 65 20 66 69 72 73 74 20 72 6f 77 20 6f 66 20  he first row of 
1530: 72 65 73 75 6c 74 73 20 61 72 65 20 61 76 61 69  results are avai
1540: 6c 61 62 6c 65 2e 0a 20 20 54 6f 20 61 64 76 61  lable..  To adva
1550: 6e 63 65 20 74 6f 20 74 68 65 20 73 65 63 6f 6e  nce to the secon
1560: 64 20 72 6f 77 20 6f 66 20 72 65 73 75 6c 74 73  d row of results
1570: 2c 20 69 6e 76 6f 6b 65 20 5b 73 71 6c 69 74 65  , invoke [sqlite
1580: 33 5f 73 74 65 70 28 29 5d 20 61 67 61 69 6e 2e  3_step()] again.
1590: 0a 20 20 43 6f 6e 74 69 6e 75 65 20 69 6e 76 6f  .  Continue invo
15a0: 6b 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 73 74  king [sqlite3_st
15b0: 65 70 28 29 5d 20 75 6e 74 69 6c 20 74 68 65 20  ep()] until the 
15c0: 73 74 61 74 65 6d 65 6e 74 20 69 73 20 63 6f 6d  statement is com
15d0: 70 6c 65 74 65 2e 0a 20 20 53 74 61 74 65 6d 65  plete..  Stateme
15e0: 6e 74 73 20 74 68 61 74 20 64 6f 20 6e 6f 74 20  nts that do not 
15f0: 72 65 74 75 72 6e 20 72 65 73 75 6c 74 73 20 28  return results (
1600: 65 78 3a 20 49 4e 53 45 52 54 2c 20 55 50 44 41  ex: INSERT, UPDA
1610: 54 45 2c 20 6f 72 20 44 45 4c 45 54 45 0a 20 20  TE, or DELETE.  
1620: 73 74 61 74 65 6d 65 6e 74 73 29 20 72 75 6e 20  statements) run 
1630: 74 6f 20 63 6f 6d 70 6c 65 74 69 6f 6e 20 6f 6e  to completion on
1640: 20 61 20 73 69 6e 67 6c 65 20 63 61 6c 6c 20 74   a single call t
1650: 6f 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28  o [sqlite3_step(
1660: 29 5d 2e 0a 3c 2f 74 64 3e 0a 0a 0a 3c 74 72 3e  )]..</td>...<tr>
1670: 3c 74 64 20 76 61 6c 69 67 6e 3d 22 74 6f 70 22  <td valign="top"
1680: 20 61 6c 69 67 6e 3d 22 72 69 67 68 74 22 3e 5b   align="right">[
1690: 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 69  sqlite3_column_i
16a0: 6e 74 20 7c 20 73 71 6c 69 74 65 33 5f 63 6f 6c  nt | sqlite3_col
16b0: 75 6d 6e 28 29 5d 3c 2f 74 64 3e 0a 3c 74 64 20  umn()]</td>.<td 
16c0: 76 61 6c 69 67 6e 3d 22 74 6f 70 22 3e 0a 20 20  valign="top">.  
16d0: 54 68 69 73 20 72 6f 75 74 69 6e 65 20 72 65 74  This routine ret
16e0: 75 72 6e 73 20 61 20 73 69 6e 67 6c 65 20 63 6f  urns a single co
16f0: 6c 75 6d 6e 20 66 72 6f 6d 20 74 68 65 20 63 75  lumn from the cu
1700: 72 72 65 6e 74 20 72 6f 77 20 6f 66 20 61 20 72  rrent row of a r
1710: 65 73 75 6c 74 0a 20 20 73 65 74 20 66 6f 72 20  esult.  set for 
1720: 61 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74  a [prepared stat
1730: 65 6d 65 6e 74 5d 20 74 68 61 74 20 69 73 20 62  ement] that is b
1740: 65 69 6e 67 20 65 76 61 6c 75 61 74 65 64 20 62  eing evaluated b
1750: 79 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28  y [sqlite3_step(
1760: 29 5d 2e 0a 20 20 45 61 63 68 20 74 69 6d 65 20  )]..  Each time 
1770: 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d  [sqlite3_step()]
1780: 20 73 74 6f 70 73 20 77 69 74 68 20 61 20 6e 65   stops with a ne
1790: 77 20 72 65 73 75 6c 74 20 73 65 74 20 72 6f 77  w result set row
17a0: 2c 20 74 68 69 73 20 72 6f 75 74 69 6e 65 0a 20  , this routine. 
17b0: 20 63 61 6e 20 62 65 20 63 61 6c 6c 65 64 20 6d   can be called m
17c0: 75 6c 74 69 70 6c 65 20 74 69 6d 65 73 20 74 6f  ultiple times to
17d0: 20 66 69 6e 64 20 74 68 65 20 76 61 6c 75 65 73   find the values
17e0: 20 6f 66 20 61 6c 6c 20 63 6f 6c 75 6d 6e 73 20   of all columns 
17f0: 69 6e 20 74 68 61 74 20 72 6f 77 2e 0a 20 20 41  in that row..  A
1800: 73 20 6e 6f 74 65 64 20 61 62 6f 76 65 2c 20 74  s noted above, t
1810: 68 65 72 65 20 72 65 61 6c 6c 79 20 69 73 20 6e  here really is n
1820: 6f 20 73 75 63 68 20 74 68 69 6e 67 20 61 73 20  o such thing as 
1830: 61 20 22 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  a "sqlite3_colum
1840: 6e 28 29 22 0a 20 20 66 75 6e 63 74 69 6f 6e 20  n()".  function 
1850: 69 6e 20 74 68 65 20 53 51 4c 69 74 65 20 41 50  in the SQLite AP
1860: 49 2e 20 20 49 6e 73 74 65 61 64 2c 20 77 68 61  I.  Instead, wha
1870: 74 20 77 65 20 68 65 72 65 20 63 61 6c 6c 20 22  t we here call "
1880: 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 28 29  sqlite3_column()
1890: 22 0a 20 20 69 73 20 72 65 61 6c 6c 79 20 61 20  ".  is really a 
18a0: 70 6c 61 63 65 2d 68 6f 6c 64 65 72 20 66 6f 72  place-holder for
18b0: 20 61 6e 20 65 6e 74 69 72 65 20 66 61 6d 69 6c   an entire famil
18c0: 79 20 6f 66 20 66 75 6e 63 74 69 6f 6e 73 20 74  y of functions t
18d0: 68 61 74 20 72 65 74 75 72 6e 0a 20 20 61 20 76  hat return.  a v
18e0: 61 6c 75 65 20 66 72 6f 6d 20 74 68 65 20 72 65  alue from the re
18f0: 73 75 6c 74 20 73 65 74 20 69 6e 20 76 61 72 69  sult set in vari
1900: 6f 75 73 20 64 61 74 61 20 74 79 70 65 73 2e 20  ous data types. 
1910: 20 54 68 65 72 65 20 61 72 65 20 61 6c 73 6f 20   There are also 
1920: 72 6f 75 74 69 6e 65 73 0a 20 20 69 6e 20 74 68  routines.  in th
1930: 69 73 20 66 61 6d 69 6c 79 20 74 68 61 74 20 72  is family that r
1940: 65 74 75 72 6e 20 74 68 65 20 73 69 7a 65 20 6f  eturn the size o
1950: 66 20 74 68 65 20 72 65 73 75 6c 74 20 28 69 66  f the result (if
1960: 20 69 74 20 69 73 20 61 20 73 74 72 69 6e 67 20   it is a string 
1970: 6f 72 0a 20 20 42 4c 4f 42 29 20 61 6e 64 20 74  or.  BLOB) and t
1980: 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 63 6f 6c  he number of col
1990: 75 6d 6e 73 20 69 6e 20 74 68 65 20 72 65 73 75  umns in the resu
19a0: 6c 74 20 73 65 74 2e 20 20 0a 0a 20 20 3c 70 3e  lt set.  ..  <p>
19b0: 3c 75 6c 3e 0a 20 20 20 20 3c 6c 69 3e 20 5b 73  <ul>.    <li> [s
19c0: 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 6c  qlite3_column_bl
19d0: 6f 62 28 29 5d 20 3c 2f 6c 69 3e 0a 20 20 20 20  ob()] </li>.    
19e0: 3c 6c 69 3e 20 5b 73 71 6c 69 74 65 33 5f 63 6f  <li> [sqlite3_co
19f0: 6c 75 6d 6e 5f 62 79 74 65 73 28 29 5d 20 3c 2f  lumn_bytes()] </
1a00: 6c 69 3e 0a 20 20 20 20 3c 6c 69 3e 20 5b 73 71  li>.    <li> [sq
1a10: 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74  lite3_column_byt
1a20: 65 73 31 36 28 29 5d 20 3c 2f 6c 69 3e 0a 20 20  es16()] </li>.  
1a30: 20 20 3c 6c 69 3e 20 5b 73 71 6c 69 74 65 33 5f    <li> [sqlite3_
1a40: 63 6f 6c 75 6d 6e 5f 63 6f 75 6e 74 28 29 5d 20  column_count()] 
1a50: 3c 2f 6c 69 3e 0a 20 20 20 20 3c 6c 69 3e 20 5b  </li>.    <li> [
1a60: 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 64  sqlite3_column_d
1a70: 6f 75 62 6c 65 28 29 5d 20 3c 2f 6c 69 3e 0a 20  ouble()] </li>. 
1a80: 20 20 20 3c 6c 69 3e 20 5b 73 71 6c 69 74 65 33     <li> [sqlite3
1a90: 5f 63 6f 6c 75 6d 6e 5f 69 6e 74 28 29 5d 20 3c  _column_int()] <
1aa0: 2f 6c 69 3e 0a 20 20 20 20 3c 6c 69 3e 20 5b 73  /li>.    <li> [s
1ab0: 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 69 6e  qlite3_column_in
1ac0: 74 36 34 28 29 5d 20 3c 2f 6c 69 3e 0a 20 20 20  t64()] </li>.   
1ad0: 20 3c 6c 69 3e 20 5b 73 71 6c 69 74 65 33 5f 63   <li> [sqlite3_c
1ae0: 6f 6c 75 6d 6e 5f 74 65 78 74 28 29 5d 20 3c 2f  olumn_text()] </
1af0: 6c 69 3e 0a 20 20 20 20 3c 6c 69 3e 20 5b 73 71  li>.    <li> [sq
1b00: 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78  lite3_column_tex
1b10: 74 31 36 28 29 5d 20 3c 2f 6c 69 3e 0a 20 20 20  t16()] </li>.   
1b20: 20 3c 6c 69 3e 20 5b 73 71 6c 69 74 65 33 5f 63   <li> [sqlite3_c
1b30: 6f 6c 75 6d 6e 5f 74 79 70 65 28 29 5d 20 3c 2f  olumn_type()] </
1b40: 6c 69 3e 0a 20 20 20 20 3c 6c 69 3e 20 5b 73 71  li>.    <li> [sq
1b50: 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 76 61 6c  lite3_column_val
1b60: 75 65 28 29 5d 20 3c 2f 6c 69 3e 0a 20 20 3c 2f  ue()] </li>.  </
1b70: 75 6c 3e 3c 2f 70 3e 0a 3c 2f 74 64 3e 0a 0a 3c  ul></p>.</td>..<
1b80: 74 72 3e 3c 74 64 20 76 61 6c 69 67 6e 3d 22 74  tr><td valign="t
1b90: 6f 70 22 20 61 6c 69 67 6e 3d 22 72 69 67 68 74  op" align="right
1ba0: 22 3e 5b 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c  ">[sqlite3_final
1bb0: 69 7a 65 28 29 5d 3c 2f 74 64 3e 0a 3c 74 64 20  ize()]</td>.<td 
1bc0: 76 61 6c 69 67 6e 3d 22 74 6f 70 22 3e 0a 20 20  valign="top">.  
1bd0: 54 68 69 73 20 72 6f 75 74 69 6e 65 20 64 65 73  This routine des
1be0: 74 72 6f 79 73 20 61 20 5b 70 72 65 70 61 72 65  troys a [prepare
1bf0: 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 63 72 65  d statement] cre
1c00: 61 74 65 64 20 62 79 20 61 20 70 72 69 6f 72 20  ated by a prior 
1c10: 63 61 6c 6c 0a 20 20 74 6f 20 5b 73 71 6c 69 74  call.  to [sqlit
1c20: 65 33 5f 70 72 65 70 61 72 65 28 29 5d 2e 20 20  e3_prepare()].  
1c30: 45 76 65 72 79 20 70 72 65 70 61 72 65 64 20 73  Every prepared s
1c40: 74 61 74 65 6d 65 6e 74 20 6d 75 73 74 20 62 65  tatement must be
1c50: 20 64 65 73 74 72 6f 79 65 64 20 75 73 69 6e 67   destroyed using
1c60: 0a 20 20 61 20 63 61 6c 6c 20 74 6f 20 74 68 69  .  a call to thi
1c70: 73 20 72 6f 75 74 69 6e 65 20 69 6e 20 6f 72 64  s routine in ord
1c80: 65 72 20 74 6f 20 61 76 6f 69 64 20 6d 65 6d 6f  er to avoid memo
1c90: 72 79 20 6c 65 61 6b 73 2e 0a 3c 2f 74 64 3e 0a  ry leaks..</td>.
1ca0: 0a 3c 74 72 3e 3c 74 64 20 76 61 6c 69 67 6e 3d  .<tr><td valign=
1cb0: 22 74 6f 70 22 20 61 6c 69 67 6e 3d 22 72 69 67  "top" align="rig
1cc0: 68 74 22 3e 5b 73 71 6c 69 74 65 33 5f 63 6c 6f  ht">[sqlite3_clo
1cd0: 73 65 28 29 5d 3c 2f 74 64 3e 0a 3c 74 64 20 76  se()]</td>.<td v
1ce0: 61 6c 69 67 6e 3d 22 74 6f 70 22 3e 0a 20 20 54  align="top">.  T
1cf0: 68 69 73 20 72 6f 75 74 69 6e 65 20 63 6c 6f 73  his routine clos
1d00: 65 73 20 61 20 5b 64 61 74 61 62 61 73 65 20 63  es a [database c
1d10: 6f 6e 6e 65 63 74 69 6f 6e 5d 20 70 72 65 76 69  onnection] previ
1d20: 6f 75 73 6c 79 20 6f 70 65 6e 65 64 20 62 79 20  ously opened by 
1d30: 61 20 63 61 6c 6c 0a 20 20 74 6f 20 5b 73 71 6c  a call.  to [sql
1d40: 69 74 65 33 5f 6f 70 65 6e 28 29 5d 2e 20 20 41  ite3_open()].  A
1d50: 6c 6c 20 5b 70 72 65 70 61 72 65 64 20 73 74 61  ll [prepared sta
1d60: 74 65 6d 65 6e 74 73 5d 20 61 73 73 6f 63 69 61  tements] associa
1d70: 74 65 64 20 77 69 74 68 20 74 68 65 0a 20 20 63  ted with the.  c
1d80: 6f 6e 6e 65 63 74 69 6f 6e 20 73 68 6f 75 6c 64  onnection should
1d90: 20 62 65 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e   be [sqlite3_fin
1da0: 61 6c 69 7a 65 20 7c 20 66 69 6e 61 6c 69 7a 65  alize | finalize
1db0: 64 5d 20 70 72 69 6f 72 20 74 6f 20 63 6c 6f 73  d] prior to clos
1dc0: 69 6e 67 20 74 68 65 0a 20 20 63 6f 6e 6e 65 63  ing the.  connec
1dd0: 74 69 6f 6e 2e 0a 3c 2f 74 64 3e 0a 0a 3c 2f 74  tion..</td>..</t
1de0: 61 62 6c 65 3e 0a 0a 3c 74 63 6c 3e 48 45 41 44  able>..<tcl>HEAD
1df0: 49 4e 47 20 32 20 7b 54 79 70 69 63 61 6c 20 55  ING 2 {Typical U
1e00: 73 61 67 65 20 4f 66 20 43 6f 72 65 20 52 6f 75  sage Of Core Rou
1e10: 74 69 6e 65 73 20 41 6e 64 20 4f 62 6a 65 63 74  tines And Object
1e20: 73 7d 3c 2f 74 63 6c 3e 0a 0a 3c 70 3e 0a 20 20  s}</tcl>..<p>.  
1e30: 41 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 74  An application t
1e40: 68 61 74 20 77 61 6e 74 73 20 74 6f 20 75 73 65  hat wants to use
1e50: 20 53 51 4c 69 74 65 20 77 69 6c 6c 20 74 79 70   SQLite will typ
1e60: 69 63 61 6c 6c 79 20 75 73 65 0a 20 20 5b 73 71  ically use.  [sq
1e70: 6c 69 74 65 33 5f 6f 70 65 6e 28 29 5d 20 74 6f  lite3_open()] to
1e80: 20 63 72 65 61 74 65 20 61 20 73 69 6e 67 6c 65   create a single
1e90: 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65   [database conne
1ea0: 63 74 69 6f 6e 5d 0a 20 20 64 75 72 69 6e 67 20  ction].  during 
1eb0: 69 6e 69 74 69 61 6c 69 7a 61 74 69 6f 6e 2e 0a  initialization..
1ec0: 20 20 4e 6f 74 65 20 74 68 61 74 20 5b 73 71 6c    Note that [sql
1ed0: 69 74 65 33 5f 6f 70 65 6e 28 29 5d 20 63 61 6e  ite3_open()] can
1ee0: 20 62 65 20 75 73 65 64 20 74 6f 20 65 69 74 68   be used to eith
1ef0: 65 72 20 6f 70 65 6e 20 65 78 69 73 74 69 6e 67  er open existing
1f00: 20 64 61 74 61 62 61 73 65 0a 20 20 66 69 6c 65   database.  file
1f10: 73 20 6f 72 20 74 6f 20 63 72 65 61 74 65 20 61  s or to create a
1f20: 6e 64 20 6f 70 65 6e 20 6e 65 77 20 64 61 74 61  nd open new data
1f30: 62 61 73 65 20 66 69 6c 65 73 2e 0a 20 20 57 68  base files..  Wh
1f40: 69 6c 65 20 6d 61 6e 79 20 61 70 70 6c 69 63 61  ile many applica
1f50: 74 69 6f 6e 73 20 75 73 65 20 6f 6e 6c 79 20 61  tions use only a
1f60: 20 73 69 6e 67 6c 65 20 5b 64 61 74 61 62 61 73   single [databas
1f70: 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 2c 20 74  e connection], t
1f80: 68 65 72 65 20 69 73 0a 20 20 6e 6f 20 72 65 61  here is.  no rea
1f90: 73 6f 6e 20 77 68 79 20 61 6e 20 61 70 70 6c 69  son why an appli
1fa0: 63 61 74 69 6f 6e 20 63 61 6e 6e 6f 74 20 63 61  cation cannot ca
1fb0: 6c 6c 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e  ll [sqlite3_open
1fc0: 28 29 5d 20 6d 75 6c 74 69 70 6c 65 20 74 69 6d  ()] multiple tim
1fd0: 65 73 0a 20 20 69 6e 20 6f 72 64 65 72 20 74 6f  es.  in order to
1fe0: 20 6f 70 65 6e 20 6d 75 6c 74 69 70 6c 65 20 5b   open multiple [
1ff0: 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
2000: 69 6f 6e 73 5d 20 2d 20 65 69 74 68 65 72 20 74  ions] - either t
2010: 6f 20 74 68 65 20 73 61 6d 65 0a 20 20 64 61 74  o the same.  dat
2020: 61 62 61 73 65 20 6f 72 20 74 6f 20 64 69 66 66  abase or to diff
2030: 65 72 65 6e 74 20 64 61 74 61 62 61 73 65 73 2e  erent databases.
2040: 20 20 53 6f 6d 65 74 69 6d 65 73 20 61 20 6d 75    Sometimes a mu
2050: 6c 74 69 2d 74 68 72 65 61 64 65 64 20 61 70 70  lti-threaded app
2060: 6c 69 63 61 74 69 6f 6e 0a 20 20 77 69 6c 6c 20  lication.  will 
2070: 63 72 65 61 74 65 20 73 65 70 61 72 61 74 65 20  create separate 
2080: 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63  [database connec
2090: 74 69 6f 6e 73 5d 20 66 6f 72 20 65 61 63 68 20  tions] for each 
20a0: 74 68 72 65 61 64 73 2e 0a 20 20 4e 6f 74 65 20  threads..  Note 
20b0: 74 6f 6f 20 74 68 61 74 20 69 73 20 6e 6f 74 20  too that is not 
20c0: 6e 65 63 65 73 73 61 72 79 20 74 6f 20 6f 70 65  necessary to ope
20d0: 6e 20 73 65 70 61 72 61 74 65 20 64 61 74 61 62  n separate datab
20e0: 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 20  ase connections 
20f0: 69 6e 0a 20 20 6f 72 64 65 72 20 74 6f 20 61 63  in.  order to ac
2100: 63 65 73 73 20 74 77 6f 20 6f 72 20 6d 6f 72 65  cess two or more
2110: 20 64 61 74 61 62 61 73 65 73 2e 20 20 41 20 73   databases.  A s
2120: 69 6e 67 6c 65 20 5b 64 61 74 61 62 61 73 65 20  ingle [database 
2130: 63 6f 6e 6e 65 63 74 69 6f 6e 5d 0a 20 20 63 61  connection].  ca
2140: 6e 20 62 65 20 6d 61 64 65 20 74 6f 20 61 63 63  n be made to acc
2150: 65 73 73 20 74 77 6f 20 6f 72 20 6d 6f 72 65 20  ess two or more 
2160: 64 61 74 61 62 61 73 65 73 20 61 74 20 6f 6e 65  databases at one
2170: 20 74 69 6d 65 20 75 73 69 6e 67 20 74 68 65 0a   time using the.
2180: 20 20 5b 41 54 54 41 43 48 5d 20 53 51 4c 20 63    [ATTACH] SQL c
2190: 6f 6d 6d 61 6e 64 2e 0a 3c 2f 70 3e 0a 0a 3c 70  ommand..</p>..<p
21a0: 3e 0a 20 20 4d 61 6e 79 20 61 70 70 6c 69 63 61  >.  Many applica
21b0: 74 69 6f 6e 73 20 64 65 73 74 72 6f 79 20 74 68  tions destroy th
21c0: 65 69 72 20 5b 64 61 74 61 62 61 73 65 20 63 6f  eir [database co
21d0: 6e 6e 65 63 74 69 6f 6e 73 5d 20 75 73 69 6e 67  nnections] using
21e0: 20 63 61 6c 6c 73 20 74 6f 0a 20 20 5b 73 71 6c   calls to.  [sql
21f0: 69 74 65 33 5f 63 6c 6f 73 65 28 29 5d 20 61 74  ite3_close()] at
2200: 20 73 68 75 74 64 6f 77 6e 2e 20 20 4f 72 2c 20   shutdown.  Or, 
2210: 66 6f 72 20 65 78 61 6d 70 6c 65 2c 20 61 6e 20  for example, an 
2220: 61 70 70 6c 69 63 61 74 69 6f 6e 20 6d 69 67 68  application migh
2230: 74 0a 20 20 6f 70 65 6e 20 5b 64 61 74 61 62 61  t.  open [databa
2240: 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 5d 20  se connections] 
2250: 69 6e 20 72 65 73 70 6f 6e 73 65 20 74 6f 20 61  in response to a
2260: 20 46 69 6c 65 2d 3e 4f 70 65 6e 20 6d 65 6e 75   File->Open menu
2270: 20 61 63 74 69 6f 6e 0a 20 20 61 6e 64 20 74 68   action.  and th
2280: 65 6e 20 64 65 73 74 72 6f 79 20 74 68 65 20 63  en destroy the c
2290: 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20 5b 64 61  orresponding [da
22a0: 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
22b0: 6e 5d 20 69 6e 20 72 65 73 70 6f 6e 73 65 0a 20  n] in response. 
22c0: 20 74 6f 20 74 68 65 20 46 69 6c 65 2d 3e 43 6c   to the File->Cl
22d0: 6f 73 65 20 6d 65 6e 75 2e 0a 3c 2f 70 3e 0a 0a  ose menu..</p>..
22e0: 3c 70 3e 0a 20 20 54 6f 20 72 75 6e 20 61 6e 20  <p>.  To run an 
22f0: 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2c 20 74  SQL statement, t
2300: 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 66  he application f
2310: 6f 6c 6c 6f 77 73 20 74 68 65 73 65 20 73 74 65  ollows these ste
2320: 70 73 3a 0a 3c 2f 70 3e 0a 0a 3c 70 3e 3c 6f 6c  ps:.</p>..<p><ol
2330: 3e 0a 20 20 3c 6c 69 3e 20 43 72 65 61 74 65 20  >.  <li> Create 
2340: 61 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74  a [prepared stat
2350: 65 6d 65 6e 74 5d 20 75 73 69 6e 67 20 5b 73 71  ement] using [sq
2360: 6c 69 74 65 33 5f 70 72 65 70 61 72 65 28 29 5d  lite3_prepare()]
2370: 2e 20 3c 2f 6c 69 3e 0a 20 20 3c 6c 69 3e 20 45  . </li>.  <li> E
2380: 76 61 6c 75 61 74 65 20 74 68 65 20 5b 70 72 65  valuate the [pre
2390: 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d  pared statement]
23a0: 20 62 79 20 63 61 6c 6c 69 6e 67 20 5b 73 71 6c   by calling [sql
23b0: 69 74 65 33 5f 73 74 65 70 28 29 5d 20 6f 6e 65  ite3_step()] one
23c0: 0a 20 20 20 20 20 20 20 6f 72 20 6d 6f 72 65 20  .       or more 
23d0: 74 69 6d 65 73 2e 20 3c 2f 6c 69 3e 0a 20 20 3c  times. </li>.  <
23e0: 6c 69 3e 20 46 6f 72 20 71 75 65 72 69 65 73 2c  li> For queries,
23f0: 20 65 78 74 72 61 63 74 20 72 65 73 75 6c 74 73   extract results
2400: 20 62 79 20 63 61 6c 6c 69 6e 67 20 0a 20 20 20   by calling .   
2410: 20 20 20 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c      [sqlite3_col
2420: 75 6d 6e 5f 69 6e 74 20 7c 20 73 71 6c 69 74 65  umn_int | sqlite
2430: 33 5f 63 6f 6c 75 6d 6e 28 29 5d 20 69 6e 20 62  3_column()] in b
2440: 65 74 77 65 65 6e 0a 20 20 20 20 20 20 20 74 77  etween.       tw
2450: 6f 20 63 61 6c 6c 73 20 74 6f 20 5b 73 71 6c 69  o calls to [sqli
2460: 74 65 33 5f 73 74 65 70 28 29 5d 2e 20 3c 2f 6c  te3_step()]. </l
2470: 69 3e 0a 20 20 3c 6c 69 3e 20 44 65 73 74 72 6f  i>.  <li> Destro
2480: 79 20 74 68 65 20 5b 70 72 65 70 61 72 65 64 20  y the [prepared 
2490: 73 74 61 74 65 6d 65 6e 74 5d 20 75 73 69 6e 67  statement] using
24a0: 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69   [sqlite3_finali
24b0: 7a 65 28 29 5d 2e 20 3c 2f 6c 69 3e 0a 3c 2f 6f  ze()]. </li>.</o
24c0: 6c 3e 3c 2f 70 3e 0a 0a 3c 70 3e 0a 20 20 54 68  l></p>..<p>.  Th
24d0: 65 20 66 6f 72 65 67 6f 69 6e 67 20 69 73 20 61  e foregoing is a
24e0: 6c 6c 20 6f 6e 65 20 72 65 61 6c 6c 79 20 6e 65  ll one really ne
24f0: 65 64 73 20 74 6f 20 6b 6e 6f 77 20 69 6e 20 6f  eds to know in o
2500: 72 64 65 72 20 74 6f 20 75 73 65 20 53 51 4c 69  rder to use SQLi
2510: 74 65 0a 20 20 65 66 66 65 63 74 69 76 65 6c 79  te.  effectively
2520: 2e 20 20 41 6c 6c 20 74 68 65 20 72 65 73 74 20  .  All the rest 
2530: 69 73 20 6a 75 73 74 20 6f 72 6e 61 6d 65 6e 74  is just ornament
2540: 61 74 69 6f 6e 20 61 6e 64 20 64 65 74 61 69 6c  ation and detail
2550: 2e 0a 3c 2f 70 3e 0a 0a 3c 74 63 6c 3e 48 45 41  ..</p>..<tcl>HEA
2560: 44 49 4e 47 20 31 20 7b 43 6f 6e 76 65 6e 69 65  DING 1 {Convenie
2570: 6e 63 65 20 57 72 61 70 70 65 72 73 20 41 72 6f  nce Wrappers Aro
2580: 75 6e 64 20 43 6f 72 65 20 52 6f 75 74 69 6e 65  und Core Routine
2590: 73 7d 3c 2f 74 63 6c 3e 0a 0a 3c 70 3e 0a 20 20  s}</tcl>..<p>.  
25a0: 54 68 65 20 5b 73 71 6c 69 74 65 33 5f 65 78 65  The [sqlite3_exe
25b0: 63 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 69  c()] interface i
25c0: 73 20 61 20 63 6f 6e 76 65 6e 69 65 6e 63 65 20  s a convenience 
25d0: 77 72 61 70 70 65 72 20 74 68 61 74 20 63 61 72  wrapper that car
25e0: 72 69 65 73 20 6f 75 74 0a 20 20 61 6c 6c 20 66  ries out.  all f
25f0: 6f 75 72 20 6f 66 20 74 68 65 20 61 62 6f 76 65  our of the above
2600: 20 73 74 65 70 73 20 77 69 74 68 20 61 20 73 69   steps with a si
2610: 6e 67 6c 65 20 66 75 6e 63 74 69 6f 6e 20 63 61  ngle function ca
2620: 6c 6c 2e 20 20 41 20 63 61 6c 6c 62 61 63 6b 0a  ll.  A callback.
2630: 20 20 66 75 6e 63 74 69 6f 6e 20 70 61 73 73 65    function passe
2640: 64 20 69 6e 74 6f 20 5b 73 71 6c 69 74 65 33 5f  d into [sqlite3_
2650: 65 78 65 63 28 29 5d 20 69 73 20 75 73 65 64 20  exec()] is used 
2660: 74 6f 20 70 72 6f 63 65 73 73 20 65 61 63 68 20  to process each 
2670: 72 6f 77 20 6f 66 0a 20 20 74 68 65 20 72 65 73  row of.  the res
2680: 75 6c 74 20 73 65 74 2e 20 20 54 68 65 20 5b 73  ult set.  The [s
2690: 71 6c 69 74 65 33 5f 67 65 74 5f 74 61 62 6c 65  qlite3_get_table
26a0: 28 29 5d 20 69 73 20 61 6e 6f 74 68 65 72 20 63  ()] is another c
26b0: 6f 6e 76 65 6e 69 65 6e 63 65 20 77 72 61 70 70  onvenience wrapp
26c0: 65 72 0a 20 20 74 68 61 74 20 64 6f 65 73 20 61  er.  that does a
26d0: 6c 6c 20 66 6f 75 72 20 6f 66 20 74 68 65 20 61  ll four of the a
26e0: 62 6f 76 65 20 73 74 65 70 73 2e 20 20 54 68 65  bove steps.  The
26f0: 20 5b 73 71 6c 69 74 65 33 5f 67 65 74 5f 74 61   [sqlite3_get_ta
2700: 62 6c 65 28 29 5d 20 69 6e 74 65 72 66 61 63 65  ble()] interface
2710: 0a 20 20 64 69 66 66 65 72 73 20 66 72 6f 6d 20  .  differs from 
2720: 5b 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 5d  [sqlite3_exec()]
2730: 20 69 6e 20 74 68 61 74 20 69 74 20 73 74 6f 72   in that it stor
2740: 65 73 20 74 68 65 20 72 65 73 75 6c 74 73 20 6f  es the results o
2750: 66 20 71 75 65 72 69 65 73 0a 20 20 69 6e 20 68  f queries.  in h
2760: 65 61 70 20 6d 65 6d 6f 72 79 20 72 61 74 68 65  eap memory rathe
2770: 72 20 74 68 61 6e 20 69 6e 76 6f 6b 69 6e 67 20  r than invoking 
2780: 61 20 63 61 6c 6c 62 61 63 6b 2e 0a 3c 2f 70 3e  a callback..</p>
2790: 0a 0a 3c 70 3e 0a 20 20 49 74 20 69 73 20 69 6d  ..<p>.  It is im
27a0: 70 6f 72 74 61 6e 74 20 74 6f 20 72 65 61 6c 69  portant to reali
27b0: 7a 65 20 74 68 61 74 20 6e 65 69 74 68 65 72 20  ze that neither 
27c0: 5b 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 5d  [sqlite3_exec()]
27d0: 20 6e 6f 72 0a 20 20 5b 73 71 6c 69 74 65 33 5f   nor.  [sqlite3_
27e0: 67 65 74 5f 74 61 62 6c 65 28 29 5d 20 64 6f 20  get_table()] do 
27f0: 61 6e 79 74 68 69 6e 67 20 74 68 61 74 20 63 61  anything that ca
2800: 6e 6e 6f 74 20 62 65 20 61 63 63 6f 6d 70 6c 69  nnot be accompli
2810: 73 68 65 64 20 75 73 69 6e 67 0a 20 20 74 68 65  shed using.  the
2820: 20 63 6f 72 65 20 72 6f 75 74 69 6e 65 73 2e 20   core routines. 
2830: 20 49 6e 20 66 61 63 74 2c 20 74 68 65 73 65 20   In fact, these 
2840: 77 72 61 70 70 65 72 73 20 61 72 65 20 69 6d 70  wrappers are imp
2850: 6c 65 6d 65 6e 74 65 64 20 70 75 72 65 6c 79 20  lemented purely 
2860: 69 6e 0a 20 20 74 65 72 6d 73 20 6f 66 20 74 68  in.  terms of th
2870: 65 20 63 6f 72 65 20 72 6f 75 74 69 6e 65 73 2e  e core routines.
2880: 0a 3c 2f 70 3e 0a 0a 0a 3c 74 63 6c 3e 48 45 41  .</p>...<tcl>HEA
2890: 44 49 4e 47 20 31 20 7b 42 69 6e 64 69 6e 67 20  DING 1 {Binding 
28a0: 50 61 72 61 6d 65 74 65 72 73 20 61 6e 64 20 52  Parameters and R
28b0: 65 75 73 69 6e 67 20 50 72 65 70 61 72 65 64 20  eusing Prepared 
28c0: 53 74 61 74 65 6d 65 6e 74 73 7d 3c 2f 74 63 6c  Statements}</tcl
28d0: 3e 0a 0a 3c 70 3e 0a 20 20 49 6e 20 70 72 69 6f  >..<p>.  In prio
28e0: 72 20 64 69 73 63 75 73 73 69 6f 6e 2c 20 69 74  r discussion, it
28f0: 20 77 61 73 20 61 73 73 75 6d 65 64 20 74 68 61   was assumed tha
2900: 74 20 65 61 63 68 20 53 51 4c 20 73 74 61 74 65  t each SQL state
2910: 6d 65 6e 74 20 69 73 20 70 72 65 70 61 72 65 64  ment is prepared
2920: 0a 20 20 6f 6e 63 65 2c 20 65 76 61 6c 75 61 74  .  once, evaluat
2930: 65 64 2c 20 74 68 65 6e 20 64 65 73 74 72 6f 79  ed, then destroy
2940: 65 64 2e 20 20 48 6f 77 65 76 65 72 2c 20 74 68  ed.  However, th
2950: 65 20 53 51 4c 69 74 65 20 61 6c 6c 6f 77 73 20  e SQLite allows 
2960: 74 68 65 20 73 61 6d 65 0a 20 20 5b 70 72 65 70  the same.  [prep
2970: 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20  ared statement] 
2980: 74 6f 20 62 65 20 65 76 61 6c 75 61 74 65 64 20  to be evaluated 
2990: 6d 75 6c 74 69 70 6c 65 20 74 69 6d 65 73 2e 20  multiple times. 
29a0: 20 54 68 69 73 20 69 73 20 61 63 63 6f 6d 70 6c   This is accompl
29b0: 69 73 68 65 64 0a 20 20 75 73 69 6e 67 20 74 68  ished.  using th
29c0: 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 72 6f 75 74  e following rout
29d0: 69 6e 65 73 3a 0a 3c 2f 70 3e 0a 0a 3c 70 3e 3c  ines:.</p>..<p><
29e0: 75 6c 3e 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c 69  ul>.  <li> [sqli
29f0: 74 65 33 5f 72 65 73 65 74 28 29 5d 20 3c 2f 6c  te3_reset()] </l
2a00: 69 3e 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c 69 74  i>.  <li> [sqlit
2a10: 65 33 5f 62 69 6e 64 5f 69 6e 74 20 7c 20 73 71  e3_bind_int | sq
2a20: 6c 69 74 65 33 5f 62 69 6e 64 28 29 5d 20 3c 2f  lite3_bind()] </
2a30: 6c 69 3e 0a 3c 2f 75 6c 3e 3c 2f 70 3e 0a 0a 3c  li>.</ul></p>..<
2a40: 70 3e 0a 20 20 41 66 74 65 72 20 61 20 5b 70 72  p>.  After a [pr
2a50: 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
2a60: 5d 20 68 61 73 20 62 65 65 6e 20 65 76 61 6c 75  ] has been evalu
2a70: 61 74 65 64 20 62 79 20 6f 6e 65 20 6f 72 20 6d  ated by one or m
2a80: 6f 72 65 20 63 61 6c 6c 73 20 74 6f 0a 20 20 5b  ore calls to.  [
2a90: 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 2c  sqlite3_step()],
2aa0: 20 69 74 20 63 61 6e 20 62 65 20 72 65 73 65 74   it can be reset
2ab0: 20 69 6e 20 6f 72 64 65 72 20 74 6f 20 62 65 20   in order to be 
2ac0: 65 76 61 6c 75 61 74 65 64 20 61 67 61 69 6e 20  evaluated again 
2ad0: 62 79 20 61 0a 20 20 63 61 6c 6c 20 74 6f 20 5b  by a.  call to [
2ae0: 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d  sqlite3_reset()]
2af0: 2e 0a 20 20 55 73 69 6e 67 20 5b 73 71 6c 69 74  ..  Using [sqlit
2b00: 65 33 5f 72 65 73 65 74 28 29 5d 20 6f 6e 20 61  e3_reset()] on a
2b10: 6e 20 65 78 69 73 74 69 6e 67 20 5b 70 72 65 70  n existing [prep
2b20: 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20  ared statement] 
2b30: 72 61 74 68 65 72 20 74 68 61 6e 0a 20 20 63 72  rather than.  cr
2b40: 65 61 74 69 6e 67 20 61 20 6e 65 77 20 5b 70 72  eating a new [pr
2b50: 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
2b60: 5d 20 61 76 6f 69 64 73 20 75 6e 6e 65 63 65 73  ] avoids unneces
2b70: 73 61 72 79 20 63 61 6c 6c 73 20 74 6f 0a 20 20  sary calls to.  
2b80: 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65  [sqlite3_prepare
2b90: 28 29 5d 2e 0a 20 20 49 6e 20 6d 61 6e 79 20 53  ()]..  In many S
2ba0: 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 2c 20 74  QL statements, t
2bb0: 68 65 20 74 69 6d 65 20 6e 65 65 64 65 64 0a 20  he time needed. 
2bc0: 20 74 6f 20 72 75 6e 20 5b 73 71 6c 69 74 65 33   to run [sqlite3
2bd0: 5f 70 72 65 70 61 72 65 28 29 5d 20 65 71 75 61  _prepare()] equa
2be0: 6c 73 20 6f 72 20 65 78 63 65 65 64 73 20 74 68  ls or exceeds th
2bf0: 65 20 74 69 6d 65 20 6e 65 65 64 65 64 20 62 79  e time needed by
2c00: 0a 20 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70  .  [sqlite3_step
2c10: 28 29 5d 2e 20 20 53 6f 20 61 76 6f 69 64 69 6e  ()].  So avoidin
2c20: 67 20 63 61 6c 6c 73 20 74 6f 20 5b 73 71 6c 69  g calls to [sqli
2c30: 74 65 33 5f 70 72 65 70 61 72 65 28 29 5d 20 63  te3_prepare()] c
2c40: 61 6e 20 72 65 73 75 6c 74 0a 20 20 69 6e 20 61  an result.  in a
2c50: 20 73 69 67 6e 69 66 69 63 61 6e 74 20 70 65 72   significant per
2c60: 66 6f 72 6d 61 6e 63 65 20 69 6d 70 72 6f 76 65  formance improve
2c70: 6d 65 6e 74 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a  ment..</p>..<p>.
2c80: 20 20 55 73 75 61 6c 6c 79 2c 20 74 68 6f 75 67    Usually, thoug
2c90: 68 2c 20 69 74 20 69 73 20 6e 6f 74 20 75 73 65  h, it is not use
2ca0: 66 75 6c 20 74 6f 20 65 76 61 6c 75 61 74 65 20  ful to evaluate 
2cb0: 65 78 61 63 74 6c 79 20 74 68 65 20 73 61 6d 65  exactly the same
2cc0: 20 53 51 4c 0a 20 20 73 74 61 74 65 6d 65 6e 74   SQL.  statement
2cd0: 20 6d 6f 72 65 20 74 68 61 6e 20 6f 6e 63 65 2e   more than once.
2ce0: 20 20 4d 6f 72 65 20 6f 66 74 65 6e 2c 20 6f 6e    More often, on
2cf0: 65 20 77 61 6e 74 73 20 74 6f 20 65 76 61 6c 75  e wants to evalu
2d00: 61 74 65 20 73 69 6d 69 6c 61 72 0a 20 20 73 74  ate similar.  st
2d10: 61 74 65 6d 65 6e 74 73 2e 20 20 46 6f 72 20 65  atements.  For e
2d20: 78 61 6d 70 6c 65 2c 20 79 6f 75 20 6d 69 67 68  xample, you migh
2d30: 74 20 77 61 6e 74 20 74 6f 20 65 76 61 6c 75 61  t want to evalua
2d40: 74 65 20 61 6e 20 49 4e 53 45 52 54 20 73 74 61  te an INSERT sta
2d50: 74 65 6d 65 6e 74 0a 20 20 6d 75 6c 74 69 70 6c  tement.  multipl
2d60: 65 20 74 69 6d 65 73 20 74 68 6f 75 67 68 20 77  e times though w
2d70: 69 74 68 20 64 69 66 66 65 72 65 6e 74 20 76 61  ith different va
2d80: 6c 75 65 73 20 74 6f 20 69 6e 73 65 72 74 2e 20  lues to insert. 
2d90: 20 54 6f 20 61 63 63 6f 6d 6d 6f 64 61 74 65 0a   To accommodate.
2da0: 20 20 74 68 69 73 20 6b 69 6e 64 20 6f 66 20 66    this kind of f
2db0: 6c 65 78 69 62 69 6c 69 74 79 2c 20 53 51 4c 69  lexibility, SQLi
2dc0: 74 65 20 61 6c 6c 6f 77 73 20 53 51 4c 20 73 74  te allows SQL st
2dd0: 61 74 65 6d 65 6e 74 73 20 74 6f 20 63 6f 6e 74  atements to cont
2de0: 61 69 6e 0a 20 20 5b 70 61 72 61 6d 65 74 65 72  ain.  [parameter
2df0: 20 7c 20 70 61 72 61 6d 65 74 65 72 73 5d 0a 20   | parameters]. 
2e00: 20 77 68 69 63 68 20 61 72 65 20 22 62 6f 75 6e   which are "boun
2e10: 64 22 20 74 6f 20 76 61 6c 75 65 73 20 70 72 69  d" to values pri
2e20: 6f 72 20 74 6f 20 62 65 69 6e 67 20 65 76 61 6c  or to being eval
2e30: 75 61 74 65 64 2e 20 20 54 68 65 73 65 20 76 61  uated.  These va
2e40: 6c 75 65 73 20 63 61 6e 0a 20 20 6c 61 74 65 72  lues can.  later
2e50: 20 62 65 20 63 68 61 6e 67 65 64 20 61 6e 64 20   be changed and 
2e60: 74 68 65 20 73 61 6d 65 20 5b 70 72 65 70 61 72  the same [prepar
2e70: 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 63 61  ed statement] ca
2e80: 6e 20 62 65 20 65 76 61 6c 75 61 74 65 64 0a 20  n be evaluated. 
2e90: 20 61 20 73 65 63 6f 6e 64 20 74 69 6d 65 20 75   a second time u
2ea0: 73 69 6e 67 20 74 68 65 20 6e 65 77 20 76 61 6c  sing the new val
2eb0: 75 65 73 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 20  ues..</p>..<p>. 
2ec0: 20 49 6e 20 53 51 4c 69 74 65 2c 20 77 68 65 72   In SQLite, wher
2ed0: 65 76 65 72 20 69 74 20 69 73 20 76 61 6c 69 64  ever it is valid
2ee0: 20 74 6f 20 69 6e 63 6c 75 64 65 20 61 20 73 74   to include a st
2ef0: 72 69 6e 67 20 6c 69 74 65 72 61 6c 2c 20 6f 6e  ring literal, on
2f00: 65 20 63 61 6e 20 75 73 65 0a 20 20 61 20 5b 70  e can use.  a [p
2f10: 61 72 61 6d 65 74 65 72 5d 20 69 6e 20 6f 6e 65  arameter] in one
2f20: 20 6f 66 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e   of the followin
2f30: 67 20 66 6f 72 6d 73 3a 0a 3c 2f 70 3e 0a 0a 3c  g forms:.</p>..<
2f40: 70 3e 3c 75 6c 3e 0a 20 20 3c 6c 69 3e 20 3c 62  p><ul>.  <li> <b
2f50: 3e 3f 3c 2f 62 3e 20 3c 2f 6c 69 3e 0a 20 20 3c  >?</b> </li>.  <
2f60: 6c 69 3e 20 3c 62 3e 3f 3c 2f 62 3e 3c 69 3e 4e  li> <b>?</b><i>N
2f70: 4e 4e 3c 2f 69 3e 20 3c 2f 6c 69 3e 0a 20 20 3c  NN</i> </li>.  <
2f80: 6c 69 3e 20 3c 62 3e 3a 3c 2f 62 3e 3c 69 3e 41  li> <b>:</b><i>A
2f90: 41 41 3c 2f 69 3e 20 3c 2f 6c 69 3e 0a 20 20 3c  AA</i> </li>.  <
2fa0: 6c 69 3e 20 3c 62 3e 24 3c 2f 62 3e 3c 69 3e 41  li> <b>$</b><i>A
2fb0: 41 41 3c 2f 69 3e 20 3c 2f 6c 69 3e 0a 20 20 3c  AA</i> </li>.  <
2fc0: 6c 69 3e 20 3c 62 3e 40 3c 2f 62 3e 3c 69 3e 41  li> <b>@</b><i>A
2fd0: 41 41 3c 2f 69 3e 20 3c 2f 6c 69 3e 0a 3c 2f 75  AA</i> </li>.</u
2fe0: 6c 3e 3c 2f 70 3e 0a 0a 3c 70 3e 0a 20 20 49 6e  l></p>..<p>.  In
2ff0: 20 74 68 65 20 65 78 61 6d 70 6c 65 73 20 61 62   the examples ab
3000: 6f 76 65 2c 20 3c 69 3e 4e 4e 4e 3c 2f 69 3e 20  ove, <i>NNN</i> 
3010: 69 73 20 61 6e 20 69 6e 74 65 67 65 72 20 76 61  is an integer va
3020: 6c 75 65 20 61 6e 64 0a 20 20 3c 69 3e 41 41 41  lue and.  <i>AAA
3030: 3c 2f 69 3e 20 69 73 20 61 6e 20 69 64 65 6e 74  </i> is an ident
3040: 69 66 69 65 72 2e 0a 20 20 41 20 70 61 72 61 6d  ifier..  A param
3050: 65 74 65 72 20 69 6e 69 74 69 61 6c 6c 79 20 68  eter initially h
3060: 61 73 20 61 20 76 61 6c 75 65 20 6f 66 20 4e 55  as a value of NU
3070: 4c 4c 2e 0a 20 20 50 72 69 6f 72 20 74 6f 20 63  LL..  Prior to c
3080: 61 6c 6c 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f  alling [sqlite3_
3090: 73 74 65 70 28 29 5d 20 66 6f 72 20 74 68 65 20  step()] for the 
30a0: 66 69 72 73 74 20 74 69 6d 65 20 6f 72 20 69 6d  first time or im
30b0: 6d 65 64 69 61 74 65 6c 79 0a 20 20 61 66 74 65  mediately.  afte
30c0: 72 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74  r [sqlite3_reset
30d0: 28 29 5d 2c 20 74 68 65 20 61 70 70 6c 69 63 61  ()], the applica
30e0: 74 69 6f 6e 20 63 61 6e 20 69 6e 76 6f 6b 65 20  tion can invoke 
30f0: 6f 6e 65 20 6f 66 20 74 68 65 0a 20 20 5b 73 71  one of the.  [sq
3100: 6c 69 74 65 33 5f 62 69 6e 64 5f 69 6e 74 20 7c  lite3_bind_int |
3110: 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 28 29 5d   sqlite3_bind()]
3120: 20 69 6e 74 65 72 66 61 63 65 73 20 74 6f 20 61   interfaces to a
3130: 74 74 61 63 68 20 76 61 6c 75 65 73 0a 20 20 74  ttach values.  t
3140: 6f 20 74 68 65 20 70 61 72 61 6d 65 74 65 72 73  o the parameters
3150: 2e 20 20 45 61 63 68 20 63 61 6c 6c 20 74 6f 20  .  Each call to 
3160: 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 69 6e  [sqlite3_bind_in
3170: 74 20 7c 20 73 71 6c 69 74 65 33 5f 62 69 6e 64  t | sqlite3_bind
3180: 28 29 5d 0a 20 20 6f 76 65 72 72 69 64 65 73 20  ()].  overrides 
3190: 70 72 69 6f 72 20 62 69 6e 64 69 6e 67 73 20 6f  prior bindings o
31a0: 6e 20 74 68 65 20 73 61 6d 65 20 70 61 72 61 6d  n the same param
31b0: 65 74 65 72 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a  eter..</p>..<p>.
31c0: 20 20 41 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e    An application
31d0: 20 69 73 20 61 6c 6c 6f 77 65 64 20 74 6f 20 70   is allowed to p
31e0: 72 65 70 61 72 65 20 6d 75 6c 74 69 70 6c 65 20  repare multiple 
31f0: 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 20 69  SQL statements i
3200: 6e 20 61 64 76 61 6e 63 65 0a 20 20 61 6e 64 20  n advance.  and 
3210: 65 76 61 6c 75 61 74 65 20 74 68 65 6d 20 61 73  evaluate them as
3220: 20 6e 65 65 64 65 64 2e 0a 20 20 54 68 65 72 65   needed..  There
3230: 20 69 73 20 6e 6f 20 61 72 62 69 74 72 61 72 79   is no arbitrary
3240: 20 6c 69 6d 69 74 20 74 6f 20 74 68 65 20 6e 75   limit to the nu
3250: 6d 62 65 72 20 6f 66 20 6f 75 74 73 74 61 6e 64  mber of outstand
3260: 69 6e 67 0a 20 20 5b 70 72 65 70 61 72 65 64 20  ing.  [prepared 
3270: 73 74 61 74 65 6d 65 6e 74 73 5d 2e 0a 3c 2f 70  statements]..</p
3280: 3e 0a 0a 3c 74 63 6c 3e 48 45 41 44 49 4e 47 20  >..<tcl>HEADING 
3290: 31 20 7b 45 78 74 65 6e 64 69 6e 67 20 53 51 4c  1 {Extending SQL
32a0: 69 74 65 7d 3c 2f 74 63 6c 3e 0a 0a 3c 70 3e 0a  ite}</tcl>..<p>.
32b0: 20 20 53 51 4c 69 74 65 20 69 6e 63 6c 75 64 65    SQLite include
32c0: 73 20 69 6e 74 65 72 66 61 63 65 73 20 74 68 61  s interfaces tha
32d0: 74 20 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f  t can be used to
32e0: 20 65 78 74 65 6e 64 20 69 74 73 20 66 75 6e 63   extend its func
32f0: 74 69 6f 6e 61 6c 69 74 79 2e 0a 20 20 53 75 63  tionality..  Suc
3300: 68 20 72 6f 75 74 69 6e 65 73 20 69 6e 63 6c 75  h routines inclu
3310: 64 65 3a 0a 3c 2f 70 3e 0a 0a 3c 70 3e 3c 75 6c  de:.</p>..<p><ul
3320: 3e 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c 69 74 65  >.  <li> [sqlite
3330: 33 5f 63 72 65 61 74 65 5f 63 6f 6c 6c 61 74 69  3_create_collati
3340: 6f 6e 28 29 5d 20 3c 2f 6c 69 3e 0a 20 20 3c 6c  on()] </li>.  <l
3350: 69 3e 20 5b 73 71 6c 69 74 65 33 5f 63 72 65 61  i> [sqlite3_crea
3360: 74 65 5f 66 75 6e 63 74 69 6f 6e 28 29 5d 20 3c  te_function()] <
3370: 2f 6c 69 3e 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c  /li>.  <li> [sql
3380: 69 74 65 33 5f 63 72 65 61 74 65 5f 6d 6f 64 75  ite3_create_modu
3390: 6c 65 28 29 5d 20 3c 2f 6c 69 3e 0a 3c 2f 75 6c  le()] </li>.</ul
33a0: 3e 3c 2f 70 3e 0a 0a 3c 70 3e 0a 20 20 54 68 65  ></p>..<p>.  The
33b0: 20 5b 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65   [sqlite3_create
33c0: 5f 63 6f 6c 6c 61 74 69 6f 6e 28 29 5d 20 69 6e  _collation()] in
33d0: 74 65 72 66 61 63 65 20 69 73 20 75 73 65 64 20  terface is used 
33e0: 74 6f 20 63 72 65 61 74 65 20 6e 65 77 0a 20 20  to create new.  
33f0: 63 6f 6c 6c 61 74 69 6e 67 20 73 65 71 75 65 6e  collating sequen
3400: 63 65 73 20 66 6f 72 20 73 6f 72 74 69 6e 67 20  ces for sorting 
3410: 74 65 78 74 2e 0a 20 20 54 68 65 20 5b 73 71 6c  text..  The [sql
3420: 69 74 65 33 5f 63 72 65 61 74 65 5f 6d 6f 64 75  ite3_create_modu
3430: 6c 65 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20  le()] interface 
3440: 69 73 20 75 73 65 64 20 74 6f 20 72 65 67 69 73  is used to regis
3450: 74 65 72 20 6e 65 77 0a 20 20 76 69 72 74 75 61  ter new.  virtua
3460: 6c 20 74 61 62 6c 65 20 69 6d 70 6c 65 6d 65 6e  l table implemen
3470: 74 61 74 69 6f 6e 73 2e 0a 3c 2f 70 3e 0a 0a 3c  tations..</p>..<
3480: 70 3e 0a 20 20 54 68 65 20 5b 73 71 6c 69 74 65  p>.  The [sqlite
3490: 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f  3_create_functio
34a0: 6e 28 29 5d 20 69 6e 74 65 72 66 61 63 65 20 63  n()] interface c
34b0: 72 65 61 74 65 73 20 6e 65 77 20 53 51 4c 20 66  reates new SQL f
34c0: 75 6e 63 74 69 6f 6e 73 20 2d 20 0a 20 20 65 69  unctions - .  ei
34d0: 74 68 65 72 20 73 63 61 6c 61 72 20 6f 72 20 61  ther scalar or a
34e0: 67 67 72 65 67 61 74 65 2e 20 20 54 68 65 20 6e  ggregate.  The n
34f0: 65 77 20 66 75 6e 63 74 69 6f 6e 20 69 6d 70 6c  ew function impl
3500: 65 6d 65 6e 74 61 74 69 6f 6e 20 74 79 70 69 63  ementation typic
3510: 61 6c 6c 79 0a 20 20 6d 61 6b 65 73 20 75 73 65  ally.  makes use
3520: 20 6f 66 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e   of the followin
3530: 67 20 61 64 64 69 74 69 6f 6e 61 6c 20 69 6e 74  g additional int
3540: 65 72 66 61 63 65 73 3a 0a 3c 2f 70 3e 0a 0a 3c  erfaces:.</p>..<
3550: 70 3e 3c 75 6c 3e 0a 20 20 3c 6c 69 3e 20 5b 73  p><ul>.  <li> [s
3560: 71 6c 69 74 65 33 5f 61 67 67 72 65 67 61 74 65  qlite3_aggregate
3570: 5f 63 6f 6e 74 65 78 74 28 29 5d 20 3c 2f 6c 69  _context()] </li
3580: 3e 0a 20 20 3c 6c 69 3e 20 5b 73 71 6c 69 74 65  >.  <li> [sqlite
3590: 33 5f 72 65 73 75 6c 74 5f 69 6e 74 20 7c 20 73  3_result_int | s
35a0: 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 28 29 5d  qlite3_result()]
35b0: 20 3c 2f 6c 69 3e 0a 20 20 3c 6c 69 3e 20 5b 73   </li>.  <li> [s
35c0: 71 6c 69 74 65 33 5f 75 73 65 72 5f 64 61 74 61  qlite3_user_data
35d0: 28 29 5d 20 3c 2f 6c 69 3e 0a 20 20 3c 6c 69 3e  ()] </li>.  <li>
35e0: 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f   [sqlite3_value_
35f0: 69 6e 74 20 7c 20 73 71 6c 69 74 65 33 5f 76 61  int | sqlite3_va
3600: 6c 75 65 28 29 5d 20 3c 2f 6c 69 3e 0a 3c 2f 75  lue()] </li>.</u
3610: 6c 3e 3c 2f 70 3e 0a 0a 3c 70 3e 0a 20 20 41 6c  l></p>..<p>.  Al
3620: 6c 20 6f 66 20 74 68 65 20 62 75 69 6c 74 2d 69  l of the built-i
3630: 6e 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20  n SQL functions 
3640: 6f 66 20 53 51 4c 69 74 65 20 61 72 65 20 63 72  of SQLite are cr
3650: 65 61 74 65 64 20 75 73 69 6e 67 20 65 78 61 63  eated using exac
3660: 74 6c 79 0a 20 20 74 68 65 73 65 20 73 61 6d 65  tly.  these same
3670: 20 69 6e 74 65 72 66 61 63 65 73 2e 20 20 52 65   interfaces.  Re
3680: 66 65 72 20 74 6f 20 74 68 65 20 53 51 4c 69 74  fer to the SQLit
3690: 65 20 73 6f 75 72 63 65 20 63 6f 64 65 2c 20 61  e source code, a
36a0: 6e 64 20 69 6e 20 70 61 72 74 69 63 75 6c 61 72  nd in particular
36b0: 0a 20 20 74 68 65 20 3c 62 3e 64 61 74 65 2e 63  .  the <b>date.c
36c0: 3c 2f 62 3e 20 61 6e 64 20 3c 62 3e 66 75 6e 63  </b> and <b>func
36d0: 2e 63 3c 2f 62 3e 20 73 6f 75 72 63 65 20 66 69  .c</b> source fi
36e0: 6c 65 73 20 66 6f 72 20 65 78 61 6d 70 6c 65 73  les for examples
36f0: 2e 0a 3c 2f 70 3e 0a 0a 3c 74 63 6c 3e 48 45 41  ..</p>..<tcl>HEA
3700: 44 49 4e 47 20 31 20 7b 4f 74 68 65 72 20 49 6e  DING 1 {Other In
3710: 74 65 72 66 61 63 65 73 7d 3c 2f 74 63 6c 3e 0a  terfaces}</tcl>.
3720: 0a 3c 70 3e 0a 20 20 54 68 69 73 20 61 72 74 69  .<p>.  This arti
3730: 63 6c 65 20 6f 6e 6c 79 20 6d 65 6e 74 69 6f 6e  cle only mention
3740: 73 20 74 68 65 20 66 6f 75 6e 64 61 74 69 6f 6e  s the foundation
3750: 61 6c 20 53 51 4c 69 74 65 20 69 6e 74 65 72 66  al SQLite interf
3760: 61 63 65 73 2e 0a 20 20 54 68 65 20 53 51 4c 69  aces..  The SQLi
3770: 74 65 20 6c 69 62 72 61 72 79 20 69 6e 63 6c 75  te library inclu
3780: 64 65 73 20 6d 61 6e 79 20 6f 74 68 65 72 20 41  des many other A
3790: 50 49 73 20 69 6d 70 6c 65 6d 65 6e 74 69 6e 67  PIs implementing
37a0: 20 75 73 65 66 75 6c 0a 20 20 66 65 61 74 75 72   useful.  featur
37b0: 65 73 20 74 68 61 74 20 61 72 65 20 6e 6f 74 20  es that are not 
37c0: 64 65 73 63 72 69 62 65 64 20 68 65 72 65 2e 20  described here. 
37d0: 20 0a 20 20 41 20 5b 63 61 70 69 33 72 65 66 5f   .  A [capi3ref_
37e0: 66 75 6e 63 6c 69 73 74 20 7c 20 63 6f 6d 70 6c  funclist | compl
37f0: 65 74 65 20 6c 69 73 74 20 6f 66 20 66 75 6e 63  ete list of func
3800: 74 69 6f 6e 73 5d 20 74 68 61 74 20 66 6f 72 6d  tions] that form
3810: 20 74 68 65 20 53 51 4c 69 74 65 0a 20 20 61 70   the SQLite.  ap
3820: 70 6c 69 63 61 74 69 6f 6e 20 70 72 6f 67 72 61  plication progra
3830: 6d 6d 69 6e 67 20 69 6e 74 65 72 66 61 63 65 20  mming interface 
3840: 69 73 20 66 6f 75 6e 64 20 61 74 20 74 68 65 0a  is found at the.
3850: 20 20 5b 63 61 70 69 33 72 65 66 20 7c 20 43 2f    [capi3ref | C/
3860: 43 2b 2b 20 49 6e 74 65 72 66 61 63 65 20 53 70  C++ Interface Sp
3870: 65 63 69 66 69 63 61 74 69 6f 6e 5d 2e 0a 20 20  ecification]..  
3880: 52 65 66 65 72 20 74 6f 20 74 68 61 74 20 64 6f  Refer to that do
3890: 63 75 6d 65 6e 74 20 66 6f 72 20 63 6f 6d 70 6c  cument for compl
38a0: 65 74 65 20 61 6e 64 20 61 75 74 68 6f 72 69 74  ete and authorit
38b0: 61 74 69 76 65 20 69 6e 66 6f 72 6d 61 74 69 6f  ative informatio
38c0: 6e 20 61 62 6f 75 74 0a 20 20 61 6c 6c 20 53 51  n about.  all SQ
38d0: 4c 69 74 65 20 69 6e 74 65 72 66 61 63 65 73 2e  Lite interfaces.
38e0: 0a 3c 2f 70 3e 0a                                .</p>.