index

Documentation

Index

• type Batch
  • func NewBatch() *Batch
  • func (b Batch) Delete(id string)
  • func (b Batch) DeleteInternal(key []byte)
  • func (b Batch) SetInternal(key, val []byte)
  • func (b Batch) Update(doc *document.Document)
• type DictEntry
• type DocIDReader
• type FieldDict
• type FieldTerms
• type Index
• type IndexReader
• type TermFieldDoc
• type TermFieldReader
• type TermFieldVector

Types

type Batch

type Batch struct {
	IndexOps    map[string]*document.Document
	InternalOps map[string][]byte
}

func NewBatch

func NewBatch() *Batch

func (Batch) Delete

func (b Batch) Delete(id string)

func (Batch) DeleteInternal

func (b Batch) DeleteInternal(key []byte)

func (Batch) SetInternal

func (b Batch) SetInternal(key, val []byte)

func (Batch) Update

func (b Batch) Update(doc *document.Document)

type DictEntry

type DictEntry struct {
	Term  string
	Count uint64
}

type DocIDReader

type DocIDReader interface {
	Next() (string, error)
	Advance(ID string) (string, error)
	Close() error
}

type FieldDict

type FieldDict interface {
	Next() (*DictEntry, error)
	Close() error
}

type FieldTerms

type FieldTerms map[string][]string

type Index

type Index interface {
	Open() error
	Close() error

	DocCount() (uint64, error)

	Update(doc *document.Document) error
	Delete(id string) error
	Batch(batch *Batch) error

	SetInternal(key, val []byte) error
	DeleteInternal(key []byte) error

	DumpAll() chan interface{}
	DumpDoc(id string) chan interface{}
	DumpFields() chan interface{}

	Reader() (IndexReader, error)

	Stats() json.Marshaler
}

type IndexReader

type IndexReader interface {
	TermFieldReader(term []byte, field string) (TermFieldReader, error)
	DocIDReader(start, end string) (DocIDReader, error)

	FieldDict(field string) (FieldDict, error)
	FieldDictRange(field string, startTerm []byte, endTerm []byte) (FieldDict, error)
	FieldDictPrefix(field string, termPrefix []byte) (FieldDict, error)

	Document(id string) (*document.Document, error)
	DocumentFieldTerms(id string) (FieldTerms, error)

	Fields() ([]string, error)

	GetInternal(key []byte) ([]byte, error)

	DocCount() uint64

	Close() error
}

type TermFieldDoc

type TermFieldDoc struct {
	Term    string
	ID      string
	Freq    uint64
	Norm    float64
	Vectors []*TermFieldVector
}

type TermFieldReader

type TermFieldReader interface {
	Next() (*TermFieldDoc, error)
	Advance(ID string) (*TermFieldDoc, error)
	Count() uint64
	Close() error
}

type TermFieldVector

type TermFieldVector struct {
	Field string
	Pos   uint64
	Start uint64
	End   uint64
}