StarRocks migration tool(SMT)
StarRocks migration tool(简称 SMT)是一个命令行工具,用于生成通过 Flink 将源数据库的数据导入 StarRocks 所需的 SQL。其主要有两个功能:
- 根据源数据库和目标 StarRocks 集群的信息,生成 StarRocks 建表语句。
- 生成 Flink 的 SQL 客户端 可执行的 SQL 语句,以提交同步数据的 Flink job,简化链路中全量或增量数据同步流程。
当前 SMT 支持的源数据库如下:
| 源数据库 | 表结构同步 | 全量同步 | 增量同步 |
|---|---|---|---|
| MySQL | 支持 | 支持 | 支持 |
| PostgreSQL | 支持 | 支持 | 支持 |
| Oracle | 支持 | 支持 | 支持 |
| Hive | 支持 | 支持 | 不支持 |
| ClickHouse | 支持 | 支持 | 不支 持 |
| SQL Server | 支持 | 支持 | 支持 |
| TiDB | 支持 | 支持 | 支持 |
下载链接:https://cdn-thirdparty.starrocks.com/smt.tar.gz?r=2
SMT 的作用与限制
SMT 只负责生成 SQL 文件,生成后即退出。它读取源数据库中的表定义,并在 result 目录下生成两类文件:
starrocks-create.*.sql:CREATE TABLE 语句,需要您在 StarRocks 中执行。flink-create.*.sql:定义 source table 和 sink table 并提交INSERT INTO ... SELECT作业的 Flink SQL,需要您在 Flink SQL 客户端中执行。
SMT 不会启动、运行或连接 Flink,也不会迁移任何数据。您仍然需要安装并运行 Flink 集群,并为其配置源数据库对应的 Flink CDC connector 和 StarRocks Flink connector,然后自行执行生成的文件。
不使用 SMT 同步数据
SMT 不是必需的。您也可以:
- 使用 Flink CDC pipeline。Pipeline 通过一个 YAML 文件定义,会自动创建 StarRocks 表并执行同步。参见 从 PostgreSQL 实时同步;对于 MySQL,参见 Flink CDC 文档中的 Streaming ELT from MySQL to StarRocks。
- 自行创建 StarRocks 表,并使用 StarRocks Flink connector 作为 sink 编写 Flink SQL。该方式适用于 Flink 能够读取的任何数据源。
SMT 使用步骤
通常分成三步:
- 配置 conf/config_prod.conf 文件。
- 执行 starrocks-migration-tool。
- 运行结果默认生成在 result 目录中。
然后就可以执行 result 中的 SQL 脚本来进行元数据或者数据的同步了。
SMT 配置
-
[db]段为数据源的连接信息,根据 type 不同配置对应数据源的连接信息即可。 -
[other]段为一些其他配置,建议修改be_num为实际的个数即可。 -
flink.starrocks.sink.*是 flink-connector-starrocks 的配置信息,参考配置项说明即可。 -
[table-rule.1]是数据源 table 匹配规则,可以根据正则表达式匹配数据库和表名生成建表的 SQL,也可以配置多个规则。每个规则都会生成对应的结果,例如:[table-rule.1]->result/starrocks-create.1.sql[table-rule.2]->result/starrocks-create.2.sql
如果有多组规则,需要给每一组规则匹配 database,table 和 flink-connector-starrocks 的配置。
[table-rule.1]
# pattern to match databases for setting properties
database = ^ database1.*$
# pattern to match tables for setting properties
table = ^.*$
schema = ^.*$
############################################
### flink sink configurations
### DO NOT set `connector`, `table-name`, `database-name`, they are auto-generated
############################################
flink.starrocks.jdbc-url=jdbc:mysql://192.168.1.1:9030
flink.starrocks.load-url= 192.168.1.1:8030
flink.starrocks.username=root
flink.starrocks.password=
flink.starrocks.sink.max-retries=10
flink.starrocks.sink.buffer-flush.interval-ms=15000
flink.starrocks.sink.properties.format=json
flink.starrocks.sink.properties.strip_outer_array=true
[table-rule.2]
# pattern to match databases for setting properties
database = ^database2.*$
# pattern to match tables for setting properties
table = ^.*$
schema = ^.*$
############################################
### flink sink configurations
### DO NOT set `connector`, `table-name`, `database-name`, they are auto-generated
############################################
flink.starrocks.jdbc-url=jdbc:mysql://192.168.1.1:9030
flink.starrocks.load-url= 192.168.1.1:8030
flink.starrocks.username=root
flink.starrocks.password=
flink.starrocks.sink.max-retries=10
flink.starrocks.sink.buffer-flush.interval-ms=15000
flink.starrocks.sink.properties.format=json
flink.starrocks.sink.properties.strip_outer_array=true -
针对分库分表的大表可以单独配置一个规则,比如:有两个数据库 edu_db_1,edu_db_2,每个数据库下面分别有 course_1,course_2 两张表,并且所有表的数据结构都是相同的,通过如下配置把他们导入 StarRocks 的一张表中进行分析。
[table-rule.3]
# pattern to match databases for setting properties
database = ^edu_db_[0-9]*$
# pattern to match tables for setting properties
table = ^course_[0-9]*$
schema = ^.*$这样会自动生成一个多对一的导入关系,在 StarRocks 默认生成的表名是
course__auto_shard,也可以自行在生成的配置文件中修改。
同步 MySQL 到 StarRocks
简介
通过 Flink CDC connector 和 SMT 可以实现 MySQL 数据的秒级同步。

