Skip to content

Commit 61e8a92

Browse files
Airbladertwalthr
authored andcommitted
[FLINK-22475][table-common] Document usage of '#' placeholder in option keys
1 parent 0f51995 commit 61e8a92

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

flink-table/flink-table-common/src/main/java/org/apache/flink/table/factories/Factory.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@
5252
* <li>In case of a hierarchy, try not to use the higher level again in the key name (e.g. do
5353
* {@code sink.partitioner} instead of {@code sink.sink-partitioner}) to <b>keep the keys
5454
* short</b>.
55+
* <li>Key names which can be templated, e.g. to refer to a specific column, should be listed
56+
* using '#' as the placeholder symbol. For example, use {@code fields.#.min}.
5557
* </ul>
5658
*/
5759
@PublicEvolving

0 commit comments

Comments
 (0)