io.github.dengliming.redismodule.redisearch

类 RediSearch

java.lang.Object

org.redisson.RedissonObject

io.github.dengliming.redismodule.redisearch.RediSearch

所有已实现的接口:

org.redisson.api.RObject, org.redisson.api.RObjectAsync

public class RediSearch
extends org.redisson.RedissonObject

作者:

dengliming

字段概要

从类继承的字段 org.redisson.RedissonObject

codec, commandExecutor, name

构造器概要

构造器

构造器和说明
RediSearch(org.redisson.client.codec.Codec codec, org.redisson.command.CommandAsyncExecutor commandExecutor, String name)
RediSearch(org.redisson.command.CommandAsyncExecutor commandExecutor, String name)

方法概要

限定符和类型	方法和说明
boolean	addAlias(String alias)
org.redisson.api.RFuture<Boolean>	addAliasAsync(String alias)
int	addDict(String dictName, String... terms) Adds terms to a dictionary.
org.redisson.api.RFuture<Integer>	addDictAsync(String dictName, String... terms)
boolean	addDocument(Document document) Adds a document to the index.
boolean	addDocument(Document document, DocumentOptions options)
org.redisson.api.RFuture<Boolean>	addDocumentAsync(Document document, DocumentOptions options)
boolean	addHash(String docId, double score) Adds a document to the index from an existing HASH key in Redis.
boolean	addHash(String docId, double score, RSLanguage language)
boolean	addHash(String docId, double score, RSLanguage language, boolean replace)
org.redisson.api.RFuture<Boolean>	addHashAsync(String docId, double score, RSLanguage language, boolean replace)
int	addSuggestion(Suggestion suggestion) Adds a suggestion string to an auto-complete suggestion dictionary.
int	addSuggestion(Suggestion suggestion, boolean increment)
org.redisson.api.RFuture<Integer>	addSuggestionAsync(Suggestion suggestion, boolean increment)
long	addSynonym(String... terms) Adds a synonym group.
org.redisson.api.RFuture<Long>	addSynonymAsync(String... terms)
AggregateResult	aggregate(String query, AggregateOptions aggregateOptions) Runs a search query on an index, and performs aggregate transformations on the results.
org.redisson.api.RFuture<AggregateResult>	aggregateAsync(String query, AggregateOptions aggregateOptions)
boolean	alterIndex(Field... fields)
org.redisson.api.RFuture<Boolean>	alterIndexAsync(Field... fields)
boolean	createIndex(Schema schema) Creates an index with the given spec
boolean	createIndex(Schema schema, IndexOptions indexOptions)
org.redisson.api.RFuture<Boolean>	createIndexAsync(Schema schema, IndexOptions indexOptions)
boolean	deleteAlias(String alias)
org.redisson.api.RFuture<Boolean>	deleteAliasAsync(String alias)
int	deleteDict(String dictName, String... terms) Deletes terms from a dictionary.
org.redisson.api.RFuture<Integer>	deleteDictAsync(String dictName, String... terms)
boolean	deleteDocument(String docId) Deletes a document from the index.
boolean	deleteDocument(String docId, boolean deleteDocument)
org.redisson.api.RFuture<Boolean>	deleteDocumentAsync(String docId, boolean deleteDocument)
boolean	deleteSuggestion(String term) Deletes a string from a suggestion index.
org.redisson.api.RFuture<Boolean>	deleteSuggestionAsync(String term)
boolean	dropIndex() Deletes all the keys associated with the index.
boolean	dropIndex(boolean keepDocs)
org.redisson.api.RFuture<Boolean>	dropIndexAsync(boolean keepDocs)
List<String>	dumpDict(String dictName) Dumps all terms in the given dictionary.
org.redisson.api.RFuture<List<String>>	dumpDictAsync(String dictName)
Map<String,List<Long>>	dumpSynonyms() Dumps the contents of a synonym group.
org.redisson.api.RFuture<Map<String,List<Long>>>	dumpSynonymsAsync()
String	explain(String query)
org.redisson.api.RFuture<String>	explainAsync(String query)
Map<String,String>	getConfig(ConfigOption option)
org.redisson.api.RFuture<Map<String,String>>	getConfigAsync(ConfigOption option)
Map<String,Object>	getDocument(String docId) Returns the full contents of a document.
org.redisson.api.RFuture<Map<String,Object>>	getDocumentAsync(String docId)
List<Map<String,Object>>	getDocuments(String... docIds) Returns the full contents of multiple documents.
org.redisson.api.RFuture<List<Map<String,Object>>>	getDocumentsAsync(String... docIds)
Map<String,String>	getHelp(ConfigOption option)
org.redisson.api.RFuture<Map<String,String>>	getHelpAsync(ConfigOption option)
List<Suggestion>	getSuggestion(String prefix, SuggestionOptions options) Gets completion suggestions for a prefix.
org.redisson.api.RFuture<List<Suggestion>>	getSuggestionAsync(String prefix, SuggestionOptions options)
int	getSuggestionLength() Gets the size of an auto-complete suggestion dictionary
org.redisson.api.RFuture<Integer>	getSuggestionLengthAsync()
List<String>	getTagVals(String fieldName) Returns the distinct tags indexed in a Tag field.
org.redisson.api.RFuture<List<String>>	getTagValsAsync(String fieldName)
List<String>	listIndexes() Returns a list of all existing indexes.
org.redisson.api.RFuture<List<String>>	listIndexesAsync()
Map<String,Object>	loadIndex()
org.redisson.api.RFuture<Map<String,Object>>	loadIndexAsync()
SearchResult	search(String query, SearchOptions searchOptions) Searches the index with a textual query, returning either documents or just ids.
org.redisson.api.RFuture<SearchResult>	searchAsync(String query, SearchOptions searchOptions)
boolean	setConfig(ConfigOption option, String value)
org.redisson.api.RFuture<Boolean>	setConfigAsync(ConfigOption option, String value)
List<MisspelledTerm>	spellCheck(String query, SpellCheckOptions options) Performs spelling correction on a query, returning suggestions for misspelled terms.
org.redisson.api.RFuture<List<MisspelledTerm>>	spellCheckAsync(String query, SpellCheckOptions options)
boolean	updateAlias(String alias)
org.redisson.api.RFuture<Boolean>	updateAliasAsync(String alias)
boolean	updateSynonym(long synonymGroupId, String... terms) Updates a synonym group.
org.redisson.api.RFuture<Boolean>	updateSynonymAsync(long synonymGroupId, String... terms)

