APSW Module

The module is the main interface to SQLite. Methods and data on the module have process wide effects.

Type Annotations

Comprehensive type annotations are included, and your code using apsw can be checked using tools like mypy. You can refer to the types below for your annotations (eg as apsw.SQLiteValue)


.. class:: SQLiteValue

    | `Union <https://docs.python.org/3/library/typing.html#typing.Union>`__ [None, int, float, bytes, str]

    SQLite supports 5 types - None (NULL), 64 bit signed int, 64 bit
    float, bytes, and unicode text


.. class:: SQLiteValues

    | `Union <https://docs.python.org/3/library/typing.html#typing.Union>`__ [`Tuple <https://docs.python.org/3/library/typing.html#typing.Tuple>`__ [()], `Tuple <https://docs.python.org/3/library/typing.html#typing.Tuple>`__ [:class:`SQLiteValue`, ...]]

    A sequence of zero or more :class:`SQLiteValue`


.. class:: Bindings

    | `Union <https://docs.python.org/3/library/typing.html#typing.Union>`__ [`Sequence <https://docs.python.org/3/library/typing.html#typing.Sequence>`__ [`Union <https://docs.python.org/3/library/typing.html#typing.Union>`__ [:class:`SQLiteValue`, :class:`zeroblob`]], `Dict <https://docs.python.org/3/library/typing.html#typing.Dict>`__ [str, `Union <https://docs.python.org/3/library/typing.html#typing.Union>`__ [:class:`SQLiteValue`, :class:`zeroblob`]]]

    Query bindings are either a sequence of :class:`SQLiteValue`, or a dict mapping names
    to :class:`SQLiteValues`.  You can also provide :class:`zeroblob` in :class:`Bindings`.


.. class:: AggregateT

    | `Any <https://docs.python.org/3/library/typing.html#typing.Any>`__ 

    An object provided as first parameter of step and final aggregate functions


.. class:: AggregateStep

    | `Union <https://docs.python.org/3/library/typing.html#typing.Union>`__ [
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`AggregateT`], None],
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`AggregateT`, :class:`SQLiteValue`], None],
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`AggregateT`, :class:`SQLiteValue`, :class:`SQLiteValue`], None],
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`AggregateT`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`], None],
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`AggregateT`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`], None],
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`AggregateT`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`], None],
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`AggregateT`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`], None],
    | ]

    :class:`AggregateStep` is called on each matching row with the relevant number of :class:`SQLiteValue`


.. class:: AggregateFinal

    | `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`AggregateT`], :class:`SQLiteValue`]

    Final is called after all matching rows have been processed by step, and returns a :class:`SQLiteValue`


.. class:: AggregateFactory

    | `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[], `Tuple <https://docs.python.org/3/library/typing.html#typing.Tuple>`__ [:class:`AggregateT`, :class:`AggregateStep`, :class:`AggregateFinal`]]

    Called each time for the start of a new calculation using an aggregate function,
    returning an object, a step function and a final function


.. class:: ScalarProtocol

    | `Union <https://docs.python.org/3/library/typing.html#typing.Union>`__ [
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[], :class:`SQLiteValue`],
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`SQLiteValue`], :class:`SQLiteValue`],
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`SQLiteValue`, :class:`SQLiteValue`], :class:`SQLiteValue`],
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`], :class:`SQLiteValue`],
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`], :class:`SQLiteValue`],
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`], :class:`SQLiteValue`],
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`], :class:`SQLiteValue`],
    |         `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`, :class:`SQLiteValue`], :class:`SQLiteValue`]
    | ]

    Scalar callbacks take zero or more :class:`SQLiteValues`, and return a :class:`SQLiteValue`


.. class:: RowTracer

    | `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`Cursor`, :class:`SQLiteValues`], `Any <https://docs.python.org/3/library/typing.html#typing.Any>`__ ]

    Row tracers are called with the :class:`Cursor`, and the row that would
    be returned.  If you return None, then no row is returned, otherwise
    whatever is returned is returned as a result row for the query


.. class:: ExecTracer

    | `Callable <https://docs.python.org/3/library/typing.html#typing.Callable>`__ [[:class:`Cursor`, str, `Optional <https://docs.python.org/3/library/typing.html#typing.Optional>`__ [:class:`Bindings`]], bool]

    Execution tracers are called with the cursor, sql query text, and the bindings
    used.  Return False/None to abort execution, or True to continue

API Reference

SQLITE_VERSION_NUMBER: int

The integer version number of SQLite that APSW was compiled against. For example SQLite 3.6.4 will have the value 3006004. This number may be different than the actual library in use if the library is shared and has been updated. Call sqlitelibversion() to get the actual library version.

apswversion() → str

