https://github.com/omnilib/aiosqlite

asyncio bridge to the standard sqlite3 module
https://github.com/omnilib/aiosqlite

asyncio hacktoberfest python sqlite sqlite3

Last synced: 4 days ago
JSON representation

asyncio bridge to the standard sqlite3 module

• Host: GitHub
• URL: https://github.com/omnilib/aiosqlite
• Owner: omnilib
• License: mit
• Created: 2017-05-25T03:09:18.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-08-15T15:12:14.000Z (4 months ago)
• Last Synced: 2024-10-29T14:04:59.776Z (about 2 months ago)
• Topics: asyncio, hacktoberfest, python, sqlite, sqlite3
• Language: Python
• Homepage: https://aiosqlite.omnilib.dev
• Size: 310 KB
• Stars: 1,197
• Watchers: 12
• Forks: 94
• Open Issues: 41
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
aiosqlite\: Sqlite for AsyncIO

==============================

.. image:: https://readthedocs.org/projects/aiosqlite/badge/?version=latest

   :target: https://aiosqlite.omnilib.dev/en/latest/?badge=latest

   :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/aiosqlite.svg

   :target: https://pypi.org/project/aiosqlite

   :alt: PyPI Release

.. image:: https://img.shields.io/badge/change-log-blue

   :target: https://github.com/omnilib/aiosqlite/blob/master/CHANGELOG.md

   :alt: Changelog

.. image:: https://img.shields.io/pypi/l/aiosqlite.svg

   :target: https://github.com/omnilib/aiosqlite/blob/master/LICENSE

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

.. code-block:: python

    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:

.. code-block:: python

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

.. code-block:: python

    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:

.. code-block:: console

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

.. _LICENSE: https://github.com/omnilib/aiosqlite/blob/master/LICENSE