Storage

Base class for storages.

Hierarchy

• Storage
  • KeyValueStore
  • Dataset
  • RequestQueue

Index

Methods

• drop
• get_metadata
• open
• purge

Properties

• id
• name

Methods

drop

• async drop(): None

• Overrides Storage.drop

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

  ---

  Returns None

get_metadata

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

• Overrides Storage.get_metadata

  Get the storage metadata.

  ---

  Returns (DatasetMetadata | KeyValueStoreMetadata) | RequestQueueMetadata

open

• async open(*, id, name, 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.

  • 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

purge

• async purge(): None

• Overrides Storage.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

Properties

id

id: str

Get the storage ID.

name

name: str | None

Get the storage name.