Add datetime functions #3473
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
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,33 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.sql.calcite.udf.datetimeUDF; | ||
|
|
||
| import org.opensearch.sql.calcite.udf.UserDefinedFunction; | ||
| import org.opensearch.sql.calcite.utils.UserDefinedFunctionUtils; | ||
| import org.opensearch.sql.data.model.ExprStringValue; | ||
| import org.opensearch.sql.data.model.ExprValue; | ||
| import org.opensearch.sql.expression.datetime.DateTimeFunctions; | ||
|
|
||
| public class ConvertTZFunction implements UserDefinedFunction { | ||
| @Override | ||
| public Object eval(Object... args) { | ||
|
|
||
| if (UserDefinedFunctionUtils.containsNull(args)) { | ||
| return null; | ||
| } | ||
|
|
||
| Object argTimestamp = args[0]; | ||
| Object fromTz = args[1]; | ||
| Object toTz = args[2]; | ||
| ExprValue datetimeExpr = | ||
| DateTimeFunctions.exprConvertTZ( | ||
| new ExprStringValue(argTimestamp.toString()), | ||
| new ExprStringValue(fromTz.toString()), | ||
| new ExprStringValue(toTz.toString())); | ||
|
|
||
| return datetimeExpr.valueForCalcite(); | ||
| } | ||
| } |
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,61 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.sql.calcite.udf.datetimeUDF; | ||
|
|
||
| import static org.opensearch.sql.calcite.utils.UserDefinedFunctionUtils.*; | ||
| import static org.opensearch.sql.calcite.utils.datetime.DateTimeApplyUtils.convertToTemporalAmount; | ||
| import static org.opensearch.sql.calcite.utils.datetime.DateTimeApplyUtils.transferInputToExprValue; | ||
|
|
||
| import org.apache.calcite.avatica.util.TimeUnit; | ||
| import org.apache.calcite.rel.type.RelDataType; | ||
| import org.apache.calcite.sql.type.SqlReturnTypeInference; | ||
| import org.apache.calcite.sql.type.SqlTypeName; | ||
| import org.opensearch.sql.calcite.udf.UserDefinedFunction; | ||
| import org.opensearch.sql.calcite.utils.UserDefinedFunctionUtils; | ||
| import org.opensearch.sql.data.model.ExprDateValue; | ||
| import org.opensearch.sql.data.model.ExprValue; | ||
| import org.opensearch.sql.expression.datetime.DateTimeFunctions; | ||
| import org.opensearch.sql.expression.function.FunctionProperties; | ||
|
|
||
| public class DateAddSubFunction implements UserDefinedFunction { | ||
| @Override | ||
| public Object eval(Object... args) { | ||
|
|
||
| if (UserDefinedFunctionUtils.containsNull(args)) { | ||
| return null; | ||
| } | ||
|
|
||
| TimeUnit unit = (TimeUnit) args[0]; | ||
| long interval = ((Number) args[1]).longValue(); | ||
| Object argBase = args[2]; | ||
| SqlTypeName sqlTypeName = (SqlTypeName) args[3]; | ||
| boolean isAdd = (Boolean) args[4]; | ||
| SqlTypeName returnSqlType = (SqlTypeName) args[5]; | ||
| ExprValue base = transferInputToExprValue(argBase, sqlTypeName); | ||
| FunctionProperties restored = restoreFunctionProperties(args[args.length - 1]); | ||
|
There was a problem hiding this comment. This properties should be set when constructing the function and I think it supports pass in FunctionProperties directly, please add a TODO here to make change in the future. There was a problem hiding this comment. Got it. Add in function restoreFunctionProperties |
||
| ExprValue resultDatetime = | ||
| DateTimeFunctions.exprDateApplyInterval( | ||
| restored, base, convertToTemporalAmount(interval, unit), isAdd); | ||
| if (returnSqlType == SqlTypeName.TIMESTAMP) { | ||
| return resultDatetime.valueForCalcite(); | ||
| } else { | ||
| return new ExprDateValue(resultDatetime.dateValue()).valueForCalcite(); | ||
| } | ||
| } | ||
|
|
||
| public static SqlReturnTypeInference getReturnTypeForAddOrSubDate() { | ||
| return opBinding -> { | ||
| RelDataType operandType0 = opBinding.getOperandType(6); | ||
| SqlTypeName typeName = operandType0.getSqlTypeName(); | ||
| if (typeName == SqlTypeName.TIMESTAMP) { | ||
|
There was a problem hiding this comment. In which case will we use SqlTypeName.TIMESTAMP? |
||
| return nullableTimestampUDT; | ||
| } else if (typeName == SqlTypeName.DATE) { | ||
| return nullableDateUDT; | ||
| } | ||
| return opBinding.getTypeFactory().createSqlType(typeName); | ||
| }; | ||
| } | ||
| } | ||
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,41 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.sql.calcite.udf.datetimeUDF; | ||
|
|
||
| import static org.opensearch.sql.calcite.utils.OpenSearchTypeFactory.convertSqlTypeNameToExprType; | ||
| import static org.opensearch.sql.calcite.utils.UserDefinedFunctionUtils.restoreFunctionProperties; | ||
| import static org.opensearch.sql.data.model.ExprValueUtils.fromObjectValue; | ||
|
|
||
| import org.apache.calcite.sql.type.SqlTypeName; | ||
| import org.opensearch.sql.calcite.udf.UserDefinedFunction; | ||
| import org.opensearch.sql.calcite.utils.UserDefinedFunctionUtils; | ||
| import org.opensearch.sql.data.model.ExprValue; | ||
| import org.opensearch.sql.expression.datetime.DateTimeFunctions; | ||
| import org.opensearch.sql.expression.function.FunctionProperties; | ||
|
|
||
| /** | ||
| * Calculates the difference of date parts of given values. If the first argument is time, today's | ||
| * date is used. | ||
| * | ||
| * <p>(DATE/TIMESTAMP/TIME, DATE/TIMESTAMP/TIME) -> LONG | ||
| */ | ||
| public class DateDiffFunction implements UserDefinedFunction { | ||
| @Override | ||
| public Object eval(Object... args) { | ||
| if (UserDefinedFunctionUtils.containsNull(args)) { | ||
| return null; | ||
| } | ||
| FunctionProperties restored = restoreFunctionProperties(args[args.length - 1]); | ||
| SqlTypeName sqlTypeName1 = (SqlTypeName) args[1]; | ||
| SqlTypeName sqlTypeName2 = (SqlTypeName) args[3]; | ||
| ExprValue diffResult = | ||
| DateTimeFunctions.exprDateDiff( | ||
| restored, | ||
| fromObjectValue(args[0], convertSqlTypeNameToExprType(sqlTypeName1)), | ||
| fromObjectValue(args[2], convertSqlTypeNameToExprType(sqlTypeName2))); | ||
| return diffResult.longValue(); | ||
| } | ||
| } |
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,41 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.sql.calcite.udf.datetimeUDF; | ||
|
|
||
| import static org.opensearch.sql.calcite.utils.UserDefinedFunctionUtils.restoreFunctionProperties; | ||
| import static org.opensearch.sql.calcite.utils.datetime.DateTimeApplyUtils.transferInputToExprValue; | ||
| import static org.opensearch.sql.expression.datetime.DateTimeFormatterUtil.getFormattedDate; | ||
| import static org.opensearch.sql.expression.datetime.DateTimeFormatterUtil.getFormattedDateOfToday; | ||
|
|
||
| import org.apache.calcite.sql.type.SqlTypeName; | ||
| import org.opensearch.sql.calcite.udf.UserDefinedFunction; | ||
| import org.opensearch.sql.calcite.utils.UserDefinedFunctionUtils; | ||
| import org.opensearch.sql.data.model.ExprStringValue; | ||
| import org.opensearch.sql.data.model.ExprValue; | ||
| import org.opensearch.sql.expression.function.FunctionProperties; | ||
|
|
||
| public class DateFormatFunction implements UserDefinedFunction { | ||
| @Override | ||
| public Object eval(Object... args) { | ||
| if (UserDefinedFunctionUtils.containsNull(args)) { | ||
| return null; | ||
| } | ||
| Object argDatetime = args[0]; | ||
| Object argDatetimeType = args[1]; | ||
| Object argFormat = args[2]; | ||
| FunctionProperties restored = restoreFunctionProperties(args[args.length - 1]); | ||
| ExprValue candidateValue = transferInputToExprValue(argDatetime, (SqlTypeName) argDatetimeType); | ||
| if (argDatetimeType == SqlTypeName.TIME) { | ||
| return getFormattedDateOfToday( | ||
| new ExprStringValue(argFormat.toString()), | ||
| candidateValue, | ||
| restored.getQueryStartClock()) | ||
| .stringValue(); | ||
| } | ||
| return getFormattedDate(candidateValue, new ExprStringValue(argFormat.toString())) | ||
| .stringValue(); | ||
| } | ||
| } |
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,34 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.sql.calcite.udf.datetimeUDF; | ||
|
|
||
| import static org.opensearch.sql.calcite.utils.UserDefinedFunctionUtils.restoreFunctionProperties; | ||
| import static org.opensearch.sql.calcite.utils.datetime.DateTimeApplyUtils.transferInputToExprValue; | ||
| import static org.opensearch.sql.expression.datetime.DateTimeFunctions.exprDate; | ||
|
|
||
| import org.apache.calcite.sql.type.SqlTypeName; | ||
| import org.opensearch.sql.calcite.udf.UserDefinedFunction; | ||
| import org.opensearch.sql.calcite.utils.UserDefinedFunctionUtils; | ||
| import org.opensearch.sql.data.model.ExprDateValue; | ||
| import org.opensearch.sql.data.model.ExprTimeValue; | ||
| import org.opensearch.sql.data.model.ExprValue; | ||
| import org.opensearch.sql.expression.function.FunctionProperties; | ||
|
|
||
| public class DateFunction implements UserDefinedFunction { | ||
|
|
||
| @Override | ||
| public Object eval(Object... args) { | ||
| if (UserDefinedFunctionUtils.containsNull(args)) { | ||
| return null; | ||
| } | ||
| FunctionProperties restored = restoreFunctionProperties(args[args.length - 1]); | ||
| ExprValue candidate = transferInputToExprValue(args[0], (SqlTypeName) args[1]); | ||
| if ((SqlTypeName) args[1] == SqlTypeName.TIME) { | ||
| return new ExprDateValue(((ExprTimeValue) candidate).dateValue(restored)).valueForCalcite(); | ||
| } | ||
| return exprDate(candidate).valueForCalcite(); | ||
| } | ||
| } |
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.
Why using SqlTypeName here? I think sql type is a subset of all types we use and date, time, timestamp of Sql type is no longer used by us after introducing UDT
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.
For our current UDF, all time/timestamp/time input would be the UDT. So we directly transfer the type to corresponding sqltypetime that we can call
fromObjectValueeasily. See functiontransferDateRelatedTimeNameThere 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.
These UDT's real SqlType is VARCHAR, the more appropriate way is pass in the RelDataType here and get the correct exprtype by using
ExprUDT.getExprCoreType.It works here because we have a incorrect mapping in
convertSqlTypeNameToExprType(the mapping of time,timestamp,date will never be used since they are blocked now by the previous logic of handling UDT), and you pass inSqlTypeName.TIMESTAMPdirectly from the place where you call this funciton.