Skip to content

Add missing udfs in v3 #3957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
qianheng-aws merged 9 commits into from
Aug 8, 2025
Merged

Add missing udfs in v3 #3957

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f553fdb
add math udfs
ishaoxy Jul 31, 2025
e7c0636
fix decimal bug
ishaoxy Aug 1, 2025
37c661e
make general udf adapter
ishaoxy Aug 1, 2025
052fa10
add math IT
ishaoxy Aug 1, 2025
601a188
fix
ishaoxy Aug 1, 2025
4a681d1
add rst
ishaoxy Aug 1, 2025
5eafd78
fix error
ishaoxy Aug 4, 2025
a60904f
change signum IT
ishaoxy Aug 4, 2025
fe0c673
add javadoc
ishaoxy Aug 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions core/src/main/java/org/opensearch/sql/calcite/utils/UserDefinedFunctionUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,47 @@ public UDFOperandMetadata getOperandMetadata() {
};
}

/**
* Adapt a static math function (e.g., Math.expm1, Math.rint) to a UserDefinedFunctionBuilder.
* This method generates a Calcite-compatible UDF by boxing the operand, converting it to a
* double, and then calling the corresponding method in {@link Math}.
*
* <p>It assumes the math method has the signature: {@code double method(double)}. This utility is
* specifically designed for single-operand Math methods.
*
* @param methodName the name of the static method in {@link Math} to be invoked
* @param returnTypeInference the return type inference of the UDF
* @param nullPolicy the null policy of the UDF
* @param operandMetadata type checker
* @return an adapted ImplementorUDF with the math method, which is a UserDefinedFunctionBuilder
*/
public static ImplementorUDF adaptMathFunctionToUDF(
Copy link
Member

@LantaoJin LantaoJin Aug 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a Javadoc for this class?

Copy link
Contributor Author

@ishaoxy ishaoxy Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Of course. Added.

String methodName,
SqlReturnTypeInference returnTypeInference,
NullPolicy nullPolicy,
UDFOperandMetadata operandMetadata) {

NotNullImplementor implementor =
(translator, call, translatedOperands) -> {
Expression operand = translatedOperands.get(0);
operand = Expressions.box(operand);
operand = Expressions.call(operand, "doubleValue");
return Expressions.call(Math.class, methodName, operand);
};

return new ImplementorUDF(implementor, nullPolicy) {
@Override
public SqlReturnTypeInference getReturnTypeInference() {
return returnTypeInference;
}

@Override
public UDFOperandMetadata getOperandMetadata() {
return operandMetadata;
}
};
}

