如何使用Python从MySQL数据库导出表结构到Word文档

在开发和维护数据库的过程中，能够快速且准确地获取表结构信息是至关重要的。本文将向您展示一种简单而有效的方法，利用Python脚本从MySQL数据库中提取指定表的结构信息，并将其导出为格式化的Word文档。此方法不仅提高了工作效率，还确保了文档的一致性和准确性。

使用步骤：

第一步：安装必要的库

首先，你需要确保你的环境中安装了mysql-connector-python和python-docx这两个Python库。你可以通过以下命令来安装它们：

bash 复制代码

pip install mysql-connector-python python-docx

第二步：准备代码

复制以下Python代码，并保存为.py文件（例如export_table_structure.py）。

python 复制代码

import mysql.connector
from docx import Document

def get_table_structure_with_comments(host, port, user, password, database, table):
    try:
        cnx = mysql.connector.connect(
            user=user,
            port=port,
            password=password,
            host=host,
            database=database
        )
        cursor = cnx.cursor()

        # 获取表结构和字段信息（包含comment）
        columns_query = """
        SELECT 
            COLUMN_NAME, 
            COLUMN_TYPE, 
            IS_NULLABLE, 
            COLUMN_KEY, 
            COLUMN_DEFAULT, 
            EXTRA,
            COLUMN_COMMENT
        FROM information_schema.COLUMNS
        WHERE TABLE_SCHEMA = %s AND TABLE_NAME = %s
        ORDER BY ORDINAL_POSITION;
        """
        cursor.execute(columns_query, (database, table))
        columns_info = cursor.fetchall()

        # 获取表的comment
        table_comment_query = """
        SELECT TABLE_COMMENT
        FROM information_schema.TABLES
        WHERE TABLE_SCHEMA = %s AND TABLE_NAME = %s;
        """
        cursor.execute(table_comment_query, (database, table))
        table_comment = cursor.fetchone()[0]

        cursor.close()
        cnx.close()

        return table_comment, columns_info
    except mysql.connector.Error as err:
        print(f"Database Error: {err}")
        return None, None

def write_to_docx_with_comments(table_name, table_comment, columns_info, output_path):
    document = Document()
    # 表标题带注释
    document.add_heading(f'Table Structure for {table_name} ({table_comment})', level=1)
    document.add_heading('Columns Information', level=2)
    # 创建表格：
    table = document.add_table(rows=1, cols=6)
    hdr_cells = table.rows[0].cells
    hdr_cells[0].text = 'Field'
    hdr_cells[1].text = 'Type'
    hdr_cells[2].text = 'Null'
    hdr_cells[3].text = 'Key'
    hdr_cells[4].text = 'Default'
    #hdr_cells[5].text = 'Extra'
    hdr_cells[5].text = 'Comment'

    for column in columns_info:
        row_cells = table.add_row().cells
        row_cells[0].text = column[0] or ''
        row_cells[1].text = column[1] or ''
        row_cells[2].text = column[2] or ''
        row_cells[3].text = column[3] or ''
        row_cells[4].text = str(column[4]) if column[4] is not None else ''
        #row_cells[5].text = column[5] or ''
        row_cells[5].text = column[6] or ''

    document.save(output_path)


# 使用示例
if __name__ == '__main__':
    host = '127.0.0.1'
    port = 3306
    user = 'user'
    password = 'password'
    database = 'database'
    table = 'goods'
    output_path = './goods.docx'

    # 获取表注释和字段信息
    table_comment, columns_info = get_table_structure_with_comments(host, port, user, password, database, table)

    if table_comment and columns_info:
        write_to_docx_with_comments(table, table_comment, columns_info, output_path)
        print(f"文档已保存至：{output_path}")
    else:
        print("无法读取数据库表结构，请检查连接或表是否存在。")

第三步：配置数据库连接参数

在代码的末尾，找到如下部分，根据您的数据库实际信息修改这些变量值：

python 复制代码

host = '127.0.0.1'  # 数据库主机地址
port = 3306         # 端口号
user = 'user'       # 用户名
password = 'password'  # 密码
database = 'database'  # 数据库名
table = 'goods'     # 表名
output_path = './goods.docx'  # 输出文件路径

第四步：运行脚本

打开终端或命令提示符，导航至包含上述脚本的目录，然后运行该脚本：

bash 复制代码

python export_table_structure.py

如果一切设置正确，脚本将自动生成一个名为goods.docx的Word文档，其中包含了指定表的结构信息。

第五步：检查输出结果

打开生成的Word文档，检查内容是否符合预期。每个字段的信息都应清晰地列出，包括名称、数据类型、是否允许NULL、键信息、默认值以及注释等。

通过这种方式，您可以轻松地为数据库中的任何表创建详细的结构文档，这在项目交接、文档编写或是日常维护工作中都非常有用。希望这个小技巧能帮助您更高效地管理数据库资源！