@prisma-next/driver-postgres 0.0.1

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 ADDED
@@ -0,0 +1,113 @@
1
+ # @prisma-next/driver-postgres
2
+
3
+ PostgreSQL driver for Prisma Next.
4
+
5
+ ## Package Classification
6
+
7
+ - **Domain**: targets
8
+ - **Layer**: drivers
9
+ - **Plane**: multi-plane (migration, runtime)
10
+
11
+ ## Overview
12
+
13
+ The PostgreSQL driver provides transport and connection management for PostgreSQL databases. It implements the `SqlDriver` interface for executing SQL statements, explaining queries, and managing connections.
14
+
15
+ Drivers are transport-agnostic: they own pooling, connection management, and transport protocol (TCP, HTTP, etc.), but contain no dialect-specific logic. All dialect behavior lives in adapters.
16
+
17
+ This package spans multiple planes:
18
+ - **Migration plane** (`src/exports/control.ts`): Control plane entry point for driver descriptors
19
+ - **Runtime plane** (`src/exports/runtime.ts`): Runtime entry point for driver implementation
20
+
21
+ ## Purpose
22
+
23
+ Provide PostgreSQL transport and connection management. Execute SQL statements and manage connections without dialect-specific logic.
24
+
25
+ ## Responsibilities
26
+
27
+ - **Connection Management**: Acquire and release database connections
28
+ - **Statement Execution**: Execute SQL statements with parameters
29
+ - **Query Explanation**: Execute EXPLAIN queries for query analysis
30
+ - **Connection Pooling**: Manage connection pools (when applicable)
31
+ - **Transport Protocol**: Handle PostgreSQL protocol (TCP, HTTP, etc.)
32
+
33
+ **Non-goals:**
34
+ - Dialect-specific SQL lowering (adapters)
35
+ - Query compilation (sql-query)
36
+ - Runtime execution (runtime)
37
+
38
+ ## Architecture
39
+
40
+ ```mermaid
41
+ flowchart TD
42
+ subgraph "Runtime"
43
+ RT[Runtime]
44
+ ADAPTER[Adapter]
45
+ end
46
+
47
+ subgraph "Postgres Driver"
48
+ DRIVER[Driver]
49
+ POOL[Connection Pool]
50
+ CONN[Connection]
51
+ end
52
+
53
+ subgraph "PostgreSQL"
54
+ PG[(PostgreSQL)]
55
+ end
56
+
57
+ RT --> ADAPTER
58
+ ADAPTER --> DRIVER
59
+ DRIVER --> POOL
60
+ POOL --> CONN
61
+ CONN --> PG
62
+ PG --> CONN
63
+ CONN --> DRIVER
64
+ DRIVER --> RT
65
+ ```
66
+
67
+ ## Components
68
+
69
+ ### Driver (`postgres-driver.ts`)
70
+ - Main driver implementation
71
+ - Implements `SqlDriver` interface
72
+ - Manages connections and executes statements
73
+ - Handles PostgreSQL protocol
74
+
75
+ ## Dependencies
76
+
77
+ - **`@prisma-next/sql-target`**: Driver SPI and SQL types
78
+
79
+ ## Related Subsystems
80
+
81
+ - **[Adapters & Targets](../../docs/architecture%20docs/subsystems/5.%20Adapters%20&%20Targets.md)**: Driver specification
82
+
83
+ ## Related ADRs
84
+
85
+ - [ADR 005 - Thin Core Fat Targets](../../docs/architecture%20docs/adrs/ADR%20005%20-%20Thin%20Core%20Fat%20Targets.md)
86
+ - [ADR 016 - Adapter SPI for Lowering](../../docs/architecture%20docs/adrs/ADR%20016%20-%20Adapter%20SPI%20for%20Lowering.md)
87
+
88
+ ## Usage
89
+
90
+ ```typescript
91
+ import { createPostgresDriver } from '@prisma-next/driver-postgres/runtime';
92
+ import { createRuntime } from '@prisma-next/sql-runtime';
93
+
94
+ const driver = createPostgresDriver({
95
+ connectionString: process.env.DATABASE_URL,
96
+ });
97
+
98
+ const runtime = createRuntime({
99
+ contract,
100
+ adapter: postgresAdapter,
101
+ driver,
102
+ });
103
+ ```
104
+
105
+ ## Exports
106
+
107
+ - `./runtime`: Runtime entry point for driver implementation
108
+ - `createPostgresDriver(connectionString, options?)`: Create driver from connection string
109
+ - `createPostgresDriverFromOptions(options)`: Create driver from options object
110
+ - Types: `PostgresDriverOptions`, `QueryResult`
111
+ - `./control`: Control plane entry point for driver descriptors
112
+ - Default export: `DriverDescriptor` for use in `prisma-next.config.ts`
113
+
@@ -0,0 +1,26 @@
1
+ import { ControlDriverDescriptor, ControlDriverInstance } from '@prisma-next/core-control-plane/types';
2
+ import { Client } from 'pg';
3
+
4
+ /**
5
+ * Postgres control driver instance for control-plane operations.
6
+ * Implements ControlDriverInstance<'postgres'> for database queries.
7
+ */
8
+ declare class PostgresControlDriver implements ControlDriverInstance<'postgres'> {
9
+ private readonly client;
10
+ readonly targetId: "postgres";
11
+ /**
12
+ * @deprecated Use targetId instead
13
+ */
14
+ readonly target: "postgres";
15
+ constructor(client: Client);
16
+ query<Row = Record<string, unknown>>(sql: string, params?: readonly unknown[]): Promise<{
17
+ readonly rows: Row[];
18
+ }>;
19
+ close(): Promise<void>;
20
+ }
21
+ /**
22
+ * Postgres driver descriptor for CLI config.
23
+ */
24
+ declare const postgresDriverDescriptor: ControlDriverDescriptor<'sql', 'postgres', PostgresControlDriver>;
25
+
26
+ export { PostgresControlDriver, postgresDriverDescriptor as default };
@@ -0,0 +1,73 @@
1
+ // src/exports/control.ts
2
+ import { readFileSync } from "fs";
3
+ import { dirname, join } from "path";
4
+ import { fileURLToPath } from "url";
5
+ import { type } from "arktype";
6
+ import { Client } from "pg";
7
+ var PostgresControlDriver = class {
8
+ constructor(client) {
9
+ this.client = client;
10
+ }
11
+ targetId = "postgres";
12
+ /**
13
+ * @deprecated Use targetId instead
14
+ */
15
+ target = "postgres";
16
+ async query(sql, params) {
17
+ const result = await this.client.query(sql, params);
18
+ return { rows: result.rows };
19
+ }
20
+ async close() {
21
+ await this.client.end();
22
+ }
23
+ };
24
+ var __filename = fileURLToPath(import.meta.url);
25
+ var __dirname = dirname(__filename);
26
+ var TypesImportSpecSchema = type({
27
+ package: "string",
28
+ named: "string",
29
+ alias: "string"
30
+ });
31
+ var ExtensionPackManifestSchema = type({
32
+ id: "string",
33
+ version: "string",
34
+ "targets?": type({ "[string]": type({ "minVersion?": "string" }) }),
35
+ "capabilities?": "Record<string, unknown>",
36
+ "types?": type({
37
+ "codecTypes?": type({
38
+ import: TypesImportSpecSchema
39
+ }),
40
+ "operationTypes?": type({
41
+ import: TypesImportSpecSchema
42
+ })
43
+ }),
44
+ "operations?": "unknown[]"
45
+ });
46
+ function loadDriverManifest() {
47
+ const manifestPath = join(__dirname, "../../packs/manifest.json");
48
+ const manifestJson = JSON.parse(readFileSync(manifestPath, "utf-8"));
49
+ const result = ExtensionPackManifestSchema(manifestJson);
50
+ if (result instanceof type.errors) {
51
+ const messages = result.map((p) => p.message).join("; ");
52
+ throw new Error(`Invalid driver manifest structure at ${manifestPath}: ${messages}`);
53
+ }
54
+ return result;
55
+ }
56
+ var postgresDriverDescriptor = {
57
+ kind: "driver",
58
+ id: "postgres",
59
+ familyId: "sql",
60
+ targetId: "postgres",
61
+ manifest: loadDriverManifest(),
62
+ async create(url) {
63
+ const client = new Client({ connectionString: url });
64
+ await client.connect();
65
+ return new PostgresControlDriver(client);
66
+ }
67
+ };
68
+ var control_default = postgresDriverDescriptor;
69
+ export {
70
+ PostgresControlDriver,
71
+ control_default as default
72
+ };
73
+ //# sourceMappingURL=control.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/exports/control.ts"],"sourcesContent":["import { readFileSync } from 'node:fs';\nimport { dirname, join } from 'node:path';\nimport { fileURLToPath } from 'node:url';\nimport type { ExtensionPackManifest } from '@prisma-next/contract/pack-manifest-types';\nimport type {\n ControlDriverDescriptor,\n ControlDriverInstance,\n} from '@prisma-next/core-control-plane/types';\nimport { type } from 'arktype';\nimport { Client } from 'pg';\n\n/**\n * Postgres control driver instance for control-plane operations.\n * Implements ControlDriverInstance<'postgres'> for database queries.\n */\nexport class PostgresControlDriver implements ControlDriverInstance<'postgres'> {\n readonly targetId = 'postgres' as const;\n /**\n * @deprecated Use targetId instead\n */\n readonly target = 'postgres' as const;\n\n constructor(private readonly client: Client) {}\n\n async query<Row = Record<string, unknown>>(\n sql: string,\n params?: readonly unknown[],\n ): Promise<{ readonly rows: Row[] }> {\n const result = await this.client.query(sql, params as unknown[] | undefined);\n return { rows: result.rows as Row[] };\n }\n\n async close(): Promise<void> {\n await this.client.end();\n }\n}\n\nconst __filename = fileURLToPath(import.meta.url);\nconst __dirname = dirname(__filename);\n\nconst TypesImportSpecSchema = type({\n package: 'string',\n named: 'string',\n alias: 'string',\n});\n\nconst ExtensionPackManifestSchema = type({\n id: 'string',\n version: 'string',\n 'targets?': type({ '[string]': type({ 'minVersion?': 'string' }) }),\n 'capabilities?': 'Record<string, unknown>',\n 'types?': type({\n 'codecTypes?': type({\n import: TypesImportSpecSchema,\n }),\n 'operationTypes?': type({\n import: TypesImportSpecSchema,\n }),\n }),\n 'operations?': 'unknown[]',\n});\n\n/**\n * Loads the driver manifest from packs/manifest.json.\n */\nfunction loadDriverManifest(): ExtensionPackManifest {\n const manifestPath = join(__dirname, '../../packs/manifest.json');\n const manifestJson = JSON.parse(readFileSync(manifestPath, 'utf-8'));\n\n const result = ExtensionPackManifestSchema(manifestJson);\n if (result instanceof type.errors) {\n const messages = result.map((p: { message: string }) => p.message).join('; ');\n throw new Error(`Invalid driver manifest structure at ${manifestPath}: ${messages}`);\n }\n\n return result as ExtensionPackManifest;\n}\n\n/**\n * Postgres driver descriptor for CLI config.\n */\nconst postgresDriverDescriptor: ControlDriverDescriptor<'sql', 'postgres', PostgresControlDriver> =\n {\n kind: 'driver',\n id: 'postgres',\n familyId: 'sql',\n targetId: 'postgres',\n manifest: loadDriverManifest(),\n async create(url: string): Promise<PostgresControlDriver> {\n const client = new Client({ connectionString: url });\n await client.connect();\n return new PostgresControlDriver(client);\n },\n };\n\nexport default postgresDriverDescriptor;\n"],"mappings":";AAAA,SAAS,oBAAoB;AAC7B,SAAS,SAAS,YAAY;AAC9B,SAAS,qBAAqB;AAM9B,SAAS,YAAY;AACrB,SAAS,cAAc;AAMhB,IAAM,wBAAN,MAAyE;AAAA,EAO9E,YAA6B,QAAgB;AAAhB;AAAA,EAAiB;AAAA,EANrC,WAAW;AAAA;AAAA;AAAA;AAAA,EAIX,SAAS;AAAA,EAIlB,MAAM,MACJ,KACA,QACmC;AACnC,UAAM,SAAS,MAAM,KAAK,OAAO,MAAM,KAAK,MAA+B;AAC3E,WAAO,EAAE,MAAM,OAAO,KAAc;AAAA,EACtC;AAAA,EAEA,MAAM,QAAuB;AAC3B,UAAM,KAAK,OAAO,IAAI;AAAA,EACxB;AACF;AAEA,IAAM,aAAa,cAAc,YAAY,GAAG;AAChD,IAAM,YAAY,QAAQ,UAAU;AAEpC,IAAM,wBAAwB,KAAK;AAAA,EACjC,SAAS;AAAA,EACT,OAAO;AAAA,EACP,OAAO;AACT,CAAC;AAED,IAAM,8BAA8B,KAAK;AAAA,EACvC,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,YAAY,KAAK,EAAE,YAAY,KAAK,EAAE,eAAe,SAAS,CAAC,EAAE,CAAC;AAAA,EAClE,iBAAiB;AAAA,EACjB,UAAU,KAAK;AAAA,IACb,eAAe,KAAK;AAAA,MAClB,QAAQ;AAAA,IACV,CAAC;AAAA,IACD,mBAAmB,KAAK;AAAA,MACtB,QAAQ;AAAA,IACV,CAAC;AAAA,EACH,CAAC;AAAA,EACD,eAAe;AACjB,CAAC;AAKD,SAAS,qBAA4C;AACnD,QAAM,eAAe,KAAK,WAAW,2BAA2B;AAChE,QAAM,eAAe,KAAK,MAAM,aAAa,cAAc,OAAO,CAAC;AAEnE,QAAM,SAAS,4BAA4B,YAAY;AACvD,MAAI,kBAAkB,KAAK,QAAQ;AACjC,UAAM,WAAW,OAAO,IAAI,CAAC,MAA2B,EAAE,OAAO,EAAE,KAAK,IAAI;AAC5E,UAAM,IAAI,MAAM,wCAAwC,YAAY,KAAK,QAAQ,EAAE;AAAA,EACrF;AAEA,SAAO;AACT;AAKA,IAAM,2BACJ;AAAA,EACE,MAAM;AAAA,EACN,IAAI;AAAA,EACJ,UAAU;AAAA,EACV,UAAU;AAAA,EACV,UAAU,mBAAmB;AAAA,EAC7B,MAAM,OAAO,KAA6C;AACxD,UAAM,SAAS,IAAI,OAAO,EAAE,kBAAkB,IAAI,CAAC;AACnD,UAAM,OAAO,QAAQ;AACrB,WAAO,IAAI,sBAAsB,MAAM;AAAA,EACzC;AACF;AAEF,IAAO,kBAAQ;","names":[]}
@@ -0,0 +1,55 @@
1
+ import { RuntimeDriverDescriptor, RuntimeDriverInstance } from '@prisma-next/core-execution-plane/types';
2
+ import { Client, Pool, QueryResultRow, QueryResult as QueryResult$1 } from 'pg';
3
+
4
+ interface SqlExecuteRequest {
5
+ readonly sql: string;
6
+ readonly params?: readonly unknown[];
7
+ }
8
+ interface SqlQueryResult<Row = Record<string, unknown>> {
9
+ readonly rows: ReadonlyArray<Row>;
10
+ readonly rowCount?: number | null;
11
+ readonly [key: string]: unknown;
12
+ }
13
+ interface SqlExplainResult<Row = Record<string, unknown>> {
14
+ readonly rows: ReadonlyArray<Row>;
15
+ }
16
+ interface SqlDriver {
17
+ connect(): Promise<void>;
18
+ execute<Row = Record<string, unknown>>(request: SqlExecuteRequest): AsyncIterable<Row>;
19
+ explain?(request: SqlExecuteRequest): Promise<SqlExplainResult>;
20
+ query<Row = Record<string, unknown>>(sql: string, params?: readonly unknown[]): Promise<SqlQueryResult<Row>>;
21
+ close(): Promise<void>;
22
+ }
23
+
24
+ type QueryResult<T extends QueryResultRow = QueryResultRow> = QueryResult$1<T>;
25
+ interface PostgresDriverOptions {
26
+ readonly connect: {
27
+ client: Client;
28
+ } | {
29
+ pool: Pool;
30
+ };
31
+ readonly cursor?: {
32
+ readonly batchSize?: number;
33
+ readonly disabled?: boolean;
34
+ } | undefined;
35
+ }
36
+ interface CreatePostgresDriverOptions {
37
+ readonly cursor?: PostgresDriverOptions['cursor'];
38
+ readonly poolFactory?: typeof Pool;
39
+ }
40
+ declare function createPostgresDriver(connectionString: string, options?: CreatePostgresDriverOptions): SqlDriver;
41
+ declare function createPostgresDriverFromOptions(options: PostgresDriverOptions): SqlDriver;
42
+
43
+ /**
44
+ * Postgres runtime driver instance interface.
45
+ * SqlDriver provides SQL-specific methods (execute, explain, close).
46
+ * RuntimeDriverInstance provides target identification (targetId).
47
+ * We use intersection type to combine both interfaces.
48
+ */
49
+ type PostgresRuntimeDriver = RuntimeDriverInstance<'postgres'> & SqlDriver;
50
+ /**
51
+ * Postgres driver descriptor for runtime plane.
52
+ */
53
+ declare const postgresRuntimeDriverDescriptor: RuntimeDriverDescriptor<'sql', 'postgres', PostgresRuntimeDriver>;
54
+
55
+ export { type CreatePostgresDriverOptions, type PostgresDriverOptions, type PostgresRuntimeDriver, type QueryResult, createPostgresDriver, createPostgresDriverFromOptions, postgresRuntimeDriverDescriptor as default };
@@ -0,0 +1,209 @@
1
+ // src/exports/runtime.ts
2
+ import { readFileSync } from "fs";
3
+ import { dirname, join } from "path";
4
+ import { fileURLToPath } from "url";
5
+ import { type } from "arktype";
6
+
7
+ // src/postgres-driver.ts
8
+ import { Pool } from "pg";
9
+ import Cursor from "pg-cursor";
10
+ var DEFAULT_BATCH_SIZE = 100;
11
+ var PostgresDriverImpl = class {
12
+ pool;
13
+ directClient;
14
+ cursorBatchSize;
15
+ cursorDisabled;
16
+ constructor(options) {
17
+ if ("client" in options.connect) {
18
+ this.directClient = options.connect.client;
19
+ } else if ("pool" in options.connect) {
20
+ this.pool = options.connect.pool;
21
+ } else {
22
+ throw new Error("PostgresDriver requires a pool or client");
23
+ }
24
+ this.cursorBatchSize = options.cursor?.batchSize ?? DEFAULT_BATCH_SIZE;
25
+ this.cursorDisabled = options.cursor?.disabled ?? false;
26
+ }
27
+ async connect() {
28
+ }
29
+ async *execute(request) {
30
+ const client = await this.acquireClient();
31
+ try {
32
+ if (!this.cursorDisabled) {
33
+ try {
34
+ for await (const row of this.executeWithCursor(client, request.sql, request.params)) {
35
+ yield row;
36
+ }
37
+ return;
38
+ } catch (cursorError) {
39
+ if (!(cursorError instanceof Error)) {
40
+ throw cursorError;
41
+ }
42
+ }
43
+ }
44
+ for await (const row of this.executeBuffered(client, request.sql, request.params)) {
45
+ yield row;
46
+ }
47
+ } finally {
48
+ await this.releaseClient(client);
49
+ }
50
+ }
51
+ async explain(request) {
52
+ const text = `EXPLAIN (FORMAT JSON) ${request.sql}`;
53
+ const client = await this.acquireClient();
54
+ try {
55
+ const result = await client.query(text, request.params);
56
+ return { rows: result.rows };
57
+ } finally {
58
+ await this.releaseClient(client);
59
+ }
60
+ }
61
+ async query(sql, params) {
62
+ const client = await this.acquireClient();
63
+ try {
64
+ const result = await client.query(sql, params);
65
+ return result;
66
+ } finally {
67
+ await this.releaseClient(client);
68
+ }
69
+ }
70
+ async close() {
71
+ if (this.pool) {
72
+ if (!this.pool.ended) {
73
+ await this.pool.end();
74
+ }
75
+ }
76
+ }
77
+ async acquireClient() {
78
+ if (this.pool) {
79
+ return this.pool.connect();
80
+ }
81
+ if (this.directClient) {
82
+ try {
83
+ await this.directClient.connect();
84
+ } catch (error) {
85
+ if (error instanceof Error) {
86
+ const message = error.message.toLowerCase();
87
+ if (!message.includes("already") && !message.includes("connected")) {
88
+ throw error;
89
+ }
90
+ } else {
91
+ throw error;
92
+ }
93
+ }
94
+ return this.directClient;
95
+ }
96
+ throw new Error("PostgresDriver requires a pool or client");
97
+ }
98
+ async releaseClient(client) {
99
+ if (this.pool) {
100
+ client.release();
101
+ }
102
+ }
103
+ async *executeWithCursor(client, sql, params) {
104
+ const cursor = client.query(new Cursor(sql, params));
105
+ try {
106
+ while (true) {
107
+ const rows = await readCursor(cursor, this.cursorBatchSize);
108
+ if (rows.length === 0) {
109
+ break;
110
+ }
111
+ for (const row of rows) {
112
+ yield row;
113
+ }
114
+ }
115
+ } finally {
116
+ await closeCursor(cursor);
117
+ }
118
+ }
119
+ async *executeBuffered(client, sql, params) {
120
+ const result = await client.query(sql, params);
121
+ for (const row of result.rows) {
122
+ yield row;
123
+ }
124
+ }
125
+ };
126
+ function createPostgresDriver(connectionString, options) {
127
+ const PoolImpl = options?.poolFactory ?? Pool;
128
+ const pool = new PoolImpl({ connectionString });
129
+ return new PostgresDriverImpl({
130
+ connect: { pool },
131
+ cursor: options?.cursor
132
+ });
133
+ }
134
+ function createPostgresDriverFromOptions(options) {
135
+ return new PostgresDriverImpl(options);
136
+ }
137
+ function readCursor(cursor, size) {
138
+ return new Promise((resolve, reject) => {
139
+ cursor.read(size, (err, rows) => {
140
+ if (err) {
141
+ reject(err);
142
+ return;
143
+ }
144
+ resolve(rows ?? []);
145
+ });
146
+ });
147
+ }
148
+ function closeCursor(cursor) {
149
+ return new Promise((resolve, reject) => {
150
+ cursor.close((err) => {
151
+ if (err) {
152
+ reject(err);
153
+ return;
154
+ }
155
+ resolve();
156
+ });
157
+ });
158
+ }
159
+
160
+ // src/exports/runtime.ts
161
+ var __filename = fileURLToPath(import.meta.url);
162
+ var __dirname = dirname(__filename);
163
+ var TypesImportSpecSchema = type({
164
+ package: "string",
165
+ named: "string",
166
+ alias: "string"
167
+ });
168
+ var ExtensionPackManifestSchema = type({
169
+ id: "string",
170
+ version: "string",
171
+ "targets?": type({ "[string]": type({ "minVersion?": "string" }) }),
172
+ "capabilities?": "Record<string, unknown>",
173
+ "types?": type({
174
+ "codecTypes?": type({
175
+ import: TypesImportSpecSchema
176
+ }),
177
+ "operationTypes?": type({
178
+ import: TypesImportSpecSchema
179
+ })
180
+ }),
181
+ "operations?": "unknown[]"
182
+ });
183
+ function loadDriverManifest() {
184
+ const manifestPath = join(__dirname, "../../packs/manifest.json");
185
+ const manifestJson = JSON.parse(readFileSync(manifestPath, "utf-8"));
186
+ const result = ExtensionPackManifestSchema(manifestJson);
187
+ if (result instanceof type.errors) {
188
+ const messages = result.map((p) => p.message).join("; ");
189
+ throw new Error(`Invalid driver manifest structure at ${manifestPath}: ${messages}`);
190
+ }
191
+ return result;
192
+ }
193
+ var postgresRuntimeDriverDescriptor = {
194
+ kind: "driver",
195
+ familyId: "sql",
196
+ targetId: "postgres",
197
+ id: "postgres",
198
+ manifest: loadDriverManifest(),
199
+ create(options) {
200
+ return createPostgresDriverFromOptions(options);
201
+ }
202
+ };
203
+ var runtime_default = postgresRuntimeDriverDescriptor;
204
+ export {
205
+ createPostgresDriver,
206
+ createPostgresDriverFromOptions,
207
+ runtime_default as default
208
+ };
209
+ //# sourceMappingURL=runtime.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/exports/runtime.ts","../../src/postgres-driver.ts"],"sourcesContent":["import { readFileSync } from 'node:fs';\nimport { dirname, join } from 'node:path';\nimport { fileURLToPath } from 'node:url';\nimport type { ExtensionPackManifest } from '@prisma-next/contract/pack-manifest-types';\nimport type {\n RuntimeDriverDescriptor,\n RuntimeDriverInstance,\n} from '@prisma-next/core-execution-plane/types';\nimport type { SqlDriver } from '@prisma-next/sql-relational-core/ast';\nimport { type } from 'arktype';\nimport type { PostgresDriverOptions } from '../postgres-driver';\nimport { createPostgresDriverFromOptions } from '../postgres-driver';\n\nconst __filename = fileURLToPath(import.meta.url);\nconst __dirname = dirname(__filename);\n\nconst TypesImportSpecSchema = type({\n package: 'string',\n named: 'string',\n alias: 'string',\n});\n\nconst ExtensionPackManifestSchema = type({\n id: 'string',\n version: 'string',\n 'targets?': type({ '[string]': type({ 'minVersion?': 'string' }) }),\n 'capabilities?': 'Record<string, unknown>',\n 'types?': type({\n 'codecTypes?': type({\n import: TypesImportSpecSchema,\n }),\n 'operationTypes?': type({\n import: TypesImportSpecSchema,\n }),\n }),\n 'operations?': 'unknown[]',\n});\n\n/**\n * Loads the driver manifest from packs/manifest.json.\n */\nfunction loadDriverManifest(): ExtensionPackManifest {\n const manifestPath = join(__dirname, '../../packs/manifest.json');\n const manifestJson = JSON.parse(readFileSync(manifestPath, 'utf-8'));\n\n const result = ExtensionPackManifestSchema(manifestJson);\n if (result instanceof type.errors) {\n const messages = result.map((p: { message: string }) => p.message).join('; ');\n throw new Error(`Invalid driver manifest structure at ${manifestPath}: ${messages}`);\n }\n\n return result as ExtensionPackManifest;\n}\n\n/**\n * Postgres runtime driver instance interface.\n * SqlDriver provides SQL-specific methods (execute, explain, close).\n * RuntimeDriverInstance provides target identification (targetId).\n * We use intersection type to combine both interfaces.\n */\nexport type PostgresRuntimeDriver = RuntimeDriverInstance<'postgres'> & SqlDriver;\n\n/**\n * Postgres driver descriptor for runtime plane.\n */\nconst postgresRuntimeDriverDescriptor: RuntimeDriverDescriptor<\n 'sql',\n 'postgres',\n PostgresRuntimeDriver\n> = {\n kind: 'driver',\n familyId: 'sql',\n targetId: 'postgres',\n id: 'postgres',\n manifest: loadDriverManifest(),\n create(options: PostgresDriverOptions): PostgresRuntimeDriver {\n return createPostgresDriverFromOptions(options) as PostgresRuntimeDriver;\n },\n};\n\nexport default postgresRuntimeDriverDescriptor;\nexport type {\n CreatePostgresDriverOptions,\n PostgresDriverOptions,\n QueryResult,\n} from '../postgres-driver';\nexport { createPostgresDriver, createPostgresDriverFromOptions } from '../postgres-driver';\n","import type {\n SqlDriver,\n SqlExecuteRequest,\n SqlExplainResult,\n SqlQueryResult,\n} from '@prisma-next/sql-relational-core/ast';\nimport type {\n Client,\n QueryResult as PgQueryResult,\n PoolClient,\n Pool as PoolType,\n QueryResultRow,\n} from 'pg';\nimport { Pool } from 'pg';\nimport Cursor from 'pg-cursor';\n\nexport type QueryResult<T extends QueryResultRow = QueryResultRow> = PgQueryResult<T>;\n\nexport interface PostgresDriverOptions {\n readonly connect: { client: Client } | { pool: PoolType };\n readonly cursor?:\n | {\n readonly batchSize?: number;\n readonly disabled?: boolean;\n }\n | undefined;\n}\n\nconst DEFAULT_BATCH_SIZE = 100;\n\nclass PostgresDriverImpl implements SqlDriver {\n private readonly pool: PoolType | undefined;\n private readonly directClient: Client | undefined;\n private readonly cursorBatchSize: number;\n private readonly cursorDisabled: boolean;\n\n constructor(options: PostgresDriverOptions) {\n if ('client' in options.connect) {\n this.directClient = options.connect.client;\n } else if ('pool' in options.connect) {\n this.pool = options.connect.pool;\n } else {\n throw new Error('PostgresDriver requires a pool or client');\n }\n\n this.cursorBatchSize = options.cursor?.batchSize ?? DEFAULT_BATCH_SIZE;\n this.cursorDisabled = options.cursor?.disabled ?? false;\n }\n\n async connect(): Promise<void> {\n // No-op: caller controls connecting the underlying client or pool\n }\n\n async *execute<Row = Record<string, unknown>>(request: SqlExecuteRequest): AsyncIterable<Row> {\n const client = await this.acquireClient();\n try {\n if (!this.cursorDisabled) {\n try {\n for await (const row of this.executeWithCursor(client, request.sql, request.params)) {\n yield row as Row;\n }\n return;\n } catch (cursorError) {\n if (!(cursorError instanceof Error)) {\n throw cursorError;\n }\n }\n }\n\n for await (const row of this.executeBuffered(client, request.sql, request.params)) {\n yield row as Row;\n }\n } finally {\n await this.releaseClient(client);\n }\n }\n\n async explain(request: SqlExecuteRequest): Promise<SqlExplainResult> {\n const text = `EXPLAIN (FORMAT JSON) ${request.sql}`;\n const client = await this.acquireClient();\n try {\n const result = await client.query(text, request.params as unknown[] | undefined);\n return { rows: result.rows as ReadonlyArray<Record<string, unknown>> };\n } finally {\n await this.releaseClient(client);\n }\n }\n\n async query<Row = Record<string, unknown>>(\n sql: string,\n params?: readonly unknown[],\n ): Promise<SqlQueryResult<Row>> {\n const client = await this.acquireClient();\n try {\n const result = await client.query(sql, params as unknown[] | undefined);\n return result as unknown as SqlQueryResult<Row>;\n } finally {\n await this.releaseClient(client);\n }\n }\n\n async close(): Promise<void> {\n if (this.pool) {\n // Check if pool is already closed to avoid \"Called end on pool more than once\" error\n // pg Pool has an 'ended' property that indicates if the pool has been closed\n if (!(this.pool as { ended?: boolean }).ended) {\n await this.pool.end();\n }\n }\n }\n\n private async acquireClient(): Promise<PoolClient | Client> {\n if (this.pool) {\n return this.pool.connect();\n }\n if (this.directClient) {\n // Lazy connection: connect if not already connected\n // This allows tests to manage their own connections while still supporting lazy connection\n // pg's Client.connect() will throw if already connected, so we catch and ignore that case\n try {\n await this.directClient.connect();\n } catch (error: unknown) {\n // If already connected, pg throws an error - ignore it and proceed\n // Re-throw other errors (actual connection failures)\n if (error instanceof Error) {\n const message = error.message.toLowerCase();\n if (!message.includes('already') && !message.includes('connected')) {\n throw error;\n }\n } else {\n throw error;\n }\n }\n return this.directClient;\n }\n throw new Error('PostgresDriver requires a pool or client');\n }\n\n private async releaseClient(client: PoolClient | Client): Promise<void> {\n if (this.pool) {\n (client as PoolClient).release();\n }\n }\n\n private async *executeWithCursor(\n client: PoolClient | Client,\n sql: string,\n params: readonly unknown[] | undefined,\n ): AsyncIterable<Record<string, unknown>> {\n const cursor = client.query(new Cursor(sql, params as unknown[] | undefined));\n\n try {\n while (true) {\n const rows = await readCursor(cursor, this.cursorBatchSize);\n if (rows.length === 0) {\n break;\n }\n\n for (const row of rows) {\n yield row;\n }\n }\n } finally {\n await closeCursor(cursor);\n }\n }\n\n private async *executeBuffered(\n client: PoolClient | Client,\n sql: string,\n params: readonly unknown[] | undefined,\n ): AsyncIterable<Record<string, unknown>> {\n const result = await client.query(sql, params as unknown[] | undefined);\n for (const row of result.rows as Record<string, unknown>[]) {\n yield row;\n }\n }\n}\n\nexport interface CreatePostgresDriverOptions {\n readonly cursor?: PostgresDriverOptions['cursor'];\n readonly poolFactory?: typeof Pool;\n}\n\nexport function createPostgresDriver(\n connectionString: string,\n options?: CreatePostgresDriverOptions,\n): SqlDriver {\n const PoolImpl: typeof Pool = options?.poolFactory ?? Pool;\n const pool = new PoolImpl({ connectionString });\n return new PostgresDriverImpl({\n connect: { pool },\n cursor: options?.cursor,\n });\n}\n\nexport function createPostgresDriverFromOptions(options: PostgresDriverOptions): SqlDriver {\n return new PostgresDriverImpl(options);\n}\n\nfunction readCursor<Row>(cursor: Cursor<Row>, size: number): Promise<Row[]> {\n return new Promise<Row[]>((resolve, reject) => {\n cursor.read(size, (err, rows) => {\n if (err) {\n reject(err);\n return;\n }\n\n resolve(rows ?? []);\n });\n });\n}\n\nfunction closeCursor(cursor: Cursor<unknown>): Promise<void> {\n return new Promise<void>((resolve, reject) => {\n cursor.close((err) => {\n if (err) {\n reject(err);\n return;\n }\n\n resolve();\n });\n });\n}\n"],"mappings":";AAAA,SAAS,oBAAoB;AAC7B,SAAS,SAAS,YAAY;AAC9B,SAAS,qBAAqB;AAO9B,SAAS,YAAY;;;ACIrB,SAAS,YAAY;AACrB,OAAO,YAAY;AAcnB,IAAM,qBAAqB;AAE3B,IAAM,qBAAN,MAA8C;AAAA,EAC3B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEjB,YAAY,SAAgC;AAC1C,QAAI,YAAY,QAAQ,SAAS;AAC/B,WAAK,eAAe,QAAQ,QAAQ;AAAA,IACtC,WAAW,UAAU,QAAQ,SAAS;AACpC,WAAK,OAAO,QAAQ,QAAQ;AAAA,IAC9B,OAAO;AACL,YAAM,IAAI,MAAM,0CAA0C;AAAA,IAC5D;AAEA,SAAK,kBAAkB,QAAQ,QAAQ,aAAa;AACpD,SAAK,iBAAiB,QAAQ,QAAQ,YAAY;AAAA,EACpD;AAAA,EAEA,MAAM,UAAyB;AAAA,EAE/B;AAAA,EAEA,OAAO,QAAuC,SAAgD;AAC5F,UAAM,SAAS,MAAM,KAAK,cAAc;AACxC,QAAI;AACF,UAAI,CAAC,KAAK,gBAAgB;AACxB,YAAI;AACF,2BAAiB,OAAO,KAAK,kBAAkB,QAAQ,QAAQ,KAAK,QAAQ,MAAM,GAAG;AACnF,kBAAM;AAAA,UACR;AACA;AAAA,QACF,SAAS,aAAa;AACpB,cAAI,EAAE,uBAAuB,QAAQ;AACnC,kBAAM;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAEA,uBAAiB,OAAO,KAAK,gBAAgB,QAAQ,QAAQ,KAAK,QAAQ,MAAM,GAAG;AACjF,cAAM;AAAA,MACR;AAAA,IACF,UAAE;AACA,YAAM,KAAK,cAAc,MAAM;AAAA,IACjC;AAAA,EACF;AAAA,EAEA,MAAM,QAAQ,SAAuD;AACnE,UAAM,OAAO,yBAAyB,QAAQ,GAAG;AACjD,UAAM,SAAS,MAAM,KAAK,cAAc;AACxC,QAAI;AACF,YAAM,SAAS,MAAM,OAAO,MAAM,MAAM,QAAQ,MAA+B;AAC/E,aAAO,EAAE,MAAM,OAAO,KAA+C;AAAA,IACvE,UAAE;AACA,YAAM,KAAK,cAAc,MAAM;AAAA,IACjC;AAAA,EACF;AAAA,EAEA,MAAM,MACJ,KACA,QAC8B;AAC9B,UAAM,SAAS,MAAM,KAAK,cAAc;AACxC,QAAI;AACF,YAAM,SAAS,MAAM,OAAO,MAAM,KAAK,MAA+B;AACtE,aAAO;AAAA,IACT,UAAE;AACA,YAAM,KAAK,cAAc,MAAM;AAAA,IACjC;AAAA,EACF;AAAA,EAEA,MAAM,QAAuB;AAC3B,QAAI,KAAK,MAAM;AAGb,UAAI,CAAE,KAAK,KAA6B,OAAO;AAC7C,cAAM,KAAK,KAAK,IAAI;AAAA,MACtB;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAc,gBAA8C;AAC1D,QAAI,KAAK,MAAM;AACb,aAAO,KAAK,KAAK,QAAQ;AAAA,IAC3B;AACA,QAAI,KAAK,cAAc;AAIrB,UAAI;AACF,cAAM,KAAK,aAAa,QAAQ;AAAA,MAClC,SAAS,OAAgB;AAGvB,YAAI,iBAAiB,OAAO;AAC1B,gBAAM,UAAU,MAAM,QAAQ,YAAY;AAC1C,cAAI,CAAC,QAAQ,SAAS,SAAS,KAAK,CAAC,QAAQ,SAAS,WAAW,GAAG;AAClE,kBAAM;AAAA,UACR;AAAA,QACF,OAAO;AACL,gBAAM;AAAA,QACR;AAAA,MACF;AACA,aAAO,KAAK;AAAA,IACd;AACA,UAAM,IAAI,MAAM,0CAA0C;AAAA,EAC5D;AAAA,EAEA,MAAc,cAAc,QAA4C;AACtE,QAAI,KAAK,MAAM;AACb,MAAC,OAAsB,QAAQ;AAAA,IACjC;AAAA,EACF;AAAA,EAEA,OAAe,kBACb,QACA,KACA,QACwC;AACxC,UAAM,SAAS,OAAO,MAAM,IAAI,OAAO,KAAK,MAA+B,CAAC;AAE5E,QAAI;AACF,aAAO,MAAM;AACX,cAAM,OAAO,MAAM,WAAW,QAAQ,KAAK,eAAe;AAC1D,YAAI,KAAK,WAAW,GAAG;AACrB;AAAA,QACF;AAEA,mBAAW,OAAO,MAAM;AACtB,gBAAM;AAAA,QACR;AAAA,MACF;AAAA,IACF,UAAE;AACA,YAAM,YAAY,MAAM;AAAA,IAC1B;AAAA,EACF;AAAA,EAEA,OAAe,gBACb,QACA,KACA,QACwC;AACxC,UAAM,SAAS,MAAM,OAAO,MAAM,KAAK,MAA+B;AACtE,eAAW,OAAO,OAAO,MAAmC;AAC1D,YAAM;AAAA,IACR;AAAA,EACF;AACF;AAOO,SAAS,qBACd,kBACA,SACW;AACX,QAAM,WAAwB,SAAS,eAAe;AACtD,QAAM,OAAO,IAAI,SAAS,EAAE,iBAAiB,CAAC;AAC9C,SAAO,IAAI,mBAAmB;AAAA,IAC5B,SAAS,EAAE,KAAK;AAAA,IAChB,QAAQ,SAAS;AAAA,EACnB,CAAC;AACH;AAEO,SAAS,gCAAgC,SAA2C;AACzF,SAAO,IAAI,mBAAmB,OAAO;AACvC;AAEA,SAAS,WAAgB,QAAqB,MAA8B;AAC1E,SAAO,IAAI,QAAe,CAAC,SAAS,WAAW;AAC7C,WAAO,KAAK,MAAM,CAAC,KAAK,SAAS;AAC/B,UAAI,KAAK;AACP,eAAO,GAAG;AACV;AAAA,MACF;AAEA,cAAQ,QAAQ,CAAC,CAAC;AAAA,IACpB,CAAC;AAAA,EACH,CAAC;AACH;AAEA,SAAS,YAAY,QAAwC;AAC3D,SAAO,IAAI,QAAc,CAAC,SAAS,WAAW;AAC5C,WAAO,MAAM,CAAC,QAAQ;AACpB,UAAI,KAAK;AACP,eAAO,GAAG;AACV;AAAA,MACF;AAEA,cAAQ;AAAA,IACV,CAAC;AAAA,EACH,CAAC;AACH;;;ADnNA,IAAM,aAAa,cAAc,YAAY,GAAG;AAChD,IAAM,YAAY,QAAQ,UAAU;AAEpC,IAAM,wBAAwB,KAAK;AAAA,EACjC,SAAS;AAAA,EACT,OAAO;AAAA,EACP,OAAO;AACT,CAAC;AAED,IAAM,8BAA8B,KAAK;AAAA,EACvC,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,YAAY,KAAK,EAAE,YAAY,KAAK,EAAE,eAAe,SAAS,CAAC,EAAE,CAAC;AAAA,EAClE,iBAAiB;AAAA,EACjB,UAAU,KAAK;AAAA,IACb,eAAe,KAAK;AAAA,MAClB,QAAQ;AAAA,IACV,CAAC;AAAA,IACD,mBAAmB,KAAK;AAAA,MACtB,QAAQ;AAAA,IACV,CAAC;AAAA,EACH,CAAC;AAAA,EACD,eAAe;AACjB,CAAC;AAKD,SAAS,qBAA4C;AACnD,QAAM,eAAe,KAAK,WAAW,2BAA2B;AAChE,QAAM,eAAe,KAAK,MAAM,aAAa,cAAc,OAAO,CAAC;AAEnE,QAAM,SAAS,4BAA4B,YAAY;AACvD,MAAI,kBAAkB,KAAK,QAAQ;AACjC,UAAM,WAAW,OAAO,IAAI,CAAC,MAA2B,EAAE,OAAO,EAAE,KAAK,IAAI;AAC5E,UAAM,IAAI,MAAM,wCAAwC,YAAY,KAAK,QAAQ,EAAE;AAAA,EACrF;AAEA,SAAO;AACT;AAaA,IAAM,kCAIF;AAAA,EACF,MAAM;AAAA,EACN,UAAU;AAAA,EACV,UAAU;AAAA,EACV,IAAI;AAAA,EACJ,UAAU,mBAAmB;AAAA,EAC7B,OAAO,SAAuD;AAC5D,WAAO,gCAAgC,OAAO;AAAA,EAChD;AACF;AAEA,IAAO,kBAAQ;","names":[]}
package/package.json ADDED
@@ -0,0 +1,45 @@
1
+ {
2
+ "name": "@prisma-next/driver-postgres",
3
+ "version": "0.0.1",
4
+ "type": "module",
5
+ "sideEffects": false,
6
+ "dependencies": {
7
+ "arktype": "^2.0.0",
8
+ "pg": "^8.11.5",
9
+ "pg-cursor": "^2.10.5",
10
+ "@prisma-next/core-control-plane": "0.0.1",
11
+ "@prisma-next/core-execution-plane": "0.0.1",
12
+ "@prisma-next/sql-operations": "0.0.1",
13
+ "@prisma-next/sql-contract": "0.0.1"
14
+ },
15
+ "devDependencies": {
16
+ "pg-mem": "^3.0.5",
17
+ "tsup": "^8.3.0",
18
+ "typescript": "^5.9.3",
19
+ "vitest": "^2.1.1",
20
+ "@types/pg": "^8.11.10",
21
+ "@types/pg-cursor": "^2.4.6",
22
+ "@prisma-next/test-utils": "0.0.1"
23
+ },
24
+ "files": [
25
+ "dist"
26
+ ],
27
+ "exports": {
28
+ "./control": {
29
+ "types": "./dist/exports/control.d.ts",
30
+ "import": "./dist/exports/control.js"
31
+ },
32
+ "./runtime": {
33
+ "types": "./dist/exports/runtime.d.ts",
34
+ "import": "./dist/exports/runtime.js"
35
+ }
36
+ },
37
+ "scripts": {
38
+ "build": "tsup --config tsup.config.ts",
39
+ "test": "vitest run",
40
+ "test:coverage": "vitest run --coverage",
41
+ "typecheck": "tsc --project tsconfig.json --noEmit",
42
+ "lint": "biome check . --config-path ../../../biome.json --error-on-warnings",
43
+ "clean": "node ../../../scripts/clean.mjs"
44
+ }
45
+ }