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

Artifact 858659c6605ae07a2a0fb3d176b25573d30f27c5:


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 33 37 20 32 30  tree.h,v 1.37 20
0250: 30 34 2f 30 34 2f 32 36 20 31 34 3a 31 30 3a 32  04/04/26 14:10:2
0260: 31 20 64 72 68 20 45 78 70 20 24 0a 2a 2f 0a 23  1 drh Exp $.*/.#
0270: 69 66 6e 64 65 66 20 5f 42 54 52 45 45 5f 48 5f  ifndef _BTREE_H_
0280: 0a 23 64 65 66 69 6e 65 20 5f 42 54 52 45 45 5f  .#define _BTREE_
0290: 48 5f 0a 0a 2f 2a 0a 2a 2a 20 46 6f 72 77 61 72  H_../*.** Forwar
02a0: 64 20 64 65 63 6c 61 72 61 74 69 6f 6e 73 20 6f  d declarations o
02b0: 66 20 73 74 72 75 63 74 75 72 65 0a 2a 2f 0a 74  f structure.*/.t
02c0: 79 70 65 64 65 66 20 73 74 72 75 63 74 20 42 74  ypedef struct Bt
02d0: 72 65 65 20 42 74 72 65 65 3b 0a 74 79 70 65 64  ree Btree;.typed
02e0: 65 66 20 73 74 72 75 63 74 20 42 74 43 75 72 73  ef struct BtCurs
02f0: 6f 72 20 42 74 43 75 72 73 6f 72 3b 0a 0a 0a 69  or BtCursor;...i
0300: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 4f  nt sqlite3BtreeO
0310: 70 65 6e 28 63 6f 6e 73 74 20 63 68 61 72 20 2a  pen(const char *
0320: 7a 46 69 6c 65 6e 61 6d 65 2c 20 42 74 72 65 65  zFilename, Btree
0330: 20 2a 2a 2c 20 69 6e 74 20 6e 43 61 63 68 65 2c   **, int nCache,
0340: 20 69 6e 74 20 66 6c 61 67 73 29 3b 0a 0a 2f 2a   int flags);../*
0350: 20 54 68 65 20 66 6c 61 67 73 20 70 61 72 61 6d   The flags param
0360: 65 74 65 72 20 74 6f 20 73 71 6c 69 74 65 33 42  eter to sqlite3B
0370: 74 72 65 65 4f 70 65 6e 20 63 61 6e 20 62 65 20  treeOpen can be 
0380: 74 68 65 20 62 69 74 77 69 73 65 20 6f 72 20 6f  the bitwise or o
0390: 66 20 74 68 65 0a 2a 2a 20 66 6f 6c 6c 6f 77 69  f the.** followi
03a0: 6e 67 20 76 61 6c 75 65 73 2e 0a 2a 2f 0a 23 64  ng values..*/.#d
03b0: 65 66 69 6e 65 20 42 54 52 45 45 5f 4f 4d 49 54  efine BTREE_OMIT
03c0: 5f 4a 4f 55 52 4e 41 4c 20 20 31 20 20 2f 2a 20  _JOURNAL  1  /* 
03d0: 44 6f 20 6e 6f 74 20 75 73 65 20 6a 6f 75 72 6e  Do not use journ
03e0: 61 6c 2e 20 20 4e 6f 20 61 72 67 75 6d 65 6e 74  al.  No argument
03f0: 20 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52 45   */.#define BTRE
0400: 45 5f 4d 45 4d 4f 52 59 20 20 20 20 20 20 20 20  E_MEMORY        
0410: 32 20 20 2f 2a 20 49 6e 2d 6d 65 6d 6f 72 79 20  2  /* In-memory 
0420: 44 42 2e 20 20 4e 6f 20 61 72 67 75 6d 65 6e 74  DB.  No argument
0430: 20 2a 2f 0a 0a 69 6e 74 20 73 71 6c 69 74 65 33   */..int sqlite3
0440: 42 74 72 65 65 43 6c 6f 73 65 28 42 74 72 65 65  BtreeClose(Btree
0450: 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  *);.int sqlite3B
0460: 74 72 65 65 53 65 74 43 61 63 68 65 53 69 7a 65  treeSetCacheSize
0470: 28 42 74 72 65 65 2a 2c 69 6e 74 29 3b 0a 69 6e  (Btree*,int);.in
0480: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 53 65  t sqlite3BtreeSe
0490: 74 53 61 66 65 74 79 4c 65 76 65 6c 28 42 74 72  tSafetyLevel(Btr
04a0: 65 65 2a 2c 69 6e 74 29 3b 0a 69 6e 74 20 73 71  ee*,int);.int sq
04b0: 6c 69 74 65 33 42 74 72 65 65 42 65 67 69 6e 54  lite3BtreeBeginT
04c0: 72 61 6e 73 28 42 74 72 65 65 2a 29 3b 0a 69 6e  rans(Btree*);.in
04d0: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 43 6f  t sqlite3BtreeCo
04e0: 6d 6d 69 74 28 42 74 72 65 65 2a 29 3b 0a 69 6e  mmit(Btree*);.in
04f0: 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 52 6f  t sqlite3BtreeRo
0500: 6c 6c 62 61 63 6b 28 42 74 72 65 65 2a 29 3b 0a  llback(Btree*);.
0510: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
0520: 42 65 67 69 6e 53 74 6d 74 28 42 74 72 65 65 2a  BeginStmt(Btree*
0530: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
0540: 72 65 65 43 6f 6d 6d 69 74 53 74 6d 74 28 42 74  reeCommitStmt(Bt
0550: 72 65 65 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74  ree*);.int sqlit
0560: 65 33 42 74 72 65 65 52 6f 6c 6c 62 61 63 6b 53  e3BtreeRollbackS
0570: 74 6d 74 28 42 74 72 65 65 2a 29 3b 0a 69 6e 74  tmt(Btree*);.int
0580: 20 73 71 6c 69 74 65 33 42 74 72 65 65 43 72 65   sqlite3BtreeCre
0590: 61 74 65 54 61 62 6c 65 28 42 74 72 65 65 2a 2c  ateTable(Btree*,
05a0: 20 69 6e 74 2a 2c 20 69 6e 74 20 66 6c 61 67 73   int*, int flags
05b0: 29 3b 0a 0a 2f 2a 20 54 68 65 20 66 6c 61 67 73  );../* The flags
05c0: 20 70 61 72 61 6d 65 74 65 72 20 74 6f 20 73 71   parameter to sq
05d0: 6c 69 74 65 33 42 74 72 65 65 43 72 65 61 74 65  lite3BtreeCreate
05e0: 54 61 62 6c 65 20 63 61 6e 20 62 65 20 74 68 65  Table can be the
05f0: 20 62 69 74 77 69 73 65 20 4f 52 0a 2a 2a 20 6f   bitwise OR.** o
0600: 66 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20  f the following 
0610: 66 6c 61 67 73 3a 0a 2a 2f 0a 23 64 65 66 69 6e  flags:.*/.#defin
0620: 65 20 42 54 52 45 45 5f 49 4e 54 4b 45 59 20 20  e BTREE_INTKEY  
0630: 20 20 20 31 20 20 20 20 20 20 2f 2a 20 54 61 62     1      /* Tab
0640: 6c 65 20 68 61 73 20 6f 6e 6c 79 20 36 34 2d 62  le has only 64-b
0650: 69 74 20 69 6e 74 65 67 65 72 20 6b 65 79 73 20  it integer keys 
0660: 2a 2f 0a 23 64 65 66 69 6e 65 20 42 54 52 45 45  */.#define BTREE
0670: 5f 5a 45 52 4f 44 41 54 41 20 20 20 32 20 20 20  _ZERODATA   2   
0680: 20 20 20 2f 2a 20 54 61 62 6c 65 20 68 61 73 20     /* Table has 
0690: 6b 65 79 73 20 6f 6e 6c 79 20 2d 20 6e 6f 20 64  keys only - no d
06a0: 61 74 61 20 2a 2f 0a 0a 69 6e 74 20 73 71 6c 69  ata */..int sqli
06b0: 74 65 33 42 74 72 65 65 44 72 6f 70 54 61 62 6c  te3BtreeDropTabl
06c0: 65 28 42 74 72 65 65 2a 2c 20 69 6e 74 29 3b 0a  e(Btree*, int);.
06d0: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
06e0: 43 6c 65 61 72 54 61 62 6c 65 28 42 74 72 65 65  ClearTable(Btree
06f0: 2a 2c 20 69 6e 74 29 3b 0a 69 6e 74 20 73 71 6c  *, int);.int sql
0700: 69 74 65 33 42 74 72 65 65 47 65 74 4d 65 74 61  ite3BtreeGetMeta
0710: 28 42 74 72 65 65 2a 2c 20 69 6e 74 20 69 64 78  (Btree*, int idx
0720: 2c 20 75 33 32 20 2a 70 56 61 6c 75 65 29 3b 0a  , u32 *pValue);.
0730: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
0740: 55 70 64 61 74 65 4d 65 74 61 28 42 74 72 65 65  UpdateMeta(Btree
0750: 2a 2c 20 69 6e 74 20 69 64 78 2c 20 75 33 32 20  *, int idx, u32 
0760: 76 61 6c 75 65 29 3b 0a 0a 69 6e 74 20 73 71 6c  value);..int sql
0770: 69 74 65 33 42 74 72 65 65 43 75 72 73 6f 72 28  ite3BtreeCursor(
0780: 0a 20 20 42 74 72 65 65 2a 2c 20 20 20 20 20 20  .  Btree*,      
0790: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
07a0: 20 20 20 20 20 20 20 20 2f 2a 20 42 54 72 65 65          /* BTree
07b0: 20 63 6f 6e 74 61 69 6e 69 6e 67 20 74 61 62 6c   containing tabl
07c0: 65 20 74 6f 20 6f 70 65 6e 20 2a 2f 0a 20 20 69  e to open */.  i
07d0: 6e 74 20 69 54 61 62 6c 65 2c 20 20 20 20 20 20  nt iTable,      
07e0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
07f0: 20 20 20 20 2f 2a 20 49 6e 64 65 78 20 6f 66 20      /* Index of 
0800: 72 6f 6f 74 20 70 61 67 65 20 2a 2f 0a 20 20 69  root page */.  i
0810: 6e 74 20 77 72 46 6c 61 67 2c 20 20 20 20 20 20  nt wrFlag,      
0820: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0830: 20 20 20 20 2f 2a 20 31 20 66 6f 72 20 77 72 69      /* 1 for wri
0840: 74 69 6e 67 2e 20 20 30 20 66 6f 72 20 72 65 61  ting.  0 for rea
0850: 64 2d 6f 6e 6c 79 20 2a 2f 0a 20 20 69 6e 74 28  d-only */.  int(
0860: 2a 29 28 76 6f 69 64 2a 2c 69 6e 74 2c 63 6f 6e  *)(void*,int,con
0870: 73 74 20 76 6f 69 64 2a 2c 69 6e 74 2c 63 6f 6e  st void*,int,con
0880: 73 74 20 76 6f 69 64 2a 29 2c 20 20 2f 2a 20 4b  st void*),  /* K
0890: 65 79 20 63 6f 6d 70 61 72 69 73 6f 6e 20 66 75  ey comparison fu
08a0: 6e 63 74 69 6f 6e 20 2a 2f 0a 20 20 76 6f 69 64  nction */.  void
08b0: 2a 2c 20 20 20 20 20 20 20 20 20 20 20 20 20 20  *,              
08c0: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
08d0: 20 2f 2a 20 46 69 72 73 74 20 61 72 67 75 6d 65   /* First argume
08e0: 6e 74 20 74 6f 20 63 6f 6d 70 61 72 65 20 66 75  nt to compare fu
08f0: 6e 63 74 69 6f 6e 20 2a 2f 0a 20 20 42 74 43 75  nction */.  BtCu
0900: 72 73 6f 72 20 2a 2a 70 70 43 75 72 73 6f 72 20  rsor **ppCursor 
0910: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0920: 20 2f 2a 20 52 65 74 75 72 6e 65 64 20 63 75 72   /* Returned cur
0930: 73 6f 72 20 2a 2f 0a 29 3b 0a 0a 69 6e 74 20 73  sor */.);..int s
0940: 71 6c 69 74 65 33 42 74 72 65 65 43 75 72 73 6f  qlite3BtreeCurso
0950: 72 43 6c 6f 73 65 28 42 74 43 75 72 73 6f 72 2a  rClose(BtCursor*
0960: 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42 74  );.int sqlite3Bt
0970: 72 65 65 4d 6f 76 65 74 6f 28 42 74 43 75 72 73  reeMoveto(BtCurs
0980: 6f 72 2a 2c 20 63 6f 6e 73 74 20 76 6f 69 64 20  or*, const void 
0990: 2a 70 4b 65 79 2c 20 75 36 34 20 6e 4b 65 79 2c  *pKey, u64 nKey,
09a0: 20 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69 6e 74   int *pRes);.int
09b0: 20 73 71 6c 69 74 65 33 42 74 72 65 65 44 65 6c   sqlite3BtreeDel
09c0: 65 74 65 28 42 74 43 75 72 73 6f 72 2a 29 3b 0a  ete(BtCursor*);.
09d0: 69 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65  int sqlite3Btree
09e0: 49 6e 73 65 72 74 28 42 74 43 75 72 73 6f 72 2a  Insert(BtCursor*
09f0: 2c 20 63 6f 6e 73 74 20 76 6f 69 64 20 2a 70 4b  , const void *pK
0a00: 65 79 2c 20 75 36 34 20 6e 4b 65 79 2c 0a 20 20  ey, u64 nKey,.  
0a10: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0a20: 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20                  
0a30: 63 6f 6e 73 74 20 76 6f 69 64 20 2a 70 44 61 74  const void *pDat
0a40: 61 2c 20 69 6e 74 20 6e 44 61 74 61 29 3b 0a 69  a, int nData);.i
0a50: 6e 74 20 73 71 6c 69 74 65 33 42 74 72 65 65 46  nt sqlite3BtreeF
0a60: 69 72 73 74 28 42 74 43 75 72 73 6f 72 2a 2c 20  irst(BtCursor*, 
0a70: 69 6e 74 20 2a 70 52 65 73 29 3b 0a 69 6e 74 20  int *pRes);.int 
0a80: 73 71 6c 69 74 65 33 42 74 72 65 65 4c 61 73 74  sqlite3BtreeLast
0a90: 28 42 74 43 75 72 73 6f 72 2a 2c 20 69 6e 74 20  (BtCursor*, int 
0aa0: 2a 70 52 65 73 29 3b 0a 69 6e 74 20 73 71 6c 69  *pRes);.int sqli
0ab0: 74 65 33 42 74 72 65 65 4e 65 78 74 28 42 74 43  te3BtreeNext(BtC
0ac0: 75 72 73 6f 72 2a 2c 20 69 6e 74 20 2a 70 52 65  ursor*, int *pRe
0ad0: 73 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  s);.int sqlite3B
0ae0: 74 72 65 65 50 72 65 76 69 6f 75 73 28 42 74 43  treePrevious(BtC
0af0: 75 72 73 6f 72 2a 2c 20 69 6e 74 20 2a 70 52 65  ursor*, int *pRe
0b00: 73 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  s);.int sqlite3B
0b10: 74 72 65 65 4b 65 79 53 69 7a 65 28 42 74 43 75  treeKeySize(BtCu
0b20: 72 73 6f 72 2a 2c 20 75 36 34 20 2a 70 53 69 7a  rsor*, u64 *pSiz
0b30: 65 29 3b 0a 69 6e 74 20 73 71 6c 69 74 65 33 42  e);.int sqlite3B
0b40: 74 72 65 65 4b 65 79 28 42 74 43 75 72 73 6f 72  treeKey(BtCursor
0b50: 2a 2c 20 75 33 32 20 6f 66 66 73 65 74 2c 20 75  *, u32 offset, u
0b60: 33 32 20 61 6d 74 2c 20 76 6f 69 64 2a 29 3b 0a  32 amt, void*);.
0b70: 76 6f 69 64 20 2a 73 71 6c 69 74 65 33 42 74 72  void *sqlite3Btr
0b80: 65 65 4b 65 79 46 65 74 63 68 28 42 74 43 75 72  eeKeyFetch(BtCur
0b90: 73 6f 72 2a 29 3b 0a 69 6e 74 20 73 71 6c 69 74  sor*);.int sqlit
0ba0: 65 33 42 74 72 65 65 44 61 74 61 53 69 7a 65 28  e3BtreeDataSize(
0bb0: 42 74 43 75 72 73 6f 72 2a 2c 20 75 33 32 20 2a  BtCursor*, u32 *
0bc0: 70 53 69 7a 65 29 3b 0a 69 6e 74 20 73 71 6c 69  pSize);.int sqli
0bd0: 74 65 33 42 74 72 65 65 44 61 74 61 28 42 74 43  te3BtreeData(BtC
0be0: 75 72 73 6f 72 2a 2c 20 75 33 32 20 6f 66 66 73  ursor*, u32 offs
0bf0: 65 74 2c 20 75 33 32 20 61 6d 74 2c 20 76 6f 69  et, u32 amt, voi
0c00: 64 2a 29 3b 0a 0a 0a 23 65 6e 64 69 66 20 2f 2a  d*);...#endif /*
0c10: 20 5f 42 54 52 45 45 5f 48 5f 20 2a 2f 0a         _BTREE_H_ */.