textsearch

Documentation

Overview

Package textsearch implements basic text search features (for matching text fields of JSON documents).

Index

• type IndexedDoc
  • func NewIndexedDoc(doc map[string]interface{}, fields []string) (*IndexedDoc, error)
• type SearchTerms
  • func ParseTextQuery(q string) SearchTerms
  • func (terms SearchTerms) Match(d *IndexedDoc) bool

Types

type IndexedDoc

type IndexedDoc struct {
	Content string         `msgpack:"c"`
	Stems   map[string]int `msgpack:"s"`
}

IndexedDoc holds a parsed "document"

func NewIndexedDoc

func NewIndexedDoc(doc map[string]interface{}, fields []string) (*IndexedDoc, error)

NewIndexedDoc returns a parsed "document"

type SearchTerms

type SearchTerms []*searchTerm

SearchTerms holds a parsed text search query

func ParseTextQuery

func ParseTextQuery(q string) SearchTerms

ParseTextQuery returns a parsed text query

func (SearchTerms) Match

func (terms SearchTerms) Match(d *IndexedDoc) bool

Match returns true if the query matches the given `IndexedDoc`