requirements.html

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

of C that is set at compile-time.
</td></tr>
<tr><td valign="top">F12764</td><td valign="top">
A successful call to 
<a href="c3ref/limit.html">sqlite3_limit(D,C,V)</a> where V is zero
changes the limit on the size of construct C in

<a href="c3ref/sqlite3.html">database connection</a> D to be the hard upper bound on the size
of C that is set at compile-time.
</td></tr>
<tr><td valign="top">F12766</td><td valign="top">
A successful call to 
<a href="c3ref/limit.html">sqlite3_limit(D,C,V)</a> where V is negative
leaves the state of 
<a href="c3ref/sqlite3.html">database connection</a> D unchanged.
</td></tr>
<tr><td valign="top">F12769</td><td valign="top">
A successful call to 
<a href="c3ref/limit.html">sqlite3_limit(D,C,V)</a> returns the
value of the limit on the size of construct C in
in 
<a href="c3ref/sqlite3.html">database connection</a> D as it was prior to the call.
</td></tr>
<tr><td valign="top">F12790</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
#define SQLITE_LIMIT_LENGTH                    0
#define SQLITE_LIMIT_SQL_LENGTH                1
#define SQLITE_LIMIT_COLUMN                    2
#define SQLITE_LIMIT_EXPR_DEPTH                3
#define SQLITE_LIMIT_COMPOUND_SELECT           4
#define SQLITE_LIMIT_VDBE_OP                   5
#define SQLITE_LIMIT_FUNCTION_ARG              6
#define SQLITE_LIMIT_ATTACHED                  7
#define SQLITE_LIMIT_LIKE_PATTERN_LENGTH       8
#define SQLITE_LIMIT_VARIABLE_NUMBER           9

</pre></blockquote>
</td></tr>
<tr><td valign="top">F12800</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
int sqlite3_errcode(sqlite3 *db);
const char *sqlite3_errmsg(sqlite3*);
const void *sqlite3_errmsg16(sqlite3*);

</pre></blockquote>
</td></tr>
<tr><td valign="top">F12801</td><td valign="top">
The 
<a href="c3ref/errcode.html">sqlite3_errcode(D)</a> interface returns the numeric

<a href="c3ref/c_abort.html">result code</a> or

<a href="c3ref/c_ioerr_blocked.html">extended result code</a>
for the most recently failed interface call associated
with 
<a href="c3ref/sqlite3.html">database connection</a> D.
</td></tr>
<tr><td valign="top">F12803</td><td valign="top">
The 
<a href="c3ref/errcode.html">sqlite3_errmsg(D)</a> and 
<a href="c3ref/errcode.html">sqlite3_errmsg16(D)</a>
interfaces return English-language text that describes
the error in the mostly recently failed interface call,
encoded as either UTF8 or UTF16 respectively.
</td></tr>
<tr><td valign="top">F12807</td><td valign="top">
The strings returned by 
<a href="c3ref/errcode.html">sqlite3_errmsg()</a> and 
<a href="c3ref/errcode.html">sqlite3_errmsg16()</a>
are valid until the next SQLite interface call.
</td></tr>
<tr><td valign="top">F12808</td><td valign="top">
Calls to API routines that do not return an error code
(example: 
<a href="c3ref/data_count.html">sqlite3_data_count()</a>) do not
change the error code or message returned by

<a href="c3ref/errcode.html">sqlite3_errcode()</a>, 
<a href="c3ref/errcode.html">sqlite3_errmsg()</a>, or 
<a href="c3ref/errcode.html">sqlite3_errmsg16()</a>.
</td></tr>
<tr><td valign="top">F12809</td><td valign="top">
Interfaces that are not associated with a specific

