Skip to content

Commit 54f2160

Browse files
committed
update docs
1 parent cda3049 commit 54f2160

File tree

2 files changed

+24
-3
lines changed

2 files changed

+24
-3
lines changed

docs/backend/reference/db.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ DATABASE_PASSWORD='123456'
7373

7474
## 解耦
7575

76+
如果你只想保留一种数据库兼容性,请参考以下内容:
77+
7678
- 删除 `with_variant` 相关代码(如果存在),仅保留数据库对应的类型
7779
- 删除 `backend/core/conf.py` 文件中的 `DATABASE_TYPE` 及其相关的调用代码
7880
- 删除 `.env_example``.env` 文件中的 `DATABASE_TYPE`

docs/backend/reference/pk.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,34 @@ title: 主键
4949

5050
## 切换选择
5151

52+
::: warning
53+
在切换选择之前,请确认以下事项
54+
55+
- 未启动过项目
56+
- 未通过 SQL 脚本创建过表
57+
- `backend/conf.py` 文件中的 `DATABASE_SCHEMA` 配置符合预期
58+
59+
如果存在以上操作,在切换选择前,必须删除所有数据库表
60+
:::
61+
62+
::: caution
63+
不要随意切换选择!!!自增 ID 是数据库表级物理绑定,随意切换将导致致命问题!!!
64+
:::
65+
5266
### 自增 ID
5367

5468
无需切换,这是 fba 内的全局默认声明方式
5569

5670
### 雪花 ID
5771

58-
1. 更新 fba 内所有 sqlalchemy model 中的 `id: Mapped[id_key]``id: Mapped[snowflake_id_key]`
59-
2. 更新所有 `id_key` 导入为 `snowflake_id_key`
60-
3. 执行 `backend/sql/init_snowflake_test_data.sql` 脚本初始化测试数据
72+
1. 务必仔细查看本章节警告内容,确保数据库环境整洁
73+
2. 更新 fba 内所有 sqlalchemy model 中的 `id: Mapped[id_key]``id: Mapped[snowflake_id_key]`
74+
75+
温馨提示:合理利用 IDE 一键替换功能,可避免繁琐操作和遗漏
76+
77+
3. 更新所有 `id_key` 导入为 `snowflake_id_key`
78+
4. 执行 `backend/sql/xxx/init_snowflake_test_data.sql` 脚本初始化测试数据
79+
5. 阅读 [注意事项](#注意事项)
6180

6281
::: caution Windows 平台警告
6382
如果您正在 Windows 平台中使用 mysql >= 8.0,还需要更新 `backend/database/db.py` 文件内的 `mysql+asyncmy`

0 commit comments

Comments
 (0)