@lark-apaas/miaoda-cli 0.1.2-alpha.4d0ff57 → 0.1.2-alpha.51197c2

package/dist/api/db/api.js

@@ -5,10 +5,14 @@ exports.getSchema = getSchema;
 exports.importData = importData;
 exports.exportData = exportData;
 exports.listDDLChangelog = listDDLChangelog;
+exports.getAuditStatus = getAuditStatus;
 exports.setAuditConfig = setAuditConfig;
+exports.listAuditLog = listAuditLog;
 exports.migrationInit = migrationInit;
 exports.migrate = migrate;
+exports.getMigrationStatus = getMigrationStatus;
 exports.recover = recover;
+exports.getRecoveryPreview = getRecoveryPreview;
 exports.getDbQuota = getDbQuota;
 const http_1 = require("../../utils/http");
 const error_1 = require("../../utils/error");
@@ -31,6 +35,22 @@ async function mapDbHttpError(err, url, ctx,
 onErrorBody) {
     if (err instanceof error_1.AppError)
         throw err;
+    // 客户端超时 / abort：SdkHttpError 时 response 通常缺失（status=0），落到 throw 时
+    // message 形如 'Failed to recover: 0' 让用户看不懂。识别 abort / timeout 关键字
+    // 转成专用错误码 + 友好 hint。
+    if (err instanceof Error) {
+        const msg = err.message.toLowerCase();
+        if (msg.includes("aborted") ||
+            msg.includes("timeout") ||
+            err.name === "AbortError" ||
+            err.name === "TimeoutError") {
+            throw new error_1.AppError("REQUEST_TIMEOUT", `${ctx}: request timed out`, {
+                next_actions: [
+                    "Server-side async tasks may take up to 60s. Retry the command if the underlying task likely succeeded.",
+                ],
+            });
+        }
+    }
     if (err instanceof http_client_1.HttpError) {
         const status = err.response?.status ?? 0;
         const statusText = err.response?.statusText ?? "";
@@ -332,13 +352,35 @@ async function listDDLChangelog(opts) {
         hasMore: Boolean(data.hasMore),
     };
 }
-// ── db audit → InnerAdminSetAuditConfig ──
+// ── db audit → InnerAdminGetAuditStatus / InnerAdminSetAuditConfig ──
+/**
+ * 后端：GET /v1/dataloom/app/{appId}/db/audit/status?table=&dbBranch=
+ * 查表审计开关状态。table 非空 → 单表过滤；空 → 返当前 workspace 全部已配置表。
+ */
+async function getAuditStatus(opts) {
+    const client = (0, http_1.getHttpClient)();
+    const url = (0, client_1.buildInnerUrl)(opts.appId, "/db/audit/status", {
+        table: opts.table,
+        dbBranch: opts.dbBranch,
+    });
+    const start = Date.now();
+    let response;
+    try {
+        response = await client.get(url);
+        (0, client_1.traceHttp)("GET", url, start, response);
+    }
+    catch (err) {
+        (0, client_1.traceHttp)("GET", url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
+        await mapDbHttpError(err, url, "Failed to get audit status");
+        throw err; // 不可达
+    }
+    const respBody = (await response.json());
+    const data = (0, client_1.extractData)(respBody);
+    return data.items ?? [];
+}
 /**
  * 后端：POST /v1/dataloom/app/{appId}/db/audit/config
  * 写：enabled=true 开启 / false 关闭。retention 仅 enabled=true 生效。
- *
- * 读路径（status / log）不在此模块——CLI handler 走 execSql 直接 SELECT
- * `_dl_audit_config` / `_dl_audit_log` 元数据表。
  */
 async function setAuditConfig(opts) {
     const client = (0, http_1.getHttpClient)();
@@ -369,6 +411,51 @@ async function setAuditConfig(opts) {
     }
     return data.status;
 }
+// ── db audit log → InnerAdminListAuditLog ──
+/**
+ * 后端：GET /v1/dataloom/app/{appId}/db/audit/log?tables=&since=&until=&limit=&cursor=&dbBranch=
+ *
+ * 走 admin-inner 接口而不是 InnerAdminExecuteSQL 直接 SELECT pg_audit：
+ *   - operator 在 details JSONB 内是 user_id，服务端解析成 username
+ *   - summary 后端按 type + before/after diff 合成（pg_audit 表无此列）
+ *   - before/after JSONB 后端 JSON.stringify 后透传字符串，CLI 按需 parse
+ *
+ * 多表用逗号拼接走 query；后端按 target_table IN (...) 一次查。skipped 字段返
+ * 多表中无记录的表名，便于 CLI 展示 hint。
+ */
+async function listAuditLog(opts) {
+    if (opts.tables.length === 0) {
+        throw new error_1.AppError("ARGS_INVALID", "at least one table is required");
+    }
+    const client = (0, http_1.getHttpClient)();
+    const url = (0, client_1.buildInnerUrl)(opts.appId, "/db/audit/log", {
+        tables: opts.tables.join(","),
+        since: opts.since,
+        until: opts.until,
+        limit: opts.limit !== undefined ? String(opts.limit) : undefined,
+        cursor: opts.cursor,
+        dbBranch: opts.dbBranch,
+    });
+    const start = Date.now();
+    let response;
+    try {
+        response = await client.get(url);
+        (0, client_1.traceHttp)("GET", url, start, response);
+    }
+    catch (err) {
+        (0, client_1.traceHttp)("GET", url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
+        await mapDbHttpError(err, url, "Failed to list audit log");
+        throw err; // 不可达
+    }
+    const body = (await response.json());
+    const data = (0, client_1.extractData)(body);
+    return {
+        items: data.items ?? [],
+        nextCursor: data.nextCursor && data.nextCursor !== "" ? data.nextCursor : null,
+        hasMore: Boolean(data.hasMore),
+        skipped: data.skipped ?? [],
+    };
+}
 // ── db migration → InnerAdminMigrationInit / InnerAdminMigrate ──
 /**
  * 后端：POST /v1/dataloom/app/{appId}/db/enableMultiEnv
@@ -415,6 +502,31 @@ async function migrate(opts) {
     const respBody = (await response.json());
     return (0, client_1.extractData)(respBody);
 }
+/**
+ * 后端：GET /v1/dataloom/app/{appId}/db/migration/status?taskId=...
+ * CLI 拿到 migration apply 的 taskId 后定时调本接口，直到 status=success/failed。
+ * 网络层超时仍走 mapDbHttpError → 单次 30s；轮询节奏由 CLI handler 自行控制。
+ */
+async function getMigrationStatus(opts) {
+    const client = (0, http_1.getHttpClient)();
+    const url = (0, client_1.buildInnerUrl)(opts.appId, "/db/migration/status", {
+        taskId: opts.taskId,
+        dbBranch: opts.dbBranch,
+    });
+    const start = Date.now();
+    let response;
+    try {
+        response = await client.get(url);
+        (0, client_1.traceHttp)("GET", url, start, response);
+    }
+    catch (err) {
+        (0, client_1.traceHttp)("GET", url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
+        await mapDbHttpError(err, url, "Failed to get migration status");
+        throw err; // 不可达
+    }
+    const body = (await response.json());
+    return (0, client_1.extractData)(body);
+}
 // ── db recovery → InnerAdminRecover ──
 /**
  * 后端：POST /v1/dataloom/app/{appId}/db/recovery
@@ -440,6 +552,30 @@ async function recover(opts) {
     const respBody = (await response.json());
     return (0, client_1.extractData)(respBody);
 }
+/**
+ * 后端：GET /v1/dataloom/app/{appId}/db/recovery/preview?previewRequestId=...
+ * CLI 拿到 recovery diff 的 previewRequestId 后定时调本接口直到 previewStatus=success/failed。
+ */
+async function getRecoveryPreview(opts) {
+    const client = (0, http_1.getHttpClient)();
+    const url = (0, client_1.buildInnerUrl)(opts.appId, "/db/recovery/preview", {
+        previewRequestId: opts.previewRequestId,
+        dbBranch: opts.dbBranch,
+    });
+    const start = Date.now();
+    let response;
+    try {
+        response = await client.get(url);
+        (0, client_1.traceHttp)("GET", url, start, response);
+    }
+    catch (err) {
+        (0, client_1.traceHttp)("GET", url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
+        await mapDbHttpError(err, url, "Failed to get recovery preview");
+        throw err; // 不可达
+    }
+    const body = (await response.json());
+    return (0, client_1.extractData)(body);
+}
 // ── db quota → InnerAdminGetDbQuota ──
 /**
  * 后端：GET /v1/dataloom/app/{appId}/db/quota?dbBranch=

package/dist/api/db/client.js

@@ -140,7 +140,7 @@ const BIZ_ERR_MAP = new Map(Object.entries({
     },
     k_dl_1310003: {
         code: "INVALID_RETENTION",
-        hint: "Allowed values: 7d / 30d / 180d / 360d.",
+        hint: "Allowed values: 7d, 30d, 180d, 360d, forever.",
     },
     // migration
     k_dl_1320001: {

package/dist/api/db/index.js

@@ -1,16 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pickTableDetail = exports.flattenSchemaList = exports.parseSqlResult = exports.SQLSTATE_MAP = exports.ensureInnerSuccess = exports.buildInnerUrl = exports.getDbQuota = exports.recover = exports.migrate = exports.migrationInit = exports.setAuditConfig = exports.listDDLChangelog = exports.exportData = exports.importData = exports.getSchema = exports.execSql = void 0;
+exports.pickTableDetail = exports.flattenSchemaList = exports.parseSqlResult = exports.SQLSTATE_MAP = exports.ensureInnerSuccess = exports.buildInnerUrl = exports.getDbQuota = exports.getRecoveryPreview = exports.recover = exports.getMigrationStatus = exports.migrate = exports.migrationInit = exports.listAuditLog = exports.setAuditConfig = exports.getAuditStatus = exports.listDDLChangelog = exports.exportData = exports.importData = exports.getSchema = exports.execSql = void 0;
 var api_1 = require("./api");
 Object.defineProperty(exports, "execSql", { enumerable: true, get: function () { return api_1.execSql; } });
 Object.defineProperty(exports, "getSchema", { enumerable: true, get: function () { return api_1.getSchema; } });
 Object.defineProperty(exports, "importData", { enumerable: true, get: function () { return api_1.importData; } });
 Object.defineProperty(exports, "exportData", { enumerable: true, get: function () { return api_1.exportData; } });
 Object.defineProperty(exports, "listDDLChangelog", { enumerable: true, get: function () { return api_1.listDDLChangelog; } });
+Object.defineProperty(exports, "getAuditStatus", { enumerable: true, get: function () { return api_1.getAuditStatus; } });
 Object.defineProperty(exports, "setAuditConfig", { enumerable: true, get: function () { return api_1.setAuditConfig; } });
+Object.defineProperty(exports, "listAuditLog", { enumerable: true, get: function () { return api_1.listAuditLog; } });
 Object.defineProperty(exports, "migrationInit", { enumerable: true, get: function () { return api_1.migrationInit; } });
 Object.defineProperty(exports, "migrate", { enumerable: true, get: function () { return api_1.migrate; } });
+Object.defineProperty(exports, "getMigrationStatus", { enumerable: true, get: function () { return api_1.getMigrationStatus; } });
 Object.defineProperty(exports, "recover", { enumerable: true, get: function () { return api_1.recover; } });
+Object.defineProperty(exports, "getRecoveryPreview", { enumerable: true, get: function () { return api_1.getRecoveryPreview; } });
 Object.defineProperty(exports, "getDbQuota", { enumerable: true, get: function () { return api_1.getDbQuota; } });
 var client_1 = require("./client");
 Object.defineProperty(exports, "buildInnerUrl", { enumerable: true, get: function () { return client_1.buildInnerUrl; } });

package/dist/cli/commands/db/index.js

@@ -218,17 +218,49 @@ Examples:
     dbCmd
         .command("changelog")
         .summary("查看 DDL 变更历史")
-        .description("列出 DDL 变更（CREATE / ALTER / DROP），支持按表、时间窗筛选与游标分页。")
+        .description("查看 DDL 变更记录（建表、改表、删表等）。默认按时间倒序显示，可按表名或时间范围过滤。")
         .usage("[flags]")
-        .option("--table <name>", "只看某张表的 DDL 变更")
-        .option("--since <time>", "起始时间（含），相对 1h/2d / 日期 YYYY-MM-DD / ISO 8601")
-        .option("--until <time>", "结束时间（含），同 --since 格式")
-        .option("--limit <n>", "单次返回上限（默认 20）", parsePositiveInt, 20)
-        .option("--cursor <token>", "分页游标，从上次响应的 next_cursor 取值")
-        .option("--all", "自动翻页直到取完所有记录")
+        .option("--table <name>", "按表名过滤")
+        .option("--since <time>", "起始时间，支持 YYYY-MM-DD（按当日 00:00:00 UTC）/ ISO 8601（如 2026-04-01T10:00:00Z）/ 相对时间（1h、2d、1w）")
+        .option("--until <time>", "截止时间，格式同 --since")
+        .option("--limit <n>", "返回条数上限（默认 20）", parsePositiveInt, 20)
+        .option("--cursor <token>", "从上一页返回的游标位置继续获取")
+        .option("--all", "获取全部结果，自动翻页")
         .action(async function () {
         await (0, index_1.handleDbChangelog)(this.optsWithGlobals());
-    });
+    })
+        .addHelpText("after", `
+Notes:
+  - DDL 变更由系统自动记录，不可关闭，无需单独开启。
+  - 默认输出展示摘要（summary），完整 SQL 原文（statement）通过 --json 获取。
+
+Examples:
+  # 列出近期变更（statement 截断展示，完整 SQL 用 --json 获取）
+  $ miaoda db changelog
+  change_id          changed_at             operator   target_table   change_type             summary
+  1862462453263587   2026-04-16 13:24:59    zqy        users          ALTER_AUDIT_RETENTION   修改记录日志周期
+  1861814222210116   2026-04-08 20:12:37    zqy        users          CREATE_TABLE            创建并修改数据表
+
+  # 按条件过滤
+  $ miaoda db changelog --table users --since 2026-04-01
+  $ miaoda db changelog --limit 5
+
+  # JSON 输出包含完整 statement
+  $ miaoda db changelog --limit 1 --json
+  {
+    "data": [{
+      "change_id": "1861814222210116",
+      "changed_at": "2026-04-08T20:12:37Z",
+      "operator": "zqy",
+      "target_table": "users",
+      "change_type": "CREATE_TABLE",
+      "summary": "创建并修改数据表",
+      "statement": "CREATE TABLE ... ;"
+    }],
+    "next_cursor": null,
+    "has_more": false
+  }
+`);
     // ── audit ──
     const auditCmd = dbCmd
         .command("audit")
@@ -240,42 +272,136 @@ Examples:
     });
     auditCmd
         .command("status")
-        .summary("查看审计开关状态（不传 table 返列表）")
+        .summary("查看审计开关状态")
+        .description("查看表的审计开关状态。不指定表则显示全部。")
         .usage("[table] [flags]")
         .argument("[table]", "表名；省略时返所有已配置审计的表")
         .action(async function (table) {
         await (0, index_1.handleDbAuditStatus)(table, this.optsWithGlobals());
-    });
+    })
+        .addHelpText("after", `
+Examples:
+  # 全部表
+  $ miaoda db audit status
+  table     enabled   enabled_at            retention
+  users     yes       2026-04-01 08:00:00   30d
+  orders    no        —                     —
+  products  yes       2026-03-15 10:30:00   forever
+
+  # 单表
+  $ miaoda db audit status users
+       Table:  users
+     Enabled:  yes
+  Enabled at:  2026-04-01 08:00:00
+   Retention:  30d
+
+  # JSON
+  $ miaoda db audit status --json
+  $ miaoda db audit status users --json
+`);
     auditCmd
         .command("enable")
         .summary("启用表审计")
+        .description("开启指定表的审计，记录每次 INSERT / UPDATE / DELETE 操作。")
         .usage("<table> [flags]")
         .argument("<table>", "目标表名")
-        .option("--retention <ttl>", "保留时长 7d / 30d / 180d / 360d", "7d")
+        .option("--retention <period>", "审计日志保留时长，可选 7d / 30d / 180d / 360d / forever", "7d")
         .action(async function (table) {
         await (0, index_1.handleDbAuditEnable)(table, this.optsWithGlobals());
-    });
+    })
+        .addHelpText("after", `
+Notes:
+  - 开启审计会占用额外存储空间，计入应用的存储配额。
+  - 用 \`miaoda db quota\` 查看用量；用 \`miaoda db audit disable\` 或调整 --retention 控制开销。
+
+Examples:
+  # 默认保留 7 天
+  $ miaoda db audit enable orders
+  ✓ Audit enabled for table 'orders' (retention: 7d)
+
+  # 指定保留时长 / 永久保留
+  $ miaoda db audit enable orders --retention 180d
+  $ miaoda db audit enable orders --retention forever
+
+  # JSON
+  $ miaoda db audit enable orders --retention 180d --json
+
+  # 报错：已经开启
+  $ miaoda db audit enable orders
+  Error: Audit is already enabled for table 'orders'
+    hint: Use \`miaoda db audit status orders\` to check current retention,
+          or run this command with a different --retention to update.
+
+  # 报错：retention 值非法
+  $ miaoda db audit enable orders --retention 60d
+  Error: Invalid retention '60d'
+    hint: Allowed values: 7d, 30d, 180d, 360d, forever.
+`);
     auditCmd
         .command("disable")
         .summary("关闭表审计")
+        .description("关闭指定表的审计。")
         .usage("<table> [flags]")
         .argument("<table>", "目标表名")
         .action(async function (table) {
         await (0, index_1.handleDbAuditDisable)(table, this.optsWithGlobals());
-    });
+    })
+        .addHelpText("after", `
+Examples:
+  $ miaoda db audit disable orders
+  ✓ Audit disabled for table 'orders'
+
+  # JSON
+  $ miaoda db audit disable orders --json
+
+  # 报错：未开启
+  $ miaoda db audit disable orders
+  Error: Audit is not enabled for table 'orders'
+    hint: Use \`miaoda db audit status\` to see which tables have audit enabled.
+`);
     auditCmd
         .command("list")
         .summary("查询审计日志")
-        .description("按表 + 时间窗查询审计日志（INSERT / UPDATE / DELETE）。")
+        .description("查询一个或多个表的审计日志记录。多表查询时输出会带 target_table 列标识每条记录所属的表。")
         .usage("<table...> [flags]")
-        .argument("<tables...>", "一个或多个表名（多表时空表会汇总到 stderr）")
-        .option("--since <time>", "起始时间")
-        .option("--until <time>", "结束时间")
-        .option("--limit <n>", "单次返回上限（默认 50）", parsePositiveInt, 50)
-        .option("--cursor <ts>", "分页游标，传上一页末条 event_time")
+        .argument("<tables...>", "一个或多个表名")
+        .option("--since <time>", "起始时间，支持 YYYY-MM-DD / ISO 8601 / 相对时间（同 changelog --since）")
+        .option("--until <time>", "截止时间，格式同 --since")
+        .option("--limit <n>", "返回条数上限（默认 20）", parsePositiveInt, 20)
+        .option("--cursor <token>", "从上一页返回的游标位置继续获取")
+        .option("--all", "获取全部结果，自动翻页")
         .action(async function (tables) {
         await (0, index_1.handleDbAuditList)(tables, this.optsWithGlobals());
-    });
+    })
+        .addHelpText("after", `
+Notes:
+  - 默认输出展示变更摘要（summary），完整变更快照（details 含 before / after）通过 --json 获取。
+  - 多表查询时不可用的表（未开启审计或不存在）会被跳过而非整体失败，全部不可用才返回错误。
+  - 退出码：只要有任何一张表有结果即为 0（跳过不算失败）；全部不可用才为 1。
+
+Examples:
+  # 单表
+  $ miaoda db audit list users --limit 5
+
+  # 多表（输出带 target_table 列区分来源）
+  $ miaoda db audit list users orders --limit 5
+
+  # 按时间范围
+  $ miaoda db audit list users --since 2026-04-14 --limit 10
+
+  # JSON（含完整 details / before / after）
+  $ miaoda db audit list users --limit 1 --json
+
+  # 报错：单表未开启
+  $ miaoda db audit list orders
+  Error: Audit is not enabled for table 'orders'
+    hint: Run \`miaoda db audit enable orders\` to start recording changes.
+
+  # 多表全部不可用才整体报错
+  $ miaoda db audit list orders invoices
+  Error: No audit data available for any of the specified tables
+    hint: Check audit status with \`miaoda db audit status\`.
+`);
     // ── migration ──
     const migrationCmd = dbCmd
         .command("migration")
@@ -287,28 +413,106 @@ Examples:
     });
     migrationCmd
         .command("init")
-        .summary("初始化多环境（不可逆）")
+        .summary("初始化多环境模式（dev / online）")
+        .description("初始化多环境模式（dev / online）。初始化后，dev 环境的数据库结构变更需要经 `migration apply` " +
+        "应用到 online；online 将无法直接更改数据库结构（仍可进行数据 DML 操作）。")
         .usage("[flags]")
-        .option("--sync-data", "同时把现有数据复制到 dev")
-        .option("--yes", "跳过 TTY 确认")
+        .option("--sync-data", "启用时将现有数据同步一份到 dev 环境")
+        .option("-y, --yes", "跳过确认提示直接执行")
         .action(async function () {
         await (0, index_1.handleDbMigrationInit)(this.optsWithGlobals());
-    });
+    })
+        .addHelpText("after", `
+Notes:
+  - 多环境模式一旦启用无法恢复为单库模式，请确认后再启用。
+
+Examples:
+  # TTY 下会要求确认
+  $ miaoda db migration init
+  ? This action is irreversible. Initialize multi-env (dev / online)? (y/N) y
+  ✓ Multi-env initialized (dev / online)
+
+  # --yes 跳过确认（Agent / CI 场景）
+  $ miaoda db migration init --sync-data --yes
+  ✓ Multi-env initialized, data synced to dev
+
+  # JSON
+  $ miaoda db migration init --yes --json
+  {"data": {"status": "initialized", "environments": ["dev", "online"], "data_synced": false}}
+
+  # 报错：已经初始化过
+  $ miaoda db migration init
+  Error: Multi-env is already initialized
+    hint: Run \`miaoda db migration diff\` to view pending changes.
+`);
     migrationCmd
         .command("diff")
         .summary("预览 dev → online 待发布变更")
+        .description("预览 dev → online 的待发布变更。只读预览，不会实际发布。")
         .usage("[flags]")
         .action(async function () {
         await (0, index_1.handleDbMigrationDiff)(this.optsWithGlobals());
-    });
+    })
+        .addHelpText("after", `
+Examples:
+  $ miaoda db migration diff
+  dev → online (2 changes):
+
+    ALTER TABLE users ADD COLUMN avatar_url text;
+    CREATE INDEX idx_users_avatar ON users(avatar_url);
+
+  # JSON
+  $ miaoda db migration diff --json
+
+  # 报错：无待发布变更
+  $ miaoda db migration diff
+  Error: No pending changes between dev and online
+    hint: Make schema changes in dev first (e.g. \`miaoda db sql "ALTER TABLE ..." --env dev\`).
+
+  # 报错：多环境未初始化
+  $ miaoda db migration diff
+  Error: Multi-env is not initialized
+    hint: Run \`miaoda db migration init\` to set up multi-env first.
+`);
     migrationCmd
         .command("apply")
-        .summary("应用 dev 变更到 online（多 DDL 单事务原子）")
+        .summary("将 dev 的变更发布到 online（单事务原子）")
+        .description("将 dev 的变更发布到 online。")
         .usage("[flags]")
-        .option("--yes", "跳过 TTY 二次确认")
+        .option("-y, --yes", "跳过确认提示直接执行")
         .action(async function () {
         await (0, index_1.handleDbMigrationApply)(this.optsWithGlobals());
-    });
+    })
+        .addHelpText("after", `
+Notes:
+  - 该操作会直接改动线上数据库，建议先用 \`migration diff\` 确认变更。
+  - 变更以单事务执行：多条 DDL 任何一条失败整批回滚，online 保持原状态。
+  - 退出码：0 表示全部成功；1 表示已回滚。
+
+Examples:
+  # TTY 下会要求确认
+  $ miaoda db migration apply
+  ? Apply 2 changes to online? (y/N) y
+  ✓ Applied dev → online (2 changes)
+
+  # --yes 跳过确认
+  $ miaoda db migration apply --yes
+  ✓ Applied dev → online (2 changes)
+
+  # JSON
+  $ miaoda db migration apply --yes --json
+  {"data": {"status": "applied", "from": "dev", "to": "online", "changes_applied": 2}}
+
+  # 报错：无待发布变更
+  $ miaoda db migration apply
+  Error: No pending changes to apply
+    hint: Make schema changes in dev first, then run \`miaoda db migration diff\` to preview.
+
+  # 报错：多环境未启用
+  $ miaoda db migration apply
+  Error: Multi-env is not initialized
+    hint: Run \`miaoda db migration init\` to set up multi-env first.
+`);
     // ── recovery（PITR）──
     const recoveryCmd = dbCmd
         .command("recovery")
@@ -321,26 +525,119 @@ Examples:
     recoveryCmd
         .command("diff")
         .summary("预览恢复到指定时间点的影响范围")
+        .description("预览恢复到指定时间点的影响范围（受影响的表、数据变更量、预计耗时）。只读预览，不改动数据。")
         .usage("<timestamp> [flags]")
-        .argument("<timestamp>", "目标时间，YYYY-MM-DD / YYYY-MM-DD HH:MM[:SS] / ISO 8601")
+        .argument("<timestamp>", "目标时间，YYYY-MM-DD 或 ISO 8601（如 2026-04-15T10:00:00Z）")
         .action(async function (target) {
         await (0, index_1.handleDbRecoveryDiff)(target, this.optsWithGlobals());
-    });
+    })
+        .addHelpText("after", `
+Notes:
+  - 超出可恢复窗口的时间点会报错，错误信息中会标注当前可恢复窗口。
+
+Examples:
+  # TTY pretty
+  $ miaoda db recovery diff 2026-04-15T10:00:00Z
+  Recovery preview (→ 2026-04-15T10:00:00Z):
+
+    tables affected: 2
+    users:   +3 rows, -1 row, ~5 rows modified
+    orders:  table will be restored (was dropped at 10:25:00)
+
+    estimated time: ~30s
+
+  # non-TTY（管道，TAB 分列）
+  $ miaoda db recovery diff 2026-04-15T10:00:00Z | cat
+  Recovery preview (-> 2026-04-15T10:00:00Z):
+  tables_affected	2
+  users	+3 rows, -1 row, ~5 rows modified
+  orders	table will be restored (was dropped at 10:25:00)
+  estimated_time	30
+
+  # JSON
+  $ miaoda db recovery diff 2026-04-15T10:00:00Z --json
+
+  # 无变更（目标时间点与当前状态一致）
+  $ miaoda db recovery diff 2026-04-15T14:00:00Z
+  Recovery preview (→ 2026-04-15T14:00:00Z):
+
+    No changes — database is already at this state.
+
+  # 超出可恢复窗口
+  $ miaoda db recovery diff 2026-04-05T10:00:00Z
+  Error: Timestamp is outside the recoverable window
+    hint: Current recoverable window: 2026-04-09T12:00:00Z ~ 2026-04-16T12:00:00Z
+
+  # 时间格式错误
+  $ miaoda db recovery diff 2026/04/15
+  Error: Invalid timestamp format '2026/04/15'
+    hint: Use ISO 8601 format, e.g. 2026-04-15 or 2026-04-15T10:00:00Z
+`);
     recoveryCmd
         .command("apply")
-        .summary("触发恢复到指定时间点（不可逆覆盖）")
+        .summary("将数据库恢复到指定时间点的状态")
+        .description("将数据库恢复到指定时间点的状态。")
         .usage("<timestamp> [flags]")
-        .argument("<timestamp>", "目标时间，YYYY-MM-DD / YYYY-MM-DD HH:MM[:SS] / ISO 8601")
-        .option("--yes", "跳过 TTY 二次确认")
+        .argument("<timestamp>", "目标时间，YYYY-MM-DD 或 ISO 8601（如 2026-04-15T10:00:00Z）")
+        .option("-y, --yes", "跳过确认提示直接执行")
         .action(async function (target) {
         await (0, index_1.handleDbRecoveryApply)(target, this.optsWithGlobals());
-    });
+    })
+        .addHelpText("after", `
+Notes:
+  - 该操作会覆盖当前数据且不可撤销，建议先用 \`recovery diff\` 预览影响。
+  - 恢复过程是原子的：中途失败时数据库回到操作前的状态，不会出现部分恢复。
+  - 退出码：0 表示完成；1 表示已回滚。
+
+Examples:
+  # TTY 下会要求确认
+  $ miaoda db recovery apply 2026-04-15T10:00:00Z
+  ? Restore database to 2026-04-15T10:00:00Z? This will overwrite current data. (y/N) y
+  ✓ Database restored to 2026-04-15T10:00:00Z (2 tables affected, 30s elapsed)
+
+  # --yes 跳过确认
+  $ miaoda db recovery apply 2026-04-15T10:00:00Z --yes
+
+  # JSON
+  $ miaoda db recovery apply 2026-04-15T10:00:00Z --yes --json
+
+  # 超出可恢复窗口
+  $ miaoda db recovery apply 2026-04-05T10:00:00Z
+  Error: Timestamp is outside the recoverable window
+    hint: Current recoverable window: 2026-04-09T12:00:00Z ~ 2026-04-16T12:00:00Z
+          Run \`miaoda db recovery diff <ts>\` within this window to preview impact.
+
+  # 并发冲突（已有恢复任务在执行）
+  $ miaoda db recovery apply 2026-04-15T10:00:00Z
+  Error: Another recovery is already in progress
+    hint: Wait for the current recovery to finish.
+`);
     // ── quota ──
     dbCmd
         .command("quota")
-        .summary("查看数据库用量与限额")
+        .summary("查看数据库的存储用量与限额")
+        .description("查看数据库的存储用量、配额和表数量。")
         .usage("[flags]")
         .action(async function () {
         await (0, index_1.handleDbQuota)(this.optsWithGlobals());
-    });
+    })
+        .addHelpText("after", `
+Examples:
+  $ miaoda db quota
+      Storage:  14.9 MB / 1 GB (1.5%)
+       Tables:  3
+        Views:  10
+
+  # JSON
+  $ miaoda db quota --json
+  {
+    "data": {
+      "storage_used_bytes": 15623782,
+      "storage_quota_bytes": 1073741824,
+      "usage_percent": 1.5,
+      "tables": 3,
+      "views": 10
+    }
+  }
+`);
 }