public static List<Expression> prependFunctionProperties(
List<Expression> operands, RexToLixTranslator translator) {
List<Expression> operandsWithProperties = new ArrayList<>(operands);
Expand Down
21 changes: 21 additions & 0 deletions core/src/main/java/org/opensearch/sql/expression/function/PPLBuiltinOperators.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import static org.opensearch.sql.calcite.utils.UserDefinedFunctionUtils.adaptExprMethodToUDF;
import static org.opensearch.sql.calcite.utils.UserDefinedFunctionUtils.adaptExprMethodWithPropertiesToUDF;
import static org.opensearch.sql.calcite.utils.UserDefinedFunctionUtils.adaptMathFunctionToUDF;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
Expand Down Expand Up @@ -104,6 +105,26 @@ public class PPLBuiltinOperators extends ReflectiveSqlOperatorTable {
public static final SqlOperator SHA2 = CryptographicFunction.sha2().toUDF("SHA2");
public static final SqlOperator CIDRMATCH = new CidrMatchFunction().toUDF("CIDRMATCH");

public static final SqlOperator COSH =
adaptMathFunctionToUDF(
"cosh", ReturnTypes.DOUBLE_FORCE_NULLABLE, NullPolicy.ANY, PPLOperandTypes.NUMERIC)
.toUDF("COSH");

public static final SqlOperator SINH =
adaptMathFunctionToUDF(
"sinh", ReturnTypes.DOUBLE_FORCE_NULLABLE, NullPolicy.ANY, PPLOperandTypes.NUMERIC)
.toUDF("SINH");

public static final SqlOperator RINT =
adaptMathFunctionToUDF(
"rint", ReturnTypes.DOUBLE_FORCE_NULLABLE, NullPolicy.ANY, PPLOperandTypes.NUMERIC)
.toUDF("RINT");

public static final SqlOperator EXPM1 =
adaptMathFunctionToUDF(
"expm1", ReturnTypes.DOUBLE_FORCE_NULLABLE, NullPolicy.ANY, PPLOperandTypes.NUMERIC)
.toUDF("EXPM1");

// IP comparing functions
public static final SqlOperator NOT_EQUALS_IP =
CompareIpFunction.notEquals().toUDF("NOT_EQUALS_IP");
Expand Down
18 changes: 18 additions & 0 deletions core/src/main/java/org/opensearch/sql/expression/function/PPLFuncImpTable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import static org.opensearch.sql.expression.function.BuiltinFunctionName.ACOS;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.ADD;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.ADDDATE;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.ADDFUNCTION;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.ADDTIME;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.AND;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.ARRAY;
Expand All @@ -37,6 +38,7 @@
import static org.opensearch.sql.expression.function.BuiltinFunctionName.CONV;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.CONVERT_TZ;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.COS;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.COSH;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.COT;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.COUNT;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.CRC32;
Expand All @@ -61,11 +63,13 @@
import static org.opensearch.sql.expression.function.BuiltinFunctionName.DAY_OF_YEAR;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.DEGREES;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.DIVIDE;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.DIVIDEFUNCTION;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.E;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.EARLIEST;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.EQUAL;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.EXISTS;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.EXP;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.EXPM1;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.EXTRACT;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.FILTER;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.FLOOR;
Expand Down Expand Up @@ -137,6 +141,7 @@
import static org.opensearch.sql.expression.function.BuiltinFunctionName.MONTHNAME;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.MONTH_OF_YEAR;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.MULTIPLY;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.MULTIPLYFUNCTION;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.MULTI_MATCH;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.NOT;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.NOTEQUAL;
Expand All @@ -159,6 +164,7 @@
import static org.opensearch.sql.expression.function.BuiltinFunctionName.REPLACE;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.REVERSE;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.RIGHT;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.RINT;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.ROUND;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.RTRIM;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SECOND;
Expand All @@ -167,8 +173,10 @@
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SHA1;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SHA2;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SIGN;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SIGNUM;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SIMPLE_QUERY_STRING;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SIN;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SINH;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SPAN;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SQRT;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.STDDEV_POP;
Expand All @@ -180,6 +188,7 @@
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SUBSTRING;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SUBTIME;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SUBTRACT;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SUBTRACTFUNCTION;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SUM;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.SYSDATE;
import static org.opensearch.sql.expression.function.BuiltinFunctionName.TAKE;
Expand Down Expand Up @@ -668,8 +677,11 @@ void populate() {
registerOperator(OR, SqlStdOperatorTable.OR);
registerOperator(NOT, SqlStdOperatorTable.NOT);
registerOperator(ADD, SqlStdOperatorTable.PLUS);
registerOperator(ADDFUNCTION, SqlStdOperatorTable.PLUS);
registerOperator(SUBTRACT, SqlStdOperatorTable.MINUS);
registerOperator(SUBTRACTFUNCTION, SqlStdOperatorTable.MINUS);
registerOperator(MULTIPLY, SqlStdOperatorTable.MULTIPLY);
registerOperator(MULTIPLYFUNCTION, SqlStdOperatorTable.MULTIPLY);
registerOperator(TRUNCATE, SqlStdOperatorTable.TRUNCATE);
registerOperator(ASCII, SqlStdOperatorTable.ASCII);
registerOperator(LENGTH, SqlStdOperatorTable.CHAR_LENGTH);
Expand Down Expand Up @@ -699,6 +711,7 @@ void populate() {
registerOperator(RAND, SqlStdOperatorTable.RAND);
registerOperator(ROUND, SqlStdOperatorTable.ROUND);
registerOperator(SIGN, SqlStdOperatorTable.SIGN);
registerOperator(SIGNUM, SqlStdOperatorTable.SIGN);
Copy link
Collaborator

@yuancu yuancu Aug 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The return type of SqlStdOperatorTable.SIGN (ARG0) seems to be different with SIGNUM (INTEGER) described in the documentation.

Copy link
Contributor Author

@ishaoxy ishaoxy Aug 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now the behavior is exactly the same as the existing function sign. Let me keep these changes first.

registerOperator(SIN, SqlStdOperatorTable.SIN);
registerOperator(CBRT, SqlStdOperatorTable.CBRT);
registerOperator(IS_NOT_NULL, SqlStdOperatorTable.IS_NOT_NULL);
Expand All @@ -725,6 +738,10 @@ void populate() {
registerOperator(INTERNAL_REGEXP_REPLACE_3, SqlLibraryOperators.REGEXP_REPLACE_3);

// Register PPL UDF operator
registerOperator(COSH, PPLBuiltinOperators.COSH);
registerOperator(SINH, PPLBuiltinOperators.SINH);
registerOperator(EXPM1, PPLBuiltinOperators.EXPM1);
registerOperator(RINT, PPLBuiltinOperators.RINT);
registerOperator(SPAN, PPLBuiltinOperators.SPAN);
registerOperator(E, PPLBuiltinOperators.E);
registerOperator(CONV, PPLBuiltinOperators.CONV);
Expand All @@ -733,6 +750,7 @@ void populate() {
registerOperator(MODULUSFUNCTION, PPLBuiltinOperators.MOD);
registerOperator(CRC32, PPLBuiltinOperators.CRC32);
registerOperator(DIVIDE, PPLBuiltinOperators.DIVIDE);
registerOperator(DIVIDEFUNCTION, PPLBuiltinOperators.DIVIDE);
registerOperator(SHA2, PPLBuiltinOperators.SHA2);
registerOperator(CIDRMATCH, PPLBuiltinOperators.CIDRMATCH);
registerOperator(INTERNAL_GROK, PPLBuiltinOperators.GROK);
Expand Down
Loading
Loading