Documentation Source Text

Check-in [725dade577]
Login

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

Overview
Comment:Additional documentation updates for the 3.6.12 release. Also, added new emphasis that SQLITE_OMIT_* options only work with canonical sources and are unsupported.
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 725dade577c8215ca38785358ec8131e3cf612a9
User & Date: drh 2009-03-16 20:20:00
Context
2009-03-17
11:07
Fix typo in the rtree.html webpage. CVSTrac ticket #3730. check-in: 61871a4c17 user: drh tags: trunk
2009-03-16
20:20
Additional documentation updates for the 3.6.12 release. Also, added new emphasis that SQLITE_OMIT_* options only work with canonical sources and are unsupported. check-in: 725dade577 user: drh tags: trunk
13:34
Tweaks to the sqlite3_unlock_notify() documentation. check-in: 14a827286f user: drh tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to pages/changes.in.

39
40
41
42
43
44
45

46






47
48
49
50
51
52
53
    }
    hd_close_aux
    hd_enable_main 1
  }
}

chng {2009 March 23 (3.6.12)} {

<li>Added the [reverse_unordered_selects pragma].






}

chng {2009 Feb 18 (3.6.11)} {
<li>Added the [sqlite3_backup_init | hot-backup interface].
<li>Added new commands ".backup" and ".restore" to the [CLI].
<li>Added new methods <a href="tclsqlite.html#backup">backup</a> and
    <a href="tclsqlite.html#restore">restore</a> to the TCL interface.







>

>
>
>
>
>
>







39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
    }
    hd_close_aux
    hd_enable_main 1
  }
}

chng {2009 March 23 (3.6.12)} {
<li>Added the [sqlite3_unlock_notify()] interface.
<li>Added the [reverse_unordered_selects pragma].
<li>The default page size on windows is automatically adjusted to match the
    capabilities of the underlying filesystem.
<li>Add the new ".genfkey" command in the [CLI] for generating triggers to
    implement foreign key constraints.
<li>Performance improvements for "count(*)" queries.
<li>Reduce the amount of heap memory used, especially by TRIGGERs.
}

