SQL脚本生成数据字典

很多互联网创业型公司前期都不太规范，新人来了，没有太多的设计文档、需求文档，也没有ER图、数据字典这些东西。所以，熟悉业务需要不少时间，很多简单的问题（如数据表中状态值的含义）不得不问老员工，因为没有注释也没有数据字典。

问完之后，我一般会在测试库里边添加注释，不至于下次还要问。我每到一个新公司，都会整理出一个数据字典和ER图，一来方便自己，二来方便以后的新同事。

第一个公司使用的是SQL Server 2008数据库，生成数据字典比较麻烦，不好理解：

use YourDatabase  --指定要生成数据字典的数据库 go  SELECT   表名=case when a.colorder=1 then d.name else ‘‘ end,  表说明=case when a.colorder=1 then isnull(f.value,‘‘) else ‘‘ end, 字段序号=a.colorder,  字段名=a.name,  标识=case when COLUMNPROPERTY(a.id,a.name,‘IsIdentity‘)=1 then ‘√‘else ‘‘ end,  主键=case when exists(SELECT 1 FROM sysobjects where xtype=‘PK‘ and name in (   SELECT name FROM sysindexes WHERE indid in(    SELECT indid FROM sysindexkeys WHERE id = a.id AND colid=a.colid     ))) then ‘√‘ else ‘‘ end,  类型=b.name,  占用字节数=a.length,  长度=COLUMNPROPERTY(a.id,a.name,‘PRECISION‘),  小数位数=isnull(COLUMNPROPERTY(a.id,a.name,‘Scale‘),0),  允许空=case when a.isnullable=1 then ‘√‘else ‘‘ end,  默认值=isnull(e.text,‘‘),  字段说明=isnull(g.[value],‘‘)  FROM syscolumns a  left join systypes b on a.xtype=b.xusertype  inner join sysobjects d on a.id=d.id and d.xtype=‘U‘ and d.name<>‘dtproperties‘  left join syscomments e on a.cdefault=e.id  left join sys.extended_properties g on a.id=g.major_id and a.colid=g.minor_id  left join sys.extended_properties f on d.id=f.major_id and f.minor_id =0  --where d.name=‘要查询的表‘ --如果只查询指定表,加上此条件    order by a.id,a.colorder

第二个公司使用的是MySQL5.6，生成数据字典比较简单：

USE information_schema;

  SELECT     T.TABLE_SCHEMA AS ‘数据库名称‘,     T.TABLE_NAME AS ‘表名‘,     T.TABLE_TYPE AS ‘表类型‘,  

   T. ENGINE AS ‘数据库引擎‘,     C.ORDINAL_POSITION AS ‘字段编号‘,     C.COLUMN_NAME AS ‘字段名‘,   

  C.COLUMN_TYPE AS ‘数据类型‘,     C.IS_NULLABLE AS ‘允许为空‘,     C.COLUMN_KEY AS ‘键类型‘,  

   C.EXTRA AS ‘自增属性‘,     C.CHARACTER_SET_NAME AS ‘编码名称‘,     C.COLUMN_COMMENT AS ‘字段说明‘

 FROM     COLUMNS C INNER JOIN TABLES T ON C.TABLE_SCHEMA = T.TABLE_SCHEMA AND C.TABLE_NAME = T.TABLE_NAME 

WHERE     T.TABLE_SCHEMA = ‘mysql‘  --指定要生成数据字典的数据库

效果图如下：

数据字典.png

这两个脚本只是方便查看数据字典，你可以导出到Excel，也可以写个程序，连接到数据库，将这些信息生成HTML网页或者带有格式的Excel、Word等。我封装了一个jar包，只需要在配置文件中配置数据库地址、用户名和密码就可以用java命令直接生成.doc文档，很方便。