db_collection_read_metadata: Read Metadata for a Collection

View source: R/metadata.R

db_collection_read_metadataR Documentation

Read Metadata for a Collection

Description

Read Metadata for a Collection

Usage

db_collection_read_metadata(
  con,
  collection_name,
  collection_owner,
  valid_on = NULL,
  locale = NULL,
  schema = "timeseries"
)

Arguments

con

RPostgres connection object.

collection_name

character name of the collection.

collection_owner

character name of the collection owner.

valid_on

character representation of a date in the form of 'YYYY-MM-DD'. valid_on selects the version of a time series that is valid at the specified time.

locale

character indicating the language of the meta information to be store. We recommend to use ISO country codes to represent languages. Defaults to NULL. When local is set to NULL, metadata are stored without localization. Note that, when localizing meta information by assigning a language, multiple meta information objects can be stored for a single time series.

schema

character name of the database schema. Defaults to 'timeseries'

Value

list of all available meta descriptions for a particular collection and language.

See Also

Other metadata functions: db_dataset_read_metadata(), db_meta_get_latest_validity(), db_metadata_read(), db_metadata_store()


timeseriesdb documentation built on March 24, 2022, 1:06 a.m.