Documentation Source Text

Check-in [356a4d4687]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Expand on the documentation for Tcl method "wal_hook".
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 356a4d46878a103909b9f0638cd9b705129adc6235a91a1c0a338d3870c7d59a
User & Date: dan 2017-07-14 15:37:35
Context
2017-07-14
15:38
Update the change log and the SQLITE_STMT documentation to reflect the new table name. check-in: d2cf72e32f user: drh tags: trunk
15:37
Expand on the documentation for Tcl method "wal_hook". check-in: 356a4d4687 user: dan tags: trunk
13:00
Small wording change to the faster-than-fs document. check-in: 98f02236a9 user: drh tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Show Whitespace Changes Patch

Changes to pages/tclsqlite.in.

   783    783   </ul>
   784    784   
   785    785   <p>This method might decide to run a [checkpoint] either itself or as a
   786    786   subsequent idle callback.  Note that SQLite only allows a single WAL hook.
   787    787   By default this single WAL hook is used for the auto-checkpointing.  If you
   788    788   set up an explicit WAL hook, then that one WAL hook must ensure that checkpoints
   789    789   are occurring since the auto-checkpointing mechanism will be disabled.</p>
          790  +
          791  +<p>This method should return an integer value that is equivalent to an 
          792  +SQLite error code (usually 0 for SQLITE_OK in the case of success or 1 for
          793  +SQLITE_ERROR if some error occurs). As in [sqlite3_wal_hook()], the results of
          794  +returning an integer that does not correspond to an SQLite error code are
          795  +undefined. If the value returned by the script cannot be interpreted as an
          796  +integer value, or if the script throws a Tcl exception, no error is returned to
          797  +SQLite but a Tcl background-error is raised.
   790    798   }
   791    799   
   792    800   ##############################################################################
   793    801   METHOD incrblob {
   794    802   
   795    803   <p>This method opens a TCL channel that can be used to read or write
   796    804   into a preexisting BLOB in the database.  The syntax is like this:</p>