io.redisearch

Interface Client

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

ClusterClient

All Known Implementing Classes:

Client, ClusterClient

public interface Client
extends Closeable

Field Summary

Fields

Modifier and Type	Field and Description
static String	DELETE_DOCUMENT Deprecated.
static String	FUZZY_FLAG Deprecated.
static String	INCREMENT_FLAG Deprecated.
static String	MAX_FLAG Deprecated.
static String	PAYLOAD_FLAG Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	addDocument(Document doc, AddOptions options)
boolean	addHash(String docId, double score, boolean replace)
Long	addSuggestion(Suggestion suggestion, boolean increment) Add a word to the suggestion index for redis plugin
AggregationResult	aggregate(AggregationBuilder q)
AggregationResult	aggregate(AggregationRequest q) Deprecated. use aggregate(AggregationBuilder) instead
boolean	createIndex(Schema schema, Client.IndexOptions options)
boolean	cursorDelete(long cursorId)
AggregationResult	cursorRead(long cursorId, int count)
boolean	deleteDocument(String docId)
boolean	dropIndex(boolean missingOk)
String	explain(Query q)
Document	getDocument(String docId)
Map<String,Object>	getInfo()
List<Suggestion>	getSuggestion(String prefix, SuggestionOptions suggestionOptions) Request the Suggestions based on the prefix
boolean	replaceDocument(String docId, double score, Map<String,Object> fields)
SearchResult	search(Query q)
boolean	updateDocument(String docId, double score, Map<String,Object> fields)

Methods inherited from interface java.io.Closeable

close

Field Detail

INCREMENT_FLAG

@Deprecated
static final String INCREMENT_FLAG

Deprecated.

See Also:

Constant Field Values

PAYLOAD_FLAG

@Deprecated
static final String PAYLOAD_FLAG

Deprecated.

See Also:

Constant Field Values

MAX_FLAG

@Deprecated
static final String MAX_FLAG

Deprecated.

See Also:

Constant Field Values

FUZZY_FLAG

@Deprecated
static final String FUZZY_FLAG

Deprecated.

See Also:

Constant Field Values

DELETE_DOCUMENT

@Deprecated
static final String DELETE_DOCUMENT

Deprecated.

See Also:

Constant Field Values

Method Detail

createIndex

boolean createIndex(Schema schema,
                    Client.IndexOptions options)

search

SearchResult search(Query q)

aggregate

@Deprecated
AggregationResult aggregate(AggregationRequest q)

Deprecated. use aggregate(AggregationBuilder) instead

aggregate

AggregationResult aggregate(AggregationBuilder q)

cursorDelete

boolean cursorDelete(long cursorId)

cursorRead

AggregationResult cursorRead(long cursorId,
                             int count)

explain

String explain(Query q)

addDocument

boolean addDocument(Document doc,
                    AddOptions options)

replaceDocument

boolean replaceDocument(String docId,
                        double score,
                        Map<String,Object> fields)

updateDocument

boolean updateDocument(String docId,
                       double score,
                       Map<String,Object> fields)

addHash

boolean addHash(String docId,
                double score,
                boolean replace)

getInfo

Map<String,Object> getInfo()

deleteDocument

boolean deleteDocument(String docId)

getDocument

Document getDocument(String docId)

dropIndex

boolean dropIndex(boolean missingOk)

addSuggestion

Long addSuggestion(Suggestion suggestion,
                   boolean increment)

Add a word to the suggestion index for redis plugin

Parameters:

suggestion - the Suggestion to be added

increment - if we should increment this suggestion or not

Returns:

the current size after your added suggestion has been added

getSuggestion

List<Suggestion> getSuggestion(String prefix,
                               SuggestionOptions suggestionOptions)

Request the Suggestions based on the prefix

Parameters:

prefix - the partial word

suggestionOptions - the options on what you need returned and other usage

Returns:

list of suggestions