io.redisearch.client

Class Client

java.lang.Object

io.redisearch.client.Client

All Implemented Interfaces:

Client, Closeable, AutoCloseable

Direct Known Subclasses:

ClusterClient

public class Client
extends Object
implements Client

Client is the main RediSearch client class, wrapping connection management and all RediSearch commands

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Client.IndexOptions IndexOptions encapsulates flags for index creation and should be given to the client on index creation

Field Summary

Fields

Modifier and Type	Field and Description
protected Commands.CommandProvider	commands

Fields inherited from interface io.redisearch.Client

DELETE_DOCUMENT, FUZZY_FLAG, INCREMENT_FLAG, MAX_FLAG, PAYLOAD_FLAG

Constructor Summary

Constructors

Constructor and Description
Client(String indexName, redis.clients.jedis.Jedis jedis)
Client(String indexName, redis.clients.jedis.util.Pool<redis.clients.jedis.Jedis> pool) Create a new client to a RediSearch index
Client(String indexName, String host, int port) Create a new client to a RediSearch index
Client(String indexName, String host, int port, int timeout, int poolSize) Create a new client to a RediSearch index
Client(String indexName, String host, int port, int timeout, int poolSize, String password) Create a new client to a RediSearch index
Client(String indexName, String masterName, Set<String> sentinels) Create a new client to a RediSearch index with JediSentinelPool implementation.
Client(String indexName, String masterName, Set<String> sentinels, int timeout, int poolSize) Create a new client to a RediSearch index with JediSentinelPool implementation.
Client(String indexName, String master, Set<String> sentinels, int timeout, int poolSize, String password) Create a new client to a RediSearch index with JediSentinelPool implementation.

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) see addDocuments(AddOptions, Document...)
boolean	addHash(String docId, double score, boolean replace) Deprecated. does support starting from RediSearch 2.0
Long	addSuggestion(Suggestion suggestion, boolean increment) Add a word to the suggestion index for redis plugin
long	addSynonym(String... terms) Deprecated.
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
void	close()
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 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 documents 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) 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.
boolean	updateSynonym(String synonymGroupId, String... terms) Updates a synonym group.

Methods inherited from class java.lang.Object

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

Field Detail

commands

protected Commands.CommandProvider commands

Constructor Detail

Client

public Client(String indexName,
              redis.clients.jedis.util.Pool<redis.clients.jedis.Jedis> pool)

Create a new client to a RediSearch index

Parameters:

indexName - the name of the index we are connecting to or creating

pool - jedis connection pool to be used

Client

public Client(String indexName,
              redis.clients.jedis.Jedis jedis)

Client

public Client(String indexName,
              String host,
              int port)

Create a new client to a RediSearch index

Parameters:

indexName - the name of the index we are connecting to or creating

host - the redis host

port - the redis pot

Client

public Client(String indexName,
              String host,
              int port,
              int timeout,
              int poolSize)

Create a new client to a RediSearch index

Parameters:

indexName - the name of the index we are connecting to or creating

host - the redis host

port - the redis pot

Client

public Client(String indexName,
              String host,
              int port,
              int timeout,
              int poolSize,
              String password)

Create a new client to a RediSearch index

Parameters:

indexName - the name of the index we are connecting to or creating

host - the redis host

port - the redis pot

password - the password for authentication in a password protected Redis server

Client

public Client(String indexName,
              String master,
              Set<String> sentinels,
              int timeout,
              int poolSize,
              String password)

Create a new client to a RediSearch index with JediSentinelPool implementation. JedisSentinelPool takes care of reconfiguring the Pool when there is a failover of master node thus providing high availability and automatic failover.

Parameters:

indexName - the name of the index we are connecting to or creating

master - the masterName to connect from list of masters monitored by sentinels

sentinels - the set of sentinels monitoring the cluster

timeout - the timeout in milliseconds

poolSize - the poolSize of JedisSentinelPool

password - the password for authentication in a password protected Redis server

Client

public Client(String indexName,
              String masterName,
              Set<String> sentinels,
              int timeout,
              int poolSize)

Create a new client to a RediSearch index with JediSentinelPool implementation. JedisSentinelPool takes care of reconfiguring the Pool when there is a failover of master node thus providing high availability and automatic failover.

The Client is initialized with following default values for JedisSentinelPool

• password - NULL, no authentication required to connect to Redis Server

Parameters:

indexName - the name of the index we are connecting to or creating

