Package org.elasticsearch.xpack.esql.expression.function.scalar.string.regex

Class WildcardLike

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.core.expression.function.scalar.ScalarFunction

org.elasticsearch.xpack.esql.core.expression.function.scalar.UnaryScalarFunction

org.elasticsearch.xpack.esql.core.expression.predicate.regex.RegexMatch<WildcardPattern>

org.elasticsearch.xpack.esql.expression.function.scalar.string.regex.WildcardLike

All Implemented Interfaces:

NamedWriteable, Writeable, TranslationAware, TranslationAware.SingleValueTranslationAware, Resolvable, EvaluatorMapper

public class WildcardLike
extends RegexMatch<WildcardPattern>

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.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 NamedWriteableRegistry.Entry	ENTRY
static final String	NAME

Fields inherited from class org.elasticsearch.xpack.esql.core.expression.function.scalar.ScalarFunction

MAX_BYTES_REF_RESULT_SIZE

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

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
WildcardLike(Source source, Expression left, WildcardPattern pattern)
WildcardLike(Source source, Expression left, WildcardPattern pattern, boolean caseInsensitive)

Method Summary

Modifier and Type	Method	Description
Query	asQuery(LucenePushdownPredicates pushdownPredicates, TranslatorHandler handler)	Translates the implementing expression into a Query.
Boolean	fold(FoldContext ctx)	Evaluate this expression statically to a constant.
String	getWriteableName()
protected NodeInfo<WildcardLike>	info()	Normally, you want to use one of the static create methods to implement this.
String	name()
void	nodeString(StringBuilder sb, Node.NodeStringFormat format, NodeStringMapper mapper)	Append this Node's string representation to sb.
Expression	optimizeStringCasingWithInsensitiveRegexMatch(Expression unwrappedField, Predicate<String> matchesCaseFn)	Pushes down string casing optimization for a single pattern using the provided predicate.
protected WildcardLike	replaceChild(Expression newLeft)
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
Expression	singleValueField()	Returns the field that only supports single-value semantics.
ExpressionEvaluator.Factory	toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)	Fast path for prefix, suffix, and contains wildcard shapes (e.g.
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.
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.predicate.regex.RegexMatch

caseInsensitive, dataType, equals, foldable, hashCode, nullable, pattern

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

field, replaceChildren

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

arguments, functionName

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

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

WildcardLike

public WildcardLike(Source source,
 Expression left,
 WildcardPattern pattern)

WildcardLike

public WildcardLike(Source source,
 Expression left,
 WildcardPattern pattern,
 boolean caseInsensitive)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class UnaryScalarFunction

Throws:

IOException

name

public String name()

getWriteableName

public String getWriteableName()

info

protected NodeInfo<WildcardLike> 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>

replaceChild

protected WildcardLike replaceChild(Expression newLeft)

Specified by:

replaceChild in class UnaryScalarFunction

toEvaluator

public ExpressionEvaluator.Factory toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)

Fast path for prefix, suffix, and contains wildcard shapes (e.g. LIKE "foo*", LIKE "*foo", LIKE "*foo*"): dispatch to byte-comparison / byte-substring-search evaluators instead of building an Automaton and running RunAutomaton.step per row. The general path (other patterns, case-insensitive matching) still goes through AutomataMatch. Prefix and suffix reuse the STARTS_WITH/ENDS_WITH evaluators; contains delegates to the SIMD-backed processContains(org.apache.lucene.util.BytesRef, org.apache.lucene.util.BytesRef) below.

Specified by:

toEvaluator in interface EvaluatorMapper

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

asQuery

public Query asQuery(LucenePushdownPredicates pushdownPredicates,
 TranslatorHandler handler)

Description copied from interface: TranslationAware

Translates the implementing expression into a Query. If during translation a child needs to be translated first, the handler needs to be used even if the child implements this interface as well. This is to ensure that the child is wrapped in a SingleValueQuery if necessary.

So use this:

Query childQuery = handler.asQuery(child);

and not this:

Query childQuery = child.asQuery(handler);

optimizeStringCasingWithInsensitiveRegexMatch

public Expression optimizeStringCasingWithInsensitiveRegexMatch(Expression unwrappedField,
 Predicate<String> matchesCaseFn)

Pushes down string casing optimization for a single pattern using the provided predicate. Returns a new WildcardLike with case insensitivity or a Literal.FALSE if not matched.

Specified by:

optimizeStringCasingWithInsensitiveRegexMatch in class RegexMatch<WildcardPattern>

Parameters:

unwrappedField - the field with to_upper/to_lower function removed

matchesCaseFn - a predicate to check if a pattern matches the case

Returns:

an optimized equivalent Expression or this if no optimization is possible

resolveType

protected Expression.TypeResolution resolveType()

Description copied from class: Expression

The implementation of Expression.typeResolved(), which is just a caching wrapper around this method. See it's javadoc for what this method should return.

Implementations will rarely interact with the Expression.TypeResolution class directly, instead usually calling the utility methods on TypeResolutions.

Implementations should fail if Expression.childrenResolved() returns false.

Overrides:

resolveType in class RegexMatch<P extends AbstractStringPattern>

fold

public Boolean fold(FoldContext ctx)

Description copied from class: Expression

Evaluate this expression statically to a constant. It is an error to call this if Expression.foldable() returns false.

Overrides:

fold in class RegexMatch<P extends AbstractStringPattern>

singleValueField

public Expression singleValueField()

Description copied from interface: TranslationAware.SingleValueTranslationAware

Returns the field that only supports single-value semantics.

Specified by:

singleValueField in interface TranslationAware.SingleValueTranslationAware

nodeString

public void nodeString(StringBuilder sb,
 Node.NodeStringFormat format,
 NodeStringMapper mapper)

Description copied from class: Node

Append this Node's string representation to sb. This does not include this node's Node.children().

Overrides:

nodeString in class Function

Parameters:

sb - target for the string

format - output-shape configuration (width / lines / property count)

mapper - identifier-mapping strategy (raw via NodeStringMapper.IDENTITY, anonymized via the failure-path anonymizer, etc.)