Skip to main content

KeyValueStoreClientAsync

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

Index

Methods

delete

  • async delete(): None

delete_record

  • async delete_record(key): None

get

  • async get(): dict | None

get_record

  • async get_record(key): dict | None

get_record_as_bytes

  • async get_record_as_bytes(key): dict | None

list_keys

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

  • 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

set_record

  • async set_record(key, value, content_type): None

stream_record

  • async stream_record(key): AsyncIterator[dict | None]

update

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