数据字典模版

朱雀 2022-04-15 05:05 200阅读 0赞

一个好的团队，工作之中应该有各种各样的模版，对应数据库设计也是一样，数据库字典是你对整个系统从各个环节的思考的细化。现在都实行敏捷开发，数据字典不于过重，所以最近工作之中自己设计了一个简易的数据字典模版。

>  
> 
>  
> 
> # **                                                                  XXXX3.2版本数据字典** #
> 
>  
> 
>  
> 
>  
> 
> ## **                                                                                            设计说明书** ##
> 
>  
> 
>  
> 
> ## **                                                                                版本：                1.0               ** ##
> 
> ## **                                                                                作者：           芭蕉扇            ** ##
> 
> ## **                                                                                日期：       2018-11-21      ** ##
> 
>  
> 
>  
> 
>  
> 
>  
> 
>  
> 
>

>  
> 
> # **                                                                                  目录** #
> 
>  
> 
>  
> 
> ##                               ** 1. 数据结构** ##
> 
> ### **                                 ** 1.1 帮助中心分类表（xx\_help\_class） ------------------------------1 ###
> 
> ### **                           **       1.2 帮助中心文章表（xx\_help\_article）-----------------------------1 ###
> 
> ## **                              2.附录** ##
> 
> ### **                                 ** 表名规范-----------------------------------------------------------2 ###
> 
> ###                                  字段名规范---------------------------------------------------------2 ###
> 
> ###                                  数据类型规范-------------------------------------------------------2 ###
> 
>  
> 
>  
> 
>  
> 
>  
> 
>

##                              ##

