/ Hex Artifact Content
Login

Artifact 36a7a26a29382c2b1a519b42bb125880d46d00d4:


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 32 37 20 32 30  tree.h,v 1.27 20
0250: 30 33 2f 30 32 2f 31 32 20 31 34 3a 30 39 3a 34  03/02/12 14:09:4
0260: 34 20 64 72 68 20 45 78 70 20 24 0a 2a 2f 0a 23  4 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 74 79 70 65 64 65 66 20 73 74 72 75  H_..typedef stru
02a0: 63 74 20 42 74 72 65 65 20 42 74 72 65 65 3b 0a  ct Btree Btree;.
02b0: 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20 42  typedef struct B
02c0: 74 43 75 72 73 6f 72 20 42 74 43 75 72 73 6f 72  tCursor BtCursor
02d0: 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 42 74 72  ;..int sqliteBtr
02e0: 65 65 4f 70 65 6e 28 63 6f 6e 73 74 20 63 68 61  eeOpen(const cha
02f0: 72 20 2a 7a 46 69 6c 65 6e 61 6d 65 2c 20 69 6e  r *zFilename, in
0300: 74 20 6d 6f 64 65 2c 20 69 6e 74 20 6e 50 67 2c  t mode, int nPg,
0310: 20 42 74 72 65 65 20 2a 2a 70 70 42 74 72 65 65   Btree **ppBtree
0320: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 42 74 72  );.int sqliteBtr
0330: 65 65 43 6c 6f 73 65 28 42 74 72 65 65 2a 29 3b  eeClose(Btree*);
0340: 0a 69 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65  .int sqliteBtree
0350: 53 65 74 43 61 63 68 65 53 69 7a 65 28 42 74 72  SetCacheSize(Btr
0360: 65 65 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73  ee*, int);.int s
0370: 71 6c 69 74 65 42 74 72 65 65 53 65 74 53 61 66  qliteBtreeSetSaf
0380: 65 74 79 4c 65 76 65 6c 28 42 74 72 65 65 2a 2c  etyLevel(Btree*,
0390: 20 69 6e 74 29 3b 0a 0a 69 6e 74 20 73 71 6c 69   int);..int sqli
03a0: 74 65 42 74 72 65 65 42 65 67 69 6e 54 72 61 6e  teBtreeBeginTran
03b0: 73 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73  s(Btree*);.int s
03c0: 71 6c 69 74 65 42 74 72 65 65 43 6f 6d 6d 69 74  qliteBtreeCommit
03d0: 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71  (Btree*);.int sq
03e0: 6c 69 74 65 42 74 72 65 65 52 6f 6c 6c 62 61 63  liteBtreeRollbac
03f0: 6b 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73  k(Btree*);.int s
0400: 71 6c 69 74 65 42 74 72 65 65 42 65 67 69 6e 43  qliteBtreeBeginC
0410: 6b 70 74 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74  kpt(Btree*);.int
0420: 20 73 71 6c 69 74 65 42 74 72 65 65 43 6f 6d 6d   sqliteBtreeComm
0430: 69 74 43 6b 70 74 28 42 74 72 65 65 2a 29 3b 0a  itCkpt(Btree*);.
0440: 69 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 52  int sqliteBtreeR
0450: 6f 6c 6c 62 61 63 6b 43 6b 70 74 28 42 74 72 65  ollbackCkpt(Btre
0460: 65 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65  e*);..int sqlite
0470: 42 74 72 65 65 43 72 65 61 74 65 54 61 62 6c 65  BtreeCreateTable
0480: 28 42 74 72 65 65 2a 2c 20 69 6e 74 2a 29 3b 0a  (Btree*, int*);.
0490: 69 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 43  int sqliteBtreeC
04a0: 72 65 61 74 65 49 6e 64 65 78 28 42 74 72 65 65  reateIndex(Btree
04b0: 2a 2c 20 69 6e 74 2a 29 3b 0a 69 6e 74 20 73 71  *, int*);.int sq
04c0: 6c 69 74 65 42 74 72 65 65 44 72 6f 70 54 61 62  liteBtreeDropTab
04d0: 6c 65 28 42 74 72 65 65 2a 2c 20 69 6e 74 29 3b  le(Btree*, int);
04e0: 0a 69 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65  .int sqliteBtree
04f0: 43 6c 65 61 72 54 61 62 6c 65 28 42 74 72 65 65  ClearTable(Btree
0500: 2a 2c 20 69 6e 74 29 3b 0a 0a 69 6e 74 20 73 71  *, int);..int sq
0510: 6c 69 74 65 42 74 72 65 65 43 75 72 73 6f 72 28  liteBtreeCursor(
0520: 42 74 72 65 65 2a 2c 20 69 6e 74 20 69 54 61 62  Btree*, int iTab
0530: 6c 65 2c 20 69 6e 74 20 77 72 46 6c 61 67 2c 20  le, int wrFlag, 
0540: 42 74 43 75 72 73 6f 72 20 2a 2a 70 70 43 75 72  BtCursor **ppCur
0550: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 42 74 72  );.int sqliteBtr
0560: 65 65 4d 6f 76 65 74 6f 28 42 74 43 75 72 73 6f  eeMoveto(BtCurso
0570: 72 2a 2c 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a  r*, const void *
0580: 70 4b 65 79 2c 20 69 6e 74 20 6e 4b 65 79 2c 20  pKey, int nKey, 
0590: 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69 6e 74 20  int *pRes);.int 
05a0: 73 71 6c 69 74 65 42 74 72 65 65 44 65 6c 65 74  sqliteBtreeDelet
05b0: 65 28 42 74 43 75 72 73 6f 72 2a 29 3b 0a 69 6e  e(BtCursor*);.in
05c0: 74 20 73 71 6c 69 74 65 42 74 72 65 65 49 6e 73  t sqliteBtreeIns
05d0: 65 72 74 28 42 74 43 75 72 73 6f 72 2a 2c 20 63  ert(BtCursor*, c
05e0: 6f 6e 73 74 20 76 6f 69 64 20 2a 70 4b 65 79 2c  onst void *pKey,
05f0: 20 69 6e 74 20 6e 4b 65 79 2c 0a 20 20 20 20 20   int nKey,.     
0600: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0610: 20 20 20 20 20 20 20 20 20 20 20 20 63 6f 6e 73              cons
0620: 74 20 76 6f 69 64 20 2a 70 44 61 74 61 2c 20 69  t void *pData, i
0630: 6e 74 20 6e 44 61 74 61 29 3b 0a 69 6e 74 20 73  nt nData);.int s
0640: 71 6c 69 74 65 42 74 72 65 65 46 69 72 73 74 28  qliteBtreeFirst(
0650: 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e 74 20 2a  BtCursor*, int *
0660: 70 52 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69 74  pRes);.int sqlit
0670: 65 42 74 72 65 65 4c 61 73 74 28 42 74 43 75 72  eBtreeLast(BtCur
0680: 73 6f 72 2a 2c 20 69 6e 74 20 2a 70 52 65 73 29  sor*, int *pRes)
0690: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 42 74 72 65  ;.int sqliteBtre
06a0: 65 4e 65 78 74 28 42 74 43 75 72 73 6f 72 2a 2c  eNext(BtCursor*,
06b0: 20 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69 6e 74   int *pRes);.int
06c0: 20 73 71 6c 69 74 65 42 74 72 65 65 50 72 65 76   sqliteBtreePrev
06d0: 69 6f 75 73 28 42 74 43 75 72 73 6f 72 2a 2c 20  ious(BtCursor*, 
06e0: 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69 6e 74 20  int *pRes);.int 
06f0: 73 71 6c 69 74 65 42 74 72 65 65 4b 65 79 53 69  sqliteBtreeKeySi
0700: 7a 65 28 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e  ze(BtCursor*, in
0710: 74 20 2a 70 53 69 7a 65 29 3b 0a 69 6e 74 20 73  t *pSize);.int s
0720: 71 6c 69 74 65 42 74 72 65 65 4b 65 79 28 42 74  qliteBtreeKey(Bt
0730: 43 75 72 73 6f 72 2a 2c 20 69 6e 74 20 6f 66 66  Cursor*, int off
0740: 73 65 74 2c 20 69 6e 74 20 61 6d 74 2c 20 63 68  set, int amt, ch
0750: 61 72 20 2a 7a 42 75 66 29 3b 0a 69 6e 74 20 73  ar *zBuf);.int s
0760: 71 6c 69 74 65 42 74 72 65 65 4b 65 79 43 6f 6d  qliteBtreeKeyCom
0770: 70 61 72 65 28 42 74 43 75 72 73 6f 72 2a 2c 20  pare(BtCursor*, 
0780: 63 6f 6e 73 74 20 76 6f 69 64 20 2a 70 4b 65 79  const void *pKey
0790: 2c 20 69 6e 74 20 6e 4b 65 79 2c 0a 20 20 20 20  , int nKey,.    
07a0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
07b0: 20 20 20 20 20 20 69 6e 74 20 6e 49 67 6e 6f 72        int nIgnor
07c0: 65 2c 20 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69  e, int *pRes);.i
07d0: 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 44 61  nt sqliteBtreeDa
07e0: 74 61 53 69 7a 65 28 42 74 43 75 72 73 6f 72 2a  taSize(BtCursor*
07f0: 2c 20 69 6e 74 20 2a 70 53 69 7a 65 29 3b 0a 69  , int *pSize);.i
0800: 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 44 61  nt sqliteBtreeDa
0810: 74 61 28 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e  ta(BtCursor*, in
0820: 74 20 6f 66 66 73 65 74 2c 20 69 6e 74 20 61 6d  t offset, int am
0830: 74 2c 20 63 68 61 72 20 2a 7a 42 75 66 29 3b 0a  t, char *zBuf);.
0840: 69 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 43  int sqliteBtreeC
0850: 6c 6f 73 65 43 75 72 73 6f 72 28 42 74 43 75 72  loseCursor(BtCur
0860: 73 6f 72 2a 29 3b 0a 0a 23 64 65 66 69 6e 65 20  sor*);..#define 
0870: 53 51 4c 49 54 45 5f 4e 5f 42 54 52 45 45 5f 4d  SQLITE_N_BTREE_M
0880: 45 54 41 20 31 30 0a 69 6e 74 20 73 71 6c 69 74  ETA 10.int sqlit
0890: 65 42 74 72 65 65 47 65 74 4d 65 74 61 28 42 74  eBtreeGetMeta(Bt
08a0: 72 65 65 2a 2c 20 69 6e 74 2a 29 3b 0a 69 6e 74  ree*, int*);.int
08b0: 20 73 71 6c 69 74 65 42 74 72 65 65 55 70 64 61   sqliteBtreeUpda
08c0: 74 65 4d 65 74 61 28 42 74 72 65 65 2a 2c 20 69  teMeta(Btree*, i
08d0: 6e 74 2a 29 3b 0a 0a 63 68 61 72 20 2a 73 71 6c  nt*);..char *sql
08e0: 69 74 65 42 74 72 65 65 49 6e 74 65 67 72 69 74  iteBtreeIntegrit
08f0: 79 43 68 65 63 6b 28 42 74 72 65 65 2a 2c 20 69  yCheck(Btree*, i
0900: 6e 74 2a 2c 20 69 6e 74 29 3b 0a 0a 23 69 66 64  nt*, int);..#ifd
0910: 65 66 20 53 51 4c 49 54 45 5f 54 45 53 54 0a 69  ef SQLITE_TEST.i
0920: 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 50 61  nt sqliteBtreePa
0930: 67 65 44 75 6d 70 28 42 74 72 65 65 2a 2c 20 69  geDump(Btree*, i
0940: 6e 74 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71  nt, int);.int sq
0950: 6c 69 74 65 42 74 72 65 65 43 75 72 73 6f 72 44  liteBtreeCursorD
0960: 75 6d 70 28 42 74 43 75 72 73 6f 72 2a 2c 20 69  ump(BtCursor*, i
0970: 6e 74 2a 29 3b 0a 73 74 72 75 63 74 20 50 61 67  nt*);.struct Pag
0980: 65 72 20 2a 73 71 6c 69 74 65 42 74 72 65 65 50  er *sqliteBtreeP
0990: 61 67 65 72 28 42 74 72 65 65 2a 29 3b 0a 69 6e  ager(Btree*);.in
09a0: 74 20 62 74 72 65 65 5f 6e 61 74 69 76 65 5f 62  t btree_native_b
09b0: 79 74 65 5f 6f 72 64 65 72 3b 0a 23 65 6e 64 69  yte_order;.#endi
09c0: 66 0a 0a 23 65 6e 64 69 66 20 2f 2a 20 5f 42 54  f..#endif /* _BT
09d0: 52 45 45 5f 48 5f 20 2a 2f 0a                    REE_H_ */.