-
Notifications
You must be signed in to change notification settings - Fork 13.8k
[FLINK-37924][table]Introduce Built-in Function to Access field or element in the Variant #27330
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.
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
Open
JinkunLiu
wants to merge
6
commits into
apache:master
Choose a base branch
from
JinkunLiu:feature/FLINK-37924
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
53f4993
[FLINK-37924][table]Introduce Built-in Function to Access field or el…
JinkunLiu 5ef9f93
[FLINK-37924][table] Improve error messages for accessing Variant val…
JinkunLiu e036ebc
[FLINK-37924][table] Update expected argument types and signatures fo…
JinkunLiu 2d5a8ef
[FLINK-37924][table] Add error tests
JinkunLiu 06d5c7c
[FLINK-37924][table] Support CALCITE-7325 change
JinkunLiu 43de8ce
[FLINK-37924][table] Add Doc for Variant Built-in Function
JinkunLiu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
218 changes: 218 additions & 0 deletions
218
flink-table/flink-sql-parser/src/main/java/org/apache/calcite/sql/fun/SqlItemOperator.java
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,218 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to you under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.calcite.sql.fun; | ||
|
|
||
| import org.apache.calcite.rel.type.RelDataType; | ||
| import org.apache.calcite.rel.type.RelDataTypeFactory; | ||
| import org.apache.calcite.rel.type.RelDataTypeField; | ||
| import org.apache.calcite.sql.SqlCall; | ||
| import org.apache.calcite.sql.SqlCallBinding; | ||
| import org.apache.calcite.sql.SqlKind; | ||
| import org.apache.calcite.sql.SqlNode; | ||
| import org.apache.calcite.sql.SqlOperandCountRange; | ||
| import org.apache.calcite.sql.SqlOperatorBinding; | ||
| import org.apache.calcite.sql.SqlSpecialOperator; | ||
| import org.apache.calcite.sql.SqlWriter; | ||
| import org.apache.calcite.sql.parser.SqlParserPos; | ||
| import org.apache.calcite.sql.type.OperandTypes; | ||
| import org.apache.calcite.sql.type.SqlOperandCountRanges; | ||
| import org.apache.calcite.sql.type.SqlSingleOperandTypeChecker; | ||
| import org.apache.calcite.sql.type.SqlTypeFamily; | ||
| import org.apache.calcite.sql.type.SqlTypeName; | ||
| import org.apache.calcite.sql.type.SqlTypeUtil; | ||
|
|
||
| import java.util.Arrays; | ||
|
|
||
| import static java.util.Objects.requireNonNull; | ||
| import static org.apache.calcite.sql.type.NonNullableAccessors.getComponentTypeOrThrow; | ||
| import static org.apache.calcite.sql.validate.SqlNonNullableAccessors.getOperandLiteralValueOrThrow; | ||
|
|
||
| /** | ||
| * The item operator {@code [ ... ]}, used to access a given element of an array, map or struct. For | ||
| * example, {@code myArray[3]}, {@code "myMap['foo']"}, {@code myStruct[2]} or {@code | ||
| * myStruct['fieldName']}. | ||
| * | ||
| * <p>This class was copied over from Calcite 1.39.0 version to support access variant | ||
| * (FLINK-37924). | ||
| * | ||
| * <p>Line 148, CALCITE-7325, should be removed after upgrading Calcite to 1.42.0. | ||
| */ | ||
| public class SqlItemOperator extends SqlSpecialOperator { | ||
| public final int offset; | ||
| public final boolean safe; | ||
|
|
||
| public SqlItemOperator( | ||
| String name, SqlSingleOperandTypeChecker operandTypeChecker, int offset, boolean safe) { | ||
| super(name, SqlKind.ITEM, 100, true, null, null, operandTypeChecker); | ||
| this.offset = offset; | ||
| this.safe = safe; | ||
| } | ||
|
|
||
| @Override | ||
| public ReduceResult reduceExpr(int ordinal, TokenSequence list) { | ||
| SqlNode left = list.node(ordinal - 1); | ||
| SqlNode right = list.node(ordinal + 1); | ||
| return new ReduceResult( | ||
| ordinal - 1, | ||
| ordinal + 2, | ||
| createCall( | ||
| SqlParserPos.sum( | ||
| Arrays.asList( | ||
| requireNonNull(left, "left").getParserPosition(), | ||
| requireNonNull(right, "right").getParserPosition(), | ||
| list.pos(ordinal))), | ||
| left, | ||
| right)); | ||
| } | ||
|
|
||
| @Override | ||
| public void unparse(SqlWriter writer, SqlCall call, int leftPrec, int rightPrec) { | ||
| call.operand(0).unparse(writer, leftPrec, 0); | ||
| final SqlWriter.Frame frame = writer.startList("[", "]"); | ||
| if (!this.getName().equals("ITEM")) { | ||
| final SqlWriter.Frame offsetFrame = writer.startFunCall(this.getName()); | ||
| call.operand(1).unparse(writer, 0, 0); | ||
| writer.endFunCall(offsetFrame); | ||
| } else { | ||
| call.operand(1).unparse(writer, 0, 0); | ||
| } | ||
| writer.endList(frame); | ||
| } | ||
|
|
||
| @Override | ||
| public SqlOperandCountRange getOperandCountRange() { | ||
| return SqlOperandCountRanges.of(2); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean checkOperandTypes(SqlCallBinding callBinding, boolean throwOnFailure) { | ||
| final SqlNode left = callBinding.operand(0); | ||
| final SqlNode right = callBinding.operand(1); | ||
| if (!getOperandTypeChecker().checkSingleOperandType(callBinding, left, 0, throwOnFailure)) { | ||
| return false; | ||
| } | ||
| final SqlSingleOperandTypeChecker checker = getChecker(callBinding); | ||
| return checker.checkSingleOperandType(callBinding, right, 0, throwOnFailure); | ||
| } | ||
|
|
||
| @Override | ||
| public SqlSingleOperandTypeChecker getOperandTypeChecker() { | ||
| return (SqlSingleOperandTypeChecker) | ||
| requireNonNull(super.getOperandTypeChecker(), "operandTypeChecker"); | ||
| } | ||
|
|
||
| private static SqlSingleOperandTypeChecker getChecker(SqlCallBinding callBinding) { | ||
| final RelDataType operandType = callBinding.getOperandType(0); | ||
| switch (operandType.getSqlTypeName()) { | ||
| case ARRAY: | ||
| return OperandTypes.family(SqlTypeFamily.INTEGER); | ||
| case MAP: | ||
| RelDataType keyType = | ||
| requireNonNull(operandType.getKeyType(), "operandType.getKeyType()"); | ||
| SqlTypeName sqlTypeName = keyType.getSqlTypeName(); | ||
| return OperandTypes.family( | ||
| requireNonNull( | ||
| sqlTypeName.getFamily(), | ||
| () -> | ||
| "keyType.getSqlTypeName().getFamily() null, type is " | ||
| + sqlTypeName)); | ||
| case ROW: | ||
| case ANY: | ||
| case DYNAMIC_STAR: | ||
| case VARIANT: | ||
| return OperandTypes.family(SqlTypeFamily.INTEGER) | ||
| .or(OperandTypes.family(SqlTypeFamily.CHARACTER)); | ||
| default: | ||
| throw callBinding.newValidationSignatureError(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public String getAllowedSignatures(String name) { | ||
| if (name.equals("ITEM")) { | ||
| return "<ARRAY>[<INTEGER>]\n" | ||
| + "<MAP>[<ANY>]\n" | ||
| + "<ROW>[<CHARACTER>|<INTEGER>]\n" | ||
| + "<VARIANT>[<CHARACTER>|<INTEGER>]"; | ||
| } else { | ||
| return "<ARRAY>[" + name + "(<INTEGER>)]"; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public RelDataType inferReturnType(SqlOperatorBinding opBinding) { | ||
| final RelDataTypeFactory typeFactory = opBinding.getTypeFactory(); | ||
| final RelDataType operandType = opBinding.getOperandType(0); | ||
| switch (operandType.getSqlTypeName()) { | ||
| case VARIANT: | ||
| // Return type is always nullable VARIANT | ||
| return typeFactory.createTypeWithNullability(operandType, true); | ||
| case ARRAY: | ||
| return typeFactory.createTypeWithNullability( | ||
| getComponentTypeOrThrow(operandType), true); | ||
| case MAP: | ||
| return typeFactory.createTypeWithNullability( | ||
| requireNonNull( | ||
| operandType.getValueType(), | ||
| () -> "operandType.getValueType() is null for " + operandType), | ||
| true); | ||
| case ROW: | ||
| RelDataType fieldType; | ||
| RelDataType indexType = opBinding.getOperandType(1); | ||
|
|
||
| if (SqlTypeUtil.isString(indexType)) { | ||
| final String fieldName = | ||
| getOperandLiteralValueOrThrow(opBinding, 1, String.class); | ||
| RelDataTypeField field = operandType.getField(fieldName, false, false); | ||
| if (field == null) { | ||
| throw new AssertionError( | ||
| "Cannot infer type of field '" | ||
| + fieldName | ||
| + "' within ROW type: " | ||
| + operandType); | ||
| } else { | ||
| fieldType = field.getType(); | ||
| } | ||
| } else if (SqlTypeUtil.isIntType(indexType)) { | ||
| Integer index = opBinding.getOperandLiteralValue(1, Integer.class); | ||
| if (index == null || index < 1 || index > operandType.getFieldCount()) { | ||
| throw new AssertionError( | ||
| "Cannot infer type of field at position " | ||
| + index | ||
| + " within ROW type: " | ||
| + operandType); | ||
| } else { | ||
| fieldType = | ||
| operandType.getFieldList().get(index - 1).getType(); // 1 indexed | ||
| } | ||
| } else { | ||
| throw new AssertionError( | ||
| "Unsupported field identifier type: '" + indexType + "'"); | ||
| } | ||
| if (operandType.isNullable()) { | ||
| fieldType = typeFactory.createTypeWithNullability(fieldType, true); | ||
| } | ||
| return fieldType; | ||
| case ANY: | ||
| case DYNAMIC_STAR: | ||
| return typeFactory.createTypeWithNullability( | ||
| typeFactory.createSqlType(SqlTypeName.ANY), true); | ||
| default: | ||
| throw new AssertionError(); | ||
| } | ||
| } | ||
| } |
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
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.