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

Artifact 1342a9b2cc2089e3534d3ef00204786783f6aea6:


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 73 71 6c 69 74 65   that the sqlite
01b0: 20 42 2d 54 72 65 65 20 66 69 6c 65 0a 2a 2a 20   B-Tree file.** 
01c0: 73 75 62 73 79 73 74 65 6d 2e 20 20 53 65 65 20  subsystem.  See 
01d0: 63 6f 6d 6d 65 6e 74 73 20 69 6e 20 74 68 65 20  comments in the 
01e0: 73 6f 75 72 63 65 20 63 6f 64 65 20 66 6f 72 20  source code for 
01f0: 61 20 64 65 74 61 69 6c 65 64 20 64 65 73 63 72  a detailed descr
0200: 69 70 74 69 6f 6e 0a 2a 2a 20 6f 66 20 77 68 61  iption.** of wha
0210: 74 20 65 61 63 68 20 69 6e 74 65 72 66 61 63 65  t each interface
0220: 20 72 6f 75 74 69 6e 65 20 64 6f 65 73 2e 0a 2a   routine does..*
0230: 2f 0a 23 69 66 6e 64 65 66 20 5f 42 54 52 45 45  /.#ifndef _BTREE
0240: 5f 48 5f 0a 23 64 65 66 69 6e 65 20 5f 42 54 52  _H_.#define _BTR
0250: 45 45 5f 48 5f 0a 0a 2f 2a 20 54 4f 44 4f 3a 20  EE_H_../* TODO: 
0260: 54 68 69 73 20 64 65 66 69 6e 69 74 69 6f 6e 20  This definition 
0270: 69 73 20 6a 75 73 74 20 69 6e 63 6c 75 64 65 64  is just included
0280: 20 73 6f 20 6f 74 68 65 72 20 6d 6f 64 75 6c 65   so other module
0290: 73 20 63 6f 6d 70 69 6c 65 2e 20 49 74 0a 2a 2a  s compile. It.**
02a0: 20 6e 65 65 64 73 20 74 6f 20 62 65 20 72 65 76   needs to be rev
02b0: 69 73 69 74 65 64 2e 0a 2a 2f 0a 23 64 65 66 69  isited..*/.#defi
02c0: 6e 65 20 53 51 4c 49 54 45 5f 4e 5f 42 54 52 45  ne SQLITE_N_BTRE
02d0: 45 5f 4d 45 54 41 20 31 36 0a 0a 2f 2a 0a 2a 2a  E_META 16../*.**
02e0: 20 49 66 20 64 65 66 69 6e 65 64 20 61 73 20 6e   If defined as n
02f0: 6f 6e 2d 7a 65 72 6f 2c 20 61 75 74 6f 2d 76 61  on-zero, auto-va
0300: 63 75 75 6d 20 69 73 20 65 6e 61 62 6c 65 64 20  cuum is enabled 
0310: 62 79 20 64 65 66 61 75 6c 74 2e 20 4f 74 68 65  by default. Othe
0320: 72 77 69 73 65 0a 2a 2a 20 69 74 20 6d 75 73 74  rwise.** it must
0330: 20 62 65 20 74 75 72 6e 65 64 20 6f 6e 20 66 6f   be turned on fo
0340: 72 20 65 61 63 68 20 64 61 74 61 62 61 73 65 20  r each database 
0350: 75 73 69 6e 67 20 22 50 52 41 47 4d 41 20 61 75  using "PRAGMA au
0360: 74 6f 5f 76 61 63 75 75 6d 20 3d 20 31 22 2e 0a  to_vacuum = 1"..
0370: 2a 2f 0a 23 69 66 6e 64 65 66 20 53 51 4c 49 54  */.#ifndef SQLIT
0380: 45 5f 44 45 46 41 55 4c 54 5f 41 55 54 4f 56 41  E_DEFAULT_AUTOVA
0390: 43 55 55 4d 0a 20 20 23 64 65 66 69 6e 65 20 53  CUUM.  #define S
03a0: 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f 41 55  QLITE_DEFAULT_AU
03b0: 54 4f 56 41 43 55 55 4d 20 30 0a 23 65 6e 64 69  TOVACUUM 0.#endi
03c0: 66 0a 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45  f..#define BTREE
03d0: 5f 41 55 54 4f 56 41 43 55 55 4d 5f 4e 4f 4e 45  _AUTOVACUUM_NONE
03e0: 20 30 20 20 20 20 20 20 20 20 2f 2a 20 44 6f 20   0        /* Do 
03f0: 6e 6f 74 20 64 6f 20 61 75 74 6f 2d 76 61 63 75  not do auto-vacu
0400: 75 6d 20 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54  um */.#define BT
0410: 52 45 45 5f 41 55 54 4f 56 41 43 55 55 4d 5f 46  REE_AUTOVACUUM_F
0420: 55 4c 4c 20 31 20 20 20 20 20 20 20 20 2f 2a 20  ULL 1        /* 
0430: 44 6f 20 66 75 6c 6c 20 61 75 74 6f 2d 76 61 63  Do full auto-vac
0440: 75 75 6d 20 2a 2f 0a 23 64 65 66 69 6e 65 20 42  uum */.#define B
0450: 54 52 45 45 5f 41 55 54 4f 56 41 43 55 55 4d 5f  TREE_AUTOVACUUM_
0460: 49 4e 43 52 20 32 20 20 20 20 20 20 20 20 2f 2a  INCR 2        /*
0470: 20 49 6e 63 72 65 6d 65 6e 74 61 6c 20 76 61 63   Incremental vac
0480: 75 75 6d 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 46 6f  uum */../*.** Fo
0490: 72 77 61 72 64 20 64 65 63 6c 61 72 61 74 69 6f  rward declaratio
04a0: 6e 73 20 6f 66 20 73 74 72 75 63 74 75 72 65 0a  ns of structure.
04b0: 2a 2f 0a 74 79 70 65 64 65 66 20 73 74 72 75 63  */.typedef struc
04c0: 74 20 42 74 72 65 65 20 42 74 72 65 65 3b 0a 74  t Btree Btree;.t
04d0: 79 70 65 64 65 66 20 73 74 72 75 63 74 20 42 74  ypedef struct Bt
04e0: 43 75 72 73 6f 72 20 42 74 43 75 72 73 6f 72 3b  Cursor BtCursor;
04f0: 0a 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20  .typedef struct 
0500: 42 74 53 68 61 72 65 64 20 42 74 53 68 61 72 65  BtShared BtShare
0510: 64 3b 0a 74 79 70 65 64 65 66 20 73 74 72 75 63  d;.typedef struc
0520: 74 20 42 74 72 65 65 50 61 79 6c 6f 61 64 20 42  t BtreePayload B
0530: 74 72 65 65 50 61 79 6c 6f 61 64 3b 0a 0a 0a 69  treePayload;...i
0540: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 4f  nt sqlite3BtreeO
0550: 70 65 6e 28 0a 20 20 73 71 6c 69 74 65 33 5f 76  pen(.  sqlite3_v
0560: 66 73 20 2a 70 56 66 73 2c 20 20 20 20 20 20 20  fs *pVfs,       
0570: 2f 2a 20 56 46 53 20 74 6f 20 75 73 65 20 77 69  /* VFS to use wi
0580: 74 68 20 74 68 69 73 20 62 2d 74 72 65 65 20 2a  th this b-tree *
0590: 2f 0a 20 20 63 6f 6e 73 74 20 63 68 61 72 20 2a  /.  const char *
05a0: 7a 46 69 6c 65 6e 61 6d 65 2c 20 20 20 2f 2a 20  zFilename,   /* 
05b0: 4e 61 6d 65 20 6f 66 20 64 61 74 61 62 61 73 65  Name of database
05c0: 20 66 69 6c 65 20 74 6f 20 6f 70 65 6e 20 2a 2f   file to open */
05d0: 0a 20 20 73 71 6c 69 74 65 33 20 2a 64 62 2c 20  .  sqlite3 *db, 
05e0: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 41              /* A
05f0: 73 73 6f 63 69 61 74 65 64 20 64 61 74 61 62 61  ssociated databa
0600: 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 2a 2f  se connection */
0610: 0a 20 20 42 74 72 65 65 20 2a 2a 70 70 42 74 72  .  Btree **ppBtr
0620: 65 65 2c 20 20 20 20 20 20 20 20 20 2f 2a 20 52  ee,         /* R
0630: 65 74 75 72 6e 20 6f 70 65 6e 20 42 74 72 65 65  eturn open Btree
0640: 2a 20 68 65 72 65 20 2a 2f 0a 20 20 69 6e 74 20  * here */.  int 
0650: 66 6c 61 67 73 2c 20 20 20 20 20 20 20 20 20 20  flags,          
0660: 20 20 20 20 20 2f 2a 20 46 6c 61 67 73 20 2a 2f       /* Flags */
0670: 0a 20 20 69 6e 74 20 76 66 73 46 6c 61 67 73 20  .  int vfsFlags 
0680: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 46              /* F
0690: 6c 61 67 73 20 70 61 73 73 65 64 20 74 68 72 6f  lags passed thro
06a0: 75 67 68 20 74 6f 20 56 46 53 20 6f 70 65 6e 20  ugh to VFS open 
06b0: 2a 2f 0a 29 3b 0a 0a 2f 2a 20 54 68 65 20 66 6c  */.);../* The fl
06c0: 61 67 73 20 70 61 72 61 6d 65 74 65 72 20 74 6f  ags parameter to
06d0: 20 73 71 6c 69 74 65 33 42 74 72 65 65 4f 70 65   sqlite3BtreeOpe
06e0: 6e 20 63 61 6e 20 62 65 20 74 68 65 20 62 69 74  n can be the bit
06f0: 77 69 73 65 20 6f 72 20 6f 66 20 74 68 65 0a 2a  wise or of the.*
0700: 2a 20 66 6f 6c 6c 6f 77 69 6e 67 20 76 61 6c 75  * following valu
0710: 65 73 2e 0a 2a 2a 0a 2a 2a 20 4e 4f 54 45 3a 20  es..**.** NOTE: 
0720: 20 54 68 65 73 65 20 76 61 6c 75 65 73 20 6d 75   These values mu
0730: 73 74 20 6d 61 74 63 68 20 74 68 65 20 63 6f 72  st match the cor
0740: 72 65 73 70 6f 6e 64 69 6e 67 20 50 41 47 45 52  responding PAGER
0750: 5f 20 76 61 6c 75 65 73 20 69 6e 0a 2a 2a 20 70  _ values in.** p
0760: 61 67 65 72 2e 68 2e 0a 2a 2f 0a 23 64 65 66 69  ager.h..*/.#defi
0770: 6e 65 20 42 54 52 45 45 5f 4f 4d 49 54 5f 4a 4f  ne BTREE_OMIT_JO
0780: 55 52 4e 41 4c 20 20 31 20 20 2f 2a 20 44 6f 20  URNAL  1  /* Do 
0790: 6e 6f 74 20 63 72 65 61 74 65 20 6f 72 20 75 73  not create or us
07a0: 65 20 61 20 72 6f 6c 6c 62 61 63 6b 20 6a 6f 75  e a rollback jou
07b0: 72 6e 61 6c 20 2a 2f 0a 23 64 65 66 69 6e 65 20  rnal */.#define 
07c0: 42 54 52 45 45 5f 4d 45 4d 4f 52 59 20 20 20 20  BTREE_MEMORY    
07d0: 20 20 20 20 32 20 20 2f 2a 20 54 68 69 73 20 69      2  /* This i
07e0: 73 20 61 6e 20 69 6e 2d 6d 65 6d 6f 72 79 20 44  s an in-memory D
07f0: 42 20 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52  B */.#define BTR
0800: 45 45 5f 53 49 4e 47 4c 45 20 20 20 20 20 20 20  EE_SINGLE       
0810: 20 34 20 20 2f 2a 20 54 68 65 20 66 69 6c 65 20   4  /* The file 
0820: 63 6f 6e 74 61 69 6e 73 20 61 74 20 6d 6f 73 74  contains at most
0830: 20 31 20 62 2d 74 72 65 65 20 2a 2f 0a 23 64 65   1 b-tree */.#de
0840: 66 69 6e 65 20 42 54 52 45 45 5f 55 4e 4f 52 44  fine BTREE_UNORD
0850: 45 52 45 44 20 20 20 20 20 38 20 20 2f 2a 20 55  ERED     8  /* U
0860: 73 65 20 6f 66 20 61 20 68 61 73 68 20 69 6d 70  se of a hash imp
0870: 6c 65 6d 65 6e 74 61 74 69 6f 6e 20 69 73 20 4f  lementation is O
0880: 4b 20 2a 2f 0a 0a 69 6e 74 20 73 71 6c 69 74 65  K */..int sqlite
0890: 33 42 74 72 65 65 43 6c 6f 73 65 28 42 74 72 65  3BtreeClose(Btre
08a0: 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  e*);.int sqlite3
08b0: 42 74 72 65 65 53 65 74 43 61 63 68 65 53 69 7a  BtreeSetCacheSiz
08c0: 65 28 42 74 72 65 65 2a 2c 69 6e 74 29 3b 0a 69  e(Btree*,int);.i
08d0: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 53  nt sqlite3BtreeS
08e0: 65 74 53 70 69 6c 6c 53 69 7a 65 28 42 74 72 65  etSpillSize(Btre
08f0: 65 2a 2c 69 6e 74 29 3b 0a 23 69 66 20 53 51 4c  e*,int);.#if SQL
0900: 49 54 45 5f 4d 41 58 5f 4d 4d 41 50 5f 53 49 5a  ITE_MAX_MMAP_SIZ
0910: 45 3e 30 0a 20 20 69 6e 74 20 73 71 6c 69 74 65  E>0.  int sqlite
0920: 33 42 74 72 65 65 53 65 74 4d 6d 61 70 4c 69 6d  3BtreeSetMmapLim
0930: 69 74 28 42 74 72 65 65 2a 2c 73 71 6c 69 74 65  it(Btree*,sqlite
0940: 33 5f 69 6e 74 36 34 29 3b 0a 23 65 6e 64 69 66  3_int64);.#endif
0950: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65  .int sqlite3Btre
0960: 65 53 65 74 50 61 67 65 72 46 6c 61 67 73 28 42  eSetPagerFlags(B
0970: 74 72 65 65 2a 2c 75 6e 73 69 67 6e 65 64 29 3b  tree*,unsigned);
0980: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65  .int sqlite3Btre
0990: 65 53 65 74 50 61 67 65 53 69 7a 65 28 42 74 72  eSetPageSize(Btr
09a0: 65 65 20 2a 70 2c 20 69 6e 74 20 6e 50 61 67 65  ee *p, int nPage
09b0: 73 69 7a 65 2c 20 69 6e 74 20 6e 52 65 73 65 72  size, int nReser
09c0: 76 65 2c 20 69 6e 74 20 65 46 69 78 29 3b 0a 69  ve, int eFix);.i
09d0: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 47  nt sqlite3BtreeG
09e0: 65 74 50 61 67 65 53 69 7a 65 28 42 74 72 65 65  etPageSize(Btree
09f0: 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  *);.int sqlite3B
0a00: 74 72 65 65 4d 61 78 50 61 67 65 43 6f 75 6e 74  treeMaxPageCount
0a10: 28 42 74 72 65 65 2a 2c 69 6e 74 29 3b 0a 75 33  (Btree*,int);.u3
0a20: 32 20 73 71 6c 69 74 65 33 42 74 72 65 65 4c 61  2 sqlite3BtreeLa
0a30: 73 74 50 61 67 65 28 42 74 72 65 65 2a 29 3b 0a  stPage(Btree*);.
0a40: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
0a50: 53 65 63 75 72 65 44 65 6c 65 74 65 28 42 74 72  SecureDelete(Btr
0a60: 65 65 2a 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71  ee*,int);.int sq
0a70: 6c 69 74 65 33 42 74 72 65 65 47 65 74 4f 70 74  lite3BtreeGetOpt
0a80: 69 6d 61 6c 52 65 73 65 72 76 65 28 42 74 72 65  imalReserve(Btre
0a90: 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  e*);.int sqlite3
0aa0: 42 74 72 65 65 47 65 74 52 65 73 65 72 76 65 4e  BtreeGetReserveN
0ab0: 6f 4d 75 74 65 78 28 42 74 72 65 65 20 2a 70 29  oMutex(Btree *p)
0ac0: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72  ;.int sqlite3Btr
0ad0: 65 65 53 65 74 41 75 74 6f 56 61 63 75 75 6d 28  eeSetAutoVacuum(
0ae0: 42 74 72 65 65 20 2a 2c 20 69 6e 74 29 3b 0a 69  Btree *, int);.i
0af0: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 47  nt sqlite3BtreeG
0b00: 65 74 41 75 74 6f 56 61 63 75 75 6d 28 42 74 72  etAutoVacuum(Btr
0b10: 65 65 20 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74  ee *);.int sqlit
0b20: 65 33 42 74 72 65 65 42 65 67 69 6e 54 72 61 6e  e3BtreeBeginTran
0b30: 73 28 42 74 72 65 65 2a 2c 69 6e 74 29 3b 0a 69  s(Btree*,int);.i
0b40: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 43  nt sqlite3BtreeC
0b50: 6f 6d 6d 69 74 50 68 61 73 65 4f 6e 65 28 42 74  ommitPhaseOne(Bt
0b60: 72 65 65 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72  ree*, const char
0b70: 20 2a 7a 4d 61 73 74 65 72 29 3b 0a 69 6e 74 20   *zMaster);.int 
0b80: 73 71 6c 69 74 65 33 42 74 72 65 65 43 6f 6d 6d  sqlite3BtreeComm
0b90: 69 74 50 68 61 73 65 54 77 6f 28 42 74 72 65 65  itPhaseTwo(Btree
0ba0: 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c  *, int);.int sql
0bb0: 69 74 65 33 42 74 72 65 65 43 6f 6d 6d 69 74 28  ite3BtreeCommit(
0bc0: 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c  Btree*);.int sql
0bd0: 69 74 65 33 42 74 72 65 65 52 6f 6c 6c 62 61 63  ite3BtreeRollbac
0be0: 6b 28 42 74 72 65 65 2a 2c 69 6e 74 2c 69 6e 74  k(Btree*,int,int
0bf0: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
0c00: 72 65 65 42 65 67 69 6e 53 74 6d 74 28 42 74 72  reeBeginStmt(Btr
0c10: 65 65 2a 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71  ee*,int);.int sq
0c20: 6c 69 74 65 33 42 74 72 65 65 43 72 65 61 74 65  lite3BtreeCreate
0c30: 54 61 62 6c 65 28 42 74 72 65 65 2a 2c 20 69 6e  Table(Btree*, in
0c40: 74 2a 2c 20 69 6e 74 20 66 6c 61 67 73 29 3b 0a  t*, int flags);.
0c50: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
0c60: 49 73 49 6e 54 72 61 6e 73 28 42 74 72 65 65 2a  IsInTrans(Btree*
0c70: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
0c80: 72 65 65 49 73 49 6e 52 65 61 64 54 72 61 6e 73  reeIsInReadTrans
0c90: 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71  (Btree*);.int sq
0ca0: 6c 69 74 65 33 42 74 72 65 65 49 73 49 6e 42 61  lite3BtreeIsInBa
0cb0: 63 6b 75 70 28 42 74 72 65 65 2a 29 3b 0a 76 6f  ckup(Btree*);.vo
0cc0: 69 64 20 2a 73 71 6c 69 74 65 33 42 74 72 65 65  id *sqlite3Btree
0cd0: 53 63 68 65 6d 61 28 42 74 72 65 65 20 2a 2c 20  Schema(Btree *, 
0ce0: 69 6e 74 2c 20 76 6f 69 64 28 2a 29 28 76 6f 69  int, void(*)(voi
0cf0: 64 20 2a 29 29 3b 0a 69 6e 74 20 73 71 6c 69 74  d *));.int sqlit
0d00: 65 33 42 74 72 65 65 53 63 68 65 6d 61 4c 6f 63  e3BtreeSchemaLoc
0d10: 6b 65 64 28 42 74 72 65 65 20 2a 70 42 74 72 65  ked(Btree *pBtre
0d20: 65 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  e);.int sqlite3B
0d30: 74 72 65 65 4c 6f 63 6b 54 61 62 6c 65 28 42 74  treeLockTable(Bt
0d40: 72 65 65 20 2a 70 42 74 72 65 65 2c 20 69 6e 74  ree *pBtree, int
0d50: 20 69 54 61 62 2c 20 75 38 20 69 73 57 72 69 74   iTab, u8 isWrit
0d60: 65 4c 6f 63 6b 29 3b 0a 69 6e 74 20 73 71 6c 69  eLock);.int sqli
0d70: 74 65 33 42 74 72 65 65 53 61 76 65 70 6f 69 6e  te3BtreeSavepoin
0d80: 74 28 42 74 72 65 65 20 2a 2c 20 69 6e 74 2c 20  t(Btree *, int, 
0d90: 69 6e 74 29 3b 0a 0a 63 6f 6e 73 74 20 63 68 61  int);..const cha
0da0: 72 20 2a 73 71 6c 69 74 65 33 42 74 72 65 65 47  r *sqlite3BtreeG
0db0: 65 74 46 69 6c 65 6e 61 6d 65 28 42 74 72 65 65  etFilename(Btree
0dc0: 20 2a 29 3b 0a 63 6f 6e 73 74 20 63 68 61 72 20   *);.const char 
0dd0: 2a 73 71 6c 69 74 65 33 42 74 72 65 65 47 65 74  *sqlite3BtreeGet
0de0: 4a 6f 75 72 6e 61 6c 6e 61 6d 65 28 42 74 72 65  Journalname(Btre
0df0: 65 20 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  e *);.int sqlite
0e00: 33 42 74 72 65 65 43 6f 70 79 46 69 6c 65 28 42  3BtreeCopyFile(B
0e10: 74 72 65 65 20 2a 2c 20 42 74 72 65 65 20 2a 29  tree *, Btree *)
0e20: 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  ;..int sqlite3Bt
0e30: 72 65 65 49 6e 63 72 56 61 63 75 75 6d 28 42 74  reeIncrVacuum(Bt
0e40: 72 65 65 20 2a 29 3b 0a 0a 2f 2a 20 54 68 65 20  ree *);../* The 
0e50: 66 6c 61 67 73 20 70 61 72 61 6d 65 74 65 72 20  flags parameter 
0e60: 74 6f 20 73 71 6c 69 74 65 33 42 74 72 65 65 43  to sqlite3BtreeC
0e70: 72 65 61 74 65 54 61 62 6c 65 20 63 61 6e 20 62  reateTable can b
0e80: 65 20 74 68 65 20 62 69 74 77 69 73 65 20 4f 52  e the bitwise OR
0e90: 0a 2a 2a 20 6f 66 20 74 68 65 20 66 6c 61 67 73  .** of the flags
0ea0: 20 73 68 6f 77 6e 20 62 65 6c 6f 77 2e 0a 2a 2a   shown below..**
0eb0: 0a 2a 2a 20 45 76 65 72 79 20 53 51 4c 69 74 65  .** Every SQLite
0ec0: 20 74 61 62 6c 65 20 6d 75 73 74 20 68 61 76 65   table must have
0ed0: 20 65 69 74 68 65 72 20 42 54 52 45 45 5f 49 4e   either BTREE_IN
0ee0: 54 4b 45 59 20 6f 72 20 42 54 52 45 45 5f 42 4c  TKEY or BTREE_BL
0ef0: 4f 42 4b 45 59 20 73 65 74 2e 0a 2a 2a 20 57 69  OBKEY set..** Wi
0f00: 74 68 20 42 54 52 45 45 5f 49 4e 54 4b 45 59 2c  th BTREE_INTKEY,
0f10: 20 74 68 65 20 74 61 62 6c 65 20 6b 65 79 20 69   the table key i
0f20: 73 20 61 20 36 34 2d 62 69 74 20 69 6e 74 65 67  s a 64-bit integ
0f30: 65 72 20 61 6e 64 20 61 72 62 69 74 72 61 72 79  er and arbitrary
0f40: 20 64 61 74 61 0a 2a 2a 20 69 73 20 73 74 6f 72   data.** is stor
0f50: 65 64 20 69 6e 20 74 68 65 20 6c 65 61 76 65 73  ed in the leaves
0f60: 2e 20 20 28 42 54 52 45 45 5f 49 4e 54 4b 45 59  .  (BTREE_INTKEY
0f70: 20 69 73 20 75 73 65 64 20 66 6f 72 20 53 51 4c   is used for SQL
0f80: 20 74 61 62 6c 65 73 2e 29 20 20 57 69 74 68 0a   tables.)  With.
0f90: 2a 2a 20 42 54 52 45 45 5f 42 4c 4f 42 4b 45 59  ** BTREE_BLOBKEY
0fa0: 2c 20 74 68 65 20 6b 65 79 20 69 73 20 61 6e 20  , the key is an 
0fb0: 61 72 62 69 74 72 61 72 79 20 42 4c 4f 42 20 61  arbitrary BLOB a
0fc0: 6e 64 20 6e 6f 20 63 6f 6e 74 65 6e 74 20 69 73  nd no content is
0fd0: 20 73 74 6f 72 65 64 0a 2a 2a 20 61 6e 79 77 68   stored.** anywh
0fe0: 65 72 65 20 2d 20 74 68 65 20 6b 65 79 20 69 73  ere - the key is
0ff0: 20 74 68 65 20 63 6f 6e 74 65 6e 74 2e 20 20 28   the content.  (
1000: 42 54 52 45 45 5f 42 4c 4f 42 4b 45 59 20 69 73  BTREE_BLOBKEY is
1010: 20 75 73 65 64 20 66 6f 72 20 53 51 4c 0a 2a 2a   used for SQL.**
1020: 20 69 6e 64 69 63 65 73 2e 29 0a 2a 2f 0a 23 64   indices.).*/.#d
1030: 65 66 69 6e 65 20 42 54 52 45 45 5f 49 4e 54 4b  efine BTREE_INTK
1040: 45 59 20 20 20 20 20 31 20 20 20 20 2f 2a 20 54  EY     1    /* T
1050: 61 62 6c 65 20 68 61 73 20 6f 6e 6c 79 20 36 34  able has only 64
1060: 2d 62 69 74 20 73 69 67 6e 65 64 20 69 6e 74 65  -bit signed inte
1070: 67 65 72 20 6b 65 79 73 20 2a 2f 0a 23 64 65 66  ger keys */.#def
1080: 69 6e 65 20 42 54 52 45 45 5f 42 4c 4f 42 4b 45  ine BTREE_BLOBKE
1090: 59 20 20 20 20 32 20 20 20 20 2f 2a 20 54 61 62  Y    2    /* Tab
10a0: 6c 65 20 68 61 73 20 6b 65 79 73 20 6f 6e 6c 79  le has keys only
10b0: 20 2d 20 6e 6f 20 64 61 74 61 20 2a 2f 0a 0a 69   - no data */..i
10c0: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 44  nt sqlite3BtreeD
10d0: 72 6f 70 54 61 62 6c 65 28 42 74 72 65 65 2a 2c  ropTable(Btree*,
10e0: 20 69 6e 74 2c 20 69 6e 74 2a 29 3b 0a 69 6e 74   int, int*);.int
10f0: 20 73 71 6c 69 74 65 33 42 74 72 65 65 43 6c 65   sqlite3BtreeCle
1100: 61 72 54 61 62 6c 65 28 42 74 72 65 65 2a 2c 20  arTable(Btree*, 
1110: 69 6e 74 2c 20 69 6e 74 2a 29 3b 0a 69 6e 74 20  int, int*);.int 
1120: 73 71 6c 69 74 65 33 42 74 72 65 65 43 6c 65 61  sqlite3BtreeClea
1130: 72 54 61 62 6c 65 4f 66 43 75 72 73 6f 72 28 42  rTableOfCursor(B
1140: 74 43 75 72 73 6f 72 2a 29 3b 0a 69 6e 74 20 73  tCursor*);.int s
1150: 71 6c 69 74 65 33 42 74 72 65 65 54 72 69 70 41  qlite3BtreeTripA
1160: 6c 6c 43 75 72 73 6f 72 73 28 42 74 72 65 65 2a  llCursors(Btree*
1170: 2c 20 69 6e 74 2c 20 69 6e 74 29 3b 0a 0a 76 6f  , int, int);..vo
1180: 69 64 20 73 71 6c 69 74 65 33 42 74 72 65 65 47  id sqlite3BtreeG
1190: 65 74 4d 65 74 61 28 42 74 72 65 65 20 2a 70 42  etMeta(Btree *pB
11a0: 74 72 65 65 2c 20 69 6e 74 20 69 64 78 2c 20 75  tree, int idx, u
11b0: 33 32 20 2a 70 56 61 6c 75 65 29 3b 0a 69 6e 74  32 *pValue);.int
11c0: 20 73 71 6c 69 74 65 33 42 74 72 65 65 55 70 64   sqlite3BtreeUpd
11d0: 61 74 65 4d 65 74 61 28 42 74 72 65 65 2a 2c 20  ateMeta(Btree*, 
11e0: 69 6e 74 20 69 64 78 2c 20 75 33 32 20 76 61 6c  int idx, u32 val
11f0: 75 65 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65  ue);..int sqlite
1200: 33 42 74 72 65 65 4e 65 77 44 62 28 42 74 72 65  3BtreeNewDb(Btre
1210: 65 20 2a 70 29 3b 0a 0a 2f 2a 0a 2a 2a 20 54 68  e *p);../*.** Th
1220: 65 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74  e second paramet
1230: 65 72 20 74 6f 20 73 71 6c 69 74 65 33 42 74 72  er to sqlite3Btr
1240: 65 65 47 65 74 4d 65 74 61 20 6f 72 20 73 71 6c  eeGetMeta or sql
1250: 69 74 65 33 42 74 72 65 65 55 70 64 61 74 65 4d  ite3BtreeUpdateM
1260: 65 74 61 0a 2a 2a 20 73 68 6f 75 6c 64 20 62 65  eta.** should be
1270: 20 6f 6e 65 20 6f 66 20 74 68 65 20 66 6f 6c 6c   one of the foll
1280: 6f 77 69 6e 67 20 76 61 6c 75 65 73 2e 20 54 68  owing values. Th
1290: 65 20 69 6e 74 65 67 65 72 20 76 61 6c 75 65 73  e integer values
12a0: 20 61 72 65 20 61 73 73 69 67 6e 65 64 20 0a 2a   are assigned .*
12b0: 2a 20 74 6f 20 63 6f 6e 73 74 61 6e 74 73 20 73  * to constants s
12c0: 6f 20 74 68 61 74 20 74 68 65 20 6f 66 66 73 65  o that the offse
12d0: 74 20 6f 66 20 74 68 65 20 63 6f 72 72 65 73 70  t of the corresp
12e0: 6f 6e 64 69 6e 67 20 66 69 65 6c 64 20 69 6e 20  onding field in 
12f0: 61 6e 0a 2a 2a 20 53 51 4c 69 74 65 20 64 61 74  an.** SQLite dat
1300: 61 62 61 73 65 20 68 65 61 64 65 72 20 6d 61 79  abase header may
1310: 20 62 65 20 66 6f 75 6e 64 20 75 73 69 6e 67 20   be found using 
1320: 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 66 6f  the following fo
1330: 72 6d 75 6c 61 3a 0a 2a 2a 0a 2a 2a 20 20 20 6f  rmula:.**.**   o
1340: 66 66 73 65 74 20 3d 20 33 36 20 2b 20 28 69 64  ffset = 36 + (id
1350: 78 20 2a 20 34 29 0a 2a 2a 0a 2a 2a 20 46 6f 72  x * 4).**.** For
1360: 20 65 78 61 6d 70 6c 65 2c 20 74 68 65 20 66 72   example, the fr
1370: 65 65 2d 70 61 67 65 2d 63 6f 75 6e 74 20 66 69  ee-page-count fi
1380: 65 6c 64 20 69 73 20 6c 6f 63 61 74 65 64 20 61  eld is located a
1390: 74 20 62 79 74 65 20 6f 66 66 73 65 74 20 33 36  t byte offset 36
13a0: 20 6f 66 0a 2a 2a 20 74 68 65 20 64 61 74 61 62   of.** the datab
13b0: 61 73 65 20 66 69 6c 65 20 68 65 61 64 65 72 2e  ase file header.
13c0: 20 54 68 65 20 69 6e 63 72 2d 76 61 63 75 75 6d   The incr-vacuum
13d0: 2d 66 6c 61 67 20 66 69 65 6c 64 20 69 73 20 6c  -flag field is l
13e0: 6f 63 61 74 65 64 20 61 74 0a 2a 2a 20 62 79 74  ocated at.** byt
13f0: 65 20 6f 66 66 73 65 74 20 36 34 20 28 3d 3d 20  e offset 64 (== 
1400: 33 36 2b 34 2a 37 29 2e 0a 2a 2a 0a 2a 2a 20 54  36+4*7)..**.** T
1410: 68 65 20 42 54 52 45 45 5f 44 41 54 41 5f 56 45  he BTREE_DATA_VE
1420: 52 53 49 4f 4e 20 76 61 6c 75 65 20 69 73 20 6e  RSION value is n
1430: 6f 74 20 72 65 61 6c 6c 79 20 61 20 76 61 6c 75  ot really a valu
1440: 65 20 73 74 6f 72 65 64 20 69 6e 20 74 68 65 20  e stored in the 
1450: 68 65 61 64 65 72 2e 0a 2a 2a 20 49 74 20 69 73  header..** It is
1460: 20 61 20 72 65 61 64 2d 6f 6e 6c 79 20 6e 75 6d   a read-only num
1470: 62 65 72 20 63 6f 6d 70 75 74 65 64 20 62 79 20  ber computed by 
1480: 74 68 65 20 70 61 67 65 72 2e 20 20 42 75 74 20  the pager.  But 
1490: 77 65 20 6d 65 72 67 65 20 69 74 20 77 69 74 68  we merge it with
14a0: 0a 2a 2a 20 74 68 65 20 68 65 61 64 65 72 20 76  .** the header v
14b0: 61 6c 75 65 20 61 63 63 65 73 73 20 72 6f 75 74  alue access rout
14c0: 69 6e 65 73 20 73 69 6e 63 65 20 69 74 73 20 61  ines since its a
14d0: 63 63 65 73 73 20 70 61 74 74 65 72 6e 20 69 73  ccess pattern is
14e0: 20 74 68 65 20 73 61 6d 65 2e 0a 2a 2a 20 43 61   the same..** Ca
14f0: 6c 6c 20 69 74 20 61 20 22 76 69 72 74 75 61 6c  ll it a "virtual
1500: 20 6d 65 74 61 20 76 61 6c 75 65 22 2e 0a 2a 2f   meta value"..*/
1510: 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f 46  .#define BTREE_F
1520: 52 45 45 5f 50 41 47 45 5f 43 4f 55 4e 54 20 20  REE_PAGE_COUNT  
1530: 20 20 20 30 0a 23 64 65 66 69 6e 65 20 42 54 52     0.#define BTR
1540: 45 45 5f 53 43 48 45 4d 41 5f 56 45 52 53 49 4f  EE_SCHEMA_VERSIO
1550: 4e 20 20 20 20 20 20 31 0a 23 64 65 66 69 6e 65  N      1.#define
1560: 20 42 54 52 45 45 5f 46 49 4c 45 5f 46 4f 52 4d   BTREE_FILE_FORM
1570: 41 54 20 20 20 20 20 20 20 20 20 32 0a 23 64 65  AT         2.#de
1580: 66 69 6e 65 20 42 54 52 45 45 5f 44 45 46 41 55  fine BTREE_DEFAU
1590: 4c 54 5f 43 41 43 48 45 5f 53 49 5a 45 20 20 33  LT_CACHE_SIZE  3
15a0: 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f 4c  .#define BTREE_L
15b0: 41 52 47 45 53 54 5f 52 4f 4f 54 5f 50 41 47 45  ARGEST_ROOT_PAGE
15c0: 20 20 20 34 0a 23 64 65 66 69 6e 65 20 42 54 52     4.#define BTR
15d0: 45 45 5f 54 45 58 54 5f 45 4e 43 4f 44 49 4e 47  EE_TEXT_ENCODING
15e0: 20 20 20 20 20 20 20 35 0a 23 64 65 66 69 6e 65         5.#define
15f0: 20 42 54 52 45 45 5f 55 53 45 52 5f 56 45 52 53   BTREE_USER_VERS
1600: 49 4f 4e 20 20 20 20 20 20 20 20 36 0a 23 64 65  ION        6.#de
1610: 66 69 6e 65 20 42 54 52 45 45 5f 49 4e 43 52 5f  fine BTREE_INCR_
1620: 56 41 43 55 55 4d 20 20 20 20 20 20 20 20 20 37  VACUUM         7
1630: 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f 41  .#define BTREE_A
1640: 50 50 4c 49 43 41 54 49 4f 4e 5f 49 44 20 20 20  PPLICATION_ID   
1650: 20 20 20 38 0a 23 64 65 66 69 6e 65 20 42 54 52     8.#define BTR
1660: 45 45 5f 44 41 54 41 5f 56 45 52 53 49 4f 4e 20  EE_DATA_VERSION 
1670: 20 20 20 20 20 20 20 31 35 20 20 2f 2a 20 41 20         15  /* A 
1680: 76 69 72 74 75 61 6c 20 6d 65 74 61 2d 76 61 6c  virtual meta-val
1690: 75 65 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 4b 69 6e  ue */../*.** Kin
16a0: 64 73 20 6f 66 20 68 69 6e 74 73 20 74 68 61 74  ds of hints that
16b0: 20 63 61 6e 20 62 65 20 70 61 73 73 65 64 20 69   can be passed i
16c0: 6e 74 6f 20 74 68 65 20 73 71 6c 69 74 65 33 42  nto the sqlite3B
16d0: 74 72 65 65 43 75 72 73 6f 72 48 69 6e 74 28 29  treeCursorHint()
16e0: 0a 2a 2a 20 69 6e 74 65 72 66 61 63 65 2e 0a 2a  .** interface..*
16f0: 2a 0a 2a 2a 20 42 54 52 45 45 5f 48 49 4e 54 5f  *.** BTREE_HINT_
1700: 52 41 4e 47 45 20 20 28 61 72 67 75 6d 65 6e 74  RANGE  (argument
1710: 73 3a 20 45 78 70 72 2a 2c 20 4d 65 6d 2a 29 0a  s: Expr*, Mem*).
1720: 2a 2a 0a 2a 2a 20 20 20 20 20 54 68 65 20 66 69  **.**     The fi
1730: 72 73 74 20 61 72 67 75 6d 65 6e 74 20 69 73 20  rst argument is 
1740: 61 6e 20 45 78 70 72 2a 20 28 77 68 69 63 68 20  an Expr* (which 
1750: 69 73 20 67 75 61 72 61 6e 74 65 65 64 20 74 6f  is guaranteed to
1760: 20 62 65 20 63 6f 6e 73 74 61 6e 74 20 66 6f 72   be constant for
1770: 0a 2a 2a 20 20 20 20 20 74 68 65 20 6c 69 66 65  .**     the life
1780: 74 69 6d 65 20 6f 66 20 74 68 65 20 63 75 72 73  time of the curs
1790: 6f 72 29 20 74 68 61 74 20 64 65 66 69 6e 65 73  or) that defines
17a0: 20 63 6f 6e 73 74 72 61 69 6e 74 73 20 6f 6e 20   constraints on 
17b0: 77 68 69 63 68 20 72 6f 77 73 0a 2a 2a 20 20 20  which rows.**   
17c0: 20 20 6d 69 67 68 74 20 62 65 20 66 65 74 63 68    might be fetch
17d0: 65 64 20 77 69 74 68 20 74 68 69 73 20 63 75 72  ed with this cur
17e0: 73 6f 72 2e 20 20 54 68 65 20 45 78 70 72 2a 20  sor.  The Expr* 
17f0: 74 72 65 65 20 6d 61 79 20 63 6f 6e 74 61 69 6e  tree may contain
1800: 0a 2a 2a 20 20 20 20 20 54 4b 5f 52 45 47 49 53  .**     TK_REGIS
1810: 54 45 52 20 6e 6f 64 65 73 20 74 68 61 74 20 72  TER nodes that r
1820: 65 66 65 72 20 74 6f 20 76 61 6c 75 65 73 20 73  efer to values s
1830: 74 6f 72 65 64 20 69 6e 20 74 68 65 20 61 72 72  tored in the arr
1840: 61 79 20 6f 66 20 72 65 67 69 73 74 65 72 73 0a  ay of registers.
1850: 2a 2a 20 20 20 20 20 70 61 73 73 65 64 20 61 73  **     passed as
1860: 20 74 68 65 20 73 65 63 6f 6e 64 20 70 61 72 61   the second para
1870: 6d 65 74 65 72 2e 20 20 49 6e 20 6f 74 68 65 72  meter.  In other
1880: 20 77 6f 72 64 73 2c 20 69 66 20 45 78 70 72 2e   words, if Expr.
1890: 6f 70 3d 3d 54 4b 5f 52 45 47 49 53 54 45 52 0a  op==TK_REGISTER.
18a0: 2a 2a 20 20 20 20 20 74 68 65 6e 20 74 68 65 20  **     then the 
18b0: 76 61 6c 75 65 20 6f 66 20 74 68 65 20 6e 6f 64  value of the nod
18c0: 65 20 69 73 20 74 68 65 20 76 61 6c 75 65 20 69  e is the value i
18d0: 6e 20 4d 65 6d 5b 70 45 78 70 72 2e 69 54 61 62  n Mem[pExpr.iTab
18e0: 6c 65 5d 2e 20 20 41 6e 79 0a 2a 2a 20 20 20 20  le].  Any.**    
18f0: 20 54 4b 5f 43 4f 4c 55 4d 4e 20 6e 6f 64 65 20   TK_COLUMN node 
1900: 69 6e 20 74 68 65 20 65 78 70 72 65 73 73 69 6f  in the expressio
1910: 6e 20 74 72 65 65 20 72 65 66 65 72 73 20 74 6f  n tree refers to
1920: 20 74 68 65 20 45 78 70 72 2e 69 43 6f 6c 75 6d   the Expr.iColum
1930: 6e 2d 74 68 0a 2a 2a 20 20 20 20 20 63 6f 6c 75  n-th.**     colu
1940: 6d 6e 20 6f 66 20 74 68 65 20 62 2d 74 72 65 65  mn of the b-tree
1950: 20 6f 66 20 74 68 65 20 63 75 72 73 6f 72 2e 20   of the cursor. 
1960: 20 54 68 65 20 45 78 70 72 20 74 72 65 65 20 77   The Expr tree w
1970: 69 6c 6c 20 6e 6f 74 20 63 6f 6e 74 61 69 6e 0a  ill not contain.
1980: 2a 2a 20 20 20 20 20 61 6e 79 20 66 75 6e 63 74  **     any funct
1990: 69 6f 6e 20 63 61 6c 6c 73 20 6e 6f 72 20 73 75  ion calls nor su
19a0: 62 71 75 65 72 69 65 73 20 6e 6f 72 20 72 65 66  bqueries nor ref
19b0: 65 72 65 6e 63 65 73 20 74 6f 20 62 2d 74 72 65  erences to b-tre
19c0: 65 73 20 6f 74 68 65 72 20 74 68 61 6e 0a 2a 2a  es other than.**
19d0: 20 20 20 20 20 74 68 65 20 63 75 72 73 6f 72 20       the cursor 
19e0: 62 65 69 6e 67 20 68 69 6e 74 65 64 2e 0a 2a 2a  being hinted..**
19f0: 0a 2a 2a 20 20 20 20 20 54 68 65 20 64 65 73 69  .**     The desi
1a00: 67 6e 20 6f 66 20 74 68 65 20 5f 52 41 4e 47 45  gn of the _RANGE
1a10: 20 68 69 6e 74 20 69 73 20 61 69 64 20 62 2d 74   hint is aid b-t
1a20: 72 65 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69  ree implementati
1a30: 6f 6e 73 20 74 68 61 74 20 74 72 79 0a 2a 2a 20  ons that try.** 
1a40: 20 20 20 20 74 6f 20 70 72 65 66 65 74 63 68 20      to prefetch 
1a50: 63 6f 6e 74 65 6e 74 20 66 72 6f 6d 20 72 65 6d  content from rem
1a60: 6f 74 65 20 6d 61 63 68 69 6e 65 73 20 2d 20 74  ote machines - t
1a70: 6f 20 70 72 6f 76 69 64 65 20 74 68 6f 73 65 0a  o provide those.
1a80: 2a 2a 20 20 20 20 20 69 6d 70 6c 65 6d 65 6e 74  **     implement
1a90: 61 74 69 6f 6e 73 20 77 69 74 68 20 6c 69 6d 69  ations with limi
1aa0: 74 73 20 6f 6e 20 77 68 61 74 20 6e 65 65 64 73  ts on what needs
1ab0: 20 74 6f 20 62 65 20 70 72 65 66 65 74 63 68 65   to be prefetche
1ac0: 64 20 61 6e 64 20 74 68 65 72 65 62 79 0a 2a 2a  d and thereby.**
1ad0: 20 20 20 20 20 72 65 64 75 63 65 20 6e 65 74 77       reduce netw
1ae0: 6f 72 6b 20 62 61 6e 64 77 69 64 74 68 2e 0a 2a  ork bandwidth..*
1af0: 2a 0a 2a 2a 20 4e 6f 74 65 20 74 68 61 74 20 42  *.** Note that B
1b00: 54 52 45 45 5f 48 49 4e 54 5f 46 4c 41 47 53 20  TREE_HINT_FLAGS 
1b10: 77 69 74 68 20 42 54 52 45 45 5f 42 55 4c 4b 4c  with BTREE_BULKL
1b20: 4f 41 44 20 69 73 20 74 68 65 20 6f 6e 6c 79 20  OAD is the only 
1b30: 68 69 6e 74 20 75 73 65 64 20 62 79 0a 2a 2a 20  hint used by.** 
1b40: 73 74 61 6e 64 61 72 64 20 53 51 4c 69 74 65 2e  standard SQLite.
1b50: 20 20 54 68 65 20 6f 74 68 65 72 20 68 69 6e 74    The other hint
1b60: 73 20 61 72 65 20 70 72 6f 76 69 64 65 64 20 66  s are provided f
1b70: 6f 72 20 65 78 74 65 6e 74 69 6f 6e 73 20 74 68  or extentions th
1b80: 61 74 20 75 73 65 0a 2a 2a 20 74 68 65 20 53 51  at use.** the SQ
1b90: 4c 69 74 65 20 70 61 72 73 65 72 20 61 6e 64 20  Lite parser and 
1ba0: 63 6f 64 65 20 67 65 6e 65 72 61 74 6f 72 20 62  code generator b
1bb0: 75 74 20 73 75 62 73 74 69 74 75 74 65 20 74 68  ut substitute th
1bc0: 65 69 72 20 6f 77 6e 20 73 74 6f 72 61 67 65 0a  eir own storage.
1bd0: 2a 2a 20 65 6e 67 69 6e 65 2e 0a 2a 2f 0a 23 64  ** engine..*/.#d
1be0: 65 66 69 6e 65 20 42 54 52 45 45 5f 48 49 4e 54  efine BTREE_HINT
1bf0: 5f 52 41 4e 47 45 20 30 20 20 20 20 20 20 20 2f  _RANGE 0       /
1c00: 2a 20 52 61 6e 67 65 20 63 6f 6e 73 74 72 61 69  * Range constrai
1c10: 6e 74 73 20 6f 6e 20 71 75 65 72 69 65 73 20 2a  nts on queries *
1c20: 2f 0a 0a 2f 2a 0a 2a 2a 20 56 61 6c 75 65 73 20  /../*.** Values 
1c30: 74 68 61 74 20 6d 61 79 20 62 65 20 4f 52 27 64  that may be OR'd
1c40: 20 74 6f 67 65 74 68 65 72 20 74 6f 20 66 6f 72   together to for
1c50: 6d 20 74 68 65 20 61 72 67 75 6d 65 6e 74 20 74  m the argument t
1c60: 6f 20 74 68 65 0a 2a 2a 20 42 54 52 45 45 5f 48  o the.** BTREE_H
1c70: 49 4e 54 5f 46 4c 41 47 53 20 68 69 6e 74 20 66  INT_FLAGS hint f
1c80: 6f 72 20 73 71 6c 69 74 65 33 42 74 72 65 65 43  or sqlite3BtreeC
1c90: 75 72 73 6f 72 48 69 6e 74 28 29 3a 0a 2a 2a 0a  ursorHint():.**.
1ca0: 2a 2a 20 54 68 65 20 42 54 52 45 45 5f 42 55 4c  ** The BTREE_BUL
1cb0: 4b 4c 4f 41 44 20 66 6c 61 67 20 69 73 20 73 65  KLOAD flag is se
1cc0: 74 20 6f 6e 20 69 6e 64 65 78 20 63 75 72 73 6f  t on index curso
1cd0: 72 73 20 77 68 65 6e 20 74 68 65 20 69 6e 64 65  rs when the inde
1ce0: 78 20 69 73 20 67 6f 69 6e 67 0a 2a 2a 20 74 6f  x is going.** to
1cf0: 20 62 65 20 66 69 6c 6c 65 64 20 77 69 74 68 20   be filled with 
1d00: 63 6f 6e 74 65 6e 74 20 74 68 61 74 20 69 73 20  content that is 
1d10: 61 6c 72 65 61 64 79 20 69 6e 20 73 6f 72 74 65  already in sorte
1d20: 64 20 6f 72 64 65 72 2e 0a 2a 2a 0a 2a 2a 20 54  d order..**.** T
1d30: 68 65 20 42 54 52 45 45 5f 53 45 45 4b 5f 45 51  he BTREE_SEEK_EQ
1d40: 20 66 6c 61 67 20 69 73 20 73 65 74 20 6f 6e 20   flag is set on 
1d50: 63 75 72 73 6f 72 73 20 74 68 61 74 20 77 69 6c  cursors that wil
1d60: 6c 20 67 65 74 20 4f 50 5f 53 65 65 6b 47 45 20  l get OP_SeekGE 
1d70: 6f 72 0a 2a 2a 20 4f 50 5f 53 65 65 6b 4c 45 20  or.** OP_SeekLE 
1d80: 6f 70 63 6f 64 65 73 20 66 6f 72 20 61 20 72 61  opcodes for a ra
1d90: 6e 67 65 20 73 65 61 72 63 68 2c 20 62 75 74 20  nge search, but 
1da0: 77 68 65 72 65 20 74 68 65 20 72 61 6e 67 65 20  where the range 
1db0: 6f 66 20 65 6e 74 72 69 65 73 0a 2a 2a 20 73 65  of entries.** se
1dc0: 6c 65 63 74 65 64 20 77 69 6c 6c 20 61 6c 6c 20  lected will all 
1dd0: 68 61 76 65 20 74 68 65 20 73 61 6d 65 20 6b 65  have the same ke
1de0: 79 2e 20 20 49 6e 20 6f 74 68 65 72 20 77 6f 72  y.  In other wor
1df0: 64 73 2c 20 74 68 65 20 63 75 72 73 6f 72 20 77  ds, the cursor w
1e00: 69 6c 6c 0a 2a 2a 20 62 65 20 75 73 65 64 20 6f  ill.** be used o
1e10: 6e 6c 79 20 66 6f 72 20 65 71 75 61 6c 69 74 79  nly for equality
1e20: 20 6b 65 79 20 73 65 61 72 63 68 65 73 2e 0a 2a   key searches..*
1e30: 2a 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52  *.*/.#define BTR
1e40: 45 45 5f 42 55 4c 4b 4c 4f 41 44 20 30 78 30 30  EE_BULKLOAD 0x00
1e50: 30 30 30 30 30 31 20 20 2f 2a 20 55 73 65 64 20  000001  /* Used 
1e60: 74 6f 20 66 75 6c 6c 20 69 6e 64 65 78 20 69 6e  to full index in
1e70: 20 73 6f 72 74 65 64 20 6f 72 64 65 72 20 2a 2f   sorted order */
1e80: 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f 53  .#define BTREE_S
1e90: 45 45 4b 5f 45 51 20 20 30 78 30 30 30 30 30 30  EEK_EQ  0x000000
1ea0: 30 32 20 20 2f 2a 20 45 51 20 73 65 65 6b 73 20  02  /* EQ seeks 
1eb0: 6f 6e 6c 79 20 2d 20 6e 6f 20 72 61 6e 67 65 20  only - no range 
1ec0: 73 65 65 6b 73 20 2a 2f 0a 0a 2f 2a 20 0a 2a 2a  seeks */../* .**
1ed0: 20 46 6c 61 67 73 20 70 61 73 73 65 64 20 61 73   Flags passed as
1ee0: 20 74 68 65 20 74 68 69 72 64 20 61 72 67 75 6d   the third argum
1ef0: 65 6e 74 20 74 6f 20 73 71 6c 69 74 65 33 42 74  ent to sqlite3Bt
1f00: 72 65 65 43 75 72 73 6f 72 28 29 2e 0a 2a 2a 0a  reeCursor()..**.
1f10: 2a 2a 20 46 6f 72 20 72 65 61 64 2d 6f 6e 6c 79  ** For read-only
1f20: 20 63 75 72 73 6f 72 73 20 74 68 65 20 77 72 46   cursors the wrF
1f30: 6c 61 67 20 61 72 67 75 6d 65 6e 74 20 69 73 20  lag argument is 
1f40: 61 6c 77 61 79 73 20 7a 65 72 6f 2e 20 46 6f 72  always zero. For
1f50: 20 72 65 61 64 2d 77 72 69 74 65 0a 2a 2a 20 63   read-write.** c
1f60: 75 72 73 6f 72 73 20 69 74 20 6d 61 79 20 62 65  ursors it may be
1f70: 20 73 65 74 20 74 6f 20 65 69 74 68 65 72 20 28   set to either (
1f80: 42 54 52 45 45 5f 57 52 43 53 52 7c 42 54 52 45  BTREE_WRCSR|BTRE
1f90: 45 5f 46 4f 52 44 45 4c 45 54 45 29 20 6f 72 20  E_FORDELETE) or 
1fa0: 6a 75 73 74 0a 2a 2a 20 28 42 54 52 45 45 5f 57  just.** (BTREE_W
1fb0: 52 43 53 52 29 2e 20 49 66 20 74 68 65 20 42 54  RCSR). If the BT
1fc0: 52 45 45 5f 46 4f 52 44 45 4c 45 54 45 20 62 69  REE_FORDELETE bi
1fd0: 74 20 69 73 20 73 65 74 2c 20 74 68 65 6e 20 74  t is set, then t
1fe0: 68 65 20 63 75 72 73 6f 72 20 77 69 6c 6c 0a 2a  he cursor will.*
1ff0: 2a 20 6f 6e 6c 79 20 62 65 20 75 73 65 64 20 62  * only be used b
2000: 79 20 53 51 4c 69 74 65 20 66 6f 72 20 74 68 65  y SQLite for the
2010: 20 66 6f 6c 6c 6f 77 69 6e 67 3a 0a 2a 2a 0a 2a   following:.**.*
2020: 2a 20 20 20 2a 20 74 6f 20 73 65 65 6b 20 74 6f  *   * to seek to
2030: 20 61 6e 64 20 74 68 65 6e 20 64 65 6c 65 74 65   and then delete
2040: 20 73 70 65 63 69 66 69 63 20 65 6e 74 72 69 65   specific entrie
2050: 73 2c 20 61 6e 64 2f 6f 72 0a 2a 2a 0a 2a 2a 20  s, and/or.**.** 
2060: 20 20 2a 20 74 6f 20 72 65 61 64 20 76 61 6c 75    * to read valu
2070: 65 73 20 74 68 61 74 20 77 69 6c 6c 20 62 65 20  es that will be 
2080: 75 73 65 64 20 74 6f 20 63 72 65 61 74 65 20 6b  used to create k
2090: 65 79 73 20 74 68 61 74 20 6f 74 68 65 72 0a 2a  eys that other.*
20a0: 2a 20 20 20 20 20 42 54 52 45 45 5f 46 4f 52 44  *     BTREE_FORD
20b0: 45 4c 45 54 45 20 63 75 72 73 6f 72 73 20 77 69  ELETE cursors wi
20c0: 6c 6c 20 73 65 65 6b 20 74 6f 20 61 6e 64 20 64  ll seek to and d
20d0: 65 6c 65 74 65 2e 0a 2a 2a 0a 2a 2a 20 54 68 65  elete..**.** The
20e0: 20 42 54 52 45 45 5f 46 4f 52 44 45 4c 45 54 45   BTREE_FORDELETE
20f0: 20 66 6c 61 67 20 69 73 20 61 6e 20 6f 70 74 69   flag is an opti
2100: 6d 69 7a 61 74 69 6f 6e 20 68 69 6e 74 2e 20 20  mization hint.  
2110: 49 74 20 69 73 20 6e 6f 74 20 75 73 65 64 20 62  It is not used b
2120: 79 0a 2a 2a 20 62 79 20 74 68 69 73 2c 20 74 68  y.** by this, th
2130: 65 20 6e 61 74 69 76 65 20 62 2d 74 72 65 65 20  e native b-tree 
2140: 65 6e 67 69 6e 65 20 6f 66 20 53 51 4c 69 74 65  engine of SQLite
2150: 2c 20 62 75 74 20 69 74 20 69 73 20 61 76 61 69  , but it is avai
2160: 6c 61 62 6c 65 20 74 6f 0a 2a 2a 20 61 6c 74 65  lable to.** alte
2170: 72 6e 61 74 69 76 65 20 73 74 6f 72 61 67 65 20  rnative storage 
2180: 65 6e 67 69 6e 65 73 20 74 68 61 74 20 6d 69 67  engines that mig
2190: 68 74 20 62 65 20 73 75 62 73 74 69 74 75 74 65  ht be substitute
21a0: 64 20 69 6e 20 70 6c 61 63 65 20 6f 66 20 74 68  d in place of th
21b0: 69 73 0a 2a 2a 20 62 2d 74 72 65 65 20 73 79 73  is.** b-tree sys
21c0: 74 65 6d 2e 20 20 46 6f 72 20 61 6c 74 65 72 6e  tem.  For altern
21d0: 61 74 69 76 65 20 73 74 6f 72 61 67 65 20 65 6e  ative storage en
21e0: 67 69 6e 65 73 20 69 6e 20 77 68 69 63 68 20 61  gines in which a
21f0: 20 64 65 6c 65 74 65 20 6f 66 0a 2a 2a 20 74 68   delete of.** th
2200: 65 20 6d 61 69 6e 20 74 61 62 6c 65 20 72 6f 77  e main table row
2210: 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 64   automatically d
2220: 65 6c 65 74 65 73 20 63 6f 72 72 65 73 70 6f 6e  eletes correspon
2230: 64 69 6e 67 20 69 6e 64 65 78 20 72 6f 77 73 2c  ding index rows,
2240: 0a 2a 2a 20 74 68 65 20 46 4f 52 44 45 4c 45 54  .** the FORDELET
2250: 45 20 66 6c 61 67 20 68 69 6e 74 20 61 6c 6c 6f  E flag hint allo
2260: 77 73 20 74 68 6f 73 65 20 61 6c 74 65 72 6e 61  ws those alterna
2270: 74 69 76 65 20 73 74 6f 72 61 67 65 20 65 6e 67  tive storage eng
2280: 69 6e 65 73 20 74 6f 0a 2a 2a 20 73 6b 69 70 20  ines to.** skip 
2290: 61 20 6c 6f 74 20 6f 66 20 77 6f 72 6b 2e 20 20  a lot of work.  
22a0: 4e 61 6d 65 6c 79 3a 20 20 46 4f 52 44 45 4c 45  Namely:  FORDELE
22b0: 54 45 20 63 75 72 73 6f 72 73 20 6d 61 79 20 74  TE cursors may t
22c0: 72 65 61 74 20 61 6c 6c 20 53 45 45 4b 0a 2a 2a  reat all SEEK.**
22d0: 20 61 6e 64 20 44 45 4c 45 54 45 20 6f 70 65 72   and DELETE oper
22e0: 61 74 69 6f 6e 73 20 61 73 20 6e 6f 2d 6f 70 73  ations as no-ops
22f0: 2c 20 61 6e 64 20 61 6e 79 20 52 45 41 44 20 6f  , and any READ o
2300: 70 65 72 61 74 69 6f 6e 20 61 67 61 69 6e 73 74  peration against
2310: 20 61 0a 2a 2a 20 46 4f 52 44 45 4c 45 54 45 20   a.** FORDELETE 
2320: 63 75 72 73 6f 72 20 6d 61 79 20 72 65 74 75 72  cursor may retur
2330: 6e 20 61 20 6e 75 6c 6c 20 72 6f 77 3a 20 30 78  n a null row: 0x
2340: 30 31 20 30 78 30 30 2e 0a 2a 2f 0a 23 64 65 66  01 0x00..*/.#def
2350: 69 6e 65 20 42 54 52 45 45 5f 57 52 43 53 52 20  ine BTREE_WRCSR 
2360: 20 20 20 20 30 78 30 30 30 30 30 30 30 34 20 20      0x00000004  
2370: 20 20 20 2f 2a 20 72 65 61 64 2d 77 72 69 74 65     /* read-write
2380: 20 63 75 72 73 6f 72 20 2a 2f 0a 23 64 65 66 69   cursor */.#defi
2390: 6e 65 20 42 54 52 45 45 5f 46 4f 52 44 45 4c 45  ne BTREE_FORDELE
23a0: 54 45 20 30 78 30 30 30 30 30 30 30 38 20 20 20  TE 0x00000008   
23b0: 20 20 2f 2a 20 43 75 72 73 6f 72 20 69 73 20 66    /* Cursor is f
23c0: 6f 72 20 73 65 65 6b 2f 64 65 6c 65 74 65 20 6f  or seek/delete o
23d0: 6e 6c 79 20 2a 2f 0a 0a 69 6e 74 20 73 71 6c 69  nly */..int sqli
23e0: 74 65 33 42 74 72 65 65 43 75 72 73 6f 72 28 0a  te3BtreeCursor(.
23f0: 20 20 42 74 72 65 65 2a 2c 20 20 20 20 20 20 20    Btree*,       
2400: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2410: 20 20 20 20 20 20 20 2f 2a 20 42 54 72 65 65 20         /* BTree 
2420: 63 6f 6e 74 61 69 6e 69 6e 67 20 74 61 62 6c 65  containing table
2430: 20 74 6f 20 6f 70 65 6e 20 2a 2f 0a 20 20 69 6e   to open */.  in
2440: 74 20 69 54 61 62 6c 65 2c 20 20 20 20 20 20 20  t iTable,       
2450: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2460: 20 20 20 2f 2a 20 49 6e 64 65 78 20 6f 66 20 72     /* Index of r
2470: 6f 6f 74 20 70 61 67 65 20 2a 2f 0a 20 20 69 6e  oot page */.  in
2480: 74 20 77 72 46 6c 61 67 2c 20 20 20 20 20 20 20  t wrFlag,       
2490: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
24a0: 20 20 20 2f 2a 20 31 20 66 6f 72 20 77 72 69 74     /* 1 for writ
24b0: 69 6e 67 2e 20 20 30 20 66 6f 72 20 72 65 61 64  ing.  0 for read
24c0: 2d 6f 6e 6c 79 20 2a 2f 0a 20 20 73 74 72 75 63  -only */.  struc
24d0: 74 20 4b 65 79 49 6e 66 6f 2a 2c 20 20 20 20 20  t KeyInfo*,     
24e0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
24f0: 2f 2a 20 46 69 72 73 74 20 61 72 67 75 6d 65 6e  /* First argumen
2500: 74 20 74 6f 20 63 6f 6d 70 61 72 65 20 66 75 6e  t to compare fun
2510: 63 74 69 6f 6e 20 2a 2f 0a 20 20 42 74 43 75 72  ction */.  BtCur
2520: 73 6f 72 20 2a 70 43 75 72 73 6f 72 20 20 20 20  sor *pCursor    
2530: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2540: 2f 2a 20 53 70 61 63 65 20 74 6f 20 77 72 69 74  /* Space to writ
2550: 65 20 63 75 72 73 6f 72 20 73 74 72 75 63 74 75  e cursor structu
2560: 72 65 20 2a 2f 0a 29 3b 0a 69 6e 74 20 73 71 6c  re */.);.int sql
2570: 69 74 65 33 42 74 72 65 65 43 75 72 73 6f 72 53  ite3BtreeCursorS
2580: 69 7a 65 28 76 6f 69 64 29 3b 0a 76 6f 69 64 20  ize(void);.void 
2590: 73 71 6c 69 74 65 33 42 74 72 65 65 43 75 72 73  sqlite3BtreeCurs
25a0: 6f 72 5a 65 72 6f 28 42 74 43 75 72 73 6f 72 2a  orZero(BtCursor*
25b0: 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 42  );.void sqlite3B
25c0: 74 72 65 65 43 75 72 73 6f 72 48 69 6e 74 46 6c  treeCursorHintFl
25d0: 61 67 73 28 42 74 43 75 72 73 6f 72 2a 2c 20 75  ags(BtCursor*, u
25e0: 6e 73 69 67 6e 65 64 29 3b 0a 23 69 66 64 65 66  nsigned);.#ifdef
25f0: 20 53 51 4c 49 54 45 5f 45 4e 41 42 4c 45 5f 43   SQLITE_ENABLE_C
2600: 55 52 53 4f 52 5f 48 49 4e 54 53 0a 76 6f 69 64  URSOR_HINTS.void
2610: 20 73 71 6c 69 74 65 33 42 74 72 65 65 43 75 72   sqlite3BtreeCur
2620: 73 6f 72 48 69 6e 74 28 42 74 43 75 72 73 6f 72  sorHint(BtCursor
2630: 2a 2c 20 69 6e 74 2c 20 2e 2e 2e 29 3b 0a 23 65  *, int, ...);.#e
2640: 6e 64 69 66 0a 0a 69 6e 74 20 73 71 6c 69 74 65  ndif..int sqlite
2650: 33 42 74 72 65 65 43 6c 6f 73 65 43 75 72 73 6f  3BtreeCloseCurso
2660: 72 28 42 74 43 75 72 73 6f 72 2a 29 3b 0a 69 6e  r(BtCursor*);.in
2670: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 4d 6f  t sqlite3BtreeMo
2680: 76 65 74 6f 55 6e 70 61 63 6b 65 64 28 0a 20 20  vetoUnpacked(.  
2690: 42 74 43 75 72 73 6f 72 2a 2c 0a 20 20 55 6e 70  BtCursor*,.  Unp
26a0: 61 63 6b 65 64 52 65 63 6f 72 64 20 2a 70 55 6e  ackedRecord *pUn
26b0: 4b 65 79 2c 0a 20 20 69 36 34 20 69 6e 74 4b 65  Key,.  i64 intKe
26c0: 79 2c 0a 20 20 69 6e 74 20 62 69 61 73 2c 0a 20  y,.  int bias,. 
26d0: 20 69 6e 74 20 2a 70 52 65 73 0a 29 3b 0a 69 6e   int *pRes.);.in
26e0: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 43 75  t sqlite3BtreeCu
26f0: 72 73 6f 72 48 61 73 4d 6f 76 65 64 28 42 74 43  rsorHasMoved(BtC
2700: 75 72 73 6f 72 2a 29 3b 0a 69 6e 74 20 73 71 6c  ursor*);.int sql
2710: 69 74 65 33 42 74 72 65 65 43 75 72 73 6f 72 52  ite3BtreeCursorR
2720: 65 73 74 6f 72 65 28 42 74 43 75 72 73 6f 72 2a  estore(BtCursor*
2730: 2c 20 69 6e 74 2a 29 3b 0a 69 6e 74 20 73 71 6c  , int*);.int sql
2740: 69 74 65 33 42 74 72 65 65 44 65 6c 65 74 65 28  ite3BtreeDelete(
2750: 42 74 43 75 72 73 6f 72 2a 2c 20 75 38 20 66 6c  BtCursor*, u8 fl
2760: 61 67 73 29 3b 0a 0a 2f 2a 20 41 6c 6c 6f 77 65  ags);../* Allowe
2770: 64 20 66 6c 61 67 73 20 66 6f 72 20 74 68 65 20  d flags for the 
2780: 32 6e 64 20 61 72 67 75 6d 65 6e 74 20 74 6f 20  2nd argument to 
2790: 73 71 6c 69 74 65 33 42 74 72 65 65 44 65 6c 65  sqlite3BtreeDele
27a0: 74 65 28 29 20 2a 2f 0a 23 64 65 66 69 6e 65 20  te() */.#define 
27b0: 42 54 52 45 45 5f 53 41 56 45 50 4f 53 49 54 49  BTREE_SAVEPOSITI
27c0: 4f 4e 20 30 78 30 32 20 20 2f 2a 20 4c 65 61 76  ON 0x02  /* Leav
27d0: 65 20 63 75 72 73 6f 72 20 70 6f 69 6e 74 69 6e  e cursor pointin
27e0: 67 20 61 74 20 4e 45 58 54 20 6f 72 20 50 52 45  g at NEXT or PRE
27f0: 56 20 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52  V */.#define BTR
2800: 45 45 5f 41 55 58 44 45 4c 45 54 45 20 20 20 20  EE_AUXDELETE    
2810: 30 78 30 34 20 20 2f 2a 20 6e 6f 74 20 74 68 65  0x04  /* not the
2820: 20 70 72 69 6d 61 72 79 20 64 65 6c 65 74 65 20   primary delete 
2830: 6f 70 65 72 61 74 69 6f 6e 20 2a 2f 0a 0a 2f 2a  operation */../*
2840: 20 41 6e 20 69 6e 73 74 61 6e 63 65 20 6f 66 20   An instance of 
2850: 74 68 65 20 42 74 72 65 65 50 61 79 6c 6f 61 64  the BtreePayload
2860: 20 6f 62 6a 65 63 74 20 64 65 73 63 72 69 62 65   object describe
2870: 73 20 74 68 65 20 63 6f 6e 74 65 6e 74 20 6f 66  s the content of
2880: 20 61 20 73 69 6e 67 6c 65 0a 2a 2a 20 65 6e 74   a single.** ent
2890: 72 79 20 69 6e 20 65 69 74 68 65 72 20 61 6e 20  ry in either an 
28a0: 69 6e 64 65 78 20 6f 72 20 74 61 62 6c 65 20 62  index or table b
28b0: 74 72 65 65 2e 0a 2a 2a 0a 2a 2a 20 49 6e 64 65  tree..**.** Inde
28c0: 78 20 62 74 72 65 65 73 20 28 75 73 65 64 20 66  x btrees (used f
28d0: 6f 72 20 69 6e 64 65 78 65 73 20 61 6e 64 20 61  or indexes and a
28e0: 6c 73 6f 20 57 49 54 48 4f 55 54 20 52 4f 57 49  lso WITHOUT ROWI
28f0: 44 20 74 61 62 6c 65 73 29 20 63 6f 6e 74 61 69  D tables) contai
2900: 6e 0a 2a 2a 20 61 6e 20 61 72 62 69 74 72 61 72  n.** an arbitrar
2910: 79 20 6b 65 79 20 61 6e 64 20 6e 6f 20 64 61 74  y key and no dat
2920: 61 2e 20 20 54 68 65 73 65 20 62 74 72 65 65 73  a.  These btrees
2930: 20 68 61 76 65 20 70 4b 65 79 2c 6e 4b 65 79 20   have pKey,nKey 
2940: 73 65 74 20 74 6f 20 74 68 65 69 72 0a 2a 2a 20  set to their.** 
2950: 6b 65 79 20 61 6e 64 20 70 44 61 74 61 2c 6e 44  key and pData,nD
2960: 61 74 61 2c 6e 5a 65 72 6f 20 73 65 74 20 74 6f  ata,nZero set to
2970: 20 7a 65 72 6f 2e 0a 2a 2a 0a 2a 2a 20 54 61 62   zero..**.** Tab
2980: 6c 65 20 62 74 72 65 65 73 20 28 75 73 65 64 20  le btrees (used 
2990: 66 6f 72 20 72 6f 77 69 64 20 74 61 62 6c 65 73  for rowid tables
29a0: 29 20 63 6f 6e 74 61 69 6e 20 61 6e 20 69 6e 74  ) contain an int
29b0: 65 67 65 72 20 72 6f 77 69 64 20 75 73 65 64 20  eger rowid used 
29c0: 61 73 0a 2a 2a 20 74 68 65 20 6b 65 79 20 61 6e  as.** the key an
29d0: 64 20 70 61 73 73 65 64 20 69 6e 20 74 68 65 20  d passed in the 
29e0: 6e 4b 65 79 20 66 69 65 6c 64 2e 20 20 54 68 65  nKey field.  The
29f0: 20 70 4b 65 79 20 66 69 65 6c 64 20 69 73 20 7a   pKey field is z
2a00: 65 72 6f 2e 20 20 0a 2a 2a 20 70 44 61 74 61 2c  ero.  .** pData,
2a10: 6e 44 61 74 61 20 68 6f 6c 64 20 74 68 65 20 63  nData hold the c
2a20: 6f 6e 74 65 6e 74 20 6f 66 20 74 68 65 20 6e 65  ontent of the ne
2a30: 77 20 65 6e 74 72 79 2e 20 20 6e 5a 65 72 6f 20  w entry.  nZero 
2a40: 65 78 74 72 61 20 7a 65 72 6f 20 62 79 74 65 73  extra zero bytes
2a50: 0a 2a 2a 20 61 72 65 20 61 70 70 65 6e 64 65 64  .** are appended
2a60: 20 74 6f 20 74 68 65 20 65 6e 64 20 6f 66 20 74   to the end of t
2a70: 68 65 20 63 6f 6e 74 65 6e 74 20 77 68 65 6e 20  he content when 
2a80: 63 6f 6e 73 74 72 75 63 74 69 6e 67 20 74 68 65  constructing the
2a90: 20 65 6e 74 72 79 2e 0a 2a 2a 0a 2a 2a 20 54 68   entry..**.** Th
2aa0: 69 73 20 6f 62 6a 65 63 74 20 69 73 20 75 73 65  is object is use
2ab0: 64 20 74 6f 20 70 61 73 73 20 69 6e 66 6f 72 6d  d to pass inform
2ac0: 61 74 69 6f 6e 20 69 6e 74 6f 20 73 71 6c 69 74  ation into sqlit
2ad0: 65 33 42 74 72 65 65 49 6e 73 65 72 74 28 29 2e  e3BtreeInsert().
2ae0: 20 20 54 68 65 0a 2a 2a 20 73 61 6d 65 20 69 6e    The.** same in
2af0: 66 6f 72 6d 61 74 69 6f 6e 20 75 73 65 64 20 74  formation used t
2b00: 6f 20 62 65 20 70 61 73 73 65 64 20 61 73 20 66  o be passed as f
2b10: 69 76 65 20 73 65 70 61 72 61 74 65 20 70 61 72  ive separate par
2b20: 61 6d 65 74 65 72 73 2e 20 20 42 75 74 20 70 6c  ameters.  But pl
2b30: 61 63 69 6e 67 0a 2a 2a 20 74 68 65 20 69 6e 66  acing.** the inf
2b40: 6f 72 6d 61 74 69 6f 6e 20 69 6e 74 6f 20 74 68  ormation into th
2b50: 69 73 20 6f 62 6a 65 63 74 20 68 65 6c 70 73 20  is object helps 
2b60: 74 6f 20 6b 65 65 70 20 74 68 65 20 69 6e 74 65  to keep the inte
2b70: 72 66 61 63 65 20 6d 6f 72 65 20 0a 2a 2a 20 6f  rface more .** o
2b80: 72 67 61 6e 69 7a 65 64 20 61 6e 64 20 75 6e 64  rganized and und
2b90: 65 72 73 74 61 6e 64 61 62 6c 65 2c 20 61 6e 64  erstandable, and
2ba0: 20 69 74 20 61 6c 73 6f 20 68 65 6c 70 73 20 74   it also helps t
2bb0: 68 65 20 72 65 73 75 6c 74 69 6e 67 20 63 6f 64  he resulting cod
2bc0: 65 20 74 6f 0a 2a 2a 20 72 75 6e 20 61 20 6c 69  e to.** run a li
2bd0: 74 74 6c 65 20 66 61 73 74 65 72 20 62 79 20 75  ttle faster by u
2be0: 73 69 6e 67 20 66 65 77 65 72 20 72 65 67 69 73  sing fewer regis
2bf0: 74 65 72 73 20 66 6f 72 20 70 61 72 61 6d 65 74  ters for paramet
2c00: 65 72 20 70 61 73 73 69 6e 67 2e 0a 2a 2f 0a 73  er passing..*/.s
2c10: 74 72 75 63 74 20 42 74 72 65 65 50 61 79 6c 6f  truct BtreePaylo
2c20: 61 64 20 7b 0a 20 20 63 6f 6e 73 74 20 76 6f 69  ad {.  const voi
2c30: 64 20 2a 70 4b 65 79 3b 20 20 20 20 20 20 20 2f  d *pKey;       /
2c40: 2a 20 4b 65 79 20 63 6f 6e 74 65 6e 74 20 66 6f  * Key content fo
2c50: 72 20 69 6e 64 65 78 65 73 2e 20 20 4e 55 4c 4c  r indexes.  NULL
2c60: 20 66 6f 72 20 74 61 62 6c 65 73 20 2a 2f 0a 20   for tables */. 
2c70: 20 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 20 6e   sqlite3_int64 n
2c80: 4b 65 79 3b 20 20 20 20 20 2f 2a 20 53 69 7a 65  Key;     /* Size
2c90: 20 6f 66 20 70 4b 65 79 20 66 6f 72 20 69 6e 64   of pKey for ind
2ca0: 65 78 65 73 2e 20 20 50 52 49 4d 41 52 59 20 4b  exes.  PRIMARY K
2cb0: 45 59 20 66 6f 72 20 74 61 62 73 20 2a 2f 0a 20  EY for tabs */. 
2cc0: 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a 70 44 61   const void *pDa
2cd0: 74 61 3b 20 20 20 20 20 20 2f 2a 20 44 61 74 61  ta;      /* Data
2ce0: 20 66 6f 72 20 74 61 62 6c 65 73 2e 20 20 4e 55   for tables.  NU
2cf0: 4c 4c 20 66 6f 72 20 69 6e 64 65 78 65 73 20 2a  LL for indexes *
2d00: 2f 0a 20 20 69 6e 74 20 6e 44 61 74 61 3b 20 20  /.  int nData;  
2d10: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 53              /* S
2d20: 69 7a 65 20 6f 66 20 70 44 61 74 61 2e 20 20 30  ize of pData.  0
2d30: 20 69 66 20 6e 6f 6e 65 2e 20 2a 2f 0a 20 20 69   if none. */.  i
2d40: 6e 74 20 6e 5a 65 72 6f 3b 20 20 20 20 20 20 20  nt nZero;       
2d50: 20 20 20 20 20 20 20 2f 2a 20 45 78 74 72 61 20         /* Extra 
2d60: 7a 65 72 6f 20 64 61 74 61 20 61 70 70 65 6e 64  zero data append
2d70: 65 64 20 61 66 74 65 72 20 70 44 61 74 61 2c 6e  ed after pData,n
2d80: 44 61 74 61 20 2a 2f 0a 7d 3b 0a 0a 69 6e 74 20  Data */.};..int 
2d90: 73 71 6c 69 74 65 33 42 74 72 65 65 49 6e 73 65  sqlite3BtreeInse
2da0: 72 74 28 42 74 43 75 72 73 6f 72 2a 2c 20 63 6f  rt(BtCursor*, co
2db0: 6e 73 74 20 42 74 72 65 65 50 61 79 6c 6f 61 64  nst BtreePayload
2dc0: 20 2a 70 50 61 79 6c 6f 61 64 2c 0a 20 20 20 20   *pPayload,.    
2dd0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2de0: 20 20 20 69 6e 74 20 62 69 61 73 2c 20 69 6e 74     int bias, int
2df0: 20 73 65 65 6b 52 65 73 75 6c 74 29 3b 0a 69 6e   seekResult);.in
2e00: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 46 69  t sqlite3BtreeFi
2e10: 72 73 74 28 42 74 43 75 72 73 6f 72 2a 2c 20 69  rst(BtCursor*, i
2e20: 6e 74 20 2a 70 52 65 73 29 3b 0a 69 6e 74 20 73  nt *pRes);.int s
2e30: 71 6c 69 74 65 33 42 74 72 65 65 4c 61 73 74 28  qlite3BtreeLast(
2e40: 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e 74 20 2a  BtCursor*, int *
2e50: 70 52 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69 74  pRes);.int sqlit
2e60: 65 33 42 74 72 65 65 4e 65 78 74 28 42 74 43 75  e3BtreeNext(BtCu
2e70: 72 73 6f 72 2a 2c 20 69 6e 74 20 2a 70 52 65 73  rsor*, int *pRes
2e80: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
2e90: 72 65 65 45 6f 66 28 42 74 43 75 72 73 6f 72 2a  reeEof(BtCursor*
2ea0: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
2eb0: 72 65 65 50 72 65 76 69 6f 75 73 28 42 74 43 75  reePrevious(BtCu
2ec0: 72 73 6f 72 2a 2c 20 69 6e 74 20 2a 70 52 65 73  rsor*, int *pRes
2ed0: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
2ee0: 72 65 65 4b 65 79 53 69 7a 65 28 42 74 43 75 72  reeKeySize(BtCur
2ef0: 73 6f 72 2a 2c 20 69 36 34 20 2a 70 53 69 7a 65  sor*, i64 *pSize
2f00: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
2f10: 72 65 65 4b 65 79 28 42 74 43 75 72 73 6f 72 2a  reeKey(BtCursor*
2f20: 2c 20 75 33 32 20 6f 66 66 73 65 74 2c 20 75 33  , u32 offset, u3
2f30: 32 20 61 6d 74 2c 20 76 6f 69 64 2a 29 3b 0a 63  2 amt, void*);.c
2f40: 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c 69 74  onst void *sqlit
2f50: 65 33 42 74 72 65 65 4b 65 79 46 65 74 63 68 28  e3BtreeKeyFetch(
2f60: 42 74 43 75 72 73 6f 72 2a 2c 20 75 33 32 20 2a  BtCursor*, u32 *
2f70: 70 41 6d 74 29 3b 0a 63 6f 6e 73 74 20 76 6f 69  pAmt);.const voi
2f80: 64 20 2a 73 71 6c 69 74 65 33 42 74 72 65 65 44  d *sqlite3BtreeD
2f90: 61 74 61 46 65 74 63 68 28 42 74 43 75 72 73 6f  ataFetch(BtCurso
2fa0: 72 2a 2c 20 75 33 32 20 2a 70 41 6d 74 29 3b 0a  r*, u32 *pAmt);.
2fb0: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
2fc0: 44 61 74 61 53 69 7a 65 28 42 74 43 75 72 73 6f  DataSize(BtCurso
2fd0: 72 2a 2c 20 75 33 32 20 2a 70 53 69 7a 65 29 3b  r*, u32 *pSize);
2fe0: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65  .int sqlite3Btre
2ff0: 65 44 61 74 61 28 42 74 43 75 72 73 6f 72 2a 2c  eData(BtCursor*,
3000: 20 75 33 32 20 6f 66 66 73 65 74 2c 20 75 33 32   u32 offset, u32
3010: 20 61 6d 74 2c 20 76 6f 69 64 2a 29 3b 0a 0a 63   amt, void*);..c
3020: 68 61 72 20 2a 73 71 6c 69 74 65 33 42 74 72 65  har *sqlite3Btre
3030: 65 49 6e 74 65 67 72 69 74 79 43 68 65 63 6b 28  eIntegrityCheck(
3040: 42 74 72 65 65 2a 2c 20 69 6e 74 20 2a 61 52 6f  Btree*, int *aRo
3050: 6f 74 2c 20 69 6e 74 20 6e 52 6f 6f 74 2c 20 69  ot, int nRoot, i
3060: 6e 74 2c 20 69 6e 74 2a 29 3b 0a 73 74 72 75 63  nt, int*);.struc
3070: 74 20 50 61 67 65 72 20 2a 73 71 6c 69 74 65 33  t Pager *sqlite3
3080: 42 74 72 65 65 50 61 67 65 72 28 42 74 72 65 65  BtreePager(Btree
3090: 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33  *);..int sqlite3
30a0: 42 74 72 65 65 50 75 74 44 61 74 61 28 42 74 43  BtreePutData(BtC
30b0: 75 72 73 6f 72 2a 2c 20 75 33 32 20 6f 66 66 73  ursor*, u32 offs
30c0: 65 74 2c 20 75 33 32 20 61 6d 74 2c 20 76 6f 69  et, u32 amt, voi
30d0: 64 2a 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65  d*);.void sqlite
30e0: 33 42 74 72 65 65 49 6e 63 72 62 6c 6f 62 43 75  3BtreeIncrblobCu
30f0: 72 73 6f 72 28 42 74 43 75 72 73 6f 72 20 2a 29  rsor(BtCursor *)
3100: 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 42 74  ;.void sqlite3Bt
3110: 72 65 65 43 6c 65 61 72 43 75 72 73 6f 72 28 42  reeClearCursor(B
3120: 74 43 75 72 73 6f 72 20 2a 29 3b 0a 69 6e 74 20  tCursor *);.int 
3130: 73 71 6c 69 74 65 33 42 74 72 65 65 53 65 74 56  sqlite3BtreeSetV
3140: 65 72 73 69 6f 6e 28 42 74 72 65 65 20 2a 70 42  ersion(Btree *pB
3150: 74 2c 20 69 6e 74 20 69 56 65 72 73 69 6f 6e 29  t, int iVersion)
3160: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72  ;.int sqlite3Btr
3170: 65 65 43 75 72 73 6f 72 48 61 73 48 69 6e 74 28  eeCursorHasHint(
3180: 42 74 43 75 72 73 6f 72 2a 2c 20 75 6e 73 69 67  BtCursor*, unsig
3190: 6e 65 64 20 69 6e 74 20 6d 61 73 6b 29 3b 0a 69  ned int mask);.i
31a0: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 49  nt sqlite3BtreeI
31b0: 73 52 65 61 64 6f 6e 6c 79 28 42 74 72 65 65 20  sReadonly(Btree 
31c0: 2a 70 42 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74  *pBt);.int sqlit
31d0: 65 33 48 65 61 64 65 72 53 69 7a 65 42 74 72 65  e3HeaderSizeBtre
31e0: 65 28 76 6f 69 64 29 3b 0a 0a 23 69 66 6e 64 65  e(void);..#ifnde
31f0: 66 20 4e 44 45 42 55 47 0a 69 6e 74 20 73 71 6c  f NDEBUG.int sql
3200: 69 74 65 33 42 74 72 65 65 43 75 72 73 6f 72 49  ite3BtreeCursorI
3210: 73 56 61 6c 69 64 28 42 74 43 75 72 73 6f 72 2a  sValid(BtCursor*
3220: 29 3b 0a 23 65 6e 64 69 66 0a 0a 23 69 66 6e 64  );.#endif..#ifnd
3230: 65 66 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 42  ef SQLITE_OMIT_B
3240: 54 52 45 45 43 4f 55 4e 54 0a 69 6e 74 20 73 71  TREECOUNT.int sq
3250: 6c 69 74 65 33 42 74 72 65 65 43 6f 75 6e 74 28  lite3BtreeCount(
3260: 42 74 43 75 72 73 6f 72 20 2a 2c 20 69 36 34 20  BtCursor *, i64 
3270: 2a 29 3b 0a 23 65 6e 64 69 66 0a 0a 23 69 66 64  *);.#endif..#ifd
3280: 65 66 20 53 51 4c 49 54 45 5f 54 45 53 54 0a 69  ef SQLITE_TEST.i
3290: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 43  nt sqlite3BtreeC
32a0: 75 72 73 6f 72 49 6e 66 6f 28 42 74 43 75 72 73  ursorInfo(BtCurs
32b0: 6f 72 2a 2c 20 69 6e 74 2a 2c 20 69 6e 74 29 3b  or*, int*, int);
32c0: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 42 74 72  .void sqlite3Btr
32d0: 65 65 43 75 72 73 6f 72 4c 69 73 74 28 42 74 72  eeCursorList(Btr
32e0: 65 65 2a 29 3b 0a 23 65 6e 64 69 66 0a 0a 23 69  ee*);.#endif..#i
32f0: 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f 4d 49  fndef SQLITE_OMI
3300: 54 5f 57 41 4c 0a 20 20 69 6e 74 20 73 71 6c 69  T_WAL.  int sqli
3310: 74 65 33 42 74 72 65 65 43 68 65 63 6b 70 6f 69  te3BtreeCheckpoi
3320: 6e 74 28 42 74 72 65 65 2a 2c 20 69 6e 74 2c 20  nt(Btree*, int, 
3330: 69 6e 74 20 2a 2c 20 69 6e 74 20 2a 29 3b 0a 23  int *, int *);.#
3340: 65 6e 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 49 66 20  endif../*.** If 
3350: 77 65 20 61 72 65 20 6e 6f 74 20 75 73 69 6e 67  we are not using
3360: 20 73 68 61 72 65 64 20 63 61 63 68 65 2c 20 74   shared cache, t
3370: 68 65 6e 20 74 68 65 72 65 20 69 73 20 6e 6f 20  hen there is no 
3380: 6e 65 65 64 20 74 6f 0a 2a 2a 20 75 73 65 20 6d  need to.** use m
3390: 75 74 65 78 65 73 20 74 6f 20 61 63 63 65 73 73  utexes to access
33a0: 20 74 68 65 20 42 74 53 68 61 72 65 64 20 73 74   the BtShared st
33b0: 72 75 63 74 75 72 65 73 2e 20 20 53 6f 20 6d 61  ructures.  So ma
33c0: 6b 65 20 74 68 65 0a 2a 2a 20 45 6e 74 65 72 20  ke the.** Enter 
33d0: 61 6e 64 20 4c 65 61 76 65 20 70 72 6f 63 65 64  and Leave proced
33e0: 75 72 65 73 20 6e 6f 2d 6f 70 73 2e 0a 2a 2f 0a  ures no-ops..*/.
33f0: 23 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 4f  #ifndef SQLITE_O
3400: 4d 49 54 5f 53 48 41 52 45 44 5f 43 41 43 48 45  MIT_SHARED_CACHE
3410: 0a 20 20 76 6f 69 64 20 73 71 6c 69 74 65 33 42  .  void sqlite3B
3420: 74 72 65 65 45 6e 74 65 72 28 42 74 72 65 65 2a  treeEnter(Btree*
3430: 29 3b 0a 20 20 76 6f 69 64 20 73 71 6c 69 74 65  );.  void sqlite
3440: 33 42 74 72 65 65 45 6e 74 65 72 41 6c 6c 28 73  3BtreeEnterAll(s
3450: 71 6c 69 74 65 33 2a 29 3b 0a 20 20 69 6e 74 20  qlite3*);.  int 
3460: 73 71 6c 69 74 65 33 42 74 72 65 65 53 68 61 72  sqlite3BtreeShar
3470: 61 62 6c 65 28 42 74 72 65 65 2a 29 3b 0a 20 20  able(Btree*);.  
3480: 76 6f 69 64 20 73 71 6c 69 74 65 33 42 74 72 65  void sqlite3Btre
3490: 65 45 6e 74 65 72 43 75 72 73 6f 72 28 42 74 43  eEnterCursor(BtC
34a0: 75 72 73 6f 72 2a 29 3b 0a 23 65 6c 73 65 0a 23  ursor*);.#else.#
34b0: 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 42   define sqlite3B
34c0: 74 72 65 65 45 6e 74 65 72 28 58 29 20 0a 23 20  treeEnter(X) .# 
34d0: 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 42 74  define sqlite3Bt
34e0: 72 65 65 45 6e 74 65 72 41 6c 6c 28 58 29 0a 23  reeEnterAll(X).#
34f0: 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 42   define sqlite3B
3500: 74 72 65 65 53 68 61 72 61 62 6c 65 28 58 29 20  treeSharable(X) 
3510: 30 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74  0.# define sqlit
3520: 65 33 42 74 72 65 65 45 6e 74 65 72 43 75 72 73  e3BtreeEnterCurs
3530: 6f 72 28 58 29 0a 23 65 6e 64 69 66 0a 0a 23 69  or(X).#endif..#i
3540: 66 20 21 64 65 66 69 6e 65 64 28 53 51 4c 49 54  f !defined(SQLIT
3550: 45 5f 4f 4d 49 54 5f 53 48 41 52 45 44 5f 43 41  E_OMIT_SHARED_CA
3560: 43 48 45 29 20 26 26 20 53 51 4c 49 54 45 5f 54  CHE) && SQLITE_T
3570: 48 52 45 41 44 53 41 46 45 0a 20 20 76 6f 69 64  HREADSAFE.  void
3580: 20 73 71 6c 69 74 65 33 42 74 72 65 65 4c 65 61   sqlite3BtreeLea
3590: 76 65 28 42 74 72 65 65 2a 29 3b 0a 20 20 76 6f  ve(Btree*);.  vo
35a0: 69 64 20 73 71 6c 69 74 65 33 42 74 72 65 65 4c  id sqlite3BtreeL
35b0: 65 61 76 65 43 75 72 73 6f 72 28 42 74 43 75 72  eaveCursor(BtCur
35c0: 73 6f 72 2a 29 3b 0a 20 20 76 6f 69 64 20 73 71  sor*);.  void sq
35d0: 6c 69 74 65 33 42 74 72 65 65 4c 65 61 76 65 41  lite3BtreeLeaveA
35e0: 6c 6c 28 73 71 6c 69 74 65 33 2a 29 3b 0a 23 69  ll(sqlite3*);.#i
35f0: 66 6e 64 65 66 20 4e 44 45 42 55 47 0a 20 20 2f  fndef NDEBUG.  /
3600: 2a 20 54 68 65 73 65 20 72 6f 75 74 69 6e 65 73  * These routines
3610: 20 61 72 65 20 75 73 65 64 20 69 6e 73 69 64 65   are used inside
3620: 20 61 73 73 65 72 74 28 29 20 73 74 61 74 65 6d   assert() statem
3630: 65 6e 74 73 20 6f 6e 6c 79 2e 20 2a 2f 0a 20 20  ents only. */.  
3640: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
3650: 48 6f 6c 64 73 4d 75 74 65 78 28 42 74 72 65 65  HoldsMutex(Btree
3660: 2a 29 3b 0a 20 20 69 6e 74 20 73 71 6c 69 74 65  *);.  int sqlite
3670: 33 42 74 72 65 65 48 6f 6c 64 73 41 6c 6c 4d 75  3BtreeHoldsAllMu
3680: 74 65 78 65 73 28 73 71 6c 69 74 65 33 2a 29 3b  texes(sqlite3*);
3690: 0a 20 20 69 6e 74 20 73 71 6c 69 74 65 33 53 63  .  int sqlite3Sc
36a0: 68 65 6d 61 4d 75 74 65 78 48 65 6c 64 28 73 71  hemaMutexHeld(sq
36b0: 6c 69 74 65 33 2a 2c 69 6e 74 2c 53 63 68 65 6d  lite3*,int,Schem
36c0: 61 2a 29 3b 0a 23 65 6e 64 69 66 0a 23 65 6c 73  a*);.#endif.#els
36d0: 65 0a 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69  e..# define sqli
36e0: 74 65 33 42 74 72 65 65 4c 65 61 76 65 28 58 29  te3BtreeLeave(X)
36f0: 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65  .# define sqlite
3700: 33 42 74 72 65 65 4c 65 61 76 65 43 75 72 73 6f  3BtreeLeaveCurso
3710: 72 28 58 29 0a 23 20 64 65 66 69 6e 65 20 73 71  r(X).# define sq
3720: 6c 69 74 65 33 42 74 72 65 65 4c 65 61 76 65 41  lite3BtreeLeaveA
3730: 6c 6c 28 58 29 0a 0a 23 20 64 65 66 69 6e 65 20  ll(X)..# define 
3740: 73 71 6c 69 74 65 33 42 74 72 65 65 48 6f 6c 64  sqlite3BtreeHold
3750: 73 4d 75 74 65 78 28 58 29 20 31 0a 23 20 64 65  sMutex(X) 1.# de
3760: 66 69 6e 65 20 73 71 6c 69 74 65 33 42 74 72 65  fine sqlite3Btre
3770: 65 48 6f 6c 64 73 41 6c 6c 4d 75 74 65 78 65 73  eHoldsAllMutexes
3780: 28 58 29 20 31 0a 23 20 64 65 66 69 6e 65 20 73  (X) 1.# define s
3790: 71 6c 69 74 65 33 53 63 68 65 6d 61 4d 75 74 65  qlite3SchemaMute
37a0: 78 48 65 6c 64 28 58 2c 59 2c 5a 29 20 31 0a 23  xHeld(X,Y,Z) 1.#
37b0: 65 6e 64 69 66 0a 0a 0a 23 65 6e 64 69 66 20 2f  endif...#endif /
37c0: 2a 20 5f 42 54 52 45 45 5f 48 5f 20 2a 2f 0a     * _BTREE_H_ */.