schema

Documentation

Index

• Constants
• type IndexBloomFilterInfo
• type IndexEntry
• type IndexInfo
• type IndexSummariesInfo
• type IndexSummary
• type LogEntry
• type LogInfo
• type LogMetadata

Constants

const MajorVersion = 1

MajorVersion is the major schema version for a set of fileset files, this is only incremented when breaking changes are introduced and tooling needs to upgrade older files to newer files before a server restart

Types

type IndexBloomFilterInfo

type IndexBloomFilterInfo struct {
	NumElementsM int64
	NumHashesK   int64
}

IndexBloomFilterInfo stores metadata about the bloom filter

type IndexEntry

type IndexEntry struct {
	Index       int64
	ID          []byte
	Size        int64
	Offset      int64
	Checksum    int64
	EncodedTags []byte
}

IndexEntry stores entry-level data indexing

type IndexInfo

type IndexInfo struct {
	MajorVersion int64
	BlockStart   int64
	BlockSize    int64
	Entries      int64
	Summaries    IndexSummariesInfo
	BloomFilter  IndexBloomFilterInfo
	SnapshotTime int64
	FileType     persist.FileSetType
	SnapshotID   []byte
}

IndexInfo stores metadata information about block filesets

type IndexSummariesInfo

type IndexSummariesInfo struct {
	Summaries int64
}

IndexSummariesInfo stores metadata about the summaries

type IndexSummary

type IndexSummary struct {
	Index            int64
	ID               []byte
	IndexEntryOffset int64
}

IndexSummary stores a summary of an index entry to lookup

type LogEntry

type LogEntry struct {
	Index      uint64
	Create     int64
	Metadata   []byte
	Timestamp  int64
	Value      float64
	Unit       uint32
	Annotation []byte
}

LogEntry stores per-entry data in a commit log

type LogInfo

type LogInfo struct {
	// Deprecated fields, left intact as documentation for the actual
	// format on disk.
	DeprecatedDoNotUseStart    int64
	DeprecatedDoNotUseDuration int64

	Index int64
}

LogInfo stores summary information about a commit log

type LogMetadata

type LogMetadata struct {
	ID          []byte
	Namespace   []byte
	Shard       uint32
	EncodedTags []byte
}

LogMetadata stores metadata information about a commit log