Skip to main content

aiosqlite

AsyncIO bridge to the standard sqlite3 module for Python 3.5+

build status version license code style

Install

aiosqlite is compatible with Python 3.5 and newer. You can install it from PyPI with the following command:

$ pip install aiosqlite

Usage

aiosqlite replicates the standard sqlite3 module, but with async versions of all the standard connection and cursor methods, and context managers for automatically closing connections:

    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:
                ...

Alternately, you can continue using connections more directly:

    async with aiosqlite.connect(...) as db:
        cursor = await db.execute('SELECT * FROM some_table')
        row = await cursor.fetchone()
        rows = await cursor.fetchall()
        await cursor.close()

aiosqlite also replicates most of the standard connection properties, as needed for advanced use cases like row or text factories, or for tracking the total number of rows inserted, modified, or deleted:

    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

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.

Release files for aiosqlite 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aiosqlite 0.8.1
File Size Uploaded
aiosqlite-0.8.1.tar.gz 5.9 kB Details

Release files / aiosqlite-0.8.1.tar.gz

Download URL aiosqlite-0.8.1.tar.gz
Size 5.9 kB
Tags Source
SHA-256 checksum
How to use checksums
a29bf465f0c366c9495c90c1802e62828eeccf12f3d704a33b14a50851e1715f
BLAKE2b-256 checksum
How to use checksums
fc0ccb7df346fce249de017442c5e53780e81c0903d330f604dfb11b0530dc93
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.5

Release history Release notifications | RSS feed

0.22.1

2 release files

0.22.0

2 release files

0.20.0

2 release files

0.19.0

2 release files

0.18.0

2 release files

0.17.0

2 release files

0.16.1

2 release files

0.15.0

2 release files

0.14.1

2 release files

0.14.0

2 release files

0.12.0

1 release file

0.11.0

1 release file

0.10.0

1 release file

0.9.0

1 release file

This release

0.8.1 This release

1 release file

0.8.0

1 release file

0.7.0

1 release file

0.6.0

1 release file

0.5.0

1 release file

0.4.0

1 release file

0.3.0

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page