redis.clients.jedis.search

Class Query

java.lang.Object

redis.clients.jedis.search.Query

All Implemented Interfaces:

IParams

public class Query
extends java.lang.Object
implements IParams

Query represents query parameters and filters to load results from the engine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Query.Filter Filter represents a filtering rules in a query
static class	Query.GeoFilter GeoFilter encapsulates a radius filter on a geographical indexed fields
static class	Query.HighlightTags
static class	Query.NumericFilter NumericFilter wraps a range filter on a numeric field.
static class	Query.Paging

Constructor Summary

Constructors

Constructor and Description
Query()
Query(java.lang.String queryString) Create a new index

Method Summary

Modifier and Type	Method and Description
Query	addFilter(Query.Filter f) Add a filter to the query's filter list
Query	addParam(java.lang.String name, java.lang.Object value) Parameters can be referenced in the query string by a $ , followed by the parameter name, e.g., $user , and each such reference in the search query to a parameter name is substituted by the corresponding parameter value.
void	addParams(CommandArguments args)
Query	dialect(int dialect) Set the dialect version to execute the query accordingly
Query	dialectOptional(int dialect) This method will not replace the dialect if it has been already set.
boolean	getNoContent()
boolean	getWithScores()
Query	highlightFields(Query.HighlightTags tags, java.lang.String... fields)
Query	highlightFields(java.lang.String... fields)
Query	limit(java.lang.Integer offset, java.lang.Integer limit) Limit the results to a certain offset and limit
Query	limitFields(java.lang.String... fields) Limit the query to results that are limited to a specific set of fields
Query	limitKeys(java.lang.String... keys) Limit the query to results that are limited to a specific set of keys
Query	returnFields(FieldName... fields) Result's projection - the fields to return by the query
Query	returnFields(java.lang.String... fields) Result's projection - the fields to return by the query
Query	setExpander(java.lang.String field) Set the query to use a custom query expander instead of the stemmer
Query	setInOrder() Set the query terms appear in the same order in the document as in the query, regardless of the offsets between them
Query	setLanguage(java.lang.String language) Set the query language, for stemming purposes See http://redisearch.io for documentation on languages and stemming
Query	setNoContent() Set the query not to return the contents of documents, and rather just return the ids
Query	setNoStopwords() Set the query not to filter for stopwords.
Query	setScorer(java.lang.String scorer) Set the query custom scorer See http://redisearch.io for documentation on extending RediSearch
Query	setSortBy(java.lang.String field, boolean ascending) Set the query to be sorted by a Sortable field defined in the schema
Query	setVerbatim() Set the query to verbatim mode, disabling stemming and query expansion
Query	setWithScores() Set the query to return a factored score for each results.
Query	slop(int slop) Set the slop to execute the query accordingly
Query	summarizeFields(int contextLen, int fragmentCount, java.lang.String separator, java.lang.String... fields)
Query	summarizeFields(java.lang.String... fields)
Query	timeout(long timeout) Set the timeout to execute the query accordingly

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query()

Query

public Query(java.lang.String queryString)

Create a new index

Parameters:

queryString - the textual part of the query

Method Detail

addParams

public void addParams(CommandArguments args)

Specified by:

addParams in interface IParams

limit

public Query limit(java.lang.Integer offset,
                   java.lang.Integer limit)

Limit the results to a certain offset and limit

Parameters:

offset - the first result to show, zero based indexing

limit - how many results we want to show

Returns:

the query itself, for builder-style syntax

addFilter

public Query addFilter(Query.Filter f)

Add a filter to the query's filter list

Parameters:

f - either a numeric or geo filter object

Returns:

the query itself

setVerbatim

public Query setVerbatim()

Set the query to verbatim mode, disabling stemming and query expansion

Returns:

the query object

getNoContent

public boolean getNoContent()

setNoContent

public Query setNoContent()

Set the query not to return the contents of documents, and rather just return the ids

Returns:

the query itself

setNoStopwords

public Query setNoStopwords()

Set the query not to filter for stopwords. In general this should not be used

Returns:

the query object

getWithScores

public boolean getWithScores()

setWithScores

public Query setWithScores()

Set the query to return a factored score for each results. This is useful to merge results from multiple queries.

Returns:

the query object itself

setLanguage

public Query setLanguage(java.lang.String language)

Set the query language, for stemming purposes

See http://redisearch.io for documentation on languages and stemming

Parameters:

language - a language.

Returns:

the query object itself

setScorer

public Query setScorer(java.lang.String scorer)

Set the query custom scorer

See http://redisearch.io for documentation on extending RediSearch

Parameters:

scorer - a custom scorer.

Returns:

the query object itself

limitFields

public Query limitFields(java.lang.String... fields)

Limit the query to results that are limited to a specific set of fields

Parameters:

fields - a list of TEXT fields in the schemas

Returns:

the query object itself

limitKeys

public Query limitKeys(java.lang.String... keys)

Limit the query to results that are limited to a specific set of keys

Parameters:

keys - a list of TEXT fields in the schemas

Returns:

the query object itself

returnFields

public Query returnFields(java.lang.String... fields)

Result's projection - the fields to return by the query

Parameters:

fields - a list of TEXT fields in the schemas

Returns:

the query object itself

returnFields

public Query returnFields(FieldName... fields)

Result's projection - the fields to return by the query

Parameters:

fields - a list of TEXT fields in the schemas

Returns:

the query object itself

highlightFields

public Query highlightFields(Query.HighlightTags tags,
                             java.lang.String... fields)

highlightFields

public Query highlightFields(java.lang.String... fields)

summarizeFields

public Query summarizeFields(int contextLen,
                             int fragmentCount,
                             java.lang.String separator,
                             java.lang.String... fields)

summarizeFields

public Query summarizeFields(java.lang.String... fields)

setSortBy

public Query setSortBy(java.lang.String field,
                       boolean ascending)

Set the query to be sorted by a Sortable field defined in the schema

Parameters:

field - the sorting field's name

ascending - if set to true, the sorting order is ascending, else descending

Returns:

the query object itself

addParam

public Query addParam(java.lang.String name,
                      java.lang.Object value)

Parameters can be referenced in the query string by a $ , followed by the parameter name, e.g., $user , and each such reference in the search query to a parameter name is substituted by the corresponding parameter value.

Parameters:

name -

value - can be String, long or float

Returns:

the query object itself

dialect

public Query dialect(int dialect)

Set the dialect version to execute the query accordingly

Parameters:

dialect - integer

Returns:

the query object itself

dialectOptional

public Query dialectOptional(int dialect)

This method will not replace the dialect if it has been already set.

Parameters:

dialect - dialect

Returns:

this

slop

public Query slop(int slop)

Set the slop to execute the query accordingly

Parameters:

slop - integer

Returns:

the query object itself

timeout

public Query timeout(long timeout)

Set the timeout to execute the query accordingly

Parameters:

timeout - long

Returns:

the query object itself

setInOrder

public Query setInOrder()

Set the query terms appear in the same order in the document as in the query, regardless of the offsets between them

Returns:

the query object

setExpander

public Query setExpander(java.lang.String field)

Set the query to use a custom query expander instead of the stemmer

Parameters:

field - the expander field's name

Returns:

the query object itself