Version$delete

Version$delete() → Version | void

If a version is unreleased, it will be permanently deleted, and this method will return void. Otherwise, the historic version will be marked as deleted and all of its data will be removed, though metadata about the version will persist. In this latter case, the updated version will be returned, with version.properties["isDeleted"] == TRUE.

The current version of a dataset cannot be deleted.

Returns:

Version | void

Examples

dataset <- redivis.organization("my_organization")$dataset("some_dataset")

# Only valid if version 1.0 isn't the current version
first_version <- dataset$version("1.0")
first_version$delete() # first_version$properties[["isDeleted"]] == TRUE

# Only valid if the dataset has an unreleased "next" version
next_version <- dataset$version("next")
next_version$delete() # next_version$exists() == FALSE