This is an automated email from the ASF dual-hosted git repository.
twalthr pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 61e8a926e825a407cc5f1f3a9b7502a325f3ea0a
Author: Ingo Bürk <ingo.bu...@tngtech.com>
AuthorDate: Tue May 11 08:00:58 2021 +0200
[FLINK-22475][table-common] Document usage of '#' placeholder in option keys
---
.../src/main/java/org/apache/flink/table/factories/Factory.java | 2 ++
1 file changed, 2 insertions(+)
diff --git
a/flink-table/flink-table-common/src/main/java/org/apache/flink/table/factories/Factory.java
b/flink-table/flink-table-common/src/main/java/org/apache/flink/table/factories/Factory.java
index e55523e..4a50e06 100644
---
a/flink-table/flink-table-common/src/main/java/org/apache/flink/table/factories/Factory.java
+++
b/flink-table/flink-table-common/src/main/java/org/apache/flink/table/factories/Factory.java
@@ -52,6 +52,8 @@ import java.util.Set;
* <li>In case of a hierarchy, try not to use the higher level again in the
key name (e.g. do
* {@code sink.partitioner} instead of {@code sink.sink-partitioner}) to
<b>keep the keys
* short</b>.
+ * <li>Key names which can be templated, e.g. to refer to a specific column,
should be listed
+ * using '#' as the placeholder symbol. For example, use {@code
fields.#.min}.
* </ul>
*/
@PublicEvolving
