KeyValueStoreCollectionClient

apify_client.clients.KeyValueStoreCollectionClient

Sub-client for manipulating key-value stores.

Index

Methods

• get_or_create
• list

Methods

get_or_create

• get_or_create(*, name, schema): Dict

• Retrieve a named key-value store, or create a new one when it doesn’t exist.

  https://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store

  ---

  Parameters

  • name: Optional[str] = Noneoptionalkeyword-only

    The name of the key-value store to retrieve or create.

  • schema: Optional[Dict] = Noneoptionalkeyword-only

    The schema of the key-value store

  Returns Dict

  The retrieved or newly-created key-value store.

list

• list(*, unnamed, limit, offset, desc): ListPage[Dict]

• List the available key-value stores.

  https://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores

  ---

  Parameters

  • unnamed: Optional[bool] = Noneoptionalkeyword-only

    Whether to include unnamed key-value stores in the list

  • limit: Optional[int] = Noneoptionalkeyword-only

    How many key-value stores to retrieve

  • offset: Optional[int] = Noneoptionalkeyword-only

    What key-value store to include as first when retrieving the list

  • desc: Optional[bool] = Noneoptionalkeyword-only

    Whether to sort the key-value stores in descending order based on their modification date

  Returns ListPage[Dict]

  The list of available key-value stores matching the specified filters.