History tracking extension for SQLAlchemy.
Project description
SQLAlchemy-History
SQLAlchemy-history is a fork of sqlalchemy-continuum. An auditing extension for sqlalchemy which keeps a track of the history of your sqlalchemy models
Features
- Supports sqlalchemy 1.4+ and python 3.7+
- Tracks history 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. Get the relationships of an object in that point in time.
QuickStart
pip install sqlalchemy-history
In order to make your models versioned you need two things:
- Call
make_versioned()
before your models are defined. - Add
__versioned__
to all models you wish to add versioning to
>>> from sqlalchemy_history import make_versioned
>>> make_versioned(user_cls=None)
>>> class Article(Base):
... __versioned__ = {}
... __tablename__ = 'article'
... id = sa.Column(sa.Integer, primary_key=True, autoincrement=True)
... name = sa.Column(sa.Unicode(255))
... content = sa.Column(sa.UnicodeText)
>>> article = Article(name='Some article', content='Some content')
>>> session.add(article)
>>> session.commit()
'article has now one version stored in database'
>>> article.versions[0].name
'Some article'
>>> article.name = 'Updated name'
>>> session.commit()
>>> article.versions[1].name
'Updated name'
>>> article.versions[0].revert()
'lets revert back to first version'
>>> article.name
'Some article'
For completeness, below is a working example.
from sqlalchemy_history import make_versioned
from sqlalchemy import Column, Integer, Unicode, UnicodeText, create_engine
try:
from sqlalchemy.orm import declarative_base
except ImportError: # sqla < 2.x
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import create_session, configure_mappers
make_versioned(user_cls=None)
Base = declarative_base()
class Article(Base):
__versioned__ = {}
__tablename__ = 'article'
id = Column(Integer, primary_key=True, autoincrement=True)
name = Column(Unicode(255))
content = Column(UnicodeText)
configure_mappers()
engine = create_engine('sqlite://')
Base.metadata.create_all(engine)
session = create_session(bind=engine, autocommit=False)
article = Article(name='Some article', content='Some content')
session.add(article)
session.commit()
print(article.versions[0].name) # 'Some article'
article.name = 'Updated name'
session.commit()
print(article.versions[1].name) # 'Updated name'
article.versions[0].revert()
print(article.name) # 'Some article'
Resources
More information
- http://en.wikipedia.org/wiki/Slowly_changing_dimension
- http://en.wikipedia.org/wiki/Change_data_capture
- http://en.wikipedia.org/wiki/Anchor_Modeling
- http://en.wikipedia.org/wiki/Shadow_table
- https://wiki.postgresql.org/wiki/Audit_trigger
- https://wiki.postgresql.org/wiki/Audit_trigger_91plus
- http://kosalads.blogspot.fi/2014/06/implement-audit-functionality-in.html
- https://github.com/2ndQuadrant/pgaudit
Comparison
Primary reasons to create another library:
- Be future looking and support sqlalchemy 1.4 and 2.x
- Support multiple databases (sqlite, mysql, postgres, mssql, oracle)
- Focus on the history tracking and be as efficient as possible when doing it
We found multiple libraries which has an implementation of history tracking:
- sqlalchemy-continuum
- Does not support oracle, mssql
- Feature filled making it difficult to maintain all plugins/extensions
- flask-continuum
- Thin wrapper on sqlalchemy-continuum specifically for flask
- postgresql-audit
- Supports only postgres
- versionalchemy
- Not updated in a while
- No reverting capability, Relationship queries on history not available
- django-simple-history
- Uses django ORM, does not support sqlalchemy
- sqlalchemy example versioning-objects
- Simple example to demonstrate implementation - but very minimal
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sqlalchemy_history-2.1.4.tar.gz
(39.1 kB
view hashes)
Built Distribution
Close
Hashes for sqlalchemy_history-2.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | adeee6e5a9a1e89126fec29fd4f5dfef83b86000d3cc0cca3b921533309a2633 |
|
MD5 | e7dc6fe61bfe63f8e58f3f5dc9170afb |
|
BLAKE2b-256 | 370c96b7827fa8cadfe65c5aea841e3eb8563ac82713dc08a1f864bee9e3a560 |