frostfs-api/proto-docs/query.md
Evgeniy Kulikov fe877a169f
initialize
2020-01-30 14:43:09 +03:00

3.1 KiB

Protocol Documentation

Table of Contents

Top

query/types.proto

Message Filter

Field Type Label Description
type Filter.Type Type of filter
Name string Name of field that should be filtered
Value string Value that should be used for filter

Message Query

Field Type Label Description
Filters Filter repeated Filters is set of filters, should not be empty

Filter.Type

Name Number Description
Exact 0 Exact sets when value of filter should be equal to the header value
Regex 1 Regex sets when value of filter should match the header value by the regular expression

Scalar Value Types

.proto Type Notes C++ Type Java Type Python Type
double double double float
float 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 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 int/long
uint32 Uses variable-length encoding. uint32 int int/long
uint64 Uses variable-length encoding. uint64 long int/long
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long
sfixed32 Always four bytes. int32 int int
sfixed64 Always eight bytes. int64 long int/long
bool bool boolean boolean
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode
bytes May contain any arbitrary sequence of bytes. string ByteString str