Skip to content

DeleteValueKVStoreRequest

Purpose

Prevent actors capable of sending read requests to the Storage Engine to be able to read a previously set value for a specified key.

Type

Reception:

DeleteValueKVStoreRequestV1

Records with fields:

  • Storage Key: StorageKeyV1

    The key that that identifies the piece of data that should be removed from the KV-store.

Triggers

DeleteValueKVStoreResponseV1

Records with fields:

  • Storage Key: StorageKeyV1

    The key that that identifies the piece of data in the KV-store.

  • Success Operation: SuccessOperationV1

    The success of the operation, indicating that the KV-pair was deleted successfully or not.

Behaviour

Finds a value by its key in the KV-store and modifies the reading capabilities related to said key availiable through the Storage API.

The behavior is tied directly to reading capabilities of the Storage Engine and hence can be described via interaction with GetValueKVStore as follows:

If DeleteValueKVStoreRequestV1 was sent with key key specified and DeleteValueKVStoreResponseV1 returns a success then GetValueKVStoreRequestV1 sent with key key will trigger a Nothing response.

Message Flow

sequenceDiagram

%% --8<-- [start:sequence]
Any Local Engine ->>+ Local KV Storage Engine: DeleteValueKVStoreRequest
Local KV Storage Engine -->>- Any Local Engine: DeleteValueKVStoreResponse
%% --8<-- [end:sequence]
(Wiki) links on this page