Skip to content

数据库规范

命名

  1. 表名不能使用复数。

    示例

    订单表应使用 order, 而不是 orders

  2. 表名应按业务模块添加前缀。例如:sys_、st_

  3. 表/字段名禁止使用保留字。

  4. 表/字段命名使用蛇形命名法(snake_case)命名。例如:user_name

  5. 主键索引应以 pk_ 开头,唯一索引应以 uk_ 开头,普通索引应以 idx_ 开头,临时表以 tmp_ 开头。

    示例

    pk_user_id、user_202205

设计

  1. 必须填写表、字段备注,对字段用途进行说明。
  2. 非特殊场景,所有表必须继承 sys_base_table
  3. 小数类型为 decimal(numeric),禁止使用 float 和 double。
  4. 表必须设置主键。
  5. 不同表之间相关联的字段,字段类型必须一致,字段名也应保持一致。

    示例

    用户表id字段,其他表应统一使用 user_id。

  6. 表字段尽可能不允许 null 值,使用默认值替代。
  7. 关键查询字段应创建索引。