Skip to main content

asyncio bridge to the standard sqlite3 module

Project description

PyPI Release Documentation Status Changelog Code Coverage Build Status MIT Licensed Code Style Black

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.6 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 John 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.17.0.tar.gz (25.9 kB view details)

Uploaded Source

Built Distribution

aiosqlite-0.17.0-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiosqlite-0.17.0.tar.gz
  • Upload date:
  • Size: 25.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.1

File hashes

Hashes for aiosqlite-0.17.0.tar.gz
Algorithm Hash digest
SHA256 f0e6acc24bc4864149267ac82fb46dfb3be4455f99fe21df82609cc6e6baee51
MD5 6d329ca418d7df462750640366515b11
BLAKE2b-256 40e0ad1edd74311831ca71b32a5b83352b490d78d11a90a1cde04e1b6830e018

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: aiosqlite-0.17.0-py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.1

File hashes

Hashes for aiosqlite-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6c49dc6d3405929b1d08eeccc72306d3677503cc5e5e43771efc1e00232e8231
MD5 06bfb5c2cac50371ec033df3ee663169
BLAKE2b-256 a04877c0092f716c4bf9460dca44f5120f70b8f71f14a12f40d22551a7152719

See more details on using hashes here.

Provenance

Supported by

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