4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing:
7 ** 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.
11 *************************************************************************
12 ** This header file defines the interface that the sqlite B-Tree file
13 ** subsystem. See comments in the source code for a detailed description
14 ** of what each interface routine does.
16 ** @(#) $Id: btree.h,v 1.103 2008/08/13 19:11:48 drh Exp $
21 /* TODO: This definition is just included so other modules compile. It
22 ** needs to be revisited.
24 #define SQLITE_N_BTREE_META 10
27 ** 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".
30 #ifndef SQLITE_DEFAULT_AUTOVACUUM
31 #define SQLITE_DEFAULT_AUTOVACUUM 0
34 #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 */
39 ** Forward declarations of structure
41 typedef struct Btree Btree;
42 typedef struct BtCursor BtCursor;
43 typedef struct BtShared BtShared;
44 typedef struct BtreeMutexArray BtreeMutexArray;
47 ** This structure records all of the Btrees that need to hold
48 ** a mutex before we enter sqlite3VdbeExec(). The Btrees are
49 ** are placed in aBtree[] in order of aBtree[]->pBt. That way,
50 ** we can always lock and unlock them all quickly.
52 struct BtreeMutexArray {
54 Btree *aBtree[SQLITE_MAX_ATTACHED+1];
59 const char *zFilename, /* Name of database file to open */
60 sqlite3 *db, /* Associated database connection */
61 Btree **, /* Return open Btree* here */
62 int flags, /* Flags */
63 int vfsFlags /* Flags passed through to VFS open */
66 /* The flags parameter to sqlite3BtreeOpen can be the bitwise or of the
69 ** NOTE: These values must match the corresponding PAGER_ values in
72 #define BTREE_OMIT_JOURNAL 1 /* Do not use journal. No argument */
73 #define BTREE_NO_READLOCK 2 /* Omit readlocks on readonly files */
74 #define BTREE_MEMORY 4 /* In-memory DB. No argument */
75 #define BTREE_READONLY 8 /* Open the database in read-only mode */
76 #define BTREE_READWRITE 16 /* Open for both reading and writing */
77 #define BTREE_CREATE 32 /* Create the database if it does not exist */
79 int sqlite3BtreeClose(Btree*);
80 int sqlite3BtreeSetCacheSize(Btree*,int);
81 int sqlite3BtreeSetSafetyLevel(Btree*,int,int);
82 int sqlite3BtreeSyncDisabled(Btree*);
83 int sqlite3BtreeSetPageSize(Btree*,int,int);
84 int sqlite3BtreeGetPageSize(Btree*);
85 int sqlite3BtreeMaxPageCount(Btree*,int);
86 int sqlite3BtreeGetReserve(Btree*);
87 int sqlite3BtreeSetAutoVacuum(Btree *, int);
88 int sqlite3BtreeGetAutoVacuum(Btree *);
89 int sqlite3BtreeBeginTrans(Btree*,int);
90 int sqlite3BtreeCommitPhaseOne(Btree*, const char *zMaster);
91 int sqlite3BtreeCommitPhaseTwo(Btree*);
92 int sqlite3BtreeCommit(Btree*);
93 int sqlite3BtreeRollback(Btree*);
94 int sqlite3BtreeBeginStmt(Btree*);
95 int sqlite3BtreeCommitStmt(Btree*);
96 int sqlite3BtreeRollbackStmt(Btree*);
97 int sqlite3BtreeCreateTable(Btree*, int*, int flags);
98 int sqlite3BtreeIsInTrans(Btree*);
99 int sqlite3BtreeIsInStmt(Btree*);
100 int sqlite3BtreeIsInReadTrans(Btree*);
101 void *sqlite3BtreeSchema(Btree *, int, void(*)(void *));
102 int sqlite3BtreeSchemaLocked(Btree *);
103 int sqlite3BtreeLockTable(Btree *, int, u8);
105 const char *sqlite3BtreeGetFilename(Btree *);
106 const char *sqlite3BtreeGetDirname(Btree *);
107 const char *sqlite3BtreeGetJournalname(Btree *);
108 int sqlite3BtreeCopyFile(Btree *, Btree *);
110 int sqlite3BtreeIncrVacuum(Btree *);
112 /* The flags parameter to sqlite3BtreeCreateTable can be the bitwise OR
113 ** of the following flags:
115 #define BTREE_INTKEY 1 /* Table has only 64-bit signed integer keys */
116 #define BTREE_ZERODATA 2 /* Table has keys only - no data */
117 #define BTREE_LEAFDATA 4 /* Data stored in leaves only. Implies INTKEY */
119 int sqlite3BtreeDropTable(Btree*, int, int*);
120 int sqlite3BtreeClearTable(Btree*, int);
121 int sqlite3BtreeGetMeta(Btree*, int idx, u32 *pValue);
122 int sqlite3BtreeUpdateMeta(Btree*, int idx, u32 value);
123 void sqlite3BtreeTripAllCursors(Btree*, int);
125 int sqlite3BtreeCursor(
126 Btree*, /* BTree containing table to open */
127 int iTable, /* Index of root page */
128 int wrFlag, /* 1 for writing. 0 for read-only */
129 struct KeyInfo*, /* First argument to compare function */
130 BtCursor *pCursor /* Space to write cursor structure */
132 int sqlite3BtreeCursorSize(void);
134 int sqlite3BtreeCloseCursor(BtCursor*);
135 int sqlite3BtreeMoveto(
142 int sqlite3BtreeMovetoUnpacked(
144 UnpackedRecord *pUnKey,
149 int sqlite3BtreeCursorHasMoved(BtCursor*, int*);
150 int sqlite3BtreeDelete(BtCursor*);
151 int sqlite3BtreeInsert(BtCursor*, const void *pKey, i64 nKey,
152 const void *pData, int nData,
153 int nZero, int bias);
154 int sqlite3BtreeFirst(BtCursor*, int *pRes);
155 int sqlite3BtreeLast(BtCursor*, int *pRes);
156 int sqlite3BtreeNext(BtCursor*, int *pRes);
157 int sqlite3BtreeEof(BtCursor*);
158 int sqlite3BtreeFlags(BtCursor*);
159 int sqlite3BtreePrevious(BtCursor*, int *pRes);
160 int sqlite3BtreeKeySize(BtCursor*, i64 *pSize);
161 int sqlite3BtreeKey(BtCursor*, u32 offset, u32 amt, void*);
162 sqlite3 *sqlite3BtreeCursorDb(const BtCursor*);
163 const void *sqlite3BtreeKeyFetch(BtCursor*, int *pAmt);
164 const void *sqlite3BtreeDataFetch(BtCursor*, int *pAmt);
165 int sqlite3BtreeDataSize(BtCursor*, u32 *pSize);
166 int sqlite3BtreeData(BtCursor*, u32 offset, u32 amt, void*);
168 char *sqlite3BtreeIntegrityCheck(Btree*, int *aRoot, int nRoot, int, int*);
169 struct Pager *sqlite3BtreePager(Btree*);
171 int sqlite3BtreePutData(BtCursor*, u32 offset, u32 amt, void*);
172 void sqlite3BtreeCacheOverflow(BtCursor *);
175 int sqlite3BtreeCursorInfo(BtCursor*, int*, int);
176 void sqlite3BtreeCursorList(Btree*);
180 ** If we are not using shared cache, then there is no need to
181 ** use mutexes to access the BtShared structures. So make the
182 ** Enter and Leave procedures no-ops.
184 #if !defined(SQLITE_OMIT_SHARED_CACHE) && SQLITE_THREADSAFE
185 void sqlite3BtreeEnter(Btree*);
186 void sqlite3BtreeLeave(Btree*);
188 /* This routine is used inside assert() statements only. */
189 int sqlite3BtreeHoldsMutex(Btree*);
191 void sqlite3BtreeEnterCursor(BtCursor*);
192 void sqlite3BtreeLeaveCursor(BtCursor*);
193 void sqlite3BtreeEnterAll(sqlite3*);
194 void sqlite3BtreeLeaveAll(sqlite3*);
196 /* This routine is used inside assert() statements only. */
197 int sqlite3BtreeHoldsAllMutexes(sqlite3*);
199 void sqlite3BtreeMutexArrayEnter(BtreeMutexArray*);
200 void sqlite3BtreeMutexArrayLeave(BtreeMutexArray*);
201 void sqlite3BtreeMutexArrayInsert(BtreeMutexArray*, Btree*);
203 # define sqlite3BtreeEnter(X)
204 # define sqlite3BtreeLeave(X)
206 /* This routine is used inside assert() statements only. */
207 # define sqlite3BtreeHoldsMutex(X) 1
209 # define sqlite3BtreeEnterCursor(X)
210 # define sqlite3BtreeLeaveCursor(X)
211 # define sqlite3BtreeEnterAll(X)
212 # define sqlite3BtreeLeaveAll(X)
214 /* This routine is used inside assert() statements only. */
215 # define sqlite3BtreeHoldsAllMutexes(X) 1
217 # define sqlite3BtreeMutexArrayEnter(X)
218 # define sqlite3BtreeMutexArrayLeave(X)
219 # define sqlite3BtreeMutexArrayInsert(X,Y)
223 #endif /* _BTREE_H_ */