Rework parts of the pragma documentation. Ticket #1081. (CVS 2354)

FossilOrigin-Name: 25141d9e213005940c4e57deca408e09c3e615d1

diff --git a/manifest b/manifest
index 18c119357cd1d7308629c6853da7b0c43b31ef84..00e3113e6250faf95099bfb337e357fcc59fe133 100644 (file)
--- a/manifest
+++ b/manifest
@@ -1,5 +1,5 @@
-C Add\sdocumentation\son\sthe\sEXISTS\sexpression.\s\sTicket\s#1082.\s(CVS\s2353)
-D 2005-02-19T12:44:16
+C Rework\sparts\sof\sthe\spragma\sdocumentation.\s\sTicket\s#1081.\s(CVS\s2354)
+D 2005-02-19T13:05:48
 F Makefile.in 76443a83549d1539105e12d13bd0054a05ab2214
 F Makefile.linux-gcc a9e5a0d309fa7c38e7c14d3ecf7690879d3a5457
 F README a01693e454a00cc117967e3f9fdab2d4d52e9bc1
@@ -265,7 +265,7 @@ F www/oldnews.tcl 1e4c67ca29b4d9621fca846e75702dd9ae9c9868
 F www/omitted.tcl 9f332aea97b47ec53234f4cd9aa4b4a6da8641ec
 F www/opcode.tcl dafa030a5a3cc24a2f9fd4cfbfb7d7323d2151b0
 F www/optimizing.tcl f0b2538988d1bbad16cbfe63ec6e8f48c9eb04e5
-F www/pragma.tcl 91fdeace099542858192335a401cb5e18cfbe88d
+F www/pragma.tcl 3b7d88d6545e9b8ea4a3661e0be5e0f0e9817466
 F www/quickstart.tcl 6f6f694b6139be2d967b1492eb9a6bdf7058aa60
 F www/speed.tcl 1f8fb33df0d5bebf29508af763db3ee019c45967
 F www/sqlite.tcl b51fd15f0531a54874de785a9efba323eecd5975
@@ -274,7 +274,7 @@ F www/tclsqlite.tcl e73f8f8e5f20e8277619433f7970060ab01088fc
 F www/vdbe.tcl 095f106d93875c94b47367384ebc870517431618
 F www/version3.tcl 092a01f5ef430d2c4acc0ae558d74c4bb89638a0
 F www/whentouse.tcl 3e522a06ad41992023c80ca29a048ae2331ca5bd
-P c1fc0a8aa96d2bd615f815b2477b801bda9e9c50
-R 058fc001a82eb2a82cc843693727b03a
+P 76cacb4a39d2dd79a27624a8bd1ff65eeedd4ac8
+R 0ac2f46a61ccb1df27a10469653c076c
 U drh
-Z ef9a2bd579709be8b4e9198f4f3f3df9
+Z ec850b159f313c6a7d5ae471f77f9052

diff --git a/manifest.uuid b/manifest.uuid
index 220f82bf21c9d583a2814d7cf8d702c606b256a9..e07bc5d5517c682cd3c4b514da2c335aa568dc94 100644 (file)
--- a/manifest.uuid
+++ b/manifest.uuid
@@ -1 +1 @@
-76cacb4a39d2dd79a27624a8bd1ff65eeedd4ac8
\ No newline at end of file
+25141d9e213005940c4e57deca408e09c3e615d1
\ No newline at end of file

diff --git a/www/pragma.tcl b/www/pragma.tcl
index 29122dea75f5cc33db8e98c87bdf630a6f99708f..e968ad2d803bc0cefc959eee5132958ad62be11e 100644 (file)
--- a/www/pragma.tcl
+++ b/www/pragma.tcl
@@ -1,7 +1,7 @@
 #
 # Run this Tcl script to generate the pragma.html file.
 #
