mysql2uml README

这个扩展可以将mysql数据库结构生成uml类图。

它件扩展名为.dbuml的配置文件生成uml类图。

使用方法

*.dburml内容如下：

{
    "host": "localhost",
    "port": 3306,
    "user": "root",
    "password": "password",
    "database": "test",

}

options 可以选项,机构如下：

    "options": { 
        "tablePattern":"string", 
        "models":[
          {
            "name":"model1",
            "disableFields":false,
            "tables":["table1","table2"]
          }
        ]
    }

tablePattern 表名筛选条件,可选 disableFields 可选，屏蔽字段，默认为false models 模型定义,可选,按指定的模型生成多个uml类图

• 运行命令：

mysql2uml

• 在.dburml文件的编辑器中，使用右击菜单，mysql2uml

数据库结构约定

1. 主键字段名使用id，关联字段名使用{table_name}_id，例如：

CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) NOT NULL,
  `age` int(11) NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

CREATE TABLE `post` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `user_id` int(11) NOT NULL,
  `title` varchar(255) NOT NULL,
  `content` text NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

2. 如果关联字段名不是{table_name}_id，则需要在注释中指定。

CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  'code' varchar(255) NOT NULL COMMENT '用户编号',
  `name` varchar(255) NOT NULL,
  `age` int(11) NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

CREATE TABLE `post` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `user_code` int(11) NOT NULL COMMENT '关联用户{lk:user.code}',
  `title` varchar(255) NOT NULL,
  `content` text NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

注释中添加{lk:user.code}，表示关联字段名为user_code，关联表名为user。

关联字段注释规则

{lk:user.code,rel:1-0..n,title:关联名称}

• lk：关联字段名
• rel：关联关系，1-1，1-0..n，0..1-n，0..1-0..n
• title：关联名称

发布： https://dev.azure.com