IStateStore

Interface for state storages that are used to store and retrieve transaction states.

Description

TODO: add description

Abstract methods

delete

Deletes a state from the store by its key.

abstractmethod delete(correlation_id: Optional[str], key: str): Any

  • correlation_id: Optional[str] - (optional) transaction id to trace execution through a call chain.
  • key: str - a unique value key.
  • return: Any - removed item

load

Loads state from the store using its key. If value is missing in the store it returns null.

abstractmethod load(correlation_id: Optional[str], key: str): Any

  • correlation_id: Optional[str] - (optional) transaction id to trace execution through a call chain.
  • key: str - a unique state key.
  • return: Any - the state value or null if value wasn’t found.

load_bulk

Loads an array of states from the store using their keys.

abstractmethod load_bulk(self, correlation_id: Optional[str], keys: List[str]) -> List[StateValue]

  • correlation_id: Optional[str] - (optional) transaction id to trace execution through call chain.
  • keys: List[str] - unique state keys.
  • returns: List[StateValue] - an array with state values and their corresponding keys.

save

Saves state into the store.

abstractmethod save(correlation_id: Optional[str], key: str, value: Any): Any

  • correlation_id: Optional[str] - (optional) transaction id to trace execution through a call chain.
  • key: str - a unique state key.
  • value: Any - a state value.
  • returns: Any - execution duration in milliseconds.