check.md

结构校验

结构迁移后，您可使用两种校验方式。一种是我们自带的，一种是第三方 liquibase。本文档主要介绍前者。

示例: MySQL -> MySQL

参考 任务模版

校验结果

以源端结构为基准，校验结果包括 miss，diff，extra（目标多出）以及 summary 等部分，均以 JSON 的方式呈现。

miss.log, diff.log, extra.log 均采用相同的 JSON 结构 (StructCheckLog)：

{
  "key": "type.schema.table", // 例如: table.db_name.tb_name 或 index.db.tb.idx
  "src_sql": "CREATE TABLE `table_name` (id INT PRIMARY KEY)",  // 在 miss/diff 中出现
  "dst_sql": "CREATE TABLE `table_name` (id INT PRIMARY KEY)"   // 在 diff/extra 中出现
}

• miss.log (源端存在但目标端缺失)

{"key":"table.struct_check_test_1.not_match_miss","src_sql":"CREATE TABLE IF NOT EXISTS `not_match_miss` (`id` int NOT NULL PRIMARY KEY)"}
{"key":"index.struct_check_test_1.not_match_index.i6_miss","src_sql":"CREATE INDEX `i6_miss` ON `not_match_index` (`col6`)"}

• diff.log (两端都存在但不一致；同一行包含 src_sql 和 dst_sql)

{"key":"index.struct_check_test_1.not_match_index","src_sql":"ALTER TABLE `not_match_index` ADD INDEX `idx_v1` (`col1`)","dst_sql":"ALTER TABLE `not_match_index` ADD INDEX `idx_v2` (`col1`)"}
{"key":"table.struct_check_test_1.not_match_column","src_sql":"CREATE TABLE `not_match_column` (`id` int)","dst_sql":"CREATE TABLE `not_match_column` (`id` bigint)"}

• extra.log (目标端多出)

{"key":"index.struct_check_test_1.not_match_index.i5_diff_name_dst","dst_sql":"CREATE INDEX `i5_diff_name_dst` ON `not_match_index` (`col5`)"}

• summary.log (校验结果概览)

{"start_time": "2023-10-01T10:00:00+08:00", "end_time": "2023-10-01T10:00:05+08:00", "is_consistent": false, "miss_count": 8, "diff_count": 5, "extra_count": 1, "sql_count": 14}

• sql.log (当配置 output_revise_sql = true 时生成)

CREATE TABLE IF NOT EXISTS `not_match_miss` (`id` int NOT NULL PRIMARY KEY);