@mikro-orm/core 7.0.0-dev.175 → 7.0.0-dev.176

package/errors.d.ts

@@ -67,6 +67,7 @@ export declare class MetadataError<T extends AnyEntity = AnyEntity> extends Vali
     static targetKeyNotFound(meta: EntityMetadata, prop: EntityProperty): MetadataError<Partial<any>>;
     static dangerousPropertyName(meta: EntityMetadata, prop: EntityProperty): MetadataError<Partial<any>>;
     static viewEntityWithoutExpression(meta: EntityMetadata): MetadataError;
+    static materializedWithoutView(meta: EntityMetadata): MetadataError;
     private static fromMessage;
 }
 export declare class NotFoundError<T extends AnyEntity = AnyEntity> extends ValidationError<T> {

package/errors.js

@@ -228,6 +228,9 @@ export class MetadataError extends ValidationError {
     static viewEntityWithoutExpression(meta) {
         return new MetadataError(`View entity ${meta.className} is missing 'expression'. View entities must have an expression defining the SQL query.`);
     }
+    static materializedWithoutView(meta) {
+        return new MetadataError(`Entity ${meta.className} has 'materialized: true' but is missing 'view: true'. Materialized views must also be marked as views.`);
+    }
     static fromMessage(meta, prop, message) {
         return new MetadataError(`${meta.className}.${prop.name} ${message}`);
     }

package/metadata/MetadataValidator.js

@@ -19,6 +19,9 @@ const DANGEROUS_PROPERTY_NAMES = ['__proto__', 'constructor', 'prototype'];
 export class MetadataValidator {
     validateEntityDefinition(metadata, name, options) {
         const meta = metadata.get(name);
+        if (meta.materialized && !meta.view) {
+            throw MetadataError.materializedWithoutView(meta);
+        }
         // View entities (expression with view flag) behave like regular tables but are read-only
         // They can have primary keys and are created as actual database views
         if (meta.view) {

package/metadata/types.d.ts

@@ -35,6 +35,18 @@ export type EntityOptions<T, E = T extends EntityClass<infer P> ? P : T> = {
      * View entities are read-only by default.
      */
     view?: boolean;
+    /**
+     * Marks the view entity as a materialized view. Requires `view: true`.
+     * Materialized views store the query results and must be refreshed to update data.
+     * Only supported on PostgreSQL.
+     */
+    materialized?: boolean;
+    /**
+     * For materialized views, whether to populate data immediately on creation.
+     * Defaults to `true`. Set to `false` to create an unpopulated materialized view.
+     * Only applicable when `materialized: true`.
+     */
+    withData?: boolean;
     /** Used to make ORM aware of externally defined triggers. This is needed for MS SQL Server multi inserts, ignored in other dialects. */
     hasTriggers?: boolean;
     /** SQL query that maps to a {@doclink virtual-entities | virtual entity}, or for view entities, the view definition. */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mikro-orm/core",
   "type": "module",
-  "version": "7.0.0-dev.175",
+  "version": "7.0.0-dev.176",
   "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.",
   "exports": {
     "./package.json": "./package.json",

package/platforms/Platform.d.ts

@@ -27,6 +27,7 @@ export declare abstract class Platform {
     supportsNativeEnums(): boolean;
     /** for postgres text enums (default) */
     usesEnumCheckConstraints(): boolean;
+    supportsMaterializedViews(): boolean;
     getSchemaHelper(): unknown;
     indexForeignKeys(): boolean;
     /**

package/platforms/Platform.js

@@ -41,6 +41,9 @@ export class Platform {
     usesEnumCheckConstraints() {
         return false;
     }
+    supportsMaterializedViews() {
+        return false;
+    }
     getSchemaHelper() {
         return undefined;
     }

package/typings.d.ts

@@ -474,6 +474,10 @@ export interface EntityMetadata<Entity = any, Class extends EntityCtor<Entity> =
     virtual?: boolean;
     /** True if this entity represents a database view (not a virtual entity). */
     view?: boolean;
+    /** True if this is a materialized view (PostgreSQL only). Requires `view: true`. */
+    materialized?: boolean;
+    /** For materialized views, whether data is populated on creation. Defaults to true. */
+    withData?: boolean;
     expression?: string | ((em: any, where: ObjectQuery<Entity>, options: FindOptions<Entity, any, any, any>, stream?: boolean) => MaybePromise<Raw | object | string>);
     discriminatorColumn?: EntityKey<Entity> | AnyString;
     discriminatorValue?: number | string;

package/utils/Utils.js

@@ -123,7 +123,7 @@ export function parseJsonSafe(value) {
 }
 export class Utils {
     static PK_SEPARATOR = '~~~';
-    static #ORM_VERSION = '7.0.0-dev.175';
+    static #ORM_VERSION = '7.0.0-dev.176';
     /**
      * Checks if the argument is instance of `Object`. Returns false for arrays.
      */