:mod:`!sqlite3` --- DB-API 2.0 interface for SQLite databases
Python 3.14 Docs · نسخهٔ 3.14.10 · PSF License
:mod:!sqlite3 --- DB-API 2.0 interface for SQLite databases
:synopsis: A DB-API 2.0 implementation using SQLite 3.x.
Source code: Lib/sqlite3/
import sqlite3 src = sqlite3.connect(":memory:", isolation_level=None) dst = sqlite3.connect("tutorial.db", isolation_level=None) src.backup(dst) src.close() dst.close() del src, dst
SQLite is a C library that provides a lightweight disk-based database that doesn't require a separate server process and allows accessing the database using a nonstandard variant of the SQL query language. Some applications can use SQLite for internal data storage. It's also possible to prototype an application using SQLite and then port the code to a larger database such as PostgreSQL or Oracle.
The !sqlite3 module was written by Gerhard Häring. It provides an SQL interface compliant with the DB-API 2.0 specification described by 249, and requires the third-party SQLite <https://sqlite.org/>_ library.
This document includes four main sections:
sqlite3-tutorialteaches how to use the!sqlite3module.sqlite3-referencedescribes the classes and functions this module
defines.
sqlite3-howtosdetails how to handle specific tasks.sqlite3-explanationprovides in-depth background on
transaction control.
https://www.sqlite.org The SQLite web page; the documentation describes the syntax and the available data types for the supported SQL dialect.
https://www.w3schools.com/sql/ Tutorial, reference and examples for learning SQL syntax.
249 - Database API Specification 2.0 PEP written by Marc-André Lemburg.
- UPPERCASE for keywords
- snake_case for schema
- single quotes for string literals
- singular for table names
- if needed, use double quotes for table and column names
Tutorial
In this tutorial, you will create a database of Monty Python movies using basic !sqlite3 functionality. It assumes a fundamental understanding of database concepts, including cursors_ and transactions_.
First, we need to create a new database and open a database connection to allow !sqlite3 to work with it. Call sqlite3.connect to create a connection to the database tutorial.db in the current working directory, implicitly creating it if it does not exist:
import sqlite3 con = sqlite3.connect("tutorial.db")
The returned Connection object `con` represents the connection to the on-disk database.
In order to execute SQL statements and fetch results from SQL queries, we will need to use a database cursor. Call con.cursor() <Connection.cursor> to create the Cursor:
cur = con.cursor()
Now that we've got a database connection and a cursor, we can create a database table `movie with columns for title, release year, and review score. For simplicity, we can just use column names in the table declaration -- thanks to the flexible typing_ feature of SQLite, specifying the data types is optional. Execute the CREATE TABLE statement by calling cur.execute(...) <Cursor.execute>`:
cur.execute("CREATE TABLE movie(title, year, score)")
but SQLite versions older than 3.33.0 do not recognise that variant.
We can verify that the new table has been created by querying the `sqlite_master table built-in to SQLite, which should now contain an entry for the movie table definition (see The Schema Table_ for details). Execute that query by calling cur.execute(...) <Cursor.execute>, assign the result to res, and call res.fetchone() <Cursor.fetchone>` to fetch the resulting row:
توجه: >> res = cur.execute("SELECT name FROM sqlite_master") >> res.fetchone()
('movie',)
We can see that the table has been created, as the query returns a tuple containing the table's name. If we query `sqlite_master for a non-existent table spam, !res.fetchone will return None`:
توجه: >> res = cur.execute("SELECT name FROM sqlite_master WHERE name='spam'") >> res.fetchone() is None
True
Now, add two rows of data supplied as SQL literals by executing an `INSERT statement, once again by calling cur.execute(...) <Cursor.execute>`:
cur.execute(""" INSERT INTO movie VALUES ('Monty Python and the Holy Grail', 1975, 8.2), ('And Now for Something Completely Different', 1971, 7.5) """)
The `INSERT statement implicitly opens a transaction, which needs to be committed before changes are saved in the database (see sqlite3-controlling-transactions for details). Call con.commit() <Connection.commit>` on the connection object to commit the transaction:
con.commit()
We can verify that the data was inserted correctly by executing a `SELECT query. Use the now-familiar cur.execute(...) <Cursor.execute> to assign the result to res, and call res.fetchall() <Cursor.fetchall>` to return all resulting rows:
توجه: >> res = cur.execute("SELECT score FROM movie") >> res.fetchall()
[(8.2,), (7.5,)]
The result is a list of two !tuple\s, one per row, each containing that row's `score` value.
Now, insert three more rows by calling cur.executemany(...) <Cursor.executemany>:
data = [ ("Monty Python Live at the Hollywood Bowl", 1982, 7.9), ("Monty Python's The Meaning of Life", 1983, 7.5), ("Monty Python's Life of Brian", 1979, 8.0), ] cur.executemany("INSERT INTO movie VALUES(?, ?, ?)", data) con.commit() # Remember to commit the transaction after executing INSERT.
Notice that `? placeholders are used to bind data to the query. Always use placeholders instead of string formatting <tut-formatting> to bind Python values to SQL statements, to avoid SQL injection attacks_ (see sqlite3-placeholders` for more details).
We can verify that the new rows were inserted by executing a `SELECT` query, this time iterating over the results of the query:
توجه: >> for row in cur.execute("SELECT year, title FROM movie ORDER BY year"):
... print(row) (1971, 'And Now for Something Completely Different') (1975, 'Monty Python and the Holy Grail') (1979, "Monty Python's Life of Brian") (1982, 'Monty Python Live at the Hollywood Bowl') (1983, "Monty Python's The Meaning of Life")
Each row is a two-item tuple of `(year, title)`, matching the columns selected in the query.
Finally, verify that the database has been written to disk by calling con.close() <Connection.close> to close the existing connection, opening a new one, creating a new cursor, then querying the database:
توجه: >> con.close() >> new_con = sqlite3.connect("tutorial.db") >> new_cur = new_con.cursor() >> res = new_cur.execute("SELECT title, year FROM movie ORDER BY score DESC") >> title, year = res.fetchone() >> print(f'The highest scoring Monty Python movie is {title!r}, released in {year}')
The highest scoring Monty Python movie is 'Monty Python and the Holy Grail', released in 1975
توجه: >> new_con.close()
You've now created an SQLite database using the !sqlite3 module, inserted data and retrieved values from it in multiple ways.
sqlite3-howtosfor further reading:
sqlite3-placeholderssqlite3-adapterssqlite3-converterssqlite3-connection-context-managersqlite3-howto-row-factory
sqlite3-explanationfor in-depth background on transaction control.
Reference
Module functions
isolation_level="DEFERRED", check_same_thread=True, \ factory=sqlite3.Connection, cached_statements=128, \ uri=False, *, \ autocommit=sqlite3.LEGACY_TRANSACTION_CONTROL)
Open a connection to an SQLite database.
:param database: The path to the database file to be opened. You can pass `":memory:" to create an SQLite database existing only in memory <https://sqlite.org/inmemorydb.html>_, and open a connection to it. :type database: path-like object`
:param float timeout: How many seconds the connection should wait before raising an OperationalError when a table is locked. If another connection opens a transaction to modify a table, that table will be locked until the transaction is committed. Default five seconds.
:param int detect_types: Control whether and how data types not natively supported by SQLite <sqlite3-types> are looked up to be converted to Python types, using the converters registered with register_converter. Set it to any combination (using `|, bitwise or) of PARSE_DECLTYPES and PARSE_COLNAMES to enable this. Column names take precedence over declared types if both flags are set. By default (0`), type detection is disabled.
:param isolation_level: Control legacy transaction handling behaviour. See Connection.isolation_level and sqlite3-transaction-control-isolation-level for more information. Can be `"DEFERRED" (default), "EXCLUSIVE" or "IMMEDIATE"; or None to disable opening transactions implicitly. Has no effect unless Connection.autocommit is set to ~sqlite3.LEGACY_TRANSACTION_CONTROL` (the default). :type isolation_level: str | None
:param bool check_same_thread: If `True (default), ProgrammingError will be raised if the database connection is used by a thread other than the one that created it. If False, the connection may be accessed in multiple threads; write operations may need to be serialized by the user to avoid data corruption. See threadsafety` for more information.
:param ~sqlite3.Connection factory: A custom subclass of Connection to create the connection with, if not the default Connection class.
:param int cached_statements: The number of statements that !sqlite3 should internally cache for this connection, to avoid parsing overhead. By default, 128 statements.
:param bool uri: If set to `True, *database* is interpreted as a URI (Uniform Resource Identifier) with a file path and an optional query string. The scheme part *must* be "file:", and the path can be relative or absolute. The query string allows passing parameters to SQLite, enabling various sqlite3-uri-tricks`.
:param autocommit: Control 249 transaction handling behaviour. See Connection.autocommit and sqlite3-transaction-control-autocommit for more information. *autocommit* currently defaults to ~sqlite3.LEGACY_TRANSACTION_CONTROL. The default will change to `False` in a future Python release. :type autocommit: bool
:rtype: ~sqlite3.Connection
Added the *uri* parameter.
*database* can now also be a path-like object, not only a string.
Added the `sqlite3.connect/handle` auditing event.
Added the *autocommit* parameter.
Positional use of the parameters *timeout*, *detect_types*, *isolation_level*, *check_same_thread*, *factory*, *cached_statements*, and *uri* is deprecated. They will become keyword-only parameters in Python 3.15.
Return `True` if the string *statement* appears to contain one or more complete SQL statements. No syntactic verification or parsing of any kind is performed, other than checking that there are no unclosed string literals and the statement is terminated by a semicolon.
For example:
توجه: >> sqlite3.complete_statement("SELECT foo FROM bar;")
True
توجه: >> sqlite3.complete_statement("SELECT foo")
False
This function may be useful during command-line input to determine if the entered text seems to form a complete SQL statement, or if additional input is needed before calling ~Cursor.execute.
See !runsource in Lib/sqlite3/__main__.py for real-world use.
Enable or disable callback tracebacks. By default you will not get any tracebacks in user-defined functions, aggregates, converters, authorizer callbacks etc. If you want to debug them, you can call this function with *flag* set to `True. Afterwards, you will get tracebacks from callbacks on sys.stderr. Use False` to disable the feature again.
Errors in user-defined function callbacks are logged as unraisable exceptions. Use an unraisable hook handler <sys.unraisablehook> for introspection of the failed callback.
Register an *adapter* callable to adapt the Python type *type* into an SQLite type. The adapter is called with a Python object of type *type* as its sole argument, and must return a value of a type that SQLite natively understands <sqlite3-types>.
Register the *converter* callable to convert SQLite objects of type *typename* into a Python object of a specific type. The converter is invoked for all SQLite values of type *typename*; it is passed a bytes object and should return an object of the desired Python type. Consult the parameter *detect_types* of connect for information regarding how type detection works.
Note: *typename* and the name of the type in your query are matched case-insensitively.
Module constants
Set ~Connection.autocommit to this constant to select old style (pre-Python 3.12) transaction control behaviour. See sqlite3-transaction-control-isolation-level for more information.
Pass this flag value to the *detect_types* parameter of connect to look up a converter function using the declared types for each column. The types are declared when the database table is created. !sqlite3 will look up a converter function using the first word of the declared type as the converter dictionary key. For example:
CREATE TABLE test(
i integer primary key, ! will look up a converter named "integer"
p point, ! will look up a converter named "point"
n number(10) ! will look up a converter named "number"
)
This flag may be combined with :const:`PARSE_COLNAMES` using the ``|``
(bitwise or) operator.
.. note::
Generated fields (for example ``MAX(p)``) are returned as :class:`str`.
Use :const:`!PARSE_COLNAMES` to enforce types for such queries.Pass this flag value to the *detect_types* parameter of connect to look up a converter function by using the type name, parsed from the query column name, as the converter dictionary key. The query column name must be wrapped in double quotes (`") and the type name must be wrapped in square brackets ([]`).
SELECT MAX(p) as "p [point]" FROM test; ! will look up converter "point"
This flag may be combined with :const:`PARSE_DECLTYPES` using the ``|``
(bitwise or) operator.SQLITE_DENY SQLITE_IGNORE
Flags that should be returned by the *authorizer_callback* callable passed to Connection.set_authorizer, to indicate whether:
- Access is allowed (
!SQLITE_OK), - The SQL statement should be aborted with an error (
!SQLITE_DENY) - The column should be treated as a `
NULLvalue (!SQLITE_IGNORE`)
String constant stating the supported DB-API level. Required by the DB-API. Hard-coded to `"2.0"`.
String constant stating the type of parameter marker formatting expected by the !sqlite3 module. Required by the DB-API. Hard-coded to `"qmark"`.
The `named` DB-API parameter style is also supported.
Version number of the runtime SQLite library as a string <str>.
Version number of the runtime SQLite library as a tuple of integers <int>.
Integer constant required by the DB-API 2.0, stating the level of thread safety the !sqlite3 module supports. This attribute is set based on the default threading mode <https://sqlite.org/threadsafe.html>_ the underlying SQLite library is compiled with. The SQLite threading modes are:
- Single-thread: In this mode, all mutexes are disabled and SQLite is
unsafe to use in more than a single thread at once.
- Multi-thread: In this mode, SQLite can be safely used by multiple
threads provided that no single database connection is used simultaneously in two or more threads.
- Serialized: In serialized mode, SQLite can be safely used by
multiple threads with no restriction.
The mappings from SQLite threading modes to DB-API 2.0 threadsafety levels are as follows:
+------------------+----------------------+----------------------+-------------------------------+
| SQLite threading | `threadsafety | SQLITE_THREADSAFE_ | DB-API 2.0 meaning |
| mode | <0249#threadsafety>` |
+==================+======================+======================+===============================+
| single-thread | 0 | 0 | Threads may not share the |
| module |
+------------------+----------------------+----------------------+-------------------------------+
| multi-thread | 1 | 2 | Threads may share the module, |
| but not connections |
+------------------+----------------------+----------------------+-------------------------------+
| serialized | 3 | 1 | Threads may share the module, |
| connections and cursors |
+------------------+----------------------+----------------------+-------------------------------+
Set *threadsafety* dynamically instead of hard-coding it to `1`.
SQLITE_DBCONFIG_DQS_DDL SQLITE_DBCONFIG_DQS_DML SQLITE_DBCONFIG_ENABLE_FKEY SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION SQLITE_DBCONFIG_ENABLE_QPSG SQLITE_DBCONFIG_ENABLE_TRIGGER SQLITE_DBCONFIG_ENABLE_VIEW SQLITE_DBCONFIG_LEGACY_ALTER_TABLE SQLITE_DBCONFIG_LEGACY_FILE_FORMAT SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE SQLITE_DBCONFIG_RESET_DATABASE SQLITE_DBCONFIG_TRIGGER_EQP SQLITE_DBCONFIG_TRUSTED_SCHEMA SQLITE_DBCONFIG_WRITABLE_SCHEMA
These constants are used for the Connection.setconfig and ~Connection.getconfig methods.
The availability of these constants varies depending on the version of SQLite Python was compiled with.
https://www.sqlite.org/c3ref/c_dbconfig_defensive.html SQLite docs: Database Connection Configuration Options
The !version and !version_info constants.
Connection objects
Each open SQLite database is represented by a `Connection object, which is created using sqlite3.connect. Their main purpose is creating Cursor objects, and sqlite3-controlling-transactions`.
sqlite3-connection-shortcutssqlite3-connection-context-manager
A ResourceWarning is emitted if close is not called before a !Connection object is deleted.
An SQLite database connection has the following attributes and methods:
Create and return a Cursor object. The cursor method accepts a single optional parameter *factory*. If supplied, this must be a callable returning an instance of Cursor or its subclasses.
Open a Blob handle to an existing BLOB (Binary Large OBject).
:param str table: The name of the table where the blob is located.
:param str column: The name of the column where the blob is located.
:param int rowid: The row id where the blob is located.
:param bool readonly: Set to `True if the blob should be opened without write permissions. Defaults to False`.
:param str name: The name of the database where the blob is located. Defaults to `"main"`.
:raises OperationalError: When trying to open a blob in a `WITHOUT ROWID` table.
:rtype: Blob
The blob size cannot be changed using the Blob class. Use the SQL function `zeroblob` to create a blob with a fixed size.
Commit any pending transaction to the database. If autocommit is `True, or there is no open transaction, this method does nothing. If !autocommit is False`, a new transaction is implicitly opened if a pending transaction was committed by this method.
Roll back to the start of any pending transaction. If autocommit is `True, or there is no open transaction, this method does nothing. If !autocommit is False`, a new transaction is implicitly opened if a pending transaction was rolled back by this method.
Close the database connection. If autocommit is `False, any pending transaction is implicitly rolled back. If !autocommit is True or LEGACY_TRANSACTION_CONTROL, no implicit transaction control is executed. Make sure to commit` before closing to avoid losing pending changes.
Create a new Cursor object and call ~Cursor.execute on it with the given *sql* and *parameters*. Return the new cursor object.
Create a new Cursor object and call ~Cursor.executemany on it with the given *sql* and *parameters*. Return the new cursor object.
Create a new Cursor object and call ~Cursor.executescript on it with the given *sql_script*. Return the new cursor object.
Create or remove a user-defined SQL function.
:param str name: The name of the SQL function.
:param int narg: The number of arguments the SQL function can accept. If `-1`, it may take any number of arguments.
:param func: A callable that is called when the SQL function is invoked. The callable must return :ref:a type natively supported by SQLite <sqlite3-types>. Set to `None to remove an existing SQL function. :type func: callback` | None
:param bool deterministic: If `True, the created SQL function is marked as deterministic <https://sqlite.org/deterministic.html>`_, which allows SQLite to perform additional optimizations.
Added the *deterministic* parameter.
Example:
توجه: >> import hashlib >> def md5sum(t):
... return hashlib.md5(t).hexdigest()
توجه: >> con = sqlite3.connect(":memory:") >> con.create_function("md5", 1, md5sum) >> for row in con.execute("SELECT md5(?)", (b"foo",)):
... print(row) ('acbd18db4cc2f85cedef654fccc4a4d8',)
توجه: >> con.close()
Passing *name*, *narg*, and *func* as keyword arguments is deprecated. These parameters will become positional-only in Python 3.15.
Create or remove a user-defined SQL aggregate function.
:param str name: The name of the SQL aggregate function.
:param int n_arg: The number of arguments the SQL aggregate function can accept. If `-1`, it may take any number of arguments.
:param aggregate_class: A class must implement the following methods:
- `
step()`: Add a row to the aggregate. - `
finalize()`: Return the final result of the aggregate as
a type natively supported by SQLite <sqlite3-types>.
The number of arguments that the `step()` method must accept is controlled by *n_arg*.
Set to `None to remove an existing SQL aggregate function. :type aggregate_class: class` | None
Example:
class MySum: def __init__(self): self.count = 0
def step(self, value): self.count += value
def finalize(self): return self.count
con = sqlite3.connect(":memory:") con.create_aggregate("mysum", 1, MySum) cur = con.execute("CREATE TABLE test(i)") cur.execute("INSERT INTO test(i) VALUES(1)") cur.execute("INSERT INTO test(i) VALUES(2)") cur.execute("SELECT mysum(i) FROM test") print(cur.fetchone()[0])
con.close()
:hide:
3
Passing *name*, *n_arg*, and *aggregate_class* as keyword arguments is deprecated. These parameters will become positional-only in Python 3.15.
Create or remove a user-defined aggregate window function.
:param str name: The name of the SQL aggregate window function to create or remove.
:param int num_params: The number of arguments the SQL aggregate window function can accept. If `-1`, it may take any number of arguments.
:param aggregate_class: A class that must implement the following methods:
- `
step()`: Add a row to the current window. - `
value()`: Return the current value of the aggregate. - `
inverse()`: Remove a row from the current window. - `
finalize()`: Return the final result of the aggregate as
a type natively supported by SQLite <sqlite3-types>.
The number of arguments that the `step() and value()` methods must accept is controlled by *num_params*.
Set to `None` to remove an existing SQL aggregate window function.
:raises NotSupportedError: If used with a version of SQLite older than 3.25.0, which does not support aggregate window functions.
:type aggregate_class: class | None
Example:
# Example taken from https://www.sqlite.org/windowfunctions.html#udfwinfunc class WindowSumInt: def __init__(self): self.count = 0
def step(self, value): """Add a row to the current window.""" self.count += value
def value(self): """Return the current value of the aggregate.""" return self.count
def inverse(self, value): """Remove a row from the current window.""" self.count -= value
def finalize(self): """Return the final value of the aggregate.
Any clean-up actions should be placed here. """ return self.count
con = sqlite3.connect(":memory:") cur = con.execute("CREATE TABLE test(x, y)") values = [ ("a", 4), ("b", 5), ("c", 3), ("d", 8), ("e", 1), ] cur.executemany("INSERT INTO test VALUES(?, ?)", values) con.create_window_function("sumint", 1, WindowSumInt) cur.execute(""" SELECT x, sumint(y) OVER ( ORDER BY x ROWS BETWEEN 1 PRECEDING AND 1 FOLLOWING ) AS sum_y FROM test ORDER BY x """) print(cur.fetchall()) con.close()
:hide:
[('a', 9), ('b', 12), ('c', 16), ('d', 12), ('e', 9)]
Create a collation named *name* using the collating function *callable*. *callable* is passed two string <str> arguments, and it should return an integer <int>:
- `
1` if the first is ordered higher than the second - `
-1` if the first is ordered lower than the second - `
0` if they are ordered equal
The following example shows a reverse sorting collation:
def collate_reverse(string1, string2): if string1 == string2: return 0 elif string1 < string2: return 1 else: return -1
con = sqlite3.connect(":memory:") con.create_collation("reverse", collate_reverse)
cur = con.execute("CREATE TABLE test(x)") cur.executemany("INSERT INTO test(x) VALUES(?)", [("a",), ("b",)]) cur.execute("SELECT x FROM test ORDER BY x COLLATE reverse") for row in cur: print(row) con.close()
:hide:
('b',) ('a',)
Remove a collation function by setting *callable* to `None`.
The collation name can contain any Unicode character. Earlier, only ASCII characters were allowed.
Call this method from a different thread to abort any queries that might be executing on the connection. Aborted queries will raise an OperationalError.
Register callable *authorizer_callback* to be invoked for each attempt to access a column of a table in the database. The callback should return one of SQLITE_OK, SQLITE_DENY, or SQLITE_IGNORE to signal how access to the column should be handled by the underlying SQLite library.
The first argument to the callback signifies what kind of operation is to be authorized. The second and third argument will be arguments or `None depending on the first argument. The 4th argument is the name of the database ("main", "temp", etc.) if applicable. The 5th argument is the name of the inner-most trigger or view that is responsible for the access attempt or None` if this access attempt is directly from input SQL code.
Please consult the SQLite documentation about the possible values for the first argument and the meaning of the second and third argument depending on the first one. All necessary constants are available in the !sqlite3 module.
Passing `None` as *authorizer_callback* will disable the authorizer.
Added support for disabling the authorizer using `None`.
Passing *authorizer_callback* as a keyword argument is deprecated. The parameter will become positional-only in Python 3.15.
Register callable *progress_handler* to be invoked for every *n* instructions of the SQLite virtual machine. This is useful if you want to get called from SQLite during long-running operations, for example to update a GUI.
If you want to clear any previously installed progress handler, call the method with `None` for *progress_handler*.
Returning a non-zero value from the handler function will terminate the currently executing query and cause it to raise a DatabaseError exception.
Passing *progress_handler* as a keyword argument is deprecated. The parameter will become positional-only in Python 3.15.
Register callable *trace_callback* to be invoked for each SQL statement that is actually executed by the SQLite backend.
The only argument passed to the callback is the statement (as str) that is being executed. The return value of the callback is ignored. Note that the backend does not only run statements passed to the Cursor.execute methods. Other sources include the transaction management <sqlite3-controlling-transactions> of the !sqlite3 module and the execution of triggers defined in the current database.
Passing `None` as *trace_callback* will disable the trace callback.
Exceptions raised in the trace callback are not propagated. As a development and debugging aid, use ~sqlite3.enable_callback_tracebacks to enable printing tracebacks from exceptions raised in the trace callback.
Passing *trace_callback* as a keyword argument is deprecated. The parameter will become positional-only in Python 3.15.
Enable the SQLite engine to load SQLite extensions from shared libraries if *enabled* is `True`; else, disallow loading SQLite extensions. SQLite extensions can define new functions, aggregates or whole new virtual table implementations. One well-known extension is the fulltext-search extension distributed with SQLite.
The !sqlite3 module is not built with loadable extension support by default, because some platforms (notably macOS) have SQLite libraries which are compiled without this feature. To get loadable extension support, you must pass the --enable-loadable-sqlite-extensions option to configure.
Added the `sqlite3.enable_load_extension` auditing event.
way to skip it.
con.enable_load_extension(True)
# Load the fulltext search extension
con.execute("select load_extension('./fts3.so')")
# alternatively you can load the extension using an API call:
# con.load_extension("./fts3.so")
# disable extension loading again
con.enable_load_extension(False)
# example from SQLite wiki
con.execute("CREATE VIRTUAL TABLE recipe USING fts3(name, ingredients)")
con.executescript("""
INSERT INTO recipe (name, ingredients) VALUES('broccoli stew', 'broccoli peppers cheese tomatoes');
INSERT INTO recipe (name, ingredients) VALUES('pumpkin stew', 'pumpkin onions garlic celery');
INSERT INTO recipe (name, ingredients) VALUES('broccoli pie', 'broccoli cheese onions flour');
INSERT INTO recipe (name, ingredients) VALUES('pumpkin pie', 'pumpkin sugar flour butter');
""")
for row in con.execute("SELECT rowid, name, ingredients FROM recipe WHERE name MATCH 'pie'"):
print(row)
.. method:: load_extension(path, /, *, entrypoint=None)
Load an SQLite extension from a shared library.
Enable extension loading with :meth:`enable_load_extension` before
calling this method.
The path to the SQLite extension.
Entry point name.
If ``None`` (the default),
SQLite will come up with an entry point name of its own;
see the SQLite docs `Loading an Extension`_ for details.
.. audit-event:: sqlite3.load_extension connection,path sqlite3.Connection.load_extension
.. versionadded:: 3.2
.. versionchanged:: 3.10
Added the ``sqlite3.load_extension`` auditing event.
.. versionchanged:: 3.12
Added the *entrypoint* parameter.
.. _Loading an Extension: https://www.sqlite.org/loadext.html#loading_an_extension
.. method:: iterdump(*, filter=None)
Return an :term:`iterator` to dump the database as SQL source code.
Useful when saving an in-memory database for later restoration.
Similar to the ``.dump`` command in the :program:`sqlite3` shell.
An optional ``LIKE`` pattern for database objects to dump, e.g. ``prefix_%``.
If ``None`` (the default), all database objects will be included.
Example:
.. testcode::
# Convert file example.db to SQL dump file dump.sql
con = sqlite3.connect('example.db')
with open('dump.sql', 'w') as f:
for line in con.iterdump():
f.write('%s\n' % line)
con.close()
.. seealso::
.. versionchanged:: 3.13
Added the *filter* parameter.
.. method:: backup(target, *, pages=-1, progress=None, name="main", sleep=0.250)
Create a backup of an SQLite database.
Works even if the database is being accessed by other clients
or concurrently by the same connection.
The database connection to save the backup to.
The number of pages to copy at a time.
If equal to or less than ``0``,
the entire database is copied in a single step.
Defaults to ``-1``.
If set to a :term:`callable`,
it is invoked with three integer arguments for every backup iteration:
the *status* of the last iteration,
the *remaining* number of pages still to be copied,
and the *total* number of pages.
Defaults to ``None``.
The name of the database to back up.
Either ``"main"`` (the default) for the main database,
``"temp"`` for the temporary database,
or the name of a custom database as attached using the
``ATTACH DATABASE`` SQL statement.
The number of seconds to sleep between successive attempts
to back up remaining pages.
Example 1, copy an existing database into another:
.. testcode::
def progress(status, remaining, total):
print(f'Copied {total-remaining} of {total} pages...')
src = sqlite3.connect('example.db')
dst = sqlite3.connect('backup.db')
with dst:
src.backup(dst, pages=1, progress=progress)
dst.close()
src.close()
.. testoutput::
Copied 0 of 0 pages...
Example 2, copy an existing database into a transient copy:
.. testcode::
src = sqlite3.connect('example.db')
dst = sqlite3.connect(':memory:')
src.backup(dst)
dst.close()
src.close()
.. versionadded:: 3.7
.. seealso::
.. method:: getlimit(category, /)
Get a connection runtime limit.
The `SQLite limit category`_ to be queried.
If *category* is not recognised by the underlying SQLite library.
Example, query the maximum length of an SQL statement
for :class:`Connection` ``con`` (the default is 1000000000):
.. testsetup:: sqlite3.limits
import sqlite3
con = sqlite3.connect(":memory:")
con.setlimit(sqlite3.SQLITE_LIMIT_SQL_LENGTH, 1_000_000_000)
con.setlimit(sqlite3.SQLITE_LIMIT_ATTACHED, 10)
.. doctest:: sqlite3.limits
>>> con.getlimit(sqlite3.SQLITE_LIMIT_SQL_LENGTH)
1000000000
.. versionadded:: 3.11
.. method:: setlimit(category, limit, /)
Set a connection runtime limit.
Attempts to increase a limit above its hard upper bound are silently
truncated to the hard upper bound. Regardless of whether or not the limit
was changed, the prior value of the limit is returned.
The `SQLite limit category`_ to be set.
The value of the new limit.
If negative, the current limit is unchanged.
If *category* is not recognised by the underlying SQLite library.
Example, limit the number of attached databases to 1
for :class:`Connection` ``con`` (the default limit is 10):
.. doctest:: sqlite3.limits
>>> con.setlimit(sqlite3.SQLITE_LIMIT_ATTACHED, 1)
10
>>> con.getlimit(sqlite3.SQLITE_LIMIT_ATTACHED)
1
.. testcleanup:: sqlite3.limits
con.close()
.. versionadded:: 3.11
.. _SQLite limit category: https://www.sqlite.org/c3ref/c_limit_attached.html
.. method:: getconfig(op, /)
Query a boolean connection configuration option.
A :ref:`SQLITE_DBCONFIG code <sqlite3-dbconfig-constants>`.
.. versionadded:: 3.12
.. method:: setconfig(op, enable=True, /)
Set a boolean connection configuration option.
A :ref:`SQLITE_DBCONFIG code <sqlite3-dbconfig-constants>`.
``True`` if the configuration option should be enabled (default);
``False`` if it should be disabled.
.. versionadded:: 3.12
.. method:: serialize(*, name="main")
Serialize a database into a :class:`bytes` object. For an
ordinary on-disk database file, the serialization is just a copy of the
disk file. For an in-memory database or a "temp" database, the
serialization is the same sequence of bytes which would be written to
disk if that database were backed up to disk.
The database name to be serialized.
Defaults to ``"main"``.
.. note::
This method is only available if the underlying SQLite library has the
serialize API.
.. versionadded:: 3.11
.. method:: deserialize(data, /, *, name="main")
Deserialize a :meth:`serialized <serialize>` database into a
This method causes the database connection to disconnect from database
*name*, and reopen *name* as an in-memory database based on the
serialization contained in *data*.
A serialized database.
The database name to deserialize into.
Defaults to ``"main"``.
If the database connection is currently involved in a read
transaction or a backup operation.
If *data* does not contain a valid SQLite database.
If :func:`len(data) <len>` is larger than ``2**63 - 1``.
.. note::
This method is only available if the underlying SQLite library has the
deserialize API.
.. versionadded:: 3.11
.. attribute:: autocommit
This attribute controls :pep:`249`-compliant transaction behaviour.
* ``False``: Select :pep:`249`-compliant transaction behaviour,
implying that :mod:`!sqlite3` ensures a transaction is always open.
Use :meth:`commit` and :meth:`rollback` to close transactions.
This is the recommended value of :attr:`!autocommit`.
* ``True``: Use SQLite's `autocommit mode`_.
* :data:`LEGACY_TRANSACTION_CONTROL`:
Pre-Python 3.12 (non-:pep:`249`-compliant) transaction control.
See :attr:`isolation_level` for more details.
This is currently the default value of :attr:`!autocommit`.
Changing :attr:`!autocommit` to ``False`` will open a new transaction,
and changing it to ``True`` will commit any pending transaction.
See :ref:`sqlite3-transaction-control-autocommit` for more details.
.. note::
The :attr:`isolation_level` attribute has no effect unless
.. versionadded:: 3.12
.. attribute:: in_transaction
This read-only attribute corresponds to the low-level SQLite
`autocommit mode`_.
``True`` if a transaction is active (there are uncommitted changes),
``False`` otherwise.
.. versionadded:: 3.2
.. attribute:: isolation_level
Controls the :ref:`legacy transaction handling mode
<sqlite3-transaction-control-isolation-level>` of :mod:`!sqlite3`.
If set to ``None``, transactions are never implicitly opened.
If set to one of ``"DEFERRED"``, ``"IMMEDIATE"``, or ``"EXCLUSIVE"``,
corresponding to the underlying `SQLite transaction behaviour`_,
<sqlite3-transaction-control-isolation-level>` is performed.
If not overridden by the *isolation_level* parameter of :func:`connect`,
the default is ``""``, which is an alias for ``"DEFERRED"``.
.. note::
Using :attr:`autocommit` to control transaction handling is
recommended over using :attr:`!isolation_level`.
set to :data:`LEGACY_TRANSACTION_CONTROL` (the default).
.. attribute:: row_factory
The initial :attr:`~Cursor.row_factory`
for :class:`Cursor` objects created from this connection.
Assigning to this attribute does not affect the :attr:`!row_factory`
of existing cursors belonging to this connection, only new ones.
Is ``None`` by default,
meaning each row is returned as a :class:`tuple`.
See :ref:`sqlite3-howto-row-factory` for more details.
.. versionchanged:: 3.14.6
Deleting the ``row_factory`` attribute is no longer allowed.
.. attribute:: text_factory
A :term:`callable` that accepts a :class:`bytes` parameter
and returns a text representation of it.
The callable is invoked for SQLite values with the ``TEXT`` data type.
By default, this attribute is set to :class:`str`.
See :ref:`sqlite3-howto-encoding` for more details.
.. versionchanged:: 3.14.6
Deleting the ``text_factory`` attribute is no longer allowed.
.. attribute:: total_changes
Return the total number of database rows that have been modified, inserted, or
deleted since the database connection was opened.Cursor objects
A `Cursor object represents a database cursor_ which is used to execute SQL statements, and manage the context of a fetch operation. Cursors are created using Connection.cursor, or by using any of the :ref:connection shortcut methods <sqlite3-connection-shortcuts>`.
Cursor objects are iterators <iterator>, meaning that if you ~Cursor.execute a `SELECT` query, you can simply iterate over the cursor to fetch the resulting rows:
import sqlite3 con = sqlite3.connect(":memory:", isolation_level=None) cur = con.execute("CREATE TABLE data(t)") cur.execute("INSERT INTO data VALUES(1)")
for row in cur.execute("SELECT t FROM data"): print(row)
:hide:
(1,)
A Cursor instance has the following attributes and methods.
Execute a single SQL statement, optionally binding Python values using placeholders <sqlite3-placeholders>.
:param str sql: A single SQL statement.
:param parameters: Python values to bind to placeholders in *sql*. A !dict if named placeholders are used. A !sequence if unnamed placeholders are used. See sqlite3-placeholders. :type parameters: dict | sequence
:raises ProgrammingError: When *sql* contains more than one SQL statement. When named placeholders <sqlite3-placeholders> are used and *parameters* is a sequence instead of a dict.
If ~Connection.autocommit is LEGACY_TRANSACTION_CONTROL, ~Connection.isolation_level is not `None, *sql* is an INSERT, UPDATE, DELETE, or REPLACE` statement, and there is no open transaction, a transaction is implicitly opened before executing *sql*.
ProgrammingError is emitted if named placeholders <sqlite3-placeholders> are used and *parameters* is a sequence instead of a dict.
Use executescript to execute multiple SQL statements.
For every item in *parameters*, repeatedly execute the parameterized <sqlite3-placeholders> DML (Data Manipulation Language) SQL statement *sql*.
Uses the same implicit transaction handling as ~Cursor.execute.
:param str sql: A single SQL DML statement.
:param parameters: An !iterable of parameters to bind with the placeholders in *sql*. See sqlite3-placeholders. :type parameters: iterable
:raises ProgrammingError: When *sql* contains more than one SQL statement or is not a DML statement, When named placeholders <sqlite3-placeholders> are used and the items in *parameters* are sequences instead of dict\s.
Example:
rows = [ ("row1",), ("row2",), ] # cur is an sqlite3.Cursor object cur.executemany("INSERT INTO data VALUES(?)", rows)
con.close()
Any resulting rows are discarded, including DML statements with RETURNING clauses_.
ProgrammingError is emitted if named placeholders <sqlite3-placeholders> are used and the items in *parameters* are sequences instead of dict\s.
Execute the SQL statements in *sql_script*. If the ~Connection.autocommit is LEGACY_TRANSACTION_CONTROL and there is a pending transaction, an implicit `COMMIT` statement is executed first. No other implicit transaction control is performed; any transaction control must be added to *sql_script*.
*sql_script* must be a string <str>.
Example:
# cur is an sqlite3.Cursor object cur.executescript(""" BEGIN; CREATE TABLE person(firstname, lastname, age); CREATE TABLE book(title, author, published); CREATE TABLE publisher(name, address); COMMIT; """)
If ~Cursor.row_factory is `None, return the next row query result set as a tuple. Else, pass it to the row factory and return its result. Return None` if no more data is available.
Return the next set of rows of a query result as a list. Return an empty list if no more rows are available.
The number of rows to fetch per call is specified by the *size* parameter. If *size* is not given, arraysize determines the number of rows to be fetched. If fewer than *size* rows are available, as many rows as are available are returned.
Note there are performance considerations involved with the *size* parameter. For optimal performance, it is usually best to use the arraysize attribute. If the *size* parameter is used, then it is best for it to retain the same value from one fetchmany call to the next.
Negative *size* values are rejected by raising ValueError.
Return all (remaining) rows of a query result as a list. Return an empty list if no rows are available. Note that the arraysize attribute can affect the performance of this operation.
Close the cursor now (rather than whenever `__del__` is called).
The cursor will be unusable from this point forward; a ProgrammingError exception will be raised if any operation is attempted with the cursor.
Required by the DB-API. Does nothing in !sqlite3.
Required by the DB-API. Does nothing in !sqlite3.
Read/write attribute that controls the number of rows returned by fetchmany. The default value is 1 which means a single row would be fetched per call.
Negative values are rejected by raising ValueError.
Read-only attribute that provides the SQLite database Connection belonging to the cursor. A Cursor object created by calling con.cursor() <Connection.cursor> will have a connection attribute that refers to *con*:
توجه: >> con = sqlite3.connect(":memory:") >> cur = con.cursor() >> cur.connection == con
True
توجه: >> con.close()
Read-only attribute that provides the column names of the last query. To remain compatible with the Python DB API, it returns a 7-tuple for each column where the last six items of each tuple are `None`.
It is set for `SELECT` statements without any matching rows as well.
Read-only attribute that provides the row id of the last inserted row. It is only updated after successful `INSERT or REPLACE statements using the execute method. For other statements, after executemany or executescript, or if the insertion failed, the value of lastrowid is left unchanged. The initial value of lastrowid is None`.
Inserts into `WITHOUT ROWID` tables are not recorded.
Added support for the `REPLACE` statement.
Read-only attribute that provides the number of modified rows for `INSERT, UPDATE, DELETE, and REPLACE statements; is -1 for other statements, including CTE (Common Table Expression) queries. It is only updated by the execute and executemany methods, after the statement has run to completion. This means that any resulting rows must be fetched in order for !rowcount` to be updated.
Control how a row fetched from this !Cursor is represented. If `None, a row is represented as a tuple. Can be set to the included sqlite3.Row; or a callable that accepts two arguments, a Cursor object and the !tuple` of row values, and returns a custom object representing an SQLite row.
Defaults to what Connection.row_factory was set to when the !Cursor was created. Assigning to this attribute does not affect Connection.row_factory of the parent connection.
See sqlite3-howto-row-factory for more details.
Deleting the `row_factory` attribute is no longer allowed.
into the Row reference. We keep the anchor here in order not to break existing links.
Row objects
A !Row instance serves as a highly optimized ~Connection.row_factory for Connection objects. It supports iteration, equality testing, len, and mapping access by column name and index.
Two !Row objects compare equal if they have identical column names and values.
See sqlite3-howto-row-factory for more details.
Return a list of column names as strings <str>. Immediately after a query, it is the first member of each tuple in Cursor.description.
Added support of slicing.
Blob objects
A Blob instance is a file-like object that can read and write data in an SQLite BLOB (Binary Large OBject). Call len(blob) <len> to get the size (number of bytes) of the blob. Use indices and slices <slice> for direct access to the blob data.
Use the Blob as a context manager to ensure that the blob handle is closed after use.
con = sqlite3.connect(":memory:") con.execute("CREATE TABLE test(blob_col blob)") con.execute("INSERT INTO test(blob_col) VALUES(zeroblob(13))")
# Write to our blob, using two write operations: with con.blobopen("test", "blob_col", 1) as blob: blob.write(b"hello, ") blob.write(b"world.") # Modify the first and last bytes of our blob blob[0] = ord("H") blob[-1] = ord("!")
# Read the contents of our blob with con.blobopen("test", "blob_col", 1) as blob: greeting = blob.read()
print(greeting) # outputs "b'Hello, world!'" con.close()
:hide:
b'Hello, world!'
Close the blob.
The blob will be unusable from this point onward. An ~sqlite3.Error (or subclass) exception will be raised if any further operation is attempted with the blob.
Read *length* bytes of data from the blob at the current offset position. If the end of the blob is reached, the data up to EOF (End of File) will be returned. When *length* is not specified, or is negative, ~Blob.read will read until the end of the blob.
Write *data* to the blob at the current offset. This function cannot change the blob length. Writing beyond the end of the blob will raise ValueError.
Return the current access position of the blob.
Set the current access position of the blob to *offset*. The *origin* argument defaults to os.SEEK_SET (absolute blob positioning). Other values for *origin* are os.SEEK_CUR (seek relative to the current position) and os.SEEK_END (seek relative to the blob’s end).
PrepareProtocol objects
The PrepareProtocol type's single purpose is to act as a 246 style adaption protocol for objects that can :ref:adapt themselves <sqlite3-conform> to native SQLite types <sqlite3-types>.
Exceptions
The exception hierarchy is defined by the DB-API 2.0 (249).
This exception is not currently raised by the !sqlite3 module, but may be raised by applications using !sqlite3, for example if a user-defined function truncates data while inserting. `Warning is a subclass of Exception`.
The base class of the other exceptions in this module. Use this to catch all errors with one single except statement. `Error is a subclass of Exception`.
If the exception originated from within the SQLite library, the following two attributes are added to the exception:
The numeric error code from the SQLite API <https://sqlite.org/rescode.html>_
The symbolic name of the numeric error code from the SQLite API <https://sqlite.org/rescode.html>_
Exception raised for misuse of the low-level SQLite C API. In other words, if this exception is raised, it probably indicates a bug in the !sqlite3 module. `InterfaceError is a subclass of Error`.
Exception raised for errors that are related to the database. This serves as the base exception for several types of database errors. It is only raised implicitly through the specialised subclasses. `DatabaseError is a subclass of Error`.
Exception raised for errors caused by problems with the processed data, like numeric values out of range, and strings which are too long. `DataError is a subclass of DatabaseError`.
Exception raised for errors that are related to the database's operation, and not necessarily under the control of the programmer. For example, the database path is not found, or a transaction could not be processed. `OperationalError is a subclass of DatabaseError`.
Exception raised when the relational integrity of the database is affected, e.g. a foreign key check fails. It is a subclass of DatabaseError.
Exception raised when SQLite encounters an internal error. If this is raised, it may indicate that there is a problem with the runtime SQLite library. `InternalError is a subclass of DatabaseError`.
Exception raised for !sqlite3 API programming errors, for example supplying the wrong number of bindings to a query, or trying to operate on a closed Connection. `ProgrammingError is a subclass of DatabaseError`.
Exception raised in case a method or database API is not supported by the underlying SQLite library. For example, setting *deterministic* to `True in ~Connection.create_function, if the underlying SQLite library does not support deterministic functions. NotSupportedError is a subclass of DatabaseError`.
SQLite and Python types
SQLite natively supports the following types: `NULL, INTEGER, REAL, TEXT, BLOB`.
The following Python types can thus be sent to SQLite without any problem:
+-------------------------------+-------------+
| Python type | SQLite type |
+===============================+=============+
`None` | `NULL` |
+-------------------------------+-------------+
int | `INTEGER` |
+-------------------------------+-------------+
float | `REAL` |
+-------------------------------+-------------+
str | `TEXT` |
+-------------------------------+-------------+
bytes | `BLOB` |
+-------------------------------+-------------+
This is how SQLite types are converted to Python types by default:
+-------------+----------------------------------------------+
| SQLite type | Python type |
+=============+==============================================+
`NULL` | `None` |
+-------------+----------------------------------------------+
`INTEGER` | int |
+-------------+----------------------------------------------+
`REAL` | float |
+-------------+----------------------------------------------+
`TEXT` | depends on ~Connection.text_factory, |
str by default |
+-------------+----------------------------------------------+
`BLOB` | bytes |
+-------------+----------------------------------------------+
The type system of the !sqlite3 module is extensible in two ways: you can store additional Python types in an SQLite database via object adapters <sqlite3-adapters>, and you can let the !sqlite3 module convert SQLite types to Python types via converters <sqlite3-converters>.
Default adapters and converters (deprecated)
The default adapters and converters are deprecated as of Python 3.12. Instead, use the sqlite3-adapter-converter-recipes and tailor them to your needs.
The deprecated default adapters and converters consist of:
- An adapter for
datetime.dateobjects tostrings <str>in
ISO 8601_ format.
- An adapter for
datetime.datetimeobjects to strings in
ISO 8601 format.
- A converter for
declared <sqlite3-converters>"date" types to
datetime.date objects.
- A converter for declared "timestamp" types to
datetime.datetime objects. Fractional parts will be truncated to 6 digits (microsecond precision).
The default "timestamp" converter ignores UTC offsets in the database and always returns a naive datetime.datetime object. To preserve UTC offsets in timestamps, either leave converters disabled, or register an offset-aware converter with register_converter.
Command-line interface
The !sqlite3 module can be invoked as a script, using the interpreter's -m switch, in order to provide a simple SQLite shell. The argument signature is as follows::
python -m sqlite3 [-h] [-v] [filename] [sql]
Type `.quit` or CTRL-D to exit the shell.
Print CLI help.
Print underlying SQLite library version.
How-to guides
How to use placeholders to bind values in SQL queries
SQL operations usually need to use values from Python variables. However, beware of using Python's string operations to assemble queries, as they are vulnerable to SQL injection attacks_. For example, an attacker can simply close the single quote and inject `OR TRUE` to select all rows::
توجه: >> # Never do this -- insecure! >> symbol = input()
' OR TRUE; --
توجه: >> sql = "SELECT * FROM stocks WHERE symbol = '%s'" % symbol >> print(sql)
SELECT * FROM stocks WHERE symbol = '' OR TRUE; --'
توجه: >> cur.execute(sql)
Instead, use the DB-API's parameter substitution. To insert a variable into a query string, use a placeholder in the string, and substitute the actual values into the query by providing them as a tuple of values to the second argument of the cursor's ~Cursor.execute method.
An SQL statement may use one of two kinds of placeholders: question marks (qmark style) or named placeholders (named style). For the qmark style, *parameters* must be a sequence whose length must match the number of placeholders, or a ProgrammingError is raised. For the named style, *parameters* must be an instance of a dict (or a subclass), which must contain keys for all named parameters; any extra items are ignored. Here's an example of both styles:
con = sqlite3.connect(":memory:") cur = con.execute("CREATE TABLE lang(name, first_appeared)")
# This is the named style used with executemany(): data = ( {"name": "C", "year": 1972}, {"name": "Fortran", "year": 1957}, {"name": "Python", "year": 1991}, {"name": "Go", "year": 2009}, ) cur.executemany("INSERT INTO lang VALUES(:name, :year)", data)
# This is the qmark style used in a SELECT query: params = (1972,) cur.execute("SELECT * FROM lang WHERE first_appeared = ?", params) print(cur.fetchall()) con.close()
:hide:
[('C', 1972)]
249 numeric placeholders are *not* supported. If used, they will be interpreted as named placeholders.
How to adapt custom Python types to SQLite values
SQLite supports only a limited set of data types natively. To store custom Python types in SQLite databases, *adapt* them to one of the Python types SQLite natively understands <sqlite3-types>.
There are two ways to adapt Python objects to SQLite types: letting your object adapt itself, or using an *adapter callable*. The latter will take precedence above the former. For a library that exports a custom type, it may make sense to enable that type to adapt itself. As an application developer, it may make more sense to take direct control by registering custom adapter functions.
How to write adaptable objects """"""""""""""""""""""""""""""
Suppose we have a !Point class that represents a pair of coordinates, `x and y, in a Cartesian coordinate system. The coordinate pair will be stored as a text string in the database, using a semicolon to separate the coordinates. This can be implemented by adding a __conform__(self, protocol) method which returns the adapted value. The object passed to *protocol* will be of type PrepareProtocol`.
class Point: def __init__(self, x, y): self.x, self.y = x, y
def __conform__(self, protocol): if protocol is sqlite3.PrepareProtocol: return f"{self.x};{self.y}"
con = sqlite3.connect(":memory:") cur = con.cursor()
cur.execute("SELECT ?", (Point(4.0, -3.2),)) print(cur.fetchone()[0]) con.close()
:hide:
4.0;-3.2
How to register adapter callables """""""""""""""""""""""""""""""""
The other possibility is to create a function that converts the Python object to an SQLite-compatible type. This function can then be registered using register_adapter.
class Point: def __init__(self, x, y): self.x, self.y = x, y
def adapt_point(point): return f"{point.x};{point.y}"
sqlite3.register_adapter(Point, adapt_point)
con = sqlite3.connect(":memory:") cur = con.cursor()
cur.execute("SELECT ?", (Point(1.0, 2.5),)) print(cur.fetchone()[0]) con.close()
:hide:
1.0;2.5
How to convert SQLite values to custom Python types
Writing an adapter lets you convert *from* custom Python types *to* SQLite values. To be able to convert *from* SQLite values *to* custom Python types, we use *converters*.
Let's go back to the !Point class. We stored the x and y coordinates separated via semicolons as strings in SQLite.
First, we'll define a converter function that accepts the string as a parameter and constructs a !Point object from it.
Converter functions are always passed a bytes object, no matter the underlying SQLite data type.
def convert_point(s): x, y = map(float, s.split(b";")) return Point(x, y)
We now need to tell !sqlite3 when it should convert a given SQLite value. This is done when connecting to a database, using the *detect_types* parameter of connect. There are three options:
- Implicit: set *detect_types* to
PARSE_DECLTYPES - Explicit: set *detect_types* to
PARSE_COLNAMES - Both: set *detect_types* to
`sqlite3.PARSE_DECLTYPES | sqlite3.PARSE_COLNAMES`. Column names take precedence over declared types.
The following example illustrates the implicit and explicit approaches:
class Point: def __init__(self, x, y): self.x, self.y = x, y
def __repr__(self): return f"Point({self.x}, {self.y})"
def adapt_point(point): return f"{point.x};{point.y}"
def convert_point(s): x, y = list(map(float, s.split(b";"))) return Point(x, y)
# Register the adapter and converter sqlite3.register_adapter(Point, adapt_point) sqlite3.register_converter("point", convert_point)
# 1) Parse using declared types p = Point(4.0, -3.2) con = sqlite3.connect(":memory:", detect_types=sqlite3.PARSE_DECLTYPES) cur = con.execute("CREATE TABLE test(p point)")
cur.execute("INSERT INTO test(p) VALUES(?)", (p,)) cur.execute("SELECT p FROM test") print("with declared types:", cur.fetchone()[0]) cur.close() con.close()
# 2) Parse using column names con = sqlite3.connect(":memory:", detect_types=sqlite3.PARSE_COLNAMES) cur = con.execute("CREATE TABLE test(p)")
cur.execute("INSERT INTO test(p) VALUES(?)", (p,)) cur.execute('SELECT p AS "p [point]" FROM test') print("with column names:", cur.fetchone()[0]) cur.close() con.close()
:hide:
with declared types: Point(4.0, -3.2) with column names: Point(4.0, -3.2)
Adapter and converter recipes
This section shows recipes for common adapters and converters.
import datetime as dt import sqlite3
def adapt_date_iso(val): """Adapt datetime.date to ISO 8601 date.""" return val.isoformat()
def adapt_datetime_iso(val): """Adapt datetime.datetime to timezone-naive ISO 8601 date.""" return val.replace(tzinfo=None).isoformat()
def adapt_datetime_epoch(val): """Adapt datetime.datetime to Unix timestamp.""" return int(val.timestamp())
sqlite3.register_adapter(dt.date, adapt_date_iso) sqlite3.register_adapter(dt.datetime, adapt_datetime_iso) sqlite3.register_adapter(dt.datetime, adapt_datetime_epoch)
def convert_date(val): """Convert ISO 8601 date to datetime.date object.""" return dt.date.fromisoformat(val.decode())
def convert_datetime(val): """Convert ISO 8601 datetime to datetime.datetime object.""" return dt.datetime.fromisoformat(val.decode())
def convert_timestamp(val): """Convert Unix epoch timestamp to datetime.datetime object.""" return dt.datetime.fromtimestamp(int(val))
sqlite3.register_converter("date", convert_date) sqlite3.register_converter("datetime", convert_datetime) sqlite3.register_converter("timestamp", convert_timestamp)
:hide:
when = dt.datetime(2019, 5, 18, 15, 17, 8, 123456)
assert adapt_date_iso(when.date()) == "2019-05-18" assert convert_date(b"2019-05-18") == when.date()
assert adapt_datetime_iso(when) == "2019-05-18T15:17:08.123456" assert convert_datetime(b"2019-05-18T15:17:08.123456") == when
# Using current time as fromtimestamp() returns local date/time. # Dropping microseconds as adapt_datetime_epoch truncates fractional second part. now = dt.datetime.now().replace(microsecond=0) current_timestamp = int(now.timestamp())
assert adapt_datetime_epoch(now) == current_timestamp assert convert_timestamp(str(current_timestamp).encode()) == now
How to use connection shortcut methods
Using the ~Connection.execute, ~Connection.executemany, and ~Connection.executescript methods of the Connection class, your code can be written more concisely because you don't have to create the (often superfluous) Cursor objects explicitly. Instead, the Cursor objects are created implicitly and these shortcut methods return the cursor objects. This way, you can execute a `SELECT statement and iterate over it directly using only a single call on the Connection` object.
# Create and fill the table. con = sqlite3.connect(":memory:") con.execute("CREATE TABLE lang(name, first_appeared)") data = [ ("C++", 1985), ("Objective-C", 1984), ] con.executemany("INSERT INTO lang(name, first_appeared) VALUES(?, ?)", data)
# Print the table contents for row in con.execute("SELECT name, first_appeared FROM lang"): print(row)
print("I just deleted", con.execute("DELETE FROM lang").rowcount, "rows")
# close() is not a shortcut method and it's not called automatically; # the connection object should be closed manually con.close()
:hide:
('C++', 1985) ('Objective-C', 1984) I just deleted 2 rows
How to use the connection context manager
A Connection object can be used as a context manager that automatically commits or rolls back open transactions when leaving the body of the context manager. If the body of the with statement finishes without exceptions, the transaction is committed. If this commit fails, or if the body of the `with statement raises an uncaught exception, the transaction is rolled back. If ~Connection.autocommit is False`, a new transaction is implicitly opened after committing or rolling back.
If there is no open transaction upon leaving the body of the `with statement, or if ~Connection.autocommit is True`, the context manager does nothing.
The context manager neither implicitly opens a new transaction nor closes the connection. If you need a closing context manager, consider using contextlib.closing.
con = sqlite3.connect(":memory:") con.execute("CREATE TABLE lang(id INTEGER PRIMARY KEY, name VARCHAR UNIQUE)")
# Successful, con.commit() is called automatically afterwards with con: con.execute("INSERT INTO lang(name) VALUES(?)", ("Python",))
# con.rollback() is called after the with block finishes with an exception, # the exception is still raised and must be caught try: with con: con.execute("INSERT INTO lang(name) VALUES(?)", ("Python",)) except sqlite3.IntegrityError: print("couldn't add Python twice")
# Connection object used as context manager only commits or rollbacks transactions, # so the connection object should be closed manually con.close()
:hide:
couldn't add Python twice
How to work with SQLite URIs
Some useful URI tricks include:
- Open a database in read-only mode:
توجه: >> con = sqlite3.connect("file:tutorial.db?mode=ro", uri=True) >> con.execute("CREATE TABLE readonly(data)")
Traceback (most recent call last): OperationalError: attempt to write a readonly database
توجه: >> con.close()
- Do not implicitly create a new database file if it does not already exist;
will raise ~sqlite3.OperationalError if unable to create a new file:
توجه: >> con = sqlite3.connect("file:nosuchdb.db?mode=rw", uri=True)
Traceback (most recent call last): OperationalError: unable to open database file
- Create a shared named in-memory database:
db = "file:mem1?mode=memory&cache=shared" con1 = sqlite3.connect(db, uri=True) con2 = sqlite3.connect(db, uri=True) with con1: con1.execute("CREATE TABLE shared(data)") con1.execute("INSERT INTO shared VALUES(28)") res = con2.execute("SELECT data FROM shared") assert res.fetchone() == (28,)
con1.close() con2.close()
More information about this feature, including a list of parameters, can be found in the SQLite URI documentation_.
How to create and use row factories
By default, !sqlite3 represents each row as a tuple. If a !tuple does not suit your needs, you can use the sqlite3.Row class or a custom ~Cursor.row_factory.
While !row_factory exists as an attribute both on the Cursor and the Connection, it is recommended to set Connection.row_factory, so all cursors created from the connection will use the same row factory.
!Row provides indexed and case-insensitive named access to columns, with minimal memory overhead and performance impact over a !tuple. To use !Row as a row factory, assign it to the !row_factory attribute:
توجه: >> con = sqlite3.connect(":memory:") >> con.row_factory = sqlite3.Row
Queries now return !Row objects:
توجه: >> res = con.execute("SELECT 'Earth' AS name, 6378 AS radius") >> row = res.fetchone() >> row.keys()
['name', 'radius']
توجه: >> row[0] # Access by index.
'Earth'
توجه: >> row["name"] # Access by name.
'Earth'
توجه: >> row["RADIUS"] # Column names are case-insensitive.
6378
توجه: >> con.close()
The `FROM clause can be omitted in the SELECT statement, as in the above example. In such cases, SQLite returns a single row with columns defined by expressions, e.g. literals, with the given aliases expr AS alias`.
You can create a custom ~Cursor.row_factory that returns each row as a dict, with column names mapped to values:
def dict_factory(cursor, row): fields = [column[0] for column in cursor.description] return {key: value for key, value in zip(fields, row)}
Using it, queries now return a !dict instead of a !tuple:
توجه: >> con = sqlite3.connect(":memory:") >> con.row_factory = dict_factory >> for row in con.execute("SELECT 1 AS a, 2 AS b"):
... print(row) {'a': 1, 'b': 2}
توجه: >> con.close()
The following row factory returns a named tuple:
from collections import namedtuple
def namedtuple_factory(cursor, row): fields = [column[0] for column in cursor.description] cls = namedtuple("Row", fields) return cls._make(row)
!namedtuple_factory can be used as follows:
توجه: >> con = sqlite3.connect(":memory:") >> con.row_factory = namedtuple_factory >> cur = con.execute("SELECT 1 AS a, 2 AS b") >> row = cur.fetchone() >> row
Row(a=1, b=2)
توجه: >> row[0] # Indexed access.
1
توجه: >> row.b # Attribute access.
2
توجه: >> con.close()
With some adjustments, the above recipe can be adapted to use a ~dataclasses.dataclass, or any other custom class, instead of a ~collections.namedtuple.
How to handle non-UTF-8 text encodings
By default, !sqlite3 uses str to adapt SQLite values with the `TEXT data type. This works well for UTF-8 encoded text, but it might fail for other encodings and invalid UTF-8. You can use a custom ~Connection.text_factory` to handle such cases.
Because of SQLite's flexible typing_, it is not uncommon to encounter table columns with the `TEXT data type containing non-UTF-8 encodings, or even arbitrary data. To demonstrate, let's assume we have a database with ISO-8859-2 (Latin-2) encoded text, for example a table of Czech-English dictionary entries. Assuming we now have a Connection instance !con connected to this database, we can decode the Latin-2 encoded text using this ~Connection.text_factory`:
con.text_factory = lambda data: str(data, encoding="latin2")
For invalid UTF-8 or arbitrary data in stored in `TEXT table columns, you can use the following technique, borrowed from the unicode-howto`:
con.text_factory = lambda data: str(data, errors="surrogateescape")
The !sqlite3 module API does not support strings containing surrogates.
unicode-howto
Explanation
Transaction control
!sqlite3 offers multiple methods of controlling whether, when and how database transactions are opened and closed. sqlite3-transaction-control-autocommit is recommended, while sqlite3-transaction-control-isolation-level retains the pre-Python 3.12 behaviour.
Transaction control via the `autocommit` attribute """"""""""""""""""""""""""""""""""""""""""""""""""""
The recommended way of controlling transaction behaviour is through the Connection.autocommit attribute, which should preferably be set using the *autocommit* parameter of connect.
It is suggested to set *autocommit* to `False, which implies 249`-compliant transaction control. This means:
!sqlite3ensures that a transaction is always open,
so connect, Connection.commit, and Connection.rollback will implicitly open a new transaction (immediately after closing the pending one, for the latter two). !sqlite3 uses `BEGIN DEFERRED` statements when opening transactions.
- Transactions should be committed explicitly using
!commit. - Transactions should be rolled back explicitly using
!rollback. - An implicit rollback is performed if the database is
~Connection.close-ed with pending changes.
Set *autocommit* to `True to enable SQLite's autocommit mode_. In this mode, Connection.commit and Connection.rollback have no effect. Note that SQLite's autocommit mode is distinct from the 249-compliant Connection.autocommit attribute; use Connection.in_transaction` to query the low-level SQLite autocommit mode.
Set *autocommit* to LEGACY_TRANSACTION_CONTROL to leave transaction control behaviour to the Connection.isolation_level attribute. See sqlite3-transaction-control-isolation-level for more information.
Transaction control via the `isolation_level` attribute """""""""""""""""""""""""""""""""""""""""""""""""""""""""
The recommended way of controlling transactions is via the ~Connection.autocommit attribute. See sqlite3-transaction-control-autocommit.
If Connection.autocommit is set to LEGACY_TRANSACTION_CONTROL (the default), transaction behaviour is controlled using the Connection.isolation_level attribute. Otherwise, !isolation_level has no effect.
If the connection attribute ~Connection.isolation_level is not `None, new transactions are implicitly opened before ~Cursor.execute and ~Cursor.executemany executes INSERT, UPDATE, DELETE, or REPLACE statements; for other statements, no implicit transaction handling is performed. Use the ~Connection.commit and ~Connection.rollback methods to respectively commit and roll back pending transactions. You can choose the underlying SQLite transaction behaviour_ — that is, whether and what type of BEGIN statements !sqlite3 implicitly executes – via the ~Connection.isolation_level` attribute.
If ~Connection.isolation_level is set to `None, no transactions are implicitly opened at all. This leaves the underlying SQLite library in autocommit mode_, but also allows the user to perform their own transaction handling using explicit SQL statements. The underlying SQLite library autocommit mode can be queried using the ~Connection.in_transaction` attribute.
The ~Cursor.executescript method implicitly commits any pending transaction before execution of the given SQL script, regardless of the value of ~Connection.isolation_level.
!sqlite3 used to implicitly commit an open transaction before DDL statements. This is no longer the case.
The recommended way of controlling transactions is now via the ~Connection.autocommit attribute.
https://www.sqlite.org/lang_transaction.html#implicit_versus_explicit_transactions
https://www.sqlite.org/lang_transaction.html#deferred_immediate_and_exclusive_transactions
import os os.remove("backup.db") os.remove("dump.sql") os.remove("example.db") os.remove("tutorial.db")