Documentation Source Text

Hex Artifact Content
Login

Artifact 41fd6a4b025163c552fbd1a77880827fc23193a57834a51e02f227bd3abd2f3f:


0000: 3c 74 69 74 6c 65 3e 54 68 65 20 44 42 53 54 41  <title>The DBSTA
0010: 54 20 56 69 72 74 75 61 6c 20 54 61 62 6c 65 3c  T Virtual Table<
0020: 2f 74 69 74 6c 65 3e 0a 3c 74 63 6c 3e 68 64 5f  /title>.<tcl>hd_
0030: 6b 65 79 77 6f 72 64 73 20 64 62 73 74 61 74 20  keywords dbstat 
0040: 7b 64 62 73 74 61 74 20 76 69 72 74 75 61 6c 20  {dbstat virtual 
0050: 74 61 62 6c 65 7d 3c 2f 74 63 6c 3e 0a 3c 66 61  table}</tcl>.<fa
0060: 6e 63 79 5f 66 6f 72 6d 61 74 3e 0a 0a 0a 3c 68  ncy_format>...<h
0070: 31 3e 4f 76 65 72 76 69 65 77 3c 2f 68 31 3e 0a  1>Overview</h1>.
0080: 0a 3c 70 3e 0a 54 68 65 20 44 42 53 54 41 54 20  .<p>.The DBSTAT 
0090: 76 69 72 74 75 61 6c 20 74 61 62 6c 65 20 69 73  virtual table is
00a0: 20 61 20 72 65 61 64 2d 6f 6e 6c 79 20 5b 65 70   a read-only [ep
00b0: 6f 6e 79 6d 6f 75 73 20 76 69 72 74 75 61 6c 20  onymous virtual 
00c0: 74 61 62 6c 65 5d 20 74 68 61 74 20 72 65 74 75  table] that retu
00d0: 72 6e 73 0a 69 6e 66 6f 72 6d 61 74 69 6f 6e 20  rns.information 
00e0: 61 62 6f 75 74 20 77 68 69 63 68 20 70 61 67 65  about which page
00f0: 73 20 6f 66 20 74 68 65 20 64 61 74 61 62 61 73  s of the databas
0100: 65 20 66 69 6c 65 73 20 61 72 65 20 75 73 65 64  e files are used
0110: 20 62 79 20 77 68 69 63 68 0a 74 61 62 6c 65 73   by which.tables
0120: 20 61 6e 64 20 69 6e 64 65 78 65 73 20 69 6e 20   and indexes in 
0130: 74 68 65 20 73 63 68 65 6d 61 2e 0a 54 68 65 20  the schema..The 
0140: 44 42 53 54 41 54 20 76 69 72 74 75 61 6c 20 74  DBSTAT virtual t
0150: 61 62 6c 65 20 69 73 20 75 73 65 64 20 74 6f 20  able is used to 
0160: 69 6d 70 6c 65 6d 65 6e 74 20 5b 73 71 6c 69 74  implement [sqlit
0170: 65 33 5f 61 6e 61 6c 79 7a 65 72 2e 65 78 65 5d  e3_analyzer.exe]
0180: 0a 75 74 69 6c 69 74 79 20 70 72 6f 67 72 61 6d  .utility program
0190: 2c 20 61 6e 64 20 74 6f 20 68 65 6c 70 20 63 6f  , and to help co
01a0: 6d 70 75 74 65 20 74 68 65 20 0a 5b 68 74 74 70  mpute the .[http
01b0: 73 3a 2f 2f 77 77 77 2e 73 71 6c 69 74 65 2e 6f  s://www.sqlite.o
01c0: 72 67 2f 73 72 63 2f 72 65 70 6f 2d 74 61 62 73  rg/src/repo-tabs
01d0: 69 7a 65 7c 74 61 62 6c 65 20 73 69 7a 65 20 70  ize|table size p
01e0: 69 65 2d 63 68 61 72 74 5d 20 69 6e 0a 74 68 65  ie-chart] in.the
01f0: 20 5b 68 74 74 70 73 3a 2f 2f 77 77 77 2e 66 6f   [https://www.fo
0200: 73 73 69 6c 2d 73 63 6d 2e 6f 72 67 2f 7c 46 6f  ssil-scm.org/|Fo
0210: 73 73 69 6c 2d 69 6d 70 6c 65 6d 65 6e 74 65 64  ssil-implemented
0220: 5d 20 76 65 72 73 69 6f 6e 20 63 6f 6e 74 72 6f  ] version contro
0230: 6c 20 73 79 73 74 65 6d 0a 66 6f 72 20 53 51 4c  l system.for SQL
0240: 69 74 65 2e 0a 3c 2f 70 3e 0a 0a 3c 70 3e 0a 5e  ite..</p>..<p>.^
0250: 54 68 65 20 3c 62 3e 64 62 73 74 61 74 3c 2f 62  The <b>dbstat</b
0260: 3e 20 76 69 72 74 75 61 6c 20 74 61 62 6c 65 20  > virtual table 
0270: 69 73 20 61 76 61 69 6c 61 62 6c 65 20 6f 6e 20  is available on 
0280: 61 6c 6c 20 0a 5b 64 61 74 61 62 61 73 65 20 63  all .[database c
0290: 6f 6e 6e 65 63 74 69 6f 6e 73 5d 20 77 68 65 6e  onnections] when
02a0: 20 53 51 4c 69 74 65 20 69 73 20 62 75 69 6c 74   SQLite is built
02b0: 20 75 73 69 6e 67 20 74 68 65 0a 5b 53 51 4c 49   using the.[SQLI
02c0: 54 45 5f 45 4e 41 42 4c 45 5f 44 42 53 54 41 54  TE_ENABLE_DBSTAT
02d0: 5f 56 54 41 42 5d 20 63 6f 6d 70 69 6c 65 2d 74  _VTAB] compile-t
02e0: 69 6d 65 20 6f 70 74 69 6f 6e 2e 0a 5e 54 68 65  ime option..^The
02f0: 20 64 62 73 74 61 74 20 76 69 72 74 75 61 6c 20   dbstat virtual 
0300: 74 61 62 6c 65 20 70 72 6f 76 69 64 65 73 20 6c  table provides l
0310: 6f 77 2d 6c 65 76 65 6c 20 69 6e 66 6f 72 6d 61  ow-level informa
0320: 74 69 6f 6e 20 0a 61 62 6f 75 74 20 62 74 72 65  tion .about btre
0330: 65 20 61 6e 64 20 6f 76 65 72 66 6c 6f 77 20 70  e and overflow p
0340: 61 67 65 73 20 69 6e 20 61 20 64 61 74 61 62 61  ages in a databa
0350: 73 65 20 66 69 6c 65 2e 0a 0a 3c 70 3e 0a 5e 54  se file...<p>.^T
0360: 68 65 20 64 62 73 74 61 74 20 76 69 72 74 75 61  he dbstat virtua
0370: 6c 20 74 61 62 6c 65 20 69 73 20 61 6e 20 5b 65  l table is an [e
0380: 70 6f 6e 79 6d 6f 75 73 20 76 69 72 74 75 61 6c  ponymous virtual
0390: 20 74 61 62 6c 65 5d 2c 20 6d 65 61 6e 69 6e 67   table], meaning
03a0: 0a 74 68 61 74 20 69 73 20 6e 6f 74 20 6e 65 63  .that is not nec
03b0: 65 73 73 61 72 79 20 74 6f 20 72 75 6e 20 5b 43  essary to run [C
03c0: 52 45 41 54 45 20 56 49 52 54 55 41 4c 20 54 41  REATE VIRTUAL TA
03d0: 42 4c 45 5d 20 74 6f 20 63 72 65 61 74 65 20 61  BLE] to create a
03e0: 6e 0a 69 6e 73 74 61 6e 63 65 20 6f 66 20 74 68  n.instance of th
03f0: 65 20 64 62 73 74 61 74 20 76 69 72 74 75 61 6c  e dbstat virtual
0400: 20 74 61 62 6c 65 20 62 65 66 6f 72 65 20 75 73   table before us
0410: 69 6e 67 20 69 74 2e 20 20 54 68 65 20 22 64 62  ing it.  The "db
0420: 73 74 61 74 22 0a 6d 6f 64 75 6c 65 20 6e 61 6d  stat".module nam
0430: 65 20 63 61 6e 20 62 65 20 75 73 65 64 20 61 73  e can be used as
0440: 20 69 66 20 69 74 20 77 65 72 65 20 61 20 74 61   if it were a ta
0450: 62 6c 65 20 6e 61 6d 65 20 74 6f 20 71 75 65 72  ble name to quer
0460: 79 20 74 68 65 0a 64 62 73 74 61 74 20 76 69 72  y the.dbstat vir
0470: 74 75 61 6c 20 74 61 62 6c 65 20 64 69 72 65 63  tual table direc
0480: 74 6c 79 2e 20 20 46 6f 72 20 65 78 61 6d 70 6c  tly.  For exampl
0490: 65 3a 0a 0a 3c 63 6f 64 65 62 6c 6f 63 6b 3e 0a  e:..<codeblock>.
04a0: 53 45 4c 45 43 54 20 2a 20 46 52 4f 4d 20 64 62  SELECT * FROM db
04b0: 73 74 61 74 3b 0a 3c 2f 63 6f 64 65 62 6c 6f 63  stat;.</codebloc
04c0: 6b 3e 0a 0a 3c 70 3e 0a 49 66 20 61 20 6e 61 6d  k>..<p>.If a nam
04d0: 65 64 20 76 69 72 74 75 61 6c 20 74 61 62 6c 65  ed virtual table
04e0: 20 74 68 61 74 20 75 73 65 73 20 74 68 65 20 64   that uses the d
04f0: 62 73 74 61 74 20 6d 6f 64 75 6c 65 20 69 73 20  bstat module is 
0500: 64 65 73 69 72 65 64 2c 0a 74 68 65 6e 20 74 68  desired,.then th
0510: 65 20 72 65 63 6f 6d 6d 65 6e 64 65 64 20 77 61  e recommended wa
0520: 79 20 74 6f 20 63 72 65 61 74 65 20 61 6e 20 69  y to create an i
0530: 6e 73 74 61 6e 63 65 20 6f 66 20 74 68 65 20 64  nstance of the d
0540: 62 73 74 61 74 0a 76 69 72 74 75 61 6c 20 74 61  bstat.virtual ta
0550: 62 6c 65 20 69 73 20 61 73 20 66 6f 6c 6c 6f 77  ble is as follow
0560: 73 3a 0a 0a 3c 63 6f 64 65 62 6c 6f 63 6b 3e 0a  s:..<codeblock>.
0570: 43 52 45 41 54 45 20 56 49 52 54 55 41 4c 20 54  CREATE VIRTUAL T
0580: 41 42 4c 45 20 74 65 6d 70 2e 73 74 61 74 20 55  ABLE temp.stat U
0590: 53 49 4e 47 20 64 62 73 74 61 74 28 6d 61 69 6e  SING dbstat(main
05a0: 29 3b 0a 3c 2f 63 6f 64 65 62 6c 6f 63 6b 3e 0a  );.</codeblock>.
05b0: 0a 3c 70 3e 0a 4e 6f 74 65 20 74 68 65 20 22 74  .<p>.Note the "t
05c0: 65 6d 70 2e 22 20 71 75 61 6c 69 66 69 65 72 20  emp." qualifier 
05d0: 62 65 66 6f 72 65 20 74 68 65 20 76 69 72 74 75  before the virtu
05e0: 61 6c 20 74 61 62 6c 65 20 6e 61 6d 65 20 28 22  al table name ("
05f0: 73 74 61 74 22 29 2e 20 20 54 68 69 73 0a 71 75  stat").  This.qu
0600: 61 6c 69 66 69 65 72 20 63 61 75 73 65 73 20 74  alifier causes t
0610: 68 65 20 76 69 72 74 75 61 6c 20 74 61 62 6c 65  he virtual table
0620: 20 74 6f 20 62 65 20 74 65 6d 70 6f 72 61 72 79   to be temporary
0630: 20 2d 20 74 6f 20 6f 6e 6c 79 20 65 78 69 73 74   - to only exist
0640: 20 66 6f 72 0a 74 68 65 20 64 75 72 61 74 69 6f   for.the duratio
0650: 6e 20 6f 66 20 74 68 65 20 63 75 72 72 65 6e 74  n of the current
0660: 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63   database connec
0670: 74 69 6f 6e 2e 20 20 54 68 69 73 20 69 73 20 74  tion.  This is t
0680: 68 65 0a 72 65 63 6f 6d 6d 65 6e 64 65 64 20 61  he.recommended a
0690: 70 70 72 6f 61 63 68 2e 0a 0a 3c 70 3e 0a 54 68  pproach...<p>.Th
06a0: 65 20 22 6d 61 69 6e 22 20 61 72 67 75 6d 65 6e  e "main" argumen
06b0: 74 20 74 6f 20 64 62 73 74 61 74 20 69 73 20 64  t to dbstat is d
06c0: 65 66 61 75 6c 74 20 73 63 68 65 6d 61 0a 66 6f  efault schema.fo
06d0: 72 20 77 68 69 63 68 20 69 6e 66 6f 72 6d 61 74  r which informat
06e0: 69 6f 6e 20 69 73 20 74 6f 20 62 65 20 70 72 6f  ion is to be pro
06f0: 76 69 64 65 64 2e 20 20 54 68 65 20 64 65 66 61  vided.  The defa
0700: 75 6c 74 20 69 73 20 22 6d 61 69 6e 22 2c 20 61  ult is "main", a
0710: 6e 64 0a 73 6f 20 74 68 65 20 75 73 65 20 6f 66  nd.so the use of
0720: 20 22 6d 61 69 6e 22 20 69 6e 20 74 68 65 20 65   "main" in the e
0730: 78 61 6d 70 6c 65 20 61 62 6f 76 65 20 69 73 20  xample above is 
0740: 72 65 64 75 6e 64 61 6e 74 2e 20 20 46 6f 72 20  redundant.  For 
0750: 61 6e 79 0a 70 61 72 74 69 63 75 6c 61 72 20 71  any.particular q
0760: 75 65 72 79 2c 20 74 68 65 20 73 63 68 65 6d 61  uery, the schema
0770: 20 63 61 6e 20 62 65 20 63 68 61 6e 67 65 64 20   can be changed 
0780: 62 79 20 73 70 65 63 69 66 79 69 6e 67 20 74 68  by specifying th
0790: 65 0a 61 6c 74 65 72 6e 61 74 69 76 65 20 73 63  e.alternative sc
07a0: 68 65 6d 61 20 61 73 20 61 20 66 75 6e 63 74 69  hema as a functi
07b0: 6f 6e 20 61 72 67 75 6d 65 6e 74 20 74 6f 20 74  on argument to t
07c0: 68 65 20 76 69 72 74 75 61 6c 20 74 61 62 6c 65  he virtual table
07d0: 0a 6e 61 6d 65 20 69 6e 20 74 68 65 20 46 52 4f  .name in the FRO
07e0: 4d 20 63 6c 61 75 73 65 20 6f 66 20 74 68 65 20  M clause of the 
07f0: 71 75 65 72 79 2e 20 20 28 53 65 65 20 66 75 72  query.  (See fur
0800: 74 68 65 72 20 64 69 73 63 75 73 73 69 6f 6e 20  ther discussion 
0810: 6f 66 0a 5b 74 61 62 6c 65 2d 76 61 6c 75 65 64  of.[table-valued
0820: 20 66 75 6e 63 74 69 6f 6e 73 20 69 6e 20 74 68   functions in th
0830: 65 20 46 52 4f 4d 20 63 6c 61 75 73 65 5d 20 66  e FROM clause] f
0840: 6f 72 20 6d 6f 72 65 20 64 65 74 61 69 6c 73 2e  or more details.
0850: 29 0a 0a 3c 70 3e 0a 54 68 65 20 73 63 68 65 6d  )..<p>.The schem
0860: 61 20 66 6f 72 20 74 68 65 20 64 62 73 74 61 74  a for the dbstat
0870: 20 76 69 72 74 75 61 6c 20 74 61 62 6c 65 20 69   virtual table i
0880: 73 20 74 68 69 73 3a 0a 3c 63 6f 64 65 62 6c 6f  s this:.<codeblo
0890: 63 6b 3e 0a 43 52 45 41 54 45 20 54 41 42 4c 45  ck>.CREATE TABLE
08a0: 20 64 62 73 74 61 74 28 0a 20 20 6e 61 6d 65 20   dbstat(.  name 
08b0: 20 20 20 20 20 20 54 45 58 54 2c 20 20 20 20 20        TEXT,     
08c0: 20 20 20 2d 2d 20 4e 61 6d 65 20 6f 66 20 74 61     -- Name of ta
08d0: 62 6c 65 20 6f 72 20 69 6e 64 65 78 0a 20 20 70  ble or index.  p
08e0: 61 74 68 20 20 20 20 20 20 20 54 45 58 54 2c 20  ath       TEXT, 
08f0: 20 20 20 20 20 20 20 2d 2d 20 50 61 74 68 20 74         -- Path t
0900: 6f 20 70 61 67 65 20 66 72 6f 6d 20 72 6f 6f 74  o page from root
0910: 0a 20 20 70 61 67 65 6e 6f 20 20 20 20 20 49 4e  .  pageno     IN
0920: 54 45 47 45 52 2c 20 20 20 20 20 2d 2d 20 50 61  TEGER,     -- Pa
0930: 67 65 20 6e 75 6d 62 65 72 0a 20 20 70 61 67 65  ge number.  page
0940: 74 79 70 65 20 20 20 54 45 58 54 2c 20 20 20 20  type   TEXT,    
0950: 20 20 20 20 2d 2d 20 27 69 6e 74 65 72 6e 61 6c      -- 'internal
0960: 27 2c 20 27 6c 65 61 66 27 20 6f 72 20 27 6f 76  ', 'leaf' or 'ov
0970: 65 72 66 6c 6f 77 27 0a 20 20 6e 63 65 6c 6c 20  erflow'.  ncell 
0980: 20 20 20 20 20 49 4e 54 45 47 45 52 2c 20 20 20       INTEGER,   
0990: 20 20 2d 2d 20 43 65 6c 6c 73 20 6f 6e 20 70 61    -- Cells on pa
09a0: 67 65 20 28 30 20 66 6f 72 20 6f 76 65 72 66 6c  ge (0 for overfl
09b0: 6f 77 29 0a 20 20 70 61 79 6c 6f 61 64 20 20 20  ow).  payload   
09c0: 20 49 4e 54 45 47 45 52 2c 20 20 20 20 20 2d 2d   INTEGER,     --
09d0: 20 42 79 74 65 73 20 6f 66 20 70 61 79 6c 6f 61   Bytes of payloa
09e0: 64 20 6f 6e 20 74 68 69 73 20 70 61 67 65 0a 20  d on this page. 
09f0: 20 75 6e 75 73 65 64 20 20 20 20 20 49 4e 54 45   unused     INTE
0a00: 47 45 52 2c 20 20 20 20 20 2d 2d 20 42 79 74 65  GER,     -- Byte
0a10: 73 20 6f 66 20 75 6e 75 73 65 64 20 73 70 61 63  s of unused spac
0a20: 65 20 6f 6e 20 74 68 69 73 20 70 61 67 65 0a 20  e on this page. 
0a30: 20 6d 78 5f 70 61 79 6c 6f 61 64 20 49 4e 54 45   mx_payload INTE
0a40: 47 45 52 2c 20 20 20 20 20 2d 2d 20 4c 61 72 67  GER,     -- Larg
0a50: 65 73 74 20 70 61 79 6c 6f 61 64 20 73 69 7a 65  est payload size
0a60: 20 6f 66 20 61 6c 6c 20 63 65 6c 6c 73 20 6f 6e   of all cells on
0a70: 20 74 68 69 73 20 70 61 67 65 0a 20 20 70 67 6f   this page.  pgo
0a80: 66 66 73 65 74 20 20 20 49 4e 54 45 47 45 52 2c  ffset   INTEGER,
0a90: 20 20 20 20 20 2d 2d 20 4f 66 66 73 65 74 20 6f       -- Offset o
0aa0: 66 20 70 61 67 65 20 69 6e 20 66 69 6c 65 0a 20  f page in file. 
0ab0: 20 70 67 73 69 7a 65 20 20 20 20 20 49 4e 54 45   pgsize     INTE
0ac0: 47 45 52 2c 20 20 20 20 20 2d 2d 20 53 69 7a 65  GER,     -- Size
0ad0: 20 6f 66 20 74 68 65 20 70 61 67 65 0a 20 20 73   of the page.  s
0ae0: 63 68 65 6d 61 20 20 20 20 20 54 45 58 54 20 48  chema     TEXT H
0af0: 49 44 44 45 4e 20 20 2d 2d 20 44 61 74 61 62 61  IDDEN  -- Databa
0b00: 73 65 20 73 63 68 65 6d 61 20 62 65 69 6e 67 20  se schema being 
0b10: 61 6e 61 6c 79 7a 65 64 0a 29 3b 0a 3c 2f 63 6f  analyzed.);.</co
0b20: 64 65 62 6c 6f 63 6b 3e 0a 0a 3c 70 3e 0a 54 68  deblock>..<p>.Th
0b30: 65 72 65 20 69 73 20 61 20 73 69 6e 67 6c 65 20  ere is a single 
0b40: 72 6f 77 20 6f 66 20 74 68 65 20 64 62 73 74 61  row of the dbsta
0b50: 74 20 74 61 62 6c 65 20 66 6f 72 20 65 61 63 68  t table for each
0b60: 20 70 61 67 65 20 69 6e 20 74 68 65 0a 64 61 74   page in the.dat
0b70: 61 62 61 73 65 20 66 69 6c 65 2e 20 20 46 72 65  abase file.  Fre
0b80: 65 6c 69 73 74 20 70 61 67 65 73 2c 20 74 68 65  elist pages, the
0b90: 20 6c 6f 63 6b 20 70 61 67 65 2c 20 61 6e 64 0a   lock page, and.
0ba0: 70 6f 69 6e 74 65 72 2d 6d 61 70 20 70 61 67 65  pointer-map page
0bb0: 73 20 6f 66 20 74 68 65 20 64 61 74 61 62 61 73  s of the databas
0bc0: 65 20 66 69 6c 65 20 64 6f 20 6e 6f 74 20 61 70  e file do not ap
0bd0: 70 65 61 72 20 69 6e 20 74 68 65 0a 64 62 73 74  pear in the.dbst
0be0: 61 74 20 76 69 72 74 75 61 6c 20 74 61 62 6c 65  at virtual table
0bf0: 2e 0a 0a 3c 68 31 3e 54 68 65 20 22 70 61 74 68  ...<h1>The "path
0c00: 22 20 63 6f 6c 75 6d 6e 20 6f 66 20 74 68 65 20  " column of the 
0c10: 64 62 73 74 61 74 20 76 69 72 74 75 61 6c 20 74  dbstat virtual t
0c20: 61 62 6c 65 3c 2f 68 31 3e 0a 0a 3c 70 3e 0a 54  able</h1>..<p>.T
0c30: 68 65 20 22 70 61 74 68 22 20 63 6f 6c 75 6d 6e  he "path" column
0c40: 20 64 65 73 63 72 69 62 65 73 20 74 68 65 20 70   describes the p
0c50: 61 74 68 20 74 61 6b 65 6e 20 66 72 6f 6d 20 74  ath taken from t
0c60: 68 65 20 0a 72 6f 6f 74 20 6e 6f 64 65 20 6f 66  he .root node of
0c70: 20 74 68 65 20 62 74 72 65 65 20 73 74 72 75 63   the btree struc
0c80: 74 75 72 65 20 74 6f 20 65 61 63 68 20 70 61 67  ture to each pag
0c90: 65 2e 20 20 54 68 65 0a 22 70 61 74 68 22 20 6f  e.  The."path" o
0ca0: 66 20 74 68 65 20 72 6f 6f 74 20 6e 6f 64 65 20  f the root node 
0cb0: 69 74 73 65 6c 66 20 69 73 20 27 2f 27 2e 0a 0a  itself is '/'...
0cc0: 54 68 65 20 22 70 61 74 68 22 20 66 6f 72 20 74  The "path" for t
0cd0: 68 65 20 6c 65 66 74 2d 6d 6f 73 74 20 63 68 69  he left-most chi
0ce0: 6c 64 20 70 61 67 65 20 6f 66 20 74 68 65 20 72  ld page of the r
0cf0: 6f 6f 74 20 6f 66 0a 61 20 62 74 72 65 65 20 70  oot of.a btree p
0d00: 61 67 65 20 69 73 20 27 2f 30 30 30 2f 27 2e 20  age is '/000/'. 
0d10: 28 42 74 72 65 65 73 20 73 74 6f 72 65 20 63 6f  (Btrees store co
0d20: 6e 74 65 6e 74 20 6f 72 64 65 72 65 64 20 66 72  ntent ordered fr
0d30: 6f 6d 20 6c 65 66 74 20 74 6f 20 72 69 67 68 74  om left to right
0d40: 0a 73 6f 20 74 68 65 20 70 61 67 65 73 20 74 6f  .so the pages to
0d50: 20 74 68 65 20 6c 65 66 74 20 68 61 76 65 20 73   the left have s
0d60: 6d 61 6c 6c 65 72 20 6b 65 79 73 20 74 68 61 6e  maller keys than
0d70: 20 74 68 65 20 70 61 67 65 73 20 74 6f 20 74 68   the pages to th
0d80: 65 20 72 69 67 68 74 2e 29 0a 54 68 65 20 6e 65  e right.).The ne
0d90: 78 74 20 74 6f 20 6c 65 66 74 2d 6d 6f 73 74 20  xt to left-most 
0da0: 63 68 69 6c 64 20 6f 66 20 74 68 65 20 72 6f 6f  child of the roo
0db0: 74 20 70 61 67 65 20 69 73 20 27 2f 30 30 31 27  t page is '/001'
0dc0: 2c 20 61 6e 64 20 73 6f 20 6f 6e 2c 0a 65 61 63  , and so on,.eac
0dd0: 68 20 73 69 62 6c 69 6e 67 20 70 61 67 65 20 69  h sibling page i
0de0: 64 65 6e 74 69 66 69 65 64 20 62 79 20 61 20 33  dentified by a 3
0df0: 2d 64 69 67 69 74 20 68 65 78 20 20 76 61 6c 75  -digit hex  valu
0e00: 65 2e 0a 54 68 65 20 63 68 69 6c 64 72 65 6e 20  e..The children 
0e10: 6f 66 20 74 68 65 20 34 35 31 73 74 20 6c 65 66  of the 451st lef
0e20: 74 2d 6d 6f 73 74 20 73 69 62 6c 69 6e 67 20 68  t-most sibling h
0e30: 61 76 65 20 70 61 74 68 73 20 73 75 63 68 0a 61  ave paths such.a
0e40: 73 20 27 2f 31 63 32 2f 30 30 30 2f 2c 20 27 2f  s '/1c2/000/, '/
0e50: 31 63 32 2f 30 30 31 2f 27 20 65 74 63 2e 0a 0a  1c2/001/' etc...
0e60: 4f 76 65 72 66 6c 6f 77 20 70 61 67 65 73 20 61  Overflow pages a
0e70: 72 65 20 73 70 65 63 69 66 69 65 64 20 62 79 20  re specified by 
0e80: 61 70 70 65 6e 64 69 6e 67 20 61 20 27 2b 27 20  appending a '+' 
0e90: 63 68 61 72 61 63 74 65 72 20 61 6e 64 20 61 20  character and a 
0ea0: 0a 73 69 78 2d 64 69 67 69 74 20 68 65 78 61 64  .six-digit hexad
0eb0: 65 63 69 6d 61 6c 20 76 61 6c 75 65 20 74 6f 20  ecimal value to 
0ec0: 74 68 65 20 70 61 74 68 20 74 6f 20 74 68 65 20  the path to the 
0ed0: 63 65 6c 6c 20 74 68 65 79 20 61 72 65 20 6c 69  cell they are li
0ee0: 6e 6b 65 64 0a 66 72 6f 6d 2e 20 46 6f 72 20 65  nked.from. For e
0ef0: 78 61 6d 70 6c 65 2c 20 74 68 65 20 74 68 72 65  xample, the thre
0f00: 65 20 6f 76 65 72 66 6c 6f 77 20 70 61 67 65 73  e overflow pages
0f10: 20 69 6e 20 61 20 63 68 61 69 6e 20 6c 69 6e 6b   in a chain link
0f20: 65 64 20 66 72 6f 6d 20 0a 74 68 65 20 6c 65 66  ed from .the lef
0f30: 74 2d 6d 6f 73 74 20 63 65 6c 6c 20 6f 66 20 74  t-most cell of t
0f40: 68 65 20 34 35 30 74 68 20 63 68 69 6c 64 20 6f  he 450th child o
0f50: 66 20 74 68 65 20 72 6f 6f 74 20 70 61 67 65 20  f the root page 
0f60: 61 72 65 20 69 64 65 6e 74 69 66 69 65 64 0a 62  are identified.b
0f70: 79 20 74 68 65 20 70 61 74 68 73 3a 0a 0a 3c 63  y the paths:..<c
0f80: 6f 64 65 62 6c 6f 63 6b 3e 0a 27 2f 31 63 32 2f  odeblock>.'/1c2/
0f90: 30 30 30 2b 30 30 30 30 30 30 27 20 20 20 20 20  000+000000'     
0fa0: 20 20 20 20 2f 2f 20 46 69 72 73 74 20 70 61 67      // First pag
0fb0: 65 20 69 6e 20 6f 76 65 72 66 6c 6f 77 20 63 68  e in overflow ch
0fc0: 61 69 6e 0a 27 2f 31 63 32 2f 30 30 30 2b 30 30  ain.'/1c2/000+00
0fd0: 30 30 30 31 27 20 20 20 20 20 20 20 20 20 2f 2f  0001'         //
0fe0: 20 53 65 63 6f 6e 64 20 70 61 67 65 20 69 6e 20   Second page in 
0ff0: 6f 76 65 72 66 6c 6f 77 20 63 68 61 69 6e 0a 27  overflow chain.'
1000: 2f 31 63 32 2f 30 30 30 2b 30 30 30 30 30 32 27  /1c2/000+000002'
1010: 20 20 20 20 20 20 20 20 20 2f 2f 20 54 68 69 72           // Thir
1020: 64 20 70 61 67 65 20 69 6e 20 6f 76 65 72 66 6c  d page in overfl
1030: 6f 77 20 63 68 61 69 6e 0a 3c 2f 63 6f 64 65 62  ow chain.</codeb
1040: 6c 6f 63 6b 3e 0a 0a 3c 70 3e 0a 49 66 20 74 68  lock>..<p>.If th
1050: 65 20 70 61 74 68 73 20 61 72 65 20 73 6f 72 74  e paths are sort
1060: 65 64 20 75 73 69 6e 67 20 74 68 65 20 42 49 4e  ed using the BIN
1070: 41 52 59 20 63 6f 6c 6c 61 74 69 6f 6e 20 73 65  ARY collation se
1080: 71 75 65 6e 63 65 2c 20 74 68 65 6e 0a 74 68 65  quence, then.the
1090: 20 6f 76 65 72 66 6c 6f 77 20 70 61 67 65 73 20   overflow pages 
10a0: 61 73 73 6f 63 69 61 74 65 64 20 77 69 74 68 20  associated with 
10b0: 61 20 63 65 6c 6c 20 77 69 6c 6c 20 61 70 70 65  a cell will appe
10c0: 61 72 20 65 61 72 6c 69 65 72 20 69 6e 20 74 68  ar earlier in th
10d0: 65 0a 73 6f 72 74 2d 6f 72 64 65 72 20 74 68 61  e.sort-order tha
10e0: 6e 20 69 74 73 20 63 68 69 6c 64 20 70 61 67 65  n its child page
10f0: 3a 0a 0a 3c 63 6f 64 65 62 6c 6f 63 6b 3e 0a 27  :..<codeblock>.'
1100: 2f 31 63 32 2f 30 30 30 2f 27 20 20 20 20 20 20  /1c2/000/'      
1110: 20 20 20 20 20 20 20 20 20 2f 2f 20 4c 65 66 74           // Left
1120: 2d 6d 6f 73 74 20 63 68 69 6c 64 20 6f 66 20 34  -most child of 4
1130: 35 31 73 74 20 63 68 69 6c 64 20 6f 66 20 72 6f  51st child of ro
1140: 6f 74 0a 3c 2f 63 6f 64 65 62 6c 6f 63 6b 3e 0a  ot.</codeblock>.
1150: 0a 3c 68 31 3e 45 78 61 6d 70 6c 65 20 75 73 65  .<h1>Example use
1160: 73 20 6f 66 20 74 68 65 20 64 62 73 74 61 74 20  s of the dbstat 
1170: 76 69 72 74 75 61 6c 20 74 61 62 6c 65 3c 2f 68  virtual table</h
1180: 31 3e 0a 0a 3c 70 3e 0a 54 6f 20 66 69 6e 64 20  1>..<p>.To find 
1190: 74 68 65 20 74 6f 74 61 6c 20 6e 75 6d 62 65 72  the total number
11a0: 20 6f 66 20 70 61 67 65 73 20 75 73 65 64 20 74   of pages used t
11b0: 6f 20 73 74 6f 72 65 20 74 61 62 6c 65 20 22 78  o store table "x
11c0: 79 7a 22 20 69 6e 20 73 63 68 65 6d 61 20 22 61  yz" in schema "a
11d0: 75 78 31 22 2c 0a 75 73 65 3a 0a 0a 3c 63 6f 64  ux1",.use:..<cod
11e0: 65 62 6c 6f 63 6b 3e 0a 53 45 4c 45 43 54 20 63  eblock>.SELECT c
11f0: 6f 75 6e 74 28 2a 29 20 46 52 4f 4d 20 64 62 73  ount(*) FROM dbs
1200: 74 61 74 28 27 61 75 78 31 27 29 20 57 48 45 52  tat('aux1') WHER
1210: 45 20 6e 61 6d 65 3d 27 78 79 7a 27 3b 0a 3c 2f  E name='xyz';.</
1220: 63 6f 64 65 62 6c 6f 63 6b 3e 0a 0a 3c 70 3e 0a  codeblock>..<p>.
1230: 54 6f 20 73 65 65 20 68 6f 77 20 65 66 66 69 63  To see how effic
1240: 69 65 6e 74 6c 79 20 74 68 65 20 63 6f 6e 74 65  iently the conte
1250: 6e 74 20 6f 66 20 61 20 74 61 62 6c 65 20 69 73  nt of a table is
1260: 20 73 74 6f 72 65 64 20 6f 6e 20 64 69 73 6b 2c   stored on disk,
1270: 0a 63 6f 6d 70 75 74 65 20 74 68 65 20 61 6d 6f  .compute the amo
1280: 75 6e 74 20 6f 66 20 73 70 61 63 65 20 75 73 65  unt of space use
1290: 64 20 74 6f 20 68 6f 6c 64 20 61 63 74 75 61 6c  d to hold actual
12a0: 20 63 6f 6e 74 65 6e 74 20 64 69 76 69 64 65 64   content divided
12b0: 0a 62 79 20 74 68 65 20 74 6f 74 61 6c 20 61 6d  .by the total am
12c0: 6f 75 6e 74 20 6f 66 20 64 69 73 6b 20 73 70 61  ount of disk spa
12d0: 63 65 20 75 73 65 64 2e 20 20 54 68 65 20 63 6c  ce used.  The cl
12e0: 6f 73 65 72 20 74 68 69 73 20 6e 75 6d 62 65 72  oser this number
12f0: 0a 69 73 20 74 6f 20 31 30 30 25 2c 20 74 68 65  .is to 100%, the
1300: 20 6d 6f 72 65 20 65 66 66 69 63 69 65 6e 74 20   more efficient 
1310: 74 68 65 20 70 61 63 6b 69 6e 67 2e 20 20 28 49  the packing.  (I
1320: 6e 20 74 68 69 73 20 65 78 61 6d 70 6c 65 2c 20  n this example, 
1330: 74 68 65 0a 27 78 79 7a 27 20 74 61 62 6c 65 20  the.'xyz' table 
1340: 69 73 20 61 73 73 75 6d 65 64 20 74 6f 20 62 65  is assumed to be
1350: 20 69 6e 20 74 68 65 20 27 6d 61 69 6e 27 20 73   in the 'main' s
1360: 63 68 65 6d 61 2e 29 0a 0a 3c 63 6f 64 65 62 6c  chema.)..<codebl
1370: 6f 63 6b 3e 0a 53 45 4c 45 43 54 20 73 75 6d 28  ock>.SELECT sum(
1380: 70 67 73 69 7a 65 2d 75 6e 75 73 65 64 29 2f 73  pgsize-unused)/s
1390: 75 6d 28 70 67 73 69 7a 65 29 20 46 52 4f 4d 20  um(pgsize) FROM 
13a0: 64 62 73 74 61 74 20 57 48 45 52 45 20 6e 61 6d  dbstat WHERE nam
13b0: 65 3d 27 78 79 7a 27 3b 0a 3c 2f 63 6f 64 65 62  e='xyz';.</codeb
13c0: 6c 6f 63 6b 3e 0a 0a 3c 70 3e 0a 54 6f 20 66 69  lock>..<p>.To fi
13d0: 6e 64 20 74 68 65 20 61 76 65 72 61 67 65 20 66  nd the average f
13e0: 61 6e 2d 6f 75 74 20 66 6f 72 20 61 20 74 61 62  an-out for a tab
13f0: 6c 65 2c 20 72 75 6e 3a 0a 0a 3c 63 6f 64 65 62  le, run:..<codeb
1400: 6c 6f 63 6b 3e 0a 53 45 4c 45 43 54 20 61 76 67  lock>.SELECT avg
1410: 28 6e 63 65 6c 6c 29 20 46 52 4f 4d 20 64 62 73  (ncell) FROM dbs
1420: 74 61 74 20 57 48 45 52 45 20 6e 61 6d 65 3d 27  tat WHERE name='
1430: 78 79 7a 27 20 41 4e 44 20 70 61 67 65 74 79 70  xyz' AND pagetyp
1440: 65 3d 27 69 6e 74 65 72 6e 61 6c 27 3b 0a 3c 2f  e='internal';.</
1450: 63 6f 64 65 62 6c 6f 63 6b 3e 0a 0a 0a 3c 70 3e  codeblock>...<p>
1460: 0a 4d 6f 64 65 72 6e 20 66 69 6c 65 73 79 73 74  .Modern filesyst
1470: 65 6d 73 20 6f 70 65 72 61 74 65 20 66 61 73 74  ems operate fast
1480: 65 72 20 77 68 65 6e 20 64 69 73 6b 20 61 63 63  er when disk acc
1490: 65 73 73 65 73 20 61 72 65 20 73 65 71 75 65 6e  esses are sequen
14a0: 74 69 61 6c 2e 0a 48 65 6e 63 65 2c 20 53 51 4c  tial..Hence, SQL
14b0: 69 74 65 20 77 69 6c 6c 20 72 75 6e 20 66 61 73  ite will run fas
14c0: 74 65 72 20 69 66 20 74 68 65 20 63 6f 6e 74 65  ter if the conte
14d0: 6e 74 20 6f 66 20 74 68 65 20 64 61 74 61 62 61  nt of the databa
14e0: 73 65 20 66 69 6c 65 0a 69 73 20 6f 6e 20 73 65  se file.is on se
14f0: 71 75 65 6e 74 69 61 6c 20 70 61 67 65 73 2e 20  quential pages. 
1500: 20 54 6f 20 66 69 6e 64 20 6f 75 74 20 77 68 61   To find out wha
1510: 74 20 66 72 61 63 74 69 6f 6e 20 6f 66 20 74 68  t fraction of th
1520: 65 20 70 61 67 65 73 20 69 6e 0a 61 20 64 61 74  e pages in.a dat
1530: 61 62 61 73 65 20 61 72 65 20 73 65 71 75 65 6e  abase are sequen
1540: 74 69 61 6c 20 28 61 6e 64 20 74 68 75 73 20 6f  tial (and thus o
1550: 62 74 61 69 6e 20 61 20 6d 65 61 73 75 72 65 6d  btain a measurem
1560: 65 6e 74 20 74 68 61 74 20 6d 69 67 68 74 0a 62  ent that might.b
1570: 65 20 75 73 65 66 75 6c 20 69 6e 20 64 65 74 65  e useful in dete
1580: 72 6d 69 6e 69 6e 67 20 77 68 65 6e 20 74 6f 20  rmining when to 
1590: 5b 56 41 43 55 55 4d 5d 29 2c 20 72 75 6e 20 61  [VACUUM]), run a
15a0: 20 71 75 65 72 79 20 6c 69 6b 65 20 74 68 65 20   query like the 
15b0: 66 6f 6c 6c 6f 77 69 6e 67 3a 0a 0a 3c 63 6f 64  following:..<cod
15c0: 65 62 6c 6f 63 6b 3e 0a 43 52 45 41 54 45 20 54  eblock>.CREATE T
15d0: 45 4d 50 20 54 41 42 4c 45 20 73 28 72 6f 77 69  EMP TABLE s(rowi
15e0: 64 20 49 4e 54 45 47 45 52 20 50 52 49 4d 41 52  d INTEGER PRIMAR
15f0: 59 20 4b 45 59 2c 20 70 61 67 65 6e 6f 20 49 4e  Y KEY, pageno IN
1600: 54 29 3b 0a 49 4e 53 45 52 54 20 49 4e 54 4f 20  T);.INSERT INTO 
1610: 73 28 70 61 67 65 6e 6f 29 20 53 45 4c 45 43 54  s(pageno) SELECT
1620: 20 70 61 67 65 6e 6f 20 46 52 4f 4d 20 64 62 73   pageno FROM dbs
1630: 74 61 74 20 4f 52 44 45 52 20 42 59 20 70 61 74  tat ORDER BY pat
1640: 68 3b 0a 53 45 4c 45 43 54 20 73 75 6d 28 73 31  h;.SELECT sum(s1
1650: 2e 70 61 67 65 6e 6f 2b 31 3d 3d 73 32 2e 70 61  .pageno+1==s2.pa
1660: 67 65 6e 6f 29 2a 31 2e 30 2f 63 6f 75 6e 74 28  geno)*1.0/count(
1670: 2a 29 0a 20 20 46 52 4f 4d 20 73 20 41 53 20 73  *).  FROM s AS s
1680: 31 2c 20 73 20 41 53 20 73 32 0a 20 57 48 45 52  1, s AS s2. WHER
1690: 45 20 73 31 2e 72 6f 77 69 64 2b 31 3d 73 32 2e  E s1.rowid+1=s2.
16a0: 72 6f 77 69 64 3b 0a 44 52 4f 50 20 54 41 42 4c  rowid;.DROP TABL
16b0: 45 20 73 3b 0a 3c 2f 63 6f 64 65 62 6c 6f 63 6b  E s;.</codeblock
16c0: 3e 0a                                            >.