redisearch

package module
v0.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 16, 2023 License: MIT Imports: 15 Imported by: 13

README

codecov

Documentation

Index

Constants

View Source 
const (
	RedisSearchNullNumber     = -math.MaxInt64
	RedisSearchIndexerChannel = "orm-redis-search-channel"
)

Variables

This section is empty.

Functions

func EscapeRedisSearchString 

func EscapeRedisSearchString(val string) string

func GetEntityIDs 

func GetEntityIDs(redisSearch *RedisSearchEngine, index string, q *RedisSearchQuery, pager *beeorm.Pager) ([]uint64, uint64)

Types

type AggregateReduce 

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

func NewAggregateReduceAvg 

func NewAggregateReduceAvg(property, alias string) AggregateReduce

func NewAggregateReduceCount 

func NewAggregateReduceCount(alias string) AggregateReduce

func NewAggregateReduceCountDistinct 

func NewAggregateReduceCountDistinct(property, alias string, distinctish bool) AggregateReduce

func NewAggregateReduceFirstValue 

func NewAggregateReduceFirstValue(property, alias string) AggregateReduce

func NewAggregateReduceFirstValueBy 

func NewAggregateReduceFirstValueBy(property, byProperty, alias string, desc bool) AggregateReduce

func NewAggregateReduceMax 

func NewAggregateReduceMax(property, alias string) AggregateReduce

func NewAggregateReduceMin 

func NewAggregateReduceMin(property, alias string) AggregateReduce

func NewAggregateReduceQuantile 

func NewAggregateReduceQuantile(property, quantile, alias string) AggregateReduce

func NewAggregateReduceRandomSample 

func NewAggregateReduceRandomSample(property, alias string, size ...int) AggregateReduce

func NewAggregateReduceStdDev 

func NewAggregateReduceStdDev(property, alias string) AggregateReduce

func NewAggregateReduceSum 

func NewAggregateReduceSum(property, alias string) AggregateReduce

func NewAggregateReduceToList 

func NewAggregateReduceToList(property, alias string) AggregateReduce

type BeeormRedisearchPlugin 

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

func Init 

func Init(pool string) *BeeormRedisearchPlugin

func (*BeeormRedisearchPlugin) GetCode 

func (p *BeeormRedisearchPlugin) GetCode() string

func (*BeeormRedisearchPlugin) InterfaceInitEntitySchema 

func (p *BeeormRedisearchPlugin) InterfaceInitEntitySchema(schema beeorm.SettableEntitySchema, registry *beeorm.Registry) error

nolint //Function has too many statements

func (*BeeormRedisearchPlugin) PluginInterfaceEntityFlushed 

func (p *BeeormRedisearchPlugin) PluginInterfaceEntityFlushed(
	engine beeorm.Engine,
	event beeorm.EventEntityFlushed,
	setter beeorm.FlusherCacheSetter,
)

func (*BeeormRedisearchPlugin) RegisterCustomIndex 

func (p *BeeormRedisearchPlugin) RegisterCustomIndex(customIndex *RedisSearchIndex)

type IndexerEventRedisearch added in v0.0.2 

type IndexerEventRedisearch struct {
	Index string
}

type LoadFields 

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

func (*LoadFields) AddField 

func (lf *LoadFields) AddField(field string)

func (*LoadFields) AddFieldWithAlias 

func (lf *LoadFields) AddFieldWithAlias(field, alias string)

type RedisSearchAggregation 

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

func (*RedisSearchAggregation) Apply 

func (a *RedisSearchAggregation) Apply(expression, alias string) *RedisSearchAggregation

func (*RedisSearchAggregation) Filter 

func (a *RedisSearchAggregation) Filter(expression string) *RedisSearchAggregation

func (*RedisSearchAggregation) GroupByField 

func (a *RedisSearchAggregation) GroupByField(field string, reduce ...AggregateReduce) *RedisSearchAggregation

func (*RedisSearchAggregation) GroupByFields 

func (a *RedisSearchAggregation) GroupByFields(fields []string, reduce ...AggregateReduce) *RedisSearchAggregation

