@mikro-orm/pglite 7.1.4-dev.9 → 7.1.4

package/PgliteConnection.d.ts

@@ -1,5 +1,17 @@
 import { PGliteDialect } from 'kysely';
 import { AbstractSqlConnection, type Dictionary } from '@mikro-orm/sql';
+/**
+ * Named-database mode is active when `driverOptions.dataDir` points at a real
+ * (persistent) cluster. In that case `dbName` selects a database *within* the
+ * cluster (PGlite's `database` option) instead of acting as the cluster
+ * location, which unlocks the real `CREATE DATABASE` lifecycle (`database:create`,
+ * migrations) handled by `PgliteSchemaHelper`. It stays off for in-memory
+ * clusters (we keep a single instance alive across reconnects, so the database
+ * can't be switched without losing data) and when a user-owned instance is passed.
+ *
+ * @internal — shared between the connection and `PgliteSchemaHelper`.
+ */
+export declare const pgliteUsesNamedDatabase: (driverOptions: unknown) => boolean;
 /** PostgreSQL-in-WASM database connection using `@electric-sql/pglite`. */
 export declare class PgliteConnection extends AbstractSqlConnection {
     #private;

package/PgliteConnection.js

@@ -3,6 +3,24 @@ import { PGliteDialect } from 'kysely';
 import array from 'postgres-array';
 import { AbstractSqlConnection, createPostgreSqlTypeParsers } from '@mikro-orm/sql';
 const isInMemoryDataDir = (dataDir) => !dataDir || dataDir === 'memory://' || dataDir.startsWith('memory:');
+/**
+ * Named-database mode is active when `driverOptions.dataDir` points at a real
+ * (persistent) cluster. In that case `dbName` selects a database *within* the
+ * cluster (PGlite's `database` option) instead of acting as the cluster
+ * location, which unlocks the real `CREATE DATABASE` lifecycle (`database:create`,
+ * migrations) handled by `PgliteSchemaHelper`. It stays off for in-memory
+ * clusters (we keep a single instance alive across reconnects, so the database
+ * can't be switched without losing data) and when a user-owned instance is passed.
+ *
+ * @internal — shared between the connection and `PgliteSchemaHelper`.
+ */
+export const pgliteUsesNamedDatabase = (driverOptions) => {
+    if (!driverOptions || typeof driverOptions !== 'object') {
+        return false;
+    }
+    const { pglite, dataDir } = driverOptions;
+    return !pglite && !isInMemoryDataDir(dataDir);
+};
 /** PostgreSQL-in-WASM database connection using `@electric-sql/pglite`. */
 export class PgliteConnection extends AbstractSqlConnection {
     // Stored as a Promise so `createKyselyDialect` can stay synchronous (else
@@ -15,7 +33,11 @@ export class PgliteConnection extends AbstractSqlConnection {
         const onCreateConnection = this.options.onCreateConnection ?? this.config.get('onCreateConnection');
         const options = (overrides ?? {});
         const { pglite: userPglite, ...pgliteOptions } = options;
-        const dataDir = options.dataDir ?? this.config.get('dbName');
+        const namedDatabase = pgliteUsesNamedDatabase(options);
+        const dbName = this.config.get('dbName');
+        // In named-database mode the cluster lives at `driverOptions.dataDir` and
+        // `dbName` selects a database inside it; otherwise `dbName` *is* the cluster.
+        const dataDir = options.dataDir ?? dbName;
         const parsers = { ...createPostgreSqlTypeParsers(s => array.parse(s)), ...options.parsers };
         this.#ownsPglite = !userPglite;
         // Skip `pglite.close()` (called by kysely's `PGliteDriver.destroy()`) when:
@@ -31,7 +53,12 @@ export class PgliteConnection extends AbstractSqlConnection {
                 this.#pglite = typeof userPglite === 'function' ? Promise.resolve(userPglite()) : Promise.resolve(userPglite);
             }
             else {
-                this.#pglite = PGlite.create({ ...pgliteOptions, dataDir, parsers });
+                this.#pglite = PGlite.create({
+                    ...pgliteOptions,
+                    dataDir,
+                    parsers,
+                    ...(namedDatabase ? { database: dbName } : {}),
+                });
             }
         }
         if (this.#neuterClose) {

package/PgliteSchemaHelper.d.ts

@@ -1,12 +1,18 @@
 import type { Connection } from '@mikro-orm/core';
 import { PostgreSqlSchemaHelper } from '@mikro-orm/sql';
 /**
- * PGlite is a single-database engine — there is no management catalog and no
- * `CREATE DATABASE`. Override the relevant lifecycle hooks to no-ops.
+ * In the default (single-database) setup a PGlite instance maps 1:1 to a
+ * `dataDir`, so there is no management catalog to connect to and the
+ * `CREATE DATABASE` lifecycle is a no-op. When `driverOptions.dataDir` is set,
+ * `dbName` instead selects a database inside that cluster, and we defer to the
+ * PostgreSQL behaviour: connect to the `postgres` management database to run a
+ * real `CREATE DATABASE`/`DROP DATABASE`, then reconnect to the target.
  */
 export declare class PgliteSchemaHelper extends PostgreSqlSchemaHelper {
+    #private;
     getManagementDbName(): string;
-    getCreateDatabaseSQL(): string;
-    getDropDatabaseSQL(): string;
-    databaseExists(_connection: Connection, _name: string): Promise<boolean>;
+    getCreateDatabaseSQL(name: string): string;
+    getDropDatabaseSQL(name: string): string;
+    getDatabaseNotExistsError(dbName: string): string;
+    databaseExists(connection: Connection, name: string): Promise<boolean>;
 }

package/PgliteSchemaHelper.js

@@ -1,19 +1,39 @@
 import { PostgreSqlSchemaHelper } from '@mikro-orm/sql';
+import { pgliteUsesNamedDatabase } from './PgliteConnection.js';
 /**
- * PGlite is a single-database engine — there is no management catalog and no
- * `CREATE DATABASE`. Override the relevant lifecycle hooks to no-ops.
+ * In the default (single-database) setup a PGlite instance maps 1:1 to a
+ * `dataDir`, so there is no management catalog to connect to and the
+ * `CREATE DATABASE` lifecycle is a no-op. When `driverOptions.dataDir` is set,
+ * `dbName` instead selects a database inside that cluster, and we defer to the
+ * PostgreSQL behaviour: connect to the `postgres` management database to run a
+ * real `CREATE DATABASE`/`DROP DATABASE`, then reconnect to the target.
  */
 export class PgliteSchemaHelper extends PostgreSqlSchemaHelper {
+    #usesNamedDatabase() {
+        // `driverOptions` may be a factory (resolved per-connect in `createKysely`),
+        // so resolve it the same way to stay in sync with the connection.
+        let driverOptions = this.platform.getConfig().get('driverOptions');
+        if (typeof driverOptions === 'function') {
+            driverOptions = driverOptions();
+        }
+        return pgliteUsesNamedDatabase(driverOptions);
+    }
     getManagementDbName() {
-        return '';
+        return this.#usesNamedDatabase() ? super.getManagementDbName() : '';
+    }
+    getCreateDatabaseSQL(name) {
+        return this.#usesNamedDatabase() ? super.getCreateDatabaseSQL(name) : '';
     }
-    getCreateDatabaseSQL() {
-        return '';
+    getDropDatabaseSQL(name) {
+        return this.#usesNamedDatabase() ? super.getDropDatabaseSQL(name) : '';
     }
-    getDropDatabaseSQL() {
-        return '';
+    getDatabaseNotExistsError(dbName) {
+        // PGlite throws a generic init error (rather than Postgres' "database ...
+        // does not exist") when the `database` option points at a missing database,
+        // which is how `databaseExists()` detects absence before creating it.
+        return this.#usesNamedDatabase() ? 'PGlite failed to initialize properly' : super.getDatabaseNotExistsError(dbName);
     }
-    async databaseExists(_connection, _name) {
-        return true;
+    async databaseExists(connection, name) {
+        return this.#usesNamedDatabase() ? super.databaseExists(connection, name) : true;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/pglite",
-  "version": "7.1.4-dev.9",
+  "version": "7.1.4",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "keywords": [
     "data-mapper",
@@ -48,18 +48,18 @@
     "copy": "node ../../scripts/copy.mjs"
   },
   "dependencies": {
-    "@electric-sql/pglite": "0.4.6",
-    "@mikro-orm/sql": "7.1.4-dev.9",
+    "@electric-sql/pglite": "0.5.1",
+    "@mikro-orm/sql": "7.1.4",
     "kysely": "0.29.2",
     "postgres-array": "3.0.4",
     "postgres-date": "2.1.0",
     "postgres-interval": "4.0.2"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^7.1.3"
+    "@mikro-orm/core": "^7.1.4"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.1.4-dev.9"
+    "@mikro-orm/core": "7.1.4"
   },
   "engines": {
     "node": ">= 22.17.0"