package nitric.proto.kvstore.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Service for storage and retrieval of simple JSON keyValue

• rpc GetValue (KvStoreGetValueRequest, KvStoreGetValueResponse)

  kvstore.proto:18

  Get an existing value

  message KvStoreGetValueRequest

  kvstore.proto:54

  • optional ValueRef ref = 1

    ValueRef of the key/value pair to get, which includes the store and key

  message KvStoreGetValueResponse

  kvstore.proto:59

  • optional Value value = 1

    The retrieved value

• rpc SetValue (KvStoreSetValueRequest, KvStoreSetValueResponse)

  kvstore.proto:21

  Create a new or overwrite an existing value

  message KvStoreSetValueRequest

  kvstore.proto:64

  • optional ValueRef ref = 1

    ValueRef of the key/value pair to set, which includes the store and key

  • optional google.protobuf.Struct content = 3

    The value content to store (JSON object)

  message KvStoreSetValueResponse

  kvstore.proto:71

  (message has no fields)

• rpc DeleteKey (KvStoreDeleteKeyRequest, KvStoreDeleteKeyResponse)

  kvstore.proto:24

  Delete a key and its value

  message KvStoreDeleteKeyRequest

  kvstore.proto:74

  • optional ValueRef ref = 1

    ValueRef of the key/value pair to delete, which includes the store and key

  message KvStoreDeleteKeyResponse

  kvstore.proto:79

  (message has no fields)

• rpc ScanKeys (KvStoreScanKeysRequest, stream KvStoreScanKeysResponse)

  kvstore.proto:27

  Iterate over all keys in a store

  message KvStoreScanKeysRequest

  kvstore.proto:82

  • optional Store store = 1

    The store to iterate over

  • string prefix = 2

    The prefix to filter keys by

  message KvStoreScanKeysResponse

  kvstore.proto:90

  • string key = 1

    The key of the key/value pair

Provides a Key/Value Store

Used in: KvStoreScanKeysRequest

• string name = 1

  The store name

Value provides a return value type

Used in: KvStoreGetValueResponse

• optional ValueRef ref = 1

  ValueRef of the key/value pair, which includes the store and key

• optional google.protobuf.Struct content = 2

  The content (JSON object)

ValueRef provides a unique identifier for a value

Used in: KvStoreDeleteKeyRequest, KvStoreGetValueRequest, KvStoreSetValueRequest, Value

• string store = 1

  The key/value store name

• string key = 2

  The item's unique key within the store