Documentation Source Text

Check-in [73c3c21f31]
Login

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

Overview
Comment:Fix documentation typos from David Raymond.
Downloads: Tarball | ZIP archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 73c3c21f3100fa357e45d8ffc430aab1d147a87c045d19790bb040049bc8405f
User & Date: drh 2017-07-13 19:25:13.485
Context
2017-07-13
20:59
Add basic documentation for the COMPLETION extension. (check-in: 875a26d2d9 user: drh tags: trunk)
19:25
Fix documentation typos from David Raymond. (check-in: 73c3c21f31 user: drh tags: trunk)
19:12
Merge fixes from the 3.19.0 branch. (check-in: 3a97831e93 user: drh tags: trunk)
Changes
Unified Diff Ignore Whitespace Patch
Changes to pages/changes.in.
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<li> Update the text of error messages returned by [sqlite3_errmsg()] for some
     error codes.
<li> Add new interfaces [sqlite3_bind_pointer()], [sqlite3_result_pointer()], and
     [sqlite3_value_pointer()].  Update the [carray(PTR,N)] and 
     [https://www.sqlite.org/src/file/ext/misc/remember.c | remember(V,PTR)]
     extensions to require the use of [sqlite3_bind_pointer()] to set their
     pointer values.
<li> Added the LSM1 extension
<li> Added the [STMT virtual table] extension
<li> Added the COMPLETION table-valued function extension - designed to suggest
     tab-completions for interactive user interfaces.
<li> Added the [sqlite3_prepare_v3()] and [sqlite3_prepare16_v3()] interfaces
     with the extra "prepFlags" parameters.
<li> Provide the [SQLITE_PREPARE_PERSISTENT] flag [sqlite3_prepare_v3()] and
     use it to limit [lookaside memory] misuse by [FTS3], [FTS5], and the







<







25
26
27
28
29
30
31

32
33
34
35
36
37
38
<li> Update the text of error messages returned by [sqlite3_errmsg()] for some
     error codes.
<li> Add new interfaces [sqlite3_bind_pointer()], [sqlite3_result_pointer()], and
     [sqlite3_value_pointer()].  Update the [carray(PTR,N)] and 
     [https://www.sqlite.org/src/file/ext/misc/remember.c | remember(V,PTR)]
     extensions to require the use of [sqlite3_bind_pointer()] to set their
     pointer values.

<li> Added the [STMT virtual table] extension
<li> Added the COMPLETION table-valued function extension - designed to suggest
     tab-completions for interactive user interfaces.
<li> Added the [sqlite3_prepare_v3()] and [sqlite3_prepare16_v3()] interfaces
     with the extra "prepFlags" parameters.
<li> Provide the [SQLITE_PREPARE_PERSISTENT] flag [sqlite3_prepare_v3()] and
     use it to limit [lookaside memory] misuse by [FTS3], [FTS5], and the
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<li> When generating individual loops for each ORed term of an OR scan,
     move any constant WHERE expressions outside of the loop, as is 
     done for top-level loops.
<li> The query planner examines the values of bound parameters to help
     determine if a partial index is usable.
<li> When deciding between two plans with the same estimated cost, bias 
     the selection toward the one that does not use the sorter.
<li> Evaluation WHERE clause constraints involving correlated subqueries
     last, in the hope that they never have be evaluated at all.
</ul>
<li> Add [SQLITE_STMTSTATUS_REPREPARE], [SQLITE_STMTSTATUS_RUN], 
     and [SQLITE_STMTSTATUS_MEMUSED] options for the
     [sqlite3_stmt_status()] interface.
<li> Provide eponymous virtual tables for
     [PRAGMA integrity_check], [PRAGMA quick_check], and







|







60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<li> When generating individual loops for each ORed term of an OR scan,
     move any constant WHERE expressions outside of the loop, as is 
     done for top-level loops.
<li> The query planner examines the values of bound parameters to help
     determine if a partial index is usable.
<li> When deciding between two plans with the same estimated cost, bias 
     the selection toward the one that does not use the sorter.
<li> Evaluate WHERE clause constraints involving correlated subqueries
     last, in the hope that they never have be evaluated at all.
</ul>
<li> Add [SQLITE_STMTSTATUS_REPREPARE], [SQLITE_STMTSTATUS_RUN], 
     and [SQLITE_STMTSTATUS_MEMUSED] options for the
     [sqlite3_stmt_status()] interface.
<li> Provide eponymous virtual tables for
     [PRAGMA integrity_check], [PRAGMA quick_check], and
Changes to pages/stmt.in.
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
The STMT extension implements an [eponymous-only virtual table] that
provides information about all [prepared statements] associated with
the [database connection].
</p>

<p>
The STMT extension is included in the [amalgamation] though it is disabled
by default.  The enable the STMT extension, use the [SQLITE_ENABLE_STMTVTAB]
compile-time option.  The STMT extension can also be loaded at run-time
by compiling the extension into a shared library or DLL using the source
code at [https://sqlite.org/src/file/ext/misc/stmt.c] and following the
instructions for how to [compile loadable extensions].
</p>

<p>
The STMT extension is enabled in default builts of the [command-line shell].

<h1>Usage</h1>

<p>
The STMT virtual table is a read-only table that can be directly queried
to access information about all prepared statements on the current database
connection.  For example:







|
|






|







9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
The STMT extension implements an [eponymous-only virtual table] that
provides information about all [prepared statements] associated with
the [database connection].
</p>

<p>
The STMT extension is included in the [amalgamation] though it is disabled
by default.  Use the [SQLITE_ENABLE_STMTVTAB] compile-time option to enable
the STMT extension.  The STMT extension can also be loaded at run-time
by compiling the extension into a shared library or DLL using the source
code at [https://sqlite.org/src/file/ext/misc/stmt.c] and following the
instructions for how to [compile loadable extensions].
</p>

<p>
The STMT extension is enabled in default builds of the [command-line shell].

<h1>Usage</h1>

<p>
The STMT virtual table is a read-only table that can be directly queried
to access information about all prepared statements on the current database
connection.  For example: