Modulehedis-0.16.4Haskell2010
Database.Redis.ManualCommands.FT
- 44 types
- 85 values
- Packagehedis-0.16.4
- Exports129
- LanguageHaskell2010
- LicenceBSD-3-Clause
- SourceFT.hs
Instances3Eq, Show, RedisArg
Eq FTIndexAllModeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTIndexAllModeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTRedisArg FTIndexAllModeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTFieldIdentifierDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTFieldIdentifierDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTSortableDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTSortableDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTCommonFieldOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTCommonFieldOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTTextFieldOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTTextFieldOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTTagFieldOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTTagFieldOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTGeoShapeFieldOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTGeoShapeFieldOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTVectorFieldOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTVectorFieldOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
FTCreateTextField FTFieldIdentifier FTTextFieldOptsFTCreateTagField FTFieldIdentifier FTTagFieldOptsFTCreateNumericField FTFieldIdentifier FTCommonFieldOptsFTCreateGeoField FTFieldIdentifier FTCommonFieldOptsFTCreateGeoShapeField FTFieldIdentifier FTGeoShapeFieldOptsFTCreateVectorField FTFieldIdentifier FTVectorFieldOpts
Instances2Eq, Show
Eq FTCreateFieldDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTCreateFieldDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
FTCreateOptsftCreateOn :: Maybe FTOnftCreateIndexAll :: Maybe FTIndexAllModeftCreatePrefixes :: [ByteString]ftCreateFilter :: Maybe ByteStringftCreateLanguage :: Maybe ByteStringftCreateLanguageField :: Maybe ByteStringftCreateScore :: Maybe DoubleftCreateScoreField :: Maybe ByteStringftCreatePayloadField :: Maybe ByteStringftCreateMaxTextFields :: BoolftCreateTemporarySeconds :: Maybe DoubleftCreateNoOffsets :: BoolftCreateNoHl :: BoolftCreateNoFields :: BoolftCreateNoFreqs :: BoolftCreateStopwords :: Maybe [ByteString]ftCreateSkipInitialScan :: Bool
Instances2Eq, Show
Eq FTCreateOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTCreateOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTAlterOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTAlterOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTExplainOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTExplainOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTSearchContentModeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTSearchContentModeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTSearchScoreModeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTSearchScoreModeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTSearchPayloadModeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTSearchPayloadModeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTSearchSortKeysModeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTSearchSortKeysModeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTReturnFieldDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTReturnFieldDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTSummarizeOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTSummarizeOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTHighlightOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTHighlightOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTNumericFilterDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTNumericFilterDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTGeoFilterDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTGeoFilterDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Constructors
FTSearchOptsftSearchContentMode :: FTSearchContentModeftSearchVerbatim :: BoolftSearchNoStopWords :: BoolftSearchScoreMode :: FTSearchScoreModeftSearchPayloadMode :: FTSearchPayloadModeftSearchSortKeysMode :: FTSearchSortKeysModeftSearchNumericFilters :: [FTNumericFilter]ftSearchGeoFilters :: [FTGeoFilter]ftSearchInKeys :: [ByteString]ftSearchInFields :: [ByteString]ftSearchReturnFields :: [FTReturnField]ftSearchSummarize :: Maybe FTSummarizeOptsftSearchHighlight :: Maybe FTHighlightOptsftSearchSlop :: Maybe IntegerftSearchTimeout :: Maybe IntegerftSearchInOrder :: BoolftSearchLanguage :: Maybe ByteStringftSearchExpander :: Maybe ByteStringftSearchScorer :: Maybe ByteStringftSearchPayload :: Maybe ByteStringftSearchSortBy :: Maybe FTSortByftSearchLimit :: Maybe (Integer, Integer)ftSearchParams :: [(ByteString, ByteString)]ftSearchDialect :: Maybe Integer
Instances2Eq, Show
Eq FTSearchOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTSearchOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTAggregateLoadDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTAggregateLoadDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTSortPropertyDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTSortPropertyDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Constructors
Constructors
Constructors
Instances2Eq, Show
Eq FTCursorOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTCursorOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
FTAggregateOptsftAggregateVerbatim :: BoolftAggregateLoad :: Maybe FTAggregateLoadftAggregateTimeout :: Maybe IntegerftAggregateGroupBy :: [FTGroupBy]ftAggregateSortBy :: Maybe (NonEmpty FTSortProperty, Maybe Integer)ftAggregateApply :: [FTApply]ftAggregateLimit :: Maybe (Integer, Integer)ftAggregateFilter :: Maybe ByteStringftAggregateCursor :: Maybe FTCursorOptsftAggregateParams :: [(ByteString, ByteString)]ftAggregateDialect :: Maybe Integer
Instances2Eq, Show
Eq FTAggregateOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTAggregateOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTHybridSearchClauseDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTHybridSearchClauseDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTHybridVectorQueryDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTHybridVectorQueryDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTHybridVSimClauseDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTHybridVSimClauseDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTHybridCombineDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTHybridCombineDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTHybridSortDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTHybridSortDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTHybridLoadDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTHybridLoadDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
FTHybridOptsftHybridCombine :: Maybe FTHybridCombineftHybridLimit :: Maybe (Integer, Integer)ftHybridSorting :: Maybe FTHybridSortftHybridParams :: [(ByteString, ByteString)]ftHybridTimeout :: Maybe IntegerftHybridFormat :: Maybe ByteStringftHybridLoad :: Maybe FTHybridLoadftHybridGroupBy :: [FTGroupBy]ftHybridApply :: [FTApply]ftHybridFilter :: Maybe ByteStringftHybridDialect :: Maybe Integer
Instances2Eq, Show
Eq FTHybridOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTHybridOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances3Eq, Show, RedisArg
Eq FTProfileQueryTypeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTProfileQueryTypeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTRedisArg FTProfileQueryTypeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTProfileOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTProfileOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTSpellcheckTermsModeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTSpellcheckTermsModeDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTSpellcheckOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTSpellcheckOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Instances2Eq, Show
Eq FTSugAddOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTSugAddOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Constructors
Instances2Eq, Show
Eq FTCursorReadOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FTShow FTCursorReadOptsDefined in hedis-0.16.4 · Database.Redis.ManualCommands.FT
Returns a list of all existing indexes (https://redis.io/commands/ft._list).
O(1)
Since RediSearch 2.0.0
Run a search query on an index and perform aggregate transformations on the results (https://redis.io/commands/ft.aggregate).
The reply shape varies with options such as WITHCURSOR, so this wrapper returns the raw Reply.
O(1)
Since RediSearch 1.1.0
ftAggregateOpts :: RedisCtx m f=> ByteStringIndex name.
-> ByteStringQuery string.
-> FTAggregateOptsAggregate options and transformation steps.
-> m (f Reply)
Run a search query on an index and perform aggregate transformations on the results (https://redis.io/commands/ft.aggregate).
The reply shape varies with options such as WITHCURSOR, so this wrapper returns the raw Reply.
O(1)
Since RediSearch 1.1.0
Adds or updates an alias to the index (https://redis.io/commands/ft.aliasupdate).
O(1)
Since RediSearch 1.0.0
ftAlter :: RedisCtx m f=> ByteStringIndex name.
-> FTCreateFieldField definition to append to the schema.
-> m (f Status)
Adds a new field to the index (https://redis.io/commands/ft.alter).
O(N) where N is the number of keys in the keyspace
Since RediSearch 1.0.0
ftAlterOpts :: RedisCtx m f=> ByteStringIndex name.
-> FTCreateFieldField definition to append to the schema.
-> FTAlterOptsAlter options.
-> m (f Status)
Adds a new field to the index (https://redis.io/commands/ft.alter).
O(N) where N is the number of keys in the keyspace
Since RediSearch 1.0.0
Sets runtime configuration options (https://redis.io/commands/ft.config-set).
O(1)
Since RediSearch 1.0.0
Retrieves runtime configuration options (https://redis.io/commands/ft.config-get).
The server returns an option-dependent reply payload, so this wrapper returns the raw Reply.
O(1)
Since RediSearch 1.0.0
ftCreate :: RedisCtx m f=> ByteStringIndex name.
-> NonEmpty FTCreateFieldSchema field definitions.
-> m (f Status)
Creates an index with the given spec (https://redis.io/commands/ft.create).
O(K) at creation where K is the number of fields, O(N) if scanning the keyspace is triggered, where N is the number of keys in the keyspace
Since RediSearch 1.0.0
ftCreateOpts :: RedisCtx m f=> ByteStringIndex name.
-> NonEmpty FTCreateFieldSchema field definitions.
-> FTCreateOptsIndex creation options.
-> m (f Status)
Creates an index with the given spec (https://redis.io/commands/ft.create).
O(K) at creation where K is the number of fields, O(N) if scanning the keyspace is triggered, where N is the number of keys in the keyspace
Since RediSearch 1.0.0
Reads from a cursor (https://redis.io/commands/ft.cursor-read).
The cursor batch payload is command-dependent, so this wrapper returns the raw Reply.
O(1)
Since RediSearch 1.1.0
ftCursorReadOpts :: RedisCtx m f=> ByteStringIndex name.
-> IntegerCursor identifier.
-> FTCursorReadOptsCursor read options.
-> m (f Reply)
Reads from a cursor (https://redis.io/commands/ft.cursor-read).
The cursor batch payload is command-dependent, so this wrapper returns the raw Reply.
O(1)
Since RediSearch 1.1.0
ftDictAdd :: RedisCtx m f=> ByteStringDictionary name.
-> NonEmpty ByteStringTerms to add.
-> m (f Integer)
ftDictDel :: RedisCtx m f=> ByteStringDictionary name.
-> NonEmpty ByteStringTerms to delete.
-> m (f Integer)
Deletes the index (https://redis.io/commands/ft.dropindex).
O(1) or O(N) if documents are deleted, where N is the number of keys in the keyspace
Since RediSearch 2.0.0
Deletes the index (https://redis.io/commands/ft.dropindex).
This variant also deletes indexed documents.
O(1) or O(N) if documents are deleted, where N is the number of keys in the keyspace
Since RediSearch 2.0.0
Returns the execution plan for a complex query (https://redis.io/commands/ft.explain).
O(1)
Since RediSearch 1.0.0
ftExplainOpts :: RedisCtx m f=> ByteStringIndex name.
-> ByteStringQuery string.
-> FTExplainOptsExplain options.
-> m (f ByteString)
Returns the execution plan for a complex query (https://redis.io/commands/ft.explain).
O(1)
Since RediSearch 1.0.0
ftHybrid :: RedisCtx m f=> ByteStringIndex name.
-> FTHybridSearchClauseTextual search clause.
-> FTHybridVSimClauseVector similarity clause.
-> m (f Reply)
Performs hybrid search combining text search and vector similarity with configurable fusion methods (https://redis.io/commands/ft.hybrid).
The reply shape depends on requested projections and scoring options, so this wrapper returns the raw Reply.
O(N)
Since Redis Open Source 8.4.0
ftHybridOpts :: RedisCtx m f=> ByteStringIndex name.
-> FTHybridSearchClauseTextual search clause.
-> FTHybridVSimClauseVector similarity clause.
-> FTHybridOptsHybrid query options.
-> m (f Reply)
Performs hybrid search combining text search and vector similarity with configurable fusion methods (https://redis.io/commands/ft.hybrid).
The reply shape depends on requested projections and scoring options, so this wrapper returns the raw Reply.
O(N)
Since Redis Open Source 8.4.0
Returns information and statistics on the index (https://redis.io/commands/ft.info).
The response is a heterogeneous attribute map, so this wrapper returns the raw Reply.
O(1)
Since RediSearch 1.0.0
ftProfile :: RedisCtx m f=> ByteStringIndex name.
-> FTProfileQueryTypeWrapped query type.
-> ByteStringQuery payload for the wrapped command.
-> m (f Reply)
Performs a FT.SEARCH or FT.AGGREGATE command and collects performance information (https://redis.io/commands/ft.profile).
The profiled reply depends on the wrapped query type, so this wrapper returns the raw Reply.
O(N)
Since RediSearch 2.2.0
ftProfileOpts :: RedisCtx m f=> ByteStringIndex name.
-> FTProfileQueryTypeWrapped query type.
-> ByteStringQuery payload for the wrapped command.
-> FTProfileOptsProfiling options.
-> m (f Reply)
Performs a FT.SEARCH or FT.AGGREGATE command and collects performance information (https://redis.io/commands/ft.profile).
The profiled reply depends on the wrapped query type, so this wrapper returns the raw Reply.
O(N)
Since RediSearch 2.2.0
Searches the index with a textual query, returning either documents or just ids (https://redis.io/commands/ft.search).
The reply shape depends on output flags such as NOCONTENT and WITHSCORES, so this wrapper returns the raw Reply.
O(N)
Since RediSearch 1.0.0
ftSearchOpts :: RedisCtx m f=> ByteStringIndex name.
-> ByteStringQuery string.
-> FTSearchOptsSearch options.
-> m (f Reply)
Searches the index with a textual query, returning either documents or just ids (https://redis.io/commands/ft.search).
The reply shape depends on output flags such as NOCONTENT and WITHSCORES, so this wrapper returns the raw Reply.
O(N)
Since RediSearch 1.0.0
Performs spelling correction on a query, returning suggestions for misspelled terms (https://redis.io/commands/ft.spellcheck).
The response contains nested suggestions, so this wrapper returns the raw Reply.
O(1)
Since RediSearch 1.4.0
ftSpellcheckOpts :: RedisCtx m f=> ByteStringIndex name.
-> ByteStringQuery string.
-> FTSpellcheckOptsSpellcheck options.
-> m (f Reply)
Performs spelling correction on a query, returning suggestions for misspelled terms (https://redis.io/commands/ft.spellcheck).
The response contains nested suggestions, so this wrapper returns the raw Reply.
O(1)
Since RediSearch 1.4.0
ftSugAdd :: RedisCtx m f=> ByteStringSuggestion dictionary key.
-> ByteStringSuggestion string.
-> DoubleSuggestion score.
-> m (f Integer)
Adds a suggestion string to an auto-complete suggestion dictionary (https://redis.io/commands/ft.sugadd).
O(1)
Since RediSearch 1.0.0
ftSugAddOpts :: RedisCtx m f=> ByteStringSuggestion dictionary key.
-> ByteStringSuggestion string.
-> DoubleSuggestion score.
-> FTSugAddOptsSuggestion insertion options.
-> m (f Integer)
Adds a suggestion string to an auto-complete suggestion dictionary (https://redis.io/commands/ft.sugadd).
O(1)
Since RediSearch 1.0.0
ftSugDel :: RedisCtx m f=> ByteStringSuggestion dictionary key.
-> ByteStringSuggestion string.
-> m (f Integer)
Deletes a string from a suggestion index (https://redis.io/commands/ft.sugdel).
O(1)
Since RediSearch 1.0.0
Gets the size of an auto-complete suggestion dictionary (https://redis.io/commands/ft.suglen).
O(1)
Since RediSearch 1.0.0
ftTagVals :: RedisCtx m f=> ByteStringIndex name.
-> ByteStringTag field name.
-> m (f [ByteString])
Returns the distinct tags indexed in a Tag field (https://redis.io/commands/ft.tagvals).
O(n) where n is the number of distinct tags in the field
Since RediSearch 1.0.0