Skip to content

Commit 79683cf

Browse files
Hisoka-XHisoka-X
authored
[FLINK-38836][docs] update section headings and improve pipeline configuration options (#4244)
1 parent 7f627ff commit 79683cf

4 files changed

Lines changed: 19 additions & 13 deletions

File tree

‎docs/content.zh/docs/connectors/pipeline-connectors/iceberg.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Pipeline Connector Options
135135
<td>optional</td>
136136
<td style="word-wrap: break-word;">(none)</td>
137137
<td>String</td>
138-
<td>Partition keys for each partitioned table, allow setting multiple primary keys for multiTables. Each table are separated by ';', and each partition key are separated by ','. For example, we can set partition.key of two tables by 'testdb.table1:id1,id2;testdb.table2:name'.</td>
138+
<td>Partition keys for each partitioned table. Allow setting multiple primary keys for multiTables. Tables are separated by ';', and partition keys are separated by ','. For example, we can set <code>partition.key</code> of two tables using 'testdb.table1:id1,id2;testdb.table2:name'. For partition transforms, we can set <code>partition.key</code> using 'testdb.table1:truncate[10](id);testdb.table2:hour(create_time);testdb.table3:day(create_time);testdb.table4:month(create_time);testdb.table5:year(create_time);testdb.table6:bucket[10](create_time)'.</td>
139139
</tr>
140140
<tr>
141141
<td>catalog.properties.*</td>

‎docs/content.zh/docs/connectors/pipeline-connectors/paimon.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ Pipeline 连接器配置项
207207
</tr>
208208
<tr>
209209
<td>TIMESTAMP</td>
210-
<td>DATETIME</td>
210+
<td>TIMESTAMP</td>
211211
<td></td>
212212
</tr>
213213
<tr>

‎docs/content.zh/docs/core-concept/data-pipeline.md‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -109,12 +109,18 @@ under the License.
109109
```
110110
111111
# Pipeline 配置
112-
下面 是 Data Pipeline 的一些可选配置：
113-
114-
| 参数 | 含义 | optional/required |
115-
|------------------------|-----------------------------------------------------------------------------------------------------------|-------------------|
116-
| name | 这个 pipeline 的名称，会用在 Flink 集群中作为作业的名称。 | optional |
117-
| parallelism | pipeline的全局并发度，默认值是1。 | optional |
118-
| local-time-zone | 作业级别的本地时区。 | optional |
119-
| execution.runtime-mode | pipeline 的运行模式，包含 STREAMING 和 BATCH，默认值是 STREAMING。 | optional |
120-
| operator.uid.prefix | Pipeline 中算子 UID 的前缀。如果不设置，Flink 会为每个算子生成唯一的 UID。 建议设置这个参数以提供稳定和可识别的算子 ID，这有助于有状态升级、问题排查和在 Flink UI 上的诊断。 | optional |
112+
下面是 Data Pipeline 级别支持的配置选项。
113+
请注意，虽然这些参数都是可选的，但至少需要指定其中一个。也就是说，`pipeline` 部分是必需的，不能为空。
114+
115+
| 参数 | 含义 | optional/required |
116+
|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|
117+
| `name` | 这个 pipeline 的名称，会用在 Flink 集群中作为作业的名称。 | optional |
118+
| `parallelism` | pipeline的全局并发度，默认值是1。 | optional |
119+
| `local-time-zone` | 作业级别的本地时区。 | optional |
120+
| `execution.runtime-mode` | pipeline 的运行模式，包含 STREAMING 和 BATCH，默认值是 STREAMING。 | optional |
121+
| `schema.change.behavior` | 如何处理 [schema 变更]({{< ref "docs/core-concept/schema-evolution" >}})。可选值：[`exception`]({{< ref "docs/core-concept/schema-evolution" >}}#exception-mode)、[`evolve`]({{< ref "docs/core-concept/schema-evolution" >}}#evolve-mode)、[`try_evolve`]({{< ref "docs/core-concept/schema-evolution" >}}#tryevolve-mode)、[`lenient`]({{< ref "docs/core-concept/schema-evolution" >}}#lenient-mode)（默认值）或 [`ignore`]({{< ref "docs/core-concept/schema-evolution" >}}#ignore-mode)。 | optional |
122+
| `schema.operator.uid` | Schema 算子的唯一 ID。此 ID 用于算子间通信，必须在所有算子中保持唯一。**已废弃**：请使用 `operator.uid.prefix` 代替。 | optional |
123+
| `schema-operator.rpc-timeout` | SchemaOperator 等待下游 SchemaChangeEvent 应用完成的超时时间，默认值是 3 分钟。 | optional |
124+
| `operator.uid.prefix` | Pipeline 中算子 UID 的前缀。如果不设置，Flink 会为每个算子生成唯一的 UID。 建议设置这个参数以提供稳定和可识别的算子 ID，这有助于有状态升级、问题排查和在 Flink UI 上的诊断。 | optional |
125+
126+
注意：虽然上述参数都是可选的，但至少需要指定其中一个。`pipeline` 部分是必需的，不能为空。

‎docs/content/docs/developer-guide/contribute-to-flink-cdc.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ project as follows.
4545

4646
Any other question? Reach out to the Dev mail list to get help!
4747

48-
<h2 id="code-review-guide">Code Contribution Guide</h2>
48+
<h2 id="code-contribution-guide">Code Contribution Guide</h2>
4949

5050
Flink CDC is maintained, improved, and extended by code contributions of volunteers. We welcome contributions.
5151

@@ -63,7 +63,7 @@ If you would like to contribute to Flink CDC, you could raise it as follows.
6363
4. Find a reviewer to review your PR and make sure the CI passed
6464
5. A committer of Flink CDC checks if the contribution fulfills the requirements and merges the code to the codebase.
6565

66-
<h2 id="code-contribution-guide">Code Review Guide</h2>
66+
<h2 id="code-review-guide">Code Review Guide</h2>
6767

6868
Every review needs to check the following aspects.
6969

0 commit comments

Comments
 (0)