requirements.html

SQLite is a software library that implements a self-contained, serverless, zero-configuration, trans

<blockquote><pre>
SQLITE_EXTERN char *sqlite3_temp_directory;

</pre></blockquote>
</td></tr>
<tr><td valign="top">F10330</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
int sqlite3_enable_shared_cache(int);

</pre></blockquote>
</td></tr>
<tr><td valign="top">F10331</td><td valign="top">
A successful invocation of 
<a href="c3ref/enable_shared_cache.html">sqlite3_enable_shared_cache(B)</a>
will enable or disable shared cache mode for any subsequently
created 
<a href="c3ref/sqlite3.html">database connection</a> in the same process.
</td></tr>
<tr><td valign="top">F10336</td><td valign="top">
When shared cache is enabled, the 
<a href="c3ref/create_module.html">sqlite3_create_module()</a>
interface will always return an error.
</td></tr>
<tr><td valign="top">F10337</td><td valign="top">
The 
<a href="c3ref/enable_shared_cache.html">sqlite3_enable_shared_cache(B)</a> interface returns

<a href="c3ref/c_abort.html">SQLITE_OK</a> if shared cache was enabled or disabled successfully.
</td></tr>
<tr><td valign="top">F10339</td><td valign="top">
Shared cache is disabled by default.
</td></tr>
<tr><td valign="top">F10510</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
int sqlite3_complete(const char *sql);
int sqlite3_complete16(const void *sql);

</pre></blockquote>
</td></tr>
<tr><td valign="top">F10511</td><td valign="top">
The sqlite3_complete() and sqlite3_complete16() functions
return true (non-zero) if and only if the last
non-whitespace token in their input is a semicolon that
is not in between the BEGIN and END of a CREATE TRIGGER
statement.
</td></tr>
<tr><td valign="top">F10530</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
int sqlite3_sleep(int);

</pre></blockquote>
</td></tr>
<tr><td valign="top">F10533</td><td valign="top">
The 
<a href="c3ref/sleep.html">sqlite3_sleep(M)</a> interface invokes the xSleep
method of the default 
<a href="c3ref/vfs.html">VFS</a> in order to
suspend execution of the current thread for at least
M milliseconds.
</td></tr>
<tr><td valign="top">F10536</td><td valign="top">
The 
<a href="c3ref/sleep.html">sqlite3_sleep(M)</a> interface returns the number of
milliseconds of sleep actually requested of the operating
system, which might be larger than the parameter M.
</td></tr>
<tr><td valign="top">F11110</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
typedef struct sqlite3_file sqlite3_file;
struct sqlite3_file {
  const struct sqlite3_io_methods *pMethods;  /* Methods for an open file */
};

</pre></blockquote>
</td></tr>
<tr><td valign="top">F11120</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
typedef struct sqlite3_io_methods sqlite3_io_methods;
struct sqlite3_io_methods {
  int iVersion;
  int (*xClose)(sqlite3_file*);
  int (*xRead)(sqlite3_file*, void*, int iAmt, sqlite3_int64 iOfst);
  int (*xWrite)(sqlite3_file*, const void*, int iAmt, sqlite3_int64 iOfst);
  int (*xTruncate)(sqlite3_file*, sqlite3_int64 size);
  int (*xSync)(sqlite3_file*, int flags);
  int (*xFileSize)(sqlite3_file*, sqlite3_int64 *pSize);
  int (*xLock)(sqlite3_file*, int);
  int (*xUnlock)(sqlite3_file*, int);
  int (*xCheckReservedLock)(sqlite3_file*);
  int (*xFileControl)(sqlite3_file*, int op, void *pArg);
  int (*xSectorSize)(sqlite3_file*);
  int (*xDeviceCharacteristics)(sqlite3_file*);
  /* Additional methods may be added in future releases */
};

