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

Class MatchOperator

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

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

All Implemented Interfaces:

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

public class MatchOperator
extends Match

This class performs a MatchQuery using an operator. This is used as a convenience for generating documentation and for error message purposes - it’s a way to represent the match operator in the function syntax. Serialization is provided as a way to pass the corresponding tests - serialization must be done to a Match class.

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 inherited from class org.elasticsearch.xpack.esql.expression.function.fulltext.Match

ALLOWED_OPTIONS, ENTRY, FIELD_DATA_TYPES, 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
MatchOperator(Source source, Expression field, Expression matchQuery)

Method Summary

Modifier and Type	Method	Description
String	functionName()
String	functionType()	Used to differentiate error messages between functions and operators
protected NodeInfo<? extends Expression>	info()	Normally, you want to use one of the static create methods to implement this.
Expression	replaceChildren(List<Expression> newChildren)
Expression	replaceQueryBuilder(QueryBuilder queryBuilder)	Replaces the current query builder with a rewritten iteration.

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

getAllowedOptions, getFieldDataTypes, getQueryDataTypes, getWriteableName, resolveParams, translate, writeTo

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, resolveQuery

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

asQuery, dataType, evaluatorQueryBuilder, fieldAsFieldAttribute, fieldVerifier, 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, collect, 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

Constructor Details

MatchOperator

public MatchOperator(Source source,
 Expression field,
 Expression matchQuery)

Method Details

functionType

public String functionType()

Description copied from class: FullTextFunction

Used to differentiate error messages between functions and operators

Overrides:

functionType in class FullTextFunction

Returns:

function type for error messages

functionName

public String functionName()

Overrides:

functionName in class Function

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.

Overrides:

info in class Match

replaceChildren

public Expression replaceChildren(List<Expression> newChildren)

Overrides:

replaceChildren in class Match

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

Overrides:

replaceQueryBuilder in class Match

Parameters:

queryBuilder - QueryBuilder

Returns:

Expression defining the active QueryBuilder