Skip to content

Commit

Permalink
[FLINK-20372][docs][kafka] Update Kafka SQL connector page to mention…
Browse files Browse the repository at this point in the history
… 'properties.*' options

This closes apache#14276
  • Loading branch information
fsk119 authored and wuchong committed Dec 8, 2020
1 parent 65cd385 commit ba0dfbb
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/dev/table/connectors/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,15 @@ Connector Options
<td>String</td>
<td>The id of the consumer group for Kafka source, optional for Kafka sink.</td>
</tr>
<tr>
<td><h5>properties.*</h5></td>
<td>optional</td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>
This can set and pass arbitrary Kafka configurations. Suffix names must match the configuration key defined in <a href="https://kafka.apache.org/documentation/#configuration">Kafka Configuration documentation</a>. Flink will remove the "properties." key prefix and pass the transformed key and values to the underlying KafkaClient. For example, you can disable automatic topic creation via <code>'properties.allow.auto.create.topics' = 'false'</code>. But there are some configurations that do not support to set, because Flink will override them, e.g. <code>'key.deserializer'</code> and <code>'value.deserializer'</code>.
</td>
</tr>
<tr>
<td><h5>format</h5></td>
<td>required</td>
Expand Down
9 changes: 9 additions & 0 deletions docs/dev/table/connectors/kafka.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,15 @@ Connector Options
<td>String</td>
<td>The id of the consumer group for Kafka source, optional for Kafka sink.</td>
</tr>
<tr>
<td><h5>properties.*</h5></td>
<td>optional</td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>
This can set and pass arbitrary Kafka configurations. Suffix names must match the configuration key defined in <a href="https://kafka.apache.org/documentation/#configuration">Kafka Configuration documentation</a>. Flink will remove the "properties." key prefix and pass the transformed key and values to the underlying KafkaClient. For example, you can disable automatic topic creation via <code>'properties.allow.auto.create.topics' = 'false'</code>. But there are some configurations that do not support to set, because Flink will override them, e.g. <code>'key.deserializer'</code> and <code>'value.deserializer'</code>.
</td>
</tr>
<tr>
<td><h5>format</h5></td>
<td>required</td>
Expand Down
9 changes: 9 additions & 0 deletions docs/dev/table/connectors/upsert-kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,15 @@ Connector Options
<td>String</td>
<td>Comma separated list of Kafka brokers.</td>
</tr>
<tr>
<td><h5>properties.*</h5></td>
<td>optional</td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>
This can set and pass arbitrary Kafka configurations. Suffix names must match the configuration key defined in <a href="https://kafka.apache.org/documentation/#configuration">Kafka Configuration documentation</a>. Flink will remove the "properties." key prefix and pass the transformed key and values to the underlying KafkaClient. For example, you can disable automatic topic creation via <code>'properties.allow.auto.create.topics' = 'false'</code>. But there are some configurations that do not support to set, because Flink will override them, e.g. <code>'key.deserializer'</code> and <code>'value.deserializer'</code>.
</td>
</tr>
<tr>
<td><h5>key.format</h5></td>
<td>required</td>
Expand Down
11 changes: 11 additions & 0 deletions docs/dev/table/connectors/upsert-kafka.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,17 @@ of all available metadata fields.
<td>String</td>
<td>以逗号分隔的 Kafka brokers 列表。</td>
</tr>
<tr>
<td><h5>properties.*</h5></td>
<td>可选</td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>
该选项可以传递任意的 Kafka 参数。选项的后缀名必须匹配定义在 <a href="https://kafka.apache.org/documentation/#configuration">Kafka 参数文档</a>中的参数名。
Flink 会自动移除 选项名中的 "properties." 前缀,并将转换后的键名以及值传入 KafkaClient。 例如,你可以通过 <code>'properties.allow.auto.create.topics' = 'false'</code>
来禁止自动创建 topic。 但是,某些选项,例如<code>'key.deserializer'</code> 和 <code>'value.deserializer'</code> 是不允许通过该方式传递参数,因为 Flink 会重写这些参数的值。
</td>
</tr>
<tr>
<td><h5>key.format</h5></td>
<td>必选</td>
Expand Down

0 comments on commit ba0dfbb

Please sign in to comment.