Utilities¶

Return a humanized changeset for given SQLAlchemy declarative object. With this function you can easily check the changeset of given object in current transaction.

from sqlalchemy_continuum import changeset


article = Article(name='Some article')
changeset(article)
# {'name': ['Some article', None]}

Parameters:

Return the number of versions given object has. This function works even when obj has create_models and create_tables versioned settings disabled.

article = Article(name='Some article')

count_versions(article)  # 0

session.add(article)
session.commit()

count_versions(article)  # 1

Parameters:

Return the associated SQLAlchemy-Continuum VersioningManager for given SQLAlchemy declarative model class or object.

Parameters:

Return whether or not the versioned properties of given object have been modified.

article = Article()

is_modified(article)  # False

article.name = 'Something'

is_modified(article)  # True

Parameters:

Return whether or not some of the versioned properties of given SQLAlchemy declarative object have been modified or if the object has been deleted.

Parameters:

Return whether or not any of the versioned objects in given session have been either modified or deleted.

Parameters:

Return whether or not given object is versioned.

is_versioned(Article)  # True

article = Article()

is_versioned(article)  # True

Parameters:

Return the parent class for given version model class.

parent_class(ArticleVersion)  # Article class

Parameters:

Return the associated transaction class for given versioned SQLAlchemy declarative class or version class.

from sqlalchemy_continuum import transaction_class


transaction_class(Article)  # Transaction class

Parameters:

Return the version class for given SQLAlchemy declarative model class.

version_class(Article)  # ArticleVersion class

Parameters:

Return all versioned objects in given session.

Parameters:

Return associated version table for given SQLAlchemy Table object.

Parameters: