JDBC Vertica Source Connector

Description

Read external data source data through JDBC.

Support Those Engines

Spark
Flink
SeaTunnel Zeta

Using Dependency

  1. You need to ensure that the jdbc driver jar package has been placed in directory ${SEATUNNEL_HOME}/plugins/.

For SeaTunnel Zeta Engine

  1. You need to ensure that the jdbc driver jar package has been placed in directory ${SEATUNNEL_HOME}/lib/.

Key Features

supports query SQL and can achieve projection effect.

Supported DataSource Info

Datasource Supported versions Driver Url Maven
Vertica Different dependency version has different driver class. com.vertica.jdbc.Driver jdbc:vertica://localhost:5433/vertica Download

Data Type Mapping

Vertical Data Type SeaTunnel Data Type
BIT BOOLEAN
TINYINT
TINYINT UNSIGNED
SMALLINT
SMALLINT UNSIGNED
MEDIUMINT
MEDIUMINT UNSIGNED
INT
INTEGER
YEAR		 INT
INT UNSIGNED
INTEGER UNSIGNED
BIGINT		 LONG
BIGINT UNSIGNED DECIMAL(20,0)
DECIMAL(x,y)(Get the designated column’s specified column size.<38) DECIMAL(x,y)
DECIMAL(x,y)(Get the designated column’s specified column size.>38) DECIMAL(38,18)
DECIMAL UNSIGNED DECIMAL((Get the designated column’s specified column size)+1,
(Gets the designated column’s number of digits to right of the decimal point.)))
FLOAT
FLOAT UNSIGNED		 FLOAT
DOUBLE
DOUBLE UNSIGNED		 DOUBLE
CHAR
VARCHAR
TINYTEXT
MEDIUMTEXT
TEXT
LONGTEXT
JSON		 STRING
DATE DATE
TIME TIME
DATETIME
TIMESTAMP		 TIMESTAMP
TINYBLOB
MEDIUMBLOB
BLOB
LONGBLOB
BINARY
VARBINAR
BIT(n)		 BYTES
GEOMETRY
UNKNOWN		 Not supported yet

Source Options

Name Type Required Default Description
url String Yes - The URL of the JDBC connection. Refer to a case: jdbc:vertica://localhost:5433/vertica
driver String Yes - The jdbc class name used to connect to the remote data source,
if you use Vertica the value is com.vertica.jdbc.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,Only support numeric type primary key, and only can config one 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 toimprove performance by
reducing the number database hits required to satisfy the selection criteria.
Zero means use jdbc default value.
properties Map No - Additional connection configuration parameters,when properties and URL have the same parameters, the priority is determined by the
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 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:

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.

  1. # Defining the runtime environment
  2. env {
  3.   parallelism = 2
  4.   job.mode = "BATCH"
  5. }
  6. source{
  7.     Jdbc {
  8.         url = "jdbc:vertica://localhost:5433/vertica"
  9.         driver = "com.vertica.jdbc.Driver"
  10.         connection_check_timeout_sec = 100
  11.         user = "root"
  12.         password = "123456"
  13.         query = "select * from type_bin limit 16"
  14.     }
  15. }
  17. transform {
  18.     # If you would like to get more information about how to configure seatunnel and see full list of transform plugins,
  19.     # please go to https://seatunnel.apache.org/docs/transform-v2/sql
  20. }
  22. sink {
  23.     Console {}
  24. }

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.         url = "jdbc:vertica://localhost:5433/vertica"
  4.         driver = "com.vertica.jdbc.Driver"
  5.         connection_check_timeout_sec = 100
  6.         user = "root"
  7.         password = "123456"
  8.         # Define query logic as required
  9.         query = "select * from type_bin"
  10.         # Parallel sharding reads fields
  11.         partition_column = "id"
  12.         # Number of fragments
  13.         partition_num = 10
  14.     }
  15. }

Parallel Boundary:

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

  1. source {
  2.     Jdbc {
  3.         url = "jdbc:vertica://localhost:5433/vertica"
  4.         driver = "com.vertica.jdbc.Driver"
  5.         connection_check_timeout_sec = 100
  6.         user = "root"
  7.         password = "123456"
  8.         # Define query logic as required
  9.         query = "select * from type_bin"
  10.         partition_column = "id"
  11.         # Read start boundary
  12.         partition_lower_bound = 1
  13.         # Read end boundary
  14.         partition_upper_bound = 500
  15.         partition_num = 10
  16.     }
  17. }