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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aiosqlite-0.20.0.tar.gz
Algorithm Hash digest
SHA256 6d35c8c256637f4672f843c31021464090805bf925385ac39473fb16eaaca3d7
MD5 22620fe09bc9d9df3bffef19919eed7f
BLAKE2b-256 0d3a22ff5415bf4d296c1e92b07fd746ad42c96781f13295a074d58e77747848

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for aiosqlite-0.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36a1deaca0cac40ebe32aac9977a6e2bbc7f5189f23f4a54d5908986729e5bd6
MD5 3920fd189a10e6a1643c1bedd8f6e0a4
BLAKE2b-256 00c4c93eb22025a2de6b83263dfe3d7df2e19138e345bca6f18dba7394120930

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