sqlalchemy-tenants 0.2.0

Add your description here

Multi-tenancy with SQLAlchemy made easy.

---

Documentation: telemaco019.github.io/sqlalchemy-tenants

If you like the project please support it by leaving a star ✨

---

Overview

sqlalchemy-tenants makes it easy and safe to implement multi-tenancy in your application using SQLAlchemy. It enables secure, shared use of a single database across multiple tenants using Row-Level Security (RLS).

Key Features

• 🔒 Strong Data Segregation via RLS: Automatic query and write scoping using Row-Level Security.
• ⚙️ Straightforward Integration: Just a decorator and a session manager.
• 📦 Full SQLAlchemy support: Compatible with both sync and async workflows.

Supported Databases

• PostgreSQL only (support for more databases is planned).

Example Usage

from sqlalchemy_tenants import with_rls
from sqlalchemy_tenants.aio.managers import PostgresManager
from sqlalchemy.ext.asyncio import create_async_engine
from sqlalchemy import select, insert

engine = create_async_engine("postgresql+asyncpg://user:password@localhost/dbname")
manager = PostgresManager.from_engine(engine, schema="public")

@with_rls
class MyTable(Base):
    __tablename__ = "my_table"

    id: Mapped[int] = mapped_column(primary_key=True)
    name: Mapped[str] = mapped_column()
    tenant: Mapped[str] = mapped_column()  # Required tenant column


async with manager.new_tenant_session("tenant_1") as session:
    # ✅ Only returns tenant_1’s rows
    await session.execute(select(MyTable))  
    
    # ❌ Raises error: mismatched tenant
    await session.execute(  
        insert(MyTable).values(id=1, name="Example", tenant="tenant_2")
    )
    
    # ✅ Correct insert: use session.tenant for current tenant
    await session.execute(
        insert(MyTable).values(id=1, name="Example", tenant=session.tenant)
    )

Both sync and async versions are available.

🔍 Want more? Check out the documentation and the examples for additional use cases.

License

This project is licensed under the MIT license. See the LICENSE file for details.