Skip to main content

Model CRUD manager to handle databases with asynchronous SQLAlchemy sessions

Project description

SQLAlchemy Model CRUD

Model CRUD manager to handle databases with asynchronous SQLAlchemy sessions.

Project Status

⚠️ Warning: This project is currently in development phase.

This project is in an early stage of development and may contain bugs. It is not recommended for use in production environments.

Why use sa_crudmodel?

  • 🚀 Fast to code: Increase the speed to develop integrations features.
  • Fewer bugs: Reduce human (developer) induced errors.
  • 💡 Intuitive: Great editor support. Completion everywhere. Less time debugging.
  • 🤓 Easy: Designed to be easy to use and learn. Less time reading docs.
  • 〽️ Short: Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs.


Python 3.8+

SQLAlchemy Model CRUD stands on the soulders of giants:


$  pip install sa-modelcrud


Database Model prepare

  • Create a database model with:
from sqlalchemy.orm import Mapped, mapped_column
from sa_modelcrud.models import ModelBase, Timestamp

class Sample(Timestamp, ModelBase):
    # ModelBase contains id and uid properties
    email: Mapped[str] = mapped_column(nullable=True, unique=True)

Create schemas

from typing import Optional
from uuid import UUID
from pydantic import BaseModel

class SampleBase(BaseModel):
    id: Optional[int] = None
    uid: Optional[UUID] = None
    email: Optional[str] = None

class SampleCreate(SampleBase):

class SampleUpdate(SampleBase):

Create CRUD

from sa_modelcrud import CRUDBase

class CRUDSample(CRUDBase[Sample, SampleCreate, SampleUpdate]):
    model = Sample

samples = CRUDSample()

Create session

from sqlalchemy.ext.asyncio import (

DB_URI = "sqlite+aiosqlite:///./db.sqlite3"

async_engine: AsyncEngine = create_async_engine(
    connect_args={"check_same_thread": False}

AsyncSessionLocal: AsyncSession = async_sessionmaker(

Use the CRUD

async with AsyncSessionLocal() as db:
    data = SampleCreate(email="sample@sample")

    # save data into database
    sample_obj = await samples.create(db=db, element=data)

General CRUD Methods

All inherited CRUDBase instances have the following methods:

  • .get(..., uid): Get row from model by uid.
  • .get_or_raise(..., uid): Try to get row from model by uid. Raise if not object found.
  • .list(...): Get multi items from database.
  • .filter(..., whereclause): Get items from database using whereclause to filter.
  • .find(..., **kwargs): Find elements with kwargs.
  • .find_one(..., **kwargs): Find an element with kwargs.
  • .create(..., element): Create an element into database.
  • .bulk_create(..., elements): Create elements into database.
  • .update(..., obj, data): Update a database obj with an update data schema.
  • .delete(..., uid): Delete an item from database.


  • Paginate results of methods list, filter and find.
  • Add default values for offset and limit on paginated methods.
  • Add support for Sync Sessions.
  • Create complete documentation in Readthedocs.

Contributions and Feedback

I would love to receive contributions and feedback! If you'd like to get involved, please contact me through one of the contact methods in my Profile.


This project is licensed under the terms of the 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

sa_modelcrud-0.3.2.tar.gz (9.4 kB view hashes)

Uploaded Source

Built Distribution

sa_modelcrud-0.3.2-py3-none-any.whl (11.9 kB view hashes)

Uploaded Python 3

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