@mikro-orm/sql 7.1.0-dev.2 → 7.1.0-dev.20

package/schema/DatabaseSchema.js

@@ -1,5 +1,6 @@
 import { ReferenceKind, isRaw, } from '@mikro-orm/core';
 import { DatabaseTable } from './DatabaseTable.js';
+import { getTablePartitioning } from './partitioning.js';
 /**
  * @internal
  */
@@ -173,6 +174,9 @@ export class DatabaseSchema {
             }
             const table = schema.addTable(meta.collection, this.getSchemaName(meta, config, schemaName));
             table.comment = meta.comment;
+            if (meta.partitionBy) {
+                table.setPartitioning(getTablePartitioning(meta, this.getSchemaName(meta, config, schemaName), id => platform.quoteIdentifier(id)));
+            }
             // For TPT child entities, only use ownProps (properties defined in this entity only)
             // For all other entities (including TPT root), use all props
             const propsToProcess = meta.inheritanceType === 'tpt' && meta.tptParent && meta.ownProps ? meta.ownProps : meta.props;
@@ -220,6 +224,20 @@ export class DatabaseSchema {
                     columnName,
                 });
             }
+            for (const trigger of meta.triggers) {
+                const body = isRaw(trigger.body)
+                    ? platform.formatQuery(trigger.body.sql, trigger.body.params)
+                    : trigger.body;
+                table.addTrigger({
+                    name: trigger.name,
+                    timing: trigger.timing,
+                    events: trigger.events,
+                    forEach: trigger.forEach ?? 'row',
+                    body: body ?? '',
+                    when: trigger.when,
+                    expression: trigger.expression,
+                });
+            }
         }
         return schema;
     }

package/schema/DatabaseTable.d.ts

@@ -1,6 +1,6 @@
 import { type Configuration, type DeferMode, type Dictionary, type EntityMetadata, type EntityProperty, type IndexCallback, type NamingStrategy } from '@mikro-orm/core';
 import type { SchemaHelper } from './SchemaHelper.js';
-import type { CheckDef, Column, ForeignKey, IndexDef } from '../typings.js';
+import type { CheckDef, Column, ForeignKey, IndexDef, TablePartitioning, SqlTriggerDef } from '../typings.js';
 import type { AbstractSqlPlatform } from '../AbstractSqlPlatform.js';
 /**
  * @internal
@@ -15,6 +15,7 @@ export declare class DatabaseTable {
         items: string[];
     }>;
     comment?: string;
+    partitioning?: TablePartitioning;
     constructor(platform: AbstractSqlPlatform, name: string, schema?: string | undefined);
     getQuotedName(): string;
     getColumns(): Column[];
@@ -22,11 +23,17 @@ export declare class DatabaseTable {
     removeColumn(name: string): void;
     getIndexes(): IndexDef[];
     getChecks(): CheckDef[];
+    getPartitioning(): TablePartitioning | undefined;
+    /** @internal */
+    setPartitioning(partitioning?: TablePartitioning): void;
+    getTriggers(): SqlTriggerDef[];
     /** @internal */
     setIndexes(indexes: IndexDef[]): void;
     /** @internal */
     setChecks(checks: CheckDef[]): void;
     /** @internal */
+    setTriggers(triggers: SqlTriggerDef[]): void;
+    /** @internal */
     setForeignKeys(fks: Dictionary<ForeignKey>): void;
     init(cols: Column[], indexes: IndexDef[] | undefined, checks: CheckDef[] | undefined, pks: string[], fks?: Dictionary<ForeignKey>, enums?: Dictionary<string[]>): void;
     addColumn(column: Column): void;
