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

Class Match

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

All Implemented Interfaces:

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

Direct Known Subclasses:

MatchOperator

public class Match
extends SingleFieldFullTextFunction
implements OptionalArgument, ConfigurationFunction

Full text function that performs a MatchQuery .

Nested Class Summary

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

Expression.TypeResolution

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.tree.Node

Node.NodeStringFormat

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 FunctionDefinition	DEFINITION
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_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
Match(Source source, Expression field, Expression matchQuery, Expression options, QueryBuilder queryBuilder, Configuration configuration)
Match(Source source, Expression field, Expression matchQuery, Expression options, Configuration configuration)

Method Summary

Modifier and Type	Method	Description
protected Configuration	configuration()
boolean	contributesToScore()
boolean	equals(Object o)
protected void	fieldVerifier(LogicalPlan plan, FullTextFunction function, Expression field, Failures failures)
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()
int	hashCode()
protected NodeInfo<? extends Expression>	info()	Normally, you want to use one of the static create methods to implement this.
protected boolean	isRuntimeSearch()
Expression	replaceChildren(List<Expression> newChildren)
Expression	replaceQueryBuilder(QueryBuilder queryBuilder)	Replaces the current query builder with a rewritten iteration.
protected Expression.TypeResolution	resolveParams()	Resolves the type for the function parameters, as part of the type resolution for the function
ExpressionEvaluator.Factory	toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)	Convert this into an ExpressionEvaluator.
TranslationAware.Translatable	translatable(LucenePushdownPredicates pushdownPredicates)	Can this instance be translated or not? Usually checks whether the expression arguments are actual fields that exist in Lucene.
protected Query	translate(LucenePushdownPredicates pushdownPredicates, TranslatorHandler handler)
final void	writeTo(StreamOutput out)

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

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

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

asQuery, dataType, evaluatorQueryBuilder, fieldAsFieldAttribute, functionType, getNameFromFieldAttribute, postOptimizationVerification, query, queryBuilder, requiresQueryBuilderRewrite, resolveQuery, resolveType, toScorer

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

arguments, functionName, nodeString

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

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

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

allMatch, anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, nodeString, replaceChildrenSameSize, source, sourceLocation, sourceText, toString, transformChildren, transformChildren, transformDown, transformDown, transformDown, transformDown, transformDownSkipBranch, 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

DEFINITION

public static final FunctionDefinition DEFINITION

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

Match

public Match(Source source,
 Expression field,
 Expression matchQuery,
 Expression options,
 Configuration configuration)

Match

public Match(Source source,
 Expression field,
 Expression matchQuery,
 Expression options,
 QueryBuilder queryBuilder,
 Configuration configuration)

Method Details

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

resolveParams

protected Expression.TypeResolution resolveParams()

Description copied from class: FullTextFunction

Resolves the type for the function parameters, as part of the type resolution for the function

Overrides:

resolveParams in class SingleFieldFullTextFunction

Returns:

type resolution for the function parameters

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

configuration

protected Configuration configuration()

info

protected NodeInfo<? extends Expression> info()

Description copied from class: Node

Normally, you want to use one of the static create methods to implement this.

For QueryPlans, it is very important that the properties contain all of the expressions and references relevant to this node, and that all the properties are used in the provided constructor; otherwise query plan transformations like QueryPlan#transformExpressionsOnly(Function) will not have an effect.

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

isRuntimeSearch

protected boolean isRuntimeSearch()

Overrides:

isRuntimeSearch in class FullTextFunction

translatable

public TranslationAware.Translatable translatable(LucenePushdownPredicates pushdownPredicates)

Description copied from interface: TranslationAware

Can this instance be translated or not? Usually checks whether the expression arguments are actual fields that exist in Lucene. See TranslationAware.Translatable for precisely what can be signaled from this method.

Specified by:

translatable in interface TranslationAware

Overrides:

translatable in class FullTextFunction

fieldVerifier

protected void fieldVerifier(LogicalPlan plan,
 FullTextFunction function,
 Expression field,
 Failures failures)

Overrides:

fieldVerifier in class FullTextFunction

toEvaluator

public ExpressionEvaluator.Factory toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)

Description copied from interface: EvaluatorMapper

Convert this into an ExpressionEvaluator.

Note for implementors: If you are implementing this function, you should call the passed-in lambda on your children, after doing any other manipulation (casting, etc.) necessary.

Note for Callers: If you are attempting to call this method, and you have an Expression and a Layout, you likely want to call EvalMapper.toEvaluator(org.elasticsearch.xpack.esql.core.expression.FoldContext, org.elasticsearch.xpack.esql.core.expression.Expression, org.elasticsearch.xpack.esql.planner.Layout) instead. On the other hand, if you already have something that looks like the parameter for this method, you should call this method with that function.

Build an ExpressionEvaluator.Factory for the tree of expressions rooted at this node. This is only guaranteed to return a sensible evaluator if this node has a valid type. If this node is a subclass of Expression then "valid type" means that Expression.typeResolved() returns a non-error resolution. If Expression.typeResolved() returns an error then this method may throw. Or return an evaluator that produces garbage. Or return an evaluator that throws when run.

Specified by:

toEvaluator in interface EvaluatorMapper

Overrides:

toEvaluator in class FullTextFunction

equals

public boolean equals(Object o)

Overrides:

equals in class SingleFieldFullTextFunction

hashCode

public int hashCode()

Overrides:

hashCode in class SingleFieldFullTextFunction

contributesToScore

public boolean contributesToScore()

Specified by:

contributesToScore in interface ExpressionScoreMapper