Returns the APSW version.

compile_options: Tuple[str, ...]

A tuple of the options used to compile SQLite. For example it will be something like this:

('ENABLE_LOCKING_STYLE=0', 'TEMP_STORE=1', 'THREADSAFE=1')

Calls: sqlite3_compileoption_get

complete(statement: str) → bool

Returns True if the input string comprises one or more complete SQL statements by looking for an unquoted trailing semi-colon.

An example use would be if you were prompting the user for SQL statements and needed to know if you had a whole statement, or needed to ask for another line:

statement = input("SQL> ")
while not apsw.complete(statement):
   more = input("  .. ")
   statement = statement + "\\n" + more

Calls: sqlite3_complete

config(op: int, *args: Any) → None
Parameters

Many operations don’t make sense from a Python program. The following configuration operations are supported: SQLITE_CONFIG_LOG, SQLITE_CONFIG_SINGLETHREAD, SQLITE_CONFIG_MULTITHREAD, SQLITE_CONFIG_SERIALIZED, SQLITE_CONFIG_URI, SQLITE_CONFIG_MEMSTATUS, SQLITE_CONFIG_COVERING_INDEX_SCAN, SQLITE_CONFIG_PCACHE_HDRSZ, SQLITE_CONFIG_PMASZ, and SQLITE_CONFIG_STMTJRNL_SPILL.

See tips for an example of how to receive log messages (SQLITE_CONFIG_LOG)

Calls: sqlite3_config

connection_hooks: List[Callable[[Connection], None]]

The purpose of the hooks is to allow the easy registration of functions, virtual tables or similar items with each Connection as it is created. The default value is an empty list. Whenever a Connection is created, each item in apsw.connection_hooks is invoked with a single parameter being the new Connection object. If the hook raises an exception then the creation of the Connection fails.

If you wanted to store your own defined functions in the database then you could define a hook that looked in the relevant tables, got the Python text and turned it into the functions.

enablesharedcache(enable: bool) → None

If you use the same Connection across threads or use multiple connections accessing the same file, then SQLite can share the cache between them. It is not recommended that you use this.

Calls: sqlite3_enable_shared_cache

exceptionfor(code: int) → Exception

If you would like to raise an exception that corresponds to a particular SQLite error code then call this function. It also understands extended error codes.

For example to raise SQLITE_IOERR_ACCESS:

raise apsw.exceptionfor(apsw.SQLITE_IOERR_ACCESS)
fork_checker() → None

Note This method is not available on Windows as it does not support the fork system call.

SQLite does not allow the use of database connections across forked processes (see the SQLite FAQ Q6). (Forking creates a child process that is a duplicate of the parent including the state of all data structures in the program. If you do this to SQLite then parent and child would both consider themselves owners of open databases and silently corrupt each other’s work and interfere with each other’s locks.)

One example of how you may end up using fork is if you use the multiprocessing module which uses fork to make child processes.

If you do use fork or multiprocessing on a platform that supports fork then you must ensure database connections and their objects (cursors, backup, blobs etc) are not used in the parent process, or are all closed before calling fork or starting a Process. (Note you must call close to ensure the underlying SQLite objects are closed. It is also a good idea to call gc.collect(2) to ensure anything you may have missed is also deallocated.)

Once you run this method, extra checking code is inserted into SQLite’s mutex operations (at a very small performance penalty) that verifies objects are not used across processes. You will get a ForkingViolationError if you do so. Note that due to the way Python’s internals work, the exception will be delivered to sys.excepthook in addition to the normal exception mechanisms and may be reported by Python after the line where the issue actually arose. (Destructors of objects you didn’t close also run between lines.)

You should only call this method as the first line after importing APSW, as it has to shutdown and re-initialize SQLite. If you have any SQLite objects already allocated when calling the method then the program will later crash. The recommended use is to use the fork checking as part of your test suite.

format_sql_value(value: SQLiteValue) → str

Returns a Python string representing the supplied value in SQL syntax.

initialize() → None

It is unlikely you will want to call this method as SQLite automatically initializes.

Calls: sqlite3_initialize

keywords: Set[str]

A set containing every SQLite keyword

Calls:
log(errorcode: int, message: str) → None

Calls the SQLite logging interface. Note that you must format the message before passing it to this method:

apsw.log(apsw.SQLITE_NOMEM, f"Need { needed } bytes of memory")

See tips for an example of how to receive log messages.

Calls: sqlite3_log

main()

Call this to run the interactive shell. It automatically passes in sys.argv[1:] and exits Python when done.

memoryhighwater(reset: bool = False) → int

Returns the maximum amount of memory SQLite has used. If reset is True then the high water mark is reset to the current value.

See also

status()