从类继承的方法 org.redisson.RedissonObject

addListener, addListener, addListenerAsync, addListenerAsync, addTrackingListener, addTrackingListenerAsync, copy, copyAsync, delete, deleteAsync, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getRawName, getRawName, getServiceManager, getSubscribeService, isExists, isExistsAsync, map, migrate, migrateAsync, move, moveAsync, prefixName, removeListener, removeListener, removeListenerAsync, removeListenerAsync, removeListenerAsync, removeTrackingListener, removeTrackingListenerAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

RediSearch

public RediSearch(org.redisson.client.codec.Codec codec,
                  org.redisson.command.CommandAsyncExecutor commandExecutor,
                  String name)

RediSearch

public RediSearch(org.redisson.command.CommandAsyncExecutor commandExecutor,
                  String name)

方法详细资料

createIndex

public boolean createIndex(Schema schema)

Creates an index with the given spec

参数:

schema -

返回:

createIndex

public boolean createIndex(Schema schema,
                           IndexOptions indexOptions)

createIndexAsync

public org.redisson.api.RFuture<Boolean> createIndexAsync(Schema schema,
                                                          IndexOptions indexOptions)

alterIndex

public boolean alterIndex(Field... fields)

alterIndexAsync

public org.redisson.api.RFuture<Boolean> alterIndexAsync(Field... fields)

