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,87 @@ | ||
| /* | ||
| * 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.*; | ||
| import org.opensearch.sql.data.model.ExprIpValue; | ||
| import org.opensearch.sql.exception.SemanticCheckException; | ||
| import org.opensearch.sql.expression.function.ImplementorUDF; | ||
| import org.opensearch.sql.expression.function.UDFOperandMetadata; | ||
| import org.opensearch.sql.utils.IPUtils; | ||
|
|
||
| /** | ||
| * {@code Equals(ip1, ip2)} checks if two IP addresses are equal. | ||
| * | ||
| * <p>Signature: | ||
| * | ||
| * <ul> | ||
| * <li>(STRING, STRING) -> BOOLEAN | ||
| * <li>(IP, STRING) -> BOOLEAN | ||
|
ishaoxy marked this conversation as resolved.
Outdated
|
||
| * <li>(STRING, IP) -> BOOLEAN | ||
| * <li>(IP, IP) -> BOOLEAN | ||
| * </ul> | ||
| */ | ||
| public class EqualsIpFunction extends ImplementorUDF { | ||
|
ishaoxy marked this conversation as resolved.
Outdated
|
||
| public EqualsIpFunction() { | ||
| super(new EqualsImplementor(), NullPolicy.ANY); | ||
| } | ||
|
|
||
| @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 EqualsImplementor implements NotNullImplementor { | ||
| @Override | ||
| public Expression implement( | ||
| RexToLixTranslator translator, RexCall call, List<Expression> translatedOperands) { | ||
| return Expressions.call(EqualsImplementor.class, "Equals", translatedOperands); | ||
| } | ||
|
|
||
| public static boolean Equals(String ip1, String ip2) { | ||
| try { | ||
| IPAddress ipAddress1 = IPUtils.toAddress(ip1); | ||
| IPAddress ipAddress2 = IPUtils.toAddress(ip2); | ||
| return IPUtils.compare(ipAddress1, ipAddress2) == 0; | ||
| } catch (SemanticCheckException e) { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| public static boolean Equals(String ip1, ExprIpValue ip2) { | ||
|
ishaoxy marked this conversation as resolved.
Outdated
|
||
| String ipAddress2 = ip2.value(); | ||
| return Equals(ip1, ipAddress2); | ||
| } | ||
|
|
||
| public static boolean Equals(ExprIpValue ip1, String ip2) { | ||
| String ipAddress1 = ip1.value(); | ||
| return Equals(ipAddress1, ip2); | ||
| } | ||
|
|
||
| public static boolean Equals(ExprIpValue ip1, ExprIpValue ip2) { | ||
| String ipAddress1 = ip1.value(); | ||
| String ipAddress2 = ip2.value(); | ||
| return Equals(ipAddress1, ipAddress2); | ||
| } | ||
| } | ||
| } | ||
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,87 @@ | ||
| /* | ||
| * 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.*; | ||
| import org.opensearch.sql.data.model.ExprIpValue; | ||
| import org.opensearch.sql.exception.SemanticCheckException; | ||
| import org.opensearch.sql.expression.function.ImplementorUDF; | ||
| import org.opensearch.sql.expression.function.UDFOperandMetadata; | ||
| import org.opensearch.sql.utils.IPUtils; | ||
|
|
||
| /** | ||
| * {@code Greater(ip1, ip2)} checks if ip1 is greater than ip2. | ||
| * | ||
| * <p>Signature: | ||
| * | ||
| * <ul> | ||
| * <li>(STRING, STRING) -> BOOLEAN | ||
| * <li>(IP, STRING) -> BOOLEAN | ||
| * <li>(STRING, IP) -> BOOLEAN | ||
| * <li>(IP, IP) -> BOOLEAN | ||
| * </ul> | ||
| */ | ||
| public class GreaterIpFunction extends ImplementorUDF { | ||
| public GreaterIpFunction() { | ||
| super(new GreaterImplementor(), NullPolicy.ANY); | ||
| } | ||
|
|
||
| @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 GreaterImplementor implements NotNullImplementor { | ||
| @Override | ||
| public Expression implement( | ||
| RexToLixTranslator translator, RexCall call, List<Expression> translatedOperands) { | ||
| return Expressions.call(GreaterImplementor.class, "Greater", translatedOperands); | ||
| } | ||
|
|
||
| public static boolean Greater(String ip1, String ip2) { | ||
| try { | ||
| IPAddress ipAddress1 = IPUtils.toAddress(ip1); | ||
| IPAddress ipAddress2 = IPUtils.toAddress(ip2); | ||
| return IPUtils.compare(ipAddress1, ipAddress2) > 0; | ||
| } catch (SemanticCheckException e) { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| public static boolean Greater(String ip1, ExprIpValue ip2) { | ||
| String ipAddress2 = ip2.value(); | ||
| return Greater(ip1, ipAddress2); | ||
| } | ||
|
|
||
| public static boolean Greater(ExprIpValue ip1, String ip2) { | ||
| String ipAddress1 = ip1.value(); | ||
| return Greater(ipAddress1, ip2); | ||
| } | ||
|
|
||
| public static boolean Greater(ExprIpValue ip1, ExprIpValue ip2) { | ||
| String ipAddress1 = ip1.value(); | ||
| String ipAddress2 = ip2.value(); | ||
| return Greater(ipAddress1, ipAddress2); | ||
| } | ||
| } | ||
| } |
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,87 @@ | ||
| /* | ||
| * 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.*; | ||
| import org.opensearch.sql.data.model.ExprIpValue; | ||
| import org.opensearch.sql.exception.SemanticCheckException; | ||
| import org.opensearch.sql.expression.function.ImplementorUDF; | ||
| import org.opensearch.sql.expression.function.UDFOperandMetadata; | ||
| import org.opensearch.sql.utils.IPUtils; | ||
|
|
||
| /** | ||
| * {@code Gte(ip1, ip2)} checks if ip1 is greater than or equals ip2. | ||
| * | ||
| * <p>Signature: | ||
| * | ||
| * <ul> | ||
| * <li>(STRING, STRING) -> BOOLEAN | ||
| * <li>(IP, STRING) -> BOOLEAN | ||
| * <li>(STRING, IP) -> BOOLEAN | ||
| * <li>(IP, IP) -> BOOLEAN | ||
| * </ul> | ||
| */ | ||
| public class GteIpFunction extends ImplementorUDF { | ||
| public GteIpFunction() { | ||
| super(new GteImplementor(), NullPolicy.ANY); | ||
| } | ||
|
|
||
| @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 GteImplementor implements NotNullImplementor { | ||
| @Override | ||
| public Expression implement( | ||
| RexToLixTranslator translator, RexCall call, List<Expression> translatedOperands) { | ||
| return Expressions.call(GteImplementor.class, "Gte", translatedOperands); | ||
| } | ||
|
|
||
| public static boolean Gte(String ip1, String ip2) { | ||
| try { | ||
| IPAddress ipAddress1 = IPUtils.toAddress(ip1); | ||
| IPAddress ipAddress2 = IPUtils.toAddress(ip2); | ||
| return IPUtils.compare(ipAddress1, ipAddress2) >= 0; | ||
| } catch (SemanticCheckException e) { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| public static boolean Gte(String ip1, ExprIpValue ip2) { | ||
| String ipAddress2 = ip2.value(); | ||
| return Gte(ip1, ipAddress2); | ||
| } | ||
|
|
||
| public static boolean Gte(ExprIpValue ip1, String ip2) { | ||
| String ipAddress1 = ip1.value(); | ||
| return Gte(ipAddress1, ip2); | ||
| } | ||
|
|
||
| public static boolean Gte(ExprIpValue ip1, ExprIpValue ip2) { | ||
| String ipAddress1 = ip1.value(); | ||
| String ipAddress2 = ip2.value(); | ||
| return Gte(ipAddress1, ipAddress2); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
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.