blob: 69e72e3e71d0832b58d01a4628502b4c2317e84e [file] [log] [blame]
drha059ad02001-04-17 20:09:11 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drha059ad02001-04-17 20:09:11 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drha059ad02001-04-17 20:09:11 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
drha059ad02001-04-17 20:09:11 +000010**
11*************************************************************************
12** This header file defines the interface that the sqlite B-Tree file
drh6446c4d2001-12-15 14:22:18 +000013** subsystem. See comments in the source code for a detailed description
14** of what each interface routine does.
drha059ad02001-04-17 20:09:11 +000015**
danielk19772dec9702007-05-02 16:48:37 +000016** @(#) $Id: btree.h,v 1.78 2007/05/02 16:48:37 danielk1977 Exp $
drha059ad02001-04-17 20:09:11 +000017*/
drhbe0072d2001-09-13 14:46:09 +000018#ifndef _BTREE_H_
19#define _BTREE_H_
drha059ad02001-04-17 20:09:11 +000020
danielk19774adee202004-05-08 08:23:19 +000021/* TODO: This definition is just included so other modules compile. It
22** needs to be revisited.
23*/
24#define SQLITE_N_BTREE_META 10
25
drh73509ee2003-04-06 20:44:45 +000026/*
danielk1977951af802004-11-05 15:45:09 +000027** If defined as non-zero, auto-vacuum is enabled by default. Otherwise
28** it must be turned on for each database using "PRAGMA auto_vacuum = 1".
29*/
30#ifndef SQLITE_DEFAULT_AUTOVACUUM
31 #define SQLITE_DEFAULT_AUTOVACUUM 0
32#endif
33
danielk1977dddbcdc2007-04-26 14:42:34 +000034#define BTREE_AUTOVACUUM_NONE 0 /* Do not do auto-vacuum */
35#define BTREE_AUTOVACUUM_FULL 1 /* Do full auto-vacuum */
36#define BTREE_AUTOVACUUM_INCR 2 /* Incremental vacuum */
37
danielk1977951af802004-11-05 15:45:09 +000038/*
drh73509ee2003-04-06 20:44:45 +000039** Forward declarations of structure
40*/
drha059ad02001-04-17 20:09:11 +000041typedef struct Btree Btree;
42typedef struct BtCursor BtCursor;
danielk1977aef0bf62005-12-30 16:28:01 +000043typedef struct BtShared BtShared;
paulb95a8862003-04-01 21:16:41 +000044
drh73509ee2003-04-06 20:44:45 +000045
danielk197724162fe2004-06-04 06:22:00 +000046int sqlite3BtreeOpen(
drh90f5ecb2004-07-22 01:19:35 +000047 const char *zFilename, /* Name of database file to open */
danielk1977aef0bf62005-12-30 16:28:01 +000048 sqlite3 *db, /* Associated database connection */
drh90f5ecb2004-07-22 01:19:35 +000049 Btree **, /* Return open Btree* here */
50 int flags /* Flags */
danielk197724162fe2004-06-04 06:22:00 +000051);
drh3aac2dd2004-04-26 14:10:20 +000052
53/* The flags parameter to sqlite3BtreeOpen can be the bitwise or of the
54** following values.
drh7bec5052005-02-06 02:45:41 +000055**
56** NOTE: These values must match the corresponding PAGER_ values in
57** pager.h.
drh73509ee2003-04-06 20:44:45 +000058*/
drh3aac2dd2004-04-26 14:10:20 +000059#define BTREE_OMIT_JOURNAL 1 /* Do not use journal. No argument */
drh7bec5052005-02-06 02:45:41 +000060#define BTREE_NO_READLOCK 2 /* Omit readlocks on readonly files */
61#define BTREE_MEMORY 4 /* In-memory DB. No argument */
drh73509ee2003-04-06 20:44:45 +000062
drh3aac2dd2004-04-26 14:10:20 +000063int sqlite3BtreeClose(Btree*);
drh90f5ecb2004-07-22 01:19:35 +000064int sqlite3BtreeSetBusyHandler(Btree*,BusyHandler*);
drh3aac2dd2004-04-26 14:10:20 +000065int sqlite3BtreeSetCacheSize(Btree*,int);
drhac530b12006-02-11 01:25:50 +000066int sqlite3BtreeSetSafetyLevel(Btree*,int,int);
drh2c8997b2005-08-27 16:36:48 +000067int sqlite3BtreeSyncDisabled(Btree*);
drh90f5ecb2004-07-22 01:19:35 +000068int sqlite3BtreeSetPageSize(Btree*,int,int);
69int sqlite3BtreeGetPageSize(Btree*);
drh2011d5f2004-07-22 02:40:37 +000070int sqlite3BtreeGetReserve(Btree*);
danielk1977951af802004-11-05 15:45:09 +000071int sqlite3BtreeSetAutoVacuum(Btree *, int);
72int sqlite3BtreeGetAutoVacuum(Btree *);
danielk197740b38dc2004-06-26 08:38:24 +000073int sqlite3BtreeBeginTrans(Btree*,int);
drh80e35f42007-03-30 14:06:34 +000074int sqlite3BtreeCommitPhaseOne(Btree*, const char *zMaster);
75int sqlite3BtreeCommitPhaseTwo(Btree*);
drh3aac2dd2004-04-26 14:10:20 +000076int sqlite3BtreeCommit(Btree*);
77int sqlite3BtreeRollback(Btree*);
78int sqlite3BtreeBeginStmt(Btree*);
79int sqlite3BtreeCommitStmt(Btree*);
80int sqlite3BtreeRollbackStmt(Btree*);
81int sqlite3BtreeCreateTable(Btree*, int*, int flags);
danielk19771d850a72004-05-31 08:26:49 +000082int sqlite3BtreeIsInTrans(Btree*);
83int sqlite3BtreeIsInStmt(Btree*);
danielk19772372c2b2006-06-27 16:34:56 +000084int sqlite3BtreeIsInReadTrans(Btree*);
danielk1977da184232006-01-05 11:34:32 +000085void *sqlite3BtreeSchema(Btree *, int, void(*)(void *));
danielk1977c87d34d2006-01-06 13:00:28 +000086int sqlite3BtreeSchemaLocked(Btree *);
danielk1977c00da102006-01-07 13:21:04 +000087int sqlite3BtreeLockTable(Btree *, int, u8);
drh3aac2dd2004-04-26 14:10:20 +000088
danielk19774adee202004-05-08 08:23:19 +000089const char *sqlite3BtreeGetFilename(Btree *);
danielk19775865e3d2004-06-14 06:03:57 +000090const char *sqlite3BtreeGetDirname(Btree *);
91const char *sqlite3BtreeGetJournalname(Btree *);
danielk19774adee202004-05-08 08:23:19 +000092int sqlite3BtreeCopyFile(Btree *, Btree *);
93
danielk1977dddbcdc2007-04-26 14:42:34 +000094int sqlite3BtreeIncrVacuum(Btree *);
95
drh3aac2dd2004-04-26 14:10:20 +000096/* The flags parameter to sqlite3BtreeCreateTable can be the bitwise OR
97** of the following flags:
drh73509ee2003-04-06 20:44:45 +000098*/
drh8b18dd42004-05-12 19:18:15 +000099#define BTREE_INTKEY 1 /* Table has only 64-bit signed integer keys */
100#define BTREE_ZERODATA 2 /* Table has keys only - no data */
101#define BTREE_LEAFDATA 4 /* Data stored in leaves only. Implies INTKEY */
drh73509ee2003-04-06 20:44:45 +0000102
danielk1977a0bf2652004-11-04 14:30:04 +0000103int sqlite3BtreeDropTable(Btree*, int, int*);
drh3aac2dd2004-04-26 14:10:20 +0000104int sqlite3BtreeClearTable(Btree*, int);
105int sqlite3BtreeGetMeta(Btree*, int idx, u32 *pValue);
106int sqlite3BtreeUpdateMeta(Btree*, int idx, u32 value);
paulb95a8862003-04-01 21:16:41 +0000107
drh3aac2dd2004-04-26 14:10:20 +0000108int sqlite3BtreeCursor(
109 Btree*, /* BTree containing table to open */
110 int iTable, /* Index of root page */
111 int wrFlag, /* 1 for writing. 0 for read-only */
112 int(*)(void*,int,const void*,int,const void*), /* Key comparison function */
113 void*, /* First argument to compare function */
114 BtCursor **ppCursor /* Returned cursor */
115);
paulb95a8862003-04-01 21:16:41 +0000116
danielk1977bf3b7212004-05-18 10:06:24 +0000117void sqlite3BtreeSetCompare(
118 BtCursor *,
119 int(*)(void*,int,const void*,int,const void*),
120 void*
121);
122
drha34b6762004-05-07 13:30:42 +0000123int sqlite3BtreeCloseCursor(BtCursor*);
drhe4d90812007-03-29 05:51:49 +0000124int sqlite3BtreeMoveto(BtCursor*,const void *pKey,i64 nKey,int bias,int *pRes);
drh3aac2dd2004-04-26 14:10:20 +0000125int sqlite3BtreeDelete(BtCursor*);
drh4a1c3802004-05-12 15:15:47 +0000126int sqlite3BtreeInsert(BtCursor*, const void *pKey, i64 nKey,
drhb026e052007-05-02 01:34:31 +0000127 const void *pData, int nData,
128 int nZero, int bias);
drh3aac2dd2004-04-26 14:10:20 +0000129int sqlite3BtreeFirst(BtCursor*, int *pRes);
130int sqlite3BtreeLast(BtCursor*, int *pRes);
131int sqlite3BtreeNext(BtCursor*, int *pRes);
drhc39e0002004-05-07 23:50:57 +0000132int sqlite3BtreeEof(BtCursor*);
drhf328bc82004-05-10 23:29:49 +0000133int sqlite3BtreeFlags(BtCursor*);
drh3aac2dd2004-04-26 14:10:20 +0000134int sqlite3BtreePrevious(BtCursor*, int *pRes);
drh4a1c3802004-05-12 15:15:47 +0000135int sqlite3BtreeKeySize(BtCursor*, i64 *pSize);
drh3aac2dd2004-04-26 14:10:20 +0000136int sqlite3BtreeKey(BtCursor*, u32 offset, u32 amt, void*);
drhe51c44f2004-05-30 20:46:09 +0000137const void *sqlite3BtreeKeyFetch(BtCursor*, int *pAmt);
138const void *sqlite3BtreeDataFetch(BtCursor*, int *pAmt);
drh3aac2dd2004-04-26 14:10:20 +0000139int sqlite3BtreeDataSize(BtCursor*, u32 *pSize);
140int sqlite3BtreeData(BtCursor*, u32 offset, u32 amt, void*);
drh144f9ea2003-04-16 01:28:16 +0000141
drh1dcdbc02007-01-27 02:24:54 +0000142char *sqlite3BtreeIntegrityCheck(Btree*, int *aRoot, int nRoot, int, int*);
drha34b6762004-05-07 13:30:42 +0000143struct Pager *sqlite3BtreePager(Btree*);
144
danielk1977b4e9af92007-05-01 17:49:49 +0000145int sqlite3BtreePutData(BtCursor*, u32 offset, u32 amt, const void*);
danielk19772dec9702007-05-02 16:48:37 +0000146void sqlite3BtreeCacheOverflow(BtCursor *);
drhf328bc82004-05-10 23:29:49 +0000147
drha34b6762004-05-07 13:30:42 +0000148#ifdef SQLITE_TEST
drh3e27c022004-07-23 00:01:38 +0000149int sqlite3BtreeCursorInfo(BtCursor*, int*, int);
drhc8629a12004-05-08 20:07:40 +0000150void sqlite3BtreeCursorList(Btree*);
drha34b6762004-05-07 13:30:42 +0000151#endif
152
danielk1977b5402fb2005-01-12 07:15:04 +0000153#ifdef SQLITE_DEBUG
154int sqlite3BtreePageDump(Btree*, int, int recursive);
155#else
156#define sqlite3BtreePageDump(X,Y,Z) SQLITE_OK
157#endif
drhbe0072d2001-09-13 14:46:09 +0000158
159#endif /* _BTREE_H_ */