redisearch

package

Go to main page

Versions in this module

v1

v1.1.1

Apr 22, 2021

Changes in this version

type Client

+ func (i *Client) List() ([]string, error)

type IndexInfo

+ HashIndexingFailures uint64

v1.1.0

Jan 22, 2021

Changes in this version

type Client

+ func (i *Client) CreateIndexWithIndexDefinition(schema *Schema, definition *IndexDefinition) (err error)

+ func (i *Client) DeleteDocument(docId string) (err error)

+ func (i *Client) DropIndex(deleteDocuments bool) error

+ type IndexDefinition struct

+ Async bool

+ FilterExpression string

+ IndexOn string

+ Language string

+ LanguageField string

+ PayloadField string

+ Prefix []string

+ Score float64

+ ScoreField string

+ func NewIndexDefinition() *IndexDefinition

+ func (defintion *IndexDefinition) AddPrefix(prefix string) (outDef *IndexDefinition)

+ func (defintion *IndexDefinition) Serialize(args redis.Args) redis.Args

+ func (defintion *IndexDefinition) SetAsync(value bool) (outDef *IndexDefinition)

+ func (defintion *IndexDefinition) SetFilterExpression(value string) (outDef *IndexDefinition)

+ func (defintion *IndexDefinition) SetLanguage(value string) (outDef *IndexDefinition)

+ func (defintion *IndexDefinition) SetLanguageField(value string) (outDef *IndexDefinition)

+ func (defintion *IndexDefinition) SetPayloadField(value string) (outDef *IndexDefinition)

+ func (defintion *IndexDefinition) SetScore(value float64) (outDef *IndexDefinition)

+ func (defintion *IndexDefinition) SetScoreField(value string) (outDef *IndexDefinition)

type IndexInfo

+ IsIndexing bool

+ PercentIndexed float64

type Options

+ MaxTextFieldsFlag bool

+ func (options *Options) SetMaxTextFieldsFlag(flag bool) *Options

+ type PhoneticMatcherType string

+ const PhoneticDoubleMetaphoneEnglish

+ const PhoneticDoubleMetaphoneFrench

+ const PhoneticDoubleMetaphonePortuguese

+ const PhoneticDoubleMetaphoneSpanish

type Suggestion

+ Incr bool

type TextFieldOptions

+ PhoneticMatcher PhoneticMatcherType

v1.0.1

Jul 9, 2020

Changes in this version

type Options

+ Temporary bool

+ TemporaryPeriod int

+ func NewOptions() *Options

+ func (options *Options) SetStopWords(stopwords []string) *Options

+ func (options *Options) SetTemporary(temporary bool) *Options

+ func (options *Options) SetTemporaryPeriod(period int) *Options

type Query

+ InFields []string

+ func (q *Query) SetInFields(fields ...string) *Query

v1.0.0

May 1, 2020

Changes in this version

type Client

+ func NewClientFromPool(pool *redis.Pool, name string) *Client

+ func (i *Client) AddField(f Field) error

+ func (i *Client) AddHash(docId string, score float32, language string, replace bool) (string, error)

+ func (i *Client) GetConfig(option string) (map[string]string, error)

+ func (i *Client) GetTagVals(index string, filedName string) ([]string, error)

+ func (i *Client) SetConfig(option string, value string) (string, error)

+ func (i *Client) SynAdd(indexName string, terms []string) (int64, error)

+ func (i *Client) SynDump(indexName string) (map[string][]int64, error)

+ func (i *Client) SynUpdate(indexName string, synonymGroupId int64, terms []string) (string, error)

type ConnPool

+ Close func() error

type Field

+ func NewGeoField(name string) Field

+ func NewGeoFieldOptions(name string, options GeoFieldOptions) Field

+ type Filter struct

+ Field string

+ Options interface{}

+ type GeoFieldOptions struct

+ NoIndex bool

+ type GeoFilterOptions struct

+ Lat float64

+ Lon float64

+ Radius float64

+ Unit Unit

type MultiHostPool

+ func (p *MultiHostPool) Close() (err error)

+ type NumericFilterOptions struct

+ ExclusiveMax bool

+ ExclusiveMin bool

+ Max float64

+ Min float64

type Query

+ func (q *Query) AddFilter(f Filter) *Query

+ type Unit string

+ const FEET

+ const KILOMETERS

+ const METERS

+ const MILES

v0

v0.9.0

Apr 2, 2020

Changes in this version

