Mysql 快速生成数据字典

navicat查询mysql表结构并导出

Posted by Kay on May 21, 2020

程序员做项目开发时,往往会因为一些需求的变更,导致项目做到后期后,数据库表结构已经被改得面目全非,和早先项目设计的数据库表结构相差很大。由此往往需要重新修改项目文档,其中包括了数据库的字段设计表格(以下简称数据字典)。 因此,我们需要一些快捷的方式,来帮助我们生成新的数据字典。

使用工具:Navicat 数据库:mysql


查询原理:

在MySQL中,有个自带的数据库,名为information_schema。其中保存着关于MySQL服务器所维护的所有其他数据库的信息。如数据库名,数据库的表,表栏的数据类型与访问权 限等。我们通过查询这个数据库的COLUMNS表(此表提供了其他所有表中的列信息)信息,来获取我们需要的表结构信息,从而将其导出为数据字典。


实现案例:

  1. navicat 执行以下SQL的查询(如果需要其他字段,请参考下面COLUMNS表字段拓展):
    SELECT
     column_name AS '字段名',
     column_type AS '字段类型',
     ( CASE WHEN is_nullable = 'YES' THEN '是' ELSE '否' END ) AS '是否可空',
     ( CASE WHEN column_key = 'PRI' THEN '是' ELSE '否' END ) AS '是否主键',
     column_comment AS '注释' 
    FROM
     information_schema.COLUMNS 
    WHERE
     table_schema = '要查询的数据库名' 
     AND table_name = '要查询的数据表名';
    
  2. 通过navicat工具进行导出(如下图的按钮,之后自行选择要导出的内容); 导出方式

COLUMNS表字段拓展:

列名 描述
COLUMN_NAME 字段名
COLUMN_TYPE 字段类型
TABLE_CATALOG 表限定符。
IS_NULLABLE 列的为空性。如果列允许 NULL,那么该列返回 YES。否则,返回 NO。
COLUMN_KEY 字段主键
COLUMN_DEFAULT 默认值
COLUMN_COMMENT 注释
ORDINAL_POSITION 字段在表的顺序(从1开始)
TABLE_NAME 数据表名
TABLE_SCHEMA 数据库名
DATA_TYPE 数据类型
DATETIME_PRECISION datetime 及 SQL-92 interval 数据类型的子类型代码。对于其它数据类型,返回 NULL。
EXTRA 额外信息
GENERATION_EXPRESSION  
NUMERIC_PRECISION 近似数字数据、精确数字数据、整型数据或货币数据的精度。否则,返回 NULL。
NUMERIC_SCALE 近似数字数据、精确数字数据、整数数据或货币数据的小数位数。否则,返回 NULL。
PRIVILEGES  
CHARACTER_MAXIMUM_LENGTH 以字符为单位的最大长度,适于二进制数据、字符数据,或者文本和图像数据。否则,返回NULL。
CHARACTER_OCTET_LENGTH 以字节为单位的最大长度,适于二进制数据、字符数据,或者文本和图像数据。否则,返回 NULL。
CHARACTER_SET_NAME 如果该列是字符数据或 text数据类型,那么为字符集返回唯一的名称。否则,返回 NULL。
COLLATION_NAME 排序规则,如果列是字符数据或 text数据类型,那么为排序次序返回唯一的名称。否则,返回 NULL。

参考来源:

Dear丶小贱:MYSQL中information_schema简介 沐辰:INFORMATION_SCHEMA.COLUMNS-表的字段信息