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.Match
- All Implemented Interfaces:
NamedWriteable,Writeable,PostAnalysisPlanVerificationAware,TranslationAware,Resolvable,EvaluatorMapper,OptionalArgument,ExpressionScoreMapper
- Direct Known Subclasses:
MatchOperator
public class Match
extends FullTextFunction
implements OptionalArgument, PostAnalysisPlanVerificationAware
Full text function that performs a
MatchQuery .-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression
Expression.TypeResolutionNested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper
EvaluatorMapper.ToEvaluatorNested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.score.ExpressionScoreMapper
ExpressionScoreMapper.ToScorerNested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.capabilities.TranslationAware
TranslationAware.FinishedTranslatable, TranslationAware.SingleValueTranslationAware, TranslationAware.TranslatableNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final NamedWriteableRegistry.Entryprotected final Expression -
Constructor Summary
ConstructorsConstructorDescriptionMatch(Source source, Expression field, Expression matchQuery, Expression options) Match(Source source, Expression field, Expression matchQuery, Expression options, QueryBuilder queryBuilder) -
Method Summary
Modifier and TypeMethodDescriptionbooleanfield()inthashCode()protected NodeInfo<? extends Expression> info()options()Allows the implementer to return a consumer that will perform self-validation in the context of the tree structure the implementer is part of.Returns the resulting query as an objectreplaceChildren(List<Expression> newChildren) replaceQueryBuilder(QueryBuilder queryBuilder) protected Expression.TypeResolutionResolves the type for the function parameters, as part of the type resolution for the functionprotected Querytranslate(TranslatorHandler handler) final voidwriteTo(StreamOutput out) Methods inherited from class org.elasticsearch.xpack.esql.expression.function.fulltext.FullTextFunction
asQuery, dataType, fieldAsFieldAttribute, fieldVerifier, functionType, getNameFromFieldAttribute, nullable, populateOptionsMap, query, queryBuilder, resolveOptions, resolveQuery, resolveType, toEvaluator, toScorer, translatableMethods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function
arguments, functionName, nodeStringMethods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression
canonical, canonicalize, childrenResolved, fold, foldable, propertiesToString, references, resolved, semanticEquals, semanticHash, toString, typeResolvedMethods inherited from class org.elasticsearch.xpack.esql.core.tree.Node
anyMatch, children, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformDown, transformDown, transformDown, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUpMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper
foldMethods inherited from interface org.elasticsearch.xpack.esql.capabilities.TranslationAware
asLuceneQuery
-
Field Details
-
ENTRY
-
FIELD_DATA_TYPES
-
QUERY_DATA_TYPES
-
field
-
ALLOWED_OPTIONS
-
-
Constructor Details
-
Match
-
Match
public Match(Source source, Expression field, Expression matchQuery, Expression options, QueryBuilder queryBuilder)
-
-
Method Details
-
getWriteableName
- Specified by:
getWriteableNamein interfaceNamedWriteable
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
resolveParams
Description copied from class:FullTextFunctionResolves the type for the function parameters, as part of the type resolution for the function- Overrides:
resolveParamsin classFullTextFunction- Returns:
- type resolution for the function parameters
-
resolvedOptions
- Overrides:
resolvedOptionsin classFullTextFunction
-
field
-
options
-
info
- Specified by:
infoin classNode<Expression>
-
replaceChildren
- Specified by:
replaceChildrenin classNode<Expression>
-
replaceQueryBuilder
- Specified by:
replaceQueryBuilderin classFullTextFunction
-
postAnalysisPlanVerification
Description copied from interface:PostAnalysisPlanVerificationAwareAllows the implementer to return a consumer that will perform self-validation in the context of the tree structure the implementer is part of. This usually involves checking the type and configuration of the children or that of the parent.It is often more useful to perform the checks as extended as it makes sense, over stopping at the first failure. This will allow the author to progress faster to a correct query.
Example: a
GroupingFunctioninstance, which models a function to group documents to aggregate over, can only be used in the context of the STATS command, modeled by theAggregateclass. This is how this verification is performed:@Override public BiConsumer<LogicalPlan, Failures> postAnalysisPlanVerification() { return (p, failures) -> { if (p instanceof Aggregate == false) { p.forEachExpression( GroupingFunction.class, gf -> failures.add(fail(gf, "cannot use grouping function [{}] outside of a STATS command", gf.sourceText())) ); } }; }- Specified by:
postAnalysisPlanVerificationin interfacePostAnalysisPlanVerificationAware- Overrides:
postAnalysisPlanVerificationin classFullTextFunction- Returns:
- a consumer that will receive a tree to check and an accumulator of failures found during inspection.
-
queryAsObject
Description copied from class:FullTextFunctionReturns the resulting query as an object- Overrides:
queryAsObjectin classFullTextFunction- Returns:
- query expression as an object
-
translate
- Specified by:
translatein classFullTextFunction
-
equals
- Overrides:
equalsin classFullTextFunction
-
hashCode
public int hashCode()- Overrides:
hashCodein classFullTextFunction
-