Update documentation prior to the release of 2.6.0. (CVS 683)

FossilOrigin-Name: f2d9191381e956900a14bd80e50678b9d49e19e5

diff --git a/manifest b/manifest
index f37095bb77b1df6d1d4fa03b49f99cb5a6909735..45d602aa9917a410f9d8accee070c39c27ec1bc3 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C Make\sthe\sautomatic\sdatabase\supgrade\swork\seven\sif\sthere\sare\striggers.\s\sAdd\ntests\sfor\sautomatic\supgrade\sand\sfor\sfailing\sif\sreading\sa\smore\sadvanced\sversion\nof\sthe\sdatabase.\s\sTicket\s#107.\s(CVS\s682)
-D 2002-07-18T01:27:18
+C Update\sdocumentation\sprior\sto\sthe\srelease\sof\s2.6.0.\s(CVS\s683)
+D 2002-07-18T02:07:08
 F Makefile.in 6291a33b87d2a395aafd7646ee1ed562c6f2c28c
 F Makefile.template 4e11752e0b5c7a043ca50af4296ec562857ba495
 F README a4c0ba11354ef6ba0776b400d057c59da47a4cc0
@@ -107,7 +107,7 @@ F test/trigger3.test 7dfe798d7e72c13720394685fe353112e3f31adf
 F test/unique.test 572aa791327c1e8d797932263e9d67f176cfdb44
 F test/update.test 7ffb062d580a972e7870d0f51d5af3ab9bfeae08
 F test/vacuum.test 059871b312eb910bbe49dafde1d01490cc2c6bbe
-F test/version.test c970e4196ac995d22ce51a9cb1f0285f8c950deb
+F test/version.test 7b3084bb0b225304d4f5eb8215973e6daf439bcb
 F test/view.test 3afca084dab44c7a5772d3c6a326adf93ad52050
 F test/where.test 1f87bec674bf85d74ac1cc5b2cd3d89be1e87b1d
 F tool/diffdb.c 7524b1b5df217c20cd0431f6789851a4e0cb191b
@@ -127,14 +127,14 @@ F www/arch.png 82ef36db1143828a7abc88b1e308a5f55d4336f4
 F www/arch.tcl 72a0c80e9054cc7025a50928d28d9c75c02c2b8b
 F www/audit.tcl 90e09d580f79c7efec0c7d6f447b7ec5c2dce5c0
 F www/c_interface.tcl 580c03f096a16c0cf7ce18e0483daace4a602b46
-F www/changes.tcl a6d732a78b451eab29a66a068dc07b359f32c5a8
+F www/changes.tcl 899174e0f3b0c32be054b9d09d9a3bddba82752b
 F www/conflict.tcl 81dd21f9a679e60aae049e9dd8ab53d59570cda2
 F www/crosscompile.tcl 3622ebbe518927a3854a12de51344673eb2dd060
 F www/download.tcl 29aa6679ca29621d10613f60ebbbda18f4b91c49
 F www/dynload.tcl 02eb8273aa78cfa9070dd4501dca937fb22b466c
 F www/faq.tcl 06e95342a101fde3ce59dbf128233a178502587e
-F www/formatchng.tcl f604cde78f1ac9c29420136109b04407408e876e
-F www/index.tcl d0c52fbf031d0a3ee6d9d77aa669d5a4b24b6130
+F www/formatchng.tcl 502847353450adaf76d187d87374bce20dd07e0e
+F www/index.tcl 17384c30e0ddccaac4cd775be4e3b18fa8a248eb
 F www/lang.tcl 8c3d0bda030f110c754b5edbad75eddf5dbe2ed1
 F www/mingw.tcl f1c7c0a7f53387dd9bb4f8c7e8571b7561510ebc
 F www/opcode.tcl bdec8ef9f100dbd87bbef8976c54b88e43fd8ccc
