Package org.elasticsearch.xpack.esql.expression.function.fulltext

Class MatchPhrase

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<Expression>

org.elasticsearch.xpack.esql.core.expression.Expression

org.elasticsearch.xpack.esql.core.expression.function.Function

org.elasticsearch.xpack.esql.expression.function.fulltext.FullTextFunction

org.elasticsearch.xpack.esql.expression.function.fulltext.SingleFieldFullTextFunction

org.elasticsearch.xpack.esql.expression.function.fulltext.MatchPhrase

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisPlanVerificationAware, PostOptimizationPlanVerificationAware, PostOptimizationVerificationAware, RewriteableAware, TranslationAware, Resolvable, EvaluatorMapper, OptionalArgument, ExpressionScoreMapper

public class MatchPhrase
extends SingleFieldFullTextFunction
implements OptionalArgument

Full text function that performs a MatchPhraseQuery .

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper

EvaluatorMapper.ToEvaluator

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.score.ExpressionScoreMapper

ExpressionScoreMapper.ToScorer

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.capabilities.PostOptimizationVerificationAware

PostOptimizationVerificationAware.CoordinatorOnly

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.capabilities.TranslationAware

TranslationAware.FinishedTranslatable, TranslationAware.SingleValueTranslationAware, TranslationAware.Translatable

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 final Map<String,DataType>	ALLOWED_OPTIONS
static final NamedWriteableRegistry.Entry	ENTRY
static final Set<DataType>	FIELD_DATA_TYPES
static final Set<DataType>	QUERY_DATA_TYPES

Fields inherited from class org.elasticsearch.xpack.esql.expression.function.fulltext.SingleFieldFullTextFunction

field

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
MatchPhrase(Source source, Expression field, Expression matchPhraseQuery, Expression options)
MatchPhrase(Source source, Expression field, Expression matchPhraseQuery, Expression options, QueryBuilder queryBuilder)

Method Summary

Modifier and Type	Method	Description
String	functionName()
protected Map<String,DataType>	getAllowedOptions()	Returns the allowed options map for this function.
protected Set<DataType>	getFieldDataTypes()	Returns the set of allowed data types for the field parameter.
protected Set<DataType>	getQueryDataTypes()	Returns the set of allowed data types for the query parameter.
String	getWriteableName()
protected NodeInfo<? extends Expression>	info()
Expression	replaceChildren(List<Expression> newChildren)
Expression	replaceQueryBuilder(QueryBuilder queryBuilder)	Replaces the current query builder with a rewritten iteration.
protected Query	translate(LucenePushdownPredicates pushdownPredicates, TranslatorHandler handler)
final void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.expression.function.fulltext.SingleFieldFullTextFunction

equals, expectedFieldTypesString, expectedQueryTypesString, field, fieldAsFieldAttribute, fold, foldable, hashCode, nullable, options, postAnalysisPlanVerification, postOptimizationPlanVerification, queryAsObject, resolveField, resolveOptions, resolveParams, resolveQuery

Methods inherited from class org.elasticsearch.xpack.esql.expression.function.fulltext.FullTextFunction

asQuery, dataType, evaluatorQueryBuilder, fieldAsFieldAttribute, fieldVerifier, functionType, getNameFromFieldAttribute, postOptimizationVerification, query, queryBuilder, resolveQuery, resolveType, toEvaluator, toScorer, translatable

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function

arguments, nodeString

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, canonicalize, childrenResolved, propertiesToString, references, resolved, semanticEquals, semanticHash, toString, typeResolved

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

anyMatch, children, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformDown, transformDown, transformDown, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper

fold

Methods inherited from interface org.elasticsearch.xpack.esql.capabilities.TranslationAware

asLuceneQuery

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

FIELD_DATA_TYPES

public static final Set<DataType> FIELD_DATA_TYPES

QUERY_DATA_TYPES

public static final Set<DataType> QUERY_DATA_TYPES

ALLOWED_OPTIONS

public static final Map<String,DataType> ALLOWED_OPTIONS

Constructor Details

MatchPhrase

public MatchPhrase(Source source,
 Expression field,
 Expression matchPhraseQuery,
 Expression options)

MatchPhrase

public MatchPhrase(Source source,
 Expression field,
 Expression matchPhraseQuery,
 Expression options,
 QueryBuilder queryBuilder)

Method Details

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

functionName

public String functionName()

Overrides:

functionName in class Function

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getFieldDataTypes

protected Set<DataType> getFieldDataTypes()

Description copied from class: SingleFieldFullTextFunction

Returns the set of allowed data types for the field parameter. Each subclass defines which field types it supports.

Specified by:

getFieldDataTypes in class SingleFieldFullTextFunction

getQueryDataTypes

protected Set<DataType> getQueryDataTypes()

Description copied from class: SingleFieldFullTextFunction

Returns the set of allowed data types for the query parameter. Each subclass defines which query types it supports.

Specified by:

getQueryDataTypes in class SingleFieldFullTextFunction

getAllowedOptions

protected Map<String,DataType> getAllowedOptions()

Description copied from class: SingleFieldFullTextFunction

Returns the allowed options map for this function. Keys are option names, values are the expected data types.

Specified by:

getAllowedOptions in class SingleFieldFullTextFunction

info

protected NodeInfo<? extends Expression> info()

Specified by:

info in class Node<Expression>

replaceChildren

public Expression replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

replaceQueryBuilder

public Expression replaceQueryBuilder(QueryBuilder queryBuilder)

Description copied from interface: RewriteableAware

Replaces the current query builder with a rewritten iteration. This happens multiple times through the rewrite phase until the final iteration of the query builder is stored.

Specified by:

replaceQueryBuilder in interface RewriteableAware

Parameters:

queryBuilder - QueryBuilder

Returns:

Expression defining the active QueryBuilder

translate

protected Query translate(LucenePushdownPredicates pushdownPredicates,
 TranslatorHandler handler)

Specified by:

translate in class FullTextFunction