> ##               1.数据结构 ##
> 
> ###                1.1帮助中心分类表（xx\_help\_class） ###
> 
> <table> 
> <tbody> 
> <tr> 
> <td style="background-color:#5b9bd5;width:82.55pt;"> 字段名称 </td> 
> <td style="background-color:#5b9bd5;width:82.8pt;"> 类型 </td> 
> <td style="background-color:#5b9bd5;width:72.65pt;"> 字段注释 </td> 
> <td style="background-color:#5b9bd5;width:72.5pt;"> 默认值 </td> 
> <td style="background-color:#5b9bd5;width:49.85pt;"> 非空 </td> 
> <td style="background-color:#5b9bd5;width:113.45pt;"> 说明 </td> 
> </tr> 
> <tr> 
> <td style="width:82.55pt;"> id </td> 
> <td style="width:82.8pt;"> int(20) </td> 
> <td style="width:72.65pt;"> 主键 </td> 
> <td style="width:72.5pt;"> 　 </td> 
> <td style="width:49.85pt;"> Y </td> 
> <td style="width:113.45pt;">&nbsp;</td> 
> </tr> 
> <tr> 
> <td style="background-color:#e7e6e6;width:82.55pt;"> class_name </td> 
> <td style="background-color:#e7e6e6;width:82.8pt;"> varchar(50) </td> 
> <td style="background-color:#e7e6e6;width:72.65pt;"> 分类名称 </td> 
> <td style="background-color:#e7e6e6;width:72.5pt;"> 　 </td> 
> <td style="background-color:#e7e6e6;width:49.85pt;"> Y </td> 
> <td style="background-color:#e7e6e6;width:113.45pt;"> 　 </td> 
> </tr> 
> <tr> 
> <td style="width:82.55pt;"> image_url </td> 
> <td style="width:82.8pt;"> varchar(200) </td> 
> <td style="width:72.65pt;"> 图片地址 </td> 
> <td style="width:72.5pt;"> 　 </td> 
> <td style="width:49.85pt;"> N </td> 
> <td style="width:113.45pt;"> 　 </td> 
> </tr> 
> <tr> 
> <td style="background-color:#e7e6e6;width:82.55pt;"> link_url </td> 
> <td style="background-color:#e7e6e6;width:82.8pt;"> varchar(200) </td> 
> <td style="background-color:#e7e6e6;width:72.65pt;"> 外链地址 </td> 
> <td style="background-color:#e7e6e6;width:72.5pt;"> &nbsp; </td> 
> <td style="background-color:#e7e6e6;width:49.85pt;"> N </td> 
> <td style="background-color:#e7e6e6;width:113.45pt;"> &nbsp; </td> 
> </tr> 
> <tr> 
> <td style="background-color:#ffffff;width:82.55pt;"> description </td> 
> <td style="background-color:#ffffff;width:82.8pt;"> varchar(500) </td> 
> <td style="background-color:#ffffff;width:72.65pt;"> 修改描述 </td> 
> <td style="background-color:#ffffff;width:72.5pt;"> &nbsp; </td> 
> <td style="background-color:#ffffff;width:49.85pt;"> N </td> 
> <td style="background-color:#ffffff;width:113.45pt;"> &nbsp; </td> 
> </tr> 
> <tr> 
> <td style="background-color:#e7e6e6;width:82.55pt;"> remark </td> 
> <td style="background-color:#e7e6e6;width:82.8pt;"> varchar(500) </td> 
> <td style="background-color:#e7e6e6;width:72.65pt;"> 备注 </td> 
> <td style="background-color:#e7e6e6;width:72.5pt;"> &nbsp; </td> 
> <td style="background-color:#e7e6e6;width:49.85pt;"> N </td> 
> <td style="background-color:#e7e6e6;width:113.45pt;"> &nbsp; </td> 
> </tr> 
> <tr> 
> <td style="background-color:#ffffff;width:82.55pt;"> class_type </td> 
> <td style="background-color:#ffffff;width:82.8pt;"> tinyint(1) </td> 
> <td style="background-color:#ffffff;width:72.65pt;"> 类型 </td> 
> <td style="background-color:#ffffff;width:72.5pt;"> &nbsp; </td> 
> <td style="background-color:#ffffff;width:49.85pt;"> Y </td> 
> <td style="background-color:#ffffff;width:113.45pt;"> 1-首页问题 2-普通问题 3-外链文章 </td> 
> </tr> 
> <tr> 
> <td style="background-color:#d9d9d9;width:82.55pt;"> opr_erp </td> 
> <td style="background-color:#d9d9d9;width:82.8pt;"> varchar(50) </td> 
> <td style="background-color:#d9d9d9;width:72.65pt;"> 操作人 </td> 
> <td style="background-color:#d9d9d9;width:72.5pt;">&nbsp;</td> 
> <td style="background-color:#d9d9d9;width:49.85pt;"> N </td> 
> <td style="background-color:#d9d9d9;width:113.45pt;">&nbsp;</td> 
> </tr> 
> <tr> 
> <td style="background-color:#ffffff;width:82.55pt;"> create_time </td> 
> <td style="background-color:#ffffff;width:82.8pt;"> datetime </td> 
> <td style="background-color:#ffffff;width:72.65pt;"> 创建时间 </td> 
> <td style="background-color:#ffffff;width:72.5pt;">&nbsp;</td> 
> <td style="background-color:#ffffff;width:49.85pt;"> Y </td> 
> <td style="background-color:#ffffff;width:113.45pt;"> 　 </td> 
> </tr> 
> <tr> 
> <td style="background-color:#d9d9d9;width:82.55pt;"> update_time </td> 
> <td style="background-color:#d9d9d9;width:82.8pt;"> datetime </td> 
> <td style="background-color:#d9d9d9;width:72.65pt;"> 更新时间 </td> 
> <td style="background-color:#d9d9d9;width:72.5pt;"> &nbsp; </td> 
> <td style="background-color:#d9d9d9;width:49.85pt;"> Y </td> 
> <td style="background-color:#d9d9d9;width:113.45pt;"> &nbsp; </td> 
> </tr> 
> <tr> 
> <td>&nbsp;</td> 
> <td>&nbsp;</td> 
> <td>&nbsp;</td> 
> <td>&nbsp;</td> 
> <td>&nbsp;</td> 
> <td>&nbsp;</td> 
> </tr> 
> </tbody> 
> </table>
> 
> ###                 1.2.帮助中心文章表（xx\_help\_article）               ###
> 
> <table> 
> <tbody> 
> <tr> 
> <td style="background-color:#5b9bd5;width:88.8pt;"> 字段名称 </td> 
> <td style="background-color:#5b9bd5;width:82.8pt;"> 类型 </td> 
> <td style="background-color:#5b9bd5;width:70.9pt;"> 字段注释 </td> 
> <td style="background-color:#5b9bd5;width:70.85pt;"> 默认值 </td> 
> <td style="background-color:#5b9bd5;width:49.65pt;"> 非空 </td> 
> <td style="background-color:#5b9bd5;width:108.45pt;"> 说明 </td> 
> </tr> 
> <tr> 
> <td style="width:88.8pt;"> id </td> 
> <td style="width:82.8pt;"> bigint(20) </td> 
> <td style="width:70.9pt;"> 主键 </td> 
> <td style="width:70.85pt;"> 　 </td> 
> <td style="width:49.65pt;"> Y </td> 
> <td style="width:108.45pt;"> 自增 </td> 
> </tr> 
> <tr> 
> <td style="background-color:#e7e6e6;width:88.8pt;"> title </td> 
> <td style="background-color:#e7e6e6;width:82.8pt;"> varchar(64) </td> 
> <td style="background-color:#e7e6e6;width:70.9pt;"> 文章标题 </td> 
> <td style="background-color:#e7e6e6;width:70.85pt;"> 　 </td> 
> <td style="background-color:#e7e6e6;width:49.65pt;"> Y </td> 
> <td style="background-color:#e7e6e6;width:108.45pt;"> 　 </td> 
> </tr> 
> <tr> 
> <td style="width:88.8pt;"> content </td> 
> <td style="width:82.8pt;"> mediumtext </td> 
> <td style="width:70.9pt;"> &nbsp; 文章内容 </td> 
> <td style="width:70.85pt;"> 　 </td> 
> <td style="width:49.65pt;"> Y </td> 
> <td style="width:108.45pt;"> 　 </td> 
> </tr> 
> <tr> 
> <td style="background-color:#e7e6e6;width:88.8pt;"> class_id </td> 
> <td style="background-color:#e7e6e6;width:82.8pt;"> int(11) </td> 
> <td style="background-color:#e7e6e6;width:70.9pt;"> 分类ID </td> 
> <td style="background-color:#e7e6e6;width:70.85pt;"> 　 </td> 
> <td style="background-color:#e7e6e6;width:49.65pt;"> Y </td> 
> <td style="background-color:#e7e6e6;width:108.45pt;"> 　 </td> 
> </tr> 
> <tr> 
> <td style="width:88.8pt;"> class_type </td> 
> <td style="width:82.8pt;"> tinyint(1) </td> 
> <td style="width:70.9pt;"> 分类类型 </td> 
> <td style="width:70.85pt;"> 　 </td> 
> <td style="width:49.65pt;"> Y </td> 
> <td style="width:108.45pt;"> 0-首页问题 1-普通问题 2-外链文章 </td> 
> </tr> 
> <tr> 
> <td style="background-color:#e7e6e6;width:88.8pt;"> sort </td> 
> <td style="background-color:#e7e6e6;width:82.8pt;"> int(1) </td> 
> <td style="background-color:#e7e6e6;width:70.9pt;"> 排序 </td> 
> <td style="background-color:#e7e6e6;width:70.85pt;"> 　0 </td> 
> <td style="background-color:#e7e6e6;width:49.65pt;"> Y </td> 
> <td style="background-color:#e7e6e6;width:108.45pt;"> 　 </td> 
> </tr> 
> <tr> 
> <td style="width:88.8pt;"> remark </td> 
> <td style="width:82.8pt;"> varchar(50) </td> 
> <td style="width:70.9pt;"> 备注 </td> 
> <td style="width:70.85pt;"> 　 </td> 
> <td style="width:49.65pt;"> N </td> 
> <td style="width:108.45pt;">&nbsp;</td> 
> </tr> 
> <tr> 
> <td style="background-color:#e7e6e6;width:88.8pt;"> create_time </td> 
> <td style="background-color:#e7e6e6;width:82.8pt;"> datetime </td> 
> <td style="background-color:#e7e6e6;width:70.9pt;"> 创建时间 </td> 
> <td style="background-color:#e7e6e6;width:70.85pt;">&nbsp;</td> 
> <td style="background-color:#e7e6e6;width:49.65pt;"> Y </td> 
> <td style="background-color:#e7e6e6;width:108.45pt;">&nbsp;</td> 
> </tr> 
> <tr> 
> <td style="background-color:#ffffff;width:88.8pt;"> update_time </td> 
> <td style="background-color:#ffffff;width:82.8pt;"> datetime </td> 
> <td style="background-color:#ffffff;width:70.9pt;"> 更新时间 </td> 
> <td style="background-color:#ffffff;width:70.85pt;"> &nbsp; </td> 
> <td style="background-color:#ffffff;width:49.65pt;"> Y </td> 
> <td style="background-color:#ffffff;width:108.45pt;"> &nbsp; </td> 
> </tr> 
> <tr> 
> <td style="background-color:#e7e6e6;width:88.8pt;"> yn </td> 
> <td style="background-color:#e7e6e6;width:82.8pt;"> tinyint(1) </td> 
> <td style="background-color:#e7e6e6;width:70.9pt;"> 有效状态 </td> 
> <td style="background-color:#e7e6e6;width:70.85pt;"> 0 </td> 
> <td style="background-color:#e7e6e6;width:49.65pt;"> Y </td> 
> <td style="background-color:#e7e6e6;width:108.45pt;"> 0：有效 1：无效 </td> 
> </tr> 
> <tr> 
> <td>&nbsp;</td> 
> <td>&nbsp;</td> 
> <td>&nbsp;</td> 
> <td>&nbsp;</td> 
> <td>&nbsp;</td> 
> <td>&nbsp;</td> 
> </tr> 
> </tbody> 
> </table>
> 
> ###                         ###

