Skip to contents

Fetch TileDB Metadata

Source: R/metadata.R
fetch_metadata.Rd

Fetch metadata using a list of key-value pairs for a TileDB array or group. Optionally, you can access metadata at specific point in time (time-travelling).

Usage

# S3 method for class 'TileDBArray'
fetch_metadata(x, keys = NULL, timestamp = NULL, ...)

# S3 method for class 'TileDBGroup'
fetch_metadata(x, keys = NULL, timestamp = NULL, ...)

# S3 method for class 'tiledb_array'
fetch_metadata(x, keys = NULL, timestamp = NULL,
  ...)

# S3 method for class 'tiledb_group'
fetch_metadata(x, keys = NULL, timestamp = NULL,
  ...)

# S3 method for class 'character'
fetch_metadata(x, keys = NULL, timestamp = NULL,
  ctx = NULL, ...)

Arguments

x

An R object that points to a TileDB resource whose metadata are to be accessed.

keys

A character vector of metadata key names to be accessed. When NULL (default) all metadata will be accessed.

timestamp

Optional datetime object of class "POSIXct" to write at this timestamp.

...

Other arguments passed to methods. Not used.

ctx

Optional tiledb::tiledb_ctx() object.

Value

A named list of class tdb_metadata.

Details

fetch_metadata() works similar to metadata() but works with a list of key value pairs and returns a list always.

The character method requires a valid URI path.

The methods will not alter the mode of the TileDB object; also, the object will be opened temporarily to access the metadata if it is closed.

See also

set_metadata() and metadata().