index

Documentation

Index

• type Autocompleter
• type Document
  • func NewDocument(id string, score float32) Document
  • func (d Document) Set(name string, value interface{}) Document
• type DocumentList
  • func (l DocumentList) Len() int
  • func (l DocumentList) Less(i, j int) bool
  • func (l DocumentList) Sort()
  • func (l DocumentList) Swap(i, j int)
• type Field
  • func NewNumericField(name string) Field
  • func NewTextField(name string, weight float32) Field
  • func NewTextFieldSortable(name string, weight float32) Field
• type FieldType
• type Index
• type Metadata
  • func NewMetadata() *Metadata
  • func (m *Metadata) AddField(f Field) *Metadata
• type Suggestion
• type SuggestionList
  • func (l SuggestionList) Len() int
  • func (l SuggestionList) Less(i, j int) bool
  • func (l SuggestionList) Sort()
  • func (l SuggestionList) Swap(i, j int)
• type TextFieldOptions

Types

type Autocompleter

type Autocompleter interface {
	AddTerms(terms ...Suggestion) error
	Suggest(prefix string, num int, fuzzy bool) ([]Suggestion, error)
	Delete() error
}

Autocompleter is an abstract interface for all auto-completers implemented on all engines

type Document

type Document struct {
	Id         string
	Score      float32
	Properties map[string]interface{}
}

Document represents a single document to be indexed or returned from a query. Besides a score and id, the Properties are completely arbitrary

func NewDocument

func NewDocument(id string, score float32) Document

NewDocument creates a document with the specific id and score

func (Document) Set

func (d Document) Set(name string, value interface{}) Document

Set sets a property and its value in the document

type DocumentList

type DocumentList []Document

DocumentList is used to sort documents by descending score

func (DocumentList) Len

func (l DocumentList) Len() int

func (DocumentList) Less

func (l DocumentList) Less(i, j int) bool

func (DocumentList) Sort

func (l DocumentList) Sort()

Sort the DocumentList

func (DocumentList) Swap

func (l DocumentList) Swap(i, j int)

type Field

type Field struct {
	Name    string
	Type    FieldType
	Options interface{}
}

Field represents a single field's metadata

func NewNumericField

func NewNumericField(name string) Field

NewNumericField creates a new numeric field with the given name

func NewTextField

func NewTextField(name string, weight float32) Field

NewTextField creates a new text field with the given weight

func NewTextFieldSortable

func NewTextFieldSortable(name string, weight float32) Field

type FieldType

type FieldType int

FieldType is an enumeration of field/property types

const (
	// TextField full-text field
	TextField FieldType = iota

	// NumericField numeric range field
	NumericField

	// GeoField geo-indexed point field
	GeoField

	// ValueField as-as short text value to be hashed and indexed
	ValueField

	// NoIndexField A field that shuold not be indexed
	NoIndexField
)

type Index

type Index interface {
	GetName() string
	Index(documents []Document, options interface{}) error
	FullTextQuerySingleField(query.Query, int) (docs []Document, total int, err error)
	PrefixQuery(query.Query, int) (docs []Document, total int, err error)
	WildCardQuery(query.Query, int) (docs []Document, total int, err error)
	Drop() error
	Create() error
}

Index is the abstract representation of a search index we're working against. It is implemented for redisearch, elasticserch and solr.

type Metadata

type Metadata struct {
	Fields  []Field
	Options interface{}
}

Metadata represents an index schema metadata, or how the index would treat documents sent to it.

func NewMetadata

func NewMetadata() *Metadata

NewMetadata creates a new Metadata object

func (*Metadata) AddField

func (m *Metadata) AddField(f Field) *Metadata

AddField adds a field to the Metadata object

type Suggestion

type Suggestion struct {
	Term  string
	Score float64
}

Suggestion is a single suggestion being added or received from the Autocompleter

type SuggestionList

type SuggestionList []Suggestion

SuggestionList is a sortable list of suggestions returned from an engine

func (SuggestionList) Len

func (l SuggestionList) Len() int

func (SuggestionList) Less

func (l SuggestionList) Less(i, j int) bool

func (SuggestionList) Sort

func (l SuggestionList) Sort()

Sort the SuggestionList

func (SuggestionList) Swap

func (l SuggestionList) Swap(i, j int)

type TextFieldOptions

type TextFieldOptions struct {
	Weight   float32
	Stemming bool
	Sortable bool
}

TextFieldOptions Options for text fields - weight and stemming enabled/disabled.