Awesome SQLAlchemy

.. image:: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg :target: https://github.com/sindresorhus/awesome

A curated list of awesome extra libraries and resources for SQLAlchemy_. Inspired by awesome-python_. (See also other awesome lists__!)

Licensed under a Creative Commons Attribution-ShareAlike 4.0 International License__.

.. _SQLAlchemy: https://www.sqlalchemy.org/ .. _awesome-python: https://github.com/vinta/awesome-python __ https://github.com/sindresorhus/awesome __ https://creativecommons.org/licenses/by-sa/4.0/

.. contents:: Table of Contents :backlinks: none :depth: 3

Data Structures

SQLAlchemy-Continuum_ Versioning and auditing extension for SQLAlchemy.

Creates versions for inserts, deletes and updates.
Does not store updates which don't change anything.
Supports alembic migrations.
Can revert objects data as well as all object relations at given transaction even if the object was deleted.
Transactions can be queried afterwards using SQLAlchemy query syntax.
Query for changed records at given transaction.
Temporal relationship reflection. Version object's relationship show the parent objects relationships as they where in that point in time.
Supports native versioning for PostgreSQL database (trigger based versioning).

sqlalchemy_mptt_ Library for implementing MPTT (modified preorder tree traversal) with SQLAlchemy models and working with trees of model instances, like django-mptt_.

SQLAlchemy-ORM-tree_ An implementation for SQLAlchemy-based applications of the nested-sets/modified-pre-order-tree-traversal technique for storing hierarchical data in a relational database.

vdm_ Versioned domain model. Python library for revisioning/versioning of databases.

.. _django-mptt: https://github.com/django-mptt/django-mptt/ .. _SQLAlchemy-Continuum: https://sqlalchemy-continuum.readthedocs.io/ .. _sqlalchemy_mptt: https://sqlalchemy-mptt.readthedocs.io/ .. _SQLAlchemy-ORM-tree: https://sqlalchemy-orm-tree.readthedocs.io/ .. _vdm: https://github.com/okfn/vdm

Data Types

SQLAlchemy-Enum34_ SQLAlchemy type to store standard enum.Enum values.

SQLAlchemy-Utc_ SQLAlchemy type to store aware datetime.datetime values.

SQLAlchemy-Utils_ Various utility functions, new data types and helpers for SQLAlchemy

Listeners
Data types: {..., ChoiceType, CountryType, JSONType, URLType, UUIDType, ...}
Range data types
Aggregated attributes
Generates decorator
Generic relationships
Database helpers: create_database, drop_database
Foreign key helpers
ORM helpers
Utility classes
Model mixins: Timestamp (created, updated times)

.. _SQLAlchemy-Enum34: https://github.com/spoqa/sqlalchemy-enum34 .. _SQLAlchemy-Utc: https://github.com/spoqa/sqlalchemy-utc .. _SQLAlchemy-Utils: https://sqlalchemy-utils.readthedocs.io/

Database Migration Tools

Alembic_ Alembic is a lightweight database migration tool for usage with the SQLAlchemy Database Toolkit for Python.

sqlalchemy-migrate_ Inspired by Ruby on Rails' migrations, SQLAlchemy Migrate provides a way to deal with database schema changes in SQLAlchemy projects.

.. _Alembic: https://alembic.readthedocs.io/ .. _sqlalchemy-migrate: https://sqlalchemy-migrate.readthedocs.io/

Dialects

https://docs.sqlalchemy.org/en/latest/dialects/

redshift_sqlalchemy_ Amazon Redshift_ dialect for SQLAlchemy.

sphinxalchemy_ SQLAlchemy dialect for interfacing with Sphinx_ (search engine) via SphinxQL.

GINO_ An asynchronous PostgreSQL dialect for asyncpg_, providing SQLAlchemy core support and its own asynchronous ORM interface.

.. _Amazon Redshift: https://aws.amazon.com/redshift/ .. _redshift_sqlalchemy: https://github.com/binarydud/redshift_sqlalchemy .. _Sphinx: https://sphinxsearch.com/ .. _sphinxalchemy: https://sphinxalchemy.readthedocs.io/ .. _GINO: https://github.com/python-gino/gino .. _asyncpg: https://github.com/MagicStack/asyncpg

