Skip to main content
Version: 2.3.3

JDBC

JDBC source connector

Description​

Read external data source data through JDBC.

tip

Warn: for license compliance, you have to provide database driver yourself, copy to $SEATNUNNEL_HOME/lib/ directory in order to make them work.

e.g. If you use MySQL, should download and copy mysql-connector-java-xxx.jar to $SEATNUNNEL_HOME/lib/. For Spark/Flink, you should also copy it to $SPARK_HOME/jars/ or $FLINK_HOME/lib/.

Key features​

supports query SQL and can achieve projection effect.

Options​

nametyperequireddefault value
urlStringYes-
driverStringYes-
userStringNo-
passwordStringNo-
queryStringYes-
compatible_modeStringNo-
connection_check_timeout_secIntNo30
partition_columnStringNo-
partition_upper_boundLongNo-
partition_lower_boundLongNo-
partition_numIntNojob parallelism
fetch_sizeIntNo0
common-optionsNo-

driver [string]​

The jdbc class name used to connect to the remote data source, if you use MySQL the value is com.mysql.cj.jdbc.Driver.

user [string]​

userName

password [string]​

password

url [string]​

The URL of the JDBC connection. Refer to a case: jdbc:postgresql://localhost/test

query [string]​

Query statement

compatible_mode [string]​

The compatible mode of database, required when the database supports multiple compatible modes. For example, when using OceanBase database, you need to set it to 'mysql' or 'oracle'.

connection_check_timeout_sec [int]​

The time in seconds to wait for the database operation used to validate the connection to complete.

partition_column [string]​

The column name for parallelism's partition, only support numeric type.

partition_upper_bound [BigDecimal]​

The partition_column max value for scan, if not set SeaTunnel will query database get max value.

partition_lower_bound [BigDecimal]​

The partition_column min value for scan, if not set SeaTunnel will query database get min value.

partition_num [int]​

The number of partition count, only support positive integer. default value is job parallelism

fetch_size [int]​

For queries that return a large number of objects, you can configure the row fetch size used in the query to improve performance by reducing the number database hits required to satisfy the selection criteria. Zero means use jdbc default value.

common options​

Source plugin common parameters, please refer to Source Common Options for details.

tips​

If partition_column is not set, it will run in single concurrency, and if partition_column is set, it will be executed in parallel according to the concurrency of tasks.

appendix​

there are some reference value for params above.

datasourcedriverurlmaven
mysqlcom.mysql.cj.jdbc.Driverjdbc:mysql://localhost:3306/testhttps://mvnrepository.com/artifact/mysql/mysql-connector-java
postgresqlorg.postgresql.Driverjdbc:postgresql://localhost:5432/postgreshttps://mvnrepository.com/artifact/org.postgresql/postgresql
dmdm.jdbc.driver.DmDriverjdbc:dm://localhost:5236https://mvnrepository.com/artifact/com.dameng/DmJdbcDriver18
phoenixorg.apache.phoenix.queryserver.client.Driverjdbc:phoenix:thin:url=http://localhost:8765;serialization=PROTOBUFhttps://mvnrepository.com/artifact/com.aliyun.phoenix/ali-phoenix-shaded-thin-client
sqlservercom.microsoft.sqlserver.jdbc.SQLServerDriverjdbc:sqlserver://localhost:1433https://mvnrepository.com/artifact/com.microsoft.sqlserver/mssql-jdbc
oracleoracle.jdbc.OracleDriverjdbc:oracle:thin:@localhost:1521/xepdb1https://mvnrepository.com/artifact/com.oracle.database.jdbc/ojdbc8
sqliteorg.sqlite.JDBCjdbc:sqlite:test.dbhttps://mvnrepository.com/artifact/org.xerial/sqlite-jdbc
gbase8acom.gbase.jdbc.Driverjdbc:gbase://e2e_gbase8aDb:5258/testhttps://www.gbase8.cn/wp-content/uploads/2020/10/gbase-connector-java-8.3.81.53-build55.5.7-bin_min_mix.jar
starrockscom.mysql.cj.jdbc.Driverjdbc:mysql://localhost:3306/testhttps://mvnrepository.com/artifact/mysql/mysql-connector-java
db2com.ibm.db2.jcc.DB2Driverjdbc:db2://localhost:50000/testdbhttps://mvnrepository.com/artifact/com.ibm.db2.jcc/db2jcc/db2jcc4
tablestorecom.alicloud.openservices.tablestore.jdbc.OTSDriver"jdbc:ots:http s://myinstance.cn-hangzhou.ots.aliyuncs.com/myinstance"https://mvnrepository.com/artifact/com.aliyun.openservices/tablestore-jdbc
saphanacom.sap.db.jdbc.Driverjdbc:sap://localhost:39015https://mvnrepository.com/artifact/com.sap.cloud.db.jdbc/ngdbc
doriscom.mysql.cj.jdbc.Driverjdbc:mysql://localhost:3306/testhttps://mvnrepository.com/artifact/mysql/mysql-connector-java
teradatacom.teradata.jdbc.TeraDriverjdbc:teradata://localhost/DBS_PORT=1025,DATABASE=testhttps://mvnrepository.com/artifact/com.teradata.jdbc/terajdbc
Snowflakenet.snowflake.client.jdbc.SnowflakeDriverjdbc❄️//<account_name>.snowflakecomputing.comhttps://mvnrepository.com/artifact/net.snowflake/snowflake-jdbc
Redshiftcom.amazon.redshift.jdbc42.Driverjdbc:redshift://localhost:5439/testdb?defaultRowFetchSize=1000https://mvnrepository.com/artifact/com.amazon.redshift/redshift-jdbc42
Verticacom.vertica.jdbc.Driverjdbc:vertica://localhost:5433https://repo1.maven.org/maven2/com/vertica/jdbc/vertica-jdbc/12.0.3-0/vertica-jdbc-12.0.3-0.jar
OceanBasecom.oceanbase.jdbc.Driverjdbc:oceanbase://localhost:2881https://repo1.maven.org/maven2/com/oceanbase/oceanbase-client/2.4.3/oceanbase-client-2.4.3.jar

Example​

simple:

Jdbc {
url = "jdbc:mysql://localhost/test?serverTimezone=GMT%2b8"
driver = "com.mysql.cj.jdbc.Driver"
connection_check_timeout_sec = 100
user = "root"
password = "123456"
query = "select * from type_bin"
}

parallel:

Jdbc {
url = "jdbc:mysql://localhost/test?serverTimezone=GMT%2b8"
driver = "com.mysql.cj.jdbc.Driver"
connection_check_timeout_sec = 100
user = "root"
password = "123456"
query = "select * from type_bin"
partition_column = "id"
partition_num = 10
}

Changelog​

2.2.0-beta 2022-09-26​

  • Add ClickHouse Source Connector

2.3.0-beta 2022-10-20​

  • [Feature] Support Phoenix JDBC Source (2499)
  • [Feature] Support SQL Server JDBC Source (2646)
  • [Feature] Support Oracle JDBC Source (2550)
  • [Feature] Support StarRocks JDBC Source (3060)
  • [Feature] Support GBase8a JDBC Source (3026)
  • [Feature] Support DB2 JDBC Source (2410)

next version​

  • [BugFix] Fix jdbc split bug (3220)
  • [Feature] Support Sqlite JDBC Source (3089)
  • [Feature] Support Tablestore Source (3309)
  • [Feature] Support Teradata JDBC Source (3362)
  • [Feature] Support JDBC Fetch Size Config (3478)
  • [Feature] Support Doris JDBC Source (3586)
  • [Feature] Support Redshift JDBC Sink(#3615)
  • [BugFix] Fix jdbc connection reset bug (3670)
  • [Improve] Add Vertica connector(#4303)