如图所示,SMT 可以根据 MySQL 和 StarRocks 的集群信息和表结构自动生成 source table 和 sink table 的建表语句。
通过 Flink CDC connector 消费 MySQL 的 Binlog,经过 Flink-connector-starrocks 写入 StarRocks。
操作步骤
| 依赖 | 安装包名 | 下载链接 |
|---|---|---|
| Flink | flink-x.x.x-bin-scala_2.12.tgz | 点此下载 |
| Flink CDC connector | flink-sql-connector-mysql-cdc-x.x.x.jar | 点此下载 |
| Flink-connector-starrocks | flink-connector-starrocks-x.x.x_flink-x.x.jar | 点此下载 |
| SMT | smt.tar.gz | 点此下载 |
-
下载 Flink,最低支持版本 1.11。
-
下载 Flink CDC connector,请注意下载对应 Flink 版本的 flink-sql-connector-mysql-cdc-xxx.jar。
-
复制
flink-sql-connector-mysql-cdc-xxx.jar,flink-connector-starrocks-xxx.jar到flink-xxx/lib/ -
下载 smt.tar.gz
-
解压并修改配置文件。
[db]
host = 192.168.1.1
port = 3306
user = root
password =
type = mysql
[other]
# number of backends in StarRocks
be_num = 3
# `decimal_v3` is supported since StarRocks-1.18.1
use_decimal_v3 = false
# directory to save the converted DDL SQL
output_dir = ./result
[table-rule.1]
# pattern to match databases for setting properties
database = ^db$
# pattern to match tables for setting properties
table = ^table$
schema = ^.*$
############################################
### flink sink configurations
### DO NOT set `connector`, `table-name`, `database-name`, they are auto-generated
############################################
flink.starrocks.jdbc-url=jdbc:mysql://192.168.1.1:9030
flink.starrocks.load-url= 192.168.1.1:8030
flink.starrocks.username=root
flink.starrocks.password=
flink.starrocks.sink.max-retries=10
flink.starrocks.sink.buffer-flush.interval-ms=15000
flink.starrocks.sink.properties.format=json
flink.starrocks.sink.properties.strip_outer_array=true -
执行 starrocks-migrate-tool,所有建表语句都生成在 result 目录下。
$./starrocks-migrate-tool
$ls result
flink-create.1.sql smt.tar.gz starrocks-create.all.sql
flink-create.all.sql starrocks-create.1.sql starrocks-external-create.all.sql -
生成 StarRocks 的表结构。
mysql -hxx.xx.xx.x -P9030 -uroot -p < starrocks-create.all.sql -
生成 Flink table 并开始同步。
bin/sql-client.sh embedded < flink-create.all.sql这个执行以后同步任务会持续执行。
-
观察任务状况
bin/flink list如果有任务请查看 log 日志,或者调整 conf 中的系统配置中内存和 slot。
注意事项
-
如何开启 MySQL binlog?
-
修改/etc/my.cnf
#开启binlog日志
log-bin=/var/lib/mysql/mysql-bin
#log_bin=ON
##binlog日志的基本文件名
#log_bin_basename=/var/lib/mysql/mysql-bin
##binlog文件的索引文件,管理所有binlog文件
#log_bin_index=/var/lib/mysql/mysql-bin.index
#配置serverid
server-id=1
binlog_format = row -
重启 mysqld,然后可以通过
SHOW VARIABLES LIKE 'log_bin';确认是否已经打开。
-
同步 PostgreSQL 到 StarRocks
使用 Flink CDC 3.5 或更高版本时,Flink CDC pipeline 无需 SMT 即可将 PostgreSQL 同步到 StarRocks,并会自动创建 StarRocks 表。详细步骤请参见 从 PostgreSQL 实时同步。
简介
通过 Flink CDC connector 和 SMT 可以实现 PostgreSQL 数据的秒级同步。
SMT 可以根据 PostgreSQL 和 StarRocks 的集群信息和表结构自动生成 source table 和 sink table 的建表语句。
通过 Flink CDC connector 消费 PostgreSQL 的 WAL,经过 Flink-connector-starrocks 写入 StarRocks。