datacatalog.managers.catalog package¶

class datacatalog.managers.catalog.CatalogManager(mongodb, agave=None, *args, **kwargs)[source]¶

Supports operations spanning multiple LinkedStore collections

delete_by_uuid(uuid, token=None)[source]¶

Deletes LinkedStore document and all linked references

Parameters:	uuid (str) – UUID of the document to fully delete token (str, optional) – Update token
Returns:	Whether delete was successful or not
Return type:	bool

link(uuid1, uuid2, type='child_of', token=None)[source]¶

User-friendly method to link two Data Catalog documents

Parameters:	identifier (str) – Identifier string for record to be modified linked_identifier (str) – Identifier string for record to be linked linkage_name (str) – A valid linkage name token – String token authorizing edits to target record
Raises:	`ValueError` – Raised when invalid or unknown identifers are encountered
Returns:	The modified record, including its new linkage
Return type:	dict

exception datacatalog.managers.catalog.CatalogManagerError[source]¶: Bases: datacatalog.managers.common.ManagerError

Submodules¶

class datacatalog.managers.catalog.catalog.CatalogManager(mongodb, agave=None, *args, **kwargs)[source]¶

Supports operations spanning multiple LinkedStore collections

delete_by_uuid(uuid, token=None)[source]¶

Deletes LinkedStore document and all linked references

Parameters:	uuid (str) – UUID of the document to fully delete token (str, optional) – Update token
Returns:	Whether delete was successful or not
Return type:	bool

link(uuid1, uuid2, type='child_of', token=None)[source]¶

User-friendly method to link two Data Catalog documents

Parameters:	identifier (str) – Identifier string for record to be modified linked_identifier (str) – Identifier string for record to be linked linkage_name (str) – A valid linkage name token – String token authorizing edits to target record
Raises:	`ValueError` – Raised when invalid or unknown identifers are encountered
Returns:	The modified record, including its new linkage
Return type:	dict

exception datacatalog.managers.catalog.catalog.CatalogManagerError[source]¶: Bases: datacatalog.managers.common.ManagerError