Calls: sqlite3_memory_highwater

memoryused() → int

Returns the amount of memory SQLite is currently using.

See also

status()

Calls: sqlite3_memory_used

randomness(amount: int) → bytes

Gets random data from SQLite’s random number generator.

Parameters

amount – How many bytes to return

Calls: sqlite3_randomness

releasememory(amount: int) → int

Requests SQLite try to free amount bytes of memory. Returns how many bytes were freed.

Calls: sqlite3_release_memory

shutdown() → None

It is unlikely you will want to call this method and there is no need to do so. It is a really bad idea to call it unless you are absolutely sure all connections, blobs, cursors, vfs etc have been closed, deleted and garbage collected.

Calls: sqlite3_shutdown

softheaplimit(limit: int) → int

Requests SQLite try to keep memory usage below amount bytes and returns the previous limit.

Calls: sqlite3_soft_heap_limit64

sqlite3_sourceid() → str

Returns the exact checkin information for the SQLite 3 source being used.

Calls: sqlite3_sourceid

sqlitelibversion() → str

Returns the version of the SQLite library. This value is queried at run time from the library so if you use shared libraries it will be the version in the shared library.

Calls: sqlite3_libversion

status(op: int, reset: bool = False) → Tuple[int, int]

Returns current and highwater measurements.

Parameters

  • op – A status parameter

  • reset – If True then the highwater is set to the current value

Returns

A tuple of current value and highwater value

See also

Calls: sqlite3_status64

using_amalgamation: bool

If True then SQLite amalgamation is in use (statically compiled into APSW). Using the amalgamation means that SQLite shared libraries are not used and will not affect your code.

vfsnames() → List[str]

Returns a list of the currently installed vfs. The first item in the list is the default vfs.

SQLite constants

SQLite has many constants used in various interfaces. To use a constant such as SQLITE_OK, just use apsw.SQLITE_OK.

The same values can be used in different contexts. For example SQLITE_OK and SQLITE_CREATE_INDEX both have a value of zero. For each group of constants there is also a mapping (dict) available that you can supply a string to and get the corresponding numeric value, or supply a numeric value and get the corresponding string. These can help improve diagnostics/logging, calling other modules etc. For example:

apsw.mapping_authorizer_function["SQLITE_READ"] == 20
apsw.mapping_authorizer_function[20] == "SQLITE_READ"

mapping_access Flags for the xAccess VFS method

mapping_authorizer_function Authorizer Action Codes

mapping_authorizer_return Authorizer Return Codes

mapping_bestindex_constraints Virtual Table Constraint Operator Codes

mapping_config Configuration Options

mapping_conflict_resolution_modes Conflict resolution modes

mapping_db_config Database Connection Configuration Options

mapping_db_status Status Parameters for database connections

mapping_device_characteristics Device Characteristics

mapping_extended_result_codes Extended Result Codes

