Skip to main content

Async Support for various databases

Project description

AIO-Databases

The package gives you asycio support for a range of databases (SQLite, PostgreSQL, MySQL).

Tests Status PYPI Version Python Versions

Requirements

  • python >= 3.7

Installation

aio-databases should be installed using pip:

$ pip install aio-databases

You have to choose and install the required database drivers with:

# To support SQLite
$ pip install aio-databases[aiosqlite]

# To support MySQL
$ pip install aio-databases[aiomysql]

# To support PostgreSQL (choose one)
$ pip install aio-databases[aiopg]
$ pip install aio-databases[asyncpg]

Usage

  • Init a database
    from aio_databases import Database

    db = Database('sqlite:///:memory:')
  • Prepare the database to work
    async def my_app_starts():
        # Initialize a database's pool
        await db.connect()

    async def my_app_ends():
        # Close pool/connections
        await db.disconnect()

    # As an alternative users are able to use the database
    # as an async context manager

    async with db:
        await my_main_coroutine()
  • Run SQL queries
    await db.execute('select $1', '1')
    await db.executemany('select $1', '1', '2', '3')

    records = await db.fetchall('select (2 * $1) res', 2)
    assert records == [(4,)]

    record = await db.fetchone('select (2 * $1) res', 2)
    assert record == (4,)
    assert record['res'] == 4

    result = await db.fetchval('select 2 * $1', 2)
    assert result == 4
  • Use transactions
    async with db.transaction() as trans1:
        # do some work ...

        async with db.transaction() as trans2:
            # do some work ...
            await trans2.rollback()
  • Manage connections
    await db.connection.acquire()
    # ...
    await db.connection.relese()

    # an alternative
    async with db.connection:
        # ...

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/aio-databases/issues

Contributing

Development of the project happens at: https://github.com/klen/aio-databases

License

Licensed under a MIT License

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

aio-databases-0.0.20.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

aio_databases-0.0.20-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file aio-databases-0.0.20.tar.gz.

File metadata

  • Download URL: aio-databases-0.0.20.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.7.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for aio-databases-0.0.20.tar.gz
Algorithm Hash digest
SHA256 751b59897a702339f3c62967dd5ec5f54684e43fcff9417b6c689ec79ca70907
MD5 634ca5966b2a45468141a00fc3ffbf90
BLAKE2b-256 76687dea3b2081b4465f0306ff8de8c4f981f4470cd086d07f027e9db7849c6e

See more details on using hashes here.

File details

Details for the file aio_databases-0.0.20-py3-none-any.whl.

File metadata

  • Download URL: aio_databases-0.0.20-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.7.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for aio_databases-0.0.20-py3-none-any.whl
Algorithm Hash digest
SHA256 80210c3a2c56c77582fb3f87364820e62bb2cd4bf72f0207cf24418857613583
MD5 d3b3ad8034bf3cbbcfb22080fcd232e1
BLAKE2b-256 c101b7d0e86661d3031dec120b1f7666fa6d3c7cd992e5368102861c0fd04062

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