Documentation
¶
Index ¶
- Variables
- type AggregationFunction
- func (AggregationFunction) Descriptor() protoreflect.EnumDescriptor
- func (x AggregationFunction) Enum() *AggregationFunction
- func (AggregationFunction) EnumDescriptor() ([]byte, []int)deprecated
- func (x AggregationFunction) Number() protoreflect.EnumNumber
- func (x AggregationFunction) String() string
- func (AggregationFunction) Type() protoreflect.EnumType
- type Condition
- func (*Condition) Descriptor() ([]byte, []int)deprecated
- func (x *Condition) GetName() string
- func (x *Condition) GetOp() Condition_BinaryOp
- func (x *Condition) GetValue() *TagValue
- func (*Condition) ProtoMessage()
- func (x *Condition) ProtoReflect() protoreflect.Message
- func (x *Condition) Reset()
- func (x *Condition) String() string
- type Condition_BinaryOp
- func (Condition_BinaryOp) Descriptor() protoreflect.EnumDescriptor
- func (x Condition_BinaryOp) Enum() *Condition_BinaryOp
- func (Condition_BinaryOp) EnumDescriptor() ([]byte, []int)deprecated
- func (x Condition_BinaryOp) Number() protoreflect.EnumNumber
- func (x Condition_BinaryOp) String() string
- func (Condition_BinaryOp) Type() protoreflect.EnumType
- type Criteria
- type FieldValue
- func (*FieldValue) Descriptor() ([]byte, []int)deprecated
- func (x *FieldValue) GetBinaryData() []byte
- func (x *FieldValue) GetInt() *Int
- func (x *FieldValue) GetNull() structpb.NullValue
- func (x *FieldValue) GetStr() *Str
- func (m *FieldValue) GetValue() isFieldValue_Value
- func (*FieldValue) ProtoMessage()
- func (x *FieldValue) ProtoReflect() protoreflect.Message
- func (x *FieldValue) Reset()
- func (x *FieldValue) String() string
- type FieldValue_BinaryData
- type FieldValue_Int
- type FieldValue_Null
- type FieldValue_Str
- type ID
- type Int
- type IntArray
- type QueryOrder
- type Sort
- type Str
- type StrArray
- type Tag
- type TagFamily
- type TagFamilyForWrite
- type TagProjection
- type TagProjection_TagFamily
- func (*TagProjection_TagFamily) Descriptor() ([]byte, []int)deprecated
- func (x *TagProjection_TagFamily) GetName() string
- func (x *TagProjection_TagFamily) GetTags() []string
- func (*TagProjection_TagFamily) ProtoMessage()
- func (x *TagProjection_TagFamily) ProtoReflect() protoreflect.Message
- func (x *TagProjection_TagFamily) Reset()
- func (x *TagProjection_TagFamily) String() string
- type TagValue
- func (*TagValue) Descriptor() ([]byte, []int)deprecated
- func (x *TagValue) GetBinaryData() []byte
- func (x *TagValue) GetId() *ID
- func (x *TagValue) GetInt() *Int
- func (x *TagValue) GetIntArray() *IntArray
- func (x *TagValue) GetNull() structpb.NullValue
- func (x *TagValue) GetStr() *Str
- func (x *TagValue) GetStrArray() *StrArray
- func (m *TagValue) GetValue() isTagValue_Value
- func (*TagValue) ProtoMessage()
- func (x *TagValue) ProtoReflect() protoreflect.Message
- func (x *TagValue) Reset()
- func (x *TagValue) String() string
- type TagValue_BinaryData
- type TagValue_Id
- type TagValue_Int
- type TagValue_IntArray
- type TagValue_Null
- type TagValue_Str
- type TagValue_StrArray
- type TimeRange
- func (*TimeRange) Descriptor() ([]byte, []int)deprecated
- func (x *TimeRange) GetBegin() *timestamppb.Timestamp
- func (x *TimeRange) GetEnd() *timestamppb.Timestamp
- func (*TimeRange) ProtoMessage()
- func (x *TimeRange) ProtoReflect() protoreflect.Message
- func (x *TimeRange) Reset()
- func (x *TimeRange) String() string
Constants ¶
This section is empty.
Variables ¶
var ( AggregationFunction_name = map[int32]string{ 0: "AGGREGATION_FUNCTION_UNSPECIFIED", 1: "AGGREGATION_FUNCTION_MEAN", 2: "AGGREGATION_FUNCTION_MAX", 3: "AGGREGATION_FUNCTION_MIN", 4: "AGGREGATION_FUNCTION_COUNT", 5: "AGGREGATION_FUNCTION_SUM", } AggregationFunction_value = map[string]int32{ "AGGREGATION_FUNCTION_UNSPECIFIED": 0, "AGGREGATION_FUNCTION_MEAN": 1, "AGGREGATION_FUNCTION_MAX": 2, "AGGREGATION_FUNCTION_MIN": 3, "AGGREGATION_FUNCTION_COUNT": 4, "AGGREGATION_FUNCTION_SUM": 5, } )
Enum value maps for AggregationFunction.
var ( Sort_name = map[int32]string{ 0: "SORT_UNSPECIFIED", 1: "SORT_DESC", 2: "SORT_ASC", } Sort_value = map[string]int32{ "SORT_UNSPECIFIED": 0, "SORT_DESC": 1, "SORT_ASC": 2, } )
Enum value maps for Sort.
var ( Condition_BinaryOp_name = map[int32]string{ 0: "BINARY_OP_UNSPECIFIED", 1: "BINARY_OP_EQ", 2: "BINARY_OP_NE", 3: "BINARY_OP_LT", 4: "BINARY_OP_GT", 5: "BINARY_OP_LE", 6: "BINARY_OP_GE", 7: "BINARY_OP_HAVING", 8: "BINARY_OP_NOT_HAVING", 9: "BINARY_OP_IN", 10: "BINARY_OP_NOT_IN", } Condition_BinaryOp_value = map[string]int32{ "BINARY_OP_UNSPECIFIED": 0, "BINARY_OP_EQ": 1, "BINARY_OP_NE": 2, "BINARY_OP_LT": 3, "BINARY_OP_GT": 4, "BINARY_OP_LE": 5, "BINARY_OP_GE": 6, "BINARY_OP_HAVING": 7, "BINARY_OP_NOT_HAVING": 8, "BINARY_OP_IN": 9, "BINARY_OP_NOT_IN": 10, } )
Enum value maps for Condition_BinaryOp.
var File_banyandb_model_v1_common_proto protoreflect.FileDescriptor
var File_banyandb_model_v1_query_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type AggregationFunction ¶
type AggregationFunction int32
const ( AggregationFunction_AGGREGATION_FUNCTION_UNSPECIFIED AggregationFunction = 0 AggregationFunction_AGGREGATION_FUNCTION_MEAN AggregationFunction = 1 AggregationFunction_AGGREGATION_FUNCTION_MAX AggregationFunction = 2 AggregationFunction_AGGREGATION_FUNCTION_MIN AggregationFunction = 3 AggregationFunction_AGGREGATION_FUNCTION_COUNT AggregationFunction = 4 AggregationFunction_AGGREGATION_FUNCTION_SUM AggregationFunction = 5 )
func (AggregationFunction) Descriptor ¶
func (AggregationFunction) Descriptor() protoreflect.EnumDescriptor
func (AggregationFunction) Enum ¶
func (x AggregationFunction) Enum() *AggregationFunction
func (AggregationFunction) EnumDescriptor
deprecated
func (AggregationFunction) EnumDescriptor() ([]byte, []int)
Deprecated: Use AggregationFunction.Descriptor instead.
func (AggregationFunction) Number ¶
func (x AggregationFunction) Number() protoreflect.EnumNumber
func (AggregationFunction) String ¶
func (x AggregationFunction) String() string
func (AggregationFunction) Type ¶
func (AggregationFunction) Type() protoreflect.EnumType
type Condition ¶
type Condition struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Op Condition_BinaryOp `protobuf:"varint,2,opt,name=op,proto3,enum=banyandb.model.v1.Condition_BinaryOp" json:"op,omitempty"` Value *TagValue `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
Condition consists of the query condition with a single binary operator to be imposed For 1:1 BinaryOp, values in condition must be an array with length = 1, while for 1:N BinaryOp, values can be an array with length >= 1.
func (*Condition) Descriptor
deprecated
func (*Condition) GetOp ¶
func (x *Condition) GetOp() Condition_BinaryOp
func (*Condition) ProtoMessage ¶
func (*Condition) ProtoMessage()
func (*Condition) ProtoReflect ¶
func (x *Condition) ProtoReflect() protoreflect.Message
type Condition_BinaryOp ¶
type Condition_BinaryOp int32
BinaryOp specifies the operation imposed to the given query condition For EQ, NE, LT, GT, LE and GE, only one operand should be given, i.e. one-to-one relationship. HAVING and NOT_HAVING allow multi-value to be the operand such as array/vector, i.e. one-to-many relationship. For example, "keyA" contains "valueA" **and** "valueB"
const ( Condition_BINARY_OP_UNSPECIFIED Condition_BinaryOp = 0 Condition_BINARY_OP_EQ Condition_BinaryOp = 1 Condition_BINARY_OP_NE Condition_BinaryOp = 2 Condition_BINARY_OP_LT Condition_BinaryOp = 3 Condition_BINARY_OP_GT Condition_BinaryOp = 4 Condition_BINARY_OP_LE Condition_BinaryOp = 5 Condition_BINARY_OP_GE Condition_BinaryOp = 6 Condition_BINARY_OP_HAVING Condition_BinaryOp = 7 Condition_BINARY_OP_NOT_HAVING Condition_BinaryOp = 8 Condition_BINARY_OP_IN Condition_BinaryOp = 9 Condition_BINARY_OP_NOT_IN Condition_BinaryOp = 10 )
func (Condition_BinaryOp) Descriptor ¶
func (Condition_BinaryOp) Descriptor() protoreflect.EnumDescriptor
func (Condition_BinaryOp) Enum ¶
func (x Condition_BinaryOp) Enum() *Condition_BinaryOp
func (Condition_BinaryOp) EnumDescriptor
deprecated
func (Condition_BinaryOp) EnumDescriptor() ([]byte, []int)
Deprecated: Use Condition_BinaryOp.Descriptor instead.
func (Condition_BinaryOp) Number ¶
func (x Condition_BinaryOp) Number() protoreflect.EnumNumber
func (Condition_BinaryOp) String ¶
func (x Condition_BinaryOp) String() string
func (Condition_BinaryOp) Type ¶
func (Condition_BinaryOp) Type() protoreflect.EnumType
type Criteria ¶
type Criteria struct { TagFamilyName string `protobuf:"bytes,1,opt,name=tag_family_name,json=tagFamilyName,proto3" json:"tag_family_name,omitempty"` Conditions []*Condition `protobuf:"bytes,2,rep,name=conditions,proto3" json:"conditions,omitempty"` // contains filtered or unexported fields }
tag_families are indexed.
func (*Criteria) Descriptor
deprecated
func (*Criteria) GetConditions ¶
func (*Criteria) GetTagFamilyName ¶
func (*Criteria) ProtoMessage ¶
func (*Criteria) ProtoMessage()
func (*Criteria) ProtoReflect ¶
func (x *Criteria) ProtoReflect() protoreflect.Message
type FieldValue ¶
type FieldValue struct { // Types that are assignable to Value: // *FieldValue_Null // *FieldValue_Str // *FieldValue_Int // *FieldValue_BinaryData Value isFieldValue_Value `protobuf_oneof:"value"` // contains filtered or unexported fields }
func (*FieldValue) Descriptor
deprecated
func (*FieldValue) Descriptor() ([]byte, []int)
Deprecated: Use FieldValue.ProtoReflect.Descriptor instead.
func (*FieldValue) GetBinaryData ¶
func (x *FieldValue) GetBinaryData() []byte
func (*FieldValue) GetInt ¶
func (x *FieldValue) GetInt() *Int
func (*FieldValue) GetNull ¶
func (x *FieldValue) GetNull() structpb.NullValue
func (*FieldValue) GetStr ¶
func (x *FieldValue) GetStr() *Str
func (*FieldValue) GetValue ¶
func (m *FieldValue) GetValue() isFieldValue_Value
func (*FieldValue) ProtoMessage ¶
func (*FieldValue) ProtoMessage()
func (*FieldValue) ProtoReflect ¶
func (x *FieldValue) ProtoReflect() protoreflect.Message
func (*FieldValue) Reset ¶
func (x *FieldValue) Reset()
func (*FieldValue) String ¶
func (x *FieldValue) String() string
type FieldValue_BinaryData ¶
type FieldValue_BinaryData struct {
BinaryData []byte `protobuf:"bytes,4,opt,name=binary_data,json=binaryData,proto3,oneof"`
}
type FieldValue_Int ¶
type FieldValue_Int struct {
Int *Int `protobuf:"bytes,3,opt,name=int,proto3,oneof"`
}
type FieldValue_Null ¶
type FieldValue_Str ¶
type FieldValue_Str struct {
Str *Str `protobuf:"bytes,2,opt,name=str,proto3,oneof"`
}
type ID ¶
type ID struct { Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
func (*ID) Descriptor
deprecated
func (*ID) ProtoMessage ¶
func (*ID) ProtoMessage()
func (*ID) ProtoReflect ¶
func (x *ID) ProtoReflect() protoreflect.Message
type Int ¶
type Int struct { Value int64 `protobuf:"varint,1,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
func (*Int) Descriptor
deprecated
func (*Int) ProtoMessage ¶
func (*Int) ProtoMessage()
func (*Int) ProtoReflect ¶
func (x *Int) ProtoReflect() protoreflect.Message
type IntArray ¶
type IntArray struct { Value []int64 `protobuf:"varint,1,rep,packed,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
func (*IntArray) Descriptor
deprecated
func (*IntArray) ProtoMessage ¶
func (*IntArray) ProtoMessage()
func (*IntArray) ProtoReflect ¶
func (x *IntArray) ProtoReflect() protoreflect.Message
type QueryOrder ¶
type QueryOrder struct { IndexRuleName string `protobuf:"bytes,1,opt,name=index_rule_name,json=indexRuleName,proto3" json:"index_rule_name,omitempty"` Sort Sort `protobuf:"varint,2,opt,name=sort,proto3,enum=banyandb.model.v1.Sort" json:"sort,omitempty"` // contains filtered or unexported fields }
QueryOrder means a Sort operation to be done for a given index rule. The index_rule_name refers to the name of a index rule bound to the subject.
func (*QueryOrder) Descriptor
deprecated
func (*QueryOrder) Descriptor() ([]byte, []int)
Deprecated: Use QueryOrder.ProtoReflect.Descriptor instead.
func (*QueryOrder) GetIndexRuleName ¶
func (x *QueryOrder) GetIndexRuleName() string
func (*QueryOrder) GetSort ¶
func (x *QueryOrder) GetSort() Sort
func (*QueryOrder) ProtoMessage ¶
func (*QueryOrder) ProtoMessage()
func (*QueryOrder) ProtoReflect ¶
func (x *QueryOrder) ProtoReflect() protoreflect.Message
func (*QueryOrder) Reset ¶
func (x *QueryOrder) Reset()
func (*QueryOrder) String ¶
func (x *QueryOrder) String() string
type Sort ¶
type Sort int32
func (Sort) Descriptor ¶
func (Sort) Descriptor() protoreflect.EnumDescriptor
func (Sort) EnumDescriptor
deprecated
func (Sort) Number ¶
func (x Sort) Number() protoreflect.EnumNumber
func (Sort) Type ¶
func (Sort) Type() protoreflect.EnumType
type Str ¶
type Str struct { Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
func (*Str) Descriptor
deprecated
func (*Str) ProtoMessage ¶
func (*Str) ProtoMessage()
func (*Str) ProtoReflect ¶
func (x *Str) ProtoReflect() protoreflect.Message
type StrArray ¶
type StrArray struct { Value []string `protobuf:"bytes,1,rep,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
func (*StrArray) Descriptor
deprecated
func (*StrArray) ProtoMessage ¶
func (*StrArray) ProtoMessage()
func (*StrArray) ProtoReflect ¶
func (x *StrArray) ProtoReflect() protoreflect.Message
type Tag ¶
type Tag struct { Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` Value *TagValue `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
Pair is the building block of a record which is equivalent to a key-value pair. In the context of Trace, it could be metadata of a trace such as service_name, service_instance, etc. Besides, other tags are organized in key-value pair in the underlying storage layer. One should notice that the values can be a multi-value.
func (*Tag) Descriptor
deprecated
func (*Tag) ProtoMessage ¶
func (*Tag) ProtoMessage()
func (*Tag) ProtoReflect ¶
func (x *Tag) ProtoReflect() protoreflect.Message
type TagFamily ¶
type TagFamily struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Tags []*Tag `protobuf:"bytes,2,rep,name=tags,proto3" json:"tags,omitempty"` // contains filtered or unexported fields }
func (*TagFamily) Descriptor
deprecated
func (*TagFamily) ProtoMessage ¶
func (*TagFamily) ProtoMessage()
func (*TagFamily) ProtoReflect ¶
func (x *TagFamily) ProtoReflect() protoreflect.Message
type TagFamilyForWrite ¶
type TagFamilyForWrite struct { Tags []*TagValue `protobuf:"bytes,1,rep,name=tags,proto3" json:"tags,omitempty"` // contains filtered or unexported fields }
func (*TagFamilyForWrite) Descriptor
deprecated
func (*TagFamilyForWrite) Descriptor() ([]byte, []int)
Deprecated: Use TagFamilyForWrite.ProtoReflect.Descriptor instead.
func (*TagFamilyForWrite) GetTags ¶
func (x *TagFamilyForWrite) GetTags() []*TagValue
func (*TagFamilyForWrite) ProtoMessage ¶
func (*TagFamilyForWrite) ProtoMessage()
func (*TagFamilyForWrite) ProtoReflect ¶
func (x *TagFamilyForWrite) ProtoReflect() protoreflect.Message
func (*TagFamilyForWrite) Reset ¶
func (x *TagFamilyForWrite) Reset()
func (*TagFamilyForWrite) String ¶
func (x *TagFamilyForWrite) String() string
type TagProjection ¶
type TagProjection struct { TagFamilies []*TagProjection_TagFamily `protobuf:"bytes,1,rep,name=tag_families,json=tagFamilies,proto3" json:"tag_families,omitempty"` // contains filtered or unexported fields }
TagProjection is used to select the names of keys to be returned.
func (*TagProjection) Descriptor
deprecated
func (*TagProjection) Descriptor() ([]byte, []int)
Deprecated: Use TagProjection.ProtoReflect.Descriptor instead.
func (*TagProjection) GetTagFamilies ¶
func (x *TagProjection) GetTagFamilies() []*TagProjection_TagFamily
func (*TagProjection) ProtoMessage ¶
func (*TagProjection) ProtoMessage()
func (*TagProjection) ProtoReflect ¶
func (x *TagProjection) ProtoReflect() protoreflect.Message
func (*TagProjection) Reset ¶
func (x *TagProjection) Reset()
func (*TagProjection) String ¶
func (x *TagProjection) String() string
type TagProjection_TagFamily ¶
type TagProjection_TagFamily struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Tags []string `protobuf:"bytes,2,rep,name=tags,proto3" json:"tags,omitempty"` // contains filtered or unexported fields }
func (*TagProjection_TagFamily) Descriptor
deprecated
func (*TagProjection_TagFamily) Descriptor() ([]byte, []int)
Deprecated: Use TagProjection_TagFamily.ProtoReflect.Descriptor instead.
func (*TagProjection_TagFamily) GetName ¶
func (x *TagProjection_TagFamily) GetName() string
func (*TagProjection_TagFamily) GetTags ¶
func (x *TagProjection_TagFamily) GetTags() []string
func (*TagProjection_TagFamily) ProtoMessage ¶
func (*TagProjection_TagFamily) ProtoMessage()
func (*TagProjection_TagFamily) ProtoReflect ¶
func (x *TagProjection_TagFamily) ProtoReflect() protoreflect.Message
func (*TagProjection_TagFamily) Reset ¶
func (x *TagProjection_TagFamily) Reset()
func (*TagProjection_TagFamily) String ¶
func (x *TagProjection_TagFamily) String() string
type TagValue ¶
type TagValue struct { // Types that are assignable to Value: // *TagValue_Null // *TagValue_Str // *TagValue_StrArray // *TagValue_Int // *TagValue_IntArray // *TagValue_BinaryData // *TagValue_Id Value isTagValue_Value `protobuf_oneof:"value"` // contains filtered or unexported fields }
func (*TagValue) Descriptor
deprecated
func (*TagValue) GetBinaryData ¶
func (*TagValue) GetIntArray ¶
func (*TagValue) GetStrArray ¶
func (*TagValue) ProtoMessage ¶
func (*TagValue) ProtoMessage()
func (*TagValue) ProtoReflect ¶
func (x *TagValue) ProtoReflect() protoreflect.Message
type TagValue_BinaryData ¶
type TagValue_BinaryData struct {
BinaryData []byte `protobuf:"bytes,6,opt,name=binary_data,json=binaryData,proto3,oneof"`
}
type TagValue_Id ¶
type TagValue_Id struct {
Id *ID `protobuf:"bytes,7,opt,name=id,proto3,oneof"`
}
type TagValue_Int ¶
type TagValue_Int struct {
Int *Int `protobuf:"bytes,4,opt,name=int,proto3,oneof"`
}
type TagValue_IntArray ¶
type TagValue_IntArray struct {
IntArray *IntArray `protobuf:"bytes,5,opt,name=int_array,json=intArray,proto3,oneof"`
}
type TagValue_Null ¶
type TagValue_Str ¶
type TagValue_Str struct {
Str *Str `protobuf:"bytes,2,opt,name=str,proto3,oneof"`
}
type TagValue_StrArray ¶
type TagValue_StrArray struct {
StrArray *StrArray `protobuf:"bytes,3,opt,name=str_array,json=strArray,proto3,oneof"`
}
type TimeRange ¶
type TimeRange struct { Begin *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=begin,proto3" json:"begin,omitempty"` End *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end,proto3" json:"end,omitempty"` // contains filtered or unexported fields }
TimeRange is a range query for uint64, the range here follows left-inclusive and right-exclusive rule, i.e. [begin, end) if both edges exist
func (*TimeRange) Descriptor
deprecated
func (*TimeRange) GetBegin ¶
func (x *TimeRange) GetBegin() *timestamppb.Timestamp
func (*TimeRange) GetEnd ¶
func (x *TimeRange) GetEnd() *timestamppb.Timestamp
func (*TimeRange) ProtoMessage ¶
func (*TimeRange) ProtoMessage()
func (*TimeRange) ProtoReflect ¶
func (x *TimeRange) ProtoReflect() protoreflect.Message