chng {2009 Feb 18 (3.6.11)} {
<li>Added the [sqlite3_backup_init | hot-backup interface].
<li>Added new commands ".backup" and ".restore" to the [CLI].
<li>Added new methods <a href="tclsqlite.html#backup">backup</a> and
    <a href="tclsqlite.html#restore">restore</a> to the TCL interface.

Changes to pages/compile.in.

422
423
424
425
426
427
428
429
430
431

432
433
434
435
436
437























438
439
440
441
442
443
444
...
480
481
482
483
484
485
486

487









488
489
490
491
492
493
494
495
<p>The macros in this section do not require values. The following 
compilation switches all have the same effect:<br>
-DSQLITE_OMIT_ALTERTABLE<br>
-DSQLITE_OMIT_ALTERTABLE=1<br>
-DSQLITE_OMIT_ALTERTABLE=0
</p>

<p>If any of these options are defined, then the same set of SQLITE_OMIT_XXX
options must also be defined when using the 'lemon' tool to generate the parse.c
file and when compiling the 'mkkeywordhash' tool which generates the keywordhash.h file.

Because of this, these options may only be used when the library is built
from the full source, not from the [amalgamation] or from the collection of
pre-packaged C files provided for non-Unix like platforms on the website.
Any SQLITE_OMIT_XXX options which can be used directly with the [amalgamation] 
are listed below, however, the warnings in the following paragraph should be noted.
</p>
























<p><table>
  <tr>
    <td>
      <ul>
        <li> [SQLITE_OMIT_AUTHORIZATION] </li>
        <li> [SQLITE_OMIT_AUTOINIT] </li>
................................................................................
        <li> [SQLITE_OMIT_XFER_OPT] </li>
      </ul>
    </td>
  </tr>
</table>
</p>


<p>All of the SQLITE_OMIT_XXX options are considered unsupported.  Any of these









options may be removed from the code in a future release
and without warning.  For any particular release, some of these
options may cause compile-time or run-time failures, particularly
when used in combination with other options.</p>

<tcl>
COMPILE_OPTION {SQLITE_OMIT_ALTERTABLE} {
  When this option is defined, the 







|
|
|
>

|

|


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







 







>
|
>
>
>
>
>
>
>
>
>
|







422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
...
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
<p>The macros in this section do not require values. The following 
compilation switches all have the same effect:<br>
-DSQLITE_OMIT_ALTERTABLE<br>
-DSQLITE_OMIT_ALTERTABLE=1<br>
-DSQLITE_OMIT_ALTERTABLE=0
</p>

<p>If any of these options are defined, then the same set of SQLITE_OMIT_*
options must also be defined when using the 'lemon' tool to generate the
parse.c file and when compiling the 'mkkeywordhash' tool which generates 
the keywordhash.h file.
Because of this, these options may only be used when the library is built
from canonical source, not from the [amalgamation] or from the collection of
pre-packaged C files provided for non-Unix like platforms on the website.
Any SQLITE_OMIT_* options which can be used directly with the [amalgamation] 
are listed below, however, the warnings in the following paragraph should be noted.
</p>

<blockquote>
<i><b>Important Note:</b> The SQLITE_OMIT_* options do not work with the
[amalgamation] or with pre-packaged C code files.  SQLITE_OMIT_* compile-time
options only work correctly when SQLite is built from canonical source files.
</i>
</blockquote>


<p>Special versions of the SQLite amalgamation that do work with a
predetermined set of SQLITE_OMIT_* options can be generated.  To do so,
make a copy of the Makefile.linux-gcc makefile template in the canonical
source code distribution.  Change the name of your copy to simply "Makefile".
Then edit "Makefile" to set up appropriate compile-time options.  Then
type:
<blockquote><tt>make clean; make sqlite3.c</tt></blockquote>
The resulting "sqlite3.c" amalgamation code file (and its associated
header file "sqlite3.h") can then be moved to a non-unix platform
for final compilation using a native compiler.</p>

<p>
The following SQLITE_OMIT_* options are available:
</p>

<p><table>
  <tr>
    <td>
      <ul>
        <li> [SQLITE_OMIT_AUTHORIZATION] </li>
        <li> [SQLITE_OMIT_AUTOINIT] </li>
................................................................................
        <li> [SQLITE_OMIT_XFER_OPT] </li>
      </ul>
    </td>
  </tr>
</table>
</p>


<p>All of the SQLITE_OMIT_* options are unsupported.</p>

<blockquote>
<i><b>Important Note:</b>
The SQLITE_OMIT_* compile-time options are unsupported.
</i></blockquote>

<p>
The SQLITE_OMIT_* compile-time options are usually untested and
are almost certainly untested in combination.
Any or all of these options may be removed from the code in future releases
and without warning.  For any particular release, some of these
options may cause compile-time or run-time failures, particularly
when used in combination with other options.</p>

<tcl>
COMPILE_OPTION {SQLITE_OMIT_ALTERTABLE} {
  When this option is defined, the 

Changes to pages/faq.in.

564
565
566
567
568
569
570














571
572
573
574
575
576
577

  <p>As of [Version 3.6.12] this feature is incorporated into the CLI.</p>
  
  <p>You can read about other possible solutions for foreign key
  support in the
  <a href="http://www.sqlite.org/cvstrac/wiki?p=ForeignKeyTriggers">SQLite Wiki</a>.</p>
}















# End of questions and answers.
#############

hd_puts {<h2>Frequently Asked Questions</h2>}
hd_puts {<p>See also <a href="http://www.sqlite.org/cvstrac/wiki?p=SqliteWikiFaq">SqliteWikiFaq</a>.</p>}








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







564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591

  <p>As of [Version 3.6.12] this feature is incorporated into the CLI.</p>
  
  <p>You can read about other possible solutions for foreign key
  support in the
  <a href="http://www.sqlite.org/cvstrac/wiki?p=ForeignKeyTriggers">SQLite Wiki</a>.</p>
}

faq {
  I get a compiler error if I use the SQLITE_OMIT_... 
  compile-time options when building SQLite.
} {
  The [omitfeatures | SQLITE_OMIT_...] compile-time options only work
  when building from canonically source files.  They do <u>not</u> work
  when you build from the SQLite [amalgamation] or from the pre-processed
  source files.

  It is possible to build a special [amalgamation] that will work with
  a predetermined set of SQLITE_OMIT_... options.  Instructions for doing
  so can be found with the [omitfeatures | SQLITE_OMIT_... documentation].
}

# End of questions and answers.
#############

hd_puts {<h2>Frequently Asked Questions</h2>}
hd_puts {<p>See also <a href="http://www.sqlite.org/cvstrac/wiki?p=SqliteWikiFaq">SqliteWikiFaq</a>.</p>}

Changes to pages/sqlite.in.

128
129
130
131
132
133
134






135
136
137
138
139
140
141
.backup ?DB? FILE      Backup DB (default "main") to FILE
.bail ON|OFF           Stop after hitting an error.  Default OFF
.databases             List names and files of attached databases
.dump ?TABLE? ...      Dump the database in an SQL text format
.echo ON|OFF           Turn command echo on or off
.exit                  Exit this program
.explain ON|OFF        Turn output mode suitable for EXPLAIN on or off.






.header(s) ON|OFF      Turn display of headers on or off
.help                  Show this message
.import FILE TABLE     Import data from FILE into TABLE
.indices TABLE         Show names of all indices on TABLE
.iotrace FILE          Enable I/O diagnostic logging to FILE
.load FILE ?ENTRY?     Load an extension library
.mode MODE ?TABLE?     Set output mode where MODE is one of:







>
>
>
>
>
>







128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
.backup ?DB? FILE      Backup DB (default "main") to FILE
.bail ON|OFF           Stop after hitting an error.  Default OFF
.databases             List names and files of attached databases
.dump ?TABLE? ...      Dump the database in an SQL text format
.echo ON|OFF           Turn command echo on or off
.exit                  Exit this program
.explain ON|OFF        Turn output mode suitable for EXPLAIN on or off.
.genfkey ?OPTIONS?     Options are:
                         --no-drop: Do not drop old fkey triggers.
                         --ignore-errors: Ignore tables with fkey errors
                         --exec: Execute generated SQL immediately
                       See file tool/genfkey.README in the source 
                       distribution for further information.
.header(s) ON|OFF      Turn display of headers on or off
.help                  Show this message
.import FILE TABLE     Import data from FILE into TABLE
.indices TABLE         Show names of all indices on TABLE
.iotrace FILE          Enable I/O diagnostic logging to FILE
.load FILE ?ENTRY?     Load an extension library
.mode MODE ?TABLE?     Set output mode where MODE is one of: