collector

Documentation

Index

• Constants
• Variables
• func MakeTopNDocumentMatchHandler(ctx *search.SearchContext) (search.DocumentMatchHandler, bool, error)
• type TopNCollector
  • func NewTopNCollector(size int, skip int, sort search.SortOrder) *TopNCollector
  • func NewTopNCollectorAfter(size int, sort search.SortOrder, after []string) *TopNCollector
  • func (hc *TopNCollector) Collect(ctx context.Context, searcher search.Searcher, reader index.IndexReader) error
  • func (hc *TopNCollector) FacetResults() search.FacetResults
  • func (hc *TopNCollector) MaxScore() float64
  • func (hc *TopNCollector) Results() search.DocumentMatchCollection
  • func (hc *TopNCollector) SetFacetsBuilder(facetsBuilder *search.FacetsBuilder)
  • func (hc *TopNCollector) Size() int
  • func (hc *TopNCollector) Took() time.Duration
  • func (hc *TopNCollector) Total() uint64

Constants

const CheckDoneEvery = uint64(1024)

CheckDoneEvery controls how frequently we check the context deadline

Variables

var PreAllocSizeSkipCap = 1000

PreAllocSizeSkipCap will cap preallocation to this amount when size+skip exceeds this value

Functions

func MakeTopNDocumentMatchHandler

func MakeTopNDocumentMatchHandler(
	ctx *search.SearchContext) (search.DocumentMatchHandler, bool, error)

Types

type TopNCollector

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

TopNCollector collects the top N hits, optionally skipping some results

func NewTopNCollector

func NewTopNCollector(size int, skip int, sort search.SortOrder) *TopNCollector

NewTopNCollector builds a collector to find the top 'size' hits skipping over the first 'skip' hits ordering hits by the provided sort order

func NewTopNCollectorAfter

func NewTopNCollectorAfter(size int, sort search.SortOrder, after []string) *TopNCollector

NewTopNCollector builds a collector to find the top 'size' hits skipping over the first 'skip' hits ordering hits by the provided sort order

func (*TopNCollector) Collect

func (hc *TopNCollector) Collect(ctx context.Context, searcher search.Searcher, reader index.IndexReader) error

Collect goes to the index to find the matching documents

func (*TopNCollector) FacetResults

func (hc *TopNCollector) FacetResults() search.FacetResults

FacetResults returns the computed facets results

func (*TopNCollector) MaxScore

func (hc *TopNCollector) MaxScore() float64

MaxScore returns the maximum score seen across all the hits

func (*TopNCollector) Results

func (hc *TopNCollector) Results() search.DocumentMatchCollection

Results returns the collected hits

func (*TopNCollector) SetFacetsBuilder

func (hc *TopNCollector) SetFacetsBuilder(facetsBuilder *search.FacetsBuilder)

SetFacetsBuilder registers a facet builder for this collector

func (*TopNCollector) Size

func (hc *TopNCollector) Size() int

func (*TopNCollector) Took

func (hc *TopNCollector) Took() time.Duration

Took returns the time spent collecting hits

func (*TopNCollector) Total

func (hc *TopNCollector) Total() uint64

Total returns the total number of hits