func (*RedisSearchAggregation) Load 

func (a *RedisSearchAggregation) Load(fields *LoadFields) *RedisSearchAggregation

func (*RedisSearchAggregation) LoadAll 

func (a *RedisSearchAggregation) LoadAll() *RedisSearchAggregation

func (*RedisSearchAggregation) Sort 

func (a *RedisSearchAggregation) Sort(fields ...RedisSearchAggregationSort) *RedisSearchAggregation

type RedisSearchAggregationSort 

type RedisSearchAggregationSort struct {
	Field string
	Desc  bool
}

type RedisSearchEngine added in v0.0.5 

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

func NewRedisSearch 

func NewRedisSearch(ctx context.Context, engine beeorm.Engine, pool string) *RedisSearchEngine

func (*RedisSearchEngine) Aggregate added in v0.0.5 

func (r *RedisSearchEngine) Aggregate(
	index string,
	query *RedisSearchAggregation,
	pager *beeorm.Pager,
) (result []map[string]string, totalRows uint64)

func (*RedisSearchEngine) ForceReindex added in v0.0.5 

func (r *RedisSearchEngine) ForceReindex(index string)

func (*RedisSearchEngine) GetPoolConfig added in v0.0.5 

func (r *RedisSearchEngine) GetPoolConfig() beeorm.RedisPoolConfig

func (*RedisSearchEngine) GetRedisSearchAlters added in v0.0.5 

func (r *RedisSearchEngine) GetRedisSearchAlters() (alters []RedisSearchIndexAlter)

nolint //Function has too many statements

func (*RedisSearchEngine) GetRedisSearchIndex added in v0.0.5 

func (r *RedisSearchEngine) GetRedisSearchIndex(indexName string) *RedisSearchIndex

func (*RedisSearchEngine) GetRedisSearchStatistics added in v0.0.5 

func (r *RedisSearchEngine) GetRedisSearchStatistics() []*RedisSearchStatistics

func (*RedisSearchEngine) HandleRedisIndexerEvent added in v0.0.5 

func (r *RedisSearchEngine) HandleRedisIndexerEvent(indexName string)

HandleRedisIndexerEvent : put this in your consumer from stream "RedisSearchIndexerChannel"

func (*RedisSearchEngine) Info added in v0.0.5 

func (r *RedisSearchEngine) Info(indexName string) *RedisSearchIndexInfo

nolint //Function has too many statements

func (*RedisSearchEngine) ListIndices added in v0.0.5 

func (r *RedisSearchEngine) ListIndices() []string

func (*RedisSearchEngine) RedisSearch added in v0.0.5 

func (r *RedisSearchEngine) RedisSearch(
	query *RedisSearchQuery,
	pager *beeorm.Pager,
	entities interface{},
	references ...string,
) (totalRows uint64)

func (*RedisSearchEngine) RedisSearchAggregate added in v0.0.5 

func (r *RedisSearchEngine) RedisSearchAggregate(
	entity beeorm.Entity,
	query *RedisSearchAggregation,
	pager *beeorm.Pager,
) (result []map[string]string, totalRows uint64)

func (*RedisSearchEngine) RedisSearchCount added in v0.0.5 

func (r *RedisSearchEngine) RedisSearchCount(entity beeorm.Entity, query *RedisSearchQuery) (totalRows uint64)

func (*RedisSearchEngine) RedisSearchIds added in v0.0.5 

func (r *RedisSearchEngine) RedisSearchIds(entity beeorm.Entity, query *RedisSearchQuery, pager *beeorm.Pager) (ids []uint64, totalRows uint64)

func (*RedisSearchEngine) RedisSearchOne added in v0.0.5 

func (r *RedisSearchEngine) RedisSearchOne(entity beeorm.Entity, query *RedisSearchQuery, references ...string) (found bool)

func (*RedisSearchEngine) SearchCount added in v0.0.5 

func (r *RedisSearchEngine) SearchCount(index string, query *RedisSearchQuery) uint64

func (*RedisSearchEngine) SearchKeys added in v0.0.5 

