Skip to content

[Docs][Connector-V2] Improve DB2 Kingbase and Vertica docs #11361

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.

Sign up for GitHub

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

Open
DanielCarter-stack wants to merge 1 commit into
base: dev
Choose a base branch
from
+205 −98
Open

[Docs][Connector-V2] Improve DB2 Kingbase and Vertica docs #11361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 30 additions & 8 deletions docs/en/connectors/sink/DB2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ semantics (using XA transaction guarantee).

> Use `Xa transactions` to ensure `exactly-once`. So only support `exactly-once` for the database which is
> support `Xa transactions`. You can set `is_exactly_once=true` to enable it.
- [ ] [timer flush](../../introduction/concepts/connector-v2-features.md)
- [x] [timer flush](../../introduction/concepts/connector-v2-features.md)

## Supported DataSource Info

| Datasource | Supported Versions | Driver | Url | Maven |
|------------|----------------------------------------------------------|--------------------------------|-----------------------------------|-----------------------------------------------------------------------|
| DB2 | Different dependency version has different driver class. | com.ibm.db2.jdbc.app.DB2Driver | jdbc:db2://127.0.0.1:50000/dbname | [Download](https://mvnrepository.com/artifact/com.ibm.db2.jcc/db2jcc) |
| DB2 | Different dependency version has different driver class. | com.ibm.db2.jcc.DB2Driver | jdbc:db2://127.0.0.1:50000/dbname | [Download](https://mvnrepository.com/artifact/com.ibm.db2.jcc/db2jcc) |

## Data Type Mapping

Expand All @@ -63,7 +63,7 @@ semantics (using XA transaction guarantee).
| Name | Type | Required | Default | Description |
|-------------------------------------------|---------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| url | String | Yes | - | The URL of the JDBC connection. Refer to a case: jdbc:db2://127.0.0.1:50000/dbname |
| driver | String | Yes | - | The jdbc class name used to connect to the remote data source,<br/> if you use DB2 the value is `com.ibm.db2.jdbc.app.DB2Driver`. |
| driver | String | Yes | - | The jdbc class name used to connect to the remote data source,<br/> if you use DB2 the value is `com.ibm.db2.jcc.DB2Driver`. |
| username | String | No | - | Connection instance user name |
| password | String | No | - | Connection instance password |
| query | String | No | - | Use this sql write upstream input datas to database. e.g `INSERT ...`,`query` have the higher priority |
Expand All @@ -73,14 +73,16 @@ semantics (using XA transaction guarantee).
| connection_check_timeout_sec | Int | No | 30 | The time in seconds to wait for the database operation used to validate the connection to complete. |
| max_retries | Int | No | 0 | The number of retries to submit failed (executeBatch) |
| batch_size | Int | No | 1000 | For batch writing, when the number of buffered records reaches the number of `batch_size` or the time reaches `checkpoint.interval`<br/>, the data will be flushed into the database |
| batch_interval_ms | Long | No | 0 | Write-triggered flush interval in milliseconds. `0` disables interval flushing. When the value is greater than `0`, each write checks elapsed time and flushes synchronously if the interval has passed. |
| is_exactly_once | Boolean | No | false | Whether to enable exactly-once semantics, which will use Xa transactions. If on, you need to<br/>set `xa_data_source_class_name`. |
| generate_sink_sql | Boolean | No | false | Generate sql statements based on the database table you want to write to |
| xa_data_source_class_name | String | No | - | The xa data source class name of the database Driver, for example, DB2 is `com.db2.cj.jdbc.Db2XADataSource`, and<br/>please refer to appendix for other data sources |
| xa_data_source_class_name | String | No | - | The xa data source class name of the database Driver, for example, DB2 is `com.ibm.db2.jcc.DB2XADataSource`, and<br/>please refer to appendix for other data sources |
| max_commit_attempts | Int | No | 3 | The number of retries for transaction commit failures |
| transaction_timeout_sec | Int | No | -1 | The timeout after the transaction is opened, the default is -1 (never timeout). Note that setting the timeout may affect<br/>exactly-once semantics |
| auto_commit | Boolean | No | true | Automatic transaction commit is enabled by default |
| properties | Map | No | - | Additional connection configuration parameters,when properties and URL have the same parameters, the priority is determined by the <br/>specific implementation of the driver. For example, in MySQL, properties take precedence over the URL. |
| common-options | | no | - | Sink plugin common parameters, please refer to [Sink Common Options](../common-options/sink-common-options.md) for details |
| enable_upsert | Boolean | No | true | Enable upsert when `primary_keys` exists. If the input does not contain duplicate keys, setting this parameter to `false` can speed up data import. |

### Tips

