Documentation Source Text

Check-in [f6062d7175]
Login

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

Overview
Comment:Fix typos found and reported by aku.
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: f6062d717598b5085ba1dc65551f7e256191ad57
User & Date: drh 2011-06-15 17:17:49
Context
2011-06-20
19:49
Fix the ON CONFLICT documentation to avoid the erroneous implication that you can put an ON CONFLICT clause on a CHECK constraint. check-in: 11f4999021 user: drh tags: trunk
2011-06-15
17:17
Fix typos found and reported by aku. check-in: f6062d7175 user: drh tags: trunk
12:23
Update the limits.html document for the new upper bound on SQLITE_MAX_ATTACHED and to describe the maximum database size and the maximum number of rows in a table. check-in: b91558ccbf user: drh tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to pages/shortnames.in.

    38     38   [database corruption caused by inconsistent use of 8+3 filenames].
    39     39   </p>
    40     40   
    41     41   <h2>Adjusting SQLite To Use 8+3 Filenames</h2>
    42     42   
    43     43   <p>
    44     44   Some devices are compelled to use an older filesystem with 8+3
    45         -filename restructions in order to be compatible with legacy, or due
           45  +filename restrictions for backwards compatibility, or due
    46     46   to other non-technical factors.  In such situations, SQLite can be
    47     47   coerced into using auxiliary files that fit the 8+3 pattern as follows:
    48     48   </p>
    49     49   
    50     50   <ol>
    51     51   <li><p>Compile the SQLite library with the [SQLITE_ENABLE_8_3_NAMES]
    52     52          compile-time option.
................................................................................
    57     57   
    58     58   <li><p>Use [URI filenames] when [sqlite3_open | opening] or
    59     59          [ATTACH | ATTACH-ing] database files and include the
    60     60          "<tt>8_3_names=1</tt>" query parameter in the URI.</p>
    61     61   
    62     62   <li><p>Make sure that database filenames follow the 8+3 filename
    63     63          format and that they do not have an empty name or extension.
    64         -       In other words, the database filename must not contain between
           64  +       In other words, the database filename must contain between
    65     65          1 and 8 characters in the base name and between 1 and 3 characters
    66         -       in the extension.  Blank extensions are not allows.</p>
           66  +       in the extension.  Blank extensions are not allowed.</p>
    67     67   </ol>
    68     68   
    69     69   <p>
    70     70   When the steps above are used, SQLite will shorten filename extensions
    71     71   by only using the last 3 characters of
    72     72   the extension.  Thus, for example, a file that would normally be called
    73     73   "<tt>app.db-journal</tt>" is shortened to just "<tt>app.nal</tt>".

Changes to pages/uri.in.

     8      8   <p>
     9      9   Beginning with [version 3.7.7], the SQLite database file argument to the
    10     10   [sqlite3_open()], [sqlite3_open16()], and [sqlite3_open_v2()] interfaces
    11     11   and to the [ATTACH] command can be specified
    12     12   either as an ordinary filename or as a Uniform Resource Identifier or URI.
    13     13   The advantage of using a URI filename is that query parameters on the URI can
    14     14   be used to control details of the newly created database connection.
    15         -For example, an alternative [VFS] can be specified using "vfs=" query parameter.
           15  +For example, an alternative [VFS] can be specified using a 
           16  +"vfs=" query parameter.
    16     17   Or the database can be opened read-only by using "mode=ro" as a query
    17     18   parameter.
    18     19   </p>
    19     20   
    20     21   <h1>2.0 Backwards Compatibility</h1>
    21     22   
    22     23   <p>
................................................................................
    39     40   ^If URI filenames are recognized when the database connection is originally
    40     41   opened, then URI filenames will also be recognized on [ATTACH] statemenets.
    41     42   ^Similarly, if URI filenames are not recognized when the database connection
    42     43   is first opened, they will not be recognized by [ATTACH].
    43     44   </p>
    44     45   
    45     46   <p>
    46         -Since SQLite always interprets any filename that does not begin 
    47         -with "<tt>file:</tt>" is interpreted
           47  +Since SQLite always interprets any filename that does not begins 
           48  +with "<tt>file:</tt>"
    48     49   as an ordinary filename regardless of the URI setting, and because it is
    49         -very unusual to have an actual file that beings with "<tt>file:</tt>", for
           50  +very unusual to have an actual file to begin with "<tt>file:</tt>", for
    50     51   most applications it is safe to enable URI processing even if URI filenames
    51     52   are not currently being used.
    52     53   </p>
    53     54   
    54     55   <h1>3.0 URI Format</h1>
    55     56   
    56     57   <p>