func (r *RedisSearchEngine) SearchKeys(index string, query *RedisSearchQuery, pager *beeorm.Pager) (total uint64, keys []string)

func (*RedisSearchEngine) SearchRaw added in v0.0.5 

func (r *RedisSearchEngine) SearchRaw(index string, query *RedisSearchQuery, pager *beeorm.Pager) (total uint64, rows []interface{})

func (*RedisSearchEngine) SearchResult added in v0.0.5 

func (r *RedisSearchEngine) SearchResult(index string, query *RedisSearchQuery, pager *beeorm.Pager) (total uint64, rows []*RedisSearchResult)

type RedisSearchIndex 

type RedisSearchIndex struct {
	Name            string
	RedisPool       string
	Prefixes        []string
	DefaultLanguage string
	LanguageField   string
	DefaultScore    float64
	ScoreField      string
	MaxTextFields   bool
	NoOffsets       bool
	NoNHL           bool
	NoFields        bool
	NoFreqs         bool
	SkipInitialScan bool
	StopWords       []string
	Fields          []RedisSearchIndexField
	Indexer         RedisSearchIndexerFunc `json:"-"`
}

func (*RedisSearchIndex) AddGeoField 

func (rs *RedisSearchIndex) AddGeoField(name string, sortable, noindex bool)

func (*RedisSearchIndex) AddNumericField 

func (rs *RedisSearchIndex) AddNumericField(name string, sortable, noindex bool)

func (*RedisSearchIndex) AddTagField 

func (rs *RedisSearchIndex) AddTagField(name string, sortable, noindex bool, separator string)

func (*RedisSearchIndex) AddTextField 

func (rs *RedisSearchIndex) AddTextField(name string, weight float64, sortable, noindex, nostem bool)

type RedisSearchIndexAlter 

type RedisSearchIndexAlter struct {
	Name      string
	Query     string
	Documents uint64
	Changes   []string
	Pool      string
	Execute   func()
	// contains filtered or unexported fields
}

type RedisSearchIndexField 

type RedisSearchIndexField struct {
	Type         string
	Name         string
	Sortable     bool
	NoIndex      bool
	NoStem       bool
	Weight       float64
	TagSeparator string
}

type RedisSearchIndexInfo 

type RedisSearchIndexInfo struct {
	Name                     string
	Options                  RedisSearchIndexInfoOptions
	Definition               RedisSearchIndexInfoDefinition
	Fields                   []RedisSearchIndexInfoField
	NumDocs                  uint64
	MaxDocID                 uint64
	NumTerms                 uint64
	NumRecords               uint64
	InvertedSzMB             float64
	TotalInvertedIndexBlocks float64
	OffsetVectorsSzMB        float64
	DocTableSizeMB           float64
	SortableValuesSizeMB     float64
	KeyTableSizeMB           float64
	RecordsPerDocAvg         int
	BytesPerRecordAvg        int
	OffsetsPerTermAvg        float64
	OffsetBitsPerRecordAvg   float64
	HashIndexingFailures     uint64
	Indexing                 bool
	PercentIndexed           float64
	StopWords                []string
}

type RedisSearchIndexInfoDefinition 

type RedisSearchIndexInfoDefinition struct {
	KeyType       string
	Prefixes      []string
	LanguageField string
	ScoreField    string
	DefaultScore  float64
}

type RedisSearchIndexInfoField 

type RedisSearchIndexInfoField struct {
	Name         string
	Type         string
	Weight       float64
	Sortable     bool
	NoStem       bool
	NoIndex      bool
	TagSeparator string
}

type RedisSearchIndexInfoOptions 

type RedisSearchIndexInfoOptions struct {
	NoFreqs       bool
	NoOffsets     bool
	NoFields      bool
	MaxTextFields bool
}

type RedisSearchIndexPusher 

