search

kvesteri / sqlalchemy-continuum

Versioning extension for SQLAlchemy.
BSD 3-Clause "New" or "Revised" License
568 stars 128 forks source link

readme

SQLAlchemy-Continuum

|Build Status| |Version Status| |Downloads|

Versioning and auditing extension for SQLAlchemy.

Features

QuickStart

::

pip install SQLAlchemy-Continuum

In order to make your models versioned you need two things:

  1. Call make_versioned() before your models are defined.
  2. Add versioned to all models you wish to add versioning to

.. code-block:: python

from sqlalchemy_continuum 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'

# lets revert back to first version
article.versions[0].revert()

article.name
# 'Some article'

For completeness, below is a working example.

.. code-block:: python

from sqlalchemy_continuum import make_versioned
from sqlalchemy import Column, Integer, Unicode, UnicodeText, create_engine
from sqlalchemy.orm import create_session, configure_mappers, declarative_base

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=u'Some article', content=u'Some content')
session.add(article)
session.commit()
article.versions[0].name
article.name = u'Updated name'
session.commit()
article.versions[1].name
article.versions[0].revert()
article.name

Resources

.. image:: http://i.imgur.com/UFaRx.gif

.. |Build Status| image:: https://github.com/kvesteri/sqlalchemy-continuum/workflows/Test/badge.svg :target: https://github.com/kvesteri/sqlalchemy-continuum/actions?query=workflow%3ATest .. |Version Status| image:: https://img.shields.io/pypi/v/SQLAlchemy-Continuum.png :target: https://pypi.python.org/pypi/SQLAlchemy-Continuum/ .. |Downloads| image:: https://img.shields.io/pypi/dm/SQLAlchemy-Continuum.png :target: https://pypi.python.org/pypi/SQLAlchemy-Continuum/

More information