BaseStorage

Base class for storages.

Hierarchy

• BaseStorage
  • Dataset
  • KeyValueStore
  • RequestQueue

Index

Methods

• drop
• open

Properties

• id
• name

Methods

drop

• async drop(): None

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

  ---

  Returns None

open

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

• 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: BaseStorageClient | None = None

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

  Returns BaseStorage

Properties

id

id: str

Get the storage ID.

name

name: str | None

Get the storage name.