+ var DefaultSuggestOptions = SuggestOptions

+ func SerializeIndexingOptions(opts IndexingOptions, args redis.Args) redis.Args

+ func SerializeSchema(s *Schema, args redis.Args) (redis.Args, error)

type AggregateQuery

+ func (a *AggregateQuery) Load(Properties []string) *AggregateQuery

type Autocompleter

+ func NewAutocompleterFromPool(pool *redis.Pool, name string) *Autocompleter

+ func (a *Autocompleter) DeleteTerms(terms ...Suggestion) error

+ func (a *Autocompleter) Length() (len int64, err error)

+ func (a *Autocompleter) Serialize(prefix string, opts SuggestOptions) (redis.Args, int)

type Client

+ func (i *Client) AliasAdd(name string) (err error)

+ func (i *Client) AliasDel(name string) (err error)

+ func (i *Client) AliasUpdate(name string) (err error)

+ func (i *Client) DictAdd(dictionaryName string, terms []string) (newTerms int, err error)

+ func (i *Client) DictDel(dictionaryName string, terms []string) (deletedTerms int, err error)

+ func (i *Client) DictDump(dictionaryName string) (terms []string, err error)

+ func (i *Client) Get(docId string) (doc *Document, err error)

+ func (i *Client) MultiGet(documentIds []string) (docs []*Document, err error)

type IndexingOptions

+ ReplaceCondition string

type Suggestion

+ func ProcessSugGetVals(vals []string, inc int, WithScores, WithPayloads bool) (ret []Suggestion)

v0.2.0

Oct 29, 2019

Changes in this version

+ const GroupByReducerAvg

+ const GroupByReducerCount

+ const GroupByReducerCountDistinct

+ const GroupByReducerCountDistinctish

+ const GroupByReducerFirstValue

+ const GroupByReducerMax

+ const GroupByReducerMin

+ const GroupByReducerQuantile

+ const GroupByReducerRandomSample

+ const GroupByReducerStdDev

+ const GroupByReducerSum

+ const GroupByReducerToList

+ func EscapeTextFileString(value string) string

+ func ProcessAggResponse(res []interface{}) [][]string

+ func ProcessAggResponseSS(res []interface{}) [][]string

+ type AggregateQuery struct

+ AggregatePlan redis.Args

+ Cursor *Cursor

+ Max int

+ Paging *Paging

+ Query *Query

+ Verbatim bool

+ WithCursor bool

+ WithSchema bool

+ func NewAggregateQuery() *AggregateQuery

+ func (a *AggregateQuery) Apply(expression Projection) *AggregateQuery

+ func (a *AggregateQuery) CursorHasResults() (res bool)

+ func (a *AggregateQuery) Filter(expression string) *AggregateQuery

+ func (a *AggregateQuery) GroupBy(group GroupBy) *AggregateQuery

+ func (a *AggregateQuery) Limit(offset int, num int) *AggregateQuery

+ func (a *AggregateQuery) SetCursor(cursor *Cursor) *AggregateQuery

+ func (a *AggregateQuery) SetMax(value int) *AggregateQuery

+ func (a *AggregateQuery) SetQuery(query *Query) *AggregateQuery

+ func (a *AggregateQuery) SetVerbatim(value bool) *AggregateQuery

+ func (a *AggregateQuery) SetWithSchema(value bool) *AggregateQuery

+ func (a *AggregateQuery) SortBy(SortByProperties []SortingKey) *AggregateQuery

+ func (q AggregateQuery) Serialize() redis.Args

type Client

+ func (i *Client) Aggregate(q *AggregateQuery) (aggregateReply [][]string, total int, err error)

+ func (i *Client) Delete(docId string, deleteDocument bool) (err error)

+ func (i *Client) SpellCheck(q *Query, s *SpellCheckOptions) (suggs []MisspelledTerm, total int, err error)

+ type Cursor struct

+ Count int

+ Id int

+ MaxIdle int

+ func NewCursor() *Cursor

+ func (c *Cursor) SetCount(count int) *Cursor

+ func (c *Cursor) SetId(id int) *Cursor

+ func (c *Cursor) SetMaxIdle(maxIdle int) *Cursor

+ func (c Cursor) Serialize() redis.Args

+ type GroupBy struct

+ Fields []string

+ Paging *Paging

+ Reducers []Reducer

+ func NewGroupBy() *GroupBy

+ func (g *GroupBy) AddFields(fields interface{}) *GroupBy

