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.7 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.18.0.tar.gz (27.1 kB view details)

Uploaded Source

Built Distribution

aiosqlite-0.18.0-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aiosqlite-0.18.0.tar.gz
Algorithm Hash digest
SHA256 faa843ef5fb08bafe9a9b3859012d3d9d6f77ce3637899de20606b7fc39aa213
MD5 1ebed736d07d246f473d0e09a5d1cbf7
BLAKE2b-256 bdb19c9c5847461c8eed8fa36e72541c53054987993227e1782d4f92e902cbe6

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for aiosqlite-0.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c3511b841e3a2c5614900ba1d179f366826857586f78abd75e7cbeb88e75a557
MD5 5d2947d6fdc537fd991c7f051b0409f9
BLAKE2b-256 28b02c2766e12cc7ec623294d12f1e544ea50f17403d723a03c671f6c5eadac9

See more details on using hashes here.

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