<a href="c3ref/sqlite3.html">database connection</a> (examples:

<a href="c3ref/mprintf.html">sqlite3_mprintf()</a> or 
<a href="c3ref/enable_shared_cache.html">sqlite3_enable_shared_cache()</a>
do not change the values returned by

<a href="c3ref/errcode.html">sqlite3_errcode()</a>, 
<a href="c3ref/errcode.html">sqlite3_errmsg()</a>, or 
<a href="c3ref/errcode.html">sqlite3_errmsg16()</a>.
</td></tr>
<tr><td valign="top">F12850</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
int sqlite3_table_column_metadata(
  sqlite3 *db,                /* Connection handle */
  const char *zDbName,        /* Database name or NULL */
  const char *zTableName,     /* Table name */
  const char *zColumnName,    /* Column name */
  char const **pzDataType,    /* OUTPUT: Declared data type */
  char const **pzCollSeq,     /* OUTPUT: Collation sequence name */
  int *pNotNull,              /* OUTPUT: True if NOT NULL constraint exists */
  int *pPrimaryKey,           /* OUTPUT: True if column part of PK */
  int *pAutoinc               /* OUTPUT: True if column is auto-increment */
);

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

</pre></blockquote>
</td></tr>
<tr><td valign="top">F12911</td><td valign="top">
The callback function registered by 
<a href="c3ref/progress_handler.html">sqlite3_progress_handler()</a>
is invoked periodically during long running calls to

<a href="c3ref/step.html">sqlite3_step()</a>.
</td></tr>
<tr><td valign="top">F12912</td><td valign="top">
The progress callback is invoked once for every N virtual
machine opcodes, where N is the second argument to
the 
<a href="c3ref/progress_handler.html">sqlite3_progress_handler()</a> call that registered
the callback.  <todo>What if N is less than 1?</todo>
</td></tr>
<tr><td valign="top">F12913</td><td valign="top">
The progress callback itself is identified by the third
argument to 
<a href="c3ref/progress_handler.html">sqlite3_progress_handler()</a>.
</td></tr>
<tr><td valign="top">F12914</td><td valign="top">
The fourth argument 
<a href="c3ref/progress_handler.html">sqlite3_progress_handler()</a> is a
void pointer passed to the progress callback
function each time it is invoked.
</td></tr>
<tr><td valign="top">F12915</td><td valign="top">
If a call to 
<a href="c3ref/step.html">sqlite3_step()</a> results in fewer than
N opcodes being executed,
then the progress callback is never invoked. {END}
</td></tr>
<tr><td valign="top">F12916</td><td valign="top">
Every call to 
<a href="c3ref/progress_handler.html">sqlite3_progress_handler()</a>
overwrites any previously registere progress handler.
</td></tr>
<tr><td valign="top">F12917</td><td valign="top">
If the progress handler callback is NULL then no progress
handler is invoked.
</td></tr>
<tr><td valign="top">F12918</td><td valign="top">
If the progress callback returns a result other than 0, then
the behavior is a if 
<a href="c3ref/interrupt.html">sqlite3_interrupt()</a> had been called.
</td></tr>
<tr><td valign="top">F12930</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
int sqlite3_get_autocommit(sqlite3*);

</pre></blockquote>
</td></tr>
<tr><td valign="top">F12931</td><td valign="top">
The 
<a href="c3ref/get_autocommit.html">sqlite3_get_autocommit(D)</a> interface returns non-zero or
zero if the 
<a href="c3ref/sqlite3.html">database connection</a> D is or is not in autocommit
mode, respectively.
</td></tr>
<tr><td valign="top">F12932</td><td valign="top">
Autocommit mode is on by default.
</td></tr>
<tr><td valign="top">F12933</td><td valign="top">
Autocommit mode is disabled by a successful 
<a href="lang_transaction.html">BEGIN</a> statement.
</td></tr>
<tr><td valign="top">F12934</td><td valign="top">
Autocommit mode is enabled by a successful 
<a href="lang_transaction.html">COMMIT</a> or 
<a href="lang_transaction.html">ROLLBACK</a>
statement.
</td></tr>
<tr><td valign="top">F12950</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
void *sqlite3_commit_hook(sqlite3*, int(*)(void*), void*);
void *sqlite3_rollback_hook(sqlite3*, void(*)(void *), void*);

</pre></blockquote>
</td></tr>
<tr><td valign="top">F12951</td><td valign="top">
The 
<a href="c3ref/commit_hook.html">sqlite3_commit_hook(D,F,P)</a> interface registers the
callback function F to be invoked with argument P whenever
a transaction commits on 
<a href="c3ref/sqlite3.html">database connection</a> D.
</td></tr>
<tr><td valign="top">F12952</td><td valign="top">
The 
<a href="c3ref/commit_hook.html">sqlite3_commit_hook(D,F,P)</a> interface returns the P
argument from the previous call with the same

<a href="c3ref/sqlite3.html">database connection</a> D , or NULL on the first call
for a particular 
<a href="c3ref/sqlite3.html">database connection</a> D.
</td></tr>
<tr><td valign="top">F12953</td><td valign="top">
Each call to 
<a href="c3ref/commit_hook.html">sqlite3_commit_hook()</a> overwrites the callback
registered by prior calls.
</td></tr>
<tr><td valign="top">F12954</td><td valign="top">
If the F argument to 
<a href="c3ref/commit_hook.html">sqlite3_commit_hook(D,F,P)</a> is NULL
then the commit hook callback is cancelled and no callback
is invoked when a transaction commits.
</td></tr>
<tr><td valign="top">F12955</td><td valign="top">
If the commit callback returns non-zero then the commit is
converted into a rollback.
</td></tr>
<tr><td valign="top">F12961</td><td valign="top">
The 
<a href="c3ref/commit_hook.html">sqlite3_rollback_hook(D,F,P)</a> interface registers the
callback function F to be invoked with argument P whenever
a transaction rolls back on 
<a href="c3ref/sqlite3.html">database connection</a> D.
</td></tr>
<tr><td valign="top">F12962</td><td valign="top">
The 
<a href="c3ref/commit_hook.html">sqlite3_rollback_hook(D,F,P)</a> interface returns the P
argument from the previous call with the same

<a href="c3ref/sqlite3.html">database connection</a> D , or NULL on the first call
for a particular 
<a href="c3ref/sqlite3.html">database connection</a> D.
</td></tr>
<tr><td valign="top">F12963</td><td valign="top">
Each call to 
<a href="c3ref/commit_hook.html">sqlite3_rollback_hook()</a> overwrites the callback
registered by prior calls.
</td></tr>
<tr><td valign="top">F12964</td><td valign="top">
If the F argument to 
<a href="c3ref/commit_hook.html">sqlite3_rollback_hook(D,F,P)</a> is NULL
then the rollback hook callback is cancelled and no callback
is invoked when a transaction rolls back.
</td></tr>
<tr><td valign="top">F12970</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
void *sqlite3_update_hook(
  sqlite3*, 
  void(*)(void *,int ,char const *,char const *,sqlite3_int64),
  void*
);

</pre></blockquote>
</td></tr>
<tr><td valign="top">F12971</td><td valign="top">
The 
<a href="c3ref/update_hook.html">sqlite3_update_hook(D,F,P)</a> interface causes callback
function F to be invoked with first parameter P whenever
a table row is modified, inserted, or deleted on

<a href="c3ref/sqlite3.html">database connection</a> D.
</td></tr>
<tr><td valign="top">F12973</td><td valign="top">
The 
<a href="c3ref/update_hook.html">sqlite3_update_hook(D,F,P)</a> interface returns the value
of P for the previous call on the same 
<a href="c3ref/sqlite3.html">database connection</a> D,
or NULL for the first call.
</td></tr>
<tr><td valign="top">F12975</td><td valign="top">
If the update hook callback F in 
<a href="c3ref/update_hook.html">sqlite3_update_hook(D,F,P)</a>
is NULL then the no update callbacks are made.
</td></tr>
<tr><td valign="top">F12977</td><td valign="top">
Each call to 
<a href="c3ref/update_hook.html">sqlite3_update_hook(D,F,P)</a> overrides prior calls
to the same interface on the same 
<a href="c3ref/sqlite3.html">database connection</a> D.
</td></tr>
<tr><td valign="top">F12979</td><td valign="top">
The update hook callback is not invoked when internal system
tables such as sqlite_master and sqlite_sequence are modified.
</td></tr>
<tr><td valign="top">F12981</td><td valign="top">
The second parameter to the update callback
is one of 
<a href="c3ref/c_alter_table.html">SQLITE_INSERT</a>, 
<a href="c3ref/c_alter_table.html">SQLITE_DELETE</a> or 
<a href="c3ref/c_alter_table.html">SQLITE_UPDATE</a>,
depending on the operation that caused the callback to be invoked.
</td></tr>
<tr><td valign="top">F12983</td><td valign="top">
The third and fourth arguments to the callback contain pointers
to zero-terminated UTF-8 strings which are the names of the
database and table that is being updated.
</td></tr>
<tr><td valign="top">F12985</td><td valign="top">
The final callback parameter is the rowid of the row after
the change occurs.
</td></tr>
<tr><td valign="top">F13000</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
typedef struct sqlite3_stmt sqlite3_stmt;

</pre></blockquote>
</td></tr>
<tr><td valign="top">F13010</td><td valign="top">
The sqlite3.h header file defines the following interfaces:
<blockquote><pre>
int sqlite3_prepare(
  sqlite3 *db,            /* Database handle */
  const char *zSql,       /* SQL statement, UTF-8 encoded */
  int nByte,              /* Maximum length of zSql in bytes. */
  sqlite3_stmt **ppStmt,  /* OUT: Statement handle */
  const char **pzTail     /* OUT: Pointer to unused portion of zSql */
);
int sqlite3_prepare_v2(
  sqlite3 *db,            /* Database handle */
  const char *zSql,       /* SQL statement, UTF-8 encoded */
  int nByte,              /* Maximum length of zSql in bytes. */
  sqlite3_stmt