KeyValueStore

• Storage
  • KeyValueStore

• __init__(client, id, name): None

• Initialize a new instance.

  Preferably use the KeyValueStore.open constructor to create a new instance.

  Parameters

  • client: KeyValueStoreClient

    An instance of a storage client.

  • id: str

    The unique identifier of the storage.

  • name: str | None

    The name of the storage, if available.

  Returns None

• async delete_value(key): None

• Delete a value from the KVS.

  Parameters

  • key: str

    Key of the record to delete.

  Returns None

• async drop(): None

• Overrides RequestManager.drop

  Drop the storage, removing it from the underlying storage client and clearing the cache.

  Returns None

• async get_auto_saved_value(key, default_value): MutableMapping[str, JsonSerializable]

• Get a value from KVS that will be automatically saved on changes.

  Parameters

  • key: str

    Key of the record, to store the value.

  • optionaldefault_value: MutableMapping[str, JsonSerializable] | None = None

    Value to be used if the record does not exist yet. Should be a dictionary.

  Returns MutableMapping[str, JsonSerializable]

  Return the value of the key.

• async get_metadata(): (DatasetMetadata | KeyValueStoreMetadata) | RequestQueueMetadata

• Overrides Storage.get_metadata

  Get the storage metadata.

  Returns (DatasetMetadata | KeyValueStoreMetadata) | RequestQueueMetadata

• async get_public_url(key): str

• Get the public URL for the given key.

  Parameters

  • key: str

    Key of the record for which URL is required.

  Returns str

  The public URL for the given key.

• async get_value(key: str, default_value?: T | None): T | None
• async get_value(key: str): Any
• async get_value(key: str, default_value: T): T
• async get_value(key: str, default_value?: T | None): T | None

• Get a value from the KVS.

  Parameters

  • key: str

    Key of the record to retrieve.

  • optionaldefault_value: T | None = None

    Default value returned in case the record does not exist.

  Returns T | None

  The value associated with the given key. default_value is used in case the record does not exist.

• async iterate_keys(exclusive_start_key, limit): AsyncIterator[KeyValueStoreRecordMetadata]

• Iterate over the existing keys in the KVS.

  Parameters

  • optionalexclusive_start_key: str | None = None

    Key to start the iteration from.

  • optionallimit: int | None = None

    Maximum number of keys to return. None means no limit.

  Returns AsyncIterator[KeyValueStoreRecordMetadata]

• async list_keys(exclusive_start_key, limit): list[KeyValueStoreRecordMetadata]

• List all the existing keys in the KVS.

  It uses client's iterate_keys method to get the keys.

  Parameters

  • optionalexclusive_start_key: str | None = None

    Key to start the iteration from.

  • optionallimit: int = 1000

    Maximum number of keys to return.

  Returns list[KeyValueStoreRecordMetadata]

  A list of keys in the KVS.

• async open(*, id, name, alias, configuration, storage_client): Storage

• Overrides Storage.open

  Open a storage, either restore existing or create a new one.

  Parameters

  • optionalkeyword-onlyid: str | None = None

    The storage ID.

  • optionalkeyword-onlyname: str | None = None

    The storage name (global scope, persists across runs). Name can only contain letters "a" through "z", the digits "0" through "9", and the hyphen ("-") but only in the middle of the string (e.g. "my-value-1").

  • optionalkeyword-onlyalias: str | None = None

    The storage alias (run scope, creates unnamed storage).

  • optionalkeyword-onlyconfiguration: Configuration | None = None

    Configuration object used during the storage creation or restoration process.

  • optionalkeyword-onlystorage_client: StorageClient | None = None

    Underlying storage client to use. If not provided, the default global storage client from the service locator will be used.

  Returns Storage

• async persist_autosaved_values(): None

• Force autosaved values to be saved without waiting for an event in Event Manager.

  Returns None

• async purge(): None

• Overrides RequestManager.purge

  Purge the storage, removing all items from the underlying storage client.

  This method does not remove the storage itself, e.g. don't remove the metadata, but clears all items within it.

  Returns None

• async record_exists(key): bool

• Check if a record with the given key exists in the key-value store.

  Parameters

  • key: str

    Key of the record to check for existence.

  Returns bool

  True if a record with the given key exists, False otherwise.

• async set_value(key, value, content_type): None

• Set a value in the KVS.

  Parameters

  • key: str

    Key of the record to set.

  • value: Any

    Value to set.

  • optionalcontent_type: str | None = None

    The MIME content type string.

  Returns None

Overrides Storage.id

Overrides Storage.name