Skip to main content

KeyValueStoreClient

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

Hierarchy

Index

Methods

Properties

Methods

__init__

  • __init__(*, base_url, root_client, http_client, resource_id, resource_path, params): None

  • Initialize a new instance.

    Parameters

    • keyword-onlybase_url: str

      Base URL of the API server.

    • keyword-onlyroot_client: ApifyClient

      The ApifyClient instance under which this resource client exists.

    • keyword-onlyhttp_client: HTTPClient

      The HTTPClient instance to be used in this client.

    • optionalkeyword-onlyresource_id: str | None = None

      ID of the manipulated resource, in case of a single-resource client.

    • keyword-onlyresource_path: str

      Path to the resource's endpoint on the API server.

    • optionalkeyword-onlyparams: dict | None = None

      Parameters to include in all requests from this client.

    Returns None

create_keys_public_url

  • 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

    • optionalkeyword-onlylimit: int | None = None
    • optionalkeyword-onlyexclusive_start_key: str | None = None
    • optionalkeyword-onlycollection: str | None = None
    • optionalkeyword-onlyprefix: str | None = None
    • optionalkeyword-onlyexpires_in_secs: int | None = None

    Returns str

delete

  • delete(): None

delete_record

  • delete_record(key): None

get

  • get(): dict | None

get_record

  • get_record(key): dict | None

get_record_as_bytes

  • get_record_as_bytes(key): dict | None

get_record_public_url

  • 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

      The key for which the URL should be generated.

    Returns str

list_keys

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

    • optionalkeyword-onlylimit: int | None = None

      Number of keys to be returned. Maximum value is 1000.

    • optionalkeyword-onlyexclusive_start_key: str | None = None

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

    • optionalkeyword-onlycollection: str | None = None

      The name of the collection in store schema to list keys from.

    • optionalkeyword-onlyprefix: str | None = None

      The prefix of the keys to be listed.

    Returns dict

record_exists

  • record_exists(key): bool

set_record

  • set_record(key, value, content_type): None

stream_record

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

update

  • update(*, name, general_access): dict

Properties

http_client

http_client: HTTPClient | HTTPClientAsync

params

params: dict

resource_id

resource_id: str | None

root_client

root_client: ApifyClient | ApifyClientAsync

url

url: str
Page Options