JDBC Kingbase Source Connector

Support Connector Version

  • 8.6

Support Those Engines

Spark
Flink
SeaTunnel Zeta

Key Features

Description

Read external data source data through JDBC.

Supported DataSource Info

Datasource Supported versions Driver Url Maven
Kingbase 8.6 com.kingbase8.Driver jdbc:kingbase8://localhost:54321/db_test Download

Database Dependency

Please download the support list corresponding to ‘Maven’ and copy it to the ‘$SEATNUNNEL_HOME/plugins/jdbc/lib/‘ working directory
For example: cp kingbase8-8.6.0.jar $SEATNUNNEL_HOME/plugins/jdbc/lib/

Data Type Mapping

Kingbase Data type SeaTunnel Data type
BOOL BOOLEAN
INT2 SHORT
SMALLSERIAL
SERIAL
INT4		 INT
INT8
BIGSERIAL		 BIGINT
FLOAT4 FLOAT
FLOAT8 DOUBLE
NUMERIC DECIMAL((Get the designated column’s specified column size),
(Gets the designated column’s number of digits to right of the decimal point.)))
BPCHAR
CHARACTER
VARCHAR
TEXT		 STRING
TIMESTAMP LOCALDATETIME
TIME LOCALTIME
DATE LOCALDATE
Other data type Not supported yet

Source Options

Name Type Required Default Description
url String Yes - The URL of the JDBC connection. Refer to a case: jdbc:kingbase8://localhost:54321/test
driver String Yes - The jdbc class name used to connect to the remote data source, should be com.kingbase8.Driver.
user String No - Connection instance user name
password String No - Connection instance password
query String Yes - Query statement
connection_check_timeout_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 column and string type column.
partition_lower_bound BigDecimal No - The partition_column min value for scan, if not set SeaTunnel will query database get min value.
partition_upper_bound 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
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 No - 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.

Task Example

Simple:

  1. env {
  2.   parallelism = 2
  3.   job.mode = "BATCH"
  4. }
  6. source {
  7.   Jdbc {
  8.     driver = "com.kingbase8.Driver"
  9.     url = "jdbc:kingbase8://localhost:54321/db_test"
  10.     user = "root"
  11.     password = ""
  12.     query = "select * from source"
  13.   }
  14. }
  16. transform {
  17.     # If you would like to get more information about how to configure seatunnel and see full list of transform plugins,
  18.     # please go to https://seatunnel.apache.org/docs/transform/sql
  19. }
  21. sink {
  22.     Console {}
  23. }

Parallel:

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

  1. source {
  2.   Jdbc {
  3.     driver = "com.kingbase8.Driver"
  4.     url = "jdbc:kingbase8://localhost:54321/db_test"
  5.     user = "root"
  6.     password = ""
  7.     query = "select * from source"
  8.     # Parallel sharding reads fields
  9.     partition_column = "id"
  10.     # Number of fragments
  11.     partition_num = 10
  12.   }
  13. }

Parallel Boundary:

It is more efficient to read your data source according to the upper and lower boundaries you configured

  1. source {
  2.   Jdbc {
  3.     driver = "com.kingbase8.Driver"
  4.     url = "jdbc:kingbase8://localhost:54321/db_test"
  5.     user = "root"
  6.     password = ""
  7.     query = "select * from source"
  8.     partition_column = "id"
  9.     partition_num = 10
  10.     # Read start boundary
  11.     partition_lower_bound = 1
  12.     # Read end boundary
  13.     partition_upper_bound = 500
  14.   }
  15. }