@mikro-orm/sql 7.2.2-dev.6 → 7.2.2-dev.7

package/AbstractSqlDriver.d.ts

@@ -18,6 +18,10 @@ export declare abstract class AbstractSqlDriver<Connection extends AbstractSqlCo
     evaluateFormula(formula: (...args: any[]) => string | Raw, columns: any, table: FormulaTable): string;
     /** For TPT entities, returns ownProps (columns in this table); otherwise returns all props. */
     protected getTableProps<T extends object>(meta: EntityMetadata<T>): EntityProperty<T>[];
+    /** Columns reloaded by UPDATE: raw values, PKs, generated/version columns and explicit `returning` hints. */
+    protected getUpdateReturningProperties<T extends object>(meta: EntityMetadata<T>, data: EntityDictionary<T>[]): EntityProperty<T>[];
+    /** Column expression for the `returning` clause of batch updates, applying `convertToJSValueSQL` of custom types. */
+    protected getReturningFieldSQL(prop: EntityProperty, fieldName: string, index: number): string;
     /** Creates a FormulaTable object for use in formula callbacks. */
     private createFormulaTable;
     private validateSqlOptions;

package/AbstractSqlDriver.js

@@ -49,6 +49,32 @@ export class AbstractSqlDriver extends DatabaseDriver {
     getTableProps(meta) {
         return meta.inheritanceType === 'tpt' && meta.ownProps ? meta.ownProps : meta.props;
     }
+    /** Columns reloaded by UPDATE: raw values, PKs, generated/version columns and explicit `returning` hints. */
+    getUpdateReturningProperties(meta, data) {
+        const returning = new Set();
+        for (const row of data) {
+            for (const k of Utils.keys(row)) {
+                if (isRaw(row[k])) {
+                    returning.add(meta.properties[k] ?? meta.root.properties[k]);
+                }
+            }
+        }
+        meta.getPrimaryProps().forEach(prop => returning.add(prop));
+        // a mixed STI batch shares one table, so the child columns live on the root
+        this.getTableProps(meta.root.discriminatorColumn ? meta.root : meta)
+            .filter(prop => prop.generated || prop.version || prop.returning)
+            .forEach(prop => returning.add(prop));
+        return [...returning];
+    }
+    /** Column expression for the `returning` clause of batch updates, applying `convertToJSValueSQL` of custom types. */
+    getReturningFieldSQL(prop, fieldName, index) {
+        const quoted = this.platform.quoteIdentifier(fieldName);
+        const customType = prop.customTypes?.[index] ?? prop.customType;
+        if (prop.hasConvertToJSValueSQL && customType?.convertToJSValueSQL) {
+            return `${customType.convertToJSValueSQL(quoted, this.platform)} as ${quoted}`;
+        }
+        return quoted;
+    }
     /** Creates a FormulaTable object for use in formula callbacks. */
     createFormulaTable(alias, meta, schema) {
         const effectiveSchema = schema ?? (meta.schema !== '*' ? meta.schema : undefined);
@@ -946,7 +972,7 @@ export class AbstractSqlDriver extends DatabaseDriver {
                 /* v8 ignore next */
                 const uniqueFields = options.onConflictFields ??
                     (Utils.isPlainObject(where) ? Utils.keys(where) : meta.primaryKeys);
-                const returning = getOnConflictReturningFields(meta, data, uniqueFields, options);
+                const returning = getOnConflictReturningFields(meta, data, uniqueFields, options, this.platform);
                 qb.insert(data)
                     .onConflict(uniqueFields)
                     .returning(returning);
@@ -963,11 +989,10 @@ export class AbstractSqlDriver extends DatabaseDriver {
             }
             else {
                 qb.update(data).where(where);
-                // reload generated columns and version fields
                 const returning = [];
                 this.getTableProps(meta)
-                    .filter(prop => (prop.generated && !prop.primary) || prop.version)
-                    .forEach(prop => returning.push(prop.name));
+                    .filter(prop => (prop.generated && !prop.primary) || prop.version || prop.returning || isRaw(data[prop.name]))
+                    .forEach(prop => returning.push(...prop.fieldNames));
                 qb.returning(returning);
             }
             res = await this.rethrow(qb.execute('run', false));
@@ -1003,7 +1028,7 @@ export class AbstractSqlDriver extends DatabaseDriver {
                     : meta.primaryKeys);
             const qb = this.createQueryBuilder(entityName, options.ctx, 'write', options.convertCustomTypes, options.loggerContext).withSchema(this.getSchemaName(meta, options));
             qb.setAbortOptions(pickAbortOptions(options));
-            let returning = getOnConflictReturningFields(meta, data[0], uniqueFields, options);
+            let returning = getOnConflictReturningFields(meta, data[0], uniqueFields, options, this.platform);
             if (meta.inheritanceType === 'tpt') {
                 // each TPT table only carries its own columns, the entity is reloaded instead of mapping the returned rows
                 const own = (key) => meta.primaryKeys.includes(key) ||
@@ -1032,20 +1057,12 @@ export class AbstractSqlDriver extends DatabaseDriver {
         const collections = options.processCollections ? data.map(d => this.extractManyToMany(meta, d)) : [];
         const keys = new Set();
         const fields = new Set();
-        const returning = new Set();
+        const returning = this.getUpdateReturningProperties(meta, data);
         for (const row of data) {
             for (const k of Utils.keys(row)) {
                 keys.add(k);
-                if (isRaw(row[k])) {
-                    returning.add(k);
-                }
             }
         }
-        // reload generated columns and version fields
-        meta.getPrimaryProps().forEach(prop => returning.add(prop.name));
-        this.getTableProps(meta)
-            .filter(prop => prop.generated || prop.version)
-            .forEach(prop => returning.add(prop.name));
         const pkCond = Utils.flatten(meta.primaryKeys.map(pk => meta.properties[pk].fieldNames))
             .map(pk => `${this.platform.quoteIdentifier(pk)} = ?`)
             .join(' and ');
@@ -1115,7 +1132,12 @@ export class AbstractSqlDriver extends DatabaseDriver {
             }
             sql += `, `;
         }
-        sql = sql.substring(0, sql.length - 2) + ' where ';
+        sql = sql.substring(0, sql.length - 2);
+        if (this.platform.usesOutputStatement() && returning.length > 0) {
+            const fields = returning.flatMap(prop => prop.fieldNames);
+            sql += ` output ${fields.map(field => 'inserted.' + this.platform.quoteIdentifier(field)).join(', ')}`;
+        }
+        sql += ' where ';
         const pkProps = meta.primaryKeys.concat(...meta.getOwnConcurrencyCheckKeys());
         const pks = Utils.flatten(pkProps.map(pk => meta.properties[pk].fieldNames));
         const useTupleIn = pks.length <= 1 || this.platform.allowsComparingTuples();
@@ -1151,13 +1173,9 @@ export class AbstractSqlDriver extends DatabaseDriver {
         else {
             sql += conds.join(' or ');
         }
-        if (this.platform.usesReturningStatement() && returning.size > 0) {
-            const returningFields = Utils.flatten([...returning].map(prop => (meta.properties[prop] ?? meta.root.properties[prop]).fieldNames));
-            /* v8 ignore next */
-            sql +=
-                returningFields.length > 0
-                    ? ` returning ${returningFields.map(field => this.platform.quoteIdentifier(field)).join(', ')}`
-                    : '';
+        if (this.platform.usesReturningStatement() && returning.length > 0) {
+            const returningFields = returning.flatMap(prop => prop.fieldNames.map((field, idx) => this.getReturningFieldSQL(prop, field, idx)));
+            sql += ` returning ${returningFields.join(', ')}`;
         }
         if (transform) {
             sql = transform(sql, params);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/sql",
-  "version": "7.2.2-dev.6",
+  "version": "7.2.2-dev.7",
   "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",
@@ -53,7 +53,7 @@
     "@mikro-orm/core": "^7.2.1"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.2.2-dev.6"
+    "@mikro-orm/core": "7.2.2-dev.7"
   },
   "engines": {
     "node": ">= 22.17.0"

package/query/QueryBuilder.js

@@ -916,18 +916,13 @@ export class QueryBuilder {
             return;
         }
         if (this.type === QueryType.UPDATE && data) {
-            const returningProps = meta.hydrateProps.filter(prop => prop.fieldNames && isRaw(data[prop.fieldNames[0]]));
+            const returningProps = meta.hydrateProps
+                .filter(prop => prop.returning || (prop.fieldNames && isRaw(data[prop.fieldNames[0]])))
+                // a TPT table can only return its own columns
+                .filter(prop => meta.inheritanceType !== 'tpt' || prop.primary || meta.ownProps.some(p => p.name === prop.name));
             if (returningProps.length > 0) {
-                qb.returning(returningProps.flatMap((prop) => {
-                    if (prop.hasConvertToJSValueSQL) {
-                        const aliased = this.platform.quoteIdentifier(prop.fieldNames[0]);
-                        const sql = prop.customType.convertToJSValueSQL(aliased, this.platform) +
-                            ' as ' +
-                            this.platform.quoteIdentifier(prop.fieldNames[0]);
-                        return [raw(sql)];
-                    }
-                    return prop.fieldNames;
-                }));
+                const fields = returningProps.flatMap(prop => prop.fieldNames);
+                qb.returning(fields.map(field => this.helper.mapper(field, this.type)));
             }
         }
     }

package/query/QueryBuilderHelper.js

@@ -132,17 +132,10 @@ export class QueryBuilderHelper {
             }
             return raw(`${value}${as}`);
         }
-        if (prop?.hasConvertToJSValueSQL && type !== QueryType.UPSERT) {
-            let valueSQL;
-            if (prop.fieldNames.length > 1 && fkIdx !== -1) {
-                const fk = prop.targetMeta.getPrimaryProps()[fkIdx];
-                const prefixed = this.prefix(field, isTableNameAliasRequired, true, fkIdx);
-                valueSQL = fk.customType.convertToJSValueSQL(prefixed, this.#platform);
-            }
-            else {
-                const prefixed = this.prefix(field, isTableNameAliasRequired, true);
-                valueSQL = prop.customType.convertToJSValueSQL(prefixed, this.#platform);
-            }
+        const customType = prop?.customTypes?.[fkIdx] ?? prop?.customType;
+        if (prop?.hasConvertToJSValueSQL && customType?.convertToJSValueSQL && type !== QueryType.UPSERT) {
+            const prefixed = this.prefix(field, isTableNameAliasRequired, true, fkIdx);
+            const valueSQL = customType.convertToJSValueSQL(prefixed, this.#platform);
             if (alias === null) {
                 return raw(valueSQL);
             }