deckhand.client.revisions module

class deckhand.client.revisions.Revision(manager, info, loaded=False)[source]

Bases: deckhand.client.base.Resource

class deckhand.client.revisions.RevisionManager(api)[source]

Bases: deckhand.client.base.Manager

Manage Revision resources.

deepdiff(revision_id, comparison_revision_id)[source]

Get revision deepdiff between two revisions.

delete_all()[source]

Delete all revisions.

Warning

Effectively the same as purging the entire database.

diff(revision_id, comparison_revision_id)[source]

Get revision diff between two revisions.

documents(revision_id, rendered=True, **filters)[source]

Get a list of revision documents or rendered documents.

Parameters:
  • revision_id (int) – Revision ID.
  • rendered (bool) – If True, returns list of rendered documents. Else returns list of unmodified, raw documents.
  • filters – Filters to apply to response body.
Returns:

List of documents or rendered documents.
Return type:

list[Revision]
get(revision_id)[source]

Get details for a revision.

list(**filters)[source]

Get a list of revisions.

resource_class

alias of Revision

rollback(revision_id)[source]

Rollback to a previous revision, effectively creating a new one.