Interface for state storages that are used to store and retrieve transaction states.
Instance methods
Delete
Deletes a state from the store by its key.
Delete(ctx context.Context, correlationId string, key string) any
- ctx: context.Context - operation context.
- correlationId: string - (optional) transaction id to trace execution through a call chain.
- key: string - 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.
Load(ctx context.Context, correlationId string, key string) any
- ctx: context.Context - operation context.
- correlationId: string - (optional) transaction id to trace execution through a call chain.
- key: string - a unique state key.
- return: any - the state value or
null
if value wasn’t found.
LoadBulk
Loads an array of states from the store using their keys.
LoadBulk(ctx context.Context, correlationId string, keys []string) []*StateValue
- ctx: context.Context - operation context.
- correlationId: string - (optional) transaction id to trace execution through call chain.
- keys: []string - unique state keys.
- returns: []*StateValue - an array with state values and their corresponding keys.
Save
Saves state into the store.
Save(ctx context.Context, correlationId string, key string, value any) any
- ctx: context.Context - operation context.
- correlationId: string - (optional) transaction id to trace execution through a call chain.
- key: string - a unique state key.
- value: any - a state value.
- returns: any - execution duration in milliseconds.