GRPC API

store.proto

DatabasesRequest

DatabasesResponse

Field Type Label Description
databases string repeated

DeleteOptions

Field Type Label Description
database string
table string

DeleteRequest

Field Type Label Description
key string
options DeleteOptions

DeleteResponse

Field

Field Type Label Description
type string type of value e.g string, int, int64, bool, float64
value string the actual value

ListOptions

Field Type Label Description
database string
table string
prefix string
suffix string
limit uint64
offset uint64

ListRequest

Field Type Label Description
options ListOptions

ListResponse

Field Type Label Description
keys string repeated

ReadOptions

Field Type Label Description
database string
table string
prefix bool
suffix bool
limit uint64
offset uint64
where ReadOptions.WhereEntry repeated

ReadOptions.WhereEntry

Field Type Label Description
key string
value Field

ReadRequest

Field Type Label Description
key string
options ReadOptions

ReadResponse

Field Type Label Description
records Record repeated

Record

Field Type Label Description
key string key of the recorda
value bytes value in the record
expiry int64 time.Duration (signed int64 nanoseconds)
metadata Record.MetadataEntry repeated the associated metadata

Record.MetadataEntry

Field Type Label Description
key string
value Field

TablesRequest

Field Type Label Description
database string

TablesResponse

Field Type Label Description
tables string repeated

WriteOptions

Field Type Label Description
database string
table string
expiry int64 time.Time
ttl int64 time.Duration

WriteRequest

Field Type Label Description
record Record
options WriteOptions

WriteResponse

Store

Method Name Request Type Response Type Description
Read ReadRequest ReadResponse
Write WriteRequest WriteResponse
Delete DeleteRequest DeleteResponse
List ListRequest ListResponse stream
Databases DatabasesRequest DatabasesResponse
Tables TablesRequest TablesResponse

Scalar Value Types

.proto Type Notes C++ Java
double
double double
float
float float
int32
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int
int64
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long
uint32
Uses variable-length encoding. uint32 int
uint64
Uses variable-length encoding. uint64 long
sint32
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int
sint64
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long
fixed32
Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int
fixed64
Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long
sfixed32
Always four bytes. int32 int
sfixed64
Always eight bytes. int64 long
bool
bool boolean
string
A string must always contain UTF-8 encoded or 7-bit ASCII text. string String
bytes
May contain any arbitrary sequence of bytes. string ByteString