Data Identifier Methods

class rucio.client.didclient.DIDClient(rucio_host=None, auth_host=None, account=None, ca_cert=None, auth_type=None, creds=None, timeout=None)

Bases: rucio.client.baseclient.BaseClient

DataIdentifier client class for working with data identifiers

DIDS_BASEURL = 'dids'

add_container(scope, name, statuses=None, meta=None, rules=None, lifetime=None)

Add data identifier for a container.

Parameters:

• scope – The scope name.
• name – The data identifier name.
• statuses – Dictionary with statuses, e.g.g {‘monotonic’:True}.
• lifetime – DID’s lifetime (in seconds).

Meta:

Meta-data associated with the data identifier is represented using key/value pairs in a dictionary.

Rules:

Replication rules associated with the data identifier. A list of dictionaries, e.g., [{‘copies’: 2, ‘rse_expression’: ‘TIERS1’}, ].

add_containers(cnts)

Bulk add containers.

Parameters:cnts – A list of containers.

add_containers_to_container(scope, name, cnts)

Add containers to container.

Parameters:

• scope – The scope name.
• name – The dataset name.
• dsns – The content.

add_containers_to_containers(attachments)

Add containers_to_containers.

Parameters:attachments – The attachments.

add_dataset(scope, name, statuses=None, meta=None, rules=None, lifetime=None)

Add data identifier for a dataset.

Parameters:

• scope – The scope name.
• name – The data identifier name.
• statuses – Dictionary with statuses, e.g.g {‘monotonic’:True}.
• lifetime – DID’s lifetime (in seconds).

Meta:

Meta-data associated with the data identifier is represented using key/value pairs in a dictionary.

Rules:

Replication rules associated with the data identifier. A list of dictionaries, e.g., [{‘copies’: 2, ‘rse_expression’: ‘TIERS1’}, ].

add_datasets(dsns)

Bulk add datasets.

Parameters:dsns – A list of datasets.

add_datasets_to_container(scope, name, dsns)

Add datasets to container.

Parameters:

• scope – The scope name.
• name – The dataset name.
• dsns – The content.

add_datasets_to_containers(attachments)

Add datasets_to_containers.

Parameters:attachments – The attachments.

add_did(scope, name, type, statuses=None, meta=None, rules=None, lifetime=None)

Add data identifier for a dataset or container.

Parameters:

• scope – The scope name.
• name – The data identifier name.
• statuses – Dictionary with statuses, e.g.g {‘monotonic’:True}.
• lifetime – DID’s lifetime (in seconds).

Paran type:

The data identifier type (file|dataset|container).

Meta:

Meta-data associated with the data identifier is represented using key/value pairs in a dictionary.

Rules:

Replication rules associated with the data identifier. A list of dictionaries, e.g., [{‘copies’: 2, ‘rse_expression’: ‘TIERS1’}, ].

add_dids(dids)

Buld add datasets/containers.

add_files_to_dataset(scope, name, files, rse=None)

Add files to datasets.

Parameters:

• scope – The scope name.
• name – The dataset name.
• files – The content.
• rse – The RSE name when registering replicas.

add_files_to_datasets(attachments)

Add files to datasets.

Parameters:attachments – The attachments.

attach_dids(scope, name, dids, rse=None)

Attach data identifier.

Parameters:

• scope – The scope name.
• name – The data identifier name.
• dids – The content.
• rse – The RSE name when registering replicas.

attach_dids_to_dids(attachments)

Add dids to dids.

Parameters:attachments – The attachments.

close(scope, name)

close dataset/container

Parameters:

• scope – The scope name.
• name – The dataset/container name.

delete_metadata(scope, name, key)

Delete data identifier metadata

Parameters:

• scope – The scope name.
• name – The data identifier.
• key – the key.

detach_dids(scope, name, dids)

Detach data identifier

Parameters:

• scope – The scope name.
• name – The data identifier name.
• dids – The content.

get_did(scope, name)

Retrieve a single data identifier.

Parameters:

• scope – The scope name.
• name – The data identifier name.

get_metadata(scope, name)

Get data identifier metadata

Parameters:

• scope – The scope name.
• name – The data identifier name.

list_content(scope, name)

List data identifier contents.

Parameters:

• scope – The scope name.
• name – The data identifier name.

list_did_rules(scope, name)

List the associated rules of a data identifier.

Parameters:

• scope – The scope name.
• name – The data identifier name.

list_dids(scope, filters, type='collection')

List all data identifiers in a scope which match a given pattern.

Parameters:

• scope – The scope name.
• pattern – The wildcard pattern.
• type – The type of the did: all(container, dataset, file), collection(dataset or container), dataset, container
• ignore_case – Ignore case distinctions.
• session – The database session in use.

list_files(scope, name, long=None)

List data identifier file contents.

Parameters:

• scope – The scope name.
• name – The data identifier name.
• long – A boolean to choose if GUID is returned or not.

scope_list(scope, name=None, recursive=False)

List data identifiers in a scope.

Parameters:

• scope – The scope name.
• name – The data identifier name.
• recursive – boolean, True or False.

set_metadata(scope, name, key, value)

Set data identifier metadata

Parameters:

• scope – The scope name.
• name – The data identifier name.
• key – the key.
• value – the value.

set_status(scope, name, **kwargs)

Set data identifier status

Parameters:

• scope – The scope name.
• name – The data identifier name.
• kwargs – Keyword arguments of the form status_name=value.