Documentation

File and Image Attachments

filedepot_ DEPOT is a framework for easily storing and serving files in web applications. Depot features simple integration with SQLAlchemy by providing customized model field types for storing files attached to your ORM document.

SQLAlchemy-ImageAttach_ SQLAlchemy-ImageAttach is a SQLAlchemy extension for attaching images to entity objects.

sqlalchemy-media_ Based on SQLAlchemy-ImageAttach but using JSON type instead of relation, and SqlAlchemy's mutable facility, Also supports multiple stores per context.

.. _filedepot: https://depot.readthedocs.io/ .. _SQLAlchemy-ImageAttach: https://sqlalchemy-imageattach.readthedocs.io/ .. _sqlalchemy-media: https://github.com/pylover/sqlalchemy-media

Forms and Data Validations

ColanderAlchemy_ ColanderAlchemy helps you to auto-generate Colander_ schemas that are based on SQLAlchemy mapped classes.

Such Colander schemas can be used with libraries like Deform_ and helps remove the need for duplication of schema definitions.

Flask-Validator_ Data validator for Flask and SQL-Alchemy, working at Model component with events, preventing invalid data in the columns. The extension works with event listeners from SQLAlchemy.

FormAlchemy_ FormAlchemy eliminates boilerplate by autogenerating HTML input fields from a given model. FormAlchemy will try to figure out what kind of HTML code should be returned by introspecting the model's properties and generate ready-to-use HTML code that will fit the developer's application.

WTForms-Alchemy_ WTForms-Alchemy is a WTForms_ extension toolkit for easier creation of model based forms. Strongly influenced by Django ModelForm.

Sprox_ Sprox provides an easy way to create forms for web content which are: automatically generated, easy to customize, and validated. Sprox also has powerful tools to help you display your content the way you want to with table and record viewers. Sprox provides a way to fill your widgets, whether they are forms or other content with customizable data.

.. _Colander: https://docs.pylonsproject.org/projects/colander/ .. _ColanderAlchemy: https://github.com/stefanofontanelli/ColanderAlchemy .. _Deform: https://docs.pylonsproject.org/projects/deform/ .. _Flask-Validator: https://flask-validator.readthedocs.io/ .. _FormAlchemy: https://github.com/FormAlchemy/formalchemy .. _WTForms: https://wtforms.readthedocs.io/ .. _WTForms-Alchemy: https://wtforms-alchemy.readthedocs.io/ .. _Sprox: https://sprox.org/

Full-text Searching

SQLAlchemy-Searchable_ Full-text searchable models for SQLAlchemy. Only supports PostgreSQL.

.. _SQLAlchemy-Searchable: https://sqlalchemy-searchable.readthedocs.io/

SQLAlchemy-FullText-Search_ Fulltext search support with MySQL & SQLAlchemy.

.. _SQLAlchemy-FullText-Search: https://github.com/mengzhuo/sqlalchemy-fulltext-search

GIS and Spatial Databases

GeoAlchemy_ GeoAlchemy provides extensions to SQLAlchemy to work with spatial databases.

The current supported spatial database systems are PostGIS_, Spatialite_, MySQL, Oracle, and MS SQL Server 2008.

GeoAlchemy 2_ GeoAlchemy 2 provides extensions to SQLAlchemy for working with spatial databases.

GeoAlchemy 2 focuses on PostGIS_. PostGIS 1.5 and PostGIS 2 are supported. Spatialite_ is also supported, but using GeoAlchemy 2 with Spatialite requires some specific configuration on the application side.

GeoAlchemy 2 aims to be simpler than its predecessor, GeoAlchemy_. Simpler to use, and simpler to maintain.

.. _GeoAlchemy: https://geoalchemy.readthedocs.io/ .. _GeoAlchemy 2: https://geoalchemy-2.readthedocs.io/ .. _PostGIS: https://postgis.net/ .. _Spatialite: https://www.gaia-gis.it/gaia-sins/

Internationalizations

SQLAlchemy-i18n_ Internationalization extension for SQLAlchemy models.

Stores translations in separate tables.
Reflects translation table structures based on parent model table structure.
Supports forcing of given locale.
Good performance (uses proxy dicts and other advanced SQLAlchemy concepts for performance optimization).

