io.redisearch.client

Class Client

java.lang.Object

io.redisearch.client.Client

Direct Known Subclasses:

ClusterClient

public class Client
extends Object

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 shuold be given to the client on index creation

Field Summary

Fields

Modifier and Type	Field and Description
protected Commands.CommandProvider	commands

Constructor Summary

Constructors

Constructor and Description
Client(String indexName, String host, int port)
Client(String indexName, String host, int port, int timeout, int poolSize) Create a new client to a RediSearch index

Method Summary

Modifier and Type	Method and Description
boolean	addDocument(String docId, double score, Map<String,Object> fields) See above
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 above
boolean	addHash(String docId, double score, boolean replace) Index a document already in redis as a HASH key.
boolean	createIndex(Schema schema, Client.IndexOptions options) Create the index definition in redis
boolean	deleteDocument(String docId) Delete a document from the index.
boolean	dropIndex() Drop the index and all associated keys, including documents
String	explain(Query q) Generate an explanatory textual query tree for this query string
Map<String,Object>	getInfo() Get the index info, including memory consumption and other statistics.
boolean	replaceDocument(String docId, double score, Map<String,Object> fields) replaceDocument is a convenience for calling addDocument with replace=true
SearchResult	search(Query q) Search the index
boolean	updateDocument(String docId, double score, Map<String,Object> fields) Replace specific fields in a document.

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,
              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)

Method Detail

createIndex

public 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

search

public 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

explain

public 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

public 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:

replaceDocument

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

replaceDocument is a convenience for calling addDocument with replace=true

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

Parameters:

docId -

score -

fields -

Returns:

addDocument

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

See above

addDocument

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

See above

addHash

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

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

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

Returns:

a map of key/value pairs

deleteDocument

public boolean deleteDocument(String docId)

Delete a document from the index.

Parameters:

docId - the document's id

Returns:

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

dropIndex

public boolean dropIndex()

Drop the index and all associated keys, including documents

Returns:

true on success