/ Hex Artifact Content
Login

Artifact c5dfbbc59226fa5fcc2b03befa85fe10ef23c1b5:


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 79 6e 63 44 69 73 61 62  e3BtreeSyncDisab
0970: 6c 65 64 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74  led(Btree*);.int
0980: 20 73 71 6c 69 74 65 33 42 74 72 65 65 53 65 74   sqlite3BtreeSet
0990: 50 61 67 65 53 69 7a 65 28 42 74 72 65 65 20 2a  PageSize(Btree *
09a0: 70 2c 20 69 6e 74 20 6e 50 61 67 65 73 69 7a 65  p, int nPagesize
09b0: 2c 20 69 6e 74 20 6e 52 65 73 65 72 76 65 2c 20  , int nReserve, 
09c0: 69 6e 74 20 65 46 69 78 29 3b 0a 69 6e 74 20 73  int eFix);.int s
09d0: 71 6c 69 74 65 33 42 74 72 65 65 47 65 74 50 61  qlite3BtreeGetPa
09e0: 67 65 53 69 7a 65 28 42 74 72 65 65 2a 29 3b 0a  geSize(Btree*);.
09f0: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
0a00: 4d 61 78 50 61 67 65 43 6f 75 6e 74 28 42 74 72  MaxPageCount(Btr
0a10: 65 65 2a 2c 69 6e 74 29 3b 0a 75 33 32 20 73 71  ee*,int);.u32 sq
0a20: 6c 69 74 65 33 42 74 72 65 65 4c 61 73 74 50 61  lite3BtreeLastPa
0a30: 67 65 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20  ge(Btree*);.int 
0a40: 73 71 6c 69 74 65 33 42 74 72 65 65 53 65 63 75  sqlite3BtreeSecu
0a50: 72 65 44 65 6c 65 74 65 28 42 74 72 65 65 2a 2c  reDelete(Btree*,
0a60: 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  int);.int sqlite
0a70: 33 42 74 72 65 65 47 65 74 4f 70 74 69 6d 61 6c  3BtreeGetOptimal
0a80: 52 65 73 65 72 76 65 28 42 74 72 65 65 2a 29 3b  Reserve(Btree*);
0a90: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65  .int sqlite3Btre
0aa0: 65 47 65 74 52 65 73 65 72 76 65 4e 6f 4d 75 74  eGetReserveNoMut
0ab0: 65 78 28 42 74 72 65 65 20 2a 70 29 3b 0a 69 6e  ex(Btree *p);.in
0ac0: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 53 65  t sqlite3BtreeSe
0ad0: 74 41 75 74 6f 56 61 63 75 75 6d 28 42 74 72 65  tAutoVacuum(Btre
0ae0: 65 20 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73  e *, int);.int s
0af0: 71 6c 69 74 65 33 42 74 72 65 65 47 65 74 41 75  qlite3BtreeGetAu
0b00: 74 6f 56 61 63 75 75 6d 28 42 74 72 65 65 20 2a  toVacuum(Btree *
0b10: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
0b20: 72 65 65 42 65 67 69 6e 54 72 61 6e 73 28 42 74  reeBeginTrans(Bt
0b30: 72 65 65 2a 2c 69 6e 74 29 3b 0a 69 6e 74 20 73  ree*,int);.int s
0b40: 71 6c 69 74 65 33 42 74 72 65 65 43 6f 6d 6d 69  qlite3BtreeCommi
0b50: 74 50 68 61 73 65 4f 6e 65 28 42 74 72 65 65 2a  tPhaseOne(Btree*
0b60: 2c 20 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a 4d  , const char *zM
0b70: 61 73 74 65 72 29 3b 0a 69 6e 74 20 73 71 6c 69  aster);.int sqli
0b80: 74 65 33 42 74 72 65 65 43 6f 6d 6d 69 74 50 68  te3BtreeCommitPh
0b90: 61 73 65 54 77 6f 28 42 74 72 65 65 2a 2c 20 69  aseTwo(Btree*, i
0ba0: 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  nt);.int sqlite3
0bb0: 42 74 72 65 65 43 6f 6d 6d 69 74 28 42 74 72 65  BtreeCommit(Btre
0bc0: 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  e*);.int sqlite3
0bd0: 42 74 72 65 65 52 6f 6c 6c 62 61 63 6b 28 42 74  BtreeRollback(Bt
0be0: 72 65 65 2a 2c 69 6e 74 2c 69 6e 74 29 3b 0a 69  ree*,int,int);.i
0bf0: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 42  nt sqlite3BtreeB
0c00: 65 67 69 6e 53 74 6d 74 28 42 74 72 65 65 2a 2c  eginStmt(Btree*,
0c10: 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  int);.int sqlite
0c20: 33 42 74 72 65 65 43 72 65 61 74 65 54 61 62 6c  3BtreeCreateTabl
0c30: 65 28 42 74 72 65 65 2a 2c 20 69 6e 74 2a 2c 20  e(Btree*, int*, 
0c40: 69 6e 74 20 66 6c 61 67 73 29 3b 0a 69 6e 74 20  int flags);.int 
0c50: 73 71 6c 69 74 65 33 42 74 72 65 65 49 73 49 6e  sqlite3BtreeIsIn
0c60: 54 72 61 6e 73 28 42 74 72 65 65 2a 29 3b 0a 69  Trans(Btree*);.i
0c70: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 49  nt sqlite3BtreeI
0c80: 73 49 6e 52 65 61 64 54 72 61 6e 73 28 42 74 72  sInReadTrans(Btr
0c90: 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  ee*);.int sqlite
0ca0: 33 42 74 72 65 65 49 73 49 6e 42 61 63 6b 75 70  3BtreeIsInBackup
0cb0: 28 42 74 72 65 65 2a 29 3b 0a 76 6f 69 64 20 2a  (Btree*);.void *
0cc0: 73 71 6c 69 74 65 33 42 74 72 65 65 53 63 68 65  sqlite3BtreeSche
0cd0: 6d 61 28 42 74 72 65 65 20 2a 2c 20 69 6e 74 2c  ma(Btree *, int,
0ce0: 20 76 6f 69 64 28 2a 29 28 76 6f 69 64 20 2a 29   void(*)(void *)
0cf0: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
0d00: 72 65 65 53 63 68 65 6d 61 4c 6f 63 6b 65 64 28  reeSchemaLocked(
0d10: 42 74 72 65 65 20 2a 70 42 74 72 65 65 29 3b 0a  Btree *pBtree);.
0d20: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
0d30: 4c 6f 63 6b 54 61 62 6c 65 28 42 74 72 65 65 20  LockTable(Btree 
0d40: 2a 70 42 74 72 65 65 2c 20 69 6e 74 20 69 54 61  *pBtree, int iTa
0d50: 62 2c 20 75 38 20 69 73 57 72 69 74 65 4c 6f 63  b, u8 isWriteLoc
0d60: 6b 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  k);.int sqlite3B
0d70: 74 72 65 65 53 61 76 65 70 6f 69 6e 74 28 42 74  treeSavepoint(Bt
0d80: 72 65 65 20 2a 2c 20 69 6e 74 2c 20 69 6e 74 29  ree *, int, int)
0d90: 3b 0a 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a 73  ;..const char *s
0da0: 71 6c 69 74 65 33 42 74 72 65 65 47 65 74 46 69  qlite3BtreeGetFi
0db0: 6c 65 6e 61 6d 65 28 42 74 72 65 65 20 2a 29 3b  lename(Btree *);
0dc0: 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 71 6c  .const char *sql
0dd0: 69 74 65 33 42 74 72 65 65 47 65 74 4a 6f 75 72  ite3BtreeGetJour
0de0: 6e 61 6c 6e 61 6d 65 28 42 74 72 65 65 20 2a 29  nalname(Btree *)
0df0: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72  ;.int sqlite3Btr
0e00: 65 65 43 6f 70 79 46 69 6c 65 28 42 74 72 65 65  eeCopyFile(Btree
0e10: 20 2a 2c 20 42 74 72 65 65 20 2a 29 3b 0a 0a 69   *, Btree *);..i
0e20: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 49  nt sqlite3BtreeI
0e30: 6e 63 72 56 61 63 75 75 6d 28 42 74 72 65 65 20  ncrVacuum(Btree 
0e40: 2a 29 3b 0a 0a 2f 2a 20 54 68 65 20 66 6c 61 67  *);../* The flag
0e50: 73 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73  s parameter to s
0e60: 71 6c 69 74 65 33 42 74 72 65 65 43 72 65 61 74  qlite3BtreeCreat
0e70: 65 54 61 62 6c 65 20 63 61 6e 20 62 65 20 74 68  eTable can be th
0e80: 65 20 62 69 74 77 69 73 65 20 4f 52 0a 2a 2a 20  e bitwise OR.** 
0e90: 6f 66 20 74 68 65 20 66 6c 61 67 73 20 73 68 6f  of the flags sho
0ea0: 77 6e 20 62 65 6c 6f 77 2e 0a 2a 2a 0a 2a 2a 20  wn below..**.** 
0eb0: 45 76 65 72 79 20 53 51 4c 69 74 65 20 74 61 62  Every SQLite tab
0ec0: 6c 65 20 6d 75 73 74 20 68 61 76 65 20 65 69 74  le must have eit
0ed0: 68 65 72 20 42 54 52 45 45 5f 49 4e 54 4b 45 59  her BTREE_INTKEY
0ee0: 20 6f 72 20 42 54 52 45 45 5f 42 4c 4f 42 4b 45   or BTREE_BLOBKE
0ef0: 59 20 73 65 74 2e 0a 2a 2a 20 57 69 74 68 20 42  Y set..** With B
0f00: 54 52 45 45 5f 49 4e 54 4b 45 59 2c 20 74 68 65  TREE_INTKEY, the
0f10: 20 74 61 62 6c 65 20 6b 65 79 20 69 73 20 61 20   table key is a 
0f20: 36 34 2d 62 69 74 20 69 6e 74 65 67 65 72 20 61  64-bit integer a
0f30: 6e 64 20 61 72 62 69 74 72 61 72 79 20 64 61 74  nd arbitrary dat
0f40: 61 0a 2a 2a 20 69 73 20 73 74 6f 72 65 64 20 69  a.** is stored i
0f50: 6e 20 74 68 65 20 6c 65 61 76 65 73 2e 20 20 28  n the leaves.  (
0f60: 42 54 52 45 45 5f 49 4e 54 4b 45 59 20 69 73 20  BTREE_INTKEY is 
0f70: 75 73 65 64 20 66 6f 72 20 53 51 4c 20 74 61 62  used for SQL tab
0f80: 6c 65 73 2e 29 20 20 57 69 74 68 0a 2a 2a 20 42  les.)  With.** B
0f90: 54 52 45 45 5f 42 4c 4f 42 4b 45 59 2c 20 74 68  TREE_BLOBKEY, th
0fa0: 65 20 6b 65 79 20 69 73 20 61 6e 20 61 72 62 69  e key is an arbi
0fb0: 74 72 61 72 79 20 42 4c 4f 42 20 61 6e 64 20 6e  trary BLOB and n
0fc0: 6f 20 63 6f 6e 74 65 6e 74 20 69 73 20 73 74 6f  o content is sto
0fd0: 72 65 64 0a 2a 2a 20 61 6e 79 77 68 65 72 65 20  red.** anywhere 
0fe0: 2d 20 74 68 65 20 6b 65 79 20 69 73 20 74 68 65  - the key is the
0ff0: 20 63 6f 6e 74 65 6e 74 2e 20 20 28 42 54 52 45   content.  (BTRE
1000: 45 5f 42 4c 4f 42 4b 45 59 20 69 73 20 75 73 65  E_BLOBKEY is use
1010: 64 20 66 6f 72 20 53 51 4c 0a 2a 2a 20 69 6e 64  d for SQL.** ind
1020: 69 63 65 73 2e 29 0a 2a 2f 0a 23 64 65 66 69 6e  ices.).*/.#defin
1030: 65 20 42 54 52 45 45 5f 49 4e 54 4b 45 59 20 20  e BTREE_INTKEY  
1040: 20 20 20 31 20 20 20 20 2f 2a 20 54 61 62 6c 65     1    /* Table
1050: 20 68 61 73 20 6f 6e 6c 79 20 36 34 2d 62 69 74   has only 64-bit
1060: 20 73 69 67 6e 65 64 20 69 6e 74 65 67 65 72 20   signed integer 
1070: 6b 65 79 73 20 2a 2f 0a 23 64 65 66 69 6e 65 20  keys */.#define 
1080: 42 54 52 45 45 5f 42 4c 4f 42 4b 45 59 20 20 20  BTREE_BLOBKEY   
1090: 20 32 20 20 20 20 2f 2a 20 54 61 62 6c 65 20 68   2    /* Table h
10a0: 61 73 20 6b 65 79 73 20 6f 6e 6c 79 20 2d 20 6e  as keys only - n
10b0: 6f 20 64 61 74 61 20 2a 2f 0a 0a 69 6e 74 20 73  o data */..int s
10c0: 71 6c 69 74 65 33 42 74 72 65 65 44 72 6f 70 54  qlite3BtreeDropT
10d0: 61 62 6c 65 28 42 74 72 65 65 2a 2c 20 69 6e 74  able(Btree*, int
10e0: 2c 20 69 6e 74 2a 29 3b 0a 69 6e 74 20 73 71 6c  , int*);.int sql
10f0: 69 74 65 33 42 74 72 65 65 43 6c 65 61 72 54 61  ite3BtreeClearTa
1100: 62 6c 65 28 42 74 72 65 65 2a 2c 20 69 6e 74 2c  ble(Btree*, int,
1110: 20 69 6e 74 2a 29 3b 0a 69 6e 74 20 73 71 6c 69   int*);.int sqli
1120: 74 65 33 42 74 72 65 65 43 6c 65 61 72 54 61 62  te3BtreeClearTab
1130: 6c 65 4f 66 43 75 72 73 6f 72 28 42 74 43 75 72  leOfCursor(BtCur
1140: 73 6f 72 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74  sor*);.int sqlit
1150: 65 33 42 74 72 65 65 54 72 69 70 41 6c 6c 43 75  e3BtreeTripAllCu
1160: 72 73 6f 72 73 28 42 74 72 65 65 2a 2c 20 69 6e  rsors(Btree*, in
1170: 74 2c 20 69 6e 74 29 3b 0a 0a 76 6f 69 64 20 73  t, int);..void s
1180: 71 6c 69 74 65 33 42 74 72 65 65 47 65 74 4d 65  qlite3BtreeGetMe
1190: 74 61 28 42 74 72 65 65 20 2a 70 42 74 72 65 65  ta(Btree *pBtree
11a0: 2c 20 69 6e 74 20 69 64 78 2c 20 75 33 32 20 2a  , int idx, u32 *
11b0: 70 56 61 6c 75 65 29 3b 0a 69 6e 74 20 73 71 6c  pValue);.int sql
11c0: 69 74 65 33 42 74 72 65 65 55 70 64 61 74 65 4d  ite3BtreeUpdateM
11d0: 65 74 61 28 42 74 72 65 65 2a 2c 20 69 6e 74 20  eta(Btree*, int 
11e0: 69 64 78 2c 20 75 33 32 20 76 61 6c 75 65 29 3b  idx, u32 value);
11f0: 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72  ..int sqlite3Btr
1200: 65 65 4e 65 77 44 62 28 42 74 72 65 65 20 2a 70  eeNewDb(Btree *p
1210: 29 3b 0a 0a 2f 2a 0a 2a 2a 20 54 68 65 20 73 65  );../*.** The se
1220: 63 6f 6e 64 20 70 61 72 61 6d 65 74 65 72 20 74  cond parameter t
1230: 6f 20 73 71 6c 69 74 65 33 42 74 72 65 65 47 65  o sqlite3BtreeGe
1240: 74 4d 65 74 61 20 6f 72 20 73 71 6c 69 74 65 33  tMeta or sqlite3
1250: 42 74 72 65 65 55 70 64 61 74 65 4d 65 74 61 0a  BtreeUpdateMeta.
1260: 2a 2a 20 73 68 6f 75 6c 64 20 62 65 20 6f 6e 65  ** should be one
1270: 20 6f 66 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e   of the followin
1280: 67 20 76 61 6c 75 65 73 2e 20 54 68 65 20 69 6e  g values. The in
1290: 74 65 67 65 72 20 76 61 6c 75 65 73 20 61 72 65  teger values are
12a0: 20 61 73 73 69 67 6e 65 64 20 0a 2a 2a 20 74 6f   assigned .** to
12b0: 20 63 6f 6e 73 74 61 6e 74 73 20 73 6f 20 74 68   constants so th
12c0: 61 74 20 74 68 65 20 6f 66 66 73 65 74 20 6f 66  at the offset of
12d0: 20 74 68 65 20 63 6f 72 72 65 73 70 6f 6e 64 69   the correspondi
12e0: 6e 67 20 66 69 65 6c 64 20 69 6e 20 61 6e 0a 2a  ng field in an.*
12f0: 2a 20 53 51 4c 69 74 65 20 64 61 74 61 62 61 73  * SQLite databas
1300: 65 20 68 65 61 64 65 72 20 6d 61 79 20 62 65 20  e header may be 
1310: 66 6f 75 6e 64 20 75 73 69 6e 67 20 74 68 65 20  found using the 
1320: 66 6f 6c 6c 6f 77 69 6e 67 20 66 6f 72 6d 75 6c  following formul
1330: 61 3a 0a 2a 2a 0a 2a 2a 20 20 20 6f 66 66 73 65  a:.**.**   offse
1340: 74 20 3d 20 33 36 20 2b 20 28 69 64 78 20 2a 20  t = 36 + (idx * 
1350: 34 29 0a 2a 2a 0a 2a 2a 20 46 6f 72 20 65 78 61  4).**.** For exa
1360: 6d 70 6c 65 2c 20 74 68 65 20 66 72 65 65 2d 70  mple, the free-p
1370: 61 67 65 2d 63 6f 75 6e 74 20 66 69 65 6c 64 20  age-count field 
1380: 69 73 20 6c 6f 63 61 74 65 64 20 61 74 20 62 79  is located at by
1390: 74 65 20 6f 66 66 73 65 74 20 33 36 20 6f 66 0a  te offset 36 of.
13a0: 2a 2a 20 74 68 65 20 64 61 74 61 62 61 73 65 20  ** the database 
13b0: 66 69 6c 65 20 68 65 61 64 65 72 2e 20 54 68 65  file header. The
13c0: 20 69 6e 63 72 2d 76 61 63 75 75 6d 2d 66 6c 61   incr-vacuum-fla
13d0: 67 20 66 69 65 6c 64 20 69 73 20 6c 6f 63 61 74  g field is locat
13e0: 65 64 20 61 74 0a 2a 2a 20 62 79 74 65 20 6f 66  ed at.** byte of
13f0: 66 73 65 74 20 36 34 20 28 3d 3d 20 33 36 2b 34  fset 64 (== 36+4
1400: 2a 37 29 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 42  *7)..**.** The B
1410: 54 52 45 45 5f 44 41 54 41 5f 56 45 52 53 49 4f  TREE_DATA_VERSIO
1420: 4e 20 76 61 6c 75 65 20 69 73 20 6e 6f 74 20 72  N value is not r
1430: 65 61 6c 6c 79 20 61 20 76 61 6c 75 65 20 73 74  eally a value st
1440: 6f 72 65 64 20 69 6e 20 74 68 65 20 68 65 61 64  ored in the head
1450: 65 72 2e 0a 2a 2a 20 49 74 20 69 73 20 61 20 72  er..** It is a r
1460: 65 61 64 2d 6f 6e 6c 79 20 6e 75 6d 62 65 72 20  ead-only number 
1470: 63 6f 6d 70 75 74 65 64 20 62 79 20 74 68 65 20  computed by the 
1480: 70 61 67 65 72 2e 20 20 42 75 74 20 77 65 20 6d  pager.  But we m
1490: 65 72 67 65 20 69 74 20 77 69 74 68 0a 2a 2a 20  erge it with.** 
14a0: 74 68 65 20 68 65 61 64 65 72 20 76 61 6c 75 65  the header value
14b0: 20 61 63 63 65 73 73 20 72 6f 75 74 69 6e 65 73   access routines
14c0: 20 73 69 6e 63 65 20 69 74 73 20 61 63 63 65 73   since its acces
14d0: 73 20 70 61 74 74 65 72 6e 20 69 73 20 74 68 65  s pattern is the
14e0: 20 73 61 6d 65 2e 0a 2a 2a 20 43 61 6c 6c 20 69   same..** Call i
14f0: 74 20 61 20 22 76 69 72 74 75 61 6c 20 6d 65 74  t a "virtual met
1500: 61 20 76 61 6c 75 65 22 2e 0a 2a 2f 0a 23 64 65  a value"..*/.#de
1510: 66 69 6e 65 20 42 54 52 45 45 5f 46 52 45 45 5f  fine BTREE_FREE_
1520: 50 41 47 45 5f 43 4f 55 4e 54 20 20 20 20 20 30  PAGE_COUNT     0
1530: 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f 53  .#define BTREE_S
1540: 43 48 45 4d 41 5f 56 45 52 53 49 4f 4e 20 20 20  CHEMA_VERSION   
1550: 20 20 20 31 0a 23 64 65 66 69 6e 65 20 42 54 52     1.#define BTR
1560: 45 45 5f 46 49 4c 45 5f 46 4f 52 4d 41 54 20 20  EE_FILE_FORMAT  
1570: 20 20 20 20 20 20 20 32 0a 23 64 65 66 69 6e 65         2.#define
1580: 20 42 54 52 45 45 5f 44 45 46 41 55 4c 54 5f 43   BTREE_DEFAULT_C
1590: 41 43 48 45 5f 53 49 5a 45 20 20 33 0a 23 64 65  ACHE_SIZE  3.#de
15a0: 66 69 6e 65 20 42 54 52 45 45 5f 4c 41 52 47 45  fine BTREE_LARGE
15b0: 53 54 5f 52 4f 4f 54 5f 50 41 47 45 20 20 20 34  ST_ROOT_PAGE   4
15c0: 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f 54  .#define BTREE_T
15d0: 45 58 54 5f 45 4e 43 4f 44 49 4e 47 20 20 20 20  EXT_ENCODING    
15e0: 20 20 20 35 0a 23 64 65 66 69 6e 65 20 42 54 52     5.#define BTR
15f0: 45 45 5f 55 53 45 52 5f 56 45 52 53 49 4f 4e 20  EE_USER_VERSION 
1600: 20 20 20 20 20 20 20 36 0a 23 64 65 66 69 6e 65         6.#define
1610: 20 42 54 52 45 45 5f 49 4e 43 52 5f 56 41 43 55   BTREE_INCR_VACU
1620: 55 4d 20 20 20 20 20 20 20 20 20 37 0a 23 64 65  UM         7.#de
1630: 66 69 6e 65 20 42 54 52 45 45 5f 41 50 50 4c 49  fine BTREE_APPLI
1640: 43 41 54 49 4f 4e 5f 49 44 20 20 20 20 20 20 38  CATION_ID      8
1650: 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f 44  .#define BTREE_D
1660: 41 54 41 5f 56 45 52 53 49 4f 4e 20 20 20 20 20  ATA_VERSION     
1670: 20 20 20 31 35 20 20 2f 2a 20 41 20 76 69 72 74     15  /* A virt
1680: 75 61 6c 20 6d 65 74 61 2d 76 61 6c 75 65 20 2a  ual meta-value *
1690: 2f 0a 0a 2f 2a 0a 2a 2a 20 4b 69 6e 64 73 20 6f  /../*.** Kinds o
16a0: 66 20 68 69 6e 74 73 20 74 68 61 74 20 63 61 6e  f hints that can
16b0: 20 62 65 20 70 61 73 73 65 64 20 69 6e 74 6f 20   be passed into 
16c0: 74 68 65 20 73 71 6c 69 74 65 33 42 74 72 65 65  the sqlite3Btree
16d0: 43 75 72 73 6f 72 48 69 6e 74 28 29 0a 2a 2a 20  CursorHint().** 
16e0: 69 6e 74 65 72 66 61 63 65 2e 0a 2a 2a 0a 2a 2a  interface..**.**
16f0: 20 42 54 52 45 45 5f 48 49 4e 54 5f 52 41 4e 47   BTREE_HINT_RANG
1700: 45 20 20 28 61 72 67 75 6d 65 6e 74 73 3a 20 45  E  (arguments: E
1710: 78 70 72 2a 2c 20 4d 65 6d 2a 29 0a 2a 2a 0a 2a  xpr*, Mem*).**.*
1720: 2a 20 20 20 20 20 54 68 65 20 66 69 72 73 74 20  *     The first 
1730: 61 72 67 75 6d 65 6e 74 20 69 73 20 61 6e 20 45  argument is an E
1740: 78 70 72 2a 20 28 77 68 69 63 68 20 69 73 20 67  xpr* (which is g
1750: 75 61 72 61 6e 74 65 65 64 20 74 6f 20 62 65 20  uaranteed to be 
1760: 63 6f 6e 73 74 61 6e 74 20 66 6f 72 0a 2a 2a 20  constant for.** 
1770: 20 20 20 20 74 68 65 20 6c 69 66 65 74 69 6d 65      the lifetime
1780: 20 6f 66 20 74 68 65 20 63 75 72 73 6f 72 29 20   of the cursor) 
1790: 74 68 61 74 20 64 65 66 69 6e 65 73 20 63 6f 6e  that defines con
17a0: 73 74 72 61 69 6e 74 73 20 6f 6e 20 77 68 69 63  straints on whic
17b0: 68 20 72 6f 77 73 0a 2a 2a 20 20 20 20 20 6d 69  h rows.**     mi
17c0: 67 68 74 20 62 65 20 66 65 74 63 68 65 64 20 77  ght be fetched w
17d0: 69 74 68 20 74 68 69 73 20 63 75 72 73 6f 72 2e  ith this cursor.
17e0: 20 20 54 68 65 20 45 78 70 72 2a 20 74 72 65 65    The Expr* tree
17f0: 20 6d 61 79 20 63 6f 6e 74 61 69 6e 0a 2a 2a 20   may contain.** 
1800: 20 20 20 20 54 4b 5f 52 45 47 49 53 54 45 52 20      TK_REGISTER 
1810: 6e 6f 64 65 73 20 74 68 61 74 20 72 65 66 65 72  nodes that refer
1820: 20 74 6f 20 76 61 6c 75 65 73 20 73 74 6f 72 65   to values store
1830: 64 20 69 6e 20 74 68 65 20 61 72 72 61 79 20 6f  d in the array o
1840: 66 20 72 65 67 69 73 74 65 72 73 0a 2a 2a 20 20  f registers.**  
1850: 20 20 20 70 61 73 73 65 64 20 61 73 20 74 68 65     passed as the
1860: 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65   second paramete
1870: 72 2e 20 20 49 6e 20 6f 74 68 65 72 20 77 6f 72  r.  In other wor
1880: 64 73 2c 20 69 66 20 45 78 70 72 2e 6f 70 3d 3d  ds, if Expr.op==
1890: 54 4b 5f 52 45 47 49 53 54 45 52 0a 2a 2a 20 20  TK_REGISTER.**  
18a0: 20 20 20 74 68 65 6e 20 74 68 65 20 76 61 6c 75     then the valu
18b0: 65 20 6f 66 20 74 68 65 20 6e 6f 64 65 20 69 73  e of the node is
18c0: 20 74 68 65 20 76 61 6c 75 65 20 69 6e 20 4d 65   the value in Me
18d0: 6d 5b 70 45 78 70 72 2e 69 54 61 62 6c 65 5d 2e  m[pExpr.iTable].
18e0: 20 20 41 6e 79 0a 2a 2a 20 20 20 20 20 54 4b 5f    Any.**     TK_
18f0: 43 4f 4c 55 4d 4e 20 6e 6f 64 65 20 69 6e 20 74  COLUMN node in t
1900: 68 65 20 65 78 70 72 65 73 73 69 6f 6e 20 74 72  he expression tr
1910: 65 65 20 72 65 66 65 72 73 20 74 6f 20 74 68 65  ee refers to the
1920: 20 45 78 70 72 2e 69 43 6f 6c 75 6d 6e 2d 74 68   Expr.iColumn-th
1930: 0a 2a 2a 20 20 20 20 20 63 6f 6c 75 6d 6e 20 6f  .**     column o
1940: 66 20 74 68 65 20 62 2d 74 72 65 65 20 6f 66 20  f the b-tree of 
1950: 74 68 65 20 63 75 72 73 6f 72 2e 20 20 54 68 65  the cursor.  The
1960: 20 45 78 70 72 20 74 72 65 65 20 77 69 6c 6c 20   Expr tree will 
1970: 6e 6f 74 20 63 6f 6e 74 61 69 6e 0a 2a 2a 20 20  not contain.**  
1980: 20 20 20 61 6e 79 20 66 75 6e 63 74 69 6f 6e 20     any function 
1990: 63 61 6c 6c 73 20 6e 6f 72 20 73 75 62 71 75 65  calls nor subque
19a0: 72 69 65 73 20 6e 6f 72 20 72 65 66 65 72 65 6e  ries nor referen
19b0: 63 65 73 20 74 6f 20 62 2d 74 72 65 65 73 20 6f  ces to b-trees o
19c0: 74 68 65 72 20 74 68 61 6e 0a 2a 2a 20 20 20 20  ther than.**    
19d0: 20 74 68 65 20 63 75 72 73 6f 72 20 62 65 69 6e   the cursor bein
19e0: 67 20 68 69 6e 74 65 64 2e 0a 2a 2a 0a 2a 2a 20  g hinted..**.** 
19f0: 20 20 20 20 54 68 65 20 64 65 73 69 67 6e 20 6f      The design o
1a00: 66 20 74 68 65 20 5f 52 41 4e 47 45 20 68 69 6e  f the _RANGE hin
1a10: 74 20 69 73 20 61 69 64 20 62 2d 74 72 65 65 20  t is aid b-tree 
1a20: 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f 6e 73 20  implementations 
1a30: 74 68 61 74 20 74 72 79 0a 2a 2a 20 20 20 20 20  that try.**     
1a40: 74 6f 20 70 72 65 66 65 74 63 68 20 63 6f 6e 74  to prefetch cont
1a50: 65 6e 74 20 66 72 6f 6d 20 72 65 6d 6f 74 65 20  ent from remote 
1a60: 6d 61 63 68 69 6e 65 73 20 2d 20 74 6f 20 70 72  machines - to pr
1a70: 6f 76 69 64 65 20 74 68 6f 73 65 0a 2a 2a 20 20  ovide those.**  
1a80: 20 20 20 69 6d 70 6c 65 6d 65 6e 74 61 74 69 6f     implementatio
1a90: 6e 73 20 77 69 74 68 20 6c 69 6d 69 74 73 20 6f  ns with limits o
1aa0: 6e 20 77 68 61 74 20 6e 65 65 64 73 20 74 6f 20  n what needs to 
1ab0: 62 65 20 70 72 65 66 65 74 63 68 65 64 20 61 6e  be prefetched an
1ac0: 64 20 74 68 65 72 65 62 79 0a 2a 2a 20 20 20 20  d thereby.**    
1ad0: 20 72 65 64 75 63 65 20 6e 65 74 77 6f 72 6b 20   reduce network 
1ae0: 62 61 6e 64 77 69 64 74 68 2e 0a 2a 2a 0a 2a 2a  bandwidth..**.**
1af0: 20 4e 6f 74 65 20 74 68 61 74 20 42 54 52 45 45   Note that BTREE
1b00: 5f 48 49 4e 54 5f 46 4c 41 47 53 20 77 69 74 68  _HINT_FLAGS with
1b10: 20 42 54 52 45 45 5f 42 55 4c 4b 4c 4f 41 44 20   BTREE_BULKLOAD 
1b20: 69 73 20 74 68 65 20 6f 6e 6c 79 20 68 69 6e 74  is the only hint
1b30: 20 75 73 65 64 20 62 79 0a 2a 2a 20 73 74 61 6e   used by.** stan
1b40: 64 61 72 64 20 53 51 4c 69 74 65 2e 20 20 54 68  dard SQLite.  Th
1b50: 65 20 6f 74 68 65 72 20 68 69 6e 74 73 20 61 72  e other hints ar
1b60: 65 20 70 72 6f 76 69 64 65 64 20 66 6f 72 20 65  e provided for e
1b70: 78 74 65 6e 74 69 6f 6e 73 20 74 68 61 74 20 75  xtentions that u
1b80: 73 65 0a 2a 2a 20 74 68 65 20 53 51 4c 69 74 65  se.** the SQLite
1b90: 20 70 61 72 73 65 72 20 61 6e 64 20 63 6f 64 65   parser and code
1ba0: 20 67 65 6e 65 72 61 74 6f 72 20 62 75 74 20 73   generator but s
1bb0: 75 62 73 74 69 74 75 74 65 20 74 68 65 69 72 20  ubstitute their 
1bc0: 6f 77 6e 20 73 74 6f 72 61 67 65 0a 2a 2a 20 65  own storage.** e
1bd0: 6e 67 69 6e 65 2e 0a 2a 2f 0a 23 64 65 66 69 6e  ngine..*/.#defin
1be0: 65 20 42 54 52 45 45 5f 48 49 4e 54 5f 52 41 4e  e BTREE_HINT_RAN
1bf0: 47 45 20 30 20 20 20 20 20 20 20 2f 2a 20 52 61  GE 0       /* Ra
1c00: 6e 67 65 20 63 6f 6e 73 74 72 61 69 6e 74 73 20  nge constraints 
1c10: 6f 6e 20 71 75 65 72 69 65 73 20 2a 2f 0a 0a 2f  on queries */../
1c20: 2a 0a 2a 2a 20 56 61 6c 75 65 73 20 74 68 61 74  *.** Values that
1c30: 20 6d 61 79 20 62 65 20 4f 52 27 64 20 74 6f 67   may be OR'd tog
1c40: 65 74 68 65 72 20 74 6f 20 66 6f 72 6d 20 74 68  ether to form th
1c50: 65 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 74 68  e argument to th
1c60: 65 0a 2a 2a 20 42 54 52 45 45 5f 48 49 4e 54 5f  e.** BTREE_HINT_
1c70: 46 4c 41 47 53 20 68 69 6e 74 20 66 6f 72 20 73  FLAGS hint for s
1c80: 71 6c 69 74 65 33 42 74 72 65 65 43 75 72 73 6f  qlite3BtreeCurso
1c90: 72 48 69 6e 74 28 29 3a 0a 2a 2a 0a 2a 2a 20 54  rHint():.**.** T
1ca0: 68 65 20 42 54 52 45 45 5f 42 55 4c 4b 4c 4f 41  he BTREE_BULKLOA
1cb0: 44 20 66 6c 61 67 20 69 73 20 73 65 74 20 6f 6e  D flag is set on
1cc0: 20 69 6e 64 65 78 20 63 75 72 73 6f 72 73 20 77   index cursors w
1cd0: 68 65 6e 20 74 68 65 20 69 6e 64 65 78 20 69 73  hen the index is
1ce0: 20 67 6f 69 6e 67 0a 2a 2a 20 74 6f 20 62 65 20   going.** to be 
1cf0: 66 69 6c 6c 65 64 20 77 69 74 68 20 63 6f 6e 74  filled with cont
1d00: 65 6e 74 20 74 68 61 74 20 69 73 20 61 6c 72 65  ent that is alre
1d10: 61 64 79 20 69 6e 20 73 6f 72 74 65 64 20 6f 72  ady in sorted or
1d20: 64 65 72 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 42  der..**.** The B
1d30: 54 52 45 45 5f 53 45 45 4b 5f 45 51 20 66 6c 61  TREE_SEEK_EQ fla
1d40: 67 20 69 73 20 73 65 74 20 6f 6e 20 63 75 72 73  g is set on curs
1d50: 6f 72 73 20 74 68 61 74 20 77 69 6c 6c 20 67 65  ors that will ge
1d60: 74 20 4f 50 5f 53 65 65 6b 47 45 20 6f 72 0a 2a  t OP_SeekGE or.*
1d70: 2a 20 4f 50 5f 53 65 65 6b 4c 45 20 6f 70 63 6f  * OP_SeekLE opco
1d80: 64 65 73 20 66 6f 72 20 61 20 72 61 6e 67 65 20  des for a range 
1d90: 73 65 61 72 63 68 2c 20 62 75 74 20 77 68 65 72  search, but wher
1da0: 65 20 74 68 65 20 72 61 6e 67 65 20 6f 66 20 65  e the range of e
1db0: 6e 74 72 69 65 73 0a 2a 2a 20 73 65 6c 65 63 74  ntries.** select
1dc0: 65 64 20 77 69 6c 6c 20 61 6c 6c 20 68 61 76 65  ed will all have
1dd0: 20 74 68 65 20 73 61 6d 65 20 6b 65 79 2e 20 20   the same key.  
1de0: 49 6e 20 6f 74 68 65 72 20 77 6f 72 64 73 2c 20  In other words, 
1df0: 74 68 65 20 63 75 72 73 6f 72 20 77 69 6c 6c 0a  the cursor will.
1e00: 2a 2a 20 62 65 20 75 73 65 64 20 6f 6e 6c 79 20  ** be used only 
1e10: 66 6f 72 20 65 71 75 61 6c 69 74 79 20 6b 65 79  for equality key
1e20: 20 73 65 61 72 63 68 65 73 2e 0a 2a 2a 0a 2a 2f   searches..**.*/
1e30: 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f 42  .#define BTREE_B
1e40: 55 4c 4b 4c 4f 41 44 20 30 78 30 30 30 30 30 30  ULKLOAD 0x000000
1e50: 30 31 20 20 2f 2a 20 55 73 65 64 20 74 6f 20 66  01  /* Used to f
1e60: 75 6c 6c 20 69 6e 64 65 78 20 69 6e 20 73 6f 72  ull index in sor
1e70: 74 65 64 20 6f 72 64 65 72 20 2a 2f 0a 23 64 65  ted order */.#de
1e80: 66 69 6e 65 20 42 54 52 45 45 5f 53 45 45 4b 5f  fine BTREE_SEEK_
1e90: 45 51 20 20 30 78 30 30 30 30 30 30 30 32 20 20  EQ  0x00000002  
1ea0: 2f 2a 20 45 51 20 73 65 65 6b 73 20 6f 6e 6c 79  /* EQ seeks only
1eb0: 20 2d 20 6e 6f 20 72 61 6e 67 65 20 73 65 65 6b   - no range seek
1ec0: 73 20 2a 2f 0a 0a 2f 2a 20 0a 2a 2a 20 46 6c 61  s */../* .** Fla
1ed0: 67 73 20 70 61 73 73 65 64 20 61 73 20 74 68 65  gs passed as the
1ee0: 20 74 68 69 72 64 20 61 72 67 75 6d 65 6e 74 20   third argument 
1ef0: 74 6f 20 73 71 6c 69 74 65 33 42 74 72 65 65 43  to sqlite3BtreeC
1f00: 75 72 73 6f 72 28 29 2e 0a 2a 2a 0a 2a 2a 20 46  ursor()..**.** F
1f10: 6f 72 20 72 65 61 64 2d 6f 6e 6c 79 20 63 75 72  or read-only cur
1f20: 73 6f 72 73 20 74 68 65 20 77 72 46 6c 61 67 20  sors the wrFlag 
1f30: 61 72 67 75 6d 65 6e 74 20 69 73 20 61 6c 77 61  argument is alwa
1f40: 79 73 20 7a 65 72 6f 2e 20 46 6f 72 20 72 65 61  ys zero. For rea
1f50: 64 2d 77 72 69 74 65 0a 2a 2a 20 63 75 72 73 6f  d-write.** curso
1f60: 72 73 20 69 74 20 6d 61 79 20 62 65 20 73 65 74  rs it may be set
1f70: 20 74 6f 20 65 69 74 68 65 72 20 28 42 54 52 45   to either (BTRE
1f80: 45 5f 57 52 43 53 52 7c 42 54 52 45 45 5f 46 4f  E_WRCSR|BTREE_FO
1f90: 52 44 45 4c 45 54 45 29 20 6f 72 20 6a 75 73 74  RDELETE) or just
1fa0: 0a 2a 2a 20 28 42 54 52 45 45 5f 57 52 43 53 52  .** (BTREE_WRCSR
1fb0: 29 2e 20 49 66 20 74 68 65 20 42 54 52 45 45 5f  ). If the BTREE_
1fc0: 46 4f 52 44 45 4c 45 54 45 20 62 69 74 20 69 73  FORDELETE bit is
1fd0: 20 73 65 74 2c 20 74 68 65 6e 20 74 68 65 20 63   set, then the c
1fe0: 75 72 73 6f 72 20 77 69 6c 6c 0a 2a 2a 20 6f 6e  ursor will.** on
1ff0: 6c 79 20 62 65 20 75 73 65 64 20 62 79 20 53 51  ly be used by SQ
2000: 4c 69 74 65 20 66 6f 72 20 74 68 65 20 66 6f 6c  Lite for the fol
2010: 6c 6f 77 69 6e 67 3a 0a 2a 2a 0a 2a 2a 20 20 20  lowing:.**.**   
2020: 2a 20 74 6f 20 73 65 65 6b 20 74 6f 20 61 6e 64  * to seek to and
2030: 20 74 68 65 6e 20 64 65 6c 65 74 65 20 73 70 65   then delete spe
2040: 63 69 66 69 63 20 65 6e 74 72 69 65 73 2c 20 61  cific entries, a
2050: 6e 64 2f 6f 72 0a 2a 2a 0a 2a 2a 20 20 20 2a 20  nd/or.**.**   * 
2060: 74 6f 20 72 65 61 64 20 76 61 6c 75 65 73 20 74  to read values t
2070: 68 61 74 20 77 69 6c 6c 20 62 65 20 75 73 65 64  hat will be used
2080: 20 74 6f 20 63 72 65 61 74 65 20 6b 65 79 73 20   to create keys 
2090: 74 68 61 74 20 6f 74 68 65 72 0a 2a 2a 20 20 20  that other.**   
20a0: 20 20 42 54 52 45 45 5f 46 4f 52 44 45 4c 45 54    BTREE_FORDELET
20b0: 45 20 63 75 72 73 6f 72 73 20 77 69 6c 6c 20 73  E cursors will s
20c0: 65 65 6b 20 74 6f 20 61 6e 64 20 64 65 6c 65 74  eek to and delet
20d0: 65 2e 0a 2a 2a 0a 2a 2a 20 54 68 65 20 42 54 52  e..**.** The BTR
20e0: 45 45 5f 46 4f 52 44 45 4c 45 54 45 20 66 6c 61  EE_FORDELETE fla
20f0: 67 20 69 73 20 61 6e 20 6f 70 74 69 6d 69 7a 61  g is an optimiza
2100: 74 69 6f 6e 20 68 69 6e 74 2e 20 20 49 74 20 69  tion hint.  It i
2110: 73 20 6e 6f 74 20 75 73 65 64 20 62 79 0a 2a 2a  s not used by.**
2120: 20 62 79 20 74 68 69 73 2c 20 74 68 65 20 6e 61   by this, the na
2130: 74 69 76 65 20 62 2d 74 72 65 65 20 65 6e 67 69  tive b-tree engi
2140: 6e 65 20 6f 66 20 53 51 4c 69 74 65 2c 20 62 75  ne of SQLite, bu
2150: 74 20 69 74 20 69 73 20 61 76 61 69 6c 61 62 6c  t it is availabl
2160: 65 20 74 6f 0a 2a 2a 20 61 6c 74 65 72 6e 61 74  e to.** alternat
2170: 69 76 65 20 73 74 6f 72 61 67 65 20 65 6e 67 69  ive storage engi
2180: 6e 65 73 20 74 68 61 74 20 6d 69 67 68 74 20 62  nes that might b
2190: 65 20 73 75 62 73 74 69 74 75 74 65 64 20 69 6e  e substituted in
21a0: 20 70 6c 61 63 65 20 6f 66 20 74 68 69 73 0a 2a   place of this.*
21b0: 2a 20 62 2d 74 72 65 65 20 73 79 73 74 65 6d 2e  * b-tree system.
21c0: 20 20 46 6f 72 20 61 6c 74 65 72 6e 61 74 69 76    For alternativ
21d0: 65 20 73 74 6f 72 61 67 65 20 65 6e 67 69 6e 65  e storage engine
21e0: 73 20 69 6e 20 77 68 69 63 68 20 61 20 64 65 6c  s in which a del
21f0: 65 74 65 20 6f 66 0a 2a 2a 20 74 68 65 20 6d 61  ete of.** the ma
2200: 69 6e 20 74 61 62 6c 65 20 72 6f 77 20 61 75 74  in table row aut
2210: 6f 6d 61 74 69 63 61 6c 6c 79 20 64 65 6c 65 74  omatically delet
2220: 65 73 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67  es corresponding
2230: 20 69 6e 64 65 78 20 72 6f 77 73 2c 0a 2a 2a 20   index rows,.** 
2240: 74 68 65 20 46 4f 52 44 45 4c 45 54 45 20 66 6c  the FORDELETE fl
2250: 61 67 20 68 69 6e 74 20 61 6c 6c 6f 77 73 20 74  ag hint allows t
2260: 68 6f 73 65 20 61 6c 74 65 72 6e 61 74 69 76 65  hose alternative
2270: 20 73 74 6f 72 61 67 65 20 65 6e 67 69 6e 65 73   storage engines
2280: 20 74 6f 0a 2a 2a 20 73 6b 69 70 20 61 20 6c 6f   to.** skip a lo
2290: 74 20 6f 66 20 77 6f 72 6b 2e 20 20 4e 61 6d 65  t of work.  Name
22a0: 6c 79 3a 20 20 46 4f 52 44 45 4c 45 54 45 20 63  ly:  FORDELETE c
22b0: 75 72 73 6f 72 73 20 6d 61 79 20 74 72 65 61 74  ursors may treat
22c0: 20 61 6c 6c 20 53 45 45 4b 0a 2a 2a 20 61 6e 64   all SEEK.** and
22d0: 20 44 45 4c 45 54 45 20 6f 70 65 72 61 74 69 6f   DELETE operatio
22e0: 6e 73 20 61 73 20 6e 6f 2d 6f 70 73 2c 20 61 6e  ns as no-ops, an
22f0: 64 20 61 6e 79 20 52 45 41 44 20 6f 70 65 72 61  d any READ opera
2300: 74 69 6f 6e 20 61 67 61 69 6e 73 74 20 61 0a 2a  tion against a.*
2310: 2a 20 46 4f 52 44 45 4c 45 54 45 20 63 75 72 73  * FORDELETE curs
2320: 6f 72 20 6d 61 79 20 72 65 74 75 72 6e 20 61 20  or may return a 
2330: 6e 75 6c 6c 20 72 6f 77 3a 20 30 78 30 31 20 30  null row: 0x01 0
2340: 78 30 30 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20  x00..*/.#define 
2350: 42 54 52 45 45 5f 57 52 43 53 52 20 20 20 20 20  BTREE_WRCSR     
2360: 30 78 30 30 30 30 30 30 30 34 20 20 20 20 20 2f  0x00000004     /
2370: 2a 20 72 65 61 64 2d 77 72 69 74 65 20 63 75 72  * read-write cur
2380: 73 6f 72 20 2a 2f 0a 23 64 65 66 69 6e 65 20 42  sor */.#define B
2390: 54 52 45 45 5f 46 4f 52 44 45 4c 45 54 45 20 30  TREE_FORDELETE 0
23a0: 78 30 30 30 30 30 30 30 38 20 20 20 20 20 2f 2a  x00000008     /*
23b0: 20 43 75 72 73 6f 72 20 69 73 20 66 6f 72 20 73   Cursor is for s
23c0: 65 65 6b 2f 64 65 6c 65 74 65 20 6f 6e 6c 79 20  eek/delete only 
23d0: 2a 2f 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  */..int sqlite3B
23e0: 74 72 65 65 43 75 72 73 6f 72 28 0a 20 20 42 74  treeCursor(.  Bt
23f0: 72 65 65 2a 2c 20 20 20 20 20 20 20 20 20 20 20  ree*,           
2400: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2410: 20 20 20 2f 2a 20 42 54 72 65 65 20 63 6f 6e 74     /* BTree cont
2420: 61 69 6e 69 6e 67 20 74 61 62 6c 65 20 74 6f 20  aining table to 
2430: 6f 70 65 6e 20 2a 2f 0a 20 20 69 6e 74 20 69 54  open */.  int iT
2440: 61 62 6c 65 2c 20 20 20 20 20 20 20 20 20 20 20  able,           
2450: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
2460: 2a 20 49 6e 64 65 78 20 6f 66 20 72 6f 6f 74 20  * Index of root 
2470: 70 61 67 65 20 2a 2f 0a 20 20 69 6e 74 20 77 72  page */.  int wr
2480: 46 6c 61 67 2c 20 20 20 20 20 20 20 20 20 20 20  Flag,           
2490: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
24a0: 2a 20 31 20 66 6f 72 20 77 72 69 74 69 6e 67 2e  * 1 for writing.
24b0: 20 20 30 20 66 6f 72 20 72 65 61 64 2d 6f 6e 6c    0 for read-onl
24c0: 79 20 2a 2f 0a 20 20 73 74 72 75 63 74 20 4b 65  y */.  struct Ke
24d0: 79 49 6e 66 6f 2a 2c 20 20 20 20 20 20 20 20 20  yInfo*,         
24e0: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 46              /* F
24f0: 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f  irst argument to
2500: 20 63 6f 6d 70 61 72 65 20 66 75 6e 63 74 69 6f   compare functio
2510: 6e 20 2a 2f 0a 20 20 42 74 43 75 72 73 6f 72 20  n */.  BtCursor 
2520: 2a 70 43 75 72 73 6f 72 20 20 20 20 20 20 20 20  *pCursor        
2530: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 53              /* S
2540: 70 61 63 65 20 74 6f 20 77 72 69 74 65 20 63 75  pace to write cu
2550: 72 73 6f 72 20 73 74 72 75 63 74 75 72 65 20 2a  rsor structure *
2560: 2f 0a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  /.);.int sqlite3
2570: 42 74 72 65 65 43 75 72 73 6f 72 53 69 7a 65 28  BtreeCursorSize(
2580: 76 6f 69 64 29 3b 0a 76 6f 69 64 20 73 71 6c 69  void);.void sqli
2590: 74 65 33 42 74 72 65 65 43 75 72 73 6f 72 5a 65  te3BtreeCursorZe
25a0: 72 6f 28 42 74 43 75 72 73 6f 72 2a 29 3b 0a 76  ro(BtCursor*);.v
25b0: 6f 69 64 20 73 71 6c 69 74 65 33 42 74 72 65 65  oid sqlite3Btree
25c0: 43 75 72 73 6f 72 48 69 6e 74 46 6c 61 67 73 28  CursorHintFlags(
25d0: 42 74 43 75 72 73 6f 72 2a 2c 20 75 6e 73 69 67  BtCursor*, unsig
25e0: 6e 65 64 29 3b 0a 23 69 66 64 65 66 20 53 51 4c  ned);.#ifdef SQL
25f0: 49 54 45 5f 45 4e 41 42 4c 45 5f 43 55 52 53 4f  ITE_ENABLE_CURSO
2600: 52 5f 48 49 4e 54 53 0a 76 6f 69 64 20 73 71 6c  R_HINTS.void sql
2610: 69 74 65 33 42 74 72 65 65 43 75 72 73 6f 72 48  ite3BtreeCursorH
2620: 69 6e 74 28 42 74 43 75 72 73 6f 72 2a 2c 20 69  int(BtCursor*, i
2630: 6e 74 2c 20 2e 2e 2e 29 3b 0a 23 65 6e 64 69 66  nt, ...);.#endif
2640: 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72  ..int sqlite3Btr
2650: 65 65 43 6c 6f 73 65 43 75 72 73 6f 72 28 42 74  eeCloseCursor(Bt
2660: 43 75 72 73 6f 72 2a 29 3b 0a 69 6e 74 20 73 71  Cursor*);.int sq
2670: 6c 69 74 65 33 42 74 72 65 65 4d 6f 76 65 74 6f  lite3BtreeMoveto
2680: 55 6e 70 61 63 6b 65 64 28 0a 20 20 42 74 43 75  Unpacked(.  BtCu
2690: 72 73 6f 72 2a 2c 0a 20 20 55 6e 70 61 63 6b 65  rsor*,.  Unpacke
26a0: 64 52 65 63 6f 72 64 20 2a 70 55 6e 4b 65 79 2c  dRecord *pUnKey,
26b0: 0a 20 20 69 36 34 20 69 6e 74 4b 65 79 2c 0a 20  .  i64 intKey,. 
26c0: 20 69 6e 74 20 62 69 61 73 2c 0a 20 20 69 6e 74   int bias,.  int
26d0: 20 2a 70 52 65 73 0a 29 3b 0a 69 6e 74 20 73 71   *pRes.);.int sq
26e0: 6c 69 74 65 33 42 74 72 65 65 43 75 72 73 6f 72  lite3BtreeCursor
26f0: 48 61 73 4d 6f 76 65 64 28 42 74 43 75 72 73 6f  HasMoved(BtCurso
2700: 72 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  r*);.int sqlite3
2710: 42 74 72 65 65 43 75 72 73 6f 72 52 65 73 74 6f  BtreeCursorResto
2720: 72 65 28 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e  re(BtCursor*, in
2730: 74 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  t*);.int sqlite3
2740: 42 74 72 65 65 44 65 6c 65 74 65 28 42 74 43 75  BtreeDelete(BtCu
2750: 72 73 6f 72 2a 2c 20 75 38 20 66 6c 61 67 73 29  rsor*, u8 flags)
2760: 3b 0a 0a 2f 2a 20 41 6c 6c 6f 77 65 64 20 66 6c  ;../* Allowed fl
2770: 61 67 73 20 66 6f 72 20 74 68 65 20 32 6e 64 20  ags for the 2nd 
2780: 61 72 67 75 6d 65 6e 74 20 74 6f 20 73 71 6c 69  argument to sqli
2790: 74 65 33 42 74 72 65 65 44 65 6c 65 74 65 28 29  te3BtreeDelete()
27a0: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52 45   */.#define BTRE
27b0: 45 5f 53 41 56 45 50 4f 53 49 54 49 4f 4e 20 30  E_SAVEPOSITION 0
27c0: 78 30 32 20 20 2f 2a 20 4c 65 61 76 65 20 63 75  x02  /* Leave cu
27d0: 72 73 6f 72 20 70 6f 69 6e 74 69 6e 67 20 61 74  rsor pointing at
27e0: 20 4e 45 58 54 20 6f 72 20 50 52 45 56 20 2a 2f   NEXT or PREV */
27f0: 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f 49  .#define BTREE_I
2800: 44 58 44 45 4c 45 54 45 20 20 20 20 30 78 30 34  DXDELETE    0x04
2810: 20 20 2f 2a 20 74 68 69 73 20 69 73 20 69 6e 64    /* this is ind
2820: 65 78 2c 20 74 61 62 6c 65 20 72 6f 77 20 61 6c  ex, table row al
2830: 72 65 61 64 79 20 64 65 6c 65 74 65 64 20 2a 2f  ready deleted */
2840: 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72  ..int sqlite3Btr
2850: 65 65 49 6e 73 65 72 74 28 42 74 43 75 72 73 6f  eeInsert(BtCurso
2860: 72 2a 2c 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a  r*, const void *
2870: 70 4b 65 79 2c 20 69 36 34 20 6e 4b 65 79 2c 0a  pKey, i64 nKey,.
2880: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
2890: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
28a0: 20 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a 70 44    const void *pD
28b0: 61 74 61 2c 20 69 6e 74 20 6e 44 61 74 61 2c 0a  ata, int nData,.
28c0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
28d0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
28e0: 20 20 69 6e 74 20 6e 5a 65 72 6f 2c 20 69 6e 74    int nZero, int
28f0: 20 62 69 61 73 2c 20 69 6e 74 20 73 65 65 6b 52   bias, int seekR
2900: 65 73 75 6c 74 29 3b 0a 69 6e 74 20 73 71 6c 69  esult);.int sqli
2910: 74 65 33 42 74 72 65 65 46 69 72 73 74 28 42 74  te3BtreeFirst(Bt
2920: 43 75 72 73 6f 72 2a 2c 20 69 6e 74 20 2a 70 52  Cursor*, int *pR
2930: 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33  es);.int sqlite3
2940: 42 74 72 65 65 4c 61 73 74 28 42 74 43 75 72 73  BtreeLast(BtCurs
2950: 6f 72 2a 2c 20 69 6e 74 20 2a 70 52 65 73 29 3b  or*, int *pRes);
2960: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65  .int sqlite3Btre
2970: 65 4e 65 78 74 28 42 74 43 75 72 73 6f 72 2a 2c  eNext(BtCursor*,
2980: 20 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69 6e 74   int *pRes);.int
2990: 20 73 71 6c 69 74 65 33 42 74 72 65 65 45 6f 66   sqlite3BtreeEof
29a0: 28 42 74 43 75 72 73 6f 72 2a 29 3b 0a 69 6e 74  (BtCursor*);.int
29b0: 20 73 71 6c 69 74 65 33 42 74 72 65 65 50 72 65   sqlite3BtreePre
29c0: 76 69 6f 75 73 28 42 74 43 75 72 73 6f 72 2a 2c  vious(BtCursor*,
29d0: 20 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69 6e 74   int *pRes);.int
29e0: 20 73 71 6c 69 74 65 33 42 74 72 65 65 4b 65 79   sqlite3BtreeKey
29f0: 53 69 7a 65 28 42 74 43 75 72 73 6f 72 2a 2c 20  Size(BtCursor*, 
2a00: 69 36 34 20 2a 70 53 69 7a 65 29 3b 0a 69 6e 74  i64 *pSize);.int
2a10: 20 73 71 6c 69 74 65 33 42 74 72 65 65 4b 65 79   sqlite3BtreeKey
2a20: 28 42 74 43 75 72 73 6f 72 2a 2c 20 75 33 32 20  (BtCursor*, u32 
2a30: 6f 66 66 73 65 74 2c 20 75 33 32 20 61 6d 74 2c  offset, u32 amt,
2a40: 20 76 6f 69 64 2a 29 3b 0a 63 6f 6e 73 74 20 76   void*);.const v
2a50: 6f 69 64 20 2a 73 71 6c 69 74 65 33 42 74 72 65  oid *sqlite3Btre
2a60: 65 4b 65 79 46 65 74 63 68 28 42 74 43 75 72 73  eKeyFetch(BtCurs
2a70: 6f 72 2a 2c 20 75 33 32 20 2a 70 41 6d 74 29 3b  or*, u32 *pAmt);
2a80: 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71 6c  .const void *sql
2a90: 69 74 65 33 42 74 72 65 65 44 61 74 61 46 65 74  ite3BtreeDataFet
2aa0: 63 68 28 42 74 43 75 72 73 6f 72 2a 2c 20 75 33  ch(BtCursor*, u3
2ab0: 32 20 2a 70 41 6d 74 29 3b 0a 69 6e 74 20 73 71  2 *pAmt);.int sq
2ac0: 6c 69 74 65 33 42 74 72 65 65 44 61 74 61 53 69  lite3BtreeDataSi
2ad0: 7a 65 28 42 74 43 75 72 73 6f 72 2a 2c 20 75 33  ze(BtCursor*, u3
2ae0: 32 20 2a 70 53 69 7a 65 29 3b 0a 69 6e 74 20 73  2 *pSize);.int s
2af0: 71 6c 69 74 65 33 42 74 72 65 65 44 61 74 61 28  qlite3BtreeData(
2b00: 42 74 43 75 72 73 6f 72 2a 2c 20 75 33 32 20 6f  BtCursor*, u32 o
2b10: 66 66 73 65 74 2c 20 75 33 32 20 61 6d 74 2c 20  ffset, u32 amt, 
2b20: 76 6f 69 64 2a 29 3b 0a 0a 63 68 61 72 20 2a 73  void*);..char *s
2b30: 71 6c 69 74 65 33 42 74 72 65 65 49 6e 74 65 67  qlite3BtreeInteg
2b40: 72 69 74 79 43 68 65 63 6b 28 42 74 72 65 65 2a  rityCheck(Btree*
2b50: 2c 20 69 6e 74 20 2a 61 52 6f 6f 74 2c 20 69 6e  , int *aRoot, in
2b60: 74 20 6e 52 6f 6f 74 2c 20 69 6e 74 2c 20 69 6e  t nRoot, int, in
2b70: 74 2a 29 3b 0a 73 74 72 75 63 74 20 50 61 67 65  t*);.struct Page
2b80: 72 20 2a 73 71 6c 69 74 65 33 42 74 72 65 65 50  r *sqlite3BtreeP
2b90: 61 67 65 72 28 42 74 72 65 65 2a 29 3b 0a 0a 69  ager(Btree*);..i
2ba0: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 50  nt sqlite3BtreeP
2bb0: 75 74 44 61 74 61 28 42 74 43 75 72 73 6f 72 2a  utData(BtCursor*
2bc0: 2c 20 75 33 32 20 6f 66 66 73 65 74 2c 20 75 33  , u32 offset, u3
2bd0: 32 20 61 6d 74 2c 20 76 6f 69 64 2a 29 3b 0a 76  2 amt, void*);.v
2be0: 6f 69 64 20 73 71 6c 69 74 65 33 42 74 72 65 65  oid sqlite3Btree
2bf0: 49 6e 63 72 62 6c 6f 62 43 75 72 73 6f 72 28 42  IncrblobCursor(B
2c00: 74 43 75 72 73 6f 72 20 2a 29 3b 0a 76 6f 69 64  tCursor *);.void
2c10: 20 73 71 6c 69 74 65 33 42 74 72 65 65 43 6c 65   sqlite3BtreeCle
2c20: 61 72 43 75 72 73 6f 72 28 42 74 43 75 72 73 6f  arCursor(BtCurso
2c30: 72 20 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  r *);.int sqlite
2c40: 33 42 74 72 65 65 53 65 74 56 65 72 73 69 6f 6e  3BtreeSetVersion
2c50: 28 42 74 72 65 65 20 2a 70 42 74 2c 20 69 6e 74  (Btree *pBt, int
2c60: 20 69 56 65 72 73 69 6f 6e 29 3b 0a 69 6e 74 20   iVersion);.int 
2c70: 73 71 6c 69 74 65 33 42 74 72 65 65 43 75 72 73  sqlite3BtreeCurs
2c80: 6f 72 48 61 73 48 69 6e 74 28 42 74 43 75 72 73  orHasHint(BtCurs
2c90: 6f 72 2a 2c 20 75 6e 73 69 67 6e 65 64 20 69 6e  or*, unsigned in
2ca0: 74 20 6d 61 73 6b 29 3b 0a 69 6e 74 20 73 71 6c  t mask);.int sql
2cb0: 69 74 65 33 42 74 72 65 65 49 73 52 65 61 64 6f  ite3BtreeIsReado
2cc0: 6e 6c 79 28 42 74 72 65 65 20 2a 70 42 74 29 3b  nly(Btree *pBt);
2cd0: 0a 69 6e 74 20 73 71 6c 69 74 65 33 48 65 61 64  .int sqlite3Head
2ce0: 65 72 53 69 7a 65 42 74 72 65 65 28 76 6f 69 64  erSizeBtree(void
2cf0: 29 3b 0a 0a 23 69 66 6e 64 65 66 20 4e 44 45 42  );..#ifndef NDEB
2d00: 55 47 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  UG.int sqlite3Bt
2d10: 72 65 65 43 75 72 73 6f 72 49 73 56 61 6c 69 64  reeCursorIsValid
2d20: 28 42 74 43 75 72 73 6f 72 2a 29 3b 0a 23 65 6e  (BtCursor*);.#en
2d30: 64 69 66 0a 0a 23 69 66 6e 64 65 66 20 53 51 4c  dif..#ifndef SQL
2d40: 49 54 45 5f 4f 4d 49 54 5f 42 54 52 45 45 43 4f  ITE_OMIT_BTREECO
2d50: 55 4e 54 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  UNT.int sqlite3B
2d60: 74 72 65 65 43 6f 75 6e 74 28 42 74 43 75 72 73  treeCount(BtCurs
2d70: 6f 72 20 2a 2c 20 69 36 34 20 2a 29 3b 0a 23 65  or *, i64 *);.#e
2d80: 6e 64 69 66 0a 0a 23 69 66 64 65 66 20 53 51 4c  ndif..#ifdef SQL
2d90: 49 54 45 5f 54 45 53 54 0a 69 6e 74 20 73 71 6c  ITE_TEST.int sql
2da0: 69 74 65 33 42 74 72 65 65 43 75 72 73 6f 72 49  ite3BtreeCursorI
2db0: 6e 66 6f 28 42 74 43 75 72 73 6f 72 2a 2c 20 69  nfo(BtCursor*, i
2dc0: 6e 74 2a 2c 20 69 6e 74 29 3b 0a 76 6f 69 64 20  nt*, int);.void 
2dd0: 73 71 6c 69 74 65 33 42 74 72 65 65 43 75 72 73  sqlite3BtreeCurs
2de0: 6f 72 4c 69 73 74 28 42 74 72 65 65 2a 29 3b 0a  orList(Btree*);.
2df0: 23 65 6e 64 69 66 0a 0a 23 69 66 6e 64 65 66 20  #endif..#ifndef 
2e00: 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 57 41 4c 0a  SQLITE_OMIT_WAL.
2e10: 20 20 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72    int sqlite3Btr
2e20: 65 65 43 68 65 63 6b 70 6f 69 6e 74 28 42 74 72  eeCheckpoint(Btr
2e30: 65 65 2a 2c 20 69 6e 74 2c 20 69 6e 74 20 2a 2c  ee*, int, int *,
2e40: 20 69 6e 74 20 2a 29 3b 0a 23 65 6e 64 69 66 0a   int *);.#endif.
2e50: 0a 2f 2a 0a 2a 2a 20 49 66 20 77 65 20 61 72 65  ./*.** If we are
2e60: 20 6e 6f 74 20 75 73 69 6e 67 20 73 68 61 72 65   not using share
2e70: 64 20 63 61 63 68 65 2c 20 74 68 65 6e 20 74 68  d cache, then th
2e80: 65 72 65 20 69 73 20 6e 6f 20 6e 65 65 64 20 74  ere is no need t
2e90: 6f 0a 2a 2a 20 75 73 65 20 6d 75 74 65 78 65 73  o.** use mutexes
2ea0: 20 74 6f 20 61 63 63 65 73 73 20 74 68 65 20 42   to access the B
2eb0: 74 53 68 61 72 65 64 20 73 74 72 75 63 74 75 72  tShared structur
2ec0: 65 73 2e 20 20 53 6f 20 6d 61 6b 65 20 74 68 65  es.  So make the
2ed0: 0a 2a 2a 20 45 6e 74 65 72 20 61 6e 64 20 4c 65  .** Enter and Le
2ee0: 61 76 65 20 70 72 6f 63 65 64 75 72 65 73 20 6e  ave procedures n
2ef0: 6f 2d 6f 70 73 2e 0a 2a 2f 0a 23 69 66 6e 64 65  o-ops..*/.#ifnde
2f00: 66 20 53 51 4c 49 54 45 5f 4f 4d 49 54 5f 53 48  f SQLITE_OMIT_SH
2f10: 41 52 45 44 5f 43 41 43 48 45 0a 20 20 76 6f 69  ARED_CACHE.  voi
2f20: 64 20 73 71 6c 69 74 65 33 42 74 72 65 65 45 6e  d sqlite3BtreeEn
2f30: 74 65 72 28 42 74 72 65 65 2a 29 3b 0a 20 20 76  ter(Btree*);.  v
2f40: 6f 69 64 20 73 71 6c 69 74 65 33 42 74 72 65 65  oid sqlite3Btree
2f50: 45 6e 74 65 72 41 6c 6c 28 73 71 6c 69 74 65 33  EnterAll(sqlite3
2f60: 2a 29 3b 0a 20 20 69 6e 74 20 73 71 6c 69 74 65  *);.  int sqlite
2f70: 33 42 74 72 65 65 53 68 61 72 61 62 6c 65 28 42  3BtreeSharable(B
2f80: 74 72 65 65 2a 29 3b 0a 20 20 76 6f 69 64 20 73  tree*);.  void s
2f90: 71 6c 69 74 65 33 42 74 72 65 65 45 6e 74 65 72  qlite3BtreeEnter
2fa0: 43 75 72 73 6f 72 28 42 74 43 75 72 73 6f 72 2a  Cursor(BtCursor*
2fb0: 29 3b 0a 23 65 6c 73 65 0a 23 20 64 65 66 69 6e  );.#else.# defin
2fc0: 65 20 73 71 6c 69 74 65 33 42 74 72 65 65 45 6e  e sqlite3BtreeEn
2fd0: 74 65 72 28 58 29 20 0a 23 20 64 65 66 69 6e 65  ter(X) .# define
2fe0: 20 73 71 6c 69 74 65 33 42 74 72 65 65 45 6e 74   sqlite3BtreeEnt
2ff0: 65 72 41 6c 6c 28 58 29 0a 23 20 64 65 66 69 6e  erAll(X).# defin
3000: 65 20 73 71 6c 69 74 65 33 42 74 72 65 65 53 68  e sqlite3BtreeSh
3010: 61 72 61 62 6c 65 28 58 29 20 30 0a 23 20 64 65  arable(X) 0.# de
3020: 66 69 6e 65 20 73 71 6c 69 74 65 33 42 74 72 65  fine sqlite3Btre
3030: 65 45 6e 74 65 72 43 75 72 73 6f 72 28 58 29 0a  eEnterCursor(X).
3040: 23 65 6e 64 69 66 0a 0a 23 69 66 20 21 64 65 66  #endif..#if !def
3050: 69 6e 65 64 28 53 51 4c 49 54 45 5f 4f 4d 49 54  ined(SQLITE_OMIT
3060: 5f 53 48 41 52 45 44 5f 43 41 43 48 45 29 20 26  _SHARED_CACHE) &
3070: 26 20 53 51 4c 49 54 45 5f 54 48 52 45 41 44 53  & SQLITE_THREADS
3080: 41 46 45 0a 20 20 76 6f 69 64 20 73 71 6c 69 74  AFE.  void sqlit
3090: 65 33 42 74 72 65 65 4c 65 61 76 65 28 42 74 72  e3BtreeLeave(Btr
30a0: 65 65 2a 29 3b 0a 20 20 76 6f 69 64 20 73 71 6c  ee*);.  void sql
30b0: 69 74 65 33 42 74 72 65 65 4c 65 61 76 65 43 75  ite3BtreeLeaveCu
30c0: 72 73 6f 72 28 42 74 43 75 72 73 6f 72 2a 29 3b  rsor(BtCursor*);
30d0: 0a 20 20 76 6f 69 64 20 73 71 6c 69 74 65 33 42  .  void sqlite3B
30e0: 74 72 65 65 4c 65 61 76 65 41 6c 6c 28 73 71 6c  treeLeaveAll(sql
30f0: 69 74 65 33 2a 29 3b 0a 23 69 66 6e 64 65 66 20  ite3*);.#ifndef 
3100: 4e 44 45 42 55 47 0a 20 20 2f 2a 20 54 68 65 73  NDEBUG.  /* Thes
3110: 65 20 72 6f 75 74 69 6e 65 73 20 61 72 65 20 75  e routines are u
3120: 73 65 64 20 69 6e 73 69 64 65 20 61 73 73 65 72  sed inside asser
3130: 74 28 29 20 73 74 61 74 65 6d 65 6e 74 73 20 6f  t() statements o
3140: 6e 6c 79 2e 20 2a 2f 0a 20 20 69 6e 74 20 73 71  nly. */.  int sq
3150: 6c 69 74 65 33 42 74 72 65 65 48 6f 6c 64 73 4d  lite3BtreeHoldsM
3160: 75 74 65 78 28 42 74 72 65 65 2a 29 3b 0a 20 20  utex(Btree*);.  
3170: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
3180: 48 6f 6c 64 73 41 6c 6c 4d 75 74 65 78 65 73 28  HoldsAllMutexes(
3190: 73 71 6c 69 74 65 33 2a 29 3b 0a 20 20 69 6e 74  sqlite3*);.  int
31a0: 20 73 71 6c 69 74 65 33 53 63 68 65 6d 61 4d 75   sqlite3SchemaMu
31b0: 74 65 78 48 65 6c 64 28 73 71 6c 69 74 65 33 2a  texHeld(sqlite3*
31c0: 2c 69 6e 74 2c 53 63 68 65 6d 61 2a 29 3b 0a 23  ,int,Schema*);.#
31d0: 65 6e 64 69 66 0a 23 65 6c 73 65 0a 0a 23 20 64  endif.#else..# d
31e0: 65 66 69 6e 65 20 73 71 6c 69 74 65 33 42 74 72  efine sqlite3Btr
31f0: 65 65 4c 65 61 76 65 28 58 29 0a 23 20 64 65 66  eeLeave(X).# def
3200: 69 6e 65 20 73 71 6c 69 74 65 33 42 74 72 65 65  ine sqlite3Btree
3210: 4c 65 61 76 65 43 75 72 73 6f 72 28 58 29 0a 23  LeaveCursor(X).#
3220: 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 42   define sqlite3B
3230: 74 72 65 65 4c 65 61 76 65 41 6c 6c 28 58 29 0a  treeLeaveAll(X).
3240: 0a 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65  .# define sqlite
3250: 33 42 74 72 65 65 48 6f 6c 64 73 4d 75 74 65 78  3BtreeHoldsMutex
3260: 28 58 29 20 31 0a 23 20 64 65 66 69 6e 65 20 73  (X) 1.# define s
3270: 71 6c 69 74 65 33 42 74 72 65 65 48 6f 6c 64 73  qlite3BtreeHolds
3280: 41 6c 6c 4d 75 74 65 78 65 73 28 58 29 20 31 0a  AllMutexes(X) 1.
3290: 23 20 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33  # define sqlite3
32a0: 53 63 68 65 6d 61 4d 75 74 65 78 48 65 6c 64 28  SchemaMutexHeld(
32b0: 58 2c 59 2c 5a 29 20 31 0a 23 65 6e 64 69 66 0a  X,Y,Z) 1.#endif.
32c0: 0a 0a 23 65 6e 64 69 66 20 2f 2a 20 5f 42 54 52  ..#endif /* _BTR
32d0: 45 45 5f 48 5f 20 2a 2f 0a                       EE_H_ */.