[FLINK-37543][table-planner] Support sink reuse in batch mode #26379
+1,131
−10
There are no files selected for viewing
This file contains 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 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,62 @@ | ||
| /* | ||
| * 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.connector.sink.abilities; | ||
|
|
||
| import org.apache.flink.annotation.PublicEvolving; | ||
| import org.apache.flink.table.connector.sink.DynamicTableSink; | ||
|
|
||
| /** | ||
| * Interface for {@link DynamicTableSink}s that support target column writing. | ||
|
|
||
| * | ||
| * <p>The planner will parse target columns from the DML clause and call {@link | ||
| * #applyTargetColumns(int[][])} to pass an array of column index paths to sink. | ||
|
There was a problem hiding this comment. nit: to sink -> to the sink |
||
| * | ||
| * <p>The array indices are 0-based and support composite columns within (possibly nested) | ||
| * structures. This information comes from the column list of the DML clause, e.g., for a sink table | ||
| * t1 which schema is: {@code a STRING, b ROW < b1 INT, b2 STRING>, c BIGINT} | ||
| * | ||
| * <ul> | ||
| * <li>insert: 'insert into t1(a, b.b2) ...', the column list will be 'a, b.b2', and will provide | ||
| * {@code [[0], [1, 1]]}. The statement 'insert into t1 select ...' will not apply this | ||
| * ability. | ||
| * <li>update: 'update t1 set a=1, b.b1=2 where ...', the column list will be 'a, b.b1', and will | ||
| * provide {@code [[0], [1, 0]]}. | ||
| * </ul> | ||
| * | ||
| * <p>Note: Planner will not apply this ability for the delete statement because it has no column | ||
| * list. | ||
| * | ||
| * <p>A sink can use this information to perform target columns writing. | ||
| * | ||
| * <p>If this interface is implemented and {@link #applyTargetColumns(int[][])} returns true. The | ||
| * planner will use this information for plan optimization such as sink reuse. | ||
| */ | ||
| @PublicEvolving | ||
| public interface SupportsTargetColumnWriting { | ||
|
|
||
| /** | ||
| * Provides an array of column index paths related to user specified target column list. | ||
| * | ||
| * <p>See the documentation of {@link SupportsTargetColumnWriting} for more information. | ||
| * | ||
| * @param targetColumns column index paths | ||
| * @return true if the target columns are applied successfully, false otherwise. | ||
| */ | ||
| boolean applyTargetColumns(int[][] targetColumns); | ||
| } | ||
This file contains 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 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 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,79 @@ | ||
| /* | ||
| * 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.planner.plan.abilities.sink; | ||
|
|
||
| import org.apache.flink.table.api.TableException; | ||
| import org.apache.flink.table.connector.sink.DynamicTableSink; | ||
| import org.apache.flink.table.connector.sink.abilities.SupportsTargetColumnWriting; | ||
|
|
||
| import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonCreator; | ||
| import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonIgnoreProperties; | ||
| import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonProperty; | ||
| import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonTypeName; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.Objects; | ||
|
|
||
| /** | ||
| * A sub-class of {@link SinkAbilitySpec} that can not only serialize/deserialize the writing target | ||
| * column indices to/from JSON, but also can write the target columns for {@link | ||
| * SupportsTargetColumnWriting}. | ||
| */ | ||
| @JsonIgnoreProperties(ignoreUnknown = true) | ||
| @JsonTypeName("TargetColumnWriting") | ||
| public class TargetColumnWritingSpec implements SinkAbilitySpec { | ||
| public static final String FIELD_NAME_TARGET_COLUMNS = "targetColumns"; | ||
|
|
||
| @JsonProperty(FIELD_NAME_TARGET_COLUMNS) | ||
| private final int[][] targetColumns; | ||
|
|
||
| @JsonCreator | ||
| public TargetColumnWritingSpec(@JsonProperty(FIELD_NAME_TARGET_COLUMNS) int[][] targetColumns) { | ||
| this.targetColumns = targetColumns; | ||
| } | ||
|
|
||
| @Override | ||
| public void apply(DynamicTableSink tableSink) { | ||
| if (tableSink instanceof SupportsTargetColumnWriting) { | ||
| ((SupportsTargetColumnWriting) tableSink).applyTargetColumns(targetColumns); | ||
| } else { | ||
| throw new TableException( | ||
| String.format( | ||
| "%s does not support SupportsTargetColumnWriting.", | ||
| tableSink.getClass().getName())); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) { | ||
| return true; | ||
| } | ||
| if (o == null || getClass() != o.getClass()) { | ||
| return false; | ||
| } | ||
| TargetColumnWritingSpec that = (TargetColumnWritingSpec) o; | ||
| return Objects.deepEquals(targetColumns, that.targetColumns); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Arrays.deepHashCode(targetColumns); | ||
| } | ||
| } |
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.
nit: find out duplicated -> find duplicate