datasetmd

type ColumnDesc struct {
	// Type holds the type of data in the column.
	Type *ColumnType `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Tag is an optional string that can be used to distinguish between
	// different columns with the same type.
	//
	// For example, there may be two columns with the type (uint64.timestamp)
	// but with different tags ("start_time" and "end_time").
	//
	// Columns are uniquely named based on the combination of their type and
	// optional tag, separated by a "/" when a tag is present:
	//
	//   - uint64.timestamp/start_time
	//   - uint64.timestamp/end_time
	//   - uint64.stream_id (no tag)
	//
	// The tag string can be retrieved from the dictionary field in
	// SectionMetadata, using the tag_ref value as the index.
	TagRef uint32 `protobuf:"varint,2,opt,name=tag_ref,json=tagRef,proto3" json:"tag_ref,omitempty"`
	// Total number of pages in the column.
	PagesCount uint64 `protobuf:"varint,3,opt,name=pages_count,json=pagesCount,proto3" json:"pages_count,omitempty"`
	// Total number of rows (values + nulls) in the column across all pages.
	RowsCount uint64 `protobuf:"varint,4,opt,name=rows_count,json=rowsCount,proto3" json:"rows_count,omitempty"`
	// Total number of non-NULL values in this column across all pages. The
	// number of NULL values is rows_count - values_count.
	ValuesCount uint64 `protobuf:"varint,5,opt,name=values_count,json=valuesCount,proto3" json:"values_count,omitempty"`
	// Compression type used for all pages.
	Compression CompressionType `protobuf:"varint,6,opt,name=compression,proto3,enum=dataobj.metadata.dataset.v2.CompressionType" json:"compression,omitempty"`
	// Total uncompressed size of all pages in the column in bytes.
	UncompressedSize uint64 `protobuf:"varint,7,opt,name=uncompressed_size,json=uncompressedSize,proto3" json:"uncompressed_size,omitempty"`
	// Total compressed size of all pages in the column. If no compression is
	// used, compressed_size matches uncompressed_size.
	CompressedSize uint64 `protobuf:"varint,8,opt,name=compressed_size,json=compressedSize,proto3" json:"compressed_size,omitempty"`
	// Byte offset relative to the start of the section's metadata region where
	// ColumnMetadata for this column is stored.
	ColumnMetadataOffset uint64 `protobuf:"varint,9,opt,name=column_metadata_offset,json=columnMetadataOffset,proto3" json:"column_metadata_offset,omitempty"`
	// Length of the ColumnMetadata for this column in bytes.
	ColumnMetadataLength uint64 `protobuf:"varint,10,opt,name=column_metadata_length,json=columnMetadataLength,proto3" json:"column_metadata_length,omitempty"`
	// Statistics for this column.
	Statistics *Statistics `protobuf:"bytes,11,opt,name=statistics,proto3" json:"statistics,omitempty"`
}

type ColumnMetadata struct {
	// Pages within the column.
	Pages []*PageDesc `protobuf:"bytes,1,rep,name=pages,proto3" json:"pages,omitempty"`
}

type ColumnType struct {
	// Physical is the physical type of the column.
	Physical PhysicalType `protobuf:"varint,1,opt,name=physical,proto3,enum=dataobj.metadata.dataset.v2.PhysicalType" json:"physical,omitempty"`
	// Logical is a section-specified string indicating how to interpret the
	// physical type. Section implementations are responsible for interpreting
	// this value.
	//
	// The string can be retrieved from the dictionary field in SectionMetadata,
	// using the logical_ref value as the index.
	LogicalRef uint32 `protobuf:"varint,3,opt,name=logical_ref,json=logicalRef,proto3" json:"logical_ref,omitempty"`
}

type CompressionType int32

type EncodingType int32

type PageDesc struct {
	// Uncompressed size of the page in bytes.
	UncompressedSize uint64 `protobuf:"varint,1,opt,name=uncompressed_size,json=uncompressedSize,proto3" json:"uncompressed_size,omitempty"`
	// Compressed size of the page in bytes.
	CompressedSize uint64 `protobuf:"varint,2,opt,name=compressed_size,json=compressedSize,proto3" json:"compressed_size,omitempty"`
	// CRC32 checksum of the page data.
	Crc32 uint32 `protobuf:"varint,3,opt,name=crc32,proto3" json:"crc32,omitempty"`
	// Total number of rows (values + nulls) in the page.
	RowsCount uint64 `protobuf:"varint,4,opt,name=rows_count,json=rowsCount,proto3" json:"rows_count,omitempty"`
	// Total number of non-NULL values in the page. The number of NULL values is
	// rows_count - values_count.
	ValuesCount uint64 `protobuf:"varint,5,opt,name=values_count,json=valuesCount,proto3" json:"values_count,omitempty"`
	// Encoding used for values in the page.
	Encoding EncodingType `protobuf:"varint,6,opt,name=encoding,proto3,enum=dataobj.metadata.dataset.v2.EncodingType" json:"encoding,omitempty"`
	// Byte offset relative to the start of the section's data region where the
	// page is stored.
	DataOffset uint64 `protobuf:"varint,7,opt,name=data_offset,json=dataOffset,proto3" json:"data_offset,omitempty"`
	// Size of the page's data in bytes.
	DataSize uint64 `protobuf:"varint,8,opt,name=data_size,json=dataSize,proto3" json:"data_size,omitempty"`
	// Optional statistics for the page.
	Statistics *Statistics `protobuf:"bytes,9,opt,name=statistics,proto3" json:"statistics,omitempty"`
}

type PhysicalType int32

type SectionInfoExtension struct {
	// Byte offset relative to the start of the section's metadata region where
	// SectionMetadata for this section is stored.
	SectionMetadataOffset uint64 `` /* 127-byte string literal not displayed */
	// Length of the SectionMetadata for this column in bytes.
	SectionMetadataLength uint64 `` /* 127-byte string literal not displayed */
}

type SectionMetadata struct {
	// The list of columns in the dataset.
	Columns []*ColumnDesc `protobuf:"bytes,1,rep,name=columns,proto3" json:"columns,omitempty"`
	// Dictionary for deduplicating logical types and column tags. The first
	// element (index zero) is reserved for invalid strings ("").
	Dictionary []string `protobuf:"bytes,2,rep,name=dictionary,proto3" json:"dictionary,omitempty"`
	// Sort information about the columns.
	SortInfo *SortInfo `protobuf:"bytes,3,opt,name=sort_info,json=sortInfo,proto3" json:"sort_info,omitempty"`
}

type SortDirection int32

type SortInfo struct {
	// The list of column sorts. The length of this depends on how many columns
	// are used for sorting.
	//
	// If the section has no sorting at all, this field will be empty. If the
	// section is sorted based on the value of a single column, this field will
	// contain a single element. Otherwise, this field will contain multiple
	// elements when compound sorting is used.
	ColumnSorts []*SortInfo_ColumnSort `protobuf:"bytes,1,rep,name=column_sorts,json=columnSorts,proto3" json:"column_sorts,omitempty"`
}

type SortInfo_ColumnSort struct {
	// Index of the column in the columns list.
	ColumnIndex uint32 `protobuf:"varint,1,opt,name=column_index,json=columnIndex,proto3" json:"column_index,omitempty"`
	// Sort direction of the column.
	Direction SortDirection `protobuf:"varint,2,opt,name=direction,proto3,enum=dataobj.metadata.dataset.v2.SortDirection" json:"direction,omitempty"`
}

type Statistics struct {
	// Minimum value. Applications should only set min_value to an encoding of a
	// non-NULL value. If there is no non-NULL value, min_value should be unset.
	//
	// Applications must not assume that an unset min_value means that the column
	// is empty; check for values_count == 0 instead.
	MinValue []byte `protobuf:"bytes,1,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
	// Maximum value. Applications should only set max_value to an encoding of a
	// non-NULL value. If there is no non-NULL value, max_value should be unset.
	//
	// Applications must not assume that an unset max_value means that the column
	// is empty; check for values_count == 0 instead.
	MaxValue []byte `protobuf:"bytes,2,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
	// Estimated number of distinct values in the column.
	//
	// Applications must not assume that an unset cardinality_count means that
	// the column has no distinct values; check for values_count == 0 instead.
	CardinalityCount uint64 `protobuf:"varint,3,opt,name=cardinality_count,json=cardinalityCount,proto3" json:"cardinality_count,omitempty"`
}