Project: SeaTunnel (App Definition and Development / Streaming & Messaging)
File: DB2.md

JDBC DB2 Source Connector Spark<br/> Flink<br/> SeaTunnel Zeta<br/> Read external data source data through JDBC. You need to ensure that the has been placed in directory `${SEATUNNEL_HOME}/plugins/`. You need to ensure that the has been placed in directory `${SEATUNNEL_HOME}/lib/`. supports query SQL and can achieve projection effect. | 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 | | Please download the support list corresponding to 'Maven' and copy it to the '$SEATNUNNEL_HOME/plugins/jdbc/lib/' working directory<br/> For example DB2 datasource: cp db2-connector-java-xxx.jar $SEATNUNNEL_HOME/plugins/jdbc/lib/ | DB2 Data Type | SeaTunnel Data Type | |||| | BOOLEAN | BOOLEAN | | SMALLINT | SHORT | | INT<br/>INTEGER<br/> | INTEGER | | BIGINT | LONG | | DECIMAL<br/>DEC<br/>NUMERIC<br/>NUM | DECIMAL(38,18) | | REAL | FLOAT | | FLOAT<br/>DOUBLE<br/>DOUBLE PRECISION<br/>DECFLOAT | DOUBLE | | CHAR<br/>VARCHAR<br/>LONG VARCHAR<br/>CLOB<br/>GRAPHIC<br/>VARGRAPHIC<br/>LONG VARGRAPHIC<br/>DBCLOB | STRING | | BLOB | BYTES | | DATE | DATE | | TIME | TIME | | TIMESTAMP | TIMESTAMP | | ROWID<br/>XML | Not supported yet | | 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`. | | user | String | No | - | Connection instance user name | | password | String | No | - | Connection instance password | | query | String | Yes | - | Query statement | | connectionchecktimeout_sec | Int | No | 30 | The time in seconds to wait for the database operation used to validate the connection to complete | | partition_column | String | No | - | The column name for parallelism's partition, only support numeric type,Only support numeric type primary key, and only can config one column. | | partitionlowerbound | BigDecimal | No | - | The partition_column min value for scan, if not set SeaTunnel will query database get min value. | | partitionupperbound | BigDecimal | No | - | The partition_column max value for scan, if not set SeaTunnel will query database get max value. | | partition_num | Int | No | job parallelism | The number of partition count, only support positive integer. default value is job parallelism | | fetch_size | Int | No | 0 | For queries that return a large number of objects,you can configure<br/> the row fetch size used in the query toimprove performance by<br/> reducing the number database hits required to satisfy the selection criteria.<br/> Zero means use jdbc 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 | - | Source plugin common parameters, please refer to for details | If partitioncolumn is not set, it will run in single concurrency, and if partitioncolumn is set, it will be executed in parallel according to the concurrency of tasks. This example queries type_bin 'table' 16 data in your test "database" in single parallel and queries all of its fields. You can also specify which fields to query for final output to the console. ``` env { parallelism = 2 job.mode = "BATCH" } source{ Jdbc { url = "jdbc:db2://127.0.0.1:50000/dbname" driver = "com.ibm.db2.jdbc.app.DB2Driver" connectionchecktimeout_sec = 100 user = "root" password = "123456" query = "select * from table_xxx" } } transform { } sink { Console {} } ``` Read your query table in parallel with the shard field you configured and the shard data You can do this if you want to read the whole table ``` source { Jdbc { url = "jdbc:db2://127.0.0.1:50000/dbname" driver = "com.ibm.db2.jdbc.app.DB2Driver" connectionchecktimeout_sec = 100 user = "root" password = "123456" query = "select * from type_bin" partition_column = "id" partition_num = 10 } } ``` It is more efficient to specify the data within the upper and lower bounds of the query It is more efficient to read your data source according to the upper and lower boundaries you configured ``` source { Jdbc { url = "jdbc:db2://127.0.0.1:50000/dbname" driver = "com.ibm.db2.jdbc.app.DB2Driver" connectionchecktimeout_sec = 100 user = "root" password = "123456" query = "select * from type_bin" partition_column = "id" partitionlowerbound = 1 partitionupperbound = 500 partition_num = 10 } } ``` able in your DB2. And if you have not yet installed and deployed SeaTunnel, you need to follow the instructions in to install and deploy SeaTunnel. And then follow the instructions in to run this job. ``` env { parallelism = 1 job.mode = "BATCH" } source { FakeSource { parallelism = 1 resulttablename = "fake" row.num = 16 schema = { fields { name = "string" age = "int" } } } } transform { } sink { jdbc { url = "jdbc:db2://127.0.0.1:50000/dbname" driver = "com.ibm.db2.jdbc.app.DB2Driver" user = "root" password = "123456" query = "insert into test_table(name,age) values(?,?)" } } ``` This example not need to write complex sql statements, you can configure the database name table name to automatically generate add statements for you ``` sink { jdbc { url = "jdbc:db2://127.0.0.1:50000/dbname" driver = "com.ibm.db2.jdbc.app.DB2Driver" user = "root" password = "123456" generatesinksql = true database = test table = test_table } } ``` For accurate write scene we guarantee accurate once ``` sink { jdbc { url = "jdbc:db2://127.0.0.1:50000/dbname" driver = "com.ibm.db2.jdbc.app.DB2Driver" max_retries = 0 user = "root" password = "123456" query = "insert into test_table(name,age) values(?,?)" isexactlyonce = "true" xadatasourceclassname = "com.db2.cj.jdbc.Db2XADataSource" } } ```