Support function argument coercion with Calcite #3914
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,139 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.sql.expression.function; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import javax.annotation.Nullable; | ||
| import org.apache.calcite.rex.RexBuilder; | ||
| import org.apache.calcite.rex.RexNode; | ||
| import org.opensearch.sql.calcite.utils.OpenSearchTypeFactory; | ||
| import org.opensearch.sql.data.type.ExprCoreType; | ||
| import org.opensearch.sql.data.type.ExprType; | ||
| import org.opensearch.sql.data.type.WideningTypeRule; | ||
| import org.opensearch.sql.exception.ExpressionEvaluationException; | ||
|
|
||
| public class CoercionUtils { | ||
|
|
||
| /** | ||
| * Casts the arguments to the types specified in the typeChecker. Returns null if no combination | ||
| * of parameter types matches the arguments or if casting fails. | ||
| * | ||
| * @param builder RexBuilder to create casts | ||
| * @param typeChecker PPLTypeChecker that provides the parameter types | ||
| * @param arguments List of RexNode arguments to be cast | ||
| * @return List of cast RexNode arguments or null if casting fails | ||
| */ | ||
| public static @Nullable List<RexNode> castArguments( | ||
| RexBuilder builder, PPLTypeChecker typeChecker, List<RexNode> arguments) { | ||
| List<List<ExprType>> paramTypeCombinations = typeChecker.getParameterTypes(); | ||
|
|
||
| // TODO: var args? | ||
|
|
||
| for (List<ExprType> paramTypes : paramTypeCombinations) { | ||
| List<RexNode> castedArguments = castArguments(builder, paramTypes, arguments); | ||
| if (castedArguments != null) { | ||
| return castedArguments; | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * Widen the arguments to the widest type found among them. If no widest type can be determined, | ||
| * returns null. | ||
| * | ||
| * @param builder RexBuilder to create casts | ||
| * @param arguments List of RexNode arguments to be widened | ||
| * @return List of widened RexNode arguments or null if no widest type can be determined | ||
| */ | ||
| public static @Nullable List<RexNode> widenArguments( | ||
| RexBuilder builder, List<RexNode> arguments) { | ||
| // TODO: Add test on e.g. IP | ||
| ExprType widestType = findWidestType(arguments); | ||
| if (widestType == null) { | ||
| return null; // No widest type found, return null | ||
| } | ||
| return arguments.stream().map(arg -> cast(builder, widestType, arg)).toList(); | ||
| } | ||
|
|
||
| /** | ||
| * Casts the arguments to the types specified in paramTypes. Returns null if the number of | ||
| * parameters does not match or if casting fails. | ||
| */ | ||
| private static @Nullable List<RexNode> castArguments( | ||
| RexBuilder builder, List<ExprType> paramTypes, List<RexNode> arguments) { | ||
| if (paramTypes.size() != arguments.size()) { | ||
| return null; // Skip if the number of parameters does not match | ||
| } | ||
|
|
||
| List<RexNode> castedArguments = new ArrayList<>(); | ||
| for (int i = 0; i < paramTypes.size(); i++) { | ||
| ExprType toType = paramTypes.get(i); | ||
| RexNode arg = arguments.get(i); | ||
|
|
||
| RexNode castedArg = cast(builder, toType, arg); | ||
|
|
||
| if (castedArg == null) { | ||
| return null; | ||
| } | ||
| castedArguments.add(castedArg); | ||
| } | ||
| return castedArguments; | ||
| } | ||
|
|
||
| private static @Nullable RexNode cast(RexBuilder builder, ExprType targetType, RexNode arg) { | ||
| ExprType argType = OpenSearchTypeFactory.convertRelDataTypeToExprType(arg.getType()); | ||
| if (!argType.shouldCast(targetType)) { | ||
| return arg; | ||
| } | ||
|
|
||
| if (WideningTypeRule.distance(argType, targetType) != WideningTypeRule.IMPOSSIBLE_WIDENING) { | ||
| return builder.makeCast(OpenSearchTypeFactory.convertExprTypeToRelDataType(targetType), arg); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * Finds the widest type among the given arguments. The widest type is determined by applying the | ||
| * widening type rule to each pair of types in the arguments. | ||
| * | ||
| * @param arguments List of RexNode arguments to find the widest type from | ||
| * @return the widest ExprType if found, otherwise null | ||
| */ | ||
| private static @Nullable ExprType findWidestType(List<RexNode> arguments) { | ||
| if (arguments.isEmpty()) { | ||
| return null; // No arguments to process | ||
| } | ||
| ExprType widestType = | ||
| OpenSearchTypeFactory.convertRelDataTypeToExprType(arguments.getFirst().getType()); | ||
| if (arguments.size() == 1) { | ||
| return widestType; | ||
| } | ||
|
|
||
| // Iterate pairwise through the arguments and find the widest type | ||
| for (int i = 1; i < arguments.size(); i++) { | ||
| var type = OpenSearchTypeFactory.convertRelDataTypeToExprType(arguments.get(i).getType()); | ||
| try { | ||
| if (areDateAndTime(widestType, type)) { | ||
| // If one is date and the other is time, we consider timestamp as the widest type | ||
| widestType = ExprCoreType.TIMESTAMP; | ||
| } else { | ||
| widestType = WideningTypeRule.max(widestType, type); | ||
|
Collaborator
There was a problem hiding this comment. [non-blocking]Calcite has similar operation by using We may deprecate ExprValue and ExprType in the future. But for now, it's OK to keep using this one.
Collaborator
Author
There was a problem hiding this comment. Good idea, we could override |
||
| } | ||
| } catch (ExpressionEvaluationException e) { | ||
| // the two types are not compatible, return null | ||
| return null; | ||
| } | ||
| } | ||
| return widestType; | ||
| } | ||
|
|
||
| private static boolean areDateAndTime(ExprType type1, ExprType type2) { | ||
| return (type1 == ExprCoreType.DATE && type2 == ExprCoreType.TIME) | ||
| || (type1 == ExprCoreType.TIME && type2 == ExprCoreType.DATE); | ||
| } | ||
| } | ||
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.
Uh oh!
There was an error while loading. Please reload this page.