Yoan Huang
85a42a62bc
- Dropped the ai_run_event table and associated columns from ai_run. - Removed event-related logic from AiRunStore, including methods for appending and listing events. - Updated AiRunRecord and related types to eliminate event-related properties. - Introduced a new ChatMessageLogStore to handle message logging. - Adjusted tests to reflect the removal of event handling and ensure message log functionality.
6.0 KiB
NCurator-Desktop 数据库架构
本文说明项目的本地存储边界、SQLite 与 LanceDB 的职责关系，以及索引一致性规则。具体表字段和查询细节以 migration、Store 和测试为准。
总体原则
- SQLite 是业务真相，文件位于
userData/app.sqlite。 - LanceDB 是可重建索引，目录位于
userData/lancedb，只保存vector_chunk。 - SQLite schema 通过 migration 向前演进；LanceDB 索引按 SQLite 中的 document generation 重建。
- 同一业务状态不能同时以 SQLite 和 LanceDB 为真相。
SQLite
SQLite 使用 better-sqlite3。启动时 SqliteCore 负责：
- 打开
app.sqlite。 - 设置
PRAGMA foreign_keys = ON。 - 设置
PRAGMA journal_mode = WAL。 - 设置
PRAGMA busy_timeout = 5000。 - 执行未执行的 migration。
SQLite 保存以下业务数据：
- 会话、消息和按会话隔离的中断恢复快照；恢复快照只在任务正常完成或会话删除时清理。
- AI run、审批和文件修改记录。
- 会话级 append-only 的消息转录（
chat_session_message_log），作为模型上下文的唯一真相源。 - 工作区、文件索引任务、文档元数据和网页源。
- LLM 配置和 AI runtime 设置。
- AI runtime 设置中的
systemNotificationsEnabled，默认值为1，控制 AI 运行终态系统通知。 - 文件内容和预览 artifact 的 SHA-256 对象引用；实际对象保存在工作区
.ncurator/objects/sha256，相同内容只存一份。 - Workbench 会话 UI 快照、最后活动会话、未发送草稿和内置浏览器标签状态。
关键规则：
chat_message使用会话内seq保证稳定顺序。chat_session_message_log使用session_id + seq保证会话内消息转录的稳定顺序（user/assistant/tool/annotation条目）。- 待审批状态以 SQLite 中的 run 记录为准。
document.active_generation_id是当前有效索引版本。
Workbench 会话 UI 状态
chat_session_ui_state以session_id为主键保存版本化state_json，会话删除时通过外键级联删除。workbench_ui_state是id = 1的单例，保存最后活动会话和未发送的__draft__UI 快照。browser_tab_state以owner_key隔离真实会话或__draft__的标签，保存 URL、标题、缩放、导航历史、顺序和更新时间。- 首次发送创建真实会话时，创建会话、复制草稿 UI 快照、清空草稿和转移浏览器标签在同一个 SQLite transaction 中完成。
- Renderer 内存只负责当前交互，SQLite 是重启恢复的真相；浏览器
WebContentsView只负责运行期页面实例，不是持久化真相。
SQLite Migration
- migration 记录在
schema_migrations。 - migration 定义统一放在
src/main/services/storage/sqlite/migrations/00X_*.ts，每个文件导出一个Migration（含version、name、sql或run），SqliteCore按文件导入并组成MIGRATIONS数组。 - migration 按版本递增执行。
- 每个 migration 都在 SQLite transaction 中执行。
- migration 失败会阻止启动，并抛出明确错误。
- 上线后只允许向前迁移，不做自动降级。
- 新字段优先用
ALTER TABLE ADD COLUMN。 - 改名或删除字段时，使用建新表、复制数据、删旧表、rename 的方式。
- 大数据变更需要分批处理，不能在启动时长时间阻塞。
Native 依赖
better-sqlite3 是 native 模块，Node backend 测试和 Electron e2e 使用不同 ABI。项目通过独立缓存保存两套 binding，不覆盖 node_modules 中的同一个 .node 文件。
测试 runner 和打包流程会自动准备并注入正确 binding，正常开发与回归不手工 rebuild。已发布 migration 不修改、重排或复用；任何 schema 或数据变更都新增更高版本 migration，具体历史以 migration 源码为准。migration 版本号必须全局唯一且只递增；启动时会校验当前定义中没有重复版本。旧版本曾发生冲突时，必须新增更高版本的修复 migration，不能修改用户已有的 schema_migrations 记录。
LanceDB
LanceDB 只创建和使用 vector_chunk 表。
vector_chunk 保存 chunk、document、workspace、source type、generation、顺序、正文、文档名、metadata、创建时间和 embedding vector。
允许操作：
- 批量写入 chunks。
- 向量搜索和全文搜索 chunks。
- 按
document_id / workspace_id / generation_id删除 chunks。 - 对向量表执行 optimize。
禁止操作：
- 高频业务 update。
- 业务状态 mergeInsert。
- 用 LanceDB 保存会话、消息、run、审批、网页源、工作区状态或配置。
SQLite 与 LanceDB 的关系
SQLite 决定什么数据有效，LanceDB 只负责在有效范围内检索内容。
搜索流程：
- 从 SQLite 读取当前 workspace 和 document 元数据。
- 确认当前有效的
active_generation_id。 - 到 LanceDB 搜索
workspace_id + source_type + generation_id。 - 返回命中的 chunk 和来源信息。
搜索结果不能返回非 active generation 的 chunks。
Generation 机制
文件和网页索引先写入新 generation_id，成功后由 SQLite transaction 切换 active_generation_id，再清理旧 chunks；失败时不切换，因此已有检索结果仍可用。
Fragment 和 Optimize
LanceDB fragment 是一次或多次写入形成的数据片段，不等于一行数据。
维护规则：
- chunk 必须批量写入。
- 避免大量小 batch 写入。
- 大量写入或删除后可以执行 optimize。
- optimize 只用于整理向量索引文件，不承担业务 migration。
- 不允许启动时自动删表重建。
性能约束
- 会话首屏只读取必要数据，不回放完整 run/event。
- 完整 run/event replay、context usage、file change detail 不进入切换首屏关键路径。
- chunk 写入必须批量进行。
- 慢查询优先检查 generation 过滤、workspace 过滤、source type 过滤和 fragment 数量。
- 不用缓存掩盖错误的数据边界。