Metadata service API

class MetadataAPI(kv_host: str, kv_port: int)

async close()

async is_ready(timeout: float | None = None, pause: float = 0.5)

async new_superuser(username: str, password: str, dataset_name: str)

async new_account(username: str, password: str)

Registers a new account

Creates a new account. Checks that the username is not registered.

Parameters:

• username – Accounts username

• password – Accounts password

async new_dataset(username: str, password: str, dataset_name: str)

Registers a new dataset

Validates the account credentials, and creates a new dataset associated to the account. It updates the account metadata to add access to the new dataset. The dataset name must bu unique.

Parameters:

• username – Accounts username

• password – Accounts password

• dataset_name – Name of the new dataset. Must be unique.

Raises:

Exception('Account is not valid!') – If wrong credentials

async add_account_to_dataset(username: str, password: str, dataset_name: str, account_name: str)

Allow a certain account to access a certain dataset.

The owner of a dataset can call this and add access to an arbitrary account.

async new_dataclay(dataclay_id: UUID, host: str, port: int, is_this: bool = False)

async get_dataclay(dataclay_id: UUID | str) → Dataclay

async get_all_backends(from_backend: bool = False, **kwargs) → dict[UUID, Backend]

async register_backend(id: UUID, host: str, port: int, dataclay_id: UUID)

async delete_backend(id: UUID)

async get_all_objects(filter_func: Callable[[ObjectMetadata], bool] | None = None) → dict[UUID, ObjectMetadata]

async upsert_object(object_md: ObjectMetadata)

async change_object_id(old_id: UUID, new_id: UUID)

async delete_object(id: UUID)

async get_object_md_by_id(object_id: UUID) → ObjectMetadata

async get_object_md_by_alias(alias_name: str, dataset_name: str) → ObjectMetadata

async new_alias(alias_name: str, dataset_name: str, object_id: UUID)

async get_all_alias(dataset_name: str | None = None, object_id: UUID | None = None) → dict[str, Alias]

async delete_alias(alias_name: str, dataset_name: str)