type RedisSearchIndexPusher interface {
	NewDocument(key string)
	DeleteDocuments(key ...string)
	SetString(key string, value string)
	SetTag(key string, tag ...string)
	SetUint(key string, value uint64)
	SetInt(key string, value int64)
	SetIntNil(key string)
	SetFloat(key string, value float64)
	SetBool(key string, value bool)
	SetGeo(key string, lon float64, lat float64)
	PushDocument()
	Flush()
	// contains filtered or unexported methods
}

func NewRedisSearchIndexPusher 

func NewRedisSearchIndexPusher(ormService beeorm.Engine, pool string) RedisSearchIndexPusher

type RedisSearchIndexerFunc 

type RedisSearchIndexerFunc func(engine beeorm.Engine, lastID uint64, pusher RedisSearchIndexPusher) (newID uint64, hasMore bool)

type RedisSearchQuery 

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

func NewRedisSearchQuery 

func NewRedisSearchQuery() *RedisSearchQuery

func (*RedisSearchQuery) Aggregate 

func (q *RedisSearchQuery) Aggregate() *RedisSearchAggregation

func (*RedisSearchQuery) AppendQueryRaw 

func (q *RedisSearchQuery) AppendQueryRaw(query string) *RedisSearchQuery

func (*RedisSearchQuery) ExplainScore 

func (q *RedisSearchQuery) ExplainScore() *RedisSearchQuery

func (*RedisSearchQuery) FilterBool 

func (q *RedisSearchQuery) FilterBool(field string, value bool) *RedisSearchQuery

func (*RedisSearchQuery) FilterDate 

func (q *RedisSearchQuery) FilterDate(field string, date time.Time) *RedisSearchQuery

func (*RedisSearchQuery) FilterDateGreater 

func (q *RedisSearchQuery) FilterDateGreater(field string, date time.Time) *RedisSearchQuery

func (*RedisSearchQuery) FilterDateGreaterEqual 

func (q *RedisSearchQuery) FilterDateGreaterEqual(field string, date time.Time) *RedisSearchQuery

func (*RedisSearchQuery) FilterDateLess 

func (q *RedisSearchQuery) FilterDateLess(field string, date time.Time) *RedisSearchQuery

func (*RedisSearchQuery) FilterDateLessEqual 

func (q *RedisSearchQuery) FilterDateLessEqual(field string, date time.Time) *RedisSearchQuery

func (*RedisSearchQuery) FilterDateMinMax 

func (q *RedisSearchQuery) FilterDateMinMax(field string, min, max time.Time) *RedisSearchQuery

func (*RedisSearchQuery) FilterDateNull 

func (q *RedisSearchQuery) FilterDateNull(field string) *RedisSearchQuery

func (*RedisSearchQuery) FilterDateTime 

func (q *RedisSearchQuery) FilterDateTime(field string, date time.Time) *RedisSearchQuery

func (*RedisSearchQuery) FilterDateTimeGreater 

func (q *RedisSearchQuery) FilterDateTimeGreater(field string, date time.Time) *RedisSearchQuery

func (*RedisSearchQuery) FilterDateTimeGreaterEqual 

func (q *RedisSearchQuery) FilterDateTimeGreaterEqual(field string, date time.Time) *RedisSearchQuery

func (*RedisSearchQuery) FilterDateTimeLess 

func (q *RedisSearchQuery) FilterDateTimeLess(field string, date time.Time) *RedisSearchQuery

func (*RedisSearchQuery) FilterDateTimeLessEqual 

func (q *RedisSearchQuery) FilterDateTimeLessEqual(field string, date time.Time) *RedisSearchQuery

func (*RedisSearchQuery) FilterDateTimeMinMax 

func (q *RedisSearchQuery) FilterDateTimeMinMax(field string, min, max time.Time) *RedisSearchQuery

func (*RedisSearchQuery) FilterDateTimeNull 

func (q *RedisSearchQuery) FilterDateTimeNull(field string) *RedisSearchQuery

func (*RedisSearchQuery) FilterFloat 

func (q *RedisSearchQuery) FilterFloat(field string, value ...float64) *RedisSearchQuery

func (*RedisSearchQuery) FilterFloatGreater 

func (q *RedisSearchQuery) FilterFloatGreater(field string, value float64) *RedisSearchQuery

