search

Documentation

Index

• Constants
• type FacetAttrs
• type FacetCount
• type Group
  • func NewGroup(keys []string, hits []*Hit) *Group
• type Groups
  • func NewGroups() *Groups
  • func (g *Groups) HasMoreGroups() bool
  • func (g *Groups) Len() int
  • func (g *Groups) Next() (*Group, error)
• type Hit
  • func NewSearchHit(tsHit *tsApi.SearchResultHit) *Hit
• type Hits
  • func NewHits() *Hits
  • func (h *Hits) HasMoreHits() bool
  • func (h *Hits) Len() int
  • func (h *Hits) Next() (*Hit, error)
• type IHits
• type IHitsMutable
• type Response
  • func (r *Response) HasMore() bool
  • func (r *Response) Next() (*ResultRow, error)
• type ResponseFactory
  • func NewResponseFactory(inputQuery *search.Query) *ResponseFactory
  • func (r *ResponseFactory) GetGroupedHitsIterator(response []tsApi.SearchResult) *Groups
  • func (r *ResponseFactory) GetHitsIterator(response []tsApi.SearchResult) IHits
  • func (r *ResponseFactory) GetResponse(response []tsApi.SearchResult) Response
• type ResultRow
• type SortedFacets
  • func NewSortedFacets() *SortedFacets
  • func (f *SortedFacets) Add(tsCounts *tsApi.FacetCounts) error
  • func (f *SortedFacets) GetFacetCount(field string) (*FacetCount, bool)
  • func (f *SortedFacets) GetStats(field string) *api.FacetStats
• type SortedMergeHits
  • func NewSortedHits(sortingOrder *sort.Ordering) *SortedMergeHits
  • func (s *SortedMergeHits) HasMoreHits() bool
  • func (s *SortedMergeHits) Len() int
  • func (s *SortedMergeHits) Next() (*Hit, error)

Constants

const (
	This  = 1
	That  = -1
	Equal = 0
)

Comparison outputs.

Types

type FacetAttrs

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

type FacetCount

type FacetCount struct {
	Value string
	Count int64
}

type Group

type Group struct {
	Hits []*Hit
	Keys []string
}

func NewGroup

func NewGroup(keys []string, hits []*Hit) *Group

type Groups

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

func NewGroups

func NewGroups() *Groups

func (*Groups) HasMoreGroups

func (g *Groups) HasMoreGroups() bool

func (*Groups) Len

func (g *Groups) Len() int

func (*Groups) Next

func (g *Groups) Next() (*Group, error)

type Hit

type Hit struct {
	Document       map[string]interface{}
	TextMatchScore int64
	Match          *api.Match
}

func NewSearchHit

func NewSearchHit(tsHit *tsApi.SearchResultHit) *Hit

type Hits

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

func NewHits

func NewHits() *Hits

func (*Hits) HasMoreHits

func (h *Hits) HasMoreHits() bool

func (*Hits) Len

func (h *Hits) Len() int

func (*Hits) Next

func (h *Hits) Next() (*Hit, error)

type IHits

type IHits interface {
	Next() (*Hit, error)
	Len() int
	HasMoreHits() bool
}

type IHitsMutable

type IHitsMutable interface {
	IHits
	// contains filtered or unexported methods
}

type Response

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

func (*Response) HasMore

func (r *Response) HasMore() bool

func (*Response) Next

func (r *Response) Next() (*ResultRow, error)

type ResponseFactory

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

ResponseFactory is used to convert raw hits response to our Iterable that has final order of hits.

func NewResponseFactory

func NewResponseFactory(inputQuery *search.Query) *ResponseFactory

func (*ResponseFactory) GetGroupedHitsIterator

func (r *ResponseFactory) GetGroupedHitsIterator(response []tsApi.SearchResult) *Groups

func (*ResponseFactory) GetHitsIterator

func (r *ResponseFactory) GetHitsIterator(response []tsApi.SearchResult) IHits

GetHitsIterator returns an IHits interface which contains hits results in an order that we need to stream out to the user.

func (*ResponseFactory) GetResponse

func (r *ResponseFactory) GetResponse(response []tsApi.SearchResult) Response

type ResultRow

type ResultRow struct {
	Hit   *Hit
	Group *Group
}

type SortedFacets

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

SortedFacets is a Temporary workaround to merge facet values when aggregating results from multi-search queries resulting from OR filters this is not very efficient as of now.

func NewSortedFacets

func NewSortedFacets() *SortedFacets

func (*SortedFacets) Add

func (f *SortedFacets) Add(tsCounts *tsApi.FacetCounts) error

Add creates or merges the facet counts with existing for each field new values cannot be added to this data structure once it has been sorted.

func (*SortedFacets) GetFacetCount

func (f *SortedFacets) GetFacetCount(field string) (*FacetCount, bool)

GetFacetCount removes from priority queue and returns the value with highest count for the field if present else returns nil, False.

func (*SortedFacets) GetStats

func (f *SortedFacets) GetStats(field string) *api.FacetStats

GetStats returns the computed stats for the faceted field.

type SortedMergeHits

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

SortedMergeHits is a Priority queue to merge sorted results. This is used when we have multiple responses and we know that each response hits is already sorted.

func NewSortedHits

func NewSortedHits(sortingOrder *sort.Ordering) *SortedMergeHits

NewSortedHits returns hits in decreasing order by priority.

func (*SortedMergeHits) HasMoreHits

func (s *SortedMergeHits) HasMoreHits() bool

func (*SortedMergeHits) Len

func (s *SortedMergeHits) Len() int

func (*SortedMergeHits) Next

func (s *SortedMergeHits) Next() (*Hit, error)