Skip to content

Db naming

数据库命名规范（MySQL、MSSQL、PostgreSQL、ClickHouse）

数据库对象是数据库的组成部分，常见的有以下几种：表（Table ）、索引（Index）、视图（View）、图表（Diagram）、缺省值（Default）、规则（Rule） 、触发器（Trigger）、存储过程（Stored Procedure）、 用户（User）等。

命名规范是指数据库对象如数据库（SCHEMA）、表（TABLE）、索引（INDEX）、约束（CONSTRAINTS）等的命名约定。

数据库对象全局命名规范

  1. 命名使用具有意义的英文词汇，词汇中间以下划线分隔
  2. 命名只能使用英文字母、数字、下划线，以英文字母开头
  3. 避免使用保留字如：backup、call、group等
  4. 所有数据库对象使用小写字母
  5. 数据库、表、字段等所有名称使用英文单词或英文短语或相应缩写，禁止使用汉语拼音（特殊情况下使用汉字）
  6. 且均使用单数名，例如：对存储客人信息的表命名为customer而不是customers

数据库命名规范

  1. 数据库命名尽量不超过30个字符
  2. 数据库命名一般为项目名称+代表库含义的简写，比如IM项目的工作流数据库，可以是 im_flow
  3. 数据库创建时必须添加默认字符集和校对规则子句。默认字符集为UTF8
  4. 命名应使用小写

表命名规范

  1. 常规表表名以t_开头，t代表table的意思，命名规则即 t + 模块（包含模块含义的简写）+ 表（包含表含义的简写），比如用户模块的教育信息表：t_user_eduinfo
  2. 临时表（RD、QA或DBA同学用于数据临时处理的表），命名规则：temp前缀+模块+表+日期后缀：temp_user_eduinfo_20210719
  3. 备份表（用于保存和归档历史数据或者作为灾备恢复的数据）命名规则，bak前缀+模块+表+日期后缀：bak_user_eduinfo_20210719
  4. 同一个模块的表尽可能使用相同的前缀，表名称尽可能表达含义
  5. 多个单词以下划线 _ 分隔
  6. 常规表表名尽量不超过30个字符，temp表和bak表视情况而定，也尽量简短为宜，命名应使用小写

字段命名规范

  1. 字段命名需要表示其实际含义的英文单词或简写，单词之间用下划线 _ 进行连接，如 service_ip、service_port
  2. 各表之间相同意义的字段必须同名，比如a表和b表都有创建时间，应该统一为create_time，不一致会很混乱
  3. 多个单词以下划线 _ 分隔
  4. 字段名尽量不超过30个字符，命名应该使用小写

索引命名规范

  1. 唯一索引使用uni + 字段名 来命名： create unique index uni_uid on t_user_basic(uid)
  2. 非唯一索引使用idx + 字段名 来命名： create index idx_uname_mobile on t_user_basic(uname,mobile)
  3. 多个单词以下划线 _ 分隔
  4. 索引名尽量不超过50个字符，命名应该使用小写，组合索引的字段不宜太多，不然也不利于查询效率的提升
  5. 多单词组成的列名，取尽可能代表意义的缩写，如 test_contact表member_id和friend_id上的组合索引：idx_mid_fid
  6. 理解组合索引最左前缀原则，避免重复建设索引，如果建立了(a,b,c)，相当于建立了(a), (a,b), (a,b,c)

视图命名规范

  1. 视图名以v开头，表示view，完整结构是v+视图内容含义缩写
  2. 如果视图只来源单个表，则为v+表名。如果视图由几个表关联产生就用v+下划线（_）连接几个表名，视图名尽量不超过30个字符。如超过30个字符则取简写
  3. 命名应使用小写

存储过程命名规范

  1. 存储过程名以sp开头，表示存储过程（storage procedure）。之后多个单词以下划线（_）进行连接。存储过程命名中应体现其功能。存储过程名尽量不能超过30个字符
  2. 存储过程中的输入参数以i_开头，输出参数以o_开头
  3. 命名应使用小写

函数命名规范

  1. 函数名以f开始，表示function。之后多个单词以下划线（_）进行连接，函数命名中应体现其功能。函数名尽量不超过30个字符
  2. 命名应使用小写

sql create function f_format_date(ctime datetime)

触发器命名规范

  1. 触发器以trig开头，表示trigger 触发器
  2. 基本部分，描述触发器所加的表，触发器名尽量不超过30个字符
  3. 后缀（_i,_u,_d）,表示触发条件的触发方式（insert,update或delete）
  4. 命名应使用小写
DROP TRIGGER IF EXISTS trig_attach_log_d;
  CREATE TRIGGER trig_attach_log_d AFTER DELETE ON t_dept FOR EACH ROW;

约束命名规范

  1. 唯一约束：uk_表名称_字段名。uk是UNIQUE KEY的缩写。比如给一个部门的部门名称加上唯一约束，来保证不重名，如： ALTER TABLE t_dept ADD CONSTRAINT un_name UNIQUE(name)

  2. 外键约束：fk_表名，后面紧跟该外键所在的表名和对应的主表名（不含t_）。子表名和父表名用下划线(_)分隔，如： ALTER TABLE t_user ADD CONSTRAINT fk_user_dept FOREIGN KEY(depno) REFERENCES t_dept (id)

  3. 非空约束：如无特殊需要，建议所有字段默认非空(not null)，不同数据类型必须给出默认值(default)

  4. 出于性能考虑，如无特殊需要，建议不使用外键。参照完整性由代码控制。从程序角度进行完整性控制，但是如果不注意，也会产生脏数据

  5. 命名应使用小写

用户命名规范

  1. 生产使用的用户命名格式为 code_应用
  2. 只读用户命名规则为 read_应用