masterName - the masterName to connect from list of masters monitored by sentinels

sentinels - the set of sentinels monitoring the cluster

timeout - the timeout in milliseconds

poolSize - the poolSize of JedisSentinelPool

Client

public Client(String indexName,
              String masterName,
              Set<String> sentinels)

Create a new client to a RediSearch index with JediSentinelPool implementation. JedisSentinelPool takes care of reconfiguring the Pool when there is a failover of master node thus providing high availability and automatic failover.

The Client is initialized with following default values for JedisSentinelPool

• timeout - 500 mills
• poolSize - 100 connections
• password - NULL, no authentication required to connect to Redis Server

Parameters:

indexName - the name of the index we are connecting to or creating

masterName - the masterName to connect from list of masters monitored by sentinels

sentinels - the set of sentinels monitoring the cluster

Method Detail

connection

public redis.clients.jedis.Jedis connection()

Specified by:

connection in interface Client

Returns:

a connection from the connection pool

createIndex

public boolean createIndex(Schema schema,
                           Client.IndexOptions options)

Create the index definition in redis

Specified by:

createIndex in interface Client

Parameters:

schema - a schema definition, see Schema

options - index option flags, see Client.IndexOptions

Returns:

true if successful

alterIndex

public boolean alterIndex(Schema.Field... fields)

Alter index add fields

Specified by:

alterIndex in interface Client

Parameters:

fields - list of fields

Returns:

true if successful

setConfig

public boolean setConfig(ConfigOption option,
                         String value)

Set runtime configuration option

Specified by:

setConfig in interface Client

Parameters:

option - the name of the configuration option

value - a value for the configuration option

Returns:

OK

getConfig

public String getConfig(ConfigOption option)

Get runtime configuration option value

Specified by:

getConfig in interface Client

Parameters:

option - the name of the configuration option

Returns:

config

getAllConfig

public Map<String,String> getAllConfig()

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

Specified by:

getAllConfig in interface Client

Returns:

all configs map

addAlias

public boolean addAlias(String name)

Description copied from interface: Client

Add an alias to the index.

Specified by:

addAlias in interface Client

Returns:

OK

updateAlias

public boolean updateAlias(String name)

Description copied from interface: Client

Update an alias from an index.

Specified by:

updateAlias in interface Client

Returns:

OK

deleteAlias

public boolean deleteAlias(String name)

Description copied from interface: Client

remove an alias from an index.

Specified by:

deleteAlias in interface Client

Returns:

OK

searchBatch

public SearchResult[] searchBatch(Query... queries)

Search the index

Specified by:

searchBatch in interface Client

Parameters:

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

Returns:

a SearchResult object with the results

search

public SearchResult search(Query q)

Search the index

Specified by:

search in interface Client

Parameters:

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

Returns:

a SearchResult object with the results

search

public SearchResult search(Query q,
                           boolean decode)

Search the index

Specified by:

search in interface Client

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
public AggregationResult aggregate(AggregationRequest q)

Deprecated. use aggregate(AggregationBuilder) instead

Specified by:

aggregate in interface Client

aggregate

public AggregationResult aggregate(AggregationBuilder q)

Description copied from interface: Client

Search and Aggregate the index

Specified by:

aggregate in interface Client

Parameters:

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

Returns:

a AggregationResult object with the results

explain

public String explain(Query q)

Generate an explanatory textual query tree for this query string

Specified by:

explain in interface Client

Parameters:

q - The query to explain

Returns:

A string describing this query

addDocument

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

Add a single document to the query

Specified by:

addDocument in interface Client

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

public boolean addDocument(Document doc)

Add a document to the index

Specified by:

addDocument in interface Client

Parameters:

doc - The document to add

Returns:

true on success

addDocument

public boolean addDocument(Document doc,
                           AddOptions options)

Add a document to the index

Specified by:

addDocument in interface Client

Parameters:

doc - The document to add

options - Options for the operation

Returns:

true on success

addDocuments

public boolean[] addDocuments(Document... docs)

see addDocuments(AddOptions, Document...)

Specified by:

addDocuments in interface Client

Parameters:

docs - The document to add

Returns:

true on success

addDocuments

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

Add a batch of documents to the index

Specified by:

addDocuments in interface Client

Parameters:

options - Options for the operation

docs - The documents to add

Returns:

true on success for each document

replaceDocument

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

replaceDocument is a convenience for calling addDocument with replace=true

