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 Unified Diffs Show Whitespace Changes Patch

Changes to pages/tclsqlite.in.

783
784
785
786
787
788
789








790
791
792
793
794
795
796
</ul>

<p>This method might decide to run a [checkpoint] either itself or as a
subsequent idle callback.  Note that SQLite only allows a single WAL hook.
By default this single WAL hook is used for the auto-checkpointing.  If you
set up an explicit WAL hook, then that one WAL hook must ensure that checkpoints
are occurring since the auto-checkpointing mechanism will be disabled.</p>








}

##############################################################################
METHOD incrblob {

<p>This method opens a TCL channel that can be used to read or write
into a preexisting BLOB in the database.  The syntax is like this:</p>







>
>
>
>
>
>
>
>







783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
</ul>

<p>This method might decide to run a [checkpoint] either itself or as a
subsequent idle callback.  Note that SQLite only allows a single WAL hook.
By default this single WAL hook is used for the auto-checkpointing.  If you
set up an explicit WAL hook, then that one WAL hook must ensure that checkpoints
are occurring since the auto-checkpointing mechanism will be disabled.</p>

<p>This method should return an integer value that is equivalent to an 
SQLite error code (usually 0 for SQLITE_OK in the case of success or 1 for
SQLITE_ERROR if some error occurs). As in [sqlite3_wal_hook()], the results of
returning an integer that does not correspond to an SQLite error code are
undefined. If the value returned by the script cannot be interpreted as an
integer value, or if the script throws a Tcl exception, no error is returned to
SQLite but a Tcl background-error is raised.
}

##############################################################################
METHOD incrblob {

<p>This method opens a TCL channel that can be used to read or write
into a preexisting BLOB in the database.  The syntax is like this:</p>