数据库表结构导出工具【人生的第一个开源工具】

数据库表结构导出工具

如今我努力奔跑，不过是为了追上那个曾经被寄予厚望的自己 —— 约翰。利文斯顿

本工具是一个用于将数据库表结构导出到 Word 文档的实用工具。它能够连接到指定的数据库，提取数据库中所有表的结构信息，并将这些信息以专业的方式整理并保存到一个易于阅读和分享的文档中。

功能特点

• 数据库连接验证：提供了测试连接功能，确保用户输入的数据库连接信息准确无误，确保成功连接到目标数据库。
• 数据结构导出：能够自动从数据库中提取所有表的结构信息，包括表名称、字段名称、数据类型和字段注释等，并将其整理到一个规范的 Word 文档中。
• 用户友好界面：采用直观清晰的用户界面设计，使用户可以轻松输入数据库连接信息和文件保存路径，并通过简单的按钮操作完成数据结构导出。

使用方法

1. 克隆本仓库到本地计算机：

   git clone https://gitee.com/wanghui1201/Data-Dictionary-Export-utils.git
   

2. 安装依赖：

   pip install sqlalchemy docx
   

3. 运行主程序：

   python App.py
   

4. 在打开的界面中，输入数据库的连接信息和文件存储路径，然后点击 “测试连接” 按钮检查连接是否成功。如果连接成功，点击 “导出文档” 按钮即可导出数据库中所有表的结构信息到 Word 文档中。

核心源码

# 数据库连接
def get_table_fields(ip, database, username, password):
    try:
        # 构建数据库连接字符串
        db_url = f"mysql://{username}:{password}@{ip}/{database}?charset=utf8mb4"
        # 创建数据库引擎
        engine = create_engine(db_url)
        # 创建元数据对象
        metadata = MetaData(bind=engine)
        # 反射表结构
        metadata.reflect()
        # 获取所有的表结构
        tables = metadata.tables
        return tables
    except Exception as e:
        return str(e)
        
# 获取所有的表对象
def get_all_table_structure(tables):
    # 定义所有表的结构信息字典
    all_tables_info = {}
    # 遍历所有表，获取所有表的结构
    for table_name, table in tables.items():
        table_info = []
        for column in table.columns:
            field_info = {
                "name": column.name,
                "type": str(column.type),
                "comment": column.comment if hasattr(column, 'comment') else None
            }
            table_info.append(field_info)
        all_tables_info[table_name] = table_info
    return all_tables_info

程序界面

产品测试

注意事项

• 确保已经正确安装了 Python 3 环境。
• 确保输入的数据库连接信息正确，包括 IP 地址、数据库名称、用户名和密码。
• 导出的 Word 文档将保存在指定的文件存储路径中，文件名为 “数据结构.docx”。

通过本工具，您可以轻松快速地了解和分享数据库中的表结构信息，为团队协作和数据库管理提供便利。欢迎使用并提出宝贵意见和建议，让我们不断改进和完善本工具。