pg-admin-mcp 0.0.0-stage → 0.1.0
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/README.md +608 -2
- package/dist/config/env.js +67 -0
- package/dist/config/env.js.map +1 -0
- package/dist/config/profiles.js +257 -0
- package/dist/config/profiles.js.map +1 -0
- package/dist/core/audit-context.js +21 -0
- package/dist/core/audit-context.js.map +1 -0
- package/dist/core/audit.js +91 -0
- package/dist/core/audit.js.map +1 -0
- package/dist/core/brands.js +24 -0
- package/dist/core/brands.js.map +1 -0
- package/dist/core/classifier.js +279 -0
- package/dist/core/classifier.js.map +1 -0
- package/dist/core/errors.js +197 -0
- package/dist/core/errors.js.map +1 -0
- package/dist/core/format.js +258 -0
- package/dist/core/format.js.map +1 -0
- package/dist/core/guards.js +513 -0
- package/dist/core/guards.js.map +1 -0
- package/dist/core/identifiers.js +431 -0
- package/dist/core/identifiers.js.map +1 -0
- package/dist/core/limits.js +79 -0
- package/dist/core/limits.js.map +1 -0
- package/dist/core/logger.js +34 -0
- package/dist/core/logger.js.map +1 -0
- package/dist/core/paginate.js +195 -0
- package/dist/core/paginate.js.map +1 -0
- package/dist/core/paths.js +392 -0
- package/dist/core/paths.js.map +1 -0
- package/dist/core/policy.js +98 -0
- package/dist/core/policy.js.map +1 -0
- package/dist/core/shutdown.js +10 -0
- package/dist/core/shutdown.js.map +1 -0
- package/dist/core/stdout-guard.js +25 -0
- package/dist/core/stdout-guard.js.map +1 -0
- package/dist/db/catalog.js +1006 -0
- package/dist/db/catalog.js.map +1 -0
- package/dist/db/pool.js +158 -0
- package/dist/db/pool.js.map +1 -0
- package/dist/db/session.js +258 -0
- package/dist/db/session.js.map +1 -0
- package/dist/db/types.js +2 -0
- package/dist/db/types.js.map +1 -0
- package/dist/index.js +91 -0
- package/dist/index.js.map +1 -0
- package/dist/resources/index.js +88 -0
- package/dist/resources/index.js.map +1 -0
- package/dist/runtime/binaries.js +356 -0
- package/dist/runtime/binaries.js.map +1 -0
- package/dist/runtime/env-file.js +62 -0
- package/dist/runtime/env-file.js.map +1 -0
- package/dist/runtime/environment.js +34 -0
- package/dist/runtime/environment.js.map +1 -0
- package/dist/server.js +106 -0
- package/dist/server.js.map +1 -0
- package/dist/snapshot/capture.js +189 -0
- package/dist/snapshot/capture.js.map +1 -0
- package/dist/snapshot/diff.js +254 -0
- package/dist/snapshot/diff.js.map +1 -0
- package/dist/snapshot/migrate.js +1596 -0
- package/dist/snapshot/migrate.js.map +1 -0
- package/dist/snapshot/model.js +80 -0
- package/dist/snapshot/model.js.map +1 -0
- package/dist/tools/_archive_meta.js +138 -0
- package/dist/tools/_archive_meta.js.map +1 -0
- package/dist/tools/_batch_shared.js +73 -0
- package/dist/tools/_batch_shared.js.map +1 -0
- package/dist/tools/_export_format.js +107 -0
- package/dist/tools/_export_format.js.map +1 -0
- package/dist/tools/_object_kinds.js +97 -0
- package/dist/tools/_object_kinds.js.map +1 -0
- package/dist/tools/_relation_detail.js +55 -0
- package/dist/tools/_relation_detail.js.map +1 -0
- package/dist/tools/_shared.js +17 -0
- package/dist/tools/_shared.js.map +1 -0
- package/dist/tools/_snapshot_io.js +238 -0
- package/dist/tools/_snapshot_io.js.map +1 -0
- package/dist/tools/admin/_shared.js +18 -0
- package/dist/tools/admin/_shared.js.map +1 -0
- package/dist/tools/admin/extensions.js +80 -0
- package/dist/tools/admin/extensions.js.map +1 -0
- package/dist/tools/admin/grants.js +207 -0
- package/dist/tools/admin/grants.js.map +1 -0
- package/dist/tools/admin/index.js +138 -0
- package/dist/tools/admin/index.js.map +1 -0
- package/dist/tools/admin/maintenance.js +106 -0
- package/dist/tools/admin/maintenance.js.map +1 -0
- package/dist/tools/admin/roles.js +144 -0
- package/dist/tools/admin/roles.js.map +1 -0
- package/dist/tools/admin/sessions.js +104 -0
- package/dist/tools/admin/sessions.js.map +1 -0
- package/dist/tools/admin/stats.js +63 -0
- package/dist/tools/admin/stats.js.map +1 -0
- package/dist/tools/backup.js +288 -0
- package/dist/tools/backup.js.map +1 -0
- package/dist/tools/connection_status.js +138 -0
- package/dist/tools/connection_status.js.map +1 -0
- package/dist/tools/copy.js +355 -0
- package/dist/tools/copy.js.map +1 -0
- package/dist/tools/delete_batch.js +73 -0
- package/dist/tools/delete_batch.js.map +1 -0
- package/dist/tools/describe_object.js +87 -0
- package/dist/tools/describe_object.js.map +1 -0
- package/dist/tools/execute_sql.js +395 -0
- package/dist/tools/execute_sql.js.map +1 -0
- package/dist/tools/explain.js +134 -0
- package/dist/tools/explain.js.map +1 -0
- package/dist/tools/export.js +215 -0
- package/dist/tools/export.js.map +1 -0
- package/dist/tools/get_schema.js +148 -0
- package/dist/tools/get_schema.js.map +1 -0
- package/dist/tools/index.js +40 -0
- package/dist/tools/index.js.map +1 -0
- package/dist/tools/insert_batch.js +212 -0
- package/dist/tools/insert_batch.js.map +1 -0
- package/dist/tools/list_objects.js +160 -0
- package/dist/tools/list_objects.js.map +1 -0
- package/dist/tools/prepare_migration.js +112 -0
- package/dist/tools/prepare_migration.js.map +1 -0
- package/dist/tools/restore.js +301 -0
- package/dist/tools/restore.js.map +1 -0
- package/dist/tools/schema_diff.js +79 -0
- package/dist/tools/schema_diff.js.map +1 -0
- package/dist/tools/schema_snapshot.js +57 -0
- package/dist/tools/schema_snapshot.js.map +1 -0
- package/dist/tools/select.js +162 -0
- package/dist/tools/select.js.map +1 -0
- package/dist/tools/update_batch.js +154 -0
- package/dist/tools/update_batch.js.map +1 -0
- package/package.json +47 -5
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { listEnumTypes, listExtensions, listFunctions, listRelations, listSchemas, listSequences } from '../db/catalog.js';
|
|
2
|
+
/**
|
|
3
|
+
* Shared object-kind vocabulary and gathering logic for `postgres_list_objects`
|
|
4
|
+
* and `postgres_get_schema` — both are "everything the profile can see, maybe
|
|
5
|
+
* filtered/paginated" views over the exact same `db/catalog.ts` listings, so
|
|
6
|
+
* the merge lives here once instead of twice.
|
|
7
|
+
*/
|
|
8
|
+
export const RELATION_KINDS = ['table', 'partitioned_table', 'view', 'materialized_view', 'foreign_table'];
|
|
9
|
+
export const OBJECT_KINDS = [...RELATION_KINDS, 'schema', 'sequence', 'function', 'enum', 'extension'];
|
|
10
|
+
/**
|
|
11
|
+
* Converts a SQL `LIKE` pattern (`%`, `_`) to a case-insensitive RegExp.
|
|
12
|
+
*
|
|
13
|
+
* **No longer on the production filtering path** — `gatherObjects` below
|
|
14
|
+
* binds `namePattern` straight into `ILIKE $N` inside `db/catalog.ts`
|
|
15
|
+
* instead, so PostgreSQL's linear-time matcher does the work. A pattern with
|
|
16
|
+
* many `%`s (e.g. `%%%%%%%%%%%%`) compiled the old way into unanchored
|
|
17
|
+
* `.*` runs that a JS regex engine backtracks catastrophically on for a long
|
|
18
|
+
* name — a multi-minute hang per call, once per catalog object. Kept
|
|
19
|
+
* exported (and defensively collapsing repeated `%` before compiling, in
|
|
20
|
+
* case any future caller reintroduces JS-side matching) purely for the unit
|
|
21
|
+
* tests in `test/unit/object_kinds.test.ts` and the ILIKE-vs-JS-matcher
|
|
22
|
+
* equivalence test — never call this on a live `namePattern` in a hot path.
|
|
23
|
+
*/
|
|
24
|
+
export function patternToRegExp(pattern) {
|
|
25
|
+
const collapsed = pattern.replace(/%+/g, '%');
|
|
26
|
+
const escaped = collapsed.replace(/[.*+?^${}()|[\]\\]/g, '\\$&').replace(/%/g, '.*').replace(/_/g, '.');
|
|
27
|
+
return new RegExp(`^${escaped}$`, 'i');
|
|
28
|
+
}
|
|
29
|
+
export function matchesPattern(name, pattern) {
|
|
30
|
+
return patternToRegExp(pattern).test(name);
|
|
31
|
+
}
|
|
32
|
+
export function sortObjects(objects) {
|
|
33
|
+
return [...objects].sort((a, b) => a.schema.localeCompare(b.schema) || a.kind.localeCompare(b.kind) || a.name.localeCompare(b.name));
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Gathers every object of the requested kinds across `schemaNames`, composed
|
|
37
|
+
* entirely from `db/catalog.ts` listings — no new catalog SQL here.
|
|
38
|
+
* `requestedKinds` unset/empty means every kind in {@link OBJECT_KINDS}.
|
|
39
|
+
* `extension` is database-wide but still filtered to `schemaNames`, since an
|
|
40
|
+
* extension lives in exactly one schema.
|
|
41
|
+
*
|
|
42
|
+
* `namePattern` (a SQL `LIKE` pattern) is passed straight through to every
|
|
43
|
+
* `db/catalog.ts` listing call, which binds it as `$N` into `ILIKE` — see the
|
|
44
|
+
* doc comment on `db/catalog.ts#listSchemas` for why matching happens in
|
|
45
|
+
* PostgreSQL and never in JS here.
|
|
46
|
+
*/
|
|
47
|
+
export async function gatherObjects(client, schemaNames, requestedKinds, namePattern) {
|
|
48
|
+
const kinds = requestedKinds !== undefined && requestedKinds.length > 0 ? new Set(requestedKinds) : new Set(OBJECT_KINDS);
|
|
49
|
+
const relationKinds = RELATION_KINDS.filter((k) => kinds.has(k));
|
|
50
|
+
const out = [];
|
|
51
|
+
if (schemaNames.length === 0)
|
|
52
|
+
return out;
|
|
53
|
+
if (kinds.has('schema')) {
|
|
54
|
+
for (const s of await listSchemas(client, schemaNames, namePattern)) {
|
|
55
|
+
out.push({ kind: 'schema', schema: s.name, name: s.name, oid: s.oid, owner: s.owner, comment: null, details: null });
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
if (relationKinds.length > 0) {
|
|
59
|
+
const relOpts = { kinds: relationKinds, ...(namePattern === undefined ? {} : { namePattern }) };
|
|
60
|
+
for (const r of await listRelations(client, schemaNames, relOpts)) {
|
|
61
|
+
out.push({ kind: r.kind, schema: r.schema, name: r.name, oid: r.oid, owner: r.owner, comment: r.comment, details: { estimatedRows: r.estimatedRows } });
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
if (kinds.has('sequence')) {
|
|
65
|
+
for (const s of await listSequences(client, schemaNames, namePattern)) {
|
|
66
|
+
out.push({ kind: 'sequence', schema: s.schema, name: s.name, oid: s.oid, owner: s.owner, comment: s.comment, details: null });
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
if (kinds.has('function')) {
|
|
70
|
+
for (const f of await listFunctions(client, schemaNames, namePattern)) {
|
|
71
|
+
out.push({
|
|
72
|
+
kind: 'function',
|
|
73
|
+
schema: f.schema,
|
|
74
|
+
name: f.name,
|
|
75
|
+
oid: f.oid,
|
|
76
|
+
owner: null,
|
|
77
|
+
comment: f.comment,
|
|
78
|
+
details: { argTypes: f.argTypes, returnType: f.returnType, language: f.language, procKind: f.kind },
|
|
79
|
+
});
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
if (kinds.has('enum')) {
|
|
83
|
+
for (const e of await listEnumTypes(client, schemaNames, namePattern)) {
|
|
84
|
+
out.push({ kind: 'enum', schema: e.schema, name: e.name, oid: e.oid, owner: null, comment: e.comment, details: { labels: e.labels } });
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
if (kinds.has('extension')) {
|
|
88
|
+
const schemaSet = new Set(schemaNames);
|
|
89
|
+
for (const e of await listExtensions(client, namePattern)) {
|
|
90
|
+
if (!schemaSet.has(e.schema))
|
|
91
|
+
continue;
|
|
92
|
+
out.push({ kind: 'extension', schema: e.schema, name: e.name, oid: null, owner: null, comment: e.comment, details: { version: e.version } });
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
return sortObjects(out);
|
|
96
|
+
}
|
|
97
|
+
//# sourceMappingURL=_object_kinds.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"_object_kinds.js","sourceRoot":"","sources":["../../src/tools/_object_kinds.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAG3H;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,mBAAmB,EAAE,MAAM,EAAE,mBAAmB,EAAE,eAAe,CAA4C,CAAC;AAEtJ,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,GAAG,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,CAAU,CAAC;AAehH;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,eAAe,CAAC,OAAe;IAC7C,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC9C,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACxG,OAAO,IAAI,MAAM,CAAC,IAAI,OAAO,GAAG,EAAE,GAAG,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,OAAe;IAC1D,OAAO,eAAe,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,OAAiC;IAC3D,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,CACtB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAC3G,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAkB,EAClB,WAA8B,EAC9B,cAAsC,EACtC,WAAoB;IAEpB,MAAM,KAAK,GAAG,cAAc,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAa,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAa,YAAY,CAAC,CAAC;IAClJ,MAAM,aAAa,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACjE,MAAM,GAAG,GAAoB,EAAE,CAAC;IAChC,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC;IAEzC,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,KAAK,MAAM,CAAC,IAAI,MAAM,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC,EAAE,CAAC;YACpE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACvH,CAAC;IACH,CAAC;IACD,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;QAChG,KAAK,MAAM,CAAC,IAAI,MAAM,aAAa,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,CAAC;YAClE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;QAC1J,CAAC;IACH,CAAC;IACD,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1B,KAAK,MAAM,CAAC,IAAI,MAAM,aAAa,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC,EAAE,CAAC;YACtE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAChI,CAAC;IACH,CAAC;IACD,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1B,KAAK,MAAM,CAAC,IAAI,MAAM,aAAa,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC,EAAE,CAAC;YACtE,GAAG,CAAC,IAAI,CAAC;gBACP,IAAI,EAAE,UAAU;gBAChB,MAAM,EAAE,CAAC,CAAC,MAAM;gBAChB,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,GAAG,EAAE,CAAC,CAAC,GAAG;gBACV,KAAK,EAAE,IAAI;gBACX,OAAO,EAAE,CAAC,CAAC,OAAO;gBAClB,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE;aACpG,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,KAAK,MAAM,CAAC,IAAI,MAAM,aAAa,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC,EAAE,CAAC;YACtE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACzI,CAAC;IACH,CAAC;IACD,IAAI,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;QACvC,KAAK,MAAM,CAAC,IAAI,MAAM,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,CAAC;YAC1D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC;gBAAE,SAAS;YACvC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAC/I,CAAC;IACH,CAAC;IAED,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC;AAC1B,CAAC"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { getCheckConstraints, getColumns, getColumnsBatch, getForeignKeys, getForeignKeysBatch, getIndexes, getIndexesBatch, getInboundForeignKeys, getPermissions, getPrimaryKey, getPrimaryKeysBatch, getRelationMeta, getRowSecurity, getTriggers, getUniqueConstraints, getViewDefinition, } from '../db/catalog.js';
|
|
2
|
+
/** The columns/PK/outbound-FKs/indexes slice — cheap enough to compute for every relation in a schema, which is what `get_schema`'s `detail: "full"` needs. */
|
|
3
|
+
export async function buildRelationOverview(client, rel) {
|
|
4
|
+
const columns = await getColumns(client, rel);
|
|
5
|
+
const primaryKey = await getPrimaryKey(client, rel);
|
|
6
|
+
const foreignKeys = await getForeignKeys(client, rel);
|
|
7
|
+
const indexes = await getIndexes(client, rel);
|
|
8
|
+
return { columns, primaryKey, foreignKeys, indexes };
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* The batched counterpart of {@link buildRelationOverview} for many relations
|
|
12
|
+
* at once — `get_schema`'s `detail: "full"` level. Runs exactly 4 catalog
|
|
13
|
+
* queries total (one `oid = ANY($1)` pass each for columns, primary keys,
|
|
14
|
+
* foreign keys, and indexes — `db/catalog.ts`'s `*Batch` functions) no matter
|
|
15
|
+
* how many `rels` are passed, instead of 4 queries *per relation*: the
|
|
16
|
+
* previous per-relation `Promise.all(rels.map(buildRelationOverview))` shape
|
|
17
|
+
* meant 40 objects cost ~160 round trips, and the profile's default
|
|
18
|
+
* `maxRows` (500) meant up to ~2000 sequential round trips on one connection
|
|
19
|
+
* with no per-statement timeout able to catch it (each individual statement
|
|
20
|
+
* was fast). A relation with no rows in one of the four batches (e.g. no
|
|
21
|
+
* primary key, no indexes) gets the same empty/`null` default
|
|
22
|
+
* {@link buildRelationOverview} would have produced.
|
|
23
|
+
*/
|
|
24
|
+
export async function buildRelationOverviewBatch(client, rels) {
|
|
25
|
+
const oids = rels.map((r) => r.oid);
|
|
26
|
+
const columns = await getColumnsBatch(client, oids);
|
|
27
|
+
const primaryKeys = await getPrimaryKeysBatch(client, oids);
|
|
28
|
+
const foreignKeys = await getForeignKeysBatch(client, oids);
|
|
29
|
+
const indexes = await getIndexesBatch(client, oids);
|
|
30
|
+
const out = new Map();
|
|
31
|
+
for (const rel of rels) {
|
|
32
|
+
out.set(rel.oid, {
|
|
33
|
+
columns: columns.get(rel.oid) ?? [],
|
|
34
|
+
primaryKey: primaryKeys.get(rel.oid) ?? null,
|
|
35
|
+
foreignKeys: foreignKeys.get(rel.oid) ?? [],
|
|
36
|
+
indexes: indexes.get(rel.oid) ?? [],
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
return out;
|
|
40
|
+
}
|
|
41
|
+
/** The full `postgres_describe_object` payload for a table/view/materialized view/etc. */
|
|
42
|
+
export async function buildRelationDetail(client, rel) {
|
|
43
|
+
const isView = rel.kind === 'view' || rel.kind === 'materialized_view';
|
|
44
|
+
const overview = await buildRelationOverview(client, rel);
|
|
45
|
+
const meta = await getRelationMeta(client, rel);
|
|
46
|
+
const referencedBy = await getInboundForeignKeys(client, rel);
|
|
47
|
+
const uniqueConstraints = await getUniqueConstraints(client, rel);
|
|
48
|
+
const checkConstraints = await getCheckConstraints(client, rel);
|
|
49
|
+
const triggers = await getTriggers(client, rel);
|
|
50
|
+
const rowSecurity = await getRowSecurity(client, rel);
|
|
51
|
+
const permissions = await getPermissions(client, rel);
|
|
52
|
+
const viewDefinition = isView ? await getViewDefinition(client, rel) : null;
|
|
53
|
+
return { ...overview, meta, referencedBy, uniqueConstraints, checkConstraints, triggers, rowSecurity, permissions, viewDefinition };
|
|
54
|
+
}
|
|
55
|
+
//# sourceMappingURL=_relation_detail.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"_relation_detail.js","sourceRoot":"","sources":["../../src/tools/_relation_detail.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,mBAAmB,EACnB,UAAU,EACV,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,UAAU,EACV,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,WAAW,EACX,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,kBAAkB,CAAC;AAwC1B,+JAA+J;AAC/J,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,MAAkB,EAAE,GAAgB;IAC9E,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9C,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACpD,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9C,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC;AACvD,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,MAAkB,EAAE,IAA4B;IAC/F,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACpD,MAAM,WAAW,GAAG,MAAM,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5D,MAAM,WAAW,GAAG,MAAM,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,MAAM,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAEpD,MAAM,GAAG,GAAG,IAAI,GAAG,EAA4B,CAAC;IAChD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE;YACf,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE;YACnC,UAAU,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI;YAC5C,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE;YAC3C,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE;SACpC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAcD,0FAA0F;AAC1F,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,MAAkB,EAAE,GAAgB;IAC5E,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,GAAG,CAAC,IAAI,KAAK,mBAAmB,CAAC;IACvE,MAAM,QAAQ,GAAG,MAAM,qBAAqB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1D,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChD,MAAM,YAAY,GAAG,MAAM,qBAAqB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9D,MAAM,iBAAiB,GAAG,MAAM,oBAAoB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAClE,MAAM,gBAAgB,GAAG,MAAM,mBAAmB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChE,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChD,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACtD,MAAM,WAAW,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACtD,MAAM,cAAc,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,iBAAiB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAE5E,OAAO,EAAE,GAAG,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC;AACtI,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
export function defineTool(name, config, handler) {
|
|
3
|
+
// The single erasure cast. See the file header.
|
|
4
|
+
return { name, config, handler };
|
|
5
|
+
}
|
|
6
|
+
/** Shared input fragment — spread into every tool's `z.object({ ... })`. */
|
|
7
|
+
export const profileParam = {
|
|
8
|
+
profile: z
|
|
9
|
+
.string()
|
|
10
|
+
.optional()
|
|
11
|
+
.describe('Connection profile alias. Defaults to PG_MCP_DEFAULT_PROFILE.'),
|
|
12
|
+
};
|
|
13
|
+
/** Exhaustiveness guard: adding a `ToolOutcome` member breaks every switch that forgot it. */
|
|
14
|
+
export function assertNever(x) {
|
|
15
|
+
throw new Error(`unhandled variant: ${JSON.stringify(x)}`);
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=_shared.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"_shared.js","sourceRoot":"","sources":["../../src/tools/_shared.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAmCxB,MAAM,UAAU,UAAU,CACxB,IAAY,EACZ,MAAsB,EACtB,OAAyB;IAEzB,gDAAgD;IAChD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAwB,CAAC;AACzD,CAAC;AAED,4EAA4E;AAC5E,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,+DAA+D,CAAC;CAC7E,CAAC;AAwDF,8FAA8F;AAC9F,MAAM,UAAU,WAAW,CAAC,CAAQ;IAClC,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAC7D,CAAC"}
|
|
@@ -0,0 +1,238 @@
|
|
|
1
|
+
import process from 'node:process';
|
|
2
|
+
import { z } from 'zod';
|
|
3
|
+
import { readInt } from '../config/env.js';
|
|
4
|
+
import { loadProfiles } from '../config/profiles.js';
|
|
5
|
+
import { PgMcpError } from '../core/errors.js';
|
|
6
|
+
import { resolveWorkspaceFileForRead } from '../core/paths.js';
|
|
7
|
+
import { captureSnapshot } from '../snapshot/capture.js';
|
|
8
|
+
/**
|
|
9
|
+
* Shared by `postgres_schema_diff` and `postgres_prepare_migration`: both
|
|
10
|
+
* compare two "sides", each of which is either a live database or a snapshot
|
|
11
|
+
* file written earlier by `postgres_schema_snapshot`.
|
|
12
|
+
*
|
|
13
|
+
* **A snapshot file is untrusted input.** It is plain JSON on disk — nothing
|
|
14
|
+
* stops an operator (or another tool) from handing this one a hand-edited or
|
|
15
|
+
* differently-shaped file, and `diff.ts`/`migrate.ts` were written assuming
|
|
16
|
+
* the exact shape `capture.ts` produces. {@link schemaSnapshotSchema} is a
|
|
17
|
+
* `.strict()` zod mirror of every interface in `snapshot/model.ts`, so a
|
|
18
|
+
* malformed file fails here, with a specific field-level message, instead of
|
|
19
|
+
* surfacing as a confusing crash three modules downstream. It deliberately
|
|
20
|
+
* does **not** re-check `formatVersion` against {@link SNAPSHOT_FORMAT_VERSION}
|
|
21
|
+
* — that is `diff.ts#diffSnapshots`'s job (`SNAPSHOT_VERSION_MISMATCH`, which
|
|
22
|
+
* names *both* versions being compared); this only rejects a file that is not
|
|
23
|
+
* even shaped like *a* snapshot.
|
|
24
|
+
*
|
|
25
|
+
* **Untrusted also means untrusted as a *path*.** See
|
|
26
|
+
* {@link readSnapshotFile} — the containment and size checks are the same ones
|
|
27
|
+
* `tools/copy.ts` documents for its import direction, for the same reasons.
|
|
28
|
+
*/
|
|
29
|
+
const snapshotColumnSchema = z
|
|
30
|
+
.object({
|
|
31
|
+
name: z.string(),
|
|
32
|
+
type: z.string(),
|
|
33
|
+
nullable: z.boolean(),
|
|
34
|
+
default: z.string().nullable(),
|
|
35
|
+
identity: z.enum(['always', 'by default']).nullable(),
|
|
36
|
+
generated: z.literal('stored').nullable(),
|
|
37
|
+
collation: z.string().nullable(),
|
|
38
|
+
comment: z.string().nullable(),
|
|
39
|
+
})
|
|
40
|
+
.strict();
|
|
41
|
+
const snapshotConstraintSchema = z.object({ name: z.string(), definition: z.string() }).strict();
|
|
42
|
+
const snapshotForeignKeySchema = snapshotConstraintSchema
|
|
43
|
+
.extend({ refSchema: z.string(), refTable: z.string() })
|
|
44
|
+
.strict();
|
|
45
|
+
const snapshotIndexSchema = z
|
|
46
|
+
.object({
|
|
47
|
+
name: z.string(),
|
|
48
|
+
definition: z.string(),
|
|
49
|
+
unique: z.boolean(),
|
|
50
|
+
columns: z.array(z.string()),
|
|
51
|
+
predicate: z.string().nullable(),
|
|
52
|
+
})
|
|
53
|
+
.strict();
|
|
54
|
+
const snapshotTriggerSchema = z
|
|
55
|
+
.object({
|
|
56
|
+
name: z.string(),
|
|
57
|
+
timing: z.enum(['BEFORE', 'AFTER', 'INSTEAD OF']),
|
|
58
|
+
events: z.array(z.enum(['INSERT', 'UPDATE', 'DELETE', 'TRUNCATE'])),
|
|
59
|
+
definition: z.string(),
|
|
60
|
+
})
|
|
61
|
+
.strict();
|
|
62
|
+
const snapshotPolicySchema = z
|
|
63
|
+
.object({
|
|
64
|
+
name: z.string(),
|
|
65
|
+
command: z.enum(['ALL', 'SELECT', 'INSERT', 'UPDATE', 'DELETE']),
|
|
66
|
+
permissive: z.boolean(),
|
|
67
|
+
roles: z.array(z.string()),
|
|
68
|
+
using: z.string().nullable(),
|
|
69
|
+
withCheck: z.string().nullable(),
|
|
70
|
+
})
|
|
71
|
+
.strict();
|
|
72
|
+
const snapshotRowSecuritySchema = z
|
|
73
|
+
.object({ enabled: z.boolean(), forced: z.boolean(), policies: z.array(snapshotPolicySchema) })
|
|
74
|
+
.strict();
|
|
75
|
+
const snapshotTableSchema = z
|
|
76
|
+
.object({
|
|
77
|
+
name: z.string(),
|
|
78
|
+
kind: z.enum(['table', 'partitioned_table', 'foreign_table']),
|
|
79
|
+
owner: z.string(),
|
|
80
|
+
comment: z.string().nullable(),
|
|
81
|
+
inherits: z.array(z.string()),
|
|
82
|
+
partitionBound: z.string().nullable(),
|
|
83
|
+
columns: z.array(snapshotColumnSchema),
|
|
84
|
+
primaryKey: snapshotConstraintSchema.nullable(),
|
|
85
|
+
foreignKeys: z.array(snapshotForeignKeySchema),
|
|
86
|
+
uniqueConstraints: z.array(snapshotConstraintSchema),
|
|
87
|
+
checkConstraints: z.array(snapshotConstraintSchema),
|
|
88
|
+
indexes: z.array(snapshotIndexSchema),
|
|
89
|
+
triggers: z.array(snapshotTriggerSchema),
|
|
90
|
+
rowSecurity: snapshotRowSecuritySchema,
|
|
91
|
+
})
|
|
92
|
+
.strict();
|
|
93
|
+
const snapshotViewSchema = z
|
|
94
|
+
.object({
|
|
95
|
+
name: z.string(),
|
|
96
|
+
kind: z.enum(['view', 'materialized_view']),
|
|
97
|
+
owner: z.string(),
|
|
98
|
+
comment: z.string().nullable(),
|
|
99
|
+
definition: z.string().nullable(),
|
|
100
|
+
columns: z.array(snapshotColumnSchema),
|
|
101
|
+
indexes: z.array(snapshotIndexSchema),
|
|
102
|
+
triggers: z.array(snapshotTriggerSchema),
|
|
103
|
+
})
|
|
104
|
+
.strict();
|
|
105
|
+
const snapshotSequenceSchema = z
|
|
106
|
+
.object({
|
|
107
|
+
name: z.string(),
|
|
108
|
+
owner: z.string(),
|
|
109
|
+
comment: z.string().nullable(),
|
|
110
|
+
dataType: z.string(),
|
|
111
|
+
startValue: z.string(),
|
|
112
|
+
minValue: z.string(),
|
|
113
|
+
maxValue: z.string(),
|
|
114
|
+
incrementBy: z.string(),
|
|
115
|
+
cacheSize: z.string(),
|
|
116
|
+
cycle: z.boolean(),
|
|
117
|
+
})
|
|
118
|
+
.strict();
|
|
119
|
+
const snapshotFunctionSchema = z
|
|
120
|
+
.object({
|
|
121
|
+
name: z.string(),
|
|
122
|
+
arguments: z.string(),
|
|
123
|
+
returns: z.string(),
|
|
124
|
+
language: z.string(),
|
|
125
|
+
kind: z.string(),
|
|
126
|
+
body: z.string().nullable(),
|
|
127
|
+
comment: z.string().nullable(),
|
|
128
|
+
})
|
|
129
|
+
.strict();
|
|
130
|
+
const snapshotEnumSchema = z.object({ name: z.string(), labels: z.array(z.string()), comment: z.string().nullable() }).strict();
|
|
131
|
+
const snapshotSchemaSchema = z
|
|
132
|
+
.object({
|
|
133
|
+
name: z.string(),
|
|
134
|
+
owner: z.string(),
|
|
135
|
+
tables: z.array(snapshotTableSchema),
|
|
136
|
+
views: z.array(snapshotViewSchema),
|
|
137
|
+
materializedViews: z.array(snapshotViewSchema),
|
|
138
|
+
sequences: z.array(snapshotSequenceSchema),
|
|
139
|
+
functions: z.array(snapshotFunctionSchema),
|
|
140
|
+
enums: z.array(snapshotEnumSchema),
|
|
141
|
+
})
|
|
142
|
+
.strict();
|
|
143
|
+
const snapshotExtensionSchema = z.object({ name: z.string(), version: z.string() }).strict();
|
|
144
|
+
/** `.strict()` mirror of `snapshot/model.ts#SchemaSnapshot` — see the file header. */
|
|
145
|
+
export const schemaSnapshotSchema = z
|
|
146
|
+
.object({
|
|
147
|
+
formatVersion: z.number().int(),
|
|
148
|
+
database: z.string(),
|
|
149
|
+
schemas: z.array(snapshotSchemaSchema),
|
|
150
|
+
extensions: z.array(snapshotExtensionSchema),
|
|
151
|
+
})
|
|
152
|
+
.strict();
|
|
153
|
+
/** Parses and validates untrusted JSON text read from a workspace file. Throws `PgMcpError` `SNAPSHOT_INVALID` with a concrete reason — never lets a malformed file reach `diff.ts`/`migrate.ts`. */
|
|
154
|
+
export function parseSnapshotFile(raw, origin) {
|
|
155
|
+
let json;
|
|
156
|
+
try {
|
|
157
|
+
json = JSON.parse(raw);
|
|
158
|
+
}
|
|
159
|
+
catch (err) {
|
|
160
|
+
throw new PgMcpError({
|
|
161
|
+
code: 'SNAPSHOT_INVALID',
|
|
162
|
+
message: `"${origin}" is not valid JSON`,
|
|
163
|
+
hint: 'this file was not written by postgres_schema_snapshot, or it is truncated or corrupted — recapture it',
|
|
164
|
+
cause: err,
|
|
165
|
+
});
|
|
166
|
+
}
|
|
167
|
+
const parsed = schemaSnapshotSchema.safeParse(json);
|
|
168
|
+
if (!parsed.success) {
|
|
169
|
+
const issues = parsed.error.issues
|
|
170
|
+
.slice(0, 5)
|
|
171
|
+
.map((i) => `${i.path.length === 0 ? '(root)' : i.path.join('.')}: ${i.message}`)
|
|
172
|
+
.join('; ');
|
|
173
|
+
throw new PgMcpError({
|
|
174
|
+
code: 'SNAPSHOT_INVALID',
|
|
175
|
+
message: `"${origin}" does not match the schema snapshot format (${parsed.error.issues.length} issue(s)): ${issues}`,
|
|
176
|
+
hint: 'this file was not written by postgres_schema_snapshot, or was written by an incompatible version — recapture it with postgres_schema_snapshot',
|
|
177
|
+
details: { origin, issueCount: parsed.error.issues.length },
|
|
178
|
+
});
|
|
179
|
+
}
|
|
180
|
+
return parsed.data;
|
|
181
|
+
}
|
|
182
|
+
const liveSource = z.object({
|
|
183
|
+
kind: z.literal('live'),
|
|
184
|
+
profile: z.string().optional().describe('Overrides the top-level profile for this side. Defaults to the top-level profile.'),
|
|
185
|
+
schemas: z.array(z.string().min(1)).optional().describe('Restrict this side\'s capture to these schemas. Omit for every schema in scope.'),
|
|
186
|
+
});
|
|
187
|
+
const fileSource = z.object({
|
|
188
|
+
kind: z.literal('file'),
|
|
189
|
+
path: z.string().min(1).describe('Path to a snapshot file written by postgres_schema_snapshot. Same resolution rules as postgres_export.'),
|
|
190
|
+
profile: z.string().optional().describe('Profile whose allowed directories this path resolves against. Defaults to the top-level profile.'),
|
|
191
|
+
});
|
|
192
|
+
/** One side of a comparison: a live database capture, or a previously written snapshot file. */
|
|
193
|
+
export const snapshotSourceSchema = z.discriminatedUnion('kind', [liveSource, fileSource]);
|
|
194
|
+
/** Resolves one comparison side to a `SchemaSnapshot`, capturing live or reading+validating a workspace file. */
|
|
195
|
+
export async function resolveSnapshotSource(source, defaultProfileAlias) {
|
|
196
|
+
const registry = loadProfiles();
|
|
197
|
+
const profile = registry.get(source.profile ?? defaultProfileAlias);
|
|
198
|
+
if (source.kind === 'live') {
|
|
199
|
+
return captureSnapshot(profile, source.schemas === undefined ? {} : { schemas: source.schemas });
|
|
200
|
+
}
|
|
201
|
+
const { path, raw } = await readSnapshotFile(source.path, profile.allowedDirs);
|
|
202
|
+
return parseSnapshotFile(raw, path);
|
|
203
|
+
}
|
|
204
|
+
/**
|
|
205
|
+
* Generous for any snapshot this server writes (a 200-relation database is a
|
|
206
|
+
* few MB) and far below V8's ~512 MB maximum string length, which is what an
|
|
207
|
+
* unbounded `readFile(…, 'utf8')` used to hit instead — reporting `Invalid
|
|
208
|
+
* string length` as `PATH_DENIED` with a hint about the path being wrong,
|
|
209
|
+
* after already having read the whole file into memory.
|
|
210
|
+
*/
|
|
211
|
+
const DEFAULT_MAX_SNAPSHOT_BYTES = 64 * 1024 * 1024;
|
|
212
|
+
/**
|
|
213
|
+
* Reads a snapshot file through `core/paths.ts#resolveWorkspaceFileForRead` —
|
|
214
|
+
* the one read-side path policy, shared with `postgres_copy`'s import
|
|
215
|
+
* direction and `postgres_restore`'s archive. That helper refuses the path for
|
|
216
|
+
* containment (double-resolve, so a symlink planted inside an allowed
|
|
217
|
+
* directory cannot lead out of it), for kind, and for size, opens it once and
|
|
218
|
+
* checks the open handle's `ino`, all before a single byte is read. Only the
|
|
219
|
+
* wording and the cap are this tool's.
|
|
220
|
+
*/
|
|
221
|
+
export async function readSnapshotFile(input, allowedDirs) {
|
|
222
|
+
const cap = readInt(process.env, 'PG_MCP_MAX_SNAPSHOT_BYTES', { default: DEFAULT_MAX_SNAPSHOT_BYTES, min: 1 });
|
|
223
|
+
const { path, handle } = await resolveWorkspaceFileForRead(input, allowedDirs, {
|
|
224
|
+
maxBytes: cap,
|
|
225
|
+
limitLabel: 'snapshot read',
|
|
226
|
+
limitHint: 'a snapshot this large is almost certainly not one postgres_schema_snapshot wrote — check the path, or raise ' +
|
|
227
|
+
`PG_MCP_MAX_SNAPSHOT_BYTES (currently ${cap}) and restart the server`,
|
|
228
|
+
missingHint: 'run postgres_schema_snapshot first to create it, or check that the path is correct and inside an allowed directory',
|
|
229
|
+
notFileHint: 'point path at a file written by postgres_schema_snapshot, not a directory or device',
|
|
230
|
+
});
|
|
231
|
+
try {
|
|
232
|
+
return { path, raw: await handle.readFile('utf8') };
|
|
233
|
+
}
|
|
234
|
+
finally {
|
|
235
|
+
await handle.close();
|
|
236
|
+
}
|
|
237
|
+
}
|
|
238
|
+
//# sourceMappingURL=_snapshot_io.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"_snapshot_io.js","sourceRoot":"","sources":["../../src/tools/_snapshot_io.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,2BAA2B,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAGzD;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,MAAM,oBAAoB,GAAG,CAAC;KAC3B,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IACrB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE;IACrD,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE;IACzC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;AAEjG,MAAM,wBAAwB,GAAG,wBAAwB;KACtD,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;KACvD,MAAM,EAAE,CAAC;AAEZ,MAAM,mBAAmB,GAAG,CAAC;KAC1B,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,MAAM,qBAAqB,GAAG,CAAC;KAC5B,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;IACjD,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;IACnE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;CACvB,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,MAAM,oBAAoB,GAAG,CAAC;KAC3B,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAChE,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,MAAM,yBAAyB,GAAG,CAAC;KAChC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAE,CAAC;KAC9F,MAAM,EAAE,CAAC;AAEZ,MAAM,mBAAmB,GAAG,CAAC;KAC1B,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,mBAAmB,EAAE,eAAe,CAAC,CAAC;IAC7D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC7B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;IACtC,UAAU,EAAE,wBAAwB,CAAC,QAAQ,EAAE;IAC/C,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC;IAC9C,iBAAiB,EAAE,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC;IACpD,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC;IACnD,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC;IACrC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC;IACxC,WAAW,EAAE,yBAAyB;CACvC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,MAAM,kBAAkB,GAAG,CAAC;KACzB,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC3C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;IACtC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC;IACrC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC;CACzC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,MAAM,sBAAsB,GAAG,CAAC;KAC7B,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE;CACnB,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,MAAM,sBAAsB,GAAG,CAAC;KAC7B,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;AAEhI,MAAM,oBAAoB,GAAG,CAAC;KAC3B,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC;IACpC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;IAClC,iBAAiB,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;IAC9C,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC;IAC1C,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC;IAC1C,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC;CACnC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;AAE7F,sFAAsF;AACtF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,MAAM,CAAC;IACN,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC/B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;IACtC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC;CAC7C,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,qMAAqM;AACrM,MAAM,UAAU,iBAAiB,CAAC,GAAW,EAAE,MAAc;IAC3D,IAAI,IAAa,CAAC;IAClB,IAAI,CAAC;QACH,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,IAAI,UAAU,CAAC;YACnB,IAAI,EAAE,kBAAkB;YACxB,OAAO,EAAE,IAAI,MAAM,qBAAqB;YACxC,IAAI,EAAE,uGAAuG;YAC7G,KAAK,EAAE,GAAG;SACX,CAAC,CAAC;IACL,CAAC;IACD,MAAM,MAAM,GAAG,oBAAoB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACpD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM;aAC/B,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;aACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;aAChF,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,MAAM,IAAI,UAAU,CAAC;YACnB,IAAI,EAAE,kBAAkB;YACxB,OAAO,EAAE,IAAI,MAAM,gDAAgD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,eAAe,MAAM,EAAE;YACpH,IAAI,EAAE,+IAA+I;YACrJ,OAAO,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE;SAC5D,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACvB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,mFAAmF,CAAC;IAC5H,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iFAAiF,CAAC;CAC3I,CAAC,CAAC;AAEH,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1B,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACvB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,wGAAwG,CAAC;IAC1I,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kGAAkG,CAAC;CAC5I,CAAC,CAAC;AAEH,gGAAgG;AAChG,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;AAG3F,iHAAiH;AACjH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,MAAsB,EAAE,mBAAuC;IACzG,MAAM,QAAQ,GAAG,YAAY,EAAE,CAAC;IAChC,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,mBAAmB,CAAC,CAAC;IAEpE,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC3B,OAAO,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,gBAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/E,OAAO,iBAAiB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,0BAA0B,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AAEpD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,KAAa,EAAE,WAA8B;IAClF,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,2BAA2B,EAAE,EAAE,OAAO,EAAE,0BAA0B,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;IAC/G,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,2BAA2B,CAAC,KAAK,EAAE,WAAW,EAAE;QAC7E,QAAQ,EAAE,GAAG;QACb,UAAU,EAAE,eAAe;QAC3B,SAAS,EACP,8GAA8G;YAC9G,wCAAwC,GAAG,0BAA0B;QACvE,WAAW,EACT,oHAAoH;QACtH,WAAW,EAAE,qFAAqF;KACnG,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;IACtD,CAAC;YAAS,CAAC;QACT,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { resolveLimits, truncateRows } from '../../core/limits.js';
|
|
2
|
+
/**
|
|
3
|
+
* Wraps a catalog-sourced list into a `report` outcome, applying the same
|
|
4
|
+
* row/byte caps every other listing tool respects (`Profile.maxRows` /
|
|
5
|
+
* `PG_MCP_MAX_BYTES`). All of `postgres_admin`'s read sub-operations
|
|
6
|
+
* (`roles_list`, `grants_get`, `extensions_list`, `sessions_list`,
|
|
7
|
+
* `stats_*`) render through this — none of them are query-result rows with
|
|
8
|
+
* `ColumnMeta`, so the `rows` outcome kind does not fit; `report` does.
|
|
9
|
+
*/
|
|
10
|
+
export function reportList(profile, items) {
|
|
11
|
+
const caps = resolveLimits(profile.maxRows);
|
|
12
|
+
const { rows, truncation } = truncateRows(items, caps, (row) => JSON.stringify(row));
|
|
13
|
+
return {
|
|
14
|
+
kind: 'report',
|
|
15
|
+
data: truncation.reason === null ? { count: rows.length, items: rows } : { count: rows.length, items: rows, truncation },
|
|
16
|
+
};
|
|
17
|
+
}
|
|
18
|
+
//# sourceMappingURL=_shared.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"_shared.js","sourceRoot":"","sources":["../../../src/tools/admin/_shared.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGnE;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAI,OAAgB,EAAE,KAAmB;IACjE,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;IACrF,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,UAAU,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE;KACzH,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { CONFIRM_PROTOCOL_DESCRIPTION, runGuardedMutation } from '../../core/guards.js';
|
|
3
|
+
import { resolveAvailableExtension, resolveInstalledExtension, resolveSchemaIdent } from '../../core/identifiers.js';
|
|
4
|
+
import { listAvailableExtensions } from '../../db/catalog.js';
|
|
5
|
+
import { withSession } from '../../db/session.js';
|
|
6
|
+
import { confirmFragment, toExpectToken } from '../_batch_shared.js';
|
|
7
|
+
import { reportList } from './_shared.js';
|
|
8
|
+
/**
|
|
9
|
+
* `extensions` sub-operation. `extensions_list` (read-only, no capability)
|
|
10
|
+
* reads `pg_available_extensions`, which already carries both
|
|
11
|
+
* `default_version` and `installed_version` — one query covers "available"
|
|
12
|
+
* and "installed" at once, no separate listing needed.
|
|
13
|
+
*
|
|
14
|
+
* `extensions_create`/`extensions_drop` require `admin`. `CREATE EXTENSION`
|
|
15
|
+
* runs that extension's install script as superuser, which can run
|
|
16
|
+
* arbitrary SQL — the tool description says so explicitly, and
|
|
17
|
+
* `resolveAvailableExtension` refuses an extension PostgreSQL does not
|
|
18
|
+
* already know about (its control file is not installed) before any of
|
|
19
|
+
* that can happen.
|
|
20
|
+
*/
|
|
21
|
+
export const extensionsListSchema = z.object({
|
|
22
|
+
op: z.literal('extensions_list'),
|
|
23
|
+
namePattern: z.string().optional().describe('SQL ILIKE pattern to filter extension names.'),
|
|
24
|
+
});
|
|
25
|
+
export const extensionsCreateSchema = z.object({
|
|
26
|
+
op: z.literal('extensions_create'),
|
|
27
|
+
extension: z.string().min(1),
|
|
28
|
+
schema: z.string().min(1).optional().describe('Target schema; must already exist. Omit to use the default search_path schema.'),
|
|
29
|
+
version: z.string().min(1).optional(),
|
|
30
|
+
...confirmFragment,
|
|
31
|
+
});
|
|
32
|
+
export const extensionsDropSchema = z.object({
|
|
33
|
+
op: z.literal('extensions_drop'),
|
|
34
|
+
extension: z.string().min(1),
|
|
35
|
+
cascade: z.boolean().optional().default(false),
|
|
36
|
+
...confirmFragment,
|
|
37
|
+
});
|
|
38
|
+
export async function handleExtensionsList(profile, args) {
|
|
39
|
+
const extensions = await withSession(profile, (client) => listAvailableExtensions(client, args.namePattern), { operation: 'admin_extensions_list' });
|
|
40
|
+
return reportList(profile, extensions);
|
|
41
|
+
}
|
|
42
|
+
export async function handleExtensionsCreate(profile, args) {
|
|
43
|
+
const extIdent = await resolveAvailableExtension(profile, args.extension);
|
|
44
|
+
const schemaIdent = args.schema === undefined ? undefined : (await resolveSchemaIdent(profile, args.schema)).name;
|
|
45
|
+
const parts = [`CREATE EXTENSION ${extIdent}`];
|
|
46
|
+
if (schemaIdent !== undefined)
|
|
47
|
+
parts.push(`SCHEMA ${schemaIdent}`);
|
|
48
|
+
if (args.version !== undefined)
|
|
49
|
+
parts.push(`VERSION '${args.version.replace(/'/g, "''")}'`);
|
|
50
|
+
return runGuardedMutation({
|
|
51
|
+
profile,
|
|
52
|
+
capability: 'admin',
|
|
53
|
+
operation: 'admin_extensions_create',
|
|
54
|
+
sql: parts.join(' '),
|
|
55
|
+
params: [],
|
|
56
|
+
keyColumns: [],
|
|
57
|
+
confirm: args.confirm,
|
|
58
|
+
expect: toExpectToken(args.expect),
|
|
59
|
+
allowRowDrift: args.allowRowDrift,
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
export async function handleExtensionsDrop(profile, args) {
|
|
63
|
+
const extIdent = await resolveInstalledExtension(profile, args.extension);
|
|
64
|
+
const sql = `DROP EXTENSION ${extIdent}${args.cascade ? ' CASCADE' : ''}`;
|
|
65
|
+
return runGuardedMutation({
|
|
66
|
+
profile,
|
|
67
|
+
capability: 'admin',
|
|
68
|
+
operation: 'admin_extensions_drop',
|
|
69
|
+
sql,
|
|
70
|
+
params: [],
|
|
71
|
+
keyColumns: [],
|
|
72
|
+
confirm: args.confirm,
|
|
73
|
+
expect: toExpectToken(args.expect),
|
|
74
|
+
allowRowDrift: args.allowRowDrift,
|
|
75
|
+
});
|
|
76
|
+
}
|
|
77
|
+
export const EXTENSIONS_DESCRIPTION = `\`extensions_list\` (read-only, no capability) lists available and installed extensions with versions. \`extensions_create\`/` +
|
|
78
|
+
`\`extensions_drop\` require \`admin\`. WARNING: installing an extension runs that extension's install script as superuser — ` +
|
|
79
|
+
`this can execute arbitrary SQL, not just add functions. ${CONFIRM_PROTOCOL_DESCRIPTION}`;
|
|
80
|
+
//# sourceMappingURL=extensions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"extensions.js","sourceRoot":"","sources":["../../../src/tools/admin/extensions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,4BAA4B,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACxF,OAAO,EAAE,yBAAyB,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACrH,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAErE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;;;;;;;;;;GAYG;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAChC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,8CAA8C,CAAC;CAC5F,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC;IAClC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gFAAgF,CAAC;IAC/H,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACrC,GAAG,eAAe;CACnB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5B,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAC9C,GAAG,eAAe;CACnB,CAAC,CAAC;AAEH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,OAAgB,EAAE,IAA0C;IACrG,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,uBAAuB,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,uBAAuB,EAAE,CAAC,CAAC;IACrJ,OAAO,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,OAAgB,EAAE,IAA4C;IACzG,MAAM,QAAQ,GAAG,MAAM,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC1E,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;IAElH,MAAM,KAAK,GAAG,CAAC,oBAAoB,QAAQ,EAAE,CAAC,CAAC;IAC/C,IAAI,WAAW,KAAK,SAAS;QAAE,KAAK,CAAC,IAAI,CAAC,UAAU,WAAW,EAAE,CAAC,CAAC;IACnE,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;QAAE,KAAK,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IAE5F,OAAO,kBAAkB,CAAC;QACxB,OAAO;QACP,UAAU,EAAE,OAAO;QACnB,SAAS,EAAE,yBAAyB;QACpC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;QACpB,MAAM,EAAE,EAAE;QACV,UAAU,EAAE,EAAE;QACd,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC;QAClC,aAAa,EAAE,IAAI,CAAC,aAAa;KAClC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,OAAgB,EAAE,IAA0C;IACrG,MAAM,QAAQ,GAAG,MAAM,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAC1E,MAAM,GAAG,GAAG,kBAAkB,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAE1E,OAAO,kBAAkB,CAAC;QACxB,OAAO;QACP,UAAU,EAAE,OAAO;QACnB,SAAS,EAAE,uBAAuB;QAClC,GAAG;QACH,MAAM,EAAE,EAAE;QACV,UAAU,EAAE,EAAE;QACd,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM,EAAE,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC;QAClC,aAAa,EAAE,IAAI,CAAC,aAAa;KAClC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,MAAM,sBAAsB,GACjC,+HAA+H;IAC/H,8HAA8H;IAC9H,2DAA2D,4BAA4B,EAAE,CAAC"}
|