+ func (g *GroupBy) Limit(offset int, num int) *GroupBy

+ func (g *GroupBy) Reduce(reducer Reducer) *GroupBy

+ func (g GroupBy) Serialize() redis.Args

+ type GroupByReducers string

+ type MisspelledSuggestion struct

+ Score float32

+ Suggestion string

+ func NewMisspelledSuggestion(term string, score float32) MisspelledSuggestion

+ type MisspelledTerm struct

+ MisspelledSuggestionList []MisspelledSuggestion

+ Term string

+ func NewMisspelledTerm(term string) MisspelledTerm

+ func (l MisspelledTerm) Len() int

+ func (l MisspelledTerm) Less(i, j int) bool

+ func (l MisspelledTerm) Sort()

+ func (l MisspelledTerm) Swap(i, j int)

type Paging

+ func NewPaging(offset int, num int) *Paging

+ type Projection struct

+ Alias string

+ Expression string

+ func NewProjection(expression string, alias string) *Projection

+ func (p Projection) Serialize() redis.Args

+ type Reducer struct

+ Alias string

+ Args []string

+ Name GroupByReducers

+ func NewReducer(name GroupByReducers, args []string) *Reducer

+ func NewReducerAlias(name GroupByReducers, args []string, alias string) *Reducer

+ func (r *Reducer) SetAlias(a string) *Reducer

+ func (r *Reducer) SetArgs(args []string) *Reducer

+ func (r *Reducer) SetName(reducer GroupByReducers) *Reducer

+ func (r Reducer) Serialize() redis.Args

type SortingKey

+ func NewSortingKeyDir(field string, ascending bool) *SortingKey

+ func (s SortingKey) Serialize() redis.Args

+ type SpellCheckOptions struct

+ Distance int

+ ExclusionDicts []string

+ InclusionDicts []string

+ func NewSpellCheckOptions(distance int) *SpellCheckOptions

+ func NewSpellCheckOptionsDefaults() *SpellCheckOptions

+ func (s *SpellCheckOptions) AddExclusionDict(dictname string) *SpellCheckOptions

+ func (s *SpellCheckOptions) AddInclusionDict(dictname string) *SpellCheckOptions

+ func (s *SpellCheckOptions) SetDistance(distance int) (*SpellCheckOptions, error)

v0.1.0

Mar 12, 2019

Changes in this version

+ var DefaultIndexingOptions = IndexingOptions

+ var DefaultOptions = Options

+ type Autocompleter struct

+ func NewAutocompleter(addr, name string) *Autocompleter

+ func (a *Autocompleter) AddTerms(terms ...Suggestion) error

+ func (a *Autocompleter) Delete() error

+ func (a *Autocompleter) Suggest(prefix string, num int, fuzzy bool) ([]Suggestion, error)

+ func (a *Autocompleter) SuggestOpts(prefix string, opts SuggestOptions) ([]Suggestion, error)

+ type Client struct

+ func NewClient(addr, name string) *Client

+ func (i *Client) CreateIndex(s *Schema) error

+ func (i *Client) Drop() error

+ func (i *Client) Explain(q *Query) (string, error)

+ func (i *Client) Index(docs ...Document) error

+ func (i *Client) IndexOptions(opts IndexingOptions, docs ...Document) error

+ func (i *Client) Info() (*IndexInfo, error)

+ func (i *Client) Search(q *Query) (docs []Document, total int, err error)

+ type ConnPool interface

+ Get func() redis.Conn

+ type Document struct

+ Id string

+ Payload []byte

+ Properties map[string]interface{}

+ Score float32

+ func NewDocument(id string, score float32) Document

+ func (d *Document) EstimateSize() (sz int)

+ func (d *Document) SetPayload(payload []byte)

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

+ type DocumentList []Document

+ 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 struct

+ Name string

+ Options interface{}

+ Sortable bool

+ Type FieldType

+ func NewNumericField(name string) Field

+ func NewNumericFieldOptions(name string, options NumericFieldOptions) Field

+ func NewSortableNumericField(name string) Field

+ func NewSortableTextField(name string, weight float32) Field

+ func NewTagField(name string) Field

+ func NewTagFieldOptions(name string, opts TagFieldOptions) Field

+ func NewTextField(name string) Field

+ func NewTextFieldOptions(name string, opts TextFieldOptions) Field

+ type FieldType int

+ const GeoField

+ const NumericField

+ const TagField

