feat: neon connector

docs/2.connectors/neon.md

@@ -6,9 +6,33 @@ icon: cbi:neon
 
 > Connect DB0 to Neon Serverless Postgres.
 
-:read-more{to="https://neon.tech/"}
+:read-more{to="https://neon.tech"}
 
-::read-more{to="https://github.com/unjs/db0/issues/32"}
-This connector is planned to be supported. Follow up via [unjs/db0#32](https://github.com/unjs/db0/issues/32).
-::
+## Usage
 
+For this connector, you need to install [`@neondatabase/serverless`](https://www.npmjs.com/package/@neondatabase/serverless) dependency:
+
+:pm-install{name="@neondatabase/serverless"}
+
+Use `neon` connector:
+
+```js
+import { createDatabase } from "db0";
+import neonConnector from "db0/connectors/neon";
+
+const db = createDatabase(
+  neonConnector({
+    /* options */
+  }),
+);
+```
+
+## Options
+
+### `url`
+
+The URL of the Neon Serverless Postgres instance.
+
+**Type:** `string`
+
+:read-more{to="https://neon.tech/docs/serverless/serverless-driver#neon-function-configuration-options"}

package.json

@@ -55,6 +55,7 @@
     "@libsql/client": "^0.14.0",
     "@planetscale/database": "^1.19.0",
     "@types/better-sqlite3": "^7.6.12",
+    "@neondatabase/serverless": "^0.10.1",
     "@types/bun": "^1.2.0",
     "@types/pg": "^8.11.11",
     "@types/sqlite3": "^3.1.11",
@@ -80,6 +81,7 @@
   "peerDependencies": {
     "@electric-sql/pglite": "*",
     "@libsql/client": "*",
+    "@neondatabase/serverless": "*",
     "better-sqlite3": "*",
     "drizzle-orm": "*",
     "mysql2": "*",
@@ -89,6 +91,9 @@
     "@libsql/client": {
       "optional": true
     },
+    "@neondatabase/serverless": {
+      "optional": true
+    },
     "better-sqlite3": {
       "optional": true
     },

src/_connectors.ts

@@ -8,12 +8,13 @@
 import type { ConnectorOptions as LibSQLNodeOptions } from "db0/connectors/libsql/node";
 import type { ConnectorOptions as LibSQLWebOptions } from "db0/connectors/libsql/web";
 import type { ConnectorOptions as MySQL2Options } from "db0/connectors/mysql2";
+import type { ConnectorOptions as NeonOptions } from "db0/connectors/neon";
 import type { ConnectorOptions as NodeSQLite3Options } from "db0/connectors/node-sqlite3";
 import type { ConnectorOptions as PgliteOptions } from "db0/connectors/pglite";
 import type { ConnectorOptions as PlanetscaleOptions } from "db0/connectors/planetscale";
 import type { ConnectorOptions as PostgreSQLOptions } from "db0/connectors/postgresql";
 
-export type BuiltinConnectorName = "better-sqlite3" | "sqlite" | "bun-sqlite" | "bun" | "cloudflare-d1" | "libsql-core" | "libsql-http" | "libsql-node" | "libsql" | "libsql-web" | "mysql2" | "node-sqlite3" | "pglite" | "planetscale" | "postgresql";
+export type BuiltinConnectorName = "better-sqlite3" | "sqlite" | "bun-sqlite" | "bun" | "cloudflare-d1" | "libsql-core" | "libsql-http" | "libsql-node" | "libsql" | "libsql-web" | "mysql2" | "neon" | "node-sqlite3" | "pglite" | "planetscale" | "postgresql";
 
 export type BuiltinConnectorOptions = {
   "better-sqlite3": BetterSQLite3Options;
@@ -30,6 +31,7 @@
   "libsql": LibSQLNodeOptions;
   "libsql-web": LibSQLWebOptions;
   "mysql2": MySQL2Options;
+  "neon": NeonOptions;
   "node-sqlite3": NodeSQLite3Options;
   "pglite": PgliteOptions;
   "planetscale": PlanetscaleOptions;
@@ -51,6 +53,7 @@
   "libsql": "db0/connectors/libsql/node",
   "libsql-web": "db0/connectors/libsql/web",
   "mysql2": "db0/connectors/mysql2",
+  "neon": "db0/connectors/neon",
   "node-sqlite3": "db0/connectors/node-sqlite3",
   "pglite": "db0/connectors/pglite",
   "planetscale": "db0/connectors/planetscale",

src/connectors/neon.ts

@@ -0,0 +1,59 @@
+import { neon, HTTPTransactionOptions, NeonQueryFunction } from '@neondatabase/serverless';
+
+import type { Connector, Statement } from "../types";
+
+export interface ConnectorOptions extends HTTPTransactionOptions<undefined, undefined> {
+  /**
+   * The URL of the Neon Serverless Postgres instance.
+   *
+   * @required
+   */
+  url: string;
+}
+
+export default function neonConnector(opts: ConnectorOptions) {
+  let _connection: NeonQueryFunction<undefined, undefined>;
+  const getConnection = async () => {
+    if (_connection) {
+      return _connection;
+    }
+
+    const { url, ...transactionOptions } = opts;
+
+    _connection = neon(url, {
+      ...transactionOptions,
+    })
+
+    return _connection;
+  };
+
+  return <Connector>{
+    name: "neon",
+    dialect: "postgresql",
+    exec(sql: string) {
+      return getConnection().then((c) => c(sql));
+    },
+    prepare(sql: string) {
+      const stmt = <Statement>{
+        _sql: sql,
+        _params: [],
+        bind(...params) {
+          if (params.length > 0) {
+            this._params = params;
+          }
+          return stmt;
+        },
+        all(...params) {
+          return getConnection().then((c) => c(this._sql, params || this._params));
+        },
+        run(...params) {
+          return getConnection().then((c) => c(this._sql, params || this._params));
+        },
+        get(...params) {
+          return getConnection().then((c) => c(this._sql, params || this._params)).then((res) => res[0]);
+        },
+      };
+      return stmt;
+    },
+  };
+}

test/connectors/neon.test.ts

@@ -0,0 +1,15 @@
+import { describe } from "vitest";
+import connector from "../../src/connectors/neon";
+import { testConnector } from "./_tests";
+
+describe.runIf(process.env.POSTGRESQL_URL)(
+  "connectors: neon.test",
+  () => {
+    testConnector({
+      dialect: "postgresql",
+      connector: connector({
+        url: process.env.POSTGRESQL_URL!,
+      }),
+    });
+  },
+);