Utilities¶
changeset¶
-
sqlalchemy_continuum.utils.
changeset
(obj)[source]¶ 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=u'Some article') changeset(article) # {'name': [u'Some article', None]}
Parameters: obj – SQLAlchemy declarative model object
count_versions¶
-
sqlalchemy_continuum.utils.
count_versions
(obj)[source]¶ 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=u'Some article') count_versions(article) # 0 session.add(article) session.commit() count_versions(article) # 1
Parameters: obj – SQLAlchemy declarative model object
get_versioning_manager¶
is_modified¶
-
sqlalchemy_continuum.utils.
is_modified
(obj)[source]¶ 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: obj – SQLAlchemy declarative model object See also
See also
is_modified_or_deleted¶
is_session_modified¶
is_versioned¶
parent_class¶
transaction_class¶
-
sqlalchemy_continuum.utils.
transaction_class
(cls)[source]¶ 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: cls – SQLAlchemy versioned declarative class or version model class