From b0bf726fe37f936785ce0bc4ae1232b7c54d6ca4 Mon Sep 17 00:00:00 2001 From: drh Date: Fri, 28 Sep 2001 23:11:24 +0000 Subject: [PATCH] Documentation updates. (CVS 275) FossilOrigin-Name: 4b4bfc6290f05c6672338690911f68fd8bb418c9 --- manifest | 24 ++++++++++----------- manifest.uuid | 2 +- www/arch.tcl | 16 +++++++------- www/c_interface.tcl | 51 ++++++++++++++++++++++++++++++--------------- www/index.tcl | 42 ++++++++++++++++++++++++------------- www/opcode.tcl | 41 ++++++++++++++++++------------------ www/speed.tcl | 7 +++---- www/sqlite.tcl | 29 +++++++++++--------------- www/vdbe.tcl | 16 ++++++++------ 9 files changed, 127 insertions(+), 101 deletions(-) diff --git a/manifest b/manifest index af6cd78425..a32ea08427 100644 --- a/manifest +++ b/manifest @@ -1,5 +1,5 @@ -C Remove\sreference\sto\sGDBM\sin\sthe\sdocumentation\sof\sthe\s"sqlite"\ncommand-line\sutility.\s(CVS\s274) -D 2001-09-28T18:14:17 +C Documentation\supdates.\s(CVS\s275) +D 2001-09-28T23:11:24 F Makefile.in 98d4627cb364537e4c3a29ee806171f3abf5211a F Makefile.template 7179523fdf3d6e7933ec843e2352dcfc9785c700 F README 93d2977cc5c6595c448de16bdefc312b9d401533 @@ -98,20 +98,20 @@ F tool/renumberOps.awk 6d067177ad5f8d711b79577b462da9b3634bd0a9 F tool/report1.txt 9eae07f26a8fc53889b45fc833a66a33daa22816 F www/arch.fig d5f9752a4dbf242e9cfffffd3f5762b6c63b3bcf F www/arch.png 82ef36db1143828a7abc88b1e308a5f55d4336f4 -F www/arch.tcl c1891efdc00cd76eec72bdbf8b446195902932a3 -F www/c_interface.tcl 52ae81c89bf906b358e04857bd3f76b1a7f61c1b +F www/arch.tcl 03b521d252575f93b9c52f7c8b0007011512fcfb +F www/c_interface.tcl 8e8d9e66e8467c5751116c3427296bde77f474a6 F www/changes.tcl 47619693c843174b57d41482fcd00e2e70d41fd0 F www/crosscompile.tcl c99efacb3aefaa550c6e80d91b240f55eb9fd33e F www/dynload.tcl 02eb8273aa78cfa9070dd4501dca937fb22b466c -F www/index.tcl 639a75165dc532a16ddb02055bc69541eecc3fa7 +F www/index.tcl 998f61fe69be9f1b04e403c8efb75bca92710e83 F www/lang.tcl 33a74d727615ccbee8be7c8efd5876ce008c4b0e F www/mingw.tcl fc5f4ba9d336b6e8c97347cc6496d6162461ef60 -F www/opcode.tcl 60222aeb57a7855b2582c374b8753cb5bb53c4ab -F www/speed.tcl 91b53f9403a62bb322dc1f85a81531309bcfb41c -F www/sqlite.tcl ea362207eee32cdd9dd594b1ec990bdb20101efe +F www/opcode.tcl 4365ad9798872491dbd7d3071510ebe461785ac3 +F www/speed.tcl ab7d6d3bc898472bd94320a5d3c63de928d4804b +F www/sqlite.tcl 6a21242a272e9c0939a04419a51c3d50cae33e3e F www/tclsqlite.tcl 13d50723f583888fc80ae1a38247c0ab415066fa -F www/vdbe.tcl 0c8aaa529dd216ccbf7daaabd80985e413d5f9ad -P 7e79e91b03e21058bbae2c0aab8f3e8ce09ae7f9 -R 241095ce4074dd39044429d0144b987e +F www/vdbe.tcl bb7d620995f0a987293e9d4fb6185a3b077e9b44 +P 0ffab36d1fc29125fdcf0d732073f77012dfcad4 +R 50ffde789836ed27912ab4a11f3cd02b U drh -Z 5497d3942cad9d16c737ee62c27c8636 +Z 7f4c737cc5ad90cbc1518651f459aab9 diff --git a/manifest.uuid b/manifest.uuid index e2aae0032c..a41dbd5389 100644 --- a/manifest.uuid +++ b/manifest.uuid @@ -1 +1 @@ -0ffab36d1fc29125fdcf0d732073f77012dfcad4 \ No newline at end of file +4b4bfc6290f05c6672338690911f68fd8bb418c9 \ No newline at end of file diff --git a/www/arch.tcl b/www/arch.tcl index 0982b7dee5..a32f9f592e 100644 --- a/www/arch.tcl +++ b/www/arch.tcl @@ -1,7 +1,7 @@ # # Run this Tcl script to generate the sqlite.html file. # -set rcsid {$Id: arch.tcl,v 1.5 2001/09/20 01:44:43 drh Exp $} +set rcsid {$Id: arch.tcl,v 1.6 2001/09/28 23:11:24 drh Exp $} puts { @@ -121,11 +121,11 @@ between the virtual machine and the rest of the SQLite library.

An SQLite database is maintained on disk using a B-tree implementation found in the btree.c source file. A separate B-tree is used for -each table and index in the database but all B-trees are stored in the -same disk file. Each page of a B-tree is 1024 bytes in size. The data -is stored with the key in an area called "payload". Up to 236 bytes of -payload can be stored with each B-tree entry. Any additional payload -is stored in a chain of overflow pages.

+each table and index in the database. All B-trees are stored in the +same disk file. Each page of a B-tree is 1024 bytes in size. The key +and data for an entry are stored together in an area called "payload". +Up to 236 bytes of payload can be stored on the same page as the B-tree +entry. Any additional payload is stored in a chain of overflow pages.

The interface to the B-tree subsystem is defined by the header file btree.h. @@ -135,11 +135,11 @@ is stored in a chain of overflow pages.

The B-tree module requests information from the disk in 1024 byte chunks. The page cache is reponsible for reading, writing, and -caching these chunks for the B-tree module. +caching these chunks at the behest of the B-tree module. The page cache also provides the rollback and atomic commit abstraction and takes care of reader/writer locking of the database file. The B-tree driver requests particular pages from the page cache and notifies -the page cache when it wants to modify pages and commit or rollback its +the page cache when it wants to modify pages or commit or rollback changes and the page cache handles all the messy details of making sure the requests are handled quickly, safely, and efficiently.

diff --git a/www/c_interface.tcl b/www/c_interface.tcl index fdbd668fb9..c65f589188 100644 --- a/www/c_interface.tcl +++ b/www/c_interface.tcl @@ -1,7 +1,7 @@ # # Run this Tcl script to generate the sqlite.html file. # -set rcsid {$Id: c_interface.tcl,v 1.15 2001/09/20 01:44:43 drh Exp $} +set rcsid {$Id: c_interface.tcl,v 1.16 2001/09/28 23:11:24 drh Exp $} puts { @@ -41,22 +41,26 @@ int sqlite_exec( char **errmsg ); -#define SQLITE_OK 0 /* Successful result */ -#define SQLITE_ERROR 1 /* SQL error or missing database */ -#define SQLITE_INTERNAL 2 /* An internal logic error in SQLite */ -#define SQLITE_PERM 3 /* Access permission denied */ -#define SQLITE_ABORT 4 /* Callback routine requested an abort */ -#define SQLITE_BUSY 5 /* One or more database files are locked */ -#define SQLITE_NOMEM 6 /* A malloc() failed */ -#define SQLITE_READONLY 7 /* Attempt to write a readonly database */ -#define SQLITE_INTERRUPT 8 /* Operation terminated by sqlite_interrupt() */ -#define SQLITE_IOERR 9 /* Some kind of disk I/O error occurred */ -#define SQLITE_CORRUPT 10 /* The database disk image is malformed */ -#define SQLITE_FULL 12 /* Insertion failed because database is full */ -#define SQLITE_CANTOPEN 13 /* Unable to open the database file */ -#define SQLITE_PROTOCOL 14 /* Database lock protocol error */ -#define SQLITE_SCHEMA 16 /* The database schema changed */ -#define SQLITE_TOOBIG 17 /* Too much data for one row of a table */ +#define SQLITE_OK 0 /* Successful result */ +#define SQLITE_ERROR 1 /* SQL error or missing database */ +#define SQLITE_INTERNAL 2 /* An internal logic error in SQLite */ +#define SQLITE_PERM 3 /* Access permission denied */ +#define SQLITE_ABORT 4 /* Callback routine requested an abort */ +#define SQLITE_BUSY 5 /* The database file is locked */ +#define SQLITE_LOCKED 6 /* A table in the database is locked */ +#define SQLITE_NOMEM 7 /* A malloc() failed */ +#define SQLITE_READONLY 8 /* Attempt to write a readonly database */ +#define SQLITE_INTERRUPT 9 /* Operation terminated by sqlite_interrupt() */ +#define SQLITE_IOERR 10 /* Some kind of disk I/O error occurred */ +#define SQLITE_CORRUPT 11 /* The database disk image is malformed */ +#define SQLITE_NOTFOUND 12 /* (Internal Only) Table or record not found */ +#define SQLITE_FULL 13 /* Insertion failed because database is full */ +#define SQLITE_CANTOPEN 14 /* Unable to open the database file */ +#define SQLITE_PROTOCOL 15 /* Database lock protocol error */ +#define SQLITE_EMPTY 16 /* (Internal Only) Database table is empty */ +#define SQLITE_SCHEMA 17 /* The database schema changed */ +#define SQLITE_TOOBIG 18 /* Too much data for one row of a table */ +#define SQLITE_CONSTRAINT 19 /* Abort due to contraint violation */

Only the three core routines shown above are required to use @@ -259,6 +263,15 @@ database at the same time, but only one thread can have the database open for writing at the same time. Locking in SQLite is on the entire database.

+
SQLITE_LOCKED
+

This return code is similar to SQLITE_BUSY in that it indicates +that the database is locked. But the source of the lock is a recursive +call to sqlite_exec(). This return can only occur if you attempt +to invoke sqlite_exec() from within a callback routine of a query +from a prior invocation of sqlite_exec(). Recursive calls to +sqlite_exec() are allowed as long as no more they all read-only or do +not attempt to write the same table. +

SQLITE_NOMEM

This value is returned if a call to malloc() fails.

@@ -309,6 +322,10 @@ command usually will clear the problem. of a single table. If you attempt to store more than 64K in a single row, this is the return code you get.

+
SQLITE_CONSTRAINT
+

This constant is returned if the SQL statement would have violated +a database constraint. +

diff --git a/www/index.tcl b/www/index.tcl index 23c4af1590..3abbdaad81 100644 --- 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.42 2001/09/28 17:47:14 drh Exp $} +set rcsid {$Id: index.tcl,v 1.43 2001/09/28 23:11:24 drh Exp $} puts { SQLite: An SQL Database Engine In A C Library @@ -41,7 +41,7 @@ puts {

Features