Skip to main content

BaseKeyValueStoreCollectionClient

crawlee.base_storage_client._base_key_value_store_collection_client.BaseKeyValueStoreCollectionClient

Abstract base class for key-value store collection clients.

This collection client handles operations that involve multiple instances of a given resource type.

Index

Methods

Methods

get_or_create

  • async get_or_create(*, id, name, schema): KeyValueStoreMetadata

  • Retrieve an existing key-value store by its name or ID, or create a new one if it does not exist.

    Parameters

    • id: str | None = Nonekeyword-only
    • name: str | None = Nonekeyword-only
    • schema: dict | None = Nonekeyword-only

    Returns KeyValueStoreMetadata

list

  • async list(*, unnamed, limit, offset, desc): KeyValueStoreListPage

  • List the available key-value stores.

    Parameters

    • unnamed: bool = Falsekeyword-only
    • limit: int | None = Nonekeyword-only
    • offset: int | None = Nonekeyword-only
    • desc: bool = Falsekeyword-only

    Returns KeyValueStoreListPage