python自动生成mysql数据库表结构设计文档

一、需求背景

需要提供Mysql数据库设计word文档，展示数据库表结构设计，类似如下图

二、分析

mysql的information_schema库中存放了库表数据信息，可以从中获取到需要的数据。

2.1 获取所有表和表的备注

SELECT
        TABLE_NAME,
        TABLE_COMMENT
    FROM
        information_schema.TABLES
    WHERE
        TABLE_SCHEMA = 'test_database_name'

其中test_database_name是待查询的数据库名称

2.2 获取表的字段说明

    SELECT
        COLUMN_NAME 列名,
        COLUMN_TYPE 数据类型,
        IS_NULLABLE 是否为空,
        COLUMN_DEFAULT 默认值,
        COLUMN_COMMENT 备注
    FROM
        INFORMATION_SCHEMA.COLUMNS
    WHERE
        table_schema = 'test_database_name'
        AND table_name = 'test_table_name'

其中test_database_name是待查询的数据库名称，test_table_name是待查询的数据表名称。
当然，desc命令也可以，自由发挥。

2.3 生成word文档

可以利用python的python-docx库来实现

三、实现

Python3代码如下：

# # coding=utf-8

import MySQLdb

from docx import Document

DATABASE_NAME_CMO = 'test_database_name'  # 库名
DATABASE_USER_CMO = 'test_user_name'  # 用户名
DATABASE_PASSWORD_CMO = 'test_password'  # 密码
DATABASE_HOST_CMO = '127.0.0.1'  # host
DATABASE_PORT_CMO = 3600  # port

def connect_mysql():
    db_config = dict(host=DATABASE_HOST_CMO, port=DATABASE_PORT_CMO, db=DATABASE_NAME_CMO, charset="utf8",
                     user=DATABASE_USER_CMO, passwd=DATABASE_PASSWORD_CMO)
    try:
        conn = MySQLdb.connect(**db_config)
    except Exception as err:
        raise err
    return conn


def get_all_table(_conn, _cursor) -> tuple:
    sql = """
    SELECT
        TABLE_NAME,
        TABLE_COMMENT
    FROM
        information_schema.TABLES
    WHERE
        TABLE_SCHEMA = '%s'""" % DATABASE_NAME_CMO
    try:
        _cursor.execute(sql)
        return _cursor.fetchall()
    except Exception as err:
        raise err


if __name__ == '__main__':
    conn = connect_mysql()
    cursor = conn.cursor()
    table_infos = get_all_table(conn, cursor)

    document = Document()
    document.add_paragraph()
    document.add_heading("数据库设计文档", 0)

    desc_sql = """
    SELECT
        COLUMN_NAME 列名,
        COLUMN_TYPE 数据类型,
        IS_NULLABLE 是否为空,
        COLUMN_DEFAULT 默认值,
        COLUMN_COMMENT 备注
    FROM
        INFORMATION_SCHEMA.COLUMNS
    WHERE
        table_schema = '%s'
        AND table_name = '%s'"""

    for i in range(len(table_infos)):
        if i == 10:
            break
        table_info = table_infos[i]
        try:

            cursor.execute(desc_sql % (DATABASE_NAME_CMO, table_info[0]))
            results = cursor.fetchall()

            document.add_heading(str(i + 1) + "、" + table_info[0], 1)
            document.add_heading(str(i + 1) + ".1 数据表说明", 2)
            document.add_paragraph(table_info[1])
            document.add_heading(str(i + 1) + ".2 字段说明", 2)

            table = document.add_table(rows=1, cols=5)

            table.style = "Table Grid"
            table.rows[0].cells[0].text = "字段名"
            table.rows[0].cells[1].text = "数据类型"
            table.rows[0].cells[2].text = "是否可为空"
            table.rows[0].cells[3].text = "默认值"
            table.rows[0].cells[4].text = "字段说明"

            for result in results:
                row_cells = table.add_row().cells
                row_cells[0].text = result[0] if result[0] else ""
                row_cells[1].text = result[1] if result[1] else ""
                row_cells[2].text = result[2] if result[2] else ""
                row_cells[3].text = result[3] if result[3] else ""
                row_cells[4].text = result[4] if result[4] else ""
        except Exception as err:
            raise err
    document.save("数据库设计文档.docx")

需要确保pip安装了python-docx和mysqlclient，没有安装的查一下怎么装。mysqlclient可能比较麻烦，需要安装一些依赖，不过总归是可以解决的。