Skip to main content

SQLAlchemy 1.4 / 2.0 support for aiohttp.

Project description

Documentation Status https://badge.fury.io/py/aiohttp-sqlalchemy.svg Downloads count https://travis-ci.com/ri-gilfanov/aiohttp-sqlalchemy.svg?branch=master https://coveralls.io/repos/github/ri-gilfanov/aiohttp-sqlalchemy/badge.svg?branch=master

SQLAlchemy 1.4 / 2.0 support for aiohttp.

The library provides the next features:

  • forwarding SQLAlchemy asynchronous sessions for function handlers, class organized handlers, and class based view methods;

  • a middleware factory sa_middleware(key: str = 'sa_main')' for forwarding sessions as request[key] for all your request handlers;

  • a decorator sa_decorator(key: str = 'sa_main') for forwarding sessions as request[key] for your chosen handlers;

  • a parent class SAView for forwarding sessions as SAView.sa_session(key: str = 'sa_main') method.

Documentation

https://aiohttp-sqlalchemy.readthedocs.io

Installation

pip install aiohttp-sqlalchemy

Simple example

Install aiosqlite for work with sqlite3:

pip install aiosqlite

Copy and paste this code in a file and run:

from aiohttp import web
import aiohttp_sqlalchemy
from aiohttp_sqlalchemy import sa_bind
from datetime import datetime
import sqlalchemy as sa
from sqlalchemy import orm
from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine


metadata = sa.MetaData()
Base = orm.declarative_base(metadata=metadata)


class MyModel(Base):
    __tablename__ = 'my_table'
    id = sa.Column(sa.Integer, primary_key=True)
    timestamp = sa.Column(sa.DateTime(), default=datetime.now)


async def main(request):
    async with request['sa_main'].bind.begin() as conn:
        await conn.run_sync(Base.metadata.create_all)

    async with request['sa_main'].begin():
        request['sa_main'].add_all([MyModel()])
        result = await request['sa_main'].execute(sa.select(MyModel))
        data = {r.id: r.timestamp.isoformat() for r in result.scalars()}
        return web.json_response(data)


app = web.Application()

engine = create_async_engine('sqlite+aiosqlite:///')
Session = orm.sessionmaker(engine, AsyncSession)
aiohttp_sqlalchemy.setup(app, [sa_bind(Session)])

app.add_routes([web.get('/', main)])

if __name__ == '__main__':
    web.run_app(app)

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiohttp-sqlalchemy-0.9.3.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiohttp_sqlalchemy-0.9.3-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file aiohttp-sqlalchemy-0.9.3.tar.gz.

File metadata

  • Download URL: aiohttp-sqlalchemy-0.9.3.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.5 Linux/5.4.0-74-generic

File hashes

Hashes for aiohttp-sqlalchemy-0.9.3.tar.gz
Algorithm Hash digest
SHA256 1b78929d4b40672aceebec1306d7d34b7641664d38ece86896abbf2fbc85182d
MD5 756ba20b57470eada0f4849fd5784f42
BLAKE2b-256 491fd12c9e08223225562310c81c0d2bda7f109403a9aa80868822a79090b83d

See more details on using hashes here.

File details

Details for the file aiohttp_sqlalchemy-0.9.3-py3-none-any.whl.

File metadata

  • Download URL: aiohttp_sqlalchemy-0.9.3-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.9.5 Linux/5.4.0-74-generic

File hashes

Hashes for aiohttp_sqlalchemy-0.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 38076511a2f62b3e63e445bbf35df06bb13aa3453e91e344b53e4603b94f6943
MD5 4e6230baad81a8873dd7b824a5757d74
BLAKE2b-256 48c0463c58e65cbf0650a53409b9a83a5c20a2bd01d481b257418be2566a0f13

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page