@@ -142,7 +142,7 @@ F www/speed.tcl da8afcc1d3ccc5696cfb388a68982bc3d9f7f00f
 F www/sqlite.tcl ae3dcfb077e53833b59d4fcc94d8a12c50a44098
 F www/tclsqlite.tcl 1db15abeb446aad0caf0b95b8b9579720e4ea331
 F www/vdbe.tcl 2013852c27a02a091d39a766bc87cff329f21218
-P 20d152fcddb4fa53556a9c93c7a869600a7c5183
-R 234db4e0b851adaa70ea9179904f5e16
+P 0493e39c1cbbe4a38e990a2370181a79606af222
+R b4dca914d3bc15b016390e11b1848c08
 U drh
-Z 8a3f7ec18696f6fb7843f936645bc3ff
+Z 7f7610a66e86d758a528a8b2f954025f

diff --git a/manifest.uuid b/manifest.uuid
index 549a0a047b09dde9ffe374909adfb26f806b6e2e..e40d4d0722d9803ac14e6b0dcc20f62dafd824c4 100644 (file)
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-0493e39c1cbbe4a38e990a2370181a79606af222
\ No newline at end of file
+f2d9191381e956900a14bd80e50678b9d49e19e5
\ No newline at end of file

diff --git a/test/version.test b/test/version.test
index f742f87f8bb35f8d13d4ecbdbd39b3400fb519a6..623c4a37d12a87b6e51c2c2f4d58fea6b1756060 100644 (file)
--- a/test/version.test
+++ b/test/version.test
@@ -12,7 +12,7 @@
 # focus of this file is testing the ability of the library to detect
 # past or future file format version numbers and respond appropriately.
 #
-# $Id: version.test,v 1.1 2002/07/18 01:27:19 drh Exp $
+# $Id: version.test,v 1.2 2002/07/18 02:07:08 drh Exp $
 
 set testdir [file dirname $argv0]
 source $testdir/tester.tcl
@@ -164,6 +164,19 @@ do_test version-1.14 {
   }
 } {16 0}
 
-
+# Try to do an upgrade where the database file is read-only
+#
+do_test version-2.1 {
+  db close
+  set m2 [lreplace $::meta 2 2 2]
+  btree_begin_transaction $::bt
+  eval btree_update_meta $::bt $m2
+  btree_commit $::bt
+  btree_close $::bt
+  catch {file attributes test.db -permissions 0444}
+  catch {file attributes test.db -readonly 1}
+  set rc [catch {sqlite db test.db} msg]
+  lappend rc $msg
+} {1 {unable to upgrade database to the version 2.6 format}}
 
 finish_test

diff --git a/www/changes.tcl b/www/changes.tcl
index 117ee3d81f6df6ebd0241e5b772cd12472cebe6b..81812423922c85dcf89e0258afd7aadd50109810 100644 (file)
--- a/www/changes.tcl
+++ b/www/changes.tcl
@@ -25,6 +25,17 @@ proc chng {date desc} {
   puts "<DD><P><UL>$desc</UL></P></DD>"
 }
 
