/ Hex Artifact Content
Login
SQLite training in Houston TX on 2019-11-05 (details)
Part of the 2019 Tcl Conference

Artifact 584410ebff31c8d1ca7cac5ddc9f0fa00e9b21c8:


0000: 2f 2a 0a 2a 2a 20 32 30 30 31 20 53 65 70 74 65  /*.** 2001 Septe
0010: 6d 62 65 72 20 31 35 0a 2a 2a 0a 2a 2a 20 54 68  mber 15.**.** Th
0020: 65 20 61 75 74 68 6f 72 20 64 69 73 63 6c 61 69  e author disclai
0030: 6d 73 20 63 6f 70 79 72 69 67 68 74 20 74 6f 20  ms copyright to 
0040: 74 68 69 73 20 73 6f 75 72 63 65 20 63 6f 64 65  this source code
0050: 2e 20 20 49 6e 20 70 6c 61 63 65 20 6f 66 0a 2a  .  In place of.*
0060: 2a 20 61 20 6c 65 67 61 6c 20 6e 6f 74 69 63 65  * a legal notice
0070: 2c 20 68 65 72 65 20 69 73 20 61 20 62 6c 65 73  , here is a bles
0080: 73 69 6e 67 3a 0a 2a 2a 0a 2a 2a 20 20 20 20 4d  sing:.**.**    M
0090: 61 79 20 79 6f 75 20 64 6f 20 67 6f 6f 64 20 61  ay you do good a
00a0: 6e 64 20 6e 6f 74 20 65 76 69 6c 2e 0a 2a 2a 20  nd not evil..** 
00b0: 20 20 20 4d 61 79 20 79 6f 75 20 66 69 6e 64 20     May you find 
00c0: 66 6f 72 67 69 76 65 6e 65 73 73 20 66 6f 72 20  forgiveness for 
00d0: 79 6f 75 72 73 65 6c 66 20 61 6e 64 20 66 6f 72  yourself and for
00e0: 67 69 76 65 20 6f 74 68 65 72 73 2e 0a 2a 2a 20  give others..** 
00f0: 20 20 20 4d 61 79 20 79 6f 75 20 73 68 61 72 65     May you share
0100: 20 66 72 65 65 6c 79 2c 20 6e 65 76 65 72 20 74   freely, never t
0110: 61 6b 69 6e 67 20 6d 6f 72 65 20 74 68 61 6e 20  aking more than 
0120: 79 6f 75 20 67 69 76 65 2e 0a 2a 2a 0a 2a 2a 2a  you give..**.***
0130: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0140: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0150: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0160: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0170: 2a 2a 2a 2a 2a 2a 0a 2a 2a 20 54 68 69 73 20 68  ******.** This h
0180: 65 61 64 65 72 20 66 69 6c 65 20 64 65 66 69 6e  eader file defin
0190: 65 73 20 74 68 65 20 69 6e 74 65 72 66 61 63 65  es the interface
01a0: 20 74 68 61 74 20 74 68 65 20 53 51 4c 69 74 65   that the SQLite
01b0: 20 6c 69 62 72 61 72 79 0a 2a 2a 20 70 72 65 73   library.** pres
01c0: 65 6e 74 73 20 74 6f 20 63 6c 69 65 6e 74 20 70  ents to client p
01d0: 72 6f 67 72 61 6d 73 2e 20 20 49 66 20 61 20 43  rograms.  If a C
01e0: 2d 66 75 6e 63 74 69 6f 6e 2c 20 73 74 72 75 63  -function, struc
01f0: 74 75 72 65 2c 20 64 61 74 61 74 79 70 65 2c 0a  ture, datatype,.
0200: 2a 2a 20 6f 72 20 63 6f 6e 73 74 61 6e 74 20 64  ** or constant d
0210: 65 66 69 6e 69 74 69 6f 6e 20 64 6f 65 73 20 6e  efinition does n
0220: 6f 74 20 61 70 70 65 61 72 20 69 6e 20 74 68 69  ot appear in thi
0230: 73 20 66 69 6c 65 2c 20 74 68 65 6e 20 69 74 20  s file, then it 
0240: 69 73 0a 2a 2a 20 6e 6f 74 20 61 20 70 75 62 6c  is.** not a publ
0250: 69 73 68 65 64 20 41 50 49 20 6f 66 20 53 51 4c  ished API of SQL
0260: 69 74 65 2c 20 69 73 20 73 75 62 6a 65 63 74 20  ite, is subject 
0270: 74 6f 20 63 68 61 6e 67 65 20 77 69 74 68 6f 75  to change withou
0280: 74 0a 2a 2a 20 6e 6f 74 69 63 65 2c 20 61 6e 64  t.** notice, and
0290: 20 73 68 6f 75 6c 64 20 6e 6f 74 20 62 65 20 72   should not be r
02a0: 65 66 65 72 65 6e 63 65 64 20 62 79 20 70 72 6f  eferenced by pro
02b0: 67 72 61 6d 73 20 74 68 61 74 20 75 73 65 20 53  grams that use S
02c0: 51 4c 69 74 65 2e 0a 2a 2a 0a 2a 2a 20 53 6f 6d  QLite..**.** Som
02d0: 65 20 6f 66 20 74 68 65 20 64 65 66 69 6e 69 74  e of the definit
02e0: 69 6f 6e 73 20 74 68 61 74 20 61 72 65 20 69 6e  ions that are in
02f0: 20 74 68 69 73 20 66 69 6c 65 20 61 72 65 20 6d   this file are m
0300: 61 72 6b 65 64 20 61 73 0a 2a 2a 20 22 65 78 70  arked as.** "exp
0310: 65 72 69 6d 65 6e 74 61 6c 22 2e 20 20 45 78 70  erimental".  Exp
0320: 65 72 69 6d 65 6e 74 61 6c 20 69 6e 74 65 72 66  erimental interf
0330: 61 63 65 73 20 61 72 65 20 6e 6f 72 6d 61 6c 6c  aces are normall
0340: 79 20 6e 65 77 0a 2a 2a 20 66 65 61 74 75 72 65  y new.** feature
0350: 73 20 72 65 63 65 6e 74 6c 79 20 61 64 64 65 64  s recently added
0360: 20 74 6f 20 53 51 4c 69 74 65 2e 20 20 57 65 20   to SQLite.  We 
0370: 64 6f 20 6e 6f 74 20 61 6e 74 69 63 69 70 61 74  do not anticipat
0380: 65 20 63 68 61 6e 67 65 73 0a 2a 2a 20 74 6f 20  e changes.** to 
0390: 65 78 70 65 72 69 6d 65 6e 74 61 6c 20 69 6e 74  experimental int
03a0: 65 72 66 61 63 65 73 20 62 75 74 20 72 65 73 65  erfaces but rese
03b0: 72 76 65 20 74 68 65 20 72 69 67 68 74 20 74 6f  rve the right to
03c0: 20 6d 61 6b 65 20 6d 69 6e 6f 72 20 63 68 61 6e   make minor chan
03d0: 67 65 73 0a 2a 2a 20 69 66 20 65 78 70 65 72 69  ges.** if experi
03e0: 65 6e 63 65 20 66 72 6f 6d 20 75 73 65 20 22 69  ence from use "i
03f0: 6e 20 74 68 65 20 77 69 6c 64 22 20 73 75 67 67  n the wild" sugg
0400: 65 73 74 20 73 75 63 68 20 63 68 61 6e 67 65 73  est such changes
0410: 20 61 72 65 20 70 72 75 64 65 6e 74 2e 0a 2a 2a   are prudent..**
0420: 0a 2a 2a 20 54 68 65 20 6f 66 66 69 63 69 61 6c  .** The official
0430: 20 43 2d 6c 61 6e 67 75 61 67 65 20 41 50 49 20   C-language API 
0440: 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 6f  documentation fo
0450: 72 20 53 51 4c 69 74 65 20 69 73 20 64 65 72 69  r SQLite is deri
0460: 76 65 64 0a 2a 2a 20 66 72 6f 6d 20 63 6f 6d 6d  ved.** from comm
0470: 65 6e 74 73 20 69 6e 20 74 68 69 73 20 66 69 6c  ents in this fil
0480: 65 2e 20 20 54 68 69 73 20 66 69 6c 65 20 69 73  e.  This file is
0490: 20 74 68 65 20 61 75 74 68 6f 72 69 74 61 74 69   the authoritati
04a0: 76 65 20 73 6f 75 72 63 65 0a 2a 2a 20 6f 6e 20  ve source.** on 
04b0: 68 6f 77 20 53 51 4c 69 74 65 20 69 6e 74 65 72  how SQLite inter
04c0: 66 61 63 65 73 20 61 72 65 20 73 75 70 70 6f 73  faces are suppos
04d0: 65 20 74 6f 20 6f 70 65 72 61 74 65 2e 0a 2a 2a  e to operate..**
04e0: 0a 2a 2a 20 54 68 65 20 6e 61 6d 65 20 6f 66 20  .** The name of 
04f0: 74 68 69 73 20 66 69 6c 65 20 75 6e 64 65 72 20  this file under 
0500: 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d 61  configuration ma
0510: 6e 61 67 65 6d 65 6e 74 20 69 73 20 22 73 71 6c  nagement is "sql
0520: 69 74 65 2e 68 2e 69 6e 22 2e 0a 2a 2a 20 54 68  ite.h.in"..** Th
0530: 65 20 6d 61 6b 65 66 69 6c 65 20 6d 61 6b 65 73  e makefile makes
0540: 20 73 6f 6d 65 20 6d 69 6e 6f 72 20 63 68 61 6e   some minor chan
0550: 67 65 73 20 74 6f 20 74 68 69 73 20 66 69 6c 65  ges to this file
0560: 20 28 73 75 63 68 20 61 73 20 69 6e 73 65 72 74   (such as insert
0570: 69 6e 67 0a 2a 2a 20 74 68 65 20 76 65 72 73 69  ing.** the versi
0580: 6f 6e 20 6e 75 6d 62 65 72 29 20 61 6e 64 20 63  on number) and c
0590: 68 61 6e 67 65 73 20 69 74 73 20 6e 61 6d 65 20  hanges its name 
05a0: 74 6f 20 22 73 71 6c 69 74 65 33 2e 68 22 20 61  to "sqlite3.h" a
05b0: 73 0a 2a 2a 20 70 61 72 74 20 6f 66 20 74 68 65  s.** part of the
05c0: 20 62 75 69 6c 64 20 70 72 6f 63 65 73 73 2e 0a   build process..
05d0: 2a 2f 0a 23 69 66 6e 64 65 66 20 5f 53 51 4c 49  */.#ifndef _SQLI
05e0: 54 45 33 5f 48 5f 0a 23 64 65 66 69 6e 65 20 5f  TE3_H_.#define _
05f0: 53 51 4c 49 54 45 33 5f 48 5f 0a 23 69 6e 63 6c  SQLITE3_H_.#incl
0600: 75 64 65 20 3c 73 74 64 61 72 67 2e 68 3e 20 20  ude <stdarg.h>  
0610: 20 20 20 2f 2a 20 4e 65 65 64 65 64 20 66 6f 72     /* Needed for
0620: 20 74 68 65 20 64 65 66 69 6e 69 74 69 6f 6e 20   the definition 
0630: 6f 66 20 76 61 5f 6c 69 73 74 20 2a 2f 0a 0a 2f  of va_list */../
0640: 2a 0a 2a 2a 20 4d 61 6b 65 20 73 75 72 65 20 77  *.** Make sure w
0650: 65 20 63 61 6e 20 63 61 6c 6c 20 74 68 69 73 20  e can call this 
0660: 73 74 75 66 66 20 66 72 6f 6d 20 43 2b 2b 2e 0a  stuff from C++..
0670: 2a 2f 0a 23 69 66 64 65 66 20 5f 5f 63 70 6c 75  */.#ifdef __cplu
0680: 73 70 6c 75 73 0a 65 78 74 65 72 6e 20 22 43 22  splus.extern "C"
0690: 20 7b 0a 23 65 6e 64 69 66 0a 0a 0a 2f 2a 0a 2a   {.#endif.../*.*
06a0: 2a 20 41 64 64 20 74 68 65 20 61 62 69 6c 69 74  * Add the abilit
06b0: 79 20 74 6f 20 6f 76 65 72 72 69 64 65 20 27 65  y to override 'e
06c0: 78 74 65 72 6e 27 0a 2a 2f 0a 23 69 66 6e 64 65  xtern'.*/.#ifnde
06d0: 66 20 53 51 4c 49 54 45 5f 45 58 54 45 52 4e 0a  f SQLITE_EXTERN.
06e0: 23 20 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  # define SQLITE_
06f0: 45 58 54 45 52 4e 20 65 78 74 65 72 6e 0a 23 65  EXTERN extern.#e
0700: 6e 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 54 68 65 73  ndif../*.** Thes
0710: 65 20 6e 6f 2d 6f 70 20 6d 61 63 72 6f 73 20 61  e no-op macros a
0720: 72 65 20 75 73 65 64 20 69 6e 20 66 72 6f 6e 74  re used in front
0730: 20 6f 66 20 69 6e 74 65 72 66 61 63 65 73 20 74   of interfaces t
0740: 6f 20 6d 61 72 6b 20 74 68 6f 73 65 0a 2a 2a 20  o mark those.** 
0750: 69 6e 74 65 72 66 61 63 65 73 20 61 73 20 65 69  interfaces as ei
0760: 74 68 65 72 20 64 65 70 72 65 63 61 74 65 64 20  ther deprecated 
0770: 6f 72 20 65 78 70 65 72 69 6d 65 6e 74 61 6c 2e  or experimental.
0780: 20 20 4e 65 77 20 61 70 70 6c 69 63 61 74 69 6f    New applicatio
0790: 6e 73 0a 2a 2a 20 73 68 6f 75 6c 64 20 6e 6f 74  ns.** should not
07a0: 20 75 73 65 20 64 65 70 72 65 63 61 74 65 64 20   use deprecated 
07b0: 69 6e 74 65 72 66 61 63 65 73 20 2d 20 74 68 65  interfaces - the
07c0: 79 20 61 72 65 20 73 75 70 70 6f 72 74 20 66 6f  y are support fo
07d0: 72 20 62 61 63 6b 77 61 72 64 73 0a 2a 2a 20 63  r backwards.** c
07e0: 6f 6d 70 61 74 69 62 69 6c 69 74 79 20 6f 6e 6c  ompatibility onl
07f0: 79 2e 20 20 41 70 70 6c 69 63 61 74 69 6f 6e 20  y.  Application 
0800: 77 72 69 74 65 72 73 20 73 68 6f 75 6c 64 20 62  writers should b
0810: 65 20 61 77 61 72 65 20 74 68 61 74 0a 2a 2a 20  e aware that.** 
0820: 65 78 70 65 72 69 6d 65 6e 74 61 6c 20 69 6e 74  experimental int
0830: 65 72 66 61 63 65 73 20 61 72 65 20 73 75 62 6a  erfaces are subj
0840: 65 63 74 20 74 6f 20 63 68 61 6e 67 65 20 69 6e  ect to change in
0850: 20 70 6f 69 6e 74 20 72 65 6c 65 61 73 65 73 2e   point releases.
0860: 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 6d 61 63  .**.** These mac
0870: 72 6f 73 20 75 73 65 64 20 74 6f 20 72 65 73 6f  ros used to reso
0880: 6c 76 65 20 74 6f 20 76 61 72 69 6f 75 73 20 6b  lve to various k
0890: 69 6e 64 73 20 6f 66 20 63 6f 6d 70 69 6c 65 72  inds of compiler
08a0: 20 6d 61 67 69 63 20 74 68 61 74 0a 2a 2a 20 77   magic that.** w
08b0: 6f 75 6c 64 20 67 65 6e 65 72 61 74 65 20 77 61  ould generate wa
08c0: 72 6e 69 6e 67 20 6d 65 73 73 61 67 65 73 20 77  rning messages w
08d0: 68 65 6e 20 74 68 65 79 20 77 65 72 65 20 75 73  hen they were us
08e0: 65 64 2e 20 20 42 75 74 20 74 68 61 74 0a 2a 2a  ed.  But that.**
08f0: 20 63 6f 6d 70 69 6c 65 72 20 6d 61 67 69 63 20   compiler magic 
0900: 65 6e 64 65 64 20 75 70 20 67 65 6e 65 72 61 74  ended up generat
0910: 69 6e 67 20 73 75 63 68 20 61 20 66 6c 75 72 72  ing such a flurr
0920: 79 20 6f 66 20 62 75 67 20 72 65 70 6f 72 74 73  y of bug reports
0930: 0a 2a 2a 20 74 68 61 74 20 77 65 20 68 61 76 65  .** that we have
0940: 20 74 61 6b 65 6e 20 69 74 20 61 6c 6c 20 6f 75   taken it all ou
0950: 74 20 61 6e 64 20 67 6f 6e 65 20 62 61 63 6b 20  t and gone back 
0960: 74 6f 20 75 73 69 6e 67 20 73 69 6d 70 6c 65 0a  to using simple.
0970: 2a 2a 20 6e 6f 6f 70 20 6d 61 63 72 6f 73 2e 0a  ** noop macros..
0980: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
0990: 45 5f 44 45 50 52 45 43 41 54 45 44 0a 23 64 65  E_DEPRECATED.#de
09a0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 45 58 50 45  fine SQLITE_EXPE
09b0: 52 49 4d 45 4e 54 41 4c 0a 0a 2f 2a 0a 2a 2a 20  RIMENTAL../*.** 
09c0: 45 6e 73 75 72 65 20 74 68 65 73 65 20 73 79 6d  Ensure these sym
09d0: 62 6f 6c 73 20 77 65 72 65 20 6e 6f 74 20 64 65  bols were not de
09e0: 66 69 6e 65 64 20 62 79 20 73 6f 6d 65 20 70 72  fined by some pr
09f0: 65 76 69 6f 75 73 20 68 65 61 64 65 72 20 66 69  evious header fi
0a00: 6c 65 2e 0a 2a 2f 0a 23 69 66 64 65 66 20 53 51  le..*/.#ifdef SQ
0a10: 4c 49 54 45 5f 56 45 52 53 49 4f 4e 0a 23 20 75  LITE_VERSION.# u
0a20: 6e 64 65 66 20 53 51 4c 49 54 45 5f 56 45 52 53  ndef SQLITE_VERS
0a30: 49 4f 4e 0a 23 65 6e 64 69 66 0a 23 69 66 64 65  ION.#endif.#ifde
0a40: 66 20 53 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e  f SQLITE_VERSION
0a50: 5f 4e 55 4d 42 45 52 0a 23 20 75 6e 64 65 66 20  _NUMBER.# undef 
0a60: 53 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e 5f 4e  SQLITE_VERSION_N
0a70: 55 4d 42 45 52 0a 23 65 6e 64 69 66 0a 0a 2f 2a  UMBER.#endif../*
0a80: 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6f  .** CAPI3REF: Co
0a90: 6d 70 69 6c 65 2d 54 69 6d 65 20 4c 69 62 72 61  mpile-Time Libra
0aa0: 72 79 20 56 65 72 73 69 6f 6e 20 4e 75 6d 62 65  ry Version Numbe
0ab0: 72 73 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20 5b  rs.**.** ^(The [
0ac0: 53 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e 5d 20  SQLITE_VERSION] 
0ad0: 43 20 70 72 65 70 72 6f 63 65 73 73 6f 72 20 6d  C preprocessor m
0ae0: 61 63 72 6f 20 69 6e 20 74 68 65 20 73 71 6c 69  acro in the sqli
0af0: 74 65 33 2e 68 20 68 65 61 64 65 72 0a 2a 2a 20  te3.h header.** 
0b00: 65 76 61 6c 75 61 74 65 73 20 74 6f 20 61 20 73  evaluates to a s
0b10: 74 72 69 6e 67 20 6c 69 74 65 72 61 6c 20 74 68  tring literal th
0b20: 61 74 20 69 73 20 74 68 65 20 53 51 4c 69 74 65  at is the SQLite
0b30: 20 76 65 72 73 69 6f 6e 20 69 6e 20 74 68 65 0a   version in the.
0b40: 2a 2a 20 66 6f 72 6d 61 74 20 22 58 2e 59 2e 5a  ** format "X.Y.Z
0b50: 22 20 77 68 65 72 65 20 58 20 69 73 20 74 68 65  " where X is the
0b60: 20 6d 61 6a 6f 72 20 76 65 72 73 69 6f 6e 20 6e   major version n
0b70: 75 6d 62 65 72 20 28 61 6c 77 61 79 73 20 33 20  umber (always 3 
0b80: 66 6f 72 0a 2a 2a 20 53 51 4c 69 74 65 33 29 20  for.** SQLite3) 
0b90: 61 6e 64 20 59 20 69 73 20 74 68 65 20 6d 69 6e  and Y is the min
0ba0: 6f 72 20 76 65 72 73 69 6f 6e 20 6e 75 6d 62 65  or version numbe
0bb0: 72 20 61 6e 64 20 5a 20 69 73 20 74 68 65 20 72  r and Z is the r
0bc0: 65 6c 65 61 73 65 20 6e 75 6d 62 65 72 2e 29 5e  elease number.)^
0bd0: 0a 2a 2a 20 5e 28 54 68 65 20 5b 53 51 4c 49 54  .** ^(The [SQLIT
0be0: 45 5f 56 45 52 53 49 4f 4e 5f 4e 55 4d 42 45 52  E_VERSION_NUMBER
0bf0: 5d 20 43 20 70 72 65 70 72 6f 63 65 73 73 6f 72  ] C preprocessor
0c00: 20 6d 61 63 72 6f 20 72 65 73 6f 6c 76 65 73 20   macro resolves 
0c10: 74 6f 20 61 6e 20 69 6e 74 65 67 65 72 0a 2a 2a  to an integer.**
0c20: 20 77 69 74 68 20 74 68 65 20 76 61 6c 75 65 20   with the value 
0c30: 28 58 2a 31 30 30 30 30 30 30 20 2b 20 59 2a 31  (X*1000000 + Y*1
0c40: 30 30 30 20 2b 20 5a 29 20 77 68 65 72 65 20 58  000 + Z) where X
0c50: 2c 20 59 2c 20 61 6e 64 20 5a 20 61 72 65 20 74  , Y, and Z are t
0c60: 68 65 20 73 61 6d 65 0a 2a 2a 20 6e 75 6d 62 65  he same.** numbe
0c70: 72 73 20 75 73 65 64 20 69 6e 20 5b 53 51 4c 49  rs used in [SQLI
0c80: 54 45 5f 56 45 52 53 49 4f 4e 5d 2e 29 5e 0a 2a  TE_VERSION].)^.*
0c90: 2a 20 54 68 65 20 53 51 4c 49 54 45 5f 56 45 52  * The SQLITE_VER
0ca0: 53 49 4f 4e 5f 4e 55 4d 42 45 52 20 66 6f 72 20  SION_NUMBER for 
0cb0: 61 6e 79 20 67 69 76 65 6e 20 72 65 6c 65 61 73  any given releas
0cc0: 65 20 6f 66 20 53 51 4c 69 74 65 20 77 69 6c 6c  e of SQLite will
0cd0: 20 61 6c 73 6f 0a 2a 2a 20 62 65 20 6c 61 72 67   also.** be larg
0ce0: 65 72 20 74 68 61 6e 20 74 68 65 20 72 65 6c 65  er than the rele
0cf0: 61 73 65 20 66 72 6f 6d 20 77 68 69 63 68 20 69  ase from which i
0d00: 74 20 69 73 20 64 65 72 69 76 65 64 2e 20 20 45  t is derived.  E
0d10: 69 74 68 65 72 20 59 20 77 69 6c 6c 0a 2a 2a 20  ither Y will.** 
0d20: 62 65 20 68 65 6c 64 20 63 6f 6e 73 74 61 6e 74  be held constant
0d30: 20 61 6e 64 20 5a 20 77 69 6c 6c 20 62 65 20 69   and Z will be i
0d40: 6e 63 72 65 6d 65 6e 74 65 64 20 6f 72 20 65 6c  ncremented or el
0d50: 73 65 20 59 20 77 69 6c 6c 20 62 65 20 69 6e 63  se Y will be inc
0d60: 72 65 6d 65 6e 74 65 64 0a 2a 2a 20 61 6e 64 20  remented.** and 
0d70: 5a 20 77 69 6c 6c 20 62 65 20 72 65 73 65 74 20  Z will be reset 
0d80: 74 6f 20 7a 65 72 6f 2e 0a 2a 2a 0a 2a 2a 20 53  to zero..**.** S
0d90: 69 6e 63 65 20 76 65 72 73 69 6f 6e 20 33 2e 36  ince version 3.6
0da0: 2e 31 38 2c 20 53 51 4c 69 74 65 20 73 6f 75 72  .18, SQLite sour
0db0: 63 65 20 63 6f 64 65 20 68 61 73 20 62 65 65 6e  ce code has been
0dc0: 20 73 74 6f 72 65 64 20 69 6e 20 74 68 65 0a 2a   stored in the.*
0dd0: 2a 20 3c 61 20 68 72 65 66 3d 22 68 74 74 70 3a  * <a href="http:
0de0: 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 6d  //www.fossil-scm
0df0: 2e 6f 72 67 2f 22 3e 46 6f 73 73 69 6c 20 63 6f  .org/">Fossil co
0e00: 6e 66 69 67 75 72 61 74 69 6f 6e 20 6d 61 6e 61  nfiguration mana
0e10: 67 65 6d 65 6e 74 0a 2a 2a 20 73 79 73 74 65 6d  gement.** system
0e20: 3c 2f 61 3e 2e 20 20 5e 54 68 65 20 53 51 4c 49  </a>.  ^The SQLI
0e30: 54 45 5f 53 4f 55 52 43 45 5f 49 44 20 6d 61 63  TE_SOURCE_ID mac
0e40: 72 6f 20 65 76 61 6c 75 61 74 65 73 20 74 6f 0a  ro evaluates to.
0e50: 2a 2a 20 61 20 73 74 72 69 6e 67 20 77 68 69 63  ** a string whic
0e60: 68 20 69 64 65 6e 74 69 66 69 65 73 20 61 20 70  h identifies a p
0e70: 61 72 74 69 63 75 6c 61 72 20 63 68 65 63 6b 2d  articular check-
0e80: 69 6e 20 6f 66 20 53 51 4c 69 74 65 0a 2a 2a 20  in of SQLite.** 
0e90: 77 69 74 68 69 6e 20 69 74 73 20 63 6f 6e 66 69  within its confi
0ea0: 67 75 72 61 74 69 6f 6e 20 6d 61 6e 61 67 65 6d  guration managem
0eb0: 65 6e 74 20 73 79 73 74 65 6d 2e 20 20 5e 54 68  ent system.  ^Th
0ec0: 65 20 53 51 4c 49 54 45 5f 53 4f 55 52 43 45 5f  e SQLITE_SOURCE_
0ed0: 49 44 0a 2a 2a 20 73 74 72 69 6e 67 20 63 6f 6e  ID.** string con
0ee0: 74 61 69 6e 73 20 74 68 65 20 64 61 74 65 20 61  tains the date a
0ef0: 6e 64 20 74 69 6d 65 20 6f 66 20 74 68 65 20 63  nd time of the c
0f00: 68 65 63 6b 2d 69 6e 20 28 55 54 43 29 20 61 6e  heck-in (UTC) an
0f10: 64 20 61 6e 20 53 48 41 31 0a 2a 2a 20 68 61 73  d an SHA1.** has
0f20: 68 20 6f 66 20 74 68 65 20 65 6e 74 69 72 65 20  h of the entire 
0f30: 73 6f 75 72 63 65 20 74 72 65 65 2e 0a 2a 2a 0a  source tree..**.
0f40: 2a 2a 20 53 65 65 20 61 6c 73 6f 3a 20 5b 73 71  ** See also: [sq
0f50: 6c 69 74 65 33 5f 6c 69 62 76 65 72 73 69 6f 6e  lite3_libversion
0f60: 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  ()],.** [sqlite3
0f70: 5f 6c 69 62 76 65 72 73 69 6f 6e 5f 6e 75 6d 62  _libversion_numb
0f80: 65 72 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f  er()], [sqlite3_
0f90: 73 6f 75 72 63 65 69 64 28 29 5d 2c 0a 2a 2a 20  sourceid()],.** 
0fa0: 5b 73 71 6c 69 74 65 5f 76 65 72 73 69 6f 6e 28  [sqlite_version(
0fb0: 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65 5f 73  )] and [sqlite_s
0fc0: 6f 75 72 63 65 5f 69 64 28 29 5d 2e 0a 2a 2f 0a  ource_id()]..*/.
0fd0: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 56  #define SQLITE_V
0fe0: 45 52 53 49 4f 4e 20 20 20 20 20 20 20 20 22 2d  ERSION        "-
0ff0: 2d 56 45 52 53 2d 2d 22 0a 23 64 65 66 69 6e 65  -VERS--".#define
1000: 20 53 51 4c 49 54 45 5f 56 45 52 53 49 4f 4e 5f   SQLITE_VERSION_
1010: 4e 55 4d 42 45 52 20 2d 2d 56 45 52 53 49 4f 4e  NUMBER --VERSION
1020: 2d 4e 55 4d 42 45 52 2d 2d 0a 23 64 65 66 69 6e  -NUMBER--.#defin
1030: 65 20 53 51 4c 49 54 45 5f 53 4f 55 52 43 45 5f  e SQLITE_SOURCE_
1040: 49 44 20 20 20 20 20 20 22 2d 2d 53 4f 55 52 43  ID      "--SOURC
1050: 45 2d 49 44 2d 2d 22 0a 0a 2f 2a 0a 2a 2a 20 43  E-ID--"../*.** C
1060: 41 50 49 33 52 45 46 3a 20 52 75 6e 2d 54 69 6d  API3REF: Run-Tim
1070: 65 20 4c 69 62 72 61 72 79 20 56 65 72 73 69 6f  e Library Versio
1080: 6e 20 4e 75 6d 62 65 72 73 0a 2a 2a 20 4b 45 59  n Numbers.** KEY
1090: 57 4f 52 44 53 3a 20 73 71 6c 69 74 65 33 5f 76  WORDS: sqlite3_v
10a0: 65 72 73 69 6f 6e 2c 20 73 71 6c 69 74 65 33 5f  ersion, sqlite3_
10b0: 73 6f 75 72 63 65 69 64 0a 2a 2a 0a 2a 2a 20 54  sourceid.**.** T
10c0: 68 65 73 65 20 69 6e 74 65 72 66 61 63 65 73 20  hese interfaces 
10d0: 70 72 6f 76 69 64 65 20 74 68 65 20 73 61 6d 65  provide the same
10e0: 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 61 73 20   information as 
10f0: 74 68 65 20 5b 53 51 4c 49 54 45 5f 56 45 52 53  the [SQLITE_VERS
1100: 49 4f 4e 5d 2c 0a 2a 2a 20 5b 53 51 4c 49 54 45  ION],.** [SQLITE
1110: 5f 56 45 52 53 49 4f 4e 5f 4e 55 4d 42 45 52 5d  _VERSION_NUMBER]
1120: 2c 20 61 6e 64 20 5b 53 51 4c 49 54 45 5f 53 4f  , and [SQLITE_SO
1130: 55 52 43 45 5f 49 44 5d 20 43 20 70 72 65 70 72  URCE_ID] C prepr
1140: 6f 63 65 73 73 6f 72 20 6d 61 63 72 6f 73 0a 2a  ocessor macros.*
1150: 2a 20 62 75 74 20 61 72 65 20 61 73 73 6f 63 69  * but are associ
1160: 61 74 65 64 20 77 69 74 68 20 74 68 65 20 6c 69  ated with the li
1170: 62 72 61 72 79 20 69 6e 73 74 65 61 64 20 6f 66  brary instead of
1180: 20 74 68 65 20 68 65 61 64 65 72 20 66 69 6c 65   the header file
1190: 2e 20 20 5e 28 43 61 75 74 69 6f 75 73 0a 2a 2a  .  ^(Cautious.**
11a0: 20 70 72 6f 67 72 61 6d 6d 65 72 73 20 6d 69 67   programmers mig
11b0: 68 74 20 69 6e 63 6c 75 64 65 20 61 73 73 65 72  ht include asser
11c0: 74 28 29 20 73 74 61 74 65 6d 65 6e 74 73 20 69  t() statements i
11d0: 6e 20 74 68 65 69 72 20 61 70 70 6c 69 63 61 74  n their applicat
11e0: 69 6f 6e 20 74 6f 0a 2a 2a 20 76 65 72 69 66 79  ion to.** verify
11f0: 20 74 68 61 74 20 76 61 6c 75 65 73 20 72 65 74   that values ret
1200: 75 72 6e 65 64 20 62 79 20 74 68 65 73 65 20 69  urned by these i
1210: 6e 74 65 72 66 61 63 65 73 20 6d 61 74 63 68 20  nterfaces match 
1220: 74 68 65 20 6d 61 63 72 6f 73 20 69 6e 0a 2a 2a  the macros in.**
1230: 20 74 68 65 20 68 65 61 64 65 72 2c 20 61 6e 64   the header, and
1240: 20 74 68 75 73 20 69 6e 73 75 72 65 20 74 68 61   thus insure tha
1250: 74 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f  t the applicatio
1260: 6e 20 69 73 0a 2a 2a 20 63 6f 6d 70 69 6c 65 64  n is.** compiled
1270: 20 77 69 74 68 20 6d 61 74 63 68 69 6e 67 20 6c   with matching l
1280: 69 62 72 61 72 79 20 61 6e 64 20 68 65 61 64 65  ibrary and heade
1290: 72 20 66 69 6c 65 73 2e 0a 2a 2a 0a 2a 2a 20 3c  r files..**.** <
12a0: 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e  blockquote><pre>
12b0: 0a 2a 2a 20 61 73 73 65 72 74 28 20 73 71 6c 69  .** assert( sqli
12c0: 74 65 33 5f 6c 69 62 76 65 72 73 69 6f 6e 5f 6e  te3_libversion_n
12d0: 75 6d 62 65 72 28 29 3d 3d 53 51 4c 49 54 45 5f  umber()==SQLITE_
12e0: 56 45 52 53 49 4f 4e 5f 4e 55 4d 42 45 52 20 29  VERSION_NUMBER )
12f0: 3b 0a 2a 2a 20 61 73 73 65 72 74 28 20 73 74 72  ;.** assert( str
1300: 63 6d 70 28 73 71 6c 69 74 65 33 5f 73 6f 75 72  cmp(sqlite3_sour
1310: 63 65 69 64 28 29 2c 53 51 4c 49 54 45 5f 53 4f  ceid(),SQLITE_SO
1320: 55 52 43 45 5f 49 44 29 3d 3d 30 20 29 3b 0a 2a  URCE_ID)==0 );.*
1330: 2a 20 61 73 73 65 72 74 28 20 73 74 72 63 6d 70  * assert( strcmp
1340: 28 73 71 6c 69 74 65 33 5f 6c 69 62 76 65 72 73  (sqlite3_libvers
1350: 69 6f 6e 28 29 2c 53 51 4c 49 54 45 5f 56 45 52  ion(),SQLITE_VER
1360: 53 49 4f 4e 29 3d 3d 30 20 29 3b 0a 2a 2a 20 3c  SION)==0 );.** <
1370: 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74  /pre></blockquot
1380: 65 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  e>)^.**.** ^The 
1390: 73 71 6c 69 74 65 33 5f 76 65 72 73 69 6f 6e 5b  sqlite3_version[
13a0: 5d 20 73 74 72 69 6e 67 20 63 6f 6e 73 74 61 6e  ] string constan
13b0: 74 20 63 6f 6e 74 61 69 6e 73 20 74 68 65 20 74  t contains the t
13c0: 65 78 74 20 6f 66 20 5b 53 51 4c 49 54 45 5f 56  ext of [SQLITE_V
13d0: 45 52 53 49 4f 4e 5d 0a 2a 2a 20 6d 61 63 72 6f  ERSION].** macro
13e0: 2e 20 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  .  ^The sqlite3_
13f0: 6c 69 62 76 65 72 73 69 6f 6e 28 29 20 66 75 6e  libversion() fun
1400: 63 74 69 6f 6e 20 72 65 74 75 72 6e 73 20 61 20  ction returns a 
1410: 70 6f 69 6e 74 65 72 20 74 6f 20 74 68 65 0a 2a  pointer to the.*
1420: 2a 20 74 6f 20 74 68 65 20 73 71 6c 69 74 65 33  * to the sqlite3
1430: 5f 76 65 72 73 69 6f 6e 5b 5d 20 73 74 72 69 6e  _version[] strin
1440: 67 20 63 6f 6e 73 74 61 6e 74 2e 20 20 54 68 65  g constant.  The
1450: 20 73 71 6c 69 74 65 33 5f 6c 69 62 76 65 72 73   sqlite3_libvers
1460: 69 6f 6e 28 29 0a 2a 2a 20 66 75 6e 63 74 69 6f  ion().** functio
1470: 6e 20 69 73 20 70 72 6f 76 69 64 65 64 20 66 6f  n is provided fo
1480: 72 20 75 73 65 20 69 6e 20 44 4c 4c 73 20 73 69  r use in DLLs si
1490: 6e 63 65 20 44 4c 4c 20 75 73 65 72 73 20 75 73  nce DLL users us
14a0: 75 61 6c 6c 79 20 64 6f 20 6e 6f 74 20 68 61 76  ually do not hav
14b0: 65 0a 2a 2a 20 64 69 72 65 63 74 20 61 63 63 65  e.** direct acce
14c0: 73 73 20 74 6f 20 73 74 72 69 6e 67 20 63 6f 6e  ss to string con
14d0: 73 74 61 6e 74 73 20 77 69 74 68 69 6e 20 74 68  stants within th
14e0: 65 20 44 4c 4c 2e 20 20 5e 54 68 65 0a 2a 2a 20  e DLL.  ^The.** 
14f0: 73 71 6c 69 74 65 33 5f 6c 69 62 76 65 72 73 69  sqlite3_libversi
1500: 6f 6e 5f 6e 75 6d 62 65 72 28 29 20 66 75 6e 63  on_number() func
1510: 74 69 6f 6e 20 72 65 74 75 72 6e 73 20 61 6e 20  tion returns an 
1520: 69 6e 74 65 67 65 72 20 65 71 75 61 6c 20 74 6f  integer equal to
1530: 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 56 45 52 53  .** [SQLITE_VERS
1540: 49 4f 4e 5f 4e 55 4d 42 45 52 5d 2e 20 20 5e 54  ION_NUMBER].  ^T
1550: 68 65 20 73 71 6c 69 74 65 33 5f 73 6f 75 72 63  he sqlite3_sourc
1560: 65 69 64 28 29 20 66 75 6e 63 74 69 6f 6e 20 72  eid() function r
1570: 65 74 75 72 6e 73 20 0a 2a 2a 20 61 20 70 6f 69  eturns .** a poi
1580: 6e 74 65 72 20 74 6f 20 61 20 73 74 72 69 6e 67  nter to a string
1590: 20 63 6f 6e 73 74 61 6e 74 20 77 68 6f 73 65 20   constant whose 
15a0: 76 61 6c 75 65 20 69 73 20 74 68 65 20 73 61 6d  value is the sam
15b0: 65 20 61 73 20 74 68 65 20 0a 2a 2a 20 5b 53 51  e as the .** [SQ
15c0: 4c 49 54 45 5f 53 4f 55 52 43 45 5f 49 44 5d 20  LITE_SOURCE_ID] 
15d0: 43 20 70 72 65 70 72 6f 63 65 73 73 6f 72 20 6d  C preprocessor m
15e0: 61 63 72 6f 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20  acro..**.** See 
15f0: 61 6c 73 6f 3a 20 5b 73 71 6c 69 74 65 5f 76 65  also: [sqlite_ve
1600: 72 73 69 6f 6e 28 29 5d 20 61 6e 64 20 5b 73 71  rsion()] and [sq
1610: 6c 69 74 65 5f 73 6f 75 72 63 65 5f 69 64 28 29  lite_source_id()
1620: 5d 2e 0a 2a 2f 0a 53 51 4c 49 54 45 5f 45 58 54  ]..*/.SQLITE_EXT
1630: 45 52 4e 20 63 6f 6e 73 74 20 63 68 61 72 20 73  ERN const char s
1640: 71 6c 69 74 65 33 5f 76 65 72 73 69 6f 6e 5b 5d  qlite3_version[]
1650: 3b 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 71  ;.const char *sq
1660: 6c 69 74 65 33 5f 6c 69 62 76 65 72 73 69 6f 6e  lite3_libversion
1670: 28 76 6f 69 64 29 3b 0a 63 6f 6e 73 74 20 63 68  (void);.const ch
1680: 61 72 20 2a 73 71 6c 69 74 65 33 5f 73 6f 75 72  ar *sqlite3_sour
1690: 63 65 69 64 28 76 6f 69 64 29 3b 0a 69 6e 74 20  ceid(void);.int 
16a0: 73 71 6c 69 74 65 33 5f 6c 69 62 76 65 72 73 69  sqlite3_libversi
16b0: 6f 6e 5f 6e 75 6d 62 65 72 28 76 6f 69 64 29 3b  on_number(void);
16c0: 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
16d0: 3a 20 52 75 6e 2d 54 69 6d 65 20 4c 69 62 72 61  : Run-Time Libra
16e0: 72 79 20 43 6f 6d 70 69 6c 61 74 69 6f 6e 20 4f  ry Compilation O
16f0: 70 74 69 6f 6e 73 20 44 69 61 67 6e 6f 73 74 69  ptions Diagnosti
1700: 63 73 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71  cs.**.** ^The sq
1710: 6c 69 74 65 33 5f 63 6f 6d 70 69 6c 65 6f 70 74  lite3_compileopt
1720: 69 6f 6e 5f 75 73 65 64 28 29 20 66 75 6e 63 74  ion_used() funct
1730: 69 6f 6e 20 72 65 74 75 72 6e 73 20 30 20 6f 72  ion returns 0 or
1740: 20 31 20 0a 2a 2a 20 69 6e 64 69 63 61 74 69 6e   1 .** indicatin
1750: 67 20 77 68 65 74 68 65 72 20 74 68 65 20 73 70  g whether the sp
1760: 65 63 69 66 69 65 64 20 6f 70 74 69 6f 6e 20 77  ecified option w
1770: 61 73 20 64 65 66 69 6e 65 64 20 61 74 20 0a 2a  as defined at .*
1780: 2a 20 63 6f 6d 70 69 6c 65 20 74 69 6d 65 2e 20  * compile time. 
1790: 20 5e 54 68 65 20 53 51 4c 49 54 45 5f 20 70 72   ^The SQLITE_ pr
17a0: 65 66 69 78 20 6d 61 79 20 62 65 20 6f 6d 69 74  efix may be omit
17b0: 74 65 64 20 66 72 6f 6d 20 74 68 65 20 0a 2a 2a  ted from the .**
17c0: 20 6f 70 74 69 6f 6e 20 6e 61 6d 65 20 70 61 73   option name pas
17d0: 73 65 64 20 74 6f 20 73 71 6c 69 74 65 33 5f 63  sed to sqlite3_c
17e0: 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 75 73 65  ompileoption_use
17f0: 64 28 29 2e 20 20 0a 2a 2a 0a 2a 2a 20 5e 54 68  d().  .**.** ^Th
1800: 65 20 73 71 6c 69 74 65 33 5f 63 6f 6d 70 69 6c  e sqlite3_compil
1810: 65 6f 70 74 69 6f 6e 5f 67 65 74 28 29 20 66 75  eoption_get() fu
1820: 6e 63 74 69 6f 6e 20 61 6c 6c 6f 77 73 20 69 74  nction allows it
1830: 65 72 61 74 69 6e 67 0a 2a 2a 20 6f 76 65 72 20  erating.** over 
1840: 74 68 65 20 6c 69 73 74 20 6f 66 20 6f 70 74 69  the list of opti
1850: 6f 6e 73 20 74 68 61 74 20 77 65 72 65 20 64 65  ons that were de
1860: 66 69 6e 65 64 20 61 74 20 63 6f 6d 70 69 6c 65  fined at compile
1870: 20 74 69 6d 65 20 62 79 0a 2a 2a 20 72 65 74 75   time by.** retu
1880: 72 6e 69 6e 67 20 74 68 65 20 4e 2d 74 68 20 63  rning the N-th c
1890: 6f 6d 70 69 6c 65 20 74 69 6d 65 20 6f 70 74 69  ompile time opti
18a0: 6f 6e 20 73 74 72 69 6e 67 2e 20 20 5e 49 66 20  on string.  ^If 
18b0: 4e 20 69 73 20 6f 75 74 20 6f 66 20 72 61 6e 67  N is out of rang
18c0: 65 2c 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63 6f  e,.** sqlite3_co
18d0: 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 67 65 74 28  mpileoption_get(
18e0: 29 20 72 65 74 75 72 6e 73 20 61 20 4e 55 4c 4c  ) returns a NULL
18f0: 20 70 6f 69 6e 74 65 72 2e 20 20 5e 54 68 65 20   pointer.  ^The 
1900: 53 51 4c 49 54 45 5f 20 0a 2a 2a 20 70 72 65 66  SQLITE_ .** pref
1910: 69 78 20 69 73 20 6f 6d 69 74 74 65 64 20 66 72  ix is omitted fr
1920: 6f 6d 20 61 6e 79 20 73 74 72 69 6e 67 73 20 72  om any strings r
1930: 65 74 75 72 6e 65 64 20 62 79 20 0a 2a 2a 20 73  eturned by .** s
1940: 71 6c 69 74 65 33 5f 63 6f 6d 70 69 6c 65 6f 70  qlite3_compileop
1950: 74 69 6f 6e 5f 67 65 74 28 29 2e 0a 2a 2a 0a 2a  tion_get()..**.*
1960: 2a 20 5e 53 75 70 70 6f 72 74 20 66 6f 72 20 74  * ^Support for t
1970: 68 65 20 64 69 61 67 6e 6f 73 74 69 63 20 66 75  he diagnostic fu
1980: 6e 63 74 69 6f 6e 73 20 73 71 6c 69 74 65 33 5f  nctions sqlite3_
1990: 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 75 73  compileoption_us
19a0: 65 64 28 29 0a 2a 2a 20 61 6e 64 20 73 71 6c 69  ed().** and sqli
19b0: 74 65 33 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f  te3_compileoptio
19c0: 6e 5f 67 65 74 28 29 20 6d 61 79 20 62 65 20 6f  n_get() may be o
19d0: 6d 69 74 74 65 64 20 62 79 20 73 70 65 63 69 66  mitted by specif
19e0: 79 69 6e 67 20 74 68 65 20 0a 2a 2a 20 5b 53 51  ying the .** [SQ
19f0: 4c 49 54 45 5f 4f 4d 49 54 5f 43 4f 4d 50 49 4c  LITE_OMIT_COMPIL
1a00: 45 4f 50 54 49 4f 4e 5f 44 49 41 47 53 5d 20 6f  EOPTION_DIAGS] o
1a10: 70 74 69 6f 6e 20 61 74 20 63 6f 6d 70 69 6c 65  ption at compile
1a20: 20 74 69 6d 65 2e 0a 2a 2a 0a 2a 2a 20 53 65 65   time..**.** See
1a30: 20 61 6c 73 6f 3a 20 53 51 4c 20 66 75 6e 63 74   also: SQL funct
1a40: 69 6f 6e 73 20 5b 73 71 6c 69 74 65 5f 63 6f 6d  ions [sqlite_com
1a50: 70 69 6c 65 6f 70 74 69 6f 6e 5f 75 73 65 64 28  pileoption_used(
1a60: 29 5d 20 61 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74  )] and.** [sqlit
1a70: 65 5f 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f  e_compileoption_
1a80: 67 65 74 28 29 5d 20 61 6e 64 20 74 68 65 20 5b  get()] and the [
1a90: 63 6f 6d 70 69 6c 65 5f 6f 70 74 69 6f 6e 73 20  compile_options 
1aa0: 70 72 61 67 6d 61 5d 2e 0a 2a 2f 0a 23 69 66 6e  pragma]..*/.#ifn
1ab0: 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f  def SQLITE_OMIT_
1ac0: 43 4f 4d 50 49 4c 45 4f 50 54 49 4f 4e 5f 44 49  COMPILEOPTION_DI
1ad0: 41 47 53 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  AGS.int sqlite3_
1ae0: 63 6f 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 75 73  compileoption_us
1af0: 65 64 28 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a  ed(const char *z
1b00: 4f 70 74 4e 61 6d 65 29 3b 0a 63 6f 6e 73 74 20  OptName);.const 
1b10: 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 63 6f  char *sqlite3_co
1b20: 6d 70 69 6c 65 6f 70 74 69 6f 6e 5f 67 65 74 28  mpileoption_get(
1b30: 69 6e 74 20 4e 29 3b 0a 23 65 6e 64 69 66 0a 0a  int N);.#endif..
1b40: 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
1b50: 54 65 73 74 20 54 6f 20 53 65 65 20 49 66 20 54  Test To See If T
1b60: 68 65 20 4c 69 62 72 61 72 79 20 49 73 20 54 68  he Library Is Th
1b70: 72 65 61 64 73 61 66 65 0a 2a 2a 0a 2a 2a 20 5e  readsafe.**.** ^
1b80: 54 68 65 20 73 71 6c 69 74 65 33 5f 74 68 72 65  The sqlite3_thre
1b90: 61 64 73 61 66 65 28 29 20 66 75 6e 63 74 69 6f  adsafe() functio
1ba0: 6e 20 72 65 74 75 72 6e 73 20 7a 65 72 6f 20 69  n returns zero i
1bb0: 66 20 61 6e 64 20 6f 6e 6c 79 20 69 66 0a 2a 2a  f and only if.**
1bc0: 20 53 51 4c 69 74 65 20 77 61 73 20 63 6f 6d 70   SQLite was comp
1bd0: 69 6c 65 64 20 6d 75 74 65 78 69 6e 67 20 63 6f  iled mutexing co
1be0: 64 65 20 6f 6d 69 74 74 65 64 20 64 75 65 20 74  de omitted due t
1bf0: 6f 20 74 68 65 0a 2a 2a 20 5b 53 51 4c 49 54 45  o the.** [SQLITE
1c00: 5f 54 48 52 45 41 44 53 41 46 45 5d 20 63 6f 6d  _THREADSAFE] com
1c10: 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e  pile-time option
1c20: 20 62 65 69 6e 67 20 73 65 74 20 74 6f 20 30 2e   being set to 0.
1c30: 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74 65 20 63 61  .**.** SQLite ca
1c40: 6e 20 62 65 20 63 6f 6d 70 69 6c 65 64 20 77 69  n be compiled wi
1c50: 74 68 20 6f 72 20 77 69 74 68 6f 75 74 20 6d 75  th or without mu
1c60: 74 65 78 65 73 2e 20 20 57 68 65 6e 0a 2a 2a 20  texes.  When.** 
1c70: 74 68 65 20 5b 53 51 4c 49 54 45 5f 54 48 52 45  the [SQLITE_THRE
1c80: 41 44 53 41 46 45 5d 20 43 20 70 72 65 70 72 6f  ADSAFE] C prepro
1c90: 63 65 73 73 6f 72 20 6d 61 63 72 6f 20 69 73 20  cessor macro is 
1ca0: 31 20 6f 72 20 32 2c 20 6d 75 74 65 78 65 73 0a  1 or 2, mutexes.
1cb0: 2a 2a 20 61 72 65 20 65 6e 61 62 6c 65 64 20 61  ** are enabled a
1cc0: 6e 64 20 53 51 4c 69 74 65 20 69 73 20 74 68 72  nd SQLite is thr
1cd0: 65 61 64 73 61 66 65 2e 20 20 57 68 65 6e 20 74  eadsafe.  When t
1ce0: 68 65 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 54 48  he.** [SQLITE_TH
1cf0: 52 45 41 44 53 41 46 45 5d 20 6d 61 63 72 6f 20  READSAFE] macro 
1d00: 69 73 20 30 2c 20 0a 2a 2a 20 74 68 65 20 6d 75  is 0, .** the mu
1d10: 74 65 78 65 73 20 61 72 65 20 6f 6d 69 74 74 65  texes are omitte
1d20: 64 2e 20 20 57 69 74 68 6f 75 74 20 74 68 65 20  d.  Without the 
1d30: 6d 75 74 65 78 65 73 2c 20 69 74 20 69 73 20 6e  mutexes, it is n
1d40: 6f 74 20 73 61 66 65 0a 2a 2a 20 74 6f 20 75 73  ot safe.** to us
1d50: 65 20 53 51 4c 69 74 65 20 63 6f 6e 63 75 72 72  e SQLite concurr
1d60: 65 6e 74 6c 79 20 66 72 6f 6d 20 6d 6f 72 65 20  ently from more 
1d70: 74 68 61 6e 20 6f 6e 65 20 74 68 72 65 61 64 2e  than one thread.
1d80: 0a 2a 2a 0a 2a 2a 20 45 6e 61 62 6c 69 6e 67 20  .**.** Enabling 
1d90: 6d 75 74 65 78 65 73 20 69 6e 63 75 72 73 20 61  mutexes incurs a
1da0: 20 6d 65 61 73 75 72 61 62 6c 65 20 70 65 72 66   measurable perf
1db0: 6f 72 6d 61 6e 63 65 20 70 65 6e 61 6c 74 79 2e  ormance penalty.
1dc0: 0a 2a 2a 20 53 6f 20 69 66 20 73 70 65 65 64 20  .** So if speed 
1dd0: 69 73 20 6f 66 20 75 74 6d 6f 73 74 20 69 6d 70  is of utmost imp
1de0: 6f 72 74 61 6e 63 65 2c 20 69 74 20 6d 61 6b 65  ortance, it make
1df0: 73 20 73 65 6e 73 65 20 74 6f 20 64 69 73 61 62  s sense to disab
1e00: 6c 65 0a 2a 2a 20 74 68 65 20 6d 75 74 65 78 65  le.** the mutexe
1e10: 73 2e 20 20 42 75 74 20 66 6f 72 20 6d 61 78 69  s.  But for maxi
1e20: 6d 75 6d 20 73 61 66 65 74 79 2c 20 6d 75 74 65  mum safety, mute
1e30: 78 65 73 20 73 68 6f 75 6c 64 20 62 65 20 65 6e  xes should be en
1e40: 61 62 6c 65 64 2e 0a 2a 2a 20 5e 54 68 65 20 64  abled..** ^The d
1e50: 65 66 61 75 6c 74 20 62 65 68 61 76 69 6f 72 20  efault behavior 
1e60: 69 73 20 66 6f 72 20 6d 75 74 65 78 65 73 20 74  is for mutexes t
1e70: 6f 20 62 65 20 65 6e 61 62 6c 65 64 2e 0a 2a 2a  o be enabled..**
1e80: 0a 2a 2a 20 54 68 69 73 20 69 6e 74 65 72 66 61  .** This interfa
1e90: 63 65 20 63 61 6e 20 62 65 20 75 73 65 64 20 62  ce can be used b
1ea0: 79 20 61 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e  y an application
1eb0: 20 74 6f 20 6d 61 6b 65 20 73 75 72 65 20 74 68   to make sure th
1ec0: 61 74 20 74 68 65 0a 2a 2a 20 76 65 72 73 69 6f  at the.** versio
1ed0: 6e 20 6f 66 20 53 51 4c 69 74 65 20 74 68 61 74  n of SQLite that
1ee0: 20 69 74 20 69 73 20 6c 69 6e 6b 69 6e 67 20 61   it is linking a
1ef0: 67 61 69 6e 73 74 20 77 61 73 20 63 6f 6d 70 69  gainst was compi
1f00: 6c 65 64 20 77 69 74 68 0a 2a 2a 20 74 68 65 20  led with.** the 
1f10: 64 65 73 69 72 65 64 20 73 65 74 74 69 6e 67 20  desired setting 
1f20: 6f 66 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 54  of the [SQLITE_T
1f30: 48 52 45 41 44 53 41 46 45 5d 20 6d 61 63 72 6f  HREADSAFE] macro
1f40: 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 69 6e 74  ..**.** This int
1f50: 65 72 66 61 63 65 20 6f 6e 6c 79 20 72 65 70 6f  erface only repo
1f60: 72 74 73 20 6f 6e 20 74 68 65 20 63 6f 6d 70 69  rts on the compi
1f70: 6c 65 2d 74 69 6d 65 20 6d 75 74 65 78 20 73 65  le-time mutex se
1f80: 74 74 69 6e 67 0a 2a 2a 20 6f 66 20 74 68 65 20  tting.** of the 
1f90: 5b 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41  [SQLITE_THREADSA
1fa0: 46 45 5d 20 66 6c 61 67 2e 20 20 49 66 20 53 51  FE] flag.  If SQ
1fb0: 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c 65 64  Lite is compiled
1fc0: 20 77 69 74 68 0a 2a 2a 20 53 51 4c 49 54 45 5f   with.** SQLITE_
1fd0: 54 48 52 45 41 44 53 41 46 45 3d 31 20 6f 72 20  THREADSAFE=1 or 
1fe0: 3d 32 20 74 68 65 6e 20 6d 75 74 65 78 65 73 20  =2 then mutexes 
1ff0: 61 72 65 20 65 6e 61 62 6c 65 64 20 62 79 20 64  are enabled by d
2000: 65 66 61 75 6c 74 20 62 75 74 0a 2a 2a 20 63 61  efault but.** ca
2010: 6e 20 62 65 20 66 75 6c 6c 79 20 6f 72 20 70 61  n be fully or pa
2020: 72 74 69 61 6c 6c 79 20 64 69 73 61 62 6c 65 64  rtially disabled
2030: 20 75 73 69 6e 67 20 61 20 63 61 6c 6c 20 74 6f   using a call to
2040: 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67   [sqlite3_config
2050: 28 29 5d 0a 2a 2a 20 77 69 74 68 20 74 68 65 20  ()].** with the 
2060: 76 65 72 62 73 20 5b 53 51 4c 49 54 45 5f 43 4f  verbs [SQLITE_CO
2070: 4e 46 49 47 5f 53 49 4e 47 4c 45 54 48 52 45 41  NFIG_SINGLETHREA
2080: 44 5d 2c 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46  D], [SQLITE_CONF
2090: 49 47 5f 4d 55 4c 54 49 54 48 52 45 41 44 5d 2c  IG_MULTITHREAD],
20a0: 0a 2a 2a 20 6f 72 20 5b 53 51 4c 49 54 45 5f 43  .** or [SQLITE_C
20b0: 4f 4e 46 49 47 5f 4d 55 54 45 58 5d 2e 20 20 5e  ONFIG_MUTEX].  ^
20c0: 28 54 68 65 20 72 65 74 75 72 6e 20 76 61 6c 75  (The return valu
20d0: 65 20 6f 66 20 74 68 65 0a 2a 2a 20 73 71 6c 69  e of the.** sqli
20e0: 74 65 33 5f 74 68 72 65 61 64 73 61 66 65 28 29  te3_threadsafe()
20f0: 20 66 75 6e 63 74 69 6f 6e 20 73 68 6f 77 73 20   function shows 
2100: 6f 6e 6c 79 20 74 68 65 20 63 6f 6d 70 69 6c 65  only the compile
2110: 2d 74 69 6d 65 20 73 65 74 74 69 6e 67 20 6f 66  -time setting of
2120: 0a 2a 2a 20 74 68 72 65 61 64 20 73 61 66 65 74  .** thread safet
2130: 79 2c 20 6e 6f 74 20 61 6e 79 20 72 75 6e 2d 74  y, not any run-t
2140: 69 6d 65 20 63 68 61 6e 67 65 73 20 74 6f 20 74  ime changes to t
2150: 68 61 74 20 73 65 74 74 69 6e 67 20 6d 61 64 65  hat setting made
2160: 20 62 79 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63   by.** sqlite3_c
2170: 6f 6e 66 69 67 28 29 2e 20 49 6e 20 6f 74 68 65  onfig(). In othe
2180: 72 20 77 6f 72 64 73 2c 20 74 68 65 20 72 65 74  r words, the ret
2190: 75 72 6e 20 76 61 6c 75 65 20 66 72 6f 6d 20 73  urn value from s
21a0: 71 6c 69 74 65 33 5f 74 68 72 65 61 64 73 61 66  qlite3_threadsaf
21b0: 65 28 29 0a 2a 2a 20 69 73 20 75 6e 63 68 61 6e  e().** is unchan
21c0: 67 65 64 20 62 79 20 63 61 6c 6c 73 20 74 6f 20  ged by calls to 
21d0: 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29  sqlite3_config()
21e0: 2e 29 5e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 74 68  .)^.**.** See th
21f0: 65 20 5b 74 68 72 65 61 64 69 6e 67 20 6d 6f 64  e [threading mod
2200: 65 5d 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e  e] documentation
2210: 20 66 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c 20   for additional 
2220: 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e 0a 2a 2f 0a  information..*/.
2230: 69 6e 74 20 73 71 6c 69 74 65 33 5f 74 68 72 65  int sqlite3_thre
2240: 61 64 73 61 66 65 28 76 6f 69 64 29 3b 0a 0a 2f  adsafe(void);../
2250: 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 44  *.** CAPI3REF: D
2260: 61 74 61 62 61 73 65 20 43 6f 6e 6e 65 63 74 69  atabase Connecti
2270: 6f 6e 20 48 61 6e 64 6c 65 0a 2a 2a 20 4b 45 59  on Handle.** KEY
2280: 57 4f 52 44 53 3a 20 7b 64 61 74 61 62 61 73 65  WORDS: {database
2290: 20 63 6f 6e 6e 65 63 74 69 6f 6e 7d 20 7b 64 61   connection} {da
22a0: 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
22b0: 6e 73 7d 0a 2a 2a 0a 2a 2a 20 45 61 63 68 20 6f  ns}.**.** Each o
22c0: 70 65 6e 20 53 51 4c 69 74 65 20 64 61 74 61 62  pen SQLite datab
22d0: 61 73 65 20 69 73 20 72 65 70 72 65 73 65 6e 74  ase is represent
22e0: 65 64 20 62 79 20 61 20 70 6f 69 6e 74 65 72 20  ed by a pointer 
22f0: 74 6f 20 61 6e 20 69 6e 73 74 61 6e 63 65 20 6f  to an instance o
2300: 66 0a 2a 2a 20 74 68 65 20 6f 70 61 71 75 65 20  f.** the opaque 
2310: 73 74 72 75 63 74 75 72 65 20 6e 61 6d 65 64 20  structure named 
2320: 22 73 71 6c 69 74 65 33 22 2e 20 20 49 74 20 69  "sqlite3".  It i
2330: 73 20 75 73 65 66 75 6c 20 74 6f 20 74 68 69 6e  s useful to thin
2340: 6b 20 6f 66 20 61 6e 20 73 71 6c 69 74 65 33 0a  k of an sqlite3.
2350: 2a 2a 20 70 6f 69 6e 74 65 72 20 61 73 20 61 6e  ** pointer as an
2360: 20 6f 62 6a 65 63 74 2e 20 20 54 68 65 20 5b 73   object.  The [s
2370: 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 5d 2c 20  qlite3_open()], 
2380: 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31 36 28  [sqlite3_open16(
2390: 29 5d 2c 20 61 6e 64 0a 2a 2a 20 5b 73 71 6c 69  )], and.** [sqli
23a0: 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 5d 20 69  te3_open_v2()] i
23b0: 6e 74 65 72 66 61 63 65 73 20 61 72 65 20 69 74  nterfaces are it
23c0: 73 20 63 6f 6e 73 74 72 75 63 74 6f 72 73 2c 20  s constructors, 
23d0: 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 63 6c 6f  and [sqlite3_clo
23e0: 73 65 28 29 5d 0a 2a 2a 20 69 73 20 69 74 73 20  se()].** is its 
23f0: 64 65 73 74 72 75 63 74 6f 72 2e 20 20 54 68 65  destructor.  The
2400: 72 65 20 61 72 65 20 6d 61 6e 79 20 6f 74 68 65  re are many othe
2410: 72 20 69 6e 74 65 72 66 61 63 65 73 20 28 73 75  r interfaces (su
2420: 63 68 20 61 73 0a 2a 2a 20 5b 73 71 6c 69 74 65  ch as.** [sqlite
2430: 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d 2c  3_prepare_v2()],
2440: 20 5b 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65   [sqlite3_create
2450: 5f 66 75 6e 63 74 69 6f 6e 28 29 5d 2c 20 61 6e  _function()], an
2460: 64 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62 75  d.** [sqlite3_bu
2470: 73 79 5f 74 69 6d 65 6f 75 74 28 29 5d 20 74 6f  sy_timeout()] to
2480: 20 6e 61 6d 65 20 62 75 74 20 74 68 72 65 65 29   name but three)
2490: 20 74 68 61 74 20 61 72 65 20 6d 65 74 68 6f 64   that are method
24a0: 73 20 6f 6e 20 61 6e 0a 2a 2a 20 73 71 6c 69 74  s on an.** sqlit
24b0: 65 33 20 6f 62 6a 65 63 74 2e 0a 2a 2f 0a 74 79  e3 object..*/.ty
24c0: 70 65 64 65 66 20 73 74 72 75 63 74 20 73 71 6c  pedef struct sql
24d0: 69 74 65 33 20 73 71 6c 69 74 65 33 3b 0a 0a 2f  ite3 sqlite3;../
24e0: 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 36  *.** CAPI3REF: 6
24f0: 34 2d 42 69 74 20 49 6e 74 65 67 65 72 20 54 79  4-Bit Integer Ty
2500: 70 65 73 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a  pes.** KEYWORDS:
2510: 20 73 71 6c 69 74 65 5f 69 6e 74 36 34 20 73 71   sqlite_int64 sq
2520: 6c 69 74 65 5f 75 69 6e 74 36 34 0a 2a 2a 0a 2a  lite_uint64.**.*
2530: 2a 20 42 65 63 61 75 73 65 20 74 68 65 72 65 20  * Because there 
2540: 69 73 20 6e 6f 20 63 72 6f 73 73 2d 70 6c 61 74  is no cross-plat
2550: 66 6f 72 6d 20 77 61 79 20 74 6f 20 73 70 65 63  form way to spec
2560: 69 66 79 20 36 34 2d 62 69 74 20 69 6e 74 65 67  ify 64-bit integ
2570: 65 72 20 74 79 70 65 73 0a 2a 2a 20 53 51 4c 69  er types.** SQLi
2580: 74 65 20 69 6e 63 6c 75 64 65 73 20 74 79 70 65  te includes type
2590: 64 65 66 73 20 66 6f 72 20 36 34 2d 62 69 74 20  defs for 64-bit 
25a0: 73 69 67 6e 65 64 20 61 6e 64 20 75 6e 73 69 67  signed and unsig
25b0: 6e 65 64 20 69 6e 74 65 67 65 72 73 2e 0a 2a 2a  ned integers..**
25c0: 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65 33 5f  .** The sqlite3_
25d0: 69 6e 74 36 34 20 61 6e 64 20 73 71 6c 69 74 65  int64 and sqlite
25e0: 33 5f 75 69 6e 74 36 34 20 61 72 65 20 74 68 65  3_uint64 are the
25f0: 20 70 72 65 66 65 72 72 65 64 20 74 79 70 65 20   preferred type 
2600: 64 65 66 69 6e 69 74 69 6f 6e 73 2e 0a 2a 2a 20  definitions..** 
2610: 54 68 65 20 73 71 6c 69 74 65 5f 69 6e 74 36 34  The sqlite_int64
2620: 20 61 6e 64 20 73 71 6c 69 74 65 5f 75 69 6e 74   and sqlite_uint
2630: 36 34 20 74 79 70 65 73 20 61 72 65 20 73 75 70  64 types are sup
2640: 70 6f 72 74 65 64 20 66 6f 72 20 62 61 63 6b 77  ported for backw
2650: 61 72 64 73 0a 2a 2a 20 63 6f 6d 70 61 74 69 62  ards.** compatib
2660: 69 6c 69 74 79 20 6f 6e 6c 79 2e 0a 2a 2a 0a 2a  ility only..**.*
2670: 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 69  * ^The sqlite3_i
2680: 6e 74 36 34 20 61 6e 64 20 73 71 6c 69 74 65 5f  nt64 and sqlite_
2690: 69 6e 74 36 34 20 74 79 70 65 73 20 63 61 6e 20  int64 types can 
26a0: 73 74 6f 72 65 20 69 6e 74 65 67 65 72 20 76 61  store integer va
26b0: 6c 75 65 73 0a 2a 2a 20 62 65 74 77 65 65 6e 20  lues.** between 
26c0: 2d 39 32 32 33 33 37 32 30 33 36 38 35 34 37 37  -922337203685477
26d0: 35 38 30 38 20 61 6e 64 20 2b 39 32 32 33 33 37  5808 and +922337
26e0: 32 30 33 36 38 35 34 37 37 35 38 30 37 20 69 6e  2036854775807 in
26f0: 63 6c 75 73 69 76 65 2e 20 20 5e 54 68 65 0a 2a  clusive.  ^The.*
2700: 2a 20 73 71 6c 69 74 65 33 5f 75 69 6e 74 36 34  * sqlite3_uint64
2710: 20 61 6e 64 20 73 71 6c 69 74 65 5f 75 69 6e 74   and sqlite_uint
2720: 36 34 20 74 79 70 65 73 20 63 61 6e 20 73 74 6f  64 types can sto
2730: 72 65 20 69 6e 74 65 67 65 72 20 76 61 6c 75 65  re integer value
2740: 73 20 0a 2a 2a 20 62 65 74 77 65 65 6e 20 30 20  s .** between 0 
2750: 61 6e 64 20 2b 31 38 34 34 36 37 34 34 30 37 33  and +18446744073
2760: 37 30 39 35 35 31 36 31 35 20 69 6e 63 6c 75 73  709551615 inclus
2770: 69 76 65 2e 0a 2a 2f 0a 23 69 66 64 65 66 20 53  ive..*/.#ifdef S
2780: 51 4c 49 54 45 5f 49 4e 54 36 34 5f 54 59 50 45  QLITE_INT64_TYPE
2790: 0a 20 20 74 79 70 65 64 65 66 20 53 51 4c 49 54  .  typedef SQLIT
27a0: 45 5f 49 4e 54 36 34 5f 54 59 50 45 20 73 71 6c  E_INT64_TYPE sql
27b0: 69 74 65 5f 69 6e 74 36 34 3b 0a 20 20 74 79 70  ite_int64;.  typ
27c0: 65 64 65 66 20 75 6e 73 69 67 6e 65 64 20 53 51  edef unsigned SQ
27d0: 4c 49 54 45 5f 49 4e 54 36 34 5f 54 59 50 45 20  LITE_INT64_TYPE 
27e0: 73 71 6c 69 74 65 5f 75 69 6e 74 36 34 3b 0a 23  sqlite_uint64;.#
27f0: 65 6c 69 66 20 64 65 66 69 6e 65 64 28 5f 4d 53  elif defined(_MS
2800: 43 5f 56 45 52 29 20 7c 7c 20 64 65 66 69 6e 65  C_VER) || define
2810: 64 28 5f 5f 42 4f 52 4c 41 4e 44 43 5f 5f 29 0a  d(__BORLANDC__).
2820: 20 20 74 79 70 65 64 65 66 20 5f 5f 69 6e 74 36    typedef __int6
2830: 34 20 73 71 6c 69 74 65 5f 69 6e 74 36 34 3b 0a  4 sqlite_int64;.
2840: 20 20 74 79 70 65 64 65 66 20 75 6e 73 69 67 6e    typedef unsign
2850: 65 64 20 5f 5f 69 6e 74 36 34 20 73 71 6c 69 74  ed __int64 sqlit
2860: 65 5f 75 69 6e 74 36 34 3b 0a 23 65 6c 73 65 0a  e_uint64;.#else.
2870: 20 20 74 79 70 65 64 65 66 20 6c 6f 6e 67 20 6c    typedef long l
2880: 6f 6e 67 20 69 6e 74 20 73 71 6c 69 74 65 5f 69  ong int sqlite_i
2890: 6e 74 36 34 3b 0a 20 20 74 79 70 65 64 65 66 20  nt64;.  typedef 
28a0: 75 6e 73 69 67 6e 65 64 20 6c 6f 6e 67 20 6c 6f  unsigned long lo
28b0: 6e 67 20 69 6e 74 20 73 71 6c 69 74 65 5f 75 69  ng int sqlite_ui
28c0: 6e 74 36 34 3b 0a 23 65 6e 64 69 66 0a 74 79 70  nt64;.#endif.typ
28d0: 65 64 65 66 20 73 71 6c 69 74 65 5f 69 6e 74 36  edef sqlite_int6
28e0: 34 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 3b  4 sqlite3_int64;
28f0: 0a 74 79 70 65 64 65 66 20 73 71 6c 69 74 65 5f  .typedef sqlite_
2900: 75 69 6e 74 36 34 20 73 71 6c 69 74 65 33 5f 75  uint64 sqlite3_u
2910: 69 6e 74 36 34 3b 0a 0a 2f 2a 0a 2a 2a 20 49 66  int64;../*.** If
2920: 20 63 6f 6d 70 69 6c 69 6e 67 20 66 6f 72 20 61   compiling for a
2930: 20 70 72 6f 63 65 73 73 6f 72 20 74 68 61 74 20   processor that 
2940: 6c 61 63 6b 73 20 66 6c 6f 61 74 69 6e 67 20 70  lacks floating p
2950: 6f 69 6e 74 20 73 75 70 70 6f 72 74 2c 0a 2a 2a  oint support,.**
2960: 20 73 75 62 73 74 69 74 75 74 65 20 69 6e 74 65   substitute inte
2970: 67 65 72 20 66 6f 72 20 66 6c 6f 61 74 69 6e 67  ger for floating
2980: 2d 70 6f 69 6e 74 2e 0a 2a 2f 0a 23 69 66 64 65  -point..*/.#ifde
2990: 66 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 46 4c  f SQLITE_OMIT_FL
29a0: 4f 41 54 49 4e 47 5f 50 4f 49 4e 54 0a 23 20 64  OATING_POINT.# d
29b0: 65 66 69 6e 65 20 64 6f 75 62 6c 65 20 73 71 6c  efine double sql
29c0: 69 74 65 33 5f 69 6e 74 36 34 0a 23 65 6e 64 69  ite3_int64.#endi
29d0: 66 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  f../*.** CAPI3RE
29e0: 46 3a 20 43 6c 6f 73 69 6e 67 20 41 20 44 61 74  F: Closing A Dat
29f0: 61 62 61 73 65 20 43 6f 6e 6e 65 63 74 69 6f 6e  abase Connection
2a00: 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69  .**.** ^The sqli
2a10: 74 65 33 5f 63 6c 6f 73 65 28 29 20 72 6f 75 74  te3_close() rout
2a20: 69 6e 65 20 69 73 20 74 68 65 20 64 65 73 74 72  ine is the destr
2a30: 75 63 74 6f 72 20 66 6f 72 20 74 68 65 20 5b 73  uctor for the [s
2a40: 71 6c 69 74 65 33 5d 20 6f 62 6a 65 63 74 2e 0a  qlite3] object..
2a50: 2a 2a 20 5e 43 61 6c 6c 73 20 74 6f 20 73 71 6c  ** ^Calls to sql
2a60: 69 74 65 33 5f 63 6c 6f 73 65 28 29 20 72 65 74  ite3_close() ret
2a70: 75 72 6e 20 53 51 4c 49 54 45 5f 4f 4b 20 69 66  urn SQLITE_OK if
2a80: 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5d 20 6f   the [sqlite3] o
2a90: 62 6a 65 63 74 20 69 73 0a 2a 2a 20 73 75 63 63  bject is.** succ
2aa0: 65 73 73 66 75 6c 6c 79 20 64 65 73 74 72 6f 79  essfully destroy
2ab0: 65 64 20 61 6e 64 20 61 6c 6c 20 61 73 73 6f 63  ed and all assoc
2ac0: 69 61 74 65 64 20 72 65 73 6f 75 72 63 65 73 20  iated resources 
2ad0: 61 72 65 20 64 65 61 6c 6c 6f 63 61 74 65 64 2e  are deallocated.
2ae0: 0a 2a 2a 0a 2a 2a 20 41 70 70 6c 69 63 61 74 69  .**.** Applicati
2af0: 6f 6e 73 20 6d 75 73 74 20 5b 73 71 6c 69 74 65  ons must [sqlite
2b00: 33 5f 66 69 6e 61 6c 69 7a 65 20 7c 20 66 69 6e  3_finalize | fin
2b10: 61 6c 69 7a 65 5d 20 61 6c 6c 20 5b 70 72 65 70  alize] all [prep
2b20: 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 73 5d  ared statements]
2b30: 0a 2a 2a 20 61 6e 64 20 5b 73 71 6c 69 74 65 33  .** and [sqlite3
2b40: 5f 62 6c 6f 62 5f 63 6c 6f 73 65 20 7c 20 63 6c  _blob_close | cl
2b50: 6f 73 65 5d 20 61 6c 6c 20 5b 42 4c 4f 42 20 68  ose] all [BLOB h
2b60: 61 6e 64 6c 65 73 5d 20 61 73 73 6f 63 69 61 74  andles] associat
2b70: 65 64 20 77 69 74 68 0a 2a 2a 20 74 68 65 20 5b  ed with.** the [
2b80: 73 71 6c 69 74 65 33 5d 20 6f 62 6a 65 63 74 20  sqlite3] object 
2b90: 70 72 69 6f 72 20 74 6f 20 61 74 74 65 6d 70 74  prior to attempt
2ba0: 69 6e 67 20 74 6f 20 63 6c 6f 73 65 20 74 68 65  ing to close the
2bb0: 20 6f 62 6a 65 63 74 2e 20 20 5e 49 66 0a 2a 2a   object.  ^If.**
2bc0: 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 28 29   sqlite3_close()
2bd0: 20 69 73 20 63 61 6c 6c 65 64 20 6f 6e 20 61 20   is called on a 
2be0: 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63  [database connec
2bf0: 74 69 6f 6e 5d 20 74 68 61 74 20 73 74 69 6c 6c  tion] that still
2c00: 20 68 61 73 0a 2a 2a 20 6f 75 74 73 74 61 6e 64   has.** outstand
2c10: 69 6e 67 20 5b 70 72 65 70 61 72 65 64 20 73 74  ing [prepared st
2c20: 61 74 65 6d 65 6e 74 73 5d 20 6f 72 20 5b 42 4c  atements] or [BL
2c30: 4f 42 20 68 61 6e 64 6c 65 73 5d 2c 20 74 68 65  OB handles], the
2c40: 6e 20 69 74 20 72 65 74 75 72 6e 73 0a 2a 2a 20  n it returns.** 
2c50: 53 51 4c 49 54 45 5f 42 55 53 59 2e 0a 2a 2a 0a  SQLITE_BUSY..**.
2c60: 2a 2a 20 5e 49 66 20 5b 73 71 6c 69 74 65 33 5f  ** ^If [sqlite3_
2c70: 63 6c 6f 73 65 28 29 5d 20 69 73 20 69 6e 76 6f  close()] is invo
2c80: 6b 65 64 20 77 68 69 6c 65 20 61 20 74 72 61 6e  ked while a tran
2c90: 73 61 63 74 69 6f 6e 20 69 73 20 6f 70 65 6e 2c  saction is open,
2ca0: 0a 2a 2a 20 74 68 65 20 74 72 61 6e 73 61 63 74  .** the transact
2cb0: 69 6f 6e 20 69 73 20 61 75 74 6f 6d 61 74 69 63  ion is automatic
2cc0: 61 6c 6c 79 20 72 6f 6c 6c 65 64 20 62 61 63 6b  ally rolled back
2cd0: 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 43 20 70 61  ..**.** The C pa
2ce0: 72 61 6d 65 74 65 72 20 74 6f 20 5b 73 71 6c 69  rameter to [sqli
2cf0: 74 65 33 5f 63 6c 6f 73 65 28 43 29 5d 20 6d 75  te3_close(C)] mu
2d00: 73 74 20 62 65 20 65 69 74 68 65 72 20 61 20 4e  st be either a N
2d10: 55 4c 4c 0a 2a 2a 20 70 6f 69 6e 74 65 72 20 6f  ULL.** pointer o
2d20: 72 20 61 6e 20 5b 73 71 6c 69 74 65 33 5d 20 6f  r an [sqlite3] o
2d30: 62 6a 65 63 74 20 70 6f 69 6e 74 65 72 20 6f 62  bject pointer ob
2d40: 74 61 69 6e 65 64 0a 2a 2a 20 66 72 6f 6d 20 5b  tained.** from [
2d50: 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 5d 2c  sqlite3_open()],
2d60: 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31 36   [sqlite3_open16
2d70: 28 29 5d 2c 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69  ()], or.** [sqli
2d80: 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 5d 2c 20  te3_open_v2()], 
2d90: 61 6e 64 20 6e 6f 74 20 70 72 65 76 69 6f 75 73  and not previous
2da0: 6c 79 20 63 6c 6f 73 65 64 2e 0a 2a 2a 20 5e 43  ly closed..** ^C
2db0: 61 6c 6c 69 6e 67 20 73 71 6c 69 74 65 33 5f 63  alling sqlite3_c
2dc0: 6c 6f 73 65 28 29 20 77 69 74 68 20 61 20 4e 55  lose() with a NU
2dd0: 4c 4c 20 70 6f 69 6e 74 65 72 20 61 72 67 75 6d  LL pointer argum
2de0: 65 6e 74 20 69 73 20 61 20 0a 2a 2a 20 68 61 72  ent is a .** har
2df0: 6d 6c 65 73 73 20 6e 6f 2d 6f 70 2e 0a 2a 2f 0a  mless no-op..*/.
2e00: 69 6e 74 20 73 71 6c 69 74 65 33 5f 63 6c 6f 73  int sqlite3_clos
2e10: 65 28 73 71 6c 69 74 65 33 20 2a 29 3b 0a 0a 2f  e(sqlite3 *);../
2e20: 2a 0a 2a 2a 20 54 68 65 20 74 79 70 65 20 66 6f  *.** The type fo
2e30: 72 20 61 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e  r a callback fun
2e40: 63 74 69 6f 6e 2e 0a 2a 2a 20 54 68 69 73 20 69  ction..** This i
2e50: 73 20 6c 65 67 61 63 79 20 61 6e 64 20 64 65 70  s legacy and dep
2e60: 72 65 63 61 74 65 64 2e 20 20 49 74 20 69 73 20  recated.  It is 
2e70: 69 6e 63 6c 75 64 65 64 20 66 6f 72 20 68 69 73  included for his
2e80: 74 6f 72 69 63 61 6c 0a 2a 2a 20 63 6f 6d 70 61  torical.** compa
2e90: 74 69 62 69 6c 69 74 79 20 61 6e 64 20 69 73 20  tibility and is 
2ea0: 6e 6f 74 20 64 6f 63 75 6d 65 6e 74 65 64 2e 0a  not documented..
2eb0: 2a 2f 0a 74 79 70 65 64 65 66 20 69 6e 74 20 28  */.typedef int (
2ec0: 2a 73 71 6c 69 74 65 33 5f 63 61 6c 6c 62 61 63  *sqlite3_callbac
2ed0: 6b 29 28 76 6f 69 64 2a 2c 69 6e 74 2c 63 68 61  k)(void*,int,cha
2ee0: 72 2a 2a 2c 20 63 68 61 72 2a 2a 29 3b 0a 0a 2f  r**, char**);../
2ef0: 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4f  *.** CAPI3REF: O
2f00: 6e 65 2d 53 74 65 70 20 51 75 65 72 79 20 45 78  ne-Step Query Ex
2f10: 65 63 75 74 69 6f 6e 20 49 6e 74 65 72 66 61 63  ecution Interfac
2f20: 65 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69  e.**.** The sqli
2f30: 74 65 33 5f 65 78 65 63 28 29 20 69 6e 74 65 72  te3_exec() inter
2f40: 66 61 63 65 20 69 73 20 61 20 63 6f 6e 76 65 6e  face is a conven
2f50: 69 65 6e 63 65 20 77 72 61 70 70 65 72 20 61 72  ience wrapper ar
2f60: 6f 75 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  ound.** [sqlite3
2f70: 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d 2c 20  _prepare_v2()], 
2f80: 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d  [sqlite3_step()]
2f90: 2c 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 66  , and [sqlite3_f
2fa0: 69 6e 61 6c 69 7a 65 28 29 5d 2c 0a 2a 2a 20 74  inalize()],.** t
2fb0: 68 61 74 20 61 6c 6c 6f 77 73 20 61 6e 20 61 70  hat allows an ap
2fc0: 70 6c 69 63 61 74 69 6f 6e 20 74 6f 20 72 75 6e  plication to run
2fd0: 20 6d 75 6c 74 69 70 6c 65 20 73 74 61 74 65 6d   multiple statem
2fe0: 65 6e 74 73 20 6f 66 20 53 51 4c 0a 2a 2a 20 77  ents of SQL.** w
2ff0: 69 74 68 6f 75 74 20 68 61 76 69 6e 67 20 74 6f  ithout having to
3000: 20 75 73 65 20 61 20 6c 6f 74 20 6f 66 20 43 20   use a lot of C 
3010: 63 6f 64 65 2e 20 0a 2a 2a 0a 2a 2a 20 5e 54 68  code. .**.** ^Th
3020: 65 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29  e sqlite3_exec()
3030: 20 69 6e 74 65 72 66 61 63 65 20 72 75 6e 73 20   interface runs 
3040: 7a 65 72 6f 20 6f 72 20 6d 6f 72 65 20 55 54 46  zero or more UTF
3050: 2d 38 20 65 6e 63 6f 64 65 64 2c 0a 2a 2a 20 73  -8 encoded,.** s
3060: 65 6d 69 63 6f 6c 6f 6e 2d 73 65 70 61 72 61 74  emicolon-separat
3070: 65 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73  e SQL statements
3080: 20 70 61 73 73 65 64 20 69 6e 74 6f 20 69 74 73   passed into its
3090: 20 32 6e 64 20 61 72 67 75 6d 65 6e 74 2c 0a 2a   2nd argument,.*
30a0: 2a 20 69 6e 20 74 68 65 20 63 6f 6e 74 65 78 74  * in the context
30b0: 20 6f 66 20 74 68 65 20 5b 64 61 74 61 62 61 73   of the [databas
30c0: 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 70 61  e connection] pa
30d0: 73 73 65 64 20 69 6e 20 61 73 20 69 74 73 20 31  ssed in as its 1
30e0: 73 74 0a 2a 2a 20 61 72 67 75 6d 65 6e 74 2e 20  st.** argument. 
30f0: 20 5e 49 66 20 74 68 65 20 63 61 6c 6c 62 61 63   ^If the callbac
3100: 6b 20 66 75 6e 63 74 69 6f 6e 20 6f 66 20 74 68  k function of th
3110: 65 20 33 72 64 20 61 72 67 75 6d 65 6e 74 20 74  e 3rd argument t
3120: 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 65 78 65  o.** sqlite3_exe
3130: 63 28 29 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 2c  c() is not NULL,
3140: 20 74 68 65 6e 20 69 74 20 69 73 20 69 6e 76 6f   then it is invo
3150: 6b 65 64 20 66 6f 72 20 65 61 63 68 20 72 65 73  ked for each res
3160: 75 6c 74 20 72 6f 77 0a 2a 2a 20 63 6f 6d 69 6e  ult row.** comin
3170: 67 20 6f 75 74 20 6f 66 20 74 68 65 20 65 76 61  g out of the eva
3180: 6c 75 61 74 65 64 20 53 51 4c 20 73 74 61 74 65  luated SQL state
3190: 6d 65 6e 74 73 2e 20 20 5e 54 68 65 20 34 74 68  ments.  ^The 4th
31a0: 20 61 72 67 75 6d 65 6e 74 20 74 6f 0a 2a 2a 20   argument to.** 
31b0: 74 6f 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28  to sqlite3_exec(
31c0: 29 20 69 73 20 72 65 6c 61 79 65 64 20 74 68 72  ) is relayed thr
31d0: 6f 75 67 68 20 74 6f 20 74 68 65 20 31 73 74 20  ough to the 1st 
31e0: 61 72 67 75 6d 65 6e 74 20 6f 66 20 65 61 63 68  argument of each
31f0: 0a 2a 2a 20 63 61 6c 6c 62 61 63 6b 20 69 6e 76  .** callback inv
3200: 6f 63 61 74 69 6f 6e 2e 20 20 5e 49 66 20 74 68  ocation.  ^If th
3210: 65 20 63 61 6c 6c 62 61 63 6b 20 70 6f 69 6e 74  e callback point
3220: 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 65 78  er to sqlite3_ex
3230: 65 63 28 29 0a 2a 2a 20 69 73 20 4e 55 4c 4c 2c  ec().** is NULL,
3240: 20 74 68 65 6e 20 6e 6f 20 63 61 6c 6c 62 61 63   then no callbac
3250: 6b 20 69 73 20 65 76 65 72 20 69 6e 76 6f 6b 65  k is ever invoke
3260: 64 20 61 6e 64 20 72 65 73 75 6c 74 20 72 6f 77  d and result row
3270: 73 20 61 72 65 0a 2a 2a 20 69 67 6e 6f 72 65 64  s are.** ignored
3280: 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 61 6e 20 65  ..**.** ^If an e
3290: 72 72 6f 72 20 6f 63 63 75 72 73 20 77 68 69 6c  rror occurs whil
32a0: 65 20 65 76 61 6c 75 61 74 69 6e 67 20 74 68 65  e evaluating the
32b0: 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 20   SQL statements 
32c0: 70 61 73 73 65 64 20 69 6e 74 6f 0a 2a 2a 20 73  passed into.** s
32d0: 71 6c 69 74 65 33 5f 65 78 65 63 28 29 2c 20 74  qlite3_exec(), t
32e0: 68 65 6e 20 65 78 65 63 75 74 69 6f 6e 20 6f 66  hen execution of
32f0: 20 74 68 65 20 63 75 72 72 65 6e 74 20 73 74 61   the current sta
3300: 74 65 6d 65 6e 74 20 73 74 6f 70 73 20 61 6e 64  tement stops and
3310: 0a 2a 2a 20 73 75 62 73 65 71 75 65 6e 74 20 73  .** subsequent s
3320: 74 61 74 65 6d 65 6e 74 73 20 61 72 65 20 73 6b  tatements are sk
3330: 69 70 70 65 64 2e 20 20 5e 49 66 20 74 68 65 20  ipped.  ^If the 
3340: 35 74 68 20 70 61 72 61 6d 65 74 65 72 20 74 6f  5th parameter to
3350: 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 0a   sqlite3_exec().
3360: 2a 2a 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 20 74  ** is not NULL t
3370: 68 65 6e 20 61 6e 79 20 65 72 72 6f 72 20 6d 65  hen any error me
3380: 73 73 61 67 65 20 69 73 20 77 72 69 74 74 65 6e  ssage is written
3390: 20 69 6e 74 6f 20 6d 65 6d 6f 72 79 20 6f 62 74   into memory obt
33a0: 61 69 6e 65 64 0a 2a 2a 20 66 72 6f 6d 20 5b 73  ained.** from [s
33b0: 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d  qlite3_malloc()]
33c0: 20 61 6e 64 20 70 61 73 73 65 64 20 62 61 63 6b   and passed back
33d0: 20 74 68 72 6f 75 67 68 20 74 68 65 20 35 74 68   through the 5th
33e0: 20 70 61 72 61 6d 65 74 65 72 2e 0a 2a 2a 20 54   parameter..** T
33f0: 6f 20 61 76 6f 69 64 20 6d 65 6d 6f 72 79 20 6c  o avoid memory l
3400: 65 61 6b 73 2c 20 74 68 65 20 61 70 70 6c 69 63  eaks, the applic
3410: 61 74 69 6f 6e 20 73 68 6f 75 6c 64 20 69 6e 76  ation should inv
3420: 6f 6b 65 20 5b 73 71 6c 69 74 65 33 5f 66 72 65  oke [sqlite3_fre
3430: 65 28 29 5d 0a 2a 2a 20 6f 6e 20 65 72 72 6f 72  e()].** on error
3440: 20 6d 65 73 73 61 67 65 20 73 74 72 69 6e 67 73   message strings
3450: 20 72 65 74 75 72 6e 65 64 20 74 68 72 6f 75 67   returned throug
3460: 68 20 74 68 65 20 35 74 68 20 70 61 72 61 6d 65  h the 5th parame
3470: 74 65 72 20 6f 66 0a 2a 2a 20 6f 66 20 73 71 6c  ter of.** of sql
3480: 69 74 65 33 5f 65 78 65 63 28 29 20 61 66 74 65  ite3_exec() afte
3490: 72 20 74 68 65 20 65 72 72 6f 72 20 6d 65 73 73  r the error mess
34a0: 61 67 65 20 73 74 72 69 6e 67 20 69 73 20 6e 6f  age string is no
34b0: 20 6c 6f 6e 67 65 72 20 6e 65 65 64 65 64 2e 0a   longer needed..
34c0: 2a 2a 20 5e 49 66 20 74 68 65 20 35 74 68 20 70  ** ^If the 5th p
34d0: 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69  arameter to sqli
34e0: 74 65 33 5f 65 78 65 63 28 29 20 69 73 20 6e 6f  te3_exec() is no
34f0: 74 20 4e 55 4c 4c 20 61 6e 64 20 6e 6f 20 65 72  t NULL and no er
3500: 72 6f 72 73 0a 2a 2a 20 6f 63 63 75 72 2c 20 74  rors.** occur, t
3510: 68 65 6e 20 73 71 6c 69 74 65 33 5f 65 78 65 63  hen sqlite3_exec
3520: 28 29 20 73 65 74 73 20 74 68 65 20 70 6f 69 6e  () sets the poin
3530: 74 65 72 20 69 6e 20 69 74 73 20 35 74 68 20 70  ter in its 5th p
3540: 61 72 61 6d 65 74 65 72 20 74 6f 0a 2a 2a 20 4e  arameter to.** N
3550: 55 4c 4c 20 62 65 66 6f 72 65 20 72 65 74 75 72  ULL before retur
3560: 6e 69 6e 67 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20  ning..**.** ^If 
3570: 61 6e 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28  an sqlite3_exec(
3580: 29 20 63 61 6c 6c 62 61 63 6b 20 72 65 74 75 72  ) callback retur
3590: 6e 73 20 6e 6f 6e 2d 7a 65 72 6f 2c 20 74 68 65  ns non-zero, the
35a0: 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 0a   sqlite3_exec().
35b0: 2a 2a 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72  ** routine retur
35c0: 6e 73 20 53 51 4c 49 54 45 5f 41 42 4f 52 54 20  ns SQLITE_ABORT 
35d0: 77 69 74 68 6f 75 74 20 69 6e 76 6f 6b 69 6e 67  without invoking
35e0: 20 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 61 67   the callback ag
35f0: 61 69 6e 20 61 6e 64 0a 2a 2a 20 77 69 74 68 6f  ain and.** witho
3600: 75 74 20 72 75 6e 6e 69 6e 67 20 61 6e 79 20 73  ut running any s
3610: 75 62 73 65 71 75 65 6e 74 20 53 51 4c 20 73 74  ubsequent SQL st
3620: 61 74 65 6d 65 6e 74 73 2e 0a 2a 2a 0a 2a 2a 20  atements..**.** 
3630: 5e 54 68 65 20 32 6e 64 20 61 72 67 75 6d 65 6e  ^The 2nd argumen
3640: 74 20 74 6f 20 74 68 65 20 73 71 6c 69 74 65 33  t to the sqlite3
3650: 5f 65 78 65 63 28 29 20 63 61 6c 6c 62 61 63 6b  _exec() callback
3660: 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 74 68 65   function is the
3670: 0a 2a 2a 20 6e 75 6d 62 65 72 20 6f 66 20 63 6f  .** number of co
3680: 6c 75 6d 6e 73 20 69 6e 20 74 68 65 20 72 65 73  lumns in the res
3690: 75 6c 74 2e 20 20 5e 54 68 65 20 33 72 64 20 61  ult.  ^The 3rd a
36a0: 72 67 75 6d 65 6e 74 20 74 6f 20 74 68 65 20 73  rgument to the s
36b0: 71 6c 69 74 65 33 5f 65 78 65 63 28 29 0a 2a 2a  qlite3_exec().**
36c0: 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 61 6e 20   callback is an 
36d0: 61 72 72 61 79 20 6f 66 20 70 6f 69 6e 74 65 72  array of pointer
36e0: 73 20 74 6f 20 73 74 72 69 6e 67 73 20 6f 62 74  s to strings obt
36f0: 61 69 6e 65 64 20 61 73 20 69 66 20 66 72 6f 6d  ained as if from
3700: 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c  .** [sqlite3_col
3710: 75 6d 6e 5f 74 65 78 74 28 29 5d 2c 20 6f 6e 65  umn_text()], one
3720: 20 66 6f 72 20 65 61 63 68 20 63 6f 6c 75 6d 6e   for each column
3730: 2e 20 20 5e 49 66 20 61 6e 20 65 6c 65 6d 65 6e  .  ^If an elemen
3740: 74 20 6f 66 20 61 0a 2a 2a 20 72 65 73 75 6c 74  t of a.** result
3750: 20 72 6f 77 20 69 73 20 4e 55 4c 4c 20 74 68 65   row is NULL the
3760: 6e 20 74 68 65 20 63 6f 72 72 65 73 70 6f 6e 64  n the correspond
3770: 69 6e 67 20 73 74 72 69 6e 67 20 70 6f 69 6e 74  ing string point
3780: 65 72 20 66 6f 72 20 74 68 65 0a 2a 2a 20 73 71  er for the.** sq
3790: 6c 69 74 65 33 5f 65 78 65 63 28 29 20 63 61 6c  lite3_exec() cal
37a0: 6c 62 61 63 6b 20 69 73 20 61 20 4e 55 4c 4c 20  lback is a NULL 
37b0: 70 6f 69 6e 74 65 72 2e 20 20 5e 54 68 65 20 34  pointer.  ^The 4
37c0: 74 68 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 74  th argument to t
37d0: 68 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 65 78  he.** sqlite3_ex
37e0: 65 63 28 29 20 63 61 6c 6c 62 61 63 6b 20 69 73  ec() callback is
37f0: 20 61 6e 20 61 72 72 61 79 20 6f 66 20 70 6f 69   an array of poi
3800: 6e 74 65 72 73 20 74 6f 20 73 74 72 69 6e 67 73  nters to strings
3810: 20 77 68 65 72 65 20 65 61 63 68 0a 2a 2a 20 65   where each.** e
3820: 6e 74 72 79 20 72 65 70 72 65 73 65 6e 74 73 20  ntry represents 
3830: 74 68 65 20 6e 61 6d 65 20 6f 66 20 63 6f 72 72  the name of corr
3840: 65 73 70 6f 6e 64 69 6e 67 20 72 65 73 75 6c 74  esponding result
3850: 20 63 6f 6c 75 6d 6e 20 61 73 20 6f 62 74 61 69   column as obtai
3860: 6e 65 64 0a 2a 2a 20 66 72 6f 6d 20 5b 73 71 6c  ned.** from [sql
3870: 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6e 61 6d 65  ite3_column_name
3880: 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74  ()]..**.** ^If t
3890: 68 65 20 32 6e 64 20 70 61 72 61 6d 65 74 65 72  he 2nd parameter
38a0: 20 74 6f 20 73 71 6c 69 74 65 33 5f 65 78 65 63   to sqlite3_exec
38b0: 28 29 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69  () is a NULL poi
38c0: 6e 74 65 72 2c 20 61 20 70 6f 69 6e 74 65 72 0a  nter, a pointer.
38d0: 2a 2a 20 74 6f 20 61 6e 20 65 6d 70 74 79 20 73  ** to an empty s
38e0: 74 72 69 6e 67 2c 20 6f 72 20 61 20 70 6f 69 6e  tring, or a poin
38f0: 74 65 72 20 74 68 61 74 20 63 6f 6e 74 61 69 6e  ter that contain
3900: 73 20 6f 6e 6c 79 20 77 68 69 74 65 73 70 61 63  s only whitespac
3910: 65 20 61 6e 64 2f 6f 72 20 0a 2a 2a 20 53 51 4c  e and/or .** SQL
3920: 20 63 6f 6d 6d 65 6e 74 73 2c 20 74 68 65 6e 20   comments, then 
3930: 6e 6f 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  no SQL statement
3940: 73 20 61 72 65 20 65 76 61 6c 75 61 74 65 64 20  s are evaluated 
3950: 61 6e 64 20 74 68 65 20 64 61 74 61 62 61 73 65  and the database
3960: 0a 2a 2a 20 69 73 20 6e 6f 74 20 63 68 61 6e 67  .** is not chang
3970: 65 64 2e 0a 2a 2a 0a 2a 2a 20 52 65 73 74 72 69  ed..**.** Restri
3980: 63 74 69 6f 6e 73 3a 0a 2a 2a 0a 2a 2a 20 3c 75  ctions:.**.** <u
3990: 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20 54 68 65 20 61  l>.** <li> The a
39a0: 70 70 6c 69 63 61 74 69 6f 6e 20 6d 75 73 74 20  pplication must 
39b0: 69 6e 73 75 72 65 20 74 68 61 74 20 74 68 65 20  insure that the 
39c0: 31 73 74 20 70 61 72 61 6d 65 74 65 72 20 74 6f  1st parameter to
39d0: 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29 0a   sqlite3_exec().
39e0: 2a 2a 20 20 20 20 20 20 69 73 20 61 20 76 61 6c  **      is a val
39f0: 69 64 20 61 6e 64 20 6f 70 65 6e 20 5b 64 61 74  id and open [dat
3a00: 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
3a10: 5d 2e 0a 2a 2a 20 3c 6c 69 3e 20 54 68 65 20 61  ]..** <li> The a
3a20: 70 70 6c 69 63 61 74 69 6f 6e 20 6d 75 73 74 20  pplication must 
3a30: 6e 6f 74 20 63 6c 6f 73 65 20 5b 64 61 74 61 62  not close [datab
3a40: 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20  ase connection] 
3a50: 73 70 65 63 69 66 69 65 64 20 62 79 0a 2a 2a 20  specified by.** 
3a60: 20 20 20 20 20 74 68 65 20 31 73 74 20 70 61 72       the 1st par
3a70: 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65  ameter to sqlite
3a80: 33 5f 65 78 65 63 28 29 20 77 68 69 6c 65 20 73  3_exec() while s
3a90: 71 6c 69 74 65 33 5f 65 78 65 63 28 29 20 69 73  qlite3_exec() is
3aa0: 20 72 75 6e 6e 69 6e 67 2e 0a 2a 2a 20 3c 6c 69   running..** <li
3ab0: 3e 20 54 68 65 20 61 70 70 6c 69 63 61 74 69 6f  > The applicatio
3ac0: 6e 20 6d 75 73 74 20 6e 6f 74 20 6d 6f 64 69 66  n must not modif
3ad0: 79 20 74 68 65 20 53 51 4c 20 73 74 61 74 65 6d  y the SQL statem
3ae0: 65 6e 74 20 74 65 78 74 20 70 61 73 73 65 64 20  ent text passed 
3af0: 69 6e 74 6f 0a 2a 2a 20 20 20 20 20 20 74 68 65  into.**      the
3b00: 20 32 6e 64 20 70 61 72 61 6d 65 74 65 72 20 6f   2nd parameter o
3b10: 66 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28 29  f sqlite3_exec()
3b20: 20 77 68 69 6c 65 20 73 71 6c 69 74 65 33 5f 65   while sqlite3_e
3b30: 78 65 63 28 29 20 69 73 20 72 75 6e 6e 69 6e 67  xec() is running
3b40: 2e 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2f 0a 69 6e  ..** </ul>.*/.in
3b50: 74 20 73 71 6c 69 74 65 33 5f 65 78 65 63 28 0a  t sqlite3_exec(.
3b60: 20 20 73 71 6c 69 74 65 33 2a 2c 20 20 20 20 20    sqlite3*,     
3b70: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
3b80: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
3b90: 41 6e 20 6f 70 65 6e 20 64 61 74 61 62 61 73 65  An open database
3ba0: 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 63 68 61 72   */.  const char
3bb0: 20 2a 73 71 6c 2c 20 20 20 20 20 20 20 20 20 20   *sql,          
3bc0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
3bd0: 20 2f 2a 20 53 51 4c 20 74 6f 20 62 65 20 65 76   /* SQL to be ev
3be0: 61 6c 75 61 74 65 64 20 2a 2f 0a 20 20 69 6e 74  aluated */.  int
3bf0: 20 28 2a 63 61 6c 6c 62 61 63 6b 29 28 76 6f 69   (*callback)(voi
3c00: 64 2a 2c 69 6e 74 2c 63 68 61 72 2a 2a 2c 63 68  d*,int,char**,ch
3c10: 61 72 2a 2a 29 2c 20 20 2f 2a 20 43 61 6c 6c 62  ar**),  /* Callb
3c20: 61 63 6b 20 66 75 6e 63 74 69 6f 6e 20 2a 2f 0a  ack function */.
3c30: 20 20 76 6f 69 64 20 2a 2c 20 20 20 20 20 20 20    void *,       
3c40: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
3c50: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
3c60: 31 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f 20  1st argument to 
3c70: 63 61 6c 6c 62 61 63 6b 20 2a 2f 0a 20 20 63 68  callback */.  ch
3c80: 61 72 20 2a 2a 65 72 72 6d 73 67 20 20 20 20 20  ar **errmsg     
3c90: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
3ca0: 20 20 20 20 20 20 20 20 20 2f 2a 20 45 72 72 6f           /* Erro
3cb0: 72 20 6d 73 67 20 77 72 69 74 74 65 6e 20 68 65  r msg written he
3cc0: 72 65 20 2a 2f 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20  re */.);../*.** 
3cd0: 43 41 50 49 33 52 45 46 3a 20 52 65 73 75 6c 74  CAPI3REF: Result
3ce0: 20 43 6f 64 65 73 0a 2a 2a 20 4b 45 59 57 4f 52   Codes.** KEYWOR
3cf0: 44 53 3a 20 53 51 4c 49 54 45 5f 4f 4b 20 7b 65  DS: SQLITE_OK {e
3d00: 72 72 6f 72 20 63 6f 64 65 7d 20 7b 65 72 72 6f  rror code} {erro
3d10: 72 20 63 6f 64 65 73 7d 0a 2a 2a 20 4b 45 59 57  r codes}.** KEYW
3d20: 4f 52 44 53 3a 20 7b 72 65 73 75 6c 74 20 63 6f  ORDS: {result co
3d30: 64 65 7d 20 7b 72 65 73 75 6c 74 20 63 6f 64 65  de} {result code
3d40: 73 7d 0a 2a 2a 0a 2a 2a 20 4d 61 6e 79 20 53 51  s}.**.** Many SQ
3d50: 4c 69 74 65 20 66 75 6e 63 74 69 6f 6e 73 20 72  Lite functions r
3d60: 65 74 75 72 6e 20 61 6e 20 69 6e 74 65 67 65 72  eturn an integer
3d70: 20 72 65 73 75 6c 74 20 63 6f 64 65 20 66 72 6f   result code fro
3d80: 6d 20 74 68 65 20 73 65 74 20 73 68 6f 77 6e 0a  m the set shown.
3d90: 2a 2a 20 68 65 72 65 20 69 6e 20 6f 72 64 65 72  ** here in order
3da0: 20 74 6f 20 69 6e 64 69 63 61 74 65 73 20 73 75   to indicates su
3db0: 63 63 65 73 73 20 6f 72 20 66 61 69 6c 75 72 65  ccess or failure
3dc0: 2e 0a 2a 2a 0a 2a 2a 20 4e 65 77 20 65 72 72 6f  ..**.** New erro
3dd0: 72 20 63 6f 64 65 73 20 6d 61 79 20 62 65 20 61  r codes may be a
3de0: 64 64 65 64 20 69 6e 20 66 75 74 75 72 65 20 76  dded in future v
3df0: 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74  ersions of SQLit
3e00: 65 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73  e..**.** See als
3e10: 6f 3a 20 5b 53 51 4c 49 54 45 5f 49 4f 45 52 52  o: [SQLITE_IOERR
3e20: 5f 52 45 41 44 20 7c 20 65 78 74 65 6e 64 65 64  _READ | extended
3e30: 20 72 65 73 75 6c 74 20 63 6f 64 65 73 5d 0a 2a   result codes].*
3e40: 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
3e50: 5f 4f 4b 20 20 20 20 20 20 20 20 20 20 20 30 20  _OK           0 
3e60: 20 20 2f 2a 20 53 75 63 63 65 73 73 66 75 6c 20    /* Successful 
3e70: 72 65 73 75 6c 74 20 2a 2f 0a 2f 2a 20 62 65 67  result */./* beg
3e80: 69 6e 6e 69 6e 67 2d 6f 66 2d 65 72 72 6f 72 2d  inning-of-error-
3e90: 63 6f 64 65 73 20 2a 2f 0a 23 64 65 66 69 6e 65  codes */.#define
3ea0: 20 53 51 4c 49 54 45 5f 45 52 52 4f 52 20 20 20   SQLITE_ERROR   
3eb0: 20 20 20 20 20 31 20 20 20 2f 2a 20 53 51 4c 20       1   /* SQL 
3ec0: 65 72 72 6f 72 20 6f 72 20 6d 69 73 73 69 6e 67  error or missing
3ed0: 20 64 61 74 61 62 61 73 65 20 2a 2f 0a 23 64 65   database */.#de
3ee0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4e 54 45  fine SQLITE_INTE
3ef0: 52 4e 41 4c 20 20 20 20 20 32 20 20 20 2f 2a 20  RNAL     2   /* 
3f00: 49 6e 74 65 72 6e 61 6c 20 6c 6f 67 69 63 20 65  Internal logic e
3f10: 72 72 6f 72 20 69 6e 20 53 51 4c 69 74 65 20 2a  rror in SQLite *
3f20: 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
3f30: 5f 50 45 52 4d 20 20 20 20 20 20 20 20 20 33 20  _PERM         3 
3f40: 20 20 2f 2a 20 41 63 63 65 73 73 20 70 65 72 6d    /* Access perm
3f50: 69 73 73 69 6f 6e 20 64 65 6e 69 65 64 20 2a 2f  ission denied */
3f60: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
3f70: 41 42 4f 52 54 20 20 20 20 20 20 20 20 34 20 20  ABORT        4  
3f80: 20 2f 2a 20 43 61 6c 6c 62 61 63 6b 20 72 6f 75   /* Callback rou
3f90: 74 69 6e 65 20 72 65 71 75 65 73 74 65 64 20 61  tine requested a
3fa0: 6e 20 61 62 6f 72 74 20 2a 2f 0a 23 64 65 66 69  n abort */.#defi
3fb0: 6e 65 20 53 51 4c 49 54 45 5f 42 55 53 59 20 20  ne SQLITE_BUSY  
3fc0: 20 20 20 20 20 20 20 35 20 20 20 2f 2a 20 54 68         5   /* Th
3fd0: 65 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20  e database file 
3fe0: 69 73 20 6c 6f 63 6b 65 64 20 2a 2f 0a 23 64 65  is locked */.#de
3ff0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c 4f 43 4b  fine SQLITE_LOCK
4000: 45 44 20 20 20 20 20 20 20 36 20 20 20 2f 2a 20  ED       6   /* 
4010: 41 20 74 61 62 6c 65 20 69 6e 20 74 68 65 20 64  A table in the d
4020: 61 74 61 62 61 73 65 20 69 73 20 6c 6f 63 6b 65  atabase is locke
4030: 64 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  d */.#define SQL
4040: 49 54 45 5f 4e 4f 4d 45 4d 20 20 20 20 20 20 20  ITE_NOMEM       
4050: 20 37 20 20 20 2f 2a 20 41 20 6d 61 6c 6c 6f 63   7   /* A malloc
4060: 28 29 20 66 61 69 6c 65 64 20 2a 2f 0a 23 64 65  () failed */.#de
4070: 66 69 6e 65 20 53 51 4c 49 54 45 5f 52 45 41 44  fine SQLITE_READ
4080: 4f 4e 4c 59 20 20 20 20 20 38 20 20 20 2f 2a 20  ONLY     8   /* 
4090: 41 74 74 65 6d 70 74 20 74 6f 20 77 72 69 74 65  Attempt to write
40a0: 20 61 20 72 65 61 64 6f 6e 6c 79 20 64 61 74 61   a readonly data
40b0: 62 61 73 65 20 2a 2f 0a 23 64 65 66 69 6e 65 20  base */.#define 
40c0: 53 51 4c 49 54 45 5f 49 4e 54 45 52 52 55 50 54  SQLITE_INTERRUPT
40d0: 20 20 20 20 39 20 20 20 2f 2a 20 4f 70 65 72 61      9   /* Opera
40e0: 74 69 6f 6e 20 74 65 72 6d 69 6e 61 74 65 64 20  tion terminated 
40f0: 62 79 20 73 71 6c 69 74 65 33 5f 69 6e 74 65 72  by sqlite3_inter
4100: 72 75 70 74 28 29 2a 2f 0a 23 64 65 66 69 6e 65  rupt()*/.#define
4110: 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 20 20 20   SQLITE_IOERR   
4120: 20 20 20 20 31 30 20 20 20 2f 2a 20 53 6f 6d 65      10   /* Some
4130: 20 6b 69 6e 64 20 6f 66 20 64 69 73 6b 20 49 2f   kind of disk I/
4140: 4f 20 65 72 72 6f 72 20 6f 63 63 75 72 72 65 64  O error occurred
4150: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
4160: 54 45 5f 43 4f 52 52 55 50 54 20 20 20 20 20 31  TE_CORRUPT     1
4170: 31 20 20 20 2f 2a 20 54 68 65 20 64 61 74 61 62  1   /* The datab
4180: 61 73 65 20 64 69 73 6b 20 69 6d 61 67 65 20 69  ase disk image i
4190: 73 20 6d 61 6c 66 6f 72 6d 65 64 20 2a 2f 0a 23  s malformed */.#
41a0: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4e 4f  define SQLITE_NO
41b0: 54 46 4f 55 4e 44 20 20 20 20 31 32 20 20 20 2f  TFOUND    12   /
41c0: 2a 20 4e 4f 54 20 55 53 45 44 2e 20 54 61 62 6c  * NOT USED. Tabl
41d0: 65 20 6f 72 20 72 65 63 6f 72 64 20 6e 6f 74 20  e or record not 
41e0: 66 6f 75 6e 64 20 2a 2f 0a 23 64 65 66 69 6e 65  found */.#define
41f0: 20 53 51 4c 49 54 45 5f 46 55 4c 4c 20 20 20 20   SQLITE_FULL    
4200: 20 20 20 20 31 33 20 20 20 2f 2a 20 49 6e 73 65      13   /* Inse
4210: 72 74 69 6f 6e 20 66 61 69 6c 65 64 20 62 65 63  rtion failed bec
4220: 61 75 73 65 20 64 61 74 61 62 61 73 65 20 69 73  ause database is
4230: 20 66 75 6c 6c 20 2a 2f 0a 23 64 65 66 69 6e 65   full */.#define
4240: 20 53 51 4c 49 54 45 5f 43 41 4e 54 4f 50 45 4e   SQLITE_CANTOPEN
4250: 20 20 20 20 31 34 20 20 20 2f 2a 20 55 6e 61 62      14   /* Unab
4260: 6c 65 20 74 6f 20 6f 70 65 6e 20 74 68 65 20 64  le to open the d
4270: 61 74 61 62 61 73 65 20 66 69 6c 65 20 2a 2f 0a  atabase file */.
4280: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 50  #define SQLITE_P
4290: 52 4f 54 4f 43 4f 4c 20 20 20 20 31 35 20 20 20  ROTOCOL    15   
42a0: 2f 2a 20 44 61 74 61 62 61 73 65 20 6c 6f 63 6b  /* Database lock
42b0: 20 70 72 6f 74 6f 63 6f 6c 20 65 72 72 6f 72 20   protocol error 
42c0: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
42d0: 45 5f 45 4d 50 54 59 20 20 20 20 20 20 20 31 36  E_EMPTY       16
42e0: 20 20 20 2f 2a 20 44 61 74 61 62 61 73 65 20 69     /* Database i
42f0: 73 20 65 6d 70 74 79 20 2a 2f 0a 23 64 65 66 69  s empty */.#defi
4300: 6e 65 20 53 51 4c 49 54 45 5f 53 43 48 45 4d 41  ne SQLITE_SCHEMA
4310: 20 20 20 20 20 20 31 37 20 20 20 2f 2a 20 54 68        17   /* Th
4320: 65 20 64 61 74 61 62 61 73 65 20 73 63 68 65 6d  e database schem
4330: 61 20 63 68 61 6e 67 65 64 20 2a 2f 0a 23 64 65  a changed */.#de
4340: 66 69 6e 65 20 53 51 4c 49 54 45 5f 54 4f 4f 42  fine SQLITE_TOOB
4350: 49 47 20 20 20 20 20 20 31 38 20 20 20 2f 2a 20  IG      18   /* 
4360: 53 74 72 69 6e 67 20 6f 72 20 42 4c 4f 42 20 65  String or BLOB e
4370: 78 63 65 65 64 73 20 73 69 7a 65 20 6c 69 6d 69  xceeds size limi
4380: 74 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  t */.#define SQL
4390: 49 54 45 5f 43 4f 4e 53 54 52 41 49 4e 54 20 20  ITE_CONSTRAINT  
43a0: 31 39 20 20 20 2f 2a 20 41 62 6f 72 74 20 64 75  19   /* Abort du
43b0: 65 20 74 6f 20 63 6f 6e 73 74 72 61 69 6e 74 20  e to constraint 
43c0: 76 69 6f 6c 61 74 69 6f 6e 20 2a 2f 0a 23 64 65  violation */.#de
43d0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4d 49 53 4d  fine SQLITE_MISM
43e0: 41 54 43 48 20 20 20 20 32 30 20 20 20 2f 2a 20  ATCH    20   /* 
43f0: 44 61 74 61 20 74 79 70 65 20 6d 69 73 6d 61 74  Data type mismat
4400: 63 68 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  ch */.#define SQ
4410: 4c 49 54 45 5f 4d 49 53 55 53 45 20 20 20 20 20  LITE_MISUSE     
4420: 20 32 31 20 20 20 2f 2a 20 4c 69 62 72 61 72 79   21   /* Library
4430: 20 75 73 65 64 20 69 6e 63 6f 72 72 65 63 74 6c   used incorrectl
4440: 79 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  y */.#define SQL
4450: 49 54 45 5f 4e 4f 4c 46 53 20 20 20 20 20 20 20  ITE_NOLFS       
4460: 32 32 20 20 20 2f 2a 20 55 73 65 73 20 4f 53 20  22   /* Uses OS 
4470: 66 65 61 74 75 72 65 73 20 6e 6f 74 20 73 75 70  features not sup
4480: 70 6f 72 74 65 64 20 6f 6e 20 68 6f 73 74 20 2a  ported on host *
4490: 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
44a0: 5f 41 55 54 48 20 20 20 20 20 20 20 20 32 33 20  _AUTH        23 
44b0: 20 20 2f 2a 20 41 75 74 68 6f 72 69 7a 61 74 69    /* Authorizati
44c0: 6f 6e 20 64 65 6e 69 65 64 20 2a 2f 0a 23 64 65  on denied */.#de
44d0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 46 4f 52 4d  fine SQLITE_FORM
44e0: 41 54 20 20 20 20 20 20 32 34 20 20 20 2f 2a 20  AT      24   /* 
44f0: 41 75 78 69 6c 69 61 72 79 20 64 61 74 61 62 61  Auxiliary databa
4500: 73 65 20 66 6f 72 6d 61 74 20 65 72 72 6f 72 20  se format error 
4510: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
4520: 45 5f 52 41 4e 47 45 20 20 20 20 20 20 20 32 35  E_RANGE       25
4530: 20 20 20 2f 2a 20 32 6e 64 20 70 61 72 61 6d 65     /* 2nd parame
4540: 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 62  ter to sqlite3_b
4550: 69 6e 64 20 6f 75 74 20 6f 66 20 72 61 6e 67 65  ind out of range
4560: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
4570: 54 45 5f 4e 4f 54 41 44 42 20 20 20 20 20 20 32  TE_NOTADB      2
4580: 36 20 20 20 2f 2a 20 46 69 6c 65 20 6f 70 65 6e  6   /* File open
4590: 65 64 20 74 68 61 74 20 69 73 20 6e 6f 74 20 61  ed that is not a
45a0: 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 2a   database file *
45b0: 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
45c0: 5f 52 4f 57 20 20 20 20 20 20 20 20 20 31 30 30  _ROW         100
45d0: 20 20 2f 2a 20 73 71 6c 69 74 65 33 5f 73 74 65    /* sqlite3_ste
45e0: 70 28 29 20 68 61 73 20 61 6e 6f 74 68 65 72 20  p() has another 
45f0: 72 6f 77 20 72 65 61 64 79 20 2a 2f 0a 23 64 65  row ready */.#de
4600: 66 69 6e 65 20 53 51 4c 49 54 45 5f 44 4f 4e 45  fine SQLITE_DONE
4610: 20 20 20 20 20 20 20 20 31 30 31 20 20 2f 2a 20          101  /* 
4620: 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 20 68  sqlite3_step() h
4630: 61 73 20 66 69 6e 69 73 68 65 64 20 65 78 65 63  as finished exec
4640: 75 74 69 6e 67 20 2a 2f 0a 2f 2a 20 65 6e 64 2d  uting */./* end-
4650: 6f 66 2d 65 72 72 6f 72 2d 63 6f 64 65 73 20 2a  of-error-codes *
4660: 2f 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  /../*.** CAPI3RE
4670: 46 3a 20 45 78 74 65 6e 64 65 64 20 52 65 73 75  F: Extended Resu
4680: 6c 74 20 43 6f 64 65 73 0a 2a 2a 20 4b 45 59 57  lt Codes.** KEYW
4690: 4f 52 44 53 3a 20 7b 65 78 74 65 6e 64 65 64 20  ORDS: {extended 
46a0: 65 72 72 6f 72 20 63 6f 64 65 7d 20 7b 65 78 74  error code} {ext
46b0: 65 6e 64 65 64 20 65 72 72 6f 72 20 63 6f 64 65  ended error code
46c0: 73 7d 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20  s}.** KEYWORDS: 
46d0: 7b 65 78 74 65 6e 64 65 64 20 72 65 73 75 6c 74  {extended result
46e0: 20 63 6f 64 65 7d 20 7b 65 78 74 65 6e 64 65 64   code} {extended
46f0: 20 72 65 73 75 6c 74 20 63 6f 64 65 73 7d 0a 2a   result codes}.*
4700: 2a 0a 2a 2a 20 49 6e 20 69 74 73 20 64 65 66 61  *.** In its defa
4710: 75 6c 74 20 63 6f 6e 66 69 67 75 72 61 74 69 6f  ult configuratio
4720: 6e 2c 20 53 51 4c 69 74 65 20 41 50 49 20 72 6f  n, SQLite API ro
4730: 75 74 69 6e 65 73 20 72 65 74 75 72 6e 20 6f 6e  utines return on
4740: 65 20 6f 66 20 32 36 20 69 6e 74 65 67 65 72 0a  e of 26 integer.
4750: 2a 2a 20 5b 53 51 4c 49 54 45 5f 4f 4b 20 7c 20  ** [SQLITE_OK | 
4760: 72 65 73 75 6c 74 20 63 6f 64 65 73 5d 2e 20 20  result codes].  
4770: 48 6f 77 65 76 65 72 2c 20 65 78 70 65 72 69 65  However, experie
4780: 6e 63 65 20 68 61 73 20 73 68 6f 77 6e 20 74 68  nce has shown th
4790: 61 74 20 6d 61 6e 79 20 6f 66 0a 2a 2a 20 74 68  at many of.** th
47a0: 65 73 65 20 72 65 73 75 6c 74 20 63 6f 64 65 73  ese result codes
47b0: 20 61 72 65 20 74 6f 6f 20 63 6f 61 72 73 65 2d   are too coarse-
47c0: 67 72 61 69 6e 65 64 2e 20 20 54 68 65 79 20 64  grained.  They d
47d0: 6f 20 6e 6f 74 20 70 72 6f 76 69 64 65 20 61 73  o not provide as
47e0: 0a 2a 2a 20 6d 75 63 68 20 69 6e 66 6f 72 6d 61  .** much informa
47f0: 74 69 6f 6e 20 61 62 6f 75 74 20 70 72 6f 62 6c  tion about probl
4800: 65 6d 73 20 61 73 20 70 72 6f 67 72 61 6d 6d 65  ems as programme
4810: 72 73 20 6d 69 67 68 74 20 6c 69 6b 65 2e 20 20  rs might like.  
4820: 49 6e 20 61 6e 20 65 66 66 6f 72 74 20 74 6f 0a  In an effort to.
4830: 2a 2a 20 61 64 64 72 65 73 73 20 74 68 69 73 2c  ** address this,
4840: 20 6e 65 77 65 72 20 76 65 72 73 69 6f 6e 73 20   newer versions 
4850: 6f 66 20 53 51 4c 69 74 65 20 28 76 65 72 73 69  of SQLite (versi
4860: 6f 6e 20 33 2e 33 2e 38 20 61 6e 64 20 6c 61 74  on 3.3.8 and lat
4870: 65 72 29 20 69 6e 63 6c 75 64 65 0a 2a 2a 20 73  er) include.** s
4880: 75 70 70 6f 72 74 20 66 6f 72 20 61 64 64 69 74  upport for addit
4890: 69 6f 6e 61 6c 20 72 65 73 75 6c 74 20 63 6f 64  ional result cod
48a0: 65 73 20 74 68 61 74 20 70 72 6f 76 69 64 65 20  es that provide 
48b0: 6d 6f 72 65 20 64 65 74 61 69 6c 65 64 20 69 6e  more detailed in
48c0: 66 6f 72 6d 61 74 69 6f 6e 0a 2a 2a 20 61 62 6f  formation.** abo
48d0: 75 74 20 65 72 72 6f 72 73 2e 20 54 68 65 20 65  ut errors. The e
48e0: 78 74 65 6e 64 65 64 20 72 65 73 75 6c 74 20 63  xtended result c
48f0: 6f 64 65 73 20 61 72 65 20 65 6e 61 62 6c 65 64  odes are enabled
4900: 20 6f 72 20 64 69 73 61 62 6c 65 64 0a 2a 2a 20   or disabled.** 
4910: 6f 6e 20 61 20 70 65 72 20 64 61 74 61 62 61 73  on a per databas
4920: 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 62 61 73  e connection bas
4930: 69 73 20 75 73 69 6e 67 20 74 68 65 0a 2a 2a 20  is using the.** 
4940: 5b 73 71 6c 69 74 65 33 5f 65 78 74 65 6e 64 65  [sqlite3_extende
4950: 64 5f 72 65 73 75 6c 74 5f 63 6f 64 65 73 28 29  d_result_codes()
4960: 5d 20 41 50 49 2e 0a 2a 2a 0a 2a 2a 20 53 6f 6d  ] API..**.** Som
4970: 65 20 6f 66 20 74 68 65 20 61 76 61 69 6c 61 62  e of the availab
4980: 6c 65 20 65 78 74 65 6e 64 65 64 20 72 65 73 75  le extended resu
4990: 6c 74 20 63 6f 64 65 73 20 61 72 65 20 6c 69 73  lt codes are lis
49a0: 74 65 64 20 68 65 72 65 2e 0a 2a 2a 20 4f 6e 65  ted here..** One
49b0: 20 6d 61 79 20 65 78 70 65 63 74 20 74 68 65 20   may expect the 
49c0: 6e 75 6d 62 65 72 20 6f 66 20 65 78 74 65 6e 64  number of extend
49d0: 65 64 20 72 65 73 75 6c 74 20 63 6f 64 65 73 20  ed result codes 
49e0: 77 69 6c 6c 20 62 65 20 65 78 70 61 6e 64 0a 2a  will be expand.*
49f0: 2a 20 6f 76 65 72 20 74 69 6d 65 2e 20 20 53 6f  * over time.  So
4a00: 66 74 77 61 72 65 20 74 68 61 74 20 75 73 65 73  ftware that uses
4a10: 20 65 78 74 65 6e 64 65 64 20 72 65 73 75 6c 74   extended result
4a20: 20 63 6f 64 65 73 20 73 68 6f 75 6c 64 20 65 78   codes should ex
4a30: 70 65 63 74 0a 2a 2a 20 74 6f 20 73 65 65 20 6e  pect.** to see n
4a40: 65 77 20 72 65 73 75 6c 74 20 63 6f 64 65 73 20  ew result codes 
4a50: 69 6e 20 66 75 74 75 72 65 20 72 65 6c 65 61 73  in future releas
4a60: 65 73 20 6f 66 20 53 51 4c 69 74 65 2e 0a 2a 2a  es of SQLite..**
4a70: 0a 2a 2a 20 54 68 65 20 53 51 4c 49 54 45 5f 4f  .** The SQLITE_O
4a80: 4b 20 72 65 73 75 6c 74 20 63 6f 64 65 20 77 69  K result code wi
4a90: 6c 6c 20 6e 65 76 65 72 20 62 65 20 65 78 74 65  ll never be exte
4aa0: 6e 64 65 64 2e 20 20 49 74 20 77 69 6c 6c 20 61  nded.  It will a
4ab0: 6c 77 61 79 73 0a 2a 2a 20 62 65 20 65 78 61 63  lways.** be exac
4ac0: 74 6c 79 20 7a 65 72 6f 2e 0a 2a 2f 0a 23 64 65  tly zero..*/.#de
4ad0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52  fine SQLITE_IOER
4ae0: 52 5f 52 45 41 44 20 20 20 20 20 20 20 20 20 20  R_READ          
4af0: 20 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52      (SQLITE_IOER
4b00: 52 20 7c 20 28 31 3c 3c 38 29 29 0a 23 64 65 66  R | (1<<8)).#def
4b10: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  ine SQLITE_IOERR
4b20: 5f 53 48 4f 52 54 5f 52 45 41 44 20 20 20 20 20  _SHORT_READ     
4b30: 20 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52     (SQLITE_IOERR
4b40: 20 7c 20 28 32 3c 3c 38 29 29 0a 23 64 65 66 69   | (2<<8)).#defi
4b50: 6e 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f  ne SQLITE_IOERR_
4b60: 57 52 49 54 45 20 20 20 20 20 20 20 20 20 20 20  WRITE           
4b70: 20 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20    (SQLITE_IOERR 
4b80: 7c 20 28 33 3c 3c 38 29 29 0a 23 64 65 66 69 6e  | (3<<8)).#defin
4b90: 65 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f 46  e SQLITE_IOERR_F
4ba0: 53 59 4e 43 20 20 20 20 20 20 20 20 20 20 20 20  SYNC            
4bb0: 20 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20 7c   (SQLITE_IOERR |
4bc0: 20 28 34 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65   (4<<8)).#define
4bd0: 20 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f 44 49   SQLITE_IOERR_DI
4be0: 52 5f 46 53 59 4e 43 20 20 20 20 20 20 20 20 20  R_FSYNC         
4bf0: 28 53 51 4c 49 54 45 5f 49 4f 45 52 52 20 7c 20  (SQLITE_IOERR | 
4c00: 28 35 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20  (5<<8)).#define 
4c10: 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f 54 52 55  SQLITE_IOERR_TRU
4c20: 4e 43 41 54 45 20 20 20 20 20 20 20 20 20 20 28  NCATE          (
4c30: 53 51 4c 49 54 45 5f 49 4f 45 52 52 20 7c 20 28  SQLITE_IOERR | (
4c40: 36 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53  6<<8)).#define S
4c50: 51 4c 49 54 45 5f 49 4f 45 52 52 5f 46 53 54 41  QLITE_IOERR_FSTA
4c60: 54 20 20 20 20 20 20 20 20 20 20 20 20 20 28 53  T             (S
4c70: 51 4c 49 54 45 5f 49 4f 45 52 52 20 7c 20 28 37  QLITE_IOERR | (7
4c80: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
4c90: 4c 49 54 45 5f 49 4f 45 52 52 5f 55 4e 4c 4f 43  LITE_IOERR_UNLOC
4ca0: 4b 20 20 20 20 20 20 20 20 20 20 20 20 28 53 51  K            (SQ
4cb0: 4c 49 54 45 5f 49 4f 45 52 52 20 7c 20 28 38 3c  LITE_IOERR | (8<
4cc0: 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c  <8)).#define SQL
4cd0: 49 54 45 5f 49 4f 45 52 52 5f 52 44 4c 4f 43 4b  ITE_IOERR_RDLOCK
4ce0: 20 20 20 20 20 20 20 20 20 20 20 20 28 53 51 4c              (SQL
4cf0: 49 54 45 5f 49 4f 45 52 52 20 7c 20 28 39 3c 3c  ITE_IOERR | (9<<
4d00: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
4d10: 54 45 5f 49 4f 45 52 52 5f 44 45 4c 45 54 45 20  TE_IOERR_DELETE 
4d20: 20 20 20 20 20 20 20 20 20 20 20 28 53 51 4c 49             (SQLI
4d30: 54 45 5f 49 4f 45 52 52 20 7c 20 28 31 30 3c 3c  TE_IOERR | (10<<
4d40: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
4d50: 54 45 5f 49 4f 45 52 52 5f 42 4c 4f 43 4b 45 44  TE_IOERR_BLOCKED
4d60: 20 20 20 20 20 20 20 20 20 20 20 28 53 51 4c 49             (SQLI
4d70: 54 45 5f 49 4f 45 52 52 20 7c 20 28 31 31 3c 3c  TE_IOERR | (11<<
4d80: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
4d90: 54 45 5f 49 4f 45 52 52 5f 4e 4f 4d 45 4d 20 20  TE_IOERR_NOMEM  
4da0: 20 20 20 20 20 20 20 20 20 20 20 28 53 51 4c 49             (SQLI
4db0: 54 45 5f 49 4f 45 52 52 20 7c 20 28 31 32 3c 3c  TE_IOERR | (12<<
4dc0: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
4dd0: 54 45 5f 49 4f 45 52 52 5f 41 43 43 45 53 53 20  TE_IOERR_ACCESS 
4de0: 20 20 20 20 20 20 20 20 20 20 20 28 53 51 4c 49             (SQLI
4df0: 54 45 5f 49 4f 45 52 52 20 7c 20 28 31 33 3c 3c  TE_IOERR | (13<<
4e00: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
4e10: 54 45 5f 49 4f 45 52 52 5f 43 48 45 43 4b 52 45  TE_IOERR_CHECKRE
4e20: 53 45 52 56 45 44 4c 4f 43 4b 20 28 53 51 4c 49  SERVEDLOCK (SQLI
4e30: 54 45 5f 49 4f 45 52 52 20 7c 20 28 31 34 3c 3c  TE_IOERR | (14<<
4e40: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
4e50: 54 45 5f 49 4f 45 52 52 5f 4c 4f 43 4b 20 20 20  TE_IOERR_LOCK   
4e60: 20 20 20 20 20 20 20 20 20 20 20 28 53 51 4c 49             (SQLI
4e70: 54 45 5f 49 4f 45 52 52 20 7c 20 28 31 35 3c 3c  TE_IOERR | (15<<
4e80: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
4e90: 54 45 5f 49 4f 45 52 52 5f 43 4c 4f 53 45 20 20  TE_IOERR_CLOSE  
4ea0: 20 20 20 20 20 20 20 20 20 20 20 28 53 51 4c 49             (SQLI
4eb0: 54 45 5f 49 4f 45 52 52 20 7c 20 28 31 36 3c 3c  TE_IOERR | (16<<
4ec0: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
4ed0: 54 45 5f 49 4f 45 52 52 5f 44 49 52 5f 43 4c 4f  TE_IOERR_DIR_CLO
4ee0: 53 45 20 20 20 20 20 20 20 20 20 28 53 51 4c 49  SE         (SQLI
4ef0: 54 45 5f 49 4f 45 52 52 20 7c 20 28 31 37 3c 3c  TE_IOERR | (17<<
4f00: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
4f10: 54 45 5f 49 4f 45 52 52 5f 53 48 4d 4f 50 45 4e  TE_IOERR_SHMOPEN
4f20: 20 20 20 20 20 20 20 20 20 20 20 28 53 51 4c 49             (SQLI
4f30: 54 45 5f 49 4f 45 52 52 20 7c 20 28 31 38 3c 3c  TE_IOERR | (18<<
4f40: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
4f50: 54 45 5f 49 4f 45 52 52 5f 53 48 4d 53 49 5a 45  TE_IOERR_SHMSIZE
4f60: 20 20 20 20 20 20 20 20 20 20 20 28 53 51 4c 49             (SQLI
4f70: 54 45 5f 49 4f 45 52 52 20 7c 20 28 31 39 3c 3c  TE_IOERR | (19<<
4f80: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
4f90: 54 45 5f 49 4f 45 52 52 5f 53 48 4d 4c 4f 43 4b  TE_IOERR_SHMLOCK
4fa0: 20 20 20 20 20 20 20 20 20 20 20 28 53 51 4c 49             (SQLI
4fb0: 54 45 5f 49 4f 45 52 52 20 7c 20 28 32 30 3c 3c  TE_IOERR | (20<<
4fc0: 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  8)).#define SQLI
4fd0: 54 45 5f 4c 4f 43 4b 45 44 5f 53 48 41 52 45 44  TE_LOCKED_SHARED
4fe0: 43 41 43 48 45 20 20 20 20 20 20 28 53 51 4c 49  CACHE      (SQLI
4ff0: 54 45 5f 4c 4f 43 4b 45 44 20 7c 20 20 28 31 3c  TE_LOCKED |  (1<
5000: 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51 4c  <8)).#define SQL
5010: 49 54 45 5f 42 55 53 59 5f 52 45 43 4f 56 45 52  ITE_BUSY_RECOVER
5020: 59 20 20 20 20 20 20 20 20 20 20 20 28 53 51 4c  Y           (SQL
5030: 49 54 45 5f 42 55 53 59 20 20 20 7c 20 20 28 31  ITE_BUSY   |  (1
5040: 3c 3c 38 29 29 0a 23 64 65 66 69 6e 65 20 53 51  <<8)).#define SQ
5050: 4c 49 54 45 5f 43 41 4e 54 4f 50 45 4e 5f 4e 4f  LITE_CANTOPEN_NO
5060: 54 45 4d 50 44 49 52 20 20 20 20 20 20 28 53 51  TEMPDIR      (SQ
5070: 4c 49 54 45 5f 43 41 4e 54 4f 50 45 4e 20 7c 20  LITE_CANTOPEN | 
5080: 28 31 3c 3c 38 29 29 0a 0a 2f 2a 0a 2a 2a 20 43  (1<<8))../*.** C
5090: 41 50 49 33 52 45 46 3a 20 46 6c 61 67 73 20 46  API3REF: Flags F
50a0: 6f 72 20 46 69 6c 65 20 4f 70 65 6e 20 4f 70 65  or File Open Ope
50b0: 72 61 74 69 6f 6e 73 0a 2a 2a 0a 2a 2a 20 54 68  rations.**.** Th
50c0: 65 73 65 20 62 69 74 20 76 61 6c 75 65 73 20 61  ese bit values a
50d0: 72 65 20 69 6e 74 65 6e 64 65 64 20 66 6f 72 20  re intended for 
50e0: 75 73 65 20 69 6e 20 74 68 65 0a 2a 2a 20 33 72  use in the.** 3r
50f0: 64 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 74  d parameter to t
5100: 68 65 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e  he [sqlite3_open
5110: 5f 76 32 28 29 5d 20 69 6e 74 65 72 66 61 63 65  _v2()] interface
5120: 20 61 6e 64 0a 2a 2a 20 69 6e 20 74 68 65 20 34   and.** in the 4
5130: 74 68 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20  th parameter to 
5140: 74 68 65 20 78 4f 70 65 6e 20 6d 65 74 68 6f 64  the xOpen method
5150: 20 6f 66 20 74 68 65 0a 2a 2a 20 5b 73 71 6c 69   of the.** [sqli
5160: 74 65 33 5f 76 66 73 5d 20 6f 62 6a 65 63 74 2e  te3_vfs] object.
5170: 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  .*/.#define SQLI
5180: 54 45 5f 4f 50 45 4e 5f 52 45 41 44 4f 4e 4c 59  TE_OPEN_READONLY
5190: 20 20 20 20 20 20 20 20 20 30 78 30 30 30 30 30           0x00000
51a0: 30 30 31 20 20 2f 2a 20 4f 6b 20 66 6f 72 20 73  001  /* Ok for s
51b0: 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29  qlite3_open_v2()
51c0: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
51d0: 54 45 5f 4f 50 45 4e 5f 52 45 41 44 57 52 49 54  TE_OPEN_READWRIT
51e0: 45 20 20 20 20 20 20 20 20 30 78 30 30 30 30 30  E        0x00000
51f0: 30 30 32 20 20 2f 2a 20 4f 6b 20 66 6f 72 20 73  002  /* Ok for s
5200: 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29  qlite3_open_v2()
5210: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
5220: 54 45 5f 4f 50 45 4e 5f 43 52 45 41 54 45 20 20  TE_OPEN_CREATE  
5230: 20 20 20 20 20 20 20 20 20 30 78 30 30 30 30 30           0x00000
5240: 30 30 34 20 20 2f 2a 20 4f 6b 20 66 6f 72 20 73  004  /* Ok for s
5250: 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29  qlite3_open_v2()
5260: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
5270: 54 45 5f 4f 50 45 4e 5f 44 45 4c 45 54 45 4f 4e  TE_OPEN_DELETEON
5280: 43 4c 4f 53 45 20 20 20 20 30 78 30 30 30 30 30  CLOSE    0x00000
5290: 30 30 38 20 20 2f 2a 20 56 46 53 20 6f 6e 6c 79  008  /* VFS only
52a0: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
52b0: 54 45 5f 4f 50 45 4e 5f 45 58 43 4c 55 53 49 56  TE_OPEN_EXCLUSIV
52c0: 45 20 20 20 20 20 20 20 20 30 78 30 30 30 30 30  E        0x00000
52d0: 30 31 30 20 20 2f 2a 20 56 46 53 20 6f 6e 6c 79  010  /* VFS only
52e0: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
52f0: 54 45 5f 4f 50 45 4e 5f 41 55 54 4f 50 52 4f 58  TE_OPEN_AUTOPROX
5300: 59 20 20 20 20 20 20 20 20 30 78 30 30 30 30 30  Y        0x00000
5310: 30 32 30 20 20 2f 2a 20 56 46 53 20 6f 6e 6c 79  020  /* VFS only
5320: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
5330: 54 45 5f 4f 50 45 4e 5f 4d 41 49 4e 5f 44 42 20  TE_OPEN_MAIN_DB 
5340: 20 20 20 20 20 20 20 20 20 30 78 30 30 30 30 30           0x00000
5350: 31 30 30 20 20 2f 2a 20 56 46 53 20 6f 6e 6c 79  100  /* VFS only
5360: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
5370: 54 45 5f 4f 50 45 4e 5f 54 45 4d 50 5f 44 42 20  TE_OPEN_TEMP_DB 
5380: 20 20 20 20 20 20 20 20 20 30 78 30 30 30 30 30           0x00000
5390: 32 30 30 20 20 2f 2a 20 56 46 53 20 6f 6e 6c 79  200  /* VFS only
53a0: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
53b0: 54 45 5f 4f 50 45 4e 5f 54 52 41 4e 53 49 45 4e  TE_OPEN_TRANSIEN
53c0: 54 5f 44 42 20 20 20 20 20 30 78 30 30 30 30 30  T_DB     0x00000
53d0: 34 30 30 20 20 2f 2a 20 56 46 53 20 6f 6e 6c 79  400  /* VFS only
53e0: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
53f0: 54 45 5f 4f 50 45 4e 5f 4d 41 49 4e 5f 4a 4f 55  TE_OPEN_MAIN_JOU
5400: 52 4e 41 4c 20 20 20 20 20 30 78 30 30 30 30 30  RNAL     0x00000
5410: 38 30 30 20 20 2f 2a 20 56 46 53 20 6f 6e 6c 79  800  /* VFS only
5420: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
5430: 54 45 5f 4f 50 45 4e 5f 54 45 4d 50 5f 4a 4f 55  TE_OPEN_TEMP_JOU
5440: 52 4e 41 4c 20 20 20 20 20 30 78 30 30 30 30 31  RNAL     0x00001
5450: 30 30 30 20 20 2f 2a 20 56 46 53 20 6f 6e 6c 79  000  /* VFS only
5460: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
5470: 54 45 5f 4f 50 45 4e 5f 53 55 42 4a 4f 55 52 4e  TE_OPEN_SUBJOURN
5480: 41 4c 20 20 20 20 20 20 20 30 78 30 30 30 30 32  AL       0x00002
5490: 30 30 30 20 20 2f 2a 20 56 46 53 20 6f 6e 6c 79  000  /* VFS only
54a0: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
54b0: 54 45 5f 4f 50 45 4e 5f 4d 41 53 54 45 52 5f 4a  TE_OPEN_MASTER_J
54c0: 4f 55 52 4e 41 4c 20 20 20 30 78 30 30 30 30 34  OURNAL   0x00004
54d0: 30 30 30 20 20 2f 2a 20 56 46 53 20 6f 6e 6c 79  000  /* VFS only
54e0: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
54f0: 54 45 5f 4f 50 45 4e 5f 4e 4f 4d 55 54 45 58 20  TE_OPEN_NOMUTEX 
5500: 20 20 20 20 20 20 20 20 20 30 78 30 30 30 30 38           0x00008
5510: 30 30 30 20 20 2f 2a 20 4f 6b 20 66 6f 72 20 73  000  /* Ok for s
5520: 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29  qlite3_open_v2()
5530: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
5540: 54 45 5f 4f 50 45 4e 5f 46 55 4c 4c 4d 55 54 45  TE_OPEN_FULLMUTE
5550: 58 20 20 20 20 20 20 20 20 30 78 30 30 30 31 30  X        0x00010
5560: 30 30 30 20 20 2f 2a 20 4f 6b 20 66 6f 72 20 73  000  /* Ok for s
5570: 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29  qlite3_open_v2()
5580: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
5590: 54 45 5f 4f 50 45 4e 5f 53 48 41 52 45 44 43 41  TE_OPEN_SHAREDCA
55a0: 43 48 45 20 20 20 20 20 20 30 78 30 30 30 32 30  CHE      0x00020
55b0: 30 30 30 20 20 2f 2a 20 4f 6b 20 66 6f 72 20 73  000  /* Ok for s
55c0: 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29  qlite3_open_v2()
55d0: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
55e0: 54 45 5f 4f 50 45 4e 5f 50 52 49 56 41 54 45 43  TE_OPEN_PRIVATEC
55f0: 41 43 48 45 20 20 20 20 20 30 78 30 30 30 34 30  ACHE     0x00040
5600: 30 30 30 20 20 2f 2a 20 4f 6b 20 66 6f 72 20 73  000  /* Ok for s
5610: 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29  qlite3_open_v2()
5620: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
5630: 54 45 5f 4f 50 45 4e 5f 57 41 4c 20 20 20 20 20  TE_OPEN_WAL     
5640: 20 20 20 20 20 20 20 20 20 30 78 30 30 30 38 30           0x00080
5650: 30 30 30 20 20 2f 2a 20 56 46 53 20 6f 6e 6c 79  000  /* VFS only
5660: 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33   */../*.** CAPI3
5670: 52 45 46 3a 20 44 65 76 69 63 65 20 43 68 61 72  REF: Device Char
5680: 61 63 74 65 72 69 73 74 69 63 73 0a 2a 2a 0a 2a  acteristics.**.*
5690: 2a 20 54 68 65 20 78 44 65 76 69 63 65 43 68 61  * The xDeviceCha
56a0: 72 61 63 74 65 72 69 73 74 69 63 73 20 6d 65 74  racteristics met
56b0: 68 6f 64 20 6f 66 20 74 68 65 20 5b 73 71 6c 69  hod of the [sqli
56c0: 74 65 33 5f 69 6f 5f 6d 65 74 68 6f 64 73 5d 0a  te3_io_methods].
56d0: 2a 2a 20 6f 62 6a 65 63 74 20 72 65 74 75 72 6e  ** object return
56e0: 73 20 61 6e 20 69 6e 74 65 67 65 72 20 77 68 69  s an integer whi
56f0: 63 68 20 69 73 20 61 20 76 65 63 74 6f 72 20 6f  ch is a vector o
5700: 66 20 74 68 65 20 74 68 65 73 65 0a 2a 2a 20 62  f the these.** b
5710: 69 74 20 76 61 6c 75 65 73 20 65 78 70 72 65 73  it values expres
5720: 73 69 6e 67 20 49 2f 4f 20 63 68 61 72 61 63 74  sing I/O charact
5730: 65 72 69 73 74 69 63 73 20 6f 66 20 74 68 65 20  eristics of the 
5740: 6d 61 73 73 20 73 74 6f 72 61 67 65 0a 2a 2a 20  mass storage.** 
5750: 64 65 76 69 63 65 20 74 68 61 74 20 68 6f 6c 64  device that hold
5760: 73 20 74 68 65 20 66 69 6c 65 20 74 68 61 74 20  s the file that 
5770: 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 69 6f 5f  the [sqlite3_io_
5780: 6d 65 74 68 6f 64 73 5d 0a 2a 2a 20 72 65 66 65  methods].** refe
5790: 72 73 20 74 6f 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  rs to..**.** The
57a0: 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 41 54   SQLITE_IOCAP_AT
57b0: 4f 4d 49 43 20 70 72 6f 70 65 72 74 79 20 6d 65  OMIC property me
57c0: 61 6e 73 20 74 68 61 74 20 61 6c 6c 20 77 72 69  ans that all wri
57d0: 74 65 73 20 6f 66 0a 2a 2a 20 61 6e 79 20 73 69  tes of.** any si
57e0: 7a 65 20 61 72 65 20 61 74 6f 6d 69 63 2e 20 20  ze are atomic.  
57f0: 54 68 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50  The SQLITE_IOCAP
5800: 5f 41 54 4f 4d 49 43 6e 6e 6e 20 76 61 6c 75 65  _ATOMICnnn value
5810: 73 0a 2a 2a 20 6d 65 61 6e 20 74 68 61 74 20 77  s.** mean that w
5820: 72 69 74 65 73 20 6f 66 20 62 6c 6f 63 6b 73 20  rites of blocks 
5830: 74 68 61 74 20 61 72 65 20 6e 6e 6e 20 62 79 74  that are nnn byt
5840: 65 73 20 69 6e 20 73 69 7a 65 20 61 6e 64 0a 2a  es in size and.*
5850: 2a 20 61 72 65 20 61 6c 69 67 6e 65 64 20 74 6f  * are aligned to
5860: 20 61 6e 20 61 64 64 72 65 73 73 20 77 68 69 63   an address whic
5870: 68 20 69 73 20 61 6e 20 69 6e 74 65 67 65 72 20  h is an integer 
5880: 6d 75 6c 74 69 70 6c 65 20 6f 66 0a 2a 2a 20 6e  multiple of.** n
5890: 6e 6e 20 61 72 65 20 61 74 6f 6d 69 63 2e 20 20  nn are atomic.  
58a0: 54 68 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50  The SQLITE_IOCAP
58b0: 5f 53 41 46 45 5f 41 50 50 45 4e 44 20 76 61 6c  _SAFE_APPEND val
58c0: 75 65 20 6d 65 61 6e 73 0a 2a 2a 20 74 68 61 74  ue means.** that
58d0: 20 77 68 65 6e 20 64 61 74 61 20 69 73 20 61 70   when data is ap
58e0: 70 65 6e 64 65 64 20 74 6f 20 61 20 66 69 6c 65  pended to a file
58f0: 2c 20 74 68 65 20 64 61 74 61 20 69 73 20 61 70  , the data is ap
5900: 70 65 6e 64 65 64 0a 2a 2a 20 66 69 72 73 74 20  pended.** first 
5910: 74 68 65 6e 20 74 68 65 20 73 69 7a 65 20 6f 66  then the size of
5920: 20 74 68 65 20 66 69 6c 65 20 69 73 20 65 78 74   the file is ext
5930: 65 6e 64 65 64 2c 20 6e 65 76 65 72 20 74 68 65  ended, never the
5940: 20 6f 74 68 65 72 0a 2a 2a 20 77 61 79 20 61 72   other.** way ar
5950: 6f 75 6e 64 2e 20 20 54 68 65 20 53 51 4c 49 54  ound.  The SQLIT
5960: 45 5f 49 4f 43 41 50 5f 53 45 51 55 45 4e 54 49  E_IOCAP_SEQUENTI
5970: 41 4c 20 70 72 6f 70 65 72 74 79 20 6d 65 61 6e  AL property mean
5980: 73 20 74 68 61 74 0a 2a 2a 20 69 6e 66 6f 72 6d  s that.** inform
5990: 61 74 69 6f 6e 20 69 73 20 77 72 69 74 74 65 6e  ation is written
59a0: 20 74 6f 20 64 69 73 6b 20 69 6e 20 74 68 65 20   to disk in the 
59b0: 73 61 6d 65 20 6f 72 64 65 72 20 61 73 20 63 61  same order as ca
59c0: 6c 6c 73 0a 2a 2a 20 74 6f 20 78 57 72 69 74 65  lls.** to xWrite
59d0: 28 29 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53  ()..*/.#define S
59e0: 51 4c 49 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d  QLITE_IOCAP_ATOM
59f0: 49 43 20 20 20 20 20 20 20 20 20 20 20 20 20 20  IC              
5a00: 20 20 20 30 78 30 30 30 30 30 30 30 31 0a 23 64     0x00000001.#d
5a10: 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 43  efine SQLITE_IOC
5a20: 41 50 5f 41 54 4f 4d 49 43 35 31 32 20 20 20 20  AP_ATOMIC512    
5a30: 20 20 20 20 20 20 20 20 20 20 30 78 30 30 30 30            0x0000
5a40: 30 30 30 32 0a 23 64 65 66 69 6e 65 20 53 51 4c  0002.#define SQL
5a50: 49 54 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43  ITE_IOCAP_ATOMIC
5a60: 31 4b 20 20 20 20 20 20 20 20 20 20 20 20 20 20  1K              
5a70: 20 30 78 30 30 30 30 30 30 30 34 0a 23 64 65 66   0x00000004.#def
5a80: 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50  ine SQLITE_IOCAP
5a90: 5f 41 54 4f 4d 49 43 32 4b 20 20 20 20 20 20 20  _ATOMIC2K       
5aa0: 20 20 20 20 20 20 20 20 30 78 30 30 30 30 30 30          0x000000
5ab0: 30 38 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  08.#define SQLIT
5ac0: 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 34 4b  E_IOCAP_ATOMIC4K
5ad0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 30                 0
5ae0: 78 30 30 30 30 30 30 31 30 0a 23 64 65 66 69 6e  x00000010.#defin
5af0: 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 41  e SQLITE_IOCAP_A
5b00: 54 4f 4d 49 43 38 4b 20 20 20 20 20 20 20 20 20  TOMIC8K         
5b10: 20 20 20 20 20 20 30 78 30 30 30 30 30 30 32 30        0x00000020
5b20: 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
5b30: 49 4f 43 41 50 5f 41 54 4f 4d 49 43 31 36 4b 20  IOCAP_ATOMIC16K 
5b40: 20 20 20 20 20 20 20 20 20 20 20 20 20 30 78 30               0x0
5b50: 30 30 30 30 30 34 30 0a 23 64 65 66 69 6e 65 20  0000040.#define 
5b60: 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 41 54 4f  SQLITE_IOCAP_ATO
5b70: 4d 49 43 33 32 4b 20 20 20 20 20 20 20 20 20 20  MIC32K          
5b80: 20 20 20 20 30 78 30 30 30 30 30 30 38 30 0a 23      0x00000080.#
5b90: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f  define SQLITE_IO
5ba0: 43 41 50 5f 41 54 4f 4d 49 43 36 34 4b 20 20 20  CAP_ATOMIC64K   
5bb0: 20 20 20 20 20 20 20 20 20 20 20 30 78 30 30 30             0x000
5bc0: 30 30 31 30 30 0a 23 64 65 66 69 6e 65 20 53 51  00100.#define SQ
5bd0: 4c 49 54 45 5f 49 4f 43 41 50 5f 53 41 46 45 5f  LITE_IOCAP_SAFE_
5be0: 41 50 50 45 4e 44 20 20 20 20 20 20 20 20 20 20  APPEND          
5bf0: 20 20 30 78 30 30 30 30 30 32 30 30 0a 23 64 65    0x00000200.#de
5c00: 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4f 43 41  fine SQLITE_IOCA
5c10: 50 5f 53 45 51 55 45 4e 54 49 41 4c 20 20 20 20  P_SEQUENTIAL    
5c20: 20 20 20 20 20 20 20 20 20 30 78 30 30 30 30 30           0x00000
5c30: 34 30 30 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  400.#define SQLI
5c40: 54 45 5f 49 4f 43 41 50 5f 55 4e 44 45 4c 45 54  TE_IOCAP_UNDELET
5c50: 41 42 4c 45 5f 57 48 45 4e 5f 4f 50 45 4e 20 20  ABLE_WHEN_OPEN  
5c60: 30 78 30 30 30 30 30 38 30 30 0a 0a 2f 2a 0a 2a  0x00000800../*.*
5c70: 2a 20 43 41 50 49 33 52 45 46 3a 20 46 69 6c 65  * CAPI3REF: File
5c80: 20 4c 6f 63 6b 69 6e 67 20 4c 65 76 65 6c 73 0a   Locking Levels.
5c90: 2a 2a 0a 2a 2a 20 53 51 4c 69 74 65 20 75 73 65  **.** SQLite use
5ca0: 73 20 6f 6e 65 20 6f 66 20 74 68 65 73 65 20 69  s one of these i
5cb0: 6e 74 65 67 65 72 20 76 61 6c 75 65 73 20 61 73  nteger values as
5cc0: 20 74 68 65 20 73 65 63 6f 6e 64 0a 2a 2a 20 61   the second.** a
5cd0: 72 67 75 6d 65 6e 74 20 74 6f 20 63 61 6c 6c 73  rgument to calls
5ce0: 20 69 74 20 6d 61 6b 65 73 20 74 6f 20 74 68 65   it makes to the
5cf0: 20 78 4c 6f 63 6b 28 29 20 61 6e 64 20 78 55 6e   xLock() and xUn
5d00: 6c 6f 63 6b 28 29 20 6d 65 74 68 6f 64 73 0a 2a  lock() methods.*
5d10: 2a 20 6f 66 20 61 6e 20 5b 73 71 6c 69 74 65 33  * of an [sqlite3
5d20: 5f 69 6f 5f 6d 65 74 68 6f 64 73 5d 20 6f 62 6a  _io_methods] obj
5d30: 65 63 74 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20  ect..*/.#define 
5d40: 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 4e 4f 4e 45  SQLITE_LOCK_NONE
5d50: 20 20 20 20 20 20 20 20 20 20 30 0a 23 64 65 66            0.#def
5d60: 69 6e 65 20 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f  ine SQLITE_LOCK_
5d70: 53 48 41 52 45 44 20 20 20 20 20 20 20 20 31 0a  SHARED        1.
5d80: 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c  #define SQLITE_L
5d90: 4f 43 4b 5f 52 45 53 45 52 56 45 44 20 20 20 20  OCK_RESERVED    
5da0: 20 20 32 0a 23 64 65 66 69 6e 65 20 53 51 4c 49    2.#define SQLI
5db0: 54 45 5f 4c 4f 43 4b 5f 50 45 4e 44 49 4e 47 20  TE_LOCK_PENDING 
5dc0: 20 20 20 20 20 20 33 0a 23 64 65 66 69 6e 65 20        3.#define 
5dd0: 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 45 58 43 4c  SQLITE_LOCK_EXCL
5de0: 55 53 49 56 45 20 20 20 20 20 34 0a 0a 2f 2a 0a  USIVE     4../*.
5df0: 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 53 79 6e  ** CAPI3REF: Syn
5e00: 63 68 72 6f 6e 69 7a 61 74 69 6f 6e 20 54 79 70  chronization Typ
5e10: 65 20 46 6c 61 67 73 0a 2a 2a 0a 2a 2a 20 57 68  e Flags.**.** Wh
5e20: 65 6e 20 53 51 4c 69 74 65 20 69 6e 76 6f 6b 65  en SQLite invoke
5e30: 73 20 74 68 65 20 78 53 79 6e 63 28 29 20 6d 65  s the xSync() me
5e40: 74 68 6f 64 20 6f 66 20 61 6e 0a 2a 2a 20 5b 73  thod of an.** [s
5e50: 71 6c 69 74 65 33 5f 69 6f 5f 6d 65 74 68 6f 64  qlite3_io_method
5e60: 73 5d 20 6f 62 6a 65 63 74 20 69 74 20 75 73 65  s] object it use
5e70: 73 20 61 20 63 6f 6d 62 69 6e 61 74 69 6f 6e 20  s a combination 
5e80: 6f 66 0a 2a 2a 20 74 68 65 73 65 20 69 6e 74 65  of.** these inte
5e90: 67 65 72 20 76 61 6c 75 65 73 20 61 73 20 74 68  ger values as th
5ea0: 65 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e  e second argumen
5eb0: 74 2e 0a 2a 2a 0a 2a 2a 20 57 68 65 6e 20 74 68  t..**.** When th
5ec0: 65 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 44 41  e SQLITE_SYNC_DA
5ed0: 54 41 4f 4e 4c 59 20 66 6c 61 67 20 69 73 20 75  TAONLY flag is u
5ee0: 73 65 64 2c 20 69 74 20 6d 65 61 6e 73 20 74 68  sed, it means th
5ef0: 61 74 20 74 68 65 0a 2a 2a 20 73 79 6e 63 20 6f  at the.** sync o
5f00: 70 65 72 61 74 69 6f 6e 20 6f 6e 6c 79 20 6e 65  peration only ne
5f10: 65 64 73 20 74 6f 20 66 6c 75 73 68 20 64 61 74  eds to flush dat
5f20: 61 20 74 6f 20 6d 61 73 73 20 73 74 6f 72 61 67  a to mass storag
5f30: 65 2e 20 20 49 6e 6f 64 65 0a 2a 2a 20 69 6e 66  e.  Inode.** inf
5f40: 6f 72 6d 61 74 69 6f 6e 20 6e 65 65 64 20 6e 6f  ormation need no
5f50: 74 20 62 65 20 66 6c 75 73 68 65 64 2e 20 49 66  t be flushed. If
5f60: 20 74 68 65 20 6c 6f 77 65 72 20 66 6f 75 72 20   the lower four 
5f70: 62 69 74 73 20 6f 66 20 74 68 65 20 66 6c 61 67  bits of the flag
5f80: 0a 2a 2a 20 65 71 75 61 6c 20 53 51 4c 49 54 45  .** equal SQLITE
5f90: 5f 53 59 4e 43 5f 4e 4f 52 4d 41 4c 2c 20 74 68  _SYNC_NORMAL, th
5fa0: 61 74 20 6d 65 61 6e 73 20 74 6f 20 75 73 65 20  at means to use 
5fb0: 6e 6f 72 6d 61 6c 20 66 73 79 6e 63 28 29 20 73  normal fsync() s
5fc0: 65 6d 61 6e 74 69 63 73 2e 0a 2a 2a 20 49 66 20  emantics..** If 
5fd0: 74 68 65 20 6c 6f 77 65 72 20 66 6f 75 72 20 62  the lower four b
5fe0: 69 74 73 20 65 71 75 61 6c 20 53 51 4c 49 54 45  its equal SQLITE
5ff0: 5f 53 59 4e 43 5f 46 55 4c 4c 2c 20 74 68 61 74  _SYNC_FULL, that
6000: 20 6d 65 61 6e 73 0a 2a 2a 20 74 6f 20 75 73 65   means.** to use
6010: 20 4d 61 63 20 4f 53 20 58 20 73 74 79 6c 65 20   Mac OS X style 
6020: 66 75 6c 6c 73 79 6e 63 20 69 6e 73 74 65 61 64  fullsync instead
6030: 20 6f 66 20 66 73 79 6e 63 28 29 2e 0a 2a 2a 0a   of fsync()..**.
6040: 2a 2a 20 44 6f 20 6e 6f 74 20 63 6f 6e 66 75 73  ** Do not confus
6050: 65 20 74 68 65 20 53 51 4c 49 54 45 5f 53 59 4e  e the SQLITE_SYN
6060: 43 5f 4e 4f 52 4d 41 4c 20 61 6e 64 20 53 51 4c  C_NORMAL and SQL
6070: 49 54 45 5f 53 59 4e 43 5f 46 55 4c 4c 20 66 6c  ITE_SYNC_FULL fl
6080: 61 67 73 0a 2a 2a 20 77 69 74 68 20 74 68 65 20  ags.** with the 
6090: 5b 50 52 41 47 4d 41 20 73 79 6e 63 68 72 6f 6e  [PRAGMA synchron
60a0: 6f 75 73 5d 3d 4e 4f 52 4d 41 4c 20 61 6e 64 20  ous]=NORMAL and 
60b0: 5b 50 52 41 47 4d 41 20 73 79 6e 63 68 72 6f 6e  [PRAGMA synchron
60c0: 6f 75 73 5d 3d 46 55 4c 4c 0a 2a 2a 20 73 65 74  ous]=FULL.** set
60d0: 74 69 6e 67 73 2e 20 20 54 68 65 20 5b 73 79 6e  tings.  The [syn
60e0: 63 68 72 6f 6e 6f 75 73 20 70 72 61 67 6d 61 5d  chronous pragma]
60f0: 20 64 65 74 65 72 6d 69 6e 65 73 20 77 68 65 6e   determines when
6100: 20 63 61 6c 6c 73 20 74 6f 20 74 68 65 0a 2a 2a   calls to the.**
6110: 20 78 53 79 6e 63 20 56 46 53 20 6d 65 74 68 6f   xSync VFS metho
6120: 64 20 6f 63 63 75 72 20 61 6e 64 20 61 70 70 6c  d occur and appl
6130: 69 65 73 20 75 6e 69 66 6f 72 6d 6c 79 20 61 63  ies uniformly ac
6140: 72 6f 73 73 20 61 6c 6c 20 70 6c 61 74 66 6f 72  ross all platfor
6150: 6d 73 2e 0a 2a 2a 20 54 68 65 20 53 51 4c 49 54  ms..** The SQLIT
6160: 45 5f 53 59 4e 43 5f 4e 4f 52 4d 41 4c 20 61 6e  E_SYNC_NORMAL an
6170: 64 20 53 51 4c 49 54 45 5f 53 59 4e 43 5f 46 55  d SQLITE_SYNC_FU
6180: 4c 4c 20 66 6c 61 67 73 20 64 65 74 65 72 6d 69  LL flags determi
6190: 6e 65 20 68 6f 77 0a 2a 2a 20 65 6e 65 72 67 65  ne how.** energe
61a0: 74 69 63 20 6f 72 20 72 69 67 6f 72 6f 75 73 20  tic or rigorous 
61b0: 6f 72 20 66 6f 72 63 65 66 75 6c 20 74 68 65 20  or forceful the 
61c0: 73 79 6e 63 20 6f 70 65 72 61 74 69 6f 6e 73 20  sync operations 
61d0: 61 72 65 20 61 6e 64 0a 2a 2a 20 6f 6e 6c 79 20  are and.** only 
61e0: 6d 61 6b 65 20 61 20 64 69 66 66 65 72 65 6e 63  make a differenc
61f0: 65 20 6f 6e 20 4d 61 63 20 4f 53 58 20 66 6f 72  e on Mac OSX for
6200: 20 74 68 65 20 64 65 66 61 75 6c 74 20 53 51 4c   the default SQL
6210: 69 74 65 20 63 6f 64 65 2e 0a 2a 2a 20 28 54 68  ite code..** (Th
6220: 69 72 64 2d 70 61 72 74 79 20 56 46 53 20 69 6d  ird-party VFS im
6230: 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20 6d 69  plementations mi
6240: 67 68 74 20 61 6c 73 6f 20 6d 61 6b 65 20 74 68  ght also make th
6250: 65 20 64 69 73 74 69 6e 63 74 69 6f 6e 0a 2a 2a  e distinction.**
6260: 20 62 65 74 77 65 65 6e 20 53 51 4c 49 54 45 5f   between SQLITE_
6270: 53 59 4e 43 5f 4e 4f 52 4d 41 4c 20 61 6e 64 20  SYNC_NORMAL and 
6280: 53 51 4c 49 54 45 5f 53 59 4e 43 5f 46 55 4c 4c  SQLITE_SYNC_FULL
6290: 2c 20 62 75 74 20 61 6d 6f 6e 67 20 74 68 65 0a  , but among the.
62a0: 2a 2a 20 6f 70 65 72 61 74 69 6e 67 20 73 79 73  ** operating sys
62b0: 74 65 6d 73 20 6e 61 74 69 76 65 6c 79 20 73 75  tems natively su
62c0: 70 70 6f 72 74 65 64 20 62 79 20 53 51 4c 69 74  pported by SQLit
62d0: 65 2c 20 6f 6e 6c 79 20 4d 61 63 20 4f 53 58 0a  e, only Mac OSX.
62e0: 2a 2a 20 63 61 72 65 73 20 61 62 6f 75 74 20 74  ** cares about t
62f0: 68 65 20 64 69 66 66 65 72 65 6e 63 65 2e 29 0a  he difference.).
6300: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
6310: 45 5f 53 59 4e 43 5f 4e 4f 52 4d 41 4c 20 20 20  E_SYNC_NORMAL   
6320: 20 20 20 20 20 30 78 30 30 30 30 32 0a 23 64 65       0x00002.#de
6330: 66 69 6e 65 20 53 51 4c 49 54 45 5f 53 59 4e 43  fine SQLITE_SYNC
6340: 5f 46 55 4c 4c 20 20 20 20 20 20 20 20 20 20 30  _FULL          0
6350: 78 30 30 30 30 33 0a 23 64 65 66 69 6e 65 20 53  x00003.#define S
6360: 51 4c 49 54 45 5f 53 59 4e 43 5f 44 41 54 41 4f  QLITE_SYNC_DATAO
6370: 4e 4c 59 20 20 20 20 20 20 30 78 30 30 30 31 30  NLY      0x00010
6380: 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
6390: 3a 20 4f 53 20 49 6e 74 65 72 66 61 63 65 20 4f  : OS Interface O
63a0: 70 65 6e 20 46 69 6c 65 20 48 61 6e 64 6c 65 0a  pen File Handle.
63b0: 2a 2a 0a 2a 2a 20 41 6e 20 5b 73 71 6c 69 74 65  **.** An [sqlite
63c0: 33 5f 66 69 6c 65 5d 20 6f 62 6a 65 63 74 20 72  3_file] object r
63d0: 65 70 72 65 73 65 6e 74 73 20 61 6e 20 6f 70 65  epresents an ope
63e0: 6e 20 66 69 6c 65 20 69 6e 20 74 68 65 20 0a 2a  n file in the .*
63f0: 2a 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 20 7c  * [sqlite3_vfs |
6400: 20 4f 53 20 69 6e 74 65 72 66 61 63 65 20 6c 61   OS interface la
6410: 79 65 72 5d 2e 20 20 49 6e 64 69 76 69 64 75 61  yer].  Individua
6420: 6c 20 4f 53 20 69 6e 74 65 72 66 61 63 65 0a 2a  l OS interface.*
6430: 2a 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  * implementation
6440: 73 20 77 69 6c 6c 0a 2a 2a 20 77 61 6e 74 20 74  s will.** want t
6450: 6f 20 73 75 62 63 6c 61 73 73 20 74 68 69 73 20  o subclass this 
6460: 6f 62 6a 65 63 74 20 62 79 20 61 70 70 65 6e 64  object by append
6470: 69 6e 67 20 61 64 64 69 74 69 6f 6e 61 6c 20 66  ing additional f
6480: 69 65 6c 64 73 0a 2a 2a 20 66 6f 72 20 74 68 65  ields.** for the
6490: 69 72 20 6f 77 6e 20 75 73 65 2e 20 20 54 68 65  ir own use.  The
64a0: 20 70 4d 65 74 68 6f 64 73 20 65 6e 74 72 79 20   pMethods entry 
64b0: 69 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20  is a pointer to 
64c0: 61 6e 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 69  an.** [sqlite3_i
64d0: 6f 5f 6d 65 74 68 6f 64 73 5d 20 6f 62 6a 65 63  o_methods] objec
64e0: 74 20 74 68 61 74 20 64 65 66 69 6e 65 73 20 6d  t that defines m
64f0: 65 74 68 6f 64 73 20 66 6f 72 20 70 65 72 66 6f  ethods for perfo
6500: 72 6d 69 6e 67 0a 2a 2a 20 49 2f 4f 20 6f 70 65  rming.** I/O ope
6510: 72 61 74 69 6f 6e 73 20 6f 6e 20 74 68 65 20 6f  rations on the o
6520: 70 65 6e 20 66 69 6c 65 2e 0a 2a 2f 0a 74 79 70  pen file..*/.typ
6530: 65 64 65 66 20 73 74 72 75 63 74 20 73 71 6c 69  edef struct sqli
6540: 74 65 33 5f 66 69 6c 65 20 73 71 6c 69 74 65 33  te3_file sqlite3
6550: 5f 66 69 6c 65 3b 0a 73 74 72 75 63 74 20 73 71  _file;.struct sq
6560: 6c 69 74 65 33 5f 66 69 6c 65 20 7b 0a 20 20 63  lite3_file {.  c
6570: 6f 6e 73 74 20 73 74 72 75 63 74 20 73 71 6c 69  onst struct sqli
6580: 74 65 33 5f 69 6f 5f 6d 65 74 68 6f 64 73 20 2a  te3_io_methods *
6590: 70 4d 65 74 68 6f 64 73 3b 20 20 2f 2a 20 4d 65  pMethods;  /* Me
65a0: 74 68 6f 64 73 20 66 6f 72 20 61 6e 20 6f 70 65  thods for an ope
65b0: 6e 20 66 69 6c 65 20 2a 2f 0a 7d 3b 0a 0a 2f 2a  n file */.};../*
65c0: 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4f 53  .** CAPI3REF: OS
65d0: 20 49 6e 74 65 72 66 61 63 65 20 46 69 6c 65 20   Interface File 
65e0: 56 69 72 74 75 61 6c 20 4d 65 74 68 6f 64 73 20  Virtual Methods 
65f0: 4f 62 6a 65 63 74 0a 2a 2a 0a 2a 2a 20 45 76 65  Object.**.** Eve
6600: 72 79 20 66 69 6c 65 20 6f 70 65 6e 65 64 20 62  ry file opened b
6610: 79 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 76  y the [sqlite3_v
6620: 66 73 5d 20 78 4f 70 65 6e 20 6d 65 74 68 6f 64  fs] xOpen method
6630: 20 70 6f 70 75 6c 61 74 65 73 20 61 6e 0a 2a 2a   populates an.**
6640: 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d 20   [sqlite3_file] 
6650: 6f 62 6a 65 63 74 20 28 6f 72 2c 20 6d 6f 72 65  object (or, more
6660: 20 63 6f 6d 6d 6f 6e 6c 79 2c 20 61 20 73 75 62   commonly, a sub
6670: 63 6c 61 73 73 20 6f 66 20 74 68 65 0a 2a 2a 20  class of the.** 
6680: 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d 20 6f  [sqlite3_file] o
6690: 62 6a 65 63 74 29 20 77 69 74 68 20 61 20 70 6f  bject) with a po
66a0: 69 6e 74 65 72 20 74 6f 20 61 6e 20 69 6e 73 74  inter to an inst
66b0: 61 6e 63 65 20 6f 66 20 74 68 69 73 20 6f 62 6a  ance of this obj
66c0: 65 63 74 2e 0a 2a 2a 20 54 68 69 73 20 6f 62 6a  ect..** This obj
66d0: 65 63 74 20 64 65 66 69 6e 65 73 20 74 68 65 20  ect defines the 
66e0: 6d 65 74 68 6f 64 73 20 75 73 65 64 20 74 6f 20  methods used to 
66f0: 70 65 72 66 6f 72 6d 20 76 61 72 69 6f 75 73 20  perform various 
6700: 6f 70 65 72 61 74 69 6f 6e 73 0a 2a 2a 20 61 67  operations.** ag
6710: 61 69 6e 73 74 20 74 68 65 20 6f 70 65 6e 20 66  ainst the open f
6720: 69 6c 65 20 72 65 70 72 65 73 65 6e 74 65 64 20  ile represented 
6730: 62 79 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  by the [sqlite3_
6740: 66 69 6c 65 5d 20 6f 62 6a 65 63 74 2e 0a 2a 2a  file] object..**
6750: 0a 2a 2a 20 49 66 20 74 68 65 20 78 4f 70 65 6e  .** If the xOpen
6760: 20 6d 65 74 68 6f 64 20 73 65 74 73 20 74 68 65   method sets the
6770: 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 2e 70 4d   sqlite3_file.pM
6780: 65 74 68 6f 64 73 20 65 6c 65 6d 65 6e 74 20 0a  ethods element .
6790: 2a 2a 20 74 6f 20 61 20 6e 6f 6e 2d 4e 55 4c 4c  ** to a non-NULL
67a0: 20 70 6f 69 6e 74 65 72 2c 20 74 68 65 6e 20 74   pointer, then t
67b0: 68 65 20 73 71 6c 69 74 65 33 5f 69 6f 5f 6d 65  he sqlite3_io_me
67c0: 74 68 6f 64 73 2e 78 43 6c 6f 73 65 20 6d 65 74  thods.xClose met
67d0: 68 6f 64 0a 2a 2a 20 6d 61 79 20 62 65 20 69 6e  hod.** may be in
67e0: 76 6f 6b 65 64 20 65 76 65 6e 20 69 66 20 74 68  voked even if th
67f0: 65 20 78 4f 70 65 6e 20 72 65 70 6f 72 74 65 64  e xOpen reported
6800: 20 74 68 61 74 20 69 74 20 66 61 69 6c 65 64 2e   that it failed.
6810: 20 20 54 68 65 0a 2a 2a 20 6f 6e 6c 79 20 77 61    The.** only wa
6820: 79 20 74 6f 20 70 72 65 76 65 6e 74 20 61 20 63  y to prevent a c
6830: 61 6c 6c 20 74 6f 20 78 43 6c 6f 73 65 20 66 6f  all to xClose fo
6840: 6c 6c 6f 77 69 6e 67 20 61 20 66 61 69 6c 65 64  llowing a failed
6850: 20 78 4f 70 65 6e 0a 2a 2a 20 69 73 20 66 6f 72   xOpen.** is for
6860: 20 74 68 65 20 78 4f 70 65 6e 20 74 6f 20 73 65   the xOpen to se
6870: 74 20 74 68 65 20 73 71 6c 69 74 65 33 5f 66 69  t the sqlite3_fi
6880: 6c 65 2e 70 4d 65 74 68 6f 64 73 20 65 6c 65 6d  le.pMethods elem
6890: 65 6e 74 20 74 6f 20 4e 55 4c 4c 2e 0a 2a 2a 0a  ent to NULL..**.
68a0: 2a 2a 20 54 68 65 20 66 6c 61 67 73 20 61 72 67  ** The flags arg
68b0: 75 6d 65 6e 74 20 74 6f 20 78 53 79 6e 63 20 6d  ument to xSync m
68c0: 61 79 20 62 65 20 6f 6e 65 20 6f 66 20 5b 53 51  ay be one of [SQ
68d0: 4c 49 54 45 5f 53 59 4e 43 5f 4e 4f 52 4d 41 4c  LITE_SYNC_NORMAL
68e0: 5d 20 6f 72 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f  ] or.** [SQLITE_
68f0: 53 59 4e 43 5f 46 55 4c 4c 5d 2e 20 20 54 68 65  SYNC_FULL].  The
6900: 20 66 69 72 73 74 20 63 68 6f 69 63 65 20 69 73   first choice is
6910: 20 74 68 65 20 6e 6f 72 6d 61 6c 20 66 73 79 6e   the normal fsyn
6920: 63 28 29 2e 0a 2a 2a 20 54 68 65 20 73 65 63 6f  c()..** The seco
6930: 6e 64 20 63 68 6f 69 63 65 20 69 73 20 61 20 4d  nd choice is a M
6940: 61 63 20 4f 53 20 58 20 73 74 79 6c 65 20 66 75  ac OS X style fu
6950: 6c 6c 73 79 6e 63 2e 20 20 54 68 65 20 5b 53 51  llsync.  The [SQ
6960: 4c 49 54 45 5f 53 59 4e 43 5f 44 41 54 41 4f 4e  LITE_SYNC_DATAON
6970: 4c 59 5d 0a 2a 2a 20 66 6c 61 67 20 6d 61 79 20  LY].** flag may 
6980: 62 65 20 4f 52 65 64 20 69 6e 20 74 6f 20 69 6e  be ORed in to in
6990: 64 69 63 61 74 65 20 74 68 61 74 20 6f 6e 6c 79  dicate that only
69a0: 20 74 68 65 20 64 61 74 61 20 6f 66 20 74 68 65   the data of the
69b0: 20 66 69 6c 65 0a 2a 2a 20 61 6e 64 20 6e 6f 74   file.** and not
69c0: 20 69 74 73 20 69 6e 6f 64 65 20 6e 65 65 64 73   its inode needs
69d0: 20 74 6f 20 62 65 20 73 79 6e 63 65 64 2e 0a 2a   to be synced..*
69e0: 2a 0a 2a 2a 20 54 68 65 20 69 6e 74 65 67 65 72  *.** The integer
69f0: 20 76 61 6c 75 65 73 20 74 6f 20 78 4c 6f 63 6b   values to xLock
6a00: 28 29 20 61 6e 64 20 78 55 6e 6c 6f 63 6b 28 29  () and xUnlock()
6a10: 20 61 72 65 20 6f 6e 65 20 6f 66 0a 2a 2a 20 3c   are one of.** <
6a20: 75 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c  ul>.** <li> [SQL
6a30: 49 54 45 5f 4c 4f 43 4b 5f 4e 4f 4e 45 5d 2c 0a  ITE_LOCK_NONE],.
6a40: 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f  ** <li> [SQLITE_
6a50: 4c 4f 43 4b 5f 53 48 41 52 45 44 5d 2c 0a 2a 2a  LOCK_SHARED],.**
6a60: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4c 4f   <li> [SQLITE_LO
6a70: 43 4b 5f 52 45 53 45 52 56 45 44 5d 2c 0a 2a 2a  CK_RESERVED],.**
6a80: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 4c 4f   <li> [SQLITE_LO
6a90: 43 4b 5f 50 45 4e 44 49 4e 47 5d 2c 20 6f 72 0a  CK_PENDING], or.
6aa0: 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f  ** <li> [SQLITE_
6ab0: 4c 4f 43 4b 5f 45 58 43 4c 55 53 49 56 45 5d 2e  LOCK_EXCLUSIVE].
6ac0: 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 20 78 4c 6f  .** </ul>.** xLo
6ad0: 63 6b 28 29 20 69 6e 63 72 65 61 73 65 73 20 74  ck() increases t
6ae0: 68 65 20 6c 6f 63 6b 2e 20 78 55 6e 6c 6f 63 6b  he lock. xUnlock
6af0: 28 29 20 64 65 63 72 65 61 73 65 73 20 74 68 65  () decreases the
6b00: 20 6c 6f 63 6b 2e 0a 2a 2a 20 54 68 65 20 78 43   lock..** The xC
6b10: 68 65 63 6b 52 65 73 65 72 76 65 64 4c 6f 63 6b  heckReservedLock
6b20: 28 29 20 6d 65 74 68 6f 64 20 63 68 65 63 6b 73  () method checks
6b30: 20 77 68 65 74 68 65 72 20 61 6e 79 20 64 61 74   whether any dat
6b40: 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
6b50: 2c 0a 2a 2a 20 65 69 74 68 65 72 20 69 6e 20 74  ,.** either in t
6b60: 68 69 73 20 70 72 6f 63 65 73 73 20 6f 72 20 69  his process or i
6b70: 6e 20 73 6f 6d 65 20 6f 74 68 65 72 20 70 72 6f  n some other pro
6b80: 63 65 73 73 2c 20 69 73 20 68 6f 6c 64 69 6e 67  cess, is holding
6b90: 20 61 20 52 45 53 45 52 56 45 44 2c 0a 2a 2a 20   a RESERVED,.** 
6ba0: 50 45 4e 44 49 4e 47 2c 20 6f 72 20 45 58 43 4c  PENDING, or EXCL
6bb0: 55 53 49 56 45 20 6c 6f 63 6b 20 6f 6e 20 74 68  USIVE lock on th
6bc0: 65 20 66 69 6c 65 2e 20 20 49 74 20 72 65 74 75  e file.  It retu
6bd0: 72 6e 73 20 74 72 75 65 0a 2a 2a 20 69 66 20 73  rns true.** if s
6be0: 75 63 68 20 61 20 6c 6f 63 6b 20 65 78 69 73 74  uch a lock exist
6bf0: 73 20 61 6e 64 20 66 61 6c 73 65 20 6f 74 68 65  s and false othe
6c00: 72 77 69 73 65 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  rwise..**.** The
6c10: 20 78 46 69 6c 65 43 6f 6e 74 72 6f 6c 28 29 20   xFileControl() 
6c20: 6d 65 74 68 6f 64 20 69 73 20 61 20 67 65 6e 65  method is a gene
6c30: 72 69 63 20 69 6e 74 65 72 66 61 63 65 20 74 68  ric interface th
6c40: 61 74 20 61 6c 6c 6f 77 73 20 63 75 73 74 6f 6d  at allows custom
6c50: 0a 2a 2a 20 56 46 53 20 69 6d 70 6c 65 6d 65 6e  .** VFS implemen
6c60: 74 61 74 69 6f 6e 73 20 74 6f 20 64 69 72 65 63  tations to direc
6c70: 74 6c 79 20 63 6f 6e 74 72 6f 6c 20 61 6e 20 6f  tly control an o
6c80: 70 65 6e 20 66 69 6c 65 20 75 73 69 6e 67 20 74  pen file using t
6c90: 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 66  he.** [sqlite3_f
6ca0: 69 6c 65 5f 63 6f 6e 74 72 6f 6c 28 29 5d 20 69  ile_control()] i
6cb0: 6e 74 65 72 66 61 63 65 2e 20 20 54 68 65 20 73  nterface.  The s
6cc0: 65 63 6f 6e 64 20 22 6f 70 22 20 61 72 67 75 6d  econd "op" argum
6cd0: 65 6e 74 20 69 73 20 61 6e 0a 2a 2a 20 69 6e 74  ent is an.** int
6ce0: 65 67 65 72 20 6f 70 63 6f 64 65 2e 20 20 54 68  eger opcode.  Th
6cf0: 65 20 74 68 69 72 64 20 61 72 67 75 6d 65 6e 74  e third argument
6d00: 20 69 73 20 61 20 67 65 6e 65 72 69 63 20 70 6f   is a generic po
6d10: 69 6e 74 65 72 20 69 6e 74 65 6e 64 65 64 20 74  inter intended t
6d20: 6f 0a 2a 2a 20 70 6f 69 6e 74 20 74 6f 20 61 20  o.** point to a 
6d30: 73 74 72 75 63 74 75 72 65 20 74 68 61 74 20 6d  structure that m
6d40: 61 79 20 63 6f 6e 74 61 69 6e 20 61 72 67 75 6d  ay contain argum
6d50: 65 6e 74 73 20 6f 72 20 73 70 61 63 65 20 69 6e  ents or space in
6d60: 20 77 68 69 63 68 20 74 6f 0a 2a 2a 20 77 72 69   which to.** wri
6d70: 74 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 73  te return values
6d80: 2e 20 20 50 6f 74 65 6e 74 69 61 6c 20 75 73 65  .  Potential use
6d90: 73 20 66 6f 72 20 78 46 69 6c 65 43 6f 6e 74 72  s for xFileContr
6da0: 6f 6c 28 29 20 6d 69 67 68 74 20 62 65 0a 2a 2a  ol() might be.**
6db0: 20 66 75 6e 63 74 69 6f 6e 73 20 74 6f 20 65 6e   functions to en
6dc0: 61 62 6c 65 20 62 6c 6f 63 6b 69 6e 67 20 6c 6f  able blocking lo
6dd0: 63 6b 73 20 77 69 74 68 20 74 69 6d 65 6f 75 74  cks with timeout
6de0: 73 2c 20 74 6f 20 63 68 61 6e 67 65 20 74 68 65  s, to change the
6df0: 0a 2a 2a 20 6c 6f 63 6b 69 6e 67 20 73 74 72 61  .** locking stra
6e00: 74 65 67 79 20 28 66 6f 72 20 65 78 61 6d 70 6c  tegy (for exampl
6e10: 65 20 74 6f 20 75 73 65 20 64 6f 74 2d 66 69 6c  e to use dot-fil
6e20: 65 20 6c 6f 63 6b 73 29 2c 20 74 6f 20 69 6e 71  e locks), to inq
6e30: 75 69 72 65 0a 2a 2a 20 61 62 6f 75 74 20 74 68  uire.** about th
6e40: 65 20 73 74 61 74 75 73 20 6f 66 20 61 20 6c 6f  e status of a lo
6e50: 63 6b 2c 20 6f 72 20 74 6f 20 62 72 65 61 6b 20  ck, or to break 
6e60: 73 74 61 6c 65 20 6c 6f 63 6b 73 2e 20 20 54 68  stale locks.  Th
6e70: 65 20 53 51 4c 69 74 65 0a 2a 2a 20 63 6f 72 65  e SQLite.** core
6e80: 20 72 65 73 65 72 76 65 73 20 61 6c 6c 20 6f 70   reserves all op
6e90: 63 6f 64 65 73 20 6c 65 73 73 20 74 68 61 6e 20  codes less than 
6ea0: 31 30 30 20 66 6f 72 20 69 74 73 20 6f 77 6e 20  100 for its own 
6eb0: 75 73 65 2e 0a 2a 2a 20 41 20 5b 53 51 4c 49 54  use..** A [SQLIT
6ec0: 45 5f 46 43 4e 54 4c 5f 4c 4f 43 4b 53 54 41 54  E_FCNTL_LOCKSTAT
6ed0: 45 20 7c 20 6c 69 73 74 20 6f 66 20 6f 70 63 6f  E | list of opco
6ee0: 64 65 73 5d 20 6c 65 73 73 20 74 68 61 6e 20 31  des] less than 1
6ef0: 30 30 20 69 73 20 61 76 61 69 6c 61 62 6c 65 2e  00 is available.
6f00: 0a 2a 2a 20 41 70 70 6c 69 63 61 74 69 6f 6e 73  .** Applications
6f10: 20 74 68 61 74 20 64 65 66 69 6e 65 20 61 20 63   that define a c
6f20: 75 73 74 6f 6d 20 78 46 69 6c 65 43 6f 6e 74 72  ustom xFileContr
6f30: 6f 6c 20 6d 65 74 68 6f 64 20 73 68 6f 75 6c 64  ol method should
6f40: 20 75 73 65 20 6f 70 63 6f 64 65 73 0a 2a 2a 20   use opcodes.** 
6f50: 67 72 65 61 74 65 72 20 74 68 61 6e 20 31 30 30  greater than 100
6f60: 20 74 6f 20 61 76 6f 69 64 20 63 6f 6e 66 6c 69   to avoid confli
6f70: 63 74 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 78  cts..**.** The x
6f80: 53 65 63 74 6f 72 53 69 7a 65 28 29 20 6d 65 74  SectorSize() met
6f90: 68 6f 64 20 72 65 74 75 72 6e 73 20 74 68 65 20  hod returns the 
6fa0: 73 65 63 74 6f 72 20 73 69 7a 65 20 6f 66 20 74  sector size of t
6fb0: 68 65 0a 2a 2a 20 64 65 76 69 63 65 20 74 68 61  he.** device tha
6fc0: 74 20 75 6e 64 65 72 6c 69 65 73 20 74 68 65 20  t underlies the 
6fd0: 66 69 6c 65 2e 20 20 54 68 65 20 73 65 63 74 6f  file.  The secto
6fe0: 72 20 73 69 7a 65 20 69 73 20 74 68 65 0a 2a 2a  r size is the.**
6ff0: 20 6d 69 6e 69 6d 75 6d 20 77 72 69 74 65 20 74   minimum write t
7000: 68 61 74 20 63 61 6e 20 62 65 20 70 65 72 66 6f  hat can be perfo
7010: 72 6d 65 64 20 77 69 74 68 6f 75 74 20 64 69 73  rmed without dis
7020: 74 75 72 62 69 6e 67 0a 2a 2a 20 6f 74 68 65 72  turbing.** other
7030: 20 62 79 74 65 73 20 69 6e 20 74 68 65 20 66 69   bytes in the fi
7040: 6c 65 2e 20 20 54 68 65 20 78 44 65 76 69 63 65  le.  The xDevice
7050: 43 68 61 72 61 63 74 65 72 69 73 74 69 63 73 28  Characteristics(
7060: 29 0a 2a 2a 20 6d 65 74 68 6f 64 20 72 65 74 75  ).** method retu
7070: 72 6e 73 20 61 20 62 69 74 20 76 65 63 74 6f 72  rns a bit vector
7080: 20 64 65 73 63 72 69 62 69 6e 67 20 62 65 68 61   describing beha
7090: 76 69 6f 72 73 20 6f 66 20 74 68 65 0a 2a 2a 20  viors of the.** 
70a0: 75 6e 64 65 72 6c 79 69 6e 67 20 64 65 76 69 63  underlying devic
70b0: 65 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a  e:.**.** <ul>.**
70c0: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f   <li> [SQLITE_IO
70d0: 43 41 50 5f 41 54 4f 4d 49 43 5d 0a 2a 2a 20 3c  CAP_ATOMIC].** <
70e0: 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f 43 41  li> [SQLITE_IOCA
70f0: 50 5f 41 54 4f 4d 49 43 35 31 32 5d 0a 2a 2a 20  P_ATOMIC512].** 
7100: 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f 43  <li> [SQLITE_IOC
7110: 41 50 5f 41 54 4f 4d 49 43 31 4b 5d 0a 2a 2a 20  AP_ATOMIC1K].** 
7120: 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f 43  <li> [SQLITE_IOC
7130: 41 50 5f 41 54 4f 4d 49 43 32 4b 5d 0a 2a 2a 20  AP_ATOMIC2K].** 
7140: 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f 43  <li> [SQLITE_IOC
7150: 41 50 5f 41 54 4f 4d 49 43 34 4b 5d 0a 2a 2a 20  AP_ATOMIC4K].** 
7160: 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f 43  <li> [SQLITE_IOC
7170: 41 50 5f 41 54 4f 4d 49 43 38 4b 5d 0a 2a 2a 20  AP_ATOMIC8K].** 
7180: 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f 43  <li> [SQLITE_IOC
7190: 41 50 5f 41 54 4f 4d 49 43 31 36 4b 5d 0a 2a 2a  AP_ATOMIC16K].**
71a0: 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49 4f   <li> [SQLITE_IO
71b0: 43 41 50 5f 41 54 4f 4d 49 43 33 32 4b 5d 0a 2a  CAP_ATOMIC32K].*
71c0: 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 49  * <li> [SQLITE_I
71d0: 4f 43 41 50 5f 41 54 4f 4d 49 43 36 34 4b 5d 0a  OCAP_ATOMIC64K].
71e0: 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f  ** <li> [SQLITE_
71f0: 49 4f 43 41 50 5f 53 41 46 45 5f 41 50 50 45 4e  IOCAP_SAFE_APPEN
7200: 44 5d 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49  D].** <li> [SQLI
7210: 54 45 5f 49 4f 43 41 50 5f 53 45 51 55 45 4e 54  TE_IOCAP_SEQUENT
7220: 49 41 4c 5d 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a  IAL].** </ul>.**
7230: 0a 2a 2a 20 54 68 65 20 53 51 4c 49 54 45 5f 49  .** The SQLITE_I
7240: 4f 43 41 50 5f 41 54 4f 4d 49 43 20 70 72 6f 70  OCAP_ATOMIC prop
7250: 65 72 74 79 20 6d 65 61 6e 73 20 74 68 61 74 20  erty means that 
7260: 61 6c 6c 20 77 72 69 74 65 73 20 6f 66 0a 2a 2a  all writes of.**
7270: 20 61 6e 79 20 73 69 7a 65 20 61 72 65 20 61 74   any size are at
7280: 6f 6d 69 63 2e 20 20 54 68 65 20 53 51 4c 49 54  omic.  The SQLIT
7290: 45 5f 49 4f 43 41 50 5f 41 54 4f 4d 49 43 6e 6e  E_IOCAP_ATOMICnn
72a0: 6e 20 76 61 6c 75 65 73 0a 2a 2a 20 6d 65 61 6e  n values.** mean
72b0: 20 74 68 61 74 20 77 72 69 74 65 73 20 6f 66 20   that writes of 
72c0: 62 6c 6f 63 6b 73 20 74 68 61 74 20 61 72 65 20  blocks that are 
72d0: 6e 6e 6e 20 62 79 74 65 73 20 69 6e 20 73 69 7a  nnn bytes in siz
72e0: 65 20 61 6e 64 0a 2a 2a 20 61 72 65 20 61 6c 69  e and.** are ali
72f0: 67 6e 65 64 20 74 6f 20 61 6e 20 61 64 64 72 65  gned to an addre
7300: 73 73 20 77 68 69 63 68 20 69 73 20 61 6e 20 69  ss which is an i
7310: 6e 74 65 67 65 72 20 6d 75 6c 74 69 70 6c 65 20  nteger multiple 
7320: 6f 66 0a 2a 2a 20 6e 6e 6e 20 61 72 65 20 61 74  of.** nnn are at
7330: 6f 6d 69 63 2e 20 20 54 68 65 20 53 51 4c 49 54  omic.  The SQLIT
7340: 45 5f 49 4f 43 41 50 5f 53 41 46 45 5f 41 50 50  E_IOCAP_SAFE_APP
7350: 45 4e 44 20 76 61 6c 75 65 20 6d 65 61 6e 73 0a  END value means.
7360: 2a 2a 20 74 68 61 74 20 77 68 65 6e 20 64 61 74  ** that when dat
7370: 61 20 69 73 20 61 70 70 65 6e 64 65 64 20 74 6f  a is appended to
7380: 20 61 20 66 69 6c 65 2c 20 74 68 65 20 64 61 74   a file, the dat
7390: 61 20 69 73 20 61 70 70 65 6e 64 65 64 0a 2a 2a  a is appended.**
73a0: 20 66 69 72 73 74 20 74 68 65 6e 20 74 68 65 20   first then the 
73b0: 73 69 7a 65 20 6f 66 20 74 68 65 20 66 69 6c 65  size of the file
73c0: 20 69 73 20 65 78 74 65 6e 64 65 64 2c 20 6e 65   is extended, ne
73d0: 76 65 72 20 74 68 65 20 6f 74 68 65 72 0a 2a 2a  ver the other.**
73e0: 20 77 61 79 20 61 72 6f 75 6e 64 2e 20 20 54 68   way around.  Th
73f0: 65 20 53 51 4c 49 54 45 5f 49 4f 43 41 50 5f 53  e SQLITE_IOCAP_S
7400: 45 51 55 45 4e 54 49 41 4c 20 70 72 6f 70 65 72  EQUENTIAL proper
7410: 74 79 20 6d 65 61 6e 73 20 74 68 61 74 0a 2a 2a  ty means that.**
7420: 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 69 73 20   information is 
7430: 77 72 69 74 74 65 6e 20 74 6f 20 64 69 73 6b 20  written to disk 
7440: 69 6e 20 74 68 65 20 73 61 6d 65 20 6f 72 64 65  in the same orde
7450: 72 20 61 73 20 63 61 6c 6c 73 0a 2a 2a 20 74 6f  r as calls.** to
7460: 20 78 57 72 69 74 65 28 29 2e 0a 2a 2a 0a 2a 2a   xWrite()..**.**
7470: 20 49 66 20 78 52 65 61 64 28 29 20 72 65 74 75   If xRead() retu
7480: 72 6e 73 20 53 51 4c 49 54 45 5f 49 4f 45 52 52  rns SQLITE_IOERR
7490: 5f 53 48 4f 52 54 5f 52 45 41 44 20 69 74 20 6d  _SHORT_READ it m
74a0: 75 73 74 20 61 6c 73 6f 20 66 69 6c 6c 0a 2a 2a  ust also fill.**
74b0: 20 69 6e 20 74 68 65 20 75 6e 72 65 61 64 20 70   in the unread p
74c0: 6f 72 74 69 6f 6e 73 20 6f 66 20 74 68 65 20 62  ortions of the b
74d0: 75 66 66 65 72 20 77 69 74 68 20 7a 65 72 6f 73  uffer with zeros
74e0: 2e 20 20 41 20 56 46 53 20 74 68 61 74 0a 2a 2a  .  A VFS that.**
74f0: 20 66 61 69 6c 73 20 74 6f 20 7a 65 72 6f 2d 66   fails to zero-f
7500: 69 6c 6c 20 73 68 6f 72 74 20 72 65 61 64 73 20  ill short reads 
7510: 6d 69 67 68 74 20 73 65 65 6d 20 74 6f 20 77 6f  might seem to wo
7520: 72 6b 2e 20 20 48 6f 77 65 76 65 72 2c 0a 2a 2a  rk.  However,.**
7530: 20 66 61 69 6c 75 72 65 20 74 6f 20 7a 65 72 6f   failure to zero
7540: 2d 66 69 6c 6c 20 73 68 6f 72 74 20 72 65 61 64  -fill short read
7550: 73 20 77 69 6c 6c 20 65 76 65 6e 74 75 61 6c 6c  s will eventuall
7560: 79 20 6c 65 61 64 20 74 6f 0a 2a 2a 20 64 61 74  y lead to.** dat
7570: 61 62 61 73 65 20 63 6f 72 72 75 70 74 69 6f 6e  abase corruption
7580: 2e 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73 74 72  ..*/.typedef str
7590: 75 63 74 20 73 71 6c 69 74 65 33 5f 69 6f 5f 6d  uct sqlite3_io_m
75a0: 65 74 68 6f 64 73 20 73 71 6c 69 74 65 33 5f 69  ethods sqlite3_i
75b0: 6f 5f 6d 65 74 68 6f 64 73 3b 0a 73 74 72 75 63  o_methods;.struc
75c0: 74 20 73 71 6c 69 74 65 33 5f 69 6f 5f 6d 65 74  t sqlite3_io_met
75d0: 68 6f 64 73 20 7b 0a 20 20 69 6e 74 20 69 56 65  hods {.  int iVe
75e0: 72 73 69 6f 6e 3b 0a 20 20 69 6e 74 20 28 2a 78  rsion;.  int (*x
75f0: 43 6c 6f 73 65 29 28 73 71 6c 69 74 65 33 5f 66  Close)(sqlite3_f
7600: 69 6c 65 2a 29 3b 0a 20 20 69 6e 74 20 28 2a 78  ile*);.  int (*x
7610: 52 65 61 64 29 28 73 71 6c 69 74 65 33 5f 66 69  Read)(sqlite3_fi
7620: 6c 65 2a 2c 20 76 6f 69 64 2a 2c 20 69 6e 74 20  le*, void*, int 
7630: 69 41 6d 74 2c 20 73 71 6c 69 74 65 33 5f 69 6e  iAmt, sqlite3_in
7640: 74 36 34 20 69 4f 66 73 74 29 3b 0a 20 20 69 6e  t64 iOfst);.  in
7650: 74 20 28 2a 78 57 72 69 74 65 29 28 73 71 6c 69  t (*xWrite)(sqli
7660: 74 65 33 5f 66 69 6c 65 2a 2c 20 63 6f 6e 73 74  te3_file*, const
7670: 20 76 6f 69 64 2a 2c 20 69 6e 74 20 69 41 6d 74   void*, int iAmt
7680: 2c 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 20  , sqlite3_int64 
7690: 69 4f 66 73 74 29 3b 0a 20 20 69 6e 74 20 28 2a  iOfst);.  int (*
76a0: 78 54 72 75 6e 63 61 74 65 29 28 73 71 6c 69 74  xTruncate)(sqlit
76b0: 65 33 5f 66 69 6c 65 2a 2c 20 73 71 6c 69 74 65  e3_file*, sqlite
76c0: 33 5f 69 6e 74 36 34 20 73 69 7a 65 29 3b 0a 20  3_int64 size);. 
76d0: 20 69 6e 74 20 28 2a 78 53 79 6e 63 29 28 73 71   int (*xSync)(sq
76e0: 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 69 6e 74  lite3_file*, int
76f0: 20 66 6c 61 67 73 29 3b 0a 20 20 69 6e 74 20 28   flags);.  int (
7700: 2a 78 46 69 6c 65 53 69 7a 65 29 28 73 71 6c 69  *xFileSize)(sqli
7710: 74 65 33 5f 66 69 6c 65 2a 2c 20 73 71 6c 69 74  te3_file*, sqlit
7720: 65 33 5f 69 6e 74 36 34 20 2a 70 53 69 7a 65 29  e3_int64 *pSize)
7730: 3b 0a 20 20 69 6e 74 20 28 2a 78 4c 6f 63 6b 29  ;.  int (*xLock)
7740: 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20  (sqlite3_file*, 
7750: 69 6e 74 29 3b 0a 20 20 69 6e 74 20 28 2a 78 55  int);.  int (*xU
7760: 6e 6c 6f 63 6b 29 28 73 71 6c 69 74 65 33 5f 66  nlock)(sqlite3_f
7770: 69 6c 65 2a 2c 20 69 6e 74 29 3b 0a 20 20 69 6e  ile*, int);.  in
7780: 74 20 28 2a 78 43 68 65 63 6b 52 65 73 65 72 76  t (*xCheckReserv
7790: 65 64 4c 6f 63 6b 29 28 73 71 6c 69 74 65 33 5f  edLock)(sqlite3_
77a0: 66 69 6c 65 2a 2c 20 69 6e 74 20 2a 70 52 65 73  file*, int *pRes
77b0: 4f 75 74 29 3b 0a 20 20 69 6e 74 20 28 2a 78 46  Out);.  int (*xF
77c0: 69 6c 65 43 6f 6e 74 72 6f 6c 29 28 73 71 6c 69  ileControl)(sqli
77d0: 74 65 33 5f 66 69 6c 65 2a 2c 20 69 6e 74 20 6f  te3_file*, int o
77e0: 70 2c 20 76 6f 69 64 20 2a 70 41 72 67 29 3b 0a  p, void *pArg);.
77f0: 20 20 69 6e 74 20 28 2a 78 53 65 63 74 6f 72 53    int (*xSectorS
7800: 69 7a 65 29 28 73 71 6c 69 74 65 33 5f 66 69 6c  ize)(sqlite3_fil
7810: 65 2a 29 3b 0a 20 20 69 6e 74 20 28 2a 78 44 65  e*);.  int (*xDe
7820: 76 69 63 65 43 68 61 72 61 63 74 65 72 69 73 74  viceCharacterist
7830: 69 63 73 29 28 73 71 6c 69 74 65 33 5f 66 69 6c  ics)(sqlite3_fil
7840: 65 2a 29 3b 0a 20 20 2f 2a 20 4d 65 74 68 6f 64  e*);.  /* Method
7850: 73 20 61 62 6f 76 65 20 61 72 65 20 76 61 6c 69  s above are vali
7860: 64 20 66 6f 72 20 76 65 72 73 69 6f 6e 20 31 20  d for version 1 
7870: 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 53 68 6d 4d  */.  int (*xShmM
7880: 61 70 29 28 73 71 6c 69 74 65 33 5f 66 69 6c 65  ap)(sqlite3_file
7890: 2a 2c 20 69 6e 74 20 69 50 67 2c 20 69 6e 74 20  *, int iPg, int 
78a0: 70 67 73 7a 2c 20 69 6e 74 2c 20 76 6f 69 64 20  pgsz, int, void 
78b0: 76 6f 6c 61 74 69 6c 65 2a 2a 29 3b 0a 20 20 69  volatile**);.  i
78c0: 6e 74 20 28 2a 78 53 68 6d 4c 6f 63 6b 29 28 73  nt (*xShmLock)(s
78d0: 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c 20 69 6e  qlite3_file*, in
78e0: 74 20 6f 66 66 73 65 74 2c 20 69 6e 74 20 6e 2c  t offset, int n,
78f0: 20 69 6e 74 20 66 6c 61 67 73 29 3b 0a 20 20 76   int flags);.  v
7900: 6f 69 64 20 28 2a 78 53 68 6d 42 61 72 72 69 65  oid (*xShmBarrie
7910: 72 29 28 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a  r)(sqlite3_file*
7920: 29 3b 0a 20 20 69 6e 74 20 28 2a 78 53 68 6d 55  );.  int (*xShmU
7930: 6e 6d 61 70 29 28 73 71 6c 69 74 65 33 5f 66 69  nmap)(sqlite3_fi
7940: 6c 65 2a 2c 20 69 6e 74 20 64 65 6c 65 74 65 46  le*, int deleteF
7950: 6c 61 67 29 3b 0a 20 20 2f 2a 20 4d 65 74 68 6f  lag);.  /* Metho
7960: 64 73 20 61 62 6f 76 65 20 61 72 65 20 76 61 6c  ds above are val
7970: 69 64 20 66 6f 72 20 76 65 72 73 69 6f 6e 20 32  id for version 2
7980: 20 2a 2f 0a 20 20 2f 2a 20 41 64 64 69 74 69 6f   */.  /* Additio
7990: 6e 61 6c 20 6d 65 74 68 6f 64 73 20 6d 61 79 20  nal methods may 
79a0: 62 65 20 61 64 64 65 64 20 69 6e 20 66 75 74 75  be added in futu
79b0: 72 65 20 72 65 6c 65 61 73 65 73 20 2a 2f 0a 7d  re releases */.}
79c0: 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
79d0: 46 3a 20 53 74 61 6e 64 61 72 64 20 46 69 6c 65  F: Standard File
79e0: 20 43 6f 6e 74 72 6f 6c 20 4f 70 63 6f 64 65 73   Control Opcodes
79f0: 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 69 6e 74  .**.** These int
7a00: 65 67 65 72 20 63 6f 6e 73 74 61 6e 74 73 20 61  eger constants a
7a10: 72 65 20 6f 70 63 6f 64 65 73 20 66 6f 72 20 74  re opcodes for t
7a20: 68 65 20 78 46 69 6c 65 43 6f 6e 74 72 6f 6c 20  he xFileControl 
7a30: 6d 65 74 68 6f 64 0a 2a 2a 20 6f 66 20 74 68 65  method.** of the
7a40: 20 5b 73 71 6c 69 74 65 33 5f 69 6f 5f 6d 65 74   [sqlite3_io_met
7a50: 68 6f 64 73 5d 20 6f 62 6a 65 63 74 20 61 6e 64  hods] object and
7a60: 20 66 6f 72 20 74 68 65 20 5b 73 71 6c 69 74 65   for the [sqlite
7a70: 33 5f 66 69 6c 65 5f 63 6f 6e 74 72 6f 6c 28 29  3_file_control()
7a80: 5d 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 2e 0a  ].** interface..
7a90: 2a 2a 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54  **.** The [SQLIT
7aa0: 45 5f 46 43 4e 54 4c 5f 4c 4f 43 4b 53 54 41 54  E_FCNTL_LOCKSTAT
7ab0: 45 5d 20 6f 70 63 6f 64 65 20 69 73 20 75 73 65  E] opcode is use
7ac0: 64 20 66 6f 72 20 64 65 62 75 67 67 69 6e 67 2e  d for debugging.
7ad0: 20 20 54 68 69 73 0a 2a 2a 20 6f 70 63 6f 64 65    This.** opcode
7ae0: 20 63 61 75 73 65 73 20 74 68 65 20 78 46 69 6c   causes the xFil
7af0: 65 43 6f 6e 74 72 6f 6c 20 6d 65 74 68 6f 64 20  eControl method 
7b00: 74 6f 20 77 72 69 74 65 20 74 68 65 20 63 75 72  to write the cur
7b10: 72 65 6e 74 20 73 74 61 74 65 20 6f 66 0a 2a 2a  rent state of.**
7b20: 20 74 68 65 20 6c 6f 63 6b 20 28 6f 6e 65 20 6f   the lock (one o
7b30: 66 20 5b 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 4e  f [SQLITE_LOCK_N
7b40: 4f 4e 45 5d 2c 20 5b 53 51 4c 49 54 45 5f 4c 4f  ONE], [SQLITE_LO
7b50: 43 4b 5f 53 48 41 52 45 44 5d 2c 0a 2a 2a 20 5b  CK_SHARED],.** [
7b60: 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 52 45 53 45  SQLITE_LOCK_RESE
7b70: 52 56 45 44 5d 2c 20 5b 53 51 4c 49 54 45 5f 4c  RVED], [SQLITE_L
7b80: 4f 43 4b 5f 50 45 4e 44 49 4e 47 5d 2c 20 6f 72  OCK_PENDING], or
7b90: 20 5b 53 51 4c 49 54 45 5f 4c 4f 43 4b 5f 45 58   [SQLITE_LOCK_EX
7ba0: 43 4c 55 53 49 56 45 5d 29 0a 2a 2a 20 69 6e 74  CLUSIVE]).** int
7bb0: 6f 20 61 6e 20 69 6e 74 65 67 65 72 20 74 68 61  o an integer tha
7bc0: 74 20 74 68 65 20 70 41 72 67 20 61 72 67 75 6d  t the pArg argum
7bd0: 65 6e 74 20 70 6f 69 6e 74 73 20 74 6f 2e 20 54  ent points to. T
7be0: 68 69 73 20 63 61 70 61 62 69 6c 69 74 79 0a 2a  his capability.*
7bf0: 2a 20 69 73 20 75 73 65 64 20 64 75 72 69 6e 67  * is used during
7c00: 20 74 65 73 74 69 6e 67 20 61 6e 64 20 6f 6e 6c   testing and onl
7c10: 79 20 6e 65 65 64 73 20 74 6f 20 62 65 20 73 75  y needs to be su
7c20: 70 70 6f 72 74 65 64 20 77 68 65 6e 20 53 51 4c  pported when SQL
7c30: 49 54 45 5f 54 45 53 54 0a 2a 2a 20 69 73 20 64  ITE_TEST.** is d
7c40: 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68  efined..**.** Th
7c50: 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c 5f  e [SQLITE_FCNTL_
7c60: 53 49 5a 45 5f 48 49 4e 54 5d 20 6f 70 63 6f 64  SIZE_HINT] opcod
7c70: 65 20 69 73 20 75 73 65 64 20 62 79 20 53 51 4c  e is used by SQL
7c80: 69 74 65 20 74 6f 20 67 69 76 65 20 74 68 65 20  ite to give the 
7c90: 56 46 53 0a 2a 2a 20 6c 61 79 65 72 20 61 20 68  VFS.** layer a h
7ca0: 69 6e 74 20 6f 66 20 68 6f 77 20 6c 61 72 67 65  int of how large
7cb0: 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69   the database fi
7cc0: 6c 65 20 77 69 6c 6c 20 67 72 6f 77 20 74 6f 20  le will grow to 
7cd0: 62 65 20 64 75 72 69 6e 67 20 74 68 65 0a 2a 2a  be during the.**
7ce0: 20 63 75 72 72 65 6e 74 20 74 72 61 6e 73 61 63   current transac
7cf0: 74 69 6f 6e 2e 20 20 54 68 69 73 20 68 69 6e 74  tion.  This hint
7d00: 20 69 73 20 6e 6f 74 20 67 75 61 72 61 6e 74 65   is not guarante
7d10: 65 64 20 74 6f 20 62 65 20 61 63 63 75 72 61 74  ed to be accurat
7d20: 65 20 62 75 74 20 69 74 0a 2a 2a 20 69 73 20 6f  e but it.** is o
7d30: 66 74 65 6e 20 63 6c 6f 73 65 2e 20 20 54 68 65  ften close.  The
7d40: 20 75 6e 64 65 72 6c 79 69 6e 67 20 56 46 53 20   underlying VFS 
7d50: 6d 69 67 68 74 20 63 68 6f 6f 73 65 20 74 6f 20  might choose to 
7d60: 70 72 65 61 6c 6c 6f 63 61 74 65 20 64 61 74 61  preallocate data
7d70: 62 61 73 65 0a 2a 2a 20 66 69 6c 65 20 73 70 61  base.** file spa
7d80: 63 65 20 62 61 73 65 64 20 6f 6e 20 74 68 69 73  ce based on this
7d90: 20 68 69 6e 74 20 69 6e 20 6f 72 64 65 72 20 74   hint in order t
7da0: 6f 20 68 65 6c 70 20 77 72 69 74 65 73 20 74 6f  o help writes to
7db0: 20 74 68 65 20 64 61 74 61 62 61 73 65 0a 2a 2a   the database.**
7dc0: 20 66 69 6c 65 20 72 75 6e 20 66 61 73 74 65 72   file run faster
7dd0: 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 5b 53 51 4c  ..**.** The [SQL
7de0: 49 54 45 5f 46 43 4e 54 4c 5f 43 48 55 4e 4b 5f  ITE_FCNTL_CHUNK_
7df0: 53 49 5a 45 5d 20 6f 70 63 6f 64 65 20 69 73 20  SIZE] opcode is 
7e00: 75 73 65 64 20 74 6f 20 72 65 71 75 65 73 74 20  used to request 
7e10: 74 68 61 74 20 74 68 65 20 56 46 53 0a 2a 2a 20  that the VFS.** 
7e20: 65 78 74 65 6e 64 73 20 61 6e 64 20 74 72 75 6e  extends and trun
7e30: 63 61 74 65 73 20 74 68 65 20 64 61 74 61 62 61  cates the databa
7e40: 73 65 20 66 69 6c 65 20 69 6e 20 63 68 75 6e 6b  se file in chunk
7e50: 73 20 6f 66 20 61 20 73 69 7a 65 20 73 70 65 63  s of a size spec
7e60: 69 66 69 65 64 0a 2a 2a 20 62 79 20 74 68 65 20  ified.** by the 
7e70: 75 73 65 72 2e 20 54 68 65 20 66 6f 75 72 74 68  user. The fourth
7e80: 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 5b 73 71   argument to [sq
7e90: 6c 69 74 65 33 5f 66 69 6c 65 5f 63 6f 6e 74 72  lite3_file_contr
7ea0: 6f 6c 28 29 5d 20 73 68 6f 75 6c 64 20 0a 2a 2a  ol()] should .**
7eb0: 20 70 6f 69 6e 74 20 74 6f 20 61 6e 20 69 6e 74   point to an int
7ec0: 65 67 65 72 20 28 74 79 70 65 20 69 6e 74 29 20  eger (type int) 
7ed0: 63 6f 6e 74 61 69 6e 69 6e 67 20 74 68 65 20 6e  containing the n
7ee0: 65 77 20 63 68 75 6e 6b 2d 73 69 7a 65 20 74 6f  ew chunk-size to
7ef0: 20 75 73 65 0a 2a 2a 20 66 6f 72 20 74 68 65 20   use.** for the 
7f00: 6e 6f 6d 69 6e 61 74 65 64 20 64 61 74 61 62 61  nominated databa
7f10: 73 65 2e 20 41 6c 6c 6f 63 61 74 69 6e 67 20 64  se. Allocating d
7f20: 61 74 61 62 61 73 65 20 66 69 6c 65 20 73 70 61  atabase file spa
7f30: 63 65 20 69 6e 20 6c 61 72 67 65 0a 2a 2a 20 63  ce in large.** c
7f40: 68 75 6e 6b 73 20 28 73 61 79 20 31 4d 42 20 61  hunks (say 1MB a
7f50: 74 20 61 20 74 69 6d 65 29 2c 20 6d 61 79 20 72  t a time), may r
7f60: 65 64 75 63 65 20 66 69 6c 65 2d 73 79 73 74 65  educe file-syste
7f70: 6d 20 66 72 61 67 6d 65 6e 74 61 74 69 6f 6e 20  m fragmentation 
7f80: 61 6e 64 0a 2a 2a 20 69 6d 70 72 6f 76 65 20 70  and.** improve p
7f90: 65 72 66 6f 72 6d 61 6e 63 65 20 6f 6e 20 73 6f  erformance on so
7fa0: 6d 65 20 73 79 73 74 65 6d 73 2e 0a 2a 2a 0a 2a  me systems..**.*
7fb0: 2a 20 54 68 65 20 5b 53 51 4c 49 54 45 5f 46 43  * The [SQLITE_FC
7fc0: 4e 54 4c 5f 46 49 4c 45 5f 50 4f 49 4e 54 45 52  NTL_FILE_POINTER
7fd0: 5d 20 6f 70 63 6f 64 65 20 69 73 20 75 73 65 64  ] opcode is used
7fe0: 20 74 6f 20 6f 62 74 61 69 6e 20 61 20 70 6f 69   to obtain a poi
7ff0: 6e 74 65 72 0a 2a 2a 20 74 6f 20 74 68 65 20 5b  nter.** to the [
8000: 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d 20 6f 62  sqlite3_file] ob
8010: 6a 65 63 74 20 61 73 73 6f 63 69 61 74 65 64 20  ject associated 
8020: 77 69 74 68 20 61 20 70 61 72 74 69 63 75 6c 61  with a particula
8030: 72 20 64 61 74 61 62 61 73 65 0a 2a 2a 20 63 6f  r database.** co
8040: 6e 6e 65 63 74 69 6f 6e 2e 20 20 53 65 65 20 74  nnection.  See t
8050: 68 65 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65  he [sqlite3_file
8060: 5f 63 6f 6e 74 72 6f 6c 28 29 5d 20 64 6f 63 75  _control()] docu
8070: 6d 65 6e 74 61 74 69 6f 6e 20 66 6f 72 0a 2a 2a  mentation for.**
8080: 20 61 64 64 69 74 69 6f 6e 61 6c 20 69 6e 66 6f   additional info
8090: 72 6d 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 54  rmation..**.** T
80a0: 68 65 20 5b 53 51 4c 49 54 45 5f 46 43 4e 54 4c  he [SQLITE_FCNTL
80b0: 5f 53 59 4e 43 5d 20 6f 70 63 6f 64 65 20 69 73  _SYNC] opcode is
80c0: 20 75 73 65 64 20 69 6e 74 65 72 6e 61 6c 6c 79   used internally
80d0: 2e 20 53 51 4c 69 74 65 20 63 61 6c 6c 73 0a 2a  . SQLite calls.*
80e0: 2a 20 74 68 65 20 66 69 6c 65 2d 63 6f 6e 74 72  * the file-contr
80f0: 6f 6c 20 6d 65 74 68 6f 64 20 77 69 74 68 20 74  ol method with t
8100: 68 69 73 20 6f 70 63 6f 64 65 20 69 6d 6d 65 64  his opcode immed
8110: 69 61 74 65 6c 79 20 61 66 74 65 72 20 74 68 65  iately after the
8120: 20 64 61 74 61 62 61 73 65 0a 2a 2a 20 66 69 6c   database.** fil
8130: 65 20 69 73 20 73 79 6e 63 65 64 2c 20 6f 72 20  e is synced, or 
8140: 69 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20  if the database 
8150: 69 73 20 72 75 6e 6e 69 6e 67 20 69 6e 20 73 79  is running in sy
8160: 6e 63 68 72 6f 6e 6f 75 73 3d 6f 66 66 20 6d 6f  nchronous=off mo
8170: 64 65 0a 2a 2a 20 69 6d 6d 65 64 69 61 74 65 6c  de.** immediatel
8180: 79 20 61 66 74 65 72 20 69 74 20 77 6f 75 6c 64  y after it would
8190: 20 68 61 76 65 20 62 65 65 6e 20 73 79 6e 63 65   have been synce
81a0: 64 20 6f 74 68 65 72 77 69 73 65 2e 20 54 68 69  d otherwise. Thi
81b0: 73 20 6d 61 6b 65 73 20 69 74 0a 2a 2a 20 65 61  s makes it.** ea
81c0: 73 69 65 72 20 74 6f 20 77 72 69 74 65 20 73 70  sier to write sp
81d0: 65 63 69 61 6c 20 56 46 53 20 6d 6f 64 75 6c 65  ecial VFS module
81e0: 73 20 74 68 61 74 20 64 65 70 65 6e 64 20 6f 6e  s that depend on
81f0: 20 74 68 65 20 78 53 79 6e 63 20 63 61 6c 6c 2e   the xSync call.
8200: 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  .*/.#define SQLI
8210: 54 45 5f 46 43 4e 54 4c 5f 4c 4f 43 4b 53 54 41  TE_FCNTL_LOCKSTA
8220: 54 45 20 20 20 20 20 20 20 20 31 0a 23 64 65 66  TE        1.#def
8230: 69 6e 65 20 53 51 4c 49 54 45 5f 47 45 54 5f 4c  ine SQLITE_GET_L
8240: 4f 43 4b 50 52 4f 58 59 46 49 4c 45 20 20 20 20  OCKPROXYFILE    
8250: 20 20 32 0a 23 64 65 66 69 6e 65 20 53 51 4c 49    2.#define SQLI
8260: 54 45 5f 53 45 54 5f 4c 4f 43 4b 50 52 4f 58 59  TE_SET_LOCKPROXY
8270: 46 49 4c 45 20 20 20 20 20 20 33 0a 23 64 65 66  FILE      3.#def
8280: 69 6e 65 20 53 51 4c 49 54 45 5f 4c 41 53 54 5f  ine SQLITE_LAST_
8290: 45 52 52 4e 4f 20 20 20 20 20 20 20 20 20 20 20  ERRNO           
82a0: 20 20 34 0a 23 64 65 66 69 6e 65 20 53 51 4c 49    4.#define SQLI
82b0: 54 45 5f 46 43 4e 54 4c 5f 53 49 5a 45 5f 48 49  TE_FCNTL_SIZE_HI
82c0: 4e 54 20 20 20 20 20 20 20 20 35 0a 23 64 65 66  NT        5.#def
82d0: 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c  ine SQLITE_FCNTL
82e0: 5f 43 48 55 4e 4b 5f 53 49 5a 45 20 20 20 20 20  _CHUNK_SIZE     
82f0: 20 20 36 0a 23 64 65 66 69 6e 65 20 53 51 4c 49    6.#define SQLI
8300: 54 45 5f 46 43 4e 54 4c 5f 46 49 4c 45 5f 50 4f  TE_FCNTL_FILE_PO
8310: 49 4e 54 45 52 20 20 20 20 20 37 0a 23 64 65 66  INTER     7.#def
8320: 69 6e 65 20 53 51 4c 49 54 45 5f 46 43 4e 54 4c  ine SQLITE_FCNTL
8330: 5f 53 59 4e 43 20 20 20 20 20 20 20 20 20 20 20  _SYNC           
8340: 20 20 38 0a 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49    8.../*.** CAPI
8350: 33 52 45 46 3a 20 4d 75 74 65 78 20 48 61 6e 64  3REF: Mutex Hand
8360: 6c 65 0a 2a 2a 0a 2a 2a 20 54 68 65 20 6d 75 74  le.**.** The mut
8370: 65 78 20 6d 6f 64 75 6c 65 20 77 69 74 68 69 6e  ex module within
8380: 20 53 51 4c 69 74 65 20 64 65 66 69 6e 65 73 20   SQLite defines 
8390: 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65 78 5d 20  [sqlite3_mutex] 
83a0: 74 6f 20 62 65 20 61 6e 0a 2a 2a 20 61 62 73 74  to be an.** abst
83b0: 72 61 63 74 20 74 79 70 65 20 66 6f 72 20 61 20  ract type for a 
83c0: 6d 75 74 65 78 20 6f 62 6a 65 63 74 2e 20 20 54  mutex object.  T
83d0: 68 65 20 53 51 4c 69 74 65 20 63 6f 72 65 20 6e  he SQLite core n
83e0: 65 76 65 72 20 6c 6f 6f 6b 73 0a 2a 2a 20 61 74  ever looks.** at
83f0: 20 74 68 65 20 69 6e 74 65 72 6e 61 6c 20 72 65   the internal re
8400: 70 72 65 73 65 6e 74 61 74 69 6f 6e 20 6f 66 20  presentation of 
8410: 61 6e 20 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65  an [sqlite3_mute
8420: 78 5d 2e 20 20 49 74 20 6f 6e 6c 79 0a 2a 2a 20  x].  It only.** 
8430: 64 65 61 6c 73 20 77 69 74 68 20 70 6f 69 6e 74  deals with point
8440: 65 72 73 20 74 6f 20 74 68 65 20 5b 73 71 6c 69  ers to the [sqli
8450: 74 65 33 5f 6d 75 74 65 78 5d 20 6f 62 6a 65 63  te3_mutex] objec
8460: 74 2e 0a 2a 2a 0a 2a 2a 20 4d 75 74 65 78 65 73  t..**.** Mutexes
8470: 20 61 72 65 20 63 72 65 61 74 65 64 20 75 73 69   are created usi
8480: 6e 67 20 5b 73 71 6c 69 74 65 33 5f 6d 75 74 65  ng [sqlite3_mute
8490: 78 5f 61 6c 6c 6f 63 28 29 5d 2e 0a 2a 2f 0a 74  x_alloc()]..*/.t
84a0: 79 70 65 64 65 66 20 73 74 72 75 63 74 20 73 71  ypedef struct sq
84b0: 6c 69 74 65 33 5f 6d 75 74 65 78 20 73 71 6c 69  lite3_mutex sqli
84c0: 74 65 33 5f 6d 75 74 65 78 3b 0a 0a 2f 2a 0a 2a  te3_mutex;../*.*
84d0: 2a 20 43 41 50 49 33 52 45 46 3a 20 4f 53 20 49  * CAPI3REF: OS I
84e0: 6e 74 65 72 66 61 63 65 20 4f 62 6a 65 63 74 0a  nterface Object.
84f0: 2a 2a 0a 2a 2a 20 41 6e 20 69 6e 73 74 61 6e 63  **.** An instanc
8500: 65 20 6f 66 20 74 68 65 20 73 71 6c 69 74 65 33  e of the sqlite3
8510: 5f 76 66 73 20 6f 62 6a 65 63 74 20 64 65 66 69  _vfs object defi
8520: 6e 65 73 20 74 68 65 20 69 6e 74 65 72 66 61 63  nes the interfac
8530: 65 20 62 65 74 77 65 65 6e 0a 2a 2a 20 74 68 65  e between.** the
8540: 20 53 51 4c 69 74 65 20 63 6f 72 65 20 61 6e 64   SQLite core and
8550: 20 74 68 65 20 75 6e 64 65 72 6c 79 69 6e 67 20   the underlying 
8560: 6f 70 65 72 61 74 69 6e 67 20 73 79 73 74 65 6d  operating system
8570: 2e 20 20 54 68 65 20 22 76 66 73 22 0a 2a 2a 20  .  The "vfs".** 
8580: 69 6e 20 74 68 65 20 6e 61 6d 65 20 6f 66 20 74  in the name of t
8590: 68 65 20 6f 62 6a 65 63 74 20 73 74 61 6e 64 73  he object stands
85a0: 20 66 6f 72 20 22 76 69 72 74 75 61 6c 20 66 69   for "virtual fi
85b0: 6c 65 20 73 79 73 74 65 6d 22 2e 0a 2a 2a 0a 2a  le system"..**.*
85c0: 2a 20 54 68 65 20 76 61 6c 75 65 20 6f 66 20 74  * The value of t
85d0: 68 65 20 69 56 65 72 73 69 6f 6e 20 66 69 65 6c  he iVersion fiel
85e0: 64 20 69 73 20 69 6e 69 74 69 61 6c 6c 79 20 31  d is initially 1
85f0: 20 62 75 74 20 6d 61 79 20 62 65 20 6c 61 72 67   but may be larg
8600: 65 72 20 69 6e 0a 2a 2a 20 66 75 74 75 72 65 20  er in.** future 
8610: 76 65 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69  versions of SQLi
8620: 74 65 2e 20 20 41 64 64 69 74 69 6f 6e 61 6c 20  te.  Additional 
8630: 66 69 65 6c 64 73 20 6d 61 79 20 62 65 20 61 70  fields may be ap
8640: 70 65 6e 64 65 64 20 74 6f 20 74 68 69 73 0a 2a  pended to this.*
8650: 2a 20 6f 62 6a 65 63 74 20 77 68 65 6e 20 74 68  * object when th
8660: 65 20 69 56 65 72 73 69 6f 6e 20 76 61 6c 75 65  e iVersion value
8670: 20 69 73 20 69 6e 63 72 65 61 73 65 64 2e 20 20   is increased.  
8680: 4e 6f 74 65 20 74 68 61 74 20 74 68 65 20 73 74  Note that the st
8690: 72 75 63 74 75 72 65 0a 2a 2a 20 6f 66 20 74 68  ructure.** of th
86a0: 65 20 73 71 6c 69 74 65 33 5f 76 66 73 20 6f 62  e sqlite3_vfs ob
86b0: 6a 65 63 74 20 63 68 61 6e 67 65 73 20 69 6e 20  ject changes in 
86c0: 74 68 65 20 74 72 61 6e 73 61 63 74 69 6f 6e 20  the transaction 
86d0: 62 65 74 77 65 65 6e 0a 2a 2a 20 53 51 4c 69 74  between.** SQLit
86e0: 65 20 76 65 72 73 69 6f 6e 20 33 2e 35 2e 39 20  e version 3.5.9 
86f0: 61 6e 64 20 33 2e 36 2e 30 20 61 6e 64 20 79 65  and 3.6.0 and ye
8700: 74 20 74 68 65 20 69 56 65 72 73 69 6f 6e 20 66  t the iVersion f
8710: 69 65 6c 64 20 77 61 73 20 6e 6f 74 0a 2a 2a 20  ield was not.** 
8720: 6d 6f 64 69 66 69 65 64 2e 0a 2a 2a 0a 2a 2a 20  modified..**.** 
8730: 54 68 65 20 73 7a 4f 73 46 69 6c 65 20 66 69 65  The szOsFile fie
8740: 6c 64 20 69 73 20 74 68 65 20 73 69 7a 65 20 6f  ld is the size o
8750: 66 20 74 68 65 20 73 75 62 63 6c 61 73 73 65 64  f the subclassed
8760: 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d 0a   [sqlite3_file].
8770: 2a 2a 20 73 74 72 75 63 74 75 72 65 20 75 73 65  ** structure use
8780: 64 20 62 79 20 74 68 69 73 20 56 46 53 2e 20 20  d by this VFS.  
8790: 6d 78 50 61 74 68 6e 61 6d 65 20 69 73 20 74 68  mxPathname is th
87a0: 65 20 6d 61 78 69 6d 75 6d 20 6c 65 6e 67 74 68  e maximum length
87b0: 20 6f 66 0a 2a 2a 20 61 20 70 61 74 68 6e 61 6d   of.** a pathnam
87c0: 65 20 69 6e 20 74 68 69 73 20 56 46 53 2e 0a 2a  e in this VFS..*
87d0: 2a 0a 2a 2a 20 52 65 67 69 73 74 65 72 65 64 20  *.** Registered 
87e0: 73 71 6c 69 74 65 33 5f 76 66 73 20 6f 62 6a 65  sqlite3_vfs obje
87f0: 63 74 73 20 61 72 65 20 6b 65 70 74 20 6f 6e 20  cts are kept on 
8800: 61 20 6c 69 6e 6b 65 64 20 6c 69 73 74 20 66 6f  a linked list fo
8810: 72 6d 65 64 20 62 79 0a 2a 2a 20 74 68 65 20 70  rmed by.** the p
8820: 4e 65 78 74 20 70 6f 69 6e 74 65 72 2e 20 20 54  Next pointer.  T
8830: 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5f  he [sqlite3_vfs_
8840: 72 65 67 69 73 74 65 72 28 29 5d 0a 2a 2a 20 61  register()].** a
8850: 6e 64 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5f  nd [sqlite3_vfs_
8860: 75 6e 72 65 67 69 73 74 65 72 28 29 5d 20 69 6e  unregister()] in
8870: 74 65 72 66 61 63 65 73 20 6d 61 6e 61 67 65 20  terfaces manage 
8880: 74 68 69 73 20 6c 69 73 74 0a 2a 2a 20 69 6e 20  this list.** in 
8890: 61 20 74 68 72 65 61 64 2d 73 61 66 65 20 77 61  a thread-safe wa
88a0: 79 2e 20 20 54 68 65 20 5b 73 71 6c 69 74 65 33  y.  The [sqlite3
88b0: 5f 76 66 73 5f 66 69 6e 64 28 29 5d 20 69 6e 74  _vfs_find()] int
88c0: 65 72 66 61 63 65 0a 2a 2a 20 73 65 61 72 63 68  erface.** search
88d0: 65 73 20 74 68 65 20 6c 69 73 74 2e 20 20 4e 65  es the list.  Ne
88e0: 69 74 68 65 72 20 74 68 65 20 61 70 70 6c 69 63  ither the applic
88f0: 61 74 69 6f 6e 20 63 6f 64 65 20 6e 6f 72 20 74  ation code nor t
8900: 68 65 20 56 46 53 0a 2a 2a 20 69 6d 70 6c 65 6d  he VFS.** implem
8910: 65 6e 74 61 74 69 6f 6e 20 73 68 6f 75 6c 64 20  entation should 
8920: 75 73 65 20 74 68 65 20 70 4e 65 78 74 20 70 6f  use the pNext po
8930: 69 6e 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  inter..**.** The
8940: 20 70 4e 65 78 74 20 66 69 65 6c 64 20 69 73 20   pNext field is 
8950: 74 68 65 20 6f 6e 6c 79 20 66 69 65 6c 64 20 69  the only field i
8960: 6e 20 74 68 65 20 73 71 6c 69 74 65 33 5f 76 66  n the sqlite3_vf
8970: 73 0a 2a 2a 20 73 74 72 75 63 74 75 72 65 20 74  s.** structure t
8980: 68 61 74 20 53 51 4c 69 74 65 20 77 69 6c 6c 20  hat SQLite will 
8990: 65 76 65 72 20 6d 6f 64 69 66 79 2e 20 20 53 51  ever modify.  SQ
89a0: 4c 69 74 65 20 77 69 6c 6c 20 6f 6e 6c 79 20 61  Lite will only a
89b0: 63 63 65 73 73 0a 2a 2a 20 6f 72 20 6d 6f 64 69  ccess.** or modi
89c0: 66 79 20 74 68 69 73 20 66 69 65 6c 64 20 77 68  fy this field wh
89d0: 69 6c 65 20 68 6f 6c 64 69 6e 67 20 61 20 70 61  ile holding a pa
89e0: 72 74 69 63 75 6c 61 72 20 73 74 61 74 69 63 20  rticular static 
89f0: 6d 75 74 65 78 2e 0a 2a 2a 20 54 68 65 20 61 70  mutex..** The ap
8a00: 70 6c 69 63 61 74 69 6f 6e 20 73 68 6f 75 6c 64  plication should
8a10: 20 6e 65 76 65 72 20 6d 6f 64 69 66 79 20 61 6e   never modify an
8a20: 79 74 68 69 6e 67 20 77 69 74 68 69 6e 20 74 68  ything within th
8a30: 65 20 73 71 6c 69 74 65 33 5f 76 66 73 0a 2a 2a  e sqlite3_vfs.**
8a40: 20 6f 62 6a 65 63 74 20 6f 6e 63 65 20 74 68 65   object once the
8a50: 20 6f 62 6a 65 63 74 20 68 61 73 20 62 65 65 6e   object has been
8a60: 20 72 65 67 69 73 74 65 72 65 64 2e 0a 2a 2a 0a   registered..**.
8a70: 2a 2a 20 54 68 65 20 7a 4e 61 6d 65 20 66 69 65  ** The zName fie
8a80: 6c 64 20 68 6f 6c 64 73 20 74 68 65 20 6e 61 6d  ld holds the nam
8a90: 65 20 6f 66 20 74 68 65 20 56 46 53 20 6d 6f 64  e of the VFS mod
8aa0: 75 6c 65 2e 20 20 54 68 65 20 6e 61 6d 65 20 6d  ule.  The name m
8ab0: 75 73 74 0a 2a 2a 20 62 65 20 75 6e 69 71 75 65  ust.** be unique
8ac0: 20 61 63 72 6f 73 73 20 61 6c 6c 20 56 46 53 20   across all VFS 
8ad0: 6d 6f 64 75 6c 65 73 2e 0a 2a 2a 0a 2a 2a 20 5e  modules..**.** ^
8ae0: 53 51 4c 69 74 65 20 67 75 61 72 61 6e 74 65 65  SQLite guarantee
8af0: 73 20 74 68 61 74 20 74 68 65 20 7a 46 69 6c 65  s that the zFile
8b00: 6e 61 6d 65 20 70 61 72 61 6d 65 74 65 72 20 74  name parameter t
8b10: 6f 20 78 4f 70 65 6e 0a 2a 2a 20 69 73 20 65 69  o xOpen.** is ei
8b20: 74 68 65 72 20 61 20 4e 55 4c 4c 20 70 6f 69 6e  ther a NULL poin
8b30: 74 65 72 20 6f 72 20 73 74 72 69 6e 67 20 6f 62  ter or string ob
8b40: 74 61 69 6e 65 64 0a 2a 2a 20 66 72 6f 6d 20 78  tained.** from x
8b50: 46 75 6c 6c 50 61 74 68 6e 61 6d 65 28 29 20 77  FullPathname() w
8b60: 69 74 68 20 61 6e 20 6f 70 74 69 6f 6e 61 6c 20  ith an optional 
8b70: 73 75 66 66 69 78 20 61 64 64 65 64 2e 0a 2a 2a  suffix added..**
8b80: 20 5e 49 66 20 61 20 73 75 66 66 69 78 20 69 73   ^If a suffix is
8b90: 20 61 64 64 65 64 20 74 6f 20 74 68 65 20 7a 46   added to the zF
8ba0: 69 6c 65 6e 61 6d 65 20 70 61 72 61 6d 65 74 65  ilename paramete
8bb0: 72 2c 20 69 74 20 77 69 6c 6c 0a 2a 2a 20 63 6f  r, it will.** co
8bc0: 6e 73 69 73 74 20 6f 66 20 61 20 73 69 6e 67 6c  nsist of a singl
8bd0: 65 20 22 2d 22 20 63 68 61 72 61 63 74 65 72 20  e "-" character 
8be0: 66 6f 6c 6c 6f 77 65 64 20 62 79 20 6e 6f 20 6d  followed by no m
8bf0: 6f 72 65 20 74 68 61 6e 0a 2a 2a 20 31 30 20 61  ore than.** 10 a
8c00: 6c 70 68 61 6e 75 6d 65 72 69 63 20 61 6e 64 2f  lphanumeric and/
8c10: 6f 72 20 22 2d 22 20 63 68 61 72 61 63 74 65 72  or "-" character
8c20: 73 2e 0a 2a 2a 20 5e 53 51 4c 69 74 65 20 66 75  s..** ^SQLite fu
8c30: 72 74 68 65 72 20 67 75 61 72 61 6e 74 65 65 73  rther guarantees
8c40: 20 74 68 61 74 0a 2a 2a 20 74 68 65 20 73 74 72   that.** the str
8c50: 69 6e 67 20 77 69 6c 6c 20 62 65 20 76 61 6c 69  ing will be vali
8c60: 64 20 61 6e 64 20 75 6e 63 68 61 6e 67 65 64 20  d and unchanged 
8c70: 75 6e 74 69 6c 20 78 43 6c 6f 73 65 28 29 20 69  until xClose() i
8c80: 73 0a 2a 2a 20 63 61 6c 6c 65 64 2e 20 42 65 63  s.** called. Bec
8c90: 61 75 73 65 20 6f 66 20 74 68 65 20 70 72 65 76  ause of the prev
8ca0: 69 6f 75 73 20 73 65 6e 74 65 6e 63 65 2c 0a 2a  ious sentence,.*
8cb0: 2a 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 66  * the [sqlite3_f
8cc0: 69 6c 65 5d 20 63 61 6e 20 73 61 66 65 6c 79 20  ile] can safely 
8cd0: 73 74 6f 72 65 20 61 20 70 6f 69 6e 74 65 72 20  store a pointer 
8ce0: 74 6f 20 74 68 65 0a 2a 2a 20 66 69 6c 65 6e 61  to the.** filena
8cf0: 6d 65 20 69 66 20 69 74 20 6e 65 65 64 73 20 74  me if it needs t
8d00: 6f 20 72 65 6d 65 6d 62 65 72 20 74 68 65 20 66  o remember the f
8d10: 69 6c 65 6e 61 6d 65 20 66 6f 72 20 73 6f 6d 65  ilename for some
8d20: 20 72 65 61 73 6f 6e 2e 0a 2a 2a 20 49 66 20 74   reason..** If t
8d30: 68 65 20 7a 46 69 6c 65 6e 61 6d 65 20 70 61 72  he zFilename par
8d40: 61 6d 65 74 65 72 20 74 6f 20 78 4f 70 65 6e 20  ameter to xOpen 
8d50: 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  is a NULL pointe
8d60: 72 20 74 68 65 6e 20 78 4f 70 65 6e 0a 2a 2a 20  r then xOpen.** 
8d70: 6d 75 73 74 20 69 6e 76 65 6e 74 20 69 74 73 20  must invent its 
8d80: 6f 77 6e 20 74 65 6d 70 6f 72 61 72 79 20 6e 61  own temporary na
8d90: 6d 65 20 66 6f 72 20 74 68 65 20 66 69 6c 65 2e  me for the file.
8da0: 20 20 5e 57 68 65 6e 65 76 65 72 20 74 68 65 20    ^Whenever the 
8db0: 0a 2a 2a 20 78 46 69 6c 65 6e 61 6d 65 20 70 61  .** xFilename pa
8dc0: 72 61 6d 65 74 65 72 20 69 73 20 4e 55 4c 4c 20  rameter is NULL 
8dd0: 69 74 20 77 69 6c 6c 20 61 6c 73 6f 20 62 65 20  it will also be 
8de0: 74 68 65 20 63 61 73 65 20 74 68 61 74 20 74 68  the case that th
8df0: 65 0a 2a 2a 20 66 6c 61 67 73 20 70 61 72 61 6d  e.** flags param
8e00: 65 74 65 72 20 77 69 6c 6c 20 69 6e 63 6c 75 64  eter will includ
8e10: 65 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 44  e [SQLITE_OPEN_D
8e20: 45 4c 45 54 45 4f 4e 43 4c 4f 53 45 5d 2e 0a 2a  ELETEONCLOSE]..*
8e30: 2a 0a 2a 2a 20 54 68 65 20 66 6c 61 67 73 20 61  *.** The flags a
8e40: 72 67 75 6d 65 6e 74 20 74 6f 20 78 4f 70 65 6e  rgument to xOpen
8e50: 28 29 20 69 6e 63 6c 75 64 65 73 20 61 6c 6c 20  () includes all 
8e60: 62 69 74 73 20 73 65 74 20 69 6e 0a 2a 2a 20 74  bits set in.** t
8e70: 68 65 20 66 6c 61 67 73 20 61 72 67 75 6d 65 6e  he flags argumen
8e80: 74 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 6f 70  t to [sqlite3_op
8e90: 65 6e 5f 76 32 28 29 5d 2e 20 20 4f 72 20 69 66  en_v2()].  Or if
8ea0: 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29   [sqlite3_open()
8eb0: 5d 0a 2a 2a 20 6f 72 20 5b 73 71 6c 69 74 65 33  ].** or [sqlite3
8ec0: 5f 6f 70 65 6e 31 36 28 29 5d 20 69 73 20 75 73  _open16()] is us
8ed0: 65 64 2c 20 74 68 65 6e 20 66 6c 61 67 73 20 69  ed, then flags i
8ee0: 6e 63 6c 75 64 65 73 20 61 74 20 6c 65 61 73 74  ncludes at least
8ef0: 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  .** [SQLITE_OPEN
8f00: 5f 52 45 41 44 57 52 49 54 45 5d 20 7c 20 5b 53  _READWRITE] | [S
8f10: 51 4c 49 54 45 5f 4f 50 45 4e 5f 43 52 45 41 54  QLITE_OPEN_CREAT
8f20: 45 5d 2e 20 0a 2a 2a 20 49 66 20 78 4f 70 65 6e  E]. .** If xOpen
8f30: 28 29 20 6f 70 65 6e 73 20 61 20 66 69 6c 65 20  () opens a file 
8f40: 72 65 61 64 2d 6f 6e 6c 79 20 74 68 65 6e 20 69  read-only then i
8f50: 74 20 73 65 74 73 20 2a 70 4f 75 74 46 6c 61 67  t sets *pOutFlag
8f60: 73 20 74 6f 0a 2a 2a 20 69 6e 63 6c 75 64 65 20  s to.** include 
8f70: 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 52 45 41  [SQLITE_OPEN_REA
8f80: 44 4f 4e 4c 59 5d 2e 20 20 4f 74 68 65 72 20 62  DONLY].  Other b
8f90: 69 74 73 20 69 6e 20 2a 70 4f 75 74 46 6c 61 67  its in *pOutFlag
8fa0: 73 20 6d 61 79 20 62 65 20 73 65 74 2e 0a 2a 2a  s may be set..**
8fb0: 0a 2a 2a 20 5e 28 53 51 4c 69 74 65 20 77 69 6c  .** ^(SQLite wil
8fc0: 6c 20 61 6c 73 6f 20 61 64 64 20 6f 6e 65 20 6f  l also add one o
8fd0: 66 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20  f the following 
8fe0: 66 6c 61 67 73 20 74 6f 20 74 68 65 20 78 4f 70  flags to the xOp
8ff0: 65 6e 28 29 0a 2a 2a 20 63 61 6c 6c 2c 20 64 65  en().** call, de
9000: 70 65 6e 64 69 6e 67 20 6f 6e 20 74 68 65 20 6f  pending on the o
9010: 62 6a 65 63 74 20 62 65 69 6e 67 20 6f 70 65 6e  bject being open
9020: 65 64 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a  ed:.**.** <ul>.*
9030: 2a 20 3c 6c 69 3e 20 20 5b 53 51 4c 49 54 45 5f  * <li>  [SQLITE_
9040: 4f 50 45 4e 5f 4d 41 49 4e 5f 44 42 5d 0a 2a 2a  OPEN_MAIN_DB].**
9050: 20 3c 6c 69 3e 20 20 5b 53 51 4c 49 54 45 5f 4f   <li>  [SQLITE_O
9060: 50 45 4e 5f 4d 41 49 4e 5f 4a 4f 55 52 4e 41 4c  PEN_MAIN_JOURNAL
9070: 5d 0a 2a 2a 20 3c 6c 69 3e 20 20 5b 53 51 4c 49  ].** <li>  [SQLI
9080: 54 45 5f 4f 50 45 4e 5f 54 45 4d 50 5f 44 42 5d  TE_OPEN_TEMP_DB]
9090: 0a 2a 2a 20 3c 6c 69 3e 20 20 5b 53 51 4c 49 54  .** <li>  [SQLIT
90a0: 45 5f 4f 50 45 4e 5f 54 45 4d 50 5f 4a 4f 55 52  E_OPEN_TEMP_JOUR
90b0: 4e 41 4c 5d 0a 2a 2a 20 3c 6c 69 3e 20 20 5b 53  NAL].** <li>  [S
90c0: 51 4c 49 54 45 5f 4f 50 45 4e 5f 54 52 41 4e 53  QLITE_OPEN_TRANS
90d0: 49 45 4e 54 5f 44 42 5d 0a 2a 2a 20 3c 6c 69 3e  IENT_DB].** <li>
90e0: 20 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 53    [SQLITE_OPEN_S
90f0: 55 42 4a 4f 55 52 4e 41 4c 5d 0a 2a 2a 20 3c 6c  UBJOURNAL].** <l
9100: 69 3e 20 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  i>  [SQLITE_OPEN
9110: 5f 4d 41 53 54 45 52 5f 4a 4f 55 52 4e 41 4c 5d  _MASTER_JOURNAL]
9120: 0a 2a 2a 20 3c 6c 69 3e 20 20 5b 53 51 4c 49 54  .** <li>  [SQLIT
9130: 45 5f 4f 50 45 4e 5f 57 41 4c 5d 0a 2a 2a 20 3c  E_OPEN_WAL].** <
9140: 2f 75 6c 3e 29 5e 0a 2a 2a 0a 2a 2a 20 54 68 65  /ul>)^.**.** The
9150: 20 66 69 6c 65 20 49 2f 4f 20 69 6d 70 6c 65 6d   file I/O implem
9160: 65 6e 74 61 74 69 6f 6e 20 63 61 6e 20 75 73 65  entation can use
9170: 20 74 68 65 20 6f 62 6a 65 63 74 20 74 79 70 65   the object type
9180: 20 66 6c 61 67 73 20 74 6f 0a 2a 2a 20 63 68 61   flags to.** cha
9190: 6e 67 65 20 74 68 65 20 77 61 79 20 69 74 20 64  nge the way it d
91a0: 65 61 6c 73 20 77 69 74 68 20 66 69 6c 65 73 2e  eals with files.
91b0: 20 20 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20 61    For example, a
91c0: 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 0a 2a 2a  n application.**
91d0: 20 74 68 61 74 20 64 6f 65 73 20 6e 6f 74 20 63   that does not c
91e0: 61 72 65 20 61 62 6f 75 74 20 63 72 61 73 68 20  are about crash 
91f0: 72 65 63 6f 76 65 72 79 20 6f 72 20 72 6f 6c 6c  recovery or roll
9200: 62 61 63 6b 20 6d 69 67 68 74 20 6d 61 6b 65 0a  back might make.
9210: 2a 2a 20 74 68 65 20 6f 70 65 6e 20 6f 66 20 61  ** the open of a
9220: 20 6a 6f 75 72 6e 61 6c 20 66 69 6c 65 20 61 20   journal file a 
9230: 6e 6f 2d 6f 70 2e 20 20 57 72 69 74 65 73 20 74  no-op.  Writes t
9240: 6f 20 74 68 69 73 20 6a 6f 75 72 6e 61 6c 20 77  o this journal w
9250: 6f 75 6c 64 0a 2a 2a 20 61 6c 73 6f 20 62 65 20  ould.** also be 
9260: 6e 6f 2d 6f 70 73 2c 20 61 6e 64 20 61 6e 79 20  no-ops, and any 
9270: 61 74 74 65 6d 70 74 20 74 6f 20 72 65 61 64 20  attempt to read 
9280: 74 68 65 20 6a 6f 75 72 6e 61 6c 20 77 6f 75 6c  the journal woul
9290: 64 20 72 65 74 75 72 6e 0a 2a 2a 20 53 51 4c 49  d return.** SQLI
92a0: 54 45 5f 49 4f 45 52 52 2e 20 20 4f 72 20 74 68  TE_IOERR.  Or th
92b0: 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  e implementation
92c0: 20 6d 69 67 68 74 20 72 65 63 6f 67 6e 69 7a 65   might recognize
92d0: 20 74 68 61 74 20 61 20 64 61 74 61 62 61 73 65   that a database
92e0: 0a 2a 2a 20 66 69 6c 65 20 77 69 6c 6c 20 62 65  .** file will be
92f0: 20 64 6f 69 6e 67 20 70 61 67 65 2d 61 6c 69 67   doing page-alig
9300: 6e 65 64 20 73 65 63 74 6f 72 20 72 65 61 64 73  ned sector reads
9310: 20 61 6e 64 20 77 72 69 74 65 73 20 69 6e 20 61   and writes in a
9320: 20 72 61 6e 64 6f 6d 0a 2a 2a 20 6f 72 64 65 72   random.** order
9330: 20 61 6e 64 20 73 65 74 20 75 70 20 69 74 73 20   and set up its 
9340: 49 2f 4f 20 73 75 62 73 79 73 74 65 6d 20 61 63  I/O subsystem ac
9350: 63 6f 72 64 69 6e 67 6c 79 2e 0a 2a 2a 0a 2a 2a  cordingly..**.**
9360: 20 53 51 4c 69 74 65 20 6d 69 67 68 74 20 61 6c   SQLite might al
9370: 73 6f 20 61 64 64 20 6f 6e 65 20 6f 66 20 74 68  so add one of th
9380: 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 66 6c 61 67  e following flag
9390: 73 20 74 6f 20 74 68 65 20 78 4f 70 65 6e 20 6d  s to the xOpen m
93a0: 65 74 68 6f 64 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c  ethod:.**.** <ul
93b0: 3e 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54  >.** <li> [SQLIT
93c0: 45 5f 4f 50 45 4e 5f 44 45 4c 45 54 45 4f 4e 43  E_OPEN_DELETEONC
93d0: 4c 4f 53 45 5d 0a 2a 2a 20 3c 6c 69 3e 20 5b 53  LOSE].** <li> [S
93e0: 51 4c 49 54 45 5f 4f 50 45 4e 5f 45 58 43 4c 55  QLITE_OPEN_EXCLU
93f0: 53 49 56 45 5d 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a  SIVE].** </ul>.*
9400: 2a 0a 2a 2a 20 54 68 65 20 5b 53 51 4c 49 54 45  *.** The [SQLITE
9410: 5f 4f 50 45 4e 5f 44 45 4c 45 54 45 4f 4e 43 4c  _OPEN_DELETEONCL
9420: 4f 53 45 5d 20 66 6c 61 67 20 6d 65 61 6e 73 20  OSE] flag means 
9430: 74 68 65 20 66 69 6c 65 20 73 68 6f 75 6c 64 20  the file should 
9440: 62 65 0a 2a 2a 20 64 65 6c 65 74 65 64 20 77 68  be.** deleted wh
9450: 65 6e 20 69 74 20 69 73 20 63 6c 6f 73 65 64 2e  en it is closed.
9460: 20 20 5e 54 68 65 20 5b 53 51 4c 49 54 45 5f 4f    ^The [SQLITE_O
9470: 50 45 4e 5f 44 45 4c 45 54 45 4f 4e 43 4c 4f 53  PEN_DELETEONCLOS
9480: 45 5d 0a 2a 2a 20 77 69 6c 6c 20 62 65 20 73 65  E].** will be se
9490: 74 20 66 6f 72 20 54 45 4d 50 20 64 61 74 61 62  t for TEMP datab
94a0: 61 73 65 73 20 61 6e 64 20 74 68 65 69 72 20 6a  ases and their j
94b0: 6f 75 72 6e 61 6c 73 2c 20 74 72 61 6e 73 69 65  ournals, transie
94c0: 6e 74 0a 2a 2a 20 64 61 74 61 62 61 73 65 73 2c  nt.** databases,
94d0: 20 61 6e 64 20 73 75 62 6a 6f 75 72 6e 61 6c 73   and subjournals
94e0: 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 5b 53 51  ..**.** ^The [SQ
94f0: 4c 49 54 45 5f 4f 50 45 4e 5f 45 58 43 4c 55 53  LITE_OPEN_EXCLUS
9500: 49 56 45 5d 20 66 6c 61 67 20 69 73 20 61 6c 77  IVE] flag is alw
9510: 61 79 73 20 75 73 65 64 20 69 6e 20 63 6f 6e 6a  ays used in conj
9520: 75 6e 63 74 69 6f 6e 0a 2a 2a 20 77 69 74 68 20  unction.** with 
9530: 74 68 65 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  the [SQLITE_OPEN
9540: 5f 43 52 45 41 54 45 5d 20 66 6c 61 67 2c 20 77  _CREATE] flag, w
9550: 68 69 63 68 20 61 72 65 20 62 6f 74 68 20 64 69  hich are both di
9560: 72 65 63 74 6c 79 0a 2a 2a 20 61 6e 61 6c 6f 67  rectly.** analog
9570: 6f 75 73 20 74 6f 20 74 68 65 20 4f 5f 45 58 43  ous to the O_EXC
9580: 4c 20 61 6e 64 20 4f 5f 43 52 45 41 54 20 66 6c  L and O_CREAT fl
9590: 61 67 73 20 6f 66 20 74 68 65 20 50 4f 53 49 58  ags of the POSIX
95a0: 20 6f 70 65 6e 28 29 0a 2a 2a 20 41 50 49 2e 20   open().** API. 
95b0: 20 54 68 65 20 53 51 4c 49 54 45 5f 4f 50 45 4e   The SQLITE_OPEN
95c0: 5f 45 58 43 4c 55 53 49 56 45 20 66 6c 61 67 2c  _EXCLUSIVE flag,
95d0: 20 77 68 65 6e 20 70 61 69 72 65 64 20 77 69 74   when paired wit
95e0: 68 20 74 68 65 20 0a 2a 2a 20 53 51 4c 49 54 45  h the .** SQLITE
95f0: 5f 4f 50 45 4e 5f 43 52 45 41 54 45 2c 20 69 73  _OPEN_CREATE, is
9600: 20 75 73 65 64 20 74 6f 20 69 6e 64 69 63 61 74   used to indicat
9610: 65 20 74 68 61 74 20 66 69 6c 65 20 73 68 6f 75  e that file shou
9620: 6c 64 20 61 6c 77 61 79 73 0a 2a 2a 20 62 65 20  ld always.** be 
9630: 63 72 65 61 74 65 64 2c 20 61 6e 64 20 74 68 61  created, and tha
9640: 74 20 69 74 20 69 73 20 61 6e 20 65 72 72 6f 72  t it is an error
9650: 20 69 66 20 69 74 20 61 6c 72 65 61 64 79 20 65   if it already e
9660: 78 69 73 74 73 2e 0a 2a 2a 20 49 74 20 69 73 20  xists..** It is 
9670: 3c 69 3e 6e 6f 74 3c 2f 69 3e 20 75 73 65 64 20  <i>not</i> used 
9680: 74 6f 20 69 6e 64 69 63 61 74 65 20 74 68 65 20  to indicate the 
9690: 66 69 6c 65 20 73 68 6f 75 6c 64 20 62 65 20 6f  file should be o
96a0: 70 65 6e 65 64 20 0a 2a 2a 20 66 6f 72 20 65 78  pened .** for ex
96b0: 63 6c 75 73 69 76 65 20 61 63 63 65 73 73 2e 0a  clusive access..
96c0: 2a 2a 0a 2a 2a 20 5e 41 74 20 6c 65 61 73 74 20  **.** ^At least 
96d0: 73 7a 4f 73 46 69 6c 65 20 62 79 74 65 73 20 6f  szOsFile bytes o
96e0: 66 20 6d 65 6d 6f 72 79 20 61 72 65 20 61 6c 6c  f memory are all
96f0: 6f 63 61 74 65 64 20 62 79 20 53 51 4c 69 74 65  ocated by SQLite
9700: 0a 2a 2a 20 74 6f 20 68 6f 6c 64 20 74 68 65 20  .** to hold the 
9710: 20 5b 73 71 6c 69 74 65 33 5f 66 69 6c 65 5d 20   [sqlite3_file] 
9720: 73 74 72 75 63 74 75 72 65 20 70 61 73 73 65 64  structure passed
9730: 20 61 73 20 74 68 65 20 74 68 69 72 64 0a 2a 2a   as the third.**
9740: 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 78 4f 70   argument to xOp
9750: 65 6e 2e 20 20 54 68 65 20 78 4f 70 65 6e 20 6d  en.  The xOpen m
9760: 65 74 68 6f 64 20 64 6f 65 73 20 6e 6f 74 20 68  ethod does not h
9770: 61 76 65 20 74 6f 0a 2a 2a 20 61 6c 6c 6f 63 61  ave to.** alloca
9780: 74 65 20 74 68 65 20 73 74 72 75 63 74 75 72 65  te the structure
9790: 3b 20 69 74 20 73 68 6f 75 6c 64 20 6a 75 73 74  ; it should just
97a0: 20 66 69 6c 6c 20 69 74 20 69 6e 2e 20 20 4e 6f   fill it in.  No
97b0: 74 65 20 74 68 61 74 0a 2a 2a 20 74 68 65 20 78  te that.** the x
97c0: 4f 70 65 6e 20 6d 65 74 68 6f 64 20 6d 75 73 74  Open method must
97d0: 20 73 65 74 20 74 68 65 20 73 71 6c 69 74 65 33   set the sqlite3
97e0: 5f 66 69 6c 65 2e 70 4d 65 74 68 6f 64 73 20 74  _file.pMethods t
97f0: 6f 20 65 69 74 68 65 72 0a 2a 2a 20 61 20 76 61  o either.** a va
9800: 6c 69 64 20 5b 73 71 6c 69 74 65 33 5f 69 6f 5f  lid [sqlite3_io_
9810: 6d 65 74 68 6f 64 73 5d 20 6f 62 6a 65 63 74 20  methods] object 
9820: 6f 72 20 74 6f 20 4e 55 4c 4c 2e 20 20 78 4f 70  or to NULL.  xOp
9830: 65 6e 20 6d 75 73 74 20 64 6f 0a 2a 2a 20 74 68  en must do.** th
9840: 69 73 20 65 76 65 6e 20 69 66 20 74 68 65 20 6f  is even if the o
9850: 70 65 6e 20 66 61 69 6c 73 2e 20 20 53 51 4c 69  pen fails.  SQLi
9860: 74 65 20 65 78 70 65 63 74 73 20 74 68 61 74 20  te expects that 
9870: 74 68 65 20 73 71 6c 69 74 65 33 5f 66 69 6c 65  the sqlite3_file
9880: 2e 70 4d 65 74 68 6f 64 73 0a 2a 2a 20 65 6c 65  .pMethods.** ele
9890: 6d 65 6e 74 20 77 69 6c 6c 20 62 65 20 76 61 6c  ment will be val
98a0: 69 64 20 61 66 74 65 72 20 78 4f 70 65 6e 20 72  id after xOpen r
98b0: 65 74 75 72 6e 73 20 72 65 67 61 72 64 6c 65 73  eturns regardles
98c0: 73 20 6f 66 20 74 68 65 20 73 75 63 63 65 73 73  s of the success
98d0: 0a 2a 2a 20 6f 72 20 66 61 69 6c 75 72 65 20 6f  .** or failure o
98e0: 66 20 74 68 65 20 78 4f 70 65 6e 20 63 61 6c 6c  f the xOpen call
98f0: 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66 6c 61  ..**.** ^The fla
9900: 67 73 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 78  gs argument to x
9910: 41 63 63 65 73 73 28 29 20 6d 61 79 20 62 65 20  Access() may be 
9920: 5b 53 51 4c 49 54 45 5f 41 43 43 45 53 53 5f 45  [SQLITE_ACCESS_E
9930: 58 49 53 54 53 5d 0a 2a 2a 20 74 6f 20 74 65 73  XISTS].** to tes
9940: 74 20 66 6f 72 20 74 68 65 20 65 78 69 73 74 65  t for the existe
9950: 6e 63 65 20 6f 66 20 61 20 66 69 6c 65 2c 20 6f  nce of a file, o
9960: 72 20 5b 53 51 4c 49 54 45 5f 41 43 43 45 53 53  r [SQLITE_ACCESS
9970: 5f 52 45 41 44 57 52 49 54 45 5d 20 74 6f 0a 2a  _READWRITE] to.*
9980: 2a 20 74 65 73 74 20 77 68 65 74 68 65 72 20 61  * test whether a
9990: 20 66 69 6c 65 20 69 73 20 72 65 61 64 61 62 6c   file is readabl
99a0: 65 20 61 6e 64 20 77 72 69 74 61 62 6c 65 2c 20  e and writable, 
99b0: 6f 72 20 5b 53 51 4c 49 54 45 5f 41 43 43 45 53  or [SQLITE_ACCES
99c0: 53 5f 52 45 41 44 5d 0a 2a 2a 20 74 6f 20 74 65  S_READ].** to te
99d0: 73 74 20 77 68 65 74 68 65 72 20 61 20 66 69 6c  st whether a fil
99e0: 65 20 69 73 20 61 74 20 6c 65 61 73 74 20 72 65  e is at least re
99f0: 61 64 61 62 6c 65 2e 20 20 20 54 68 65 20 66 69  adable.   The fi
9a00: 6c 65 20 63 61 6e 20 62 65 20 61 0a 2a 2a 20 64  le can be a.** d
9a10: 69 72 65 63 74 6f 72 79 2e 0a 2a 2a 0a 2a 2a 20  irectory..**.** 
9a20: 5e 53 51 4c 69 74 65 20 77 69 6c 6c 20 61 6c 77  ^SQLite will alw
9a30: 61 79 73 20 61 6c 6c 6f 63 61 74 65 20 61 74 20  ays allocate at 
9a40: 6c 65 61 73 74 20 6d 78 50 61 74 68 6e 61 6d 65  least mxPathname
9a50: 2b 31 20 62 79 74 65 73 20 66 6f 72 20 74 68 65  +1 bytes for the
9a60: 0a 2a 2a 20 6f 75 74 70 75 74 20 62 75 66 66 65  .** output buffe
9a70: 72 20 78 46 75 6c 6c 50 61 74 68 6e 61 6d 65 2e  r xFullPathname.
9a80: 20 20 54 68 65 20 65 78 61 63 74 20 73 69 7a 65    The exact size
9a90: 20 6f 66 20 74 68 65 20 6f 75 74 70 75 74 20 62   of the output b
9aa0: 75 66 66 65 72 0a 2a 2a 20 69 73 20 61 6c 73 6f  uffer.** is also
9ab0: 20 70 61 73 73 65 64 20 61 73 20 61 20 70 61 72   passed as a par
9ac0: 61 6d 65 74 65 72 20 74 6f 20 62 6f 74 68 20 20  ameter to both  
9ad0: 6d 65 74 68 6f 64 73 2e 20 49 66 20 74 68 65 20  methods. If the 
9ae0: 6f 75 74 70 75 74 20 62 75 66 66 65 72 0a 2a 2a  output buffer.**
9af0: 20 69 73 20 6e 6f 74 20 6c 61 72 67 65 20 65 6e   is not large en
9b00: 6f 75 67 68 2c 20 5b 53 51 4c 49 54 45 5f 43 41  ough, [SQLITE_CA
9b10: 4e 54 4f 50 45 4e 5d 20 73 68 6f 75 6c 64 20 62  NTOPEN] should b
9b20: 65 20 72 65 74 75 72 6e 65 64 2e 20 53 69 6e 63  e returned. Sinc
9b30: 65 20 74 68 69 73 20 69 73 0a 2a 2a 20 68 61 6e  e this is.** han
9b40: 64 6c 65 64 20 61 73 20 61 20 66 61 74 61 6c 20  dled as a fatal 
9b50: 65 72 72 6f 72 20 62 79 20 53 51 4c 69 74 65 2c  error by SQLite,
9b60: 20 76 66 73 20 69 6d 70 6c 65 6d 65 6e 74 61 74   vfs implementat
9b70: 69 6f 6e 73 20 73 68 6f 75 6c 64 20 65 6e 64 65  ions should ende
9b80: 61 76 6f 72 0a 2a 2a 20 74 6f 20 70 72 65 76 65  avor.** to preve
9b90: 6e 74 20 74 68 69 73 20 62 79 20 73 65 74 74 69  nt this by setti
9ba0: 6e 67 20 6d 78 50 61 74 68 6e 61 6d 65 20 74 6f  ng mxPathname to
9bb0: 20 61 20 73 75 66 66 69 63 69 65 6e 74 6c 79 20   a sufficiently 
9bc0: 6c 61 72 67 65 20 76 61 6c 75 65 2e 0a 2a 2a 0a  large value..**.
9bd0: 2a 2a 20 54 68 65 20 78 52 61 6e 64 6f 6d 6e 65  ** The xRandomne
9be0: 73 73 28 29 2c 20 78 53 6c 65 65 70 28 29 2c 20  ss(), xSleep(), 
9bf0: 78 43 75 72 72 65 6e 74 54 69 6d 65 28 29 2c 20  xCurrentTime(), 
9c00: 61 6e 64 20 78 43 75 72 72 65 6e 74 54 69 6d 65  and xCurrentTime
9c10: 49 6e 74 36 34 28 29 0a 2a 2a 20 69 6e 74 65 72  Int64().** inter
9c20: 66 61 63 65 73 20 61 72 65 20 6e 6f 74 20 73 74  faces are not st
9c30: 72 69 63 74 6c 79 20 61 20 70 61 72 74 20 6f 66  rictly a part of
9c40: 20 74 68 65 20 66 69 6c 65 73 79 73 74 65 6d 2c   the filesystem,
9c50: 20 62 75 74 20 74 68 65 79 20 61 72 65 0a 2a 2a   but they are.**
9c60: 20 69 6e 63 6c 75 64 65 64 20 69 6e 20 74 68 65   included in the
9c70: 20 56 46 53 20 73 74 72 75 63 74 75 72 65 20 66   VFS structure f
9c80: 6f 72 20 63 6f 6d 70 6c 65 74 65 6e 65 73 73 2e  or completeness.
9c90: 0a 2a 2a 20 54 68 65 20 78 52 61 6e 64 6f 6d 6e  .** The xRandomn
9ca0: 65 73 73 28 29 20 66 75 6e 63 74 69 6f 6e 20 61  ess() function a
9cb0: 74 74 65 6d 70 74 73 20 74 6f 20 72 65 74 75 72  ttempts to retur
9cc0: 6e 20 6e 42 79 74 65 73 20 62 79 74 65 73 0a 2a  n nBytes bytes.*
9cd0: 2a 20 6f 66 20 67 6f 6f 64 2d 71 75 61 6c 69 74  * of good-qualit
9ce0: 79 20 72 61 6e 64 6f 6d 6e 65 73 73 20 69 6e 74  y randomness int
9cf0: 6f 20 7a 4f 75 74 2e 20 20 54 68 65 20 72 65 74  o zOut.  The ret
9d00: 75 72 6e 20 76 61 6c 75 65 20 69 73 0a 2a 2a 20  urn value is.** 
9d10: 74 68 65 20 61 63 74 75 61 6c 20 6e 75 6d 62 65  the actual numbe
9d20: 72 20 6f 66 20 62 79 74 65 73 20 6f 66 20 72 61  r of bytes of ra
9d30: 6e 64 6f 6d 6e 65 73 73 20 6f 62 74 61 69 6e 65  ndomness obtaine
9d40: 64 2e 0a 2a 2a 20 54 68 65 20 78 53 6c 65 65 70  d..** The xSleep
9d50: 28 29 20 6d 65 74 68 6f 64 20 63 61 75 73 65 73  () method causes
9d60: 20 74 68 65 20 63 61 6c 6c 69 6e 67 20 74 68 72   the calling thr
9d70: 65 61 64 20 74 6f 20 73 6c 65 65 70 20 66 6f 72  ead to sleep for
9d80: 20 61 74 0a 2a 2a 20 6c 65 61 73 74 20 74 68 65   at.** least the
9d90: 20 6e 75 6d 62 65 72 20 6f 66 20 6d 69 63 72 6f   number of micro
9da0: 73 65 63 6f 6e 64 73 20 67 69 76 65 6e 2e 20 20  seconds given.  
9db0: 5e 54 68 65 20 78 43 75 72 72 65 6e 74 54 69 6d  ^The xCurrentTim
9dc0: 65 28 29 0a 2a 2a 20 6d 65 74 68 6f 64 20 72 65  e().** method re
9dd0: 74 75 72 6e 73 20 61 20 4a 75 6c 69 61 6e 20 44  turns a Julian D
9de0: 61 79 20 4e 75 6d 62 65 72 20 66 6f 72 20 74 68  ay Number for th
9df0: 65 20 63 75 72 72 65 6e 74 20 64 61 74 65 20 61  e current date a
9e00: 6e 64 20 74 69 6d 65 20 61 73 0a 2a 2a 20 61 20  nd time as.** a 
9e10: 66 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 20 76  floating point v
9e20: 61 6c 75 65 2e 0a 2a 2a 20 5e 54 68 65 20 78 43  alue..** ^The xC
9e30: 75 72 72 65 6e 74 54 69 6d 65 49 6e 74 36 34 28  urrentTimeInt64(
9e40: 29 20 6d 65 74 68 6f 64 20 72 65 74 75 72 6e 73  ) method returns
9e50: 2c 20 61 73 20 61 6e 20 69 6e 74 65 67 65 72 2c  , as an integer,
9e60: 20 74 68 65 20 4a 75 6c 69 61 6e 0a 2a 2a 20 44   the Julian.** D
9e70: 61 79 20 4e 75 6d 62 65 72 20 6d 75 6c 74 69 70  ay Number multip
9e80: 6c 65 64 20 62 79 20 38 36 34 30 30 30 30 30 20  led by 86400000 
9e90: 28 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 6d  (the number of m
9ea0: 69 6c 6c 69 73 65 63 6f 6e 64 73 20 69 6e 20 0a  illiseconds in .
9eb0: 2a 2a 20 61 20 32 34 2d 68 6f 75 72 20 64 61 79  ** a 24-hour day
9ec0: 29 2e 20 20 0a 2a 2a 20 5e 53 51 4c 69 74 65 20  ).  .** ^SQLite 
9ed0: 77 69 6c 6c 20 75 73 65 20 74 68 65 20 78 43 75  will use the xCu
9ee0: 72 72 65 6e 74 54 69 6d 65 49 6e 74 36 34 28 29  rrentTimeInt64()
9ef0: 20 6d 65 74 68 6f 64 20 74 6f 20 67 65 74 20 74   method to get t
9f00: 68 65 20 63 75 72 72 65 6e 74 0a 2a 2a 20 64 61  he current.** da
9f10: 74 65 20 61 6e 64 20 74 69 6d 65 20 69 66 20 74  te and time if t
9f20: 68 61 74 20 6d 65 74 68 6f 64 20 69 73 20 61 76  hat method is av
9f30: 61 69 6c 61 62 6c 65 20 28 69 66 20 69 56 65 72  ailable (if iVer
9f40: 73 69 6f 6e 20 69 73 20 32 20 6f 72 20 0a 2a 2a  sion is 2 or .**
9f50: 20 67 72 65 61 74 65 72 20 61 6e 64 20 74 68 65   greater and the
9f60: 20 66 75 6e 63 74 69 6f 6e 20 70 6f 69 6e 74 65   function pointe
9f70: 72 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 29 20 61  r is not NULL) a
9f80: 6e 64 20 77 69 6c 6c 20 66 61 6c 6c 20 62 61 63  nd will fall bac
9f90: 6b 0a 2a 2a 20 74 6f 20 78 43 75 72 72 65 6e 74  k.** to xCurrent
9fa0: 54 69 6d 65 28 29 20 69 66 20 78 43 75 72 72 65  Time() if xCurre
9fb0: 6e 74 54 69 6d 65 49 6e 74 36 34 28 29 20 69 73  ntTimeInt64() is
9fc0: 20 75 6e 61 76 61 69 6c 61 62 6c 65 2e 0a 2a 2f   unavailable..*/
9fd0: 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20  .typedef struct 
9fe0: 73 71 6c 69 74 65 33 5f 76 66 73 20 73 71 6c 69  sqlite3_vfs sqli
9ff0: 74 65 33 5f 76 66 73 3b 0a 73 74 72 75 63 74 20  te3_vfs;.struct 
a000: 73 71 6c 69 74 65 33 5f 76 66 73 20 7b 0a 20 20  sqlite3_vfs {.  
a010: 69 6e 74 20 69 56 65 72 73 69 6f 6e 3b 20 20 20  int iVersion;   
a020: 20 20 20 20 20 20 20 20 20 2f 2a 20 53 74 72 75           /* Stru
a030: 63 74 75 72 65 20 76 65 72 73 69 6f 6e 20 6e 75  cture version nu
a040: 6d 62 65 72 20 28 63 75 72 72 65 6e 74 6c 79 20  mber (currently 
a050: 32 29 20 2a 2f 0a 20 20 69 6e 74 20 73 7a 4f 73  2) */.  int szOs
a060: 46 69 6c 65 3b 20 20 20 20 20 20 20 20 20 20 20  File;           
a070: 20 2f 2a 20 53 69 7a 65 20 6f 66 20 73 75 62 63   /* Size of subc
a080: 6c 61 73 73 65 64 20 73 71 6c 69 74 65 33 5f 66  lassed sqlite3_f
a090: 69 6c 65 20 2a 2f 0a 20 20 69 6e 74 20 6d 78 50  ile */.  int mxP
a0a0: 61 74 68 6e 61 6d 65 3b 20 20 20 20 20 20 20 20  athname;        
a0b0: 20 20 2f 2a 20 4d 61 78 69 6d 75 6d 20 66 69 6c    /* Maximum fil
a0c0: 65 20 70 61 74 68 6e 61 6d 65 20 6c 65 6e 67 74  e pathname lengt
a0d0: 68 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33 5f 76  h */.  sqlite3_v
a0e0: 66 73 20 2a 70 4e 65 78 74 3b 20 20 20 20 20 20  fs *pNext;      
a0f0: 2f 2a 20 4e 65 78 74 20 72 65 67 69 73 74 65 72  /* Next register
a100: 65 64 20 56 46 53 20 2a 2f 0a 20 20 63 6f 6e 73  ed VFS */.  cons
a110: 74 20 63 68 61 72 20 2a 7a 4e 61 6d 65 3b 20 20  t char *zName;  
a120: 20 20 20 20 20 2f 2a 20 4e 61 6d 65 20 6f 66 20       /* Name of 
a130: 74 68 69 73 20 76 69 72 74 75 61 6c 20 66 69 6c  this virtual fil
a140: 65 20 73 79 73 74 65 6d 20 2a 2f 0a 20 20 76 6f  e system */.  vo
a150: 69 64 20 2a 70 41 70 70 44 61 74 61 3b 20 20 20  id *pAppData;   
a160: 20 20 20 20 20 20 20 2f 2a 20 50 6f 69 6e 74 65         /* Pointe
a170: 72 20 74 6f 20 61 70 70 6c 69 63 61 74 69 6f 6e  r to application
a180: 2d 73 70 65 63 69 66 69 63 20 64 61 74 61 20 2a  -specific data *
a190: 2f 0a 20 20 69 6e 74 20 28 2a 78 4f 70 65 6e 29  /.  int (*xOpen)
a1a0: 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 63  (sqlite3_vfs*, c
a1b0: 6f 6e 73 74 20 63 68 61 72 20 2a 7a 4e 61 6d 65  onst char *zName
a1c0: 2c 20 73 71 6c 69 74 65 33 5f 66 69 6c 65 2a 2c  , sqlite3_file*,
a1d0: 0a 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  .               
a1e0: 69 6e 74 20 66 6c 61 67 73 2c 20 69 6e 74 20 2a  int flags, int *
a1f0: 70 4f 75 74 46 6c 61 67 73 29 3b 0a 20 20 69 6e  pOutFlags);.  in
a200: 74 20 28 2a 78 44 65 6c 65 74 65 29 28 73 71 6c  t (*xDelete)(sql
a210: 69 74 65 33 5f 76 66 73 2a 2c 20 63 6f 6e 73 74  ite3_vfs*, const
a220: 20 63 68 61 72 20 2a 7a 4e 61 6d 65 2c 20 69 6e   char *zName, in
a230: 74 20 73 79 6e 63 44 69 72 29 3b 0a 20 20 69 6e  t syncDir);.  in
a240: 74 20 28 2a 78 41 63 63 65 73 73 29 28 73 71 6c  t (*xAccess)(sql
a250: 69 74 65 33 5f 76 66 73 2a 2c 20 63 6f 6e 73 74  ite3_vfs*, const
a260: 20 63 68 61 72 20 2a 7a 4e 61 6d 65 2c 20 69 6e   char *zName, in
a270: 74 20 66 6c 61 67 73 2c 20 69 6e 74 20 2a 70 52  t flags, int *pR
a280: 65 73 4f 75 74 29 3b 0a 20 20 69 6e 74 20 28 2a  esOut);.  int (*
a290: 78 46 75 6c 6c 50 61 74 68 6e 61 6d 65 29 28 73  xFullPathname)(s
a2a0: 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 63 6f 6e  qlite3_vfs*, con
a2b0: 73 74 20 63 68 61 72 20 2a 7a 4e 61 6d 65 2c 20  st char *zName, 
a2c0: 69 6e 74 20 6e 4f 75 74 2c 20 63 68 61 72 20 2a  int nOut, char *
a2d0: 7a 4f 75 74 29 3b 0a 20 20 76 6f 69 64 20 2a 28  zOut);.  void *(
a2e0: 2a 78 44 6c 4f 70 65 6e 29 28 73 71 6c 69 74 65  *xDlOpen)(sqlite
a2f0: 33 5f 76 66 73 2a 2c 20 63 6f 6e 73 74 20 63 68  3_vfs*, const ch
a300: 61 72 20 2a 7a 46 69 6c 65 6e 61 6d 65 29 3b 0a  ar *zFilename);.
a310: 20 20 76 6f 69 64 20 28 2a 78 44 6c 45 72 72 6f    void (*xDlErro
a320: 72 29 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c  r)(sqlite3_vfs*,
a330: 20 69 6e 74 20 6e 42 79 74 65 2c 20 63 68 61 72   int nByte, char
a340: 20 2a 7a 45 72 72 4d 73 67 29 3b 0a 20 20 76 6f   *zErrMsg);.  vo
a350: 69 64 20 28 2a 28 2a 78 44 6c 53 79 6d 29 28 73  id (*(*xDlSym)(s
a360: 71 6c 69 74 65 33 5f 76 66 73 2a 2c 76 6f 69 64  qlite3_vfs*,void
a370: 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a  *, const char *z
a380: 53 79 6d 62 6f 6c 29 29 28 76 6f 69 64 29 3b 0a  Symbol))(void);.
a390: 20 20 76 6f 69 64 20 28 2a 78 44 6c 43 6c 6f 73    void (*xDlClos
a3a0: 65 29 28 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c  e)(sqlite3_vfs*,
a3b0: 20 76 6f 69 64 2a 29 3b 0a 20 20 69 6e 74 20 28   void*);.  int (
a3c0: 2a 78 52 61 6e 64 6f 6d 6e 65 73 73 29 28 73 71  *xRandomness)(sq
a3d0: 6c 69 74 65 33 5f 76 66 73 2a 2c 20 69 6e 74 20  lite3_vfs*, int 
a3e0: 6e 42 79 74 65 2c 20 63 68 61 72 20 2a 7a 4f 75  nByte, char *zOu
a3f0: 74 29 3b 0a 20 20 69 6e 74 20 28 2a 78 53 6c 65  t);.  int (*xSle
a400: 65 70 29 28 73 71 6c 69 74 65 33 5f 76 66 73 2a  ep)(sqlite3_vfs*
a410: 2c 20 69 6e 74 20 6d 69 63 72 6f 73 65 63 6f 6e  , int microsecon
a420: 64 73 29 3b 0a 20 20 69 6e 74 20 28 2a 78 43 75  ds);.  int (*xCu
a430: 72 72 65 6e 74 54 69 6d 65 29 28 73 71 6c 69 74  rrentTime)(sqlit
a440: 65 33 5f 76 66 73 2a 2c 20 64 6f 75 62 6c 65 2a  e3_vfs*, double*
a450: 29 3b 0a 20 20 69 6e 74 20 28 2a 78 47 65 74 4c  );.  int (*xGetL
a460: 61 73 74 45 72 72 6f 72 29 28 73 71 6c 69 74 65  astError)(sqlite
a470: 33 5f 76 66 73 2a 2c 20 69 6e 74 2c 20 63 68 61  3_vfs*, int, cha
a480: 72 20 2a 29 3b 0a 20 20 2f 2a 0a 20 20 2a 2a 20  r *);.  /*.  ** 
a490: 54 68 65 20 6d 65 74 68 6f 64 73 20 61 62 6f 76  The methods abov
a4a0: 65 20 61 72 65 20 69 6e 20 76 65 72 73 69 6f 6e  e are in version
a4b0: 20 31 20 6f 66 20 74 68 65 20 73 71 6c 69 74 65   1 of the sqlite
a4c0: 5f 76 66 73 20 6f 62 6a 65 63 74 0a 20 20 2a 2a  _vfs object.  **
a4d0: 20 64 65 66 69 6e 69 74 69 6f 6e 2e 20 20 54 68   definition.  Th
a4e0: 6f 73 65 20 74 68 61 74 20 66 6f 6c 6c 6f 77 20  ose that follow 
a4f0: 61 72 65 20 61 64 64 65 64 20 69 6e 20 76 65 72  are added in ver
a500: 73 69 6f 6e 20 32 20 6f 72 20 6c 61 74 65 72 0a  sion 2 or later.
a510: 20 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78 43 75    */.  int (*xCu
a520: 72 72 65 6e 74 54 69 6d 65 49 6e 74 36 34 29 28  rrentTimeInt64)(
a530: 73 71 6c 69 74 65 33 5f 76 66 73 2a 2c 20 73 71  sqlite3_vfs*, sq
a540: 6c 69 74 65 33 5f 69 6e 74 36 34 2a 29 3b 0a 20  lite3_int64*);. 
a550: 20 2f 2a 0a 20 20 2a 2a 20 54 68 65 20 6d 65 74   /*.  ** The met
a560: 68 6f 64 73 20 61 62 6f 76 65 20 61 72 65 20 69  hods above are i
a570: 6e 20 76 65 72 73 69 6f 6e 73 20 31 20 61 6e 64  n versions 1 and
a580: 20 32 20 6f 66 20 74 68 65 20 73 71 6c 69 74 65   2 of the sqlite
a590: 5f 76 66 73 20 6f 62 6a 65 63 74 2e 0a 20 20 2a  _vfs object..  *
a5a0: 2a 20 4e 65 77 20 66 69 65 6c 64 73 20 6d 61 79  * New fields may
a5b0: 20 62 65 20 61 70 70 65 6e 64 65 64 20 69 6e 20   be appended in 
a5c0: 66 69 67 75 72 65 20 76 65 72 73 69 6f 6e 73 2e  figure versions.
a5d0: 20 20 54 68 65 20 69 56 65 72 73 69 6f 6e 0a 20    The iVersion. 
a5e0: 20 2a 2a 20 76 61 6c 75 65 20 77 69 6c 6c 20 69   ** value will i
a5f0: 6e 63 72 65 6d 65 6e 74 20 77 68 65 6e 65 76 65  ncrement wheneve
a600: 72 20 74 68 69 73 20 68 61 70 70 65 6e 73 2e 20  r this happens. 
a610: 0a 20 20 2a 2f 0a 7d 3b 0a 0a 2f 2a 0a 2a 2a 20  .  */.};../*.** 
a620: 43 41 50 49 33 52 45 46 3a 20 46 6c 61 67 73 20  CAPI3REF: Flags 
a630: 66 6f 72 20 74 68 65 20 78 41 63 63 65 73 73 20  for the xAccess 
a640: 56 46 53 20 6d 65 74 68 6f 64 0a 2a 2a 0a 2a 2a  VFS method.**.**
a650: 20 54 68 65 73 65 20 69 6e 74 65 67 65 72 20 63   These integer c
a660: 6f 6e 73 74 61 6e 74 73 20 63 61 6e 20 62 65 20  onstants can be 
a670: 75 73 65 64 20 61 73 20 74 68 65 20 74 68 69 72  used as the thir
a680: 64 20 70 61 72 61 6d 65 74 65 72 20 74 6f 0a 2a  d parameter to.*
a690: 2a 20 74 68 65 20 78 41 63 63 65 73 73 20 6d 65  * the xAccess me
a6a0: 74 68 6f 64 20 6f 66 20 61 6e 20 5b 73 71 6c 69  thod of an [sqli
a6b0: 74 65 33 5f 76 66 73 5d 20 6f 62 6a 65 63 74 2e  te3_vfs] object.
a6c0: 20 20 54 68 65 79 20 64 65 74 65 72 6d 69 6e 65    They determine
a6d0: 0a 2a 2a 20 77 68 61 74 20 6b 69 6e 64 20 6f 66  .** what kind of
a6e0: 20 70 65 72 6d 69 73 73 69 6f 6e 73 20 74 68 65   permissions the
a6f0: 20 78 41 63 63 65 73 73 20 6d 65 74 68 6f 64 20   xAccess method 
a700: 69 73 20 6c 6f 6f 6b 69 6e 67 20 66 6f 72 2e 0a  is looking for..
a710: 2a 2a 20 57 69 74 68 20 53 51 4c 49 54 45 5f 41  ** With SQLITE_A
a720: 43 43 45 53 53 5f 45 58 49 53 54 53 2c 20 74 68  CCESS_EXISTS, th
a730: 65 20 78 41 63 63 65 73 73 20 6d 65 74 68 6f 64  e xAccess method
a740: 0a 2a 2a 20 73 69 6d 70 6c 79 20 63 68 65 63 6b  .** simply check
a750: 73 20 77 68 65 74 68 65 72 20 74 68 65 20 66 69  s whether the fi
a760: 6c 65 20 65 78 69 73 74 73 2e 0a 2a 2a 20 57 69  le exists..** Wi
a770: 74 68 20 53 51 4c 49 54 45 5f 41 43 43 45 53 53  th SQLITE_ACCESS
a780: 5f 52 45 41 44 57 52 49 54 45 2c 20 74 68 65 20  _READWRITE, the 
a790: 78 41 63 63 65 73 73 20 6d 65 74 68 6f 64 0a 2a  xAccess method.*
a7a0: 2a 20 63 68 65 63 6b 73 20 77 68 65 74 68 65 72  * checks whether
a7b0: 20 74 68 65 20 6e 61 6d 65 64 20 64 69 72 65 63   the named direc
a7c0: 74 6f 72 79 20 69 73 20 62 6f 74 68 20 72 65 61  tory is both rea
a7d0: 64 61 62 6c 65 20 61 6e 64 20 77 72 69 74 61 62  dable and writab
a7e0: 6c 65 0a 2a 2a 20 28 69 6e 20 6f 74 68 65 72 20  le.** (in other 
a7f0: 77 6f 72 64 73 2c 20 69 66 20 66 69 6c 65 73 20  words, if files 
a800: 63 61 6e 20 62 65 20 61 64 64 65 64 2c 20 72 65  can be added, re
a810: 6d 6f 76 65 64 2c 20 61 6e 64 20 72 65 6e 61 6d  moved, and renam
a820: 65 64 20 77 69 74 68 69 6e 0a 2a 2a 20 74 68 65  ed within.** the
a830: 20 64 69 72 65 63 74 6f 72 79 29 2e 0a 2a 2a 20   directory)..** 
a840: 54 68 65 20 53 51 4c 49 54 45 5f 41 43 43 45 53  The SQLITE_ACCES
a850: 53 5f 52 45 41 44 57 52 49 54 45 20 63 6f 6e 73  S_READWRITE cons
a860: 74 61 6e 74 20 69 73 20 63 75 72 72 65 6e 74 6c  tant is currentl
a870: 79 20 75 73 65 64 20 6f 6e 6c 79 20 62 79 20 74  y used only by t
a880: 68 65 0a 2a 2a 20 5b 74 65 6d 70 5f 73 74 6f 72  he.** [temp_stor
a890: 65 5f 64 69 72 65 63 74 6f 72 79 20 70 72 61 67  e_directory prag
a8a0: 6d 61 5d 2c 20 74 68 6f 75 67 68 20 74 68 69 73  ma], though this
a8b0: 20 63 6f 75 6c 64 20 63 68 61 6e 67 65 20 69 6e   could change in
a8c0: 20 61 20 66 75 74 75 72 65 0a 2a 2a 20 72 65 6c   a future.** rel
a8d0: 65 61 73 65 20 6f 66 20 53 51 4c 69 74 65 2e 0a  ease of SQLite..
a8e0: 2a 2a 20 57 69 74 68 20 53 51 4c 49 54 45 5f 41  ** With SQLITE_A
a8f0: 43 43 45 53 53 5f 52 45 41 44 2c 20 74 68 65 20  CCESS_READ, the 
a900: 78 41 63 63 65 73 73 20 6d 65 74 68 6f 64 0a 2a  xAccess method.*
a910: 2a 20 63 68 65 63 6b 73 20 77 68 65 74 68 65 72  * checks whether
a920: 20 74 68 65 20 66 69 6c 65 20 69 73 20 72 65 61   the file is rea
a930: 64 61 62 6c 65 2e 20 20 54 68 65 20 53 51 4c 49  dable.  The SQLI
a940: 54 45 5f 41 43 43 45 53 53 5f 52 45 41 44 20 63  TE_ACCESS_READ c
a950: 6f 6e 73 74 61 6e 74 20 69 73 0a 2a 2a 20 63 75  onstant is.** cu
a960: 72 72 65 6e 74 6c 79 20 75 6e 75 73 65 64 2c 20  rrently unused, 
a970: 74 68 6f 75 67 68 20 69 74 20 6d 69 67 68 74 20  though it might 
a980: 62 65 20 75 73 65 64 20 69 6e 20 61 20 66 75 74  be used in a fut
a990: 75 72 65 20 72 65 6c 65 61 73 65 20 6f 66 0a 2a  ure release of.*
a9a0: 2a 20 53 51 4c 69 74 65 2e 0a 2a 2f 0a 23 64 65  * SQLite..*/.#de
a9b0: 66 69 6e 65 20 53 51 4c 49 54 45 5f 41 43 43 45  fine SQLITE_ACCE
a9c0: 53 53 5f 45 58 49 53 54 53 20 20 20 20 30 0a 23  SS_EXISTS    0.#
a9d0: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 41 43  define SQLITE_AC
a9e0: 43 45 53 53 5f 52 45 41 44 57 52 49 54 45 20 31  CESS_READWRITE 1
a9f0: 20 20 20 2f 2a 20 55 73 65 64 20 62 79 20 50 52     /* Used by PR
aa00: 41 47 4d 41 20 74 65 6d 70 5f 73 74 6f 72 65 5f  AGMA temp_store_
aa10: 64 69 72 65 63 74 6f 72 79 20 2a 2f 0a 23 64 65  directory */.#de
aa20: 66 69 6e 65 20 53 51 4c 49 54 45 5f 41 43 43 45  fine SQLITE_ACCE
aa30: 53 53 5f 52 45 41 44 20 20 20 20 20 20 32 20 20  SS_READ      2  
aa40: 20 2f 2a 20 55 6e 75 73 65 64 20 2a 2f 0a 0a 2f   /* Unused */../
aa50: 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 46  *.** CAPI3REF: F
aa60: 6c 61 67 73 20 66 6f 72 20 74 68 65 20 78 53 68  lags for the xSh
aa70: 6d 4c 6f 63 6b 20 56 46 53 20 6d 65 74 68 6f 64  mLock VFS method
aa80: 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 69 6e 74  .**.** These int
aa90: 65 67 65 72 20 63 6f 6e 73 74 61 6e 74 73 20 64  eger constants d
aaa0: 65 66 69 6e 65 20 74 68 65 20 76 61 72 69 6f 75  efine the variou
aab0: 73 20 6c 6f 63 6b 69 6e 67 20 6f 70 65 72 61 74  s locking operat
aac0: 69 6f 6e 73 0a 2a 2a 20 61 6c 6c 6f 77 65 64 20  ions.** allowed 
aad0: 62 79 20 74 68 65 20 78 53 68 6d 4c 6f 63 6b 20  by the xShmLock 
aae0: 6d 65 74 68 6f 64 20 6f 66 20 5b 73 71 6c 69 74  method of [sqlit
aaf0: 65 33 5f 69 6f 5f 6d 65 74 68 6f 64 73 5d 2e 20  e3_io_methods]. 
ab00: 20 54 68 65 0a 2a 2a 20 66 6f 6c 6c 6f 77 69 6e   The.** followin
ab10: 67 20 61 72 65 20 74 68 65 20 6f 6e 6c 79 20 6c  g are the only l
ab20: 65 67 61 6c 20 63 6f 6d 62 69 6e 61 74 69 6f 6e  egal combination
ab30: 73 20 6f 66 20 66 6c 61 67 73 20 74 6f 20 74 68  s of flags to th
ab40: 65 0a 2a 2a 20 78 53 68 6d 4c 6f 63 6b 20 6d 65  e.** xShmLock me
ab50: 74 68 6f 64 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e  thod:.**.** <ul>
ab60: 0a 2a 2a 20 3c 6c 69 3e 20 20 53 51 4c 49 54 45  .** <li>  SQLITE
ab70: 5f 53 48 4d 5f 4c 4f 43 4b 20 7c 20 53 51 4c 49  _SHM_LOCK | SQLI
ab80: 54 45 5f 53 48 4d 5f 53 48 41 52 45 44 0a 2a 2a  TE_SHM_SHARED.**
ab90: 20 3c 6c 69 3e 20 20 53 51 4c 49 54 45 5f 53 48   <li>  SQLITE_SH
aba0: 4d 5f 4c 4f 43 4b 20 7c 20 53 51 4c 49 54 45 5f  M_LOCK | SQLITE_
abb0: 53 48 4d 5f 45 58 43 4c 55 53 49 56 45 0a 2a 2a  SHM_EXCLUSIVE.**
abc0: 20 3c 6c 69 3e 20 20 53 51 4c 49 54 45 5f 53 48   <li>  SQLITE_SH
abd0: 4d 5f 55 4e 4c 4f 43 4b 20 7c 20 53 51 4c 49 54  M_UNLOCK | SQLIT
abe0: 45 5f 53 48 4d 5f 53 48 41 52 45 44 0a 2a 2a 20  E_SHM_SHARED.** 
abf0: 3c 6c 69 3e 20 20 53 51 4c 49 54 45 5f 53 48 4d  <li>  SQLITE_SHM
ac00: 5f 55 4e 4c 4f 43 4b 20 7c 20 53 51 4c 49 54 45  _UNLOCK | SQLITE
ac10: 5f 53 48 4d 5f 45 58 43 4c 55 53 49 56 45 0a 2a  _SHM_EXCLUSIVE.*
ac20: 2a 20 3c 2f 75 6c 3e 0a 2a 2a 0a 2a 2a 20 57 68  * </ul>.**.** Wh
ac30: 65 6e 20 75 6e 6c 6f 63 6b 69 6e 67 2c 20 74 68  en unlocking, th
ac40: 65 20 73 61 6d 65 20 53 48 41 52 45 44 20 6f 72  e same SHARED or
ac50: 20 45 58 43 4c 55 53 49 56 45 20 66 6c 61 67 20   EXCLUSIVE flag 
ac60: 6d 75 73 74 20 62 65 20 73 75 70 70 6c 69 65 64  must be supplied
ac70: 20 61 73 0a 2a 2a 20 77 61 73 20 67 69 76 65 6e   as.** was given
ac80: 20 6e 6f 20 74 68 65 20 63 6f 72 72 65 73 70 6f   no the correspo
ac90: 6e 64 69 6e 67 20 6c 6f 63 6b 2e 20 20 0a 2a 2a  nding lock.  .**
aca0: 0a 2a 2a 20 54 68 65 20 78 53 68 6d 4c 6f 63 6b  .** The xShmLock
acb0: 20 6d 65 74 68 6f 64 20 63 61 6e 20 74 72 61 6e   method can tran
acc0: 73 69 74 69 6f 6e 20 62 65 74 77 65 65 6e 20 75  sition between u
acd0: 6e 6c 6f 63 6b 65 64 20 61 6e 64 20 53 48 41 52  nlocked and SHAR
ace0: 45 44 20 6f 72 0a 2a 2a 20 62 65 74 77 65 65 6e  ED or.** between
acf0: 20 75 6e 6c 6f 63 6b 65 64 20 61 6e 64 20 45 58   unlocked and EX
ad00: 43 4c 55 53 49 56 45 2e 20 20 49 74 20 63 61 6e  CLUSIVE.  It can
ad10: 6e 6f 74 20 74 72 61 6e 73 69 74 69 6f 6e 20 62  not transition b
ad20: 65 74 77 65 65 6e 20 53 48 41 52 45 44 0a 2a 2a  etween SHARED.**
ad30: 20 61 6e 64 20 45 58 43 4c 55 53 49 56 45 2e 0a   and EXCLUSIVE..
ad40: 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
ad50: 45 5f 53 48 4d 5f 55 4e 4c 4f 43 4b 20 20 20 20  E_SHM_UNLOCK    
ad60: 20 20 20 31 0a 23 64 65 66 69 6e 65 20 53 51 4c     1.#define SQL
ad70: 49 54 45 5f 53 48 4d 5f 4c 4f 43 4b 20 20 20 20  ITE_SHM_LOCK    
ad80: 20 20 20 20 20 32 0a 23 64 65 66 69 6e 65 20 53       2.#define S
ad90: 51 4c 49 54 45 5f 53 48 4d 5f 53 48 41 52 45 44  QLITE_SHM_SHARED
ada0: 20 20 20 20 20 20 20 34 0a 23 64 65 66 69 6e 65         4.#define
adb0: 20 53 51 4c 49 54 45 5f 53 48 4d 5f 45 58 43 4c   SQLITE_SHM_EXCL
adc0: 55 53 49 56 45 20 20 20 20 38 0a 0a 2f 2a 0a 2a  USIVE    8../*.*
add0: 2a 20 43 41 50 49 33 52 45 46 3a 20 4d 61 78 69  * CAPI3REF: Maxi
ade0: 6d 75 6d 20 78 53 68 6d 4c 6f 63 6b 20 69 6e 64  mum xShmLock ind
adf0: 65 78 0a 2a 2a 0a 2a 2a 20 54 68 65 20 78 53 68  ex.**.** The xSh
ae00: 6d 4c 6f 63 6b 20 6d 65 74 68 6f 64 20 6f 6e 20  mLock method on 
ae10: 5b 73 71 6c 69 74 65 33 5f 69 6f 5f 6d 65 74 68  [sqlite3_io_meth
ae20: 6f 64 73 5d 20 6d 61 79 20 75 73 65 20 76 61 6c  ods] may use val
ae30: 75 65 73 0a 2a 2a 20 62 65 74 77 65 65 6e 20 30  ues.** between 0
ae40: 20 61 6e 64 20 74 68 69 73 20 75 70 70 65 72 20   and this upper 
ae50: 62 6f 75 6e 64 20 61 73 20 69 74 73 20 22 6f 66  bound as its "of
ae60: 66 73 65 74 22 20 61 72 67 75 6d 65 6e 74 2e 0a  fset" argument..
ae70: 2a 2a 20 54 68 65 20 53 51 4c 69 74 65 20 63 6f  ** The SQLite co
ae80: 72 65 20 77 69 6c 6c 20 6e 65 76 65 72 20 61 74  re will never at
ae90: 74 65 6d 70 74 20 74 6f 20 61 63 71 75 69 72 65  tempt to acquire
aea0: 20 6f 72 20 72 65 6c 65 61 73 65 20 61 0a 2a 2a   or release a.**
aeb0: 20 6c 6f 63 6b 20 6f 75 74 73 69 64 65 20 6f 66   lock outside of
aec0: 20 74 68 69 73 20 72 61 6e 67 65 0a 2a 2f 0a 23   this range.*/.#
aed0: 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53 48  define SQLITE_SH
aee0: 4d 5f 4e 4c 4f 43 4b 20 20 20 20 20 20 20 20 38  M_NLOCK        8
aef0: 0a 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  .../*.** CAPI3RE
af00: 46 3a 20 49 6e 69 74 69 61 6c 69 7a 65 20 54 68  F: Initialize Th
af10: 65 20 53 51 4c 69 74 65 20 4c 69 62 72 61 72 79  e SQLite Library
af20: 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69  .**.** ^The sqli
af30: 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29  te3_initialize()
af40: 20 72 6f 75 74 69 6e 65 20 69 6e 69 74 69 61 6c   routine initial
af50: 69 7a 65 73 20 74 68 65 0a 2a 2a 20 53 51 4c 69  izes the.** SQLi
af60: 74 65 20 6c 69 62 72 61 72 79 2e 20 20 5e 54 68  te library.  ^Th
af70: 65 20 73 71 6c 69 74 65 33 5f 73 68 75 74 64 6f  e sqlite3_shutdo
af80: 77 6e 28 29 20 72 6f 75 74 69 6e 65 0a 2a 2a 20  wn() routine.** 
af90: 64 65 61 6c 6c 6f 63 61 74 65 73 20 61 6e 79 20  deallocates any 
afa0: 72 65 73 6f 75 72 63 65 73 20 74 68 61 74 20 77  resources that w
afb0: 65 72 65 20 61 6c 6c 6f 63 61 74 65 64 20 62 79  ere allocated by
afc0: 20 73 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c   sqlite3_initial
afd0: 69 7a 65 28 29 2e 0a 2a 2a 20 54 68 65 73 65 20  ize()..** These 
afe0: 72 6f 75 74 69 6e 65 73 20 61 72 65 20 64 65 73  routines are des
aff0: 69 67 6e 65 64 20 74 6f 20 61 69 64 20 69 6e 20  igned to aid in 
b000: 70 72 6f 63 65 73 73 20 69 6e 69 74 69 61 6c 69  process initiali
b010: 7a 61 74 69 6f 6e 20 61 6e 64 0a 2a 2a 20 73 68  zation and.** sh
b020: 75 74 64 6f 77 6e 20 6f 6e 20 65 6d 62 65 64 64  utdown on embedd
b030: 65 64 20 73 79 73 74 65 6d 73 2e 20 20 57 6f 72  ed systems.  Wor
b040: 6b 73 74 61 74 69 6f 6e 20 61 70 70 6c 69 63 61  kstation applica
b050: 74 69 6f 6e 73 20 75 73 69 6e 67 0a 2a 2a 20 53  tions using.** S
b060: 51 4c 69 74 65 20 6e 6f 72 6d 61 6c 6c 79 20 64  QLite normally d
b070: 6f 20 6e 6f 74 20 6e 65 65 64 20 74 6f 20 69 6e  o not need to in
b080: 76 6f 6b 65 20 65 69 74 68 65 72 20 6f 66 20 74  voke either of t
b090: 68 65 73 65 20 72 6f 75 74 69 6e 65 73 2e 0a 2a  hese routines..*
b0a0: 2a 0a 2a 2a 20 41 20 63 61 6c 6c 20 74 6f 20 73  *.** A call to s
b0b0: 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a  qlite3_initializ
b0c0: 65 28 29 20 69 73 20 61 6e 20 22 65 66 66 65 63  e() is an "effec
b0d0: 74 69 76 65 22 20 63 61 6c 6c 20 69 66 20 69 74  tive" call if it
b0e0: 20 69 73 0a 2a 2a 20 74 68 65 20 66 69 72 73 74   is.** the first
b0f0: 20 74 69 6d 65 20 73 71 6c 69 74 65 33 5f 69 6e   time sqlite3_in
b100: 69 74 69 61 6c 69 7a 65 28 29 20 69 73 20 69 6e  itialize() is in
b110: 76 6f 6b 65 64 20 64 75 72 69 6e 67 20 74 68 65  voked during the
b120: 20 6c 69 66 65 74 69 6d 65 20 6f 66 0a 2a 2a 20   lifetime of.** 
b130: 74 68 65 20 70 72 6f 63 65 73 73 2c 20 6f 72 20  the process, or 
b140: 69 66 20 69 74 20 69 73 20 74 68 65 20 66 69 72  if it is the fir
b150: 73 74 20 74 69 6d 65 20 73 71 6c 69 74 65 33 5f  st time sqlite3_
b160: 69 6e 69 74 69 61 6c 69 7a 65 28 29 20 69 73 20  initialize() is 
b170: 69 6e 76 6f 6b 65 64 0a 2a 2a 20 66 6f 6c 6c 6f  invoked.** follo
b180: 77 69 6e 67 20 61 20 63 61 6c 6c 20 74 6f 20 73  wing a call to s
b190: 71 6c 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28  qlite3_shutdown(
b1a0: 29 2e 20 20 5e 28 4f 6e 6c 79 20 61 6e 20 65 66  ).  ^(Only an ef
b1b0: 66 65 63 74 69 76 65 20 63 61 6c 6c 0a 2a 2a 20  fective call.** 
b1c0: 6f 66 20 73 71 6c 69 74 65 33 5f 69 6e 69 74 69  of sqlite3_initi
b1d0: 61 6c 69 7a 65 28 29 20 64 6f 65 73 20 61 6e 79  alize() does any
b1e0: 20 69 6e 69 74 69 61 6c 69 7a 61 74 69 6f 6e 2e   initialization.
b1f0: 20 20 41 6c 6c 20 6f 74 68 65 72 20 63 61 6c 6c    All other call
b200: 73 0a 2a 2a 20 61 72 65 20 68 61 72 6d 6c 65 73  s.** are harmles
b210: 73 20 6e 6f 2d 6f 70 73 2e 29 5e 0a 2a 2a 0a 2a  s no-ops.)^.**.*
b220: 2a 20 41 20 63 61 6c 6c 20 74 6f 20 73 71 6c 69  * A call to sqli
b230: 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 20 69  te3_shutdown() i
b240: 73 20 61 6e 20 22 65 66 66 65 63 74 69 76 65 22  s an "effective"
b250: 20 63 61 6c 6c 20 69 66 20 69 74 20 69 73 20 74   call if it is t
b260: 68 65 20 66 69 72 73 74 0a 2a 2a 20 63 61 6c 6c  he first.** call
b270: 20 74 6f 20 73 71 6c 69 74 65 33 5f 73 68 75 74   to sqlite3_shut
b280: 64 6f 77 6e 28 29 20 73 69 6e 63 65 20 74 68 65  down() since the
b290: 20 6c 61 73 74 20 73 71 6c 69 74 65 33 5f 69 6e   last sqlite3_in
b2a0: 69 74 69 61 6c 69 7a 65 28 29 2e 20 20 5e 28 4f  itialize().  ^(O
b2b0: 6e 6c 79 0a 2a 2a 20 61 6e 20 65 66 66 65 63 74  nly.** an effect
b2c0: 69 76 65 20 63 61 6c 6c 20 74 6f 20 73 71 6c 69  ive call to sqli
b2d0: 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 20 64  te3_shutdown() d
b2e0: 6f 65 73 20 61 6e 79 20 64 65 69 6e 69 74 69 61  oes any deinitia
b2f0: 6c 69 7a 61 74 69 6f 6e 2e 0a 2a 2a 20 41 6c 6c  lization..** All
b300: 20 6f 74 68 65 72 20 76 61 6c 69 64 20 63 61 6c   other valid cal
b310: 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 5f 73 68  ls to sqlite3_sh
b320: 75 74 64 6f 77 6e 28 29 20 61 72 65 20 68 61 72  utdown() are har
b330: 6d 6c 65 73 73 20 6e 6f 2d 6f 70 73 2e 29 5e 0a  mless no-ops.)^.
b340: 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65  **.** The sqlite
b350: 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 20 69  3_initialize() i
b360: 6e 74 65 72 66 61 63 65 20 69 73 20 74 68 72 65  nterface is thre
b370: 61 64 73 61 66 65 2c 20 62 75 74 20 73 71 6c 69  adsafe, but sqli
b380: 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 0a 2a  te3_shutdown().*
b390: 2a 20 69 73 20 6e 6f 74 2e 20 20 54 68 65 20 73  * is not.  The s
b3a0: 71 6c 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28  qlite3_shutdown(
b3b0: 29 20 69 6e 74 65 72 66 61 63 65 20 6d 75 73 74  ) interface must
b3c0: 20 6f 6e 6c 79 20 62 65 20 63 61 6c 6c 65 64 20   only be called 
b3d0: 66 72 6f 6d 20 61 0a 2a 2a 20 73 69 6e 67 6c 65  from a.** single
b3e0: 20 74 68 72 65 61 64 2e 20 20 41 6c 6c 20 6f 70   thread.  All op
b3f0: 65 6e 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e  en [database con
b400: 6e 65 63 74 69 6f 6e 73 5d 20 6d 75 73 74 20 62  nections] must b
b410: 65 20 63 6c 6f 73 65 64 20 61 6e 64 20 61 6c 6c  e closed and all
b420: 0a 2a 2a 20 6f 74 68 65 72 20 53 51 4c 69 74 65  .** other SQLite
b430: 20 72 65 73 6f 75 72 63 65 73 20 6d 75 73 74 20   resources must 
b440: 62 65 20 64 65 61 6c 6c 6f 63 61 74 65 64 20 70  be deallocated p
b450: 72 69 6f 72 20 74 6f 20 69 6e 76 6f 6b 69 6e 67  rior to invoking
b460: 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 73 68 75 74  .** sqlite3_shut
b470: 64 6f 77 6e 28 29 2e 0a 2a 2a 0a 2a 2a 20 41 6d  down()..**.** Am
b480: 6f 6e 67 20 6f 74 68 65 72 20 74 68 69 6e 67 73  ong other things
b490: 2c 20 5e 73 71 6c 69 74 65 33 5f 69 6e 69 74 69  , ^sqlite3_initi
b4a0: 61 6c 69 7a 65 28 29 20 77 69 6c 6c 20 69 6e 76  alize() will inv
b4b0: 6f 6b 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 6f  oke.** sqlite3_o
b4c0: 73 5f 69 6e 69 74 28 29 2e 20 20 53 69 6d 69 6c  s_init().  Simil
b4d0: 61 72 6c 79 2c 20 5e 73 71 6c 69 74 65 33 5f 73  arly, ^sqlite3_s
b4e0: 68 75 74 64 6f 77 6e 28 29 0a 2a 2a 20 77 69 6c  hutdown().** wil
b4f0: 6c 20 69 6e 76 6f 6b 65 20 73 71 6c 69 74 65 33  l invoke sqlite3
b500: 5f 6f 73 5f 65 6e 64 28 29 2e 0a 2a 2a 0a 2a 2a  _os_end()..**.**
b510: 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 69 6e   ^The sqlite3_in
b520: 69 74 69 61 6c 69 7a 65 28 29 20 72 6f 75 74 69  itialize() routi
b530: 6e 65 20 72 65 74 75 72 6e 73 20 5b 53 51 4c 49  ne returns [SQLI
b540: 54 45 5f 4f 4b 5d 20 6f 6e 20 73 75 63 63 65 73  TE_OK] on succes
b550: 73 2e 0a 2a 2a 20 5e 49 66 20 66 6f 72 20 73 6f  s..** ^If for so
b560: 6d 65 20 72 65 61 73 6f 6e 2c 20 73 71 6c 69 74  me reason, sqlit
b570: 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 20  e3_initialize() 
b580: 69 73 20 75 6e 61 62 6c 65 20 74 6f 20 69 6e 69  is unable to ini
b590: 74 69 61 6c 69 7a 65 0a 2a 2a 20 74 68 65 20 6c  tialize.** the l
b5a0: 69 62 72 61 72 79 20 28 70 65 72 68 61 70 73 20  ibrary (perhaps 
b5b0: 69 74 20 69 73 20 75 6e 61 62 6c 65 20 74 6f 20  it is unable to 
b5c0: 61 6c 6c 6f 63 61 74 65 20 61 20 6e 65 65 64 65  allocate a neede
b5d0: 64 20 72 65 73 6f 75 72 63 65 20 73 75 63 68 0a  d resource such.
b5e0: 2a 2a 20 61 73 20 61 20 6d 75 74 65 78 29 20 69  ** as a mutex) i
b5f0: 74 20 72 65 74 75 72 6e 73 20 61 6e 20 5b 65 72  t returns an [er
b600: 72 6f 72 20 63 6f 64 65 5d 20 6f 74 68 65 72 20  ror code] other 
b610: 74 68 61 6e 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d  than [SQLITE_OK]
b620: 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  ..**.** ^The sql
b630: 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28  ite3_initialize(
b640: 29 20 72 6f 75 74 69 6e 65 20 69 73 20 63 61 6c  ) routine is cal
b650: 6c 65 64 20 69 6e 74 65 72 6e 61 6c 6c 79 20 62  led internally b
b660: 79 20 6d 61 6e 79 20 6f 74 68 65 72 0a 2a 2a 20  y many other.** 
b670: 53 51 4c 69 74 65 20 69 6e 74 65 72 66 61 63 65  SQLite interface
b680: 73 20 73 6f 20 74 68 61 74 20 61 6e 20 61 70 70  s so that an app
b690: 6c 69 63 61 74 69 6f 6e 20 75 73 75 61 6c 6c 79  lication usually
b6a0: 20 64 6f 65 73 20 6e 6f 74 20 6e 65 65 64 20 74   does not need t
b6b0: 6f 0a 2a 2a 20 69 6e 76 6f 6b 65 20 73 71 6c 69  o.** invoke sqli
b6c0: 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29  te3_initialize()
b6d0: 20 64 69 72 65 63 74 6c 79 2e 20 20 46 6f 72 20   directly.  For 
b6e0: 65 78 61 6d 70 6c 65 2c 20 5b 73 71 6c 69 74 65  example, [sqlite
b6f0: 33 5f 6f 70 65 6e 28 29 5d 0a 2a 2a 20 63 61 6c  3_open()].** cal
b700: 6c 73 20 73 71 6c 69 74 65 33 5f 69 6e 69 74 69  ls sqlite3_initi
b710: 61 6c 69 7a 65 28 29 20 73 6f 20 74 68 65 20 53  alize() so the S
b720: 51 4c 69 74 65 20 6c 69 62 72 61 72 79 20 77 69  QLite library wi
b730: 6c 6c 20 62 65 20 61 75 74 6f 6d 61 74 69 63 61  ll be automatica
b740: 6c 6c 79 0a 2a 2a 20 69 6e 69 74 69 61 6c 69 7a  lly.** initializ
b750: 65 64 20 77 68 65 6e 20 5b 73 71 6c 69 74 65 33  ed when [sqlite3
b760: 5f 6f 70 65 6e 28 29 5d 20 69 73 20 63 61 6c 6c  _open()] is call
b770: 65 64 20 69 66 20 69 74 20 68 61 73 20 6e 6f 74  ed if it has not
b780: 20 62 65 20 69 6e 69 74 69 61 6c 69 7a 65 64 0a   be initialized.
b790: 2a 2a 20 61 6c 72 65 61 64 79 2e 20 20 5e 48 6f  ** already.  ^Ho
b7a0: 77 65 76 65 72 2c 20 69 66 20 53 51 4c 69 74 65  wever, if SQLite
b7b0: 20 69 73 20 63 6f 6d 70 69 6c 65 64 20 77 69 74   is compiled wit
b7c0: 68 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 4f 4d  h the [SQLITE_OM
b7d0: 49 54 5f 41 55 54 4f 49 4e 49 54 5d 0a 2a 2a 20  IT_AUTOINIT].** 
b7e0: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
b7f0: 69 6f 6e 2c 20 74 68 65 6e 20 74 68 65 20 61 75  ion, then the au
b800: 74 6f 6d 61 74 69 63 20 63 61 6c 6c 73 20 74 6f  tomatic calls to
b810: 20 73 71 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c   sqlite3_initial
b820: 69 7a 65 28 29 0a 2a 2a 20 61 72 65 20 6f 6d 69  ize().** are omi
b830: 74 74 65 64 20 61 6e 64 20 74 68 65 20 61 70 70  tted and the app
b840: 6c 69 63 61 74 69 6f 6e 20 6d 75 73 74 20 63 61  lication must ca
b850: 6c 6c 20 73 71 6c 69 74 65 33 5f 69 6e 69 74 69  ll sqlite3_initi
b860: 61 6c 69 7a 65 28 29 20 64 69 72 65 63 74 6c 79  alize() directly
b870: 0a 2a 2a 20 70 72 69 6f 72 20 74 6f 20 75 73 69  .** prior to usi
b880: 6e 67 20 61 6e 79 20 6f 74 68 65 72 20 53 51 4c  ng any other SQL
b890: 69 74 65 20 69 6e 74 65 72 66 61 63 65 2e 20 20  ite interface.  
b8a0: 46 6f 72 20 6d 61 78 69 6d 75 6d 20 70 6f 72 74  For maximum port
b8b0: 61 62 69 6c 69 74 79 2c 0a 2a 2a 20 69 74 20 69  ability,.** it i
b8c0: 73 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 74 68  s recommended th
b8d0: 61 74 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20  at applications 
b8e0: 61 6c 77 61 79 73 20 69 6e 76 6f 6b 65 20 73 71  always invoke sq
b8f0: 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65  lite3_initialize
b900: 28 29 0a 2a 2a 20 64 69 72 65 63 74 6c 79 20 70  ().** directly p
b910: 72 69 6f 72 20 74 6f 20 75 73 69 6e 67 20 61 6e  rior to using an
b920: 79 20 6f 74 68 65 72 20 53 51 4c 69 74 65 20 69  y other SQLite i
b930: 6e 74 65 72 66 61 63 65 2e 20 20 46 75 74 75 72  nterface.  Futur
b940: 65 20 72 65 6c 65 61 73 65 73 0a 2a 2a 20 6f 66  e releases.** of
b950: 20 53 51 4c 69 74 65 20 6d 61 79 20 72 65 71 75   SQLite may requ
b960: 69 72 65 20 74 68 69 73 2e 20 20 49 6e 20 6f 74  ire this.  In ot
b970: 68 65 72 20 77 6f 72 64 73 2c 20 74 68 65 20 62  her words, the b
b980: 65 68 61 76 69 6f 72 20 65 78 68 69 62 69 74 65  ehavior exhibite
b990: 64 0a 2a 2a 20 77 68 65 6e 20 53 51 4c 69 74 65  d.** when SQLite
b9a0: 20 69 73 20 63 6f 6d 70 69 6c 65 64 20 77 69 74   is compiled wit
b9b0: 68 20 5b 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 41  h [SQLITE_OMIT_A
b9c0: 55 54 4f 49 4e 49 54 5d 20 6d 69 67 68 74 20 62  UTOINIT] might b
b9d0: 65 63 6f 6d 65 20 74 68 65 0a 2a 2a 20 64 65 66  ecome the.** def
b9e0: 61 75 6c 74 20 62 65 68 61 76 69 6f 72 20 69 6e  ault behavior in
b9f0: 20 73 6f 6d 65 20 66 75 74 75 72 65 20 72 65 6c   some future rel
ba00: 65 61 73 65 20 6f 66 20 53 51 4c 69 74 65 2e 0a  ease of SQLite..
ba10: 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65  **.** The sqlite
ba20: 33 5f 6f 73 5f 69 6e 69 74 28 29 20 72 6f 75 74  3_os_init() rout
ba30: 69 6e 65 20 64 6f 65 73 20 6f 70 65 72 61 74 69  ine does operati
ba40: 6e 67 2d 73 79 73 74 65 6d 20 73 70 65 63 69 66  ng-system specif
ba50: 69 63 0a 2a 2a 20 69 6e 69 74 69 61 6c 69 7a 61  ic.** initializa
ba60: 74 69 6f 6e 20 6f 66 20 74 68 65 20 53 51 4c 69  tion of the SQLi
ba70: 74 65 20 6c 69 62 72 61 72 79 2e 20 20 54 68 65  te library.  The
ba80: 20 73 71 6c 69 74 65 33 5f 6f 73 5f 65 6e 64 28   sqlite3_os_end(
ba90: 29 0a 2a 2a 20 72 6f 75 74 69 6e 65 20 75 6e 64  ).** routine und
baa0: 6f 65 73 20 74 68 65 20 65 66 66 65 63 74 20 6f  oes the effect o
bab0: 66 20 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e 69  f sqlite3_os_ini
bac0: 74 28 29 2e 20 20 54 79 70 69 63 61 6c 20 74 61  t().  Typical ta
bad0: 73 6b 73 0a 2a 2a 20 70 65 72 66 6f 72 6d 65 64  sks.** performed
bae0: 20 62 79 20 74 68 65 73 65 20 72 6f 75 74 69 6e   by these routin
baf0: 65 73 20 69 6e 63 6c 75 64 65 20 61 6c 6c 6f 63  es include alloc
bb00: 61 74 69 6f 6e 20 6f 72 20 64 65 61 6c 6c 6f 63  ation or dealloc
bb10: 61 74 69 6f 6e 0a 2a 2a 20 6f 66 20 73 74 61 74  ation.** of stat
bb20: 69 63 20 72 65 73 6f 75 72 63 65 73 2c 20 69 6e  ic resources, in
bb30: 69 74 69 61 6c 69 7a 61 74 69 6f 6e 20 6f 66 20  itialization of 
bb40: 67 6c 6f 62 61 6c 20 76 61 72 69 61 62 6c 65 73  global variables
bb50: 2c 0a 2a 2a 20 73 65 74 74 69 6e 67 20 75 70 20  ,.** setting up 
bb60: 61 20 64 65 66 61 75 6c 74 20 5b 73 71 6c 69 74  a default [sqlit
bb70: 65 33 5f 76 66 73 5d 20 6d 6f 64 75 6c 65 2c 20  e3_vfs] module, 
bb80: 6f 72 20 73 65 74 74 69 6e 67 20 75 70 0a 2a 2a  or setting up.**
bb90: 20 61 20 64 65 66 61 75 6c 74 20 63 6f 6e 66 69   a default confi
bba0: 67 75 72 61 74 69 6f 6e 20 75 73 69 6e 67 20 5b  guration using [
bbb0: 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29  sqlite3_config()
bbc0: 5d 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 61 70 70  ]..**.** The app
bbd0: 6c 69 63 61 74 69 6f 6e 20 73 68 6f 75 6c 64 20  lication should 
bbe0: 6e 65 76 65 72 20 69 6e 76 6f 6b 65 20 65 69 74  never invoke eit
bbf0: 68 65 72 20 73 71 6c 69 74 65 33 5f 6f 73 5f 69  her sqlite3_os_i
bc00: 6e 69 74 28 29 0a 2a 2a 20 6f 72 20 73 71 6c 69  nit().** or sqli
bc10: 74 65 33 5f 6f 73 5f 65 6e 64 28 29 20 64 69 72  te3_os_end() dir
bc20: 65 63 74 6c 79 2e 20 20 54 68 65 20 61 70 70 6c  ectly.  The appl
bc30: 69 63 61 74 69 6f 6e 20 73 68 6f 75 6c 64 20 6f  ication should o
bc40: 6e 6c 79 20 69 6e 76 6f 6b 65 0a 2a 2a 20 73 71  nly invoke.** sq
bc50: 6c 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65  lite3_initialize
bc60: 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 73  () and sqlite3_s
bc70: 68 75 74 64 6f 77 6e 28 29 2e 20 20 54 68 65 20  hutdown().  The 
bc80: 73 71 6c 69 74 65 33 5f 6f 73 5f 69 6e 69 74 28  sqlite3_os_init(
bc90: 29 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 69  ).** interface i
bca0: 73 20 63 61 6c 6c 65 64 20 61 75 74 6f 6d 61 74  s called automat
bcb0: 69 63 61 6c 6c 79 20 62 79 20 73 71 6c 69 74 65  ically by sqlite
bcc0: 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29 20 61  3_initialize() a
bcd0: 6e 64 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 6f 73  nd.** sqlite3_os
bce0: 5f 65 6e 64 28 29 20 69 73 20 63 61 6c 6c 65 64  _end() is called
bcf0: 20 62 79 20 73 71 6c 69 74 65 33 5f 73 68 75 74   by sqlite3_shut
bd00: 64 6f 77 6e 28 29 2e 20 20 41 70 70 72 6f 70 72  down().  Appropr
bd10: 69 61 74 65 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e  iate.** implemen
bd20: 74 61 74 69 6f 6e 73 20 66 6f 72 20 73 71 6c 69  tations for sqli
bd30: 74 65 33 5f 6f 73 5f 69 6e 69 74 28 29 20 61 6e  te3_os_init() an
bd40: 64 20 73 71 6c 69 74 65 33 5f 6f 73 5f 65 6e 64  d sqlite3_os_end
bd50: 28 29 0a 2a 2a 20 61 72 65 20 62 75 69 6c 74 20  ().** are built 
bd60: 69 6e 74 6f 20 53 51 4c 69 74 65 20 77 68 65 6e  into SQLite when
bd70: 20 69 74 20 69 73 20 63 6f 6d 70 69 6c 65 64 20   it is compiled 
bd80: 66 6f 72 20 55 6e 69 78 2c 20 57 69 6e 64 6f 77  for Unix, Window
bd90: 73 2c 20 6f 72 20 4f 53 2f 32 2e 0a 2a 2a 20 57  s, or OS/2..** W
bda0: 68 65 6e 20 5b 63 75 73 74 6f 6d 20 62 75 69 6c  hen [custom buil
bdb0: 64 73 20 7c 20 62 75 69 6c 74 20 66 6f 72 20 6f  ds | built for o
bdc0: 74 68 65 72 20 70 6c 61 74 66 6f 72 6d 73 5d 0a  ther platforms].
bdd0: 2a 2a 20 28 75 73 69 6e 67 20 74 68 65 20 5b 53  ** (using the [S
bde0: 51 4c 49 54 45 5f 4f 53 5f 4f 54 48 45 52 3d 31  QLITE_OS_OTHER=1
bdf0: 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 0a 2a  ] compile-time.*
be00: 2a 20 6f 70 74 69 6f 6e 29 20 74 68 65 20 61 70  * option) the ap
be10: 70 6c 69 63 61 74 69 6f 6e 20 6d 75 73 74 20 73  plication must s
be20: 75 70 70 6c 79 20 61 20 73 75 69 74 61 62 6c 65  upply a suitable
be30: 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20   implementation 
be40: 66 6f 72 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 6f  for.** sqlite3_o
be50: 73 5f 69 6e 69 74 28 29 20 61 6e 64 20 73 71 6c  s_init() and sql
be60: 69 74 65 33 5f 6f 73 5f 65 6e 64 28 29 2e 20 20  ite3_os_end().  
be70: 41 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d 73  An application-s
be80: 75 70 70 6c 69 65 64 0a 2a 2a 20 69 6d 70 6c 65  upplied.** imple
be90: 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20 73 71 6c  mentation of sql
bea0: 69 74 65 33 5f 6f 73 5f 69 6e 69 74 28 29 20 6f  ite3_os_init() o
beb0: 72 20 73 71 6c 69 74 65 33 5f 6f 73 5f 65 6e 64  r sqlite3_os_end
bec0: 28 29 0a 2a 2a 20 6d 75 73 74 20 72 65 74 75 72  ().** must retur
bed0: 6e 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 6f 6e  n [SQLITE_OK] on
bee0: 20 73 75 63 63 65 73 73 20 61 6e 64 20 73 6f 6d   success and som
bef0: 65 20 6f 74 68 65 72 20 5b 65 72 72 6f 72 20 63  e other [error c
bf00: 6f 64 65 5d 20 75 70 6f 6e 0a 2a 2a 20 66 61 69  ode] upon.** fai
bf10: 6c 75 72 65 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c  lure..*/.int sql
bf20: 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28  ite3_initialize(
bf30: 76 6f 69 64 29 3b 0a 69 6e 74 20 73 71 6c 69 74  void);.int sqlit
bf40: 65 33 5f 73 68 75 74 64 6f 77 6e 28 76 6f 69 64  e3_shutdown(void
bf50: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 6f  );.int sqlite3_o
bf60: 73 5f 69 6e 69 74 28 76 6f 69 64 29 3b 0a 69 6e  s_init(void);.in
bf70: 74 20 73 71 6c 69 74 65 33 5f 6f 73 5f 65 6e 64  t sqlite3_os_end
bf80: 28 76 6f 69 64 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43  (void);../*.** C
bf90: 41 50 49 33 52 45 46 3a 20 43 6f 6e 66 69 67 75  API3REF: Configu
bfa0: 72 69 6e 67 20 54 68 65 20 53 51 4c 69 74 65 20  ring The SQLite 
bfb0: 4c 69 62 72 61 72 79 0a 2a 2a 0a 2a 2a 20 54 68  Library.**.** Th
bfc0: 65 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67  e sqlite3_config
bfd0: 28 29 20 69 6e 74 65 72 66 61 63 65 20 69 73 20  () interface is 
bfe0: 75 73 65 64 20 74 6f 20 6d 61 6b 65 20 67 6c 6f  used to make glo
bff0: 62 61 6c 20 63 6f 6e 66 69 67 75 72 61 74 69 6f  bal configuratio
c000: 6e 0a 2a 2a 20 63 68 61 6e 67 65 73 20 74 6f 20  n.** changes to 
c010: 53 51 4c 69 74 65 20 69 6e 20 6f 72 64 65 72 20  SQLite in order 
c020: 74 6f 20 74 75 6e 65 20 53 51 4c 69 74 65 20 74  to tune SQLite t
c030: 6f 20 74 68 65 20 73 70 65 63 69 66 69 63 20 6e  o the specific n
c040: 65 65 64 73 20 6f 66 0a 2a 2a 20 74 68 65 20 61  eeds of.** the a
c050: 70 70 6c 69 63 61 74 69 6f 6e 2e 20 20 54 68 65  pplication.  The
c060: 20 64 65 66 61 75 6c 74 20 63 6f 6e 66 69 67 75   default configu
c070: 72 61 74 69 6f 6e 20 69 73 20 72 65 63 6f 6d 6d  ration is recomm
c080: 65 6e 64 65 64 20 66 6f 72 20 6d 6f 73 74 0a 2a  ended for most.*
c090: 2a 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 61  * applications a
c0a0: 6e 64 20 73 6f 20 74 68 69 73 20 72 6f 75 74 69  nd so this routi
c0b0: 6e 65 20 69 73 20 75 73 75 61 6c 6c 79 20 6e 6f  ne is usually no
c0c0: 74 20 6e 65 63 65 73 73 61 72 79 2e 20 20 49 74  t necessary.  It
c0d0: 20 69 73 0a 2a 2a 20 70 72 6f 76 69 64 65 64 20   is.** provided 
c0e0: 74 6f 20 73 75 70 70 6f 72 74 20 72 61 72 65 20  to support rare 
c0f0: 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 77 69 74  applications wit
c100: 68 20 75 6e 75 73 75 61 6c 20 6e 65 65 64 73 2e  h unusual needs.
c110: 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74  .**.** The sqlit
c120: 65 33 5f 63 6f 6e 66 69 67 28 29 20 69 6e 74 65  e3_config() inte
c130: 72 66 61 63 65 20 69 73 20 6e 6f 74 20 74 68 72  rface is not thr
c140: 65 61 64 73 61 66 65 2e 20 20 54 68 65 20 61 70  eadsafe.  The ap
c150: 70 6c 69 63 61 74 69 6f 6e 0a 2a 2a 20 6d 75 73  plication.** mus
c160: 74 20 69 6e 73 75 72 65 20 74 68 61 74 20 6e 6f  t insure that no
c170: 20 6f 74 68 65 72 20 53 51 4c 69 74 65 20 69 6e   other SQLite in
c180: 74 65 72 66 61 63 65 73 20 61 72 65 20 69 6e 76  terfaces are inv
c190: 6f 6b 65 64 20 62 79 20 6f 74 68 65 72 0a 2a 2a  oked by other.**
c1a0: 20 74 68 72 65 61 64 73 20 77 68 69 6c 65 20 73   threads while s
c1b0: 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 20  qlite3_config() 
c1c0: 69 73 20 72 75 6e 6e 69 6e 67 2e 20 20 46 75 72  is running.  Fur
c1d0: 74 68 65 72 6d 6f 72 65 2c 20 73 71 6c 69 74 65  thermore, sqlite
c1e0: 33 5f 63 6f 6e 66 69 67 28 29 0a 2a 2a 20 6d 61  3_config().** ma
c1f0: 79 20 6f 6e 6c 79 20 62 65 20 69 6e 76 6f 6b 65  y only be invoke
c200: 64 20 70 72 69 6f 72 20 74 6f 20 6c 69 62 72 61  d prior to libra
c210: 72 79 20 69 6e 69 74 69 61 6c 69 7a 61 74 69 6f  ry initializatio
c220: 6e 20 75 73 69 6e 67 0a 2a 2a 20 5b 73 71 6c 69  n using.** [sqli
c230: 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28 29  te3_initialize()
c240: 5d 20 6f 72 20 61 66 74 65 72 20 73 68 75 74 64  ] or after shutd
c250: 6f 77 6e 20 62 79 20 5b 73 71 6c 69 74 65 33 5f  own by [sqlite3_
c260: 73 68 75 74 64 6f 77 6e 28 29 5d 2e 0a 2a 2a 20  shutdown()]..** 
c270: 5e 49 66 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66  ^If sqlite3_conf
c280: 69 67 28 29 20 69 73 20 63 61 6c 6c 65 64 20 61  ig() is called a
c290: 66 74 65 72 20 5b 73 71 6c 69 74 65 33 5f 69 6e  fter [sqlite3_in
c2a0: 69 74 69 61 6c 69 7a 65 28 29 5d 20 61 6e 64 20  itialize()] and 
c2b0: 62 65 66 6f 72 65 0a 2a 2a 20 5b 73 71 6c 69 74  before.** [sqlit
c2c0: 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 5d 20 74  e3_shutdown()] t
c2d0: 68 65 6e 20 69 74 20 77 69 6c 6c 20 72 65 74 75  hen it will retu
c2e0: 72 6e 20 53 51 4c 49 54 45 5f 4d 49 53 55 53 45  rn SQLITE_MISUSE
c2f0: 2e 0a 2a 2a 20 4e 6f 74 65 2c 20 68 6f 77 65 76  ..** Note, howev
c300: 65 72 2c 20 74 68 61 74 20 5e 73 71 6c 69 74 65  er, that ^sqlite
c310: 33 5f 63 6f 6e 66 69 67 28 29 20 63 61 6e 20 62  3_config() can b
c320: 65 20 63 61 6c 6c 65 64 20 61 73 20 70 61 72 74  e called as part
c330: 20 6f 66 20 74 68 65 0a 2a 2a 20 69 6d 70 6c 65   of the.** imple
c340: 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20 61 6e 20  mentation of an 
c350: 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69  application-defi
c360: 6e 65 64 20 5b 73 71 6c 69 74 65 33 5f 6f 73 5f  ned [sqlite3_os_
c370: 69 6e 69 74 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 54  init()]..**.** T
c380: 68 65 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e  he first argumen
c390: 74 20 74 6f 20 73 71 6c 69 74 65 33 5f 63 6f 6e  t to sqlite3_con
c3a0: 66 69 67 28 29 20 69 73 20 61 6e 20 69 6e 74 65  fig() is an inte
c3b0: 67 65 72 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 43  ger.** [SQLITE_C
c3c0: 4f 4e 46 49 47 5f 53 49 4e 47 4c 45 54 48 52 45  ONFIG_SINGLETHRE
c3d0: 41 44 20 7c 20 63 6f 6e 66 69 67 75 72 61 74 69  AD | configurati
c3e0: 6f 6e 20 6f 70 74 69 6f 6e 5d 20 74 68 61 74 20  on option] that 
c3f0: 64 65 74 65 72 6d 69 6e 65 73 0a 2a 2a 20 77 68  determines.** wh
c400: 61 74 20 70 72 6f 70 65 72 74 79 20 6f 66 20 53  at property of S
c410: 51 4c 69 74 65 20 69 73 20 74 6f 20 62 65 20 63  QLite is to be c
c420: 6f 6e 66 69 67 75 72 65 64 2e 20 20 53 75 62 73  onfigured.  Subs
c430: 65 71 75 65 6e 74 20 61 72 67 75 6d 65 6e 74 73  equent arguments
c440: 0a 2a 2a 20 76 61 72 79 20 64 65 70 65 6e 64 69  .** vary dependi
c450: 6e 67 20 6f 6e 20 74 68 65 20 5b 53 51 4c 49 54  ng on the [SQLIT
c460: 45 5f 43 4f 4e 46 49 47 5f 53 49 4e 47 4c 45 54  E_CONFIG_SINGLET
c470: 48 52 45 41 44 20 7c 20 63 6f 6e 66 69 67 75 72  HREAD | configur
c480: 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 5d 0a 2a 2a  ation option].**
c490: 20 69 6e 20 74 68 65 20 66 69 72 73 74 20 61 72   in the first ar
c4a0: 67 75 6d 65 6e 74 2e 0a 2a 2a 0a 2a 2a 20 5e 57  gument..**.** ^W
c4b0: 68 65 6e 20 61 20 63 6f 6e 66 69 67 75 72 61 74  hen a configurat
c4c0: 69 6f 6e 20 6f 70 74 69 6f 6e 20 69 73 20 73 65  ion option is se
c4d0: 74 2c 20 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69  t, sqlite3_confi
c4e0: 67 28 29 20 72 65 74 75 72 6e 73 20 5b 53 51 4c  g() returns [SQL
c4f0: 49 54 45 5f 4f 4b 5d 2e 0a 2a 2a 20 5e 49 66 20  ITE_OK]..** ^If 
c500: 74 68 65 20 6f 70 74 69 6f 6e 20 69 73 20 75 6e  the option is un
c510: 6b 6e 6f 77 6e 20 6f 72 20 53 51 4c 69 74 65 20  known or SQLite 
c520: 69 73 20 75 6e 61 62 6c 65 20 74 6f 20 73 65 74  is unable to set
c530: 20 74 68 65 20 6f 70 74 69 6f 6e 0a 2a 2a 20 74   the option.** t
c540: 68 65 6e 20 74 68 69 73 20 72 6f 75 74 69 6e 65  hen this routine
c550: 20 72 65 74 75 72 6e 73 20 61 20 6e 6f 6e 2d 7a   returns a non-z
c560: 65 72 6f 20 5b 65 72 72 6f 72 20 63 6f 64 65 5d  ero [error code]
c570: 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  ..*/.int sqlite3
c580: 5f 63 6f 6e 66 69 67 28 69 6e 74 2c 20 2e 2e 2e  _config(int, ...
c590: 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
c5a0: 45 46 3a 20 43 6f 6e 66 69 67 75 72 65 20 64 61  EF: Configure da
c5b0: 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
c5c0: 6e 73 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c  ns.**.** The sql
c5d0: 69 74 65 33 5f 64 62 5f 63 6f 6e 66 69 67 28 29  ite3_db_config()
c5e0: 20 69 6e 74 65 72 66 61 63 65 20 69 73 20 75 73   interface is us
c5f0: 65 64 20 74 6f 20 6d 61 6b 65 20 63 6f 6e 66 69  ed to make confi
c600: 67 75 72 61 74 69 6f 6e 0a 2a 2a 20 63 68 61 6e  guration.** chan
c610: 67 65 73 20 74 6f 20 61 20 5b 64 61 74 61 62 61  ges to a [databa
c620: 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 2e 20  se connection]. 
c630: 20 54 68 65 20 69 6e 74 65 72 66 61 63 65 20 69   The interface i
c640: 73 20 73 69 6d 69 6c 61 72 20 74 6f 0a 2a 2a 20  s similar to.** 
c650: 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28  [sqlite3_config(
c660: 29 5d 20 65 78 63 65 70 74 20 74 68 61 74 20 74  )] except that t
c670: 68 65 20 63 68 61 6e 67 65 73 20 61 70 70 6c 79  he changes apply
c680: 20 74 6f 20 61 20 73 69 6e 67 6c 65 0a 2a 2a 20   to a single.** 
c690: 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63  [database connec
c6a0: 74 69 6f 6e 5d 20 28 73 70 65 63 69 66 69 65 64  tion] (specified
c6b0: 20 69 6e 20 74 68 65 20 66 69 72 73 74 20 61 72   in the first ar
c6c0: 67 75 6d 65 6e 74 29 2e 20 20 54 68 65 0a 2a 2a  gument).  The.**
c6d0: 20 73 71 6c 69 74 65 33 5f 64 62 5f 63 6f 6e 66   sqlite3_db_conf
c6e0: 69 67 28 29 20 69 6e 74 65 72 66 61 63 65 20 73  ig() interface s
c6f0: 68 6f 75 6c 64 20 6f 6e 6c 79 20 62 65 20 75 73  hould only be us
c700: 65 64 20 69 6d 6d 65 64 69 61 74 65 6c 79 20 61  ed immediately a
c710: 66 74 65 72 0a 2a 2a 20 74 68 65 20 64 61 74 61  fter.** the data
c720: 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20  base connection 
c730: 69 73 20 63 72 65 61 74 65 64 20 75 73 69 6e 67  is created using
c740: 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29   [sqlite3_open()
c750: 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6f  ],.** [sqlite3_o
c760: 70 65 6e 31 36 28 29 5d 2c 20 6f 72 20 5b 73 71  pen16()], or [sq
c770: 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 5d  lite3_open_v2()]
c780: 2e 20 20 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 65  .  .**.** The se
c790: 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20 74 6f  cond argument to
c7a0: 20 73 71 6c 69 74 65 33 5f 64 62 5f 63 6f 6e 66   sqlite3_db_conf
c7b0: 69 67 28 44 2c 56 2c 2e 2e 2e 29 20 20 69 73 20  ig(D,V,...)  is 
c7c0: 74 68 65 0a 2a 2a 20 63 6f 6e 66 69 67 75 72 61  the.** configura
c7d0: 74 69 6f 6e 20 76 65 72 62 20 2d 20 61 6e 20 69  tion verb - an i
c7e0: 6e 74 65 67 65 72 20 63 6f 64 65 20 74 68 61 74  nteger code that
c7f0: 20 69 6e 64 69 63 61 74 65 73 20 77 68 61 74 0a   indicates what.
c800: 2a 2a 20 61 73 70 65 63 74 20 6f 66 20 74 68 65  ** aspect of the
c810: 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65   [database conne
c820: 63 74 69 6f 6e 5d 20 69 73 20 62 65 69 6e 67 20  ction] is being 
c830: 63 6f 6e 66 69 67 75 72 65 64 2e 0a 2a 2a 20 54  configured..** T
c840: 68 65 20 6f 6e 6c 79 20 63 68 6f 69 63 65 20 66  he only choice f
c850: 6f 72 20 74 68 69 73 20 76 61 6c 75 65 20 69 73  or this value is
c860: 20 5b 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46 49   [SQLITE_DBCONFI
c870: 47 5f 4c 4f 4f 4b 41 53 49 44 45 5d 2e 0a 2a 2a  G_LOOKASIDE]..**
c880: 20 4e 65 77 20 76 65 72 62 73 20 61 72 65 20 6c   New verbs are l
c890: 69 6b 65 6c 79 20 74 6f 20 62 65 20 61 64 64 65  ikely to be adde
c8a0: 64 20 69 6e 20 66 75 74 75 72 65 20 72 65 6c 65  d in future rele
c8b0: 61 73 65 73 20 6f 66 20 53 51 4c 69 74 65 2e 0a  ases of SQLite..
c8c0: 2a 2a 20 41 64 64 69 74 69 6f 6e 61 6c 20 61 72  ** Additional ar
c8d0: 67 75 6d 65 6e 74 73 20 64 65 70 65 6e 64 20 6f  guments depend o
c8e0: 6e 20 74 68 65 20 76 65 72 62 2e 0a 2a 2a 0a 2a  n the verb..**.*
c8f0: 2a 20 5e 43 61 6c 6c 73 20 74 6f 20 73 71 6c 69  * ^Calls to sqli
c900: 74 65 33 5f 64 62 5f 63 6f 6e 66 69 67 28 29 20  te3_db_config() 
c910: 72 65 74 75 72 6e 20 53 51 4c 49 54 45 5f 4f 4b  return SQLITE_OK
c920: 20 69 66 20 61 6e 64 20 6f 6e 6c 79 20 69 66 0a   if and only if.
c930: 2a 2a 20 74 68 65 20 63 61 6c 6c 20 69 73 20 63  ** the call is c
c940: 6f 6e 73 69 64 65 72 65 64 20 73 75 63 63 65 73  onsidered succes
c950: 73 66 75 6c 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c  sful..*/.int sql
c960: 69 74 65 33 5f 64 62 5f 63 6f 6e 66 69 67 28 73  ite3_db_config(s
c970: 71 6c 69 74 65 33 2a 2c 20 69 6e 74 20 6f 70 2c  qlite3*, int op,
c980: 20 2e 2e 2e 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41   ...);../*.** CA
c990: 50 49 33 52 45 46 3a 20 4d 65 6d 6f 72 79 20 41  PI3REF: Memory A
c9a0: 6c 6c 6f 63 61 74 69 6f 6e 20 52 6f 75 74 69 6e  llocation Routin
c9b0: 65 73 0a 2a 2a 0a 2a 2a 20 41 6e 20 69 6e 73 74  es.**.** An inst
c9c0: 61 6e 63 65 20 6f 66 20 74 68 69 73 20 6f 62 6a  ance of this obj
c9d0: 65 63 74 20 64 65 66 69 6e 65 73 20 74 68 65 20  ect defines the 
c9e0: 69 6e 74 65 72 66 61 63 65 20 62 65 74 77 65 65  interface betwee
c9f0: 6e 20 53 51 4c 69 74 65 0a 2a 2a 20 61 6e 64 20  n SQLite.** and 
ca00: 6c 6f 77 2d 6c 65 76 65 6c 20 6d 65 6d 6f 72 79  low-level memory
ca10: 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 72 6f 75 74   allocation rout
ca20: 69 6e 65 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 73  ines..**.** This
ca30: 20 6f 62 6a 65 63 74 20 69 73 20 75 73 65 64 20   object is used 
ca40: 69 6e 20 6f 6e 6c 79 20 6f 6e 65 20 70 6c 61 63  in only one plac
ca50: 65 20 69 6e 20 74 68 65 20 53 51 4c 69 74 65 20  e in the SQLite 
ca60: 69 6e 74 65 72 66 61 63 65 2e 0a 2a 2a 20 41 20  interface..** A 
ca70: 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e 20 69 6e  pointer to an in
ca80: 73 74 61 6e 63 65 20 6f 66 20 74 68 69 73 20 6f  stance of this o
ca90: 62 6a 65 63 74 20 69 73 20 74 68 65 20 61 72 67  bject is the arg
caa0: 75 6d 65 6e 74 20 74 6f 0a 2a 2a 20 5b 73 71 6c  ument to.** [sql
cab0: 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d 20 77  ite3_config()] w
cac0: 68 65 6e 20 74 68 65 20 63 6f 6e 66 69 67 75 72  hen the configur
cad0: 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 20 69 73 0a  ation option is.
cae0: 2a 2a 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49  ** [SQLITE_CONFI
caf0: 47 5f 4d 41 4c 4c 4f 43 5d 20 6f 72 20 5b 53 51  G_MALLOC] or [SQ
cb00: 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 4d  LITE_CONFIG_GETM
cb10: 41 4c 4c 4f 43 5d 2e 20 20 0a 2a 2a 20 42 79 20  ALLOC].  .** By 
cb20: 63 72 65 61 74 69 6e 67 20 61 6e 20 69 6e 73 74  creating an inst
cb30: 61 6e 63 65 20 6f 66 20 74 68 69 73 20 6f 62 6a  ance of this obj
cb40: 65 63 74 0a 2a 2a 20 61 6e 64 20 70 61 73 73 69  ect.** and passi
cb50: 6e 67 20 69 74 20 74 6f 20 5b 73 71 6c 69 74 65  ng it to [sqlite
cb60: 33 5f 63 6f 6e 66 69 67 5d 28 5b 53 51 4c 49 54  3_config]([SQLIT
cb70: 45 5f 43 4f 4e 46 49 47 5f 4d 41 4c 4c 4f 43 5d  E_CONFIG_MALLOC]
cb80: 29 0a 2a 2a 20 64 75 72 69 6e 67 20 63 6f 6e 66  ).** during conf
cb90: 69 67 75 72 61 74 69 6f 6e 2c 20 61 6e 20 61 70  iguration, an ap
cba0: 70 6c 69 63 61 74 69 6f 6e 20 63 61 6e 20 73 70  plication can sp
cbb0: 65 63 69 66 79 20 61 6e 20 61 6c 74 65 72 6e 61  ecify an alterna
cbc0: 74 69 76 65 0a 2a 2a 20 6d 65 6d 6f 72 79 20 61  tive.** memory a
cbd0: 6c 6c 6f 63 61 74 69 6f 6e 20 73 75 62 73 79 73  llocation subsys
cbe0: 74 65 6d 20 66 6f 72 20 53 51 4c 69 74 65 20 74  tem for SQLite t
cbf0: 6f 20 75 73 65 20 66 6f 72 20 61 6c 6c 20 6f 66  o use for all of
cc00: 20 69 74 73 0a 2a 2a 20 64 79 6e 61 6d 69 63 20   its.** dynamic 
cc10: 6d 65 6d 6f 72 79 20 6e 65 65 64 73 2e 0a 2a 2a  memory needs..**
cc20: 0a 2a 2a 20 4e 6f 74 65 20 74 68 61 74 20 53 51  .** Note that SQ
cc30: 4c 69 74 65 20 63 6f 6d 65 73 20 77 69 74 68 20  Lite comes with 
cc40: 73 65 76 65 72 61 6c 20 5b 62 75 69 6c 74 2d 69  several [built-i
cc50: 6e 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  n memory allocat
cc60: 6f 72 73 5d 0a 2a 2a 20 74 68 61 74 20 61 72 65  ors].** that are
cc70: 20 70 65 72 66 65 63 74 6c 79 20 61 64 65 71 75   perfectly adequ
cc80: 61 74 65 20 66 6f 72 20 74 68 65 20 6f 76 65 72  ate for the over
cc90: 77 68 65 6c 6d 69 6e 67 20 6d 61 6a 6f 72 69 74  whelming majorit
cca0: 79 20 6f 66 20 61 70 70 6c 69 63 61 74 69 6f 6e  y of application
ccb0: 73 0a 2a 2a 20 61 6e 64 20 74 68 61 74 20 74 68  s.** and that th
ccc0: 69 73 20 6f 62 6a 65 63 74 20 69 73 20 6f 6e 6c  is object is onl
ccd0: 79 20 75 73 65 66 75 6c 20 74 6f 20 61 20 74 69  y useful to a ti
cce0: 6e 79 20 6d 69 6e 6f 72 69 74 79 20 6f 66 20 61  ny minority of a
ccf0: 70 70 6c 69 63 61 74 69 6f 6e 73 0a 2a 2a 20 77  pplications.** w
cd00: 69 74 68 20 73 70 65 63 69 61 6c 69 7a 65 64 20  ith specialized 
cd10: 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f  memory allocatio
cd20: 6e 20 72 65 71 75 69 72 65 6d 65 6e 74 73 2e 20  n requirements. 
cd30: 20 54 68 69 73 20 6f 62 6a 65 63 74 20 69 73 0a   This object is.
cd40: 2a 2a 20 61 6c 73 6f 20 75 73 65 64 20 64 75 72  ** also used dur
cd50: 69 6e 67 20 74 65 73 74 69 6e 67 20 6f 66 20 53  ing testing of S
cd60: 51 4c 69 74 65 20 69 6e 20 6f 72 64 65 72 20 74  QLite in order t
cd70: 6f 20 73 70 65 63 69 66 79 20 61 6e 20 61 6c 74  o specify an alt
cd80: 65 72 6e 61 74 69 76 65 0a 2a 2a 20 6d 65 6d 6f  ernative.** memo
cd90: 72 79 20 61 6c 6c 6f 63 61 74 6f 72 20 74 68 61  ry allocator tha
cda0: 74 20 73 69 6d 75 6c 61 74 65 73 20 6d 65 6d 6f  t simulates memo
cdb0: 72 79 20 6f 75 74 2d 6f 66 2d 6d 65 6d 6f 72 79  ry out-of-memory
cdc0: 20 63 6f 6e 64 69 74 69 6f 6e 73 20 69 6e 0a 2a   conditions in.*
cdd0: 2a 20 6f 72 64 65 72 20 74 6f 20 76 65 72 69 66  * order to verif
cde0: 79 20 74 68 61 74 20 53 51 4c 69 74 65 20 72 65  y that SQLite re
cdf0: 63 6f 76 65 72 73 20 67 72 61 63 65 66 75 6c 6c  covers gracefull
ce00: 79 20 66 72 6f 6d 20 73 75 63 68 0a 2a 2a 20 63  y from such.** c
ce10: 6f 6e 64 69 74 69 6f 6e 73 2e 0a 2a 2a 0a 2a 2a  onditions..**.**
ce20: 20 54 68 65 20 78 4d 61 6c 6c 6f 63 20 61 6e 64   The xMalloc and
ce30: 20 78 46 72 65 65 20 6d 65 74 68 6f 64 73 20 6d   xFree methods m
ce40: 75 73 74 20 77 6f 72 6b 20 6c 69 6b 65 20 74 68  ust work like th
ce50: 65 0a 2a 2a 20 6d 61 6c 6c 6f 63 28 29 20 61 6e  e.** malloc() an
ce60: 64 20 66 72 65 65 28 29 20 66 75 6e 63 74 69 6f  d free() functio
ce70: 6e 73 20 66 72 6f 6d 20 74 68 65 20 73 74 61 6e  ns from the stan
ce80: 64 61 72 64 20 43 20 6c 69 62 72 61 72 79 2e 0a  dard C library..
ce90: 2a 2a 20 54 68 65 20 78 52 65 61 6c 6c 6f 63 20  ** The xRealloc 
cea0: 6d 65 74 68 6f 64 20 6d 75 73 74 20 77 6f 72 6b  method must work
ceb0: 20 6c 69 6b 65 20 72 65 61 6c 6c 6f 63 28 29 20   like realloc() 
cec0: 66 72 6f 6d 20 74 68 65 20 73 74 61 6e 64 61 72  from the standar
ced0: 64 20 43 20 6c 69 62 72 61 72 79 0a 2a 2a 20 77  d C library.** w
cee0: 69 74 68 20 74 68 65 20 65 78 63 65 70 74 69 6f  ith the exceptio
cef0: 6e 20 74 68 61 74 20 69 66 20 74 68 65 20 73 65  n that if the se
cf00: 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20 74 6f  cond argument to
cf10: 20 78 52 65 61 6c 6c 6f 63 20 69 73 20 7a 65 72   xRealloc is zer
cf20: 6f 2c 0a 2a 2a 20 78 52 65 61 6c 6c 6f 63 20 6d  o,.** xRealloc m
cf30: 75 73 74 20 62 65 20 61 20 6e 6f 2d 6f 70 20 2d  ust be a no-op -
cf40: 20 69 74 20 6d 75 73 74 20 6e 6f 74 20 70 65 72   it must not per
cf50: 66 6f 72 6d 20 61 6e 79 20 61 6c 6c 6f 63 61 74  form any allocat
cf60: 69 6f 6e 20 6f 72 0a 2a 2a 20 64 65 61 6c 6c 6f  ion or.** deallo
cf70: 63 61 74 69 6f 6e 2e 20 20 5e 53 51 4c 69 74 65  cation.  ^SQLite
cf80: 20 67 75 61 72 61 6e 74 65 65 73 20 74 68 61 74   guarantees that
cf90: 20 74 68 65 20 73 65 63 6f 6e 64 20 61 72 67 75   the second argu
cfa0: 6d 65 6e 74 20 74 6f 0a 2a 2a 20 78 52 65 61 6c  ment to.** xReal
cfb0: 6c 6f 63 20 69 73 20 61 6c 77 61 79 73 20 61 20  loc is always a 
cfc0: 76 61 6c 75 65 20 72 65 74 75 72 6e 65 64 20 62  value returned b
cfd0: 79 20 61 20 70 72 69 6f 72 20 63 61 6c 6c 20 74  y a prior call t
cfe0: 6f 20 78 52 6f 75 6e 64 75 70 2e 0a 2a 2a 20 41  o xRoundup..** A
cff0: 6e 64 20 73 6f 20 69 6e 20 63 61 73 65 73 20 77  nd so in cases w
d000: 68 65 72 65 20 78 52 6f 75 6e 64 75 70 20 61 6c  here xRoundup al
d010: 77 61 79 73 20 72 65 74 75 72 6e 73 20 61 20 70  ways returns a p
d020: 6f 73 69 74 69 76 65 20 6e 75 6d 62 65 72 2c 0a  ositive number,.
d030: 2a 2a 20 78 52 65 61 6c 6c 6f 63 20 63 61 6e 20  ** xRealloc can 
d040: 70 65 72 66 6f 72 6d 20 65 78 61 63 74 6c 79 20  perform exactly 
d050: 61 73 20 74 68 65 20 73 74 61 6e 64 61 72 64 20  as the standard 
d060: 6c 69 62 72 61 72 79 20 72 65 61 6c 6c 6f 63 28  library realloc(
d070: 29 20 61 6e 64 0a 2a 2a 20 73 74 69 6c 6c 20 62  ) and.** still b
d080: 65 20 69 6e 20 63 6f 6d 70 6c 69 61 6e 63 65 20  e in compliance 
d090: 77 69 74 68 20 74 68 69 73 20 73 70 65 63 69 66  with this specif
d0a0: 69 63 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 78  ication..**.** x
d0b0: 53 69 7a 65 20 73 68 6f 75 6c 64 20 72 65 74 75  Size should retu
d0c0: 72 6e 20 74 68 65 20 61 6c 6c 6f 63 61 74 65 64  rn the allocated
d0d0: 20 73 69 7a 65 20 6f 66 20 61 20 6d 65 6d 6f 72   size of a memor
d0e0: 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 0a 2a 2a 20  y allocation.** 
d0f0: 70 72 65 76 69 6f 75 73 6c 79 20 6f 62 74 61 69  previously obtai
d100: 6e 65 64 20 66 72 6f 6d 20 78 4d 61 6c 6c 6f 63  ned from xMalloc
d110: 20 6f 72 20 78 52 65 61 6c 6c 6f 63 2e 20 20 54   or xRealloc.  T
d120: 68 65 20 61 6c 6c 6f 63 61 74 65 64 20 73 69 7a  he allocated siz
d130: 65 0a 2a 2a 20 69 73 20 61 6c 77 61 79 73 20 61  e.** is always a
d140: 74 20 6c 65 61 73 74 20 61 73 20 62 69 67 20 61  t least as big a
d150: 73 20 74 68 65 20 72 65 71 75 65 73 74 65 64 20  s the requested 
d160: 73 69 7a 65 20 62 75 74 20 6d 61 79 20 62 65 20  size but may be 
d170: 6c 61 72 67 65 72 2e 0a 2a 2a 0a 2a 2a 20 54 68  larger..**.** Th
d180: 65 20 78 52 6f 75 6e 64 75 70 20 6d 65 74 68 6f  e xRoundup metho
d190: 64 20 72 65 74 75 72 6e 73 20 77 68 61 74 20 77  d returns what w
d1a0: 6f 75 6c 64 20 62 65 20 74 68 65 20 61 6c 6c 6f  ould be the allo
d1b0: 63 61 74 65 64 20 73 69 7a 65 20 6f 66 0a 2a 2a  cated size of.**
d1c0: 20 61 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61   a memory alloca
d1d0: 74 69 6f 6e 20 67 69 76 65 6e 20 61 20 70 61 72  tion given a par
d1e0: 74 69 63 75 6c 61 72 20 72 65 71 75 65 73 74 65  ticular requeste
d1f0: 64 20 73 69 7a 65 2e 20 20 4d 6f 73 74 20 6d 65  d size.  Most me
d200: 6d 6f 72 79 0a 2a 2a 20 61 6c 6c 6f 63 61 74 6f  mory.** allocato
d210: 72 73 20 72 6f 75 6e 64 20 75 70 20 6d 65 6d 6f  rs round up memo
d220: 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 73 20 61  ry allocations a
d230: 74 20 6c 65 61 73 74 20 74 6f 20 74 68 65 20 6e  t least to the n
d240: 65 78 74 20 6d 75 6c 74 69 70 6c 65 0a 2a 2a 20  ext multiple.** 
d250: 6f 66 20 38 2e 20 20 53 6f 6d 65 20 61 6c 6c 6f  of 8.  Some allo
d260: 63 61 74 6f 72 73 20 72 6f 75 6e 64 20 75 70 20  cators round up 
d270: 74 6f 20 61 20 6c 61 72 67 65 72 20 6d 75 6c 74  to a larger mult
d280: 69 70 6c 65 20 6f 72 20 74 6f 20 61 20 70 6f 77  iple or to a pow
d290: 65 72 20 6f 66 20 32 2e 0a 2a 2a 20 45 76 65 72  er of 2..** Ever
d2a0: 79 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  y memory allocat
d2b0: 69 6f 6e 20 72 65 71 75 65 73 74 20 63 6f 6d 69  ion request comi
d2c0: 6e 67 20 69 6e 20 74 68 72 6f 75 67 68 20 5b 73  ng in through [s
d2d0: 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d  qlite3_malloc()]
d2e0: 0a 2a 2a 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f  .** or [sqlite3_
d2f0: 72 65 61 6c 6c 6f 63 28 29 5d 20 66 69 72 73 74  realloc()] first
d300: 20 63 61 6c 6c 73 20 78 52 6f 75 6e 64 75 70 2e   calls xRoundup.
d310: 20 20 49 66 20 78 52 6f 75 6e 64 75 70 20 72 65    If xRoundup re
d320: 74 75 72 6e 73 20 30 2c 20 0a 2a 2a 20 74 68 61  turns 0, .** tha
d330: 74 20 63 61 75 73 65 73 20 74 68 65 20 63 6f 72  t causes the cor
d340: 72 65 73 70 6f 6e 64 69 6e 67 20 6d 65 6d 6f 72  responding memor
d350: 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 74 6f 20  y allocation to 
d360: 66 61 69 6c 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  fail..**.** The 
d370: 78 49 6e 69 74 20 6d 65 74 68 6f 64 20 69 6e 69  xInit method ini
d380: 74 69 61 6c 69 7a 65 73 20 74 68 65 20 6d 65 6d  tializes the mem
d390: 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72 2e 20 20  ory allocator.  
d3a0: 28 46 6f 72 20 65 78 61 6d 70 6c 65 2c 0a 2a 2a  (For example,.**
d3b0: 20 69 74 20 6d 69 67 68 74 20 61 6c 6c 6f 63 61   it might alloca
d3c0: 74 65 20 61 6e 79 20 72 65 71 75 69 72 65 20 6d  te any require m
d3d0: 75 74 65 78 65 73 20 6f 72 20 69 6e 69 74 69 61  utexes or initia
d3e0: 6c 69 7a 65 20 69 6e 74 65 72 6e 61 6c 20 64 61  lize internal da
d3f0: 74 61 0a 2a 2a 20 73 74 72 75 63 74 75 72 65 73  ta.** structures
d400: 2e 20 20 54 68 65 20 78 53 68 75 74 64 6f 77 6e  .  The xShutdown
d410: 20 6d 65 74 68 6f 64 20 69 73 20 69 6e 76 6f 6b   method is invok
d420: 65 64 20 28 69 6e 64 69 72 65 63 74 6c 79 29 20  ed (indirectly) 
d430: 62 79 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 73  by.** [sqlite3_s
d440: 68 75 74 64 6f 77 6e 28 29 5d 20 61 6e 64 20 73  hutdown()] and s
d450: 68 6f 75 6c 64 20 64 65 61 6c 6c 6f 63 61 74 65  hould deallocate
d460: 20 61 6e 79 20 72 65 73 6f 75 72 63 65 73 20 61   any resources a
d470: 63 71 75 69 72 65 64 0a 2a 2a 20 62 79 20 78 49  cquired.** by xI
d480: 6e 69 74 2e 20 20 54 68 65 20 70 41 70 70 44 61  nit.  The pAppDa
d490: 74 61 20 70 6f 69 6e 74 65 72 20 69 73 20 75 73  ta pointer is us
d4a0: 65 64 20 61 73 20 74 68 65 20 6f 6e 6c 79 20 70  ed as the only p
d4b0: 61 72 61 6d 65 74 65 72 20 74 6f 0a 2a 2a 20 78  arameter to.** x
d4c0: 49 6e 69 74 20 61 6e 64 20 78 53 68 75 74 64 6f  Init and xShutdo
d4d0: 77 6e 2e 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74 65  wn..**.** SQLite
d4e0: 20 68 6f 6c 64 73 20 74 68 65 20 5b 53 51 4c 49   holds the [SQLI
d4f0: 54 45 5f 4d 55 54 45 58 5f 53 54 41 54 49 43 5f  TE_MUTEX_STATIC_
d500: 4d 41 53 54 45 52 5d 20 6d 75 74 65 78 20 77 68  MASTER] mutex wh
d510: 65 6e 20 69 74 20 69 6e 76 6f 6b 65 73 0a 2a 2a  en it invokes.**
d520: 20 74 68 65 20 78 49 6e 69 74 20 6d 65 74 68 6f   the xInit metho
d530: 64 2c 20 73 6f 20 74 68 65 20 78 49 6e 69 74 20  d, so the xInit 
d540: 6d 65 74 68 6f 64 20 6e 65 65 64 20 6e 6f 74 20  method need not 
d550: 62 65 20 74 68 72 65 61 64 73 61 66 65 2e 20 20  be threadsafe.  
d560: 54 68 65 0a 2a 2a 20 78 53 68 75 74 64 6f 77 6e  The.** xShutdown
d570: 20 6d 65 74 68 6f 64 20 69 73 20 6f 6e 6c 79 20   method is only 
d580: 63 61 6c 6c 65 64 20 66 72 6f 6d 20 5b 73 71 6c  called from [sql
d590: 69 74 65 33 5f 73 68 75 74 64 6f 77 6e 28 29 5d  ite3_shutdown()]
d5a0: 20 73 6f 20 69 74 20 64 6f 65 73 0a 2a 2a 20 6e   so it does.** n
d5b0: 6f 74 20 6e 65 65 64 20 74 6f 20 62 65 20 74 68  ot need to be th
d5c0: 72 65 61 64 73 61 66 65 20 65 69 74 68 65 72 2e  readsafe either.
d5d0: 20 20 46 6f 72 20 61 6c 6c 20 6f 74 68 65 72 20    For all other 
d5e0: 6d 65 74 68 6f 64 73 2c 20 53 51 4c 69 74 65 0a  methods, SQLite.
d5f0: 2a 2a 20 68 6f 6c 64 73 20 74 68 65 20 5b 53 51  ** holds the [SQ
d600: 4c 49 54 45 5f 4d 55 54 45 58 5f 53 54 41 54 49  LITE_MUTEX_STATI
d610: 43 5f 4d 45 4d 5d 20 6d 75 74 65 78 20 61 73 20  C_MEM] mutex as 
d620: 6c 6f 6e 67 20 61 73 20 74 68 65 0a 2a 2a 20 5b  long as the.** [
d630: 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 45  SQLITE_CONFIG_ME
d640: 4d 53 54 41 54 55 53 5d 20 63 6f 6e 66 69 67 75  MSTATUS] configu
d650: 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 20 69 73  ration option is
d660: 20 74 75 72 6e 65 64 20 6f 6e 20 28 77 68 69 63   turned on (whic
d670: 68 0a 2a 2a 20 69 74 20 69 73 20 62 79 20 64 65  h.** it is by de
d680: 66 61 75 6c 74 29 20 61 6e 64 20 73 6f 20 74 68  fault) and so th
d690: 65 20 6d 65 74 68 6f 64 73 20 61 72 65 20 61 75  e methods are au
d6a0: 74 6f 6d 61 74 69 63 61 6c 6c 79 20 73 65 72 69  tomatically seri
d6b0: 61 6c 69 7a 65 64 2e 0a 2a 2a 20 48 6f 77 65 76  alized..** Howev
d6c0: 65 72 2c 20 69 66 20 5b 53 51 4c 49 54 45 5f 43  er, if [SQLITE_C
d6d0: 4f 4e 46 49 47 5f 4d 45 4d 53 54 41 54 55 53 5d  ONFIG_MEMSTATUS]
d6e0: 20 69 73 20 64 69 73 61 62 6c 65 64 2c 20 74 68   is disabled, th
d6f0: 65 6e 20 74 68 65 20 6f 74 68 65 72 0a 2a 2a 20  en the other.** 
d700: 6d 65 74 68 6f 64 73 20 6d 75 73 74 20 62 65 20  methods must be 
d710: 74 68 72 65 61 64 73 61 66 65 20 6f 72 20 65 6c  threadsafe or el
d720: 73 65 20 6d 61 6b 65 20 74 68 65 69 72 20 6f 77  se make their ow
d730: 6e 20 61 72 72 61 6e 67 65 6d 65 6e 74 73 20 66  n arrangements f
d740: 6f 72 0a 2a 2a 20 73 65 72 69 61 6c 69 7a 61 74  or.** serializat
d750: 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74  ion..**.** SQLit
d760: 65 20 77 69 6c 6c 20 6e 65 76 65 72 20 69 6e 76  e will never inv
d770: 6f 6b 65 20 78 49 6e 69 74 28 29 20 6d 6f 72 65  oke xInit() more
d780: 20 74 68 61 6e 20 6f 6e 63 65 20 77 69 74 68 6f   than once witho
d790: 75 74 20 61 6e 20 69 6e 74 65 72 76 65 6e 69 6e  ut an intervenin
d7a0: 67 0a 2a 2a 20 63 61 6c 6c 20 74 6f 20 78 53 68  g.** call to xSh
d7b0: 75 74 64 6f 77 6e 28 29 2e 0a 2a 2f 0a 74 79 70  utdown()..*/.typ
d7c0: 65 64 65 66 20 73 74 72 75 63 74 20 73 71 6c 69  edef struct sqli
d7d0: 74 65 33 5f 6d 65 6d 5f 6d 65 74 68 6f 64 73 20  te3_mem_methods 
d7e0: 73 71 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65 74 68  sqlite3_mem_meth
d7f0: 6f 64 73 3b 0a 73 74 72 75 63 74 20 73 71 6c 69  ods;.struct sqli
d800: 74 65 33 5f 6d 65 6d 5f 6d 65 74 68 6f 64 73 20  te3_mem_methods 
d810: 7b 0a 20 20 76 6f 69 64 20 2a 28 2a 78 4d 61 6c  {.  void *(*xMal
d820: 6c 6f 63 29 28 69 6e 74 29 3b 20 20 20 20 20 20  loc)(int);      
d830: 20 20 20 2f 2a 20 4d 65 6d 6f 72 79 20 61 6c 6c     /* Memory all
d840: 6f 63 61 74 69 6f 6e 20 66 75 6e 63 74 69 6f 6e  ocation function
d850: 20 2a 2f 0a 20 20 76 6f 69 64 20 28 2a 78 46 72   */.  void (*xFr
d860: 65 65 29 28 76 6f 69 64 2a 29 3b 20 20 20 20 20  ee)(void*);     
d870: 20 20 20 20 20 2f 2a 20 46 72 65 65 20 61 20 70       /* Free a p
d880: 72 69 6f 72 20 61 6c 6c 6f 63 61 74 69 6f 6e 20  rior allocation 
d890: 2a 2f 0a 20 20 76 6f 69 64 20 2a 28 2a 78 52 65  */.  void *(*xRe
d8a0: 61 6c 6c 6f 63 29 28 76 6f 69 64 2a 2c 69 6e 74  alloc)(void*,int
d8b0: 29 3b 20 20 2f 2a 20 52 65 73 69 7a 65 20 61 6e  );  /* Resize an
d8c0: 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 2a 2f 0a 20   allocation */. 
d8d0: 20 69 6e 74 20 28 2a 78 53 69 7a 65 29 28 76 6f   int (*xSize)(vo
d8e0: 69 64 2a 29 3b 20 20 20 20 20 20 20 20 20 20 20  id*);           
d8f0: 2f 2a 20 52 65 74 75 72 6e 20 74 68 65 20 73 69  /* Return the si
d900: 7a 65 20 6f 66 20 61 6e 20 61 6c 6c 6f 63 61 74  ze of an allocat
d910: 69 6f 6e 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78  ion */.  int (*x
d920: 52 6f 75 6e 64 75 70 29 28 69 6e 74 29 3b 20 20  Roundup)(int);  
d930: 20 20 20 20 20 20 20 20 2f 2a 20 52 6f 75 6e 64          /* Round
d940: 20 75 70 20 72 65 71 75 65 73 74 20 73 69 7a 65   up request size
d950: 20 74 6f 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 73   to allocation s
d960: 69 7a 65 20 2a 2f 0a 20 20 69 6e 74 20 28 2a 78  ize */.  int (*x
d970: 49 6e 69 74 29 28 76 6f 69 64 2a 29 3b 20 20 20  Init)(void*);   
d980: 20 20 20 20 20 20 20 20 2f 2a 20 49 6e 69 74 69          /* Initi
d990: 61 6c 69 7a 65 20 74 68 65 20 6d 65 6d 6f 72 79  alize the memory
d9a0: 20 61 6c 6c 6f 63 61 74 6f 72 20 2a 2f 0a 20 20   allocator */.  
d9b0: 76 6f 69 64 20 28 2a 78 53 68 75 74 64 6f 77 6e  void (*xShutdown
d9c0: 29 28 76 6f 69 64 2a 29 3b 20 20 20 20 20 20 2f  )(void*);      /
d9d0: 2a 20 44 65 69 6e 69 74 69 61 6c 69 7a 65 20 74  * Deinitialize t
d9e0: 68 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61  he memory alloca
d9f0: 74 6f 72 20 2a 2f 0a 20 20 76 6f 69 64 20 2a 70  tor */.  void *p
da00: 41 70 70 44 61 74 61 3b 20 20 20 20 20 20 20 20  AppData;        
da10: 20 20 20 20 20 20 20 20 2f 2a 20 41 72 67 75 6d          /* Argum
da20: 65 6e 74 20 74 6f 20 78 49 6e 69 74 28 29 20 61  ent to xInit() a
da30: 6e 64 20 78 53 68 75 74 64 6f 77 6e 28 29 20 2a  nd xShutdown() *
da40: 2f 0a 7d 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  /.};../*.** CAPI
da50: 33 52 45 46 3a 20 43 6f 6e 66 69 67 75 72 61 74  3REF: Configurat
da60: 69 6f 6e 20 4f 70 74 69 6f 6e 73 0a 2a 2a 0a 2a  ion Options.**.*
da70: 2a 20 54 68 65 73 65 20 63 6f 6e 73 74 61 6e 74  * These constant
da80: 73 20 61 72 65 20 74 68 65 20 61 76 61 69 6c 61  s are the availa
da90: 62 6c 65 20 69 6e 74 65 67 65 72 20 63 6f 6e 66  ble integer conf
daa0: 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e  iguration option
dab0: 73 20 74 68 61 74 0a 2a 2a 20 63 61 6e 20 62 65  s that.** can be
dac0: 20 70 61 73 73 65 64 20 61 73 20 74 68 65 20 66   passed as the f
dad0: 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f  irst argument to
dae0: 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 63 6f   the [sqlite3_co
daf0: 6e 66 69 67 28 29 5d 20 69 6e 74 65 72 66 61 63  nfig()] interfac
db00: 65 2e 0a 2a 2a 0a 2a 2a 20 4e 65 77 20 63 6f 6e  e..**.** New con
db10: 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f  figuration optio
db20: 6e 73 20 6d 61 79 20 62 65 20 61 64 64 65 64 20  ns may be added 
db30: 69 6e 20 66 75 74 75 72 65 20 72 65 6c 65 61 73  in future releas
db40: 65 73 20 6f 66 20 53 51 4c 69 74 65 2e 0a 2a 2a  es of SQLite..**
db50: 20 45 78 69 73 74 69 6e 67 20 63 6f 6e 66 69 67   Existing config
db60: 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 73 20  uration options 
db70: 6d 69 67 68 74 20 62 65 20 64 69 73 63 6f 6e 74  might be discont
db80: 69 6e 75 65 64 2e 20 20 41 70 70 6c 69 63 61 74  inued.  Applicat
db90: 69 6f 6e 73 0a 2a 2a 20 73 68 6f 75 6c 64 20 63  ions.** should c
dba0: 68 65 63 6b 20 74 68 65 20 72 65 74 75 72 6e 20  heck the return 
dbb0: 63 6f 64 65 20 66 72 6f 6d 20 5b 73 71 6c 69 74  code from [sqlit
dbc0: 65 33 5f 63 6f 6e 66 69 67 28 29 5d 20 74 6f 20  e3_config()] to 
dbd0: 6d 61 6b 65 20 73 75 72 65 20 74 68 61 74 0a 2a  make sure that.*
dbe0: 2a 20 74 68 65 20 63 61 6c 6c 20 77 6f 72 6b 65  * the call worke
dbf0: 64 2e 20 20 54 68 65 20 5b 73 71 6c 69 74 65 33  d.  The [sqlite3
dc00: 5f 63 6f 6e 66 69 67 28 29 5d 20 69 6e 74 65 72  _config()] inter
dc10: 66 61 63 65 20 77 69 6c 6c 20 72 65 74 75 72 6e  face will return
dc20: 20 61 0a 2a 2a 20 6e 6f 6e 2d 7a 65 72 6f 20 5b   a.** non-zero [
dc30: 65 72 72 6f 72 20 63 6f 64 65 5d 20 69 66 20 61  error code] if a
dc40: 20 64 69 73 63 6f 6e 74 69 6e 75 65 64 20 6f 72   discontinued or
dc50: 20 75 6e 73 75 70 70 6f 72 74 65 64 20 63 6f 6e   unsupported con
dc60: 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f  figuration optio
dc70: 6e 0a 2a 2a 20 69 73 20 69 6e 76 6f 6b 65 64 2e  n.** is invoked.
dc80: 0a 2a 2a 0a 2a 2a 20 3c 64 6c 3e 0a 2a 2a 20 3c  .**.** <dl>.** <
dc90: 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47  dt>SQLITE_CONFIG
dca0: 5f 53 49 4e 47 4c 45 54 48 52 45 41 44 3c 2f 64  _SINGLETHREAD</d
dcb0: 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 72 65 20  t>.** <dd>There 
dcc0: 61 72 65 20 6e 6f 20 61 72 67 75 6d 65 6e 74 73  are no arguments
dcd0: 20 74 6f 20 74 68 69 73 20 6f 70 74 69 6f 6e 2e   to this option.
dce0: 20 20 5e 54 68 69 73 20 6f 70 74 69 6f 6e 20 73    ^This option s
dcf0: 65 74 73 20 74 68 65 0a 2a 2a 20 5b 74 68 72 65  ets the.** [thre
dd00: 61 64 69 6e 67 20 6d 6f 64 65 5d 20 74 6f 20 53  ading mode] to S
dd10: 69 6e 67 6c 65 2d 74 68 72 65 61 64 2e 20 20 49  ingle-thread.  I
dd20: 6e 20 6f 74 68 65 72 20 77 6f 72 64 73 2c 20 69  n other words, i
dd30: 74 20 64 69 73 61 62 6c 65 73 0a 2a 2a 20 61 6c  t disables.** al
dd40: 6c 20 6d 75 74 65 78 69 6e 67 20 61 6e 64 20 70  l mutexing and p
dd50: 75 74 73 20 53 51 4c 69 74 65 20 69 6e 74 6f 20  uts SQLite into 
dd60: 61 20 6d 6f 64 65 20 77 68 65 72 65 20 69 74 20  a mode where it 
dd70: 63 61 6e 20 6f 6e 6c 79 20 62 65 20 75 73 65 64  can only be used
dd80: 0a 2a 2a 20 62 79 20 61 20 73 69 6e 67 6c 65 20  .** by a single 
dd90: 74 68 72 65 61 64 2e 20 20 20 5e 49 66 20 53 51  thread.   ^If SQ
dda0: 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c 65 64  Lite is compiled
ddb0: 20 77 69 74 68 0a 2a 2a 20 74 68 65 20 5b 53 51   with.** the [SQ
ddc0: 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45 20  LITE_THREADSAFE 
ddd0: 7c 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53  | SQLITE_THREADS
dde0: 41 46 45 3d 30 5d 20 63 6f 6d 70 69 6c 65 2d 74  AFE=0] compile-t
ddf0: 69 6d 65 20 6f 70 74 69 6f 6e 20 74 68 65 6e 0a  ime option then.
de00: 2a 2a 20 69 74 20 69 73 20 6e 6f 74 20 70 6f 73  ** it is not pos
de10: 73 69 62 6c 65 20 74 6f 20 63 68 61 6e 67 65 20  sible to change 
de20: 74 68 65 20 5b 74 68 72 65 61 64 69 6e 67 20 6d  the [threading m
de30: 6f 64 65 5d 20 66 72 6f 6d 20 69 74 73 20 64 65  ode] from its de
de40: 66 61 75 6c 74 0a 2a 2a 20 76 61 6c 75 65 20 6f  fault.** value o
de50: 66 20 53 69 6e 67 6c 65 2d 74 68 72 65 61 64 20  f Single-thread 
de60: 61 6e 64 20 73 6f 20 5b 73 71 6c 69 74 65 33 5f  and so [sqlite3_
de70: 63 6f 6e 66 69 67 28 29 5d 20 77 69 6c 6c 20 72  config()] will r
de80: 65 74 75 72 6e 20 0a 2a 2a 20 5b 53 51 4c 49 54  eturn .** [SQLIT
de90: 45 5f 45 52 52 4f 52 5d 20 69 66 20 63 61 6c 6c  E_ERROR] if call
dea0: 65 64 20 77 69 74 68 20 74 68 65 20 53 51 4c 49  ed with the SQLI
deb0: 54 45 5f 43 4f 4e 46 49 47 5f 53 49 4e 47 4c 45  TE_CONFIG_SINGLE
dec0: 54 48 52 45 41 44 0a 2a 2a 20 63 6f 6e 66 69 67  THREAD.** config
ded0: 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 2e 3c  uration option.<
dee0: 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 64 74 3e 53  /dd>.**.** <dt>S
def0: 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 55 4c  QLITE_CONFIG_MUL
df00: 54 49 54 48 52 45 41 44 3c 2f 64 74 3e 0a 2a 2a  TITHREAD</dt>.**
df10: 20 3c 64 64 3e 54 68 65 72 65 20 61 72 65 20 6e   <dd>There are n
df20: 6f 20 61 72 67 75 6d 65 6e 74 73 20 74 6f 20 74  o arguments to t
df30: 68 69 73 20 6f 70 74 69 6f 6e 2e 20 20 5e 54 68  his option.  ^Th
df40: 69 73 20 6f 70 74 69 6f 6e 20 73 65 74 73 20 74  is option sets t
df50: 68 65 0a 2a 2a 20 5b 74 68 72 65 61 64 69 6e 67  he.** [threading
df60: 20 6d 6f 64 65 5d 20 74 6f 20 4d 75 6c 74 69 2d   mode] to Multi-
df70: 74 68 72 65 61 64 2e 20 20 49 6e 20 6f 74 68 65  thread.  In othe
df80: 72 20 77 6f 72 64 73 2c 20 69 74 20 64 69 73 61  r words, it disa
df90: 62 6c 65 73 0a 2a 2a 20 6d 75 74 65 78 69 6e 67  bles.** mutexing
dfa0: 20 6f 6e 20 5b 64 61 74 61 62 61 73 65 20 63 6f   on [database co
dfb0: 6e 6e 65 63 74 69 6f 6e 5d 20 61 6e 64 20 5b 70  nnection] and [p
dfc0: 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e  repared statemen
dfd0: 74 5d 20 6f 62 6a 65 63 74 73 2e 0a 2a 2a 20 54  t] objects..** T
dfe0: 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 69  he application i
dff0: 73 20 72 65 73 70 6f 6e 73 69 62 6c 65 20 66 6f  s responsible fo
e000: 72 20 73 65 72 69 61 6c 69 7a 69 6e 67 20 61 63  r serializing ac
e010: 63 65 73 73 20 74 6f 0a 2a 2a 20 5b 64 61 74 61  cess to.** [data
e020: 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73  base connections
e030: 5d 20 61 6e 64 20 5b 70 72 65 70 61 72 65 64 20  ] and [prepared 
e040: 73 74 61 74 65 6d 65 6e 74 73 5d 2e 20 20 42 75  statements].  Bu
e050: 74 20 6f 74 68 65 72 20 6d 75 74 65 78 65 73 0a  t other mutexes.
e060: 2a 2a 20 61 72 65 20 65 6e 61 62 6c 65 64 20 73  ** are enabled s
e070: 6f 20 74 68 61 74 20 53 51 4c 69 74 65 20 77 69  o that SQLite wi
e080: 6c 6c 20 62 65 20 73 61 66 65 20 74 6f 20 75 73  ll be safe to us
e090: 65 20 69 6e 20 61 20 6d 75 6c 74 69 2d 74 68 72  e in a multi-thr
e0a0: 65 61 64 65 64 0a 2a 2a 20 65 6e 76 69 72 6f 6e  eaded.** environ
e0b0: 6d 65 6e 74 20 61 73 20 6c 6f 6e 67 20 61 73 20  ment as long as 
e0c0: 6e 6f 20 74 77 6f 20 74 68 72 65 61 64 73 20 61  no two threads a
e0d0: 74 74 65 6d 70 74 20 74 6f 20 75 73 65 20 74 68  ttempt to use th
e0e0: 65 20 73 61 6d 65 0a 2a 2a 20 5b 64 61 74 61 62  e same.** [datab
e0f0: 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20  ase connection] 
e100: 61 74 20 74 68 65 20 73 61 6d 65 20 74 69 6d 65  at the same time
e110: 2e 20 20 5e 49 66 20 53 51 4c 69 74 65 20 69 73  .  ^If SQLite is
e120: 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 0a 2a   compiled with.*
e130: 2a 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 54 48  * the [SQLITE_TH
e140: 52 45 41 44 53 41 46 45 20 7c 20 53 51 4c 49 54  READSAFE | SQLIT
e150: 45 5f 54 48 52 45 41 44 53 41 46 45 3d 30 5d 20  E_THREADSAFE=0] 
e160: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
e170: 69 6f 6e 20 74 68 65 6e 0a 2a 2a 20 69 74 20 69  ion then.** it i
e180: 73 20 6e 6f 74 20 70 6f 73 73 69 62 6c 65 20 74  s not possible t
e190: 6f 20 73 65 74 20 74 68 65 20 4d 75 6c 74 69 2d  o set the Multi-
e1a0: 74 68 72 65 61 64 20 5b 74 68 72 65 61 64 69 6e  thread [threadin
e1b0: 67 20 6d 6f 64 65 5d 20 61 6e 64 0a 2a 2a 20 5b  g mode] and.** [
e1c0: 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29  sqlite3_config()
e1d0: 5d 20 77 69 6c 6c 20 72 65 74 75 72 6e 20 5b 53  ] will return [S
e1e0: 51 4c 49 54 45 5f 45 52 52 4f 52 5d 20 69 66 20  QLITE_ERROR] if 
e1f0: 63 61 6c 6c 65 64 20 77 69 74 68 20 74 68 65 0a  called with the.
e200: 2a 2a 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47  ** SQLITE_CONFIG
e210: 5f 4d 55 4c 54 49 54 48 52 45 41 44 20 63 6f 6e  _MULTITHREAD con
e220: 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f  figuration optio
e230: 6e 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 64  n.</dd>.**.** <d
e240: 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  t>SQLITE_CONFIG_
e250: 53 45 52 49 41 4c 49 5a 45 44 3c 2f 64 74 3e 0a  SERIALIZED</dt>.
e260: 2a 2a 20 3c 64 64 3e 54 68 65 72 65 20 61 72 65  ** <dd>There are
e270: 20 6e 6f 20 61 72 67 75 6d 65 6e 74 73 20 74 6f   no arguments to
e280: 20 74 68 69 73 20 6f 70 74 69 6f 6e 2e 20 20 5e   this option.  ^
e290: 54 68 69 73 20 6f 70 74 69 6f 6e 20 73 65 74 73  This option sets
e2a0: 20 74 68 65 0a 2a 2a 20 5b 74 68 72 65 61 64 69   the.** [threadi
e2b0: 6e 67 20 6d 6f 64 65 5d 20 74 6f 20 53 65 72 69  ng mode] to Seri
e2c0: 61 6c 69 7a 65 64 2e 20 49 6e 20 6f 74 68 65 72  alized. In other
e2d0: 20 77 6f 72 64 73 2c 20 74 68 69 73 20 6f 70 74   words, this opt
e2e0: 69 6f 6e 20 65 6e 61 62 6c 65 73 0a 2a 2a 20 61  ion enables.** a
e2f0: 6c 6c 20 6d 75 74 65 78 65 73 20 69 6e 63 6c 75  ll mutexes inclu
e300: 64 69 6e 67 20 74 68 65 20 72 65 63 75 72 73 69  ding the recursi
e310: 76 65 0a 2a 2a 20 6d 75 74 65 78 65 73 20 6f 6e  ve.** mutexes on
e320: 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65   [database conne
e330: 63 74 69 6f 6e 5d 20 61 6e 64 20 5b 70 72 65 70  ction] and [prep
e340: 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20  ared statement] 
e350: 6f 62 6a 65 63 74 73 2e 0a 2a 2a 20 49 6e 20 74  objects..** In t
e360: 68 69 73 20 6d 6f 64 65 20 28 77 68 69 63 68 20  his mode (which 
e370: 69 73 20 74 68 65 20 64 65 66 61 75 6c 74 20 77  is the default w
e380: 68 65 6e 20 53 51 4c 69 74 65 20 69 73 20 63 6f  hen SQLite is co
e390: 6d 70 69 6c 65 64 20 77 69 74 68 0a 2a 2a 20 5b  mpiled with.** [
e3a0: 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46  SQLITE_THREADSAF
e3b0: 45 3d 31 5d 29 20 74 68 65 20 53 51 4c 69 74 65  E=1]) the SQLite
e3c0: 20 6c 69 62 72 61 72 79 20 77 69 6c 6c 20 69 74   library will it
e3d0: 73 65 6c 66 20 73 65 72 69 61 6c 69 7a 65 20 61  self serialize a
e3e0: 63 63 65 73 73 0a 2a 2a 20 74 6f 20 5b 64 61 74  ccess.** to [dat
e3f0: 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
e400: 73 5d 20 61 6e 64 20 5b 70 72 65 70 61 72 65 64  s] and [prepared
e410: 20 73 74 61 74 65 6d 65 6e 74 73 5d 20 73 6f 20   statements] so 
e420: 74 68 61 74 20 74 68 65 0a 2a 2a 20 61 70 70 6c  that the.** appl
e430: 69 63 61 74 69 6f 6e 20 69 73 20 66 72 65 65 20  ication is free 
e440: 74 6f 20 75 73 65 20 74 68 65 20 73 61 6d 65 20  to use the same 
e450: 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63  [database connec
e460: 74 69 6f 6e 5d 20 6f 72 20 74 68 65 0a 2a 2a 20  tion] or the.** 
e470: 73 61 6d 65 20 5b 70 72 65 70 61 72 65 64 20 73  same [prepared s
e480: 74 61 74 65 6d 65 6e 74 5d 20 69 6e 20 64 69 66  tatement] in dif
e490: 66 65 72 65 6e 74 20 74 68 72 65 61 64 73 20 61  ferent threads a
e4a0: 74 20 74 68 65 20 73 61 6d 65 20 74 69 6d 65 2e  t the same time.
e4b0: 0a 2a 2a 20 5e 49 66 20 53 51 4c 69 74 65 20 69  .** ^If SQLite i
e4c0: 73 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 0a  s compiled with.
e4d0: 2a 2a 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 54  ** the [SQLITE_T
e4e0: 48 52 45 41 44 53 41 46 45 20 7c 20 53 51 4c 49  HREADSAFE | SQLI
e4f0: 54 45 5f 54 48 52 45 41 44 53 41 46 45 3d 30 5d  TE_THREADSAFE=0]
e500: 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70   compile-time op
e510: 74 69 6f 6e 20 74 68 65 6e 0a 2a 2a 20 69 74 20  tion then.** it 
e520: 69 73 20 6e 6f 74 20 70 6f 73 73 69 62 6c 65 20  is not possible 
e530: 74 6f 20 73 65 74 20 74 68 65 20 53 65 72 69 61  to set the Seria
e540: 6c 69 7a 65 64 20 5b 74 68 72 65 61 64 69 6e 67  lized [threading
e550: 20 6d 6f 64 65 5d 20 61 6e 64 0a 2a 2a 20 5b 73   mode] and.** [s
e560: 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29 5d  qlite3_config()]
e570: 20 77 69 6c 6c 20 72 65 74 75 72 6e 20 5b 53 51   will return [SQ
e580: 4c 49 54 45 5f 45 52 52 4f 52 5d 20 69 66 20 63  LITE_ERROR] if c
e590: 61 6c 6c 65 64 20 77 69 74 68 20 74 68 65 0a 2a  alled with the.*
e5a0: 2a 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  * SQLITE_CONFIG_
e5b0: 53 45 52 49 41 4c 49 5a 45 44 20 63 6f 6e 66 69  SERIALIZED confi
e5c0: 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 2e  guration option.
e5d0: 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 64 74 3e  </dd>.**.** <dt>
e5e0: 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 41  SQLITE_CONFIG_MA
e5f0: 4c 4c 4f 43 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64  LLOC</dt>.** <dd
e600: 3e 20 5e 28 54 68 69 73 20 6f 70 74 69 6f 6e 20  > ^(This option 
e610: 74 61 6b 65 73 20 61 20 73 69 6e 67 6c 65 20 61  takes a single a
e620: 72 67 75 6d 65 6e 74 20 77 68 69 63 68 20 69 73  rgument which is
e630: 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 6e   a pointer to an
e640: 0a 2a 2a 20 69 6e 73 74 61 6e 63 65 20 6f 66 20  .** instance of 
e650: 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d  the [sqlite3_mem
e660: 5f 6d 65 74 68 6f 64 73 5d 20 73 74 72 75 63 74  _methods] struct
e670: 75 72 65 2e 20 20 54 68 65 20 61 72 67 75 6d 65  ure.  The argume
e680: 6e 74 20 73 70 65 63 69 66 69 65 73 0a 2a 2a 20  nt specifies.** 
e690: 61 6c 74 65 72 6e 61 74 69 76 65 20 6c 6f 77 2d  alternative low-
e6a0: 6c 65 76 65 6c 20 6d 65 6d 6f 72 79 20 61 6c 6c  level memory all
e6b0: 6f 63 61 74 69 6f 6e 20 72 6f 75 74 69 6e 65 73  ocation routines
e6c0: 20 74 6f 20 62 65 20 75 73 65 64 20 69 6e 20 70   to be used in p
e6d0: 6c 61 63 65 20 6f 66 0a 2a 2a 20 74 68 65 20 6d  lace of.** the m
e6e0: 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e  emory allocation
e6f0: 20 72 6f 75 74 69 6e 65 73 20 62 75 69 6c 74 20   routines built 
e700: 69 6e 74 6f 20 53 51 4c 69 74 65 2e 29 5e 20 5e  into SQLite.)^ ^
e710: 53 51 4c 69 74 65 20 6d 61 6b 65 73 0a 2a 2a 20  SQLite makes.** 
e720: 69 74 73 20 6f 77 6e 20 70 72 69 76 61 74 65 20  its own private 
e730: 63 6f 70 79 20 6f 66 20 74 68 65 20 63 6f 6e 74  copy of the cont
e740: 65 6e 74 20 6f 66 20 74 68 65 20 5b 73 71 6c 69  ent of the [sqli
e750: 74 65 33 5f 6d 65 6d 5f 6d 65 74 68 6f 64 73 5d  te3_mem_methods]
e760: 20 73 74 72 75 63 74 75 72 65 0a 2a 2a 20 62 65   structure.** be
e770: 66 6f 72 65 20 74 68 65 20 5b 73 71 6c 69 74 65  fore the [sqlite
e780: 33 5f 63 6f 6e 66 69 67 28 29 5d 20 63 61 6c 6c  3_config()] call
e790: 20 72 65 74 75 72 6e 73 2e 3c 2f 64 64 3e 0a 2a   returns.</dd>.*
e7a0: 2a 0a 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f  *.** <dt>SQLITE_
e7b0: 43 4f 4e 46 49 47 5f 47 45 54 4d 41 4c 4c 4f 43  CONFIG_GETMALLOC
e7c0: 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 28  </dt>.** <dd> ^(
e7d0: 54 68 69 73 20 6f 70 74 69 6f 6e 20 74 61 6b 65  This option take
e7e0: 73 20 61 20 73 69 6e 67 6c 65 20 61 72 67 75 6d  s a single argum
e7f0: 65 6e 74 20 77 68 69 63 68 20 69 73 20 61 20 70  ent which is a p
e800: 6f 69 6e 74 65 72 20 74 6f 20 61 6e 0a 2a 2a 20  ointer to an.** 
e810: 69 6e 73 74 61 6e 63 65 20 6f 66 20 74 68 65 20  instance of the 
e820: 5b 73 71 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65 74  [sqlite3_mem_met
e830: 68 6f 64 73 5d 20 73 74 72 75 63 74 75 72 65 2e  hods] structure.
e840: 20 20 54 68 65 20 5b 73 71 6c 69 74 65 33 5f 6d    The [sqlite3_m
e850: 65 6d 5f 6d 65 74 68 6f 64 73 5d 0a 2a 2a 20 73  em_methods].** s
e860: 74 72 75 63 74 75 72 65 20 69 73 20 66 69 6c 6c  tructure is fill
e870: 65 64 20 77 69 74 68 20 74 68 65 20 63 75 72 72  ed with the curr
e880: 65 6e 74 6c 79 20 64 65 66 69 6e 65 64 20 6d 65  ently defined me
e890: 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20  mory allocation 
e8a0: 72 6f 75 74 69 6e 65 73 2e 29 5e 0a 2a 2a 20 54  routines.)^.** T
e8b0: 68 69 73 20 6f 70 74 69 6f 6e 20 63 61 6e 20 62  his option can b
e8c0: 65 20 75 73 65 64 20 74 6f 20 6f 76 65 72 6c 6f  e used to overlo
e8d0: 61 64 20 74 68 65 20 64 65 66 61 75 6c 74 20 6d  ad the default m
e8e0: 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e  emory allocation
e8f0: 0a 2a 2a 20 72 6f 75 74 69 6e 65 73 20 77 69 74  .** routines wit
e900: 68 20 61 20 77 72 61 70 70 65 72 20 74 68 61 74  h a wrapper that
e910: 20 73 69 6d 75 6c 61 74 69 6f 6e 73 20 6d 65 6d   simulations mem
e920: 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 66  ory allocation f
e930: 61 69 6c 75 72 65 20 6f 72 0a 2a 2a 20 74 72 61  ailure or.** tra
e940: 63 6b 73 20 6d 65 6d 6f 72 79 20 75 73 61 67 65  cks memory usage
e950: 2c 20 66 6f 72 20 65 78 61 6d 70 6c 65 2e 20 3c  , for example. <
e960: 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 64 74 3e 53  /dd>.**.** <dt>S
e970: 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 45 4d  QLITE_CONFIG_MEM
e980: 53 54 41 54 55 53 3c 2f 64 74 3e 0a 2a 2a 20 3c  STATUS</dt>.** <
e990: 64 64 3e 20 5e 54 68 69 73 20 6f 70 74 69 6f 6e  dd> ^This option
e9a0: 20 74 61 6b 65 73 20 73 69 6e 67 6c 65 20 61 72   takes single ar
e9b0: 67 75 6d 65 6e 74 20 6f 66 20 74 79 70 65 20 69  gument of type i
e9c0: 6e 74 2c 20 69 6e 74 65 72 70 72 65 74 65 64 20  nt, interpreted 
e9d0: 61 73 20 61 20 0a 2a 2a 20 62 6f 6f 6c 65 61 6e  as a .** boolean
e9e0: 2c 20 77 68 69 63 68 20 65 6e 61 62 6c 65 73 20  , which enables 
e9f0: 6f 72 20 64 69 73 61 62 6c 65 73 20 74 68 65 20  or disables the 
ea00: 63 6f 6c 6c 65 63 74 69 6f 6e 20 6f 66 20 6d 65  collection of me
ea10: 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20  mory allocation 
ea20: 0a 2a 2a 20 73 74 61 74 69 73 74 69 63 73 2e 20  .** statistics. 
ea30: 5e 28 57 68 65 6e 20 6d 65 6d 6f 72 79 20 61 6c  ^(When memory al
ea40: 6c 6f 63 61 74 69 6f 6e 20 73 74 61 74 69 73 74  location statist
ea50: 69 63 73 20 61 72 65 20 64 69 73 61 62 6c 65 64  ics are disabled
ea60: 2c 20 74 68 65 20 0a 2a 2a 20 66 6f 6c 6c 6f 77  , the .** follow
ea70: 69 6e 67 20 53 51 4c 69 74 65 20 69 6e 74 65 72  ing SQLite inter
ea80: 66 61 63 65 73 20 62 65 63 6f 6d 65 20 6e 6f 6e  faces become non
ea90: 2d 6f 70 65 72 61 74 69 6f 6e 61 6c 3a 0a 2a 2a  -operational:.**
eaa0: 20 20 20 3c 75 6c 3e 0a 2a 2a 20 20 20 3c 6c 69     <ul>.**   <li
eab0: 3e 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d 6f 72  > [sqlite3_memor
eac0: 79 5f 75 73 65 64 28 29 5d 0a 2a 2a 20 20 20 3c  y_used()].**   <
ead0: 6c 69 3e 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d  li> [sqlite3_mem
eae0: 6f 72 79 5f 68 69 67 68 77 61 74 65 72 28 29 5d  ory_highwater()]
eaf0: 0a 2a 2a 20 20 20 3c 6c 69 3e 20 5b 73 71 6c 69  .**   <li> [sqli
eb00: 74 65 33 5f 73 6f 66 74 5f 68 65 61 70 5f 6c 69  te3_soft_heap_li
eb10: 6d 69 74 36 34 28 29 5d 0a 2a 2a 20 20 20 3c 6c  mit64()].**   <l
eb20: 69 3e 20 5b 73 71 6c 69 74 65 33 5f 73 74 61 74  i> [sqlite3_stat
eb30: 75 73 28 29 5d 0a 2a 2a 20 20 20 3c 2f 75 6c 3e  us()].**   </ul>
eb40: 29 5e 0a 2a 2a 20 5e 4d 65 6d 6f 72 79 20 61 6c  )^.** ^Memory al
eb50: 6c 6f 63 61 74 69 6f 6e 20 73 74 61 74 69 73 74  location statist
eb60: 69 63 73 20 61 72 65 20 65 6e 61 62 6c 65 64 20  ics are enabled 
eb70: 62 79 20 64 65 66 61 75 6c 74 20 75 6e 6c 65 73  by default unles
eb80: 73 20 53 51 4c 69 74 65 20 69 73 0a 2a 2a 20 63  s SQLite is.** c
eb90: 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 5b 53 51  ompiled with [SQ
eba0: 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f 4d 45 4d  LITE_DEFAULT_MEM
ebb0: 53 54 41 54 55 53 5d 3d 30 20 69 6e 20 77 68 69  STATUS]=0 in whi
ebc0: 63 68 20 63 61 73 65 20 6d 65 6d 6f 72 79 0a 2a  ch case memory.*
ebd0: 2a 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 73 74 61  * allocation sta
ebe0: 74 69 73 74 69 63 73 20 61 72 65 20 64 69 73 61  tistics are disa
ebf0: 62 6c 65 64 20 62 79 20 64 65 66 61 75 6c 74 2e  bled by default.
ec00: 0a 2a 2a 20 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20  .** </dd>.**.** 
ec10: 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49  <dt>SQLITE_CONFI
ec20: 47 5f 53 43 52 41 54 43 48 3c 2f 64 74 3e 0a 2a  G_SCRATCH</dt>.*
ec30: 2a 20 3c 64 64 3e 20 5e 54 68 69 73 20 6f 70 74  * <dd> ^This opt
ec40: 69 6f 6e 20 73 70 65 63 69 66 69 65 73 20 61 20  ion specifies a 
ec50: 73 74 61 74 69 63 20 6d 65 6d 6f 72 79 20 62 75  static memory bu
ec60: 66 66 65 72 20 74 68 61 74 20 53 51 4c 69 74 65  ffer that SQLite
ec70: 20 63 61 6e 20 75 73 65 20 66 6f 72 0a 2a 2a 20   can use for.** 
ec80: 73 63 72 61 74 63 68 20 6d 65 6d 6f 72 79 2e 20  scratch memory. 
ec90: 20 54 68 65 72 65 20 61 72 65 20 74 68 72 65 65   There are three
eca0: 20 61 72 67 75 6d 65 6e 74 73 3a 20 20 41 20 70   arguments:  A p
ecb0: 6f 69 6e 74 65 72 20 61 6e 20 38 2d 62 79 74 65  ointer an 8-byte
ecc0: 0a 2a 2a 20 61 6c 69 67 6e 65 64 20 6d 65 6d 6f  .** aligned memo
ecd0: 72 79 20 62 75 66 66 65 72 20 66 72 6f 6d 20 77  ry buffer from w
ece0: 68 69 63 68 20 74 68 65 20 73 63 72 61 63 68 20  hich the scrach 
ecf0: 61 6c 6c 6f 63 61 74 69 6f 6e 73 20 77 69 6c 6c  allocations will
ed00: 20 62 65 0a 2a 2a 20 64 72 61 77 6e 2c 20 74 68   be.** drawn, th
ed10: 65 20 73 69 7a 65 20 6f 66 20 65 61 63 68 20 73  e size of each s
ed20: 63 72 61 74 63 68 20 61 6c 6c 6f 63 61 74 69 6f  cratch allocatio
ed30: 6e 20 28 73 7a 29 2c 0a 2a 2a 20 61 6e 64 20 74  n (sz),.** and t
ed40: 68 65 20 6d 61 78 69 6d 75 6d 20 6e 75 6d 62 65  he maximum numbe
ed50: 72 20 6f 66 20 73 63 72 61 74 63 68 20 61 6c 6c  r of scratch all
ed60: 6f 63 61 74 69 6f 6e 73 20 28 4e 29 2e 20 20 54  ocations (N).  T
ed70: 68 65 20 73 7a 0a 2a 2a 20 61 72 67 75 6d 65 6e  he sz.** argumen
ed80: 74 20 6d 75 73 74 20 62 65 20 61 20 6d 75 6c 74  t must be a mult
ed90: 69 70 6c 65 20 6f 66 20 31 36 2e 0a 2a 2a 20 54  iple of 16..** T
eda0: 68 65 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e  he first argumen
edb0: 74 20 6d 75 73 74 20 62 65 20 61 20 70 6f 69 6e  t must be a poin
edc0: 74 65 72 20 74 6f 20 61 6e 20 38 2d 62 79 74 65  ter to an 8-byte
edd0: 20 61 6c 69 67 6e 65 64 20 62 75 66 66 65 72 0a   aligned buffer.
ede0: 2a 2a 20 6f 66 20 61 74 20 6c 65 61 73 74 20 73  ** of at least s
edf0: 7a 2a 4e 20 62 79 74 65 73 20 6f 66 20 6d 65 6d  z*N bytes of mem
ee00: 6f 72 79 2e 0a 2a 2a 20 5e 53 51 4c 69 74 65 20  ory..** ^SQLite 
ee10: 77 69 6c 6c 20 75 73 65 20 6e 6f 20 6d 6f 72 65  will use no more
ee20: 20 74 68 61 6e 20 74 77 6f 20 73 63 72 61 74 63   than two scratc
ee30: 68 20 62 75 66 66 65 72 73 20 70 65 72 20 74 68  h buffers per th
ee40: 72 65 61 64 2e 20 20 53 6f 0a 2a 2a 20 4e 20 73  read.  So.** N s
ee50: 68 6f 75 6c 64 20 62 65 20 73 65 74 20 74 6f 20  hould be set to 
ee60: 74 77 69 63 65 20 74 68 65 20 65 78 70 65 63 74  twice the expect
ee70: 65 64 20 6d 61 78 69 6d 75 6d 20 6e 75 6d 62 65  ed maximum numbe
ee80: 72 20 6f 66 20 74 68 72 65 61 64 73 2e 0a 2a 2a  r of threads..**
ee90: 20 5e 53 51 4c 69 74 65 20 77 69 6c 6c 20 6e 65   ^SQLite will ne
eea0: 76 65 72 20 72 65 71 75 69 72 65 20 61 20 73 63  ver require a sc
eeb0: 72 61 74 63 68 20 62 75 66 66 65 72 20 74 68 61  ratch buffer tha
eec0: 74 20 69 73 20 6d 6f 72 65 20 74 68 61 6e 20 36  t is more than 6
eed0: 0a 2a 2a 20 74 69 6d 65 73 20 74 68 65 20 64 61  .** times the da
eee0: 74 61 62 61 73 65 20 70 61 67 65 20 73 69 7a 65  tabase page size
eef0: 2e 20 5e 49 66 20 53 51 4c 69 74 65 20 6e 65 65  . ^If SQLite nee
ef00: 64 73 20 6e 65 65 64 73 20 61 64 64 69 74 69 6f  ds needs additio
ef10: 6e 61 6c 0a 2a 2a 20 73 63 72 61 74 63 68 20 6d  nal.** scratch m
ef20: 65 6d 6f 72 79 20 62 65 79 6f 6e 64 20 77 68 61  emory beyond wha
ef30: 74 20 69 73 20 70 72 6f 76 69 64 65 64 20 62 79  t is provided by
ef40: 20 74 68 69 73 20 63 6f 6e 66 69 67 75 72 61 74   this configurat
ef50: 69 6f 6e 20 6f 70 74 69 6f 6e 2c 20 74 68 65 6e  ion option, then
ef60: 20 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6d 61   .** [sqlite3_ma
ef70: 6c 6c 6f 63 28 29 5d 20 77 69 6c 6c 20 62 65 20  lloc()] will be 
ef80: 75 73 65 64 20 74 6f 20 6f 62 74 61 69 6e 20 74  used to obtain t
ef90: 68 65 20 6d 65 6d 6f 72 79 20 6e 65 65 64 65 64  he memory needed
efa0: 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 64 74  .</dd>.**.** <dt
efb0: 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50  >SQLITE_CONFIG_P
efc0: 41 47 45 43 41 43 48 45 3c 2f 64 74 3e 0a 2a 2a  AGECACHE</dt>.**
efd0: 20 3c 64 64 3e 20 5e 54 68 69 73 20 6f 70 74 69   <dd> ^This opti
efe0: 6f 6e 20 73 70 65 63 69 66 69 65 73 20 61 20 73  on specifies a s
eff0: 74 61 74 69 63 20 6d 65 6d 6f 72 79 20 62 75 66  tatic memory buf
f000: 66 65 72 20 74 68 61 74 20 53 51 4c 69 74 65 20  fer that SQLite 
f010: 63 61 6e 20 75 73 65 20 66 6f 72 0a 2a 2a 20 74  can use for.** t
f020: 68 65 20 64 61 74 61 62 61 73 65 20 70 61 67 65  he database page
f030: 20 63 61 63 68 65 20 77 69 74 68 20 74 68 65 20   cache with the 
f040: 64 65 66 61 75 6c 74 20 70 61 67 65 20 63 61 63  default page cac
f050: 68 65 20 69 6d 70 6c 65 6d 65 6e 61 74 69 6f 6e  he implemenation
f060: 2e 20 20 0a 2a 2a 20 54 68 69 73 20 63 6f 6e 66  .  .** This conf
f070: 69 67 75 72 61 74 69 6f 6e 20 73 68 6f 75 6c 64  iguration should
f080: 20 6e 6f 74 20 62 65 20 75 73 65 64 20 69 66 20   not be used if 
f090: 61 6e 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64  an application-d
f0a0: 65 66 69 6e 65 20 70 61 67 65 0a 2a 2a 20 63 61  efine page.** ca
f0b0: 63 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  che implementati
f0c0: 6f 6e 20 69 73 20 6c 6f 61 64 65 64 20 75 73 69  on is loaded usi
f0d0: 6e 67 20 74 68 65 20 53 51 4c 49 54 45 5f 43 4f  ng the SQLITE_CO
f0e0: 4e 46 49 47 5f 50 43 41 43 48 45 20 6f 70 74 69  NFIG_PCACHE opti
f0f0: 6f 6e 2e 0a 2a 2a 20 54 68 65 72 65 20 61 72 65  on..** There are
f100: 20 74 68 72 65 65 20 61 72 67 75 6d 65 6e 74 73   three arguments
f110: 20 74 6f 20 74 68 69 73 20 6f 70 74 69 6f 6e 3a   to this option:
f120: 20 41 20 70 6f 69 6e 74 65 72 20 74 6f 20 38 2d   A pointer to 8-
f130: 62 79 74 65 20 61 6c 69 67 6e 65 64 0a 2a 2a 20  byte aligned.** 
f140: 6d 65 6d 6f 72 79 2c 20 74 68 65 20 73 69 7a 65  memory, the size
f150: 20 6f 66 20 65 61 63 68 20 70 61 67 65 20 62 75   of each page bu
f160: 66 66 65 72 20 28 73 7a 29 2c 20 61 6e 64 20 74  ffer (sz), and t
f170: 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 70 61 67  he number of pag
f180: 65 73 20 28 4e 29 2e 0a 2a 2a 20 54 68 65 20 73  es (N)..** The s
f190: 7a 20 61 72 67 75 6d 65 6e 74 20 73 68 6f 75 6c  z argument shoul
f1a0: 64 20 62 65 20 74 68 65 20 73 69 7a 65 20 6f 66  d be the size of
f1b0: 20 74 68 65 20 6c 61 72 67 65 73 74 20 64 61 74   the largest dat
f1c0: 61 62 61 73 65 20 70 61 67 65 0a 2a 2a 20 28 61  abase page.** (a
f1d0: 20 70 6f 77 65 72 20 6f 66 20 74 77 6f 20 62 65   power of two be
f1e0: 74 77 65 65 6e 20 35 31 32 20 61 6e 64 20 33 32  tween 512 and 32
f1f0: 37 36 38 29 20 70 6c 75 73 20 61 20 6c 69 74 74  768) plus a litt
f200: 6c 65 20 65 78 74 72 61 20 66 6f 72 20 65 61 63  le extra for eac
f210: 68 0a 2a 2a 20 70 61 67 65 20 68 65 61 64 65 72  h.** page header
f220: 2e 20 20 5e 54 68 65 20 70 61 67 65 20 68 65 61  .  ^The page hea
f230: 64 65 72 20 73 69 7a 65 20 69 73 20 32 30 20 74  der size is 20 t
f240: 6f 20 34 30 20 62 79 74 65 73 20 64 65 70 65 6e  o 40 bytes depen
f250: 64 69 6e 67 20 6f 6e 0a 2a 2a 20 74 68 65 20 68  ding on.** the h
f260: 6f 73 74 20 61 72 63 68 69 74 65 63 74 75 72 65  ost architecture
f270: 2e 20 20 5e 49 74 20 69 73 20 68 61 72 6d 6c 65  .  ^It is harmle
f280: 73 73 2c 20 61 70 61 72 74 20 66 72 6f 6d 20 74  ss, apart from t
f290: 68 65 20 77 61 73 74 65 64 20 6d 65 6d 6f 72 79  he wasted memory
f2a0: 2c 0a 2a 2a 20 74 6f 20 6d 61 6b 65 20 73 7a 20  ,.** to make sz 
f2b0: 61 20 6c 69 74 74 6c 65 20 74 6f 6f 20 6c 61 72  a little too lar
f2c0: 67 65 2e 20 20 54 68 65 20 66 69 72 73 74 0a 2a  ge.  The first.*
f2d0: 2a 20 61 72 67 75 6d 65 6e 74 20 73 68 6f 75 6c  * argument shoul
f2e0: 64 20 70 6f 69 6e 74 20 74 6f 20 61 6e 20 61 6c  d point to an al
f2f0: 6c 6f 63 61 74 69 6f 6e 20 6f 66 20 61 74 20 6c  location of at l
f300: 65 61 73 74 20 73 7a 2a 4e 20 62 79 74 65 73 20  east sz*N bytes 
f310: 6f 66 20 6d 65 6d 6f 72 79 2e 0a 2a 2a 20 5e 53  of memory..** ^S
f320: 51 4c 69 74 65 20 77 69 6c 6c 20 75 73 65 20 74  QLite will use t
f330: 68 65 20 6d 65 6d 6f 72 79 20 70 72 6f 76 69 64  he memory provid
f340: 65 64 20 62 79 20 74 68 65 20 66 69 72 73 74 20  ed by the first 
f350: 61 72 67 75 6d 65 6e 74 20 74 6f 20 73 61 74 69  argument to sati
f360: 73 66 79 20 69 74 73 0a 2a 2a 20 6d 65 6d 6f 72  sfy its.** memor
f370: 79 20 6e 65 65 64 73 20 66 6f 72 20 74 68 65 20  y needs for the 
f380: 66 69 72 73 74 20 4e 20 70 61 67 65 73 20 74 68  first N pages th
f390: 61 74 20 69 74 20 61 64 64 73 20 74 6f 20 63 61  at it adds to ca
f3a0: 63 68 65 2e 20 20 5e 49 66 20 61 64 64 69 74 69  che.  ^If additi
f3b0: 6f 6e 61 6c 0a 2a 2a 20 70 61 67 65 20 63 61 63  onal.** page cac
f3c0: 68 65 20 6d 65 6d 6f 72 79 20 69 73 20 6e 65 65  he memory is nee
f3d0: 64 65 64 20 62 65 79 6f 6e 64 20 77 68 61 74 20  ded beyond what 
f3e0: 69 73 20 70 72 6f 76 69 64 65 64 20 62 79 20 74  is provided by t
f3f0: 68 69 73 20 6f 70 74 69 6f 6e 2c 20 74 68 65 6e  his option, then
f400: 0a 2a 2a 20 53 51 4c 69 74 65 20 67 6f 65 73 20  .** SQLite goes 
f410: 74 6f 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c  to [sqlite3_mall
f420: 6f 63 28 29 5d 20 66 6f 72 20 74 68 65 20 61 64  oc()] for the ad
f430: 64 69 74 69 6f 6e 61 6c 20 73 74 6f 72 61 67 65  ditional storage
f440: 20 73 70 61 63 65 2e 0a 2a 2a 20 54 68 65 20 70   space..** The p
f450: 6f 69 6e 74 65 72 20 69 6e 20 74 68 65 20 66 69  ointer in the fi
f460: 72 73 74 20 61 72 67 75 6d 65 6e 74 20 6d 75 73  rst argument mus
f470: 74 0a 2a 2a 20 62 65 20 61 6c 69 67 6e 65 64 20  t.** be aligned 
f480: 74 6f 20 61 6e 20 38 2d 62 79 74 65 20 62 6f 75  to an 8-byte bou
f490: 6e 64 61 72 79 20 6f 72 20 73 75 62 73 65 71 75  ndary or subsequ
f4a0: 65 6e 74 20 62 65 68 61 76 69 6f 72 20 6f 66 20  ent behavior of 
f4b0: 53 51 4c 69 74 65 0a 2a 2a 20 77 69 6c 6c 20 62  SQLite.** will b
f4c0: 65 20 75 6e 64 65 66 69 6e 65 64 2e 3c 2f 64 64  e undefined.</dd
f4d0: 3e 0a 2a 2a 0a 2a 2a 20 3c 64 74 3e 53 51 4c 49  >.**.** <dt>SQLI
f4e0: 54 45 5f 43 4f 4e 46 49 47 5f 48 45 41 50 3c 2f  TE_CONFIG_HEAP</
f4f0: 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 54 68 69  dt>.** <dd> ^Thi
f500: 73 20 6f 70 74 69 6f 6e 20 73 70 65 63 69 66 69  s option specifi
f510: 65 73 20 61 20 73 74 61 74 69 63 20 6d 65 6d 6f  es a static memo
f520: 72 79 20 62 75 66 66 65 72 20 74 68 61 74 20 53  ry buffer that S
f530: 51 4c 69 74 65 20 77 69 6c 6c 20 75 73 65 0a 2a  QLite will use.*
f540: 2a 20 66 6f 72 20 61 6c 6c 20 6f 66 20 69 74 73  * for all of its
f550: 20 64 79 6e 61 6d 69 63 20 6d 65 6d 6f 72 79 20   dynamic memory 
f560: 61 6c 6c 6f 63 61 74 69 6f 6e 20 6e 65 65 64 73  allocation needs
f570: 20 62 65 79 6f 6e 64 20 74 68 6f 73 65 20 70 72   beyond those pr
f580: 6f 76 69 64 65 64 0a 2a 2a 20 66 6f 72 20 62 79  ovided.** for by
f590: 20 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f   [SQLITE_CONFIG_
f5a0: 53 43 52 41 54 43 48 5d 20 61 6e 64 20 5b 53 51  SCRATCH] and [SQ
f5b0: 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 41 47 45  LITE_CONFIG_PAGE
f5c0: 43 41 43 48 45 5d 2e 0a 2a 2a 20 54 68 65 72 65  CACHE]..** There
f5d0: 20 61 72 65 20 74 68 72 65 65 20 61 72 67 75 6d   are three argum
f5e0: 65 6e 74 73 3a 20 41 6e 20 38 2d 62 79 74 65 20  ents: An 8-byte 
f5f0: 61 6c 69 67 6e 65 64 20 70 6f 69 6e 74 65 72 20  aligned pointer 
f600: 74 6f 20 74 68 65 20 6d 65 6d 6f 72 79 2c 0a 2a  to the memory,.*
f610: 2a 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20  * the number of 
f620: 62 79 74 65 73 20 69 6e 20 74 68 65 20 6d 65 6d  bytes in the mem
f630: 6f 72 79 20 62 75 66 66 65 72 2c 20 61 6e 64 20  ory buffer, and 
f640: 74 68 65 20 6d 69 6e 69 6d 75 6d 20 61 6c 6c 6f  the minimum allo
f650: 63 61 74 69 6f 6e 20 73 69 7a 65 2e 0a 2a 2a 20  cation size..** 
f660: 5e 49 66 20 74 68 65 20 66 69 72 73 74 20 70 6f  ^If the first po
f670: 69 6e 74 65 72 20 28 74 68 65 20 6d 65 6d 6f 72  inter (the memor
f680: 79 20 70 6f 69 6e 74 65 72 29 20 69 73 20 4e 55  y pointer) is NU
f690: 4c 4c 2c 20 74 68 65 6e 20 53 51 4c 69 74 65 20  LL, then SQLite 
f6a0: 72 65 76 65 72 74 73 0a 2a 2a 20 74 6f 20 75 73  reverts.** to us
f6b0: 69 6e 67 20 69 74 73 20 64 65 66 61 75 6c 74 20  ing its default 
f6c0: 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72  memory allocator
f6d0: 20 28 74 68 65 20 73 79 73 74 65 6d 20 6d 61 6c   (the system mal
f6e0: 6c 6f 63 28 29 20 69 6d 70 6c 65 6d 65 6e 74 61  loc() implementa
f6f0: 74 69 6f 6e 29 2c 0a 2a 2a 20 75 6e 64 6f 69 6e  tion),.** undoin
f700: 67 20 61 6e 79 20 70 72 69 6f 72 20 69 6e 76 6f  g any prior invo
f710: 63 61 74 69 6f 6e 20 6f 66 20 5b 53 51 4c 49 54  cation of [SQLIT
f720: 45 5f 43 4f 4e 46 49 47 5f 4d 41 4c 4c 4f 43 5d  E_CONFIG_MALLOC]
f730: 2e 20 20 5e 49 66 20 74 68 65 0a 2a 2a 20 6d 65  .  ^If the.** me
f740: 6d 6f 72 79 20 70 6f 69 6e 74 65 72 20 69 73 20  mory pointer is 
f750: 6e 6f 74 20 4e 55 4c 4c 20 61 6e 64 20 65 69 74  not NULL and eit
f760: 68 65 72 20 5b 53 51 4c 49 54 45 5f 45 4e 41 42  her [SQLITE_ENAB
f770: 4c 45 5f 4d 45 4d 53 59 53 33 5d 20 6f 72 0a 2a  LE_MEMSYS3] or.*
f780: 2a 20 5b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45  * [SQLITE_ENABLE
f790: 5f 4d 45 4d 53 59 53 35 5d 20 61 72 65 20 64 65  _MEMSYS5] are de
f7a0: 66 69 6e 65 64 2c 20 74 68 65 6e 20 74 68 65 20  fined, then the 
f7b0: 61 6c 74 65 72 6e 61 74 69 76 65 20 6d 65 6d 6f  alternative memo
f7c0: 72 79 0a 2a 2a 20 61 6c 6c 6f 63 61 74 6f 72 20  ry.** allocator 
f7d0: 69 73 20 65 6e 67 61 67 65 64 20 74 6f 20 68 61  is engaged to ha
f7e0: 6e 64 6c 65 20 61 6c 6c 20 6f 66 20 53 51 4c 69  ndle all of SQLi
f7f0: 74 65 73 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  tes memory alloc
f800: 61 74 69 6f 6e 20 6e 65 65 64 73 2e 0a 2a 2a 20  ation needs..** 
f810: 54 68 65 20 66 69 72 73 74 20 70 6f 69 6e 74 65  The first pointe
f820: 72 20 28 74 68 65 20 6d 65 6d 6f 72 79 20 70 6f  r (the memory po
f830: 69 6e 74 65 72 29 20 6d 75 73 74 20 62 65 20 61  inter) must be a
f840: 6c 69 67 6e 65 64 20 74 6f 20 61 6e 20 38 2d 62  ligned to an 8-b
f850: 79 74 65 0a 2a 2a 20 62 6f 75 6e 64 61 72 79 20  yte.** boundary 
f860: 6f 72 20 73 75 62 73 65 71 75 65 6e 74 20 62 65  or subsequent be
f870: 68 61 76 69 6f 72 20 6f 66 20 53 51 4c 69 74 65  havior of SQLite
f880: 20 77 69 6c 6c 20 62 65 20 75 6e 64 65 66 69 6e   will be undefin
f890: 65 64 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c  ed.</dd>.**.** <
f8a0: 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47  dt>SQLITE_CONFIG
f8b0: 5f 4d 55 54 45 58 3c 2f 64 74 3e 0a 2a 2a 20 3c  _MUTEX</dt>.** <
f8c0: 64 64 3e 20 5e 28 54 68 69 73 20 6f 70 74 69 6f  dd> ^(This optio
f8d0: 6e 20 74 61 6b 65 73 20 61 20 73 69 6e 67 6c 65  n takes a single
f8e0: 20 61 72 67 75 6d 65 6e 74 20 77 68 69 63 68 20   argument which 
f8f0: 69 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20  is a pointer to 
f900: 61 6e 0a 2a 2a 20 69 6e 73 74 61 6e 63 65 20 6f  an.** instance o
f910: 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 6d  f the [sqlite3_m
f920: 75 74 65 78 5f 6d 65 74 68 6f 64 73 5d 20 73 74  utex_methods] st
f930: 72 75 63 74 75 72 65 2e 20 20 54 68 65 20 61 72  ructure.  The ar
f940: 67 75 6d 65 6e 74 20 73 70 65 63 69 66 69 65 73  gument specifies
f950: 0a 2a 2a 20 61 6c 74 65 72 6e 61 74 69 76 65 20  .** alternative 
f960: 6c 6f 77 2d 6c 65 76 65 6c 20 6d 75 74 65 78 20  low-level mutex 
f970: 72 6f 75 74 69 6e 65 73 20 74 6f 20 62 65 20 75  routines to be u
f980: 73 65 64 20 69 6e 20 70 6c 61 63 65 0a 2a 2a 20  sed in place.** 
f990: 74 68 65 20 6d 75 74 65 78 20 72 6f 75 74 69 6e  the mutex routin
f9a0: 65 73 20 62 75 69 6c 74 20 69 6e 74 6f 20 53 51  es built into SQ
f9b0: 4c 69 74 65 2e 29 5e 20 20 5e 53 51 4c 69 74 65  Lite.)^  ^SQLite
f9c0: 20 6d 61 6b 65 73 20 61 20 63 6f 70 79 20 6f 66   makes a copy of
f9d0: 20 74 68 65 0a 2a 2a 20 63 6f 6e 74 65 6e 74 20   the.** content 
f9e0: 6f 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  of the [sqlite3_
f9f0: 6d 75 74 65 78 5f 6d 65 74 68 6f 64 73 5d 20 73  mutex_methods] s
fa00: 74 72 75 63 74 75 72 65 20 62 65 66 6f 72 65 20  tructure before 
fa10: 74 68 65 20 63 61 6c 6c 20 74 6f 0a 2a 2a 20 5b  the call to.** [
fa20: 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 28 29  sqlite3_config()
fa30: 5d 20 72 65 74 75 72 6e 73 2e 20 5e 49 66 20 53  ] returns. ^If S
fa40: 51 4c 69 74 65 20 69 73 20 63 6f 6d 70 69 6c 65  QLite is compile
fa50: 64 20 77 69 74 68 0a 2a 2a 20 74 68 65 20 5b 53  d with.** the [S
fa60: 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46 45  QLITE_THREADSAFE
fa70: 20 7c 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44   | SQLITE_THREAD
fa80: 53 41 46 45 3d 30 5d 20 63 6f 6d 70 69 6c 65 2d  SAFE=0] compile-
fa90: 74 69 6d 65 20 6f 70 74 69 6f 6e 20 74 68 65 6e  time option then
faa0: 0a 2a 2a 20 74 68 65 20 65 6e 74 69 72 65 20 6d  .** the entire m
fab0: 75 74 65 78 69 6e 67 20 73 75 62 73 79 73 74 65  utexing subsyste
fac0: 6d 20 69 73 20 6f 6d 69 74 74 65 64 20 66 72 6f  m is omitted fro
fad0: 6d 20 74 68 65 20 62 75 69 6c 64 20 61 6e 64 20  m the build and 
fae0: 68 65 6e 63 65 20 63 61 6c 6c 73 20 74 6f 0a 2a  hence calls to.*
faf0: 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69  * [sqlite3_confi
fb00: 67 28 29 5d 20 77 69 74 68 20 74 68 65 20 53 51  g()] with the SQ
fb10: 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 55 54 45  LITE_CONFIG_MUTE
fb20: 58 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20  X configuration 
fb30: 6f 70 74 69 6f 6e 20 77 69 6c 6c 0a 2a 2a 20 72  option will.** r
fb40: 65 74 75 72 6e 20 5b 53 51 4c 49 54 45 5f 45 52  eturn [SQLITE_ER
fb50: 52 4f 52 5d 2e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a  ROR].</dd>.**.**
fb60: 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f 4e 46   <dt>SQLITE_CONF
fb70: 49 47 5f 47 45 54 4d 55 54 45 58 3c 2f 64 74 3e  IG_GETMUTEX</dt>
fb80: 0a 2a 2a 20 3c 64 64 3e 20 5e 28 54 68 69 73 20  .** <dd> ^(This 
fb90: 6f 70 74 69 6f 6e 20 74 61 6b 65 73 20 61 20 73  option takes a s
fba0: 69 6e 67 6c 65 20 61 72 67 75 6d 65 6e 74 20 77  ingle argument w
fbb0: 68 69 63 68 20 69 73 20 61 20 70 6f 69 6e 74 65  hich is a pointe
fbc0: 72 20 74 6f 20 61 6e 0a 2a 2a 20 69 6e 73 74 61  r to an.** insta
fbd0: 6e 63 65 20 6f 66 20 74 68 65 20 5b 73 71 6c 69  nce of the [sqli
fbe0: 74 65 33 5f 6d 75 74 65 78 5f 6d 65 74 68 6f 64  te3_mutex_method
fbf0: 73 5d 20 73 74 72 75 63 74 75 72 65 2e 20 20 54  s] structure.  T
fc00: 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6d  he.** [sqlite3_m
fc10: 75 74 65 78 5f 6d 65 74 68 6f 64 73 5d 0a 2a 2a  utex_methods].**
fc20: 20 73 74 72 75 63 74 75 72 65 20 69 73 20 66 69   structure is fi
fc30: 6c 6c 65 64 20 77 69 74 68 20 74 68 65 20 63 75  lled with the cu
fc40: 72 72 65 6e 74 6c 79 20 64 65 66 69 6e 65 64 20  rrently defined 
fc50: 6d 75 74 65 78 20 72 6f 75 74 69 6e 65 73 2e 29  mutex routines.)
fc60: 5e 0a 2a 2a 20 54 68 69 73 20 6f 70 74 69 6f 6e  ^.** This option
fc70: 20 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20   can be used to 
fc80: 6f 76 65 72 6c 6f 61 64 20 74 68 65 20 64 65 66  overload the def
fc90: 61 75 6c 74 20 6d 75 74 65 78 20 61 6c 6c 6f 63  ault mutex alloc
fca0: 61 74 69 6f 6e 0a 2a 2a 20 72 6f 75 74 69 6e 65  ation.** routine
fcb0: 73 20 77 69 74 68 20 61 20 77 72 61 70 70 65 72  s with a wrapper
fcc0: 20 75 73 65 64 20 74 6f 20 74 72 61 63 6b 20 6d   used to track m
fcd0: 75 74 65 78 20 75 73 61 67 65 20 66 6f 72 20 70  utex usage for p
fce0: 65 72 66 6f 72 6d 61 6e 63 65 0a 2a 2a 20 70 72  erformance.** pr
fcf0: 6f 66 69 6c 69 6e 67 20 6f 72 20 74 65 73 74 69  ofiling or testi
fd00: 6e 67 2c 20 66 6f 72 20 65 78 61 6d 70 6c 65 2e  ng, for example.
fd10: 20 20 20 5e 49 66 20 53 51 4c 69 74 65 20 69 73     ^If SQLite is
fd20: 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 0a 2a   compiled with.*
fd30: 2a 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 54 48  * the [SQLITE_TH
fd40: 52 45 41 44 53 41 46 45 20 7c 20 53 51 4c 49 54  READSAFE | SQLIT
fd50: 45 5f 54 48 52 45 41 44 53 41 46 45 3d 30 5d 20  E_THREADSAFE=0] 
fd60: 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70 74  compile-time opt
fd70: 69 6f 6e 20 74 68 65 6e 0a 2a 2a 20 74 68 65 20  ion then.** the 
fd80: 65 6e 74 69 72 65 20 6d 75 74 65 78 69 6e 67 20  entire mutexing 
fd90: 73 75 62 73 79 73 74 65 6d 20 69 73 20 6f 6d 69  subsystem is omi
fda0: 74 74 65 64 20 66 72 6f 6d 20 74 68 65 20 62 75  tted from the bu
fdb0: 69 6c 64 20 61 6e 64 20 68 65 6e 63 65 20 63 61  ild and hence ca
fdc0: 6c 6c 73 20 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74  lls to.** [sqlit
fdd0: 65 33 5f 63 6f 6e 66 69 67 28 29 5d 20 77 69 74  e3_config()] wit
fde0: 68 20 74 68 65 20 53 51 4c 49 54 45 5f 43 4f 4e  h the SQLITE_CON
fdf0: 46 49 47 5f 47 45 54 4d 55 54 45 58 20 63 6f 6e  FIG_GETMUTEX con
fe00: 66 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f  figuration optio
fe10: 6e 20 77 69 6c 6c 0a 2a 2a 20 72 65 74 75 72 6e  n will.** return
fe20: 20 5b 53 51 4c 49 54 45 5f 45 52 52 4f 52 5d 2e   [SQLITE_ERROR].
fe30: 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 64 74 3e  </dd>.**.** <dt>
fe40: 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4c 4f  SQLITE_CONFIG_LO
fe50: 4f 4b 41 53 49 44 45 3c 2f 64 74 3e 0a 2a 2a 20  OKASIDE</dt>.** 
fe60: 3c 64 64 3e 20 5e 28 54 68 69 73 20 6f 70 74 69  <dd> ^(This opti
fe70: 6f 6e 20 74 61 6b 65 73 20 74 77 6f 20 61 72 67  on takes two arg
fe80: 75 6d 65 6e 74 73 20 74 68 61 74 20 64 65 74 65  uments that dete
fe90: 72 6d 69 6e 65 20 74 68 65 20 64 65 66 61 75 6c  rmine the defaul
fea0: 74 0a 2a 2a 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f  t.** memory allo
feb0: 63 61 74 69 6f 6e 20 66 6f 72 20 74 68 65 20 6c  cation for the l
fec0: 6f 6f 6b 61 73 69 64 65 20 6d 65 6d 6f 72 79 20  ookaside memory 
fed0: 61 6c 6c 6f 63 61 74 6f 72 20 6f 6e 20 65 61 63  allocator on eac
fee0: 68 0a 2a 2a 20 5b 64 61 74 61 62 61 73 65 20 63  h.** [database c
fef0: 6f 6e 6e 65 63 74 69 6f 6e 5d 2e 20 20 54 68 65  onnection].  The
ff00: 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20   first argument 
ff10: 69 73 20 74 68 65 0a 2a 2a 20 73 69 7a 65 20 6f  is the.** size o
ff20: 66 20 65 61 63 68 20 6c 6f 6f 6b 61 73 69 64 65  f each lookaside
ff30: 20 62 75 66 66 65 72 20 73 6c 6f 74 20 61 6e 64   buffer slot and
ff40: 20 74 68 65 20 73 65 63 6f 6e 64 20 69 73 20 74   the second is t
ff50: 68 65 20 6e 75 6d 62 65 72 20 6f 66 0a 2a 2a 20  he number of.** 
ff60: 73 6c 6f 74 73 20 61 6c 6c 6f 63 61 74 65 64 20  slots allocated 
ff70: 74 6f 20 65 61 63 68 20 64 61 74 61 62 61 73 65  to each database
ff80: 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e 29 5e 20 20   connection.)^  
ff90: 5e 28 54 68 69 73 20 6f 70 74 69 6f 6e 20 73 65  ^(This option se
ffa0: 74 73 20 74 68 65 0a 2a 2a 20 3c 69 3e 64 65 66  ts the.** <i>def
ffb0: 61 75 6c 74 3c 2f 69 3e 20 6c 6f 6f 6b 61 73 69  ault</i> lookasi
ffc0: 64 65 20 73 69 7a 65 2e 20 54 68 65 20 5b 53 51  de size. The [SQ
ffd0: 4c 49 54 45 5f 44 42 43 4f 4e 46 49 47 5f 4c 4f  LITE_DBCONFIG_LO
ffe0: 4f 4b 41 53 49 44 45 5d 0a 2a 2a 20 76 65 72 62  OKASIDE].** verb
fff0: 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 64 62 5f   to [sqlite3_db_
10000 63 6f 6e 66 69 67 28 29 5d 20 63 61 6e 20 62 65  config()] can be
10010 20 75 73 65 64 20 74 6f 20 63 68 61 6e 67 65 20   used to change 
10020 74 68 65 20 6c 6f 6f 6b 61 73 69 64 65 0a 2a 2a  the lookaside.**
10030 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 6f   configuration o
10040 6e 20 69 6e 64 69 76 69 64 75 61 6c 20 63 6f 6e  n individual con
10050 6e 65 63 74 69 6f 6e 73 2e 29 5e 20 3c 2f 64 64  nections.)^ </dd
10060 3e 0a 2a 2a 0a 2a 2a 20 3c 64 74 3e 53 51 4c 49  >.**.** <dt>SQLI
10070 54 45 5f 43 4f 4e 46 49 47 5f 50 43 41 43 48 45  TE_CONFIG_PCACHE
10080 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 28  </dt>.** <dd> ^(
10090 54 68 69 73 20 6f 70 74 69 6f 6e 20 74 61 6b 65  This option take
100a0 73 20 61 20 73 69 6e 67 6c 65 20 61 72 67 75 6d  s a single argum
100b0 65 6e 74 20 77 68 69 63 68 20 69 73 20 61 20 70  ent which is a p
100c0 6f 69 6e 74 65 72 20 74 6f 0a 2a 2a 20 61 6e 20  ointer to.** an 
100d0 5b 73 71 6c 69 74 65 33 5f 70 63 61 63 68 65 5f  [sqlite3_pcache_
100e0 6d 65 74 68 6f 64 73 5d 20 6f 62 6a 65 63 74 2e  methods] object.
100f0 20 20 54 68 69 73 20 6f 62 6a 65 63 74 20 73 70    This object sp
10100 65 63 69 66 69 65 73 20 74 68 65 20 69 6e 74 65  ecifies the inte
10110 72 66 61 63 65 0a 2a 2a 20 74 6f 20 61 20 63 75  rface.** to a cu
10120 73 74 6f 6d 20 70 61 67 65 20 63 61 63 68 65 20  stom page cache 
10130 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 2e 29  implementation.)
10140 5e 20 20 5e 53 51 4c 69 74 65 20 6d 61 6b 65 73  ^  ^SQLite makes
10150 20 61 20 63 6f 70 79 20 6f 66 20 74 68 65 0a 2a   a copy of the.*
10160 2a 20 6f 62 6a 65 63 74 20 61 6e 64 20 75 73 65  * object and use
10170 73 20 69 74 20 66 6f 72 20 70 61 67 65 20 63 61  s it for page ca
10180 63 68 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  che memory alloc
10190 61 74 69 6f 6e 73 2e 3c 2f 64 64 3e 0a 2a 2a 0a  ations.</dd>.**.
101a0 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f 43 4f  ** <dt>SQLITE_CO
101b0 4e 46 49 47 5f 47 45 54 50 43 41 43 48 45 3c 2f  NFIG_GETPCACHE</
101c0 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 28 54 68  dt>.** <dd> ^(Th
101d0 69 73 20 6f 70 74 69 6f 6e 20 74 61 6b 65 73 20  is option takes 
101e0 61 20 73 69 6e 67 6c 65 20 61 72 67 75 6d 65 6e  a single argumen
101f0 74 20 77 68 69 63 68 20 69 73 20 61 20 70 6f 69  t which is a poi
10200 6e 74 65 72 20 74 6f 20 61 6e 0a 2a 2a 20 5b 73  nter to an.** [s
10210 71 6c 69 74 65 33 5f 70 63 61 63 68 65 5f 6d 65  qlite3_pcache_me
10220 74 68 6f 64 73 5d 20 6f 62 6a 65 63 74 2e 20 20  thods] object.  
10230 53 51 4c 69 74 65 20 63 6f 70 69 65 73 20 6f 66  SQLite copies of
10240 20 74 68 65 20 63 75 72 72 65 6e 74 0a 2a 2a 20   the current.** 
10250 70 61 67 65 20 63 61 63 68 65 20 69 6d 70 6c 65  page cache imple
10260 6d 65 6e 74 61 74 69 6f 6e 20 69 6e 74 6f 20 74  mentation into t
10270 68 61 74 20 6f 62 6a 65 63 74 2e 29 5e 20 3c 2f  hat object.)^ </
10280 64 64 3e 0a 2a 2a 0a 2a 2a 20 3c 64 74 3e 53 51  dd>.**.** <dt>SQ
10290 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4c 4f 47 3c  LITE_CONFIG_LOG<
102a0 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20 5e 54 68  /dt>.** <dd> ^Th
102b0 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  e SQLITE_CONFIG_
102c0 4c 4f 47 20 6f 70 74 69 6f 6e 20 74 61 6b 65 73  LOG option takes
102d0 20 74 77 6f 20 61 72 67 75 6d 65 6e 74 73 3a 20   two arguments: 
102e0 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 0a 2a  a pointer to a.*
102f0 2a 20 66 75 6e 63 74 69 6f 6e 20 77 69 74 68 20  * function with 
10300 61 20 63 61 6c 6c 20 73 69 67 6e 61 74 75 72 65  a call signature
10310 20 6f 66 20 76 6f 69 64 28 2a 29 28 76 6f 69 64   of void(*)(void
10320 2a 2c 69 6e 74 2c 63 6f 6e 73 74 20 63 68 61 72  *,int,const char
10330 2a 29 2c 20 0a 2a 2a 20 61 6e 64 20 61 20 70 6f  *), .** and a po
10340 69 6e 74 65 72 20 74 6f 20 76 6f 69 64 2e 20 5e  inter to void. ^
10350 49 66 20 74 68 65 20 66 75 6e 63 74 69 6f 6e 20  If the function 
10360 70 6f 69 6e 74 65 72 20 69 73 20 6e 6f 74 20 4e  pointer is not N
10370 55 4c 4c 2c 20 69 74 20 69 73 0a 2a 2a 20 69 6e  ULL, it is.** in
10380 76 6f 6b 65 64 20 62 79 20 5b 73 71 6c 69 74 65  voked by [sqlite
10390 33 5f 6c 6f 67 28 29 5d 20 74 6f 20 70 72 6f 63  3_log()] to proc
103a0 65 73 73 20 65 61 63 68 20 6c 6f 67 67 69 6e 67  ess each logging
103b0 20 65 76 65 6e 74 2e 20 20 5e 49 66 20 74 68 65   event.  ^If the
103c0 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 70 6f 69  .** function poi
103d0 6e 74 65 72 20 69 73 20 4e 55 4c 4c 2c 20 74 68  nter is NULL, th
103e0 65 20 5b 73 71 6c 69 74 65 33 5f 6c 6f 67 28 29  e [sqlite3_log()
103f0 5d 20 69 6e 74 65 72 66 61 63 65 20 62 65 63 6f  ] interface beco
10400 6d 65 73 20 61 20 6e 6f 2d 6f 70 2e 0a 2a 2a 20  mes a no-op..** 
10410 5e 54 68 65 20 76 6f 69 64 20 70 6f 69 6e 74 65  ^The void pointe
10420 72 20 74 68 61 74 20 69 73 20 74 68 65 20 73 65  r that is the se
10430 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20 74 6f  cond argument to
10440 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4c   SQLITE_CONFIG_L
10450 4f 47 20 69 73 0a 2a 2a 20 70 61 73 73 65 64 20  OG is.** passed 
10460 74 68 72 6f 75 67 68 20 61 73 20 74 68 65 20 66  through as the f
10470 69 72 73 74 20 70 61 72 61 6d 65 74 65 72 20 74  irst parameter t
10480 6f 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f  o the applicatio
10490 6e 2d 64 65 66 69 6e 65 64 20 6c 6f 67 67 65 72  n-defined logger
104a0 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 77 68 65  .** function whe
104b0 6e 65 76 65 72 20 74 68 61 74 20 66 75 6e 63 74  never that funct
104c0 69 6f 6e 20 69 73 20 69 6e 76 6f 6b 65 64 2e 20  ion is invoked. 
104d0 20 5e 54 68 65 20 73 65 63 6f 6e 64 20 70 61 72   ^The second par
104e0 61 6d 65 74 65 72 20 74 6f 0a 2a 2a 20 74 68 65  ameter to.** the
104f0 20 6c 6f 67 67 65 72 20 66 75 6e 63 74 69 6f 6e   logger function
10500 20 69 73 20 61 20 63 6f 70 79 20 6f 66 20 74 68   is a copy of th
10510 65 20 66 69 72 73 74 20 70 61 72 61 6d 65 74 65  e first paramete
10520 72 20 74 6f 20 74 68 65 20 63 6f 72 72 65 73 70  r to the corresp
10530 6f 6e 64 69 6e 67 0a 2a 2a 20 5b 73 71 6c 69 74  onding.** [sqlit
10540 65 33 5f 6c 6f 67 28 29 5d 20 63 61 6c 6c 20 61  e3_log()] call a
10550 6e 64 20 69 73 20 69 6e 74 65 6e 64 65 64 20 74  nd is intended t
10560 6f 20 62 65 20 61 20 5b 72 65 73 75 6c 74 20 63  o be a [result c
10570 6f 64 65 5d 20 6f 72 20 61 6e 0a 2a 2a 20 5b 65  ode] or an.** [e
10580 78 74 65 6e 64 65 64 20 72 65 73 75 6c 74 20 63  xtended result c
10590 6f 64 65 5d 2e 20 20 5e 54 68 65 20 74 68 69 72  ode].  ^The thir
105a0 64 20 70 61 72 61 6d 65 74 65 72 20 70 61 73 73  d parameter pass
105b0 65 64 20 74 6f 20 74 68 65 20 6c 6f 67 67 65 72  ed to the logger
105c0 20 69 73 0a 2a 2a 20 6c 6f 67 20 6d 65 73 73 61   is.** log messa
105d0 67 65 20 61 66 74 65 72 20 66 6f 72 6d 61 74 74  ge after formatt
105e0 69 6e 67 20 76 69 61 20 5b 73 71 6c 69 74 65 33  ing via [sqlite3
105f0 5f 73 6e 70 72 69 6e 74 66 28 29 5d 2e 0a 2a 2a  _snprintf()]..**
10600 20 54 68 65 20 53 51 4c 69 74 65 20 6c 6f 67 67   The SQLite logg
10610 69 6e 67 20 69 6e 74 65 72 66 61 63 65 20 69 73  ing interface is
10620 20 6e 6f 74 20 72 65 65 6e 74 72 61 6e 74 3b 20   not reentrant; 
10630 74 68 65 20 6c 6f 67 67 65 72 20 66 75 6e 63 74  the logger funct
10640 69 6f 6e 0a 2a 2a 20 73 75 70 70 6c 69 65 64 20  ion.** supplied 
10650 62 79 20 74 68 65 20 61 70 70 6c 69 63 61 74 69  by the applicati
10660 6f 6e 20 6d 75 73 74 20 6e 6f 74 20 69 6e 76 6f  on must not invo
10670 6b 65 20 61 6e 79 20 53 51 4c 69 74 65 20 69 6e  ke any SQLite in
10680 74 65 72 66 61 63 65 2e 0a 2a 2a 20 49 6e 20 61  terface..** In a
10690 20 6d 75 6c 74 69 2d 74 68 72 65 61 64 65 64 20   multi-threaded 
106a0 61 70 70 6c 69 63 61 74 69 6f 6e 2c 20 74 68 65  application, the
106b0 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66   application-def
106c0 69 6e 65 64 20 6c 6f 67 67 65 72 0a 2a 2a 20 66  ined logger.** f
106d0 75 6e 63 74 69 6f 6e 20 6d 75 73 74 20 62 65 20  unction must be 
106e0 74 68 72 65 61 64 73 61 66 65 2e 20 3c 2f 64 64  threadsafe. </dd
106f0 3e 0a 2a 2a 0a 2a 2a 20 3c 2f 64 6c 3e 0a 2a 2f  >.**.** </dl>.*/
10700 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
10710 43 4f 4e 46 49 47 5f 53 49 4e 47 4c 45 54 48 52  CONFIG_SINGLETHR
10720 45 41 44 20 20 31 20 20 2f 2a 20 6e 69 6c 20 2a  EAD  1  /* nil *
10730 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
10740 5f 43 4f 4e 46 49 47 5f 4d 55 4c 54 49 54 48 52  _CONFIG_MULTITHR
10750 45 41 44 20 20 20 32 20 20 2f 2a 20 6e 69 6c 20  EAD   2  /* nil 
10760 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
10770 45 5f 43 4f 4e 46 49 47 5f 53 45 52 49 41 4c 49  E_CONFIG_SERIALI
10780 5a 45 44 20 20 20 20 33 20 20 2f 2a 20 6e 69 6c  ZED    3  /* nil
10790 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
107a0 54 45 5f 43 4f 4e 46 49 47 5f 4d 41 4c 4c 4f 43  TE_CONFIG_MALLOC
107b0 20 20 20 20 20 20 20 20 34 20 20 2f 2a 20 73 71          4  /* sq
107c0 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65 74 68 6f 64  lite3_mem_method
107d0 73 2a 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51  s* */.#define SQ
107e0 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 47 45 54 4d  LITE_CONFIG_GETM
107f0 41 4c 4c 4f 43 20 20 20 20 20 35 20 20 2f 2a 20  ALLOC     5  /* 
10800 73 71 6c 69 74 65 33 5f 6d 65 6d 5f 6d 65 74 68  sqlite3_mem_meth
10810 6f 64 73 2a 20 2a 2f 0a 23 64 65 66 69 6e 65 20  ods* */.#define 
10820 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 53 43  SQLITE_CONFIG_SC
10830 52 41 54 43 48 20 20 20 20 20 20 20 36 20 20 2f  RATCH       6  /
10840 2a 20 76 6f 69 64 2a 2c 20 69 6e 74 20 73 7a 2c  * void*, int sz,
10850 20 69 6e 74 20 4e 20 2a 2f 0a 23 64 65 66 69 6e   int N */.#defin
10860 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f  e SQLITE_CONFIG_
10870 50 41 47 45 43 41 43 48 45 20 20 20 20 20 37 20  PAGECACHE     7 
10880 20 2f 2a 20 76 6f 69 64 2a 2c 20 69 6e 74 20 73   /* void*, int s
10890 7a 2c 20 69 6e 74 20 4e 20 2a 2f 0a 23 64 65 66  z, int N */.#def
108a0 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  ine SQLITE_CONFI
108b0 47 5f 48 45 41 50 20 20 20 20 20 20 20 20 20 20  G_HEAP          
108c0 38 20 20 2f 2a 20 76 6f 69 64 2a 2c 20 69 6e 74  8  /* void*, int
108d0 20 6e 42 79 74 65 2c 20 69 6e 74 20 6d 69 6e 20   nByte, int min 
108e0 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
108f0 45 5f 43 4f 4e 46 49 47 5f 4d 45 4d 53 54 41 54  E_CONFIG_MEMSTAT
10900 55 53 20 20 20 20 20 39 20 20 2f 2a 20 62 6f 6f  US     9  /* boo
10910 6c 65 61 6e 20 2a 2f 0a 23 64 65 66 69 6e 65 20  lean */.#define 
10920 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 4d 55  SQLITE_CONFIG_MU
10930 54 45 58 20 20 20 20 20 20 20 20 31 30 20 20 2f  TEX        10  /
10940 2a 20 73 71 6c 69 74 65 33 5f 6d 75 74 65 78 5f  * sqlite3_mutex_
10950 6d 65 74 68 6f 64 73 2a 20 2a 2f 0a 23 64 65 66  methods* */.#def
10960 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46 49  ine SQLITE_CONFI
10970 47 5f 47 45 54 4d 55 54 45 58 20 20 20 20 20 31  G_GETMUTEX     1
10980 31 20 20 2f 2a 20 73 71 6c 69 74 65 33 5f 6d 75  1  /* sqlite3_mu
10990 74 65 78 5f 6d 65 74 68 6f 64 73 2a 20 2a 2f 0a  tex_methods* */.
109a0 2f 2a 20 70 72 65 76 69 6f 75 73 6c 79 20 53 51  /* previously SQ
109b0 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 43 48 55 4e  LITE_CONFIG_CHUN
109c0 4b 41 4c 4c 4f 43 20 31 32 20 77 68 69 63 68 20  KALLOC 12 which 
109d0 69 73 20 6e 6f 77 20 75 6e 75 73 65 64 2e 20 2a  is now unused. *
109e0 2f 20 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  / .#define SQLIT
109f0 45 5f 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49  E_CONFIG_LOOKASI
10a00 44 45 20 20 20 20 31 33 20 20 2f 2a 20 69 6e 74  DE    13  /* int
10a10 20 69 6e 74 20 2a 2f 0a 23 64 65 66 69 6e 65 20   int */.#define 
10a20 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50 43  SQLITE_CONFIG_PC
10a30 41 43 48 45 20 20 20 20 20 20 20 31 34 20 20 2f  ACHE       14  /
10a40 2a 20 73 71 6c 69 74 65 33 5f 70 63 61 63 68 65  * sqlite3_pcache
10a50 5f 6d 65 74 68 6f 64 73 2a 20 2a 2f 0a 23 64 65  _methods* */.#de
10a60 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 4f 4e 46  fine SQLITE_CONF
10a70 49 47 5f 47 45 54 50 43 41 43 48 45 20 20 20 20  IG_GETPCACHE    
10a80 31 35 20 20 2f 2a 20 73 71 6c 69 74 65 33 5f 70  15  /* sqlite3_p
10a90 63 61 63 68 65 5f 6d 65 74 68 6f 64 73 2a 20 2a  cache_methods* *
10aa0 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
10ab0 5f 43 4f 4e 46 49 47 5f 4c 4f 47 20 20 20 20 20  _CONFIG_LOG     
10ac0 20 20 20 20 20 31 36 20 20 2f 2a 20 78 46 75 6e       16  /* xFun
10ad0 63 2c 20 76 6f 69 64 2a 20 2a 2f 0a 0a 2f 2a 0a  c, void* */../*.
10ae0 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 44 61 74  ** CAPI3REF: Dat
10af0 61 62 61 73 65 20 43 6f 6e 6e 65 63 74 69 6f 6e  abase Connection
10b00 20 43 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 4f   Configuration O
10b10 70 74 69 6f 6e 73 0a 2a 2a 0a 2a 2a 20 54 68 65  ptions.**.** The
10b20 73 65 20 63 6f 6e 73 74 61 6e 74 73 20 61 72 65  se constants are
10b30 20 74 68 65 20 61 76 61 69 6c 61 62 6c 65 20 69   the available i
10b40 6e 74 65 67 65 72 20 63 6f 6e 66 69 67 75 72 61  nteger configura
10b50 74 69 6f 6e 20 6f 70 74 69 6f 6e 73 20 74 68 61  tion options tha
10b60 74 0a 2a 2a 20 63 61 6e 20 62 65 20 70 61 73 73  t.** can be pass
10b70 65 64 20 61 73 20 74 68 65 20 73 65 63 6f 6e 64  ed as the second
10b80 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 74 68 65   argument to the
10b90 20 5b 73 71 6c 69 74 65 33 5f 64 62 5f 63 6f 6e   [sqlite3_db_con
10ba0 66 69 67 28 29 5d 20 69 6e 74 65 72 66 61 63 65  fig()] interface
10bb0 2e 0a 2a 2a 0a 2a 2a 20 4e 65 77 20 63 6f 6e 66  ..**.** New conf
10bc0 69 67 75 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e  iguration option
10bd0 73 20 6d 61 79 20 62 65 20 61 64 64 65 64 20 69  s may be added i
10be0 6e 20 66 75 74 75 72 65 20 72 65 6c 65 61 73 65  n future release
10bf0 73 20 6f 66 20 53 51 4c 69 74 65 2e 0a 2a 2a 20  s of SQLite..** 
10c00 45 78 69 73 74 69 6e 67 20 63 6f 6e 66 69 67 75  Existing configu
10c10 72 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 73 20 6d  ration options m
10c20 69 67 68 74 20 62 65 20 64 69 73 63 6f 6e 74 69  ight be disconti
10c30 6e 75 65 64 2e 20 20 41 70 70 6c 69 63 61 74 69  nued.  Applicati
10c40 6f 6e 73 0a 2a 2a 20 73 68 6f 75 6c 64 20 63 68  ons.** should ch
10c50 65 63 6b 20 74 68 65 20 72 65 74 75 72 6e 20 63  eck the return c
10c60 6f 64 65 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65  ode from [sqlite
10c70 33 5f 64 62 5f 63 6f 6e 66 69 67 28 29 5d 20 74  3_db_config()] t
10c80 6f 20 6d 61 6b 65 20 73 75 72 65 20 74 68 61 74  o make sure that
10c90 0a 2a 2a 20 74 68 65 20 63 61 6c 6c 20 77 6f 72  .** the call wor
10ca0 6b 65 64 2e 20 20 5e 54 68 65 20 5b 73 71 6c 69  ked.  ^The [sqli
10cb0 74 65 33 5f 64 62 5f 63 6f 6e 66 69 67 28 29 5d  te3_db_config()]
10cc0 20 69 6e 74 65 72 66 61 63 65 20 77 69 6c 6c 20   interface will 
10cd0 72 65 74 75 72 6e 20 61 0a 2a 2a 20 6e 6f 6e 2d  return a.** non-
10ce0 7a 65 72 6f 20 5b 65 72 72 6f 72 20 63 6f 64 65  zero [error code
10cf0 5d 20 69 66 20 61 20 64 69 73 63 6f 6e 74 69 6e  ] if a discontin
10d00 75 65 64 20 6f 72 20 75 6e 73 75 70 70 6f 72 74  ued or unsupport
10d10 65 64 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e  ed configuration
10d20 20 6f 70 74 69 6f 6e 0a 2a 2a 20 69 73 20 69 6e   option.** is in
10d30 76 6f 6b 65 64 2e 0a 2a 2a 0a 2a 2a 20 3c 64 6c  voked..**.** <dl
10d40 3e 0a 2a 2a 20 3c 64 74 3e 53 51 4c 49 54 45 5f  >.** <dt>SQLITE_
10d50 44 42 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49  DBCONFIG_LOOKASI
10d60 44 45 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 20  DE</dt>.** <dd> 
10d70 5e 54 68 69 73 20 6f 70 74 69 6f 6e 20 74 61 6b  ^This option tak
10d80 65 73 20 74 68 72 65 65 20 61 64 64 69 74 69 6f  es three additio
10d90 6e 61 6c 20 61 72 67 75 6d 65 6e 74 73 20 74 68  nal arguments th
10da0 61 74 20 64 65 74 65 72 6d 69 6e 65 20 74 68 65  at determine the
10db0 20 0a 2a 2a 20 5b 6c 6f 6f 6b 61 73 69 64 65 20   .** [lookaside 
10dc0 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 6f 72  memory allocator
10dd0 5d 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20  ] configuration 
10de0 66 6f 72 20 74 68 65 20 5b 64 61 74 61 62 61 73  for the [databas
10df0 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 2e 0a 2a  e connection]..*
10e00 2a 20 5e 54 68 65 20 66 69 72 73 74 20 61 72 67  * ^The first arg
10e10 75 6d 65 6e 74 20 28 74 68 65 20 74 68 69 72 64  ument (the third
10e20 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 5b 73   parameter to [s
10e30 71 6c 69 74 65 33 5f 64 62 5f 63 6f 6e 66 69 67  qlite3_db_config
10e40 28 29 5d 20 69 73 20 61 0a 2a 2a 20 70 6f 69 6e  ()] is a.** poin
10e50 74 65 72 20 74 6f 20 61 6e 20 6d 65 6d 6f 72 79  ter to an memory
10e60 20 62 75 66 66 65 72 20 74 6f 20 75 73 65 20 66   buffer to use f
10e70 6f 72 20 6c 6f 6f 6b 61 73 69 64 65 20 6d 65 6d  or lookaside mem
10e80 6f 72 79 2e 0a 2a 2a 20 5e 54 68 65 20 66 69 72  ory..** ^The fir
10e90 73 74 20 61 72 67 75 6d 65 6e 74 20 61 66 74 65  st argument afte
10ea0 72 20 74 68 65 20 53 51 4c 49 54 45 5f 44 42 43  r the SQLITE_DBC
10eb0 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49 44 45 20  ONFIG_LOOKASIDE 
10ec0 76 65 72 62 0a 2a 2a 20 6d 61 79 20 62 65 20 4e  verb.** may be N
10ed0 55 4c 4c 20 69 6e 20 77 68 69 63 68 20 63 61 73  ULL in which cas
10ee0 65 20 53 51 4c 69 74 65 20 77 69 6c 6c 20 61 6c  e SQLite will al
10ef0 6c 6f 63 61 74 65 20 74 68 65 0a 2a 2a 20 6c 6f  locate the.** lo
10f00 6f 6b 61 73 69 64 65 20 62 75 66 66 65 72 20 69  okaside buffer i
10f10 74 73 65 6c 66 20 75 73 69 6e 67 20 5b 73 71 6c  tself using [sql
10f20 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 2e 20  ite3_malloc()]. 
10f30 5e 54 68 65 20 73 65 63 6f 6e 64 20 61 72 67 75  ^The second argu
10f40 6d 65 6e 74 20 69 73 20 74 68 65 0a 2a 2a 20 73  ment is the.** s
10f50 69 7a 65 20 6f 66 20 65 61 63 68 20 6c 6f 6f 6b  ize of each look
10f60 61 73 69 64 65 20 62 75 66 66 65 72 20 73 6c 6f  aside buffer slo
10f70 74 2e 20 20 5e 54 68 65 20 74 68 69 72 64 20 61  t.  ^The third a
10f80 72 67 75 6d 65 6e 74 20 69 73 20 74 68 65 20 6e  rgument is the n
10f90 75 6d 62 65 72 20 6f 66 0a 2a 2a 20 73 6c 6f 74  umber of.** slot
10fa0 73 2e 20 20 54 68 65 20 73 69 7a 65 20 6f 66 20  s.  The size of 
10fb0 74 68 65 20 62 75 66 66 65 72 20 69 6e 20 74 68  the buffer in th
10fc0 65 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74  e first argument
10fd0 20 6d 75 73 74 20 62 65 20 67 72 65 61 74 65 72   must be greater
10fe0 20 74 68 61 6e 0a 2a 2a 20 6f 72 20 65 71 75 61   than.** or equa
10ff0 6c 20 74 6f 20 74 68 65 20 70 72 6f 64 75 63 74  l to the product
11000 20 6f 66 20 74 68 65 20 73 65 63 6f 6e 64 20 61   of the second a
11010 6e 64 20 74 68 69 72 64 20 61 72 67 75 6d 65 6e  nd third argumen
11020 74 73 2e 20 20 54 68 65 20 62 75 66 66 65 72 0a  ts.  The buffer.
11030 2a 2a 20 6d 75 73 74 20 62 65 20 61 6c 69 67 6e  ** must be align
11040 65 64 20 74 6f 20 61 6e 20 38 2d 62 79 74 65 20  ed to an 8-byte 
11050 62 6f 75 6e 64 61 72 79 2e 20 20 5e 49 66 20 74  boundary.  ^If t
11060 68 65 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65  he second argume
11070 6e 74 20 74 6f 0a 2a 2a 20 53 51 4c 49 54 45 5f  nt to.** SQLITE_
11080 44 42 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49  DBCONFIG_LOOKASI
11090 44 45 20 69 73 20 6e 6f 74 20 61 20 6d 75 6c 74  DE is not a mult
110a0 69 70 6c 65 20 6f 66 20 38 2c 20 69 74 20 69 73  iple of 8, it is
110b0 20 69 6e 74 65 72 6e 61 6c 6c 79 0a 2a 2a 20 72   internally.** r
110c0 6f 75 6e 64 65 64 20 64 6f 77 6e 20 74 6f 20 74  ounded down to t
110d0 68 65 20 6e 65 78 74 20 73 6d 61 6c 6c 65 72 20  he next smaller 
110e0 6d 75 6c 74 69 70 6c 65 20 6f 66 20 38 2e 20 20  multiple of 8.  
110f0 5e 28 54 68 65 20 6c 6f 6f 6b 61 73 69 64 65 20  ^(The lookaside 
11100 6d 65 6d 6f 72 79 0a 2a 2a 20 63 6f 6e 66 69 67  memory.** config
11110 75 72 61 74 69 6f 6e 20 66 6f 72 20 61 20 64 61  uration for a da
11120 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
11130 6e 20 63 61 6e 20 6f 6e 6c 79 20 62 65 20 63 68  n can only be ch
11140 61 6e 67 65 64 20 77 68 65 6e 20 74 68 61 74 0a  anged when that.
11150 2a 2a 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 69 73  ** connection is
11160 20 6e 6f 74 20 63 75 72 72 65 6e 74 6c 79 20 75   not currently u
11170 73 69 6e 67 20 6c 6f 6f 6b 61 73 69 64 65 20 6d  sing lookaside m
11180 65 6d 6f 72 79 2c 20 6f 72 20 69 6e 20 6f 74 68  emory, or in oth
11190 65 72 20 77 6f 72 64 73 0a 2a 2a 20 77 68 65 6e  er words.** when
111a0 20 74 68 65 20 22 63 75 72 72 65 6e 74 20 76 61   the "current va
111b0 6c 75 65 22 20 72 65 74 75 72 6e 65 64 20 62 79  lue" returned by
111c0 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 64 62 5f  .** [sqlite3_db_
111d0 73 74 61 74 75 73 5d 28 44 2c 5b 53 51 4c 49 54  status](D,[SQLIT
111e0 45 5f 43 4f 4e 46 49 47 5f 4c 4f 4f 4b 41 53 49  E_CONFIG_LOOKASI
111f0 44 45 5d 2c 2e 2e 2e 29 20 69 73 20 7a 65 72 6f  DE],...) is zero
11200 2e 0a 2a 2a 20 41 6e 79 20 61 74 74 65 6d 70 74  ..** Any attempt
11210 20 74 6f 20 63 68 61 6e 67 65 20 74 68 65 20 6c   to change the l
11220 6f 6f 6b 61 73 69 64 65 20 6d 65 6d 6f 72 79 20  ookaside memory 
11230 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 77 68  configuration wh
11240 65 6e 20 6c 6f 6f 6b 61 73 69 64 65 0a 2a 2a 20  en lookaside.** 
11250 6d 65 6d 6f 72 79 20 69 73 20 69 6e 20 75 73 65  memory is in use
11260 20 6c 65 61 76 65 73 20 74 68 65 20 63 6f 6e 66   leaves the conf
11270 69 67 75 72 61 74 69 6f 6e 20 75 6e 63 68 61 6e  iguration unchan
11280 67 65 64 20 61 6e 64 20 72 65 74 75 72 6e 73 20  ged and returns 
11290 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 42 55 53 59  .** [SQLITE_BUSY
112a0 5d 2e 29 5e 3c 2f 64 64 3e 0a 2a 2a 0a 2a 2a 20  ].)^</dd>.**.** 
112b0 3c 2f 64 6c 3e 0a 2a 2f 0a 23 64 65 66 69 6e 65  </dl>.*/.#define
112c0 20 53 51 4c 49 54 45 5f 44 42 43 4f 4e 46 49 47   SQLITE_DBCONFIG
112d0 5f 4c 4f 4f 4b 41 53 49 44 45 20 20 20 20 31 30  _LOOKASIDE    10
112e0 30 31 20 20 2f 2a 20 76 6f 69 64 2a 20 69 6e 74  01  /* void* int
112f0 20 69 6e 74 20 2a 2f 0a 0a 0a 2f 2a 0a 2a 2a 20   int */.../*.** 
11300 43 41 50 49 33 52 45 46 3a 20 45 6e 61 62 6c 65  CAPI3REF: Enable
11310 20 4f 72 20 44 69 73 61 62 6c 65 20 45 78 74 65   Or Disable Exte
11320 6e 64 65 64 20 52 65 73 75 6c 74 20 43 6f 64 65  nded Result Code
11330 73 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  s.**.** ^The sql
11340 69 74 65 33 5f 65 78 74 65 6e 64 65 64 5f 72 65  ite3_extended_re
11350 73 75 6c 74 5f 63 6f 64 65 73 28 29 20 72 6f 75  sult_codes() rou
11360 74 69 6e 65 20 65 6e 61 62 6c 65 73 20 6f 72 20  tine enables or 
11370 64 69 73 61 62 6c 65 73 20 74 68 65 0a 2a 2a 20  disables the.** 
11380 5b 65 78 74 65 6e 64 65 64 20 72 65 73 75 6c 74  [extended result
11390 20 63 6f 64 65 73 5d 20 66 65 61 74 75 72 65 20   codes] feature 
113a0 6f 66 20 53 51 4c 69 74 65 2e 20 5e 54 68 65 20  of SQLite. ^The 
113b0 65 78 74 65 6e 64 65 64 20 72 65 73 75 6c 74 0a  extended result.
113c0 2a 2a 20 63 6f 64 65 73 20 61 72 65 20 64 69 73  ** codes are dis
113d0 61 62 6c 65 64 20 62 79 20 64 65 66 61 75 6c 74  abled by default
113e0 20 66 6f 72 20 68 69 73 74 6f 72 69 63 61 6c 20   for historical 
113f0 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 2e 0a 2a  compatibility..*
11400 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 65 78  /.int sqlite3_ex
11410 74 65 6e 64 65 64 5f 72 65 73 75 6c 74 5f 63 6f  tended_result_co
11420 64 65 73 28 73 71 6c 69 74 65 33 2a 2c 20 69 6e  des(sqlite3*, in
11430 74 20 6f 6e 6f 66 66 29 3b 0a 0a 2f 2a 0a 2a 2a  t onoff);../*.**
11440 20 43 41 50 49 33 52 45 46 3a 20 4c 61 73 74 20   CAPI3REF: Last 
11450 49 6e 73 65 72 74 20 52 6f 77 69 64 0a 2a 2a 0a  Insert Rowid.**.
11460 2a 2a 20 5e 45 61 63 68 20 65 6e 74 72 79 20 69  ** ^Each entry i
11470 6e 20 61 6e 20 53 51 4c 69 74 65 20 74 61 62 6c  n an SQLite tabl
11480 65 20 68 61 73 20 61 20 75 6e 69 71 75 65 20 36  e has a unique 6
11490 34 2d 62 69 74 20 73 69 67 6e 65 64 0a 2a 2a 20  4-bit signed.** 
114a0 69 6e 74 65 67 65 72 20 6b 65 79 20 63 61 6c 6c  integer key call
114b0 65 64 20 74 68 65 20 5b 52 4f 57 49 44 20 7c 20  ed the [ROWID | 
114c0 22 72 6f 77 69 64 22 5d 2e 20 5e 54 68 65 20 72  "rowid"]. ^The r
114d0 6f 77 69 64 20 69 73 20 61 6c 77 61 79 73 20 61  owid is always a
114e0 76 61 69 6c 61 62 6c 65 0a 2a 2a 20 61 73 20 61  vailable.** as a
114f0 6e 20 75 6e 64 65 63 6c 61 72 65 64 20 63 6f 6c  n undeclared col
11500 75 6d 6e 20 6e 61 6d 65 64 20 52 4f 57 49 44 2c  umn named ROWID,
11510 20 4f 49 44 2c 20 6f 72 20 5f 52 4f 57 49 44 5f   OID, or _ROWID_
11520 20 61 73 20 6c 6f 6e 67 20 61 73 20 74 68 6f 73   as long as thos
11530 65 0a 2a 2a 20 6e 61 6d 65 73 20 61 72 65 20 6e  e.** names are n
11540 6f 74 20 61 6c 73 6f 20 75 73 65 64 20 62 79 20  ot also used by 
11550 65 78 70 6c 69 63 69 74 6c 79 20 64 65 63 6c 61  explicitly decla
11560 72 65 64 20 63 6f 6c 75 6d 6e 73 2e 20 5e 49 66  red columns. ^If
11570 0a 2a 2a 20 74 68 65 20 74 61 62 6c 65 20 68 61  .** the table ha
11580 73 20 61 20 63 6f 6c 75 6d 6e 20 6f 66 20 74 79  s a column of ty
11590 70 65 20 5b 49 4e 54 45 47 45 52 20 50 52 49 4d  pe [INTEGER PRIM
115a0 41 52 59 20 4b 45 59 5d 20 74 68 65 6e 20 74 68  ARY KEY] then th
115b0 61 74 20 63 6f 6c 75 6d 6e 0a 2a 2a 20 69 73 20  at column.** is 
115c0 61 6e 6f 74 68 65 72 20 61 6c 69 61 73 20 66 6f  another alias fo
115d0 72 20 74 68 65 20 72 6f 77 69 64 2e 0a 2a 2a 0a  r the rowid..**.
115e0 2a 2a 20 5e 54 68 69 73 20 72 6f 75 74 69 6e 65  ** ^This routine
115f0 20 72 65 74 75 72 6e 73 20 74 68 65 20 5b 72 6f   returns the [ro
11600 77 69 64 5d 20 6f 66 20 74 68 65 20 6d 6f 73 74  wid] of the most
11610 20 72 65 63 65 6e 74 0a 2a 2a 20 73 75 63 63 65   recent.** succe
11620 73 73 66 75 6c 20 5b 49 4e 53 45 52 54 5d 20 69  ssful [INSERT] i
11630 6e 74 6f 20 74 68 65 20 64 61 74 61 62 61 73 65  nto the database
11640 20 66 72 6f 6d 20 74 68 65 20 5b 64 61 74 61 62   from the [datab
11650 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 0a  ase connection].
11660 2a 2a 20 69 6e 20 74 68 65 20 66 69 72 73 74 20  ** in the first 
11670 61 72 67 75 6d 65 6e 74 2e 20 20 5e 49 66 20 6e  argument.  ^If n
11680 6f 20 73 75 63 63 65 73 73 66 75 6c 20 5b 49 4e  o successful [IN
11690 53 45 52 54 5d 73 0a 2a 2a 20 68 61 76 65 20 65  SERT]s.** have e
116a0 76 65 72 20 6f 63 63 75 72 72 65 64 20 6f 6e 20  ver occurred on 
116b0 74 68 61 74 20 64 61 74 61 62 61 73 65 20 63 6f  that database co
116c0 6e 6e 65 63 74 69 6f 6e 2c 20 7a 65 72 6f 20 69  nnection, zero i
116d0 73 20 72 65 74 75 72 6e 65 64 2e 0a 2a 2a 0a 2a  s returned..**.*
116e0 2a 20 5e 28 49 66 20 61 6e 20 5b 49 4e 53 45 52  * ^(If an [INSER
116f0 54 5d 20 6f 63 63 75 72 73 20 77 69 74 68 69 6e  T] occurs within
11700 20 61 20 74 72 69 67 67 65 72 2c 20 74 68 65 6e   a trigger, then
11710 20 74 68 65 20 5b 72 6f 77 69 64 5d 20 6f 66 20   the [rowid] of 
11720 74 68 65 20 69 6e 73 65 72 74 65 64 0a 2a 2a 20  the inserted.** 
11730 72 6f 77 20 69 73 20 72 65 74 75 72 6e 65 64 20  row is returned 
11740 62 79 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20  by this routine 
11750 61 73 20 6c 6f 6e 67 20 61 73 20 74 68 65 20 74  as long as the t
11760 72 69 67 67 65 72 20 69 73 20 72 75 6e 6e 69 6e  rigger is runnin
11770 67 2e 0a 2a 2a 20 42 75 74 20 6f 6e 63 65 20 74  g..** But once t
11780 68 65 20 74 72 69 67 67 65 72 20 74 65 72 6d 69  he trigger termi
11790 6e 61 74 65 73 2c 20 74 68 65 20 76 61 6c 75 65  nates, the value
117a0 20 72 65 74 75 72 6e 65 64 20 62 79 20 74 68 69   returned by thi
117b0 73 20 72 6f 75 74 69 6e 65 0a 2a 2a 20 72 65 76  s routine.** rev
117c0 65 72 74 73 20 74 6f 20 74 68 65 20 6c 61 73 74  erts to the last
117d0 20 76 61 6c 75 65 20 69 6e 73 65 72 74 65 64 20   value inserted 
117e0 62 65 66 6f 72 65 20 74 68 65 20 74 72 69 67 67  before the trigg
117f0 65 72 20 66 69 72 65 64 2e 29 5e 0a 2a 2a 0a 2a  er fired.)^.**.*
11800 2a 20 5e 41 6e 20 5b 49 4e 53 45 52 54 5d 20 74  * ^An [INSERT] t
11810 68 61 74 20 66 61 69 6c 73 20 64 75 65 20 74 6f  hat fails due to
11820 20 61 20 63 6f 6e 73 74 72 61 69 6e 74 20 76 69   a constraint vi
11830 6f 6c 61 74 69 6f 6e 20 69 73 20 6e 6f 74 20 61  olation is not a
11840 0a 2a 2a 20 73 75 63 63 65 73 73 66 75 6c 20 5b  .** successful [
11850 49 4e 53 45 52 54 5d 20 61 6e 64 20 64 6f 65 73  INSERT] and does
11860 20 6e 6f 74 20 63 68 61 6e 67 65 20 74 68 65 20   not change the 
11870 76 61 6c 75 65 20 72 65 74 75 72 6e 65 64 20 62  value returned b
11880 79 20 74 68 69 73 0a 2a 2a 20 72 6f 75 74 69 6e  y this.** routin
11890 65 2e 20 20 5e 54 68 75 73 20 49 4e 53 45 52 54  e.  ^Thus INSERT
118a0 20 4f 52 20 46 41 49 4c 2c 20 49 4e 53 45 52 54   OR FAIL, INSERT
118b0 20 4f 52 20 49 47 4e 4f 52 45 2c 20 49 4e 53 45   OR IGNORE, INSE
118c0 52 54 20 4f 52 20 52 4f 4c 4c 42 41 43 4b 2c 0a  RT OR ROLLBACK,.
118d0 2a 2a 20 61 6e 64 20 49 4e 53 45 52 54 20 4f 52  ** and INSERT OR
118e0 20 41 42 4f 52 54 20 6d 61 6b 65 20 6e 6f 20 63   ABORT make no c
118f0 68 61 6e 67 65 73 20 74 6f 20 74 68 65 20 72 65  hanges to the re
11900 74 75 72 6e 20 76 61 6c 75 65 20 6f 66 20 74 68  turn value of th
11910 69 73 0a 2a 2a 20 72 6f 75 74 69 6e 65 20 77 68  is.** routine wh
11920 65 6e 20 74 68 65 69 72 20 69 6e 73 65 72 74 69  en their inserti
11930 6f 6e 20 66 61 69 6c 73 2e 20 20 5e 28 57 68 65  on fails.  ^(Whe
11940 6e 20 49 4e 53 45 52 54 20 4f 52 20 52 45 50 4c  n INSERT OR REPL
11950 41 43 45 0a 2a 2a 20 65 6e 63 6f 75 6e 74 65 72  ACE.** encounter
11960 73 20 61 20 63 6f 6e 73 74 72 61 69 6e 74 20 76  s a constraint v
11970 69 6f 6c 61 74 69 6f 6e 2c 20 69 74 20 64 6f 65  iolation, it doe
11980 73 20 6e 6f 74 20 66 61 69 6c 2e 20 20 54 68 65  s not fail.  The
11990 0a 2a 2a 20 49 4e 53 45 52 54 20 63 6f 6e 74 69  .** INSERT conti
119a0 6e 75 65 73 20 74 6f 20 63 6f 6d 70 6c 65 74 69  nues to completi
119b0 6f 6e 20 61 66 74 65 72 20 64 65 6c 65 74 69 6e  on after deletin
119c0 67 20 72 6f 77 73 20 74 68 61 74 20 63 61 75 73  g rows that caus
119d0 65 64 0a 2a 2a 20 74 68 65 20 63 6f 6e 73 74 72  ed.** the constr
119e0 61 69 6e 74 20 70 72 6f 62 6c 65 6d 20 73 6f 20  aint problem so 
119f0 49 4e 53 45 52 54 20 4f 52 20 52 45 50 4c 41 43  INSERT OR REPLAC
11a00 45 20 77 69 6c 6c 20 61 6c 77 61 79 73 20 63 68  E will always ch
11a10 61 6e 67 65 0a 2a 2a 20 74 68 65 20 72 65 74 75  ange.** the retu
11a20 72 6e 20 76 61 6c 75 65 20 6f 66 20 74 68 69 73  rn value of this
11a30 20 69 6e 74 65 72 66 61 63 65 2e 29 5e 0a 2a 2a   interface.)^.**
11a40 0a 2a 2a 20 5e 46 6f 72 20 74 68 65 20 70 75 72  .** ^For the pur
11a50 70 6f 73 65 73 20 6f 66 20 74 68 69 73 20 72 6f  poses of this ro
11a60 75 74 69 6e 65 2c 20 61 6e 20 5b 49 4e 53 45 52  utine, an [INSER
11a70 54 5d 20 69 73 20 63 6f 6e 73 69 64 65 72 65 64  T] is considered
11a80 20 74 6f 0a 2a 2a 20 62 65 20 73 75 63 63 65 73   to.** be succes
11a90 73 66 75 6c 20 65 76 65 6e 20 69 66 20 69 74 20  sful even if it 
11aa0 69 73 20 73 75 62 73 65 71 75 65 6e 74 6c 79 20  is subsequently 
11ab0 72 6f 6c 6c 65 64 20 62 61 63 6b 2e 0a 2a 2a 0a  rolled back..**.
11ac0 2a 2a 20 54 68 69 73 20 66 75 6e 63 74 69 6f 6e  ** This function
11ad0 20 69 73 20 61 63 63 65 73 73 69 62 6c 65 20 74   is accessible t
11ae0 6f 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 73  o SQL statements
11af0 20 76 69 61 20 74 68 65 0a 2a 2a 20 5b 6c 61 73   via the.** [las
11b00 74 5f 69 6e 73 65 72 74 5f 72 6f 77 69 64 28 29  t_insert_rowid()
11b10 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 5d 2e 0a   SQL function]..
11b20 2a 2a 0a 2a 2a 20 49 66 20 61 20 73 65 70 61 72  **.** If a separ
11b30 61 74 65 20 74 68 72 65 61 64 20 70 65 72 66 6f  ate thread perfo
11b40 72 6d 73 20 61 20 6e 65 77 20 5b 49 4e 53 45 52  rms a new [INSER
11b50 54 5d 20 6f 6e 20 74 68 65 20 73 61 6d 65 0a 2a  T] on the same.*
11b60 2a 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65  * database conne
11b70 63 74 69 6f 6e 20 77 68 69 6c 65 20 74 68 65 20  ction while the 
11b80 5b 73 71 6c 69 74 65 33 5f 6c 61 73 74 5f 69 6e  [sqlite3_last_in
11b90 73 65 72 74 5f 72 6f 77 69 64 28 29 5d 0a 2a 2a  sert_rowid()].**
11ba0 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 72 75 6e   function is run
11bb0 6e 69 6e 67 20 61 6e 64 20 74 68 75 73 20 63 68  ning and thus ch
11bc0 61 6e 67 65 73 20 74 68 65 20 6c 61 73 74 20 69  anges the last i
11bd0 6e 73 65 72 74 20 5b 72 6f 77 69 64 5d 2c 0a 2a  nsert [rowid],.*
11be0 2a 20 74 68 65 6e 20 74 68 65 20 76 61 6c 75 65  * then the value
11bf0 20 72 65 74 75 72 6e 65 64 20 62 79 20 5b 73 71   returned by [sq
11c00 6c 69 74 65 33 5f 6c 61 73 74 5f 69 6e 73 65 72  lite3_last_inser
11c10 74 5f 72 6f 77 69 64 28 29 5d 20 69 73 0a 2a 2a  t_rowid()] is.**
11c20 20 75 6e 70 72 65 64 69 63 74 61 62 6c 65 20 61   unpredictable a
11c30 6e 64 20 6d 69 67 68 74 20 6e 6f 74 20 65 71 75  nd might not equ
11c40 61 6c 20 65 69 74 68 65 72 20 74 68 65 20 6f 6c  al either the ol
11c50 64 20 6f 72 20 74 68 65 20 6e 65 77 0a 2a 2a 20  d or the new.** 
11c60 6c 61 73 74 20 69 6e 73 65 72 74 20 5b 72 6f 77  last insert [row
11c70 69 64 5d 2e 0a 2a 2f 0a 73 71 6c 69 74 65 33 5f  id]..*/.sqlite3_
11c80 69 6e 74 36 34 20 73 71 6c 69 74 65 33 5f 6c 61  int64 sqlite3_la
11c90 73 74 5f 69 6e 73 65 72 74 5f 72 6f 77 69 64 28  st_insert_rowid(
11ca0 73 71 6c 69 74 65 33 2a 29 3b 0a 0a 2f 2a 0a 2a  sqlite3*);../*.*
11cb0 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6f 75 6e  * CAPI3REF: Coun
11cc0 74 20 54 68 65 20 4e 75 6d 62 65 72 20 4f 66 20  t The Number Of 
11cd0 52 6f 77 73 20 4d 6f 64 69 66 69 65 64 0a 2a 2a  Rows Modified.**
11ce0 0a 2a 2a 20 5e 54 68 69 73 20 66 75 6e 63 74 69  .** ^This functi
11cf0 6f 6e 20 72 65 74 75 72 6e 73 20 74 68 65 20 6e  on returns the n
11d00 75 6d 62 65 72 20 6f 66 20 64 61 74 61 62 61 73  umber of databas
11d10 65 20 72 6f 77 73 20 74 68 61 74 20 77 65 72 65  e rows that were
11d20 20 63 68 61 6e 67 65 64 0a 2a 2a 20 6f 72 20 69   changed.** or i
11d30 6e 73 65 72 74 65 64 20 6f 72 20 64 65 6c 65 74  nserted or delet
11d40 65 64 20 62 79 20 74 68 65 20 6d 6f 73 74 20 72  ed by the most r
11d50 65 63 65 6e 74 6c 79 20 63 6f 6d 70 6c 65 74 65  ecently complete
11d60 64 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 0a  d SQL statement.
11d70 2a 2a 20 6f 6e 20 74 68 65 20 5b 64 61 74 61 62  ** on the [datab
11d80 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20  ase connection] 
11d90 73 70 65 63 69 66 69 65 64 20 62 79 20 74 68 65  specified by the
11da0 20 66 69 72 73 74 20 70 61 72 61 6d 65 74 65 72   first parameter
11db0 2e 0a 2a 2a 20 5e 28 4f 6e 6c 79 20 63 68 61 6e  ..** ^(Only chan
11dc0 67 65 73 20 74 68 61 74 20 61 72 65 20 64 69 72  ges that are dir
11dd0 65 63 74 6c 79 20 73 70 65 63 69 66 69 65 64 20  ectly specified 
11de0 62 79 20 74 68 65 20 5b 49 4e 53 45 52 54 5d 2c  by the [INSERT],
11df0 20 5b 55 50 44 41 54 45 5d 2c 0a 2a 2a 20 6f 72   [UPDATE],.** or
11e00 20 5b 44 45 4c 45 54 45 5d 20 73 74 61 74 65 6d   [DELETE] statem
11e10 65 6e 74 20 61 72 65 20 63 6f 75 6e 74 65 64 2e  ent are counted.
11e20 20 20 41 75 78 69 6c 69 61 72 79 20 63 68 61 6e    Auxiliary chan
11e30 67 65 73 20 63 61 75 73 65 64 20 62 79 0a 2a 2a  ges caused by.**
11e40 20 74 72 69 67 67 65 72 73 20 6f 72 20 5b 66 6f   triggers or [fo
11e50 72 65 69 67 6e 20 6b 65 79 20 61 63 74 69 6f 6e  reign key action
11e60 73 5d 20 61 72 65 20 6e 6f 74 20 63 6f 75 6e 74  s] are not count
11e70 65 64 2e 29 5e 20 55 73 65 20 74 68 65 0a 2a 2a  ed.)^ Use the.**
11e80 20 5b 73 71 6c 69 74 65 33 5f 74 6f 74 61 6c 5f   [sqlite3_total_
11e90 63 68 61 6e 67 65 73 28 29 5d 20 66 75 6e 63 74  changes()] funct
11ea0 69 6f 6e 20 74 6f 20 66 69 6e 64 20 74 68 65 20  ion to find the 
11eb0 74 6f 74 61 6c 20 6e 75 6d 62 65 72 20 6f 66 20  total number of 
11ec0 63 68 61 6e 67 65 73 0a 2a 2a 20 69 6e 63 6c 75  changes.** inclu
11ed0 64 69 6e 67 20 63 68 61 6e 67 65 73 20 63 61 75  ding changes cau
11ee0 73 65 64 20 62 79 20 74 72 69 67 67 65 72 73 20  sed by triggers 
11ef0 61 6e 64 20 66 6f 72 65 69 67 6e 20 6b 65 79 20  and foreign key 
11f00 61 63 74 69 6f 6e 73 2e 0a 2a 2a 0a 2a 2a 20 5e  actions..**.** ^
11f10 43 68 61 6e 67 65 73 20 74 6f 20 61 20 76 69 65  Changes to a vie
11f20 77 20 74 68 61 74 20 61 72 65 20 73 69 6d 75 6c  w that are simul
11f30 61 74 65 64 20 62 79 20 61 6e 20 5b 49 4e 53 54  ated by an [INST
11f40 45 41 44 20 4f 46 20 74 72 69 67 67 65 72 5d 0a  EAD OF trigger].
11f50 2a 2a 20 61 72 65 20 6e 6f 74 20 63 6f 75 6e 74  ** are not count
11f60 65 64 2e 20 20 4f 6e 6c 79 20 72 65 61 6c 20 74  ed.  Only real t
11f70 61 62 6c 65 20 63 68 61 6e 67 65 73 20 61 72 65  able changes are
11f80 20 63 6f 75 6e 74 65 64 2e 0a 2a 2a 0a 2a 2a 20   counted..**.** 
11f90 5e 28 41 20 22 72 6f 77 20 63 68 61 6e 67 65 22  ^(A "row change"
11fa0 20 69 73 20 61 20 63 68 61 6e 67 65 20 74 6f 20   is a change to 
11fb0 61 20 73 69 6e 67 6c 65 20 72 6f 77 20 6f 66 20  a single row of 
11fc0 61 20 73 69 6e 67 6c 65 20 74 61 62 6c 65 0a 2a  a single table.*
11fd0 2a 20 63 61 75 73 65 64 20 62 79 20 61 6e 20 49  * caused by an I
11fe0 4e 53 45 52 54 2c 20 44 45 4c 45 54 45 2c 20 6f  NSERT, DELETE, o
11ff0 72 20 55 50 44 41 54 45 20 73 74 61 74 65 6d 65  r UPDATE stateme
12000 6e 74 2e 20 20 52 6f 77 73 20 74 68 61 74 0a 2a  nt.  Rows that.*
12010 2a 20 61 72 65 20 63 68 61 6e 67 65 64 20 61 73  * are changed as
12020 20 73 69 64 65 20 65 66 66 65 63 74 73 20 6f 66   side effects of
12030 20 5b 52 45 50 4c 41 43 45 5d 20 63 6f 6e 73 74   [REPLACE] const
12040 72 61 69 6e 74 20 72 65 73 6f 6c 75 74 69 6f 6e  raint resolution
12050 2c 0a 2a 2a 20 72 6f 6c 6c 62 61 63 6b 2c 20 41  ,.** rollback, A
12060 42 4f 52 54 20 70 72 6f 63 65 73 73 69 6e 67 2c  BORT processing,
12070 20 5b 44 52 4f 50 20 54 41 42 4c 45 5d 2c 20 6f   [DROP TABLE], o
12080 72 20 62 79 20 61 6e 79 20 6f 74 68 65 72 0a 2a  r by any other.*
12090 2a 20 6d 65 63 68 61 6e 69 73 6d 73 20 64 6f 20  * mechanisms do 
120a0 6e 6f 74 20 63 6f 75 6e 74 20 61 73 20 64 69 72  not count as dir
120b0 65 63 74 20 72 6f 77 20 63 68 61 6e 67 65 73 2e  ect row changes.
120c0 29 5e 0a 2a 2a 0a 2a 2a 20 41 20 22 74 72 69 67  )^.**.** A "trig
120d0 67 65 72 20 63 6f 6e 74 65 78 74 22 20 69 73 20  ger context" is 
120e0 61 20 73 63 6f 70 65 20 6f 66 20 65 78 65 63 75  a scope of execu
120f0 74 69 6f 6e 20 74 68 61 74 20 62 65 67 69 6e 73  tion that begins
12100 20 61 6e 64 0a 2a 2a 20 65 6e 64 73 20 77 69 74   and.** ends wit
12110 68 20 74 68 65 20 73 63 72 69 70 74 20 6f 66 20  h the script of 
12120 61 20 5b 43 52 45 41 54 45 20 54 52 49 47 47 45  a [CREATE TRIGGE
12130 52 20 7c 20 74 72 69 67 67 65 72 5d 2e 20 0a 2a  R | trigger]. .*
12140 2a 20 4d 6f 73 74 20 53 51 4c 20 73 74 61 74 65  * Most SQL state
12150 6d 65 6e 74 73 20 61 72 65 0a 2a 2a 20 65 76 61  ments are.** eva
12160 6c 75 61 74 65 64 20 6f 75 74 73 69 64 65 20 6f  luated outside o
12170 66 20 61 6e 79 20 74 72 69 67 67 65 72 2e 20 20  f any trigger.  
12180 54 68 69 73 20 69 73 20 74 68 65 20 22 74 6f 70  This is the "top
12190 20 6c 65 76 65 6c 22 0a 2a 2a 20 74 72 69 67 67   level".** trigg
121a0 65 72 20 63 6f 6e 74 65 78 74 2e 20 20 49 66 20  er context.  If 
121b0 61 20 74 72 69 67 67 65 72 20 66 69 72 65 73 20  a trigger fires 
121c0 66 72 6f 6d 20 74 68 65 20 74 6f 70 20 6c 65 76  from the top lev
121d0 65 6c 2c 20 61 0a 2a 2a 20 6e 65 77 20 74 72 69  el, a.** new tri
121e0 67 67 65 72 20 63 6f 6e 74 65 78 74 20 69 73 20  gger context is 
121f0 65 6e 74 65 72 65 64 20 66 6f 72 20 74 68 65 20  entered for the 
12200 64 75 72 61 74 69 6f 6e 20 6f 66 20 74 68 61 74  duration of that
12210 20 6f 6e 65 0a 2a 2a 20 74 72 69 67 67 65 72 2e   one.** trigger.
12220 20 20 53 75 62 74 72 69 67 67 65 72 73 20 63 72    Subtriggers cr
12230 65 61 74 65 20 73 75 62 63 6f 6e 74 65 78 74 73  eate subcontexts
12240 20 66 6f 72 20 74 68 65 69 72 20 64 75 72 61 74   for their durat
12250 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 43 61 6c 6c  ion..**.** ^Call
12260 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 65 78 65  ing [sqlite3_exe
12270 63 28 29 5d 20 6f 72 20 5b 73 71 6c 69 74 65 33  c()] or [sqlite3
12280 5f 73 74 65 70 28 29 5d 20 72 65 63 75 72 73 69  _step()] recursi
12290 76 65 6c 79 20 64 6f 65 73 0a 2a 2a 20 6e 6f 74  vely does.** not
122a0 20 63 72 65 61 74 65 20 61 20 6e 65 77 20 74 72   create a new tr
122b0 69 67 67 65 72 20 63 6f 6e 74 65 78 74 2e 0a 2a  igger context..*
122c0 2a 0a 2a 2a 20 5e 54 68 69 73 20 66 75 6e 63 74  *.** ^This funct
122d0 69 6f 6e 20 72 65 74 75 72 6e 73 20 74 68 65 20  ion returns the 
122e0 6e 75 6d 62 65 72 20 6f 66 20 64 69 72 65 63 74  number of direct
122f0 20 72 6f 77 20 63 68 61 6e 67 65 73 20 69 6e 20   row changes in 
12300 74 68 65 0a 2a 2a 20 6d 6f 73 74 20 72 65 63 65  the.** most rece
12310 6e 74 20 49 4e 53 45 52 54 2c 20 55 50 44 41 54  nt INSERT, UPDAT
12320 45 2c 20 6f 72 20 44 45 4c 45 54 45 20 73 74 61  E, or DELETE sta
12330 74 65 6d 65 6e 74 20 77 69 74 68 69 6e 20 74 68  tement within th
12340 65 20 73 61 6d 65 0a 2a 2a 20 74 72 69 67 67 65  e same.** trigge
12350 72 20 63 6f 6e 74 65 78 74 2e 0a 2a 2a 0a 2a 2a  r context..**.**
12360 20 5e 54 68 75 73 2c 20 77 68 65 6e 20 63 61 6c   ^Thus, when cal
12370 6c 65 64 20 66 72 6f 6d 20 74 68 65 20 74 6f 70  led from the top
12380 20 6c 65 76 65 6c 2c 20 74 68 69 73 20 66 75 6e   level, this fun
12390 63 74 69 6f 6e 20 72 65 74 75 72 6e 73 20 74 68  ction returns th
123a0 65 0a 2a 2a 20 6e 75 6d 62 65 72 20 6f 66 20 63  e.** number of c
123b0 68 61 6e 67 65 73 20 69 6e 20 74 68 65 20 6d 6f  hanges in the mo
123c0 73 74 20 72 65 63 65 6e 74 20 49 4e 53 45 52 54  st recent INSERT
123d0 2c 20 55 50 44 41 54 45 2c 20 6f 72 20 44 45 4c  , UPDATE, or DEL
123e0 45 54 45 0a 2a 2a 20 74 68 61 74 20 61 6c 73 6f  ETE.** that also
123f0 20 6f 63 63 75 72 72 65 64 20 61 74 20 74 68 65   occurred at the
12400 20 74 6f 70 20 6c 65 76 65 6c 2e 20 20 5e 28 57   top level.  ^(W
12410 69 74 68 69 6e 20 74 68 65 20 62 6f 64 79 20 6f  ithin the body o
12420 66 20 61 20 74 72 69 67 67 65 72 2c 0a 2a 2a 20  f a trigger,.** 
12430 74 68 65 20 73 71 6c 69 74 65 33 5f 63 68 61 6e  the sqlite3_chan
12440 67 65 73 28 29 20 69 6e 74 65 72 66 61 63 65 20  ges() interface 
12450 63 61 6e 20 62 65 20 63 61 6c 6c 65 64 20 74 6f  can be called to
12460 20 66 69 6e 64 20 74 68 65 20 6e 75 6d 62 65 72   find the number
12470 20 6f 66 0a 2a 2a 20 63 68 61 6e 67 65 73 20 69   of.** changes i
12480 6e 20 74 68 65 20 6d 6f 73 74 20 72 65 63 65 6e  n the most recen
12490 74 6c 79 20 63 6f 6d 70 6c 65 74 65 64 20 49 4e  tly completed IN
124a0 53 45 52 54 2c 20 55 50 44 41 54 45 2c 20 6f 72  SERT, UPDATE, or
124b0 20 44 45 4c 45 54 45 0a 2a 2a 20 73 74 61 74 65   DELETE.** state
124c0 6d 65 6e 74 20 77 69 74 68 69 6e 20 74 68 65 20  ment within the 
124d0 62 6f 64 79 20 6f 66 20 74 68 65 20 73 61 6d 65  body of the same
124e0 20 74 72 69 67 67 65 72 2e 0a 2a 2a 20 48 6f 77   trigger..** How
124f0 65 76 65 72 2c 20 74 68 65 20 6e 75 6d 62 65 72  ever, the number
12500 20 72 65 74 75 72 6e 65 64 20 64 6f 65 73 20 6e   returned does n
12510 6f 74 20 69 6e 63 6c 75 64 65 20 63 68 61 6e 67  ot include chang
12520 65 73 0a 2a 2a 20 63 61 75 73 65 64 20 62 79 20  es.** caused by 
12530 73 75 62 74 72 69 67 67 65 72 73 20 73 69 6e 63  subtriggers sinc
12540 65 20 74 68 6f 73 65 20 68 61 76 65 20 74 68 65  e those have the
12550 69 72 20 6f 77 6e 20 63 6f 6e 74 65 78 74 2e 29  ir own context.)
12560 5e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f  ^.**.** See also
12570 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 74 6f   the [sqlite3_to
12580 74 61 6c 5f 63 68 61 6e 67 65 73 28 29 5d 20 69  tal_changes()] i
12590 6e 74 65 72 66 61 63 65 2c 20 74 68 65 0a 2a 2a  nterface, the.**
125a0 20 5b 63 6f 75 6e 74 5f 63 68 61 6e 67 65 73 20   [count_changes 
125b0 70 72 61 67 6d 61 5d 2c 20 61 6e 64 20 74 68 65  pragma], and the
125c0 20 5b 63 68 61 6e 67 65 73 28 29 20 53 51 4c 20   [changes() SQL 
125d0 66 75 6e 63 74 69 6f 6e 5d 2e 0a 2a 2a 0a 2a 2a  function]..**.**
125e0 20 49 66 20 61 20 73 65 70 61 72 61 74 65 20 74   If a separate t
125f0 68 72 65 61 64 20 6d 61 6b 65 73 20 63 68 61 6e  hread makes chan
12600 67 65 73 20 6f 6e 20 74 68 65 20 73 61 6d 65 20  ges on the same 
12610 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
12620 69 6f 6e 0a 2a 2a 20 77 68 69 6c 65 20 5b 73 71  ion.** while [sq
12630 6c 69 74 65 33 5f 63 68 61 6e 67 65 73 28 29 5d  lite3_changes()]
12640 20 69 73 20 72 75 6e 6e 69 6e 67 20 74 68 65 6e   is running then
12650 20 74 68 65 20 76 61 6c 75 65 20 72 65 74 75 72   the value retur
12660 6e 65 64 0a 2a 2a 20 69 73 20 75 6e 70 72 65 64  ned.** is unpred
12670 69 63 74 61 62 6c 65 20 61 6e 64 20 6e 6f 74 20  ictable and not 
12680 6d 65 61 6e 69 6e 67 66 75 6c 2e 0a 2a 2f 0a 69  meaningful..*/.i
12690 6e 74 20 73 71 6c 69 74 65 33 5f 63 68 61 6e 67  nt sqlite3_chang
126a0 65 73 28 73 71 6c 69 74 65 33 2a 29 3b 0a 0a 2f  es(sqlite3*);../
126b0 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 54  *.** CAPI3REF: T
126c0 6f 74 61 6c 20 4e 75 6d 62 65 72 20 4f 66 20 52  otal Number Of R
126d0 6f 77 73 20 4d 6f 64 69 66 69 65 64 0a 2a 2a 0a  ows Modified.**.
126e0 2a 2a 20 5e 54 68 69 73 20 66 75 6e 63 74 69 6f  ** ^This functio
126f0 6e 20 72 65 74 75 72 6e 73 20 74 68 65 20 6e 75  n returns the nu
12700 6d 62 65 72 20 6f 66 20 72 6f 77 20 63 68 61 6e  mber of row chan
12710 67 65 73 20 63 61 75 73 65 64 20 62 79 20 5b 49  ges caused by [I
12720 4e 53 45 52 54 5d 2c 0a 2a 2a 20 5b 55 50 44 41  NSERT],.** [UPDA
12730 54 45 5d 20 6f 72 20 5b 44 45 4c 45 54 45 5d 20  TE] or [DELETE] 
12740 73 74 61 74 65 6d 65 6e 74 73 20 73 69 6e 63 65  statements since
12750 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20 63   the [database c
12760 6f 6e 6e 65 63 74 69 6f 6e 5d 20 77 61 73 20 6f  onnection] was o
12770 70 65 6e 65 64 2e 0a 2a 2a 20 5e 28 54 68 65 20  pened..** ^(The 
12780 63 6f 75 6e 74 20 72 65 74 75 72 6e 65 64 20 62  count returned b
12790 79 20 73 71 6c 69 74 65 33 5f 74 6f 74 61 6c 5f  y sqlite3_total_
127a0 63 68 61 6e 67 65 73 28 29 20 69 6e 63 6c 75 64  changes() includ
127b0 65 73 20 61 6c 6c 20 63 68 61 6e 67 65 73 0a 2a  es all changes.*
127c0 2a 20 66 72 6f 6d 20 61 6c 6c 20 5b 43 52 45 41  * from all [CREA
127d0 54 45 20 54 52 49 47 47 45 52 20 7c 20 74 72 69  TE TRIGGER | tri
127e0 67 67 65 72 5d 20 63 6f 6e 74 65 78 74 73 20 61  gger] contexts a
127f0 6e 64 20 63 68 61 6e 67 65 73 20 6d 61 64 65 20  nd changes made 
12800 62 79 0a 2a 2a 20 5b 66 6f 72 65 69 67 6e 20 6b  by.** [foreign k
12810 65 79 20 61 63 74 69 6f 6e 73 5d 2e 20 48 6f 77  ey actions]. How
12820 65 76 65 72 2c 0a 2a 2a 20 74 68 65 20 63 6f 75  ever,.** the cou
12830 6e 74 20 64 6f 65 73 20 6e 6f 74 20 69 6e 63 6c  nt does not incl
12840 75 64 65 20 63 68 61 6e 67 65 73 20 75 73 65 64  ude changes used
12850 20 74 6f 20 69 6d 70 6c 65 6d 65 6e 74 20 5b 52   to implement [R
12860 45 50 4c 41 43 45 5d 20 63 6f 6e 73 74 72 61 69  EPLACE] constrai
12870 6e 74 73 2c 0a 2a 2a 20 64 6f 20 72 6f 6c 6c 62  nts,.** do rollb
12880 61 63 6b 73 20 6f 72 20 41 42 4f 52 54 20 70 72  acks or ABORT pr
12890 6f 63 65 73 73 69 6e 67 2c 20 6f 72 20 5b 44 52  ocessing, or [DR
128a0 4f 50 20 54 41 42 4c 45 5d 20 70 72 6f 63 65 73  OP TABLE] proces
128b0 73 69 6e 67 2e 20 20 54 68 65 0a 2a 2a 20 63 6f  sing.  The.** co
128c0 75 6e 74 20 64 6f 65 73 20 6e 6f 74 20 69 6e 63  unt does not inc
128d0 6c 75 64 65 20 72 6f 77 73 20 6f 66 20 76 69 65  lude rows of vie
128e0 77 73 20 74 68 61 74 20 66 69 72 65 20 61 6e 20  ws that fire an 
128f0 5b 49 4e 53 54 45 41 44 20 4f 46 20 74 72 69 67  [INSTEAD OF trig
12900 67 65 72 5d 2c 0a 2a 2a 20 74 68 6f 75 67 68 20  ger],.** though 
12910 69 66 20 74 68 65 20 49 4e 53 54 45 41 44 20 4f  if the INSTEAD O
12920 46 20 74 72 69 67 67 65 72 20 6d 61 6b 65 73 20  F trigger makes 
12930 63 68 61 6e 67 65 73 20 6f 66 20 69 74 73 20 6f  changes of its o
12940 77 6e 2c 20 74 68 6f 73 65 20 63 68 61 6e 67 65  wn, those change
12950 73 20 0a 2a 2a 20 61 72 65 20 63 6f 75 6e 74 65  s .** are counte
12960 64 2e 29 5e 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  d.)^.** ^The sql
12970 69 74 65 33 5f 74 6f 74 61 6c 5f 63 68 61 6e 67  ite3_total_chang
12980 65 73 28 29 20 66 75 6e 63 74 69 6f 6e 20 63 6f  es() function co
12990 75 6e 74 73 20 74 68 65 20 63 68 61 6e 67 65 73  unts the changes
129a0 20 61 73 20 73 6f 6f 6e 20 61 73 0a 2a 2a 20 74   as soon as.** t
129b0 68 65 20 73 74 61 74 65 6d 65 6e 74 20 74 68 61  he statement tha
129c0 74 20 6d 61 6b 65 73 20 74 68 65 6d 20 69 73 20  t makes them is 
129d0 63 6f 6d 70 6c 65 74 65 64 20 28 77 68 65 6e 20  completed (when 
129e0 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20 68 61  the statement ha
129f0 6e 64 6c 65 0a 2a 2a 20 69 73 20 70 61 73 73 65  ndle.** is passe
12a00 64 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 72 65  d to [sqlite3_re
12a10 73 65 74 28 29 5d 20 6f 72 20 5b 73 71 6c 69 74  set()] or [sqlit
12a20 65 33 5f 66 69 6e 61 6c 69 7a 65 28 29 5d 29 2e  e3_finalize()]).
12a30 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 20  .**.** See also 
12a40 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 63 68 61  the [sqlite3_cha
12a50 6e 67 65 73 28 29 5d 20 69 6e 74 65 72 66 61 63  nges()] interfac
12a60 65 2c 20 74 68 65 0a 2a 2a 20 5b 63 6f 75 6e 74  e, the.** [count
12a70 5f 63 68 61 6e 67 65 73 20 70 72 61 67 6d 61 5d  _changes pragma]
12a80 2c 20 61 6e 64 20 74 68 65 20 5b 74 6f 74 61 6c  , and the [total
12a90 5f 63 68 61 6e 67 65 73 28 29 20 53 51 4c 20 66  _changes() SQL f
12aa0 75 6e 63 74 69 6f 6e 5d 2e 0a 2a 2a 0a 2a 2a 20  unction]..**.** 
12ab0 49 66 20 61 20 73 65 70 61 72 61 74 65 20 74 68  If a separate th
12ac0 72 65 61 64 20 6d 61 6b 65 73 20 63 68 61 6e 67  read makes chang
12ad0 65 73 20 6f 6e 20 74 68 65 20 73 61 6d 65 20 64  es on the same d
12ae0 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
12af0 6f 6e 0a 2a 2a 20 77 68 69 6c 65 20 5b 73 71 6c  on.** while [sql
12b00 69 74 65 33 5f 74 6f 74 61 6c 5f 63 68 61 6e 67  ite3_total_chang
12b10 65 73 28 29 5d 20 69 73 20 72 75 6e 6e 69 6e 67  es()] is running
12b20 20 74 68 65 6e 20 74 68 65 20 76 61 6c 75 65 0a   then the value.
12b30 2a 2a 20 72 65 74 75 72 6e 65 64 20 69 73 20 75  ** returned is u
12b40 6e 70 72 65 64 69 63 74 61 62 6c 65 20 61 6e 64  npredictable and
12b50 20 6e 6f 74 20 6d 65 61 6e 69 6e 67 66 75 6c 2e   not meaningful.
12b60 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .*/.int sqlite3_
12b70 74 6f 74 61 6c 5f 63 68 61 6e 67 65 73 28 73 71  total_changes(sq
12b80 6c 69 74 65 33 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20  lite3*);../*.** 
12b90 43 41 50 49 33 52 45 46 3a 20 49 6e 74 65 72 72  CAPI3REF: Interr
12ba0 75 70 74 20 41 20 4c 6f 6e 67 2d 52 75 6e 6e 69  upt A Long-Runni
12bb0 6e 67 20 51 75 65 72 79 0a 2a 2a 0a 2a 2a 20 5e  ng Query.**.** ^
12bc0 54 68 69 73 20 66 75 6e 63 74 69 6f 6e 20 63 61  This function ca
12bd0 75 73 65 73 20 61 6e 79 20 70 65 6e 64 69 6e 67  uses any pending
12be0 20 64 61 74 61 62 61 73 65 20 6f 70 65 72 61 74   database operat
12bf0 69 6f 6e 20 74 6f 20 61 62 6f 72 74 20 61 6e 64  ion to abort and
12c00 0a 2a 2a 20 72 65 74 75 72 6e 20 61 74 20 69 74  .** return at it
12c10 73 20 65 61 72 6c 69 65 73 74 20 6f 70 70 6f 72  s earliest oppor
12c20 74 75 6e 69 74 79 2e 20 54 68 69 73 20 72 6f 75  tunity. This rou
12c30 74 69 6e 65 20 69 73 20 74 79 70 69 63 61 6c 6c  tine is typicall
12c40 79 0a 2a 2a 20 63 61 6c 6c 65 64 20 69 6e 20 72  y.** called in r
12c50 65 73 70 6f 6e 73 65 20 74 6f 20 61 20 75 73 65  esponse to a use
12c60 72 20 61 63 74 69 6f 6e 20 73 75 63 68 20 61 73  r action such as
12c70 20 70 72 65 73 73 69 6e 67 20 22 43 61 6e 63 65   pressing "Cance
12c80 6c 22 0a 2a 2a 20 6f 72 20 43 74 72 6c 2d 43 20  l".** or Ctrl-C 
12c90 77 68 65 72 65 20 74 68 65 20 75 73 65 72 20 77  where the user w
12ca0 61 6e 74 73 20 61 20 6c 6f 6e 67 20 71 75 65 72  ants a long quer
12cb0 79 20 6f 70 65 72 61 74 69 6f 6e 20 74 6f 20 68  y operation to h
12cc0 61 6c 74 0a 2a 2a 20 69 6d 6d 65 64 69 61 74 65  alt.** immediate
12cd0 6c 79 2e 0a 2a 2a 0a 2a 2a 20 5e 49 74 20 69 73  ly..**.** ^It is
12ce0 20 73 61 66 65 20 74 6f 20 63 61 6c 6c 20 74 68   safe to call th
12cf0 69 73 20 72 6f 75 74 69 6e 65 20 66 72 6f 6d 20  is routine from 
12d00 61 20 74 68 72 65 61 64 20 64 69 66 66 65 72 65  a thread differe
12d10 6e 74 20 66 72 6f 6d 20 74 68 65 0a 2a 2a 20 74  nt from the.** t
12d20 68 72 65 61 64 20 74 68 61 74 20 69 73 20 63 75  hread that is cu
12d30 72 72 65 6e 74 6c 79 20 72 75 6e 6e 69 6e 67 20  rrently running 
12d40 74 68 65 20 64 61 74 61 62 61 73 65 20 6f 70 65  the database ope
12d50 72 61 74 69 6f 6e 2e 20 20 42 75 74 20 69 74 0a  ration.  But it.
12d60 2a 2a 20 69 73 20 6e 6f 74 20 73 61 66 65 20 74  ** is not safe t
12d70 6f 20 63 61 6c 6c 20 74 68 69 73 20 72 6f 75 74  o call this rout
12d80 69 6e 65 20 77 69 74 68 20 61 20 5b 64 61 74 61  ine with a [data
12d90 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d  base connection]
12da0 20 74 68 61 74 0a 2a 2a 20 69 73 20 63 6c 6f 73   that.** is clos
12db0 65 64 20 6f 72 20 6d 69 67 68 74 20 63 6c 6f 73  ed or might clos
12dc0 65 20 62 65 66 6f 72 65 20 73 71 6c 69 74 65 33  e before sqlite3
12dd0 5f 69 6e 74 65 72 72 75 70 74 28 29 20 72 65 74  _interrupt() ret
12de0 75 72 6e 73 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20  urns..**.** ^If 
12df0 61 6e 20 53 51 4c 20 6f 70 65 72 61 74 69 6f 6e  an SQL operation
12e00 20 69 73 20 76 65 72 79 20 6e 65 61 72 6c 79 20   is very nearly 
12e10 66 69 6e 69 73 68 65 64 20 61 74 20 74 68 65 20  finished at the 
12e20 74 69 6d 65 20 77 68 65 6e 0a 2a 2a 20 73 71 6c  time when.** sql
12e30 69 74 65 33 5f 69 6e 74 65 72 72 75 70 74 28 29  ite3_interrupt()
12e40 20 69 73 20 63 61 6c 6c 65 64 2c 20 74 68 65 6e   is called, then
12e50 20 69 74 20 6d 69 67 68 74 20 6e 6f 74 20 68 61   it might not ha
12e60 76 65 20 61 6e 20 6f 70 70 6f 72 74 75 6e 69 74  ve an opportunit
12e70 79 0a 2a 2a 20 74 6f 20 62 65 20 69 6e 74 65 72  y.** to be inter
12e80 72 75 70 74 65 64 20 61 6e 64 20 6d 69 67 68 74  rupted and might
12e90 20 63 6f 6e 74 69 6e 75 65 20 74 6f 20 63 6f 6d   continue to com
12ea0 70 6c 65 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e  pletion..**.** ^
12eb0 41 6e 20 53 51 4c 20 6f 70 65 72 61 74 69 6f 6e  An SQL operation
12ec0 20 74 68 61 74 20 69 73 20 69 6e 74 65 72 72 75   that is interru
12ed0 70 74 65 64 20 77 69 6c 6c 20 72 65 74 75 72 6e  pted will return
12ee0 20 5b 53 51 4c 49 54 45 5f 49 4e 54 45 52 52 55   [SQLITE_INTERRU
12ef0 50 54 5d 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20  PT]..** ^If the 
12f00 69 6e 74 65 72 72 75 70 74 65 64 20 53 51 4c 20  interrupted SQL 
12f10 6f 70 65 72 61 74 69 6f 6e 20 69 73 20 61 6e 20  operation is an 
12f20 49 4e 53 45 52 54 2c 20 55 50 44 41 54 45 2c 20  INSERT, UPDATE, 
12f30 6f 72 20 44 45 4c 45 54 45 0a 2a 2a 20 74 68 61  or DELETE.** tha
12f40 74 20 69 73 20 69 6e 73 69 64 65 20 61 6e 20 65  t is inside an e
12f50 78 70 6c 69 63 69 74 20 74 72 61 6e 73 61 63 74  xplicit transact
12f60 69 6f 6e 2c 20 74 68 65 6e 20 74 68 65 20 65 6e  ion, then the en
12f70 74 69 72 65 20 74 72 61 6e 73 61 63 74 69 6f 6e  tire transaction
12f80 0a 2a 2a 20 77 69 6c 6c 20 62 65 20 72 6f 6c 6c  .** will be roll
12f90 65 64 20 62 61 63 6b 20 61 75 74 6f 6d 61 74 69  ed back automati
12fa0 63 61 6c 6c 79 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  cally..**.** ^Th
12fb0 65 20 73 71 6c 69 74 65 33 5f 69 6e 74 65 72 72  e sqlite3_interr
12fc0 75 70 74 28 44 29 20 63 61 6c 6c 20 69 73 20 69  upt(D) call is i
12fd0 6e 20 65 66 66 65 63 74 20 75 6e 74 69 6c 20 61  n effect until a
12fe0 6c 6c 20 63 75 72 72 65 6e 74 6c 79 20 72 75 6e  ll currently run
12ff0 6e 69 6e 67 0a 2a 2a 20 53 51 4c 20 73 74 61 74  ning.** SQL stat
13000 65 6d 65 6e 74 73 20 6f 6e 20 5b 64 61 74 61 62  ements on [datab
13010 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20  ase connection] 
13020 44 20 63 6f 6d 70 6c 65 74 65 2e 20 20 5e 41 6e  D complete.  ^An
13030 79 20 6e 65 77 20 53 51 4c 20 73 74 61 74 65 6d  y new SQL statem
13040 65 6e 74 73 0a 2a 2a 20 74 68 61 74 20 61 72 65  ents.** that are
13050 20 73 74 61 72 74 65 64 20 61 66 74 65 72 20 74   started after t
13060 68 65 20 73 71 6c 69 74 65 33 5f 69 6e 74 65 72  he sqlite3_inter
13070 72 75 70 74 28 29 20 63 61 6c 6c 20 61 6e 64 20  rupt() call and 
13080 62 65 66 6f 72 65 20 74 68 65 20 0a 2a 2a 20 72  before the .** r
13090 75 6e 6e 69 6e 67 20 73 74 61 74 65 6d 65 6e 74  unning statement
130a0 73 20 72 65 61 63 68 65 73 20 7a 65 72 6f 20 61  s reaches zero a
130b0 72 65 20 69 6e 74 65 72 72 75 70 74 65 64 20 61  re interrupted a
130c0 73 20 69 66 20 74 68 65 79 20 68 61 64 20 62 65  s if they had be
130d0 65 6e 0a 2a 2a 20 72 75 6e 6e 69 6e 67 20 70 72  en.** running pr
130e0 69 6f 72 20 74 6f 20 74 68 65 20 73 71 6c 69 74  ior to the sqlit
130f0 65 33 5f 69 6e 74 65 72 72 75 70 74 28 29 20 63  e3_interrupt() c
13100 61 6c 6c 2e 20 20 5e 4e 65 77 20 53 51 4c 20 73  all.  ^New SQL s
13110 74 61 74 65 6d 65 6e 74 73 0a 2a 2a 20 74 68 61  tatements.** tha
13120 74 20 61 72 65 20 73 74 61 72 74 65 64 20 61 66  t are started af
13130 74 65 72 20 74 68 65 20 72 75 6e 6e 69 6e 67 20  ter the running 
13140 73 74 61 74 65 6d 65 6e 74 20 63 6f 75 6e 74 20  statement count 
13150 72 65 61 63 68 65 73 20 7a 65 72 6f 20 61 72 65  reaches zero are
13160 0a 2a 2a 20 6e 6f 74 20 65 66 66 65 63 74 65 64  .** not effected
13170 20 62 79 20 74 68 65 20 73 71 6c 69 74 65 33 5f   by the sqlite3_
13180 69 6e 74 65 72 72 75 70 74 28 29 2e 0a 2a 2a 20  interrupt()..** 
13190 5e 41 20 63 61 6c 6c 20 74 6f 20 73 71 6c 69 74  ^A call to sqlit
131a0 65 33 5f 69 6e 74 65 72 72 75 70 74 28 44 29 20  e3_interrupt(D) 
131b0 74 68 61 74 20 6f 63 63 75 72 73 20 77 68 65 6e  that occurs when
131c0 20 74 68 65 72 65 20 61 72 65 20 6e 6f 20 72 75   there are no ru
131d0 6e 6e 69 6e 67 0a 2a 2a 20 53 51 4c 20 73 74 61  nning.** SQL sta
131e0 74 65 6d 65 6e 74 73 20 69 73 20 61 20 6e 6f 2d  tements is a no-
131f0 6f 70 20 61 6e 64 20 68 61 73 20 6e 6f 20 65 66  op and has no ef
13200 66 65 63 74 20 6f 6e 20 53 51 4c 20 73 74 61 74  fect on SQL stat
13210 65 6d 65 6e 74 73 0a 2a 2a 20 74 68 61 74 20 61  ements.** that a
13220 72 65 20 73 74 61 72 74 65 64 20 61 66 74 65 72  re started after
13230 20 74 68 65 20 73 71 6c 69 74 65 33 5f 69 6e 74   the sqlite3_int
13240 65 72 72 75 70 74 28 29 20 63 61 6c 6c 20 72 65  errupt() call re
13250 74 75 72 6e 73 2e 0a 2a 2a 0a 2a 2a 20 49 66 20  turns..**.** If 
13260 74 68 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e  the database con
13270 6e 65 63 74 69 6f 6e 20 63 6c 6f 73 65 73 20 77  nection closes w
13280 68 69 6c 65 20 5b 73 71 6c 69 74 65 33 5f 69 6e  hile [sqlite3_in
13290 74 65 72 72 75 70 74 28 29 5d 0a 2a 2a 20 69 73  terrupt()].** is
132a0 20 72 75 6e 6e 69 6e 67 20 74 68 65 6e 20 62 61   running then ba
132b0 64 20 74 68 69 6e 67 73 20 77 69 6c 6c 20 6c 69  d things will li
132c0 6b 65 6c 79 20 68 61 70 70 65 6e 2e 0a 2a 2f 0a  kely happen..*/.
132d0 76 6f 69 64 20 73 71 6c 69 74 65 33 5f 69 6e 74  void sqlite3_int
132e0 65 72 72 75 70 74 28 73 71 6c 69 74 65 33 2a 29  errupt(sqlite3*)
132f0 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
13300 46 3a 20 44 65 74 65 72 6d 69 6e 65 20 49 66 20  F: Determine If 
13310 41 6e 20 53 51 4c 20 53 74 61 74 65 6d 65 6e 74  An SQL Statement
13320 20 49 73 20 43 6f 6d 70 6c 65 74 65 0a 2a 2a 0a   Is Complete.**.
13330 2a 2a 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65  ** These routine
13340 73 20 61 72 65 20 75 73 65 66 75 6c 20 64 75 72  s are useful dur
13350 69 6e 67 20 63 6f 6d 6d 61 6e 64 2d 6c 69 6e 65  ing command-line
13360 20 69 6e 70 75 74 20 74 6f 20 64 65 74 65 72 6d   input to determ
13370 69 6e 65 20 69 66 20 74 68 65 0a 2a 2a 20 63 75  ine if the.** cu
13380 72 72 65 6e 74 6c 79 20 65 6e 74 65 72 65 64 20  rrently entered 
13390 74 65 78 74 20 73 65 65 6d 73 20 74 6f 20 66 6f  text seems to fo
133a0 72 6d 20 61 20 63 6f 6d 70 6c 65 74 65 20 53 51  rm a complete SQ
133b0 4c 20 73 74 61 74 65 6d 65 6e 74 20 6f 72 0a 2a  L statement or.*
133c0 2a 20 69 66 20 61 64 64 69 74 69 6f 6e 61 6c 20  * if additional 
133d0 69 6e 70 75 74 20 69 73 20 6e 65 65 64 65 64 20  input is needed 
133e0 62 65 66 6f 72 65 20 73 65 6e 64 69 6e 67 20 74  before sending t
133f0 68 65 20 74 65 78 74 20 69 6e 74 6f 0a 2a 2a 20  he text into.** 
13400 53 51 4c 69 74 65 20 66 6f 72 20 70 61 72 73 69  SQLite for parsi
13410 6e 67 2e 20 20 5e 54 68 65 73 65 20 72 6f 75 74  ng.  ^These rout
13420 69 6e 65 73 20 72 65 74 75 72 6e 20 31 20 69 66  ines return 1 if
13430 20 74 68 65 20 69 6e 70 75 74 20 73 74 72 69 6e   the input strin
13440 67 0a 2a 2a 20 61 70 70 65 61 72 73 20 74 6f 20  g.** appears to 
13450 62 65 20 61 20 63 6f 6d 70 6c 65 74 65 20 53 51  be a complete SQ
13460 4c 20 73 74 61 74 65 6d 65 6e 74 2e 20 20 5e 41  L statement.  ^A
13470 20 73 74 61 74 65 6d 65 6e 74 20 69 73 20 6a 75   statement is ju
13480 64 67 65 64 20 74 6f 20 62 65 0a 2a 2a 20 63 6f  dged to be.** co
13490 6d 70 6c 65 74 65 20 69 66 20 69 74 20 65 6e 64  mplete if it end
134a0 73 20 77 69 74 68 20 61 20 73 65 6d 69 63 6f 6c  s with a semicol
134b0 6f 6e 20 74 6f 6b 65 6e 20 61 6e 64 20 69 73 20  on token and is 
134c0 6e 6f 74 20 61 20 70 72 65 66 69 78 20 6f 66 20  not a prefix of 
134d0 61 0a 2a 2a 20 77 65 6c 6c 2d 66 6f 72 6d 65 64  a.** well-formed
134e0 20 43 52 45 41 54 45 20 54 52 49 47 47 45 52 20   CREATE TRIGGER 
134f0 73 74 61 74 65 6d 65 6e 74 2e 20 20 5e 53 65 6d  statement.  ^Sem
13500 69 63 6f 6c 6f 6e 73 20 74 68 61 74 20 61 72 65  icolons that are
13510 20 65 6d 62 65 64 64 65 64 20 77 69 74 68 69 6e   embedded within
13520 0a 2a 2a 20 73 74 72 69 6e 67 20 6c 69 74 65 72  .** string liter
13530 61 6c 73 20 6f 72 20 71 75 6f 74 65 64 20 69 64  als or quoted id
13540 65 6e 74 69 66 69 65 72 20 6e 61 6d 65 73 20 6f  entifier names o
13550 72 20 63 6f 6d 6d 65 6e 74 73 20 61 72 65 20 6e  r comments are n
13560 6f 74 0a 2a 2a 20 69 6e 64 65 70 65 6e 64 65 6e  ot.** independen
13570 74 20 74 6f 6b 65 6e 73 20 28 74 68 65 79 20 61  t tokens (they a
13580 72 65 20 70 61 72 74 20 6f 66 20 74 68 65 20 74  re part of the t
13590 6f 6b 65 6e 20 69 6e 20 77 68 69 63 68 20 74 68  oken in which th
135a0 65 79 20 61 72 65 0a 2a 2a 20 65 6d 62 65 64 64  ey are.** embedd
135b0 65 64 29 20 61 6e 64 20 74 68 75 73 20 64 6f 20  ed) and thus do 
135c0 6e 6f 74 20 63 6f 75 6e 74 20 61 73 20 61 20 73  not count as a s
135d0 74 61 74 65 6d 65 6e 74 20 74 65 72 6d 69 6e 61  tatement termina
135e0 74 6f 72 2e 20 20 5e 57 68 69 74 65 73 70 61 63  tor.  ^Whitespac
135f0 65 0a 2a 2a 20 61 6e 64 20 63 6f 6d 6d 65 6e 74  e.** and comment
13600 73 20 74 68 61 74 20 66 6f 6c 6c 6f 77 20 74 68  s that follow th
13610 65 20 66 69 6e 61 6c 20 73 65 6d 69 63 6f 6c 6f  e final semicolo
13620 6e 20 61 72 65 20 69 67 6e 6f 72 65 64 2e 0a 2a  n are ignored..*
13630 2a 0a 2a 2a 20 5e 54 68 65 73 65 20 72 6f 75 74  *.** ^These rout
13640 69 6e 65 73 20 72 65 74 75 72 6e 20 30 20 69 66  ines return 0 if
13650 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20 69   the statement i
13660 73 20 69 6e 63 6f 6d 70 6c 65 74 65 2e 20 20 5e  s incomplete.  ^
13670 49 66 20 61 0a 2a 2a 20 6d 65 6d 6f 72 79 20 61  If a.** memory a
13680 6c 6c 6f 63 61 74 69 6f 6e 20 66 61 69 6c 73 2c  llocation fails,
13690 20 74 68 65 6e 20 53 51 4c 49 54 45 5f 4e 4f 4d   then SQLITE_NOM
136a0 45 4d 20 69 73 20 72 65 74 75 72 6e 65 64 2e 0a  EM is returned..
136b0 2a 2a 0a 2a 2a 20 5e 54 68 65 73 65 20 72 6f 75  **.** ^These rou
136c0 74 69 6e 65 73 20 64 6f 20 6e 6f 74 20 70 61 72  tines do not par
136d0 73 65 20 74 68 65 20 53 51 4c 20 73 74 61 74 65  se the SQL state
136e0 6d 65 6e 74 73 20 74 68 75 73 0a 2a 2a 20 77 69  ments thus.** wi
136f0 6c 6c 20 6e 6f 74 20 64 65 74 65 63 74 20 73 79  ll not detect sy
13700 6e 74 61 63 74 69 63 61 6c 6c 79 20 69 6e 63 6f  ntactically inco
13710 72 72 65 63 74 20 53 51 4c 2e 0a 2a 2a 0a 2a 2a  rrect SQL..**.**
13720 20 5e 28 49 66 20 53 51 4c 69 74 65 20 68 61 73   ^(If SQLite has
13730 20 6e 6f 74 20 62 65 65 6e 20 69 6e 69 74 69 61   not been initia
13740 6c 69 7a 65 64 20 75 73 69 6e 67 20 5b 73 71 6c  lized using [sql
13750 69 74 65 33 5f 69 6e 69 74 69 61 6c 69 7a 65 28  ite3_initialize(
13760 29 5d 20 70 72 69 6f 72 20 0a 2a 2a 20 74 6f 20  )] prior .** to 
13770 69 6e 76 6f 6b 69 6e 67 20 73 71 6c 69 74 65 33  invoking sqlite3
13780 5f 63 6f 6d 70 6c 65 74 65 31 36 28 29 20 74 68  _complete16() th
13790 65 6e 20 73 71 6c 69 74 65 33 5f 69 6e 69 74 69  en sqlite3_initi
137a0 61 6c 69 7a 65 28 29 20 69 73 20 69 6e 76 6f 6b  alize() is invok
137b0 65 64 0a 2a 2a 20 61 75 74 6f 6d 61 74 69 63 61  ed.** automatica
137c0 6c 6c 79 20 62 79 20 73 71 6c 69 74 65 33 5f 63  lly by sqlite3_c
137d0 6f 6d 70 6c 65 74 65 31 36 28 29 2e 20 20 49 66  omplete16().  If
137e0 20 74 68 61 74 20 69 6e 69 74 69 61 6c 69 7a 61   that initializa
137f0 74 69 6f 6e 20 66 61 69 6c 73 2c 0a 2a 2a 20 74  tion fails,.** t
13800 68 65 6e 20 74 68 65 20 72 65 74 75 72 6e 20 76  hen the return v
13810 61 6c 75 65 20 66 72 6f 6d 20 73 71 6c 69 74 65  alue from sqlite
13820 33 5f 63 6f 6d 70 6c 65 74 65 31 36 28 29 20 77  3_complete16() w
13830 69 6c 6c 20 62 65 20 6e 6f 6e 2d 7a 65 72 6f 0a  ill be non-zero.
13840 2a 2a 20 72 65 67 61 72 64 6c 65 73 73 20 6f 66  ** regardless of
13850 20 77 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20   whether or not 
13860 74 68 65 20 69 6e 70 75 74 20 53 51 4c 20 69 73  the input SQL is
13870 20 63 6f 6d 70 6c 65 74 65 2e 29 5e 0a 2a 2a 0a   complete.)^.**.
13880 2a 2a 20 54 68 65 20 69 6e 70 75 74 20 74 6f 20  ** The input to 
13890 5b 73 71 6c 69 74 65 33 5f 63 6f 6d 70 6c 65 74  [sqlite3_complet
138a0 65 28 29 5d 20 6d 75 73 74 20 62 65 20 61 20 7a  e()] must be a z
138b0 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 0a 2a  ero-terminated.*
138c0 2a 20 55 54 46 2d 38 20 73 74 72 69 6e 67 2e 0a  * UTF-8 string..
138d0 2a 2a 0a 2a 2a 20 54 68 65 20 69 6e 70 75 74 20  **.** The input 
138e0 74 6f 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6d 70  to [sqlite3_comp
138f0 6c 65 74 65 31 36 28 29 5d 20 6d 75 73 74 20 62  lete16()] must b
13900 65 20 61 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61  e a zero-termina
13910 74 65 64 0a 2a 2a 20 55 54 46 2d 31 36 20 73 74  ted.** UTF-16 st
13920 72 69 6e 67 20 69 6e 20 6e 61 74 69 76 65 20 62  ring in native b
13930 79 74 65 20 6f 72 64 65 72 2e 0a 2a 2f 0a 69 6e  yte order..*/.in
13940 74 20 73 71 6c 69 74 65 33 5f 63 6f 6d 70 6c 65  t sqlite3_comple
13950 74 65 28 63 6f 6e 73 74 20 63 68 61 72 20 2a 73  te(const char *s
13960 71 6c 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  ql);.int sqlite3
13970 5f 63 6f 6d 70 6c 65 74 65 31 36 28 63 6f 6e 73  _complete16(cons
13980 74 20 76 6f 69 64 20 2a 73 71 6c 29 3b 0a 0a 2f  t void *sql);../
13990 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 52  *.** CAPI3REF: R
139a0 65 67 69 73 74 65 72 20 41 20 43 61 6c 6c 62 61  egister A Callba
139b0 63 6b 20 54 6f 20 48 61 6e 64 6c 65 20 53 51 4c  ck To Handle SQL
139c0 49 54 45 5f 42 55 53 59 20 45 72 72 6f 72 73 0a  ITE_BUSY Errors.
139d0 2a 2a 0a 2a 2a 20 5e 54 68 69 73 20 72 6f 75 74  **.** ^This rout
139e0 69 6e 65 20 73 65 74 73 20 61 20 63 61 6c 6c 62  ine sets a callb
139f0 61 63 6b 20 66 75 6e 63 74 69 6f 6e 20 74 68 61  ack function tha
13a00 74 20 6d 69 67 68 74 20 62 65 20 69 6e 76 6f 6b  t might be invok
13a10 65 64 20 77 68 65 6e 65 76 65 72 0a 2a 2a 20 61  ed whenever.** a
13a20 6e 20 61 74 74 65 6d 70 74 20 69 73 20 6d 61 64  n attempt is mad
13a30 65 20 74 6f 20 6f 70 65 6e 20 61 20 64 61 74 61  e to open a data
13a40 62 61 73 65 20 74 61 62 6c 65 20 74 68 61 74 20  base table that 
13a50 61 6e 6f 74 68 65 72 20 74 68 72 65 61 64 0a 2a  another thread.*
13a60 2a 20 6f 72 20 70 72 6f 63 65 73 73 20 68 61 73  * or process has
13a70 20 6c 6f 63 6b 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e   locked..**.** ^
13a80 49 66 20 74 68 65 20 62 75 73 79 20 63 61 6c 6c  If the busy call
13a90 62 61 63 6b 20 69 73 20 4e 55 4c 4c 2c 20 74 68  back is NULL, th
13aa0 65 6e 20 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d  en [SQLITE_BUSY]
13ab0 20 6f 72 20 5b 53 51 4c 49 54 45 5f 49 4f 45 52   or [SQLITE_IOER
13ac0 52 5f 42 4c 4f 43 4b 45 44 5d 0a 2a 2a 20 69 73  R_BLOCKED].** is
13ad0 20 72 65 74 75 72 6e 65 64 20 69 6d 6d 65 64 69   returned immedi
13ae0 61 74 65 6c 79 20 75 70 6f 6e 20 65 6e 63 6f 75  ately upon encou
13af0 6e 74 65 72 69 6e 67 20 74 68 65 20 6c 6f 63 6b  ntering the lock
13b00 2e 20 20 5e 49 66 20 74 68 65 20 62 75 73 79 20  .  ^If the busy 
13b10 63 61 6c 6c 62 61 63 6b 0a 2a 2a 20 69 73 20 6e  callback.** is n
13b20 6f 74 20 4e 55 4c 4c 2c 20 74 68 65 6e 20 74 68  ot NULL, then th
13b30 65 20 63 61 6c 6c 62 61 63 6b 20 6d 69 67 68 74  e callback might
13b40 20 62 65 20 69 6e 76 6f 6b 65 64 20 77 69 74 68   be invoked with
13b50 20 74 77 6f 20 61 72 67 75 6d 65 6e 74 73 2e 0a   two arguments..
13b60 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66 69 72 73 74  **.** ^The first
13b70 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 74 68 65   argument to the
13b80 20 62 75 73 79 20 68 61 6e 64 6c 65 72 20 69 73   busy handler is
13b90 20 61 20 63 6f 70 79 20 6f 66 20 74 68 65 20 76   a copy of the v
13ba0 6f 69 64 2a 20 70 6f 69 6e 74 65 72 20 77 68 69  oid* pointer whi
13bb0 63 68 0a 2a 2a 20 69 73 20 74 68 65 20 74 68 69  ch.** is the thi
13bc0 72 64 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 73  rd argument to s
13bd0 71 6c 69 74 65 33 5f 62 75 73 79 5f 68 61 6e 64  qlite3_busy_hand
13be0 6c 65 72 28 29 2e 20 20 5e 54 68 65 20 73 65 63  ler().  ^The sec
13bf0 6f 6e 64 20 61 72 67 75 6d 65 6e 74 20 74 6f 0a  ond argument to.
13c00 2a 2a 20 74 68 65 20 62 75 73 79 20 68 61 6e 64  ** the busy hand
13c10 6c 65 72 20 63 61 6c 6c 62 61 63 6b 20 69 73 20  ler callback is 
13c20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 74 69  the number of ti
13c30 6d 65 73 20 74 68 61 74 20 74 68 65 20 62 75 73  mes that the bus
13c40 79 20 68 61 6e 64 6c 65 72 20 68 61 73 0a 2a 2a  y handler has.**
13c50 20 62 65 65 6e 20 69 6e 76 6f 6b 65 64 20 66 6f   been invoked fo
13c60 72 20 74 68 69 73 20 6c 6f 63 6b 69 6e 67 20 65  r this locking e
13c70 76 65 6e 74 2e 20 20 5e 49 66 20 74 68 65 0a 2a  vent.  ^If the.*
13c80 2a 20 62 75 73 79 20 63 61 6c 6c 62 61 63 6b 20  * busy callback 
13c90 72 65 74 75 72 6e 73 20 30 2c 20 74 68 65 6e 20  returns 0, then 
13ca0 6e 6f 20 61 64 64 69 74 69 6f 6e 61 6c 20 61 74  no additional at
13cb0 74 65 6d 70 74 73 20 61 72 65 20 6d 61 64 65 20  tempts are made 
13cc0 74 6f 0a 2a 2a 20 61 63 63 65 73 73 20 74 68 65  to.** access the
13cd0 20 64 61 74 61 62 61 73 65 20 61 6e 64 20 5b 53   database and [S
13ce0 51 4c 49 54 45 5f 42 55 53 59 5d 20 6f 72 20 5b  QLITE_BUSY] or [
13cf0 53 51 4c 49 54 45 5f 49 4f 45 52 52 5f 42 4c 4f  SQLITE_IOERR_BLO
13d00 43 4b 45 44 5d 20 69 73 20 72 65 74 75 72 6e 65  CKED] is returne
13d10 64 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 63 61  d..** ^If the ca
13d20 6c 6c 62 61 63 6b 20 72 65 74 75 72 6e 73 20 6e  llback returns n
13d30 6f 6e 2d 7a 65 72 6f 2c 20 74 68 65 6e 20 61 6e  on-zero, then an
13d40 6f 74 68 65 72 20 61 74 74 65 6d 70 74 0a 2a 2a  other attempt.**
13d50 20 69 73 20 6d 61 64 65 20 74 6f 20 6f 70 65 6e   is made to open
13d60 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66 6f   the database fo
13d70 72 20 72 65 61 64 69 6e 67 20 61 6e 64 20 74 68  r reading and th
13d80 65 20 63 79 63 6c 65 20 72 65 70 65 61 74 73 2e  e cycle repeats.
13d90 0a 2a 2a 0a 2a 2a 20 54 68 65 20 70 72 65 73 65  .**.** The prese
13da0 6e 63 65 20 6f 66 20 61 20 62 75 73 79 20 68 61  nce of a busy ha
13db0 6e 64 6c 65 72 20 64 6f 65 73 20 6e 6f 74 20 67  ndler does not g
13dc0 75 61 72 61 6e 74 65 65 20 74 68 61 74 20 69 74  uarantee that it
13dd0 20 77 69 6c 6c 20 62 65 20 69 6e 76 6f 6b 65 64   will be invoked
13de0 0a 2a 2a 20 77 68 65 6e 20 74 68 65 72 65 20 69  .** when there i
13df0 73 20 6c 6f 63 6b 20 63 6f 6e 74 65 6e 74 69 6f  s lock contentio
13e00 6e 2e 20 5e 49 66 20 53 51 4c 69 74 65 20 64 65  n. ^If SQLite de
13e10 74 65 72 6d 69 6e 65 73 20 74 68 61 74 20 69 6e  termines that in
13e20 76 6f 6b 69 6e 67 20 74 68 65 20 62 75 73 79 0a  voking the busy.
13e30 2a 2a 20 68 61 6e 64 6c 65 72 20 63 6f 75 6c 64  ** handler could
13e40 20 72 65 73 75 6c 74 20 69 6e 20 61 20 64 65 61   result in a dea
13e50 64 6c 6f 63 6b 2c 20 69 74 20 77 69 6c 6c 20 67  dlock, it will g
13e60 6f 20 61 68 65 61 64 20 61 6e 64 20 72 65 74 75  o ahead and retu
13e70 72 6e 20 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d  rn [SQLITE_BUSY]
13e80 0a 2a 2a 20 6f 72 20 5b 53 51 4c 49 54 45 5f 49  .** or [SQLITE_I
13e90 4f 45 52 52 5f 42 4c 4f 43 4b 45 44 5d 20 69 6e  OERR_BLOCKED] in
13ea0 73 74 65 61 64 20 6f 66 20 69 6e 76 6f 6b 69 6e  stead of invokin
13eb0 67 20 74 68 65 20 62 75 73 79 20 68 61 6e 64 6c  g the busy handl
13ec0 65 72 2e 0a 2a 2a 20 43 6f 6e 73 69 64 65 72 20  er..** Consider 
13ed0 61 20 73 63 65 6e 61 72 69 6f 20 77 68 65 72 65  a scenario where
13ee0 20 6f 6e 65 20 70 72 6f 63 65 73 73 20 69 73 20   one process is 
13ef0 68 6f 6c 64 69 6e 67 20 61 20 72 65 61 64 20 6c  holding a read l
13f00 6f 63 6b 20 74 68 61 74 0a 2a 2a 20 69 74 20 69  ock that.** it i
13f10 73 20 74 72 79 69 6e 67 20 74 6f 20 70 72 6f 6d  s trying to prom
13f20 6f 74 65 20 74 6f 20 61 20 72 65 73 65 72 76 65  ote to a reserve
13f30 64 20 6c 6f 63 6b 20 61 6e 64 0a 2a 2a 20 61 20  d lock and.** a 
13f40 73 65 63 6f 6e 64 20 70 72 6f 63 65 73 73 20 69  second process i
13f50 73 20 68 6f 6c 64 69 6e 67 20 61 20 72 65 73 65  s holding a rese
13f60 72 76 65 64 20 6c 6f 63 6b 20 74 68 61 74 20 69  rved lock that i
13f70 74 20 69 73 20 74 72 79 69 6e 67 0a 2a 2a 20 74  t is trying.** t
13f80 6f 20 70 72 6f 6d 6f 74 65 20 74 6f 20 61 6e 20  o promote to an 
13f90 65 78 63 6c 75 73 69 76 65 20 6c 6f 63 6b 2e 20  exclusive lock. 
13fa0 20 54 68 65 20 66 69 72 73 74 20 70 72 6f 63 65   The first proce
13fb0 73 73 20 63 61 6e 6e 6f 74 20 70 72 6f 63 65 65  ss cannot procee
13fc0 64 0a 2a 2a 20 62 65 63 61 75 73 65 20 69 74 20  d.** because it 
13fd0 69 73 20 62 6c 6f 63 6b 65 64 20 62 79 20 74 68  is blocked by th
13fe0 65 20 73 65 63 6f 6e 64 20 61 6e 64 20 74 68 65  e second and the
13ff0 20 73 65 63 6f 6e 64 20 70 72 6f 63 65 73 73 20   second process 
14000 63 61 6e 6e 6f 74 0a 2a 2a 20 70 72 6f 63 65 65  cannot.** procee
14010 64 20 62 65 63 61 75 73 65 20 69 74 20 69 73 20  d because it is 
14020 62 6c 6f 63 6b 65 64 20 62 79 20 74 68 65 20 66  blocked by the f
14030 69 72 73 74 2e 20 20 49 66 20 62 6f 74 68 20 70  irst.  If both p
14040 72 6f 63 65 73 73 65 73 0a 2a 2a 20 69 6e 76 6f  rocesses.** invo
14050 6b 65 20 74 68 65 20 62 75 73 79 20 68 61 6e 64  ke the busy hand
14060 6c 65 72 73 2c 20 6e 65 69 74 68 65 72 20 77 69  lers, neither wi
14070 6c 6c 20 6d 61 6b 65 20 61 6e 79 20 70 72 6f 67  ll make any prog
14080 72 65 73 73 2e 20 20 54 68 65 72 65 66 6f 72 65  ress.  Therefore
14090 2c 0a 2a 2a 20 53 51 4c 69 74 65 20 72 65 74 75  ,.** SQLite retu
140a0 72 6e 73 20 5b 53 51 4c 49 54 45 5f 42 55 53 59  rns [SQLITE_BUSY
140b0 5d 20 66 6f 72 20 74 68 65 20 66 69 72 73 74 20  ] for the first 
140c0 70 72 6f 63 65 73 73 2c 20 68 6f 70 69 6e 67 20  process, hoping 
140d0 74 68 61 74 20 74 68 69 73 0a 2a 2a 20 77 69 6c  that this.** wil
140e0 6c 20 69 6e 64 75 63 65 20 74 68 65 20 66 69 72  l induce the fir
140f0 73 74 20 70 72 6f 63 65 73 73 20 74 6f 20 72 65  st process to re
14100 6c 65 61 73 65 20 69 74 73 20 72 65 61 64 20 6c  lease its read l
14110 6f 63 6b 20 61 6e 64 20 61 6c 6c 6f 77 0a 2a 2a  ock and allow.**
14120 20 74 68 65 20 73 65 63 6f 6e 64 20 70 72 6f 63   the second proc
14130 65 73 73 20 74 6f 20 70 72 6f 63 65 65 64 2e 0a  ess to proceed..
14140 2a 2a 0a 2a 2a 20 5e 54 68 65 20 64 65 66 61 75  **.** ^The defau
14150 6c 74 20 62 75 73 79 20 63 61 6c 6c 62 61 63 6b  lt busy callback
14160 20 69 73 20 4e 55 4c 4c 2e 0a 2a 2a 0a 2a 2a 20   is NULL..**.** 
14170 5e 54 68 65 20 5b 53 51 4c 49 54 45 5f 42 55 53  ^The [SQLITE_BUS
14180 59 5d 20 65 72 72 6f 72 20 69 73 20 63 6f 6e 76  Y] error is conv
14190 65 72 74 65 64 20 74 6f 20 5b 53 51 4c 49 54 45  erted to [SQLITE
141a0 5f 49 4f 45 52 52 5f 42 4c 4f 43 4b 45 44 5d 0a  _IOERR_BLOCKED].
141b0 2a 2a 20 77 68 65 6e 20 53 51 4c 69 74 65 20 69  ** when SQLite i
141c0 73 20 69 6e 20 74 68 65 20 6d 69 64 64 6c 65 20  s in the middle 
141d0 6f 66 20 61 20 6c 61 72 67 65 20 74 72 61 6e 73  of a large trans
141e0 61 63 74 69 6f 6e 20 77 68 65 72 65 20 61 6c 6c  action where all
141f0 20 74 68 65 0a 2a 2a 20 63 68 61 6e 67 65 73 20   the.** changes 
14200 77 69 6c 6c 20 6e 6f 74 20 66 69 74 20 69 6e 74  will not fit int
14210 6f 20 74 68 65 20 69 6e 2d 6d 65 6d 6f 72 79 20  o the in-memory 
14220 63 61 63 68 65 2e 20 20 53 51 4c 69 74 65 20 77  cache.  SQLite w
14230 69 6c 6c 0a 2a 2a 20 61 6c 72 65 61 64 79 20 68  ill.** already h
14240 6f 6c 64 20 61 20 52 45 53 45 52 56 45 44 20 6c  old a RESERVED l
14250 6f 63 6b 20 6f 6e 20 74 68 65 20 64 61 74 61 62  ock on the datab
14260 61 73 65 20 66 69 6c 65 2c 20 62 75 74 20 69 74  ase file, but it
14270 20 6e 65 65 64 73 0a 2a 2a 20 74 6f 20 70 72 6f   needs.** to pro
14280 6d 6f 74 65 20 74 68 69 73 20 6c 6f 63 6b 20 74  mote this lock t
14290 6f 20 45 58 43 4c 55 53 49 56 45 20 73 6f 20 74  o EXCLUSIVE so t
142a0 68 61 74 20 69 74 20 63 61 6e 20 73 70 69 6c 6c  hat it can spill
142b0 20 63 61 63 68 65 0a 2a 2a 20 70 61 67 65 73 20   cache.** pages 
142c0 69 6e 74 6f 20 74 68 65 20 64 61 74 61 62 61 73  into the databas
142d0 65 20 66 69 6c 65 20 77 69 74 68 6f 75 74 20 68  e file without h
142e0 61 72 6d 20 74 6f 20 63 6f 6e 63 75 72 72 65 6e  arm to concurren
142f0 74 0a 2a 2a 20 72 65 61 64 65 72 73 2e 20 20 5e  t.** readers.  ^
14300 49 66 20 69 74 20 69 73 20 75 6e 61 62 6c 65 20  If it is unable 
14310 74 6f 20 70 72 6f 6d 6f 74 65 20 74 68 65 20 6c  to promote the l
14320 6f 63 6b 2c 20 74 68 65 6e 20 74 68 65 20 69 6e  ock, then the in
14330 2d 6d 65 6d 6f 72 79 0a 2a 2a 20 63 61 63 68 65  -memory.** cache
14340 20 77 69 6c 6c 20 62 65 20 6c 65 66 74 20 69 6e   will be left in
14350 20 61 6e 20 69 6e 63 6f 6e 73 69 73 74 65 6e 74   an inconsistent
14360 20 73 74 61 74 65 20 61 6e 64 20 73 6f 20 74 68   state and so th
14370 65 20 65 72 72 6f 72 0a 2a 2a 20 63 6f 64 65 20  e error.** code 
14380 69 73 20 70 72 6f 6d 6f 74 65 64 20 66 72 6f 6d  is promoted from
14390 20 74 68 65 20 72 65 6c 61 74 69 76 65 6c 79 20   the relatively 
143a0 62 65 6e 69 67 6e 20 5b 53 51 4c 49 54 45 5f 42  benign [SQLITE_B
143b0 55 53 59 5d 20 74 6f 0a 2a 2a 20 74 68 65 20 6d  USY] to.** the m
143c0 6f 72 65 20 73 65 76 65 72 65 20 5b 53 51 4c 49  ore severe [SQLI
143d0 54 45 5f 49 4f 45 52 52 5f 42 4c 4f 43 4b 45 44  TE_IOERR_BLOCKED
143e0 5d 2e 20 20 5e 54 68 69 73 20 65 72 72 6f 72 20  ].  ^This error 
143f0 63 6f 64 65 20 70 72 6f 6d 6f 74 69 6f 6e 0a 2a  code promotion.*
14400 2a 20 66 6f 72 63 65 73 20 61 6e 20 61 75 74 6f  * forces an auto
14410 6d 61 74 69 63 20 72 6f 6c 6c 62 61 63 6b 20 6f  matic rollback o
14420 66 20 74 68 65 20 63 68 61 6e 67 65 73 2e 20 20  f the changes.  
14430 53 65 65 20 74 68 65 0a 2a 2a 20 3c 61 20 68 72  See the.** <a hr
14440 65 66 3d 22 2f 63 76 73 74 72 61 63 2f 77 69 6b  ef="/cvstrac/wik
14450 69 3f 70 3d 43 6f 72 72 75 70 74 69 6f 6e 46 6f  i?p=CorruptionFo
14460 6c 6c 6f 77 69 6e 67 42 75 73 79 45 72 72 6f 72  llowingBusyError
14470 22 3e 0a 2a 2a 20 43 6f 72 72 75 70 74 69 6f 6e  ">.** Corruption
14480 46 6f 6c 6c 6f 77 69 6e 67 42 75 73 79 45 72 72  FollowingBusyErr
14490 6f 72 3c 2f 61 3e 20 77 69 6b 69 20 70 61 67 65  or</a> wiki page
144a0 20 66 6f 72 20 61 20 64 69 73 63 75 73 73 69 6f   for a discussio
144b0 6e 20 6f 66 20 77 68 79 0a 2a 2a 20 74 68 69 73  n of why.** this
144c0 20 69 73 20 69 6d 70 6f 72 74 61 6e 74 2e 0a 2a   is important..*
144d0 2a 0a 2a 2a 20 5e 28 54 68 65 72 65 20 63 61 6e  *.** ^(There can
144e0 20 6f 6e 6c 79 20 62 65 20 61 20 73 69 6e 67 6c   only be a singl
144f0 65 20 62 75 73 79 20 68 61 6e 64 6c 65 72 20 64  e busy handler d
14500 65 66 69 6e 65 64 20 66 6f 72 20 65 61 63 68 0a  efined for each.
14510 2a 2a 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e  ** [database con
14520 6e 65 63 74 69 6f 6e 5d 2e 20 20 53 65 74 74 69  nection].  Setti
14530 6e 67 20 61 20 6e 65 77 20 62 75 73 79 20 68 61  ng a new busy ha
14540 6e 64 6c 65 72 20 63 6c 65 61 72 73 20 61 6e 79  ndler clears any
14550 0a 2a 2a 20 70 72 65 76 69 6f 75 73 6c 79 20 73  .** previously s
14560 65 74 20 68 61 6e 64 6c 65 72 2e 29 5e 20 20 5e  et handler.)^  ^
14570 4e 6f 74 65 20 74 68 61 74 20 63 61 6c 6c 69 6e  Note that callin
14580 67 20 5b 73 71 6c 69 74 65 33 5f 62 75 73 79 5f  g [sqlite3_busy_
14590 74 69 6d 65 6f 75 74 28 29 5d 0a 2a 2a 20 77 69  timeout()].** wi
145a0 6c 6c 20 61 6c 73 6f 20 73 65 74 20 6f 72 20 63  ll also set or c
145b0 6c 65 61 72 20 74 68 65 20 62 75 73 79 20 68 61  lear the busy ha
145c0 6e 64 6c 65 72 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  ndler..**.** The
145d0 20 62 75 73 79 20 63 61 6c 6c 62 61 63 6b 20 73   busy callback s
145e0 68 6f 75 6c 64 20 6e 6f 74 20 74 61 6b 65 20 61  hould not take a
145f0 6e 79 20 61 63 74 69 6f 6e 73 20 77 68 69 63 68  ny actions which
14600 20 6d 6f 64 69 66 79 20 74 68 65 0a 2a 2a 20 64   modify the.** d
14610 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
14620 6f 6e 20 74 68 61 74 20 69 6e 76 6f 6b 65 64 20  on that invoked 
14630 74 68 65 20 62 75 73 79 20 68 61 6e 64 6c 65 72  the busy handler
14640 2e 20 20 41 6e 79 20 73 75 63 68 20 61 63 74 69  .  Any such acti
14650 6f 6e 73 0a 2a 2a 20 72 65 73 75 6c 74 20 69 6e  ons.** result in
14660 20 75 6e 64 65 66 69 6e 65 64 20 62 65 68 61 76   undefined behav
14670 69 6f 72 2e 0a 2a 2a 20 0a 2a 2a 20 41 20 62 75  ior..** .** A bu
14680 73 79 20 68 61 6e 64 6c 65 72 20 6d 75 73 74 20  sy handler must 
14690 6e 6f 74 20 63 6c 6f 73 65 20 74 68 65 20 64 61  not close the da
146a0 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
146b0 6e 0a 2a 2a 20 6f 72 20 5b 70 72 65 70 61 72 65  n.** or [prepare
146c0 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 74 68 61  d statement] tha
146d0 74 20 69 6e 76 6f 6b 65 64 20 74 68 65 20 62 75  t invoked the bu
146e0 73 79 20 68 61 6e 64 6c 65 72 2e 0a 2a 2f 0a 69  sy handler..*/.i
146f0 6e 74 20 73 71 6c 69 74 65 33 5f 62 75 73 79 5f  nt sqlite3_busy_
14700 68 61 6e 64 6c 65 72 28 73 71 6c 69 74 65 33 2a  handler(sqlite3*
14710 2c 20 69 6e 74 28 2a 29 28 76 6f 69 64 2a 2c 69  , int(*)(void*,i
14720 6e 74 29 2c 20 76 6f 69 64 2a 29 3b 0a 0a 2f 2a  nt), void*);../*
14730 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 53 65  .** CAPI3REF: Se
14740 74 20 41 20 42 75 73 79 20 54 69 6d 65 6f 75 74  t A Busy Timeout
14750 0a 2a 2a 0a 2a 2a 20 5e 54 68 69 73 20 72 6f 75  .**.** ^This rou
14760 74 69 6e 65 20 73 65 74 73 20 61 20 5b 73 71 6c  tine sets a [sql
14770 69 74 65 33 5f 62 75 73 79 5f 68 61 6e 64 6c 65  ite3_busy_handle
14780 72 20 7c 20 62 75 73 79 20 68 61 6e 64 6c 65 72  r | busy handler
14790 5d 20 74 68 61 74 20 73 6c 65 65 70 73 0a 2a 2a  ] that sleeps.**
147a0 20 66 6f 72 20 61 20 73 70 65 63 69 66 69 65 64   for a specified
147b0 20 61 6d 6f 75 6e 74 20 6f 66 20 74 69 6d 65 20   amount of time 
147c0 77 68 65 6e 20 61 20 74 61 62 6c 65 20 69 73 20  when a table is 
147d0 6c 6f 63 6b 65 64 2e 20 20 5e 54 68 65 20 68 61  locked.  ^The ha
147e0 6e 64 6c 65 72 0a 2a 2a 20 77 69 6c 6c 20 73 6c  ndler.** will sl
147f0 65 65 70 20 6d 75 6c 74 69 70 6c 65 20 74 69 6d  eep multiple tim
14800 65 73 20 75 6e 74 69 6c 20 61 74 20 6c 65 61 73  es until at leas
14810 74 20 22 6d 73 22 20 6d 69 6c 6c 69 73 65 63 6f  t "ms" milliseco
14820 6e 64 73 20 6f 66 20 73 6c 65 65 70 69 6e 67 0a  nds of sleeping.
14830 2a 2a 20 68 61 76 65 20 61 63 63 75 6d 75 6c 61  ** have accumula
14840 74 65 64 2e 20 20 5e 41 66 74 65 72 20 61 74 20  ted.  ^After at 
14850 6c 65 61 73 74 20 22 6d 73 22 20 6d 69 6c 6c 69  least "ms" milli
14860 73 65 63 6f 6e 64 73 20 6f 66 20 73 6c 65 65 70  seconds of sleep
14870 69 6e 67 2c 0a 2a 2a 20 74 68 65 20 68 61 6e 64  ing,.** the hand
14880 6c 65 72 20 72 65 74 75 72 6e 73 20 30 20 77 68  ler returns 0 wh
14890 69 63 68 20 63 61 75 73 65 73 20 5b 73 71 6c 69  ich causes [sqli
148a0 74 65 33 5f 73 74 65 70 28 29 5d 20 74 6f 20 72  te3_step()] to r
148b0 65 74 75 72 6e 0a 2a 2a 20 5b 53 51 4c 49 54 45  eturn.** [SQLITE
148c0 5f 42 55 53 59 5d 20 6f 72 20 5b 53 51 4c 49 54  _BUSY] or [SQLIT
148d0 45 5f 49 4f 45 52 52 5f 42 4c 4f 43 4b 45 44 5d  E_IOERR_BLOCKED]
148e0 2e 0a 2a 2a 0a 2a 2a 20 5e 43 61 6c 6c 69 6e 67  ..**.** ^Calling
148f0 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 77 69   this routine wi
14900 74 68 20 61 6e 20 61 72 67 75 6d 65 6e 74 20 6c  th an argument l
14910 65 73 73 20 74 68 61 6e 20 6f 72 20 65 71 75 61  ess than or equa
14920 6c 20 74 6f 20 7a 65 72 6f 0a 2a 2a 20 74 75 72  l to zero.** tur
14930 6e 73 20 6f 66 66 20 61 6c 6c 20 62 75 73 79 20  ns off all busy 
14940 68 61 6e 64 6c 65 72 73 2e 0a 2a 2a 0a 2a 2a 20  handlers..**.** 
14950 5e 28 54 68 65 72 65 20 63 61 6e 20 6f 6e 6c 79  ^(There can only
14960 20 62 65 20 61 20 73 69 6e 67 6c 65 20 62 75 73   be a single bus
14970 79 20 68 61 6e 64 6c 65 72 20 66 6f 72 20 61 20  y handler for a 
14980 70 61 72 74 69 63 75 6c 61 72 0a 2a 2a 20 5b 64  particular.** [d
14990 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
149a0 6f 6e 5d 20 61 6e 79 20 61 6e 79 20 67 69 76 65  on] any any give
149b0 6e 20 6d 6f 6d 65 6e 74 2e 20 20 49 66 20 61 6e  n moment.  If an
149c0 6f 74 68 65 72 20 62 75 73 79 20 68 61 6e 64 6c  other busy handl
149d0 65 72 0a 2a 2a 20 77 61 73 20 64 65 66 69 6e 65  er.** was define
149e0 64 20 20 28 75 73 69 6e 67 20 5b 73 71 6c 69 74  d  (using [sqlit
149f0 65 33 5f 62 75 73 79 5f 68 61 6e 64 6c 65 72 28  e3_busy_handler(
14a00 29 5d 29 20 70 72 69 6f 72 20 74 6f 20 63 61 6c  )]) prior to cal
14a10 6c 69 6e 67 0a 2a 2a 20 74 68 69 73 20 72 6f 75  ling.** this rou
14a20 74 69 6e 65 2c 20 74 68 61 74 20 6f 74 68 65 72  tine, that other
14a30 20 62 75 73 79 20 68 61 6e 64 6c 65 72 20 69 73   busy handler is
14a40 20 63 6c 65 61 72 65 64 2e 29 5e 0a 2a 2f 0a 69   cleared.)^.*/.i
14a50 6e 74 20 73 71 6c 69 74 65 33 5f 62 75 73 79 5f  nt sqlite3_busy_
14a60 74 69 6d 65 6f 75 74 28 73 71 6c 69 74 65 33 2a  timeout(sqlite3*
14a70 2c 20 69 6e 74 20 6d 73 29 3b 0a 0a 2f 2a 0a 2a  , int ms);../*.*
14a80 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6f 6e 76  * CAPI3REF: Conv
14a90 65 6e 69 65 6e 63 65 20 52 6f 75 74 69 6e 65 73  enience Routines
14aa0 20 46 6f 72 20 52 75 6e 6e 69 6e 67 20 51 75 65   For Running Que
14ab0 72 69 65 73 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20  ries.**.** This 
14ac0 69 73 20 61 20 6c 65 67 61 63 79 20 69 6e 74 65  is a legacy inte
14ad0 72 66 61 63 65 20 74 68 61 74 20 69 73 20 70 72  rface that is pr
14ae0 65 73 65 72 76 65 64 20 66 6f 72 20 62 61 63 6b  eserved for back
14af0 77 61 72 64 73 20 63 6f 6d 70 61 74 69 62 69 6c  wards compatibil
14b00 69 74 79 2e 0a 2a 2a 20 55 73 65 20 6f 66 20 74  ity..** Use of t
14b10 68 69 73 20 69 6e 74 65 72 66 61 63 65 20 69 73  his interface is
14b20 20 6e 6f 74 20 72 65 63 6f 6d 6d 65 6e 64 65 64   not recommended
14b30 2e 0a 2a 2a 0a 2a 2a 20 44 65 66 69 6e 69 74 69  ..**.** Definiti
14b40 6f 6e 3a 20 41 20 3c 62 3e 72 65 73 75 6c 74 20  on: A <b>result 
14b50 74 61 62 6c 65 3c 2f 62 3e 20 69 73 20 6d 65 6d  table</b> is mem
14b60 6f 72 79 20 64 61 74 61 20 73 74 72 75 63 74 75  ory data structu
14b70 72 65 20 63 72 65 61 74 65 64 20 62 79 20 74 68  re created by th
14b80 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 67 65  e.** [sqlite3_ge
14b90 74 5f 74 61 62 6c 65 28 29 5d 20 69 6e 74 65 72  t_table()] inter
14ba0 66 61 63 65 2e 20 20 41 20 72 65 73 75 6c 74 20  face.  A result 
14bb0 74 61 62 6c 65 20 72 65 63 6f 72 64 73 20 74 68  table records th
14bc0 65 0a 2a 2a 20 63 6f 6d 70 6c 65 74 65 20 71 75  e.** complete qu
14bd0 65 72 79 20 72 65 73 75 6c 74 73 20 66 72 6f 6d  ery results from
14be0 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 20 71 75 65   one or more que
14bf0 72 69 65 73 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  ries..**.** The 
14c00 74 61 62 6c 65 20 63 6f 6e 63 65 70 74 75 61 6c  table conceptual
14c10 6c 79 20 68 61 73 20 61 20 6e 75 6d 62 65 72 20  ly has a number 
14c20 6f 66 20 72 6f 77 73 20 61 6e 64 20 63 6f 6c 75  of rows and colu
14c30 6d 6e 73 2e 20 20 42 75 74 0a 2a 2a 20 74 68 65  mns.  But.** the
14c40 73 65 20 6e 75 6d 62 65 72 73 20 61 72 65 20 6e  se numbers are n
14c50 6f 74 20 70 61 72 74 20 6f 66 20 74 68 65 20 72  ot part of the r
14c60 65 73 75 6c 74 20 74 61 62 6c 65 20 69 74 73 65  esult table itse
14c70 6c 66 2e 20 20 54 68 65 73 65 0a 2a 2a 20 6e 75  lf.  These.** nu
14c80 6d 62 65 72 73 20 61 72 65 20 6f 62 74 61 69 6e  mbers are obtain
14c90 65 64 20 73 65 70 61 72 61 74 65 6c 79 2e 20 20  ed separately.  
14ca0 4c 65 74 20 4e 20 62 65 20 74 68 65 20 6e 75 6d  Let N be the num
14cb0 62 65 72 20 6f 66 20 72 6f 77 73 0a 2a 2a 20 61  ber of rows.** a
14cc0 6e 64 20 4d 20 62 65 20 74 68 65 20 6e 75 6d 62  nd M be the numb
14cd0 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 2e 0a 2a  er of columns..*
14ce0 2a 0a 2a 2a 20 41 20 72 65 73 75 6c 74 20 74 61  *.** A result ta
14cf0 62 6c 65 20 69 73 20 61 6e 20 61 72 72 61 79 20  ble is an array 
14d00 6f 66 20 70 6f 69 6e 74 65 72 73 20 74 6f 20 7a  of pointers to z
14d10 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 20 55  ero-terminated U
14d20 54 46 2d 38 20 73 74 72 69 6e 67 73 2e 0a 2a 2a  TF-8 strings..**
14d30 20 54 68 65 72 65 20 61 72 65 20 28 4e 2b 31 29   There are (N+1)
14d40 2a 4d 20 65 6c 65 6d 65 6e 74 73 20 69 6e 20 74  *M elements in t
14d50 68 65 20 61 72 72 61 79 2e 20 20 54 68 65 20 66  he array.  The f
14d60 69 72 73 74 20 4d 20 70 6f 69 6e 74 65 72 73 20  irst M pointers 
14d70 70 6f 69 6e 74 0a 2a 2a 20 74 6f 20 7a 65 72 6f  point.** to zero
14d80 2d 74 65 72 6d 69 6e 61 74 65 64 20 73 74 72 69  -terminated stri
14d90 6e 67 73 20 74 68 61 74 20 20 63 6f 6e 74 61 69  ngs that  contai
14da0 6e 20 74 68 65 20 6e 61 6d 65 73 20 6f 66 20 74  n the names of t
14db0 68 65 20 63 6f 6c 75 6d 6e 73 2e 0a 2a 2a 20 54  he columns..** T
14dc0 68 65 20 72 65 6d 61 69 6e 69 6e 67 20 65 6e 74  he remaining ent
14dd0 72 69 65 73 20 61 6c 6c 20 70 6f 69 6e 74 20 74  ries all point t
14de0 6f 20 71 75 65 72 79 20 72 65 73 75 6c 74 73 2e  o query results.
14df0 20 20 4e 55 4c 4c 20 76 61 6c 75 65 73 20 72 65    NULL values re
14e00 73 75 6c 74 0a 2a 2a 20 69 6e 20 4e 55 4c 4c 20  sult.** in NULL 
14e10 70 6f 69 6e 74 65 72 73 2e 20 20 41 6c 6c 20 6f  pointers.  All o
14e20 74 68 65 72 20 76 61 6c 75 65 73 20 61 72 65 20  ther values are 
14e30 69 6e 20 74 68 65 69 72 20 55 54 46 2d 38 20 7a  in their UTF-8 z
14e40 65 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 0a 2a  ero-terminated.*
14e50 2a 20 73 74 72 69 6e 67 20 72 65 70 72 65 73 65  * string represe
14e60 6e 74 61 74 69 6f 6e 20 61 73 20 72 65 74 75 72  ntation as retur
14e70 6e 65 64 20 62 79 20 5b 73 71 6c 69 74 65 33 5f  ned by [sqlite3_
14e80 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 29 5d 2e 0a  column_text()]..
14e90 2a 2a 0a 2a 2a 20 41 20 72 65 73 75 6c 74 20 74  **.** A result t
14ea0 61 62 6c 65 20 6d 69 67 68 74 20 63 6f 6e 73 69  able might consi
14eb0 73 74 20 6f 66 20 6f 6e 65 20 6f 72 20 6d 6f 72  st of one or mor
14ec0 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  e memory allocat
14ed0 69 6f 6e 73 2e 0a 2a 2a 20 49 74 20 69 73 20 6e  ions..** It is n
14ee0 6f 74 20 73 61 66 65 20 74 6f 20 70 61 73 73 20  ot safe to pass 
14ef0 61 20 72 65 73 75 6c 74 20 74 61 62 6c 65 20 64  a result table d
14f00 69 72 65 63 74 6c 79 20 74 6f 20 5b 73 71 6c 69  irectly to [sqli
14f10 74 65 33 5f 66 72 65 65 28 29 5d 2e 0a 2a 2a 20  te3_free()]..** 
14f20 41 20 72 65 73 75 6c 74 20 74 61 62 6c 65 20 73  A result table s
14f30 68 6f 75 6c 64 20 62 65 20 64 65 61 6c 6c 6f 63  hould be dealloc
14f40 61 74 65 64 20 75 73 69 6e 67 20 5b 73 71 6c 69  ated using [sqli
14f50 74 65 33 5f 66 72 65 65 5f 74 61 62 6c 65 28 29  te3_free_table()
14f60 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 28 41 73 20 61 6e  ]..**.** ^(As an
14f70 20 65 78 61 6d 70 6c 65 20 6f 66 20 74 68 65 20   example of the 
14f80 72 65 73 75 6c 74 20 74 61 62 6c 65 20 66 6f 72  result table for
14f90 6d 61 74 2c 20 73 75 70 70 6f 73 65 20 61 20 71  mat, suppose a q
14fa0 75 65 72 79 20 72 65 73 75 6c 74 0a 2a 2a 20 69  uery result.** i
14fb0 73 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a 2a 2a  s as follows:.**
14fc0 0a 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e  .** <blockquote>
14fd0 3c 70 72 65 3e 0a 2a 2a 20 20 20 20 20 20 20 20  <pre>.**        
14fe0 4e 61 6d 65 20 20 20 20 20 20 20 20 7c 20 41 67  Name        | Ag
14ff0 65 0a 2a 2a 20 20 20 20 20 20 20 20 2d 2d 2d 2d  e.**        ----
15000 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
15010 2d 2d 2d 0a 2a 2a 20 20 20 20 20 20 20 20 41 6c  ---.**        Al
15020 69 63 65 20 20 20 20 20 20 20 7c 20 34 33 0a 2a  ice       | 43.*
15030 2a 20 20 20 20 20 20 20 20 42 6f 62 20 20 20 20  *        Bob    
15040 20 20 20 20 20 7c 20 32 38 0a 2a 2a 20 20 20 20       | 28.**    
15050 20 20 20 20 43 69 6e 64 79 20 20 20 20 20 20 20      Cindy       
15060 7c 20 32 31 0a 2a 2a 20 3c 2f 70 72 65 3e 3c 2f  | 21.** </pre></
15070 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 2a 2a 0a 2a  blockquote>.**.*
15080 2a 20 54 68 65 72 65 20 61 72 65 20 74 77 6f 20  * There are two 
15090 63 6f 6c 75 6d 6e 20 28 4d 3d 3d 32 29 20 61 6e  column (M==2) an
150a0 64 20 74 68 72 65 65 20 72 6f 77 73 20 28 4e 3d  d three rows (N=
150b0 3d 33 29 2e 20 20 54 68 75 73 20 74 68 65 0a 2a  =3).  Thus the.*
150c0 2a 20 72 65 73 75 6c 74 20 74 61 62 6c 65 20 68  * result table h
150d0 61 73 20 38 20 65 6e 74 72 69 65 73 2e 20 20 53  as 8 entries.  S
150e0 75 70 70 6f 73 65 20 74 68 65 20 72 65 73 75 6c  uppose the resul
150f0 74 20 74 61 62 6c 65 20 69 73 20 73 74 6f 72 65  t table is store
15100 64 0a 2a 2a 20 69 6e 20 61 6e 20 61 72 72 61 79  d.** in an array
15110 20 6e 61 6d 65 73 20 61 7a 52 65 73 75 6c 74 2e   names azResult.
15120 20 20 54 68 65 6e 20 61 7a 52 65 73 75 6c 74 20    Then azResult 
15130 68 6f 6c 64 73 20 74 68 69 73 20 63 6f 6e 74 65  holds this conte
15140 6e 74 3a 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b  nt:.**.** <block
15150 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 2a 2a 20 20  quote><pre>.**  
15160 20 20 20 20 20 20 61 7a 52 65 73 75 6c 74 26 23        azResult&#
15170 39 31 3b 30 5d 20 3d 20 22 4e 61 6d 65 22 3b 0a  91;0] = "Name";.
15180 2a 2a 20 20 20 20 20 20 20 20 61 7a 52 65 73 75  **        azResu
15190 6c 74 26 23 39 31 3b 31 5d 20 3d 20 22 41 67 65  lt&#91;1] = "Age
151a0 22 3b 0a 2a 2a 20 20 20 20 20 20 20 20 61 7a 52  ";.**        azR
151b0 65 73 75 6c 74 26 23 39 31 3b 32 5d 20 3d 20 22  esult&#91;2] = "
151c0 41 6c 69 63 65 22 3b 0a 2a 2a 20 20 20 20 20 20  Alice";.**      
151d0 20 20 61 7a 52 65 73 75 6c 74 26 23 39 31 3b 33    azResult&#91;3
151e0 5d 20 3d 20 22 34 33 22 3b 0a 2a 2a 20 20 20 20  ] = "43";.**    
151f0 20 20 20 20 61 7a 52 65 73 75 6c 74 26 23 39 31      azResult&#91
15200 3b 34 5d 20 3d 20 22 42 6f 62 22 3b 0a 2a 2a 20  ;4] = "Bob";.** 
15210 20 20 20 20 20 20 20 61 7a 52 65 73 75 6c 74 26         azResult&
15220 23 39 31 3b 35 5d 20 3d 20 22 32 38 22 3b 0a 2a  #91;5] = "28";.*
15230 2a 20 20 20 20 20 20 20 20 61 7a 52 65 73 75 6c  *        azResul
15240 74 26 23 39 31 3b 36 5d 20 3d 20 22 43 69 6e 64  t&#91;6] = "Cind
15250 79 22 3b 0a 2a 2a 20 20 20 20 20 20 20 20 61 7a  y";.**        az
15260 52 65 73 75 6c 74 26 23 39 31 3b 37 5d 20 3d 20  Result&#91;7] = 
15270 22 32 31 22 3b 0a 2a 2a 20 3c 2f 70 72 65 3e 3c  "21";.** </pre><
15280 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 29 5e 0a 2a  /blockquote>)^.*
15290 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65  *.** ^The sqlite
152a0 33 5f 67 65 74 5f 74 61 62 6c 65 28 29 20 66 75  3_get_table() fu
152b0 6e 63 74 69 6f 6e 20 65 76 61 6c 75 61 74 65 73  nction evaluates
152c0 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 0a 2a 2a 20   one or more.** 
152d0 73 65 6d 69 63 6f 6c 6f 6e 2d 73 65 70 61 72 61  semicolon-separa
152e0 74 65 64 20 53 51 4c 20 73 74 61 74 65 6d 65 6e  ted SQL statemen
152f0 74 73 20 69 6e 20 74 68 65 20 7a 65 72 6f 2d 74  ts in the zero-t
15300 65 72 6d 69 6e 61 74 65 64 20 55 54 46 2d 38 0a  erminated UTF-8.
15310 2a 2a 20 73 74 72 69 6e 67 20 6f 66 20 69 74 73  ** string of its
15320 20 32 6e 64 20 70 61 72 61 6d 65 74 65 72 20 61   2nd parameter a
15330 6e 64 20 72 65 74 75 72 6e 73 20 61 20 72 65 73  nd returns a res
15340 75 6c 74 20 74 61 62 6c 65 20 74 6f 20 74 68 65  ult table to the
15350 0a 2a 2a 20 70 6f 69 6e 74 65 72 20 67 69 76 65  .** pointer give
15360 6e 20 69 6e 20 69 74 73 20 33 72 64 20 70 61 72  n in its 3rd par
15370 61 6d 65 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 41 66  ameter..**.** Af
15380 74 65 72 20 74 68 65 20 61 70 70 6c 69 63 61 74  ter the applicat
15390 69 6f 6e 20 68 61 73 20 66 69 6e 69 73 68 65 64  ion has finished
153a0 20 77 69 74 68 20 74 68 65 20 72 65 73 75 6c 74   with the result
153b0 20 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f 67 65   from sqlite3_ge
153c0 74 5f 74 61 62 6c 65 28 29 2c 0a 2a 2a 20 69 74  t_table(),.** it
153d0 20 6d 75 73 74 20 70 61 73 73 20 74 68 65 20 72   must pass the r
153e0 65 73 75 6c 74 20 74 61 62 6c 65 20 70 6f 69 6e  esult table poin
153f0 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 66  ter to sqlite3_f
15400 72 65 65 5f 74 61 62 6c 65 28 29 20 69 6e 20 6f  ree_table() in o
15410 72 64 65 72 20 74 6f 0a 2a 2a 20 72 65 6c 65 61  rder to.** relea
15420 73 65 20 74 68 65 20 6d 65 6d 6f 72 79 20 74 68  se the memory th
15430 61 74 20 77 61 73 20 6d 61 6c 6c 6f 63 65 64 2e  at was malloced.
15440 20 20 42 65 63 61 75 73 65 20 6f 66 20 74 68 65    Because of the
15450 20 77 61 79 20 74 68 65 0a 2a 2a 20 5b 73 71 6c   way the.** [sql
15460 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 20 68  ite3_malloc()] h
15470 61 70 70 65 6e 73 20 77 69 74 68 69 6e 20 73 71  appens within sq
15480 6c 69 74 65 33 5f 67 65 74 5f 74 61 62 6c 65 28  lite3_get_table(
15490 29 2c 20 74 68 65 20 63 61 6c 6c 69 6e 67 0a 2a  ), the calling.*
154a0 2a 20 66 75 6e 63 74 69 6f 6e 20 6d 75 73 74 20  * function must 
154b0 6e 6f 74 20 74 72 79 20 74 6f 20 63 61 6c 6c 20  not try to call 
154c0 5b 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29 5d  [sqlite3_free()]
154d0 20 64 69 72 65 63 74 6c 79 2e 20 20 4f 6e 6c 79   directly.  Only
154e0 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 66 72 65  .** [sqlite3_fre
154f0 65 5f 74 61 62 6c 65 28 29 5d 20 69 73 20 61 62  e_table()] is ab
15500 6c 65 20 74 6f 20 72 65 6c 65 61 73 65 20 74 68  le to release th
15510 65 20 6d 65 6d 6f 72 79 20 70 72 6f 70 65 72 6c  e memory properl
15520 79 20 61 6e 64 20 73 61 66 65 6c 79 2e 0a 2a 2a  y and safely..**
15530 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65 33 5f  .** The sqlite3_
15540 67 65 74 5f 74 61 62 6c 65 28 29 20 69 6e 74 65  get_table() inte
15550 72 66 61 63 65 20 69 73 20 69 6d 70 6c 65 6d 65  rface is impleme
15560 6e 74 65 64 20 61 73 20 61 20 77 72 61 70 70 65  nted as a wrappe
15570 72 20 61 72 6f 75 6e 64 0a 2a 2a 20 5b 73 71 6c  r around.** [sql
15580 69 74 65 33 5f 65 78 65 63 28 29 5d 2e 20 20 54  ite3_exec()].  T
15590 68 65 20 73 71 6c 69 74 65 33 5f 67 65 74 5f 74  he sqlite3_get_t
155a0 61 62 6c 65 28 29 20 72 6f 75 74 69 6e 65 20 64  able() routine d
155b0 6f 65 73 20 6e 6f 74 20 68 61 76 65 20 61 63 63  oes not have acc
155c0 65 73 73 0a 2a 2a 20 74 6f 20 61 6e 79 20 69 6e  ess.** to any in
155d0 74 65 72 6e 61 6c 20 64 61 74 61 20 73 74 72 75  ternal data stru
155e0 63 74 75 72 65 73 20 6f 66 20 53 51 4c 69 74 65  ctures of SQLite
155f0 2e 20 20 49 74 20 75 73 65 73 20 6f 6e 6c 79 20  .  It uses only 
15600 74 68 65 20 70 75 62 6c 69 63 0a 2a 2a 20 69 6e  the public.** in
15610 74 65 72 66 61 63 65 20 64 65 66 69 6e 65 64 20  terface defined 
15620 68 65 72 65 2e 20 20 41 73 20 61 20 63 6f 6e 73  here.  As a cons
15630 65 71 75 65 6e 63 65 2c 20 65 72 72 6f 72 73 20  equence, errors 
15640 74 68 61 74 20 6f 63 63 75 72 20 69 6e 20 74 68  that occur in th
15650 65 0a 2a 2a 20 77 72 61 70 70 65 72 20 6c 61 79  e.** wrapper lay
15660 65 72 20 6f 75 74 73 69 64 65 20 6f 66 20 74 68  er outside of th
15670 65 20 69 6e 74 65 72 6e 61 6c 20 5b 73 71 6c 69  e internal [sqli
15680 74 65 33 5f 65 78 65 63 28 29 5d 20 63 61 6c 6c  te3_exec()] call
15690 20 61 72 65 20 6e 6f 74 0a 2a 2a 20 72 65 66 6c   are not.** refl
156a0 65 63 74 65 64 20 69 6e 20 73 75 62 73 65 71 75  ected in subsequ
156b0 65 6e 74 20 63 61 6c 6c 73 20 74 6f 20 5b 73 71  ent calls to [sq
156c0 6c 69 74 65 33 5f 65 72 72 63 6f 64 65 28 29 5d  lite3_errcode()]
156d0 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f   or.** [sqlite3_
156e0 65 72 72 6d 73 67 28 29 5d 2e 0a 2a 2f 0a 69 6e  errmsg()]..*/.in
156f0 74 20 73 71 6c 69 74 65 33 5f 67 65 74 5f 74 61  t sqlite3_get_ta
15700 62 6c 65 28 0a 20 20 73 71 6c 69 74 65 33 20 2a  ble(.  sqlite3 *
15710 64 62 2c 20 20 20 20 20 20 20 20 20 20 2f 2a 20  db,          /* 
15720 41 6e 20 6f 70 65 6e 20 64 61 74 61 62 61 73 65  An open database
15730 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 63 68 61 72   */.  const char
15740 20 2a 7a 53 71 6c 2c 20 20 20 20 20 2f 2a 20 53   *zSql,     /* S
15750 51 4c 20 74 6f 20 62 65 20 65 76 61 6c 75 61 74  QL to be evaluat
15760 65 64 20 2a 2f 0a 20 20 63 68 61 72 20 2a 2a 2a  ed */.  char ***
15770 70 61 7a 52 65 73 75 6c 74 2c 20 20 20 20 2f 2a  pazResult,    /*
15780 20 52 65 73 75 6c 74 73 20 6f 66 20 74 68 65 20   Results of the 
15790 71 75 65 72 79 20 2a 2f 0a 20 20 69 6e 74 20 2a  query */.  int *
157a0 70 6e 52 6f 77 2c 20 20 20 20 20 20 20 20 20 20  pnRow,          
157b0 20 2f 2a 20 4e 75 6d 62 65 72 20 6f 66 20 72 65   /* Number of re
157c0 73 75 6c 74 20 72 6f 77 73 20 77 72 69 74 74 65  sult rows writte
157d0 6e 20 68 65 72 65 20 2a 2f 0a 20 20 69 6e 74 20  n here */.  int 
157e0 2a 70 6e 43 6f 6c 75 6d 6e 2c 20 20 20 20 20 20  *pnColumn,      
157f0 20 20 2f 2a 20 4e 75 6d 62 65 72 20 6f 66 20 72    /* Number of r
15800 65 73 75 6c 74 20 63 6f 6c 75 6d 6e 73 20 77 72  esult columns wr
15810 69 74 74 65 6e 20 68 65 72 65 20 2a 2f 0a 20 20  itten here */.  
15820 63 68 61 72 20 2a 2a 70 7a 45 72 72 6d 73 67 20  char **pzErrmsg 
15830 20 20 20 20 20 20 2f 2a 20 45 72 72 6f 72 20 6d        /* Error m
15840 73 67 20 77 72 69 74 74 65 6e 20 68 65 72 65 20  sg written here 
15850 2a 2f 0a 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74  */.);.void sqlit
15860 65 33 5f 66 72 65 65 5f 74 61 62 6c 65 28 63 68  e3_free_table(ch
15870 61 72 20 2a 2a 72 65 73 75 6c 74 29 3b 0a 0a 2f  ar **result);../
15880 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 46  *.** CAPI3REF: F
15890 6f 72 6d 61 74 74 65 64 20 53 74 72 69 6e 67 20  ormatted String 
158a0 50 72 69 6e 74 69 6e 67 20 46 75 6e 63 74 69 6f  Printing Functio
158b0 6e 73 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72  ns.**.** These r
158c0 6f 75 74 69 6e 65 73 20 61 72 65 20 77 6f 72 6b  outines are work
158d0 2d 61 6c 69 6b 65 73 20 6f 66 20 74 68 65 20 22  -alikes of the "
158e0 70 72 69 6e 74 66 28 29 22 20 66 61 6d 69 6c 79  printf()" family
158f0 20 6f 66 20 66 75 6e 63 74 69 6f 6e 73 0a 2a 2a   of functions.**
15900 20 66 72 6f 6d 20 74 68 65 20 73 74 61 6e 64 61   from the standa
15910 72 64 20 43 20 6c 69 62 72 61 72 79 2e 0a 2a 2a  rd C library..**
15920 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33  .** ^The sqlite3
15930 5f 6d 70 72 69 6e 74 66 28 29 20 61 6e 64 20 73  _mprintf() and s
15940 71 6c 69 74 65 33 5f 76 6d 70 72 69 6e 74 66 28  qlite3_vmprintf(
15950 29 20 72 6f 75 74 69 6e 65 73 20 77 72 69 74 65  ) routines write
15960 20 74 68 65 69 72 0a 2a 2a 20 72 65 73 75 6c 74   their.** result
15970 73 20 69 6e 74 6f 20 6d 65 6d 6f 72 79 20 6f 62  s into memory ob
15980 74 61 69 6e 65 64 20 66 72 6f 6d 20 5b 73 71 6c  tained from [sql
15990 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 5d 2e 0a  ite3_malloc()]..
159a0 2a 2a 20 54 68 65 20 73 74 72 69 6e 67 73 20 72  ** The strings r
159b0 65 74 75 72 6e 65 64 20 62 79 20 74 68 65 73 65  eturned by these
159c0 20 74 77 6f 20 72 6f 75 74 69 6e 65 73 20 73 68   two routines sh
159d0 6f 75 6c 64 20 62 65 0a 2a 2a 20 72 65 6c 65 61  ould be.** relea
159e0 73 65 64 20 62 79 20 5b 73 71 6c 69 74 65 33 5f  sed by [sqlite3_
159f0 66 72 65 65 28 29 5d 2e 20 20 5e 42 6f 74 68 20  free()].  ^Both 
15a00 72 6f 75 74 69 6e 65 73 20 72 65 74 75 72 6e 20  routines return 
15a10 61 0a 2a 2a 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  a.** NULL pointe
15a20 72 20 69 66 20 5b 73 71 6c 69 74 65 33 5f 6d 61  r if [sqlite3_ma
15a30 6c 6c 6f 63 28 29 5d 20 69 73 20 75 6e 61 62 6c  lloc()] is unabl
15a40 65 20 74 6f 20 61 6c 6c 6f 63 61 74 65 20 65 6e  e to allocate en
15a50 6f 75 67 68 0a 2a 2a 20 6d 65 6d 6f 72 79 20 74  ough.** memory t
15a60 6f 20 68 6f 6c 64 20 74 68 65 20 72 65 73 75 6c  o hold the resul
15a70 74 69 6e 67 20 73 74 72 69 6e 67 2e 0a 2a 2a 0a  ting string..**.
15a80 2a 2a 20 5e 28 49 6e 20 73 71 6c 69 74 65 33 5f  ** ^(In sqlite3_
15a90 73 6e 70 72 69 6e 74 66 28 29 20 72 6f 75 74 69  snprintf() routi
15aa0 6e 65 20 69 73 20 73 69 6d 69 6c 61 72 20 74 6f  ne is similar to
15ab0 20 22 73 6e 70 72 69 6e 74 66 28 29 22 20 66 72   "snprintf()" fr
15ac0 6f 6d 0a 2a 2a 20 74 68 65 20 73 74 61 6e 64 61  om.** the standa
15ad0 72 64 20 43 20 6c 69 62 72 61 72 79 2e 20 20 54  rd C library.  T
15ae0 68 65 20 72 65 73 75 6c 74 20 69 73 20 77 72 69  he result is wri
15af0 74 74 65 6e 20 69 6e 74 6f 20 74 68 65 0a 2a 2a  tten into the.**
15b00 20 62 75 66 66 65 72 20 73 75 70 70 6c 69 65 64   buffer supplied
15b10 20 61 73 20 74 68 65 20 73 65 63 6f 6e 64 20 70   as the second p
15b20 61 72 61 6d 65 74 65 72 20 77 68 6f 73 65 20 73  arameter whose s
15b30 69 7a 65 20 69 73 20 67 69 76 65 6e 20 62 79 0a  ize is given by.
15b40 2a 2a 20 74 68 65 20 66 69 72 73 74 20 70 61 72  ** the first par
15b50 61 6d 65 74 65 72 2e 20 4e 6f 74 65 20 74 68 61  ameter. Note tha
15b60 74 20 74 68 65 20 6f 72 64 65 72 20 6f 66 20 74  t the order of t
15b70 68 65 0a 2a 2a 20 66 69 72 73 74 20 74 77 6f 20  he.** first two 
15b80 70 61 72 61 6d 65 74 65 72 73 20 69 73 20 72 65  parameters is re
15b90 76 65 72 73 65 64 20 66 72 6f 6d 20 73 6e 70 72  versed from snpr
15ba0 69 6e 74 66 28 29 2e 29 5e 20 20 54 68 69 73 20  intf().)^  This 
15bb0 69 73 20 61 6e 0a 2a 2a 20 68 69 73 74 6f 72 69  is an.** histori
15bc0 63 61 6c 20 61 63 63 69 64 65 6e 74 20 74 68 61  cal accident tha
15bd0 74 20 63 61 6e 6e 6f 74 20 62 65 20 66 69 78 65  t cannot be fixe
15be0 64 20 77 69 74 68 6f 75 74 20 62 72 65 61 6b 69  d without breaki
15bf0 6e 67 0a 2a 2a 20 62 61 63 6b 77 61 72 64 73 20  ng.** backwards 
15c00 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 2e 20 20  compatibility.  
15c10 5e 28 4e 6f 74 65 20 61 6c 73 6f 20 74 68 61 74  ^(Note also that
15c20 20 73 71 6c 69 74 65 33 5f 73 6e 70 72 69 6e 74   sqlite3_snprint
15c30 66 28 29 0a 2a 2a 20 72 65 74 75 72 6e 73 20 61  f().** returns a
15c40 20 70 6f 69 6e 74 65 72 20 74 6f 20 69 74 73 20   pointer to its 
15c50 62 75 66 66 65 72 20 69 6e 73 74 65 61 64 20 6f  buffer instead o
15c60 66 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 0a  f the number of.
15c70 2a 2a 20 63 68 61 72 61 63 74 65 72 73 20 61 63  ** characters ac
15c80 74 75 61 6c 6c 79 20 77 72 69 74 74 65 6e 20 69  tually written i
15c90 6e 74 6f 20 74 68 65 20 62 75 66 66 65 72 2e 29  nto the buffer.)
15ca0 5e 20 20 57 65 20 61 64 6d 69 74 20 74 68 61 74  ^  We admit that
15cb0 0a 2a 2a 20 74 68 65 20 6e 75 6d 62 65 72 20 6f  .** the number o
15cc0 66 20 63 68 61 72 61 63 74 65 72 73 20 77 72 69  f characters wri
15cd0 74 74 65 6e 20 77 6f 75 6c 64 20 62 65 20 61 20  tten would be a 
15ce0 6d 6f 72 65 20 75 73 65 66 75 6c 20 72 65 74 75  more useful retu
15cf0 72 6e 0a 2a 2a 20 76 61 6c 75 65 20 62 75 74 20  rn.** value but 
15d00 77 65 20 63 61 6e 6e 6f 74 20 63 68 61 6e 67 65  we cannot change
15d10 20 74 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74   the implementat
15d20 69 6f 6e 20 6f 66 20 73 71 6c 69 74 65 33 5f 73  ion of sqlite3_s
15d30 6e 70 72 69 6e 74 66 28 29 0a 2a 2a 20 6e 6f 77  nprintf().** now
15d40 20 77 69 74 68 6f 75 74 20 62 72 65 61 6b 69 6e   without breakin
15d50 67 20 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 2e  g compatibility.
15d60 0a 2a 2a 0a 2a 2a 20 5e 41 73 20 6c 6f 6e 67 20  .**.** ^As long 
15d70 61 73 20 74 68 65 20 62 75 66 66 65 72 20 73 69  as the buffer si
15d80 7a 65 20 69 73 20 67 72 65 61 74 65 72 20 74 68  ze is greater th
15d90 61 6e 20 7a 65 72 6f 2c 20 73 71 6c 69 74 65 33  an zero, sqlite3
15da0 5f 73 6e 70 72 69 6e 74 66 28 29 0a 2a 2a 20 67  _snprintf().** g
15db0 75 61 72 61 6e 74 65 65 73 20 74 68 61 74 20 74  uarantees that t
15dc0 68 65 20 62 75 66 66 65 72 20 69 73 20 61 6c 77  he buffer is alw
15dd0 61 79 73 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61  ays zero-termina
15de0 74 65 64 2e 20 20 5e 54 68 65 20 66 69 72 73 74  ted.  ^The first
15df0 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72 20 22 6e  .** parameter "n
15e00 22 20 69 73 20 74 68 65 20 74 6f 74 61 6c 20 73  " is the total s
15e10 69 7a 65 20 6f 66 20 74 68 65 20 62 75 66 66 65  ize of the buffe
15e20 72 2c 20 69 6e 63 6c 75 64 69 6e 67 20 73 70 61  r, including spa
15e30 63 65 20 66 6f 72 0a 2a 2a 20 74 68 65 20 7a 65  ce for.** the ze
15e40 72 6f 20 74 65 72 6d 69 6e 61 74 6f 72 2e 20 20  ro terminator.  
15e50 53 6f 20 74 68 65 20 6c 6f 6e 67 65 73 74 20 73  So the longest s
15e60 74 72 69 6e 67 20 74 68 61 74 20 63 61 6e 20 62  tring that can b
15e70 65 20 63 6f 6d 70 6c 65 74 65 6c 79 0a 2a 2a 20  e completely.** 
15e80 77 72 69 74 74 65 6e 20 77 69 6c 6c 20 62 65 20  written will be 
15e90 6e 2d 31 20 63 68 61 72 61 63 74 65 72 73 2e 0a  n-1 characters..
15ea0 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  **.** ^The sqlit
15eb0 65 33 5f 76 73 6e 70 72 69 6e 74 66 28 29 20 72  e3_vsnprintf() r
15ec0 6f 75 74 69 6e 65 20 69 73 20 61 20 76 61 72 61  outine is a vara
15ed0 72 67 73 20 76 65 72 73 69 6f 6e 20 6f 66 20 73  rgs version of s
15ee0 71 6c 69 74 65 33 5f 73 6e 70 72 69 6e 74 66 28  qlite3_snprintf(
15ef0 29 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72  )..**.** These r
15f00 6f 75 74 69 6e 65 73 20 61 6c 6c 20 69 6d 70 6c  outines all impl
15f10 65 6d 65 6e 74 20 73 6f 6d 65 20 61 64 64 69 74  ement some addit
15f20 69 6f 6e 61 6c 20 66 6f 72 6d 61 74 74 69 6e 67  ional formatting
15f30 0a 2a 2a 20 6f 70 74 69 6f 6e 73 20 74 68 61 74  .** options that
15f40 20 61 72 65 20 75 73 65 66 75 6c 20 66 6f 72 20   are useful for 
15f50 63 6f 6e 73 74 72 75 63 74 69 6e 67 20 53 51 4c  constructing SQL
15f60 20 73 74 61 74 65 6d 65 6e 74 73 2e 0a 2a 2a 20   statements..** 
15f70 41 6c 6c 20 6f 66 20 74 68 65 20 75 73 75 61 6c  All of the usual
15f80 20 70 72 69 6e 74 66 28 29 20 66 6f 72 6d 61 74   printf() format
15f90 74 69 6e 67 20 6f 70 74 69 6f 6e 73 20 61 70 70  ting options app
15fa0 6c 79 2e 20 20 49 6e 20 61 64 64 69 74 69 6f 6e  ly.  In addition
15fb0 2c 20 74 68 65 72 65 0a 2a 2a 20 69 73 20 61 72  , there.** is ar
15fc0 65 20 22 25 71 22 2c 20 22 25 51 22 2c 20 61 6e  e "%q", "%Q", an
15fd0 64 20 22 25 7a 22 20 6f 70 74 69 6f 6e 73 2e 0a  d "%z" options..
15fe0 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20 25 71 20 6f  **.** ^(The %q o
15ff0 70 74 69 6f 6e 20 77 6f 72 6b 73 20 6c 69 6b 65  ption works like
16000 20 25 73 20 69 6e 20 74 68 61 74 20 69 74 20 73   %s in that it s
16010 75 62 73 74 69 74 75 74 65 73 20 61 20 6e 75 6c  ubstitutes a nul
16020 6c 2d 74 65 72 6d 69 6e 61 74 65 64 0a 2a 2a 20  l-terminated.** 
16030 73 74 72 69 6e 67 20 66 72 6f 6d 20 74 68 65 20  string from the 
16040 61 72 67 75 6d 65 6e 74 20 6c 69 73 74 2e 20 20  argument list.  
16050 42 75 74 20 25 71 20 61 6c 73 6f 20 64 6f 75 62  But %q also doub
16060 6c 65 73 20 65 76 65 72 79 20 27 5c 27 27 20 63  les every '\'' c
16070 68 61 72 61 63 74 65 72 2e 0a 2a 2a 20 25 71 20  haracter..** %q 
16080 69 73 20 64 65 73 69 67 6e 65 64 20 66 6f 72 20  is designed for 
16090 75 73 65 20 69 6e 73 69 64 65 20 61 20 73 74 72  use inside a str
160a0 69 6e 67 20 6c 69 74 65 72 61 6c 2e 29 5e 20 20  ing literal.)^  
160b0 42 79 20 64 6f 75 62 6c 69 6e 67 20 65 61 63 68  By doubling each
160c0 20 27 5c 27 27 0a 2a 2a 20 63 68 61 72 61 63 74   '\''.** charact
160d0 65 72 20 69 74 20 65 73 63 61 70 65 73 20 74 68  er it escapes th
160e0 61 74 20 63 68 61 72 61 63 74 65 72 20 61 6e 64  at character and
160f0 20 61 6c 6c 6f 77 73 20 69 74 20 74 6f 20 62 65   allows it to be
16100 20 69 6e 73 65 72 74 65 64 20 69 6e 74 6f 0a 2a   inserted into.*
16110 2a 20 74 68 65 20 73 74 72 69 6e 67 2e 0a 2a 2a  * the string..**
16120 0a 2a 2a 20 46 6f 72 20 65 78 61 6d 70 6c 65 2c  .** For example,
16130 20 61 73 73 75 6d 65 20 74 68 65 20 73 74 72 69   assume the stri
16140 6e 67 20 76 61 72 69 61 62 6c 65 20 7a 54 65 78  ng variable zTex
16150 74 20 63 6f 6e 74 61 69 6e 73 20 74 65 78 74 20  t contains text 
16160 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a 2a 2a 0a 2a  as follows:.**.*
16170 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70  * <blockquote><p
16180 72 65 3e 0a 2a 2a 20 20 63 68 61 72 20 2a 7a 54  re>.**  char *zT
16190 65 78 74 20 3d 20 22 49 74 27 73 20 61 20 68 61  ext = "It's a ha
161a0 70 70 79 20 64 61 79 21 22 3b 0a 2a 2a 20 3c 2f  ppy day!";.** </
161b0 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65  pre></blockquote
161c0 3e 0a 2a 2a 0a 2a 2a 20 4f 6e 65 20 63 61 6e 20  >.**.** One can 
161d0 75 73 65 20 74 68 69 73 20 74 65 78 74 20 69 6e  use this text in
161e0 20 61 6e 20 53 51 4c 20 73 74 61 74 65 6d 65 6e   an SQL statemen
161f0 74 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a 2a 2a  t as follows:.**
16200 0a 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e  .** <blockquote>
16210 3c 70 72 65 3e 0a 2a 2a 20 20 63 68 61 72 20 2a  <pre>.**  char *
16220 7a 53 51 4c 20 3d 20 73 71 6c 69 74 65 33 5f 6d  zSQL = sqlite3_m
16230 70 72 69 6e 74 66 28 22 49 4e 53 45 52 54 20 49  printf("INSERT I
16240 4e 54 4f 20 74 61 62 6c 65 20 56 41 4c 55 45 53  NTO table VALUES
16250 28 27 25 71 27 29 22 2c 20 7a 54 65 78 74 29 3b  ('%q')", zText);
16260 0a 2a 2a 20 20 73 71 6c 69 74 65 33 5f 65 78 65  .**  sqlite3_exe
16270 63 28 64 62 2c 20 7a 53 51 4c 2c 20 30 2c 20 30  c(db, zSQL, 0, 0
16280 2c 20 30 29 3b 0a 2a 2a 20 20 73 71 6c 69 74 65  , 0);.**  sqlite
16290 33 5f 66 72 65 65 28 7a 53 51 4c 29 3b 0a 2a 2a  3_free(zSQL);.**
162a0 20 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75   </pre></blockqu
162b0 6f 74 65 3e 0a 2a 2a 0a 2a 2a 20 42 65 63 61 75  ote>.**.** Becau
162c0 73 65 20 74 68 65 20 25 71 20 66 6f 72 6d 61 74  se the %q format
162d0 20 73 74 72 69 6e 67 20 69 73 20 75 73 65 64 2c   string is used,
162e0 20 74 68 65 20 27 5c 27 27 20 63 68 61 72 61 63   the '\'' charac
162f0 74 65 72 20 69 6e 20 7a 54 65 78 74 0a 2a 2a 20  ter in zText.** 
16300 69 73 20 65 73 63 61 70 65 64 20 61 6e 64 20 74  is escaped and t
16310 68 65 20 53 51 4c 20 67 65 6e 65 72 61 74 65 64  he SQL generated
16320 20 69 73 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a   is as follows:.
16330 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74  **.** <blockquot
16340 65 3e 3c 70 72 65 3e 0a 2a 2a 20 20 49 4e 53 45  e><pre>.**  INSE
16350 52 54 20 49 4e 54 4f 20 74 61 62 6c 65 31 20 56  RT INTO table1 V
16360 41 4c 55 45 53 28 27 49 74 27 27 73 20 61 20 68  ALUES('It''s a h
16370 61 70 70 79 20 64 61 79 21 27 29 0a 2a 2a 20 3c  appy day!').** <
16380 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74  /pre></blockquot
16390 65 3e 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 69 73  e>.**.** This is
163a0 20 63 6f 72 72 65 63 74 2e 20 20 48 61 64 20 77   correct.  Had w
163b0 65 20 75 73 65 64 20 25 73 20 69 6e 73 74 65 61  e used %s instea
163c0 64 20 6f 66 20 25 71 2c 20 74 68 65 20 67 65 6e  d of %q, the gen
163d0 65 72 61 74 65 64 20 53 51 4c 0a 2a 2a 20 77 6f  erated SQL.** wo
163e0 75 6c 64 20 68 61 76 65 20 6c 6f 6f 6b 65 64 20  uld have looked 
163f0 6c 69 6b 65 20 74 68 69 73 3a 0a 2a 2a 0a 2a 2a  like this:.**.**
16400 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72   <blockquote><pr
16410 65 3e 0a 2a 2a 20 20 49 4e 53 45 52 54 20 49 4e  e>.**  INSERT IN
16420 54 4f 20 74 61 62 6c 65 31 20 56 41 4c 55 45 53  TO table1 VALUES
16430 28 27 49 74 27 73 20 61 20 68 61 70 70 79 20 64  ('It's a happy d
16440 61 79 21 27 29 3b 0a 2a 2a 20 3c 2f 70 72 65 3e  ay!');.** </pre>
16450 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 2a 2a  </blockquote>.**
16460 0a 2a 2a 20 54 68 69 73 20 73 65 63 6f 6e 64 20  .** This second 
16470 65 78 61 6d 70 6c 65 20 69 73 20 61 6e 20 53 51  example is an SQ
16480 4c 20 73 79 6e 74 61 78 20 65 72 72 6f 72 2e 20  L syntax error. 
16490 20 41 73 20 61 20 67 65 6e 65 72 61 6c 20 72 75   As a general ru
164a0 6c 65 20 79 6f 75 20 73 68 6f 75 6c 64 0a 2a 2a  le you should.**
164b0 20 61 6c 77 61 79 73 20 75 73 65 20 25 71 20 69   always use %q i
164c0 6e 73 74 65 61 64 20 6f 66 20 25 73 20 77 68 65  nstead of %s whe
164d0 6e 20 69 6e 73 65 72 74 69 6e 67 20 74 65 78 74  n inserting text
164e0 20 69 6e 74 6f 20 61 20 73 74 72 69 6e 67 20 6c   into a string l
164f0 69 74 65 72 61 6c 2e 0a 2a 2a 0a 2a 2a 20 5e 28  iteral..**.** ^(
16500 54 68 65 20 25 51 20 6f 70 74 69 6f 6e 20 77 6f  The %Q option wo
16510 72 6b 73 20 6c 69 6b 65 20 25 71 20 65 78 63 65  rks like %q exce
16520 70 74 20 69 74 20 61 6c 73 6f 20 61 64 64 73 20  pt it also adds 
16530 73 69 6e 67 6c 65 20 71 75 6f 74 65 73 20 61 72  single quotes ar
16540 6f 75 6e 64 0a 2a 2a 20 74 68 65 20 6f 75 74 73  ound.** the outs
16550 69 64 65 20 6f 66 20 74 68 65 20 74 6f 74 61 6c  ide of the total
16560 20 73 74 72 69 6e 67 2e 20 20 41 64 64 69 74 69   string.  Additi
16570 6f 6e 61 6c 6c 79 2c 20 69 66 20 74 68 65 20 70  onally, if the p
16580 61 72 61 6d 65 74 65 72 20 69 6e 20 74 68 65 0a  arameter in the.
16590 2a 2a 20 61 72 67 75 6d 65 6e 74 20 6c 69 73 74  ** argument list
165a0 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74   is a NULL point
165b0 65 72 2c 20 25 51 20 73 75 62 73 74 69 74 75 74  er, %Q substitut
165c0 65 73 20 74 68 65 20 74 65 78 74 20 22 4e 55 4c  es the text "NUL
165d0 4c 22 20 28 77 69 74 68 6f 75 74 0a 2a 2a 20 73  L" (without.** s
165e0 69 6e 67 6c 65 20 71 75 6f 74 65 73 29 2e 29 5e  ingle quotes).)^
165f0 20 20 53 6f 2c 20 66 6f 72 20 65 78 61 6d 70 6c    So, for exampl
16600 65 2c 20 6f 6e 65 20 63 6f 75 6c 64 20 73 61 79  e, one could say
16610 3a 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71 75  :.**.** <blockqu
16620 6f 74 65 3e 3c 70 72 65 3e 0a 2a 2a 20 20 63 68  ote><pre>.**  ch
16630 61 72 20 2a 7a 53 51 4c 20 3d 20 73 71 6c 69 74  ar *zSQL = sqlit
16640 65 33 5f 6d 70 72 69 6e 74 66 28 22 49 4e 53 45  e3_mprintf("INSE
16650 52 54 20 49 4e 54 4f 20 74 61 62 6c 65 20 56 41  RT INTO table VA
16660 4c 55 45 53 28 25 51 29 22 2c 20 7a 54 65 78 74  LUES(%Q)", zText
16670 29 3b 0a 2a 2a 20 20 73 71 6c 69 74 65 33 5f 65  );.**  sqlite3_e
16680 78 65 63 28 64 62 2c 20 7a 53 51 4c 2c 20 30 2c  xec(db, zSQL, 0,
16690 20 30 2c 20 30 29 3b 0a 2a 2a 20 20 73 71 6c 69   0, 0);.**  sqli
166a0 74 65 33 5f 66 72 65 65 28 7a 53 51 4c 29 3b 0a  te3_free(zSQL);.
166b0 2a 2a 20 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b  ** </pre></block
166c0 71 75 6f 74 65 3e 0a 2a 2a 0a 2a 2a 20 54 68 65  quote>.**.** The
166d0 20 63 6f 64 65 20 61 62 6f 76 65 20 77 69 6c 6c   code above will
166e0 20 72 65 6e 64 65 72 20 61 20 63 6f 72 72 65 63   render a correc
166f0 74 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20  t SQL statement 
16700 69 6e 20 74 68 65 20 7a 53 51 4c 0a 2a 2a 20 76  in the zSQL.** v
16710 61 72 69 61 62 6c 65 20 65 76 65 6e 20 69 66 20  ariable even if 
16720 74 68 65 20 7a 54 65 78 74 20 76 61 72 69 61 62  the zText variab
16730 6c 65 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f 69  le is a NULL poi
16740 6e 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68  nter..**.** ^(Th
16750 65 20 22 25 7a 22 20 66 6f 72 6d 61 74 74 69 6e  e "%z" formattin
16760 67 20 6f 70 74 69 6f 6e 20 77 6f 72 6b 73 20 6c  g option works l
16770 69 6b 65 20 22 25 73 22 20 62 75 74 20 77 69 74  ike "%s" but wit
16780 68 20 74 68 65 0a 2a 2a 20 61 64 64 69 74 69 6f  h the.** additio
16790 6e 20 74 68 61 74 20 61 66 74 65 72 20 74 68 65  n that after the
167a0 20 73 74 72 69 6e 67 20 68 61 73 20 62 65 65 6e   string has been
167b0 20 72 65 61 64 20 61 6e 64 20 63 6f 70 69 65 64   read and copied
167c0 20 69 6e 74 6f 0a 2a 2a 20 74 68 65 20 72 65 73   into.** the res
167d0 75 6c 74 2c 20 5b 73 71 6c 69 74 65 33 5f 66 72  ult, [sqlite3_fr
167e0 65 65 28 29 5d 20 69 73 20 63 61 6c 6c 65 64 20  ee()] is called 
167f0 6f 6e 20 74 68 65 20 69 6e 70 75 74 20 73 74 72  on the input str
16800 69 6e 67 2e 29 5e 0a 2a 2f 0a 63 68 61 72 20 2a  ing.)^.*/.char *
16810 73 71 6c 69 74 65 33 5f 6d 70 72 69 6e 74 66 28  sqlite3_mprintf(
16820 63 6f 6e 73 74 20 63 68 61 72 2a 2c 2e 2e 2e 29  const char*,...)
16830 3b 0a 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f  ;.char *sqlite3_
16840 76 6d 70 72 69 6e 74 66 28 63 6f 6e 73 74 20 63  vmprintf(const c
16850 68 61 72 2a 2c 20 76 61 5f 6c 69 73 74 29 3b 0a  har*, va_list);.
16860 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 73 6e  char *sqlite3_sn
16870 70 72 69 6e 74 66 28 69 6e 74 2c 63 68 61 72 2a  printf(int,char*
16880 2c 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20 2e 2e  ,const char*, ..
16890 2e 29 3b 0a 63 68 61 72 20 2a 73 71 6c 69 74 65  .);.char *sqlite
168a0 33 5f 76 73 6e 70 72 69 6e 74 66 28 69 6e 74 2c  3_vsnprintf(int,
168b0 63 68 61 72 2a 2c 63 6f 6e 73 74 20 63 68 61 72  char*,const char
168c0 2a 2c 20 76 61 5f 6c 69 73 74 29 3b 0a 0a 2f 2a  *, va_list);../*
168d0 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4d 65  .** CAPI3REF: Me
168e0 6d 6f 72 79 20 41 6c 6c 6f 63 61 74 69 6f 6e 20  mory Allocation 
168f0 53 75 62 73 79 73 74 65 6d 0a 2a 2a 0a 2a 2a 20  Subsystem.**.** 
16900 54 68 65 20 53 51 4c 69 74 65 20 63 6f 72 65 20  The SQLite core 
16910 75 73 65 73 20 74 68 65 73 65 20 74 68 72 65 65  uses these three
16920 20 72 6f 75 74 69 6e 65 73 20 66 6f 72 20 61 6c   routines for al
16930 6c 20 6f 66 20 69 74 73 20 6f 77 6e 0a 2a 2a 20  l of its own.** 
16940 69 6e 74 65 72 6e 61 6c 20 6d 65 6d 6f 72 79 20  internal memory 
16950 61 6c 6c 6f 63 61 74 69 6f 6e 20 6e 65 65 64 73  allocation needs
16960 2e 20 22 43 6f 72 65 22 20 69 6e 20 74 68 65 20  . "Core" in the 
16970 70 72 65 76 69 6f 75 73 20 73 65 6e 74 65 6e 63  previous sentenc
16980 65 0a 2a 2a 20 64 6f 65 73 20 6e 6f 74 20 69 6e  e.** does not in
16990 63 6c 75 64 65 20 6f 70 65 72 61 74 69 6e 67 2d  clude operating-
169a0 73 79 73 74 65 6d 20 73 70 65 63 69 66 69 63 20  system specific 
169b0 56 46 53 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  VFS implementati
169c0 6f 6e 2e 20 20 54 68 65 0a 2a 2a 20 57 69 6e 64  on.  The.** Wind
169d0 6f 77 73 20 56 46 53 20 75 73 65 73 20 6e 61 74  ows VFS uses nat
169e0 69 76 65 20 6d 61 6c 6c 6f 63 28 29 20 61 6e 64  ive malloc() and
169f0 20 66 72 65 65 28 29 20 66 6f 72 20 73 6f 6d 65   free() for some
16a00 20 6f 70 65 72 61 74 69 6f 6e 73 2e 0a 2a 2a 0a   operations..**.
16a10 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  ** ^The sqlite3_
16a20 6d 61 6c 6c 6f 63 28 29 20 72 6f 75 74 69 6e 65  malloc() routine
16a30 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69 6e 74   returns a point
16a40 65 72 20 74 6f 20 61 20 62 6c 6f 63 6b 0a 2a 2a  er to a block.**
16a50 20 6f 66 20 6d 65 6d 6f 72 79 20 61 74 20 6c 65   of memory at le
16a60 61 73 74 20 4e 20 62 79 74 65 73 20 69 6e 20 6c  ast N bytes in l
16a70 65 6e 67 74 68 2c 20 77 68 65 72 65 20 4e 20 69  ength, where N i
16a80 73 20 74 68 65 20 70 61 72 61 6d 65 74 65 72 2e  s the parameter.
16a90 0a 2a 2a 20 5e 49 66 20 73 71 6c 69 74 65 33 5f  .** ^If sqlite3_
16aa0 6d 61 6c 6c 6f 63 28 29 20 69 73 20 75 6e 61 62  malloc() is unab
16ab0 6c 65 20 74 6f 20 6f 62 74 61 69 6e 20 73 75 66  le to obtain suf
16ac0 66 69 63 69 65 6e 74 20 66 72 65 65 0a 2a 2a 20  ficient free.** 
16ad0 6d 65 6d 6f 72 79 2c 20 69 74 20 72 65 74 75 72  memory, it retur
16ae0 6e 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65  ns a NULL pointe
16af0 72 2e 20 20 5e 49 66 20 74 68 65 20 70 61 72 61  r.  ^If the para
16b00 6d 65 74 65 72 20 4e 20 74 6f 0a 2a 2a 20 73 71  meter N to.** sq
16b10 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29 20 69  lite3_malloc() i
16b20 73 20 7a 65 72 6f 20 6f 72 20 6e 65 67 61 74 69  s zero or negati
16b30 76 65 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f  ve then sqlite3_
16b40 6d 61 6c 6c 6f 63 28 29 20 72 65 74 75 72 6e 73  malloc() returns
16b50 0a 2a 2a 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74  .** a NULL point
16b60 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 43 61 6c 6c 69  er..**.** ^Calli
16b70 6e 67 20 73 71 6c 69 74 65 33 5f 66 72 65 65 28  ng sqlite3_free(
16b80 29 20 77 69 74 68 20 61 20 70 6f 69 6e 74 65 72  ) with a pointer
16b90 20 70 72 65 76 69 6f 75 73 6c 79 20 72 65 74 75   previously retu
16ba0 72 6e 65 64 0a 2a 2a 20 62 79 20 73 71 6c 69 74  rned.** by sqlit
16bb0 65 33 5f 6d 61 6c 6c 6f 63 28 29 20 6f 72 20 73  e3_malloc() or s
16bc0 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63 28 29  qlite3_realloc()
16bd0 20 72 65 6c 65 61 73 65 73 20 74 68 61 74 20 6d   releases that m
16be0 65 6d 6f 72 79 20 73 6f 0a 2a 2a 20 74 68 61 74  emory so.** that
16bf0 20 69 74 20 6d 69 67 68 74 20 62 65 20 72 65 75   it might be reu
16c00 73 65 64 2e 20 20 5e 54 68 65 20 73 71 6c 69 74  sed.  ^The sqlit
16c10 65 33 5f 66 72 65 65 28 29 20 72 6f 75 74 69 6e  e3_free() routin
16c20 65 20 69 73 0a 2a 2a 20 61 20 6e 6f 2d 6f 70 20  e is.** a no-op 
16c30 69 66 20 69 73 20 63 61 6c 6c 65 64 20 77 69 74  if is called wit
16c40 68 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72  h a NULL pointer
16c50 2e 20 20 50 61 73 73 69 6e 67 20 61 20 4e 55 4c  .  Passing a NUL
16c60 4c 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 74 6f 20  L pointer.** to 
16c70 73 71 6c 69 74 65 33 5f 66 72 65 65 28 29 20 69  sqlite3_free() i
16c80 73 20 68 61 72 6d 6c 65 73 73 2e 20 20 41 66 74  s harmless.  Aft
16c90 65 72 20 62 65 69 6e 67 20 66 72 65 65 64 2c 20  er being freed, 
16ca0 6d 65 6d 6f 72 79 0a 2a 2a 20 73 68 6f 75 6c 64  memory.** should
16cb0 20 6e 65 69 74 68 65 72 20 62 65 20 72 65 61 64   neither be read
16cc0 20 6e 6f 72 20 77 72 69 74 74 65 6e 2e 20 20 45   nor written.  E
16cd0 76 65 6e 20 72 65 61 64 69 6e 67 20 70 72 65 76  ven reading prev
16ce0 69 6f 75 73 6c 79 20 66 72 65 65 64 0a 2a 2a 20  iously freed.** 
16cf0 6d 65 6d 6f 72 79 20 6d 69 67 68 74 20 72 65 73  memory might res
16d00 75 6c 74 20 69 6e 20 61 20 73 65 67 6d 65 6e 74  ult in a segment
16d10 61 74 69 6f 6e 20 66 61 75 6c 74 20 6f 72 20 6f  ation fault or o
16d20 74 68 65 72 20 73 65 76 65 72 65 20 65 72 72 6f  ther severe erro
16d30 72 2e 0a 2a 2a 20 4d 65 6d 6f 72 79 20 63 6f 72  r..** Memory cor
16d40 72 75 70 74 69 6f 6e 2c 20 61 20 73 65 67 6d 65  ruption, a segme
16d50 6e 74 61 74 69 6f 6e 20 66 61 75 6c 74 2c 20 6f  ntation fault, o
16d60 72 20 6f 74 68 65 72 20 73 65 76 65 72 65 20 65  r other severe e
16d70 72 72 6f 72 0a 2a 2a 20 6d 69 67 68 74 20 72 65  rror.** might re
16d80 73 75 6c 74 20 69 66 20 73 71 6c 69 74 65 33 5f  sult if sqlite3_
16d90 66 72 65 65 28 29 20 69 73 20 63 61 6c 6c 65 64  free() is called
16da0 20 77 69 74 68 20 61 20 6e 6f 6e 2d 4e 55 4c 4c   with a non-NULL
16db0 20 70 6f 69 6e 74 65 72 20 74 68 61 74 0a 2a 2a   pointer that.**
16dc0 20 77 61 73 20 6e 6f 74 20 6f 62 74 61 69 6e 65   was not obtaine
16dd0 64 20 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f 6d  d from sqlite3_m
16de0 61 6c 6c 6f 63 28 29 20 6f 72 20 73 71 6c 69 74  alloc() or sqlit
16df0 65 33 5f 72 65 61 6c 6c 6f 63 28 29 2e 0a 2a 2a  e3_realloc()..**
16e00 0a 2a 2a 20 5e 28 54 68 65 20 73 71 6c 69 74 65  .** ^(The sqlite
16e10 33 5f 72 65 61 6c 6c 6f 63 28 29 20 69 6e 74 65  3_realloc() inte
16e20 72 66 61 63 65 20 61 74 74 65 6d 70 74 73 20 74  rface attempts t
16e30 6f 20 72 65 73 69 7a 65 20 61 0a 2a 2a 20 70 72  o resize a.** pr
16e40 69 6f 72 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63  ior memory alloc
16e50 61 74 69 6f 6e 20 74 6f 20 62 65 20 61 74 20 6c  ation to be at l
16e60 65 61 73 74 20 4e 20 62 79 74 65 73 2c 20 77 68  east N bytes, wh
16e70 65 72 65 20 4e 20 69 73 20 74 68 65 0a 2a 2a 20  ere N is the.** 
16e80 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72  second parameter
16e90 2e 20 20 54 68 65 20 6d 65 6d 6f 72 79 20 61 6c  .  The memory al
16ea0 6c 6f 63 61 74 69 6f 6e 20 74 6f 20 62 65 20 72  location to be r
16eb0 65 73 69 7a 65 64 20 69 73 20 74 68 65 20 66 69  esized is the fi
16ec0 72 73 74 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72  rst.** parameter
16ed0 2e 29 5e 20 5e 20 49 66 20 74 68 65 20 66 69 72  .)^ ^ If the fir
16ee0 73 74 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20  st parameter to 
16ef0 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63 28  sqlite3_realloc(
16f00 29 0a 2a 2a 20 69 73 20 61 20 4e 55 4c 4c 20 70  ).** is a NULL p
16f10 6f 69 6e 74 65 72 20 74 68 65 6e 20 69 74 73 20  ointer then its 
16f20 62 65 68 61 76 69 6f 72 20 69 73 20 69 64 65 6e  behavior is iden
16f30 74 69 63 61 6c 20 74 6f 20 63 61 6c 6c 69 6e 67  tical to calling
16f40 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c  .** sqlite3_mall
16f50 6f 63 28 4e 29 20 77 68 65 72 65 20 4e 20 69 73  oc(N) where N is
16f60 20 74 68 65 20 73 65 63 6f 6e 64 20 70 61 72 61   the second para
16f70 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33  meter to sqlite3
16f80 5f 72 65 61 6c 6c 6f 63 28 29 2e 0a 2a 2a 20 5e  _realloc()..** ^
16f90 49 66 20 74 68 65 20 73 65 63 6f 6e 64 20 70 61  If the second pa
16fa0 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74  rameter to sqlit
16fb0 65 33 5f 72 65 61 6c 6c 6f 63 28 29 20 69 73 20  e3_realloc() is 
16fc0 7a 65 72 6f 20 6f 72 0a 2a 2a 20 6e 65 67 61 74  zero or.** negat
16fd0 69 76 65 20 74 68 65 6e 20 74 68 65 20 62 65 68  ive then the beh
16fe0 61 76 69 6f 72 20 69 73 20 65 78 61 63 74 6c 79  avior is exactly
16ff0 20 74 68 65 20 73 61 6d 65 20 61 73 20 63 61 6c   the same as cal
17000 6c 69 6e 67 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  ling.** sqlite3_
17010 66 72 65 65 28 50 29 20 77 68 65 72 65 20 50 20  free(P) where P 
17020 69 73 20 74 68 65 20 66 69 72 73 74 20 70 61 72  is the first par
17030 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65  ameter to sqlite
17040 33 5f 72 65 61 6c 6c 6f 63 28 29 2e 0a 2a 2a 20  3_realloc()..** 
17050 5e 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c 6f 63  ^sqlite3_realloc
17060 28 29 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69  () returns a poi
17070 6e 74 65 72 20 74 6f 20 61 20 6d 65 6d 6f 72 79  nter to a memory
17080 20 61 6c 6c 6f 63 61 74 69 6f 6e 0a 2a 2a 20 6f   allocation.** o
17090 66 20 61 74 20 6c 65 61 73 74 20 4e 20 62 79 74  f at least N byt
170a0 65 73 20 69 6e 20 73 69 7a 65 20 6f 72 20 4e 55  es in size or NU
170b0 4c 4c 20 69 66 20 73 75 66 66 69 63 69 65 6e 74  LL if sufficient
170c0 20 6d 65 6d 6f 72 79 20 69 73 20 75 6e 61 76 61   memory is unava
170d0 69 6c 61 62 6c 65 2e 0a 2a 2a 20 5e 49 66 20 4d  ilable..** ^If M
170e0 20 69 73 20 74 68 65 20 73 69 7a 65 20 6f 66 20   is the size of 
170f0 74 68 65 20 70 72 69 6f 72 20 61 6c 6c 6f 63 61  the prior alloca
17100 74 69 6f 6e 2c 20 74 68 65 6e 20 6d 69 6e 28 4e  tion, then min(N
17110 2c 4d 29 20 62 79 74 65 73 0a 2a 2a 20 6f 66 20  ,M) bytes.** of 
17120 74 68 65 20 70 72 69 6f 72 20 61 6c 6c 6f 63 61  the prior alloca
17130 74 69 6f 6e 20 61 72 65 20 63 6f 70 69 65 64 20  tion are copied 
17140 69 6e 74 6f 20 74 68 65 20 62 65 67 69 6e 6e 69  into the beginni
17150 6e 67 20 6f 66 20 62 75 66 66 65 72 20 72 65 74  ng of buffer ret
17160 75 72 6e 65 64 0a 2a 2a 20 62 79 20 73 71 6c 69  urned.** by sqli
17170 74 65 33 5f 72 65 61 6c 6c 6f 63 28 29 20 61 6e  te3_realloc() an
17180 64 20 74 68 65 20 70 72 69 6f 72 20 61 6c 6c 6f  d the prior allo
17190 63 61 74 69 6f 6e 20 69 73 20 66 72 65 65 64 2e  cation is freed.
171a0 0a 2a 2a 20 5e 49 66 20 73 71 6c 69 74 65 33 5f  .** ^If sqlite3_
171b0 72 65 61 6c 6c 6f 63 28 29 20 72 65 74 75 72 6e  realloc() return
171c0 73 20 4e 55 4c 4c 2c 20 74 68 65 6e 20 74 68 65  s NULL, then the
171d0 20 70 72 69 6f 72 20 61 6c 6c 6f 63 61 74 69 6f   prior allocatio
171e0 6e 0a 2a 2a 20 69 73 20 6e 6f 74 20 66 72 65 65  n.** is not free
171f0 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 6d 65  d..**.** ^The me
17200 6d 6f 72 79 20 72 65 74 75 72 6e 65 64 20 62 79  mory returned by
17210 20 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28   sqlite3_malloc(
17220 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 72 65  ) and sqlite3_re
17230 61 6c 6c 6f 63 28 29 0a 2a 2a 20 69 73 20 61 6c  alloc().** is al
17240 77 61 79 73 20 61 6c 69 67 6e 65 64 20 74 6f 20  ways aligned to 
17250 61 74 20 6c 65 61 73 74 20 61 6e 20 38 20 62 79  at least an 8 by
17260 74 65 20 62 6f 75 6e 64 61 72 79 2c 20 6f 72 20  te boundary, or 
17270 74 6f 20 61 0a 2a 2a 20 34 20 62 79 74 65 20 62  to a.** 4 byte b
17280 6f 75 6e 64 61 72 79 20 69 66 20 74 68 65 20 5b  oundary if the [
17290 53 51 4c 49 54 45 5f 34 5f 42 59 54 45 5f 41 4c  SQLITE_4_BYTE_AL
172a0 49 47 4e 45 44 5f 4d 41 4c 4c 4f 43 5d 20 63 6f  IGNED_MALLOC] co
172b0 6d 70 69 6c 65 2d 74 69 6d 65 0a 2a 2a 20 6f 70  mpile-time.** op
172c0 74 69 6f 6e 20 69 73 20 75 73 65 64 2e 0a 2a 2a  tion is used..**
172d0 0a 2a 2a 20 49 6e 20 53 51 4c 69 74 65 20 76 65  .** In SQLite ve
172e0 72 73 69 6f 6e 20 33 2e 35 2e 30 20 61 6e 64 20  rsion 3.5.0 and 
172f0 33 2e 35 2e 31 2c 20 69 74 20 77 61 73 20 70 6f  3.5.1, it was po
17300 73 73 69 62 6c 65 20 74 6f 20 64 65 66 69 6e 65  ssible to define
17310 0a 2a 2a 20 74 68 65 20 53 51 4c 49 54 45 5f 4f  .** the SQLITE_O
17320 4d 49 54 5f 4d 45 4d 4f 52 59 5f 41 4c 4c 4f 43  MIT_MEMORY_ALLOC
17330 41 54 49 4f 4e 20 77 68 69 63 68 20 77 6f 75 6c  ATION which woul
17340 64 20 63 61 75 73 65 20 74 68 65 20 62 75 69 6c  d cause the buil
17350 74 2d 69 6e 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e  t-in.** implemen
17360 74 61 74 69 6f 6e 20 6f 66 20 74 68 65 73 65 20  tation of these 
17370 72 6f 75 74 69 6e 65 73 20 74 6f 20 62 65 20 6f  routines to be o
17380 6d 69 74 74 65 64 2e 20 20 54 68 61 74 20 63 61  mitted.  That ca
17390 70 61 62 69 6c 69 74 79 0a 2a 2a 20 69 73 20 6e  pability.** is n
173a0 6f 20 6c 6f 6e 67 65 72 20 70 72 6f 76 69 64 65  o longer provide
173b0 64 2e 20 20 4f 6e 6c 79 20 62 75 69 6c 74 2d 69  d.  Only built-i
173c0 6e 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  n memory allocat
173d0 6f 72 73 20 63 61 6e 20 62 65 20 75 73 65 64 2e  ors can be used.
173e0 0a 2a 2a 0a 2a 2a 20 54 68 65 20 57 69 6e 64 6f  .**.** The Windo
173f0 77 73 20 4f 53 20 69 6e 74 65 72 66 61 63 65 20  ws OS interface 
17400 6c 61 79 65 72 20 63 61 6c 6c 73 0a 2a 2a 20 74  layer calls.** t
17410 68 65 20 73 79 73 74 65 6d 20 6d 61 6c 6c 6f 63  he system malloc
17420 28 29 20 61 6e 64 20 66 72 65 65 28 29 20 64 69  () and free() di
17430 72 65 63 74 6c 79 20 77 68 65 6e 20 63 6f 6e 76  rectly when conv
17440 65 72 74 69 6e 67 0a 2a 2a 20 66 69 6c 65 6e 61  erting.** filena
17450 6d 65 73 20 62 65 74 77 65 65 6e 20 74 68 65 20  mes between the 
17460 55 54 46 2d 38 20 65 6e 63 6f 64 69 6e 67 20 75  UTF-8 encoding u
17470 73 65 64 20 62 79 20 53 51 4c 69 74 65 0a 2a 2a  sed by SQLite.**
17480 20 61 6e 64 20 77 68 61 74 65 76 65 72 20 66 69   and whatever fi
17490 6c 65 6e 61 6d 65 20 65 6e 63 6f 64 69 6e 67 20  lename encoding 
174a0 69 73 20 75 73 65 64 20 62 79 20 74 68 65 20 70  is used by the p
174b0 61 72 74 69 63 75 6c 61 72 20 57 69 6e 64 6f 77  articular Window
174c0 73 0a 2a 2a 20 69 6e 73 74 61 6c 6c 61 74 69 6f  s.** installatio
174d0 6e 2e 20 20 4d 65 6d 6f 72 79 20 61 6c 6c 6f 63  n.  Memory alloc
174e0 61 74 69 6f 6e 20 65 72 72 6f 72 73 20 61 72 65  ation errors are
174f0 20 64 65 74 65 63 74 65 64 2c 20 62 75 74 0a 2a   detected, but.*
17500 2a 20 74 68 65 79 20 61 72 65 20 72 65 70 6f 72  * they are repor
17510 74 65 64 20 62 61 63 6b 20 61 73 20 5b 53 51 4c  ted back as [SQL
17520 49 54 45 5f 43 41 4e 54 4f 50 45 4e 5d 20 6f 72  ITE_CANTOPEN] or
17530 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 49 4f 45 52  .** [SQLITE_IOER
17540 52 5d 20 72 61 74 68 65 72 20 74 68 61 6e 20 5b  R] rather than [
17550 53 51 4c 49 54 45 5f 4e 4f 4d 45 4d 5d 2e 0a 2a  SQLITE_NOMEM]..*
17560 2a 0a 2a 2a 20 54 68 65 20 70 6f 69 6e 74 65 72  *.** The pointer
17570 20 61 72 67 75 6d 65 6e 74 73 20 74 6f 20 5b 73   arguments to [s
17580 71 6c 69 74 65 33 5f 66 72 65 65 28 29 5d 20 61  qlite3_free()] a
17590 6e 64 20 5b 73 71 6c 69 74 65 33 5f 72 65 61 6c  nd [sqlite3_real
175a0 6c 6f 63 28 29 5d 0a 2a 2a 20 6d 75 73 74 20 62  loc()].** must b
175b0 65 20 65 69 74 68 65 72 20 4e 55 4c 4c 20 6f 72  e either NULL or
175c0 20 65 6c 73 65 20 70 6f 69 6e 74 65 72 73 20 6f   else pointers o
175d0 62 74 61 69 6e 65 64 20 66 72 6f 6d 20 61 20 70  btained from a p
175e0 72 69 6f 72 0a 2a 2a 20 69 6e 76 6f 63 61 74 69  rior.** invocati
175f0 6f 6e 20 6f 66 20 5b 73 71 6c 69 74 65 33 5f 6d  on of [sqlite3_m
17600 61 6c 6c 6f 63 28 29 5d 20 6f 72 20 5b 73 71 6c  alloc()] or [sql
17610 69 74 65 33 5f 72 65 61 6c 6c 6f 63 28 29 5d 20  ite3_realloc()] 
17620 74 68 61 74 20 68 61 76 65 0a 2a 2a 20 6e 6f 74  that have.** not
17630 20 79 65 74 20 62 65 65 6e 20 72 65 6c 65 61 73   yet been releas
17640 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 61 70  ed..**.** The ap
17650 70 6c 69 63 61 74 69 6f 6e 20 6d 75 73 74 20 6e  plication must n
17660 6f 74 20 72 65 61 64 20 6f 72 20 77 72 69 74 65  ot read or write
17670 20 61 6e 79 20 70 61 72 74 20 6f 66 0a 2a 2a 20   any part of.** 
17680 61 20 62 6c 6f 63 6b 20 6f 66 20 6d 65 6d 6f 72  a block of memor
17690 79 20 61 66 74 65 72 20 69 74 20 68 61 73 20 62  y after it has b
176a0 65 65 6e 20 72 65 6c 65 61 73 65 64 20 75 73 69  een released usi
176b0 6e 67 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 66  ng.** [sqlite3_f
176c0 72 65 65 28 29 5d 20 6f 72 20 5b 73 71 6c 69 74  ree()] or [sqlit
176d0 65 33 5f 72 65 61 6c 6c 6f 63 28 29 5d 2e 0a 2a  e3_realloc()]..*
176e0 2f 0a 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f  /.void *sqlite3_
176f0 6d 61 6c 6c 6f 63 28 69 6e 74 29 3b 0a 76 6f 69  malloc(int);.voi
17700 64 20 2a 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c  d *sqlite3_reall
17710 6f 63 28 76 6f 69 64 2a 2c 20 69 6e 74 29 3b 0a  oc(void*, int);.
17720 76 6f 69 64 20 73 71 6c 69 74 65 33 5f 66 72 65  void sqlite3_fre
17730 65 28 76 6f 69 64 2a 29 3b 0a 0a 2f 2a 0a 2a 2a  e(void*);../*.**
17740 20 43 41 50 49 33 52 45 46 3a 20 4d 65 6d 6f 72   CAPI3REF: Memor
17750 79 20 41 6c 6c 6f 63 61 74 6f 72 20 53 74 61 74  y Allocator Stat
17760 69 73 74 69 63 73 0a 2a 2a 0a 2a 2a 20 53 51 4c  istics.**.** SQL
17770 69 74 65 20 70 72 6f 76 69 64 65 73 20 74 68 65  ite provides the
17780 73 65 20 74 77 6f 20 69 6e 74 65 72 66 61 63 65  se two interface
17790 73 20 66 6f 72 20 72 65 70 6f 72 74 69 6e 67 20  s for reporting 
177a0 6f 6e 20 74 68 65 20 73 74 61 74 75 73 0a 2a 2a  on the status.**
177b0 20 6f 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33   of the [sqlite3
177c0 5f 6d 61 6c 6c 6f 63 28 29 5d 2c 20 5b 73 71 6c  _malloc()], [sql
177d0 69 74 65 33 5f 66 72 65 65 28 29 5d 2c 20 61 6e  ite3_free()], an
177e0 64 20 5b 73 71 6c 69 74 65 33 5f 72 65 61 6c 6c  d [sqlite3_reall
177f0 6f 63 28 29 5d 0a 2a 2a 20 72 6f 75 74 69 6e 65  oc()].** routine
17800 73 2c 20 77 68 69 63 68 20 66 6f 72 6d 20 74 68  s, which form th
17810 65 20 62 75 69 6c 74 2d 69 6e 20 6d 65 6d 6f 72  e built-in memor
17820 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 73 75 62  y allocation sub
17830 73 79 73 74 65 6d 2e 0a 2a 2a 0a 2a 2a 20 5e 54  system..**.** ^T
17840 68 65 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d 6f  he [sqlite3_memo
17850 72 79 5f 75 73 65 64 28 29 5d 20 72 6f 75 74 69  ry_used()] routi
17860 6e 65 20 72 65 74 75 72 6e 73 20 74 68 65 20 6e  ne returns the n
17870 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73 0a 2a  umber of bytes.*
17880 2a 20 6f 66 20 6d 65 6d 6f 72 79 20 63 75 72 72  * of memory curr
17890 65 6e 74 6c 79 20 6f 75 74 73 74 61 6e 64 69 6e  ently outstandin
178a0 67 20 28 6d 61 6c 6c 6f 63 65 64 20 62 75 74 20  g (malloced but 
178b0 6e 6f 74 20 66 72 65 65 64 29 2e 0a 2a 2a 20 5e  not freed)..** ^
178c0 54 68 65 20 5b 73 71 6c 69 74 65 33 5f 6d 65 6d  The [sqlite3_mem
178d0 6f 72 79 5f 68 69 67 68 77 61 74 65 72 28 29 5d  ory_highwater()]
178e0 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73   routine returns
178f0 20 74 68 65 20 6d 61 78 69 6d 75 6d 0a 2a 2a 20   the maximum.** 
17900 76 61 6c 75 65 20 6f 66 20 5b 73 71 6c 69 74 65  value of [sqlite
17910 33 5f 6d 65 6d 6f 72 79 5f 75 73 65 64 28 29 5d  3_memory_used()]
17920 20 73 69 6e 63 65 20 74 68 65 20 68 69 67 68 2d   since the high-
17930 77 61 74 65 72 20 6d 61 72 6b 0a 2a 2a 20 77 61  water mark.** wa
17940 73 20 6c 61 73 74 20 72 65 73 65 74 2e 20 20 5e  s last reset.  ^
17950 54 68 65 20 76 61 6c 75 65 73 20 72 65 74 75 72  The values retur
17960 6e 65 64 20 62 79 20 5b 73 71 6c 69 74 65 33 5f  ned by [sqlite3_
17970 6d 65 6d 6f 72 79 5f 75 73 65 64 28 29 5d 20 61  memory_used()] a
17980 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6d  nd.** [sqlite3_m
17990 65 6d 6f 72 79 5f 68 69 67 68 77 61 74 65 72 28  emory_highwater(
179a0 29 5d 20 69 6e 63 6c 75 64 65 20 61 6e 79 20 6f  )] include any o
179b0 76 65 72 68 65 61 64 0a 2a 2a 20 61 64 64 65 64  verhead.** added
179c0 20 62 79 20 53 51 4c 69 74 65 20 69 6e 20 69 74   by SQLite in it
179d0 73 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e  s implementation
179e0 20 6f 66 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c   of [sqlite3_mal
179f0 6c 6f 63 28 29 5d 2c 0a 2a 2a 20 62 75 74 20 6e  loc()],.** but n
17a00 6f 74 20 6f 76 65 72 68 65 61 64 20 61 64 64 65  ot overhead adde
17a10 64 20 62 79 20 74 68 65 20 61 6e 79 20 75 6e 64  d by the any und
17a20 65 72 6c 79 69 6e 67 20 73 79 73 74 65 6d 20 6c  erlying system l
17a30 69 62 72 61 72 79 0a 2a 2a 20 72 6f 75 74 69 6e  ibrary.** routin
17a40 65 73 20 74 68 61 74 20 5b 73 71 6c 69 74 65 33  es that [sqlite3
17a50 5f 6d 61 6c 6c 6f 63 28 29 5d 20 6d 61 79 20 63  _malloc()] may c
17a60 61 6c 6c 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  all..**.** ^The 
17a70 6d 65 6d 6f 72 79 20 68 69 67 68 2d 77 61 74 65  memory high-wate
17a80 72 20 6d 61 72 6b 20 69 73 20 72 65 73 65 74 20  r mark is reset 
17a90 74 6f 20 74 68 65 20 63 75 72 72 65 6e 74 20 76  to the current v
17aa0 61 6c 75 65 20 6f 66 0a 2a 2a 20 5b 73 71 6c 69  alue of.** [sqli
17ab0 74 65 33 5f 6d 65 6d 6f 72 79 5f 75 73 65 64 28  te3_memory_used(
17ac0 29 5d 20 69 66 20 61 6e 64 20 6f 6e 6c 79 20 69  )] if and only i
17ad0 66 20 74 68 65 20 70 61 72 61 6d 65 74 65 72 20  f the parameter 
17ae0 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6d  to.** [sqlite3_m
17af0 65 6d 6f 72 79 5f 68 69 67 68 77 61 74 65 72 28  emory_highwater(
17b00 29 5d 20 69 73 20 74 72 75 65 2e 20 20 5e 54 68  )] is true.  ^Th
17b10 65 20 76 61 6c 75 65 20 72 65 74 75 72 6e 65 64  e value returned
17b20 0a 2a 2a 20 62 79 20 5b 73 71 6c 69 74 65 33 5f  .** by [sqlite3_
17b30 6d 65 6d 6f 72 79 5f 68 69 67 68 77 61 74 65 72  memory_highwater
17b40 28 31 29 5d 20 69 73 20 74 68 65 20 68 69 67 68  (1)] is the high
17b50 2d 77 61 74 65 72 20 6d 61 72 6b 0a 2a 2a 20 70  -water mark.** p
17b60 72 69 6f 72 20 74 6f 20 74 68 65 20 72 65 73 65  rior to the rese
17b70 74 2e 0a 2a 2f 0a 73 71 6c 69 74 65 33 5f 69 6e  t..*/.sqlite3_in
17b80 74 36 34 20 73 71 6c 69 74 65 33 5f 6d 65 6d 6f  t64 sqlite3_memo
17b90 72 79 5f 75 73 65 64 28 76 6f 69 64 29 3b 0a 73  ry_used(void);.s
17ba0 71 6c 69 74 65 33 5f 69 6e 74 36 34 20 73 71 6c  qlite3_int64 sql
17bb0 69 74 65 33 5f 6d 65 6d 6f 72 79 5f 68 69 67 68  ite3_memory_high
17bc0 77 61 74 65 72 28 69 6e 74 20 72 65 73 65 74 46  water(int resetF
17bd0 6c 61 67 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  lag);../*.** CAP
17be0 49 33 52 45 46 3a 20 50 73 65 75 64 6f 2d 52 61  I3REF: Pseudo-Ra
17bf0 6e 64 6f 6d 20 4e 75 6d 62 65 72 20 47 65 6e 65  ndom Number Gene
17c00 72 61 74 6f 72 0a 2a 2a 0a 2a 2a 20 53 51 4c 69  rator.**.** SQLi
17c10 74 65 20 63 6f 6e 74 61 69 6e 73 20 61 20 68 69  te contains a hi
17c20 67 68 2d 71 75 61 6c 69 74 79 20 70 73 65 75 64  gh-quality pseud
17c30 6f 2d 72 61 6e 64 6f 6d 20 6e 75 6d 62 65 72 20  o-random number 
17c40 67 65 6e 65 72 61 74 6f 72 20 28 50 52 4e 47 29  generator (PRNG)
17c50 20 75 73 65 64 20 74 6f 0a 2a 2a 20 73 65 6c 65   used to.** sele
17c60 63 74 20 72 61 6e 64 6f 6d 20 5b 52 4f 57 49 44  ct random [ROWID
17c70 20 7c 20 52 4f 57 49 44 73 5d 20 77 68 65 6e 20   | ROWIDs] when 
17c80 69 6e 73 65 72 74 69 6e 67 20 6e 65 77 20 72 65  inserting new re
17c90 63 6f 72 64 73 20 69 6e 74 6f 20 61 20 74 61 62  cords into a tab
17ca0 6c 65 20 74 68 61 74 0a 2a 2a 20 61 6c 72 65 61  le that.** alrea
17cb0 64 79 20 75 73 65 73 20 74 68 65 20 6c 61 72 67  dy uses the larg
17cc0 65 73 74 20 70 6f 73 73 69 62 6c 65 20 5b 52 4f  est possible [RO
17cd0 57 49 44 5d 2e 20 20 54 68 65 20 50 52 4e 47 20  WID].  The PRNG 
17ce0 69 73 20 61 6c 73 6f 20 75 73 65 64 20 66 6f 72  is also used for
17cf0 0a 2a 2a 20 74 68 65 20 62 75 69 6c 64 2d 69 6e  .** the build-in
17d00 20 72 61 6e 64 6f 6d 28 29 20 61 6e 64 20 72 61   random() and ra
17d10 6e 64 6f 6d 62 6c 6f 62 28 29 20 53 51 4c 20 66  ndomblob() SQL f
17d20 75 6e 63 74 69 6f 6e 73 2e 20 20 54 68 69 73 20  unctions.  This 
17d30 69 6e 74 65 72 66 61 63 65 20 61 6c 6c 6f 77 73  interface allows
17d40 0a 2a 2a 20 61 70 70 6c 69 63 61 74 69 6f 6e 73  .** applications
17d50 20 74 6f 20 61 63 63 65 73 73 20 74 68 65 20 73   to access the s
17d60 61 6d 65 20 50 52 4e 47 20 66 6f 72 20 6f 74 68  ame PRNG for oth
17d70 65 72 20 70 75 72 70 6f 73 65 73 2e 0a 2a 2a 0a  er purposes..**.
17d80 2a 2a 20 5e 41 20 63 61 6c 6c 20 74 6f 20 74 68  ** ^A call to th
17d90 69 73 20 72 6f 75 74 69 6e 65 20 73 74 6f 72 65  is routine store
17da0 73 20 4e 20 62 79 74 65 73 20 6f 66 20 72 61 6e  s N bytes of ran
17db0 64 6f 6d 6e 65 73 73 20 69 6e 74 6f 20 62 75 66  domness into buf
17dc0 66 65 72 20 50 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  fer P..**.** ^Th
17dd0 65 20 66 69 72 73 74 20 74 69 6d 65 20 74 68 69  e first time thi
17de0 73 20 72 6f 75 74 69 6e 65 20 69 73 20 69 6e 76  s routine is inv
17df0 6f 6b 65 64 20 28 65 69 74 68 65 72 20 69 6e 74  oked (either int
17e00 65 72 6e 61 6c 6c 79 20 6f 72 20 62 79 0a 2a 2a  ernally or by.**
17e10 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e   the application
17e20 29 20 74 68 65 20 50 52 4e 47 20 69 73 20 73 65  ) the PRNG is se
17e30 65 64 65 64 20 75 73 69 6e 67 20 72 61 6e 64 6f  eded using rando
17e40 6d 6e 65 73 73 20 6f 62 74 61 69 6e 65 64 0a 2a  mness obtained.*
17e50 2a 20 66 72 6f 6d 20 74 68 65 20 78 52 61 6e 64  * from the xRand
17e60 6f 6d 6e 65 73 73 20 6d 65 74 68 6f 64 20 6f 66  omness method of
17e70 20 74 68 65 20 64 65 66 61 75 6c 74 20 5b 73 71   the default [sq
17e80 6c 69 74 65 33 5f 76 66 73 5d 20 6f 62 6a 65 63  lite3_vfs] objec
17e90 74 2e 0a 2a 2a 20 5e 4f 6e 20 61 6c 6c 20 73 75  t..** ^On all su
17ea0 62 73 65 71 75 65 6e 74 20 69 6e 76 6f 63 61 74  bsequent invocat
17eb0 69 6f 6e 73 2c 20 74 68 65 20 70 73 65 75 64 6f  ions, the pseudo
17ec0 2d 72 61 6e 64 6f 6d 6e 65 73 73 20 69 73 20 67  -randomness is g
17ed0 65 6e 65 72 61 74 65 64 0a 2a 2a 20 69 6e 74 65  enerated.** inte
17ee0 72 6e 61 6c 6c 79 20 61 6e 64 20 77 69 74 68 6f  rnally and witho
17ef0 75 74 20 72 65 63 6f 75 72 73 65 20 74 6f 20 74  ut recourse to t
17f00 68 65 20 5b 73 71 6c 69 74 65 33 5f 76 66 73 5d  he [sqlite3_vfs]
17f10 20 78 52 61 6e 64 6f 6d 6e 65 73 73 0a 2a 2a 20   xRandomness.** 
17f20 6d 65 74 68 6f 64 2e 0a 2a 2f 0a 76 6f 69 64 20  method..*/.void 
17f30 73 71 6c 69 74 65 33 5f 72 61 6e 64 6f 6d 6e 65  sqlite3_randomne
17f40 73 73 28 69 6e 74 20 4e 2c 20 76 6f 69 64 20 2a  ss(int N, void *
17f50 50 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  P);../*.** CAPI3
17f60 52 45 46 3a 20 43 6f 6d 70 69 6c 65 2d 54 69 6d  REF: Compile-Tim
17f70 65 20 41 75 74 68 6f 72 69 7a 61 74 69 6f 6e 20  e Authorization 
17f80 43 61 6c 6c 62 61 63 6b 73 0a 2a 2a 0a 2a 2a 20  Callbacks.**.** 
17f90 5e 54 68 69 73 20 72 6f 75 74 69 6e 65 20 72 65  ^This routine re
17fa0 67 69 73 74 65 72 73 20 61 20 61 75 74 68 6f 72  gisters a author
17fb0 69 7a 65 72 20 63 61 6c 6c 62 61 63 6b 20 77 69  izer callback wi
17fc0 74 68 20 61 20 70 61 72 74 69 63 75 6c 61 72 0a  th a particular.
17fd0 2a 2a 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e  ** [database con
17fe0 6e 65 63 74 69 6f 6e 5d 2c 20 73 75 70 70 6c 69  nection], suppli
17ff0 65 64 20 69 6e 20 74 68 65 20 66 69 72 73 74 20  ed in the first 
18000 61 72 67 75 6d 65 6e 74 2e 0a 2a 2a 20 5e 54 68  argument..** ^Th
18010 65 20 61 75 74 68 6f 72 69 7a 65 72 20 63 61 6c  e authorizer cal
18020 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64  lback is invoked
18030 20 61 73 20 53 51 4c 20 73 74 61 74 65 6d 65 6e   as SQL statemen
18040 74 73 20 61 72 65 20 62 65 69 6e 67 20 63 6f 6d  ts are being com
18050 70 69 6c 65 64 0a 2a 2a 20 62 79 20 5b 73 71 6c  piled.** by [sql
18060 69 74 65 33 5f 70 72 65 70 61 72 65 28 29 5d 20  ite3_prepare()] 
18070 6f 72 20 69 74 73 20 76 61 72 69 61 6e 74 73 20  or its variants 
18080 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65  [sqlite3_prepare
18090 5f 76 32 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69  _v2()],.** [sqli
180a0 74 65 33 5f 70 72 65 70 61 72 65 31 36 28 29 5d  te3_prepare16()]
180b0 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 70 72   and [sqlite3_pr
180c0 65 70 61 72 65 31 36 5f 76 32 28 29 5d 2e 20 20  epare16_v2()].  
180d0 5e 41 74 20 76 61 72 69 6f 75 73 0a 2a 2a 20 70  ^At various.** p
180e0 6f 69 6e 74 73 20 64 75 72 69 6e 67 20 74 68 65  oints during the
180f0 20 63 6f 6d 70 69 6c 61 74 69 6f 6e 20 70 72 6f   compilation pro
18100 63 65 73 73 2c 20 61 73 20 6c 6f 67 69 63 20 69  cess, as logic i
18110 73 20 62 65 69 6e 67 20 63 72 65 61 74 65 64 0a  s being created.
18120 2a 2a 20 74 6f 20 70 65 72 66 6f 72 6d 20 76 61  ** to perform va
18130 72 69 6f 75 73 20 61 63 74 69 6f 6e 73 2c 20 74  rious actions, t
18140 68 65 20 61 75 74 68 6f 72 69 7a 65 72 20 63 61  he authorizer ca
18150 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65  llback is invoke
18160 64 20 74 6f 0a 2a 2a 20 73 65 65 20 69 66 20 74  d to.** see if t
18170 68 6f 73 65 20 61 63 74 69 6f 6e 73 20 61 72 65  hose actions are
18180 20 61 6c 6c 6f 77 65 64 2e 20 20 5e 54 68 65 20   allowed.  ^The 
18190 61 75 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62  authorizer callb
181a0 61 63 6b 20 73 68 6f 75 6c 64 0a 2a 2a 20 72 65  ack should.** re
181b0 74 75 72 6e 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d  turn [SQLITE_OK]
181c0 20 74 6f 20 61 6c 6c 6f 77 20 74 68 65 20 61 63   to allow the ac
181d0 74 69 6f 6e 2c 20 5b 53 51 4c 49 54 45 5f 49 47  tion, [SQLITE_IG
181e0 4e 4f 52 45 5d 20 74 6f 20 64 69 73 61 6c 6c 6f  NORE] to disallo
181f0 77 20 74 68 65 0a 2a 2a 20 73 70 65 63 69 66 69  w the.** specifi
18200 63 20 61 63 74 69 6f 6e 20 62 75 74 20 61 6c 6c  c action but all
18210 6f 77 20 74 68 65 20 53 51 4c 20 73 74 61 74 65  ow the SQL state
18220 6d 65 6e 74 20 74 6f 20 63 6f 6e 74 69 6e 75 65  ment to continue
18230 20 74 6f 20 62 65 0a 2a 2a 20 63 6f 6d 70 69 6c   to be.** compil
18240 65 64 2c 20 6f 72 20 5b 53 51 4c 49 54 45 5f 44  ed, or [SQLITE_D
18250 45 4e 59 5d 20 74 6f 20 63 61 75 73 65 20 74 68  ENY] to cause th
18260 65 20 65 6e 74 69 72 65 20 53 51 4c 20 73 74 61  e entire SQL sta
18270 74 65 6d 65 6e 74 20 74 6f 20 62 65 0a 2a 2a 20  tement to be.** 
18280 72 65 6a 65 63 74 65 64 20 77 69 74 68 20 61 6e  rejected with an
18290 20 65 72 72 6f 72 2e 20 20 5e 49 66 20 74 68 65   error.  ^If the
182a0 20 61 75 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c   authorizer call
182b0 62 61 63 6b 20 72 65 74 75 72 6e 73 0a 2a 2a 20  back returns.** 
182c0 61 6e 79 20 76 61 6c 75 65 20 6f 74 68 65 72 20  any value other 
182d0 74 68 61 6e 20 5b 53 51 4c 49 54 45 5f 49 47 4e  than [SQLITE_IGN
182e0 4f 52 45 5d 2c 20 5b 53 51 4c 49 54 45 5f 4f 4b  ORE], [SQLITE_OK
182f0 5d 2c 20 6f 72 20 5b 53 51 4c 49 54 45 5f 44 45  ], or [SQLITE_DE
18300 4e 59 5d 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20  NY].** then the 
18310 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65  [sqlite3_prepare
18320 5f 76 32 28 29 5d 20 6f 72 20 65 71 75 69 76 61  _v2()] or equiva
18330 6c 65 6e 74 20 63 61 6c 6c 20 74 68 61 74 20 74  lent call that t
18340 72 69 67 67 65 72 65 64 0a 2a 2a 20 74 68 65 20  riggered.** the 
18350 61 75 74 68 6f 72 69 7a 65 72 20 77 69 6c 6c 20  authorizer will 
18360 66 61 69 6c 20 77 69 74 68 20 61 6e 20 65 72 72  fail with an err
18370 6f 72 20 6d 65 73 73 61 67 65 2e 0a 2a 2a 0a 2a  or message..**.*
18380 2a 20 57 68 65 6e 20 74 68 65 20 63 61 6c 6c 62  * When the callb
18390 61 63 6b 20 72 65 74 75 72 6e 73 20 5b 53 51 4c  ack returns [SQL
183a0 49 54 45 5f 4f 4b 5d 2c 20 74 68 61 74 20 6d 65  ITE_OK], that me
183b0 61 6e 73 20 74 68 65 20 6f 70 65 72 61 74 69 6f  ans the operatio
183c0 6e 0a 2a 2a 20 72 65 71 75 65 73 74 65 64 20 69  n.** requested i
183d0 73 20 6f 6b 2e 20 20 5e 57 68 65 6e 20 74 68 65  s ok.  ^When the
183e0 20 63 61 6c 6c 62 61 63 6b 20 72 65 74 75 72 6e   callback return
183f0 73 20 5b 53 51 4c 49 54 45 5f 44 45 4e 59 5d 2c  s [SQLITE_DENY],
18400 20 74 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33   the.** [sqlite3
18410 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d 20 6f  _prepare_v2()] o
18420 72 20 65 71 75 69 76 61 6c 65 6e 74 20 63 61 6c  r equivalent cal
18430 6c 20 74 68 61 74 20 74 72 69 67 67 65 72 65 64  l that triggered
18440 20 74 68 65 0a 2a 2a 20 61 75 74 68 6f 72 69 7a   the.** authoriz
18450 65 72 20 77 69 6c 6c 20 66 61 69 6c 20 77 69 74  er will fail wit
18460 68 20 61 6e 20 65 72 72 6f 72 20 6d 65 73 73 61  h an error messa
18470 67 65 20 65 78 70 6c 61 69 6e 69 6e 67 20 74 68  ge explaining th
18480 61 74 0a 2a 2a 20 61 63 63 65 73 73 20 69 73 20  at.** access is 
18490 64 65 6e 69 65 64 2e 20 0a 2a 2a 0a 2a 2a 20 5e  denied. .**.** ^
184a0 54 68 65 20 66 69 72 73 74 20 70 61 72 61 6d 65  The first parame
184b0 74 65 72 20 74 6f 20 74 68 65 20 61 75 74 68 6f  ter to the autho
184c0 72 69 7a 65 72 20 63 61 6c 6c 62 61 63 6b 20 69  rizer callback i
184d0 73 20 61 20 63 6f 70 79 20 6f 66 20 74 68 65 20  s a copy of the 
184e0 74 68 69 72 64 0a 2a 2a 20 70 61 72 61 6d 65 74  third.** paramet
184f0 65 72 20 74 6f 20 74 68 65 20 73 71 6c 69 74 65  er to the sqlite
18500 33 5f 73 65 74 5f 61 75 74 68 6f 72 69 7a 65 72  3_set_authorizer
18510 28 29 20 69 6e 74 65 72 66 61 63 65 2e 20 5e 54  () interface. ^T
18520 68 65 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65  he second parame
18530 74 65 72 0a 2a 2a 20 74 6f 20 74 68 65 20 63 61  ter.** to the ca
18540 6c 6c 62 61 63 6b 20 69 73 20 61 6e 20 69 6e 74  llback is an int
18550 65 67 65 72 20 5b 53 51 4c 49 54 45 5f 43 4f 50  eger [SQLITE_COP
18560 59 20 7c 20 61 63 74 69 6f 6e 20 63 6f 64 65 5d  Y | action code]
18570 20 74 68 61 74 20 73 70 65 63 69 66 69 65 73 0a   that specifies.
18580 2a 2a 20 74 68 65 20 70 61 72 74 69 63 75 6c 61  ** the particula
18590 72 20 61 63 74 69 6f 6e 20 74 6f 20 62 65 20 61  r action to be a
185a0 75 74 68 6f 72 69 7a 65 64 2e 20 5e 54 68 65 20  uthorized. ^The 
185b0 74 68 69 72 64 20 74 68 72 6f 75 67 68 20 73 69  third through si
185c0 78 74 68 20 70 61 72 61 6d 65 74 65 72 73 0a 2a  xth parameters.*
185d0 2a 20 74 6f 20 74 68 65 20 63 61 6c 6c 62 61 63  * to the callbac
185e0 6b 20 61 72 65 20 7a 65 72 6f 2d 74 65 72 6d 69  k are zero-termi
185f0 6e 61 74 65 64 20 73 74 72 69 6e 67 73 20 74 68  nated strings th
18600 61 74 20 63 6f 6e 74 61 69 6e 20 61 64 64 69 74  at contain addit
18610 69 6f 6e 61 6c 0a 2a 2a 20 64 65 74 61 69 6c 73  ional.** details
18620 20 61 62 6f 75 74 20 74 68 65 20 61 63 74 69 6f   about the actio
18630 6e 20 74 6f 20 62 65 20 61 75 74 68 6f 72 69 7a  n to be authoriz
18640 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68  ed..**.** ^If th
18650 65 20 61 63 74 69 6f 6e 20 63 6f 64 65 20 69 73  e action code is
18660 20 5b 53 51 4c 49 54 45 5f 52 45 41 44 5d 0a 2a   [SQLITE_READ].*
18670 2a 20 61 6e 64 20 74 68 65 20 63 61 6c 6c 62 61  * and the callba
18680 63 6b 20 72 65 74 75 72 6e 73 20 5b 53 51 4c 49  ck returns [SQLI
18690 54 45 5f 49 47 4e 4f 52 45 5d 20 74 68 65 6e 20  TE_IGNORE] then 
186a0 74 68 65 0a 2a 2a 20 5b 70 72 65 70 61 72 65 64  the.** [prepared
186b0 20 73 74 61 74 65 6d 65 6e 74 5d 20 73 74 61 74   statement] stat
186c0 65 6d 65 6e 74 20 69 73 20 63 6f 6e 73 74 72 75  ement is constru
186d0 63 74 65 64 20 74 6f 20 73 75 62 73 74 69 74 75  cted to substitu
186e0 74 65 0a 2a 2a 20 61 20 4e 55 4c 4c 20 76 61 6c  te.** a NULL val
186f0 75 65 20 69 6e 20 70 6c 61 63 65 20 6f 66 20 74  ue in place of t
18700 68 65 20 74 61 62 6c 65 20 63 6f 6c 75 6d 6e 20  he table column 
18710 74 68 61 74 20 77 6f 75 6c 64 20 68 61 76 65 0a  that would have.
18720 2a 2a 20 62 65 65 6e 20 72 65 61 64 20 69 66 20  ** been read if 
18730 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 68 61 64 20  [SQLITE_OK] had 
18740 62 65 65 6e 20 72 65 74 75 72 6e 65 64 2e 20 20  been returned.  
18750 54 68 65 20 5b 53 51 4c 49 54 45 5f 49 47 4e 4f  The [SQLITE_IGNO
18760 52 45 5d 0a 2a 2a 20 72 65 74 75 72 6e 20 63 61  RE].** return ca
18770 6e 20 62 65 20 75 73 65 64 20 74 6f 20 64 65 6e  n be used to den
18780 79 20 61 6e 20 75 6e 74 72 75 73 74 65 64 20 75  y an untrusted u
18790 73 65 72 20 61 63 63 65 73 73 20 74 6f 20 69 6e  ser access to in
187a0 64 69 76 69 64 75 61 6c 0a 2a 2a 20 63 6f 6c 75  dividual.** colu
187b0 6d 6e 73 20 6f 66 20 61 20 74 61 62 6c 65 2e 0a  mns of a table..
187c0 2a 2a 20 5e 49 66 20 74 68 65 20 61 63 74 69 6f  ** ^If the actio
187d0 6e 20 63 6f 64 65 20 69 73 20 5b 53 51 4c 49 54  n code is [SQLIT
187e0 45 5f 44 45 4c 45 54 45 5d 20 61 6e 64 20 74 68  E_DELETE] and th
187f0 65 20 63 61 6c 6c 62 61 63 6b 20 72 65 74 75 72  e callback retur
18800 6e 73 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 49 47  ns.** [SQLITE_IG
18810 4e 4f 52 45 5d 20 74 68 65 6e 20 74 68 65 20 5b  NORE] then the [
18820 44 45 4c 45 54 45 5d 20 6f 70 65 72 61 74 69 6f  DELETE] operatio
18830 6e 20 70 72 6f 63 65 65 64 73 20 62 75 74 20 74  n proceeds but t
18840 68 65 0a 2a 2a 20 5b 74 72 75 6e 63 61 74 65 20  he.** [truncate 
18850 6f 70 74 69 6d 69 7a 61 74 69 6f 6e 5d 20 69 73  optimization] is
18860 20 64 69 73 61 62 6c 65 64 20 61 6e 64 20 61 6c   disabled and al
18870 6c 20 72 6f 77 73 20 61 72 65 20 64 65 6c 65 74  l rows are delet
18880 65 64 20 69 6e 64 69 76 69 64 75 61 6c 6c 79 2e  ed individually.
18890 0a 2a 2a 0a 2a 2a 20 41 6e 20 61 75 74 68 6f 72  .**.** An author
188a0 69 7a 65 72 20 69 73 20 75 73 65 64 20 77 68 65  izer is used whe
188b0 6e 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61  n [sqlite3_prepa
188c0 72 65 20 7c 20 70 72 65 70 61 72 69 6e 67 5d 0a  re | preparing].
188d0 2a 2a 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  ** SQL statement
188e0 73 20 66 72 6f 6d 20 61 6e 20 75 6e 74 72 75 73  s from an untrus
188f0 74 65 64 20 73 6f 75 72 63 65 2c 20 74 6f 20 65  ted source, to e
18900 6e 73 75 72 65 20 74 68 61 74 20 74 68 65 20 53  nsure that the S
18910 51 4c 20 73 74 61 74 65 6d 65 6e 74 73 0a 2a 2a  QL statements.**
18920 20 64 6f 20 6e 6f 74 20 74 72 79 20 74 6f 20 61   do not try to a
18930 63 63 65 73 73 20 64 61 74 61 20 74 68 65 79 20  ccess data they 
18940 61 72 65 20 6e 6f 74 20 61 6c 6c 6f 77 65 64 20  are not allowed 
18950 74 6f 20 73 65 65 2c 20 6f 72 20 74 68 61 74 20  to see, or that 
18960 74 68 65 79 20 64 6f 20 6e 6f 74 0a 2a 2a 20 74  they do not.** t
18970 72 79 20 74 6f 20 65 78 65 63 75 74 65 20 6d 61  ry to execute ma
18980 6c 69 63 69 6f 75 73 20 73 74 61 74 65 6d 65 6e  licious statemen
18990 74 73 20 74 68 61 74 20 64 61 6d 61 67 65 20 74  ts that damage t
189a0 68 65 20 64 61 74 61 62 61 73 65 2e 20 20 46 6f  he database.  Fo
189b0 72 0a 2a 2a 20 65 78 61 6d 70 6c 65 2c 20 61 6e  r.** example, an
189c0 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 6d 61 79   application may
189d0 20 61 6c 6c 6f 77 20 61 20 75 73 65 72 20 74 6f   allow a user to
189e0 20 65 6e 74 65 72 20 61 72 62 69 74 72 61 72 79   enter arbitrary
189f0 0a 2a 2a 20 53 51 4c 20 71 75 65 72 69 65 73 20  .** SQL queries 
18a00 66 6f 72 20 65 76 61 6c 75 61 74 69 6f 6e 20 62  for evaluation b
18a10 79 20 61 20 64 61 74 61 62 61 73 65 2e 20 20 42  y a database.  B
18a20 75 74 20 74 68 65 20 61 70 70 6c 69 63 61 74 69  ut the applicati
18a30 6f 6e 20 64 6f 65 73 0a 2a 2a 20 6e 6f 74 20 77  on does.** not w
18a40 61 6e 74 20 74 68 65 20 75 73 65 72 20 74 6f 20  ant the user to 
18a50 62 65 20 61 62 6c 65 20 74 6f 20 6d 61 6b 65 20  be able to make 
18a60 61 72 62 69 74 72 61 72 79 20 63 68 61 6e 67 65  arbitrary change
18a70 73 20 74 6f 20 74 68 65 0a 2a 2a 20 64 61 74 61  s to the.** data
18a80 62 61 73 65 2e 20 20 41 6e 20 61 75 74 68 6f 72  base.  An author
18a90 69 7a 65 72 20 63 6f 75 6c 64 20 74 68 65 6e 20  izer could then 
18aa0 62 65 20 70 75 74 20 69 6e 20 70 6c 61 63 65 20  be put in place 
18ab0 77 68 69 6c 65 20 74 68 65 0a 2a 2a 20 75 73 65  while the.** use
18ac0 72 2d 65 6e 74 65 72 65 64 20 53 51 4c 20 69 73  r-entered SQL is
18ad0 20 62 65 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f   being [sqlite3_
18ae0 70 72 65 70 61 72 65 20 7c 20 70 72 65 70 61 72  prepare | prepar
18af0 65 64 5d 20 74 68 61 74 0a 2a 2a 20 64 69 73 61  ed] that.** disa
18b00 6c 6c 6f 77 73 20 65 76 65 72 79 74 68 69 6e 67  llows everything
18b10 20 65 78 63 65 70 74 20 5b 53 45 4c 45 43 54 5d   except [SELECT]
18b20 20 73 74 61 74 65 6d 65 6e 74 73 2e 0a 2a 2a 0a   statements..**.
18b30 2a 2a 20 41 70 70 6c 69 63 61 74 69 6f 6e 73 20  ** Applications 
18b40 74 68 61 74 20 6e 65 65 64 20 74 6f 20 70 72 6f  that need to pro
18b50 63 65 73 73 20 53 51 4c 20 66 72 6f 6d 20 75 6e  cess SQL from un
18b60 74 72 75 73 74 65 64 20 73 6f 75 72 63 65 73 0a  trusted sources.
18b70 2a 2a 20 6d 69 67 68 74 20 61 6c 73 6f 20 63 6f  ** might also co
18b80 6e 73 69 64 65 72 20 6c 6f 77 65 72 69 6e 67 20  nsider lowering 
18b90 72 65 73 6f 75 72 63 65 20 6c 69 6d 69 74 73 20  resource limits 
18ba0 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 6c  using [sqlite3_l
18bb0 69 6d 69 74 28 29 5d 0a 2a 2a 20 61 6e 64 20 6c  imit()].** and l
18bc0 69 6d 69 74 69 6e 67 20 64 61 74 61 62 61 73 65  imiting database
18bd0 20 73 69 7a 65 20 75 73 69 6e 67 20 74 68 65 20   size using the 
18be0 5b 6d 61 78 5f 70 61 67 65 5f 63 6f 75 6e 74 5d  [max_page_count]
18bf0 20 5b 50 52 41 47 4d 41 5d 0a 2a 2a 20 69 6e 20   [PRAGMA].** in 
18c00 61 64 64 69 74 69 6f 6e 20 74 6f 20 75 73 69 6e  addition to usin
18c10 67 20 61 6e 20 61 75 74 68 6f 72 69 7a 65 72 2e  g an authorizer.
18c20 0a 2a 2a 0a 2a 2a 20 5e 28 4f 6e 6c 79 20 61 20  .**.** ^(Only a 
18c30 73 69 6e 67 6c 65 20 61 75 74 68 6f 72 69 7a 65  single authorize
18c40 72 20 63 61 6e 20 62 65 20 69 6e 20 70 6c 61 63  r can be in plac
18c50 65 20 6f 6e 20 61 20 64 61 74 61 62 61 73 65 20  e on a database 
18c60 63 6f 6e 6e 65 63 74 69 6f 6e 0a 2a 2a 20 61 74  connection.** at
18c70 20 61 20 74 69 6d 65 2e 20 20 45 61 63 68 20 63   a time.  Each c
18c80 61 6c 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f 73  all to sqlite3_s
18c90 65 74 5f 61 75 74 68 6f 72 69 7a 65 72 20 6f 76  et_authorizer ov
18ca0 65 72 72 69 64 65 73 20 74 68 65 0a 2a 2a 20 70  errides the.** p
18cb0 72 65 76 69 6f 75 73 20 63 61 6c 6c 2e 29 5e 20  revious call.)^ 
18cc0 20 5e 44 69 73 61 62 6c 65 20 74 68 65 20 61 75   ^Disable the au
18cd0 74 68 6f 72 69 7a 65 72 20 62 79 20 69 6e 73 74  thorizer by inst
18ce0 61 6c 6c 69 6e 67 20 61 20 4e 55 4c 4c 20 63 61  alling a NULL ca
18cf0 6c 6c 62 61 63 6b 2e 0a 2a 2a 20 54 68 65 20 61  llback..** The a
18d00 75 74 68 6f 72 69 7a 65 72 20 69 73 20 64 69 73  uthorizer is dis
18d10 61 62 6c 65 64 20 62 79 20 64 65 66 61 75 6c 74  abled by default
18d20 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 61 75 74 68  ..**.** The auth
18d30 6f 72 69 7a 65 72 20 63 61 6c 6c 62 61 63 6b 20  orizer callback 
18d40 6d 75 73 74 20 6e 6f 74 20 64 6f 20 61 6e 79 74  must not do anyt
18d50 68 69 6e 67 20 74 68 61 74 20 77 69 6c 6c 20 6d  hing that will m
18d60 6f 64 69 66 79 0a 2a 2a 20 74 68 65 20 64 61 74  odify.** the dat
18d70 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
18d80 20 74 68 61 74 20 69 6e 76 6f 6b 65 64 20 74 68   that invoked th
18d90 65 20 61 75 74 68 6f 72 69 7a 65 72 20 63 61 6c  e authorizer cal
18da0 6c 62 61 63 6b 2e 0a 2a 2a 20 4e 6f 74 65 20 74  lback..** Note t
18db0 68 61 74 20 5b 73 71 6c 69 74 65 33 5f 70 72 65  hat [sqlite3_pre
18dc0 70 61 72 65 5f 76 32 28 29 5d 20 61 6e 64 20 5b  pare_v2()] and [
18dd0 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20  sqlite3_step()] 
18de0 62 6f 74 68 20 6d 6f 64 69 66 79 20 74 68 65 69  both modify thei
18df0 72 0a 2a 2a 20 64 61 74 61 62 61 73 65 20 63 6f  r.** database co
18e00 6e 6e 65 63 74 69 6f 6e 73 20 66 6f 72 20 74 68  nnections for th
18e10 65 20 6d 65 61 6e 69 6e 67 20 6f 66 20 22 6d 6f  e meaning of "mo
18e20 64 69 66 79 22 20 69 6e 20 74 68 69 73 20 70 61  dify" in this pa
18e30 72 61 67 72 61 70 68 2e 0a 2a 2a 0a 2a 2a 20 5e  ragraph..**.** ^
18e40 57 68 65 6e 20 5b 73 71 6c 69 74 65 33 5f 70 72  When [sqlite3_pr
18e50 65 70 61 72 65 5f 76 32 28 29 5d 20 69 73 20 75  epare_v2()] is u
18e60 73 65 64 20 74 6f 20 70 72 65 70 61 72 65 20 61  sed to prepare a
18e70 20 73 74 61 74 65 6d 65 6e 74 2c 20 74 68 65 0a   statement, the.
18e80 2a 2a 20 73 74 61 74 65 6d 65 6e 74 20 6d 69 67  ** statement mig
18e90 68 74 20 62 65 20 72 65 2d 70 72 65 70 61 72 65  ht be re-prepare
18ea0 64 20 64 75 72 69 6e 67 20 5b 73 71 6c 69 74 65  d during [sqlite
18eb0 33 5f 73 74 65 70 28 29 5d 20 64 75 65 20 74 6f  3_step()] due to
18ec0 20 61 20 0a 2a 2a 20 73 63 68 65 6d 61 20 63 68   a .** schema ch
18ed0 61 6e 67 65 2e 20 20 48 65 6e 63 65 2c 20 74 68  ange.  Hence, th
18ee0 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 73 68  e application sh
18ef0 6f 75 6c 64 20 65 6e 73 75 72 65 20 74 68 61 74  ould ensure that
18f00 20 74 68 65 0a 2a 2a 20 63 6f 72 72 65 63 74 20   the.** correct 
18f10 61 75 74 68 6f 72 69 7a 65 72 20 63 61 6c 6c 62  authorizer callb
18f20 61 63 6b 20 72 65 6d 61 69 6e 73 20 69 6e 20 70  ack remains in p
18f30 6c 61 63 65 20 64 75 72 69 6e 67 20 74 68 65 20  lace during the 
18f40 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d  [sqlite3_step()]
18f50 2e 0a 2a 2a 0a 2a 2a 20 5e 4e 6f 74 65 20 74 68  ..**.** ^Note th
18f60 61 74 20 74 68 65 20 61 75 74 68 6f 72 69 7a 65  at the authorize
18f70 72 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e  r callback is in
18f80 76 6f 6b 65 64 20 6f 6e 6c 79 20 64 75 72 69 6e  voked only durin
18f90 67 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 70 72  g.** [sqlite3_pr
18fa0 65 70 61 72 65 28 29 5d 20 6f 72 20 69 74 73 20  epare()] or its 
18fb0 76 61 72 69 61 6e 74 73 2e 20 20 41 75 74 68 6f  variants.  Autho
18fc0 72 69 7a 61 74 69 6f 6e 20 69 73 20 6e 6f 74 0a  rization is not.
18fd0 2a 2a 20 70 65 72 66 6f 72 6d 65 64 20 64 75 72  ** performed dur
18fe0 69 6e 67 20 73 74 61 74 65 6d 65 6e 74 20 65 76  ing statement ev
18ff0 61 6c 75 61 74 69 6f 6e 20 69 6e 20 5b 73 71 6c  aluation in [sql
19000 69 74 65 33 5f 73 74 65 70 28 29 5d 2c 20 75 6e  ite3_step()], un
19010 6c 65 73 73 0a 2a 2a 20 61 73 20 73 74 61 74 65  less.** as state
19020 64 20 69 6e 20 74 68 65 20 70 72 65 76 69 6f 75  d in the previou
19030 73 20 70 61 72 61 67 72 61 70 68 2c 20 73 71 6c  s paragraph, sql
19040 69 74 65 33 5f 73 74 65 70 28 29 20 69 6e 76 6f  ite3_step() invo
19050 6b 65 73 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 70  kes.** sqlite3_p
19060 72 65 70 61 72 65 5f 76 32 28 29 20 74 6f 20 72  repare_v2() to r
19070 65 70 72 65 70 61 72 65 20 61 20 73 74 61 74 65  eprepare a state
19080 6d 65 6e 74 20 61 66 74 65 72 20 61 20 73 63 68  ment after a sch
19090 65 6d 61 20 63 68 61 6e 67 65 2e 0a 2a 2f 0a 69  ema change..*/.i
190a0 6e 74 20 73 71 6c 69 74 65 33 5f 73 65 74 5f 61  nt sqlite3_set_a
190b0 75 74 68 6f 72 69 7a 65 72 28 0a 20 20 73 71 6c  uthorizer(.  sql
190c0 69 74 65 33 2a 2c 0a 20 20 69 6e 74 20 28 2a 78  ite3*,.  int (*x
190d0 41 75 74 68 29 28 76 6f 69 64 2a 2c 69 6e 74 2c  Auth)(void*,int,
190e0 63 6f 6e 73 74 20 63 68 61 72 2a 2c 63 6f 6e 73  const char*,cons
190f0 74 20 63 68 61 72 2a 2c 63 6f 6e 73 74 20 63 68  t char*,const ch
19100 61 72 2a 2c 63 6f 6e 73 74 20 63 68 61 72 2a 29  ar*,const char*)
19110 2c 0a 20 20 76 6f 69 64 20 2a 70 55 73 65 72 44  ,.  void *pUserD
19120 61 74 61 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41  ata.);../*.** CA
19130 50 49 33 52 45 46 3a 20 41 75 74 68 6f 72 69 7a  PI3REF: Authoriz
19140 65 72 20 52 65 74 75 72 6e 20 43 6f 64 65 73 0a  er Return Codes.
19150 2a 2a 0a 2a 2a 20 54 68 65 20 5b 73 71 6c 69 74  **.** The [sqlit
19160 65 33 5f 73 65 74 5f 61 75 74 68 6f 72 69 7a 65  e3_set_authorize
19170 72 20 7c 20 61 75 74 68 6f 72 69 7a 65 72 20 63  r | authorizer c
19180 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e  allback function
19190 5d 20 6d 75 73 74 0a 2a 2a 20 72 65 74 75 72 6e  ] must.** return
191a0 20 65 69 74 68 65 72 20 5b 53 51 4c 49 54 45 5f   either [SQLITE_
191b0 4f 4b 5d 20 6f 72 20 6f 6e 65 20 6f 66 20 74 68  OK] or one of th
191c0 65 73 65 20 74 77 6f 20 63 6f 6e 73 74 61 6e 74  ese two constant
191d0 73 20 69 6e 20 6f 72 64 65 72 0a 2a 2a 20 74 6f  s in order.** to
191e0 20 73 69 67 6e 61 6c 20 53 51 4c 69 74 65 20 77   signal SQLite w
191f0 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20 74 68  hether or not th
19200 65 20 61 63 74 69 6f 6e 20 69 73 20 70 65 72 6d  e action is perm
19210 69 74 74 65 64 2e 20 20 53 65 65 20 74 68 65 0a  itted.  See the.
19220 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 73 65 74 5f  ** [sqlite3_set_
19230 61 75 74 68 6f 72 69 7a 65 72 20 7c 20 61 75 74  authorizer | aut
19240 68 6f 72 69 7a 65 72 20 64 6f 63 75 6d 65 6e 74  horizer document
19250 61 74 69 6f 6e 5d 20 66 6f 72 20 61 64 64 69 74  ation] for addit
19260 69 6f 6e 61 6c 0a 2a 2a 20 69 6e 66 6f 72 6d 61  ional.** informa
19270 74 69 6f 6e 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65  tion..*/.#define
19280 20 53 51 4c 49 54 45 5f 44 45 4e 59 20 20 20 31   SQLITE_DENY   1
19290 20 20 20 2f 2a 20 41 62 6f 72 74 20 74 68 65 20     /* Abort the 
192a0 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 77 69  SQL statement wi
192b0 74 68 20 61 6e 20 65 72 72 6f 72 20 2a 2f 0a 23  th an error */.#
192c0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 47  define SQLITE_IG
192d0 4e 4f 52 45 20 32 20 20 20 2f 2a 20 44 6f 6e 27  NORE 2   /* Don'
192e0 74 20 61 6c 6c 6f 77 20 61 63 63 65 73 73 2c 20  t allow access, 
192f0 62 75 74 20 64 6f 6e 27 74 20 67 65 6e 65 72 61  but don't genera
19300 74 65 20 61 6e 20 65 72 72 6f 72 20 2a 2f 0a 0a  te an error */..
19310 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
19320 41 75 74 68 6f 72 69 7a 65 72 20 41 63 74 69 6f  Authorizer Actio
19330 6e 20 43 6f 64 65 73 0a 2a 2a 0a 2a 2a 20 54 68  n Codes.**.** Th
19340 65 20 5b 73 71 6c 69 74 65 33 5f 73 65 74 5f 61  e [sqlite3_set_a
19350 75 74 68 6f 72 69 7a 65 72 28 29 5d 20 69 6e 74  uthorizer()] int
19360 65 72 66 61 63 65 20 72 65 67 69 73 74 65 72 73  erface registers
19370 20 61 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63   a callback func
19380 74 69 6f 6e 0a 2a 2a 20 74 68 61 74 20 69 73 20  tion.** that is 
19390 69 6e 76 6f 6b 65 64 20 74 6f 20 61 75 74 68 6f  invoked to autho
193a0 72 69 7a 65 20 63 65 72 74 61 69 6e 20 53 51 4c  rize certain SQL
193b0 20 73 74 61 74 65 6d 65 6e 74 20 61 63 74 69 6f   statement actio
193c0 6e 73 2e 20 20 54 68 65 0a 2a 2a 20 73 65 63 6f  ns.  The.** seco
193d0 6e 64 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20  nd parameter to 
193e0 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 69 73 20  the callback is 
193f0 61 6e 20 69 6e 74 65 67 65 72 20 63 6f 64 65 20  an integer code 
19400 74 68 61 74 20 73 70 65 63 69 66 69 65 73 0a 2a  that specifies.*
19410 2a 20 77 68 61 74 20 61 63 74 69 6f 6e 20 69 73  * what action is
19420 20 62 65 69 6e 67 20 61 75 74 68 6f 72 69 7a 65   being authorize
19430 64 2e 20 20 54 68 65 73 65 20 61 72 65 20 74 68  d.  These are th
19440 65 20 69 6e 74 65 67 65 72 20 61 63 74 69 6f 6e  e integer action
19450 20 63 6f 64 65 73 20 74 68 61 74 0a 2a 2a 20 74   codes that.** t
19460 68 65 20 61 75 74 68 6f 72 69 7a 65 72 20 63 61  he authorizer ca
19470 6c 6c 62 61 63 6b 20 6d 61 79 20 62 65 20 70 61  llback may be pa
19480 73 73 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 73  ssed..**.** Thes
19490 65 20 61 63 74 69 6f 6e 20 63 6f 64 65 20 76 61  e action code va
194a0 6c 75 65 73 20 73 69 67 6e 69 66 79 20 77 68 61  lues signify wha
194b0 74 20 6b 69 6e 64 20 6f 66 20 6f 70 65 72 61 74  t kind of operat
194c0 69 6f 6e 20 69 73 20 74 6f 20 62 65 0a 2a 2a 20  ion is to be.** 
194d0 61 75 74 68 6f 72 69 7a 65 64 2e 20 20 54 68 65  authorized.  The
194e0 20 33 72 64 20 61 6e 64 20 34 74 68 20 70 61 72   3rd and 4th par
194f0 61 6d 65 74 65 72 73 20 74 6f 20 74 68 65 20 61  ameters to the a
19500 75 74 68 6f 72 69 7a 61 74 69 6f 6e 0a 2a 2a 20  uthorization.** 
19510 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f  callback functio
19520 6e 20 77 69 6c 6c 20 62 65 20 70 61 72 61 6d 65  n will be parame
19530 74 65 72 73 20 6f 72 20 4e 55 4c 4c 20 64 65 70  ters or NULL dep
19540 65 6e 64 69 6e 67 20 6f 6e 20 77 68 69 63 68 20  ending on which 
19550 6f 66 20 74 68 65 73 65 0a 2a 2a 20 63 6f 64 65  of these.** code
19560 73 20 69 73 20 75 73 65 64 20 61 73 20 74 68 65  s is used as the
19570 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65   second paramete
19580 72 2e 20 20 5e 28 54 68 65 20 35 74 68 20 70 61  r.  ^(The 5th pa
19590 72 61 6d 65 74 65 72 20 74 6f 20 74 68 65 0a 2a  rameter to the.*
195a0 2a 20 61 75 74 68 6f 72 69 7a 65 72 20 63 61 6c  * authorizer cal
195b0 6c 62 61 63 6b 20 69 73 20 74 68 65 20 6e 61 6d  lback is the nam
195c0 65 20 6f 66 20 74 68 65 20 64 61 74 61 62 61 73  e of the databas
195d0 65 20 28 22 6d 61 69 6e 22 2c 20 22 74 65 6d 70  e ("main", "temp
195e0 22 2c 0a 2a 2a 20 65 74 63 2e 29 20 69 66 20 61  ",.** etc.) if a
195f0 70 70 6c 69 63 61 62 6c 65 2e 29 5e 20 20 5e 54  pplicable.)^  ^T
19600 68 65 20 36 74 68 20 70 61 72 61 6d 65 74 65 72  he 6th parameter
19610 20 74 6f 20 74 68 65 20 61 75 74 68 6f 72 69 7a   to the authoriz
19620 65 72 20 63 61 6c 6c 62 61 63 6b 0a 2a 2a 20 69  er callback.** i
19630 73 20 74 68 65 20 6e 61 6d 65 20 6f 66 20 74 68  s the name of th
19640 65 20 69 6e 6e 65 72 2d 6d 6f 73 74 20 74 72 69  e inner-most tri
19650 67 67 65 72 20 6f 72 20 76 69 65 77 20 74 68 61  gger or view tha
19660 74 20 69 73 20 72 65 73 70 6f 6e 73 69 62 6c 65  t is responsible
19670 20 66 6f 72 0a 2a 2a 20 74 68 65 20 61 63 63 65   for.** the acce
19680 73 73 20 61 74 74 65 6d 70 74 20 6f 72 20 4e 55  ss attempt or NU
19690 4c 4c 20 69 66 20 74 68 69 73 20 61 63 63 65 73  LL if this acces
196a0 73 20 61 74 74 65 6d 70 74 20 69 73 20 64 69 72  s attempt is dir
196b0 65 63 74 6c 79 20 66 72 6f 6d 0a 2a 2a 20 74 6f  ectly from.** to
196c0 70 2d 6c 65 76 65 6c 20 53 51 4c 20 63 6f 64 65  p-level SQL code
196d0 2e 0a 2a 2f 0a 2f 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ..*/./**********
196e0 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
196f0 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
19700 2a 20 33 72 64 20 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  * 3rd **********
19710 2a 2a 20 34 74 68 20 2a 2a 2a 2a 2a 2a 2a 2a 2a  ** 4th *********
19720 2a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49  **/.#define SQLI
19730 54 45 5f 43 52 45 41 54 45 5f 49 4e 44 45 58 20  TE_CREATE_INDEX 
19740 20 20 20 20 20 20 20 20 20 31 20 20 20 2f 2a 20           1   /* 
19750 49 6e 64 65 78 20 4e 61 6d 65 20 20 20 20 20 20  Index Name      
19760 54 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20 20  Table Name      
19770 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
19780 45 5f 43 52 45 41 54 45 5f 54 41 42 4c 45 20 20  E_CREATE_TABLE  
19790 20 20 20 20 20 20 20 20 32 20 20 20 2f 2a 20 54          2   /* T
197a0 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 4e  able Name      N
197b0 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20 20 2a  ULL            *
197c0 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
197d0 5f 43 52 45 41 54 45 5f 54 45 4d 50 5f 49 4e 44  _CREATE_TEMP_IND
197e0 45 58 20 20 20 20 20 33 20 20 20 2f 2a 20 49 6e  EX     3   /* In
197f0 64 65 78 20 4e 61 6d 65 20 20 20 20 20 20 54 61  dex Name      Ta
19800 62 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 2a 2f  ble Name      */
19810 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
19820 43 52 45 41 54 45 5f 54 45 4d 50 5f 54 41 42 4c  CREATE_TEMP_TABL
19830 45 20 20 20 20 20 34 20 20 20 2f 2a 20 54 61 62  E     4   /* Tab
19840 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 4e 55 4c  le Name      NUL
19850 4c 20 20 20 20 20 20 20 20 20 20 20 20 2a 2f 0a  L            */.
19860 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43  #define SQLITE_C
19870 52 45 41 54 45 5f 54 45 4d 50 5f 54 52 49 47 47  REATE_TEMP_TRIGG
19880 45 52 20 20 20 35 20 20 20 2f 2a 20 54 72 69 67  ER   5   /* Trig
19890 67 65 72 20 4e 61 6d 65 20 20 20 20 54 61 62 6c  ger Name    Tabl
198a0 65 20 4e 61 6d 65 20 20 20 20 20 20 2a 2f 0a 23  e Name      */.#
198b0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 52  define SQLITE_CR
198c0 45 41 54 45 5f 54 45 4d 50 5f 56 49 45 57 20 20  EATE_TEMP_VIEW  
198d0 20 20 20 20 36 20 20 20 2f 2a 20 56 69 65 77 20      6   /* View 
198e0 4e 61 6d 65 20 20 20 20 20 20 20 4e 55 4c 4c 20  Name       NULL 
198f0 20 20 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64             */.#d
19900 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 52 45  efine SQLITE_CRE
19910 41 54 45 5f 54 52 49 47 47 45 52 20 20 20 20 20  ATE_TRIGGER     
19920 20 20 20 37 20 20 20 2f 2a 20 54 72 69 67 67 65     7   /* Trigge
19930 72 20 4e 61 6d 65 20 20 20 20 54 61 62 6c 65 20  r Name    Table 
19940 4e 61 6d 65 20 20 20 20 20 20 2a 2f 0a 23 64 65  Name      */.#de
19950 66 69 6e 65 20 53 51 4c 49 54 45 5f 43 52 45 41  fine SQLITE_CREA
19960 54 45 5f 56 49 45 57 20 20 20 20 20 20 20 20 20  TE_VIEW         
19970 20 20 38 20 20 20 2f 2a 20 56 69 65 77 20 4e 61    8   /* View Na
19980 6d 65 20 20 20 20 20 20 20 4e 55 4c 4c 20 20 20  me       NULL   
19990 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64 65 66           */.#def
199a0 69 6e 65 20 53 51 4c 49 54 45 5f 44 45 4c 45 54  ine SQLITE_DELET
199b0 45 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  E               
199c0 20 39 20 20 20 2f 2a 20 54 61 62 6c 65 20 4e 61   9   /* Table Na
199d0 6d 65 20 20 20 20 20 20 4e 55 4c 4c 20 20 20 20  me      NULL    
199e0 20 20 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69          */.#defi
199f0 6e 65 20 53 51 4c 49 54 45 5f 44 52 4f 50 5f 49  ne SQLITE_DROP_I
19a00 4e 44 45 58 20 20 20 20 20 20 20 20 20 20 20 31  NDEX           1
19a10 30 20 20 20 2f 2a 20 49 6e 64 65 78 20 4e 61 6d  0   /* Index Nam
19a20 65 20 20 20 20 20 20 54 61 62 6c 65 20 4e 61 6d  e      Table Nam
19a30 65 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e  e      */.#defin
19a40 65 20 53 51 4c 49 54 45 5f 44 52 4f 50 5f 54 41  e SQLITE_DROP_TA
19a50 42 4c 45 20 20 20 20 20 20 20 20 20 20 20 31 31  BLE           11
19a60 20 20 20 2f 2a 20 54 61 62 6c 65 20 4e 61 6d 65     /* Table Name
19a70 20 20 20 20 20 20 4e 55 4c 4c 20 20 20 20 20 20        NULL      
19a80 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65        */.#define
19a90 20 53 51 4c 49 54 45 5f 44 52 4f 50 5f 54 45 4d   SQLITE_DROP_TEM
19aa0 50 5f 49 4e 44 45 58 20 20 20 20 20 20 31 32 20  P_INDEX      12 
19ab0 20 20 2f 2a 20 49 6e 64 65 78 20 4e 61 6d 65 20    /* Index Name 
19ac0 20 20 20 20 20 54 61 62 6c 65 20 4e 61 6d 65 20       Table Name 
19ad0 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20       */.#define 
19ae0 53 51 4c 49 54 45 5f 44 52 4f 50 5f 54 45 4d 50  SQLITE_DROP_TEMP
19af0 5f 54 41 42 4c 45 20 20 20 20 20 20 31 33 20 20  _TABLE      13  
19b00 20 2f 2a 20 54 61 62 6c 65 20 4e 61 6d 65 20 20   /* Table Name  
19b10 20 20 20 20 4e 55 4c 4c 20 20 20 20 20 20 20 20      NULL        
19b20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53      */.#define S
19b30 51 4c 49 54 45 5f 44 52 4f 50 5f 54 45 4d 50 5f  QLITE_DROP_TEMP_
19b40 54 52 49 47 47 45 52 20 20 20 20 31 34 20 20 20  TRIGGER    14   
19b50 2f 2a 20 54 72 69 67 67 65 72 20 4e 61 6d 65 20  /* Trigger Name 
19b60 20 20 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20     Table Name   
19b70 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51     */.#define SQ
19b80 4c 49 54 45 5f 44 52 4f 50 5f 54 45 4d 50 5f 56  LITE_DROP_TEMP_V
19b90 49 45 57 20 20 20 20 20 20 20 31 35 20 20 20 2f  IEW       15   /
19ba0 2a 20 56 69 65 77 20 4e 61 6d 65 20 20 20 20 20  * View Name     
19bb0 20 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20    NULL          
19bc0 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c    */.#define SQL
19bd0 49 54 45 5f 44 52 4f 50 5f 54 52 49 47 47 45 52  ITE_DROP_TRIGGER
19be0 20 20 20 20 20 20 20 20 20 31 36 20 20 20 2f 2a           16   /*
19bf0 20 54 72 69 67 67 65 72 20 4e 61 6d 65 20 20 20   Trigger Name   
19c00 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20   Table Name     
19c10 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
19c20 54 45 5f 44 52 4f 50 5f 56 49 45 57 20 20 20 20  TE_DROP_VIEW    
19c30 20 20 20 20 20 20 20 20 31 37 20 20 20 2f 2a 20          17   /* 
19c40 56 69 65 77 20 4e 61 6d 65 20 20 20 20 20 20 20  View Name       
19c50 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20 20  NULL            
19c60 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  */.#define SQLIT
19c70 45 5f 49 4e 53 45 52 54 20 20 20 20 20 20 20 20  E_INSERT        
19c80 20 20 20 20 20 20 20 31 38 20 20 20 2f 2a 20 54         18   /* T
19c90 61 62 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 4e  able Name      N
19ca0 55 4c 4c 20 20 20 20 20 20 20 20 20 20 20 20 2a  ULL            *
19cb0 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
19cc0 5f 50 52 41 47 4d 41 20 20 20 20 20 20 20 20 20  _PRAGMA         
19cd0 20 20 20 20 20 20 31 39 20 20 20 2f 2a 20 50 72        19   /* Pr
19ce0 61 67 6d 61 20 4e 61 6d 65 20 20 20 20 20 31 73  agma Name     1s
19cf0 74 20 61 72 67 20 6f 72 20 4e 55 4c 4c 20 2a 2f  t arg or NULL */
19d00 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
19d10 52 45 41 44 20 20 20 20 20 20 20 20 20 20 20 20  READ            
19d20 20 20 20 20 20 32 30 20 20 20 2f 2a 20 54 61 62       20   /* Tab
19d30 6c 65 20 4e 61 6d 65 20 20 20 20 20 20 43 6f 6c  le Name      Col
19d40 75 6d 6e 20 4e 61 6d 65 20 20 20 20 20 2a 2f 0a  umn Name     */.
19d50 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 53  #define SQLITE_S
19d60 45 4c 45 43 54 20 20 20 20 20 20 20 20 20 20 20  ELECT           
19d70 20 20 20 20 32 31 20 20 20 2f 2a 20 4e 55 4c 4c      21   /* NULL
19d80 20 20 20 20 20 20 20 20 20 20 20 20 4e 55 4c 4c              NULL
19d90 20 20 20 20 20 20 20 20 20 20 20 20 2a 2f 0a 23              */.#
19da0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 54 52  define SQLITE_TR
19db0 41 4e 53 41 43 54 49 4f 4e 20 20 20 20 20 20 20  ANSACTION       
19dc0 20 20 20 32 32 20 20 20 2f 2a 20 4f 70 65 72 61     22   /* Opera
19dd0 74 69 6f 6e 20 20 20 20 20 20 20 4e 55 4c 4c 20  tion       NULL 
19de0 20 20 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64             */.#d
19df0 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 55 50 44  efine SQLITE_UPD
19e00 41 54 45 20 20 20 20 20 20 20 20 20 20 20 20 20  ATE             
19e10 20 20 32 33 20 20 20 2f 2a 20 54 61 62 6c 65 20    23   /* Table 
19e20 4e 61 6d 65 20 20 20 20 20 20 43 6f 6c 75 6d 6e  Name      Column
19e30 20 4e 61 6d 65 20 20 20 20 20 2a 2f 0a 23 64 65   Name     */.#de
19e40 66 69 6e 65 20 53 51 4c 49 54 45 5f 41 54 54 41  fine SQLITE_ATTA
19e50 43 48 20 20 20 20 20 20 20 20 20 20 20 20 20 20  CH              
19e60 20 32 34 20 20 20 2f 2a 20 46 69 6c 65 6e 61 6d   24   /* Filenam
19e70 65 20 20 20 20 20 20 20 20 4e 55 4c 4c 20 20 20  e        NULL   
19e80 20 20 20 20 20 20 20 20 20 2a 2f 0a 23 64 65 66           */.#def
19e90 69 6e 65 20 53 51 4c 49 54 45 5f 44 45 54 41 43  ine SQLITE_DETAC
19ea0 48 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  H               
19eb0 32 35 20 20 20 2f 2a 20 44 61 74 61 62 61 73 65  25   /* Database
19ec0 20 4e 61 6d 65 20 20 20 4e 55 4c 4c 20 20 20 20   Name   NULL    
19ed0 20 20 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69          */.#defi
19ee0 6e 65 20 53 51 4c 49 54 45 5f 41 4c 54 45 52 5f  ne SQLITE_ALTER_
19ef0 54 41 42 4c 45 20 20 20 20 20 20 20 20 20 20 32  TABLE          2
19f00 36 20 20 20 2f 2a 20 44 61 74 61 62 61 73 65 20  6   /* Database 
19f10 4e 61 6d 65 20 20 20 54 61 62 6c 65 20 4e 61 6d  Name   Table Nam
19f20 65 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e  e      */.#defin
19f30 65 20 53 51 4c 49 54 45 5f 52 45 49 4e 44 45 58  e SQLITE_REINDEX
19f40 20 20 20 20 20 20 20 20 20 20 20 20 20 20 32 37                27
19f50 20 20 20 2f 2a 20 49 6e 64 65 78 20 4e 61 6d 65     /* Index Name
19f60 20 20 20 20 20 20 4e 55 4c 4c 20 20 20 20 20 20        NULL      
19f70 20 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65        */.#define
19f80 20 53 51 4c 49 54 45 5f 41 4e 41 4c 59 5a 45 20   SQLITE_ANALYZE 
19f90 20 20 20 20 20 20 20 20 20 20 20 20 20 32 38 20               28 
19fa0 20 20 2f 2a 20 54 61 62 6c 65 20 4e 61 6d 65 20    /* Table Name 
19fb0 20 20 20 20 20 4e 55 4c 4c 20 20 20 20 20 20 20       NULL       
19fc0 20 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20       */.#define 
19fd0 53 51 4c 49 54 45 5f 43 52 45 41 54 45 5f 56 54  SQLITE_CREATE_VT
19fe0 41 42 4c 45 20 20 20 20 20 20 20 20 32 39 20 20  ABLE        29  
19ff0 20 2f 2a 20 54 61 62 6c 65 20 4e 61 6d 65 20 20   /* Table Name  
1a000 20 20 20 20 4d 6f 64 75 6c 65 20 4e 61 6d 65 20      Module Name 
1a010 20 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53      */.#define S
1a020 51 4c 49 54 45 5f 44 52 4f 50 5f 56 54 41 42 4c  QLITE_DROP_VTABL
1a030 45 20 20 20 20 20 20 20 20 20 20 33 30 20 20 20  E          30   
1a040 2f 2a 20 54 61 62 6c 65 20 4e 61 6d 65 20 20 20  /* Table Name   
1a050 20 20 20 4d 6f 64 75 6c 65 20 4e 61 6d 65 20 20     Module Name  
1a060 20 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51     */.#define SQ
1a070 4c 49 54 45 5f 46 55 4e 43 54 49 4f 4e 20 20 20  LITE_FUNCTION   
1a080 20 20 20 20 20 20 20 20 20 20 33 31 20 20 20 2f            31   /
1a090 2a 20 4e 55 4c 4c 20 20 20 20 20 20 20 20 20 20  * NULL          
1a0a0 20 20 46 75 6e 63 74 69 6f 6e 20 4e 61 6d 65 20    Function Name 
1a0b0 20 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c    */.#define SQL
1a0c0 49 54 45 5f 53 41 56 45 50 4f 49 4e 54 20 20 20  ITE_SAVEPOINT   
1a0d0 20 20 20 20 20 20 20 20 20 33 32 20 20 20 2f 2a           32   /*
1a0e0 20 4f 70 65 72 61 74 69 6f 6e 20 20 20 20 20 20   Operation      
1a0f0 20 53 61 76 65 70 6f 69 6e 74 20 4e 61 6d 65 20   Savepoint Name 
1a100 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
1a110 54 45 5f 43 4f 50 59 20 20 20 20 20 20 20 20 20  TE_COPY         
1a120 20 20 20 20 20 20 20 20 20 30 20 20 20 2f 2a 20           0   /* 
1a130 4e 6f 20 6c 6f 6e 67 65 72 20 75 73 65 64 20 2a  No longer used *
1a140 2f 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  /../*.** CAPI3RE
1a150 46 3a 20 54 72 61 63 69 6e 67 20 41 6e 64 20 50  F: Tracing And P
1a160 72 6f 66 69 6c 69 6e 67 20 46 75 6e 63 74 69 6f  rofiling Functio
1a170 6e 73 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72  ns.**.** These r
1a180 6f 75 74 69 6e 65 73 20 72 65 67 69 73 74 65 72  outines register
1a190 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69   callback functi
1a1a0 6f 6e 73 20 74 68 61 74 20 63 61 6e 20 62 65 20  ons that can be 
1a1b0 75 73 65 64 20 66 6f 72 0a 2a 2a 20 74 72 61 63  used for.** trac
1a1c0 69 6e 67 20 61 6e 64 20 70 72 6f 66 69 6c 69 6e  ing and profilin
1a1d0 67 20 74 68 65 20 65 78 65 63 75 74 69 6f 6e 20  g the execution 
1a1e0 6f 66 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74  of SQL statement
1a1f0 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 63 61  s..**.** ^The ca
1a200 6c 6c 62 61 63 6b 20 66 75 6e 63 74 69 6f 6e 20  llback function 
1a210 72 65 67 69 73 74 65 72 65 64 20 62 79 20 73 71  registered by sq
1a220 6c 69 74 65 33 5f 74 72 61 63 65 28 29 20 69 73  lite3_trace() is
1a230 20 69 6e 76 6f 6b 65 64 20 61 74 0a 2a 2a 20 76   invoked at.** v
1a240 61 72 69 6f 75 73 20 74 69 6d 65 73 20 77 68 65  arious times whe
1a250 6e 20 61 6e 20 53 51 4c 20 73 74 61 74 65 6d 65  n an SQL stateme
1a260 6e 74 20 69 73 20 62 65 69 6e 67 20 72 75 6e 20  nt is being run 
1a270 62 79 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70  by [sqlite3_step
1a280 28 29 5d 2e 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  ()]..** ^The sql
1a290 69 74 65 33 5f 74 72 61 63 65 28 29 20 63 61 6c  ite3_trace() cal
1a2a0 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65 64  lback is invoked
1a2b0 20 77 69 74 68 20 61 20 55 54 46 2d 38 20 72 65   with a UTF-8 re
1a2c0 6e 64 65 72 69 6e 67 20 6f 66 20 74 68 65 0a 2a  ndering of the.*
1a2d0 2a 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 20  * SQL statement 
1a2e0 74 65 78 74 20 61 73 20 74 68 65 20 73 74 61 74  text as the stat
1a2f0 65 6d 65 6e 74 20 66 69 72 73 74 20 62 65 67 69  ement first begi
1a300 6e 73 20 65 78 65 63 75 74 69 6e 67 2e 0a 2a 2a  ns executing..**
1a310 20 5e 28 41 64 64 69 74 69 6f 6e 61 6c 20 73 71   ^(Additional sq
1a320 6c 69 74 65 33 5f 74 72 61 63 65 28 29 20 63 61  lite3_trace() ca
1a330 6c 6c 62 61 63 6b 73 20 6d 69 67 68 74 20 6f 63  llbacks might oc
1a340 63 75 72 0a 2a 2a 20 61 73 20 65 61 63 68 20 74  cur.** as each t
1a350 72 69 67 67 65 72 65 64 20 73 75 62 70 72 6f 67  riggered subprog
1a360 72 61 6d 20 69 73 20 65 6e 74 65 72 65 64 2e 20  ram is entered. 
1a370 20 54 68 65 20 63 61 6c 6c 62 61 63 6b 73 20 66   The callbacks f
1a380 6f 72 20 74 72 69 67 67 65 72 73 0a 2a 2a 20 63  or triggers.** c
1a390 6f 6e 74 61 69 6e 20 61 20 55 54 46 2d 38 20 53  ontain a UTF-8 S
1a3a0 51 4c 20 63 6f 6d 6d 65 6e 74 20 74 68 61 74 20  QL comment that 
1a3b0 69 64 65 6e 74 69 66 69 65 73 20 74 68 65 20 74  identifies the t
1a3c0 72 69 67 67 65 72 2e 29 5e 0a 2a 2a 0a 2a 2a 20  rigger.)^.**.** 
1a3d0 5e 54 68 65 20 63 61 6c 6c 62 61 63 6b 20 66 75  ^The callback fu
1a3e0 6e 63 74 69 6f 6e 20 72 65 67 69 73 74 65 72 65  nction registere
1a3f0 64 20 62 79 20 73 71 6c 69 74 65 33 5f 70 72 6f  d by sqlite3_pro
1a400 66 69 6c 65 28 29 20 69 73 20 69 6e 76 6f 6b 65  file() is invoke
1a410 64 0a 2a 2a 20 61 73 20 65 61 63 68 20 53 51 4c  d.** as each SQL
1a420 20 73 74 61 74 65 6d 65 6e 74 20 66 69 6e 69 73   statement finis
1a430 68 65 73 2e 20 20 5e 54 68 65 20 70 72 6f 66 69  hes.  ^The profi
1a440 6c 65 20 63 61 6c 6c 62 61 63 6b 20 63 6f 6e 74  le callback cont
1a450 61 69 6e 73 0a 2a 2a 20 74 68 65 20 6f 72 69 67  ains.** the orig
1a460 69 6e 61 6c 20 73 74 61 74 65 6d 65 6e 74 20 74  inal statement t
1a470 65 78 74 20 61 6e 64 20 61 6e 20 65 73 74 69 6d  ext and an estim
1a480 61 74 65 20 6f 66 20 77 61 6c 6c 2d 63 6c 6f 63  ate of wall-cloc
1a490 6b 20 74 69 6d 65 0a 2a 2a 20 6f 66 20 68 6f 77  k time.** of how
1a4a0 20 6c 6f 6e 67 20 74 68 61 74 20 73 74 61 74 65   long that state
1a4b0 6d 65 6e 74 20 74 6f 6f 6b 20 74 6f 20 72 75 6e  ment took to run
1a4c0 2e 20 20 5e 54 68 65 20 70 72 6f 66 69 6c 65 20  .  ^The profile 
1a4d0 63 61 6c 6c 62 61 63 6b 0a 2a 2a 20 74 69 6d 65  callback.** time
1a4e0 20 69 73 20 69 6e 20 75 6e 69 74 73 20 6f 66 20   is in units of 
1a4f0 6e 61 6e 6f 73 65 63 6f 6e 64 73 2c 20 68 6f 77  nanoseconds, how
1a500 65 76 65 72 20 74 68 65 20 63 75 72 72 65 6e 74  ever the current
1a510 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 0a   implementation.
1a520 2a 2a 20 69 73 20 6f 6e 6c 79 20 63 61 70 61 62  ** is only capab
1a530 6c 65 20 6f 66 20 6d 69 6c 6c 69 73 65 63 6f 6e  le of millisecon
1a540 64 20 72 65 73 6f 6c 75 74 69 6f 6e 20 73 6f 20  d resolution so 
1a550 74 68 65 20 73 69 78 20 6c 65 61 73 74 20 73 69  the six least si
1a560 67 6e 69 66 69 63 61 6e 74 0a 2a 2a 20 64 69 67  gnificant.** dig
1a570 69 74 73 20 69 6e 20 74 68 65 20 74 69 6d 65 20  its in the time 
1a580 61 72 65 20 6d 65 61 6e 69 6e 67 6c 65 73 73 2e  are meaningless.
1a590 20 20 46 75 74 75 72 65 20 76 65 72 73 69 6f 6e    Future version
1a5a0 73 20 6f 66 20 53 51 4c 69 74 65 0a 2a 2a 20 6d  s of SQLite.** m
1a5b0 69 67 68 74 20 70 72 6f 76 69 64 65 20 67 72 65  ight provide gre
1a5c0 61 74 65 72 20 72 65 73 6f 6c 75 74 69 6f 6e 20  ater resolution 
1a5d0 6f 6e 20 74 68 65 20 70 72 6f 66 69 6c 65 72 20  on the profiler 
1a5e0 63 61 6c 6c 62 61 63 6b 2e 20 20 54 68 65 0a 2a  callback.  The.*
1a5f0 2a 20 73 71 6c 69 74 65 33 5f 70 72 6f 66 69 6c  * sqlite3_profil
1a600 65 28 29 20 66 75 6e 63 74 69 6f 6e 20 69 73 20  e() function is 
1a610 63 6f 6e 73 69 64 65 72 65 64 20 65 78 70 65 72  considered exper
1a620 69 6d 65 6e 74 61 6c 20 61 6e 64 20 69 73 0a 2a  imental and is.*
1a630 2a 20 73 75 62 6a 65 63 74 20 74 6f 20 63 68 61  * subject to cha
1a640 6e 67 65 20 69 6e 20 66 75 74 75 72 65 20 76 65  nge in future ve
1a650 72 73 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74 65  rsions of SQLite
1a660 2e 0a 2a 2f 0a 76 6f 69 64 20 2a 73 71 6c 69 74  ..*/.void *sqlit
1a670 65 33 5f 74 72 61 63 65 28 73 71 6c 69 74 65 33  e3_trace(sqlite3
1a680 2a 2c 20 76 6f 69 64 28 2a 78 54 72 61 63 65 29  *, void(*xTrace)
1a690 28 76 6f 69 64 2a 2c 63 6f 6e 73 74 20 63 68 61  (void*,const cha
1a6a0 72 2a 29 2c 20 76 6f 69 64 2a 29 3b 0a 53 51 4c  r*), void*);.SQL
1a6b0 49 54 45 5f 45 58 50 45 52 49 4d 45 4e 54 41 4c  ITE_EXPERIMENTAL
1a6c0 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 70   void *sqlite3_p
1a6d0 72 6f 66 69 6c 65 28 73 71 6c 69 74 65 33 2a 2c  rofile(sqlite3*,
1a6e0 0a 20 20 20 76 6f 69 64 28 2a 78 50 72 6f 66 69  .   void(*xProfi
1a6f0 6c 65 29 28 76 6f 69 64 2a 2c 63 6f 6e 73 74 20  le)(void*,const 
1a700 63 68 61 72 2a 2c 73 71 6c 69 74 65 33 5f 75 69  char*,sqlite3_ui
1a710 6e 74 36 34 29 2c 20 76 6f 69 64 2a 29 3b 0a 0a  nt64), void*);..
1a720 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
1a730 51 75 65 72 79 20 50 72 6f 67 72 65 73 73 20 43  Query Progress C
1a740 61 6c 6c 62 61 63 6b 73 0a 2a 2a 0a 2a 2a 20 5e  allbacks.**.** ^
1a750 54 68 65 20 73 71 6c 69 74 65 33 5f 70 72 6f 67  The sqlite3_prog
1a760 72 65 73 73 5f 68 61 6e 64 6c 65 72 28 44 2c 4e  ress_handler(D,N
1a770 2c 58 2c 50 29 20 69 6e 74 65 72 66 61 63 65 20  ,X,P) interface 
1a780 63 61 75 73 65 73 20 74 68 65 20 63 61 6c 6c 62  causes the callb
1a790 61 63 6b 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20  ack.** function 
1a7a0 58 20 74 6f 20 62 65 20 69 6e 76 6f 6b 65 64 20  X to be invoked 
1a7b0 70 65 72 69 6f 64 69 63 61 6c 6c 79 20 64 75 72  periodically dur
1a7c0 69 6e 67 20 6c 6f 6e 67 20 72 75 6e 6e 69 6e 67  ing long running
1a7d0 20 63 61 6c 6c 73 20 74 6f 0a 2a 2a 20 5b 73 71   calls to.** [sq
1a7e0 6c 69 74 65 33 5f 65 78 65 63 28 29 5d 2c 20 5b  lite3_exec()], [
1a7f0 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20  sqlite3_step()] 
1a800 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 67 65 74  and [sqlite3_get
1a810 5f 74 61 62 6c 65 28 29 5d 20 66 6f 72 0a 2a 2a  _table()] for.**
1a820 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63   database connec
1a830 74 69 6f 6e 20 44 2e 20 20 41 6e 20 65 78 61 6d  tion D.  An exam
1a840 70 6c 65 20 75 73 65 20 66 6f 72 20 74 68 69 73  ple use for this
1a850 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 69 73  .** interface is
1a860 20 74 6f 20 6b 65 65 70 20 61 20 47 55 49 20 75   to keep a GUI u
1a870 70 64 61 74 65 64 20 64 75 72 69 6e 67 20 61 20  pdated during a 
1a880 6c 61 72 67 65 20 71 75 65 72 79 2e 0a 2a 2a 0a  large query..**.
1a890 2a 2a 20 5e 54 68 65 20 70 61 72 61 6d 65 74 65  ** ^The paramete
1a8a0 72 20 50 20 69 73 20 70 61 73 73 65 64 20 74 68  r P is passed th
1a8b0 72 6f 75 67 68 20 61 73 20 74 68 65 20 6f 6e 6c  rough as the onl
1a8c0 79 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 74  y parameter to t
1a8d0 68 65 20 0a 2a 2a 20 63 61 6c 6c 62 61 63 6b 20  he .** callback 
1a8e0 66 75 6e 63 74 69 6f 6e 20 58 2e 20 20 5e 54 68  function X.  ^Th
1a8f0 65 20 70 61 72 61 6d 65 74 65 72 20 4e 20 69 73  e parameter N is
1a900 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 0a   the number of .
1a910 2a 2a 20 5b 76 69 72 74 75 61 6c 20 6d 61 63 68  ** [virtual mach
1a920 69 6e 65 20 69 6e 73 74 72 75 63 74 69 6f 6e 73  ine instructions
1a930 5d 20 74 68 61 74 20 61 72 65 20 65 76 61 6c 75  ] that are evalu
1a940 61 74 65 64 20 62 65 74 77 65 65 6e 20 73 75 63  ated between suc
1a950 63 65 73 73 69 76 65 0a 2a 2a 20 69 6e 76 6f 63  cessive.** invoc
1a960 61 74 69 6f 6e 73 20 6f 66 20 74 68 65 20 63 61  ations of the ca
1a970 6c 6c 62 61 63 6b 20 58 2e 0a 2a 2a 0a 2a 2a 20  llback X..**.** 
1a980 5e 4f 6e 6c 79 20 61 20 73 69 6e 67 6c 65 20 70  ^Only a single p
1a990 72 6f 67 72 65 73 73 20 68 61 6e 64 6c 65 72 20  rogress handler 
1a9a0 6d 61 79 20 62 65 20 64 65 66 69 6e 65 64 20 61  may be defined a
1a9b0 74 20 6f 6e 65 20 74 69 6d 65 20 70 65 72 0a 2a  t one time per.*
1a9c0 2a 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  * [database conn
1a9d0 65 63 74 69 6f 6e 5d 3b 20 73 65 74 74 69 6e 67  ection]; setting
1a9e0 20 61 20 6e 65 77 20 70 72 6f 67 72 65 73 73 20   a new progress 
1a9f0 68 61 6e 64 6c 65 72 20 63 61 6e 63 65 6c 73 20  handler cancels 
1aa00 74 68 65 0a 2a 2a 20 6f 6c 64 20 6f 6e 65 2e 20  the.** old one. 
1aa10 20 5e 53 65 74 74 69 6e 67 20 70 61 72 61 6d 65   ^Setting parame
1aa20 74 65 72 20 58 20 74 6f 20 4e 55 4c 4c 20 64 69  ter X to NULL di
1aa30 73 61 62 6c 65 73 20 74 68 65 20 70 72 6f 67 72  sables the progr
1aa40 65 73 73 20 68 61 6e 64 6c 65 72 2e 0a 2a 2a 20  ess handler..** 
1aa50 5e 54 68 65 20 70 72 6f 67 72 65 73 73 20 68 61  ^The progress ha
1aa60 6e 64 6c 65 72 20 69 73 20 61 6c 73 6f 20 64 69  ndler is also di
1aa70 73 61 62 6c 65 64 20 62 79 20 73 65 74 74 69 6e  sabled by settin
1aa80 67 20 4e 20 74 6f 20 61 20 76 61 6c 75 65 20 6c  g N to a value l
1aa90 65 73 73 0a 2a 2a 20 74 68 61 6e 20 31 2e 0a 2a  ess.** than 1..*
1aaa0 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 70 72 6f  *.** ^If the pro
1aab0 67 72 65 73 73 20 63 61 6c 6c 62 61 63 6b 20 72  gress callback r
1aac0 65 74 75 72 6e 73 20 6e 6f 6e 2d 7a 65 72 6f 2c  eturns non-zero,
1aad0 20 74 68 65 20 6f 70 65 72 61 74 69 6f 6e 20 69   the operation i
1aae0 73 0a 2a 2a 20 69 6e 74 65 72 72 75 70 74 65 64  s.** interrupted
1aaf0 2e 20 20 54 68 69 73 20 66 65 61 74 75 72 65 20  .  This feature 
1ab00 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20 69  can be used to i
1ab10 6d 70 6c 65 6d 65 6e 74 20 61 0a 2a 2a 20 22 43  mplement a.** "C
1ab20 61 6e 63 65 6c 22 20 62 75 74 74 6f 6e 20 6f 6e  ancel" button on
1ab30 20 61 20 47 55 49 20 70 72 6f 67 72 65 73 73 20   a GUI progress 
1ab40 64 69 61 6c 6f 67 20 62 6f 78 2e 0a 2a 2a 0a 2a  dialog box..**.*
1ab50 2a 20 54 68 65 20 70 72 6f 67 72 65 73 73 20 68  * The progress h
1ab60 61 6e 64 6c 65 72 20 63 61 6c 6c 62 61 63 6b 20  andler callback 
1ab70 6d 75 73 74 20 6e 6f 74 20 64 6f 20 61 6e 79 74  must not do anyt
1ab80 68 69 6e 67 20 74 68 61 74 20 77 69 6c 6c 20 6d  hing that will m
1ab90 6f 64 69 66 79 0a 2a 2a 20 74 68 65 20 64 61 74  odify.** the dat
1aba0 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
1abb0 20 74 68 61 74 20 69 6e 76 6f 6b 65 64 20 74 68   that invoked th
1abc0 65 20 70 72 6f 67 72 65 73 73 20 68 61 6e 64 6c  e progress handl
1abd0 65 72 2e 0a 2a 2a 20 4e 6f 74 65 20 74 68 61 74  er..** Note that
1abe0 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72   [sqlite3_prepar
1abf0 65 5f 76 32 28 29 5d 20 61 6e 64 20 5b 73 71 6c  e_v2()] and [sql
1ac00 69 74 65 33 5f 73 74 65 70 28 29 5d 20 62 6f 74  ite3_step()] bot
1ac10 68 20 6d 6f 64 69 66 79 20 74 68 65 69 72 0a 2a  h modify their.*
1ac20 2a 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65  * database conne
1ac30 63 74 69 6f 6e 73 20 66 6f 72 20 74 68 65 20 6d  ctions for the m
1ac40 65 61 6e 69 6e 67 20 6f 66 20 22 6d 6f 64 69 66  eaning of "modif
1ac50 79 22 20 69 6e 20 74 68 69 73 20 70 61 72 61 67  y" in this parag
1ac60 72 61 70 68 2e 0a 2a 2a 0a 2a 2f 0a 76 6f 69 64  raph..**.*/.void
1ac70 20 73 71 6c 69 74 65 33 5f 70 72 6f 67 72 65 73   sqlite3_progres
1ac80 73 5f 68 61 6e 64 6c 65 72 28 73 71 6c 69 74 65  s_handler(sqlite
1ac90 33 2a 2c 20 69 6e 74 2c 20 69 6e 74 28 2a 29 28  3*, int, int(*)(
1aca0 76 6f 69 64 2a 29 2c 20 76 6f 69 64 2a 29 3b 0a  void*), void*);.
1acb0 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
1acc0 20 4f 70 65 6e 69 6e 67 20 41 20 4e 65 77 20 44   Opening A New D
1acd0 61 74 61 62 61 73 65 20 43 6f 6e 6e 65 63 74 69  atabase Connecti
1ace0 6f 6e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 73 65 20  on.**.** ^These 
1acf0 72 6f 75 74 69 6e 65 73 20 6f 70 65 6e 20 61 6e  routines open an
1ad00 20 53 51 4c 69 74 65 20 64 61 74 61 62 61 73 65   SQLite database
1ad10 20 66 69 6c 65 20 77 68 6f 73 65 20 6e 61 6d 65   file whose name
1ad20 20 69 73 20 67 69 76 65 6e 20 62 79 20 74 68 65   is given by the
1ad30 0a 2a 2a 20 66 69 6c 65 6e 61 6d 65 20 61 72 67  .** filename arg
1ad40 75 6d 65 6e 74 2e 20 5e 54 68 65 20 66 69 6c 65  ument. ^The file
1ad50 6e 61 6d 65 20 61 72 67 75 6d 65 6e 74 20 69 73  name argument is
1ad60 20 69 6e 74 65 72 70 72 65 74 65 64 20 61 73 20   interpreted as 
1ad70 55 54 46 2d 38 20 66 6f 72 0a 2a 2a 20 73 71 6c  UTF-8 for.** sql
1ad80 69 74 65 33 5f 6f 70 65 6e 28 29 20 61 6e 64 20  ite3_open() and 
1ad90 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28  sqlite3_open_v2(
1ada0 29 20 61 6e 64 20 61 73 20 55 54 46 2d 31 36 20  ) and as UTF-16 
1adb0 69 6e 20 74 68 65 20 6e 61 74 69 76 65 20 62 79  in the native by
1adc0 74 65 0a 2a 2a 20 6f 72 64 65 72 20 66 6f 72 20  te.** order for 
1add0 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31 36 28 29  sqlite3_open16()
1ade0 2e 20 5e 28 41 20 5b 64 61 74 61 62 61 73 65 20  . ^(A [database 
1adf0 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 68 61 6e 64  connection] hand
1ae00 6c 65 20 69 73 20 75 73 75 61 6c 6c 79 0a 2a 2a  le is usually.**
1ae10 20 72 65 74 75 72 6e 65 64 20 69 6e 20 2a 70 70   returned in *pp
1ae20 44 62 2c 20 65 76 65 6e 20 69 66 20 61 6e 20 65  Db, even if an e
1ae30 72 72 6f 72 20 6f 63 63 75 72 73 2e 20 20 54 68  rror occurs.  Th
1ae40 65 20 6f 6e 6c 79 20 65 78 63 65 70 74 69 6f 6e  e only exception
1ae50 20 69 73 20 74 68 61 74 0a 2a 2a 20 69 66 20 53   is that.** if S
1ae60 51 4c 69 74 65 20 69 73 20 75 6e 61 62 6c 65 20  QLite is unable 
1ae70 74 6f 20 61 6c 6c 6f 63 61 74 65 20 6d 65 6d 6f  to allocate memo
1ae80 72 79 20 74 6f 20 68 6f 6c 64 20 74 68 65 20 5b  ry to hold the [
1ae90 73 71 6c 69 74 65 33 5d 20 6f 62 6a 65 63 74 2c  sqlite3] object,
1aea0 0a 2a 2a 20 61 20 4e 55 4c 4c 20 77 69 6c 6c 20  .** a NULL will 
1aeb0 62 65 20 77 72 69 74 74 65 6e 20 69 6e 74 6f 20  be written into 
1aec0 2a 70 70 44 62 20 69 6e 73 74 65 61 64 20 6f 66  *ppDb instead of
1aed0 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 74 68   a pointer to th
1aee0 65 20 5b 73 71 6c 69 74 65 33 5d 0a 2a 2a 20 6f  e [sqlite3].** o
1aef0 62 6a 65 63 74 2e 29 5e 20 5e 28 49 66 20 74 68  bject.)^ ^(If th
1af00 65 20 64 61 74 61 62 61 73 65 20 69 73 20 6f 70  e database is op
1af10 65 6e 65 64 20 28 61 6e 64 2f 6f 72 20 63 72 65  ened (and/or cre
1af20 61 74 65 64 29 20 73 75 63 63 65 73 73 66 75 6c  ated) successful
1af30 6c 79 2c 20 74 68 65 6e 0a 2a 2a 20 5b 53 51 4c  ly, then.** [SQL
1af40 49 54 45 5f 4f 4b 5d 20 69 73 20 72 65 74 75 72  ITE_OK] is retur
1af50 6e 65 64 2e 20 20 4f 74 68 65 72 77 69 73 65 20  ned.  Otherwise 
1af60 61 6e 20 5b 65 72 72 6f 72 20 63 6f 64 65 5d 20  an [error code] 
1af70 69 73 20 72 65 74 75 72 6e 65 64 2e 29 5e 20 5e  is returned.)^ ^
1af80 54 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  The.** [sqlite3_
1af90 65 72 72 6d 73 67 28 29 5d 20 6f 72 20 5b 73 71  errmsg()] or [sq
1afa0 6c 69 74 65 33 5f 65 72 72 6d 73 67 31 36 28 29  lite3_errmsg16()
1afb0 5d 20 72 6f 75 74 69 6e 65 73 20 63 61 6e 20 62  ] routines can b
1afc0 65 20 75 73 65 64 20 74 6f 20 6f 62 74 61 69 6e  e used to obtain
1afd0 0a 2a 2a 20 61 6e 20 45 6e 67 6c 69 73 68 20 6c  .** an English l
1afe0 61 6e 67 75 61 67 65 20 64 65 73 63 72 69 70 74  anguage descript
1aff0 69 6f 6e 20 6f 66 20 74 68 65 20 65 72 72 6f 72  ion of the error
1b000 20 66 6f 6c 6c 6f 77 69 6e 67 20 61 20 66 61 69   following a fai
1b010 6c 75 72 65 20 6f 66 20 61 6e 79 0a 2a 2a 20 6f  lure of any.** o
1b020 66 20 74 68 65 20 73 71 6c 69 74 65 33 5f 6f 70  f the sqlite3_op
1b030 65 6e 28 29 20 72 6f 75 74 69 6e 65 73 2e 0a 2a  en() routines..*
1b040 2a 0a 2a 2a 20 5e 54 68 65 20 64 65 66 61 75 6c  *.** ^The defaul
1b050 74 20 65 6e 63 6f 64 69 6e 67 20 66 6f 72 20 74  t encoding for t
1b060 68 65 20 64 61 74 61 62 61 73 65 20 77 69 6c 6c  he database will
1b070 20 62 65 20 55 54 46 2d 38 20 69 66 0a 2a 2a 20   be UTF-8 if.** 
1b080 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 20 6f  sqlite3_open() o
1b090 72 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76  r sqlite3_open_v
1b0a0 32 28 29 20 69 73 20 63 61 6c 6c 65 64 20 61 6e  2() is called an
1b0b0 64 0a 2a 2a 20 55 54 46 2d 31 36 20 69 6e 20 74  d.** UTF-16 in t
1b0c0 68 65 20 6e 61 74 69 76 65 20 62 79 74 65 20 6f  he native byte o
1b0d0 72 64 65 72 20 69 66 20 73 71 6c 69 74 65 33 5f  rder if sqlite3_
1b0e0 6f 70 65 6e 31 36 28 29 20 69 73 20 75 73 65 64  open16() is used
1b0f0 2e 0a 2a 2a 0a 2a 2a 20 57 68 65 74 68 65 72 20  ..**.** Whether 
1b100 6f 72 20 6e 6f 74 20 61 6e 20 65 72 72 6f 72 20  or not an error 
1b110 6f 63 63 75 72 73 20 77 68 65 6e 20 69 74 20 69  occurs when it i
1b120 73 20 6f 70 65 6e 65 64 2c 20 72 65 73 6f 75 72  s opened, resour
1b130 63 65 73 0a 2a 2a 20 61 73 73 6f 63 69 61 74 65  ces.** associate
1b140 64 20 77 69 74 68 20 74 68 65 20 5b 64 61 74 61  d with the [data
1b150 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d  base connection]
1b160 20 68 61 6e 64 6c 65 20 73 68 6f 75 6c 64 20 62   handle should b
1b170 65 20 72 65 6c 65 61 73 65 64 20 62 79 0a 2a 2a  e released by.**
1b180 20 70 61 73 73 69 6e 67 20 69 74 20 74 6f 20 5b   passing it to [
1b190 73 71 6c 69 74 65 33 5f 63 6c 6f 73 65 28 29 5d  sqlite3_close()]
1b1a0 20 77 68 65 6e 20 69 74 20 69 73 20 6e 6f 20 6c   when it is no l
1b1b0 6f 6e 67 65 72 20 72 65 71 75 69 72 65 64 2e 0a  onger required..
1b1c0 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69 74 65  **.** The sqlite
1b1d0 33 5f 6f 70 65 6e 5f 76 32 28 29 20 69 6e 74 65  3_open_v2() inte
1b1e0 72 66 61 63 65 20 77 6f 72 6b 73 20 6c 69 6b 65  rface works like
1b1f0 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 0a   sqlite3_open().
1b200 2a 2a 20 65 78 63 65 70 74 20 74 68 61 74 20 69  ** except that i
1b210 74 20 61 63 63 65 70 74 73 20 74 77 6f 20 61 64  t accepts two ad
1b220 64 69 74 69 6f 6e 61 6c 20 70 61 72 61 6d 65 74  ditional paramet
1b230 65 72 73 20 66 6f 72 20 61 64 64 69 74 69 6f 6e  ers for addition
1b240 61 6c 20 63 6f 6e 74 72 6f 6c 0a 2a 2a 20 6f 76  al control.** ov
1b250 65 72 20 74 68 65 20 6e 65 77 20 64 61 74 61 62  er the new datab
1b260 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 2e 20  ase connection. 
1b270 20 5e 28 54 68 65 20 66 6c 61 67 73 20 70 61 72   ^(The flags par
1b280 61 6d 65 74 65 72 20 74 6f 0a 2a 2a 20 73 71 6c  ameter to.** sql
1b290 69 74 65 33 5f 6f 70 65 6e 5f 76 32 28 29 20 63  ite3_open_v2() c
1b2a0 61 6e 20 74 61 6b 65 20 6f 6e 65 20 6f 66 0a 2a  an take one of.*
1b2b0 2a 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20  * the following 
1b2c0 74 68 72 65 65 20 76 61 6c 75 65 73 2c 20 6f 70  three values, op
1b2d0 74 69 6f 6e 61 6c 6c 79 20 63 6f 6d 62 69 6e 65  tionally combine
1b2e0 64 20 77 69 74 68 20 74 68 65 20 0a 2a 2a 20 5b  d with the .** [
1b2f0 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 4e 4f 4d 55  SQLITE_OPEN_NOMU
1b300 54 45 58 5d 2c 20 5b 53 51 4c 49 54 45 5f 4f 50  TEX], [SQLITE_OP
1b310 45 4e 5f 46 55 4c 4c 4d 55 54 45 58 5d 2c 20 5b  EN_FULLMUTEX], [
1b320 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 53 48 41 52  SQLITE_OPEN_SHAR
1b330 45 44 43 41 43 48 45 5d 2c 0a 2a 2a 20 61 6e 64  EDCACHE],.** and
1b340 2f 6f 72 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  /or [SQLITE_OPEN
1b350 5f 50 52 49 56 41 54 45 43 41 43 48 45 5d 20 66  _PRIVATECACHE] f
1b360 6c 61 67 73 3a 29 5e 0a 2a 2a 0a 2a 2a 20 3c 64  lags:)^.**.** <d
1b370 6c 3e 0a 2a 2a 20 5e 28 3c 64 74 3e 5b 53 51 4c  l>.** ^(<dt>[SQL
1b380 49 54 45 5f 4f 50 45 4e 5f 52 45 41 44 4f 4e 4c  ITE_OPEN_READONL
1b390 59 5d 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54  Y]</dt>.** <dd>T
1b3a0 68 65 20 64 61 74 61 62 61 73 65 20 69 73 20 6f  he database is o
1b3b0 70 65 6e 65 64 20 69 6e 20 72 65 61 64 2d 6f 6e  pened in read-on
1b3c0 6c 79 20 6d 6f 64 65 2e 20 20 49 66 20 74 68 65  ly mode.  If the
1b3d0 20 64 61 74 61 62 61 73 65 20 64 6f 65 73 20 6e   database does n
1b3e0 6f 74 0a 2a 2a 20 61 6c 72 65 61 64 79 20 65 78  ot.** already ex
1b3f0 69 73 74 2c 20 61 6e 20 65 72 72 6f 72 20 69 73  ist, an error is
1b400 20 72 65 74 75 72 6e 65 64 2e 3c 2f 64 64 3e 29   returned.</dd>)
1b410 5e 0a 2a 2a 0a 2a 2a 20 5e 28 3c 64 74 3e 5b 53  ^.**.** ^(<dt>[S
1b420 51 4c 49 54 45 5f 4f 50 45 4e 5f 52 45 41 44 57  QLITE_OPEN_READW
1b430 52 49 54 45 5d 3c 2f 64 74 3e 0a 2a 2a 20 3c 64  RITE]</dt>.** <d
1b440 64 3e 54 68 65 20 64 61 74 61 62 61 73 65 20 69  d>The database i
1b450 73 20 6f 70 65 6e 65 64 20 66 6f 72 20 72 65 61  s opened for rea
1b460 64 69 6e 67 20 61 6e 64 20 77 72 69 74 69 6e 67  ding and writing
1b470 20 69 66 20 70 6f 73 73 69 62 6c 65 2c 20 6f 72   if possible, or
1b480 20 72 65 61 64 69 6e 67 0a 2a 2a 20 6f 6e 6c 79   reading.** only
1b490 20 69 66 20 74 68 65 20 66 69 6c 65 20 69 73 20   if the file is 
1b4a0 77 72 69 74 65 20 70 72 6f 74 65 63 74 65 64 20  write protected 
1b4b0 62 79 20 74 68 65 20 6f 70 65 72 61 74 69 6e 67  by the operating
1b4c0 20 73 79 73 74 65 6d 2e 20 20 49 6e 20 65 69 74   system.  In eit
1b4d0 68 65 72 0a 2a 2a 20 63 61 73 65 20 74 68 65 20  her.** case the 
1b4e0 64 61 74 61 62 61 73 65 20 6d 75 73 74 20 61 6c  database must al
1b4f0 72 65 61 64 79 20 65 78 69 73 74 2c 20 6f 74 68  ready exist, oth
1b500 65 72 77 69 73 65 20 61 6e 20 65 72 72 6f 72 20  erwise an error 
1b510 69 73 20 72 65 74 75 72 6e 65 64 2e 3c 2f 64 64  is returned.</dd
1b520 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 28 3c 64 74 3e  >)^.**.** ^(<dt>
1b530 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 52 45 41  [SQLITE_OPEN_REA
1b540 44 57 52 49 54 45 5d 20 7c 20 5b 53 51 4c 49 54  DWRITE] | [SQLIT
1b550 45 5f 4f 50 45 4e 5f 43 52 45 41 54 45 5d 3c 2f  E_OPEN_CREATE]</
1b560 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 64  dt>.** <dd>The d
1b570 61 74 61 62 61 73 65 20 69 73 20 6f 70 65 6e 65  atabase is opene
1b580 64 20 66 6f 72 20 72 65 61 64 69 6e 67 20 61 6e  d for reading an
1b590 64 20 77 72 69 74 69 6e 67 2c 20 61 6e 64 20 69  d writing, and i
1b5a0 73 20 63 72 65 61 74 65 73 20 69 74 20 69 66 0a  s creates it if.
1b5b0 2a 2a 20 69 74 20 64 6f 65 73 20 6e 6f 74 20 61  ** it does not a
1b5c0 6c 72 65 61 64 79 20 65 78 69 73 74 2e 20 54 68  lready exist. Th
1b5d0 69 73 20 69 73 20 74 68 65 20 62 65 68 61 76 69  is is the behavi
1b5e0 6f 72 20 74 68 61 74 20 69 73 20 61 6c 77 61 79  or that is alway
1b5f0 73 20 75 73 65 64 20 66 6f 72 0a 2a 2a 20 73 71  s used for.** sq
1b600 6c 69 74 65 33 5f 6f 70 65 6e 28 29 20 61 6e 64  lite3_open() and
1b610 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31 36 28   sqlite3_open16(
1b620 29 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 20 3c 2f 64  ).</dd>)^.** </d
1b630 6c 3e 0a 2a 2a 0a 2a 2a 20 49 66 20 74 68 65 20  l>.**.** If the 
1b640 33 72 64 20 70 61 72 61 6d 65 74 65 72 20 74 6f  3rd parameter to
1b650 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32   sqlite3_open_v2
1b660 28 29 20 69 73 20 6e 6f 74 20 6f 6e 65 20 6f 66  () is not one of
1b670 20 74 68 65 0a 2a 2a 20 63 6f 6d 62 69 6e 61 74   the.** combinat
1b680 69 6f 6e 73 20 73 68 6f 77 6e 20 61 62 6f 76 65  ions shown above
1b690 20 6f 72 20 6f 6e 65 20 6f 66 20 74 68 65 20 63   or one of the c
1b6a0 6f 6d 62 69 6e 61 74 69 6f 6e 73 20 73 68 6f 77  ombinations show
1b6b0 6e 20 61 62 6f 76 65 20 63 6f 6d 62 69 6e 65 64  n above combined
1b6c0 0a 2a 2a 20 77 69 74 68 20 74 68 65 20 5b 53 51  .** with the [SQ
1b6d0 4c 49 54 45 5f 4f 50 45 4e 5f 4e 4f 4d 55 54 45  LITE_OPEN_NOMUTE
1b6e0 58 5d 2c 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  X], [SQLITE_OPEN
1b6f0 5f 46 55 4c 4c 4d 55 54 45 58 5d 2c 0a 2a 2a 20  _FULLMUTEX],.** 
1b700 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 53 48 41  [SQLITE_OPEN_SHA
1b710 52 45 44 43 41 43 48 45 5d 20 61 6e 64 2f 6f 72  REDCACHE] and/or
1b720 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 50 52   [SQLITE_OPEN_PR
1b730 49 56 41 54 45 43 41 43 48 45 5d 20 66 6c 61 67  IVATECACHE] flag
1b740 73 2c 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20 62  s,.** then the b
1b750 65 68 61 76 69 6f 72 20 69 73 20 75 6e 64 65 66  ehavior is undef
1b760 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20  ined..**.** ^If 
1b770 74 68 65 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e  the [SQLITE_OPEN
1b780 5f 4e 4f 4d 55 54 45 58 5d 20 66 6c 61 67 20 69  _NOMUTEX] flag i
1b790 73 20 73 65 74 2c 20 74 68 65 6e 20 74 68 65 20  s set, then the 
1b7a0 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
1b7b0 69 6f 6e 0a 2a 2a 20 6f 70 65 6e 73 20 69 6e 20  ion.** opens in 
1b7c0 74 68 65 20 6d 75 6c 74 69 2d 74 68 72 65 61 64  the multi-thread
1b7d0 20 5b 74 68 72 65 61 64 69 6e 67 20 6d 6f 64 65   [threading mode
1b7e0 5d 20 61 73 20 6c 6f 6e 67 20 61 73 20 74 68 65  ] as long as the
1b7f0 20 73 69 6e 67 6c 65 2d 74 68 72 65 61 64 0a 2a   single-thread.*
1b800 2a 20 6d 6f 64 65 20 68 61 73 20 6e 6f 74 20 62  * mode has not b
1b810 65 65 6e 20 73 65 74 20 61 74 20 63 6f 6d 70 69  een set at compi
1b820 6c 65 2d 74 69 6d 65 20 6f 72 20 73 74 61 72 74  le-time or start
1b830 2d 74 69 6d 65 2e 20 20 5e 49 66 20 74 68 65 0a  -time.  ^If the.
1b840 2a 2a 20 5b 53 51 4c 49 54 45 5f 4f 50 45 4e 5f  ** [SQLITE_OPEN_
1b850 46 55 4c 4c 4d 55 54 45 58 5d 20 66 6c 61 67 20  FULLMUTEX] flag 
1b860 69 73 20 73 65 74 20 74 68 65 6e 20 74 68 65 20  is set then the 
1b870 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
1b880 69 6f 6e 20 6f 70 65 6e 73 0a 2a 2a 20 69 6e 20  ion opens.** in 
1b890 74 68 65 20 73 65 72 69 61 6c 69 7a 65 64 20 5b  the serialized [
1b8a0 74 68 72 65 61 64 69 6e 67 20 6d 6f 64 65 5d 20  threading mode] 
1b8b0 75 6e 6c 65 73 73 20 73 69 6e 67 6c 65 2d 74 68  unless single-th
1b8c0 72 65 61 64 20 77 61 73 0a 2a 2a 20 70 72 65 76  read was.** prev
1b8d0 69 6f 75 73 6c 79 20 73 65 6c 65 63 74 65 64 20  iously selected 
1b8e0 61 74 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20  at compile-time 
1b8f0 6f 72 20 73 74 61 72 74 2d 74 69 6d 65 2e 0a 2a  or start-time..*
1b900 2a 20 5e 54 68 65 20 5b 53 51 4c 49 54 45 5f 4f  * ^The [SQLITE_O
1b910 50 45 4e 5f 53 48 41 52 45 44 43 41 43 48 45 5d  PEN_SHAREDCACHE]
1b920 20 66 6c 61 67 20 63 61 75 73 65 73 20 74 68 65   flag causes the
1b930 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63   database connec
1b940 74 69 6f 6e 20 74 6f 20 62 65 0a 2a 2a 20 65 6c  tion to be.** el
1b950 69 67 69 62 6c 65 20 74 6f 20 75 73 65 20 5b 73  igible to use [s
1b960 68 61 72 65 64 20 63 61 63 68 65 20 6d 6f 64 65  hared cache mode
1b970 5d 2c 20 72 65 67 61 72 64 6c 65 73 73 20 6f 66  ], regardless of
1b980 20 77 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20   whether or not 
1b990 73 68 61 72 65 64 0a 2a 2a 20 63 61 63 68 65 20  shared.** cache 
1b9a0 69 73 20 65 6e 61 62 6c 65 64 20 75 73 69 6e 67  is enabled using
1b9b0 20 5b 73 71 6c 69 74 65 33 5f 65 6e 61 62 6c 65   [sqlite3_enable
1b9c0 5f 73 68 61 72 65 64 5f 63 61 63 68 65 28 29 5d  _shared_cache()]
1b9d0 2e 20 20 5e 54 68 65 0a 2a 2a 20 5b 53 51 4c 49  .  ^The.** [SQLI
1b9e0 54 45 5f 4f 50 45 4e 5f 50 52 49 56 41 54 45 43  TE_OPEN_PRIVATEC
1b9f0 41 43 48 45 5d 20 66 6c 61 67 20 63 61 75 73 65  ACHE] flag cause
1ba00 73 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63  s the database c
1ba10 6f 6e 6e 65 63 74 69 6f 6e 20 74 6f 20 6e 6f 74  onnection to not
1ba20 0a 2a 2a 20 70 61 72 74 69 63 69 70 61 74 65 20  .** participate 
1ba30 69 6e 20 5b 73 68 61 72 65 64 20 63 61 63 68 65  in [shared cache
1ba40 20 6d 6f 64 65 5d 20 65 76 65 6e 20 69 66 20 69   mode] even if i
1ba50 74 20 69 73 20 65 6e 61 62 6c 65 64 2e 0a 2a 2a  t is enabled..**
1ba60 0a 2a 2a 20 5e 49 66 20 74 68 65 20 66 69 6c 65  .** ^If the file
1ba70 6e 61 6d 65 20 69 73 20 22 3a 6d 65 6d 6f 72 79  name is ":memory
1ba80 3a 22 2c 20 74 68 65 6e 20 61 20 70 72 69 76 61  :", then a priva
1ba90 74 65 2c 20 74 65 6d 70 6f 72 61 72 79 20 69 6e  te, temporary in
1baa0 2d 6d 65 6d 6f 72 79 20 64 61 74 61 62 61 73 65  -memory database
1bab0 0a 2a 2a 20 69 73 20 63 72 65 61 74 65 64 20 66  .** is created f
1bac0 6f 72 20 74 68 65 20 63 6f 6e 6e 65 63 74 69 6f  or the connectio
1bad0 6e 2e 20 20 5e 54 68 69 73 20 69 6e 2d 6d 65 6d  n.  ^This in-mem
1bae0 6f 72 79 20 64 61 74 61 62 61 73 65 20 77 69 6c  ory database wil
1baf0 6c 20 76 61 6e 69 73 68 20 77 68 65 6e 0a 2a 2a  l vanish when.**
1bb00 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63 6f   the database co
1bb10 6e 6e 65 63 74 69 6f 6e 20 69 73 20 63 6c 6f 73  nnection is clos
1bb20 65 64 2e 20 20 46 75 74 75 72 65 20 76 65 72 73  ed.  Future vers
1bb30 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74 65 20 6d  ions of SQLite m
1bb40 69 67 68 74 0a 2a 2a 20 6d 61 6b 65 20 75 73 65  ight.** make use
1bb50 20 6f 66 20 61 64 64 69 74 69 6f 6e 61 6c 20 73   of additional s
1bb60 70 65 63 69 61 6c 20 66 69 6c 65 6e 61 6d 65 73  pecial filenames
1bb70 20 74 68 61 74 20 62 65 67 69 6e 20 77 69 74 68   that begin with
1bb80 20 74 68 65 20 22 3a 22 20 63 68 61 72 61 63 74   the ":" charact
1bb90 65 72 2e 0a 2a 2a 20 49 74 20 69 73 20 72 65 63  er..** It is rec
1bba0 6f 6d 6d 65 6e 64 65 64 20 74 68 61 74 20 77 68  ommended that wh
1bbb0 65 6e 20 61 20 64 61 74 61 62 61 73 65 20 66 69  en a database fi
1bbc0 6c 65 6e 61 6d 65 20 61 63 74 75 61 6c 6c 79 20  lename actually 
1bbd0 64 6f 65 73 20 62 65 67 69 6e 20 77 69 74 68 0a  does begin with.
1bbe0 2a 2a 20 61 20 22 3a 22 20 63 68 61 72 61 63 74  ** a ":" charact
1bbf0 65 72 20 79 6f 75 20 73 68 6f 75 6c 64 20 70 72  er you should pr
1bc00 65 66 69 78 20 74 68 65 20 66 69 6c 65 6e 61 6d  efix the filenam
1bc10 65 20 77 69 74 68 20 61 20 70 61 74 68 6e 61 6d  e with a pathnam
1bc20 65 20 73 75 63 68 20 61 73 0a 2a 2a 20 22 2e 2f  e such as.** "./
1bc30 22 20 74 6f 20 61 76 6f 69 64 20 61 6d 62 69 67  " to avoid ambig
1bc40 75 69 74 79 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20  uity..**.** ^If 
1bc50 74 68 65 20 66 69 6c 65 6e 61 6d 65 20 69 73 20  the filename is 
1bc60 61 6e 20 65 6d 70 74 79 20 73 74 72 69 6e 67 2c  an empty string,
1bc70 20 74 68 65 6e 20 61 20 70 72 69 76 61 74 65 2c   then a private,
1bc80 20 74 65 6d 70 6f 72 61 72 79 0a 2a 2a 20 6f 6e   temporary.** on
1bc90 2d 64 69 73 6b 20 64 61 74 61 62 61 73 65 20 77  -disk database w
1bca0 69 6c 6c 20 62 65 20 63 72 65 61 74 65 64 2e 20  ill be created. 
1bcb0 20 5e 54 68 69 73 20 70 72 69 76 61 74 65 20 64   ^This private d
1bcc0 61 74 61 62 61 73 65 20 77 69 6c 6c 20 62 65 0a  atabase will be.
1bcd0 2a 2a 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79  ** automatically
1bce0 20 64 65 6c 65 74 65 64 20 61 73 20 73 6f 6f 6e   deleted as soon
1bcf0 20 61 73 20 74 68 65 20 64 61 74 61 62 61 73 65   as the database
1bd00 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 63   connection is c
1bd10 6c 6f 73 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  losed..**.** ^Th
1bd20 65 20 66 6f 75 72 74 68 20 70 61 72 61 6d 65 74  e fourth paramet
1bd30 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 6f 70  er to sqlite3_op
1bd40 65 6e 5f 76 32 28 29 20 69 73 20 74 68 65 20 6e  en_v2() is the n
1bd50 61 6d 65 20 6f 66 20 74 68 65 0a 2a 2a 20 5b 73  ame of the.** [s
1bd60 71 6c 69 74 65 33 5f 76 66 73 5d 20 6f 62 6a 65  qlite3_vfs] obje
1bd70 63 74 20 74 68 61 74 20 64 65 66 69 6e 65 73 20  ct that defines 
1bd80 74 68 65 20 6f 70 65 72 61 74 69 6e 67 20 73 79  the operating sy
1bd90 73 74 65 6d 20 69 6e 74 65 72 66 61 63 65 20 74  stem interface t
1bda0 68 61 74 0a 2a 2a 20 74 68 65 20 6e 65 77 20 64  hat.** the new d
1bdb0 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
1bdc0 6f 6e 20 73 68 6f 75 6c 64 20 75 73 65 2e 20 20  on should use.  
1bdd0 5e 49 66 20 74 68 65 20 66 6f 75 72 74 68 20 70  ^If the fourth p
1bde0 61 72 61 6d 65 74 65 72 20 69 73 0a 2a 2a 20 61  arameter is.** a
1bdf0 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 74 68   NULL pointer th
1be00 65 6e 20 74 68 65 20 64 65 66 61 75 6c 74 20 5b  en the default [
1be10 73 71 6c 69 74 65 33 5f 76 66 73 5d 20 6f 62 6a  sqlite3_vfs] obj
1be20 65 63 74 20 69 73 20 75 73 65 64 2e 0a 2a 2a 0a  ect is used..**.
1be30 2a 2a 20 3c 62 3e 4e 6f 74 65 20 74 6f 20 57 69  ** <b>Note to Wi
1be40 6e 64 6f 77 73 20 75 73 65 72 73 3a 3c 2f 62 3e  ndows users:</b>
1be50 20 20 54 68 65 20 65 6e 63 6f 64 69 6e 67 20 75    The encoding u
1be60 73 65 64 20 66 6f 72 20 74 68 65 20 66 69 6c 65  sed for the file
1be70 6e 61 6d 65 20 61 72 67 75 6d 65 6e 74 0a 2a 2a  name argument.**
1be80 20 6f 66 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e   of sqlite3_open
1be90 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 6f  () and sqlite3_o
1bea0 70 65 6e 5f 76 32 28 29 20 6d 75 73 74 20 62 65  pen_v2() must be
1beb0 20 55 54 46 2d 38 2c 20 6e 6f 74 20 77 68 61 74   UTF-8, not what
1bec0 65 76 65 72 0a 2a 2a 20 63 6f 64 65 70 61 67 65  ever.** codepage
1bed0 20 69 73 20 63 75 72 72 65 6e 74 6c 79 20 64 65   is currently de
1bee0 66 69 6e 65 64 2e 20 20 46 69 6c 65 6e 61 6d 65  fined.  Filename
1bef0 73 20 63 6f 6e 74 61 69 6e 69 6e 67 20 69 6e 74  s containing int
1bf00 65 72 6e 61 74 69 6f 6e 61 6c 0a 2a 2a 20 63 68  ernational.** ch
1bf10 61 72 61 63 74 65 72 73 20 6d 75 73 74 20 62 65  aracters must be
1bf20 20 63 6f 6e 76 65 72 74 65 64 20 74 6f 20 55 54   converted to UT
1bf30 46 2d 38 20 70 72 69 6f 72 20 74 6f 20 70 61 73  F-8 prior to pas
1bf40 73 69 6e 67 20 74 68 65 6d 20 69 6e 74 6f 0a 2a  sing them into.*
1bf50 2a 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29  * sqlite3_open()
1bf60 20 6f 72 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e   or sqlite3_open
1bf70 5f 76 32 28 29 2e 0a 2a 2f 0a 69 6e 74 20 73 71  _v2()..*/.int sq
1bf80 6c 69 74 65 33 5f 6f 70 65 6e 28 0a 20 20 63 6f  lite3_open(.  co
1bf90 6e 73 74 20 63 68 61 72 20 2a 66 69 6c 65 6e 61  nst char *filena
1bfa0 6d 65 2c 20 20 20 2f 2a 20 44 61 74 61 62 61 73  me,   /* Databas
1bfb0 65 20 66 69 6c 65 6e 61 6d 65 20 28 55 54 46 2d  e filename (UTF-
1bfc0 38 29 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33 20  8) */.  sqlite3 
1bfd0 2a 2a 70 70 44 62 20 20 20 20 20 20 20 20 20 20  **ppDb          
1bfe0 2f 2a 20 4f 55 54 3a 20 53 51 4c 69 74 65 20 64  /* OUT: SQLite d
1bff0 62 20 68 61 6e 64 6c 65 20 2a 2f 0a 29 3b 0a 69  b handle */.);.i
1c000 6e 74 20 73 71 6c 69 74 65 33 5f 6f 70 65 6e 31  nt sqlite3_open1
1c010 36 28 0a 20 20 63 6f 6e 73 74 20 76 6f 69 64 20  6(.  const void 
1c020 2a 66 69 6c 65 6e 61 6d 65 2c 20 20 20 2f 2a 20  *filename,   /* 
1c030 44 61 74 61 62 61 73 65 20 66 69 6c 65 6e 61 6d  Database filenam
1c040 65 20 28 55 54 46 2d 31 36 29 20 2a 2f 0a 20 20  e (UTF-16) */.  
1c050 73 71 6c 69 74 65 33 20 2a 2a 70 70 44 62 20 20  sqlite3 **ppDb  
1c060 20 20 20 20 20 20 20 20 2f 2a 20 4f 55 54 3a 20          /* OUT: 
1c070 53 51 4c 69 74 65 20 64 62 20 68 61 6e 64 6c 65  SQLite db handle
1c080 20 2a 2f 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74   */.);.int sqlit
1c090 65 33 5f 6f 70 65 6e 5f 76 32 28 0a 20 20 63 6f  e3_open_v2(.  co
1c0a0 6e 73 74 20 63 68 61 72 20 2a 66 69 6c 65 6e 61  nst char *filena
1c0b0 6d 65 2c 20 20 20 2f 2a 20 44 61 74 61 62 61 73  me,   /* Databas
1c0c0 65 20 66 69 6c 65 6e 61 6d 65 20 28 55 54 46 2d  e filename (UTF-
1c0d0 38 29 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33 20  8) */.  sqlite3 
1c0e0 2a 2a 70 70 44 62 2c 20 20 20 20 20 20 20 20 20  **ppDb,         
1c0f0 2f 2a 20 4f 55 54 3a 20 53 51 4c 69 74 65 20 64  /* OUT: SQLite d
1c100 62 20 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 69 6e  b handle */.  in
1c110 74 20 66 6c 61 67 73 2c 20 20 20 20 20 20 20 20  t flags,        
1c120 20 20 20 20 20 20 2f 2a 20 46 6c 61 67 73 20 2a        /* Flags *
1c130 2f 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a  /.  const char *
1c140 7a 56 66 73 20 20 20 20 20 20 20 20 2f 2a 20 4e  zVfs        /* N
1c150 61 6d 65 20 6f 66 20 56 46 53 20 6d 6f 64 75 6c  ame of VFS modul
1c160 65 20 74 6f 20 75 73 65 20 2a 2f 0a 29 3b 0a 0a  e to use */.);..
1c170 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
1c180 45 72 72 6f 72 20 43 6f 64 65 73 20 41 6e 64 20  Error Codes And 
1c190 4d 65 73 73 61 67 65 73 0a 2a 2a 0a 2a 2a 20 5e  Messages.**.** ^
1c1a0 54 68 65 20 73 71 6c 69 74 65 33 5f 65 72 72 63  The sqlite3_errc
1c1b0 6f 64 65 28 29 20 69 6e 74 65 72 66 61 63 65 20  ode() interface 
1c1c0 72 65 74 75 72 6e 73 20 74 68 65 20 6e 75 6d 65  returns the nume
1c1d0 72 69 63 20 5b 72 65 73 75 6c 74 20 63 6f 64 65  ric [result code
1c1e0 5d 20 6f 72 0a 2a 2a 20 5b 65 78 74 65 6e 64 65  ] or.** [extende
1c1f0 64 20 72 65 73 75 6c 74 20 63 6f 64 65 5d 20 66  d result code] f
1c200 6f 72 20 74 68 65 20 6d 6f 73 74 20 72 65 63 65  or the most rece
1c210 6e 74 20 66 61 69 6c 65 64 20 73 71 6c 69 74 65  nt failed sqlite
1c220 33 5f 2a 20 41 50 49 20 63 61 6c 6c 0a 2a 2a 20  3_* API call.** 
1c230 61 73 73 6f 63 69 61 74 65 64 20 77 69 74 68 20  associated with 
1c240 61 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  a [database conn
1c250 65 63 74 69 6f 6e 5d 2e 20 49 66 20 61 20 70 72  ection]. If a pr
1c260 69 6f 72 20 41 50 49 20 63 61 6c 6c 20 66 61 69  ior API call fai
1c270 6c 65 64 0a 2a 2a 20 62 75 74 20 74 68 65 20 6d  led.** but the m
1c280 6f 73 74 20 72 65 63 65 6e 74 20 41 50 49 20 63  ost recent API c
1c290 61 6c 6c 20 73 75 63 63 65 65 64 65 64 2c 20 74  all succeeded, t
1c2a0 68 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 20  he return value 
1c2b0 66 72 6f 6d 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  from.** sqlite3_
1c2c0 65 72 72 63 6f 64 65 28 29 20 69 73 20 75 6e 64  errcode() is und
1c2d0 65 66 69 6e 65 64 2e 20 20 5e 54 68 65 20 73 71  efined.  ^The sq
1c2e0 6c 69 74 65 33 5f 65 78 74 65 6e 64 65 64 5f 65  lite3_extended_e
1c2f0 72 72 63 6f 64 65 28 29 0a 2a 2a 20 69 6e 74 65  rrcode().** inte
1c300 72 66 61 63 65 20 69 73 20 74 68 65 20 73 61 6d  rface is the sam
1c310 65 20 65 78 63 65 70 74 20 74 68 61 74 20 69 74  e except that it
1c320 20 61 6c 77 61 79 73 20 72 65 74 75 72 6e 73 20   always returns 
1c330 74 68 65 20 0a 2a 2a 20 5b 65 78 74 65 6e 64 65  the .** [extende
1c340 64 20 72 65 73 75 6c 74 20 63 6f 64 65 5d 20 65  d result code] e
1c350 76 65 6e 20 77 68 65 6e 20 65 78 74 65 6e 64 65  ven when extende
1c360 64 20 72 65 73 75 6c 74 20 63 6f 64 65 73 20 61  d result codes a
1c370 72 65 0a 2a 2a 20 64 69 73 61 62 6c 65 64 2e 0a  re.** disabled..
1c380 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  **.** ^The sqlit
1c390 65 33 5f 65 72 72 6d 73 67 28 29 20 61 6e 64 20  e3_errmsg() and 
1c3a0 73 71 6c 69 74 65 33 5f 65 72 72 6d 73 67 31 36  sqlite3_errmsg16
1c3b0 28 29 20 72 65 74 75 72 6e 20 45 6e 67 6c 69 73  () return Englis
1c3c0 68 2d 6c 61 6e 67 75 61 67 65 0a 2a 2a 20 74 65  h-language.** te
1c3d0 78 74 20 74 68 61 74 20 64 65 73 63 72 69 62 65  xt that describe
1c3e0 73 20 74 68 65 20 65 72 72 6f 72 2c 20 61 73 20  s the error, as 
1c3f0 65 69 74 68 65 72 20 55 54 46 2d 38 20 6f 72 20  either UTF-8 or 
1c400 55 54 46 2d 31 36 20 72 65 73 70 65 63 74 69 76  UTF-16 respectiv
1c410 65 6c 79 2e 0a 2a 2a 20 5e 28 4d 65 6d 6f 72 79  ely..** ^(Memory
1c420 20 74 6f 20 68 6f 6c 64 20 74 68 65 20 65 72 72   to hold the err
1c430 6f 72 20 6d 65 73 73 61 67 65 20 73 74 72 69 6e  or message strin
1c440 67 20 69 73 20 6d 61 6e 61 67 65 64 20 69 6e 74  g is managed int
1c450 65 72 6e 61 6c 6c 79 2e 0a 2a 2a 20 54 68 65 20  ernally..** The 
1c460 61 70 70 6c 69 63 61 74 69 6f 6e 20 64 6f 65 73  application does
1c470 20 6e 6f 74 20 6e 65 65 64 20 74 6f 20 77 6f 72   not need to wor
1c480 72 79 20 61 62 6f 75 74 20 66 72 65 65 69 6e 67  ry about freeing
1c490 20 74 68 65 20 72 65 73 75 6c 74 2e 0a 2a 2a 20   the result..** 
1c4a0 48 6f 77 65 76 65 72 2c 20 74 68 65 20 65 72 72  However, the err
1c4b0 6f 72 20 73 74 72 69 6e 67 20 6d 69 67 68 74 20  or string might 
1c4c0 62 65 20 6f 76 65 72 77 72 69 74 74 65 6e 20 6f  be overwritten o
1c4d0 72 20 64 65 61 6c 6c 6f 63 61 74 65 64 20 62 79  r deallocated by
1c4e0 0a 2a 2a 20 73 75 62 73 65 71 75 65 6e 74 20 63  .** subsequent c
1c4f0 61 6c 6c 73 20 74 6f 20 6f 74 68 65 72 20 53 51  alls to other SQ
1c500 4c 69 74 65 20 69 6e 74 65 72 66 61 63 65 20 66  Lite interface f
1c510 75 6e 63 74 69 6f 6e 73 2e 29 5e 0a 2a 2a 0a 2a  unctions.)^.**.*
1c520 2a 20 57 68 65 6e 20 74 68 65 20 73 65 72 69 61  * When the seria
1c530 6c 69 7a 65 64 20 5b 74 68 72 65 61 64 69 6e 67  lized [threading
1c540 20 6d 6f 64 65 5d 20 69 73 20 69 6e 20 75 73 65   mode] is in use
1c550 2c 20 69 74 20 6d 69 67 68 74 20 62 65 20 74 68  , it might be th
1c560 65 0a 2a 2a 20 63 61 73 65 20 74 68 61 74 20 61  e.** case that a
1c570 20 73 65 63 6f 6e 64 20 65 72 72 6f 72 20 6f 63   second error oc
1c580 63 75 72 73 20 6f 6e 20 61 20 73 65 70 61 72 61  curs on a separa
1c590 74 65 20 74 68 72 65 61 64 20 69 6e 20 62 65 74  te thread in bet
1c5a0 77 65 65 6e 0a 2a 2a 20 74 68 65 20 74 69 6d 65  ween.** the time
1c5b0 20 6f 66 20 74 68 65 20 66 69 72 73 74 20 65 72   of the first er
1c5c0 72 6f 72 20 61 6e 64 20 74 68 65 20 63 61 6c 6c  ror and the call
1c5d0 20 74 6f 20 74 68 65 73 65 20 69 6e 74 65 72 66   to these interf
1c5e0 61 63 65 73 2e 0a 2a 2a 20 57 68 65 6e 20 74 68  aces..** When th
1c5f0 61 74 20 68 61 70 70 65 6e 73 2c 20 74 68 65 20  at happens, the 
1c600 73 65 63 6f 6e 64 20 65 72 72 6f 72 20 77 69 6c  second error wil
1c610 6c 20 62 65 20 72 65 70 6f 72 74 65 64 20 73 69  l be reported si
1c620 6e 63 65 20 74 68 65 73 65 0a 2a 2a 20 69 6e 74  nce these.** int
1c630 65 72 66 61 63 65 73 20 61 6c 77 61 79 73 20 72  erfaces always r
1c640 65 70 6f 72 74 20 74 68 65 20 6d 6f 73 74 20 72  eport the most r
1c650 65 63 65 6e 74 20 72 65 73 75 6c 74 2e 20 20 54  ecent result.  T
1c660 6f 20 61 76 6f 69 64 0a 2a 2a 20 74 68 69 73 2c  o avoid.** this,
1c670 20 65 61 63 68 20 74 68 72 65 61 64 20 63 61 6e   each thread can
1c680 20 6f 62 74 61 69 6e 20 65 78 63 6c 75 73 69 76   obtain exclusiv
1c690 65 20 75 73 65 20 6f 66 20 74 68 65 20 5b 64 61  e use of the [da
1c6a0 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
1c6b0 6e 5d 20 44 0a 2a 2a 20 62 79 20 69 6e 76 6f 6b  n] D.** by invok
1c6c0 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 6d 75 74  ing [sqlite3_mut
1c6d0 65 78 5f 65 6e 74 65 72 5d 28 5b 73 71 6c 69 74  ex_enter]([sqlit
1c6e0 65 33 5f 64 62 5f 6d 75 74 65 78 5d 28 44 29 29  e3_db_mutex](D))
1c6f0 20 62 65 66 6f 72 65 20 62 65 67 69 6e 6e 69 6e   before beginnin
1c700 67 0a 2a 2a 20 74 6f 20 75 73 65 20 44 20 61 6e  g.** to use D an
1c710 64 20 69 6e 76 6f 6b 69 6e 67 20 5b 73 71 6c 69  d invoking [sqli
1c720 74 65 33 5f 6d 75 74 65 78 5f 6c 65 61 76 65 5d  te3_mutex_leave]
1c730 28 5b 73 71 6c 69 74 65 33 5f 64 62 5f 6d 75 74  ([sqlite3_db_mut
1c740 65 78 5d 28 44 29 29 20 61 66 74 65 72 0a 2a 2a  ex](D)) after.**
1c750 20 61 6c 6c 20 63 61 6c 6c 73 20 74 6f 20 74 68   all calls to th
1c760 65 20 69 6e 74 65 72 66 61 63 65 73 20 6c 69 73  e interfaces lis
1c770 74 65 64 20 68 65 72 65 20 61 72 65 20 63 6f 6d  ted here are com
1c780 70 6c 65 74 65 64 2e 0a 2a 2a 0a 2a 2a 20 49 66  pleted..**.** If
1c790 20 61 6e 20 69 6e 74 65 72 66 61 63 65 20 66 61   an interface fa
1c7a0 69 6c 73 20 77 69 74 68 20 53 51 4c 49 54 45 5f  ils with SQLITE_
1c7b0 4d 49 53 55 53 45 2c 20 74 68 61 74 20 6d 65 61  MISUSE, that mea
1c7c0 6e 73 20 74 68 65 20 69 6e 74 65 72 66 61 63 65  ns the interface
1c7d0 0a 2a 2a 20 77 61 73 20 69 6e 76 6f 6b 65 64 20  .** was invoked 
1c7e0 69 6e 63 6f 72 72 65 63 74 6c 79 20 62 79 20 74  incorrectly by t
1c7f0 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 2e 20  he application. 
1c800 20 49 6e 20 74 68 61 74 20 63 61 73 65 2c 20 74   In that case, t
1c810 68 65 0a 2a 2a 20 65 72 72 6f 72 20 63 6f 64 65  he.** error code
1c820 20 61 6e 64 20 6d 65 73 73 61 67 65 20 6d 61 79   and message may
1c830 20 6f 72 20 6d 61 79 20 6e 6f 74 20 62 65 20 73   or may not be s
1c840 65 74 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  et..*/.int sqlit
1c850 65 33 5f 65 72 72 63 6f 64 65 28 73 71 6c 69 74  e3_errcode(sqlit
1c860 65 33 20 2a 64 62 29 3b 0a 69 6e 74 20 73 71 6c  e3 *db);.int sql
1c870 69 74 65 33 5f 65 78 74 65 6e 64 65 64 5f 65 72  ite3_extended_er
1c880 72 63 6f 64 65 28 73 71 6c 69 74 65 33 20 2a 64  rcode(sqlite3 *d
1c890 62 29 3b 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a  b);.const char *
1c8a0 73 71 6c 69 74 65 33 5f 65 72 72 6d 73 67 28 73  sqlite3_errmsg(s
1c8b0 71 6c 69 74 65 33 2a 29 3b 0a 63 6f 6e 73 74 20  qlite3*);.const 
1c8c0 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 65 72  void *sqlite3_er
1c8d0 72 6d 73 67 31 36 28 73 71 6c 69 74 65 33 2a 29  rmsg16(sqlite3*)
1c8e0 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
1c8f0 46 3a 20 53 51 4c 20 53 74 61 74 65 6d 65 6e 74  F: SQL Statement
1c900 20 4f 62 6a 65 63 74 0a 2a 2a 20 4b 45 59 57 4f   Object.** KEYWO
1c910 52 44 53 3a 20 7b 70 72 65 70 61 72 65 64 20 73  RDS: {prepared s
1c920 74 61 74 65 6d 65 6e 74 7d 20 7b 70 72 65 70 61  tatement} {prepa
1c930 72 65 64 20 73 74 61 74 65 6d 65 6e 74 73 7d 0a  red statements}.
1c940 2a 2a 0a 2a 2a 20 41 6e 20 69 6e 73 74 61 6e 63  **.** An instanc
1c950 65 20 6f 66 20 74 68 69 73 20 6f 62 6a 65 63 74  e of this object
1c960 20 72 65 70 72 65 73 65 6e 74 73 20 61 20 73 69   represents a si
1c970 6e 67 6c 65 20 53 51 4c 20 73 74 61 74 65 6d 65  ngle SQL stateme
1c980 6e 74 2e 0a 2a 2a 20 54 68 69 73 20 6f 62 6a 65  nt..** This obje
1c990 63 74 20 69 73 20 76 61 72 69 6f 75 73 6c 79 20  ct is variously 
1c9a0 6b 6e 6f 77 6e 20 61 73 20 61 20 22 70 72 65 70  known as a "prep
1c9b0 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 22 20  ared statement" 
1c9c0 6f 72 20 61 0a 2a 2a 20 22 63 6f 6d 70 69 6c 65  or a.** "compile
1c9d0 64 20 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 22  d SQL statement"
1c9e0 20 6f 72 20 73 69 6d 70 6c 79 20 61 73 20 61 20   or simply as a 
1c9f0 22 73 74 61 74 65 6d 65 6e 74 22 2e 0a 2a 2a 0a  "statement"..**.
1ca00 2a 2a 20 54 68 65 20 6c 69 66 65 20 6f 66 20 61  ** The life of a
1ca10 20 73 74 61 74 65 6d 65 6e 74 20 6f 62 6a 65 63   statement objec
1ca20 74 20 67 6f 65 73 20 73 6f 6d 65 74 68 69 6e 67  t goes something
1ca30 20 6c 69 6b 65 20 74 68 69 73 3a 0a 2a 2a 0a 2a   like this:.**.*
1ca40 2a 20 3c 6f 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20 43  * <ol>.** <li> C
1ca50 72 65 61 74 65 20 74 68 65 20 6f 62 6a 65 63 74  reate the object
1ca60 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f   using [sqlite3_
1ca70 70 72 65 70 61 72 65 5f 76 32 28 29 5d 20 6f 72  prepare_v2()] or
1ca80 20 61 20 72 65 6c 61 74 65 64 0a 2a 2a 20 20 20   a related.**   
1ca90 20 20 20 66 75 6e 63 74 69 6f 6e 2e 0a 2a 2a 20     function..** 
1caa0 3c 6c 69 3e 20 42 69 6e 64 20 76 61 6c 75 65 73  <li> Bind values
1cab0 20 74 6f 20 5b 68 6f 73 74 20 70 61 72 61 6d 65   to [host parame
1cac0 74 65 72 73 5d 20 75 73 69 6e 67 20 74 68 65 20  ters] using the 
1cad0 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 2a 28 29  sqlite3_bind_*()
1cae0 0a 2a 2a 20 20 20 20 20 20 69 6e 74 65 72 66 61  .**      interfa
1caf0 63 65 73 2e 0a 2a 2a 20 3c 6c 69 3e 20 52 75 6e  ces..** <li> Run
1cb00 20 74 68 65 20 53 51 4c 20 62 79 20 63 61 6c 6c   the SQL by call
1cb10 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 73 74 65  ing [sqlite3_ste
1cb20 70 28 29 5d 20 6f 6e 65 20 6f 72 20 6d 6f 72 65  p()] one or more
1cb30 20 74 69 6d 65 73 2e 0a 2a 2a 20 3c 6c 69 3e 20   times..** <li> 
1cb40 52 65 73 65 74 20 74 68 65 20 73 74 61 74 65 6d  Reset the statem
1cb50 65 6e 74 20 75 73 69 6e 67 20 5b 73 71 6c 69 74  ent using [sqlit
1cb60 65 33 5f 72 65 73 65 74 28 29 5d 20 74 68 65 6e  e3_reset()] then
1cb70 20 67 6f 20 62 61 63 6b 0a 2a 2a 20 20 20 20 20   go back.**     
1cb80 20 74 6f 20 73 74 65 70 20 32 2e 20 20 44 6f 20   to step 2.  Do 
1cb90 74 68 69 73 20 7a 65 72 6f 20 6f 72 20 6d 6f 72  this zero or mor
1cba0 65 20 74 69 6d 65 73 2e 0a 2a 2a 20 3c 6c 69 3e  e times..** <li>
1cbb0 20 44 65 73 74 72 6f 79 20 74 68 65 20 6f 62 6a   Destroy the obj
1cbc0 65 63 74 20 75 73 69 6e 67 20 5b 73 71 6c 69 74  ect using [sqlit
1cbd0 65 33 5f 66 69 6e 61 6c 69 7a 65 28 29 5d 2e 0a  e3_finalize()]..
1cbe0 2a 2a 20 3c 2f 6f 6c 3e 0a 2a 2a 0a 2a 2a 20 52  ** </ol>.**.** R
1cbf0 65 66 65 72 20 74 6f 20 64 6f 63 75 6d 65 6e 74  efer to document
1cc00 61 74 69 6f 6e 20 6f 6e 20 69 6e 64 69 76 69 64  ation on individ
1cc10 75 61 6c 20 6d 65 74 68 6f 64 73 20 61 62 6f 76  ual methods abov
1cc20 65 20 66 6f 72 20 61 64 64 69 74 69 6f 6e 61 6c  e for additional
1cc30 0a 2a 2a 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e  .** information.
1cc40 0a 2a 2f 0a 74 79 70 65 64 65 66 20 73 74 72 75  .*/.typedef stru
1cc50 63 74 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 20  ct sqlite3_stmt 
1cc60 73 71 6c 69 74 65 33 5f 73 74 6d 74 3b 0a 0a 2f  sqlite3_stmt;../
1cc70 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 52  *.** CAPI3REF: R
1cc80 75 6e 2d 74 69 6d 65 20 4c 69 6d 69 74 73 0a 2a  un-time Limits.*
1cc90 2a 0a 2a 2a 20 5e 28 54 68 69 73 20 69 6e 74 65  *.** ^(This inte
1cca0 72 66 61 63 65 20 61 6c 6c 6f 77 73 20 74 68 65  rface allows the
1ccb0 20 73 69 7a 65 20 6f 66 20 76 61 72 69 6f 75 73   size of various
1ccc0 20 63 6f 6e 73 74 72 75 63 74 73 20 74 6f 20 62   constructs to b
1ccd0 65 20 6c 69 6d 69 74 65 64 0a 2a 2a 20 6f 6e 20  e limited.** on 
1cce0 61 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 62 79 20  a connection by 
1ccf0 63 6f 6e 6e 65 63 74 69 6f 6e 20 62 61 73 69 73  connection basis
1cd00 2e 20 20 54 68 65 20 66 69 72 73 74 20 70 61 72  .  The first par
1cd10 61 6d 65 74 65 72 20 69 73 20 74 68 65 0a 2a 2a  ameter is the.**
1cd20 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65   [database conne
1cd30 63 74 69 6f 6e 5d 20 77 68 6f 73 65 20 6c 69 6d  ction] whose lim
1cd40 69 74 20 69 73 20 74 6f 20 62 65 20 73 65 74 20  it is to be set 
1cd50 6f 72 20 71 75 65 72 69 65 64 2e 20 20 54 68 65  or queried.  The
1cd60 0a 2a 2a 20 73 65 63 6f 6e 64 20 70 61 72 61 6d  .** second param
1cd70 65 74 65 72 20 69 73 20 6f 6e 65 20 6f 66 20 74  eter is one of t
1cd80 68 65 20 5b 6c 69 6d 69 74 20 63 61 74 65 67 6f  he [limit catego
1cd90 72 69 65 73 5d 20 74 68 61 74 20 64 65 66 69 6e  ries] that defin
1cda0 65 20 61 0a 2a 2a 20 63 6c 61 73 73 20 6f 66 20  e a.** class of 
1cdb0 63 6f 6e 73 74 72 75 63 74 73 20 74 6f 20 62 65  constructs to be
1cdc0 20 73 69 7a 65 20 6c 69 6d 69 74 65 64 2e 20 20   size limited.  
1cdd0 54 68 65 20 74 68 69 72 64 20 70 61 72 61 6d 65  The third parame
1cde0 74 65 72 20 69 73 20 74 68 65 0a 2a 2a 20 6e 65  ter is the.** ne
1cdf0 77 20 6c 69 6d 69 74 20 66 6f 72 20 74 68 61 74  w limit for that
1ce00 20 63 6f 6e 73 74 72 75 63 74 2e 29 5e 0a 2a 2a   construct.)^.**
1ce10 0a 2a 2a 20 5e 49 66 20 74 68 65 20 6e 65 77 20  .** ^If the new 
1ce20 6c 69 6d 69 74 20 69 73 20 61 20 6e 65 67 61 74  limit is a negat
1ce30 69 76 65 20 6e 75 6d 62 65 72 2c 20 74 68 65 20  ive number, the 
1ce40 6c 69 6d 69 74 20 69 73 20 75 6e 63 68 61 6e 67  limit is unchang
1ce50 65 64 2e 0a 2a 2a 20 5e 28 46 6f 72 20 65 61 63  ed..** ^(For eac
1ce60 68 20 6c 69 6d 69 74 20 63 61 74 65 67 6f 72 79  h limit category
1ce70 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 3c 69   SQLITE_LIMIT_<i
1ce80 3e 4e 41 4d 45 3c 2f 69 3e 20 74 68 65 72 65 20  >NAME</i> there 
1ce90 69 73 20 61 20 0a 2a 2a 20 5b 6c 69 6d 69 74 73  is a .** [limits
1cea0 20 7c 20 68 61 72 64 20 75 70 70 65 72 20 62 6f   | hard upper bo
1ceb0 75 6e 64 5d 0a 2a 2a 20 73 65 74 20 61 74 20 63  und].** set at c
1cec0 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 62 79 20 61  ompile-time by a
1ced0 20 43 20 70 72 65 70 72 6f 63 65 73 73 6f 72 20   C preprocessor 
1cee0 6d 61 63 72 6f 20 63 61 6c 6c 65 64 0a 2a 2a 20  macro called.** 
1cef0 5b 6c 69 6d 69 74 73 20 7c 20 53 51 4c 49 54 45  [limits | SQLITE
1cf00 5f 4d 41 58 5f 3c 69 3e 4e 41 4d 45 3c 2f 69 3e  _MAX_<i>NAME</i>
1cf10 5d 2e 0a 2a 2a 20 28 54 68 65 20 22 5f 4c 49 4d  ]..** (The "_LIM
1cf20 49 54 5f 22 20 69 6e 20 74 68 65 20 6e 61 6d 65  IT_" in the name
1cf30 20 69 73 20 63 68 61 6e 67 65 64 20 74 6f 20 22   is changed to "
1cf40 5f 4d 41 58 5f 22 2e 29 29 5e 0a 2a 2a 20 5e 41  _MAX_".))^.** ^A
1cf50 74 74 65 6d 70 74 73 20 74 6f 20 69 6e 63 72 65  ttempts to incre
1cf60 61 73 65 20 61 20 6c 69 6d 69 74 20 61 62 6f 76  ase a limit abov
1cf70 65 20 69 74 73 20 68 61 72 64 20 75 70 70 65 72  e its hard upper
1cf80 20 62 6f 75 6e 64 20 61 72 65 0a 2a 2a 20 73 69   bound are.** si
1cf90 6c 65 6e 74 6c 79 20 74 72 75 6e 63 61 74 65 64  lently truncated
1cfa0 20 74 6f 20 74 68 65 20 68 61 72 64 20 75 70 70   to the hard upp
1cfb0 65 72 20 62 6f 75 6e 64 2e 0a 2a 2a 0a 2a 2a 20  er bound..**.** 
1cfc0 5e 52 65 67 61 72 64 6c 65 73 73 20 6f 66 20 77  ^Regardless of w
1cfd0 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20 74 68  hether or not th
1cfe0 65 20 6c 69 6d 69 74 20 77 61 73 20 63 68 61 6e  e limit was chan
1cff0 67 65 64 2c 20 74 68 65 20 0a 2a 2a 20 5b 73 71  ged, the .** [sq
1d000 6c 69 74 65 33 5f 6c 69 6d 69 74 28 29 5d 20 69  lite3_limit()] i
1d010 6e 74 65 72 66 61 63 65 20 72 65 74 75 72 6e 73  nterface returns
1d020 20 74 68 65 20 70 72 69 6f 72 20 76 61 6c 75 65   the prior value
1d030 20 6f 66 20 74 68 65 20 6c 69 6d 69 74 2e 0a 2a   of the limit..*
1d040 2a 20 5e 48 65 6e 63 65 2c 20 74 6f 20 66 69 6e  * ^Hence, to fin
1d050 64 20 74 68 65 20 63 75 72 72 65 6e 74 20 76 61  d the current va
1d060 6c 75 65 20 6f 66 20 61 20 6c 69 6d 69 74 20 77  lue of a limit w
1d070 69 74 68 6f 75 74 20 63 68 61 6e 67 69 6e 67 20  ithout changing 
1d080 69 74 2c 0a 2a 2a 20 73 69 6d 70 6c 79 20 69 6e  it,.** simply in
1d090 76 6f 6b 65 20 74 68 69 73 20 69 6e 74 65 72 66  voke this interf
1d0a0 61 63 65 20 77 69 74 68 20 74 68 65 20 74 68 69  ace with the thi
1d0b0 72 64 20 70 61 72 61 6d 65 74 65 72 20 73 65 74  rd parameter set
1d0c0 20 74 6f 20 2d 31 2e 0a 2a 2a 0a 2a 2a 20 52 75   to -1..**.** Ru
1d0d0 6e 2d 74 69 6d 65 20 6c 69 6d 69 74 73 20 61 72  n-time limits ar
1d0e0 65 20 69 6e 74 65 6e 64 65 64 20 66 6f 72 20 75  e intended for u
1d0f0 73 65 20 69 6e 20 61 70 70 6c 69 63 61 74 69 6f  se in applicatio
1d100 6e 73 20 74 68 61 74 20 6d 61 6e 61 67 65 0a 2a  ns that manage.*
1d110 2a 20 62 6f 74 68 20 74 68 65 69 72 20 6f 77 6e  * both their own
1d120 20 69 6e 74 65 72 6e 61 6c 20 64 61 74 61 62 61   internal databa
1d130 73 65 20 61 6e 64 20 61 6c 73 6f 20 64 61 74 61  se and also data
1d140 62 61 73 65 73 20 74 68 61 74 20 61 72 65 20 63  bases that are c
1d150 6f 6e 74 72 6f 6c 6c 65 64 0a 2a 2a 20 62 79 20  ontrolled.** by 
1d160 75 6e 74 72 75 73 74 65 64 20 65 78 74 65 72 6e  untrusted extern
1d170 61 6c 20 73 6f 75 72 63 65 73 2e 20 20 41 6e 20  al sources.  An 
1d180 65 78 61 6d 70 6c 65 20 61 70 70 6c 69 63 61 74  example applicat
1d190 69 6f 6e 20 6d 69 67 68 74 20 62 65 20 61 0a 2a  ion might be a.*
1d1a0 2a 20 77 65 62 20 62 72 6f 77 73 65 72 20 74 68  * web browser th
1d1b0 61 74 20 68 61 73 20 69 74 73 20 6f 77 6e 20 64  at has its own d
1d1c0 61 74 61 62 61 73 65 73 20 66 6f 72 20 73 74 6f  atabases for sto
1d1d0 72 69 6e 67 20 68 69 73 74 6f 72 79 20 61 6e 64  ring history and
1d1e0 0a 2a 2a 20 73 65 70 61 72 61 74 65 20 64 61 74  .** separate dat
1d1f0 61 62 61 73 65 73 20 63 6f 6e 74 72 6f 6c 6c 65  abases controlle
1d200 64 20 62 79 20 4a 61 76 61 53 63 72 69 70 74 20  d by JavaScript 
1d210 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 64 6f 77  applications dow
1d220 6e 6c 6f 61 64 65 64 0a 2a 2a 20 6f 66 66 20 74  nloaded.** off t
1d230 68 65 20 49 6e 74 65 72 6e 65 74 2e 20 20 54 68  he Internet.  Th
1d240 65 20 69 6e 74 65 72 6e 61 6c 20 64 61 74 61 62  e internal datab
1d250 61 73 65 73 20 63 61 6e 20 62 65 20 67 69 76 65  ases can be give
1d260 6e 20 74 68 65 0a 2a 2a 20 6c 61 72 67 65 2c 20  n the.** large, 
1d270 64 65 66 61 75 6c 74 20 6c 69 6d 69 74 73 2e 20  default limits. 
1d280 20 44 61 74 61 62 61 73 65 73 20 6d 61 6e 61 67   Databases manag
1d290 65 64 20 62 79 20 65 78 74 65 72 6e 61 6c 20 73  ed by external s
1d2a0 6f 75 72 63 65 73 20 63 61 6e 0a 2a 2a 20 62 65  ources can.** be
1d2b0 20 67 69 76 65 6e 20 6d 75 63 68 20 73 6d 61 6c   given much smal
1d2c0 6c 65 72 20 6c 69 6d 69 74 73 20 64 65 73 69 67  ler limits desig
1d2d0 6e 65 64 20 74 6f 20 70 72 65 76 65 6e 74 20 61  ned to prevent a
1d2e0 20 64 65 6e 69 61 6c 20 6f 66 20 73 65 72 76 69   denial of servi
1d2f0 63 65 0a 2a 2a 20 61 74 74 61 63 6b 2e 20 20 44  ce.** attack.  D
1d300 65 76 65 6c 6f 70 65 72 73 20 6d 69 67 68 74 20  evelopers might 
1d310 61 6c 73 6f 20 77 61 6e 74 20 74 6f 20 75 73 65  also want to use
1d320 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 65   the [sqlite3_se
1d330 74 5f 61 75 74 68 6f 72 69 7a 65 72 28 29 5d 0a  t_authorizer()].
1d340 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20  ** interface to 
1d350 66 75 72 74 68 65 72 20 63 6f 6e 74 72 6f 6c 20  further control 
1d360 75 6e 74 72 75 73 74 65 64 20 53 51 4c 2e 20 20  untrusted SQL.  
1d370 54 68 65 20 73 69 7a 65 20 6f 66 20 74 68 65 20  The size of the 
1d380 64 61 74 61 62 61 73 65 0a 2a 2a 20 63 72 65 61  database.** crea
1d390 74 65 64 20 62 79 20 61 6e 20 75 6e 74 72 75 73  ted by an untrus
1d3a0 74 65 64 20 73 63 72 69 70 74 20 63 61 6e 20 62  ted script can b
1d3b0 65 20 63 6f 6e 74 61 69 6e 65 64 20 75 73 69 6e  e contained usin
1d3c0 67 20 74 68 65 0a 2a 2a 20 5b 6d 61 78 5f 70 61  g the.** [max_pa
1d3d0 67 65 5f 63 6f 75 6e 74 5d 20 5b 50 52 41 47 4d  ge_count] [PRAGM
1d3e0 41 5d 2e 0a 2a 2a 0a 2a 2a 20 4e 65 77 20 72 75  A]..**.** New ru
1d3f0 6e 2d 74 69 6d 65 20 6c 69 6d 69 74 20 63 61 74  n-time limit cat
1d400 65 67 6f 72 69 65 73 20 6d 61 79 20 62 65 20 61  egories may be a
1d410 64 64 65 64 20 69 6e 20 66 75 74 75 72 65 20 72  dded in future r
1d420 65 6c 65 61 73 65 73 2e 0a 2a 2f 0a 69 6e 74 20  eleases..*/.int 
1d430 73 71 6c 69 74 65 33 5f 6c 69 6d 69 74 28 73 71  sqlite3_limit(sq
1d440 6c 69 74 65 33 2a 2c 20 69 6e 74 20 69 64 2c 20  lite3*, int id, 
1d450 69 6e 74 20 6e 65 77 56 61 6c 29 3b 0a 0a 2f 2a  int newVal);../*
1d460 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 52 75  .** CAPI3REF: Ru
1d470 6e 2d 54 69 6d 65 20 4c 69 6d 69 74 20 43 61 74  n-Time Limit Cat
1d480 65 67 6f 72 69 65 73 0a 2a 2a 20 4b 45 59 57 4f  egories.** KEYWO
1d490 52 44 53 3a 20 7b 6c 69 6d 69 74 20 63 61 74 65  RDS: {limit cate
1d4a0 67 6f 72 79 7d 20 7b 2a 6c 69 6d 69 74 20 63 61  gory} {*limit ca
1d4b0 74 65 67 6f 72 69 65 73 7d 0a 2a 2a 0a 2a 2a 20  tegories}.**.** 
1d4c0 54 68 65 73 65 20 63 6f 6e 73 74 61 6e 74 73 20  These constants 
1d4d0 64 65 66 69 6e 65 20 76 61 72 69 6f 75 73 20 70  define various p
1d4e0 65 72 66 6f 72 6d 61 6e 63 65 20 6c 69 6d 69 74  erformance limit
1d4f0 73 0a 2a 2a 20 74 68 61 74 20 63 61 6e 20 62 65  s.** that can be
1d500 20 6c 6f 77 65 72 65 64 20 61 74 20 72 75 6e 2d   lowered at run-
1d510 74 69 6d 65 20 75 73 69 6e 67 20 5b 73 71 6c 69  time using [sqli
1d520 74 65 33 5f 6c 69 6d 69 74 28 29 5d 2e 0a 2a 2a  te3_limit()]..**
1d530 20 54 68 65 20 73 79 6e 6f 70 73 69 73 20 6f 66   The synopsis of
1d540 20 74 68 65 20 6d 65 61 6e 69 6e 67 73 20 6f 66   the meanings of
1d550 20 74 68 65 20 76 61 72 69 6f 75 73 20 6c 69 6d   the various lim
1d560 69 74 73 20 69 73 20 73 68 6f 77 6e 20 62 65 6c  its is shown bel
1d570 6f 77 2e 0a 2a 2a 20 41 64 64 69 74 69 6f 6e 61  ow..** Additiona
1d580 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 69 73  l information is
1d590 20 61 76 61 69 6c 61 62 6c 65 20 61 74 20 5b 6c   available at [l
1d5a0 69 6d 69 74 73 20 7c 20 4c 69 6d 69 74 73 20 69  imits | Limits i
1d5b0 6e 20 53 51 4c 69 74 65 5d 2e 0a 2a 2a 0a 2a 2a  n SQLite]..**.**
1d5c0 20 3c 64 6c 3e 0a 2a 2a 20 5e 28 3c 64 74 3e 53   <dl>.** ^(<dt>S
1d5d0 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 4c 45 4e 47  QLITE_LIMIT_LENG
1d5e0 54 48 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54  TH</dt>.** <dd>T
1d5f0 68 65 20 6d 61 78 69 6d 75 6d 20 73 69 7a 65 20  he maximum size 
1d600 6f 66 20 61 6e 79 20 73 74 72 69 6e 67 20 6f 72  of any string or
1d610 20 42 4c 4f 42 20 6f 72 20 74 61 62 6c 65 20 72   BLOB or table r
1d620 6f 77 2c 20 69 6e 20 62 79 74 65 73 2e 3c 64 64  ow, in bytes.<dd
1d630 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 28 3c 64 74 3e  >)^.**.** ^(<dt>
1d640 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 53 51 4c  SQLITE_LIMIT_SQL
1d650 5f 4c 45 4e 47 54 48 3c 2f 64 74 3e 0a 2a 2a 20  _LENGTH</dt>.** 
1d660 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20  <dd>The maximum 
1d670 6c 65 6e 67 74 68 20 6f 66 20 61 6e 20 53 51 4c  length of an SQL
1d680 20 73 74 61 74 65 6d 65 6e 74 2c 20 69 6e 20 62   statement, in b
1d690 79 74 65 73 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 0a  ytes.</dd>)^.**.
1d6a0 2a 2a 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f  ** ^(<dt>SQLITE_
1d6b0 4c 49 4d 49 54 5f 43 4f 4c 55 4d 4e 3c 2f 64 74  LIMIT_COLUMN</dt
1d6c0 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 6d 61 78  >.** <dd>The max
1d6d0 69 6d 75 6d 20 6e 75 6d 62 65 72 20 6f 66 20 63  imum number of c
1d6e0 6f 6c 75 6d 6e 73 20 69 6e 20 61 20 74 61 62 6c  olumns in a tabl
1d6f0 65 20 64 65 66 69 6e 69 74 69 6f 6e 20 6f 72 20  e definition or 
1d700 69 6e 20 74 68 65 0a 2a 2a 20 72 65 73 75 6c 74  in the.** result
1d710 20 73 65 74 20 6f 66 20 61 20 5b 53 45 4c 45 43   set of a [SELEC
1d720 54 5d 20 6f 72 20 74 68 65 20 6d 61 78 69 6d 75  T] or the maximu
1d730 6d 20 6e 75 6d 62 65 72 20 6f 66 20 63 6f 6c 75  m number of colu
1d740 6d 6e 73 20 69 6e 20 61 6e 20 69 6e 64 65 78 0a  mns in an index.
1d750 2a 2a 20 6f 72 20 69 6e 20 61 6e 20 4f 52 44 45  ** or in an ORDE
1d760 52 20 42 59 20 6f 72 20 47 52 4f 55 50 20 42 59  R BY or GROUP BY
1d770 20 63 6c 61 75 73 65 2e 3c 2f 64 64 3e 29 5e 0a   clause.</dd>)^.
1d780 2a 2a 0a 2a 2a 20 5e 28 3c 64 74 3e 53 51 4c 49  **.** ^(<dt>SQLI
1d790 54 45 5f 4c 49 4d 49 54 5f 45 58 50 52 5f 44 45  TE_LIMIT_EXPR_DE
1d7a0 50 54 48 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e  PTH</dt>.** <dd>
1d7b0 54 68 65 20 6d 61 78 69 6d 75 6d 20 64 65 70 74  The maximum dept
1d7c0 68 20 6f 66 20 74 68 65 20 70 61 72 73 65 20 74  h of the parse t
1d7d0 72 65 65 20 6f 6e 20 61 6e 79 20 65 78 70 72 65  ree on any expre
1d7e0 73 73 69 6f 6e 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a  ssion.</dd>)^.**
1d7f0 0a 2a 2a 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45  .** ^(<dt>SQLITE
1d800 5f 4c 49 4d 49 54 5f 43 4f 4d 50 4f 55 4e 44 5f  _LIMIT_COMPOUND_
1d810 53 45 4c 45 43 54 3c 2f 64 74 3e 0a 2a 2a 20 3c  SELECT</dt>.** <
1d820 64 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20 6e  dd>The maximum n
1d830 75 6d 62 65 72 20 6f 66 20 74 65 72 6d 73 20 69  umber of terms i
1d840 6e 20 61 20 63 6f 6d 70 6f 75 6e 64 20 53 45 4c  n a compound SEL
1d850 45 43 54 20 73 74 61 74 65 6d 65 6e 74 2e 3c 2f  ECT statement.</
1d860 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 28 3c 64  dd>)^.**.** ^(<d
1d870 74 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 56  t>SQLITE_LIMIT_V
1d880 44 42 45 5f 4f 50 3c 2f 64 74 3e 0a 2a 2a 20 3c  DBE_OP</dt>.** <
1d890 64 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20 6e  dd>The maximum n
1d8a0 75 6d 62 65 72 20 6f 66 20 69 6e 73 74 72 75 63  umber of instruc
1d8b0 74 69 6f 6e 73 20 69 6e 20 61 20 76 69 72 74 75  tions in a virtu
1d8c0 61 6c 20 6d 61 63 68 69 6e 65 20 70 72 6f 67 72  al machine progr
1d8d0 61 6d 0a 2a 2a 20 75 73 65 64 20 74 6f 20 69 6d  am.** used to im
1d8e0 70 6c 65 6d 65 6e 74 20 61 6e 20 53 51 4c 20 73  plement an SQL s
1d8f0 74 61 74 65 6d 65 6e 74 2e 20 20 54 68 69 73 20  tatement.  This 
1d900 6c 69 6d 69 74 20 69 73 20 6e 6f 74 20 63 75 72  limit is not cur
1d910 72 65 6e 74 6c 79 0a 2a 2a 20 65 6e 66 6f 72 63  rently.** enforc
1d920 65 64 2c 20 74 68 6f 75 67 68 20 74 68 61 74 20  ed, though that 
1d930 6d 69 67 68 74 20 62 65 20 61 64 64 65 64 20 69  might be added i
1d940 6e 20 73 6f 6d 65 20 66 75 74 75 72 65 20 72 65  n some future re
1d950 6c 65 61 73 65 20 6f 66 0a 2a 2a 20 53 51 4c 69  lease of.** SQLi
1d960 74 65 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 0a 2a 2a  te.</dd>)^.**.**
1d970 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f 4c 49   ^(<dt>SQLITE_LI
1d980 4d 49 54 5f 46 55 4e 43 54 49 4f 4e 5f 41 52 47  MIT_FUNCTION_ARG
1d990 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65  </dt>.** <dd>The
1d9a0 20 6d 61 78 69 6d 75 6d 20 6e 75 6d 62 65 72 20   maximum number 
1d9b0 6f 66 20 61 72 67 75 6d 65 6e 74 73 20 6f 6e 20  of arguments on 
1d9c0 61 20 66 75 6e 63 74 69 6f 6e 2e 3c 2f 64 64 3e  a function.</dd>
1d9d0 29 5e 0a 2a 2a 0a 2a 2a 20 5e 28 3c 64 74 3e 53  )^.**.** ^(<dt>S
1d9e0 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 41 54 54 41  QLITE_LIMIT_ATTA
1d9f0 43 48 45 44 3c 2f 64 74 3e 0a 2a 2a 20 3c 64 64  CHED</dt>.** <dd
1da00 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20 6e 75 6d  >The maximum num
1da10 62 65 72 20 6f 66 20 5b 41 54 54 41 43 48 20 7c  ber of [ATTACH |
1da20 20 61 74 74 61 63 68 65 64 20 64 61 74 61 62 61   attached databa
1da30 73 65 73 5d 2e 29 5e 3c 2f 64 64 3e 0a 2a 2a 0a  ses].)^</dd>.**.
1da40 2a 2a 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45 5f  ** ^(<dt>SQLITE_
1da50 4c 49 4d 49 54 5f 4c 49 4b 45 5f 50 41 54 54 45  LIMIT_LIKE_PATTE
1da60 52 4e 5f 4c 45 4e 47 54 48 3c 2f 64 74 3e 0a 2a  RN_LENGTH</dt>.*
1da70 2a 20 3c 64 64 3e 54 68 65 20 6d 61 78 69 6d 75  * <dd>The maximu
1da80 6d 20 6c 65 6e 67 74 68 20 6f 66 20 74 68 65 20  m length of the 
1da90 70 61 74 74 65 72 6e 20 61 72 67 75 6d 65 6e 74  pattern argument
1daa0 20 74 6f 20 74 68 65 20 5b 4c 49 4b 45 5d 20 6f   to the [LIKE] o
1dab0 72 0a 2a 2a 20 5b 47 4c 4f 42 5d 20 6f 70 65 72  r.** [GLOB] oper
1dac0 61 74 6f 72 73 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a  ators.</dd>)^.**
1dad0 0a 2a 2a 20 5e 28 3c 64 74 3e 53 51 4c 49 54 45  .** ^(<dt>SQLITE
1dae0 5f 4c 49 4d 49 54 5f 56 41 52 49 41 42 4c 45 5f  _LIMIT_VARIABLE_
1daf0 4e 55 4d 42 45 52 3c 2f 64 74 3e 0a 2a 2a 20 3c  NUMBER</dt>.** <
1db00 64 64 3e 54 68 65 20 6d 61 78 69 6d 75 6d 20 69  dd>The maximum i
1db10 6e 64 65 78 20 6e 75 6d 62 65 72 20 6f 66 20 61  ndex number of a
1db20 6e 79 20 5b 70 61 72 61 6d 65 74 65 72 5d 20 69  ny [parameter] i
1db30 6e 20 61 6e 20 53 51 4c 20 73 74 61 74 65 6d 65  n an SQL stateme
1db40 6e 74 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 28 3c 64  nt.)^.**.** ^(<d
1db50 74 3e 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 54  t>SQLITE_LIMIT_T
1db60 52 49 47 47 45 52 5f 44 45 50 54 48 3c 2f 64 74  RIGGER_DEPTH</dt
1db70 3e 0a 2a 2a 20 3c 64 64 3e 54 68 65 20 6d 61 78  >.** <dd>The max
1db80 69 6d 75 6d 20 64 65 70 74 68 20 6f 66 20 72 65  imum depth of re
1db90 63 75 72 73 69 6f 6e 20 66 6f 72 20 74 72 69 67  cursion for trig
1dba0 67 65 72 73 2e 3c 2f 64 64 3e 29 5e 0a 2a 2a 20  gers.</dd>)^.** 
1dbb0 3c 2f 64 6c 3e 0a 2a 2f 0a 23 64 65 66 69 6e 65  </dl>.*/.#define
1dbc0 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 4c 45   SQLITE_LIMIT_LE
1dbd0 4e 47 54 48 20 20 20 20 20 20 20 20 20 20 20 20  NGTH            
1dbe0 20 20 20 20 20 20 20 20 30 0a 23 64 65 66 69 6e          0.#defin
1dbf0 65 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 53  e SQLITE_LIMIT_S
1dc00 51 4c 5f 4c 45 4e 47 54 48 20 20 20 20 20 20 20  QL_LENGTH       
1dc10 20 20 20 20 20 20 20 20 20 31 0a 23 64 65 66 69           1.#defi
1dc20 6e 65 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54 5f  ne SQLITE_LIMIT_
1dc30 43 4f 4c 55 4d 4e 20 20 20 20 20 20 20 20 20 20  COLUMN          
1dc40 20 20 20 20 20 20 20 20 20 20 32 0a 23 64 65 66            2.#def
1dc50 69 6e 65 20 53 51 4c 49 54 45 5f 4c 49 4d 49 54  ine SQLITE_LIMIT
1dc60 5f 45 58 50 52 5f 44 45 50 54 48 20 20 20 20 20  _EXPR_DEPTH     
1dc70 20 20 20 20 20 20 20 20 20 20 20 33 0a 23 64 65             3.#de
1dc80 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c 49 4d 49  fine SQLITE_LIMI
1dc90 54 5f 43 4f 4d 50 4f 55 4e 44 5f 53 45 4c 45 43  T_COMPOUND_SELEC
1dca0 54 20 20 20 20 20 20 20 20 20 20 20 34 0a 23 64  T           4.#d
1dcb0 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c 49 4d  efine SQLITE_LIM
1dcc0 49 54 5f 56 44 42 45 5f 4f 50 20 20 20 20 20 20  IT_VDBE_OP      
1dcd0 20 20 20 20 20 20 20 20 20 20 20 20 20 35 0a 23               5.#
1dce0 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c 49  define SQLITE_LI
1dcf0 4d 49 54 5f 46 55 4e 43 54 49 4f 4e 5f 41 52 47  MIT_FUNCTION_ARG
1dd00 20 20 20 20 20 20 20 20 20 20 20 20 20 20 36 0a                6.
1dd10 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4c  #define SQLITE_L
1dd20 49 4d 49 54 5f 41 54 54 41 43 48 45 44 20 20 20  IMIT_ATTACHED   
1dd30 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 37                 7
1dd40 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f  .#define SQLITE_
1dd50 4c 49 4d 49 54 5f 4c 49 4b 45 5f 50 41 54 54 45  LIMIT_LIKE_PATTE
1dd60 52 4e 5f 4c 45 4e 47 54 48 20 20 20 20 20 20 20  RN_LENGTH       
1dd70 38 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  8.#define SQLITE
1dd80 5f 4c 49 4d 49 54 5f 56 41 52 49 41 42 4c 45 5f  _LIMIT_VARIABLE_
1dd90 4e 55 4d 42 45 52 20 20 20 20 20 20 20 20 20 20  NUMBER          
1dda0 20 39 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54   9.#define SQLIT
1ddb0 45 5f 4c 49 4d 49 54 5f 54 52 49 47 47 45 52 5f  E_LIMIT_TRIGGER_
1ddc0 44 45 50 54 48 20 20 20 20 20 20 20 20 20 20 20  DEPTH           
1ddd0 20 31 30 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33   10../*.** CAPI3
1dde0 52 45 46 3a 20 43 6f 6d 70 69 6c 69 6e 67 20 41  REF: Compiling A
1ddf0 6e 20 53 51 4c 20 53 74 61 74 65 6d 65 6e 74 0a  n SQL Statement.
1de00 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b 53 51  ** KEYWORDS: {SQ
1de10 4c 20 73 74 61 74 65 6d 65 6e 74 20 63 6f 6d 70  L statement comp
1de20 69 6c 65 72 7d 0a 2a 2a 0a 2a 2a 20 54 6f 20 65  iler}.**.** To e
1de30 78 65 63 75 74 65 20 61 6e 20 53 51 4c 20 71 75  xecute an SQL qu
1de40 65 72 79 2c 20 69 74 20 6d 75 73 74 20 66 69 72  ery, it must fir
1de50 73 74 20 62 65 20 63 6f 6d 70 69 6c 65 64 20 69  st be compiled i
1de60 6e 74 6f 20 61 20 62 79 74 65 2d 63 6f 64 65 0a  nto a byte-code.
1de70 2a 2a 20 70 72 6f 67 72 61 6d 20 75 73 69 6e 67  ** program using
1de80 20 6f 6e 65 20 6f 66 20 74 68 65 73 65 20 72 6f   one of these ro
1de90 75 74 69 6e 65 73 2e 0a 2a 2a 0a 2a 2a 20 54 68  utines..**.** Th
1dea0 65 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74  e first argument
1deb0 2c 20 22 64 62 22 2c 20 69 73 20 61 20 5b 64 61  , "db", is a [da
1dec0 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
1ded0 6e 5d 20 6f 62 74 61 69 6e 65 64 20 66 72 6f 6d  n] obtained from
1dee0 20 61 0a 2a 2a 20 70 72 69 6f 72 20 73 75 63 63   a.** prior succ
1def0 65 73 73 66 75 6c 20 63 61 6c 6c 20 74 6f 20 5b  essful call to [
1df00 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 5d 2c  sqlite3_open()],
1df10 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76   [sqlite3_open_v
1df20 32 28 29 5d 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69  2()] or.** [sqli
1df30 74 65 33 5f 6f 70 65 6e 31 36 28 29 5d 2e 20 20  te3_open16()].  
1df40 54 68 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e  The database con
1df50 6e 65 63 74 69 6f 6e 20 6d 75 73 74 20 6e 6f 74  nection must not
1df60 20 68 61 76 65 20 62 65 65 6e 20 63 6c 6f 73 65   have been close
1df70 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 65 63  d..**.** The sec
1df80 6f 6e 64 20 61 72 67 75 6d 65 6e 74 2c 20 22 7a  ond argument, "z
1df90 53 71 6c 22 2c 20 69 73 20 74 68 65 20 73 74 61  Sql", is the sta
1dfa0 74 65 6d 65 6e 74 20 74 6f 20 62 65 20 63 6f 6d  tement to be com
1dfb0 70 69 6c 65 64 2c 20 65 6e 63 6f 64 65 64 0a 2a  piled, encoded.*
1dfc0 2a 20 61 73 20 65 69 74 68 65 72 20 55 54 46 2d  * as either UTF-
1dfd0 38 20 6f 72 20 55 54 46 2d 31 36 2e 20 20 54 68  8 or UTF-16.  Th
1dfe0 65 20 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72  e sqlite3_prepar
1dff0 65 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f  e() and sqlite3_
1e000 70 72 65 70 61 72 65 5f 76 32 28 29 0a 2a 2a 20  prepare_v2().** 
1e010 69 6e 74 65 72 66 61 63 65 73 20 75 73 65 20 55  interfaces use U
1e020 54 46 2d 38 2c 20 61 6e 64 20 73 71 6c 69 74 65  TF-8, and sqlite
1e030 33 5f 70 72 65 70 61 72 65 31 36 28 29 20 61 6e  3_prepare16() an
1e040 64 20 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72  d sqlite3_prepar
1e050 65 31 36 5f 76 32 28 29 0a 2a 2a 20 75 73 65 20  e16_v2().** use 
1e060 55 54 46 2d 31 36 2e 0a 2a 2a 0a 2a 2a 20 5e 49  UTF-16..**.** ^I
1e070 66 20 74 68 65 20 6e 42 79 74 65 20 61 72 67 75  f the nByte argu
1e080 6d 65 6e 74 20 69 73 20 6c 65 73 73 20 74 68 61  ment is less tha
1e090 6e 20 7a 65 72 6f 2c 20 74 68 65 6e 20 7a 53 71  n zero, then zSq
1e0a0 6c 20 69 73 20 72 65 61 64 20 75 70 20 74 6f 20  l is read up to 
1e0b0 74 68 65 0a 2a 2a 20 66 69 72 73 74 20 7a 65 72  the.** first zer
1e0c0 6f 20 74 65 72 6d 69 6e 61 74 6f 72 2e 20 5e 49  o terminator. ^I
1e0d0 66 20 6e 42 79 74 65 20 69 73 20 6e 6f 6e 2d 6e  f nByte is non-n
1e0e0 65 67 61 74 69 76 65 2c 20 74 68 65 6e 20 69 74  egative, then it
1e0f0 20 69 73 20 74 68 65 20 6d 61 78 69 6d 75 6d 0a   is the maximum.
1e100 2a 2a 20 6e 75 6d 62 65 72 20 6f 66 20 20 62 79  ** number of  by
1e110 74 65 73 20 72 65 61 64 20 66 72 6f 6d 20 7a 53  tes read from zS
1e120 71 6c 2e 20 20 5e 57 68 65 6e 20 6e 42 79 74 65  ql.  ^When nByte
1e130 20 69 73 20 6e 6f 6e 2d 6e 65 67 61 74 69 76 65   is non-negative
1e140 2c 20 74 68 65 0a 2a 2a 20 7a 53 71 6c 20 73 74  , the.** zSql st
1e150 72 69 6e 67 20 65 6e 64 73 20 61 74 20 65 69 74  ring ends at eit
1e160 68 65 72 20 74 68 65 20 66 69 72 73 74 20 27 5c  her the first '\
1e170 30 30 30 27 20 6f 72 20 27 5c 75 30 30 30 30 27  000' or '\u0000'
1e180 20 63 68 61 72 61 63 74 65 72 20 6f 72 0a 2a 2a   character or.**
1e190 20 74 68 65 20 6e 42 79 74 65 2d 74 68 20 62 79   the nByte-th by
1e1a0 74 65 2c 20 77 68 69 63 68 65 76 65 72 20 63 6f  te, whichever co
1e1b0 6d 65 73 20 66 69 72 73 74 2e 20 49 66 20 74 68  mes first. If th
1e1c0 65 20 63 61 6c 6c 65 72 20 6b 6e 6f 77 73 0a 2a  e caller knows.*
1e1d0 2a 20 74 68 61 74 20 74 68 65 20 73 75 70 70 6c  * that the suppl
1e1e0 69 65 64 20 73 74 72 69 6e 67 20 69 73 20 6e 75  ied string is nu
1e1f0 6c 2d 74 65 72 6d 69 6e 61 74 65 64 2c 20 74 68  l-terminated, th
1e200 65 6e 20 74 68 65 72 65 20 69 73 20 61 20 73 6d  en there is a sm
1e210 61 6c 6c 0a 2a 2a 20 70 65 72 66 6f 72 6d 61 6e  all.** performan
1e220 63 65 20 61 64 76 61 6e 74 61 67 65 20 74 6f 20  ce advantage to 
1e230 62 65 20 67 61 69 6e 65 64 20 62 79 20 70 61 73  be gained by pas
1e240 73 69 6e 67 20 61 6e 20 6e 42 79 74 65 20 70 61  sing an nByte pa
1e250 72 61 6d 65 74 65 72 20 74 68 61 74 0a 2a 2a 20  rameter that.** 
1e260 69 73 20 65 71 75 61 6c 20 74 6f 20 74 68 65 20  is equal to the 
1e270 6e 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73 20  number of bytes 
1e280 69 6e 20 74 68 65 20 69 6e 70 75 74 20 73 74 72  in the input str
1e290 69 6e 67 20 3c 69 3e 69 6e 63 6c 75 64 69 6e 67  ing <i>including
1e2a0 3c 2f 69 3e 0a 2a 2a 20 74 68 65 20 6e 75 6c 2d  </i>.** the nul-
1e2b0 74 65 72 6d 69 6e 61 74 6f 72 20 62 79 74 65 73  terminator bytes
1e2c0 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 70 7a 54 61  ..**.** ^If pzTa
1e2d0 69 6c 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 20 74  il is not NULL t
1e2e0 68 65 6e 20 2a 70 7a 54 61 69 6c 20 69 73 20 6d  hen *pzTail is m
1e2f0 61 64 65 20 74 6f 20 70 6f 69 6e 74 20 74 6f 20  ade to point to 
1e300 74 68 65 20 66 69 72 73 74 20 62 79 74 65 0a 2a  the first byte.*
1e310 2a 20 70 61 73 74 20 74 68 65 20 65 6e 64 20 6f  * past the end o
1e320 66 20 74 68 65 20 66 69 72 73 74 20 53 51 4c 20  f the first SQL 
1e330 73 74 61 74 65 6d 65 6e 74 20 69 6e 20 7a 53 71  statement in zSq
1e340 6c 2e 20 20 54 68 65 73 65 20 72 6f 75 74 69 6e  l.  These routin
1e350 65 73 20 6f 6e 6c 79 0a 2a 2a 20 63 6f 6d 70 69  es only.** compi
1e360 6c 65 20 74 68 65 20 66 69 72 73 74 20 73 74 61  le the first sta
1e370 74 65 6d 65 6e 74 20 69 6e 20 7a 53 71 6c 2c 20  tement in zSql, 
1e380 73 6f 20 2a 70 7a 54 61 69 6c 20 69 73 20 6c 65  so *pzTail is le
1e390 66 74 20 70 6f 69 6e 74 69 6e 67 20 74 6f 0a 2a  ft pointing to.*
1e3a0 2a 20 77 68 61 74 20 72 65 6d 61 69 6e 73 20 75  * what remains u
1e3b0 6e 63 6f 6d 70 69 6c 65 64 2e 0a 2a 2a 0a 2a 2a  ncompiled..**.**
1e3c0 20 5e 2a 70 70 53 74 6d 74 20 69 73 20 6c 65 66   ^*ppStmt is lef
1e3d0 74 20 70 6f 69 6e 74 69 6e 67 20 74 6f 20 61 20  t pointing to a 
1e3e0 63 6f 6d 70 69 6c 65 64 20 5b 70 72 65 70 61 72  compiled [prepar
1e3f0 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 74 68  ed statement] th
1e400 61 74 20 63 61 6e 20 62 65 0a 2a 2a 20 65 78 65  at can be.** exe
1e410 63 75 74 65 64 20 75 73 69 6e 67 20 5b 73 71 6c  cuted using [sql
1e420 69 74 65 33 5f 73 74 65 70 28 29 5d 2e 20 20 5e  ite3_step()].  ^
1e430 49 66 20 74 68 65 72 65 20 69 73 20 61 6e 20 65  If there is an e
1e440 72 72 6f 72 2c 20 2a 70 70 53 74 6d 74 20 69 73  rror, *ppStmt is
1e450 20 73 65 74 0a 2a 2a 20 74 6f 20 4e 55 4c 4c 2e   set.** to NULL.
1e460 20 20 5e 49 66 20 74 68 65 20 69 6e 70 75 74 20    ^If the input 
1e470 74 65 78 74 20 63 6f 6e 74 61 69 6e 73 20 6e 6f  text contains no
1e480 20 53 51 4c 20 28 69 66 20 74 68 65 20 69 6e 70   SQL (if the inp
1e490 75 74 20 69 73 20 61 6e 20 65 6d 70 74 79 0a 2a  ut is an empty.*
1e4a0 2a 20 73 74 72 69 6e 67 20 6f 72 20 61 20 63 6f  * string or a co
1e4b0 6d 6d 65 6e 74 29 20 74 68 65 6e 20 2a 70 70 53  mment) then *ppS
1e4c0 74 6d 74 20 69 73 20 73 65 74 20 74 6f 20 4e 55  tmt is set to NU
1e4d0 4c 4c 2e 0a 2a 2a 20 54 68 65 20 63 61 6c 6c 69  LL..** The calli
1e4e0 6e 67 20 70 72 6f 63 65 64 75 72 65 20 69 73 20  ng procedure is 
1e4f0 72 65 73 70 6f 6e 73 69 62 6c 65 20 66 6f 72 20  responsible for 
1e500 64 65 6c 65 74 69 6e 67 20 74 68 65 20 63 6f 6d  deleting the com
1e510 70 69 6c 65 64 0a 2a 2a 20 53 51 4c 20 73 74 61  piled.** SQL sta
1e520 74 65 6d 65 6e 74 20 75 73 69 6e 67 20 5b 73 71  tement using [sq
1e530 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28 29  lite3_finalize()
1e540 5d 20 61 66 74 65 72 20 69 74 20 68 61 73 20 66  ] after it has f
1e550 69 6e 69 73 68 65 64 20 77 69 74 68 20 69 74 2e  inished with it.
1e560 0a 2a 2a 20 70 70 53 74 6d 74 20 6d 61 79 20 6e  .** ppStmt may n
1e570 6f 74 20 62 65 20 4e 55 4c 4c 2e 0a 2a 2a 0a 2a  ot be NULL..**.*
1e580 2a 20 5e 4f 6e 20 73 75 63 63 65 73 73 2c 20 74  * ^On success, t
1e590 68 65 20 73 71 6c 69 74 65 33 5f 70 72 65 70 61  he sqlite3_prepa
1e5a0 72 65 28 29 20 66 61 6d 69 6c 79 20 6f 66 20 72  re() family of r
1e5b0 6f 75 74 69 6e 65 73 20 72 65 74 75 72 6e 20 5b  outines return [
1e5c0 53 51 4c 49 54 45 5f 4f 4b 5d 3b 0a 2a 2a 20 6f  SQLITE_OK];.** o
1e5d0 74 68 65 72 77 69 73 65 20 61 6e 20 5b 65 72 72  therwise an [err
1e5e0 6f 72 20 63 6f 64 65 5d 20 69 73 20 72 65 74 75  or code] is retu
1e5f0 72 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  rned..**.** The 
1e600 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f  sqlite3_prepare_
1e610 76 32 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33  v2() and sqlite3
1e620 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28 29 20  _prepare16_v2() 
1e630 69 6e 74 65 72 66 61 63 65 73 20 61 72 65 0a 2a  interfaces are.*
1e640 2a 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 66 6f  * recommended fo
1e650 72 20 61 6c 6c 20 6e 65 77 20 70 72 6f 67 72 61  r all new progra
1e660 6d 73 2e 20 54 68 65 20 74 77 6f 20 6f 6c 64 65  ms. The two olde
1e670 72 20 69 6e 74 65 72 66 61 63 65 73 20 61 72 65  r interfaces are
1e680 20 72 65 74 61 69 6e 65 64 0a 2a 2a 20 66 6f 72   retained.** for
1e690 20 62 61 63 6b 77 61 72 64 73 20 63 6f 6d 70 61   backwards compa
1e6a0 74 69 62 69 6c 69 74 79 2c 20 62 75 74 20 74 68  tibility, but th
1e6b0 65 69 72 20 75 73 65 20 69 73 20 64 69 73 63 6f  eir use is disco
1e6c0 75 72 61 67 65 64 2e 0a 2a 2a 20 5e 49 6e 20 74  uraged..** ^In t
1e6d0 68 65 20 22 76 32 22 20 69 6e 74 65 72 66 61 63  he "v2" interfac
1e6e0 65 73 2c 20 74 68 65 20 70 72 65 70 61 72 65 64  es, the prepared
1e6f0 20 73 74 61 74 65 6d 65 6e 74 0a 2a 2a 20 74 68   statement.** th
1e700 61 74 20 69 73 20 72 65 74 75 72 6e 65 64 20 28  at is returned (
1e710 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 73 74 6d  the [sqlite3_stm
1e720 74 5d 20 6f 62 6a 65 63 74 29 20 63 6f 6e 74 61  t] object) conta
1e730 69 6e 73 20 61 20 63 6f 70 79 20 6f 66 20 74 68  ins a copy of th
1e740 65 0a 2a 2a 20 6f 72 69 67 69 6e 61 6c 20 53 51  e.** original SQ
1e750 4c 20 74 65 78 74 2e 20 54 68 69 73 20 63 61 75  L text. This cau
1e760 73 65 73 20 74 68 65 20 5b 73 71 6c 69 74 65 33  ses the [sqlite3
1e770 5f 73 74 65 70 28 29 5d 20 69 6e 74 65 72 66 61  _step()] interfa
1e780 63 65 20 74 6f 0a 2a 2a 20 62 65 68 61 76 65 20  ce to.** behave 
1e790 64 69 66 66 65 72 65 6e 74 6c 79 20 69 6e 20 74  differently in t
1e7a0 68 72 65 65 20 77 61 79 73 3a 0a 2a 2a 0a 2a 2a  hree ways:.**.**
1e7b0 20 3c 6f 6c 3e 0a 2a 2a 20 3c 6c 69 3e 0a 2a 2a   <ol>.** <li>.**
1e7c0 20 5e 49 66 20 74 68 65 20 64 61 74 61 62 61 73   ^If the databas
1e7d0 65 20 73 63 68 65 6d 61 20 63 68 61 6e 67 65 73  e schema changes
1e7e0 2c 20 69 6e 73 74 65 61 64 20 6f 66 20 72 65 74  , instead of ret
1e7f0 75 72 6e 69 6e 67 20 5b 53 51 4c 49 54 45 5f 53  urning [SQLITE_S
1e800 43 48 45 4d 41 5d 20 61 73 20 69 74 0a 2a 2a 20  CHEMA] as it.** 
1e810 61 6c 77 61 79 73 20 75 73 65 64 20 74 6f 20 64  always used to d
1e820 6f 2c 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70  o, [sqlite3_step
1e830 28 29 5d 20 77 69 6c 6c 20 61 75 74 6f 6d 61 74  ()] will automat
1e840 69 63 61 6c 6c 79 20 72 65 63 6f 6d 70 69 6c 65  ically recompile
1e850 20 74 68 65 20 53 51 4c 0a 2a 2a 20 73 74 61 74   the SQL.** stat
1e860 65 6d 65 6e 74 20 61 6e 64 20 74 72 79 20 74 6f  ement and try to
1e870 20 72 75 6e 20 69 74 20 61 67 61 69 6e 2e 0a 2a   run it again..*
1e880 2a 20 3c 2f 6c 69 3e 0a 2a 2a 0a 2a 2a 20 3c 6c  * </li>.**.** <l
1e890 69 3e 0a 2a 2a 20 5e 57 68 65 6e 20 61 6e 20 65  i>.** ^When an e
1e8a0 72 72 6f 72 20 6f 63 63 75 72 73 2c 20 5b 73 71  rror occurs, [sq
1e8b0 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 77 69  lite3_step()] wi
1e8c0 6c 6c 20 72 65 74 75 72 6e 20 6f 6e 65 20 6f 66  ll return one of
1e8d0 20 74 68 65 20 64 65 74 61 69 6c 65 64 0a 2a 2a   the detailed.**
1e8e0 20 5b 65 72 72 6f 72 20 63 6f 64 65 73 5d 20 6f   [error codes] o
1e8f0 72 20 5b 65 78 74 65 6e 64 65 64 20 65 72 72 6f  r [extended erro
1e900 72 20 63 6f 64 65 73 5d 2e 20 20 5e 54 68 65 20  r codes].  ^The 
1e910 6c 65 67 61 63 79 20 62 65 68 61 76 69 6f 72 20  legacy behavior 
1e920 77 61 73 20 74 68 61 74 0a 2a 2a 20 5b 73 71 6c  was that.** [sql
1e930 69 74 65 33 5f 73 74 65 70 28 29 5d 20 77 6f 75  ite3_step()] wou
1e940 6c 64 20 6f 6e 6c 79 20 72 65 74 75 72 6e 20 61  ld only return a
1e950 20 67 65 6e 65 72 69 63 20 5b 53 51 4c 49 54 45   generic [SQLITE
1e960 5f 45 52 52 4f 52 5d 20 72 65 73 75 6c 74 20 63  _ERROR] result c
1e970 6f 64 65 0a 2a 2a 20 61 6e 64 20 74 68 65 20 61  ode.** and the a
1e980 70 70 6c 69 63 61 74 69 6f 6e 20 77 6f 75 6c 64  pplication would
1e990 20 68 61 76 65 20 74 6f 20 6d 61 6b 65 20 61 20   have to make a 
1e9a0 73 65 63 6f 6e 64 20 63 61 6c 6c 20 74 6f 20 5b  second call to [
1e9b0 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d  sqlite3_reset()]
1e9c0 0a 2a 2a 20 69 6e 20 6f 72 64 65 72 20 74 6f 20  .** in order to 
1e9d0 66 69 6e 64 20 74 68 65 20 75 6e 64 65 72 6c 79  find the underly
1e9e0 69 6e 67 20 63 61 75 73 65 20 6f 66 20 74 68 65  ing cause of the
1e9f0 20 70 72 6f 62 6c 65 6d 2e 20 57 69 74 68 20 74   problem. With t
1ea00 68 65 20 22 76 32 22 20 70 72 65 70 61 72 65 0a  he "v2" prepare.
1ea10 2a 2a 20 69 6e 74 65 72 66 61 63 65 73 2c 20 74  ** interfaces, t
1ea20 68 65 20 75 6e 64 65 72 6c 79 69 6e 67 20 72 65  he underlying re
1ea30 61 73 6f 6e 20 66 6f 72 20 74 68 65 20 65 72 72  ason for the err
1ea40 6f 72 20 69 73 20 72 65 74 75 72 6e 65 64 20 69  or is returned i
1ea50 6d 6d 65 64 69 61 74 65 6c 79 2e 0a 2a 2a 20 3c  mmediately..** <
1ea60 2f 6c 69 3e 0a 2a 2a 0a 2a 2a 20 3c 6c 69 3e 0a  /li>.**.** <li>.
1ea70 2a 2a 20 5e 49 66 20 74 68 65 20 73 70 65 63 69  ** ^If the speci
1ea80 66 69 63 20 76 61 6c 75 65 20 62 6f 75 6e 64 20  fic value bound 
1ea90 74 6f 20 5b 70 61 72 61 6d 65 74 65 72 20 7c 20  to [parameter | 
1eaa0 68 6f 73 74 20 70 61 72 61 6d 65 74 65 72 5d 20  host parameter] 
1eab0 69 6e 20 74 68 65 20 0a 2a 2a 20 57 48 45 52 45  in the .** WHERE
1eac0 20 63 6c 61 75 73 65 20 6d 69 67 68 74 20 69 6e   clause might in
1ead0 66 6c 75 65 6e 63 65 20 74 68 65 20 63 68 6f 69  fluence the choi
1eae0 63 65 20 6f 66 20 71 75 65 72 79 20 70 6c 61 6e  ce of query plan
1eaf0 20 66 6f 72 20 61 20 73 74 61 74 65 6d 65 6e 74   for a statement
1eb00 2c 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20 73 74  ,.** then the st
1eb10 61 74 65 6d 65 6e 74 20 77 69 6c 6c 20 62 65 20  atement will be 
1eb20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 72 65  automatically re
1eb30 63 6f 6d 70 69 6c 65 64 2c 20 61 73 20 69 66 20  compiled, as if 
1eb40 74 68 65 72 65 20 68 61 64 20 62 65 65 6e 20 0a  there had been .
1eb50 2a 2a 20 61 20 73 63 68 65 6d 61 20 63 68 61 6e  ** a schema chan
1eb60 67 65 2c 20 6f 6e 20 74 68 65 20 66 69 72 73 74  ge, on the first
1eb70 20 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28    [sqlite3_step(
1eb80 29 5d 20 63 61 6c 6c 20 66 6f 6c 6c 6f 77 69 6e  )] call followin
1eb90 67 20 61 6e 79 20 63 68 61 6e 67 65 0a 2a 2a 20  g any change.** 
1eba0 74 6f 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  to the [sqlite3_
1ebb0 62 69 6e 64 5f 74 65 78 74 20 7c 20 62 69 6e 64  bind_text | bind
1ebc0 69 6e 67 73 5d 20 6f 66 20 74 68 61 74 20 5b 70  ings] of that [p
1ebd0 61 72 61 6d 65 74 65 72 5d 2e 20 0a 2a 2a 20 5e  arameter]. .** ^
1ebe0 54 68 65 20 73 70 65 63 69 66 69 63 20 76 61 6c  The specific val
1ebf0 75 65 20 6f 66 20 57 48 45 52 45 2d 63 6c 61 75  ue of WHERE-clau
1ec00 73 65 20 5b 70 61 72 61 6d 65 74 65 72 5d 20 6d  se [parameter] m
1ec10 69 67 68 74 20 69 6e 66 6c 75 65 6e 63 65 20 74  ight influence t
1ec20 68 65 20 0a 2a 2a 20 63 68 6f 69 63 65 20 6f 66  he .** choice of
1ec30 20 71 75 65 72 79 20 70 6c 61 6e 20 69 66 20 74   query plan if t
1ec40 68 65 20 70 61 72 61 6d 65 74 65 72 20 69 73 20  he parameter is 
1ec50 74 68 65 20 6c 65 66 74 2d 68 61 6e 64 20 73 69  the left-hand si
1ec60 64 65 20 6f 66 20 61 20 5b 4c 49 4b 45 5d 0a 2a  de of a [LIKE].*
1ec70 2a 20 6f 72 20 5b 47 4c 4f 42 5d 20 6f 70 65 72  * or [GLOB] oper
1ec80 61 74 6f 72 20 6f 72 20 69 66 20 74 68 65 20 70  ator or if the p
1ec90 61 72 61 6d 65 74 65 72 20 69 73 20 63 6f 6d 70  arameter is comp
1eca0 61 72 65 64 20 74 6f 20 61 6e 20 69 6e 64 65 78  ared to an index
1ecb0 65 64 20 63 6f 6c 75 6d 6e 0a 2a 2a 20 61 6e 64  ed column.** and
1ecc0 20 74 68 65 20 5b 53 51 4c 49 54 45 5f 45 4e 41   the [SQLITE_ENA
1ecd0 42 4c 45 5f 53 54 41 54 32 5d 20 63 6f 6d 70 69  BLE_STAT2] compi
1ece0 6c 65 2d 74 69 6d 65 20 6f 70 74 69 6f 6e 20 69  le-time option i
1ecf0 73 20 65 6e 61 62 6c 65 64 2e 0a 2a 2a 20 74 68  s enabled..** th
1ed00 65 20 0a 2a 2a 20 3c 2f 6c 69 3e 0a 2a 2a 20 3c  e .** </li>.** <
1ed10 2f 6f 6c 3e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69  /ol>.*/.int sqli
1ed20 74 65 33 5f 70 72 65 70 61 72 65 28 0a 20 20 73  te3_prepare(.  s
1ed30 71 6c 69 74 65 33 20 2a 64 62 2c 20 20 20 20 20  qlite3 *db,     
1ed40 20 20 20 20 20 20 20 2f 2a 20 44 61 74 61 62 61         /* Databa
1ed50 73 65 20 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 63  se handle */.  c
1ed60 6f 6e 73 74 20 63 68 61 72 20 2a 7a 53 71 6c 2c  onst char *zSql,
1ed70 20 20 20 20 20 20 20 2f 2a 20 53 51 4c 20 73 74         /* SQL st
1ed80 61 74 65 6d 65 6e 74 2c 20 55 54 46 2d 38 20 65  atement, UTF-8 e
1ed90 6e 63 6f 64 65 64 20 2a 2f 0a 20 20 69 6e 74 20  ncoded */.  int 
1eda0 6e 42 79 74 65 2c 20 20 20 20 20 20 20 20 20 20  nByte,          
1edb0 20 20 20 20 2f 2a 20 4d 61 78 69 6d 75 6d 20 6c      /* Maximum l
1edc0 65 6e 67 74 68 20 6f 66 20 7a 53 71 6c 20 69 6e  ength of zSql in
1edd0 20 62 79 74 65 73 2e 20 2a 2f 0a 20 20 73 71 6c   bytes. */.  sql
1ede0 69 74 65 33 5f 73 74 6d 74 20 2a 2a 70 70 53 74  ite3_stmt **ppSt
1edf0 6d 74 2c 20 20 2f 2a 20 4f 55 54 3a 20 53 74 61  mt,  /* OUT: Sta
1ee00 74 65 6d 65 6e 74 20 68 61 6e 64 6c 65 20 2a 2f  tement handle */
1ee10 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 2a  .  const char **
1ee20 70 7a 54 61 69 6c 20 20 20 20 20 2f 2a 20 4f 55  pzTail     /* OU
1ee30 54 3a 20 50 6f 69 6e 74 65 72 20 74 6f 20 75 6e  T: Pointer to un
1ee40 75 73 65 64 20 70 6f 72 74 69 6f 6e 20 6f 66 20  used portion of 
1ee50 7a 53 71 6c 20 2a 2f 0a 29 3b 0a 69 6e 74 20 73  zSql */.);.int s
1ee60 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f 76  qlite3_prepare_v
1ee70 32 28 0a 20 20 73 71 6c 69 74 65 33 20 2a 64 62  2(.  sqlite3 *db
1ee80 2c 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20  ,            /* 
1ee90 44 61 74 61 62 61 73 65 20 68 61 6e 64 6c 65 20  Database handle 
1eea0 2a 2f 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20  */.  const char 
1eeb0 2a 7a 53 71 6c 2c 20 20 20 20 20 20 20 2f 2a 20  *zSql,       /* 
1eec0 53 51 4c 20 73 74 61 74 65 6d 65 6e 74 2c 20 55  SQL statement, U
1eed0 54 46 2d 38 20 65 6e 63 6f 64 65 64 20 2a 2f 0a  TF-8 encoded */.
1eee0 20 20 69 6e 74 20 6e 42 79 74 65 2c 20 20 20 20    int nByte,    
1eef0 20 20 20 20 20 20 20 20 20 20 2f 2a 20 4d 61 78            /* Max
1ef00 69 6d 75 6d 20 6c 65 6e 67 74 68 20 6f 66 20 7a  imum length of z
1ef10 53 71 6c 20 69 6e 20 62 79 74 65 73 2e 20 2a 2f  Sql in bytes. */
1ef20 0a 20 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 20  .  sqlite3_stmt 
1ef30 2a 2a 70 70 53 74 6d 74 2c 20 20 2f 2a 20 4f 55  **ppStmt,  /* OU
1ef40 54 3a 20 53 74 61 74 65 6d 65 6e 74 20 68 61 6e  T: Statement han
1ef50 64 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 63  dle */.  const c
1ef60 68 61 72 20 2a 2a 70 7a 54 61 69 6c 20 20 20 20  har **pzTail    
1ef70 20 2f 2a 20 4f 55 54 3a 20 50 6f 69 6e 74 65 72   /* OUT: Pointer
1ef80 20 74 6f 20 75 6e 75 73 65 64 20 70 6f 72 74 69   to unused porti
1ef90 6f 6e 20 6f 66 20 7a 53 71 6c 20 2a 2f 0a 29 3b  on of zSql */.);
1efa0 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 70 72 65  .int sqlite3_pre
1efb0 70 61 72 65 31 36 28 0a 20 20 73 71 6c 69 74 65  pare16(.  sqlite
1efc0 33 20 2a 64 62 2c 20 20 20 20 20 20 20 20 20 20  3 *db,          
1efd0 20 20 2f 2a 20 44 61 74 61 62 61 73 65 20 68 61    /* Database ha
1efe0 6e 64 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20  ndle */.  const 
1eff0 76 6f 69 64 20 2a 7a 53 71 6c 2c 20 20 20 20 20  void *zSql,     
1f000 20 20 2f 2a 20 53 51 4c 20 73 74 61 74 65 6d 65    /* SQL stateme
1f010 6e 74 2c 20 55 54 46 2d 31 36 20 65 6e 63 6f 64  nt, UTF-16 encod
1f020 65 64 20 2a 2f 0a 20 20 69 6e 74 20 6e 42 79 74  ed */.  int nByt
1f030 65 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20  e,              
1f040 2f 2a 20 4d 61 78 69 6d 75 6d 20 6c 65 6e 67 74  /* Maximum lengt
1f050 68 20 6f 66 20 7a 53 71 6c 20 69 6e 20 62 79 74  h of zSql in byt
1f060 65 73 2e 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33  es. */.  sqlite3
1f070 5f 73 74 6d 74 20 2a 2a 70 70 53 74 6d 74 2c 20  _stmt **ppStmt, 
1f080 20 2f 2a 20 4f 55 54 3a 20 53 74 61 74 65 6d 65   /* OUT: Stateme
1f090 6e 74 20 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 63  nt handle */.  c
1f0a0 6f 6e 73 74 20 76 6f 69 64 20 2a 2a 70 7a 54 61  onst void **pzTa
1f0b0 69 6c 20 20 20 20 20 2f 2a 20 4f 55 54 3a 20 50  il     /* OUT: P
1f0c0 6f 69 6e 74 65 72 20 74 6f 20 75 6e 75 73 65 64  ointer to unused
1f0d0 20 70 6f 72 74 69 6f 6e 20 6f 66 20 7a 53 71 6c   portion of zSql
1f0e0 20 2a 2f 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74   */.);.int sqlit
1f0f0 65 33 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28  e3_prepare16_v2(
1f100 0a 20 20 73 71 6c 69 74 65 33 20 2a 64 62 2c 20  .  sqlite3 *db, 
1f110 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 44 61             /* Da
1f120 74 61 62 61 73 65 20 68 61 6e 64 6c 65 20 2a 2f  tabase handle */
1f130 0a 20 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a 7a  .  const void *z
1f140 53 71 6c 2c 20 20 20 20 20 20 20 2f 2a 20 53 51  Sql,       /* SQ
1f150 4c 20 73 74 61 74 65 6d 65 6e 74 2c 20 55 54 46  L statement, UTF
1f160 2d 31 36 20 65 6e 63 6f 64 65 64 20 2a 2f 0a 20  -16 encoded */. 
1f170 20 69 6e 74 20 6e 42 79 74 65 2c 20 20 20 20 20   int nByte,     
1f180 20 20 20 20 20 20 20 20 20 2f 2a 20 4d 61 78 69           /* Maxi
1f190 6d 75 6d 20 6c 65 6e 67 74 68 20 6f 66 20 7a 53  mum length of zS
1f1a0 71 6c 20 69 6e 20 62 79 74 65 73 2e 20 2a 2f 0a  ql in bytes. */.
1f1b0 20 20 73 71 6c 69 74 65 33 5f 73 74 6d 74 20 2a    sqlite3_stmt *
1f1c0 2a 70 70 53 74 6d 74 2c 20 20 2f 2a 20 4f 55 54  *ppStmt,  /* OUT
1f1d0 3a 20 53 74 61 74 65 6d 65 6e 74 20 68 61 6e 64  : Statement hand
1f1e0 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 76 6f  le */.  const vo
1f1f0 69 64 20 2a 2a 70 7a 54 61 69 6c 20 20 20 20 20  id **pzTail     
1f200 2f 2a 20 4f 55 54 3a 20 50 6f 69 6e 74 65 72 20  /* OUT: Pointer 
1f210 74 6f 20 75 6e 75 73 65 64 20 70 6f 72 74 69 6f  to unused portio
1f220 6e 20 6f 66 20 7a 53 71 6c 20 2a 2f 0a 29 3b 0a  n of zSql */.);.
1f230 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
1f240 20 52 65 74 72 69 65 76 69 6e 67 20 53 74 61 74   Retrieving Stat
1f250 65 6d 65 6e 74 20 53 51 4c 0a 2a 2a 0a 2a 2a 20  ement SQL.**.** 
1f260 5e 54 68 69 73 20 69 6e 74 65 72 66 61 63 65 20  ^This interface 
1f270 63 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20 72  can be used to r
1f280 65 74 72 69 65 76 65 20 61 20 73 61 76 65 64 20  etrieve a saved 
1f290 63 6f 70 79 20 6f 66 20 74 68 65 20 6f 72 69 67  copy of the orig
1f2a0 69 6e 61 6c 0a 2a 2a 20 53 51 4c 20 74 65 78 74  inal.** SQL text
1f2b0 20 75 73 65 64 20 74 6f 20 63 72 65 61 74 65 20   used to create 
1f2c0 61 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74  a [prepared stat
1f2d0 65 6d 65 6e 74 5d 20 69 66 20 74 68 61 74 20 73  ement] if that s
1f2e0 74 61 74 65 6d 65 6e 74 20 77 61 73 0a 2a 2a 20  tatement was.** 
1f2f0 63 6f 6d 70 69 6c 65 64 20 75 73 69 6e 67 20 65  compiled using e
1f300 69 74 68 65 72 20 5b 73 71 6c 69 74 65 33 5f 70  ither [sqlite3_p
1f310 72 65 70 61 72 65 5f 76 32 28 29 5d 20 6f 72 20  repare_v2()] or 
1f320 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65  [sqlite3_prepare
1f330 31 36 5f 76 32 28 29 5d 2e 0a 2a 2f 0a 63 6f 6e  16_v2()]..*/.con
1f340 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33  st char *sqlite3
1f350 5f 73 71 6c 28 73 71 6c 69 74 65 33 5f 73 74 6d  _sql(sqlite3_stm
1f360 74 20 2a 70 53 74 6d 74 29 3b 0a 0a 2f 2a 0a 2a  t *pStmt);../*.*
1f370 2a 20 43 41 50 49 33 52 45 46 3a 20 44 65 74 65  * CAPI3REF: Dete
1f380 72 6d 69 6e 65 20 49 66 20 41 6e 20 53 51 4c 20  rmine If An SQL 
1f390 53 74 61 74 65 6d 65 6e 74 20 57 72 69 74 65 73  Statement Writes
1f3a0 20 54 68 65 20 44 61 74 61 62 61 73 65 0a 2a 2a   The Database.**
1f3b0 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33  .** ^The sqlite3
1f3c0 5f 73 74 6d 74 5f 72 65 61 64 6f 6e 6c 79 28 58  _stmt_readonly(X
1f3d0 29 20 69 6e 74 65 72 66 61 63 65 20 72 65 74 75  ) interface retu
1f3e0 72 6e 73 20 74 72 75 65 20 28 6e 6f 6e 2d 7a 65  rns true (non-ze
1f3f0 72 6f 29 20 69 66 20 0a 2a 2a 20 61 6e 64 20 6f  ro) if .** and o
1f400 6e 6c 79 20 69 66 20 74 68 65 20 5b 70 72 65 70  nly if the [prep
1f410 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20  ared statement] 
1f420 58 20 69 73 20 6d 61 6b 65 73 20 6e 6f 20 64 69  X is makes no di
1f430 72 65 63 74 20 63 68 61 6e 67 65 73 20 74 6f 0a  rect changes to.
1f440 2a 2a 20 74 68 65 20 63 6f 6e 74 65 6e 74 20 6f  ** the content o
1f450 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66  f the database f
1f460 69 6c 65 2e 0a 2a 2a 0a 2a 2a 20 4e 6f 74 65 20  ile..**.** Note 
1f470 74 68 61 74 20 5b 61 70 70 6c 69 63 61 74 69 6f  that [applicatio
1f480 6e 2d 64 65 66 69 6e 65 64 20 53 51 4c 20 66 75  n-defined SQL fu
1f490 6e 63 74 69 6f 6e 73 5d 20 6f 72 0a 2a 2a 20 5b  nctions] or.** [
1f4a0 76 69 72 74 75 61 6c 20 74 61 62 6c 65 73 5d 20  virtual tables] 
1f4b0 6d 69 67 68 74 20 63 68 61 6e 67 65 20 74 68 65  might change the
1f4c0 20 64 61 74 61 62 61 73 65 20 69 6e 64 69 72 65   database indire
1f4d0 63 74 6c 79 20 61 73 20 61 20 73 69 64 65 20 65  ctly as a side e
1f4e0 66 66 65 63 74 2e 20 20 0a 2a 2a 20 5e 28 46 6f  ffect.  .** ^(Fo
1f4f0 72 20 65 78 61 6d 70 6c 65 2c 20 69 66 20 61 6e  r example, if an
1f500 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 64 65 66   application def
1f510 69 6e 65 73 20 61 20 66 75 6e 63 74 69 6f 6e 20  ines a function 
1f520 22 65 76 61 6c 28 29 22 20 74 68 61 74 20 0a 2a  "eval()" that .*
1f530 2a 20 63 61 6c 6c 73 20 5b 73 71 6c 69 74 65 33  * calls [sqlite3
1f540 5f 65 78 65 63 28 29 5d 2c 20 74 68 65 6e 20 74  _exec()], then t
1f550 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 53 51 4c  he following SQL
1f560 20 73 74 61 74 65 6d 65 6e 74 20 77 6f 75 6c 64   statement would
1f570 0a 2a 2a 20 63 68 61 6e 67 65 20 74 68 65 20 64  .** change the d
1f580 61 74 61 62 61 73 65 20 66 69 6c 65 20 74 68 72  atabase file thr
1f590 6f 75 67 68 20 73 69 64 65 2d 65 66 66 65 63 74  ough side-effect
1f5a0 73 3a 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71  s:.**.** <blockq
1f5b0 75 6f 74 65 3e 3c 70 72 65 3e 0a 2a 2a 20 20 20  uote><pre>.**   
1f5c0 20 53 45 4c 45 43 54 20 65 76 61 6c 28 27 44 45   SELECT eval('DE
1f5d0 4c 45 54 45 20 46 52 4f 4d 20 74 31 27 29 20 46  LETE FROM t1') F
1f5e0 52 4f 4d 20 74 32 3b 0a 2a 2a 20 3c 2f 70 72 65  ROM t2;.** </pre
1f5f0 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 2a  ></blockquote>.*
1f600 2a 0a 2a 2a 20 42 75 74 20 62 65 63 61 75 73 65  *.** But because
1f610 20 74 68 65 20 5b 53 45 4c 45 43 54 5d 20 73 74   the [SELECT] st
1f620 61 74 65 6d 65 6e 74 20 64 6f 65 73 20 6e 6f 74  atement does not
1f630 20 63 68 61 6e 67 65 20 74 68 65 20 64 61 74 61   change the data
1f640 62 61 73 65 20 66 69 6c 65 0a 2a 2a 20 64 69 72  base file.** dir
1f650 65 63 74 6c 79 2c 20 73 71 6c 69 74 65 33 5f 73  ectly, sqlite3_s
1f660 74 6d 74 5f 72 65 61 64 6f 6e 6c 79 28 29 20 77  tmt_readonly() w
1f670 6f 75 6c 64 20 73 74 69 6c 6c 20 72 65 74 75 72  ould still retur
1f680 6e 20 74 72 75 65 2e 29 5e 0a 2a 2a 0a 2a 2a 20  n true.)^.**.** 
1f690 5e 54 72 61 6e 73 61 63 74 69 6f 6e 20 63 6f 6e  ^Transaction con
1f6a0 74 72 6f 6c 20 73 74 61 74 65 6d 65 6e 74 73 20  trol statements 
1f6b0 73 75 63 68 20 61 73 20 5b 42 45 47 49 4e 5d 2c  such as [BEGIN],
1f6c0 20 5b 43 4f 4d 4d 49 54 5d 2c 20 5b 52 4f 4c 4c   [COMMIT], [ROLL
1f6d0 42 41 43 4b 5d 2c 0a 2a 2a 20 5b 53 41 56 45 50  BACK],.** [SAVEP
1f6e0 4f 49 4e 54 5d 2c 20 61 6e 64 20 5b 52 45 4c 45  OINT], and [RELE
1f6f0 41 53 45 5d 20 63 61 75 73 65 20 73 71 6c 69 74  ASE] cause sqlit
1f700 65 33 5f 73 74 6d 74 5f 72 65 61 64 6f 6e 6c 79  e3_stmt_readonly
1f710 28 29 20 74 6f 20 72 65 74 75 72 6e 20 74 72 75  () to return tru
1f720 65 2c 0a 2a 2a 20 73 69 6e 63 65 20 74 68 65 20  e,.** since the 
1f730 73 74 61 74 65 6d 65 6e 74 73 20 74 68 65 6d 73  statements thems
1f740 65 6c 76 65 73 20 64 6f 20 6e 6f 74 20 61 63 74  elves do not act
1f750 75 61 6c 6c 79 20 6d 6f 64 69 66 79 20 74 68 65  ually modify the
1f760 20 64 61 74 61 62 61 73 65 20 62 75 74 0a 2a 2a   database but.**
1f770 20 72 61 74 68 65 72 20 74 68 65 79 20 63 6f 6e   rather they con
1f780 74 72 6f 6c 20 74 68 65 20 74 69 6d 69 6e 67 20  trol the timing 
1f790 6f 66 20 77 68 65 6e 20 6f 74 68 65 72 20 73 74  of when other st
1f7a0 61 74 65 6d 65 6e 74 73 20 6d 6f 64 69 66 79 20  atements modify 
1f7b0 74 68 65 20 0a 2a 2a 20 64 61 74 61 62 61 73 65  the .** database
1f7c0 2e 20 20 5e 54 68 65 20 5b 41 54 54 41 43 48 5d  .  ^The [ATTACH]
1f7d0 20 61 6e 64 20 5b 44 45 54 41 43 48 5d 20 73 74   and [DETACH] st
1f7e0 61 74 65 6d 65 6e 74 73 20 61 6c 73 6f 20 63 61  atements also ca
1f7f0 75 73 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 73  use.** sqlite3_s
1f800 74 6d 74 5f 72 65 61 64 6f 6e 6c 79 28 29 20 74  tmt_readonly() t
1f810 6f 20 72 65 74 75 72 6e 20 74 72 75 65 20 73 69  o return true si
1f820 6e 63 65 2c 20 77 68 69 6c 65 20 74 68 6f 73 65  nce, while those
1f830 20 73 74 61 74 65 6d 65 6e 74 73 0a 2a 2a 20 63   statements.** c
1f840 68 61 6e 67 65 20 74 68 65 20 63 6f 6e 66 69 67  hange the config
1f850 75 72 61 74 69 6f 6e 20 6f 66 20 61 20 64 61 74  uration of a dat
1f860 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
1f870 2c 20 74 68 65 79 20 64 6f 20 6e 6f 74 20 6d 61  , they do not ma
1f880 6b 65 20 0a 2a 2a 20 63 68 61 6e 67 65 73 20 74  ke .** changes t
1f890 6f 20 74 68 65 20 63 6f 6e 74 65 6e 74 20 6f 66  o the content of
1f8a0 20 74 68 65 20 64 61 74 61 62 61 73 65 20 66 69   the database fi
1f8b0 6c 65 73 20 6f 6e 20 64 69 73 6b 2e 0a 2a 2f 0a  les on disk..*/.
1f8c0 69 6e 74 20 73 71 6c 69 74 65 33 5f 73 74 6d 74  int sqlite3_stmt
1f8d0 5f 72 65 61 64 6f 6e 6c 79 28 73 71 6c 69 74 65  _readonly(sqlite
1f8e0 33 5f 73 74 6d 74 20 2a 70 53 74 6d 74 29 3b 0a  3_stmt *pStmt);.
1f8f0 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
1f900 20 44 79 6e 61 6d 69 63 61 6c 6c 79 20 54 79 70   Dynamically Typ
1f910 65 64 20 56 61 6c 75 65 20 4f 62 6a 65 63 74 0a  ed Value Object.
1f920 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b 70 72  ** KEYWORDS: {pr
1f930 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f  otected sqlite3_
1f940 76 61 6c 75 65 7d 20 7b 75 6e 70 72 6f 74 65 63  value} {unprotec
1f950 74 65 64 20 73 71 6c 69 74 65 33 5f 76 61 6c 75  ted sqlite3_valu
1f960 65 7d 0a 2a 2a 0a 2a 2a 20 53 51 4c 69 74 65 20  e}.**.** SQLite 
1f970 75 73 65 73 20 74 68 65 20 73 71 6c 69 74 65 33  uses the sqlite3
1f980 5f 76 61 6c 75 65 20 6f 62 6a 65 63 74 20 74 6f  _value object to
1f990 20 72 65 70 72 65 73 65 6e 74 20 61 6c 6c 20 76   represent all v
1f9a0 61 6c 75 65 73 0a 2a 2a 20 74 68 61 74 20 63 61  alues.** that ca
1f9b0 6e 20 62 65 20 73 74 6f 72 65 64 20 69 6e 20 61  n be stored in a
1f9c0 20 64 61 74 61 62 61 73 65 20 74 61 62 6c 65 2e   database table.
1f9d0 20 53 51 4c 69 74 65 20 75 73 65 73 20 64 79 6e   SQLite uses dyn
1f9e0 61 6d 69 63 20 74 79 70 69 6e 67 0a 2a 2a 20 66  amic typing.** f
1f9f0 6f 72 20 74 68 65 20 76 61 6c 75 65 73 20 69 74  or the values it
1fa00 20 73 74 6f 72 65 73 2e 20 20 5e 56 61 6c 75 65   stores.  ^Value
1fa10 73 20 73 74 6f 72 65 64 20 69 6e 20 73 71 6c 69  s stored in sqli
1fa20 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65 63 74  te3_value object
1fa30 73 0a 2a 2a 20 63 61 6e 20 62 65 20 69 6e 74 65  s.** can be inte
1fa40 67 65 72 73 2c 20 66 6c 6f 61 74 69 6e 67 20 70  gers, floating p
1fa50 6f 69 6e 74 20 76 61 6c 75 65 73 2c 20 73 74 72  oint values, str
1fa60 69 6e 67 73 2c 20 42 4c 4f 42 73 2c 20 6f 72 20  ings, BLOBs, or 
1fa70 4e 55 4c 4c 2e 0a 2a 2a 0a 2a 2a 20 41 6e 20 73  NULL..**.** An s
1fa80 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a  qlite3_value obj
1fa90 65 63 74 20 6d 61 79 20 62 65 20 65 69 74 68 65  ect may be eithe
1faa0 72 20 22 70 72 6f 74 65 63 74 65 64 22 20 6f 72  r "protected" or
1fab0 20 22 75 6e 70 72 6f 74 65 63 74 65 64 22 2e 0a   "unprotected"..
1fac0 2a 2a 20 53 6f 6d 65 20 69 6e 74 65 72 66 61 63  ** Some interfac
1fad0 65 73 20 72 65 71 75 69 72 65 20 61 20 70 72 6f  es require a pro
1fae0 74 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76  tected sqlite3_v
1faf0 61 6c 75 65 2e 20 20 4f 74 68 65 72 20 69 6e 74  alue.  Other int
1fb00 65 72 66 61 63 65 73 0a 2a 2a 20 77 69 6c 6c 20  erfaces.** will 
1fb10 61 63 63 65 70 74 20 65 69 74 68 65 72 20 61 20  accept either a 
1fb20 70 72 6f 74 65 63 74 65 64 20 6f 72 20 61 6e 20  protected or an 
1fb30 75 6e 70 72 6f 74 65 63 74 65 64 20 73 71 6c 69  unprotected sqli
1fb40 74 65 33 5f 76 61 6c 75 65 2e 0a 2a 2a 20 45 76  te3_value..** Ev
1fb50 65 72 79 20 69 6e 74 65 72 66 61 63 65 20 74 68  ery interface th
1fb60 61 74 20 61 63 63 65 70 74 73 20 73 71 6c 69 74  at accepts sqlit
1fb70 65 33 5f 76 61 6c 75 65 20 61 72 67 75 6d 65 6e  e3_value argumen
1fb80 74 73 20 73 70 65 63 69 66 69 65 73 0a 2a 2a 20  ts specifies.** 
1fb90 77 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20 69  whether or not i
1fba0 74 20 72 65 71 75 69 72 65 73 20 61 20 70 72 6f  t requires a pro
1fbb0 74 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76  tected sqlite3_v
1fbc0 61 6c 75 65 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20  alue..**.** The 
1fbd0 74 65 72 6d 73 20 22 70 72 6f 74 65 63 74 65 64  terms "protected
1fbe0 22 20 61 6e 64 20 22 75 6e 70 72 6f 74 65 63 74  " and "unprotect
1fbf0 65 64 22 20 72 65 66 65 72 20 74 6f 20 77 68 65  ed" refer to whe
1fc00 74 68 65 72 20 6f 72 20 6e 6f 74 0a 2a 2a 20 61  ther or not.** a
1fc10 20 6d 75 74 65 78 20 69 73 20 68 65 6c 64 2e 20   mutex is held. 
1fc20 20 41 20 69 6e 74 65 72 6e 61 6c 20 6d 75 74 65   A internal mute
1fc30 78 20 69 73 20 68 65 6c 64 20 66 6f 72 20 61 20  x is held for a 
1fc40 70 72 6f 74 65 63 74 65 64 0a 2a 2a 20 73 71 6c  protected.** sql
1fc50 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65 63  ite3_value objec
1fc60 74 20 62 75 74 20 6e 6f 20 6d 75 74 65 78 20 69  t but no mutex i
1fc70 73 20 68 65 6c 64 20 66 6f 72 20 61 6e 20 75 6e  s held for an un
1fc80 70 72 6f 74 65 63 74 65 64 0a 2a 2a 20 73 71 6c  protected.** sql
1fc90 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65 63  ite3_value objec
1fca0 74 2e 20 20 49 66 20 53 51 4c 69 74 65 20 69 73  t.  If SQLite is
1fcb0 20 63 6f 6d 70 69 6c 65 64 20 74 6f 20 62 65 20   compiled to be 
1fcc0 73 69 6e 67 6c 65 2d 74 68 72 65 61 64 65 64 0a  single-threaded.
1fcd0 2a 2a 20 28 77 69 74 68 20 5b 53 51 4c 49 54 45  ** (with [SQLITE
1fce0 5f 54 48 52 45 41 44 53 41 46 45 3d 30 5d 20 61  _THREADSAFE=0] a
1fcf0 6e 64 20 77 69 74 68 20 5b 73 71 6c 69 74 65 33  nd with [sqlite3
1fd00 5f 74 68 72 65 61 64 73 61 66 65 28 29 5d 20 72  _threadsafe()] r
1fd10 65 74 75 72 6e 69 6e 67 20 30 29 0a 2a 2a 20 6f  eturning 0).** o
1fd20 72 20 69 66 20 53 51 4c 69 74 65 20 69 73 20 72  r if SQLite is r
1fd30 75 6e 20 69 6e 20 6f 6e 65 20 6f 66 20 72 65 64  un in one of red
1fd40 75 63 65 64 20 6d 75 74 65 78 20 6d 6f 64 65 73  uced mutex modes
1fd50 20 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 43 4f 4e   .** [SQLITE_CON
1fd60 46 49 47 5f 53 49 4e 47 4c 45 54 48 52 45 41 44  FIG_SINGLETHREAD
1fd70 5d 20 6f 72 20 5b 53 51 4c 49 54 45 5f 43 4f 4e  ] or [SQLITE_CON
1fd80 46 49 47 5f 4d 55 4c 54 49 54 48 52 45 41 44 5d  FIG_MULTITHREAD]
1fd90 0a 2a 2a 20 74 68 65 6e 20 74 68 65 72 65 20 69  .** then there i
1fda0 73 20 6e 6f 20 64 69 73 74 69 6e 63 74 69 6f 6e  s no distinction
1fdb0 20 62 65 74 77 65 65 6e 20 70 72 6f 74 65 63 74   between protect
1fdc0 65 64 20 61 6e 64 20 75 6e 70 72 6f 74 65 63 74  ed and unprotect
1fdd0 65 64 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 76 61  ed.** sqlite3_va
1fde0 6c 75 65 20 6f 62 6a 65 63 74 73 20 61 6e 64 20  lue objects and 
1fdf0 74 68 65 79 20 63 61 6e 20 62 65 20 75 73 65 64  they can be used
1fe00 20 69 6e 74 65 72 63 68 61 6e 67 65 61 62 6c 79   interchangeably
1fe10 2e 20 20 48 6f 77 65 76 65 72 2c 0a 2a 2a 20 66  .  However,.** f
1fe20 6f 72 20 6d 61 78 69 6d 75 6d 20 63 6f 64 65 20  or maximum code 
1fe30 70 6f 72 74 61 62 69 6c 69 74 79 20 69 74 20 69  portability it i
1fe40 73 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 74 68  s recommended th
1fe50 61 74 20 61 70 70 6c 69 63 61 74 69 6f 6e 73 0a  at applications.
1fe60 2a 2a 20 73 74 69 6c 6c 20 6d 61 6b 65 20 74 68  ** still make th
1fe70 65 20 64 69 73 74 69 6e 63 74 69 6f 6e 20 62 65  e distinction be
1fe80 74 77 65 65 6e 20 70 72 6f 74 65 63 74 65 64 20  tween protected 
1fe90 61 6e 64 20 75 6e 70 72 6f 74 65 63 74 65 64 0a  and unprotected.
1fea0 2a 2a 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  ** sqlite3_value
1feb0 20 6f 62 6a 65 63 74 73 20 65 76 65 6e 20 77 68   objects even wh
1fec0 65 6e 20 6e 6f 74 20 73 74 72 69 63 74 6c 79 20  en not strictly 
1fed0 72 65 71 75 69 72 65 64 2e 0a 2a 2a 0a 2a 2a 20  required..**.** 
1fee0 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 76 61 6c  ^The sqlite3_val
1fef0 75 65 20 6f 62 6a 65 63 74 73 20 74 68 61 74 20  ue objects that 
1ff00 61 72 65 20 70 61 73 73 65 64 20 61 73 20 70 61  are passed as pa
1ff10 72 61 6d 65 74 65 72 73 20 69 6e 74 6f 20 74 68  rameters into th
1ff20 65 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e 74 61 74  e.** implementat
1ff30 69 6f 6e 20 6f 66 20 5b 61 70 70 6c 69 63 61 74  ion of [applicat
1ff40 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51 4c 20  ion-defined SQL 
1ff50 66 75 6e 63 74 69 6f 6e 73 5d 20 61 72 65 20 70  functions] are p
1ff60 72 6f 74 65 63 74 65 64 2e 0a 2a 2a 20 5e 54 68  rotected..** ^Th
1ff70 65 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20  e sqlite3_value 
1ff80 6f 62 6a 65 63 74 20 72 65 74 75 72 6e 65 64 20  object returned 
1ff90 62 79 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63  by.** [sqlite3_c
1ffa0 6f 6c 75 6d 6e 5f 76 61 6c 75 65 28 29 5d 20 69  olumn_value()] i
1ffb0 73 20 75 6e 70 72 6f 74 65 63 74 65 64 2e 0a 2a  s unprotected..*
1ffc0 2a 20 55 6e 70 72 6f 74 65 63 74 65 64 20 73 71  * Unprotected sq
1ffd0 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a 65  lite3_value obje
1ffe0 63 74 73 20 6d 61 79 20 6f 6e 6c 79 20 62 65 20  cts may only be 
1fff0 75 73 65 64 20 77 69 74 68 0a 2a 2a 20 5b 73 71  used with.** [sq
20000 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 76 61 6c  lite3_result_val
20010 75 65 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74  ue()] and [sqlit
20020 65 33 5f 62 69 6e 64 5f 76 61 6c 75 65 28 29 5d  e3_bind_value()]
20030 2e 0a 2a 2a 20 54 68 65 20 5b 73 71 6c 69 74 65  ..** The [sqlite
20040 33 5f 76 61 6c 75 65 5f 62 6c 6f 62 20 7c 20 73  3_value_blob | s
20050 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 79 70  qlite3_value_typ
20060 65 28 29 5d 20 66 61 6d 69 6c 79 20 6f 66 0a 2a  e()] family of.*
20070 2a 20 69 6e 74 65 72 66 61 63 65 73 20 72 65 71  * interfaces req
20080 75 69 72 65 20 70 72 6f 74 65 63 74 65 64 20 73  uire protected s
20090 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 6f 62 6a  qlite3_value obj
200a0 65 63 74 73 2e 0a 2a 2f 0a 74 79 70 65 64 65 66  ects..*/.typedef
200b0 20 73 74 72 75 63 74 20 4d 65 6d 20 73 71 6c 69   struct Mem sqli
200c0 74 65 33 5f 76 61 6c 75 65 3b 0a 0a 2f 2a 0a 2a  te3_value;../*.*
200d0 2a 20 43 41 50 49 33 52 45 46 3a 20 53 51 4c 20  * CAPI3REF: SQL 
200e0 46 75 6e 63 74 69 6f 6e 20 43 6f 6e 74 65 78 74  Function Context
200f0 20 4f 62 6a 65 63 74 0a 2a 2a 0a 2a 2a 20 54 68   Object.**.** Th
20100 65 20 63 6f 6e 74 65 78 74 20 69 6e 20 77 68 69  e context in whi
20110 63 68 20 61 6e 20 53 51 4c 20 66 75 6e 63 74 69  ch an SQL functi
20120 6f 6e 20 65 78 65 63 75 74 65 73 20 69 73 20 73  on executes is s
20130 74 6f 72 65 64 20 69 6e 20 61 6e 0a 2a 2a 20 73  tored in an.** s
20140 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 20 6f  qlite3_context o
20150 62 6a 65 63 74 2e 20 20 5e 41 20 70 6f 69 6e 74  bject.  ^A point
20160 65 72 20 74 6f 20 61 6e 20 73 71 6c 69 74 65 33  er to an sqlite3
20170 5f 63 6f 6e 74 65 78 74 20 6f 62 6a 65 63 74 0a  _context object.
20180 2a 2a 20 69 73 20 61 6c 77 61 79 73 20 66 69 72  ** is always fir
20190 73 74 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20  st parameter to 
201a0 5b 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66  [application-def
201b0 69 6e 65 64 20 53 51 4c 20 66 75 6e 63 74 69 6f  ined SQL functio
201c0 6e 73 5d 2e 0a 2a 2a 20 54 68 65 20 61 70 70 6c  ns]..** The appl
201d0 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20  ication-defined 
201e0 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 69 6d 70  SQL function imp
201f0 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 77 69 6c 6c  lementation will
20200 20 70 61 73 73 20 74 68 69 73 0a 2a 2a 20 70 6f   pass this.** po
20210 69 6e 74 65 72 20 74 68 72 6f 75 67 68 20 69 6e  inter through in
20220 74 6f 20 63 61 6c 6c 73 20 74 6f 20 5b 73 71 6c  to calls to [sql
20230 69 74 65 33 5f 72 65 73 75 6c 74 5f 69 6e 74 20  ite3_result_int 
20240 7c 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74  | sqlite3_result
20250 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  ()],.** [sqlite3
20260 5f 61 67 67 72 65 67 61 74 65 5f 63 6f 6e 74 65  _aggregate_conte
20270 78 74 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f  xt()], [sqlite3_
20280 75 73 65 72 5f 64 61 74 61 28 29 5d 2c 0a 2a 2a  user_data()],.**
20290 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78   [sqlite3_contex
202a0 74 5f 64 62 5f 68 61 6e 64 6c 65 28 29 5d 2c 20  t_db_handle()], 
202b0 5b 73 71 6c 69 74 65 33 5f 67 65 74 5f 61 75 78  [sqlite3_get_aux
202c0 64 61 74 61 28 29 5d 2c 0a 2a 2a 20 61 6e 64 2f  data()],.** and/
202d0 6f 72 20 5b 73 71 6c 69 74 65 33 5f 73 65 74 5f  or [sqlite3_set_
202e0 61 75 78 64 61 74 61 28 29 5d 2e 0a 2a 2f 0a 74  auxdata()]..*/.t
202f0 79 70 65 64 65 66 20 73 74 72 75 63 74 20 73 71  ypedef struct sq
20300 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 20 73 71  lite3_context sq
20310 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 3b 0a 0a  lite3_context;..
20320 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
20330 42 69 6e 64 69 6e 67 20 56 61 6c 75 65 73 20 54  Binding Values T
20340 6f 20 50 72 65 70 61 72 65 64 20 53 74 61 74 65  o Prepared State
20350 6d 65 6e 74 73 0a 2a 2a 20 4b 45 59 57 4f 52 44  ments.** KEYWORD
20360 53 3a 20 7b 68 6f 73 74 20 70 61 72 61 6d 65 74  S: {host paramet
20370 65 72 7d 20 7b 68 6f 73 74 20 70 61 72 61 6d 65  er} {host parame
20380 74 65 72 73 7d 20 7b 68 6f 73 74 20 70 61 72 61  ters} {host para
20390 6d 65 74 65 72 20 6e 61 6d 65 7d 0a 2a 2a 20 4b  meter name}.** K
203a0 45 59 57 4f 52 44 53 3a 20 7b 53 51 4c 20 70 61  EYWORDS: {SQL pa
203b0 72 61 6d 65 74 65 72 7d 20 7b 53 51 4c 20 70 61  rameter} {SQL pa
203c0 72 61 6d 65 74 65 72 73 7d 20 7b 70 61 72 61 6d  rameters} {param
203d0 65 74 65 72 20 62 69 6e 64 69 6e 67 7d 0a 2a 2a  eter binding}.**
203e0 0a 2a 2a 20 5e 28 49 6e 20 74 68 65 20 53 51 4c  .** ^(In the SQL
203f0 20 73 74 61 74 65 6d 65 6e 74 20 74 65 78 74 20   statement text 
20400 69 6e 70 75 74 20 74 6f 20 5b 73 71 6c 69 74 65  input to [sqlite
20410 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d 20  3_prepare_v2()] 
20420 61 6e 64 20 69 74 73 20 76 61 72 69 61 6e 74 73  and its variants
20430 2c 0a 2a 2a 20 6c 69 74 65 72 61 6c 73 20 6d 61  ,.** literals ma
20440 79 20 62 65 20 72 65 70 6c 61 63 65 64 20 62 79  y be replaced by
20450 20 61 20 5b 70 61 72 61 6d 65 74 65 72 5d 20 74   a [parameter] t
20460 68 61 74 20 6d 61 74 63 68 65 73 20 6f 6e 65 20  hat matches one 
20470 6f 66 20 66 6f 6c 6c 6f 77 69 6e 67 0a 2a 2a 20  of following.** 
20480 74 65 6d 70 6c 61 74 65 73 3a 0a 2a 2a 0a 2a 2a  templates:.**.**
20490 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20 20 3f   <ul>.** <li>  ?
204a0 0a 2a 2a 20 3c 6c 69 3e 20 20 3f 4e 4e 4e 0a 2a  .** <li>  ?NNN.*
204b0 2a 20 3c 6c 69 3e 20 20 3a 56 56 56 0a 2a 2a 20  * <li>  :VVV.** 
204c0 3c 6c 69 3e 20 20 40 56 56 56 0a 2a 2a 20 3c 6c  <li>  @VVV.** <l
204d0 69 3e 20 20 24 56 56 56 0a 2a 2a 20 3c 2f 75 6c  i>  $VVV.** </ul
204e0 3e 0a 2a 2a 0a 2a 2a 20 49 6e 20 74 68 65 20 74  >.**.** In the t
204f0 65 6d 70 6c 61 74 65 73 20 61 62 6f 76 65 2c 20  emplates above, 
20500 4e 4e 4e 20 72 65 70 72 65 73 65 6e 74 73 20 61  NNN represents a
20510 6e 20 69 6e 74 65 67 65 72 20 6c 69 74 65 72 61  n integer litera
20520 6c 2c 0a 2a 2a 20 61 6e 64 20 56 56 56 20 72 65  l,.** and VVV re
20530 70 72 65 73 65 6e 74 73 20 61 6e 20 61 6c 70 68  presents an alph
20540 61 6e 75 6d 65 72 69 63 20 69 64 65 6e 74 69 66  anumeric identif
20550 69 65 72 2e 29 5e 20 20 5e 54 68 65 20 76 61 6c  ier.)^  ^The val
20560 75 65 73 20 6f 66 20 74 68 65 73 65 0a 2a 2a 20  ues of these.** 
20570 70 61 72 61 6d 65 74 65 72 73 20 28 61 6c 73 6f  parameters (also
20580 20 63 61 6c 6c 65 64 20 22 68 6f 73 74 20 70 61   called "host pa
20590 72 61 6d 65 74 65 72 20 6e 61 6d 65 73 22 20 6f  rameter names" o
205a0 72 20 22 53 51 4c 20 70 61 72 61 6d 65 74 65 72  r "SQL parameter
205b0 73 22 29 0a 2a 2a 20 63 61 6e 20 62 65 20 73 65  s").** can be se
205c0 74 20 75 73 69 6e 67 20 74 68 65 20 73 71 6c 69  t using the sqli
205d0 74 65 33 5f 62 69 6e 64 5f 2a 28 29 20 72 6f 75  te3_bind_*() rou
205e0 74 69 6e 65 73 20 64 65 66 69 6e 65 64 20 68 65  tines defined he
205f0 72 65 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66  re..**.** ^The f
20600 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f  irst argument to
20610 20 74 68 65 20 73 71 6c 69 74 65 33 5f 62 69 6e   the sqlite3_bin
20620 64 5f 2a 28 29 20 72 6f 75 74 69 6e 65 73 20 69  d_*() routines i
20630 73 20 61 6c 77 61 79 73 0a 2a 2a 20 61 20 70 6f  s always.** a po
20640 69 6e 74 65 72 20 74 6f 20 74 68 65 20 5b 73 71  inter to the [sq
20650 6c 69 74 65 33 5f 73 74 6d 74 5d 20 6f 62 6a 65  lite3_stmt] obje
20660 63 74 20 72 65 74 75 72 6e 65 64 20 66 72 6f 6d  ct returned from
20670 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 70 72 65  .** [sqlite3_pre
20680 70 61 72 65 5f 76 32 28 29 5d 20 6f 72 20 69 74  pare_v2()] or it
20690 73 20 76 61 72 69 61 6e 74 73 2e 0a 2a 2a 0a 2a  s variants..**.*
206a0 2a 20 5e 54 68 65 20 73 65 63 6f 6e 64 20 61 72  * ^The second ar
206b0 67 75 6d 65 6e 74 20 69 73 20 74 68 65 20 69 6e  gument is the in
206c0 64 65 78 20 6f 66 20 74 68 65 20 53 51 4c 20 70  dex of the SQL p
206d0 61 72 61 6d 65 74 65 72 20 74 6f 20 62 65 20 73  arameter to be s
206e0 65 74 2e 0a 2a 2a 20 5e 54 68 65 20 6c 65 66 74  et..** ^The left
206f0 6d 6f 73 74 20 53 51 4c 20 70 61 72 61 6d 65 74  most SQL paramet
20700 65 72 20 68 61 73 20 61 6e 20 69 6e 64 65 78 20  er has an index 
20710 6f 66 20 31 2e 20 20 5e 57 68 65 6e 20 74 68 65  of 1.  ^When the
20720 20 73 61 6d 65 20 6e 61 6d 65 64 0a 2a 2a 20 53   same named.** S
20730 51 4c 20 70 61 72 61 6d 65 74 65 72 20 69 73 20  QL parameter is 
20740 75 73 65 64 20 6d 6f 72 65 20 74 68 61 6e 20 6f  used more than o
20750 6e 63 65 2c 20 73 65 63 6f 6e 64 20 61 6e 64 20  nce, second and 
20760 73 75 62 73 65 71 75 65 6e 74 0a 2a 2a 20 6f 63  subsequent.** oc
20770 63 75 72 72 65 6e 63 65 73 20 68 61 76 65 20 74  currences have t
20780 68 65 20 73 61 6d 65 20 69 6e 64 65 78 20 61 73  he same index as
20790 20 74 68 65 20 66 69 72 73 74 20 6f 63 63 75 72   the first occur
207a0 72 65 6e 63 65 2e 0a 2a 2a 20 5e 54 68 65 20 69  rence..** ^The i
207b0 6e 64 65 78 20 66 6f 72 20 6e 61 6d 65 64 20 70  ndex for named p
207c0 61 72 61 6d 65 74 65 72 73 20 63 61 6e 20 62 65  arameters can be
207d0 20 6c 6f 6f 6b 65 64 20 75 70 20 75 73 69 6e 67   looked up using
207e0 20 74 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33   the.** [sqlite3
207f0 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f  _bind_parameter_
20800 69 6e 64 65 78 28 29 5d 20 41 50 49 20 69 66 20  index()] API if 
20810 64 65 73 69 72 65 64 2e 20 20 5e 54 68 65 20 69  desired.  ^The i
20820 6e 64 65 78 0a 2a 2a 20 66 6f 72 20 22 3f 4e 4e  ndex.** for "?NN
20830 4e 22 20 70 61 72 61 6d 65 74 65 72 73 20 69 73  N" parameters is
20840 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20 4e 4e   the value of NN
20850 4e 2e 0a 2a 2a 20 5e 54 68 65 20 4e 4e 4e 20 76  N..** ^The NNN v
20860 61 6c 75 65 20 6d 75 73 74 20 62 65 20 62 65 74  alue must be bet
20870 77 65 65 6e 20 31 20 61 6e 64 20 74 68 65 20 5b  ween 1 and the [
20880 73 71 6c 69 74 65 33 5f 6c 69 6d 69 74 28 29 5d  sqlite3_limit()]
20890 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72 20 5b 53  .** parameter [S
208a0 51 4c 49 54 45 5f 4c 49 4d 49 54 5f 56 41 52 49  QLITE_LIMIT_VARI
208b0 41 42 4c 45 5f 4e 55 4d 42 45 52 5d 20 28 64 65  ABLE_NUMBER] (de
208c0 66 61 75 6c 74 20 76 61 6c 75 65 3a 20 39 39 39  fault value: 999
208d0 29 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 74 68  )..**.** ^The th
208e0 69 72 64 20 61 72 67 75 6d 65 6e 74 20 69 73 20  ird argument is 
208f0 74 68 65 20 76 61 6c 75 65 20 74 6f 20 62 69 6e  the value to bin
20900 64 20 74 6f 20 74 68 65 20 70 61 72 61 6d 65 74  d to the paramet
20910 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 28 49 6e 20 74  er..**.** ^(In t
20920 68 6f 73 65 20 72 6f 75 74 69 6e 65 73 20 74 68  hose routines th
20930 61 74 20 68 61 76 65 20 61 20 66 6f 75 72 74 68  at have a fourth
20940 20 61 72 67 75 6d 65 6e 74 2c 20 69 74 73 20 76   argument, its v
20950 61 6c 75 65 20 69 73 20 74 68 65 0a 2a 2a 20 6e  alue is the.** n
20960 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73 20 69  umber of bytes i
20970 6e 20 74 68 65 20 70 61 72 61 6d 65 74 65 72 2e  n the parameter.
20980 20 20 54 6f 20 62 65 20 63 6c 65 61 72 3a 20 74    To be clear: t
20990 68 65 20 76 61 6c 75 65 20 69 73 20 74 68 65 0a  he value is the.
209a0 2a 2a 20 6e 75 6d 62 65 72 20 6f 66 20 3c 75 3e  ** number of <u>
209b0 62 79 74 65 73 3c 2f 75 3e 20 69 6e 20 74 68 65  bytes</u> in the
209c0 20 76 61 6c 75 65 2c 20 6e 6f 74 20 74 68 65 20   value, not the 
209d0 6e 75 6d 62 65 72 20 6f 66 20 63 68 61 72 61 63  number of charac
209e0 74 65 72 73 2e 29 5e 0a 2a 2a 20 5e 49 66 20 74  ters.)^.** ^If t
209f0 68 65 20 66 6f 75 72 74 68 20 70 61 72 61 6d 65  he fourth parame
20a00 74 65 72 20 69 73 20 6e 65 67 61 74 69 76 65 2c  ter is negative,
20a10 20 74 68 65 20 6c 65 6e 67 74 68 20 6f 66 20 74   the length of t
20a20 68 65 20 73 74 72 69 6e 67 20 69 73 0a 2a 2a 20  he string is.** 
20a30 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 62 79  the number of by
20a40 74 65 73 20 75 70 20 74 6f 20 74 68 65 20 66 69  tes up to the fi
20a50 72 73 74 20 7a 65 72 6f 20 74 65 72 6d 69 6e 61  rst zero termina
20a60 74 6f 72 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  tor..**.** ^The 
20a70 66 69 66 74 68 20 61 72 67 75 6d 65 6e 74 20 74  fifth argument t
20a80 6f 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 62  o sqlite3_bind_b
20a90 6c 6f 62 28 29 2c 20 73 71 6c 69 74 65 33 5f 62  lob(), sqlite3_b
20aa0 69 6e 64 5f 74 65 78 74 28 29 2c 20 61 6e 64 0a  ind_text(), and.
20ab0 2a 2a 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  ** sqlite3_bind_
20ac0 74 65 78 74 31 36 28 29 20 69 73 20 61 20 64 65  text16() is a de
20ad0 73 74 72 75 63 74 6f 72 20 75 73 65 64 20 74 6f  structor used to
20ae0 20 64 69 73 70 6f 73 65 20 6f 66 20 74 68 65 20   dispose of the 
20af0 42 4c 4f 42 20 6f 72 0a 2a 2a 20 73 74 72 69 6e  BLOB or.** strin
20b00 67 20 61 66 74 65 72 20 53 51 4c 69 74 65 20 68  g after SQLite h
20b10 61 73 20 66 69 6e 69 73 68 65 64 20 77 69 74 68  as finished with
20b20 20 69 74 2e 20 20 5e 54 68 65 20 64 65 73 74 72   it.  ^The destr
20b30 75 63 74 6f 72 20 69 73 20 63 61 6c 6c 65 64 0a  uctor is called.
20b40 2a 2a 20 74 6f 20 64 69 73 70 6f 73 65 20 6f 66  ** to dispose of
20b50 20 74 68 65 20 42 4c 4f 42 20 6f 72 20 73 74 72   the BLOB or str
20b60 69 6e 67 20 65 76 65 6e 20 69 66 20 74 68 65 20  ing even if the 
20b70 63 61 6c 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f  call to sqlite3_
20b80 62 69 6e 64 5f 62 6c 6f 62 28 29 2c 0a 2a 2a 20  bind_blob(),.** 
20b90 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 74 65 78  sqlite3_bind_tex
20ba0 74 28 29 2c 20 6f 72 20 73 71 6c 69 74 65 33 5f  t(), or sqlite3_
20bb0 62 69 6e 64 5f 74 65 78 74 31 36 28 29 20 66 61  bind_text16() fa
20bc0 69 6c 73 2e 20 20 0a 2a 2a 20 5e 49 66 20 74 68  ils.  .** ^If th
20bd0 65 20 66 69 66 74 68 20 61 72 67 75 6d 65 6e 74  e fifth argument
20be0 20 69 73 0a 2a 2a 20 74 68 65 20 73 70 65 63 69   is.** the speci
20bf0 61 6c 20 76 61 6c 75 65 20 5b 53 51 4c 49 54 45  al value [SQLITE
20c00 5f 53 54 41 54 49 43 5d 2c 20 74 68 65 6e 20 53  _STATIC], then S
20c10 51 4c 69 74 65 20 61 73 73 75 6d 65 73 20 74 68  QLite assumes th
20c20 61 74 20 74 68 65 0a 2a 2a 20 69 6e 66 6f 72 6d  at the.** inform
20c30 61 74 69 6f 6e 20 69 73 20 69 6e 20 73 74 61 74  ation is in stat
20c40 69 63 2c 20 75 6e 6d 61 6e 61 67 65 64 20 73 70  ic, unmanaged sp
20c50 61 63 65 20 61 6e 64 20 64 6f 65 73 20 6e 6f 74  ace and does not
20c60 20 6e 65 65 64 20 74 6f 20 62 65 20 66 72 65 65   need to be free
20c70 64 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 66 69  d..** ^If the fi
20c80 66 74 68 20 61 72 67 75 6d 65 6e 74 20 68 61 73  fth argument has
20c90 20 74 68 65 20 76 61 6c 75 65 20 5b 53 51 4c 49   the value [SQLI
20ca0 54 45 5f 54 52 41 4e 53 49 45 4e 54 5d 2c 20 74  TE_TRANSIENT], t
20cb0 68 65 6e 0a 2a 2a 20 53 51 4c 69 74 65 20 6d 61  hen.** SQLite ma
20cc0 6b 65 73 20 69 74 73 20 6f 77 6e 20 70 72 69 76  kes its own priv
20cd0 61 74 65 20 63 6f 70 79 20 6f 66 20 74 68 65 20  ate copy of the 
20ce0 64 61 74 61 20 69 6d 6d 65 64 69 61 74 65 6c 79  data immediately
20cf0 2c 20 62 65 66 6f 72 65 0a 2a 2a 20 74 68 65 20  , before.** the 
20d00 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 2a 28 29  sqlite3_bind_*()
20d10 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73   routine returns
20d20 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  ..**.** ^The sql
20d30 69 74 65 33 5f 62 69 6e 64 5f 7a 65 72 6f 62 6c  ite3_bind_zerobl
20d40 6f 62 28 29 20 72 6f 75 74 69 6e 65 20 62 69 6e  ob() routine bin
20d50 64 73 20 61 20 42 4c 4f 42 20 6f 66 20 6c 65 6e  ds a BLOB of len
20d60 67 74 68 20 4e 20 74 68 61 74 0a 2a 2a 20 69 73  gth N that.** is
20d70 20 66 69 6c 6c 65 64 20 77 69 74 68 20 7a 65 72   filled with zer
20d80 6f 65 73 2e 20 20 5e 41 20 7a 65 72 6f 62 6c 6f  oes.  ^A zeroblo
20d90 62 20 75 73 65 73 20 61 20 66 69 78 65 64 20 61  b uses a fixed a
20da0 6d 6f 75 6e 74 20 6f 66 20 6d 65 6d 6f 72 79 0a  mount of memory.
20db0 2a 2a 20 28 6a 75 73 74 20 61 6e 20 69 6e 74 65  ** (just an inte
20dc0 67 65 72 20 74 6f 20 68 6f 6c 64 20 69 74 73 20  ger to hold its 
20dd0 73 69 7a 65 29 20 77 68 69 6c 65 20 69 74 20 69  size) while it i
20de0 73 20 62 65 69 6e 67 20 70 72 6f 63 65 73 73 65  s being processe
20df0 64 2e 0a 2a 2a 20 5a 65 72 6f 62 6c 6f 62 73 20  d..** Zeroblobs 
20e00 61 72 65 20 69 6e 74 65 6e 64 65 64 20 74 6f 20  are intended to 
20e10 73 65 72 76 65 20 61 73 20 70 6c 61 63 65 68 6f  serve as placeho
20e20 6c 64 65 72 73 20 66 6f 72 20 42 4c 4f 42 73 20  lders for BLOBs 
20e30 77 68 6f 73 65 0a 2a 2a 20 63 6f 6e 74 65 6e 74  whose.** content
20e40 20 69 73 20 6c 61 74 65 72 20 77 72 69 74 74 65   is later writte
20e50 6e 20 75 73 69 6e 67 0a 2a 2a 20 5b 73 71 6c 69  n using.** [sqli
20e60 74 65 33 5f 62 6c 6f 62 5f 6f 70 65 6e 20 7c 20  te3_blob_open | 
20e70 69 6e 63 72 65 6d 65 6e 74 61 6c 20 42 4c 4f 42  incremental BLOB
20e80 20 49 2f 4f 5d 20 72 6f 75 74 69 6e 65 73 2e 0a   I/O] routines..
20e90 2a 2a 20 5e 41 20 6e 65 67 61 74 69 76 65 20 76  ** ^A negative v
20ea0 61 6c 75 65 20 66 6f 72 20 74 68 65 20 7a 65 72  alue for the zer
20eb0 6f 62 6c 6f 62 20 72 65 73 75 6c 74 73 20 69 6e  oblob results in
20ec0 20 61 20 7a 65 72 6f 2d 6c 65 6e 67 74 68 20 42   a zero-length B
20ed0 4c 4f 42 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 61  LOB..**.** ^If a
20ee0 6e 79 20 6f 66 20 74 68 65 20 73 71 6c 69 74 65  ny of the sqlite
20ef0 33 5f 62 69 6e 64 5f 2a 28 29 20 72 6f 75 74 69  3_bind_*() routi
20f00 6e 65 73 20 61 72 65 20 63 61 6c 6c 65 64 20 77  nes are called w
20f10 69 74 68 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74  ith a NULL point
20f20 65 72 0a 2a 2a 20 66 6f 72 20 74 68 65 20 5b 70  er.** for the [p
20f30 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e  repared statemen
20f40 74 5d 20 6f 72 20 77 69 74 68 20 61 20 70 72 65  t] or with a pre
20f50 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 20  pared statement 
20f60 66 6f 72 20 77 68 69 63 68 0a 2a 2a 20 5b 73 71  for which.** [sq
20f70 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 68 61  lite3_step()] ha
20f80 73 20 62 65 65 6e 20 63 61 6c 6c 65 64 20 6d 6f  s been called mo
20f90 72 65 20 72 65 63 65 6e 74 6c 79 20 74 68 61 6e  re recently than
20fa0 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28   [sqlite3_reset(
20fb0 29 5d 2c 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20  )],.** then the 
20fc0 63 61 6c 6c 20 77 69 6c 6c 20 72 65 74 75 72 6e  call will return
20fd0 20 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53 45 5d   [SQLITE_MISUSE]
20fe0 2e 20 20 49 66 20 61 6e 79 20 73 71 6c 69 74 65  .  If any sqlite
20ff0 33 5f 62 69 6e 64 5f 28 29 0a 2a 2a 20 72 6f 75  3_bind_().** rou
21000 74 69 6e 65 20 69 73 20 70 61 73 73 65 64 20 61  tine is passed a
21010 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65   [prepared state
21020 6d 65 6e 74 5d 20 74 68 61 74 20 68 61 73 20 62  ment] that has b
21030 65 65 6e 20 66 69 6e 61 6c 69 7a 65 64 2c 20 74  een finalized, t
21040 68 65 0a 2a 2a 20 72 65 73 75 6c 74 20 69 73 20  he.** result is 
21050 75 6e 64 65 66 69 6e 65 64 20 61 6e 64 20 70 72  undefined and pr
21060 6f 62 61 62 6c 79 20 68 61 72 6d 66 75 6c 2e 0a  obably harmful..
21070 2a 2a 0a 2a 2a 20 5e 42 69 6e 64 69 6e 67 73 20  **.** ^Bindings 
21080 61 72 65 20 6e 6f 74 20 63 6c 65 61 72 65 64 20  are not cleared 
21090 62 79 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  by the [sqlite3_
210a0 72 65 73 65 74 28 29 5d 20 72 6f 75 74 69 6e 65  reset()] routine
210b0 2e 0a 2a 2a 20 5e 55 6e 62 6f 75 6e 64 20 70 61  ..** ^Unbound pa
210c0 72 61 6d 65 74 65 72 73 20 61 72 65 20 69 6e 74  rameters are int
210d0 65 72 70 72 65 74 65 64 20 61 73 20 4e 55 4c 4c  erpreted as NULL
210e0 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  ..**.** ^The sql
210f0 69 74 65 33 5f 62 69 6e 64 5f 2a 20 72 6f 75 74  ite3_bind_* rout
21100 69 6e 65 73 20 72 65 74 75 72 6e 20 5b 53 51 4c  ines return [SQL
21110 49 54 45 5f 4f 4b 5d 20 6f 6e 20 73 75 63 63 65  ITE_OK] on succe
21120 73 73 20 6f 72 20 61 6e 0a 2a 2a 20 5b 65 72 72  ss or an.** [err
21130 6f 72 20 63 6f 64 65 5d 20 69 66 20 61 6e 79 74  or code] if anyt
21140 68 69 6e 67 20 67 6f 65 73 20 77 72 6f 6e 67 2e  hing goes wrong.
21150 0a 2a 2a 20 5e 5b 53 51 4c 49 54 45 5f 52 41 4e  .** ^[SQLITE_RAN
21160 47 45 5d 20 69 73 20 72 65 74 75 72 6e 65 64 20  GE] is returned 
21170 69 66 20 74 68 65 20 70 61 72 61 6d 65 74 65 72  if the parameter
21180 0a 2a 2a 20 69 6e 64 65 78 20 69 73 20 6f 75 74  .** index is out
21190 20 6f 66 20 72 61 6e 67 65 2e 20 20 5e 5b 53 51   of range.  ^[SQ
211a0 4c 49 54 45 5f 4e 4f 4d 45 4d 5d 20 69 73 20 72  LITE_NOMEM] is r
211b0 65 74 75 72 6e 65 64 20 69 66 20 6d 61 6c 6c 6f  eturned if mallo
211c0 63 28 29 20 66 61 69 6c 73 2e 0a 2a 2a 0a 2a 2a  c() fails..**.**
211d0 20 53 65 65 20 61 6c 73 6f 3a 20 5b 73 71 6c 69   See also: [sqli
211e0 74 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74  te3_bind_paramet
211f0 65 72 5f 63 6f 75 6e 74 28 29 5d 2c 0a 2a 2a 20  er_count()],.** 
21200 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61  [sqlite3_bind_pa
21210 72 61 6d 65 74 65 72 5f 6e 61 6d 65 28 29 5d 2c  rameter_name()],
21220 20 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 62 69   and [sqlite3_bi
21230 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f 69 6e 64  nd_parameter_ind
21240 65 78 28 29 5d 2e 0a 2a 2f 0a 69 6e 74 20 73 71  ex()]..*/.int sq
21250 6c 69 74 65 33 5f 62 69 6e 64 5f 62 6c 6f 62 28  lite3_bind_blob(
21260 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69  sqlite3_stmt*, i
21270 6e 74 2c 20 63 6f 6e 73 74 20 76 6f 69 64 2a 2c  nt, const void*,
21280 20 69 6e 74 20 6e 2c 20 76 6f 69 64 28 2a 29 28   int n, void(*)(
21290 76 6f 69 64 2a 29 29 3b 0a 69 6e 74 20 73 71 6c  void*));.int sql
212a0 69 74 65 33 5f 62 69 6e 64 5f 64 6f 75 62 6c 65  ite3_bind_double
212b0 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20  (sqlite3_stmt*, 
212c0 69 6e 74 2c 20 64 6f 75 62 6c 65 29 3b 0a 69 6e  int, double);.in
212d0 74 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 69  t sqlite3_bind_i
212e0 6e 74 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a  nt(sqlite3_stmt*
212f0 2c 20 69 6e 74 2c 20 69 6e 74 29 3b 0a 69 6e 74  , int, int);.int
21300 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 69 6e   sqlite3_bind_in
21310 74 36 34 28 73 71 6c 69 74 65 33 5f 73 74 6d 74  t64(sqlite3_stmt
21320 2a 2c 20 69 6e 74 2c 20 73 71 6c 69 74 65 33 5f  *, int, sqlite3_
21330 69 6e 74 36 34 29 3b 0a 69 6e 74 20 73 71 6c 69  int64);.int sqli
21340 74 65 33 5f 62 69 6e 64 5f 6e 75 6c 6c 28 73 71  te3_bind_null(sq
21350 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74  lite3_stmt*, int
21360 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62  );.int sqlite3_b
21370 69 6e 64 5f 74 65 78 74 28 73 71 6c 69 74 65 33  ind_text(sqlite3
21380 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c 20 63 6f 6e  _stmt*, int, con
21390 73 74 20 63 68 61 72 2a 2c 20 69 6e 74 20 6e 2c  st char*, int n,
213a0 20 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a 29 29   void(*)(void*))
213b0 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62 69  ;.int sqlite3_bi
213c0 6e 64 5f 74 65 78 74 31 36 28 73 71 6c 69 74 65  nd_text16(sqlite
213d0 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c 20 63 6f  3_stmt*, int, co
213e0 6e 73 74 20 76 6f 69 64 2a 2c 20 69 6e 74 2c 20  nst void*, int, 
213f0 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a 29 29 3b  void(*)(void*));
21400 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62 69 6e  .int sqlite3_bin
21410 64 5f 76 61 6c 75 65 28 73 71 6c 69 74 65 33 5f  d_value(sqlite3_
21420 73 74 6d 74 2a 2c 20 69 6e 74 2c 20 63 6f 6e 73  stmt*, int, cons
21430 74 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a  t sqlite3_value*
21440 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62  );.int sqlite3_b
21450 69 6e 64 5f 7a 65 72 6f 62 6c 6f 62 28 73 71 6c  ind_zeroblob(sql
21460 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 2c  ite3_stmt*, int,
21470 20 69 6e 74 20 6e 29 3b 0a 0a 2f 2a 0a 2a 2a 20   int n);../*.** 
21480 43 41 50 49 33 52 45 46 3a 20 4e 75 6d 62 65 72  CAPI3REF: Number
21490 20 4f 66 20 53 51 4c 20 50 61 72 61 6d 65 74 65   Of SQL Paramete
214a0 72 73 0a 2a 2a 0a 2a 2a 20 5e 54 68 69 73 20 72  rs.**.** ^This r
214b0 6f 75 74 69 6e 65 20 63 61 6e 20 62 65 20 75 73  outine can be us
214c0 65 64 20 74 6f 20 66 69 6e 64 20 74 68 65 20 6e  ed to find the n
214d0 75 6d 62 65 72 20 6f 66 20 5b 53 51 4c 20 70 61  umber of [SQL pa
214e0 72 61 6d 65 74 65 72 73 5d 0a 2a 2a 20 69 6e 20  rameters].** in 
214f0 61 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74  a [prepared stat
21500 65 6d 65 6e 74 5d 2e 20 20 53 51 4c 20 70 61 72  ement].  SQL par
21510 61 6d 65 74 65 72 73 20 61 72 65 20 74 6f 6b 65  ameters are toke
21520 6e 73 20 6f 66 20 74 68 65 0a 2a 2a 20 66 6f 72  ns of the.** for
21530 6d 20 22 3f 22 2c 20 22 3f 4e 4e 4e 22 2c 20 22  m "?", "?NNN", "
21540 3a 41 41 41 22 2c 20 22 24 41 41 41 22 2c 20 6f  :AAA", "$AAA", o
21550 72 20 22 40 41 41 41 22 20 74 68 61 74 20 73 65  r "@AAA" that se
21560 72 76 65 20 61 73 0a 2a 2a 20 70 6c 61 63 65 68  rve as.** placeh
21570 6f 6c 64 65 72 73 20 66 6f 72 20 76 61 6c 75 65  olders for value
21580 73 20 74 68 61 74 20 61 72 65 20 5b 73 71 6c 69  s that are [sqli
21590 74 65 33 5f 62 69 6e 64 5f 62 6c 6f 62 20 7c 20  te3_bind_blob | 
215a0 62 6f 75 6e 64 5d 0a 2a 2a 20 74 6f 20 74 68 65  bound].** to the
215b0 20 70 61 72 61 6d 65 74 65 72 73 20 61 74 20 61   parameters at a
215c0 20 6c 61 74 65 72 20 74 69 6d 65 2e 0a 2a 2a 0a   later time..**.
215d0 2a 2a 20 5e 28 54 68 69 73 20 72 6f 75 74 69 6e  ** ^(This routin
215e0 65 20 61 63 74 75 61 6c 6c 79 20 72 65 74 75 72  e actually retur
215f0 6e 73 20 74 68 65 20 69 6e 64 65 78 20 6f 66 20  ns the index of 
21600 74 68 65 20 6c 61 72 67 65 73 74 20 28 72 69 67  the largest (rig
21610 68 74 6d 6f 73 74 29 0a 2a 2a 20 70 61 72 61 6d  htmost).** param
21620 65 74 65 72 2e 20 46 6f 72 20 61 6c 6c 20 66 6f  eter. For all fo
21630 72 6d 73 20 65 78 63 65 70 74 20 3f 4e 4e 4e 2c  rms except ?NNN,
21640 20 74 68 69 73 20 77 69 6c 6c 20 63 6f 72 72 65   this will corre
21650 73 70 6f 6e 64 20 74 6f 20 74 68 65 0a 2a 2a 20  spond to the.** 
21660 6e 75 6d 62 65 72 20 6f 66 20 75 6e 69 71 75 65  number of unique
21670 20 70 61 72 61 6d 65 74 65 72 73 2e 20 20 49 66   parameters.  If
21680 20 70 61 72 61 6d 65 74 65 72 73 20 6f 66 20 74   parameters of t
21690 68 65 20 3f 4e 4e 4e 20 66 6f 72 6d 20 61 72 65  he ?NNN form are
216a0 20 75 73 65 64 2c 0a 2a 2a 20 74 68 65 72 65 20   used,.** there 
216b0 6d 61 79 20 62 65 20 67 61 70 73 20 69 6e 20 74  may be gaps in t
216c0 68 65 20 6c 69 73 74 2e 29 5e 0a 2a 2a 0a 2a 2a  he list.)^.**.**
216d0 20 53 65 65 20 61 6c 73 6f 3a 20 5b 73 71 6c 69   See also: [sqli
216e0 74 65 33 5f 62 69 6e 64 5f 62 6c 6f 62 7c 73 71  te3_bind_blob|sq
216f0 6c 69 74 65 33 5f 62 69 6e 64 28 29 5d 2c 0a 2a  lite3_bind()],.*
21700 2a 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  * [sqlite3_bind_
21710 70 61 72 61 6d 65 74 65 72 5f 6e 61 6d 65 28 29  parameter_name()
21720 5d 2c 20 61 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74  ], and.** [sqlit
21730 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65  e3_bind_paramete
21740 72 5f 69 6e 64 65 78 28 29 5d 2e 0a 2a 2f 0a 69  r_index()]..*/.i
21750 6e 74 20 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f  nt sqlite3_bind_
21760 70 61 72 61 6d 65 74 65 72 5f 63 6f 75 6e 74 28  parameter_count(
21770 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 29 3b 0a  sqlite3_stmt*);.
21780 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
21790 20 4e 61 6d 65 20 4f 66 20 41 20 48 6f 73 74 20   Name Of A Host 
217a0 50 61 72 61 6d 65 74 65 72 0a 2a 2a 0a 2a 2a 20  Parameter.**.** 
217b0 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 62 69 6e  ^The sqlite3_bin
217c0 64 5f 70 61 72 61 6d 65 74 65 72 5f 6e 61 6d 65  d_parameter_name
217d0 28 50 2c 4e 29 20 69 6e 74 65 72 66 61 63 65 20  (P,N) interface 
217e0 72 65 74 75 72 6e 73 0a 2a 2a 20 74 68 65 20 6e  returns.** the n
217f0 61 6d 65 20 6f 66 20 74 68 65 20 4e 2d 74 68 20  ame of the N-th 
21800 5b 53 51 4c 20 70 61 72 61 6d 65 74 65 72 5d 20  [SQL parameter] 
21810 69 6e 20 74 68 65 20 5b 70 72 65 70 61 72 65 64  in the [prepared
21820 20 73 74 61 74 65 6d 65 6e 74 5d 20 50 2e 0a 2a   statement] P..*
21830 2a 20 5e 28 53 51 4c 20 70 61 72 61 6d 65 74 65  * ^(SQL paramete
21840 72 73 20 6f 66 20 74 68 65 20 66 6f 72 6d 20 22  rs of the form "
21850 3f 4e 4e 4e 22 20 6f 72 20 22 3a 41 41 41 22 20  ?NNN" or ":AAA" 
21860 6f 72 20 22 40 41 41 41 22 20 6f 72 20 22 24 41  or "@AAA" or "$A
21870 41 41 22 0a 2a 2a 20 68 61 76 65 20 61 20 6e 61  AA".** have a na
21880 6d 65 20 77 68 69 63 68 20 69 73 20 74 68 65 20  me which is the 
21890 73 74 72 69 6e 67 20 22 3f 4e 4e 4e 22 20 6f 72  string "?NNN" or
218a0 20 22 3a 41 41 41 22 20 6f 72 20 22 40 41 41 41   ":AAA" or "@AAA
218b0 22 20 6f 72 20 22 24 41 41 41 22 0a 2a 2a 20 72  " or "$AAA".** r
218c0 65 73 70 65 63 74 69 76 65 6c 79 2e 0a 2a 2a 20  espectively..** 
218d0 49 6e 20 6f 74 68 65 72 20 77 6f 72 64 73 2c 20  In other words, 
218e0 74 68 65 20 69 6e 69 74 69 61 6c 20 22 3a 22 20  the initial ":" 
218f0 6f 72 20 22 24 22 20 6f 72 20 22 40 22 20 6f 72  or "$" or "@" or
21900 20 22 3f 22 0a 2a 2a 20 69 73 20 69 6e 63 6c 75   "?".** is inclu
21910 64 65 64 20 61 73 20 70 61 72 74 20 6f 66 20 74  ded as part of t
21920 68 65 20 6e 61 6d 65 2e 29 5e 0a 2a 2a 20 5e 50  he name.)^.** ^P
21930 61 72 61 6d 65 74 65 72 73 20 6f 66 20 74 68 65  arameters of the
21940 20 66 6f 72 6d 20 22 3f 22 20 77 69 74 68 6f 75   form "?" withou
21950 74 20 61 20 66 6f 6c 6c 6f 77 69 6e 67 20 69 6e  t a following in
21960 74 65 67 65 72 20 68 61 76 65 20 6e 6f 20 6e 61  teger have no na
21970 6d 65 0a 2a 2a 20 61 6e 64 20 61 72 65 20 72 65  me.** and are re
21980 66 65 72 72 65 64 20 74 6f 20 61 73 20 22 6e 61  ferred to as "na
21990 6d 65 6c 65 73 73 22 20 6f 72 20 22 61 6e 6f 6e  meless" or "anon
219a0 79 6d 6f 75 73 20 70 61 72 61 6d 65 74 65 72 73  ymous parameters
219b0 22 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66 69  "..**.** ^The fi
219c0 72 73 74 20 68 6f 73 74 20 70 61 72 61 6d 65 74  rst host paramet
219d0 65 72 20 68 61 73 20 61 6e 20 69 6e 64 65 78 20  er has an index 
219e0 6f 66 20 31 2c 20 6e 6f 74 20 30 2e 0a 2a 2a 0a  of 1, not 0..**.
219f0 2a 2a 20 5e 49 66 20 74 68 65 20 76 61 6c 75 65  ** ^If the value
21a00 20 4e 20 69 73 20 6f 75 74 20 6f 66 20 72 61 6e   N is out of ran
21a10 67 65 20 6f 72 20 69 66 20 74 68 65 20 4e 2d 74  ge or if the N-t
21a20 68 20 70 61 72 61 6d 65 74 65 72 20 69 73 0a 2a  h parameter is.*
21a30 2a 20 6e 61 6d 65 6c 65 73 73 2c 20 74 68 65 6e  * nameless, then
21a40 20 4e 55 4c 4c 20 69 73 20 72 65 74 75 72 6e 65   NULL is returne
21a50 64 2e 20 20 5e 54 68 65 20 72 65 74 75 72 6e 65  d.  ^The returne
21a60 64 20 73 74 72 69 6e 67 20 69 73 0a 2a 2a 20 61  d string is.** a
21a70 6c 77 61 79 73 20 69 6e 20 55 54 46 2d 38 20 65  lways in UTF-8 e
21a80 6e 63 6f 64 69 6e 67 20 65 76 65 6e 20 69 66 20  ncoding even if 
21a90 74 68 65 20 6e 61 6d 65 64 20 70 61 72 61 6d 65  the named parame
21aa0 74 65 72 20 77 61 73 0a 2a 2a 20 6f 72 69 67 69  ter was.** origi
21ab0 6e 61 6c 6c 79 20 73 70 65 63 69 66 69 65 64 20  nally specified 
21ac0 61 73 20 55 54 46 2d 31 36 20 69 6e 20 5b 73 71  as UTF-16 in [sq
21ad0 6c 69 74 65 33 5f 70 72 65 70 61 72 65 31 36 28  lite3_prepare16(
21ae0 29 5d 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69 74 65  )] or.** [sqlite
21af0 33 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28 29  3_prepare16_v2()
21b00 5d 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73  ]..**.** See als
21b10 6f 3a 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64  o: [sqlite3_bind
21b20 5f 62 6c 6f 62 7c 73 71 6c 69 74 65 33 5f 62 69  _blob|sqlite3_bi
21b30 6e 64 28 29 5d 2c 0a 2a 2a 20 5b 73 71 6c 69 74  nd()],.** [sqlit
21b40 65 33 5f 62 69 6e 64 5f 70 61 72 61 6d 65 74 65  e3_bind_paramete
21b50 72 5f 63 6f 75 6e 74 28 29 5d 2c 20 61 6e 64 0a  r_count()], and.
21b60 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e 64  ** [sqlite3_bind
21b70 5f 70 61 72 61 6d 65 74 65 72 5f 69 6e 64 65 78  _parameter_index
21b80 28 29 5d 2e 0a 2a 2f 0a 63 6f 6e 73 74 20 63 68  ()]..*/.const ch
21b90 61 72 20 2a 73 71 6c 69 74 65 33 5f 62 69 6e 64  ar *sqlite3_bind
21ba0 5f 70 61 72 61 6d 65 74 65 72 5f 6e 61 6d 65 28  _parameter_name(
21bb0 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69  sqlite3_stmt*, i
21bc0 6e 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  nt);../*.** CAPI
21bd0 33 52 45 46 3a 20 49 6e 64 65 78 20 4f 66 20 41  3REF: Index Of A
21be0 20 50 61 72 61 6d 65 74 65 72 20 57 69 74 68 20   Parameter With 
21bf0 41 20 47 69 76 65 6e 20 4e 61 6d 65 0a 2a 2a 0a  A Given Name.**.
21c00 2a 2a 20 5e 52 65 74 75 72 6e 20 74 68 65 20 69  ** ^Return the i
21c10 6e 64 65 78 20 6f 66 20 61 6e 20 53 51 4c 20 70  ndex of an SQL p
21c20 61 72 61 6d 65 74 65 72 20 67 69 76 65 6e 20 69  arameter given i
21c30 74 73 20 6e 61 6d 65 2e 20 20 5e 54 68 65 0a 2a  ts name.  ^The.*
21c40 2a 20 69 6e 64 65 78 20 76 61 6c 75 65 20 72 65  * index value re
21c50 74 75 72 6e 65 64 20 69 73 20 73 75 69 74 61 62  turned is suitab
21c60 6c 65 20 66 6f 72 20 75 73 65 20 61 73 20 74 68  le for use as th
21c70 65 20 73 65 63 6f 6e 64 0a 2a 2a 20 70 61 72 61  e second.** para
21c80 6d 65 74 65 72 20 74 6f 20 5b 73 71 6c 69 74 65  meter to [sqlite
21c90 33 5f 62 69 6e 64 5f 62 6c 6f 62 7c 73 71 6c 69  3_bind_blob|sqli
21ca0 74 65 33 5f 62 69 6e 64 28 29 5d 2e 20 20 5e 41  te3_bind()].  ^A
21cb0 20 7a 65 72 6f 0a 2a 2a 20 69 73 20 72 65 74 75   zero.** is retu
21cc0 72 6e 65 64 20 69 66 20 6e 6f 20 6d 61 74 63 68  rned if no match
21cd0 69 6e 67 20 70 61 72 61 6d 65 74 65 72 20 69 73  ing parameter is
21ce0 20 66 6f 75 6e 64 2e 20 20 5e 54 68 65 20 70 61   found.  ^The pa
21cf0 72 61 6d 65 74 65 72 0a 2a 2a 20 6e 61 6d 65 20  rameter.** name 
21d00 6d 75 73 74 20 62 65 20 67 69 76 65 6e 20 69 6e  must be given in
21d10 20 55 54 46 2d 38 20 65 76 65 6e 20 69 66 20 74   UTF-8 even if t
21d20 68 65 20 6f 72 69 67 69 6e 61 6c 20 73 74 61 74  he original stat
21d30 65 6d 65 6e 74 0a 2a 2a 20 77 61 73 20 70 72 65  ement.** was pre
21d40 70 61 72 65 64 20 66 72 6f 6d 20 55 54 46 2d 31  pared from UTF-1
21d50 36 20 74 65 78 74 20 75 73 69 6e 67 20 5b 73 71  6 text using [sq
21d60 6c 69 74 65 33 5f 70 72 65 70 61 72 65 31 36 5f  lite3_prepare16_
21d70 76 32 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 53 65 65  v2()]..**.** See
21d80 20 61 6c 73 6f 3a 20 5b 73 71 6c 69 74 65 33 5f   also: [sqlite3_
21d90 62 69 6e 64 5f 62 6c 6f 62 7c 73 71 6c 69 74 65  bind_blob|sqlite
21da0 33 5f 62 69 6e 64 28 29 5d 2c 0a 2a 2a 20 5b 73  3_bind()],.** [s
21db0 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61 72 61  qlite3_bind_para
21dc0 6d 65 74 65 72 5f 63 6f 75 6e 74 28 29 5d 2c 20  meter_count()], 
21dd0 61 6e 64 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  and.** [sqlite3_
21de0 62 69 6e 64 5f 70 61 72 61 6d 65 74 65 72 5f 69  bind_parameter_i
21df0 6e 64 65 78 28 29 5d 2e 0a 2a 2f 0a 69 6e 74 20  ndex()]..*/.int 
21e00 73 71 6c 69 74 65 33 5f 62 69 6e 64 5f 70 61 72  sqlite3_bind_par
21e10 61 6d 65 74 65 72 5f 69 6e 64 65 78 28 73 71 6c  ameter_index(sql
21e20 69 74 65 33 5f 73 74 6d 74 2a 2c 20 63 6f 6e 73  ite3_stmt*, cons
21e30 74 20 63 68 61 72 20 2a 7a 4e 61 6d 65 29 3b 0a  t char *zName);.
21e40 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
21e50 20 52 65 73 65 74 20 41 6c 6c 20 42 69 6e 64 69   Reset All Bindi
21e60 6e 67 73 20 4f 6e 20 41 20 50 72 65 70 61 72 65  ngs On A Prepare
21e70 64 20 53 74 61 74 65 6d 65 6e 74 0a 2a 2a 0a 2a  d Statement.**.*
21e80 2a 20 5e 43 6f 6e 74 72 61 72 79 20 74 6f 20 74  * ^Contrary to t
21e90 68 65 20 69 6e 74 75 69 74 69 6f 6e 20 6f 66 20  he intuition of 
21ea0 6d 61 6e 79 2c 20 5b 73 71 6c 69 74 65 33 5f 72  many, [sqlite3_r
21eb0 65 73 65 74 28 29 5d 20 64 6f 65 73 20 6e 6f 74  eset()] does not
21ec0 20 72 65 73 65 74 0a 2a 2a 20 74 68 65 20 5b 73   reset.** the [s
21ed0 71 6c 69 74 65 33 5f 62 69 6e 64 5f 62 6c 6f 62  qlite3_bind_blob
21ee0 20 7c 20 62 69 6e 64 69 6e 67 73 5d 20 6f 6e 20   | bindings] on 
21ef0 61 20 5b 70 72 65 70 61 72 65 64 20 73 74 61 74  a [prepared stat
21f00 65 6d 65 6e 74 5d 2e 0a 2a 2a 20 5e 55 73 65 20  ement]..** ^Use 
21f10 74 68 69 73 20 72 6f 75 74 69 6e 65 20 74 6f 20  this routine to 
21f20 72 65 73 65 74 20 61 6c 6c 20 68 6f 73 74 20 70  reset all host p
21f30 61 72 61 6d 65 74 65 72 73 20 74 6f 20 4e 55 4c  arameters to NUL
21f40 4c 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  L..*/.int sqlite
21f50 33 5f 63 6c 65 61 72 5f 62 69 6e 64 69 6e 67 73  3_clear_bindings
21f60 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 29 3b  (sqlite3_stmt*);
21f70 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
21f80 3a 20 4e 75 6d 62 65 72 20 4f 66 20 43 6f 6c 75  : Number Of Colu
21f90 6d 6e 73 20 49 6e 20 41 20 52 65 73 75 6c 74 20  mns In A Result 
21fa0 53 65 74 0a 2a 2a 0a 2a 2a 20 5e 52 65 74 75 72  Set.**.** ^Retur
21fb0 6e 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20  n the number of 
21fc0 63 6f 6c 75 6d 6e 73 20 69 6e 20 74 68 65 20 72  columns in the r
21fd0 65 73 75 6c 74 20 73 65 74 20 72 65 74 75 72 6e  esult set return
21fe0 65 64 20 62 79 20 74 68 65 0a 2a 2a 20 5b 70 72  ed by the.** [pr
21ff0 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
22000 5d 2e 20 5e 54 68 69 73 20 72 6f 75 74 69 6e 65  ]. ^This routine
22010 20 72 65 74 75 72 6e 73 20 30 20 69 66 20 70 53   returns 0 if pS
22020 74 6d 74 20 69 73 20 61 6e 20 53 51 4c 0a 2a 2a  tmt is an SQL.**
22030 20 73 74 61 74 65 6d 65 6e 74 20 74 68 61 74 20   statement that 
22040 64 6f 65 73 20 6e 6f 74 20 72 65 74 75 72 6e 20  does not return 
22050 64 61 74 61 20 28 66 6f 72 20 65 78 61 6d 70 6c  data (for exampl
22060 65 20 61 6e 20 5b 55 50 44 41 54 45 5d 29 2e 0a  e an [UPDATE])..
22070 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 3a 20  **.** See also: 
22080 5b 73 71 6c 69 74 65 33 5f 64 61 74 61 5f 63 6f  [sqlite3_data_co
22090 75 6e 74 28 29 5d 0a 2a 2f 0a 69 6e 74 20 73 71  unt()].*/.int sq
220a0 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 63 6f 75  lite3_column_cou
220b0 6e 74 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 20  nt(sqlite3_stmt 
220c0 2a 70 53 74 6d 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20  *pStmt);../*.** 
220d0 43 41 50 49 33 52 45 46 3a 20 43 6f 6c 75 6d 6e  CAPI3REF: Column
220e0 20 4e 61 6d 65 73 20 49 6e 20 41 20 52 65 73 75   Names In A Resu
220f0 6c 74 20 53 65 74 0a 2a 2a 0a 2a 2a 20 5e 54 68  lt Set.**.** ^Th
22100 65 73 65 20 72 6f 75 74 69 6e 65 73 20 72 65 74  ese routines ret
22110 75 72 6e 20 74 68 65 20 6e 61 6d 65 20 61 73 73  urn the name ass
22120 69 67 6e 65 64 20 74 6f 20 61 20 70 61 72 74 69  igned to a parti
22130 63 75 6c 61 72 20 63 6f 6c 75 6d 6e 0a 2a 2a 20  cular column.** 
22140 69 6e 20 74 68 65 20 72 65 73 75 6c 74 20 73 65  in the result se
22150 74 20 6f 66 20 61 20 5b 53 45 4c 45 43 54 5d 20  t of a [SELECT] 
22160 73 74 61 74 65 6d 65 6e 74 2e 20 20 5e 54 68 65  statement.  ^The
22170 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
22180 6e 61 6d 65 28 29 0a 2a 2a 20 69 6e 74 65 72 66  name().** interf
22190 61 63 65 20 72 65 74 75 72 6e 73 20 61 20 70 6f  ace returns a po
221a0 69 6e 74 65 72 20 74 6f 20 61 20 7a 65 72 6f 2d  inter to a zero-
221b0 74 65 72 6d 69 6e 61 74 65 64 20 55 54 46 2d 38  terminated UTF-8
221c0 20 73 74 72 69 6e 67 0a 2a 2a 20 61 6e 64 20 73   string.** and s
221d0 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6e 61  qlite3_column_na
221e0 6d 65 31 36 28 29 20 72 65 74 75 72 6e 73 20 61  me16() returns a
221f0 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20 7a 65   pointer to a ze
22200 72 6f 2d 74 65 72 6d 69 6e 61 74 65 64 0a 2a 2a  ro-terminated.**
22210 20 55 54 46 2d 31 36 20 73 74 72 69 6e 67 2e 20   UTF-16 string. 
22220 20 5e 54 68 65 20 66 69 72 73 74 20 70 61 72 61   ^The first para
22230 6d 65 74 65 72 20 69 73 20 74 68 65 20 5b 70 72  meter is the [pr
22240 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
22250 5d 0a 2a 2a 20 74 68 61 74 20 69 6d 70 6c 65 6d  ].** that implem
22260 65 6e 74 73 20 74 68 65 20 5b 53 45 4c 45 43 54  ents the [SELECT
22270 5d 20 73 74 61 74 65 6d 65 6e 74 2e 20 5e 54 68  ] statement. ^Th
22280 65 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74  e second paramet
22290 65 72 20 69 73 20 74 68 65 0a 2a 2a 20 63 6f 6c  er is the.** col
222a0 75 6d 6e 20 6e 75 6d 62 65 72 2e 20 20 5e 54 68  umn number.  ^Th
222b0 65 20 6c 65 66 74 6d 6f 73 74 20 63 6f 6c 75 6d  e leftmost colum
222c0 6e 20 69 73 20 6e 75 6d 62 65 72 20 30 2e 0a 2a  n is number 0..*
222d0 2a 0a 2a 2a 20 5e 54 68 65 20 72 65 74 75 72 6e  *.** ^The return
222e0 65 64 20 73 74 72 69 6e 67 20 70 6f 69 6e 74 65  ed string pointe
222f0 72 20 69 73 20 76 61 6c 69 64 20 75 6e 74 69 6c  r is valid until
22300 20 65 69 74 68 65 72 20 74 68 65 20 5b 70 72 65   either the [pre
22310 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d  pared statement]
22320 0a 2a 2a 20 69 73 20 64 65 73 74 72 6f 79 65 64  .** is destroyed
22330 20 62 79 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e   by [sqlite3_fin
22340 61 6c 69 7a 65 28 29 5d 20 6f 72 20 75 6e 74 69  alize()] or unti
22350 6c 20 74 68 65 20 6e 65 78 74 20 63 61 6c 6c 20  l the next call 
22360 74 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63 6f  to.** sqlite3_co
22370 6c 75 6d 6e 5f 6e 61 6d 65 28 29 20 6f 72 20 73  lumn_name() or s
22380 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6e 61  qlite3_column_na
22390 6d 65 31 36 28 29 20 6f 6e 20 74 68 65 20 73 61  me16() on the sa
223a0 6d 65 20 63 6f 6c 75 6d 6e 2e 0a 2a 2a 0a 2a 2a  me column..**.**
223b0 20 5e 49 66 20 73 71 6c 69 74 65 33 5f 6d 61 6c   ^If sqlite3_mal
223c0 6c 6f 63 28 29 20 66 61 69 6c 73 20 64 75 72 69  loc() fails duri
223d0 6e 67 20 74 68 65 20 70 72 6f 63 65 73 73 69 6e  ng the processin
223e0 67 20 6f 66 20 65 69 74 68 65 72 20 72 6f 75 74  g of either rout
223f0 69 6e 65 0a 2a 2a 20 28 66 6f 72 20 65 78 61 6d  ine.** (for exam
22400 70 6c 65 20 64 75 72 69 6e 67 20 61 20 63 6f 6e  ple during a con
22410 76 65 72 73 69 6f 6e 20 66 72 6f 6d 20 55 54 46  version from UTF
22420 2d 38 20 74 6f 20 55 54 46 2d 31 36 29 20 74 68  -8 to UTF-16) th
22430 65 6e 20 61 0a 2a 2a 20 4e 55 4c 4c 20 70 6f 69  en a.** NULL poi
22440 6e 74 65 72 20 69 73 20 72 65 74 75 72 6e 65 64  nter is returned
22450 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 6e 61 6d  ..**.** ^The nam
22460 65 20 6f 66 20 61 20 72 65 73 75 6c 74 20 63 6f  e of a result co
22470 6c 75 6d 6e 20 69 73 20 74 68 65 20 76 61 6c 75  lumn is the valu
22480 65 20 6f 66 20 74 68 65 20 22 41 53 22 20 63 6c  e of the "AS" cl
22490 61 75 73 65 20 66 6f 72 0a 2a 2a 20 74 68 61 74  ause for.** that
224a0 20 63 6f 6c 75 6d 6e 2c 20 69 66 20 74 68 65 72   column, if ther
224b0 65 20 69 73 20 61 6e 20 41 53 20 63 6c 61 75 73  e is an AS claus
224c0 65 2e 20 20 49 66 20 74 68 65 72 65 20 69 73 20  e.  If there is 
224d0 6e 6f 20 41 53 20 63 6c 61 75 73 65 0a 2a 2a 20  no AS clause.** 
224e0 74 68 65 6e 20 74 68 65 20 6e 61 6d 65 20 6f 66  then the name of
224f0 20 74 68 65 20 63 6f 6c 75 6d 6e 20 69 73 20 75   the column is u
22500 6e 73 70 65 63 69 66 69 65 64 20 61 6e 64 20 6d  nspecified and m
22510 61 79 20 63 68 61 6e 67 65 20 66 72 6f 6d 0a 2a  ay change from.*
22520 2a 20 6f 6e 65 20 72 65 6c 65 61 73 65 20 6f 66  * one release of
22530 20 53 51 4c 69 74 65 20 74 6f 20 74 68 65 20 6e   SQLite to the n
22540 65 78 74 2e 0a 2a 2f 0a 63 6f 6e 73 74 20 63 68  ext..*/.const ch
22550 61 72 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75  ar *sqlite3_colu
22560 6d 6e 5f 6e 61 6d 65 28 73 71 6c 69 74 65 33 5f  mn_name(sqlite3_
22570 73 74 6d 74 2a 2c 20 69 6e 74 20 4e 29 3b 0a 63  stmt*, int N);.c
22580 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c 69 74  onst void *sqlit
22590 65 33 5f 63 6f 6c 75 6d 6e 5f 6e 61 6d 65 31 36  e3_column_name16
225a0 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20  (sqlite3_stmt*, 
225b0 69 6e 74 20 4e 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43  int N);../*.** C
225c0 41 50 49 33 52 45 46 3a 20 53 6f 75 72 63 65 20  API3REF: Source 
225d0 4f 66 20 44 61 74 61 20 49 6e 20 41 20 51 75 65  Of Data In A Que
225e0 72 79 20 52 65 73 75 6c 74 0a 2a 2a 0a 2a 2a 20  ry Result.**.** 
225f0 5e 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20  ^These routines 
22600 70 72 6f 76 69 64 65 20 61 20 6d 65 61 6e 73 20  provide a means 
22610 74 6f 20 64 65 74 65 72 6d 69 6e 65 20 74 68 65  to determine the
22620 20 64 61 74 61 62 61 73 65 2c 20 74 61 62 6c 65   database, table
22630 2c 20 61 6e 64 0a 2a 2a 20 74 61 62 6c 65 20 63  , and.** table c
22640 6f 6c 75 6d 6e 20 74 68 61 74 20 69 73 20 74 68  olumn that is th
22650 65 20 6f 72 69 67 69 6e 20 6f 66 20 61 20 70 61  e origin of a pa
22660 72 74 69 63 75 6c 61 72 20 72 65 73 75 6c 74 20  rticular result 
22670 63 6f 6c 75 6d 6e 20 69 6e 0a 2a 2a 20 5b 53 45  column in.** [SE
22680 4c 45 43 54 5d 20 73 74 61 74 65 6d 65 6e 74 2e  LECT] statement.
22690 0a 2a 2a 20 5e 54 68 65 20 6e 61 6d 65 20 6f 66  .** ^The name of
226a0 20 74 68 65 20 64 61 74 61 62 61 73 65 20 6f 72   the database or
226b0 20 74 61 62 6c 65 20 6f 72 20 63 6f 6c 75 6d 6e   table or column
226c0 20 63 61 6e 20 62 65 20 72 65 74 75 72 6e 65 64   can be returned
226d0 20 61 73 0a 2a 2a 20 65 69 74 68 65 72 20 61 20   as.** either a 
226e0 55 54 46 2d 38 20 6f 72 20 55 54 46 2d 31 36 20  UTF-8 or UTF-16 
226f0 73 74 72 69 6e 67 2e 20 20 5e 54 68 65 20 5f 64  string.  ^The _d
22700 61 74 61 62 61 73 65 5f 20 72 6f 75 74 69 6e 65  atabase_ routine
22710 73 20 72 65 74 75 72 6e 0a 2a 2a 20 74 68 65 20  s return.** the 
22720 64 61 74 61 62 61 73 65 20 6e 61 6d 65 2c 20 74  database name, t
22730 68 65 20 5f 74 61 62 6c 65 5f 20 72 6f 75 74 69  he _table_ routi
22740 6e 65 73 20 72 65 74 75 72 6e 20 74 68 65 20 74  nes return the t
22750 61 62 6c 65 20 6e 61 6d 65 2c 20 61 6e 64 0a 2a  able name, and.*
22760 2a 20 74 68 65 20 6f 72 69 67 69 6e 5f 20 72 6f  * the origin_ ro
22770 75 74 69 6e 65 73 20 72 65 74 75 72 6e 20 74 68  utines return th
22780 65 20 63 6f 6c 75 6d 6e 20 6e 61 6d 65 2e 0a 2a  e column name..*
22790 2a 20 5e 54 68 65 20 72 65 74 75 72 6e 65 64 20  * ^The returned 
227a0 73 74 72 69 6e 67 20 69 73 20 76 61 6c 69 64 20  string is valid 
227b0 75 6e 74 69 6c 20 74 68 65 20 5b 70 72 65 70 61  until the [prepa
227c0 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 69  red statement] i
227d0 73 20 64 65 73 74 72 6f 79 65 64 0a 2a 2a 20 75  s destroyed.** u
227e0 73 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 66 69  sing [sqlite3_fi
227f0 6e 61 6c 69 7a 65 28 29 5d 20 6f 72 20 75 6e 74  nalize()] or unt
22800 69 6c 20 74 68 65 20 73 61 6d 65 20 69 6e 66 6f  il the same info
22810 72 6d 61 74 69 6f 6e 20 69 73 20 72 65 71 75 65  rmation is reque
22820 73 74 65 64 0a 2a 2a 20 61 67 61 69 6e 20 69 6e  sted.** again in
22830 20 61 20 64 69 66 66 65 72 65 6e 74 20 65 6e 63   a different enc
22840 6f 64 69 6e 67 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  oding..**.** ^Th
22850 65 20 6e 61 6d 65 73 20 72 65 74 75 72 6e 65 64  e names returned
22860 20 61 72 65 20 74 68 65 20 6f 72 69 67 69 6e 61   are the origina
22870 6c 20 75 6e 2d 61 6c 69 61 73 65 64 20 6e 61 6d  l un-aliased nam
22880 65 73 20 6f 66 20 74 68 65 0a 2a 2a 20 64 61 74  es of the.** dat
22890 61 62 61 73 65 2c 20 74 61 62 6c 65 2c 20 61 6e  abase, table, an
228a0 64 20 63 6f 6c 75 6d 6e 2e 0a 2a 2a 0a 2a 2a 20  d column..**.** 
228b0 5e 54 68 65 20 66 69 72 73 74 20 61 72 67 75 6d  ^The first argum
228c0 65 6e 74 20 74 6f 20 74 68 65 73 65 20 69 6e 74  ent to these int
228d0 65 72 66 61 63 65 73 20 69 73 20 61 20 5b 70 72  erfaces is a [pr
228e0 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
228f0 5d 2e 0a 2a 2a 20 5e 54 68 65 73 65 20 66 75 6e  ]..** ^These fun
22900 63 74 69 6f 6e 73 20 72 65 74 75 72 6e 20 69 6e  ctions return in
22910 66 6f 72 6d 61 74 69 6f 6e 20 61 62 6f 75 74 20  formation about 
22920 74 68 65 20 4e 74 68 20 72 65 73 75 6c 74 20 63  the Nth result c
22930 6f 6c 75 6d 6e 20 72 65 74 75 72 6e 65 64 20 62  olumn returned b
22940 79 0a 2a 2a 20 74 68 65 20 73 74 61 74 65 6d 65  y.** the stateme
22950 6e 74 2c 20 77 68 65 72 65 20 4e 20 69 73 20 74  nt, where N is t
22960 68 65 20 73 65 63 6f 6e 64 20 66 75 6e 63 74 69  he second functi
22970 6f 6e 20 61 72 67 75 6d 65 6e 74 2e 0a 2a 2a 20  on argument..** 
22980 5e 54 68 65 20 6c 65 66 74 2d 6d 6f 73 74 20 63  ^The left-most c
22990 6f 6c 75 6d 6e 20 69 73 20 63 6f 6c 75 6d 6e 20  olumn is column 
229a0 30 20 66 6f 72 20 74 68 65 73 65 20 72 6f 75 74  0 for these rout
229b0 69 6e 65 73 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20  ines..**.** ^If 
229c0 74 68 65 20 4e 74 68 20 63 6f 6c 75 6d 6e 20 72  the Nth column r
229d0 65 74 75 72 6e 65 64 20 62 79 20 74 68 65 20 73  eturned by the s
229e0 74 61 74 65 6d 65 6e 74 20 69 73 20 61 6e 20 65  tatement is an e
229f0 78 70 72 65 73 73 69 6f 6e 20 6f 72 0a 2a 2a 20  xpression or.** 
22a00 73 75 62 71 75 65 72 79 20 61 6e 64 20 69 73 20  subquery and is 
22a10 6e 6f 74 20 61 20 63 6f 6c 75 6d 6e 20 76 61 6c  not a column val
22a20 75 65 2c 20 74 68 65 6e 20 61 6c 6c 20 6f 66 20  ue, then all of 
22a30 74 68 65 73 65 20 66 75 6e 63 74 69 6f 6e 73 20  these functions 
22a40 72 65 74 75 72 6e 0a 2a 2a 20 4e 55 4c 4c 2e 20  return.** NULL. 
22a50 20 5e 54 68 65 73 65 20 72 6f 75 74 69 6e 65 20   ^These routine 
22a60 6d 69 67 68 74 20 61 6c 73 6f 20 72 65 74 75 72  might also retur
22a70 6e 20 4e 55 4c 4c 20 69 66 20 61 20 6d 65 6d 6f  n NULL if a memo
22a80 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 65 72  ry allocation er
22a90 72 6f 72 0a 2a 2a 20 6f 63 63 75 72 73 2e 20 20  ror.** occurs.  
22aa0 5e 4f 74 68 65 72 77 69 73 65 2c 20 74 68 65 79  ^Otherwise, they
22ab0 20 72 65 74 75 72 6e 20 74 68 65 20 6e 61 6d 65   return the name
22ac0 20 6f 66 20 74 68 65 20 61 74 74 61 63 68 65 64   of the attached
22ad0 20 64 61 74 61 62 61 73 65 2c 20 74 61 62 6c 65   database, table
22ae0 2c 0a 2a 2a 20 6f 72 20 63 6f 6c 75 6d 6e 20 74  ,.** or column t
22af0 68 61 74 20 71 75 65 72 79 20 72 65 73 75 6c 74  hat query result
22b00 20 63 6f 6c 75 6d 6e 20 77 61 73 20 65 78 74 72   column was extr
22b10 61 63 74 65 64 20 66 72 6f 6d 2e 0a 2a 2a 0a 2a  acted from..**.*
22b20 2a 20 5e 41 73 20 77 69 74 68 20 61 6c 6c 20 6f  * ^As with all o
22b30 74 68 65 72 20 53 51 4c 69 74 65 20 41 50 49 73  ther SQLite APIs
22b40 2c 20 74 68 6f 73 65 20 77 68 6f 73 65 20 6e 61  , those whose na
22b50 6d 65 73 20 65 6e 64 20 77 69 74 68 20 22 31 36  mes end with "16
22b60 22 20 72 65 74 75 72 6e 0a 2a 2a 20 55 54 46 2d  " return.** UTF-
22b70 31 36 20 65 6e 63 6f 64 65 64 20 73 74 72 69 6e  16 encoded strin
22b80 67 73 20 61 6e 64 20 74 68 65 20 6f 74 68 65 72  gs and the other
22b90 20 66 75 6e 63 74 69 6f 6e 73 20 72 65 74 75 72   functions retur
22ba0 6e 20 55 54 46 2d 38 2e 0a 2a 2a 0a 2a 2a 20 5e  n UTF-8..**.** ^
22bb0 54 68 65 73 65 20 41 50 49 73 20 61 72 65 20 6f  These APIs are o
22bc0 6e 6c 79 20 61 76 61 69 6c 61 62 6c 65 20 69 66  nly available if
22bd0 20 74 68 65 20 6c 69 62 72 61 72 79 20 77 61 73   the library was
22be0 20 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 74   compiled with t
22bf0 68 65 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 45 4e  he.** [SQLITE_EN
22c00 41 42 4c 45 5f 43 4f 4c 55 4d 4e 5f 4d 45 54 41  ABLE_COLUMN_META
22c10 44 41 54 41 5d 20 43 2d 70 72 65 70 72 6f 63 65  DATA] C-preproce
22c20 73 73 6f 72 20 73 79 6d 62 6f 6c 2e 0a 2a 2a 0a  ssor symbol..**.
22c30 2a 2a 20 49 66 20 74 77 6f 20 6f 72 20 6d 6f 72  ** If two or mor
22c40 65 20 74 68 72 65 61 64 73 20 63 61 6c 6c 20 6f  e threads call o
22c50 6e 65 20 6f 72 20 6d 6f 72 65 20 6f 66 20 74 68  ne or more of th
22c60 65 73 65 20 72 6f 75 74 69 6e 65 73 20 61 67 61  ese routines aga
22c70 69 6e 73 74 20 74 68 65 20 73 61 6d 65 0a 2a 2a  inst the same.**
22c80 20 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d   prepared statem
22c90 65 6e 74 20 61 6e 64 20 63 6f 6c 75 6d 6e 20 61  ent and column a
22ca0 74 20 74 68 65 20 73 61 6d 65 20 74 69 6d 65 20  t the same time 
22cb0 74 68 65 6e 20 74 68 65 20 72 65 73 75 6c 74 73  then the results
22cc0 20 61 72 65 0a 2a 2a 20 75 6e 64 65 66 69 6e 65   are.** undefine
22cd0 64 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 74 77 6f 20  d..**.** If two 
22ce0 6f 72 20 6d 6f 72 65 20 74 68 72 65 61 64 73 20  or more threads 
22cf0 63 61 6c 6c 20 6f 6e 65 20 6f 72 20 6d 6f 72 65  call one or more
22d00 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c  .** [sqlite3_col
22d10 75 6d 6e 5f 64 61 74 61 62 61 73 65 5f 6e 61 6d  umn_database_nam
22d20 65 20 7c 20 63 6f 6c 75 6d 6e 20 6d 65 74 61 64  e | column metad
22d30 61 74 61 20 69 6e 74 65 72 66 61 63 65 73 5d 0a  ata interfaces].
22d40 2a 2a 20 66 6f 72 20 74 68 65 20 73 61 6d 65 20  ** for the same 
22d50 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d  [prepared statem
22d60 65 6e 74 5d 20 61 6e 64 20 72 65 73 75 6c 74 20  ent] and result 
22d70 63 6f 6c 75 6d 6e 0a 2a 2a 20 61 74 20 74 68 65  column.** at the
22d80 20 73 61 6d 65 20 74 69 6d 65 20 74 68 65 6e 20   same time then 
22d90 74 68 65 20 72 65 73 75 6c 74 73 20 61 72 65 20  the results are 
22da0 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2f 0a 63 6f  undefined..*/.co
22db0 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65  nst char *sqlite
22dc0 33 5f 63 6f 6c 75 6d 6e 5f 64 61 74 61 62 61 73  3_column_databas
22dd0 65 5f 6e 61 6d 65 28 73 71 6c 69 74 65 33 5f 73  e_name(sqlite3_s
22de0 74 6d 74 2a 2c 69 6e 74 29 3b 0a 63 6f 6e 73 74  tmt*,int);.const
22df0 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 63   void *sqlite3_c
22e00 6f 6c 75 6d 6e 5f 64 61 74 61 62 61 73 65 5f 6e  olumn_database_n
22e10 61 6d 65 31 36 28 73 71 6c 69 74 65 33 5f 73 74  ame16(sqlite3_st
22e20 6d 74 2a 2c 69 6e 74 29 3b 0a 63 6f 6e 73 74 20  mt*,int);.const 
22e30 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 63 6f  char *sqlite3_co
22e40 6c 75 6d 6e 5f 74 61 62 6c 65 5f 6e 61 6d 65 28  lumn_table_name(
22e50 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 69 6e  sqlite3_stmt*,in
22e60 74 29 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a  t);.const void *
22e70 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74  sqlite3_column_t
22e80 61 62 6c 65 5f 6e 61 6d 65 31 36 28 73 71 6c 69  able_name16(sqli
22e90 74 65 33 5f 73 74 6d 74 2a 2c 69 6e 74 29 3b 0a  te3_stmt*,int);.
22ea0 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 69  const char *sqli
22eb0 74 65 33 5f 63 6f 6c 75 6d 6e 5f 6f 72 69 67 69  te3_column_origi
22ec0 6e 5f 6e 61 6d 65 28 73 71 6c 69 74 65 33 5f 73  n_name(sqlite3_s
22ed0 74 6d 74 2a 2c 69 6e 74 29 3b 0a 63 6f 6e 73 74  tmt*,int);.const
22ee0 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 63   void *sqlite3_c
22ef0 6f 6c 75 6d 6e 5f 6f 72 69 67 69 6e 5f 6e 61 6d  olumn_origin_nam
22f00 65 31 36 28 73 71 6c 69 74 65 33 5f 73 74 6d 74  e16(sqlite3_stmt
22f10 2a 2c 69 6e 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43  *,int);../*.** C
22f20 41 50 49 33 52 45 46 3a 20 44 65 63 6c 61 72 65  API3REF: Declare
22f30 64 20 44 61 74 61 74 79 70 65 20 4f 66 20 41 20  d Datatype Of A 
22f40 51 75 65 72 79 20 52 65 73 75 6c 74 0a 2a 2a 0a  Query Result.**.
22f50 2a 2a 20 5e 28 54 68 65 20 66 69 72 73 74 20 70  ** ^(The first p
22f60 61 72 61 6d 65 74 65 72 20 69 73 20 61 20 5b 70  arameter is a [p
22f70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e  repared statemen
22f80 74 5d 2e 0a 2a 2a 20 49 66 20 74 68 69 73 20 73  t]..** If this s
22f90 74 61 74 65 6d 65 6e 74 20 69 73 20 61 20 5b 53  tatement is a [S
22fa0 45 4c 45 43 54 5d 20 73 74 61 74 65 6d 65 6e 74  ELECT] statement
22fb0 20 61 6e 64 20 74 68 65 20 4e 74 68 20 63 6f 6c   and the Nth col
22fc0 75 6d 6e 20 6f 66 20 74 68 65 0a 2a 2a 20 72 65  umn of the.** re
22fd0 74 75 72 6e 65 64 20 72 65 73 75 6c 74 20 73 65  turned result se
22fe0 74 20 6f 66 20 74 68 61 74 20 5b 53 45 4c 45 43  t of that [SELEC
22ff0 54 5d 20 69 73 20 61 20 74 61 62 6c 65 20 63 6f  T] is a table co
23000 6c 75 6d 6e 20 28 6e 6f 74 20 61 6e 0a 2a 2a 20  lumn (not an.** 
23010 65 78 70 72 65 73 73 69 6f 6e 20 6f 72 20 73 75  expression or su
23020 62 71 75 65 72 79 29 20 74 68 65 6e 20 74 68 65  bquery) then the
23030 20 64 65 63 6c 61 72 65 64 20 74 79 70 65 20 6f   declared type o
23040 66 20 74 68 65 20 74 61 62 6c 65 0a 2a 2a 20 63  f the table.** c
23050 6f 6c 75 6d 6e 20 69 73 20 72 65 74 75 72 6e 65  olumn is returne
23060 64 2e 29 5e 20 20 5e 49 66 20 74 68 65 20 4e 74  d.)^  ^If the Nt
23070 68 20 63 6f 6c 75 6d 6e 20 6f 66 20 74 68 65 20  h column of the 
23080 72 65 73 75 6c 74 20 73 65 74 20 69 73 20 61 6e  result set is an
23090 0a 2a 2a 20 65 78 70 72 65 73 73 69 6f 6e 20 6f  .** expression o
230a0 72 20 73 75 62 71 75 65 72 79 2c 20 74 68 65 6e  r subquery, then
230b0 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20   a NULL pointer 
230c0 69 73 20 72 65 74 75 72 6e 65 64 2e 0a 2a 2a 20  is returned..** 
230d0 5e 54 68 65 20 72 65 74 75 72 6e 65 64 20 73 74  ^The returned st
230e0 72 69 6e 67 20 69 73 20 61 6c 77 61 79 73 20 55  ring is always U
230f0 54 46 2d 38 20 65 6e 63 6f 64 65 64 2e 0a 2a 2a  TF-8 encoded..**
23100 0a 2a 2a 20 5e 28 46 6f 72 20 65 78 61 6d 70 6c  .** ^(For exampl
23110 65 2c 20 67 69 76 65 6e 20 74 68 65 20 64 61 74  e, given the dat
23120 61 62 61 73 65 20 73 63 68 65 6d 61 3a 0a 2a 2a  abase schema:.**
23130 0a 2a 2a 20 43 52 45 41 54 45 20 54 41 42 4c 45  .** CREATE TABLE
23140 20 74 31 28 63 31 20 56 41 52 49 41 4e 54 29 3b   t1(c1 VARIANT);
23150 0a 2a 2a 0a 2a 2a 20 61 6e 64 20 74 68 65 20 66  .**.** and the f
23160 6f 6c 6c 6f 77 69 6e 67 20 73 74 61 74 65 6d 65  ollowing stateme
23170 6e 74 20 74 6f 20 62 65 20 63 6f 6d 70 69 6c 65  nt to be compile
23180 64 3a 0a 2a 2a 0a 2a 2a 20 53 45 4c 45 43 54 20  d:.**.** SELECT 
23190 63 31 20 2b 20 31 2c 20 63 31 20 46 52 4f 4d 20  c1 + 1, c1 FROM 
231a0 74 31 3b 0a 2a 2a 0a 2a 2a 20 74 68 69 73 20 72  t1;.**.** this r
231b0 6f 75 74 69 6e 65 20 77 6f 75 6c 64 20 72 65 74  outine would ret
231c0 75 72 6e 20 74 68 65 20 73 74 72 69 6e 67 20 22  urn the string "
231d0 56 41 52 49 41 4e 54 22 20 66 6f 72 20 74 68 65  VARIANT" for the
231e0 20 73 65 63 6f 6e 64 20 72 65 73 75 6c 74 0a 2a   second result.*
231f0 2a 20 63 6f 6c 75 6d 6e 20 28 69 3d 3d 31 29 2c  * column (i==1),
23200 20 61 6e 64 20 61 20 4e 55 4c 4c 20 70 6f 69 6e   and a NULL poin
23210 74 65 72 20 66 6f 72 20 74 68 65 20 66 69 72 73  ter for the firs
23220 74 20 72 65 73 75 6c 74 20 63 6f 6c 75 6d 6e 20  t result column 
23230 28 69 3d 3d 30 29 2e 29 5e 0a 2a 2a 0a 2a 2a 20  (i==0).)^.**.** 
23240 5e 53 51 4c 69 74 65 20 75 73 65 73 20 64 79 6e  ^SQLite uses dyn
23250 61 6d 69 63 20 72 75 6e 2d 74 69 6d 65 20 74 79  amic run-time ty
23260 70 69 6e 67 2e 20 20 5e 53 6f 20 6a 75 73 74 20  ping.  ^So just 
23270 62 65 63 61 75 73 65 20 61 20 63 6f 6c 75 6d 6e  because a column
23280 0a 2a 2a 20 69 73 20 64 65 63 6c 61 72 65 64 20  .** is declared 
23290 74 6f 20 63 6f 6e 74 61 69 6e 20 61 20 70 61 72  to contain a par
232a0 74 69 63 75 6c 61 72 20 74 79 70 65 20 64 6f 65  ticular type doe
232b0 73 20 6e 6f 74 20 6d 65 61 6e 20 74 68 61 74 20  s not mean that 
232c0 74 68 65 0a 2a 2a 20 64 61 74 61 20 73 74 6f 72  the.** data stor
232d0 65 64 20 69 6e 20 74 68 61 74 20 63 6f 6c 75 6d  ed in that colum
232e0 6e 20 69 73 20 6f 66 20 74 68 65 20 64 65 63 6c  n is of the decl
232f0 61 72 65 64 20 74 79 70 65 2e 20 20 53 51 4c 69  ared type.  SQLi
23300 74 65 20 69 73 0a 2a 2a 20 73 74 72 6f 6e 67 6c  te is.** strongl
23310 79 20 74 79 70 65 64 2c 20 62 75 74 20 74 68 65  y typed, but the
23320 20 74 79 70 69 6e 67 20 69 73 20 64 79 6e 61 6d   typing is dynam
23330 69 63 20 6e 6f 74 20 73 74 61 74 69 63 2e 20 20  ic not static.  
23340 5e 54 79 70 65 0a 2a 2a 20 69 73 20 61 73 73 6f  ^Type.** is asso
23350 63 69 61 74 65 64 20 77 69 74 68 20 69 6e 64 69  ciated with indi
23360 76 69 64 75 61 6c 20 76 61 6c 75 65 73 2c 20 6e  vidual values, n
23370 6f 74 20 77 69 74 68 20 74 68 65 20 63 6f 6e 74  ot with the cont
23380 61 69 6e 65 72 73 0a 2a 2a 20 75 73 65 64 20 74  ainers.** used t
23390 6f 20 68 6f 6c 64 20 74 68 6f 73 65 20 76 61 6c  o hold those val
233a0 75 65 73 2e 0a 2a 2f 0a 63 6f 6e 73 74 20 63 68  ues..*/.const ch
233b0 61 72 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75  ar *sqlite3_colu
233c0 6d 6e 5f 64 65 63 6c 74 79 70 65 28 73 71 6c 69  mn_decltype(sqli
233d0 74 65 33 5f 73 74 6d 74 2a 2c 69 6e 74 29 3b 0a  te3_stmt*,int);.
233e0 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c 69  const void *sqli
233f0 74 65 33 5f 63 6f 6c 75 6d 6e 5f 64 65 63 6c 74  te3_column_declt
23400 79 70 65 31 36 28 73 71 6c 69 74 65 33 5f 73 74  ype16(sqlite3_st
23410 6d 74 2a 2c 69 6e 74 29 3b 0a 0a 2f 2a 0a 2a 2a  mt*,int);../*.**
23420 20 43 41 50 49 33 52 45 46 3a 20 45 76 61 6c 75   CAPI3REF: Evalu
23430 61 74 65 20 41 6e 20 53 51 4c 20 53 74 61 74 65  ate An SQL State
23440 6d 65 6e 74 0a 2a 2a 0a 2a 2a 20 41 66 74 65 72  ment.**.** After
23450 20 61 20 5b 70 72 65 70 61 72 65 64 20 73 74 61   a [prepared sta
23460 74 65 6d 65 6e 74 5d 20 68 61 73 20 62 65 65 6e  tement] has been
23470 20 70 72 65 70 61 72 65 64 20 75 73 69 6e 67 20   prepared using 
23480 65 69 74 68 65 72 0a 2a 2a 20 5b 73 71 6c 69 74  either.** [sqlit
23490 65 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29 5d  e3_prepare_v2()]
234a0 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f 70 72 65   or [sqlite3_pre
234b0 70 61 72 65 31 36 5f 76 32 28 29 5d 20 6f 72 20  pare16_v2()] or 
234c0 6f 6e 65 20 6f 66 20 74 68 65 20 6c 65 67 61 63  one of the legac
234d0 79 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 73 20  y.** interfaces 
234e0 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65  [sqlite3_prepare
234f0 28 29 5d 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f  ()] or [sqlite3_
23500 70 72 65 70 61 72 65 31 36 28 29 5d 2c 20 74 68  prepare16()], th
23510 69 73 20 66 75 6e 63 74 69 6f 6e 0a 2a 2a 20 6d  is function.** m
23520 75 73 74 20 62 65 20 63 61 6c 6c 65 64 20 6f 6e  ust be called on
23530 65 20 6f 72 20 6d 6f 72 65 20 74 69 6d 65 73 20  e or more times 
23540 74 6f 20 65 76 61 6c 75 61 74 65 20 74 68 65 20  to evaluate the 
23550 73 74 61 74 65 6d 65 6e 74 2e 0a 2a 2a 0a 2a 2a  statement..**.**
23560 20 54 68 65 20 64 65 74 61 69 6c 73 20 6f 66 20   The details of 
23570 74 68 65 20 62 65 68 61 76 69 6f 72 20 6f 66 20  the behavior of 
23580 74 68 65 20 73 71 6c 69 74 65 33 5f 73 74 65 70  the sqlite3_step
23590 28 29 20 69 6e 74 65 72 66 61 63 65 20 64 65 70  () interface dep
235a0 65 6e 64 0a 2a 2a 20 6f 6e 20 77 68 65 74 68 65  end.** on whethe
235b0 72 20 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20  r the statement 
235c0 77 61 73 20 70 72 65 70 61 72 65 64 20 75 73 69  was prepared usi
235d0 6e 67 20 74 68 65 20 6e 65 77 65 72 20 22 76 32  ng the newer "v2
235e0 22 20 69 6e 74 65 72 66 61 63 65 0a 2a 2a 20 5b  " interface.** [
235f0 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 5f  sqlite3_prepare_
23600 76 32 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74  v2()] and [sqlit
23610 65 33 5f 70 72 65 70 61 72 65 31 36 5f 76 32 28  e3_prepare16_v2(
23620 29 5d 20 6f 72 20 74 68 65 20 6f 6c 64 65 72 20  )] or the older 
23630 6c 65 67 61 63 79 0a 2a 2a 20 69 6e 74 65 72 66  legacy.** interf
23640 61 63 65 20 5b 73 71 6c 69 74 65 33 5f 70 72 65  ace [sqlite3_pre
23650 70 61 72 65 28 29 5d 20 61 6e 64 20 5b 73 71 6c  pare()] and [sql
23660 69 74 65 33 5f 70 72 65 70 61 72 65 31 36 28 29  ite3_prepare16()
23670 5d 2e 20 20 54 68 65 20 75 73 65 20 6f 66 20 74  ].  The use of t
23680 68 65 0a 2a 2a 20 6e 65 77 20 22 76 32 22 20 69  he.** new "v2" i
23690 6e 74 65 72 66 61 63 65 20 69 73 20 72 65 63 6f  nterface is reco
236a0 6d 6d 65 6e 64 65 64 20 66 6f 72 20 6e 65 77 20  mmended for new 
236b0 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 62 75 74  applications but
236c0 20 74 68 65 20 6c 65 67 61 63 79 0a 2a 2a 20 69   the legacy.** i
236d0 6e 74 65 72 66 61 63 65 20 77 69 6c 6c 20 63 6f  nterface will co
236e0 6e 74 69 6e 75 65 20 74 6f 20 62 65 20 73 75 70  ntinue to be sup
236f0 70 6f 72 74 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 49  ported..**.** ^I
23700 6e 20 74 68 65 20 6c 65 67 61 63 79 20 69 6e 74  n the legacy int
23710 65 72 66 61 63 65 2c 20 74 68 65 20 72 65 74 75  erface, the retu
23720 72 6e 20 76 61 6c 75 65 20 77 69 6c 6c 20 62 65  rn value will be
23730 20 65 69 74 68 65 72 20 5b 53 51 4c 49 54 45 5f   either [SQLITE_
23740 42 55 53 59 5d 2c 0a 2a 2a 20 5b 53 51 4c 49 54  BUSY],.** [SQLIT
23750 45 5f 44 4f 4e 45 5d 2c 20 5b 53 51 4c 49 54 45  E_DONE], [SQLITE
23760 5f 52 4f 57 5d 2c 20 5b 53 51 4c 49 54 45 5f 45  _ROW], [SQLITE_E
23770 52 52 4f 52 5d 2c 20 6f 72 20 5b 53 51 4c 49 54  RROR], or [SQLIT
23780 45 5f 4d 49 53 55 53 45 5d 2e 0a 2a 2a 20 5e 57  E_MISUSE]..** ^W
23790 69 74 68 20 74 68 65 20 22 76 32 22 20 69 6e 74  ith the "v2" int
237a0 65 72 66 61 63 65 2c 20 61 6e 79 20 6f 66 20 74  erface, any of t
237b0 68 65 20 6f 74 68 65 72 20 5b 72 65 73 75 6c 74  he other [result
237c0 20 63 6f 64 65 73 5d 20 6f 72 0a 2a 2a 20 5b 65   codes] or.** [e
237d0 78 74 65 6e 64 65 64 20 72 65 73 75 6c 74 20 63  xtended result c
237e0 6f 64 65 73 5d 20 6d 69 67 68 74 20 62 65 20 72  odes] might be r
237f0 65 74 75 72 6e 65 64 20 61 73 20 77 65 6c 6c 2e  eturned as well.
23800 0a 2a 2a 0a 2a 2a 20 5e 5b 53 51 4c 49 54 45 5f  .**.** ^[SQLITE_
23810 42 55 53 59 5d 20 6d 65 61 6e 73 20 74 68 61 74  BUSY] means that
23820 20 74 68 65 20 64 61 74 61 62 61 73 65 20 65 6e   the database en
23830 67 69 6e 65 20 77 61 73 20 75 6e 61 62 6c 65 20  gine was unable 
23840 74 6f 20 61 63 71 75 69 72 65 20 74 68 65 0a 2a  to acquire the.*
23850 2a 20 64 61 74 61 62 61 73 65 20 6c 6f 63 6b 73  * database locks
23860 20 69 74 20 6e 65 65 64 73 20 74 6f 20 64 6f 20   it needs to do 
23870 69 74 73 20 6a 6f 62 2e 20 20 5e 49 66 20 74 68  its job.  ^If th
23880 65 20 73 74 61 74 65 6d 65 6e 74 20 69 73 20 61  e statement is a
23890 20 5b 43 4f 4d 4d 49 54 5d 0a 2a 2a 20 6f 72 20   [COMMIT].** or 
238a0 6f 63 63 75 72 73 20 6f 75 74 73 69 64 65 20 6f  occurs outside o
238b0 66 20 61 6e 20 65 78 70 6c 69 63 69 74 20 74 72  f an explicit tr
238c0 61 6e 73 61 63 74 69 6f 6e 2c 20 74 68 65 6e 20  ansaction, then 
238d0 79 6f 75 20 63 61 6e 20 72 65 74 72 79 20 74 68  you can retry th
238e0 65 0a 2a 2a 20 73 74 61 74 65 6d 65 6e 74 2e 20  e.** statement. 
238f0 20 49 66 20 74 68 65 20 73 74 61 74 65 6d 65 6e   If the statemen
23900 74 20 69 73 20 6e 6f 74 20 61 20 5b 43 4f 4d 4d  t is not a [COMM
23910 49 54 5d 20 61 6e 64 20 6f 63 63 75 72 73 20 77  IT] and occurs w
23920 69 74 68 69 6e 20 61 0a 2a 2a 20 65 78 70 6c 69  ithin a.** expli
23930 63 69 74 20 74 72 61 6e 73 61 63 74 69 6f 6e 20  cit transaction 
23940 74 68 65 6e 20 79 6f 75 20 73 68 6f 75 6c 64 20  then you should 
23950 72 6f 6c 6c 62 61 63 6b 20 74 68 65 20 74 72 61  rollback the tra
23960 6e 73 61 63 74 69 6f 6e 20 62 65 66 6f 72 65 0a  nsaction before.
23970 2a 2a 20 63 6f 6e 74 69 6e 75 69 6e 67 2e 0a 2a  ** continuing..*
23980 2a 0a 2a 2a 20 5e 5b 53 51 4c 49 54 45 5f 44 4f  *.** ^[SQLITE_DO
23990 4e 45 5d 20 6d 65 61 6e 73 20 74 68 61 74 20 74  NE] means that t
239a0 68 65 20 73 74 61 74 65 6d 65 6e 74 20 68 61 73  he statement has
239b0 20 66 69 6e 69 73 68 65 64 20 65 78 65 63 75 74   finished execut
239c0 69 6e 67 0a 2a 2a 20 73 75 63 63 65 73 73 66 75  ing.** successfu
239d0 6c 6c 79 2e 20 20 73 71 6c 69 74 65 33 5f 73 74  lly.  sqlite3_st
239e0 65 70 28 29 20 73 68 6f 75 6c 64 20 6e 6f 74 20  ep() should not 
239f0 62 65 20 63 61 6c 6c 65 64 20 61 67 61 69 6e 20  be called again 
23a00 6f 6e 20 74 68 69 73 20 76 69 72 74 75 61 6c 0a  on this virtual.
23a10 2a 2a 20 6d 61 63 68 69 6e 65 20 77 69 74 68 6f  ** machine witho
23a20 75 74 20 66 69 72 73 74 20 63 61 6c 6c 69 6e 67  ut first calling
23a30 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28   [sqlite3_reset(
23a40 29 5d 20 74 6f 20 72 65 73 65 74 20 74 68 65 20  )] to reset the 
23a50 76 69 72 74 75 61 6c 0a 2a 2a 20 6d 61 63 68 69  virtual.** machi
23a60 6e 65 20 62 61 63 6b 20 74 6f 20 69 74 73 20 69  ne back to its i
23a70 6e 69 74 69 61 6c 20 73 74 61 74 65 2e 0a 2a 2a  nitial state..**
23a80 0a 2a 2a 20 5e 49 66 20 74 68 65 20 53 51 4c 20  .** ^If the SQL 
23a90 73 74 61 74 65 6d 65 6e 74 20 62 65 69 6e 67 20  statement being 
23aa0 65 78 65 63 75 74 65 64 20 72 65 74 75 72 6e 73  executed returns
23ab0 20 61 6e 79 20 64 61 74 61 2c 20 74 68 65 6e 20   any data, then 
23ac0 5b 53 51 4c 49 54 45 5f 52 4f 57 5d 0a 2a 2a 20  [SQLITE_ROW].** 
23ad0 69 73 20 72 65 74 75 72 6e 65 64 20 65 61 63 68  is returned each
23ae0 20 74 69 6d 65 20 61 20 6e 65 77 20 72 6f 77 20   time a new row 
23af0 6f 66 20 64 61 74 61 20 69 73 20 72 65 61 64 79  of data is ready
23b00 20 66 6f 72 20 70 72 6f 63 65 73 73 69 6e 67 20   for processing 
23b10 62 79 20 74 68 65 0a 2a 2a 20 63 61 6c 6c 65 72  by the.** caller
23b20 2e 20 54 68 65 20 76 61 6c 75 65 73 20 6d 61 79  . The values may
23b30 20 62 65 20 61 63 63 65 73 73 65 64 20 75 73 69   be accessed usi
23b40 6e 67 20 74 68 65 20 5b 63 6f 6c 75 6d 6e 20 61  ng the [column a
23b50 63 63 65 73 73 20 66 75 6e 63 74 69 6f 6e 73 5d  ccess functions]
23b60 2e 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 73 74 65  ..** sqlite3_ste
23b70 70 28 29 20 69 73 20 63 61 6c 6c 65 64 20 61 67  p() is called ag
23b80 61 69 6e 20 74 6f 20 72 65 74 72 69 65 76 65 20  ain to retrieve 
23b90 74 68 65 20 6e 65 78 74 20 72 6f 77 20 6f 66 20  the next row of 
23ba0 64 61 74 61 2e 0a 2a 2a 0a 2a 2a 20 5e 5b 53 51  data..**.** ^[SQ
23bb0 4c 49 54 45 5f 45 52 52 4f 52 5d 20 6d 65 61 6e  LITE_ERROR] mean
23bc0 73 20 74 68 61 74 20 61 20 72 75 6e 2d 74 69 6d  s that a run-tim
23bd0 65 20 65 72 72 6f 72 20 28 73 75 63 68 20 61 73  e error (such as
23be0 20 61 20 63 6f 6e 73 74 72 61 69 6e 74 0a 2a 2a   a constraint.**
23bf0 20 76 69 6f 6c 61 74 69 6f 6e 29 20 68 61 73 20   violation) has 
23c00 6f 63 63 75 72 72 65 64 2e 20 20 73 71 6c 69 74  occurred.  sqlit
23c10 65 33 5f 73 74 65 70 28 29 20 73 68 6f 75 6c 64  e3_step() should
23c20 20 6e 6f 74 20 62 65 20 63 61 6c 6c 65 64 20 61   not be called a
23c30 67 61 69 6e 20 6f 6e 0a 2a 2a 20 74 68 65 20 56  gain on.** the V
23c40 4d 2e 20 4d 6f 72 65 20 69 6e 66 6f 72 6d 61 74  M. More informat
23c50 69 6f 6e 20 6d 61 79 20 62 65 20 66 6f 75 6e 64  ion may be found
23c60 20 62 79 20 63 61 6c 6c 69 6e 67 20 5b 73 71 6c   by calling [sql
23c70 69 74 65 33 5f 65 72 72 6d 73 67 28 29 5d 2e 0a  ite3_errmsg()]..
23c80 2a 2a 20 5e 57 69 74 68 20 74 68 65 20 6c 65 67  ** ^With the leg
23c90 61 63 79 20 69 6e 74 65 72 66 61 63 65 2c 20 61  acy interface, a
23ca0 20 6d 6f 72 65 20 73 70 65 63 69 66 69 63 20 65   more specific e
23cb0 72 72 6f 72 20 63 6f 64 65 20 28 66 6f 72 20 65  rror code (for e
23cc0 78 61 6d 70 6c 65 2c 0a 2a 2a 20 5b 53 51 4c 49  xample,.** [SQLI
23cd0 54 45 5f 49 4e 54 45 52 52 55 50 54 5d 2c 20 5b  TE_INTERRUPT], [
23ce0 53 51 4c 49 54 45 5f 53 43 48 45 4d 41 5d 2c 20  SQLITE_SCHEMA], 
23cf0 5b 53 51 4c 49 54 45 5f 43 4f 52 52 55 50 54 5d  [SQLITE_CORRUPT]
23d00 2c 20 61 6e 64 20 73 6f 20 66 6f 72 74 68 29 0a  , and so forth).
23d10 2a 2a 20 63 61 6e 20 62 65 20 6f 62 74 61 69 6e  ** can be obtain
23d20 65 64 20 62 79 20 63 61 6c 6c 69 6e 67 20 5b 73  ed by calling [s
23d30 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20  qlite3_reset()] 
23d40 6f 6e 20 74 68 65 0a 2a 2a 20 5b 70 72 65 70 61  on the.** [prepa
23d50 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 2e 20  red statement]. 
23d60 20 5e 49 6e 20 74 68 65 20 22 76 32 22 20 69 6e   ^In the "v2" in
23d70 74 65 72 66 61 63 65 2c 0a 2a 2a 20 74 68 65 20  terface,.** the 
23d80 6d 6f 72 65 20 73 70 65 63 69 66 69 63 20 65 72  more specific er
23d90 72 6f 72 20 63 6f 64 65 20 69 73 20 72 65 74 75  ror code is retu
23da0 72 6e 65 64 20 64 69 72 65 63 74 6c 79 20 62 79  rned directly by
23db0 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 2e   sqlite3_step().
23dc0 0a 2a 2a 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 4d  .**.** [SQLITE_M
23dd0 49 53 55 53 45 5d 20 6d 65 61 6e 73 20 74 68 61  ISUSE] means tha
23de0 74 20 74 68 65 20 74 68 69 73 20 72 6f 75 74 69  t the this routi
23df0 6e 65 20 77 61 73 20 63 61 6c 6c 65 64 20 69 6e  ne was called in
23e00 61 70 70 72 6f 70 72 69 61 74 65 6c 79 2e 0a 2a  appropriately..*
23e10 2a 20 50 65 72 68 61 70 73 20 69 74 20 77 61 73  * Perhaps it was
23e20 20 63 61 6c 6c 65 64 20 6f 6e 20 61 20 5b 70 72   called on a [pr
23e30 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74  epared statement
23e40 5d 20 74 68 61 74 20 68 61 73 0a 2a 2a 20 61 6c  ] that has.** al
23e50 72 65 61 64 79 20 62 65 65 6e 20 5b 73 71 6c 69  ready been [sqli
23e60 74 65 33 5f 66 69 6e 61 6c 69 7a 65 20 7c 20 66  te3_finalize | f
23e70 69 6e 61 6c 69 7a 65 64 5d 20 6f 72 20 6f 6e 20  inalized] or on 
23e80 6f 6e 65 20 74 68 61 74 20 68 61 64 0a 2a 2a 20  one that had.** 
23e90 70 72 65 76 69 6f 75 73 6c 79 20 72 65 74 75 72  previously retur
23ea0 6e 65 64 20 5b 53 51 4c 49 54 45 5f 45 52 52 4f  ned [SQLITE_ERRO
23eb0 52 5d 20 6f 72 20 5b 53 51 4c 49 54 45 5f 44 4f  R] or [SQLITE_DO
23ec0 4e 45 5d 2e 20 20 4f 72 20 69 74 20 63 6f 75 6c  NE].  Or it coul
23ed0 64 0a 2a 2a 20 62 65 20 74 68 65 20 63 61 73 65  d.** be the case
23ee0 20 74 68 61 74 20 74 68 65 20 73 61 6d 65 20 64   that the same d
23ef0 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
23f00 6f 6e 20 69 73 20 62 65 69 6e 67 20 75 73 65 64  on is being used
23f10 20 62 79 20 74 77 6f 20 6f 72 0a 2a 2a 20 6d 6f   by two or.** mo
23f20 72 65 20 74 68 72 65 61 64 73 20 61 74 20 74 68  re threads at th
23f30 65 20 73 61 6d 65 20 6d 6f 6d 65 6e 74 20 69 6e  e same moment in
23f40 20 74 69 6d 65 2e 0a 2a 2a 0a 2a 2a 20 46 6f 72   time..**.** For
23f50 20 61 6c 6c 20 76 65 72 73 69 6f 6e 73 20 6f 66   all versions of
23f60 20 53 51 4c 69 74 65 20 75 70 20 74 6f 20 61 6e   SQLite up to an
23f70 64 20 69 6e 63 6c 75 64 69 6e 67 20 33 2e 36 2e  d including 3.6.
23f80 32 33 2e 31 2c 20 69 74 20 77 61 73 20 72 65 71  23.1, it was req
23f90 75 69 72 65 64 0a 2a 2a 20 61 66 74 65 72 20 73  uired.** after s
23fa0 71 6c 69 74 65 33 5f 73 74 65 70 28 29 20 72 65  qlite3_step() re
23fb0 74 75 72 6e 65 64 20 61 6e 79 74 68 69 6e 67 20  turned anything 
23fc0 6f 74 68 65 72 20 74 68 61 6e 20 5b 53 51 4c 49  other than [SQLI
23fd0 54 45 5f 52 4f 57 5d 20 74 68 61 74 0a 2a 2a 20  TE_ROW] that.** 
23fe0 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29  [sqlite3_reset()
23ff0 5d 20 62 65 20 63 61 6c 6c 65 64 20 62 65 66 6f  ] be called befo
24000 72 65 20 61 6e 79 20 73 75 62 73 65 71 75 65 6e  re any subsequen
24010 74 20 69 6e 76 6f 63 61 74 69 6f 6e 20 6f 66 0a  t invocation of.
24020 2a 2a 20 73 71 6c 69 74 65 33 5f 73 74 65 70 28  ** sqlite3_step(
24030 29 2e 20 20 46 61 69 6c 75 72 65 20 74 6f 20 69  ).  Failure to i
24040 6e 76 6f 6b 65 20 5b 73 71 6c 69 74 65 33 5f 72  nvoke [sqlite3_r
24050 65 73 65 74 28 29 5d 20 69 6e 20 74 68 69 73 20  eset()] in this 
24060 77 61 79 20 77 6f 75 6c 64 0a 2a 2a 20 72 65 73  way would.** res
24070 75 6c 74 20 69 6e 20 61 6e 20 5b 53 51 4c 49 54  ult in an [SQLIT
24080 45 5f 4d 49 53 55 53 45 5d 20 72 65 74 75 72 6e  E_MISUSE] return
24090 20 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f 73 74   from sqlite3_st
240a0 65 70 28 29 2e 20 20 42 75 74 20 61 66 74 65 72  ep().  But after
240b0 0a 2a 2a 20 76 65 72 73 69 6f 6e 20 33 2e 36 2e  .** version 3.6.
240c0 32 33 2e 31 2c 20 73 71 6c 69 74 65 33 5f 73 74  23.1, sqlite3_st
240d0 65 70 28 29 20 62 65 67 61 6e 20 63 61 6c 6c 69  ep() began calli
240e0 6e 67 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65  ng [sqlite3_rese
240f0 74 28 29 5d 20 0a 2a 2a 20 61 75 74 6f 6d 61 74  t()] .** automat
24100 69 63 61 6c 6c 79 20 69 6e 20 74 68 69 73 20 63  ically in this c
24110 69 72 63 75 6d 73 74 61 6e 63 65 20 72 61 74 68  ircumstance rath
24120 65 72 20 74 68 61 6e 20 72 65 74 75 72 6e 69 6e  er than returnin
24130 67 20 5b 53 51 4c 49 54 45 5f 4d 49 53 55 53 45  g [SQLITE_MISUSE
24140 5d 2e 20 20 0a 2a 2a 0a 2a 2a 20 3c 62 3e 47 6f  ].  .**.** <b>Go
24150 6f 66 79 20 49 6e 74 65 72 66 61 63 65 20 41 6c  ofy Interface Al
24160 65 72 74 3a 3c 2f 62 3e 20 49 6e 20 74 68 65 20  ert:</b> In the 
24170 6c 65 67 61 63 79 20 69 6e 74 65 72 66 61 63 65  legacy interface
24180 2c 20 74 68 65 20 73 71 6c 69 74 65 33 5f 73 74  , the sqlite3_st
24190 65 70 28 29 0a 2a 2a 20 41 50 49 20 61 6c 77 61  ep().** API alwa
241a0 79 73 20 72 65 74 75 72 6e 73 20 61 20 67 65 6e  ys returns a gen
241b0 65 72 69 63 20 65 72 72 6f 72 20 63 6f 64 65 2c  eric error code,
241c0 20 5b 53 51 4c 49 54 45 5f 45 52 52 4f 52 5d 2c   [SQLITE_ERROR],
241d0 20 66 6f 6c 6c 6f 77 69 6e 67 20 61 6e 79 0a 2a   following any.*
241e0 2a 20 65 72 72 6f 72 20 6f 74 68 65 72 20 74 68  * error other th
241f0 61 6e 20 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d  an [SQLITE_BUSY]
24200 20 61 6e 64 20 5b 53 51 4c 49 54 45 5f 4d 49 53   and [SQLITE_MIS
24210 55 53 45 5d 2e 20 20 59 6f 75 20 6d 75 73 74 20  USE].  You must 
24220 63 61 6c 6c 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  call.** [sqlite3
24230 5f 72 65 73 65 74 28 29 5d 20 6f 72 20 5b 73 71  _reset()] or [sq
24240 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28 29  lite3_finalize()
24250 5d 20 69 6e 20 6f 72 64 65 72 20 74 6f 20 66 69  ] in order to fi
24260 6e 64 20 6f 6e 65 20 6f 66 20 74 68 65 0a 2a 2a  nd one of the.**
24270 20 73 70 65 63 69 66 69 63 20 5b 65 72 72 6f 72   specific [error
24280 20 63 6f 64 65 73 5d 20 74 68 61 74 20 62 65 74   codes] that bet
24290 74 65 72 20 64 65 73 63 72 69 62 65 73 20 74 68  ter describes th
242a0 65 20 65 72 72 6f 72 2e 0a 2a 2a 20 57 65 20 61  e error..** We a
242b0 64 6d 69 74 20 74 68 61 74 20 74 68 69 73 20 69  dmit that this i
242c0 73 20 61 20 67 6f 6f 66 79 20 64 65 73 69 67 6e  s a goofy design
242d0 2e 20 20 54 68 65 20 70 72 6f 62 6c 65 6d 20 68  .  The problem h
242e0 61 73 20 62 65 65 6e 20 66 69 78 65 64 0a 2a 2a  as been fixed.**
242f0 20 77 69 74 68 20 74 68 65 20 22 76 32 22 20 69   with the "v2" i
24300 6e 74 65 72 66 61 63 65 2e 20 20 49 66 20 79 6f  nterface.  If yo
24310 75 20 70 72 65 70 61 72 65 20 61 6c 6c 20 6f 66  u prepare all of
24320 20 79 6f 75 72 20 53 51 4c 20 73 74 61 74 65 6d   your SQL statem
24330 65 6e 74 73 0a 2a 2a 20 75 73 69 6e 67 20 65 69  ents.** using ei
24340 74 68 65 72 20 5b 73 71 6c 69 74 65 33 5f 70 72  ther [sqlite3_pr
24350 65 70 61 72 65 5f 76 32 28 29 5d 20 6f 72 20 5b  epare_v2()] or [
24360 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65 31  sqlite3_prepare1
24370 36 5f 76 32 28 29 5d 20 69 6e 73 74 65 61 64 0a  6_v2()] instead.
24380 2a 2a 20 6f 66 20 74 68 65 20 6c 65 67 61 63 79  ** of the legacy
24390 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72   [sqlite3_prepar
243a0 65 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65  e()] and [sqlite
243b0 33 5f 70 72 65 70 61 72 65 31 36 28 29 5d 20 69  3_prepare16()] i
243c0 6e 74 65 72 66 61 63 65 73 2c 0a 2a 2a 20 74 68  nterfaces,.** th
243d0 65 6e 20 74 68 65 20 6d 6f 72 65 20 73 70 65 63  en the more spec
243e0 69 66 69 63 20 5b 65 72 72 6f 72 20 63 6f 64 65  ific [error code
243f0 73 5d 20 61 72 65 20 72 65 74 75 72 6e 65 64 20  s] are returned 
24400 64 69 72 65 63 74 6c 79 0a 2a 2a 20 62 79 20 73  directly.** by s
24410 71 6c 69 74 65 33 5f 73 74 65 70 28 29 2e 20 20  qlite3_step().  
24420 54 68 65 20 75 73 65 20 6f 66 20 74 68 65 20 22  The use of the "
24430 76 32 22 20 69 6e 74 65 72 66 61 63 65 20 69 73  v2" interface is
24440 20 72 65 63 6f 6d 6d 65 6e 64 65 64 2e 0a 2a 2f   recommended..*/
24450 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 73 74 65  .int sqlite3_ste
24460 70 28 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 29  p(sqlite3_stmt*)
24470 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
24480 46 3a 20 4e 75 6d 62 65 72 20 6f 66 20 63 6f 6c  F: Number of col
24490 75 6d 6e 73 20 69 6e 20 61 20 72 65 73 75 6c 74  umns in a result
244a0 20 73 65 74 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20   set.**.** ^The 
244b0 73 71 6c 69 74 65 33 5f 64 61 74 61 5f 63 6f 75  sqlite3_data_cou
244c0 6e 74 28 50 29 20 69 6e 74 65 72 66 61 63 65 20  nt(P) interface 
244d0 72 65 74 75 72 6e 73 20 74 68 65 20 6e 75 6d 62  returns the numb
244e0 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 20 69 6e  er of columns in
244f0 20 74 68 65 0a 2a 2a 20 63 75 72 72 65 6e 74 20   the.** current 
24500 72 6f 77 20 6f 66 20 74 68 65 20 72 65 73 75 6c  row of the resul
24510 74 20 73 65 74 20 6f 66 20 5b 70 72 65 70 61 72  t set of [prepar
24520 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 50 2e  ed statement] P.
24530 0a 2a 2a 20 5e 49 66 20 70 72 65 70 61 72 65 64  .** ^If prepared
24540 20 73 74 61 74 65 6d 65 6e 74 20 50 20 64 6f 65   statement P doe
24550 73 20 6e 6f 74 20 68 61 76 65 20 72 65 73 75 6c  s not have resul
24560 74 73 20 72 65 61 64 79 20 74 6f 20 72 65 74 75  ts ready to retu
24570 72 6e 0a 2a 2a 20 28 76 69 61 20 63 61 6c 6c 73  rn.** (via calls
24580 20 74 6f 20 74 68 65 20 5b 73 71 6c 69 74 65 33   to the [sqlite3
24590 5f 63 6f 6c 75 6d 6e 5f 69 6e 74 20 7c 20 73 71  _column_int | sq
245a0 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 2a 28 29  lite3_column_*()
245b0 5d 20 6f 66 0a 2a 2a 20 69 6e 74 65 72 66 61 63  ] of.** interfac
245c0 65 73 29 20 74 68 65 6e 20 73 71 6c 69 74 65 33  es) then sqlite3
245d0 5f 64 61 74 61 5f 63 6f 75 6e 74 28 50 29 20 72  _data_count(P) r
245e0 65 74 75 72 6e 73 20 30 2e 0a 2a 2a 20 5e 54 68  eturns 0..** ^Th
245f0 65 20 73 71 6c 69 74 65 33 5f 64 61 74 61 5f 63  e sqlite3_data_c
24600 6f 75 6e 74 28 50 29 20 72 6f 75 74 69 6e 65 20  ount(P) routine 
24610 61 6c 73 6f 20 72 65 74 75 72 6e 73 20 30 20 69  also returns 0 i
24620 66 20 50 20 69 73 20 61 20 4e 55 4c 4c 20 70 6f  f P is a NULL po
24630 69 6e 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 53 65 65  inter..**.** See
24640 20 61 6c 73 6f 3a 20 5b 73 71 6c 69 74 65 33 5f   also: [sqlite3_
24650 63 6f 6c 75 6d 6e 5f 63 6f 75 6e 74 28 29 5d 0a  column_count()].
24660 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 64  */.int sqlite3_d
24670 61 74 61 5f 63 6f 75 6e 74 28 73 71 6c 69 74 65  ata_count(sqlite
24680 33 5f 73 74 6d 74 20 2a 70 53 74 6d 74 29 3b 0a  3_stmt *pStmt);.
24690 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
246a0 20 46 75 6e 64 61 6d 65 6e 74 61 6c 20 44 61 74   Fundamental Dat
246b0 61 74 79 70 65 73 0a 2a 2a 20 4b 45 59 57 4f 52  atypes.** KEYWOR
246c0 44 53 3a 20 53 51 4c 49 54 45 5f 54 45 58 54 0a  DS: SQLITE_TEXT.
246d0 2a 2a 0a 2a 2a 20 5e 28 45 76 65 72 79 20 76 61  **.** ^(Every va
246e0 6c 75 65 20 69 6e 20 53 51 4c 69 74 65 20 68 61  lue in SQLite ha
246f0 73 20 6f 6e 65 20 6f 66 20 66 69 76 65 20 66 75  s one of five fu
24700 6e 64 61 6d 65 6e 74 61 6c 20 64 61 74 61 74 79  ndamental dataty
24710 70 65 73 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a  pes:.**.** <ul>.
24720 2a 2a 20 3c 6c 69 3e 20 36 34 2d 62 69 74 20 73  ** <li> 64-bit s
24730 69 67 6e 65 64 20 69 6e 74 65 67 65 72 0a 2a 2a  igned integer.**
24740 20 3c 6c 69 3e 20 36 34 2d 62 69 74 20 49 45 45   <li> 64-bit IEE
24750 45 20 66 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74  E floating point
24760 20 6e 75 6d 62 65 72 0a 2a 2a 20 3c 6c 69 3e 20   number.** <li> 
24770 73 74 72 69 6e 67 0a 2a 2a 20 3c 6c 69 3e 20 42  string.** <li> B
24780 4c 4f 42 0a 2a 2a 20 3c 6c 69 3e 20 4e 55 4c 4c  LOB.** <li> NULL
24790 0a 2a 2a 20 3c 2f 75 6c 3e 29 5e 0a 2a 2a 0a 2a  .** </ul>)^.**.*
247a0 2a 20 54 68 65 73 65 20 63 6f 6e 73 74 61 6e 74  * These constant
247b0 73 20 61 72 65 20 63 6f 64 65 73 20 66 6f 72 20  s are codes for 
247c0 65 61 63 68 20 6f 66 20 74 68 6f 73 65 20 74 79  each of those ty
247d0 70 65 73 2e 0a 2a 2a 0a 2a 2a 20 4e 6f 74 65 20  pes..**.** Note 
247e0 74 68 61 74 20 74 68 65 20 53 51 4c 49 54 45 5f  that the SQLITE_
247f0 54 45 58 54 20 63 6f 6e 73 74 61 6e 74 20 77 61  TEXT constant wa
24800 73 20 61 6c 73 6f 20 75 73 65 64 20 69 6e 20 53  s also used in S
24810 51 4c 69 74 65 20 76 65 72 73 69 6f 6e 20 32 0a  QLite version 2.
24820 2a 2a 20 66 6f 72 20 61 20 63 6f 6d 70 6c 65 74  ** for a complet
24830 65 6c 79 20 64 69 66 66 65 72 65 6e 74 20 6d 65  ely different me
24840 61 6e 69 6e 67 2e 20 20 53 6f 66 74 77 61 72 65  aning.  Software
24850 20 74 68 61 74 20 6c 69 6e 6b 73 20 61 67 61 69   that links agai
24860 6e 73 74 20 62 6f 74 68 0a 2a 2a 20 53 51 4c 69  nst both.** SQLi
24870 74 65 20 76 65 72 73 69 6f 6e 20 32 20 61 6e 64  te version 2 and
24880 20 53 51 4c 69 74 65 20 76 65 72 73 69 6f 6e 20   SQLite version 
24890 33 20 73 68 6f 75 6c 64 20 75 73 65 20 53 51 4c  3 should use SQL
248a0 49 54 45 33 5f 54 45 58 54 2c 20 6e 6f 74 0a 2a  ITE3_TEXT, not.*
248b0 2a 20 53 51 4c 49 54 45 5f 54 45 58 54 2e 0a 2a  * SQLITE_TEXT..*
248c0 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  /.#define SQLITE
248d0 5f 49 4e 54 45 47 45 52 20 20 31 0a 23 64 65 66  _INTEGER  1.#def
248e0 69 6e 65 20 53 51 4c 49 54 45 5f 46 4c 4f 41 54  ine SQLITE_FLOAT
248f0 20 20 20 20 32 0a 23 64 65 66 69 6e 65 20 53 51      2.#define SQ
24900 4c 49 54 45 5f 42 4c 4f 42 20 20 20 20 20 34 0a  LITE_BLOB     4.
24910 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 4e  #define SQLITE_N
24920 55 4c 4c 20 20 20 20 20 35 0a 23 69 66 64 65 66  ULL     5.#ifdef
24930 20 53 51 4c 49 54 45 5f 54 45 58 54 0a 23 20 75   SQLITE_TEXT.# u
24940 6e 64 65 66 20 53 51 4c 49 54 45 5f 54 45 58 54  ndef SQLITE_TEXT
24950 0a 23 65 6c 73 65 0a 23 20 64 65 66 69 6e 65 20  .#else.# define 
24960 53 51 4c 49 54 45 5f 54 45 58 54 20 20 20 20 20  SQLITE_TEXT     
24970 33 0a 23 65 6e 64 69 66 0a 23 64 65 66 69 6e 65  3.#endif.#define
24980 20 53 51 4c 49 54 45 33 5f 54 45 58 54 20 20 20   SQLITE3_TEXT   
24990 20 20 33 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33    3../*.** CAPI3
249a0 52 45 46 3a 20 52 65 73 75 6c 74 20 56 61 6c 75  REF: Result Valu
249b0 65 73 20 46 72 6f 6d 20 41 20 51 75 65 72 79 0a  es From A Query.
249c0 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b 63 6f  ** KEYWORDS: {co
249d0 6c 75 6d 6e 20 61 63 63 65 73 73 20 66 75 6e 63  lumn access func
249e0 74 69 6f 6e 73 7d 0a 2a 2a 0a 2a 2a 20 54 68 65  tions}.**.** The
249f0 73 65 20 72 6f 75 74 69 6e 65 73 20 66 6f 72 6d  se routines form
24a00 20 74 68 65 20 22 72 65 73 75 6c 74 20 73 65 74   the "result set
24a10 22 20 69 6e 74 65 72 66 61 63 65 2e 0a 2a 2a 0a  " interface..**.
24a20 2a 2a 20 5e 54 68 65 73 65 20 72 6f 75 74 69 6e  ** ^These routin
24a30 65 73 20 72 65 74 75 72 6e 20 69 6e 66 6f 72 6d  es return inform
24a40 61 74 69 6f 6e 20 61 62 6f 75 74 20 61 20 73 69  ation about a si
24a50 6e 67 6c 65 20 63 6f 6c 75 6d 6e 20 6f 66 20 74  ngle column of t
24a60 68 65 20 63 75 72 72 65 6e 74 0a 2a 2a 20 72 65  he current.** re
24a70 73 75 6c 74 20 72 6f 77 20 6f 66 20 61 20 71 75  sult row of a qu
24a80 65 72 79 2e 20 20 5e 49 6e 20 65 76 65 72 79 20  ery.  ^In every 
24a90 63 61 73 65 20 74 68 65 20 66 69 72 73 74 20 61  case the first a
24aa0 72 67 75 6d 65 6e 74 20 69 73 20 61 20 70 6f 69  rgument is a poi
24ab0 6e 74 65 72 0a 2a 2a 20 74 6f 20 74 68 65 20 5b  nter.** to the [
24ac0 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
24ad0 6e 74 5d 20 74 68 61 74 20 69 73 20 62 65 69 6e  nt] that is bein
24ae0 67 20 65 76 61 6c 75 61 74 65 64 20 28 74 68 65  g evaluated (the
24af0 20 5b 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 5d   [sqlite3_stmt*]
24b00 0a 2a 2a 20 74 68 61 74 20 77 61 73 20 72 65 74  .** that was ret
24b10 75 72 6e 65 64 20 66 72 6f 6d 20 5b 73 71 6c 69  urned from [sqli
24b20 74 65 33 5f 70 72 65 70 61 72 65 5f 76 32 28 29  te3_prepare_v2()
24b30 5d 20 6f 72 20 6f 6e 65 20 6f 66 20 69 74 73 20  ] or one of its 
24b40 76 61 72 69 61 6e 74 73 29 0a 2a 2a 20 61 6e 64  variants).** and
24b50 20 74 68 65 20 73 65 63 6f 6e 64 20 61 72 67 75   the second argu
24b60 6d 65 6e 74 20 69 73 20 74 68 65 20 69 6e 64 65  ment is the inde
24b70 78 20 6f 66 20 74 68 65 20 63 6f 6c 75 6d 6e 20  x of the column 
24b80 66 6f 72 20 77 68 69 63 68 20 69 6e 66 6f 72 6d  for which inform
24b90 61 74 69 6f 6e 0a 2a 2a 20 73 68 6f 75 6c 64 20  ation.** should 
24ba0 62 65 20 72 65 74 75 72 6e 65 64 2e 20 5e 54 68  be returned. ^Th
24bb0 65 20 6c 65 66 74 6d 6f 73 74 20 63 6f 6c 75 6d  e leftmost colum
24bc0 6e 20 6f 66 20 74 68 65 20 72 65 73 75 6c 74 20  n of the result 
24bd0 73 65 74 20 68 61 73 20 74 68 65 20 69 6e 64 65  set has the inde
24be0 78 20 30 2e 0a 2a 2a 20 5e 54 68 65 20 6e 75 6d  x 0..** ^The num
24bf0 62 65 72 20 6f 66 20 63 6f 6c 75 6d 6e 73 20 69  ber of columns i
24c00 6e 20 74 68 65 20 72 65 73 75 6c 74 20 63 61 6e  n the result can
24c10 20 62 65 20 64 65 74 65 72 6d 69 6e 65 64 20 75   be determined u
24c20 73 69 6e 67 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  sing.** [sqlite3
24c30 5f 63 6f 6c 75 6d 6e 5f 63 6f 75 6e 74 28 29 5d  _column_count()]
24c40 2e 0a 2a 2a 0a 2a 2a 20 49 66 20 74 68 65 20 53  ..**.** If the S
24c50 51 4c 20 73 74 61 74 65 6d 65 6e 74 20 64 6f 65  QL statement doe
24c60 73 20 6e 6f 74 20 63 75 72 72 65 6e 74 6c 79 20  s not currently 
24c70 70 6f 69 6e 74 20 74 6f 20 61 20 76 61 6c 69 64  point to a valid
24c80 20 72 6f 77 2c 20 6f 72 20 69 66 20 74 68 65 0a   row, or if the.
24c90 2a 2a 20 63 6f 6c 75 6d 6e 20 69 6e 64 65 78 20  ** column index 
24ca0 69 73 20 6f 75 74 20 6f 66 20 72 61 6e 67 65 2c  is out of range,
24cb0 20 74 68 65 20 72 65 73 75 6c 74 20 69 73 20 75   the result is u
24cc0 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a 20 54 68 65  ndefined..** The
24cd0 73 65 20 72 6f 75 74 69 6e 65 73 20 6d 61 79 20  se routines may 
24ce0 6f 6e 6c 79 20 62 65 20 63 61 6c 6c 65 64 20 77  only be called w
24cf0 68 65 6e 20 74 68 65 20 6d 6f 73 74 20 72 65 63  hen the most rec
24d00 65 6e 74 20 63 61 6c 6c 20 74 6f 0a 2a 2a 20 5b  ent call to.** [
24d10 73 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20  sqlite3_step()] 
24d20 68 61 73 20 72 65 74 75 72 6e 65 64 20 5b 53 51  has returned [SQ
24d30 4c 49 54 45 5f 52 4f 57 5d 20 61 6e 64 20 6e 65  LITE_ROW] and ne
24d40 69 74 68 65 72 0a 2a 2a 20 5b 73 71 6c 69 74 65  ither.** [sqlite
24d50 33 5f 72 65 73 65 74 28 29 5d 20 6e 6f 72 20 5b  3_reset()] nor [
24d60 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c 69 7a 65  sqlite3_finalize
24d70 28 29 5d 20 68 61 76 65 20 62 65 65 6e 20 63 61  ()] have been ca
24d80 6c 6c 65 64 20 73 75 62 73 65 71 75 65 6e 74 6c  lled subsequentl
24d90 79 2e 0a 2a 2a 20 49 66 20 61 6e 79 20 6f 66 20  y..** If any of 
24da0 74 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 61  these routines a
24db0 72 65 20 63 61 6c 6c 65 64 20 61 66 74 65 72 20  re called after 
24dc0 5b 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29  [sqlite3_reset()
24dd0 5d 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69 74 65 33  ] or.** [sqlite3
24de0 5f 66 69 6e 61 6c 69 7a 65 28 29 5d 20 6f 72 20  _finalize()] or 
24df0 61 66 74 65 72 20 5b 73 71 6c 69 74 65 33 5f 73  after [sqlite3_s
24e00 74 65 70 28 29 5d 20 68 61 73 20 72 65 74 75 72  tep()] has retur
24e10 6e 65 64 0a 2a 2a 20 73 6f 6d 65 74 68 69 6e 67  ned.** something
24e20 20 6f 74 68 65 72 20 74 68 61 6e 20 5b 53 51 4c   other than [SQL
24e30 49 54 45 5f 52 4f 57 5d 2c 20 74 68 65 20 72 65  ITE_ROW], the re
24e40 73 75 6c 74 73 20 61 72 65 20 75 6e 64 65 66 69  sults are undefi
24e50 6e 65 64 2e 0a 2a 2a 20 49 66 20 5b 73 71 6c 69  ned..** If [sqli
24e60 74 65 33 5f 73 74 65 70 28 29 5d 20 6f 72 20 5b  te3_step()] or [
24e70 73 71 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d  sqlite3_reset()]
24e80 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f 66 69 6e   or [sqlite3_fin
24e90 61 6c 69 7a 65 28 29 5d 0a 2a 2a 20 61 72 65 20  alize()].** are 
24ea0 63 61 6c 6c 65 64 20 66 72 6f 6d 20 61 20 64 69  called from a di
24eb0 66 66 65 72 65 6e 74 20 74 68 72 65 61 64 20 77  fferent thread w
24ec0 68 69 6c 65 20 61 6e 79 20 6f 66 20 74 68 65 73  hile any of thes
24ed0 65 20 72 6f 75 74 69 6e 65 73 0a 2a 2a 20 61 72  e routines.** ar
24ee0 65 20 70 65 6e 64 69 6e 67 2c 20 74 68 65 6e 20  e pending, then 
24ef0 74 68 65 20 72 65 73 75 6c 74 73 20 61 72 65 20  the results are 
24f00 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a  undefined..**.**
24f10 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 63 6f   ^The sqlite3_co
24f20 6c 75 6d 6e 5f 74 79 70 65 28 29 20 72 6f 75 74  lumn_type() rout
24f30 69 6e 65 20 72 65 74 75 72 6e 73 20 74 68 65 0a  ine returns the.
24f40 2a 2a 20 5b 53 51 4c 49 54 45 5f 49 4e 54 45 47  ** [SQLITE_INTEG
24f50 45 52 20 7c 20 64 61 74 61 74 79 70 65 20 63 6f  ER | datatype co
24f60 64 65 5d 20 66 6f 72 20 74 68 65 20 69 6e 69 74  de] for the init
24f70 69 61 6c 20 64 61 74 61 20 74 79 70 65 0a 2a 2a  ial data type.**
24f80 20 6f 66 20 74 68 65 20 72 65 73 75 6c 74 20 63   of the result c
24f90 6f 6c 75 6d 6e 2e 20 20 5e 54 68 65 20 72 65 74  olumn.  ^The ret
24fa0 75 72 6e 65 64 20 76 61 6c 75 65 20 69 73 20 6f  urned value is o
24fb0 6e 65 20 6f 66 20 5b 53 51 4c 49 54 45 5f 49 4e  ne of [SQLITE_IN
24fc0 54 45 47 45 52 5d 2c 0a 2a 2a 20 5b 53 51 4c 49  TEGER],.** [SQLI
24fd0 54 45 5f 46 4c 4f 41 54 5d 2c 20 5b 53 51 4c 49  TE_FLOAT], [SQLI
24fe0 54 45 5f 54 45 58 54 5d 2c 20 5b 53 51 4c 49 54  TE_TEXT], [SQLIT
24ff0 45 5f 42 4c 4f 42 5d 2c 20 6f 72 20 5b 53 51 4c  E_BLOB], or [SQL
25000 49 54 45 5f 4e 55 4c 4c 5d 2e 20 20 54 68 65 20  ITE_NULL].  The 
25010 76 61 6c 75 65 0a 2a 2a 20 72 65 74 75 72 6e 65  value.** returne
25020 64 20 62 79 20 73 71 6c 69 74 65 33 5f 63 6f 6c  d by sqlite3_col
25030 75 6d 6e 5f 74 79 70 65 28 29 20 69 73 20 6f 6e  umn_type() is on
25040 6c 79 20 6d 65 61 6e 69 6e 67 66 75 6c 20 69 66  ly meaningful if
25050 20 6e 6f 20 74 79 70 65 0a 2a 2a 20 63 6f 6e 76   no type.** conv
25060 65 72 73 69 6f 6e 73 20 68 61 76 65 20 6f 63 63  ersions have occ
25070 75 72 72 65 64 20 61 73 20 64 65 73 63 72 69 62  urred as describ
25080 65 64 20 62 65 6c 6f 77 2e 20 20 41 66 74 65 72  ed below.  After
25090 20 61 20 74 79 70 65 20 63 6f 6e 76 65 72 73 69   a type conversi
250a0 6f 6e 2c 0a 2a 2a 20 74 68 65 20 76 61 6c 75 65  on,.** the value
250b0 20 72 65 74 75 72 6e 65 64 20 62 79 20 73 71 6c   returned by sql
250c0 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 79 70 65  ite3_column_type
250d0 28 29 20 69 73 20 75 6e 64 65 66 69 6e 65 64 2e  () is undefined.
250e0 20 20 46 75 74 75 72 65 0a 2a 2a 20 76 65 72 73    Future.** vers
250f0 69 6f 6e 73 20 6f 66 20 53 51 4c 69 74 65 20 6d  ions of SQLite m
25100 61 79 20 63 68 61 6e 67 65 20 74 68 65 20 62 65  ay change the be
25110 68 61 76 69 6f 72 20 6f 66 20 73 71 6c 69 74 65  havior of sqlite
25120 33 5f 63 6f 6c 75 6d 6e 5f 74 79 70 65 28 29 0a  3_column_type().
25130 2a 2a 20 66 6f 6c 6c 6f 77 69 6e 67 20 61 20 74  ** following a t
25140 79 70 65 20 63 6f 6e 76 65 72 73 69 6f 6e 2e 0a  ype conversion..
25150 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 72 65  **.** ^If the re
25160 73 75 6c 74 20 69 73 20 61 20 42 4c 4f 42 20 6f  sult is a BLOB o
25170 72 20 55 54 46 2d 38 20 73 74 72 69 6e 67 20 74  r UTF-8 string t
25180 68 65 6e 20 74 68 65 20 73 71 6c 69 74 65 33 5f  hen the sqlite3_
25190 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29 0a 2a  column_bytes().*
251a0 2a 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e  * routine return
251b0 73 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20  s the number of 
251c0 62 79 74 65 73 20 69 6e 20 74 68 61 74 20 42 4c  bytes in that BL
251d0 4f 42 20 6f 72 20 73 74 72 69 6e 67 2e 0a 2a 2a  OB or string..**
251e0 20 5e 49 66 20 74 68 65 20 72 65 73 75 6c 74 20   ^If the result 
251f0 69 73 20 61 20 55 54 46 2d 31 36 20 73 74 72 69  is a UTF-16 stri
25200 6e 67 2c 20 74 68 65 6e 20 73 71 6c 69 74 65 33  ng, then sqlite3
25210 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29 20  _column_bytes() 
25220 63 6f 6e 76 65 72 74 73 0a 2a 2a 20 74 68 65 20  converts.** the 
25230 73 74 72 69 6e 67 20 74 6f 20 55 54 46 2d 38 20  string to UTF-8 
25240 61 6e 64 20 74 68 65 6e 20 72 65 74 75 72 6e 73  and then returns
25250 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 62   the number of b
25260 79 74 65 73 2e 0a 2a 2a 20 5e 49 66 20 74 68 65  ytes..** ^If the
25270 20 72 65 73 75 6c 74 20 69 73 20 61 20 6e 75 6d   result is a num
25280 65 72 69 63 20 76 61 6c 75 65 20 74 68 65 6e 20  eric value then 
25290 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62  sqlite3_column_b
252a0 79 74 65 73 28 29 20 75 73 65 73 0a 2a 2a 20 5b  ytes() uses.** [
252b0 73 71 6c 69 74 65 33 5f 73 6e 70 72 69 6e 74 66  sqlite3_snprintf
252c0 28 29 5d 20 74 6f 20 63 6f 6e 76 65 72 74 20 74  ()] to convert t
252d0 68 61 74 20 76 61 6c 75 65 20 74 6f 20 61 20 55  hat value to a U
252e0 54 46 2d 38 20 73 74 72 69 6e 67 20 61 6e 64 20  TF-8 string and 
252f0 72 65 74 75 72 6e 73 0a 2a 2a 20 74 68 65 20 6e  returns.** the n
25300 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73 20 69  umber of bytes i
25310 6e 20 74 68 61 74 20 73 74 72 69 6e 67 2e 0a 2a  n that string..*
25320 2a 20 5e 49 66 20 74 68 65 20 72 65 73 75 6c 74  * ^If the result
25330 20 69 73 20 4e 55 4c 4c 2c 20 74 68 65 6e 20 73   is NULL, then s
25340 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79  qlite3_column_by
25350 74 65 73 28 29 20 72 65 74 75 72 6e 73 20 7a 65  tes() returns ze
25360 72 6f 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68  ro..**.** ^If th
25370 65 20 72 65 73 75 6c 74 20 69 73 20 61 20 42 4c  e result is a BL
25380 4f 42 20 6f 72 20 55 54 46 2d 31 36 20 73 74 72  OB or UTF-16 str
25390 69 6e 67 20 74 68 65 6e 20 74 68 65 20 73 71 6c  ing then the sql
253a0 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65  ite3_column_byte
253b0 73 31 36 28 29 0a 2a 2a 20 72 6f 75 74 69 6e 65  s16().** routine
253c0 20 72 65 74 75 72 6e 73 20 74 68 65 20 6e 75 6d   returns the num
253d0 62 65 72 20 6f 66 20 62 79 74 65 73 20 69 6e 20  ber of bytes in 
253e0 74 68 61 74 20 42 4c 4f 42 20 6f 72 20 73 74 72  that BLOB or str
253f0 69 6e 67 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20  ing..** ^If the 
25400 72 65 73 75 6c 74 20 69 73 20 61 20 55 54 46 2d  result is a UTF-
25410 38 20 73 74 72 69 6e 67 2c 20 74 68 65 6e 20 73  8 string, then s
25420 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79  qlite3_column_by
25430 74 65 73 31 36 28 29 20 63 6f 6e 76 65 72 74 73  tes16() converts
25440 0a 2a 2a 20 74 68 65 20 73 74 72 69 6e 67 20 74  .** the string t
25450 6f 20 55 54 46 2d 31 36 20 61 6e 64 20 74 68 65  o UTF-16 and the
25460 6e 20 72 65 74 75 72 6e 73 20 74 68 65 20 6e 75  n returns the nu
25470 6d 62 65 72 20 6f 66 20 62 79 74 65 73 2e 0a 2a  mber of bytes..*
25480 2a 20 5e 49 66 20 74 68 65 20 72 65 73 75 6c 74  * ^If the result
25490 20 69 73 20 61 20 6e 75 6d 65 72 69 63 20 76 61   is a numeric va
254a0 6c 75 65 20 74 68 65 6e 20 73 71 6c 69 74 65 33  lue then sqlite3
254b0 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28  _column_bytes16(
254c0 29 20 75 73 65 73 0a 2a 2a 20 5b 73 71 6c 69 74  ) uses.** [sqlit
254d0 65 33 5f 73 6e 70 72 69 6e 74 66 28 29 5d 20 74  e3_snprintf()] t
254e0 6f 20 63 6f 6e 76 65 72 74 20 74 68 61 74 20 76  o convert that v
254f0 61 6c 75 65 20 74 6f 20 61 20 55 54 46 2d 31 36  alue to a UTF-16
25500 20 73 74 72 69 6e 67 20 61 6e 64 20 72 65 74 75   string and retu
25510 72 6e 73 0a 2a 2a 20 74 68 65 20 6e 75 6d 62 65  rns.** the numbe
25520 72 20 6f 66 20 62 79 74 65 73 20 69 6e 20 74 68  r of bytes in th
25530 61 74 20 73 74 72 69 6e 67 2e 0a 2a 2a 20 5e 49  at string..** ^I
25540 66 20 74 68 65 20 72 65 73 75 6c 74 20 69 73 20  f the result is 
25550 4e 55 4c 4c 2c 20 74 68 65 6e 20 73 71 6c 69 74  NULL, then sqlit
25560 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 31  e3_column_bytes1
25570 36 28 29 20 72 65 74 75 72 6e 73 20 7a 65 72 6f  6() returns zero
25580 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 76 61 6c  ..**.** ^The val
25590 75 65 73 20 72 65 74 75 72 6e 65 64 20 62 79 20  ues returned by 
255a0 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f  [sqlite3_column_
255b0 62 79 74 65 73 28 29 5d 20 61 6e 64 20 0a 2a 2a  bytes()] and .**
255c0 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e   [sqlite3_column
255d0 5f 62 79 74 65 73 31 36 28 29 5d 20 64 6f 20 6e  _bytes16()] do n
255e0 6f 74 20 69 6e 63 6c 75 64 65 20 74 68 65 20 7a  ot include the z
255f0 65 72 6f 20 74 65 72 6d 69 6e 61 74 6f 72 73 20  ero terminators 
25600 61 74 20 74 68 65 20 65 6e 64 0a 2a 2a 20 6f 66  at the end.** of
25610 20 74 68 65 20 73 74 72 69 6e 67 2e 20 20 5e 46   the string.  ^F
25620 6f 72 20 63 6c 61 72 69 74 79 3a 20 74 68 65 20  or clarity: the 
25630 76 61 6c 75 65 73 20 72 65 74 75 72 6e 65 64 20  values returned 
25640 62 79 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63  by.** [sqlite3_c
25650 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29 5d 20 61  olumn_bytes()] a
25660 6e 64 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75  nd [sqlite3_colu
25670 6d 6e 5f 62 79 74 65 73 31 36 28 29 5d 20 61 72  mn_bytes16()] ar
25680 65 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 0a  e the number of.
25690 2a 2a 20 62 79 74 65 73 20 69 6e 20 74 68 65 20  ** bytes in the 
256a0 73 74 72 69 6e 67 2c 20 6e 6f 74 20 74 68 65 20  string, not the 
256b0 6e 75 6d 62 65 72 20 6f 66 20 63 68 61 72 61 63  number of charac
256c0 74 65 72 73 2e 0a 2a 2a 0a 2a 2a 20 5e 53 74 72  ters..**.** ^Str
256d0 69 6e 67 73 20 72 65 74 75 72 6e 65 64 20 62 79  ings returned by
256e0 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f   sqlite3_column_
256f0 74 65 78 74 28 29 20 61 6e 64 20 73 71 6c 69 74  text() and sqlit
25700 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 31 36  e3_column_text16
25710 28 29 2c 0a 2a 2a 20 65 76 65 6e 20 65 6d 70 74  (),.** even empt
25720 79 20 73 74 72 69 6e 67 73 2c 20 61 72 65 20 61  y strings, are a
25730 6c 77 61 79 73 20 7a 65 72 6f 20 74 65 72 6d 69  lways zero termi
25740 6e 61 74 65 64 2e 20 20 5e 54 68 65 20 72 65 74  nated.  ^The ret
25750 75 72 6e 0a 2a 2a 20 76 61 6c 75 65 20 66 72 6f  urn.** value fro
25760 6d 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  m sqlite3_column
25770 5f 62 6c 6f 62 28 29 20 66 6f 72 20 61 20 7a 65  _blob() for a ze
25780 72 6f 2d 6c 65 6e 67 74 68 20 42 4c 4f 42 20 69  ro-length BLOB i
25790 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72  s a NULL pointer
257a0 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 6f 62 6a  ..**.** ^The obj
257b0 65 63 74 20 72 65 74 75 72 6e 65 64 20 62 79 20  ect returned by 
257c0 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f  [sqlite3_column_
257d0 76 61 6c 75 65 28 29 5d 20 69 73 20 61 6e 0a 2a  value()] is an.*
257e0 2a 20 5b 75 6e 70 72 6f 74 65 63 74 65 64 20 73  * [unprotected s
257f0 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62  qlite3_value] ob
25800 6a 65 63 74 2e 20 20 41 6e 20 75 6e 70 72 6f 74  ject.  An unprot
25810 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76 61  ected sqlite3_va
25820 6c 75 65 20 6f 62 6a 65 63 74 0a 2a 2a 20 6d 61  lue object.** ma
25830 79 20 6f 6e 6c 79 20 62 65 20 75 73 65 64 20 77  y only be used w
25840 69 74 68 20 5b 73 71 6c 69 74 65 33 5f 62 69 6e  ith [sqlite3_bin
25850 64 5f 76 61 6c 75 65 28 29 5d 20 61 6e 64 20 5b  d_value()] and [
25860 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 76  sqlite3_result_v
25870 61 6c 75 65 28 29 5d 2e 0a 2a 2a 20 49 66 20 74  alue()]..** If t
25880 68 65 20 5b 75 6e 70 72 6f 74 65 63 74 65 64 20  he [unprotected 
25890 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f  sqlite3_value] o
258a0 62 6a 65 63 74 20 72 65 74 75 72 6e 65 64 20 62  bject returned b
258b0 79 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 63 6f  y.** [sqlite3_co
258c0 6c 75 6d 6e 5f 76 61 6c 75 65 28 29 5d 20 69 73  lumn_value()] is
258d0 20 75 73 65 64 20 69 6e 20 61 6e 79 20 6f 74 68   used in any oth
258e0 65 72 20 77 61 79 2c 20 69 6e 63 6c 75 64 69 6e  er way, includin
258f0 67 20 63 61 6c 6c 73 0a 2a 2a 20 74 6f 20 72 6f  g calls.** to ro
25900 75 74 69 6e 65 73 20 6c 69 6b 65 20 5b 73 71 6c  utines like [sql
25910 69 74 65 33 5f 76 61 6c 75 65 5f 69 6e 74 28 29  ite3_value_int()
25920 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75  ], [sqlite3_valu
25930 65 5f 74 65 78 74 28 29 5d 2c 0a 2a 2a 20 6f 72  e_text()],.** or
25940 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f   [sqlite3_value_
25950 62 79 74 65 73 28 29 5d 2c 20 74 68 65 6e 20 74  bytes()], then t
25960 68 65 20 62 65 68 61 76 69 6f 72 20 69 73 20 75  he behavior is u
25970 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20  ndefined..**.** 
25980 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 61  These routines a
25990 74 74 65 6d 70 74 20 74 6f 20 63 6f 6e 76 65 72  ttempt to conver
259a0 74 20 74 68 65 20 76 61 6c 75 65 20 77 68 65 72  t the value wher
259b0 65 20 61 70 70 72 6f 70 72 69 61 74 65 2e 20 20  e appropriate.  
259c0 5e 46 6f 72 0a 2a 2a 20 65 78 61 6d 70 6c 65 2c  ^For.** example,
259d0 20 69 66 20 74 68 65 20 69 6e 74 65 72 6e 61 6c   if the internal
259e0 20 72 65 70 72 65 73 65 6e 74 61 74 69 6f 6e 20   representation 
259f0 69 73 20 46 4c 4f 41 54 20 61 6e 64 20 61 20 74  is FLOAT and a t
25a00 65 78 74 20 72 65 73 75 6c 74 0a 2a 2a 20 69 73  ext result.** is
25a10 20 72 65 71 75 65 73 74 65 64 2c 20 5b 73 71 6c   requested, [sql
25a20 69 74 65 33 5f 73 6e 70 72 69 6e 74 66 28 29 5d  ite3_snprintf()]
25a30 20 69 73 20 75 73 65 64 20 69 6e 74 65 72 6e 61   is used interna
25a40 6c 6c 79 20 74 6f 20 70 65 72 66 6f 72 6d 20 74  lly to perform t
25a50 68 65 0a 2a 2a 20 63 6f 6e 76 65 72 73 69 6f 6e  he.** conversion
25a60 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 2e 20   automatically. 
25a70 20 5e 28 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67   ^(The following
25a80 20 74 61 62 6c 65 20 64 65 74 61 69 6c 73 20 74   table details t
25a90 68 65 20 63 6f 6e 76 65 72 73 69 6f 6e 73 0a 2a  he conversions.*
25aa0 2a 20 74 68 61 74 20 61 72 65 20 61 70 70 6c 69  * that are appli
25ab0 65 64 3a 0a 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b  ed:.**.** <block
25ac0 71 75 6f 74 65 3e 0a 2a 2a 20 3c 74 61 62 6c 65  quote>.** <table
25ad0 20 62 6f 72 64 65 72 3d 22 31 22 3e 0a 2a 2a 20   border="1">.** 
25ae0 3c 74 72 3e 3c 74 68 3e 20 49 6e 74 65 72 6e 61  <tr><th> Interna
25af0 6c 3c 62 72 3e 54 79 70 65 20 3c 74 68 3e 20 52  l<br>Type <th> R
25b00 65 71 75 65 73 74 65 64 3c 62 72 3e 54 79 70 65  equested<br>Type
25b10 20 3c 74 68 3e 20 20 43 6f 6e 76 65 72 73 69 6f   <th>  Conversio
25b20 6e 0a 2a 2a 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e  n.**.** <tr><td>
25b30 20 20 4e 55 4c 4c 20 20 20 20 3c 74 64 3e 20 49    NULL    <td> I
25b40 4e 54 45 47 45 52 20 20 20 3c 74 64 3e 20 52 65  NTEGER   <td> Re
25b50 73 75 6c 74 20 69 73 20 30 0a 2a 2a 20 3c 74 72  sult is 0.** <tr
25b60 3e 3c 74 64 3e 20 20 4e 55 4c 4c 20 20 20 20 3c  ><td>  NULL    <
25b70 74 64 3e 20 20 46 4c 4f 41 54 20 20 20 20 3c 74  td>  FLOAT    <t
25b80 64 3e 20 52 65 73 75 6c 74 20 69 73 20 30 2e 30  d> Result is 0.0
25b90 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 4e 55  .** <tr><td>  NU
25ba0 4c 4c 20 20 20 20 3c 74 64 3e 20 20 20 54 45 58  LL    <td>   TEX
25bb0 54 20 20 20 20 3c 74 64 3e 20 52 65 73 75 6c 74  T    <td> Result
25bc0 20 69 73 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72   is NULL pointer
25bd0 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 4e 55  .** <tr><td>  NU
25be0 4c 4c 20 20 20 20 3c 74 64 3e 20 20 20 42 4c 4f  LL    <td>   BLO
25bf0 42 20 20 20 20 3c 74 64 3e 20 52 65 73 75 6c 74  B    <td> Result
25c00 20 69 73 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72   is NULL pointer
25c10 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 49 4e 54  .** <tr><td> INT
25c20 45 47 45 52 20 20 3c 74 64 3e 20 20 46 4c 4f 41  EGER  <td>  FLOA
25c30 54 20 20 20 20 3c 74 64 3e 20 43 6f 6e 76 65 72  T    <td> Conver
25c40 74 20 66 72 6f 6d 20 69 6e 74 65 67 65 72 20 74  t from integer t
25c50 6f 20 66 6c 6f 61 74 0a 2a 2a 20 3c 74 72 3e 3c  o float.** <tr><
25c60 74 64 3e 20 49 4e 54 45 47 45 52 20 20 3c 74 64  td> INTEGER  <td
25c70 3e 20 20 20 54 45 58 54 20 20 20 20 3c 74 64 3e  >   TEXT    <td>
25c80 20 41 53 43 49 49 20 72 65 6e 64 65 72 69 6e 67   ASCII rendering
25c90 20 6f 66 20 74 68 65 20 69 6e 74 65 67 65 72 0a   of the integer.
25ca0 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 49 4e 54 45  ** <tr><td> INTE
25cb0 47 45 52 20 20 3c 74 64 3e 20 20 20 42 4c 4f 42  GER  <td>   BLOB
25cc0 20 20 20 20 3c 74 64 3e 20 53 61 6d 65 20 61 73      <td> Same as
25cd0 20 49 4e 54 45 47 45 52 2d 3e 54 45 58 54 0a 2a   INTEGER->TEXT.*
25ce0 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 46 4c 4f 41  * <tr><td>  FLOA
25cf0 54 20 20 20 3c 74 64 3e 20 49 4e 54 45 47 45 52  T   <td> INTEGER
25d00 20 20 20 3c 74 64 3e 20 43 6f 6e 76 65 72 74 20     <td> Convert 
25d10 66 72 6f 6d 20 66 6c 6f 61 74 20 74 6f 20 69 6e  from float to in
25d20 74 65 67 65 72 0a 2a 2a 20 3c 74 72 3e 3c 74 64  teger.** <tr><td
25d30 3e 20 20 46 4c 4f 41 54 20 20 20 3c 74 64 3e 20  >  FLOAT   <td> 
25d40 20 20 54 45 58 54 20 20 20 20 3c 74 64 3e 20 41    TEXT    <td> A
25d50 53 43 49 49 20 72 65 6e 64 65 72 69 6e 67 20 6f  SCII rendering o
25d60 66 20 74 68 65 20 66 6c 6f 61 74 0a 2a 2a 20 3c  f the float.** <
25d70 74 72 3e 3c 74 64 3e 20 20 46 4c 4f 41 54 20 20  tr><td>  FLOAT  
25d80 20 3c 74 64 3e 20 20 20 42 4c 4f 42 20 20 20 20   <td>   BLOB    
25d90 3c 74 64 3e 20 53 61 6d 65 20 61 73 20 46 4c 4f  <td> Same as FLO
25da0 41 54 2d 3e 54 45 58 54 0a 2a 2a 20 3c 74 72 3e  AT->TEXT.** <tr>
25db0 3c 74 64 3e 20 20 54 45 58 54 20 20 20 20 3c 74  <td>  TEXT    <t
25dc0 64 3e 20 49 4e 54 45 47 45 52 20 20 20 3c 74 64  d> INTEGER   <td
25dd0 3e 20 55 73 65 20 61 74 6f 69 28 29 0a 2a 2a 20  > Use atoi().** 
25de0 3c 74 72 3e 3c 74 64 3e 20 20 54 45 58 54 20 20  <tr><td>  TEXT  
25df0 20 20 3c 74 64 3e 20 20 46 4c 4f 41 54 20 20 20    <td>  FLOAT   
25e00 20 3c 74 64 3e 20 55 73 65 20 61 74 6f 66 28 29   <td> Use atof()
25e10 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 20 54 45  .** <tr><td>  TE
25e20 58 54 20 20 20 20 3c 74 64 3e 20 20 20 42 4c 4f  XT    <td>   BLO
25e30 42 20 20 20 20 3c 74 64 3e 20 4e 6f 20 63 68 61  B    <td> No cha
25e40 6e 67 65 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20  nge.** <tr><td> 
25e50 20 42 4c 4f 42 20 20 20 20 3c 74 64 3e 20 49 4e   BLOB    <td> IN
25e60 54 45 47 45 52 20 20 20 3c 74 64 3e 20 43 6f 6e  TEGER   <td> Con
25e70 76 65 72 74 20 74 6f 20 54 45 58 54 20 74 68 65  vert to TEXT the
25e80 6e 20 75 73 65 20 61 74 6f 69 28 29 0a 2a 2a 20  n use atoi().** 
25e90 3c 74 72 3e 3c 74 64 3e 20 20 42 4c 4f 42 20 20  <tr><td>  BLOB  
25ea0 20 20 3c 74 64 3e 20 20 46 4c 4f 41 54 20 20 20    <td>  FLOAT   
25eb0 20 3c 74 64 3e 20 43 6f 6e 76 65 72 74 20 74 6f   <td> Convert to
25ec0 20 54 45 58 54 20 74 68 65 6e 20 75 73 65 20 61   TEXT then use a
25ed0 74 6f 66 28 29 0a 2a 2a 20 3c 74 72 3e 3c 74 64  tof().** <tr><td
25ee0 3e 20 20 42 4c 4f 42 20 20 20 20 3c 74 64 3e 20  >  BLOB    <td> 
25ef0 20 20 54 45 58 54 20 20 20 20 3c 74 64 3e 20 41    TEXT    <td> A
25f00 64 64 20 61 20 7a 65 72 6f 20 74 65 72 6d 69 6e  dd a zero termin
25f10 61 74 6f 72 20 69 66 20 6e 65 65 64 65 64 0a 2a  ator if needed.*
25f20 2a 20 3c 2f 74 61 62 6c 65 3e 0a 2a 2a 20 3c 2f  * </table>.** </
25f30 62 6c 6f 63 6b 71 75 6f 74 65 3e 29 5e 0a 2a 2a  blockquote>)^.**
25f40 0a 2a 2a 20 54 68 65 20 74 61 62 6c 65 20 61 62  .** The table ab
25f50 6f 76 65 20 6d 61 6b 65 73 20 72 65 66 65 72 65  ove makes refere
25f60 6e 63 65 20 74 6f 20 73 74 61 6e 64 61 72 64 20  nce to standard 
25f70 43 20 6c 69 62 72 61 72 79 20 66 75 6e 63 74 69  C library functi
25f80 6f 6e 73 20 61 74 6f 69 28 29 0a 2a 2a 20 61 6e  ons atoi().** an
25f90 64 20 61 74 6f 66 28 29 2e 20 20 53 51 4c 69 74  d atof().  SQLit
25fa0 65 20 64 6f 65 73 20 6e 6f 74 20 72 65 61 6c 6c  e does not reall
25fb0 79 20 75 73 65 20 74 68 65 73 65 20 66 75 6e 63  y use these func
25fc0 74 69 6f 6e 73 2e 20 20 49 74 20 68 61 73 20 69  tions.  It has i
25fd0 74 73 0a 2a 2a 20 6f 77 6e 20 65 71 75 69 76 61  ts.** own equiva
25fe0 6c 65 6e 74 20 69 6e 74 65 72 6e 61 6c 20 72 6f  lent internal ro
25ff0 75 74 69 6e 65 73 2e 20 20 54 68 65 20 61 74 6f  utines.  The ato
26000 69 28 29 20 61 6e 64 20 61 74 6f 66 28 29 20 6e  i() and atof() n
26010 61 6d 65 73 20 61 72 65 0a 2a 2a 20 75 73 65 64  ames are.** used
26020 20 69 6e 20 74 68 65 20 74 61 62 6c 65 20 66 6f   in the table fo
26030 72 20 62 72 65 76 69 74 79 20 61 6e 64 20 62 65  r brevity and be
26040 63 61 75 73 65 20 74 68 65 79 20 61 72 65 20 66  cause they are f
26050 61 6d 69 6c 69 61 72 20 74 6f 20 6d 6f 73 74 0a  amiliar to most.
26060 2a 2a 20 43 20 70 72 6f 67 72 61 6d 6d 65 72 73  ** C programmers
26070 2e 0a 2a 2a 0a 2a 2a 20 4e 6f 74 65 20 74 68 61  ..**.** Note tha
26080 74 20 77 68 65 6e 20 74 79 70 65 20 63 6f 6e 76  t when type conv
26090 65 72 73 69 6f 6e 73 20 6f 63 63 75 72 2c 20 70  ersions occur, p
260a0 6f 69 6e 74 65 72 73 20 72 65 74 75 72 6e 65 64  ointers returned
260b0 20 62 79 20 70 72 69 6f 72 0a 2a 2a 20 63 61 6c   by prior.** cal
260c0 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 5f 63 6f  ls to sqlite3_co
260d0 6c 75 6d 6e 5f 62 6c 6f 62 28 29 2c 20 73 71 6c  lumn_blob(), sql
260e0 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74  ite3_column_text
260f0 28 29 2c 20 61 6e 64 2f 6f 72 0a 2a 2a 20 73 71  (), and/or.** sq
26100 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78  lite3_column_tex
26110 74 31 36 28 29 20 6d 61 79 20 62 65 20 69 6e 76  t16() may be inv
26120 61 6c 69 64 61 74 65 64 2e 0a 2a 2a 20 54 79 70  alidated..** Typ
26130 65 20 63 6f 6e 76 65 72 73 69 6f 6e 73 20 61 6e  e conversions an
26140 64 20 70 6f 69 6e 74 65 72 20 69 6e 76 61 6c 69  d pointer invali
26150 64 61 74 69 6f 6e 73 20 6d 69 67 68 74 20 6f 63  dations might oc
26160 63 75 72 0a 2a 2a 20 69 6e 20 74 68 65 20 66 6f  cur.** in the fo
26170 6c 6c 6f 77 69 6e 67 20 63 61 73 65 73 3a 0a 2a  llowing cases:.*
26180 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a 2a 20 3c 6c 69  *.** <ul>.** <li
26190 3e 20 54 68 65 20 69 6e 69 74 69 61 6c 20 63 6f  > The initial co
261a0 6e 74 65 6e 74 20 69 73 20 61 20 42 4c 4f 42 20  ntent is a BLOB 
261b0 61 6e 64 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75  and sqlite3_colu
261c0 6d 6e 5f 74 65 78 74 28 29 20 6f 72 0a 2a 2a 20  mn_text() or.** 
261d0 20 20 20 20 20 73 71 6c 69 74 65 33 5f 63 6f 6c       sqlite3_col
261e0 75 6d 6e 5f 74 65 78 74 31 36 28 29 20 69 73 20  umn_text16() is 
261f0 63 61 6c 6c 65 64 2e 20 20 41 20 7a 65 72 6f 2d  called.  A zero-
26200 74 65 72 6d 69 6e 61 74 6f 72 20 6d 69 67 68 74  terminator might
26210 0a 2a 2a 20 20 20 20 20 20 6e 65 65 64 20 74 6f  .**      need to
26220 20 62 65 20 61 64 64 65 64 20 74 6f 20 74 68 65   be added to the
26230 20 73 74 72 69 6e 67 2e 3c 2f 6c 69 3e 0a 2a 2a   string.</li>.**
26240 20 3c 6c 69 3e 20 54 68 65 20 69 6e 69 74 69 61   <li> The initia
26250 6c 20 63 6f 6e 74 65 6e 74 20 69 73 20 55 54 46  l content is UTF
26260 2d 38 20 74 65 78 74 20 61 6e 64 20 73 71 6c 69  -8 text and sqli
26270 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73  te3_column_bytes
26280 31 36 28 29 20 6f 72 0a 2a 2a 20 20 20 20 20 20  16() or.**      
26290 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74  sqlite3_column_t
262a0 65 78 74 31 36 28 29 20 69 73 20 63 61 6c 6c 65  ext16() is calle
262b0 64 2e 20 20 54 68 65 20 63 6f 6e 74 65 6e 74 20  d.  The content 
262c0 6d 75 73 74 20 62 65 20 63 6f 6e 76 65 72 74 65  must be converte
262d0 64 0a 2a 2a 20 20 20 20 20 20 74 6f 20 55 54 46  d.**      to UTF
262e0 2d 31 36 2e 3c 2f 6c 69 3e 0a 2a 2a 20 3c 6c 69  -16.</li>.** <li
262f0 3e 20 54 68 65 20 69 6e 69 74 69 61 6c 20 63 6f  > The initial co
26300 6e 74 65 6e 74 20 69 73 20 55 54 46 2d 31 36 20  ntent is UTF-16 
26310 74 65 78 74 20 61 6e 64 20 73 71 6c 69 74 65 33  text and sqlite3
26320 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29 20  _column_bytes() 
26330 6f 72 0a 2a 2a 20 20 20 20 20 20 73 71 6c 69 74  or.**      sqlit
26340 65 33 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 29  e3_column_text()
26350 20 69 73 20 63 61 6c 6c 65 64 2e 20 20 54 68 65   is called.  The
26360 20 63 6f 6e 74 65 6e 74 20 6d 75 73 74 20 62 65   content must be
26370 20 63 6f 6e 76 65 72 74 65 64 0a 2a 2a 20 20 20   converted.**   
26380 20 20 20 74 6f 20 55 54 46 2d 38 2e 3c 2f 6c 69     to UTF-8.</li
26390 3e 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a 0a 2a 2a  >.** </ul>.**.**
263a0 20 5e 43 6f 6e 76 65 72 73 69 6f 6e 73 20 62 65   ^Conversions be
263b0 74 77 65 65 6e 20 55 54 46 2d 31 36 62 65 20 61  tween UTF-16be a
263c0 6e 64 20 55 54 46 2d 31 36 6c 65 20 61 72 65 20  nd UTF-16le are 
263d0 61 6c 77 61 79 73 20 64 6f 6e 65 20 69 6e 20 70  always done in p
263e0 6c 61 63 65 20 61 6e 64 20 64 6f 0a 2a 2a 20 6e  lace and do.** n
263f0 6f 74 20 69 6e 76 61 6c 69 64 61 74 65 20 61 20  ot invalidate a 
26400 70 72 69 6f 72 20 70 6f 69 6e 74 65 72 2c 20 74  prior pointer, t
26410 68 6f 75 67 68 20 6f 66 20 63 6f 75 72 73 65 20  hough of course 
26420 74 68 65 20 63 6f 6e 74 65 6e 74 20 6f 66 20 74  the content of t
26430 68 65 20 62 75 66 66 65 72 0a 2a 2a 20 74 68 61  he buffer.** tha
26440 74 20 74 68 65 20 70 72 69 6f 72 20 70 6f 69 6e  t the prior poin
26450 74 65 72 20 72 65 66 65 72 65 6e 63 65 73 20 77  ter references w
26460 69 6c 6c 20 68 61 76 65 20 62 65 65 6e 20 6d 6f  ill have been mo
26470 64 69 66 69 65 64 2e 20 20 4f 74 68 65 72 20 6b  dified.  Other k
26480 69 6e 64 73 0a 2a 2a 20 6f 66 20 63 6f 6e 76 65  inds.** of conve
26490 72 73 69 6f 6e 20 61 72 65 20 64 6f 6e 65 20 69  rsion are done i
264a0 6e 20 70 6c 61 63 65 20 77 68 65 6e 20 69 74 20  n place when it 
264b0 69 73 20 70 6f 73 73 69 62 6c 65 2c 20 62 75 74  is possible, but
264c0 20 73 6f 6d 65 74 69 6d 65 73 20 74 68 65 79 0a   sometimes they.
264d0 2a 2a 20 61 72 65 20 6e 6f 74 20 70 6f 73 73 69  ** are not possi
264e0 62 6c 65 20 61 6e 64 20 69 6e 20 74 68 6f 73 65  ble and in those
264f0 20 63 61 73 65 73 20 70 72 69 6f 72 20 70 6f 69   cases prior poi
26500 6e 74 65 72 73 20 61 72 65 20 69 6e 76 61 6c 69  nters are invali
26510 64 61 74 65 64 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  dated..**.** The
26520 20 73 61 66 65 73 74 20 61 6e 64 20 65 61 73 69   safest and easi
26530 65 73 74 20 74 6f 20 72 65 6d 65 6d 62 65 72 20  est to remember 
26540 70 6f 6c 69 63 79 20 69 73 20 74 6f 20 69 6e 76  policy is to inv
26550 6f 6b 65 20 74 68 65 73 65 20 72 6f 75 74 69 6e  oke these routin
26560 65 73 0a 2a 2a 20 69 6e 20 6f 6e 65 20 6f 66 20  es.** in one of 
26570 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 77 61  the following wa
26580 79 73 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e 0a 2a  ys:.**.** <ul>.*
26590 2a 20 20 3c 6c 69 3e 73 71 6c 69 74 65 33 5f 63  *  <li>sqlite3_c
265a0 6f 6c 75 6d 6e 5f 74 65 78 74 28 29 20 66 6f 6c  olumn_text() fol
265b0 6c 6f 77 65 64 20 62 79 20 73 71 6c 69 74 65 33  lowed by sqlite3
265c0 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28 29 3c  _column_bytes()<
265d0 2f 6c 69 3e 0a 2a 2a 20 20 3c 6c 69 3e 73 71 6c  /li>.**  <li>sql
265e0 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 6c 6f 62  ite3_column_blob
265f0 28 29 20 66 6f 6c 6c 6f 77 65 64 20 62 79 20 73  () followed by s
26600 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79  qlite3_column_by
26610 74 65 73 28 29 3c 2f 6c 69 3e 0a 2a 2a 20 20 3c  tes()</li>.**  <
26620 6c 69 3e 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  li>sqlite3_colum
26630 6e 5f 74 65 78 74 31 36 28 29 20 66 6f 6c 6c 6f  n_text16() follo
26640 77 65 64 20 62 79 20 73 71 6c 69 74 65 33 5f 63  wed by sqlite3_c
26650 6f 6c 75 6d 6e 5f 62 79 74 65 73 31 36 28 29 3c  olumn_bytes16()<
26660 2f 6c 69 3e 0a 2a 2a 20 3c 2f 75 6c 3e 0a 2a 2a  /li>.** </ul>.**
26670 0a 2a 2a 20 49 6e 20 6f 74 68 65 72 20 77 6f 72  .** In other wor
26680 64 73 2c 20 79 6f 75 20 73 68 6f 75 6c 64 20 63  ds, you should c
26690 61 6c 6c 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75  all sqlite3_colu
266a0 6d 6e 5f 74 65 78 74 28 29 2c 0a 2a 2a 20 73 71  mn_text(),.** sq
266b0 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 6c 6f  lite3_column_blo
266c0 62 28 29 2c 20 6f 72 20 73 71 6c 69 74 65 33 5f  b(), or sqlite3_
266d0 63 6f 6c 75 6d 6e 5f 74 65 78 74 31 36 28 29 20  column_text16() 
266e0 66 69 72 73 74 20 74 6f 20 66 6f 72 63 65 20 74  first to force t
266f0 68 65 20 72 65 73 75 6c 74 0a 2a 2a 20 69 6e 74  he result.** int
26700 6f 20 74 68 65 20 64 65 73 69 72 65 64 20 66 6f  o the desired fo
26710 72 6d 61 74 2c 20 74 68 65 6e 20 69 6e 76 6f 6b  rmat, then invok
26720 65 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  e sqlite3_column
26730 5f 62 79 74 65 73 28 29 20 6f 72 0a 2a 2a 20 73  _bytes() or.** s
26740 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79  qlite3_column_by
26750 74 65 73 31 36 28 29 20 74 6f 20 66 69 6e 64 20  tes16() to find 
26760 74 68 65 20 73 69 7a 65 20 6f 66 20 74 68 65 20  the size of the 
26770 72 65 73 75 6c 74 2e 20 20 44 6f 20 6e 6f 74 20  result.  Do not 
26780 6d 69 78 20 63 61 6c 6c 73 0a 2a 2a 20 74 6f 20  mix calls.** to 
26790 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 74  sqlite3_column_t
267a0 65 78 74 28 29 20 6f 72 20 73 71 6c 69 74 65 33  ext() or sqlite3
267b0 5f 63 6f 6c 75 6d 6e 5f 62 6c 6f 62 28 29 20 77  _column_blob() w
267c0 69 74 68 20 63 61 6c 6c 73 20 74 6f 0a 2a 2a 20  ith calls to.** 
267d0 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62  sqlite3_column_b
267e0 79 74 65 73 31 36 28 29 2c 20 61 6e 64 20 64 6f  ytes16(), and do
267f0 20 6e 6f 74 20 6d 69 78 20 63 61 6c 6c 73 20 74   not mix calls t
26800 6f 20 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e  o sqlite3_column
26810 5f 74 65 78 74 31 36 28 29 0a 2a 2a 20 77 69 74  _text16().** wit
26820 68 20 63 61 6c 6c 73 20 74 6f 20 73 71 6c 69 74  h calls to sqlit
26830 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28  e3_column_bytes(
26840 29 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 70 6f  )..**.** ^The po
26850 69 6e 74 65 72 73 20 72 65 74 75 72 6e 65 64 20  inters returned 
26860 61 72 65 20 76 61 6c 69 64 20 75 6e 74 69 6c 20  are valid until 
26870 61 20 74 79 70 65 20 63 6f 6e 76 65 72 73 69 6f  a type conversio
26880 6e 20 6f 63 63 75 72 73 20 61 73 0a 2a 2a 20 64  n occurs as.** d
26890 65 73 63 72 69 62 65 64 20 61 62 6f 76 65 2c 20  escribed above, 
268a0 6f 72 20 75 6e 74 69 6c 20 5b 73 71 6c 69 74 65  or until [sqlite
268b0 33 5f 73 74 65 70 28 29 5d 20 6f 72 20 5b 73 71  3_step()] or [sq
268c0 6c 69 74 65 33 5f 72 65 73 65 74 28 29 5d 20 6f  lite3_reset()] o
268d0 72 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 66 69  r.** [sqlite3_fi
268e0 6e 61 6c 69 7a 65 28 29 5d 20 69 73 20 63 61 6c  nalize()] is cal
268f0 6c 65 64 2e 20 20 5e 54 68 65 20 6d 65 6d 6f 72  led.  ^The memor
26900 79 20 73 70 61 63 65 20 75 73 65 64 20 74 6f 20  y space used to 
26910 68 6f 6c 64 20 73 74 72 69 6e 67 73 0a 2a 2a 20  hold strings.** 
26920 61 6e 64 20 42 4c 4f 42 73 20 69 73 20 66 72 65  and BLOBs is fre
26930 65 64 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79  ed automatically
26940 2e 20 20 44 6f 20 3c 62 3e 6e 6f 74 3c 2f 62 3e  .  Do <b>not</b>
26950 20 70 61 73 73 20 74 68 65 20 70 6f 69 6e 74 65   pass the pointe
26960 72 73 20 72 65 74 75 72 6e 65 64 0a 2a 2a 20 5b  rs returned.** [
26970 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62  sqlite3_column_b
26980 6c 6f 62 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33  lob()], [sqlite3
26990 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 29 5d 2c  _column_text()],
269a0 20 65 74 63 2e 20 69 6e 74 6f 0a 2a 2a 20 5b 73   etc. into.** [s
269b0 71 6c 69 74 65 33 5f 66 72 65 65 28 29 5d 2e 0a  qlite3_free()]..
269c0 2a 2a 0a 2a 2a 20 5e 28 49 66 20 61 20 6d 65 6d  **.** ^(If a mem
269d0 6f 72 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 20 65  ory allocation e
269e0 72 72 6f 72 20 6f 63 63 75 72 73 20 64 75 72 69  rror occurs duri
269f0 6e 67 20 74 68 65 20 65 76 61 6c 75 61 74 69 6f  ng the evaluatio
26a00 6e 20 6f 66 20 61 6e 79 0a 2a 2a 20 6f 66 20 74  n of any.** of t
26a10 68 65 73 65 20 72 6f 75 74 69 6e 65 73 2c 20 61  hese routines, a
26a20 20 64 65 66 61 75 6c 74 20 76 61 6c 75 65 20 69   default value i
26a30 73 20 72 65 74 75 72 6e 65 64 2e 20 20 54 68 65  s returned.  The
26a40 20 64 65 66 61 75 6c 74 20 76 61 6c 75 65 0a 2a   default value.*
26a50 2a 20 69 73 20 65 69 74 68 65 72 20 74 68 65 20  * is either the 
26a60 69 6e 74 65 67 65 72 20 30 2c 20 74 68 65 20 66  integer 0, the f
26a70 6c 6f 61 74 69 6e 67 20 70 6f 69 6e 74 20 6e 75  loating point nu
26a80 6d 62 65 72 20 30 2e 30 2c 20 6f 72 20 61 20 4e  mber 0.0, or a N
26a90 55 4c 4c 0a 2a 2a 20 70 6f 69 6e 74 65 72 2e 20  ULL.** pointer. 
26aa0 20 53 75 62 73 65 71 75 65 6e 74 20 63 61 6c 6c   Subsequent call
26ab0 73 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 65 72  s to [sqlite3_er
26ac0 72 63 6f 64 65 28 29 5d 20 77 69 6c 6c 20 72 65  rcode()] will re
26ad0 74 75 72 6e 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f  turn.** [SQLITE_
26ae0 4e 4f 4d 45 4d 5d 2e 29 5e 0a 2a 2f 0a 63 6f 6e  NOMEM].)^.*/.con
26af0 73 74 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33  st void *sqlite3
26b00 5f 63 6f 6c 75 6d 6e 5f 62 6c 6f 62 28 73 71 6c  _column_blob(sql
26b10 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20  ite3_stmt*, int 
26b20 69 43 6f 6c 29 3b 0a 69 6e 74 20 73 71 6c 69 74  iCol);.int sqlit
26b30 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74 65 73 28  e3_column_bytes(
26b40 73 71 6c 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69  sqlite3_stmt*, i
26b50 6e 74 20 69 43 6f 6c 29 3b 0a 69 6e 74 20 73 71  nt iCol);.int sq
26b60 6c 69 74 65 33 5f 63 6f 6c 75 6d 6e 5f 62 79 74  lite3_column_byt
26b70 65 73 31 36 28 73 71 6c 69 74 65 33 5f 73 74 6d  es16(sqlite3_stm
26b80 74 2a 2c 20 69 6e 74 20 69 43 6f 6c 29 3b 0a 64  t*, int iCol);.d
26b90 6f 75 62 6c 65 20 73 71 6c 69 74 65 33 5f 63 6f  ouble sqlite3_co
26ba0 6c 75 6d 6e 5f 64 6f 75 62 6c 65 28 73 71 6c 69  lumn_double(sqli
26bb0 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69  te3_stmt*, int i
26bc0 43 6f 6c 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  Col);.int sqlite
26bd0 33 5f 63 6f 6c 75 6d 6e 5f 69 6e 74 28 73 71 6c  3_column_int(sql
26be0 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20  ite3_stmt*, int 
26bf0 69 43 6f 6c 29 3b 0a 73 71 6c 69 74 65 33 5f 69  iCol);.sqlite3_i
26c00 6e 74 36 34 20 73 71 6c 69 74 65 33 5f 63 6f 6c  nt64 sqlite3_col
26c10 75 6d 6e 5f 69 6e 74 36 34 28 73 71 6c 69 74 65  umn_int64(sqlite
26c20 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43 6f  3_stmt*, int iCo
26c30 6c 29 3b 0a 63 6f 6e 73 74 20 75 6e 73 69 67 6e  l);.const unsign
26c40 65 64 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33  ed char *sqlite3
26c50 5f 63 6f 6c 75 6d 6e 5f 74 65 78 74 28 73 71 6c  _column_text(sql
26c60 69 74 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20  ite3_stmt*, int 
26c70 69 43 6f 6c 29 3b 0a 63 6f 6e 73 74 20 76 6f 69  iCol);.const voi
26c80 64 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75 6d  d *sqlite3_colum
26c90 6e 5f 74 65 78 74 31 36 28 73 71 6c 69 74 65 33  n_text16(sqlite3
26ca0 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43 6f 6c  _stmt*, int iCol
26cb0 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 63  );.int sqlite3_c
26cc0 6f 6c 75 6d 6e 5f 74 79 70 65 28 73 71 6c 69 74  olumn_type(sqlit
26cd0 65 33 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43  e3_stmt*, int iC
26ce0 6f 6c 29 3b 0a 73 71 6c 69 74 65 33 5f 76 61 6c  ol);.sqlite3_val
26cf0 75 65 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6c 75  ue *sqlite3_colu
26d00 6d 6e 5f 76 61 6c 75 65 28 73 71 6c 69 74 65 33  mn_value(sqlite3
26d10 5f 73 74 6d 74 2a 2c 20 69 6e 74 20 69 43 6f 6c  _stmt*, int iCol
26d20 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
26d30 45 46 3a 20 44 65 73 74 72 6f 79 20 41 20 50 72  EF: Destroy A Pr
26d40 65 70 61 72 65 64 20 53 74 61 74 65 6d 65 6e 74  epared Statement
26d50 20 4f 62 6a 65 63 74 0a 2a 2a 0a 2a 2a 20 5e 54   Object.**.** ^T
26d60 68 65 20 73 71 6c 69 74 65 33 5f 66 69 6e 61 6c  he sqlite3_final
26d70 69 7a 65 28 29 20 66 75 6e 63 74 69 6f 6e 20 69  ize() function i
26d80 73 20 63 61 6c 6c 65 64 20 74 6f 20 64 65 6c 65  s called to dele
26d90 74 65 20 61 20 5b 70 72 65 70 61 72 65 64 20 73  te a [prepared s
26da0 74 61 74 65 6d 65 6e 74 5d 2e 0a 2a 2a 20 5e 49  tatement]..** ^I
26db0 66 20 74 68 65 20 6d 6f 73 74 20 72 65 63 65 6e  f the most recen
26dc0 74 20 65 76 61 6c 75 61 74 69 6f 6e 20 6f 66 20  t evaluation of 
26dd0 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20 65 6e  the statement en
26de0 63 6f 75 6e 74 65 72 65 64 20 6e 6f 20 65 72 72  countered no err
26df0 6f 72 73 20 6f 72 0a 2a 2a 20 6f 72 20 69 66 20  ors or.** or if 
26e00 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20 69 73  the statement is
26e10 20 6e 65 76 65 72 20 62 65 65 6e 20 65 76 61 6c   never been eval
26e20 75 61 74 65 64 2c 20 74 68 65 6e 20 73 71 6c 69  uated, then sqli
26e30 74 65 33 5f 66 69 6e 61 6c 69 7a 65 28 29 20 72  te3_finalize() r
26e40 65 74 75 72 6e 73 0a 2a 2a 20 53 51 4c 49 54 45  eturns.** SQLITE
26e50 5f 4f 4b 2e 20 20 5e 49 66 20 74 68 65 20 6d 6f  _OK.  ^If the mo
26e60 73 74 20 72 65 63 65 6e 74 20 65 76 61 6c 75 61  st recent evalua
26e70 74 69 6f 6e 20 6f 66 20 73 74 61 74 65 6d 65 6e  tion of statemen
26e80 74 20 53 20 66 61 69 6c 65 64 2c 20 74 68 65 6e  t S failed, then
26e90 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 66 69 6e 61  .** sqlite3_fina
26ea0 6c 69 7a 65 28 53 29 20 72 65 74 75 72 6e 73 20  lize(S) returns 
26eb0 74 68 65 20 61 70 70 72 6f 70 72 69 61 74 65 20  the appropriate 
26ec0 5b 65 72 72 6f 72 20 63 6f 64 65 5d 20 6f 72 0a  [error code] or.
26ed0 2a 2a 20 5b 65 78 74 65 6e 64 65 64 20 65 72 72  ** [extended err
26ee0 6f 72 20 63 6f 64 65 5d 2e 0a 2a 2a 0a 2a 2a 20  or code]..**.** 
26ef0 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 66 69 6e  ^The sqlite3_fin
26f00 61 6c 69 7a 65 28 53 29 20 72 6f 75 74 69 6e 65  alize(S) routine
26f10 20 63 61 6e 20 62 65 20 63 61 6c 6c 65 64 20 61   can be called a
26f20 74 20 61 6e 79 20 70 6f 69 6e 74 20 64 75 72 69  t any point duri
26f30 6e 67 0a 2a 2a 20 74 68 65 20 6c 69 66 65 20 63  ng.** the life c
26f40 79 63 6c 65 20 6f 66 20 5b 70 72 65 70 61 72 65  ycle of [prepare
26f50 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 53 3a 0a  d statement] S:.
26f60 2a 2a 20 62 65 66 6f 72 65 20 73 74 61 74 65 6d  ** before statem
26f70 65 6e 74 20 53 20 69 73 20 65 76 65 72 20 65 76  ent S is ever ev
26f80 61 6c 75 61 74 65 64 2c 20 61 66 74 65 72 0a 2a  aluated, after.*
26f90 2a 20 6f 6e 65 20 6f 72 20 6d 6f 72 65 20 63 61  * one or more ca
26fa0 6c 6c 73 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f  lls to [sqlite3_
26fb0 72 65 73 65 74 28 29 5d 2c 20 6f 72 20 61 66 74  reset()], or aft
26fc0 65 72 20 61 6e 79 20 63 61 6c 6c 0a 2a 2a 20 74  er any call.** t
26fd0 6f 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70 28  o [sqlite3_step(
26fe0 29 5d 20 72 65 67 61 72 64 6c 65 73 73 20 6f 66  )] regardless of
26ff0 20 77 68 65 74 68 65 72 20 6f 72 20 6e 6f 74 20   whether or not 
27000 74 68 65 20 73 74 61 74 65 6d 65 6e 74 20 68 61  the statement ha
27010 73 0a 2a 2a 20 63 6f 6d 70 6c 65 74 65 64 20 65  s.** completed e
27020 78 65 63 75 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20  xecution..**.** 
27030 5e 49 6e 76 6f 6b 69 6e 67 20 73 71 6c 69 74 65  ^Invoking sqlite
27040 33 5f 66 69 6e 61 6c 69 7a 65 28 29 20 6f 6e 20  3_finalize() on 
27050 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 69  a NULL pointer i
27060 73 20 61 20 68 61 72 6d 6c 65 73 73 20 6e 6f 2d  s a harmless no-
27070 6f 70 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 61 70  op..**.** The ap
27080 70 6c 69 63 61 74 69 6f 6e 20 6d 75 73 74 20 66  plication must f
27090 69 6e 61 6c 69 7a 65 20 65 76 65 72 79 20 5b 70  inalize every [p
270a0 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e  repared statemen
270b0 74 5d 20 69 6e 20 6f 72 64 65 72 20 74 6f 20 61  t] in order to a
270c0 76 6f 69 64 0a 2a 2a 20 72 65 73 6f 75 72 63 65  void.** resource
270d0 20 6c 65 61 6b 73 2e 20 20 49 74 20 69 73 20 61   leaks.  It is a
270e0 20 67 72 69 65 76 6f 75 73 20 65 72 72 6f 72 20   grievous error 
270f0 66 6f 72 20 74 68 65 20 61 70 70 6c 69 63 61 74  for the applicat
27100 69 6f 6e 20 74 6f 20 74 72 79 20 74 6f 20 75 73  ion to try to us
27110 65 0a 2a 2a 20 61 20 70 72 65 70 61 72 65 64 20  e.** a prepared 
27120 73 74 61 74 65 6d 65 6e 74 20 61 66 74 65 72 20  statement after 
27130 69 74 20 68 61 73 20 62 65 65 6e 20 66 69 6e 61  it has been fina
27140 6c 69 7a 65 64 2e 20 20 41 6e 79 20 75 73 65 20  lized.  Any use 
27150 6f 66 20 61 20 70 72 65 70 61 72 65 64 0a 2a 2a  of a prepared.**
27160 20 73 74 61 74 65 6d 65 6e 74 20 61 66 74 65 72   statement after
27170 20 69 74 20 68 61 73 20 62 65 65 6e 20 66 69 6e   it has been fin
27180 61 6c 69 7a 65 64 20 63 61 6e 20 72 65 73 75 6c  alized can resul
27190 74 20 69 6e 20 75 6e 64 65 66 69 6e 65 64 20 61  t in undefined a
271a0 6e 64 0a 2a 2a 20 75 6e 64 65 73 69 72 61 62 6c  nd.** undesirabl
271b0 65 20 62 65 68 61 76 69 6f 72 20 73 75 63 68 20  e behavior such 
271c0 61 73 20 73 65 67 66 61 75 6c 74 73 20 61 6e 64  as segfaults and
271d0 20 68 65 61 70 20 63 6f 72 72 75 70 74 69 6f 6e   heap corruption
271e0 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  ..*/.int sqlite3
271f0 5f 66 69 6e 61 6c 69 7a 65 28 73 71 6c 69 74 65  _finalize(sqlite
27200 33 5f 73 74 6d 74 20 2a 70 53 74 6d 74 29 3b 0a  3_stmt *pStmt);.
27210 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
27220 20 52 65 73 65 74 20 41 20 50 72 65 70 61 72 65   Reset A Prepare
27230 64 20 53 74 61 74 65 6d 65 6e 74 20 4f 62 6a 65  d Statement Obje
27240 63 74 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c  ct.**.** The sql
27250 69 74 65 33 5f 72 65 73 65 74 28 29 20 66 75 6e  ite3_reset() fun
27260 63 74 69 6f 6e 20 69 73 20 63 61 6c 6c 65 64 20  ction is called 
27270 74 6f 20 72 65 73 65 74 20 61 20 5b 70 72 65 70  to reset a [prep
27280 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 0a  ared statement].
27290 2a 2a 20 6f 62 6a 65 63 74 20 62 61 63 6b 20 74  ** object back t
272a0 6f 20 69 74 73 20 69 6e 69 74 69 61 6c 20 73 74  o its initial st
272b0 61 74 65 2c 20 72 65 61 64 79 20 74 6f 20 62 65  ate, ready to be
272c0 20 72 65 2d 65 78 65 63 75 74 65 64 2e 0a 2a 2a   re-executed..**
272d0 20 5e 41 6e 79 20 53 51 4c 20 73 74 61 74 65 6d   ^Any SQL statem
272e0 65 6e 74 20 76 61 72 69 61 62 6c 65 73 20 74 68  ent variables th
272f0 61 74 20 68 61 64 20 76 61 6c 75 65 73 20 62 6f  at had values bo
27300 75 6e 64 20 74 6f 20 74 68 65 6d 20 75 73 69 6e  und to them usin
27310 67 0a 2a 2a 20 74 68 65 20 5b 73 71 6c 69 74 65  g.** the [sqlite
27320 33 5f 62 69 6e 64 5f 62 6c 6f 62 20 7c 20 73 71  3_bind_blob | sq
27330 6c 69 74 65 33 5f 62 69 6e 64 5f 2a 28 29 20 41  lite3_bind_*() A
27340 50 49 5d 20 72 65 74 61 69 6e 20 74 68 65 69 72  PI] retain their
27350 20 76 61 6c 75 65 73 2e 0a 2a 2a 20 55 73 65 20   values..** Use 
27360 5b 73 71 6c 69 74 65 33 5f 63 6c 65 61 72 5f 62  [sqlite3_clear_b
27370 69 6e 64 69 6e 67 73 28 29 5d 20 74 6f 20 72 65  indings()] to re
27380 73 65 74 20 74 68 65 20 62 69 6e 64 69 6e 67 73  set the bindings
27390 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 5b 73 71  ..**.** ^The [sq
273a0 6c 69 74 65 33 5f 72 65 73 65 74 28 53 29 5d 20  lite3_reset(S)] 
273b0 69 6e 74 65 72 66 61 63 65 20 72 65 73 65 74 73  interface resets
273c0 20 74 68 65 20 5b 70 72 65 70 61 72 65 64 20 73   the [prepared s
273d0 74 61 74 65 6d 65 6e 74 5d 20 53 0a 2a 2a 20 62  tatement] S.** b
273e0 61 63 6b 20 74 6f 20 74 68 65 20 62 65 67 69 6e  ack to the begin
273f0 6e 69 6e 67 20 6f 66 20 69 74 73 20 70 72 6f 67  ning of its prog
27400 72 61 6d 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74  ram..**.** ^If t
27410 68 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 20 63  he most recent c
27420 61 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f  all to [sqlite3_
27430 73 74 65 70 28 53 29 5d 20 66 6f 72 20 74 68 65  step(S)] for the
27440 0a 2a 2a 20 5b 70 72 65 70 61 72 65 64 20 73 74  .** [prepared st
27450 61 74 65 6d 65 6e 74 5d 20 53 20 72 65 74 75 72  atement] S retur
27460 6e 65 64 20 5b 53 51 4c 49 54 45 5f 52 4f 57 5d  ned [SQLITE_ROW]
27470 20 6f 72 20 5b 53 51 4c 49 54 45 5f 44 4f 4e 45   or [SQLITE_DONE
27480 5d 2c 0a 2a 2a 20 6f 72 20 69 66 20 5b 73 71 6c  ],.** or if [sql
27490 69 74 65 33 5f 73 74 65 70 28 53 29 5d 20 68 61  ite3_step(S)] ha
274a0 73 20 6e 65 76 65 72 20 62 65 66 6f 72 65 20 62  s never before b
274b0 65 65 6e 20 63 61 6c 6c 65 64 20 6f 6e 20 53 2c  een called on S,
274c0 0a 2a 2a 20 74 68 65 6e 20 5b 73 71 6c 69 74 65  .** then [sqlite
274d0 33 5f 72 65 73 65 74 28 53 29 5d 20 72 65 74 75  3_reset(S)] retu
274e0 72 6e 73 20 5b 53 51 4c 49 54 45 5f 4f 4b 5d 2e  rns [SQLITE_OK].
274f0 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 6d  .**.** ^If the m
27500 6f 73 74 20 72 65 63 65 6e 74 20 63 61 6c 6c 20  ost recent call 
27510 74 6f 20 5b 73 71 6c 69 74 65 33 5f 73 74 65 70  to [sqlite3_step
27520 28 53 29 5d 20 66 6f 72 20 74 68 65 0a 2a 2a 20  (S)] for the.** 
27530 5b 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d  [prepared statem
27540 65 6e 74 5d 20 53 20 69 6e 64 69 63 61 74 65 64  ent] S indicated
27550 20 61 6e 20 65 72 72 6f 72 2c 20 74 68 65 6e 0a   an error, then.
27560 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 72 65 73 65  ** [sqlite3_rese
27570 74 28 53 29 5d 20 72 65 74 75 72 6e 73 20 61 6e  t(S)] returns an
27580 20 61 70 70 72 6f 70 72 69 61 74 65 20 5b 65 72   appropriate [er
27590 72 6f 72 20 63 6f 64 65 5d 2e 0a 2a 2a 0a 2a 2a  ror code]..**.**
275a0 20 5e 54 68 65 20 5b 73 71 6c 69 74 65 33 5f 72   ^The [sqlite3_r
275b0 65 73 65 74 28 53 29 5d 20 69 6e 74 65 72 66 61  eset(S)] interfa
275c0 63 65 20 64 6f 65 73 20 6e 6f 74 20 63 68 61 6e  ce does not chan
275d0 67 65 20 74 68 65 20 76 61 6c 75 65 73 0a 2a 2a  ge the values.**
275e0 20 6f 66 20 61 6e 79 20 5b 73 71 6c 69 74 65 33   of any [sqlite3
275f0 5f 62 69 6e 64 5f 62 6c 6f 62 7c 62 69 6e 64 69  _bind_blob|bindi
27600 6e 67 73 5d 20 6f 6e 20 74 68 65 20 5b 70 72 65  ngs] on the [pre
27610 70 61 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d  pared statement]
27620 20 53 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74   S..*/.int sqlit
27630 65 33 5f 72 65 73 65 74 28 73 71 6c 69 74 65 33  e3_reset(sqlite3
27640 5f 73 74 6d 74 20 2a 70 53 74 6d 74 29 3b 0a 0a  _stmt *pStmt);..
27650 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
27660 43 72 65 61 74 65 20 4f 72 20 52 65 64 65 66 69  Create Or Redefi
27670 6e 65 20 53 51 4c 20 46 75 6e 63 74 69 6f 6e 73  ne SQL Functions
27680 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b 66  .** KEYWORDS: {f
27690 75 6e 63 74 69 6f 6e 20 63 72 65 61 74 69 6f 6e  unction creation
276a0 20 72 6f 75 74 69 6e 65 73 7d 0a 2a 2a 20 4b 45   routines}.** KE
276b0 59 57 4f 52 44 53 3a 20 7b 61 70 70 6c 69 63 61  YWORDS: {applica
276c0 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51 4c  tion-defined SQL
276d0 20 66 75 6e 63 74 69 6f 6e 7d 0a 2a 2a 20 4b 45   function}.** KE
276e0 59 57 4f 52 44 53 3a 20 7b 61 70 70 6c 69 63 61  YWORDS: {applica
276f0 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 53 51 4c  tion-defined SQL
27700 20 66 75 6e 63 74 69 6f 6e 73 7d 0a 2a 2a 0a 2a   functions}.**.*
27710 2a 20 5e 54 68 65 73 65 20 66 75 6e 63 74 69 6f  * ^These functio
27720 6e 73 20 28 63 6f 6c 6c 65 63 74 69 76 65 6c 79  ns (collectively
27730 20 6b 6e 6f 77 6e 20 61 73 20 22 66 75 6e 63 74   known as "funct
27740 69 6f 6e 20 63 72 65 61 74 69 6f 6e 20 72 6f 75  ion creation rou
27750 74 69 6e 65 73 22 29 0a 2a 2a 20 61 72 65 20 75  tines").** are u
27760 73 65 64 20 74 6f 20 61 64 64 20 53 51 4c 20 66  sed to add SQL f
27770 75 6e 63 74 69 6f 6e 73 20 6f 72 20 61 67 67 72  unctions or aggr
27780 65 67 61 74 65 73 20 6f 72 20 74 6f 20 72 65 64  egates or to red
27790 65 66 69 6e 65 20 74 68 65 20 62 65 68 61 76 69  efine the behavi
277a0 6f 72 0a 2a 2a 20 6f 66 20 65 78 69 73 74 69 6e  or.** of existin
277b0 67 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20  g SQL functions 
277c0 6f 72 20 61 67 67 72 65 67 61 74 65 73 2e 20 20  or aggregates.  
277d0 54 68 65 20 6f 6e 6c 79 20 64 69 66 66 65 72 65  The only differe
277e0 6e 63 65 73 20 62 65 74 77 65 65 6e 0a 2a 2a 20  nces between.** 
277f0 74 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 61  these routines a
27800 72 65 20 74 68 65 20 74 65 78 74 20 65 6e 63 6f  re the text enco
27810 64 69 6e 67 20 65 78 70 65 63 74 65 64 20 66 6f  ding expected fo
27820 72 0a 2a 2a 20 74 68 65 20 74 68 65 20 73 65 63  r.** the the sec
27830 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20 28 74  ond parameter (t
27840 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 66  he name of the f
27850 75 6e 63 74 69 6f 6e 20 62 65 69 6e 67 20 63 72  unction being cr
27860 65 61 74 65 64 29 0a 2a 2a 20 61 6e 64 20 74 68  eated).** and th
27870 65 20 70 72 65 73 65 6e 63 65 20 6f 72 20 61 62  e presence or ab
27880 73 65 6e 63 65 20 6f 66 20 61 20 64 65 73 74 72  sence of a destr
27890 75 63 74 6f 72 20 63 61 6c 6c 62 61 63 6b 20 66  uctor callback f
278a0 6f 72 0a 2a 2a 20 74 68 65 20 61 70 70 6c 69 63  or.** the applic
278b0 61 74 69 6f 6e 20 64 61 74 61 20 70 6f 69 6e 74  ation data point
278c0 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66  er..**.** ^The f
278d0 69 72 73 74 20 70 61 72 61 6d 65 74 65 72 20 69  irst parameter i
278e0 73 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20  s the [database 
278f0 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 74 6f 20 77  connection] to w
27900 68 69 63 68 20 74 68 65 20 53 51 4c 0a 2a 2a 20  hich the SQL.** 
27910 66 75 6e 63 74 69 6f 6e 20 69 73 20 74 6f 20 62  function is to b
27920 65 20 61 64 64 65 64 2e 20 20 5e 49 66 20 61 6e  e added.  ^If an
27930 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 75 73 65   application use
27940 73 20 6d 6f 72 65 20 74 68 61 6e 20 6f 6e 65 20  s more than one 
27950 64 61 74 61 62 61 73 65 0a 2a 2a 20 63 6f 6e 6e  database.** conn
27960 65 63 74 69 6f 6e 20 74 68 65 6e 20 61 70 70 6c  ection then appl
27970 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20  ication-defined 
27980 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20 6d 75  SQL functions mu
27990 73 74 20 62 65 20 61 64 64 65 64 0a 2a 2a 20 74  st be added.** t
279a0 6f 20 65 61 63 68 20 64 61 74 61 62 61 73 65 20  o each database 
279b0 63 6f 6e 6e 65 63 74 69 6f 6e 20 73 65 70 61 72  connection separ
279c0 61 74 65 6c 79 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68  ately..**.** ^Th
279d0 65 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74  e second paramet
279e0 65 72 20 69 73 20 74 68 65 20 6e 61 6d 65 20 6f  er is the name o
279f0 66 20 74 68 65 20 53 51 4c 20 66 75 6e 63 74 69  f the SQL functi
27a00 6f 6e 20 74 6f 20 62 65 20 63 72 65 61 74 65 64  on to be created
27a10 20 6f 72 0a 2a 2a 20 72 65 64 65 66 69 6e 65 64   or.** redefined
27a20 2e 20 20 5e 54 68 65 20 6c 65 6e 67 74 68 20 6f  .  ^The length o
27a30 66 20 74 68 65 20 6e 61 6d 65 20 69 73 20 6c 69  f the name is li
27a40 6d 69 74 65 64 20 74 6f 20 32 35 35 20 62 79 74  mited to 255 byt
27a50 65 73 20 69 6e 20 61 20 55 54 46 2d 38 0a 2a 2a  es in a UTF-8.**
27a60 20 72 65 70 72 65 73 65 6e 74 61 74 69 6f 6e 2c   representation,
27a70 20 65 78 63 6c 75 73 69 76 65 20 6f 66 20 74 68   exclusive of th
27a80 65 20 7a 65 72 6f 2d 74 65 72 6d 69 6e 61 74 6f  e zero-terminato
27a90 72 2e 20 20 5e 4e 6f 74 65 20 74 68 61 74 20 74  r.  ^Note that t
27aa0 68 65 20 6e 61 6d 65 0a 2a 2a 20 6c 65 6e 67 74  he name.** lengt
27ab0 68 20 6c 69 6d 69 74 20 69 73 20 69 6e 20 55 54  h limit is in UT
27ac0 46 2d 38 20 62 79 74 65 73 2c 20 6e 6f 74 20 63  F-8 bytes, not c
27ad0 68 61 72 61 63 74 65 72 73 20 6e 6f 72 20 55 54  haracters nor UT
27ae0 46 2d 31 36 20 62 79 74 65 73 2e 20 20 0a 2a 2a  F-16 bytes.  .**
27af0 20 5e 41 6e 79 20 61 74 74 65 6d 70 74 20 74 6f   ^Any attempt to
27b00 20 63 72 65 61 74 65 20 61 20 66 75 6e 63 74 69   create a functi
27b10 6f 6e 20 77 69 74 68 20 61 20 6c 6f 6e 67 65 72  on with a longer
27b20 20 6e 61 6d 65 0a 2a 2a 20 77 69 6c 6c 20 72 65   name.** will re
27b30 73 75 6c 74 20 69 6e 20 5b 53 51 4c 49 54 45 5f  sult in [SQLITE_
27b40 4d 49 53 55 53 45 5d 20 62 65 69 6e 67 20 72 65  MISUSE] being re
27b50 74 75 72 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54  turned..**.** ^T
27b60 68 65 20 74 68 69 72 64 20 70 61 72 61 6d 65 74  he third paramet
27b70 65 72 20 28 6e 41 72 67 29 0a 2a 2a 20 69 73 20  er (nArg).** is 
27b80 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 61 72  the number of ar
27b90 67 75 6d 65 6e 74 73 20 74 68 61 74 20 74 68 65  guments that the
27ba0 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 6f 72   SQL function or
27bb0 0a 2a 2a 20 61 67 67 72 65 67 61 74 65 20 74 61  .** aggregate ta
27bc0 6b 65 73 2e 20 5e 49 66 20 74 68 69 73 20 70 61  kes. ^If this pa
27bd0 72 61 6d 65 74 65 72 20 69 73 20 2d 31 2c 20 74  rameter is -1, t
27be0 68 65 6e 20 74 68 65 20 53 51 4c 20 66 75 6e 63  hen the SQL func
27bf0 74 69 6f 6e 20 6f 72 0a 2a 2a 20 61 67 67 72 65  tion or.** aggre
27c00 67 61 74 65 20 6d 61 79 20 74 61 6b 65 20 61 6e  gate may take an
27c10 79 20 6e 75 6d 62 65 72 20 6f 66 20 61 72 67 75  y number of argu
27c20 6d 65 6e 74 73 20 62 65 74 77 65 65 6e 20 30 20  ments between 0 
27c30 61 6e 64 20 74 68 65 20 6c 69 6d 69 74 0a 2a 2a  and the limit.**
27c40 20 73 65 74 20 62 79 20 5b 73 71 6c 69 74 65 33   set by [sqlite3
27c50 5f 6c 69 6d 69 74 5d 28 5b 53 51 4c 49 54 45 5f  _limit]([SQLITE_
27c60 4c 49 4d 49 54 5f 46 55 4e 43 54 49 4f 4e 5f 41  LIMIT_FUNCTION_A
27c70 52 47 5d 29 2e 20 20 49 66 20 74 68 65 20 74 68  RG]).  If the th
27c80 69 72 64 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72  ird.** parameter
27c90 20 69 73 20 6c 65 73 73 20 74 68 61 6e 20 2d 31   is less than -1
27ca0 20 6f 72 20 67 72 65 61 74 65 72 20 74 68 61 6e   or greater than
27cb0 20 31 32 37 20 74 68 65 6e 20 74 68 65 20 62 65   127 then the be
27cc0 68 61 76 69 6f 72 20 69 73 0a 2a 2a 20 75 6e 64  havior is.** und
27cd0 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54  efined..**.** ^T
27ce0 68 65 20 66 6f 75 72 74 68 20 70 61 72 61 6d 65  he fourth parame
27cf0 74 65 72 2c 20 65 54 65 78 74 52 65 70 2c 20 73  ter, eTextRep, s
27d00 70 65 63 69 66 69 65 73 20 77 68 61 74 0a 2a 2a  pecifies what.**
27d10 20 5b 53 51 4c 49 54 45 5f 55 54 46 38 20 7c 20   [SQLITE_UTF8 | 
27d20 74 65 78 74 20 65 6e 63 6f 64 69 6e 67 5d 20 74  text encoding] t
27d30 68 69 73 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  his SQL function
27d40 20 70 72 65 66 65 72 73 20 66 6f 72 0a 2a 2a 20   prefers for.** 
27d50 69 74 73 20 70 61 72 61 6d 65 74 65 72 73 2e 20  its parameters. 
27d60 20 45 76 65 72 79 20 53 51 4c 20 66 75 6e 63 74   Every SQL funct
27d70 69 6f 6e 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  ion implementati
27d80 6f 6e 20 6d 75 73 74 20 62 65 20 61 62 6c 65 20  on must be able 
27d90 74 6f 20 77 6f 72 6b 0a 2a 2a 20 77 69 74 68 20  to work.** with 
27da0 55 54 46 2d 38 2c 20 55 54 46 2d 31 36 6c 65 2c  UTF-8, UTF-16le,
27db0 20 6f 72 20 55 54 46 2d 31 36 62 65 2e 20 20 42   or UTF-16be.  B
27dc0 75 74 20 73 6f 6d 65 20 69 6d 70 6c 65 6d 65 6e  ut some implemen
27dd0 74 61 74 69 6f 6e 73 20 6d 61 79 20 62 65 0a 2a  tations may be.*
27de0 2a 20 6d 6f 72 65 20 65 66 66 69 63 69 65 6e 74  * more efficient
27df0 20 77 69 74 68 20 6f 6e 65 20 65 6e 63 6f 64 69   with one encodi
27e00 6e 67 20 74 68 61 6e 20 61 6e 6f 74 68 65 72 2e  ng than another.
27e10 20 20 5e 41 6e 20 61 70 70 6c 69 63 61 74 69 6f    ^An applicatio
27e20 6e 20 6d 61 79 0a 2a 2a 20 69 6e 76 6f 6b 65 20  n may.** invoke 
27e30 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 66  sqlite3_create_f
27e40 75 6e 63 74 69 6f 6e 28 29 20 6f 72 20 73 71 6c  unction() or sql
27e50 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63  ite3_create_func
27e60 74 69 6f 6e 31 36 28 29 20 6d 75 6c 74 69 70 6c  tion16() multipl
27e70 65 0a 2a 2a 20 74 69 6d 65 73 20 77 69 74 68 20  e.** times with 
27e80 74 68 65 20 73 61 6d 65 20 66 75 6e 63 74 69 6f  the same functio
27e90 6e 20 62 75 74 20 77 69 74 68 20 64 69 66 66 65  n but with diffe
27ea0 72 65 6e 74 20 76 61 6c 75 65 73 20 6f 66 20 65  rent values of e
27eb0 54 65 78 74 52 65 70 2e 0a 2a 2a 20 5e 57 68 65  TextRep..** ^Whe
27ec0 6e 20 6d 75 6c 74 69 70 6c 65 20 69 6d 70 6c 65  n multiple imple
27ed0 6d 65 6e 74 61 74 69 6f 6e 73 20 6f 66 20 74 68  mentations of th
27ee0 65 20 73 61 6d 65 20 66 75 6e 63 74 69 6f 6e 20  e same function 
27ef0 61 72 65 20 61 76 61 69 6c 61 62 6c 65 2c 20 53  are available, S
27f00 51 4c 69 74 65 0a 2a 2a 20 77 69 6c 6c 20 70 69  QLite.** will pi
27f10 63 6b 20 74 68 65 20 6f 6e 65 20 74 68 61 74 20  ck the one that 
27f20 69 6e 76 6f 6c 76 65 73 20 74 68 65 20 6c 65 61  involves the lea
27f30 73 74 20 61 6d 6f 75 6e 74 20 6f 66 20 64 61 74  st amount of dat
27f40 61 20 63 6f 6e 76 65 72 73 69 6f 6e 2e 0a 2a 2a  a conversion..**
27f50 20 49 66 20 74 68 65 72 65 20 69 73 20 6f 6e 6c   If there is onl
27f60 79 20 61 20 73 69 6e 67 6c 65 20 69 6d 70 6c 65  y a single imple
27f70 6d 65 6e 74 61 74 69 6f 6e 20 77 68 69 63 68 20  mentation which 
27f80 64 6f 65 73 20 6e 6f 74 20 63 61 72 65 20 77 68  does not care wh
27f90 61 74 20 74 65 78 74 0a 2a 2a 20 65 6e 63 6f 64  at text.** encod
27fa0 69 6e 67 20 69 73 20 75 73 65 64 2c 20 74 68 65  ing is used, the
27fb0 6e 20 74 68 65 20 66 6f 75 72 74 68 20 61 72 67  n the fourth arg
27fc0 75 6d 65 6e 74 20 73 68 6f 75 6c 64 20 62 65 20  ument should be 
27fd0 5b 53 51 4c 49 54 45 5f 41 4e 59 5d 2e 0a 2a 2a  [SQLITE_ANY]..**
27fe0 0a 2a 2a 20 5e 28 54 68 65 20 66 69 66 74 68 20  .** ^(The fifth 
27ff0 70 61 72 61 6d 65 74 65 72 20 69 73 20 61 6e 20  parameter is an 
28000 61 72 62 69 74 72 61 72 79 20 70 6f 69 6e 74 65  arbitrary pointe
28010 72 2e 20 20 54 68 65 20 69 6d 70 6c 65 6d 65 6e  r.  The implemen
28020 74 61 74 69 6f 6e 20 6f 66 20 74 68 65 0a 2a 2a  tation of the.**
28030 20 66 75 6e 63 74 69 6f 6e 20 63 61 6e 20 67 61   function can ga
28040 69 6e 20 61 63 63 65 73 73 20 74 6f 20 74 68 69  in access to thi
28050 73 20 70 6f 69 6e 74 65 72 20 75 73 69 6e 67 20  s pointer using 
28060 5b 73 71 6c 69 74 65 33 5f 75 73 65 72 5f 64 61  [sqlite3_user_da
28070 74 61 28 29 5d 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e  ta()].)^.**.** ^
28080 54 68 65 20 73 69 78 74 68 2c 20 73 65 76 65 6e  The sixth, seven
28090 74 68 20 61 6e 64 20 65 69 67 68 74 68 20 70 61  th and eighth pa
280a0 72 61 6d 65 74 65 72 73 2c 20 78 46 75 6e 63 2c  rameters, xFunc,
280b0 20 78 53 74 65 70 20 61 6e 64 20 78 46 69 6e 61   xStep and xFina
280c0 6c 2c 20 61 72 65 0a 2a 2a 20 70 6f 69 6e 74 65  l, are.** pointe
280d0 72 73 20 74 6f 20 43 2d 6c 61 6e 67 75 61 67 65  rs to C-language
280e0 20 66 75 6e 63 74 69 6f 6e 73 20 74 68 61 74 20   functions that 
280f0 69 6d 70 6c 65 6d 65 6e 74 20 74 68 65 20 53 51  implement the SQ
28100 4c 20 66 75 6e 63 74 69 6f 6e 20 6f 72 0a 2a 2a  L function or.**
28110 20 61 67 67 72 65 67 61 74 65 2e 20 5e 41 20 73   aggregate. ^A s
28120 63 61 6c 61 72 20 53 51 4c 20 66 75 6e 63 74 69  calar SQL functi
28130 6f 6e 20 72 65 71 75 69 72 65 73 20 61 6e 20 69  on requires an i
28140 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 6f 66  mplementation of
28150 20 74 68 65 20 78 46 75 6e 63 0a 2a 2a 20 63 61   the xFunc.** ca
28160 6c 6c 62 61 63 6b 20 6f 6e 6c 79 3b 20 4e 55 4c  llback only; NUL
28170 4c 20 70 6f 69 6e 74 65 72 73 20 6d 75 73 74 20  L pointers must 
28180 62 65 20 70 61 73 73 65 64 20 61 73 20 74 68 65  be passed as the
28190 20 78 53 74 65 70 20 61 6e 64 20 78 46 69 6e 61   xStep and xFina
281a0 6c 0a 2a 2a 20 70 61 72 61 6d 65 74 65 72 73 2e  l.** parameters.
281b0 20 5e 41 6e 20 61 67 67 72 65 67 61 74 65 20 53   ^An aggregate S
281c0 51 4c 20 66 75 6e 63 74 69 6f 6e 20 72 65 71 75  QL function requ
281d0 69 72 65 73 20 61 6e 20 69 6d 70 6c 65 6d 65 6e  ires an implemen
281e0 74 61 74 69 6f 6e 20 6f 66 20 78 53 74 65 70 0a  tation of xStep.
281f0 2a 2a 20 61 6e 64 20 78 46 69 6e 61 6c 20 61 6e  ** and xFinal an
28200 64 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72 20 6d  d NULL pointer m
28210 75 73 74 20 62 65 20 70 61 73 73 65 64 20 66 6f  ust be passed fo
28220 72 20 78 46 75 6e 63 2e 20 5e 54 6f 20 64 65 6c  r xFunc. ^To del
28230 65 74 65 20 61 6e 20 65 78 69 73 74 69 6e 67 0a  ete an existing.
28240 2a 2a 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20  ** SQL function 
28250 6f 72 20 61 67 67 72 65 67 61 74 65 2c 20 70 61  or aggregate, pa
28260 73 73 20 4e 55 4c 4c 20 70 6f 69 6e 65 72 73 20  ss NULL poiners 
28270 66 6f 72 20 61 6c 6c 20 74 68 72 65 65 20 66 75  for all three fu
28280 6e 63 74 69 6f 6e 0a 2a 2a 20 63 61 6c 6c 62 61  nction.** callba
28290 63 6b 73 2e 0a 2a 2a 0a 2a 2a 20 5e 28 49 66 20  cks..**.** ^(If 
282a0 74 68 65 20 6e 69 6e 74 68 20 70 61 72 61 6d 65  the ninth parame
282b0 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33 5f 63  ter to sqlite3_c
282c0 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 5f 76  reate_function_v
282d0 32 28 29 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 2c  2() is not NULL,
282e0 0a 2a 2a 20 74 68 65 6e 20 69 74 20 69 73 20 64  .** then it is d
282f0 65 73 74 72 75 63 74 6f 72 20 66 6f 72 20 74 68  estructor for th
28300 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 64 61  e application da
28310 74 61 20 70 6f 69 6e 74 65 72 2e 20 0a 2a 2a 20  ta pointer. .** 
28320 54 68 65 20 64 65 73 74 72 75 63 74 6f 72 20 69  The destructor i
28330 73 20 69 6e 76 6f 6b 65 64 20 77 68 65 6e 20 74  s invoked when t
28340 68 65 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 64  he function is d
28350 65 6c 65 74 65 64 2c 20 65 69 74 68 65 72 20 62  eleted, either b
28360 79 20 62 65 69 6e 67 0a 2a 2a 20 6f 76 65 72 6c  y being.** overl
28370 6f 61 64 65 64 20 6f 72 20 77 68 65 6e 20 74 68  oaded or when th
28380 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65  e database conne
28390 63 74 69 6f 6e 20 63 6c 6f 73 65 73 2e 29 5e 0a  ction closes.)^.
283a0 2a 2a 20 5e 54 68 65 20 64 65 73 74 72 75 63 74  ** ^The destruct
283b0 6f 72 20 69 73 20 61 6c 73 6f 20 69 6e 76 6f 6b  or is also invok
283c0 65 64 20 69 66 20 74 68 65 20 63 61 6c 6c 20 74  ed if the call t
283d0 6f 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63 72 65  o.** sqlite3_cre
283e0 61 74 65 5f 66 75 6e 63 74 69 6f 6e 5f 76 32 28  ate_function_v2(
283f0 29 20 66 61 69 6c 73 2e 0a 2a 2a 20 5e 57 68 65  ) fails..** ^Whe
28400 6e 20 74 68 65 20 64 65 73 74 72 75 63 74 6f 72  n the destructor
28410 20 63 61 6c 6c 62 61 63 6b 20 6f 66 20 74 68 65   callback of the
28420 20 74 65 6e 74 68 20 70 61 72 61 6d 65 74 65 72   tenth parameter
28430 20 69 73 20 69 6e 76 6f 6b 65 64 2c 20 69 74 0a   is invoked, it.
28440 2a 2a 20 69 73 20 70 61 73 73 65 64 20 61 20 73  ** is passed a s
28450 69 6e 67 6c 65 20 61 72 67 75 6d 65 6e 74 20 77  ingle argument w
28460 68 69 63 68 20 69 73 20 61 20 63 6f 70 79 20 6f  hich is a copy o
28470 66 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f  f the applicatio
28480 6e 20 64 61 74 61 20 0a 2a 2a 20 70 6f 69 6e 74  n data .** point
28490 65 72 20 77 68 69 63 68 20 77 61 73 20 74 68 65  er which was the
284a0 20 66 69 66 74 68 20 70 61 72 61 6d 65 74 65 72   fifth parameter
284b0 20 74 6f 20 73 71 6c 69 74 65 33 5f 63 72 65 61   to sqlite3_crea
284c0 74 65 5f 66 75 6e 63 74 69 6f 6e 5f 76 32 28 29  te_function_v2()
284d0 2e 0a 2a 2a 0a 2a 2a 20 5e 49 74 20 69 73 20 70  ..**.** ^It is p
284e0 65 72 6d 69 74 74 65 64 20 74 6f 20 72 65 67 69  ermitted to regi
284f0 73 74 65 72 20 6d 75 6c 74 69 70 6c 65 20 69 6d  ster multiple im
28500 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20 6f 66  plementations of
28510 20 74 68 65 20 73 61 6d 65 0a 2a 2a 20 66 75 6e   the same.** fun
28520 63 74 69 6f 6e 73 20 77 69 74 68 20 74 68 65 20  ctions with the 
28530 73 61 6d 65 20 6e 61 6d 65 20 62 75 74 20 77 69  same name but wi
28540 74 68 20 65 69 74 68 65 72 20 64 69 66 66 65 72  th either differ
28550 69 6e 67 20 6e 75 6d 62 65 72 73 20 6f 66 0a 2a  ing numbers of.*
28560 2a 20 61 72 67 75 6d 65 6e 74 73 20 6f 72 20 64  * arguments or d
28570 69 66 66 65 72 69 6e 67 20 70 72 65 66 65 72 72  iffering preferr
28580 65 64 20 74 65 78 74 20 65 6e 63 6f 64 69 6e 67  ed text encoding
28590 73 2e 20 20 5e 53 51 4c 69 74 65 20 77 69 6c 6c  s.  ^SQLite will
285a0 20 75 73 65 0a 2a 2a 20 74 68 65 20 69 6d 70 6c   use.** the impl
285b0 65 6d 65 6e 74 61 74 69 6f 6e 20 74 68 61 74 20  ementation that 
285c0 6d 6f 73 74 20 63 6c 6f 73 65 6c 79 20 6d 61 74  most closely mat
285d0 63 68 65 73 20 74 68 65 20 77 61 79 20 69 6e 20  ches the way in 
285e0 77 68 69 63 68 20 74 68 65 0a 2a 2a 20 53 51 4c  which the.** SQL
285f0 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 75 73 65   function is use
28600 64 2e 20 20 5e 41 20 66 75 6e 63 74 69 6f 6e 20  d.  ^A function 
28610 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 77  implementation w
28620 69 74 68 20 61 20 6e 6f 6e 2d 6e 65 67 61 74 69  ith a non-negati
28630 76 65 0a 2a 2a 20 6e 41 72 67 20 70 61 72 61 6d  ve.** nArg param
28640 65 74 65 72 20 69 73 20 61 20 62 65 74 74 65 72  eter is a better
28650 20 6d 61 74 63 68 20 74 68 61 6e 20 61 20 66 75   match than a fu
28660 6e 63 74 69 6f 6e 20 69 6d 70 6c 65 6d 65 6e 74  nction implement
28670 61 74 69 6f 6e 20 77 69 74 68 0a 2a 2a 20 61 20  ation with.** a 
28680 6e 65 67 61 74 69 76 65 20 6e 41 72 67 2e 20 20  negative nArg.  
28690 5e 41 20 66 75 6e 63 74 69 6f 6e 20 77 68 65 72  ^A function wher
286a0 65 20 74 68 65 20 70 72 65 66 65 72 72 65 64 20  e the preferred 
286b0 74 65 78 74 20 65 6e 63 6f 64 69 6e 67 0a 2a 2a  text encoding.**
286c0 20 6d 61 74 63 68 65 73 20 74 68 65 20 64 61 74   matches the dat
286d0 61 62 61 73 65 20 65 6e 63 6f 64 69 6e 67 20 69  abase encoding i
286e0 73 20 61 20 62 65 74 74 65 72 0a 2a 2a 20 6d 61  s a better.** ma
286f0 74 63 68 20 74 68 61 6e 20 61 20 66 75 6e 63 74  tch than a funct
28700 69 6f 6e 20 77 68 65 72 65 20 74 68 65 20 65 6e  ion where the en
28710 63 6f 64 69 6e 67 20 69 73 20 64 69 66 66 65 72  coding is differ
28720 65 6e 74 2e 20 20 0a 2a 2a 20 5e 41 20 66 75 6e  ent.  .** ^A fun
28730 63 74 69 6f 6e 20 77 68 65 72 65 20 74 68 65 20  ction where the 
28740 65 6e 63 6f 64 69 6e 67 20 64 69 66 66 65 72 65  encoding differe
28750 6e 63 65 20 69 73 20 62 65 74 77 65 65 6e 20 55  nce is between U
28760 54 46 31 36 6c 65 20 61 6e 64 20 55 54 46 31 36  TF16le and UTF16
28770 62 65 0a 2a 2a 20 69 73 20 61 20 63 6c 6f 73 65  be.** is a close
28780 72 20 6d 61 74 63 68 20 74 68 61 6e 20 61 20 66  r match than a f
28790 75 6e 63 74 69 6f 6e 20 77 68 65 72 65 20 74 68  unction where th
287a0 65 20 65 6e 63 6f 64 69 6e 67 20 64 69 66 66 65  e encoding diffe
287b0 72 65 6e 63 65 20 69 73 0a 2a 2a 20 62 65 74 77  rence is.** betw
287c0 65 65 6e 20 55 54 46 38 20 61 6e 64 20 55 54 46  een UTF8 and UTF
287d0 31 36 2e 0a 2a 2a 0a 2a 2a 20 5e 42 75 69 6c 74  16..**.** ^Built
287e0 2d 69 6e 20 66 75 6e 63 74 69 6f 6e 73 20 6d 61  -in functions ma
287f0 79 20 62 65 20 6f 76 65 72 6c 6f 61 64 65 64 20  y be overloaded 
28800 62 79 20 6e 65 77 20 61 70 70 6c 69 63 61 74 69  by new applicati
28810 6f 6e 2d 64 65 66 69 6e 65 64 20 66 75 6e 63 74  on-defined funct
28820 69 6f 6e 73 2e 0a 2a 2a 0a 2a 2a 20 5e 41 6e 20  ions..**.** ^An 
28830 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69  application-defi
28840 6e 65 64 20 66 75 6e 63 74 69 6f 6e 20 69 73 20  ned function is 
28850 70 65 72 6d 69 74 74 65 64 20 74 6f 20 63 61 6c  permitted to cal
28860 6c 20 6f 74 68 65 72 0a 2a 2a 20 53 51 4c 69 74  l other.** SQLit
28870 65 20 69 6e 74 65 72 66 61 63 65 73 2e 20 20 48  e interfaces.  H
28880 6f 77 65 76 65 72 2c 20 73 75 63 68 20 63 61 6c  owever, such cal
28890 6c 73 20 6d 75 73 74 20 6e 6f 74 0a 2a 2a 20 63  ls must not.** c
288a0 6c 6f 73 65 20 74 68 65 20 64 61 74 61 62 61 73  lose the databas
288b0 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 6e 6f 72  e connection nor
288c0 20 66 69 6e 61 6c 69 7a 65 20 6f 72 20 72 65 73   finalize or res
288d0 65 74 20 74 68 65 20 70 72 65 70 61 72 65 64 0a  et the prepared.
288e0 2a 2a 20 73 74 61 74 65 6d 65 6e 74 20 69 6e 20  ** statement in 
288f0 77 68 69 63 68 20 74 68 65 20 66 75 6e 63 74 69  which the functi
28900 6f 6e 20 69 73 20 72 75 6e 6e 69 6e 67 2e 0a 2a  on is running..*
28910 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 63 72  /.int sqlite3_cr
28920 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 28 0a 20  eate_function(. 
28930 20 73 71 6c 69 74 65 33 20 2a 64 62 2c 0a 20 20   sqlite3 *db,.  
28940 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 46 75 6e  const char *zFun
28950 63 74 69 6f 6e 4e 61 6d 65 2c 0a 20 20 69 6e 74  ctionName,.  int
28960 20 6e 41 72 67 2c 0a 20 20 69 6e 74 20 65 54 65   nArg,.  int eTe
28970 78 74 52 65 70 2c 0a 20 20 76 6f 69 64 20 2a 70  xtRep,.  void *p
28980 41 70 70 2c 0a 20 20 76 6f 69 64 20 28 2a 78 46  App,.  void (*xF
28990 75 6e 63 29 28 73 71 6c 69 74 65 33 5f 63 6f 6e  unc)(sqlite3_con
289a0 74 65 78 74 2a 2c 69 6e 74 2c 73 71 6c 69 74 65  text*,int,sqlite
289b0 33 5f 76 61 6c 75 65 2a 2a 29 2c 0a 20 20 76 6f  3_value**),.  vo
289c0 69 64 20 28 2a 78 53 74 65 70 29 28 73 71 6c 69  id (*xStep)(sqli
289d0 74 65 33 5f 63 6f 6e 74 65 78 74 2a 2c 69 6e 74  te3_context*,int
289e0 2c 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 2a  ,sqlite3_value**
289f0 29 2c 0a 20 20 76 6f 69 64 20 28 2a 78 46 69 6e  ),.  void (*xFin
28a00 61 6c 29 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74  al)(sqlite3_cont
28a10 65 78 74 2a 29 0a 29 3b 0a 69 6e 74 20 73 71 6c  ext*).);.int sql
28a20 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63  ite3_create_func
28a30 74 69 6f 6e 31 36 28 0a 20 20 73 71 6c 69 74 65  tion16(.  sqlite
28a40 33 20 2a 64 62 2c 0a 20 20 63 6f 6e 73 74 20 76  3 *db,.  const v
28a50 6f 69 64 20 2a 7a 46 75 6e 63 74 69 6f 6e 4e 61  oid *zFunctionNa
28a60 6d 65 2c 0a 20 20 69 6e 74 20 6e 41 72 67 2c 0a  me,.  int nArg,.
28a70 20 20 69 6e 74 20 65 54 65 78 74 52 65 70 2c 0a    int eTextRep,.
28a80 20 20 76 6f 69 64 20 2a 70 41 70 70 2c 0a 20 20    void *pApp,.  
28a90 76 6f 69 64 20 28 2a 78 46 75 6e 63 29 28 73 71  void (*xFunc)(sq
28aa0 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 2c 69  lite3_context*,i
28ab0 6e 74 2c 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  nt,sqlite3_value
28ac0 2a 2a 29 2c 0a 20 20 76 6f 69 64 20 28 2a 78 53  **),.  void (*xS
28ad0 74 65 70 29 28 73 71 6c 69 74 65 33 5f 63 6f 6e  tep)(sqlite3_con
28ae0 74 65 78 74 2a 2c 69 6e 74 2c 73 71 6c 69 74 65  text*,int,sqlite
28af0 33 5f 76 61 6c 75 65 2a 2a 29 2c 0a 20 20 76 6f  3_value**),.  vo
28b00 69 64 20 28 2a 78 46 69 6e 61 6c 29 28 73 71 6c  id (*xFinal)(sql
28b10 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 29 0a 29  ite3_context*).)
28b20 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 63 72  ;.int sqlite3_cr
28b30 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 5f 76 32  eate_function_v2
28b40 28 0a 20 20 73 71 6c 69 74 65 33 20 2a 64 62 2c  (.  sqlite3 *db,
28b50 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a  .  const char *z
28b60 46 75 6e 63 74 69 6f 6e 4e 61 6d 65 2c 0a 20 20  FunctionName,.  
28b70 69 6e 74 20 6e 41 72 67 2c 0a 20 20 69 6e 74 20  int nArg,.  int 
28b80 65 54 65 78 74 52 65 70 2c 0a 20 20 76 6f 69 64  eTextRep,.  void
28b90 20 2a 70 41 70 70 2c 0a 20 20 76 6f 69 64 20 28   *pApp,.  void (
28ba0 2a 78 46 75 6e 63 29 28 73 71 6c 69 74 65 33 5f  *xFunc)(sqlite3_
28bb0 63 6f 6e 74 65 78 74 2a 2c 69 6e 74 2c 73 71 6c  context*,int,sql
28bc0 69 74 65 33 5f 76 61 6c 75 65 2a 2a 29 2c 0a 20  ite3_value**),. 
28bd0 20 76 6f 69 64 20 28 2a 78 53 74 65 70 29 28 73   void (*xStep)(s
28be0 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 2c  qlite3_context*,
28bf0 69 6e 74 2c 73 71 6c 69 74 65 33 5f 76 61 6c 75  int,sqlite3_valu
28c00 65 2a 2a 29 2c 0a 20 20 76 6f 69 64 20 28 2a 78  e**),.  void (*x
28c10 46 69 6e 61 6c 29 28 73 71 6c 69 74 65 33 5f 63  Final)(sqlite3_c
28c20 6f 6e 74 65 78 74 2a 29 2c 0a 20 20 76 6f 69 64  ontext*),.  void
28c30 28 2a 78 44 65 73 74 72 6f 79 29 28 76 6f 69 64  (*xDestroy)(void
28c40 2a 29 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  *).);../*.** CAP
28c50 49 33 52 45 46 3a 20 54 65 78 74 20 45 6e 63 6f  I3REF: Text Enco
28c60 64 69 6e 67 73 0a 2a 2a 0a 2a 2a 20 54 68 65 73  dings.**.** Thes
28c70 65 20 63 6f 6e 73 74 61 6e 74 20 64 65 66 69 6e  e constant defin
28c80 65 20 69 6e 74 65 67 65 72 20 63 6f 64 65 73 20  e integer codes 
28c90 74 68 61 74 20 72 65 70 72 65 73 65 6e 74 20 74  that represent t
28ca0 68 65 20 76 61 72 69 6f 75 73 0a 2a 2a 20 74 65  he various.** te
28cb0 78 74 20 65 6e 63 6f 64 69 6e 67 73 20 73 75 70  xt encodings sup
28cc0 70 6f 72 74 65 64 20 62 79 20 53 51 4c 69 74 65  ported by SQLite
28cd0 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c  ..*/.#define SQL
28ce0 49 54 45 5f 55 54 46 38 20 20 20 20 20 20 20 20  ITE_UTF8        
28cf0 20 20 20 31 0a 23 64 65 66 69 6e 65 20 53 51 4c     1.#define SQL
28d00 49 54 45 5f 55 54 46 31 36 4c 45 20 20 20 20 20  ITE_UTF16LE     
28d10 20 20 20 32 0a 23 64 65 66 69 6e 65 20 53 51 4c     2.#define SQL
28d20 49 54 45 5f 55 54 46 31 36 42 45 20 20 20 20 20  ITE_UTF16BE     
28d30 20 20 20 33 0a 23 64 65 66 69 6e 65 20 53 51 4c     3.#define SQL
28d40 49 54 45 5f 55 54 46 31 36 20 20 20 20 20 20 20  ITE_UTF16       
28d50 20 20 20 34 20 20 20 20 2f 2a 20 55 73 65 20 6e     4    /* Use n
28d60 61 74 69 76 65 20 62 79 74 65 20 6f 72 64 65 72  ative byte order
28d70 20 2a 2f 0a 23 64 65 66 69 6e 65 20 53 51 4c 49   */.#define SQLI
28d80 54 45 5f 41 4e 59 20 20 20 20 20 20 20 20 20 20  TE_ANY          
28d90 20 20 35 20 20 20 20 2f 2a 20 73 71 6c 69 74 65    5    /* sqlite
28da0 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f  3_create_functio
28db0 6e 20 6f 6e 6c 79 20 2a 2f 0a 23 64 65 66 69 6e  n only */.#defin
28dc0 65 20 53 51 4c 49 54 45 5f 55 54 46 31 36 5f 41  e SQLITE_UTF16_A
28dd0 4c 49 47 4e 45 44 20 20 38 20 20 20 20 2f 2a 20  LIGNED  8    /* 
28de0 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 63  sqlite3_create_c
28df0 6f 6c 6c 61 74 69 6f 6e 20 6f 6e 6c 79 20 2a 2f  ollation only */
28e00 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
28e10 3a 20 44 65 70 72 65 63 61 74 65 64 20 46 75 6e  : Deprecated Fun
28e20 63 74 69 6f 6e 73 0a 2a 2a 20 44 45 50 52 45 43  ctions.** DEPREC
28e30 41 54 45 44 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65  ATED.**.** These
28e40 20 66 75 6e 63 74 69 6f 6e 73 20 61 72 65 20 5b   functions are [
28e50 64 65 70 72 65 63 61 74 65 64 5d 2e 20 20 49 6e  deprecated].  In
28e60 20 6f 72 64 65 72 20 74 6f 20 6d 61 69 6e 74 61   order to mainta
28e70 69 6e 0a 2a 2a 20 62 61 63 6b 77 61 72 64 73 20  in.** backwards 
28e80 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 20 77 69  compatibility wi
28e90 74 68 20 6f 6c 64 65 72 20 63 6f 64 65 2c 20 74  th older code, t
28ea0 68 65 73 65 20 66 75 6e 63 74 69 6f 6e 73 20 63  hese functions c
28eb0 6f 6e 74 69 6e 75 65 20 0a 2a 2a 20 74 6f 20 62  ontinue .** to b
28ec0 65 20 73 75 70 70 6f 72 74 65 64 2e 20 20 48 6f  e supported.  Ho
28ed0 77 65 76 65 72 2c 20 6e 65 77 20 61 70 70 6c 69  wever, new appli
28ee0 63 61 74 69 6f 6e 73 20 73 68 6f 75 6c 64 20 61  cations should a
28ef0 76 6f 69 64 0a 2a 2a 20 74 68 65 20 75 73 65 20  void.** the use 
28f00 6f 66 20 74 68 65 73 65 20 66 75 6e 63 74 69 6f  of these functio
28f10 6e 73 2e 20 20 54 6f 20 68 65 6c 70 20 65 6e 63  ns.  To help enc
28f20 6f 75 72 61 67 65 20 70 65 6f 70 6c 65 20 74 6f  ourage people to
28f30 20 61 76 6f 69 64 0a 2a 2a 20 75 73 69 6e 67 20   avoid.** using 
28f40 74 68 65 73 65 20 66 75 6e 63 74 69 6f 6e 73 2c  these functions,
28f50 20 77 65 20 61 72 65 20 6e 6f 74 20 67 6f 69 6e   we are not goin
28f60 67 20 74 6f 20 74 65 6c 6c 20 79 6f 75 20 77 68  g to tell you wh
28f70 61 74 20 74 68 65 79 20 64 6f 2e 0a 2a 2f 0a 23  at they do..*/.#
28f80 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d  ifndef SQLITE_OM
28f90 49 54 5f 44 45 50 52 45 43 41 54 45 44 0a 53 51  IT_DEPRECATED.SQ
28fa0 4c 49 54 45 5f 44 45 50 52 45 43 41 54 45 44 20  LITE_DEPRECATED 
28fb0 69 6e 74 20 73 71 6c 69 74 65 33 5f 61 67 67 72  int sqlite3_aggr
28fc0 65 67 61 74 65 5f 63 6f 75 6e 74 28 73 71 6c 69  egate_count(sqli
28fd0 74 65 33 5f 63 6f 6e 74 65 78 74 2a 29 3b 0a 53  te3_context*);.S
28fe0 51 4c 49 54 45 5f 44 45 50 52 45 43 41 54 45 44  QLITE_DEPRECATED
28ff0 20 69 6e 74 20 73 71 6c 69 74 65 33 5f 65 78 70   int sqlite3_exp
29000 69 72 65 64 28 73 71 6c 69 74 65 33 5f 73 74 6d  ired(sqlite3_stm
29010 74 2a 29 3b 0a 53 51 4c 49 54 45 5f 44 45 50 52  t*);.SQLITE_DEPR
29020 45 43 41 54 45 44 20 69 6e 74 20 73 71 6c 69 74  ECATED int sqlit
29030 65 33 5f 74 72 61 6e 73 66 65 72 5f 62 69 6e 64  e3_transfer_bind
29040 69 6e 67 73 28 73 71 6c 69 74 65 33 5f 73 74 6d  ings(sqlite3_stm
29050 74 2a 2c 20 73 71 6c 69 74 65 33 5f 73 74 6d 74  t*, sqlite3_stmt
29060 2a 29 3b 0a 53 51 4c 49 54 45 5f 44 45 50 52 45  *);.SQLITE_DEPRE
29070 43 41 54 45 44 20 69 6e 74 20 73 71 6c 69 74 65  CATED int sqlite
29080 33 5f 67 6c 6f 62 61 6c 5f 72 65 63 6f 76 65 72  3_global_recover
29090 28 76 6f 69 64 29 3b 0a 53 51 4c 49 54 45 5f 44  (void);.SQLITE_D
290a0 45 50 52 45 43 41 54 45 44 20 76 6f 69 64 20 73  EPRECATED void s
290b0 71 6c 69 74 65 33 5f 74 68 72 65 61 64 5f 63 6c  qlite3_thread_cl
290c0 65 61 6e 75 70 28 76 6f 69 64 29 3b 0a 53 51 4c  eanup(void);.SQL
290d0 49 54 45 5f 44 45 50 52 45 43 41 54 45 44 20 69  ITE_DEPRECATED i
290e0 6e 74 20 73 71 6c 69 74 65 33 5f 6d 65 6d 6f 72  nt sqlite3_memor
290f0 79 5f 61 6c 61 72 6d 28 76 6f 69 64 28 2a 29 28  y_alarm(void(*)(
29100 76 6f 69 64 2a 2c 73 71 6c 69 74 65 33 5f 69 6e  void*,sqlite3_in
29110 74 36 34 2c 69 6e 74 29 2c 76 6f 69 64 2a 2c 73  t64,int),void*,s
29120 71 6c 69 74 65 33 5f 69 6e 74 36 34 29 3b 0a 23  qlite3_int64);.#
29130 65 6e 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  endif../*.** CAP
29140 49 33 52 45 46 3a 20 4f 62 74 61 69 6e 69 6e 67  I3REF: Obtaining
29150 20 53 51 4c 20 46 75 6e 63 74 69 6f 6e 20 50 61   SQL Function Pa
29160 72 61 6d 65 74 65 72 20 56 61 6c 75 65 73 0a 2a  rameter Values.*
29170 2a 0a 2a 2a 20 54 68 65 20 43 2d 6c 61 6e 67 75  *.** The C-langu
29180 61 67 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  age implementati
29190 6f 6e 20 6f 66 20 53 51 4c 20 66 75 6e 63 74 69  on of SQL functi
291a0 6f 6e 73 20 61 6e 64 20 61 67 67 72 65 67 61 74  ons and aggregat
291b0 65 73 20 75 73 65 73 0a 2a 2a 20 74 68 69 73 20  es uses.** this 
291c0 73 65 74 20 6f 66 20 69 6e 74 65 72 66 61 63 65  set of interface
291d0 20 72 6f 75 74 69 6e 65 73 20 74 6f 20 61 63 63   routines to acc
291e0 65 73 73 20 74 68 65 20 70 61 72 61 6d 65 74 65  ess the paramete
291f0 72 20 76 61 6c 75 65 73 20 6f 6e 0a 2a 2a 20 74  r values on.** t
29200 68 65 20 66 75 6e 63 74 69 6f 6e 20 6f 72 20 61  he function or a
29210 67 67 72 65 67 61 74 65 2e 0a 2a 2a 0a 2a 2a 20  ggregate..**.** 
29220 54 68 65 20 78 46 75 6e 63 20 28 66 6f 72 20 73  The xFunc (for s
29230 63 61 6c 61 72 20 66 75 6e 63 74 69 6f 6e 73 29  calar functions)
29240 20 6f 72 20 78 53 74 65 70 20 28 66 6f 72 20 61   or xStep (for a
29250 67 67 72 65 67 61 74 65 73 29 20 70 61 72 61 6d  ggregates) param
29260 65 74 65 72 73 0a 2a 2a 20 74 6f 20 5b 73 71 6c  eters.** to [sql
29270 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63  ite3_create_func
29280 74 69 6f 6e 28 29 5d 20 61 6e 64 20 5b 73 71 6c  tion()] and [sql
29290 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75 6e 63  ite3_create_func
292a0 74 69 6f 6e 31 36 28 29 5d 0a 2a 2a 20 64 65 66  tion16()].** def
292b0 69 6e 65 20 63 61 6c 6c 62 61 63 6b 73 20 74 68  ine callbacks th
292c0 61 74 20 69 6d 70 6c 65 6d 65 6e 74 20 74 68 65  at implement the
292d0 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20 61   SQL functions a
292e0 6e 64 20 61 67 67 72 65 67 61 74 65 73 2e 0a 2a  nd aggregates..*
292f0 2a 20 54 68 65 20 33 72 64 20 70 61 72 61 6d 65  * The 3rd parame
29300 74 65 72 20 74 6f 20 74 68 65 73 65 20 63 61 6c  ter to these cal
29310 6c 62 61 63 6b 73 20 69 73 20 61 6e 20 61 72 72  lbacks is an arr
29320 61 79 20 6f 66 20 70 6f 69 6e 74 65 72 73 20 74  ay of pointers t
29330 6f 0a 2a 2a 20 5b 70 72 6f 74 65 63 74 65 64 20  o.** [protected 
29340 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f  sqlite3_value] o
29350 62 6a 65 63 74 73 2e 20 20 54 68 65 72 65 20 69  bjects.  There i
29360 73 20 6f 6e 65 20 5b 73 71 6c 69 74 65 33 5f 76  s one [sqlite3_v
29370 61 6c 75 65 5d 20 6f 62 6a 65 63 74 20 66 6f 72  alue] object for
29380 0a 2a 2a 20 65 61 63 68 20 70 61 72 61 6d 65 74  .** each paramet
29390 65 72 20 74 6f 20 74 68 65 20 53 51 4c 20 66 75  er to the SQL fu
293a0 6e 63 74 69 6f 6e 2e 20 20 54 68 65 73 65 20 72  nction.  These r
293b0 6f 75 74 69 6e 65 73 20 61 72 65 20 75 73 65 64  outines are used
293c0 20 74 6f 0a 2a 2a 20 65 78 74 72 61 63 74 20 76   to.** extract v
293d0 61 6c 75 65 73 20 66 72 6f 6d 20 74 68 65 20 5b  alues from the [
293e0 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f  sqlite3_value] o
293f0 62 6a 65 63 74 73 2e 0a 2a 2a 0a 2a 2a 20 54 68  bjects..**.** Th
29400 65 73 65 20 72 6f 75 74 69 6e 65 73 20 77 6f 72  ese routines wor
29410 6b 20 6f 6e 6c 79 20 77 69 74 68 20 5b 70 72 6f  k only with [pro
29420 74 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76  tected sqlite3_v
29430 61 6c 75 65 5d 20 6f 62 6a 65 63 74 73 2e 0a 2a  alue] objects..*
29440 2a 20 41 6e 79 20 61 74 74 65 6d 70 74 20 74 6f  * Any attempt to
29450 20 75 73 65 20 74 68 65 73 65 20 72 6f 75 74 69   use these routi
29460 6e 65 73 20 6f 6e 20 61 6e 20 5b 75 6e 70 72 6f  nes on an [unpro
29470 74 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f 76  tected sqlite3_v
29480 61 6c 75 65 5d 0a 2a 2a 20 6f 62 6a 65 63 74 20  alue].** object 
29490 72 65 73 75 6c 74 73 20 69 6e 20 75 6e 64 65 66  results in undef
294a0 69 6e 65 64 20 62 65 68 61 76 69 6f 72 2e 0a 2a  ined behavior..*
294b0 2a 0a 2a 2a 20 5e 54 68 65 73 65 20 72 6f 75 74  *.** ^These rout
294c0 69 6e 65 73 20 77 6f 72 6b 20 6a 75 73 74 20 6c  ines work just l
294d0 69 6b 65 20 74 68 65 20 63 6f 72 72 65 73 70 6f  ike the correspo
294e0 6e 64 69 6e 67 20 5b 63 6f 6c 75 6d 6e 20 61 63  nding [column ac
294f0 63 65 73 73 20 66 75 6e 63 74 69 6f 6e 73 5d 0a  cess functions].
29500 2a 2a 20 65 78 63 65 70 74 20 74 68 61 74 20 20  ** except that  
29510 74 68 65 73 65 20 72 6f 75 74 69 6e 65 73 20 74  these routines t
29520 61 6b 65 20 61 20 73 69 6e 67 6c 65 20 5b 70 72  ake a single [pr
29530 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65 33 5f  otected sqlite3_
29540 76 61 6c 75 65 5d 20 6f 62 6a 65 63 74 0a 2a 2a  value] object.**
29550 20 70 6f 69 6e 74 65 72 20 69 6e 73 74 65 61 64   pointer instead
29560 20 6f 66 20 61 20 5b 73 71 6c 69 74 65 33 5f 73   of a [sqlite3_s
29570 74 6d 74 2a 5d 20 70 6f 69 6e 74 65 72 20 61 6e  tmt*] pointer an
29580 64 20 61 6e 20 69 6e 74 65 67 65 72 20 63 6f 6c  d an integer col
29590 75 6d 6e 20 6e 75 6d 62 65 72 2e 0a 2a 2a 0a 2a  umn number..**.*
295a0 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 76  * ^The sqlite3_v
295b0 61 6c 75 65 5f 74 65 78 74 31 36 28 29 20 69 6e  alue_text16() in
295c0 74 65 72 66 61 63 65 20 65 78 74 72 61 63 74 73  terface extracts
295d0 20 61 20 55 54 46 2d 31 36 20 73 74 72 69 6e 67   a UTF-16 string
295e0 0a 2a 2a 20 69 6e 20 74 68 65 20 6e 61 74 69 76  .** in the nativ
295f0 65 20 62 79 74 65 2d 6f 72 64 65 72 20 6f 66 20  e byte-order of 
29600 74 68 65 20 68 6f 73 74 20 6d 61 63 68 69 6e 65  the host machine
29610 2e 20 20 5e 54 68 65 0a 2a 2a 20 73 71 6c 69 74  .  ^The.** sqlit
29620 65 33 5f 76 61 6c 75 65 5f 74 65 78 74 31 36 62  e3_value_text16b
29630 65 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f  e() and sqlite3_
29640 76 61 6c 75 65 5f 74 65 78 74 31 36 6c 65 28 29  value_text16le()
29650 20 69 6e 74 65 72 66 61 63 65 73 0a 2a 2a 20 65   interfaces.** e
29660 78 74 72 61 63 74 20 55 54 46 2d 31 36 20 73 74  xtract UTF-16 st
29670 72 69 6e 67 73 20 61 73 20 62 69 67 2d 65 6e 64  rings as big-end
29680 69 61 6e 20 61 6e 64 20 6c 69 74 74 6c 65 2d 65  ian and little-e
29690 6e 64 69 61 6e 20 72 65 73 70 65 63 74 69 76 65  ndian respective
296a0 6c 79 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20  ly..**.** ^(The 
296b0 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 6e 75  sqlite3_value_nu
296c0 6d 65 72 69 63 5f 74 79 70 65 28 29 20 69 6e 74  meric_type() int
296d0 65 72 66 61 63 65 20 61 74 74 65 6d 70 74 73 20  erface attempts 
296e0 74 6f 20 61 70 70 6c 79 0a 2a 2a 20 6e 75 6d 65  to apply.** nume
296f0 72 69 63 20 61 66 66 69 6e 69 74 79 20 74 6f 20  ric affinity to 
29700 74 68 65 20 76 61 6c 75 65 2e 20 20 54 68 69 73  the value.  This
29710 20 6d 65 61 6e 73 20 74 68 61 74 20 61 6e 20 61   means that an a
29720 74 74 65 6d 70 74 20 69 73 0a 2a 2a 20 6d 61 64  ttempt is.** mad
29730 65 20 74 6f 20 63 6f 6e 76 65 72 74 20 74 68 65  e to convert the
29740 20 76 61 6c 75 65 20 74 6f 20 61 6e 20 69 6e 74   value to an int
29750 65 67 65 72 20 6f 72 20 66 6c 6f 61 74 69 6e 67  eger or floating
29760 20 70 6f 69 6e 74 2e 20 20 49 66 0a 2a 2a 20 73   point.  If.** s
29770 75 63 68 20 61 20 63 6f 6e 76 65 72 73 69 6f 6e  uch a conversion
29780 20 69 73 20 70 6f 73 73 69 62 6c 65 20 77 69 74   is possible wit
29790 68 6f 75 74 20 6c 6f 73 73 20 6f 66 20 69 6e 66  hout loss of inf
297a0 6f 72 6d 61 74 69 6f 6e 20 28 69 6e 20 6f 74 68  ormation (in oth
297b0 65 72 0a 2a 2a 20 77 6f 72 64 73 2c 20 69 66 20  er.** words, if 
297c0 74 68 65 20 76 61 6c 75 65 20 69 73 20 61 20 73  the value is a s
297d0 74 72 69 6e 67 20 74 68 61 74 20 6c 6f 6f 6b 73  tring that looks
297e0 20 6c 69 6b 65 20 61 20 6e 75 6d 62 65 72 29 0a   like a number).
297f0 2a 2a 20 74 68 65 6e 20 74 68 65 20 63 6f 6e 76  ** then the conv
29800 65 72 73 69 6f 6e 20 69 73 20 70 65 72 66 6f 72  ersion is perfor
29810 6d 65 64 2e 20 20 4f 74 68 65 72 77 69 73 65 20  med.  Otherwise 
29820 6e 6f 20 63 6f 6e 76 65 72 73 69 6f 6e 20 6f 63  no conversion oc
29830 63 75 72 73 2e 0a 2a 2a 20 54 68 65 20 5b 53 51  curs..** The [SQ
29840 4c 49 54 45 5f 49 4e 54 45 47 45 52 20 7c 20 64  LITE_INTEGER | d
29850 61 74 61 74 79 70 65 5d 20 61 66 74 65 72 20 63  atatype] after c
29860 6f 6e 76 65 72 73 69 6f 6e 20 69 73 20 72 65 74  onversion is ret
29870 75 72 6e 65 64 2e 29 5e 0a 2a 2a 0a 2a 2a 20 50  urned.)^.**.** P
29880 6c 65 61 73 65 20 70 61 79 20 70 61 72 74 69 63  lease pay partic
29890 75 6c 61 72 20 61 74 74 65 6e 74 69 6f 6e 20 74  ular attention t
298a0 6f 20 74 68 65 20 66 61 63 74 20 74 68 61 74 20  o the fact that 
298b0 74 68 65 20 70 6f 69 6e 74 65 72 20 72 65 74 75  the pointer retu
298c0 72 6e 65 64 0a 2a 2a 20 66 72 6f 6d 20 5b 73 71  rned.** from [sq
298d0 6c 69 74 65 33 5f 76 61 6c 75 65 5f 62 6c 6f 62  lite3_value_blob
298e0 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 76 61  ()], [sqlite3_va
298f0 6c 75 65 5f 74 65 78 74 28 29 5d 2c 20 6f 72 0a  lue_text()], or.
29900 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75  ** [sqlite3_valu
29910 65 5f 74 65 78 74 31 36 28 29 5d 20 63 61 6e 20  e_text16()] can 
29920 62 65 20 69 6e 76 61 6c 69 64 61 74 65 64 20 62  be invalidated b
29930 79 20 61 20 73 75 62 73 65 71 75 65 6e 74 20 63  y a subsequent c
29940 61 6c 6c 20 74 6f 0a 2a 2a 20 5b 73 71 6c 69 74  all to.** [sqlit
29950 65 33 5f 76 61 6c 75 65 5f 62 79 74 65 73 28 29  e3_value_bytes()
29960 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 76 61 6c 75  ], [sqlite3_valu
29970 65 5f 62 79 74 65 73 31 36 28 29 5d 2c 20 5b 73  e_bytes16()], [s
29980 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 65 78  qlite3_value_tex
29990 74 28 29 5d 2c 0a 2a 2a 20 6f 72 20 5b 73 71 6c  t()],.** or [sql
299a0 69 74 65 33 5f 76 61 6c 75 65 5f 74 65 78 74 31  ite3_value_text1
299b0 36 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 73  6()]..**.** Thes
299c0 65 20 72 6f 75 74 69 6e 65 73 20 6d 75 73 74 20  e routines must 
299d0 62 65 20 63 61 6c 6c 65 64 20 66 72 6f 6d 20 74  be called from t
299e0 68 65 20 73 61 6d 65 20 74 68 72 65 61 64 20 61  he same thread a
299f0 73 0a 2a 2a 20 74 68 65 20 53 51 4c 20 66 75 6e  s.** the SQL fun
29a00 63 74 69 6f 6e 20 74 68 61 74 20 73 75 70 70 6c  ction that suppl
29a10 69 65 64 20 74 68 65 20 5b 73 71 6c 69 74 65 33  ied the [sqlite3
29a20 5f 76 61 6c 75 65 2a 5d 20 70 61 72 61 6d 65 74  _value*] paramet
29a30 65 72 73 2e 0a 2a 2f 0a 63 6f 6e 73 74 20 76 6f  ers..*/.const vo
29a40 69 64 20 2a 73 71 6c 69 74 65 33 5f 76 61 6c 75  id *sqlite3_valu
29a50 65 5f 62 6c 6f 62 28 73 71 6c 69 74 65 33 5f 76  e_blob(sqlite3_v
29a60 61 6c 75 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69  alue*);.int sqli
29a70 74 65 33 5f 76 61 6c 75 65 5f 62 79 74 65 73 28  te3_value_bytes(
29a80 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b  sqlite3_value*);
29a90 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 76 61 6c  .int sqlite3_val
29aa0 75 65 5f 62 79 74 65 73 31 36 28 73 71 6c 69 74  ue_bytes16(sqlit
29ab0 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 64 6f 75 62  e3_value*);.doub
29ac0 6c 65 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65  le sqlite3_value
29ad0 5f 64 6f 75 62 6c 65 28 73 71 6c 69 74 65 33 5f  _double(sqlite3_
29ae0 76 61 6c 75 65 2a 29 3b 0a 69 6e 74 20 73 71 6c  value*);.int sql
29af0 69 74 65 33 5f 76 61 6c 75 65 5f 69 6e 74 28 73  ite3_value_int(s
29b00 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a  qlite3_value*);.
29b10 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 20 73 71  sqlite3_int64 sq
29b20 6c 69 74 65 33 5f 76 61 6c 75 65 5f 69 6e 74 36  lite3_value_int6
29b30 34 28 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a  4(sqlite3_value*
29b40 29 3b 0a 63 6f 6e 73 74 20 75 6e 73 69 67 6e 65  );.const unsigne
29b50 64 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f  d char *sqlite3_
29b60 76 61 6c 75 65 5f 74 65 78 74 28 73 71 6c 69 74  value_text(sqlit
29b70 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 63 6f 6e 73  e3_value*);.cons
29b80 74 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f  t void *sqlite3_
29b90 76 61 6c 75 65 5f 74 65 78 74 31 36 28 73 71 6c  value_text16(sql
29ba0 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 63 6f  ite3_value*);.co
29bb0 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c 69 74 65  nst void *sqlite
29bc0 33 5f 76 61 6c 75 65 5f 74 65 78 74 31 36 6c 65  3_value_text16le
29bd0 28 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29  (sqlite3_value*)
29be0 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71  ;.const void *sq
29bf0 6c 69 74 65 33 5f 76 61 6c 75 65 5f 74 65 78 74  lite3_value_text
29c00 31 36 62 65 28 73 71 6c 69 74 65 33 5f 76 61 6c  16be(sqlite3_val
29c10 75 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  ue*);.int sqlite
29c20 33 5f 76 61 6c 75 65 5f 74 79 70 65 28 73 71 6c  3_value_type(sql
29c30 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 69 6e  ite3_value*);.in
29c40 74 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 5f  t sqlite3_value_
29c50 6e 75 6d 65 72 69 63 5f 74 79 70 65 28 73 71 6c  numeric_type(sql
29c60 69 74 65 33 5f 76 61 6c 75 65 2a 29 3b 0a 0a 2f  ite3_value*);../
29c70 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4f  *.** CAPI3REF: O
29c80 62 74 61 69 6e 20 41 67 67 72 65 67 61 74 65 20  btain Aggregate 
29c90 46 75 6e 63 74 69 6f 6e 20 43 6f 6e 74 65 78 74  Function Context
29ca0 0a 2a 2a 0a 2a 2a 20 49 6d 70 6c 65 6d 65 6e 74  .**.** Implement
29cb0 61 74 69 6f 6e 73 20 6f 66 20 61 67 67 72 65 67  ations of aggreg
29cc0 61 74 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  ate SQL function
29cd0 73 20 75 73 65 20 74 68 69 73 0a 2a 2a 20 72 6f  s use this.** ro
29ce0 75 74 69 6e 65 20 74 6f 20 61 6c 6c 6f 63 61 74  utine to allocat
29cf0 65 20 6d 65 6d 6f 72 79 20 66 6f 72 20 73 74 6f  e memory for sto
29d00 72 69 6e 67 20 74 68 65 69 72 20 73 74 61 74 65  ring their state
29d10 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66 69 72  ..**.** ^The fir
29d20 73 74 20 74 69 6d 65 20 74 68 65 20 73 71 6c 69  st time the sqli
29d30 74 65 33 5f 61 67 67 72 65 67 61 74 65 5f 63 6f  te3_aggregate_co
29d40 6e 74 65 78 74 28 43 2c 4e 29 20 72 6f 75 74 69  ntext(C,N) routi
29d50 6e 65 20 69 73 20 63 61 6c 6c 65 64 20 0a 2a 2a  ne is called .**
29d60 20 66 6f 72 20 61 20 70 61 72 74 69 63 75 6c 61   for a particula
29d70 72 20 61 67 67 72 65 67 61 74 65 20 66 75 6e 63  r aggregate func
29d80 74 69 6f 6e 2c 20 53 51 4c 69 74 65 0a 2a 2a 20  tion, SQLite.** 
29d90 61 6c 6c 6f 63 61 74 65 73 20 4e 20 6f 66 20 6d  allocates N of m
29da0 65 6d 6f 72 79 2c 20 7a 65 72 6f 65 73 20 6f 75  emory, zeroes ou
29db0 74 20 74 68 61 74 20 6d 65 6d 6f 72 79 2c 20 61  t that memory, a
29dc0 6e 64 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69  nd returns a poi
29dd0 6e 74 65 72 0a 2a 2a 20 74 6f 20 74 68 65 20 6e  nter.** to the n
29de0 65 77 20 6d 65 6d 6f 72 79 2e 20 5e 4f 6e 20 73  ew memory. ^On s
29df0 65 63 6f 6e 64 20 61 6e 64 20 73 75 62 73 65 71  econd and subseq
29e00 75 65 6e 74 20 63 61 6c 6c 73 20 74 6f 0a 2a 2a  uent calls to.**
29e10 20 73 71 6c 69 74 65 33 5f 61 67 67 72 65 67 61   sqlite3_aggrega
29e20 74 65 5f 63 6f 6e 74 65 78 74 28 29 20 66 6f 72  te_context() for
29e30 20 74 68 65 20 73 61 6d 65 20 61 67 67 72 65 67   the same aggreg
29e40 61 74 65 20 66 75 6e 63 74 69 6f 6e 20 69 6e 73  ate function ins
29e50 74 61 6e 63 65 2c 0a 2a 2a 20 74 68 65 20 73 61  tance,.** the sa
29e60 6d 65 20 62 75 66 66 65 72 20 69 73 20 72 65 74  me buffer is ret
29e70 75 72 6e 65 64 2e 20 20 53 71 6c 69 74 65 33 5f  urned.  Sqlite3_
29e80 61 67 67 72 65 67 61 74 65 5f 63 6f 6e 74 65 78  aggregate_contex
29e90 74 28 29 20 69 73 20 6e 6f 72 6d 61 6c 6c 79 0a  t() is normally.
29ea0 2a 2a 20 63 61 6c 6c 65 64 20 6f 6e 63 65 20 66  ** called once f
29eb0 6f 72 20 65 61 63 68 20 69 6e 76 6f 63 61 74 69  or each invocati
29ec0 6f 6e 20 6f 66 20 74 68 65 20 78 53 74 65 70 20  on of the xStep 
29ed0 63 61 6c 6c 62 61 63 6b 20 61 6e 64 20 74 68 65  callback and the
29ee0 6e 20 6f 6e 65 0a 2a 2a 20 6c 61 73 74 20 74 69  n one.** last ti
29ef0 6d 65 20 77 68 65 6e 20 74 68 65 20 78 46 69 6e  me when the xFin
29f00 61 6c 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 69  al callback is i
29f10 6e 76 6f 6b 65 64 2e 20 20 5e 28 57 68 65 6e 20  nvoked.  ^(When 
29f20 6e 6f 20 72 6f 77 73 20 6d 61 74 63 68 0a 2a 2a  no rows match.**
29f30 20 61 6e 20 61 67 67 72 65 67 61 74 65 20 71 75   an aggregate qu
29f40 65 72 79 2c 20 74 68 65 20 78 53 74 65 70 28 29  ery, the xStep()
29f50 20 63 61 6c 6c 62 61 63 6b 20 6f 66 20 74 68 65   callback of the
29f60 20 61 67 67 72 65 67 61 74 65 20 66 75 6e 63 74   aggregate funct
29f70 69 6f 6e 0a 2a 2a 20 69 6d 70 6c 65 6d 65 6e 74  ion.** implement
29f80 61 74 69 6f 6e 20 69 73 20 6e 65 76 65 72 20 63  ation is never c
29f90 61 6c 6c 65 64 20 61 6e 64 20 78 46 69 6e 61 6c  alled and xFinal
29fa0 28 29 20 69 73 20 63 61 6c 6c 65 64 20 65 78 61  () is called exa
29fb0 63 74 6c 79 20 6f 6e 63 65 2e 0a 2a 2a 20 49 6e  ctly once..** In
29fc0 20 74 68 6f 73 65 20 63 61 73 65 73 2c 20 73 71   those cases, sq
29fd0 6c 69 74 65 33 5f 61 67 67 72 65 67 61 74 65 5f  lite3_aggregate_
29fe0 63 6f 6e 74 65 78 74 28 29 20 6d 69 67 68 74 20  context() might 
29ff0 62 65 20 63 61 6c 6c 65 64 20 66 6f 72 20 74 68  be called for th
2a000 65 0a 2a 2a 20 66 69 72 73 74 20 74 69 6d 65 20  e.** first time 
2a010 66 72 6f 6d 20 77 69 74 68 69 6e 20 78 46 69 6e  from within xFin
2a020 61 6c 28 29 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 54  al().)^.**.** ^T
2a030 68 65 20 73 71 6c 69 74 65 33 5f 61 67 67 72 65  he sqlite3_aggre
2a040 67 61 74 65 5f 63 6f 6e 74 65 78 74 28 43 2c 4e  gate_context(C,N
2a050 29 20 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e  ) routine return
2a060 73 20 61 20 4e 55 4c 4c 20 70 6f 69 6e 74 65 72  s a NULL pointer
2a070 20 69 66 20 4e 20 69 73 0a 2a 2a 20 6c 65 73 73   if N is.** less
2a080 20 74 68 61 6e 20 6f 72 20 65 71 75 61 6c 20 74   than or equal t
2a090 6f 20 7a 65 72 6f 20 6f 72 20 69 66 20 61 20 6d  o zero or if a m
2a0a0 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74 65 20 65  emory allocate e
2a0b0 72 72 6f 72 20 6f 63 63 75 72 73 2e 0a 2a 2a 0a  rror occurs..**.
2a0c0 2a 2a 20 5e 28 54 68 65 20 61 6d 6f 75 6e 74 20  ** ^(The amount 
2a0d0 6f 66 20 73 70 61 63 65 20 61 6c 6c 6f 63 61 74  of space allocat
2a0e0 65 64 20 62 79 20 73 71 6c 69 74 65 33 5f 61 67  ed by sqlite3_ag
2a0f0 67 72 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28  gregate_context(
2a100 43 2c 4e 29 20 69 73 0a 2a 2a 20 64 65 74 65 72  C,N) is.** deter
2a110 6d 69 6e 65 64 20 62 79 20 74 68 65 20 4e 20 70  mined by the N p
2a120 61 72 61 6d 65 74 65 72 20 6f 6e 20 66 69 72 73  arameter on firs
2a130 74 20 73 75 63 63 65 73 73 66 75 6c 20 63 61 6c  t successful cal
2a140 6c 2e 20 20 43 68 61 6e 67 69 6e 67 20 74 68 65  l.  Changing the
2a150 0a 2a 2a 20 76 61 6c 75 65 20 6f 66 20 4e 20 69  .** value of N i
2a160 6e 20 73 75 62 73 65 71 75 65 6e 74 20 63 61 6c  n subsequent cal
2a170 6c 20 74 6f 20 73 71 6c 69 74 65 33 5f 61 67 67  l to sqlite3_agg
2a180 72 65 67 61 74 65 5f 63 6f 6e 74 65 78 74 28 29  regate_context()
2a190 20 77 69 74 68 69 6e 0a 2a 2a 20 74 68 65 20 73   within.** the s
2a1a0 61 6d 65 20 61 67 67 72 65 67 61 74 65 20 66 75  ame aggregate fu
2a1b0 6e 63 74 69 6f 6e 20 69 6e 73 74 61 6e 63 65 20  nction instance 
2a1c0 77 69 6c 6c 20 6e 6f 74 20 72 65 73 69 7a 65 20  will not resize 
2a1d0 74 68 65 20 6d 65 6d 6f 72 79 0a 2a 2a 20 61 6c  the memory.** al
2a1e0 6c 6f 63 61 74 69 6f 6e 2e 29 5e 0a 2a 2a 0a 2a  location.)^.**.*
2a1f0 2a 20 5e 53 51 4c 69 74 65 20 61 75 74 6f 6d 61  * ^SQLite automa
2a200 74 69 63 61 6c 6c 79 20 66 72 65 65 73 20 74 68  tically frees th
2a210 65 20 6d 65 6d 6f 72 79 20 61 6c 6c 6f 63 61 74  e memory allocat
2a220 65 64 20 62 79 20 0a 2a 2a 20 73 71 6c 69 74 65  ed by .** sqlite
2a230 33 5f 61 67 67 72 65 67 61 74 65 5f 63 6f 6e 74  3_aggregate_cont
2a240 65 78 74 28 29 20 77 68 65 6e 20 74 68 65 20 61  ext() when the a
2a250 67 67 72 65 67 61 74 65 20 71 75 65 72 79 20 63  ggregate query c
2a260 6f 6e 63 6c 75 64 65 73 2e 0a 2a 2a 0a 2a 2a 20  oncludes..**.** 
2a270 54 68 65 20 66 69 72 73 74 20 70 61 72 61 6d 65  The first parame
2a280 74 65 72 20 6d 75 73 74 20 62 65 20 61 20 63 6f  ter must be a co
2a290 70 79 20 6f 66 20 74 68 65 0a 2a 2a 20 5b 73 71  py of the.** [sq
2a2a0 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 20 7c 20  lite3_context | 
2a2b0 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 63 6f 6e  SQL function con
2a2c0 74 65 78 74 5d 20 74 68 61 74 20 69 73 20 74 68  text] that is th
2a2d0 65 20 66 69 72 73 74 20 70 61 72 61 6d 65 74 65  e first paramete
2a2e0 72 0a 2a 2a 20 74 6f 20 74 68 65 20 78 53 74 65  r.** to the xSte
2a2f0 70 20 6f 72 20 78 46 69 6e 61 6c 20 63 61 6c 6c  p or xFinal call
2a300 62 61 63 6b 20 72 6f 75 74 69 6e 65 20 74 68 61  back routine tha
2a310 74 20 69 6d 70 6c 65 6d 65 6e 74 73 20 74 68 65  t implements the
2a320 20 61 67 67 72 65 67 61 74 65 0a 2a 2a 20 66 75   aggregate.** fu
2a330 6e 63 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 54 68  nction..**.** Th
2a340 69 73 20 72 6f 75 74 69 6e 65 20 6d 75 73 74 20  is routine must 
2a350 62 65 20 63 61 6c 6c 65 64 20 66 72 6f 6d 20 74  be called from t
2a360 68 65 20 73 61 6d 65 20 74 68 72 65 61 64 20 69  he same thread i
2a370 6e 20 77 68 69 63 68 0a 2a 2a 20 74 68 65 20 61  n which.** the a
2a380 67 67 72 65 67 61 74 65 20 53 51 4c 20 66 75 6e  ggregate SQL fun
2a390 63 74 69 6f 6e 20 69 73 20 72 75 6e 6e 69 6e 67  ction is running
2a3a0 2e 0a 2a 2f 0a 76 6f 69 64 20 2a 73 71 6c 69 74  ..*/.void *sqlit
2a3b0 65 33 5f 61 67 67 72 65 67 61 74 65 5f 63 6f 6e  e3_aggregate_con
2a3c0 74 65 78 74 28 73 71 6c 69 74 65 33 5f 63 6f 6e  text(sqlite3_con
2a3d0 74 65 78 74 2a 2c 20 69 6e 74 20 6e 42 79 74 65  text*, int nByte
2a3e0 73 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33  s);../*.** CAPI3
2a3f0 52 45 46 3a 20 55 73 65 72 20 44 61 74 61 20 46  REF: User Data F
2a400 6f 72 20 46 75 6e 63 74 69 6f 6e 73 0a 2a 2a 0a  or Functions.**.
2a410 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  ** ^The sqlite3_
2a420 75 73 65 72 5f 64 61 74 61 28 29 20 69 6e 74 65  user_data() inte
2a430 72 66 61 63 65 20 72 65 74 75 72 6e 73 20 61 20  rface returns a 
2a440 63 6f 70 79 20 6f 66 0a 2a 2a 20 74 68 65 20 70  copy of.** the p
2a450 6f 69 6e 74 65 72 20 74 68 61 74 20 77 61 73 20  ointer that was 
2a460 74 68 65 20 70 55 73 65 72 44 61 74 61 20 70 61  the pUserData pa
2a470 72 61 6d 65 74 65 72 20 28 74 68 65 20 35 74 68  rameter (the 5th
2a480 20 70 61 72 61 6d 65 74 65 72 29 0a 2a 2a 20 6f   parameter).** o
2a490 66 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 63  f the [sqlite3_c
2a4a0 72 65 61 74 65 5f 66 75 6e 63 74 69 6f 6e 28 29  reate_function()
2a4b0 5d 0a 2a 2a 20 61 6e 64 20 5b 73 71 6c 69 74 65  ].** and [sqlite
2a4c0 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f  3_create_functio
2a4d0 6e 31 36 28 29 5d 20 72 6f 75 74 69 6e 65 73 20  n16()] routines 
2a4e0 74 68 61 74 20 6f 72 69 67 69 6e 61 6c 6c 79 0a  that originally.
2a4f0 2a 2a 20 72 65 67 69 73 74 65 72 65 64 20 74 68  ** registered th
2a500 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 64 65  e application de
2a510 66 69 6e 65 64 20 66 75 6e 63 74 69 6f 6e 2e 0a  fined function..
2a520 2a 2a 0a 2a 2a 20 54 68 69 73 20 72 6f 75 74 69  **.** This routi
2a530 6e 65 20 6d 75 73 74 20 62 65 20 63 61 6c 6c 65  ne must be calle
2a540 64 20 66 72 6f 6d 20 74 68 65 20 73 61 6d 65 20  d from the same 
2a550 74 68 72 65 61 64 20 69 6e 20 77 68 69 63 68 0a  thread in which.
2a560 2a 2a 20 74 68 65 20 61 70 70 6c 69 63 61 74 69  ** the applicati
2a570 6f 6e 2d 64 65 66 69 6e 65 64 20 66 75 6e 63 74  on-defined funct
2a580 69 6f 6e 20 69 73 20 72 75 6e 6e 69 6e 67 2e 0a  ion is running..
2a590 2a 2f 0a 76 6f 69 64 20 2a 73 71 6c 69 74 65 33  */.void *sqlite3
2a5a0 5f 75 73 65 72 5f 64 61 74 61 28 73 71 6c 69 74  _user_data(sqlit
2a5b0 65 33 5f 63 6f 6e 74 65 78 74 2a 29 3b 0a 0a 2f  e3_context*);../
2a5c0 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 44  *.** CAPI3REF: D
2a5d0 61 74 61 62 61 73 65 20 43 6f 6e 6e 65 63 74 69  atabase Connecti
2a5e0 6f 6e 20 46 6f 72 20 46 75 6e 63 74 69 6f 6e 73  on For Functions
2a5f0 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69  .**.** ^The sqli
2a600 74 65 33 5f 63 6f 6e 74 65 78 74 5f 64 62 5f 68  te3_context_db_h
2a610 61 6e 64 6c 65 28 29 20 69 6e 74 65 72 66 61 63  andle() interfac
2a620 65 20 72 65 74 75 72 6e 73 20 61 20 63 6f 70 79  e returns a copy
2a630 20 6f 66 0a 2a 2a 20 74 68 65 20 70 6f 69 6e 74   of.** the point
2a640 65 72 20 74 6f 20 74 68 65 20 5b 64 61 74 61 62  er to the [datab
2a650 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20  ase connection] 
2a660 28 74 68 65 20 31 73 74 20 70 61 72 61 6d 65 74  (the 1st paramet
2a670 65 72 29 0a 2a 2a 20 6f 66 20 74 68 65 20 5b 73  er).** of the [s
2a680 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 66 75  qlite3_create_fu
2a690 6e 63 74 69 6f 6e 28 29 5d 0a 2a 2a 20 61 6e 64  nction()].** and
2a6a0 20 5b 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65   [sqlite3_create
2a6b0 5f 66 75 6e 63 74 69 6f 6e 31 36 28 29 5d 20 72  _function16()] r
2a6c0 6f 75 74 69 6e 65 73 20 74 68 61 74 20 6f 72 69  outines that ori
2a6d0 67 69 6e 61 6c 6c 79 0a 2a 2a 20 72 65 67 69 73  ginally.** regis
2a6e0 74 65 72 65 64 20 74 68 65 20 61 70 70 6c 69 63  tered the applic
2a6f0 61 74 69 6f 6e 20 64 65 66 69 6e 65 64 20 66 75  ation defined fu
2a700 6e 63 74 69 6f 6e 2e 0a 2a 2f 0a 73 71 6c 69 74  nction..*/.sqlit
2a710 65 33 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6e 74  e3 *sqlite3_cont
2a720 65 78 74 5f 64 62 5f 68 61 6e 64 6c 65 28 73 71  ext_db_handle(sq
2a730 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 29 3b  lite3_context*);
2a740 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46  ../*.** CAPI3REF
2a750 3a 20 46 75 6e 63 74 69 6f 6e 20 41 75 78 69 6c  : Function Auxil
2a760 69 61 72 79 20 44 61 74 61 0a 2a 2a 0a 2a 2a 20  iary Data.**.** 
2a770 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 74 77  The following tw
2a780 6f 20 66 75 6e 63 74 69 6f 6e 73 20 6d 61 79 20  o functions may 
2a790 62 65 20 75 73 65 64 20 62 79 20 73 63 61 6c 61  be used by scala
2a7a0 72 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73 20  r SQL functions 
2a7b0 74 6f 0a 2a 2a 20 61 73 73 6f 63 69 61 74 65 20  to.** associate 
2a7c0 6d 65 74 61 64 61 74 61 20 77 69 74 68 20 61 72  metadata with ar
2a7d0 67 75 6d 65 6e 74 20 76 61 6c 75 65 73 2e 20 49  gument values. I
2a7e0 66 20 74 68 65 20 73 61 6d 65 20 76 61 6c 75 65  f the same value
2a7f0 20 69 73 20 70 61 73 73 65 64 20 74 6f 0a 2a 2a   is passed to.**
2a800 20 6d 75 6c 74 69 70 6c 65 20 69 6e 76 6f 63 61   multiple invoca
2a810 74 69 6f 6e 73 20 6f 66 20 74 68 65 20 73 61 6d  tions of the sam
2a820 65 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 64  e SQL function d
2a830 75 72 69 6e 67 20 71 75 65 72 79 20 65 78 65 63  uring query exec
2a840 75 74 69 6f 6e 2c 20 75 6e 64 65 72 0a 2a 2a 20  ution, under.** 
2a850 73 6f 6d 65 20 63 69 72 63 75 6d 73 74 61 6e 63  some circumstanc
2a860 65 73 20 74 68 65 20 61 73 73 6f 63 69 61 74 65  es the associate
2a870 64 20 6d 65 74 61 64 61 74 61 20 6d 61 79 20 62  d metadata may b
2a880 65 20 70 72 65 73 65 72 76 65 64 2e 20 54 68 69  e preserved. Thi
2a890 73 20 6d 61 79 0a 2a 2a 20 62 65 20 75 73 65 64  s may.** be used
2a8a0 2c 20 66 6f 72 20 65 78 61 6d 70 6c 65 2c 20 74  , for example, t
2a8b0 6f 20 61 64 64 20 61 20 72 65 67 75 6c 61 72 2d  o add a regular-
2a8c0 65 78 70 72 65 73 73 69 6f 6e 20 6d 61 74 63 68  expression match
2a8d0 69 6e 67 20 73 63 61 6c 61 72 0a 2a 2a 20 66 75  ing scalar.** fu
2a8e0 6e 63 74 69 6f 6e 2e 20 54 68 65 20 63 6f 6d 70  nction. The comp
2a8f0 69 6c 65 64 20 76 65 72 73 69 6f 6e 20 6f 66 20  iled version of 
2a900 74 68 65 20 72 65 67 75 6c 61 72 20 65 78 70 72  the regular expr
2a910 65 73 73 69 6f 6e 20 69 73 20 73 74 6f 72 65 64  ession is stored
2a920 20 61 73 0a 2a 2a 20 6d 65 74 61 64 61 74 61 20   as.** metadata 
2a930 61 73 73 6f 63 69 61 74 65 64 20 77 69 74 68 20  associated with 
2a940 74 68 65 20 53 51 4c 20 76 61 6c 75 65 20 70 61  the SQL value pa
2a950 73 73 65 64 20 61 73 20 74 68 65 20 72 65 67 75  ssed as the regu
2a960 6c 61 72 20 65 78 70 72 65 73 73 69 6f 6e 0a 2a  lar expression.*
2a970 2a 20 70 61 74 74 65 72 6e 2e 20 20 54 68 65 20  * pattern.  The 
2a980 63 6f 6d 70 69 6c 65 64 20 72 65 67 75 6c 61 72  compiled regular
2a990 20 65 78 70 72 65 73 73 69 6f 6e 20 63 61 6e 20   expression can 
2a9a0 62 65 20 72 65 75 73 65 64 20 6f 6e 20 6d 75 6c  be reused on mul
2a9b0 74 69 70 6c 65 0a 2a 2a 20 69 6e 76 6f 63 61 74  tiple.** invocat
2a9c0 69 6f 6e 73 20 6f 66 20 74 68 65 20 73 61 6d 65  ions of the same
2a9d0 20 66 75 6e 63 74 69 6f 6e 20 73 6f 20 74 68 61   function so tha
2a9e0 74 20 74 68 65 20 6f 72 69 67 69 6e 61 6c 20 70  t the original p
2a9f0 61 74 74 65 72 6e 20 73 74 72 69 6e 67 0a 2a 2a  attern string.**
2aa00 20 64 6f 65 73 20 6e 6f 74 20 6e 65 65 64 20 74   does not need t
2aa10 6f 20 62 65 20 72 65 63 6f 6d 70 69 6c 65 64 20  o be recompiled 
2aa20 6f 6e 20 65 61 63 68 20 69 6e 76 6f 63 61 74 69  on each invocati
2aa30 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  on..**.** ^The s
2aa40 71 6c 69 74 65 33 5f 67 65 74 5f 61 75 78 64 61  qlite3_get_auxda
2aa50 74 61 28 29 20 69 6e 74 65 72 66 61 63 65 20 72  ta() interface r
2aa60 65 74 75 72 6e 73 20 61 20 70 6f 69 6e 74 65 72  eturns a pointer
2aa70 20 74 6f 20 74 68 65 20 6d 65 74 61 64 61 74 61   to the metadata
2aa80 0a 2a 2a 20 61 73 73 6f 63 69 61 74 65 64 20 62  .** associated b
2aa90 79 20 74 68 65 20 73 71 6c 69 74 65 33 5f 73 65  y the sqlite3_se
2aaa0 74 5f 61 75 78 64 61 74 61 28 29 20 66 75 6e 63  t_auxdata() func
2aab0 74 69 6f 6e 20 77 69 74 68 20 74 68 65 20 4e 74  tion with the Nt
2aac0 68 20 61 72 67 75 6d 65 6e 74 0a 2a 2a 20 76 61  h argument.** va
2aad0 6c 75 65 20 74 6f 20 74 68 65 20 61 70 70 6c 69  lue to the appli
2aae0 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 66  cation-defined f
2aaf0 75 6e 63 74 69 6f 6e 2e 20 5e 49 66 20 6e 6f 20  unction. ^If no 
2ab00 6d 65 74 61 64 61 74 61 20 68 61 73 20 62 65 65  metadata has bee
2ab10 6e 20 65 76 65 72 0a 2a 2a 20 62 65 65 6e 20 73  n ever.** been s
2ab20 65 74 20 66 6f 72 20 74 68 65 20 4e 74 68 20 61  et for the Nth a
2ab30 72 67 75 6d 65 6e 74 20 6f 66 20 74 68 65 20 66  rgument of the f
2ab40 75 6e 63 74 69 6f 6e 2c 20 6f 72 20 69 66 20 74  unction, or if t
2ab50 68 65 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67  he corresponding
2ab60 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 70 61 72  .** function par
2ab70 61 6d 65 74 65 72 20 68 61 73 20 63 68 61 6e 67  ameter has chang
2ab80 65 64 20 73 69 6e 63 65 20 74 68 65 20 6d 65 74  ed since the met
2ab90 61 2d 64 61 74 61 20 77 61 73 20 73 65 74 2c 0a  a-data was set,.
2aba0 2a 2a 20 74 68 65 6e 20 73 71 6c 69 74 65 33 5f  ** then sqlite3_
2abb0 67 65 74 5f 61 75 78 64 61 74 61 28 29 20 72 65  get_auxdata() re
2abc0 74 75 72 6e 73 20 61 20 4e 55 4c 4c 20 70 6f 69  turns a NULL poi
2abd0 6e 74 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  nter..**.** ^The
2abe0 20 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78   sqlite3_set_aux
2abf0 64 61 74 61 28 29 20 69 6e 74 65 72 66 61 63 65  data() interface
2ac00 20 73 61 76 65 73 20 74 68 65 20 6d 65 74 61 64   saves the metad
2ac10 61 74 61 0a 2a 2a 20 70 6f 69 6e 74 65 64 20 74  ata.** pointed t
2ac20 6f 20 62 79 20 69 74 73 20 33 72 64 20 70 61 72  o by its 3rd par
2ac30 61 6d 65 74 65 72 20 61 73 20 74 68 65 20 6d 65  ameter as the me
2ac40 74 61 64 61 74 61 20 66 6f 72 20 74 68 65 20 4e  tadata for the N
2ac50 2d 74 68 0a 2a 2a 20 61 72 67 75 6d 65 6e 74 20  -th.** argument 
2ac60 6f 66 20 74 68 65 20 61 70 70 6c 69 63 61 74 69  of the applicati
2ac70 6f 6e 2d 64 65 66 69 6e 65 64 20 66 75 6e 63 74  on-defined funct
2ac80 69 6f 6e 2e 20 20 53 75 62 73 65 71 75 65 6e 74  ion.  Subsequent
2ac90 0a 2a 2a 20 63 61 6c 6c 73 20 74 6f 20 73 71 6c  .** calls to sql
2aca0 69 74 65 33 5f 67 65 74 5f 61 75 78 64 61 74 61  ite3_get_auxdata
2acb0 28 29 20 6d 69 67 68 74 20 72 65 74 75 72 6e 20  () might return 
2acc0 74 68 69 73 20 64 61 74 61 2c 20 69 66 20 69 74  this data, if it
2acd0 20 68 61 73 0a 2a 2a 20 6e 6f 74 20 62 65 65 6e   has.** not been
2ace0 20 64 65 73 74 72 6f 79 65 64 2e 0a 2a 2a 20 5e   destroyed..** ^
2acf0 49 66 20 69 74 20 69 73 20 6e 6f 74 20 4e 55 4c  If it is not NUL
2ad00 4c 2c 20 53 51 4c 69 74 65 20 77 69 6c 6c 20 69  L, SQLite will i
2ad10 6e 76 6f 6b 65 20 74 68 65 20 64 65 73 74 72 75  nvoke the destru
2ad20 63 74 6f 72 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e  ctor.** function
2ad30 20 67 69 76 65 6e 20 62 79 20 74 68 65 20 34 74   given by the 4t
2ad40 68 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73  h parameter to s
2ad50 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78 64 61  qlite3_set_auxda
2ad60 74 61 28 29 20 6f 6e 0a 2a 2a 20 74 68 65 20 6d  ta() on.** the m
2ad70 65 74 61 64 61 74 61 20 77 68 65 6e 20 74 68 65  etadata when the
2ad80 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20 66   corresponding f
2ad90 75 6e 63 74 69 6f 6e 20 70 61 72 61 6d 65 74 65  unction paramete
2ada0 72 20 63 68 61 6e 67 65 73 0a 2a 2a 20 6f 72 20  r changes.** or 
2adb0 77 68 65 6e 20 74 68 65 20 53 51 4c 20 73 74 61  when the SQL sta
2adc0 74 65 6d 65 6e 74 20 63 6f 6d 70 6c 65 74 65 73  tement completes
2add0 2c 20 77 68 69 63 68 65 76 65 72 20 63 6f 6d 65  , whichever come
2ade0 73 20 66 69 72 73 74 2e 0a 2a 2a 0a 2a 2a 20 53  s first..**.** S
2adf0 51 4c 69 74 65 20 69 73 20 66 72 65 65 20 74 6f  QLite is free to
2ae00 20 63 61 6c 6c 20 74 68 65 20 64 65 73 74 72 75   call the destru
2ae10 63 74 6f 72 20 61 6e 64 20 64 72 6f 70 20 6d 65  ctor and drop me
2ae20 74 61 64 61 74 61 20 6f 6e 20 61 6e 79 0a 2a 2a  tadata on any.**
2ae30 20 70 61 72 61 6d 65 74 65 72 20 6f 66 20 61 6e   parameter of an
2ae40 79 20 66 75 6e 63 74 69 6f 6e 20 61 74 20 61 6e  y function at an
2ae50 79 20 74 69 6d 65 2e 20 20 5e 54 68 65 20 6f 6e  y time.  ^The on
2ae60 6c 79 20 67 75 61 72 61 6e 74 65 65 20 69 73 20  ly guarantee is 
2ae70 74 68 61 74 0a 2a 2a 20 74 68 65 20 64 65 73 74  that.** the dest
2ae80 72 75 63 74 6f 72 20 77 69 6c 6c 20 62 65 20 63  ructor will be c
2ae90 61 6c 6c 65 64 20 62 65 66 6f 72 65 20 74 68 65  alled before the
2aea0 20 6d 65 74 61 64 61 74 61 20 69 73 20 64 72 6f   metadata is dro
2aeb0 70 70 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 28 49 6e  pped..**.** ^(In
2aec0 20 70 72 61 63 74 69 63 65 2c 20 6d 65 74 61 64   practice, metad
2aed0 61 74 61 20 69 73 20 70 72 65 73 65 72 76 65 64  ata is preserved
2aee0 20 62 65 74 77 65 65 6e 20 66 75 6e 63 74 69 6f   between functio
2aef0 6e 20 63 61 6c 6c 73 20 66 6f 72 0a 2a 2a 20 65  n calls for.** e
2af00 78 70 72 65 73 73 69 6f 6e 73 20 74 68 61 74 20  xpressions that 
2af10 61 72 65 20 63 6f 6e 73 74 61 6e 74 20 61 74 20  are constant at 
2af20 63 6f 6d 70 69 6c 65 20 74 69 6d 65 2e 20 54 68  compile time. Th
2af30 69 73 20 69 6e 63 6c 75 64 65 73 20 6c 69 74 65  is includes lite
2af40 72 61 6c 0a 2a 2a 20 76 61 6c 75 65 73 20 61 6e  ral.** values an
2af50 64 20 5b 70 61 72 61 6d 65 74 65 72 73 5d 2e 29  d [parameters].)
2af60 5e 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72 6f  ^.**.** These ro
2af70 75 74 69 6e 65 73 20 6d 75 73 74 20 62 65 20 63  utines must be c
2af80 61 6c 6c 65 64 20 66 72 6f 6d 20 74 68 65 20 73  alled from the s
2af90 61 6d 65 20 74 68 72 65 61 64 20 69 6e 20 77 68  ame thread in wh
2afa0 69 63 68 0a 2a 2a 20 74 68 65 20 53 51 4c 20 66  ich.** the SQL f
2afb0 75 6e 63 74 69 6f 6e 20 69 73 20 72 75 6e 6e 69  unction is runni
2afc0 6e 67 2e 0a 2a 2f 0a 76 6f 69 64 20 2a 73 71 6c  ng..*/.void *sql
2afd0 69 74 65 33 5f 67 65 74 5f 61 75 78 64 61 74 61  ite3_get_auxdata
2afe0 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74  (sqlite3_context
2aff0 2a 2c 20 69 6e 74 20 4e 29 3b 0a 76 6f 69 64 20  *, int N);.void 
2b000 73 71 6c 69 74 65 33 5f 73 65 74 5f 61 75 78 64  sqlite3_set_auxd
2b010 61 74 61 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74  ata(sqlite3_cont
2b020 65 78 74 2a 2c 20 69 6e 74 20 4e 2c 20 76 6f 69  ext*, int N, voi
2b030 64 2a 2c 20 76 6f 69 64 20 28 2a 29 28 76 6f 69  d*, void (*)(voi
2b040 64 2a 29 29 3b 0a 0a 0a 2f 2a 0a 2a 2a 20 43 41  d*));.../*.** CA
2b050 50 49 33 52 45 46 3a 20 43 6f 6e 73 74 61 6e 74  PI3REF: Constant
2b060 73 20 44 65 66 69 6e 69 6e 67 20 53 70 65 63 69  s Defining Speci
2b070 61 6c 20 44 65 73 74 72 75 63 74 6f 72 20 42 65  al Destructor Be
2b080 68 61 76 69 6f 72 0a 2a 2a 0a 2a 2a 20 54 68 65  havior.**.** The
2b090 73 65 20 61 72 65 20 73 70 65 63 69 61 6c 20 76  se are special v
2b0a0 61 6c 75 65 73 20 66 6f 72 20 74 68 65 20 64 65  alues for the de
2b0b0 73 74 72 75 63 74 6f 72 20 74 68 61 74 20 69 73  structor that is
2b0c0 20 70 61 73 73 65 64 20 69 6e 20 61 73 20 74 68   passed in as th
2b0d0 65 0a 2a 2a 20 66 69 6e 61 6c 20 61 72 67 75 6d  e.** final argum
2b0e0 65 6e 74 20 74 6f 20 72 6f 75 74 69 6e 65 73 20  ent to routines 
2b0f0 6c 69 6b 65 20 5b 73 71 6c 69 74 65 33 5f 72 65  like [sqlite3_re
2b100 73 75 6c 74 5f 62 6c 6f 62 28 29 5d 2e 20 20 5e  sult_blob()].  ^
2b110 49 66 20 74 68 65 20 64 65 73 74 72 75 63 74 6f  If the destructo
2b120 72 0a 2a 2a 20 61 72 67 75 6d 65 6e 74 20 69 73  r.** argument is
2b130 20 53 51 4c 49 54 45 5f 53 54 41 54 49 43 2c 20   SQLITE_STATIC, 
2b140 69 74 20 6d 65 61 6e 73 20 74 68 61 74 20 74 68  it means that th
2b150 65 20 63 6f 6e 74 65 6e 74 20 70 6f 69 6e 74 65  e content pointe
2b160 72 20 69 73 20 63 6f 6e 73 74 61 6e 74 0a 2a 2a  r is constant.**
2b170 20 61 6e 64 20 77 69 6c 6c 20 6e 65 76 65 72 20   and will never 
2b180 63 68 61 6e 67 65 2e 20 20 49 74 20 64 6f 65 73  change.  It does
2b190 20 6e 6f 74 20 6e 65 65 64 20 74 6f 20 62 65 20   not need to be 
2b1a0 64 65 73 74 72 6f 79 65 64 2e 20 20 5e 54 68 65  destroyed.  ^The
2b1b0 0a 2a 2a 20 53 51 4c 49 54 45 5f 54 52 41 4e 53  .** SQLITE_TRANS
2b1c0 49 45 4e 54 20 76 61 6c 75 65 20 6d 65 61 6e 73  IENT value means
2b1d0 20 74 68 61 74 20 74 68 65 20 63 6f 6e 74 65 6e   that the conten
2b1e0 74 20 77 69 6c 6c 20 6c 69 6b 65 6c 79 20 63 68  t will likely ch
2b1f0 61 6e 67 65 20 69 6e 0a 2a 2a 20 74 68 65 20 6e  ange in.** the n
2b200 65 61 72 20 66 75 74 75 72 65 20 61 6e 64 20 74  ear future and t
2b210 68 61 74 20 53 51 4c 69 74 65 20 73 68 6f 75 6c  hat SQLite shoul
2b220 64 20 6d 61 6b 65 20 69 74 73 20 6f 77 6e 20 70  d make its own p
2b230 72 69 76 61 74 65 20 63 6f 70 79 20 6f 66 0a 2a  rivate copy of.*
2b240 2a 20 74 68 65 20 63 6f 6e 74 65 6e 74 20 62 65  * the content be
2b250 66 6f 72 65 20 72 65 74 75 72 6e 69 6e 67 2e 0a  fore returning..
2b260 2a 2a 0a 2a 2a 20 54 68 65 20 74 79 70 65 64 65  **.** The typede
2b270 66 20 69 73 20 6e 65 63 65 73 73 61 72 79 20 74  f is necessary t
2b280 6f 20 77 6f 72 6b 20 61 72 6f 75 6e 64 20 70 72  o work around pr
2b290 6f 62 6c 65 6d 73 20 69 6e 20 63 65 72 74 61 69  oblems in certai
2b2a0 6e 0a 2a 2a 20 43 2b 2b 20 63 6f 6d 70 69 6c 65  n.** C++ compile
2b2b0 72 73 2e 20 20 53 65 65 20 74 69 63 6b 65 74 20  rs.  See ticket 
2b2c0 23 32 31 39 31 2e 0a 2a 2f 0a 74 79 70 65 64 65  #2191..*/.typede
2b2d0 66 20 76 6f 69 64 20 28 2a 73 71 6c 69 74 65 33  f void (*sqlite3
2b2e0 5f 64 65 73 74 72 75 63 74 6f 72 5f 74 79 70 65  _destructor_type
2b2f0 29 28 76 6f 69 64 2a 29 3b 0a 23 64 65 66 69 6e  )(void*);.#defin
2b300 65 20 53 51 4c 49 54 45 5f 53 54 41 54 49 43 20  e SQLITE_STATIC 
2b310 20 20 20 20 20 28 28 73 71 6c 69 74 65 33 5f 64       ((sqlite3_d
2b320 65 73 74 72 75 63 74 6f 72 5f 74 79 70 65 29 30  estructor_type)0
2b330 29 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45  ).#define SQLITE
2b340 5f 54 52 41 4e 53 49 45 4e 54 20 20 20 28 28 73  _TRANSIENT   ((s
2b350 71 6c 69 74 65 33 5f 64 65 73 74 72 75 63 74 6f  qlite3_destructo
2b360 72 5f 74 79 70 65 29 2d 31 29 0a 0a 2f 2a 0a 2a  r_type)-1)../*.*
2b370 2a 20 43 41 50 49 33 52 45 46 3a 20 53 65 74 74  * CAPI3REF: Sett
2b380 69 6e 67 20 54 68 65 20 52 65 73 75 6c 74 20 4f  ing The Result O
2b390 66 20 41 6e 20 53 51 4c 20 46 75 6e 63 74 69 6f  f An SQL Functio
2b3a0 6e 0a 2a 2a 0a 2a 2a 20 54 68 65 73 65 20 72 6f  n.**.** These ro
2b3b0 75 74 69 6e 65 73 20 61 72 65 20 75 73 65 64 20  utines are used 
2b3c0 62 79 20 74 68 65 20 78 46 75 6e 63 20 6f 72 20  by the xFunc or 
2b3d0 78 46 69 6e 61 6c 20 63 61 6c 6c 62 61 63 6b 73  xFinal callbacks
2b3e0 20 74 68 61 74 0a 2a 2a 20 69 6d 70 6c 65 6d 65   that.** impleme
2b3f0 6e 74 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 73  nt SQL functions
2b400 20 61 6e 64 20 61 67 67 72 65 67 61 74 65 73 2e   and aggregates.
2b410 20 20 53 65 65 0a 2a 2a 20 5b 73 71 6c 69 74 65    See.** [sqlite
2b420 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f  3_create_functio
2b430 6e 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74 65  n()] and [sqlite
2b440 33 5f 63 72 65 61 74 65 5f 66 75 6e 63 74 69 6f  3_create_functio
2b450 6e 31 36 28 29 5d 0a 2a 2a 20 66 6f 72 20 61 64  n16()].** for ad
2b460 64 69 74 69 6f 6e 61 6c 20 69 6e 66 6f 72 6d 61  ditional informa
2b470 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 73  tion..**.** Thes
2b480 65 20 66 75 6e 63 74 69 6f 6e 73 20 77 6f 72 6b  e functions work
2b490 20 76 65 72 79 20 6d 75 63 68 20 6c 69 6b 65 20   very much like 
2b4a0 74 68 65 20 5b 70 61 72 61 6d 65 74 65 72 20 62  the [parameter b
2b4b0 69 6e 64 69 6e 67 5d 20 66 61 6d 69 6c 79 20 6f  inding] family o
2b4c0 66 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 73 20 75  f.** functions u
2b4d0 73 65 64 20 74 6f 20 62 69 6e 64 20 76 61 6c 75  sed to bind valu
2b4e0 65 73 20 74 6f 20 68 6f 73 74 20 70 61 72 61 6d  es to host param
2b4f0 65 74 65 72 73 20 69 6e 20 70 72 65 70 61 72 65  eters in prepare
2b500 64 20 73 74 61 74 65 6d 65 6e 74 73 2e 0a 2a 2a  d statements..**
2b510 20 52 65 66 65 72 20 74 6f 20 74 68 65 20 5b 53   Refer to the [S
2b520 51 4c 20 70 61 72 61 6d 65 74 65 72 5d 20 64 6f  QL parameter] do
2b530 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 6f 72 20  cumentation for 
2b540 61 64 64 69 74 69 6f 6e 61 6c 20 69 6e 66 6f 72  additional infor
2b550 6d 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 54  mation..**.** ^T
2b560 68 65 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c  he sqlite3_resul
2b570 74 5f 62 6c 6f 62 28 29 20 69 6e 74 65 72 66 61  t_blob() interfa
2b580 63 65 20 73 65 74 73 20 74 68 65 20 72 65 73 75  ce sets the resu
2b590 6c 74 20 66 72 6f 6d 0a 2a 2a 20 61 6e 20 61 70  lt from.** an ap
2b5a0 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65  plication-define
2b5b0 64 20 66 75 6e 63 74 69 6f 6e 20 74 6f 20 62 65  d function to be
2b5c0 20 74 68 65 20 42 4c 4f 42 20 77 68 6f 73 65 20   the BLOB whose 
2b5d0 63 6f 6e 74 65 6e 74 20 69 73 20 70 6f 69 6e 74  content is point
2b5e0 65 64 0a 2a 2a 20 74 6f 20 62 79 20 74 68 65 20  ed.** to by the 
2b5f0 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72  second parameter
2b600 20 61 6e 64 20 77 68 69 63 68 20 69 73 20 4e 20   and which is N 
2b610 62 79 74 65 73 20 6c 6f 6e 67 20 77 68 65 72 65  bytes long where
2b620 20 4e 20 69 73 20 74 68 65 0a 2a 2a 20 74 68 69   N is the.** thi
2b630 72 64 20 70 61 72 61 6d 65 74 65 72 2e 0a 2a 2a  rd parameter..**
2b640 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33  .** ^The sqlite3
2b650 5f 72 65 73 75 6c 74 5f 7a 65 72 6f 62 6c 6f 62  _result_zeroblob
2b660 28 29 20 69 6e 74 65 72 66 61 63 65 73 20 73 65  () interfaces se
2b670 74 20 74 68 65 20 72 65 73 75 6c 74 20 6f 66 0a  t the result of.
2b680 2a 2a 20 74 68 65 20 61 70 70 6c 69 63 61 74 69  ** the applicati
2b690 6f 6e 2d 64 65 66 69 6e 65 64 20 66 75 6e 63 74  on-defined funct
2b6a0 69 6f 6e 20 74 6f 20 62 65 20 61 20 42 4c 4f 42  ion to be a BLOB
2b6b0 20 63 6f 6e 74 61 69 6e 69 6e 67 20 61 6c 6c 20   containing all 
2b6c0 7a 65 72 6f 0a 2a 2a 20 62 79 74 65 73 20 61 6e  zero.** bytes an
2b6d0 64 20 4e 20 62 79 74 65 73 20 69 6e 20 73 69 7a  d N bytes in siz
2b6e0 65 2c 20 77 68 65 72 65 20 4e 20 69 73 20 74 68  e, where N is th
2b6f0 65 20 76 61 6c 75 65 20 6f 66 20 74 68 65 20 32  e value of the 2
2b700 6e 64 20 70 61 72 61 6d 65 74 65 72 2e 0a 2a 2a  nd parameter..**
2b710 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33  .** ^The sqlite3
2b720 5f 72 65 73 75 6c 74 5f 64 6f 75 62 6c 65 28 29  _result_double()
2b730 20 69 6e 74 65 72 66 61 63 65 20 73 65 74 73 20   interface sets 
2b740 74 68 65 20 72 65 73 75 6c 74 20 66 72 6f 6d 0a  the result from.
2b750 2a 2a 20 61 6e 20 61 70 70 6c 69 63 61 74 69 6f  ** an applicatio
2b760 6e 2d 64 65 66 69 6e 65 64 20 66 75 6e 63 74 69  n-defined functi
2b770 6f 6e 20 74 6f 20 62 65 20 61 20 66 6c 6f 61 74  on to be a float
2b780 69 6e 67 20 70 6f 69 6e 74 20 76 61 6c 75 65 20  ing point value 
2b790 73 70 65 63 69 66 69 65 64 0a 2a 2a 20 62 79 20  specified.** by 
2b7a0 69 74 73 20 32 6e 64 20 61 72 67 75 6d 65 6e 74  its 2nd argument
2b7b0 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  ..**.** ^The sql
2b7c0 69 74 65 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f  ite3_result_erro
2b7d0 72 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f  r() and sqlite3_
2b7e0 72 65 73 75 6c 74 5f 65 72 72 6f 72 31 36 28 29  result_error16()
2b7f0 20 66 75 6e 63 74 69 6f 6e 73 0a 2a 2a 20 63 61   functions.** ca
2b800 75 73 65 20 74 68 65 20 69 6d 70 6c 65 6d 65 6e  use the implemen
2b810 74 65 64 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e  ted SQL function
2b820 20 74 6f 20 74 68 72 6f 77 20 61 6e 20 65 78 63   to throw an exc
2b830 65 70 74 69 6f 6e 2e 0a 2a 2a 20 5e 53 51 4c 69  eption..** ^SQLi
2b840 74 65 20 75 73 65 73 20 74 68 65 20 73 74 72 69  te uses the stri
2b850 6e 67 20 70 6f 69 6e 74 65 64 20 74 6f 20 62 79  ng pointed to by
2b860 20 74 68 65 0a 2a 2a 20 32 6e 64 20 70 61 72 61   the.** 2nd para
2b870 6d 65 74 65 72 20 6f 66 20 73 71 6c 69 74 65 33  meter of sqlite3
2b880 5f 72 65 73 75 6c 74 5f 65 72 72 6f 72 28 29 20  _result_error() 
2b890 6f 72 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c  or sqlite3_resul
2b8a0 74 5f 65 72 72 6f 72 31 36 28 29 0a 2a 2a 20 61  t_error16().** a
2b8b0 73 20 74 68 65 20 74 65 78 74 20 6f 66 20 61 6e  s the text of an
2b8c0 20 65 72 72 6f 72 20 6d 65 73 73 61 67 65 2e 20   error message. 
2b8d0 20 5e 53 51 4c 69 74 65 20 69 6e 74 65 72 70 72   ^SQLite interpr
2b8e0 65 74 73 20 74 68 65 20 65 72 72 6f 72 0a 2a 2a  ets the error.**
2b8f0 20 6d 65 73 73 61 67 65 20 73 74 72 69 6e 67 20   message string 
2b900 66 72 6f 6d 20 73 71 6c 69 74 65 33 5f 72 65 73  from sqlite3_res
2b910 75 6c 74 5f 65 72 72 6f 72 28 29 20 61 73 20 55  ult_error() as U
2b920 54 46 2d 38 2e 20 5e 53 51 4c 69 74 65 0a 2a 2a  TF-8. ^SQLite.**
2b930 20 69 6e 74 65 72 70 72 65 74 73 20 74 68 65 20   interprets the 
2b940 73 74 72 69 6e 67 20 66 72 6f 6d 20 73 71 6c 69  string from sqli
2b950 74 65 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f 72  te3_result_error
2b960 31 36 28 29 20 61 73 20 55 54 46 2d 31 36 20 69  16() as UTF-16 i
2b970 6e 20 6e 61 74 69 76 65 0a 2a 2a 20 62 79 74 65  n native.** byte
2b980 20 6f 72 64 65 72 2e 20 20 5e 49 66 20 74 68 65   order.  ^If the
2b990 20 74 68 69 72 64 20 70 61 72 61 6d 65 74 65 72   third parameter
2b9a0 20 74 6f 20 73 71 6c 69 74 65 33 5f 72 65 73 75   to sqlite3_resu
2b9b0 6c 74 5f 65 72 72 6f 72 28 29 0a 2a 2a 20 6f 72  lt_error().** or
2b9c0 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f   sqlite3_result_
2b9d0 65 72 72 6f 72 31 36 28 29 20 69 73 20 6e 65 67  error16() is neg
2b9e0 61 74 69 76 65 20 74 68 65 6e 20 53 51 4c 69 74  ative then SQLit
2b9f0 65 20 74 61 6b 65 73 20 61 73 20 74 68 65 20 65  e takes as the e
2ba00 72 72 6f 72 0a 2a 2a 20 6d 65 73 73 61 67 65 20  rror.** message 
2ba10 61 6c 6c 20 74 65 78 74 20 75 70 20 74 68 72 6f  all text up thro
2ba20 75 67 68 20 74 68 65 20 66 69 72 73 74 20 7a 65  ugh the first ze
2ba30 72 6f 20 63 68 61 72 61 63 74 65 72 2e 0a 2a 2a  ro character..**
2ba40 20 5e 49 66 20 74 68 65 20 74 68 69 72 64 20 70   ^If the third p
2ba50 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69  arameter to sqli
2ba60 74 65 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f 72  te3_result_error
2ba70 28 29 20 6f 72 0a 2a 2a 20 73 71 6c 69 74 65 33  () or.** sqlite3
2ba80 5f 72 65 73 75 6c 74 5f 65 72 72 6f 72 31 36 28  _result_error16(
2ba90 29 20 69 73 20 6e 6f 6e 2d 6e 65 67 61 74 69 76  ) is non-negativ
2baa0 65 20 74 68 65 6e 20 53 51 4c 69 74 65 20 74 61  e then SQLite ta
2bab0 6b 65 73 20 74 68 61 74 20 6d 61 6e 79 0a 2a 2a  kes that many.**
2bac0 20 62 79 74 65 73 20 28 6e 6f 74 20 63 68 61 72   bytes (not char
2bad0 61 63 74 65 72 73 29 20 66 72 6f 6d 20 74 68 65  acters) from the
2bae0 20 32 6e 64 20 70 61 72 61 6d 65 74 65 72 20 61   2nd parameter a
2baf0 73 20 74 68 65 20 65 72 72 6f 72 20 6d 65 73 73  s the error mess
2bb00 61 67 65 2e 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  age..** ^The sql
2bb10 69 74 65 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f  ite3_result_erro
2bb20 72 28 29 20 61 6e 64 20 73 71 6c 69 74 65 33 5f  r() and sqlite3_
2bb30 72 65 73 75 6c 74 5f 65 72 72 6f 72 31 36 28 29  result_error16()
2bb40 0a 2a 2a 20 72 6f 75 74 69 6e 65 73 20 6d 61 6b  .** routines mak
2bb50 65 20 61 20 70 72 69 76 61 74 65 20 63 6f 70 79  e a private copy
2bb60 20 6f 66 20 74 68 65 20 65 72 72 6f 72 20 6d 65   of the error me
2bb70 73 73 61 67 65 20 74 65 78 74 20 62 65 66 6f 72  ssage text befor
2bb80 65 0a 2a 2a 20 74 68 65 79 20 72 65 74 75 72 6e  e.** they return
2bb90 2e 20 20 48 65 6e 63 65 2c 20 74 68 65 20 63 61  .  Hence, the ca
2bba0 6c 6c 69 6e 67 20 66 75 6e 63 74 69 6f 6e 20 63  lling function c
2bbb0 61 6e 20 64 65 61 6c 6c 6f 63 61 74 65 20 6f 72  an deallocate or
2bbc0 0a 2a 2a 20 6d 6f 64 69 66 79 20 74 68 65 20 74  .** modify the t
2bbd0 65 78 74 20 61 66 74 65 72 20 74 68 65 79 20 72  ext after they r
2bbe0 65 74 75 72 6e 20 77 69 74 68 6f 75 74 20 68 61  eturn without ha
2bbf0 72 6d 2e 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69  rm..** ^The sqli
2bc00 74 65 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f 72  te3_result_error
2bc10 5f 63 6f 64 65 28 29 20 66 75 6e 63 74 69 6f 6e  _code() function
2bc20 20 63 68 61 6e 67 65 73 20 74 68 65 20 65 72 72   changes the err
2bc30 6f 72 20 63 6f 64 65 0a 2a 2a 20 72 65 74 75 72  or code.** retur
2bc40 6e 65 64 20 62 79 20 53 51 4c 69 74 65 20 61 73  ned by SQLite as
2bc50 20 61 20 72 65 73 75 6c 74 20 6f 66 20 61 6e 20   a result of an 
2bc60 65 72 72 6f 72 20 69 6e 20 61 20 66 75 6e 63 74  error in a funct
2bc70 69 6f 6e 2e 20 20 5e 42 79 20 64 65 66 61 75 6c  ion.  ^By defaul
2bc80 74 2c 0a 2a 2a 20 74 68 65 20 65 72 72 6f 72 20  t,.** the error 
2bc90 63 6f 64 65 20 69 73 20 53 51 4c 49 54 45 5f 45  code is SQLITE_E
2bca0 52 52 4f 52 2e 20 20 5e 41 20 73 75 62 73 65 71  RROR.  ^A subseq
2bcb0 75 65 6e 74 20 63 61 6c 6c 20 74 6f 20 73 71 6c  uent call to sql
2bcc0 69 74 65 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f  ite3_result_erro
2bcd0 72 28 29 0a 2a 2a 20 6f 72 20 73 71 6c 69 74 65  r().** or sqlite
2bce0 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f 72 31 36  3_result_error16
2bcf0 28 29 20 72 65 73 65 74 73 20 74 68 65 20 65 72  () resets the er
2bd00 72 6f 72 20 63 6f 64 65 20 74 6f 20 53 51 4c 49  ror code to SQLI
2bd10 54 45 5f 45 52 52 4f 52 2e 0a 2a 2a 0a 2a 2a 20  TE_ERROR..**.** 
2bd20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 72 65 73  ^The sqlite3_res
2bd30 75 6c 74 5f 74 6f 6f 62 69 67 28 29 20 69 6e 74  ult_toobig() int
2bd40 65 72 66 61 63 65 20 63 61 75 73 65 73 20 53 51  erface causes SQ
2bd50 4c 69 74 65 20 74 6f 20 74 68 72 6f 77 20 61 6e  Lite to throw an
2bd60 20 65 72 72 6f 72 0a 2a 2a 20 69 6e 64 69 63 61   error.** indica
2bd70 74 69 6e 67 20 74 68 61 74 20 61 20 73 74 72 69  ting that a stri
2bd80 6e 67 20 6f 72 20 42 4c 4f 42 20 69 73 20 74 6f  ng or BLOB is to
2bd90 6f 20 6c 6f 6e 67 20 74 6f 20 72 65 70 72 65 73  o long to repres
2bda0 65 6e 74 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  ent..**.** ^The 
2bdb0 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 6e  sqlite3_result_n
2bdc0 6f 6d 65 6d 28 29 20 69 6e 74 65 72 66 61 63 65  omem() interface
2bdd0 20 63 61 75 73 65 73 20 53 51 4c 69 74 65 20 74   causes SQLite t
2bde0 6f 20 74 68 72 6f 77 20 61 6e 20 65 72 72 6f 72  o throw an error
2bdf0 0a 2a 2a 20 69 6e 64 69 63 61 74 69 6e 67 20 74  .** indicating t
2be00 68 61 74 20 61 20 6d 65 6d 6f 72 79 20 61 6c 6c  hat a memory all
2be10 6f 63 61 74 69 6f 6e 20 66 61 69 6c 65 64 2e 0a  ocation failed..
2be20 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74  **.** ^The sqlit
2be30 65 33 5f 72 65 73 75 6c 74 5f 69 6e 74 28 29 20  e3_result_int() 
2be40 69 6e 74 65 72 66 61 63 65 20 73 65 74 73 20 74  interface sets t
2be50 68 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 0a  he return value.
2be60 2a 2a 20 6f 66 20 74 68 65 20 61 70 70 6c 69 63  ** of the applic
2be70 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 66 75  ation-defined fu
2be80 6e 63 74 69 6f 6e 20 74 6f 20 62 65 20 74 68 65  nction to be the
2be90 20 33 32 2d 62 69 74 20 73 69 67 6e 65 64 20 69   32-bit signed i
2bea0 6e 74 65 67 65 72 0a 2a 2a 20 76 61 6c 75 65 20  nteger.** value 
2beb0 67 69 76 65 6e 20 69 6e 20 74 68 65 20 32 6e 64  given in the 2nd
2bec0 20 61 72 67 75 6d 65 6e 74 2e 0a 2a 2a 20 5e 54   argument..** ^T
2bed0 68 65 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c  he sqlite3_resul
2bee0 74 5f 69 6e 74 36 34 28 29 20 69 6e 74 65 72 66  t_int64() interf
2bef0 61 63 65 20 73 65 74 73 20 74 68 65 20 72 65 74  ace sets the ret
2bf00 75 72 6e 20 76 61 6c 75 65 0a 2a 2a 20 6f 66 20  urn value.** of 
2bf10 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 2d  the application-
2bf20 64 65 66 69 6e 65 64 20 66 75 6e 63 74 69 6f 6e  defined function
2bf30 20 74 6f 20 62 65 20 74 68 65 20 36 34 2d 62 69   to be the 64-bi
2bf40 74 20 73 69 67 6e 65 64 20 69 6e 74 65 67 65 72  t signed integer
2bf50 0a 2a 2a 20 76 61 6c 75 65 20 67 69 76 65 6e 20  .** value given 
2bf60 69 6e 20 74 68 65 20 32 6e 64 20 61 72 67 75 6d  in the 2nd argum
2bf70 65 6e 74 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  ent..**.** ^The 
2bf80 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 6e  sqlite3_result_n
2bf90 75 6c 6c 28 29 20 69 6e 74 65 72 66 61 63 65 20  ull() interface 
2bfa0 73 65 74 73 20 74 68 65 20 72 65 74 75 72 6e 20  sets the return 
2bfb0 76 61 6c 75 65 0a 2a 2a 20 6f 66 20 74 68 65 20  value.** of the 
2bfc0 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69  application-defi
2bfd0 6e 65 64 20 66 75 6e 63 74 69 6f 6e 20 74 6f 20  ned function to 
2bfe0 62 65 20 4e 55 4c 4c 2e 0a 2a 2a 0a 2a 2a 20 5e  be NULL..**.** ^
2bff0 54 68 65 20 73 71 6c 69 74 65 33 5f 72 65 73 75  The sqlite3_resu
2c000 6c 74 5f 74 65 78 74 28 29 2c 20 73 71 6c 69 74  lt_text(), sqlit
2c010 65 33 5f 72 65 73 75 6c 74 5f 74 65 78 74 31 36  e3_result_text16
2c020 28 29 2c 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 72  (),.** sqlite3_r
2c030 65 73 75 6c 74 5f 74 65 78 74 31 36 6c 65 28 29  esult_text16le()
2c040 2c 20 61 6e 64 20 73 71 6c 69 74 65 33 5f 72 65  , and sqlite3_re
2c050 73 75 6c 74 5f 74 65 78 74 31 36 62 65 28 29 20  sult_text16be() 
2c060 69 6e 74 65 72 66 61 63 65 73 0a 2a 2a 20 73 65  interfaces.** se
2c070 74 20 74 68 65 20 72 65 74 75 72 6e 20 76 61 6c  t the return val
2c080 75 65 20 6f 66 20 74 68 65 20 61 70 70 6c 69 63  ue of the applic
2c090 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 66 75  ation-defined fu
2c0a0 6e 63 74 69 6f 6e 20 74 6f 20 62 65 0a 2a 2a 20  nction to be.** 
2c0b0 61 20 74 65 78 74 20 73 74 72 69 6e 67 20 77 68  a text string wh
2c0c0 69 63 68 20 69 73 20 72 65 70 72 65 73 65 6e 74  ich is represent
2c0d0 65 64 20 61 73 20 55 54 46 2d 38 2c 20 55 54 46  ed as UTF-8, UTF
2c0e0 2d 31 36 20 6e 61 74 69 76 65 20 62 79 74 65 20  -16 native byte 
2c0f0 6f 72 64 65 72 2c 0a 2a 2a 20 55 54 46 2d 31 36  order,.** UTF-16
2c100 20 6c 69 74 74 6c 65 20 65 6e 64 69 61 6e 2c 20   little endian, 
2c110 6f 72 20 55 54 46 2d 31 36 20 62 69 67 20 65 6e  or UTF-16 big en
2c120 64 69 61 6e 2c 20 72 65 73 70 65 63 74 69 76 65  dian, respective
2c130 6c 79 2e 0a 2a 2a 20 5e 53 51 4c 69 74 65 20 74  ly..** ^SQLite t
2c140 61 6b 65 73 20 74 68 65 20 74 65 78 74 20 72 65  akes the text re
2c150 73 75 6c 74 20 66 72 6f 6d 20 74 68 65 20 61 70  sult from the ap
2c160 70 6c 69 63 61 74 69 6f 6e 20 66 72 6f 6d 0a 2a  plication from.*
2c170 2a 20 74 68 65 20 32 6e 64 20 70 61 72 61 6d 65  * the 2nd parame
2c180 74 65 72 20 6f 66 20 74 68 65 20 73 71 6c 69 74  ter of the sqlit
2c190 65 33 5f 72 65 73 75 6c 74 5f 74 65 78 74 2a 20  e3_result_text* 
2c1a0 69 6e 74 65 72 66 61 63 65 73 2e 0a 2a 2a 20 5e  interfaces..** ^
2c1b0 49 66 20 74 68 65 20 33 72 64 20 70 61 72 61 6d  If the 3rd param
2c1c0 65 74 65 72 20 74 6f 20 74 68 65 20 73 71 6c 69  eter to the sqli
2c1d0 74 65 33 5f 72 65 73 75 6c 74 5f 74 65 78 74 2a  te3_result_text*
2c1e0 20 69 6e 74 65 72 66 61 63 65 73 0a 2a 2a 20 69   interfaces.** i
2c1f0 73 20 6e 65 67 61 74 69 76 65 2c 20 74 68 65 6e  s negative, then
2c200 20 53 51 4c 69 74 65 20 74 61 6b 65 73 20 72 65   SQLite takes re
2c210 73 75 6c 74 20 74 65 78 74 20 66 72 6f 6d 20 74  sult text from t
2c220 68 65 20 32 6e 64 20 70 61 72 61 6d 65 74 65 72  he 2nd parameter
2c230 0a 2a 2a 20 74 68 72 6f 75 67 68 20 74 68 65 20  .** through the 
2c240 66 69 72 73 74 20 7a 65 72 6f 20 63 68 61 72 61  first zero chara
2c250 63 74 65 72 2e 0a 2a 2a 20 5e 49 66 20 74 68 65  cter..** ^If the
2c260 20 33 72 64 20 70 61 72 61 6d 65 74 65 72 20 74   3rd parameter t
2c270 6f 20 74 68 65 20 73 71 6c 69 74 65 33 5f 72 65  o the sqlite3_re
2c280 73 75 6c 74 5f 74 65 78 74 2a 20 69 6e 74 65 72  sult_text* inter
2c290 66 61 63 65 73 0a 2a 2a 20 69 73 20 6e 6f 6e 2d  faces.** is non-
2c2a0 6e 65 67 61 74 69 76 65 2c 20 74 68 65 6e 20 61  negative, then a
2c2b0 73 20 6d 61 6e 79 20 62 79 74 65 73 20 28 6e 6f  s many bytes (no
2c2c0 74 20 63 68 61 72 61 63 74 65 72 73 29 20 6f 66  t characters) of
2c2d0 20 74 68 65 20 74 65 78 74 0a 2a 2a 20 70 6f 69   the text.** poi
2c2e0 6e 74 65 64 20 74 6f 20 62 79 20 74 68 65 20 32  nted to by the 2
2c2f0 6e 64 20 70 61 72 61 6d 65 74 65 72 20 61 72 65  nd parameter are
2c300 20 74 61 6b 65 6e 20 61 73 20 74 68 65 20 61 70   taken as the ap
2c310 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65  plication-define
2c320 64 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e 20 72 65  d.** function re
2c330 73 75 6c 74 2e 0a 2a 2a 20 5e 49 66 20 74 68 65  sult..** ^If the
2c340 20 34 74 68 20 70 61 72 61 6d 65 74 65 72 20 74   4th parameter t
2c350 6f 20 74 68 65 20 73 71 6c 69 74 65 33 5f 72 65  o the sqlite3_re
2c360 73 75 6c 74 5f 74 65 78 74 2a 20 69 6e 74 65 72  sult_text* inter
2c370 66 61 63 65 73 0a 2a 2a 20 6f 72 20 73 71 6c 69  faces.** or sqli
2c380 74 65 33 5f 72 65 73 75 6c 74 5f 62 6c 6f 62 20  te3_result_blob 
2c390 69 73 20 61 20 6e 6f 6e 2d 4e 55 4c 4c 20 70 6f  is a non-NULL po
2c3a0 69 6e 74 65 72 2c 20 74 68 65 6e 20 53 51 4c 69  inter, then SQLi
2c3b0 74 65 20 63 61 6c 6c 73 20 74 68 61 74 0a 2a 2a  te calls that.**
2c3c0 20 66 75 6e 63 74 69 6f 6e 20 61 73 20 74 68 65   function as the
2c3d0 20 64 65 73 74 72 75 63 74 6f 72 20 6f 6e 20 74   destructor on t
2c3e0 68 65 20 74 65 78 74 20 6f 72 20 42 4c 4f 42 20  he text or BLOB 
2c3f0 72 65 73 75 6c 74 20 77 68 65 6e 20 69 74 20 68  result when it h
2c400 61 73 0a 2a 2a 20 66 69 6e 69 73 68 65 64 20 75  as.** finished u
2c410 73 69 6e 67 20 74 68 61 74 20 72 65 73 75 6c 74  sing that result
2c420 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 34 74 68  ..** ^If the 4th
2c430 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 74 68   parameter to th
2c440 65 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74  e sqlite3_result
2c450 5f 74 65 78 74 2a 20 69 6e 74 65 72 66 61 63 65  _text* interface
2c460 73 20 6f 72 20 74 6f 0a 2a 2a 20 73 71 6c 69 74  s or to.** sqlit
2c470 65 33 5f 72 65 73 75 6c 74 5f 62 6c 6f 62 20 69  e3_result_blob i
2c480 73 20 74 68 65 20 73 70 65 63 69 61 6c 20 63 6f  s the special co
2c490 6e 73 74 61 6e 74 20 53 51 4c 49 54 45 5f 53 54  nstant SQLITE_ST
2c4a0 41 54 49 43 2c 20 74 68 65 6e 20 53 51 4c 69 74  ATIC, then SQLit
2c4b0 65 0a 2a 2a 20 61 73 73 75 6d 65 73 20 74 68 61  e.** assumes tha
2c4c0 74 20 74 68 65 20 74 65 78 74 20 6f 72 20 42 4c  t the text or BL
2c4d0 4f 42 20 72 65 73 75 6c 74 20 69 73 20 69 6e 20  OB result is in 
2c4e0 63 6f 6e 73 74 61 6e 74 20 73 70 61 63 65 20 61  constant space a
2c4f0 6e 64 20 64 6f 65 73 20 6e 6f 74 0a 2a 2a 20 63  nd does not.** c
2c500 6f 70 79 20 74 68 65 20 63 6f 6e 74 65 6e 74 20  opy the content 
2c510 6f 66 20 74 68 65 20 70 61 72 61 6d 65 74 65 72  of the parameter
2c520 20 6e 6f 72 20 63 61 6c 6c 20 61 20 64 65 73 74   nor call a dest
2c530 72 75 63 74 6f 72 20 6f 6e 20 74 68 65 20 63 6f  ructor on the co
2c540 6e 74 65 6e 74 0a 2a 2a 20 77 68 65 6e 20 69 74  ntent.** when it
2c550 20 68 61 73 20 66 69 6e 69 73 68 65 64 20 75 73   has finished us
2c560 69 6e 67 20 74 68 61 74 20 72 65 73 75 6c 74 2e  ing that result.
2c570 0a 2a 2a 20 5e 49 66 20 74 68 65 20 34 74 68 20  .** ^If the 4th 
2c580 70 61 72 61 6d 65 74 65 72 20 74 6f 20 74 68 65  parameter to the
2c590 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f   sqlite3_result_
2c5a0 74 65 78 74 2a 20 69 6e 74 65 72 66 61 63 65 73  text* interfaces
2c5b0 0a 2a 2a 20 6f 72 20 73 71 6c 69 74 65 33 5f 72  .** or sqlite3_r
2c5c0 65 73 75 6c 74 5f 62 6c 6f 62 20 69 73 20 74 68  esult_blob is th
2c5d0 65 20 73 70 65 63 69 61 6c 20 63 6f 6e 73 74 61  e special consta
2c5e0 6e 74 20 53 51 4c 49 54 45 5f 54 52 41 4e 53 49  nt SQLITE_TRANSI
2c5f0 45 4e 54 0a 2a 2a 20 74 68 65 6e 20 53 51 4c 69  ENT.** then SQLi
2c600 74 65 20 6d 61 6b 65 73 20 61 20 63 6f 70 79 20  te makes a copy 
2c610 6f 66 20 74 68 65 20 72 65 73 75 6c 74 20 69 6e  of the result in
2c620 74 6f 20 73 70 61 63 65 20 6f 62 74 61 69 6e 65  to space obtaine
2c630 64 20 66 72 6f 6d 0a 2a 2a 20 66 72 6f 6d 20 5b  d from.** from [
2c640 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 28 29  sqlite3_malloc()
2c650 5d 20 62 65 66 6f 72 65 20 69 74 20 72 65 74 75  ] before it retu
2c660 72 6e 73 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20  rns..**.** ^The 
2c670 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 76  sqlite3_result_v
2c680 61 6c 75 65 28 29 20 69 6e 74 65 72 66 61 63 65  alue() interface
2c690 20 73 65 74 73 20 74 68 65 20 72 65 73 75 6c 74   sets the result
2c6a0 20 6f 66 0a 2a 2a 20 74 68 65 20 61 70 70 6c 69   of.** the appli
2c6b0 63 61 74 69 6f 6e 2d 64 65 66 69 6e 65 64 20 66  cation-defined f
2c6c0 75 6e 63 74 69 6f 6e 20 74 6f 20 62 65 20 61 20  unction to be a 
2c6d0 63 6f 70 79 20 74 68 65 0a 2a 2a 20 5b 75 6e 70  copy the.** [unp
2c6e0 72 6f 74 65 63 74 65 64 20 73 71 6c 69 74 65 33  rotected sqlite3
2c6f0 5f 76 61 6c 75 65 5d 20 6f 62 6a 65 63 74 20 73  _value] object s
2c700 70 65 63 69 66 69 65 64 20 62 79 20 74 68 65 20  pecified by the 
2c710 32 6e 64 20 70 61 72 61 6d 65 74 65 72 2e 20 20  2nd parameter.  
2c720 5e 54 68 65 0a 2a 2a 20 73 71 6c 69 74 65 33 5f  ^The.** sqlite3_
2c730 72 65 73 75 6c 74 5f 76 61 6c 75 65 28 29 20 69  result_value() i
2c740 6e 74 65 72 66 61 63 65 20 6d 61 6b 65 73 20 61  nterface makes a
2c750 20 63 6f 70 79 20 6f 66 20 74 68 65 20 5b 73 71   copy of the [sq
2c760 6c 69 74 65 33 5f 76 61 6c 75 65 5d 0a 2a 2a 20  lite3_value].** 
2c770 73 6f 20 74 68 61 74 20 74 68 65 20 5b 73 71 6c  so that the [sql
2c780 69 74 65 33 5f 76 61 6c 75 65 5d 20 73 70 65 63  ite3_value] spec
2c790 69 66 69 65 64 20 69 6e 20 74 68 65 20 70 61 72  ified in the par
2c7a0 61 6d 65 74 65 72 20 6d 61 79 20 63 68 61 6e 67  ameter may chang
2c7b0 65 20 6f 72 0a 2a 2a 20 62 65 20 64 65 61 6c 6c  e or.** be deall
2c7c0 6f 63 61 74 65 64 20 61 66 74 65 72 20 73 71 6c  ocated after sql
2c7d0 69 74 65 33 5f 72 65 73 75 6c 74 5f 76 61 6c 75  ite3_result_valu
2c7e0 65 28 29 20 72 65 74 75 72 6e 73 20 77 69 74 68  e() returns with
2c7f0 6f 75 74 20 68 61 72 6d 2e 0a 2a 2a 20 5e 41 20  out harm..** ^A 
2c800 5b 70 72 6f 74 65 63 74 65 64 20 73 71 6c 69 74  [protected sqlit
2c810 65 33 5f 76 61 6c 75 65 5d 20 6f 62 6a 65 63 74  e3_value] object
2c820 20 6d 61 79 20 61 6c 77 61 79 73 20 62 65 20 75   may always be u
2c830 73 65 64 20 77 68 65 72 65 20 61 6e 0a 2a 2a 20  sed where an.** 
2c840 5b 75 6e 70 72 6f 74 65 63 74 65 64 20 73 71 6c  [unprotected sql
2c850 69 74 65 33 5f 76 61 6c 75 65 5d 20 6f 62 6a 65  ite3_value] obje
2c860 63 74 20 69 73 20 72 65 71 75 69 72 65 64 2c 20  ct is required, 
2c870 73 6f 20 65 69 74 68 65 72 0a 2a 2a 20 6b 69 6e  so either.** kin
2c880 64 20 6f 66 20 5b 73 71 6c 69 74 65 33 5f 76 61  d of [sqlite3_va
2c890 6c 75 65 5d 20 6f 62 6a 65 63 74 20 63 61 6e 20  lue] object can 
2c8a0 62 65 20 75 73 65 64 20 77 69 74 68 20 74 68 69  be used with thi
2c8b0 73 20 69 6e 74 65 72 66 61 63 65 2e 0a 2a 2a 0a  s interface..**.
2c8c0 2a 2a 20 49 66 20 74 68 65 73 65 20 72 6f 75 74  ** If these rout
2c8d0 69 6e 65 73 20 61 72 65 20 63 61 6c 6c 65 64 20  ines are called 
2c8e0 66 72 6f 6d 20 77 69 74 68 69 6e 20 74 68 65 20  from within the 
2c8f0 64 69 66 66 65 72 65 6e 74 20 74 68 72 65 61 64  different thread
2c900 0a 2a 2a 20 74 68 61 6e 20 74 68 65 20 6f 6e 65  .** than the one
2c910 20 63 6f 6e 74 61 69 6e 69 6e 67 20 74 68 65 20   containing the 
2c920 61 70 70 6c 69 63 61 74 69 6f 6e 2d 64 65 66 69  application-defi
2c930 6e 65 64 20 66 75 6e 63 74 69 6f 6e 20 74 68 61  ned function tha
2c940 74 20 72 65 63 65 69 76 65 64 0a 2a 2a 20 74 68  t received.** th
2c950 65 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65  e [sqlite3_conte
2c960 78 74 5d 20 70 6f 69 6e 74 65 72 2c 20 74 68 65  xt] pointer, the
2c970 20 72 65 73 75 6c 74 73 20 61 72 65 20 75 6e 64   results are und
2c980 65 66 69 6e 65 64 2e 0a 2a 2f 0a 76 6f 69 64 20  efined..*/.void 
2c990 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 62  sqlite3_result_b
2c9a0 6c 6f 62 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74  lob(sqlite3_cont
2c9b0 65 78 74 2a 2c 20 63 6f 6e 73 74 20 76 6f 69 64  ext*, const void
2c9c0 2a 2c 20 69 6e 74 2c 20 76 6f 69 64 28 2a 29 28  *, int, void(*)(
2c9d0 76 6f 69 64 2a 29 29 3b 0a 76 6f 69 64 20 73 71  void*));.void sq
2c9e0 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 64 6f 75  lite3_result_dou
2c9f0 62 6c 65 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74  ble(sqlite3_cont
2ca00 65 78 74 2a 2c 20 64 6f 75 62 6c 65 29 3b 0a 76  ext*, double);.v
2ca10 6f 69 64 20 73 71 6c 69 74 65 33 5f 72 65 73 75  oid sqlite3_resu
2ca20 6c 74 5f 65 72 72 6f 72 28 73 71 6c 69 74 65 33  lt_error(sqlite3
2ca30 5f 63 6f 6e 74 65 78 74 2a 2c 20 63 6f 6e 73 74  _context*, const
2ca40 20 63 68 61 72 2a 2c 20 69 6e 74 29 3b 0a 76 6f   char*, int);.vo
2ca50 69 64 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c  id sqlite3_resul
2ca60 74 5f 65 72 72 6f 72 31 36 28 73 71 6c 69 74 65  t_error16(sqlite
2ca70 33 5f 63 6f 6e 74 65 78 74 2a 2c 20 63 6f 6e 73  3_context*, cons
2ca80 74 20 76 6f 69 64 2a 2c 20 69 6e 74 29 3b 0a 76  t void*, int);.v
2ca90 6f 69 64 20 73 71 6c 69 74 65 33 5f 72 65 73 75  oid sqlite3_resu
2caa0 6c 74 5f 65 72 72 6f 72 5f 74 6f 6f 62 69 67 28  lt_error_toobig(
2cab0 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a  sqlite3_context*
2cac0 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 5f  );.void sqlite3_
2cad0 72 65 73 75 6c 74 5f 65 72 72 6f 72 5f 6e 6f 6d  result_error_nom
2cae0 65 6d 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65  em(sqlite3_conte
2caf0 78 74 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74  xt*);.void sqlit
2cb00 65 33 5f 72 65 73 75 6c 74 5f 65 72 72 6f 72 5f  e3_result_error_
2cb10 63 6f 64 65 28 73 71 6c 69 74 65 33 5f 63 6f 6e  code(sqlite3_con
2cb20 74 65 78 74 2a 2c 20 69 6e 74 29 3b 0a 76 6f 69  text*, int);.voi
2cb30 64 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74  d sqlite3_result
2cb40 5f 69 6e 74 28 73 71 6c 69 74 65 33 5f 63 6f 6e  _int(sqlite3_con
2cb50 74 65 78 74 2a 2c 20 69 6e 74 29 3b 0a 76 6f 69  text*, int);.voi
2cb60 64 20 73 71 6c 69 74 65 33 5f 72 65 73 75 6c 74  d sqlite3_result
2cb70 5f 69 6e 74 36 34 28 73 71 6c 69 74 65 33 5f 63  _int64(sqlite3_c
2cb80 6f 6e 74 65 78 74 2a 2c 20 73 71 6c 69 74 65 33  ontext*, sqlite3
2cb90 5f 69 6e 74 36 34 29 3b 0a 76 6f 69 64 20 73 71  _int64);.void sq
2cba0 6c 69 74 65 33 5f 72 65 73 75 6c 74 5f 6e 75 6c  lite3_result_nul
2cbb0 6c 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78  l(sqlite3_contex
2cbc0 74 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65  t*);.void sqlite
2cbd0 33 5f 72 65 73 75 6c 74 5f 74 65 78 74 28 73 71  3_result_text(sq
2cbe0 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 2c 20  lite3_context*, 
2cbf0 63 6f 6e 73 74 20 63 68 61 72 2a 2c 20 69 6e 74  const char*, int
2cc00 2c 20 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a 29  , void(*)(void*)
2cc10 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 5f  );.void sqlite3_
2cc20 72 65 73 75 6c 74 5f 74 65 78 74 31 36 28 73 71  result_text16(sq
2cc30 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 2c 20  lite3_context*, 
2cc40 63 6f 6e 73 74 20 76 6f 69 64 2a 2c 20 69 6e 74  const void*, int
2cc50 2c 20 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a 29  , void(*)(void*)
2cc60 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 5f  );.void sqlite3_
2cc70 72 65 73 75 6c 74 5f 74 65 78 74 31 36 6c 65 28  result_text16le(
2cc80 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a  sqlite3_context*
2cc90 2c 20 63 6f 6e 73 74 20 76 6f 69 64 2a 2c 20 69  , const void*, i
2cca0 6e 74 2c 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a  nt,void(*)(void*
2ccb0 29 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33  ));.void sqlite3
2ccc0 5f 72 65 73 75 6c 74 5f 74 65 78 74 31 36 62 65  _result_text16be
2ccd0 28 73 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74  (sqlite3_context
2cce0 2a 2c 20 63 6f 6e 73 74 20 76 6f 69 64 2a 2c 20  *, const void*, 
2ccf0 69 6e 74 2c 76 6f 69 64 28 2a 29 28 76 6f 69 64  int,void(*)(void
2cd00 2a 29 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65  *));.void sqlite
2cd10 33 5f 72 65 73 75 6c 74 5f 76 61 6c 75 65 28 73  3_result_value(s
2cd20 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 2c  qlite3_context*,
2cd30 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 2a 29   sqlite3_value*)
2cd40 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 5f 72  ;.void sqlite3_r
2cd50 65 73 75 6c 74 5f 7a 65 72 6f 62 6c 6f 62 28 73  esult_zeroblob(s
2cd60 71 6c 69 74 65 33 5f 63 6f 6e 74 65 78 74 2a 2c  qlite3_context*,
2cd70 20 69 6e 74 20 6e 29 3b 0a 0a 2f 2a 0a 2a 2a 20   int n);../*.** 
2cd80 43 41 50 49 33 52 45 46 3a 20 44 65 66 69 6e 65  CAPI3REF: Define
2cd90 20 4e 65 77 20 43 6f 6c 6c 61 74 69 6e 67 20 53   New Collating S
2cda0 65 71 75 65 6e 63 65 73 0a 2a 2a 0a 2a 2a 20 5e  equences.**.** ^
2cdb0 54 68 65 73 65 20 66 75 6e 63 74 69 6f 6e 73 20  These functions 
2cdc0 61 64 64 2c 20 72 65 6d 6f 76 65 2c 20 6f 72 20  add, remove, or 
2cdd0 6d 6f 64 69 66 79 20 61 20 5b 63 6f 6c 6c 61 74  modify a [collat
2cde0 69 6f 6e 5d 20 61 73 73 6f 63 69 61 74 65 64 0a  ion] associated.
2cdf0 2a 2a 20 77 69 74 68 20 74 68 65 20 5b 64 61 74  ** with the [dat
2ce00 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
2ce10 5d 20 73 70 65 63 69 66 69 65 64 20 61 73 20 74  ] specified as t
2ce20 68 65 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e  he first argumen
2ce30 74 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 6e 61  t..**.** ^The na
2ce40 6d 65 20 6f 66 20 74 68 65 20 63 6f 6c 6c 61 74  me of the collat
2ce50 69 6f 6e 20 69 73 20 61 20 55 54 46 2d 38 20 73  ion is a UTF-8 s
2ce60 74 72 69 6e 67 0a 2a 2a 20 66 6f 72 20 73 71 6c  tring.** for sql
2ce70 69 74 65 33 5f 63 72 65 61 74 65 5f 63 6f 6c 6c  ite3_create_coll
2ce80 61 74 69 6f 6e 28 29 20 61 6e 64 20 73 71 6c 69  ation() and sqli
2ce90 74 65 33 5f 63 72 65 61 74 65 5f 63 6f 6c 6c 61  te3_create_colla
2cea0 74 69 6f 6e 5f 76 32 28 29 0a 2a 2a 20 61 6e 64  tion_v2().** and
2ceb0 20 61 20 55 54 46 2d 31 36 20 73 74 72 69 6e 67   a UTF-16 string
2cec0 20 69 6e 20 6e 61 74 69 76 65 20 62 79 74 65 20   in native byte 
2ced0 6f 72 64 65 72 20 66 6f 72 20 73 71 6c 69 74 65  order for sqlite
2cee0 33 5f 63 72 65 61 74 65 5f 63 6f 6c 6c 61 74 69  3_create_collati
2cef0 6f 6e 31 36 28 29 2e 0a 2a 2a 20 5e 43 6f 6c 6c  on16()..** ^Coll
2cf00 61 74 69 6f 6e 20 6e 61 6d 65 73 20 74 68 61 74  ation names that
2cf10 20 63 6f 6d 70 61 72 65 20 65 71 75 61 6c 20 61   compare equal a
2cf20 63 63 6f 72 64 69 6e 67 20 74 6f 20 5b 73 71 6c  ccording to [sql
2cf30 69 74 65 33 5f 73 74 72 6e 69 63 6d 70 28 29 5d  ite3_strnicmp()]
2cf40 20 61 72 65 0a 2a 2a 20 63 6f 6e 73 69 64 65 72   are.** consider
2cf50 65 64 20 74 6f 20 62 65 20 74 68 65 20 73 61 6d  ed to be the sam
2cf60 65 20 6e 61 6d 65 2e 0a 2a 2a 0a 2a 2a 20 5e 28  e name..**.** ^(
2cf70 54 68 65 20 74 68 69 72 64 20 61 72 67 75 6d 65  The third argume
2cf80 6e 74 20 28 65 54 65 78 74 52 65 70 29 20 6d 75  nt (eTextRep) mu
2cf90 73 74 20 62 65 20 6f 6e 65 20 6f 66 20 74 68 65  st be one of the
2cfa0 20 63 6f 6e 73 74 61 6e 74 73 3a 0a 2a 2a 20 3c   constants:.** <
2cfb0 75 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51 4c  ul>.** <li> [SQL
2cfc0 49 54 45 5f 55 54 46 38 5d 2c 0a 2a 2a 20 3c 6c  ITE_UTF8],.** <l
2cfd0 69 3e 20 5b 53 51 4c 49 54 45 5f 55 54 46 31 36  i> [SQLITE_UTF16
2cfe0 4c 45 5d 2c 0a 2a 2a 20 3c 6c 69 3e 20 5b 53 51  LE],.** <li> [SQ
2cff0 4c 49 54 45 5f 55 54 46 31 36 42 45 5d 2c 0a 2a  LITE_UTF16BE],.*
2d000 2a 20 3c 6c 69 3e 20 5b 53 51 4c 49 54 45 5f 55  * <li> [SQLITE_U
2d010 54 46 31 36 5d 2c 20 6f 72 0a 2a 2a 20 3c 6c 69  TF16], or.** <li
2d020 3e 20 5b 53 51 4c 49 54 45 5f 55 54 46 31 36 5f  > [SQLITE_UTF16_
2d030 41 4c 49 47 4e 45 44 5d 2e 0a 2a 2a 20 3c 2f 75  ALIGNED]..** </u
2d040 6c 3e 29 5e 0a 2a 2a 20 5e 54 68 65 20 65 54 65  l>)^.** ^The eTe
2d050 78 74 52 65 70 20 61 72 67 75 6d 65 6e 74 20 64  xtRep argument d
2d060 65 74 65 72 6d 69 6e 65 73 20 74 68 65 20 65 6e  etermines the en
2d070 63 6f 64 69 6e 67 20 6f 66 20 73 74 72 69 6e 67  coding of string
2d080 73 20 70 61 73 73 65 64 0a 2a 2a 20 74 6f 20 74  s passed.** to t
2d090 68 65 20 63 6f 6c 6c 61 74 69 6e 67 20 66 75 6e  he collating fun
2d0a0 63 74 69 6f 6e 20 63 61 6c 6c 62 61 63 6b 2c 20  ction callback, 
2d0b0 78 43 61 6c 6c 62 61 63 6b 2e 0a 2a 2a 20 5e 54  xCallback..** ^T
2d0c0 68 65 20 5b 53 51 4c 49 54 45 5f 55 54 46 31 36  he [SQLITE_UTF16
2d0d0 5d 20 61 6e 64 20 5b 53 51 4c 49 54 45 5f 55 54  ] and [SQLITE_UT
2d0e0 46 31 36 5f 41 4c 49 47 4e 45 44 5d 20 76 61 6c  F16_ALIGNED] val
2d0f0 75 65 73 20 66 6f 72 20 65 54 65 78 74 52 65 70  ues for eTextRep
2d100 0a 2a 2a 20 66 6f 72 63 65 20 73 74 72 69 6e 67  .** force string
2d110 73 20 74 6f 20 62 65 20 55 54 46 31 36 20 77 69  s to be UTF16 wi
2d120 74 68 20 6e 61 74 69 76 65 20 62 79 74 65 20 6f  th native byte o
2d130 72 64 65 72 2e 0a 2a 2a 20 5e 54 68 65 20 5b 53  rder..** ^The [S
2d140 51 4c 49 54 45 5f 55 54 46 31 36 5f 41 4c 49 47  QLITE_UTF16_ALIG
2d150 4e 45 44 5d 20 76 61 6c 75 65 20 66 6f 72 20 65  NED] value for e
2d160 54 65 78 74 52 65 70 20 66 6f 72 63 65 73 20 73  TextRep forces s
2d170 74 72 69 6e 67 73 20 74 6f 20 62 65 67 69 6e 0a  trings to begin.
2d180 2a 2a 20 6f 6e 20 61 6e 20 65 76 65 6e 20 62 79  ** on an even by
2d190 74 65 20 61 64 64 72 65 73 73 2e 0a 2a 2a 0a 2a  te address..**.*
2d1a0 2a 20 5e 54 68 65 20 66 6f 75 72 74 68 20 61 72  * ^The fourth ar
2d1b0 67 75 6d 65 6e 74 2c 20 70 41 72 67 2c 20 69 73  gument, pArg, is
2d1c0 20 61 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 64   a application d
2d1d0 61 74 61 20 70 6f 69 6e 74 65 72 20 74 68 61 74  ata pointer that
2d1e0 20 69 73 20 70 61 73 73 65 64 0a 2a 2a 20 74 68   is passed.** th
2d1f0 72 6f 75 67 68 20 61 73 20 74 68 65 20 66 69 72  rough as the fir
2d200 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 74  st argument to t
2d210 68 65 20 63 6f 6c 6c 61 74 69 6e 67 20 66 75 6e  he collating fun
2d220 63 74 69 6f 6e 20 63 61 6c 6c 62 61 63 6b 2e 0a  ction callback..
2d230 2a 2a 0a 2a 2a 20 5e 54 68 65 20 66 69 66 74 68  **.** ^The fifth
2d240 20 61 72 67 75 6d 65 6e 74 2c 20 78 43 61 6c 6c   argument, xCall
2d250 62 61 63 6b 2c 20 69 73 20 61 20 70 6f 69 6e 74  back, is a point
2d260 65 72 20 74 6f 20 74 68 65 20 63 6f 6c 6c 61 74  er to the collat
2d270 69 6e 67 20 66 75 6e 63 74 69 6f 6e 2e 0a 2a 2a  ing function..**
2d280 20 5e 4d 75 6c 74 69 70 6c 65 20 63 6f 6c 6c 61   ^Multiple colla
2d290 74 69 6e 67 20 66 75 6e 63 74 69 6f 6e 73 20 63  ting functions c
2d2a0 61 6e 20 62 65 20 72 65 67 69 73 74 65 72 65 64  an be registered
2d2b0 20 75 73 69 6e 67 20 74 68 65 20 73 61 6d 65 20   using the same 
2d2c0 6e 61 6d 65 20 62 75 74 0a 2a 2a 20 77 69 74 68  name but.** with
2d2d0 20 64 69 66 66 65 72 65 6e 74 20 65 54 65 78 74   different eText
2d2e0 52 65 70 20 70 61 72 61 6d 65 74 65 72 73 20 61  Rep parameters a
2d2f0 6e 64 20 53 51 4c 69 74 65 20 77 69 6c 6c 20 75  nd SQLite will u
2d300 73 65 20 77 68 69 63 68 65 76 65 72 0a 2a 2a 20  se whichever.** 
2d310 66 75 6e 63 74 69 6f 6e 20 72 65 71 75 69 72 65  function require
2d320 73 20 74 68 65 20 6c 65 61 73 74 20 61 6d 6f 75  s the least amou
2d330 6e 74 20 6f 66 20 64 61 74 61 20 74 72 61 6e 73  nt of data trans
2d340 66 6f 72 6d 61 74 69 6f 6e 2e 0a 2a 2a 20 5e 49  formation..** ^I
2d350 66 20 74 68 65 20 78 43 61 6c 6c 62 61 63 6b 20  f the xCallback 
2d360 61 72 67 75 6d 65 6e 74 20 69 73 20 4e 55 4c 4c  argument is NULL
2d370 20 74 68 65 6e 20 74 68 65 20 63 6f 6c 6c 61 74   then the collat
2d380 69 6e 67 20 66 75 6e 63 74 69 6f 6e 20 69 73 0a  ing function is.
2d390 2a 2a 20 64 65 6c 65 74 65 64 2e 20 20 5e 57 68  ** deleted.  ^Wh
2d3a0 65 6e 20 61 6c 6c 20 63 6f 6c 6c 61 74 69 6e 67  en all collating
2d3b0 20 66 75 6e 63 74 69 6f 6e 73 20 68 61 76 69 6e   functions havin
2d3c0 67 20 74 68 65 20 73 61 6d 65 20 6e 61 6d 65 20  g the same name 
2d3d0 61 72 65 20 64 65 6c 65 74 65 64 2c 0a 2a 2a 20  are deleted,.** 
2d3e0 74 68 61 74 20 63 6f 6c 6c 61 74 69 6f 6e 20 69  that collation i
2d3f0 73 20 6e 6f 20 6c 6f 6e 67 65 72 20 75 73 61 62  s no longer usab
2d400 6c 65 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 63  le..**.** ^The c
2d410 6f 6c 6c 61 74 69 6e 67 20 66 75 6e 63 74 69 6f  ollating functio
2d420 6e 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 69 6e  n callback is in
2d430 76 6f 6b 65 64 20 77 69 74 68 20 61 20 63 6f 70  voked with a cop
2d440 79 20 6f 66 20 74 68 65 20 70 41 72 67 20 0a 2a  y of the pArg .*
2d450 2a 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 64 61  * application da
2d460 74 61 20 70 6f 69 6e 74 65 72 20 61 6e 64 20 77  ta pointer and w
2d470 69 74 68 20 74 77 6f 20 73 74 72 69 6e 67 73 20  ith two strings 
2d480 69 6e 20 74 68 65 20 65 6e 63 6f 64 69 6e 67 20  in the encoding 
2d490 73 70 65 63 69 66 69 65 64 0a 2a 2a 20 62 79 20  specified.** by 
2d4a0 74 68 65 20 65 54 65 78 74 52 65 70 20 61 72 67  the eTextRep arg
2d4b0 75 6d 65 6e 74 2e 20 20 54 68 65 20 63 6f 6c 6c  ument.  The coll
2d4c0 61 74 69 6e 67 20 66 75 6e 63 74 69 6f 6e 20 6d  ating function m
2d4d0 75 73 74 20 72 65 74 75 72 6e 20 61 6e 0a 2a 2a  ust return an.**
2d4e0 20 69 6e 74 65 67 65 72 20 74 68 61 74 20 69 73   integer that is
2d4f0 20 6e 65 67 61 74 69 76 65 2c 20 7a 65 72 6f 2c   negative, zero,
2d500 20 6f 72 20 70 6f 73 69 74 69 76 65 0a 2a 2a 20   or positive.** 
2d510 69 66 20 74 68 65 20 66 69 72 73 74 20 73 74 72  if the first str
2d520 69 6e 67 20 69 73 20 6c 65 73 73 20 74 68 61 6e  ing is less than
2d530 2c 20 65 71 75 61 6c 20 74 6f 2c 20 6f 72 20 67  , equal to, or g
2d540 72 65 61 74 65 72 20 74 68 61 6e 20 74 68 65 20  reater than the 
2d550 73 65 63 6f 6e 64 2c 0a 2a 2a 20 72 65 73 70 65  second,.** respe
2d560 63 74 69 76 65 6c 79 2e 20 20 41 20 63 6f 6c 6c  ctively.  A coll
2d570 61 74 69 6e 67 20 66 75 6e 63 74 69 6f 6e 20 6d  ating function m
2d580 75 73 74 20 61 6c 77 61 79 20 72 65 74 75 72 6e  ust alway return
2d590 20 74 68 65 20 73 61 6d 65 20 61 6e 73 77 65 72   the same answer
2d5a0 0a 2a 2a 20 67 69 76 65 6e 20 74 68 65 20 73 61  .** given the sa
2d5b0 6d 65 20 69 6e 70 75 74 73 2e 20 20 49 66 20 74  me inputs.  If t
2d5c0 77 6f 20 6f 72 20 6d 6f 72 65 20 63 6f 6c 6c 61  wo or more colla
2d5d0 74 69 6e 67 20 66 75 6e 63 74 69 6f 6e 73 20 61  ting functions a
2d5e0 72 65 20 72 65 67 69 73 74 65 72 65 64 0a 2a 2a  re registered.**
2d5f0 20 74 6f 20 74 68 65 20 73 61 6d 65 20 63 6f 6c   to the same col
2d600 6c 61 74 69 6f 6e 20 6e 61 6d 65 20 28 75 73 69  lation name (usi
2d610 6e 67 20 64 69 66 66 65 72 65 6e 74 20 65 54 65  ng different eTe
2d620 78 74 52 65 70 20 76 61 6c 75 65 73 29 20 74 68  xtRep values) th
2d630 65 6e 20 61 6c 6c 0a 2a 2a 20 6d 75 73 74 20 67  en all.** must g
2d640 69 76 65 20 61 6e 20 65 71 75 69 76 61 6c 65 6e  ive an equivalen
2d650 74 20 61 6e 73 77 65 72 20 77 68 65 6e 20 69 6e  t answer when in
2d660 76 6f 6b 65 64 20 77 69 74 68 20 65 71 75 69 76  voked with equiv
2d670 61 6c 65 6e 74 20 73 74 72 69 6e 67 73 2e 0a 2a  alent strings..*
2d680 2a 20 54 68 65 20 63 6f 6c 6c 61 74 69 6e 67 20  * The collating 
2d690 66 75 6e 63 74 69 6f 6e 20 6d 75 73 74 20 6f 62  function must ob
2d6a0 65 79 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67  ey the following
2d6b0 20 70 72 6f 70 65 72 74 69 65 73 20 66 6f 72 20   properties for 
2d6c0 61 6c 6c 0a 2a 2a 20 73 74 72 69 6e 67 73 20 41  all.** strings A
2d6d0 2c 20 42 2c 20 61 6e 64 20 43 3a 0a 2a 2a 0a 2a  , B, and C:.**.*
2d6e0 2a 20 3c 6f 6c 3e 0a 2a 2a 20 3c 6c 69 3e 20 49  * <ol>.** <li> I
2d6f0 66 20 41 3d 3d 42 20 74 68 65 6e 20 42 3d 3d 41  f A==B then B==A
2d700 2e 0a 2a 2a 20 3c 6c 69 3e 20 49 66 20 41 3d 3d  ..** <li> If A==
2d710 42 20 61 6e 64 20 42 3d 3d 43 20 74 68 65 6e 20  B and B==C then 
2d720 41 3d 3d 43 2e 0a 2a 2a 20 3c 6c 69 3e 20 49 66  A==C..** <li> If
2d730 20 41 26 6c 74 3b 42 20 54 48 45 4e 20 42 26 67   A&lt;B THEN B&g
2d740 74 3b 41 2e 0a 2a 2a 20 3c 6c 69 3e 20 49 66 20  t;A..** <li> If 
2d750 41 26 6c 74 3b 42 20 61 6e 64 20 42 26 6c 74 3b  A&lt;B and B&lt;
2d760 43 20 74 68 65 6e 20 41 26 6c 74 3b 43 2e 0a 2a  C then A&lt;C..*
2d770 2a 20 3c 2f 6f 6c 3e 0a 2a 2a 0a 2a 2a 20 49 66  * </ol>.**.** If
2d780 20 61 20 63 6f 6c 6c 61 74 69 6e 67 20 66 75 6e   a collating fun
2d790 63 74 69 6f 6e 20 66 61 69 6c 73 20 61 6e 79 20  ction fails any 
2d7a0 6f 66 20 74 68 65 20 61 62 6f 76 65 20 63 6f 6e  of the above con
2d7b0 73 74 72 61 69 6e 74 73 20 61 6e 64 20 74 68 61  straints and tha
2d7c0 74 0a 2a 2a 20 63 6f 6c 6c 61 74 69 6e 67 20 66  t.** collating f
2d7d0 75 6e 63 74 69 6f 6e 20 69 73 20 20 72 65 67 69  unction is  regi
2d7e0 73 74 65 72 65 64 20 61 6e 64 20 75 73 65 64 2c  stered and used,
2d7f0 20 74 68 65 6e 20 74 68 65 20 62 65 68 61 76 69   then the behavi
2d800 6f 72 20 6f 66 20 53 51 4c 69 74 65 0a 2a 2a 20  or of SQLite.** 
2d810 69 73 20 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a  is undefined..**
2d820 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33  .** ^The sqlite3
2d830 5f 63 72 65 61 74 65 5f 63 6f 6c 6c 61 74 69 6f  _create_collatio
2d840 6e 5f 76 32 28 29 20 77 6f 72 6b 73 20 6c 69 6b  n_v2() works lik
2d850 65 20 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65  e sqlite3_create
2d860 5f 63 6f 6c 6c 61 74 69 6f 6e 28 29 0a 2a 2a 20  _collation().** 
2d870 77 69 74 68 20 74 68 65 20 61 64 64 69 74 69 6f  with the additio
2d880 6e 20 74 68 61 74 20 74 68 65 20 78 44 65 73 74  n that the xDest
2d890 72 6f 79 20 63 61 6c 6c 62 61 63 6b 20 69 73 20  roy callback is 
2d8a0 69 6e 76 6f 6b 65 64 20 6f 6e 20 70 41 72 67 20  invoked on pArg 
2d8b0 77 68 65 6e 0a 2a 2a 20 74 68 65 20 63 6f 6c 6c  when.** the coll
2d8c0 61 74 69 6e 67 20 66 75 6e 63 74 69 6f 6e 20 69  ating function i
2d8d0 73 20 64 65 6c 65 74 65 64 2e 0a 2a 2a 20 5e 43  s deleted..** ^C
2d8e0 6f 6c 6c 61 74 69 6e 67 20 66 75 6e 63 74 69 6f  ollating functio
2d8f0 6e 73 20 61 72 65 20 64 65 6c 65 74 65 64 20 77  ns are deleted w
2d900 68 65 6e 20 74 68 65 79 20 61 72 65 20 6f 76 65  hen they are ove
2d910 72 72 69 64 64 65 6e 20 62 79 20 6c 61 74 65 72  rridden by later
2d920 0a 2a 2a 20 63 61 6c 6c 73 20 74 6f 20 74 68 65  .** calls to the
2d930 20 63 6f 6c 6c 61 74 69 6f 6e 20 63 72 65 61 74   collation creat
2d940 69 6f 6e 20 66 75 6e 63 74 69 6f 6e 73 20 6f 72  ion functions or
2d950 20 77 68 65 6e 20 74 68 65 0a 2a 2a 20 5b 64 61   when the.** [da
2d960 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
2d970 6e 5d 20 69 73 20 63 6c 6f 73 65 64 20 75 73 69  n] is closed usi
2d980 6e 67 20 5b 73 71 6c 69 74 65 33 5f 63 6c 6f 73  ng [sqlite3_clos
2d990 65 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  e()]..**.** ^The
2d9a0 20 78 44 65 73 74 72 6f 79 20 63 61 6c 6c 62 61   xDestroy callba
2d9b0 63 6b 20 69 73 20 3c 75 3e 6e 6f 74 3c 2f 75 3e  ck is <u>not</u>
2d9c0 20 63 61 6c 6c 65 64 20 69 66 20 74 68 65 20 0a   called if the .
2d9d0 2a 2a 20 73 71 6c 69 74 65 33 5f 63 72 65 61 74  ** sqlite3_creat
2d9e0 65 5f 63 6f 6c 6c 61 74 69 6f 6e 5f 76 32 28 29  e_collation_v2()
2d9f0 20 66 75 6e 63 74 69 6f 6e 20 66 61 69 6c 73 2e   function fails.
2da00 20 20 41 70 70 6c 69 63 61 74 69 6f 6e 73 20 74    Applications t
2da10 68 61 74 20 69 6e 76 6f 6b 65 0a 2a 2a 20 73 71  hat invoke.** sq
2da20 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 63 6f 6c  lite3_create_col
2da30 6c 61 74 69 6f 6e 5f 76 32 28 29 20 77 69 74 68  lation_v2() with
2da40 20 61 20 6e 6f 6e 2d 4e 55 4c 4c 20 78 44 65 73   a non-NULL xDes
2da50 74 72 6f 79 20 61 72 67 75 6d 65 6e 74 20 73 68  troy argument sh
2da60 6f 75 6c 64 20 0a 2a 2a 20 63 68 65 63 6b 20 74  ould .** check t
2da70 68 65 20 72 65 74 75 72 6e 20 63 6f 64 65 20 61  he return code a
2da80 6e 64 20 64 69 73 70 6f 73 65 20 6f 66 20 74 68  nd dispose of th
2da90 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 64 61  e application da
2daa0 74 61 20 70 6f 69 6e 74 65 72 0a 2a 2a 20 74 68  ta pointer.** th
2dab0 65 6d 73 65 6c 76 65 73 20 72 61 74 68 65 72 20  emselves rather 
2dac0 74 68 61 6e 20 65 78 70 65 63 74 69 6e 67 20 53  than expecting S
2dad0 51 4c 69 74 65 20 74 6f 20 64 65 61 6c 20 77 69  QLite to deal wi
2dae0 74 68 20 69 74 20 66 6f 72 20 74 68 65 6d 2e 0a  th it for them..
2daf0 2a 2a 20 54 68 69 73 20 69 73 20 64 69 66 66 65  ** This is diffe
2db00 72 65 6e 74 20 66 72 6f 6d 20 65 76 65 72 79 20  rent from every 
2db10 6f 74 68 65 72 20 53 51 4c 69 74 65 20 69 6e 74  other SQLite int
2db20 65 72 66 61 63 65 2e 20 20 54 68 65 20 69 6e 63  erface.  The inc
2db30 6f 6e 73 69 73 74 65 6e 63 79 20 0a 2a 2a 20 69  onsistency .** i
2db40 73 20 75 6e 66 6f 72 74 75 6e 61 74 65 20 62 75  s unfortunate bu
2db50 74 20 63 61 6e 6e 6f 74 20 62 65 20 63 68 61 6e  t cannot be chan
2db60 67 65 64 20 77 69 74 68 6f 75 74 20 62 72 65 61  ged without brea
2db70 6b 69 6e 67 20 62 61 63 6b 77 61 72 64 73 20 0a  king backwards .
2db80 2a 2a 20 63 6f 6d 70 61 74 69 62 69 6c 69 74 79  ** compatibility
2db90 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f  ..**.** See also
2dba0 3a 20 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c 6c  :  [sqlite3_coll
2dbb0 61 74 69 6f 6e 5f 6e 65 65 64 65 64 28 29 5d 20  ation_needed()] 
2dbc0 61 6e 64 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6c  and [sqlite3_col
2dbd0 6c 61 74 69 6f 6e 5f 6e 65 65 64 65 64 31 36 28  lation_needed16(
2dbe0 29 5d 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74  )]..*/.int sqlit
2dbf0 65 33 5f 63 72 65 61 74 65 5f 63 6f 6c 6c 61 74  e3_create_collat
2dc00 69 6f 6e 28 0a 20 20 73 71 6c 69 74 65 33 2a 2c  ion(.  sqlite3*,
2dc10 20 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a   .  const char *
2dc20 7a 4e 61 6d 65 2c 20 0a 20 20 69 6e 74 20 65 54  zName, .  int eT
2dc30 65 78 74 52 65 70 2c 20 0a 20 20 76 6f 69 64 20  extRep, .  void 
2dc40 2a 70 41 72 67 2c 0a 20 20 69 6e 74 28 2a 78 43  *pArg,.  int(*xC
2dc50 6f 6d 70 61 72 65 29 28 76 6f 69 64 2a 2c 69 6e  ompare)(void*,in
2dc60 74 2c 63 6f 6e 73 74 20 76 6f 69 64 2a 2c 69 6e  t,const void*,in
2dc70 74 2c 63 6f 6e 73 74 20 76 6f 69 64 2a 29 0a 29  t,const void*).)
2dc80 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 63 72  ;.int sqlite3_cr
2dc90 65 61 74 65 5f 63 6f 6c 6c 61 74 69 6f 6e 5f 76  eate_collation_v
2dca0 32 28 0a 20 20 73 71 6c 69 74 65 33 2a 2c 20 0a  2(.  sqlite3*, .
2dcb0 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 4e    const char *zN
2dcc0 61 6d 65 2c 20 0a 20 20 69 6e 74 20 65 54 65 78  ame, .  int eTex
2dcd0 74 52 65 70 2c 20 0a 20 20 76 6f 69 64 20 2a 70  tRep, .  void *p
2dce0 41 72 67 2c 0a 20 20 69 6e 74 28 2a 78 43 6f 6d  Arg,.  int(*xCom
2dcf0 70 61 72 65 29 28 76 6f 69 64 2a 2c 69 6e 74 2c  pare)(void*,int,
2dd00 63 6f 6e 73 74 20 76 6f 69 64 2a 2c 69 6e 74 2c  const void*,int,
2dd10 63 6f 6e 73 74 20 76 6f 69 64 2a 29 2c 0a 20 20  const void*),.  
2dd20 76 6f 69 64 28 2a 78 44 65 73 74 72 6f 79 29 28  void(*xDestroy)(
2dd30 76 6f 69 64 2a 29 0a 29 3b 0a 69 6e 74 20 73 71  void*).);.int sq
2dd40 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 63 6f 6c  lite3_create_col
2dd50 6c 61 74 69 6f 6e 31 36 28 0a 20 20 73 71 6c 69  lation16(.  sqli
2dd60 74 65 33 2a 2c 20 0a 20 20 63 6f 6e 73 74 20 76  te3*, .  const v
2dd70 6f 69 64 20 2a 7a 4e 61 6d 65 2c 0a 20 20 69 6e  oid *zName,.  in
2dd80 74 20 65 54 65 78 74 52 65 70 2c 20 0a 20 20 76  t eTextRep, .  v
2dd90 6f 69 64 20 2a 70 41 72 67 2c 0a 20 20 69 6e 74  oid *pArg,.  int
2dda0 28 2a 78 43 6f 6d 70 61 72 65 29 28 76 6f 69 64  (*xCompare)(void
2ddb0 2a 2c 69 6e 74 2c 63 6f 6e 73 74 20 76 6f 69 64  *,int,const void
2ddc0 2a 2c 69 6e 74 2c 63 6f 6e 73 74 20 76 6f 69 64  *,int,const void
2ddd0 2a 29 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  *).);../*.** CAP
2dde0 49 33 52 45 46 3a 20 43 6f 6c 6c 61 74 69 6f 6e  I3REF: Collation
2ddf0 20 4e 65 65 64 65 64 20 43 61 6c 6c 62 61 63 6b   Needed Callback
2de00 73 0a 2a 2a 0a 2a 2a 20 5e 54 6f 20 61 76 6f 69  s.**.** ^To avoi
2de10 64 20 68 61 76 69 6e 67 20 74 6f 20 72 65 67 69  d having to regi
2de20 73 74 65 72 20 61 6c 6c 20 63 6f 6c 6c 61 74 69  ster all collati
2de30 6f 6e 20 73 65 71 75 65 6e 63 65 73 20 62 65 66  on sequences bef
2de40 6f 72 65 20 61 20 64 61 74 61 62 61 73 65 0a 2a  ore a database.*
2de50 2a 20 63 61 6e 20 62 65 20 75 73 65 64 2c 20 61  * can be used, a
2de60 20 73 69 6e 67 6c 65 20 63 61 6c 6c 62 61 63 6b   single callback
2de70 20 66 75 6e 63 74 69 6f 6e 20 6d 61 79 20 62 65   function may be
2de80 20 72 65 67 69 73 74 65 72 65 64 20 77 69 74 68   registered with
2de90 20 74 68 65 0a 2a 2a 20 5b 64 61 74 61 62 61 73   the.** [databas
2dea0 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 74 6f  e connection] to
2deb0 20 62 65 20 69 6e 76 6f 6b 65 64 20 77 68 65 6e   be invoked when
2dec0 65 76 65 72 20 61 6e 20 75 6e 64 65 66 69 6e 65  ever an undefine
2ded0 64 20 63 6f 6c 6c 61 74 69 6f 6e 0a 2a 2a 20 73  d collation.** s
2dee0 65 71 75 65 6e 63 65 20 69 73 20 72 65 71 75 69  equence is requi
2def0 72 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74  red..**.** ^If t
2df00 68 65 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 72  he function is r
2df10 65 67 69 73 74 65 72 65 64 20 75 73 69 6e 67 20  egistered using 
2df20 74 68 65 20 73 71 6c 69 74 65 33 5f 63 6f 6c 6c  the sqlite3_coll
2df30 61 74 69 6f 6e 5f 6e 65 65 64 65 64 28 29 20 41  ation_needed() A
2df40 50 49 2c 0a 2a 2a 20 74 68 65 6e 20 69 74 20 69  PI,.** then it i
2df50 73 20 70 61 73 73 65 64 20 74 68 65 20 6e 61 6d  s passed the nam
2df60 65 73 20 6f 66 20 75 6e 64 65 66 69 6e 65 64 20  es of undefined 
2df70 63 6f 6c 6c 61 74 69 6f 6e 20 73 65 71 75 65 6e  collation sequen
2df80 63 65 73 20 61 73 20 73 74 72 69 6e 67 73 0a 2a  ces as strings.*
2df90 2a 20 65 6e 63 6f 64 65 64 20 69 6e 20 55 54 46  * encoded in UTF
2dfa0 2d 38 2e 20 5e 49 66 20 73 71 6c 69 74 65 33 5f  -8. ^If sqlite3_
2dfb0 63 6f 6c 6c 61 74 69 6f 6e 5f 6e 65 65 64 65 64  collation_needed
2dfc0 31 36 28 29 20 69 73 20 75 73 65 64 2c 0a 2a 2a  16() is used,.**
2dfd0 20 74 68 65 20 6e 61 6d 65 73 20 61 72 65 20 70   the names are p
2dfe0 61 73 73 65 64 20 61 73 20 55 54 46 2d 31 36 20  assed as UTF-16 
2dff0 69 6e 20 6d 61 63 68 69 6e 65 20 6e 61 74 69 76  in machine nativ
2e000 65 20 62 79 74 65 20 6f 72 64 65 72 2e 0a 2a 2a  e byte order..**
2e010 20 5e 41 20 63 61 6c 6c 20 74 6f 20 65 69 74 68   ^A call to eith
2e020 65 72 20 66 75 6e 63 74 69 6f 6e 20 72 65 70 6c  er function repl
2e030 61 63 65 73 20 74 68 65 20 65 78 69 73 74 69 6e  aces the existin
2e040 67 20 63 6f 6c 6c 61 74 69 6f 6e 2d 6e 65 65 64  g collation-need
2e050 65 64 20 63 61 6c 6c 62 61 63 6b 2e 0a 2a 2a 0a  ed callback..**.
2e060 2a 2a 20 5e 28 57 68 65 6e 20 74 68 65 20 63 61  ** ^(When the ca
2e070 6c 6c 62 61 63 6b 20 69 73 20 69 6e 76 6f 6b 65  llback is invoke
2e080 64 2c 20 74 68 65 20 66 69 72 73 74 20 61 72 67  d, the first arg
2e090 75 6d 65 6e 74 20 70 61 73 73 65 64 20 69 73 20  ument passed is 
2e0a0 61 20 63 6f 70 79 0a 2a 2a 20 6f 66 20 74 68 65  a copy.** of the
2e0b0 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74   second argument
2e0c0 20 74 6f 20 73 71 6c 69 74 65 33 5f 63 6f 6c 6c   to sqlite3_coll
2e0d0 61 74 69 6f 6e 5f 6e 65 65 64 65 64 28 29 20 6f  ation_needed() o
2e0e0 72 0a 2a 2a 20 73 71 6c 69 74 65 33 5f 63 6f 6c  r.** sqlite3_col
2e0f0 6c 61 74 69 6f 6e 5f 6e 65 65 64 65 64 31 36 28  lation_needed16(
2e100 29 2e 20 20 54 68 65 20 73 65 63 6f 6e 64 20 61  ).  The second a
2e110 72 67 75 6d 65 6e 74 20 69 73 20 74 68 65 20 64  rgument is the d
2e120 61 74 61 62 61 73 65 0a 2a 2a 20 63 6f 6e 6e 65  atabase.** conne
2e130 63 74 69 6f 6e 2e 20 20 54 68 65 20 74 68 69 72  ction.  The thir
2e140 64 20 61 72 67 75 6d 65 6e 74 20 69 73 20 6f 6e  d argument is on
2e150 65 20 6f 66 20 5b 53 51 4c 49 54 45 5f 55 54 46  e of [SQLITE_UTF
2e160 38 5d 2c 20 5b 53 51 4c 49 54 45 5f 55 54 46 31  8], [SQLITE_UTF1
2e170 36 42 45 5d 2c 0a 2a 2a 20 6f 72 20 5b 53 51 4c  6BE],.** or [SQL
2e180 49 54 45 5f 55 54 46 31 36 4c 45 5d 2c 20 69 6e  ITE_UTF16LE], in
2e190 64 69 63 61 74 69 6e 67 20 74 68 65 20 6d 6f 73  dicating the mos
2e1a0 74 20 64 65 73 69 72 61 62 6c 65 20 66 6f 72 6d  t desirable form
2e1b0 20 6f 66 20 74 68 65 20 63 6f 6c 6c 61 74 69 6f   of the collatio
2e1c0 6e 0a 2a 2a 20 73 65 71 75 65 6e 63 65 20 66 75  n.** sequence fu
2e1d0 6e 63 74 69 6f 6e 20 72 65 71 75 69 72 65 64 2e  nction required.
2e1e0 20 20 54 68 65 20 66 6f 75 72 74 68 20 70 61 72    The fourth par
2e1f0 61 6d 65 74 65 72 20 69 73 20 74 68 65 20 6e 61  ameter is the na
2e200 6d 65 20 6f 66 20 74 68 65 0a 2a 2a 20 72 65 71  me of the.** req
2e210 75 69 72 65 64 20 63 6f 6c 6c 61 74 69 6f 6e 20  uired collation 
2e220 73 65 71 75 65 6e 63 65 2e 29 5e 0a 2a 2a 0a 2a  sequence.)^.**.*
2e230 2a 20 54 68 65 20 63 61 6c 6c 62 61 63 6b 20 66  * The callback f
2e240 75 6e 63 74 69 6f 6e 20 73 68 6f 75 6c 64 20 72  unction should r
2e250 65 67 69 73 74 65 72 20 74 68 65 20 64 65 73 69  egister the desi
2e260 72 65 64 20 63 6f 6c 6c 61 74 69 6f 6e 20 75 73  red collation us
2e270 69 6e 67 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  ing.** [sqlite3_
2e280 63 72 65 61 74 65 5f 63 6f 6c 6c 61 74 69 6f 6e  create_collation
2e290 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 63 72  ()], [sqlite3_cr
2e2a0 65 61 74 65 5f 63 6f 6c 6c 61 74 69 6f 6e 31 36  eate_collation16
2e2b0 28 29 5d 2c 20 6f 72 0a 2a 2a 20 5b 73 71 6c 69  ()], or.** [sqli
2e2c0 74 65 33 5f 63 72 65 61 74 65 5f 63 6f 6c 6c 61  te3_create_colla
2e2d0 74 69 6f 6e 5f 76 32 28 29 5d 2e 0a 2a 2f 0a 69  tion_v2()]..*/.i
2e2e0 6e 74 20 73 71 6c 69 74 65 33 5f 63 6f 6c 6c 61  nt sqlite3_colla
2e2f0 74 69 6f 6e 5f 6e 65 65 64 65 64 28 0a 20 20 73  tion_needed(.  s
2e300 71 6c 69 74 65 33 2a 2c 20 0a 20 20 76 6f 69 64  qlite3*, .  void
2e310 2a 2c 20 0a 20 20 76 6f 69 64 28 2a 29 28 76 6f  *, .  void(*)(vo
2e320 69 64 2a 2c 73 71 6c 69 74 65 33 2a 2c 69 6e 74  id*,sqlite3*,int
2e330 20 65 54 65 78 74 52 65 70 2c 63 6f 6e 73 74 20   eTextRep,const 
2e340 63 68 61 72 2a 29 0a 29 3b 0a 69 6e 74 20 73 71  char*).);.int sq
2e350 6c 69 74 65 33 5f 63 6f 6c 6c 61 74 69 6f 6e 5f  lite3_collation_
2e360 6e 65 65 64 65 64 31 36 28 0a 20 20 73 71 6c 69  needed16(.  sqli
2e370 74 65 33 2a 2c 20 0a 20 20 76 6f 69 64 2a 2c 0a  te3*, .  void*,.
2e380 20 20 76 6f 69 64 28 2a 29 28 76 6f 69 64 2a 2c    void(*)(void*,
2e390 73 71 6c 69 74 65 33 2a 2c 69 6e 74 20 65 54 65  sqlite3*,int eTe
2e3a0 78 74 52 65 70 2c 63 6f 6e 73 74 20 76 6f 69 64  xtRep,const void
2e3b0 2a 29 0a 29 3b 0a 0a 23 69 66 64 65 66 20 53 51  *).);..#ifdef SQ
2e3c0 4c 49 54 45 5f 48 41 53 5f 43 4f 44 45 43 0a 2f  LITE_HAS_CODEC./
2e3d0 2a 0a 2a 2a 20 53 70 65 63 69 66 79 20 74 68 65  *.** Specify the
2e3e0 20 6b 65 79 20 66 6f 72 20 61 6e 20 65 6e 63 72   key for an encr
2e3f0 79 70 74 65 64 20 64 61 74 61 62 61 73 65 2e 20  ypted database. 
2e400 20 54 68 69 73 20 72 6f 75 74 69 6e 65 20 73 68   This routine sh
2e410 6f 75 6c 64 20 62 65 0a 2a 2a 20 63 61 6c 6c 65  ould be.** calle
2e420 64 20 72 69 67 68 74 20 61 66 74 65 72 20 73 71  d right after sq
2e430 6c 69 74 65 33 5f 6f 70 65 6e 28 29 2e 0a 2a 2a  lite3_open()..**
2e440 0a 2a 2a 20 54 68 65 20 63 6f 64 65 20 74 6f 20  .** The code to 
2e450 69 6d 70 6c 65 6d 65 6e 74 20 74 68 69 73 20 41  implement this A
2e460 50 49 20 69 73 20 6e 6f 74 20 61 76 61 69 6c 61  PI is not availa
2e470 62 6c 65 20 69 6e 20 74 68 65 20 70 75 62 6c 69  ble in the publi
2e480 63 20 72 65 6c 65 61 73 65 0a 2a 2a 20 6f 66 20  c release.** of 
2e490 53 51 4c 69 74 65 2e 0a 2a 2f 0a 69 6e 74 20 73  SQLite..*/.int s
2e4a0 71 6c 69 74 65 33 5f 6b 65 79 28 0a 20 20 73 71  qlite3_key(.  sq
2e4b0 6c 69 74 65 33 20 2a 64 62 2c 20 20 20 20 20 20  lite3 *db,      
2e4c0 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
2e4d0 44 61 74 61 62 61 73 65 20 74 6f 20 62 65 20 72  Database to be r
2e4e0 65 6b 65 79 65 64 20 2a 2f 0a 20 20 63 6f 6e 73  ekeyed */.  cons
2e4f0 74 20 76 6f 69 64 20 2a 70 4b 65 79 2c 20 69 6e  t void *pKey, in
2e500 74 20 6e 4b 65 79 20 20 20 20 20 2f 2a 20 54 68  t nKey     /* Th
2e510 65 20 6b 65 79 20 2a 2f 0a 29 3b 0a 0a 2f 2a 0a  e key */.);../*.
2e520 2a 2a 20 43 68 61 6e 67 65 20 74 68 65 20 6b 65  ** Change the ke
2e530 79 20 6f 6e 20 61 6e 20 6f 70 65 6e 20 64 61 74  y on an open dat
2e540 61 62 61 73 65 2e 20 20 49 66 20 74 68 65 20 63  abase.  If the c
2e550 75 72 72 65 6e 74 20 64 61 74 61 62 61 73 65 20  urrent database 
2e560 69 73 20 6e 6f 74 0a 2a 2a 20 65 6e 63 72 79 70  is not.** encryp
2e570 74 65 64 2c 20 74 68 69 73 20 72 6f 75 74 69 6e  ted, this routin
2e580 65 20 77 69 6c 6c 20 65 6e 63 72 79 70 74 20 69  e will encrypt i
2e590 74 2e 20 20 49 66 20 70 4e 65 77 3d 3d 30 20 6f  t.  If pNew==0 o
2e5a0 72 20 6e 4e 65 77 3d 3d 30 2c 20 74 68 65 0a 2a  r nNew==0, the.*
2e5b0 2a 20 64 61 74 61 62 61 73 65 20 69 73 20 64 65  * database is de
2e5c0 63 72 79 70 74 65 64 2e 0a 2a 2a 0a 2a 2a 20 54  crypted..**.** T
2e5d0 68 65 20 63 6f 64 65 20 74 6f 20 69 6d 70 6c 65  he code to imple
2e5e0 6d 65 6e 74 20 74 68 69 73 20 41 50 49 20 69 73  ment this API is
2e5f0 20 6e 6f 74 20 61 76 61 69 6c 61 62 6c 65 20 69   not available i
2e600 6e 20 74 68 65 20 70 75 62 6c 69 63 20 72 65 6c  n the public rel
2e610 65 61 73 65 0a 2a 2a 20 6f 66 20 53 51 4c 69 74  ease.** of SQLit
2e620 65 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65  e..*/.int sqlite
2e630 33 5f 72 65 6b 65 79 28 0a 20 20 73 71 6c 69 74  3_rekey(.  sqlit
2e640 65 33 20 2a 64 62 2c 20 20 20 20 20 20 20 20 20  e3 *db,         
2e650 20 20 20 20 20 20 20 20 20 20 2f 2a 20 44 61 74            /* Dat
2e660 61 62 61 73 65 20 74 6f 20 62 65 20 72 65 6b 65  abase to be reke
2e670 79 65 64 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 76  yed */.  const v
2e680 6f 69 64 20 2a 70 4b 65 79 2c 20 69 6e 74 20 6e  oid *pKey, int n
2e690 4b 65 79 20 20 20 20 20 2f 2a 20 54 68 65 20 6e  Key     /* The n
2e6a0 65 77 20 6b 65 79 20 2a 2f 0a 29 3b 0a 0a 2f 2a  ew key */.);../*
2e6b0 0a 2a 2a 20 53 70 65 63 69 66 79 20 74 68 65 20  .** Specify the 
2e6c0 61 63 74 69 76 61 74 69 6f 6e 20 6b 65 79 20 66  activation key f
2e6d0 6f 72 20 61 20 53 45 45 20 64 61 74 61 62 61 73  or a SEE databas
2e6e0 65 2e 20 20 55 6e 6c 65 73 73 20 0a 2a 2a 20 61  e.  Unless .** a
2e6f0 63 74 69 76 61 74 65 64 2c 20 6e 6f 6e 65 20 6f  ctivated, none o
2e700 66 20 74 68 65 20 53 45 45 20 72 6f 75 74 69 6e  f the SEE routin
2e710 65 73 20 77 69 6c 6c 20 77 6f 72 6b 2e 0a 2a 2f  es will work..*/
2e720 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 5f 61 63  .void sqlite3_ac
2e730 74 69 76 61 74 65 5f 73 65 65 28 0a 20 20 63 6f  tivate_see(.  co
2e740 6e 73 74 20 63 68 61 72 20 2a 7a 50 61 73 73 50  nst char *zPassP
2e750 68 72 61 73 65 20 20 20 20 20 20 20 20 2f 2a 20  hrase        /* 
2e760 41 63 74 69 76 61 74 69 6f 6e 20 70 68 72 61 73  Activation phras
2e770 65 20 2a 2f 0a 29 3b 0a 23 65 6e 64 69 66 0a 0a  e */.);.#endif..
2e780 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 45 4e  #ifdef SQLITE_EN
2e790 41 42 4c 45 5f 43 45 52 4f 44 0a 2f 2a 0a 2a 2a  ABLE_CEROD./*.**
2e7a0 20 53 70 65 63 69 66 79 20 74 68 65 20 61 63 74   Specify the act
2e7b0 69 76 61 74 69 6f 6e 20 6b 65 79 20 66 6f 72 20  ivation key for 
2e7c0 61 20 43 45 52 4f 44 20 64 61 74 61 62 61 73 65  a CEROD database
2e7d0 2e 20 20 55 6e 6c 65 73 73 20 0a 2a 2a 20 61 63  .  Unless .** ac
2e7e0 74 69 76 61 74 65 64 2c 20 6e 6f 6e 65 20 6f 66  tivated, none of
2e7f0 20 74 68 65 20 43 45 52 4f 44 20 72 6f 75 74 69   the CEROD routi
2e800 6e 65 73 20 77 69 6c 6c 20 77 6f 72 6b 2e 0a 2a  nes will work..*
2e810 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 5f 61  /.void sqlite3_a
2e820 63 74 69 76 61 74 65 5f 63 65 72 6f 64 28 0a 20  ctivate_cerod(. 
2e830 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 50 61   const char *zPa
2e840 73 73 50 68 72 61 73 65 20 20 20 20 20 20 20 20  ssPhrase        
2e850 2f 2a 20 41 63 74 69 76 61 74 69 6f 6e 20 70 68  /* Activation ph
2e860 72 61 73 65 20 2a 2f 0a 29 3b 0a 23 65 6e 64 69  rase */.);.#endi
2e870 66 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  f../*.** CAPI3RE
2e880 46 3a 20 53 75 73 70 65 6e 64 20 45 78 65 63 75  F: Suspend Execu
2e890 74 69 6f 6e 20 46 6f 72 20 41 20 53 68 6f 72 74  tion For A Short
2e8a0 20 54 69 6d 65 0a 2a 2a 0a 2a 2a 20 54 68 65 20   Time.**.** The 
2e8b0 73 71 6c 69 74 65 33 5f 73 6c 65 65 70 28 29 20  sqlite3_sleep() 
2e8c0 66 75 6e 63 74 69 6f 6e 20 63 61 75 73 65 73 20  function causes 
2e8d0 74 68 65 20 63 75 72 72 65 6e 74 20 74 68 72 65  the current thre
2e8e0 61 64 20 74 6f 20 73 75 73 70 65 6e 64 20 65 78  ad to suspend ex
2e8f0 65 63 75 74 69 6f 6e 0a 2a 2a 20 66 6f 72 20 61  ecution.** for a
2e900 74 20 6c 65 61 73 74 20 61 20 6e 75 6d 62 65 72  t least a number
2e910 20 6f 66 20 6d 69 6c 6c 69 73 65 63 6f 6e 64 73   of milliseconds
2e920 20 73 70 65 63 69 66 69 65 64 20 69 6e 20 69 74   specified in it
2e930 73 20 70 61 72 61 6d 65 74 65 72 2e 0a 2a 2a 0a  s parameter..**.
2e940 2a 2a 20 49 66 20 74 68 65 20 6f 70 65 72 61 74  ** If the operat
2e950 69 6e 67 20 73 79 73 74 65 6d 20 64 6f 65 73 20  ing system does 
2e960 6e 6f 74 20 73 75 70 70 6f 72 74 20 73 6c 65 65  not support slee
2e970 70 20 72 65 71 75 65 73 74 73 20 77 69 74 68 0a  p requests with.
2e980 2a 2a 20 6d 69 6c 6c 69 73 65 63 6f 6e 64 20 74  ** millisecond t
2e990 69 6d 65 20 72 65 73 6f 6c 75 74 69 6f 6e 2c 20  ime resolution, 
2e9a0 74 68 65 6e 20 74 68 65 20 74 69 6d 65 20 77 69  then the time wi
2e9b0 6c 6c 20 62 65 20 72 6f 75 6e 64 65 64 20 75 70  ll be rounded up
2e9c0 20 74 6f 0a 2a 2a 20 74 68 65 20 6e 65 61 72 65   to.** the neare
2e9d0 73 74 20 73 65 63 6f 6e 64 2e 20 54 68 65 20 6e  st second. The n
2e9e0 75 6d 62 65 72 20 6f 66 20 6d 69 6c 6c 69 73 65  umber of millise
2e9f0 63 6f 6e 64 73 20 6f 66 20 73 6c 65 65 70 20 61  conds of sleep a
2ea00 63 74 75 61 6c 6c 79 0a 2a 2a 20 72 65 71 75 65  ctually.** reque
2ea10 73 74 65 64 20 66 72 6f 6d 20 74 68 65 20 6f 70  sted from the op
2ea20 65 72 61 74 69 6e 67 20 73 79 73 74 65 6d 20 69  erating system i
2ea30 73 20 72 65 74 75 72 6e 65 64 2e 0a 2a 2a 0a 2a  s returned..**.*
2ea40 2a 20 5e 53 51 4c 69 74 65 20 69 6d 70 6c 65 6d  * ^SQLite implem
2ea50 65 6e 74 73 20 74 68 69 73 20 69 6e 74 65 72 66  ents this interf
2ea60 61 63 65 20 62 79 20 63 61 6c 6c 69 6e 67 20 74  ace by calling t
2ea70 68 65 20 78 53 6c 65 65 70 28 29 0a 2a 2a 20 6d  he xSleep().** m
2ea80 65 74 68 6f 64 20 6f 66 20 74 68 65 20 64 65 66  ethod of the def
2ea90 61 75 6c 74 20 5b 73 71 6c 69 74 65 33 5f 76 66  ault [sqlite3_vf
2eaa0 73 5d 20 6f 62 6a 65 63 74 2e 20 20 49 66 20 74  s] object.  If t
2eab0 68 65 20 78 53 6c 65 65 70 28 29 20 6d 65 74 68  he xSleep() meth
2eac0 6f 64 0a 2a 2a 20 6f 66 20 74 68 65 20 64 65 66  od.** of the def
2ead0 61 75 6c 74 20 56 46 53 20 69 73 20 6e 6f 74 20  ault VFS is not 
2eae0 69 6d 70 6c 65 6d 65 6e 74 65 64 20 63 6f 72 72  implemented corr
2eaf0 65 63 74 6c 79 2c 20 6f 72 20 6e 6f 74 20 69 6d  ectly, or not im
2eb00 70 6c 65 6d 65 6e 74 65 64 20 61 74 0a 2a 2a 20  plemented at.** 
2eb10 61 6c 6c 2c 20 74 68 65 6e 20 74 68 65 20 62 65  all, then the be
2eb20 68 61 76 69 6f 72 20 6f 66 20 73 71 6c 69 74 65  havior of sqlite
2eb30 33 5f 73 6c 65 65 70 28 29 20 6d 61 79 20 64 65  3_sleep() may de
2eb40 76 69 61 74 65 20 66 72 6f 6d 20 74 68 65 20 64  viate from the d
2eb50 65 73 63 72 69 70 74 69 6f 6e 0a 2a 2a 20 69 6e  escription.** in
2eb60 20 74 68 65 20 70 72 65 76 69 6f 75 73 20 70 61   the previous pa
2eb70 72 61 67 72 61 70 68 73 2e 0a 2a 2f 0a 69 6e 74  ragraphs..*/.int
2eb80 20 73 71 6c 69 74 65 33 5f 73 6c 65 65 70 28 69   sqlite3_sleep(i
2eb90 6e 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  nt);../*.** CAPI
2eba0 33 52 45 46 3a 20 4e 61 6d 65 20 4f 66 20 54 68  3REF: Name Of Th
2ebb0 65 20 46 6f 6c 64 65 72 20 48 6f 6c 64 69 6e 67  e Folder Holding
2ebc0 20 54 65 6d 70 6f 72 61 72 79 20 46 69 6c 65 73   Temporary Files
2ebd0 0a 2a 2a 0a 2a 2a 20 5e 28 49 66 20 74 68 69 73  .**.** ^(If this
2ebe0 20 67 6c 6f 62 61 6c 20 76 61 72 69 61 62 6c 65   global variable
2ebf0 20 69 73 20 6d 61 64 65 20 74 6f 20 70 6f 69 6e   is made to poin
2ec00 74 20 74 6f 20 61 20 73 74 72 69 6e 67 20 77 68  t to a string wh
2ec10 69 63 68 20 69 73 0a 2a 2a 20 74 68 65 20 6e 61  ich is.** the na
2ec20 6d 65 20 6f 66 20 61 20 66 6f 6c 64 65 72 20 28  me of a folder (
2ec30 61 2e 6b 2e 61 2e 20 64 69 72 65 63 74 6f 72 79  a.k.a. directory
2ec40 29 2c 20 74 68 65 6e 20 61 6c 6c 20 74 65 6d 70  ), then all temp
2ec50 6f 72 61 72 79 20 66 69 6c 65 73 0a 2a 2a 20 63  orary files.** c
2ec60 72 65 61 74 65 64 20 62 79 20 53 51 4c 69 74 65  reated by SQLite
2ec70 20 77 68 65 6e 20 75 73 69 6e 67 20 61 20 62 75   when using a bu
2ec80 69 6c 74 2d 69 6e 20 5b 73 71 6c 69 74 65 33 5f  ilt-in [sqlite3_
2ec90 76 66 73 20 7c 20 56 46 53 5d 0a 2a 2a 20 77 69  vfs | VFS].** wi
2eca0 6c 6c 20 62 65 20 70 6c 61 63 65 64 20 69 6e 20  ll be placed in 
2ecb0 74 68 61 74 20 64 69 72 65 63 74 6f 72 79 2e 29  that directory.)
2ecc0 5e 20 20 5e 49 66 20 74 68 69 73 20 76 61 72 69  ^  ^If this vari
2ecd0 61 62 6c 65 0a 2a 2a 20 69 73 20 61 20 4e 55 4c  able.** is a NUL
2ece0 4c 20 70 6f 69 6e 74 65 72 2c 20 74 68 65 6e 20  L pointer, then 
2ecf0 53 51 4c 69 74 65 20 70 65 72 66 6f 72 6d 73 20  SQLite performs 
2ed00 61 20 73 65 61 72 63 68 20 66 6f 72 20 61 6e 20  a search for an 
2ed10 61 70 70 72 6f 70 72 69 61 74 65 0a 2a 2a 20 74  appropriate.** t
2ed20 65 6d 70 6f 72 61 72 79 20 66 69 6c 65 20 64 69  emporary file di
2ed30 72 65 63 74 6f 72 79 2e 0a 2a 2a 0a 2a 2a 20 49  rectory..**.** I
2ed40 74 20 69 73 20 6e 6f 74 20 73 61 66 65 20 74 6f  t is not safe to
2ed50 20 72 65 61 64 20 6f 72 20 6d 6f 64 69 66 79 20   read or modify 
2ed60 74 68 69 73 20 76 61 72 69 61 62 6c 65 20 69 6e  this variable in
2ed70 20 6d 6f 72 65 20 74 68 61 6e 20 6f 6e 65 0a 2a   more than one.*
2ed80 2a 20 74 68 72 65 61 64 20 61 74 20 61 20 74 69  * thread at a ti
2ed90 6d 65 2e 20 20 49 74 20 69 73 20 6e 6f 74 20 73  me.  It is not s
2eda0 61 66 65 20 74 6f 20 72 65 61 64 20 6f 72 20 6d  afe to read or m
2edb0 6f 64 69 66 79 20 74 68 69 73 20 76 61 72 69 61  odify this varia
2edc0 62 6c 65 0a 2a 2a 20 69 66 20 61 20 5b 64 61 74  ble.** if a [dat
2edd0 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  abase connection
2ede0 5d 20 69 73 20 62 65 69 6e 67 20 75 73 65 64 20  ] is being used 
2edf0 61 74 20 74 68 65 20 73 61 6d 65 20 74 69 6d 65  at the same time
2ee00 20 69 6e 20 61 20 73 65 70 61 72 61 74 65 0a 2a   in a separate.*
2ee10 2a 20 74 68 72 65 61 64 2e 0a 2a 2a 20 49 74 20  * thread..** It 
2ee20 69 73 20 69 6e 74 65 6e 64 65 64 20 74 68 61 74  is intended that
2ee30 20 74 68 69 73 20 76 61 72 69 61 62 6c 65 20 62   this variable b
2ee40 65 20 73 65 74 20 6f 6e 63 65 0a 2a 2a 20 61 73  e set once.** as
2ee50 20 70 61 72 74 20 6f 66 20 70 72 6f 63 65 73 73   part of process
2ee60 20 69 6e 69 74 69 61 6c 69 7a 61 74 69 6f 6e 20   initialization 
2ee70 61 6e 64 20 62 65 66 6f 72 65 20 61 6e 79 20 53  and before any S
2ee80 51 4c 69 74 65 20 69 6e 74 65 72 66 61 63 65 0a  QLite interface.
2ee90 2a 2a 20 72 6f 75 74 69 6e 65 73 20 68 61 76 65  ** routines have
2eea0 20 62 65 65 6e 20 63 61 6c 6c 65 64 20 61 6e 64   been called and
2eeb0 20 74 68 61 74 20 74 68 69 73 20 76 61 72 69 61   that this varia
2eec0 62 6c 65 20 72 65 6d 61 69 6e 20 75 6e 63 68 61  ble remain uncha
2eed0 6e 67 65 64 0a 2a 2a 20 74 68 65 72 65 61 66 74  nged.** thereaft
2eee0 65 72 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 5b  er..**.** ^The [
2eef0 74 65 6d 70 5f 73 74 6f 72 65 5f 64 69 72 65 63  temp_store_direc
2ef00 74 6f 72 79 20 70 72 61 67 6d 61 5d 20 6d 61 79  tory pragma] may
2ef10 20 6d 6f 64 69 66 79 20 74 68 69 73 20 76 61 72   modify this var
2ef20 69 61 62 6c 65 20 61 6e 64 20 63 61 75 73 65 0a  iable and cause.
2ef30 2a 2a 20 69 74 20 74 6f 20 70 6f 69 6e 74 20 74  ** it to point t
2ef40 6f 20 6d 65 6d 6f 72 79 20 6f 62 74 61 69 6e 65  o memory obtaine
2ef50 64 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f  d from [sqlite3_
2ef60 6d 61 6c 6c 6f 63 5d 2e 20 20 5e 46 75 72 74 68  malloc].  ^Furth
2ef70 65 72 6d 6f 72 65 2c 0a 2a 2a 20 74 68 65 20 5b  ermore,.** the [
2ef80 74 65 6d 70 5f 73 74 6f 72 65 5f 64 69 72 65 63  temp_store_direc
2ef90 74 6f 72 79 20 70 72 61 67 6d 61 5d 20 61 6c 77  tory pragma] alw
2efa0 61 79 73 20 61 73 73 75 6d 65 73 20 74 68 61 74  ays assumes that
2efb0 20 61 6e 79 20 73 74 72 69 6e 67 0a 2a 2a 20 74   any string.** t
2efc0 68 61 74 20 74 68 69 73 20 76 61 72 69 61 62 6c  hat this variabl
2efd0 65 20 70 6f 69 6e 74 73 20 74 6f 20 69 73 20 68  e points to is h
2efe0 65 6c 64 20 69 6e 20 6d 65 6d 6f 72 79 20 6f 62  eld in memory ob
2eff0 74 61 69 6e 65 64 20 66 72 6f 6d 20 0a 2a 2a 20  tained from .** 
2f000 5b 73 71 6c 69 74 65 33 5f 6d 61 6c 6c 6f 63 5d  [sqlite3_malloc]
2f010 20 61 6e 64 20 74 68 65 20 70 72 61 67 6d 61 20   and the pragma 
2f020 6d 61 79 20 61 74 74 65 6d 70 74 20 74 6f 20 66  may attempt to f
2f030 72 65 65 20 74 68 61 74 20 6d 65 6d 6f 72 79 0a  ree that memory.
2f040 2a 2a 20 75 73 69 6e 67 20 5b 73 71 6c 69 74 65  ** using [sqlite
2f050 33 5f 66 72 65 65 5d 2e 0a 2a 2a 20 48 65 6e 63  3_free]..** Henc
2f060 65 2c 20 69 66 20 74 68 69 73 20 76 61 72 69 61  e, if this varia
2f070 62 6c 65 20 69 73 20 6d 6f 64 69 66 69 65 64 20  ble is modified 
2f080 64 69 72 65 63 74 6c 79 2c 20 65 69 74 68 65 72  directly, either
2f090 20 69 74 20 73 68 6f 75 6c 64 20 62 65 0a 2a 2a   it should be.**
2f0a0 20 6d 61 64 65 20 4e 55 4c 4c 20 6f 72 20 6d 61   made NULL or ma
2f0b0 64 65 20 74 6f 20 70 6f 69 6e 74 20 74 6f 20 6d  de to point to m
2f0c0 65 6d 6f 72 79 20 6f 62 74 61 69 6e 65 64 20 66  emory obtained f
2f0d0 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 6d 61 6c  rom [sqlite3_mal
2f0e0 6c 6f 63 5d 0a 2a 2a 20 6f 72 20 65 6c 73 65 20  loc].** or else 
2f0f0 74 68 65 20 75 73 65 20 6f 66 20 74 68 65 20 5b  the use of the [
2f100 74 65 6d 70 5f 73 74 6f 72 65 5f 64 69 72 65 63  temp_store_direc
2f110 74 6f 72 79 20 70 72 61 67 6d 61 5d 20 73 68 6f  tory pragma] sho
2f120 75 6c 64 20 62 65 20 61 76 6f 69 64 65 64 2e 0a  uld be avoided..
2f130 2a 2f 0a 53 51 4c 49 54 45 5f 45 58 54 45 52 4e  */.SQLITE_EXTERN
2f140 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 5f 74   char *sqlite3_t
2f150 65 6d 70 5f 64 69 72 65 63 74 6f 72 79 3b 0a 0a  emp_directory;..
2f160 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20  /*.** CAPI3REF: 
2f170 54 65 73 74 20 46 6f 72 20 41 75 74 6f 2d 43 6f  Test For Auto-Co
2f180 6d 6d 69 74 20 4d 6f 64 65 0a 2a 2a 20 4b 45 59  mmit Mode.** KEY
2f190 57 4f 52 44 53 3a 20 7b 61 75 74 6f 63 6f 6d 6d  WORDS: {autocomm
2f1a0 69 74 20 6d 6f 64 65 7d 0a 2a 2a 0a 2a 2a 20 5e  it mode}.**.** ^
2f1b0 54 68 65 20 73 71 6c 69 74 65 33 5f 67 65 74 5f  The sqlite3_get_
2f1c0 61 75 74 6f 63 6f 6d 6d 69 74 28 29 20 69 6e 74  autocommit() int
2f1d0 65 72 66 61 63 65 20 72 65 74 75 72 6e 73 20 6e  erface returns n
2f1e0 6f 6e 2d 7a 65 72 6f 20 6f 72 0a 2a 2a 20 7a 65  on-zero or.** ze
2f1f0 72 6f 20 69 66 20 74 68 65 20 67 69 76 65 6e 20  ro if the given 
2f200 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
2f210 69 6f 6e 20 69 73 20 6f 72 20 69 73 20 6e 6f 74  ion is or is not
2f220 20 69 6e 20 61 75 74 6f 63 6f 6d 6d 69 74 20 6d   in autocommit m
2f230 6f 64 65 2c 0a 2a 2a 20 72 65 73 70 65 63 74 69  ode,.** respecti
2f240 76 65 6c 79 2e 20 20 5e 41 75 74 6f 63 6f 6d 6d  vely.  ^Autocomm
2f250 69 74 20 6d 6f 64 65 20 69 73 20 6f 6e 20 62 79  it mode is on by
2f260 20 64 65 66 61 75 6c 74 2e 0a 2a 2a 20 5e 41 75   default..** ^Au
2f270 74 6f 63 6f 6d 6d 69 74 20 6d 6f 64 65 20 69 73  tocommit mode is
2f280 20 64 69 73 61 62 6c 65 64 20 62 79 20 61 20 5b   disabled by a [
2f290 42 45 47 49 4e 5d 20 73 74 61 74 65 6d 65 6e 74  BEGIN] statement
2f2a0 2e 0a 2a 2a 20 5e 41 75 74 6f 63 6f 6d 6d 69 74  ..** ^Autocommit
2f2b0 20 6d 6f 64 65 20 69 73 20 72 65 2d 65 6e 61 62   mode is re-enab
2f2c0 6c 65 64 20 62 79 20 61 20 5b 43 4f 4d 4d 49 54  led by a [COMMIT
2f2d0 5d 20 6f 72 20 5b 52 4f 4c 4c 42 41 43 4b 5d 2e  ] or [ROLLBACK].
2f2e0 0a 2a 2a 0a 2a 2a 20 49 66 20 63 65 72 74 61 69  .**.** If certai
2f2f0 6e 20 6b 69 6e 64 73 20 6f 66 20 65 72 72 6f 72  n kinds of error
2f300 73 20 6f 63 63 75 72 20 6f 6e 20 61 20 73 74 61  s occur on a sta
2f310 74 65 6d 65 6e 74 20 77 69 74 68 69 6e 20 61 20  tement within a 
2f320 6d 75 6c 74 69 2d 73 74 61 74 65 6d 65 6e 74 0a  multi-statement.
2f330 2a 2a 20 74 72 61 6e 73 61 63 74 69 6f 6e 20 28  ** transaction (
2f340 65 72 72 6f 72 73 20 69 6e 63 6c 75 64 69 6e 67  errors including
2f350 20 5b 53 51 4c 49 54 45 5f 46 55 4c 4c 5d 2c 20   [SQLITE_FULL], 
2f360 5b 53 51 4c 49 54 45 5f 49 4f 45 52 52 5d 2c 0a  [SQLITE_IOERR],.
2f370 2a 2a 20 5b 53 51 4c 49 54 45 5f 4e 4f 4d 45 4d  ** [SQLITE_NOMEM
2f380 5d 2c 20 5b 53 51 4c 49 54 45 5f 42 55 53 59 5d  ], [SQLITE_BUSY]
2f390 2c 20 61 6e 64 20 5b 53 51 4c 49 54 45 5f 49 4e  , and [SQLITE_IN
2f3a0 54 45 52 52 55 50 54 5d 29 20 74 68 65 6e 20 74  TERRUPT]) then t
2f3b0 68 65 0a 2a 2a 20 74 72 61 6e 73 61 63 74 69 6f  he.** transactio
2f3c0 6e 20 6d 69 67 68 74 20 62 65 20 72 6f 6c 6c 65  n might be rolle
2f3d0 64 20 62 61 63 6b 20 61 75 74 6f 6d 61 74 69 63  d back automatic
2f3e0 61 6c 6c 79 2e 20 20 54 68 65 20 6f 6e 6c 79 20  ally.  The only 
2f3f0 77 61 79 20 74 6f 0a 2a 2a 20 66 69 6e 64 20 6f  way to.** find o
2f400 75 74 20 77 68 65 74 68 65 72 20 53 51 4c 69 74  ut whether SQLit
2f410 65 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20  e automatically 
2f420 72 6f 6c 6c 65 64 20 62 61 63 6b 20 74 68 65 20  rolled back the 
2f430 74 72 61 6e 73 61 63 74 69 6f 6e 20 61 66 74 65  transaction afte
2f440 72 0a 2a 2a 20 61 6e 20 65 72 72 6f 72 20 69 73  r.** an error is
2f450 20 74 6f 20 75 73 65 20 74 68 69 73 20 66 75 6e   to use this fun
2f460 63 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 49 66 20  ction..**.** If 
2f470 61 6e 6f 74 68 65 72 20 74 68 72 65 61 64 20 63  another thread c
2f480 68 61 6e 67 65 73 20 74 68 65 20 61 75 74 6f 63  hanges the autoc
2f490 6f 6d 6d 69 74 20 73 74 61 74 75 73 20 6f 66 20  ommit status of 
2f4a0 74 68 65 20 64 61 74 61 62 61 73 65 0a 2a 2a 20  the database.** 
2f4b0 63 6f 6e 6e 65 63 74 69 6f 6e 20 77 68 69 6c 65  connection while
2f4c0 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 69 73   this routine is
2f4d0 20 72 75 6e 6e 69 6e 67 2c 20 74 68 65 6e 20 74   running, then t
2f4e0 68 65 20 72 65 74 75 72 6e 20 76 61 6c 75 65 0a  he return value.
2f4f0 2a 2a 20 69 73 20 75 6e 64 65 66 69 6e 65 64 2e  ** is undefined.
2f500 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .*/.int sqlite3_
2f510 67 65 74 5f 61 75 74 6f 63 6f 6d 6d 69 74 28 73  get_autocommit(s
2f520 71 6c 69 74 65 33 2a 29 3b 0a 0a 2f 2a 0a 2a 2a  qlite3*);../*.**
2f530 20 43 41 50 49 33 52 45 46 3a 20 46 69 6e 64 20   CAPI3REF: Find 
2f540 54 68 65 20 44 61 74 61 62 61 73 65 20 48 61 6e  The Database Han
2f550 64 6c 65 20 4f 66 20 41 20 50 72 65 70 61 72 65  dle Of A Prepare
2f560 64 20 53 74 61 74 65 6d 65 6e 74 0a 2a 2a 0a 2a  d Statement.**.*
2f570 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 64  * ^The sqlite3_d
2f580 62 5f 68 61 6e 64 6c 65 20 69 6e 74 65 72 66 61  b_handle interfa
2f590 63 65 20 72 65 74 75 72 6e 73 20 74 68 65 20 5b  ce returns the [
2f5a0 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
2f5b0 69 6f 6e 5d 20 68 61 6e 64 6c 65 0a 2a 2a 20 74  ion] handle.** t
2f5c0 6f 20 77 68 69 63 68 20 61 20 5b 70 72 65 70 61  o which a [prepa
2f5d0 72 65 64 20 73 74 61 74 65 6d 65 6e 74 5d 20 62  red statement] b
2f5e0 65 6c 6f 6e 67 73 2e 20 20 5e 54 68 65 20 5b 64  elongs.  ^The [d
2f5f0 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
2f600 6f 6e 5d 0a 2a 2a 20 72 65 74 75 72 6e 65 64 20  on].** returned 
2f610 62 79 20 73 71 6c 69 74 65 33 5f 64 62 5f 68 61  by sqlite3_db_ha
2f620 6e 64 6c 65 20 69 73 20 74 68 65 20 73 61 6d 65  ndle is the same
2f630 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65   [database conne
2f640 63 74 69 6f 6e 5d 0a 2a 2a 20 74 68 61 74 20 77  ction].** that w
2f650 61 73 20 74 68 65 20 66 69 72 73 74 20 61 72 67  as the first arg
2f660 75 6d 65 6e 74 0a 2a 2a 20 74 6f 20 74 68 65 20  ument.** to the 
2f670 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72 65  [sqlite3_prepare
2f680 5f 76 32 28 29 5d 20 63 61 6c 6c 20 28 6f 72 20  _v2()] call (or 
2f690 69 74 73 20 76 61 72 69 61 6e 74 73 29 20 74 68  its variants) th
2f6a0 61 74 20 77 61 73 20 75 73 65 64 20 74 6f 0a 2a  at was used to.*
2f6b0 2a 20 63 72 65 61 74 65 20 74 68 65 20 73 74 61  * create the sta
2f6c0 74 65 6d 65 6e 74 20 69 6e 20 74 68 65 20 66 69  tement in the fi
2f6d0 72 73 74 20 70 6c 61 63 65 2e 0a 2a 2f 0a 73 71  rst place..*/.sq
2f6e0 6c 69 74 65 33 20 2a 73 71 6c 69 74 65 33 5f 64  lite3 *sqlite3_d
2f6f0 62 5f 68 61 6e 64 6c 65 28 73 71 6c 69 74 65 33  b_handle(sqlite3
2f700 5f 73 74 6d 74 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20  _stmt*);../*.** 
2f710 43 41 50 49 33 52 45 46 3a 20 46 69 6e 64 20 74  CAPI3REF: Find t
2f720 68 65 20 6e 65 78 74 20 70 72 65 70 61 72 65 64  he next prepared
2f730 20 73 74 61 74 65 6d 65 6e 74 0a 2a 2a 0a 2a 2a   statement.**.**
2f740 20 5e 54 68 69 73 20 69 6e 74 65 72 66 61 63 65   ^This interface
2f750 20 72 65 74 75 72 6e 73 20 61 20 70 6f 69 6e 74   returns a point
2f760 65 72 20 74 6f 20 74 68 65 20 6e 65 78 74 20 5b  er to the next [
2f770 70 72 65 70 61 72 65 64 20 73 74 61 74 65 6d 65  prepared stateme
2f780 6e 74 5d 20 61 66 74 65 72 0a 2a 2a 20 70 53 74  nt] after.** pSt
2f790 6d 74 20 61 73 73 6f 63 69 61 74 65 64 20 77 69  mt associated wi
2f7a0 74 68 20 74 68 65 20 5b 64 61 74 61 62 61 73 65  th the [database
2f7b0 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 70 44 62   connection] pDb
2f7c0 2e 20 20 5e 49 66 20 70 53 74 6d 74 20 69 73 20  .  ^If pStmt is 
2f7d0 4e 55 4c 4c 0a 2a 2a 20 74 68 65 6e 20 74 68 69  NULL.** then thi
2f7e0 73 20 69 6e 74 65 72 66 61 63 65 20 72 65 74 75  s interface retu
2f7f0 72 6e 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f  rns a pointer to
2f800 20 74 68 65 20 66 69 72 73 74 20 70 72 65 70 61   the first prepa
2f810 72 65 64 20 73 74 61 74 65 6d 65 6e 74 0a 2a 2a  red statement.**
2f820 20 61 73 73 6f 63 69 61 74 65 64 20 77 69 74 68   associated with
2f830 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63 6f   the database co
2f840 6e 6e 65 63 74 69 6f 6e 20 70 44 62 2e 20 20 5e  nnection pDb.  ^
2f850 49 66 20 6e 6f 20 70 72 65 70 61 72 65 64 20 73  If no prepared s
2f860 74 61 74 65 6d 65 6e 74 0a 2a 2a 20 73 61 74 69  tatement.** sati
2f870 73 66 69 65 73 20 74 68 65 20 63 6f 6e 64 69 74  sfies the condit
2f880 69 6f 6e 73 20 6f 66 20 74 68 69 73 20 72 6f 75  ions of this rou
2f890 74 69 6e 65 2c 20 69 74 20 72 65 74 75 72 6e 73  tine, it returns
2f8a0 20 4e 55 4c 4c 2e 0a 2a 2a 0a 2a 2a 20 54 68 65   NULL..**.** The
2f8b0 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65   [database conne
2f8c0 63 74 69 6f 6e 5d 20 70 6f 69 6e 74 65 72 20 44  ction] pointer D
2f8d0 20 69 6e 20 61 20 63 61 6c 6c 20 74 6f 0a 2a 2a   in a call to.**
2f8e0 20 5b 73 71 6c 69 74 65 33 5f 6e 65 78 74 5f 73   [sqlite3_next_s
2f8f0 74 6d 74 28 44 2c 53 29 5d 20 6d 75 73 74 20 72  tmt(D,S)] must r
2f900 65 66 65 72 20 74 6f 20 61 6e 20 6f 70 65 6e 20  efer to an open 
2f910 64 61 74 61 62 61 73 65 0a 2a 2a 20 63 6f 6e 6e  database.** conn
2f920 65 63 74 69 6f 6e 20 61 6e 64 20 69 6e 20 70 61  ection and in pa
2f930 72 74 69 63 75 6c 61 72 20 6d 75 73 74 20 6e 6f  rticular must no
2f940 74 20 62 65 20 61 20 4e 55 4c 4c 20 70 6f 69 6e  t be a NULL poin
2f950 74 65 72 2e 0a 2a 2f 0a 73 71 6c 69 74 65 33 5f  ter..*/.sqlite3_
2f960 73 74 6d 74 20 2a 73 71 6c 69 74 65 33 5f 6e 65  stmt *sqlite3_ne
2f970 78 74 5f 73 74 6d 74 28 73 71 6c 69 74 65 33 20  xt_stmt(sqlite3 
2f980 2a 70 44 62 2c 20 73 71 6c 69 74 65 33 5f 73 74  *pDb, sqlite3_st
2f990 6d 74 20 2a 70 53 74 6d 74 29 3b 0a 0a 2f 2a 0a  mt *pStmt);../*.
2f9a0 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6f 6d  ** CAPI3REF: Com
2f9b0 6d 69 74 20 41 6e 64 20 52 6f 6c 6c 62 61 63 6b  mit And Rollback
2f9c0 20 4e 6f 74 69 66 69 63 61 74 69 6f 6e 20 43 61   Notification Ca
2f9d0 6c 6c 62 61 63 6b 73 0a 2a 2a 0a 2a 2a 20 5e 54  llbacks.**.** ^T
2f9e0 68 65 20 73 71 6c 69 74 65 33 5f 63 6f 6d 6d 69  he sqlite3_commi
2f9f0 74 5f 68 6f 6f 6b 28 29 20 69 6e 74 65 72 66 61  t_hook() interfa
2fa00 63 65 20 72 65 67 69 73 74 65 72 73 20 61 20 63  ce registers a c
2fa10 61 6c 6c 62 61 63 6b 0a 2a 2a 20 66 75 6e 63 74  allback.** funct
2fa20 69 6f 6e 20 74 6f 20 62 65 20 69 6e 76 6f 6b 65  ion to be invoke
2fa30 64 20 77 68 65 6e 65 76 65 72 20 61 20 74 72 61  d whenever a tra
2fa40 6e 73 61 63 74 69 6f 6e 20 69 73 20 5b 43 4f 4d  nsaction is [COM
2fa50 4d 49 54 20 7c 20 63 6f 6d 6d 69 74 74 65 64 5d  MIT | committed]
2fa60 2e 0a 2a 2a 20 5e 41 6e 79 20 63 61 6c 6c 62 61  ..** ^Any callba
2fa70 63 6b 20 73 65 74 20 62 79 20 61 20 70 72 65 76  ck set by a prev
2fa80 69 6f 75 73 20 63 61 6c 6c 20 74 6f 20 73 71 6c  ious call to sql
2fa90 69 74 65 33 5f 63 6f 6d 6d 69 74 5f 68 6f 6f 6b  ite3_commit_hook
2faa0 28 29 0a 2a 2a 20 66 6f 72 20 74 68 65 20 73 61  ().** for the sa
2fab0 6d 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  me database conn
2fac0 65 63 74 69 6f 6e 20 69 73 20 6f 76 65 72 72 69  ection is overri
2fad0 64 64 65 6e 2e 0a 2a 2a 20 5e 54 68 65 20 73 71  dden..** ^The sq
2fae0 6c 69 74 65 33 5f 72 6f 6c 6c 62 61 63 6b 5f 68  lite3_rollback_h
2faf0 6f 6f 6b 28 29 20 69 6e 74 65 72 66 61 63 65 20  ook() interface 
2fb00 72 65 67 69 73 74 65 72 73 20 61 20 63 61 6c 6c  registers a call
2fb10 62 61 63 6b 0a 2a 2a 20 66 75 6e 63 74 69 6f 6e  back.** function
2fb20 20 74 6f 20 62 65 20 69 6e 76 6f 6b 65 64 20 77   to be invoked w
2fb30 68 65 6e 65 76 65 72 20 61 20 74 72 61 6e 73 61  henever a transa
2fb40 63 74 69 6f 6e 20 69 73 20 5b 52 4f 4c 4c 42 41  ction is [ROLLBA
2fb50 43 4b 20 7c 20 72 6f 6c 6c 65 64 20 62 61 63 6b  CK | rolled back
2fb60 5d 2e 0a 2a 2a 20 5e 41 6e 79 20 63 61 6c 6c 62  ]..** ^Any callb
2fb70 61 63 6b 20 73 65 74 20 62 79 20 61 20 70 72 65  ack set by a pre
2fb80 76 69 6f 75 73 20 63 61 6c 6c 20 74 6f 20 73 71  vious call to sq
2fb90 6c 69 74 65 33 5f 72 6f 6c 6c 62 61 63 6b 5f 68  lite3_rollback_h
2fba0 6f 6f 6b 28 29 0a 2a 2a 20 66 6f 72 20 74 68 65  ook().** for the
2fbb0 20 73 61 6d 65 20 64 61 74 61 62 61 73 65 20 63   same database c
2fbc0 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 6f 76 65  onnection is ove
2fbd0 72 72 69 64 64 65 6e 2e 0a 2a 2a 20 5e 54 68 65  rridden..** ^The
2fbe0 20 70 41 72 67 20 61 72 67 75 6d 65 6e 74 20 69   pArg argument i
2fbf0 73 20 70 61 73 73 65 64 20 74 68 72 6f 75 67 68  s passed through
2fc00 20 74 6f 20 74 68 65 20 63 61 6c 6c 62 61 63 6b   to the callback
2fc10 2e 0a 2a 2a 20 5e 49 66 20 74 68 65 20 63 61 6c  ..** ^If the cal
2fc20 6c 62 61 63 6b 20 6f 6e 20 61 20 63 6f 6d 6d 69  lback on a commi
2fc30 74 20 68 6f 6f 6b 20 66 75 6e 63 74 69 6f 6e 20  t hook function 
2fc40 72 65 74 75 72 6e 73 20 6e 6f 6e 2d 7a 65 72 6f  returns non-zero
2fc50 2c 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20 63 6f  ,.** then the co
2fc60 6d 6d 69 74 20 69 73 20 63 6f 6e 76 65 72 74 65  mmit is converte
2fc70 64 20 69 6e 74 6f 20 61 20 72 6f 6c 6c 62 61 63  d into a rollbac
2fc80 6b 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71  k..**.** ^The sq
2fc90 6c 69 74 65 33 5f 63 6f 6d 6d 69 74 5f 68 6f 6f  lite3_commit_hoo
2fca0 6b 28 44 2c 43 2c 50 29 20 61 6e 64 20 73 71 6c  k(D,C,P) and sql
2fcb0 69 74 65 33 5f 72 6f 6c 6c 62 61 63 6b 5f 68 6f  ite3_rollback_ho
2fcc0 6f 6b 28 44 2c 43 2c 50 29 20 66 75 6e 63 74 69  ok(D,C,P) functi
2fcd0 6f 6e 73 0a 2a 2a 20 72 65 74 75 72 6e 20 74 68  ons.** return th
2fce0 65 20 50 20 61 72 67 75 6d 65 6e 74 20 66 72 6f  e P argument fro
2fcf0 6d 20 74 68 65 20 70 72 65 76 69 6f 75 73 20 63  m the previous c
2fd00 61 6c 6c 20 6f 66 20 74 68 65 20 73 61 6d 65 20  all of the same 
2fd10 66 75 6e 63 74 69 6f 6e 0a 2a 2a 20 6f 6e 20 74  function.** on t
2fd20 68 65 20 73 61 6d 65 20 5b 64 61 74 61 62 61 73  he same [databas
2fd30 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 44 2c  e connection] D,
2fd40 20 6f 72 20 4e 55 4c 4c 20 66 6f 72 0a 2a 2a 20   or NULL for.** 
2fd50 74 68 65 20 66 69 72 73 74 20 63 61 6c 6c 20 66  the first call f
2fd60 6f 72 20 65 61 63 68 20 66 75 6e 63 74 69 6f 6e  or each function
2fd70 20 6f 6e 20 44 2e 0a 2a 2a 0a 2a 2a 20 54 68 65   on D..**.** The
2fd80 20 63 61 6c 6c 62 61 63 6b 20 69 6d 70 6c 65 6d   callback implem
2fd90 65 6e 74 61 74 69 6f 6e 20 6d 75 73 74 20 6e 6f  entation must no
2fda0 74 20 64 6f 20 61 6e 79 74 68 69 6e 67 20 74 68  t do anything th
2fdb0 61 74 20 77 69 6c 6c 20 6d 6f 64 69 66 79 0a 2a  at will modify.*
2fdc0 2a 20 74 68 65 20 64 61 74 61 62 61 73 65 20 63  * the database c
2fdd0 6f 6e 6e 65 63 74 69 6f 6e 20 74 68 61 74 20 69  onnection that i
2fde0 6e 76 6f 6b 65 64 20 74 68 65 20 63 61 6c 6c 62  nvoked the callb
2fdf0 61 63 6b 2e 20 20 41 6e 79 20 61 63 74 69 6f 6e  ack.  Any action
2fe00 73 0a 2a 2a 20 74 6f 20 6d 6f 64 69 66 79 20 74  s.** to modify t
2fe10 68 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  he database conn
2fe20 65 63 74 69 6f 6e 20 6d 75 73 74 20 62 65 20 64  ection must be d
2fe30 65 66 65 72 72 65 64 20 75 6e 74 69 6c 20 61 66  eferred until af
2fe40 74 65 72 20 74 68 65 0a 2a 2a 20 63 6f 6d 70 6c  ter the.** compl
2fe50 65 74 69 6f 6e 20 6f 66 20 74 68 65 20 5b 73 71  etion of the [sq
2fe60 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 63 61  lite3_step()] ca
2fe70 6c 6c 20 74 68 61 74 20 74 72 69 67 67 65 72 65  ll that triggere
2fe80 64 20 74 68 65 20 63 6f 6d 6d 69 74 0a 2a 2a 20  d the commit.** 
2fe90 6f 72 20 72 6f 6c 6c 62 61 63 6b 20 68 6f 6f 6b  or rollback hook
2fea0 20 69 6e 20 74 68 65 20 66 69 72 73 74 20 70 6c   in the first pl
2feb0 61 63 65 2e 0a 2a 2a 20 4e 6f 74 65 20 74 68 61  ace..** Note tha
2fec0 74 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61  t [sqlite3_prepa
2fed0 72 65 5f 76 32 28 29 5d 20 61 6e 64 20 5b 73 71  re_v2()] and [sq
2fee0 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 62 6f  lite3_step()] bo
2fef0 74 68 20 6d 6f 64 69 66 79 20 74 68 65 69 72 0a  th modify their.
2ff00 2a 2a 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  ** database conn
2ff10 65 63 74 69 6f 6e 73 20 66 6f 72 20 74 68 65 20  ections for the 
2ff20 6d 65 61 6e 69 6e 67 20 6f 66 20 22 6d 6f 64 69  meaning of "modi
2ff30 66 79 22 20 69 6e 20 74 68 69 73 20 70 61 72 61  fy" in this para
2ff40 67 72 61 70 68 2e 0a 2a 2a 0a 2a 2a 20 5e 52 65  graph..**.** ^Re
2ff50 67 69 73 74 65 72 69 6e 67 20 61 20 4e 55 4c 4c  gistering a NULL
2ff60 20 66 75 6e 63 74 69 6f 6e 20 64 69 73 61 62 6c   function disabl
2ff70 65 73 20 74 68 65 20 63 61 6c 6c 62 61 63 6b 2e  es the callback.
2ff80 0a 2a 2a 0a 2a 2a 20 5e 57 68 65 6e 20 74 68 65  .**.** ^When the
2ff90 20 63 6f 6d 6d 69 74 20 68 6f 6f 6b 20 63 61 6c   commit hook cal
2ffa0 6c 62 61 63 6b 20 72 6f 75 74 69 6e 65 20 72 65  lback routine re
2ffb0 74 75 72 6e 73 20 7a 65 72 6f 2c 20 74 68 65 20  turns zero, the 
2ffc0 5b 43 4f 4d 4d 49 54 5d 0a 2a 2a 20 6f 70 65 72  [COMMIT].** oper
2ffd0 61 74 69 6f 6e 20 69 73 20 61 6c 6c 6f 77 65 64  ation is allowed
2ffe0 20 74 6f 20 63 6f 6e 74 69 6e 75 65 20 6e 6f 72   to continue nor
2fff0 6d 61 6c 6c 79 2e 20 20 5e 49 66 20 74 68 65 20  mally.  ^If the 
30000 63 6f 6d 6d 69 74 20 68 6f 6f 6b 0a 2a 2a 20 72  commit hook.** r
30010 65 74 75 72 6e 73 20 6e 6f 6e 2d 7a 65 72 6f 2c  eturns non-zero,
30020 20 74 68 65 6e 20 74 68 65 20 5b 43 4f 4d 4d 49   then the [COMMI
30030 54 5d 20 69 73 20 63 6f 6e 76 65 72 74 65 64 20  T] is converted 
30040 69 6e 74 6f 20 61 20 5b 52 4f 4c 4c 42 41 43 4b  into a [ROLLBACK
30050 5d 2e 0a 2a 2a 20 5e 54 68 65 20 72 6f 6c 6c 62  ]..** ^The rollb
30060 61 63 6b 20 68 6f 6f 6b 20 69 73 20 69 6e 76 6f  ack hook is invo
30070 6b 65 64 20 6f 6e 20 61 20 72 6f 6c 6c 62 61 63  ked on a rollbac
30080 6b 20 74 68 61 74 20 72 65 73 75 6c 74 73 20 66  k that results f
30090 72 6f 6d 20 61 20 63 6f 6d 6d 69 74 0a 2a 2a 20  rom a commit.** 
300a0 68 6f 6f 6b 20 72 65 74 75 72 6e 69 6e 67 20 6e  hook returning n
300b0 6f 6e 2d 7a 65 72 6f 2c 20 6a 75 73 74 20 61 73  on-zero, just as
300c0 20 69 74 20 77 6f 75 6c 64 20 62 65 20 77 69 74   it would be wit
300d0 68 20 61 6e 79 20 6f 74 68 65 72 20 72 6f 6c 6c  h any other roll
300e0 62 61 63 6b 2e 0a 2a 2a 0a 2a 2a 20 5e 46 6f 72  back..**.** ^For
300f0 20 74 68 65 20 70 75 72 70 6f 73 65 73 20 6f 66   the purposes of
30100 20 74 68 69 73 20 41 50 49 2c 20 61 20 74 72 61   this API, a tra
30110 6e 73 61 63 74 69 6f 6e 20 69 73 20 73 61 69 64  nsaction is said
30120 20 74 6f 20 68 61 76 65 20 62 65 65 6e 0a 2a 2a   to have been.**
30130 20 72 6f 6c 6c 65 64 20 62 61 63 6b 20 69 66 20   rolled back if 
30140 61 6e 20 65 78 70 6c 69 63 69 74 20 22 52 4f 4c  an explicit "ROL
30150 4c 42 41 43 4b 22 20 73 74 61 74 65 6d 65 6e 74  LBACK" statement
30160 20 69 73 20 65 78 65 63 75 74 65 64 2c 20 6f 72   is executed, or
30170 0a 2a 2a 20 61 6e 20 65 72 72 6f 72 20 6f 72 20  .** an error or 
30180 63 6f 6e 73 74 72 61 69 6e 74 20 63 61 75 73 65  constraint cause
30190 73 20 61 6e 20 69 6d 70 6c 69 63 69 74 20 72 6f  s an implicit ro
301a0 6c 6c 62 61 63 6b 20 74 6f 20 6f 63 63 75 72 2e  llback to occur.
301b0 0a 2a 2a 20 5e 54 68 65 20 72 6f 6c 6c 62 61 63  .** ^The rollbac
301c0 6b 20 63 61 6c 6c 62 61 63 6b 20 69 73 20 6e 6f  k callback is no
301d0 74 20 69 6e 76 6f 6b 65 64 20 69 66 20 61 20 74  t invoked if a t
301e0 72 61 6e 73 61 63 74 69 6f 6e 20 69 73 0a 2a 2a  ransaction is.**
301f0 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 72   automatically r
30200 6f 6c 6c 65 64 20 62 61 63 6b 20 62 65 63 61 75  olled back becau
30210 73 65 20 74 68 65 20 64 61 74 61 62 61 73 65 20  se the database 
30220 63 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 63 6c  connection is cl
30230 6f 73 65 64 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20  osed..**.** See 
30240 61 6c 73 6f 20 74 68 65 20 5b 73 71 6c 69 74 65  also the [sqlite
30250 33 5f 75 70 64 61 74 65 5f 68 6f 6f 6b 28 29 5d  3_update_hook()]
30260 20 69 6e 74 65 72 66 61 63 65 2e 0a 2a 2f 0a 76   interface..*/.v
30270 6f 69 64 20 2a 73 71 6c 69 74 65 33 5f 63 6f 6d  oid *sqlite3_com
30280 6d 69 74 5f 68 6f 6f 6b 28 73 71 6c 69 74 65 33  mit_hook(sqlite3
30290 2a 2c 20 69 6e 74 28 2a 29 28 76 6f 69 64 2a 29  *, int(*)(void*)
302a0 2c 20 76 6f 69 64 2a 29 3b 0a 76 6f 69 64 20 2a  , void*);.void *
302b0 73 71 6c 69 74 65 33 5f 72 6f 6c 6c 62 61 63 6b  sqlite3_rollback
302c0 5f 68 6f 6f 6b 28 73 71 6c 69 74 65 33 2a 2c 20  _hook(sqlite3*, 
302d0 76 6f 69 64 28 2a 29 28 76 6f 69 64 20 2a 29 2c  void(*)(void *),
302e0 20 76 6f 69 64 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20   void*);../*.** 
302f0 43 41 50 49 33 52 45 46 3a 20 44 61 74 61 20 43  CAPI3REF: Data C
30300 68 61 6e 67 65 20 4e 6f 74 69 66 69 63 61 74 69  hange Notificati
30310 6f 6e 20 43 61 6c 6c 62 61 63 6b 73 0a 2a 2a 0a  on Callbacks.**.
30320 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f  ** ^The sqlite3_
30330 75 70 64 61 74 65 5f 68 6f 6f 6b 28 29 20 69 6e  update_hook() in
30340 74 65 72 66 61 63 65 20 72 65 67 69 73 74 65 72  terface register
30350 73 20 61 20 63 61 6c 6c 62 61 63 6b 20 66 75 6e  s a callback fun
30360 63 74 69 6f 6e 0a 2a 2a 20 77 69 74 68 20 74 68  ction.** with th
30370 65 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  e [database conn
30380 65 63 74 69 6f 6e 5d 20 69 64 65 6e 74 69 66 69  ection] identifi
30390 65 64 20 62 79 20 74 68 65 20 66 69 72 73 74 20  ed by the first 
303a0 61 72 67 75 6d 65 6e 74 0a 2a 2a 20 74 6f 20 62  argument.** to b
303b0 65 20 69 6e 76 6f 6b 65 64 20 77 68 65 6e 65 76  e invoked whenev
303c0 65 72 20 61 20 72 6f 77 20 69 73 20 75 70 64 61  er a row is upda
303d0 74 65 64 2c 20 69 6e 73 65 72 74 65 64 20 6f 72  ted, inserted or
303e0 20 64 65 6c 65 74 65 64 2e 0a 2a 2a 20 5e 41 6e   deleted..** ^An
303f0 79 20 63 61 6c 6c 62 61 63 6b 20 73 65 74 20 62  y callback set b
30400 79 20 61 20 70 72 65 76 69 6f 75 73 20 63 61 6c  y a previous cal
30410 6c 20 74 6f 20 74 68 69 73 20 66 75 6e 63 74 69  l to this functi
30420 6f 6e 0a 2a 2a 20 66 6f 72 20 74 68 65 20 73 61  on.** for the sa
30430 6d 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  me database conn
30440 65 63 74 69 6f 6e 20 69 73 20 6f 76 65 72 72 69  ection is overri
30450 64 64 65 6e 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  dden..**.** ^The
30460 20 73 65 63 6f 6e 64 20 61 72 67 75 6d 65 6e 74   second argument
30470 20 69 73 20 61 20 70 6f 69 6e 74 65 72 20 74 6f   is a pointer to
30480 20 74 68 65 20 66 75 6e 63 74 69 6f 6e 20 74 6f   the function to
30490 20 69 6e 76 6f 6b 65 20 77 68 65 6e 20 61 0a 2a   invoke when a.*
304a0 2a 20 72 6f 77 20 69 73 20 75 70 64 61 74 65 64  * row is updated
304b0 2c 20 69 6e 73 65 72 74 65 64 20 6f 72 20 64 65  , inserted or de
304c0 6c 65 74 65 64 2e 0a 2a 2a 20 5e 54 68 65 20 66  leted..** ^The f
304d0 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f  irst argument to
304e0 20 74 68 65 20 63 61 6c 6c 62 61 63 6b 20 69 73   the callback is
304f0 20 61 20 63 6f 70 79 20 6f 66 20 74 68 65 20 74   a copy of the t
30500 68 69 72 64 20 61 72 67 75 6d 65 6e 74 0a 2a 2a  hird argument.**
30510 20 74 6f 20 73 71 6c 69 74 65 33 5f 75 70 64 61   to sqlite3_upda
30520 74 65 5f 68 6f 6f 6b 28 29 2e 0a 2a 2a 20 5e 54  te_hook()..** ^T
30530 68 65 20 73 65 63 6f 6e 64 20 63 61 6c 6c 62 61  he second callba
30540 63 6b 20 61 72 67 75 6d 65 6e 74 20 69 73 20 6f  ck argument is o
30550 6e 65 20 6f 66 20 5b 53 51 4c 49 54 45 5f 49 4e  ne of [SQLITE_IN
30560 53 45 52 54 5d 2c 20 5b 53 51 4c 49 54 45 5f 44  SERT], [SQLITE_D
30570 45 4c 45 54 45 5d 2c 0a 2a 2a 20 6f 72 20 5b 53  ELETE],.** or [S
30580 51 4c 49 54 45 5f 55 50 44 41 54 45 5d 2c 20 64  QLITE_UPDATE], d
30590 65 70 65 6e 64 69 6e 67 20 6f 6e 20 74 68 65 20  epending on the 
305a0 6f 70 65 72 61 74 69 6f 6e 20 74 68 61 74 20 63  operation that c
305b0 61 75 73 65 64 20 74 68 65 20 63 61 6c 6c 62 61  aused the callba
305c0 63 6b 0a 2a 2a 20 74 6f 20 62 65 20 69 6e 76 6f  ck.** to be invo
305d0 6b 65 64 2e 0a 2a 2a 20 5e 54 68 65 20 74 68 69  ked..** ^The thi
305e0 72 64 20 61 6e 64 20 66 6f 75 72 74 68 20 61 72  rd and fourth ar
305f0 67 75 6d 65 6e 74 73 20 74 6f 20 74 68 65 20 63  guments to the c
30600 61 6c 6c 62 61 63 6b 20 63 6f 6e 74 61 69 6e 20  allback contain 
30610 70 6f 69 6e 74 65 72 73 20 74 6f 20 74 68 65 0a  pointers to the.
30620 2a 2a 20 64 61 74 61 62 61 73 65 20 61 6e 64 20  ** database and 
30630 74 61 62 6c 65 20 6e 61 6d 65 20 63 6f 6e 74 61  table name conta
30640 69 6e 69 6e 67 20 74 68 65 20 61 66 66 65 63 74  ining the affect
30650 65 64 20 72 6f 77 2e 0a 2a 2a 20 5e 54 68 65 20  ed row..** ^The 
30660 66 69 6e 61 6c 20 63 61 6c 6c 62 61 63 6b 20 70  final callback p
30670 61 72 61 6d 65 74 65 72 20 69 73 20 74 68 65 20  arameter is the 
30680 5b 72 6f 77 69 64 5d 20 6f 66 20 74 68 65 20 72  [rowid] of the r
30690 6f 77 2e 0a 2a 2a 20 5e 49 6e 20 74 68 65 20 63  ow..** ^In the c
306a0 61 73 65 20 6f 66 20 61 6e 20 75 70 64 61 74 65  ase of an update
306b0 2c 20 74 68 69 73 20 69 73 20 74 68 65 20 5b 72  , this is the [r
306c0 6f 77 69 64 5d 20 61 66 74 65 72 20 74 68 65 20  owid] after the 
306d0 75 70 64 61 74 65 20 74 61 6b 65 73 20 70 6c 61  update takes pla
306e0 63 65 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20  ce..**.** ^(The 
306f0 75 70 64 61 74 65 20 68 6f 6f 6b 20 69 73 20 6e  update hook is n
30700 6f 74 20 69 6e 76 6f 6b 65 64 20 77 68 65 6e 20  ot invoked when 
30710 69 6e 74 65 72 6e 61 6c 20 73 79 73 74 65 6d 20  internal system 
30720 74 61 62 6c 65 73 20 61 72 65 0a 2a 2a 20 6d 6f  tables are.** mo
30730 64 69 66 69 65 64 20 28 69 2e 65 2e 20 73 71 6c  dified (i.e. sql
30740 69 74 65 5f 6d 61 73 74 65 72 20 61 6e 64 20 73  ite_master and s
30750 71 6c 69 74 65 5f 73 65 71 75 65 6e 63 65 29 2e  qlite_sequence).
30760 29 5e 0a 2a 2a 0a 2a 2a 20 5e 49 6e 20 74 68 65  )^.**.** ^In the
30770 20 63 75 72 72 65 6e 74 20 69 6d 70 6c 65 6d 65   current impleme
30780 6e 74 61 74 69 6f 6e 2c 20 74 68 65 20 75 70 64  ntation, the upd
30790 61 74 65 20 68 6f 6f 6b 0a 2a 2a 20 69 73 20 6e  ate hook.** is n
307a0 6f 74 20 69 6e 76 6f 6b 65 64 20 77 68 65 6e 20  ot invoked when 
307b0 64 75 70 6c 69 63 61 74 69 6f 6e 20 72 6f 77 73  duplication rows
307c0 20 61 72 65 20 64 65 6c 65 74 65 64 20 62 65 63   are deleted bec
307d0 61 75 73 65 20 6f 66 20 61 6e 0a 2a 2a 20 5b 4f  ause of an.** [O
307e0 4e 20 43 4f 4e 46 4c 49 43 54 20 7c 20 4f 4e 20  N CONFLICT | ON 
307f0 43 4f 4e 46 4c 49 43 54 20 52 45 50 4c 41 43 45  CONFLICT REPLACE
30800 5d 20 63 6c 61 75 73 65 2e 20 20 5e 4e 6f 72 20  ] clause.  ^Nor 
30810 69 73 20 74 68 65 20 75 70 64 61 74 65 20 68 6f  is the update ho
30820 6f 6b 0a 2a 2a 20 69 6e 76 6f 6b 65 64 20 77 68  ok.** invoked wh
30830 65 6e 20 72 6f 77 73 20 61 72 65 20 64 65 6c 65  en rows are dele
30840 74 65 64 20 75 73 69 6e 67 20 74 68 65 20 5b 74  ted using the [t
30850 72 75 6e 63 61 74 65 20 6f 70 74 69 6d 69 7a 61  runcate optimiza
30860 74 69 6f 6e 5d 2e 0a 2a 2a 20 54 68 65 20 65 78  tion]..** The ex
30870 63 65 70 74 69 6f 6e 73 20 64 65 66 69 6e 65 64  ceptions defined
30880 20 69 6e 20 74 68 69 73 20 70 61 72 61 67 72 61   in this paragra
30890 70 68 20 6d 69 67 68 74 20 63 68 61 6e 67 65 20  ph might change 
308a0 69 6e 20 61 20 66 75 74 75 72 65 0a 2a 2a 20 72  in a future.** r
308b0 65 6c 65 61 73 65 20 6f 66 20 53 51 4c 69 74 65  elease of SQLite
308c0 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 75 70 64 61  ..**.** The upda
308d0 74 65 20 68 6f 6f 6b 20 69 6d 70 6c 65 6d 65 6e  te hook implemen
308e0 74 61 74 69 6f 6e 20 6d 75 73 74 20 6e 6f 74 20  tation must not 
308f0 64 6f 20 61 6e 79 74 68 69 6e 67 20 74 68 61 74  do anything that
30900 20 77 69 6c 6c 20 6d 6f 64 69 66 79 0a 2a 2a 20   will modify.** 
30910 74 68 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e  the database con
30920 6e 65 63 74 69 6f 6e 20 74 68 61 74 20 69 6e 76  nection that inv
30930 6f 6b 65 64 20 74 68 65 20 75 70 64 61 74 65 20  oked the update 
30940 68 6f 6f 6b 2e 20 20 41 6e 79 20 61 63 74 69 6f  hook.  Any actio
30950 6e 73 0a 2a 2a 20 74 6f 20 6d 6f 64 69 66 79 20  ns.** to modify 
30960 74 68 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e  the database con
30970 6e 65 63 74 69 6f 6e 20 6d 75 73 74 20 62 65 20  nection must be 
30980 64 65 66 65 72 72 65 64 20 75 6e 74 69 6c 20 61  deferred until a
30990 66 74 65 72 20 74 68 65 0a 2a 2a 20 63 6f 6d 70  fter the.** comp
309a0 6c 65 74 69 6f 6e 20 6f 66 20 74 68 65 20 5b 73  letion of the [s
309b0 71 6c 69 74 65 33 5f 73 74 65 70 28 29 5d 20 63  qlite3_step()] c
309c0 61 6c 6c 20 74 68 61 74 20 74 72 69 67 67 65 72  all that trigger
309d0 65 64 20 74 68 65 20 75 70 64 61 74 65 20 68 6f  ed the update ho
309e0 6f 6b 2e 0a 2a 2a 20 4e 6f 74 65 20 74 68 61 74  ok..** Note that
309f0 20 5b 73 71 6c 69 74 65 33 5f 70 72 65 70 61 72   [sqlite3_prepar
30a00 65 5f 76 32 28 29 5d 20 61 6e 64 20 5b 73 71 6c  e_v2()] and [sql
30a10 69 74 65 33 5f 73 74 65 70 28 29 5d 20 62 6f 74  ite3_step()] bot
30a20 68 20 6d 6f 64 69 66 79 20 74 68 65 69 72 0a 2a  h modify their.*
30a30 2a 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65  * database conne
30a40 63 74 69 6f 6e 73 20 66 6f 72 20 74 68 65 20 6d  ctions for the m
30a50 65 61 6e 69 6e 67 20 6f 66 20 22 6d 6f 64 69 66  eaning of "modif
30a60 79 22 20 69 6e 20 74 68 69 73 20 70 61 72 61 67  y" in this parag
30a70 72 61 70 68 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65  raph..**.** ^The
30a80 20 73 71 6c 69 74 65 33 5f 75 70 64 61 74 65 5f   sqlite3_update_
30a90 68 6f 6f 6b 28 44 2c 43 2c 50 29 20 66 75 6e 63  hook(D,C,P) func
30aa0 74 69 6f 6e 0a 2a 2a 20 72 65 74 75 72 6e 73 20  tion.** returns 
30ab0 74 68 65 20 50 20 61 72 67 75 6d 65 6e 74 20 66  the P argument f
30ac0 72 6f 6d 20 74 68 65 20 70 72 65 76 69 6f 75 73  rom the previous
30ad0 20 63 61 6c 6c 0a 2a 2a 20 6f 6e 20 74 68 65 20   call.** on the 
30ae0 73 61 6d 65 20 5b 64 61 74 61 62 61 73 65 20 63  same [database c
30af0 6f 6e 6e 65 63 74 69 6f 6e 5d 20 44 2c 20 6f 72  onnection] D, or
30b00 20 4e 55 4c 4c 20 66 6f 72 0a 2a 2a 20 74 68 65   NULL for.** the
30b10 20 66 69 72 73 74 20 63 61 6c 6c 20 6f 6e 20 44   first call on D
30b20 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 61 6c 73 6f  ..**.** See also
30b30 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 63 6f   the [sqlite3_co
30b40 6d 6d 69 74 5f 68 6f 6f 6b 28 29 5d 20 61 6e 64  mmit_hook()] and
30b50 20 5b 73 71 6c 69 74 65 33 5f 72 6f 6c 6c 62 61   [sqlite3_rollba
30b60 63 6b 5f 68 6f 6f 6b 28 29 5d 0a 2a 2a 20 69 6e  ck_hook()].** in
30b70 74 65 72 66 61 63 65 73 2e 0a 2a 2f 0a 76 6f 69  terfaces..*/.voi
30b80 64 20 2a 73 71 6c 69 74 65 33 5f 75 70 64 61 74  d *sqlite3_updat
30b90 65 5f 68 6f 6f 6b 28 0a 20 20 73 71 6c 69 74 65  e_hook(.  sqlite
30ba0 33 2a 2c 20 0a 20 20 76 6f 69 64 28 2a 29 28 76  3*, .  void(*)(v
30bb0 6f 69 64 20 2a 2c 69 6e 74 20 2c 63 68 61 72 20  oid *,int ,char 
30bc0 63 6f 6e 73 74 20 2a 2c 63 68 61 72 20 63 6f 6e  const *,char con
30bd0 73 74 20 2a 2c 73 71 6c 69 74 65 33 5f 69 6e 74  st *,sqlite3_int
30be0 36 34 29 2c 0a 20 20 76 6f 69 64 2a 0a 29 3b 0a  64),.  void*.);.
30bf0 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a  ./*.** CAPI3REF:
30c00 20 45 6e 61 62 6c 65 20 4f 72 20 44 69 73 61 62   Enable Or Disab
30c10 6c 65 20 53 68 61 72 65 64 20 50 61 67 65 72 20  le Shared Pager 
30c20 43 61 63 68 65 0a 2a 2a 20 4b 45 59 57 4f 52 44  Cache.** KEYWORD
30c30 53 3a 20 7b 73 68 61 72 65 64 20 63 61 63 68 65  S: {shared cache
30c40 7d 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 69 73 20 72  }.**.** ^(This r
30c50 6f 75 74 69 6e 65 20 65 6e 61 62 6c 65 73 20 6f  outine enables o
30c60 72 20 64 69 73 61 62 6c 65 73 20 74 68 65 20 73  r disables the s
30c70 68 61 72 69 6e 67 20 6f 66 20 74 68 65 20 64 61  haring of the da
30c80 74 61 62 61 73 65 20 63 61 63 68 65 0a 2a 2a 20  tabase cache.** 
30c90 61 6e 64 20 73 63 68 65 6d 61 20 64 61 74 61 20  and schema data 
30ca0 73 74 72 75 63 74 75 72 65 73 20 62 65 74 77 65  structures betwe
30cb0 65 6e 20 5b 64 61 74 61 62 61 73 65 20 63 6f 6e  en [database con
30cc0 6e 65 63 74 69 6f 6e 20 7c 20 63 6f 6e 6e 65 63  nection | connec
30cd0 74 69 6f 6e 73 5d 0a 2a 2a 20 74 6f 20 74 68 65  tions].** to the
30ce0 20 73 61 6d 65 20 64 61 74 61 62 61 73 65 2e 20   same database. 
30cf0 53 68 61 72 69 6e 67 20 69 73 20 65 6e 61 62 6c  Sharing is enabl
30d00 65 64 20 69 66 20 74 68 65 20 61 72 67 75 6d 65  ed if the argume
30d10 6e 74 20 69 73 20 74 72 75 65 0a 2a 2a 20 61 6e  nt is true.** an
30d20 64 20 64 69 73 61 62 6c 65 64 20 69 66 20 74 68  d disabled if th
30d30 65 20 61 72 67 75 6d 65 6e 74 20 69 73 20 66 61  e argument is fa
30d40 6c 73 65 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 43 61  lse.)^.**.** ^Ca
30d50 63 68 65 20 73 68 61 72 69 6e 67 20 69 73 20 65  che sharing is e
30d60 6e 61 62 6c 65 64 20 61 6e 64 20 64 69 73 61 62  nabled and disab
30d70 6c 65 64 20 66 6f 72 20 61 6e 20 65 6e 74 69 72  led for an entir
30d80 65 20 70 72 6f 63 65 73 73 2e 0a 2a 2a 20 54 68  e process..** Th
30d90 69 73 20 69 73 20 61 20 63 68 61 6e 67 65 20 61  is is a change a
30da0 73 20 6f 66 20 53 51 4c 69 74 65 20 76 65 72 73  s of SQLite vers
30db0 69 6f 6e 20 33 2e 35 2e 30 2e 20 49 6e 20 70 72  ion 3.5.0. In pr
30dc0 69 6f 72 20 76 65 72 73 69 6f 6e 73 20 6f 66 20  ior versions of 
30dd0 53 51 4c 69 74 65 2c 0a 2a 2a 20 73 68 61 72 69  SQLite,.** shari
30de0 6e 67 20 77 61 73 20 65 6e 61 62 6c 65 64 20 6f  ng was enabled o
30df0 72 20 64 69 73 61 62 6c 65 64 20 66 6f 72 20 65  r disabled for e
30e00 61 63 68 20 74 68 72 65 61 64 20 73 65 70 61 72  ach thread separ
30e10 61 74 65 6c 79 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54  ately..**.** ^(T
30e20 68 65 20 63 61 63 68 65 20 73 68 61 72 69 6e 67  he cache sharing
30e30 20 6d 6f 64 65 20 73 65 74 20 62 79 20 74 68 69   mode set by thi
30e40 73 20 69 6e 74 65 72 66 61 63 65 20 65 66 66 65  s interface effe
30e50 63 74 73 20 61 6c 6c 20 73 75 62 73 65 71 75 65  cts all subseque
30e60 6e 74 0a 2a 2a 20 63 61 6c 6c 73 20 74 6f 20 5b  nt.** calls to [
30e70 73 71 6c 69 74 65 33 5f 6f 70 65 6e 28 29 5d 2c  sqlite3_open()],
30e80 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76   [sqlite3_open_v
30e90 32 28 29 5d 2c 20 61 6e 64 20 5b 73 71 6c 69 74  2()], and [sqlit
30ea0 65 33 5f 6f 70 65 6e 31 36 28 29 5d 2e 0a 2a 2a  e3_open16()]..**
30eb0 20 45 78 69 73 74 69 6e 67 20 64 61 74 61 62 61   Existing databa
30ec0 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 20 63  se connections c
30ed0 6f 6e 74 69 6e 75 65 20 75 73 65 20 74 68 65 20  ontinue use the 
30ee0 73 68 61 72 69 6e 67 20 6d 6f 64 65 0a 2a 2a 20  sharing mode.** 
30ef0 74 68 61 74 20 77 61 73 20 69 6e 20 65 66 66 65  that was in effe
30f00 63 74 20 61 74 20 74 68 65 20 74 69 6d 65 20 74  ct at the time t
30f10 68 65 79 20 77 65 72 65 20 6f 70 65 6e 65 64 2e  hey were opened.
30f20 29 5e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 69 73 20  )^.**.** ^(This 
30f30 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73 20  routine returns 
30f40 5b 53 51 4c 49 54 45 5f 4f 4b 5d 20 69 66 20 73  [SQLITE_OK] if s
30f50 68 61 72 65 64 20 63 61 63 68 65 20 77 61 73 20  hared cache was 
30f60 65 6e 61 62 6c 65 64 20 6f 72 20 64 69 73 61 62  enabled or disab
30f70 6c 65 64 0a 2a 2a 20 73 75 63 63 65 73 73 66 75  led.** successfu
30f80 6c 6c 79 2e 20 20 41 6e 20 5b 65 72 72 6f 72 20  lly.  An [error 
30f90 63 6f 64 65 5d 20 69 73 20 72 65 74 75 72 6e 65  code] is returne
30fa0 64 20 6f 74 68 65 72 77 69 73 65 2e 29 5e 0a 2a  d otherwise.)^.*
30fb0 2a 0a 2a 2a 20 5e 53 68 61 72 65 64 20 63 61 63  *.** ^Shared cac
30fc0 68 65 20 69 73 20 64 69 73 61 62 6c 65 64 20 62  he is disabled b
30fd0 79 20 64 65 66 61 75 6c 74 2e 20 42 75 74 20 74  y default. But t
30fe0 68 69 73 20 6d 69 67 68 74 20 63 68 61 6e 67 65  his might change
30ff0 20 69 6e 0a 2a 2a 20 66 75 74 75 72 65 20 72 65   in.** future re
31000 6c 65 61 73 65 73 20 6f 66 20 53 51 4c 69 74 65  leases of SQLite
31010 2e 20 20 41 70 70 6c 69 63 61 74 69 6f 6e 73 20  .  Applications 
31020 74 68 61 74 20 63 61 72 65 20 61 62 6f 75 74 20  that care about 
31030 73 68 61 72 65 64 0a 2a 2a 20 63 61 63 68 65 20  shared.** cache 
31040 73 65 74 74 69 6e 67 20 73 68 6f 75 6c 64 20 73  setting should s
31050 65 74 20 69 74 20 65 78 70 6c 69 63 69 74 6c 79  et it explicitly
31060 2e 0a 2a 2a 0a 2a 2a 20 53 65 65 20 41 6c 73 6f  ..**.** See Also
31070 3a 20 20 5b 53 51 4c 69 74 65 20 53 68 61 72 65  :  [SQLite Share
31080 64 2d 43 61 63 68 65 20 4d 6f 64 65 5d 0a 2a 2f  d-Cache Mode].*/
31090 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 65 6e 61  .int sqlite3_ena
310a0 62 6c 65 5f 73 68 61 72 65 64 5f 63 61 63 68 65  ble_shared_cache
310b0 28 69 6e 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41  (int);../*.** CA
310c0 50 49 33 52 45 46 3a 20 41 74 74 65 6d 70 74 20  PI3REF: Attempt 
310d0 54 6f 20 46 72 65 65 20 48 65 61 70 20 4d 65 6d  To Free Heap Mem
310e0 6f 72 79 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73  ory.**.** ^The s
310f0 71 6c 69 74 65 33 5f 72 65 6c 65 61 73 65 5f 6d  qlite3_release_m
31100 65 6d 6f 72 79 28 29 20 69 6e 74 65 72 66 61 63  emory() interfac
31110 65 20 61 74 74 65 6d 70 74 73 20 74 6f 20 66 72  e attempts to fr
31120 65 65 20 4e 20 62 79 74 65 73 0a 2a 2a 20 6f 66  ee N bytes.** of
31130 20 68 65 61 70 20 6d 65 6d 6f 72 79 20 62 79 20   heap memory by 
31140 64 65 61 6c 6c 6f 63 61 74 69 6e 67 20 6e 6f 6e  deallocating non
31150 2d 65 73 73 65 6e 74 69 61 6c 20 6d 65 6d 6f 72  -essential memor
31160 79 20 61 6c 6c 6f 63 61 74 69 6f 6e 73 0a 2a 2a  y allocations.**
31170 20 68 65 6c 64 20 62 79 20 74 68 65 20 64 61 74   held by the dat
31180 61 62 61 73 65 20 6c 69 62 72 61 72 79 2e 20 20  abase library.  
31190 20 4d 65 6d 6f 72 79 20 75 73 65 64 20 74 6f 20   Memory used to 
311a0 63 61 63 68 65 20 64 61 74 61 62 61 73 65 0a 2a  cache database.*
311b0 2a 20 70 61 67 65 73 20 74 6f 20 69 6d 70 72 6f  * pages to impro
311c0 76 65 20 70 65 72 66 6f 72 6d 61 6e 63 65 20 69  ve performance i
311d0 73 20 61 6e 20 65 78 61 6d 70 6c 65 20 6f 66 20  s an example of 
311e0 6e 6f 6e 2d 65 73 73 65 6e 74 69 61 6c 20 6d 65  non-essential me
311f0 6d 6f 72 79 2e 0a 2a 2a 20 5e 73 71 6c 69 74 65  mory..** ^sqlite
31200 33 5f 72 65 6c 65 61 73 65 5f 6d 65 6d 6f 72 79  3_release_memory
31210 28 29 20 72 65 74 75 72 6e 73 20 74 68 65 20 6e  () returns the n
31220 75 6d 62 65 72 20 6f 66 20 62 79 74 65 73 20 61  umber of bytes a
31230 63 74 75 61 6c 6c 79 20 66 72 65 65 64 2c 0a 2a  ctually freed,.*
31240 2a 20 77 68 69 63 68 20 6d 69 67 68 74 20 62 65  * which might be
31250 20 6d 6f 72 65 20 6f 72 20 6c 65 73 73 20 74 68   more or less th
31260 61 6e 20 74 68 65 20 61 6d 6f 75 6e 74 20 72 65  an the amount re
31270 71 75 65 73 74 65 64 2e 0a 2a 2a 20 5e 54 68 65  quested..** ^The
31280 20 73 71 6c 69 74 65 33 5f 72 65 6c 65 61 73 65   sqlite3_release
31290 5f 6d 65 6d 6f 72 79 28 29 20 72 6f 75 74 69 6e  _memory() routin
312a0 65 20 69 73 20 61 20 6e 6f 2d 6f 70 20 72 65 74  e is a no-op ret
312b0 75 72 6e 69 6e 67 20 7a 65 72 6f 0a 2a 2a 20 69  urning zero.** i
312c0 66 20 53 51 4c 69 74 65 20 69 73 20 6e 6f 74 20  f SQLite is not 
312d0 63 6f 6d 70 69 6c 65 64 20 77 69 74 68 20 5b 53  compiled with [S
312e0 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 4d 45 4d  QLITE_ENABLE_MEM
312f0 4f 52 59 5f 4d 41 4e 41 47 45 4d 45 4e 54 5d 2e  ORY_MANAGEMENT].
31300 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .*/.int sqlite3_
31310 72 65 6c 65 61 73 65 5f 6d 65 6d 6f 72 79 28 69  release_memory(i
31320 6e 74 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  nt);../*.** CAPI
31330 33 52 45 46 3a 20 49 6d 70 6f 73 65 20 41 20 4c  3REF: Impose A L
31340 69 6d 69 74 20 4f 6e 20 48 65 61 70 20 53 69 7a  imit On Heap Siz
31350 65 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 73 71 6c  e.**.** ^The sql
31360 69 74 65 33 5f 73 6f 66 74 5f 68 65 61 70 5f 6c  ite3_soft_heap_l
31370 69 6d 69 74 36 34 28 29 20 69 6e 74 65 72 66 61  imit64() interfa
31380 63 65 20 73 65 74 73 20 61 6e 64 2f 6f 72 20 71  ce sets and/or q
31390 75 65 72 69 65 73 20 74 68 65 0a 2a 2a 20 73 6f  ueries the.** so
313a0 66 74 20 6c 69 6d 69 74 20 6f 6e 20 74 68 65 20  ft limit on the 
313b0 61 6d 6f 75 6e 74 20 6f 66 20 68 65 61 70 20 6d  amount of heap m
313c0 65 6d 6f 72 79 20 74 68 61 74 20 6d 61 79 20 62  emory that may b
313d0 65 20 61 6c 6c 6f 63 61 74 65 64 20 62 79 20 53  e allocated by S
313e0 51 4c 69 74 65 2e 0a 2a 2a 20 5e 53 51 4c 69 74  QLite..** ^SQLit
313f0 65 20 73 74 72 69 76 65 73 20 74 6f 20 6b 65 65  e strives to kee
31400 70 20 68 65 61 70 20 6d 65 6d 6f 72 79 20 75 74  p heap memory ut
31410 69 6c 69 7a 61 74 69 6f 6e 20 62 65 6c 6f 77 20  ilization below 
31420 74 68 65 20 73 6f 66 74 20 68 65 61 70 0a 2a 2a  the soft heap.**
31430 20 6c 69 6d 69 74 20 62 79 20 72 65 64 75 63 69   limit by reduci
31440 6e 67 20 74 68 65 20 6e 75 6d 62 65 72 20 6f 66  ng the number of
31450 20 70 61 67 65 73 20 68 65 6c 64 20 69 6e 20 74   pages held in t
31460 68 65 20 70 61 67 65 20 63 61 63 68 65 0a 2a 2a  he page cache.**
31470 20 61 73 20 68 65 61 70 20 6d 65 6d 6f 72 79 20   as heap memory 
31480 75 73 61 67 65 73 20 61 70 70 72 6f 61 63 68 65  usages approache
31490 73 20 74 68 65 20 6c 69 6d 69 74 2e 0a 2a 2a 20  s the limit..** 
314a0 5e 54 68 65 20 73 6f 66 74 20 68 65 61 70 20 6c  ^The soft heap l
314b0 69 6d 69 74 20 69 73 20 22 73 6f 66 74 22 20 62  imit is "soft" b
314c0 65 63 61 75 73 65 20 65 76 65 6e 20 74 68 6f 75  ecause even thou
314d0 67 68 20 53 51 4c 69 74 65 20 73 74 72 69 76 65  gh SQLite strive
314e0 73 20 74 6f 20 73 74 61 79 0a 2a 2a 20 62 65 6c  s to stay.** bel
314f0 6f 77 20 74 68 65 20 6c 69 6d 69 74 2c 20 69 74  ow the limit, it
31500 20 77 69 6c 6c 20 65 78 63 65 65 64 20 74 68 65   will exceed the
31510 20 6c 69 6d 69 74 20 72 61 74 68 65 72 20 74 68   limit rather th
31520 61 6e 20 67 65 6e 65 72 61 74 65 0a 2a 2a 20 61  an generate.** a
31530 6e 20 5b 53 51 4c 49 54 45 5f 4e 4f 4d 45 4d 5d  n [SQLITE_NOMEM]
31540 20 65 72 72 6f 72 2e 20 20 49 6e 20 6f 74 68 65   error.  In othe
31550 72 20 77 6f 72 64 73 2c 20 74 68 65 20 73 6f 66  r words, the sof
31560 74 20 68 65 61 70 20 6c 69 6d 69 74 20 0a 2a 2a  t heap limit .**
31570 20 69 73 20 61 64 76 69 73 6f 72 79 20 6f 6e 6c   is advisory onl
31580 79 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 72 65  y..**.** ^The re
31590 74 75 72 6e 20 76 61 6c 75 65 20 66 72 6f 6d 20  turn value from 
315a0 73 71 6c 69 74 65 33 5f 73 6f 66 74 5f 68 65 61  sqlite3_soft_hea
315b0 70 5f 6c 69 6d 69 74 36 34 28 29 20 69 73 20 74  p_limit64() is t
315c0 68 65 20 73 69 7a 65 20 6f 66 0a 2a 2a 20 74 68  he size of.** th
315d0 65 20 73 6f 66 74 20 68 65 61 70 20 6c 69 6d 69  e soft heap limi
315e0 74 20 70 72 69 6f 72 20 74 6f 20 74 68 65 20 63  t prior to the c
315f0 61 6c 6c 2e 20 20 5e 49 66 20 74 68 65 20 61 72  all.  ^If the ar
31600 67 75 6d 65 6e 74 20 4e 20 69 73 20 6e 65 67 61  gument N is nega
31610 74 69 76 65 0a 2a 2a 20 74 68 65 6e 20 6e 6f 20  tive.** then no 
31620 63 68 61 6e 67 65 20 69 73 20 6d 61 64 65 20 74  change is made t
31630 6f 20 74 68 65 20 73 6f 66 74 20 68 65 61 70 20  o the soft heap 
31640 6c 69 6d 69 74 2e 20 20 48 65 6e 63 65 2c 20 74  limit.  Hence, t
31650 68 65 20 63 75 72 72 65 6e 74 0a 2a 2a 20 73 69  he current.** si
31660 7a 65 20 6f 66 20 74 68 65 20 73 6f 66 74 20 68  ze of the soft h
31670 65 61 70 20 6c 69 6d 69 74 20 63 61 6e 20 62 65  eap limit can be
31680 20 64 65 74 65 72 6d 69 6e 65 64 20 62 79 20 69   determined by i
31690 6e 76 6f 6b 69 6e 67 0a 2a 2a 20 73 71 6c 69 74  nvoking.** sqlit
316a0 65 33 5f 73 6f 66 74 5f 68 65 61 70 5f 6c 69 6d  e3_soft_heap_lim
316b0 69 74 36 34 28 29 20 77 69 74 68 20 61 20 6e 65  it64() with a ne
316c0 67 61 74 69 76 65 20 61 72 67 75 6d 65 6e 74 2e  gative argument.
316d0 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20 61  .**.** ^If the a
316e0 72 67 75 6d 65 6e 74 20 4e 20 69 73 20 7a 65 72  rgument N is zer
316f0 6f 20 74 68 65 6e 20 74 68 65 20 73 6f 66 74 20  o then the soft 
31700 68 65 61 70 20 6c 69 6d 69 74 20 69 73 20 64 69  heap limit is di
31710 73 61 62 6c 65 64 2e 0a 2a 2a 0a 2a 2a 20 5e 28  sabled..**.** ^(
31720 54 68 65 20 73 6f 66 74 20 68 65 61 70 20 6c 69  The soft heap li
31730 6d 69 74 20 69 73 20 6e 6f 74 20 65 6e 66 6f 72  mit is not enfor
31740 63 65 64 20 69 6e 20 74 68 65 20 63 75 72 72 65  ced in the curre
31750 6e 74 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f  nt implementatio
31760 6e 0a 2a 2a 20 69 66 20 6f 6e 65 20 6f 72 20 6d  n.** if one or m
31770 6f 72 65 20 6f 66 20 66 6f 6c 6c 6f 77 69 6e 67  ore of following
31780 20 63 6f 6e 64 69 74 69 6f 6e 73 20 61 72 65 20   conditions are 
31790 74 72 75 65 3a 0a 2a 2a 0a 2a 2a 20 3c 75 6c 3e  true:.**.** <ul>
317a0 0a 2a 2a 20 3c 6c 69 3e 20 54 68 65 20 73 6f 66  .** <li> The sof
317b0 74 20 68 65 61 70 20 6c 69 6d 69 74 20 69 73 20  t heap limit is 
317c0 73 65 74 20 74 6f 20 7a 65 72 6f 2e 0a 2a 2a 20  set to zero..** 
317d0 3c 6c 69 3e 20 4d 65 6d 6f 72 79 20 61 63 63 6f  <li> Memory acco
317e0 75 6e 74 69 6e 67 20 69 73 20 64 69 73 61 62 6c  unting is disabl
317f0 65 64 20 75 73 69 6e 67 20 61 20 63 6f 6d 62 69  ed using a combi
31800 6e 61 74 69 6f 6e 20 6f 66 20 74 68 65 0a 2a 2a  nation of the.**
31810 20 20 20 20 20 20 5b 73 71 6c 69 74 65 33 5f 63        [sqlite3_c
31820 6f 6e 66 69 67 5d 28 5b 53 51 4c 49 54 45 5f 43  onfig]([SQLITE_C
31830 4f 4e 46 49 47 5f 4d 45 4d 53 54 41 54 55 53 5d  ONFIG_MEMSTATUS]
31840 2c 2e 2e 2e 29 20 73 74 61 72 74 2d 74 69 6d 65  ,...) start-time
31850 20 6f 70 74 69 6f 6e 20 61 6e 64 0a 2a 2a 20 20   option and.**  
31860 20 20 20 20 74 68 65 20 5b 53 51 4c 49 54 45 5f      the [SQLITE_
31870 44 45 46 41 55 4c 54 5f 4d 45 4d 53 54 41 54 55  DEFAULT_MEMSTATU
31880 53 5d 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20  S] compile-time 
31890 6f 70 74 69 6f 6e 2e 0a 2a 2a 20 3c 6c 69 3e 20  option..** <li> 
318a0 41 6e 20 61 6c 74 65 72 6e 61 74 69 76 65 20 70  An alternative p
318b0 61 67 65 20 63 61 63 68 65 20 69 6d 70 6c 65 6d  age cache implem
318c0 65 6e 74 61 74 69 6f 6e 20 69 73 20 73 70 65 63  entation is spec
318d0 69 66 65 64 20 75 73 69 6e 67 0a 2a 2a 20 20 20  ifed using.**   
318e0 20 20 20 5b 73 71 6c 69 74 65 33 5f 63 6f 6e 66     [sqlite3_conf
318f0 69 67 5d 28 5b 53 51 4c 49 54 45 5f 43 4f 4e 46  ig]([SQLITE_CONF
31900 49 47 5f 50 43 41 43 48 45 5d 2c 2e 2e 2e 29 2e  IG_PCACHE],...).
31910 0a 2a 2a 20 3c 6c 69 3e 20 54 68 65 20 70 61 67  .** <li> The pag
31920 65 20 63 61 63 68 65 20 61 6c 6c 6f 63 61 74 65  e cache allocate
31930 73 20 66 72 6f 6d 20 69 74 73 20 6f 77 6e 20 6d  s from its own m
31940 65 6d 6f 72 79 20 70 6f 6f 6c 20 73 75 70 70 6c  emory pool suppl
31950 69 65 64 0a 2a 2a 20 20 20 20 20 20 62 79 20 5b  ied.**      by [
31960 73 71 6c 69 74 65 33 5f 63 6f 6e 66 69 67 5d 28  sqlite3_config](
31970 5b 53 51 4c 49 54 45 5f 43 4f 4e 46 49 47 5f 50  [SQLITE_CONFIG_P
31980 41 47 45 43 41 43 48 45 5d 2c 2e 2e 2e 29 20 72  AGECACHE],...) r
31990 61 74 68 65 72 20 74 68 61 6e 0a 2a 2a 20 20 20  ather than.**   
319a0 20 20 20 66 72 6f 6d 20 74 68 65 20 68 65 61 70     from the heap
319b0 2e 0a 2a 2a 20 3c 2f 75 6c 3e 29 5e 0a 2a 2a 0a  ..** </ul>)^.**.
319c0 2a 2a 20 42 65 67 69 6e 6e 69 6e 67 20 77 69 74  ** Beginning wit
319d0 68 20 53 51 4c 69 74 65 20 76 65 72 73 69 6f 6e  h SQLite version
319e0 20 33 2e 37 2e 33 2c 20 74 68 65 20 73 6f 66 74   3.7.3, the soft
319f0 20 68 65 61 70 20 6c 69 6d 69 74 20 69 73 20 65   heap limit is e
31a00 6e 66 6f 72 63 65 64 0a 2a 2a 20 72 65 67 61 72  nforced.** regar
31a10 64 6c 65 73 73 20 6f 66 20 77 68 65 74 68 65 72  dless of whether
31a20 20 6f 72 20 6e 6f 74 20 74 68 65 20 5b 53 51 4c   or not the [SQL
31a30 49 54 45 5f 45 4e 41 42 4c 45 5f 4d 45 4d 4f 52  ITE_ENABLE_MEMOR
31a40 59 5f 4d 41 4e 41 47 45 4d 45 4e 54 5d 0a 2a 2a  Y_MANAGEMENT].**
31a50 20 63 6f 6d 70 69 6c 65 2d 74 69 6d 65 20 6f 70   compile-time op
31a60 74 69 6f 6e 20 69 73 20 69 6e 76 6f 6b 65 64 2e  tion is invoked.
31a70 20 20 57 69 74 68 20 5b 53 51 4c 49 54 45 5f 45    With [SQLITE_E
31a80 4e 41 42 4c 45 5f 4d 45 4d 4f 52 59 5f 4d 41 4e  NABLE_MEMORY_MAN
31a90 41 47 45 4d 45 4e 54 5d 2c 0a 2a 2a 20 74 68 65  AGEMENT],.** the
31aa0 20 73 6f 66 74 20 68 65 61 70 20 6c 69 6d 69 74   soft heap limit
31ab0 20 69 73 20 65 6e 66 6f 72 63 65 64 20 6f 6e 20   is enforced on 
31ac0 65 76 65 72 79 20 6d 65 6d 6f 72 79 20 61 6c 6c  every memory all
31ad0 6f 63 61 74 69 6f 6e 2e 20 20 57 69 74 68 6f 75  ocation.  Withou
31ae0 74 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 45 4e 41  t.** [SQLITE_ENA
31af0 42 4c 45 5f 4d 45 4d 4f 52 59 5f 4d 41 4e 41 47  BLE_MEMORY_MANAG
31b00 45 4d 45 4e 54 5d 2c 20 74 68 65 20 73 6f 66 74  EMENT], the soft
31b10 20 68 65 61 70 20 6c 69 6d 69 74 20 69 73 20 6f   heap limit is o
31b20 6e 6c 79 20 65 6e 66 6f 72 63 65 64 0a 2a 2a 20  nly enforced.** 
31b30 77 68 65 6e 20 6d 65 6d 6f 72 79 20 69 73 20 61  when memory is a
31b40 6c 6c 6f 63 61 74 65 64 20 62 79 20 74 68 65 20  llocated by the 
31b50 70 61 67 65 20 63 61 63 68 65 2e 20 20 54 65 73  page cache.  Tes
31b60 74 69 6e 67 20 73 75 67 67 65 73 74 73 20 74 68  ting suggests th
31b70 61 74 20 62 65 63 61 75 73 65 0a 2a 2a 20 74 68  at because.** th
31b80 65 20 70 61 67 65 20 63 61 63 68 65 20 69 73 20  e page cache is 
31b90 74 68 65 20 70 72 65 64 6f 6d 69 6e 61 74 65 20  the predominate 
31ba0 6d 65 6d 6f 72 79 20 75 73 65 72 20 69 6e 20 53  memory user in S
31bb0 51 4c 69 74 65 2c 20 6d 6f 73 74 0a 2a 2a 20 61  QLite, most.** a
31bc0 70 70 6c 69 63 61 74 69 6f 6e 73 20 77 69 6c 6c  pplications will
31bd0 20 61 63 68 69 65 76 65 20 61 64 65 71 75 61 74   achieve adequat
31be0 65 20 73 6f 66 74 20 68 65 61 70 20 6c 69 6d 69  e soft heap limi
31bf0 74 20 65 6e 66 6f 72 63 65 6d 65 6e 74 20 77 69  t enforcement wi
31c00 74 68 6f 75 74 0a 2a 2a 20 74 68 65 20 75 73 65  thout.** the use
31c10 20 6f 66 20 5b 53 51 4c 49 54 45 5f 45 4e 41 42   of [SQLITE_ENAB
31c20 4c 45 5f 4d 45 4d 4f 52 59 5f 4d 41 4e 41 47 45  LE_MEMORY_MANAGE
31c30 4d 45 4e 54 5d 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  MENT]..**.** The
31c40 20 63 69 72 63 75 6d 73 74 61 6e 63 65 73 20 75   circumstances u
31c50 6e 64 65 72 20 77 68 69 63 68 20 53 51 4c 69 74  nder which SQLit
31c60 65 20 77 69 6c 6c 20 65 6e 66 6f 72 63 65 20 74  e will enforce t
31c70 68 65 20 73 6f 66 74 20 68 65 61 70 20 6c 69 6d  he soft heap lim
31c80 69 74 20 6d 61 79 0a 2a 2a 20 63 68 61 6e 67 65  it may.** change
31c90 73 20 69 6e 20 66 75 74 75 72 65 20 72 65 6c 65  s in future rele
31ca0 61 73 65 73 20 6f 66 20 53 51 4c 69 74 65 2e 0a  ases of SQLite..
31cb0 2a 2f 0a 73 71 6c 69 74 65 33 5f 69 6e 74 36 34  */.sqlite3_int64
31cc0 20 73 71 6c 69 74 65 33 5f 73 6f 66 74 5f 68 65   sqlite3_soft_he
31cd0 61 70 5f 6c 69 6d 69 74 36 34 28 73 71 6c 69 74  ap_limit64(sqlit
31ce0 65 33 5f 69 6e 74 36 34 20 4e 29 3b 0a 0a 2f 2a  e3_int64 N);../*
31cf0 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 44 65  .** CAPI3REF: De
31d00 70 72 65 63 61 74 65 64 20 53 6f 66 74 20 48 65  precated Soft He
31d10 61 70 20 4c 69 6d 69 74 20 49 6e 74 65 72 66 61  ap Limit Interfa
31d20 63 65 0a 2a 2a 20 44 45 50 52 45 43 41 54 45 44  ce.** DEPRECATED
31d30 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 69 73 20 61  .**.** This is a
31d40 20 64 65 70 72 65 63 61 74 65 64 20 76 65 72 73   deprecated vers
31d50 69 6f 6e 20 6f 66 20 74 68 65 20 5b 73 71 6c 69  ion of the [sqli
31d60 74 65 33 5f 73 6f 66 74 5f 68 65 61 70 5f 6c 69  te3_soft_heap_li
31d70 6d 69 74 36 34 28 29 5d 0a 2a 2a 20 69 6e 74 65  mit64()].** inte
31d80 72 66 61 63 65 2e 20 20 54 68 69 73 20 72 6f 75  rface.  This rou
31d90 74 69 6e 65 20 69 73 20 70 72 6f 76 69 64 65 64  tine is provided
31da0 20 66 6f 72 20 68 69 73 74 6f 72 69 63 61 6c 20   for historical 
31db0 63 6f 6d 70 61 74 69 62 69 6c 69 74 79 0a 2a 2a  compatibility.**
31dc0 20 6f 6e 6c 79 2e 20 20 41 6c 6c 20 6e 65 77 20   only.  All new 
31dd0 61 70 70 6c 69 63 61 74 69 6f 6e 73 20 73 68 6f  applications sho
31de0 75 6c 64 20 75 73 65 20 74 68 65 0a 2a 2a 20 5b  uld use the.** [
31df0 73 71 6c 69 74 65 33 5f 73 6f 66 74 5f 68 65 61  sqlite3_soft_hea
31e00 70 5f 6c 69 6d 69 74 36 34 28 29 5d 20 69 6e 74  p_limit64()] int
31e10 65 72 66 61 63 65 20 72 61 74 68 65 72 20 74 68  erface rather th
31e20 61 6e 20 74 68 69 73 20 6f 6e 65 2e 0a 2a 2f 0a  an this one..*/.
31e30 53 51 4c 49 54 45 5f 44 45 50 52 45 43 41 54 45  SQLITE_DEPRECATE
31e40 44 20 76 6f 69 64 20 73 71 6c 69 74 65 33 5f 73  D void sqlite3_s
31e50 6f 66 74 5f 68 65 61 70 5f 6c 69 6d 69 74 28 69  oft_heap_limit(i
31e60 6e 74 20 4e 29 3b 0a 0a 0a 2f 2a 0a 2a 2a 20 43  nt N);.../*.** C
31e70 41 50 49 33 52 45 46 3a 20 45 78 74 72 61 63 74  API3REF: Extract
31e80 20 4d 65 74 61 64 61 74 61 20 41 62 6f 75 74 20   Metadata About 
31e90 41 20 43 6f 6c 75 6d 6e 20 4f 66 20 41 20 54 61  A Column Of A Ta
31ea0 62 6c 65 0a 2a 2a 0a 2a 2a 20 5e 54 68 69 73 20  ble.**.** ^This 
31eb0 72 6f 75 74 69 6e 65 20 72 65 74 75 72 6e 73 20  routine returns 
31ec0 6d 65 74 61 64 61 74 61 20 61 62 6f 75 74 20 61  metadata about a
31ed0 20 73 70 65 63 69 66 69 63 20 63 6f 6c 75 6d 6e   specific column
31ee0 20 6f 66 20 61 20 73 70 65 63 69 66 69 63 0a 2a   of a specific.*
31ef0 2a 20 64 61 74 61 62 61 73 65 20 74 61 62 6c 65  * database table
31f00 20 61 63 63 65 73 73 69 62 6c 65 20 75 73 69 6e   accessible usin
31f10 67 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20  g the [database 
31f20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 68 61 6e 64  connection] hand
31f30 6c 65 0a 2a 2a 20 70 61 73 73 65 64 20 61 73 20  le.** passed as 
31f40 74 68 65 20 66 69 72 73 74 20 66 75 6e 63 74 69  the first functi
31f50 6f 6e 20 61 72 67 75 6d 65 6e 74 2e 0a 2a 2a 0a  on argument..**.
31f60 2a 2a 20 5e 54 68 65 20 63 6f 6c 75 6d 6e 20 69  ** ^The column i
31f70 73 20 69 64 65 6e 74 69 66 69 65 64 20 62 79 20  s identified by 
31f80 74 68 65 20 73 65 63 6f 6e 64 2c 20 74 68 69 72  the second, thir
31f90 64 20 61 6e 64 20 66 6f 75 72 74 68 20 70 61 72  d and fourth par
31fa0 61 6d 65 74 65 72 73 20 74 6f 0a 2a 2a 20 74 68  ameters to.** th
31fb0 69 73 20 66 75 6e 63 74 69 6f 6e 2e 20 5e 54 68  is function. ^Th
31fc0 65 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74  e second paramet
31fd0 65 72 20 69 73 20 65 69 74 68 65 72 20 74 68 65  er is either the
31fe0 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 64 61 74   name of the dat
31ff0 61 62 61 73 65 0a 2a 2a 20 28 69 2e 65 2e 20 22  abase.** (i.e. "
32000 6d 61 69 6e 22 2c 20 22 74 65 6d 70 22 2c 20 6f  main", "temp", o
32010 72 20 61 6e 20 61 74 74 61 63 68 65 64 20 64 61  r an attached da
32020 74 61 62 61 73 65 29 20 63 6f 6e 74 61 69 6e 69  tabase) containi
32030 6e 67 20 74 68 65 20 73 70 65 63 69 66 69 65 64  ng the specified
32040 0a 2a 2a 20 74 61 62 6c 65 20 6f 72 20 4e 55 4c  .** table or NUL
32050 4c 2e 20 5e 49 66 20 69 74 20 69 73 20 4e 55 4c  L. ^If it is NUL
32060 4c 2c 20 74 68 65 6e 20 61 6c 6c 20 61 74 74 61  L, then all atta
32070 63 68 65 64 20 64 61 74 61 62 61 73 65 73 20 61  ched databases a
32080 72 65 20 73 65 61 72 63 68 65 64 0a 2a 2a 20 66  re searched.** f
32090 6f 72 20 74 68 65 20 74 61 62 6c 65 20 75 73 69  or the table usi
320a0 6e 67 20 74 68 65 20 73 61 6d 65 20 61 6c 67 6f  ng the same algo
320b0 72 69 74 68 6d 20 75 73 65 64 20 62 79 20 74 68  rithm used by th
320c0 65 20 64 61 74 61 62 61 73 65 20 65 6e 67 69 6e  e database engin
320d0 65 20 74 6f 0a 2a 2a 20 72 65 73 6f 6c 76 65 20  e to.** resolve 
320e0 75 6e 71 75 61 6c 69 66 69 65 64 20 74 61 62 6c  unqualified tabl
320f0 65 20 72 65 66 65 72 65 6e 63 65 73 2e 0a 2a 2a  e references..**
32100 0a 2a 2a 20 5e 54 68 65 20 74 68 69 72 64 20 61  .** ^The third a
32110 6e 64 20 66 6f 75 72 74 68 20 70 61 72 61 6d 65  nd fourth parame
32120 74 65 72 73 20 74 6f 20 74 68 69 73 20 66 75 6e  ters to this fun
32130 63 74 69 6f 6e 20 61 72 65 20 74 68 65 20 74 61  ction are the ta
32140 62 6c 65 20 61 6e 64 20 63 6f 6c 75 6d 6e 0a 2a  ble and column.*
32150 2a 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 64 65  * name of the de
32160 73 69 72 65 64 20 63 6f 6c 75 6d 6e 2c 20 72 65  sired column, re
32170 73 70 65 63 74 69 76 65 6c 79 2e 20 4e 65 69 74  spectively. Neit
32180 68 65 72 20 6f 66 20 74 68 65 73 65 20 70 61 72  her of these par
32190 61 6d 65 74 65 72 73 0a 2a 2a 20 6d 61 79 20 62  ameters.** may b
321a0 65 20 4e 55 4c 4c 2e 0a 2a 2a 0a 2a 2a 20 5e 4d  e NULL..**.** ^M
321b0 65 74 61 64 61 74 61 20 69 73 20 72 65 74 75 72  etadata is retur
321c0 6e 65 64 20 62 79 20 77 72 69 74 69 6e 67 20 74  ned by writing t
321d0 6f 20 74 68 65 20 6d 65 6d 6f 72 79 20 6c 6f 63  o the memory loc
321e0 61 74 69 6f 6e 73 20 70 61 73 73 65 64 20 61 73  ations passed as
321f0 20 74 68 65 20 35 74 68 0a 2a 2a 20 61 6e 64 20   the 5th.** and 
32200 73 75 62 73 65 71 75 65 6e 74 20 70 61 72 61 6d  subsequent param
32210 65 74 65 72 73 20 74 6f 20 74 68 69 73 20 66 75  eters to this fu
32220 6e 63 74 69 6f 6e 2e 20 5e 41 6e 79 20 6f 66 20  nction. ^Any of 
32230 74 68 65 73 65 20 61 72 67 75 6d 65 6e 74 73 20  these arguments 
32240 6d 61 79 20 62 65 0a 2a 2a 20 4e 55 4c 4c 2c 20  may be.** NULL, 
32250 69 6e 20 77 68 69 63 68 20 63 61 73 65 20 74 68  in which case th
32260 65 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20  e corresponding 
32270 65 6c 65 6d 65 6e 74 20 6f 66 20 6d 65 74 61 64  element of metad
32280 61 74 61 20 69 73 20 6f 6d 69 74 74 65 64 2e 0a  ata is omitted..
32290 2a 2a 0a 2a 2a 20 5e 28 3c 62 6c 6f 63 6b 71 75  **.** ^(<blockqu
322a0 6f 74 65 3e 0a 2a 2a 20 3c 74 61 62 6c 65 20 62  ote>.** <table b
322b0 6f 72 64 65 72 3d 22 31 22 3e 0a 2a 2a 20 3c 74  order="1">.** <t
322c0 72 3e 3c 74 68 3e 20 50 61 72 61 6d 65 74 65 72  r><th> Parameter
322d0 20 3c 74 68 3e 20 4f 75 74 70 75 74 3c 62 72 3e   <th> Output<br>
322e0 54 79 70 65 20 3c 74 68 3e 20 20 44 65 73 63 72  Type <th>  Descr
322f0 69 70 74 69 6f 6e 0a 2a 2a 0a 2a 2a 20 3c 74 72  iption.**.** <tr
32300 3e 3c 74 64 3e 20 35 74 68 20 3c 74 64 3e 20 63  ><td> 5th <td> c
32310 6f 6e 73 74 20 63 68 61 72 2a 20 3c 74 64 3e 20  onst char* <td> 
32320 44 61 74 61 20 74 79 70 65 0a 2a 2a 20 3c 74 72  Data type.** <tr
32330 3e 3c 74 64 3e 20 36 74 68 20 3c 74 64 3e 20 63  ><td> 6th <td> c
32340 6f 6e 73 74 20 63 68 61 72 2a 20 3c 74 64 3e 20  onst char* <td> 
32350 4e 61 6d 65 20 6f 66 20 64 65 66 61 75 6c 74 20  Name of default 
32360 63 6f 6c 6c 61 74 69 6f 6e 20 73 65 71 75 65 6e  collation sequen
32370 63 65 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 37  ce.** <tr><td> 7
32380 74 68 20 3c 74 64 3e 20 69 6e 74 20 20 20 20 20  th <td> int     
32390 20 20 20 20 3c 74 64 3e 20 54 72 75 65 20 69 66      <td> True if
323a0 20 63 6f 6c 75 6d 6e 20 68 61 73 20 61 20 4e 4f   column has a NO
323b0 54 20 4e 55 4c 4c 20 63 6f 6e 73 74 72 61 69 6e  T NULL constrain
323c0 74 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 38 74  t.** <tr><td> 8t
323d0 68 20 3c 74 64 3e 20 69 6e 74 20 20 20 20 20 20  h <td> int      
323e0 20 20 20 3c 74 64 3e 20 54 72 75 65 20 69 66 20     <td> True if 
323f0 63 6f 6c 75 6d 6e 20 69 73 20 70 61 72 74 20 6f  column is part o
32400 66 20 74 68 65 20 50 52 49 4d 41 52 59 20 4b 45  f the PRIMARY KE
32410 59 0a 2a 2a 20 3c 74 72 3e 3c 74 64 3e 20 39 74  Y.** <tr><td> 9t
32420 68 20 3c 74 64 3e 20 69 6e 74 20 20 20 20 20 20  h <td> int      
32430 20 20 20 3c 74 64 3e 20 54 72 75 65 20 69 66 20     <td> True if 
32440 63 6f 6c 75 6d 6e 20 69 73 20 5b 41 55 54 4f 49  column is [AUTOI
32450 4e 43 52 45 4d 45 4e 54 5d 0a 2a 2a 20 3c 2f 74  NCREMENT].** </t
32460 61 62 6c 65 3e 0a 2a 2a 20 3c 2f 62 6c 6f 63 6b  able>.** </block
32470 71 75 6f 74 65 3e 29 5e 0a 2a 2a 0a 2a 2a 20 5e  quote>)^.**.** ^
32480 54 68 65 20 6d 65 6d 6f 72 79 20 70 6f 69 6e 74  The memory point
32490 65 64 20 74 6f 20 62 79 20 74 68 65 20 63 68 61  ed to by the cha
324a0 72 61 63 74 65 72 20 70 6f 69 6e 74 65 72 73 20  racter pointers 
324b0 72 65 74 75 72 6e 65 64 20 66 6f 72 20 74 68 65  returned for the
324c0 0a 2a 2a 20 64 65 63 6c 61 72 61 74 69 6f 6e 20  .** declaration 
324d0 74 79 70 65 20 61 6e 64 20 63 6f 6c 6c 61 74 69  type and collati
324e0 6f 6e 20 73 65 71 75 65 6e 63 65 20 69 73 20 76  on sequence is v
324f0 61 6c 69 64 20 6f 6e 6c 79 20 75 6e 74 69 6c 20  alid only until 
32500 74 68 65 20 6e 65 78 74 0a 2a 2a 20 63 61 6c 6c  the next.** call
32510 20 74 6f 20 61 6e 79 20 53 51 4c 69 74 65 20 41   to any SQLite A
32520 50 49 20 66 75 6e 63 74 69 6f 6e 2e 0a 2a 2a 0a  PI function..**.
32530 2a 2a 20 5e 49 66 20 74 68 65 20 73 70 65 63 69  ** ^If the speci
32540 66 69 65 64 20 74 61 62 6c 65 20 69 73 20 61 63  fied table is ac
32550 74 75 61 6c 6c 79 20 61 20 76 69 65 77 2c 20 61  tually a view, a
32560 6e 20 5b 65 72 72 6f 72 20 63 6f 64 65 5d 20 69  n [error code] i
32570 73 20 72 65 74 75 72 6e 65 64 2e 0a 2a 2a 0a 2a  s returned..**.*
32580 2a 20 5e 49 66 20 74 68 65 20 73 70 65 63 69 66  * ^If the specif
32590 69 65 64 20 63 6f 6c 75 6d 6e 20 69 73 20 22 72  ied column is "r
325a0 6f 77 69 64 22 2c 20 22 6f 69 64 22 20 6f 72 20  owid", "oid" or 
325b0 22 5f 72 6f 77 69 64 5f 22 20 61 6e 64 20 61 6e  "_rowid_" and an
325c0 0a 2a 2a 20 5b 49 4e 54 45 47 45 52 20 50 52 49  .** [INTEGER PRI
325d0 4d 41 52 59 20 4b 45 59 5d 20 63 6f 6c 75 6d 6e  MARY KEY] column
325e0 20 68 61 73 20 62 65 65 6e 20 65 78 70 6c 69 63   has been explic
325f0 69 74 6c 79 20 64 65 63 6c 61 72 65 64 2c 20 74  itly declared, t
32600 68 65 6e 20 74 68 65 20 6f 75 74 70 75 74 0a 2a  hen the output.*
32610 2a 20 70 61 72 61 6d 65 74 65 72 73 20 61 72 65  * parameters are
32620 20 73 65 74 20 66 6f 72 20 74 68 65 20 65 78 70   set for the exp
32630 6c 69 63 69 74 6c 79 20 64 65 63 6c 61 72 65 64  licitly declared
32640 20 63 6f 6c 75 6d 6e 2e 20 5e 28 49 66 20 74 68   column. ^(If th
32650 65 72 65 20 69 73 20 6e 6f 0a 2a 2a 20 65 78 70  ere is no.** exp
32660 6c 69 63 69 74 6c 79 20 64 65 63 6c 61 72 65 64  licitly declared
32670 20 5b 49 4e 54 45 47 45 52 20 50 52 49 4d 41 52   [INTEGER PRIMAR
32680 59 20 4b 45 59 5d 20 63 6f 6c 75 6d 6e 2c 20 74  Y KEY] column, t
32690 68 65 6e 20 74 68 65 20 6f 75 74 70 75 74 0a 2a  hen the output.*
326a0 2a 20 70 61 72 61 6d 65 74 65 72 73 20 61 72 65  * parameters are
326b0 20 73 65 74 20 61 73 20 66 6f 6c 6c 6f 77 73 3a   set as follows:
326c0 0a 2a 2a 0a 2a 2a 20 3c 70 72 65 3e 0a 2a 2a 20  .**.** <pre>.** 
326d0 20 20 20 20 64 61 74 61 20 74 79 70 65 3a 20 22      data type: "
326e0 49 4e 54 45 47 45 52 22 0a 2a 2a 20 20 20 20 20  INTEGER".**     
326f0 63 6f 6c 6c 61 74 69 6f 6e 20 73 65 71 75 65 6e  collation sequen
32700 63 65 3a 20 22 42 49 4e 41 52 59 22 0a 2a 2a 20  ce: "BINARY".** 
32710 20 20 20 20 6e 6f 74 20 6e 75 6c 6c 3a 20 30 0a      not null: 0.
32720 2a 2a 20 20 20 20 20 70 72 69 6d 61 72 79 20 6b  **     primary k
32730 65 79 3a 20 31 0a 2a 2a 20 20 20 20 20 61 75 74  ey: 1.**     aut
32740 6f 20 69 6e 63 72 65 6d 65 6e 74 3a 20 30 0a 2a  o increment: 0.*
32750 2a 20 3c 2f 70 72 65 3e 29 5e 0a 2a 2a 0a 2a 2a  * </pre>)^.**.**
32760 20 5e 28 54 68 69 73 20 66 75 6e 63 74 69 6f 6e   ^(This function
32770 20 6d 61 79 20 6c 6f 61 64 20 6f 6e 65 20 6f 72   may load one or
32780 20 6d 6f 72 65 20 73 63 68 65 6d 61 73 20 66 72   more schemas fr
32790 6f 6d 20 64 61 74 61 62 61 73 65 20 66 69 6c 65  om database file
327a0 73 2e 20 49 66 20 61 6e 0a 2a 2a 20 65 72 72 6f  s. If an.** erro
327b0 72 20 6f 63 63 75 72 73 20 64 75 72 69 6e 67 20  r occurs during 
327c0 74 68 69 73 20 70 72 6f 63 65 73 73 2c 20 6f 72  this process, or
327d0 20 69 66 20 74 68 65 20 72 65 71 75 65 73 74 65   if the requeste
327e0 64 20 74 61 62 6c 65 20 6f 72 20 63 6f 6c 75 6d  d table or colum
327f0 6e 0a 2a 2a 20 63 61 6e 6e 6f 74 20 62 65 20 66  n.** cannot be f
32800 6f 75 6e 64 2c 20 61 6e 20 5b 65 72 72 6f 72 20  ound, an [error 
32810 63 6f 64 65 5d 20 69 73 20 72 65 74 75 72 6e 65  code] is returne
32820 64 20 61 6e 64 20 61 6e 20 65 72 72 6f 72 20 6d  d and an error m
32830 65 73 73 61 67 65 20 6c 65 66 74 0a 2a 2a 20 69  essage left.** i
32840 6e 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20  n the [database 
32850 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20 28 74 6f 20  connection] (to 
32860 62 65 20 72 65 74 72 69 65 76 65 64 20 75 73 69  be retrieved usi
32870 6e 67 20 73 71 6c 69 74 65 33 5f 65 72 72 6d 73  ng sqlite3_errms
32880 67 28 29 29 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 54  g()).)^.**.** ^T
32890 68 69 73 20 41 50 49 20 69 73 20 6f 6e 6c 79 20  his API is only 
328a0 61 76 61 69 6c 61 62 6c 65 20 69 66 20 74 68 65  available if the
328b0 20 6c 69 62 72 61 72 79 20 77 61 73 20 63 6f 6d   library was com
328c0 70 69 6c 65 64 20 77 69 74 68 20 74 68 65 0a 2a  piled with the.*
328d0 2a 20 5b 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45  * [SQLITE_ENABLE
328e0 5f 43 4f 4c 55 4d 4e 5f 4d 45 54 41 44 41 54 41  _COLUMN_METADATA
328f0 5d 20 43 2d 70 72 65 70 72 6f 63 65 73 73 6f 72  ] C-preprocessor
32900 20 73 79 6d 62 6f 6c 20 64 65 66 69 6e 65 64 2e   symbol defined.
32910 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .*/.int sqlite3_
32920 74 61 62 6c 65 5f 63 6f 6c 75 6d 6e 5f 6d 65 74  table_column_met
32930 61 64 61 74 61 28 0a 20 20 73 71 6c 69 74 65 33  adata(.  sqlite3
32940 20 2a 64 62 2c 20 20 20 20 20 20 20 20 20 20 20   *db,           
32950 20 20 20 20 20 2f 2a 20 43 6f 6e 6e 65 63 74 69       /* Connecti
32960 6f 6e 20 68 61 6e 64 6c 65 20 2a 2f 0a 20 20 63  on handle */.  c
32970 6f 6e 73 74 20 63 68 61 72 20 2a 7a 44 62 4e 61  onst char *zDbNa
32980 6d 65 2c 20 20 20 20 20 20 20 20 2f 2a 20 44 61  me,        /* Da
32990 74 61 62 61 73 65 20 6e 61 6d 65 20 6f 72 20 4e  tabase name or N
329a0 55 4c 4c 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 63  ULL */.  const c
329b0 68 61 72 20 2a 7a 54 61 62 6c 65 4e 61 6d 65 2c  har *zTableName,
329c0 20 20 20 20 20 2f 2a 20 54 61 62 6c 65 20 6e 61       /* Table na
329d0 6d 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 63 68  me */.  const ch
329e0 61 72 20 2a 7a 43 6f 6c 75 6d 6e 4e 61 6d 65 2c  ar *zColumnName,
329f0 20 20 20 20 2f 2a 20 43 6f 6c 75 6d 6e 20 6e 61      /* Column na
32a00 6d 65 20 2a 2f 0a 20 20 63 68 61 72 20 63 6f 6e  me */.  char con
32a10 73 74 20 2a 2a 70 7a 44 61 74 61 54 79 70 65 2c  st **pzDataType,
32a20 20 20 20 20 2f 2a 20 4f 55 54 50 55 54 3a 20 44      /* OUTPUT: D
32a30 65 63 6c 61 72 65 64 20 64 61 74 61 20 74 79 70  eclared data typ
32a40 65 20 2a 2f 0a 20 20 63 68 61 72 20 63 6f 6e 73  e */.  char cons
32a50 74 20 2a 2a 70 7a 43 6f 6c 6c 53 65 71 2c 20 20  t **pzCollSeq,  
32a60 20 20 20 2f 2a 20 4f 55 54 50 55 54 3a 20 43 6f     /* OUTPUT: Co
32a70 6c 6c 61 74 69 6f 6e 20 73 65 71 75 65 6e 63 65  llation sequence
32a80 20 6e 61 6d 65 20 2a 2f 0a 20 20 69 6e 74 20 2a   name */.  int *
32a90 70 4e 6f 74 4e 75 6c 6c 2c 20 20 20 20 20 20 20  pNotNull,       
32aa0 20 20 20 20 20 20 20 2f 2a 20 4f 55 54 50 55 54         /* OUTPUT
32ab0 3a 20 54 72 75 65 20 69 66 20 4e 4f 54 20 4e 55  : True if NOT NU
32ac0 4c 4c 20 63 6f 6e 73 74 72 61 69 6e 74 20 65 78  LL constraint ex
32ad0 69 73 74 73 20 2a 2f 0a 20 20 69 6e 74 20 2a 70  ists */.  int *p
32ae0 50 72 69 6d 61 72 79 4b 65 79 2c 20 20 20 20 20  PrimaryKey,     
32af0 20 20 20 20 20 20 2f 2a 20 4f 55 54 50 55 54 3a        /* OUTPUT:
32b00 20 54 72 75 65 20 69 66 20 63 6f 6c 75 6d 6e 20   True if column 
32b10 70 61 72 74 20 6f 66 20 50 4b 20 2a 2f 0a 20 20  part of PK */.  
32b20 69 6e 74 20 2a 70 41 75 74 6f 69 6e 63 20 20 20  int *pAutoinc   
32b30 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 4f              /* O
32b40 55 54 50 55 54 3a 20 54 72 75 65 20 69 66 20 63  UTPUT: True if c
32b50 6f 6c 75 6d 6e 20 69 73 20 61 75 74 6f 2d 69 6e  olumn is auto-in
32b60 63 72 65 6d 65 6e 74 20 2a 2f 0a 29 3b 0a 0a 2f  crement */.);../
32b70 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 4c  *.** CAPI3REF: L
32b80 6f 61 64 20 41 6e 20 45 78 74 65 6e 73 69 6f 6e  oad An Extension
32b90 0a 2a 2a 0a 2a 2a 20 5e 54 68 69 73 20 69 6e 74  .**.** ^This int
32ba0 65 72 66 61 63 65 20 6c 6f 61 64 73 20 61 6e 20  erface loads an 
32bb0 53 51 4c 69 74 65 20 65 78 74 65 6e 73 69 6f 6e  SQLite extension
32bc0 20 6c 69 62 72 61 72 79 20 66 72 6f 6d 20 74 68   library from th
32bd0 65 20 6e 61 6d 65 64 20 66 69 6c 65 2e 0a 2a 2a  e named file..**
32be0 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33  .** ^The sqlite3
32bf0 5f 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f 6e 28  _load_extension(
32c00 29 20 69 6e 74 65 72 66 61 63 65 20 61 74 74 65  ) interface atte
32c10 6d 70 74 73 20 74 6f 20 6c 6f 61 64 20 61 6e 0a  mpts to load an.
32c20 2a 2a 20 53 51 4c 69 74 65 20 65 78 74 65 6e 73  ** SQLite extens
32c30 69 6f 6e 20 6c 69 62 72 61 72 79 20 63 6f 6e 74  ion library cont
32c40 61 69 6e 65 64 20 69 6e 20 74 68 65 20 66 69 6c  ained in the fil
32c50 65 20 7a 46 69 6c 65 2e 0a 2a 2a 0a 2a 2a 20 5e  e zFile..**.** ^
32c60 54 68 65 20 65 6e 74 72 79 20 70 6f 69 6e 74 20  The entry point 
32c70 69 73 20 7a 50 72 6f 63 2e 0a 2a 2a 20 5e 7a 50  is zProc..** ^zP
32c80 72 6f 63 20 6d 61 79 20 62 65 20 30 2c 20 69 6e  roc may be 0, in
32c90 20 77 68 69 63 68 20 63 61 73 65 20 74 68 65 20   which case the 
32ca0 6e 61 6d 65 20 6f 66 20 74 68 65 20 65 6e 74 72  name of the entr
32cb0 79 20 70 6f 69 6e 74 0a 2a 2a 20 64 65 66 61 75  y point.** defau
32cc0 6c 74 73 20 74 6f 20 22 73 71 6c 69 74 65 33 5f  lts to "sqlite3_
32cd0 65 78 74 65 6e 73 69 6f 6e 5f 69 6e 69 74 22 2e  extension_init".
32ce0 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65 33  .** ^The sqlite3
32cf0 5f 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f 6e 28  _load_extension(
32d00 29 20 69 6e 74 65 72 66 61 63 65 20 72 65 74 75  ) interface retu
32d10 72 6e 73 0a 2a 2a 20 5b 53 51 4c 49 54 45 5f 4f  rns.** [SQLITE_O
32d20 4b 5d 20 6f 6e 20 73 75 63 63 65 73 73 20 61 6e  K] on success an
32d30 64 20 5b 53 51 4c 49 54 45 5f 45 52 52 4f 52 5d  d [SQLITE_ERROR]
32d40 20 69 66 20 73 6f 6d 65 74 68 69 6e 67 20 67 6f   if something go
32d50 65 73 20 77 72 6f 6e 67 2e 0a 2a 2a 20 5e 49 66  es wrong..** ^If
32d60 20 61 6e 20 65 72 72 6f 72 20 6f 63 63 75 72 73   an error occurs
32d70 20 61 6e 64 20 70 7a 45 72 72 4d 73 67 20 69 73   and pzErrMsg is
32d80 20 6e 6f 74 20 30 2c 20 74 68 65 6e 20 74 68 65   not 0, then the
32d90 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f 6c 6f 61  .** [sqlite3_loa
32da0 64 5f 65 78 74 65 6e 73 69 6f 6e 28 29 5d 20 69  d_extension()] i
32db0 6e 74 65 72 66 61 63 65 20 73 68 61 6c 6c 20 61  nterface shall a
32dc0 74 74 65 6d 70 74 20 74 6f 0a 2a 2a 20 66 69 6c  ttempt to.** fil
32dd0 6c 20 2a 70 7a 45 72 72 4d 73 67 20 77 69 74 68  l *pzErrMsg with
32de0 20 65 72 72 6f 72 20 6d 65 73 73 61 67 65 20 74   error message t
32df0 65 78 74 20 73 74 6f 72 65 64 20 69 6e 20 6d 65  ext stored in me
32e00 6d 6f 72 79 0a 2a 2a 20 6f 62 74 61 69 6e 65 64  mory.** obtained
32e10 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 6d   from [sqlite3_m
32e20 61 6c 6c 6f 63 28 29 5d 2e 20 54 68 65 20 63 61  alloc()]. The ca
32e30 6c 6c 69 6e 67 20 66 75 6e 63 74 69 6f 6e 0a 2a  lling function.*
32e40 2a 20 73 68 6f 75 6c 64 20 66 72 65 65 20 74 68  * should free th
32e50 69 73 20 6d 65 6d 6f 72 79 20 62 79 20 63 61 6c  is memory by cal
32e60 6c 69 6e 67 20 5b 73 71 6c 69 74 65 33 5f 66 72  ling [sqlite3_fr
32e70 65 65 28 29 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 45 78  ee()]..**.** ^Ex
32e80 74 65 6e 73 69 6f 6e 20 6c 6f 61 64 69 6e 67 20  tension loading 
32e90 6d 75 73 74 20 62 65 20 65 6e 61 62 6c 65 64 20  must be enabled 
32ea0 75 73 69 6e 67 0a 2a 2a 20 5b 73 71 6c 69 74 65  using.** [sqlite
32eb0 33 5f 65 6e 61 62 6c 65 5f 6c 6f 61 64 5f 65 78  3_enable_load_ex
32ec0 74 65 6e 73 69 6f 6e 28 29 5d 20 70 72 69 6f 72  tension()] prior
32ed0 20 74 6f 20 63 61 6c 6c 69 6e 67 20 74 68 69 73   to calling this
32ee0 20 41 50 49 2c 0a 2a 2a 20 6f 74 68 65 72 77 69   API,.** otherwi
32ef0 73 65 20 61 6e 20 65 72 72 6f 72 20 77 69 6c 6c  se an error will
32f00 20 62 65 20 72 65 74 75 72 6e 65 64 2e 0a 2a 2a   be returned..**
32f10 0a 2a 2a 20 53 65 65 20 61 6c 73 6f 20 74 68 65  .** See also the
32f20 20 5b 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f 6e   [load_extension
32f30 28 29 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 5d  () SQL function]
32f40 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33  ..*/.int sqlite3
32f50 5f 6c 6f 61 64 5f 65 78 74 65 6e 73 69 6f 6e 28  _load_extension(
32f60 0a 20 20 73 71 6c 69 74 65 33 20 2a 64 62 2c 20  .  sqlite3 *db, 
32f70 20 20 20 20 20 20 20 20 20 2f 2a 20 4c 6f 61 64           /* Load
32f80 20 74 68 65 20 65 78 74 65 6e 73 69 6f 6e 20 69   the extension i
32f90 6e 74 6f 20 74 68 69 73 20 64 61 74 61 62 61 73  nto this databas
32fa0 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 2a 2f 0a  e connection */.
32fb0 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 46    const char *zF
32fc0 69 6c 65 2c 20 20 20 20 2f 2a 20 4e 61 6d 65 20  ile,    /* Name 
32fd0 6f 66 20 74 68 65 20 73 68 61 72 65 64 20 6c 69  of the shared li
32fe0 62 72 61 72 79 20 63 6f 6e 74 61 69 6e 69 6e 67  brary containing
32ff0 20 65 78 74 65 6e 73 69 6f 6e 20 2a 2f 0a 20 20   extension */.  
33000 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 50 72 6f  const char *zPro
33010 63 2c 20 20 20 20 2f 2a 20 45 6e 74 72 79 20 70  c,    /* Entry p
33020 6f 69 6e 74 2e 20 20 44 65 72 69 76 65 64 20 66  oint.  Derived f
33030 72 6f 6d 20 7a 46 69 6c 65 20 69 66 20 30 20 2a  rom zFile if 0 *
33040 2f 0a 20 20 63 68 61 72 20 2a 2a 70 7a 45 72 72  /.  char **pzErr
33050 4d 73 67 20 20 20 20 20 20 20 2f 2a 20 50 75 74  Msg       /* Put
33060 20 65 72 72 6f 72 20 6d 65 73 73 61 67 65 20 68   error message h
33070 65 72 65 20 69 66 20 6e 6f 74 20 30 20 2a 2f 0a  ere if not 0 */.
33080 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52  );../*.** CAPI3R
33090 45 46 3a 20 45 6e 61 62 6c 65 20 4f 72 20 44 69  EF: Enable Or Di
330a0 73 61 62 6c 65 20 45 78 74 65 6e 73 69 6f 6e 20  sable Extension 
330b0 4c 6f 61 64 69 6e 67 0a 2a 2a 0a 2a 2a 20 5e 53  Loading.**.** ^S
330c0 6f 20 61 73 20 6e 6f 74 20 74 6f 20 6f 70 65 6e  o as not to open
330d0 20 73 65 63 75 72 69 74 79 20 68 6f 6c 65 73 20   security holes 
330e0 69 6e 20 6f 6c 64 65 72 20 61 70 70 6c 69 63 61  in older applica
330f0 74 69 6f 6e 73 20 74 68 61 74 20 61 72 65 0a 2a  tions that are.*
33100 2a 20 75 6e 70 72 65 70 61 72 65 64 20 74 6f 20  * unprepared to 
33110 64 65 61 6c 20 77 69 74 68 20 65 78 74 65 6e 73  deal with extens
33120 69 6f 6e 20 6c 6f 61 64 69 6e 67 2c 20 61 6e 64  ion loading, and
33130 20 61 73 20 61 20 6d 65 61 6e 73 20 6f 66 20 64   as a means of d
33140 69 73 61 62 6c 69 6e 67 0a 2a 2a 20 65 78 74 65  isabling.** exte
33150 6e 73 69 6f 6e 20 6c 6f 61 64 69 6e 67 20 77 68  nsion loading wh
33160 69 6c 65 20 65 76 61 6c 75 61 74 69 6e 67 20 75  ile evaluating u
33170 73 65 72 2d 65 6e 74 65 72 65 64 20 53 51 4c 2c  ser-entered SQL,
33180 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 41   the following A
33190 50 49 0a 2a 2a 20 69 73 20 70 72 6f 76 69 64 65  PI.** is provide
331a0 64 20 74 6f 20 74 75 72 6e 20 74 68 65 20 5b 73  d to turn the [s
331b0 71 6c 69 74 65 33 5f 6c 6f 61 64 5f 65 78 74 65  qlite3_load_exte
331c0 6e 73 69 6f 6e 28 29 5d 20 6d 65 63 68 61 6e 69  nsion()] mechani
331d0 73 6d 20 6f 6e 20 61 6e 64 20 6f 66 66 2e 0a 2a  sm on and off..*
331e0 2a 0a 2a 2a 20 5e 45 78 74 65 6e 73 69 6f 6e 20  *.** ^Extension 
331f0 6c 6f 61 64 69 6e 67 20 69 73 20 6f 66 66 20 62  loading is off b
33200 79 20 64 65 66 61 75 6c 74 2e 20 53 65 65 20 74  y default. See t
33210 69 63 6b 65 74 20 23 31 38 36 33 2e 0a 2a 2a 20  icket #1863..** 
33220 5e 43 61 6c 6c 20 74 68 65 20 73 71 6c 69 74 65  ^Call the sqlite
33230 33 5f 65 6e 61 62 6c 65 5f 6c 6f 61 64 5f 65 78  3_enable_load_ex
33240 74 65 6e 73 69 6f 6e 28 29 20 72 6f 75 74 69 6e  tension() routin
33250 65 20 77 69 74 68 20 6f 6e 6f 66 66 3d 3d 31 0a  e with onoff==1.
33260 2a 2a 20 74 6f 20 74 75 72 6e 20 65 78 74 65 6e  ** to turn exten
33270 73 69 6f 6e 20 6c 6f 61 64 69 6e 67 20 6f 6e 20  sion loading on 
33280 61 6e 64 20 63 61 6c 6c 20 69 74 20 77 69 74 68  and call it with
33290 20 6f 6e 6f 66 66 3d 3d 30 20 74 6f 20 74 75 72   onoff==0 to tur
332a0 6e 0a 2a 2a 20 69 74 20 62 61 63 6b 20 6f 66 66  n.** it back off
332b0 20 61 67 61 69 6e 2e 0a 2a 2f 0a 69 6e 74 20 73   again..*/.int s
332c0 71 6c 69 74 65 33 5f 65 6e 61 62 6c 65 5f 6c 6f  qlite3_enable_lo
332d0 61 64 5f 65 78 74 65 6e 73 69 6f 6e 28 73 71 6c  ad_extension(sql
332e0 69 74 65 33 20 2a 64 62 2c 20 69 6e 74 20 6f 6e  ite3 *db, int on
332f0 6f 66 66 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  off);../*.** CAP
33300 49 33 52 45 46 3a 20 41 75 74 6f 6d 61 74 69 63  I3REF: Automatic
33310 61 6c 6c 79 20 4c 6f 61 64 20 53 74 61 74 69 63  ally Load Static
33320 61 6c 6c 79 20 4c 69 6e 6b 65 64 20 45 78 74 65  ally Linked Exte
33330 6e 73 69 6f 6e 73 0a 2a 2a 0a 2a 2a 20 5e 54 68  nsions.**.** ^Th
33340 69 73 20 69 6e 74 65 72 66 61 63 65 20 63 61 75  is interface cau
33350 73 65 73 20 74 68 65 20 78 45 6e 74 72 79 50 6f  ses the xEntryPo
33360 69 6e 74 28 29 20 66 75 6e 63 74 69 6f 6e 20 74  int() function t
33370 6f 20 62 65 20 69 6e 76 6f 6b 65 64 20 66 6f 72  o be invoked for
33380 0a 2a 2a 20 65 61 63 68 20 6e 65 77 20 5b 64 61  .** each new [da
33390 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
333a0 6e 5d 20 74 68 61 74 20 69 73 20 63 72 65 61 74  n] that is creat
333b0 65 64 2e 20 20 54 68 65 20 69 64 65 61 20 68 65  ed.  The idea he
333c0 72 65 20 69 73 20 74 68 61 74 0a 2a 2a 20 78 45  re is that.** xE
333d0 6e 74 72 79 50 6f 69 6e 74 28 29 20 69 73 20 74  ntryPoint() is t
333e0 68 65 20 65 6e 74 72 79 20 70 6f 69 6e 74 20 66  he entry point f
333f0 6f 72 20 61 20 73 74 61 74 69 63 61 6c 6c 79 20  or a statically 
33400 6c 69 6e 6b 65 64 20 53 51 4c 69 74 65 20 65 78  linked SQLite ex
33410 74 65 6e 73 69 6f 6e 0a 2a 2a 20 74 68 61 74 20  tension.** that 
33420 69 73 20 74 6f 20 62 65 20 61 75 74 6f 6d 61 74  is to be automat
33430 69 63 61 6c 6c 79 20 6c 6f 61 64 65 64 20 69 6e  ically loaded in
33440 74 6f 20 61 6c 6c 20 6e 65 77 20 64 61 74 61 62  to all new datab
33450 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 73 2e  ase connections.
33460 0a 2a 2a 0a 2a 2a 20 5e 28 45 76 65 6e 20 74 68  .**.** ^(Even th
33470 6f 75 67 68 20 74 68 65 20 66 75 6e 63 74 69 6f  ough the functio
33480 6e 20 70 72 6f 74 6f 74 79 70 65 20 73 68 6f 77  n prototype show
33490 73 20 74 68 61 74 20 78 45 6e 74 72 79 50 6f 69  s that xEntryPoi
334a0 6e 74 28 29 20 74 61 6b 65 73 0a 2a 2a 20 6e 6f  nt() takes.** no
334b0 20 61 72 67 75 6d 65 6e 74 73 20 61 6e 64 20 72   arguments and r
334c0 65 74 75 72 6e 73 20 76 6f 69 64 2c 20 53 51 4c  eturns void, SQL
334d0 69 74 65 20 69 6e 76 6f 6b 65 73 20 78 45 6e 74  ite invokes xEnt
334e0 72 79 50 6f 69 6e 74 28 29 20 77 69 74 68 20 74  ryPoint() with t
334f0 68 72 65 65 0a 2a 2a 20 61 72 67 75 6d 65 6e 74  hree.** argument
33500 73 20 61 6e 64 20 65 78 70 65 63 74 73 20 61 6e  s and expects an
33510 64 20 69 6e 74 65 67 65 72 20 72 65 73 75 6c 74  d integer result
33520 20 61 73 20 69 66 20 74 68 65 20 73 69 67 6e 61   as if the signa
33530 74 75 72 65 20 6f 66 20 74 68 65 0a 2a 2a 20 65  ture of the.** e
33540 6e 74 72 79 20 70 6f 69 6e 74 20 77 68 65 72 65  ntry point where
33550 20 61 73 20 66 6f 6c 6c 6f 77 73 3a 0a 2a 2a 0a   as follows:.**.
33560 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c  ** <blockquote><
33570 70 72 65 3e 0a 2a 2a 20 26 6e 62 73 70 3b 20 20  pre>.** &nbsp;  
33580 69 6e 74 20 78 45 6e 74 72 79 50 6f 69 6e 74 28  int xEntryPoint(
33590 0a 2a 2a 20 26 6e 62 73 70 3b 20 20 20 20 73 71  .** &nbsp;    sq
335a0 6c 69 74 65 33 20 2a 64 62 2c 0a 2a 2a 20 26 6e  lite3 *db,.** &n
335b0 62 73 70 3b 20 20 20 20 63 6f 6e 73 74 20 63 68  bsp;    const ch
335c0 61 72 20 2a 2a 70 7a 45 72 72 4d 73 67 2c 0a 2a  ar **pzErrMsg,.*
335d0 2a 20 26 6e 62 73 70 3b 20 20 20 20 63 6f 6e 73  * &nbsp;    cons
335e0 74 20 73 74 72 75 63 74 20 73 71 6c 69 74 65 33  t struct sqlite3
335f0 5f 61 70 69 5f 72 6f 75 74 69 6e 65 73 20 2a 70  _api_routines *p
33600 54 68 75 6e 6b 0a 2a 2a 20 26 6e 62 73 70 3b 20  Thunk.** &nbsp; 
33610 20 29 3b 0a 2a 2a 20 3c 2f 70 72 65 3e 3c 2f 62   );.** </pre></b
33620 6c 6f 63 6b 71 75 6f 74 65 3e 29 5e 0a 2a 2a 0a  lockquote>)^.**.
33630 2a 2a 20 49 66 20 74 68 65 20 78 45 6e 74 72 79  ** If the xEntry
33640 50 6f 69 6e 74 20 72 6f 75 74 69 6e 65 20 65 6e  Point routine en
33650 63 6f 75 6e 74 65 72 73 20 61 6e 20 65 72 72 6f  counters an erro
33660 72 2c 20 69 74 20 73 68 6f 75 6c 64 20 6d 61 6b  r, it should mak
33670 65 20 2a 70 7a 45 72 72 4d 73 67 0a 2a 2a 20 70  e *pzErrMsg.** p
33680 6f 69 6e 74 20 74 6f 20 61 6e 20 61 70 70 72 6f  oint to an appro
33690 70 72 69 61 74 65 20 65 72 72 6f 72 20 6d 65 73  priate error mes
336a0 73 61 67 65 20 28 6f 62 74 61 69 6e 65 64 20 66  sage (obtained f
336b0 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f 6d 70 72  rom [sqlite3_mpr
336c0 69 6e 74 66 28 29 5d 29 0a 2a 2a 20 61 6e 64 20  intf()]).** and 
336d0 72 65 74 75 72 6e 20 61 6e 20 61 70 70 72 6f 70  return an approp
336e0 72 69 61 74 65 20 5b 65 72 72 6f 72 20 63 6f 64  riate [error cod
336f0 65 5d 2e 20 20 5e 53 51 4c 69 74 65 20 65 6e 73  e].  ^SQLite ens
33700 75 72 65 73 20 74 68 61 74 20 2a 70 7a 45 72 72  ures that *pzErr
33710 4d 73 67 0a 2a 2a 20 69 73 20 4e 55 4c 4c 20 62  Msg.** is NULL b
33720 65 66 6f 72 65 20 63 61 6c 6c 69 6e 67 20 74 68  efore calling th
33730 65 20 78 45 6e 74 72 79 50 6f 69 6e 74 28 29 2e  e xEntryPoint().
33740 20 20 5e 53 51 4c 69 74 65 20 77 69 6c 6c 20 69    ^SQLite will i
33750 6e 76 6f 6b 65 0a 2a 2a 20 5b 73 71 6c 69 74 65  nvoke.** [sqlite
33760 33 5f 66 72 65 65 28 29 5d 20 6f 6e 20 2a 70 7a  3_free()] on *pz
33770 45 72 72 4d 73 67 20 61 66 74 65 72 20 78 45 6e  ErrMsg after xEn
33780 74 72 79 50 6f 69 6e 74 28 29 20 72 65 74 75 72  tryPoint() retur
33790 6e 73 2e 20 20 5e 49 66 20 61 6e 79 0a 2a 2a 20  ns.  ^If any.** 
337a0 78 45 6e 74 72 79 50 6f 69 6e 74 28 29 20 72 65  xEntryPoint() re
337b0 74 75 72 6e 73 20 61 6e 20 65 72 72 6f 72 2c 20  turns an error, 
337c0 74 68 65 20 5b 73 71 6c 69 74 65 33 5f 6f 70 65  the [sqlite3_ope
337d0 6e 28 29 5d 2c 20 5b 73 71 6c 69 74 65 33 5f 6f  n()], [sqlite3_o
337e0 70 65 6e 31 36 28 29 5d 2c 0a 2a 2a 20 6f 72 20  pen16()],.** or 
337f0 5b 73 71 6c 69 74 65 33 5f 6f 70 65 6e 5f 76 32  [sqlite3_open_v2
33800 28 29 5d 20 63 61 6c 6c 20 74 68 61 74 20 70 72  ()] call that pr
33810 6f 76 6f 6b 65 64 20 74 68 65 20 78 45 6e 74 72  ovoked the xEntr
33820 79 50 6f 69 6e 74 28 29 20 77 69 6c 6c 20 66 61  yPoint() will fa
33830 69 6c 2e 0a 2a 2a 0a 2a 2a 20 5e 43 61 6c 6c 69  il..**.** ^Calli
33840 6e 67 20 73 71 6c 69 74 65 33 5f 61 75 74 6f 5f  ng sqlite3_auto_
33850 65 78 74 65 6e 73 69 6f 6e 28 58 29 20 77 69 74  extension(X) wit
33860 68 20 61 6e 20 65 6e 74 72 79 20 70 6f 69 6e 74  h an entry point
33870 20 58 20 74 68 61 74 20 69 73 20 61 6c 72 65 61   X that is alrea
33880 64 79 0a 2a 2a 20 6f 6e 20 74 68 65 20 6c 69 73  dy.** on the lis
33890 74 20 6f 66 20 61 75 74 6f 6d 61 74 69 63 20 65  t of automatic e
338a0 78 74 65 6e 73 69 6f 6e 73 20 69 73 20 61 20 68  xtensions is a h
338b0 61 72 6d 6c 65 73 73 20 6e 6f 2d 6f 70 2e 20 5e  armless no-op. ^
338c0 4e 6f 20 65 6e 74 72 79 20 70 6f 69 6e 74 0a 2a  No entry point.*
338d0 2a 20 77 69 6c 6c 20 62 65 20 63 61 6c 6c 65 64  * will be called
338e0 20 6d 6f 72 65 20 74 68 61 6e 20 6f 6e 63 65 20   more than once 
338f0 66 6f 72 20 65 61 63 68 20 64 61 74 61 62 61 73  for each databas
33900 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 68 61  e connection tha
33910 74 20 69 73 20 6f 70 65 6e 65 64 2e 0a 2a 2a 0a  t is opened..**.
33920 2a 2a 20 53 65 65 20 61 6c 73 6f 3a 20 5b 73 71  ** See also: [sq
33930 6c 69 74 65 33 5f 72 65 73 65 74 5f 61 75 74 6f  lite3_reset_auto
33940 5f 65 78 74 65 6e 73 69 6f 6e 28 29 5d 2e 0a 2a  _extension()]..*
33950 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 61 75  /.int sqlite3_au
33960 74 6f 5f 65 78 74 65 6e 73 69 6f 6e 28 76 6f 69  to_extension(voi
33970 64 20 28 2a 78 45 6e 74 72 79 50 6f 69 6e 74 29  d (*xEntryPoint)
33980 28 76 6f 69 64 29 29 3b 0a 0a 2f 2a 0a 2a 2a 20  (void));../*.** 
33990 43 41 50 49 33 52 45 46 3a 20 52 65 73 65 74 20  CAPI3REF: Reset 
339a0 41 75 74 6f 6d 61 74 69 63 20 45 78 74 65 6e 73  Automatic Extens
339b0 69 6f 6e 20 4c 6f 61 64 69 6e 67 0a 2a 2a 0a 2a  ion Loading.**.*
339c0 2a 20 5e 54 68 69 73 20 69 6e 74 65 72 66 61 63  * ^This interfac
339d0 65 20 64 69 73 61 62 6c 65 73 20 61 6c 6c 20 61  e disables all a
339e0 75 74 6f 6d 61 74 69 63 20 65 78 74 65 6e 73 69  utomatic extensi
339f0 6f 6e 73 20 70 72 65 76 69 6f 75 73 6c 79 0a 2a  ons previously.*
33a00 2a 20 72 65 67 69 73 74 65 72 65 64 20 75 73 69  * registered usi
33a10 6e 67 20 5b 73 71 6c 69 74 65 33 5f 61 75 74 6f  ng [sqlite3_auto
33a20 5f 65 78 74 65 6e 73 69 6f 6e 28 29 5d 2e 0a 2a  _extension()]..*
33a30 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 5f 72  /.void sqlite3_r
33a40 65 73 65 74 5f 61 75 74 6f 5f 65 78 74 65 6e 73  eset_auto_extens
33a50 69 6f 6e 28 76 6f 69 64 29 3b 0a 0a 2f 2a 0a 2a  ion(void);../*.*
33a60 2a 20 54 68 65 20 69 6e 74 65 72 66 61 63 65 20  * The interface 
33a70 74 6f 20 74 68 65 20 76 69 72 74 75 61 6c 2d 74  to the virtual-t
33a80 61 62 6c 65 20 6d 65 63 68 61 6e 69 73 6d 20 69  able mechanism i
33a90 73 20 63 75 72 72 65 6e 74 6c 79 20 63 6f 6e 73  s currently cons
33aa0 69 64 65 72 65 64 0a 2a 2a 20 74 6f 20 62 65 20  idered.** to be 
33ab0 65 78 70 65 72 69 6d 65 6e 74 61 6c 2e 20 20 54  experimental.  T
33ac0 68 65 20 69 6e 74 65 72 66 61 63 65 20 6d 69 67  he interface mig
33ad0 68 74 20 63 68 61 6e 67 65 20 69 6e 20 69 6e 63  ht change in inc
33ae0 6f 6d 70 61 74 69 62 6c 65 20 77 61 79 73 2e 0a  ompatible ways..
33af0 2a 2a 20 49 66 20 74 68 69 73 20 69 73 20 61 20  ** If this is a 
33b00 70 72 6f 62 6c 65 6d 20 66 6f 72 20 79 6f 75 2c  problem for you,
33b10 20 64 6f 20 6e 6f 74 20 75 73 65 20 74 68 65 20   do not use the 
33b20 69 6e 74 65 72 66 61 63 65 20 61 74 20 74 68 69  interface at thi
33b30 73 20 74 69 6d 65 2e 0a 2a 2a 0a 2a 2a 20 57 68  s time..**.** Wh
33b40 65 6e 20 74 68 65 20 76 69 72 74 75 61 6c 2d 74  en the virtual-t
33b50 61 62 6c 65 20 6d 65 63 68 61 6e 69 73 6d 20 73  able mechanism s
33b60 74 61 62 69 6c 69 7a 65 73 2c 20 77 65 20 77 69  tabilizes, we wi
33b70 6c 6c 20 64 65 63 6c 61 72 65 20 74 68 65 0a 2a  ll declare the.*
33b80 2a 20 69 6e 74 65 72 66 61 63 65 20 66 69 78 65  * interface fixe
33b90 64 2c 20 73 75 70 70 6f 72 74 20 69 74 20 69 6e  d, support it in
33ba0 64 65 66 69 6e 69 74 65 6c 79 2c 20 61 6e 64 20  definitely, and 
33bb0 72 65 6d 6f 76 65 20 74 68 69 73 20 63 6f 6d 6d  remove this comm
33bc0 65 6e 74 2e 0a 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 53  ent..*/../*.** S
33bd0 74 72 75 63 74 75 72 65 73 20 75 73 65 64 20 62  tructures used b
33be0 79 20 74 68 65 20 76 69 72 74 75 61 6c 20 74 61  y the virtual ta
33bf0 62 6c 65 20 69 6e 74 65 72 66 61 63 65 0a 2a 2f  ble interface.*/
33c00 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20  .typedef struct 
33c10 73 71 6c 69 74 65 33 5f 76 74 61 62 20 73 71 6c  sqlite3_vtab sql
33c20 69 74 65 33 5f 76 74 61 62 3b 0a 74 79 70 65 64  ite3_vtab;.typed
33c30 65 66 20 73 74 72 75 63 74 20 73 71 6c 69 74 65  ef struct sqlite
33c40 33 5f 69 6e 64 65 78 5f 69 6e 66 6f 20 73 71 6c  3_index_info sql
33c50 69 74 65 33 5f 69 6e 64 65 78 5f 69 6e 66 6f 3b  ite3_index_info;
33c60 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20  .typedef struct 
33c70 73 71 6c 69 74 65 33 5f 76 74 61 62 5f 63 75 72  sqlite3_vtab_cur
33c80 73 6f 72 20 73 71 6c 69 74 65 33 5f 76 74 61 62  sor sqlite3_vtab
33c90 5f 63 75 72 73 6f 72 3b 0a 74 79 70 65 64 65 66  _cursor;.typedef
33ca0 20 73 74 72 75 63 74 20 73 71 6c 69 74 65 33 5f   struct sqlite3_
33cb0 6d 6f 64 75 6c 65 20 73 71 6c 69 74 65 33 5f 6d  module sqlite3_m
33cc0 6f 64 75 6c 65 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41  odule;../*.** CA
33cd0 50 49 33 52 45 46 3a 20 56 69 72 74 75 61 6c 20  PI3REF: Virtual 
33ce0 54 61 62 6c 65 20 4f 62 6a 65 63 74 0a 2a 2a 20  Table Object.** 
33cf0 4b 45 59 57 4f 52 44 53 3a 20 73 71 6c 69 74 65  KEYWORDS: sqlite
33d00 33 5f 6d 6f 64 75 6c 65 20 7b 76 69 72 74 75 61  3_module {virtua
33d10 6c 20 74 61 62 6c 65 20 6d 6f 64 75 6c 65 7d 0a  l table module}.
33d20 2a 2a 0a 2a 2a 20 54 68 69 73 20 73 74 72 75 63  **.** This struc
33d30 74 75 72 65 2c 20 73 6f 6d 65 74 69 6d 65 73 20  ture, sometimes 
33d40 63 61 6c 6c 65 64 20 61 20 61 20 22 76 69 72 74  called a a "virt
33d50 75 61 6c 20 74 61 62 6c 65 20 6d 6f 64 75 6c 65  ual table module
33d60 22 2c 20 0a 2a 2a 20 64 65 66 69 6e 65 73 20 74  ", .** defines t
33d70 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f  he implementatio
33d80 6e 20 6f 66 20 61 20 5b 76 69 72 74 75 61 6c 20  n of a [virtual 
33d90 74 61 62 6c 65 73 5d 2e 20 20 0a 2a 2a 20 54 68  tables].  .** Th
33da0 69 73 20 73 74 72 75 63 74 75 72 65 20 63 6f 6e  is structure con
33db0 73 69 73 74 73 20 6d 6f 73 74 6c 79 20 6f 66 20  sists mostly of 
33dc0 6d 65 74 68 6f 64 73 20 66 6f 72 20 74 68 65 20  methods for the 
33dd0 6d 6f 64 75 6c 65 2e 0a 2a 2a 0a 2a 2a 20 5e 41  module..**.** ^A
33de0 20 76 69 72 74 75 61 6c 20 74 61 62 6c 65 20 6d   virtual table m
33df0 6f 64 75 6c 65 20 69 73 20 63 72 65 61 74 65 64  odule is created
33e00 20 62 79 20 66 69 6c 6c 69 6e 67 20 69 6e 20 61   by filling in a
33e10 20 70 65 72 73 69 73 74 65 6e 74 0a 2a 2a 20 69   persistent.** i
33e20 6e 73 74 61 6e 63 65 20 6f 66 20 74 68 69 73 20  nstance of this 
33e30 73 74 72 75 63 74 75 72 65 20 61 6e 64 20 70 61  structure and pa
33e40 73 73 69 6e 67 20 61 20 70 6f 69 6e 74 65 72 20  ssing a pointer 
33e50 74 6f 20 74 68 61 74 20 69 6e 73 74 61 6e 63 65  to that instance
33e60 0a 2a 2a 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f  .** to [sqlite3_
33e70 63 72 65 61 74 65 5f 6d 6f 64 75 6c 65 28 29 5d  create_module()]
33e80 20 6f 72 20 5b 73 71 6c 69 74 65 33 5f 63 72 65   or [sqlite3_cre
33e90 61 74 65 5f 6d 6f 64 75 6c 65 5f 76 32 28 29 5d  ate_module_v2()]
33ea0 2e 0a 2a 2a 20 5e 54 68 65 20 72 65 67 69 73 74  ..** ^The regist
33eb0 72 61 74 69 6f 6e 20 72 65 6d 61 69 6e 73 20 76  ration remains v
33ec0 61 6c 69 64 20 75 6e 74 69 6c 20 69 74 20 69 73  alid until it is
33ed0 20 72 65 70 6c 61 63 65 64 20 62 79 20 61 20 64   replaced by a d
33ee0 69 66 66 65 72 65 6e 74 0a 2a 2a 20 6d 6f 64 75  ifferent.** modu
33ef0 6c 65 20 6f 72 20 75 6e 74 69 6c 20 74 68 65 20  le or until the 
33f00 5b 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63  [database connec
33f10 74 69 6f 6e 5d 20 63 6c 6f 73 65 73 2e 20 20 54  tion] closes.  T
33f20 68 65 20 63 6f 6e 74 65 6e 74 0a 2a 2a 20 6f 66  he content.** of
33f30 20 74 68 69 73 20 73 74 72 75 63 74 75 72 65 20   this structure 
33f40 6d 75 73 74 20 6e 6f 74 20 63 68 61 6e 67 65 20  must not change 
33f50 77 68 69 6c 65 20 69 74 20 69 73 20 72 65 67 69  while it is regi
33f60 73 74 65 72 65 64 20 77 69 74 68 0a 2a 2a 20 61  stered with.** a
33f70 6e 79 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  ny database conn
33f80 65 63 74 69 6f 6e 2e 0a 2a 2f 0a 73 74 72 75 63  ection..*/.struc
33f90 74 20 73 71 6c 69 74 65 33 5f 6d 6f 64 75 6c 65  t sqlite3_module
33fa0 20 7b 0a 20 20 69 6e 74 20 69 56 65 72 73 69 6f   {.  int iVersio
33fb0 6e 3b 0a 20 20 69 6e 74 20 28 2a 78 43 72 65 61  n;.  int (*xCrea
33fc0 74 65 29 28 73 71 6c 69 74 65 33 2a 2c 20 76 6f  te)(sqlite3*, vo
33fd0 69 64 20 2a 70 41 75 78 2c 0a 20 20 20 20 20 20  id *pAux,.      
33fe0 20 20 20 20 20 20 20 20 20 69 6e 74 20 61 72 67           int arg
33ff0 63 2c 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 63  c, const char *c
34000 6f 6e 73 74 2a 61 72 67 76 2c 0a 20 20 20 20 20  onst*argv,.     
34010 20 20 20 20 20 20 20 20 20 20 73 71 6c 69 74 65            sqlite
34020 33 5f 76 74 61 62 20 2a 2a 70 70 56 54 61 62 2c  3_vtab **ppVTab,
34030 20 63 68 61 72 2a 2a 29 3b 0a 20 20 69 6e 74 20   char**);.  int 
34040 28 2a 78 43 6f 6e 6e 65 63 74 29 28 73 71 6c 69  (*xConnect)(sqli
34050 74 65 33 2a 2c 20 76 6f 69 64 20 2a 70 41 75 78  te3*, void *pAux
34060 2c 0a 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ,.              
34070 20 69 6e 74 20 61 72 67 63 2c 20 63 6f 6e 73 74   int argc, const
34080 20 63 68 61 72 20 2a 63 6f 6e 73 74 2a 61 72 67   char *const*arg
34090 76 2c 0a 20 20 20 20 20 20 20 20 20 20 20 20 20  v,.             
340a0 20 20 73 71 6c 69 74 65 33 5f 76 74 61 62 20 2a    sqlite3_vtab *
340b0 2a 70 70 56 54 61 62 2c 20 63 68 61 72 2a 2a 29  *ppVTab, char**)
340c0 3b 0a 20 20 69 6e 74 20 28 2a 78 42 65 73 74 49  ;.  int (*xBestI
340d0 6e 64 65 78 29 28 73 71 6c 69 74 65 33 5f 76 74  ndex)(sqlite3_vt
340e0 61 62 20 2a 70 56 54 61 62 2c 20 73 71 6c 69 74  ab *pVTab, sqlit
340f0 65 33 5f 69 6e 64 65 78 5f 69 6e 66 6f 2a 29 3b  e3_index_info*);
34100 0a 20 20 69 6e 74 20 28 2a 78 44 69 73 63 6f 6e  .  int (*xDiscon
34110 6e 65 63 74 29 28 73 71 6c 69 74 65 33 5f 76 74  nect)(sqlite3_vt
34120 61 62 20 2a 70 56 54 61 62 29 3b 0a 20 20 69 6e  ab *pVTab);.  in
34130 74 20 28 2a 78 44 65 73 74 72 6f 79 29 28 73 71  t (*xDestroy)(sq
34140 6c 69 74 65 33 5f 76 74 61 62 20 2a 70 56 54 61  lite3_vtab *pVTa
34150 62 29 3b 0a 20 20 69 6e 74 20 28 2a 78 4f 70 65  b);.  int (*xOpe
34160 6e 29 28 73 71 6c 69 74 65 33 5f 76 74 61 62 20  n)(sqlite3_vtab 
34170 2a 70 56 54 61 62 2c 20 73 71 6c 69 74 65 33 5f  *pVTab, sqlite3_
34180 76 74 61 62 5f 63 75 72 73 6f 72 20 2a 2a 70 70  vtab_cursor **pp
34190 43 75 72 73 6f 72 29 3b 0a 20 20 69 6e 74 20 28  Cursor);.  int (
341a0 2a 78 43 6c 6f 73 65 29 28 73 71 6c 69 74 65 33  *xClose)(sqlite3
341b0 5f 76 74 61 62 5f 63 75 72 73 6f 72 2a 29 3b 0a  _vtab_cursor*);.
341c0 20 20 69 6e 74 20 28 2a 78 46 69 6c 74 65 72 29    int (*xFilter)
341d0 28 73 71 6c 69 74 65 33 5f 76 74 61 62 5f 63 75  (sqlite3_vtab_cu
341e0 72 73 6f 72 2a 2c 20 69 6e 74 20 69 64 78 4e 75  rsor*, int idxNu
341f0 6d 2c 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 69  m, const char *i
34200 64 78 53 74 72 2c 0a 20 20 20 20 20 20 20 20 20  dxStr,.         
34210 20 20 20 20 20 20 20 69 6e 74 20 61 72 67 63 2c         int argc,
34220 20 73 71 6c 69 74 65 33 5f 76 61 6c 75 65 20 2a   sqlite3_value *
34230 2a 61 72 67 76 29 3b 0a 20 20 69 6e 74 20 28 2a  *argv);.  int (*
34240 78 4e 65 78 74 29 28 73 71 6c 69 74 65 33 5f 76  xNext)(sqlite3_v
34250 74 61 62 5f 63 75 72 73 6f 72 2a 29 3b 0a 20 20  tab_cursor*);.  
34260 69 6e 74 20 28 2a 78 45 6f 66 29 28 73 71 6c 69  int (*xEof)(sqli
34270 74 65 33 5f 76 74 61 62 5f 63 75 72 73 6f 72 2a  te3_vtab_cursor*
34280 29 3b 0a 20 20 69 6e 74 20 28 2a 78 43 6f 6c 75  );.  int (*xColu
34290 6d 6e 29 28 73 71 6c 69 74 65 33 5f 76 74 61 62  mn)(sqlite3_vtab
342a0 5f 63 75 72 73 6f 72 2a 2c 20 73 71 6c 69 74 65  _cursor*, sqlite
342b0 33 5f 63 6f 6e 74 65 78 74 2a 2c 20 69 6e 74 29  3_context*, int)
342c0 3b 0a 20 20 69 6e 74 20 28 2a 78 52 6f 77 69 64  ;.  int (*xRowid
342d0 29 28 73 71 6c 69 74 65 33 5f 76 74 61 62 5f 63  )(sqlite3_vtab_c
342e0 75 72 73 6f 72 2a 2c 20 73 71 6c 69 74 65 33 5f  ursor*, sqlite3_
342f0 69 6e 74 36 34 20 2a 70 52 6f 77 69 64 29 3b 0a  int64 *pRowid);.
34300 20 20 69 6e 74 20 28 2a 78 55 70 64 61 74 65 29    int (*xUpdate)
34310 28 73 71 6c 69 74 65 33 5f 76 74 61 62 20 2a 2c  (sqlite3_vtab *,
34320 20 69 6e 74 2c 20 73 71 6c 69 74 65 33 5f 76 61   int, sqlite3_va
34330 6c 75 65 20 2a 2a 2c 20 73 71 6c 69 74 65 33 5f  lue **, sqlite3_
34340 69 6e 74 36 34 20 2a 29 3b 0a 20 20 69 6e 74 20  int64 *);.  int 
34350 28 2a 78 42 65 67 69 6e 29 28 73 71 6c 69 74 65  (*xBegin)(sqlite
34360 33 5f 76 74 61 62 20 2a 70 56 54 61 62 29 3b 0a  3_vtab *pVTab);.
34370 20 20 69 6e 74 20 28 2a 78 53 79 6e 63 29 28 73    int (*xSync)(s
34380 71 6c 69 74 65 33 5f 76 74 61 62 20 2a 70 56 54  qlite3_vtab *pVT
34390 61 62 29 3b 0a 20 20 69 6e 74 20 28 2a 78 43 6f  ab);.  int (*xCo
343a0 6d 6d 69 74 29 28 73 71 6c 69 74 65 33 5f 76 74  mmit)(sqlite3_vt
343b0 61 62 20 2a 70 56 54 61 62 29 3b 0a 20 20 69 6e  ab *pVTab);.  in
343c0 74 20 28 2a 78 52 6f 6c 6c 62 61 63 6b 29 28 73  t (*xRollback)(s
343d0 71 6c 69 74 65 33 5f 76 74 61 62 20 2a 70 56 54  qlite3_vtab *pVT
343e0 61 62 29 3b 0a 20 20 69 6e 74 20 28 2a 78 46 69  ab);.  int (*xFi
343f0 6e 64 46 75 6e 63 74 69 6f 6e 29 28 73 71 6c 69  ndFunction)(sqli
34400 74 65 33 5f 76 74 61 62 20 2a 70 56 74 61 62 2c  te3_vtab *pVtab,
34410 20 69 6e 74 20 6e 41 72 67 2c 20 63 6f 6e 73 74   int nArg, const
34420 20 63 68 61 72 20 2a 7a 4e 61 6d 65 2c 0a 20 20   char *zName,.  
34430 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
34440 20 20 20 20 20 76 6f 69 64 20 28 2a 2a 70 78 46       void (**pxF
34450 75 6e 63 29 28 73 71 6c 69 74 65 33 5f 63 6f 6e  unc)(sqlite3_con
34460 74 65 78 74 2a 2c 69 6e 74 2c 73 71 6c 69 74 65  text*,int,sqlite
34470 33 5f 76 61 6c 75 65 2a 2a 29 2c 0a 20 20 20 20  3_value**),.    
34480 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
34490 20 20 20 76 6f 69 64 20 2a 2a 70 70 41 72 67 29     void **ppArg)
344a0 3b 0a 20 20 69 6e 74 20 28 2a 78 52 65 6e 61 6d  ;.  int (*xRenam
344b0 65 29 28 73 71 6c 69 74 65 33 5f 76 74 61 62 20  e)(sqlite3_vtab 
344c0 2a 70 56 74 61 62 2c 20 63 6f 6e 73 74 20 63 68  *pVtab, const ch
344d0 61 72 20 2a 7a 4e 65 77 29 3b 0a 7d 3b 0a 0a 2f  ar *zNew);.};../
344e0 2a 0a 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 56  *.** CAPI3REF: V
344f0 69 72 74 75 61 6c 20 54 61 62 6c 65 20 49 6e 64  irtual Table Ind
34500 65 78 69 6e 67 20 49 6e 66 6f 72 6d 61 74 69 6f  exing Informatio
34510 6e 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20 73  n.** KEYWORDS: s
34520 71 6c 69 74 65 33 5f 69 6e 64 65 78 5f 69 6e 66  qlite3_index_inf
34530 6f 0a 2a 2a 0a 2a 2a 20 54 68 65 20 73 71 6c 69  o.**.** The sqli
34540 74 65 33 5f 69 6e 64 65 78 5f 69 6e 66 6f 20 73  te3_index_info s
34550 74 72 75 63 74 75 72 65 20 61 6e 64 20 69 74 73  tructure and its
34560 20 73 75 62 73 74 72 75 63 74 75 72 65 73 20 69   substructures i
34570 73 20 75 73 65 64 20 61 73 20 70 61 72 74 0a 2a  s used as part.*
34580 2a 20 6f 66 20 74 68 65 20 5b 76 69 72 74 75 61  * of the [virtua
34590 6c 20 74 61 62 6c 65 5d 20 69 6e 74 65 72 66 61  l table] interfa
345a0 63 65 20 74 6f 0a 2a 2a 20 70 61 73 73 20 69 6e  ce to.** pass in
345b0 66 6f 72 6d 61 74 69 6f 6e 20 69 6e 74 6f 20 61  formation into a
345c0 6e 64 20 72 65 63 65 69 76 65 20 74 68 65 20 72  nd receive the r
345d0 65 70 6c 79 20 66 72 6f 6d 20 74 68 65 20 5b 78  eply from the [x
345e0 42 65 73 74 49 6e 64 65 78 5d 0a 2a 2a 20 6d 65  BestIndex].** me
345f0 74 68 6f 64 20 6f 66 20 61 20 5b 76 69 72 74 75  thod of a [virtu
34600 61 6c 20 74 61 62 6c 65 20 6d 6f 64 75 6c 65 5d  al table module]
34610 2e 20 20 54 68 65 20 66 69 65 6c 64 73 20 75 6e  .  The fields un
34620 64 65 72 20 2a 2a 49 6e 70 75 74 73 2a 2a 20 61  der **Inputs** a
34630 72 65 20 74 68 65 0a 2a 2a 20 69 6e 70 75 74 73  re the.** inputs
34640 20 74 6f 20 78 42 65 73 74 49 6e 64 65 78 20 61   to xBestIndex a
34650 6e 64 20 61 72 65 20 72 65 61 64 2d 6f 6e 6c 79  nd are read-only
34660 2e 20 20 78 42 65 73 74 49 6e 64 65 78 20 69 6e  .  xBestIndex in
34670 73 65 72 74 73 20 69 74 73 0a 2a 2a 20 72 65 73  serts its.** res
34680 75 6c 74 73 20 69 6e 74 6f 20 74 68 65 20 2a 2a  ults into the **
34690 4f 75 74 70 75 74 73 2a 2a 20 66 69 65 6c 64 73  Outputs** fields
346a0 2e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20 61 43  ..**.** ^(The aC
346b0 6f 6e 73 74 72 61 69 6e 74 5b 5d 20 61 72 72 61  onstraint[] arra
346c0 79 20 72 65 63 6f 72 64 73 20 57 48 45 52 45 20  y records WHERE 
346d0 63 6c 61 75 73 65 20 63 6f 6e 73 74 72 61 69 6e  clause constrain
346e0 74 73 20 6f 66 20 74 68 65 20 66 6f 72 6d 3a 0a  ts of the form:.
346f0 2a 2a 0a 2a 2a 20 3c 62 6c 6f 63 6b 71 75 6f 74  **.** <blockquot
34700 65 3e 63 6f 6c 75 6d 6e 20 4f 50 20 65 78 70 72  e>column OP expr
34710 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 2a 2a  </blockquote>.**
34720 0a 2a 2a 20 77 68 65 72 65 20 4f 50 20 69 73 20  .** where OP is 
34730 3d 2c 20 26 6c 74 3b 2c 20 26 6c 74 3b 3d 2c 20  =, &lt;, &lt;=, 
34740 26 67 74 3b 2c 20 6f 72 20 26 67 74 3b 3d 2e 29  &gt;, or &gt;=.)
34750 5e 20 20 5e 28 54 68 65 20 70 61 72 74 69 63 75  ^  ^(The particu
34760 6c 61 72 20 6f 70 65 72 61 74 6f 72 20 69 73 0a  lar operator is.
34770 2a 2a 20 73 74 6f 72 65 64 20 69 6e 20 61 43 6f  ** stored in aCo
34780 6e 73 74 72 61 69 6e 74 5b 5d 2e 6f 70 20 75 73  nstraint[].op us
34790 69 6e 67 20 6f 6e 65 20 6f 66 20 74 68 65 0a 2a  ing one of the.*
347a0 2a 20 5b 53 51 4c 49 54 45 5f 49 4e 44 45 58 5f  * [SQLITE_INDEX_
347b0 43 4f 4e 53 54 52 41 49 4e 54 5f 45 51 20 7c 20  CONSTRAINT_EQ | 
347c0 53 51 4c 49 54 45 5f 49 4e 44 45 58 5f 43 4f 4e  SQLITE_INDEX_CON
347d0 53 54 52 41 49 4e 54 5f 20 76 61 6c 75 65 73 5d  STRAINT_ values]
347e0 2e 29 5e 0a 2a 2a 20 5e 28 54 68 65 20 69 6e 64  .)^.** ^(The ind
347f0 65 78 20 6f 66 20 74 68 65 20 63 6f 6c 75 6d 6e  ex of the column
34800 20 69 73 20 73 74 6f 72 65 64 20 69 6e 0a 2a 2a   is stored in.**
34810 20 61 43 6f 6e 73 74 72 61 69 6e 74 5b 5d 2e 69   aConstraint[].i
34820 43 6f 6c 75 6d 6e 2e 29 5e 20 20 5e 28 61 43 6f  Column.)^  ^(aCo
34830 6e 73 74 72 61 69 6e 74 5b 5d 2e 75 73 61 62 6c  nstraint[].usabl
34840 65 20 69 73 20 54 52 55 45 20 69 66 20 74 68 65  e is TRUE if the
34850 0a 2a 2a 20 65 78 70 72 20 6f 6e 20 74 68 65 20  .** expr on the 
34860 72 69 67 68 74 2d 68 61 6e 64 20 73 69 64 65 20  right-hand side 
34870 63 61 6e 20 62 65 20 65 76 61 6c 75 61 74 65 64  can be evaluated
34880 20 28 61 6e 64 20 74 68 75 73 20 74 68 65 20 63   (and thus the c
34890 6f 6e 73 74 72 61 69 6e 74 0a 2a 2a 20 69 73 20  onstraint.** is 
348a0 75 73 61 62 6c 65 29 20 61 6e 64 20 66 61 6c 73  usable) and fals
348b0 65 20 69 66 20 69 74 20 63 61 6e 6e 6f 74 2e 29  e if it cannot.)
348c0 5e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 6f 70 74  ^.**.** ^The opt
348d0 69 6d 69 7a 65 72 20 61 75 74 6f 6d 61 74 69 63  imizer automatic
348e0 61 6c 6c 79 20 69 6e 76 65 72 74 73 20 74 65 72  ally inverts ter
348f0 6d 73 20 6f 66 20 74 68 65 20 66 6f 72 6d 20 22  ms of the form "
34900 65 78 70 72 20 4f 50 20 63 6f 6c 75 6d 6e 22 0a  expr OP column".
34910 2a 2a 20 61 6e 64 20 6d 61 6b 65 73 20 6f 74 68  ** and makes oth
34920 65 72 20 73 69 6d 70 6c 69 66 69 63 61 74 69 6f  er simplificatio
34930 6e 73 20 74 6f 20 74 68 65 20 57 48 45 52 45 20  ns to the WHERE 
34940 63 6c 61 75 73 65 20 69 6e 20 61 6e 20 61 74 74  clause in an att
34950 65 6d 70 74 20 74 6f 0a 2a 2a 20 67 65 74 20 61  empt to.** get a
34960 73 20 6d 61 6e 79 20 57 48 45 52 45 20 63 6c 61  s many WHERE cla
34970 75 73 65 20 74 65 72 6d 73 20 69 6e 74 6f 20 74  use terms into t
34980 68 65 20 66 6f 72 6d 20 73 68 6f 77 6e 20 61 62  he form shown ab
34990 6f 76 65 20 61 73 20 70 6f 73 73 69 62 6c 65 2e  ove as possible.
349a0 0a 2a 2a 20 5e 54 68 65 20 61 43 6f 6e 73 74 72  .** ^The aConstr
349b0 61 69 6e 74 5b 5d 20 61 72 72 61 79 20 6f 6e 6c  aint[] array onl
349c0 79 20 72 65 70 6f 72 74 73 20 57 48 45 52 45 20  y reports WHERE 
349d0 63 6c 61 75 73 65 20 74 65 72 6d 73 20 74 68 61  clause terms tha
349e0 74 20 61 72 65 0a 2a 2a 20 72 65 6c 65 76 61 6e  t are.** relevan
349f0 74 20 74 6f 20 74 68 65 20 70 61 72 74 69 63 75  t to the particu
34a00 6c 61 72 20 76 69 72 74 75 61 6c 20 74 61 62 6c  lar virtual tabl
34a10 65 20 62 65 69 6e 67 20 71 75 65 72 69 65 64 2e  e being queried.
34a20 0a 2a 2a 0a 2a 2a 20 5e 49 6e 66 6f 72 6d 61 74  .**.** ^Informat
34a30 69 6f 6e 20 61 62 6f 75 74 20 74 68 65 20 4f 52  ion about the OR
34a40 44 45 52 20 42 59 20 63 6c 61 75 73 65 20 69 73  DER BY clause is
34a50 20 73 74 6f 72 65 64 20 69 6e 20 61 4f 72 64 65   stored in aOrde
34a60 72 42 79 5b 5d 2e 0a 2a 2a 20 5e 45 61 63 68 20  rBy[]..** ^Each 
34a70 74 65 72 6d 20 6f 66 20 61 4f 72 64 65 72 42 79  term of aOrderBy
34a80 20 72 65 63 6f 72 64 73 20 61 20 63 6f 6c 75 6d   records a colum
34a90 6e 20 6f 66 20 74 68 65 20 4f 52 44 45 52 20 42  n of the ORDER B
34aa0 59 20 63 6c 61 75 73 65 2e 0a 2a 2a 0a 2a 2a 20  Y clause..**.** 
34ab0 54 68 65 20 5b 78 42 65 73 74 49 6e 64 65 78 5d  The [xBestIndex]
34ac0 20 6d 65 74 68 6f 64 20 6d 75 73 74 20 66 69 6c   method must fil
34ad0 6c 20 61 43 6f 6e 73 74 72 61 69 6e 74 55 73 61  l aConstraintUsa
34ae0 67 65 5b 5d 20 77 69 74 68 20 69 6e 66 6f 72 6d  ge[] with inform
34af0 61 74 69 6f 6e 0a 2a 2a 20 61 62 6f 75 74 20 77  ation.** about w
34b00 68 61 74 20 70 61 72 61 6d 65 74 65 72 73 20 74  hat parameters t
34b10 6f 20 70 61 73 73 20 74 6f 20 78 46 69 6c 74 65  o pass to xFilte
34b20 72 2e 20 20 5e 49 66 20 61 72 67 76 49 6e 64 65  r.  ^If argvInde
34b30 78 3e 30 20 74 68 65 6e 0a 2a 2a 20 74 68 65 20  x>0 then.** the 
34b40 72 69 67 68 74 2d 68 61 6e 64 20 73 69 64 65 20  right-hand side 
34b50 6f 66 20 74 68 65 20 63 6f 72 72 65 73 70 6f 6e  of the correspon
34b60 64 69 6e 67 20 61 43 6f 6e 73 74 72 61 69 6e 74  ding aConstraint
34b70 5b 5d 20 69 73 20 65 76 61 6c 75 61 74 65 64 0a  [] is evaluated.
34b80 2a 2a 20 61 6e 64 20 62 65 63 6f 6d 65 73 20 74  ** and becomes t
34b90 68 65 20 61 72 67 76 49 6e 64 65 78 2d 74 68 20  he argvIndex-th 
34ba0 65 6e 74 72 79 20 69 6e 20 61 72 67 76 2e 20 20  entry in argv.  
34bb0 5e 28 49 66 20 61 43 6f 6e 73 74 72 61 69 6e 74  ^(If aConstraint
34bc0 55 73 61 67 65 5b 5d 2e 6f 6d 69 74 0a 2a 2a 20  Usage[].omit.** 
34bd0 69 73 20 74 72 75 65 2c 20 74 68 65 6e 20 74 68  is true, then th
34be0 65 20 63 6f 6e 73 74 72 61 69 6e 74 20 69 73 20  e constraint is 
34bf0 61 73 73 75 6d 65 64 20 74 6f 20 62 65 20 66 75  assumed to be fu
34c00 6c 6c 79 20 68 61 6e 64 6c 65 64 20 62 79 20 74  lly handled by t
34c10 68 65 0a 2a 2a 20 76 69 72 74 75 61 6c 20 74 61  he.** virtual ta
34c20 62 6c 65 20 61 6e 64 20 69 73 20 6e 6f 74 20 63  ble and is not c
34c30 68 65 63 6b 65 64 20 61 67 61 69 6e 20 62 79 20  hecked again by 
34c40 53 51 4c 69 74 65 2e 29 5e 0a 2a 2a 0a 2a 2a 20  SQLite.)^.**.** 
34c50 5e 54 68 65 20 69 64 78 4e 75 6d 20 61 6e 64 20  ^The idxNum and 
34c60 69 64 78 50 74 72 20 76 61 6c 75 65 73 20 61 72  idxPtr values ar
34c70 65 20 72 65 63 6f 72 64 65 64 20 61 6e 64 20 70  e recorded and p
34c80 61 73 73 65 64 20 69 6e 74 6f 20 74 68 65 0a 2a  assed into the.*
34c90 2a 20 5b 78 46 69 6c 74 65 72 5d 20 6d 65 74 68  * [xFilter] meth
34ca0 6f 64 2e 0a 2a 2a 20 5e 5b 73 71 6c 69 74 65 33  od..** ^[sqlite3
34cb0 5f 66 72 65 65 28 29 5d 20 69 73 20 75 73 65 64  _free()] is used
34cc0 20 74 6f 20 66 72 65 65 20 69 64 78 50 74 72 20   to free idxPtr 
34cd0 69 66 20 61 6e 64 20 6f 6e 6c 79 20 69 66 0a 2a  if and only if.*
34ce0 2a 20 6e 65 65 64 54 6f 46 72 65 65 49 64 78 50  * needToFreeIdxP
34cf0 74 72 20 69 73 20 74 72 75 65 2e 0a 2a 2a 0a 2a  tr is true..**.*
34d00 2a 20 5e 54 68 65 20 6f 72 64 65 72 42 79 43 6f  * ^The orderByCo
34d10 6e 73 75 6d 65 64 20 6d 65 61 6e 73 20 74 68 61  nsumed means tha
34d20 74 20 6f 75 74 70 75 74 20 66 72 6f 6d 20 5b 78  t output from [x
34d30 46 69 6c 74 65 72 5d 2f 5b 78 4e 65 78 74 5d 20  Filter]/[xNext] 
34d40 77 69 6c 6c 20 6f 63 63 75 72 20 69 6e 0a 2a 2a  will occur in.**
34d50 20 74 68 65 20 63 6f 72 72 65 63 74 20 6f 72 64   the correct ord
34d60 65 72 20 74 6f 20 73 61 74 69 73 66 79 20 74 68  er to satisfy th
34d70 65 20 4f 52 44 45 52 20 42 59 20 63 6c 61 75 73  e ORDER BY claus
34d80 65 20 73 6f 20 74 68 61 74 20 6e 6f 20 73 65 70  e so that no sep
34d90 61 72 61 74 65 0a 2a 2a 20 73 6f 72 74 69 6e 67  arate.** sorting
34da0 20 73 74 65 70 20 69 73 20 72 65 71 75 69 72 65   step is require
34db0 64 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 65 73  d..**.** ^The es
34dc0 74 69 6d 61 74 65 64 43 6f 73 74 20 76 61 6c 75  timatedCost valu
34dd0 65 20 69 73 20 61 6e 20 65 73 74 69 6d 61 74 65  e is an estimate
34de0 20 6f 66 20 74 68 65 20 63 6f 73 74 20 6f 66 20   of the cost of 
34df0 64 6f 69 6e 67 20 74 68 65 0a 2a 2a 20 70 61 72  doing the.** par
34e00 74 69 63 75 6c 61 72 20 6c 6f 6f 6b 75 70 2e 20  ticular lookup. 
34e10 20 41 20 66 75 6c 6c 20 73 63 61 6e 20 6f 66 20   A full scan of 
34e20 61 20 74 61 62 6c 65 20 77 69 74 68 20 4e 20 65  a table with N e
34e30 6e 74 72 69 65 73 20 73 68 6f 75 6c 64 20 68 61  ntries should ha
34e40 76 65 0a 2a 2a 20 61 20 63 6f 73 74 20 6f 66 20  ve.** a cost of 
34e50 4e 2e 20 20 41 20 62 69 6e 61 72 79 20 73 65 61  N.  A binary sea
34e60 72 63 68 20 6f 66 20 61 20 74 61 62 6c 65 20 6f  rch of a table o
34e70 66 20 4e 20 65 6e 74 72 69 65 73 20 73 68 6f 75  f N entries shou
34e80 6c 64 20 68 61 76 65 20 61 0a 2a 2a 20 63 6f 73  ld have a.** cos
34e90 74 20 6f 66 20 61 70 70 72 6f 78 69 6d 61 74 65  t of approximate
34ea0 6c 79 20 6c 6f 67 28 4e 29 2e 0a 2a 2f 0a 73 74  ly log(N)..*/.st
34eb0 72 75 63 74 20 73 71 6c 69 74 65 33 5f 69 6e 64  ruct sqlite3_ind
34ec0 65 78 5f 69 6e 66 6f 20 7b 0a 20 20 2f 2a 20 49  ex_info {.  /* I
34ed0 6e 70 75 74 73 20 2a 2f 0a 20 20 69 6e 74 20 6e  nputs */.  int n
34ee0 43 6f 6e 73 74 72 61 69 6e 74 3b 20 20 20 20 20  Constraint;     
34ef0 20 20 20 20 20 20 2f 2a 20 4e 75 6d 62 65 72 20        /* Number 
34f00 6f 66 20 65 6e 74 72 69 65 73 20 69 6e 20 61 43  of entries in aC
34f10 6f 6e 73 74 72 61 69 6e 74 20 2a 2f 0a 20 20 73  onstraint */.  s
34f20 74 72 75 63 74 20 73 71 6c 69 74 65 33 5f 69 6e  truct sqlite3_in
34f30 64 65 78 5f 63 6f 6e 73 74 72 61 69 6e 74 20 7b  dex_constraint {
34f40 0a 20 20 20 20 20 69 6e 74 20 69 43 6f 6c 75 6d  .     int iColum
34f50 6e 3b 20 20 20 20 20 20 20 20 20 20 20 20 20 20  n;              
34f60 2f 2a 20 43 6f 6c 75 6d 6e 20 6f 6e 20 6c 65 66  /* Column on lef
34f70 74 2d 68 61 6e 64 20 73 69 64 65 20 6f 66 20 63  t-hand side of c
34f80 6f 6e 73 74 72 61 69 6e 74 20 2a 2f 0a 20 20 20  onstraint */.   
34f90 20 20 75 6e 73 69 67 6e 65 64 20 63 68 61 72 20    unsigned char 
34fa0 6f 70 3b 20 20 20 20 20 20 20 20 20 2f 2a 20 43  op;         /* C
34fb0 6f 6e 73 74 72 61 69 6e 74 20 6f 70 65 72 61 74  onstraint operat
34fc0 6f 72 20 2a 2f 0a 20 20 20 20 20 75 6e 73 69 67  or */.     unsig
34fd0 6e 65 64 20 63 68 61 72 20 75 73 61 62 6c 65 3b  ned char usable;
34fe0 20 20 20 20 20 2f 2a 20 54 72 75 65 20 69 66 20       /* True if 
34ff0 74 68 69 73 20 63 6f 6e 73 74 72 61 69 6e 74 20  this constraint 
35000 69 73 20 75 73 61 62 6c 65 20 2a 2f 0a 20 20 20  is usable */.   
35010 20 20 69 6e 74 20 69 54 65 72 6d 4f 66 66 73 65    int iTermOffse
35020 74 3b 20 20 20 20 20 20 20 20 20 20 2f 2a 20 55  t;          /* U
35030 73 65 64 20 69 6e 74 65 72 6e 61 6c 6c 79 20 2d  sed internally -
35040 20 78 42 65 73 74 49 6e 64 65 78 20 73 68 6f 75   xBestIndex shou
35050 6c 64 20 69 67 6e 6f 72 65 20 2a 2f 0a 20 20 7d  ld ignore */.  }
35060 20 2a 61 43 6f 6e 73 74 72 61 69 6e 74 3b 20 20   *aConstraint;  
35070 20 20 20 20 20 20 20 20 20 20 2f 2a 20 54 61 62            /* Tab
35080 6c 65 20 6f 66 20 57 48 45 52 45 20 63 6c 61 75  le of WHERE clau
35090 73 65 20 63 6f 6e 73 74 72 61 69 6e 74 73 20 2a  se constraints *
350a0 2f 0a 20 20 69 6e 74 20 6e 4f 72 64 65 72 42 79  /.  int nOrderBy
350b0 3b 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f  ;              /
350c0 2a 20 4e 75 6d 62 65 72 20 6f 66 20 74 65 72 6d  * Number of term
350d0 73 20 69 6e 20 74 68 65 20 4f 52 44 45 52 20 42  s in the ORDER B
350e0 59 20 63 6c 61 75 73 65 20 2a 2f 0a 20 20 73 74  Y clause */.  st
350f0 72 75 63 74 20 73 71 6c 69 74 65 33 5f 69 6e 64  ruct sqlite3_ind
35100 65 78 5f 6f 72 64 65 72 62 79 20 7b 0a 20 20 20  ex_orderby {.   
35110 20 20 69 6e 74 20 69 43 6f 6c 75 6d 6e 3b 20 20    int iColumn;  
35120 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 43              /* C
35130 6f 6c 75 6d 6e 20 6e 75 6d 62 65 72 20 2a 2f 0a  olumn number */.
35140 20 20 20 20 20 75 6e 73 69 67 6e 65 64 20 63 68       unsigned ch
35150 61 72 20 64 65 73 63 3b 20 20 20 20 20 20 20 2f  ar desc;       /
35160 2a 20 54 72 75 65 20 66 6f 72 20 44 45 53 43 2e  * True for DESC.
35170 20 20 46 61 6c 73 65 20 66 6f 72 20 41 53 43 2e    False for ASC.
35180 20 2a 2f 0a 20 20 7d 20 2a 61 4f 72 64 65 72 42   */.  } *aOrderB
35190 79 3b 20 20 20 20 20 20 20 20 20 20 20 20 20 20  y;              
351a0 20 2f 2a 20 54 68 65 20 4f 52 44 45 52 20 42 59   /* The ORDER BY
351b0 20 63 6c 61 75 73 65 20 2a 2f 0a 20 20 2f 2a 20   clause */.  /* 
351c0 4f 75 74 70 75 74 73 20 2a 2f 0a 20 20 73 74 72  Outputs */.  str
351d0 75 63 74 20 73 71 6c 69 74 65 33 5f 69 6e 64 65  uct sqlite3_inde
351e0 78 5f 63 6f 6e 73 74 72 61 69 6e 74 5f 75 73 61  x_constraint_usa
351f0 67 65 20 7b 0a 20 20 20 20 69 6e 74 20 61 72 67  ge {.    int arg
35200 76 49 6e 64 65 78 3b 20 20 20 20 20 20 20 20 20  vIndex;         
35210 20 20 2f 2a 20 69 66 20 3e 30 2c 20 63 6f 6e 73    /* if >0, cons
35220 74 72 61 69 6e 74 20 69 73 20 70 61 72 74 20 6f  traint is part o
35230 66 20 61 72 67 76 20 74 6f 20 78 46 69 6c 74 65  f argv to xFilte
35240 72 20 2a 2f 0a 20 20 20 20 75 6e 73 69 67 6e 65  r */.    unsigne
35250 64 20 63 68 61 72 20 6f 6d 69 74 3b 20 20 20 20  d char omit;    
35260 20 20 2f 2a 20 44 6f 20 6e 6f 74 20 63 6f 64 65    /* Do not code
35270 20 61 20 74 65 73 74 20 66 6f 72 20 74 68 69 73   a test for this
35280 20 63 6f 6e 73 74 72 61 69 6e 74 20 2a 2f 0a 20   constraint */. 
35290 20 7d 20 2a 61 43 6f 6e 73 74 72 61 69 6e 74 55   } *aConstraintU
352a0 73 61 67 65 3b 0a 20 20 69 6e 74 20 69 64 78 4e  sage;.  int idxN
352b0 75 6d 3b 20 20 20 20 20 20 20 20 20 20 20 20 20  um;             
352c0 20 20 20 2f 2a 20 4e 75 6d 62 65 72 20 75 73 65     /* Number use
352d0 64 20 74 6f 20 69 64 65 6e 74 69 66 79 20 74 68  d to identify th
352e0 65 20 69 6e 64 65 78 20 2a 2f 0a 20 20 63 68 61  e index */.  cha
352f0 72 20 2a 69 64 78 53 74 72 3b 20 20 20 20 20 20  r *idxStr;      
35300 20 20 20 20 20 20 20 20 2f 2a 20 53 74 72 69 6e          /* Strin
35310 67 2c 20 70 6f 73 73 69 62 6c 79 20 6f 62 74 61  g, possibly obta
35320 69 6e 65 64 20 66 72 6f 6d 20 73 71 6c 69 74 65  ined from sqlite
35330 33 5f 6d 61 6c 6c 6f 63 20 2a 2f 0a 20 20 69 6e  3_malloc */.  in
35340 74 20 6e 65 65 64 54 6f 46 72 65 65 49 64 78 53  t needToFreeIdxS
35350 74 72 3b 20 20 20 20 20 20 2f 2a 20 46 72 65 65  tr;      /* Free
35360 20 69 64 78 53 74 72 20 75 73 69 6e 67 20 73 71   idxStr using sq
35370 6c 69 74 65 33 5f 66 72 65 65 28 29 20 69 66 20  lite3_free() if 
35380 74 72 75 65 20 2a 2f 0a 20 20 69 6e 74 20 6f 72  true */.  int or
35390 64 65 72 42 79 43 6f 6e 73 75 6d 65 64 3b 20 20  derByConsumed;  
353a0 20 20 20 20 20 2f 2a 20 54 72 75 65 20 69 66 20       /* True if 
353b0 6f 75 74 70 75 74 20 69 73 20 61 6c 72 65 61 64  output is alread
353c0 79 20 6f 72 64 65 72 65 64 20 2a 2f 0a 20 20 64  y ordered */.  d
353d0 6f 75 62 6c 65 20 65 73 74 69 6d 61 74 65 64 43  ouble estimatedC
353e0 6f 73 74 3b 20 20 20 20 20 20 2f 2a 20 45 73 74  ost;      /* Est
353f0 69 6d 61 74 65 64 20 63 6f 73 74 20 6f 66 20 75  imated cost of u
35400 73 69 6e 67 20 74 68 69 73 20 69 6e 64 65 78 20  sing this index 
35410 2a 2f 0a 7d 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50  */.};../*.** CAP
35420 49 33 52 45 46 3a 20 56 69 72 74 75 61 6c 20 54  I3REF: Virtual T
35430 61 62 6c 65 20 43 6f 6e 73 74 72 61 69 6e 74 20  able Constraint 
35440 4f 70 65 72 61 74 6f 72 20 43 6f 64 65 73 0a 2a  Operator Codes.*
35450 2a 0a 2a 2a 20 54 68 65 73 65 20 6d 61 63 72 6f  *.** These macro
35460 73 20 64 65 66 69 6e 65 64 20 74 68 65 20 61 6c  s defined the al
35470 6c 6f 77 65 64 20 76 61 6c 75 65 73 20 66 6f 72  lowed values for
35480 20 74 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33   the.** [sqlite3
35490 5f 69 6e 64 65 78 5f 69 6e 66 6f 5d 2e 61 43 6f  _index_info].aCo
354a0 6e 73 74 72 61 69 6e 74 5b 5d 2e 6f 70 20 66 69  nstraint[].op fi
354b0 65 6c 64 2e 20 20 45 61 63 68 20 76 61 6c 75 65  eld.  Each value
354c0 20 72 65 70 72 65 73 65 6e 74 73 0a 2a 2a 20 61   represents.** a
354d0 6e 20 6f 70 65 72 61 74 6f 72 20 74 68 61 74 20  n operator that 
354e0 69 73 20 70 61 72 74 20 6f 66 20 61 20 63 6f 6e  is part of a con
354f0 73 74 72 61 69 6e 74 20 74 65 72 6d 20 69 6e 20  straint term in 
35500 74 68 65 20 77 48 45 52 45 20 63 6c 61 75 73 65  the wHERE clause
35510 20 6f 66 0a 2a 2a 20 61 20 71 75 65 72 79 20 74   of.** a query t
35520 68 61 74 20 75 73 65 73 20 61 20 5b 76 69 72 74  hat uses a [virt
35530 75 61 6c 20 74 61 62 6c 65 5d 2e 0a 2a 2f 0a 23  ual table]..*/.#
35540 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4e  define SQLITE_IN
35550 44 45 58 5f 43 4f 4e 53 54 52 41 49 4e 54 5f 45  DEX_CONSTRAINT_E
35560 51 20 20 20 20 32 0a 23 64 65 66 69 6e 65 20 53  Q    2.#define S
35570 51 4c 49 54 45 5f 49 4e 44 45 58 5f 43 4f 4e 53  QLITE_INDEX_CONS
35580 54 52 41 49 4e 54 5f 47 54 20 20 20 20 34 0a 23  TRAINT_GT    4.#
35590 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49 4e  define SQLITE_IN
355a0 44 45 58 5f 43 4f 4e 53 54 52 41 49 4e 54 5f 4c  DEX_CONSTRAINT_L
355b0 45 20 20 20 20 38 0a 23 64 65 66 69 6e 65 20 53  E    8.#define S
355c0 51 4c 49 54 45 5f 49 4e 44 45 58 5f 43 4f 4e 53  QLITE_INDEX_CONS
355d0 54 52 41 49 4e 54 5f 4c 54 20 20 20 20 31 36 0a  TRAINT_LT    16.
355e0 23 64 65 66 69 6e 65 20 53 51 4c 49 54 45 5f 49  #define SQLITE_I
355f0 4e 44 45 58 5f 43 4f 4e 53 54 52 41 49 4e 54 5f  NDEX_CONSTRAINT_
35600 47 45 20 20 20 20 33 32 0a 23 64 65 66 69 6e 65  GE    32.#define
35610 20 53 51 4c 49 54 45 5f 49 4e 44 45 58 5f 43 4f   SQLITE_INDEX_CO
35620 4e 53 54 52 41 49 4e 54 5f 4d 41 54 43 48 20 36  NSTRAINT_MATCH 6
35630 34 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  4../*.** CAPI3RE
35640 46 3a 20 52 65 67 69 73 74 65 72 20 41 20 56 69  F: Register A Vi
35650 72 74 75 61 6c 20 54 61 62 6c 65 20 49 6d 70 6c  rtual Table Impl
35660 65 6d 65 6e 74 61 74 69 6f 6e 0a 2a 2a 0a 2a 2a  ementation.**.**
35670 20 5e 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73   ^These routines
35680 20 61 72 65 20 75 73 65 64 20 74 6f 20 72 65 67   are used to reg
35690 69 73 74 65 72 20 61 20 6e 65 77 20 5b 76 69 72  ister a new [vir
356a0 74 75 61 6c 20 74 61 62 6c 65 20 6d 6f 64 75 6c  tual table modul
356b0 65 5d 20 6e 61 6d 65 2e 0a 2a 2a 20 5e 4d 6f 64  e] name..** ^Mod
356c0 75 6c 65 20 6e 61 6d 65 73 20 6d 75 73 74 20 62  ule names must b
356d0 65 20 72 65 67 69 73 74 65 72 65 64 20 62 65 66  e registered bef
356e0 6f 72 65 0a 2a 2a 20 63 72 65 61 74 69 6e 67 20  ore.** creating 
356f0 61 20 6e 65 77 20 5b 76 69 72 74 75 61 6c 20 74  a new [virtual t
35700 61 62 6c 65 5d 20 75 73 69 6e 67 20 74 68 65 20  able] using the 
35710 6d 6f 64 75 6c 65 20 61 6e 64 20 62 65 66 6f 72  module and befor
35720 65 20 75 73 69 6e 67 20 61 0a 2a 2a 20 70 72 65  e using a.** pre
35730 65 78 69 73 74 69 6e 67 20 5b 76 69 72 74 75 61  existing [virtua
35740 6c 20 74 61 62 6c 65 5d 20 66 6f 72 20 74 68 65  l table] for the
35750 20 6d 6f 64 75 6c 65 2e 0a 2a 2a 0a 2a 2a 20 5e   module..**.** ^
35760 54 68 65 20 6d 6f 64 75 6c 65 20 6e 61 6d 65 20  The module name 
35770 69 73 20 72 65 67 69 73 74 65 72 65 64 20 6f 6e  is registered on
35780 20 74 68 65 20 5b 64 61 74 61 62 61 73 65 20 63   the [database c
35790 6f 6e 6e 65 63 74 69 6f 6e 5d 20 73 70 65 63 69  onnection] speci
357a0 66 69 65 64 0a 2a 2a 20 62 79 20 74 68 65 20 66  fied.** by the f
357b0 69 72 73 74 20 70 61 72 61 6d 65 74 65 72 2e 20  irst parameter. 
357c0 20 5e 54 68 65 20 6e 61 6d 65 20 6f 66 20 74 68   ^The name of th
357d0 65 20 6d 6f 64 75 6c 65 20 69 73 20 67 69 76 65  e module is give
357e0 6e 20 62 79 20 74 68 65 20 0a 2a 2a 20 73 65 63  n by the .** sec
357f0 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 2e 20 20  ond parameter.  
35800 5e 54 68 65 20 74 68 69 72 64 20 70 61 72 61 6d  ^The third param
35810 65 74 65 72 20 69 73 20 61 20 70 6f 69 6e 74 65  eter is a pointe
35820 72 20 74 6f 0a 2a 2a 20 74 68 65 20 69 6d 70 6c  r to.** the impl
35830 65 6d 65 6e 74 61 74 69 6f 6e 20 6f 66 20 74 68  ementation of th
35840 65 20 5b 76 69 72 74 75 61 6c 20 74 61 62 6c 65  e [virtual table
35850 20 6d 6f 64 75 6c 65 5d 2e 20 20 20 5e 54 68 65   module].   ^The
35860 20 66 6f 75 72 74 68 0a 2a 2a 20 70 61 72 61 6d   fourth.** param
35870 65 74 65 72 20 69 73 20 61 6e 20 61 72 62 69 74  eter is an arbit
35880 72 61 72 79 20 63 6c 69 65 6e 74 20 64 61 74 61  rary client data
35890 20 70 6f 69 6e 74 65 72 20 74 68 61 74 20 69 73   pointer that is
358a0 20 70 61 73 73 65 64 20 74 68 72 6f 75 67 68 0a   passed through.
358b0 2a 2a 20 69 6e 74 6f 20 74 68 65 20 5b 78 43 72  ** into the [xCr
358c0 65 61 74 65 5d 20 61 6e 64 20 5b 78 43 6f 6e 6e  eate] and [xConn
358d0 65 63 74 5d 20 6d 65 74 68 6f 64 73 20 6f 66 20  ect] methods of 
358e0 74 68 65 20 76 69 72 74 75 61 6c 20 74 61 62 6c  the virtual tabl
358f0 65 20 6d 6f 64 75 6c 65 0a 2a 2a 20 77 68 65 6e  e module.** when
35900 20 61 20 6e 65 77 20 76 69 72 74 75 61 6c 20 74   a new virtual t
35910 61 62 6c 65 20 69 73 20 62 65 20 62 65 69 6e 67  able is be being
35920 20 63 72 65 61 74 65 64 20 6f 72 20 72 65 69 6e   created or rein
35930 69 74 69 61 6c 69 7a 65 64 2e 0a 2a 2a 0a 2a 2a  itialized..**.**
35940 20 5e 54 68 65 20 73 71 6c 69 74 65 33 5f 63 72   ^The sqlite3_cr
35950 65 61 74 65 5f 6d 6f 64 75 6c 65 5f 76 32 28 29  eate_module_v2()
35960 20 69 6e 74 65 72 66 61 63 65 20 68 61 73 20 61   interface has a
35970 20 66 69 66 74 68 20 70 61 72 61 6d 65 74 65 72   fifth parameter
35980 20 77 68 69 63 68 0a 2a 2a 20 69 73 20 61 20 70   which.** is a p
35990 6f 69 6e 74 65 72 20 74 6f 20 61 20 64 65 73 74  ointer to a dest
359a0 72 75 63 74 6f 72 20 66 6f 72 20 74 68 65 20 70  ructor for the p
359b0 43 6c 69 65 6e 74 44 61 74 61 2e 20 20 5e 53 51  ClientData.  ^SQ
359c0 4c 69 74 65 20 77 69 6c 6c 0a 2a 2a 20 69 6e 76  Lite will.** inv
359d0 6f 6b 65 20 74 68 65 20 64 65 73 74 72 75 63 74  oke the destruct
359e0 6f 72 20 66 75 6e 63 74 69 6f 6e 20 28 69 66 20  or function (if 
359f0 69 74 20 69 73 20 6e 6f 74 20 4e 55 4c 4c 29 20  it is not NULL) 
35a00 77 68 65 6e 20 53 51 4c 69 74 65 0a 2a 2a 20 6e  when SQLite.** n
35a10 6f 20 6c 6f 6e 67 65 72 20 6e 65 65 64 73 20 74  o longer needs t
35a20 68 65 20 70 43 6c 69 65 6e 74 44 61 74 61 20 70  he pClientData p
35a30 6f 69 6e 74 65 72 2e 20 20 5e 54 68 65 20 64 65  ointer.  ^The de
35a40 73 74 72 75 63 74 6f 72 20 77 69 6c 6c 20 61 6c  structor will al
35a50 73 6f 0a 2a 2a 20 62 65 20 69 6e 76 6f 6b 65 64  so.** be invoked
35a60 20 69 66 20 74 68 65 20 63 61 6c 6c 20 74 6f 20   if the call to 
35a70 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 6d  sqlite3_create_m
35a80 6f 64 75 6c 65 5f 76 32 28 29 20 66 61 69 6c 73  odule_v2() fails
35a90 2e 0a 2a 2a 20 5e 54 68 65 20 73 71 6c 69 74 65  ..** ^The sqlite
35aa0 33 5f 63 72 65 61 74 65 5f 6d 6f 64 75 6c 65 28  3_create_module(
35ab0 29 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 20 69  ).** interface i
35ac0 73 20 65 71 75 69 76 61 6c 65 6e 74 20 74 6f 20  s equivalent to 
35ad0 73 71 6c 69 74 65 33 5f 63 72 65 61 74 65 5f 6d  sqlite3_create_m
35ae0 6f 64 75 6c 65 5f 76 32 28 29 20 77 69 74 68 20  odule_v2() with 
35af0 61 20 4e 55 4c 4c 0a 2a 2a 20 64 65 73 74 72 75  a NULL.** destru
35b00 63 74 6f 72 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c  ctor..*/.int sql
35b10 69 74 65 33 5f 63 72 65 61 74 65 5f 6d 6f 64 75  ite3_create_modu
35b20 6c 65 28 0a 20 20 73 71 6c 69 74 65 33 20 2a 64  le(.  sqlite3 *d
35b30 62 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20  b,              
35b40 20 2f 2a 20 53 51 4c 69 74 65 20 63 6f 6e 6e 65   /* SQLite conne
35b50 63 74 69 6f 6e 20 74 6f 20 72 65 67 69 73 74 65  ction to registe
35b60 72 20 6d 6f 64 75 6c 65 20 77 69 74 68 20 2a 2f  r module with */
35b70 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a  .  const char *z
35b80 4e 61 6d 65 2c 20 20 20 20 20 20 20 20 20 2f 2a  Name,         /*
35b90 20 4e 61 6d 65 20 6f 66 20 74 68 65 20 6d 6f 64   Name of the mod
35ba0 75 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20 73  ule */.  const s
35bb0 71 6c 69 74 65 33 5f 6d 6f 64 75 6c 65 20 2a 70  qlite3_module *p
35bc0 2c 20 20 20 2f 2a 20 4d 65 74 68 6f 64 73 20 66  ,   /* Methods f
35bd0 6f 72 20 74 68 65 20 6d 6f 64 75 6c 65 20 2a 2f  or the module */
35be0 0a 20 20 76 6f 69 64 20 2a 70 43 6c 69 65 6e 74  .  void *pClient
35bf0 44 61 74 61 20 20 20 20 20 20 20 20 20 20 2f 2a  Data          /*
35c00 20 43 6c 69 65 6e 74 20 64 61 74 61 20 66 6f 72   Client data for
35c10 20 78 43 72 65 61 74 65 2f 78 43 6f 6e 6e 65 63   xCreate/xConnec
35c20 74 20 2a 2f 0a 29 3b 0a 69 6e 74 20 73 71 6c 69  t */.);.int sqli
35c30 74 65 33 5f 63 72 65 61 74 65 5f 6d 6f 64 75 6c  te3_create_modul
35c40 65 5f 76 32 28 0a 20 20 73 71 6c 69 74 65 33 20  e_v2(.  sqlite3 
35c50 2a 64 62 2c 20 20 20 20 20 20 20 20 20 20 20 20  *db,            
35c60 20 20 20 2f 2a 20 53 51 4c 69 74 65 20 63 6f 6e     /* SQLite con
35c70 6e 65 63 74 69 6f 6e 20 74 6f 20 72 65 67 69 73  nection to regis
35c80 74 65 72 20 6d 6f 64 75 6c 65 20 77 69 74 68 20  ter module with 
35c90 2a 2f 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20  */.  const char 
35ca0 2a 7a 4e 61 6d 65 2c 20 20 20 20 20 20 20 20 20  *zName,         
35cb0 2f 2a 20 4e 61 6d 65 20 6f 66 20 74 68 65 20 6d  /* Name of the m
35cc0 6f 64 75 6c 65 20 2a 2f 0a 20 20 63 6f 6e 73 74  odule */.  const
35cd0 20 73 71 6c 69 74 65 33 5f 6d 6f 64 75 6c 65 20   sqlite3_module 
35ce0 2a 70 2c 20 20 20 2f 2a 20 4d 65 74 68 6f 64 73  *p,   /* Methods
35cf0 20 66 6f 72 20 74 68 65 20 6d 6f 64 75 6c 65 20   for the module 
35d00 2a 2f 0a 20 20 76 6f 69 64 20 2a 70 43 6c 69 65  */.  void *pClie
35d10 6e 74 44 61 74 61 2c 20 20 20 20 20 20 20 20 20  ntData,         
35d20 2f 2a 20 43 6c 69 65 6e 74 20 64 61 74 61 20 66  /* Client data f
35d30 6f 72 20 78 43 72 65 61 74 65 2f 78 43 6f 6e 6e  or xCreate/xConn
35d40 65 63 74 20 2a 2f 0a 20 20 76 6f 69 64 28 2a 78  ect */.  void(*x
35d50 44 65 73 74 72 6f 79 29 28 76 6f 69 64 2a 29 20  Destroy)(void*) 
35d60 20 20 20 20 2f 2a 20 4d 6f 64 75 6c 65 20 64 65      /* Module de
35d70 73 74 72 75 63 74 6f 72 20 66 75 6e 63 74 69 6f  structor functio
35d80 6e 20 2a 2f 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43  n */.);../*.** C
35d90 41 50 49 33 52 45 46 3a 20 56 69 72 74 75 61 6c  API3REF: Virtual
35da0 20 54 61 62 6c 65 20 49 6e 73 74 61 6e 63 65 20   Table Instance 
35db0 4f 62 6a 65 63 74 0a 2a 2a 20 4b 45 59 57 4f 52  Object.** KEYWOR
35dc0 44 53 3a 20 73 71 6c 69 74 65 33 5f 76 74 61 62  DS: sqlite3_vtab
35dd0 0a 2a 2a 0a 2a 2a 20 45 76 65 72 79 20 5b 76 69  .**.** Every [vi
35de0 72 74 75 61 6c 20 74 61 62 6c 65 20 6d 6f 64 75  rtual table modu
35df0 6c 65 5d 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  le] implementati
35e00 6f 6e 20 75 73 65 73 20 61 20 73 75 62 63 6c 61  on uses a subcla
35e10 73 73 0a 2a 2a 20 6f 66 20 74 68 69 73 20 6f 62  ss.** of this ob
35e20 6a 65 63 74 20 74 6f 20 64 65 73 63 72 69 62 65  ject to describe
35e30 20 61 20 70 61 72 74 69 63 75 6c 61 72 20 69 6e   a particular in
35e40 73 74 61 6e 63 65 0a 2a 2a 20 6f 66 20 74 68 65  stance.** of the
35e50 20 5b 76 69 72 74 75 61 6c 20 74 61 62 6c 65 5d   [virtual table]
35e60 2e 20 20 45 61 63 68 20 73 75 62 63 6c 61 73 73  .  Each subclass
35e70 20 77 69 6c 6c 0a 2a 2a 20 62 65 20 74 61 69 6c   will.** be tail
35e80 6f 72 65 64 20 74 6f 20 74 68 65 20 73 70 65 63  ored to the spec
35e90 69 66 69 63 20 6e 65 65 64 73 20 6f 66 20 74 68  ific needs of th
35ea0 65 20 6d 6f 64 75 6c 65 20 69 6d 70 6c 65 6d 65  e module impleme
35eb0 6e 74 61 74 69 6f 6e 2e 0a 2a 2a 20 54 68 65 20  ntation..** The 
35ec0 70 75 72 70 6f 73 65 20 6f 66 20 74 68 69 73 20  purpose of this 
35ed0 73 75 70 65 72 63 6c 61 73 73 20 69 73 20 74 6f  superclass is to
35ee0 20 64 65 66 69 6e 65 20 63 65 72 74 61 69 6e 20   define certain 
35ef0 66 69 65 6c 64 73 20 74 68 61 74 20 61 72 65 0a  fields that are.
35f00 2a 2a 20 63 6f 6d 6d 6f 6e 20 74 6f 20 61 6c 6c  ** common to all
35f10 20 6d 6f 64 75 6c 65 20 69 6d 70 6c 65 6d 65 6e   module implemen
35f20 74 61 74 69 6f 6e 73 2e 0a 2a 2a 0a 2a 2a 20 5e  tations..**.** ^
35f30 56 69 72 74 75 61 6c 20 74 61 62 6c 65 73 20 6d  Virtual tables m
35f40 65 74 68 6f 64 73 20 63 61 6e 20 73 65 74 20 61  ethods can set a
35f50 6e 20 65 72 72 6f 72 20 6d 65 73 73 61 67 65 20  n error message 
35f60 62 79 20 61 73 73 69 67 6e 69 6e 67 20 61 0a 2a  by assigning a.*
35f70 2a 20 73 74 72 69 6e 67 20 6f 62 74 61 69 6e 65  * string obtaine
35f80 64 20 66 72 6f 6d 20 5b 73 71 6c 69 74 65 33 5f  d from [sqlite3_
35f90 6d 70 72 69 6e 74 66 28 29 5d 20 74 6f 20 7a 45  mprintf()] to zE
35fa0 72 72 4d 73 67 2e 20 20 54 68 65 20 6d 65 74 68  rrMsg.  The meth
35fb0 6f 64 20 73 68 6f 75 6c 64 0a 2a 2a 20 74 61 6b  od should.** tak
35fc0 65 20 63 61 72 65 20 74 68 61 74 20 61 6e 79 20  e care that any 
35fd0 70 72 69 6f 72 20 73 74 72 69 6e 67 20 69 73 20  prior string is 
35fe0 66 72 65 65 64 20 62 79 20 61 20 63 61 6c 6c 20  freed by a call 
35ff0 74 6f 20 5b 73 71 6c 69 74 65 33 5f 66 72 65 65  to [sqlite3_free
36000 28 29 5d 0a 2a 2a 20 70 72 69 6f 72 20 74 6f 20  ()].** prior to 
36010 61 73 73 69 67 6e 69 6e 67 20 61 20 6e 65 77 20  assigning a new 
36020 73 74 72 69 6e 67 20 74 6f 20 7a 45 72 72 4d 73  string to zErrMs
36030 67 2e 20 20 5e 41 66 74 65 72 20 74 68 65 20 65  g.  ^After the e
36040 72 72 6f 72 20 6d 65 73 73 61 67 65 0a 2a 2a 20  rror message.** 
36050 69 73 20 64 65 6c 69 76 65 72 65 64 20 75 70 20  is delivered up 
36060 74 6f 20 74 68 65 20 63 6c 69 65 6e 74 20 61 70  to the client ap
36070 70 6c 69 63 61 74 69 6f 6e 2c 20 74 68 65 20 73  plication, the s
36080 74 72 69 6e 67 20 77 69 6c 6c 20 62 65 20 61 75  tring will be au
36090 74 6f 6d 61 74 69 63 61 6c 6c 79 0a 2a 2a 20 66  tomatically.** f
360a0 72 65 65 64 20 62 79 20 73 71 6c 69 74 65 33 5f  reed by sqlite3_
360b0 66 72 65 65 28 29 20 61 6e 64 20 74 68 65 20 7a  free() and the z
360c0 45 72 72 4d 73 67 20 66 69 65 6c 64 20 77 69 6c  ErrMsg field wil
360d0 6c 20 62 65 20 7a 65 72 6f 65 64 2e 0a 2a 2f 0a  l be zeroed..*/.
360e0 73 74 72 75 63 74 20 73 71 6c 69 74 65 33 5f 76  struct sqlite3_v
360f0 74 61 62 20 7b 0a 20 20 63 6f 6e 73 74 20 73 71  tab {.  const sq
36100 6c 69 74 65 33 5f 6d 6f 64 75 6c 65 20 2a 70 4d  lite3_module *pM
36110 6f 64 75 6c 65 3b 20 20 2f 2a 20 54 68 65 20 6d  odule;  /* The m
36120 6f 64 75 6c 65 20 66 6f 72 20 74 68 69 73 20 76  odule for this v
36130 69 72 74 75 61 6c 20 74 61 62 6c 65 20 2a 2f 0a  irtual table */.
36140 20 20 69 6e 74 20 6e 52 65 66 3b 20 20 20 20 20    int nRef;     
36150 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
36160 20 20 2f 2a 20 4e 4f 20 4c 4f 4e 47 45 52 20 55    /* NO LONGER U
36170 53 45 44 20 2a 2f 0a 20 20 63 68 61 72 20 2a 7a  SED */.  char *z
36180 45 72 72 4d 73 67 3b 20 20 20 20 20 20 20 20 20  ErrMsg;         
36190 20 20 20 20 20 20 20 20 20 2f 2a 20 45 72 72 6f           /* Erro
361a0 72 20 6d 65 73 73 61 67 65 20 66 72 6f 6d 20 73  r message from s
361b0 71 6c 69 74 65 33 5f 6d 70 72 69 6e 74 66 28 29  qlite3_mprintf()
361c0 20 2a 2f 0a 20 20 2f 2a 20 56 69 72 74 75 61 6c   */.  /* Virtual
361d0 20 74 61 62 6c 65 20 69 6d 70 6c 65 6d 65 6e 74   table implement
361e0 61 74 69 6f 6e 73 20 77 69 6c 6c 20 74 79 70 69  ations will typi
361f0 63 61 6c 6c 79 20 61 64 64 20 61 64 64 69 74 69  cally add additi
36200 6f 6e 61 6c 20 66 69 65 6c 64 73 20 2a 2f 0a 7d  onal fields */.}
36210 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49 33 52 45  ;../*.** CAPI3RE
36220 46 3a 20 56 69 72 74 75 61 6c 20 54 61 62 6c 65  F: Virtual Table
36230 20 43 75 72 73 6f 72 20 4f 62 6a 65 63 74 0a 2a   Cursor Object.*
36240 2a 20 4b 45 59 57 4f 52 44 53 3a 20 73 71 6c 69  * KEYWORDS: sqli
36250 74 65 33 5f 76 74 61 62 5f 63 75 72 73 6f 72 20  te3_vtab_cursor 
36260 7b 76 69 72 74 75 61 6c 20 74 61 62 6c 65 20 63  {virtual table c
36270 75 72 73 6f 72 7d 0a 2a 2a 0a 2a 2a 20 45 76 65  ursor}.**.** Eve
36280 72 79 20 5b 76 69 72 74 75 61 6c 20 74 61 62 6c  ry [virtual tabl
36290 65 20 6d 6f 64 75 6c 65 5d 20 69 6d 70 6c 65 6d  e module] implem
362a0 65 6e 74 61 74 69 6f 6e 20 75 73 65 73 20 61 20  entation uses a 
362b0 73 75 62 63 6c 61 73 73 20 6f 66 20 74 68 65 0a  subclass of the.
362c0 2a 2a 20 66 6f 6c 6c 6f 77 69 6e 67 20 73 74 72  ** following str
362d0 75 63 74 75 72 65 20 74 6f 20 64 65 73 63 72 69  ucture to descri
362e0 62 65 20 63 75 72 73 6f 72 73 20 74 68 61 74 20  be cursors that 
362f0 70 6f 69 6e 74 20 69 6e 74 6f 20 74 68 65 0a 2a  point into the.*
36300 2a 20 5b 76 69 72 74 75 61 6c 20 74 61 62 6c 65  * [virtual table
36310 5d 20 61 6e 64 20 61 72 65 20 75 73 65 64 0a 2a  ] and are used.*
36320 2a 20 74 6f 20 6c 6f 6f 70 20 74 68 72 6f 75 67  * to loop throug
36330 68 20 74 68 65 20 76 69 72 74 75 61 6c 20 74 61  h the virtual ta
36340 62 6c 65 2e 20 20 43 75 72 73 6f 72 73 20 61 72  ble.  Cursors ar
36350 65 20 63 72 65 61 74 65 64 20 75 73 69 6e 67 20  e created using 
36360 74 68 65 0a 2a 2a 20 5b 73 71 6c 69 74 65 33 5f  the.** [sqlite3_
36370 6d 6f 64 75 6c 65 2e 78 4f 70 65 6e 20 7c 20 78  module.xOpen | x
36380 4f 70 65 6e 5d 20 6d 65 74 68 6f 64 20 6f 66 20  Open] method of 
36390 74 68 65 20 6d 6f 64 75 6c 65 20 61 6e 64 20 61  the module and a
363a0 72 65 20 64 65 73 74 72 6f 79 65 64 0a 2a 2a 20  re destroyed.** 
363b0 62 79 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  by the [sqlite3_
363c0 6d 6f 64 75 6c 65 2e 78 43 6c 6f 73 65 20 7c 20  module.xClose | 
363d0 78 43 6c 6f 73 65 5d 20 6d 65 74 68 6f 64 2e 20  xClose] method. 
363e0 20 43 75 72 73 6f 72 73 20 61 72 65 20 75 73 65   Cursors are use
363f0 64 0a 2a 2a 20 62 79 20 74 68 65 20 5b 78 46 69  d.** by the [xFi
36400 6c 74 65 72 5d 2c 20 5b 78 4e 65 78 74 5d 2c 20  lter], [xNext], 
36410 5b 78 45 6f 66 5d 2c 20 5b 78 43 6f 6c 75 6d 6e  [xEof], [xColumn
36420 5d 2c 20 61 6e 64 20 5b 78 52 6f 77 69 64 5d 20  ], and [xRowid] 
36430 6d 65 74 68 6f 64 73 0a 2a 2a 20 6f 66 20 74 68  methods.** of th
36440 65 20 6d 6f 64 75 6c 65 2e 20 20 45 61 63 68 20  e module.  Each 
36450 6d 6f 64 75 6c 65 20 69 6d 70 6c 65 6d 65 6e 74  module implement
36460 61 74 69 6f 6e 20 77 69 6c 6c 20 64 65 66 69 6e  ation will defin
36470 65 0a 2a 2a 20 74 68 65 20 63 6f 6e 74 65 6e 74  e.** the content
36480 20 6f 66 20 61 20 63 75 72 73 6f 72 20 73 74 72   of a cursor str
36490 75 63 74 75 72 65 20 74 6f 20 73 75 69 74 20 69  ucture to suit i
364a0 74 73 20 6f 77 6e 20 6e 65 65 64 73 2e 0a 2a 2a  ts own needs..**
364b0 0a 2a 2a 20 54 68 69 73 20 73 75 70 65 72 63 6c  .** This supercl
364c0 61 73 73 20 65 78 69 73 74 73 20 69 6e 20 6f 72  ass exists in or
364d0 64 65 72 20 74 6f 20 64 65 66 69 6e 65 20 66 69  der to define fi
364e0 65 6c 64 73 20 6f 66 20 74 68 65 20 63 75 72 73  elds of the curs
364f0 6f 72 20 74 68 61 74 0a 2a 2a 20 61 72 65 20 63  or that.** are c
36500 6f 6d 6d 6f 6e 20 74 6f 20 61 6c 6c 20 69 6d 70  ommon to all imp
36510 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 2e 0a 2a 2f  lementations..*/
36520 0a 73 74 72 75 63 74 20 73 71 6c 69 74 65 33 5f  .struct sqlite3_
36530 76 74 61 62 5f 63 75 72 73 6f 72 20 7b 0a 20 20  vtab_cursor {.  
36540 73 71 6c 69 74 65 33 5f 76 74 61 62 20 2a 70 56  sqlite3_vtab *pV
36550 74 61 62 3b 20 20 20 20 20 20 2f 2a 20 56 69 72  tab;      /* Vir
36560 74 75 61 6c 20 74 61 62 6c 65 20 6f 66 20 74 68  tual table of th
36570 69 73 20 63 75 72 73 6f 72 20 2a 2f 0a 20 20 2f  is cursor */.  /
36580 2a 20 56 69 72 74 75 61 6c 20 74 61 62 6c 65 20  * Virtual table 
36590 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20  implementations 
365a0 77 69 6c 6c 20 74 79 70 69 63 61 6c 6c 79 20 61  will typically a
365b0 64 64 20 61 64 64 69 74 69 6f 6e 61 6c 20 66 69  dd additional fi
365c0 65 6c 64 73 20 2a 2f 0a 7d 3b 0a 0a 2f 2a 0a 2a  elds */.};../*.*
365d0 2a 20 43 41 50 49 33 52 45 46 3a 20 44 65 63 6c  * CAPI3REF: Decl
365e0 61 72 65 20 54 68 65 20 53 63 68 65 6d 61 20 4f  are The Schema O
365f0 66 20 41 20 56 69 72 74 75 61 6c 20 54 61 62 6c  f A Virtual Tabl
36600 65 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 5b 78 43  e.**.** ^The [xC
36610 72 65 61 74 65 5d 20 61 6e 64 20 5b 78 43 6f 6e  reate] and [xCon
36620 6e 65 63 74 5d 20 6d 65 74 68 6f 64 73 20 6f 66  nect] methods of
36630 20 61 0a 2a 2a 20 5b 76 69 72 74 75 61 6c 20 74   a.** [virtual t
36640 61 62 6c 65 20 6d 6f 64 75 6c 65 5d 20 63 61 6c  able module] cal
36650 6c 20 74 68 69 73 20 69 6e 74 65 72 66 61 63 65  l this interface
36660 0a 2a 2a 20 74 6f 20 64 65 63 6c 61 72 65 20 74  .** to declare t
36670 68 65 20 66 6f 72 6d 61 74 20 28 74 68 65 20 6e  he format (the n
36680 61 6d 65 73 20 61 6e 64 20 64 61 74 61 74 79 70  ames and datatyp
36690 65 73 20 6f 66 20 74 68 65 20 63 6f 6c 75 6d 6e  es of the column
366a0 73 29 20 6f 66 0a 2a 2a 20 74 68 65 20 76 69 72  s) of.** the vir
366b0 74 75 61 6c 20 74 61 62 6c 65 73 20 74 68 65 79  tual tables they
366c0 20 69 6d 70 6c 65 6d 65 6e 74 2e 0a 2a 2f 0a 69   implement..*/.i
366d0 6e 74 20 73 71 6c 69 74 65 33 5f 64 65 63 6c 61  nt sqlite3_decla
366e0 72 65 5f 76 74 61 62 28 73 71 6c 69 74 65 33 2a  re_vtab(sqlite3*
366f0 2c 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 53  , const char *zS
36700 51 4c 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  QL);../*.** CAPI
36710 33 52 45 46 3a 20 4f 76 65 72 6c 6f 61 64 20 41  3REF: Overload A
36720 20 46 75 6e 63 74 69 6f 6e 20 46 6f 72 20 41 20   Function For A 
36730 56 69 72 74 75 61 6c 20 54 61 62 6c 65 0a 2a 2a  Virtual Table.**
36740 0a 2a 2a 20 5e 28 56 69 72 74 75 61 6c 20 74 61  .** ^(Virtual ta
36750 62 6c 65 73 20 63 61 6e 20 70 72 6f 76 69 64 65  bles can provide
36760 20 61 6c 74 65 72 6e 61 74 69 76 65 20 69 6d 70   alternative imp
36770 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20 6f 66 20  lementations of 
36780 66 75 6e 63 74 69 6f 6e 73 0a 2a 2a 20 75 73 69  functions.** usi
36790 6e 67 20 74 68 65 20 5b 78 46 69 6e 64 46 75 6e  ng the [xFindFun
367a0 63 74 69 6f 6e 5d 20 6d 65 74 68 6f 64 20 6f 66  ction] method of
367b0 20 74 68 65 20 5b 76 69 72 74 75 61 6c 20 74 61   the [virtual ta
367c0 62 6c 65 20 6d 6f 64 75 6c 65 5d 2e 20 20 0a 2a  ble module].  .*
367d0 2a 20 42 75 74 20 67 6c 6f 62 61 6c 20 76 65 72  * But global ver
367e0 73 69 6f 6e 73 20 6f 66 20 74 68 6f 73 65 20 66  sions of those f
367f0 75 6e 63 74 69 6f 6e 73 0a 2a 2a 20 6d 75 73 74  unctions.** must
36800 20 65 78 69 73 74 20 69 6e 20 6f 72 64 65 72 20   exist in order 
36810 74 6f 20 62 65 20 6f 76 65 72 6c 6f 61 64 65 64  to be overloaded
36820 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 69 73  .)^.**.** ^(This
36830 20 41 50 49 20 6d 61 6b 65 73 20 73 75 72 65 20   API makes sure 
36840 61 20 67 6c 6f 62 61 6c 20 76 65 72 73 69 6f 6e  a global version
36850 20 6f 66 20 61 20 66 75 6e 63 74 69 6f 6e 20 77   of a function w
36860 69 74 68 20 61 20 70 61 72 74 69 63 75 6c 61 72  ith a particular
36870 0a 2a 2a 20 6e 61 6d 65 20 61 6e 64 20 6e 75 6d  .** name and num
36880 62 65 72 20 6f 66 20 70 61 72 61 6d 65 74 65 72  ber of parameter
36890 73 20 65 78 69 73 74 73 2e 20 20 49 66 20 6e 6f  s exists.  If no
368a0 20 73 75 63 68 20 66 75 6e 63 74 69 6f 6e 20 65   such function e
368b0 78 69 73 74 73 0a 2a 2a 20 62 65 66 6f 72 65 20  xists.** before 
368c0 74 68 69 73 20 41 50 49 20 69 73 20 63 61 6c 6c  this API is call
368d0 65 64 2c 20 61 20 6e 65 77 20 66 75 6e 63 74 69  ed, a new functi
368e0 6f 6e 20 69 73 20 63 72 65 61 74 65 64 2e 29 5e  on is created.)^
368f0 20 20 5e 54 68 65 20 69 6d 70 6c 65 6d 65 6e 74    ^The implement
36900 61 74 69 6f 6e 0a 2a 2a 20 6f 66 20 74 68 65 20  ation.** of the 
36910 6e 65 77 20 66 75 6e 63 74 69 6f 6e 20 61 6c 77  new function alw
36920 61 79 73 20 63 61 75 73 65 73 20 61 6e 20 65 78  ays causes an ex
36930 63 65 70 74 69 6f 6e 20 74 6f 20 62 65 20 74 68  ception to be th
36940 72 6f 77 6e 2e 20 20 53 6f 0a 2a 2a 20 74 68 65  rown.  So.** the
36950 20 6e 65 77 20 66 75 6e 63 74 69 6f 6e 20 69 73   new function is
36960 20 6e 6f 74 20 67 6f 6f 64 20 66 6f 72 20 61 6e   not good for an
36970 79 74 68 69 6e 67 20 62 79 20 69 74 73 65 6c 66  ything by itself
36980 2e 20 20 49 74 73 20 6f 6e 6c 79 0a 2a 2a 20 70  .  Its only.** p
36990 75 72 70 6f 73 65 20 69 73 20 74 6f 20 62 65 20  urpose is to be 
369a0 61 20 70 6c 61 63 65 68 6f 6c 64 65 72 20 66 75  a placeholder fu
369b0 6e 63 74 69 6f 6e 20 74 68 61 74 20 63 61 6e 20  nction that can 
369c0 62 65 20 6f 76 65 72 6c 6f 61 64 65 64 0a 2a 2a  be overloaded.**
369d0 20 62 79 20 61 20 5b 76 69 72 74 75 61 6c 20 74   by a [virtual t
369e0 61 62 6c 65 5d 2e 0a 2a 2f 0a 69 6e 74 20 73 71  able]..*/.int sq
369f0 6c 69 74 65 33 5f 6f 76 65 72 6c 6f 61 64 5f 66  lite3_overload_f
36a00 75 6e 63 74 69 6f 6e 28 73 71 6c 69 74 65 33 2a  unction(sqlite3*
36a10 2c 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 46  , const char *zF
36a20 75 6e 63 4e 61 6d 65 2c 20 69 6e 74 20 6e 41 72  uncName, int nAr
36a30 67 29 3b 0a 0a 2f 2a 0a 2a 2a 20 54 68 65 20 69  g);../*.** The i
36a40 6e 74 65 72 66 61 63 65 20 74 6f 20 74 68 65 20  nterface to the 
36a50 76 69 72 74 75 61 6c 2d 74 61 62 6c 65 20 6d 65  virtual-table me
36a60 63 68 61 6e 69 73 6d 20 64 65 66 69 6e 65 64 20  chanism defined 
36a70 61 62 6f 76 65 20 28 62 61 63 6b 20 75 70 0a 2a  above (back up.*
36a80 2a 20 74 6f 20 61 20 63 6f 6d 6d 65 6e 74 20 72  * to a comment r
36a90 65 6d 61 72 6b 61 62 6c 79 20 73 69 6d 69 6c 61  emarkably simila
36aa0 72 20 74 6f 20 74 68 69 73 20 6f 6e 65 29 20 69  r to this one) i
36ab0 73 20 63 75 72 72 65 6e 74 6c 79 20 63 6f 6e 73  s currently cons
36ac0 69 64 65 72 65 64 0a 2a 2a 20 74 6f 20 62 65 20  idered.** to be 
36ad0 65 78 70 65 72 69 6d 65 6e 74 61 6c 2e 20 20 54  experimental.  T
36ae0 68 65 20 69 6e 74 65 72 66 61 63 65 20 6d 69 67  he interface mig
36af0 68 74 20 63 68 61 6e 67 65 20 69 6e 20 69 6e 63  ht change in inc
36b00 6f 6d 70 61 74 69 62 6c 65 20 77 61 79 73 2e 0a  ompatible ways..
36b10 2a 2a 20 49 66 20 74 68 69 73 20 69 73 20 61 20  ** If this is a 
36b20 70 72 6f 62 6c 65 6d 20 66 6f 72 20 79 6f 75 2c  problem for you,
36b30 20 64 6f 20 6e 6f 74 20 75 73 65 20 74 68 65 20   do not use the 
36b40 69 6e 74 65 72 66 61 63 65 20 61 74 20 74 68 69  interface at thi
36b50 73 20 74 69 6d 65 2e 0a 2a 2a 0a 2a 2a 20 57 68  s time..**.** Wh
36b60 65 6e 20 74 68 65 20 76 69 72 74 75 61 6c 2d 74  en the virtual-t
36b70 61 62 6c 65 20 6d 65 63 68 61 6e 69 73 6d 20 73  able mechanism s
36b80 74 61 62 69 6c 69 7a 65 73 2c 20 77 65 20 77 69  tabilizes, we wi
36b90 6c 6c 20 64 65 63 6c 61 72 65 20 74 68 65 0a 2a  ll declare the.*
36ba0 2a 20 69 6e 74 65 72 66 61 63 65 20 66 69 78 65  * interface fixe
36bb0 64 2c 20 73 75 70 70 6f 72 74 20 69 74 20 69 6e  d, support it in
36bc0 64 65 66 69 6e 69 74 65 6c 79 2c 20 61 6e 64 20  definitely, and 
36bd0 72 65 6d 6f 76 65 20 74 68 69 73 20 63 6f 6d 6d  remove this comm
36be0 65 6e 74 2e 0a 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 43  ent..*/../*.** C
36bf0 41 50 49 33 52 45 46 3a 20 41 20 48 61 6e 64 6c  API3REF: A Handl
36c00 65 20 54 6f 20 41 6e 20 4f 70 65 6e 20 42 4c 4f  e To An Open BLO
36c10 42 0a 2a 2a 20 4b 45 59 57 4f 52 44 53 3a 20 7b  B.** KEYWORDS: {
36c20 42 4c 4f 42 20 68 61 6e 64 6c 65 7d 20 7b 42 4c  BLOB handle} {BL
36c30 4f 42 20 68 61 6e 64 6c 65 73 7d 0a 2a 2a 0a 2a  OB handles}.**.*
36c40 2a 20 41 6e 20 69 6e 73 74 61 6e 63 65 20 6f 66  * An instance of
36c50 20 74 68 69 73 20 6f 62 6a 65 63 74 20 72 65 70   this object rep
36c60 72 65 73 65 6e 74 73 20 61 6e 20 6f 70 65 6e 20  resents an open 
36c70 42 4c 4f 42 20 6f 6e 20 77 68 69 63 68 0a 2a 2a  BLOB on which.**
36c80 20 5b 73 71 6c 69 74 65 33 5f 62 6c 6f 62 5f 6f   [sqlite3_blob_o
36c90 70 65 6e 20 7c 20 69 6e 63 72 65 6d 65 6e 74 61  pen | incrementa
36ca0 6c 20 42 4c 4f 42 20 49 2f 4f 5d 20 63 61 6e 20  l BLOB I/O] can 
36cb0 62 65 20 70 65 72 66 6f 72 6d 65 64 2e 0a 2a 2a  be performed..**
36cc0 20 5e 4f 62 6a 65 63 74 73 20 6f 66 20 74 68 69   ^Objects of thi
36cd0 73 20 74 79 70 65 20 61 72 65 20 63 72 65 61 74  s type are creat
36ce0 65 64 20 62 79 20 5b 73 71 6c 69 74 65 33 5f 62  ed by [sqlite3_b
36cf0 6c 6f 62 5f 6f 70 65 6e 28 29 5d 0a 2a 2a 20 61  lob_open()].** a
36d00 6e 64 20 64 65 73 74 72 6f 79 65 64 20 62 79 20  nd destroyed by 
36d10 5b 73 71 6c 69 74 65 33 5f 62 6c 6f 62 5f 63 6c  [sqlite3_blob_cl
36d20 6f 73 65 28 29 5d 2e 0a 2a 2a 20 5e 54 68 65 20  ose()]..** ^The 
36d30 5b 73 71 6c 69 74 65 33 5f 62 6c 6f 62 5f 72 65  [sqlite3_blob_re
36d40 61 64 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69 74  ad()] and [sqlit
36d50 65 33 5f 62 6c 6f 62 5f 77 72 69 74 65 28 29 5d  e3_blob_write()]
36d60 20 69 6e 74 65 72 66 61 63 65 73 0a 2a 2a 20 63   interfaces.** c
36d70 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20 72 65  an be used to re
36d80 61 64 20 6f 72 20 77 72 69 74 65 20 73 6d 61 6c  ad or write smal
36d90 6c 20 73 75 62 73 65 63 74 69 6f 6e 73 20 6f 66  l subsections of
36da0 20 74 68 65 20 42 4c 4f 42 2e 0a 2a 2a 20 5e 54   the BLOB..** ^T
36db0 68 65 20 5b 73 71 6c 69 74 65 33 5f 62 6c 6f 62  he [sqlite3_blob
36dc0 5f 62 79 74 65 73 28 29 5d 20 69 6e 74 65 72 66  _bytes()] interf
36dd0 61 63 65 20 72 65 74 75 72 6e 73 20 74 68 65 20  ace returns the 
36de0 73 69 7a 65 20 6f 66 20 74 68 65 20 42 4c 4f 42  size of the BLOB
36df0 20 69 6e 20 62 79 74 65 73 2e 0a 2a 2f 0a 74 79   in bytes..*/.ty
36e00 70 65 64 65 66 20 73 74 72 75 63 74 20 73 71 6c  pedef struct sql
36e10 69 74 65 33 5f 62 6c 6f 62 20 73 71 6c 69 74 65  ite3_blob sqlite
36e20 33 5f 62 6c 6f 62 3b 0a 0a 2f 2a 0a 2a 2a 20 43  3_blob;../*.** C
36e30 41 50 49 33 52 45 46 3a 20 4f 70 65 6e 20 41 20  API3REF: Open A 
36e40 42 4c 4f 42 20 46 6f 72 20 49 6e 63 72 65 6d 65  BLOB For Increme
36e50 6e 74 61 6c 20 49 2f 4f 0a 2a 2a 0a 2a 2a 20 5e  ntal I/O.**.** ^
36e60 28 54 68 69 73 20 69 6e 74 65 72 66 61 63 65 73  (This interfaces
36e70 20 6f 70 65 6e 73 20 61 20 5b 42 4c 4f 42 20 68   opens a [BLOB h
36e80 61 6e 64 6c 65 20 7c 20 68 61 6e 64 6c 65 5d 20  andle | handle] 
36e90 74 6f 20 74 68 65 20 42 4c 4f 42 20 6c 6f 63 61  to the BLOB loca
36ea0 74 65 64 0a 2a 2a 20 69 6e 20 72 6f 77 20 69 52  ted.** in row iR
36eb0 6f 77 2c 20 63 6f 6c 75 6d 6e 20 7a 43 6f 6c 75  ow, column zColu
36ec0 6d 6e 2c 20 74 61 62 6c 65 20 7a 54 61 62 6c 65  mn, table zTable
36ed0 20 69 6e 20 64 61 74 61 62 61 73 65 20 7a 44 62   in database zDb
36ee0 3b 0a 2a 2a 20 69 6e 20 6f 74 68 65 72 20 77 6f  ;.** in other wo
36ef0 72 64 73 2c 20 74 68 65 20 73 61 6d 65 20 42 4c  rds, the same BL
36f00 4f 42 20 74 68 61 74 20 77 6f 75 6c 64 20 62 65  OB that would be
36f10 20 73 65 6c 65 63 74 65 64 20 62 79 3a 0a 2a 2a   selected by:.**
36f20 0a 2a 2a 20 3c 70 72 65 3e 0a 2a 2a 20 20 20 20  .** <pre>.**    
36f30 20 53 45 4c 45 43 54 20 7a 43 6f 6c 75 6d 6e 20   SELECT zColumn 
36f40 46 52 4f 4d 20 7a 44 62 2e 7a 54 61 62 6c 65 20  FROM zDb.zTable 
36f50 57 48 45 52 45 20 5b 72 6f 77 69 64 5d 20 3d 20  WHERE [rowid] = 
36f60 69 52 6f 77 3b 0a 2a 2a 20 3c 2f 70 72 65 3e 29  iRow;.** </pre>)
36f70 5e 0a 2a 2a 0a 2a 2a 20 5e 49 66 20 74 68 65 20  ^.**.** ^If the 
36f80 66 6c 61 67 73 20 70 61 72 61 6d 65 74 65 72 20  flags parameter 
36f90 69 73 20 6e 6f 6e 2d 7a 65 72 6f 2c 20 74 68 65  is non-zero, the
36fa0 6e 20 74 68 65 20 42 4c 4f 42 20 69 73 20 6f 70  n the BLOB is op
36fb0 65 6e 65 64 20 66 6f 72 20 72 65 61 64 0a 2a 2a  ened for read.**
36fc0 20 61 6e 64 20 77 72 69 74 65 20 61 63 63 65 73   and write acces
36fd0 73 2e 20 5e 49 66 20 69 74 20 69 73 20 7a 65 72  s. ^If it is zer
36fe0 6f 2c 20 74 68 65 20 42 4c 4f 42 20 69 73 20 6f  o, the BLOB is o
36ff0 70 65 6e 65 64 20 66 6f 72 20 72 65 61 64 20 61  pened for read a
37000 63 63 65 73 73 2e 0a 2a 2a 20 5e 49 74 20 69 73  ccess..** ^It is
37010 20 6e 6f 74 20 70 6f 73 73 69 62 6c 65 20 74 6f   not possible to
37020 20 6f 70 65 6e 20 61 20 63 6f 6c 75 6d 6e 20 74   open a column t
37030 68 61 74 20 69 73 20 70 61 72 74 20 6f 66 20 61  hat is part of a
37040 6e 20 69 6e 64 65 78 20 6f 72 20 70 72 69 6d 61  n index or prima
37050 72 79 20 0a 2a 2a 20 6b 65 79 20 66 6f 72 20 77  ry .** key for w
37060 72 69 74 69 6e 67 2e 20 5e 49 66 20 5b 66 6f 72  riting. ^If [for
37070 65 69 67 6e 20 6b 65 79 20 63 6f 6e 73 74 72 61  eign key constra
37080 69 6e 74 73 5d 20 61 72 65 20 65 6e 61 62 6c 65  ints] are enable
37090 64 2c 20 69 74 20 69 73 20 0a 2a 2a 20 6e 6f 74  d, it is .** not
370a0 20 70 6f 73 73 69 62 6c 65 20 74 6f 20 6f 70 65   possible to ope
370b0 6e 20 61 20 63 6f 6c 75 6d 6e 20 74 68 61 74 20  n a column that 
370c0 69 73 20 70 61 72 74 20 6f 66 20 61 20 5b 63 68  is part of a [ch
370d0 69 6c 64 20 6b 65 79 5d 20 66 6f 72 20 77 72 69  ild key] for wri
370e0 74 69 6e 67 2e 0a 2a 2a 0a 2a 2a 20 5e 4e 6f 74  ting..**.** ^Not
370f0 65 20 74 68 61 74 20 74 68 65 20 64 61 74 61 62  e that the datab
37100 61 73 65 20 6e 61 6d 65 20 69 73 20 6e 6f 74 20  ase name is not 
37110 74 68 65 20 66 69 6c 65 6e 61 6d 65 20 74 68 61  the filename tha
37120 74 20 63 6f 6e 74 61 69 6e 73 0a 2a 2a 20 74 68  t contains.** th
37130 65 20 64 61 74 61 62 61 73 65 20 62 75 74 20 72  e database but r
37140 61 74 68 65 72 20 74 68 65 20 73 79 6d 62 6f 6c  ather the symbol
37150 69 63 20 6e 61 6d 65 20 6f 66 20 74 68 65 20 64  ic name of the d
37160 61 74 61 62 61 73 65 20 74 68 61 74 0a 2a 2a 20  atabase that.** 
37170 61 70 70 65 61 72 73 20 61 66 74 65 72 20 74 68  appears after th
37180 65 20 41 53 20 6b 65 79 77 6f 72 64 20 77 68 65  e AS keyword whe
37190 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20 69  n the database i
371a0 73 20 63 6f 6e 6e 65 63 74 65 64 20 75 73 69 6e  s connected usin
371b0 67 20 5b 41 54 54 41 43 48 5d 2e 0a 2a 2a 20 5e  g [ATTACH]..** ^
371c0 46 6f 72 20 74 68 65 20 6d 61 69 6e 20 64 61 74  For the main dat
371d0 61 62 61 73 65 20 66 69 6c 65 2c 20 74 68 65 20  abase file, the 
371e0 64 61 74 61 62 61 73 65 20 6e 61 6d 65 20 69 73  database name is
371f0 20 22 6d 61 69 6e 22 2e 0a 2a 2a 20 5e 46 6f 72   "main"..** ^For
37200 20 54 45 4d 50 20 74 61 62 6c 65 73 2c 20 74 68   TEMP tables, th
37210 65 20 64 61 74 61 62 61 73 65 20 6e 61 6d 65 20  e database name 
37220 69 73 20 22 74 65 6d 70 22 2e 0a 2a 2a 0a 2a 2a  is "temp"..**.**
37230 20 5e 28 4f 6e 20 73 75 63 63 65 73 73 2c 20 5b   ^(On success, [
37240 53 51 4c 49 54 45 5f 4f 4b 5d 20 69 73 20 72 65  SQLITE_OK] is re
37250 74 75 72 6e 65 64 20 61 6e 64 20 74 68 65 20 6e  turned and the n
37260 65 77 20 5b 42 4c 4f 42 20 68 61 6e 64 6c 65 5d  ew [BLOB handle]
37270 20 69 73 20 77 72 69 74 74 65 6e 0a 2a 2a 20 74   is written.** t
37280 6f 20 2a 70 70 42 6c 6f 62 2e 20 4f 74 68 65 72  o *ppBlob. Other
37290 77 69 73 65 20 61 6e 20 5b 65 72 72 6f 72 20 63  wise an [error c
372a0 6f 64 65 5d 20 69 73 20 72 65 74 75 72 6e 65 64  ode] is returned
372b0 20 61 6e 64 20 2a 70 70 42 6c 6f 62 20 69 73 20   and *ppBlob is 
372c0 73 65 74 0a 2a 2a 20 74 6f 20 62 65 20 61 20 6e  set.** to be a n
372d0 75 6c 6c 20 70 6f 69 6e 74 65 72 2e 29 5e 0a 2a  ull pointer.)^.*
372e0 2a 20 5e 54 68 69 73 20 66 75 6e 63 74 69 6f 6e  * ^This function
372f0 20 73 65 74 73 20 74 68 65 20 5b 64 61 74 61 62   sets the [datab
37300 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 5d 20  ase connection] 
37310 65 72 72 6f 72 20 63 6f 64 65 20 61 6e 64 20 6d  error code and m
37320 65 73 73 61 67 65 0a 2a 2a 20 61 63 63 65 73 73  essage.** access
37330 69 62 6c 65 20 76 69 61 20 5b 73 71 6c 69 74 65  ible via [sqlite
37340 33 5f 65 72 72 63 6f 64 65 28 29 5d 20 61 6e 64  3_errcode()] and
37350 20 5b 73 71 6c 69 74 65 33 5f 65 72 72 6d 73 67   [sqlite3_errmsg
37360 28 29 5d 20 61 6e 64 20 72 65 6c 61 74 65 64 0a  ()] and related.
37370 2a 2a 20 66 75 6e 63 74 69 6f 6e 73 2e 20 5e 4e  ** functions. ^N
37380 6f 74 65 20 74 68 61 74 20 74 68 65 20 2a 70 70  ote that the *pp
37390 42 6c 6f 62 20 76 61 72 69 61 62 6c 65 20 69 73  Blob variable is
373a0 20 61 6c 77 61 79 73 20 69 6e 69 74 69 61 6c 69   always initiali
373b0 7a 65 64 20 69 6e 20 61 0a 2a 2a 20 77 61 79 20  zed in a.** way 
373c0 74 68 61 74 20 6d 61 6b 65 73 20 69 74 20 73 61  that makes it sa
373d0 66 65 20 74 6f 20 69 6e 76 6f 6b 65 20 5b 73 71  fe to invoke [sq
373e0 6c 69 74 65 33 5f 62 6c 6f 62 5f 63 6c 6f 73 65  lite3_blob_close
373f0 28 29 5d 20 6f 6e 20 2a 70 70 42 6c 6f 62 0a 2a  ()] on *ppBlob.*
37400 2a 20 72 65 67 61 72 64 6c 65 73 73 20 6f 66 20  * regardless of 
37410 74 68 65 20 73 75 63 63 65 73 73 20 6f 72 20 66  the success or f
37420 61 69 6c 75 72 65 20 6f 66 20 74 68 69 73 20 72  ailure of this r
37430 6f 75 74 69 6e 65 2e 0a 2a 2a 0a 2a 2a 20 5e 28  outine..**.** ^(
37440 49 66 20 74 68 65 20 72 6f 77 20 74 68 61 74 20  If the row that 
37450 61 20 42 4c 4f 42 20 68 61 6e 64 6c 65 20 70 6f  a BLOB handle po
37460 69 6e 74 73 20 74 6f 20 69 73 20 6d 6f 64 69 66  ints to is modif
37470 69 65 64 20 62 79 20 61 6e 0a 2a 2a 20 5b 55 50  ied by an.** [UP
37480 44 41 54 45 5d 2c 20 5b 44 45 4c 45 54 45 5d 2c  DATE], [DELETE],
37490 20 6f 72 20 62 79 20 5b 4f 4e 20 43 4f 4e 46 4c   or by [ON CONFL
374a0 49 43 54 5d 20 73 69 64 65 2d 65 66 66 65 63 74  ICT] side-effect
374b0 73 0a 2a 2a 20 74 68 65 6e 20 74 68 65 20 42 4c  s.** then the BL
374c0 4f 42 20 68 61 6e 64 6c 65 20 69 73 20 6d 61 72  OB handle is mar
374d0 6b 65 64 20 61 73 20 22 65 78 70 69 72 65 64 22  ked as "expired"
374e0 2e 0a 2a 2a 20 54 68 69 73 20 69 73 20 74 72 75  ..** This is tru
374f0 65 20 69 66 20 61 6e 79 20 63 6f 6c 75 6d 6e 20  e if any column 
37500 6f 66 20 74 68 65 20 72 6f 77 20 69 73 20 63 68  of the row is ch
37510 61 6e 67 65 64 2c 20 65 76 65 6e 20 61 20 63 6f  anged, even a co
37520 6c 75 6d 6e 0a 2a 2a 20 6f 74 68 65 72 20 74 68  lumn.** other th
37530 61 6e 20 74 68 65 20 6f 6e 65 20 74 68 65 20 42  an the one the B
37540 4c 4f 42 20 68 61 6e 64 6c 65 20 69 73 20 6f 70  LOB handle is op
37550 65 6e 20 6f 6e 2e 29 5e 0a 2a 2a 20 5e 43 61 6c  en on.)^.** ^Cal
37560 6c 73 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 62  ls to [sqlite3_b
37570 6c 6f 62 5f 72 65 61 64 28 29 5d 20 61 6e 64 20  lob_read()] and 
37580 5b 73 71 6c 69 74 65 33 5f 62 6c 6f 62 5f 77 72  [sqlite3_blob_wr
37590 69 74 65 28 29 5d 20 66 6f 72 0a 2a 2a 20 61 20  ite()] for.** a 
375a0 65 78 70 69 72 65 64 20 42 4c 4f 42 20 68 61 6e  expired BLOB han
375b0 64 6c 65 20 66 61 69 6c 20 77 69 74 68 20 61 6e  dle fail with an
375c0 20 72 65 74 75 72 6e 20 63 6f 64 65 20 6f 66 20   return code of 
375d0 5b 53 51 4c 49 54 45 5f 41 42 4f 52 54 5d 2e 0a  [SQLITE_ABORT]..
375e0 2a 2a 20 5e 28 43 68 61 6e 67 65 73 20 77 72 69  ** ^(Changes wri
375f0 74 74 65 6e 20 69 6e 74 6f 20 61 20 42 4c 4f 42  tten into a BLOB
37600 20 70 72 69 6f 72 20 74 6f 20 74 68 65 20 42 4c   prior to the BL
37610 4f 42 20 65 78 70 69 72 69 6e 67 20 61 72 65 20  OB expiring are 
37620 6e 6f 74 0a 2a 2a 20 72 6f 6c 6c 65 64 20 62 61  not.** rolled ba
37630 63 6b 20 62 79 20 74 68 65 20 65 78 70 69 72 61  ck by the expira
37640 74 69 6f 6e 20 6f 66 20 74 68 65 20 42 4c 4f 42  tion of the BLOB
37650 2e 20 20 53 75 63 68 20 63 68 61 6e 67 65 73 20  .  Such changes 
37660 77 69 6c 6c 20 65 76 65 6e 74 75 61 6c 6c 79 0a  will eventually.
37670 2a 2a 20 63 6f 6d 6d 69 74 20 69 66 20 74 68 65  ** commit if the
37680 20 74 72 61 6e 73 61 63 74 69 6f 6e 20 63 6f 6e   transaction con
37690 74 69 6e 75 65 73 20 74 6f 20 63 6f 6d 70 6c 65  tinues to comple
376a0 74 69 6f 6e 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 55  tion.)^.**.** ^U
376b0 73 65 20 74 68 65 20 5b 73 71 6c 69 74 65 33 5f  se the [sqlite3_
376c0 62 6c 6f 62 5f 62 79 74 65 73 28 29 5d 20 69 6e  blob_bytes()] in
376d0 74 65 72 66 61 63 65 20 74 6f 20 64 65 74 65 72  terface to deter
376e0 6d 69 6e 65 20 74 68 65 20 73 69 7a 65 20 6f 66  mine the size of
376f0 0a 2a 2a 20 74 68 65 20 6f 70 65 6e 65 64 20 62  .** the opened b
37700 6c 6f 62 2e 20 20 5e 54 68 65 20 73 69 7a 65 20  lob.  ^The size 
37710 6f 66 20 61 20 62 6c 6f 62 20 6d 61 79 20 6e 6f  of a blob may no
37720 74 20 62 65 20 63 68 61 6e 67 65 64 20 62 79 20  t be changed by 
37730 74 68 69 73 0a 2a 2a 20 69 6e 74 65 72 66 61 63  this.** interfac
37740 65 2e 20 20 55 73 65 20 74 68 65 20 5b 55 50 44  e.  Use the [UPD
37750 41 54 45 5d 20 53 51 4c 20 63 6f 6d 6d 61 6e 64  ATE] SQL command
37760 20 74 6f 20 63 68 61 6e 67 65 20 74 68 65 20 73   to change the s
37770 69 7a 65 20 6f 66 20 61 0a 2a 2a 20 62 6c 6f 62  ize of a.** blob
37780 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68 65 20 5b 73 71  ..**.** ^The [sq
37790 6c 69 74 65 33 5f 62 69 6e 64 5f 7a 65 72 6f 62  lite3_bind_zerob
377a0 6c 6f 62 28 29 5d 20 61 6e 64 20 5b 73 71 6c 69  lob()] and [sqli
377b0 74 65 33 5f 72 65 73 75 6c 74 5f 7a 65 72 6f 62  te3_result_zerob
377c0 6c 6f 62 28 29 5d 20 69 6e 74 65 72 66 61 63 65  lob()] interface
377d0 73 0a 2a 2a 20 61 6e 64 20 74 68 65 20 62 75 69  s.** and the bui
377e0 6c 74 2d 69 6e 20 5b 7a 65 72 6f 62 6c 6f 62 5d  lt-in [zeroblob]
377f0 20 53 51 4c 20 66 75 6e 63 74 69 6f 6e 20 63 61   SQL function ca
37800 6e 20 62 65 20 75 73 65 64 2c 20 69 66 20 64 65  n be used, if de
37810 73 69 72 65 64 2c 0a 2a 2a 20 74 6f 20 63 72 65  sired,.** to cre
37820 61 74 65 20 61 6e 20 65 6d 70 74 79 2c 20 7a 65  ate an empty, ze
37830 72 6f 2d 66 69 6c 6c 65 64 20 62 6c 6f 62 20 69  ro-filled blob i
37840 6e 20 77 68 69 63 68 20 74 6f 20 72 65 61 64 20  n which to read 
37850 6f 72 20 77 72 69 74 65 20 75 73 69 6e 67 0a 2a  or write using.*
37860 2a 20 74 68 69 73 20 69 6e 74 65 72 66 61 63 65  * this interface
37870 2e 0a 2a 2a 0a 2a 2a 20 54 6f 20 61 76 6f 69 64  ..**.** To avoid
37880 20 61 20 72 65 73 6f 75 72 63 65 20 6c 65 61 6b   a resource leak
37890 2c 20 65 76 65 72 79 20 6f 70 65 6e 20 5b 42 4c  , every open [BL
378a0 4f 42 20 68 61 6e 64 6c 65 5d 20 73 68 6f 75 6c  OB handle] shoul
378b0 64 20 65 76 65 6e 74 75 61 6c 6c 79 0a 2a 2a 20  d eventually.** 
378c0 62 65 20 72 65 6c 65 61 73 65 64 20 62 79 20 61  be released by a
378d0 20 63 61 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 65   call to [sqlite
378e0 33 5f 62 6c 6f 62 5f 63 6c 6f 73 65 28 29 5d 2e  3_blob_close()].
378f0 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .*/.int sqlite3_
37900 62 6c 6f 62 5f 6f 70 65 6e 28 0a 20 20 73 71 6c  blob_open(.  sql
37910 69 74 65 33 2a 2c 0a 20 20 63 6f 6e 73 74 20 63  ite3*,.  const c
37920 68 61 72 20 2a 7a 44 62 2c 0a 20 20 63 6f 6e 73  har *zDb,.  cons
37930 74 20 63 68 61 72 20 2a 7a 54 61 62 6c 65 2c 0a  t char *zTable,.
37940 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 43    const char *zC
37950 6f 6c 75 6d 6e 2c 0a 20 20 73 71 6c 69 74 65 33  olumn,.  sqlite3
37960 5f 69 6e 74 36 34 20 69 52 6f 77 2c 0a 20 20 69  _int64 iRow,.  i
37970 6e 74 20 66 6c 61 67 73 2c 0a 20 20 73 71 6c 69  nt flags,.  sqli
37980 74 65 33 5f 62 6c 6f 62 20 2a 2a 70 70 42 6c 6f  te3_blob **ppBlo
37990 62 0a 29 3b 0a 0a 2f 2a 0a 2a 2a 20 43 41 50 49  b.);../*.** CAPI
379a0 33 52 45 46 3a 20 4d 6f 76 65 20 61 20 42 4c 4f  3REF: Move a BLO
379b0 42 20 48 61 6e 64 6c 65 20 74 6f 20 61 20 4e 65  B Handle to a Ne
379c0 77 20 52 6f 77 0a 2a 2a 0a 2a 2a 20 5e 54 68 69  w Row.**.** ^Thi
379d0 73 20 66 75 6e 63 74 69 6f 6e 20 69 73 20 75 73  s function is us
379e0 65 64 20 74 6f 20 6d 6f 76 65 20 61 6e 20 65 78  ed to move an ex
379f0 69 73 74 69 6e 67 20 62 6c 6f 62 20 68 61 6e 64  isting blob hand
37a00 6c 65 20 73 6f 20 74 68 61 74 20 69 74 20 70 6f  le so that it po
37a10 69 6e 74 73 0a 2a 2a 20 74 6f 20 61 20 64 69 66  ints.** to a dif
37a20 66 65 72 65 6e 74 20 72 6f 77 20 6f 66 20 74 68  ferent row of th
37a30 65 20 73 61 6d 65 20 64 61 74 61 62 61 73 65 20  e same database 
37a40 74 61 62 6c 65 2e 20 5e 54 68 65 20 6e 65 77 20  table. ^The new 
37a50 72 6f 77 20 69 73 20 69 64 65 6e 74 69 66 69 65  row is identifie
37a60 64 0a 2a 2a 20 62 79 20 74 68 65 20 72 6f 77 69  d.** by the rowi
37a70 64 20 76 61 6c 75 65 20 70 61 73 73 65 64 20 61  d value passed a
37a80 73 20 74 68 65 20 73 65 63 6f 6e 64 20 61 72 67  s the second arg
37a90 75 6d 65 6e 74 2e 20 4f 6e 6c 79 20 74 68 65 20  ument. Only the 
37aa0 72 6f 77 20 63 61 6e 20 62 65 0a 2a 2a 20 63 68  row can be.** ch
37ab0 61 6e 67 65 64 2e 20 5e 54 68 65 20 64 61 74 61  anged. ^The data
37ac0 62 61 73 65 2c 20 74 61 62 6c 65 20 61 6e 64 20  base, table and 
37ad0 63 6f 6c 75 6d 6e 20 6f 6e 20 77 68 69 63 68 20  column on which 
37ae0 74 68 65 20 62 6c 6f 62 20 68 61 6e 64 6c 65 20  the blob handle 
37af0 69 73 20 6f 70 65 6e 0a 2a 2a 20 72 65 6d 61 69  is open.** remai
37b00 6e 20 74 68 65 20 73 61 6d 65 2e 20 4d 6f 76 69  n the same. Movi
37b10 6e 67 20 61 6e 20 65 78 69 73 74 69 6e 67 20 62  ng an existing b
37b20 6c 6f 62 20 68 61 6e 64 6c 65 20 74 6f 20 61 20  lob handle to a 
37b30 6e 65 77 20 72 6f 77 20 63 61 6e 20 62 65 0a 2a  new row can be.*
37b40 2a 20 66 61 73 74 65 72 20 74 68 61 6e 20 63 6c  * faster than cl
37b50 6f 73 69 6e 67 20 74 68 65 20 65 78 69 73 74 69  osing the existi
37b60 6e 67 20 68 61 6e 64 6c 65 20 61 6e 64 20 6f 70  ng handle and op
37b70 65 6e 69 6e 67 20 61 20 6e 65 77 20 6f 6e 65 2e  ening a new one.
37b80 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 65 20 6e 65 77  .**.** ^(The new
37b90 20 72 6f 77 20 6d 75 73 74 20 6d 65 65 74 20 74   row must meet t
37ba0 68 65 20 73 61 6d 65 20 63 72 69 74 65 72 69 61  he same criteria
37bb0 20 61 73 20 66 6f 72 20 5b 73 71 6c 69 74 65 33   as for [sqlite3
37bc0 5f 62 6c 6f 62 5f 6f 70 65 6e 28 29 5d 20 2d 0a  _blob_open()] -.
37bd0 2a 2a 20 69 74 20 6d 75 73 74 20 65 78 69 73 74  ** it must exist
37be0 20 61 6e 64 20 74 68 65 72 65 20 6d 75 73 74 20   and there must 
37bf0 62 65 20 65 69 74 68 65 72 20 61 20 62 6c 6f 62  be either a blob
37c00 20 6f 72 20 74 65 78 74 20 76 61 6c 75 65 20 73   or text value s
37c10 74 6f 72 65 64 20 69 6e 0a 2a 2a 20 74 68 65 20  tored in.** the 
37c20 6e 6f 6d 69 6e 61 74 65 64 20 63 6f 6c 75 6d 6e  nominated column
37c30 2e 29 5e 20 5e 49 66 20 74 68 65 20 6e 65 77 20  .)^ ^If the new 
37c40 72 6f 77 20 69 73 20 6e 6f 74 20 70 72 65 73 65  row is not prese
37c50 6e 74 20 69 6e 20 74 68 65 20 74 61 62 6c 65 2c  nt in the table,
37c60 20 6f 72 20 69 66 0a 2a 2a 20 69 74 20 64 6f 65   or if.** it doe
37c70 73 20 6e 6f 74 20 63 6f 6e 74 61 69 6e 20 61 20  s not contain a 
37c80 62 6c 6f 62 20 6f 72 20 74 65 78 74 20 76 61 6c  blob or text val
37c90 75 65 2c 20 6f 72 20 69 66 20 61 6e 6f 74 68 65  ue, or if anothe
37ca0 72 20 65 72 72 6f 72 20 6f 63 63 75 72 73 2c 20  r error occurs, 
37cb0 61 6e 0a 2a 2a 20 53 51 4c 69 74 65 20 65 72 72  an.** SQLite err
37cc0 6f 72 20 63 6f 64 65 20 69 73 20 72 65 74 75 72  or code is retur
37cd0 6e 65 64 20 61 6e 64 20 74 68 65 20 62 6c 6f 62  ned and the blob
37ce0 20 68 61 6e 64 6c 65 20 69 73 20 63 6f 6e 73 69   handle is consi
37cf0 64 65 72 65 64 20 61 62 6f 72 74 65 64 2e 0a 2a  dered aborted..*
37d00 2a 20 5e 41 6c 6c 20 73 75 62 73 65 71 75 65 6e  * ^All subsequen
37d10 74 20 63 61 6c 6c 73 20 74 6f 20 5b 73 71 6c 69  t calls to [sqli
37d20 74 65 33 5f 62 6c 6f 62 5f 72 65 61 64 28 29 5d  te3_blob_read()]
37d30 2c 20 5b 73 71 6c 69 74 65 33 5f 62 6c 6f 62 5f  , [sqlite3_blob_
37d40 77 72 69 74 65 28 29 5d 20 6f 72 0a 2a 2a 20 5b  write()] or.** [
37d50 73 71 6c 69 74 65 33 5f 62 6c 6f 62 5f 72 65 6f  sqlite3_blob_reo
37d60 70 65 6e 28 29 5d 20 6f 6e 20 61 6e 20 61 62 6f  pen()] on an abo
37d70 72 74 65 64 20 62 6c 6f 62 20 68 61 6e 64 6c 65  rted blob handle
37d80 20 69 6d 6d 65 64 69 61 74 65 6c 79 20 72 65 74   immediately ret
37d90 75 72 6e 0a 2a 2a 20 53 51 4c 49 54 45 5f 41 42  urn.** SQLITE_AB
37da0 4f 52 54 2e 20 5e 43 61 6c 6c 69 6e 67 20 5b 73  ORT. ^Calling [s
37db0 71 6c 69 74 65 33 5f 62 6c 6f 62 5f 62 79 74 65  qlite3_blob_byte
37dc0 73 28 29 5d 20 6f 6e 20 61 6e 20 61 62 6f 72 74  s()] on an abort
37dd0 65 64 20 62 6c 6f 62 20 68 61 6e 64 6c 65 0a 2a  ed blob handle.*
37de0 2a 20 61 6c 77 61 79 73 20 72 65 74 75 72 6e 73  * always returns
37df0 20 7a 65 72 6f 2e 0a 2a 2a 0a 2a 2a 20 5e 54 68   zero..**.** ^Th
37e00 69 73 20 66 75 6e 63 74 69 6f 6e 20 73 65 74 73  is function sets
37e10 20 74 68 65 20 64 61 74 61 62 61 73 65 20 68 61   the database ha
37e20 6e 64 6c 65 20 65 72 72 6f 72 20 63 6f 64 65 20  ndle error code 
37e30 61 6e 64 20 6d 65 73 73 61 67 65 2e 0a 2a 2f 0a  and message..*/.
37e40 53 51 4c 49 54 45 5f 45 58 50 45 52 49 4d 45 4e  SQLITE_EXPERIMEN
37e50 54 41 4c 20 69 6e 74 20 73 71 6c 69 74 65 33 5f  TAL int sqlite3_
37e60 62 6c 6f 62 5f 72 65 6f 70 65 6e 28 73 71 6c 69  blob_reopen(sqli
37e70 74 65 33 5f 62 6c 6f 62 20 2a 2c 20 73 71 6c 69  te3_blob *, sqli
37e80 74 65 33 5f 69 6e 74 36 34 29 3b 0a 0a 2f 2a 0a  te3_int64);../*.
37e90 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 43 6c 6f  ** CAPI3REF: Clo
37ea0 73 65 20 41 20 42 4c 4f 42 20 48 61 6e 64 6c 65  se A BLOB Handle
37eb0 0a 2a 2a 0a 2a 2a 20 5e 43 6c 6f 73 65 73 20 61  .**.** ^Closes a
37ec0 6e 20 6f 70 65 6e 20 5b 42 4c 4f 42 20 68 61 6e  n open [BLOB han
37ed0 64 6c 65 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 43 6c 6f  dle]..**.** ^Clo
37ee0 73 69 6e 67 20 61 20 42 4c 4f 42 20 73 68 61 6c  sing a BLOB shal
37ef0 6c 20 63 61 75 73 65 20 74 68 65 20 63 75 72 72  l cause the curr
37f00 65 6e 74 20 74 72 61 6e 73 61 63 74 69 6f 6e 20  ent transaction 
37f10 74 6f 20 63 6f 6d 6d 69 74 0a 2a 2a 20 69 66 20  to commit.** if 
37f20 74 68 65 72 65 20 61 72 65 20 6e 6f 20 6f 74 68  there are no oth
37f30 65 72 20 42 4c 4f 42 73 2c 20 6e 6f 20 70 65 6e  er BLOBs, no pen
37f40 64 69 6e 67 20 70 72 65 70 61 72 65 64 20 73 74  ding prepared st
37f50 61 74 65 6d 65 6e 74 73 2c 20 61 6e 64 20 74 68  atements, and th
37f60 65 0a 2a 2a 20 64 61 74 61 62 61 73 65 20 63 6f  e.** database co
37f70 6e 6e 65 63 74 69 6f 6e 20 69 73 20 69 6e 20 5b  nnection is in [
37f80 61 75 74 6f 63 6f 6d 6d 69 74 20 6d 6f 64 65 5d  autocommit mode]
37f90 2e 0a 2a 2a 20 5e 49 66 20 61 6e 79 20 77 72 69  ..** ^If any wri
37fa0 74 65 73 20 77 65 72 65 20 6d 61 64 65 20 74 6f  tes were made to
37fb0 20 74 68 65 20 42 4c 4f 42 2c 20 74 68 65 79 20   the BLOB, they 
37fc0 6d 69 67 68 74 20 62 65 20 68 65 6c 64 20 69 6e  might be held in
37fd0 20 63 61 63 68 65 0a 2a 2a 20 75 6e 74 69 6c 20   cache.** until 
37fe0 74 68 65 20 63 6c 6f 73 65 20 6f 70 65 72 61 74  the close operat
37ff0 69 6f 6e 20 69 66 20 74 68 65 79 20 77 69 6c 6c  ion if they will
38000 20 66 69 74 2e 0a 2a 2a 0a 2a 2a 20 5e 28 43 6c   fit..**.** ^(Cl
38010 6f 73 69 6e 67 20 74 68 65 20 42 4c 4f 42 20 6f  osing the BLOB o
38020 66 74 65 6e 20 66 6f 72 63 65 73 20 74 68 65 20  ften forces the 
38030 63 68 61 6e 67 65 73 0a 2a 2a 20 6f 75 74 20 74  changes.** out t
38040 6f 20 64 69 73 6b 20 61 6e 64 20 73 6f 20 69 66  o disk and so if
38050 20 61 6e 79 20 49 2f 4f 20 65 72 72 6f 72 73 20   any I/O errors 
38060 6f 63 63 75 72 2c 20 74 68 65 79 20 77 69 6c 6c  occur, they will
38070 20 6c 69 6b 65 6c 79 20 6f 63 63 75 72 0a 2a 2a   likely occur.**
38080 20 61 74 20 74 68 65 20 74 69 6d 65 20 77 68 65   at the time whe
38090 6e 20 74 68 65 20 42 4c 4f 42 20 69 73 20 63 6c  n the BLOB is cl
380a0 6f 73 65 64 2e 20 20 41 6e 79 20 65 72 72 6f 72  osed.  Any error
380b0 73 20 74 68 61 74 20 6f 63 63 75 72 20 64 75 72  s that occur dur
380c0 69 6e 67 0a 2a 2a 20 63 6c 6f 73 69 6e 67 20 61  ing.** closing a
380d0 72 65 20 72 65 70 6f 72 74 65 64 20 61 73 20 61  re reported as a
380e0 20 6e 6f 6e 2d 7a 65 72 6f 20 72 65 74 75 72 6e   non-zero return
380f0 20 76 61 6c 75 65 2e 29 5e 0a 2a 2a 0a 2a 2a 20   value.)^.**.** 
38100 5e 28 54 68 65 20 42 4c 4f 42 20 69 73 20 63 6c  ^(The BLOB is cl
38110 6f 73 65 64 20 75 6e 63 6f 6e 64 69 74 69 6f 6e  osed uncondition
38120 61 6c 6c 79 2e 20 20 45 76 65 6e 20 69 66 20 74  ally.  Even if t
38130 68 69 73 20 72 6f 75 74 69 6e 65 20 72 65 74 75  his routine retu
38140 72 6e 73 0a 2a 2a 20 61 6e 20 65 72 72 6f 72 20  rns.** an error 
38150 63 6f 64 65 2c 20 74 68 65 20 42 4c 4f 42 20 69  code, the BLOB i
38160 73 20 73 74 69 6c 6c 20 63 6c 6f 73 65 64 2e 29  s still closed.)
38170 5e 0a 2a 2a 0a 2a 2a 20 5e 43 61 6c 6c 69 6e 67  ^.**.** ^Calling
38180 20 74 68 69 73 20 72 6f 75 74 69 6e 65 20 77 69   this routine wi
38190 74 68 20 61 20 6e 75 6c 6c 20 70 6f 69 6e 74 65  th a null pointe
381a0 72 20 28 73 75 63 68 20 61 73 20 77 6f 75 6c 64  r (such as would
381b0 20 62 65 20 72 65 74 75 72 6e 65 64 0a 2a 2a 20   be returned.** 
381c0 62 79 20 61 20 66 61 69 6c 65 64 20 63 61 6c 6c  by a failed call
381d0 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 62 6c 6f   to [sqlite3_blo
381e0 62 5f 6f 70 65 6e 28 29 5d 29 20 69 73 20 61 20  b_open()]) is a 
381f0 68 61 72 6d 6c 65 73 73 20 6e 6f 2d 6f 70 2e 0a  harmless no-op..
38200 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f 62  */.int sqlite3_b
38210 6c 6f 62 5f 63 6c 6f 73 65 28 73 71 6c 69 74 65  lob_close(sqlite
38220 33 5f 62 6c 6f 62 20 2a 29 3b 0a 0a 2f 2a 0a 2a  3_blob *);../*.*
38230 2a 20 43 41 50 49 33 52 45 46 3a 20 52 65 74 75  * CAPI3REF: Retu
38240 72 6e 20 54 68 65 20 53 69 7a 65 20 4f 66 20 41  rn The Size Of A
38250 6e 20 4f 70 65 6e 20 42 4c 4f 42 0a 2a 2a 0a 2a  n Open BLOB.**.*
38260 2a 20 5e 52 65 74 75 72 6e 73 20 74 68 65 20 73  * ^Returns the s
38270 69 7a 65 20 69 6e 20 62 79 74 65 73 20 6f 66 20  ize in bytes of 
38280 74 68 65 20 42 4c 4f 42 20 61 63 63 65 73 73 69  the BLOB accessi
38290 62 6c 65 20 76 69 61 20 74 68 65 20 0a 2a 2a 20  ble via the .** 
382a0 73 75 63 63 65 73 73 66 75 6c 6c 79 20 6f 70 65  successfully ope
382b0 6e 65 64 20 5b 42 4c 4f 42 20 68 61 6e 64 6c 65  ned [BLOB handle
382c0 5d 20 69 6e 20 69 74 73 20 6f 6e 6c 79 20 61 72  ] in its only ar
382d0 67 75 6d 65 6e 74 2e 20 20 5e 54 68 65 0a 2a 2a  gument.  ^The.**
382e0 20 69 6e 63 72 65 6d 65 6e 74 61 6c 20 62 6c 6f   incremental blo
382f0 62 20 49 2f 4f 20 72 6f 75 74 69 6e 65 73 20 63  b I/O routines c
38300 61 6e 20 6f 6e 6c 79 20 72 65 61 64 20 6f 72 20  an only read or 
38310 6f 76 65 72 77 72 69 74 69 6e 67 20 65 78 69 73  overwriting exis
38320 74 69 6e 67 0a 2a 2a 20 62 6c 6f 62 20 63 6f 6e  ting.** blob con
38330 74 65 6e 74 3b 20 74 68 65 79 20 63 61 6e 6e 6f  tent; they canno
38340 74 20 63 68 61 6e 67 65 20 74 68 65 20 73 69 7a  t change the siz
38350 65 20 6f 66 20 61 20 62 6c 6f 62 2e 0a 2a 2a 0a  e of a blob..**.
38360 2a 2a 20 54 68 69 73 20 72 6f 75 74 69 6e 65 20  ** This routine 
38370 6f 6e 6c 79 20 77 6f 72 6b 73 20 6f 6e 20 61 20  only works on a 
38380 5b 42 4c 4f 42 20 68 61 6e 64 6c 65 5d 20 77 68  [BLOB handle] wh
38390 69 63 68 20 68 61 73 20 62 65 65 6e 20 63 72 65  ich has been cre
383a0 61 74 65 64 0a 2a 2a 20 62 79 20 61 20 70 72 69  ated.** by a pri
383b0 6f 72 20 73 75 63 63 65 73 73 66 75 6c 20 63 61  or successful ca
383c0 6c 6c 20 74 6f 20 5b 73 71 6c 69 74 65 33 5f 62  ll to [sqlite3_b
383d0 6c 6f 62 5f 6f 70 65 6e 28 29 5d 20 61 6e 64 20  lob_open()] and 
383e0 77 68 69 63 68 20 68 61 73 20 6e 6f 74 0a 2a 2a  which has not.**
383f0 20 62 65 65 6e 20 63 6c 6f 73 65 64 20 62 79 20   been closed by 
38400 5b 73 71 6c 69 74 65 33 5f 62 6c 6f 62 5f 63 6c  [sqlite3_blob_cl
38410 6f 73 65 28 29 5d 2e 20 20 50 61 73 73 69 6e 67  ose()].  Passing
38420 20 61 6e 79 20 6f 74 68 65 72 20 70 6f 69 6e 74   any other point
38430 65 72 20 69 6e 0a 2a 2a 20 74 6f 20 74 68 69 73  er in.** to this
38440 20 72 6f 75 74 69 6e 65 20 72 65 73 75 6c 74 73   routine results
38450 20 69 6e 20 75 6e 64 65 66 69 6e 65 64 20 61 6e   in undefined an
38460 64 20 70 72 6f 62 61 62 6c 79 20 75 6e 64 65 73  d probably undes
38470 69 72 61 62 6c 65 20 62 65 68 61 76 69 6f 72 2e  irable behavior.
38480 0a 2a 2f 0a 69 6e 74 20 73 71 6c 69 74 65 33 5f  .*/.int sqlite3_
38490 62 6c 6f 62 5f 62 79 74 65 73 28 73 71 6c 69 74  blob_bytes(sqlit
384a0 65 33 5f 62 6c 6f 62 20 2a 29 3b 0a 0a 2f 2a 0a  e3_blob *);../*.
384b0 2a 2a 20 43 41 50 49 33 52 45 46 3a 20 52 65 61  ** CAPI3REF: Rea
384c0 64 20 44 61 74 61 20 46 72 6f 6d 20 41 20 42 4c  d Data From A BL
384d0 4f 42 20 49 6e 63 72 65 6d 65 6e 74 61 6c 6c 79  OB Incrementally
384e0 0a 2a 2a 0a 2a 2a 20 5e 28 54 68 69 73 20 66 75  .**.** ^(This fu
384f0 6e 63 74 69 6f 6e 20 69 73 20 75 73 65 64 20 74  nction is used t
38500 6f 20 72 65 61 64 20 64 61 74 61 20 66 72 6f 6d  o read data from
38510 20 61 6e 20 6f 70 65 6e 20 5b 42 4c 4f 42 20 68   an open [BLOB h
38520 61 6e 64 6c 65 5d 20 69 6e 74 6f 20 61 0a 2a 2a  andle] into a.**
38530 20 63 61 6c 6c 65 72 2d 73 75 70 70 6c 69 65 64   caller-supplied
38540 20 62 75 66 66 65 72 2e 20 4e 20 62 79 74 65 73   buffer. N bytes
38550 20 6f 66 20 64 61 74 61 20 61 72 65 20 63 6f 70   of data are cop
38560 69 65 64 20 69 6e 74 6f 20 62 75 66 66 65 72 20  ied into buffer 
38570 5a 0a 2a 2a 20 66 72 6f 6d 20 74 68 65 20 6f 70  Z.** from the op
38580 65 6e 20 42 4c 4f 42 2c 20 73 74 61 72 74 69 6e  en BLOB, startin
38590 67 20 61 74 20 6f 66 66 73 65 74 20 69 4f 66 66  g at offset iOff
385a0 73 65 74 2e 29 5e 0a 2a 2a 0a 2a 2a 20 5e 49 66  set.)^.**.** ^If
385b0 20 6f 66 66 73 65 74 20 69 4f 66 66 73 65 74 20   offset iOffset 
385c0 69 73 20 6c 65 73 73 20 74 68 61 6e 20 4e 20 62  is less than N b
385d0 79 74 65 73 20 66 72 6f 6d 20 74 68 65 20 65 6e  ytes from the en
385e0 64 20 6f 66 20 74 68 65 20 42 4c 4f 42 2c 0a 2a  d of the BLOB,.*
385f0 2a 20 5b 53 51 4c 49 54 45 5f 45 52 52 4f 52 5d  * [SQLITE_ERROR]
38600 20 69 73 20 72 65 74 75 72 6e 65 64 20 61 6e 64   is returned and
38610 20 6e 6f 20 64 61 74 61 20 69 73 20 72 65 61 64   no data is read
38620 2e 20 20 5e 49 66 20 4e 20 6f 72 20 69 4f 66 66  .  ^If N or iOff
38630 73 65 74 20 69 73 0a 2a 2a 20 6c 65 73 73 20 74  set is.** less t
38640 68 61 6e 20 7a 65 72 6f 2c 20 5b 53 51 4c 49 54  han zero, [SQLIT
38650 45 5f 45 52 52 4f 52 5d 20 69 73 20 72 65 74 75  E_ERROR] is retu
38660 72 6e 65 64 20 61 6e 64 20 6e 6f 20 64 61 74 61  rned and no data
38670 20 69 73 20 72 65 61 64 2e 0a 2a 2a 20 5e 54 68   is read..** ^Th
38680 65 20 73 69 7a 65 20 6f 66 20 74 68 65 20 62 6c  e size of the bl
38690 6f 62 20 28 61 6e 64 20 68 65 6e 63 65 20 74 68  ob (and hence th
386a0 65 20 6d 61 78 69 6d 75 6d 20 76 61 6c 75 65 20  e maximum value 
386b0 6f 66 20 4e 2b 69 4f 66 66 73 65 74 29 0a 2a 2a  of N+iOffset).**
386c0 20 63 61 6e 20 62 65 20 64 65 74 65 72 6d 69 6e   can be determin
386d0 65 64 20 75 73 69 6e 67 20 74 68 65 20 5b 73 71  ed using the [sq
386e0 6c 69 74 65 33 5f 62 6c 6f 62 5f 62 79 74 65 73  lite3_blob_bytes
386f0 28 29 5d 20 69 6e 74 65 72 66 61 63 65 2e 0a 2a  ()] interface..*
38700 2a 0a 2a 2a 20 5e 41 6e 20 61 74 74 65 6d 70 74  *.** ^An attempt
38710 20 74 6f 20 72 65 61 64 20 66 72 6f 6d 20 61 6e   to read from an
38720 20 65 78 70 69 72 65 64 20 5b 42 4c 4f 42 20 68   expired [BLOB h
38730 61 6e 64 6c 65 5d 20 66 61 69 6c 73 20 77 69 74  andle] fails wit
38740 68 20 61 6e 0a 2a 2a 20 65 72 72 6f 72 20 63 6f  h an.** error co
38750 64 65 20 6f 66 20 5b 53 51 4c 49 54 45 5f 41 42  de of [SQLITE_AB
38760 4f 52 54 5d 2e 0a 2a 2a 0a 2a 2a 20 5e 28 4f 6e  ORT]..**.** ^(On
38770 20 73 75 63 63 65 73 73 2c 20 73 71 6c 69 74 65   success, sqlite
38780 33 5f 62 6c 6f 62 5f 72 65 61 64 28 29 20 72 65  3_blob_read() re
38790 74 75 72 6e 73 20 53 51 4c 49 54 45 5f 4f 4b 2e  turns SQLITE_OK.
387a0 0a 2a 2a 20 4f 74 68 65 72 77 69 73 65 2c 20 61  .** Otherwise, a
387b0 6e 20 5b 65 72 72 6f 72 20 63 6f 64 65 5d 20 6f  n [error code] o
387c0 72 20 61 6e 20 5b 65 78 74 65 6e 64 65 64 20 65  r an [extended e
387d0 72 72 6f 72 20 63 6f 64 65 5d 20 69 73 20 72 65  rror code] is re
387e0 74 75 72 6e 65 64 2e 29 5e 0a 2a 2a 0a 2a 2a 20  turned.)^.**.** 
387f0 54 68 69 73 20 72 6f 75 74 69 6e 65 20 6f 6e 6c  This routine onl
38800 79 20 77 6f 72 6b 73 20 6f 6e 20 61 20 5b 42 4c  y works on a [BL
38810 4f 42 20 68 61 6e 64 6c 65 5d 20 77 68 69 63 68  OB handle] which
38820 20 68 61 73 20 62 65 65 6e 20 63 72 65 61 74 65   has been create
38830 64 0a 2a 2a 20 62 79 20 61 20 70 72 69 6f 72 20  d.** by a prior 
38840 73 75 63 63 65 73 73 66 75 6c 20 63 61 6c 6c 20  successful call 
38850 74 6f 20 5b 73 71 6c 69 74 65 33 5f 62 6c 6f 62  to [sqlite3_blob
38860 5f 6f 70 65 6e 28 29 5d 20 61 6e 64 20 77 68 69  _open()] and whi
38870 63 68 20 68 61 73 20 6e 6f 74 0a 2a 2a 20 62 65  ch has not.** be
38880 65 6e 20 63 6c 6f 73 65 64 20 62 79 20 5b 73 71  en closed b