Skip to content

持久化

核心锚点

所有 Coffer 状态都驻留在用户本机。daemon 是唯一的数据库写入者。恢复一个可工作的安装所需的一切——数据库、daemon 配置、日志、上游状态——都位于同一个目录:~/.coffer/

这解决了什么问题

Coffer 是一个本地优先的开发者工具:用户沉淀下来的 AI 资产——已注册的 MCP 服务器、能力偏好、审计历史、知识库、记忆、聊天会话、通道以及同步状态——必须在不依赖任何云服务的情况下可读可写。这个约束要求持久化层必须是自包含的、零配置的,并且可以简单地备份。

答案是两层结构。~/.coffer/coffer.db 中的单个 SQLite 文件是所有控制面状态的事实记录方 (system of record)。批量用户内容——知识库文档和记忆 fact——以 markdown 文件的形式存放于本地文件系统(事实源);SQLite 在其之上承载一个可重建的检索索引(ADR-012)。不需要安装独立的数据库服务进程,不需要调优连接池,daemon 与存储之间也没有网络跳转。用户的数据就是他们的文件。

为什么选择 SQLite 而非 Postgres

被否决的方案——Postgres 或 MySQL 这类服务端数据库——需要用户安装并管理一个数据库进程、配置凭据、并保持一个服务持续运行。对于单用户本地工具来说,这些开销纯粹是没有任何收益的摩擦成本。

章程不变量

章程将 SQLite 指定为控制面状态的事实记录方。批量用户内容(按规范引入时)以文件形式存放于本地文件系统,按需建立索引。将控制面迁移到服务端数据库需要走章程修订流程。