................................................................................
    99    100   ^The filename argument sqlite3_open16() is converted from UTF16 
   100    101   native byte order into UTF8 prior to processing.
   101    102   
   102    103   <h2>3.1 The URI Path</h2>
   103    104   
   104    105   <p>^The path component of the URI specifies the disk file that is the
   105    106   SQLite database to be opened.  ^(If the path component is omitted, then
   106         -a temporary files is opened as a new database that will be automatically
          107  +the database is stored in a temporary file that will be automatically
   107    108   deleted when the database connection closes.)^  ^If the authority section
   108         -is present, then the path is alway an absolute pathname.  ^If the 
          109  +is present, then the path is always an absolute pathname.  ^If the 
   109    110   authority section is omitted, then the path is an absolute pathname if it
   110    111   begins with the "/" character (ASCII code 0x2f) and is a relative
   111    112   pathname otherwise.  ^(On windows, if the absolute path begins with
   112    113   "<b>/<i>X</i>:/</b>" where <b><i>X</i></b> is any single ASCII alphabetic
   113    114   character ("a" through "z" or "A" through "Z") then the "<b><i>X:</i></b>"
   114    115   is understood to be the drive letter of the the volume containing the file,
   115    116   not the toplevel directory.)^
   116    117   
   117    118   <p>An ordinary filename can usually be converted into an equivalent URI 
   118         -by the step shown below.  The one exception is that a relative windows
          119  +by the steps shown below.  The one exception is that a relative windows
   119    120   pathname with a drive letter cannot be converted directly into a URI; it must
   120    121   be changed into an absolute pathname first.</p>
   121    122   
   122    123   <ol>
   123    124   <li>Convert all "<tt>?</tt>" characters into "<tt>%3f</tt>".
   124    125   <li>Convert all "<tt>#</tt>" characters into "<tt>%23</tt>".
   125    126   <li>On windows only, convert all "<tt>\</tt>" characters into "<tt>/</tt>".
................................................................................
   139    140   We usually refer to these key/value pairs as "query parameters".
   140    141   ^Key/value pairs are separated by a single "<tt>&amp;</tt>" character.
   141    142   ^The key comes first and is separated from the value by a single
   142    143   "<tt>=</tt>" character.
   143    144   ^Both key and value may contain <b>%HH</b> escape sequences.</p>
   144    145   
   145    146   <p>
   146         -^The text of query parameters is appended to the filename argument to
          147  +^The text of query parameters is appended to the filename argument of
   147    148   the xOpen method of the [VFS].
   148    149   ^Any %HH escape sequences in the query parameters are resolved prior to
   149         -being appended ot the xOpen filename.
          150  +being appended to the xOpen filename.
   150    151   ^A single zero-byte separates the xOpen filename argument from the key of
   151    152   the first query parameters, each key and value, and each subsequent key
   152    153   from the prior value.
   153         -^The list query parameters parameters appended to the xOpen filename
          154  +^The list of query parameters parameters appended to the xOpen filename
   154    155   is terminated by a single zero-length key.
   155    156   Note that the value of a query parameter can be an empty string.
   156    157   </p>
   157    158   
   158    159   <tcl>hd_fragment coreqp {query parameters with special meaning to SQLite}</tcl>
   159    160   <h2>3.3 Recognized Query Parameters</h2>
   160    161   
................................................................................
   168    169   <p>
   169    170   The following query parameters are recognized by SQLite as of version 3.7.7.
   170    171   Other query parameters might be added to this set in future releases.
   171    172   </p>
   172    173   
   173    174   <dl>
   174    175   <dt><b>vfs=</b><i>NAME</i></dt>
   175         -<dd><p>^This query parameter cases the database connection to be opened
          176  +<dd><p>^This query parameter causes the database connection to be opened
   176    177   using the [VFS] called <i>NAME</i>.
   177    178   ^The open attempt fails if <i>NAME</i> is not the name of a [VFS] that
   178    179   is built into SQLite or that has been previously registered using
   179    180   [sqlite3_vfs_register()].</dd>
   180    181   
   181    182   <dt><b>mode=ro<br>mode=rw<br>mode=rwc</b></dt>
   182    183   <dd><p>^These query parameters determine if the new database is opened