KeyValueStoreClient

Subclient for manipulating a single key-value store.

Hierarchy

• BaseKeyValueStoreClient
  • KeyValueStoreClient

Index

Constructors

• __init__

Methods

• delete
• delete_persisted_record
• delete_record
• get
• get_public_url
• get_record
• get_record_as_bytes
• list_keys
• persist_record
• set_record
• stream_record
• update
• update_timestamps

Properties

• resource_directory
• resource_info

Constructors

__init__

• __init__(*, memory_storage_client, id, name, created_at, accessed_at, modified_at): None

• Parameters

  • keyword-onlymemory_storage_client: MemoryStorageClient

  • keyword-onlyid: str | None = None

  • keyword-onlyname: str | None = None

  • keyword-onlycreated_at: datetime | None = None

  • keyword-onlyaccessed_at: datetime | None = None

  • keyword-onlymodified_at: datetime | None = None

  Returns None

Methods

delete

• async delete(): None

• Returns None

delete_persisted_record

• async delete_persisted_record(record): None

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

  ---

  Parameters

  • record: KeyValueStoreRecord

  Returns None

delete_record

• async delete_record(key): None

• Parameters

  • key: str

  Returns None

get

• async get(): KeyValueStoreMetadata | None

• Returns KeyValueStoreMetadata | None

get_public_url

• async get_public_url(key): str

• Parameters

  • key: str

  Returns str

get_record

• async get_record(key): KeyValueStoreRecord | None

• Parameters

  • key: str

  Returns KeyValueStoreRecord | None

get_record_as_bytes

• async get_record_as_bytes(key): KeyValueStoreRecord[bytes] | None

• Parameters

  • key: str

  Returns KeyValueStoreRecord[bytes] | None

list_keys

• async list_keys(*, limit, exclusive_start_key): KeyValueStoreListKeysPage

• Parameters

  • keyword-onlylimit: int = 1000

  • keyword-onlyexclusive_start_key: str | None = None

  Returns KeyValueStoreListKeysPage

persist_record

• async persist_record(record): None

• Persist the specified record to the key-value store.

  ---

  Parameters

  • record: KeyValueStoreRecord

  Returns None

set_record

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

• Parameters

  • key: str

  • value: Any

  • content_type: str | None = None

  Returns None

stream_record

• async stream_record(key): AsyncContextManager[KeyValueStoreRecord[Response] | None]

• Parameters

  • key: str

  Returns AsyncContextManager[KeyValueStoreRecord[Response] | None]

update

• async update(*, name): KeyValueStoreMetadata

• Parameters

  • keyword-onlyname: str | None = None

  Returns KeyValueStoreMetadata

update_timestamps

• async update_timestamps(*, has_been_modified): None

• Update the timestamps of the key-value store.

  ---

  Parameters

  • keyword-onlyhas_been_modified: bool

  Returns None

Properties

resource_directory

resource_directory: str

Get the resource directory for the client.

resource_info

resource_info: KeyValueStoreMetadata

Get the resource info for the key-value store client.