Skip to main content

aiosqlite: Sqlite for AsyncIO

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-black

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-black 0.21.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-black 0.21.0
File Size Uploaded
aiosqlite_black-0.21.0.tar.gz 21.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aiosqlite-black 0.21.0
File Interpreter ABI Platform
aiosqlite_black-0.21.0-py3-none-any.whl Python 3 none any Details

Total release size: 37.3 kB

Release files / aiosqlite_black-0.21.0.tar.gz

Download URL aiosqlite_black-0.21.0.tar.gz
Size 21.5 kB
Tags Source
SHA-256 checksum
How to use checksums
db36416d340d95aab71e4993a45c256cb1c7a3bb62df21dcdce20d06aed9c358
BLAKE2b-256 checksum
How to use checksums
c1cbf6433099abbc6208021b8b53717f957f3d3661cc38bd88c4b85a78d79f69
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.31.0

Release files / aiosqlite_black-0.21.0-py3-none-any.whl

Download URL aiosqlite_black-0.21.0-py3-none-any.whl
Size 15.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
30fed8cb055d0e0465553a6143c72097dcffdfc3e4ef884a0ad03c26ca7e5b9f
BLAKE2b-256 checksum
How to use checksums
10cdfc17018de28eefd0374c83f3a794586f197eda7a77ca8e699dee12e5f324
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.31.0

Release history Release notifications | RSS feed

This release

0.21.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