All Constants Table

The following table lists all of the constant values provided by the ooSQLiteConstants class. Additional tables list subsets of the constant values grouped by purpose.

Constant Meaning
Compile-Time Version Constants
VERSION "3.8.1" The value of this constant will vary depending on the exact version of the SQLite database engine embedded in ooSQLite. Typically this documentation is updated when ooSQLite is upgraded to use a new version of the SQLite library so that the value shown here is current.
VERSION_NUMBER 3008001 The value of this constant will vary depending on the exact version of the SQLite database engine embedded in ooSQLite. Typically this documentation is updated when ooSQLite is upgraded to use a new version of the SQLite library so that the value shown here is current.
SOURCE_ID "2013-10-17 12:57:35 c78be6d786c19073b3a6730dfe3fb1be54f5657a" The value of this constant will vary depending on the exact version of the SQLite database engine embedded in ooSQLite. Typically this documentation is updated when ooSQLite is upgraded to use a new version of the SQLite library so that the value shown here is current.
ooSQLite Specific Result Code Constants
OO_INTERNAL_ERR The ooSQLite framework encountered an error internally that it is unprepared to handle. It was not considered possible for the error to happen.
OO_WRONG_ARG_TYPE An argument to a method or function is not the correct type. For instance the argument requires a number, but the supplied argument is not a number.
OO_UNEXPECTED_RESULT The SQLite database engine returned a result that was considered to be impossible to produce.
OO_BACKUP_IN_PROGRESS A method was invoked on this database connection object when the database is the destnation of a backup in progress.
OO_BACKUP_DB_ERRSTATE The specified source or destination database for a backup operation is in an error state.
ooSQLite Specific Result Set Format Constants
OO_ARRAY_OF_ARRAYS Result sets are returned as an array where each item in the array is an array. The array at item 1 is an array of the column names. The following items are the records of the result set.
OO_ARRAY_OF_DIRECTORIES Result sets are returned as an array where each item in the array is a Directory object. Each directory in the array contains the values of the columns in a row, where the indexes are the names of the columns.
OO_STEM_OF_STEMS Result sets are returned as a stem with the tails 0 through the number of rows. Tail 0 contains the number rows and tails 1 through n contain a stem for each row. The tails of stem of a row are the column names for the rows.
OO_CLASSIC_STEM Result sets are returned as a stem with the tails 0 through the number of rows. Tail 0 contains the number rows and tails 1 through n contain compound tails for each row. The compound tails consists of the row number combined with each column name of the row.
Result Code Constants
OK Successful result
ERROR SQL error or missing database
INTERNAL Internal logic error in SQLite
PERM Access permission denied
ABORT Callback routine requested an abort
BUSY The database file is locked
LOCKED A table in the database is locked
NOMEM A malloc() failed
READONLY Attempt to write a readonly database
INTERRUPT Operation terminated by sqlite3_interrupt()
IOERR Some kind of disk I/O error occurred
CORRUPT The database disk image is malformed
NOTFOUND Unknown opcode in sqlite3_file_control()
FULL Insertion failed because database is full
CANTOPEN Unable to open the database file
PROTOCOL Database lock protocol error
EMPTY Database is empty
SCHEMA The database schema changed
TOOBIG String or BLOB exceeds size limit
CONSTRAINT Abort due to constraint violation
MISMATCH Data type mismatch
MISUSE Library used incorrectly
NOLFS Uses OS features not supported on host
AUTH Authorization denied
FORMAT Auxiliary database format error
RANGE 2nd parameter to sqlite3_bind out of range
NOTADB File opened that is not a database file
ROW sqlite3_step() has another row ready
DONE sqlite3_step() has finished executing
IOERR_READ
IOERR_SHORT_READ
IOERR_WRITE
IOERR_FSYNC
IOERR_DIR_FSYNC
IOERR_TRUNCATE
IOERR_FSTAT
IOERR_UNLOCK
IOERR_RDLOCK
IOERR_DELETE
IOERR_BLOCKED
IOERR_NOMEM
IOERR_ACCESS
IOERR_CHECKRESERVEDLOCK
IOERR_LOCK
IOERR_CLOSE
IOERR_DIR_CLOSE
IOERR_SHMOPEN
IOERR_SHMSIZE
IOERR_SHMLOCK
IOERR_SHMMAP
IOERR_SEEK
IOERR_DELETE_NOENT
IOERR_MMAP
IOERR_GETTEMPPATH
IOERR_CONVPATH
LOCKED_SHAREDCACHE
BUSY_RECOVERY
BUSY_SNAPSHOT
CANTOPEN_NOTEMPDIR
CANTOPEN_ISDIR
CANTOPEN_FULLPATH
CANTOPEN_CONVPATH
CORRUPT_VTAB
READONLY_RECOVERY
READONLY_CANTLOCK
READONLY_ROLLBACK
READONLY_DBMOVED
ABORT_ROLLBACK
CONSTRAINT_CHECK
CONSTRAINT_COMMITHOOK
CONSTRAINT_FOREIGNKEY
CONSTRAINT_FUNCTION
CONSTRAINT_NOTNULL
CONSTRAINT_PRIMARYKEY
CONSTRAINT_TRIGGER
CONSTRAINT_UNIQUE
CONSTRAINT_VTAB
NOTICE_RECOVER_WAL
NOTICE_RECOVER_ROLLBACK
WARNING_AUTOINDEX
File Open Constants
OPEN_READONLY Ok for sqlite3_open_v2(). The database is opened in read-only mode. If the database does not already exist, an error is returned.
OPEN_READWRITE Ok for sqlite3_open_v2(). The database is opened for reading and writing if possible, or reading only if the file is write protected by the operating system. In either case the database must already exist, otherwise an error is returned
OPEN_CREATE Ok for sqlite3_open_v2(). When merged with OPEN_READWRITE, the database is opened for reading and writing, and is created if it does not already exist.
OPEN_DELETEONCLOSE VFS only
OPEN_EXCLUSIVE VFS only
OPEN_AUTOPROXY VFS only
OPEN_URI Ok for sqlite3_open_v2()
OPEN_MAIN_DB VFS only
OPEN_TEMP_DB VFS only
OPEN_TRANSIENT_DB VFS only
OPEN_MAIN_JOURNAL VFS only
OPEN_TEMP_JOURNAL VFS only
OPEN_SUBJOURNAL VFS only
OPEN_MASTER_JOURNAL VFS only
OPEN_NOMUTEX Ok for sqlite3_open_v2()
OPEN_FULLMUTEX Ok for sqlite3_open_v2()
OPEN_SHAREDCACHE Ok for sqlite3_open_v2()
OPEN_PRIVATECACHE Ok for sqlite3_open_v2()
OPEN_WAL VFS only
Authorizer Action Constants
CREATE_INDEX
CREATE_TABLE
CREATE_TEMP_INDEX
CREATE_TEMP_TABLE
CREATE_TEMP_TRIGGER
CREATE_TEMP_VIEW
CREATE_TRIGGER
CREATE_VIEW
DELETE
DROP_INDEX
DROP_TABLE
DROP_TEMP_INDEX
DROP_TEMP_TABLE
DROP_TEMP_TRIGGER
DROP_TEMP_VIEW
DROP_TRIGGER
DROP_VIEW
INSERT
PRAGMA
READ
SELECT
TRANSACTION
UPDATE
ATTACH
DETACH
ALTER_TABLE
REINDEX
ANALYZE
CREATE_VTABLE
DROP_VTABLE
FUNCTION
SAVEPOINT
RECURSIVE
Authorizer Return Code Constants
DENY Abort the SQL statement with an error
IGNORE Don't allow access, but don't generate an error
xAccess VFS Method Constants
ACCESS_EXISTS
ACCESS_READWRITE Used by PRAGMA temp_store_directory
ACCESS_READ Unused
Checkpoint Operation Parameter Constants
CHECKPOINT_PASSIVE
CHECKPOINT_FULL
CHECKPOINT_RESTART
Configuration Option Constants
CONFIG_SINGLETHREAD nil
CONFIG_MULTITHREAD nil
CONFIG_SERIALIZED nil
CONFIG_MALLOC sqlite3_mem_methods*
CONFIG_GETMALLOC sqlite3_mem_methods*
CONFIG_SCRATCH void*, int sz, int N
CONFIG_PAGECACHE void*, int sz, int N
CONFIG_HEAP void*, int nByte, int min
CONFIG_MEMSTATUS boolean
CONFIG_MUTEX sqlite3_mutex_methods*
CONFIG_GETMUTEX sqlite3_mutex_methods*
CONFIG_LOOKASIDE int int
CONFIG_PCACHE no-op
CONFIG_GETPCACHE no-op
CONFIG_LOG xFunc, void*
CONFIG_URI int
CONFIG_PCACHE2 sqlite3_pcache_methods2*
CONFIG_GETPCACHE2 sqlite3_pcache_methods2*
CONFIG_COVERING_INDEX_SCAN int
CONFIG_SQLLOG xSqllog, void*
CONFIG_MMAP_SIZE sqlite3_int64, sqlite3_int64
CONFIG_WIN32_HEAPSIZE int nByte
DB Connection Configuration Constants
DBCONFIG_LOOKASIDE void* int int
DBCONFIG_ENABLE_FKEY int int*
DBCONFIG_ENABLE_TRIGGER int int*
DB Status Parameter Constants
DBSTATUS_LOOKASIDE_USED
DBSTATUS_CACHE_USED
DBSTATUS_SCHEMA_USED
DBSTATUS_STMT_USED
DBSTATUS_LOOKASIDE_HIT
DBSTATUS_LOOKASIDE_MISS_SIZE
DBSTATUS_LOOKASIDE_MISS_FULL
DBSTATUS_CACHE_HIT
DBSTATUS_CACHE_MISS
DBSTATUS_CACHE_WRITE
DBSTATUS_MAX Largest defined DBSTATUS
File Control Opcode Constants
FCNTL_LOCKSTATE
GET_LOCKPROXYFILE
SET_LOCKPROXYFILE
LAST_ERRNO
FCNTL_SIZE_HINT
FCNTL_CHUNK_SIZE
FCNTL_FILE_POINTER
FCNTL_SYNC_OMITTED
FCNTL_WIN32_AV_RETRY
FCNTL_PERSIST_WAL
FCNTL_OVERWRITE
FCNTL_VFSNAME
FCNTL_POWERSAFE_OVERWRITE
FCNTL_PRAGMA
FCNTL_BUSYHANDLER
FCNTL_TEMPFILENAME
FCNTL_MMAP_SIZE
FCNTL_TRACE
FCNTL_HAS_MOVED
FCNTL_SYNC
FCNTL_COMMIT_PHASETWO
Fundamental Datatype Constants
INTEGER
FLOAT
BLOB
SQLNULL
TEXT
Device Characteristic Constants
IOCAP_ATOMIC
IOCAP_ATOMIC512
IOCAP_ATOMIC1K
IOCAP_ATOMIC2K
IOCAP_ATOMIC4K
IOCAP_ATOMIC8K
IOCAP_ATOMIC16K
IOCAP_ATOMIC32K
IOCAP_ATOMIC64K
IOCAP_SAFE_APPEND
IOCAP_SEQUENTIAL
IOCAP_UNDELETABLE_WHEN_OPEN
IOCAP_POWERSAFE_OVERWRITE
Run-Time Limit Constants
LIMIT_LENGTH
LIMIT_SQL_LENGTH
LIMIT_COLUMN
LIMIT_EXPR_DEPTH
LIMIT_COMPOUND_SELECT
LIMIT_VDBE_OP
LIMIT_FUNCTION_ARG
LIMIT_ATTACHED
LIMIT_LIKE_PATTERN_LENGTH
LIMIT_VARIABLE_NUMBER
LIMIT_TRIGGER_DEPTH
File Locking Constants
LOCK_NONE
LOCK_SHARED
LOCK_RESERVED
LOCK_PENDING
LOCK_EXCLUSIVE
Mutex Type Constants
MUTEX_FAST
MUTEX_RECURSIVE
MUTEX_STATIC_MASTER
MUTEX_STATIC_MEM sqlite3_malloc()
MUTEX_STATIC_OPEN sqlite3BtreeOpen()
MUTEX_STATIC_PRNG sqlite3_random()
MUTEX_STATIC_LRU lru page list
MUTEX_STATIC_PMEM sqlite3PageMalloc()
xShmLock VFS Constants
SHM_UNLOCK
SHM_LOCK
SHM_SHARED
SHM_EXCLUSIVE
Destructor Behavior Constants
STATIC
TRANSIENT
Status Parameter Constants
STATUS_MEMORY_USED
STATUS_PAGECACHE_USED
STATUS_PAGECACHE_OVERFLOW
STATUS_SCRATCH_USED
STATUS_SCRATCH_OVERFLOW
STATUS_MALLOC_SIZE
STATUS_PARSER_STACK
STATUS_PAGECACHE_SIZE
STATUS_SCRATCH_SIZE
STATUS_MALLOC_COUNT
Status Parameter Constants (Stmt)
STMTSTATUS_FULLSCAN_STEP This is the number of times that SQLite has stepped forward in a table as part of a full table scan. Large numbers for this counter may indicate opportunities for performance improvement through careful use of indices.
STMTSTATUS_SORT This is the number of sort operations that have occurred. A non-zero value in this counter may indicate an opportunity to improvement performance through careful use of indices.
STMTSTATUS_AUTOINDEX This is the number of rows inserted into transient indices that were created automatically in order to help joins run faster. A non-zero value in this counter may indicate an opportunity to improvement performance by adding permanent indices that do not need to be reinitialized each time the statement is run.
STMTSTATUS_VM_STEP This is the number of virtual machine operations executed by the prepared statement if that number is less than or equal to 2147483647. The number of virtual machine operations can be used as a proxy for the total work done by the prepared statement. If the number of virtual machine operations exceeds 2147483647 then the value returned by this statement status code is undefined.
Synchronization Constants
SYNC_NORMAL
SYNC_FULL
SYNC_DATAONLY
Text Encoding Constants
UTF8
UTF16LE
UTF16BE
UTF16 Use native byte order
ANY Deprecated
UTF16_ALIGNED sqlite3_create_collation only
DETERMINISTIC
Virtual Table Config Option Constants
VTAB_CONSTRAINT_SUPPORT