KeyValueStoreClientAsync

Async sub-client for manipulating a single key-value store.

Index

Methods

• create_keys_public_url
• delete
• delete_record
• get
• get_record
• get_record_as_bytes
• get_record_public_url
• list_keys
• record_exists
• set_record
• stream_record
• update

Methods

create_keys_public_url

• async create_keys_public_url(*, limit, exclusive_start_key, collection, prefix, expires_in_secs): str

• Generate a URL that can be used to access key-value store keys.

  If the client has permission to access the key-value store's URL signing key, the URL will include a signature to verify its authenticity.

  You can optionally control how long the signed URL should be valid using the expires_in_secs option. This value sets the expiration duration in seconds from the time the URL is generated. If not provided, the URL will not expire.

  Any other options (like limit or prefix) will be included as query parameters in the URL.

  ---

  Parameters

  • keyword-onlylimit: int | None = None

  • keyword-onlyexclusive_start_key: str | None = None

  • keyword-onlycollection: str | None = None

  • keyword-onlyprefix: str | None = None

  • keyword-onlyexpires_in_secs: int | None = None

  Returns str

delete

• async 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

• async 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

  Returns None

get

• async 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

get_record

• async get_record(key, signature): 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

  • signature: str | None = None

  Returns dict | None

get_record_as_bytes

• async get_record_as_bytes(key, signature): 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

  • signature: str | None = None

  Returns dict | None

get_record_public_url

• async get_record_public_url(key): str

• Generate a URL that can be used to access key-value store record.

  If the client has permission to access the key-value store's URL signing key, the URL will include a signature to verify its authenticity.

  ---

  Parameters

  • key: str

  Returns str

list_keys

• async list_keys(*, limit, exclusive_start_key, collection, prefix, signature): 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

  • keyword-onlylimit: int | None = None

  • keyword-onlyexclusive_start_key: str | None = None

  • keyword-onlycollection: str | None = None

  • keyword-onlyprefix: str | None = None

  • keyword-onlysignature: str | None = None

  Returns dict

record_exists

• async record_exists(key): bool

• Check if given record is present in the key-value store.

  https://docs.apify.com/api/v2/key-value-store-record-head

  ---

  Parameters

  • key: str

  Returns bool

set_record

• async 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

  • value: Any

  • content_type: str | None = None

  Returns None

stream_record

• async stream_record(key, signature): AsyncIterator[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

  • signature: str | None = None

  Returns AsyncIterator[dict | None]

update

• async update(*, name, general_access): dict

• Update the key-value store with specified fields.

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

  ---

  Parameters

  • keyword-onlyname: str | None = None

  • keyword-onlygeneral_access: StorageGeneralAccess | None = None

  Returns dict