Documentation Source Text

Check-in [4d3f01f58b]
Login

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

Overview
Comment:Add documentation for sqlite3_compileoption_get() and related routines and pragmas. Fix up hyperlinks.
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 4d3f01f58ba6e65107dd3d1ddf2f039e3c9cd2ec
User & Date: drh 2010-02-26 15:39:55
Context
2010-03-08
00:49
Allow the colon character (ASCII 0x3a) as a valid character in the body of a URL. check-in: dba0a9dc4b user: drh tags: trunk
2010-02-26
15:39
Add documentation for sqlite3_compileoption_get() and related routines and pragmas. Fix up hyperlinks. check-in: 4d3f01f58b user: drh tags: trunk
14:05
Begin updating the documentation for the 3.6.23 release. check-in: e45a1175e7 user: drh tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to pages/changes.in.

42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
  }
}

chng {2010 March 08 (3.6.23)} {
<li> Added the [secure_delete pragma].
<li> Added the [sqlite3_compileoption_used()] and
     [sqlite3_compileoption_get()] interfaces as well as the
     [compile_options pragma] and the [sqlite_compile_option_used()] SQL
     function.
<li> Added the [sqlite3_log()] interface together with the
     [SQLITE_CONFIG_LOG] verb to [sqlite3_config()].  The ".log" command
     is added to the [Command Line Interface].
<li> Improvements to [FTS3].
<li> Improvements and bug-fixes in support for [SQLITE_OMIT_FLOATING_POINT].
<li> The [integrity_check pragma] is enhanced to detect out-of-order rowids.
<li> The ".genfkey" operator has been removed from the







|
|







42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
  }
}

chng {2010 March 08 (3.6.23)} {
<li> Added the [secure_delete pragma].
<li> Added the [sqlite3_compileoption_used()] and
     [sqlite3_compileoption_get()] interfaces as well as the
     [compile_options pragma] and the [sqlite_compileoption_used()] and
     [sqlite_compileoption_get()] SQL functions.
<li> Added the [sqlite3_log()] interface together with the
     [SQLITE_CONFIG_LOG] verb to [sqlite3_config()].  The ".log" command
     is added to the [Command Line Interface].
<li> Improvements to [FTS3].
<li> Improvements and bug-fixes in support for [SQLITE_OMIT_FLOATING_POINT].
<li> The [integrity_check pragma] is enhanced to detect out-of-order rowids.
<li> The ".genfkey" operator has been removed from the

Changes to pages/compile.in.

592
593
594
595
596
597
598








599
600
601
602
603
604
605
  they will just not be enforced.
}

COMPILE_OPTION {SQLITE_OMIT_COMPLETE} {
  This option causes the [sqlite3_complete()] and [sqlite3_complete16()]
  interfaces to be omitted.
}









COMPILE_OPTION {SQLITE_OMIT_COMPOUND_SELECT} {
  This option is used to omit the compound [SELECT] functionality. 
  [SELECT] statements that use the 
  UNION, UNION ALL, INTERSECT or EXCEPT compound SELECT operators will 
  cause a parse error.
}







>
>
>
>
>
>
>
>







592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
  they will just not be enforced.
}

COMPILE_OPTION {SQLITE_OMIT_COMPLETE} {
  This option causes the [sqlite3_complete()] and [sqlite3_complete16()]
  interfaces to be omitted.
}

COMPILE_OPTION {SQLITE_OMIT_COMPILEOPTION_DIAGS} {
  This option is used to omit the compile-time option diagnostics available
  in SQLite, including the [sqlite3_compileoption_used()] and
  [sqlite3_compileoption_get()] C/C++ functions, the
  [sqlite_compileoption_used()] and [sqlite_compileoption_get()] SQL functions,
  and the [compile_options pragma].
}

COMPILE_OPTION {SQLITE_OMIT_COMPOUND_SELECT} {
  This option is used to omit the compound [SELECT] functionality. 
  [SELECT] statements that use the 
  UNION, UNION ALL, INTERSECT or EXCEPT compound SELECT operators will 
  cause a parse error.
}

Changes to pages/lang.in.

1819
1820
1821
1822
1823
1824
1825
















1826
1827
1828
1829
1830
1831
1832
  of the string X.
  ^The string "?000" is returned if the argument is NULL or contains
  no ASCII alphabetic characters.
  ^(This function is omitted from SQLite by default.
  It is only available if the [SQLITE_SOUNDEX] compile-time option
  is used when SQLite is built.)^
}

















