package snapshotv1alpha1

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

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	    snapshot.pb.go
	    snapshot_vtproto.pb.go
Package-Level Type Names (total 6)

	/* sort by: alphabet | popularity */
	 type FooterData (struct)
		FooterData is a message stored in the footer of a snapshot file that encodes
		data about the rest of the file.

		Fields (only one)
			TableMetadata []*Table
				table_metadata is a list of all tables in the snapshot.

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

			(*FooterData) GetTableMetadata() []*Table
			(*FooterData) MarshalToSizedBufferVT(dAtA []byte) (int, error)
			(*FooterData) MarshalToVT(dAtA []byte) (int, error)
			(*FooterData) MarshalVT() (dAtA []byte, err error)
			(*FooterData) ProtoMessage()
			(*FooterData) ProtoReflect() protoreflect.Message
			(*FooterData) Reset()
			(*FooterData) SizeVT() (n int)
			(*FooterData) String() string
			(*FooterData) UnmarshalVT(dAtA []byte) error
		Implements (at least 5)
			*FooterData : github.com/gogo/protobuf/proto.Message
			*FooterData : expvar.Var
			*FooterData : fmt.Stringer
			*FooterData : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*FooterData : google.golang.org/protobuf/runtime/protoiface.MessageV1

	 type Granule (struct)
		Granule encodes metadata about a granule in a table.

		Fields (only one)
			PartMetadata []*Part
				part_metadata is a list of all parts in the granule.

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

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

	 type Part (struct)
		Part encodes metadata about a part in a granule.

		Fields (total 5)
			CompactionLevel uint64
				compaction_level is the compaction level of the part.

			Encoding Part_Encoding
				encoding is the actual encoding of the part.

			EndOffset int64
				end_offset is the end offset of the part.

			StartOffset int64
				start_offset is the start offset of the part.

			Tx uint64
				tx is the transaction id of the part.

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

			(*Part) GetCompactionLevel() uint64
			(*Part) GetEncoding() Part_Encoding
			(*Part) GetEndOffset() int64
			(*Part) GetStartOffset() int64
			(*Part) GetTx() uint64
			(*Part) MarshalToSizedBufferVT(dAtA []byte) (int, error)
			(*Part) MarshalToVT(dAtA []byte) (int, error)
			(*Part) MarshalVT() (dAtA []byte, err error)
			(*Part) ProtoMessage()
			(*Part) ProtoReflect() protoreflect.Message
			(*Part) Reset()
			(*Part) SizeVT() (n int)
			(*Part) String() string
			(*Part) UnmarshalVT(dAtA []byte) error
		Implements (at least 5)
			*Part : github.com/gogo/protobuf/proto.Message
			*Part : expvar.Var
			*Part : fmt.Stringer
			*Part : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Part : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*Granule).GetPartMetadata() []*Part

	 type Part_Encoding int32 (basic type)
		Encoding is a enum of possible encodings of the part.

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

			( Part_Encoding) Number() protoreflect.EnumNumber
			( Part_Encoding) String() string
			( Part_Encoding) Type() protoreflect.EnumType
		Implements (at least 3)
			 Part_Encoding : expvar.Var
			 Part_Encoding : fmt.Stringer
			 Part_Encoding : google.golang.org/protobuf/reflect/protoreflect.Enum
		As Outputs Of (at least 2)
			func (*Part).GetEncoding() Part_Encoding
			func Part_Encoding.Enum() *Part_Encoding
		As Types Of (total 3)
			const Part_ENCODING_ARROW
			const Part_ENCODING_PARQUET
			const Part_ENCODING_UNSPECIFIED

	 type Table (struct)
		Table encodes metadata about a table in a snapshot.

		Fields (total 4)
			ActiveBlock *Table_TableBlock
				active_block is the active block of the table.

			Config *v1alpha1.TableConfig
				config is the configuration of the table.

			GranuleMetadata []*Granule
				granule_metadata is a list of all granules in the table.

			Name string
				name of the table.

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

			(*Table) GetActiveBlock() *Table_TableBlock
			(*Table) GetConfig() *v1alpha1.TableConfig
			(*Table) GetGranuleMetadata() []*Granule
			(*Table) GetName() string
			(*Table) MarshalToSizedBufferVT(dAtA []byte) (int, error)
			(*Table) MarshalToVT(dAtA []byte) (int, error)
			(*Table) MarshalVT() (dAtA []byte, err error)
			(*Table) ProtoMessage()
			(*Table) ProtoReflect() protoreflect.Message
			(*Table) Reset()
			(*Table) SizeVT() (n int)
			(*Table) String() string
			(*Table) UnmarshalVT(dAtA []byte) error
		Implements (at least 5)
			*Table : github.com/gogo/protobuf/proto.Message
			*Table : expvar.Var
			*Table : fmt.Stringer
			*Table : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Table : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*FooterData).GetTableMetadata() []*Table

	 type Table_TableBlock (struct)
		TableBlock

		Fields (total 4)
			MinTx uint64
				min_tx is the minimum transaction id in the block.

			PrevTx uint64
				prev_tx is the transaction id of the previous block.

			Size int64
				size is the size of the block in bytes.

			Ulid []byte
				ulid is the unique identifier of the block.

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

			(*Table_TableBlock) GetMinTx() uint64
			(*Table_TableBlock) GetPrevTx() uint64
			(*Table_TableBlock) GetSize() int64
			(*Table_TableBlock) GetUlid() []byte
			(*Table_TableBlock) MarshalToSizedBufferVT(dAtA []byte) (int, error)
			(*Table_TableBlock) MarshalToVT(dAtA []byte) (int, error)
			(*Table_TableBlock) MarshalVT() (dAtA []byte, err error)
			(*Table_TableBlock) ProtoMessage()
			(*Table_TableBlock) ProtoReflect() protoreflect.Message
			(*Table_TableBlock) Reset()
			(*Table_TableBlock) SizeVT() (n int)
			(*Table_TableBlock) String() string
			(*Table_TableBlock) UnmarshalVT(dAtA []byte) error
		Implements (at least 5)
			*Table_TableBlock : github.com/gogo/protobuf/proto.Message
			*Table_TableBlock : expvar.Var
			*Table_TableBlock : fmt.Stringer
			*Table_TableBlock : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Table_TableBlock : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*Table).GetActiveBlock() *Table_TableBlock


Package-Level Variables (total 3)

	  var File_frostdb_snapshot_v1alpha1_snapshot_proto protoreflect.FileDescriptor
	  var Part_Encoding_name map[int32]string
		Enum value maps for Part_Encoding.

	  var Part_Encoding_value map[string]int32
		Enum value maps for Part_Encoding.


Package-Level Constants (total 3)

	const Part_ENCODING_ARROW Part_Encoding = 2
		ENCODING_ARROW is an arrow encoding.

	const Part_ENCODING_PARQUET Part_Encoding = 1
		ENCODING_PARQUET is a parquet encoding.

	const Part_ENCODING_UNSPECIFIED Part_Encoding = 0
		ENCODING_UNSPECIFIED is an unknown encoding.

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.