[FLINK-14925][table] Support precision-aware TO_TIMESTAMP with format-based inference #27793
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -848,7 +848,21 @@ temporal: | |
| TO_TIMESTAMP_LTZ('2023-01-01 00:00:00', 'yyyy-MM-dd HH:mm:ss', 'Asia/Shanghai') parses in Shanghai time zone. | ||
| - sql: TO_TIMESTAMP(string1[, string2]) | ||
| table: toTimestamp(STRING1[, STRING2]) | ||
| description: | | ||
| Converts a datetime string to a TIMESTAMP without time zone. | ||
| - string1: the datetime string to parse | ||
| - string2: the format pattern (default 'yyyy-MM-dd HH:mm:ss'). The pattern follows Java's DateTimeFormatter syntax, where 'S' represents fractional seconds (e.g., 'SSS' for milliseconds, 'SSSSSS' for microseconds, 'SSSSSSSSS' for nanoseconds). | ||
| The output precision depends on the variant used: | ||
| - 1-arg variant: always returns TIMESTAMP(3). | ||
| - 2-arg variant: precision is inferred from the number of trailing 'S' characters in the format pattern, with a minimum of 3. E.g., format 'yyyy-MM-dd HH:mm:ss.SS' returns TIMESTAMP(3), format 'yyyy-MM-dd HH:mm:ss.SSSSSS' returns TIMESTAMP(6). | ||
|
||
| Returns NULL if the input string cannot be parsed. | ||
| E.g., TO_TIMESTAMP('2023-01-01 00:00:00') parses using default format and returns TIMESTAMP(3), | ||
| TO_TIMESTAMP('2023-01-01 12:30:00.123456', 'yyyy-MM-dd HH:mm:ss.SSSSSS') parses with microsecond precision and returns TIMESTAMP(6), | ||
| TO_TIMESTAMP('2023-01-01 12:30:00.123', 'yyyy-MM-dd HH:mm:ss.SSS') returns TIMESTAMP(3). | ||
| - sql: CURRENT_WATERMARK(rowtime) | ||
| description: | | ||
| 返回给定时间列属性 rowtime 的当前水印，如果管道中的当前操作没有可用的上游操作的公共水印时则为 `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
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,115 @@ | ||
| /* | ||
| * 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.flink.table.types.inference.strategies; | ||
|
|
||
| import org.apache.flink.annotation.Internal; | ||
| import org.apache.flink.table.functions.BuiltInFunctionDefinitions; | ||
| import org.apache.flink.table.functions.FunctionDefinition; | ||
| import org.apache.flink.table.types.DataType; | ||
| import org.apache.flink.table.types.inference.ArgumentCount; | ||
| import org.apache.flink.table.types.inference.ArgumentTypeStrategy; | ||
| import org.apache.flink.table.types.inference.CallContext; | ||
| import org.apache.flink.table.types.inference.ConstantArgumentCount; | ||
| import org.apache.flink.table.types.inference.InputTypeStrategy; | ||
| import org.apache.flink.table.types.inference.Signature; | ||
| import org.apache.flink.table.types.inference.Signature.Argument; | ||
| import org.apache.flink.table.types.logical.LogicalTypeFamily; | ||
|
|
||
| import java.time.format.DateTimeFormatter; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Optional; | ||
|
|
||
| import static org.apache.flink.table.types.inference.InputTypeStrategies.logical; | ||
|
|
||
| /** | ||
| * Input type strategy for {@link BuiltInFunctionDefinitions#TO_TIMESTAMP} that validates the format | ||
| * pattern at compile time when provided as a literal. | ||
| */ | ||
| @Internal | ||
| public class ToTimestampInputTypeStrategy implements InputTypeStrategy { | ||
|
|
||
| private static final ArgumentTypeStrategy CHARACTER_STRING_FAMILY_ARG = | ||
| logical(LogicalTypeFamily.CHARACTER_STRING); | ||
|
|
||
| @Override | ||
| public ArgumentCount getArgumentCount() { | ||
| return ConstantArgumentCount.between(1, 2); | ||
| } | ||
|
|
||
| @Override | ||
| public Optional<List<DataType>> inferInputTypes( | ||
| CallContext callContext, boolean throwOnFailure) { | ||
| final List<DataType> result = new ArrayList<>(); | ||
| final int numberOfArguments = callContext.getArgumentDataTypes().size(); | ||
|
|
||
| final Optional<DataType> timestampArg = | ||
| CHARACTER_STRING_FAMILY_ARG.inferArgumentType(callContext, 0, throwOnFailure); | ||
| if (timestampArg.isEmpty()) { | ||
| return Optional.empty(); | ||
| } | ||
| result.add(timestampArg.get()); | ||
|
|
||
| if (numberOfArguments > 1) { | ||
| final Optional<DataType> patternArg = | ||
| validatePatternArgument(callContext, throwOnFailure); | ||
| if (patternArg.isEmpty()) { | ||
| return Optional.empty(); | ||
| } | ||
| result.add(patternArg.get()); | ||
| } | ||
|
|
||
| return Optional.of(result); | ||
| } | ||
|
|
||
| private Optional<DataType> validatePatternArgument( | ||
| final CallContext callContext, final boolean throwOnFailure) { | ||
| final Optional<DataType> patternArg = | ||
| CHARACTER_STRING_FAMILY_ARG.inferArgumentType(callContext, 1, throwOnFailure); | ||
| if (patternArg.isEmpty()) { | ||
| return Optional.empty(); | ||
| } | ||
|
|
||
| if (callContext.isArgumentLiteral(1)) { | ||
| final Optional<String> patternOpt = callContext.getArgumentValue(1, String.class); | ||
| if (patternOpt.isEmpty()) { | ||
| return callContext.fail(throwOnFailure, "Pattern can not be a null literal"); | ||
| } | ||
| try { | ||
| DateTimeFormatter.ofPattern(patternOpt.get()); | ||
| } catch (IllegalArgumentException e) { | ||
| return callContext.fail( | ||
| throwOnFailure, | ||
| "Invalid pattern for parsing TIMESTAMP: %s", | ||
| e.getMessage()); | ||
| } | ||
| } | ||
|
|
||
| return patternArg; | ||
| } | ||
|
|
||
| @Override | ||
| public List<Signature> getExpectedSignatures(FunctionDefinition definition) { | ||
| return List.of( | ||
| Signature.of(Argument.ofGroup(LogicalTypeFamily.CHARACTER_STRING)), | ||
| Signature.of( | ||
| Argument.ofGroup(LogicalTypeFamily.CHARACTER_STRING), | ||
| Argument.ofGroup("pattern", LogicalTypeFamily.CHARACTER_STRING))); | ||
| } | ||
| } |
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,63 @@ | ||
| /* | ||
| * 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.flink.table.types.inference.strategies; | ||
|
|
||
| import org.apache.flink.annotation.Internal; | ||
| import org.apache.flink.table.api.DataTypes; | ||
| import org.apache.flink.table.types.DataType; | ||
| import org.apache.flink.table.types.inference.CallContext; | ||
| import org.apache.flink.table.types.inference.TypeStrategy; | ||
| import org.apache.flink.table.utils.DateTimeUtils; | ||
|
|
||
| import java.util.Optional; | ||
|
|
||
| /** | ||
| * Type strategy of {@code TO_TIMESTAMP}. Returns {@code TIMESTAMP(3)} for the 1-arg variant and | ||
| * infers precision from the format pattern's trailing 'S' count for the 2-arg variant. | ||
| */ | ||
| @Internal | ||
| public class ToTimestampTypeStrategy implements TypeStrategy { | ||
|
|
||
| private static final int DEFAULT_PRECISION = 3; | ||
|
|
||
| @Override | ||
| public Optional<DataType> inferType(CallContext callContext) { | ||
| int outputPrecision = DEFAULT_PRECISION; | ||
|
|
||
| if (callContext.getArgumentDataTypes().size() == 2) { | ||
| outputPrecision = inferPrecisionFromFormat(callContext); | ||
| } | ||
|
|
||
| return Optional.of(DataTypes.TIMESTAMP(outputPrecision).nullable()); | ||
| } | ||
|
|
||
| /** | ||
| * Infers the output precision from a format string literal. Returns at least {@link | ||
| * #DEFAULT_PRECISION}. | ||
| */ | ||
| private static int inferPrecisionFromFormat(CallContext callContext) { | ||
| if (!callContext.isArgumentLiteral(1)) { | ||
| return DEFAULT_PRECISION; | ||
| } | ||
| return callContext | ||
| .getArgumentValue(1, String.class) | ||
| .map(DateTimeUtils::precisionFromFormat) | ||
| .orElse(DEFAULT_PRECISION); | ||
| } | ||
| } |
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,73 @@ | ||
| /* | ||
| * 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.flink.table.types.inference.strategies; | ||
|
|
||
| import org.apache.flink.table.api.DataTypes; | ||
| import org.apache.flink.table.types.inference.TypeStrategiesTestBase; | ||
|
|
||
| import java.util.stream.Stream; | ||
|
|
||
| /** Tests for {@link ToTimestampTypeStrategy}. */ | ||
| class ToTimestampTypeStrategyTest extends TypeStrategiesTestBase { | ||
|
|
||
| @Override | ||
| protected Stream<TestSpec> testData() { | ||
| return Stream.of( | ||
| // 1-arg: always TIMESTAMP(3) | ||
| TestSpec.forStrategy( | ||
| "TO_TIMESTAMP(<STRING>) returns TIMESTAMP(3)", | ||
| SpecificTypeStrategies.TO_TIMESTAMP) | ||
| .inputTypes(DataTypes.STRING()) | ||
| .expectDataType(DataTypes.TIMESTAMP(3).nullable()), | ||
| // 2-arg: non-literal format defaults to TIMESTAMP(3) | ||
| TestSpec.forStrategy( | ||
| "TO_TIMESTAMP(<STRING>, <STRING>) defaults to TIMESTAMP(3)", | ||
| SpecificTypeStrategies.TO_TIMESTAMP) | ||
| .inputTypes(DataTypes.STRING(), DataTypes.STRING()) | ||
| .expectDataType(DataTypes.TIMESTAMP(3).nullable()), | ||
| // Format-based precision: SSS → TIMESTAMP(3) | ||
| TestSpec.forStrategy( | ||
| "Format with SSS returns TIMESTAMP(3)", | ||
| SpecificTypeStrategies.TO_TIMESTAMP) | ||
| .inputTypes(DataTypes.STRING(), DataTypes.STRING()) | ||
| .calledWithLiteralAt(1, "yyyy-MM-dd HH:mm:ss.SSS") | ||
| .expectDataType(DataTypes.TIMESTAMP(3).nullable()), | ||
| // Format-based precision: SSSSSS → TIMESTAMP(6) | ||
| TestSpec.forStrategy( | ||
| "Format with SSSSSS returns TIMESTAMP(6)", | ||
| SpecificTypeStrategies.TO_TIMESTAMP) | ||
| .inputTypes(DataTypes.STRING(), DataTypes.STRING()) | ||
| .calledWithLiteralAt(1, "yyyy-MM-dd HH:mm:ss.SSSSSS") | ||
| .expectDataType(DataTypes.TIMESTAMP(6).nullable()), | ||
| // Format-based precision: SSSSSSSSS → TIMESTAMP(9) | ||
| TestSpec.forStrategy( | ||
| "Format with SSSSSSSSS returns TIMESTAMP(9)", | ||
| SpecificTypeStrategies.TO_TIMESTAMP) | ||
| .inputTypes(DataTypes.STRING(), DataTypes.STRING()) | ||
| .calledWithLiteralAt(1, "yyyy-MM-dd HH:mm:ss.SSSSSSSSS") | ||
| .expectDataType(DataTypes.TIMESTAMP(9).nullable()), | ||
| // Format without S → TIMESTAMP(3) | ||
| TestSpec.forStrategy( | ||
| "Format without S returns TIMESTAMP(3)", | ||
| SpecificTypeStrategies.TO_TIMESTAMP) | ||
| .inputTypes(DataTypes.STRING(), DataTypes.STRING()) | ||
| .calledWithLiteralAt(1, "yyyy-MM-dd HH:mm:ss") | ||
| .expectDataType(DataTypes.TIMESTAMP(3).nullable())); | ||
| } | ||
| } |
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.
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.
looks like we are going to heavily introduce java classes here....
Would be great if we have it consistent at least.
I'm asking since here we are talking about
DateTimeFormatter, in case ofDATE_FORMATthere isSimpleDateFormatter...I think we should have at least a link to their doc explaining the formats, it will simplify the search for non java people (sql, python)
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.
Updated the docs. Let me know if something is still missing.