Documentation ¶
Index ¶
- Variables
- type Catalog
- type Group
- func (*Group) Descriptor() ([]byte, []int)deprecated
- func (x *Group) GetCatalog() Catalog
- func (x *Group) GetMetadata() *Metadata
- func (x *Group) GetResourceOpts() *ResourceOpts
- func (x *Group) GetUpdatedAt() *timestamppb.Timestamp
- func (*Group) ProtoMessage()
- func (x *Group) ProtoReflect() protoreflect.Message
- func (x *Group) Reset()
- func (x *Group) String() string
- type Metadata
- func (*Metadata) Descriptor() ([]byte, []int)deprecated
- func (x *Metadata) GetCreateRevision() int64
- func (x *Metadata) GetGroup() string
- func (x *Metadata) GetId() uint32
- func (x *Metadata) GetModRevision() int64
- func (x *Metadata) GetName() string
- func (*Metadata) ProtoMessage()
- func (x *Metadata) ProtoReflect() protoreflect.Message
- func (x *Metadata) Reset()
- func (x *Metadata) String() string
- type ResourceOpts
- func (*ResourceOpts) Descriptor() ([]byte, []int)deprecated
- func (x *ResourceOpts) GetBlockNum() uint32
- func (x *ResourceOpts) GetShardNum() uint32
- func (x *ResourceOpts) GetTtl() string
- func (*ResourceOpts) ProtoMessage()
- func (x *ResourceOpts) ProtoReflect() protoreflect.Message
- func (x *ResourceOpts) Reset()
- func (x *ResourceOpts) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var ( Catalog_name = map[int32]string{ 0: "CATALOG_UNSPECIFIED", 1: "CATALOG_STREAM", 2: "CATALOG_MEASURE", } Catalog_value = map[string]int32{ "CATALOG_UNSPECIFIED": 0, "CATALOG_STREAM": 1, "CATALOG_MEASURE": 2, } )
Enum value maps for Catalog.
View Source
var File_banyandb_common_v1_common_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Catalog ¶
type Catalog int32
func (Catalog) Descriptor ¶
func (Catalog) Descriptor() protoreflect.EnumDescriptor
func (Catalog) EnumDescriptor
deprecated
func (Catalog) Number ¶
func (x Catalog) Number() protoreflect.EnumNumber
func (Catalog) Type ¶
func (Catalog) Type() protoreflect.EnumType
type Group ¶
type Group struct { // metadata define the group's identity Metadata *Metadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"` // catalog denotes which type of data the group contains Catalog Catalog `protobuf:"varint,2,opt,name=catalog,proto3,enum=banyandb.common.v1.Catalog" json:"catalog,omitempty"` // resourceOpts indicates the structure of the underlying kv storage ResourceOpts *ResourceOpts `protobuf:"bytes,3,opt,name=resource_opts,json=resourceOpts,proto3" json:"resource_opts,omitempty"` // updated_at indicates when resources of the group are updated UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"` // contains filtered or unexported fields }
Group is an internal object for Group management
func (*Group) Descriptor
deprecated
func (*Group) GetCatalog ¶
func (*Group) GetMetadata ¶
func (*Group) GetResourceOpts ¶
func (x *Group) GetResourceOpts() *ResourceOpts
func (*Group) GetUpdatedAt ¶
func (x *Group) GetUpdatedAt() *timestamppb.Timestamp
func (*Group) ProtoMessage ¶
func (*Group) ProtoMessage()
func (*Group) ProtoReflect ¶
func (x *Group) ProtoReflect() protoreflect.Message
type Metadata ¶
type Metadata struct { // group contains a set of options, like retention policy, max Group string `protobuf:"bytes,1,opt,name=group,proto3" json:"group,omitempty"` // name of the entity Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` Id uint32 `protobuf:"varint,3,opt,name=id,proto3" json:"id,omitempty"` // readonly. create_revision is the revision of last creation on this key. CreateRevision int64 `protobuf:"varint,4,opt,name=create_revision,json=createRevision,proto3" json:"create_revision,omitempty"` // readonly. mod_revision is the revision of last modification on this key. ModRevision int64 `protobuf:"varint,5,opt,name=mod_revision,json=modRevision,proto3" json:"mod_revision,omitempty"` // contains filtered or unexported fields }
Metadata is for multi-tenant, multi-model use
func (*Metadata) Descriptor
deprecated
func (*Metadata) GetCreateRevision ¶
func (*Metadata) GetModRevision ¶
func (*Metadata) ProtoMessage ¶
func (*Metadata) ProtoMessage()
func (*Metadata) ProtoReflect ¶
func (x *Metadata) ProtoReflect() protoreflect.Message
type ResourceOpts ¶
type ResourceOpts struct { // shard_num is the number of shards ShardNum uint32 `protobuf:"varint,1,opt,name=shard_num,json=shardNum,proto3" json:"shard_num,omitempty"` // block_num specific how many blocks in a segment BlockNum uint32 `protobuf:"varint,2,opt,name=block_num,json=blockNum,proto3" json:"block_num,omitempty"` // ttl indicates time to live, how long the data will be cached Ttl string `protobuf:"bytes,3,opt,name=ttl,proto3" json:"ttl,omitempty"` // contains filtered or unexported fields }
func (*ResourceOpts) Descriptor
deprecated
func (*ResourceOpts) Descriptor() ([]byte, []int)
Deprecated: Use ResourceOpts.ProtoReflect.Descriptor instead.
func (*ResourceOpts) GetBlockNum ¶
func (x *ResourceOpts) GetBlockNum() uint32
func (*ResourceOpts) GetShardNum ¶
func (x *ResourceOpts) GetShardNum() uint32
func (*ResourceOpts) GetTtl ¶
func (x *ResourceOpts) GetTtl() string
func (*ResourceOpts) ProtoMessage ¶
func (*ResourceOpts) ProtoMessage()
func (*ResourceOpts) ProtoReflect ¶
func (x *ResourceOpts) ProtoReflect() protoreflect.Message
func (*ResourceOpts) Reset ¶
func (x *ResourceOpts) Reset()
func (*ResourceOpts) String ¶
func (x *ResourceOpts) String() string
Click to show internal directories.
Click to hide internal directories.