Skip to main content

asyncio bridge to the standard sqlite3 module

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiosqlite-0.21.0.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

aiosqlite-0.21.0-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

Details for the file aiosqlite-0.21.0.tar.gz.

File metadata

  • Download URL: aiosqlite-0.21.0.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for aiosqlite-0.21.0.tar.gz
Algorithm Hash digest
SHA256 131bb8056daa3bc875608c631c678cda73922a2d4ba8aec373b19f18c17e7aa3
MD5 693b491a6ad7caa281618a83bf83ddc6
BLAKE2b-256 137d8bca2bf9a247c2c5dfeec1d7a5f40db6518f88d314b8bca9da29670d2671

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiosqlite-0.21.0.tar.gz:

Publisher: ci.yml on omnilib/aiosqlite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aiosqlite-0.21.0-py3-none-any.whl.

File metadata

  • Download URL: aiosqlite-0.21.0-py3-none-any.whl
  • Upload date:
  • Size: 15.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for aiosqlite-0.21.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2549cf4057f95f53dcba16f2b64e8e2791d7e1adedb13197dd8ed77bb226d7d0
MD5 e56414f9d7c48f49d0aef32c16119e9b
BLAKE2b-256 f5106c25ed6de94c49f88a91fa5018cb4c0f3625f31d5be9f771ebe5cc7cd506

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiosqlite-0.21.0-py3-none-any.whl:

Publisher: ci.yml on omnilib/aiosqlite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page