index

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 24, 2019 License: Apache-2.0 Imports: 20 Imported by: 16

Documentation

Index

Constants

View Source 
const (
	// MagicIndex 4 bytes at the head of an index file.
	MagicIndex = 0xBAAAD700
	// HeaderLen represents number of bytes reserved of index for header.
	HeaderLen = 5

	// FormatV1 represents 1 version of index.
	FormatV1 = 1
	// FormatV2 represents 2 version of index.
	FormatV2 = 2
)

Variables

This section is empty.

Functions

func AllPostingsKey 

func AllPostingsKey() (name, value string)

AllPostingsKey returns the label key that is used to store the postings list of all existing IDs.

func ExpandPostings 

func ExpandPostings(p Postings) (res []uint64, err error)

ExpandPostings returns the postings expanded as a slice.

func NewStringTuples 

func NewStringTuples(entries []string, length int) (*stringTuples, error)

func ReadOffsetTable added in v0.4.0 

func ReadOffsetTable(bs ByteSlice, off uint64, f func([]string, uint64) error) error

ReadOffsetTable reads an offset table and at the given position calls f for each found entry. If f returns an error it stops decoding and returns the received error.

func ReadSymbols added in v0.4.0 

func ReadSymbols(bs ByteSlice, version int, off int) ([]string, map[uint32]string, error)

ReadSymbols reads the symbol table fully into memory and allocates proper strings for them. Strings backed by the mmap'd memory would cause memory faults if applications keep using them after the reader is closed.

Types

type ByteSlice 

type ByteSlice interface {
	Len() int
	Range(start, end int) []byte
}

ByteSlice abstracts a byte slice.

type Decoder 

type Decoder struct {
	LookupSymbol func(uint32) (string, error)
}

Decoder provides decoding methods for the v1 and v2 index file format.

It currently does not contain decoding methods for all entry types but can be extended by them if there's demand.

func (*Decoder) Postings 

func (dec *Decoder) Postings(b []byte) (int, Postings, error)

Postings returns a postings list for b and its number of elements.

func (*Decoder) Series 

func (dec *Decoder) Series(b []byte, lbls *labels.Labels, chks *[]chunks.Meta) error

Series decodes a series entry from the given byte slice into lset and chks.

type ListPostings added in v0.7.0 

type ListPostings struct {
	// contains filtered or unexported fields
}

ListPostings implements the Postings interface over a plain list.

func (*ListPostings) At added in v0.7.0 

func (it *ListPostings) At() uint64

func (*ListPostings) Err added in v0.7.0 

func (it *ListPostings) Err() error

func (*ListPostings) Next added in v0.7.0 

func (it *ListPostings) Next() bool

func (*ListPostings) Seek added in v0.7.0 

func (it *ListPostings) Seek(x uint64) bool

type MemPostings 

type MemPostings struct {
	// contains filtered or unexported fields
}

MemPostings holds postings list for series ID per label pair. They may be written to out of order. ensureOrder() must be called once before any reads are done. This allows for quick unordered batch fills on startup.

func NewMemPostings 

func NewMemPostings() *MemPostings

NewMemPostings returns a memPostings that's ready for reads and writes.

func NewUnorderedMemPostings 

func NewUnorderedMemPostings() *MemPostings

NewUnorderedMemPostings returns a memPostings that is not safe to be read from until ensureOrder was called once.

func (*MemPostings) Add 

func (p *MemPostings) Add(id uint64, lset labels.Labels)

Add a label set to the postings index.

func (*MemPostings) All 

func (p *MemPostings) All() Postings

All returns a postings list over all documents ever added.

func (*MemPostings) Delete 

func (p *MemPostings) Delete(deleted map[uint64]struct{})

Delete removes all ids in the given map from the postings lists.

func (*MemPostings) EnsureOrder 

func (p *MemPostings) EnsureOrder()

EnsureOrder ensures that all postings lists are sorted. After it returns all further calls to add and addFor will insert new IDs in a sorted manner.

func (*MemPostings) Get 

func (p *MemPostings) Get(name, value string) Postings

Get returns a postings list for the given label pair.

func (*MemPostings) Iter 

func (p *MemPostings) Iter(f func(labels.Label, Postings) error) error

Iter calls f for each postings list. It aborts if f returns an error and returns it.

func (*MemPostings) SortedKeys 

func (p *MemPostings) SortedKeys() []labels.Label

SortedKeys returns a list of sorted label keys of the postings.

type Postings 

type Postings interface {
	// Next advances the iterator and returns true if another value was found.
	Next() bool

	// Seek advances the iterator to value v or greater and returns
	// true if a value was found.
	Seek(v uint64) bool

	// At returns the value at the current iterator position.
	At() uint64

	// Err returns the last error of the iterator.
	Err() error
}

