Many of the routines in the SQLite
C-language Interface
return
numeric result codes indicating either success or failure, and
in the event of a failure, providing some idea of the cause of
the failure. This document strives to explain what each
of those numeric result codes means.
1.
Result Codes versus Error Codes
"Error codes" are a subset of "result codes" that indicate that
something has gone wrong. There are only a few non-error result
codes:
SQLITE_OK
,
SQLITE_ROW
, and
SQLITE_DONE
. The term
"error code" means any result code other than these three.
2.
Primary Result Codes versus Extended Result Codes
Result codes are signed 32-bit integers.
The least significant 8 bits of the result code define a broad category
and are called the "primary result code". More significant bits provide
more detailed information about the error and are called the
"extended result code"
Note that the primary result code is always a part of the extended
result code. Given a full 32-bit extended result code, the application
can always find the corresponding primary result code merely by extracting
the least significant 8 bits of the extended result code.
All extended result codes are also error codes. Hence the terms
"extended result code" and "extended error code" are interchangeable.
For historic compatibility, the C-language interfaces return
primary result codes by default.
The extended result code for the most recent error can be
retrieved using the
sqlite3_extended_errcode()
interface.
The
sqlite3_extended_result_codes()
interface can be used to put
a
database connection
into a mode where it returns the
extended result codes instead of the primary result codes.
3.
Definitions
All result codes are integers.
Symbolic names for all result codes are created using
"#define" macros in the sqlite3.h header file.
There are separate sections in the sqlite3.h header file for
the
result code definitions
and the
extended result code definitions
.
Primary result code symbolic names are of the form "SQLITE_XXXXXX" where
XXXXXX is a sequence of uppercase alphabetic characters. Extended
result code names are of the form "SQLITE_XXXXXX_YYYYYYY" where
the XXXXXX part is the corresponding primary result code and the
YYYYYYY is an extension that further classifies the result code.
The names and numeric values for existing result codes are fixed
and unchanging. However, new result codes, and especially new extended
result codes, might appear in future releases of SQLite.
4.
Primary Result Code List
The 31 result codes are
defined in sqlite3.h
and are listed in
alphabetical order below:
SQLITE_ABORT (4)
SQLITE_AUTH (23)
SQLITE_BUSY (5)
SQLITE_CANTOPEN (14)
SQLITE_CONSTRAINT (19)
SQLITE_CORRUPT (11)
SQLITE_DONE (101)
SQLITE_EMPTY (16)
SQLITE_ERROR (1)
SQLITE_FORMAT (24)
SQLITE_FULL (13)
SQLITE_INTERNAL (2)
SQLITE_INTERRUPT (9)
SQLITE_IOERR (10)
SQLITE_LOCKED (6)
SQLITE_MISMATCH (20)
SQLITE_MISUSE (21)
SQLITE_NOLFS (22)
SQLITE_NOMEM (7)
SQLITE_NOTADB (26)
SQLITE_NOTFOUND (12)
SQLITE_NOTICE (27)
SQLITE_OK (0)
SQLITE_PERM (3)
SQLITE_PROTOCOL (15)
SQLITE_RANGE (25)
SQLITE_READONLY (8)
SQLITE_ROW (100)
SQLITE_SCHEMA (17)
SQLITE_TOOBIG (18)
SQLITE_WARNING (28)
The 74 extended result codes
are
defined in sqlite3.h
and are
listed in alphabetical order below:
SQLITE_ABORT_ROLLBACK (516)
SQLITE_AUTH_USER (279)
SQLITE_BUSY_RECOVERY (261)
SQLITE_BUSY_SNAPSHOT (517)
SQLITE_BUSY_TIMEOUT (773)
SQLITE_CANTOPEN_CONVPATH (1038)
SQLITE_CANTOPEN_DIRTYWAL (1294)
SQLITE_CANTOPEN_FULLPATH (782)
SQLITE_CANTOPEN_ISDIR (526)
SQLITE_CANTOPEN_NOTEMPDIR (270)
SQLITE_CANTOPEN_SYMLINK (1550)
SQLITE_CONSTRAINT_CHECK (275)
SQLITE_CONSTRAINT_COMMITHOOK (531)
SQLITE_CONSTRAINT_DATATYPE (3091)
SQLITE_CONSTRAINT_FOREIGNKEY (787)
SQLITE_CONSTRAINT_FUNCTION (1043)
SQLITE_CONSTRAINT_NOTNULL (1299)
SQLITE_CONSTRAINT_PINNED (2835)
SQLITE_CONSTRAINT_PRIMARYKEY (1555)
SQLITE_CONSTRAINT_ROWID (2579)
SQLITE_CONSTRAINT_TRIGGER (1811)
SQLITE_CONSTRAINT_UNIQUE (2067)
SQLITE_CONSTRAINT_VTAB (2323)
SQLITE_CORRUPT_INDEX (779)
SQLITE_CORRUPT_SEQUENCE (523)
SQLITE_CORRUPT_VTAB (267)
SQLITE_ERROR_MISSING_COLLSEQ (257)
SQLITE_ERROR_RETRY (513)
SQLITE_ERROR_SNAPSHOT (769)
SQLITE_IOERR_ACCESS (3338)
SQLITE_IOERR_AUTH (7178)
SQLITE_IOERR_BEGIN_ATOMIC (7434)
SQLITE_IOERR_BLOCKED (2826)
SQLITE_IOERR_CHECKRESERVEDLOCK (3594)
SQLITE_IOERR_CLOSE (4106)
SQLITE_IOERR_COMMIT_ATOMIC (7690)
SQLITE_IOERR_CONVPATH (6666)
SQLITE_IOERR_CORRUPTFS (8458)
SQLITE_IOERR_DATA (8202)
SQLITE_IOERR_DELETE (2570)
SQLITE_IOERR_DELETE_NOENT (5898)
SQLITE_IOERR_DIR_CLOSE (4362)
SQLITE_IOERR_DIR_FSYNC (1290)
SQLITE_IOERR_FSTAT (1802)
SQLITE_IOERR_FSYNC (1034)
SQLITE_IOERR_GETTEMPPATH (6410)
SQLITE_IOERR_LOCK (3850)
SQLITE_IOERR_MMAP (6154)
SQLITE_IOERR_NOMEM (3082)
SQLITE_IOERR_RDLOCK (2314)
SQLITE_IOERR_READ (266)
SQLITE_IOERR_ROLLBACK_ATOMIC (7946)
SQLITE_IOERR_SEEK (5642)
SQLITE_IOERR_SHMLOCK (5130)
SQLITE_IOERR_SHMMAP (5386)
SQLITE_IOERR_SHMOPEN (4618)
SQLITE_IOERR_SHMSIZE (4874)
SQLITE_IOERR_SHORT_READ (522)
SQLITE_IOERR_TRUNCATE (1546)
SQLITE_IOERR_UNLOCK (2058)
SQLITE_IOERR_VNODE (6922)
SQLITE_IOERR_WRITE (778)
SQLITE_LOCKED_SHAREDCACHE (262)
SQLITE_LOCKED_VTAB (518)
SQLITE_NOTICE_RECOVER_ROLLBACK (539)
SQLITE_NOTICE_RECOVER_WAL (283)
SQLITE_OK_LOAD_PERMANENTLY (256)
SQLITE_READONLY_CANTINIT (1288)
SQLITE_READONLY_CANTLOCK (520)
SQLITE_READONLY_DBMOVED (1032)
SQLITE_READONLY_DIRECTORY (1544)
SQLITE_READONLY_RECOVERY (264)
SQLITE_READONLY_ROLLBACK (776)
SQLITE_WARNING_AUTOINDEX (284)
6.
Result Code Meanings
The meanings for all 105
result code values are shown below,
in numeric order.
(0) SQLITE_OK
The SQLITE_OK result code means that the operation was successful and
that there were no errors. Most other result codes indicate an error.
The SQLITE_INTERNAL result code indicates an internal malfunction.
In a working version of SQLite, an application should never see this
result code. If application does encounter this result code, it shows
that there is a bug in the database engine.
SQLite does not currently generate this result code.
However,
application-defined SQL functions
or
virtual tables
, or
VFSes
, or other extensions might cause this
result code to be returned.
The SQLITE_ABORT result code indicates that an operation was aborted
prior to completion, usually be application request.
See also:
SQLITE_INTERRUPT
.
If the callback function to
sqlite3_exec()
returns non-zero, then
sqlite3_exec() will return SQLITE_ABORT.
If a
ROLLBACK
operation occurs on the same
database connection
as
a pending read or write, then the pending read or write may fail with
an SQLITE_ABORT or
SQLITE_ABORT_ROLLBACK
error.
In addition to being a result code,
the SQLITE_ABORT value is also used as a
conflict resolution mode
returned from the
sqlite3_vtab_on_conflict()
interface.
The SQLITE_BUSY result code indicates that the database file could not
be written (or in some cases read) because of concurrent activity by
some other
database connection
, usually a database connection in a
separate process.
For example, if process A is in the middle of a large write transaction
and at the same time process B attempts to start a new write transaction,
process B will get back an SQLITE_BUSY result because SQLite only supports
one writer at a time. Process B will need to wait for process A to finish
its transaction before starting a new transaction. The
sqlite3_busy_timeout()
and
sqlite3_busy_handler()
interfaces and
the
busy_timeout pragma
are available to process B to help it deal
with SQLITE_BUSY errors.
An SQLITE_BUSY error can occur at any point in a transaction: when the
transaction is first started, during any write or update operations, or
when the transaction commits.
To avoid encountering SQLITE_BUSY errors in the middle of a transaction,
the application can use
BEGIN IMMEDIATE
instead of just
BEGIN
to
start a transaction. The
BEGIN IMMEDIATE
command might itself return
SQLITE_BUSY, but if it succeeds, then SQLite guarantees that no
subsequent operations on the same database through the next
COMMIT
will return SQLITE_BUSY.
See also:
SQLITE_BUSY_RECOVERY
and
SQLITE_BUSY_SNAPSHOT
.
The SQLITE_BUSY result code differs from
SQLITE_LOCKED
in that
SQLITE_BUSY indicates a conflict with a
separate
database connection
, probably in a separate process,
whereas
SQLITE_LOCKED
indicates a conflict within the same
database connection
(or sometimes
a database connection with a
shared cache
).
(6) SQLITE_LOCKED
The SQLITE_LOCKED result code indicates that a write operation could not
continue because of a conflict within the same
database connection
or
a conflict with a different database connection that uses a
shared cache
.
For example, a
DROP TABLE
statement cannot be run while another thread
is reading from that table on the same
database connection
because
dropping the table would delete the table out from under the concurrent
reader.
The SQLITE_LOCKED result code differs from
SQLITE_BUSY
in that
SQLITE_LOCKED indicates a conflict on the same
database connection
(or on a connection with a
shared cache
) whereas
SQLITE_BUSY
indicates
a conflict with a different database connection, probably in a different
process.
(7) SQLITE_NOMEM
The SQLITE_NOMEM result code indicates that SQLite was unable to allocate
all the memory it needed to complete the operation. In other words, an
internal call to
sqlite3_malloc()
or
sqlite3_realloc()
has failed in
a case where the memory being allocated was required in order to continue
the operation.
(8) SQLITE_READONLY
The SQLITE_READONLY result code is returned when an attempt is made to
alter some data for which the current database connection does not have
write permission.
The SQLITE_INTERRUPT result code indicates that an operation was
interrupted by the
sqlite3_interrupt()
interface.
See also:
SQLITE_ABORT
The SQLITE_IOERR result code says that the operation could not finish
because the operating system reported an I/O error.
A full disk drive will normally give an
SQLITE_FULL
error rather than
an SQLITE_IOERR error.
There are many different extended result codes for I/O errors that
identify the specific I/O operation that failed.
The SQLITE_CORRUPT result code indicates that the database file has
been corrupted. See the
How To Corrupt Your Database Files
for
further discussion on how corruption can occur.
SQLITE_NOTFOUND can be returned by the
sqlite3_file_control()
interface
to indicate that the
file control opcode
passed as the third argument
was not recognized by the underlying
VFS
.
SQLITE_NOTFOUND can also be returned by the xSetSystemCall() method of
an
sqlite3_vfs
object.
SQLITE_NOTFOUND can be returned by
sqlite3_vtab_rhs_value()
to indicate
that the right-hand operand of a constraint is not available to the
xBestIndex method
that made the call.
The SQLITE_NOTFOUND result code is also used
internally by the SQLite implementation, but those internal uses are
not exposed to the application.
The SQLITE_FULL result code indicates that a write could not complete
because the disk is full. Note that this error can occur when trying
to write information into the main database file, or it can also
occur when writing into
temporary disk files
.
Sometimes applications encounter this error even though there is an
abundance of primary disk space because the error occurs when writing
into
temporary disk files
on a system where temporary files are stored
on a separate partition with much less space that the primary disk.
The SQLITE_CANTOPEN result code indicates that SQLite was unable to
open a file. The file in question might be a primary database file
or one of several
temporary disk files
.
(15) SQLITE_PROTOCOL
The SQLITE_PROTOCOL result code indicates a problem with the file locking
protocol used by SQLite. The SQLITE_PROTOCOL error is currently only
returned when using
WAL mode
and attempting to start a new transaction.
There is a race condition that can occur when two separate
database connections
both try to start a transaction at the same time
in
WAL mode
. The loser of the race backs off and tries again, after
a brief delay. If the same connection loses the locking race dozens
of times over a span of multiple seconds, it will eventually give up and
return SQLITE_PROTOCOL. The SQLITE_PROTOCOL error should appear in practice
very, very rarely, and only when there are many separate processes all
competing intensely to write to the same database.
The SQLITE_SCHEMA result code indicates that the database schema
has changed. This result code can be returned from
sqlite3_step()
for
a
prepared statement
that was generated using
sqlite3_prepare()
or
sqlite3_prepare16()
. If the database schema was changed by some other
process in between the time that the statement was prepared and the time
the statement was run, this error can result.
If a
prepared statement
is generated from
sqlite3_prepare_v2()
then
the statement is automatically re-prepared if the schema changes, up to
SQLITE_MAX_SCHEMA_RETRY
times (default: 50). The
sqlite3_step()
interface will only return SQLITE_SCHEMA back to the application if
the failure persists after these many retries.
The SQLITE_TOOBIG error code indicates that a string or BLOB was
too large. The default maximum length of a string or BLOB in SQLite is
1,000,000,000 bytes. This maximum length can be changed at compile-time
using the
SQLITE_MAX_LENGTH
compile-time option, or at run-time using
the
sqlite3_limit
(db,
SQLITE_LIMIT_LENGTH
,...) interface. The
SQLITE_TOOBIG error results when SQLite encounters a string or BLOB
that exceeds the compile-time or run-time limit.
The SQLITE_TOOBIG error code can also result when an oversized SQL
statement is passed into one of the
sqlite3_prepare_v2()
interfaces.
The maximum length of an SQL statement defaults to a much smaller
value of 1,000,000,000 bytes. The maximum SQL statement length can be
set at compile-time using
SQLITE_MAX_SQL_LENGTH
or at run-time
using
sqlite3_limit
(db,
SQLITE_LIMIT_SQL_LENGTH
,...).
(19) SQLITE_CONSTRAINT
The SQLITE_CONSTRAINT error code means that an SQL constraint violation
occurred while trying to process an SQL statement. Additional information
about the failed constraint can be found by consulting the
accompanying error message (returned via
sqlite3_errmsg()
or
sqlite3_errmsg16()
) or by looking at the
extended error code
.
The SQLITE_CONSTRAINT code can also be used as the return value from
the
xBestIndex()
method of a
virtual table
implementation. When
xBestIndex() returns SQLITE_CONSTRAINT, that indicates that the particular
combination of inputs submitted to xBestIndex() cannot result in a
usable query plan and should not be given further consideration.
The SQLITE_MISMATCH error code indicates a datatype mismatch.
SQLite is normally very forgiving about mismatches between the type of
a value and the declared type of the container in which that value is
to be stored. For example, SQLite allows the application to store
a large BLOB in a column with a declared type of BOOLEAN. But in a few
cases, SQLite is strict about types. The SQLITE_MISMATCH error is
returned in those few cases when the types do not match.
The
rowid
of a table must be an integer. Attempt to set the
rowid
to anything other than an integer (or a NULL which will be automatically
converted into the next available integer rowid) results in an
SQLITE_MISMATCH error.
(21) SQLITE_MISUSE
The SQLITE_MISUSE return code might be returned if the application uses
any SQLite interface in a way that is undefined or unsupported. For
example, using a
prepared statement
after that prepared statement has
been
finalized
might result in an SQLITE_MISUSE error.
SQLite tries to detect misuse and report the misuse using this result code.
However, there is no guarantee that the detection of misuse will be
successful. Misuse detection is probabilistic. Applications should
never depend on an SQLITE_MISUSE return value.
If SQLite ever returns SQLITE_MISUSE from any interface, that means that
the application is incorrectly coded and needs to be fixed. Do not ship
an application that sometimes returns SQLITE_MISUSE from a standard
SQLite interface because that application contains potentially serious bugs.
The SQLITE_NOLFS error can be returned on systems that do not support
large files when the database grows to be larger than what the filesystem
can handle. "NOLFS" stands for "NO Large File Support".
The SQLITE_RANGE error indices that the parameter number argument
to one of the
sqlite3_bind
routines or the
column number in one of the
sqlite3_column
routines is out of range.
The SQLITE_NOTICE result code is not returned by any C/C++ interface.
However, SQLITE_NOTICE (or rather one of its
extended error codes
)
is sometimes used as the first argument in an
sqlite3_log()
callback
to indicate that an unusual operation is taking place.
(28) SQLITE_WARNING
The SQLITE_WARNING result code is not returned by any C/C++ interface.
However, SQLITE_WARNING (or rather one of its
extended error codes
)
is sometimes used as the first argument in an
sqlite3_log()
callback
to indicate that an unusual and possibly ill-advised operation is
taking place.
The SQLITE_DONE result code indicates that an operation has completed.
The SQLITE_DONE result code is most commonly seen as a return value
from
sqlite3_step()
indicating that the SQL statement has run to
completion. But SQLITE_DONE can also be returned by other multi-step
interfaces such as
sqlite3_backup_step()
.
The
sqlite3_load_extension()
interface loads an
extension
into a single
database connection. The default behavior is for that extension to be
automatically unloaded when the database connection closes. However,
if the extension entry point returns SQLITE_OK_LOAD_PERMANENTLY instead
of SQLITE_OK, then the extension remains loaded into the process address
space after the database connection closes. In other words, the
xDlClose methods of the
sqlite3_vfs
object is not called for the
extension when the database connection closes.
The SQLITE_OK_LOAD_PERMANENTLY return code is useful to
loadable extensions
that register new
VFSes
, for example.
(257) SQLITE_ERROR_MISSING_COLLSEQ
The SQLITE_ERROR_MISSING_COLLSEQ result code means that an SQL
statement could not be prepared because a collating sequence named
in that SQL statement could not be located.
Sometimes when this error code is encountered, the
sqlite3_prepare_v2()
routine will convert the error into
SQLITE_ERROR_RETRY
and try again to prepare the SQL statement
using a different query plan that does not require the use of
the unknown collating sequence.
The SQLITE_BUSY_RECOVERY error code is an
extended error code
for
SQLITE_BUSY
that indicates that an operation could not continue
because another process is busy recovering a
WAL mode
database file
following a crash. The SQLITE_BUSY_RECOVERY error code only occurs
on
WAL mode
databases.
(262) SQLITE_LOCKED_SHAREDCACHE
The SQLITE_LOCKED_SHAREDCACHE result code indicates that access to
an SQLite data record is blocked by another database connection that
is using the same record in
shared cache mode
. When two or more
database connections share the same cache and one of the connections is
in the middle of modifying a record in that cache, then other connections
are blocked from accessing that data while the modifications are on-going
in order to prevent the readers from seeing a corrupt or partially
completed change.
(264) SQLITE_READONLY_RECOVERY
The SQLITE_READONLY_RECOVERY error code is an
extended error code
for
SQLITE_READONLY
. The SQLITE_READONLY_RECOVERY error code indicates
that a
WAL mode
database cannot be opened because the database file
needs to be recovered and recovery requires write access but only
read access is available.
The SQLITE_IOERR_READ error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error in the
VFS
layer
while trying to read from a file on disk. This error might result
from a hardware malfunction or because a filesystem came unmounted
while the file was open.
The SQLITE_CORRUPT_VTAB error code is an
extended error code
for
SQLITE_CORRUPT
used by
virtual tables
. A
virtual table
might
return SQLITE_CORRUPT_VTAB to indicate that content in the virtual table
is corrupt.
(275) SQLITE_CONSTRAINT_CHECK
The SQLITE_CONSTRAINT_CHECK error code is an
extended error code
for
SQLITE_CONSTRAINT
indicating that a
CHECK constraint
failed.
The SQLITE_AUTH_USER error code is an
extended error code
for
SQLITE_AUTH
indicating that an operation was attempted on a
database for which the logged in user lacks sufficient authorization.
The SQLITE_WARNING_AUTOINDEX result code is
passed to the callback of
sqlite3_log()
whenever
automatic indexing
is used.
This can serve as a warning to application designers that the
database might benefit from additional indexes.
(513) SQLITE_ERROR_RETRY
The SQLITE_ERROR_RETRY is used internally to provoke
sqlite3_prepare_v2()
(or one of its sibling routines for creating prepared statements) to
try again to prepare a statement that failed with an error on the
previous attempt.
(516) SQLITE_ABORT_ROLLBACK
The SQLITE_ABORT_ROLLBACK error code is an
extended error code
for
SQLITE_ABORT
indicating that an SQL statement aborted because
the transaction that was active when the SQL statement first started
was rolled back. Pending write operations always fail with this error
when a rollback occurs. A
ROLLBACK
will cause a pending read operation
to fail only if the schema was changed within the transaction being rolled
back.
The SQLITE_BUSY_SNAPSHOT error code is an
extended error code
for
SQLITE_BUSY
that occurs on
WAL mode
databases when a database
connection tries to promote a read transaction into a write transaction
but finds that another
database connection
has already written to the
database and thus invalidated prior reads.
The following scenario illustrates how an SQLITE_BUSY_SNAPSHOT error
might arise:
Process A starts a read transaction on the database and does one
or more SELECT statement. Process A keeps the transaction open.
Process B updates the database, changing values previous read by
process A.
Process A now tries to write to the database. But process A's view
of the database content is now obsolete because process B has
modified the database file after process A read from it. Hence
process A gets an SQLITE_BUSY_SNAPSHOT error.
(518) SQLITE_LOCKED_VTAB
The SQLITE_LOCKED_VTAB result code is not used by the SQLite core, but
it is available for use by extensions. Virtual table implementations
can return this result code to indicate that they cannot complete the
current operation because of locks held by other threads or processes.
The
R-Tree extension
returns this result code when an attempt is made
to update the R-Tree while another prepared statement is actively reading
the R-Tree. The update cannot proceed because any change to an R-Tree
might involve reshuffling and rebalancing of nodes, which would disrupt
read cursors, causing some rows to be repeated and other rows to be
omitted.
(520) SQLITE_READONLY_CANTLOCK
The SQLITE_READONLY_CANTLOCK error code is an
extended error code
for
SQLITE_READONLY
. The SQLITE_READONLY_CANTLOCK error code indicates
that SQLite is unable to obtain a read lock on a
WAL mode
database
because the shared-memory file associated with that database is read-only.
(522) SQLITE_IOERR_SHORT_READ
The SQLITE_IOERR_SHORT_READ error code is an
extended error code
for
SQLITE_IOERR
indicating that a read attempt in the
VFS
layer
was unable to obtain as many bytes as was requested. This might be
due to a truncated file.
(523) SQLITE_CORRUPT_SEQUENCE
The SQLITE_CORRUPT_SEQUENCE result code means that the schema of
the sqlite_sequence table is corrupt. The sqlite_sequence table
is used to help implement the
AUTOINCREMENT
feature. The
sqlite_sequence table should have the following format:
CREATE TABLE sqlite_sequence(name,seq);
If SQLite discovers that the sqlite_sequence table has any other
format, it returns the SQLITE_CORRUPT_SEQUENCE error.
(526) SQLITE_CANTOPEN_ISDIR
The SQLITE_CANTOPEN_ISDIR error code is an
extended error code
for
SQLITE_CANTOPEN
indicating that a file open operation failed because
the file is really a directory.
The SQLITE_CONSTRAINT_COMMITHOOK error code
is an
extended error code
for
SQLITE_CONSTRAINT
indicating that a
commit hook callback
returned non-zero that thus
caused the SQL statement to be rolled back.
(769) SQLITE_ERROR_SNAPSHOT
The SQLITE_ERROR_SNAPSHOT result code might be returned when attempting
to start a read transaction on an historical version of the database
by using the
sqlite3_snapshot_open()
interface. If the historical
snapshot is no longer available, then the read transaction will fail
with the SQLITE_ERROR_SNAPSHOT. This error code is only possible if
SQLite is compiled with
-DSQLITE_ENABLE_SNAPSHOT
.
(773) SQLITE_BUSY_TIMEOUT
The SQLITE_BUSY_TIMEOUT error code indicates that a blocking Posix
advisory file lock request in the VFS layer failed due to a timeout.
Blocking Posix advisory locks are only
available as a proprietary SQLite extension and even then are only
supported if SQLite is compiled with the SQLITE_EANBLE_SETLK_TIMEOUT
compile-time option.
(776) SQLITE_READONLY_ROLLBACK
The SQLITE_READONLY_ROLLBACK error code is an
extended error code
for
SQLITE_READONLY
. The SQLITE_READONLY_ROLLBACK error code indicates
that a database cannot be opened because it has a
hot journal
that
needs to be rolled back but cannot because the database is readonly.
The SQLITE_IOERR_WRITE error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error in the
VFS
layer
while trying to write into a file on disk. This error might result
from a hardware malfunction or because a filesystem came unmounted
while the file was open. This error should not occur if the filesystem
is full as there is a separate error code (SQLITE_FULL) for that purpose.
(779) SQLITE_CORRUPT_INDEX
The SQLITE_CORRUPT_INDEX result code means that SQLite detected
an entry is or was missing from an index. This is a special case of
the
SQLITE_CORRUPT
error code that suggests that the problem might
be resolved by running the
REINDEX
command, assuming no other
problems exist elsewhere in the database file.
(782) SQLITE_CANTOPEN_FULLPATH
The SQLITE_CANTOPEN_FULLPATH error code is an
extended error code
for
SQLITE_CANTOPEN
indicating that a file open operation failed because
the operating system was unable to convert the filename into a full pathname.
(1032) SQLITE_READONLY_DBMOVED
The SQLITE_READONLY_DBMOVED error code is an
extended error code
for
SQLITE_READONLY
. The SQLITE_READONLY_DBMOVED error code indicates
that a database cannot be modified because the database file has been
moved since it was opened, and so any attempt to modify the database
might result in database corruption if the processes crashes because the
rollback journal
would not be correctly named.
The SQLITE_IOERR_FSYNC error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error in the
VFS
layer
while trying to flush previously written content out of OS and/or
disk-control buffers and into persistent storage. In other words,
this code indicates a problem with the fsync() system call in unix
or the FlushFileBuffers() system call in windows.
(1038) SQLITE_CANTOPEN_CONVPATH
The SQLITE_CANTOPEN_CONVPATH error code is an
extended error code
for
SQLITE_CANTOPEN
used only by Cygwin
VFS
and indicating that
the cygwin_conv_path() system call failed while trying to open a file.
See also:
SQLITE_IOERR_CONVPATH
(1043) SQLITE_CONSTRAINT_FUNCTION
The SQLITE_CONSTRAINT_FUNCTION error code is not currently used
by the SQLite core. However, this error code is available for use
by extension functions.
(1288) SQLITE_READONLY_CANTINIT
The SQLITE_READONLY_CANTINIT result code originates in the xShmMap method
of a
VFS
to indicate that the shared memory region used by
WAL mode
exists buts its content is unreliable and unusable by the current process
since the current process does not have write permission on the shared
memory region. (The shared memory region for WAL mode is normally a
file with a "-wal" suffix that is mmapped into the process space. If
the current process does not have write permission on that file, then it
cannot write into shared memory.)
Higher level logic within SQLite will normally intercept the error code
and create a temporary in-memory shared memory region so that the current
process can at least read the content of the database. This result code
should not reach the application interface layer.
(1290) SQLITE_IOERR_DIR_FSYNC
The SQLITE_IOERR_DIR_FSYNC error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error in the
VFS
layer
while trying to invoke fsync() on a directory. The unix
VFS
attempts
to fsync() directories after creating or deleting certain files to
ensure that those files will still appear in the filesystem following
a power loss or system crash. This error code indicates a problem
attempting to perform that fsync().
(1544) SQLITE_READONLY_DIRECTORY
The SQLITE_READONLY_DIRECTORY result code indicates that the database
is read-only because process does not have permission to create
a journal file in the same directory as the database and the creation of
a journal file is a prerequisite for writing.
(1546) SQLITE_IOERR_TRUNCATE
The SQLITE_IOERR_TRUNCATE error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error in the
VFS
layer
while trying to truncate a file to a smaller size.
The SQLITE_CANTOPEN_SYMLINK result code is returned by the
sqlite3_open()
interface and its siblings when the
SQLITE_OPEN_NOFOLLOW
flag is used and the database file is
a symbolic link.
The SQLITE_IOERR_FSTAT error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error in the
VFS
layer
while trying to invoke fstat() (or the equivalent) on a file in order
to determine information such as the file size or access permissions.
The SQLITE_CONSTRAINT_TRIGGER error code
is an
extended error code
for
SQLITE_CONSTRAINT
indicating that a
RAISE function
within
a
trigger
fired, causing the SQL statement to abort.
The SQLITE_IOERR_UNLOCK error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error
within xUnlock method on the
sqlite3_io_methods
object.
The SQLITE_IOERR_RDLOCK error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error
within xLock method on the
sqlite3_io_methods
object while trying
to obtain a read lock.
The SQLITE_CONSTRAINT_VTAB error code is not currently used
by the SQLite core. However, this error code is available for use
by application-defined
virtual tables
.
The SQLITE_IOERR_DELETE error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error
within xDelete method on the
sqlite3_vfs
object.
The SQLITE_CONSTRAINT_PINNED error code
is an
extended error code
for
SQLITE_CONSTRAINT
indicating that an
UPDATE trigger
attempted
do delete the row that was being updated in the middle of the update.
(3082) SQLITE_IOERR_NOMEM
The SQLITE_IOERR_NOMEM error code is sometimes returned by the
VFS
layer to indicate that an operation could not be completed due to the
inability to allocate sufficient memory. This error code is normally
converted into
SQLITE_NOMEM
by the higher layers of SQLite before
being returned to the application.
The SQLITE_CONSTRAINT_DATATYPE error code
is an
extended error code
for
SQLITE_CONSTRAINT
indicating that an insert or update attempted
to store a value inconsistent with the column's declared type
in a table defined as STRICT.
The SQLITE_IOERR_ACCESS error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error
within the xAccess method on the
sqlite3_vfs
object.
The SQLITE_IOERR_CHECKRESERVEDLOCK error code is
an
extended error code
for
SQLITE_IOERR
indicating an I/O error
within the xCheckReservedLock method on the
sqlite3_io_methods
object.
The SQLITE_IOERR_LOCK error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error in the
advisory file locking logic.
Usually an SQLITE_IOERR_LOCK error indicates a problem obtaining
a
PENDING lock
. However it can also indicate miscellaneous
locking errors on some of the specialized
VFSes
used on Macs.
The SQLITE_IOERR_CLOSE error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error
within the xClose method on the
sqlite3_io_methods
object.
The SQLITE_IOERR_SHMOPEN error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error
within the xShmMap method on the
sqlite3_io_methods
object
while trying to open a new shared memory segment.
The SQLITE_IOERR_SHMSIZE error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error
within the xShmMap method on the
sqlite3_io_methods
object
while trying to enlarge a
"shm" file
as part of
WAL mode
transaction processing. This error may indicate that
the underlying filesystem volume is out of space.
The SQLITE_IOERR_SHMMAP error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error
within the xShmMap method on the
sqlite3_io_methods
object
while trying to map a shared memory segment into the process address space.
The SQLITE_IOERR_SEEK error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error
within the xRead or xWrite methods on the
sqlite3_io_methods
object
while trying to seek a file descriptor to the beginning point of the
file where the read or write is to occur.
The SQLITE_IOERR_DELETE_NOENT error code
is an
extended error code
for
SQLITE_IOERR
indicating that the
xDelete method on the
sqlite3_vfs
object failed because the
file being deleted does not exist.
The SQLITE_IOERR_MMAP error code is an
extended error code
for
SQLITE_IOERR
indicating an I/O error
within the xFetch or xUnfetch methods on the
sqlite3_io_methods
object
while trying to map or unmap part of the database file into the
process address space.
(6410) SQLITE_IOERR_GETTEMPPATH
The SQLITE_IOERR_GETTEMPPATH error code is an
extended error code
for
SQLITE_IOERR
indicating that the
VFS
is unable to determine
a suitable directory in which to place temporary files.
(6666) SQLITE_IOERR_CONVPATH
The SQLITE_IOERR_CONVPATH error code is an
extended error code
for
SQLITE_IOERR
used only by Cygwin
VFS
and indicating that
the cygwin_conv_path() system call failed.
See also:
SQLITE_CANTOPEN_CONVPATH
(7434) SQLITE_IOERR_BEGIN_ATOMIC
The SQLITE_IOERR_BEGIN_ATOMIC error code indicates that the
underlying operating system reported and error on the
SQLITE_FCNTL_BEGIN_ATOMIC_WRITE
file-control. This only comes
up when
SQLITE_ENABLE_ATOMIC_WRITE
is enabled and the database
is hosted on a filesystem that supports atomic writes.
(7690) SQLITE_IOERR_COMMIT_ATOMIC
The SQLITE_IOERR_COMMIT_ATOMIC error code indicates that the
underlying operating system reported and error on the
SQLITE_FCNTL_COMMIT_ATOMIC_WRITE
file-control. This only comes
up when
SQLITE_ENABLE_ATOMIC_WRITE
is enabled and the database
is hosted on a filesystem that supports atomic writes.
(7946) SQLITE_IOERR_ROLLBACK_ATOMIC
The SQLITE_IOERR_ROLLBACK_ATOMIC error code indicates that the
underlying operating system reported and error on the
SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE
file-control. This only comes
up when
SQLITE_ENABLE_ATOMIC_WRITE
is enabled and the database
is hosted on a filesystem that supports atomic writes.
The SQLITE_IOERR_DATA error code is an
extended error code
for
SQLITE_IOERR
used only by
checksum VFS shim
to indicate that
the checksum on a page of the database file is incorrect.
(8458) SQLITE_IOERR_CORRUPTFS
The SQLITE_IOERR_CORRUPTFS error code is an
extended error code
for
SQLITE_IOERR
used only by a VFS to indicate that a seek or read
failure was due to the request not falling within the file's boundary