Sqlalchemy_aio

sqlalchemy_aio

sqlalchemy_aio ============== |PyPI Version| |Documentation| |Travis| |Coverage| |MIT License| `sqlalchemyaio adds asyncio and Trio support to SQLAlchemy core, derived from alchimia_. +-------------------------------------------------------------------------------+ | ⚠️ Compatibility Note | +===============================================================================+ | SQLAlchemy 1.3 is the latest supported version. SQLAlchemy 1.4 | | brings native asyncio support_, so you should consider using that instead. | +-------------------------------------------------------------------------------+ .. _alchimia: https://github.com/alex/alchimia .. _Trio: https://github.com/python-trio/trio .. _native asyncio support: https://docs.sqlalchemy.org/en/14/orm/extensions/asyncio.html Getting started .. code-block:: python import asyncio from sqlalchemyaio import ASYNCIOSTRATEGY from sqlalchemy import ( Column, Integer, MetaData, Table, Text, create_engine, select) from sqlalchemy.schema import CreateTable, DropTable async def main(): engine = create_engine( In-memory sqlite database cannot be accessed from different threads, use file. 'sqlite:///test.db', strategy=ASYNCIO_STRATEGY ) metadata = MetaData() users = Table( 'users', metadata, Column('id', Integer, primary_key=True), Column('name', Text), ) Create the table await engine.execute(CreateTable(users)) conn = await engine.connect() Insert some users await conn.execute(users.insert().values(name='Jeremy Goodwin')) await conn.execute(users.insert().values(name='Natalie Hurley')) await conn.execute(users.insert().values(name='Dan Rydell')) await conn.execute(users.insert().values(name='Casey McCall')) await conn.execute(users.insert().values(name='Dana Whitaker')) result = await conn.execute(users.select(users.c.name.startswith('D'))) d_users = await result.fetchall() await conn.close() Print out the users for user in d_users: print('Username: %s' % user[users.c.name]) Supports context async managers async with engine.connect() as conn: async with conn.begin() as trans: assert await conn.scalar(select([1])) == 1 await engine.execute(DropTable(users)) if name == 'main': loop = asyncio.geteventloop() loop.rununtilcomplete(main()) Getting started with Trio To use the above example with Trio_, just change the following: .. code-block:: python import trio from sqlalchemyaio import TRIOSTRATEGY async def main(): engine = createengine('sqlite:///test.db', strategy=TRIOSTRATEGY) ... trio.run(main) What is this? It's not an asyncio implementation of SQLAlchemy or the drivers it uses. sqlalchemy_aio lets you use SQLAlchemy by running operations in a separate thread. If you're already using runinexecutor_ to execute SQLAlchemy tasks, sqlalchemy_aio will work well with similar performance. If performance is critical, perhaps asyncpg_ can help. .. _asyncpg: https://github.com/MagicStack/asyncpg .. runinexecutor: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.AbstractEventLoop.runin_executor Documentation The documentation`_ has more information, including limitations of the API. .. _The documentation: https://sqlalchemy-aio.readthedocs.io/en/latest/ .. |PyPI Version| image:: https://img.shields.io/pypi/v/sqlalchemy_aio.svg?style=flat-square :target: https://pypi.python.org/pypi/sqlalchemy_aio/ .. |Documentation| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat-square :target: https://sqlalchemy-aio.readthedocs.io/en/latest/ .. |Travis| image:: http://img.shields.io/travis/RazerM/sqlalchemy_aio/master.svg?style=flat-square&label=travis :target: https://travis-ci.org/RazerM/sqlalchemy_aio .. |Coverage| image:: https://img.shields.io/codecov/c/github/RazerM/sqlalchemy_aio/master.svg?style=flat-square :target: https://codecov.io/github/RazerM/sqlalchemy_aio?branch=master .. |MIT License| image:: http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square :target: https://raw.githubusercontent.com/RazerM/sqlalchemy_aio/master/LICENSE