mysql 数据库转 表结构文档

Share on facebook
Share on google
Share on twitter
Share on linkedin

前言:

经常通过navicat设计完成数据库后 需要倒出成 word文档;要包含表结构说明,用于和同事之间交流 以及设计文档的发布;

之前一直用的动软代码生成器的导出模块;由于这个软件不再维护了;有一些bug导致结果并不如人意;

于是自己写了一个 可以生成 html结构的数据库说明文档,由于浏览器的特性html table可以直接导入 语雀、confluence等协作平台中。

本模块 开发语言是c#,依赖平台是 .NETStandard 2.0 所以也是兼容 .net core的;

本模块托管在 nuget上 地址是:

https://www.nuget.org/packages/YTKDBDoc/

 

安装模块:

Install-Package YTKDBDoc -Version 1.0.0

 

使用说明:

///
/// 实例化
/// 
///输出文件路径(xxx.html)
///host
///用户名称
///用户密码
///数据库名称
///端口号
///字符集:默认 utf8
YTKDBDoc.Export2Html ytk = new Export2Html("1.html","192.168.1.114","root","password","db",3306);
Console.WriteLine(ytk.Export());

 

导出文档案例展示:

abpm_record:动态血压记录表

字段名
数据类型
默认值
允许非空
自动递增
备注
abpm_id varchar(32)   NO   动态血压ID
measure_time bigint(11)   YES   测量时间UTC
doc_id varchar(32)   NO   检查医生ID
dev_code varchar(32)   YES   设备编码
usr_name varchar(40)   NO   患者姓名
usr_gender int(11)   NO   性别
user_age double   NO   年龄(保留一位小数)
RelationCHOL int(11)   YES   总胆固醇数值关系
CHOL double   YES   总胆固醇
RelationHDLC int(11)   YES   高密度脂蛋白数值关系
HDLC double   YES   高密度脂蛋白
RelationTRIG int(11)   YES   甘油三酯数值关系
TRIG double   YES   甘油三酯
RelationLDLC int(11)   YES   低密度脂蛋白数值关系
LDLC double   YES   低密度脂蛋白
RelationTCHDL int(11)   YES   总胆固醇与高密度脂蛋白比值数值关系
TCHDL double   YES   总胆固醇与高密度脂蛋白比值
create_time bigint(20)   YES   创建时间
remark varchar(255)   YES   备注
is_deleted bit(1) b’0′ YES   是否删除

app_start:APP启动设置表

字段名
数据类型
默认值
允许非空
自动递增
备注
App_start_id int(11)   NO APP启动设置
App_updatetime bigint(11)   YES   更新时间
App_savetime bigint(11)   YES   保留周期
remark varchar(255)   YES   备注
is_deleted bit(1)   YES   是否删除