5.4 KiB
5.4 KiB
数据库变更规范(DDL)
所有表结构变更只允许通过 sequelize-cli 迁移脚本执行,禁止直接连库改表。
为什么
- 迁移记录在
SequelizeMeta表里,换环境(开发 / 测试 / 生产)按同一条命令重放,不会漏表、漏字段; - 直接
ALTER TABLE无法回溯,环境之间会悄悄不一致; - 回滚有据可依(每个迁移都有
down)。
目录与配置
backend/
├─ .sequelizerc # sequelize-cli 路径配置
├─ database/
│ ├─ config.cjs # 连接信息(与环境变量 / config.local.js 同源)
│ ├─ migrations/ # ★ DDL 脚本放这里
│ └─ seeders/ # 初始数据(可选)
连接信息由 scripts/db-config.js 统一解析:环境变量 > config/config.local.js > 默认值,
与运行时服务完全一致,避免「迁移改 A 库、服务连 B 库」。
常用命令
npm run db:migrate # 执行全部未执行的迁移
npm run db:migrate:status # 查看哪些执行过
npm run db:migrate:undo # 回滚最后一条
npm run db:migration:generate -- create_xxx_tables # 生成迁移骨架
写迁移的约定
- 表名/字段名用下划线,与既有表保持一致;
- 主键统一
BIGINT UNSIGNED自增; - 时间字段统一
created_at/updated_at/deleted_at(软删除),status用TINYINT UNSIGNED; - 不建物理外键(与
users、scanners等既有表一致),只建索引; up()必须能重复执行前先看SequelizeMeta(由 CLI 保证只跑一次),down()必须能干净回滚。
已执行过的迁移
| 迁移 | 内容 |
|---|---|
20261018100000-create-nvr-camera-workstation-tables |
nvrs / cameras / workstations / workstation_cameras / workstation_scan_channels |
20261018150000-add-channel-name-to-cameras |
cameras.channel_name(设备通道名,与业务别名分开) |
20261018180000-add-has-ptz-to-cameras |
cameras.has_ptz(是否支持云台) |
20261018200000-add-workstation-layout |
workstations.canvas_width/height + workstation_cameras.x/y/width/height/stream_type/z_index |
20261018200100-backfill-workstation-camera-layout |
回填已有绑定关系的画布位置(第 1 条铺满 / 第 2 条右上 / 其余左下) |
20261018210000-add-workstation-type |
workstations.ws_type(1 散单 / 2 团购) |
20261018220000-add-workstation-record-range |
workstations.record_before_sec/record_after_sec/record_max_sec(录制范围与最大录制时长) |
20261018230000-create-subject-tables |
新表 subjects / subject_members;scanners/nvrs/cameras/workstations/scan_channels/scan_records 加 subject_id,并把已有数据回填到「每人一个主体」 |
20261024100000-add-workstation-login-fields |
workstations.login_code(登录码 WSC- 前缀,唯一)/ last_active_at(最后活跃时间)/ idle_timeout_sec(多少秒不活跃自动下线,团购 3600 / 散单 1800),并回填已有工作台(⚠️ login_code 已被 20261028121000 删除) |
20261024101000-create-workstation-login-records |
新表 workstation_login_records(工作台成员登录记录,含 (workstation_id, login_at) 等索引) |
20261024102000-add-workstation-camera-label-flag |
workstation_cameras.is_label_camera(面单摄像头标记;现支持一台工作台多路,散单/团购都可设) |
20261028120000-create-wechat-gateway-bindings |
新表 wechat_gateway_bindings(微信登录网关绑定:user_id / app_key / openid(唯一)/ unionid / bind_scene / last_login_at) |
20261028121500-add-subject-member-temp-user |
subject_members.temp_user_id(扫码绑定时自动建给成员的临时账号;被已有账号继承时该账号会被删除) |
20261028121000-drop-workstation-login-code |
删除 workstations.login_code(WSC- 登录码已废弃,扫码登入改走微信登录网关的一次性二维码);workstation_login_records.login_code 保留作历史 |
20261029100000-drop-legacy-wechat-tables |
删除 wechat_oauth(自建公众号网页授权)与 wechat_mp_accounts(小程序 code2Session 一键登录):微信侧接入已统一走登录网关;down 按原结构重建两张空表 |
20261029120000-create-admin-members |
新表 admin_members(平台管理员:user_id 唯一、name、role、status、remark)+ 把内置管理员(username='admin',没有就 id=1)先入表 |
20261107120000-create-doc-tables |
新表 doc_categories / doc_sections / doc_articles(文档站三级结构)+ 一页「欢迎使用」示例(⚠️ 表结构已被 20261109230000 收紧成两级) |
20261109230000-doc-two-level-structure |
文档站改成两级:doc_categories 改名 doc_sections(即「栏目」,保留 code / 名称 / 说明 / 排序 / 显隐),删掉原二级栏目表,doc_articles.section_id 改指栏目并删 category_id |
历史遗留的
sql/schema.sql+sql/migrations/*.sql(用npm run db:init执行)是接入 sequelize-cli 之前的做法, 只用于初始化老表;新变更一律写database/migrations/*.js。