datalad catalog-get
Synopsis
datalad catalog-get [-h] [-c CATALOG] [-i DATASET_ID] [-v DATASET_VERSION] [--record-type RECORD_TYPE] [--record-path RECORD_PATH] [--version] property
Description
Utility for getting various properties of a catalog, based on the specified property ('home', 'config', 'metadata', 'report')
Used to get the catalog home page, get config at catalog- or dataset-level, get the metadata for a specific dataset/version, or get a summary report of the catalog.
Examples
Get the configuration of an existing catalog:
% datalad catalog-get -c /tmp/my-cat/ config
Get the home page details of an existing catalog:
% datalad catalog-get -c /tmp/my-cat/ home
Get metadata of a specific dataset from an existing catalog:
% datalad catalog-get -c /tmp/my-cat -i abcd -v 1234 metadata
Get metadata of a specific directory node in a dataset from an existing catalog:
% datalad catalog-get -c /tmp/my-cat -i abcd -v 1234 --record_type directory --record_path relative/path/to/directory metadata
Get a report of the number of datasets, dataset-versions, and metadata files contained in existing catalog:
% datalad catalog-get -c /tmp/my-cat report
Options
property
The property to get in the catalog. Should be one of 'home', 'config', 'metadata' or 'report'.
-h, --help, --help-np
show this help message. --help-np forcefully disables the use of a pager for displaying the help message
-c CATALOG, --catalog CATALOG
Location of the existing catalog.
-i DATASET_ID, --dataset-id DATASET_ID
The unique identifier of the dataset for which metadata or config has been requested.
-v DATASET_VERSION, --dataset-version DATASET_VERSION
The unique version of the dataset for which metadata or config has been requested.
--record-type RECORD_TYPE
The type of record in a catalog for which metadata has been requested. Should be one of 'dataset' (default), 'directory', or 'file'.
--record-path RECORD_PATH
The relative path of record in a catalog for which metadata has been requested. Required if 'record_type' is 'directory' or 'file'.
--version
show the module and its version which provides the command