Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Version

class Version

A version of a dataset. Each released version of a dataset is immutable; changes are made in the dataset's unreleased next version, which then becomes the current version once released.

Constructors

Method
Description

Return a Version of a dataset.

Dataset.listVersions([maxResults])

List the Versions of a dataset.

Return the version before this one.

Return the version after this one.

Examples

const dataset = redivis.organization('demo').dataset('iris_species');

const version = await dataset.version('v1_0');
await version.get();
console.log(version.properties);

const previous = await version.previousVersion(); // null if this is the first version
const datasetAtVersion = version.dataset(); // The dataset at this version

for (const version of await dataset.listVersions()) {
  console.log(version.tag);
}

Attributes

Name
Description

tag

The version's tag, e.g. v1_0, current, or next.

properties

An object containing the API resource representation of the version. This will only be populated after certain methods are called, particularly the get method.

Methods

Method
Description

Return the Dataset at this version.

Delete the version.

Check whether the version exists.

Fetch the version's metadata, populating version.properties.

Return the version after this one, if any.

Return the version before this one, if any.

Restore a deleted version.

Update the version's label and release notes.

Was this helpful?