Class MultiMatchQueryBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,QueryBuilder
,Rewriteable<QueryBuilder>
MatchQueryBuilder
but supports multiple fields.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Modifier and TypeFieldDescriptionstatic boolean
static int
static Operator
static int
static int
static MultiMatchQueryBuilder.Type
static ZeroTermsQueryOption
static
Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName
Fields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDS
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionvalue, ... fields)
Constructs a new text query.Read from a stream. -
Method Summary
Modifier and TypeMethodDescriptionanalyzer()
analyzer)
Explicitly set the analyzer to use.boolean
Whether phrase queries should be automatically generated for multi terms synonyms.autoGenerateSynonymsPhraseQuery(boolean enable)
cutoffFrequency(float cutoff)
Deprecated.Since max_score optimization landed in 7.0, normal MultiMatchQuery will achieve the same result without any configuration.cutoff)
Deprecated.Since max_score optimization landed in 7.0, normal MultiMatchQuery will achieve the same result without any configuration.protected boolean
doEquals(MultiMatchQueryBuilder other)
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.protected int
protected org.apache.lucene.search.Query
doToQuery(SearchExecutionContext context)
protected void
doWriteTo(StreamOutput out)
void
doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
field)
Adds a field to run the multi match against.field, float boost)
Adds a field to run the multi match against with a specific boost.<,>
fields()
<,> fields)
Add several fields to run the query against with a specific boost.static MultiMatchQueryBuilder
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
fuzziness)
Sets the fuzziness used when evaluated to a fuzzy query type.fuzzyRewrite)
boolean
fuzzyTranspositions(boolean fuzzyTranspositions)
Sets whether transpositions are supported in fuzzy queries.getType()
Returns the type (for testing)Returns the name of the writeable objectboolean
lenient()
lenient(boolean lenient)
Sets whether format based failures will be ignored.int
maxExpansions(int maxExpansions)
When using fuzzy or prefix type query, the number of term expansions to use.minimumShouldMatch)
operator()
Sets the operator to use when using a boolean query.int
prefixLength(int prefixLength)
int
slop()
slop(int slop)
Set the phrase slop if evaluated to a phrase query type.tieBreaker(float tieBreaker)
Tie-Breaker for "best-match" disjunction queries (OR-Queries).tieBreaker)
Tie-Breaker for "best-match" disjunction queries (OR-Queries).type()
type)
Sets the type of the text query.type(MultiMatchQueryBuilder.Type type)
Sets the type of the text query.value()
zeroTermsQuery(ZeroTermsQueryOption zeroTermsQuery)
Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo
Methods inherited from class java.lang.
, , , , , , ,
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
public static final NAME- See Also:
- Constant Field Values
-
DEFAULT_TYPE
-
DEFAULT_OPERATOR
-
DEFAULT_PHRASE_SLOP
public static final int DEFAULT_PHRASE_SLOP- See Also:
- Constant Field Values
-
DEFAULT_PREFIX_LENGTH
public static final int DEFAULT_PREFIX_LENGTH- See Also:
- Constant Field Values
-
DEFAULT_MAX_EXPANSIONS
public static final int DEFAULT_MAX_EXPANSIONS- See Also:
- Constant Field Values
-
DEFAULT_ZERO_TERMS_QUERY
-
DEFAULT_FUZZY_TRANSPOSITIONS
public static final boolean DEFAULT_FUZZY_TRANSPOSITIONS- See Also:
- Constant Field Values
-
-
Constructor Details
-
MultiMatchQueryBuilder
public MultiMatchQueryBuilder( value, ... fields)Constructs a new text query. -
MultiMatchQueryBuilder
Read from a stream.- Throws:
-
-
Method Details
-
getType
Returns the type (for testing) -
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<MultiMatchQueryBuilder>
- Throws:
-
value
public value() -
field
public field)Adds a field to run the multi match against. -
field
public field, float boost)Adds a field to run the multi match against with a specific boost. -
fields
public <,> fields)Add several fields to run the query against with a specific boost. -
fields
public <,> fields() -
type
Sets the type of the text query. -
type
public type)Sets the type of the text query. -
type
-
operator
Sets the operator to use when using a boolean query. Defaults toOR
. -
operator
-
analyzer
public analyzer)Explicitly set the analyzer to use. Defaults to use explicit mapping config for the field, or, if not set, the default search analyzer. -
analyzer
public analyzer() -
slop
Set the phrase slop if evaluated to a phrase query type. -
slop
public int slop() -
fuzziness
public fuzziness)Sets the fuzziness used when evaluated to a fuzzy query type. Defaults to "AUTO". -
fuzziness
-
prefixLength
-
prefixLength
public int prefixLength() -
maxExpansions
When using fuzzy or prefix type query, the number of term expansions to use. Defaults to unbounded so its recommended to set it to a reasonable value for faster execution. -
maxExpansions
public int maxExpansions() -
minimumShouldMatch
public minimumShouldMatch) -
minimumShouldMatch
public minimumShouldMatch() -
fuzzyRewrite
public fuzzyRewrite) -
fuzzyRewrite
public fuzzyRewrite() -
tieBreaker
Tie-Breaker for "best-match" disjunction queries (OR-Queries). The tie breaker capability allows documents that match more than one query clause (in this case on more than one field) to be scored better than documents that match only the best of the fields, without confusing this with the better case of two distinct matches in the multiple fields.
A tie-breaker value of
1.0
is interpreted as a signal to score queries as "most-match" queries where all matching query clauses are considered for scoring.- See Also:
MultiMatchQueryBuilder.Type
-
tieBreaker
public tieBreaker)Tie-Breaker for "best-match" disjunction queries (OR-Queries). The tie breaker capability allows documents that match more than one query clause (in this case on more than one field) to be scored better than documents that match only the best of the fields, without confusing this with the better case of two distinct matches in the multiple fields.
A tie-breaker value of
1.0
is interpreted as a signal to score queries as "most-match" queries where all matching query clauses are considered for scoring.- See Also:
MultiMatchQueryBuilder.Type
-
tieBreaker
public tieBreaker() -
lenient
Sets whether format based failures will be ignored. -
lenient
public boolean lenient() -
cutoffFrequency
Deprecated.Since max_score optimization landed in 7.0, normal MultiMatchQuery will achieve the same result without any configuration.Set a cutoff value in [0..1] (or absolute number >=1) representing the maximum threshold of a terms document frequency to be considered a low frequency term. -
cutoffFrequency
public cutoff)Deprecated.Since max_score optimization landed in 7.0, normal MultiMatchQuery will achieve the same result without any configuration.Set a cutoff value in [0..1] (or absolute number >=1) representing the maximum threshold of a terms document frequency to be considered a low frequency term. -
cutoffFrequency
public cutoffFrequency() -
zeroTermsQuery
-
zeroTermsQuery
-
autoGenerateSynonymsPhraseQuery
-
autoGenerateSynonymsPhraseQuery
public boolean autoGenerateSynonymsPhraseQuery()Whether phrase queries should be automatically generated for multi terms synonyms. Defaults totrue
. -
fuzzyTranspositions
public boolean fuzzyTranspositions() -
fuzzyTranspositions
Sets whether transpositions are supported in fuzzy queries.The default metric used by fuzzy queries to determine a match is the Damerau-Levenshtein distance formula which supports transpositions. Setting transposition to false will switch to classic Levenshtein distance.
If not set, Damerau-Levenshtein distance metric will be used. -
doXContent
public void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws- Specified by:
doXContent
in classAbstractQueryBuilder<MultiMatchQueryBuilder>
- Throws:
-
fromXContent
public static MultiMatchQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws- Throws:
-
getWriteableName
public getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object -
doToQuery
- Specified by:
doToQuery
in classAbstractQueryBuilder<MultiMatchQueryBuilder>
- Throws:
-
doHashCode
protected int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<MultiMatchQueryBuilder>
-
doEquals
Description copied from class:AbstractQueryBuilder
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.- Specified by:
doEquals
in classAbstractQueryBuilder<MultiMatchQueryBuilder>
-