func (*RedisSearchQuery) FilterFloatGreaterEqual 

func (q *RedisSearchQuery) FilterFloatGreaterEqual(field string, value float64) *RedisSearchQuery

func (*RedisSearchQuery) FilterFloatLess 

func (q *RedisSearchQuery) FilterFloatLess(field string, value float64) *RedisSearchQuery

func (*RedisSearchQuery) FilterFloatLessEqual 

func (q *RedisSearchQuery) FilterFloatLessEqual(field string, value float64) *RedisSearchQuery

func (*RedisSearchQuery) FilterFloatMinMax 

func (q *RedisSearchQuery) FilterFloatMinMax(field string, min, max float64) *RedisSearchQuery

func (*RedisSearchQuery) FilterFloatNull 

func (q *RedisSearchQuery) FilterFloatNull(field string) *RedisSearchQuery

func (*RedisSearchQuery) FilterGeo 

func (q *RedisSearchQuery) FilterGeo(field string, lon, lat, radius float64, unit string) *RedisSearchQuery

func (*RedisSearchQuery) FilterInt 

func (q *RedisSearchQuery) FilterInt(field string, value ...int64) *RedisSearchQuery

func (*RedisSearchQuery) FilterIntGreater 

func (q *RedisSearchQuery) FilterIntGreater(field string, value int64) *RedisSearchQuery

func (*RedisSearchQuery) FilterIntGreaterEqual 

func (q *RedisSearchQuery) FilterIntGreaterEqual(field string, value int64) *RedisSearchQuery

func (*RedisSearchQuery) FilterIntLess 

func (q *RedisSearchQuery) FilterIntLess(field string, value int64) *RedisSearchQuery

func (*RedisSearchQuery) FilterIntLessEqual 

func (q *RedisSearchQuery) FilterIntLessEqual(field string, value int64) *RedisSearchQuery

func (*RedisSearchQuery) FilterIntMinMax 

func (q *RedisSearchQuery) FilterIntMinMax(field string, min, max int64) *RedisSearchQuery

func (*RedisSearchQuery) FilterIntNull 

func (q *RedisSearchQuery) FilterIntNull(field string) *RedisSearchQuery

func (*RedisSearchQuery) FilterManyReferenceIn 

func (q *RedisSearchQuery) FilterManyReferenceIn(field string, id ...uint64) *RedisSearchQuery

func (*RedisSearchQuery) FilterManyReferenceNotIn 

func (q *RedisSearchQuery) FilterManyReferenceNotIn(field string, id ...uint64) *RedisSearchQuery

func (*RedisSearchQuery) FilterNotDate 

func (q *RedisSearchQuery) FilterNotDate(field string, date time.Time) *RedisSearchQuery

func (*RedisSearchQuery) FilterNotDateNull 

func (q *RedisSearchQuery) FilterNotDateNull(field string) *RedisSearchQuery

func (*RedisSearchQuery) FilterNotInt 

func (q *RedisSearchQuery) FilterNotInt(field string, value ...int64) *RedisSearchQuery

func (*RedisSearchQuery) FilterNotIntNull 

func (q *RedisSearchQuery) FilterNotIntNull(field string) *RedisSearchQuery

func (*RedisSearchQuery) FilterNotString 

func (q *RedisSearchQuery) FilterNotString(field string, value ...string) *RedisSearchQuery

func (*RedisSearchQuery) FilterNotTag 

func (q *RedisSearchQuery) FilterNotTag(field string, tag ...string) *RedisSearchQuery

func (*RedisSearchQuery) FilterString 

func (q *RedisSearchQuery) FilterString(field string, value ...string) *RedisSearchQuery

func (*RedisSearchQuery) FilterTag 

func (q *RedisSearchQuery) FilterTag(field string, tag ...string) *RedisSearchQuery

func (*RedisSearchQuery) FilterUint 

func (q *RedisSearchQuery) FilterUint(field string, value ...uint64) *RedisSearchQuery

func (*RedisSearchQuery) FilterUintGreater 