SQLITE_ABORT_ROLLBACK, SQLITE_AUTH_USER, SQLITE_BUSY_RECOVERY, SQLITE_BUSY_SNAPSHOT, SQLITE_BUSY_TIMEOUT, SQLITE_CANTOPEN_CONVPATH, SQLITE_CANTOPEN_DIRTYWAL, SQLITE_CANTOPEN_FULLPATH, SQLITE_CANTOPEN_ISDIR, SQLITE_CANTOPEN_NOTEMPDIR, SQLITE_CANTOPEN_SYMLINK, SQLITE_CONSTRAINT_CHECK, SQLITE_CONSTRAINT_COMMITHOOK, SQLITE_CONSTRAINT_DATATYPE, SQLITE_CONSTRAINT_FOREIGNKEY, SQLITE_CONSTRAINT_FUNCTION, SQLITE_CONSTRAINT_NOTNULL, SQLITE_CONSTRAINT_PINNED, SQLITE_CONSTRAINT_PRIMARYKEY, SQLITE_CONSTRAINT_ROWID, SQLITE_CONSTRAINT_TRIGGER, SQLITE_CONSTRAINT_UNIQUE, SQLITE_CONSTRAINT_VTAB, SQLITE_CORRUPT_INDEX, SQLITE_CORRUPT_SEQUENCE, SQLITE_CORRUPT_VTAB, SQLITE_ERROR_MISSING_COLLSEQ, SQLITE_ERROR_RETRY, SQLITE_ERROR_SNAPSHOT, SQLITE_IOERR_ACCESS, SQLITE_IOERR_AUTH, SQLITE_IOERR_BEGIN_ATOMIC, SQLITE_IOERR_BLOCKED, SQLITE_IOERR_CHECKRESERVEDLOCK, SQLITE_IOERR_CLOSE, SQLITE_IOERR_COMMIT_ATOMIC, SQLITE_IOERR_CONVPATH, SQLITE_IOERR_CORRUPTFS, SQLITE_IOERR_DATA, SQLITE_IOERR_DELETE, SQLITE_IOERR_DELETE_NOENT, SQLITE_IOERR_DIR_CLOSE, SQLITE_IOERR_DIR_FSYNC, SQLITE_IOERR_FSTAT, SQLITE_IOERR_FSYNC, SQLITE_IOERR_GETTEMPPATH, SQLITE_IOERR_LOCK, SQLITE_IOERR_MMAP, SQLITE_IOERR_NOMEM, SQLITE_IOERR_RDLOCK, SQLITE_IOERR_READ, SQLITE_IOERR_ROLLBACK_ATOMIC, SQLITE_IOERR_SEEK, SQLITE_IOERR_SHMLOCK, SQLITE_IOERR_SHMMAP, SQLITE_IOERR_SHMOPEN, SQLITE_IOERR_SHMSIZE, SQLITE_IOERR_SHORT_READ, SQLITE_IOERR_TRUNCATE, SQLITE_IOERR_UNLOCK, SQLITE_IOERR_VNODE, SQLITE_IOERR_WRITE, SQLITE_LOCKED_SHAREDCACHE, SQLITE_LOCKED_VTAB, SQLITE_NOTICE_RECOVER_ROLLBACK, SQLITE_NOTICE_RECOVER_WAL, SQLITE_OK_LOAD_PERMANENTLY, SQLITE_OK_SYMLINK, SQLITE_READONLY_CANTINIT, SQLITE_READONLY_CANTLOCK, SQLITE_READONLY_DBMOVED, SQLITE_READONLY_DIRECTORY, SQLITE_READONLY_RECOVERY, SQLITE_READONLY_ROLLBACK, SQLITE_WARNING_AUTOINDEX

mapping_file_control Standard File Control Opcodes

SQLITE_FCNTL_BEGIN_ATOMIC_WRITE, SQLITE_FCNTL_BUSYHANDLER, SQLITE_FCNTL_CHUNK_SIZE, SQLITE_FCNTL_CKPT_DONE, SQLITE_FCNTL_CKPT_START, SQLITE_FCNTL_CKSM_FILE, SQLITE_FCNTL_COMMIT_ATOMIC_WRITE, SQLITE_FCNTL_COMMIT_PHASETWO, SQLITE_FCNTL_DATA_VERSION, SQLITE_FCNTL_EXTERNAL_READER, SQLITE_FCNTL_FILE_POINTER, SQLITE_FCNTL_GET_LOCKPROXYFILE, SQLITE_FCNTL_HAS_MOVED, SQLITE_FCNTL_JOURNAL_POINTER, SQLITE_FCNTL_LAST_ERRNO, SQLITE_FCNTL_LOCKSTATE, SQLITE_FCNTL_LOCK_TIMEOUT, SQLITE_FCNTL_MMAP_SIZE, SQLITE_FCNTL_OVERWRITE, SQLITE_FCNTL_PDB, SQLITE_FCNTL_PERSIST_WAL, SQLITE_FCNTL_POWERSAFE_OVERWRITE, SQLITE_FCNTL_PRAGMA, SQLITE_FCNTL_RBU, SQLITE_FCNTL_RESERVE_BYTES, SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE, SQLITE_FCNTL_SET_LOCKPROXYFILE, SQLITE_FCNTL_SIZE_HINT, SQLITE_FCNTL_SIZE_LIMIT, SQLITE_FCNTL_SYNC, SQLITE_FCNTL_SYNC_OMITTED, SQLITE_FCNTL_TEMPFILENAME, SQLITE_FCNTL_TRACE, SQLITE_FCNTL_VFSNAME, SQLITE_FCNTL_VFS_POINTER, SQLITE_FCNTL_WAL_BLOCK, SQLITE_FCNTL_WIN32_AV_RETRY, SQLITE_FCNTL_WIN32_GET_HANDLE, SQLITE_FCNTL_WIN32_SET_HANDLE, SQLITE_FCNTL_ZIPVFS

mapping_limits Run-Time Limit Categories

mapping_locking_level File Locking Levels

mapping_open_flags Flags For File Open Operations

mapping_result_codes Result Codes

mapping_status Status Parameters

mapping_sync Synchronization Type Flags

mapping_txn_state Allowed return values from [sqlite3_txn_state()]

mapping_virtual_table_configuration_options Virtual Table Configuration Options

mapping_virtual_table_scan_flags Virtual Table Scan Flags

mapping_wal_checkpoint Checkpoint Mode Values

mapping_xshmlock_flags Flags for the xShmLock VFS method