Specified by:

replaceDocument in interface Client

Parameters:

docId -

score -

fields -

Returns:

true on success

replaceDocument

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

replaceDocument is a convenience for calling addDocument with replace=true

Specified by:

replaceDocument in interface Client

Parameters:

docId -

score -

fields -

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

Returns:

true on success

updateDocument

public 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

Specified by:

updateDocument in interface Client

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

public 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

Specified by:

updateDocument in interface Client

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

addDocument

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

See updateDocument(String, double, Map)

Specified by:

addDocument in interface Client

addDocument

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

See updateDocument(String, double, Map)

Specified by:

addDocument in interface Client

addHash

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

Deprecated. does support starting from RediSearch 2.0

Index a document already in redis as a HASH key.

Specified by:

addHash in interface Client

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

public Map<String,Object> getInfo()

Get the index info, including memory consumption and other statistics. TODO: Make a class for easier access to the index properties

Specified by:

getInfo in interface Client

Returns:

a map of key/value pairs

deleteDocuments

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

Delete a documents from the index

Specified by:

deleteDocuments in interface Client

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

public boolean deleteDocument(String docId)

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

Specified by:

deleteDocument in interface Client

Parameters:

docId - the document's id

Returns:

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

See Also:

deleteDocument(String, boolean)

deleteDocument

public boolean deleteDocument(String docId,
                              boolean deleteDocument)

Delete a document from the index.

Specified by:

deleteDocument in interface Client

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

public Document getDocument(String docId)

Get a document from the index

Specified by:

getDocument in interface Client

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

public Document getDocument(String docId,
                            boolean decode)

Get a document from the index

Specified by:

getDocument in interface Client

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

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

Get a documents from the index

Specified by:

getDocuments in interface Client

Parameters:

docIds - The document IDs to retrieve

Returns:

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

getDocuments

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

Get a documents from the index

Specified by:

getDocuments in interface Client

Parameters:

docIds - The document IDs 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.

dropIndex

public boolean dropIndex()

Drop the index and all associated keys, including documents

Specified by:

dropIndex in interface Client

Returns:

true on success

dropIndex

public boolean dropIndex(boolean missingOk)

Drop the index and associated keys, including documents

Specified by:

dropIndex in interface Client

Parameters:

missingOk - If the index does not exist, don't throw an exception, but return false instead

Returns:

True if the index was dropped, false if it did not exist (or some other error occurred).

addSuggestion

public Long addSuggestion(Suggestion suggestion,
                          boolean increment)

Description copied from interface: Client

Add a word to the suggestion index for redis plugin

Specified by:

addSuggestion in interface Client

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

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

Description copied from interface: Client

Request the Suggestions based on the prefix

Specified by:

getSuggestion in interface Client

Parameters:

prefix - the partial word

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

Returns:

list of suggestions

deleteSuggestion

public Long deleteSuggestion(String entry)

Description copied from interface: Client

Deletes a string from a suggestion

Specified by:

deleteSuggestion in interface Client

Returns:

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

getSuggestionLength

public Long getSuggestionLength()

Description copied from interface: Client

Gets the size of an auto-complete suggestion

Specified by:

getSuggestionLength in interface Client

Returns:

the size of an auto-complete suggestion dictionary

cursorDelete

public boolean cursorDelete(long cursorId)

Description copied from interface: Client

Delete a cursor from the index.

Specified by:

cursorDelete in interface Client

Parameters:

cursorId - the cursor's id

Returns:

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

cursorRead

public AggregationResult cursorRead(long cursorId,
                                    int count)

Description copied from interface: Client

Read from an existing cursor

Specified by:

cursorRead in interface Client

Parameters:

cursorId - the cursor's id

count - limit the amount of returned results

Returns:

a AggregationResult object with the results

addSynonym

@Deprecated
public long addSynonym(String... terms)

Deprecated.

Description copied from interface: Client

Adds a synonym group.

Specified by:

addSynonym in interface Client

Returns:

the synonym group id

updateSynonym

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

Deprecated.

Description copied from interface: Client

Updates a synonym group.

Specified by:

updateSynonym in interface Client

Returns:

true on success

updateSynonym

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

Description copied from interface: Client

Updates a synonym group.

Specified by:

updateSynonym in interface Client

Returns:

true on success

dumpSynonym

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

Specified by:

dumpSynonym in interface Client

Returns:

a map of synonym terms and their synonym group ids.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable