@mikro-orm/knex 6.0.0-dev.121 → 6.0.0-dev.123

package/AbstractSqlDriver.js

@@ -333,7 +333,7 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
         }
         if (meta && this.platform.usesReturningStatement()) {
             const returningProps = meta.props
-                .filter(prop => prop.persist !== false && ((prop.primary && prop.autoincrement) || prop.defaultRaw || prop.autoincrement))
+                .filter(prop => prop.persist !== false && prop.defaultRaw || prop.autoincrement || prop.generated)
                 .filter(prop => !(prop.name in data[0]) || core_1.Utils.isRawSql(data[0][prop.name]));
             const returningFields = core_1.Utils.flatten(returningProps.map(prop => prop.fieldNames));
             /* istanbul ignore next */
@@ -386,6 +386,12 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
             }
             else {
                 qb.update(data).where(where);
+                // reload generated columns
+                const returning = [];
+                meta?.props
+                    .filter(prop => prop.generated && !prop.primary)
+                    .forEach(prop => returning.push(prop.name));
+                qb.returning(returning);
             }
             res = await this.rethrow(qb.execute('run', false));
         }
@@ -425,6 +431,10 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
                 }
             });
         });
+        // reload generated columns
+        meta?.props
+            .filter(prop => prop.generated && !prop.primary)
+            .forEach(prop => returning.add(prop.name));
         const pkCond = core_1.Utils.flatten(meta.primaryKeys.map(pk => meta.properties[pk].fieldNames)).map(pk => `${this.platform.quoteIdentifier(pk)} = ?`).join(' and ');
         const params = [];
         let sql = `update ${this.getTableName(meta, options)} set `;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/knex",
-  "version": "6.0.0-dev.121",
+  "version": "6.0.0-dev.123",
   "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.",
   "main": "index.js",
   "module": "index.mjs",
@@ -66,6 +66,6 @@
     "@mikro-orm/core": "^5.9.0"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "6.0.0-dev.121"
+    "@mikro-orm/core": "6.0.0-dev.123"
   }
 }

package/query/QueryBuilder.d.ts

@@ -99,9 +99,9 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
     join(field: string | Knex.QueryBuilder | QueryBuilder<any>, alias: string, cond?: QBFilterQuery, type?: 'leftJoin' | 'innerJoin' | 'pivotJoin', path?: string, schema?: string): this;
     innerJoin(field: string | Knex.QueryBuilder | QueryBuilder<any>, alias: string, cond?: QBFilterQuery, schema?: string): this;
     leftJoin(field: string | Knex.QueryBuilder | QueryBuilder<any>, alias: string, cond?: QBFilterQuery, schema?: string): this;
-    joinAndSelect(field: string | [field: string, Knex.QueryBuilder | QueryBuilder<any>], alias: string, cond?: QBFilterQuery, type?: 'leftJoin' | 'innerJoin' | 'pivotJoin', path?: string, fields?: string[], schema?: string): SelectQueryBuilder<T>;
-    leftJoinAndSelect(field: string | [field: string, Knex.QueryBuilder | QueryBuilder<any>], alias: string, cond?: QBFilterQuery, fields?: string[], schema?: string): SelectQueryBuilder<T>;
-    innerJoinAndSelect(field: string | [field: string, Knex.QueryBuilder | QueryBuilder<any>], alias: string, cond?: QBFilterQuery, fields?: string[], schema?: string): SelectQueryBuilder<T>;
+    joinAndSelect(field: string | [field: string, qb: Knex.QueryBuilder | QueryBuilder<any>], alias: string, cond?: QBFilterQuery, type?: 'leftJoin' | 'innerJoin' | 'pivotJoin', path?: string, fields?: string[], schema?: string): SelectQueryBuilder<T>;
+    leftJoinAndSelect(field: string | [field: string, qb: Knex.QueryBuilder | QueryBuilder<any>], alias: string, cond?: QBFilterQuery, fields?: string[], schema?: string): SelectQueryBuilder<T>;
+    innerJoinAndSelect(field: string | [field: string, qb: Knex.QueryBuilder | QueryBuilder<any>], alias: string, cond?: QBFilterQuery, fields?: string[], schema?: string): SelectQueryBuilder<T>;
     protected getFieldsForJoinedLoad(prop: EntityProperty<T>, alias: string, explicitFields?: string[]): Field<T>[];
     withSubQuery(subQuery: Knex.QueryBuilder, alias: string): this;
     where(cond: QBFilterQuery<T>, operator?: keyof typeof GroupOperator): this;

