Skip to content

Latest commit

 

History

History
210 lines (166 loc) · 19.4 KB

Mysql.md

File metadata and controls

210 lines (166 loc) · 19.4 KB
Raw

MySQL

JDBC Mysql Sink Connector

Support Mysql Version

  • 5.5/5.6/5.7/8.0

Support Those Engines

Spark
Flink
SeaTunnel Zeta

Description

Write data through jdbc. Support Batch mode and Streaming mode, support concurrent writing, support exactly-once semantics (using XA transaction guarantee).

Using Dependency

For Spark/Flink Engine

  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

Use Xa transactions to ensure exactly-once. So only support exactly-once for the database which is support Xa transactions. You can set is_exactly_once=true to enable it.

Supported DataSource Info

Datasource Supported Versions Driver Url Maven
Mysql Different dependency version has different driver class. com.mysql.cj.jdbc.Driver jdbc:mysql://localhost:3306:3306/test Download

Data Type Mapping

Mysql Data Type SeaTunnel 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 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

Sink Options

Name Type Required Default Description
url String Yes - The URL of the JDBC connection. Refer to a case: jdbc:mysql://localhost:3306:3306/test
driver String Yes - 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 No - Connection instance user name
password String No - Connection instance password
query String No - Use this sql write upstream input datas to database. e.g INSERT ...,query have the higher priority
database String No - 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.
table String No - 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_keys Array No - This option is used to support operations such as insert, delete, and update when automatically generate sql.
support_upsert_by_query_primary_key_exist Boolean No false Choose 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_sec Int No 30 The time in seconds to wait for the database operation used to validate the connection to complete.
max_retries Int No 0 The number of retries to submit failed (executeBatch)
batch_size Int No 1000 For 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
is_exactly_once Boolean No false Whether to enable exactly-once semantics, which will use Xa transactions. If on, you need to
set xa_data_source_class_name.
generate_sink_sql Boolean No false Generate sql statements based on the database table you want to write to
xa_data_source_class_name String No - The xa data source class name of the database Driver, for example, mysql is com.mysql.cj.jdbc.MysqlXADataSource, and
please refer to appendix for other data sources
max_commit_attempts Int No 3 The number of retries for transaction commit failures
transaction_timeout_sec Int No -1 The timeout after the transaction is opened, the default is -1 (never timeout). Note that setting the timeout may affect
exactly-once semantics
auto_commit Boolean No true Automatic transaction commit is enabled by default
field_ide String No - Identify whether the field needs to be converted when synchronizing from the source to the sink. ORIGINAL indicates no conversion is needed;UPPERCASE indicates conversion to uppercase;LOWERCASE indicates conversion to lowercase.
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 - Sink plugin common parameters, please refer to Sink Common Options for details
schema_save_mode Enum No CREATE_SCHEMA_WHEN_NOT_EXIST Before the synchronous task is turned on, different treatment schemes are selected for the existing surface structure of the target side.
data_save_mode Enum No APPEND_DATA Before the synchronous task is turned on, different processing schemes are selected for data existing data on the target side.
custom_sql String No - When data_save_mode selects CUSTOM_PROCESSING, you should fill in the CUSTOM_SQL parameter. This parameter usually fills in a SQL that can be executed. SQL will be executed before synchronization tasks.
enable_upsert Boolean No true Enable upsert by primary_keys exist, If the task only has insert, 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/category/source-v2
}

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:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&rewriteBatchedStatements=true"
        driver = "com.mysql.cj.jdbc.Driver"
        user = "root"
        password = "123456"
        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/category/sink-v2
}

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:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&rewriteBatchedStatements=true"
        driver = "com.mysql.cj.jdbc.Driver"
        user = "root"
        password = "123456"
        # Automatically generate sql statements based on database table names
        generate_sink_sql = true
        database = test
        table = test_table
    }
}

Exactly-once :

For accurate write scene we guarantee accurate once

sink {
    jdbc {
        url = "jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&rewriteBatchedStatements=true"
        driver = "com.mysql.cj.jdbc.Driver"
    
        max_retries = 0
        user = "root"
        password = "123456"
        query = "insert into test_table(name,age) values(?,?)"
    
        is_exactly_once = "true"
    
        xa_data_source_class_name = "com.mysql.cj.jdbc.MysqlXADataSource"
    }
}

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:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&rewriteBatchedStatements=true"
        driver = "com.mysql.cj.jdbc.Driver"
        user = "root"
        password = "123456"
        
        generate_sink_sql = true
        # You need to configure both database and table
        database = test
        table = sink_table
        primary_keys = ["id","name"]
        field_ide = UPPERCASE
        schema_save_mode = "CREATE_SCHEMA_WHEN_NOT_EXIST"
        data_save_mode="APPEND_DATA"
    }
}