/ Hex Artifact Content
Login

Artifact 57d653ef5137b91f2a068aaf71a2905468dd2cb7:


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 0a 2a 2a 0a 2a 2a  subsystem..**.**
01d0: 20 40 28 23 29 20 24 49 64 3a 20 62 74 72 65 65   @(#) $Id: btree
01e0: 2e 68 2c 76 20 31 2e 31 36 20 32 30 30 31 2f 30  .h,v 1.16 2001/0
01f0: 39 2f 32 37 20 30 33 3a 32 32 3a 33 33 20 64 72  9/27 03:22:33 dr
0200: 68 20 45 78 70 20 24 0a 2a 2f 0a 23 69 66 6e 64  h Exp $.*/.#ifnd
0210: 65 66 20 5f 42 54 52 45 45 5f 48 5f 0a 23 64 65  ef _BTREE_H_.#de
0220: 66 69 6e 65 20 5f 42 54 52 45 45 5f 48 5f 0a 0a  fine _BTREE_H_..
0230: 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20 42  typedef struct B
0240: 74 72 65 65 20 42 74 72 65 65 3b 0a 74 79 70 65  tree Btree;.type
0250: 64 65 66 20 73 74 72 75 63 74 20 42 74 43 75 72  def struct BtCur
0260: 73 6f 72 20 42 74 43 75 72 73 6f 72 3b 0a 0a 69  sor BtCursor;..i
0270: 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 4f 70  nt sqliteBtreeOp
0280: 65 6e 28 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a  en(const char *z
0290: 46 69 6c 65 6e 61 6d 65 2c 20 69 6e 74 20 6d 6f  Filename, int mo
02a0: 64 65 2c 20 69 6e 74 20 6e 50 67 2c 20 42 74 72  de, int nPg, Btr
02b0: 65 65 20 2a 2a 70 70 42 74 72 65 65 29 3b 0a 69  ee **ppBtree);.i
02c0: 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 43 6c  nt sqliteBtreeCl
02d0: 6f 73 65 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74  ose(Btree*);.int
02e0: 20 73 71 6c 69 74 65 42 74 72 65 65 53 65 74 43   sqliteBtreeSetC
02f0: 61 63 68 65 53 69 7a 65 28 42 74 72 65 65 2a 2c  acheSize(Btree*,
0300: 20 69 6e 74 29 3b 0a 0a 69 6e 74 20 73 71 6c 69   int);..int sqli
0310: 74 65 42 74 72 65 65 42 65 67 69 6e 54 72 61 6e  teBtreeBeginTran
0320: 73 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73  s(Btree*);.int s
0330: 71 6c 69 74 65 42 74 72 65 65 43 6f 6d 6d 69 74  qliteBtreeCommit
0340: 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71  (Btree*);.int sq
0350: 6c 69 74 65 42 74 72 65 65 52 6f 6c 6c 62 61 63  liteBtreeRollbac
0360: 6b 28 42 74 72 65 65 2a 29 3b 0a 0a 69 6e 74 20  k(Btree*);..int 
0370: 73 71 6c 69 74 65 42 74 72 65 65 43 72 65 61 74  sqliteBtreeCreat
0380: 65 54 61 62 6c 65 28 42 74 72 65 65 2a 2c 20 69  eTable(Btree*, i
0390: 6e 74 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  nt*);.int sqlite
03a0: 42 74 72 65 65 44 72 6f 70 54 61 62 6c 65 28 42  BtreeDropTable(B
03b0: 74 72 65 65 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74  tree*, int);.int
03c0: 20 73 71 6c 69 74 65 42 74 72 65 65 43 6c 65 61   sqliteBtreeClea
03d0: 72 54 61 62 6c 65 28 42 74 72 65 65 2a 2c 20 69  rTable(Btree*, i
03e0: 6e 74 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65  nt);..int sqlite
03f0: 42 74 72 65 65 43 75 72 73 6f 72 28 42 74 72 65  BtreeCursor(Btre
0400: 65 2a 2c 20 69 6e 74 20 69 54 61 62 6c 65 2c 20  e*, int iTable, 
0410: 69 6e 74 20 77 72 46 6c 61 67 2c 20 42 74 43 75  int wrFlag, BtCu
0420: 72 73 6f 72 20 2a 2a 70 70 43 75 72 29 3b 0a 69  rsor **ppCur);.i
0430: 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 4d 6f  nt sqliteBtreeMo
0440: 76 65 74 6f 28 42 74 43 75 72 73 6f 72 2a 2c 20  veto(BtCursor*, 
0450: 63 6f 6e 73 74 20 76 6f 69 64 20 2a 70 4b 65 79  const void *pKey
0460: 2c 20 69 6e 74 20 6e 4b 65 79 2c 20 69 6e 74 20  , int nKey, int 
0470: 2a 70 52 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69  *pRes);.int sqli
0480: 74 65 42 74 72 65 65 44 65 6c 65 74 65 28 42 74  teBtreeDelete(Bt
0490: 43 75 72 73 6f 72 2a 29 3b 0a 69 6e 74 20 73 71  Cursor*);.int sq
04a0: 6c 69 74 65 42 74 72 65 65 49 6e 73 65 72 74 28  liteBtreeInsert(
04b0: 42 74 43 75 72 73 6f 72 2a 2c 20 63 6f 6e 73 74  BtCursor*, const
04c0: 20 76 6f 69 64 20 2a 70 4b 65 79 2c 20 69 6e 74   void *pKey, int
04d0: 20 6e 4b 65 79 2c 0a 20 20 20 20 20 20 20 20 20   nKey,.         
04e0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
04f0: 20 20 20 20 20 20 20 20 63 6f 6e 73 74 20 76 6f          const vo
0500: 69 64 20 2a 70 44 61 74 61 2c 20 69 6e 74 20 6e  id *pData, int n
0510: 44 61 74 61 29 3b 0a 69 6e 74 20 73 71 6c 69 74  Data);.int sqlit
0520: 65 42 74 72 65 65 46 69 72 73 74 28 42 74 43 75  eBtreeFirst(BtCu
0530: 72 73 6f 72 2a 2c 20 69 6e 74 20 2a 70 52 65 73  rsor*, int *pRes
0540: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 42 74 72  );.int sqliteBtr
0550: 65 65 4e 65 78 74 28 42 74 43 75 72 73 6f 72 2a  eeNext(BtCursor*
0560: 2c 20 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69 6e  , int *pRes);.in
0570: 74 20 73 71 6c 69 74 65 42 74 72 65 65 4b 65 79  t sqliteBtreeKey
0580: 53 69 7a 65 28 42 74 43 75 72 73 6f 72 2a 2c 20  Size(BtCursor*, 
0590: 69 6e 74 20 2a 70 53 69 7a 65 29 3b 0a 69 6e 74  int *pSize);.int
05a0: 20 73 71 6c 69 74 65 42 74 72 65 65 4b 65 79 28   sqliteBtreeKey(
05b0: 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e 74 20 6f  BtCursor*, int o
05c0: 66 66 73 65 74 2c 20 69 6e 74 20 61 6d 74 2c 20  ffset, int amt, 
05d0: 63 68 61 72 20 2a 7a 42 75 66 29 3b 0a 69 6e 74  char *zBuf);.int
05e0: 20 73 71 6c 69 74 65 42 74 72 65 65 4b 65 79 43   sqliteBtreeKeyC
05f0: 6f 6d 70 61 72 65 28 42 74 43 75 72 73 6f 72 2a  ompare(BtCursor*
0600: 2c 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a 70 4b  , const void *pK
0610: 65 79 2c 20 69 6e 74 20 6e 4b 65 79 2c 20 69 6e  ey, int nKey, in
0620: 74 20 2a 70 52 65 73 29 3b 0a 69 6e 74 20 73 71  t *pRes);.int sq
0630: 6c 69 74 65 42 74 72 65 65 44 61 74 61 53 69 7a  liteBtreeDataSiz
0640: 65 28 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e 74  e(BtCursor*, int
0650: 20 2a 70 53 69 7a 65 29 3b 0a 69 6e 74 20 73 71   *pSize);.int sq
0660: 6c 69 74 65 42 74 72 65 65 44 61 74 61 28 42 74  liteBtreeData(Bt
0670: 43 75 72 73 6f 72 2a 2c 20 69 6e 74 20 6f 66 66  Cursor*, int off
0680: 73 65 74 2c 20 69 6e 74 20 61 6d 74 2c 20 63 68  set, int amt, ch
0690: 61 72 20 2a 7a 42 75 66 29 3b 0a 69 6e 74 20 73  ar *zBuf);.int s
06a0: 71 6c 69 74 65 42 74 72 65 65 43 6c 6f 73 65 43  qliteBtreeCloseC
06b0: 75 72 73 6f 72 28 42 74 43 75 72 73 6f 72 2a 29  ursor(BtCursor*)
06c0: 3b 0a 0a 23 64 65 66 69 6e 65 20 53 51 4c 49 54  ;..#define SQLIT
06d0: 45 5f 4e 5f 42 54 52 45 45 5f 4d 45 54 41 20 34  E_N_BTREE_META 4
06e0: 0a 69 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65  .int sqliteBtree
06f0: 47 65 74 4d 65 74 61 28 42 74 72 65 65 2a 2c 20  GetMeta(Btree*, 
0700: 69 6e 74 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74  int*);.int sqlit
0710: 65 42 74 72 65 65 55 70 64 61 74 65 4d 65 74 61  eBtreeUpdateMeta
0720: 28 42 74 72 65 65 2a 2c 20 69 6e 74 2a 29 3b 0a  (Btree*, int*);.
0730: 0a 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f  ..#ifdef SQLITE_
0740: 54 45 53 54 0a 69 6e 74 20 73 71 6c 69 74 65 42  TEST.int sqliteB
0750: 74 72 65 65 50 61 67 65 44 75 6d 70 28 42 74 72  treePageDump(Btr
0760: 65 65 2a 2c 20 69 6e 74 2c 20 69 6e 74 29 3b 0a  ee*, int, int);.
0770: 69 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 43  int sqliteBtreeC
0780: 75 72 73 6f 72 44 75 6d 70 28 42 74 43 75 72 73  ursorDump(BtCurs
0790: 6f 72 2a 2c 20 69 6e 74 2a 29 3b 0a 73 74 72 75  or*, int*);.stru
07a0: 63 74 20 50 61 67 65 72 20 2a 73 71 6c 69 74 65  ct Pager *sqlite
07b0: 42 74 72 65 65 50 61 67 65 72 28 42 74 72 65 65  BtreePager(Btree
07c0: 2a 29 3b 0a 63 68 61 72 20 2a 73 71 6c 69 74 65  *);.char *sqlite
07d0: 42 74 72 65 65 53 61 6e 69 74 79 43 68 65 63 6b  BtreeSanityCheck
07e0: 28 42 74 72 65 65 2a 2c 20 69 6e 74 2a 2c 20 69  (Btree*, int*, i
07f0: 6e 74 29 3b 0a 23 65 6e 64 69 66 0a 0a 23 65 6e  nt);.#endif..#en
0800: 64 69 66 20 2f 2a 20 5f 42 54 52 45 45 5f 48 5f  dif /* _BTREE_H_
0810: 20 2a 2f 0a                                       */.