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 20 32 30 30 tree.h,v 1.8 200
0250: 35 2f 30 38 2f 32 37 20 32 33 3a 31 39 3a 34 30 5/08/27 23:19:40
0260: 20 72 6d 73 69 6d 70 73 6f 6e 20 45 78 70 20 24 rmsimpson Exp $
0270: 0a 2a 2f 0a 23 69 66 6e 64 65 66 20 5f 42 54 52 .*/.#ifndef _BTR
0280: 45 45 5f 48 5f 0a 23 64 65 66 69 6e 65 20 5f 42 EE_H_.#define _B
0290: 54 52 45 45 5f 48 5f 0a 0a 2f 2a 20 54 4f 44 4f TREE_H_../* TODO
02a0: 3a 20 54 68 69 73 20 64 65 66 69 6e 69 74 69 6f : This definitio
02b0: 6e 20 69 73 20 6a 75 73 74 20 69 6e 63 6c 75 64 n is just includ
02c0: 65 64 20 73 6f 20 6f 74 68 65 72 20 6d 6f 64 75 ed so other modu
02d0: 6c 65 73 20 63 6f 6d 70 69 6c 65 2e 20 49 74 0a les compile. It.
02e0: 2a 2a 20 6e 65 65 64 73 20 74 6f 20 62 65 20 72 ** needs to be r
02f0: 65 76 69 73 69 74 65 64 2e 0a 2a 2f 0a 23 64 65 evisited..*/.#de
0300: 66 69 6e 65 20 53 51 4c 49 54 45 5f 4e 5f 42 54 fine SQLITE_N_BT
0310: 52 45 45 5f 4d 45 54 41 20 31 30 0a 0a 2f 2a 0a REE_META 10../*.
0320: 2a 2a 20 49 66 20 64 65 66 69 6e 65 64 20 61 73 ** If defined as
0330: 20 6e 6f 6e 2d 7a 65 72 6f 2c 20 61 75 74 6f 2d non-zero, auto-
0340: 76 61 63 75 75 6d 20 69 73 20 65 6e 61 62 6c 65 vacuum is enable
0350: 64 20 62 79 20 64 65 66 61 75 6c 74 2e 20 4f 74 d by default. Ot
0360: 68 65 72 77 69 73 65 0a 2a 2a 20 69 74 20 6d 75 herwise.** it mu
0370: 73 74 20 62 65 20 74 75 72 6e 65 64 20 6f 6e 20 st be turned on
0380: 66 6f 72 20 65 61 63 68 20 64 61 74 61 62 61 73 for each databas
0390: 65 20 75 73 69 6e 67 20 22 50 52 41 47 4d 41 20 e using "PRAGMA
03a0: 61 75 74 6f 5f 76 61 63 75 75 6d 20 3d 20 31 22 auto_vacuum = 1"
03b0: 2e 0a 2a 2f 0a 23 69 66 6e 64 65 66 20 53 51 4c ..*/.#ifndef SQL
03c0: 49 54 45 5f 44 45 46 41 55 4c 54 5f 41 55 54 4f ITE_DEFAULT_AUTO
03d0: 56 41 43 55 55 4d 0a 20 20 23 64 65 66 69 6e 65 VACUUM. #define
03e0: 20 53 51 4c 49 54 45 5f 44 45 46 41 55 4c 54 5f SQLITE_DEFAULT_
03f0: 41 55 54 4f 56 41 43 55 55 4d 20 30 0a 23 65 6e AUTOVACUUM 0.#en
0400: 64 69 66 0a 0a 2f 2a 0a 2a 2a 20 46 6f 72 77 61 dif../*.** Forwa
0410: 72 64 20 64 65 63 6c 61 72 61 74 69 6f 6e 73 20 rd declarations
0420: 6f 66 20 73 74 72 75 63 74 75 72 65 0a 2a 2f 0a of structure.*/.
0430: 74 79 70 65 64 65 66 20 73 74 72 75 63 74 20 42 typedef struct B
0440: 74 72 65 65 20 42 74 72 65 65 3b 0a 74 79 70 65 tree Btree;.type
0450: 64 65 66 20 73 74 72 75 63 74 20 42 74 43 75 72 def struct BtCur
0460: 73 6f 72 20 42 74 43 75 72 73 6f 72 3b 0a 0a 0a sor BtCursor;...
0470: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 int sqlite3Btree
0480: 4f 70 65 6e 28 0a 20 20 63 6f 6e 73 74 20 63 68 Open(. const ch
0490: 61 72 20 2a 7a 46 69 6c 65 6e 61 6d 65 2c 20 20 ar *zFilename,
04a0: 20 2f 2a 20 4e 61 6d 65 20 6f 66 20 64 61 74 61 /* Name of data
04b0: 62 61 73 65 20 66 69 6c 65 20 74 6f 20 6f 70 65 base file to ope
04c0: 6e 20 2a 2f 0a 20 20 42 74 72 65 65 20 2a 2a 2c n */. Btree **,
04d0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
04e0: 2f 2a 20 52 65 74 75 72 6e 20 6f 70 65 6e 20 42 /* Return open B
04f0: 74 72 65 65 2a 20 68 65 72 65 20 2a 2f 0a 20 20 tree* here */.
0500: 69 6e 74 20 66 6c 61 67 73 20 20 20 20 20 20 20 int flags
0510: 20 20 20 20 20 20 20 20 20 2f 2a 20 46 6c 61 67 /* Flag
0520: 73 20 2a 2f 0a 29 3b 0a 0a 2f 2a 20 54 68 65 20 s */.);../* The
0530: 66 6c 61 67 73 20 70 61 72 61 6d 65 74 65 72 20 flags parameter
0540: 74 6f 20 73 71 6c 69 74 65 33 42 74 72 65 65 4f to sqlite3BtreeO
0550: 70 65 6e 20 63 61 6e 20 62 65 20 74 68 65 20 62 pen can be the b
0560: 69 74 77 69 73 65 20 6f 72 20 6f 66 20 74 68 65 itwise or of the
0570: 0a 2a 2a 20 66 6f 6c 6c 6f 77 69 6e 67 20 76 61 .** following va
0580: 6c 75 65 73 2e 0a 2a 2a 0a 2a 2a 20 4e 4f 54 45 lues..**.** NOTE
0590: 3a 20 20 54 68 65 73 65 20 76 61 6c 75 65 73 20 : These values
05a0: 6d 75 73 74 20 6d 61 74 63 68 20 74 68 65 20 63 must match the c
05b0: 6f 72 72 65 73 70 6f 6e 64 69 6e 67 20 50 41 47 orresponding PAG
05c0: 45 52 5f 20 76 61 6c 75 65 73 20 69 6e 0a 2a 2a ER_ values in.**
05d0: 20 70 61 67 65 72 2e 68 2e 0a 2a 2f 0a 23 64 65 pager.h..*/.#de
05e0: 66 69 6e 65 20 42 54 52 45 45 5f 4f 4d 49 54 5f fine BTREE_OMIT_
05f0: 4a 4f 55 52 4e 41 4c 20 20 31 20 20 2f 2a 20 44 JOURNAL 1 /* D
0600: 6f 20 6e 6f 74 20 75 73 65 20 6a 6f 75 72 6e 61 o not use journa
0610: 6c 2e 20 20 4e 6f 20 61 72 67 75 6d 65 6e 74 20 l. No argument
0620: 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 */.#define BTREE
0630: 5f 4e 4f 5f 52 45 41 44 4c 4f 43 4b 20 20 20 32 _NO_READLOCK 2
0640: 20 20 2f 2a 20 4f 6d 69 74 20 72 65 61 64 6c 6f /* Omit readlo
0650: 63 6b 73 20 6f 6e 20 72 65 61 64 6f 6e 6c 79 20 cks on readonly
0660: 66 69 6c 65 73 20 2a 2f 0a 23 64 65 66 69 6e 65 files */.#define
0670: 20 42 54 52 45 45 5f 4d 45 4d 4f 52 59 20 20 20 BTREE_MEMORY
0680: 20 20 20 20 20 34 20 20 2f 2a 20 49 6e 2d 6d 65 4 /* In-me
0690: 6d 6f 72 79 20 44 42 2e 20 20 4e 6f 20 61 72 67 mory DB. No arg
06a0: 75 6d 65 6e 74 20 2a 2f 0a 0a 69 6e 74 20 73 71 ument */..int sq
06b0: 6c 69 74 65 33 42 74 72 65 65 43 6c 6f 73 65 28 lite3BtreeClose(
06c0: 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c Btree*);.int sql
06d0: 69 74 65 33 42 74 72 65 65 53 65 74 42 75 73 79 ite3BtreeSetBusy
06e0: 48 61 6e 64 6c 65 72 28 42 74 72 65 65 2a 2c 42 Handler(Btree*,B
06f0: 75 73 79 48 61 6e 64 6c 65 72 2a 29 3b 0a 69 6e usyHandler*);.in
0700: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 53 65 t sqlite3BtreeSe
0710: 74 43 61 63 68 65 53 69 7a 65 28 42 74 72 65 65 tCacheSize(Btree
0720: 2a 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 *,int);.int sqli
0730: 74 65 33 42 74 72 65 65 53 65 74 53 61 66 65 74 te3BtreeSetSafet
0740: 79 4c 65 76 65 6c 28 42 74 72 65 65 2a 2c 69 6e yLevel(Btree*,in
0750: 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 t);.int sqlite3B
0760: 74 72 65 65 53 79 6e 63 44 69 73 61 62 6c 65 64 treeSyncDisabled
0770: 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71 (Btree*);.int sq
0780: 6c 69 74 65 33 42 74 72 65 65 53 65 74 50 61 67 lite3BtreeSetPag
0790: 65 53 69 7a 65 28 42 74 72 65 65 2a 2c 69 6e 74 eSize(Btree*,int
07a0: 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 ,int);.int sqlit
07b0: 65 33 42 74 72 65 65 47 65 74 50 61 67 65 53 69 e3BtreeGetPageSi
07c0: 7a 65 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 ze(Btree*);.int
07d0: 73 71 6c 69 74 65 33 42 74 72 65 65 47 65 74 52 sqlite3BtreeGetR
07e0: 65 73 65 72 76 65 28 42 74 72 65 65 2a 29 3b 0a eserve(Btree*);.
07f0: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 int sqlite3Btree
0800: 53 65 74 41 75 74 6f 56 61 63 75 75 6d 28 42 74 SetAutoVacuum(Bt
0810: 72 65 65 20 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74 ree *, int);.int
0820: 20 73 71 6c 69 74 65 33 42 74 72 65 65 47 65 74 sqlite3BtreeGet
0830: 41 75 74 6f 56 61 63 75 75 6d 28 42 74 72 65 65 AutoVacuum(Btree
0840: 20 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 *);.int sqlite3
0850: 42 74 72 65 65 42 65 67 69 6e 54 72 61 6e 73 28 BtreeBeginTrans(
0860: 42 74 72 65 65 2a 2c 69 6e 74 29 3b 0a 69 6e 74 Btree*,int);.int
0870: 20 73 71 6c 69 74 65 33 42 74 72 65 65 43 6f 6d sqlite3BtreeCom
0880: 6d 69 74 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 mit(Btree*);.int
0890: 20 73 71 6c 69 74 65 33 42 74 72 65 65 52 6f 6c sqlite3BtreeRol
08a0: 6c 62 61 63 6b 28 42 74 72 65 65 2a 29 3b 0a 69 lback(Btree*);.i
08b0: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 42 nt sqlite3BtreeB
08c0: 65 67 69 6e 53 74 6d 74 28 42 74 72 65 65 2a 29 eginStmt(Btree*)
08d0: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 ;.int sqlite3Btr
08e0: 65 65 43 6f 6d 6d 69 74 53 74 6d 74 28 42 74 72 eeCommitStmt(Btr
08f0: 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 ee*);.int sqlite
0900: 33 42 74 72 65 65 52 6f 6c 6c 62 61 63 6b 53 74 3BtreeRollbackSt
0910: 6d 74 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 mt(Btree*);.int
0920: 73 71 6c 69 74 65 33 42 74 72 65 65 43 72 65 61 sqlite3BtreeCrea
0930: 74 65 54 61 62 6c 65 28 42 74 72 65 65 2a 2c 20 teTable(Btree*,
0940: 69 6e 74 2a 2c 20 69 6e 74 20 66 6c 61 67 73 29 int*, int flags)
0950: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 ;.int sqlite3Btr
0960: 65 65 49 73 49 6e 54 72 61 6e 73 28 42 74 72 65 eeIsInTrans(Btre
0970: 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 e*);.int sqlite3
0980: 42 74 72 65 65 49 73 49 6e 53 74 6d 74 28 42 74 BtreeIsInStmt(Bt
0990: 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 ree*);.int sqlit
09a0: 65 33 42 74 72 65 65 53 79 6e 63 28 42 74 72 65 e3BtreeSync(Btre
09b0: 65 2a 2c 20 63 6f 6e 73 74 20 63 68 61 72 20 2a e*, const char *
09c0: 7a 4d 61 73 74 65 72 29 3b 0a 69 6e 74 20 73 71 zMaster);.int sq
09d0: 6c 69 74 65 33 42 74 72 65 65 52 65 73 65 74 28 lite3BtreeReset(
09e0: 42 74 72 65 65 20 2a 29 3b 0a 0a 63 6f 6e 73 74 Btree *);..const
09f0: 20 63 68 61 72 20 2a 73 71 6c 69 74 65 33 42 74 char *sqlite3Bt
0a00: 72 65 65 47 65 74 46 69 6c 65 6e 61 6d 65 28 42 reeGetFilename(B
0a10: 74 72 65 65 20 2a 29 3b 0a 63 6f 6e 73 74 20 63 tree *);.const c
0a20: 68 61 72 20 2a 73 71 6c 69 74 65 33 42 74 72 65 har *sqlite3Btre
0a30: 65 47 65 74 44 69 72 6e 61 6d 65 28 42 74 72 65 eGetDirname(Btre
0a40: 65 20 2a 29 3b 0a 63 6f 6e 73 74 20 63 68 61 72 e *);.const char
0a50: 20 2a 73 71 6c 69 74 65 33 42 74 72 65 65 47 65 *sqlite3BtreeGe
0a60: 74 4a 6f 75 72 6e 61 6c 6e 61 6d 65 28 42 74 72 tJournalname(Btr
0a70: 65 65 20 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 ee *);.int sqlit
0a80: 65 33 42 74 72 65 65 43 6f 70 79 46 69 6c 65 28 e3BtreeCopyFile(
0a90: 42 74 72 65 65 20 2a 2c 20 42 74 72 65 65 20 2a Btree *, Btree *
0aa0: 29 3b 0a 0a 2f 2a 20 54 68 65 20 66 6c 61 67 73 );../* The flags
0ab0: 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71 parameter to sq
0ac0: 6c 69 74 65 33 42 74 72 65 65 43 72 65 61 74 65 lite3BtreeCreate
0ad0: 54 61 62 6c 65 20 63 61 6e 20 62 65 20 74 68 65 Table can be the
0ae0: 20 62 69 74 77 69 73 65 20 4f 52 0a 2a 2a 20 6f bitwise OR.** o
0af0: 66 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 f the following
0b00: 66 6c 61 67 73 3a 0a 2a 2f 0a 23 64 65 66 69 6e flags:.*/.#defin
0b10: 65 20 42 54 52 45 45 5f 49 4e 54 4b 45 59 20 20 e BTREE_INTKEY
0b20: 20 20 20 31 20 20 20 20 2f 2a 20 54 61 62 6c 65 1 /* Table
0b30: 20 68 61 73 20 6f 6e 6c 79 20 36 34 2d 62 69 74 has only 64-bit
0b40: 20 73 69 67 6e 65 64 20 69 6e 74 65 67 65 72 20 signed integer
0b50: 6b 65 79 73 20 2a 2f 0a 23 64 65 66 69 6e 65 20 keys */.#define
0b60: 42 54 52 45 45 5f 5a 45 52 4f 44 41 54 41 20 20 BTREE_ZERODATA
0b70: 20 32 20 20 20 20 2f 2a 20 54 61 62 6c 65 20 68 2 /* Table h
0b80: 61 73 20 6b 65 79 73 20 6f 6e 6c 79 20 2d 20 6e as keys only - n
0b90: 6f 20 64 61 74 61 20 2a 2f 0a 23 64 65 66 69 6e o data */.#defin
0ba0: 65 20 42 54 52 45 45 5f 4c 45 41 46 44 41 54 41 e BTREE_LEAFDATA
0bb0: 20 20 20 34 20 20 20 20 2f 2a 20 44 61 74 61 20 4 /* Data
0bc0: 73 74 6f 72 65 64 20 69 6e 20 6c 65 61 76 65 73 stored in leaves
0bd0: 20 6f 6e 6c 79 2e 20 20 49 6d 70 6c 69 65 73 20 only. Implies
0be0: 49 4e 54 4b 45 59 20 2a 2f 0a 0a 69 6e 74 20 73 INTKEY */..int s
0bf0: 71 6c 69 74 65 33 42 74 72 65 65 44 72 6f 70 54 qlite3BtreeDropT
0c00: 61 62 6c 65 28 42 74 72 65 65 2a 2c 20 69 6e 74 able(Btree*, int
0c10: 2c 20 69 6e 74 2a 29 3b 0a 69 6e 74 20 73 71 6c , int*);.int sql
0c20: 69 74 65 33 42 74 72 65 65 43 6c 65 61 72 54 61 ite3BtreeClearTa
0c30: 62 6c 65 28 42 74 72 65 65 2a 2c 20 69 6e 74 29 ble(Btree*, int)
0c40: 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 ;.int sqlite3Btr
0c50: 65 65 47 65 74 4d 65 74 61 28 42 74 72 65 65 2a eeGetMeta(Btree*
0c60: 2c 20 69 6e 74 20 69 64 78 2c 20 75 33 32 20 2a , int idx, u32 *
0c70: 70 56 61 6c 75 65 29 3b 0a 69 6e 74 20 73 71 6c pValue);.int sql
0c80: 69 74 65 33 42 74 72 65 65 55 70 64 61 74 65 4d ite3BtreeUpdateM
0c90: 65 74 61 28 42 74 72 65 65 2a 2c 20 69 6e 74 20 eta(Btree*, int
0ca0: 69 64 78 2c 20 75 33 32 20 76 61 6c 75 65 29 3b idx, u32 value);
0cb0: 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 ..int sqlite3Btr
0cc0: 65 65 43 75 72 73 6f 72 28 0a 20 20 42 74 72 65 eeCursor(. Btre
0cd0: 65 2a 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 e*,
0ce0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
0cf0: 20 2f 2a 20 42 54 72 65 65 20 63 6f 6e 74 61 69 /* BTree contai
0d00: 6e 69 6e 67 20 74 61 62 6c 65 20 74 6f 20 6f 70 ning table to op
0d10: 65 6e 20 2a 2f 0a 20 20 69 6e 74 20 69 54 61 62 en */. int iTab
0d20: 6c 65 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 le,
0d30: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 /*
0d40: 49 6e 64 65 78 20 6f 66 20 72 6f 6f 74 20 70 61 Index of root pa
0d50: 67 65 20 2a 2f 0a 20 20 69 6e 74 20 77 72 46 6c ge */. int wrFl
0d60: 61 67 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 ag,
0d70: 20 20 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 /*
0d80: 31 20 66 6f 72 20 77 72 69 74 69 6e 67 2e 20 20 1 for writing.
0d90: 30 20 66 6f 72 20 72 65 61 64 2d 6f 6e 6c 79 20 0 for read-only
0da0: 2a 2f 0a 20 20 69 6e 74 28 2a 29 28 76 6f 69 64 */. int(*)(void
0db0: 2a 2c 69 6e 74 2c 63 6f 6e 73 74 20 76 6f 69 64 *,int,const void
0dc0: 2a 2c 69 6e 74 2c 63 6f 6e 73 74 20 76 6f 69 64 *,int,const void
0dd0: 2a 29 2c 20 20 2f 2a 20 4b 65 79 20 63 6f 6d 70 *), /* Key comp
0de0: 61 72 69 73 6f 6e 20 66 75 6e 63 74 69 6f 6e 20 arison function
0df0: 2a 2f 0a 20 20 76 6f 69 64 2a 2c 20 20 20 20 20 */. void*,
0e00: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
0e10: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 46 69 72 /* Fir
0e20: 73 74 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 63 st argument to c
0e30: 6f 6d 70 61 72 65 20 66 75 6e 63 74 69 6f 6e 20 ompare function
0e40: 2a 2f 0a 20 20 42 74 43 75 72 73 6f 72 20 2a 2a */. BtCursor **
0e50: 70 70 43 75 72 73 6f 72 20 20 20 20 20 20 20 20 ppCursor
0e60: 20 20 20 20 20 20 20 20 20 20 2f 2a 20 52 65 74 /* Ret
0e70: 75 72 6e 65 64 20 63 75 72 73 6f 72 20 2a 2f 0a urned cursor */.
0e80: 29 3b 0a 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 );..void sqlite3
0e90: 42 74 72 65 65 53 65 74 43 6f 6d 70 61 72 65 28 BtreeSetCompare(
0ea0: 0a 20 20 42 74 43 75 72 73 6f 72 20 2a 2c 0a 20 . BtCursor *,.
0eb0: 20 69 6e 74 28 2a 29 28 76 6f 69 64 2a 2c 69 6e int(*)(void*,in
0ec0: 74 2c 63 6f 6e 73 74 20 76 6f 69 64 2a 2c 69 6e t,const void*,in
0ed0: 74 2c 63 6f 6e 73 74 20 76 6f 69 64 2a 29 2c 0a t,const void*),.
0ee0: 20 20 76 6f 69 64 2a 0a 29 3b 0a 0a 69 6e 74 20 void*.);..int
0ef0: 73 71 6c 69 74 65 33 42 74 72 65 65 43 6c 6f 73 sqlite3BtreeClos
0f00: 65 43 75 72 73 6f 72 28 42 74 43 75 72 73 6f 72 eCursor(BtCursor
0f10: 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 *);.int sqlite3B
0f20: 74 72 65 65 4d 6f 76 65 74 6f 28 42 74 43 75 72 treeMoveto(BtCur
0f30: 73 6f 72 2a 2c 20 63 6f 6e 73 74 20 76 6f 69 64 sor*, const void
0f40: 20 2a 70 4b 65 79 2c 20 69 36 34 20 6e 4b 65 79 *pKey, i64 nKey
0f50: 2c 20 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69 6e , int *pRes);.in
0f60: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 44 65 t sqlite3BtreeDe
0f70: 6c 65 74 65 28 42 74 43 75 72 73 6f 72 2a 29 3b lete(BtCursor*);
0f80: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 .int sqlite3Btre
0f90: 65 49 6e 73 65 72 74 28 42 74 43 75 72 73 6f 72 eInsert(BtCursor
0fa0: 2a 2c 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a 70 *, const void *p
0fb0: 4b 65 79 2c 20 69 36 34 20 6e 4b 65 79 2c 0a 20 Key, i64 nKey,.
0fc0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
0fd0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
0fe0: 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a 70 44 61 const void *pDa
0ff0: 74 61 2c 20 69 6e 74 20 6e 44 61 74 61 29 3b 0a ta, int nData);.
1000: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 int sqlite3Btree
1010: 46 69 72 73 74 28 42 74 43 75 72 73 6f 72 2a 2c First(BtCursor*,
1020: 20 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69 6e 74 int *pRes);.int
1030: 20 73 71 6c 69 74 65 33 42 74 72 65 65 4c 61 73 sqlite3BtreeLas
1040: 74 28 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e 74 t(BtCursor*, int
1050: 20 2a 70 52 65 73 29 3b 0a 69 6e 74 20 73 71 6c *pRes);.int sql
1060: 69 74 65 33 42 74 72 65 65 4e 65 78 74 28 42 74 ite3BtreeNext(Bt
1070: 43 75 72 73 6f 72 2a 2c 20 69 6e 74 20 2a 70 52 Cursor*, int *pR
1080: 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 es);.int sqlite3
1090: 42 74 72 65 65 45 6f 66 28 42 74 43 75 72 73 6f BtreeEof(BtCurso
10a0: 72 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 r*);.int sqlite3
10b0: 42 74 72 65 65 46 6c 61 67 73 28 42 74 43 75 72 BtreeFlags(BtCur
10c0: 73 6f 72 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 sor*);.int sqlit
10d0: 65 33 42 74 72 65 65 50 72 65 76 69 6f 75 73 28 e3BtreePrevious(
10e0: 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e 74 20 2a BtCursor*, int *
10f0: 70 52 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69 74 pRes);.int sqlit
1100: 65 33 42 74 72 65 65 4b 65 79 53 69 7a 65 28 42 e3BtreeKeySize(B
1110: 74 43 75 72 73 6f 72 2a 2c 20 69 36 34 20 2a 70 tCursor*, i64 *p
1120: 53 69 7a 65 29 3b 0a 69 6e 74 20 73 71 6c 69 74 Size);.int sqlit
1130: 65 33 42 74 72 65 65 4b 65 79 28 42 74 43 75 72 e3BtreeKey(BtCur
1140: 73 6f 72 2a 2c 20 75 33 32 20 6f 66 66 73 65 74 sor*, u32 offset
1150: 2c 20 75 33 32 20 61 6d 74 2c 20 76 6f 69 64 2a , u32 amt, void*
1160: 29 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20 2a 73 );.const void *s
1170: 71 6c 69 74 65 33 42 74 72 65 65 4b 65 79 46 65 qlite3BtreeKeyFe
1180: 74 63 68 28 42 74 43 75 72 73 6f 72 2a 2c 20 69 tch(BtCursor*, i
1190: 6e 74 20 2a 70 41 6d 74 29 3b 0a 63 6f 6e 73 74 nt *pAmt);.const
11a0: 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 42 74 void *sqlite3Bt
11b0: 72 65 65 44 61 74 61 46 65 74 63 68 28 42 74 43 reeDataFetch(BtC
11c0: 75 72 73 6f 72 2a 2c 20 69 6e 74 20 2a 70 41 6d ursor*, int *pAm
11d0: 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 t);.int sqlite3B
11e0: 74 72 65 65 44 61 74 61 53 69 7a 65 28 42 74 43 treeDataSize(BtC
11f0: 75 72 73 6f 72 2a 2c 20 75 33 32 20 2a 70 53 69 ursor*, u32 *pSi
1200: 7a 65 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 ze);.int sqlite3
1210: 42 74 72 65 65 44 61 74 61 28 42 74 43 75 72 73 BtreeData(BtCurs
1220: 6f 72 2a 2c 20 75 33 32 20 6f 66 66 73 65 74 2c or*, u32 offset,
1230: 20 75 33 32 20 61 6d 74 2c 20 76 6f 69 64 2a 29 u32 amt, void*)
1240: 3b 0a 0a 63 68 61 72 20 2a 73 71 6c 69 74 65 33 ;..char *sqlite3
1250: 42 74 72 65 65 49 6e 74 65 67 72 69 74 79 43 68 BtreeIntegrityCh
1260: 65 63 6b 28 42 74 72 65 65 2a 2c 20 69 6e 74 20 eck(Btree*, int
1270: 2a 61 52 6f 6f 74 2c 20 69 6e 74 20 6e 52 6f 6f *aRoot, int nRoo
1280: 74 29 3b 0a 73 74 72 75 63 74 20 50 61 67 65 72 t);.struct Pager
1290: 20 2a 73 71 6c 69 74 65 33 42 74 72 65 65 50 61 *sqlite3BtreePa
12a0: 67 65 72 28 42 74 72 65 65 2a 29 3b 0a 0a 0a 23 ger(Btree*);...#
12b0: 69 66 64 65 66 20 53 51 4c 49 54 45 5f 54 45 53 ifdef SQLITE_TES
12c0: 54 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 T.int sqlite3Btr
12d0: 65 65 43 75 72 73 6f 72 49 6e 66 6f 28 42 74 43 eeCursorInfo(BtC
12e0: 75 72 73 6f 72 2a 2c 20 69 6e 74 2a 2c 20 69 6e ursor*, int*, in
12f0: 74 29 3b 0a 76 6f 69 64 20 73 71 6c 69 74 65 33 t);.void sqlite3
1300: 42 74 72 65 65 43 75 72 73 6f 72 4c 69 73 74 28 BtreeCursorList(
1310: 42 74 72 65 65 2a 29 3b 0a 23 65 6e 64 69 66 0a Btree*);.#endif.
1320: 0a 23 69 66 64 65 66 20 53 51 4c 49 54 45 5f 44 .#ifdef SQLITE_D
1330: 45 42 55 47 0a 69 6e 74 20 73 71 6c 69 74 65 33 EBUG.int sqlite3
1340: 42 74 72 65 65 50 61 67 65 44 75 6d 70 28 42 74 BtreePageDump(Bt
1350: 72 65 65 2a 2c 20 69 6e 74 2c 20 69 6e 74 20 72 ree*, int, int r
1360: 65 63 75 72 73 69 76 65 29 3b 0a 23 65 6c 73 65 ecursive);.#else
1370: 0a 23 64 65 66 69 6e 65 20 73 71 6c 69 74 65 33 .#define sqlite3
1380: 42 74 72 65 65 50 61 67 65 44 75 6d 70 28 58 2c BtreePageDump(X,
1390: 59 2c 5a 29 20 53 51 4c 49 54 45 5f 4f 4b 0a 23 Y,Z) SQLITE_OK.#
13a0: 65 6e 64 69 66 0a 0a 23 65 6e 64 69 66 20 2f 2a endif..#endif /*
13b0: 20 5f 42 54 52 45 45 5f 48 5f 20 2a 2f 0a _BTREE_H_ */.