Skip to main content
Documentation Status PyPI Release Changelog MIT Licensed

aiosqlite provides a friendly, async interface to sqlite databases.

It replicates the standard sqlite3 module, but with async versions of all the standard connection and cursor methods, plus context managers for automatically closing connections and cursors:

async with aiosqlite.connect(...) as db:
    await db.execute("INSERT INTO some_table ...")
    await db.commit()

    async with db.execute("SELECT * FROM some_table") as cursor:
        async for row in cursor:
            ...

It can also be used in the traditional, procedural manner:

db = await aiosqlite.connect(...)
cursor = await db.execute('SELECT * FROM some_table')
row = await cursor.fetchone()
rows = await cursor.fetchall()
await cursor.close()
await db.close()

aiosqlite also replicates most of the advanced features of sqlite3:

async with aiosqlite.connect(...) as db:
    db.row_factory = aiosqlite.Row
    async with db.execute('SELECT * FROM some_table') as cursor:
        async for row in cursor:
            value = row['column']

    await db.execute('INSERT INTO foo some_table')
    assert db.total_changes > 0

Install

aiosqlite is compatible with Python 3.8 and newer. You can install it from PyPI:

$ pip install aiosqlite

Details

aiosqlite allows interaction with SQLite databases on the main AsyncIO event loop without blocking execution of other coroutines while waiting for queries or data fetches. It does this by using a single, shared thread per connection. This thread executes all actions within a shared request queue to prevent overlapping actions.

Connection objects are proxies to the real connections, contain the shared execution thread, and provide context managers to handle automatically closing connections. Cursors are similarly proxies to the real cursors, and provide async iterators to query results.

License

aiosqlite is copyright Amethyst Reese, and licensed under the MIT license. I am providing code in this repository to you under an open source license. This is my personal repository; the license you receive to my code is from me and not from my employer. See the LICENSE file for details.

Metadata

Release files for aiosqlite-custom 0.19.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aiosqlite-custom 0.19.0
File Size Uploaded
aiosqlite_custom-0.19.0.tar.gz 13.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aiosqlite-custom 0.19.0
File Interpreter ABI Platform
aiosqlite_custom-0.19.0-py3-none-any.whl Python 3 none any Details

Total release size: 28.5 kB

Release files / aiosqlite_custom-0.19.0.tar.gz

Download URL aiosqlite_custom-0.19.0.tar.gz
Size 13.0 kB
Tags Source
SHA-256 checksum
How to use checksums
26baaad8fa2d691c076c0fe45766a7b50bcdd4844d549107c537c3e832426559
BLAKE2b-256 checksum
How to use checksums
68d5c46fecd927885855bdffdff8d368c69f4326902c34a81a0ecbef7bb47e3f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.12

Release files / aiosqlite_custom-0.19.0-py3-none-any.whl

Download URL aiosqlite_custom-0.19.0-py3-none-any.whl
Size 15.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a01e6f2e68931a3632a0d3ae6c7fa56442c953f2d06d1b7482a1861be43b28cf
BLAKE2b-256 checksum
How to use checksums
fb0e044ec4212b40df1bd1722f82d7099a6969994ace25f5644babdcc0d61f96
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.12

Release history Release notifications | RSS feed

This release

0.19.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page