跳到主要内容
版本：Next

TiDB CDC

TiDB CDC模式的连接器

支持的引擎​

SeaTunnel Zeta
Flink

主要功能​

描述​

TiDB-CDC连接器允许从 TiDB 数据库读取快照数据和增量数据。本文将介绍如何设置 TiDB-CDC 连接器，在 TiDB 数据库中对数据进行快照和捕获流事件。

支持的数据源信息​

数据源支持的版本驱动Maven
MySQL
  • MySQL: 5.5, 5.6, 5.7, 8.0.x
  • RDS MySQL: 5.6, 5.7, 8.0.x
    		• com.mysql.cj.jdbc.Driverhttps://mvnrepository.com/artifact/mysql/mysql-connector-java/8.0.28
    tikv-client-java3.2.0-https://mvnrepository.com/artifact/org.tikv/tikv-client-java/3.2.0

    依赖​

    安装驱动​

    1. 你需要确保 jdbc 驱动 jar 包 和 tikv-client-java jar 包 已经放在目录 ${SEATUNNEL_HOME}/plugins/。

    在 SeaTunnel Zeta 引擎下​

    1. 你需要确保 jdbc 驱动 jar 包 和 tikv-client-java jar 包 已经放在目录 ${SEATUNNEL_HOME}/lib/ 。

    请下载 MySQL 驱动和 tikv-java-client，并按所使用引擎的要求放到对应目录。

    数据类型映射​

    Mysql 数据类型SeaTunnel 数据类型
    BIT(1)
    TINYINT(1)    		BOOLEAN
    TINYINTTINYINT
    TINYINT UNSIGNED
    SMALLINT    		SMALLINT
    SMALLINT UNSIGNED
    MEDIUMINT
    MEDIUMINT UNSIGNED
    INT
    INTEGER
    YEAR    		INT
    INT UNSIGNED
    INTEGER UNSIGNED
    BIGINT    		BIGINT
    BIGINT UNSIGNEDDECIMAL(20,0)
    DECIMAL(p, s)
    DECIMAL(p, s) UNSIGNED
    NUMERIC(p, s)
    NUMERIC(p, s) UNSIGNED    		DECIMAL(p,s)
    FLOAT
    FLOAT UNSIGNED    		FLOAT
    DOUBLE
    DOUBLE UNSIGNED
    REAL
    REAL UNSIGNED    		DOUBLE
    CHAR
    VARCHAR
    TINYTEXT
    MEDIUMTEXT
    TEXT
    LONGTEXT
    ENUM
    JSON
    ENUM    		STRING
    DATEDATE
    TIME(s)TIME(s)
    DATETIME
    TIMESTAMP(s)    		TIMESTAMP(s)
    BINARY
    VARBINAR
    BIT(p)
    TINYBLOB
    MEDIUMBLOB
    BLOB
    LONGBLOB
    GEOMETRY    		BYTES

    源选项​

    名称类型必需默认描述
    urlString是-JDBC 连接的 URL，例如：jdbc:mysql://tidb0:4000/inventory。
    usernameString是-连接数据库服务器时使用的用户名。
    passwordString是-连接数据库服务器时使用的密码。
    pd-addressesString是-TiKV 集群的 PD 地址。
    database-nameString是-要监控的数据库名称。
    table-nameString是-要监控的表名，属于 database-name 指定的数据库。这里不要再包含数据库名。
    startup.modeEnum否INITIALTiDB CDC 消费器的可选启动模式，可选值有 initial、earliest 和 latest。
    initial：启动时同步历史数据，然后同步增量数据。
    earliest：从最早的可用偏移量开始启动。
    latest：从最新的偏移量开始启动，并跳过初始快照。
    batch-size-per-scanInt否1000每次扫描的大小。
    tikv.grpc.timeout_in_msLong否-TiKV GRPC 超时时间（毫秒）。
    tikv.grpc.scan_timeout_in_msLong否-TiKV GRPC 扫描超时时间（毫秒）。
    tikv.batch_get_concurrencyInteger否-TiKV GRPC 批量获取并发度。
    tikv.batch_scan_concurrencyInteger否-TiKV GRPC 批量扫描并发度。

    任务示例​

    简单示例​

    env {
      parallelism = 1
      job.mode = "STREAMING"
      checkpoint.interval = 5000
    }

    source {
      TiDB-CDC {
        plugin_output = "products_tidb_cdc"
        url = "jdbc:mysql://tidb0:4000/tidb_cdc"
        driver = "com.mysql.cj.jdbc.Driver"
        tikv.grpc.timeout_in_ms = 20000
        pd-addresses = "pd0:2379"
        username = "root"
        password = ""
        database-name = "tidb_cdc"
        table-name = "tidb_cdc_e2e_source_table"
      }
    }

    transform {
    }

    sink {
      jdbc {
        plugin_input = "products_tidb_cdc"
        url = "jdbc:mysql://tidb0:4000/tidb_cdc"
        driver = "com.mysql.cj.jdbc.Driver"
        username = "root"
        password = ""
        database = "tidb_cdc"
        table = "tidb_cdc_e2e_sink_table"
        generate_sink_sql = true
        primary_keys = ["id"]
      }
    }

    从最新位置启动​

    如果只需要读取新的变更、不需要同步历史快照，可以使用 startup.mode = "latest"。

    source {
      TiDB-CDC {
        url = "jdbc:mysql://tidb0:4000/tidb_cdc"
        driver = "com.mysql.cj.jdbc.Driver"
        pd-addresses = "pd0:2379"
        username = "root"
        password = ""
        database-name = "tidb_cdc"
        table-name = "tidb_cdc_e2e_source_table"
        startup.mode = "latest"
      }
    }

    注意事项​

    • TiDB CDC 每个 source 块读取一张表；如果一个任务要读取多张表，请配置多个 TiDB-CDC source 块。
    • startup.mode = "specific" 不是 TiDB CDC 的有效配置值，请使用 initial、earliest 或 latest。
    • 只有默认 TiKV 客户端设置不能满足集群需求时，才需要调整 tikv.grpc.* 和 tikv.batch_*_concurrency 参数。

    变更日志​