/ Check-in [8be28aa0]
Login

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

Overview
Comment:Documentation updates. No changes to code. (CVS 5402)
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 8be28aa0f259f0b86103e4f1e7da1adfecc4305c
User & Date: drh 2008-07-12 20:35:08
Context
2008-07-13
03:55
Fix a typo in the documentation. (CVS 5403) check-in: d618a883 user: drh tags: trunk
2008-07-12
20:35
Documentation updates. No changes to code. (CVS 5402) check-in: 8be28aa0 user: drh tags: trunk
15:55
Fix the test script --binarylog option. (CVS 5401) check-in: 03e3cfc4 user: danielk1977 tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to src/sqlite.h.in.

    26     26   ** on how SQLite interfaces are suppose to operate.
    27     27   **
    28     28   ** The name of this file under configuration management is "sqlite.h.in".
    29     29   ** The makefile makes some minor changes to this file (such as inserting
    30     30   ** the version number) and changes its name to "sqlite3.h" as
    31     31   ** part of the build process.
    32     32   **
    33         -** @(#) $Id: sqlite.h.in,v 1.368 2008/07/11 16:15:18 drh Exp $
           33  +** @(#) $Id: sqlite.h.in,v 1.369 2008/07/12 20:35:08 drh Exp $
    34     34   */
    35     35   #ifndef _SQLITE3_H_
    36     36   #define _SQLITE3_H_
    37     37   #include <stdarg.h>     /* Needed for the definition of va_list */
    38     38   
    39     39   /*
    40     40   ** Make sure we can call this stuff from C++.
................................................................................
  1045   1045   ** <dd>There are no arguments to this option.  This option enables
  1046   1046   ** all mutexes including the recursive
  1047   1047   ** mutexes on [database connection] and [prepared statement] objects.
  1048   1048   ** In this mode (which is the default when SQLite is compiled with
  1049   1049   ** [SQLITE_THREADSAFE=1]) the SQLite library will itself serialize access
  1050   1050   ** to [database connections] and [prepared statements] so that the
  1051   1051   ** application is free to use the same [database connection] or the
  1052         -** same [prepared statement] in different threads at the same time.</dd>
         1052  +** same [prepared statement] in different threads at the same time.
         1053  +**
         1054  +** <p>This configuration option merely sets the default mutex 
         1055  +** behavior to serialize access to [database connections].  Individual
         1056  +** [database connections] can override this setting
         1057  +** using the [SQLITE_OPEN_NOMUTEX] flag to [sqlite3_open_v2()].</p></dd>
  1053   1058   **
  1054   1059   ** <dt>SQLITE_CONFIG_MALLOC</dt>
  1055   1060   ** <dd>This option takes a single argument which is a pointer to an
  1056   1061   ** instance of the [sqlite3_mem_methods] structure.  The argument specifies
  1057   1062   ** alternative low-level memory allocation routines to be used in place of
  1058   1063   ** the memory allocation routines built into SQLite.</dd>
  1059   1064   **
................................................................................
  2278   2283   ** associated with the [database connection] handle should be released by
  2279   2284   ** passing it to [sqlite3_close()] when it is no longer required.
  2280   2285   **
  2281   2286   ** The sqlite3_open_v2() interface works like sqlite3_open()
  2282   2287   ** except that it accepts two additional parameters for additional control
  2283   2288   ** over the new database connection.  The flags parameter can take one of
  2284   2289   ** the following three values, optionally combined with the 
  2285         -** SQLITE_OPEN_NOMUTEX flag:
         2290  +** [SQLITE_OPEN_NOMUTEX] flag:
  2286   2291   **
  2287   2292   ** <dl>
  2288   2293   ** <dt>[SQLITE_OPEN_READONLY]</dt>
  2289   2294   ** <dd>The database is opened in read-only mode.  If the database does not
  2290   2295   ** already exist, an error is returned.</dd>
  2291   2296   **
  2292   2297   ** <dt>[SQLITE_OPEN_READWRITE]</dt>
................................................................................
  2298   2303   ** <dd>The database is opened for reading and writing, and is creates it if
  2299   2304   ** it does not already exist. This is the behavior that is always used for
  2300   2305   ** sqlite3_open() and sqlite3_open16().</dd>
  2301   2306   ** </dl>
  2302   2307   **
  2303   2308   ** If the 3rd parameter to sqlite3_open_v2() is not one of the
  2304   2309   ** combinations shown above or one of the combinations shown above combined
  2305         -** with the SQLITE_OPEN_NOMUTEX flag, then the behavior is undefined.
         2310  +** with the [SQLITE_OPEN_NOMUTEX] flag, then the behavior is undefined.
  2306   2311   **
  2307         -** If the SQLITE_OPEN_NOMUTEX flag is set, then the opened database handle  
  2308         -** is not threadsafe. If two threads attempt to use the database handle or
  2309         -** any of it's statement handles simultaneously, the results will be 
  2310         -** unpredictable.
         2312  +** If the [SQLITE_OPEN_NOMUTEX] flag is set, then mutexes on the
         2313  +** opened [database connection] are disabled and the appliation must
         2314  +** insure that access to the [database connection] and its associated
         2315  +** [prepared statements] is serialized.  The [SQLITE_OPEN_NOMUTEX] flag
         2316  +** is the default behavior is SQLite is configured using the
         2317  +** [SQLITE_CONFIG_MULTITHREAD] or [SQLITE_CONFIG_SINGLETHREAD] options
         2318  +** to [sqlite3_config()].  The [SQLITE_OPEN_NOMUTEX] flag only makes a
         2319  +** difference when SQLite is in its default [SQLITE_CONFIG_SERIALIZED] mode.
  2311   2320   **
  2312   2321   ** If the filename is ":memory:", then a private, temporary in-memory database
  2313   2322   ** is created for the connection.  This in-memory database will vanish when
  2314   2323   ** the database connection is closed.  Future versions of SQLite might
  2315   2324   ** make use of additional special filenames that begin with the ":" character.
  2316   2325   ** It is recommended that when a database filename actually does begin with
  2317   2326   ** a ":" character you should prefix the filename with a pathname such as