func (q *RedisSearchQuery) FilterUintGreater(field string, value uint64) *RedisSearchQuery

func (*RedisSearchQuery) FilterUintGreaterEqual 

func (q *RedisSearchQuery) FilterUintGreaterEqual(field string, value uint64) *RedisSearchQuery

func (*RedisSearchQuery) FilterUintLess 

func (q *RedisSearchQuery) FilterUintLess(field string, value uint64) *RedisSearchQuery

func (*RedisSearchQuery) FilterUintLessEqual 

func (q *RedisSearchQuery) FilterUintLessEqual(field string, value uint64) *RedisSearchQuery

func (*RedisSearchQuery) FilterUintMinMax 

func (q *RedisSearchQuery) FilterUintMinMax(field string, min, max uint64) *RedisSearchQuery

func (*RedisSearchQuery) FilterUintNull 

func (q *RedisSearchQuery) FilterUintNull(field string) *RedisSearchQuery

func (*RedisSearchQuery) Highlight 

func (q *RedisSearchQuery) Highlight(field ...string) *RedisSearchQuery

func (*RedisSearchQuery) HighlightTags 

func (q *RedisSearchQuery) HighlightTags(openTag, closeTag string) *RedisSearchQuery

func (*RedisSearchQuery) InFields 

func (q *RedisSearchQuery) InFields(field ...string) *RedisSearchQuery

func (*RedisSearchQuery) InKeys 

func (q *RedisSearchQuery) InKeys(key ...string) *RedisSearchQuery

func (*RedisSearchQuery) InOrder 

func (q *RedisSearchQuery) InOrder() *RedisSearchQuery

func (*RedisSearchQuery) Lang 

func (q *RedisSearchQuery) Lang(lang string) *RedisSearchQuery

func (*RedisSearchQuery) NoStopWords 

func (q *RedisSearchQuery) NoStopWords() *RedisSearchQuery

func (*RedisSearchQuery) Query 

func (q *RedisSearchQuery) Query(query string) *RedisSearchQuery

func (*RedisSearchQuery) QueryField 

func (q *RedisSearchQuery) QueryField(field string, value ...string) *RedisSearchQuery

func (*RedisSearchQuery) QueryFieldPrefixMatch 

func (q *RedisSearchQuery) QueryFieldPrefixMatch(field string, value ...string) *RedisSearchQuery

func (*RedisSearchQuery) QueryRaw 

func (q *RedisSearchQuery) QueryRaw(query string) *RedisSearchQuery

func (*RedisSearchQuery) Return 

func (q *RedisSearchQuery) Return(field ...string) *RedisSearchQuery

func (*RedisSearchQuery) Slop 

func (q *RedisSearchQuery) Slop(slop int) *RedisSearchQuery

func (*RedisSearchQuery) Sort 

func (q *RedisSearchQuery) Sort(field string, desc bool) *RedisSearchQuery

func (*RedisSearchQuery) Summarize 

func (q *RedisSearchQuery) Summarize(field ...string) *RedisSearchQuery

func (*RedisSearchQuery) SummarizeOptions 

func (q *RedisSearchQuery) SummarizeOptions(separator string, frags, len int) *RedisSearchQuery

func (*RedisSearchQuery) Verbatim 

func (q *RedisSearchQuery) Verbatim() *RedisSearchQuery

func (*RedisSearchQuery) WithFakeDeleteRows 

func (q *RedisSearchQuery) WithFakeDeleteRows() *RedisSearchQuery

func (*RedisSearchQuery) WithScores 

func (q *RedisSearchQuery) WithScores() *RedisSearchQuery

type RedisSearchResult 

type RedisSearchResult struct {
	Key          string
	Fields       []interface{}
	Score        float64
	ExplainScore []interface{}
}

func (*RedisSearchResult) Value 

func (r *RedisSearchResult) Value(field string) interface{}

type RedisSearchStatistics 

type RedisSearchStatistics struct {
	Index *RedisSearchIndex
	Info  *RedisSearchIndexInfo
}

Source Files

View all Source files

Directories

Path Synopsis
customindex
entity

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.