mysql数据库说明文档生成方法

数据库建好了,表字段的说明文档是必不可少的。虽然数据库备注里面都写清楚了表和字段的作用,但是作为规范管理和方便后期维护,这个文档还是需要的,至少要保证一个项目的资料的完整性才行。

而编写文档这种事情其实是很头痛的,技术含量不高,还很繁琐,不注意还容易出错,作为想偷懒又想把事情做好的我来说,当然最希望的是交给别人做…emmmmm,当然这是不太现实的事情,那么就想不手动做,让软件去生成。

偷懒的事情往往都会想到一起去,正好有个叫叶正盛的大神就做了这样一款软件,可以根据mysql表和字段的备注自动生成数据库说明文档,当然,还有字段名称、类型、长度等信息,这款软件叫做DBExportDoc V1.0 For MySQL,软件基于word+vba,那么使用Window和Office套装就是必须的了(mac上测试无法使用,wps使用宏有障碍…)。

使用前需要安装一些工具

  1. mysql odbc 5.x(一定要用5.x,8.x试过了无法安装),odbc下载地址
  2. vc2013或者vc2015(玩window这些不该常备吗)。

配置数据源

  1. 进入控制面板->所有控制面板项->管理工具,找到并打开数据源(ODBC)
  2. 添加MySQL ODBC 5.3 Unicode Driver,配置数据库连接。

图1 配置数据库连接

连接数据并使用软件

  1. 打开DBExportDoc V1.0 For MySQL.doc,允许宏。
  2. 点击连接数据库,点击新建连接,选择Microsoft OLE DB Provider for ODBC Drivers,再选择之前配置的数据,确定后点击连接。
  3. 按照DBExportDoc V1.0 For MySQL 使用手册.doc开心的使用吧。

图2 选择odbc drivers

图3 选择配置的数据源

生成文档的一些问题

需要注意的是,当id字段为int类型时,生成的长度默认显示为10,0,其实不算太对,int应该是11位才对,所以建议把这个改为11。

其他补充说明

关于int类型位数的解释,int范围是-(2^31) ~ (2^31)-1,算下来是-2147483648 ~ 2147483647,数字部分的确是10位,但是不要忘了int有正负的,如果是正数那么前面的+省略了,而负数则不能省略-,这样子最大就是11位了。

而生成的长度为10,0其实也不算错,数字部分是10位,int是整形,精度部分为0也是可以理解的了。

另外,如果字段设置了ZEROFILL属性,那么字段值前面会补0,正数也会补充为11位了。