Postings provides iterative access over a postings list.

func EmptyPostings 

func EmptyPostings() Postings

EmptyPostings returns a postings list that's always empty. NOTE: Returning EmptyPostings sentinel when index.Postings struct has no postings is recommended. It triggers optimized flow in other functions like Intersect, Without etc.

func ErrPostings 

func ErrPostings(err error) Postings

ErrPostings returns new postings that immediately error.

func Intersect 

func Intersect(its ...Postings) Postings

Intersect returns a new postings list over the intersection of the input postings.

func Merge 

func Merge(its ...Postings) Postings

Merge returns a new iterator over the union of the input iterators.

func NewListPostings 

func NewListPostings(list []uint64) Postings

func Without 

func Without(full, drop Postings) Postings

Without returns a new postings list that contains all elements from the full list that are not in the drop list.

type Range 

type Range struct {
	Start, End int64
}

Range marks a byte range.

type Reader 

type Reader struct {
	// contains filtered or unexported fields
}

func NewFileReader 

func NewFileReader(path string) (*Reader, error)

NewFileReader returns a new index reader against the given index file.

func NewReader 

func NewReader(b ByteSlice) (*Reader, error)

NewReader returns a new index reader on the given byte slice. It automatically handles different format versions.

func (*Reader) Close 

func (r *Reader) Close() error

Close the reader and its underlying resources.

func (*Reader) LabelIndices 

func (r *Reader) LabelIndices() ([][]string, error)

LabelIndices returns a slice of label names for which labels or label tuples value indices exist. NOTE: This is deprecated. Use `LabelNames()` instead.

func (*Reader) LabelNames 

func (r *Reader) LabelNames() ([]string, error)

LabelNames returns all the unique label names present in the index.

func (*Reader) LabelValues 

func (r *Reader) LabelValues(names ...string) (StringTuples, error)

LabelValues returns value tuples that exist for the given label name tuples.

func (*Reader) Postings 

func (r *Reader) Postings(name, value string) (Postings, error)

Postings returns a postings list for the given label pair.

func (*Reader) PostingsRanges 

func (r *Reader) PostingsRanges() (map[labels.Label]Range, error)

PostingsRanges returns a new map of byte range in the underlying index file for all postings lists.

func (*Reader) Series 

func (r *Reader) Series(id uint64, lbls *labels.Labels, chks *[]chunks.Meta) error

Series reads the series with the given ID and writes its labels and chunks into lbls and chks.

func (*Reader) Size added in v0.4.0 

func (r *Reader) Size() int64

Size returns the size of an index file.

func (*Reader) SortedPostings 

func (r *Reader) SortedPostings(p Postings) Postings

SortedPostings returns the given postings list reordered so that the backing series are sorted.

func (*Reader) SymbolTableSize added in v0.3.0 

func (r *Reader) SymbolTableSize() uint64

SymbolTableSize returns the symbol table size in bytes.

func (*Reader) Symbols 

func (r *Reader) Symbols() (map[string]struct{}, error)

Symbols returns a set of symbols that exist within the index.

func (*Reader) Version 

func (r *Reader) Version() int

Version returns the file format version of the underlying index.

type StringTuples 

type StringTuples interface {
	// Total number of tuples in the list.
	Len() int
	// At returns the tuple at position i.
	At(i int) ([]string, error)
}

StringTuples provides access to a sorted list of string tuples.

type TOC added in v0.4.0 

type TOC struct {
	Symbols           uint64
	Series            uint64
	LabelIndices      uint64
	LabelIndicesTable uint64
	Postings          uint64
	PostingsTable     uint64
}

TOC represents index Table Of Content that states where each section of index starts.

func NewTOCFromByteSlice added in v0.4.0 

func NewTOCFromByteSlice(bs ByteSlice) (*TOC, error)

NewTOCFromByteSlice return parsed TOC from given index byte slice.

type Writer 

type Writer struct {
	Version int
	// contains filtered or unexported fields
}

Writer implements the IndexWriter interface for the standard serialization format.

func NewWriter 

func NewWriter(fn string) (*Writer, error)

NewWriter returns a new Writer to the given filename. It serializes data in format version 2.

func (*Writer) AddSeries 

func (w *Writer) AddSeries(ref uint64, lset labels.Labels, chunks ...chunks.Meta) error

AddSeries adds the series one at a time along with its chunks.

func (*Writer) AddSymbols 

func (w *Writer) AddSymbols(sym map[string]struct{}) error

func (*Writer) Close 

func (w *Writer) Close() error

func (*Writer) WriteLabelIndex 

func (w *Writer) WriteLabelIndex(names []string, values []string) error

func (*Writer) WritePostings 

func (w *Writer) WritePostings(name, value string, it Postings) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.