@lark-apaas/miaoda-cli 0.1.2 → 0.1.3-alpha.09899c4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/README.md +8 -7
  2. package/dist/api/app/api.js +25 -0
  3. package/dist/api/app/index.js +15 -0
  4. package/dist/api/app/schemas.js +79 -0
  5. package/dist/api/app/types.js +58 -0
  6. package/dist/api/db/api.js +390 -55
  7. package/dist/api/db/client.js +65 -25
  8. package/dist/api/db/index.js +12 -1
  9. package/dist/api/db/parsers.js +20 -20
  10. package/dist/api/db/sql-keywords.js +87 -87
  11. package/dist/api/deploy/api.js +60 -0
  12. package/dist/api/deploy/index.js +16 -0
  13. package/dist/api/deploy/schemas.js +105 -0
  14. package/dist/api/deploy/types.js +22 -0
  15. package/dist/api/file/api.js +89 -87
  16. package/dist/api/file/client.js +62 -22
  17. package/dist/api/file/detect.js +3 -3
  18. package/dist/api/file/index.js +2 -1
  19. package/dist/api/file/parsers.js +18 -7
  20. package/dist/api/index.js +7 -1
  21. package/dist/api/observability/api.js +52 -0
  22. package/dist/api/observability/index.js +16 -0
  23. package/dist/api/observability/schemas.js +60 -0
  24. package/dist/api/observability/types.js +27 -0
  25. package/dist/api/plugin/api.js +31 -31
  26. package/dist/cli/commands/app/index.js +62 -0
  27. package/dist/cli/commands/db/index.js +600 -59
  28. package/dist/cli/commands/deploy/index.js +155 -0
  29. package/dist/cli/commands/file/index.js +91 -63
  30. package/dist/cli/commands/index.js +10 -6
  31. package/dist/cli/commands/observability/index.js +240 -0
  32. package/dist/cli/commands/plugin/index.js +27 -27
  33. package/dist/cli/commands/shared.js +86 -10
  34. package/dist/cli/handlers/app/get.js +47 -0
  35. package/dist/cli/handlers/app/index.js +7 -0
  36. package/dist/cli/handlers/app/update.js +59 -0
  37. package/dist/cli/handlers/db/_operator.js +35 -0
  38. package/dist/cli/handlers/db/audit.js +383 -0
  39. package/dist/cli/handlers/db/changelog.js +160 -0
  40. package/dist/cli/handlers/db/data.js +34 -34
  41. package/dist/cli/handlers/db/index.js +17 -1
  42. package/dist/cli/handlers/db/migration.js +245 -0
  43. package/dist/cli/handlers/db/quota.js +68 -0
  44. package/dist/cli/handlers/db/recovery.js +387 -0
  45. package/dist/cli/handlers/db/schema.js +35 -36
  46. package/dist/cli/handlers/db/sql.js +70 -71
  47. package/dist/cli/handlers/deploy/deploy.js +84 -0
  48. package/dist/cli/handlers/deploy/error-log.js +60 -0
  49. package/dist/cli/handlers/deploy/format.js +39 -0
  50. package/dist/cli/handlers/deploy/get.js +71 -0
  51. package/dist/cli/handlers/deploy/helpers.js +41 -0
  52. package/dist/cli/handlers/deploy/history.js +70 -0
  53. package/dist/cli/handlers/deploy/index.js +14 -0
  54. package/dist/cli/handlers/deploy/polling.js +162 -0
  55. package/dist/cli/handlers/file/cp.js +31 -32
  56. package/dist/cli/handlers/file/index.js +3 -1
  57. package/dist/cli/handlers/file/ls.js +6 -7
  58. package/dist/cli/handlers/file/quota.js +66 -0
  59. package/dist/cli/handlers/file/rm.js +33 -32
  60. package/dist/cli/handlers/file/sign.js +4 -5
  61. package/dist/cli/handlers/file/stat.js +11 -11
  62. package/dist/cli/handlers/observability/analytics.js +212 -0
  63. package/dist/cli/handlers/observability/helpers.js +66 -0
  64. package/dist/cli/handlers/observability/index.js +12 -0
  65. package/dist/cli/handlers/observability/log.js +94 -0
  66. package/dist/cli/handlers/observability/metric.js +208 -0
  67. package/dist/cli/handlers/observability/trace.js +102 -0
  68. package/dist/cli/handlers/plugin/plugin-local.js +53 -53
  69. package/dist/cli/handlers/plugin/plugin.js +15 -15
  70. package/dist/cli/help.js +16 -16
  71. package/dist/main.js +13 -9
  72. package/dist/utils/args.js +8 -0
  73. package/dist/utils/colors.js +2 -2
  74. package/dist/utils/config.js +2 -2
  75. package/dist/utils/devops-error.js +28 -0
  76. package/dist/utils/error.js +2 -2
  77. package/dist/utils/git.js +29 -0
  78. package/dist/utils/http.js +119 -1
  79. package/dist/utils/index.js +15 -1
  80. package/dist/utils/output.js +373 -20
  81. package/dist/utils/poll.js +35 -0
  82. package/dist/utils/render.js +27 -27
  83. package/dist/utils/spinner.js +46 -0
  84. package/dist/utils/time.js +208 -0
  85. package/package.json +7 -5
@@ -1,30 +1,39 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.registerDbCommands = registerDbCommands;
4
+ const error_1 = require("../../../utils/error");
4
5
  const index_1 = require("../../../cli/handlers/db/index");
6
+ const shared_1 = require("../../../cli/commands/shared");
7
+ function parsePositiveInt(raw) {
8
+ const n = Number(raw);
9
+ if (!Number.isInteger(n) || n < 1) {
10
+ throw new error_1.AppError('ARGS_INVALID', `--limit must be a positive integer (got '${raw}')`);
11
+ }
12
+ return n;
13
+ }
5
14
  function registerDbCommands(program) {
6
15
  const dbCmd = program
7
- .command("db")
8
- .description("应用数据库(PostgreSQL)的命令行操作集合。")
9
- .usage("<command> [flags]")
16
+ .command('db')
17
+ .description('应用数据库(PostgreSQL)的命令行操作集合。')
18
+ .usage('<command> [flags]')
10
19
  // --env 注册在 db 父级,spec 把它列入 db --help 的 Global Flags;
11
20
  // leaf 命令仍各自接收 --env 值(commander 解析时父级 option 自动适用于子命令)
12
- .option("--env <name>", "指定目标环境(dev / online,仅专家模式应用支持)");
21
+ .option('--env <name>', '指定目标环境(dev / online,仅专家模式应用支持)');
13
22
  dbCmd.action(() => {
14
23
  dbCmd.outputHelp();
15
24
  });
16
25
  dbCmd
17
- .command("sql")
18
- .summary("执行任意 SQL(SELECT / DML / DDL,支持多条分号分隔)")
19
- .description("执行 SQL 语句,支持 SELECT、DML、DDL 等所有标准 PostgreSQL 操作。\n" +
20
- "支持通过 stdin 读取(miaoda db sql < file.sql),多条语句以分号分隔。\n" +
21
- "事务控制使用 PG 原生的 BEGIN / COMMIT / ROLLBACK 语法。")
22
- .usage("<query> [flags]")
23
- .argument("[query]", "要执行的 SQL 语句;省略时从标准输入读取")
26
+ .command('sql')
27
+ .summary('执行任意 SQL(SELECT / DML / DDL,支持多条分号分隔)')
28
+ .description('执行 SQL 语句,支持 SELECT、DML、DDL 等所有标准 PostgreSQL 操作。\n' +
29
+ '支持通过 stdin 读取(miaoda db sql < file.sql),多条语句以分号分隔。\n' +
30
+ '事务控制使用 PG 原生的 BEGIN / COMMIT / ROLLBACK 语法。')
31
+ .usage('<query> [flags]')
32
+ .argument('[query]', '要执行的 SQL 语句;省略时从标准输入读取')
24
33
  .action(async function (query) {
25
- await (0, index_1.handleDbSql)(query, this.optsWithGlobals());
34
+ await (0, index_1.handleDbSql)(query, { ...this.optsWithGlobals(), appId: (0, shared_1.resolveAppId)({}) });
26
35
  })
27
- .addHelpText("after", `
36
+ .addHelpText('after', `
28
37
  Notes:
29
38
  - SELECT 结果超过 1000 行直接报错(RESULT_SET_TOO_LARGE),不做隐式截断。
30
39
  需要分页时请在 SQL 中用 LIMIT / OFFSET。
@@ -59,23 +68,23 @@ Examples:
59
68
  `);
60
69
  // schema 二级资源分组
61
70
  const schemaCmd = dbCmd
62
- .command("schema")
63
- .summary("查看数据库表结构")
64
- .description("查看应用数据库的表结构信息。")
65
- .usage("<command> [flags]");
71
+ .command('schema')
72
+ .summary('查看数据库表结构')
73
+ .description('查看应用数据库的表结构信息。')
74
+ .usage('<command> [flags]');
66
75
  schemaCmd.action(() => {
67
76
  schemaCmd.outputHelp();
68
77
  });
69
78
  schemaCmd
70
- .command("list")
71
- .summary("列出所有表的概览(表名、行数、大小等)")
72
- .description("列出当前应用所有表的概览信息:表名、描述、行数、大小、列数、最近更新时间。\n" +
73
- "查看单表完整结构请用 `schema get`;查看 DDL 变更历史请用 `changelog`(P1)。")
74
- .usage("[flags]")
79
+ .command('list')
80
+ .summary('列出所有表的概览(表名、行数、大小等)')
81
+ .description('列出当前应用所有表的概览信息:表名、描述、行数、大小、列数、最近更新时间。\n' +
82
+ '查看单表完整结构请用 `schema get`;查看 DDL 变更历史请用 `changelog`。')
83
+ .usage('[flags]')
75
84
  .action(async function () {
76
- await (0, index_1.handleDbSchemaList)(this.optsWithGlobals());
85
+ await (0, index_1.handleDbSchemaList)({ ...this.optsWithGlobals(), appId: (0, shared_1.resolveAppId)({}) });
77
86
  })
78
- .addHelpText("after", `
87
+ .addHelpText('after', `
79
88
  Examples:
80
89
  $ miaoda db schema list
81
90
  name description rows size columns updated_at
@@ -95,17 +104,17 @@ Examples:
95
104
  }
96
105
  `);
97
106
  schemaCmd
98
- .command("get")
99
- .summary("查看单表完整结构(列定义、索引、约束)")
100
- .description("查看指定表的完整结构:列定义(含类型、可空、默认值、注释)、索引、行数、大小。\n" +
101
- "默认 pretty 输出 CREATE TABLE 的 SQL 文本;--json 输出结构化字段。")
102
- .usage("<table> [flags]")
103
- .argument("<table>", "表名(无需带 schema 前缀)")
104
- .option("--ddl", "强制输出 CREATE TABLE 建表语句(pretty 默认就是 DDL,--json 时配合此 flag 返 SQL 文本)")
107
+ .command('get')
108
+ .summary('查看单表完整结构(列定义、索引、约束)')
109
+ .description('查看指定表的完整结构:列定义(含类型、可空、默认值、注释)、索引、行数、大小。\n' +
110
+ '默认 pretty 输出 CREATE TABLE 的 SQL 文本;--json 输出结构化字段。')
111
+ .usage('<table> [flags]')
112
+ .argument('<table>', '表名(无需带 schema 前缀)')
113
+ .option('--ddl', '强制输出 CREATE TABLE 建表语句(pretty 默认就是 DDL,--json 时配合此 flag 返 SQL 文本)')
105
114
  .action(async function (table) {
106
- await (0, index_1.handleDbSchemaGet)(table, this.optsWithGlobals());
115
+ await (0, index_1.handleDbSchemaGet)(table, { ...this.optsWithGlobals(), appId: (0, shared_1.resolveAppId)({}) });
107
116
  })
108
- .addHelpText("after", `
117
+ .addHelpText('after', `
109
118
  Examples:
110
119
  $ miaoda db schema get users
111
120
  CREATE TABLE users (
@@ -126,27 +135,27 @@ Examples:
126
135
  `);
127
136
  // data 二级资源分组
128
137
  const dataCmd = dbCmd
129
- .command("data")
130
- .summary("表数据导入导出")
131
- .description("表数据的批量导入导出,适合数据备份、跨环境迁移、外部分析。")
132
- .usage("<command> [flags]");
138
+ .command('data')
139
+ .summary('表数据导入导出')
140
+ .description('表数据的批量导入导出,适合数据备份、跨环境迁移、外部分析。')
141
+ .usage('<command> [flags]');
133
142
  dataCmd.action(() => {
134
143
  dataCmd.outputHelp();
135
144
  });
136
145
  dataCmd
137
- .command("import")
138
- .summary("从本地 CSV / JSON 文件导入数据到表")
139
- .description("从本地 CSV / JSON 文件导入数据到表。整个导入是原子的——遇到任何错误(主键冲突、\n" +
140
- "类型不匹配、列名不匹配等)会回滚已插入的所有行。\n" +
141
- "不支持 SQL 文件,SQL 备份请用 `miaoda db sql < <文件>.sql` 回放。")
142
- .usage("<file> [flags]")
143
- .argument("<file>", "本地文件路径(CSV 或 JSON 格式)")
144
- .option("--table <name>", "目标表名;未指定时按文件名(不含扩展名)推断(如 users.csv → users)")
145
- .option("--format <fmt>", "文件格式 csv / json;未指定时按文件扩展名推断")
146
+ .command('import')
147
+ .summary('从本地 CSV / JSON 文件导入数据到表')
148
+ .description('从本地 CSV / JSON 文件导入数据到表。整个导入是原子的——遇到任何错误(主键冲突、\n' +
149
+ '类型不匹配、列名不匹配等)会回滚已插入的所有行。\n' +
150
+ '不支持 SQL 文件,SQL 备份请用 `miaoda db sql < <文件>.sql` 回放。')
151
+ .usage('<file> [flags]')
152
+ .argument('<file>', '本地文件路径(CSV 或 JSON 格式)')
153
+ .option('--table <name>', '目标表名;未指定时按文件名(不含扩展名)推断(如 users.csv → users)')
154
+ .option('--format <fmt>', '文件格式 csv / json;未指定时按文件扩展名推断')
146
155
  .action(async function (file) {
147
- await (0, index_1.handleDbDataImport)(file, this.optsWithGlobals());
156
+ await (0, index_1.handleDbDataImport)(file, { ...this.optsWithGlobals(), appId: (0, shared_1.resolveAppId)({}) });
148
157
  })
149
- .addHelpText("after", `
158
+ .addHelpText('after', `
150
159
  Notes:
151
160
  - 目标表必须已存在;CSV 表头 / JSON 顶层 key 必须与表字段名完全一致。
152
161
  - 导入为原子操作:遇到错误回滚所有已插入行,不会出现部分导入的中间状态。
@@ -171,19 +180,19 @@ Examples:
171
180
  \`miaoda db sql "DELETE FROM users WHERE id IN (...)"\`.
172
181
  `);
173
182
  dataCmd
174
- .command("export")
175
- .summary("导出表数据到本地 CSV / JSON / SQL 文件")
176
- .description("把指定表的所有数据导出到本地文件,支持 CSV / JSON / SQL 三种格式。")
177
- .usage("<table> [flags]")
178
- .argument("<table>", "表名(无需带 schema 前缀)")
179
- .option("--format <fmt>", "导出格式 csv / json / sql,默认 csv(sql 输出 INSERT 语句,可用 db sql < file.sql 回放)")
180
- .option("-f, --file <path>", "输出文件路径,默认 <表名>.<格式>")
181
- .option("--limit <n>", "最多导出行数(不超过 5000)")
182
- .option("--force", "输出文件已存在时覆盖(默认报错)")
183
+ .command('export')
184
+ .summary('导出表数据到本地 CSV / JSON / SQL 文件')
185
+ .description('把指定表的所有数据导出到本地文件,支持 CSV / JSON / SQL 三种格式。')
186
+ .usage('<table> [flags]')
187
+ .argument('<table>', '表名(无需带 schema 前缀)')
188
+ .option('--format <fmt>', '导出格式 csv / json / sql,默认 csv(sql 输出 INSERT 语句,可用 db sql < file.sql 回放)')
189
+ .option('-f, --file <path>', '输出文件路径,默认 <表名>.<格式>')
190
+ .option('--limit <n>', '最多导出行数(不超过 5000)')
191
+ .option('--force', '输出文件已存在时覆盖(默认报错)')
183
192
  .action(async function (table) {
184
- await (0, index_1.handleDbDataExport)(table, this.optsWithGlobals());
193
+ await (0, index_1.handleDbDataExport)(table, { ...this.optsWithGlobals(), appId: (0, shared_1.resolveAppId)({}) });
185
194
  })
186
- .addHelpText("after", `
195
+ .addHelpText('after', `
187
196
  Notes:
188
197
  - SQL 格式生成 INSERT 语句,可用 \`miaoda db sql < <文件>.sql\` 在其他环境回放。
189
198
  - 文件已存在时默认报错(FILE_ALREADY_EXISTS),用 --force 覆盖或 -f 改路径。
@@ -205,5 +214,537 @@ Examples:
205
214
  $ miaoda db data export users
206
215
  Error: Output file 'users.csv' already exists
207
216
  hint: Use -f to specify a different path, or --force to overwrite.
217
+ `);
218
+ // ── changelog ──
219
+ dbCmd
220
+ .command('changelog')
221
+ .summary('查看 DDL 变更历史')
222
+ .description('查看 DDL 变更记录(建表、改表、删表等)。默认按时间倒序显示,可按表名或时间范围过滤。')
223
+ .usage('[flags]')
224
+ .option('--table <name>', '按表名过滤')
225
+ .option('--since <time>', '起始时间')
226
+ .option('--until <time>', '截止时间')
227
+ .option('--change-id <id>', '按 change_id 精确查询单条变更记录(指定后只返该 ID 一条,JSON 仍保持数组)')
228
+ .option('--limit <n>', '返回条数上限(默认 20)', parsePositiveInt, 20)
229
+ .option('--cursor <token>', '从上一页返回的游标位置继续获取')
230
+ .option('--all', '获取全部结果,自动翻页')
231
+ .action(async function () {
232
+ await (0, index_1.handleDbChangelog)(this.optsWithGlobals());
233
+ })
234
+ .addHelpText('after', `
235
+ Notes:
236
+ - DDL 变更由系统自动记录,不可关闭,无需单独开启。
237
+ - 默认输出展示摘要(summary),完整 SQL 原文(statement)通过 --json 获取。
238
+
239
+ Examples:
240
+ # 列出近期变更(statement 截断展示,完整 SQL 用 --json 获取)
241
+ $ miaoda db changelog
242
+ change_id changed_at operator target_table change_type summary
243
+ 1862462453263587 2026-04-16 13:24:59 zqy users ALTER_AUDIT_RETENTION 修改记录日志周期
244
+ 1861814222210116 2026-04-08 20:12:37 zqy users CREATE_TABLE 创建并修改数据表
245
+
246
+ # 按条件过滤
247
+ $ miaoda db changelog --table users --since 2026-04-01
248
+ $ miaoda db changelog --limit 5
249
+
250
+ # --json 输出包含完整 statement
251
+ $ miaoda db changelog --limit 1 --json
252
+ {
253
+ "data": [{
254
+ "change_id": "1861814222210116",
255
+ "changed_at": "2026-04-08T20:12:37Z",
256
+ "operator": "zqy",
257
+ "target_table": "users",
258
+ "change_type": "CREATE_TABLE",
259
+ "summary": "创建并修改数据表",
260
+ "statement": "CREATE TABLE ... ;"
261
+ }],
262
+ "next_cursor": null,
263
+ "has_more": false
264
+ }
265
+ `);
266
+ // ── audit ──
267
+ const auditCmd = dbCmd
268
+ .command('audit')
269
+ .summary('表级数据审计开关与查询')
270
+ .description('配置表的数据审计 (enable/disable/retention),查询审计状态与日志。')
271
+ .usage('<command> [flags]');
272
+ auditCmd.action(() => {
273
+ auditCmd.outputHelp();
274
+ });
275
+ auditCmd
276
+ .command('status')
277
+ .summary('查看审计开关状态')
278
+ .description('查看表的审计开关状态。不指定表则显示全部。')
279
+ .usage('[table] [flags]')
280
+ .argument('[table]', '表名;省略时返所有已配置审计的表')
281
+ .action(async function (table) {
282
+ await (0, index_1.handleDbAuditStatus)(table, this.optsWithGlobals());
283
+ })
284
+ .addHelpText('after', `
285
+ Examples:
286
+ # 全部表
287
+ $ miaoda db audit status
288
+ table enabled enabled_at retention
289
+ users yes 2026-04-01 08:00:00 30d
290
+ orders no — —
291
+ products yes 2026-03-15 10:30:00 forever
292
+
293
+ # 单表
294
+ $ miaoda db audit status users
295
+ Table: users
296
+ Enabled: yes
297
+ Enabled at: 2026-04-01 08:00:00
298
+ Retention: 30d
299
+
300
+ # --json(全部表)
301
+ $ miaoda db audit status --json
302
+ {
303
+ "data": [
304
+ {"table": "users", "enabled": true, "enabled_at": "2026-04-01T08:00:00Z", "retention": "30d"},
305
+ {"table": "orders", "enabled": false, "enabled_at": null, "retention": null},
306
+ {"table": "products", "enabled": true, "enabled_at": "2026-03-15T10:30:00Z", "retention": "forever"}
307
+ ]
308
+ }
309
+
310
+ # --json(单表)
311
+ $ miaoda db audit status users --json
312
+ {
313
+ "data": {
314
+ "table": "users",
315
+ "enabled": true,
316
+ "enabled_at": "2026-04-01T08:00:00Z",
317
+ "retention": "30d"
318
+ }
319
+ }
320
+ `);
321
+ auditCmd
322
+ .command('enable')
323
+ .summary('启用表审计')
324
+ .description('开启指定表的审计,记录每次 INSERT / UPDATE / DELETE 操作。')
325
+ .usage('<table> [flags]')
326
+ .argument('<table>', '目标表名')
327
+ .option('--retention <period>', '审计日志保留时长,可选 7d / 30d / 180d / 360d / forever', '7d')
328
+ .action(async function (table) {
329
+ await (0, index_1.handleDbAuditEnable)(table, this.optsWithGlobals());
330
+ })
331
+ .addHelpText('after', `
332
+ Notes:
333
+ - 开启审计会占用额外存储空间,计入应用的存储配额。
334
+ - 用 \`miaoda db quota\` 查看用量;用 \`miaoda db audit disable\` 或调整 --retention 控制开销。
335
+
336
+ Examples:
337
+ # 默认保留 7 天
338
+ $ miaoda db audit enable orders
339
+ ✓ Audit enabled for table 'orders' (retention: 7d)
340
+
341
+ # 指定保留时长 / 永久保留
342
+ $ miaoda db audit enable orders --retention 180d
343
+ $ miaoda db audit enable orders --retention forever
344
+
345
+ # non-TTY
346
+ $ miaoda db audit enable orders | cat
347
+ OK Audit enabled for table 'orders' (retention: 7d)
348
+
349
+ # --json
350
+ $ miaoda db audit enable orders --retention 180d --json
351
+ {
352
+ "data": {
353
+ "table": "orders",
354
+ "enabled": true,
355
+ "retention": "180d"
356
+ }
357
+ }
358
+
359
+ # 报错:已经开启
360
+ $ miaoda db audit enable orders
361
+ Error: Audit is already enabled for table 'orders'
362
+ hint: Use \`miaoda db audit status orders\` to check current retention,
363
+ or run this command with a different --retention to update.
364
+
365
+ # 报错:retention 值非法
366
+ $ miaoda db audit enable orders --retention 60d
367
+ Error: Invalid retention '60d'
368
+ hint: Allowed values: 7d, 30d, 180d, 360d, forever.
369
+ `);
370
+ auditCmd
371
+ .command('disable')
372
+ .summary('关闭表审计')
373
+ .description('关闭指定表的审计。')
374
+ .usage('<table> [flags]')
375
+ .argument('<table>', '目标表名')
376
+ .action(async function (table) {
377
+ await (0, index_1.handleDbAuditDisable)(table, this.optsWithGlobals());
378
+ })
379
+ .addHelpText('after', `
380
+ Examples:
381
+ $ miaoda db audit disable orders
382
+ ✓ Audit disabled for table 'orders'
383
+
384
+ # non-TTY
385
+ $ miaoda db audit disable orders | cat
386
+ OK Audit disabled for table 'orders'
387
+
388
+ # --json
389
+ $ miaoda db audit disable orders --json
390
+ {
391
+ "data": {
392
+ "table": "orders",
393
+ "enabled": false
394
+ }
395
+ }
396
+
397
+ # 报错:未开启
398
+ $ miaoda db audit disable orders
399
+ Error: Audit is not enabled for table 'orders'
400
+ hint: Use \`miaoda db audit status\` to see which tables have audit enabled.
401
+ `);
402
+ auditCmd
403
+ .command('list')
404
+ .summary('查询审计日志')
405
+ .description('查询一个或多个表的审计日志记录。多表查询时输出会带 target_table 列标识每条记录所属的表。')
406
+ .usage('<table...> [flags]')
407
+ .argument('<tables...>', '一个或多个表名')
408
+ .option('--since <time>', '起始时间')
409
+ .option('--until <time>', '截止时间')
410
+ .option('--limit <n>', '返回条数上限(默认 20)', parsePositiveInt, 20)
411
+ .option('--cursor <token>', '从上一页返回的游标位置继续获取')
412
+ .option('--all', '获取全部结果,自动翻页')
413
+ .action(async function (tables) {
414
+ await (0, index_1.handleDbAuditList)(tables, this.optsWithGlobals());
415
+ })
416
+ .addHelpText('after', `
417
+ Notes:
418
+ - 默认输出展示变更摘要(summary),完整变更快照(details 含 before / after)通过 --json 获取。
419
+ - 多表查询时不可用的表(未开启审计或不存在)会被跳过而非整体失败,全部不可用才返回错误。
420
+ - 退出码:只要有任何一张表有结果即为 0(跳过不算失败);全部不可用才为 1。
421
+
422
+ Examples:
423
+ # 单表
424
+ $ miaoda db audit list users --limit 5
425
+
426
+ # 多表(输出带 target_table 列区分来源)
427
+ $ miaoda db audit list users orders --limit 5
428
+
429
+ # 按时间范围
430
+ $ miaoda db audit list users --since 2026-04-14 --limit 10
431
+
432
+ # --json(含完整 details / before / after)
433
+ $ miaoda db audit list users --limit 1 --json
434
+ {
435
+ "data": [{
436
+ "event_id": "01525416B44F87001509F20CD000000002",
437
+ "event_time": "2026-04-15T10:30:00Z",
438
+ "target_table": "users",
439
+ "type": "UPDATE",
440
+ "operator": "alice",
441
+ "details": {
442
+ "before": {"id": "ef4db805-...", "age": 28},
443
+ "after": {"id": "ef4db805-...", "age": 29}
444
+ }
445
+ }],
446
+ "next_cursor": null,
447
+ "has_more": false
448
+ }
449
+
450
+ # 报错:单表未开启
451
+ $ miaoda db audit list orders
452
+ Error: Audit is not enabled for table 'orders'
453
+ hint: Run \`miaoda db audit enable orders\` to start recording changes.
454
+
455
+ # 多表全部不可用才整体报错
456
+ $ miaoda db audit list orders invoices
457
+ Error: No audit data available for any of the specified tables
458
+ hint: Check audit status with \`miaoda db audit status\`.
459
+ `);
460
+ // ── migration ──
461
+ const migrationCmd = dbCmd
462
+ .command('migration')
463
+ .summary('多环境管理(dev / online,仅专家模式应用)')
464
+ .description('init 拆分双环境,diff 预览待发布变更,apply 把 dev 同步到 online。')
465
+ .usage('<command> [flags]');
466
+ migrationCmd.action(() => {
467
+ migrationCmd.outputHelp();
468
+ });
469
+ migrationCmd
470
+ .command('init')
471
+ .summary('初始化多环境模式(dev / online)')
472
+ .description('初始化多环境模式(dev / online)。初始化后,dev 环境的数据库结构变更需要经 `migration apply` ' +
473
+ '应用到 online;online 将无法直接更改数据库结构(仍可进行数据 DML 操作)。')
474
+ .usage('[flags]')
475
+ .option('--sync-data', '启用时将现有数据同步一份到 dev 环境')
476
+ .option('-y, --yes', '跳过确认提示直接执行')
477
+ .action(async function () {
478
+ await (0, index_1.handleDbMigrationInit)(this.optsWithGlobals());
479
+ })
480
+ .addHelpText('after', `
481
+ Notes:
482
+ - 多环境模式一旦启用无法恢复为单库模式,请确认后再启用。
483
+
484
+ Examples:
485
+ # TTY 下会要求确认
486
+ $ miaoda db migration init
487
+ ? This action is irreversible. Initialize multi-env (dev / online)? (y/N) y
488
+ ✓ Multi-env initialized (dev / online)
489
+
490
+ # --yes 跳过确认(Agent / CI 场景)
491
+ $ miaoda db migration init --sync-data --yes
492
+ ✓ Multi-env initialized, data synced to dev
493
+
494
+ # non-TTY
495
+ $ miaoda db migration init --yes | cat
496
+ OK Multi-env initialized (dev / online)
497
+
498
+ # --json
499
+ $ miaoda db migration init --yes --json
500
+ {
501
+ "data": {
502
+ "status": "initialized",
503
+ "environments": ["dev", "online"],
504
+ "data_synced": false
505
+ }
506
+ }
507
+
508
+ # 报错:已经初始化过
509
+ $ miaoda db migration init
510
+ Error: Multi-env is already initialized
511
+ hint: Run \`miaoda db migration diff\` to view pending changes.
512
+ `);
513
+ migrationCmd
514
+ .command('diff')
515
+ .summary('预览 dev → online 待发布变更')
516
+ .description('预览 dev → online 的待发布变更。只读预览,不会实际发布。')
517
+ .usage('[flags]')
518
+ .action(async function () {
519
+ await (0, index_1.handleDbMigrationDiff)(this.optsWithGlobals());
520
+ })
521
+ .addHelpText('after', `
522
+ Examples:
523
+ $ miaoda db migration diff
524
+ dev → online (2 changes):
525
+
526
+ ALTER TABLE users ADD COLUMN avatar_url text;
527
+ CREATE INDEX idx_users_avatar ON users(avatar_url);
528
+
529
+ # --json
530
+ $ miaoda db migration diff --json
531
+ {
532
+ "data": {
533
+ "from": "dev",
534
+ "to": "online",
535
+ "changes": [
536
+ {"type": "ALTER_TABLE", "table": "users", "statement": "ALTER TABLE users ADD COLUMN avatar_url text;"},
537
+ {"type": "CREATE_INDEX", "table": "users", "statement": "CREATE INDEX idx_users_avatar ON users(avatar_url);"}
538
+ ]
539
+ }
540
+ }
541
+
542
+ # 报错:无待发布变更
543
+ $ miaoda db migration diff
544
+ Error: No pending changes between dev and online
545
+ hint: Make schema changes in dev first (e.g. \`miaoda db sql "ALTER TABLE ..." --env dev\`).
546
+
547
+ # 报错:多环境未初始化
548
+ $ miaoda db migration diff
549
+ Error: Multi-env is not initialized
550
+ hint: Run \`miaoda db migration init\` to set up multi-env first.
551
+ `);
552
+ migrationCmd
553
+ .command('apply')
554
+ .summary('将 dev 的变更发布到 online(单事务原子)')
555
+ .description('将 dev 的变更发布到 online。')
556
+ .usage('[flags]')
557
+ .option('-y, --yes', '跳过确认提示直接执行')
558
+ .action(async function () {
559
+ await (0, index_1.handleDbMigrationApply)(this.optsWithGlobals());
560
+ })
561
+ .addHelpText('after', `
562
+ Notes:
563
+ - 该操作会直接改动线上数据库,建议先用 \`migration diff\` 确认变更。
564
+ - 变更以单事务执行:多条 DDL 任何一条失败整批回滚,online 保持原状态。
565
+ - 退出码:0 表示全部成功;1 表示已回滚。
566
+
567
+ Examples:
568
+ # TTY 下会要求确认
569
+ $ miaoda db migration apply
570
+ ? Apply 2 changes to online? (y/N) y
571
+ ✓ Applied dev → online (2 changes)
572
+
573
+ # --yes 跳过确认
574
+ $ miaoda db migration apply --yes
575
+ ✓ Applied dev → online (2 changes)
576
+
577
+ # non-TTY
578
+ $ miaoda db migration apply --yes | cat
579
+ OK Applied dev -> online (2 changes)
580
+
581
+ # --json
582
+ $ miaoda db migration apply --yes --json
583
+ {
584
+ "data": {
585
+ "status": "applied",
586
+ "from": "dev",
587
+ "to": "online",
588
+ "changes_applied": 2
589
+ }
590
+ }
591
+
592
+ # 报错:无待发布变更
593
+ $ miaoda db migration apply
594
+ Error: No pending changes to apply
595
+ hint: Make schema changes in dev first, then run \`miaoda db migration diff\` to preview.
596
+
597
+ # 报错:多环境未启用
598
+ $ miaoda db migration apply
599
+ Error: Multi-env is not initialized
600
+ hint: Run \`miaoda db migration init\` to set up multi-env first.
601
+ `);
602
+ // ── recovery(PITR)──
603
+ const recoveryCmd = dbCmd
604
+ .command('recovery')
605
+ .summary('基于时间点恢复(PITR)')
606
+ .description('把数据库整体恢复到指定时间点,diff 预览影响范围,apply 不可逆覆盖。')
607
+ .usage('<command> [flags]');
608
+ recoveryCmd.action(() => {
609
+ recoveryCmd.outputHelp();
610
+ });
611
+ recoveryCmd
612
+ .command('diff')
613
+ .summary('预览恢复到指定时间点的影响范围')
614
+ .description('预览恢复到指定时间点的影响范围(受影响的表、数据变更量、预计耗时)。只读预览,不改动数据。')
615
+ .usage('<timestamp> [flags]')
616
+ .argument('<timestamp>', '目标时间')
617
+ .action(async function (target) {
618
+ await (0, index_1.handleDbRecoveryDiff)(target, this.optsWithGlobals());
619
+ })
620
+ .addHelpText('after', `
621
+ Notes:
622
+ - 超出可恢复窗口的时间点会报错,错误信息中会标注当前可恢复窗口。
623
+
624
+ Examples:
625
+ # TTY pretty
626
+ $ miaoda db recovery diff 2026-04-15T10:00:00Z
627
+ Recovery preview (→ 2026-04-15T10:00:00Z):
628
+
629
+ tables affected: 2
630
+ users: +3 rows, -1 row, ~5 rows modified
631
+ orders: table will be restored (was dropped at 10:25:00)
632
+
633
+ estimated time: ~30s
634
+
635
+ # non-TTY(管道,TAB 分列)
636
+ $ miaoda db recovery diff 2026-04-15T10:00:00Z | cat
637
+ Recovery preview (-> 2026-04-15T10:00:00Z):
638
+ tables_affected 2
639
+ users +3 rows, -1 row, ~5 rows modified
640
+ orders table will be restored (was dropped at 10:25:00)
641
+ estimated_time 30
642
+
643
+ # --json
644
+ $ miaoda db recovery diff 2026-04-15T10:00:00Z --json
645
+ {
646
+ "data": {
647
+ "target": "2026-04-15T10:00:00Z",
648
+ "tables_affected": 2,
649
+ "changes": [
650
+ {"table": "users", "inserted": 3, "deleted": 1, "modified": 5},
651
+ {"table": "orders", "action": "restore_table", "dropped_at": "2026-04-15T10:25:00Z"}
652
+ ],
653
+ "estimated_seconds": 30
654
+ }
655
+ }
656
+
657
+ # 无变更(目标时间点与当前状态一致)
658
+ $ miaoda db recovery diff 2026-04-15T14:00:00Z
659
+ Recovery preview (→ 2026-04-15T14:00:00Z):
660
+
661
+ No changes — database is already at this state.
662
+
663
+ # 超出可恢复窗口
664
+ $ miaoda db recovery diff 2026-04-05T10:00:00Z
665
+ Error: Timestamp is outside the recoverable window
666
+ hint: Current recoverable window: 2026-04-09T12:00:00Z ~ 2026-04-16T12:00:00Z
667
+ (limited by last migration apply at 2026-04-09T12:00:00Z)
668
+
669
+ `);
670
+ recoveryCmd
671
+ .command('apply')
672
+ .summary('将数据库恢复到指定时间点的状态')
673
+ .description('将数据库恢复到指定时间点的状态。')
674
+ .usage('<timestamp> [flags]')
675
+ .argument('<timestamp>', '目标时间')
676
+ .option('-y, --yes', '跳过确认提示直接执行')
677
+ .action(async function (target) {
678
+ await (0, index_1.handleDbRecoveryApply)(target, this.optsWithGlobals());
679
+ })
680
+ .addHelpText('after', `
681
+ Notes:
682
+ - 该操作会覆盖当前数据且不可撤销,建议先用 \`recovery diff\` 预览影响。
683
+ - 恢复过程是原子的:中途失败时数据库回到操作前的状态,不会出现部分恢复。
684
+ - 退出码:0 表示完成;1 表示已回滚。
685
+
686
+ Examples:
687
+ # TTY 下会要求确认
688
+ $ miaoda db recovery apply 2026-04-15T10:00:00Z
689
+ ? Restore database to 2026-04-15T10:00:00Z? This will overwrite current data. (y/N) y
690
+ ✓ Database restored to 2026-04-15T10:00:00Z (2 tables affected, 30s elapsed)
691
+
692
+ # --yes 跳过确认
693
+ $ miaoda db recovery apply 2026-04-15T10:00:00Z --yes
694
+ ✓ Database restored to 2026-04-15T10:00:00Z (2 tables affected, 30s elapsed)
695
+
696
+ # non-TTY
697
+ $ miaoda db recovery apply 2026-04-15T10:00:00Z --yes | cat
698
+ OK Database restored to 2026-04-15T10:00:00Z (2 tables affected, 30s elapsed)
699
+
700
+ # --json
701
+ $ miaoda db recovery apply 2026-04-15T10:00:00Z --yes --json
702
+ {
703
+ "data": {
704
+ "status": "restored",
705
+ "target": "2026-04-15T10:00:00Z",
706
+ "tables_affected": 2,
707
+ "elapsed_seconds": 30
708
+ }
709
+ }
710
+
711
+ # 超出可恢复窗口
712
+ $ miaoda db recovery apply 2026-04-05T10:00:00Z
713
+ Error: Timestamp is outside the recoverable window
714
+ hint: Current recoverable window: 2026-04-09T12:00:00Z ~ 2026-04-16T12:00:00Z
715
+ Run \`miaoda db recovery diff <ts>\` within this window to preview impact.
716
+
717
+ # 并发冲突(已有恢复任务在执行)
718
+ $ miaoda db recovery apply 2026-04-15T10:00:00Z
719
+ Error: Another recovery is already in progress
720
+ hint: Wait for the current recovery to finish. Started at 2026-04-16T12:30:00Z.
721
+ `);
722
+ // ── quota ──
723
+ dbCmd
724
+ .command('quota')
725
+ .summary('查看数据库的存储用量与限额')
726
+ .description('查看数据库的存储用量、配额和表数量。')
727
+ .usage('[flags]')
728
+ .action(async function () {
729
+ await (0, index_1.handleDbQuota)(this.optsWithGlobals());
730
+ })
731
+ .addHelpText('after', `
732
+ Examples:
733
+ $ miaoda db quota
734
+ Storage: 14.9 MB / 1 GB (1.5%)
735
+ Tables: 3
736
+ Views: 10
737
+
738
+ # --json
739
+ $ miaoda db quota --json
740
+ {
741
+ "data": {
742
+ "storage_used_bytes": 15623782,
743
+ "storage_quota_bytes": 1073741824,
744
+ "usage_percent": 1.5,
745
+ "tables": 3,
746
+ "views": 10
747
+ }
748
+ }
208
749
  `);
209
750
  }