/ Hex Artifact Content
Login
SQLite training in Houston TX on 2019-11-05 (details)
Part of the 2019 Tcl Conference

Artifact 987d80658ae67f0e4d8b849539c113d4f9a7e835:


0000: 2f 2a 0a 2a 2a 20 43 6f 70 79 72 69 67 68 74 20  /*.** Copyright 
0010: 28 63 29 20 32 30 30 31 20 44 2e 20 52 69 63 68  (c) 2001 D. Rich
0020: 61 72 64 20 48 69 70 70 0a 2a 2a 0a 2a 2a 20 54  ard Hipp.**.** T
0030: 68 69 73 20 70 72 6f 67 72 61 6d 20 69 73 20 66  his program is f
0040: 72 65 65 20 73 6f 66 74 77 61 72 65 3b 20 79 6f  ree software; yo
0050: 75 20 63 61 6e 20 72 65 64 69 73 74 72 69 62 75  u can redistribu
0060: 74 65 20 69 74 20 61 6e 64 2f 6f 72 0a 2a 2a 20  te it and/or.** 
0070: 6d 6f 64 69 66 79 20 69 74 20 75 6e 64 65 72 20  modify it under 
0080: 74 68 65 20 74 65 72 6d 73 20 6f 66 20 74 68 65  the terms of the
0090: 20 47 4e 55 20 47 65 6e 65 72 61 6c 20 50 75 62   GNU General Pub
00a0: 6c 69 63 0a 2a 2a 20 4c 69 63 65 6e 73 65 20 61  lic.** License a
00b0: 73 20 70 75 62 6c 69 73 68 65 64 20 62 79 20 74  s published by t
00c0: 68 65 20 46 72 65 65 20 53 6f 66 74 77 61 72 65  he Free Software
00d0: 20 46 6f 75 6e 64 61 74 69 6f 6e 3b 20 65 69 74   Foundation; eit
00e0: 68 65 72 0a 2a 2a 20 76 65 72 73 69 6f 6e 20 32  her.** version 2
00f0: 20 6f 66 20 74 68 65 20 4c 69 63 65 6e 73 65 2c   of the License,
0100: 20 6f 72 20 28 61 74 20 79 6f 75 72 20 6f 70 74   or (at your opt
0110: 69 6f 6e 29 20 61 6e 79 20 6c 61 74 65 72 20 76  ion) any later v
0120: 65 72 73 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 54 68  ersion..**.** Th
0130: 69 73 20 70 72 6f 67 72 61 6d 20 69 73 20 64 69  is program is di
0140: 73 74 72 69 62 75 74 65 64 20 69 6e 20 74 68 65  stributed in the
0150: 20 68 6f 70 65 20 74 68 61 74 20 69 74 20 77 69   hope that it wi
0160: 6c 6c 20 62 65 20 75 73 65 66 75 6c 2c 0a 2a 2a  ll be useful,.**
0170: 20 62 75 74 20 57 49 54 48 4f 55 54 20 41 4e 59   but WITHOUT ANY
0180: 20 57 41 52 52 41 4e 54 59 3b 20 77 69 74 68 6f   WARRANTY; witho
0190: 75 74 20 65 76 65 6e 20 74 68 65 20 69 6d 70 6c  ut even the impl
01a0: 69 65 64 20 77 61 72 72 61 6e 74 79 20 6f 66 0a  ied warranty of.
01b0: 2a 2a 20 4d 45 52 43 48 41 4e 54 41 42 49 4c 49  ** MERCHANTABILI
01c0: 54 59 20 6f 72 20 46 49 54 4e 45 53 53 20 46 4f  TY or FITNESS FO
01d0: 52 20 41 20 50 41 52 54 49 43 55 4c 41 52 20 50  R A PARTICULAR P
01e0: 55 52 50 4f 53 45 2e 20 20 53 65 65 20 74 68 65  URPOSE.  See the
01f0: 20 47 4e 55 0a 2a 2a 20 47 65 6e 65 72 61 6c 20   GNU.** General 
0200: 50 75 62 6c 69 63 20 4c 69 63 65 6e 73 65 20 66  Public License f
0210: 6f 72 20 6d 6f 72 65 20 64 65 74 61 69 6c 73 2e  or more details.
0220: 0a 2a 2a 20 0a 2a 2a 20 59 6f 75 20 73 68 6f 75  .** .** You shou
0230: 6c 64 20 68 61 76 65 20 72 65 63 65 69 76 65 64  ld have received
0240: 20 61 20 63 6f 70 79 20 6f 66 20 74 68 65 20 47   a copy of the G
0250: 4e 55 20 47 65 6e 65 72 61 6c 20 50 75 62 6c 69  NU General Publi
0260: 63 0a 2a 2a 20 4c 69 63 65 6e 73 65 20 61 6c 6f  c.** License alo
0270: 6e 67 20 77 69 74 68 20 74 68 69 73 20 6c 69 62  ng with this lib
0280: 72 61 72 79 3b 20 69 66 20 6e 6f 74 2c 20 77 72  rary; if not, wr
0290: 69 74 65 20 74 6f 20 74 68 65 0a 2a 2a 20 46 72  ite to the.** Fr
02a0: 65 65 20 53 6f 66 74 77 61 72 65 20 46 6f 75 6e  ee Software Foun
02b0: 64 61 74 69 6f 6e 2c 20 49 6e 63 2e 2c 20 35 39  dation, Inc., 59
02c0: 20 54 65 6d 70 6c 65 20 50 6c 61 63 65 20 2d 20   Temple Place - 
02d0: 53 75 69 74 65 20 33 33 30 2c 0a 2a 2a 20 42 6f  Suite 330,.** Bo
02e0: 73 74 6f 6e 2c 20 4d 41 20 20 30 32 31 31 31 2d  ston, MA  02111-
02f0: 31 33 30 37 2c 20 55 53 41 2e 0a 2a 2a 0a 2a 2a  1307, USA..**.**
0300: 20 41 75 74 68 6f 72 20 63 6f 6e 74 61 63 74 20   Author contact 
0310: 69 6e 66 6f 72 6d 61 74 69 6f 6e 3a 0a 2a 2a 20  information:.** 
0320: 20 20 64 72 68 40 68 77 61 63 69 2e 63 6f 6d 0a    drh@hwaci.com.
0330: 2a 2a 20 20 20 68 74 74 70 3a 2f 2f 77 77 77 2e  **   http://www.
0340: 68 77 61 63 69 2e 63 6f 6d 2f 64 72 68 2f 0a 2a  hwaci.com/drh/.*
0350: 2a 0a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  *.**************
0360: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0370: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0380: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a  ****************
0390: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 0a 2a 2a 20 54  ***********.** T
03a0: 68 69 73 20 68 65 61 64 65 72 20 66 69 6c 65 20  his header file 
03b0: 64 65 66 69 6e 65 73 20 74 68 65 20 69 6e 74 65  defines the inte
03c0: 72 66 61 63 65 20 74 68 61 74 20 74 68 65 20 73  rface that the s
03d0: 71 6c 69 74 65 20 42 2d 54 72 65 65 20 66 69 6c  qlite B-Tree fil
03e0: 65 0a 2a 2a 20 73 75 62 73 79 73 74 65 6d 2e 0a  e.** subsystem..
03f0: 2a 2a 0a 2a 2a 20 40 28 23 29 20 24 49 64 3a 20  **.** @(#) $Id: 
0400: 62 74 72 65 65 2e 68 2c 76 20 31 2e 38 20 32 30  btree.h,v 1.8 20
0410: 30 31 2f 30 36 2f 33 30 20 32 31 3a 35 33 3a 35  01/06/30 21:53:5
0420: 33 20 64 72 68 20 45 78 70 20 24 0a 2a 2f 0a 0a  3 drh Exp $.*/..
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 69  sor BtCursor;..i
0470: 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 4f 70  nt sqliteBtreeOp
0480: 65 6e 28 63 6f 6e 73 74 20 63 68 61 72 20 2a 7a  en(const char *z
0490: 46 69 6c 65 6e 61 6d 65 2c 20 69 6e 74 20 6d 6f  Filename, int mo
04a0: 64 65 2c 20 42 74 72 65 65 20 2a 2a 70 70 42 74  de, Btree **ppBt
04b0: 72 65 65 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65  ree);.int sqlite
04c0: 42 74 72 65 65 43 6c 6f 73 65 28 42 74 72 65 65  BtreeClose(Btree
04d0: 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 42  *);..int sqliteB
04e0: 74 72 65 65 42 65 67 69 6e 54 72 61 6e 73 28 42  treeBeginTrans(B
04f0: 74 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69  tree*);.int sqli
0500: 74 65 42 74 72 65 65 43 6f 6d 6d 69 74 28 42 74  teBtreeCommit(Bt
0510: 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74  ree*);.int sqlit
0520: 65 42 74 72 65 65 52 6f 6c 6c 62 61 63 6b 28 42  eBtreeRollback(B
0530: 74 72 65 65 2a 29 3b 0a 0a 69 6e 74 20 73 71 6c  tree*);..int sql
0540: 69 74 65 42 74 72 65 65 43 72 65 61 74 65 54 61  iteBtreeCreateTa
0550: 62 6c 65 28 42 74 72 65 65 2a 2c 20 69 6e 74 2a  ble(Btree*, int*
0560: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 42 74 72  );.int sqliteBtr
0570: 65 65 44 72 6f 70 54 61 62 6c 65 28 42 74 72 65  eeDropTable(Btre
0580: 65 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71  e*, int);.int sq
0590: 6c 69 74 65 42 74 72 65 65 43 6c 65 61 72 54 61  liteBtreeClearTa
05a0: 62 6c 65 28 42 74 72 65 65 2a 2c 20 69 6e 74 29  ble(Btree*, int)
05b0: 3b 0a 0a 69 6e 74 20 73 71 6c 69 74 65 42 74 72  ;..int sqliteBtr
05c0: 65 65 43 75 72 73 6f 72 28 42 74 72 65 65 2a 2c  eeCursor(Btree*,
05d0: 20 69 6e 74 20 69 54 61 62 6c 65 2c 20 42 74 43   int iTable, BtC
05e0: 75 72 73 6f 72 20 2a 2a 70 70 43 75 72 29 3b 0a  ursor **ppCur);.
05f0: 69 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 4d  int sqliteBtreeM
0600: 6f 76 65 74 6f 28 42 74 43 75 72 73 6f 72 2a 2c  oveto(BtCursor*,
0610: 20 76 6f 69 64 20 2a 70 4b 65 79 2c 20 69 6e 74   void *pKey, int
0620: 20 6e 4b 65 79 2c 20 69 6e 74 20 2a 70 52 65 73   nKey, int *pRes
0630: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 42 74 72  );.int sqliteBtr
0640: 65 65 44 65 6c 65 74 65 28 42 74 43 75 72 73 6f  eeDelete(BtCurso
0650: 72 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 42  r*);.int sqliteB
0660: 74 72 65 65 49 6e 73 65 72 74 28 42 74 43 75 72  treeInsert(BtCur
0670: 73 6f 72 2a 2c 20 76 6f 69 64 20 2a 70 4b 65 79  sor*, void *pKey
0680: 2c 20 69 6e 74 20 6e 4b 65 79 2c 20 76 6f 69 64  , int nKey, void
0690: 20 2a 70 44 61 74 61 2c 20 69 6e 74 20 6e 44 61   *pData, int nDa
06a0: 74 61 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 42  ta);.int sqliteB
06b0: 74 72 65 65 4e 65 78 74 28 42 74 43 75 72 73 6f  treeNext(BtCurso
06c0: 72 2a 2c 20 69 6e 74 20 2a 70 52 65 73 29 3b 0a  r*, int *pRes);.
06d0: 69 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 4b  int sqliteBtreeK
06e0: 65 79 53 69 7a 65 28 42 74 43 75 72 73 6f 72 2a  eySize(BtCursor*
06f0: 2c 20 69 6e 74 20 2a 70 53 69 7a 65 29 3b 0a 69  , int *pSize);.i
0700: 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 4b 65  nt sqliteBtreeKe
0710: 79 28 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e 74  y(BtCursor*, int
0720: 20 6f 66 66 73 65 74 2c 20 69 6e 74 20 61 6d 74   offset, int amt
0730: 2c 20 63 68 61 72 20 2a 7a 42 75 66 29 3b 0a 69  , char *zBuf);.i
0740: 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 44 61  nt sqliteBtreeDa
0750: 74 61 53 69 7a 65 28 42 74 43 75 72 73 6f 72 2a  taSize(BtCursor*
0760: 2c 20 69 6e 74 20 2a 70 53 69 7a 65 29 3b 0a 69  , int *pSize);.i
0770: 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 44 61  nt sqliteBtreeDa
0780: 74 61 28 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e  ta(BtCursor*, in
0790: 74 20 6f 66 66 73 65 74 2c 20 69 6e 74 20 61 6d  t offset, int am
07a0: 74 2c 20 63 68 61 72 20 2a 7a 42 75 66 29 3b 0a  t, char *zBuf);.
07b0: 69 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 43  int sqliteBtreeC
07c0: 6c 6f 73 65 43 75 72 73 6f 72 28 42 74 43 75 72  loseCursor(BtCur
07d0: 73 6f 72 2a 29 3b 0a 0a 23 64 65 66 69 6e 65 20  sor*);..#define 
07e0: 53 51 4c 49 54 45 5f 4e 5f 42 54 52 45 45 5f 4d  SQLITE_N_BTREE_M
07f0: 45 54 41 20 34 0a 69 6e 74 20 73 71 6c 69 74 65  ETA 4.int sqlite
0800: 42 74 72 65 65 47 65 74 4d 65 74 61 28 42 74 72  BtreeGetMeta(Btr
0810: 65 65 2a 2c 20 69 6e 74 2a 29 3b 0a 69 6e 74 20  ee*, int*);.int 
0820: 73 71 6c 69 74 65 42 74 72 65 65 55 70 64 61 74  sqliteBtreeUpdat
0830: 65 4d 65 74 61 28 42 74 72 65 65 2a 2c 20 69 6e  eMeta(Btree*, in
0840: 74 2a 29 3b 0a 0a 0a 23 69 66 64 65 66 20 53 51  t*);...#ifdef SQ
0850: 4c 49 54 45 5f 54 45 53 54 0a 69 6e 74 20 73 71  LITE_TEST.int sq
0860: 6c 69 74 65 42 74 72 65 65 50 61 67 65 44 75 6d  liteBtreePageDum
0870: 70 28 42 74 72 65 65 2a 2c 20 69 6e 74 29 3b 0a  p(Btree*, int);.
0880: 69 6e 74 20 73 71 6c 69 74 65 42 74 72 65 65 43  int sqliteBtreeC
0890: 75 72 73 6f 72 44 75 6d 70 28 42 74 43 75 72 73  ursorDump(BtCurs
08a0: 6f 72 2a 2c 20 69 6e 74 2a 29 3b 0a 50 61 67 65  or*, int*);.Page
08b0: 72 20 2a 73 71 6c 69 74 65 42 74 72 65 65 50 61  r *sqliteBtreePa
08c0: 67 65 72 28 42 74 72 65 65 2a 29 3b 0a 63 68 61  ger(Btree*);.cha
08d0: 72 20 2a 73 71 6c 69 74 65 42 74 72 65 65 53 61  r *sqliteBtreeSa
08e0: 6e 69 74 79 43 68 65 63 6b 28 42 74 72 65 65 2a  nityCheck(Btree*
08f0: 2c 20 69 6e 74 2a 2c 20 69 6e 74 29 3b 0a 23 65  , int*, int);.#e
0900: 6e 64 69 66 0a                                   ndif.