Class MultiMatchQueryBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentObject
,QueryBuilder
,Rewriteable<QueryBuilder>
public class MultiMatchQueryBuilder extends AbstractQueryBuilder<MultiMatchQueryBuilder>
MatchQueryBuilder
but supports multiple fields.-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MultiMatchQueryBuilder.Type
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields Modifier and Type Field Description static boolean
DEFAULT_FUZZY_TRANSPOSITIONS
static int
DEFAULT_MAX_EXPANSIONS
static Operator
DEFAULT_OPERATOR
static int
DEFAULT_PHRASE_SLOP
static int
DEFAULT_PREFIX_LENGTH
static MultiMatchQueryBuilder.Type
DEFAULT_TYPE
static MatchQuery.ZeroTermsQuery
DEFAULT_ZERO_TERMS_QUERY
static java.lang.String
NAME
Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName
-
Constructor Summary
Constructors Constructor Description MultiMatchQueryBuilder(java.lang.Object value, java.lang.String... fields)
Constructs a new text query.MultiMatchQueryBuilder(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description java.lang.String
analyzer()
MultiMatchQueryBuilder
analyzer(java.lang.String analyzer)
Explicitly set the analyzer to use.boolean
autoGenerateSynonymsPhraseQuery()
Whether phrase queries should be automatically generated for multi terms synonyms.MultiMatchQueryBuilder
autoGenerateSynonymsPhraseQuery(boolean enable)
java.lang.Float
cutoffFrequency()
MultiMatchQueryBuilder
cutoffFrequency(float cutoff)
Deprecated.Since max_score optimization landed in 7.0, normal MultiMatchQuery will achieve the same result without any configuration.MultiMatchQueryBuilder
cutoffFrequency(java.lang.Float 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
doHashCode()
protected org.apache.lucene.search.Query
doToQuery(QueryShardContext context)
protected void
doWriteTo(StreamOutput out)
void
doXContent(XContentBuilder builder, ToXContent.Params params)
MultiMatchQueryBuilder
field(java.lang.String field)
Adds a field to run the multi match against.MultiMatchQueryBuilder
field(java.lang.String field, float boost)
Adds a field to run the multi match against with a specific boost.java.util.Map<java.lang.String,java.lang.Float>
fields()
MultiMatchQueryBuilder
fields(java.util.Map<java.lang.String,java.lang.Float> fields)
Add several fields to run the query against with a specific boost.static MultiMatchQueryBuilder
fromXContent(XContentParser parser)
Fuzziness
fuzziness()
MultiMatchQueryBuilder
fuzziness(java.lang.Object fuzziness)
Sets the fuzziness used when evaluated to a fuzzy query type.java.lang.String
fuzzyRewrite()
MultiMatchQueryBuilder
fuzzyRewrite(java.lang.String fuzzyRewrite)
boolean
fuzzyTranspositions()
MultiMatchQueryBuilder
fuzzyTranspositions(boolean fuzzyTranspositions)
Sets whether transpositions are supported in fuzzy queries.MultiMatchQueryBuilder.Type
getType()
Returns the type (for testing)java.lang.String
getWriteableName()
Returns the name of the writeable objectboolean
lenient()
MultiMatchQueryBuilder
lenient(boolean lenient)
Sets whether format based failures will be ignored.int
maxExpansions()
MultiMatchQueryBuilder
maxExpansions(int maxExpansions)
When using fuzzy or prefix type query, the number of term expansions to use.java.lang.String
minimumShouldMatch()
MultiMatchQueryBuilder
minimumShouldMatch(java.lang.String minimumShouldMatch)
Operator
operator()
MultiMatchQueryBuilder
operator(Operator operator)
Sets the operator to use when using a boolean query.int
prefixLength()
MultiMatchQueryBuilder
prefixLength(int prefixLength)
int
slop()
MultiMatchQueryBuilder
slop(int slop)
Set the phrase slop if evaluated to a phrase query type.java.lang.Float
tieBreaker()
MultiMatchQueryBuilder
tieBreaker(float tieBreaker)
Tie-Breaker for "best-match" disjunction queries (OR-Queries).MultiMatchQueryBuilder
tieBreaker(java.lang.Float tieBreaker)
Tie-Breaker for "best-match" disjunction queries (OR-Queries).MultiMatchQueryBuilder.Type
type()
MultiMatchQueryBuilder
type(java.lang.Object type)
Sets the type of the text query.MultiMatchQueryBuilder
type(MultiMatchQueryBuilder.Type type)
Sets the type of the text query.java.lang.Object
value()
MatchQuery.ZeroTermsQuery
zeroTermsQuery()
MultiMatchQueryBuilder
zeroTermsQuery(MatchQuery.ZeroTermsQuery zeroTermsQuery)
Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo
-
Field Details
-
NAME
public static final java.lang.String 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(java.lang.Object value, java.lang.String... fields)Constructs a new text query. -
MultiMatchQueryBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
getType
Returns the type (for testing) -
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<MultiMatchQueryBuilder>
- Throws:
java.io.IOException
-
value
public java.lang.Object value() -
field
Adds a field to run the multi match against. -
field
Adds a field to run the multi match against with a specific boost. -
fields
Add several fields to run the query against with a specific boost. -
fields
public java.util.Map<java.lang.String,java.lang.Float> fields() -
type
Sets the type of the text query. -
type
Sets the type of the text query. -
type
-
operator
Sets the operator to use when using a boolean query. Defaults toOR
. -
operator
-
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 java.lang.String analyzer() -
slop
Set the phrase slop if evaluated to a phrase query type. -
slop
public int slop() -
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
-
minimumShouldMatch
public java.lang.String minimumShouldMatch() -
fuzzyRewrite
-
fuzzyRewrite
public java.lang.String 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
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 java.lang.Float 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
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 java.lang.Float 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(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
doXContent
in classAbstractQueryBuilder<MultiMatchQueryBuilder>
- Throws:
java.io.IOException
-
fromXContent
public static MultiMatchQueryBuilder fromXContent(XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object -
doToQuery
protected org.apache.lucene.search.Query doToQuery(QueryShardContext context) throws java.io.IOException- Specified by:
doToQuery
in classAbstractQueryBuilder<MultiMatchQueryBuilder>
- Throws:
java.io.IOException
-
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>
-