@mikro-orm/core 7.2.2-dev.2 → 7.2.2-dev.20

package/EntityManager.d.ts

@@ -580,6 +580,11 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
      * Checks whether this EntityManager is currently operating inside a database transaction.
      */
     isInTransaction(): boolean;
+    /**
+     * Checks whether transactions are disabled for this EntityManager.
+     * @internal
+     */
+    isTransactionDisabled(): boolean;
     /**
      * Gets the transaction context (driver dependent object used to make sure queries are executed on same connection).
      */
@@ -633,7 +638,7 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
     /**
      * @internal
      */
-    tryCache<T extends object, R>(entityName: EntityName<T>, config: boolean | number | [string, number] | undefined, key: unknown, refresh?: boolean, merge?: boolean): Promise<{
+    tryCache<T extends object, R>(entityName: EntityName<T>, config: boolean | number | [string, number] | undefined, key: unknown, refresh?: boolean, merge?: boolean, schema?: string): Promise<{
         data?: R | null;
         key: string;
     } | undefined>;

package/EntityManager.js

@@ -133,7 +133,7 @@ export class EntityManager {
         options.populate = (await em.preparePopulate(entityName, options));
         const populate = options.populate;
         const cacheKey = em.cacheKey(entityName, options, 'em.find', where);
-        const cached = await em.tryCache(entityName, options.cache, cacheKey, options.refresh, true);
+        const cached = await em.tryCache(entityName, options.cache, cacheKey, options.refresh, true, options.schema);
         if (cached?.data) {
             await em.#entityLoader.populate(entityName, cached.data, populate, {
                 ...options,
@@ -834,7 +834,7 @@ export class EntityManager {
         validateParams(where);
         options.populate = (await em.preparePopulate(entityName, options));
         const cacheKey = em.cacheKey(entityName, options, 'em.findOne', where);
-        const cached = await em.tryCache(entityName, options.cache, cacheKey, options.refresh, true);
+        const cached = await em.tryCache(entityName, options.cache, cacheKey, options.refresh, true, options.schema);
         if (cached?.data !== undefined) {
             if (cached.data) {
                 await em.#entityLoader.populate(entityName, [cached.data], options.populate, {
@@ -994,10 +994,14 @@ export class EntityManager {
         });
         const uniqueFields = options.onConflictFields ??
             (Utils.isPlainObject(where) ? Object.keys(where) : meta.primaryKeys);
-        const returning = getOnConflictReturningFields(meta, data, uniqueFields, options);
+        const platform = this.getPlatform();
+        const returning = getOnConflictReturningFields(meta, data, uniqueFields, options, platform);
+        if (options.onConflictWhere && !ret.row) {
+            returning.push(...Object.keys(data));
+        }
         if (options.onConflictAction === 'ignore' ||
             !helper(entity).hasPrimaryKey() ||
-            (returning.length > 0 && !(this.getPlatform().usesReturningStatement() && ret.row))) {
+            (returning.length > 0 && !((platform.usesReturningStatement() || platform.usesOutputStatement()) && ret.row))) {
             const where = {};
             if (Array.isArray(uniqueFields)) {
                 for (const prop of uniqueFields) {
@@ -1088,6 +1092,41 @@ export class EntityManager {
             }
             return ret;
         }
+        // merge fields are derived from the first row, rows of a different shape need their own statement
+        if (!options.onConflictMergeFields && options.onConflictAction !== 'ignore') {
+            const pks = this.metadata.get(entityName).primaryKeys;
+            const shapes = new Map();
+            data.forEach((row, i) => {
+                // entity instances carry their unset properties as `undefined` keys, while in plain rows those are merged as `null`
+                const shape = Object.keys(row)
+                    .filter(key => !pks.includes(key) && !(Utils.isEntity(row) && row[key] === undefined))
+                    .sort()
+                    .join();
+                const idx = shapes.get(shape) ?? [];
+                shapes.set(shape, idx);
+                idx.push(i);
+            });
+            if (shapes.size > 1) {
+                const ret = [];
+                for (const idx of shapes.values()) {
+                    const res = await this.upsertMany(entityName, idx.map(i => data[i]), options);
+                    const seen = new Set();
+                    let j = 0;
+                    // `res` holds every entity once, so skip the rows resolving to an entity an earlier row already took
+                    for (const i of idx) {
+                        const row = data[i];
+                        const entity = Utils.isEntity(row)
+                            ? row
+                            : em.#unitOfWork.tryGetById(entityName, row, options.schema, false);
+                        if (!seen.has(entity)) {
+                            seen.add((ret[i] = res[j++]));
+                        }
+                    }
+                }
+                // rows resolving to the same entity are returned once, as in the single statement path
+                return [...new Set(ret.filter(entity => entity))];
+            }
+        }
         // the rows are replaced with their processed copies below, keep the caller's array intact
         data = [...data];
         const meta = this.metadata.get(entityName);
@@ -1095,9 +1134,10 @@ export class EntityManager {
         const generatedFields = new Set();
         const allData = [];
         const allWhere = [];
+        const dataIndexes = [];
+        const result = [];
         const entities = new Map();
         const entitiesByData = new Map();
-        const entitiesByAllDataIdx = new Map();
         for (let i = 0; i < data.length; i++) {
             let row = data[i];
             let where;
@@ -1105,14 +1145,12 @@ export class EntityManager {
                 const entity = row;
                 if (helper(entity).__managed && helper(entity).__em === em && !this.config.get('upsertManaged')) {
                     em.#entityFactory.mergeData(meta, entity, row, { initialized: true });
-                    entities.set(entity, row);
-                    entitiesByData.set(row, entity);
+                    result[i] = entity;
                     continue;
                 }
                 where = helper(entity).getPrimaryKey();
                 getOnCreateGeneratedFields(meta, entity).forEach(field => generatedFields.add(field));
                 em.#entityFactory.assignDefaultValues(entity, meta);
-                entitiesByAllDataIdx.set(allData.length, entity);
                 row = em.#comparator.prepareEntity(entity);
             }
             else {
@@ -1122,8 +1160,7 @@ export class EntityManager {
                     const exists = em.#unitOfWork.getById(entityName, where, options.schema);
                     if (exists) {
                         em.assign(exists, row);
-                        entities.set(exists, row);
-                        entitiesByData.set(row, exists);
+                        result[i] = exists;
                         continue;
                     }
                 }
@@ -1156,22 +1193,25 @@ export class EntityManager {
             validateParams(row, 'insert data');
             allData.push(row);
             allWhere.push(where);
+            dataIndexes.push(i);
         }
-        if (entities.size === data.length) {
-            return [...entities.keys()];
+        if (allData.length === 0) {
+            return [...new Set(result)];
         }
         // `onCreate` generated values are for the insert clause only, they must not overwrite existing rows
         if (generatedFields.size > 0 && !options.onConflictMergeFields) {
             options.onConflictExcludeFields = [...(options.onConflictExcludeFields ?? []), ...generatedFields];
         }
         if (em.eventManager.hasListeners(EventType.beforeUpsert, meta)) {
-            for (const dto of data) {
-                const entity = entitiesByData.get(dto) ?? dto;
+            for (const index of dataIndexes) {
+                const entity = data[index];
                 await em.eventManager.dispatchEvent(EventType.beforeUpsert, { entity, em, meta }, meta);
             }
-            for (const [idx, entity] of entitiesByAllDataIdx) {
-                allData[idx] = em.#comparator.prepareEntity(entity);
-            }
+            dataIndexes.forEach((index, idx) => {
+                if (Utils.isEntity(data[index])) {
+                    allData[idx] = em.#comparator.prepareEntity(data[index]);
+                }
+            });
         }
         const res = await em.withSessionContext(options.ctx ?? em.#transactionContext, ctx => em.driver.nativeUpdateMany(entityName, allWhere, allData, {
             upsert: true,
@@ -1179,15 +1219,16 @@ export class EntityManager {
             ...options,
             ctx,
         }));
-        entities.clear();
-        entitiesByData.clear();
         const loadPK = new Map();
         allData.forEach((row, i) => {
-            em.#unitOfWork
-                .getChangeSetPersister()
-                .mapReturnedValues(Utils.isEntity(data[i]) ? data[i] : null, Utils.isEntity(data[i]) ? {} : data[i], res.rows?.[i], meta, true);
-            const entity = Utils.isEntity(data[i])
-                ? data[i]
+            // Managed inputs skipped by the SQL batch still occupy positions in `data`.
+            const index = dataIndexes[i];
+            const item = data[index];
+            em.#unitOfWork.getChangeSetPersister().mapReturnedValues(Utils.isEntity(item) ? item : null, Utils.isEntity(item) ? {} : item, 
+            // A suppressed conflict omits its row; positional mapping would hydrate a different entity.
+            res.rows?.length === allData.length ? res.rows[i] : undefined, meta, true);
+            const entity = Utils.isEntity(item)
+                ? item
                 : em.#entityFactory.create(entityName, row, {
                     refresh: true,
                     initialized: true,
@@ -1198,13 +1239,19 @@ export class EntityManager {
             }
             entities.set(entity, row);
             entitiesByData.set(row, entity);
+            result[index] = entity;
         });
         // skip the reload only when RETURNING brought back a row for every input
         // (onConflictWhere can suppress writes, leaving some rows out)
         // oxfmt-ignore
         const uniqueFields = options.onConflictFields ?? (Utils.isPlainObject(allWhere[0]) ? Object.keys(allWhere[0]).flatMap(key => Utils.splitPrimaryKeys(key)) : meta.primaryKeys);
-        const returning = getOnConflictReturningFields(meta, data[0], uniqueFields, options);
-        const reloadFields = returning.length > 0 && !(this.getPlatform().usesReturningStatement() && res.rows?.length === data.length);
+        const platform = this.getPlatform();
+        const returning = getOnConflictReturningFields(meta, data[dataIndexes[0]], uniqueFields, options, platform);
+        if (options.onConflictWhere && res.rows?.length !== allData.length) {
+            returning.push(...meta.comparableProps.filter(p => !p.lazy && !p.embeddable).map(p => p.name));
+        }
+        const reloadFields = returning.length > 0 &&
+            !((platform.usesReturningStatement() || platform.usesOutputStatement()) && res.rows?.length === allData.length);
         if (options.onConflictAction === 'ignore' || (!res.rows?.length && loadPK.size > 0) || reloadFields) {
             const unique = meta.hydrateProps.filter(p => !p.lazy).map(p => p.name);
             const add = new Set(propIndex !== false && propIndex >= 0
@@ -1214,7 +1261,8 @@ export class EntityManager {
                 Utils.keys(cond).forEach(key => add.add(key));
             }
             const where = { $or: [] };
-            data.forEach((item, idx) => {
+            dataIndexes.forEach((index, idx) => {
+                const item = data[index];
                 where.$or[idx] = {};
                 const props = Array.isArray(uniqueFields) ? uniqueFields : Object.keys(item);
                 props.forEach(prop => {
@@ -1235,8 +1283,9 @@ export class EntityManager {
                 const row = data2.find(row => {
                     const tmp = {};
                     add.forEach(k => {
-                        if (!meta.properties[k]?.primary) {
-                            tmp[k] = row[k];
+                        const prop = meta.properties[k];
+                        if (!prop?.primary) {
+                            tmp[k] = prop?.customType ? prop.customType.convertToDatabaseValue(row[k], this.getPlatform()) : row[k];
                         }
                     });
                     return this.#comparator.matching(entityName, cond, tmp);
@@ -1283,7 +1332,7 @@ export class EntityManager {
                 await em.eventManager.dispatchEvent(EventType.afterUpsert, { entity, em, meta }, meta);
             }
         }
-        return [...entities.keys()];
+        return [...new Set(result)];
     }
     /**
      * Runs your callback wrapped inside a database transaction.
@@ -1940,6 +1989,13 @@ export class EntityManager {
     isInTransaction() {
         return !!this.getContext(false).#transactionContext;
     }
+    /**
+     * Checks whether transactions are disabled for this EntityManager.
+     * @internal
+     */
+    isTransactionDisabled() {
+        return !!this.getContext(false).#disableTransactions;
+    }
     /**
      * Gets the transaction context (driver dependent object used to make sure queries are executed on same connection).
      */
@@ -2295,7 +2351,7 @@ export class EntityManager {
     /**
      * @internal
      */
-    async tryCache(entityName, config, key, refresh, merge) {
+    async tryCache(entityName, config, key, refresh, merge, schema) {
         config ??= this.config.get('resultCache').global;
         if (!config) {
             return undefined;
@@ -2317,6 +2373,7 @@ export class EntityManager {
             merge: true,
             convertCustomTypes: false,
             refresh,
+            schema,
             recomputeSnapshot: true,
         };
         if (Array.isArray(cached) && merge) {

package/entity/defineEntity.d.ts

@@ -267,7 +267,7 @@ export declare class UniversalPropertyOptionsBuilder<in out Value, in out Option
         autoincrement: false;
     }, IncludeKeys>, IncludeKeys>;
     /**
-     * Add the property to the `returning` statement.
+     * Add the property to the `returning` clause of inserts, updates and upserts, reloading the database value into the entity.
      */
     returning(returning?: boolean): Pick<UniversalPropertyOptionsBuilder<Value, Options, IncludeKeys>, IncludeKeys>;
     /**

package/entity/defineEntity.js

@@ -88,7 +88,7 @@ export class UniversalPropertyOptionsBuilder {
         return this.assignOptions({ autoincrement });
     }
     /**
-     * Add the property to the `returning` statement.
+     * Add the property to the `returning` clause of inserts, updates and upserts, reloading the database value into the entity.
      */
     returning(returning = true) {
         return this.assignOptions({ returning });

package/metadata/MetadataDiscovery.d.ts

@@ -128,6 +128,8 @@ export declare class MetadataDiscovery {
     private initRelation;
     /** Resolves the `through` option of a virtual to-one relation into a read-only formula property. */
     private initThroughRelation;
+    /** `returning` is only honoured for physical columns that can be hydrated back into the entity. */
+    private initReturning;
     private initColumnType;
     private getMappedType;
     private getPrefix;

package/metadata/MetadataDiscovery.js

@@ -174,6 +174,7 @@ export class MetadataDiscovery {
             this.initRelation(p);
             this.initThroughRelation(m, p);
             this.initColumnType(p);
+            this.initReturning(p);
         });
         forEachProp((m, p) => this.initIndexes(m, p));
         filtered.forEach(meta => this.autoWireBidirectionalProperties(meta));
@@ -2129,6 +2130,16 @@ export class MetadataDiscovery {
         prop.persist = false;
         prop.formula = columns => this.#platform.getThroughRelationFormula(prop, columns);
     }
+    /** `returning` is only honoured for physical columns that can be hydrated back into the entity. */
+    initReturning(prop) {
+        const owning = prop.kind === ReferenceKind.SCALAR ||
+            prop.kind === ReferenceKind.MANY_TO_ONE ||
+            (prop.kind === ReferenceKind.ONE_TO_ONE && prop.owner) ||
+            (prop.kind === ReferenceKind.EMBEDDED && prop.object);
+        if (prop.returning && (!owning || prop.persist === false || prop.hydrate === false || prop.formula)) {
+            prop.returning = false;
+        }
+    }
     initColumnType(prop) {
         this.initUnsigned(prop);
         // Get the target properties for FK relations - use targetKey property if specified, otherwise PKs

package/metadata/types.d.ts

@@ -175,7 +175,7 @@ export interface PropertyOptions<Owner> {
      */
     autoincrement?: boolean;
     /**
-     * Add the property to the `returning` statement.
+     * Add the property to the `returning` clause of inserts, updates and upserts, reloading the database value into the entity.
      */
     returning?: boolean;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/core",
-  "version": "7.2.2-dev.2",
+  "version": "7.2.2-dev.20",
   "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",

package/unit-of-work/UnitOfWork.js

@@ -467,7 +467,10 @@ export class UnitOfWork {
             }
             const groups = this.getChangeSetGroups();
             const platform = this.#em.getPlatform();
-            const runInTransaction = !this.#em.isInTransaction() && platform.supportsTransactions() && this.#em.config.get('implicitTransactions');
+            const runInTransaction = !this.#em.isInTransaction() &&
+                !this.#em.isTransactionDisabled() &&
+                platform.supportsTransactions() &&
+                this.#em.config.get('implicitTransactions');
             if (runInTransaction) {
                 const loggerContext = Utils.merge({ id: this.#em._id }, this.#em.getLoggerContext({ disableContextResolution: true }));
                 await this.#em.getConnection('write').transactional(trx => this.persistToDatabase(groups, trx), {

package/utils/QueryHelper.js

@@ -111,9 +111,17 @@ export class QueryHelper {
             const op = this.liftGroupOperators(value, prop.targetMeta, metadata, k);
             if (op) {
                 delete where[k];
-                where[op] = value[op].map((v) => {
+                const group = value[op].map((v) => {
                     return { [k]: v };
                 });
+                if (op in where) {
+                    // Sibling groups are conjunctive, even when both use `$or`.
+                    where.$and ??= [];
+                    where.$and.push({ [op]: group });
+                }
+                else {
+                    where[op] = group;
+                }
             }
         }
         return undefined;

package/utils/Utils.js

@@ -153,7 +153,7 @@ export function parseJsonSafe(value) {
 /** Collection of general-purpose utility methods used throughout the ORM. */
 export class Utils {
     static PK_SEPARATOR = '~~~';
-    static #ORM_VERSION = '7.2.2-dev.2';
+    static #ORM_VERSION = '7.2.2-dev.20';
     /** Default session variable name backing an RLS filter argument (`current_setting('mikro.<filter>.<arg>')`). */
     static getRlsSettingName(filterName, argName) {
         return `mikro.${filterName}.${argName}`;

package/utils/upsert-utils.d.ts

@@ -1,6 +1,7 @@
 import type { EntityData, EntityKey, EntityMetadata, FilterQuery } from '../typings.js';
 import type { UpsertOptions } from '../drivers/IDatabaseDriver.js';
 import { type Raw } from '../utils/RawQueryFragment.js';
+import type { Platform } from '../platforms/Platform.js';
 /** @internal */
 export declare function getOnConflictFields<T>(meta: EntityMetadata<T> | undefined, data: EntityData<T>, uniqueFields: (keyof T)[] | Raw, options: UpsertOptions<T>): (keyof T)[];
 /**
@@ -12,7 +13,7 @@ export declare function getOnConflictFields<T>(meta: EntityMetadata<T> | undefin
  */
 export declare function getOnCreateGeneratedFields<T extends object>(meta: EntityMetadata<T>, data: T | EntityData<T>): EntityKey<T>[];
 /** @internal */
-export declare function getOnConflictReturningFields<T, P extends string>(meta: EntityMetadata<T> | undefined, data: EntityData<T>, uniqueFields: (keyof T)[] | Raw, options: UpsertOptions<T, P>): (keyof T)[] | '*';
+export declare function getOnConflictReturningFields<T, P extends string>(meta: EntityMetadata<T> | undefined, data: EntityData<T>, uniqueFields: (keyof T)[] | Raw, options: UpsertOptions<T, P>, platform?: Platform): (keyof T)[] | '*';
 /** @internal */
 export declare function getWhereCondition<T extends object>(meta: EntityMetadata<T>, onConflictFields: (keyof T)[] | Raw | undefined, data: EntityData<T>, where: FilterQuery<T>): {
     where: FilterQuery<T>;

package/utils/upsert-utils.js

@@ -89,11 +89,15 @@ export function getOnCreateGeneratedFields(meta, data) {
         .map(prop => prop.name);
 }
 /** @internal */
-export function getOnConflictReturningFields(meta, data, uniqueFields, options) {
+export function getOnConflictReturningFields(meta, data, uniqueFields, options, platform) {
     /* v8 ignore next */
     if (!meta) {
         return '*';
     }
+    // props with explicit `returning` hint are reloaded even when supplied, as the database might normalize them
+    const returning = platform?.usesReturningStatement() || platform?.usesOutputStatement()
+        ? meta.props.filter(p => p.returning).map(p => p.name)
+        : [];
     const keys = meta.comparableProps
         .filter(p => {
         if (p.lazy || p.embeddable) {
@@ -112,17 +116,17 @@ export function getOnConflictReturningFields(meta, data, uniqueFields, options)
         keys.push(meta.versionProperty);
     }
     if (options.onConflictAction === 'ignore') {
-        return keys;
+        return Utils.unique([...keys, ...returning]);
     }
     if (options.onConflictMergeFields) {
         const onConflictMergeFields = expandFields(meta, options.onConflictMergeFields);
-        return keys.filter(key => !onConflictMergeFields.includes(key));
+        return Utils.unique([...keys.filter(key => !onConflictMergeFields.includes(key)), ...returning]);
     }
     if (options.onConflictExcludeFields) {
         const onConflictExcludeFields = expandFields(meta, options.onConflictExcludeFields);
-        return [...new Set(keys.concat(...onConflictExcludeFields))];
+        return Utils.unique([...keys, ...onConflictExcludeFields, ...returning]);
     }
-    return keys.filter(key => !(key in data));
+    return Utils.unique([...keys.filter(key => !(key in data)), ...returning]);
 }
 function getPropertyValue(obj, key) {
     if (!key.includes('.')) {