dropIndex

public boolean dropIndex()

Deletes all the keys associated with the index.

返回:

dropIndex

public boolean dropIndex(boolean keepDocs)

dropIndexAsync

public org.redisson.api.RFuture<Boolean> dropIndexAsync(boolean keepDocs)

loadIndex

public Map<String,Object> loadIndex()

loadIndexAsync

public org.redisson.api.RFuture<Map<String,Object>> loadIndexAsync()

addDocument

public boolean addDocument(Document document)

Adds a document to the index.

参数:

document -

返回:

addDocument

public boolean addDocument(Document document,
                           DocumentOptions options)

addDocumentAsync

public org.redisson.api.RFuture<Boolean> addDocumentAsync(Document document,
                                                          DocumentOptions options)

getDocument

public Map<String,Object> getDocument(String docId)

Returns the full contents of a document.

参数:

docId -

返回:

getDocumentAsync

public org.redisson.api.RFuture<Map<String,Object>> getDocumentAsync(String docId)

getDocuments

public List<Map<String,Object>> getDocuments(String... docIds)

Returns the full contents of multiple documents.

参数:

docIds -

返回:

getDocumentsAsync

public org.redisson.api.RFuture<List<Map<String,Object>>> getDocumentsAsync(String... docIds)

deleteDocument

public boolean deleteDocument(String docId)

Deletes a document from the index.

参数:

docId -

返回:

deleteDocument

public boolean deleteDocument(String docId,
                              boolean deleteDocument)

deleteDocumentAsync

public org.redisson.api.RFuture<Boolean> deleteDocumentAsync(String docId,
                                                             boolean deleteDocument)

addHash

public boolean addHash(String docId,
                       double score)

Adds a document to the index from an existing HASH key in Redis.

参数:

docId -

score -

返回:

addHash

public boolean addHash(String docId,
                       double score,
                       RSLanguage language)

addHash

public boolean addHash(String docId,
                       double score,
                       RSLanguage language,
                       boolean replace)

addHashAsync

public org.redisson.api.RFuture<Boolean> addHashAsync(String docId,
                                                      double score,
                                                      RSLanguage language,
                                                      boolean replace)

addAlias

public boolean addAlias(String alias)

addAliasAsync

public org.redisson.api.RFuture<Boolean> addAliasAsync(String alias)

updateAlias

public boolean updateAlias(String alias)

updateAliasAsync

public org.redisson.api.RFuture<Boolean> updateAliasAsync(String alias)

deleteAlias

public boolean deleteAlias(String alias)

deleteAliasAsync

public org.redisson.api.RFuture<Boolean> deleteAliasAsync(String alias)

explain

public String explain(String query)

explainAsync

public org.redisson.api.RFuture<String> explainAsync(String query)

setConfig

public boolean setConfig(ConfigOption option,
                         String value)

setConfigAsync

public org.redisson.api.RFuture<Boolean> setConfigAsync(ConfigOption option,
                                                        String value)

getConfig

public Map<String,String> getConfig(ConfigOption option)

getConfigAsync

public org.redisson.api.RFuture<Map<String,String>> getConfigAsync(ConfigOption option)

getHelp

public Map<String,String> getHelp(ConfigOption option)

getHelpAsync

public org.redisson.api.RFuture<Map<String,String>> getHelpAsync(ConfigOption option)

addDict

public int addDict(String dictName,
                   String... terms)

Adds terms to a dictionary.

参数:

dictName -

terms -

返回:

addDictAsync

public org.redisson.api.RFuture<Integer> addDictAsync(String dictName,
                                                      String... terms)

deleteDict

public int deleteDict(String dictName,
                      String... terms)

Deletes terms from a dictionary.

参数:

dictName -

terms -

返回:

