v1

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 2, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
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.

View Source
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.

View Source
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.

View Source
var File_banyandb_model_v1_common_proto protoreflect.FileDescriptor
View Source
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) Enum

func (AggregationFunction) EnumDescriptor deprecated

func (AggregationFunction) EnumDescriptor() ([]byte, []int)

Deprecated: Use AggregationFunction.Descriptor instead.

func (AggregationFunction) Number

func (AggregationFunction) String

func (x AggregationFunction) String() string

func (AggregationFunction) Type

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) Descriptor() ([]byte, []int)

Deprecated: Use Condition.ProtoReflect.Descriptor instead.

func (*Condition) GetName

func (x *Condition) GetName() string

func (*Condition) GetOp

func (x *Condition) GetOp() Condition_BinaryOp

func (*Condition) GetValue

func (x *Condition) GetValue() *TagValue

func (*Condition) ProtoMessage

func (*Condition) ProtoMessage()

func (*Condition) ProtoReflect

func (x *Condition) ProtoReflect() protoreflect.Message

func (*Condition) Reset

func (x *Condition) Reset()

func (*Condition) String

func (x *Condition) String() string

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) Enum

func (Condition_BinaryOp) EnumDescriptor deprecated

func (Condition_BinaryOp) EnumDescriptor() ([]byte, []int)

Deprecated: Use Condition_BinaryOp.Descriptor instead.

func (Condition_BinaryOp) Number

func (Condition_BinaryOp) String

func (x Condition_BinaryOp) String() string

func (Condition_BinaryOp) Type

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) Descriptor() ([]byte, []int)

Deprecated: Use Criteria.ProtoReflect.Descriptor instead.

func (*Criteria) GetConditions

func (x *Criteria) GetConditions() []*Condition

func (*Criteria) GetTagFamilyName

func (x *Criteria) GetTagFamilyName() string

func (*Criteria) ProtoMessage

func (*Criteria) ProtoMessage()

func (*Criteria) ProtoReflect

func (x *Criteria) ProtoReflect() protoreflect.Message

func (*Criteria) Reset

func (x *Criteria) Reset()

func (*Criteria) String

func (x *Criteria) String() string

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_Null struct {
	Null structpb.NullValue `protobuf:"varint,1,opt,name=null,proto3,enum=google.protobuf.NullValue,oneof"`
}

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) Descriptor() ([]byte, []int)

Deprecated: Use ID.ProtoReflect.Descriptor instead.

func (*ID) GetValue

func (x *ID) GetValue() string

func (*ID) ProtoMessage

func (*ID) ProtoMessage()

func (*ID) ProtoReflect

func (x *ID) ProtoReflect() protoreflect.Message

func (*ID) Reset

func (x *ID) Reset()

func (*ID) String

func (x *ID) String() string

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) Descriptor() ([]byte, []int)

Deprecated: Use Int.ProtoReflect.Descriptor instead.

func (*Int) GetValue

func (x *Int) GetValue() int64

func (*Int) ProtoMessage

func (*Int) ProtoMessage()

func (*Int) ProtoReflect

func (x *Int) ProtoReflect() protoreflect.Message

func (*Int) Reset

func (x *Int) Reset()

func (*Int) String

func (x *Int) String() string

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) Descriptor() ([]byte, []int)

Deprecated: Use IntArray.ProtoReflect.Descriptor instead.

func (*IntArray) GetValue

func (x *IntArray) GetValue() []int64

func (*IntArray) ProtoMessage

func (*IntArray) ProtoMessage()

func (*IntArray) ProtoReflect

func (x *IntArray) ProtoReflect() protoreflect.Message

func (*IntArray) Reset

func (x *IntArray) Reset()

func (*IntArray) String

func (x *IntArray) String() string

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
const (
	Sort_SORT_UNSPECIFIED Sort = 0
	Sort_SORT_DESC        Sort = 1
	Sort_SORT_ASC         Sort = 2
)

func (Sort) Descriptor

func (Sort) Descriptor() protoreflect.EnumDescriptor

