Repository files navigation

aiosqlite provides a friendly, async interface to sqlite databases.

It replicates the standardsqlite3 module, but with async versionsof all the standard connection and cursor methods, plus context managers forautomatically closing connections and cursors:

asyncwithaiosqlite.connect(...)asdb:awaitdb.execute("INSERT INTO some_table ...")awaitdb.commit()asyncwithdb.execute("SELECT * FROM some_table")ascursor:asyncforrowincursor:            ...

It can also be used in the traditional, procedural manner:

db=awaitaiosqlite.connect(...)cursor=awaitdb.execute('SELECT * FROM some_table')row=awaitcursor.fetchone()rows=awaitcursor.fetchall()awaitcursor.close()awaitdb.close()

aiosqlite also replicates most of the advanced features ofsqlite3:

asyncwithaiosqlite.connect(...)asdb:db.row_factory=aiosqlite.Rowasyncwithdb.execute('SELECT * FROM some_table')ascursor:asyncforrowincursor:value=row['column']awaitdb.execute('INSERT INTO foo some_table')assertdb.total_changes>0

aiosqlite is compatible with Python 3.8 and newer.You can install it from PyPI:

$pip install aiosqlite

aiosqlite allows interaction with SQLite databases on the main AsyncIO eventloop without blocking execution of other coroutines while waiting for queriesor data fetches. It does this by using a single, shared thread per connection.This thread executes all actions within a shared request queue to preventoverlapping actions.

Connection objects are proxies to the real connections, contain the sharedexecution thread, and provide context managers to handle automatically closingconnections. Cursors are similarly proxies to the real cursors, and provideasync iterators to query results.

aiosqlite is copyrightAmethyst Reese, and licensed under theMIT license. I am providing code in this repository to you under an open sourcelicense. This is my personal repository; the license you receive to my codeis from me and not from my employer. See theLICENSE file for details.