v0.3.0 · latestRuntime Format 2

把现有 Markdown 变成可以运行、继续编辑的数据。

Markdown DB Engine 为应用提供事务、查询与一致性，同时保留 Obsidian、编辑器和 Agent 直接维护 Markdown Workspace 的自由。

迁移现有 Vault 创建新数据库

Apache-2.0 · 查看源码

migration previewREAD ONLY

SOURCE VAULT

◆Knowledge/Welcome.md
◆Projects/Roadmap.md
◇assets/diagram.svg

目录用于导航，不会自动成为 Collection。

SEMANTIC CONFIG

collections:
  documents:
    include:
      - Knowledge/**/*.md
      - Projects/**/*.md
    schema:
      title: string
      body: markdown

ELIGIBLE

PENDING

ASSETS

preserved

确认后：backup → apply → Based Workspaceno file moves

Choose your path

从你现在拥有的内容开始

已有 Vault、新建数据库、或者正在开发应用，都有一条可以完整执行和验证的路径。

已有 Markdown / Obsidian

先观察，再决定哪些内容进入数据库

Scan 与 Preview 保持只读。你审阅语义 Collection 和 Schema 后，Apply 自动创建外部备份，最小化写入身份字段，并把原 Vault 变成 Based Workspace。图片和 PDF 继续留在原目录。

01 scan
02 preview
03 backup + apply

查看 Obsidian 迁移指南

创建新的内容数据库

从 Embedded SDK 或 Local Server 开始，定义 Collection、写入 Record，并通过 Web UI 检查数据。

快速开始

基于 Runtime 搭建应用

检查真实 Schema，根据 Writer Host 选择 Embedded 或 Remote，建立 Repository 边界并完成生产构建。

应用搭建指南

事务与一致查询

Markdown 正式记录

受检查的原子 Merge

Credential、权限与审计

Workflow

迁移一次，之后按照正常 Workspace 工作

Config 只服务于一次性迁移。Apply 以后，Runtime 负责应用 IO；Obsidian 与 Agent 在 Based Workspace 编辑，再显式 Merge。

现有 Obsidian / Markdown

保留目录、文件名、正文和图片引用

scan → config → preview

只读分析语义 Collection、Schema、歧义与待处理文件

backup → apply

确认以后创建外部备份，写入最小身份字段并建立 Runtime

Runtime + Based Workspace

应用查询 Runtime；Obsidian 继续编辑原 Vault 和资源

merge plan → merge apply

Server 运行时通过 Remote CLI 提交修改与新文章

Verified workflow

官网上的命令，就是发布包验证过的命令

0.3.0 的公共 npm 包已经在全新目录中完成 Scan、Preview、Apply、Remote Merge 和新文章查询。

migrate-vault.sh

bash

# 1. 只读分析，报告写到 Vault 外部
npx md-db-engine init scan ./vault --output ./migration-review

# 2. 编辑 config 后反复预览
npx md-db-engine init preview ./vault \
  --config ./migration-review/mddb.init.yaml \
  --plan ./migration-review/migration-plan.json --json

# 3. 明确确认后备份并迁移
npx md-db-engine init apply ./vault \
  --plan ./migration-review/migration-plan.json \
  --database ./content.mddb --yes --json

obsidian-roundtrip.sh

bash

# Server 是唯一 Writer Host
npx md-db-engine serve ./content.mddb --open

# Obsidian 编辑完成后，通过 Server 预览并提交
md-db-engine merge plan \
  --endpoint http://127.0.0.1:3000 \
  --credentials "$MDDB_CREDENTIALS" \
  --workspace ./vault --json

md-db-engine merge apply \
  --endpoint http://127.0.0.1:3000 \
  --credentials "$MDDB_CREDENTIALS" \
  --workspace ./vault --yes --json

需要 TypeScript SDK？阅读应用搭建指南，根据 Writer Host 选择 Embedded 或 Remote。

Documentation