deleteDictAsync

public org.redisson.api.RFuture<Integer> deleteDictAsync(String dictName,
                                                         String... terms)

dumpDict

public List<String> dumpDict(String dictName)

Dumps all terms in the given dictionary.

参数:

dictName -

返回:

dumpDictAsync

public org.redisson.api.RFuture<List<String>> dumpDictAsync(String dictName)

addSynonym

public long addSynonym(String... terms)

Adds a synonym group.

参数:

terms -

返回:

addSynonymAsync

public org.redisson.api.RFuture<Long> addSynonymAsync(String... terms)

updateSynonym

public boolean updateSynonym(long synonymGroupId,
                             String... terms)

Updates a synonym group.

参数:

synonymGroupId -

terms -

返回:

updateSynonymAsync

public org.redisson.api.RFuture<Boolean> updateSynonymAsync(long synonymGroupId,
                                                            String... terms)

dumpSynonyms

public Map<String,List<Long>> dumpSynonyms()

Dumps the contents of a synonym group.

返回:

dumpSynonymsAsync

public org.redisson.api.RFuture<Map<String,List<Long>>> dumpSynonymsAsync()

getTagVals

public List<String> getTagVals(String fieldName)

Returns the distinct tags indexed in a Tag field.

参数:

fieldName -

返回:

getTagValsAsync

public org.redisson.api.RFuture<List<String>> getTagValsAsync(String fieldName)

addSuggestion

public int addSuggestion(Suggestion suggestion)

Adds a suggestion string to an auto-complete suggestion dictionary.

参数:

suggestion -

返回:

addSuggestion

public int addSuggestion(Suggestion suggestion,
                         boolean increment)

addSuggestionAsync

public org.redisson.api.RFuture<Integer> addSuggestionAsync(Suggestion suggestion,
                                                            boolean increment)

getSuggestionLength

public int getSuggestionLength()

Gets the size of an auto-complete suggestion dictionary

返回:

getSuggestionLengthAsync

public org.redisson.api.RFuture<Integer> getSuggestionLengthAsync()

deleteSuggestion

public boolean deleteSuggestion(String term)

Deletes a string from a suggestion index.

参数:

term -

返回:

deleteSuggestionAsync

public org.redisson.api.RFuture<Boolean> deleteSuggestionAsync(String term)

getSuggestion

public List<Suggestion> getSuggestion(String prefix,
                                      SuggestionOptions options)

Gets completion suggestions for a prefix.

参数:

prefix -

options -

返回:

getSuggestionAsync

public org.redisson.api.RFuture<List<Suggestion>> getSuggestionAsync(String prefix,
                                                                     SuggestionOptions options)

search

public SearchResult search(String query,
                           SearchOptions searchOptions)

Searches the index with a textual query, returning either documents or just ids.

参数:

query -

searchOptions -

返回:

searchAsync

public org.redisson.api.RFuture<SearchResult> searchAsync(String query,
                                                          SearchOptions searchOptions)

aggregate

public AggregateResult aggregate(String query,
                                 AggregateOptions aggregateOptions)

Runs a search query on an index, and performs aggregate transformations on the results.

参数:

query -

aggregateOptions -

返回:

aggregateAsync

public org.redisson.api.RFuture<AggregateResult> aggregateAsync(String query,
                                                                AggregateOptions aggregateOptions)

spellCheck

public List<MisspelledTerm> spellCheck(String query,
                                       SpellCheckOptions options)

Performs spelling correction on a query, returning suggestions for misspelled terms.

参数:

query -

options -

返回:

spellCheckAsync

public org.redisson.api.RFuture<List<MisspelledTerm>> spellCheckAsync(String query,
                                                                      SpellCheckOptions options)

listIndexes

public List<String> listIndexes()

Returns a list of all existing indexes.

返回:

listIndexesAsync

public org.redisson.api.RFuture<List<String>> listIndexesAsync()