Python 实现 MySQL Schema 同步

前言

在日常的工作中,经常会遇到不同环境之间同步表结构的需求,特别是在生产与测试环境之间,在长时间的运行后,总会有不一致的情况。数据库表结构变更的正常流程是在测试环境验证之后,通过工单的形式在生产环境上执行,但生产环境经常会遇到索引的修改,紧急修改字段长度等操作,这些操作很多时候并没有在测试环境中执行,久而久之就造成了环境之间表结构的不一致。

SchemaObject

SchemaObject 是一个将 MySQL Schema 转换成 Python 对象的一个工具包,方便了后面的 Schema 对比。下面是 SchemaObject 大概的一个类图:

未命名文件.png

SchemaObject 将数据库中的 table, colume, index 等变成了一个 Python 类,每个类都有 create drop modify 方法,这些方法都能产生当前数据库类型的 SQL 语句。比如,TableSchema 类的 create 方法就能生成表的建表语句。这样通过比对就能快速地生成同步 Schema 的 SQL 语句了。

另外注意下 SchemaObject 依赖 PyMySQL,如果是使用的是 Python3 的版本,需要修改下源码中 connection.py 中 72 行 :

# Python2
if sys.version_info < (3, 0):
    if isinstance(values, (basestring, unicode)):
        values = (values,)
else:
    # Python3
    if isinstance(values, (str, bytes)):
        values = (values,)

比对 Schema

获取信息

在比对 Schema 之前,需要先获取不同类型的 Scheme 信息,虽然 SchemaObject 工具包都将这些 Schema 信息的采集方法封装好了,我们还是来看下它是如何获取这些信息的:

  • database option 信息通过 information_schema.SCHEMATA 表获取

    SELECT
      SCHEMA_NAME,
      DEFAULT_CHARACTER_SET_NAME,
      DEFAULT_COLLATION_NAME
    FROM information_schema.SCHEMATA
    
  • table 信息通过 information_schema.TABLES 表获取

    SELECT TABLE_NAME, ENGINE, ROW_FORMAT, AUTO_INCREMENT,
                        CREATE_OPTIONS, TABLE_COLLATION, TABLE_COMMENT, TABLE_SCHEMA
                FROM information_schema.`TABLES`
    WHERE TABLE_SCHEMA='<TABLENAME>'
    AND not isnull(ENGINE)
    
  • column 信息通过 information_schema.COLUMNS 表获取

    SELECT
      TABLE_NAME,
      COLUMN_NAME,
      ORDINAL_POSITION,
      COLUMN_DEFAULT,
      IS_NULLABLE,
      COLUMN_TYPE,
      COLUMN_KEY,
      CHARACTER_MAXIMUM_LENGTH,
      CHARACTER_SET_NAME,
      COLLATION_NAME,
      EXTRA,
      COLUMN_COMMENT,
      TABLE_SCHEMA,
      TABLE_NAME
    FROM information_schema.COLUMNS
    WHERE TABLE_SCHEMA = '<TABLENAME>'
    AND TABLE_NAME = 'core_account'
    ORDER BY ORDINAL_POSITION;
    
  • 索引信息获取

    SHOW INDEXES FROM `<DATABASE>`.`<TABLE>`;
    
  • 外键约束信息获取

    SELECT
      K.CONSTRAINT_NAME,
      K.TABLE_SCHEMA,
      K.TABLE_NAME,
      K.COLUMN_NAME,
      K.REFERENCED_TABLE_SCHEMA,
      K.REFERENCED_TABLE_NAME,
      K.REFERENCED_COLUMN_NAME,
      K.POSITION_IN_UNIQUE_CONSTRAINT
    FROM information_schema.KEY_COLUMN_USAGE K,
         information_schema.TABLE_CONSTRAINTS T
    WHERE K.CONSTRAINT_NAME = T.CONSTRAINT_NAME
    AND T.CONSTRAINT_TYPE = 'FOREIGN KEY'
    AND K.CONSTRAINT_SCHEMA = '<DATABASE>'
    AND K.TABLE_NAME = '<TABLE>'
    AND K.REFERENCED_TABLE_NAME IS NOT NULL
    
    # 获取 FK 的 update rule, delete rule
    SELECT
      UPDATE_RULE,
      DELETE_RULE
    FROM information_schema.REFERENTIAL_CONSTRAINTS
    WHERE CONSTRAINT_SCHEMA = '<DATABASE>'
    AND TABLE_NAME = '<TABLE>'
    AND CONSTRAINT_NAME = '<FK_NAME>'
    

对比表

当原库中表不在目标库中存在,【新建表】:

for s_t in from_tables:
    if s_t not in target_tables:
        # Generate Create Table SQL, 调用 SchemaObject.TableSchema create 方法生成建表语句
        s_t.create()

当目标库中表不在原库中存在,【删除表】:

for t_t in target_tables:
    if t_t not in from_tables:
        # Generate Drop Table SQL, 调用 SchemaObject.TableSchema drop 方法生成删表语句
        t_t.drop()

对比字段

当原表中的字段不在目标表中存在,【新建字段】:

for s_col in from_cols:
    if s_col not in target_cols:
        # Generate Add Col SQL, 调用 SchemaObject.ColumnSchema create 方法生成新增字段语句
        s_col.create()

当目标表中的字段不在原表中存在,【删除字段】:

for t_col in target_cols:
    if t_col not in from_cols:
        # Generate Drop Col SQL, 调用 SchemaObject.ColumnSchema drop 方法生成删除字段语句
        t_col.drop()

当原表中的字段在目标表中存在,但字段类型不同,【修改字段】:

for idx, s_col in enumerate(from_cols):
    if s_col in to_cols and s_col != to_cols[s_col]:
        # Generate Modify Col SQL, 调用 SchemaObject.ColumnSchema modify 方法生成修改字段语句
        s_col.modify()

对比 Index FK

对比索引,FK 跟对比字段的流程一样,不同的是在 Drop Index 之前需要先执行 create, modify, drop FK 的操作,不然 Drop Index 会出现外键约束。

小结

根据上诉这些对比,就能生成一个 Schema 同步的 SQL 语句。同时 SchemaObject 的作者也写了一个 SchemaSync 包来实现了上诉的对比,生成 同步 SQL 的过程。更多的详情可看 SchemaSync 的源码获取。

注意,SchemaSync 同样不支持 Python3,笔者对 SchemaSync 进行了修改,支持了 Python3,同时能直接将 SQL 在目标库中执行,请见:https://github.com/hctech/mysql-schema-sync

参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,757评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,478评论 1 289
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,540评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,593评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,903评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,329评论 1 210
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,659评论 2 309
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,383评论 0 195
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,055评论 1 238
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,337评论 2 241
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,864评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,227评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,820评论 3 231
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,999评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,750评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,365评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,260评论 2 258

推荐阅读更多精彩内容