KeyValueStoreClient

apify_client.clients.KeyValueStoreClient

Sub-client for manipulating a single key-value store.

Index

Methods

• delete
• delete_record
• get
• get_record
• get_record_as_bytes
• list_keys
• set_record
• stream_record
• update

Methods

delete

• delete(): None

• Delete the key-value store.

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

  ---

  Returns None

delete_record

• delete_record(key): None

• Delete the specified record from the key-value store.

  https://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record

  ---

  Parameters

  • key: str

    The key of the record which to delete

  Returns None

get

• get(): dict | None

• Retrieve the key-value store.

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

  ---

  Returns dict | None

  The retrieved key-value store, or None if it does not exist

get_record

• get_record(key, *, as_bytes, as_file): dict | None

• Retrieve the given record from the key-value store.

  https://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record

  ---

  Parameters

  • key: str

    Key of the record to retrieve

  • as_bytes: bool = Falsekeyword-only

    Deprecated, use get_record_as_bytes() instead. Whether to retrieve the record as raw bytes, default False

  • as_file: bool = Falsekeyword-only

    Deprecated, use stream_record() instead. Whether to retrieve the record as a file-like object, default False

  Returns dict | None

  The requested record, or None, if the record does not exist

get_record_as_bytes

• get_record_as_bytes(key): dict | None

• Retrieve the given record from the key-value store, without parsing it.

  https://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record

  ---

  Parameters

  • key: str

    Key of the record to retrieve

  Returns dict | None

  The requested record, or None, if the record does not exist

list_keys

• list_keys(*, limit, exclusive_start_key): dict

• List the keys in the key-value store.

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

  ---

  Parameters

  • limit: int | None = Nonekeyword-only

    Number of keys to be returned. Maximum value is 1000

  • exclusive_start_key: str | None = Nonekeyword-only

    All keys up to this one (including) are skipped from the result

  Returns dict

  The list of keys in the key-value store matching the given arguments

set_record

• set_record(key, value, content_type): None

• Set a value to the given record in the key-value store.

  https://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record

  ---

  Parameters

  • key: str

    The key of the record to save the value to

  • value: Any

    The value to save into the record

  • content_type: str | None = None

    The content type of the saved value

  Returns None

stream_record

• stream_record(key): Iterator[dict | None]

• Retrieve the given record from the key-value store, as a stream.

  https://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record

  ---

  Parameters

  • key: str

    Key of the record to retrieve

  Returns Iterator[dict | None]

  The requested record as a context-managed streaming Response, or None, if the record does not exist

update

• update(*, name): dict

• Update the key-value store with specified fields.

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

  ---

  Parameters

  • name: str | None = Nonekeyword-only

    The new name for key-value store

  Returns dict

  The updated key-value store