forked from apache/flink
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FLINK-21989][table] Add a SupportsSourceWatermark ability interface
This closes apache#15388.
- Loading branch information
Showing
14 changed files
with
306 additions
and
32 deletions.
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
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
53 changes: 53 additions & 0 deletions
53
.../main/java/org/apache/flink/table/connector/source/abilities/SupportsSourceWatermark.java
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,53 @@ | ||
| /* | ||
| * 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.source.abilities; | ||
|
|
||
| import org.apache.flink.annotation.PublicEvolving; | ||
| import org.apache.flink.table.connector.source.ScanTableSource; | ||
|
|
||
| /** | ||
| * Enables to fully rely on the watermark strategy provided by the {@link ScanTableSource} itself. | ||
| * | ||
| * <p>The concept of watermarks defines when time operations based on an event time attribute will | ||
| * be triggered. A watermark tells operators that no elements with a timestamp older or equal to the | ||
| * watermark timestamp should arrive at the operator. Thus, watermarks are a trade-off between | ||
| * latency and completeness. | ||
| * | ||
| * <p>Given the following SQL: | ||
| * | ||
| * <pre>{@code | ||
| * CREATE TABLE t (i INT, ts TIMESTAMP(3), WATERMARK FOR ts AS SOURCE_WATERMARK()) // `ts` becomes a time attribute | ||
| * }</pre> | ||
| * | ||
| * <p>In the above example, the {@code SOURCE_WATERMARK()} is a built-in marker function that will | ||
| * be detected by the planner and translated into a call to this interface if available. If a source | ||
| * does not implement this interface, an exception will be thrown. | ||
| * | ||
| * <p>Compared to {@link SupportsWatermarkPushDown}, it is not possible to influence a source's | ||
| * watermark strategy using customs expressions if {@code SOURCE_WATERMARK()} is declared. | ||
| * Nevertheless, a source can implement both interfaces if necessary. | ||
| * | ||
| * @see SupportsWatermarkPushDown | ||
| */ | ||
| @PublicEvolving | ||
| public interface SupportsSourceWatermark { | ||
|
|
||
| /** Instructs the source to emit source-specific watermarks during runtime. */ | ||
| void applySourceWatermark(); | ||
| } |
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
63 changes: 63 additions & 0 deletions
63
...c/main/java/org/apache/flink/table/planner/plan/abilities/source/SourceWatermarkSpec.java
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,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.planner.plan.abilities.source; | ||
|
|
||
| import org.apache.flink.table.api.TableException; | ||
| import org.apache.flink.table.connector.source.DynamicTableSource; | ||
| import org.apache.flink.table.connector.source.abilities.SupportsSourceWatermark; | ||
| import org.apache.flink.table.types.logical.RowType; | ||
|
|
||
| import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonCreator; | ||
| import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonProperty; | ||
| import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonTypeName; | ||
|
|
||
| /** | ||
| * A sub-class of {@link SourceAbilitySpec} that can not only serialize/deserialize the boolean flag | ||
| * whether a source watermark should be used to/from JSON, but can also apply it to {@link | ||
| * SupportsSourceWatermark}. | ||
| */ | ||
| @JsonTypeName("SourceWatermark") | ||
| public class SourceWatermarkSpec extends SourceAbilitySpecBase { | ||
| public static final String FIELD_NAME_SOURCE_WATERMARK_ENABLED = "sourceWatermarkEnabled"; | ||
|
|
||
| @JsonProperty(FIELD_NAME_SOURCE_WATERMARK_ENABLED) | ||
| private final boolean sourceWatermarkEnabled; | ||
|
|
||
| @JsonCreator | ||
| public SourceWatermarkSpec( | ||
| @JsonProperty(FIELD_NAME_SOURCE_WATERMARK_ENABLED) boolean sourceWatermarkEnabled, | ||
| @JsonProperty(FIELD_NAME_PRODUCED_TYPE) RowType producedType) { | ||
| super(producedType); | ||
| this.sourceWatermarkEnabled = sourceWatermarkEnabled; | ||
| } | ||
|
|
||
| @Override | ||
| public void apply(DynamicTableSource tableSource, SourceAbilityContext context) { | ||
| if (tableSource instanceof SupportsSourceWatermark) { | ||
| if (sourceWatermarkEnabled) { | ||
| ((SupportsSourceWatermark) tableSource).applySourceWatermark(); | ||
| } | ||
| } else { | ||
| throw new TableException( | ||
| String.format( | ||
| "%s does not support SupportsSourceWatermark.", | ||
| tableSource.getClass().getName())); | ||
| } | ||
| } | ||
| } |
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
Oops, something went wrong.