</pre></blockquote>
</td></tr>
<tr><td valign="top">F11140</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
typedef struct sqlite3_vfs sqlite3_vfs;
struct sqlite3_vfs {
  int iVersion;            /* Structure version number */
  int szOsFile;            /* Size of subclassed sqlite3_file */
  int mxPathname;          /* Maximum file pathname length */
  sqlite3_vfs *pNext;      /* Next registered VFS */
  const char *zName;       /* Name of this virtual file system */
  void *pAppData;          /* Pointer to application-specific data */
  int (*xOpen)(sqlite3_vfs*, const char *zName, sqlite3_file*,
               int flags, int *pOutFlags);
  int (*xDelete)(sqlite3_vfs*, const char *zName, int syncDir);
  int (*xAccess)(sqlite3_vfs*, const char *zName, int flags);
  int (*xGetTempname)(sqlite3_vfs*, int nOut, char *zOut);
  int (*xFullPathname)(sqlite3_vfs*, const char *zName, int nOut, char *zOut);
  void *(*xDlOpen)(sqlite3_vfs*, const char *zFilename);
  void (*xDlError)(sqlite3_vfs*, int nByte, char *zErrMsg);
  void *(*xDlSym)(sqlite3_vfs*,void*, const char *zSymbol);
  void (*xDlClose)(sqlite3_vfs*, void*);
  int (*xRandomness)(sqlite3_vfs*, int nByte, char *zOut);
  int (*xSleep)(sqlite3_vfs*, int microseconds);
  int (*xCurrentTime)(sqlite3_vfs*, double*);
  /* New fields may be appended in figure versions.  The iVersion
  ** value will increment whenever this happens. */
};

</pre></blockquote>
</td></tr>
<tr><td valign="top">F11190</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
#define SQLITE_ACCESS_EXISTS    0
#define SQLITE_ACCESS_READWRITE 1
#define SQLITE_ACCESS_READ      2

</pre></blockquote>
</td></tr>
<tr><td valign="top">F11200</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
sqlite3_vfs *sqlite3_vfs_find(const char *zVfsName);
int sqlite3_vfs_register(sqlite3_vfs*, int makeDflt);
int sqlite3_vfs_unregister(sqlite3_vfs*);

</pre></blockquote>
</td></tr>
<tr><td valign="top">F11203</td><td valign="top">
The 
<a href="c3ref/vfs_find.html">sqlite3_vfs_find(N)</a> interface returns a pointer to the
registered 
<a href="c3ref/vfs.html">sqlite3_vfs</a> object whose name exactly matches
the zero-terminated UTF-8 string N, or it returns NULL if
there is no match.
</td></tr>
<tr><td valign="top">F11206</td><td valign="top">
If the N parameter to 
<a href="c3ref/vfs_find.html">sqlite3_vfs_find(N)</a> is NULL then
the function returns a pointer to the default 
<a href="c3ref/vfs.html">sqlite3_vfs</a>
object if there is one, or NULL if there is no default

<a href="c3ref/vfs.html">sqlite3_vfs</a> object.
</td></tr>
<tr><td valign="top">F11209</td><td valign="top">
The 
<a href="c3ref/vfs_find.html">sqlite3_vfs_register(P,F)</a> interface registers the
well-formed 
<a href="c3ref/vfs.html">sqlite3_vfs</a> object P using the name given
by the zName field of the object.
</td></tr>
<tr><td valign="top">F11212</td><td valign="top">
Using the 
<a href="c3ref/vfs_find.html">sqlite3_vfs_register(P,F)</a> interface to register
the same 
<a href="c3ref/vfs.html">sqlite3_vfs</a> object multiple times is a harmless no-op.
</td></tr>
<tr><td valign="top">F11215</td><td valign="top">
The 
<a href="c3ref/vfs_find.html">sqlite3_vfs_register(P,F)</a> interface makes the
the 
<a href="c3ref/vfs.html">sqlite3_vfs</a> object P the default 
<a href="c3ref/vfs.html">sqlite3_vfs</a> object
if F is non-zero.
</td></tr>
<tr><td valign="top">F11218</td><td valign="top">
The 
<a href="c3ref/vfs_find.html">sqlite3_vfs_unregister(P)</a> interface unregisters the

<a href="c3ref/vfs.html">sqlite3_vfs</a> object P so that it is no longer returned by
subsequent calls to 
<a href="c3ref/vfs_find.html">sqlite3_vfs_find()</a>.
</td></tr>
<tr><td valign="top">F11300</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);

</pre></blockquote>
</td></tr>
<tr><td valign="top">F11302</td><td valign="top">
The 
<a href="c3ref/finalize.html">sqlite3_finalize(S)</a> interface destroys the

<a href="c3ref/stmt.html">prepared statement</a> S and releases all
memory and file resources held by that object.
</td></tr>
<tr><td valign="top">F11304</td><td valign="top">
If the most recent call to 
<a href="c3ref/step.html">sqlite3_step(S)</a> for the

<a href="c3ref/stmt.html">prepared statement</a> S returned an error,
then 
<a href="c3ref/finalize.html">sqlite3_finalize(S)</a> returns that same error.
</td></tr>
<tr><td valign="top">F11310</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
#define SQLITE_FCNTL_LOCKSTATE        1