+chng {2002 Jly 7 (2.6.0)} {
+<li>Change the format of indices to correct a design flaw the originated
+    with version 2.1.0.  <font color="red">*** This is an incompatible
+    file format change ***</font>  When version 2.6.0 or later of the
+    library attempts to open a database file created by version 2.5.6 or
+    earlier, it will automatically and irreversibly convert the file format.
+    <b>Make backup copies of older database files before opening them with
+    version 2.6.0 of the library.</b>
+    </li>
+}
+
 chng {2002 Jly 7 (2.5.6)} {
 <li>Fix more problems with rollback.  Enhance the test suite to exercise
     the rollback logic extensively in order to prevent any future problems.

diff --git a/www/formatchng.tcl b/www/formatchng.tcl
index 067b69059b1dd31d9290b391ebf7839018ca3702..41288d45299a37bb421859915383eb2ce39fbf9c 100644 (file)
--- a/www/formatchng.tcl
+++ b/www/formatchng.tcl
@@ -1,7 +1,7 @@
 #
 # Run this Tcl script to generate the formatchng.html file.
 #
-set rcsid {$Id: formatchng.tcl,v 1.5 2002/06/20 11:41:59 drh Exp $ }
+set rcsid {$Id: formatchng.tcl,v 1.6 2002/07/18 02:07:08 drh Exp $ }
 
 puts {<html>
 <head>
@@ -115,6 +115,27 @@ occurred since version 1.0.0:
   and initialization will fail.
   </td>
 </tr>
+<tr>
+  <td valign="top">2.5.6 to 2.6.0</td>
+  <td valign="top">2002-July-17</td>
+  <td>A design flaw in the layout of indices required a file format change
+  to correct.  This change appeared in version 2.6.0.<p>
+
+  If you use version 2.6.0 or later of the library to open a database file
+  that was originally created by version 2.5.6 or earlier, an attempt to
+  rebuild the database into the new format will occur automatically.
+  This can take some time for a large database.  (Allow 1 or 2 seconds
+  per megabyte of database under Unix - longer under Windows.)  This format
+  conversion is irreversible.  It is <strong>strongly</strong> suggested
+  that you make a backup copy of older database files prior to opening them
+  with version 2.6.0 or later of the library, in case there are errors in
+  the format conversion logic.<p>
+
+  Version 2.6.0 or later of the library cannot open read-only database
+  files from version 2.5.6 or earlier, since read-only files cannot be
+  upgraded to the new format.</p>
+  </td>
+</tr>
 </table>
 </blockquote>
 

diff --git a/www/index.tcl b/www/index.tcl
index 5e928e70f891487f5ac5a55a3e4ec88c19734ec1..4caa8ea60334d388c697fccaecb909e3243ec157 100644 (file)
--- a/www/index.tcl
+++ b/www/index.tcl
@@ -1,7 +1,7 @@
 #
 # Run this TCL script to generate HTML for the index.html file.
 #
-set rcsid {$Id: index.tcl,v 1.59 2002/04/12 13:11:53 drh Exp $}
+set rcsid {$Id: index.tcl,v 1.60 2002/07/18 02:07:08 drh Exp $}
 
 puts {<html>
 <head><title>SQLite: An SQL Database Engine In A C Library</title></head>
@@ -47,7 +47,7 @@ Quick Links:
 puts {<h2>Features</h2>
 
 <p><ul>
-<li>Implements a large subset of SQL92.</li>
+<li>Implements most of SQL92.</li>
 <li>A complete database (with multiple tables and indices) is
     stored in a single disk file.</li>
 <li>Atomic commit and rollback protect data integrity.</li>
@@ -66,6 +66,30 @@ three functions and one opaque structure.</li>
 </p>
 }
 
+puts {<h2>Database File Format Change - 2002 July 17</h2>
+
+<p>Beginning with version 2.6.0, the SQLite database file format changed
+in an incompatible way.  If you open a database file from version 2.5.6
+or earlier with version 2.6.0 or later of the library, then the file format
+will be converted automatically.  This is an irreversible operation.  Once
+the conversion occurs, you will no longer be able to access the database
+file from older versions of the library.  If the database is large, the
+conversion might take some time. (Allow 1 to 2 seconds per megabyte
+of database under Linux.) If the database is read-only,
+the conversion cannot occur and the attempt to open the database will
+fail.
+It is suggested that you make backup copies of older database files
+before attempting to open them with version 2.6.0 or later of the library.</p>
+
+<center>
+<table width="50%" border=1 cellpadding=20 cellspacing=0>
+<tr><td>
+<b>Make backups of older database files before opening them
+with version 2.6.0 or later of SQLite</b></td></tr>
+</table>
+</center>
+}
+
 puts {<h2>Current Status</h2>
 
 <p>A <a href="changes.html">Change Summary</a> is available on this