接口文档说明
数据库文档说明
数据库表说明文档样式
数据库对象命名规范
表名构成:系统名称缩写++模型域前缀++对象名称(英文单词或英文缩写),例如权限控制的某个表名:ABF_AC_FUNCTION
表名全部使用大写
表名建议不要太长(15个字符以内),如果太长,请使用单词的缩写
对象名称不能使用汉字
对象名称不能使用中文拼音或中文拼音的首字母
对象名称尽可能不使用阿拉伯数字
必须保证你的对象名称没有和保留词、数据库系统或者常用访问方法冲突
绝对不要在对象名称的字符之间留空格
对象名称是一个单词的,不能使用缩写。
字段命名规范
字段名全部大写
为保持字段名短小,字段不同单词之间使用“_”作为连接符
不同表的同一个业务字段类型、长度、字段名称保持一致,如果表中同时存在多个业务字段引用,则类型长度保持一致,名称在保留原名称前加2缩写。例如,客户编号可能存在于多个表中,要求采用同样的字段名,并且类型、长度一致。又例如机构表中存在两个字段都是对机构编号ORG_ID的引用,一是此机构的编号,二是父机构的编号,则父机构编号使用PARENT_ORG_ID表示。
字段名建议不要太长(15个字符以内),如果太长,请使用单词的缩写
必须保证你的字段名称没有和保留词、数据库系统或者常用访问方法冲突
绝对不要在字段名称的字符之间留空格
主键字段统一以ID结尾,并使用numeric类型,如App编号:APP_ID numeric(12)
业务表中使用字典表中的数据时,字段字段统一以ID结尾,并使用numeric类型,如App编号:APP_ID numeric(12)
包含”代码“的字段统一以CODE结尾,如应用代码APP_CODE
“日期”类型的字段统一以DATE结尾,“时间”类型的字段统一以TIME结尾
字段名称建议命名规则(设计期持续更新)
系统数据库文档,接口文档,编码规约说明
最新推荐文章于 2024-01-09 11:35:46 发布