SQLite 选择的实际后果塑造了持久化层的每一个细节:

  • 单写入者 — SQLite 的写并发有限;由一个写入者(daemon)负责,从设计上消除了所有写冲突。daemon 序列化每一次变更;需要写入的接口面(CLI 命令、HTTP handler)都通过 loopback HTTP 经由 daemon 进行。
  • WAL 模式 — Write-Ahead Logging 允许读取者(例如调用 REST API 的 coffer mcp list 命令)与写入者并发执行,而不会被锁阻塞。实际效果是 coffer mcp list 不会因等待正在进行的迁移而挂起。
  • 零基础设施备份 — 由于所有 Coffer 状态都在 ~/.coffer/ 下,完整 vault 可打包成一个 .tar.gz 快照(db + knowledge//memory//skills/ 文件树,默认不含 master key)。从 CLI 运行 coffer backup <dest.tar.gz>,或通过 HTTP 触发 POST /api/v1/vault/backup;两者均将归档写入 ~/.coffer/backups/。使用 coffer restore <src.tar.gz> 恢复。

SQLAlchemy 2.0 异步 ORM

数据访问层使用 SQLAlchemy 2.0 的异步模式(AsyncSession、由 aiosqlite 驱动的 create_async_engine)。这与 FastAPI daemon 的异步 I/O 模型相匹配:请求 handler 以 await 等待数据库查询,而不阻塞事件循环,使 daemon 能够响应并发的 MCP 客户端连接。

所有 kind 的所有 ORM 模型——包括与 kind 无关的核心表以及 MCP 特定的表——都注册在同一份中央 Base.metadata 对象上。这正是让 Alembic 迁移变得简单的架构决策:只有一个迁移历史,一条 alembic upgrade head 命令,不需要在多个 kind 的迁移树之间进行协调。

ORM 与领域层之间的边界是显式的。每个 ORM 模型提供:

  • to_domain() → <DomainEntity> — 将 ORM 行转换为纯 Python 领域对象(不携带 SQLAlchemy 状态)。
  • from_domain(entity) → <Model> — 从领域对象创建 ORM 实例,可直接添加到会话中。

领域对象是普通的 Python dataclass,不携带任何 SQLAlchemy 插桩。应用层服务只与领域对象打交道;ORM 模型是基础设施层的实现细节。

JSON 字段与 Pydantic 校验

kind 特定的配置以 TEXT 列(resources 表中的 config_json)存储。SQLite 没有原生的 JSON 类型;将任意结构化的配置存为文本,是 SQLite 能处理的最简单表示方式。

这个权衡在于数据库本身无法对 TEXT 列强制执行结构约束——对 SQLite 来说,字符串 "garbage" 和格式良好的 JSON 对象同样合法。保证来自 application 层边界:Pydantic 在每次写入前和读取后都会校验 Resource.config。领域层的 Kind.config_schema 是一个 Pydantic BaseModel 子类;应用层服务对每一个传入的 config dict 调用 .model_validate(),在写入前调用 .model_dump(mode="json")。未经验证的数据永远不会到达 SQLite,从 SQLite 读出的数据也都会经过 Pydantic 重新验证。

序列化注意事项

使用了 AnyUrldatetime 等类型的 Pydantic 字段,在传给 json.dumps() 之前必须使用 model_dump(mode="json") 进行序列化。默认的 model_dump() 会将这些类型保留为 Python 对象,而 json.dumps 无法处理它们。这是一条强制约定,而非可选的风格选择。

Alembic 迁移

Schema 演化由 Alembic 管理,配置文件为 backend/alembic.ini,迁移历史位于 backend/coffer/infrastructure/persistence/migrations/ 下的单一迁移序列。随着各个 spec 陆续落地,已累积了二十个修订版本(00010020)——每个需要新表的 spec 都会新增一个修订版本,而不是修改已有的。前三个搭建起 MCP 控制面:

修订版本文件创建内容
000120260520_0001_initial.pyresourcesaudit_logretention_policies
000220260521_0002_mcp_tables.pymcp_capability_preferencesmcp_invocations
000320260522_0003_mcp_server_health.pymcp_server_health

后续修订版本陆续加入了 skill、knowledge、memory、embedding 配置、chat、channel、credentials 和 sync 等表(以及若干索引和数据修复修订版本),止于 0020。在 daemon 首次启动时,alembic upgrade head 会在 HTTP 服务开始接受连接之前运行。由于 Alembic 迁移作为数据文件被打包进 PyInstaller daemon 二进制文件,最终用户的安装在首次启动时也能正确创建 schema,无需单独的迁移步骤。

数据库表概览

应用所有修订版本后存在的表,按领域分组:

核心(与 kind 无关):

数据表用途
resources所有用户管理资源的与 kind 无关的注册表。每个已注册的 MCP 服务器(或未来的其他 kind)对应一行。包含 kindnameconfig_jsonenabled 标志和时间戳。
audit_log所有资源或能力生命周期变更的仅追加历史记录。记录事件类型、actor、resource ref、时间戳和结构化 JSON payload。
retention_policies每个可剪裁表对应一行,记录配置的保留窗口(天数或永久保留)以及最近一次剪裁的元数据。

MCP 网关:

数据表用途
mcp_capability_preferences持久化用户对每个已注册 MCP 服务器的逐能力启用/禁用决策。在上游重启和 schema 变更后依然有效。resource 删除时级联删除。
mcp_invocations网关中每次工具、资源和提示词调用的时序日志:服务器名称、能力键、耗时、状态、会话 ID。永远不存储参数或返回内容。
mcp_server_health每个已注册 MCP 服务器的最新健康状态(healthy / failing / unknown),在每次健康检查时写入。

凭据与 embedding:

数据表用途
credentials信封加密的密钥存储:每个密钥在到达 SQLite 之前都用主密钥进行 Fernet 加密。明文永远不会落盘。参阅安全和 ADR-015。
embedding_config检索索引所使用的当前 embedding 提供方/模型配置。

知识基底 (substrate):

数据表用途
documents每个知识库/记忆文档对应一行,与磁盘上的 markdown 文件相互映射。
chunks检索流水线从 markdown 切分出的逐文档 chunk 行。
documents_fts支撑对 chunk 文本进行关键词搜索的 FTS5 虚拟表。
sqlite-vec每个 store 一个 vec0 虚拟表(按 store 惰性创建,以 kind + 维度命名),保存 chunk embedding 用于向量搜索。

记忆 (memory):

数据表用途
memory_projection_bindings记录某个记忆 store 被投影到哪个 agent/项目。
memory_store_project_roots将记忆项目 store 映射到其磁盘上的项目根目录。

聊天 (chat):

数据表用途
conversations每个聊天会话对应一行,包含归档/保留时间戳。
chat_messages每个会话中的消息。随会话一同级联删除。
chat_models用户配置的聊天模型定义。

通道 (channel):

数据表用途
channel_peers已配对的通知通道对端(例如 Telegram / SeaTalk)。

技能 (skill):

数据表用途
skill_agent_bindings记录哪些技能绑定到哪些 agent 工作区。

同步 (sync):

数据表用途
sync_config用户的多机同步配置(远端、分支、开关)。
sync_state上次同步的记账信息(commit ref、冲突状态)。

文件即事实源,SQLite 是可重建的索引(ADR-012)

上述控制面表是其行的事实记录方。知识基底则不同:~/.coffer/knowledge/~/.coffer/memory/ 下的 markdown 文件才是事实源,而 SQLite 检索索引(documents / chunks / documents_fts FTS5 表以及每个 store 的 sqlite-vec 虚拟表)是这些文件的一个完全可重建的投影。

这消除了双事实源问题:如果索引损坏、丢失或经历了 schema 迁移,它会从文件重新生成。coffer kb reindex 会从磁盘上的 markdown 重建它。备份就是一棵目录树;损坏恢复就是一次 reindex。

级联与完整性规则

Schema 强制执行了几条仅靠应用层无法表达的不变量:

  • 删除资源会级联删除 mcp_capability_preferences(通过 ON DELETE CASCADE)。但不会级联删除 audit_logmcp_invocations——即使服务器被删除,历史记录也会被保留。
  • kindname 一旦写入就不可变。应用层永远不会发出 UPDATE resources SET kind=?UPDATE resources SET name=?。重命名意味着先删除再重新注册。
  • retention_policies 中的行在 daemon 启动时进行 upsert,永不删除。应用层将其视为始终存在的配置。

~/.coffer/ 下的所有文件

Coffer 写入的完整文件集合:

路径内容
~/.coffer/coffer.dbSQLite 数据库(WAL 模式)——事实记录方
~/.coffer/daemon.jsonDaemon PID、端口和 bearer token(权限位 0600
~/.coffer/master.key凭据存储主密钥(默认文件存储;可选钥匙串)。参阅安全
~/.coffer/knowledge/以 markdown 形式存放的知识库文档——由 SQLite 索引的事实源
~/.coffer/memory/以 markdown 形式存放的记忆 fact——由 SQLite 索引的事实源
~/.coffer/sync/镜像各文件树、用于多机同步的 git 工作树
~/.coffer/logs/structlog 输出的结构化 JSON 日志文件
~/.coffer/bin/由桌面应用部署的 coffer-mcp-shimcoffer-daemon 二进制文件
~/.coffer/backups/按时间点的 SQLite 备份副本
~/.coffer/upstream-pids/用于会话追踪的每个上游子进程的 PID 文件

将所有文件统一置于一个父目录下,使备份变得简单,迁移路径清晰,彻底卸载也能做到完整。daemon 的检测-或-拉起协议(ADR-006)也因此受益:每一个需要查找 daemon 的进程都读取 ~/.coffer/daemon.json——没有注册表,没有环境变量,也不需要探测任何平台特定的服务目录。

保留策略默认值

daemon 启动时的 RetentionService.initialize_defaults() 调用会在 retention_policies 表行不存在时进行初始化。这些种子值在组装入口 (composition root) 定义,而非在迁移文件中,这样后续规范引入的新可剪裁表无需新的迁移修订即可注册各自的默认值:

策略动作默认保留期
audit_log删除早于窗口的行365 天
mcp_invocations删除早于窗口的行30 天
conversations_archive自动归档闲置达到指定天数的会话7 天
conversations在归档后达到指定天数时删除已归档会话(连同其消息)30 天

会话遵循两阶段生命周期:闲置线程先被自动归档,已归档线程稍后被删除。任意策略均可通过 PATCH /api/v1/retention/{table_name} 或等效的 CLI 命令由用户修改;变更本身会被审计。

另请参阅