You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by ku...@apache.org on 2025/05/27 01:29:15 UTC
(flink-cdc) branch master updated: [FLINK-37465][docs] Update options for OceanBase connector (#3946)
This is an automated email from the ASF dual-hosted git repository.
kunni pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-cdc.git
The following commit(s) were added to refs/heads/master by this push:
new 447b8d6f6 [FLINK-37465][docs] Update options for OceanBase connector (#3946)
447b8d6f6 is described below
commit 447b8d6f6641b8e33a4332d28eb65f133874df91
Author: Shawn Huang <hx...@gmail.com>
AuthorDate: Tue May 27 09:29:11 2025 +0800
[FLINK-37465][docs] Update options for OceanBase connector (#3946)
---
.../connectors/pipeline-connectors/oceanbase.md | 6 +-
.../connectors/pipeline-connectors/oceanbase.md | 69 +++++++++++++++++++++-
2 files changed, 69 insertions(+), 6 deletions(-)
diff --git a/docs/content.zh/docs/connectors/pipeline-connectors/oceanbase.md b/docs/content.zh/docs/connectors/pipeline-connectors/oceanbase.md
index 17f4f91f6..a01d35bb6 100644
--- a/docs/content.zh/docs/connectors/pipeline-connectors/oceanbase.md
+++ b/docs/content.zh/docs/connectors/pipeline-connectors/oceanbase.md
@@ -52,7 +52,7 @@ sink:
type: oceanbase
url: jdbc:mysql://oceanbase:2881/test
username: root@test
- password:
+ password: password
pipeline:
name: MySQL to OceanBase Pipeline
@@ -75,8 +75,8 @@ pipeline:
<tbody>
<tr>
<td>type</td>
- <td>required</td>
- <td style="word-wrap: break-word;">(none)</td>
+ <td>是</td>
+ <td></td>
<td>String</td>
<td>指定要使用的连接器, 这里需要设置成 <code>'oceanbase'</code>.</td>
</tr>
diff --git a/docs/content/docs/connectors/pipeline-connectors/oceanbase.md b/docs/content/docs/connectors/pipeline-connectors/oceanbase.md
index 19ccbcab4..e0b1bdd7b 100644
--- a/docs/content/docs/connectors/pipeline-connectors/oceanbase.md
+++ b/docs/content/docs/connectors/pipeline-connectors/oceanbase.md
@@ -52,7 +52,7 @@ sink:
type: oceanbase
url: jdbc:mysql://oceanbase:2881/test
username: root@test
- password:
+ password: password
pipeline:
name: MySQL to OceanBase Pipeline
@@ -73,6 +73,13 @@ pipeline:
</tr>
</thead>
<tbody>
+ <tr>
+ <td>type</td>
+ <td>Yes</td>
+ <td></td>
+ <td>String</td>
+ <td>Specify what connector to use, here should be <code>'oceanbase'</code>.</td>
+ </tr>
<tr>
<td>url</td>
<td>Yes</td>
@@ -96,14 +103,14 @@ pipeline:
</tr>
<tr>
<td>schema-name</td>
- <td>Yes</td>
+ <td>No</td>
<td></td>
<td>String</td>
<td>The schema name or database name.</td>
</tr>
<tr>
<td>table-name</td>
- <td>Yes</td>
+ <td>No</td>
<td></td>
<td>String</td>
<td>The table name.</td>
@@ -178,6 +185,62 @@ pipeline:
<td>Boolean</td>
<td>Whether to enable partition calculation and flush records by partitions. Only works when 'sync-write' and 'direct-load.enabled' are 'false'.</td>
</tr>
+ <tr>
+ <td>direct-load.enabled</td>
+ <td>No</td>
+ <td>false</td>
+ <td>Boolean</td>
+ <td>Whether to enable direct load. The parallelism of sink should be 1 if enabled.</td>
+ </tr>
+ <tr>
+ <td>direct-load.host</td>
+ <td>No</td>
+ <td></td>
+ <td>String</td>
+ <td>Hostname used in direct load.</td>
+ </tr>
+ <tr>
+ <td>direct-load.port</td>
+ <td>No</td>
+ <td>2882</td>
+ <td>String</td>
+ <td>Rpc port number used in direct load.</td>
+ </tr>
+ <tr>
+ <td>direct-load.parallel</td>
+ <td>No</td>
+ <td>8</td>
+ <td>Integer</td>
+ <td>Parallelism of direct load.</td>
+ </tr>
+ <tr>
+ <td>direct-load.max-error-rows</td>
+ <td>No</td>
+ <td>0</td>
+ <td>Long</td>
+ <td>Maximum tolerable number of error rows.</td>
+ </tr>
+ <tr>
+ <td>direct-load.dup-action</td>
+ <td>No</td>
+ <td>REPLACE</td>
+ <td>STRING</td>
+ <td>Action when there is duplicated record in direct load.</td>
+ </tr>
+ <tr>
+ <td>direct-load.timeout</td>
+ <td>No</td>
+ <td>7d</td>
+ <td>Duration</td>
+ <td>Timeout for direct load task.</td>
+ </tr>
+ <tr>
+ <td>direct-load.heartbeat-timeout</td>
+ <td>No</td>
+ <td>30s</td>
+ <td>Duration</td>
+ <td>Client heartbeat timeout in direct load task.</td>
+ </tr>
</tbody>
</table>
</div>