Modifier and Type | Class and Description |
---|---|
static class |
FTSearchParams.GeoFilter
GeoFilter encapsulates a radius filter on a geographical indexed fields
|
static class |
FTSearchParams.HighlightParams |
static class |
FTSearchParams.NumericFilter
NumericFilter wraps a range filter on a numeric field.
|
static class |
FTSearchParams.SummarizeParams |
Constructor and Description |
---|
FTSearchParams() |
Modifier and Type | Method and Description |
---|---|
FTSearchParams |
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) |
FTSearchParams |
dialect(int dialect)
Set the dialect version to execute the query accordingly
|
FTSearchParams |
filter(FTSearchParams.NumericFilter numericFilter) |
FTSearchParams |
filter(java.lang.String field,
double min,
boolean exclusiveMin,
double max,
boolean exclusiveMax) |
FTSearchParams |
filter(java.lang.String field,
double min,
double max) |
FTSearchParams |
geoFilter(FTSearchParams.GeoFilter geoFilter) |
FTSearchParams |
geoFilter(java.lang.String field,
double lon,
double lat,
double radius,
GeoUnit unit) |
boolean |
getNoContent() |
boolean |
getWithScores() |
FTSearchParams |
highlight() |
FTSearchParams |
highlight(FTSearchParams.HighlightParams highlightParams) |
static FTSearchParams.HighlightParams |
highlightParams() |
FTSearchParams |
inFields(java.util.Collection<java.lang.String> fields) |
FTSearchParams |
inFields(java.lang.String... fields)
Limit the query to results that are limited to a specific set of fields
|
FTSearchParams |
inKeys(java.util.Collection<java.lang.String> keys) |
FTSearchParams |
inKeys(java.lang.String... keys)
Limit the query to results that are limited to a specific set of keys
|
FTSearchParams |
inOrder() |
FTSearchParams |
language(java.lang.String language)
Set the query language, for stemming purposes
|
FTSearchParams |
limit(int offset,
int num)
Limit the results to a certain offset and limit
|
FTSearchParams |
noContent()
Set the query not to return the contents of documents, and rather just return the ids
|
FTSearchParams |
noStopwords()
Set the query not to filter for stopwords.
|
FTSearchParams |
params(java.util.Map<java.lang.String,java.lang.Object> paramValues) |
FTSearchParams |
returnField(FieldName field) |
FTSearchParams |
returnFields(java.util.Collection<FieldName> fields) |
FTSearchParams |
returnFields(FieldName... fields) |
FTSearchParams |
returnFields(java.lang.String... fields)
Result's projection - the fields to return by the query
|
FTSearchParams |
scorer(java.lang.String scorer)
Set the query custom scorer
|
static FTSearchParams |
searchParams() |
FTSearchParams |
slop(int slop) |
FTSearchParams |
sortBy(java.lang.String sortBy,
SortingOrder order)
Set the query to be sorted by a Sortable field defined in the schema
|
FTSearchParams |
summarize() |
FTSearchParams |
summarize(FTSearchParams.SummarizeParams summarizeParams) |
static FTSearchParams.SummarizeParams |
summarizeParams() |
FTSearchParams |
timeout(long timeout) |
FTSearchParams |
verbatim()
Set the query to verbatim mode, disabling stemming and query expansion
|
FTSearchParams |
withScores()
Set the query to return a factored score for each results.
|
public static FTSearchParams searchParams()
public void addParams(CommandArguments args)
public FTSearchParams noContent()
public FTSearchParams verbatim()
public FTSearchParams noStopwords()
public FTSearchParams withScores()
public FTSearchParams filter(java.lang.String field, double min, double max)
public FTSearchParams filter(java.lang.String field, double min, boolean exclusiveMin, double max, boolean exclusiveMax)
public FTSearchParams filter(FTSearchParams.NumericFilter numericFilter)
public FTSearchParams geoFilter(java.lang.String field, double lon, double lat, double radius, GeoUnit unit)
public FTSearchParams geoFilter(FTSearchParams.GeoFilter geoFilter)
public FTSearchParams inKeys(java.lang.String... keys)
keys
- a list of TEXT fields in the schemaspublic FTSearchParams inKeys(java.util.Collection<java.lang.String> keys)
public FTSearchParams inFields(java.lang.String... fields)
fields
- a list of TEXT fields in the schemaspublic FTSearchParams inFields(java.util.Collection<java.lang.String> fields)
public FTSearchParams returnFields(java.lang.String... fields)
fields
- a list of TEXT fields in the schemaspublic FTSearchParams returnField(FieldName field)
public FTSearchParams returnFields(FieldName... fields)
public FTSearchParams returnFields(java.util.Collection<FieldName> fields)
public FTSearchParams summarize()
public FTSearchParams summarize(FTSearchParams.SummarizeParams summarizeParams)
public FTSearchParams highlight()
public FTSearchParams highlight(FTSearchParams.HighlightParams highlightParams)
public FTSearchParams scorer(java.lang.String scorer)
See http://redisearch.io for documentation on extending RediSearch
scorer
- a custom scorer.public FTSearchParams slop(int slop)
public FTSearchParams timeout(long timeout)
public FTSearchParams inOrder()
public FTSearchParams language(java.lang.String language)
See http://redisearch.io for documentation on languages and stemming
language
- a language.public FTSearchParams sortBy(java.lang.String sortBy, SortingOrder order)
sortBy
- the sorting field's nameorder
- the sorting orderpublic FTSearchParams limit(int offset, int num)
offset
- the first result to show, zero based indexingnum
- how many results we want to showpublic FTSearchParams addParam(java.lang.String name, java.lang.Object value)
name
- value
- can be String, long or floatpublic FTSearchParams params(java.util.Map<java.lang.String,java.lang.Object> paramValues)
public FTSearchParams dialect(int dialect)
dialect
- integerpublic boolean getNoContent()
public boolean getWithScores()
public static FTSearchParams.SummarizeParams summarizeParams()
public static FTSearchParams.HighlightParams highlightParams()
Copyright © 2023. All rights reserved.