funcdef {sqlite_source_id()} {} {
  ^The sqlite_source_id() function returns a string that identifies the
  specific version of the source code that was used to build the SQLite
  library.  ^The string returned by sqlite_source_id() begins with
  the date and time that the source code was checked in and is follows by
  an SHA1 hash that uniquely identifies the source tree.  ^This function is







>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>







1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
  of the string X.
  ^The string "?000" is returned if the argument is NULL or contains
  no ASCII alphabetic characters.
  ^(This function is omitted from SQLite by default.
  It is only available if the [SQLITE_SOUNDEX] compile-time option
  is used when SQLite is built.)^
}

funcdef {sqlite_compileoption_get(N)} {} {
  ^The sqlite_compileoption_get() SQL function is a wrapper around the
  [sqlite3_compileoption_get()] C/C++ function.
  ^This routine returns the N-th compile-time option used to build SQLite
  or NULL if N is out of range.  See also the [compile_options pragma].
}

funcdef {sqlite_compileoption_used(X)} {} {
  ^The sqlite_compileoption_used() SQL function is a wrapper around the
  [sqlite3_compileoption_used()] C/C++ function.
  ^When the argument X to sqlite_compileoption_used(X) is a string which
  is the name of a compile-time option, this routine returns true (1) or
  false (0) depending on whether or not that option was used during the
  build.
}

funcdef {sqlite_source_id()} {} {
  ^The sqlite_source_id() function returns a string that identifies the
  specific version of the source code that was used to build the SQLite
  library.  ^The string returned by sqlite_source_id() begins with
  the date and time that the source code was checked in and is follows by
  an SHA1 hash that uniquely identifies the source tree.  ^This function is

Changes to pages/news.in.

19
20
21
22
23
24
25
26
27
28

29
30
31
32
33
34
35
  hd_puts "<hr width=\"50%\">"
}

newsitem {2010-Mar-09} {Version 3.6.23} {
  SQLite [version 3.6.23] is a regular bimonthly release of SQLite.
  Upgrading from the prior release is purely optional.

  This release contains new pragmas: the [secure_delete pragma],
  the [compile_options pragma], and the [compile_option pragma].
  There are a new SQL functions: [sqlite_compile_option_used()].

  New C/C++ interfaces: [sqlite3_compileoption_used()],
  [sqlite3_compileoption_get()], [SQLITE_CONFIG_LOG], and
  [sqlite3_log()].

  This release also includes several minor bug fixes and performance
  improvements.  Support for [SQLITE_OMIT_FLOATING_POINT] is enhanced.
  There are on-going improvements to [FTS3].







|
|
|
>







19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
  hd_puts "<hr width=\"50%\">"
}

newsitem {2010-Mar-09} {Version 3.6.23} {
  SQLite [version 3.6.23] is a regular bimonthly release of SQLite.
  Upgrading from the prior release is purely optional.

  This release contains new pragmas: the [secure_delete pragma], and
  the [compile_options pragma].
  There are a new SQL functions: [sqlite_compileoption_used()]
  and [sqlite_compileoption_get()].
  New C/C++ interfaces: [sqlite3_compileoption_used()],
  [sqlite3_compileoption_get()], [SQLITE_CONFIG_LOG], and
  [sqlite3_log()].

  This release also includes several minor bug fixes and performance
  improvements.  Support for [SQLITE_OMIT_FLOATING_POINT] is enhanced.
  There are on-going improvements to [FTS3].

Changes to pages/pragma.in.

870
871
872
873
874
875
876








877
878
879
880
881
882
883
       applications for any purpose.</p>
</li>
</ul>

<tcl>Section {Pragmas to debug the library} debug</tcl>

<ul>








<tcl>Subsection integrity_check</tcl>
<li><p><b>PRAGMA integrity_check;
    <br>PRAGMA integrity_check(</b><i>integer</i><b>)</b></p>
    <p>^This pragma does an integrity check of the entire database.  ^It
    looks for out-of-order records, missing pages, malformed records, and
    corrupt indices.
    ^If any problems are found, then strings are returned (as multiple







>
>
>
>
>
>
>
>







870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
       applications for any purpose.</p>
</li>
</ul>

<tcl>Section {Pragmas to debug the library} debug</tcl>

<ul>
<tcl>Subsection compile_options</tcl>
<li><p><b>PRAGMA compile_options;</b></p>
    <p>^This pragma returns the names of [compile-time options] used when
    building SQLite, one option per row.  ^The "SQLITE_" prefix is omitted
    from the returned option names.  See also the
    [sqlite3_compileoption_get()] C/C++ interface and the
    [sqlite_compileoption_get()] SQL functions.</p></li>

<tcl>Subsection integrity_check</tcl>
<li><p><b>PRAGMA integrity_check;
    <br>PRAGMA integrity_check(</b><i>integer</i><b>)</b></p>
    <p>^This pragma does an integrity check of the entire database.  ^It
    looks for out-of-order records, missing pages, malformed records, and
    corrupt indices.
    ^If any problems are found, then strings are returned (as multiple