cdspec 0.1.0 → 0.1.3

package/templates/{standards-backend → backend-standard}/references//346/225/260/346/215/256/345/272/223/350/256/276/350/256/241/350/247/204/350/214/203.md

@@ -1,116 +1,116 @@
-# 数据库设计规范（部门版）
-
-## 1. 命名规范
-1. 数据库对象名使用小写字母、数字、下划线，禁止数字开头。
-2. 表名使用模块前缀：`sss_xxx`，关系表使用 `sss_xxx_yyy_rel`。
-3. 字段名全小写下划线，命名必须可读且语义明确。
-4. 同语义字段在不同表必须同名同类型。
-5. 关联字段统一 `xxx_id`，类型与被关联主键一致。
-
-## 2. 字段设计
-1. 时间字段：精确到时分秒使用 `xxx_time`（`datetime`）；仅日期使用 `xxx_date`（`date`）。
-2. 标志字段使用 `xxx_flag`；逻辑删除建议统一 `del_flag`（0 未删除，1 已删除）。
-3. 类型字段统一 `xxx_type` 或 `xxx_category`，避免含义不清的数值编码。
-4. 布尔字段命名建议使用 `is_` / `has_` 前缀，避免否定命名。
-
-## 3. 表结构基本约束
-1. 存储引擎统一 InnoDB。
-2. 字符集统一 `utf8mb4`，排序规则统一 `utf8mb4_general_ci`。
-3. 每张表必须有表注释，每个字段必须有字段注释。
-4. 主键建议单一代理键；桥接表可按场景使用复合主键。
-
-## 4. 索引规范
-1. 索引命名使用 `idx_表名_字段名`。
-2. 唯一约束命名使用 `uk_表名_字段名`。
-3. 关联字段必须建索引，避免联表全表扫描。
-4. 单表索引数量建议控制，避免无效和重复索引。
-5. 联合索引遵循最左前缀原则，结合常见查询条件设计。
-
-## 5. SQL 编写规范
-1. 禁止 `select *`，只查询必要列。
-2. 多表查询统一使用别名并带别名前缀。
-3. 分页查询必须限制返回量，避免深分页性能问题。
-4. 避免在索引列上使用函数、隐式转换、前导模糊匹配。
-5. 条件值可能为空时，使用 `is null` / `is not null` 语义表达。
-
-## 6. 变更脚本规范
-1. 版本号采用 `<major>.<minor>.<patch>`。
-2. 脚本命名：`[V|R][版本号]_[序号]__[模块]_[操作]_[描述].sql`。
-3. `V` 脚本只执行一次且不允许改动；`R` 脚本每次运行可重复执行。
-4. 生产变更必须提供回滚策略或数据修复策略。
-
-## 7. 设计评审清单
-1. 是否存在冗余字段或语义不清字段。
-2. 是否缺失必要索引或存在过度索引。
-3. 是否满足基础字段要求（见本文第 8 章）。
-4. 是否考虑了租户、并发更新、历史追溯需求。
-
-## 8. 数据表基线字段规范（内置）
-
-### 8.1 普通业务表（默认必须）
-以下字段为部门级默认基线，除评审通过外不得删除。
-
-```sql
-`id` varchar(36) NOT NULL COMMENT '主键',
-`del_flag` tinyint(4) DEFAULT '0' COMMENT '逻辑删除标志：0-未删除，1-已删除',
-`create_by` varchar(50) DEFAULT NULL COMMENT '创建人',
-`create_time` datetime DEFAULT NULL COMMENT '创建时间',
-`update_by` varchar(50) DEFAULT NULL COMMENT '更新人',
-`update_time` datetime DEFAULT NULL COMMENT '更新时间',
-`version` int(11) DEFAULT '0' COMMENT '乐观锁版本号'
-```
-
-如启用多租户，追加：
-
-```sql
-`tenant_id` int(11) DEFAULT NULL COMMENT '租户ID'
-```
-
-### 8.2 关联表（中间关系表）例外规则
-纯关联表允许精简字段，不强制套用 8.1 的完整审计字段。典型形态如下：
-
-```sql
-`id` varchar(36) NOT NULL COMMENT '主键',
-`user_id` varchar(36) NOT NULL COMMENT '用户ID',
-`role_id` varchar(36) NOT NULL COMMENT '角色ID'
-```
-
-多租户场景建议追加：
-
-```sql
-`tenant_id` int(11) DEFAULT NULL COMMENT '租户ID'
-```
-
-补充约束：
-1. 关联表最少保证 `id + 两端关联ID`，不强制 `del_flag/create_*/update_*/version`。
-2. 若关联关系需要审计追踪、逻辑删除或并发控制，再按 8.1 补齐字段。
-3. 应建立唯一约束避免重复关系（例如 `uk_user_role(user_id, role_id[, tenant_id])`）。
-4. 应给关联 ID 建索引（`idx_xxx_user_id`、`idx_xxx_role_id`）。
-
-### 8.3 历史表（默认必须）
-历史表应包含原表核心业务字段，并追加：
-
-```sql
-`instance_id` varchar(36) DEFAULT NULL COMMENT '历史实例ID',
-`transaction_by` varchar(32) DEFAULT NULL COMMENT '变更人',
-`transaction_time` datetime DEFAULT NULL COMMENT '变更时间'
-```
-
-### 8.4 推荐建表示例（普通业务表）
-```sql
-create table `wms_example_order` (
-  `id` varchar(36) not null comment '主键',
-  `order_no` varchar(64) not null comment '单据编号',
-  `order_status` varchar(32) not null comment '单据状态',
-  `del_flag` tinyint(4) default '0' comment '逻辑删除标志：0-未删除，1-已删除',
-  `create_by` varchar(50) default null comment '创建人',
-  `create_time` datetime default null comment '创建时间',
-  `update_by` varchar(50) default null comment '更新人',
-  `update_time` datetime default null comment '更新时间',
-  `tenant_id` int(11) default null comment '租户ID',
-  `version` int(11) default '0' comment '乐观锁版本号',
-  primary key (`id`),
-  key `idx_wms_example_order_order_no` (`order_no`),
-  key `idx_wms_example_order_status` (`order_status`)
-) engine=innodb default charset=utf8mb4 collate=utf8mb4_general_ci comment='示例订单表';
-```
+# 数据库设计规范（部门版）
+
+## 1. 命名规范
+1. 数据库对象名使用小写字母、数字、下划线，禁止数字开头。
+2. 表名使用模块前缀：`sss_xxx`，关系表使用 `sss_xxx_yyy_rel`。
+3. 字段名全小写下划线，命名必须可读且语义明确。
+4. 同语义字段在不同表必须同名同类型。
+5. 关联字段统一 `xxx_id`，类型与被关联主键一致。
+
+## 2. 字段设计
+1. 时间字段：精确到时分秒使用 `xxx_time`（`datetime`）；仅日期使用 `xxx_date`（`date`）。
+2. 标志字段使用 `xxx_flag`；逻辑删除建议统一 `del_flag`（0 未删除，1 已删除）。
+3. 类型字段统一 `xxx_type` 或 `xxx_category`，避免含义不清的数值编码。
+4. 布尔字段命名建议使用 `is_` / `has_` 前缀，避免否定命名。
+
+## 3. 表结构基本约束
+1. 存储引擎统一 InnoDB。
+2. 字符集统一 `utf8mb4`，排序规则统一 `utf8mb4_general_ci`。
+3. 每张表必须有表注释，每个字段必须有字段注释。
+4. 主键建议单一代理键；桥接表可按场景使用复合主键。
+
+## 4. 索引规范
+1. 索引命名使用 `idx_表名_字段名`。
+2. 唯一约束命名使用 `uk_表名_字段名`。
+3. 关联字段必须建索引，避免联表全表扫描。
+4. 单表索引数量建议控制，避免无效和重复索引。
+5. 联合索引遵循最左前缀原则，结合常见查询条件设计。
+
+## 5. SQL 编写规范
+1. 禁止 `select *`，只查询必要列。
+2. 多表查询统一使用别名并带别名前缀。
+3. 分页查询必须限制返回量，避免深分页性能问题。
+4. 避免在索引列上使用函数、隐式转换、前导模糊匹配。
+5. 条件值可能为空时，使用 `is null` / `is not null` 语义表达。
+
+## 6. 变更脚本规范
+1. 版本号采用 `<major>.<minor>.<patch>`。
+2. 脚本命名：`[V|R][版本号]_[序号]__[模块]_[操作]_[描述].sql`。
+3. `V` 脚本只执行一次且不允许改动；`R` 脚本每次运行可重复执行。
+4. 生产变更必须提供回滚策略或数据修复策略。
+
+## 7. 设计评审清单
+1. 是否存在冗余字段或语义不清字段。
+2. 是否缺失必要索引或存在过度索引。
+3. 是否满足基础字段要求（见本文第 8 章）。
+4. 是否考虑了租户、并发更新、历史追溯需求。
+
+## 8. 数据表基线字段规范（内置）
+
+### 8.1 普通业务表（默认必须）
+以下字段为部门级默认基线，除评审通过外不得删除。
+
+```sql
+`id` varchar(36) NOT NULL COMMENT '主键',
+`del_flag` tinyint(4) DEFAULT '0' COMMENT '逻辑删除标志：0-未删除，1-已删除',
+`create_by` varchar(50) DEFAULT NULL COMMENT '创建人',
+`create_time` datetime DEFAULT NULL COMMENT '创建时间',
+`update_by` varchar(50) DEFAULT NULL COMMENT '更新人',
+`update_time` datetime DEFAULT NULL COMMENT '更新时间',
+`version` int(11) DEFAULT '0' COMMENT '乐观锁版本号'
+```
+
+如启用多租户，追加：
+
+```sql
+`tenant_id` int(11) DEFAULT NULL COMMENT '租户ID'
+```
+
+### 8.2 关联表（中间关系表）例外规则
+纯关联表允许精简字段，不强制套用 8.1 的完整审计字段。典型形态如下：
+
+```sql
+`id` varchar(36) NOT NULL COMMENT '主键',
+`user_id` varchar(36) NOT NULL COMMENT '用户ID',
+`role_id` varchar(36) NOT NULL COMMENT '角色ID'
+```
+
+多租户场景建议追加：
+
+```sql
+`tenant_id` int(11) DEFAULT NULL COMMENT '租户ID'
+```
+
+补充约束：
+1. 关联表最少保证 `id + 两端关联ID`，不强制 `del_flag/create_*/update_*/version`。
+2. 若关联关系需要审计追踪、逻辑删除或并发控制，再按 8.1 补齐字段。
+3. 应建立唯一约束避免重复关系（例如 `uk_user_role(user_id, role_id[, tenant_id])`）。
+4. 应给关联 ID 建索引（`idx_xxx_user_id`、`idx_xxx_role_id`）。
+
+### 8.3 历史表（默认必须）
+历史表应包含原表核心业务字段，并追加：
+
+```sql
+`instance_id` varchar(36) DEFAULT NULL COMMENT '历史实例ID',
+`transaction_by` varchar(32) DEFAULT NULL COMMENT '变更人',
+`transaction_time` datetime DEFAULT NULL COMMENT '变更时间'
+```
+
+### 8.4 推荐建表示例（普通业务表）
+```sql
+create table `wms_example_order` (
+  `id` varchar(36) not null comment '主键',
+  `order_no` varchar(64) not null comment '单据编号',
+  `order_status` varchar(32) not null comment '单据状态',
+  `del_flag` tinyint(4) default '0' comment '逻辑删除标志：0-未删除，1-已删除',
+  `create_by` varchar(50) default null comment '创建人',
+  `create_time` datetime default null comment '创建时间',
+  `update_by` varchar(50) default null comment '更新人',
+  `update_time` datetime default null comment '更新时间',
+  `tenant_id` int(11) default null comment '租户ID',
+  `version` int(11) default '0' comment '乐观锁版本号',
+  primary key (`id`),
+  key `idx_wms_example_order_order_no` (`order_no`),
+  key `idx_wms_example_order_status` (`order_status`)
+) engine=innodb default charset=utf8mb4 collate=utf8mb4_general_ci comment='示例订单表';
+```