.. _SQLAlchemy-i18n: https://sqlalchemy-i18n.readthedocs.io/

Profilers

flask_debugtoolbar_ Debug toolbar with SQLAlchemy query information for Flask.

pyramid_debugtoolbar_ Debug toolbar with SQLAlchemy query information for Pyramid.

SQLTap_ SQLTap is a library that allows you to profile and introspect the queries that your application makes using SQLAlchemy.

SQLTap helps you understand:

how many times a sql query is executed
how much time your sql queries take
where your application is issuing sql queries from

nplusone_ Auto-detect the n+1 queries problem in SQLAlchemy (and other Python ORMs)

nplusone detects unnecessary queries caused by lazy loading and unused eager loading. Integrates with Flask-SQLAlchemy.

.. _flask_debugtoolbar: https://github.com/flask-debugtoolbar/flask-debugtoolbar .. _pyramid_debugtoolbar: https://github.com/Pylons/pyramid_debugtoolbar .. _SQLTap: https://github.com/inconshreveable/sqltap .. _nplusone: https://github.com/jmcarp/nplusone

Query helpers

sqlakeyset_ This library implements keyset-based paging for SQLAlchemy (both ORM and core).

This library has been tested with PostgreSQL and MariaDB/MySQL. It should work with other SQLAlchemy-supported databases to provided they support row( syntax.

.. _sqlakeyset: https://github.com/djrobstep/sqlakeyset

Recipes

https://github.com/sqlalchemy/sqlalchemy/wiki/UsageRecipes

Serialization and deserialization

marshmallow-sqlalchemy_ SQLAlchemy integration with the marshmallow_ (de)serialization library.

pydantic_ Data parsing and validation using Python type hints

sqlalchemy-dict_ SQLAlchemy extension for interacting models with python dictionary.

.. _marshmallow: https://marshmallow.readthedocs.io/ .. _marshmallow-sqlalchemy: https://marshmallow-sqlalchemy.readthedocs.io/ .. _pydantic: https://github.com/samuelcolvin/pydantic .. _sqlalchemy-dict: https://github.com/meyt/sqlalchemy-dict

Testing

charlatan_ Fixtures management for SQLAlchemy and other systems.

factory_boy_ Generate fake data and create random fixtures for testing in SQLAlchemy and many other Python ORM systems.

mixer_ Generate fake data and create random fixtures for testing in SQLAlchemy and many other Python ORM systems.

.. _charlatan: https://github.com/uber/charlatan .. _factory_boy: https://github.com/FactoryBoy/factory_boy .. _mixer: https://github.com/klen/mixer

Thin Abstractions

Dataset_ Easy-to-use data handling for SQL data stores in Python with support for implicit table creation, bulk loading, and transaction. Dataset also includes support for freezing data to CSV and JSON flat files.

rdflib-sqlalchemy_ RDFLib_ store using SQLAlchemy dbapi as back-end.

PugSQL_ Loading and execution of parameterized queries stored in files.

SQLSoup_ SQLSoup provides a convenient way to map Python objects to relational database tables, with no declarative code of any kind. It's built on top of the SQLAlchemy ORM and provides a super-minimalistic interface to an existing database.

SQLModel_ SQLModel is a library for interacting with SQL databases from Python code, with Python objects. It is designed to be intuitive, easy to use, highly compatible, and robust. SQLModel is based on Python type annotations, and powered by Pydantic and SQLAlchemy.

Zillion_ Zillion is a free, open data warehousing and dimensional modeling tool that allows combining and analyzing data from multiple datasources through a simple API. It writes SQL so you don't have to, and it easily bolts onto existing database infrastructure via SQLAlchemy.

.. _Dataset: https://dataset.readthedocs.io/ .. _RDFLib: https://github.com/RDFLib/rdflib .. _rdflib-sqlalchemy: https://github.com/RDFLib/rdflib-sqlalchemy .. _PugSQL: https://pugsql.org/ .. _SQLSoup: https://sqlsoup.readthedocs.io/ .. _SQLModel: https://sqlmodel.tiangolo.com/ .. _Zillion: https://totalhack.github.io/zillion/

Vendor-specific Extensions

PostgreSQL ..........

Flask-SQLAlchemy-PGEvents <https://github.com/shawalli/flask-sqlalchemy-pgevents>_ Flask extension that uses SQLAlchemy and psycopg2-pgevents <https://github.com/shawalli/psycopg2-pgevents>_ to enable event listeners tied into database-layer triggers.

sqlalchemy-crosstab-postgresql_ New grammar for SQLAlchemy to make handling the crosstab() tablefunc (i.e. pivot tables) in PostgreSQL easy peasy.

sqlalchemy-postgres-copy_ Wrapper for using PostgreSQL COPY with SQLAlchemy for efficient bulk data imports and exports.

.. _sqlalchemy-crosstab-postgresql: https://github.com/makmanalp/sqlalchemy-crosstab-postgresql .. _sqlalchemy-postgres-copy: https://github.com/jmcarp/sqlalchemy-postgres-copy

Visualizations

sadisplay_ Simple package for describing SQLAlchemy schema and display raw database tables by reflecting feature.

sqlalchemy_schemadisplay_ This module generates images from SQLAlchemy models.

eralchemy_ ERAlchemy generates Entity Relation (ER) diagram from databases or from SQLAlchemy models.

paracelsus_ CLI and Library that generates Mermaid and DOT Diagrams from SQLAlchemy models and injects them into documentation.

.. _sadisplay: https://bitbucket.org/estin/sadisplay .. _sqlalchemy_schemadisplay: https://github.com/fschulze/sqlalchemy_schemadisplay .. _eralchemy: https://github.com/Alexis-benoist/eralchemy .. _paracelsus: https://github.com/tedivm/paracelsus

Web

Framework Integrations ......................

bottle-sqlalchemy_ A Bottle_ plugin to manage SQLAlchemy session to your application.

filteralchemy_ Declarative query builder that auto-generates filter parameters from models and parses request parameters using marshmallow-sqlalchemy_ and webargs_.

Flask-SQLAlchemy_ Flask-SQLAlchemy is an extension for Flask_ that adds support for SQLAlchemy to your application.

Flask-Admin_ The admin interface framework for Flask_. With scaffolding for SQLAlchemy, MongoEngine, pymongo and Peewee.

pyramid_sqlalchemy_ pyramid_sqlalchemy provides everything needed to use SQLAlchemy in Pyramid_ applications.

pyramid_restler_ pyramid_restler is a somewhat-opinionated toolkit for building RESTful Web services and applications on top of the Pyramid framework (with SQLAlchemy models).

sacrud_ SACRUD will solve your problem of CRUD interface for SQLAlchemy, by providing extension for Pyramid_ (yet) or use it in pure form. Unlike classical CRUD interface, pyramid_sacrud_ allows override and flexibly customize interface (that is closer to django.contrib.admin).

SQLA-wrapper_ A light and framework-independent wrapper for SQLAlchemy that makes it really easy to setup and use.

- Doesn't change the SQLAlchemy syntax.
- Can paginate the results of the queries.
- Support for multiple databases at the same time.

zope.sqlalchemy_ The aim of this package is to unify the plethora of existing packages integrating SQLAlchemy with Zope_'s transaction management. As such it seeks only to provide a data manager and makes no attempt to define a zopeish way to configure engines.

.. _Bottle: https://bottlepy.org/ .. _bottle-sqlalchemy: https://github.com/iurisilvio/bottle-sqlalchemy .. _filteralchemy: https://github.com/jmcarp/filteralchemy .. _Flask: https://palletsprojects.com/p/flask/ .. _Flask-SQLAlchemy: https://pythonhosted.org/Flask-SQLAlchemy/ .. _Flask-Admin: https://github.com/flask-admin/flask-admin .. _Pyramid: https://trypyramid.com/ .. _pyramid_restler: https://github.com/wylee/pyramid_restler .. _pyramid_sacrud: https://pyramid-sacrud.readthedocs.io/ .. _pyramid_sqlalchemy: https://pyramid-sqlalchemy.readthedocs.io/ .. _sacrud: https://sacrud.readthedocs.io/ .. _SQLA-wrapper: https://github.com/jpscaletti/sqla-wrapper .. _webargs: https://github.com/marshmallow-code/webargs .. _Zope: https://www.zope.org/ .. _zope.sqlalchemy: https://pypi.org/project/zope.sqlalchemy/