Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asynq-io/sqlargon
SQLAlchemy utils for Postgres and Sqlite
https://github.com/asynq-io/sqlargon
asyncio python sqlalchemy
Last synced: 2 months ago
JSON representation
SQLAlchemy utils for Postgres and Sqlite
- Host: GitHub
- URL: https://github.com/asynq-io/sqlargon
- Owner: asynq-io
- License: apache-2.0
- Created: 2024-07-16T13:00:41.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-11-05T08:59:42.000Z (3 months ago)
- Last Synced: 2024-11-05T09:38:23.969Z (3 months ago)
- Topics: asyncio, python, sqlalchemy
- Language: Python
- Homepage:
- Size: 813 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SQLArgon
[](https://github.com/charliermarsh/ruff)
[](https://github.com/PyCQA/bandit)
*Wrapper around SQLAlchemy async session, core and Postgres native features*
---
Version: 0.6.5
Documentation: https://asynq-io.github.io/sqlargon/
Repository: https://github.com/asynq-io/sqlargon
---
## About
This library provides glue code to use sqlalchemy async sessions, core queries and orm models
from one object which provides somewhat of repository pattern. This solution has few advantages:
- no need to pass `session` object to every function/method. It is stored (and optionally injected) in repository object
- write data access queries in one place
- no need to import `insert`,`update`, `delete`, `select` from sqlalchemy over and over again
- Implicit cast of results to `.scalars().all()` or `.one()`
- Your view model (e.g. FastAPI routes) does not need to know about the underlying storage. Repository class can be replaced at any moment any object providing similar interface.
## Usage
```python
import sqlalchemy as sa
from sqlalchemy.orm import Mapped
from sqlargon import GUID, GenerateUUID, Database, Base, SQLAlchemyRepository
db = Database(url=...)
class User(Base):
id = sa.Column(
GUID(), primary_key=True, server_default=GenerateUUID(), nullable=False
)
name: Mapped[str] = sa.Column(sa.Unicode(255))
class UserRepository(SQLAlchemyRepository[User]):
async def get_user_by_name(self, name: str):
# custom user function
return await self.select().filter_by(name=name).one()
user_repository = UserRepository(db)
# select
await user_repository.all()
await user_repository.list(User.name == "test", User.id >= 18)
# insert
user = await user_repository.insert({"name": "test"}).one()
await user_repository.commit()
# delete
await user_repository.delete().filter(name="John").one()
# custom sqlalchemy core functions
users = await user_repository.select().join(...).filter(
User.name == "test"
).filter_by(...).order_by(User.created_at).limit(2).all()
```
## Sessions
Manager object needs `sqlalchemy.ext.asyncio.AsyncSession`, but it's possible
to provide the session object by yourself, by subclassing Manager class e.g.
```python
from sqlargon import Database, SQLAlchemyRepository
from fastapi import Depends
db = Database(url="sqlite+aiosqlite:///:memory:")
class UserRepository(SQLAlchemyRepository[User]):
...
from fastapi import FastAPI
app = FastAPI()
@app.get("/users")
async def get_users(user_repository: UserRepository = db.Depends(UserRepository)):
return await user_repository.all()
```