Add compare_ip operator udfs #3821
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
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 |
|---|---|---|
|
|
@@ -400,6 +400,10 @@ private static List<ExprType> getExprTypes(SqlTypeFamily family) { | |
| OpenSearchTypeFactory.TYPE_FACTORY.createSqlType(SqlTypeName.INTEGER)); | ||
| case ANY, IGNORE -> List.of( | ||
| OpenSearchTypeFactory.TYPE_FACTORY.createSqlType(SqlTypeName.ANY)); | ||
| // We borrow SqlTypeFamily.NULL to represent EXPR_IP. This is a workaround | ||
|
Collaborator
There was a problem hiding this comment. If we stop use
Collaborator
There was a problem hiding this comment. @qianheng-aws How about this implementation ishaoxy#1
Collaborator
There was a problem hiding this comment. It just came to me that there's not only compare that checks IP type. CIDR_MATCH also has to validate IP types. If we make a specific IP type checker for compare operators, we may also have to create one for each other functions like cidrmatch and geoip. |
||
| // since there is no corresponding IP type family in Calcite. | ||
| case NULL -> List.of( | ||
| OpenSearchTypeFactory.TYPE_FACTORY.createUDT(OpenSearchTypeFactory.ExprUDT.EXPR_IP)); | ||
| default -> { | ||
| RelDataType type = family.getDefaultConcreteType(OpenSearchTypeFactory.TYPE_FACTORY); | ||
| if (type == null) { | ||
|
|
||
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,134 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.sql.expression.function.udf.ip; | ||
|
|
||
| import inet.ipaddr.IPAddress; | ||
| import java.util.List; | ||
| import org.apache.calcite.adapter.enumerable.NotNullImplementor; | ||
| import org.apache.calcite.adapter.enumerable.NullPolicy; | ||
| import org.apache.calcite.adapter.enumerable.RexToLixTranslator; | ||
| import org.apache.calcite.linq4j.tree.Expression; | ||
| import org.apache.calcite.linq4j.tree.Expressions; | ||
| import org.apache.calcite.rex.RexCall; | ||
| import org.apache.calcite.sql.type.CompositeOperandTypeChecker; | ||
| import org.apache.calcite.sql.type.OperandTypes; | ||
| import org.apache.calcite.sql.type.ReturnTypes; | ||
| import org.apache.calcite.sql.type.SqlReturnTypeInference; | ||
| import org.apache.calcite.sql.type.SqlTypeFamily; | ||
| import org.opensearch.sql.data.model.ExprIpValue; | ||
| import org.opensearch.sql.expression.function.ImplementorUDF; | ||
| import org.opensearch.sql.expression.function.UDFOperandMetadata; | ||
| import org.opensearch.sql.utils.IPUtils; | ||
|
|
||
| /** | ||
| * {@code compare(ip1, ip2)} compares two IP addresses using a provided op. | ||
| * | ||
| * <p>Signature: | ||
| * | ||
| * <ul> | ||
| * <li>(IP, STRING) -> BOOLEAN | ||
| * <li>(STRING, IP) -> BOOLEAN | ||
| * <li>(IP, IP) -> BOOLEAN | ||
| * </ul> | ||
| */ | ||
| public class CompareIpFunction extends ImplementorUDF { | ||
|
|
||
| private CompareIpFunction(ComparisonType comparisonType) { | ||
| super(new CompareImplementor(comparisonType), NullPolicy.ANY); | ||
| } | ||
|
|
||
| public static CompareIpFunction less() { | ||
| return new CompareIpFunction(ComparisonType.LESS); | ||
| } | ||
|
|
||
| public static CompareIpFunction greater() { | ||
| return new CompareIpFunction(ComparisonType.GREATER); | ||
| } | ||
|
|
||
| public static CompareIpFunction lessOrEquals() { | ||
| return new CompareIpFunction(ComparisonType.LESS_OR_EQUAL); | ||
| } | ||
|
|
||
| public static CompareIpFunction greaterOrEquals() { | ||
| return new CompareIpFunction(ComparisonType.GREATER_OR_EQUAL); | ||
| } | ||
|
|
||
| public static CompareIpFunction equals() { | ||
| return new CompareIpFunction(ComparisonType.EQUALS); | ||
| } | ||
|
|
||
| public static CompareIpFunction notEquals() { | ||
| return new CompareIpFunction(ComparisonType.NOT_EQUALS); | ||
| } | ||
|
|
||
| @Override | ||
| public SqlReturnTypeInference getReturnTypeInference() { | ||
| return ReturnTypes.BOOLEAN_FORCE_NULLABLE; | ||
| } | ||
|
|
||
| @Override | ||
| public UDFOperandMetadata getOperandMetadata() { | ||
| return UDFOperandMetadata.wrap( | ||
| (CompositeOperandTypeChecker) | ||
| OperandTypes.family(SqlTypeFamily.STRING, SqlTypeFamily.NULL) | ||
| .or(OperandTypes.family(SqlTypeFamily.NULL, SqlTypeFamily.STRING)) | ||
| .or(OperandTypes.family(SqlTypeFamily.NULL, SqlTypeFamily.NULL))); | ||
| } | ||
|
|
||
| public static class CompareImplementor implements NotNullImplementor { | ||
| private final ComparisonType comparisonType; | ||
|
|
||
| public CompareImplementor(ComparisonType comparisonType) { | ||
| this.comparisonType = comparisonType; | ||
| } | ||
|
|
||
| @Override | ||
| public Expression implement( | ||
| RexToLixTranslator translator, RexCall call, List<Expression> translatedOperands) { | ||
| return Expressions.call( | ||
| CompareImplementor.class, | ||
| "compare", | ||
| translatedOperands.get(0), | ||
| translatedOperands.get(1), | ||
| Expressions.constant(comparisonType)); | ||
| } | ||
|
|
||
| public static boolean compare(Object obj1, Object obj2, ComparisonType comparisonType) { | ||
| try { | ||
| String ip1 = extractIpString(obj1); | ||
|
Collaborator
There was a problem hiding this comment. Why not leverage
Contributor
Author
There was a problem hiding this comment. Sorry for only focusing on IPUtils before and ignoring the functions encapsulated in ExprIpValue. Now fixed. |
||
| String ip2 = extractIpString(obj2); | ||
| IPAddress addr1 = IPUtils.toAddress(ip1); | ||
| IPAddress addr2 = IPUtils.toAddress(ip2); | ||
| int result = IPUtils.compare(addr1, addr2); | ||
| return switch (comparisonType) { | ||
|
Collaborator
There was a problem hiding this comment. For efficiency consideration, we'd better move this switch case to the |
||
| case EQUALS -> result == 0; | ||
| case NOT_EQUALS -> result != 0; | ||
| case LESS -> result < 0; | ||
| case LESS_OR_EQUAL -> result <= 0; | ||
| case GREATER -> result > 0; | ||
| case GREATER_OR_EQUAL -> result >= 0; | ||
| }; | ||
| } catch (Exception e) { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| private static String extractIpString(Object obj) { | ||
| if (obj instanceof String) return (String) obj; | ||
| if (obj instanceof ExprIpValue) return ((ExprIpValue) obj).value(); | ||
| throw new IllegalArgumentException("Invalid IP type: " + obj); | ||
| } | ||
| } | ||
|
|
||
| public enum ComparisonType { | ||
| EQUALS, | ||
| NOT_EQUALS, | ||
| LESS, | ||
| LESS_OR_EQUAL, | ||
| GREATER, | ||
| GREATER_OR_EQUAL | ||
| } | ||
| } | ||
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
Oops, something went wrong.
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.
Questions, Do we need to support IP as UDT in PPL engine?
In OpenSearch PPL, IP handling depends on index field type. CIDR-based filtering should use ip_range queries for ip fields, script pushdown / in-memory processing for keyword, text, and runtime string fields.