package/schema/DatabaseTable.js

@@ -83,6 +83,7 @@ class DatabaseTable {
             this.columns[field] = {
                 name: prop.fieldNames[idx],
                 type: prop.columnTypes[idx],
+                generated: prop.generated,
                 mappedType,
                 unsigned: prop.unsigned && this.platform.isNumericColumn(mappedType),
                 autoincrement: prop.autoincrement ?? primary,

package/schema/SchemaComparator.d.ts

@@ -1,4 +1,4 @@
-import type { CheckDef, Column, ForeignKey, IndexDef, SchemaDifference, TableDifference } from '../typings';
+import type { Column, ForeignKey, IndexDef, SchemaDifference, TableDifference } from '../typings';
 import type { DatabaseSchema } from './DatabaseSchema';
 import type { DatabaseTable } from './DatabaseTable';
 import type { AbstractSqlPlatform } from '../AbstractSqlPlatform';
@@ -38,7 +38,7 @@ export declare class SchemaComparator {
      * Returns the difference between the columns
      * If there are differences this method returns field2, otherwise the boolean false.
      */
-    diffColumn(column1: Column, column2: Column, tableName?: string): Set<string>;
+    diffColumn(fromColumn: Column, toColumn: Column, tableName?: string): Set<string>;
     diffEnumItems(items1?: string[], items2?: string[]): boolean;
     diffComment(comment1?: string, comment2?: string): boolean;
     /**
@@ -50,7 +50,7 @@ export declare class SchemaComparator {
      * Checks if the other index already fulfills all the indexing and constraint needs of the current one.
      */
     isIndexFulfilledBy(index1: IndexDef, index2: IndexDef): boolean;
-    diffCheck(check1: CheckDef, check2: CheckDef): boolean;
+    diffExpression(expr1: string, expr2: string): boolean;
     hasSameDefaultValue(from: Column, to: Column): boolean;
     private mapColumnToProperty;
     private log;

package/schema/SchemaComparator.js

@@ -142,6 +142,12 @@ class SchemaComparator {
             if (changedProperties.size === 0) {
                 continue;
             }
+            if (changedProperties.size === 1 && changedProperties.has('generated')) {
+                tableDifferences.addedColumns[column.name] = toTable.getColumn(column.name);
+                tableDifferences.removedColumns[column.name] = column;
+                changes++;
+                continue;
+            }
             tableDifferences.changedColumns[column.name] = {
                 oldColumnName: column.name,
                 fromColumn: column,
@@ -203,7 +209,7 @@ class SchemaComparator {
             }
             // See if index has changed in "to" table
             const toTableCheck = toTable.getCheck(check.name);
-            if (!this.diffCheck(check, toTableCheck)) {
+            if (!this.diffExpression(check.expression, toTableCheck.expression)) {
                 continue;
             }
             this.log(`check constraint ${check.name} changed in table ${tableDifferences.name}`, { fromTableCheck: check, toTableCheck });
@@ -327,12 +333,12 @@ class SchemaComparator {
      * Returns the difference between the columns
      * If there are differences this method returns field2, otherwise the boolean false.
      */
-    diffColumn(column1, column2, tableName) {
+    diffColumn(fromColumn, toColumn, tableName) {
         const changedProperties = new Set();
-        const prop1 = this.mapColumnToProperty({ ...column1, autoincrement: false });
-        const prop2 = this.mapColumnToProperty({ ...column2, autoincrement: false });
-        const columnType1 = column1.mappedType.getColumnType(prop1, this.platform).toLowerCase();
-        const columnType2 = column2.mappedType.getColumnType(prop2, this.platform).toLowerCase();
+        const fromProp = this.mapColumnToProperty({ ...fromColumn, autoincrement: false });
+        const toProp = this.mapColumnToProperty({ ...toColumn, autoincrement: false });
+        const fromColumnType = fromColumn.mappedType.getColumnType(fromProp, this.platform).toLowerCase();
+        const toColumnType = toColumn.mappedType.getColumnType(toProp, this.platform).toLowerCase();
         const log = (msg, params) => {
             if (tableName) {
                 const copy = core_1.Utils.copy(params);
@@ -340,42 +346,46 @@ class SchemaComparator {
                 this.log(msg, copy);
             }
         };
-        if (columnType1 !== columnType2 &&
-            !(column1.ignoreSchemaChanges?.includes('type') ||
-                column2.ignoreSchemaChanges?.includes('type'))) {
-            log(`'type' changed for column ${tableName}.${column1.name}`, { columnType1, columnType2 });
+        if (fromColumnType !== toColumnType &&
+            !(fromColumn.ignoreSchemaChanges?.includes('type') ||
+                toColumn.ignoreSchemaChanges?.includes('type'))) {
+            log(`'type' changed for column ${tableName}.${fromColumn.name}`, { fromColumnType, toColumnType });
             changedProperties.add('type');
         }
-        if (column1.nullable !== column2.nullable) {
-            log(`'nullable' changed for column ${tableName}.${column1.name}`, { column1, column2 });
+        if (fromColumn.nullable !== toColumn.nullable && !fromColumn.generated && !toColumn.generated) {
+            log(`'nullable' changed for column ${tableName}.${fromColumn.name}`, { fromColumn, toColumn });
             changedProperties.add('nullable');
         }
-        if (!!column1.autoincrement !== !!column2.autoincrement) {
-            log(`'autoincrement' changed for column ${tableName}.${column1.name}`, { column1, column2 });
+        if (this.diffExpression(fromColumn.generated, toColumn.generated)) {
+            log(`'generated' changed for column ${tableName}.${fromColumn.name}`, { fromColumn, toColumn });
+            changedProperties.add('generated');
+        }
+        if (!!fromColumn.autoincrement !== !!toColumn.autoincrement) {
+            log(`'autoincrement' changed for column ${tableName}.${fromColumn.name}`, { fromColumn, toColumn });
             changedProperties.add('autoincrement');
         }
-        if (column1.unsigned !== column2.unsigned && this.platform.supportsUnsigned()) {
-            log(`'unsigned' changed for column ${tableName}.${column1.name}`, { column1, column2 });
+        if (fromColumn.unsigned !== toColumn.unsigned && this.platform.supportsUnsigned()) {
+            log(`'unsigned' changed for column ${tableName}.${fromColumn.name}`, { fromColumn, toColumn });
             changedProperties.add('unsigned');
         }
-        if (!this.hasSameDefaultValue(column1, column2)) {
-            log(`'default' changed for column ${tableName}.${column1.name}`, { column1, column2 });
+        if (!this.hasSameDefaultValue(fromColumn, toColumn)) {
+            log(`'default' changed for column ${tableName}.${fromColumn.name}`, { fromColumn, toColumn });
             changedProperties.add('default');
         }
-        if (this.diffComment(column1.comment, column2.comment)) {
-            log(`'comment' changed for column ${tableName}.${column1.name}`, { column1, column2 });
+        if (this.diffComment(fromColumn.comment, toColumn.comment)) {
+            log(`'comment' changed for column ${tableName}.${fromColumn.name}`, { fromColumn, toColumn });
             changedProperties.add('comment');
         }
-        if (!(column1.mappedType instanceof core_1.ArrayType) &&
-            !(column2.mappedType instanceof core_1.ArrayType) &&
-            this.diffEnumItems(column1.enumItems, column2.enumItems)) {
-            log(`'enumItems' changed for column ${tableName}.${column1.name}`, { column1, column2 });
+        if (!(fromColumn.mappedType instanceof core_1.ArrayType) &&
+            !(toColumn.mappedType instanceof core_1.ArrayType) &&
+            this.diffEnumItems(fromColumn.enumItems, toColumn.enumItems)) {
+            log(`'enumItems' changed for column ${tableName}.${fromColumn.name}`, { fromColumn, toColumn });
             changedProperties.add('enumItems');
         }
-        if ((column1.extra || '').toLowerCase() !== (column2.extra || '').toLowerCase() &&
-            !(column1.ignoreSchemaChanges?.includes('extra') ||
-                column2.ignoreSchemaChanges?.includes('extra'))) {
-            log(`'extra' changed for column ${tableName}.${column1.name}`, { column1, column2 });
+        if ((fromColumn.extra || '').toLowerCase() !== (toColumn.extra || '').toLowerCase() &&
+            !(fromColumn.ignoreSchemaChanges?.includes('extra') ||
+                toColumn.ignoreSchemaChanges?.includes('extra'))) {
+            log(`'extra' changed for column ${tableName}.${fromColumn.name}`, { fromColumn, toColumn });
             changedProperties.add('extra');
         }
         return changedProperties;
@@ -429,11 +439,11 @@ class SchemaComparator {
         }
         return index1.primary === index2.primary && index1.unique === index2.unique;
     }
-    diffCheck(check1, check2) {
-        // check constraint definition might be normalized by the driver,
+    diffExpression(expr1, expr2) {
+        // expressions like check constraints might be normalized by the driver,
         // e.g. quotes might be added (https://github.com/mikro-orm/mikro-orm/issues/3827)
-        const simplify = (str) => str?.replace(/['"`()]/g, '').toLowerCase();
-        return simplify(check1.expression) !== simplify(check2.expression);
+        const simplify = (str) => str?.replace(/_\w+\\'(.*?)\\'/g, '$1').replace(/['"`()]|::\w+| +/g, '').toLowerCase();
+        return simplify(expr1) !== simplify(expr2);
     }
     hasSameDefaultValue(from, to) {
         if (from.default == null || from.default.toString().toLowerCase() === 'null' || from.default.toString().startsWith('nextval(')) {

package/schema/SchemaHelper.js

@@ -102,7 +102,7 @@ class SchemaHelper {
     }
     createTableColumn(table, column, fromTable, changedProperties) {
         const compositePK = fromTable.getPrimaryKey()?.composite;
-        if (column.autoincrement && !compositePK && (!changedProperties || changedProperties.has('autoincrement') || changedProperties.has('type'))) {
+        if (column.autoincrement && !column.generated && !compositePK && (!changedProperties || changedProperties.has('autoincrement') || changedProperties.has('type'))) {
             const primaryKey = !changedProperties && !this.hasNonDefaultPrimaryKeyName(fromTable);
             if (column.mappedType instanceof core_1.BigIntType) {
                 return table.bigIncrements(column.name, { primaryKey });
@@ -112,12 +112,16 @@ class SchemaHelper {
         if (column.mappedType instanceof core_1.EnumType && column.enumItems?.every(item => core_1.Utils.isString(item))) {
             return table.enum(column.name, column.enumItems);
         }
-        return table.specificType(column.name, column.type);
+        let columnType = column.type;
+        if (column.generated) {
+            columnType += ` generated always as ${column.generated}`;
+        }
+        return table.specificType(column.name, columnType);
     }
     configureColumn(column, col, knex, changedProperties) {
         const guard = (key) => !changedProperties || changedProperties.has(key);
         core_1.Utils.runIfNotEmpty(() => col.nullable(), column.nullable && guard('nullable'));
-        core_1.Utils.runIfNotEmpty(() => col.notNullable(), !column.nullable);
+        core_1.Utils.runIfNotEmpty(() => col.notNullable(), !column.nullable && !column.generated);
         core_1.Utils.runIfNotEmpty(() => col.unsigned(), column.unsigned);
         core_1.Utils.runIfNotEmpty(() => col.comment(column.comment), column.comment);
         this.configureColumnDefault(column, col, knex, changedProperties);

package/schema/SqlSchemaGenerator.js

@@ -282,6 +282,14 @@ class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
             for (const check of Object.values(diff.changedChecks)) {
                 this.dropCheck(table, check);
             }
+            /* istanbul ignore else */
+            if (!safe) {
+                for (const column of Object.values(diff.removedColumns)) {
+                    this.helper.pushTableQuery(table, `alter table ${this.platform.quoteIdentifier(tableName)} drop column ${this.platform.quoteIdentifier(column.name)}`);
+                }
+            }
+        }));
+        ret.push(this.createSchemaBuilder(schemaName).alterTable(tableName, table => {
             for (const column of Object.values(diff.addedColumns)) {
                 const col = this.helper.createTableColumn(table, column, diff.fromTable);
                 this.helper.configureColumn(column, col, this.knex);
@@ -295,12 +303,6 @@ class SqlSchemaGenerator extends core_1.AbstractSchemaGenerator {
                         .onDelete(foreignKey.deleteRule);
                 }
             }
-            /* istanbul ignore else */
-            if (!safe) {
-                for (const column of Object.values(diff.removedColumns)) {
-                    table.dropColumn(column.name);
-                }
-            }
             for (const { column, changedProperties } of Object.values(diff.changedColumns)) {
                 if (changedProperties.size === 1 && changedProperties.has('comment')) {
                     continue;

package/typings.d.ts

@@ -40,6 +40,7 @@ export interface Column {
     scale?: number;
     default?: string | null;
     comment?: string;
+    generated?: string;
     nativeEnumName?: string;
     enumItems?: string[];
     primary?: boolean;