@mikro-orm/sql 7.1.0-dev.30 → 7.1.0-dev.31

package/README.md

@@ -2,7 +2,7 @@
   <a href="https://mikro-orm.io"><img src="https://raw.githubusercontent.com/mikro-orm/mikro-orm/master/docs/static/img/logo-readme.svg?sanitize=true" alt="MikroORM" /></a>
 </h1>
 
-TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-orm.io/docs/unit-of-work/) and [Identity Map](https://mikro-orm.io/docs/identity-map/) patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL, SQLite (including libSQL), MSSQL and Oracle databases.
+TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-orm.io/docs/unit-of-work/) and [Identity Map](https://mikro-orm.io/docs/identity-map/) patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL (including CockroachDB and PGlite), SQLite (including libSQL), MSSQL and Oracle databases.
 
 > Heavily inspired by [Doctrine](https://www.doctrine-project.org/) and [Hibernate](https://hibernate.org/).
 
@@ -19,6 +19,7 @@ Install a driver package for your database:
 
 ```sh
 npm install @mikro-orm/postgresql   # PostgreSQL
+npm install @mikro-orm/pglite       # PGlite (embedded PostgreSQL in WASM)
 npm install @mikro-orm/mysql        # MySQL
 npm install @mikro-orm/mariadb      # MariaDB
 npm install @mikro-orm/sqlite       # SQLite

package/dialects/postgresql/BasePostgreSqlEntityManager.d.ts

@@ -0,0 +1,19 @@
+import { type EntityName } from '@mikro-orm/core';
+import { SqlEntityManager } from '../../SqlEntityManager.js';
+import type { AbstractSqlDriver } from '../../AbstractSqlDriver.js';
+/**
+ * Shared base class for PostgreSQL-flavoured entity managers (`pg`, `pglite`).
+ * Adds Postgres-only helpers on top of `SqlEntityManager`.
+ */
+export declare class BasePostgreSqlEntityManager<Driver extends AbstractSqlDriver = AbstractSqlDriver> extends SqlEntityManager<Driver> {
+    /**
+     * Refreshes a materialized view.
+     *
+     * @param entityName - The entity name or class of the materialized view
+     * @param options - Optional settings
+     * @param options.concurrently - If true, refreshes the view concurrently (requires a unique index on the view)
+     */
+    refreshMaterializedView<Entity extends object>(entityName: EntityName<Entity>, options?: {
+        concurrently?: boolean;
+    }): Promise<void>;
+}

package/dialects/postgresql/BasePostgreSqlEntityManager.js

@@ -0,0 +1,24 @@
+import { SqlEntityManager } from '../../SqlEntityManager.js';
+/**
+ * Shared base class for PostgreSQL-flavoured entity managers (`pg`, `pglite`).
+ * Adds Postgres-only helpers on top of `SqlEntityManager`.
+ */
+export class BasePostgreSqlEntityManager extends SqlEntityManager {
+    /**
+     * Refreshes a materialized view.
+     *
+     * @param entityName - The entity name or class of the materialized view
+     * @param options - Optional settings
+     * @param options.concurrently - If true, refreshes the view concurrently (requires a unique index on the view)
+     */
+    async refreshMaterializedView(entityName, options) {
+        const meta = this.getMetadata(entityName);
+        if (!meta.view || !meta.materialized) {
+            throw new Error(`Entity ${meta.className} is not a materialized view`);
+        }
+        const helper = this.getDriver().getPlatform().getSchemaHelper();
+        const schema = meta.schema ?? this.config.get('schema');
+        const sql = helper.refreshMaterializedView(meta.tableName, schema, options?.concurrently);
+        await this.execute(sql);
+    }
+}

package/dialects/postgresql/BasePostgreSqlPlatform.d.ts

@@ -71,6 +71,12 @@ export declare class BasePostgreSqlPlatform extends AbstractSqlPlatform {
     }): string[];
     marshallArray(values: string[]): string;
     unmarshallArray(value: string): string[];
+    escape(value: any): string;
+    /**
+     * Ported from PostgreSQL 9.2.4 source code (`src/interfaces/libpq/fe-exec.c`),
+     * matching `pg.Client.prototype.escapeLiteral` so we don't need a `pg` dep here.
+     */
+    private escapeLiteral;
     getVarcharTypeDeclarationSQL(column: {
         length?: number;
     }): string;

package/dialects/postgresql/BasePostgreSqlPlatform.js

@@ -212,6 +212,50 @@ export class BasePostgreSqlPlatform extends AbstractSqlPlatform {
             return v;
         });
     }
+    escape(value) {
+        if (typeof value === 'bigint') {
+            value = value.toString();
+        }
+        if (typeof value === 'string') {
+            return this.escapeLiteral(value);
+        }
+        if (value instanceof Date) {
+            return `'${this.formatDate(value)}'`;
+        }
+        if (ArrayBuffer.isView(value)) {
+            return `E'\\\\x${value.toString('hex')}'`;
+        }
+        if (Array.isArray(value)) {
+            return value.map(v => this.escape(v)).join(', ');
+        }
+        return value;
+    }
+    /**
+     * Ported from PostgreSQL 9.2.4 source code (`src/interfaces/libpq/fe-exec.c`),
+     * matching `pg.Client.prototype.escapeLiteral` so we don't need a `pg` dep here.
+     */
+    escapeLiteral(str) {
+        let hasBackslash = false;
+        let escaped = `'`;
+        for (let i = 0; i < str.length; i++) {
+            const c = str[i];
+            if (c === `'`) {
+                escaped += c + c;
+            }
+            else if (c === '\\') {
+                escaped += c + c;
+                hasBackslash = true;
+            }
+            else {
+                escaped += c;
+            }
+        }
+        escaped += `'`;
+        if (hasBackslash) {
+            escaped = ` E${escaped}`;
+        }
+        return escaped;
+    }
     getVarcharTypeDeclarationSQL(column) {
         if (column.length === -1) {
             return 'varchar';

package/dialects/postgresql/index.d.ts

@@ -1,4 +1,6 @@
 export * from './PostgreSqlNativeQueryBuilder.js';
 export * from './BasePostgreSqlPlatform.js';
+export * from './BasePostgreSqlEntityManager.js';
 export * from './FullTextType.js';
 export * from './PostgreSqlSchemaHelper.js';
+export * from './typeOverrides.js';

package/dialects/postgresql/index.js

@@ -1,4 +1,6 @@
 export * from './PostgreSqlNativeQueryBuilder.js';
 export * from './BasePostgreSqlPlatform.js';
+export * from './BasePostgreSqlEntityManager.js';
 export * from './FullTextType.js';
 export * from './PostgreSqlSchemaHelper.js';
+export * from './typeOverrides.js';

package/dialects/postgresql/typeOverrides.d.ts

@@ -0,0 +1,14 @@
+/**
+ * MikroORM keeps PostgreSQL date/timestamp/interval values as raw strings
+ * (and array variants as `string[]`); both `pg` and `pglite` would otherwise
+ * eagerly parse them via `pg-types`. Centralizing the OID list here keeps the
+ * postgres and pglite drivers in lockstep, while leaving the actual array
+ * parsing implementation to the leaf driver (so `@mikro-orm/sql` stays free of
+ * postgres-array / postgres-date / postgres-interval dependencies).
+ *
+ * Use `select typname, oid, typarray from pg_type order by oid` to look up OIDs.
+ */
+type PostgreSqlArrayParser = (value: string) => string[];
+type PostgreSqlValueParser = (value: string) => unknown;
+export declare function createPostgreSqlTypeParsers(arrayParse: PostgreSqlArrayParser): Record<number, PostgreSqlValueParser>;
+export {};

package/dialects/postgresql/typeOverrides.js

@@ -0,0 +1,12 @@
+export function createPostgreSqlTypeParsers(arrayParse) {
+    const parsers = {};
+    for (const oid of [1082, 1114, 1184, 1186]) {
+        // date, timestamp, timestamptz, interval — kept as raw strings
+        parsers[oid] = str => str;
+    }
+    for (const oid of [1182, 1115, 1185, 1187]) {
+        // date[], timestamp[], timestamptz[], interval[]
+        parsers[oid] = arrayParse;
+    }
+    return parsers;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/sql",
-  "version": "7.1.0-dev.30",
+  "version": "7.1.0-dev.31",
   "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",
@@ -47,13 +47,13 @@
     "copy": "node ../../scripts/copy.mjs"
   },
   "dependencies": {
-    "kysely": "0.28.17"
+    "kysely": "0.29.0"
   },
   "devDependencies": {
     "@mikro-orm/core": "^7.0.15"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.1.0-dev.30"
+    "@mikro-orm/core": "7.1.0-dev.31"
   },
   "engines": {
     "node": ">= 22.17.0"