EQL: Add wildcard function #54020
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.xpack.eql.expression.function.scalar.string; | ||
|
|
||
| import org.elasticsearch.xpack.eql.EqlIllegalArgumentException; | ||
| import org.elasticsearch.xpack.eql.util.StringUtils; | ||
| import org.elasticsearch.xpack.ql.expression.Expression; | ||
| import org.elasticsearch.xpack.ql.expression.Expressions; | ||
| import org.elasticsearch.xpack.ql.expression.Expressions.ParamOrdinal; | ||
| import org.elasticsearch.xpack.ql.expression.function.scalar.ScalarFunction; | ||
| import org.elasticsearch.xpack.ql.expression.gen.pipeline.Pipe; | ||
| import org.elasticsearch.xpack.ql.expression.gen.script.ScriptTemplate; | ||
| import org.elasticsearch.xpack.ql.expression.predicate.logical.Or; | ||
| import org.elasticsearch.xpack.ql.expression.predicate.regex.Like; | ||
| import org.elasticsearch.xpack.ql.tree.NodeInfo; | ||
| import org.elasticsearch.xpack.ql.tree.Source; | ||
| import org.elasticsearch.xpack.ql.type.DataType; | ||
| import org.elasticsearch.xpack.ql.type.DataTypes; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import static org.elasticsearch.common.logging.LoggerMessageFormat.format; | ||
| import static org.elasticsearch.xpack.ql.expression.TypeResolutions.isStringAndExact; | ||
|
|
||
| /** | ||
| * EQL wildcard function. Matches the form: | ||
| * wildcard(field, "*wildcard*pattern*", "*wildcard*pattern*") | ||
| */ | ||
| public class Wildcard extends ScalarFunction { | ||
|
Member
There was a problem hiding this comment. Please implement the methods in the order of the super class (which is not alphabetical) which roughly is: constructor |
||
|
|
||
| private final Expression field; | ||
| private final List<Expression> patterns; | ||
|
|
||
| public Wildcard(Source source, Expression field, List<Expression> patterns) { | ||
| super(source, toArguments(field, patterns)); | ||
| this.field = field; | ||
| this.patterns = patterns; | ||
| } | ||
|
|
||
| @Override | ||
| protected NodeInfo<? extends Expression> info() { | ||
| return NodeInfo.create(this, Wildcard::new, field, patterns); | ||
| } | ||
|
|
||
| @Override | ||
| public Expression replaceChildren(List<Expression> newChildren) { | ||
| if (newChildren.size() < 2) { | ||
| throw new IllegalArgumentException("expected at least [2] children but received [" + newChildren.size() + "]"); | ||
| } | ||
|
|
||
| return new Wildcard(source(), newChildren.get(0), newChildren.subList(1, newChildren.size())); | ||
| } | ||
|
|
||
| @Override | ||
| public DataType dataType() { | ||
| return DataTypes.BOOLEAN; | ||
| } | ||
|
|
||
| @Override | ||
| protected TypeResolution resolveType() { | ||
| if (!childrenResolved()) { | ||
|
||
| return new TypeResolution("Unresolved children"); | ||
| } | ||
|
|
||
| TypeResolution lastResolution = isStringAndExact(field, sourceText(), ParamOrdinal.FIRST); | ||
| if (lastResolution.unresolved()) { | ||
| return lastResolution; | ||
| } | ||
|
|
||
| for (Expression p: patterns) { | ||
| lastResolution = isStringAndExact(p, sourceText(), ParamOrdinal.DEFAULT); | ||
|
||
| if (lastResolution.unresolved()) { | ||
| break; | ||
| } | ||
|
|
||
| if (p.foldable() == false) { | ||
| return new TypeResolution(format(null, "wildcard against variables are not (currently) supported; offender [{}] in [{}]", | ||
| Expressions.name(p), | ||
| sourceText())); | ||
| } | ||
| } | ||
|
|
||
| return lastResolution; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean foldable() { | ||
| return Expressions.foldable(arguments()); | ||
|
||
| } | ||
|
|
||
| @Override | ||
| public Object fold() { | ||
| return asLikes().fold(); | ||
| } | ||
|
|
||
| @Override | ||
| protected Pipe makePipe() { | ||
| throw new EqlIllegalArgumentException("Wildcard.makePipe() should not be called directly"); | ||
| } | ||
|
|
||
| @Override | ||
| public ScriptTemplate asScript() { | ||
| throw new EqlIllegalArgumentException("Wildcard.asScript() should not be called directly"); | ||
| } | ||
|
|
||
| public ScalarFunction asLikes() { | ||
| ScalarFunction result = null; | ||
|
|
||
| for (Expression pattern: patterns) { | ||
| String wcString = pattern.fold().toString(); | ||
| Like like = new Like(source(), field, StringUtils.toLikePattern(wcString)); | ||
| result = result == null ? like : new Or(source(), result, like); | ||
| } | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| private static List<Expression> toArguments(Expression src, List<Expression> patterns) { | ||
|
||
| ArrayList<Expression> arguments = new ArrayList<>(); | ||
| arguments.add(src); | ||
| arguments.addAll(patterns); | ||
| return arguments; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
|
|
||
| package org.elasticsearch.xpack.eql.util; | ||
|
|
||
| import org.elasticsearch.xpack.ql.expression.predicate.regex.LikePattern; | ||
|
|
||
| public final class StringUtils { | ||
|
|
||
| private StringUtils() {} | ||
|
|
||
| /** | ||
| * Convert an EQL wildcard string to a LikePattern. | ||
| */ | ||
| public static LikePattern toLikePattern(String s) { | ||
| // pick a character that is guaranteed not to be in the string, because it isn't allowed to escape itself | ||
| char escape = 1; | ||
|
|
||
| // replace wildcards with % and escape special characters | ||
| String likeString = s.replace("%", escape + "%") | ||
| .replace("_", escape + "_") | ||
| .replace("*", "%"); | ||
|
|
||
| return new LikePattern(likeString, escape); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -421,4 +421,26 @@ public static <T extends Function> FunctionDefinition def(Class<T> function, | |
| protected interface CastFunctionBuilder<T> { | ||
| T build(Source source, Expression expression, DataType dataType); | ||
| } | ||
|
|
||
| @SuppressWarnings("overloads") // These are ambiguous if you aren't using ctor references but we always do | ||
| public static <T extends Function> FunctionDefinition def(Class<T> function, | ||
|
Member
There was a problem hiding this comment. How many arguments does wildcard expect?
Contributor
Author
There was a problem hiding this comment. at least two, but it's unbounded in the maximum number |
||
| TwoParametersVariadicBuilder<T> ctorRef, String... names) { | ||
| FunctionBuilder builder = (source, children, distinct, cfg) -> { | ||
| boolean hasMinimumOne = OptionalArgument.class.isAssignableFrom(function); | ||
| if (hasMinimumOne && children.size() < 1) { | ||
| throw new QlIllegalArgumentException("expects at least one argument"); | ||
| } else if (!hasMinimumOne && children.size() < 2) { | ||
| throw new QlIllegalArgumentException("expects at least two arguments"); | ||
| } | ||
| if (distinct) { | ||
| throw new QlIllegalArgumentException("does not support DISTINCT yet it was specified"); | ||
| } | ||
| return ctorRef.build(source, children.get(0), children.subList(1, children.size())); | ||
| }; | ||
| return def(function, builder, false, names); | ||
| } | ||
|
|
||
| protected interface TwoParametersVariadicBuilder<T> { | ||
| T build(Source source, Expression src, List<Expression> remaining); | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Isn't
wildcarda "string function"? If so, it should belong to the FunctionDefinition array that, also, hassubstringin it. In SQL we were grouping these functions by their type: string, grouping, math, conditional, date etc.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh right, good catch