Expand Down Expand Up @@ -124,7 +126,7 @@ transform {
sink {
jdbc {
url = "jdbc:db2://127.0.0.1:50000/dbname"
driver = "com.ibm.db2.jdbc.app.DB2Driver"
driver = "com.ibm.db2.jcc.DB2Driver"
username = "root"
password = "123456"
query = "insert into test_table(name,age) values(?,?)"
Expand All @@ -142,7 +144,7 @@ sink {
sink {
jdbc {
url = "jdbc:db2://127.0.0.1:50000/dbname"
driver = "com.ibm.db2.jdbc.app.DB2Driver"
driver = "com.ibm.db2.jcc.DB2Driver"
username = "root"
password = "123456"
# Automatically generate sql statements based on database table names
Expand All @@ -161,7 +163,7 @@ sink {
sink {
jdbc {
url = "jdbc:db2://127.0.0.1:50000/dbname"
driver = "com.ibm.db2.jdbc.app.DB2Driver"
driver = "com.ibm.db2.jcc.DB2Driver"

max_retries = 0
username = "root"
Expand All @@ -170,7 +172,27 @@ sink {

is_exactly_once = "true"

xa_data_source_class_name = "com.db2.cj.jdbc.Db2XADataSource"
xa_data_source_class_name = "com.ibm.db2.jcc.DB2XADataSource"
}
}
```

### Generate Sink SQL With Upsert

> When `generate_sink_sql = true` and `primary_keys` is set, DB2 uses a generated `MERGE` statement for upsert writes. If the input is insert-only and duplicate keys are impossible, set `enable_upsert = false` to use a faster insert path.

```
sink {
Jdbc {
url = "jdbc:db2://127.0.0.1:50000/E2E"
driver = "com.ibm.db2.jcc.DB2Driver"
username = "db2inst1"
password = "123456"
database = "E2E"
table = "SINK"
generate_sink_sql = true
enable_upsert = true
primary_keys = ["C_INT"]
}
}
```
Expand Down
27 changes: 22 additions & 5 deletions docs/en/connectors/sink/Kingbase.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import ChangeLog from '../changelog/connector-jdbc.md';

- [ ] [exactly-once](../../introduction/concepts/connector-v2-features.md)
- [ ] [cdc](../../introduction/concepts/connector-v2-features.md)
- [ ] [timer flush](../../introduction/concepts/connector-v2-features.md)
- [x] [timer flush](../../introduction/concepts/connector-v2-features.md)

## Description

Expand Down Expand Up @@ -58,9 +58,9 @@ import ChangeLog from '../changelog/connector-jdbc.md';

| Name | Type | Required | Default | Description |
|-------------------------------------------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| url | String | Yes | - | The URL of the JDBC connection. Refer to a case: jdbc:db2://127.0.0.1:50000/dbname |
| driver | String | Yes | - | The jdbc class name used to connect to the remote data source,<br/> if you use DB2 the value is `com.ibm.db2.jdbc.app.DB2Driver`. |
| username | String | No | - | Connection instance user name |
| url | String | Yes | - | The URL of the JDBC connection. Refer to a case: jdbc:kingbase8://localhost:54321/db_test |
| driver | String | Yes | - | The jdbc class name used to connect to the remote data source,<br/> if you use Kingbase the value is `com.kingbase8.Driver`. |
| username | String | No | - | Connection instance user name. The old key `user` is still accepted as a fallback. |
| password | String | No | - | Connection instance password |
| query | String | No | - | Use this sql write upstream input datas to database. e.g `INSERT ...`,`query` have the higher priority |
| database | String | No | - | Use this `database` and `table-name` auto-generate sql and receive upstream input datas write to database.<br/>This option is mutually exclusive with `query` and has a higher priority. |
Expand All @@ -69,6 +69,7 @@ import ChangeLog from '../changelog/connector-jdbc.md';
| connection_check_timeout_sec | Int | No | 30 | The time in seconds to wait for the database operation used to validate the connection to complete. |
| max_retries | Int | No | 0 | The number of retries to submit failed (executeBatch) |
| batch_size | Int | No | 1000 | For batch writing, when the number of buffered records reaches the number of `batch_size` or the time reaches `checkpoint.interval`<br/>, the data will be flushed into the database |
| batch_interval_ms | Long | No | 0 | Write-triggered flush interval in milliseconds. `0` disables interval flushing. When the value is greater than `0`, each write checks elapsed time and flushes synchronously if the interval has passed. |
| is_exactly_once | Boolean | No | false | Whether to enable exactly-once semantics, which will use Xa transactions. If on, you need to<br/>set `xa_data_source_class_name`. Kingbase currently does not support |
| generate_sink_sql | Boolean | No | false | Generate sql statements based on the database table you want to write to |
| xa_data_source_class_name | String | No | - | The xa data source class name of the database Driver，Kingbase currently does not support |
Expand Down Expand Up @@ -168,6 +169,22 @@ sink {
}
```

### Write To A Schema Table

> When writing with a custom `query`, the placeholder count must match the upstream fields. Kingbase schema-qualified tables can be written as `public.table_name`.

```
sink {
Jdbc {
driver = "com.kingbase8.Driver"
url = "jdbc:kingbase8://localhost:54321/test"
user = "SYSTEM"
password = "123456"
query = "INSERT INTO public.e2e_table_sink (c1, c2, c3) VALUES (?, ?, ?)"
}
}
```

## Changelog

<ChangeLog />
<ChangeLog />
Loading
Loading