Version

class Version

All datasets on Redivis are versioned. This interface allows you to view detailed information about the version history of a dataset and manage historic versions. However, if you want to get a dataset's contents at a particular version, construct the dataset with the version tag; e.g. user|organization.dataset(name, tag="1.0").

Constructors

Dataset.list_versions([max_results])	Returns the list of all versions of a dataset.
Dataset.version(tag)	Construct a new version instance based on a specific version tag (e.g., tag=1.0)

Examples

Basics

my_org = redivis.organization("some_organization")
dataset = my_org.dataset("some_dataset")
current_version = dataset.version("1.0")

current_version.exists() # True

# Get the full API representation of the version and print its properties
print(current_version.get().properties)

for version in dataset.list_versions():
    print(version.properties)

Jump between versions

my_org = redivis.organization("some_organization")
dataset = my_org.dataset("some_dataset")
current_version = dataset.version("current")

# can also call version.get_next_version() to go the other direction
previous_version = current_version.get_previous_version()
if previous_version is not None:
    print(previous_version["tag"])

Delete a historic version

my_org = redivis.organization("some_organization")
dataset = my_org.dataset("some_dataset")
historic_version = dataset.version("1.0")

# Delete the data in this version, potentially saving storage costs
# Note that users will no longer be able to query or export data in this version!
historic_version.delete()

Attributes

properties

A dict containing the API resource representation of the version. This will be fully populated after calling get(). This will also be partially populated for versions returned via the Dataset.list_versions method.

Methods

Version.dataset()	Create a new dataset reference representing this particular version.
Version.delete()	Delete an unreleased version, or mark an historic version as deleted.
Version.exists()	Check whether the version exists.
Version.get()	Fetch the version, populating the properties attribute on the current instance.
Version.previous_version()	Return the version immediately before this version. If no previous version exists, will return None.
Version.next_version()	Return the version immediately after this version. If no next version exists, will return None.