Skip to main content
Version: 2.5

KeyValueStoreClient

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

Index

Methods

Methods

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

    • 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

  • delete(): None

delete_record

  • delete_record(key): None

get

  • get(): dict | None

get_record

  • get_record(key, signature): dict | None

get_record_as_bytes

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

    Returns str

list_keys

  • list_keys(*, limit, exclusive_start_key, collection, prefix, signature): dict

record_exists

  • record_exists(key): bool

set_record

  • set_record(key, value, content_type): None

stream_record

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

update

  • update(*, name, general_access): dict
Page Options