Documentation Source Text

Hex Artifact Content
Login

Artifact 788d25eeb69ca74eb682099c5dd0056d8eec75c3:


0000: 48 4c 52 20 48 35 30 30 31 30 0a 54 68 65 20 42  HLR H50010.The B
0010: 2d 54 72 65 65 20 6d 6f 64 75 6c 65 20 73 68 61  -Tree module sha
0020: 6c 6c 20 70 72 6f 76 69 64 65 20 61 6e 20 69 6e  ll provide an in
0030: 74 65 72 66 61 63 65 20 74 6f 20 6f 70 65 6e 20  terface to open 
0040: 61 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 0a 74 6f  a connection .to
0050: 20 65 69 74 68 65 72 20 61 20 6e 61 6d 65 64 20   either a named 
0060: 70 65 72 73 69 73 74 65 6e 74 20 64 61 74 61 62  persistent datab
0070: 61 73 65 20 66 69 6c 65 2c 20 6f 72 20 61 6e 20  ase file, or an 
0080: 61 6e 6f 6e 79 6d 6f 75 73 20 74 65 6d 70 6f 72  anonymous tempor
0090: 61 72 79 20 0a 64 61 74 61 62 61 73 65 2e 0a 0a  ary .database...
00a0: 48 4c 52 20 48 35 30 30 32 30 0a 57 68 65 6e 20  HLR H50020.When 
00b0: 6f 70 65 6e 69 6e 67 20 61 20 70 65 72 73 69 73  opening a persis
00c0: 74 65 6e 74 20 64 61 74 61 62 61 73 65 2c 20 74  tent database, t
00d0: 68 65 20 42 2d 54 72 65 65 20 6d 6f 64 75 6c 65  he B-Tree module
00e0: 20 73 68 61 6c 6c 20 61 6c 6c 6f 77 20 74 68 65   shall allow the
00f0: 20 75 73 65 72 20 0a 74 6f 20 73 70 65 63 69 66   user .to specif
0100: 79 20 74 68 61 74 20 74 68 65 20 63 6f 6e 6e 65  y that the conne
0110: 63 74 69 6f 6e 20 62 65 20 6f 70 65 6e 65 64 20  ction be opened 
0120: 66 6f 72 20 72 65 61 64 2d 6f 6e 6c 79 20 61 63  for read-only ac
0130: 63 65 73 73 2e 0a 0a 48 4c 52 20 48 35 30 30 33  cess...HLR H5003
0140: 30 0a 57 68 65 6e 20 6f 70 65 6e 69 6e 67 20 61  0.When opening a
0150: 20 70 65 72 73 69 73 74 65 6e 74 20 64 61 74 61   persistent data
0160: 62 61 73 65 2c 20 74 68 65 20 42 2d 54 72 65 65  base, the B-Tree
0170: 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c 20 61 6c   module shall al
0180: 6c 6f 77 20 74 68 65 20 75 73 65 72 20 0a 74 6f  low the user .to
0190: 20 73 70 65 63 69 66 79 20 74 68 61 74 20 74 68   specify that th
01a0: 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 6f 6e 6c  e connection onl
01b0: 79 20 62 65 20 6f 70 65 6e 65 64 20 69 66 20 74  y be opened if t
01c0: 68 65 20 73 70 65 63 69 66 69 65 64 20 66 69 6c  he specified fil
01d0: 65 20 65 78 69 73 74 73 2e 0a 0a 48 4c 52 20 48  e exists...HLR H
01e0: 35 30 30 34 30 0a 49 66 20 53 51 4c 69 74 65 20  50040.If SQLite 
01f0: 69 73 20 63 6f 6e 66 69 67 75 72 65 64 20 74 6f  is configured to
0200: 20 72 75 6e 20 69 6e 20 73 68 61 72 65 64 2d 63   run in shared-c
0210: 61 63 68 65 20 6d 6f 64 65 2c 20 61 6e 64 20 61  ache mode, and a
0220: 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 6f   connection is o
0230: 70 65 6e 65 64 0a 74 6f 20 61 20 70 65 72 73 69  pened.to a persi
0240: 73 74 65 6e 74 20 64 61 74 61 62 61 73 65 20 66  stent database f
0250: 69 6c 65 20 66 6f 72 20 77 68 69 63 68 20 74 68  ile for which th
0260: 65 72 65 20 65 78 69 73 74 73 20 61 6c 72 65 61  ere exists alrea
0270: 64 79 20 61 20 70 61 67 65 2d 63 61 63 68 65 20  dy a page-cache 
0280: 77 69 74 68 69 6e 20 0a 74 68 65 20 63 75 72 72  within .the curr
0290: 65 6e 74 20 70 72 6f 63 65 73 73 65 73 20 61 64  ent processes ad
02a0: 64 72 65 73 73 20 73 70 61 63 65 2c 20 74 68 65  dress space, the
02b0: 6e 20 74 68 65 20 63 6f 6e 6e 65 63 74 69 6f 6e  n the connection
02c0: 20 6f 70 65 6e 65 64 20 73 68 61 6c 6c 20 62 65   opened shall be
02d0: 20 61 0a 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 6f   a.connection to
02e0: 20 74 68 65 20 65 78 69 73 74 69 6e 67 20 70 61   the existing pa
02f0: 67 65 2d 63 61 63 68 65 2e 0a 0a 48 4c 52 20 48  ge-cache...HLR H
0300: 35 30 30 35 30 0a 49 66 20 61 20 6e 65 77 20 42  50050.If a new B
0310: 2d 54 72 65 65 20 64 61 74 61 62 61 73 65 20 63  -Tree database c
0320: 6f 6e 6e 65 63 74 69 6f 6e 20 69 73 20 6f 70 65  onnection is ope
0330: 6e 65 64 20 61 6e 64 20 72 65 71 75 69 72 65 6d  ned and requirem
0340: 65 6e 74 20 48 35 30 30 34 30 20 64 6f 65 73 20  ent H50040 does 
0350: 6e 6f 74 20 61 70 70 6c 79 2c 0a 74 68 65 6e 20  not apply,.then 
0360: 61 20 6e 65 77 20 70 61 67 65 2d 63 61 63 68 65  a new page-cache
0370: 20 73 68 61 6c 6c 20 62 65 20 63 72 65 61 74 65   shall be create
0380: 64 20 77 69 74 68 69 6e 20 74 68 65 20 70 72 6f  d within the pro
0390: 63 65 73 73 65 73 20 61 64 64 72 65 73 73 20 73  cesses address s
03a0: 70 61 63 65 2e 20 54 68 65 0a 6f 70 65 6e 65 64  pace. The.opened
03b0: 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 73 68 61 6c   connection shal
03c0: 6c 20 62 65 20 61 20 63 6f 6e 6e 65 63 74 69 6f  l be a connectio
03d0: 6e 20 74 6f 20 74 68 65 20 6e 65 77 20 70 61 67  n to the new pag
03e0: 65 2d 63 61 63 68 65 2e 0a 0a 48 4c 52 20 48 35  e-cache...HLR H5
03f0: 30 30 36 30 0a 54 68 65 20 42 2d 54 72 65 65 20  0060.The B-Tree 
0400: 6d 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70 72 6f  module shall pro
0410: 76 69 64 65 20 61 6e 20 69 6e 74 65 72 66 61 63  vide an interfac
0420: 65 20 74 6f 20 63 6c 6f 73 65 20 61 20 42 2d 54  e to close a B-T
0430: 72 65 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e  ree database con
0440: 6e 65 63 74 69 6f 6e 2e 20 0a 0a 48 4c 52 20 48  nection. ..HLR H
0450: 35 30 30 37 30 0a 49 66 20 61 20 42 2d 54 72 65  50070.If a B-Tre
0460: 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65  e database conne
0470: 63 74 69 6f 6e 20 69 73 20 63 6c 6f 73 65 64 20  ction is closed 
0480: 61 6e 64 20 74 68 69 73 20 63 61 75 73 65 73 20  and this causes 
0490: 74 68 65 20 61 73 73 6f 63 69 61 74 65 64 0a 70  the associated.p
04a0: 61 67 65 2d 63 61 63 68 65 20 74 6f 20 68 61 76  age-cache to hav
04b0: 65 20 7a 65 72 6f 20 63 6f 6e 6e 65 63 74 69 6f  e zero connectio
04c0: 6e 73 20 74 6f 20 69 74 2c 20 74 68 65 6e 20 74  ns to it, then t
04d0: 68 65 20 70 61 67 65 2d 63 61 63 68 65 20 73 68  he page-cache sh
04e0: 61 6c 6c 20 62 65 20 63 6c 6f 73 65 64 0a 61 6e  all be closed.an
04f0: 64 20 61 6c 6c 20 61 73 73 6f 63 69 61 74 65 64  d all associated
0500: 20 72 65 73 6f 75 72 63 65 73 20 72 65 6c 65 61   resources relea
0510: 73 65 64 2e 0a 0a 48 4c 52 20 48 35 30 30 38 30  sed...HLR H50080
0520: 0a 54 68 65 20 42 2d 54 72 65 65 20 6d 6f 64 75  .The B-Tree modu
0530: 6c 65 20 73 68 61 6c 6c 20 70 72 6f 76 69 64 65  le shall provide
0540: 20 61 6e 20 69 6e 74 65 72 66 61 63 65 20 74 6f   an interface to
0550: 20 63 6f 6e 66 69 67 75 72 65 20 74 68 65 20 70   configure the p
0560: 61 67 65 2d 73 69 7a 65 20 6f 66 20 61 0a 6e 65  age-size of a.ne
0570: 77 20 64 61 74 61 62 61 73 65 20 69 6d 61 67 65  w database image
0580: 2e 20 0a 0a 48 4c 52 20 48 35 30 30 39 30 0a 54  . ..HLR H50090.T
0590: 68 65 20 42 2d 54 72 65 65 20 6d 6f 64 75 6c 65  he B-Tree module
05a0: 20 73 68 61 6c 6c 20 70 72 6f 76 69 64 65 20 61   shall provide a
05b0: 6e 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20 63  n interface to c
05c0: 6f 6e 66 69 67 75 72 65 20 77 68 65 74 68 65 72  onfigure whether
05d0: 20 6f 72 20 6e 6f 74 20 61 20 6e 65 77 0a 64 61   or not a new.da
05e0: 74 61 62 61 73 65 20 69 6d 61 67 65 20 69 73 20  tabase image is 
05f0: 61 75 74 6f 2d 76 61 63 75 75 6d 20 63 61 70 61  auto-vacuum capa
0600: 62 6c 65 2e 0a 0a 0a 48 4c 52 20 48 35 30 31 30  ble....HLR H5010
0610: 30 0a 54 68 65 20 42 2d 54 72 65 65 20 6d 6f 64  0.The B-Tree mod
0620: 75 6c 65 20 73 68 61 6c 6c 20 70 72 6f 76 69 64  ule shall provid
0630: 65 20 61 6e 20 69 6e 74 65 72 66 61 63 65 20 74  e an interface t
0640: 6f 20 6f 70 65 6e 20 28 73 74 61 72 74 29 20 61  o open (start) a
0650: 20 72 65 61 64 2d 6f 6e 6c 79 20 74 72 61 6e 73   read-only trans
0660: 61 63 74 69 6f 6e 2e 0a 0a 48 4c 52 20 48 35 30  action...HLR H50
0670: 31 30 31 0a 54 68 65 20 42 2d 54 72 65 65 20 6d  101.The B-Tree m
0680: 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70 72 6f 76  odule shall prov
0690: 69 64 65 20 61 6e 20 69 6e 74 65 72 66 61 63 65  ide an interface
06a0: 20 74 6f 20 63 6c 6f 73 65 20 28 66 69 6e 69 73   to close (finis
06b0: 68 29 20 61 20 72 65 61 64 2d 6f 6e 6c 79 20 74  h) a read-only t
06c0: 72 61 6e 73 61 63 74 69 6f 6e 2e 0a 0a 48 4c 52  ransaction...HLR
06d0: 20 48 35 30 31 30 32 0a 54 68 65 20 42 2d 54 72   H50102.The B-Tr
06e0: 65 65 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c 20  ee module shall 
06f0: 70 72 6f 76 69 64 65 20 61 6e 20 69 6e 74 65 72  provide an inter
0700: 66 61 63 65 20 74 6f 20 6f 70 65 6e 20 61 20 72  face to open a r
0710: 65 61 64 2f 77 72 69 74 65 20 74 72 61 6e 73 61  ead/write transa
0720: 63 74 69 6f 6e 0a 6f 72 20 74 6f 20 75 70 67 72  ction.or to upgr
0730: 61 64 65 20 66 72 6f 6d 20 61 20 72 65 61 64 2d  ade from a read-
0740: 6f 6e 6c 79 20 74 72 61 6e 73 61 63 74 69 6f 6e  only transaction
0750: 20 74 6f 20 61 20 72 65 61 64 2f 77 72 69 74 65   to a read/write
0760: 20 74 72 61 6e 73 61 63 74 69 6f 6e 2e 0a 0a 48   transaction...H
0770: 4c 52 20 48 35 30 31 30 33 0a 54 68 65 20 42 2d  LR H50103.The B-
0780: 54 72 65 65 20 6d 6f 64 75 6c 65 20 73 68 61 6c  Tree module shal
0790: 6c 20 70 72 6f 76 69 64 65 20 61 6e 20 69 6e 74  l provide an int
07a0: 65 72 66 61 63 65 20 74 6f 20 63 6f 6d 6d 69 74  erface to commit
07b0: 20 61 20 72 65 61 64 2f 77 72 69 74 65 20 74 72   a read/write tr
07c0: 61 6e 73 61 63 74 69 6f 6e 2e 0a 0a 48 4c 52 20  ansaction...HLR 
07d0: 48 35 30 31 30 34 0a 54 68 65 20 42 2d 54 72 65  H50104.The B-Tre
07e0: 65 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70  e module shall p
07f0: 72 6f 76 69 64 65 20 61 6e 20 69 6e 74 65 72 66  rovide an interf
0800: 61 63 65 20 74 6f 20 72 6f 6c 6c 62 61 63 6b 20  ace to rollback 
0810: 61 20 72 65 61 64 2f 77 72 69 74 65 20 74 72 61  a read/write tra
0820: 6e 73 61 63 74 69 6f 6e 2e 0a 0a 48 4c 52 20 48  nsaction...HLR H
0830: 35 30 31 30 35 0a 54 68 65 20 42 2d 54 72 65 65  50105.The B-Tree
0840: 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70 72   module shall pr
0850: 6f 76 69 64 65 20 61 6e 20 69 6e 74 65 72 66 61  ovide an interfa
0860: 63 65 20 74 6f 20 6f 70 65 6e 20 73 61 76 65 70  ce to open savep
0870: 6f 69 6e 74 20 74 72 61 6e 73 61 63 74 69 6f 6e  oint transaction
0880: 73 2e 0a 0a 48 4c 52 20 48 35 30 31 30 36 0a 54  s...HLR H50106.T
0890: 68 65 20 42 2d 54 72 65 65 20 6d 6f 64 75 6c 65  he B-Tree module
08a0: 20 73 68 61 6c 6c 20 70 72 6f 76 69 64 65 20 61   shall provide a
08b0: 6e 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20 63  n interface to c
08c0: 6f 6d 6d 69 74 20 73 61 76 65 70 6f 69 6e 74 20  ommit savepoint 
08d0: 74 72 61 6e 73 61 63 74 69 6f 6e 73 2e 0a 0a 48  transactions...H
08e0: 4c 52 20 48 35 30 31 30 37 0a 54 68 65 20 42 2d  LR H50107.The B-
08f0: 54 72 65 65 20 6d 6f 64 75 6c 65 20 73 68 61 6c  Tree module shal
0900: 6c 20 70 72 6f 76 69 64 65 20 61 6e 20 69 6e 74  l provide an int
0910: 65 72 66 61 63 65 20 74 6f 20 72 6f 6c 6c 62 61  erface to rollba
0920: 63 6b 20 73 61 76 65 70 6f 69 6e 74 20 74 72 61  ck savepoint tra
0930: 6e 73 61 63 74 69 6f 6e 73 2e 0a 0a 48 4c 52 20  nsactions...HLR 
0940: 48 35 30 31 30 38 0a 54 68 65 20 42 2d 54 72 65  H50108.The B-Tre
0950: 65 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70  e module shall p
0960: 72 6f 76 69 64 65 20 61 6e 20 69 6e 74 65 72 66  rovide an interf
0970: 61 63 65 20 74 6f 20 71 75 65 72 79 20 61 20 42  ace to query a B
0980: 2d 54 72 65 65 20 64 61 74 61 62 61 73 65 0a 63  -Tree database.c
0990: 6f 6e 6e 65 63 74 69 6f 6e 20 74 6f 20 64 65 74  onnection to det
09a0: 65 72 6d 69 6e 65 20 69 66 20 74 68 65 72 65 20  ermine if there 
09b0: 69 73 20 61 6e 20 6f 70 65 6e 20 74 72 61 6e 73  is an open trans
09c0: 61 63 74 69 6f 6e 2c 20 61 6e 64 20 69 66 20 73  action, and if s
09d0: 6f 20 69 66 20 74 68 65 20 6f 70 65 6e 0a 74 72  o if the open.tr
09e0: 61 6e 73 61 63 74 69 6f 6e 20 69 73 20 72 65 61  ansaction is rea
09f0: 64 2d 6f 6e 6c 79 20 6f 72 20 72 65 61 64 2f 77  d-only or read/w
0a00: 72 69 74 65 2e 0a 0a 0a 0a 48 4c 52 20 48 35 30  rite.....HLR H50
0a10: 31 30 39 0a 54 68 65 20 42 2d 54 72 65 65 20 6d  109.The B-Tree m
0a20: 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70 72 6f 76  odule shall prov
0a30: 69 64 65 20 61 6e 20 69 6e 74 65 72 66 61 63 65  ide an interface
0a40: 20 74 6f 20 72 65 61 64 20 74 68 65 20 76 61 6c   to read the val
0a50: 75 65 20 6f 66 20 61 6e 79 20 6f 66 20 74 68 65  ue of any of the
0a60: 0a 34 2d 62 79 74 65 20 75 6e 73 69 67 6e 65 64  .4-byte unsigned
0a70: 20 62 69 67 2d 65 6e 64 69 61 6e 20 69 6e 74 65   big-endian inte
0a80: 67 65 72 20 66 69 65 6c 64 73 20 62 65 67 69 6e  ger fields begin
0a90: 6e 69 6e 67 20 61 74 20 62 79 74 65 20 6f 66 66  ning at byte off
0aa0: 73 65 74 20 33 36 20 6f 66 20 74 68 65 0a 64 61  set 36 of the.da
0ab0: 74 61 62 61 73 65 20 69 6d 61 67 65 2e 0a 0a 48  tabase image...H
0ac0: 4c 52 20 48 35 30 31 31 30 0a 54 68 65 20 42 2d  LR H50110.The B-
0ad0: 54 72 65 65 20 6d 6f 64 75 6c 65 20 73 68 61 6c  Tree module shal
0ae0: 6c 20 70 72 6f 76 69 64 65 20 61 6e 20 69 6e 74  l provide an int
0af0: 65 72 66 61 63 65 20 74 6f 20 6f 70 65 6e 20 61  erface to open a
0b00: 20 42 2d 54 72 65 65 20 63 75 72 73 6f 72 20 6f   B-Tree cursor o
0b10: 6e 20 61 6e 79 20 74 61 62 6c 65 20 6f 72 0a 69  n any table or.i
0b20: 6e 64 65 78 20 62 2d 74 72 65 65 20 77 69 74 68  ndex b-tree with
0b30: 69 6e 20 74 68 65 20 64 61 74 61 62 61 73 65 20  in the database 
0b40: 69 6d 61 67 65 2c 20 67 69 76 65 6e 20 69 74 73  image, given its
0b50: 20 72 6f 6f 74 20 70 61 67 65 20 6e 75 6d 62 65   root page numbe
0b60: 72 2e 0a 0a 48 4c 52 20 48 35 30 31 31 31 0a 54  r...HLR H50111.T
0b70: 68 65 20 42 2d 54 72 65 65 20 6d 6f 64 75 6c 65  he B-Tree module
0b80: 20 73 68 61 6c 6c 20 70 72 6f 76 69 64 65 20 61   shall provide a
0b90: 6e 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20 63  n interface to c
0ba0: 6c 6f 73 65 20 61 20 42 2d 54 72 65 65 20 63 75  lose a B-Tree cu
0bb0: 72 73 6f 72 2e 0a 0a 48 4c 52 20 48 35 30 31 31  rsor...HLR H5011
0bc0: 32 0a 54 68 65 20 42 2d 54 72 65 65 20 6d 6f 64  2.The B-Tree mod
0bd0: 75 6c 65 20 73 68 61 6c 6c 20 70 72 6f 76 69 64  ule shall provid
0be0: 65 20 61 6e 20 69 6e 74 65 72 66 61 63 65 20 74  e an interface t
0bf0: 6f 20 6d 6f 76 65 20 61 6e 20 6f 70 65 6e 20 42  o move an open B
0c00: 2d 54 72 65 65 20 63 75 72 73 6f 72 20 74 6f 0a  -Tree cursor to.
0c10: 74 68 65 20 65 6e 74 72 79 20 61 73 73 6f 63 69  the entry associ
0c20: 61 74 65 64 20 77 69 74 68 20 74 68 65 20 6c 61  ated with the la
0c30: 72 67 65 73 74 20 6b 65 79 20 69 6e 20 74 68 65  rgest key in the
0c40: 20 6f 70 65 6e 20 62 2d 74 72 65 65 20 73 74 72   open b-tree str
0c50: 75 63 74 75 72 65 2e 0a 0a 48 4c 52 20 48 35 30  ucture...HLR H50
0c60: 31 31 33 0a 54 68 65 20 42 2d 54 72 65 65 20 6d  113.The B-Tree m
0c70: 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70 72 6f 76  odule shall prov
0c80: 69 64 65 20 61 6e 20 69 6e 74 65 72 66 61 63 65  ide an interface
0c90: 20 74 6f 20 6d 6f 76 65 20 61 6e 20 6f 70 65 6e   to move an open
0ca0: 20 42 2d 54 72 65 65 20 63 75 72 73 6f 72 20 74   B-Tree cursor t
0cb0: 6f 0a 74 68 65 20 65 6e 74 72 79 20 61 73 73 6f  o.the entry asso
0cc0: 63 69 61 74 65 64 20 77 69 74 68 20 74 68 65 20  ciated with the 
0cd0: 73 6d 61 6c 6c 65 73 74 20 6b 65 79 20 69 6e 20  smallest key in 
0ce0: 74 68 65 20 6f 70 65 6e 20 62 2d 74 72 65 65 20  the open b-tree 
0cf0: 73 74 72 75 63 74 75 72 65 2e 0a 0a 0a 48 4c 52  structure....HLR
0d00: 20 48 35 30 31 31 34 0a 54 68 65 20 42 2d 54 72   H50114.The B-Tr
0d10: 65 65 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c 20  ee module shall 
0d20: 70 72 6f 76 69 64 65 20 61 6e 20 69 6e 74 65 72  provide an inter
0d30: 66 61 63 65 20 74 6f 20 6d 6f 76 65 20 61 6e 20  face to move an 
0d40: 6f 70 65 6e 20 42 2d 54 72 65 65 20 63 75 72 73  open B-Tree curs
0d50: 6f 72 20 74 68 61 74 0a 63 75 72 72 65 6e 74 6c  or that.currentl
0d60: 79 20 70 6f 69 6e 74 73 20 61 74 20 61 20 76 61  y points at a va
0d70: 6c 69 64 20 62 2d 74 72 65 65 20 65 6e 74 72 79  lid b-tree entry
0d80: 20 74 6f 20 74 68 65 20 6e 65 78 74 20 65 6e 74   to the next ent
0d90: 72 79 20 69 6e 20 74 68 65 20 62 2d 74 72 65 65  ry in the b-tree
0da0: 0a 73 74 72 75 63 74 75 72 65 2c 20 73 6f 72 74  .structure, sort
0db0: 65 64 20 69 6e 20 6f 72 64 65 72 20 6f 66 20 6b  ed in order of k
0dc0: 65 79 20 76 61 6c 75 65 2c 20 69 66 20 61 6e 79  ey value, if any
0dd0: 2e 0a 0a 48 4c 52 20 48 35 30 31 31 35 0a 54 68  ...HLR H50115.Th
0de0: 65 20 42 2d 54 72 65 65 20 6d 6f 64 75 6c 65 20  e B-Tree module 
0df0: 73 68 61 6c 6c 20 70 72 6f 76 69 64 65 20 61 6e  shall provide an
0e00: 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20 6d 6f   interface to mo
0e10: 76 65 20 61 6e 20 6f 70 65 6e 20 42 2d 54 72 65  ve an open B-Tre
0e20: 65 20 63 75 72 73 6f 72 20 74 68 61 74 0a 63 75  e cursor that.cu
0e30: 72 72 65 6e 74 6c 79 20 70 6f 69 6e 74 73 20 61  rrently points a
0e40: 74 20 61 20 76 61 6c 69 64 20 62 2d 74 72 65 65  t a valid b-tree
0e50: 20 65 6e 74 72 79 20 74 6f 20 74 68 65 20 70 72   entry to the pr
0e60: 65 76 69 6f 75 73 20 65 6e 74 72 79 20 69 6e 20  evious entry in 
0e70: 74 68 65 20 62 2d 74 72 65 65 0a 73 74 72 75 63  the b-tree.struc
0e80: 74 75 72 65 2c 20 73 6f 72 74 65 64 20 69 6e 20  ture, sorted in 
0e90: 6f 72 64 65 72 20 6f 66 20 6b 65 79 20 76 61 6c  order of key val
0ea0: 75 65 2c 20 69 66 20 61 6e 79 2e 0a 0a 48 4c 52  ue, if any...HLR
0eb0: 20 48 35 30 31 31 36 0a 54 68 65 20 42 2d 54 72   H50116.The B-Tr
0ec0: 65 65 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c 20  ee module shall 
0ed0: 70 72 6f 76 69 64 65 20 61 6e 20 69 6e 74 65 72  provide an inter
0ee0: 66 61 63 65 20 74 6f 20 72 65 74 72 69 65 76 65  face to retrieve
0ef0: 20 74 68 65 20 6b 65 79 20 76 61 6c 75 65 20 0a   the key value .
0f00: 61 73 73 6f 63 69 61 74 65 64 20 77 69 74 68 20  associated with 
0f10: 74 68 65 20 62 2d 74 72 65 65 20 73 74 72 75 63  the b-tree struc
0f20: 74 75 72 65 20 65 6e 74 72 79 20 74 68 61 74 20  ture entry that 
0f30: 61 20 42 2d 54 72 65 65 20 63 75 72 73 6f 72 20  a B-Tree cursor 
0f40: 69 73 20 70 6f 69 6e 74 69 6e 67 20 74 6f 2c 0a  is pointing to,.
0f50: 69 66 20 61 6e 79 2e 0a 0a 48 4c 52 20 48 35 30  if any...HLR H50
0f60: 31 31 37 0a 54 68 65 20 42 2d 54 72 65 65 20 6d  117.The B-Tree m
0f70: 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70 72 6f 76  odule shall prov
0f80: 69 64 65 20 61 6e 20 69 6e 74 65 72 66 61 63 65  ide an interface
0f90: 20 74 6f 20 72 65 74 72 69 65 76 65 20 74 68 65   to retrieve the
0fa0: 20 62 6c 6f 62 20 6f 66 20 64 61 74 61 20 28 74   blob of data (t
0fb0: 68 65 0a 64 61 74 61 62 61 73 65 20 72 65 63 6f  he.database reco
0fc0: 72 64 29 20 61 73 73 6f 63 69 61 74 65 64 20 77  rd) associated w
0fd0: 69 74 68 20 74 68 65 20 62 2d 74 72 65 65 20 73  ith the b-tree s
0fe0: 74 72 75 63 74 75 72 65 20 65 6e 74 72 79 20 74  tructure entry t
0ff0: 68 61 74 20 61 20 42 2d 54 72 65 65 0a 63 75 72  hat a B-Tree.cur
1000: 73 6f 72 20 6f 70 65 6e 20 6f 6e 20 61 20 74 61  sor open on a ta
1010: 62 6c 65 20 62 2d 74 72 65 65 20 69 73 20 70 6f  ble b-tree is po
1020: 69 6e 74 69 6e 67 20 74 6f 2c 20 69 66 20 61 6e  inting to, if an
1030: 79 2e 0a 0a 48 4c 52 20 48 35 30 31 31 38 0a 54  y...HLR H50118.T
1040: 68 65 20 42 2d 54 72 65 65 20 6d 6f 64 75 6c 65  he B-Tree module
1050: 20 73 68 61 6c 6c 20 70 72 6f 76 69 64 65 20 61   shall provide a
1060: 6e 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20 72  n interface to r
1070: 65 74 75 72 6e 20 74 68 65 20 6e 75 6d 62 65 72  eturn the number
1080: 20 6f 66 20 65 6e 74 72 69 65 73 0a 63 75 72 72   of entries.curr
1090: 65 6e 74 6c 79 20 73 74 6f 72 65 64 20 69 6e 20  ently stored in 
10a0: 74 68 65 20 62 2d 74 72 65 65 20 73 74 72 75 63  the b-tree struc
10b0: 74 75 72 65 20 74 68 61 74 20 61 20 42 2d 54 72  ture that a B-Tr
10c0: 65 65 20 63 75 72 73 6f 72 20 69 73 20 6f 70 65  ee cursor is ope
10d0: 6e 20 6f 6e 2e 0a 0a 0a 48 4c 52 20 48 35 30 31  n on....HLR H501
10e0: 31 39 0a 47 69 76 65 6e 20 61 20 6b 65 79 20 76  19.Given a key v
10f0: 61 6c 75 65 2c 20 74 68 65 20 42 2d 54 72 65 65  alue, the B-Tree
1100: 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70 72   module shall pr
1110: 6f 76 69 64 65 20 61 6e 20 69 6e 74 65 72 66 61  ovide an interfa
1120: 63 65 20 74 6f 20 6d 6f 76 65 20 61 0a 42 2d 54  ce to move a.B-T
1130: 72 65 65 20 63 75 72 73 6f 72 20 6f 70 65 6e 20  ree cursor open 
1140: 6f 6e 20 61 20 62 2d 74 72 65 65 20 73 74 72 75  on a b-tree stru
1150: 63 74 75 72 65 20 74 6f 20 74 68 65 20 42 2d 54  cture to the B-T
1160: 72 65 65 20 65 6e 74 72 79 20 77 69 74 68 20 74  ree entry with t
1170: 68 65 20 6d 61 74 63 68 69 6e 67 0a 6b 65 79 20  he matching.key 
1180: 76 61 6c 75 65 2c 20 69 66 20 73 75 63 68 20 61  value, if such a
1190: 6e 20 65 6e 74 72 79 20 65 78 69 73 74 73 2e 0a  n entry exists..
11a0: 0a 48 4c 52 20 48 35 30 31 32 30 0a 49 66 20 74  .HLR H50120.If t
11b0: 68 65 20 69 6e 74 65 72 66 61 63 65 20 72 65 71  he interface req
11c0: 75 69 72 65 64 20 62 79 20 48 35 30 31 31 39 20  uired by H50119 
11d0: 69 73 20 75 73 65 64 20 74 6f 20 73 65 61 72 63  is used to searc
11e0: 68 20 66 6f 72 20 61 20 6b 65 79 20 76 61 6c 75  h for a key valu
11f0: 65 20 74 68 61 74 20 69 73 0a 6e 6f 74 20 70 72  e that is.not pr
1200: 65 73 65 6e 74 20 69 6e 20 74 68 65 20 62 2d 74  esent in the b-t
1210: 72 65 65 20 73 74 72 75 63 74 75 72 65 20 61 6e  ree structure an
1220: 64 20 74 68 65 20 62 2d 74 72 65 65 20 69 73 20  d the b-tree is 
1230: 6e 6f 74 20 65 6d 70 74 79 2c 20 74 68 65 20 63  not empty, the c
1240: 75 72 73 6f 72 20 73 68 61 6c 6c 0a 62 65 20 6d  ursor shall.be m
1250: 6f 76 65 64 20 74 6f 20 61 6e 20 65 78 69 73 74  oved to an exist
1260: 69 6e 67 20 65 6e 74 72 79 20 74 68 61 74 20 77  ing entry that w
1270: 6f 75 6c 64 20 62 65 20 61 64 6a 61 63 65 6e 74  ould be adjacent
1280: 20 74 6f 20 61 20 68 79 70 6f 74 68 65 74 69 63   to a hypothetic
1290: 61 6c 0a 65 6e 74 72 79 20 77 69 74 68 20 74 68  al.entry with th
12a0: 65 20 73 70 65 63 69 66 69 65 64 20 6b 65 79 20  e specified key 
12b0: 76 61 6c 75 65 2e 20 0a 0a 48 4c 52 20 48 35 30  value. ..HLR H50
12c0: 31 32 31 0a 54 68 65 20 69 6e 74 65 72 66 61 63  121.The interfac
12d0: 65 20 72 65 71 75 69 72 65 64 20 62 79 20 48 35  e required by H5
12e0: 30 31 31 39 20 73 68 61 6c 6c 20 70 72 6f 76 69  0119 shall provi
12f0: 64 65 20 61 6e 20 69 6e 64 69 63 61 74 69 6f 6e  de an indication
1300: 20 74 6f 20 74 68 65 20 63 61 6c 6c 65 72 20 61   to the caller a
1310: 73 0a 74 6f 20 77 68 65 74 68 65 72 20 74 68 65  s.to whether the
1320: 20 63 75 72 73 6f 72 20 69 73 20 6c 65 66 74 20   cursor is left 
1330: 70 6f 69 6e 74 69 6e 67 20 61 74 20 61 6e 20 65  pointing at an e
1340: 6e 74 72 79 20 77 69 74 68 20 61 20 6b 65 79 20  ntry with a key 
1350: 76 61 6c 75 65 20 74 68 61 74 20 69 73 0a 73 6d  value that is.sm
1360: 61 6c 6c 65 72 2c 20 6c 61 72 67 65 72 20 6f 72  aller, larger or
1370: 20 65 71 75 61 6c 20 74 6f 20 74 68 65 20 72 65   equal to the re
1380: 71 75 65 73 74 65 64 20 76 61 6c 75 65 2c 20 6f  quested value, o
1390: 72 20 69 66 20 69 74 20 69 73 20 70 6f 69 6e 74  r if it is point
13a0: 69 6e 67 20 74 6f 20 6e 6f 0a 65 6e 74 72 79 20  ing to no.entry 
13b0: 61 74 20 61 6c 6c 20 28 62 65 63 61 75 73 65 20  at all (because 
13c0: 74 68 65 20 62 2d 74 72 65 65 20 73 74 72 75 63  the b-tree struc
13d0: 74 75 72 65 20 69 73 20 65 6d 70 74 79 29 2e 0a  ture is empty)..
13e0: 0a 0a 48 4c 52 20 48 35 30 31 32 32 0a 54 68 65  ..HLR H50122.The
13f0: 20 42 2d 54 72 65 65 20 6d 6f 64 75 6c 65 20 73   B-Tree module s
1400: 68 61 6c 6c 20 70 72 6f 76 69 64 65 20 61 6e 20  hall provide an 
1410: 69 6e 74 65 72 66 61 63 65 20 74 6f 20 77 72 69  interface to wri
1420: 74 65 20 61 20 76 61 6c 75 65 20 74 6f 20 61 6e  te a value to an
1430: 79 20 6f 66 20 74 68 65 0a 34 2d 62 79 74 65 20  y of the.4-byte 
1440: 75 6e 73 69 67 6e 65 64 20 62 69 67 2d 65 6e 64  unsigned big-end
1450: 69 61 6e 20 69 6e 74 65 67 65 72 20 66 69 65 6c  ian integer fiel
1460: 64 73 20 62 65 67 69 6e 6e 69 6e 67 20 61 74 20  ds beginning at 
1470: 62 79 74 65 20 6f 66 66 73 65 74 20 33 36 20 6f  byte offset 36 o
1480: 66 20 74 68 65 0a 64 61 74 61 62 61 73 65 20 69  f the.database i
1490: 6d 61 67 65 2e 0a 0a 48 4c 52 20 48 35 30 31 32  mage...HLR H5012
14a0: 33 0a 54 68 65 20 42 2d 54 72 65 65 20 6d 6f 64  3.The B-Tree mod
14b0: 75 6c 65 20 73 68 61 6c 6c 20 70 72 6f 76 69 64  ule shall provid
14c0: 65 20 61 6e 20 69 6e 74 65 72 66 61 63 65 20 74  e an interface t
14d0: 6f 20 63 72 65 61 74 65 20 61 20 6e 65 77 20 69  o create a new i
14e0: 6e 64 65 78 20 6f 72 20 74 61 62 6c 65 0a 62 2d  ndex or table.b-
14f0: 74 72 65 65 20 73 74 72 75 63 74 75 72 65 73 20  tree structures 
1500: 77 69 74 68 69 6e 20 74 68 65 20 64 61 74 61 62  within the datab
1510: 61 73 65 20 69 6d 61 67 65 2e 20 54 68 65 20 69  ase image. The i
1520: 6e 74 65 72 66 61 63 65 20 73 68 61 6c 6c 20 61  nterface shall a
1530: 75 74 6f 6d 61 74 69 63 61 6c 6c 79 0a 61 73 73  utomatically.ass
1540: 69 67 6e 20 61 20 72 6f 6f 74 2d 70 61 67 65 20  ign a root-page 
1550: 74 6f 20 74 68 65 20 6e 65 77 20 62 2d 74 72 65  to the new b-tre
1560: 65 20 73 74 72 75 63 74 75 72 65 2e 0a 0a 48 4c  e structure...HL
1570: 52 20 48 35 30 31 32 34 0a 54 68 65 20 42 2d 54  R H50124.The B-T
1580: 72 65 65 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c  ree module shall
1590: 20 70 72 6f 76 69 64 65 20 61 6e 20 69 6e 74 65   provide an inte
15a0: 72 66 61 63 65 20 74 6f 20 72 65 6d 6f 76 65 20  rface to remove 
15b0: 61 6e 20 65 78 69 73 74 69 6e 67 20 69 6e 64 65  an existing inde
15c0: 78 20 6f 72 20 0a 74 61 62 6c 65 20 62 2d 74 72  x or .table b-tr
15d0: 65 65 20 73 74 72 75 63 74 75 72 65 20 66 72 6f  ee structure fro
15e0: 6d 20 74 68 65 20 64 61 74 61 62 61 73 65 20 69  m the database i
15f0: 6d 61 67 65 2c 20 67 69 76 65 6e 20 74 68 65 20  mage, given the 
1600: 72 6f 6f 74 20 70 61 67 65 20 6e 75 6d 62 65 72  root page number
1610: 20 6f 66 0a 74 68 65 20 62 2d 74 72 65 65 20 74   of.the b-tree t
1620: 6f 20 72 65 6d 6f 76 65 2e 0a 0a 48 4c 52 20 48  o remove...HLR H
1630: 35 30 31 32 35 0a 54 68 65 20 42 2d 54 72 65 65  50125.The B-Tree
1640: 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70 72   module shall pr
1650: 6f 76 69 64 65 20 61 6e 20 69 6e 74 65 72 66 61  ovide an interfa
1660: 63 65 20 74 6f 20 72 65 6d 6f 76 65 20 61 6c 6c  ce to remove all
1670: 20 65 6e 74 72 69 65 73 20 66 72 6f 6d 20 28 64   entries from (d
1680: 65 6c 65 74 65 0a 74 68 65 20 63 6f 6e 74 65 6e  elete.the conten
1690: 74 73 20 6f 66 29 20 61 6e 20 69 6e 64 65 78 20  ts of) an index 
16a0: 6f 72 20 74 61 62 6c 65 20 62 2d 74 72 65 65 2c  or table b-tree,
16b0: 20 67 69 76 65 6e 20 74 68 65 20 72 6f 6f 74 20   given the root 
16c0: 70 61 67 65 20 6e 75 6d 62 65 72 20 6f 66 20 74  page number of t
16d0: 68 65 0a 62 2d 74 72 65 65 20 74 6f 20 65 6d 70  he.b-tree to emp
16e0: 74 79 2e 0a 0a 48 4c 52 20 48 35 30 31 32 36 0a  ty...HLR H50126.
16f0: 57 68 65 6e 20 6f 70 65 6e 69 6e 67 20 61 20 42  When opening a B
1700: 2d 54 72 65 65 20 63 75 72 73 6f 72 20 75 73 69  -Tree cursor usi
1710: 6e 67 20 74 68 65 20 69 6e 74 65 72 66 61 63 65  ng the interface
1720: 20 72 65 71 75 69 72 65 64 20 62 79 20 48 35 30   required by H50
1730: 31 31 30 2c 20 69 74 20 73 68 61 6c 6c 0a 62 65  110, it shall.be
1740: 20 70 6f 73 73 69 62 6c 65 20 74 6f 20 73 70 65   possible to spe
1750: 63 69 66 79 20 74 68 61 74 20 74 68 65 20 6e 65  cify that the ne
1760: 77 20 63 75 72 73 6f 72 20 62 65 20 61 20 77 72  w cursor be a wr
1770: 69 74 65 20 63 75 72 73 6f 72 2c 20 6f 72 20 61  ite cursor, or a
1780: 6e 20 6f 72 64 69 6e 61 72 79 0a 72 65 61 64 2d  n ordinary.read-
1790: 6f 6e 6c 79 20 63 75 72 73 6f 72 2e 0a 0a 48 4c  only cursor...HL
17a0: 52 20 48 35 30 31 32 37 0a 54 68 65 20 42 2d 54  R H50127.The B-T
17b0: 72 65 65 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c  ree module shall
17c0: 20 70 72 6f 76 69 64 65 20 61 6e 20 69 6e 74 65   provide an inte
17d0: 72 66 61 63 65 20 74 68 61 74 20 61 6c 6c 6f 77  rface that allow
17e0: 73 20 74 68 65 20 75 73 65 72 20 74 6f 20 64 65  s the user to de
17f0: 6c 65 74 65 20 74 68 65 0a 62 2d 74 72 65 65 20  lete the.b-tree 
1800: 65 6e 74 72 79 20 74 68 61 74 20 61 20 77 72 69  entry that a wri
1810: 74 65 20 63 75 72 73 6f 72 20 70 6f 69 6e 74 73  te cursor points
1820: 20 74 6f 2c 20 69 66 20 61 6e 79 2e 0a 0a 48 4c   to, if any...HL
1830: 52 20 48 35 30 31 32 38 0a 54 68 65 20 42 2d 54  R H50128.The B-T
1840: 72 65 65 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c  ree module shall
1850: 20 70 72 6f 76 69 64 65 20 61 6e 20 69 6e 74 65   provide an inte
1860: 72 66 61 63 65 20 74 6f 20 69 6e 73 65 72 74 20  rface to insert 
1870: 6e 65 77 20 65 6e 74 72 69 65 73 20 69 6e 74 6f  new entries into
1880: 20 61 20 74 61 62 6c 65 0a 6f 72 20 69 6e 64 65   a table.or inde
1890: 78 20 42 2d 54 72 65 65 2c 20 67 69 76 65 6e 20  x B-Tree, given 
18a0: 61 20 77 72 69 74 65 20 63 75 72 73 6f 72 20 6f  a write cursor o
18b0: 70 65 6e 20 6f 6e 20 74 68 65 20 74 61 62 6c 65  pen on the table
18c0: 20 6f 72 20 69 6e 64 65 78 20 62 2d 74 72 65 65   or index b-tree
18d0: 20 74 68 65 20 6e 65 77 0a 65 6e 74 72 79 20 69   the new.entry i
18e0: 73 20 74 6f 20 62 65 20 69 6e 73 65 72 74 65 64  s to be inserted
18f0: 20 69 6e 74 6f 2e 0a 0a 0a 48 4c 52 20 48 35 30   into....HLR H50
1900: 31 32 39 0a 54 68 65 20 42 2d 54 72 65 65 20 6d  129.The B-Tree m
1910: 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70 72 6f 76  odule shall prov
1920: 69 64 65 20 61 6e 20 69 6e 74 65 72 66 61 63 65  ide an interface
1930: 20 61 6c 6c 6f 77 69 6e 67 20 74 68 65 20 61 70   allowing the ap
1940: 70 6c 69 63 61 74 69 6f 6e 20 74 6f 20 71 75 65  plication to que
1950: 72 79 0a 61 20 62 2d 74 72 65 65 20 64 61 74 61  ry.a b-tree data
1960: 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20  base connection 
1970: 6f 70 65 6e 20 6f 6e 20 61 20 70 65 72 73 69 73  open on a persis
1980: 74 65 6e 74 20 64 61 74 61 62 61 73 65 20 66 6f  tent database fo
1990: 72 20 74 68 65 20 6e 61 6d 65 20 6f 66 20 74 68  r the name of th
19a0: 65 0a 75 6e 64 65 72 6c 79 69 6e 67 20 64 61 74  e.underlying dat
19b0: 61 62 61 73 65 20 66 69 6c 65 20 77 69 74 68 69  abase file withi
19c0: 6e 20 74 68 65 20 66 69 6c 65 2d 73 79 73 74 65  n the file-syste
19d0: 6d 2e 0a 0a 48 4c 52 20 48 35 30 31 33 30 0a 54  m...HLR H50130.T
19e0: 68 65 20 42 2d 54 72 65 65 20 6d 6f 64 75 6c 65  he B-Tree module
19f0: 20 73 68 61 6c 6c 20 70 72 6f 76 69 64 65 20 61   shall provide a
1a00: 6e 20 69 6e 74 65 72 66 61 63 65 20 61 6c 6c 6f  n interface allo
1a10: 77 69 6e 67 20 74 68 65 20 61 70 70 6c 69 63 61  wing the applica
1a20: 74 69 6f 6e 20 74 6f 20 71 75 65 72 79 0a 61 20  tion to query.a 
1a30: 62 2d 74 72 65 65 20 64 61 74 61 62 61 73 65 20  b-tree database 
1a40: 63 6f 6e 6e 65 63 74 69 6f 6e 20 6f 70 65 6e 20  connection open 
1a50: 6f 6e 20 61 20 70 65 72 73 69 73 74 65 6e 74 20  on a persistent 
1a60: 64 61 74 61 62 61 73 65 20 66 6f 72 20 74 68 65  database for the
1a70: 20 6e 61 6d 65 20 6f 66 20 74 68 65 0a 75 6e 64   name of the.und
1a80: 65 72 6c 79 69 6e 67 20 6a 6f 75 72 6e 61 6c 20  erlying journal 
1a90: 66 69 6c 65 20 77 69 74 68 69 6e 20 74 68 65 20  file within the 
1aa0: 66 69 6c 65 2d 73 79 73 74 65 6d 2e 0a 0a 48 4c  file-system...HL
1ab0: 52 20 48 35 30 31 33 31 0a 54 68 65 20 42 2d 54  R H50131.The B-T
1ac0: 72 65 65 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c  ree module shall
1ad0: 20 70 72 6f 76 69 64 65 20 61 6e 20 69 6e 74 65   provide an inte
1ae0: 72 66 61 63 65 20 74 6f 20 71 75 65 72 79 20 61  rface to query a
1af0: 6e 20 6f 70 65 6e 20 62 2d 74 72 65 65 20 64 61  n open b-tree da
1b00: 74 61 62 61 73 65 0a 68 61 6e 64 6c 65 20 74 6f  tabase.handle to
1b10: 20 64 65 74 65 72 6d 69 6e 65 20 69 66 20 74 68   determine if th
1b20: 65 20 75 6e 64 65 72 6c 79 69 6e 67 20 64 61 74  e underlying dat
1b30: 61 62 61 73 65 20 69 73 20 61 20 70 65 72 73 69  abase is a persi
1b40: 73 74 65 6e 74 20 64 61 74 61 62 61 73 65 20 6f  stent database o
1b50: 72 20 61 0a 74 65 6d 70 6f 72 61 72 79 20 64 61  r a.temporary da
1b60: 74 61 62 61 73 65 2e 0a 0a 0a 48 4c 52 20 48 35  tabase....HLR H5
1b70: 30 31 33 32 0a 54 68 65 20 42 2d 54 72 65 65 20  0132.The B-Tree 
1b80: 6d 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70 72 6f  module shall pro
1b90: 76 69 64 65 20 61 6e 20 69 6e 74 65 72 66 61 63  vide an interfac
1ba0: 65 20 74 6f 20 71 75 65 72 79 20 74 68 65 20 63  e to query the c
1bb0: 75 72 72 65 6e 74 20 6c 6f 63 6b 69 6e 67 2d 6d  urrent locking-m
1bc0: 6f 64 65 0a 6f 66 20 61 20 70 61 67 65 2d 63 61  ode.of a page-ca
1bd0: 63 68 65 2c 20 67 69 76 65 6e 20 61 6e 20 6f 70  che, given an op
1be0: 65 6e 20 62 2d 74 72 65 65 20 64 61 74 61 62 61  en b-tree databa
1bf0: 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 6f  se connection to
1c00: 20 74 68 61 74 20 70 61 67 65 2d 63 61 63 68 65   that page-cache
1c10: 2e 0a 0a 48 4c 52 20 48 35 30 31 33 33 0a 54 68  ...HLR H50133.Th
1c20: 65 20 42 2d 54 72 65 65 20 6d 6f 64 75 6c 65 20  e B-Tree module 
1c30: 73 68 61 6c 6c 20 70 72 6f 76 69 64 65 20 61 6e  shall provide an
1c40: 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20 71 75   interface to qu
1c50: 65 72 79 20 74 68 65 20 63 75 72 72 65 6e 74 20  ery the current 
1c60: 6a 6f 75 72 6e 61 6c 2d 6d 6f 64 65 0a 6f 66 20  journal-mode.of 
1c70: 61 20 70 61 67 65 2d 63 61 63 68 65 2c 20 67 69  a page-cache, gi
1c80: 76 65 6e 20 61 6e 20 6f 70 65 6e 20 62 2d 74 72  ven an open b-tr
1c90: 65 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  ee database conn
1ca0: 65 63 74 69 6f 6e 20 74 6f 20 74 68 61 74 20 70  ection to that p
1cb0: 61 67 65 2d 63 61 63 68 65 2e 0a 0a 48 4c 52 20  age-cache...HLR 
1cc0: 48 35 30 31 33 34 0a 54 68 65 20 42 2d 54 72 65  H50134.The B-Tre
1cd0: 65 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70  e module shall p
1ce0: 72 6f 76 69 64 65 20 61 6e 20 69 6e 74 65 72 66  rovide an interf
1cf0: 61 63 65 20 74 6f 20 71 75 65 72 79 20 74 68 65  ace to query the
1d00: 20 63 75 72 72 65 6e 74 20 6a 6f 75 72 6e 61 6c   current journal
1d10: 20 66 69 6c 65 0a 73 69 7a 65 2d 6c 69 6d 69 74   file.size-limit
1d20: 20 6f 66 20 61 20 70 61 67 65 2d 63 61 63 68 65   of a page-cache
1d30: 2c 20 67 69 76 65 6e 20 61 6e 20 6f 70 65 6e 20  , given an open 
1d40: 62 2d 74 72 65 65 20 64 61 74 61 62 61 73 65 20  b-tree database 
1d50: 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 6f 20 74 68  connection to th
1d60: 61 74 0a 70 61 67 65 2d 63 61 63 68 65 2e 0a 0a  at.page-cache...
1d70: 48 4c 52 20 48 35 30 31 33 35 0a 54 68 65 20 42  HLR H50135.The B
1d80: 2d 54 72 65 65 20 6d 6f 64 75 6c 65 20 73 68 61  -Tree module sha
1d90: 6c 6c 20 70 72 6f 76 69 64 65 20 61 6e 20 69 6e  ll provide an in
1da0: 74 65 72 66 61 63 65 20 74 6f 20 71 75 65 72 79  terface to query
1db0: 20 74 68 65 20 63 75 72 72 65 6e 74 20 64 61 74   the current dat
1dc0: 61 62 61 73 65 20 66 69 6c 65 0a 73 69 7a 65 2d  abase file.size-
1dd0: 6c 69 6d 69 74 20 6f 66 20 61 20 70 61 67 65 2d  limit of a page-
1de0: 63 61 63 68 65 2c 20 67 69 76 65 6e 20 61 6e 20  cache, given an 
1df0: 6f 70 65 6e 20 62 2d 74 72 65 65 20 64 61 74 61  open b-tree data
1e00: 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20  base connection 
1e10: 74 6f 20 74 68 61 74 0a 70 61 67 65 2d 63 61 63  to that.page-cac
1e20: 68 65 2e 0a 0a 48 4c 52 20 48 35 30 31 33 36 0a  he...HLR H50136.
1e30: 54 68 65 20 42 2d 54 72 65 65 20 6d 6f 64 75 6c  The B-Tree modul
1e40: 65 20 73 68 61 6c 6c 20 70 72 6f 76 69 64 65 20  e shall provide 
1e50: 61 6e 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20  an interface to 
1e60: 71 75 65 72 79 20 74 68 65 20 63 75 72 72 65 6e  query the curren
1e70: 74 20 63 61 63 68 65 2d 73 69 7a 65 0a 6f 66 20  t cache-size.of 
1e80: 61 20 70 61 67 65 2d 63 61 63 68 65 2c 20 67 69  a page-cache, gi
1e90: 76 65 6e 20 61 6e 20 6f 70 65 6e 20 62 2d 74 72  ven an open b-tr
1ea0: 65 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  ee database conn
1eb0: 65 63 74 69 6f 6e 20 74 6f 20 74 68 61 74 20 70  ection to that p
1ec0: 61 67 65 2d 63 61 63 68 65 2e 0a 0a 48 4c 52 20  age-cache...HLR 
1ed0: 48 35 30 31 33 37 0a 54 68 65 20 42 2d 54 72 65  H50137.The B-Tre
1ee0: 65 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70  e module shall p
1ef0: 72 6f 76 69 64 65 20 61 6e 20 69 6e 74 65 72 66  rovide an interf
1f00: 61 63 65 20 74 6f 20 71 75 65 72 79 20 74 68 65  ace to query the
1f10: 20 63 75 72 72 65 6e 74 20 73 61 66 65 74 79 2d   current safety-
1f20: 6c 65 76 65 6c 0a 6f 66 20 61 20 70 61 67 65 2d  level.of a page-
1f30: 63 61 63 68 65 2c 20 67 69 76 65 6e 20 61 6e 20  cache, given an 
1f40: 6f 70 65 6e 20 62 2d 74 72 65 65 20 64 61 74 61  open b-tree data
1f50: 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20  base connection 
1f60: 74 6f 20 74 68 61 74 20 70 61 67 65 2d 63 61 63  to that page-cac
1f70: 68 65 2e 0a 0a 0a 48 4c 52 20 48 35 30 31 33 38  he....HLR H50138
1f80: 0a 54 68 65 20 42 2d 54 72 65 65 20 6d 6f 64 75  .The B-Tree modu
1f90: 6c 65 20 73 68 61 6c 6c 20 70 72 6f 76 69 64 65  le shall provide
1fa0: 20 61 6e 20 69 6e 74 65 72 66 61 63 65 20 61 6c   an interface al
1fb0: 6c 6f 77 69 6e 67 20 74 68 65 20 61 70 70 6c 69  lowing the appli
1fc0: 63 61 74 69 6f 6e 20 74 6f 20 73 65 74 0a 74 68  cation to set.th
1fd0: 65 20 6c 6f 63 6b 69 6e 67 2d 6d 6f 64 65 20 6f  e locking-mode o
1fe0: 66 20 61 20 70 61 67 65 2d 63 61 63 68 65 20 74  f a page-cache t
1ff0: 6f 20 65 69 74 68 65 72 20 22 6e 6f 72 6d 61 6c  o either "normal
2000: 22 20 6f 72 20 22 65 78 63 6c 75 73 69 76 65 22  " or "exclusive"
2010: 2c 20 67 69 76 65 6e 20 61 6e 0a 6f 70 65 6e 20  , given an.open 
2020: 62 2d 74 72 65 65 20 64 61 74 61 62 61 73 65 20  b-tree database 
2030: 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 6f 20 74 68  connection to th
2040: 61 74 20 70 61 67 65 2d 63 61 63 68 65 2e 0a 0a  at page-cache...
2050: 48 4c 52 20 48 35 30 31 33 39 0a 49 66 20 74 68  HLR H50139.If th
2060: 65 20 6c 6f 63 6b 69 6e 67 2d 6d 6f 64 65 20 6f  e locking-mode o
2070: 66 20 61 20 70 61 67 65 2d 63 61 63 68 65 20 69  f a page-cache i
2080: 73 20 73 65 74 20 74 6f 20 22 6e 6f 72 6d 61 6c  s set to "normal
2090: 22 20 77 68 65 6e 20 61 20 72 65 61 64 2f 77 72  " when a read/wr
20a0: 69 74 65 20 0a 6f 72 20 72 65 61 64 2d 6f 6e 6c  ite .or read-onl
20b0: 79 20 74 72 61 6e 73 61 63 74 69 6f 6e 20 69 73  y transaction is
20c0: 20 65 6e 64 65 64 2c 20 61 6e 79 20 6c 6f 63 6b   ended, any lock
20d0: 73 20 68 65 6c 64 20 6f 6e 20 74 68 65 20 64 61  s held on the da
20e0: 74 61 62 61 73 65 20 66 69 6c 65 2d 73 79 73 74  tabase file-syst
20f0: 65 6d 0a 72 65 70 72 65 73 65 6e 74 61 74 69 6f  em.representatio
2100: 6e 20 62 79 20 74 68 65 20 70 61 67 65 2d 63 61  n by the page-ca
2110: 63 68 65 20 73 68 61 6c 6c 20 62 65 20 72 65 6c  che shall be rel
2120: 69 6e 71 75 69 73 68 65 64 2e 0a 0a 48 4c 52 20  inquished...HLR 
2130: 48 35 30 31 34 30 0a 49 66 20 74 68 65 20 6c 6f  H50140.If the lo
2140: 63 6b 69 6e 67 2d 6d 6f 64 65 20 6f 66 20 61 20  cking-mode of a 
2150: 70 61 67 65 2d 63 61 63 68 65 20 69 73 20 73 65  page-cache is se
2160: 74 20 74 6f 20 22 65 78 63 6c 75 73 69 76 65 22  t to "exclusive"
2170: 20 77 68 65 6e 20 61 20 72 65 61 64 2f 77 72 69   when a read/wri
2180: 74 65 20 0a 6f 72 20 72 65 61 64 2d 6f 6e 6c 79  te .or read-only
2190: 20 74 72 61 6e 73 61 63 74 69 6f 6e 20 69 73 20   transaction is 
21a0: 65 6e 64 65 64 2c 20 61 6e 79 20 6c 6f 63 6b 73  ended, any locks
21b0: 20 68 65 6c 64 20 6f 6e 20 74 68 65 20 64 61 74   held on the dat
21c0: 61 62 61 73 65 20 66 69 6c 65 2d 73 79 73 74 65  abase file-syste
21d0: 6d 0a 72 65 70 72 65 73 65 6e 74 61 74 69 6f 6e  m.representation
21e0: 20 62 79 20 74 68 65 20 70 61 67 65 2d 63 61 63   by the page-cac
21f0: 68 65 20 73 68 61 6c 6c 20 62 65 20 72 65 74 61  he shall be reta
2200: 69 6e 65 64 2e 0a 0a 0a 48 4c 52 20 48 35 30 31  ined....HLR H501
2210: 34 31 0a 54 68 65 20 42 2d 54 72 65 65 20 6d 6f  41.The B-Tree mo
2220: 64 75 6c 65 20 73 68 61 6c 6c 20 70 72 6f 76 69  dule shall provi
2230: 64 65 20 61 6e 20 69 6e 74 65 72 66 61 63 65 20  de an interface 
2240: 61 6c 6c 6f 77 69 6e 67 20 74 68 65 20 61 70 70  allowing the app
2250: 6c 69 63 61 74 69 6f 6e 20 74 6f 20 73 65 74 0a  lication to set.
2260: 74 68 65 20 6a 6f 75 72 6e 61 6c 2d 6d 6f 64 65  the journal-mode
2270: 20 6f 66 20 61 20 70 61 67 65 2d 63 61 63 68 65   of a page-cache
2280: 20 74 6f 20 6f 6e 65 20 6f 66 20 22 6f 66 66 22   to one of "off"
2290: 2c 20 22 6d 65 6d 6f 72 79 22 2c 20 22 64 65 6c  , "memory", "del
22a0: 65 74 65 22 2c 0a 22 70 65 72 73 69 73 74 22 2c  ete",."persist",
22b0: 20 6f 72 20 22 74 72 75 6e 63 61 74 65 22 2c 20   or "truncate", 
22c0: 67 69 76 65 6e 20 61 6e 20 6f 70 65 6e 20 62 2d  given an open b-
22d0: 74 72 65 65 20 64 61 74 61 62 61 73 65 20 63 6f  tree database co
22e0: 6e 6e 65 63 74 69 6f 6e 20 74 6f 20 74 68 61 74  nnection to that
22f0: 0a 70 61 67 65 2d 63 61 63 68 65 2e 0a 0a 48 4c  .page-cache...HL
2300: 52 20 48 35 30 31 34 32 0a 49 66 20 74 68 65 20  R H50142.If the 
2310: 6a 6f 75 72 6e 61 6c 2d 6d 6f 64 65 20 6f 66 20  journal-mode of 
2320: 61 20 70 61 67 65 2d 63 61 63 68 65 20 69 73 20  a page-cache is 
2330: 73 65 74 20 74 6f 20 22 6f 66 66 22 20 77 68 65  set to "off" whe
2340: 6e 20 61 20 72 65 61 64 2f 77 72 69 74 65 0a 74  n a read/write.t
2350: 72 61 6e 73 61 63 74 69 6f 6e 20 69 73 20 6f 70  ransaction is op
2360: 65 6e 65 64 2c 20 74 68 65 6e 20 74 68 65 20 74  ened, then the t
2370: 72 61 6e 73 61 63 74 69 6f 6e 20 73 68 61 6c 6c  ransaction shall
2380: 20 75 73 65 20 6e 6f 20 6a 6f 75 72 6e 61 6c 20   use no journal 
2390: 66 69 6c 65 2e 0a 0a 48 4c 52 20 48 35 30 31 34  file...HLR H5014
23a0: 33 0a 49 66 20 74 68 65 20 6a 6f 75 72 6e 61 6c  3.If the journal
23b0: 2d 6d 6f 64 65 20 6f 66 20 61 20 70 61 67 65 2d  -mode of a page-
23c0: 63 61 63 68 65 20 69 73 20 73 65 74 20 74 6f 20  cache is set to 
23d0: 22 6d 65 6d 6f 72 79 22 20 77 68 65 6e 20 61 20  "memory" when a 
23e0: 72 65 61 64 2f 77 72 69 74 65 0a 74 72 61 6e 73  read/write.trans
23f0: 61 63 74 69 6f 6e 20 69 73 20 6f 70 65 6e 65 64  action is opened
2400: 2c 20 74 68 65 6e 20 69 6e 73 74 65 61 64 20 6f  , then instead o
2410: 66 20 75 73 69 6e 67 20 74 68 65 20 6a 6f 75 72  f using the jour
2420: 6e 61 6c 20 66 69 6c 65 20 6c 6f 63 61 74 65 64  nal file located
2430: 20 69 6e 20 74 68 65 0a 66 69 6c 65 2d 73 79 73   in the.file-sys
2440: 74 65 6d 2c 20 6a 6f 75 72 6e 61 6c 2d 66 69 6c  tem, journal-fil
2450: 65 20 64 61 74 61 20 73 68 61 6c 6c 20 62 65 20  e data shall be 
2460: 73 74 6f 72 65 64 20 69 6e 20 6d 61 69 6e 2d 6d  stored in main-m
2470: 65 6d 6f 72 79 2e 0a 0a 48 4c 52 20 48 35 30 31  emory...HLR H501
2480: 34 34 0a 49 66 20 74 68 65 20 6a 6f 75 72 6e 61  44.If the journa
2490: 6c 2d 6d 6f 64 65 20 6f 66 20 61 20 70 61 67 65  l-mode of a page
24a0: 2d 63 61 63 68 65 20 69 73 20 73 65 74 20 74 6f  -cache is set to
24b0: 20 22 64 65 6c 65 74 65 22 20 77 68 65 6e 20 61   "delete" when a
24c0: 20 72 65 61 64 2f 77 72 69 74 65 0a 74 72 61 6e   read/write.tran
24d0: 73 61 63 74 69 6f 6e 20 69 73 20 6f 70 65 6e 65  saction is opene
24e0: 64 2c 20 74 68 65 6e 20 61 6e 79 20 6a 6f 75 72  d, then any jour
24f0: 6e 61 6c 20 66 69 6c 65 20 75 73 65 64 20 62 79  nal file used by
2500: 20 74 68 65 20 74 72 61 6e 73 61 63 74 69 6f 6e   the transaction
2510: 20 73 68 61 6c 6c 0a 62 65 20 64 65 6c 65 74 65   shall.be delete
2520: 64 20 61 74 20 74 68 65 20 63 6f 6e 63 6c 75 73  d at the conclus
2530: 69 6f 6e 20 6f 66 20 74 68 65 20 74 72 61 6e 73  ion of the trans
2540: 61 63 74 69 6f 6e 2e 0a 0a 48 4c 52 20 48 35 30  action...HLR H50
2550: 31 34 35 0a 49 66 20 74 68 65 20 6a 6f 75 72 6e  145.If the journ
2560: 61 6c 2d 6d 6f 64 65 20 6f 66 20 61 20 70 61 67  al-mode of a pag
2570: 65 2d 63 61 63 68 65 20 69 73 20 73 65 74 20 74  e-cache is set t
2580: 6f 20 22 74 72 75 6e 63 61 74 65 22 20 77 68 65  o "truncate" whe
2590: 6e 20 61 20 72 65 61 64 2f 77 72 69 74 65 0a 74  n a read/write.t
25a0: 72 61 6e 73 61 63 74 69 6f 6e 20 69 73 20 6f 70  ransaction is op
25b0: 65 6e 65 64 2c 20 74 68 65 6e 20 61 6e 79 20 6a  ened, then any j
25c0: 6f 75 72 6e 61 6c 20 66 69 6c 65 20 75 73 65 64  ournal file used
25d0: 20 62 79 20 74 68 65 20 74 72 61 6e 73 61 63 74   by the transact
25e0: 69 6f 6e 20 73 68 61 6c 6c 0a 62 65 20 74 72 75  ion shall.be tru
25f0: 6e 63 61 74 65 64 20 74 6f 20 7a 65 72 6f 20 62  ncated to zero b
2600: 79 74 65 73 20 69 6e 20 73 69 7a 65 20 61 74 20  ytes in size at 
2610: 74 68 65 20 63 6f 6e 63 6c 75 73 69 6f 6e 20 6f  the conclusion o
2620: 66 20 74 68 65 20 74 72 61 6e 73 61 63 74 69 6f  f the transactio
2630: 6e 2e 0a 0a 48 4c 52 20 48 35 30 31 34 36 0a 49  n...HLR H50146.I
2640: 66 20 74 68 65 20 6a 6f 75 72 6e 61 6c 2d 6d 6f  f the journal-mo
2650: 64 65 20 6f 66 20 61 20 70 61 67 65 2d 63 61 63  de of a page-cac
2660: 68 65 20 69 73 20 73 65 74 20 74 6f 20 22 70 65  he is set to "pe
2670: 72 73 69 73 74 22 20 77 68 65 6e 20 61 20 72 65  rsist" when a re
2680: 61 64 2f 77 72 69 74 65 0a 74 72 61 6e 73 61 63  ad/write.transac
2690: 74 69 6f 6e 20 69 73 20 6f 70 65 6e 65 64 2c 20  tion is opened, 
26a0: 74 68 65 6e 20 61 6e 79 20 6a 6f 75 72 6e 61 6c  then any journal
26b0: 20 66 69 6c 65 20 75 73 65 64 20 62 79 20 74 68   file used by th
26c0: 65 20 74 72 61 6e 73 61 63 74 69 6f 6e 20 73 68  e transaction sh
26d0: 61 6c 6c 0a 72 65 6d 61 69 6e 20 69 6e 20 74 68  all.remain in th
26e0: 65 20 66 69 6c 65 2d 73 79 73 74 65 6d 20 61 74  e file-system at
26f0: 20 74 68 65 20 63 6f 6e 63 6c 75 73 69 6f 6e 20   the conclusion 
2700: 6f 66 20 74 68 65 20 74 72 61 6e 73 61 63 74 69  of the transacti
2710: 6f 6e 2e 0a 0a 0a 48 4c 52 20 48 35 30 31 34 37  on....HLR H50147
2720: 0a 54 68 65 20 42 2d 54 72 65 65 20 6d 6f 64 75  .The B-Tree modu
2730: 6c 65 20 73 68 61 6c 6c 20 70 72 6f 76 69 64 65  le shall provide
2740: 20 61 6e 20 69 6e 74 65 72 66 61 63 65 20 74 6f   an interface to
2750: 20 73 65 74 20 74 68 65 20 76 61 6c 75 65 20 6f   set the value o
2760: 66 20 74 68 65 0a 6a 6f 75 72 6e 61 6c 2d 66 69  f the.journal-fi
2770: 6c 65 20 73 69 7a 65 20 6c 69 6d 69 74 20 63 6f  le size limit co
2780: 6e 66 69 67 75 72 61 74 69 6f 6e 20 70 61 72 61  nfiguration para
2790: 6d 65 74 65 72 20 6f 66 20 61 20 70 61 67 65 2d  meter of a page-
27a0: 63 61 63 68 65 2c 20 67 69 76 65 6e 0a 61 6e 20  cache, given.an 
27b0: 6f 70 65 6e 20 62 2d 74 72 65 65 20 64 61 74 61  open b-tree data
27c0: 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20  base connection 
27d0: 74 6f 20 74 68 61 74 20 70 61 67 65 2d 63 61 63  to that page-cac
27e0: 68 65 2e 0a 0a 48 4c 52 20 48 35 30 31 34 38 0a  he...HLR H50148.
27f0: 54 68 65 20 64 65 66 61 75 6c 74 20 76 61 6c 75  The default valu
2800: 65 20 61 73 73 69 67 6e 65 64 20 74 6f 20 74 68  e assigned to th
2810: 65 20 6a 6f 75 72 6e 61 6c 2d 66 69 6c 65 20 73  e journal-file s
2820: 69 7a 65 20 6c 69 6d 69 74 20 63 6f 6e 66 69 67  ize limit config
2830: 75 72 61 74 69 6f 6e 20 6f 66 20 61 0a 70 61 67  uration of a.pag
2840: 65 2d 63 61 63 68 65 20 73 68 61 6c 6c 20 62 65  e-cache shall be
2850: 20 2d 31 2e 0a 0a 48 4c 52 20 48 35 30 31 34 39   -1...HLR H50149
2860: 0a 49 66 20 74 68 65 20 6a 6f 75 72 6e 61 6c 2d  .If the journal-
2870: 66 69 6c 65 20 73 69 7a 65 20 6c 69 6d 69 74 20  file size limit 
2880: 70 61 72 61 6d 65 74 65 72 20 69 73 20 73 65 74  parameter is set
2890: 20 74 6f 20 61 20 6e 6f 6e 2d 6e 65 67 61 74 69   to a non-negati
28a0: 76 65 20 76 61 6c 75 65 2c 20 61 6e 64 0a 74 68  ve value, and.th
28b0: 65 20 75 73 65 72 20 65 78 65 63 75 74 65 73 20  e user executes 
28c0: 61 20 77 72 69 74 65 20 6f 70 65 72 61 74 69 6f  a write operatio
28d0: 6e 20 74 68 61 74 20 77 6f 75 6c 64 20 6f 74 68  n that would oth
28e0: 65 72 77 69 73 65 20 72 65 71 75 69 72 65 20 74  erwise require t
28f0: 68 65 20 6a 6f 75 72 6e 61 6c 0a 66 69 6c 65 20  he journal.file 
2900: 74 6f 20 62 65 20 65 78 74 65 6e 64 65 64 20 74  to be extended t
2910: 6f 20 61 20 73 69 7a 65 20 67 72 65 61 74 65 72  o a size greater
2920: 20 74 68 61 6e 20 74 68 65 20 63 6f 6e 66 69 67   than the config
2930: 75 72 65 64 20 76 61 6c 75 65 20 69 6e 20 62 79  ured value in by
2940: 74 65 73 2c 20 74 68 65 6e 0a 74 68 65 20 6f 70  tes, then.the op
2950: 65 72 61 74 69 6f 6e 20 73 68 61 6c 6c 20 66 61  eration shall fa
2960: 69 6c 20 61 6e 64 20 61 6e 20 65 72 72 6f 72 20  il and an error 
2970: 62 65 20 72 65 74 75 72 6e 65 64 20 74 6f 20 74  be returned to t
2980: 68 65 20 75 73 65 72 2e 0a 0a 0a 48 4c 52 20 48  he user....HLR H
2990: 35 30 31 35 30 0a 54 68 65 20 42 2d 54 72 65 65  50150.The B-Tree
29a0: 20 6d 6f 64 75 6c 65 20 73 68 61 6c 6c 20 70 72   module shall pr
29b0: 6f 76 69 64 65 20 61 6e 20 69 6e 74 65 72 66 61  ovide an interfa
29c0: 63 65 20 74 6f 20 73 65 74 20 74 68 65 20 76 61  ce to set the va
29d0: 6c 75 65 20 6f 66 20 74 68 65 0a 64 61 74 61 62  lue of the.datab
29e0: 61 73 65 2d 69 6d 61 67 65 20 73 69 7a 65 20 6c  ase-image size l
29f0: 69 6d 69 74 20 63 6f 6e 66 69 67 75 72 61 74 69  imit configurati
2a00: 6f 6e 20 70 61 72 61 6d 65 74 65 72 20 6f 66 20  on parameter of 
2a10: 61 20 70 61 67 65 2d 63 61 63 68 65 2c 20 67 69  a page-cache, gi
2a20: 76 65 6e 0a 61 6e 20 6f 70 65 6e 20 62 2d 74 72  ven.an open b-tr
2a30: 65 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  ee database conn
2a40: 65 63 74 69 6f 6e 20 74 6f 20 74 68 61 74 20 70  ection to that p
2a50: 61 67 65 2d 63 61 63 68 65 2e 0a 0a 48 4c 52 20  age-cache...HLR 
2a60: 48 35 30 31 35 31 0a 54 68 65 20 64 65 66 61 75  H50151.The defau
2a70: 6c 74 20 76 61 6c 75 65 20 61 73 73 69 67 6e 65  lt value assigne
2a80: 64 20 74 6f 20 74 68 65 20 64 61 74 61 62 61 73  d to the databas
2a90: 65 2d 69 6d 61 67 65 20 73 69 7a 65 20 6c 69 6d  e-image size lim
2aa0: 69 74 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e  it configuration
2ab0: 20 6f 66 20 61 0a 70 61 67 65 2d 63 61 63 68 65   of a.page-cache
2ac0: 20 73 68 61 6c 6c 20 62 65 20 74 68 65 20 76 61   shall be the va
2ad0: 6c 75 65 20 6f 66 20 74 68 65 20 63 6f 6d 70 69  lue of the compi
2ae0: 6c 65 20 74 69 6d 65 20 73 79 6d 62 6f 6c 20 53  le time symbol S
2af0: 51 4c 49 54 45 5f 4d 41 58 5f 50 41 47 45 5f 43  QLITE_MAX_PAGE_C
2b00: 4f 55 4e 54 0a 28 31 30 37 33 37 34 31 38 32 33  OUNT.(1073741823
2b10: 20 62 79 20 64 65 66 61 75 6c 74 29 2e 0a 0a 48   by default)...H
2b20: 4c 52 20 48 35 30 31 35 32 0a 49 66 20 74 68 65  LR H50152.If the
2b30: 20 64 61 74 61 62 61 73 65 2d 69 6d 61 67 65 20   database-image 
2b40: 73 69 7a 65 20 6c 69 6d 69 74 20 70 61 72 61 6d  size limit param
2b50: 65 74 65 72 20 69 73 20 73 65 74 20 74 6f 20 61  eter is set to a
2b60: 20 6e 6f 6e 2d 6e 65 67 61 74 69 76 65 20 76 61   non-negative va
2b70: 6c 75 65 2c 20 61 6e 64 0a 74 68 65 20 75 73 65  lue, and.the use
2b80: 72 20 65 78 65 63 75 74 65 73 20 61 20 77 72 69  r executes a wri
2b90: 74 65 20 6f 70 65 72 61 74 69 6f 6e 20 74 68 61  te operation tha
2ba0: 74 20 77 6f 75 6c 64 20 6f 74 68 65 72 77 69 73  t would otherwis
2bb0: 65 20 72 65 71 75 69 72 65 20 74 68 65 20 6a 6f  e require the jo
2bc0: 75 72 6e 61 6c 0a 66 69 6c 65 20 74 6f 20 62 65  urnal.file to be
2bd0: 20 65 78 74 65 6e 64 65 64 20 74 6f 20 61 20 73   extended to a s
2be0: 69 7a 65 20 67 72 65 61 74 65 72 20 74 68 61 6e  ize greater than
2bf0: 20 74 68 65 20 63 6f 6e 66 69 67 75 72 65 64 20   the configured 
2c00: 76 61 6c 75 65 20 69 6e 20 62 79 74 65 73 2c 20  value in bytes, 
2c10: 74 68 65 6e 0a 74 68 65 20 6f 70 65 72 61 74 69  then.the operati
2c20: 6f 6e 20 73 68 61 6c 6c 20 66 61 69 6c 20 61 6e  on shall fail an
2c30: 64 20 61 6e 20 65 72 72 6f 72 20 62 65 20 72 65  d an error be re
2c40: 74 75 72 6e 65 64 20 74 6f 20 74 68 65 20 75 73  turned to the us
2c50: 65 72 2e 0a 0a 48 4c 52 20 48 35 30 31 35 33 0a  er...HLR H50153.
2c60: 54 68 65 20 42 2d 54 72 65 65 20 6d 6f 64 75 6c  The B-Tree modul
2c70: 65 20 73 68 61 6c 6c 20 70 72 6f 76 69 64 65 20  e shall provide 
2c80: 61 6e 20 69 6e 74 65 72 66 61 63 65 20 74 6f 20  an interface to 
2c90: 73 65 74 20 74 68 65 20 76 61 6c 75 65 20 6f 66  set the value of
2ca0: 20 74 68 65 0a 63 61 63 68 65 2d 73 69 7a 65 20   the.cache-size 
2cb0: 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 70 61  configuration pa
2cc0: 72 61 6d 65 74 65 72 20 6f 66 20 61 20 70 61 67  rameter of a pag
2cd0: 65 2d 63 61 63 68 65 2c 20 67 69 76 65 6e 20 61  e-cache, given a
2ce0: 6e 20 6f 70 65 6e 20 62 2d 74 72 65 65 0a 64 61  n open b-tree.da
2cf0: 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
2d00: 6e 20 74 6f 20 74 68 61 74 20 70 61 67 65 2d 63  n to that page-c
2d10: 61 63 68 65 2e 0a 0a 48 4c 52 20 48 35 30 31 35  ache...HLR H5015
2d20: 34 0a 54 68 65 20 42 2d 54 72 65 65 20 6d 6f 64  4.The B-Tree mod
2d30: 75 6c 65 20 73 68 61 6c 6c 20 70 72 6f 76 69 64  ule shall provid
2d40: 65 20 61 6e 20 69 6e 74 65 72 66 61 63 65 20 61  e an interface a
2d50: 6c 6c 6f 77 69 6e 67 20 74 68 65 20 61 70 70 6c  llowing the appl
2d60: 69 63 61 74 69 6f 6e 20 74 6f 20 73 65 74 0a 74  ication to set.t
2d70: 68 65 20 73 61 66 65 74 79 2d 6c 65 76 65 6c 20  he safety-level 
2d80: 6f 66 20 61 20 70 61 67 65 2d 63 61 63 68 65 20  of a page-cache 
2d90: 74 6f 20 6f 6e 65 20 6f 66 20 22 6f 66 66 22 2c  to one of "off",
2da0: 20 22 6e 6f 72 6d 61 6c 22 20 6f 72 20 22 66 75   "normal" or "fu
2db0: 6c 6c 22 2c 0a 67 69 76 65 6e 20 61 6e 20 6f 70  ll",.given an op
2dc0: 65 6e 20 62 2d 74 72 65 65 20 64 61 74 61 62 61  en b-tree databa
2dd0: 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 74 6f  se connection to
2de0: 20 74 68 61 74 20 70 61 67 65 2d 63 61 63 68 65   that page-cache
2df0: 2e 0a 0a 48 4c 52 20 48 35 30 31 35 35 0a 54 68  ...HLR H50155.Th
2e00: 65 20 64 65 66 61 75 6c 74 20 76 61 6c 75 65 20  e default value 
2e10: 61 73 73 69 67 6e 65 64 20 74 6f 20 74 68 65 20  assigned to the 
2e20: 73 61 66 65 74 79 2d 6c 65 76 65 6c 20 63 6f 6e  safety-level con
2e30: 66 69 67 75 72 61 74 69 6f 6e 20 70 61 72 61 6d  figuration param
2e40: 65 74 65 72 20 6f 66 20 61 0a 70 61 67 65 2d 63  eter of a.page-c
2e50: 61 63 68 65 20 73 68 61 6c 6c 20 62 65 20 22 66  ache shall be "f
2e60: 75 6c 6c 22 2e 0a 0a 48 4c 52 20 48 35 30 31 35  ull"...HLR H5015
2e70: 36 0a 54 68 65 20 62 2d 74 72 65 65 20 6d 6f 64  6.The b-tree mod
2e80: 75 6c 65 20 73 68 61 6c 6c 20 70 72 6f 76 69 64  ule shall provid
2e90: 65 20 61 6e 20 69 6e 74 65 72 66 61 63 65 20 61  e an interface a
2ea0: 6c 6c 6f 77 69 6e 67 20 64 61 74 61 62 61 73 65  llowing database
2eb0: 20 63 6c 69 65 6e 74 73 20 74 6f 0a 61 63 71 75   clients to.acqu
2ec0: 69 72 65 20 61 64 76 69 73 6f 72 79 20 72 65 61  ire advisory rea
2ed0: 64 20 28 73 68 61 72 65 64 29 20 6f 72 20 77 72  d (shared) or wr
2ee0: 69 74 65 20 28 65 78 63 6c 75 73 69 76 65 29 20  ite (exclusive) 
2ef0: 6c 6f 63 6b 73 20 6f 6e 20 61 20 73 70 65 63 69  locks on a speci
2f00: 66 69 63 20 62 2d 74 72 65 65 0a 73 74 72 75 63  fic b-tree.struc
2f10: 74 75 72 65 20 77 69 74 68 69 6e 20 74 68 65 20  ture within the 
2f20: 64 61 74 61 62 61 73 65 2e 0a 0a 0a 0a 48 4c 52  database.....HLR
2f30: 20 48 35 31 30 30 31 20 20 20 20 20 20 48 35 30   H51001      H50
2f40: 30 31 30 0a 49 66 20 73 75 63 63 65 73 73 66 75  010.If successfu
2f50: 6c 2c 20 61 20 63 61 6c 6c 20 74 6f 20 74 68 65  l, a call to the
2f60: 20 73 71 6c 69 74 65 33 42 74 72 65 65 4f 70 65   sqlite3BtreeOpe
2f70: 6e 20 66 75 6e 63 74 69 6f 6e 20 73 68 61 6c 6c  n function shall
2f80: 20 72 65 74 75 72 6e 20 53 51 4c 49 54 45 5f 4f   return SQLITE_O
2f90: 4b 0a 61 6e 64 20 73 65 74 20 74 68 65 20 76 61  K.and set the va
2fa0: 6c 75 65 20 6f 66 20 2a 70 70 42 74 72 65 65 20  lue of *ppBtree 
2fb0: 74 6f 20 63 6f 6e 74 61 69 6e 20 61 20 6e 65 77  to contain a new
2fc0: 20 42 2d 54 72 65 65 20 64 61 74 61 62 61 73 65   B-Tree database
2fd0: 20 63 6f 6e 6e 65 63 74 69 6f 6e 0a 68 61 6e 64   connection.hand
2fe0: 6c 65 2e 0a 0a 48 4c 52 20 48 35 31 30 30 32 0a  le...HLR H51002.
2ff0: 49 66 20 75 6e 73 75 63 63 65 73 73 66 75 6c 2c  If unsuccessful,
3000: 20 61 20 63 61 6c 6c 20 74 6f 20 74 68 65 20 73   a call to the s
3010: 71 6c 69 74 65 33 42 74 72 65 65 4f 70 65 6e 20  qlite3BtreeOpen 
3020: 66 75 6e 63 74 69 6f 6e 20 73 68 61 6c 6c 20 72  function shall r
3030: 65 74 75 72 6e 20 61 6e 20 53 51 4c 69 74 65 0a  eturn an SQLite.
3040: 65 72 72 6f 72 20 63 6f 64 65 20 6f 74 68 65 72  error code other
3050: 20 74 68 61 6e 20 53 51 4c 49 54 45 5f 4f 4b 20   than SQLITE_OK 
3060: 69 6e 64 69 63 61 74 69 6e 67 20 74 68 65 20 72  indicating the r
3070: 65 61 73 6f 6e 20 66 6f 72 20 74 68 65 20 66 61  eason for the fa
3080: 69 6c 75 72 65 2e 20 54 68 65 0a 76 61 6c 75 65  ilure. The.value
3090: 20 6f 66 20 2a 70 70 42 74 72 65 65 20 73 68 61   of *ppBtree sha
30a0: 6c 6c 20 6e 6f 74 20 62 65 20 6d 6f 64 69 66 69  ll not be modifi
30b0: 65 64 20 69 6e 20 74 68 69 73 20 63 61 73 65 2e  ed in this case.
30c0: 0a 0a 48 4c 52 20 48 35 31 30 30 33 0a 49 66 20  ..HLR H51003.If 
30d0: 74 68 65 20 7a 46 69 6c 65 6e 61 6d 65 20 70 61  the zFilename pa
30e0: 72 61 6d 65 74 65 72 20 74 6f 20 61 20 63 61 6c  rameter to a cal
30f0: 6c 20 74 6f 20 73 71 6c 69 74 65 33 42 74 72 65  l to sqlite3Btre
3100: 65 4f 70 65 6e 20 69 73 20 4e 55 4c 4c 20 6f 72  eOpen is NULL or
3110: 20 61 20 70 6f 69 6e 74 65 72 0a 74 6f 20 61 20   a pointer.to a 
3120: 62 75 66 66 65 72 20 6f 66 20 77 68 69 63 68 20  buffer of which 
3130: 74 68 65 20 66 69 72 73 74 20 62 79 74 65 20 69  the first byte i
3140: 73 20 61 20 6e 75 6c 20 28 30 78 30 30 29 2c 20  s a nul (0x00), 
3150: 74 68 65 6e 20 73 71 6c 69 74 65 33 42 74 72 65  then sqlite3Btre
3160: 65 4f 70 65 6e 0a 73 68 61 6c 6c 20 61 74 74 65  eOpen.shall atte
3170: 6d 70 74 20 74 6f 20 6f 70 65 6e 20 61 20 63 6f  mpt to open a co
3180: 6e 6e 65 63 74 69 6f 6e 20 74 6f 20 61 20 74 65  nnection to a te
3190: 6d 70 6f 72 61 72 79 20 64 61 74 61 62 61 73 65  mporary database
31a0: 2e 0a 0a 48 4c 52 20 48 35 31 30 30 34 0a 49 66  ...HLR H51004.If
31b0: 20 74 68 65 20 7a 46 69 6c 65 6e 61 6d 65 20 70   the zFilename p
31c0: 61 72 61 6d 65 74 65 72 20 74 6f 20 61 20 63 61  arameter to a ca
31d0: 6c 6c 20 74 6f 20 73 71 6c 69 74 65 33 42 74 72  ll to sqlite3Btr
31e0: 65 65 4f 70 65 6e 20 69 73 20 61 20 70 6f 69 6e  eeOpen is a poin
31f0: 74 65 72 20 74 6f 20 61 0a 62 75 66 66 65 72 20  ter to a.buffer 
3200: 63 6f 6e 74 61 69 6e 69 6e 67 20 61 20 6e 75 6c  containing a nul
3210: 2d 74 65 72 6d 69 6e 61 74 65 64 20 55 54 46 2d  -terminated UTF-
3220: 38 20 65 6e 63 6f 64 65 64 20 73 74 72 69 6e 67  8 encoded string
3230: 2c 20 73 71 6c 69 74 65 33 42 74 72 65 65 4f 70  , sqlite3BtreeOp
3240: 65 6e 20 73 68 61 6c 6c 0a 61 74 74 65 6d 70 74  en shall.attempt
3250: 20 74 6f 20 6f 70 65 6e 20 61 20 63 6f 6e 6e 65   to open a conne
3260: 63 74 69 6f 6e 20 74 6f 20 61 20 70 65 72 73 69  ction to a persi
3270: 73 74 65 6e 74 20 64 61 74 61 62 61 73 65 2e 0a  stent database..
3280: 0a 48 4c 52 20 48 35 31 30 30 35 0a 49 66 20 74  .HLR H51005.If t
3290: 68 65 20 42 54 52 45 45 5f 4f 4d 49 54 5f 4a 4f  he BTREE_OMIT_JO
32a0: 55 52 4e 41 4c 20 62 69 74 20 69 73 20 73 65 74  URNAL bit is set
32b0: 20 69 6e 20 74 68 65 20 66 6c 61 67 73 20 70 61   in the flags pa
32c0: 72 61 6d 65 74 65 72 20 70 61 73 73 65 64 20 74  rameter passed t
32d0: 6f 20 61 20 0a 73 75 63 63 65 73 73 66 75 6c 20  o a .successful 
32e0: 63 61 6c 6c 20 74 6f 20 73 71 6c 69 74 65 33 42  call to sqlite3B
32f0: 74 72 65 65 4f 70 65 6e 20 74 6f 20 6f 70 65 6e  treeOpen to open
3300: 20 61 20 74 65 6d 70 6f 72 61 72 79 20 64 61 74   a temporary dat
3310: 61 62 61 73 65 2c 20 74 68 65 6e 20 74 68 65 0a  abase, then the.
3320: 70 61 67 65 2d 63 61 63 68 65 20 63 72 65 61 74  page-cache creat
3330: 65 64 20 61 73 20 61 20 72 65 73 75 6c 74 20 73  ed as a result s
3340: 68 61 6c 6c 20 6e 6f 74 20 6f 70 65 6e 20 6f 72  hall not open or
3350: 20 75 73 65 20 61 20 6a 6f 75 72 6e 61 6c 20 66   use a journal f
3360: 69 6c 65 20 66 6f 72 20 61 6e 79 0a 70 75 72 70  ile for any.purp
3370: 6f 73 65 2e 0a 0a 48 4c 52 20 48 35 31 30 30 36  ose...HLR H51006
3380: 0a 49 66 20 74 68 65 20 42 54 52 45 45 5f 4e 4f  .If the BTREE_NO
3390: 5f 52 45 41 44 4c 4f 43 4b 20 62 69 74 20 69 73  _READLOCK bit is
33a0: 20 73 65 74 20 69 6e 20 74 68 65 20 66 6c 61 67   set in the flag
33b0: 73 20 70 61 72 61 6d 65 74 65 72 20 70 61 73 73  s parameter pass
33c0: 65 64 20 74 6f 20 61 20 0a 73 75 63 63 65 73 73  ed to a .success
33d0: 66 75 6c 20 63 61 6c 6c 20 74 6f 20 73 71 6c 69  ful call to sqli
33e0: 74 65 33 42 74 72 65 65 4f 70 65 6e 20 74 6f 20  te3BtreeOpen to 
33f0: 6f 70 65 6e 20 61 20 70 65 72 73 69 73 74 65 6e  open a persisten
3400: 74 20 64 61 74 61 62 61 73 65 20 61 6e 64 20 61  t database and a
3410: 0a 6e 65 77 20 70 61 67 65 2d 63 61 63 68 65 20  .new page-cache 
3420: 69 73 20 63 72 65 61 74 65 64 20 61 73 20 61 20  is created as a 
3430: 72 65 73 75 6c 74 20 6f 66 20 74 68 65 20 63 61  result of the ca
3440: 6c 6c 2c 20 74 68 65 6e 20 74 68 65 20 6e 65 77  ll, then the new
3450: 20 70 61 67 65 2d 63 61 63 68 65 20 0a 73 68 61   page-cache .sha
3460: 6c 6c 20 6f 6e 6c 79 20 6c 6f 63 6b 20 74 68 65  ll only lock the
3470: 20 64 61 74 61 62 61 73 65 20 66 69 6c 65 2d 73   database file-s
3480: 79 73 74 65 6d 20 72 65 70 72 65 73 65 6e 74 61  ystem representa
3490: 74 69 6f 6e 20 77 68 65 6e 20 77 72 69 74 69 6e  tion when writin
34a0: 67 20 74 6f 0a 69 74 2e 0a 0a 48 4c 52 20 48 35  g to.it...HLR H5
34b0: 31 30 30 37 0a 49 66 20 74 68 65 20 73 71 6c 69  1007.If the sqli
34c0: 74 65 33 42 74 72 65 65 4f 70 65 6e 20 66 75 6e  te3BtreeOpen fun
34d0: 63 74 69 6f 6e 20 69 73 20 63 61 6c 6c 65 64 20  ction is called 
34e0: 74 6f 20 6f 70 65 6e 20 61 20 63 6f 6e 6e 65 63  to open a connec
34f0: 74 69 6f 6e 20 74 6f 20 61 20 70 65 72 73 69 73  tion to a persis
3500: 74 65 6e 74 0a 64 61 74 61 62 61 73 65 2c 20 61  tent.database, a
3510: 6e 64 20 74 68 65 20 63 61 6c 6c 20 63 61 75 73  nd the call caus
3520: 65 73 20 61 20 6e 65 77 20 70 61 67 65 2d 63 61  es a new page-ca
3530: 63 68 65 20 74 6f 20 62 65 20 63 72 65 61 74 65  che to be create
3540: 64 2c 20 77 68 65 6e 20 6f 70 65 6e 69 6e 67 20  d, when opening 
3550: 74 68 65 0a 64 61 74 61 62 61 73 65 20 66 69 6c  the.database fil
3560: 65 20 75 73 69 6e 67 20 74 68 65 20 56 46 53 20  e using the VFS 
3570: 69 6e 74 65 72 66 61 63 65 20 78 4f 70 65 6e 20  interface xOpen 
3580: 6d 65 74 68 6f 64 20 74 68 65 20 34 74 68 20 70  method the 4th p
3590: 61 72 61 6d 65 74 65 72 20 70 61 73 73 65 64 20  arameter passed 
35a0: 74 6f 0a 78 4f 70 65 6e 20 28 66 6c 61 67 73 29  to.xOpen (flags)
35b0: 20 73 68 61 6c 6c 20 62 65 20 61 20 63 6f 70 79   shall be a copy
35c0: 20 6f 66 20 74 68 65 20 76 66 73 46 6c 61 67 73   of the vfsFlags
35d0: 20 76 61 6c 75 65 20 70 61 73 73 65 64 20 74 6f   value passed to
35e0: 20 73 71 6c 69 74 65 33 42 74 72 65 65 4f 70 65   sqlite3BtreeOpe
35f0: 6e 2e 0a 0a 48 4c 52 20 48 35 31 30 30 38 0a 49  n...HLR H51008.I
3600: 66 20 74 68 65 20 73 71 6c 69 74 65 33 42 74 72  f the sqlite3Btr
3610: 65 65 4f 70 65 6e 20 66 75 6e 63 74 69 6f 6e 20  eeOpen function 
3620: 69 73 20 63 61 6c 6c 65 64 20 74 6f 20 6f 70 65  is called to ope
3630: 6e 20 61 20 63 6f 6e 6e 65 63 74 69 6f 6e 20 74  n a connection t
3640: 6f 20 61 20 74 65 6d 70 6f 72 61 72 79 0a 64 61  o a temporary.da
3650: 74 61 62 61 73 65 2c 20 69 66 20 61 6e 64 20 77  tabase, if and w
3660: 68 65 6e 20 61 20 74 65 6d 70 6f 72 61 72 79 20  hen a temporary 
3670: 66 69 6c 65 20 69 73 20 6f 70 65 6e 65 64 20 74  file is opened t
3680: 6f 20 75 73 65 20 61 73 20 73 65 63 6f 6e 64 61  o use as seconda
3690: 72 79 20 73 74 6f 72 61 67 65 0a 75 73 69 6e 67  ry storage.using
36a0: 20 74 68 65 20 56 46 53 20 69 6e 74 65 72 66 61   the VFS interfa
36b0: 63 65 20 78 4f 70 65 6e 20 6d 65 74 68 6f 64 20  ce xOpen method 
36c0: 74 68 65 20 34 74 68 20 70 61 72 61 6d 65 74 65  the 4th paramete
36d0: 72 20 70 61 73 73 65 64 20 74 6f 20 78 4f 70 65  r passed to xOpe
36e0: 6e 20 28 66 6c 61 67 73 29 20 0a 73 68 61 6c 6c  n (flags) .shall
36f0: 20 62 65 20 61 20 63 6f 70 79 20 6f 66 20 74 68   be a copy of th
3700: 65 20 76 66 73 46 6c 61 67 73 20 76 61 6c 75 65  e vfsFlags value
3710: 20 70 61 73 73 65 64 20 74 6f 20 73 71 6c 69 74   passed to sqlit
3720: 65 33 42 74 72 65 65 4f 70 65 6e 20 77 69 74 68  e3BtreeOpen with
3730: 20 74 68 65 20 0a 53 51 4c 49 54 45 5f 4f 50 45   the .SQLITE_OPE
3740: 4e 5f 52 45 41 44 57 52 49 54 45 2c 20 53 51 4c  N_READWRITE, SQL
3750: 49 54 45 5f 4f 50 45 4e 5f 43 52 45 41 54 45 2c  ITE_OPEN_CREATE,
3760: 20 53 51 4c 49 54 45 5f 4f 50 45 4e 5f 45 58 43   SQLITE_OPEN_EXC
3770: 4c 55 53 49 56 45 20 61 6e 64 20 0a 53 51 4c 49  LUSIVE and .SQLI
3780: 54 45 5f 4f 50 45 4e 5f 44 45 4c 45 54 45 4f 4e  TE_OPEN_DELETEON
3790: 43 4c 4f 53 45 20 62 69 74 73 20 61 6c 73 6f 20  CLOSE bits also 
37a0: 73 65 74 2e 0a 0a 48 4c 52 20 48 35 31 30 30 39  set...HLR H51009
37b0: 0a 41 20 63 61 6c 6c 20 74 6f 20 74 68 65 20 73  .A call to the s
37c0: 71 6c 69 74 65 33 42 74 72 65 65 43 6c 6f 73 65  qlite3BtreeClose
37d0: 20 66 75 6e 63 74 69 6f 6e 20 77 69 74 68 20 61   function with a
37e0: 20 76 61 6c 69 64 20 62 2d 74 72 65 65 20 64 61   valid b-tree da
37f0: 74 61 62 61 73 65 0a 63 6f 6e 6e 65 63 74 69 6f  tabase.connectio
3800: 6e 20 68 61 6e 64 6c 65 20 70 61 73 73 65 64 20  n handle passed 
3810: 61 73 20 74 68 65 20 6f 6e 6c 79 20 61 72 67 75  as the only argu
3820: 6d 65 6e 74 20 73 68 61 6c 6c 20 69 6e 76 61 6c  ment shall inval
3830: 69 64 61 74 65 20 74 68 65 20 68 61 6e 64 6c 65  idate the handle
3840: 2c 0a 63 6c 6f 73 65 20 74 68 65 20 62 2d 74 72  ,.close the b-tr
3850: 65 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e  ee database conn
3860: 65 63 74 69 6f 6e 20 61 6e 64 20 72 65 6c 65 61  ection and relea
3870: 73 65 20 61 6c 6c 20 61 73 73 6f 63 69 61 74 65  se all associate
3880: 64 20 72 65 73 6f 75 72 63 65 73 2e 0a 0a 48 4c  d resources...HL
3890: 52 20 48 35 31 30 31 30 0a 49 66 20 61 20 63 61  R H51010.If a ca
38a0: 6c 6c 20 74 6f 20 73 71 6c 69 74 65 33 42 74 72  ll to sqlite3Btr
38b0: 65 65 43 6c 6f 73 65 20 69 73 20 6d 61 64 65 20  eeClose is made 
38c0: 74 6f 20 63 6c 6f 73 65 20 61 20 62 2d 74 72 65  to close a b-tre
38d0: 65 20 64 61 74 61 62 61 73 65 20 63 6f 6e 6e 65  e database conne
38e0: 63 74 69 6f 6e 0a 77 68 69 6c 65 20 74 68 65 72  ction.while ther
38f0: 65 20 65 78 69 73 74 20 6f 70 65 6e 20 42 2d 54  e exist open B-T
3900: 72 65 65 20 63 75 72 73 6f 72 73 20 74 68 61 74  ree cursors that
3910: 20 77 65 72 65 20 6f 70 65 6e 65 64 20 75 73 69   were opened usi
3920: 6e 67 20 74 68 65 20 73 70 65 63 69 66 69 65 64  ng the specified
3930: 0a 62 2d 74 72 65 65 20 64 61 74 61 62 61 73 65  .b-tree database
3940: 20 63 6f 6e 6e 65 63 74 69 6f 6e 2c 20 74 68 65   connection, the
3950: 79 20 73 68 61 6c 6c 20 62 65 20 63 6c 6f 73 65  y shall be close
3960: 64 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20  d automatically 
3970: 66 72 6f 6d 20 77 69 74 68 69 6e 0a 73 71 6c 69  from within.sqli
3980: 74 65 33 42 74 72 65 65 43 6c 6f 73 65 2c 20 6a  te3BtreeClose, j
3990: 75 73 74 20 61 73 20 69 66 20 74 68 65 69 72 20  ust as if their 
39a0: 68 61 6e 64 6c 65 73 20 77 65 72 65 20 70 61 73  handles were pas
39b0: 73 65 64 20 74 6f 0a 73 71 6c 69 74 65 33 42 74  sed to.sqlite3Bt
39c0: 72 65 65 43 6c 6f 73 65 43 75 72 73 6f 72 2e 0a  reeCloseCursor..
39d0: 0a 0a 0a 0a 0a 48 4c 52 20 48 35 31 30 31 31 0a  .....HLR H51011.
39e0: 41 20 63 61 6c 6c 20 74 6f 20 74 68 65 20 73 71  A call to the sq
39f0: 6c 69 74 65 33 42 74 72 65 65 47 65 74 46 69 6c  lite3BtreeGetFil
3a00: 65 6e 61 6d 65 20 66 75 6e 63 74 69 6f 6e 20 77  ename function w
3a10: 69 74 68 20 61 20 76 61 6c 69 64 20 42 2d 54 72  ith a valid B-Tr
3a20: 65 65 20 64 61 74 61 62 61 73 65 0a 63 6f 6e 6e  ee database.conn
3a30: 65 63 74 69 6f 6e 20 68 61 6e 64 6c 65 20 6f 70  ection handle op
3a40: 65 6e 65 64 20 6f 6e 20 61 20 70 65 72 73 69 73  ened on a persis
3a50: 74 65 6e 74 20 64 61 74 61 62 61 73 65 20 61 73  tent database as
3a60: 20 74 68 65 20 66 69 72 73 74 20 61 72 67 75 6d   the first argum
3a70: 65 6e 74 20 73 68 61 6c 6c 0a 72 65 74 75 72 6e  ent shall.return
3a80: 20 61 20 70 6f 69 6e 74 65 72 20 74 6f 20 61 20   a pointer to a 
3a90: 62 75 66 66 65 72 20 63 6f 6e 74 61 69 6e 69 6e  buffer containin
3aa0: 67 20 74 68 65 20 66 75 6c 6c 2d 70 61 74 68 20  g the full-path 
3ab0: 6f 66 20 74 68 65 20 64 61 74 61 62 61 73 65 20  of the database 
3ac0: 66 69 6c 65 0a 66 6f 72 6d 61 74 74 65 64 20 61  file.formatted a
3ad0: 73 20 61 20 6e 75 6c 2d 74 65 72 6d 69 6e 61 74  s a nul-terminat
3ae0: 65 64 2c 20 55 54 46 2d 38 20 73 74 72 69 6e 67  ed, UTF-8 string
3af0: 2e 0a 0a 48 4c 52 20 48 35 31 30 31 32 0a 41 20  ...HLR H51012.A 
3b00: 63 61 6c 6c 20 74 6f 20 74 68 65 20 73 71 6c 69  call to the sqli
3b10: 74 65 33 42 74 72 65 65 47 65 74 46 69 6c 65 6e  te3BtreeGetFilen
3b20: 61 6d 65 20 66 75 6e 63 74 69 6f 6e 20 77 69 74  ame function wit
3b30: 68 20 61 20 76 61 6c 69 64 20 42 2d 54 72 65 65  h a valid B-Tree
3b40: 20 64 61 74 61 62 61 73 65 0a 63 6f 6e 6e 65 63   database.connec
3b50: 74 69 6f 6e 20 68 61 6e 64 6c 65 20 6f 70 65 6e  tion handle open
3b60: 65 64 20 6f 6e 20 61 20 74 65 6d 70 6f 72 61 72  ed on a temporar
3b70: 79 20 64 61 74 61 62 61 73 65 20 61 73 20 74 68  y database as th
3b80: 65 20 66 69 72 73 74 20 61 72 67 75 6d 65 6e 74  e first argument
3b90: 20 73 68 61 6c 6c 0a 72 65 74 75 72 6e 20 61 20   shall.return a 
3ba0: 70 6f 69 6e 74 65 72 20 74 6f 20 61 20 62 75 66  pointer to a buf
3bb0: 66 65 72 20 74 6f 20 61 20 6e 75 6c 2d 74 65 72  fer to a nul-ter
3bc0: 6d 69 6e 61 74 65 64 20 73 74 72 69 6e 67 20 7a  minated string z
3bd0: 65 72 6f 20 62 79 74 65 73 20 69 6e 20 6c 65 6e  ero bytes in len
3be0: 67 74 68 0a 28 69 2e 65 2e 20 74 68 65 20 66 69  gth.(i.e. the fi
3bf0: 72 73 74 20 62 79 74 65 20 6f 66 20 74 68 65 20  rst byte of the 
3c00: 62 75 66 66 65 72 20 73 68 61 6c 6c 20 62 65 20  buffer shall be 
3c10: 30 78 30 30 29 2e 0a 0a 48 4c 52 20 48 35 31 30  0x00)...HLR H510
3c20: 31 33 0a 41 20 63 61 6c 6c 20 74 6f 20 74 68 65  13.A call to the
3c30: 20 73 71 6c 69 74 65 33 42 74 72 65 65 47 65 74   sqlite3BtreeGet
3c40: 4a 6f 75 72 6e 61 6c 6e 61 6d 65 20 66 75 6e 63  Journalname func
3c50: 74 69 6f 6e 20 77 69 74 68 20 61 20 76 61 6c 69  tion with a vali
3c60: 64 20 42 2d 54 72 65 65 20 64 61 74 61 62 61 73  d B-Tree databas
3c70: 65 0a 63 6f 6e 6e 65 63 74 69 6f 6e 20 68 61 6e  e.connection han
3c80: 64 6c 65 20 6f 70 65 6e 65 64 20 6f 6e 20 61 20  dle opened on a 
3c90: 70 65 72 73 69 73 74 65 6e 74 20 64 61 74 61 62  persistent datab
3ca0: 61 73 65 20 61 73 20 74 68 65 20 66 69 72 73 74  ase as the first
3cb0: 20 61 72 67 75 6d 65 6e 74 20 73 68 61 6c 6c 0a   argument shall.
3cc0: 72 65 74 75 72 6e 20 61 20 70 6f 69 6e 74 65 72  return a pointer
3cd0: 20 74 6f 20 61 20 62 75 66 66 65 72 20 63 6f 6e   to a buffer con
3ce0: 74 61 69 6e 69 6e 67 20 74 68 65 20 66 75 6c 6c  taining the full
3cf0: 2d 70 61 74 68 20 6f 66 20 74 68 65 20 6a 6f 75  -path of the jou
3d00: 72 6e 61 6c 20 66 69 6c 65 0a 66 6f 72 6d 61 74  rnal file.format
3d10: 74 65 64 20 61 73 20 61 20 6e 75 6c 2d 74 65 72  ted as a nul-ter
3d20: 6d 69 6e 61 74 65 64 2c 20 55 54 46 2d 38 20 73  minated, UTF-8 s
3d30: 74 72 69 6e 67 2e 0a 0a 48 4c 52 20 48 35 31 30  tring...HLR H510
3d40: 31 34 0a 41 20 63 61 6c 6c 20 74 6f 20 74 68 65  14.A call to the
3d50: 20 73 71 6c 69 74 65 33 42 74 72 65 65 47 65 74   sqlite3BtreeGet
3d60: 4a 6f 75 72 6e 61 6c 6e 61 6d 65 20 66 75 6e 63  Journalname func
3d70: 74 69 6f 6e 20 77 69 74 68 20 61 20 76 61 6c 69  tion with a vali
3d80: 64 20 42 2d 54 72 65 65 20 64 61 74 61 62 61 73  d B-Tree databas
3d90: 65 0a 63 6f 6e 6e 65 63 74 69 6f 6e 20 68 61 6e  e.connection han
3da0: 64 6c 65 20 6f 70 65 6e 65 64 20 6f 6e 20 61 20  dle opened on a 
3db0: 74 65 6d 70 6f 72 61 72 79 20 64 61 74 61 62 61  temporary databa
3dc0: 73 65 20 61 73 20 74 68 65 20 66 69 72 73 74 20  se as the first 
3dd0: 61 72 67 75 6d 65 6e 74 20 73 68 61 6c 6c 0a 72  argument shall.r
3de0: 65 74 75 72 6e 20 61 20 70 6f 69 6e 74 65 72 20  eturn a pointer 
3df0: 74 6f 20 61 20 62 75 66 66 65 72 20 74 6f 20 61  to a buffer to a
3e00: 20 6e 75 6c 2d 74 65 72 6d 69 6e 61 74 65 64 20   nul-terminated 
3e10: 73 74 72 69 6e 67 20 7a 65 72 6f 20 62 79 74 65  string zero byte
3e20: 73 20 69 6e 20 6c 65 6e 67 74 68 0a 28 69 2e 65  s in length.(i.e
3e30: 2e 20 74 68 65 20 66 69 72 73 74 20 62 79 74 65  . the first byte
3e40: 20 6f 66 20 74 68 65 20 62 75 66 66 65 72 20 73   of the buffer s
3e50: 68 61 6c 6c 20 62 65 20 30 78 30 30 29 2e 0a 0a  hall be 0x00)...
3e60: 0a 0a 0a 48 4c 52 20 48 35 31 30 31 35 20 20 20  ...HLR H51015   
3e70: 20 20 20 20 48 35 30 31 30 39 0a 49 66 20 74 68      H50109.If th
3e80: 65 20 66 69 72 73 74 20 70 61 72 61 6d 65 74 65  e first paramete
3e90: 72 20 69 73 20 61 20 62 2d 74 72 65 65 20 64 61  r is a b-tree da
3ea0: 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f  tabase connectio
3eb0: 6e 20 68 61 6e 64 6c 65 20 77 69 74 68 20 61 6e  n handle with an
3ec0: 20 6f 70 65 6e 0a 72 65 61 64 2d 6f 6e 6c 79 20   open.read-only 
3ed0: 6f 72 20 72 65 61 64 2d 77 72 69 74 65 20 74 72  or read-write tr
3ee0: 61 6e 73 61 63 74 69 6f 6e 2c 20 61 6e 64 20 74  ansaction, and t
3ef0: 68 65 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65  he second parame
3f00: 74 65 72 20 69 73 20 61 6e 20 69 6e 74 65 67 65  ter is an intege
3f10: 72 0a 62 65 74 77 65 65 6e 20 30 20 61 6e 64 20  r.between 0 and 
3f20: 37 20 69 6e 63 6c 75 73 69 76 65 2c 20 61 6e 64  7 inclusive, and
3f30: 20 74 68 65 20 64 61 74 61 62 61 73 65 20 69 6d   the database im
3f40: 61 67 65 20 63 6f 6e 73 69 73 74 73 20 6f 66 20  age consists of 
3f50: 7a 65 72 6f 20 70 61 67 65 73 2c 0a 61 20 63 61  zero pages,.a ca
3f60: 6c 6c 20 74 6f 20 74 68 65 20 73 71 6c 69 74 65  ll to the sqlite
3f70: 33 42 74 72 65 65 47 65 74 4d 65 74 61 20 66 75  3BtreeGetMeta fu
3f80: 6e 63 74 69 6f 6e 20 73 68 61 6c 6c 20 73 65 74  nction shall set
3f90: 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20 2a 70   the value of *p
3fa0: 56 61 6c 75 65 20 74 6f 20 0a 7a 65 72 6f 2e 0a  Value to .zero..
3fb0: 0a 48 4c 52 20 48 35 31 30 31 36 20 20 20 20 20  .HLR H51016     
3fc0: 20 20 48 35 30 31 30 39 0a 49 66 20 74 68 65 20    H50109.If the 
3fd0: 66 69 72 73 74 20 70 61 72 61 6d 65 74 65 72 20  first parameter 
3fe0: 69 73 20 61 20 62 2d 74 72 65 65 20 64 61 74 61  is a b-tree data
3ff0: 62 61 73 65 20 63 6f 6e 6e 65 63 74 69 6f 6e 20  base connection 
4000: 68 61 6e 64 6c 65 20 77 69 74 68 20 61 6e 20 6f  handle with an o
4010: 70 65 6e 0a 72 65 61 64 2d 6f 6e 6c 79 20 6f 72  pen.read-only or
4020: 20 72 65 61 64 2d 77 72 69 74 65 20 74 72 61 6e   read-write tran
4030: 73 61 63 74 69 6f 6e 2c 20 61 6e 64 20 74 68 65  saction, and the
4040: 20 73 65 63 6f 6e 64 20 70 61 72 61 6d 65 74 65   second paramete
4050: 72 20 69 73 20 61 6e 20 69 6e 74 65 67 65 72 0a  r is an integer.
4060: 62 65 74 77 65 65 6e 20 30 20 61 6e 64 20 37 20  between 0 and 7 
4070: 69 6e 63 6c 75 73 69 76 65 2c 20 61 6e 64 20 74  inclusive, and t
4080: 68 65 20 64 61 74 61 62 61 73 65 20 69 6d 61 67  he database imag
4090: 65 20 63 6f 6e 73 69 73 74 73 20 6f 66 20 6f 6e  e consists of on
40a0: 65 20 6f 72 20 6d 6f 72 65 0a 70 61 67 65 73 2c  e or more.pages,
40b0: 20 61 20 63 61 6c 6c 20 74 6f 20 74 68 65 20 73   a call to the s
40c0: 71 6c 69 74 65 33 42 74 72 65 65 47 65 74 4d 65  qlite3BtreeGetMe
40d0: 74 61 20 66 75 6e 63 74 69 6f 6e 20 73 68 61 6c  ta function shal
40e0: 6c 20 73 65 74 20 74 68 65 20 76 61 6c 75 65 20  l set the value 
40f0: 6f 66 0a 2a 70 56 61 6c 75 65 20 74 6f 20 74 68  of.*pValue to th
4100: 65 20 63 75 72 72 65 6e 74 20 76 61 6c 75 65 20  e current value 
4110: 6f 66 20 74 68 65 20 73 70 65 63 69 66 69 65 64  of the specified
4120: 20 33 32 2d 62 69 74 20 75 6e 73 69 67 6e 65 64   32-bit unsigned
4130: 20 69 6e 74 65 67 65 72 20 69 6e 20 74 68 65 0a   integer in the.
4140: 64 61 74 61 62 61 73 65 20 69 6d 61 67 65 20 64  database image d
4150: 61 74 61 62 61 73 65 20 68 65 61 64 65 72 2e 0a  atabase header..
4160: 0a 48 4c 52 20 48 35 31 30 31 37 20 20 20 20 20  .HLR H51017     
4170: 20 20 48 35 30 31 30 39 0a 54 68 65 20 64 61 74    H50109.The dat
4180: 61 62 61 73 65 20 68 65 61 64 65 72 20 66 69 65  abase header fie
4190: 6c 64 20 72 65 61 64 20 66 72 6f 6d 20 74 68 65  ld read from the
41a0: 20 64 61 74 61 62 61 73 65 20 69 6d 61 67 65 20   database image 
41b0: 62 79 20 61 20 63 61 6c 6c 20 74 6f 0a 73 71 6c  by a call to.sql
41c0: 69 74 65 33 42 74 72 65 65 47 65 74 4d 65 74 61  ite3BtreeGetMeta
41d0: 20 69 6e 20 74 68 65 20 73 69 74 75 61 74 69 6f   in the situatio
41e0: 6e 20 73 70 65 63 69 66 69 65 64 20 62 79 20 48  n specified by H
41f0: 35 31 30 31 36 20 73 68 61 6c 6c 20 62 65 20 74  51016 shall be t
4200: 68 65 20 33 32 2d 62 69 74 20 0a 75 6e 73 69 67  he 32-bit .unsig
4210: 6e 65 64 20 69 6e 74 65 67 65 72 20 68 65 61 64  ned integer head
4220: 65 72 20 66 69 65 6c 64 20 73 74 6f 72 65 64 20  er field stored 
4230: 61 74 20 62 79 74 65 20 6f 66 66 73 65 74 20 28  at byte offset (
4240: 33 36 20 2b 20 34 20 2a 20 69 64 78 29 20 6f 66  36 + 4 * idx) of
4250: 20 74 68 65 0a 64 61 74 61 62 61 73 65 20 68 65   the.database he
4260: 61 64 65 72 2c 20 77 68 65 72 65 20 69 64 78 20  ader, where idx 
4270: 69 73 20 74 68 65 20 76 61 6c 75 65 20 6f 66 20  is the value of 
4280: 74 68 65 20 73 65 63 6f 6e 64 20 70 61 72 61 6d  the second param
4290: 65 74 65 72 20 70 61 73 73 65 64 20 74 6f 0a 73  eter passed to.s
42a0: 71 6c 69 74 65 33 42 74 72 65 65 47 65 74 4d 65  qlite3BtreeGetMe
42b0: 74 61 2e 0a 0a                                   ta...