Skip to content

Commit 13485b5

Browse files
author
duzhendi
committed
[Doc][Improve] support chinese [docs/zh/connector-v2/sink/Kingbase.md]
1 parent 25dfbb2 commit 13485b5

File tree

1 file changed

+168
-0
lines changed

1 file changed

+168
-0
lines changed

Diff for: ‎docs/zh/connector-v2/sink/Kingbase.md

+168
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
# Kingbase
2+
3+
> JDBC Kingbase数据接收器
4+
5+
## 支持连接器版本
6+
7+
- 8.6
8+
9+
## 支持引擎
10+
11+
> Spark<br/>
12+
> Flink<br/>
13+
> SeaTunnel Zeta<br/>
14+
15+
## 主要特性
16+
17+
- [ ] [exactly-once](../../concept/connector-v2-features.md)
18+
- [ ] [cdc](../../concept/connector-v2-features.md)
19+
20+
## 描述
21+
22+
>使用"Xa transactions"来确保"精确一次"。因此，数据库只支持"精确一次"，即
23+
>支持"Xa transactions"。您可以设置`is_exactly_once=true `来启用它。Kingbase目前不支持
24+
25+
## 支持的数据源信息
26+
27+
| Datasource | Supported versions | Driver | Url | Maven |
28+
|------------|--------------------|----------------------|------------------------------------------|------------------------------------------------------------------------------------------------|
29+
| Kingbase | 8.6 | com.kingbase8.Driver | jdbc:kingbase8://localhost:54321/db_test | [Download](https://repo1.maven.org/maven2/cn/com/kingbase/kingbase8/8.6.0/kingbase8-8.6.0.jar) |
30+
31+
## 数据库相关性
32+
33+
> 请下载"Maven"对应的支持列表，并将其复制到"$SEATUNNEL_HOME/plugins/jdbc/lib/"
34+
> 工作目录<br/>
35+
> 例如：cp-kingbase8-8.6.0.jar$SEATUNNEL_HOME/plugins/jdbc/lib/
36+
37+
## 数据类型映射
38+
39+
| Kingbase 数据类型 | SeaTunnel 数据类型 |
40+
|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
41+
| BOOL | BOOLEAN |
42+
| INT2 | SHORT |
43+
| SMALLSERIAL <br/>SERIAL <br/>INT4 | INT |
44+
| INT8 <br/>BIGSERIAL | BIGINT |
45+
| FLOAT4 | FLOAT |
46+
| FLOAT8 | DOUBLE |
47+
| NUMERIC | DECIMAL((Get the designated column's specified column size),<br/>(Gets the designated column's number of digits to right of the decimal point.))) |
48+
| BPCHAR <br/>CHARACTER <br/>VARCHAR <br/>TEXT | STRING |
49+
| TIMESTAMP | LOCALDATETIME |
50+
| TIME | LOCALTIME |
51+
| DATE | LOCALDATE |
52+
| Other data type | Not supported yet |
53+
54+
## Sink 选项
55+
56+
| 名称 | 类型 | 是否必传 | 默认值 | 描述 |
57+
|-------------------------------------------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
58+
| url | String | 是 | - | JDBC连接的URL。请参考案例：jdbc:db2://127.0.0.1:50000/dbname |
59+
| driver | String | 是 | - | 用于连接到远程数据源的jdbc类名，<br/>如果使用DB2，则值为 `com.ibm.db2.jdbc.app.DB2Driver`. |
60+
| user | String | 否 | - | 连接实例用户名 |
61+
| password | String | 否 | - | 连接实例用密码 |
62+
| query | String | 否 | - | 使用此sql将上游输入数据写入数据库。例如`INSERT ...`,`query`具有更高的优先级 |
63+
| database | String | 否 | - | 使用这个“database”和“table-name”自动生成sql并接收上游输入数据写入数据库<br/>此选项与“query”互斥，具有更高的优先级。 |
64+
| table | String | 否 | - | 使用数据库和此表名自动生成sql并接收上游输入数据写入数据库<br/>此选项与“query”互斥，具有更高的优先级。 |
65+
| primary_keys | Array | 否 | - | 此选项用于在自动生成sql时支持`insert`, `delete` 和`update`等操作。 |
66+
| support_upsert_by_query_primary_key_exist | Boolean | 否 | false | 选择使用INSERT sql、UPDATE sql根据查询主键是否存在来处理更新事件（INSERT, UPDATE_AFTER）。此配置仅在数据库不支持升级语法时使用**注**：此方法性能低 |
67+
| connection_check_timeout_sec | Int | 否 | 30 | 等待用于验证连接的数据库操作完成的时间（秒）。 |
68+
| max_retries | Int | 否 | 0 | 提交失败的重试次数（executeBatch） |
69+
| batch_size | Int | 否 | 1000 | 对于批量写入，当缓冲记录的数量达到“batch_size”的数量或时间达到“checkpoint.interval”<br/>时，数据将被刷新到数据库中 |
70+
| is_exactly_once | Boolean | 否 | false | 是否启用精确一次语义，这将使用Xa事务。如果启用，则需要<br/>设置`xa_data_source_class_name`。Kingbase目前不支持 |
71+
| generate_sink_sql | Boolean | 否 | false | 根据要写入的数据库表生成sql语句 |
72+
| xa_data_source_class_name | String | 否 | - | database Driver的xa数据源类名，Kingbase目前不支持 |
73+
| max_commit_attempts | Int | 否 | 3 | 事务提交失败的重试次数 |
74+
| transaction_timeout_sec | Int | No | -1 | 事务打开后的超时，默认值为-1（永不超时）。请注意，设置超时可能会影响＜br/＞精确一次语义 |
75+
| auto_commit | Boolean | 否 | true | 默认情况下启用自动事务提交 |
76+
| common-options | | 否 | - | Sink插件常用参数，详见[Sink common Options]（../Sink common Options.md） |
77+
| enable_upsert | Boolean | 否 | true | 通过primary_keys存在启用upstart，如果任务没有密钥重复数据，将此参数设置为“false”可以加快数据导入 |
78+
79+
### 提示
80+
81+
> 如果未设置partition_column，它将以单并发方式运行，如果设置了partition_coolumn，它将被执行
82+
> 根据任务的并发性并行执行。
83+
84+
## 任务示例
85+
86+
### 简单示例:
87+
88+
> 此示例定义了一个SeaTunnel同步任务，该任务通过FakeSource自动生成数据并发送
89+
> 它连接到JDBC接收器。FakeSource总共生成16行数据（row.num=16），每行有12个字段。最终的目标表是test_table，表中也将有16行数据。
90+
> 之前
91+
> 运行此作业，您需要在Kingbase中创建数据库测试和表test_table。如果你还没有安装和
92+
> 已部署SeaTunnel，您需要按照[安装SeaTunnel]中的说明进行操作（../../start-v2/local/deployment.md）
93+
> to
94+
> 安装和部署SeaTunnel。然后按照指示进行
95+
> 在[快速启动SeaTunnel引擎]（../../Start-v2/locale/Quick-Start SeaTunnel Engine.md）中运行此作业。
96+
97+
```
98+
# 定义运行时环境
99+
env {
100+
parallelism = 1
101+
job.mode = "BATCH"
102+
}
103+
104+
source {
105+
# 这是一个示例源插件**，仅用于测试和演示功能源插件**
106+
FakeSource {
107+
parallelism = 1
108+
plugin_output = "fake"
109+
row.num = 16
110+
schema = {
111+
fields {
112+
c_string = string
113+
c_boolean = boolean
114+
c_tinyint = tinyint
115+
c_smallint = smallint
116+
c_int = int
117+
c_bigint = bigint
118+
c_float = float
119+
c_double = double
120+
c_decimal = "decimal(30, 8)"
121+
c_date = date
122+
c_time = time
123+
c_timestamp = timestamp
124+
}
125+
}
126+
}
127+
# 如果你想了解更多关于如何配置seatunnel的信息，并查看完整的源插件列表，
128+
# 请前往https://seatunnel.apache.org/docs/connector-v2/source
129+
}
130+
131+
transform {
132+
# 如果你想了解更多关于如何配置seatunnel的信息，并查看转换插件的完整列表，
133+
# 请前往https://seatunnel.apache.org/docs/category/transform-v2
134+
}
135+
136+
sink {
137+
jdbc {
138+
url = "jdbc:kingbase8://127.0.0.1:54321/dbname"
139+
driver = "com.kingbase8.Driver"
140+
user = "root"
141+
password = "123456"
142+
query = "insert into test_table(c_string,c_boolean,c_tinyint,c_smallint,c_int,c_bigint,c_float,c_double,c_decimal,c_date,c_time,c_timestamp) values(?,?,?,?,?,?,?,?,?,?,?,?)"
143+
}
144+
# 如果你想了解更多关于如何配置seatunnel的信息，并查看完整的sink插件列表，
145+
# 请前往https://seatunnel.apache.org/docs/connector-v2/sink
146+
}
147+
```
148+
149+
### 生成Sink SQL
150+
151+
> 此示例不需要编写复杂的sql语句，可以将数据库名称表名配置为自动
152+
> 为您生成add语句
153+
154+
```
155+
sink {
156+
jdbc {
157+
url = "jdbc:kingbase8://127.0.0.1:54321/dbname"
158+
driver = "com.kingbase8.Driver"
159+
user = "root"
160+
password = "123456"
161+
# Automatically generate sql statements based on database table names
162+
generate_sink_sql = true
163+
database = test
164+
table = test_table
165+
}
166+
}
167+
```
168+

0 commit comments

Comments
 (0)