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 37 20 32 30 30 tree.h,v 1.7 200
0250: 35 2f 30 38 2f 32 32 20 31 38 3a 32 32 3a 31 32 5/08/22 18:22:12
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 65 74 50 61 67 65 53 69 7a 65 28 treeSetPageSize(
0770: 42 74 72 65 65 2a 2c 69 6e 74 2c 69 6e 74 29 3b Btree*,int,int);
0780: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 .int sqlite3Btre
0790: 65 47 65 74 50 61 67 65 53 69 7a 65 28 42 74 72 eGetPageSize(Btr
07a0: 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 ee*);.int sqlite
07b0: 33 42 74 72 65 65 47 65 74 52 65 73 65 72 76 65 3BtreeGetReserve
07c0: 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71 (Btree*);.int sq
07d0: 6c 69 74 65 33 42 74 72 65 65 53 65 74 41 75 74 lite3BtreeSetAut
07e0: 6f 56 61 63 75 75 6d 28 42 74 72 65 65 20 2a 2c oVacuum(Btree *,
07f0: 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 int);.int sqlit
0800: 65 33 42 74 72 65 65 47 65 74 41 75 74 6f 56 61 e3BtreeGetAutoVa
0810: 63 75 75 6d 28 42 74 72 65 65 20 2a 29 3b 0a 69 cuum(Btree *);.i
0820: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 42 nt sqlite3BtreeB
0830: 65 67 69 6e 54 72 61 6e 73 28 42 74 72 65 65 2a eginTrans(Btree*
0840: 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c 69 74 ,int);.int sqlit
0850: 65 33 42 74 72 65 65 43 6f 6d 6d 69 74 28 42 74 e3BtreeCommit(Bt
0860: 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 ree*);.int sqlit
0870: 65 33 42 74 72 65 65 52 6f 6c 6c 62 61 63 6b 28 e3BtreeRollback(
0880: 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c Btree*);.int sql
0890: 69 74 65 33 42 74 72 65 65 42 65 67 69 6e 53 74 ite3BtreeBeginSt
08a0: 6d 74 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74 20 mt(Btree*);.int
08b0: 73 71 6c 69 74 65 33 42 74 72 65 65 43 6f 6d 6d sqlite3BtreeComm
08c0: 69 74 53 74 6d 74 28 42 74 72 65 65 2a 29 3b 0a itStmt(Btree*);.
08d0: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 int sqlite3Btree
08e0: 52 6f 6c 6c 62 61 63 6b 53 74 6d 74 28 42 74 72 RollbackStmt(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 43 72 65 61 74 65 54 61 62 6c 3BtreeCreateTabl
0910: 65 28 42 74 72 65 65 2a 2c 20 69 6e 74 2a 2c 20 e(Btree*, int*,
0920: 69 6e 74 20 66 6c 61 67 73 29 3b 0a 69 6e 74 20 int flags);.int
0930: 73 71 6c 69 74 65 33 42 74 72 65 65 49 73 49 6e sqlite3BtreeIsIn
0940: 54 72 61 6e 73 28 42 74 72 65 65 2a 29 3b 0a 69 Trans(Btree*);.i
0950: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 49 nt sqlite3BtreeI
0960: 73 49 6e 53 74 6d 74 28 42 74 72 65 65 2a 29 3b sInStmt(Btree*);
0970: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 .int sqlite3Btre
0980: 65 53 79 6e 63 28 42 74 72 65 65 2a 2c 20 63 6f eSync(Btree*, co
0990: 6e 73 74 20 63 68 61 72 20 2a 7a 4d 61 73 74 65 nst char *zMaste
09a0: 72 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 r);.int sqlite3B
09b0: 74 72 65 65 52 65 73 65 74 28 42 74 72 65 65 20 treeReset(Btree
09c0: 2a 29 3b 0a 0a 63 6f 6e 73 74 20 63 68 61 72 20 *);..const char
09d0: 2a 73 71 6c 69 74 65 33 42 74 72 65 65 47 65 74 *sqlite3BtreeGet
09e0: 46 69 6c 65 6e 61 6d 65 28 42 74 72 65 65 20 2a Filename(Btree *
09f0: 29 3b 0a 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 );.const char *s
0a00: 71 6c 69 74 65 33 42 74 72 65 65 47 65 74 44 69 qlite3BtreeGetDi
0a10: 72 6e 61 6d 65 28 42 74 72 65 65 20 2a 29 3b 0a rname(Btree *);.
0a20: 63 6f 6e 73 74 20 63 68 61 72 20 2a 73 71 6c 69 const char *sqli
0a30: 74 65 33 42 74 72 65 65 47 65 74 4a 6f 75 72 6e te3BtreeGetJourn
0a40: 61 6c 6e 61 6d 65 28 42 74 72 65 65 20 2a 29 3b alname(Btree *);
0a50: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 .int sqlite3Btre
0a60: 65 43 6f 70 79 46 69 6c 65 28 42 74 72 65 65 20 eCopyFile(Btree
0a70: 2a 2c 20 42 74 72 65 65 20 2a 29 3b 0a 0a 2f 2a *, Btree *);../*
0a80: 20 54 68 65 20 66 6c 61 67 73 20 70 61 72 61 6d The flags param
0a90: 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33 42 eter to sqlite3B
0aa0: 74 72 65 65 43 72 65 61 74 65 54 61 62 6c 65 20 treeCreateTable
0ab0: 63 61 6e 20 62 65 20 74 68 65 20 62 69 74 77 69 can be the bitwi
0ac0: 73 65 20 4f 52 0a 2a 2a 20 6f 66 20 74 68 65 20 se OR.** of the
0ad0: 66 6f 6c 6c 6f 77 69 6e 67 20 66 6c 61 67 73 3a following flags:
0ae0: 0a 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52 45 .*/.#define BTRE
0af0: 45 5f 49 4e 54 4b 45 59 20 20 20 20 20 31 20 20 E_INTKEY 1
0b00: 20 20 2f 2a 20 54 61 62 6c 65 20 68 61 73 20 6f /* Table has o
0b10: 6e 6c 79 20 36 34 2d 62 69 74 20 73 69 67 6e 65 nly 64-bit signe
0b20: 64 20 69 6e 74 65 67 65 72 20 6b 65 79 73 20 2a d integer keys *
0b30: 2f 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45 5f /.#define BTREE_
0b40: 5a 45 52 4f 44 41 54 41 20 20 20 32 20 20 20 20 ZERODATA 2
0b50: 2f 2a 20 54 61 62 6c 65 20 68 61 73 20 6b 65 79 /* Table has key
0b60: 73 20 6f 6e 6c 79 20 2d 20 6e 6f 20 64 61 74 61 s only - no data
0b70: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52 45 */.#define BTRE
0b80: 45 5f 4c 45 41 46 44 41 54 41 20 20 20 34 20 20 E_LEAFDATA 4
0b90: 20 20 2f 2a 20 44 61 74 61 20 73 74 6f 72 65 64 /* Data stored
0ba0: 20 69 6e 20 6c 65 61 76 65 73 20 6f 6e 6c 79 2e in leaves only.
0bb0: 20 20 49 6d 70 6c 69 65 73 20 49 4e 54 4b 45 59 Implies INTKEY
0bc0: 20 2a 2f 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33 */..int sqlite3
0bd0: 42 74 72 65 65 44 72 6f 70 54 61 62 6c 65 28 42 BtreeDropTable(B
0be0: 74 72 65 65 2a 2c 20 69 6e 74 2c 20 69 6e 74 2a tree*, int, int*
0bf0: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 );.int sqlite3Bt
0c00: 72 65 65 43 6c 65 61 72 54 61 62 6c 65 28 42 74 reeClearTable(Bt
0c10: 72 65 65 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 ree*, int);.int
0c20: 73 71 6c 69 74 65 33 42 74 72 65 65 47 65 74 4d sqlite3BtreeGetM
0c30: 65 74 61 28 42 74 72 65 65 2a 2c 20 69 6e 74 20 eta(Btree*, int
0c40: 69 64 78 2c 20 75 33 32 20 2a 70 56 61 6c 75 65 idx, u32 *pValue
0c50: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 );.int sqlite3Bt
0c60: 72 65 65 55 70 64 61 74 65 4d 65 74 61 28 42 74 reeUpdateMeta(Bt
0c70: 72 65 65 2a 2c 20 69 6e 74 20 69 64 78 2c 20 75 ree*, int idx, u
0c80: 33 32 20 76 61 6c 75 65 29 3b 0a 0a 69 6e 74 20 32 value);..int
0c90: 73 71 6c 69 74 65 33 42 74 72 65 65 43 75 72 73 sqlite3BtreeCurs
0ca0: 6f 72 28 0a 20 20 42 74 72 65 65 2a 2c 20 20 20 or(. Btree*,
0cb0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
0cc0: 20 20 20 20 20 20 20 20 20 20 20 2f 2a 20 42 54 /* BT
0cd0: 72 65 65 20 63 6f 6e 74 61 69 6e 69 6e 67 20 74 ree containing t
0ce0: 61 62 6c 65 20 74 6f 20 6f 70 65 6e 20 2a 2f 0a able to open */.
0cf0: 20 20 69 6e 74 20 69 54 61 62 6c 65 2c 20 20 20 int iTable,
0d00: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
0d10: 20 20 20 20 20 20 20 2f 2a 20 49 6e 64 65 78 20 /* Index
0d20: 6f 66 20 72 6f 6f 74 20 70 61 67 65 20 2a 2f 0a of root page */.
0d30: 20 20 69 6e 74 20 77 72 46 6c 61 67 2c 20 20 20 int wrFlag,
0d40: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
0d50: 20 20 20 20 20 20 20 2f 2a 20 31 20 66 6f 72 20 /* 1 for
0d60: 77 72 69 74 69 6e 67 2e 20 20 30 20 66 6f 72 20 writing. 0 for
0d70: 72 65 61 64 2d 6f 6e 6c 79 20 2a 2f 0a 20 20 69 read-only */. i
0d80: 6e 74 28 2a 29 28 76 6f 69 64 2a 2c 69 6e 74 2c nt(*)(void*,int,
0d90: 63 6f 6e 73 74 20 76 6f 69 64 2a 2c 69 6e 74 2c const void*,int,
0da0: 63 6f 6e 73 74 20 76 6f 69 64 2a 29 2c 20 20 2f const void*), /
0db0: 2a 20 4b 65 79 20 63 6f 6d 70 61 72 69 73 6f 6e * Key comparison
0dc0: 20 66 75 6e 63 74 69 6f 6e 20 2a 2f 0a 20 20 76 function */. v
0dd0: 6f 69 64 2a 2c 20 20 20 20 20 20 20 20 20 20 20 oid*,
0de0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
0df0: 20 20 20 20 2f 2a 20 46 69 72 73 74 20 61 72 67 /* First arg
0e00: 75 6d 65 6e 74 20 74 6f 20 63 6f 6d 70 61 72 65 ument to compare
0e10: 20 66 75 6e 63 74 69 6f 6e 20 2a 2f 0a 20 20 42 function */. B
0e20: 74 43 75 72 73 6f 72 20 2a 2a 70 70 43 75 72 73 tCursor **ppCurs
0e30: 6f 72 20 20 20 20 20 20 20 20 20 20 20 20 20 20 or
0e40: 20 20 20 20 2f 2a 20 52 65 74 75 72 6e 65 64 20 /* Returned
0e50: 63 75 72 73 6f 72 20 2a 2f 0a 29 3b 0a 0a 76 6f cursor */.);..vo
0e60: 69 64 20 73 71 6c 69 74 65 33 42 74 72 65 65 53 id sqlite3BtreeS
0e70: 65 74 43 6f 6d 70 61 72 65 28 0a 20 20 42 74 43 etCompare(. BtC
0e80: 75 72 73 6f 72 20 2a 2c 0a 20 20 69 6e 74 28 2a ursor *,. int(*
0e90: 29 28 76 6f 69 64 2a 2c 69 6e 74 2c 63 6f 6e 73 )(void*,int,cons
0ea0: 74 20 76 6f 69 64 2a 2c 69 6e 74 2c 63 6f 6e 73 t void*,int,cons
0eb0: 74 20 76 6f 69 64 2a 29 2c 0a 20 20 76 6f 69 64 t void*),. void
0ec0: 2a 0a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 *.);..int sqlite
0ed0: 33 42 74 72 65 65 43 6c 6f 73 65 43 75 72 73 6f 3BtreeCloseCurso
0ee0: 72 28 42 74 43 75 72 73 6f 72 2a 29 3b 0a 69 6e r(BtCursor*);.in
0ef0: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 4d 6f t sqlite3BtreeMo
0f00: 76 65 74 6f 28 42 74 43 75 72 73 6f 72 2a 2c 20 veto(BtCursor*,
0f10: 63 6f 6e 73 74 20 76 6f 69 64 20 2a 70 4b 65 79 const void *pKey
0f20: 2c 20 69 36 34 20 6e 4b 65 79 2c 20 69 6e 74 20 , i64 nKey, int
0f30: 2a 70 52 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69 *pRes);.int sqli
0f40: 74 65 33 42 74 72 65 65 44 65 6c 65 74 65 28 42 te3BtreeDelete(B
0f50: 74 43 75 72 73 6f 72 2a 29 3b 0a 69 6e 74 20 73 tCursor*);.int s
0f60: 71 6c 69 74 65 33 42 74 72 65 65 49 6e 73 65 72 qlite3BtreeInser
0f70: 74 28 42 74 43 75 72 73 6f 72 2a 2c 20 63 6f 6e t(BtCursor*, con
0f80: 73 74 20 76 6f 69 64 20 2a 70 4b 65 79 2c 20 69 st void *pKey, i
0f90: 36 34 20 6e 4b 65 79 2c 0a 20 20 20 20 20 20 20 64 nKey,.
0fa0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20
0fb0: 20 20 20 20 20 20 20 20 20 20 20 63 6f 6e 73 74 const
0fc0: 20 76 6f 69 64 20 2a 70 44 61 74 61 2c 20 69 6e void *pData, in
0fd0: 74 20 6e 44 61 74 61 29 3b 0a 69 6e 74 20 73 71 t nData);.int sq
0fe0: 6c 69 74 65 33 42 74 72 65 65 46 69 72 73 74 28 lite3BtreeFirst(
0ff0: 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e 74 20 2a BtCursor*, int *
1000: 70 52 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69 74 pRes);.int sqlit
1010: 65 33 42 74 72 65 65 4c 61 73 74 28 42 74 43 75 e3BtreeLast(BtCu
1020: 72 73 6f 72 2a 2c 20 69 6e 74 20 2a 70 52 65 73 rsor*, int *pRes
1030: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 );.int sqlite3Bt
1040: 72 65 65 4e 65 78 74 28 42 74 43 75 72 73 6f 72 reeNext(BtCursor
1050: 2a 2c 20 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69 *, int *pRes);.i
1060: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 45 nt sqlite3BtreeE
1070: 6f 66 28 42 74 43 75 72 73 6f 72 2a 29 3b 0a 69 of(BtCursor*);.i
1080: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 46 nt sqlite3BtreeF
1090: 6c 61 67 73 28 42 74 43 75 72 73 6f 72 2a 29 3b lags(BtCursor*);
10a0: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 .int sqlite3Btre
10b0: 65 50 72 65 76 69 6f 75 73 28 42 74 43 75 72 73 ePrevious(BtCurs
10c0: 6f 72 2a 2c 20 69 6e 74 20 2a 70 52 65 73 29 3b or*, int *pRes);
10d0: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 .int sqlite3Btre
10e0: 65 4b 65 79 53 69 7a 65 28 42 74 43 75 72 73 6f eKeySize(BtCurso
10f0: 72 2a 2c 20 69 36 34 20 2a 70 53 69 7a 65 29 3b r*, i64 *pSize);
1100: 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 .int sqlite3Btre
1110: 65 4b 65 79 28 42 74 43 75 72 73 6f 72 2a 2c 20 eKey(BtCursor*,
1120: 75 33 32 20 6f 66 66 73 65 74 2c 20 75 33 32 20 u32 offset, u32
1130: 61 6d 74 2c 20 76 6f 69 64 2a 29 3b 0a 63 6f 6e amt, void*);.con
1140: 73 74 20 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 st void *sqlite3
1150: 42 74 72 65 65 4b 65 79 46 65 74 63 68 28 42 74 BtreeKeyFetch(Bt
1160: 43 75 72 73 6f 72 2a 2c 20 69 6e 74 20 2a 70 41 Cursor*, int *pA
1170: 6d 74 29 3b 0a 63 6f 6e 73 74 20 76 6f 69 64 20 mt);.const void
1180: 2a 73 71 6c 69 74 65 33 42 74 72 65 65 44 61 74 *sqlite3BtreeDat
1190: 61 46 65 74 63 68 28 42 74 43 75 72 73 6f 72 2a aFetch(BtCursor*
11a0: 2c 20 69 6e 74 20 2a 70 41 6d 74 29 3b 0a 69 6e , int *pAmt);.in
11b0: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 44 61 t sqlite3BtreeDa
11c0: 74 61 53 69 7a 65 28 42 74 43 75 72 73 6f 72 2a taSize(BtCursor*
11d0: 2c 20 75 33 32 20 2a 70 53 69 7a 65 29 3b 0a 69 , u32 *pSize);.i
11e0: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 44 nt sqlite3BtreeD
11f0: 61 74 61 28 42 74 43 75 72 73 6f 72 2a 2c 20 75 ata(BtCursor*, u
1200: 33 32 20 6f 66 66 73 65 74 2c 20 75 33 32 20 61 32 offset, u32 a
1210: 6d 74 2c 20 76 6f 69 64 2a 29 3b 0a 0a 63 68 61 mt, void*);..cha
1220: 72 20 2a 73 71 6c 69 74 65 33 42 74 72 65 65 49 r *sqlite3BtreeI
1230: 6e 74 65 67 72 69 74 79 43 68 65 63 6b 28 42 74 ntegrityCheck(Bt
1240: 72 65 65 2a 2c 20 69 6e 74 20 2a 61 52 6f 6f 74 ree*, int *aRoot
1250: 2c 20 69 6e 74 20 6e 52 6f 6f 74 29 3b 0a 73 74 , int nRoot);.st
1260: 72 75 63 74 20 50 61 67 65 72 20 2a 73 71 6c 69 ruct Pager *sqli
1270: 74 65 33 42 74 72 65 65 50 61 67 65 72 28 42 74 te3BtreePager(Bt
1280: 72 65 65 2a 29 3b 0a 0a 0a 23 69 66 64 65 66 20 ree*);...#ifdef
1290: 53 51 4c 49 54 45 5f 54 45 53 54 0a 69 6e 74 20 SQLITE_TEST.int
12a0: 73 71 6c 69 74 65 33 42 74 72 65 65 43 75 72 73 sqlite3BtreeCurs
12b0: 6f 72 49 6e 66 6f 28 42 74 43 75 72 73 6f 72 2a orInfo(BtCursor*
12c0: 2c 20 69 6e 74 2a 2c 20 69 6e 74 29 3b 0a 76 6f , int*, int);.vo
12d0: 69 64 20 73 71 6c 69 74 65 33 42 74 72 65 65 43 id sqlite3BtreeC
12e0: 75 72 73 6f 72 4c 69 73 74 28 42 74 72 65 65 2a ursorList(Btree*
12f0: 29 3b 0a 23 65 6e 64 69 66 0a 0a 23 69 66 64 65 );.#endif..#ifde
1300: 66 20 53 51 4c 49 54 45 5f 44 45 42 55 47 0a 69 f SQLITE_DEBUG.i
1310: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 50 nt sqlite3BtreeP
1320: 61 67 65 44 75 6d 70 28 42 74 72 65 65 2a 2c 20 ageDump(Btree*,
1330: 69 6e 74 2c 20 69 6e 74 20 72 65 63 75 72 73 69 int, int recursi
1340: 76 65 29 3b 0a 23 65 6c 73 65 0a 23 64 65 66 69 ve);.#else.#defi
1350: 6e 65 20 73 71 6c 69 74 65 33 42 74 72 65 65 50 ne sqlite3BtreeP
1360: 61 67 65 44 75 6d 70 28 58 2c 59 2c 5a 29 20 53 ageDump(X,Y,Z) S
1370: 51 4c 49 54 45 5f 4f 4b 0a 23 65 6e 64 69 66 0a QLITE_OK.#endif.
1380: 0a 23 65 6e 64 69 66 20 2f 2a 20 5f 42 54 52 45 .#endif /* _BTRE
1390: 45 5f 48 5f 20 2a 2f 0a E_H_ */.