/ Hex Artifact Content
Login

Artifact 845543b5a53d5d8a80ea14aeeb521276602317b7:


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: 2a 0a 2a 2a 20 40 28 23 29 20 24 49 64 3a 20 62  *.** @(#) $Id: b
0240: 74 72 65 65 2e 68 2c 76 20 31 2e 38 30 20 32 30  tree.h,v 1.80 20
0250: 30 37 2f 30 35 2f 30 35 20 31 38 3a 34 39 3a 35  07/05/05 18:49:5
0260: 33 20 64 72 68 20 45 78 70 20 24 0a 2a 2f 0a 23  3 drh Exp $.*/.#
0270: 69 66 6e 64 65 66 20 5f 42 54 52 45 45 5f 48 5f  ifndef _BTREE_H_
0280: 0a 23 64 65 66 69 6e 65 20 5f 42 54 52 45 45 5f  .#define _BTREE_
0290: 48 5f 0a 0a 2f 2a 20 54 4f 44 4f 3a 20 54 68 69  H_../* TODO: Thi
02a0: 73 20 64 65 66 69 6e 69 74 69 6f 6e 20 69 73 20  s definition is 
02b0: 6a 75 73 74 20 69 6e 63 6c 75 64 65 64 20 73 6f  just included so
02c0: 20 6f 74 68 65 72 20 6d 6f 64 75 6c 65 73 20 63   other modules c
02d0: 6f 6d 70 69 6c 65 2e 20 49 74 0a 2a 2a 20 6e 65  ompile. It.** ne
02e0: 65 64 73 20 74 6f 20 62 65 20 72 65 76 69 73 69  eds to be revisi
02f0: 74 65 64 2e 0a 2a 2f 0a 23 64 65 66 69 6e 65 20  ted..*/.#define 
0300: 53 51 4c 49 54 45 5f 4e 5f 42 54 52 45 45 5f 4d  SQLITE_N_BTREE_M
0310: 45 54 41 20 31 30 0a 0a 2f 2a 0a 2a 2a 20 49 66  ETA 10../*.** If
0320: 20 64 65 66 69 6e 65 64 20 61 73 20 6e 6f 6e 2d   defined as non-
0330: 7a 65 72 6f 2c 20 61 75 74 6f 2d 76 61 63 75 75  zero, auto-vacuu
0340: 6d 20 69 73 20 65 6e 61 62 6c 65 64 20 62 79 20  m is enabled by 
0350: 64 65 66 61 75 6c 74 2e 20 4f 74 68 65 72 77 69  default. Otherwi
0360: 73 65 0a 2a 2a 20 69 74 20 6d 75 73 74 20 62 65  se.** it must be
0370: 20 74 75 72 6e 65 64 20 6f 6e 20 66 6f 72 20 65   turned on for e
0380: 61 63 68 20 64 61 74 61 62 61 73 65 20 75 73 69  ach database usi
0390: 6e 67 20 22 50 52 41 47 4d 41 20 61 75 74 6f 5f  ng "PRAGMA auto_
03a0: 76 61 63 75 75 6d 20 3d 20 31 22 2e 0a 2a 2f 0a  vacuum = 1"..*/.
03b0: 23 69 66 6e 64 65 66 20 53 51 4c 49 54 45 5f 44  #ifndef SQLITE_D
03c0: 45 46 41 55 4c 54 5f 41 55 54 4f 56 41 43 55 55  EFAULT_AUTOVACUU
03d0: 4d 0a 20 20 23 64 65 66 69 6e 65 20 53 51 4c 49  M.  #define SQLI
03e0: 54 45 5f 44 45 46 41 55 4c 54 5f 41 55 54 4f 56  TE_DEFAULT_AUTOV
03f0: 41 43 55 55 4d 20 30 0a 23 65 6e 64 69 66 0a 0a  ACUUM 0.#endif..
0400: 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f 41 55  #define BTREE_AU
0410: 54 4f 56 41 43 55 55 4d 5f 4e 4f 4e 45 20 30 20  TOVACUUM_NONE 0 
0420: 20 20 20 20 20 20 20 2f 2a 20 44 6f 20 6e 6f 74         /* Do not
0430: 20 64 6f 20 61 75 74 6f 2d 76 61 63 75 75 6d 20   do auto-vacuum 
0440: 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45  */.#define BTREE
0450: 5f 41 55 54 4f 56 41 43 55 55 4d 5f 46 55 4c 4c  _AUTOVACUUM_FULL
0460: 20 31 20 20 20 20 20 20 20 20 2f 2a 20 44 6f 20   1        /* Do 
0470: 66 75 6c 6c 20 61 75 74 6f 2d 76 61 63 75 75 6d  full auto-vacuum
0480: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52 45   */.#define BTRE
0490: 45 5f 41 55 54 4f 56 41 43 55 55 4d 5f 49 4e 43  E_AUTOVACUUM_INC
04a0: 52 20 32 20 20 20 20 20 20 20 20 2f 2a 20 49 6e  R 2        /* In
04b0: 63 72 65 6d 65 6e 74 61 6c 20 76 61 63 75 75 6d  cremental vacuum
04c0: 20 2a 2f 0a 0a 2f 2a 0a 2a 2a 20 46 6f 72 77 61   */../*.** Forwa
04d0: 72 64 20 64 65 63 6c 61 72 61 74 69 6f 6e 73 20  rd declarations 
04e0: 6f 66 20 73 74 72 75 63 74 75 72 65 0a 2a 2f 0a  of structure.*/.
04f0: 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20 42  typedef struct B
0500: 74 72 65 65 20 42 74 72 65 65 3b 0a 74 79 70 65  tree Btree;.type
0510: 64 65 66 20 73 74 72 75 63 74 20 42 74 43 75 72  def struct BtCur
0520: 73 6f 72 20 42 74 43 75 72 73 6f 72 3b 0a 74 79  sor BtCursor;.ty
0530: 70 65 64 65 66 20 73 74 72 75 63 74 20 42 74 53  pedef struct BtS
0540: 68 61 72 65 64 20 42 74 53 68 61 72 65 64 3b 0a  hared BtShared;.
0550: 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72  ..int sqlite3Btr
0560: 65 65 4f 70 65 6e 28 0a 20 20 63 6f 6e 73 74 20  eeOpen(.  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 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20  *,              
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 20 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 29 3b 0a 0a 2f 2a 20 54 68  ags */.);../* Th
0650: 65 20 66 6c 61 67 73 20 70 61 72 61 6d 65 74 65  e flags paramete
0660: 72 20 74 6f 20 73 71 6c 69 74 65 33 42 74 72 65  r to sqlite3Btre
0670: 65 4f 70 65 6e 20 63 61 6e 20 62 65 20 74 68 65  eOpen can be the
0680: 20 62 69 74 77 69 73 65 20 6f 72 20 6f 66 20 74   bitwise or of t
0690: 68 65 0a 2a 2a 20 66 6f 6c 6c 6f 77 69 6e 67 20  he.** following 
06a0: 76 61 6c 75 65 73 2e 0a 2a 2a 0a 2a 2a 20 4e 4f  values..**.** NO
06b0: 54 45 3a 20 20 54 68 65 73 65 20 76 61 6c 75 65  TE:  These value
06c0: 73 20 6d 75 73 74 20 6d 61 74 63 68 20 74 68 65  s must match the
06d0: 20 63 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20 50   corresponding P
06e0: 41 47 45 52 5f 20 76 61 6c 75 65 73 20 69 6e 0a  AGER_ values in.
06f0: 2a 2a 20 70 61 67 65 72 2e 68 2e 0a 2a 2f 0a 23  ** pager.h..*/.#
0700: 64 65 66 69 6e 65 20 42 54 52 45 45 5f 4f 4d 49  define BTREE_OMI
0710: 54 5f 4a 4f 55 52 4e 41 4c 20 20 31 20 20 2f 2a  T_JOURNAL  1  /*
0720: 20 44 6f 20 6e 6f 74 20 75 73 65 20 6a 6f 75 72   Do not use jour
0730: 6e 61 6c 2e 20 20 4e 6f 20 61 72 67 75 6d 65 6e  nal.  No argumen
0740: 74 20 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52  t */.#define BTR
0750: 45 45 5f 4e 4f 5f 52 45 41 44 4c 4f 43 4b 20 20  EE_NO_READLOCK  
0760: 20 32 20 20 2f 2a 20 4f 6d 69 74 20 72 65 61 64   2  /* Omit read
0770: 6c 6f 63 6b 73 20 6f 6e 20 72 65 61 64 6f 6e 6c  locks on readonl
0780: 79 20 66 69 6c 65 73 20 2a 2f 0a 23 64 65 66 69  y files */.#defi
0790: 6e 65 20 42 54 52 45 45 5f 4d 45 4d 4f 52 59 20  ne BTREE_MEMORY 
07a0: 20 20 20 20 20 20 20 34 20 20 2f 2a 20 49 6e 2d         4  /* In-
07b0: 6d 65 6d 6f 72 79 20 44 42 2e 20 20 4e 6f 20 61  memory DB.  No a
07c0: 72 67 75 6d 65 6e 74 20 2a 2f 0a 0a 69 6e 74 20  rgument */..int 
07d0: 73 71 6c 69 74 65 33 42 74 72 65 65 43 6c 6f 73  sqlite3BtreeClos
07e0: 65 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73  e(Btree*);.int s
07f0: 71 6c 69 74 65 33 42 74 72 65 65 53 65 74 42 75  qlite3BtreeSetBu
0800: 73 79 48 61 6e 64 6c 65 72 28 42 74 72 65 65 2a  syHandler(Btree*
0810: 2c 42 75 73 79 48 61 6e 64 6c 65 72 2a 29 3b 0a  ,BusyHandler*);.
0820: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
0830: 53 65 74 43 61 63 68 65 53 69 7a 65 28 42 74 72  SetCacheSize(Btr
0840: 65 65 2a 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71  ee*,int);.int sq
0850: 6c 69 74 65 33 42 74 72 65 65 53 65 74 53 61 66  lite3BtreeSetSaf
0860: 65 74 79 4c 65 76 65 6c 28 42 74 72 65 65 2a 2c  etyLevel(Btree*,
0870: 69 6e 74 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71  int,int);.int sq
0880: 6c 69 74 65 33 42 74 72 65 65 53 79 6e 63 44 69  lite3BtreeSyncDi
0890: 73 61 62 6c 65 64 28 42 74 72 65 65 2a 29 3b 0a  sabled(Btree*);.
08a0: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
08b0: 53 65 74 50 61 67 65 53 69 7a 65 28 42 74 72 65  SetPageSize(Btre
08c0: 65 2a 2c 69 6e 74 2c 69 6e 74 29 3b 0a 69 6e 74  e*,int,int);.int
08d0: 20 73 71 6c 69 74 65 33 42 74 72 65 65 47 65 74   sqlite3BtreeGet
08e0: 50 61 67 65 53 69 7a 65 28 42 74 72 65 65 2a 29  PageSize(Btree*)
08f0: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72  ;.int sqlite3Btr
0900: 65 65 47 65 74 52 65 73 65 72 76 65 28 42 74 72  eeGetReserve(Btr
0910: 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  ee*);.int sqlite
0920: 33 42 74 72 65 65 53 65 74 41 75 74 6f 56 61 63  3BtreeSetAutoVac
0930: 75 75 6d 28 42 74 72 65 65 20 2a 2c 20 69 6e 74  uum(Btree *, int
0940: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
0950: 72 65 65 47 65 74 41 75 74 6f 56 61 63 75 75 6d  reeGetAutoVacuum
0960: 28 42 74 72 65 65 20 2a 29 3b 0a 69 6e 74 20 73  (Btree *);.int s
0970: 71 6c 69 74 65 33 42 74 72 65 65 42 65 67 69 6e  qlite3BtreeBegin
0980: 54 72 61 6e 73 28 42 74 72 65 65 2a 2c 69 6e 74  Trans(Btree*,int
0990: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
09a0: 72 65 65 43 6f 6d 6d 69 74 50 68 61 73 65 4f 6e  reeCommitPhaseOn
09b0: 65 28 42 74 72 65 65 2a 2c 20 63 6f 6e 73 74 20  e(Btree*, const 
09c0: 63 68 61 72 20 2a 7a 4d 61 73 74 65 72 29 3b 0a  char *zMaster);.
09d0: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
09e0: 43 6f 6d 6d 69 74 50 68 61 73 65 54 77 6f 28 42  CommitPhaseTwo(B
09f0: 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69  tree*);.int sqli
0a00: 74 65 33 42 74 72 65 65 43 6f 6d 6d 69 74 28 42  te3BtreeCommit(B
0a10: 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69  tree*);.int sqli
0a20: 74 65 33 42 74 72 65 65 52 6f 6c 6c 62 61 63 6b  te3BtreeRollback
0a30: 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71  (Btree*);.int sq
0a40: 6c 69 74 65 33 42 74 72 65 65 42 65 67 69 6e 53  lite3BtreeBeginS
0a50: 74 6d 74 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74  tmt(Btree*);.int
0a60: 20 73 71 6c 69 74 65 33 42 74 72 65 65 43 6f 6d   sqlite3BtreeCom
0a70: 6d 69 74 53 74 6d 74 28 42 74 72 65 65 2a 29 3b  mitStmt(Btree*);
0a80: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65  .int sqlite3Btre
0a90: 65 52 6f 6c 6c 62 61 63 6b 53 74 6d 74 28 42 74  eRollbackStmt(Bt
0aa0: 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74  ree*);.int sqlit
0ab0: 65 33 42 74 72 65 65 43 72 65 61 74 65 54 61 62  e3BtreeCreateTab
0ac0: 6c 65 28 42 74 72 65 65 2a 2c 20 69 6e 74 2a 2c  le(Btree*, int*,
0ad0: 20 69 6e 74 20 66 6c 61 67 73 29 3b 0a 69 6e 74   int flags);.int
0ae0: 20 73 71 6c 69 74 65 33 42 74 72 65 65 49 73 49   sqlite3BtreeIsI
0af0: 6e 54 72 61 6e 73 28 42 74 72 65 65 2a 29 3b 0a  nTrans(Btree*);.
0b00: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
0b10: 49 73 49 6e 53 74 6d 74 28 42 74 72 65 65 2a 29  IsInStmt(Btree*)
0b20: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72  ;.int sqlite3Btr
0b30: 65 65 49 73 49 6e 52 65 61 64 54 72 61 6e 73 28  eeIsInReadTrans(
0b40: 42 74 72 65 65 2a 29 3b 0a 76 6f 69 64 20 2a 73  Btree*);.void *s
0b50: 71 6c 69 74 65 33 42 74 72 65 65 53 63 68 65 6d  qlite3BtreeSchem
0b60: 61 28 42 74 72 65 65 20 2a 2c 20 69 6e 74 2c 20  a(Btree *, int, 
0b70: 76 6f 69 64 28 2a 29 28 76 6f 69 64 20 2a 29 29  void(*)(void *))
0b80: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72  ;.int sqlite3Btr
0b90: 65 65 53 63 68 65 6d 61 4c 6f 63 6b 65 64 28 42  eeSchemaLocked(B
0ba0: 74 72 65 65 20 2a 29 3b 0a 69 6e 74 20 73 71 6c  tree *);.int sql
0bb0: 69 74 65 33 42 74 72 65 65 4c 6f 63 6b 54 61 62  ite3BtreeLockTab
0bc0: 6c 65 28 42 74 72 65 65 20 2a 2c 20 69 6e 74 2c  le(Btree *, int,
0bd0: 20 75 38 29 3b 0a 0a 63 6f 6e 73 74 20 63 68 61   u8);..const cha
0be0: 72 20 2a 73 71 6c 69 74 65 33 42 74 72 65 65 47  r *sqlite3BtreeG
0bf0: 65 74 46 69 6c 65 6e 61 6d 65 28 42 74 72 65 65  etFilename(Btree
0c00: 20 2a 29 3b 0a 63 6f 6e 73 74 20 63 68 61 72 20   *);.const char 
0c10: 2a 73 71 6c 69 74 65 33 42 74 72 65 65 47 65 74  *sqlite3BtreeGet
0c20: 44 69 72 6e 61 6d 65 28 42 74 72 65 65 20 2a 29  Dirname(Btree *)
0c30: 3b 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 71  ;.const char *sq
0c40: 6c 69 74 65 33 42 74 72 65 65 47 65 74 4a 6f 75  lite3BtreeGetJou
0c50: 72 6e 61 6c 6e 61 6d 65 28 42 74 72 65 65 20 2a  rnalname(Btree *
0c60: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
0c70: 72 65 65 43 6f 70 79 46 69 6c 65 28 42 74 72 65  reeCopyFile(Btre
0c80: 65 20 2a 2c 20 42 74 72 65 65 20 2a 29 3b 0a 0a  e *, Btree *);..
0c90: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
0ca0: 49 6e 63 72 56 61 63 75 75 6d 28 42 74 72 65 65  IncrVacuum(Btree
0cb0: 20 2a 29 3b 0a 0a 2f 2a 20 54 68 65 20 66 6c 61   *);../* The fla
0cc0: 67 73 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20  gs parameter to 
0cd0: 73 71 6c 69 74 65 33 42 74 72 65 65 43 72 65 61  sqlite3BtreeCrea
0ce0: 74 65 54 61 62 6c 65 20 63 61 6e 20 62 65 20 74  teTable can be t
0cf0: 68 65 20 62 69 74 77 69 73 65 20 4f 52 0a 2a 2a  he bitwise OR.**
0d00: 20 6f 66 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e   of the followin
0d10: 67 20 66 6c 61 67 73 3a 0a 2a 2f 0a 23 64 65 66  g flags:.*/.#def
0d20: 69 6e 65 20 42 54 52 45 45 5f 49 4e 54 4b 45 59  ine BTREE_INTKEY
0d30: 20 20 20 20 20 31 20 20 20 20 2f 2a 20 54 61 62       1    /* Tab
0d40: 6c 65 20 68 61 73 20 6f 6e 6c 79 20 36 34 2d 62  le has only 64-b
0d50: 69 74 20 73 69 67 6e 65 64 20 69 6e 74 65 67 65  it signed intege
0d60: 72 20 6b 65 79 73 20 2a 2f 0a 23 64 65 66 69 6e  r keys */.#defin
0d70: 65 20 42 54 52 45 45 5f 5a 45 52 4f 44 41 54 41  e BTREE_ZERODATA
0d80: 20 20 20 32 20 20 20 20 2f 2a 20 54 61 62 6c 65     2    /* Table
0d90: 20 68 61 73 20 6b 65 79 73 20 6f 6e 6c 79 20 2d   has keys only -
0da0: 20 6e 6f 20 64 61 74 61 20 2a 2f 0a 23 64 65 66   no data */.#def
0db0: 69 6e 65 20 42 54 52 45 45 5f 4c 45 41 46 44 41  ine BTREE_LEAFDA
0dc0: 54 41 20 20 20 34 20 20 20 20 2f 2a 20 44 61 74  TA   4    /* Dat
0dd0: 61 20 73 74 6f 72 65 64 20 69 6e 20 6c 65 61 76  a stored in leav
0de0: 65 73 20 6f 6e 6c 79 2e 20 20 49 6d 70 6c 69 65  es only.  Implie
0df0: 73 20 49 4e 54 4b 45 59 20 2a 2f 0a 0a 69 6e 74  s INTKEY */..int
0e00: 20 73 71 6c 69 74 65 33 42 74 72 65 65 44 72 6f   sqlite3BtreeDro
0e10: 70 54 61 62 6c 65 28 42 74 72 65 65 2a 2c 20 69  pTable(Btree*, i
0e20: 6e 74 2c 20 69 6e 74 2a 29 3b 0a 69 6e 74 20 73  nt, int*);.int s
0e30: 71 6c 69 74 65 33 42 74 72 65 65 43 6c 65 61 72  qlite3BtreeClear
0e40: 54 61 62 6c 65 28 42 74 72 65 65 2a 2c 20 69 6e  Table(Btree*, in
0e50: 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  t);.int sqlite3B
0e60: 74 72 65 65 47 65 74 4d 65 74 61 28 42 74 72 65  treeGetMeta(Btre
0e70: 65 2a 2c 20 69 6e 74 20 69 64 78 2c 20 75 33 32  e*, int idx, u32
0e80: 20 2a 70 56 61 6c 75 65 29 3b 0a 69 6e 74 20 73   *pValue);.int s
0e90: 71 6c 69 74 65 33 42 74 72 65 65 55 70 64 61 74  qlite3BtreeUpdat
0ea0: 65 4d 65 74 61 28 42 74 72 65 65 2a 2c 20 69 6e  eMeta(Btree*, in
0eb0: 74 20 69 64 78 2c 20 75 33 32 20 76 61 6c 75 65  t idx, u32 value
0ec0: 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  );..int sqlite3B
0ed0: 74 72 65 65 43 75 72 73 6f 72 28 0a 20 20 42 74  treeCursor(.  Bt
0ee0: 72 65 65 2a 2c 20 20 20 20 20 20 20 20 20 20 20  ree*,           
0ef0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0f00: 20 20 20 2f 2a 20 42 54 72 65 65 20 63 6f 6e 74     /* BTree cont
0f10: 61 69 6e 69 6e 67 20 74 61 62 6c 65 20 74 6f 20  aining table to 
0f20: 6f 70 65 6e 20 2a 2f 0a 20 20 69 6e 74 20 69 54  open */.  int iT
0f30: 61 62 6c 65 2c 20 20 20 20 20 20 20 20 20 20 20  able,           
0f40: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
0f50: 2a 20 49 6e 64 65 78 20 6f 66 20 72 6f 6f 74 20  * Index of root 
0f60: 70 61 67 65 20 2a 2f 0a 20 20 69 6e 74 20 77 72  page */.  int wr
0f70: 46 6c 61 67 2c 20 20 20 20 20 20 20 20 20 20 20  Flag,           
0f80: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 2f                 /
0f90: 2a 20 31 20 66 6f 72 20 77 72 69 74 69 6e 67 2e  * 1 for writing.
0fa0: 20 20 30 20 66 6f 72 20 72 65 61 64 2d 6f 6e 6c    0 for read-onl
0fb0: 79 20 2a 2f 0a 20 20 69 6e 74 28 2a 29 28 76 6f  y */.  int(*)(vo
0fc0: 69 64 2a 2c 69 6e 74 2c 63 6f 6e 73 74 20 76 6f  id*,int,const vo
0fd0: 69 64 2a 2c 69 6e 74 2c 63 6f 6e 73 74 20 76 6f  id*,int,const vo
0fe0: 69 64 2a 29 2c 20 20 2f 2a 20 4b 65 79 20 63 6f  id*),  /* Key co
0ff0: 6d 70 61 72 69 73 6f 6e 20 66 75 6e 63 74 69 6f  mparison functio
1000: 6e 20 2a 2f 0a 20 20 76 6f 69 64 2a 2c 20 20 20  n */.  void*,   
1010: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1020: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 46              /* F
1030: 69 72 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f  irst argument to
1040: 20 63 6f 6d 70 61 72 65 20 66 75 6e 63 74 69 6f   compare functio
1050: 6e 20 2a 2f 0a 20 20 42 74 43 75 72 73 6f 72 20  n */.  BtCursor 
1060: 2a 2a 70 70 43 75 72 73 6f 72 20 20 20 20 20 20  **ppCursor      
1070: 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 52              /* R
1080: 65 74 75 72 6e 65 64 20 63 75 72 73 6f 72 20 2a  eturned cursor *
1090: 2f 0a 29 3b 0a 0a 76 6f 69 64 20 73 71 6c 69 74  /.);..void sqlit
10a0: 65 33 42 74 72 65 65 53 65 74 43 6f 6d 70 61 72  e3BtreeSetCompar
10b0: 65 28 0a 20 20 42 74 43 75 72 73 6f 72 20 2a 2c  e(.  BtCursor *,
10c0: 0a 20 20 69 6e 74 28 2a 29 28 76 6f 69 64 2a 2c  .  int(*)(void*,
10d0: 69 6e 74 2c 63 6f 6e 73 74 20 76 6f 69 64 2a 2c  int,const void*,
10e0: 69 6e 74 2c 63 6f 6e 73 74 20 76 6f 69 64 2a 29  int,const void*)
10f0: 2c 0a 20 20 76 6f 69 64 2a 0a 29 3b 0a 0a 69 6e  ,.  void*.);..in
1100: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 43 6c  t sqlite3BtreeCl
1110: 6f 73 65 43 75 72 73 6f 72 28 42 74 43 75 72 73  oseCursor(BtCurs
1120: 6f 72 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  or*);.int sqlite
1130: 33 42 74 72 65 65 4d 6f 76 65 74 6f 28 42 74 43  3BtreeMoveto(BtC
1140: 75 72 73 6f 72 2a 2c 63 6f 6e 73 74 20 76 6f 69  ursor*,const voi
1150: 64 20 2a 70 4b 65 79 2c 69 36 34 20 6e 4b 65 79  d *pKey,i64 nKey
1160: 2c 69 6e 74 20 62 69 61 73 2c 69 6e 74 20 2a 70  ,int bias,int *p
1170: 52 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  Res);.int sqlite
1180: 33 42 74 72 65 65 44 65 6c 65 74 65 28 42 74 43  3BtreeDelete(BtC
1190: 75 72 73 6f 72 2a 29 3b 0a 69 6e 74 20 73 71 6c  ursor*);.int sql
11a0: 69 74 65 33 42 74 72 65 65 49 6e 73 65 72 74 28  ite3BtreeInsert(
11b0: 42 74 43 75 72 73 6f 72 2a 2c 20 63 6f 6e 73 74  BtCursor*, const
11c0: 20 76 6f 69 64 20 2a 70 4b 65 79 2c 20 69 36 34   void *pKey, i64
11d0: 20 6e 4b 65 79 2c 0a 20 20 20 20 20 20 20 20 20   nKey,.         
11e0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
11f0: 20 20 20 20 20 20 20 20 20 63 6f 6e 73 74 20 76           const v
1200: 6f 69 64 20 2a 70 44 61 74 61 2c 20 69 6e 74 20  oid *pData, int 
1210: 6e 44 61 74 61 2c 0a 20 20 20 20 20 20 20 20 20  nData,.         
1220: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
1230: 20 20 20 20 20 20 20 20 20 69 6e 74 20 6e 5a 65           int nZe
1240: 72 6f 2c 20 69 6e 74 20 62 69 61 73 29 3b 0a 69  ro, int bias);.i
1250: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 46  nt sqlite3BtreeF
1260: 69 72 73 74 28 42 74 43 75 72 73 6f 72 2a 2c 20  irst(BtCursor*, 
1270: 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69 6e 74 20  int *pRes);.int 
1280: 73 71 6c 69 74 65 33 42 74 72 65 65 4c 61 73 74  sqlite3BtreeLast
1290: 28 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e 74 20  (BtCursor*, int 
12a0: 2a 70 52 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69  *pRes);.int sqli
12b0: 74 65 33 42 74 72 65 65 4e 65 78 74 28 42 74 43  te3BtreeNext(BtC
12c0: 75 72 73 6f 72 2a 2c 20 69 6e 74 20 2a 70 52 65  ursor*, int *pRe
12d0: 73 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  s);.int sqlite3B
12e0: 74 72 65 65 45 6f 66 28 42 74 43 75 72 73 6f 72  treeEof(BtCursor
12f0: 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  *);.int sqlite3B
1300: 74 72 65 65 46 6c 61 67 73 28 42 74 43 75 72 73  treeFlags(BtCurs
1310: 6f 72 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  or*);.int sqlite
1320: 33 42 74 72 65 65 50 72 65 76 69 6f 75 73 28 42  3BtreePrevious(B
1330: 74 43 75 72 73 6f 72 2a 2c 20 69 6e 74 20 2a 70  tCursor*, int *p
1340: 52 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  Res);.int sqlite
1350: 33 42 74 72 65 65 4b 65 79 53 69 7a 65 28 42 74  3BtreeKeySize(Bt
1360: 43 75 72 73 6f 72 2a 2c 20 69 36 34 20 2a 70 53  Cursor*, i64 *pS
1370: 69 7a 65 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  ize);.int sqlite
1380: 33 42 74 72 65 65 4b 65 79 28 42 74 43 75 72 73  3BtreeKey(BtCurs
1390: 6f 72 2a 2c 20 75 33 32 20 6f 66 66 73 65 74 2c  or*, u32 offset,
13a0: 20 75 33 32 20 61 6d 74 2c 20 76 6f 69 64 2a 29   u32 amt, void*)
13b0: 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 71  ;.const void *sq
13c0: 6c 69 74 65 33 42 74 72 65 65 4b 65 79 46 65 74  lite3BtreeKeyFet
13d0: 63 68 28 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e  ch(BtCursor*, in
13e0: 74 20 2a 70 41 6d 74 29 3b 0a 63 6f 6e 73 74 20  t *pAmt);.const 
13f0: 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 42 74 72  void *sqlite3Btr
1400: 65 65 44 61 74 61 46 65 74 63 68 28 42 74 43 75  eeDataFetch(BtCu
1410: 72 73 6f 72 2a 2c 20 69 6e 74 20 2a 70 41 6d 74  rsor*, int *pAmt
1420: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
1430: 72 65 65 44 61 74 61 53 69 7a 65 28 42 74 43 75  reeDataSize(BtCu
1440: 72 73 6f 72 2a 2c 20 75 33 32 20 2a 70 53 69 7a  rsor*, u32 *pSiz
1450: 65 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  e);.int sqlite3B
1460: 74 72 65 65 44 61 74 61 28 42 74 43 75 72 73 6f  treeData(BtCurso
1470: 72 2a 2c 20 75 33 32 20 6f 66 66 73 65 74 2c 20  r*, u32 offset, 
1480: 75 33 32 20 61 6d 74 2c 20 76 6f 69 64 2a 29 3b  u32 amt, void*);
1490: 0a 0a 63 68 61 72 20 2a 73 71 6c 69 74 65 33 42  ..char *sqlite3B
14a0: 74 72 65 65 49 6e 74 65 67 72 69 74 79 43 68 65  treeIntegrityChe
14b0: 63 6b 28 42 74 72 65 65 2a 2c 20 69 6e 74 20 2a  ck(Btree*, int *
14c0: 61 52 6f 6f 74 2c 20 69 6e 74 20 6e 52 6f 6f 74  aRoot, int nRoot
14d0: 2c 20 69 6e 74 2c 20 69 6e 74 2a 29 3b 0a 73 74  , int, int*);.st
14e0: 72 75 63 74 20 50 61 67 65 72 20 2a 73 71 6c 69  ruct Pager *sqli
14f0: 74 65 33 42 74 72 65 65 50 61 67 65 72 28 42 74  te3BtreePager(Bt
1500: 72 65 65 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69  ree*);..int sqli
1510: 74 65 33 42 74 72 65 65 50 75 74 44 61 74 61 28  te3BtreePutData(
1520: 42 74 43 75 72 73 6f 72 2a 2c 20 75 33 32 20 6f  BtCursor*, u32 o
1530: 66 66 73 65 74 2c 20 75 33 32 20 61 6d 74 2c 20  ffset, u32 amt, 
1540: 76 6f 69 64 2a 29 3b 0a 76 6f 69 64 20 73 71 6c  void*);.void sql
1550: 69 74 65 33 42 74 72 65 65 43 61 63 68 65 4f 76  ite3BtreeCacheOv
1560: 65 72 66 6c 6f 77 28 42 74 43 75 72 73 6f 72 20  erflow(BtCursor 
1570: 2a 29 3b 0a 0a 23 69 66 64 65 66 20 53 51 4c 49  *);..#ifdef SQLI
1580: 54 45 5f 54 45 53 54 0a 69 6e 74 20 73 71 6c 69  TE_TEST.int sqli
1590: 74 65 33 42 74 72 65 65 43 75 72 73 6f 72 49 6e  te3BtreeCursorIn
15a0: 66 6f 28 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e  fo(BtCursor*, in
15b0: 74 2a 2c 20 69 6e 74 29 3b 0a 76 6f 69 64 20 73  t*, int);.void s
15c0: 71 6c 69 74 65 33 42 74 72 65 65 43 75 72 73 6f  qlite3BtreeCurso
15d0: 72 4c 69 73 74 28 42 74 72 65 65 2a 29 3b 0a 69  rList(Btree*);.i
15e0: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 50  nt sqlite3BtreeP
15f0: 61 67 65 44 75 6d 70 28 42 74 72 65 65 2a 2c 20  ageDump(Btree*, 
1600: 69 6e 74 2c 20 69 6e 74 20 72 65 63 75 72 73 69  int, int recursi
1610: 76 65 29 3b 0a 23 65 6e 64 69 66 0a 0a 23 65 6e  ve);.#endif..#en
1620: 64 69 66 20 2f 2a 20 5f 42 54 52 45 45 5f 48 5f  dif /* _BTREE_H_
1630: 20 2a 2f 0a                                       */.