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-36705][table-common] Add initial ProcessTableFunction class an…
…d annotations
- Loading branch information
Showing
12 changed files
with
531 additions
and
30 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
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
73 changes: 73 additions & 0 deletions
73
...k-table/flink-table-common/src/main/java/org/apache/flink/table/annotation/StateHint.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,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.annotation; | ||
|
|
||
| import org.apache.flink.annotation.PublicEvolving; | ||
| import org.apache.flink.table.functions.AggregateFunction; | ||
| import org.apache.flink.table.functions.ProcessTableFunction; | ||
| import org.apache.flink.table.functions.TableAggregateFunction; | ||
|
|
||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| /** | ||
| * A hint that declares an intermediate result (i.e. state entry) that is managed by the framework | ||
| * (i.e. Flink managed state). | ||
| * | ||
| * <p>State hints are primarily intended for {@link ProcessTableFunction}. A PTF supports multiple | ||
| * state entries at the beginning of an eval()/onTimer() method (after an optional context | ||
| * parameter). | ||
| * | ||
| * <p>Aggregating functions (i.e. {@link AggregateFunction} and {@link TableAggregateFunction}) | ||
| * support a single state entry at the beginning of an accumulate()/retract() method (i.e. the | ||
| * accumulator). | ||
| * | ||
| * <p>For example, {@code @StateHint(name = "count", type = @DataTypeHint("BIGINT"))} is a state | ||
| * entry with the data type BIGINT named "count". | ||
| * | ||
| * <p>Note: Usually, a state entry is partitioned by a key and can not be accessed globally. The | ||
| * partitioning (or whether it is only a single partition) is defined by the corresponding function | ||
| * call. | ||
| * | ||
| * @see FunctionHint | ||
| */ | ||
| @PublicEvolving | ||
| @Retention(RetentionPolicy.RUNTIME) | ||
| @Target({ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER}) | ||
| public @interface StateHint { | ||
|
|
||
| /** | ||
| * The name of the state entry. It must be unique among other state entries. | ||
| * | ||
| * <p>This can be used to provide a descriptive name for the state entry. The name can be used | ||
| * for referencing the entry during clean up. | ||
| */ | ||
| String name() default ""; | ||
|
|
||
| /** | ||
| * The data type hint for the state entry. | ||
| * | ||
| * <p>This can be used to provide additional information about the expected data type of the | ||
| * argument. The {@link DataTypeHint} annotation can be used to specify the data type explicitly | ||
| * or provide hints for the reflection-based extraction of the data type. | ||
| */ | ||
| DataTypeHint type() default @DataTypeHint(); | ||
| } |
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 |
|---|---|---|
|
|
@@ -35,5 +35,7 @@ public enum FunctionKind { | |
|
|
||
| TABLE_AGGREGATE, | ||
|
|
||
| PROCESS_TABLE, | ||
|
|
||
| OTHER | ||
| } | ||
Oops, something went wrong.