Documentation ¶
Index ¶
- Variables
- type Column
- func (*Column) Descriptor() ([]byte, []int)deprecated
- func (x *Column) GetDynamic() bool
- func (x *Column) GetName() string
- func (x *Column) GetPrehash() bool
- func (x *Column) GetStorageLayout() *StorageLayout
- func (m *Column) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Column) MarshalToVT(dAtA []byte) (int, error)
- func (m *Column) MarshalVT() (dAtA []byte, err error)
- func (*Column) ProtoMessage()
- func (x *Column) ProtoReflect() protoreflect.Message
- func (x *Column) Reset()
- func (m *Column) SizeVT() (n int)
- func (x *Column) String() string
- func (m *Column) UnmarshalVT(dAtA []byte) error
- type Schema
- func (*Schema) Descriptor() ([]byte, []int)deprecated
- func (x *Schema) GetColumns() []*Column
- func (x *Schema) GetName() string
- func (x *Schema) GetSortingColumns() []*SortingColumn
- func (x *Schema) GetUniquePrimaryIndex() bool
- func (m *Schema) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Schema) MarshalToVT(dAtA []byte) (int, error)
- func (m *Schema) MarshalVT() (dAtA []byte, err error)
- func (*Schema) ProtoMessage()
- func (x *Schema) ProtoReflect() protoreflect.Message
- func (x *Schema) Reset()
- func (m *Schema) SizeVT() (n int)
- func (x *Schema) String() string
- func (m *Schema) UnmarshalVT(dAtA []byte) error
- type SortingColumn
- func (*SortingColumn) Descriptor() ([]byte, []int)deprecated
- func (x *SortingColumn) GetDirection() SortingColumn_Direction
- func (x *SortingColumn) GetName() string
- func (x *SortingColumn) GetNullsFirst() bool
- func (m *SortingColumn) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *SortingColumn) MarshalToVT(dAtA []byte) (int, error)
- func (m *SortingColumn) MarshalVT() (dAtA []byte, err error)
- func (*SortingColumn) ProtoMessage()
- func (x *SortingColumn) ProtoReflect() protoreflect.Message
- func (x *SortingColumn) Reset()
- func (m *SortingColumn) SizeVT() (n int)
- func (x *SortingColumn) String() string
- func (m *SortingColumn) UnmarshalVT(dAtA []byte) error
- type SortingColumn_Direction
- func (SortingColumn_Direction) Descriptor() protoreflect.EnumDescriptor
- func (x SortingColumn_Direction) Enum() *SortingColumn_Direction
- func (SortingColumn_Direction) EnumDescriptor() ([]byte, []int)deprecated
- func (x SortingColumn_Direction) Number() protoreflect.EnumNumber
- func (x SortingColumn_Direction) String() string
- func (SortingColumn_Direction) Type() protoreflect.EnumType
- type StorageLayout
- func (*StorageLayout) Descriptor() ([]byte, []int)deprecated
- func (x *StorageLayout) GetCompression() StorageLayout_Compression
- func (x *StorageLayout) GetEncoding() StorageLayout_Encoding
- func (x *StorageLayout) GetNullable() bool
- func (x *StorageLayout) GetRepeated() bool
- func (x *StorageLayout) GetType() StorageLayout_Type
- func (m *StorageLayout) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *StorageLayout) MarshalToVT(dAtA []byte) (int, error)
- func (m *StorageLayout) MarshalVT() (dAtA []byte, err error)
- func (*StorageLayout) ProtoMessage()
- func (x *StorageLayout) ProtoReflect() protoreflect.Message
- func (x *StorageLayout) Reset()
- func (m *StorageLayout) SizeVT() (n int)
- func (x *StorageLayout) String() string
- func (m *StorageLayout) UnmarshalVT(dAtA []byte) error
- type StorageLayout_Compression
- func (StorageLayout_Compression) Descriptor() protoreflect.EnumDescriptor
- func (x StorageLayout_Compression) Enum() *StorageLayout_Compression
- func (StorageLayout_Compression) EnumDescriptor() ([]byte, []int)deprecated
- func (x StorageLayout_Compression) Number() protoreflect.EnumNumber
- func (x StorageLayout_Compression) String() string
- func (StorageLayout_Compression) Type() protoreflect.EnumType
- type StorageLayout_Encoding
- func (StorageLayout_Encoding) Descriptor() protoreflect.EnumDescriptor
- func (x StorageLayout_Encoding) Enum() *StorageLayout_Encoding
- func (StorageLayout_Encoding) EnumDescriptor() ([]byte, []int)deprecated
- func (x StorageLayout_Encoding) Number() protoreflect.EnumNumber
- func (x StorageLayout_Encoding) String() string
- func (StorageLayout_Encoding) Type() protoreflect.EnumType
- type StorageLayout_Type
- func (StorageLayout_Type) Descriptor() protoreflect.EnumDescriptor
- func (x StorageLayout_Type) Enum() *StorageLayout_Type
- func (StorageLayout_Type) EnumDescriptor() ([]byte, []int)deprecated
- func (x StorageLayout_Type) Number() protoreflect.EnumNumber
- func (x StorageLayout_Type) String() string
- func (StorageLayout_Type) Type() protoreflect.EnumType
Constants ¶
This section is empty.
Variables ¶
var ( StorageLayout_Type_name = map[int32]string{ 0: "TYPE_UNKNOWN_UNSPECIFIED", 1: "TYPE_STRING", 2: "TYPE_INT64", 3: "TYPE_DOUBLE", 4: "TYPE_BOOL", 5: "TYPE_INT32", 6: "TYPE_UINT64", } StorageLayout_Type_value = map[string]int32{ "TYPE_UNKNOWN_UNSPECIFIED": 0, "TYPE_STRING": 1, "TYPE_INT64": 2, "TYPE_DOUBLE": 3, "TYPE_BOOL": 4, "TYPE_INT32": 5, "TYPE_UINT64": 6, } )
Enum value maps for StorageLayout_Type.
var ( StorageLayout_Encoding_name = map[int32]string{ 0: "ENCODING_PLAIN_UNSPECIFIED", 1: "ENCODING_RLE_DICTIONARY", 2: "ENCODING_DELTA_BINARY_PACKED", 3: "ENCODING_DELTA_BYTE_ARRAY", 4: "ENCODING_DELTA_LENGTH_BYTE_ARRAY", } StorageLayout_Encoding_value = map[string]int32{ "ENCODING_PLAIN_UNSPECIFIED": 0, "ENCODING_RLE_DICTIONARY": 1, "ENCODING_DELTA_BINARY_PACKED": 2, "ENCODING_DELTA_BYTE_ARRAY": 3, "ENCODING_DELTA_LENGTH_BYTE_ARRAY": 4, } )
Enum value maps for StorageLayout_Encoding.
var ( StorageLayout_Compression_name = map[int32]string{ 0: "COMPRESSION_NONE_UNSPECIFIED", 1: "COMPRESSION_SNAPPY", 2: "COMPRESSION_GZIP", 3: "COMPRESSION_BROTLI", 4: "COMPRESSION_LZ4_RAW", 5: "COMPRESSION_ZSTD", } StorageLayout_Compression_value = map[string]int32{ "COMPRESSION_NONE_UNSPECIFIED": 0, "COMPRESSION_SNAPPY": 1, "COMPRESSION_GZIP": 2, "COMPRESSION_BROTLI": 3, "COMPRESSION_LZ4_RAW": 4, "COMPRESSION_ZSTD": 5, } )
Enum value maps for StorageLayout_Compression.
var ( SortingColumn_Direction_name = map[int32]string{ 0: "DIRECTION_UNKNOWN_UNSPECIFIED", 1: "DIRECTION_ASCENDING", 2: "DIRECTION_DESCENDING", } SortingColumn_Direction_value = map[string]int32{ "DIRECTION_UNKNOWN_UNSPECIFIED": 0, "DIRECTION_ASCENDING": 1, "DIRECTION_DESCENDING": 2, } )
Enum value maps for SortingColumn_Direction.
var ( ErrInvalidLength = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflow = fmt.Errorf("proto: integer overflow") ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group") )
var File_frostdb_schema_v1alpha1_schema_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Column ¶
type Column struct { // Name of the column. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Storage layout of the column. StorageLayout *StorageLayout `protobuf:"bytes,2,opt,name=storage_layout,json=storageLayout,proto3" json:"storage_layout,omitempty"` // Whether the column can dynamically expand. Dynamic bool `protobuf:"varint,3,opt,name=dynamic,proto3" json:"dynamic,omitempty"` // Prehash the column before storing it. This is an optimization to speed up aggregation queries when this column is often aggregated. // This will create a separate non-dynamic column with the same name and the prefix "hashed." that contains the prehashed values. Prehash bool `protobuf:"varint,4,opt,name=prehash,proto3" json:"prehash,omitempty"` // contains filtered or unexported fields }
Column definition.
func (*Column) Descriptor
deprecated
func (*Column) GetDynamic ¶
func (*Column) GetPrehash ¶
func (*Column) GetStorageLayout ¶
func (x *Column) GetStorageLayout() *StorageLayout
func (*Column) MarshalToSizedBufferVT ¶
func (*Column) ProtoMessage ¶
func (*Column) ProtoMessage()
func (*Column) ProtoReflect ¶
func (x *Column) ProtoReflect() protoreflect.Message
func (*Column) UnmarshalVT ¶
type Schema ¶
type Schema struct { // Name of the schema. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Columns in the schema. Columns []*Column `protobuf:"bytes,2,rep,name=columns,proto3" json:"columns,omitempty"` // Columns to sort by in the schema. SortingColumns []*SortingColumn `protobuf:"bytes,3,rep,name=sorting_columns,json=sortingColumns,proto3" json:"sorting_columns,omitempty"` // UniquePrimaryIndex defines whether the primary index is unique. Duplicate // (according to the sorting column) rows will be dropped on compaction. UniquePrimaryIndex bool `protobuf:"varint,4,opt,name=unique_primary_index,json=uniquePrimaryIndex,proto3" json:"unique_primary_index,omitempty"` // contains filtered or unexported fields }
Schema definition for a table.
func (*Schema) Descriptor
deprecated
func (*Schema) GetColumns ¶
func (*Schema) GetSortingColumns ¶
func (x *Schema) GetSortingColumns() []*SortingColumn
func (*Schema) GetUniquePrimaryIndex ¶
func (*Schema) MarshalToSizedBufferVT ¶
func (*Schema) ProtoMessage ¶
func (*Schema) ProtoMessage()
func (*Schema) ProtoReflect ¶
func (x *Schema) ProtoReflect() protoreflect.Message
func (*Schema) UnmarshalVT ¶
type SortingColumn ¶
type SortingColumn struct { // Name of the column to sort by. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Direction of the sorting. Direction SortingColumn_Direction `protobuf:"varint,2,opt,name=direction,proto3,enum=frostdb.schema.v1alpha1.SortingColumn_Direction" json:"direction,omitempty"` // Whether nulls are the smallest or largest values. NullsFirst bool `protobuf:"varint,3,opt,name=nulls_first,json=nullsFirst,proto3" json:"nulls_first,omitempty"` // contains filtered or unexported fields }
SortingColumn definition.
func (*SortingColumn) Descriptor
deprecated
func (*SortingColumn) Descriptor() ([]byte, []int)
Deprecated: Use SortingColumn.ProtoReflect.Descriptor instead.
func (*SortingColumn) GetDirection ¶
func (x *SortingColumn) GetDirection() SortingColumn_Direction
func (*SortingColumn) GetName ¶
func (x *SortingColumn) GetName() string
func (*SortingColumn) GetNullsFirst ¶
func (x *SortingColumn) GetNullsFirst() bool
func (*SortingColumn) MarshalToSizedBufferVT ¶
func (m *SortingColumn) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*SortingColumn) MarshalToVT ¶
func (m *SortingColumn) MarshalToVT(dAtA []byte) (int, error)
func (*SortingColumn) MarshalVT ¶
func (m *SortingColumn) MarshalVT() (dAtA []byte, err error)
func (*SortingColumn) ProtoMessage ¶
func (*SortingColumn) ProtoMessage()
func (*SortingColumn) ProtoReflect ¶
func (x *SortingColumn) ProtoReflect() protoreflect.Message
func (*SortingColumn) Reset ¶
func (x *SortingColumn) Reset()
func (*SortingColumn) SizeVT ¶
func (m *SortingColumn) SizeVT() (n int)
func (*SortingColumn) String ¶
func (x *SortingColumn) String() string
func (*SortingColumn) UnmarshalVT ¶
func (m *SortingColumn) UnmarshalVT(dAtA []byte) error
type SortingColumn_Direction ¶
type SortingColumn_Direction int32
Enum of possible sorting directions.
const ( // Unknown direction. SortingColumn_DIRECTION_UNKNOWN_UNSPECIFIED SortingColumn_Direction = 0 // Sort in ascending order. SortingColumn_DIRECTION_ASCENDING SortingColumn_Direction = 1 // Sort in descending order. SortingColumn_DIRECTION_DESCENDING SortingColumn_Direction = 2 )
func (SortingColumn_Direction) Descriptor ¶
func (SortingColumn_Direction) Descriptor() protoreflect.EnumDescriptor
func (SortingColumn_Direction) Enum ¶
func (x SortingColumn_Direction) Enum() *SortingColumn_Direction
func (SortingColumn_Direction) EnumDescriptor
deprecated
func (SortingColumn_Direction) EnumDescriptor() ([]byte, []int)
Deprecated: Use SortingColumn_Direction.Descriptor instead.
func (SortingColumn_Direction) Number ¶
func (x SortingColumn_Direction) Number() protoreflect.EnumNumber
func (SortingColumn_Direction) String ¶
func (x SortingColumn_Direction) String() string
func (SortingColumn_Direction) Type ¶
func (SortingColumn_Direction) Type() protoreflect.EnumType
type StorageLayout ¶
type StorageLayout struct { // Type of the column. Type StorageLayout_Type `protobuf:"varint,1,opt,name=type,proto3,enum=frostdb.schema.v1alpha1.StorageLayout_Type" json:"type,omitempty"` // Encoding of the column. Encoding StorageLayout_Encoding `protobuf:"varint,2,opt,name=encoding,proto3,enum=frostdb.schema.v1alpha1.StorageLayout_Encoding" json:"encoding,omitempty"` // Compression of the column. Compression StorageLayout_Compression `` /* 131-byte string literal not displayed */ // Wether values in the column are allowed to be null. Nullable bool `protobuf:"varint,4,opt,name=nullable,proto3" json:"nullable,omitempty"` // Whether the column is repeated. Repeated bool `protobuf:"varint,5,opt,name=repeated,proto3" json:"repeated,omitempty"` // contains filtered or unexported fields }
Storage layout describes the physical storage properties of a column.
func (*StorageLayout) Descriptor
deprecated
func (*StorageLayout) Descriptor() ([]byte, []int)
Deprecated: Use StorageLayout.ProtoReflect.Descriptor instead.
func (*StorageLayout) GetCompression ¶
func (x *StorageLayout) GetCompression() StorageLayout_Compression
func (*StorageLayout) GetEncoding ¶
func (x *StorageLayout) GetEncoding() StorageLayout_Encoding
func (*StorageLayout) GetNullable ¶
func (x *StorageLayout) GetNullable() bool
func (*StorageLayout) GetRepeated ¶
func (x *StorageLayout) GetRepeated() bool
func (*StorageLayout) GetType ¶
func (x *StorageLayout) GetType() StorageLayout_Type
func (*StorageLayout) MarshalToSizedBufferVT ¶
func (m *StorageLayout) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*StorageLayout) MarshalToVT ¶
func (m *StorageLayout) MarshalToVT(dAtA []byte) (int, error)
func (*StorageLayout) MarshalVT ¶
func (m *StorageLayout) MarshalVT() (dAtA []byte, err error)
func (*StorageLayout) ProtoMessage ¶
func (*StorageLayout) ProtoMessage()
func (*StorageLayout) ProtoReflect ¶
func (x *StorageLayout) ProtoReflect() protoreflect.Message
func (*StorageLayout) Reset ¶
func (x *StorageLayout) Reset()
func (*StorageLayout) SizeVT ¶
func (m *StorageLayout) SizeVT() (n int)
func (*StorageLayout) String ¶
func (x *StorageLayout) String() string
func (*StorageLayout) UnmarshalVT ¶
func (m *StorageLayout) UnmarshalVT(dAtA []byte) error
type StorageLayout_Compression ¶
type StorageLayout_Compression int32
Compression enum of a column.
const ( // No compression. StorageLayout_COMPRESSION_NONE_UNSPECIFIED StorageLayout_Compression = 0 // Snappy compression. StorageLayout_COMPRESSION_SNAPPY StorageLayout_Compression = 1 // GZIP compression. StorageLayout_COMPRESSION_GZIP StorageLayout_Compression = 2 // Brotli compression. StorageLayout_COMPRESSION_BROTLI StorageLayout_Compression = 3 // LZ4_RAW compression. StorageLayout_COMPRESSION_LZ4_RAW StorageLayout_Compression = 4 // ZSTD compression. StorageLayout_COMPRESSION_ZSTD StorageLayout_Compression = 5 )
func (StorageLayout_Compression) Descriptor ¶
func (StorageLayout_Compression) Descriptor() protoreflect.EnumDescriptor
func (StorageLayout_Compression) Enum ¶
func (x StorageLayout_Compression) Enum() *StorageLayout_Compression
func (StorageLayout_Compression) EnumDescriptor
deprecated
func (StorageLayout_Compression) EnumDescriptor() ([]byte, []int)
Deprecated: Use StorageLayout_Compression.Descriptor instead.
func (StorageLayout_Compression) Number ¶
func (x StorageLayout_Compression) Number() protoreflect.EnumNumber
func (StorageLayout_Compression) String ¶
func (x StorageLayout_Compression) String() string
func (StorageLayout_Compression) Type ¶
func (StorageLayout_Compression) Type() protoreflect.EnumType
type StorageLayout_Encoding ¶
type StorageLayout_Encoding int32
Encoding enum of a column.
const ( // Plain encoding. StorageLayout_ENCODING_PLAIN_UNSPECIFIED StorageLayout_Encoding = 0 // Dictionary run-length encoding. StorageLayout_ENCODING_RLE_DICTIONARY StorageLayout_Encoding = 1 // Delta binary packed encoding. StorageLayout_ENCODING_DELTA_BINARY_PACKED StorageLayout_Encoding = 2 // Delta Byte Array encoding. StorageLayout_ENCODING_DELTA_BYTE_ARRAY StorageLayout_Encoding = 3 // Delta Length Byte Array encoding. StorageLayout_ENCODING_DELTA_LENGTH_BYTE_ARRAY StorageLayout_Encoding = 4 )
func (StorageLayout_Encoding) Descriptor ¶
func (StorageLayout_Encoding) Descriptor() protoreflect.EnumDescriptor
func (StorageLayout_Encoding) Enum ¶
func (x StorageLayout_Encoding) Enum() *StorageLayout_Encoding
func (StorageLayout_Encoding) EnumDescriptor
deprecated
func (StorageLayout_Encoding) EnumDescriptor() ([]byte, []int)
Deprecated: Use StorageLayout_Encoding.Descriptor instead.
func (StorageLayout_Encoding) Number ¶
func (x StorageLayout_Encoding) Number() protoreflect.EnumNumber
func (StorageLayout_Encoding) String ¶
func (x StorageLayout_Encoding) String() string
func (StorageLayout_Encoding) Type ¶
func (StorageLayout_Encoding) Type() protoreflect.EnumType
type StorageLayout_Type ¶
type StorageLayout_Type int32
Type enum of a column.
const ( // Unknown type. StorageLayout_TYPE_UNKNOWN_UNSPECIFIED StorageLayout_Type = 0 // Represents a string type. StorageLayout_TYPE_STRING StorageLayout_Type = 1 // Represents an int64 type. StorageLayout_TYPE_INT64 StorageLayout_Type = 2 // Represents a double type. StorageLayout_TYPE_DOUBLE StorageLayout_Type = 3 // Represents a boolean type. StorageLayout_TYPE_BOOL StorageLayout_Type = 4 // Represents a int32 type. StorageLayout_TYPE_INT32 StorageLayout_Type = 5 // Represents a uint64 type. StorageLayout_TYPE_UINT64 StorageLayout_Type = 6 )
func (StorageLayout_Type) Descriptor ¶
func (StorageLayout_Type) Descriptor() protoreflect.EnumDescriptor
func (StorageLayout_Type) Enum ¶
func (x StorageLayout_Type) Enum() *StorageLayout_Type
func (StorageLayout_Type) EnumDescriptor
deprecated
func (StorageLayout_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use StorageLayout_Type.Descriptor instead.
func (StorageLayout_Type) Number ¶
func (x StorageLayout_Type) Number() protoreflect.EnumNumber
func (StorageLayout_Type) String ¶
func (x StorageLayout_Type) String() string
func (StorageLayout_Type) Type ¶
func (StorageLayout_Type) Type() protoreflect.EnumType