io.redisearch

Class Query

java.lang.Object

io.redisearch.Query

public class Query
extends Object

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.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

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	_fields
protected List<io.redisearch.Query.Filter>	_filters The query's filter list.
protected String[]	_keys
protected String	_language
protected boolean	_noContent
protected boolean	_noStopwords
protected Query.Paging	_paging The sorting parameters
protected byte[]	_payload
protected String	_queryString The textual part of the query
protected String[]	_returnFields
protected boolean	_sortAsc
protected String	_sortBy
protected boolean	_verbatim
protected boolean	_withPayloads
protected boolean	_withScores
protected String[]	highlightFields
protected String[]	highlightTags
protected String[]	summarizeFields
protected int	summarizeFragmentLen
protected int	summarizeNumFragments
protected String	summarizeSeparator
protected boolean	wantsHighlight
protected boolean	wantsSummarize

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Query	addFilter(io.redisearch.Query.Filter f) Add a filter to the query's filter list
boolean	getNoContent()
boolean	getWithPayloads()
boolean	getWithScores()
Query	highlightFields(Query.HighlightTags tags, String... fields)
Query	highlightFields(String... fields)
Query	limit(Integer offset, Integer limit) Limit the results to a certain offset and limit
Query	limitFields(String... fields) Limit the query to results that are limited to a specific set of fields
Query	limitKeys(String... keys) Limit the query to results that are limited to a specific set of keys
Query	returnFields(String... fields) Result's projection - the fields to return by the query
void	serializeRedisArgs(List<byte[]> args)
Query	setLanguage(String language) Set the query language, for stemming purposes
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	setPayload(byte[] payload)
Query	setSortBy(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	setWithPaload() Deprecated. setWithPayload()
Query	setWithPayload() Set the query to return object payloads, if any were given
Query	setWithScores() Set the query to return a factored score for each results.
Query	summarizeFields(int contextLen, int fragmentCount, String separator, String... fields)
Query	summarizeFields(String... fields)

Methods inherited from class java.lang.Object

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

Field Detail

_filters

protected final List<io.redisearch.Query.Filter> _filters

The query's filter list. We only support AND operation on all those filters

_queryString

protected final String _queryString

The textual part of the query

_paging

protected final Query.Paging _paging

The sorting parameters

_verbatim

protected boolean _verbatim

_noContent

protected boolean _noContent

_noStopwords

protected boolean _noStopwords

_withScores

protected boolean _withScores

_withPayloads

protected boolean _withPayloads

_language

protected String _language

_fields

protected String[] _fields

_keys

protected String[] _keys

_returnFields

protected String[] _returnFields

highlightFields

protected String[] highlightFields

summarizeFields

protected String[] summarizeFields

highlightTags

protected String[] highlightTags

summarizeSeparator

protected String summarizeSeparator

summarizeNumFragments

protected int summarizeNumFragments

summarizeFragmentLen

protected int summarizeFragmentLen

_payload

protected byte[] _payload

_sortBy

protected String _sortBy

_sortAsc

protected boolean _sortAsc

wantsHighlight

protected boolean wantsHighlight

wantsSummarize

protected boolean wantsSummarize

Constructor Detail

Query

public Query(String queryString)

Create a new index

Parameters:

queryString - the textual part of the query

Method Detail

serializeRedisArgs

public void serializeRedisArgs(List<byte[]> args)

limit

public Query limit(Integer offset,
                   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(io.redisearch.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

setPayload

public Query setPayload(byte[] payload)

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

getWithPayloads

public boolean getWithPayloads()

setWithPaload

@Deprecated
public Query setWithPaload()

Deprecated. setWithPayload()

setWithPayload

public Query setWithPayload()

Set the query to return object payloads, if any were given

Returns:

the query object itself

setLanguage

public Query setLanguage(String language)

Set the query language, for stemming purposes

Parameters:

language - a language. see http://redisearch.io for documentation on languages and stemming

Returns:

the query object itself

limitFields

public Query limitFields(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(String... keys)

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

Parameters:

fields - a list of TEXT fields in the schemas

Returns:

the query object itself

returnFields

public Query returnFields(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

highlightFields

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

highlightFields

public Query highlightFields(String... fields)

summarizeFields

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

summarizeFields

public Query summarizeFields(String... fields)

setSortBy

public Query setSortBy(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