</pre></blockquote>
</td></tr>
<tr><td valign="top">F11400</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
int sqlite3_test_control(int op, ...);

</pre></blockquote>
</td></tr>
<tr><td valign="top">F11410</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
#define SQLITE_TESTCTRL_FAULT_CONFIG             1
#define SQLITE_TESTCTRL_FAULT_FAILURES           2
#define SQLITE_TESTCTRL_FAULT_BENIGN_FAILURES    3
#define SQLITE_TESTCTRL_FAULT_PENDING            4
#define SQLITE_TESTCTRL_PRNG_SAVE                5
#define SQLITE_TESTCTRL_PRNG_RESTORE             6
#define SQLITE_TESTCTRL_PRNG_RESET               7
#define SQLITE_TESTCTRL_BITVEC_TEST              8

</pre></blockquote>
</td></tr>
<tr><td valign="top">F12000</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
typedef struct sqlite3 sqlite3;

</pre></blockquote>
</td></tr>
<tr><td valign="top">F12010</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
int sqlite3_close(sqlite3 *);

</pre></blockquote>
</td></tr>
<tr><td valign="top">F12011</td><td valign="top">
The 
<a href="c3ref/close.html">sqlite3_close()</a> interface destroys an 
<a href="c3ref/sqlite3.html">sqlite3</a> object
allocated by a prior call to 
<a href="c3ref/open.html">sqlite3_open()</a>,

<a href="c3ref/open.html">sqlite3_open16()</a>, or 
<a href="c3ref/open.html">sqlite3_open_v2()</a>.
</td></tr>
<tr><td valign="top">F12012</td><td valign="top">
The 
<a href="c3ref/close.html">sqlite3_close()</a> function releases all memory used by the
connection and closes all open files.
</td></tr>
<tr><td valign="top">F12013</td><td valign="top">
If the database connection contains

<a href="c3ref/stmt.html">prepared statements</a> that have not been
finalized by 
<a href="c3ref/finalize.html">sqlite3_finalize()</a>, then 
<a href="c3ref/close.html">sqlite3_close()</a>
returns 
<a href="c3ref/c_abort.html">SQLITE_BUSY</a> and leaves the connection open.
</td></tr>
<tr><td valign="top">F12014</td><td valign="top">
Giving sqlite3_close() a NULL pointer is a harmless no-op.
</td></tr>
<tr><td valign="top">F12100</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
int sqlite3_exec(
  sqlite3*,                                  /* An open database */
  const char *sql,                           /* SQL to be evaluted */
  int (*callback)(void*,int,char**,char**),  /* Callback function */
  void *,                                    /* 1st argument to callback */
  char **errmsg                              /* Error msg written here */
);

</pre></blockquote>
</td></tr>
<tr><td valign="top">F12101</td><td valign="top">
The 
<a href="c3ref/exec.html">sqlite3_exec()</a> interface evaluates zero or more UTF-8
encoded, semicolon-separated, SQL statements in the
zero-terminated string of its 2nd parameter within the
context of the 
<a href="c3ref/sqlite3.html">sqlite3</a> object given in the 1st parameter.
</td></tr>
<tr><td valign="top">F12104</td><td valign="top">
The return value of 
<a href="c3ref/exec.html">sqlite3_exec()</a> is SQLITE_OK if all
SQL statements run successfully.
</td></tr>
<tr><td valign="top">F12105</td><td valign="top">
The return value of 
<a href="c3ref/exec.html">sqlite3_exec()</a> is an appropriate
non-zero error code if any SQL statement fails.
</td></tr>
<tr><td valign="top">F12107</td><td valign="top">
If one or more of the SQL statements handed to 
<a href="c3ref/exec.html">sqlite3_exec()</a>
return results and the 3rd parameter is not NULL, then
the callback function specified by the 3rd parameter is
invoked once for each row of result.
</td></tr>
<tr><td valign="top">F12110</td><td valign="top">
If the callback returns a non-zero value then 
<a href="c3ref/exec.html">sqlite3_exec()</a>
will aborted the SQL statement it is currently evaluating,
skip all subsequent SQL statements, and return 
<a href="c3ref/c_abort.html">SQLITE_ABORT</a>.
<todo>What happens to *errmsg here?  Does the result code for
sqlite3_errcode() get set?</todo>
</td></tr>
<tr><td valign="top">F12113</td><td valign="top">
The 
<a href="c3ref/exec.html">sqlite3_exec()</a> routine will pass its 4th parameter through