@mikro-orm/knex 5.7.8-dev.3 → 5.7.8-dev.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/knex",
-  "version": "5.7.8-dev.3",
+  "version": "5.7.8-dev.4",
   "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,9 +66,9 @@
     "@mikro-orm/core": "^5.7.7"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "~5.7.8-dev.3",
-    "@mikro-orm/entity-generator": "~5.7.8-dev.3",
-    "@mikro-orm/migrations": "~5.7.8-dev.3",
+    "@mikro-orm/core": "~5.7.8-dev.4",
+    "@mikro-orm/entity-generator": "~5.7.8-dev.4",
+    "@mikro-orm/migrations": "~5.7.8-dev.4",
     "better-sqlite3": "*",
     "mssql": "*",
     "mysql": "*",

package/query/QueryBuilder.d.ts

@@ -58,6 +58,7 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
     private _orderBy;
     private _groupBy;
     private _having;
+    private _returning?;
     private _onConflict?;
     private _limit?;
     private _offset?;
@@ -107,6 +108,7 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
     onConflict(fields?: Field<T> | Field<T>[]): this;
     ignore(): this;
     merge(data?: EntityData<T> | Field<T>[]): this;
+    returning(fields?: Field<T> | Field<T>[]): this;
     /**
      * @internal
      */

package/query/QueryBuilder.js

@@ -266,6 +266,10 @@ class QueryBuilder {
         this._onConflict[this._onConflict.length - 1].merge = data;
         return this;
     }
+    returning(fields) {
+        this._returning = fields != null ? core_1.Utils.asArray(fields) : fields;
+        return this;
+    }
     /**
      * @internal
      */
@@ -377,7 +381,7 @@ class QueryBuilder {
         if (this.lockMode) {
             this.helper.getLockSQL(qb, this.lockMode, this.lockTables);
         }
-        this.helper.finalize(this.type ?? enums_1.QueryType.SELECT, qb, this.mainAlias.metadata);
+        this.helper.finalize(this.type ?? enums_1.QueryType.SELECT, qb, this.mainAlias.metadata, this._data, this._returning);
         return qb;
     }
     /**
@@ -565,7 +569,7 @@ class QueryBuilder {
         // clone array/object properties
         const properties = [
             'flags', '_populate', '_populateWhere', '_populateMap', '_joins', '_joinedProps', '_cond', '_data', '_orderBy',
-            '_schema', '_indexHint', '_cache', 'subQueries', 'lockMode', 'lockTables', '_groupBy', '_having',
+            '_schema', '_indexHint', '_cache', 'subQueries', 'lockMode', 'lockTables', '_groupBy', '_having', '_returning',
         ];
         properties.forEach(prop => qb[prop] = core_1.Utils.copy(this[prop]));
         /* istanbul ignore else */

package/query/QueryBuilderHelper.d.ts

@@ -48,7 +48,7 @@ export declare class QueryBuilderHelper {
     private getOperatorReplacement;
     getQueryOrder(type: QueryType, orderBy: FlatQueryOrderMap | FlatQueryOrderMap[], populate: Dictionary<string>): string;
     getQueryOrderFromObject(type: QueryType, orderBy: FlatQueryOrderMap, populate: Dictionary<string>): string;
-    finalize(type: QueryType, qb: Knex.QueryBuilder, meta?: EntityMetadata): void;
+    finalize(type: QueryType, qb: Knex.QueryBuilder, meta?: EntityMetadata, data?: Dictionary, returning?: Field<any>[]): void;
     splitField(field: string, greedyAlias?: boolean): [string, string];
     getLockSQL(qb: Knex.QueryBuilder, lockMode: LockMode, lockTables?: string[]): void;
     updateVersionProperty(qb: Knex.QueryBuilder, data: Dictionary): void;

package/query/QueryBuilderHelper.js

@@ -460,11 +460,22 @@ class QueryBuilderHelper {
         });
         return ret.join(', ');
     }
-    finalize(type, qb, meta) {
-        const useReturningStatement = type === enums_1.QueryType.INSERT && this.platform.usesReturningStatement() && meta && !meta.compositePK;
-        if (useReturningStatement) {
-            const returningProps = meta.hydrateProps.filter(prop => prop.persist !== false && (prop.primary || prop.defaultRaw));
-            qb.returning(core_1.Utils.flatten(returningProps.map(prop => prop.fieldNames)));
+    finalize(type, qb, meta, data, returning) {
+        if (!meta || !data || !this.platform.usesReturningStatement()) {
+            return;
+        }
+        // always respect explicit returning hint
+        if (returning && returning.length > 0) {
+            qb.returning(returning.map(field => this.mapper(field, type)));
+            return;
+        }
+        if (type === enums_1.QueryType.INSERT) {
+            const returningProps = meta.hydrateProps
+                .filter(prop => prop.returning || (prop.persist !== false && ((prop.primary && prop.autoincrement) || prop.defaultRaw)))
+                .filter(prop => !(prop.name in data));
+            if (returningProps.length > 0) {
+                qb.returning(core_1.Utils.flatten(returningProps.map(prop => prop.fieldNames)));
+            }
         }
     }
     splitField(field, greedyAlias = false) {