tg-mysql-design

MySQL数据库设计助手。根据业务规则文档和存量SQL DDL脚本,设计符合阿里巴巴规范的MySQL 5.7/8.0建表语句。当用户提到"数据库设计"、"建表语句"、"DDL"、"表结构设计"、"CREATE TABLE"等关键词时触发。支持读取业务规则文档(.md文件)、SQL脚本(.sql文件),输出遵循阿里...

安装

概览

tg-mysql-design 是一款专为 MySQL 数据库设计打造的智能助手工具,旨在帮助开发者快速生成符合阿里巴巴集团规范的建表语句(DDL)。该工具深度集成于开发流程中,当用户提及“数据库设计”、“建表语句”、“CREATE TABLE”等关键词时自动触发响应。其核心能力在于结合业务规则文档与存量 SQL 脚本进行智能解析,输出结构清晰、规范严谨的 MySQL 5.7/8.0 兼容建表语句。通过自动化处理命名规范、字段类型选择、主键索引配置及审计字段添加等环节,显著提升数据库设计的效率与一致性,避免人为疏漏。 该工具严格遵循阿里系数据库设计最佳实践,涵盖从需求分析到最终 SQL 脚本输出的完整工作流。首先,它通过读取 Markdown 格式的业务规则文档或现有 .sql 文件,精准提取实体关系、字段定义与约束条件;随后依据内置规范体系完成表结构设计,包括采用小写下划线命名法、合理选用 VARCHAR/DECIMAL/DATETIME 等数据类型、设置 UUID 主键与逻辑删除字段等。最终生成的 DDL 不仅语法正确,还包含详尽注释、字符集 utf8mb4 配置及 InnoDB 引擎指定,确保可直接用于生产环境部署。 此外,tg-mysql-design 充分考虑实际工程中的兼容性、性能与安全需求。例如支持 MySQL 5.7 与 8.0 双版本适配,避免使用高版本特有功能;强调索引优化策略如区分度评估与最左前缀原则;同时建议敏感数据加密与软删除机制以增强系统健壮性。整体而言,这是一款面向中大型项目、致力于标准化与工业化数据库建设的实用型 AI 辅助工具。

核心功能特点

  1. 基于业务规则文档和存量 SQL 脚本自动生成符合阿里巴巴规范的 MySQL DDL 建表语句
  2. 严格遵循命名规范:表名采用模块_业务含义格式,字段名小写下划线,禁用保留关键字
  3. 智能推荐数据类型:主键用 VARCHAR(32),金额用 DECIMAL(M,2),时间用 DATETIME,状态用 TINYINT 或 CHAR(2)
  4. 自动添加标准审计字段:create_time、update_time、create_by、update_by 和 deleted 逻辑删除标识
  5. 支持主键与多类索引设计:主键必设,唯一键加 uk_ 前缀,高频查询字段建立 idx_ 索引
  6. 输出完整的 CREATE TABLE 语句,包含 utf8mb4 字符集、InnoDB 引擎及详细字段注释

适用场景

tg-mysql-design 特别适用于需要快速构建标准化数据库结构的开发场景。在新项目开发初期,当产品经理提供详细的业务规则文档(通常为 .md 文件)时,开发者可通过上传该文档,由工具自动识别合同编号、客户 ID、状态枚举等业务要素,并一键生成结构完整的销售合同表或采购订单表。这种方式不仅大幅缩短了从零开始设计表结构的时间,还能确保所有字段命名、类型选择和约束条件均符合团队统一规范,降低后期维护成本。 对于已有部分历史表结构的系统升级或重构项目,该工具同样表现出色。它能读取现有的 .sql 脚本文件,分析原有设计中的冗余字段或潜在问题,并在新设计中保持必要的兼容性。例如,在整合多个子系统时,可借助其判断是否需要保留旧表的外键关联,或如何优雅地引入新的审计字段而不破坏既有应用逻辑。这种兼顾继承与创新的能力,使其成为数据库迁移与微服务拆分过程中的得力助手。 此外,在团队协作频繁、对数据库规范要求严格的金融、电商或 SaaS 平台项目中,tg-mysql-design 可作为标准化流程的一部分强制执行设计准则。无论是初创公司制定初始数据模型,还是大型企业推进内部工具链统一,该工具都能有效减少因个人习惯差异导致的设计偏差,提升全团队交付质量。尤其适合那些希望将数据库设计从经验驱动转变为规则驱动的组织,实现更高效、更安全的数据架构演进。