设计 - 数据字典

article/2025/9/24 17:54:37

文档分类

写文档目的

你有没有遇到过开晨会、周会的时候某个问题已经讨论的很清晰。

但是几天后或者临近周末的时候再说这个问题的时候，团队中有的童鞋会说:“我不知道，没有说过这个问题或者这个方案”，因此而造成的BB事很伤神费心。

为了避免出现问题后的瞎 BB，特需要形成文字记录下来。

1)、好记忆不如烂笔头，我们讨论很好的方案，有时候只是灵光一闪，尽快记录下来会留住灵感。

2)、追根溯源。口头开会的时候，大家各抒己见，貌似已经讨论出方案。但实际每个人的理解各有不同，会后及时形成文档甚至图表，抄收给与会者，便于大家达成共识。

如:能清晰界定出责任、明细分工。

3)、真正写的时候，更便于梳理思路

如:需求文档会清晰定义每一个客户需求点和要求，是用户利益保障的前提，是甲方、乙方沟通的纽带和桥梁。如:会议纪要是大家会议讨论结果的总结，存在问题、责任人、解决方案明确的基石。如:变更需求的依据，原来需求怎么写的，为什么不满足，原因是什么？如何修改等。

文档的痛点

1)、认为不重视。程序员往往会感觉没必要，能技术实现就ok了，其他不重要。

2)、真心不想写。会形成恶性循环，这次不想写，下次、下下次还会如此。

3)、感觉没必要。感觉没有必要写，不知道为什么要写，不知道写什么？

文档的重要性

1)、研发开发根据，功能实现根据需求明细是开发技术实现的依据，验收时需求矩阵中的每一个点都要覆盖和完善。

2)、关乎项目的持续性。项目管理中有文档归档管理，规划、需求、设计等贯穿项目始终的流程中的所有文档都要归档。便于下一个版本或后续项目开展的很好的依据。新加入团队人员的第一手也是最重要参考文档。

3)、是为证据，便于追责项目中曾经出现过通过甲方、乙方的邮件作为证据对簿公堂的情况。

提示 : 以上部分概念行描述，摘自网友，具体来源不知，若有侵权，请联系

数据字典

1. 数据库 sql 语句 + wolds 文档

1. 数据字典执行语句数据源

SELECTCOLUMN_NAME 列名,COLUMN_TYPE 数据类型,DATA_TYPE 字段类型,CHARACTER_MAXIMUM_LENGTH 长度,IS_NULLABLE 是否为空,COLUMN_DEFAULT 默认值,COLUMN_COMMENT 备注 
FROMINFORMATION_SCHEMA.COLUMNS
where
-- developerclub为数据库名称，到时候只需要修改成你要导出表结构的数据库即可
table_schema ='iot_resource'
AND
-- article为表名，到时候换成你要导出的表的名称
-- 如果不写的话，默认会查询出所有表中的数据，这样可能就分不清到底哪些字段是哪张表中的了，所以还是建议写上要导出的名名称
table_name  = 'iot_field'

2. 数据字典 sql 语句优化 - ( 按需求配置 ) ( 经验版 )

SELECTCOLUMN_NAME 数据库字段,COLUMN_TYPE 类型,COLUMN_COMMENT 说明 
FROMINFORMATION_SCHEMA.COLUMNS
where
-- developerclub为数据库名称，到时候只需要修改成你要导出表结构的数据库即可
table_schema ='iot_resource'
AND
-- article为表名，到时候换成你要导出的表的名称
-- 如果不写的话，默认会查询出所有表中的数据，这样可能就分不清到底哪些字段是哪张表中的了，所以还是建议写上要导出的名名称
table_name  = 'iot_field'

3. 数据字段 - 进阶版 - ( 详细配置，自行选择 )

-- 使用 MySQL自带的 information_schema 数据库，它提供了访问数据库元数据的方式
USE information_schema;SELECTT.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 字段说明FROMCOLUMNS CINNER JOIN TABLES T ON C.TABLE_SCHEMA = T.TABLE_SCHEMAAND C.TABLE_NAME = T.TABLE_NAME-- 唯一需要输入部分:数据库
WHERE T.TABLE_SCHEMA = 'iot_emergency'

information_schema 数据库 - 简析

information_schema数据库是MySQL自带的，它提供了访问数据库元数据的方式。

什么是元数据呢？

元数据是关于数据的数据，如数据库名或表名，列的数据类型，或访问权限等。

有些时候用于表述该信息的其他术语包括“数据词典”和“系统目录”。

在MySQL中，把 information_schema 看作是一个数据库，确切说是信息数据库。

其中保存着关于MySQL服务器所维护的所有其他数据库的信息。如数据库名，数据库的表，表栏的数据类型与访问权限等。

在INFORMATION_SCHEMA中，有数个只读表。它们实际上是视图，而不是基本表，因此，你将无法看到与之相关的任何文件。

information_schema - 数据库表说明

SCHEMATA 表 : 提供了当前mysql实例中所有数据库的信息。是show databases的结果取之此表。

TABLES 表 : 提供了关于数据库中的表的信息(包括视图)。详细表述了某个表属于哪个schema，表类型，表引擎，创建时间等信息。是show tables from schemaname 的结果取之此表。

COLUMNS 表 : 提供了表中的列信息。详细表述了某张表的所有列以及每个列的信息。是show columns from schemaname.tablename的结果取之此表。

STATISTICS 表 : 提供了关于表索引的信息。是show index from schemaname.tablename的结果取之此表。

USER_PRIVILEGES(用户权限) 表 : 给出了关于全程权限的信息。该信息源自mysql.user授权表。是非标准表。

SCHEMA_PRIVILEGES(方案权限) 表 : 给出了关于方案(数据库)权限的信息。该信息来自mysql.db授权表。是非标准表。

TABLE_PRIVILEGES(表权限)表:给出了关于表权限的信息。该信息源自mysql.tables_priv授权表。是非标准表。

COLUMN_PRIVILEGES(列权限)表:给出了关于列权限的信息。该信息源自mysql.columns_priv授权表。是非标准表。

CHARACTER_SETS(字符集)表:提供了mysql实例可用字符集的信息。是SHOW CHARACTER SET结果集取之此表。

COLLATIONS表:提供了关于各字符集的对照信息。

COLLATION_CHARACTER_SET_APPLICABILITY表:指明了可用于校对的字符集。这些列等效于SHOW COLLATION的前两个显示字段。

TABLE_CONSTRAINTS表:描述了存在约束的表。以及表的约束类型。

KEY_COLUMN_USAGE表:描述了具有约束的键列。

ROUTINES表:提供了关于存储子程序(存储程序和函数)的信息。此时，ROUTINES表不包含自定义函数(UDF)。名为“mysql.proc name”的列指明了对应于INFORMATION_SCHEMA.ROUTINES表的mysql.proc表列。

VIEWS表:给出了关于数据库中的视图的信息。需要有show views权限，否则无法查看视图信息。

TRIGGERS表:提供了关于触发程序的信息。必须有super权限才能查看该表