> ##                2.附录 ##
> 
> ###                     表名规范 ###
> 
> ###                         xx\_功能名称\_详细表名称 ###
> 
> ###                    字段名规范 ###
> 
>                        （1）采用26个英文字母(区分大小写)和0-9的自然数(经常不需要)加上下划线'\_'组成，命名简洁明确，多
> 
>                            个单词用下划线'\_'分隔
> 
>                 （2）**全部小写命名，禁止出现大写**
> 
>                （3）**字段必须填写描述信息**
> 
>                （4）禁止使用数据库关键字，如：name，time ，datetime password 等
> 
>               （5）**字段名称一般采用名词或动宾短语**
> 
>              （6）采用字段的名称必须是易于理解，一般不超过三个英文单词
> 
>              （7）在命名表的列时，不要重复表的名称
> 
>                     例如，在名employe的表中避免使用名为employee\_lastname的字段
> 
>            （8）不要在列的名称中包含数据类型
> 
>            （9）**字段命名使用完整名称，禁止缩写**
> 
> ###        数据类型规范 ###
> 
>  
> 
> （1）所有字段在设计时，除以下数据类型timestamp、image、datetime、smalldatetime、uniqueidentifier、
> 
>          binary、sql\_variant、binary、varbinary外，必须有默认值，字符型的默认值为一个空字符值串’’，数值型
> 
>         的默认值为数值0，逻辑型的默认值为数值0
> 
> （2）系统中所有逻辑型中数值0表示为“假”，数值1表示为“真”，datetime、smalldatetime类型的字段没有默认
> 
>          值，必须为NULL
> 
> （3）用尽量少的存储空间来存储一个字段的数据
> 
>           使用int就不要使用varchar、char
> 
>            用varchar(16)就不要使varchar(256)
> 
>            IP地址使用int类型,固定长度的类型最好使用char，例如：邮编(postcode);
> 
>           能使用tinyint就不要使用smallint，int
> 
>           最好给每个字段一个默认值，最好不能为null
> 
> （4）用合适的字段类型节约空间
> 
>          字符转化为数字(能转化的最好转化，同样节约空间、提高查询性能)
> 
>         避免使用NULL字段(NULL字段很难查询优化、NULL字段的索引需要额外空间、NULL字段的复合索引无效)
> 
>         少用text类型(尽量使用varchar代替text字段)