# Functions
AllPostingsKey returns the label key that is used to store the postings list of all existing IDs.
EmptyPostings returns a postings list that's always empty.
ErrPostings returns new postings that immediately error.
ExpandPostings returns the postings expanded as a slice.
Intersect returns a new postings list over the intersection of the input postings.
IsEmptyPostingsType returns true if the postings are an empty postings list.
Merge returns a new iterator over the union of the input iterators.
NewBufferWriter returns a new BufferWriter.
NewFileReader returns a new index reader against the given index file.
For writing TSDBs using temporary files.
NewMemPostings returns a memPostings that's ready for reads and writes.
For writing TSDBs in memory.
NewReader returns a new index reader on the given byte slice.
Note: shardedPostings can technically return more series than just those that correspond to the requested shard.
NewStringListIter returns a StringIter for the given sorted list of strings.
NewSymbols returns a Symbols object for symbol lookups.
NewTOCFromByteSlice return parsed TOC from given index byte slice.
NewUnorderedMemPostings returns a memPostings that is not safe to be read from until EnsureOrder() was called once.
NewWriter returns a new Writer to the given filename.
ReadOffsetTable reads an offset table and at the given position calls f for each found entry.
Without returns a new postings list that contains all elements from the full list that are not in the drop list.
# Constants
Chunks per page.
Minimum number of chunks present to use page based lookup instead of linear scan which performs better at lower n-values.
FormatV1 represents 1 version of index.
FormatV2 represents 2 version of index.
FormatV3 represents 3 version of index.
HeaderLen represents number of bytes reserved of index for header.
MagicIndex 4 bytes at the head of an index file.
ShardLabel is a reserved label referencing a cortex shard.
ShardLabelFmt is the fmt of the ShardLabel key.
reserved; used in multitenant indices to signal the tenant.
# Structs
BigEndianPostings implements the Postings interface over a byte stream of big endian numbers.
Meta holds information about a chunk of data.
Creator implements the IndexWriter interface for the standard serialization format.
Decoder provides decoding methods It currently does not contain decoding methods for all entry types but can be extended by them if there's demand.
ListPostings implements the Postings interface over a plain list.
MemPostings holds postings list for series ID per label pair.
Metadata is TSDB-level metadata.
PostingsStats contains cardinality based statistics for postings.
Range marks a byte range.
ShardAnnotation is a convenience struct which holds data from a parsed shard label Of MUST be a power of 2 to ensure sharding logic works correctly.
Stat holds values for a single cardinality statistic.
TOC represents index Table Of Content that states where each section of index starts.
# Interfaces
ByteSlice abstracts a byte slice.
Postings provides iterative access over a postings list.
StringIter iterates over a sorted list of strings.