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:
        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.14.0.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

aiosqlite-0.14.0-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aiosqlite-0.14.0.tar.gz
Algorithm Hash digest
SHA256 c08580eea5e1e256e09e83b8504da5bf96df33fa5e469f4d442ee45763935f72
MD5 f7eae249af5ab9bef3fa4081374c0178
BLAKE2b-256 e54054784db966c5bb52af3ddcd9782ee81af6f265343716b4c9d8a53dabe9f2

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for aiosqlite-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 063e33c4f03f98c91c1012d760a37cb26eb3763b264505ae5a23e991a6d17237
MD5 a5969453bd8c6d75aa335d66a1b5f2b4
BLAKE2b-256 36e092322a09c30c72eac842b74d82012687840e86b69b4ea96e5e7aec38c850

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