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. use Keywords.DD instead
static String	FUZZY_FLAG Deprecated. use Keywords.FUZZY instead
static String	INCREMENT_FLAG Deprecated. use Keywords.INCR instead
static String	MAX_FLAG Deprecated. use Keywords.MAX instead
static String	PAYLOAD_FLAG Deprecated. use Keywords.PAYLOAD instead

Method Summary

Modifier and Type	Method and Description
boolean	addAlias(String name) Add an alias to the index.
boolean	addDocument(Document doc) Add a document to the index
boolean	addDocument(Document doc, AddOptions options) Add a document to the index
boolean	addDocument(String docId, double score, Map<String,Object> fields) See updateDocument(String, double, Map)
boolean	addDocument(String docId, double score, Map<String,Object> fields, boolean noSave, boolean replace, byte[] payload) Add a single document to the query
boolean	addDocument(String docId, Map<String,Object> fields) See updateDocument(String, double, Map)
boolean[]	addDocuments(AddOptions options, Document... docs) Add a batch of documents to the index
boolean[]	addDocuments(Document... docs) Add a document to the index
boolean	addHash(String docId, double score, boolean replace) Deprecated. not supported since RediSeach 2 use BinaryJedis.hset(byte[], Map) instead
Long	addSuggestion(Suggestion suggestion, boolean increment) Add a word to the suggestion index for redis plugin
long	addSynonym(String... terms) Deprecated. not supported since RediSeach 2 use {@link #updateSynonym(String, String...) instead
AggregationResult	aggregate(AggregationBuilder q) Search and Aggregate the index
AggregationResult	aggregate(AggregationRequest q) Deprecated. use aggregate(AggregationBuilder) instead
boolean	alterIndex(Schema.Field... fields) Alter index add fields
redis.clients.jedis.Jedis	connection()
boolean	createIndex(Schema schema, Client.IndexOptions options) Create the index definition in redis
boolean	cursorDelete(long cursorId) Delete a cursor from the index.
AggregationResult	cursorRead(long cursorId, int count) Read from an existing cursor
boolean	deleteAlias(String name) remove an alias from an index.
boolean	deleteDocument(String docId) Delete a document from the index (doesn't delete the document).
boolean	deleteDocument(String docId, boolean deleteDocument) Delete a document from the index.
boolean[]	deleteDocuments(boolean deleteDocuments, String... docIds) Delete a documents from the index
Long	deleteSuggestion(String entry) Deletes a string from a suggestion
boolean	dropIndex() Drop the index and all associated keys, including documents
boolean	dropIndex(boolean missingOk) Drop the index and all associated keys, including documents
Map<String,List<String>>	dumpSynonym()
String	explain(Query q) Generate an explanatory textual query tree for this query string
Map<String,String>	getAllConfig() Get all configuration options, consisting of the option's name and current value
String	getConfig(ConfigOption option) Get runtime configuration option value
Document	getDocument(String docId) Get a document from the index
Document	getDocument(String docId, boolean decode) Get a document from the index
List<Document>	getDocuments(boolean decode, String... docIds) Get a documents from the index
List<Document>	getDocuments(String... docIds) Get a document from the index
Map<String,Object>	getInfo() Get the index info, including memory consumption and other statistics.
List<Suggestion>	getSuggestion(String prefix, SuggestionOptions suggestionOptions) Request the Suggestions based on the prefix
Long	getSuggestionLength() Gets the size of an auto-complete suggestion
boolean	replaceDocument(String docId, double score, Map<String,Object> fields) replaceDocument is a convenience for calling addDocument with replace=true
boolean	replaceDocument(String docId, double score, Map<String,Object> fields, String filter) replaceDocument is a convenience for calling addDocument with replace=true
SearchResult	search(Query q) Search the index
SearchResult	search(Query q, boolean decode) Search the index
SearchResult[]	searchBatch(Query... queries) Batch search the index
boolean	setConfig(ConfigOption option, String value) Set runtime configuration option
boolean	updateAlias(String name) Update an alias from an index.
boolean	updateDocument(String docId, double score, Map<String,Object> fields) Replace specific fields in a document.
boolean	updateDocument(String docId, double score, Map<String,Object> fields, String filter) Replace specific fields in a document.
boolean	updateSynonym(long synonymGroupId, String... terms) Deprecated. use {@link #updateSynonym(String, String...) instead
boolean	updateSynonym(String synonymGroupId, String... terms) Updates a synonym group.

Methods inherited from interface java.io.Closeable

close

Field Detail

INCREMENT_FLAG

@Deprecated
static final String INCREMENT_FLAG

Deprecated. use Keywords.INCR instead

See Also:

Constant Field Values

PAYLOAD_FLAG

@Deprecated
static final String PAYLOAD_FLAG

Deprecated. use Keywords.PAYLOAD instead

See Also:

Constant Field Values

MAX_FLAG

@Deprecated
static final String MAX_FLAG

Deprecated. use Keywords.MAX instead

See Also:

Constant Field Values

FUZZY_FLAG

@Deprecated
static final String FUZZY_FLAG

Deprecated. use Keywords.FUZZY instead

See Also:

Constant Field Values

DELETE_DOCUMENT

@Deprecated
static final String DELETE_DOCUMENT

Deprecated. use Keywords.DD instead

See Also:

Constant Field Values

Method Detail

createIndex

boolean createIndex(Schema schema,
                    Client.IndexOptions options)

Create the index definition in redis

Parameters:

schema - a schema definition, see Schema

options - index option flags, see Client.IndexOptions

Returns:

true if successful

Since:

2.0

search

SearchResult search(Query q)

Search the index

Parameters:

q - a Query object with the query string and optional parameters

Returns:

a SearchResult object with the results

searchBatch

SearchResult[] searchBatch(Query... queries)

Batch search the index

Parameters:

queries - batch of Query objects with the query strings and optional parameters

Returns:

SearchResult batch with the results

search

SearchResult search(Query q,
                    boolean decode)

Search the index

Parameters:

q - a Query object with the query string and optional parameters

decode - false - keeps the fields value as byte[]

Returns:

a SearchResult object with the results

aggregate

@Deprecated
AggregationResult aggregate(AggregationRequest q)

Deprecated. use aggregate(AggregationBuilder) instead

aggregate

AggregationResult aggregate(AggregationBuilder q)

Search and Aggregate the index

Parameters:

q - a AggregationBuilder object with the query string and optional aggregation parameters

Returns:

a AggregationResult object with the results

cursorDelete

boolean cursorDelete(long cursorId)

Delete a cursor from the index.

Parameters:

cursorId - the cursor's id

Returns:

true if it has been deleted, false if it did not exist

cursorRead

AggregationResult cursorRead(long cursorId,
                             int count)

Read from an existing cursor

Parameters:

cursorId - the cursor's id

count - limit the amount of returned results

Returns:

a AggregationResult object with the results

explain

String explain(Query q)

Generate an explanatory textual query tree for this query string

Parameters:

q - The query to explain

Returns:

A string describing this query

addDocument

boolean addDocument(Document doc,
                    AddOptions options)

Add a document to the index

Parameters:

doc - The document to add

options - Options for the operation

Returns:

true on success

addDocument

boolean addDocument(String docId,
                    double score,
                    Map<String,Object> fields,
                    boolean noSave,
                    boolean replace,
                    byte[] payload)

Add a single document to the query

Parameters:

docId - the id of the document. It cannot belong to a document already in the index unless replace is set

score - the document's score, floating point number between 0 and 1

fields - a map of the document's fields

noSave - if set, we only index the document and do not save its contents. This allows fetching just doc ids

replace - if set, and the document already exists, we reindex and update it

payload - if set, we can save a payload in the index to be retrieved or evaluated by scoring functions on the server

Returns:

true on success

addDocument

boolean addDocument(Document doc)

Add a document to the index

Parameters:

doc - The document to add

Returns:

true on success

addDocuments

boolean[] addDocuments(Document... docs)

Add a document to the index

Parameters:

docs - The document to add

Returns:

true on success

addDocuments

boolean[] addDocuments(AddOptions options,
                       Document... docs)

Add a batch of documents to the index

Parameters:

options - Options for the operation

docs - The documents to add

Returns:

true on success for each document

addDocument

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

See updateDocument(String, double, Map)

addDocument

boolean addDocument(String docId,
                    Map<String,Object> fields)

See updateDocument(String, double, Map)

replaceDocument

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

replaceDocument is a convenience for calling addDocument with replace=true

Parameters:

docId -

score -

fields -

Returns:

true on success

replaceDocument

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

replaceDocument is a convenience for calling addDocument with replace=true

Parameters:

docId -

score -

fields -

filter - updates the document only if a boolean expression applies to the document

Returns:

true on success

updateDocument

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

Replace specific fields in a document. Unlike #replaceDocument(), fields not present in the field list are not erased, but retained. This avoids reindexing the entire document if the new values are not indexed (though a reindex will happen

Parameters:

docId - the id of the document. It cannot belong to a document already in the index unless replace is set

score - the document's score, floating point number between 0 and 1

fields - a map of the document's fields

Returns:

true on success

updateDocument

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

Replace specific fields in a document. Unlike #replaceDocument(), fields not present in the field list are not erased, but retained. This avoids reindexing the entire document if the new values are not indexed (though a reindex will happen

Parameters:

docId - the id of the document. It cannot belong to a document already in the index unless replace is set

score - the document's score, floating point number between 0 and 1

fields - a map of the document's fields

filter - updates the document only if a boolean expression applies to the document

Returns:

true on success

addHash

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

Deprecated. not supported since RediSeach 2 use BinaryJedis.hset(byte[], Map) instead

Index a document already in redis as a HASH key.

Parameters:

docId - the id of the document in redis. This must match an existing, unindexed HASH key

score - the document's index score, between 0 and 1

replace - if set, and the document already exists, we reindex and update it

Returns:

true on success

getInfo

Map<String,Object> getInfo()

Get the index info, including memory consumption and other statistics.

Returns:

a map of key/value pairs

deleteDocument

boolean deleteDocument(String docId)

Delete a document from the index (doesn't delete the document).

Parameters:

docId - the document's id

Returns:

true if it has been deleted, false if it did not exist

See Also:

deleteDocument(String, boolean)

deleteDocuments

boolean[] deleteDocuments(boolean deleteDocuments,
                          String... docIds)

Delete a documents from the index

Parameters:

deleteDocuments - if true also deletes the actual document ifs it is in the index

docIds - the document's ids

Returns:

true on success for each document if it has been deleted, false if it did not exist

deleteDocument

boolean deleteDocument(String docId,
                       boolean deleteDocument)

Delete a document from the index.

Parameters:

docId - the document's id

deleteDocument - if true also deletes the actual document if it is in the index

Returns:

true if it has been deleted, false if it did not exist

getDocument

Document getDocument(String docId)

Get a document from the index

Parameters:

docId - The document ID to retrieve

Returns:

The document as stored in the index. If the document does not exist, null is returned. Decode values by default as String

See Also:

getDocument(String, boolean)

getDocument

Document getDocument(String docId,
                     boolean decode)

Get a document from the index

Parameters:

docId - The document ID to retrieve

decode - false - keeps the fields value as byte[]

Returns:

The document as stored in the index. If the document does not exist, null is returned.

getDocuments

List<Document> getDocuments(String... docIds)

Get a document from the index

Parameters:

docIds - The document IDs to retrieve

Returns:

The documents stored in the index. If a document does not exist, null is returned.

getDocuments

List<Document> getDocuments(boolean decode,
                            String... docIds)

Get a documents from the index

Parameters:

decode - false - keeps the fields value as byte[]

docIds - The document IDs to retrieve

Returns:

The documents stored in the index. If a document does not exist, null is returned.

dropIndex

boolean dropIndex()

Drop the index and all associated keys, including documents

Returns:

true on success

dropIndex

boolean dropIndex(boolean missingOk)

Drop the index and all associated keys, including documents

Returns:

true on success

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

deleteSuggestion

Long deleteSuggestion(String entry)

Deletes a string from a suggestion

Returns:

1 if the string was found and deleted, 0 otherwise.

getSuggestionLength

Long getSuggestionLength()

Gets the size of an auto-complete suggestion

Returns:

the size of an auto-complete suggestion dictionary

alterIndex

boolean alterIndex(Schema.Field... fields)

Alter index add fields

Parameters:

fields - list of fields

Returns:

true if successful

setConfig

boolean setConfig(ConfigOption option,
                  String value)

Set runtime configuration option

Parameters:

option - the name of the configuration option

value - a value for the configuration option

Returns:

getConfig

String getConfig(ConfigOption option)

Get runtime configuration option value

Parameters:

option - the name of the configuration option

Returns:

getAllConfig

Map<String,String> getAllConfig()

Get all configuration options, consisting of the option's name and current value

Returns:

addAlias

boolean addAlias(String name)

Add an alias to the index.

Parameters:

name -

Returns:

updateAlias

boolean updateAlias(String name)

Update an alias from an index.

Parameters:

name -

Returns:

deleteAlias

boolean deleteAlias(String name)

remove an alias from an index.

Parameters:

name -

Returns:

addSynonym

@Deprecated
long addSynonym(String... terms)

Deprecated. not supported since RediSeach 2 use {@link #updateSynonym(String, String...) instead

Adds a synonym group.

Parameters:

terms -

Returns:

the synonym group id

updateSynonym

@Deprecated
boolean updateSynonym(long synonymGroupId,
                                  String... terms)

Deprecated. use {@link #updateSynonym(String, String...) instead

Updates a synonym group.

Parameters:

synonymGroupId -

terms -

Returns:

true on success

updateSynonym

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

Updates a synonym group.

Parameters:

synonymGroupId -

terms -

Returns:

true on success

dumpSynonym

Map<String,List<String>> dumpSynonym()

Returns:

a map of synonym terms and their synonym group ids.

connection

redis.clients.jedis.Jedis connection()

Returns:

a connection from the connection pool