func (Sort) Enum

func (x Sort) Enum() *Sort

func (Sort) EnumDescriptor deprecated

func (Sort) EnumDescriptor() ([]byte, []int)

Deprecated: Use Sort.Descriptor instead.

func (Sort) Number

func (x Sort) Number() protoreflect.EnumNumber

func (Sort) String

func (x Sort) String() string

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) Descriptor() ([]byte, []int)

Deprecated: Use Str.ProtoReflect.Descriptor instead.

func (*Str) GetValue

func (x *Str) GetValue() string

func (*Str) ProtoMessage

func (*Str) ProtoMessage()

func (*Str) ProtoReflect

func (x *Str) ProtoReflect() protoreflect.Message

func (*Str) Reset

func (x *Str) Reset()

func (*Str) String

func (x *Str) String() string

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) Descriptor() ([]byte, []int)

Deprecated: Use StrArray.ProtoReflect.Descriptor instead.

func (*StrArray) GetValue

func (x *StrArray) GetValue() []string

func (*StrArray) ProtoMessage

func (*StrArray) ProtoMessage()

func (*StrArray) ProtoReflect

func (x *StrArray) ProtoReflect() protoreflect.Message

func (*StrArray) Reset

func (x *StrArray) Reset()

func (*StrArray) String

func (x *StrArray) String() string

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) Descriptor() ([]byte, []int)

Deprecated: Use Tag.ProtoReflect.Descriptor instead.

func (*Tag) GetKey

func (x *Tag) GetKey() string

func (*Tag) GetValue

func (x *Tag) GetValue() *TagValue

func (*Tag) ProtoMessage

func (*Tag) ProtoMessage()

func (*Tag) ProtoReflect

func (x *Tag) ProtoReflect() protoreflect.Message

func (*Tag) Reset

func (x *Tag) Reset()

func (*Tag) String

func (x *Tag) String() string

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) Descriptor() ([]byte, []int)

Deprecated: Use TagFamily.ProtoReflect.Descriptor instead.

func (*TagFamily) GetName

func (x *TagFamily) GetName() string

func (*TagFamily) GetTags

func (x *TagFamily) GetTags() []*Tag

func (*TagFamily) ProtoMessage

func (*TagFamily) ProtoMessage()

func (*TagFamily) ProtoReflect

func (x *TagFamily) ProtoReflect() protoreflect.Message

func (*TagFamily) Reset

func (x *TagFamily) Reset()

func (*TagFamily) String

func (x *TagFamily) String() string

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) Descriptor() ([]byte, []int)

Deprecated: Use TagValue.ProtoReflect.Descriptor instead.

func (*TagValue) GetBinaryData

func (x *TagValue) GetBinaryData() []byte

func (*TagValue) GetId

func (x *TagValue) GetId() *ID

func (*TagValue) GetInt

func (x *TagValue) GetInt() *Int

func (*TagValue) GetIntArray

func (x *TagValue) GetIntArray() *IntArray

func (*TagValue) GetNull

func (x *TagValue) GetNull() structpb.NullValue

func (*TagValue) GetStr

func (x *TagValue) GetStr() *Str

func (*TagValue) GetStrArray

func (x *TagValue) GetStrArray() *StrArray

func (*TagValue) GetValue

func (m *TagValue) GetValue() isTagValue_Value

func (*TagValue) ProtoMessage

func (*TagValue) ProtoMessage()

func (*TagValue) ProtoReflect

func (x *TagValue) ProtoReflect() protoreflect.Message

func (*TagValue) Reset

func (x *TagValue) Reset()

func (*TagValue) String

func (x *TagValue) String() string

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_Null struct {
	Null structpb.NullValue `protobuf:"varint,1,opt,name=null,proto3,enum=google.protobuf.NullValue,oneof"`
}

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) Descriptor() ([]byte, []int)

Deprecated: Use TimeRange.ProtoReflect.Descriptor instead.

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

func (*TimeRange) Reset

func (x *TimeRange) Reset()

func (*TimeRange) String

func (x *TimeRange) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL