跳到主要内容
版本:2.3.8

OceanBase

JDBC OceanBase Sink Connector

Support Those Engines

Spark
Flink
SeaTunnel Zeta

Key Features

Description

Write data through jdbc. Support Batch mode and Streaming mode, support concurrent writing, support exactly-once semantics.

Supported DataSource Info

DatasourceSupported versionsDriverUrlMaven
OceanBaseAll OceanBase server versions.com.oceanbase.jdbc.Driverjdbc:oceanbase://localhost:2883/testDownload

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 oceanbase-client-xxx.jar $SEATNUNNEL_HOME/plugins/jdbc/lib/

Data Type Mapping

Mysql Mode

Mysql Data typeSeaTunnel Data type
BIT(1)
INT UNSIGNED
BOOLEAN
TINYINT
TINYINT UNSIGNED
SMALLINT
SMALLINT UNSIGNED
MEDIUMINT
MEDIUMINT UNSIGNED
INT
INTEGER
YEAR
INT
INT UNSIGNED
INTEGER UNSIGNED
BIGINT
BIGINT
BIGINT UNSIGNEDDECIMAL(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 UNSIGNEDDECIMAL((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
DATEDATE
TIMETIME
DATETIME
TIMESTAMP
TIMESTAMP
TINYBLOB
MEDIUMBLOB
BLOB
LONGBLOB
BINARY
VARBINAR
BIT(n)
BYTES
GEOMETRY
UNKNOWN
Not supported yet

Oracle Mode

Oracle Data typeSeaTunnel Data type
Number(p), p <= 9INT
Number(p), p <= 18BIGINT
Number(p), p > 18DECIMAL(38,18)
REAL
BINARY_FLOAT
FLOAT
BINARY_DOUBLEDOUBLE
CHAR
NCHAR
NVARCHAR2
NCLOB
CLOB
ROWID
STRING
DATEDATE
TIMESTAMP
TIMESTAMP WITH LOCAL TIME ZONE
TIMESTAMP
BLOB
RAW
LONG RAW
BFILE
BYTES
UNKNOWNNot supported yet

Sink Options

NameTypeRequiredDefaultDescription
urlStringYes-The URL of the JDBC connection. Refer to a case: jdbc:oceanbase://localhost:2883/test
driverStringYes-The jdbc class name used to connect to the remote data source, should be com.oceanbase.jdbc.Driver.
userStringNo-Connection instance user name
passwordStringNo-Connection instance password
queryStringNo-Use this sql write upstream input datas to database. e.g INSERT ...,query have the higher priority
compatible_modeStringYes-The compatible mode of OceanBase, can be 'mysql' or 'oracle'.
databaseStringNo-Use this database and table-name auto-generate sql and receive upstream input datas write to database.
This option is mutually exclusive with query and has a higher priority.
tableStringNo-Use database and this table-name auto-generate sql and receive upstream input datas write to database.
This option is mutually exclusive with query and has a higher priority.
primary_keysArrayNo-This option is used to support operations such as insert, delete, and update when automatically generate sql.
support_upsert_by_query_primary_key_existBooleanNofalseChoose to use INSERT sql, UPDATE sql to process update events(INSERT, UPDATE_AFTER) based on query primary key exists. This configuration is only used when database unsupport upsert syntax. Note: that this method has low performance
connection_check_timeout_secIntNo30The time in seconds to wait for the database operation used to validate the connection to complete.
max_retriesIntNo0The number of retries to submit failed (executeBatch)
batch_sizeIntNo1000For batch writing, when the number of buffered records reaches the number of batch_size or the time reaches checkpoint.interval
, the data will be flushed into the database
generate_sink_sqlBooleanNofalseGenerate sql statements based on the database table you want to write to
max_commit_attemptsIntNo3The number of retries for transaction commit failures
transaction_timeout_secIntNo-1The timeout after the transaction is opened, the default is -1 (never timeout). Note that setting the timeout may affect
exactly-once semantics
auto_commitBooleanNotrueAutomatic transaction commit is enabled by default
propertiesMapNo-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-optionsNo-Sink plugin common parameters, please refer to Sink Common Options for details
enable_upsertBooleanNotrueEnable upsert by primary_keys exist, If the task has no key duplicate data, setting this parameter to false can speed up data import

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 defines a SeaTunnel synchronization task that automatically generates data through FakeSource and sends it to JDBC Sink. FakeSource generates a total of 16 rows of data (row.num=16), with each row having two fields, name (string type) and age (int type). The final target table is test_table will also be 16 rows of data in the table. Before run this job, you need create database test and table test_table in your mysql. And if you have not yet installed and deployed SeaTunnel, you need to follow the instructions in Install SeaTunnel to install and deploy SeaTunnel. And then follow the instructions in Quick Start With SeaTunnel Engine to run this job.

# Defining the runtime environment
env {
parallelism = 1
job.mode = "BATCH"
}

source {
# This is a example source plugin **only for test and demonstrate the feature source plugin**
FakeSource {
parallelism = 1
result_table_name = "fake"
row.num = 16
schema = {
fields {
name = "string"
age = "int"
}
}
}
# If you would like to get more information about how to configure seatunnel and see full list of source plugins,
# please go to https://seatunnel.apache.org/docs/connector-v2/source
}

transform {
# If you would like to get more information about how to configure seatunnel and see full list of transform plugins,
# please go to https://seatunnel.apache.org/docs/category/transform-v2
}

sink {
jdbc {
url = "jdbc:oceanbase://localhost:2883/test"
driver = "com.oceanbase.jdbc.Driver"
user = "root"
password = "123456"
compatible_mode = "mysql"
query = "insert into test_table(name,age) values(?,?)"
}
# If you would like to get more information about how to configure seatunnel and see full list of sink plugins,
# please go to https://seatunnel.apache.org/docs/connector-v2/sink
}

Generate Sink SQL

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:oceanbase://localhost:2883/test"
driver = "com.oceanbase.jdbc.Driver"
user = "root"
password = "123456"
compatible_mode = "mysql"
# Automatically generate sql statements based on database table names
generate_sink_sql = true
database = test
table = test_table
}
}

CDC(Change Data Capture) Event

CDC change data is also supported by us In this case, you need config database, table and primary_keys.

sink {
jdbc {
url = "jdbc:oceanbase://localhost:3306/test"
driver = "com.oceanbase.jdbc.Driver"
user = "root"
password = "123456"
compatible_mode = "mysql"
generate_sink_sql = true
# You need to configure both database and table
database = test
table = sink_table
primary_keys = ["id","name"]
}
}