metadata function

Get/set user-defined metadata for a storage object

Get/set user-defined metadata for a storage object

get_storage_metadata(object, ...) ## S3 method for class 'blob_container' get_storage_metadata(object, blob, snapshot = NULL, version = NULL, ...) ## S3 method for class 'file_share' get_storage_metadata(object, file, isdir, ...) ## S3 method for class 'adls_filesystem' get_storage_metadata(object, file, ...) set_storage_metadata(object, ...) ## S3 method for class 'blob_container' set_storage_metadata(object, blob, ..., keep_existing = TRUE) ## S3 method for class 'file_share' set_storage_metadata(object, file, isdir, ..., keep_existing = TRUE) ## S3 method for class 'adls_filesystem' set_storage_metadata(object, file, ..., keep_existing = TRUE)

Arguments

  • object: A blob container, file share or ADLS filesystem object.
  • ...: For the metadata setters, name-value pairs to set as metadata for a blob or file.
  • blob, file: Optionally the name of an individual blob, file or directory within a container.
  • snapshot, version: For the blob method of get_storage_metadata, optional snapshot and version identifiers. These should be datetime strings, in the format "yyyy-mm-ddTHH:MM:SS.SSSSSSSZ". Ignored if blob is omitted.
  • isdir: For the file share method, whether the file argument is a file or directory. If omitted, get_storage_metadata will auto-detect the type; however this can be slow, so supply this argument if possible.
  • keep_existing: For the metadata setters, whether to retain existing metadata information.

Returns

get_storage_metadata returns a named list of metadata properties. If the blob or file argument is present, the properties will be for the blob/file specified. If this argument is omitted, the properties will be for the container itself.

set_storage_metadata returns the same list after setting the object's metadata, invisibly.

Details

These methods let you get and set user-defined properties (metadata) for storage objects.

Examples

## Not run: fs <- storage_container("https://mystorage.dfs.core.windows.net/myshare", key="access_key") create_storage_dir("newdir") storage_upload(share, "iris.csv", "newdir/iris.csv") set_storage_metadata(fs, "newdir/iris.csv", name1="value1") # will be list(name1="value1") get_storage_metadata(fs, "newdir/iris.csv") set_storage_metadata(fs, "newdir/iris.csv", name2="value2") # will be list(name1="value1", name2="value2") get_storage_metadata(fs, "newdir/iris.csv") set_storage_metadata(fs, "newdir/iris.csv", name3="value3", keep_existing=FALSE) # will be list(name3="value3") get_storage_metadata(fs, "newdir/iris.csv") # deleting all metadata set_storage_metadata(fs, "newdir/iris.csv", keep_existing=FALSE) ## End(Not run)

See Also

blob_container , file_share , adls_filesystem

get_storage_properties for standard properties

  • Maintainer: Hong Ooi
  • License: MIT + file LICENSE
  • Last published: 2022-05-25