@querypanel/node-sdk 1.0.8 → 1.0.10

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 (70) hide show
  1. package/README.md +174 -0
  2. package/dist/cjs/adapters/clickhouse.d.ts +36 -0
  3. package/dist/cjs/adapters/clickhouse.d.ts.map +1 -0
  4. package/dist/cjs/adapters/clickhouse.js +259 -0
  5. package/dist/cjs/adapters/clickhouse.js.map +1 -0
  6. package/dist/cjs/adapters/introspection.spec.d.ts +2 -0
  7. package/dist/cjs/adapters/introspection.spec.d.ts.map +1 -0
  8. package/dist/cjs/adapters/introspection.spec.js +201 -0
  9. package/dist/cjs/adapters/introspection.spec.js.map +1 -0
  10. package/dist/cjs/adapters/postgres.d.ts +35 -0
  11. package/dist/cjs/adapters/postgres.d.ts.map +1 -0
  12. package/dist/cjs/adapters/postgres.js +407 -0
  13. package/dist/cjs/adapters/postgres.js.map +1 -0
  14. package/dist/cjs/adapters/types.d.ts +36 -0
  15. package/dist/cjs/adapters/types.d.ts.map +1 -0
  16. package/dist/cjs/adapters/types.js +3 -0
  17. package/dist/cjs/adapters/types.js.map +1 -0
  18. package/dist/cjs/anonymize.spec.d.ts +2 -0
  19. package/dist/cjs/anonymize.spec.d.ts.map +1 -0
  20. package/dist/cjs/anonymize.spec.js +80 -0
  21. package/dist/cjs/anonymize.spec.js.map +1 -0
  22. package/dist/cjs/clickhouseClient.spec.d.ts +2 -0
  23. package/dist/cjs/clickhouseClient.spec.d.ts.map +1 -0
  24. package/dist/cjs/clickhouseClient.spec.js +286 -0
  25. package/dist/cjs/clickhouseClient.spec.js.map +1 -0
  26. package/dist/cjs/index.d.ts +101 -1
  27. package/dist/cjs/index.d.ts.map +1 -1
  28. package/dist/cjs/index.js +321 -53
  29. package/dist/cjs/index.js.map +1 -1
  30. package/dist/cjs/index.test.js +52 -7
  31. package/dist/cjs/index.test.js.map +1 -1
  32. package/dist/cjs/multidb.spec.d.ts +2 -0
  33. package/dist/cjs/multidb.spec.d.ts.map +1 -0
  34. package/dist/cjs/multidb.spec.js +76 -0
  35. package/dist/cjs/multidb.spec.js.map +1 -0
  36. package/dist/esm/adapters/clickhouse.d.ts +36 -0
  37. package/dist/esm/adapters/clickhouse.d.ts.map +1 -0
  38. package/dist/esm/adapters/clickhouse.js +255 -0
  39. package/dist/esm/adapters/clickhouse.js.map +1 -0
  40. package/dist/esm/adapters/introspection.spec.d.ts +2 -0
  41. package/dist/esm/adapters/introspection.spec.d.ts.map +1 -0
  42. package/dist/esm/adapters/introspection.spec.js +199 -0
  43. package/dist/esm/adapters/introspection.spec.js.map +1 -0
  44. package/dist/esm/adapters/postgres.d.ts +35 -0
  45. package/dist/esm/adapters/postgres.d.ts.map +1 -0
  46. package/dist/esm/adapters/postgres.js +403 -0
  47. package/dist/esm/adapters/postgres.js.map +1 -0
  48. package/dist/esm/adapters/types.d.ts +36 -0
  49. package/dist/esm/adapters/types.d.ts.map +1 -0
  50. package/dist/esm/adapters/types.js +2 -0
  51. package/dist/esm/adapters/types.js.map +1 -0
  52. package/dist/esm/anonymize.spec.d.ts +2 -0
  53. package/dist/esm/anonymize.spec.d.ts.map +1 -0
  54. package/dist/esm/anonymize.spec.js +78 -0
  55. package/dist/esm/anonymize.spec.js.map +1 -0
  56. package/dist/esm/clickhouseClient.spec.d.ts +2 -0
  57. package/dist/esm/clickhouseClient.spec.d.ts.map +1 -0
  58. package/dist/esm/clickhouseClient.spec.js +281 -0
  59. package/dist/esm/clickhouseClient.spec.js.map +1 -0
  60. package/dist/esm/index.d.ts +101 -1
  61. package/dist/esm/index.d.ts.map +1 -1
  62. package/dist/esm/index.js +320 -53
  63. package/dist/esm/index.js.map +1 -1
  64. package/dist/esm/index.test.js +52 -7
  65. package/dist/esm/index.test.js.map +1 -1
  66. package/dist/esm/multidb.spec.d.ts +2 -0
  67. package/dist/esm/multidb.spec.d.ts.map +1 -0
  68. package/dist/esm/multidb.spec.js +74 -0
  69. package/dist/esm/multidb.spec.js.map +1 -0
  70. package/package.json +5 -2
