@lark-apaas/miaoda-cli 0.1.3-alpha.b499e4d → 0.1.3-alpha.dcf1a0c
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.
- package/dist/api/db/api.js +52 -16
- package/dist/api/db/client.js +97 -6
- package/dist/api/db/index.js +2 -1
- package/dist/cli/commands/db/index.js +9 -0
- package/dist/cli/commands/file/index.js +1 -1
- package/dist/cli/handlers/db/_destructive.js +67 -0
- package/dist/cli/handlers/db/_env.js +26 -0
- package/dist/cli/handlers/db/_operator.js +35 -0
- package/dist/cli/handlers/db/audit.js +105 -16
- package/dist/cli/handlers/db/changelog.js +37 -7
- package/dist/cli/handlers/db/migration.js +25 -26
- package/dist/cli/handlers/db/recovery.js +121 -65
- package/dist/cli/handlers/file/rm.js +8 -6
- package/dist/utils/poll.js +21 -13
- package/dist/utils/spinner.js +46 -0
- package/package.json +1 -1
package/dist/api/db/api.js
CHANGED
|
@@ -13,6 +13,7 @@ exports.migrate = migrate;
|
|
|
13
13
|
exports.getMigrationStatus = getMigrationStatus;
|
|
14
14
|
exports.recover = recover;
|
|
15
15
|
exports.getRecoveryPreview = getRecoveryPreview;
|
|
16
|
+
exports.getRecoveryStatus = getRecoveryStatus;
|
|
16
17
|
exports.getDbQuota = getDbQuota;
|
|
17
18
|
const http_1 = require("../../utils/http");
|
|
18
19
|
const error_1 = require("../../utils/error");
|
|
@@ -47,8 +48,13 @@ async function mapDbHttpError(err, url, ctx, opts) {
|
|
|
47
48
|
(0, client_1.extractData)(body); // 业务 code 命中 → 抛 AppError;不命中走兜底
|
|
48
49
|
}
|
|
49
50
|
catch (appErr) {
|
|
50
|
-
if (appErr instanceof error_1.AppError
|
|
51
|
-
|
|
51
|
+
if (appErr instanceof error_1.AppError) {
|
|
52
|
+
// env 上下文存在时把"env not exist"系列错误统一重写成 UNKNOWN_ENV_VALUE
|
|
53
|
+
// —— 用户视角 vocab 错和 state 错都是「这个 env 不能用」,文案统一更好理解。
|
|
54
|
+
const decorated = (0, client_1.decorateEnvError)(appErr, opts?.env);
|
|
55
|
+
if (opts?.onErrorBody)
|
|
56
|
+
opts.onErrorBody(body, decorated);
|
|
57
|
+
throw decorated;
|
|
52
58
|
}
|
|
53
59
|
throw appErr;
|
|
54
60
|
}
|
|
@@ -103,6 +109,7 @@ async function execSql(opts) {
|
|
|
103
109
|
catch (err) {
|
|
104
110
|
(0, client_1.traceHttp)('POST', url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
|
|
105
111
|
await mapDbHttpError(err, url, 'Failed to execute SQL', {
|
|
112
|
+
env: opts.dbBranch,
|
|
106
113
|
onErrorBody: attachSqlPartialResults,
|
|
107
114
|
// SQL 路径单独的超时文案:PG 的 statement_timeout 会回滚整条事务,所以这里
|
|
108
115
|
// 明示「事务已回滚、没有改动落地」,并把 hint 引导到「简化 SQL / 加 LIMIT / 拆条」。
|
|
@@ -190,7 +197,7 @@ async function getSchema(opts) {
|
|
|
190
197
|
}
|
|
191
198
|
catch (err) {
|
|
192
199
|
(0, client_1.traceHttp)('GET', url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
|
|
193
|
-
await mapDbHttpError(err, url, 'Failed to get schema');
|
|
200
|
+
await mapDbHttpError(err, url, 'Failed to get schema', { env: opts.dbBranch });
|
|
194
201
|
throw err; // 不可达
|
|
195
202
|
}
|
|
196
203
|
const body = (await response.json());
|
|
@@ -217,7 +224,8 @@ async function importData(opts) {
|
|
|
217
224
|
records: opts.body.toString('utf8'),
|
|
218
225
|
};
|
|
219
226
|
if (opts.dbBranch !== undefined && opts.dbBranch !== '') {
|
|
220
|
-
|
|
227
|
+
// 兼容 `online` 别名 → 后端实际 dbBranch 名为 `main`
|
|
228
|
+
reqBody.dbBranch = opts.dbBranch === 'online' ? 'main' : opts.dbBranch;
|
|
221
229
|
}
|
|
222
230
|
const start = Date.now();
|
|
223
231
|
let response;
|
|
@@ -227,7 +235,7 @@ async function importData(opts) {
|
|
|
227
235
|
}
|
|
228
236
|
catch (err) {
|
|
229
237
|
(0, client_1.traceHttp)('POST', url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
|
|
230
|
-
await mapDbHttpError(err, url, 'Failed to import data');
|
|
238
|
+
await mapDbHttpError(err, url, 'Failed to import data', { env: opts.dbBranch });
|
|
231
239
|
throw err; // 不可达
|
|
232
240
|
}
|
|
233
241
|
// 后端 InnerAdminImportData 响应里 data 直接返 {tableName, recordCount, durationMs}
|
|
@@ -266,7 +274,7 @@ async function exportData(opts) {
|
|
|
266
274
|
}
|
|
267
275
|
catch (err) {
|
|
268
276
|
(0, client_1.traceHttp)('POST', url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
|
|
269
|
-
await mapDbHttpError(err, url, 'Failed to export data');
|
|
277
|
+
await mapDbHttpError(err, url, 'Failed to export data', { env: opts.dbBranch });
|
|
270
278
|
throw err; // 不可达
|
|
271
279
|
}
|
|
272
280
|
// 成功路径:响应 body 通常是原始 CSV/SQL/JSON 字节,但部分错误场景下网关会返
|
|
@@ -325,6 +333,7 @@ async function listDDLChangelog(opts) {
|
|
|
325
333
|
table: opts.table,
|
|
326
334
|
since: opts.since,
|
|
327
335
|
until: opts.until,
|
|
336
|
+
changeId: opts.changeId,
|
|
328
337
|
limit: opts.limit !== undefined ? String(opts.limit) : undefined,
|
|
329
338
|
cursor: opts.cursor,
|
|
330
339
|
dbBranch: opts.dbBranch,
|
|
@@ -337,7 +346,7 @@ async function listDDLChangelog(opts) {
|
|
|
337
346
|
}
|
|
338
347
|
catch (err) {
|
|
339
348
|
(0, client_1.traceHttp)('GET', url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
|
|
340
|
-
await mapDbHttpError(err, url, 'Failed to list DDL changelog');
|
|
349
|
+
await mapDbHttpError(err, url, 'Failed to list DDL changelog', { env: opts.dbBranch });
|
|
341
350
|
throw err; // 不可达
|
|
342
351
|
}
|
|
343
352
|
const body = (await response.json());
|
|
@@ -367,7 +376,7 @@ async function getAuditStatus(opts) {
|
|
|
367
376
|
}
|
|
368
377
|
catch (err) {
|
|
369
378
|
(0, client_1.traceHttp)('GET', url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
|
|
370
|
-
await mapDbHttpError(err, url, 'Failed to get audit status');
|
|
379
|
+
await mapDbHttpError(err, url, 'Failed to get audit status', { env: opts.dbBranch });
|
|
371
380
|
throw err; // 不可达
|
|
372
381
|
}
|
|
373
382
|
const respBody = (await response.json());
|
|
@@ -387,8 +396,10 @@ async function setAuditConfig(opts) {
|
|
|
387
396
|
};
|
|
388
397
|
if (opts.retention !== undefined && opts.retention !== '')
|
|
389
398
|
body.retention = opts.retention;
|
|
390
|
-
if (opts.dbBranch !== undefined && opts.dbBranch !== '')
|
|
391
|
-
|
|
399
|
+
if (opts.dbBranch !== undefined && opts.dbBranch !== '') {
|
|
400
|
+
// 兼容 `online` 别名 → 后端实际 dbBranch 名为 `main`
|
|
401
|
+
body.dbBranch = opts.dbBranch === 'online' ? 'main' : opts.dbBranch;
|
|
402
|
+
}
|
|
392
403
|
const start = Date.now();
|
|
393
404
|
let response;
|
|
394
405
|
try {
|
|
@@ -397,7 +408,7 @@ async function setAuditConfig(opts) {
|
|
|
397
408
|
}
|
|
398
409
|
catch (err) {
|
|
399
410
|
(0, client_1.traceHttp)('POST', url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
|
|
400
|
-
await mapDbHttpError(err, url, 'Failed to set audit config');
|
|
411
|
+
await mapDbHttpError(err, url, 'Failed to set audit config', { env: opts.dbBranch });
|
|
401
412
|
throw err; // 不可达
|
|
402
413
|
}
|
|
403
414
|
const respBody = (await response.json());
|
|
@@ -425,7 +436,9 @@ async function listAuditLog(opts) {
|
|
|
425
436
|
}
|
|
426
437
|
const client = (0, http_1.getHttpClient)();
|
|
427
438
|
const url = (0, client_1.buildInnerUrl)(opts.appId, '/db/audit/log', {
|
|
428
|
-
tables
|
|
439
|
+
// IDL `Tables list<string>` 走重复 query key(?tables=A&tables=B)—— join(',')
|
|
440
|
+
// 会让 Hertz/Kitex 网关绑成 ["A,B"] 单元素切片,命中单表错误分支报错文案错乱。
|
|
441
|
+
tables: opts.tables,
|
|
429
442
|
since: opts.since,
|
|
430
443
|
until: opts.until,
|
|
431
444
|
limit: opts.limit !== undefined ? String(opts.limit) : undefined,
|
|
@@ -440,7 +453,7 @@ async function listAuditLog(opts) {
|
|
|
440
453
|
}
|
|
441
454
|
catch (err) {
|
|
442
455
|
(0, client_1.traceHttp)('GET', url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
|
|
443
|
-
await mapDbHttpError(err, url, 'Failed to list audit log');
|
|
456
|
+
await mapDbHttpError(err, url, 'Failed to list audit log', { env: opts.dbBranch });
|
|
444
457
|
throw err; // 不可达
|
|
445
458
|
}
|
|
446
459
|
const body = (await response.json());
|
|
@@ -517,7 +530,7 @@ async function getMigrationStatus(opts) {
|
|
|
517
530
|
}
|
|
518
531
|
catch (err) {
|
|
519
532
|
(0, client_1.traceHttp)('GET', url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
|
|
520
|
-
await mapDbHttpError(err, url, 'Failed to get migration status');
|
|
533
|
+
await mapDbHttpError(err, url, 'Failed to get migration status', { env: opts.dbBranch });
|
|
521
534
|
throw err; // 不可达
|
|
522
535
|
}
|
|
523
536
|
const body = (await response.json());
|
|
@@ -566,7 +579,30 @@ async function getRecoveryPreview(opts) {
|
|
|
566
579
|
}
|
|
567
580
|
catch (err) {
|
|
568
581
|
(0, client_1.traceHttp)('GET', url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
|
|
569
|
-
await mapDbHttpError(err, url, 'Failed to get recovery preview');
|
|
582
|
+
await mapDbHttpError(err, url, 'Failed to get recovery preview', { env: opts.dbBranch });
|
|
583
|
+
throw err; // 不可达
|
|
584
|
+
}
|
|
585
|
+
const body = (await response.json());
|
|
586
|
+
return (0, client_1.extractData)(body);
|
|
587
|
+
}
|
|
588
|
+
/**
|
|
589
|
+
* 后端:GET /v1/dataloom/app/{appId}/db/recovery/status
|
|
590
|
+
* CLI apply 触发后定时调本接口直到 status=success/failed。dataloom 内部 Redis
|
|
591
|
+
* 维护 workspace 级 restore 状态,无需传 task id;workspace+dbBranch 维度同时
|
|
592
|
+
* 只允许一个 restore 进行中。
|
|
593
|
+
*/
|
|
594
|
+
async function getRecoveryStatus(opts) {
|
|
595
|
+
const client = (0, http_1.getHttpClient)();
|
|
596
|
+
const url = (0, client_1.buildInnerUrl)(opts.appId, '/db/recovery/status', { dbBranch: opts.dbBranch });
|
|
597
|
+
const start = Date.now();
|
|
598
|
+
let response;
|
|
599
|
+
try {
|
|
600
|
+
response = await client.get(url);
|
|
601
|
+
(0, client_1.traceHttp)('GET', url, start, response);
|
|
602
|
+
}
|
|
603
|
+
catch (err) {
|
|
604
|
+
(0, client_1.traceHttp)('GET', url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
|
|
605
|
+
await mapDbHttpError(err, url, 'Failed to get recovery status', { env: opts.dbBranch });
|
|
570
606
|
throw err; // 不可达
|
|
571
607
|
}
|
|
572
608
|
const body = (await response.json());
|
|
@@ -587,7 +623,7 @@ async function getDbQuota(opts) {
|
|
|
587
623
|
}
|
|
588
624
|
catch (err) {
|
|
589
625
|
(0, client_1.traceHttp)('GET', url, start, err instanceof http_client_1.HttpError ? err.response : undefined, err);
|
|
590
|
-
await mapDbHttpError(err, url, 'Failed to get db quota');
|
|
626
|
+
await mapDbHttpError(err, url, 'Failed to get db quota', { env: opts.dbBranch });
|
|
591
627
|
throw err; // 不可达
|
|
592
628
|
}
|
|
593
629
|
const respBody = (await response.json());
|
package/dist/api/db/client.js
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.SQLSTATE_MAP = void 0;
|
|
3
|
+
exports.SQLSTATE_MAP = exports.ENV_CTX_TYPO = void 0;
|
|
4
4
|
exports.traceHttp = traceHttp;
|
|
5
5
|
exports.ensureInnerSuccess = ensureInnerSuccess;
|
|
6
6
|
exports.mapDataloomBizError = mapDataloomBizError;
|
|
7
|
+
exports.buildUnknownEnvError = buildUnknownEnvError;
|
|
8
|
+
exports.decorateEnvError = decorateEnvError;
|
|
7
9
|
exports.extractData = extractData;
|
|
8
10
|
exports.buildInnerUrl = buildInnerUrl;
|
|
9
11
|
const error_1 = require("../../utils/error");
|
|
@@ -69,7 +71,8 @@ function ensureInnerSuccess(body) {
|
|
|
69
71
|
*
|
|
70
72
|
* 优先级:
|
|
71
73
|
* 1. k_dl_1300002 + SQLSTATE 透传 → SQLSTATE_MAP
|
|
72
|
-
* 2. k_dl_1600000 + "Invalid DB Branch" →
|
|
74
|
+
* 2. k_dl_1600000 + "Invalid DB Branch" → UNKNOWN_ENV_VALUE 占位(mapDbHttpError
|
|
75
|
+
* 会用用户实际 --env 值通过 decorateEnvError 重写)
|
|
73
76
|
* 3. BIZ_ERR_MAP 命中 → 语义 code(可能带 hint)
|
|
74
77
|
* 4. 兜底 DB_API_<code>
|
|
75
78
|
*
|
|
@@ -84,7 +87,13 @@ function mapDataloomBizError(code, rawMessage) {
|
|
|
84
87
|
}
|
|
85
88
|
}
|
|
86
89
|
if (code === 'k_dl_1600000' && message.startsWith('Invalid DB Branch')) {
|
|
87
|
-
|
|
90
|
+
// 这里没有 user-facing --env 值(client 层不知道 CLI 入参),先用 server 侧返回的
|
|
91
|
+
// 分支名占位;mapDbHttpError 在拿到 env 上下文后会通过 decorateEnvError 重写成
|
|
92
|
+
// 用户传入的实际值。dataloom 错误文案历史上同时存在英文冒号和中文冒号「:」格式,
|
|
93
|
+
// 这里两种都接。
|
|
94
|
+
const m = /Invalid DB Branch[::\s]+([^\s]+)/i.exec(message);
|
|
95
|
+
const branch = m?.[1] ?? '<branch>';
|
|
96
|
+
return buildUnknownEnvError(branch);
|
|
88
97
|
}
|
|
89
98
|
const mapped = BIZ_ERR_MAP.get(code);
|
|
90
99
|
if (mapped) {
|
|
@@ -94,6 +103,71 @@ function mapDataloomBizError(code, rawMessage) {
|
|
|
94
103
|
}
|
|
95
104
|
return new error_1.AppError(`DB_API_${code}`, message);
|
|
96
105
|
}
|
|
106
|
+
/**
|
|
107
|
+
* typo / CLI vocab violation 路径用:state 未知,列双 env 让用户在 dev/online 之间选,
|
|
108
|
+
* 不引导 init(init 不会创建 typo 出来的分支)。
|
|
109
|
+
*/
|
|
110
|
+
exports.ENV_CTX_TYPO = {
|
|
111
|
+
available: ['dev', 'online'],
|
|
112
|
+
suggestInit: false,
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* 统一构造"--env 值不可用"错误。两类入口共用:
|
|
116
|
+
* - CLI vocab 校验(_env.ts validateEnv):用户传 dev/main/online 以外值
|
|
117
|
+
* - backend state 错(decorateEnvError):vocab 合法但 db 实际状态对不上
|
|
118
|
+
*
|
|
119
|
+
* `available` 跟 `suggestInit` 由调用方按错误码归类传入;user-facing 不展示 `main`
|
|
120
|
+
* 内部别名,统一用 `online`。
|
|
121
|
+
*/
|
|
122
|
+
function buildUnknownEnvError(env, ctx = exports.ENV_CTX_TYPO) {
|
|
123
|
+
const hints = [
|
|
124
|
+
`--env must match an existing database branch. Available: ${ctx.available.join(', ')}.`,
|
|
125
|
+
];
|
|
126
|
+
if (ctx.suggestInit) {
|
|
127
|
+
hints.push(`Run \`miaoda db migration init\` before using '${env}'.`);
|
|
128
|
+
}
|
|
129
|
+
return new error_1.AppError('UNKNOWN_ENV_VALUE', `Unknown --env value '${env}'`, {
|
|
130
|
+
next_actions: hints,
|
|
131
|
+
});
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* 把 backend env 相关错误统一重写成 UNKNOWN_ENV_VALUE 文案,按错误码做 state 推断:
|
|
135
|
+
*
|
|
136
|
+
* - DB_API_k_dl_1300033(非专家应用)→ 单 env (online),不建议 init
|
|
137
|
+
* - DB_API_k_dl_1300039(专家未 init)→ 单 env (online),建议 init
|
|
138
|
+
* - DB_API_k_dl_000007 + "db branch not found"(pg connection 兜底)→ 单 env,建议 init
|
|
139
|
+
* - UNKNOWN_ENV_VALUE(mapDataloomBizError 对 k_dl_1600000 的占位)→ typo path
|
|
140
|
+
*
|
|
141
|
+
* env 未传时不改写:避免把 backend 兜底文案(如 "Multi-env is not initialized")
|
|
142
|
+
* 改成 `Unknown --env value ''` 这种空字符串错误。
|
|
143
|
+
*/
|
|
144
|
+
function decorateEnvError(err, env) {
|
|
145
|
+
if (env === undefined || env === '')
|
|
146
|
+
return err;
|
|
147
|
+
const ctx = classifyEnvError(err);
|
|
148
|
+
if (!ctx)
|
|
149
|
+
return err;
|
|
150
|
+
return buildUnknownEnvError(env, ctx);
|
|
151
|
+
}
|
|
152
|
+
function classifyEnvError(err) {
|
|
153
|
+
if (err.code === 'DB_API_k_dl_1300033') {
|
|
154
|
+
// 非专家应用:init 也会被同一 guard 拒掉,建议 init 是误导
|
|
155
|
+
return { available: ['online'], suggestInit: false };
|
|
156
|
+
}
|
|
157
|
+
if (err.code === 'DB_API_k_dl_1300039') {
|
|
158
|
+
// 专家未 init:init 会创建 dev 分支
|
|
159
|
+
return { available: ['online'], suggestInit: true };
|
|
160
|
+
}
|
|
161
|
+
if (err.code === 'DB_API_k_dl_000007' && /db branch not found/i.test(err.message)) {
|
|
162
|
+
// pg connection 层 ErrParamsInvalid:大概率 pre-init;建议 init(非专家会被 init 路径拦)
|
|
163
|
+
return { available: ['online'], suggestInit: true };
|
|
164
|
+
}
|
|
165
|
+
if (err.code === 'UNKNOWN_ENV_VALUE') {
|
|
166
|
+
// mapDataloomBizError 对 k_dl_1600000 的占位:typo path,state 未知,列双 env
|
|
167
|
+
return exports.ENV_CTX_TYPO;
|
|
168
|
+
}
|
|
169
|
+
return null;
|
|
170
|
+
}
|
|
97
171
|
/**
|
|
98
172
|
* 剥掉 PG 透传错误的 "ERROR:" 前缀:CLI 输出本身就会前缀 "Error:",
|
|
99
173
|
* 不去掉就会变成 `Error: ERROR: relation ...` 双重前缀,PRD 不要这种冗余。
|
|
@@ -201,9 +275,26 @@ function buildInnerUrl(appId, path, query) {
|
|
|
201
275
|
let url = `/v1/dataloom/app/${encodeURIComponent(appId)}${normalized}`;
|
|
202
276
|
if (query) {
|
|
203
277
|
const usp = new URLSearchParams();
|
|
204
|
-
for (const [k,
|
|
205
|
-
if (
|
|
206
|
-
|
|
278
|
+
for (const [k, rawV] of Object.entries(query)) {
|
|
279
|
+
if (rawV === undefined)
|
|
280
|
+
continue;
|
|
281
|
+
// 数组值 → 重复 key 编码(?k=v1&k=v2)。IDL 里 list<string> 类型经
|
|
282
|
+
// Hertz/Kitex HTTP→Thrift 网关绑定 slice 字段需要重复 key;如果改成
|
|
283
|
+
// join(',') 单串,后端会拿到 ["v1,v2"] 单元素切片而非 ["v1","v2"]。
|
|
284
|
+
if (typeof rawV !== 'string') {
|
|
285
|
+
for (const item of rawV) {
|
|
286
|
+
if (item === '')
|
|
287
|
+
continue;
|
|
288
|
+
usp.append(k, item);
|
|
289
|
+
}
|
|
290
|
+
continue;
|
|
291
|
+
}
|
|
292
|
+
if (rawV === '')
|
|
293
|
+
continue;
|
|
294
|
+
// dbBranch 兼容用户视角的 `online` 别名 → 后端实际 dbBranch 名为 `main`,
|
|
295
|
+
// 这里集中归一,避免每个 API 函数各自处理。其他值(dev / 自定义分支)原样透传。
|
|
296
|
+
const norm = k === 'dbBranch' && rawV === 'online' ? 'main' : rawV;
|
|
297
|
+
usp.append(k, norm);
|
|
207
298
|
}
|
|
208
299
|
const qs = usp.toString();
|
|
209
300
|
if (qs)
|
package/dist/api/db/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
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;
|
|
3
|
+
exports.pickTableDetail = exports.flattenSchemaList = exports.parseSqlResult = exports.SQLSTATE_MAP = exports.ensureInnerSuccess = exports.buildInnerUrl = exports.getDbQuota = exports.getRecoveryStatus = 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;
|
|
4
4
|
var api_1 = require("./api");
|
|
5
5
|
Object.defineProperty(exports, "execSql", { enumerable: true, get: function () { return api_1.execSql; } });
|
|
6
6
|
Object.defineProperty(exports, "getSchema", { enumerable: true, get: function () { return api_1.getSchema; } });
|
|
@@ -15,6 +15,7 @@ Object.defineProperty(exports, "migrate", { enumerable: true, get: function () {
|
|
|
15
15
|
Object.defineProperty(exports, "getMigrationStatus", { enumerable: true, get: function () { return api_1.getMigrationStatus; } });
|
|
16
16
|
Object.defineProperty(exports, "recover", { enumerable: true, get: function () { return api_1.recover; } });
|
|
17
17
|
Object.defineProperty(exports, "getRecoveryPreview", { enumerable: true, get: function () { return api_1.getRecoveryPreview; } });
|
|
18
|
+
Object.defineProperty(exports, "getRecoveryStatus", { enumerable: true, get: function () { return api_1.getRecoveryStatus; } });
|
|
18
19
|
Object.defineProperty(exports, "getDbQuota", { enumerable: true, get: function () { return api_1.getDbQuota; } });
|
|
19
20
|
var client_1 = require("./client");
|
|
20
21
|
Object.defineProperty(exports, "buildInnerUrl", { enumerable: true, get: function () { return client_1.buildInnerUrl; } });
|
|
@@ -4,6 +4,7 @@ exports.registerDbCommands = registerDbCommands;
|
|
|
4
4
|
const error_1 = require("../../../utils/error");
|
|
5
5
|
const index_1 = require("../../../cli/handlers/db/index");
|
|
6
6
|
const shared_1 = require("../../../cli/commands/shared");
|
|
7
|
+
const _env_1 = require("../../../cli/handlers/db/_env");
|
|
7
8
|
function parsePositiveInt(raw) {
|
|
8
9
|
const n = Number(raw);
|
|
9
10
|
if (!Number.isInteger(n) || n < 1) {
|
|
@@ -19,6 +20,13 @@ function registerDbCommands(program) {
|
|
|
19
20
|
// --env 注册在 db 父级,spec 把它列入 db --help 的 Global Flags;
|
|
20
21
|
// leaf 命令仍各自接收 --env 值(commander 解析时父级 option 自动适用于子命令)
|
|
21
22
|
.option('--env <name>', '指定目标环境(dev / online,仅专家模式应用支持)');
|
|
23
|
+
// 任意 leaf action 执行前先做 --env vocab 校验:用户拼错('onlin'/'prod' 等)立即报
|
|
24
|
+
// UNKNOWN_ENV_VALUE 避免后端无意义被打到。preAction hook 拿父级 dbCmd 的 --env 值
|
|
25
|
+
// —— commander 把父级 option 自动 propagate 给子命令的 optsWithGlobals。
|
|
26
|
+
dbCmd.hook('preAction', () => {
|
|
27
|
+
const env = dbCmd.opts().env;
|
|
28
|
+
(0, _env_1.validateEnv)(typeof env === 'string' ? env : undefined);
|
|
29
|
+
});
|
|
22
30
|
dbCmd.action(() => {
|
|
23
31
|
dbCmd.outputHelp();
|
|
24
32
|
});
|
|
@@ -224,6 +232,7 @@ Examples:
|
|
|
224
232
|
.option('--table <name>', '按表名过滤')
|
|
225
233
|
.option('--since <time>', '起始时间')
|
|
226
234
|
.option('--until <time>', '截止时间')
|
|
235
|
+
.option('--change-id <id>', '按 change_id 精确查询单条变更记录(指定后只返该 ID 一条,JSON 仍保持数组)')
|
|
227
236
|
.option('--limit <n>', '返回条数上限(默认 20)', parsePositiveInt, 20)
|
|
228
237
|
.option('--cursor <token>', '从上一页返回的游标位置继续获取')
|
|
229
238
|
.option('--all', '获取全部结果,自动翻页')
|
|
@@ -159,7 +159,7 @@ Notes:
|
|
|
159
159
|
Examples:
|
|
160
160
|
# 单文件删除(TTY 下需确认)
|
|
161
161
|
$ miaoda file rm /images/brand/1858537546760216.png
|
|
162
|
-
?
|
|
162
|
+
? Are you sure you want to permanently delete '/images/brand/1858537546760216.png'? (y/N) y
|
|
163
163
|
✓ Deleted /images/brand/1858537546760216.png
|
|
164
164
|
|
|
165
165
|
# 批量删除(混用 path 与 file_name)
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// db 域内不可逆 / destructive 操作的统一确认门。
|
|
3
|
+
//
|
|
4
|
+
// 设计要点:
|
|
5
|
+
// 1. --yes:放行(CI / 脚本显式确认场景)
|
|
6
|
+
// 2. 非 TTY 且无 --yes:抛 DESTRUCTIVE_REQUIRES_CONFIRM,不要默认放行。
|
|
7
|
+
// 非 TTY 通常是 CI / agent / 管道场景,无人能交互回答 y/N,必须靠 --yes 显式确认。
|
|
8
|
+
// 3. TTY 且无 --yes:交互式 y/N(prompt 写 stderr,避免污染 --json 模式 stdout)
|
|
9
|
+
//
|
|
10
|
+
// 反例(已修复,见这次 commit):把 !isJsonMode() 拿来做确认门 —— --json 只改输出
|
|
11
|
+
// 格式,跟"用户已确认"不是同一语义。CI / agent 几乎总会带 --json 解析输出,等价于
|
|
12
|
+
// 把不可逆操作的确认变成了空门,跟 file rm 的模型也不一致。
|
|
13
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
14
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
exports.confirmDestructive = confirmDestructive;
|
|
18
|
+
exports.assertDestructiveAllowedInTty = assertDestructiveAllowedInTty;
|
|
19
|
+
exports.askYesNo = askYesNo;
|
|
20
|
+
const node_readline_1 = __importDefault(require("node:readline"));
|
|
21
|
+
const render_1 = require("../../../utils/render");
|
|
22
|
+
const error_1 = require("../../../utils/error");
|
|
23
|
+
const DESTRUCTIVE_REQUIRES_CONFIRM_MSG = 'This operation is destructive. Rerun with --yes to confirm.';
|
|
24
|
+
/**
|
|
25
|
+
* 完整的"yes/tty/交互"决策门。直接用于无需 fetch 预览的简单确认场景(如 migration init)。
|
|
26
|
+
*
|
|
27
|
+
* 返回值:
|
|
28
|
+
* - true → 已确认,可执行
|
|
29
|
+
* - false → TTY 下用户输了 n,调用方应渲染 Aborted 并退出
|
|
30
|
+
*
|
|
31
|
+
* 异常:
|
|
32
|
+
* - DESTRUCTIVE_REQUIRES_CONFIRM:非 TTY 且无 --yes
|
|
33
|
+
*/
|
|
34
|
+
async function confirmDestructive(prompt, yes) {
|
|
35
|
+
if (yes === true)
|
|
36
|
+
return true;
|
|
37
|
+
if (!(0, render_1.isStdoutTty)()) {
|
|
38
|
+
throw new error_1.AppError('DESTRUCTIVE_REQUIRES_CONFIRM', DESTRUCTIVE_REQUIRES_CONFIRM_MSG);
|
|
39
|
+
}
|
|
40
|
+
return askYesNo(prompt);
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* 给"需要在 confirm 之前先 fetch 预览"的场景(migration apply / recovery apply 可选优化)用:
|
|
44
|
+
* 在非 TTY 无 --yes 时提前抛错,避免无意义触发后端 dry-run RPC。
|
|
45
|
+
*
|
|
46
|
+
* 调用后 TTY 路径仍需自行调 askYesNo / confirmDestructive 完成交互。
|
|
47
|
+
*/
|
|
48
|
+
function assertDestructiveAllowedInTty(yes) {
|
|
49
|
+
if (yes === true)
|
|
50
|
+
return;
|
|
51
|
+
if (!(0, render_1.isStdoutTty)()) {
|
|
52
|
+
throw new error_1.AppError('DESTRUCTIVE_REQUIRES_CONFIRM', DESTRUCTIVE_REQUIRES_CONFIRM_MSG);
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* 交互式 y/N。输入读 stdin,prompt 写 stderr —— stderr 避免污染 --json 模式 stdout 的 envelope。
|
|
57
|
+
* 仅 'y'(忽略大小写)算确认;其余一律视为否决。
|
|
58
|
+
*/
|
|
59
|
+
async function askYesNo(prompt) {
|
|
60
|
+
const rl = node_readline_1.default.createInterface({ input: process.stdin, output: process.stderr });
|
|
61
|
+
return new Promise((resolve) => {
|
|
62
|
+
rl.question(prompt, (answer) => {
|
|
63
|
+
rl.close();
|
|
64
|
+
resolve(answer.trim().toLowerCase() === 'y');
|
|
65
|
+
});
|
|
66
|
+
});
|
|
67
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// db 域内 --env 参数的 CLI vocab 校验。
|
|
3
|
+
//
|
|
4
|
+
// 用户视角的 vocab:
|
|
5
|
+
// - dev → 多环境沙箱分支
|
|
6
|
+
// - online → 生产分支(向后端发请求时映射成 main,client.ts/api.ts 已处理)
|
|
7
|
+
// - main → online 的别名,兼容历史脚本
|
|
8
|
+
//
|
|
9
|
+
// 配合 client.ts::buildUnknownEnvError,把 vocab 错(这里)跟 backend state 错
|
|
10
|
+
// (client.ts 处理)统一成同一类 UNKNOWN_ENV_VALUE,避免用户在两种失败之间困惑。
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.validateEnv = validateEnv;
|
|
13
|
+
const client_1 = require("../../../api/db/client");
|
|
14
|
+
const VOCAB = ['dev', 'main', 'online'];
|
|
15
|
+
const VOCAB_SET = new Set(VOCAB);
|
|
16
|
+
/**
|
|
17
|
+
* CLI vocab 校验。空值(未传 --env)放行,由后端按 workspace 默认 branch 处理。
|
|
18
|
+
* 不在 vocab 内 → 抛 UNKNOWN_ENV_VALUE,preAction hook 兜底,避免无意义触发 RPC。
|
|
19
|
+
*/
|
|
20
|
+
function validateEnv(env) {
|
|
21
|
+
if (env === undefined || env === '')
|
|
22
|
+
return;
|
|
23
|
+
if (VOCAB_SET.has(env))
|
|
24
|
+
return;
|
|
25
|
+
throw (0, client_1.buildUnknownEnvError)(env);
|
|
26
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// changelog / audit 共用:把后端透传的 operator 字符串还原成 {id, name}。
|
|
3
|
+
//
|
|
4
|
+
// 后端约定:Operator 字段值是 `{"id":"<user_id>","name":"<resolved_name>"}` JSON
|
|
5
|
+
// 字符串(dataloom inner_service.encodeOperator 生成),用同一字段同时承载机器可
|
|
6
|
+
// 识别的 user_id 与人类可读 name。
|
|
7
|
+
//
|
|
8
|
+
// 选择"字符串内嵌 JSON"而不是 IDL struct,是为了避免 dataloom_inner.thrift +
|
|
9
|
+
// kitex_gen 跨仓库改造;CLI 端 JSON.parse 拆开即可分场景渲染:
|
|
10
|
+
// - --json 模式:返 {id, name} 对象(agent / 下游能区分同名用户)
|
|
11
|
+
// - pretty 模式:只取 name(兼容 PRD 原始 string 形态)
|
|
12
|
+
//
|
|
13
|
+
// 历史数据 / 旧版后端没接这层时,operator 仍是纯字符串。该函数兼容:
|
|
14
|
+
// - 解析失败 → 当作 {id: raw, name: raw}
|
|
15
|
+
// - 解析成功但缺字段 → 用现有字段兜底另一个
|
|
16
|
+
// 解析失败默认不报错,保留 raw 作为兜底显示文本。
|
|
17
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
+
exports.parseOperator = parseOperator;
|
|
19
|
+
function parseOperator(raw) {
|
|
20
|
+
if (raw === undefined || raw === null || raw === '') {
|
|
21
|
+
return { id: '', name: '' };
|
|
22
|
+
}
|
|
23
|
+
if (!raw.startsWith('{')) {
|
|
24
|
+
return { id: raw, name: raw };
|
|
25
|
+
}
|
|
26
|
+
try {
|
|
27
|
+
const obj = JSON.parse(raw);
|
|
28
|
+
const id = typeof obj.id === 'string' ? obj.id : '';
|
|
29
|
+
const name = typeof obj.name === 'string' && obj.name !== '' ? obj.name : id;
|
|
30
|
+
return { id, name };
|
|
31
|
+
}
|
|
32
|
+
catch {
|
|
33
|
+
return { id: raw, name: raw };
|
|
34
|
+
}
|
|
35
|
+
}
|