-set rcsid {$Id: pragma.tcl,v 1.10 2005/02/19 12:32:57 drh Exp $}
+set rcsid {$Id: pragma.tcl,v 1.11 2005/02/19 13:05:48 drh Exp $}
 source common.tcl
 header {Pragma statements supported by SQLite}
 
@@ -250,63 +250,68 @@ puts {
 
 <a name="pragma_temp_store"></a>
 <li><p><b>PRAGMA temp_store;
-       <br>PRAGMA temp_store = DEFAULT; </b>(0)<b>
-       <br>PRAGMA temp_store = MEMORY; </b>(2)<b>
-       <br>PRAGMA temp_store = FILE;</b> (1)</p>
-    <p>Query or change the setting of the "temp_store" flag affecting
-    the database for the duration of the current database connection.
-    The temp_store flag reverts to its default value when the database
-    is closed and reopened.  For additional information on the temp_store
-    flag, see the description of the <a href="#pragma_default_temp_store">
-    <b>default_temp_store</b></a> pragma.  Note that it is possible for 
-    the library compile-time options to override this setting.  
-
-<a name="pragma_temp_store"></a>
-<li><p><b>PRAGMA temp_store;
-       <br>PRAGMA temp_store = DEFAULT; </b>(0)<b>
-       <br>PRAGMA temp_store = MEMORY; </b>(2)<b>
-       <br>PRAGMA temp_store = FILE;</b> (1)</p>
+       <br>PRAGMA temp_store = DEFAULT;</b> (0)<b>
+       <br>PRAGMA temp_store = FILE;</b> (1)<b>
+       <br>PRAGMA temp_store = MEMORY;</b> (2)</p>
     <p>Query or change the setting of the "<b>temp_store</b>" parameter.
-    When temp_store is DEFAULT (0), the compile-time value of the
-    symbol TEMP_STORE is used for the temporary database.  When
-    temp_store is MEMORY (2), an in-memory database is used.  
-    When temp_store is FILE (1), a temporary database file on disk
-    will be used. See PRAGMA <a href="#pragma_temp_store_directory">
-    temp_store_directory</a> for further temporary storage options when 
+    When temp_store is DEFAULT (0), the compile-time C preprocessor macro
+    TEMP_STORE is used to determine where temporary tables and indices
+    are stored.  When
+    temp_store is MEMORY (2) temporary tables and indices are kept in memory.
+    When temp_store is FILE (1) temporary tables and indices are stored
+    in a file.  The <a href="#pragma_temp_store_directory">
+    temp_store_directory</a> pragma can be used to specify the directory
+    containing this file.
     <b>FILE</b> is specified. When the temp_store setting is changed,
-    all existing temporary tables, indices, triggers, and viewers are
+    all existing temporary tables, indices, triggers, and views are
     immediately deleted.</p>
 
-    <p>It is possible for the library compile-time symbol
-    TEMP_STORE to override this setting.  The following table summarizes 
-    this:</p>
-
-<table cellpadding="2">
-<tr><th>TEMP_STORE</th><th>temp_store</th><th>temp database location</th></tr>
-<tr><td align="center">0</td><td align="center"><em>any</em></td><td align="center">file</td></tr>
-<tr><td align="center">1</td><td align="center">0</td><td align="center">file</td></tr>
-<tr><td align="center">1</td><td align="center">1</td><td align="center">file</td></tr>
-<tr><td align="center">1</td><td align="center">2</td><td align="center">memory</td></tr>
-<tr><td align="center">2</td><td align="center">0</td><td align="center">memory</td></tr>
-<tr><td align="center">2</td><td align="center">1</td><td align="center">file</td></tr>
-<tr><td align="center">2</td><td align="center">2</td><td align="center">memory</td></tr>
-<tr><td align="center">3</td><td align="center"><em>any</em></td><td align="center">memory</td></tr>
-</table>
-</li>
-<br>
+    <p>It is possible for the library compile-time C preprocessor symbol
+    TEMP_STORE to override this pragma setting.  The following table summarizes
+    the interaction of the TEMP_STORE preprocessor macro and the
+    temp_store pragma:</p>
+
+    <blockquote>
+    <table cellpadding="2" border="1">
+    <tr><th valign="bottom">TEMP_STORE</th>
+        <th valign="bottom">PRAGMA<br>temp_store</th>
+        <th>Storage used for<br>TEMP tables and indices</th></tr>
+    <tr><td align="center">0</td>
+        <td align="center"><em>any</em></td>
+        <td align="center">file</td></tr>
+    <tr><td align="center">1</td>
+        <td align="center">0</td>
+        <td align="center">file</td></tr>
+    <tr><td align="center">1</td>
+        <td align="center">1</td>
+        <td align="center">file</td></tr>
+    <tr><td align="center">1</td>
+        <td align="center">2</td>
+        <td align="center">memory</td></tr>
+    <tr><td align="center">2</td>
+        <td align="center">0</td>
+        <td align="center">memory</td></tr>
+    <tr><td align="center">2</td>
+        <td align="center">1</td>
+        <td align="center">file</td></tr>
+    <tr><td align="center">2</td>
+        <td align="center">2</td>
+        <td align="center">memory</td></tr>
+    <tr><td align="center">3</td>
+        <td align="center"><em>any</em></td>
+        <td align="center">memory</td></tr>
+    </table>
+    </blockquote>
+    </li>
+    <br>
 
 <a name="pragma_temp_store_directory"></a>
 <li><p><b>PRAGMA temp_store_directory;
        <br>PRAGMA temp_store_directory = 'directory-name';</b></p>
-    <p>Query or change the setting of the "temp_store_directory" flag affecting
-    the database for the duration of the current database connection.
-    The temp_store_directory flag reverts to its default value when the database
-    is closed and reopened.  Setting temp_store_directory allows control of the
-    placement of temporary files created by SQLite when PRAGMA
-    <a href="#pragma_temp_store">temp_store</a> is <b>FILE</b> (1),
-    or when the compile time default temporary store is FILE.
-    Otherwise, when the temp_store (or default) setting is 
-    <b>MEMORY</b> (2), setting temp_store_directory has no effect.</p>
+    <p>Query or change the setting of the "temp_store_directory" - the
+    directory where files used for storing temporary tables and indices
+    are kept.  This setting lasts for the duration of the current connection
+    only and resets to its default value for each new connection opened.
 
     <p>When the temp_store_directory setting is changed, all existing temporary
     tables, indices, triggers, and viewers are immediately deleted.  In
@@ -315,7 +320,7 @@ puts {
 
     <p>The value <i>directory-name</i> should be enclosed in single quotes.
     To revert the directory to the default, set the <i>directory-name</i> to
-    a null string, e.g., <i>PRAGMA temp_store_directory = ''</i>.  An
+    an empty string, e.g., <i>PRAGMA temp_store_directory = ''</i>.  An
     error is raised if <i>directory-name</i> is not found or is not
     writable. </p>
 
@@ -438,6 +443,18 @@ puts {
     SQLite library on and off.  This is used for debugging.  See the 
     <a href="vdbe.html#trace">VDBE documentation</a> for more 
     information.</p></li>
+
+<a name="pragma_vdbe_listing"></a>
+<li><p><b>PRAGMA vdbe_listing = ON; </b>(1)<b>
+    <br>PRAGMA vdbe_listing = OFF;</b> (0)</p>
+    <p>Turn listings of virtual machine programs on and off.
+    With listing is on, the entire content of a program is printed
+    just prior to beginning execution.  This is like automatically
+    executing an EXPLAIN prior to each statement.  The statement
+    executes normally after the listing is printed.
+    This is used for debugging.  See the 
+    <a href="vdbe.html#trace">VDBE documentation</a> for more 
+    information.</p></li>
 </ul>
 
 }