@@ -0,0 +1,199 @@
1
+ import { describe, expect, it, vi } from "vitest";
2
+ import { ClickHouseAdapter, } from "./clickhouse.js";
3
+ import { PostgresAdapter, } from "./postgres.js";
4
+ function createClickHouseResponse(rows) {
5
+ return {
6
+ json: async () => rows,
7
+ };
8
+ }
9
+ describe("Database adapter introspection", () => {
10
+ it("introspects ClickHouse tables", async () => {
11
+ const clientFn = vi.fn(async ({ query }) => {
12
+ if (query.includes("FROM system.tables")) {
13
+ return createClickHouseResponse([
14
+ {
15
+ name: "events",
16
+ engine: "MergeTree",
17
+ comment: "Main events table",
18
+ total_rows: "1000",
19
+ total_bytes: "2048",
20
+ is_view: "0",
21
+ primary_key: "(id)",
22
+ sorting_key: null,
23
+ },
24
+ ]);
25
+ }
26
+ if (query.includes("FROM system.columns")) {
27
+ return createClickHouseResponse([
28
+ {
29
+ table: "events",
30
+ name: "id",
31
+ type: "UInt64",
32
+ position: 1,
33
+ default_kind: null,
34
+ default_expression: null,
35
+ comment: "Primary identifier",
36
+ codec_expression: null,
37
+ ttl_expression: null,
38
+ is_in_primary_key: "1",
39
+ data_compressed_bytes: "128",
40
+ data_uncompressed_bytes: "256",
41
+ },
42
+ {
43
+ table: "events",
44
+ name: "name",
45
+ type: "Nullable(String)",
46
+ position: 2,
47
+ default_kind: null,
48
+ default_expression: null,
49
+ comment: null,
50
+ codec_expression: null,
51
+ ttl_expression: null,
52
+ is_in_primary_key: "0",
53
+ data_compressed_bytes: null,
54
+ data_uncompressed_bytes: null,
55
+ },
56
+ ]);
57
+ }
58
+ return createClickHouseResponse([]);
59
+ });
60
+ const adapter = new ClickHouseAdapter(clientFn, {
61
+ database: "analytics",
62
+ });
63
+ const result = await adapter.introspect();
64
+ expect(result.db.name).toBe("analytics");
65
+ expect(result.tables).toHaveLength(1);
66
+ const table = result.tables[0];
67
+ if (!table)
68
+ throw new Error("missing table");
69
+ expect(table.columns.map((c) => c.name)).toEqual(["id", "name"]);
70
+ const idColumn = table.columns.find((c) => c.name === "id");
71
+ expect(idColumn?.isPrimaryKey).toBe(true);
72
+ expect(table.indexes[0]?.name).toBe("primary_key");
73
+ });
74
+ it("introspects Postgres tables", async () => {
75
+ const responses = new Map();
76
+ responses.set("tables", () => ({
77
+ rows: [
78
+ {
79
+ table_name: "users",
80
+ schema_name: "public",
81
+ table_type: "BASE TABLE",
82
+ comment: "application users",
83
+ total_rows: 200,
84
+ total_bytes: 4096,
85
+ },
86
+ ],
87
+ fields: [],
88
+ }));
89
+ responses.set("columns", () => ({
90
+ rows: [
91
+ {
92
+ table_name: "users",
93
+ table_schema: "public",
94
+ column_name: "id",
95
+ data_type: "integer",
96
+ udt_name: "int4",
97
+ is_nullable: "NO",
98
+ column_default: "nextval('users_id_seq'::regclass)",
99
+ character_maximum_length: null,
100
+ numeric_precision: 32,
101
+ numeric_scale: 0,
102
+ ordinal_position: 1,
103
+ description: "primary key",
104
+ },
105
+ {
106
+ table_name: "users",
107
+ table_schema: "public",
108
+ column_name: "role_id",
109
+ data_type: "integer",
110
+ udt_name: "int4",
111
+ is_nullable: "YES",
112
+ column_default: null,
113
+ character_maximum_length: null,
114
+ numeric_precision: 32,
115
+ numeric_scale: 0,
116
+ ordinal_position: 2,
117
+ description: null,
118
+ },
119
+ ],
120
+ fields: [],
121
+ }));
122
+ responses.set("constraints", () => ({
123
+ rows: [
124
+ {
125
+ table_schema: "public",
126
+ table_name: "users",
127
+ constraint_name: "users_pkey",
128
+ constraint_type: "PRIMARY KEY",
129
+ column_name: "id",
130
+ foreign_table_schema: null,
131
+ foreign_table_name: null,
132
+ foreign_column_name: null,
133
+ },
134
+ {
135
+ table_schema: "public",
136
+ table_name: "users",
137
+ constraint_name: "users_role_id_fkey",
138
+ constraint_type: "FOREIGN KEY",
139
+ column_name: "role_id",
140
+ foreign_table_schema: "public",
141
+ foreign_table_name: "roles",
142
+ foreign_column_name: "id",
143
+ },
144
+ ],
145
+ fields: [],
146
+ }));
147
+ responses.set("indexes", () => ({
148
+ rows: [
149
+ {
150
+ schema_name: "public",
151
+ table_name: "users",
152
+ index_name: "users_pkey",
153
+ indisunique: true,
154
+ column_names: ["id"],
155
+ definition: "CREATE UNIQUE INDEX users_pkey ON public.users USING btree (id)",
156
+ },
157
+ ],
158
+ fields: [],
159
+ }));
160
+ let indexQuerySql = null;
161
+ let lastSql = null;
162
+ const clientFn = vi.fn(async (sql) => {
163
+ lastSql = sql;
164
+ if (/pg_index\s+idx/.test(sql)) {
165
+ indexQuerySql = sql;
166
+ return responses.get("indexes")?.() ?? { rows: [], fields: [] };
167
+ }
168
+ if (sql.includes("FROM pg_class c")) {
169
+ return responses.get("tables")?.() ?? { rows: [], fields: [] };
170
+ }
171
+ if (sql.includes("information_schema.columns")) {
172
+ return responses.get("columns")?.() ?? { rows: [], fields: [] };
173
+ }
174
+ if (sql.includes("table_constraints")) {
175
+ return responses.get("constraints")?.() ?? { rows: [], fields: [] };
176
+ }
177
+ return { rows: [], fields: [] };
178
+ });
179
+ const adapter = new PostgresAdapter(clientFn, {
180
+ database: "app",
181
+ defaultSchema: "public",
182
+ });
183
+ const result = await adapter.introspect();
184
+ if (!indexQuerySql) {
185
+ throw new Error(`index query not executed. last sql: ${lastSql}`);
186
+ }
187
+ expect(result.db.name).toBe("app");
188
+ const table = result.tables[0];
189
+ if (!table)
190
+ throw new Error("expected table");
191
+ expect(table.constraints).toHaveLength(2);
192
+ const fk = table.constraints.find((c) => c.type === "FOREIGN KEY");
193
+ expect(fk?.referencedTable).toBe("public.roles");
194
+ const roleColumn = table.columns.find((c) => c.name === "role_id");
195
+ expect(roleColumn?.isForeignKey).toBe(true);
196
+ expect(table.indexes[0]?.columns).toEqual(["id"]);
197
+ });
198
+ });
199
+ //# sourceMappingURL=introspection.spec.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"introspection.spec.js","sourceRoot":"","sources":["../../../src/adapters/introspection.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,EACL,iBAAiB,GAElB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,eAAe,GAEhB,MAAM,eAAe,CAAC;AAEvB,SAAS,wBAAwB,CAAC,IAAoC;IACpE,OAAO;QACL,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI;KACvB,CAAC;AACJ,CAAC;AAED,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;IAC9C,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;QAC7C,MAAM,QAAQ,GAAuB,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;YAC7D,IAAI,KAAK,CAAC,QAAQ,CAAC,oBAAoB,CAAC,EAAE,CAAC;gBACzC,OAAO,wBAAwB,CAAC;oBAC9B;wBACE,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE,WAAW;wBACnB,OAAO,EAAE,mBAAmB;wBAC5B,UAAU,EAAE,MAAM;wBAClB,WAAW,EAAE,MAAM;wBACnB,OAAO,EAAE,GAAG;wBACZ,WAAW,EAAE,MAAM;wBACnB,WAAW,EAAE,IAAI;qBAClB;iBACF,CAAC,CAAC;YACL,CAAC;YACD,IAAI,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAAC;gBAC1C,OAAO,wBAAwB,CAAC;oBAC9B;wBACE,KAAK,EAAE,QAAQ;wBACf,IAAI,EAAE,IAAI;wBACV,IAAI,EAAE,QAAQ;wBACd,QAAQ,EAAE,CAAC;wBACX,YAAY,EAAE,IAAI;wBAClB,kBAAkB,EAAE,IAAI;wBACxB,OAAO,EAAE,oBAAoB;wBAC7B,gBAAgB,EAAE,IAAI;wBACtB,cAAc,EAAE,IAAI;wBACpB,iBAAiB,EAAE,GAAG;wBACtB,qBAAqB,EAAE,KAAK;wBAC5B,uBAAuB,EAAE,KAAK;qBAC/B;oBACD;wBACE,KAAK,EAAE,QAAQ;wBACf,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,kBAAkB;wBACxB,QAAQ,EAAE,CAAC;wBACX,YAAY,EAAE,IAAI;wBAClB,kBAAkB,EAAE,IAAI;wBACxB,OAAO,EAAE,IAAI;wBACb,gBAAgB,EAAE,IAAI;wBACtB,cAAc,EAAE,IAAI;wBACpB,iBAAiB,EAAE,GAAG;wBACtB,qBAAqB,EAAE,IAAI;wBAC3B,uBAAuB,EAAE,IAAI;qBAC9B;iBACF,CAAC,CAAC;YACL,CAAC;YACD,OAAO,wBAAwB,CAAC,EAAE,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,QAAQ,EAAE;YAC9C,QAAQ,EAAE,WAAW;SACtB,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,EAAE,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;QAC7C,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QACjE,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAC5D,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1C,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAsC,CAAC;QAEhE,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC;YAC7B,IAAI,EAAE;gBACJ;oBACE,UAAU,EAAE,OAAO;oBACnB,WAAW,EAAE,QAAQ;oBACrB,UAAU,EAAE,YAAY;oBACxB,OAAO,EAAE,mBAAmB;oBAC5B,UAAU,EAAE,GAAG;oBACf,WAAW,EAAE,IAAI;iBAClB;aACF;YACD,MAAM,EAAE,EAAE;SACX,CAAC,CAAC,CAAC;QAEJ,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC;YAC9B,IAAI,EAAE;gBACJ;oBACE,UAAU,EAAE,OAAO;oBACnB,YAAY,EAAE,QAAQ;oBACtB,WAAW,EAAE,IAAI;oBACjB,SAAS,EAAE,SAAS;oBACpB,QAAQ,EAAE,MAAM;oBAChB,WAAW,EAAE,IAAI;oBACjB,cAAc,EAAE,mCAAmC;oBACnD,wBAAwB,EAAE,IAAI;oBAC9B,iBAAiB,EAAE,EAAE;oBACrB,aAAa,EAAE,CAAC;oBAChB,gBAAgB,EAAE,CAAC;oBACnB,WAAW,EAAE,aAAa;iBAC3B;gBACD;oBACE,UAAU,EAAE,OAAO;oBACnB,YAAY,EAAE,QAAQ;oBACtB,WAAW,EAAE,SAAS;oBACtB,SAAS,EAAE,SAAS;oBACpB,QAAQ,EAAE,MAAM;oBAChB,WAAW,EAAE,KAAK;oBAClB,cAAc,EAAE,IAAI;oBACpB,wBAAwB,EAAE,IAAI;oBAC9B,iBAAiB,EAAE,EAAE;oBACrB,aAAa,EAAE,CAAC;oBAChB,gBAAgB,EAAE,CAAC;oBACnB,WAAW,EAAE,IAAI;iBAClB;aACF;YACD,MAAM,EAAE,EAAE;SACX,CAAC,CAAC,CAAC;QAEJ,SAAS,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC;YAClC,IAAI,EAAE;gBACJ;oBACE,YAAY,EAAE,QAAQ;oBACtB,UAAU,EAAE,OAAO;oBACnB,eAAe,EAAE,YAAY;oBAC7B,eAAe,EAAE,aAAa;oBAC9B,WAAW,EAAE,IAAI;oBACjB,oBAAoB,EAAE,IAAI;oBAC1B,kBAAkB,EAAE,IAAI;oBACxB,mBAAmB,EAAE,IAAI;iBAC1B;gBACD;oBACE,YAAY,EAAE,QAAQ;oBACtB,UAAU,EAAE,OAAO;oBACnB,eAAe,EAAE,oBAAoB;oBACrC,eAAe,EAAE,aAAa;oBAC9B,WAAW,EAAE,SAAS;oBACtB,oBAAoB,EAAE,QAAQ;oBAC9B,kBAAkB,EAAE,OAAO;oBAC3B,mBAAmB,EAAE,IAAI;iBAC1B;aACF;YACD,MAAM,EAAE,EAAE;SACX,CAAC,CAAC,CAAC;QAEJ,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC;YAC9B,IAAI,EAAE;gBACJ;oBACE,WAAW,EAAE,QAAQ;oBACrB,UAAU,EAAE,OAAO;oBACnB,UAAU,EAAE,YAAY;oBACxB,WAAW,EAAE,IAAI;oBACjB,YAAY,EAAE,CAAC,IAAI,CAAC;oBACpB,UAAU,EAAE,iEAAiE;iBAC9E;aACF;YACD,MAAM,EAAE,EAAE;SACX,CAAC,CAAC,CAAC;QAEJ,IAAI,aAAa,GAAkB,IAAI,CAAC;QACxC,IAAI,OAAO,GAAkB,IAAI,CAAC;QAElC,MAAM,QAAQ,GAAqB,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,GAAW,EAAE,EAAE;YAC7D,OAAO,GAAG,GAAG,CAAC;YACd,IAAI,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/B,aAAa,GAAG,GAAG,CAAC;gBACpB,OAAO,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;YAClE,CAAC;YACD,IAAI,GAAG,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBACpC,OAAO,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;YACjE,CAAC;YACD,IAAI,GAAG,CAAC,QAAQ,CAAC,4BAA4B,CAAC,EAAE,CAAC;gBAC/C,OAAO,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;YAClE,CAAC;YACD,IAAI,GAAG,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;gBACtC,OAAO,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;YACtE,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,IAAI,eAAe,CAAC,QAAQ,EAAE;YAC5C,QAAQ,EAAE,KAAK;YACf,aAAa,EAAE,QAAQ;SACxB,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,EAAE,CAAC;QAC1C,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,uCAAuC,OAAO,EAAE,CAAC,CAAC;QACpE,CAAC;QACD,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAC9C,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,EAAE,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC;QACnE,MAAM,CAAC,EAAE,EAAE,eAAe,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACjD,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;QACnE,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,35 @@
1
+ import type { IntrospectOptions, SchemaIntrospection } from "../schema/types.js";
2
+ import type { DatabaseAdapter, DatabaseExecutionResult } from "./types.js";
3
+ export interface PostgresQueryResult {
4
+ rows: Array<Record<string, unknown>>;
5
+ fields: Array<{
6
+ name: string;
7
+ }>;
8
+ }
9
+ export type PostgresClientFn = (sql: string, params?: unknown[]) => Promise<PostgresQueryResult>;
10
+ export interface PostgresAdapterOptions {
11
+ /** Logical database name used in introspection metadata. */
12
+ database?: string;
13
+ /** Schema to assume when a table is provided without qualification. */
14
+ defaultSchema?: string;
15
+ /** Optional database kind label. Defaults to "postgres". */
16
+ kind?: SchemaIntrospection["db"]["kind"];
17
+ }
18
+ export declare class PostgresAdapter implements DatabaseAdapter {
19
+ private readonly clientFn;
20
+ private readonly databaseName;
21
+ private readonly defaultSchema;
22
+ private readonly kind;
23
+ constructor(clientFn: PostgresClientFn, options?: PostgresAdapterOptions);
24
+ execute(sql: string, params?: Record<string, string | number | boolean | string[] | number[]>): Promise<DatabaseExecutionResult>;
25
+ /**
26
+ * Convert named params to positional array for PostgreSQL
27
+ * PostgreSQL expects $1, $2, $3 in SQL and an array of values [val1, val2, val3]
28
+ * The LLM should generate params like: { '1': 'value1', '2': 'value2' }
29
+ */
30
+ private convertNamedToPositionalParams;
31
+ validate(sql: string): Promise<void>;
32
+ getDialect(): "postgres";
33
+ introspect(options?: IntrospectOptions): Promise<SchemaIntrospection>;
34
+ }
35
+ //# sourceMappingURL=postgres.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"postgres.d.ts","sourceRoot":"","sources":["../../../src/adapters/postgres.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAIV,iBAAiB,EACjB,mBAAmB,EAEpB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EACV,eAAe,EACf,uBAAuB,EACxB,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACrC,MAAM,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACjC;AAED,MAAM,MAAM,gBAAgB,GAAG,CAC7B,GAAG,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,OAAO,EAAE,KACf,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAElC,MAAM,WAAW,sBAAsB;IACrC,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,4DAA4D;IAC5D,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;CAC1C;AAmDD,qBAAa,eAAgB,YAAW,eAAe;IAMnD,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAL3B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoC;gBAGtC,QAAQ,EAAE,gBAAgB,EAC3C,OAAO,GAAE,sBAA2B;IAOhC,OAAO,CACX,GAAG,EAAE,MAAM,EACX,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,GACvE,OAAO,CAAC,uBAAuB,CAAC;IAYnC;;;;OAIG;IACH,OAAO,CAAC,8BAA8B;IAkBhC,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1C,UAAU,IACD,UAAU;IAGb,UAAU,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CA0K5E"}
@@ -0,0 +1,403 @@
1
+ export class PostgresAdapter {
2
+ constructor(clientFn, options = {}) {
3
+ this.clientFn = clientFn;
4
+ this.databaseName = options.database ?? "postgres";
5
+ this.defaultSchema = options.defaultSchema ?? "public";
6
+ this.kind = options.kind ?? "postgres";
7
+ }
8
+ async execute(sql, params) {
9
+ // Convert named params to positional array for PostgreSQL
10
+ let paramArray;
11
+ if (params) {
12
+ paramArray = this.convertNamedToPositionalParams(params);
13
+ }
14
+ const result = await this.clientFn(sql, paramArray);
15
+ const fields = result.fields.map((f) => f.name);
16
+ return { fields, rows: result.rows };
17
+ }
18
+ /**
19
+ * Convert named params to positional array for PostgreSQL
20
+ * PostgreSQL expects $1, $2, $3 in SQL and an array of values [val1, val2, val3]
21
+ * The LLM should generate params like: { '1': 'value1', '2': 'value2' }
22
+ */
23
+ convertNamedToPositionalParams(params) {
24
+ // Extract numeric keys and sort them
25
+ const keys = Object.keys(params)
26
+ .filter((k) => /^\d+$/.test(k))
27
+ .map((k) => Number.parseInt(k, 10))
28
+ .sort((a, b) => a - b);
29
+ // Build positional array
30
+ const positionalParams = [];
31
+ for (const key of keys) {
32
+ positionalParams.push(params[String(key)]);
33
+ }
34
+ return positionalParams;
35
+ }
36
+ async validate(sql) {
37
+ await this.clientFn(`EXPLAIN ${sql}`);
38
+ }
39
+ getDialect() {
40
+ return "postgres";
41
+ }
42
+ async introspect(options) {
43
+ const normalizedTables = normalizeTableFilter(options?.tables, this.defaultSchema);
44
+ const tablesResult = await this.clientFn(buildTablesQuery(normalizedTables));
45
+ const tableRows = tablesResult.rows;
46
+ const columnsResult = await this.clientFn(buildColumnsQuery(normalizedTables));
47
+ const columnRows = columnsResult.rows;
48
+ const constraintsResult = await this.clientFn(buildConstraintsQuery(normalizedTables));
49
+ const constraintRows = constraintsResult.rows;
50
+ const indexesResult = await this.clientFn(buildIndexesQuery(normalizedTables));
51
+ const indexRows = indexesResult.rows;
52
+ const tablesByKey = new Map();
53
+ const columnsByKey = new Map();
54
+ for (const row of tableRows) {
55
+ const key = tableKey(row.schema_name, row.table_name);
56
+ const statistics = buildTableStatistics(toNumber(row.total_rows), toNumber(row.total_bytes));
57
+ const table = {
58
+ name: row.table_name,
59
+ schema: row.schema_name,
60
+ type: asTableType(row.table_type),
61
+ columns: [],
62
+ indexes: [],
63
+ constraints: [],
64
+ };
65
+ const comment = sanitize(row.comment);
66
+ if (comment !== undefined) {
67
+ table.comment = comment;
68
+ }
69
+ if (statistics) {
70
+ table.statistics = statistics;
71
+ }
72
+ tablesByKey.set(key, table);
73
+ columnsByKey.set(key, new Map());
74
+ }
75
+ for (const row of columnRows) {
76
+ const key = tableKey(row.table_schema, row.table_name);
77
+ const table = tablesByKey.get(key);
78
+ if (!table)
79
+ continue;
80
+ const column = {
81
+ name: row.column_name,
82
+ type: row.data_type,
83
+ nullable: row.is_nullable.toUpperCase() === "YES",
84
+ isPrimaryKey: false,
85
+ isForeignKey: false,
86
+ };
87
+ const rawType = row.udt_name ?? undefined;
88
+ if (rawType !== undefined)
89
+ column.rawType = rawType;
90
+ const defaultExpression = sanitize(row.column_default);
91
+ if (defaultExpression !== undefined)
92
+ column.defaultExpression = defaultExpression;
93
+ const comment = sanitize(row.description);
94
+ if (comment !== undefined)
95
+ column.comment = comment;
96
+ const maxLength = row.character_maximum_length ?? undefined;
97
+ if (maxLength !== undefined)
98
+ column.maxLength = maxLength;
99
+ const precision = row.numeric_precision ?? undefined;
100
+ if (precision !== undefined)
101
+ column.precision = precision;
102
+ const scale = row.numeric_scale ?? undefined;
103
+ if (scale !== undefined)
104
+ column.scale = scale;
105
+ table.columns.push(column);
106
+ columnsByKey.get(key)?.set(row.column_name, column);
107
+ }
108
+ const constraintGroups = groupConstraints(constraintRows);
109
+ for (const group of constraintGroups) {
110
+ const key = tableKey(group.table_schema, group.table_name);
111
+ const table = tablesByKey.get(key);
112
+ if (!table)
113
+ continue;
114
+ const constraint = {
115
+ name: group.constraint_name,
116
+ type: group.constraint_type,
117
+ columns: [...group.columns],
118
+ };
119
+ if (group.type === "FOREIGN KEY") {
120
+ if (group.foreign_table_name) {
121
+ const referencedTable = group.foreign_table_schema
122
+ ? `${group.foreign_table_schema}.${group.foreign_table_name}`
123
+ : group.foreign_table_name;
124
+ constraint.referencedTable = referencedTable;
125
+ }
126
+ if (group.foreign_columns.length) {
127
+ constraint.referencedColumns = [...group.foreign_columns];
128
+ }
129
+ }
130
+ table.constraints.push(constraint);
131
+ for (let index = 0; index < group.columns.length; index += 1) {
132
+ const columnName = group.columns[index];
133
+ if (!columnName)
134
+ continue;
135
+ const column = columnsByKey.get(key)?.get(columnName);
136
+ if (!column)
137
+ continue;
138
+ if (group.type === "PRIMARY KEY") {
139
+ column.isPrimaryKey = true;
140
+ }
141
+ if (group.type === "FOREIGN KEY") {
142
+ column.isForeignKey = true;
143
+ if (group.foreign_table_name) {
144
+ column.foreignKeyTable = group.foreign_table_schema
145
+ ? `${group.foreign_table_schema}.${group.foreign_table_name}`
146
+ : group.foreign_table_name;
147
+ }
148
+ const referencedColumn = group.foreign_columns[index];
149
+ if (referencedColumn) {
150
+ column.foreignKeyColumn = referencedColumn;
151
+ }
152
+ }
153
+ }
154
+ }
155
+ for (const row of indexRows) {
156
+ const key = tableKey(row.schema_name, row.table_name);
157
+ const table = tablesByKey.get(key);
158
+ if (!table)
159
+ continue;
160
+ const columns = coerceStringArray(row.column_names)
161
+ .map((c) => c.trim())
162
+ .filter(Boolean);
163
+ const index = {
164
+ name: row.index_name,
165
+ columns,
166
+ unique: Boolean(row.indisunique),
167
+ type: columns.length === 1 ? "INDEX" : "COMPOSITE INDEX",
168
+ };
169
+ const definition = sanitize(row.definition);
170
+ if (definition !== undefined)
171
+ index.definition = definition;
172
+ table.indexes.push(index);
173
+ }
174
+ const tables = Array.from(tablesByKey.values()).sort((a, b) => {
175
+ if (a.schema === b.schema) {
176
+ return a.name.localeCompare(b.name);
177
+ }
178
+ return a.schema.localeCompare(b.schema);
179
+ });
180
+ return {
181
+ db: {
182
+ kind: this.kind,
183
+ name: this.databaseName,
184
+ },
185
+ tables,
186
+ introspectedAt: new Date().toISOString(),
187
+ };
188
+ }
189
+ }
190
+ function groupConstraints(rows) {
191
+ const groups = new Map();
192
+ for (const row of rows) {
193
+ const key = `${row.table_schema}.${row.table_name}.${row.constraint_name}`;
194
+ let group = groups.get(key);
195
+ if (!group) {
196
+ group = {
197
+ table_schema: row.table_schema,
198
+ table_name: row.table_name,
199
+ constraint_name: row.constraint_name,
200
+ constraint_type: row.constraint_type,
201
+ columns: [],
202
+ foreign_columns: [],
203
+ type: row.constraint_type,
204
+ };
205
+ groups.set(key, group);
206
+ }
207
+ if (row.column_name) {
208
+ group.columns.push(row.column_name);
209
+ }
210
+ if (row.constraint_type === "FOREIGN KEY") {
211
+ group.foreign_table_schema = row.foreign_table_schema;
212
+ group.foreign_table_name = row.foreign_table_name;
213
+ if (row.foreign_column_name) {
214
+ group.foreign_columns.push(row.foreign_column_name);
215
+ }
216
+ }
217
+ }
218
+ return Array.from(groups.values());
219
+ }
220
+ function normalizeTableFilter(tables, defaultSchema) {
221
+ if (!tables?.length)
222
+ return [];
223
+ const normalized = [];
224
+ const seen = new Set();
225
+ for (const raw of tables) {
226
+ if (!raw)
227
+ continue;
228
+ const trimmed = raw.trim();
229
+ if (!trimmed)
230
+ continue;
231
+ const parts = trimmed.split(".");
232
+ const table = parts.pop() ?? "";
233
+ const schema = parts.pop() ?? defaultSchema;
234
+ if (!isSafeIdentifier(schema) || !isSafeIdentifier(table)) {
235
+ continue;
236
+ }
237
+ const key = tableKey(schema, table);
238
+ if (seen.has(key))
239
+ continue;
240
+ seen.add(key);
241
+ normalized.push({ schema, table });
242
+ }
243
+ return normalized;
244
+ }
245
+ function buildTablesQuery(tables) {
246
+ const filter = buildFilterClause(tables, "n.nspname", "c.relname");
247
+ return `SELECT
248
+ c.relname AS table_name,
249
+ n.nspname AS schema_name,
250
+ CASE c.relkind
251
+ WHEN 'r' THEN 'table'
252
+ WHEN 'v' THEN 'view'
253
+ WHEN 'm' THEN 'materialized_view'
254
+ ELSE c.relkind::text
255
+ END AS table_type,
256
+ obj_description(c.oid) AS comment,
257
+ c.reltuples AS total_rows,
258
+ pg_total_relation_size(c.oid) AS total_bytes
259
+ FROM pg_class c
260
+ JOIN pg_namespace n ON n.oid = c.relnamespace
261
+ WHERE n.nspname NOT IN ('pg_catalog', 'information_schema')
262
+ AND c.relkind IN ('r', 'v', 'm')
263
+ ${filter}
264
+ ORDER BY n.nspname, c.relname;`;
265
+ }
266
+ function buildColumnsQuery(tables) {
267
+ const filter = buildFilterClause(tables, "cols.table_schema", "cols.table_name");
268
+ return `SELECT
269
+ cols.table_name,
270
+ cols.table_schema,
271
+ cols.column_name,
272
+ cols.data_type,
273
+ cols.udt_name,
274
+ cols.is_nullable,
275
+ cols.column_default,
276
+ cols.character_maximum_length,
277
+ cols.numeric_precision,
278
+ cols.numeric_scale,
279
+ cols.ordinal_position,
280
+ pgd.description
281
+ FROM information_schema.columns cols
282
+ LEFT JOIN pg_catalog.pg_class c
283
+ ON c.relname = cols.table_name
284
+ AND c.relkind IN ('r', 'v', 'm')
285
+ LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
286
+ LEFT JOIN pg_catalog.pg_attribute attr
287
+ ON attr.attrelid = c.oid
288
+ AND attr.attname = cols.column_name
289
+ LEFT JOIN pg_catalog.pg_description pgd
290
+ ON pgd.objoid = attr.attrelid AND pgd.objsubid = attr.attnum
291
+ WHERE cols.table_schema NOT IN ('pg_catalog', 'information_schema')
292
+ ${filter}
293
+ ORDER BY cols.table_schema, cols.table_name, cols.ordinal_position;`;
294
+ }
295
+ function buildConstraintsQuery(tables) {
296
+ const filter = buildFilterClause(tables, "tc.table_schema", "tc.table_name");
297
+ return `SELECT
298
+ tc.table_schema,
299
+ tc.table_name,
300
+ tc.constraint_name,
301
+ tc.constraint_type,
302
+ kcu.column_name,
303
+ ccu.table_schema AS foreign_table_schema,
304
+ ccu.table_name AS foreign_table_name,
305
+ ccu.column_name AS foreign_column_name
306
+ FROM information_schema.table_constraints tc
307
+ LEFT JOIN information_schema.key_column_usage kcu
308
+ ON tc.constraint_name = kcu.constraint_name
309
+ AND tc.table_schema = kcu.table_schema
310
+ LEFT JOIN information_schema.constraint_column_usage ccu
311
+ ON ccu.constraint_name = tc.constraint_name
312
+ AND ccu.table_schema = tc.table_schema
313
+ WHERE tc.constraint_type IN ('PRIMARY KEY', 'UNIQUE', 'FOREIGN KEY')
314
+ AND tc.table_schema NOT IN ('pg_catalog', 'information_schema')
315
+ ${filter}
316
+ ORDER BY tc.table_schema, tc.table_name, tc.constraint_name, kcu.ordinal_position;`;
317
+ }
318
+ function buildIndexesQuery(tables) {
319
+ const filter = buildFilterClause(tables, "n.nspname", "c.relname");
320
+ return `SELECT
321
+ n.nspname AS schema_name,
322
+ c.relname AS table_name,
323
+ ci.relname AS index_name,
324
+ idx.indisunique,
325
+ array_remove(
326
+ array_agg(pg_get_indexdef(idx.indexrelid, g.k, true) ORDER BY g.k),
327
+ NULL
328
+ ) AS column_names,
329
+ pg_get_indexdef(idx.indexrelid) AS definition
330
+ FROM pg_class c
331
+ JOIN pg_namespace n ON n.oid = c.relnamespace
332
+ JOIN pg_index idx ON idx.indrelid = c.oid
333
+ JOIN pg_class ci ON ci.oid = idx.indexrelid
334
+ JOIN LATERAL generate_subscripts(idx.indkey, 1) AS g(k) ON true
335
+ WHERE n.nspname NOT IN ('pg_catalog', 'information_schema')
336
+ ${filter}
337
+ GROUP BY n.nspname, c.relname, ci.relname, idx.indisunique, idx.indexrelid;`;
338
+ }
339
+ function buildFilterClause(tables, schemaExpr, tableExpr) {
340
+ if (!tables.length)
341
+ return "";
342
+ const clauses = tables.map(({ schema, table }) => {
343
+ return `(${schemaExpr} = '${schema}' AND ${tableExpr} = '${table}')`;
344
+ });
345
+ return `AND (${clauses.join(" OR ")})`;
346
+ }
347
+ function tableKey(schema, table) {
348
+ return `${schema}.${table}`;
349
+ }
350
+ function isSafeIdentifier(value) {
351
+ return /^[A-Za-z_][A-Za-z0-9_]*$/.test(value);
352
+ }
353
+ function asTableType(value) {
354
+ const normalized = value.toLowerCase();
355
+ if (normalized.includes("view")) {
356
+ return normalized.includes("materialized") ? "materialized_view" : "view";
357
+ }
358
+ return "table";
359
+ }
360
+ function buildTableStatistics(totalRows, totalBytes) {
361
+ if (totalRows === undefined && totalBytes === undefined)
362
+ return undefined;
363
+ const stats = {};
364
+ if (totalRows !== undefined)
365
+ stats.totalRows = totalRows;
366
+ if (totalBytes !== undefined)
367
+ stats.totalBytes = totalBytes;
368
+ return stats;
369
+ }
370
+ function sanitize(value) {
371
+ if (value === null || value === undefined)
372
+ return undefined;
373
+ const trimmed = String(value).trim();
374
+ return trimmed.length ? trimmed : undefined;
375
+ }
376
+ function toNumber(value) {
377
+ if (value === null || value === undefined)
378
+ return undefined;
379
+ if (typeof value === "number")
380
+ return value;
381
+ const parsed = Number.parseFloat(String(value));
382
+ return Number.isNaN(parsed) ? undefined : parsed;
383
+ }
384
+ function coerceStringArray(value) {
385
+ if (!value)
386
+ return [];
387
+ if (Array.isArray(value)) {
388
+ return value.map((entry) => String(entry));
389
+ }
390
+ const text = String(value).trim();
391
+ if (!text)
392
+ return [];
393
+ const withoutBraces = text.startsWith("{") && text.endsWith("}")
394
+ ? text.slice(1, -1)
395
+ : text;
396
+ if (!withoutBraces)
397
+ return [];
398
+ return withoutBraces
399
+ .split(",")
400
+ .map((part) => part.trim().replace(/^"(.+)"$/, "$1"))
401
+ .filter(Boolean);
402
+ }
403
+ //# sourceMappingURL=postgres.js.map