index

Documentation

Index

• type Batch
  • func (b Batch) Delete(id string)
  • func (b Batch) Index(id string, doc *document.Document)
• type DocIDReader
• type FieldReader
• type FieldTerms
• type Index
• type IndexReader
• type TermFieldDoc
• type TermFieldReader
• type TermFieldVector

Types

type Batch

type Batch map[string]*document.Document

func (Batch) Delete

func (b Batch) Delete(id string)

func (Batch) Index

func (b Batch) Index(id string, doc *document.Document)

type DocIDReader

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

type FieldReader

type FieldReader interface {
	Next() (*TermFieldDoc, error)
	Close()
}

type FieldTerms

type FieldTerms map[string][]string

type Index

type Index interface {
	Open() error
	Close()

	DocCount() uint64

	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

	Stats() json.Marshaler
}

type IndexReader

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

	FieldReader(field string, startTerm []byte, endTerm []byte) (FieldReader, error)

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

	Fields() ([]string, error)

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

	DocCount() uint64

	Close()
}

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()
}

type TermFieldVector

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