Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLINK-37465][docs] Update options for OceanBase connector #3946

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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>
Expand Down
69 changes: 66 additions & 3 deletions docs/content/docs/connectors/pipeline-connectors/oceanbase.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand Down