tar_unversion: Delete cloud object version IDs from local metadata.

In targets: Dynamic Function-Oriented 'Make'-Like Declarative Pipelines

Delete cloud object version IDs from local metadata.

Description

Delete version IDs from local metadata.

Usage

tar_unversion(
  names = tidyselect::everything(),
  store = targets::tar_config_get("store")
)

Arguments

names	Tidyselect expression to identify the targets to drop version IDs. The object supplied to names should be NULL or a tidyselect expression like any_of() or starts_with() from tidyselect itself, or tar_described_as() to select target names based on their descriptions.
store	Character of length 1, path to the targets data store. Defaults to tar_config_get("store"), which in turn defaults to ⁠_targets/⁠. When you set this argument, the value of tar_config_get("store") is temporarily changed for the current function call. See tar_config_get() and tar_config_set() for details about how to set the data store path persistently for a project.

Value

NULL (invisibly).

Cloud target data versioning

Some buckets in Amazon S3 or Google Cloud Storage are "versioned", which means they track historical versions of each data object. If you use targets with cloud storage (https://books.ropensci.org/targets/cloud-storage.html) and versioning is turned on, then targets will record each version of each target in its metadata.

Functions like tar_read() and tar_load() load the version recorded in the local metadata, which may not be the same as the "current" version of the object in the bucket. Likewise, functions tar_delete() and tar_destroy() only remove the version ID of each target as recorded in the local metadata.

If you want to interact with the latest version of an object instead of the version ID recorded in the local metadata, then you will need to delete the object from the metadata.

1. Make sure your local copy of the metadata is current and up to date. You may need to run tar_meta_download() or tar_meta_sync() first.

2. Run tar_unversion() to remove the recorded version IDs of your targets in the local metadata.

3. With the version IDs gone from the local metadata, functions like tar_read() and tar_destroy() will use the latest version of each target data object.

4. Optional: to back up the local metadata file with the version IDs deleted, use tar_meta_upload().

See Also

Other clean: tar_delete(), tar_destroy(), tar_invalidate(), tar_prune(), tar_prune_list()

targets documentation built on Oct. 3, 2024, 1:11 a.m.