@@ -47,6 +54,8 @@ export declare class DatabaseTable {
     hasIndex(indexName: string): boolean;
     getCheck(checkName: string): CheckDef | undefined;
     hasCheck(checkName: string): boolean;
+    getTrigger(triggerName: string): SqlTriggerDef | undefined;
+    hasTrigger(triggerName: string): boolean;
     getPrimaryKey(): IndexDef | undefined;
     hasPrimaryKey(): boolean;
     private getForeignKeyDeclaration;
@@ -62,6 +71,7 @@ export declare class DatabaseTable {
         name?: string;
         type?: string;
         expression?: string | IndexCallback<any>;
+        where?: string | Dictionary;
         deferMode?: DeferMode | `${DeferMode}`;
         options?: Dictionary;
         columns?: {
@@ -77,6 +87,8 @@ export declare class DatabaseTable {
         disabled?: boolean;
         clustered?: boolean;
     }, type: 'index' | 'unique' | 'primary'): void;
+    private processIndexWhere;
     addCheck(check: CheckDef): void;
+    addTrigger(trigger: SqlTriggerDef): void;
     toJSON(): Dictionary;
 }

package/schema/DatabaseTable.js

@@ -1,4 +1,5 @@
 import { DecimalType, EntitySchema, isRaw, ReferenceKind, t, Type, UnknownType, Utils, } from '@mikro-orm/core';
+import { toEntityPartitionBy } from './partitioning.js';
 /**
  * @internal
  */
@@ -8,10 +9,12 @@ export class DatabaseTable {
     #columns = {};
     #indexes = [];
     #checks = [];
+    #triggers = [];
     #foreignKeys = {};
     #platform;
     nativeEnums = {}; // for postgres
     comment;
+    partitioning;
     constructor(platform, name, schema) {
         this.name = name;
         this.schema = schema;
@@ -35,6 +38,16 @@ export class DatabaseTable {
     getChecks() {
         return this.#checks;
     }
+    getPartitioning() {
+        return this.partitioning;
+    }
+    /** @internal */
+    setPartitioning(partitioning) {
+        this.partitioning = partitioning;
+    }
+    getTriggers() {
+        return this.#triggers;
+    }
     /** @internal */
     setIndexes(indexes) {
         this.#indexes = indexes;
@@ -44,6 +57,10 @@ export class DatabaseTable {
         this.#checks = checks;
     }
     /** @internal */
+    setTriggers(triggers) {
+        this.#triggers = triggers;
+    }
+    /** @internal */
     setForeignKeys(fks) {
         this.#foreignKeys = fks;
     }
@@ -177,6 +194,7 @@ export class DatabaseTable {
         const { fksOnColumnProps, fksOnStandaloneProps, columnFks, fkIndexes, nullableForeignKeys, skippedColumnNames } = this.foreignKeysToProps(namingStrategy, scalarPropertiesForRelations);
         const name = namingStrategy.getEntityName(this.name, this.schema);
         const schema = new EntitySchema({ name, collection: this.name, schema: this.schema, comment: this.comment });
+        schema.meta.partitionBy = toEntityPartitionBy(this.partitioning, this.name, this.schema);
         const compositeFkIndexes = {};
         const compositeFkUniques = {};
         const potentiallyUnmappedIndexes = this.#indexes.filter(index => !index.primary && // Skip primary index. Whether it's in use by scalar column or FK, it's already mapped.
@@ -196,6 +214,7 @@ export class DatabaseTable {
                 name: index.keyName,
                 deferMode: index.deferMode,
                 expression: index.expression,
+                where: index.where,
                 // Advanced index options - convert column names to property names
                 columns: index.columns?.map(col => ({
                     ...col,
@@ -226,7 +245,7 @@ export class DatabaseTable {
                 index.invisible ||
                 index.disabled ||
                 index.clustered;
-            const isTrivial = !index.deferMode && !index.expression && !hasAdvancedOptions;
+            const isTrivial = !index.deferMode && !index.expression && !index.where && !hasAdvancedOptions;
             if (isTrivial) {
                 // Index is for FK. Map to the FK prop and move on.
                 const fkForIndex = fkIndexes.get(index);
@@ -598,6 +617,12 @@ export class DatabaseTable {
     hasCheck(checkName) {
         return !!this.getCheck(checkName);
     }
+    getTrigger(triggerName) {
+        return this.#triggers.find(t => t.name === triggerName);
+    }
+    hasTrigger(triggerName) {
+        return !!this.getTrigger(triggerName);
+    }
     getPrimaryKey() {
         return this.#indexes.find(i => i.primary);
     }
@@ -862,16 +887,25 @@ export class DatabaseTable {
         if (index.fillFactor != null && (index.fillFactor < 0 || index.fillFactor > 100)) {
             throw new Error(`fillFactor must be between 0 and 100, got ${index.fillFactor} for index '${name}' on entity '${meta.className}'`);
         }
+        // The `expression` escape hatch takes the full index definition as raw SQL; combining it
+        // with `where` is dialect-dependent (PG/Oracle/MySQL drop `where`, MSSQL appends it) so we
+        // reject the combination up-front and ask users to inline the predicate into `expression`.
+        if (index.expression && index.where != null) {
+            throw new Error(`Index '${name}' on entity '${meta.className}': cannot combine \`expression\` with \`where\` — inline the WHERE clause into the \`expression\` escape hatch, or drop \`expression\` and use structured \`properties\` + \`where\`.`);
+        }
+        const where = this.processIndexWhere(index.where, meta);
         this.#indexes.push({
             keyName: name,
             columnNames: properties,
             composite: properties.length > 1,
-            // JSON columns can have unique index but not unique constraint, and we need to distinguish those, so we can properly drop them
-            constraint: type !== 'index' && !properties.some((d) => d.includes('.')),
+            // JSON columns can have unique index but not unique constraint, and we need to distinguish those, so we can properly drop them.
+            // Partial indexes (`where`) must use CREATE [UNIQUE] INDEX form — constraints can't carry predicates.
+            constraint: type !== 'index' && !properties.some((d) => d.includes('.')) && !where,
             primary: type === 'primary',
             unique: type !== 'index',
             type: index.type,
             expression: this.processIndexExpression(name, index.expression, meta),
+            where,
             options: index.options,
             deferMode: index.deferMode,
             columns,
@@ -882,9 +916,21 @@ export class DatabaseTable {
             clustered: index.clustered,
         });
     }
+    processIndexWhere(where, meta) {
+        if (where == null) {
+            return undefined;
+        }
+        // The driver is always an `AbstractSqlDriver` here — `DatabaseTable` is only instantiated
+        // by SQL-side schema code, so the platform's config-bound driver is guaranteed to be one.
+        const driver = this.#platform.getConfig().getDriver();
+        return driver.renderPartialIndexWhere(meta.class, where);
+    }
     addCheck(check) {
         this.#checks.push(check);
     }
+    addTrigger(trigger) {
+        this.#triggers.push(trigger);
+    }
     toJSON() {
         const columns = this.#columns;
         const columnsMapped = Utils.keys(columns).reduce((o, col) => {
@@ -929,6 +975,7 @@ export class DatabaseTable {
             columns: columnsMapped,
             indexes: this.#indexes,
             checks: this.#checks,
+            triggers: this.#triggers,
             foreignKeys: this.#foreignKeys,
             nativeEnums: this.nativeEnums,
             comment: this.comment,

package/schema/SchemaComparator.d.ts

@@ -69,6 +69,7 @@ export declare class SchemaComparator {
      * @see https://github.com/mikro-orm/mikro-orm/issues/7308
      */
     private diffViewExpression;
+    private diffTrigger;
     parseJsonDefault(defaultValue?: string | null): Dictionary | string | null;
     hasSameDefaultValue(from: Column, to: Column): boolean;
     private mapColumnToProperty;

package/schema/SchemaComparator.js

@@ -1,5 +1,6 @@
 import { ArrayType, BooleanType, DateTimeType, inspect, JsonType, parseJsonSafe, Utils, } from '@mikro-orm/core';
 import { DatabaseTable } from './DatabaseTable.js';
+import { diffPartitioning } from './partitioning.js';
 /**
  * Compares two Schemas and return an instance of SchemaDifference.
  */
@@ -176,14 +177,17 @@ export class SchemaComparator {
             addedForeignKeys: {},
             addedIndexes: {},
             addedChecks: {},
+            addedTriggers: {},
             changedColumns: {},
             changedForeignKeys: {},
             changedIndexes: {},
             changedChecks: {},
+            changedTriggers: {},
             removedColumns: {},
             removedForeignKeys: {},
             removedIndexes: {},
             removedChecks: {},
+            removedTriggers: {},
             renamedColumns: {},
             renamedIndexes: {},
             fromTable,
@@ -197,6 +201,17 @@ export class SchemaComparator {
             });
             changes++;
         }
+        if (diffPartitioning(fromTable.getPartitioning(), toTable.getPartitioning(), this.#platform.getDefaultSchemaName())) {
+            tableDifferences.changedPartitioning = {
+                from: fromTable.getPartitioning(),
+                to: toTable.getPartitioning(),
+            };
+            this.log(`table partitioning changed for ${tableDifferences.name}`, {
+                fromPartitioning: fromTable.getPartitioning(),
+                toPartitioning: toTable.getPartitioning(),
+            });
+            changes++;
+        }
         const fromTableColumns = fromTable.getColumns();
         const toTableColumns = toTable.getColumns();
         // See if all the columns in "from" table exist in "to" table
@@ -263,6 +278,19 @@ export class SchemaComparator {
             if (!this.diffIndex(index, toTableIndex)) {
                 continue;
             }
+            // Constraint-vs-index form mismatch needs drop+create with the OLD form's drop SQL,
+            // which `changedIndexes` (uses new form only) can't do. Primary keys stay on the
+            // changed path which emits `add primary key`.
+            if (!index.primary && !!index.constraint !== !!toTableIndex.constraint) {
+                tableDifferences.removedIndexes[index.keyName] = index;
+                tableDifferences.addedIndexes[index.keyName] = toTableIndex;
+                this.log(`index ${index.keyName} changed form in table ${tableDifferences.name}`, {
+                    fromTableIndex: index,
+                    toTableIndex,
+                });
+                changes += 2;
+                continue;
+            }
             tableDifferences.changedIndexes[index.keyName] = toTableIndex;
             this.log(`index ${index.keyName} changed in table ${tableDifferences.name}`, {
                 fromTableIndex: index,
@@ -309,6 +337,33 @@ export class SchemaComparator {
             tableDifferences.changedChecks[check.name] = toTableCheck;
             changes++;
         }
+        const fromTableTriggers = fromTable.getTriggers();
+        const toTableTriggers = toTable.getTriggers();
+        for (const trigger of toTableTriggers) {
+            if (fromTable.hasTrigger(trigger.name)) {
+                continue;
+            }
+            tableDifferences.addedTriggers[trigger.name] = trigger;
+            this.log(`trigger ${trigger.name} added to table ${tableDifferences.name}`, { trigger });
+            changes++;
+        }
+        for (const trigger of fromTableTriggers) {
+            if (!toTable.hasTrigger(trigger.name)) {
+                tableDifferences.removedTriggers[trigger.name] = trigger;
+                this.log(`trigger ${trigger.name} removed from table ${tableDifferences.name}`);
+                changes++;
+                continue;
+            }
+            const toTableTrigger = toTable.getTrigger(trigger.name);
+            if (this.diffTrigger(trigger, toTableTrigger)) {
+                this.log(`trigger ${trigger.name} changed in table ${tableDifferences.name}`, {
+                    fromTableTrigger: trigger,
+                    toTableTrigger,
+                });
+                tableDifferences.changedTriggers[trigger.name] = toTableTrigger;
+                changes++;
+            }
+        }
         const fromForeignKeys = { ...fromTable.getForeignKeys() };
         const toForeignKeys = { ...toTable.getForeignKeys() };
         for (const fromConstraint of Object.values(fromForeignKeys)) {
@@ -542,7 +597,8 @@ export class SchemaComparator {
      * Compares index1 with index2 and returns index2 if there are any differences or false in case there are no differences.
      */
     diffIndex(index1, index2) {
-        // if one of them is a custom expression or full text index, compare only by name
+        // Opaque raw expressions (`expression` escape hatch) and full-text indexes can't be
+        // compared structurally — fall back to name-only matching.
         if (index1.expression || index2.expression || index1.type === 'fulltext' || index2.type === 'fulltext') {
             return index1.keyName !== index2.keyName;
         }
@@ -593,6 +649,11 @@ export class SchemaComparator {
         if (!!index1.clustered !== !!index2.clustered) {
             return false;
         }
+        // Compare WHERE predicate of partial indexes structurally (whitespace/quoting/casing
+        // are normalized via the same helper used for check constraints).
+        if (this.diffExpression(index1.where ?? '', index2.where ?? '')) {
+            return false;
+        }
         if (!index1.unique && !index1.primary) {
             // this is a special case: If the current key is neither primary or unique, any unique or
             // primary key will always have the same effect for the index and there cannot be any constraint
@@ -714,6 +775,30 @@ export class SchemaComparator {
         }
         return true;
     }
+    diffTrigger(from, to) {
+        // Raw DDL expression cannot be meaningfully compared to introspected
+        // trigger metadata, so skip diffing when the metadata side uses it.
+        if (to.expression) {
+            // Both sides have expression — compare the raw DDL directly
+            if (from.expression) {
+                return this.diffExpression(from.expression, to.expression);
+            }
+            // Only metadata side has expression — the raw DDL cannot be compared to
+            // introspected metadata. Changes to the expression value won't be detected;
+            // drop and recreate the trigger manually to apply expression changes.
+            return false;
+        }
+        if (from.timing !== to.timing || from.forEach !== to.forEach) {
+            return true;
+        }
+        if ([...from.events].sort().join(',') !== [...to.events].sort().join(',')) {
+            return true;
+        }
+        if ((from.when ?? '') !== (to.when ?? '')) {
+            return true;
+        }
+        return this.diffExpression(from.body, to.body);
+    }
     parseJsonDefault(defaultValue) {
         /* v8 ignore next */
         if (!defaultValue) {

package/schema/SchemaHelper.d.ts

@@ -1,7 +1,7 @@
 import { type Connection, type Dictionary, type Options, type Transaction, type RawQueryFragment } from '@mikro-orm/core';
 import type { AbstractSqlConnection } from '../AbstractSqlConnection.js';
 import type { AbstractSqlPlatform } from '../AbstractSqlPlatform.js';
-import type { CheckDef, Column, ForeignKey, IndexDef, Table, TableDifference } from '../typings.js';
+import type { CheckDef, Column, ForeignKey, IndexDef, Table, TableDifference, SqlTriggerDef } from '../typings.js';
 import type { DatabaseSchema } from './DatabaseSchema.js';
 import type { DatabaseTable } from './DatabaseTable.js';
 /** Base class for database-specific schema helpers. Provides SQL generation for DDL operations. */
@@ -41,6 +41,46 @@ export declare abstract class SchemaHelper {
      * Hook for adding driver-specific index options (e.g., fill factor for PostgreSQL).
      */
     protected getCreateIndexSuffix(_index: IndexDef): string;
+    /**
+     * Default emits ` where <predicate>` for partial indexes. Only Oracle overrides this to
+     * return `''` (it emulates partials via CASE-WHEN columns). MySQL sidesteps the whole path
+     * with its own `getCreateIndexSQL` that never calls this, and MariaDB refuses the feature
+     * entirely via an override on `getIndexColumns`.
+     */
+    protected getIndexWhereClause(index: IndexDef): string;
+    /**
+     * Wraps each indexed column in `(CASE WHEN <predicate> THEN <col> END)` for dialects that
+     * emulate partial indexes via functional indexes (MySQL/MariaDB/Oracle). Combined with NULL
+     * being treated as distinct in unique indexes, this enforces uniqueness only where the
+     * predicate holds. Throws if combined with the advanced `columns` option.
+     */
+    protected emulatePartialIndexColumns(index: IndexDef): string;
+    /**
+     * Strips `<col> IS NOT NULL` clauses (with the dialect's identifier quoting) from an
+     * introspected partial-index predicate when the column matches one of the index's own
+     * columns. MikroORM auto-emits this guard for unique indexes on nullable columns
+     * (MSSQL, Oracle) — it's an internal artifact, not user intent.
+     *
+     * Strips at most one guard per column (the tail-most occurrence), matching how MikroORM
+     * appends a single guard per index column. This preserves user intent when they redundantly
+     * include the same `<col> IS NOT NULL` in their predicate — the guard we added is removed,
+     * their copy survives.
+     */
+    protected stripAutoNotNullFilter(filterDef: string, columnNames: string[], identifierPattern: RegExp): string;
+    /**
+     * Whether `[…]` is a quoted identifier (MSSQL convention). Other dialects either reuse
+     * `[` for array literals/constructors or never produce it in introspected predicates,
+     * so the default is `false` and the MSSQL helper opts in.
+     */
+    protected get bracketQuotedIdentifiers(): boolean;
+    /**
+     * Splits on top-level ` AND ` (case-insensitive), ignoring matches that sit inside string
+     * literals, quoted identifiers, or parenthesized groups — so a predicate like
+     * `'foo AND bar' = col` or `(a AND b) OR c` is not mis-split.
+     */
+    protected splitTopLevelAnd(s: string): string[];
+    /** Returns true iff the leading `(` matches the trailing `)` (i.e. they wrap the whole string). */
+    protected isBalancedWrap(s: string): boolean;
     /**
      * Build the column list for an index, supporting advanced options like sort order, nulls ordering, and collation.
      * Note: Prefix length is only supported by MySQL/MariaDB which override this method.
@@ -84,6 +124,16 @@ export declare abstract class SchemaHelper {
     getReferencedTableName(referencedTableName: string, schema?: string): string;
     createIndex(index: IndexDef, table: DatabaseTable, createPrimary?: boolean): string;
     createCheck(table: DatabaseTable, check: CheckDef): string;
+    /**
+     * Generates SQL to create a database trigger on a table.
+     * Override in driver-specific helpers for custom DDL (e.g., PostgreSQL function wrapping).
+     */
+    createTrigger(table: DatabaseTable, trigger: SqlTriggerDef): string;
+    /**
+     * Generates SQL to drop a database trigger from a table.
+     * Override in driver-specific helpers for custom DDL.
+     */
+    dropTrigger(table: DatabaseTable, trigger: SqlTriggerDef): string;
     /** @internal */
     getTableName(table: string, schema?: string): string;
     getTablesGroupedBySchemas(tables: Table[]): Map<string | undefined, Table[]>;