yr.kv_read

Contents

yr.kv_read#

yr.kv_read(key: str | List[str], timeout: int = 300) → bytes | memoryview | List[bytes | memoryview][source]#

Provides a Redis-like interface to retrieve data, supporting the retrieval of multiple data items simultaneously.

Parameters:

  • key (Union[str, List[str]]) – A single key or a list of keys specifying the data to be retrieved.

  • timeout (int, optional) – The timeout in seconds. This parameter is optional and defaults to 300. A value of -1 indicates permanent blocking wait.

Returns:

Returns one or a list of retrieved data items. Data type is Union[bytes, List[bytes]].

Raises:

  • RuntimeError – If kv_read() is called without initialization, an exception will be thrown.

  • RuntimeError – If data retrieval from the data system fails.

Example

>>> v1 = yr.kv_read("kv-key")
Contents