Fastapi-SQLA
A production-ready SQLAlchemy extension for FastAPI with built-in pagination, async support, SQLModel integration, and pytest fixtures.
What is Fastapi-SQLA?
Fastapi-SQLA is a SQLAlchemy extension for FastAPI that provides essential database utilities like pagination, session management, and testing support. It solves the problem of integrating SQLAlchemy with FastAPI in a production-ready manner, offering async compatibility and seamless SQLModel integration.
Backend developers building FastAPI applications with SQLAlchemy who need robust database utilities, pagination, and testing support.
Developers choose Fastapi-SQLA for its production-ready features, minimal configuration, and comprehensive support for modern Python async patterns and SQLAlchemy 2.0.
Overview
SQLAlchemy extension for FastAPI with support for pagination, asyncio, SQLModel and pytest, ready for production.
Use Cases
Best For
- Adding pagination to FastAPI endpoints with SQLAlchemy queries
- Building async FastAPI applications with PostgreSQL using asyncpg
- Integrating SQLModel with FastAPI for type-safe database operations
- Testing FastAPI applications with pre-configured database fixtures
- Managing multiple database sessions in a single FastAPI application
- Simplifying SQLAlchemy session injection in FastAPI dependency system
Not Ideal For
- Applications using asynchronous databases other than PostgreSQL, as async support is specifically tied to asyncpg and PostgreSQL.
- Projects that require minimal database abstraction and prefer to handle SQLAlchemy sessions and pagination manually without extra utilities.
- Teams already using alternative FastAPI-SQLAlchemy integrations like the FastAPI-SQLAlchemy library, as migration might not justify the switch.
- Simple CRUD APIs where the overhead of configuring multi-session support and pagination is unnecessary for basic operations.
Pros & Cons
Pros
Offers customizable pagination with async compatibility, simplifying endpoint creation in FastAPI, as shown with Paginate and Page response models in examples.
Provides full compatibility with SQLModel for type-safe database interactions without additional setup, demonstrated in the SQLModel support section.
Includes pre-configured Pytest fixtures with automatic transaction rollback and Alembic migration support, easing testing workflows for database operations.
Supports asyncio with asyncpg for PostgreSQL, enabling non-blocking queries in FastAPI, detailed in the async support configuration.
Cons
Async functionality is limited to PostgreSQL via asyncpg, with no native support for other async database drivers, restricting database flexibility.
Configuring multiple sessions requires specific environment variable naming and SQLAlchemy engine knowledge, adding initial complexity.
Pytest fixtures assume Alembic for migrations, which may not align with projects using other migration tools or custom strategies.
Frequently Asked Questions
Related Projects
PiccoloA fast, user friendly ORM and query builder which supports asyncio.
ORMAn async ORM. 🗃
AerichA database migrations tool for TortoiseORM, ready to production.
FastAPI SQLAlchemyAdds simple SQLAlchemy support to FastAPI
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.