index

Documentation

Overview

Package index implements the index system for searching data.

Index

• Variables
• func FieldStr(key FieldKey, term []byte) string
• func UnmarshalTerm(raw []byte) []byte
• type Batch
• type Document
• type Documents
• type Field
  • func (f Field) Marshal() []byte
  • func (f *Field) Unmarshal(raw []byte) error
• type FieldIterable
• type FieldIterator
• type FieldKey
  • func (f FieldKey) Equal(other FieldKey) bool
  • func (f FieldKey) HasSeriesID() bool
  • func (f FieldKey) Marshal() []byte
  • func (f FieldKey) MarshalIndexRule() string
  • func (f FieldKey) MarshalToStr() string
  • func (f *FieldKey) Unmarshal(raw []byte) error
• type Filter
• type GetSearcher
• type RangeOpts
  • func (r RangeOpts) Between(value []byte) int
• type Searcher
• type Series
  • func (s Series) String() string
• type SeriesMatcher
  • func (s SeriesMatcher) String() string
• type SeriesMatcherType
• type SeriesStore
• type Store
• type Writer

Variables

var DummyFieldIterator = &dummyIterator{}

DummyFieldIterator never iterates.

Functions

func FieldStr

func FieldStr(key FieldKey, term []byte) string

FieldStr return a string represent of Field which is composed by key and term.

func UnmarshalTerm

func UnmarshalTerm(raw []byte) []byte

UnmarshalTerm decodes term from a encoded field.

Types

type Batch

type Batch struct {
	Applied   chan struct{}
	Documents Documents
}

Batch is a collection of documents.

type Document

type Document struct {
	Fields       []Field
	EntityValues []byte
	DocID        uint64
}

Document represents a document in a index.

type Documents

type Documents []Document

Documents is a collection of documents.

type Field

type Field struct {
	Term []byte
	Key  FieldKey
}

Field is a indexed item in a document.

func (Field) Marshal

func (f Field) Marshal() []byte

Marshal encodes f to bytes.

func (*Field) Unmarshal

func (f *Field) Unmarshal(raw []byte) error

Unmarshal decodes bytes to f.

type FieldIterable

type FieldIterable interface {
	Iterator(fieldKey FieldKey, termRange RangeOpts, order modelv1.Sort, preLoadSize int) (iter FieldIterator, err error)
	Sort(sids []common.SeriesID, fieldKey FieldKey, order modelv1.Sort, preLoadSize int) (FieldIterator, error)
}

FieldIterable allows building a FieldIterator.

type FieldIterator

type FieldIterator interface {
	Next() bool
	Val() (uint64, common.SeriesID)
	Close() error
}

FieldIterator allows iterating over a field's posting values.

type FieldKey

type FieldKey struct {
	SeriesID    common.SeriesID
	IndexRuleID uint32
	Analyzer    databasev1.IndexRule_Analyzer
}

FieldKey is the key of field in a document.

func (FieldKey) Equal

func (f FieldKey) Equal(other FieldKey) bool

Equal reports whether f and other have the same series id and index rule id.

func (FieldKey) HasSeriesID

func (f FieldKey) HasSeriesID() bool

HasSeriesID reports whether f has a series id.

func (FieldKey) Marshal

func (f FieldKey) Marshal() []byte

Marshal encodes f to bytes.

func (FieldKey) MarshalIndexRule

func (f FieldKey) MarshalIndexRule() string

MarshalIndexRule encodes the index rule id to string representation.

func (FieldKey) MarshalToStr

func (f FieldKey) MarshalToStr() string

MarshalToStr encodes f to string.

func (*FieldKey) Unmarshal

func (f *FieldKey) Unmarshal(raw []byte) error

Unmarshal decodes bytes to f.

type Filter

type Filter interface {
	fmt.Stringer
	Execute(getSearcher GetSearcher, seriesID common.SeriesID) (posting.List, error)
}

Filter is a node in the filter tree.

type GetSearcher

type GetSearcher func(location databasev1.IndexRule_Type) (Searcher, error)

GetSearcher returns a searcher associated with input index rule type.

type RangeOpts

type RangeOpts struct {
	Upper         []byte
	Lower         []byte
	IncludesUpper bool
	IncludesLower bool
}

RangeOpts contains options to performance a continuous scan.

func (RangeOpts) Between

func (r RangeOpts) Between(value []byte) int

Between reports whether value is in the range.

type Searcher

type Searcher interface {
	FieldIterable
	Match(fieldKey FieldKey, match []string) (list posting.List, err error)
	MatchField(fieldKey FieldKey) (list posting.List, err error)
	MatchTerms(field Field) (list posting.List, err error)
	Range(fieldKey FieldKey, opts RangeOpts) (list posting.List, err error)
}

Searcher allows searching a field either by its key or by its key and term.

type Series

type Series struct {
	EntityValues []byte
	ID           common.SeriesID
}

Series represents a series in a index.

func (Series) String

func (s Series) String() string

type SeriesMatcher

type SeriesMatcher struct {
	Match []byte
	Type  SeriesMatcherType
}

SeriesMatcher represents a series matcher.

func (SeriesMatcher) String

func (s SeriesMatcher) String() string

String returns a string representation of the series matcher.

type SeriesMatcherType

type SeriesMatcherType int

SeriesMatcherType represents the type of series matcher.

const (
	// SeriesMatcherTypeExact represents an exact matcher.
	SeriesMatcherTypeExact SeriesMatcherType = iota
	// SeriesMatcherTypePrefix represents a prefix matcher.
	SeriesMatcherTypePrefix
	// SeriesMatcherTypeWildcard represents a wildcard matcher.
	SeriesMatcherTypeWildcard
)

type SeriesStore

type SeriesStore interface {
	Store
	// Search returns a list of series that match the given matchers.
	Search(context.Context, []SeriesMatcher) ([]Series, error)
}

SeriesStore is an abstract of a series repository.

type Store

type Store interface {
	io.Closer
	Writer
	Searcher
	SizeOnDisk() int64
}

Store is an abstract of a index repository.

type Writer

type Writer interface {
	Write(fields []Field, docID uint64) error
	Batch(batch Batch) error
}

Writer allows writing fields and docID in a document to a index.