+ const TextField

+ type Flag uint64

+ const DefaultNum

+ const DefaultOffset

+ const QueryInOrder

+ const QueryNoContent

+ const QueryVerbatim

+ const QueryWithPayloads

+ const QueryWithScores

+ type HighlightOptions struct

+ Fields []string

+ Tags [2]string

+ type IndexInfo struct

+ BytesPerRecordAvg float64

+ DocCount uint64

+ DocTableSizeMB float64

+ InvertedIndexSizeMB float64

+ KeyTableSizeMB float64

+ MaxDocID uint64

+ Name string

+ OffsetBitsPerTermAvg float64

+ OffsetVectorSizeMB float64

+ OffsetsPerTermAvg float64

+ RecordCount uint64

+ RecordsPerDocAvg float64

+ Schema Schema

+ TermCount uint64

+ type IndexingOptions struct

+ Language string

+ NoSave bool

+ Partial bool

+ Replace bool

+ type MultiError []error

+ func NewMultiError(len int) MultiError

+ func (e MultiError) Error() string

+ type MultiHostPool struct

+ func NewMultiHostPool(hosts []string) *MultiHostPool

+ func (p *MultiHostPool) Get() redis.Conn

+ type NumericFieldOptions struct

+ NoIndex bool

+ Sortable bool

+ type Operator string

+ const Between

+ const BetweenInclusive

+ const Eq

+ const Gt

+ const Gte

+ const Lt

+ const Lte

+ type Options struct

+ NoFieldFlags bool

+ NoFrequencies bool

+ NoOffsetVectors bool

+ NoSave bool

+ Stopwords []string

+ type Paging struct

+ Num int

+ Offset int

+ type Predicate struct

+ Operator Operator

+ Property string

+ Value []interface{}

+ func Equals(property string, value interface{}) Predicate

+ func GreaterThan(property string, value interface{}) Predicate

+ func GreaterThanEquals(property string, value interface{}) Predicate

+ func InRange(property string, min, max interface{}, inclusive bool) Predicate

+ func LessThan(property string, value interface{}) Predicate

+ func LessThanEquals(property string, value interface{}) Predicate

+ func NewPredicate(property string, operator Operator, values ...interface{}) Predicate

+ type Query struct

+ Expander string

+ Filters []Predicate

+ Flags Flag

+ HighlightOpts *HighlightOptions

+ InKeys []string

+ Language string

+ Paging Paging

+ Payload []byte

+ Raw string

+ ReturnFields []string

+ Scorer string

+ Slop int

+ SortBy *SortingKey

+ SummarizeOpts *SummaryOptions

+ func NewQuery(raw string) *Query

+ func (q *Query) Highlight(fields []string, openTag, closeTag string) *Query

+ func (q *Query) Limit(offset, num int) *Query

+ func (q *Query) SetExpander(exp string) *Query

+ func (q *Query) SetFlags(flags Flag) *Query

+ func (q *Query) SetInKeys(keys ...string) *Query

+ func (q *Query) SetLanguage(lang string) *Query

+ func (q *Query) SetPayload(payload []byte) *Query

+ func (q *Query) SetReturnFields(fields ...string) *Query

+ func (q *Query) SetScorer(scorer string) *Query

+ func (q *Query) SetSortBy(field string, ascending bool) *Query

+ func (q *Query) Summarize(fields ...string) *Query

+ func (q *Query) SummarizeOptions(opts SummaryOptions) *Query

+ type Schema struct

+ Fields []Field

+ Options Options

+ func NewSchema(opts Options) *Schema

+ func (m *Schema) AddField(f Field) *Schema

+ type SingleHostPool struct

+ func NewSingleHostPool(host string) *SingleHostPool

+ type SortingKey struct

+ Ascending bool

+ Field string

+ type SuggestOptions struct

+ Fuzzy bool

+ Num int

+ WithPayloads bool

+ WithScores bool

+ type Suggestion struct

+ Payload string

+ Score float64

+ Term string

+ type SuggestionList []Suggestion

+ 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 SummaryOptions struct

+ Fields []string

+ FragmentLen int

+ NumFragments int

+ Separator string

+ type TagFieldOptions struct

+ NoIndex bool

+ Separator byte

+ Sortable bool

+ type TextFieldOptions struct

+ NoIndex bool

+ NoStem bool

+ Sortable bool

+ Weight float32

Other modules containing this package

github.com/RediSearch/redisearch-go/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL