Did column meta

Classes¶

DidColumnMeta ¶

DidColumnMeta()

A metadata plugin to interact with the base did table metadata.

Functions¶

get_metadata ¶

get_metadata(scope, name, *, session)

Get data identifier metadata.

PARAMETER	DESCRIPTION
`scope`	The scope name.
`name`	The data identifier name.
`session`	The database session in use. TYPE: `Session`

list_dids ¶

list_dids(
    scope,
    filters,
    did_type="collection",
    ignore_case=False,
    limit=None,
    offset=None,
    long=False,
    recursive=False,
    ignore_dids=None,
    *,
    session
)

Search data identifiers.

PARAMETER	DESCRIPTION
`scope`	the scope name.
`filters`	dictionary of attributes by which the results should be filtered.
`did_type`	the type of the did: all(container, dataset, file), collection(dataset or container), dataset, container, file. DEFAULT: `'collection'`
`ignore_case`	ignore case distinctions. DEFAULT: `False`
`limit`	limit number. DEFAULT: `None`
`offset`	offset number. DEFAULT: `None`
`long`	Long format option to display more information for each DID. DEFAULT: `False`
`session`	The database session in use. TYPE: `Session`
`recursive`	Recursively list DIDs content. DEFAULT: `False`
`ignore_dids`	List of DIDs to refrain from yielding. DEFAULT: `None`

delete_metadata ¶

delete_metadata(scope, name, key, *, session=None)

Deletes the metadata stored for the given key.

PARAMETER	DESCRIPTION
`scope`	The scope of the did.
`name`	The name of the did.
`key`	Key of the metadata.

get_plugin_name ¶

get_plugin_name()

Returns a unique identifier for this plugin. This can be later used for filtering down results to this plugin only.

RETURNS	DESCRIPTION
	The name of the plugin.