package schemav1alpha1

Import Path
	github.com/polarsignals/frostdb/gen/proto/go/frostdb/schema/v1alpha1 (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 5 packages

Involved Source Files

	    schema.pb.go
	    schema_vtproto.pb.go
Package-Level Type Names (total 8)

	/* sort by: alphabet | popularity */
	 type Column (struct)
		Column definition.

		Fields (total 4)
			Dynamic bool
				Whether the column can dynamically expand.

			Name string
				Name of the column.

			Prehash bool
				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.

			StorageLayout *StorageLayout
				Storage layout of the column.

		Methods (total 14)
			(*Column) Descriptor() ([]byte, []int)
				Deprecated: Use Column.ProtoReflect.Descriptor instead.

			(*Column) GetDynamic() bool
			(*Column) GetName() string
			(*Column) GetPrehash() bool
			(*Column) GetStorageLayout() *StorageLayout
			(*Column) MarshalToSizedBufferVT(dAtA []byte) (int, error)
			(*Column) MarshalToVT(dAtA []byte) (int, error)
			(*Column) MarshalVT() (dAtA []byte, err error)
			(*Column) ProtoMessage()
			(*Column) ProtoReflect() protoreflect.Message
			(*Column) Reset()
			(*Column) SizeVT() (n int)
			(*Column) String() string
			(*Column) UnmarshalVT(dAtA []byte) error
		Implements (at least 5)
			*Column : github.com/gogo/protobuf/proto.Message
			*Column : expvar.Var
			*Column : fmt.Stringer
			*Column : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Column : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*Schema).GetColumns() []*Column

	 type Schema (struct)
		Schema definition for a table.

		Fields (total 4)
			Columns []*Column
				Columns in the schema.

			Name string
				Name of the schema.

			SortingColumns []*SortingColumn
				Columns to sort by in the schema.

			UniquePrimaryIndex bool
				UniquePrimaryIndex defines whether the primary index is unique. Duplicate
				(according to the sorting column) rows will be dropped on compaction.

		Methods (total 14)
			(*Schema) Descriptor() ([]byte, []int)
				Deprecated: Use Schema.ProtoReflect.Descriptor instead.

			(*Schema) GetColumns() []*Column
			(*Schema) GetName() string
			(*Schema) GetSortingColumns() []*SortingColumn
			(*Schema) GetUniquePrimaryIndex() bool
			(*Schema) MarshalToSizedBufferVT(dAtA []byte) (int, error)
			(*Schema) MarshalToVT(dAtA []byte) (int, error)
			(*Schema) MarshalVT() (dAtA []byte, err error)
			(*Schema) ProtoMessage()
			(*Schema) ProtoReflect() protoreflect.Message
			(*Schema) Reset()
			(*Schema) SizeVT() (n int)
			(*Schema) String() string
			(*Schema) UnmarshalVT(dAtA []byte) error
		Implements (at least 5)
			*Schema : github.com/gogo/protobuf/proto.Message
			*Schema : expvar.Var
			*Schema : fmt.Stringer
			*Schema : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Schema : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least 6)
			func github.com/polarsignals/frostdb/gen/proto/go/frostdb/table/v1alpha1.(*TableConfig).GetDeprecatedSchema() *Schema
			func github.com/polarsignals/frostdb/dynparquet.DefinitionFromParquetFile(file *parquet.File) (*Schema, error)
			func github.com/polarsignals/frostdb/internal/records.Build[T].Schema(name string) (s *Schema)
			func github.com/polarsignals/frostdb/samples.PrehashedSampleDefinition() *Schema
			func github.com/polarsignals/frostdb/samples.SampleDefinition() *Schema
			func github.com/polarsignals/frostdb/samples.SampleDefinitionWithFloat() *Schema

	 type SortingColumn (struct)
		SortingColumn definition.

		Fields (total 3)
			Direction SortingColumn_Direction
				Direction of the sorting.

			Name string
				Name of the column to sort by.

			NullsFirst bool
				Whether nulls are the smallest or largest values.

		Methods (total 13)
			(*SortingColumn) Descriptor() ([]byte, []int)
				Deprecated: Use SortingColumn.ProtoReflect.Descriptor instead.

			(*SortingColumn) GetDirection() SortingColumn_Direction
			(*SortingColumn) GetName() string
			(*SortingColumn) GetNullsFirst() bool
			(*SortingColumn) MarshalToSizedBufferVT(dAtA []byte) (int, error)
			(*SortingColumn) MarshalToVT(dAtA []byte) (int, error)
			(*SortingColumn) MarshalVT() (dAtA []byte, err error)
			(*SortingColumn) ProtoMessage()
			(*SortingColumn) ProtoReflect() protoreflect.Message
			(*SortingColumn) Reset()
			(*SortingColumn) SizeVT() (n int)
			(*SortingColumn) String() string
			(*SortingColumn) UnmarshalVT(dAtA []byte) error
		Implements (at least 5)
			*SortingColumn : github.com/gogo/protobuf/proto.Message
			*SortingColumn : expvar.Var
			*SortingColumn : fmt.Stringer
			*SortingColumn : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*SortingColumn : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*Schema).GetSortingColumns() []*SortingColumn

	 type SortingColumn_Direction int32 (basic type)
		Enum of possible sorting directions.

		Methods (total 6)
			( SortingColumn_Direction) Descriptor() protoreflect.EnumDescriptor
			( SortingColumn_Direction) Enum() *SortingColumn_Direction
			( SortingColumn_Direction) EnumDescriptor() ([]byte, []int)
				Deprecated: Use SortingColumn_Direction.Descriptor instead.

			( SortingColumn_Direction) Number() protoreflect.EnumNumber
			( SortingColumn_Direction) String() string
			( SortingColumn_Direction) Type() protoreflect.EnumType
		Implements (at least 3)
			 SortingColumn_Direction : expvar.Var
			 SortingColumn_Direction : fmt.Stringer
			 SortingColumn_Direction : google.golang.org/protobuf/reflect/protoreflect.Enum
		As Outputs Of (at least 2)
			func (*SortingColumn).GetDirection() SortingColumn_Direction
			func SortingColumn_Direction.Enum() *SortingColumn_Direction
		As Types Of (total 3)
			const SortingColumn_DIRECTION_ASCENDING
			const SortingColumn_DIRECTION_DESCENDING
			const SortingColumn_DIRECTION_UNKNOWN_UNSPECIFIED

	 type StorageLayout (struct)
		Storage layout describes the physical storage properties of a column.

		Fields (total 5)
			Compression StorageLayout_Compression
				Compression of the column.

			Encoding StorageLayout_Encoding
				Encoding of the column.

			Nullable bool
				Wether values in the column are allowed to be null.

			Repeated bool
				Whether the column is repeated.

			Type StorageLayout_Type
				Type of the column.

		Methods (total 15)
			(*StorageLayout) Descriptor() ([]byte, []int)
				Deprecated: Use StorageLayout.ProtoReflect.Descriptor instead.

			(*StorageLayout) GetCompression() StorageLayout_Compression
			(*StorageLayout) GetEncoding() StorageLayout_Encoding
			(*StorageLayout) GetNullable() bool
			(*StorageLayout) GetRepeated() bool
			(*StorageLayout) GetType() StorageLayout_Type
			(*StorageLayout) MarshalToSizedBufferVT(dAtA []byte) (int, error)
			(*StorageLayout) MarshalToVT(dAtA []byte) (int, error)
			(*StorageLayout) MarshalVT() (dAtA []byte, err error)
			(*StorageLayout) ProtoMessage()
			(*StorageLayout) ProtoReflect() protoreflect.Message
			(*StorageLayout) Reset()
			(*StorageLayout) SizeVT() (n int)
			(*StorageLayout) String() string
			(*StorageLayout) UnmarshalVT(dAtA []byte) error
		Implements (at least 5)
			*StorageLayout : github.com/gogo/protobuf/proto.Message
			*StorageLayout : expvar.Var
			*StorageLayout : fmt.Stringer
			*StorageLayout : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*StorageLayout : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*Column).GetStorageLayout() *StorageLayout

	 type StorageLayout_Compression int32 (basic type)
		Compression enum of a column.

		Methods (total 6)
			( StorageLayout_Compression) Descriptor() protoreflect.EnumDescriptor
			( StorageLayout_Compression) Enum() *StorageLayout_Compression
			( StorageLayout_Compression) EnumDescriptor() ([]byte, []int)
				Deprecated: Use StorageLayout_Compression.Descriptor instead.

			( StorageLayout_Compression) Number() protoreflect.EnumNumber
			( StorageLayout_Compression) String() string
			( StorageLayout_Compression) Type() protoreflect.EnumType
		Implements (at least 3)
			 StorageLayout_Compression : expvar.Var
			 StorageLayout_Compression : fmt.Stringer
			 StorageLayout_Compression : google.golang.org/protobuf/reflect/protoreflect.Enum
		As Outputs Of (at least 2)
			func (*StorageLayout).GetCompression() StorageLayout_Compression
			func StorageLayout_Compression.Enum() *StorageLayout_Compression
		As Types Of (total 6)
			const StorageLayout_COMPRESSION_BROTLI
			const StorageLayout_COMPRESSION_GZIP
			const StorageLayout_COMPRESSION_LZ4_RAW
			const StorageLayout_COMPRESSION_NONE_UNSPECIFIED
			const StorageLayout_COMPRESSION_SNAPPY
			const StorageLayout_COMPRESSION_ZSTD

	 type StorageLayout_Encoding int32 (basic type)
		Encoding enum of a column.

		Methods (total 6)
			( StorageLayout_Encoding) Descriptor() protoreflect.EnumDescriptor
			( StorageLayout_Encoding) Enum() *StorageLayout_Encoding
			( StorageLayout_Encoding) EnumDescriptor() ([]byte, []int)
				Deprecated: Use StorageLayout_Encoding.Descriptor instead.

			( StorageLayout_Encoding) Number() protoreflect.EnumNumber
			( StorageLayout_Encoding) String() string
			( StorageLayout_Encoding) Type() protoreflect.EnumType
		Implements (at least 3)
			 StorageLayout_Encoding : expvar.Var
			 StorageLayout_Encoding : fmt.Stringer
			 StorageLayout_Encoding : google.golang.org/protobuf/reflect/protoreflect.Enum
		As Outputs Of (at least 2)
			func (*StorageLayout).GetEncoding() StorageLayout_Encoding
			func StorageLayout_Encoding.Enum() *StorageLayout_Encoding
		As Types Of (total 5)
			const StorageLayout_ENCODING_DELTA_BINARY_PACKED
			const StorageLayout_ENCODING_DELTA_BYTE_ARRAY
			const StorageLayout_ENCODING_DELTA_LENGTH_BYTE_ARRAY
			const StorageLayout_ENCODING_PLAIN_UNSPECIFIED
			const StorageLayout_ENCODING_RLE_DICTIONARY

	 type StorageLayout_Type int32 (basic type)
		Type enum of a column.

		Methods (total 6)
			( StorageLayout_Type) Descriptor() protoreflect.EnumDescriptor
			( StorageLayout_Type) Enum() *StorageLayout_Type
			( StorageLayout_Type) EnumDescriptor() ([]byte, []int)
				Deprecated: Use StorageLayout_Type.Descriptor instead.

			( StorageLayout_Type) Number() protoreflect.EnumNumber
			( StorageLayout_Type) String() string
			( StorageLayout_Type) Type() protoreflect.EnumType
		Implements (at least 3)
			 StorageLayout_Type : expvar.Var
			 StorageLayout_Type : fmt.Stringer
			 StorageLayout_Type : google.golang.org/protobuf/reflect/protoreflect.Enum
		As Outputs Of (at least 2)
			func (*StorageLayout).GetType() StorageLayout_Type
			func StorageLayout_Type.Enum() *StorageLayout_Type
		As Types Of (total 7)
			const StorageLayout_TYPE_BOOL
			const StorageLayout_TYPE_DOUBLE
			const StorageLayout_TYPE_INT32
			const StorageLayout_TYPE_INT64
			const StorageLayout_TYPE_STRING
			const StorageLayout_TYPE_UINT64
			const StorageLayout_TYPE_UNKNOWN_UNSPECIFIED


Package-Level Variables (total 9)

	  var File_frostdb_schema_v1alpha1_schema_proto protoreflect.FileDescriptor
	  var SortingColumn_Direction_name map[int32]string
		Enum value maps for SortingColumn_Direction.

	  var SortingColumn_Direction_value map[string]int32
		Enum value maps for SortingColumn_Direction.

	  var StorageLayout_Compression_name map[int32]string
		Enum value maps for StorageLayout_Compression.

	  var StorageLayout_Compression_value map[string]int32
		Enum value maps for StorageLayout_Compression.

	  var StorageLayout_Encoding_name map[int32]string
		Enum value maps for StorageLayout_Encoding.

	  var StorageLayout_Encoding_value map[string]int32
		Enum value maps for StorageLayout_Encoding.

	  var StorageLayout_Type_name map[int32]string
		Enum value maps for StorageLayout_Type.

	  var StorageLayout_Type_value map[string]int32
		Enum value maps for StorageLayout_Type.


Package-Level Constants (total 21)

	const SortingColumn_DIRECTION_ASCENDING SortingColumn_Direction = 1
		Sort in ascending order.

	const SortingColumn_DIRECTION_DESCENDING SortingColumn_Direction = 2
		Sort in descending order.

	const SortingColumn_DIRECTION_UNKNOWN_UNSPECIFIED SortingColumn_Direction = 0
		Unknown direction.

	const StorageLayout_COMPRESSION_BROTLI StorageLayout_Compression = 3
		Brotli compression.

	const StorageLayout_COMPRESSION_GZIP StorageLayout_Compression = 2
		GZIP compression.

	const StorageLayout_COMPRESSION_LZ4_RAW StorageLayout_Compression = 4
		LZ4_RAW compression.

	const StorageLayout_COMPRESSION_NONE_UNSPECIFIED StorageLayout_Compression = 0
		No compression.

	const StorageLayout_COMPRESSION_SNAPPY StorageLayout_Compression = 1
		Snappy compression.

	const StorageLayout_COMPRESSION_ZSTD StorageLayout_Compression = 5
		ZSTD compression.

	const StorageLayout_ENCODING_DELTA_BINARY_PACKED StorageLayout_Encoding = 2
		Delta binary packed encoding.

	const StorageLayout_ENCODING_DELTA_BYTE_ARRAY StorageLayout_Encoding = 3
		Delta Byte Array encoding.

	const StorageLayout_ENCODING_DELTA_LENGTH_BYTE_ARRAY StorageLayout_Encoding = 4
		Delta Length Byte Array encoding.

	const StorageLayout_ENCODING_PLAIN_UNSPECIFIED StorageLayout_Encoding = 0
		Plain encoding.

	const StorageLayout_ENCODING_RLE_DICTIONARY StorageLayout_Encoding = 1
		Dictionary run-length encoding.

	const StorageLayout_TYPE_BOOL StorageLayout_Type = 4
		Represents a boolean type.

	const StorageLayout_TYPE_DOUBLE StorageLayout_Type = 3
		Represents a double type.

	const StorageLayout_TYPE_INT32 StorageLayout_Type = 5
		Represents a int32 type.

	const StorageLayout_TYPE_INT64 StorageLayout_Type = 2
		Represents an int64 type.

	const StorageLayout_TYPE_STRING StorageLayout_Type = 1
		Represents a string type.

	const StorageLayout_TYPE_UINT64 StorageLayout_Type = 6
		Represents a uint64 type.

	const StorageLayout_TYPE_UNKNOWN_UNSPECIFIED StorageLayout_Type = 0
		Unknown type.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.