/ Hex Artifact Content
Login

Artifact 248919b5863d041e3931702f922bae62cf613004:


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 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33  d;...int sqlite3
0520: 42 74 72 65 65 4f 70 65 6e 28 0a 20 20 73 71 6c  BtreeOpen(.  sql
0530: 69 74 65 33 5f 76 66 73 20 2a 70 56 66 73 2c 20  ite3_vfs *pVfs, 
0540: 20 20 20 20 20 20 2f 2a 20 56 46 53 20 74 6f 20        /* VFS to 
0550: 75 73 65 20 77 69 74 68 20 74 68 69 73 20 62 2d  use with this b-
0560: 74 72 65 65 20 2a 2f 0a 20 20 63 6f 6e 73 74 20  tree */.  const 
0570: 63 68 61 72 20 2a 7a 46 69 6c 65 6e 61 6d 65 2c  char *zFilename,
0580: 20 20 20 2f 2a 20 4e 61 6d 65 20 6f 66 20 64 61     /* Name of da
0590: 74 61 62 61 73 65 20 66 69 6c 65 20 74 6f 20 6f  tabase file to o
05a0: 70 65 6e 20 2a 2f 0a 20 20 73 71 6c 69 74 65 33  pen */.  sqlite3
05b0: 20 2a 64 62 2c 20 20 20 20 20 20 20 20 20 20 20   *db,           
05c0: 20 20 2f 2a 20 41 73 73 6f 63 69 61 74 65 64 20    /* Associated 
05d0: 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74  database connect
05e0: 69 6f 6e 20 2a 2f 0a 20 20 42 74 72 65 65 20 2a  ion */.  Btree *
05f0: 2a 70 70 42 74 72 65 65 2c 20 20 20 20 20 20 20  *ppBtree,       
0600: 20 20 2f 2a 20 52 65 74 75 72 6e 20 6f 70 65 6e    /* Return open
0610: 20 42 74 72 65 65 2a 20 68 65 72 65 20 2a 2f 0a   Btree* here */.
0620: 20 20 69 6e 74 20 66 6c 61 67 73 2c 20 20 20 20    int flags,    
0630: 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 46 6c             /* Fl
0640: 61 67 73 20 2a 2f 0a 20 20 69 6e 74 20 76 66 73  ags */.  int vfs
0650: 46 6c 61 67 73 20 20 20 20 20 20 20 20 20 20 20  Flags           
0660: 20 20 2f 2a 20 46 6c 61 67 73 20 70 61 73 73 65    /* Flags passe
0670: 64 20 74 68 72 6f 75 67 68 20 74 6f 20 56 46 53  d through to VFS
0680: 20 6f 70 65 6e 20 2a 2f 0a 29 3b 0a 0a 2f 2a 20   open */.);../* 
0690: 54 68 65 20 66 6c 61 67 73 20 70 61 72 61 6d 65  The flags parame
06a0: 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33 42 74  ter to sqlite3Bt
06b0: 72 65 65 4f 70 65 6e 20 63 61 6e 20 62 65 20 74  reeOpen can be t
06c0: 68 65 20 62 69 74 77 69 73 65 20 6f 72 20 6f 66  he bitwise or of
06d0: 20 74 68 65 0a 2a 2a 20 66 6f 6c 6c 6f 77 69 6e   the.** followin
06e0: 67 20 76 61 6c 75 65 73 2e 0a 2a 2a 0a 2a 2a 20  g values..**.** 
06f0: 4e 4f 54 45 3a 20 20 54 68 65 73 65 20 76 61 6c  NOTE:  These val
0700: 75 65 73 20 6d 75 73 74 20 6d 61 74 63 68 20 74  ues must match t
0710: 68 65 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67  he corresponding
0720: 20 50 41 47 45 52 5f 20 76 61 6c 75 65 73 20 69   PAGER_ values i
0730: 6e 0a 2a 2a 20 70 61 67 65 72 2e 68 2e 0a 2a 2f  n.** pager.h..*/
0740: 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f 4f  .#define BTREE_O
0750: 4d 49 54 5f 4a 4f 55 52 4e 41 4c 20 20 31 20 20  MIT_JOURNAL  1  
0760: 2f 2a 20 44 6f 20 6e 6f 74 20 63 72 65 61 74 65  /* Do not create
0770: 20 6f 72 20 75 73 65 20 61 20 72 6f 6c 6c 62 61   or use a rollba
0780: 63 6b 20 6a 6f 75 72 6e 61 6c 20 2a 2f 0a 23 64  ck journal */.#d
0790: 65 66 69 6e 65 20 42 54 52 45 45 5f 4d 45 4d 4f  efine BTREE_MEMO
07a0: 52 59 20 20 20 20 20 20 20 20 32 20 20 2f 2a 20  RY        2  /* 
07b0: 54 68 69 73 20 69 73 20 61 6e 20 69 6e 2d 6d 65  This is an in-me
07c0: 6d 6f 72 79 20 44 42 20 2a 2f 0a 23 64 65 66 69  mory DB */.#defi
07d0: 6e 65 20 42 54 52 45 45 5f 53 49 4e 47 4c 45 20  ne BTREE_SINGLE 
07e0: 20 20 20 20 20 20 20 34 20 20 2f 2a 20 54 68 65         4  /* The
07f0: 20 66 69 6c 65 20 63 6f 6e 74 61 69 6e 73 20 61   file contains a
0800: 74 20 6d 6f 73 74 20 31 20 62 2d 74 72 65 65 20  t most 1 b-tree 
0810: 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45  */.#define BTREE
0820: 5f 55 4e 4f 52 44 45 52 45 44 20 20 20 20 20 38  _UNORDERED     8
0830: 20 20 2f 2a 20 55 73 65 20 6f 66 20 61 20 68 61    /* Use of a ha
0840: 73 68 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f  sh implementatio
0850: 6e 20 69 73 20 4f 4b 20 2a 2f 0a 0a 69 6e 74 20  n is OK */..int 
0860: 73 71 6c 69 74 65 33 42 74 72 65 65 43 6c 6f 73  sqlite3BtreeClos
0870: 65 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73  e(Btree*);.int s
0880: 71 6c 69 74 65 33 42 74 72 65 65 53 65 74 43 61  qlite3BtreeSetCa
0890: 63 68 65 53 69 7a 65 28 42 74 72 65 65 2a 2c 69  cheSize(Btree*,i
08a0: 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  nt);.int sqlite3
08b0: 42 74 72 65 65 53 65 74 53 70 69 6c 6c 53 69 7a  BtreeSetSpillSiz
08c0: 65 28 42 74 72 65 65 2a 2c 69 6e 74 29 3b 0a 23  e(Btree*,int);.#
08d0: 69 66 20 53 51 4c 49 54 45 5f 4d 41 58 5f 4d 4d  if SQLITE_MAX_MM
08e0: 41 50 5f 53 49 5a 45 3e 30 0a 20 20 69 6e 74 20  AP_SIZE>0.  int 
08f0: 73 71 6c 69 74 65 33 42 74 72 65 65 53 65 74 4d  sqlite3BtreeSetM
0900: 6d 61 70 4c 69 6d 69 74 28 42 74 72 65 65 2a 2c  mapLimit(Btree*,
0910: 73 71 6c 69 74 65 33 5f 69 6e 74 36 34 29 3b 0a  sqlite3_int64);.
0920: 23 65 6e 64 69 66 0a 69 6e 74 20 73 71 6c 69 74  #endif.int sqlit
0930: 65 33 42 74 72 65 65 53 65 74 50 61 67 65 72 46  e3BtreeSetPagerF
0940: 6c 61 67 73 28 42 74 72 65 65 2a 2c 75 6e 73 69  lags(Btree*,unsi
0950: 67 6e 65 64 29 3b 0a 69 6e 74 20 73 71 6c 69 74  gned);.int sqlit
0960: 65 33 42 74 72 65 65 53 65 74 50 61 67 65 53 69  e3BtreeSetPageSi
0970: 7a 65 28 42 74 72 65 65 20 2a 70 2c 20 69 6e 74  ze(Btree *p, int
0980: 20 6e 50 61 67 65 73 69 7a 65 2c 20 69 6e 74 20   nPagesize, int 
0990: 6e 52 65 73 65 72 76 65 2c 20 69 6e 74 20 65 46  nReserve, int eF
09a0: 69 78 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  ix);.int sqlite3
09b0: 42 74 72 65 65 47 65 74 50 61 67 65 53 69 7a 65  BtreeGetPageSize
09c0: 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71  (Btree*);.int sq
09d0: 6c 69 74 65 33 42 74 72 65 65 4d 61 78 50 61 67  lite3BtreeMaxPag
09e0: 65 43 6f 75 6e 74 28 42 74 72 65 65 2a 2c 69 6e  eCount(Btree*,in
09f0: 74 29 3b 0a 75 33 32 20 73 71 6c 69 74 65 33 42  t);.u32 sqlite3B
0a00: 74 72 65 65 4c 61 73 74 50 61 67 65 28 42 74 72  treeLastPage(Btr
0a10: 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  ee*);.int sqlite
0a20: 33 42 74 72 65 65 53 65 63 75 72 65 44 65 6c 65  3BtreeSecureDele
0a30: 74 65 28 42 74 72 65 65 2a 2c 69 6e 74 29 3b 0a  te(Btree*,int);.
0a40: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
0a50: 47 65 74 4f 70 74 69 6d 61 6c 52 65 73 65 72 76  GetOptimalReserv
0a60: 65 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73  e(Btree*);.int s
0a70: 71 6c 69 74 65 33 42 74 72 65 65 47 65 74 52 65  qlite3BtreeGetRe
0a80: 73 65 72 76 65 4e 6f 4d 75 74 65 78 28 42 74 72  serveNoMutex(Btr
0a90: 65 65 20 2a 70 29 3b 0a 69 6e 74 20 73 71 6c 69  ee *p);.int sqli
0aa0: 74 65 33 42 74 72 65 65 53 65 74 41 75 74 6f 56  te3BtreeSetAutoV
0ab0: 61 63 75 75 6d 28 42 74 72 65 65 20 2a 2c 20 69  acuum(Btree *, i
0ac0: 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  nt);.int sqlite3
0ad0: 42 74 72 65 65 47 65 74 41 75 74 6f 56 61 63 75  BtreeGetAutoVacu
0ae0: 75 6d 28 42 74 72 65 65 20 2a 29 3b 0a 69 6e 74  um(Btree *);.int
0af0: 20 73 71 6c 69 74 65 33 42 74 72 65 65 42 65 67   sqlite3BtreeBeg
0b00: 69 6e 54 72 61 6e 73 28 42 74 72 65 65 2a 2c 69  inTrans(Btree*,i
0b10: 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  nt);.int sqlite3
0b20: 42 74 72 65 65 43 6f 6d 6d 69 74 50 68 61 73 65  BtreeCommitPhase
0b30: 4f 6e 65 28 42 74 72 65 65 2a 2c 20 63 6f 6e 73  One(Btree*, cons
0b40: 74 20 63 68 61 72 20 2a 7a 4d 61 73 74 65 72 29  t char *zMaster)
0b50: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72  ;.int sqlite3Btr
0b60: 65 65 43 6f 6d 6d 69 74 50 68 61 73 65 54 77 6f  eeCommitPhaseTwo
0b70: 28 42 74 72 65 65 2a 2c 20 69 6e 74 29 3b 0a 69  (Btree*, int);.i
0b80: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 43  nt sqlite3BtreeC
0b90: 6f 6d 6d 69 74 28 42 74 72 65 65 2a 29 3b 0a 69  ommit(Btree*);.i
0ba0: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 52  nt sqlite3BtreeR
0bb0: 6f 6c 6c 62 61 63 6b 28 42 74 72 65 65 2a 2c 69  ollback(Btree*,i
0bc0: 6e 74 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c  nt,int);.int sql
0bd0: 69 74 65 33 42 74 72 65 65 42 65 67 69 6e 53 74  ite3BtreeBeginSt
0be0: 6d 74 28 42 74 72 65 65 2a 2c 69 6e 74 29 3b 0a  mt(Btree*,int);.
0bf0: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
0c00: 43 72 65 61 74 65 54 61 62 6c 65 28 42 74 72 65  CreateTable(Btre
0c10: 65 2a 2c 20 69 6e 74 2a 2c 20 69 6e 74 20 66 6c  e*, int*, int fl
0c20: 61 67 73 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  ags);.int sqlite
0c30: 33 42 74 72 65 65 49 73 49 6e 54 72 61 6e 73 28  3BtreeIsInTrans(
0c40: 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c  Btree*);.int sql
0c50: 69 74 65 33 42 74 72 65 65 49 73 49 6e 52 65 61  ite3BtreeIsInRea
0c60: 64 54 72 61 6e 73 28 42 74 72 65 65 2a 29 3b 0a  dTrans(Btree*);.
0c70: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
0c80: 49 73 49 6e 42 61 63 6b 75 70 28 42 74 72 65 65  IsInBackup(Btree
0c90: 2a 29 3b 0a 76 6f 69 64 20 2a 73 71 6c 69 74 65  *);.void *sqlite
0ca0: 33 42 74 72 65 65 53 63 68 65 6d 61 28 42 74 72  3BtreeSchema(Btr
0cb0: 65 65 20 2a 2c 20 69 6e 74 2c 20 76 6f 69 64 28  ee *, int, void(
0cc0: 2a 29 28 76 6f 69 64 20 2a 29 29 3b 0a 69 6e 74  *)(void *));.int
0cd0: 20 73 71 6c 69 74 65 33 42 74 72 65 65 53 63 68   sqlite3BtreeSch
0ce0: 65 6d 61 4c 6f 63 6b 65 64 28 42 74 72 65 65 20  emaLocked(Btree 
0cf0: 2a 70 42 74 72 65 65 29 3b 0a 69 6e 74 20 73 71  *pBtree);.int sq
0d00: 6c 69 74 65 33 42 74 72 65 65 4c 6f 63 6b 54 61  lite3BtreeLockTa
0d10: 62 6c 65 28 42 74 72 65 65 20 2a 70 42 74 72 65  ble(Btree *pBtre
0d20: 65 2c 20 69 6e 74 20 69 54 61 62 2c 20 75 38 20  e, int iTab, u8 
0d30: 69 73 57 72 69 74 65 4c 6f 63 6b 29 3b 0a 69 6e  isWriteLock);.in
0d40: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 53 61  t sqlite3BtreeSa
0d50: 76 65 70 6f 69 6e 74 28 42 74 72 65 65 20 2a 2c  vepoint(Btree *,
0d60: 20 69 6e 74 2c 20 69 6e 74 29 3b 0a 0a 63 6f 6e   int, int);..con
0d70: 73 74 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33  st char *sqlite3
0d80: 42 74 72 65 65 47 65 74 46 69 6c 65 6e 61 6d 65  BtreeGetFilename
0d90: 28 42 74 72 65 65 20 2a 29 3b 0a 63 6f 6e 73 74  (Btree *);.const
0da0: 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 42 74   char *sqlite3Bt
0db0: 72 65 65 47 65 74 4a 6f 75 72 6e 61 6c 6e 61 6d  reeGetJournalnam
0dc0: 65 28 42 74 72 65 65 20 2a 29 3b 0a 69 6e 74 20  e(Btree *);.int 
0dd0: 73 71 6c 69 74 65 33 42 74 72 65 65 43 6f 70 79  sqlite3BtreeCopy
0de0: 46 69 6c 65 28 42 74 72 65 65 20 2a 2c 20 42 74  File(Btree *, Bt
0df0: 72 65 65 20 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c  ree *);..int sql
0e00: 69 74 65 33 42 74 72 65 65 49 6e 63 72 56 61 63  ite3BtreeIncrVac
0e10: 75 75 6d 28 42 74 72 65 65 20 2a 29 3b 0a 0a 2f  uum(Btree *);../
0e20: 2a 20 54 68 65 20 66 6c 61 67 73 20 70 61 72 61  * The flags para
0e30: 6d 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33  meter to sqlite3
0e40: 42 74 72 65 65 43 72 65 61 74 65 54 61 62 6c 65  BtreeCreateTable
0e50: 20 63 61 6e 20 62 65 20 74 68 65 20 62 69 74 77   can be the bitw
0e60: 69 73 65 20 4f 52 0a 2a 2a 20 6f 66 20 74 68 65  ise OR.** of the
0e70: 20 66 6c 61 67 73 20 73 68 6f 77 6e 20 62 65 6c   flags shown bel
0e80: 6f 77 2e 0a 2a 2a 0a 2a 2a 20 45 76 65 72 79 20  ow..**.** Every 
0e90: 53 51 4c 69 74 65 20 74 61 62 6c 65 20 6d 75 73  SQLite table mus
0ea0: 74 20 68 61 76 65 20 65 69 74 68 65 72 20 42 54  t have either BT
0eb0: 52 45 45 5f 49 4e 54 4b 45 59 20 6f 72 20 42 54  REE_INTKEY or BT
0ec0: 52 45 45 5f 42 4c 4f 42 4b 45 59 20 73 65 74 2e  REE_BLOBKEY set.
0ed0: 0a 2a 2a 20 57 69 74 68 20 42 54 52 45 45 5f 49  .** With BTREE_I
0ee0: 4e 54 4b 45 59 2c 20 74 68 65 20 74 61 62 6c 65  NTKEY, the table
0ef0: 20 6b 65 79 20 69 73 20 61 20 36 34 2d 62 69 74   key is a 64-bit
0f00: 20 69 6e 74 65 67 65 72 20 61 6e 64 20 61 72 62   integer and arb
0f10: 69 74 72 61 72 79 20 64 61 74 61 0a 2a 2a 20 69  itrary data.** i
0f20: 73 20 73 74 6f 72 65 64 20 69 6e 20 74 68 65 20  s stored in the 
0f30: 6c 65 61 76 65 73 2e 20 20 28 42 54 52 45 45 5f  leaves.  (BTREE_
0f40: 49 4e 54 4b 45 59 20 69 73 20 75 73 65 64 20 66  INTKEY is used f
0f50: 6f 72 20 53 51 4c 20 74 61 62 6c 65 73 2e 29 20  or SQL tables.) 
0f60: 20 57 69 74 68 0a 2a 2a 20 42 54 52 45 45 5f 42   With.** BTREE_B
0f70: 4c 4f 42 4b 45 59 2c 20 74 68 65 20 6b 65 79 20  LOBKEY, the key 
0f80: 69 73 20 61 6e 20 61 72 62 69 74 72 61 72 79 20  is an arbitrary 
0f90: 42 4c 4f 42 20 61 6e 64 20 6e 6f 20 63 6f 6e 74  BLOB and no cont
0fa0: 65 6e 74 20 69 73 20 73 74 6f 72 65 64 0a 2a 2a  ent is stored.**
0fb0: 20 61 6e 79 77 68 65 72 65 20 2d 20 74 68 65 20   anywhere - the 
0fc0: 6b 65 79 20 69 73 20 74 68 65 20 63 6f 6e 74 65  key is the conte
0fd0: 6e 74 2e 20 20 28 42 54 52 45 45 5f 42 4c 4f 42  nt.  (BTREE_BLOB
0fe0: 4b 45 59 20 69 73 20 75 73 65 64 20 66 6f 72 20  KEY is used for 
0ff0: 53 51 4c 0a 2a 2a 20 69 6e 64 69 63 65 73 2e 29  SQL.** indices.)
1000: 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52 45  .*/.#define BTRE
1010: 45 5f 49 4e 54 4b 45 59 20 20 20 20 20 31 20 20  E_INTKEY     1  
1020: 20 20 2f 2a 20 54 61 62 6c 65 20 68 61 73 20 6f    /* Table has o
1030: 6e 6c 79 20 36 34 2d 62 69 74 20 73 69 67 6e 65  nly 64-bit signe
1040: 64 20 69 6e 74 65 67 65 72 20 6b 65 79 73 20 2a  d integer keys *
1050: 2f 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f  /.#define BTREE_
1060: 42 4c 4f 42 4b 45 59 20 20 20 20 32 20 20 20 20  BLOBKEY    2    
1070: 2f 2a 20 54 61 62 6c 65 20 68 61 73 20 6b 65 79  /* Table has key
1080: 73 20 6f 6e 6c 79 20 2d 20 6e 6f 20 64 61 74 61  s only - no data
1090: 20 2a 2f 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33   */..int sqlite3
10a0: 42 74 72 65 65 44 72 6f 70 54 61 62 6c 65 28 42  BtreeDropTable(B
10b0: 74 72 65 65 2a 2c 20 69 6e 74 2c 20 69 6e 74 2a  tree*, int, int*
10c0: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
10d0: 72 65 65 43 6c 65 61 72 54 61 62 6c 65 28 42 74  reeClearTable(Bt
10e0: 72 65 65 2a 2c 20 69 6e 74 2c 20 69 6e 74 2a 29  ree*, int, int*)
10f0: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72  ;.int sqlite3Btr
1100: 65 65 43 6c 65 61 72 54 61 62 6c 65 4f 66 43 75  eeClearTableOfCu
1110: 72 73 6f 72 28 42 74 43 75 72 73 6f 72 2a 29 3b  rsor(BtCursor*);
1120: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65  .int sqlite3Btre
1130: 65 54 72 69 70 41 6c 6c 43 75 72 73 6f 72 73 28  eTripAllCursors(
1140: 42 74 72 65 65 2a 2c 20 69 6e 74 2c 20 69 6e 74  Btree*, int, int
1150: 29 3b 0a 0a 76 6f 69 64 20 73 71 6c 69 74 65 33  );..void sqlite3
1160: 42 74 72 65 65 47 65 74 4d 65 74 61 28 42 74 72  BtreeGetMeta(Btr
1170: 65 65 20 2a 70 42 74 72 65 65 2c 20 69 6e 74 20  ee *pBtree, int 
1180: 69 64 78 2c 20 75 33 32 20 2a 70 56 61 6c 75 65  idx, u32 *pValue
1190: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
11a0: 72 65 65 55 70 64 61 74 65 4d 65 74 61 28 42 74  reeUpdateMeta(Bt
11b0: 72 65 65 2a 2c 20 69 6e 74 20 69 64 78 2c 20 75  ree*, int idx, u
11c0: 33 32 20 76 61 6c 75 65 29 3b 0a 0a 69 6e 74 20  32 value);..int 
11d0: 73 71 6c 69 74 65 33 42 74 72 65 65 4e 65 77 44  sqlite3BtreeNewD
11e0: 62 28 42 74 72 65 65 20 2a 70 29 3b 0a 0a 2f 2a  b(Btree *p);../*
11f0: 0a 2a 2a 20 54 68 65 20 73 65 63 6f 6e 64 20 70  .** The second p
1200: 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71 6c 69  arameter to sqli
1210: 74 65 33 42 74 72 65 65 47 65 74 4d 65 74 61 20  te3BtreeGetMeta 
1220: 6f 72 20 73 71 6c 69 74 65 33 42 74 72 65 65 55  or sqlite3BtreeU
1230: 70 64 61 74 65 4d 65 74 61 0a 2a 2a 20 73 68 6f  pdateMeta.** sho
1240: 75 6c 64 20 62 65 20 6f 6e 65 20 6f 66 20 74 68  uld be one of th
1250: 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 76 61 6c 75  e following valu
1260: 65 73 2e 20 54 68 65 20 69 6e 74 65 67 65 72 20  es. The integer 
1270: 76 61 6c 75 65 73 20 61 72 65 20 61 73 73 69 67  values are assig
1280: 6e 65 64 20 0a 2a 2a 20 74 6f 20 63 6f 6e 73 74  ned .** to const
1290: 61 6e 74 73 20 73 6f 20 74 68 61 74 20 74 68 65  ants so that the
12a0: 20 6f 66 66 73 65 74 20 6f 66 20 74 68 65 20 63   offset of the c
12b0: 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20 66 69 65  orresponding fie
12c0: 6c 64 20 69 6e 20 61 6e 0a 2a 2a 20 53 51 4c 69  ld in an.** SQLi
12d0: 74 65 20 64 61 74 61 62 61 73 65 20 68 65 61 64  te database head
12e0: 65 72 20 6d 61 79 20 62 65 20 66 6f 75 6e 64 20  er may be found 
12f0: 75 73 69 6e 67 20 74 68 65 20 66 6f 6c 6c 6f 77  using the follow
1300: 69 6e 67 20 66 6f 72 6d 75 6c 61 3a 0a 2a 2a 0a  ing formula:.**.
1310: 2a 2a 20 20 20 6f 66 66 73 65 74 20 3d 20 33 36  **   offset = 36
1320: 20 2b 20 28 69 64 78 20 2a 20 34 29 0a 2a 2a 0a   + (idx * 4).**.
1330: 2a 2a 20 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20  ** For example, 
1340: 74 68 65 20 66 72 65 65 2d 70 61 67 65 2d 63 6f  the free-page-co
1350: 75 6e 74 20 66 69 65 6c 64 20 69 73 20 6c 6f 63  unt field is loc
1360: 61 74 65 64 20 61 74 20 62 79 74 65 20 6f 66 66  ated at byte off
1370: 73 65 74 20 33 36 20 6f 66 0a 2a 2a 20 74 68 65  set 36 of.** the
1380: 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 20 68   database file h
1390: 65 61 64 65 72 2e 20 54 68 65 20 69 6e 63 72 2d  eader. The incr-
13a0: 76 61 63 75 75 6d 2d 66 6c 61 67 20 66 69 65 6c  vacuum-flag fiel
13b0: 64 20 69 73 20 6c 6f 63 61 74 65 64 20 61 74 0a  d is located at.
13c0: 2a 2a 20 62 79 74 65 20 6f 66 66 73 65 74 20 36  ** byte offset 6
13d0: 34 20 28 3d 3d 20 33 36 2b 34 2a 37 29 2e 0a 2a  4 (== 36+4*7)..*
13e0: 2a 0a 2a 2a 20 54 68 65 20 42 54 52 45 45 5f 44  *.** The BTREE_D
13f0: 41 54 41 5f 56 45 52 53 49 4f 4e 20 76 61 6c 75  ATA_VERSION valu
1400: 65 20 69 73 20 6e 6f 74 20 72 65 61 6c 6c 79 20  e is not really 
1410: 61 20 76 61 6c 75 65 20 73 74 6f 72 65 64 20 69  a value stored i
1420: 6e 20 74 68 65 20 68 65 61 64 65 72 2e 0a 2a 2a  n the header..**
1430: 20 49 74 20 69 73 20 61 20 72 65 61 64 2d 6f 6e   It is a read-on
1440: 6c 79 20 6e 75 6d 62 65 72 20 63 6f 6d 70 75 74  ly number comput
1450: 65 64 20 62 79 20 74 68 65 20 70 61 67 65 72 2e  ed by the pager.
1460: 20 20 42 75 74 20 77 65 20 6d 65 72 67 65 20 69    But we merge i
1470: 74 20 77 69 74 68 0a 2a 2a 20 74 68 65 20 68 65  t with.** the he
1480: 61 64 65 72 20 76 61 6c 75 65 20 61 63 63 65 73  ader value acces
1490: 73 20 72 6f 75 74 69 6e 65 73 20 73 69 6e 63 65  s routines since
14a0: 20 69 74 73 20 61 63 63 65 73 73 20 70 61 74 74   its access patt
14b0: 65 72 6e 20 69 73 20 74 68 65 20 73 61 6d 65 2e  ern is the same.
14c0: 0a 2a 2a 20 43 61 6c 6c 20 69 74 20 61 20 22 76  .** Call it a "v
14d0: 69 72 74 75 61 6c 20 6d 65 74 61 20 76 61 6c 75  irtual meta valu
14e0: 65 22 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 42  e"..*/.#define B
14f0: 54 52 45 45 5f 46 52 45 45 5f 50 41 47 45 5f 43  TREE_FREE_PAGE_C
1500: 4f 55 4e 54 20 20 20 20 20 30 0a 23 64 65 66 69  OUNT     0.#defi
1510: 6e 65 20 42 54 52 45 45 5f 53 43 48 45 4d 41 5f  ne BTREE_SCHEMA_
1520: 56 45 52 53 49 4f 4e 20 20 20 20 20 20 31 0a 23  VERSION      1.#
1530: 64 65 66 69 6e 65 20 42 54 52 45 45 5f 46 49 4c  define BTREE_FIL
1540: 45 5f 46 4f 52 4d 41 54 20 20 20 20 20 20 20 20  E_FORMAT        
1550: 20 32 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45   2.#define BTREE
1560: 5f 44 45 46 41 55 4c 54 5f 43 41 43 48 45 5f 53  _DEFAULT_CACHE_S
1570: 49 5a 45 20 20 33 0a 23 64 65 66 69 6e 65 20 42  IZE  3.#define B
1580: 54 52 45 45 5f 4c 41 52 47 45 53 54 5f 52 4f 4f  TREE_LARGEST_ROO
1590: 54 5f 50 41 47 45 20 20 20 34 0a 23 64 65 66 69  T_PAGE   4.#defi
15a0: 6e 65 20 42 54 52 45 45 5f 54 45 58 54 5f 45 4e  ne BTREE_TEXT_EN
15b0: 43 4f 44 49 4e 47 20 20 20 20 20 20 20 35 0a 23  CODING       5.#
15c0: 64 65 66 69 6e 65 20 42 54 52 45 45 5f 55 53 45  define BTREE_USE
15d0: 52 5f 56 45 52 53 49 4f 4e 20 20 20 20 20 20 20  R_VERSION       
15e0: 20 36 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45   6.#define BTREE
15f0: 5f 49 4e 43 52 5f 56 41 43 55 55 4d 20 20 20 20  _INCR_VACUUM    
1600: 20 20 20 20 20 37 0a 23 64 65 66 69 6e 65 20 42       7.#define B
1610: 54 52 45 45 5f 41 50 50 4c 49 43 41 54 49 4f 4e  TREE_APPLICATION
1620: 5f 49 44 20 20 20 20 20 20 38 0a 23 64 65 66 69  _ID      8.#defi
1630: 6e 65 20 42 54 52 45 45 5f 44 41 54 41 5f 56 45  ne BTREE_DATA_VE
1640: 52 53 49 4f 4e 20 20 20 20 20 20 20 20 31 35 20  RSION        15 
1650: 20 2f 2a 20 41 20 76 69 72 74 75 61 6c 20 6d 65   /* A virtual me
1660: 74 61 2d 76 61 6c 75 65 20 2a 2f 0a 0a 2f 2a 0a  ta-value */../*.
1670: 2a 2a 20 4b 69 6e 64 73 20 6f 66 20 68 69 6e 74  ** Kinds of hint
1680: 73 20 74 68 61 74 20 63 61 6e 20 62 65 20 70 61  s that can be pa
1690: 73 73 65 64 20 69 6e 74 6f 20 74 68 65 20 73 71  ssed into the sq
16a0: 6c 69 74 65 33 42 74 72 65 65 43 75 72 73 6f 72  lite3BtreeCursor
16b0: 48 69 6e 74 28 29 0a 2a 2a 20 69 6e 74 65 72 66  Hint().** interf
16c0: 61 63 65 2e 0a 2a 2a 0a 2a 2a 20 42 54 52 45 45  ace..**.** BTREE
16d0: 5f 48 49 4e 54 5f 52 41 4e 47 45 20 20 28 61 72  _HINT_RANGE  (ar
16e0: 67 75 6d 65 6e 74 73 3a 20 45 78 70 72 2a 2c 20  guments: Expr*, 
16f0: 4d 65 6d 2a 29 0a 2a 2a 0a 2a 2a 20 20 20 20 20  Mem*).**.**     
1700: 54 68 65 20 66 69 72 73 74 20 61 72 67 75 6d 65  The first argume
1710: 6e 74 20 69 73 20 61 6e 20 45 78 70 72 2a 20 28  nt is an Expr* (
1720: 77 68 69 63 68 20 69 73 20 67 75 61 72 61 6e 74  which is guarant
1730: 65 65 64 20 74 6f 20 62 65 20 63 6f 6e 73 74 61  eed to be consta
1740: 6e 74 20 66 6f 72 0a 2a 2a 20 20 20 20 20 74 68  nt for.**     th
1750: 65 20 6c 69 66 65 74 69 6d 65 20 6f 66 20 74 68  e lifetime of th
1760: 65 20 63 75 72 73 6f 72 29 20 74 68 61 74 20 64  e cursor) that d
1770: 65 66 69 6e 65 73 20 63 6f 6e 73 74 72 61 69 6e  efines constrain
1780: 74 73 20 6f 6e 20 77 68 69 63 68 20 72 6f 77 73  ts on which rows
1790: 0a 2a 2a 20 20 20 20 20 6d 69 67 68 74 20 62 65  .**     might be
17a0: 20 66 65 74 63 68 65 64 20 77 69 74 68 20 74 68   fetched with th
17b0: 69 73 20 63 75 72 73 6f 72 2e 20 20 54 68 65 20  is cursor.  The 
17c0: 45 78 70 72 2a 20 74 72 65 65 20 6d 61 79 20 63  Expr* tree may c
17d0: 6f 6e 74 61 69 6e 0a 2a 2a 20 20 20 20 20 54 4b  ontain.**     TK
17e0: 5f 52 45 47 49 53 54 45 52 20 6e 6f 64 65 73 20  _REGISTER nodes 
17f0: 74 68 61 74 20 72 65 66 65 72 20 74 6f 20 76 61  that refer to va
1800: 6c 75 65 73 20 73 74 6f 72 65 64 20 69 6e 20 74  lues stored in t
1810: 68 65 20 61 72 72 61 79 20 6f 66 20 72 65 67 69  he array of regi
1820: 73 74 65 72 73 0a 2a 2a 20 20 20 20 20 70 61 73  sters.**     pas
1830: 73 65 64 20 61 73 20 74 68 65 20 73 65 63 6f 6e  sed as the secon
1840: 64 20 70 61 72 61 6d 65 74 65 72 2e 20 20 49 6e  d parameter.  In
1850: 20 6f 74 68 65 72 20 77 6f 72 64 73 2c 20 69 66   other words, if
1860: 20 45 78 70 72 2e 6f 70 3d 3d 54 4b 5f 52 45 47   Expr.op==TK_REG
1870: 49 53 54 45 52 0a 2a 2a 20 20 20 20 20 74 68 65  ISTER.**     the
1880: 6e 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20 74  n the value of t
1890: 68 65 20 6e 6f 64 65 20 69 73 20 74 68 65 20 76  he node is the v
18a0: 61 6c 75 65 20 69 6e 20 4d 65 6d 5b 70 45 78 70  alue in Mem[pExp
18b0: 72 2e 69 54 61 62 6c 65 5d 2e 20 20 41 6e 79 0a  r.iTable].  Any.
18c0: 2a 2a 20 20 20 20 20 54 4b 5f 43 4f 4c 55 4d 4e  **     TK_COLUMN
18d0: 20 6e 6f 64 65 20 69 6e 20 74 68 65 20 65 78 70   node in the exp
18e0: 72 65 73 73 69 6f 6e 20 74 72 65 65 20 72 65 66  ression tree ref
18f0: 65 72 73 20 74 6f 20 74 68 65 20 45 78 70 72 2e  ers to the Expr.
1900: 69 43 6f 6c 75 6d 6e 2d 74 68 0a 2a 2a 20 20 20  iColumn-th.**   
1910: 20 20 63 6f 6c 75 6d 6e 20 6f 66 20 74 68 65 20    column of the 
1920: 62 2d 74 72 65 65 20 6f 66 20 74 68 65 20 63 75  b-tree of the cu
1930: 72 73 6f 72 2e 20 20 54 68 65 20 45 78 70 72 20  rsor.  The Expr 
1940: 74 72 65 65 20 77 69 6c 6c 20 6e 6f 74 20 63 6f  tree will not co
1950: 6e 74 61 69 6e 0a 2a 2a 20 20 20 20 20 61 6e 79  ntain.**     any
1960: 20 66 75 6e 63 74 69 6f 6e 20 63 61 6c 6c 73 20   function calls 
1970: 6e 6f 72 20 73 75 62 71 75 65 72 69 65 73 20 6e  nor subqueries n
1980: 6f 72 20 72 65 66 65 72 65 6e 63 65 73 20 74 6f  or references to
1990: 20 62 2d 74 72 65 65 73 20 6f 74 68 65 72 20 74   b-trees other t
19a0: 68 61 6e 0a 2a 2a 20 20 20 20 20 74 68 65 20 63  han.**     the c
19b0: 75 72 73 6f 72 20 62 65 69 6e 67 20 68 69 6e 74  ursor being hint
19c0: 65 64 2e 0a 2a 2a 0a 2a 2a 20 20 20 20 20 54 68  ed..**.**     Th
19d0: 65 20 64 65 73 69 67 6e 20 6f 66 20 74 68 65 20  e design of the 
19e0: 5f 52 41 4e 47 45 20 68 69 6e 74 20 69 73 20 61  _RANGE hint is a
19f0: 69 64 20 62 2d 74 72 65 65 20 69 6d 70 6c 65 6d  id b-tree implem
1a00: 65 6e 74 61 74 69 6f 6e 73 20 74 68 61 74 20 74  entations that t
1a10: 72 79 0a 2a 2a 20 20 20 20 20 74 6f 20 70 72 65  ry.**     to pre
1a20: 66 65 74 63 68 20 63 6f 6e 74 65 6e 74 20 66 72  fetch content fr
1a30: 6f 6d 20 72 65 6d 6f 74 65 20 6d 61 63 68 69 6e  om remote machin
1a40: 65 73 20 2d 20 74 6f 20 70 72 6f 76 69 64 65 20  es - to provide 
1a50: 74 68 6f 73 65 0a 2a 2a 20 20 20 20 20 69 6d 70  those.**     imp
1a60: 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20 77 69 74  lementations wit
1a70: 68 20 6c 69 6d 69 74 73 20 6f 6e 20 77 68 61 74  h limits on what
1a80: 20 6e 65 65 64 73 20 74 6f 20 62 65 20 70 72 65   needs to be pre
1a90: 66 65 74 63 68 65 64 20 61 6e 64 20 74 68 65 72  fetched and ther
1aa0: 65 62 79 0a 2a 2a 20 20 20 20 20 72 65 64 75 63  eby.**     reduc
1ab0: 65 20 6e 65 74 77 6f 72 6b 20 62 61 6e 64 77 69  e network bandwi
1ac0: 64 74 68 2e 0a 2a 2a 0a 2a 2a 20 4e 6f 74 65 20  dth..**.** Note 
1ad0: 74 68 61 74 20 42 54 52 45 45 5f 48 49 4e 54 5f  that BTREE_HINT_
1ae0: 46 4c 41 47 53 20 77 69 74 68 20 42 54 52 45 45  FLAGS with BTREE
1af0: 5f 42 55 4c 4b 4c 4f 41 44 20 69 73 20 74 68 65  _BULKLOAD is the
1b00: 20 6f 6e 6c 79 20 68 69 6e 74 20 75 73 65 64 20   only hint used 
1b10: 62 79 0a 2a 2a 20 73 74 61 6e 64 61 72 64 20 53  by.** standard S
1b20: 51 4c 69 74 65 2e 20 20 54 68 65 20 6f 74 68 65  QLite.  The othe
1b30: 72 20 68 69 6e 74 73 20 61 72 65 20 70 72 6f 76  r hints are prov
1b40: 69 64 65 64 20 66 6f 72 20 65 78 74 65 6e 74 69  ided for extenti
1b50: 6f 6e 73 20 74 68 61 74 20 75 73 65 0a 2a 2a 20  ons that use.** 
1b60: 74 68 65 20 53 51 4c 69 74 65 20 70 61 72 73 65  the SQLite parse
1b70: 72 20 61 6e 64 20 63 6f 64 65 20 67 65 6e 65 72  r and code gener
1b80: 61 74 6f 72 20 62 75 74 20 73 75 62 73 74 69 74  ator but substit
1b90: 75 74 65 20 74 68 65 69 72 20 6f 77 6e 20 73 74  ute their own st
1ba0: 6f 72 61 67 65 0a 2a 2a 20 65 6e 67 69 6e 65 2e  orage.** engine.
1bb0: 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52 45  .*/.#define BTRE
1bc0: 45 5f 48 49 4e 54 5f 52 41 4e 47 45 20 30 20 20  E_HINT_RANGE 0  
1bd0: 20 20 20 20 20 2f 2a 20 52 61 6e 67 65 20 63 6f       /* Range co
1be0: 6e 73 74 72 61 69 6e 74 73 20 6f 6e 20 71 75 65  nstraints on que
1bf0: 72 69 65 73 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 56  ries */../*.** V
1c00: 61 6c 75 65 73 20 74 68 61 74 20 6d 61 79 20 62  alues that may b
1c10: 65 20 4f 52 27 64 20 74 6f 67 65 74 68 65 72 20  e OR'd together 
1c20: 74 6f 20 66 6f 72 6d 20 74 68 65 20 61 72 67 75  to form the argu
1c30: 6d 65 6e 74 20 74 6f 20 74 68 65 0a 2a 2a 20 42  ment to the.** B
1c40: 54 52 45 45 5f 48 49 4e 54 5f 46 4c 41 47 53 20  TREE_HINT_FLAGS 
1c50: 68 69 6e 74 20 66 6f 72 20 73 71 6c 69 74 65 33  hint for sqlite3
1c60: 42 74 72 65 65 43 75 72 73 6f 72 48 69 6e 74 28  BtreeCursorHint(
1c70: 29 3a 0a 2a 2a 0a 2a 2a 20 54 68 65 20 42 54 52  ):.**.** The BTR
1c80: 45 45 5f 42 55 4c 4b 4c 4f 41 44 20 66 6c 61 67  EE_BULKLOAD flag
1c90: 20 69 73 20 73 65 74 20 6f 6e 20 69 6e 64 65 78   is set on index
1ca0: 20 63 75 72 73 6f 72 73 20 77 68 65 6e 20 74 68   cursors when th
1cb0: 65 20 69 6e 64 65 78 20 69 73 20 67 6f 69 6e 67  e index is going
1cc0: 0a 2a 2a 20 74 6f 20 62 65 20 66 69 6c 6c 65 64  .** to be filled
1cd0: 20 77 69 74 68 20 63 6f 6e 74 65 6e 74 20 74 68   with content th
1ce0: 61 74 20 69 73 20 61 6c 72 65 61 64 79 20 69 6e  at is already in
1cf0: 20 73 6f 72 74 65 64 20 6f 72 64 65 72 2e 0a 2a   sorted order..*
1d00: 2a 0a 2a 2a 20 54 68 65 20 42 54 52 45 45 5f 53  *.** The BTREE_S
1d10: 45 45 4b 5f 45 51 20 66 6c 61 67 20 69 73 20 73  EEK_EQ flag is s
1d20: 65 74 20 6f 6e 20 63 75 72 73 6f 72 73 20 74 68  et on cursors th
1d30: 61 74 20 77 69 6c 6c 20 67 65 74 20 4f 50 5f 53  at will get OP_S
1d40: 65 65 6b 47 45 20 6f 72 0a 2a 2a 20 4f 50 5f 53  eekGE or.** OP_S
1d50: 65 65 6b 4c 45 20 6f 70 63 6f 64 65 73 20 66 6f  eekLE opcodes fo
1d60: 72 20 61 20 72 61 6e 67 65 20 73 65 61 72 63 68  r a range search
1d70: 2c 20 62 75 74 20 77 68 65 72 65 20 74 68 65 20  , but where the 
1d80: 72 61 6e 67 65 20 6f 66 20 65 6e 74 72 69 65 73  range of entries
1d90: 0a 2a 2a 20 73 65 6c 65 63 74 65 64 20 77 69 6c  .** selected wil
1da0: 6c 20 61 6c 6c 20 68 61 76 65 20 74 68 65 20 73  l all have the s
1db0: 61 6d 65 20 6b 65 79 2e 20 20 49 6e 20 6f 74 68  ame key.  In oth
1dc0: 65 72 20 77 6f 72 64 73 2c 20 74 68 65 20 63 75  er words, the cu
1dd0: 72 73 6f 72 20 77 69 6c 6c 0a 2a 2a 20 62 65 20  rsor will.** be 
1de0: 75 73 65 64 20 6f 6e 6c 79 20 66 6f 72 20 65 71  used only for eq
1df0: 75 61 6c 69 74 79 20 6b 65 79 20 73 65 61 72 63  uality key searc
1e00: 68 65 73 2e 0a 2a 2a 0a 2a 2f 0a 23 64 65 66 69  hes..**.*/.#defi
1e10: 6e 65 20 42 54 52 45 45 5f 42 55 4c 4b 4c 4f 41  ne BTREE_BULKLOA
1e20: 44 20 30 78 30 30 30 30 30 30 30 31 20 20 2f 2a  D 0x00000001  /*
1e30: 20 55 73 65 64 20 74 6f 20 66 75 6c 6c 20 69 6e   Used to full in
1e40: 64 65 78 20 69 6e 20 73 6f 72 74 65 64 20 6f 72  dex in sorted or
1e50: 64 65 72 20 2a 2f 0a 23 64 65 66 69 6e 65 20 42  der */.#define B
1e60: 54 52 45 45 5f 53 45 45 4b 5f 45 51 20 20 30 78  TREE_SEEK_EQ  0x
1e70: 30 30 30 30 30 30 30 32 20 20 2f 2a 20 45 51 20  00000002  /* EQ 
1e80: 73 65 65 6b 73 20 6f 6e 6c 79 20 2d 20 6e 6f 20  seeks only - no 
1e90: 72 61 6e 67 65 20 73 65 65 6b 73 20 2a 2f 0a 0a  range seeks */..
1ea0: 2f 2a 20 0a 2a 2a 20 46 6c 61 67 73 20 70 61 73  /* .** Flags pas
1eb0: 73 65 64 20 61 73 20 74 68 65 20 74 68 69 72 64  sed as the third
1ec0: 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 73 71 6c   argument to sql
1ed0: 69 74 65 33 42 74 72 65 65 43 75 72 73 6f 72 28  ite3BtreeCursor(
1ee0: 29 2e 0a 2a 2a 0a 2a 2a 20 46 6f 72 20 72 65 61  )..**.** For rea
1ef0: 64 2d 6f 6e 6c 79 20 63 75 72 73 6f 72 73 20 74  d-only cursors t
1f00: 68 65 20 77 72 46 6c 61 67 20 61 72 67 75 6d 65  he wrFlag argume
1f10: 6e 74 20 69 73 20 61 6c 77 61 79 73 20 7a 65 72  nt is always zer
1f20: 6f 2e 20 46 6f 72 20 72 65 61 64 2d 77 72 69 74  o. For read-writ
1f30: 65 0a 2a 2a 20 63 75 72 73 6f 72 73 20 69 74 20  e.** cursors it 
1f40: 6d 61 79 20 62 65 20 73 65 74 20 74 6f 20 65 69  may be set to ei
1f50: 74 68 65 72 20 28 42 54 52 45 45 5f 57 52 43 53  ther (BTREE_WRCS
1f60: 52 7c 42 54 52 45 45 5f 46 4f 52 44 45 4c 45 54  R|BTREE_FORDELET
1f70: 45 29 20 6f 72 20 6a 75 73 74 0a 2a 2a 20 28 42  E) or just.** (B
1f80: 54 52 45 45 5f 57 52 43 53 52 29 2e 20 49 66 20  TREE_WRCSR). If 
1f90: 74 68 65 20 42 54 52 45 45 5f 46 4f 52 44 45 4c  the BTREE_FORDEL
1fa0: 45 54 45 20 62 69 74 20 69 73 20 73 65 74 2c 20  ETE bit is set, 
1fb0: 74 68 65 6e 20 74 68 65 20 63 75 72 73 6f 72 20  then the cursor 
1fc0: 77 69 6c 6c 0a 2a 2a 20 6f 6e 6c 79 20 62 65 20  will.** only be 
1fd0: 75 73 65 64 20 62 79 20 53 51 4c 69 74 65 20 66  used by SQLite f
1fe0: 6f 72 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67  or the following
1ff0: 3a 0a 2a 2a 0a 2a 2a 20 20 20 2a 20 74 6f 20 73  :.**.**   * to s
2000: 65 65 6b 20 74 6f 20 61 6e 64 20 74 68 65 6e 20  eek to and then 
2010: 64 65 6c 65 74 65 20 73 70 65 63 69 66 69 63 20  delete specific 
2020: 65 6e 74 72 69 65 73 2c 20 61 6e 64 2f 6f 72 0a  entries, and/or.
2030: 2a 2a 0a 2a 2a 20 20 20 2a 20 74 6f 20 72 65 61  **.**   * to rea
2040: 64 20 76 61 6c 75 65 73 20 74 68 61 74 20 77 69  d values that wi
2050: 6c 6c 20 62 65 20 75 73 65 64 20 74 6f 20 63 72  ll be used to cr
2060: 65 61 74 65 20 6b 65 79 73 20 74 68 61 74 20 6f  eate keys that o
2070: 74 68 65 72 0a 2a 2a 20 20 20 20 20 42 54 52 45  ther.**     BTRE
2080: 45 5f 46 4f 52 44 45 4c 45 54 45 20 63 75 72 73  E_FORDELETE curs
2090: 6f 72 73 20 77 69 6c 6c 20 73 65 65 6b 20 74 6f  ors will seek to
20a0: 20 61 6e 64 20 64 65 6c 65 74 65 2e 0a 2a 2a 0a   and delete..**.
20b0: 2a 2a 20 54 68 65 20 42 54 52 45 45 5f 46 4f 52  ** The BTREE_FOR
20c0: 44 45 4c 45 54 45 20 66 6c 61 67 20 69 73 20 61  DELETE flag is a
20d0: 6e 20 6f 70 74 69 6d 69 7a 61 74 69 6f 6e 20 68  n optimization h
20e0: 69 6e 74 2e 20 20 49 74 20 69 73 20 6e 6f 74 20  int.  It is not 
20f0: 75 73 65 64 20 62 79 0a 2a 2a 20 62 79 20 74 68  used by.** by th
2100: 69 73 2c 20 74 68 65 20 6e 61 74 69 76 65 20 62  is, the native b
2110: 2d 74 72 65 65 20 65 6e 67 69 6e 65 20 6f 66 20  -tree engine of 
2120: 53 51 4c 69 74 65 2c 20 62 75 74 20 69 74 20 69  SQLite, but it i
2130: 73 20 61 76 61 69 6c 61 62 6c 65 20 74 6f 0a 2a  s available to.*
2140: 2a 20 61 6c 74 65 72 6e 61 74 69 76 65 20 73 74  * alternative st
2150: 6f 72 61 67 65 20 65 6e 67 69 6e 65 73 20 74 68  orage engines th
2160: 61 74 20 6d 69 67 68 74 20 62 65 20 73 75 62 73  at might be subs
2170: 74 69 74 75 74 65 64 20 69 6e 20 70 6c 61 63 65  tituted in place
2180: 20 6f 66 20 74 68 69 73 0a 2a 2a 20 62 2d 74 72   of this.** b-tr
2190: 65 65 20 73 79 73 74 65 6d 2e 20 20 46 6f 72 20  ee system.  For 
21a0: 61 6c 74 65 72 6e 61 74 69 76 65 20 73 74 6f 72  alternative stor
21b0: 61 67 65 20 65 6e 67 69 6e 65 73 20 69 6e 20 77  age engines in w
21c0: 68 69 63 68 20 61 20 64 65 6c 65 74 65 20 6f 66  hich a delete of
21d0: 0a 2a 2a 20 74 68 65 20 6d 61 69 6e 20 74 61 62  .** the main tab
21e0: 6c 65 20 72 6f 77 20 61 75 74 6f 6d 61 74 69 63  le row automatic
21f0: 61 6c 6c 79 20 64 65 6c 65 74 65 73 20 63 6f 72  ally deletes cor
2200: 72 65 73 70 6f 6e 64 69 6e 67 20 69 6e 64 65 78  responding index
2210: 20 72 6f 77 73 2c 0a 2a 2a 20 74 68 65 20 46 4f   rows,.** the FO
2220: 52 44 45 4c 45 54 45 20 66 6c 61 67 20 68 69 6e  RDELETE flag hin
2230: 74 20 61 6c 6c 6f 77 73 20 74 68 6f 73 65 20 61  t allows those a
2240: 6c 74 65 72 6e 61 74 69 76 65 20 73 74 6f 72 61  lternative stora
2250: 67 65 20 65 6e 67 69 6e 65 73 20 74 6f 0a 2a 2a  ge engines to.**
2260: 20 73 6b 69 70 20 61 20 6c 6f 74 20 6f 66 20 77   skip a lot of w
2270: 6f 72 6b 2e 20 20 4e 61 6d 65 6c 79 3a 20 20 46  ork.  Namely:  F
2280: 4f 52 44 45 4c 45 54 45 20 63 75 72 73 6f 72 73  ORDELETE cursors
2290: 20 6d 61 79 20 74 72 65 61 74 20 61 6c 6c 20 53   may treat all S
22a0: 45 45 4b 0a 2a 2a 20 61 6e 64 20 44 45 4c 45 54  EEK.** and DELET
22b0: 45 20 6f 70 65 72 61 74 69 6f 6e 73 20 61 73 20  E operations as 
22c0: 6e 6f 2d 6f 70 73 2c 20 61 6e 64 20 61 6e 79 20  no-ops, and any 
22d0: 52 45 41 44 20 6f 70 65 72 61 74 69 6f 6e 20 61  READ operation a
22e0: 67 61 69 6e 73 74 20 61 0a 2a 2a 20 46 4f 52 44  gainst a.** FORD
22f0: 45 4c 45 54 45 20 63 75 72 73 6f 72 20 6d 61 79  ELETE cursor may
2300: 20 72 65 74 75 72 6e 20 61 20 6e 75 6c 6c 20 72   return a null r
2310: 6f 77 3a 20 30 78 30 31 20 30 78 30 30 2e 0a 2a  ow: 0x01 0x00..*
2320: 2f 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f  /.#define BTREE_
2330: 57 52 43 53 52 20 20 20 20 20 30 78 30 30 30 30  WRCSR     0x0000
2340: 30 30 30 34 20 20 20 20 20 2f 2a 20 72 65 61 64  0004     /* read
2350: 2d 77 72 69 74 65 20 63 75 72 73 6f 72 20 2a 2f  -write cursor */
2360: 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f 46  .#define BTREE_F
2370: 4f 52 44 45 4c 45 54 45 20 30 78 30 30 30 30 30  ORDELETE 0x00000
2380: 30 30 38 20 20 20 20 20 2f 2a 20 43 75 72 73 6f  008     /* Curso
2390: 72 20 69 73 20 66 6f 72 20 73 65 65 6b 2f 64 65  r is for seek/de
23a0: 6c 65 74 65 20 6f 6e 6c 79 20 2a 2f 0a 0a 69 6e  lete only */..in
23b0: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 43 75  t sqlite3BtreeCu
23c0: 72 73 6f 72 28 0a 20 20 42 74 72 65 65 2a 2c 20  rsor(.  Btree*, 
23d0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
23e0: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20               /* 
23f0: 42 54 72 65 65 20 63 6f 6e 74 61 69 6e 69 6e 67  BTree containing
2400: 20 74 61 62 6c 65 20 74 6f 20 6f 70 65 6e 20 2a   table to open *
2410: 2f 0a 20 20 69 6e 74 20 69 54 61 62 6c 65 2c 20  /.  int iTable, 
2420: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2430: 20 20 20 20 20 20 20 20 20 2f 2a 20 49 6e 64 65           /* Inde
2440: 78 20 6f 66 20 72 6f 6f 74 20 70 61 67 65 20 2a  x of root page *
2450: 2f 0a 20 20 69 6e 74 20 77 72 46 6c 61 67 2c 20  /.  int wrFlag, 
2460: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2470: 20 20 20 20 20 20 20 20 20 2f 2a 20 31 20 66 6f           /* 1 fo
2480: 72 20 77 72 69 74 69 6e 67 2e 20 20 30 20 66 6f  r writing.  0 fo
2490: 72 20 72 65 61 64 2d 6f 6e 6c 79 20 2a 2f 0a 20  r read-only */. 
24a0: 20 73 74 72 75 63 74 20 4b 65 79 49 6e 66 6f 2a   struct KeyInfo*
24b0: 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ,               
24c0: 20 20 20 20 20 20 2f 2a 20 46 69 72 73 74 20 61        /* First a
24d0: 72 67 75 6d 65 6e 74 20 74 6f 20 63 6f 6d 70 61  rgument to compa
24e0: 72 65 20 66 75 6e 63 74 69 6f 6e 20 2a 2f 0a 20  re function */. 
24f0: 20 42 74 43 75 72 73 6f 72 20 2a 70 43 75 72 73   BtCursor *pCurs
2500: 6f 72 20 20 20 20 20 20 20 20 20 20 20 20 20 20  or              
2510: 20 20 20 20 20 20 2f 2a 20 53 70 61 63 65 20 74        /* Space t
2520: 6f 20 77 72 69 74 65 20 63 75 72 73 6f 72 20 73  o write cursor s
2530: 74 72 75 63 74 75 72 65 20 2a 2f 0a 29 3b 0a 69  tructure */.);.i
2540: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 43  nt sqlite3BtreeC
2550: 75 72 73 6f 72 53 69 7a 65 28 76 6f 69 64 29 3b  ursorSize(void);
2560: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 42 74 72  .void sqlite3Btr
2570: 65 65 43 75 72 73 6f 72 5a 65 72 6f 28 42 74 43  eeCursorZero(BtC
2580: 75 72 73 6f 72 2a 29 3b 0a 76 6f 69 64 20 73 71  ursor*);.void sq
2590: 6c 69 74 65 33 42 74 72 65 65 43 75 72 73 6f 72  lite3BtreeCursor
25a0: 48 69 6e 74 46 6c 61 67 73 28 42 74 43 75 72 73  HintFlags(BtCurs
25b0: 6f 72 2a 2c 20 75 6e 73 69 67 6e 65 64 29 3b 0a  or*, unsigned);.
25c0: 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 45 4e  #ifdef SQLITE_EN
25d0: 41 42 4c 45 5f 43 55 52 53 4f 52 5f 48 49 4e 54  ABLE_CURSOR_HINT
25e0: 53 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 42 74  S.void sqlite3Bt
25f0: 72 65 65 43 75 72 73 6f 72 48 69 6e 74 28 42 74  reeCursorHint(Bt
2600: 43 75 72 73 6f 72 2a 2c 20 69 6e 74 2c 20 2e 2e  Cursor*, int, ..
2610: 2e 29 3b 0a 23 65 6e 64 69 66 0a 0a 69 6e 74 20  .);.#endif..int 
2620: 73 71 6c 69 74 65 33 42 74 72 65 65 43 6c 6f 73  sqlite3BtreeClos
2630: 65 43 75 72 73 6f 72 28 42 74 43 75 72 73 6f 72  eCursor(BtCursor
2640: 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  *);.int sqlite3B
2650: 74 72 65 65 4d 6f 76 65 74 6f 55 6e 70 61 63 6b  treeMovetoUnpack
2660: 65 64 28 0a 20 20 42 74 43 75 72 73 6f 72 2a 2c  ed(.  BtCursor*,
2670: 0a 20 20 55 6e 70 61 63 6b 65 64 52 65 63 6f 72  .  UnpackedRecor
2680: 64 20 2a 70 55 6e 4b 65 79 2c 0a 20 20 69 36 34  d *pUnKey,.  i64
2690: 20 69 6e 74 4b 65 79 2c 0a 20 20 69 6e 74 20 62   intKey,.  int b
26a0: 69 61 73 2c 0a 20 20 69 6e 74 20 2a 70 52 65 73  ias,.  int *pRes
26b0: 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  .);.int sqlite3B
26c0: 74 72 65 65 43 75 72 73 6f 72 48 61 73 4d 6f 76  treeCursorHasMov
26d0: 65 64 28 42 74 43 75 72 73 6f 72 2a 29 3b 0a 69  ed(BtCursor*);.i
26e0: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 43  nt sqlite3BtreeC
26f0: 75 72 73 6f 72 52 65 73 74 6f 72 65 28 42 74 43  ursorRestore(BtC
2700: 75 72 73 6f 72 2a 2c 20 69 6e 74 2a 29 3b 0a 69  ursor*, int*);.i
2710: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 44  nt sqlite3BtreeD
2720: 65 6c 65 74 65 28 42 74 43 75 72 73 6f 72 2a 2c  elete(BtCursor*,
2730: 20 75 38 20 66 6c 61 67 73 29 3b 0a 0a 2f 2a 20   u8 flags);../* 
2740: 41 6c 6c 6f 77 65 64 20 66 6c 61 67 73 20 66 6f  Allowed flags fo
2750: 72 20 74 68 65 20 32 6e 64 20 61 72 67 75 6d 65  r the 2nd argume
2760: 6e 74 20 74 6f 20 73 71 6c 69 74 65 33 42 74 72  nt to sqlite3Btr
2770: 65 65 44 65 6c 65 74 65 28 29 20 2a 2f 0a 23 64  eeDelete() */.#d
2780: 65 66 69 6e 65 20 42 54 52 45 45 5f 53 41 56 45  efine BTREE_SAVE
2790: 50 4f 53 49 54 49 4f 4e 20 30 78 30 32 20 20 2f  POSITION 0x02  /
27a0: 2a 20 4c 65 61 76 65 20 63 75 72 73 6f 72 20 70  * Leave cursor p
27b0: 6f 69 6e 74 69 6e 67 20 61 74 20 4e 45 58 54 20  ointing at NEXT 
27c0: 6f 72 20 50 52 45 56 20 2a 2f 0a 23 64 65 66 69  or PREV */.#defi
27d0: 6e 65 20 42 54 52 45 45 5f 41 55 58 44 45 4c 45  ne BTREE_AUXDELE
27e0: 54 45 20 20 20 20 30 78 30 34 20 20 2f 2a 20 6e  TE    0x04  /* n
27f0: 6f 74 20 74 68 65 20 70 72 69 6d 61 72 79 20 64  ot the primary d
2800: 65 6c 65 74 65 20 6f 70 65 72 61 74 69 6f 6e 20  elete operation 
2810: 2a 2f 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  */..int sqlite3B
2820: 74 72 65 65 49 6e 73 65 72 74 28 42 74 43 75 72  treeInsert(BtCur
2830: 73 6f 72 2a 2c 20 63 6f 6e 73 74 20 76 6f 69 64  sor*, const void
2840: 20 2a 70 4b 65 79 2c 20 69 36 34 20 6e 4b 65 79   *pKey, i64 nKey
2850: 2c 0a 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ,.              
2860: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2870: 20 20 20 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a      const void *
2880: 70 44 61 74 61 2c 20 69 6e 74 20 6e 44 61 74 61  pData, int nData
2890: 2c 0a 20 20 20 20 20 20 20 20 20 20 20 20 20 20  ,.              
28a0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
28b0: 20 20 20 20 69 6e 74 20 6e 5a 65 72 6f 2c 20 69      int nZero, i
28c0: 6e 74 20 62 69 61 73 2c 20 69 6e 74 20 73 65 65  nt bias, int see
28d0: 6b 52 65 73 75 6c 74 29 3b 0a 69 6e 74 20 73 71  kResult);.int sq
28e0: 6c 69 74 65 33 42 74 72 65 65 46 69 72 73 74 28  lite3BtreeFirst(
28f0: 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e 74 20 2a  BtCursor*, int *
2900: 70 52 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69 74  pRes);.int sqlit
2910: 65 33 42 74 72 65 65 4c 61 73 74 28 42 74 43 75  e3BtreeLast(BtCu
2920: 72 73 6f 72 2a 2c 20 69 6e 74 20 2a 70 52 65 73  rsor*, int *pRes
2930: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
2940: 72 65 65 4e 65 78 74 28 42 74 43 75 72 73 6f 72  reeNext(BtCursor
2950: 2a 2c 20 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69  *, int *pRes);.i
2960: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 45  nt sqlite3BtreeE
2970: 6f 66 28 42 74 43 75 72 73 6f 72 2a 29 3b 0a 69  of(BtCursor*);.i
2980: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 50  nt sqlite3BtreeP
2990: 72 65 76 69 6f 75 73 28 42 74 43 75 72 73 6f 72  revious(BtCursor
29a0: 2a 2c 20 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69  *, int *pRes);.i
29b0: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 4b  nt sqlite3BtreeK
29c0: 65 79 53 69 7a 65 28 42 74 43 75 72 73 6f 72 2a  eySize(BtCursor*
29d0: 2c 20 69 36 34 20 2a 70 53 69 7a 65 29 3b 0a 69  , i64 *pSize);.i
29e0: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 4b  nt sqlite3BtreeK
29f0: 65 79 28 42 74 43 75 72 73 6f 72 2a 2c 20 75 33  ey(BtCursor*, u3
2a00: 32 20 6f 66 66 73 65 74 2c 20 75 33 32 20 61 6d  2 offset, u32 am
2a10: 74 2c 20 76 6f 69 64 2a 29 3b 0a 63 6f 6e 73 74  t, void*);.const
2a20: 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 42 74   void *sqlite3Bt
2a30: 72 65 65 4b 65 79 46 65 74 63 68 28 42 74 43 75  reeKeyFetch(BtCu
2a40: 72 73 6f 72 2a 2c 20 75 33 32 20 2a 70 41 6d 74  rsor*, u32 *pAmt
2a50: 29 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73  );.const void *s
2a60: 71 6c 69 74 65 33 42 74 72 65 65 44 61 74 61 46  qlite3BtreeDataF
2a70: 65 74 63 68 28 42 74 43 75 72 73 6f 72 2a 2c 20  etch(BtCursor*, 
2a80: 75 33 32 20 2a 70 41 6d 74 29 3b 0a 69 6e 74 20  u32 *pAmt);.int 
2a90: 73 71 6c 69 74 65 33 42 74 72 65 65 44 61 74 61  sqlite3BtreeData
2aa0: 53 69 7a 65 28 42 74 43 75 72 73 6f 72 2a 2c 20  Size(BtCursor*, 
2ab0: 75 33 32 20 2a 70 53 69 7a 65 29 3b 0a 69 6e 74  u32 *pSize);.int
2ac0: 20 73 71 6c 69 74 65 33 42 74 72 65 65 44 61 74   sqlite3BtreeDat
2ad0: 61 28 42 74 43 75 72 73 6f 72 2a 2c 20 75 33 32  a(BtCursor*, u32
2ae0: 20 6f 66 66 73 65 74 2c 20 75 33 32 20 61 6d 74   offset, u32 amt
2af0: 2c 20 76 6f 69 64 2a 29 3b 0a 0a 63 68 61 72 20  , void*);..char 
2b00: 2a 73 71 6c 69 74 65 33 42 74 72 65 65 49 6e 74  *sqlite3BtreeInt
2b10: 65 67 72 69 74 79 43 68 65 63 6b 28 42 74 72 65  egrityCheck(Btre
2b20: 65 2a 2c 20 69 6e 74 20 2a 61 52 6f 6f 74 2c 20  e*, int *aRoot, 
2b30: 69 6e 74 20 6e 52 6f 6f 74 2c 20 69 6e 74 2c 20  int nRoot, int, 
2b40: 69 6e 74 2a 29 3b 0a 73 74 72 75 63 74 20 50 61  int*);.struct Pa
2b50: 67 65 72 20 2a 73 71 6c 69 74 65 33 42 74 72 65  ger *sqlite3Btre
2b60: 65 50 61 67 65 72 28 42 74 72 65 65 2a 29 3b 0a  ePager(Btree*);.
2b70: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65  .int sqlite3Btre
2b80: 65 50 75 74 44 61 74 61 28 42 74 43 75 72 73 6f  ePutData(BtCurso
2b90: 72 2a 2c 20 75 33 32 20 6f 66 66 73 65 74 2c 20  r*, u32 offset, 
2ba0: 75 33 32 20 61 6d 74 2c 20 76 6f 69 64 2a 29 3b  u32 amt, void*);
2bb0: 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 42 74 72  .void sqlite3Btr
2bc0: 65 65 49 6e 63 72 62 6c 6f 62 43 75 72 73 6f 72  eeIncrblobCursor
2bd0: 28 42 74 43 75 72 73 6f 72 20 2a 29 3b 0a 76 6f  (BtCursor *);.vo
2be0: 69 64 20 73 71 6c 69 74 65 33 42 74 72 65 65 43  id sqlite3BtreeC
2bf0: 6c 65 61 72 43 75 72 73 6f 72 28 42 74 43 75 72  learCursor(BtCur
2c00: 73 6f 72 20 2a 29 3b 0a 69 6e 74 20 73 71 6c 69  sor *);.int sqli
2c10: 74 65 33 42 74 72 65 65 53 65 74 56 65 72 73 69  te3BtreeSetVersi
2c20: 6f 6e 28 42 74 72 65 65 20 2a 70 42 74 2c 20 69  on(Btree *pBt, i
2c30: 6e 74 20 69 56 65 72 73 69 6f 6e 29 3b 0a 69 6e  nt iVersion);.in
2c40: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 43 75  t sqlite3BtreeCu
2c50: 72 73 6f 72 48 61 73 48 69 6e 74 28 42 74 43 75  rsorHasHint(BtCu
2c60: 72 73 6f 72 2a 2c 20 75 6e 73 69 67 6e 65 64 20  rsor*, unsigned 
2c70: 69 6e 74 20 6d 61 73 6b 29 3b 0a 69 6e 74 20 73  int mask);.int s
2c80: 71 6c 69 74 65 33 42 74 72 65 65 49 73 52 65 61  qlite3BtreeIsRea
2c90: 64 6f 6e 6c 79 28 42 74 72 65 65 20 2a 70 42 74  donly(Btree *pBt
2ca0: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 48 65  );.int sqlite3He
2cb0: 61 64 65 72 53 69 7a 65 42 74 72 65 65 28 76 6f  aderSizeBtree(vo
2cc0: 69 64 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65  id);..int sqlite
2cd0: 33 42 74 72 65 65 45 78 63 6c 75 73 69 76 65 4c  3BtreeExclusiveL
2ce0: 6f 63 6b 28 42 74 72 65 65 20 2a 70 42 74 29 3b  ock(Btree *pBt);
2cf0: 0a 0a 23 69 66 6e 64 65 66 20 4e 44 45 42 55 47  ..#ifndef NDEBUG
2d00: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65  .int sqlite3Btre
2d10: 65 43 75 72 73 6f 72 49 73 56 61 6c 69 64 28 42  eCursorIsValid(B
2d20: 74 43 75 72 73 6f 72 2a 29 3b 0a 23 65 6e 64 69  tCursor*);.#endi
2d30: 66 0a 0a 23 69 66 6e 64 65 66 20 53 51 4c 49 54  f..#ifndef SQLIT
2d40: 45 5f 4f 4d 49 54 5f 42 54 52 45 45 43 4f 55 4e  E_OMIT_BTREECOUN
2d50: 54 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72  T.int sqlite3Btr
2d60: 65 65 43 6f 75 6e 74 28 42 74 43 75 72 73 6f 72  eeCount(BtCursor
2d70: 20 2a 2c 20 69 36 34 20 2a 29 3b 0a 23 65 6e 64   *, i64 *);.#end
2d80: 69 66 0a 0a 23 69 66 64 65 66 20 53 51 4c 49 54  if..#ifdef SQLIT
2d90: 45 5f 54 45 53 54 0a 69 6e 74 20 73 71 6c 69 74  E_TEST.int sqlit
2da0: 65 33 42 74 72 65 65 43 75 72 73 6f 72 49 6e 66  e3BtreeCursorInf
2db0: 6f 28 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e 74  o(BtCursor*, int
2dc0: 2a 2c 20 69 6e 74 29 3b 0a 76 6f 69 64 20 73 71  *, int);.void sq
2dd0: 6c 69 74 65 33 42 74 72 65 65 43 75 72 73 6f 72  lite3BtreeCursor
2de0: 4c 69 73 74 28 42 74 72 65 65 2a 29 3b 0a 23 65  List(Btree*);.#e
2df0: 6e 64 69 66 0a 0a 23 69 66 6e 64 65 66 20 53 51  ndif..#ifndef SQ
2e00: 4c 49 54 45 5f 4f 4d 49 54 5f 57 41 4c 0a 20 20  LITE_OMIT_WAL.  
2e10: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
2e20: 43 68 65 63 6b 70 6f 69 6e 74 28 42 74 72 65 65  Checkpoint(Btree
2e30: 2a 2c 20 69 6e 74 2c 20 69 6e 74 20 2a 2c 20 69  *, int, int *, i
2e40: 6e 74 20 2a 29 3b 0a 23 65 6e 64 69 66 0a 0a 2f  nt *);.#endif../
2e50: 2a 0a 2a 2a 20 49 66 20 77 65 20 61 72 65 20 6e  *.** If we are n
2e60: 6f 74 20 75 73 69 6e 67 20 73 68 61 72 65 64 20  ot using shared 
2e70: 63 61 63 68 65 2c 20 74 68 65 6e 20 74 68 65 72  cache, then ther
2e80: 65 20 69 73 20 6e 6f 20 6e 65 65 64 20 74 6f 0a  e is no need to.
2e90: 2a 2a 20 75 73 65 20 6d 75 74 65 78 65 73 20 74  ** use mutexes t
2ea0: 6f 20 61 63 63 65 73 73 20 74 68 65 20 42 74 53  o access the BtS
2eb0: 68 61 72 65 64 20 73 74 72 75 63 74 75 72 65 73  hared structures
2ec0: 2e 20 20 53 6f 20 6d 61 6b 65 20 74 68 65 0a 2a  .  So make the.*
2ed0: 2a 20 45 6e 74 65 72 20 61 6e 64 20 4c 65 61 76  * Enter and Leav
2ee0: 65 20 70 72 6f 63 65 64 75 72 65 73 20 6e 6f 2d  e procedures no-
2ef0: 6f 70 73 2e 0a 2a 2f 0a 23 69 66 6e 64 65 66 20  ops..*/.#ifndef 
2f00: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 53 48 41 52  SQLITE_OMIT_SHAR
2f10: 45 44 5f 43 41 43 48 45 0a 20 20 76 6f 69 64 20  ED_CACHE.  void 
2f20: 73 71 6c 69 74 65 33 42 74 72 65 65 45 6e 74 65  sqlite3BtreeEnte
2f30: 72 28 42 74 72 65 65 2a 29 3b 0a 20 20 76 6f 69  r(Btree*);.  voi
2f40: 64 20 73 71 6c 69 74 65 33 42 74 72 65 65 45 6e  d sqlite3BtreeEn
2f50: 74 65 72 41 6c 6c 28 73 71 6c 69 74 65 33 2a 29  terAll(sqlite3*)
2f60: 3b 0a 20 20 69 6e 74 20 73 71 6c 69 74 65 33 42  ;.  int sqlite3B
2f70: 74 72 65 65 53 68 61 72 61 62 6c 65 28 42 74 72  treeSharable(Btr
2f80: 65 65 2a 29 3b 0a 20 20 76 6f 69 64 20 73 71 6c  ee*);.  void sql
2f90: 69 74 65 33 42 74 72 65 65 45 6e 74 65 72 43 75  ite3BtreeEnterCu
2fa0: 72 73 6f 72 28 42 74 43 75 72 73 6f 72 2a 29 3b  rsor(BtCursor*);
2fb0: 0a 23 65 6c 73 65 0a 23 20 64 65 66 69 6e 65 20  .#else.# define 
2fc0: 73 71 6c 69 74 65 33 42 74 72 65 65 45 6e 74 65  sqlite3BtreeEnte
2fd0: 72 28 58 29 20 0a 23 20 64 65 66 69 6e 65 20 73  r(X) .# define s
2fe0: 71 6c 69 74 65 33 42 74 72 65 65 45 6e 74 65 72  qlite3BtreeEnter
2ff0: 41 6c 6c 28 58 29 0a 23 20 64 65 66 69 6e 65 20  All(X).# define 
3000: 73 71 6c 69 74 65 33 42 74 72 65 65 53 68 61 72  sqlite3BtreeShar
3010: 61 62 6c 65 28 58 29 20 30 0a 23 20 64 65 66 69  able(X) 0.# defi
3020: 6e 65 20 73 71 6c 69 74 65 33 42 74 72 65 65 45  ne sqlite3BtreeE
3030: 6e 74 65 72 43 75 72 73 6f 72 28 58 29 0a 23 65  nterCursor(X).#e
3040: 6e 64 69 66 0a 0a 23 69 66 20 21 64 65 66 69 6e  ndif..#if !defin
3050: 65 64 28 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 53  ed(SQLITE_OMIT_S
3060: 48 41 52 45 44 5f 43 41 43 48 45 29 20 26 26 20  HARED_CACHE) && 
3070: 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53 41 46  SQLITE_THREADSAF
3080: 45 0a 20 20 76 6f 69 64 20 73 71 6c 69 74 65 33  E.  void sqlite3
3090: 42 74 72 65 65 4c 65 61 76 65 28 42 74 72 65 65  BtreeLeave(Btree
30a0: 2a 29 3b 0a 20 20 76 6f 69 64 20 73 71 6c 69 74  *);.  void sqlit
30b0: 65 33 42 74 72 65 65 4c 65 61 76 65 43 75 72 73  e3BtreeLeaveCurs
30c0: 6f 72 28 42 74 43 75 72 73 6f 72 2a 29 3b 0a 20  or(BtCursor*);. 
30d0: 20 76 6f 69 64 20 73 71 6c 69 74 65 33 42 74 72   void sqlite3Btr
30e0: 65 65 4c 65 61 76 65 41 6c 6c 28 73 71 6c 69 74  eeLeaveAll(sqlit
30f0: 65 33 2a 29 3b 0a 23 69 66 6e 64 65 66 20 4e 44  e3*);.#ifndef ND
3100: 45 42 55 47 0a 20 20 2f 2a 20 54 68 65 73 65 20  EBUG.  /* These 
3110: 72 6f 75 74 69 6e 65 73 20 61 72 65 20 75 73 65  routines are use
3120: 64 20 69 6e 73 69 64 65 20 61 73 73 65 72 74 28  d inside assert(
3130: 29 20 73 74 61 74 65 6d 65 6e 74 73 20 6f 6e 6c  ) statements onl
3140: 79 2e 20 2a 2f 0a 20 20 69 6e 74 20 73 71 6c 69  y. */.  int sqli
3150: 74 65 33 42 74 72 65 65 48 6f 6c 64 73 4d 75 74  te3BtreeHoldsMut
3160: 65 78 28 42 74 72 65 65 2a 29 3b 0a 20 20 69 6e  ex(Btree*);.  in
3170: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 48 6f  t sqlite3BtreeHo
3180: 6c 64 73 41 6c 6c 4d 75 74 65 78 65 73 28 73 71  ldsAllMutexes(sq
3190: 6c 69 74 65 33 2a 29 3b 0a 20 20 69 6e 74 20 73  lite3*);.  int s
31a0: 71 6c 69 74 65 33 53 63 68 65 6d 61 4d 75 74 65  qlite3SchemaMute
31b0: 78 48 65 6c 64 28 73 71 6c 69 74 65 33 2a 2c 69  xHeld(sqlite3*,i
31c0: 6e 74 2c 53 63 68 65 6d 61 2a 29 3b 0a 23 65 6e  nt,Schema*);.#en
31d0: 64 69 66 0a 23 65 6c 73 65 0a 0a 23 20 64 65 66  dif.#else..# def
31e0: 69 6e 65 20 73 71 6c 69 74 65 33 42 74 72 65 65  ine sqlite3Btree
31f0: 4c 65 61 76 65 28 58 29 0a 23 20 64 65 66 69 6e  Leave(X).# defin
3200: 65 20 73 71 6c 69 74 65 33 42 74 72 65 65 4c 65  e sqlite3BtreeLe
3210: 61 76 65 43 75 72 73 6f 72 28 58 29 0a 23 20 64  aveCursor(X).# d
3220: 65 66 69 6e 65 20 73 71 6c 69 74 65 33 42 74 72  efine sqlite3Btr
3230: 65 65 4c 65 61 76 65 41 6c 6c 28 58 29 0a 0a 23  eeLeaveAll(X)..#
3240: 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 42   define sqlite3B
3250: 74 72 65 65 48 6f 6c 64 73 4d 75 74 65 78 28 58  treeHoldsMutex(X
3260: 29 20 31 0a 23 20 64 65 66 69 6e 65 20 73 71 6c  ) 1.# define sql
3270: 69 74 65 33 42 74 72 65 65 48 6f 6c 64 73 41 6c  ite3BtreeHoldsAl
3280: 6c 4d 75 74 65 78 65 73 28 58 29 20 31 0a 23 20  lMutexes(X) 1.# 
3290: 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 53 63  define sqlite3Sc
32a0: 68 65 6d 61 4d 75 74 65 78 48 65 6c 64 28 58 2c  hemaMutexHeld(X,
32b0: 59 2c 5a 29 20 31 0a 23 65 6e 64 69 66 0a 0a 23  Y,Z) 1.#endif..#
32c0: 65 6e 64 69 66 20 2f 2a 20 5f 42 54 52 45 45 5f  endif /* _BTREE_
32d0: 48 5f 20 2a 2f 0a                                H_ */.