@mikro-orm/knex 6.0.0-dev.10 → 6.0.0-dev.101

package/index.mjs

@@ -1,6 +1,8 @@
 import mod from "./index.js";
 
 export default mod;
+export const ALIAS_REPLACEMENT = mod.ALIAS_REPLACEMENT;
+export const ALIAS_REPLACEMENT_RE = mod.ALIAS_REPLACEMENT_RE;
 export const ARRAY_OPERATORS = mod.ARRAY_OPERATORS;
 export const AbstractNamingStrategy = mod.AbstractNamingStrategy;
 export const AbstractSchemaGenerator = mod.AbstractSchemaGenerator;
@@ -10,6 +12,7 @@ export const AbstractSqlPlatform = mod.AbstractSqlPlatform;
 export const AfterCreate = mod.AfterCreate;
 export const AfterDelete = mod.AfterDelete;
 export const AfterUpdate = mod.AfterUpdate;
+export const AfterUpsert = mod.AfterUpsert;
 export const ArrayCollection = mod.ArrayCollection;
 export const ArrayCriteriaNode = mod.ArrayCriteriaNode;
 export const ArrayType = mod.ArrayType;
@@ -17,6 +20,7 @@ export const BaseEntity = mod.BaseEntity;
 export const BeforeCreate = mod.BeforeCreate;
 export const BeforeDelete = mod.BeforeDelete;
 export const BeforeUpdate = mod.BeforeUpdate;
+export const BeforeUpsert = mod.BeforeUpsert;
 export const BigIntType = mod.BigIntType;
 export const BlobType = mod.BlobType;
 export const BooleanType = mod.BooleanType;
@@ -34,8 +38,10 @@ export const ConfigurationLoader = mod.ConfigurationLoader;
 export const Connection = mod.Connection;
 export const ConnectionException = mod.ConnectionException;
 export const ConstraintViolationException = mod.ConstraintViolationException;
+export const CreateRequestContext = mod.CreateRequestContext;
 export const CriteriaNode = mod.CriteriaNode;
 export const CriteriaNodeFactory = mod.CriteriaNodeFactory;
+export const Cursor = mod.Cursor;
 export const DatabaseDriver = mod.DatabaseDriver;
 export const DatabaseObjectExistsException = mod.DatabaseObjectExistsException;
 export const DatabaseObjectNotFoundException = mod.DatabaseObjectNotFoundException;
@@ -48,8 +54,10 @@ export const DecimalType = mod.DecimalType;
 export const DefaultLogger = mod.DefaultLogger;
 export const DoubleType = mod.DoubleType;
 export const DriverException = mod.DriverException;
+export const EagerProps = mod.EagerProps;
 export const Embeddable = mod.Embeddable;
 export const Embedded = mod.Embedded;
+export const EnsureRequestContext = mod.EnsureRequestContext;
 export const Entity = mod.Entity;
 export const EntityAssigner = mod.EntityAssigner;
 export const EntityCaseNamingStrategy = mod.EntityCaseNamingStrategy;
@@ -72,6 +80,7 @@ export const EnumArrayType = mod.EnumArrayType;
 export const EnumType = mod.EnumType;
 export const EventManager = mod.EventManager;
 export const EventType = mod.EventType;
+export const EventTypeMap = mod.EventTypeMap;
 export const ExceptionConverter = mod.ExceptionConverter;
 export const FileCacheAdapter = mod.FileCacheAdapter;
 export const Filter = mod.Filter;
@@ -79,14 +88,15 @@ export const FloatType = mod.FloatType;
 export const FlushMode = mod.FlushMode;
 export const ForeignKeyConstraintViolationException = mod.ForeignKeyConstraintViolationException;
 export const Formula = mod.Formula;
+export const GeneratedCacheAdapter = mod.GeneratedCacheAdapter;
 export const GroupOperator = mod.GroupOperator;
+export const HiddenProps = mod.HiddenProps;
 export const Hydrator = mod.Hydrator;
 export const IdentityMap = mod.IdentityMap;
 export const Index = mod.Index;
 export const IntegerType = mod.IntegerType;
 export const InvalidFieldNameException = mod.InvalidFieldNameException;
 export const IsolationLevel = mod.IsolationLevel;
-export const JavaScriptMetadataProvider = mod.JavaScriptMetadataProvider;
 export const JsonProperty = mod.JsonProperty;
 export const JsonType = mod.JsonType;
 export const Knex = mod.Knex;
@@ -125,7 +135,6 @@ export const Platform = mod.Platform;
 export const PopulateHint = mod.PopulateHint;
 export const PrimaryKey = mod.PrimaryKey;
 export const PrimaryKeyProp = mod.PrimaryKeyProp;
-export const PrimaryKeyType = mod.PrimaryKeyType;
 export const Property = mod.Property;
 export const QueryBuilder = mod.QueryBuilder;
 export const QueryBuilderHelper = mod.QueryBuilderHelper;
@@ -135,13 +144,16 @@ export const QueryOperator = mod.QueryOperator;
 export const QueryOrder = mod.QueryOrder;
 export const QueryOrderNumeric = mod.QueryOrderNumeric;
 export const QueryType = mod.QueryType;
+export const RawQueryFragment = mod.RawQueryFragment;
 export const ReadOnlyException = mod.ReadOnlyException;
+export const Ref = mod.Ref;
 export const Reference = mod.Reference;
-export const ReferenceType = mod.ReferenceType;
+export const ReferenceKind = mod.ReferenceKind;
 export const ReflectMetadataProvider = mod.ReflectMetadataProvider;
 export const RequestContext = mod.RequestContext;
 export const SCALAR_TYPES = mod.SCALAR_TYPES;
 export const ScalarCriteriaNode = mod.ScalarCriteriaNode;
+export const ScalarReference = mod.ScalarReference;
 export const SchemaComparator = mod.SchemaComparator;
 export const SchemaGenerator = mod.SchemaGenerator;
 export const SchemaHelper = mod.SchemaHelper;
@@ -154,7 +166,6 @@ export const SqlEntityManager = mod.SqlEntityManager;
 export const SqlEntityRepository = mod.SqlEntityRepository;
 export const SqlSchemaGenerator = mod.SqlSchemaGenerator;
 export const StringType = mod.StringType;
-export const Subscriber = mod.Subscriber;
 export const SyntaxErrorException = mod.SyntaxErrorException;
 export const TableExistsException = mod.TableExistsException;
 export const TableNotFoundException = mod.TableNotFoundException;
@@ -164,12 +175,12 @@ export const TinyIntType = mod.TinyIntType;
 export const TransactionContext = mod.TransactionContext;
 export const TransactionEventBroadcaster = mod.TransactionEventBroadcaster;
 export const Type = mod.Type;
+export const Uint8ArrayType = mod.Uint8ArrayType;
 export const UnderscoreNamingStrategy = mod.UnderscoreNamingStrategy;
 export const Unique = mod.Unique;
 export const UniqueConstraintViolationException = mod.UniqueConstraintViolationException;
 export const UnitOfWork = mod.UnitOfWork;
 export const UnknownType = mod.UnknownType;
-export const UseRequestContext = mod.UseRequestContext;
 export const Utils = mod.Utils;
 export const UuidType = mod.UuidType;
 export const ValidationError = mod.ValidationError;
@@ -182,11 +193,16 @@ export const compareBuffers = mod.compareBuffers;
 export const compareObjects = mod.compareObjects;
 export const defineConfig = mod.defineConfig;
 export const equals = mod.equals;
-export const expr = mod.expr;
+export const getOnConflictFields = mod.getOnConflictFields;
+export const getOnConflictReturningFields = mod.getOnConflictReturningFields;
 export const helper = mod.helper;
 export const knex = mod.knex;
+export const parseJsonSafe = mod.parseJsonSafe;
+export const raw = mod.raw;
 export const ref = mod.ref;
+export const rel = mod.rel;
 export const serialize = mod.serialize;
+export const sql = mod.sql;
 export const t = mod.t;
 export const types = mod.types;
 export const wrap = mod.wrap;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/knex",
-  "version": "6.0.0-dev.10",
+  "version": "6.0.0-dev.101",
   "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",
@@ -46,26 +46,26 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 16.0.0"
+    "node": ">= 18.12.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy && yarn run -T gen-esm-wrapper index.js index.mjs",
-    "clean": "rimraf ./dist",
-    "compile": "tsc -p tsconfig.build.json",
+    "clean": "yarn run -T rimraf ./dist",
+    "compile": "yarn run -T tsc -p tsconfig.build.json",
     "copy": "node ../../scripts/copy.mjs"
   },
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "fs-extra": "11.1.0",
-    "knex": "2.3.0",
+    "fs-extra": "11.1.1",
+    "knex": "2.5.1",
     "sqlstring": "2.3.3"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^5.5.3"
+    "@mikro-orm/core": "^5.8.1"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "~6.0.0-dev.10"
+    "@mikro-orm/core": "~6.0.0-dev.101"
   }
 }

package/query/ArrayCriteriaNode.d.ts

@@ -3,7 +3,7 @@ import type { IQueryBuilder } from '../typings';
 /**
  * @internal
  */
-export declare class ArrayCriteriaNode extends CriteriaNode {
-    process<T>(qb: IQueryBuilder<T>, alias?: string): any;
-    willAutoJoin<T>(qb: IQueryBuilder<T>, alias?: string): any;
+export declare class ArrayCriteriaNode<T extends object> extends CriteriaNode<T> {
+    process(qb: IQueryBuilder<T>, alias?: string): any;
+    willAutoJoin(qb: IQueryBuilder<T>, alias?: string): any;
 }

package/query/CriteriaNode.d.ts

@@ -1,24 +1,24 @@
 /// <reference types="node" />
 import { inspect } from 'util';
-import type { EntityProperty, MetadataStorage } from '@mikro-orm/core';
+import { type EntityProperty, type MetadataStorage, type EntityKey } from '@mikro-orm/core';
 import type { ICriteriaNode, IQueryBuilder } from '../typings';
 /**
  * Helper for working with deeply nested where/orderBy/having criteria. Uses composite pattern to build tree from the payload.
  * Auto-joins relations and converts payload from { books: { publisher: { name: '...' } } } to { 'publisher_alias.name': '...' }
  * @internal
  */
-export declare class CriteriaNode implements ICriteriaNode {
+export declare class CriteriaNode<T extends object> implements ICriteriaNode<T> {
     protected readonly metadata: MetadataStorage;
     readonly entityName: string;
-    readonly parent?: ICriteriaNode | undefined;
-    readonly key?: string | undefined;
+    readonly parent?: ICriteriaNode<T> | undefined;
+    readonly key?: EntityKey<T> | undefined;
     payload: any;
-    prop?: EntityProperty;
+    prop?: EntityProperty<T>;
     index?: number;
-    constructor(metadata: MetadataStorage, entityName: string, parent?: ICriteriaNode | undefined, key?: string | undefined, validate?: boolean);
-    process<T>(qb: IQueryBuilder<T>, alias?: string): any;
+    constructor(metadata: MetadataStorage, entityName: string, parent?: ICriteriaNode<T> | undefined, key?: EntityKey<T> | undefined, validate?: boolean);
+    process(qb: IQueryBuilder<T>, alias?: string): any;
     shouldInline(payload: any): boolean;
-    willAutoJoin<T>(qb: IQueryBuilder<T>, alias?: string): boolean;
+    willAutoJoin(qb: IQueryBuilder<T>, alias?: string): boolean;
     shouldRename(payload: any): boolean;
     renameFieldToPK<T>(qb: IQueryBuilder<T>): string;
     getPath(addIndex?: boolean): string;

package/query/CriteriaNode.js

@@ -9,6 +9,13 @@ const core_1 = require("@mikro-orm/core");
  * @internal
  */
 class CriteriaNode {
+    metadata;
+    entityName;
+    parent;
+    key;
+    payload;
+    prop;
+    index;
     constructor(metadata, entityName, parent, key, validate = true) {
         this.metadata = metadata;
         this.entityName = entityName;
@@ -40,7 +47,7 @@ class CriteriaNode {
         return false;
     }
     shouldRename(payload) {
-        const type = this.prop ? this.prop.reference : null;
+        const type = this.prop ? this.prop.kind : null;
         const composite = this.prop?.joinColumns ? this.prop.joinColumns.length > 1 : false;
         const customExpression = CriteriaNode.isCustomExpression(this.key);
         const scalar = payload === null || core_1.Utils.isPrimaryKey(payload) || payload instanceof RegExp || payload instanceof Date || customExpression;
@@ -49,17 +56,17 @@ class CriteriaNode {
             return true;
         }
         switch (type) {
-            case core_1.ReferenceType.MANY_TO_ONE: return false;
-            case core_1.ReferenceType.ONE_TO_ONE: return !this.prop.owner;
-            case core_1.ReferenceType.ONE_TO_MANY: return scalar || operator;
-            case core_1.ReferenceType.MANY_TO_MANY: return scalar || operator;
+            case core_1.ReferenceKind.MANY_TO_ONE: return false;
+            case core_1.ReferenceKind.ONE_TO_ONE: return !this.prop.owner;
+            case core_1.ReferenceKind.ONE_TO_MANY: return scalar || operator;
+            case core_1.ReferenceKind.MANY_TO_MANY: return scalar || operator;
             default: return false;
         }
     }
     renameFieldToPK(qb) {
         const joinAlias = qb.getAliasForJoinPath(this.getPath());
         const alias = joinAlias ?? qb.alias;
-        if (this.prop.reference === core_1.ReferenceType.MANY_TO_MANY) {
+        if (this.prop.kind === core_1.ReferenceKind.MANY_TO_MANY) {
             return core_1.Utils.getPrimaryKeyHash(this.prop.inverseJoinColumns.map(col => `${alias}.${col}`));
         }
         // if we found a matching join, we need to use the target table column names, as we use that alias instead of the root
@@ -70,7 +77,7 @@ class CriteriaNode {
     }
     getPath(addIndex = false) {
         // use index on parent only if we are processing to-many relation
-        const addParentIndex = this.prop && [core_1.ReferenceType.ONE_TO_MANY, core_1.ReferenceType.MANY_TO_MANY].includes(this.prop.reference);
+        const addParentIndex = this.prop && [core_1.ReferenceKind.ONE_TO_MANY, core_1.ReferenceKind.MANY_TO_MANY].includes(this.prop.kind);
         const parentPath = this.parent?.getPath(addParentIndex) ?? this.entityName;
         const index = addIndex && this.index != null ? `[${this.index}]` : '';
         // ignore group operators to allow easier mapping (e.g. for orderBy)
@@ -89,7 +96,7 @@ class CriteriaNode {
         const customExpression = CriteriaNode.isCustomExpression(this.key);
         const scalar = this.payload === null || core_1.Utils.isPrimaryKey(this.payload) || this.payload instanceof RegExp || this.payload instanceof Date || customExpression;
         const operator = core_1.Utils.isObject(this.payload) && Object.keys(this.payload).every(k => core_1.Utils.isOperator(k, false));
-        return this.prop.reference === core_1.ReferenceType.MANY_TO_MANY && (scalar || operator);
+        return this.prop.kind === core_1.ReferenceKind.MANY_TO_MANY && (scalar || operator);
     }
     getPivotPath(path) {
         return `${path}[pivot]`;
@@ -97,7 +104,7 @@ class CriteriaNode {
     [util_1.inspect.custom]() {
         const o = {};
         ['entityName', 'key', 'index', 'payload']
-            .filter(k => this[k] != null)
+            .filter(k => this[k] !== undefined)
             .forEach(k => o[k] = this[k]);
         return `${this.constructor.name} ${(0, util_1.inspect)(o)}`;
     }

package/query/CriteriaNodeFactory.d.ts

@@ -1,12 +1,12 @@
-import type { Dictionary, EntityMetadata, MetadataStorage } from '@mikro-orm/core';
+import { type Dictionary, type EntityMetadata, type MetadataStorage, type EntityKey } from '@mikro-orm/core';
 import type { ICriteriaNode } from '../typings';
 /**
  * @internal
  */
 export declare class CriteriaNodeFactory {
-    static createNode(metadata: MetadataStorage, entityName: string, payload: any, parent?: ICriteriaNode, key?: string): ICriteriaNode;
-    static createScalarNode(metadata: MetadataStorage, entityName: string, payload: any, parent?: ICriteriaNode, key?: string): ICriteriaNode;
-    static createArrayNode(metadata: MetadataStorage, entityName: string, payload: any[], parent?: ICriteriaNode, key?: string): ICriteriaNode;
-    static createObjectNode(metadata: MetadataStorage, entityName: string, payload: Dictionary, parent?: ICriteriaNode, key?: string): ICriteriaNode;
-    static createObjectItemNode(metadata: MetadataStorage, entityName: string, node: ICriteriaNode, payload: Dictionary, item: string, meta?: EntityMetadata): ICriteriaNode;
+    static createNode<T extends object>(metadata: MetadataStorage, entityName: string, payload: any, parent?: ICriteriaNode<T>, key?: EntityKey<T>): ICriteriaNode<T>;
+    static createScalarNode<T extends object>(metadata: MetadataStorage, entityName: string, payload: any, parent?: ICriteriaNode<T>, key?: EntityKey<T>): ICriteriaNode<T>;
+    static createArrayNode<T extends object>(metadata: MetadataStorage, entityName: string, payload: any[], parent?: ICriteriaNode<T>, key?: EntityKey<T>): ICriteriaNode<T>;
+    static createObjectNode<T extends object>(metadata: MetadataStorage, entityName: string, payload: Dictionary, parent?: ICriteriaNode<T>, key?: EntityKey<T>): ICriteriaNode<T>;
+    static createObjectItemNode<T extends object>(metadata: MetadataStorage, entityName: string, node: ICriteriaNode<T>, payload: Dictionary, key: EntityKey<T>, meta?: EntityMetadata<T>): ICriteriaNode<T>;
 }

package/query/CriteriaNodeFactory.js

@@ -12,7 +12,7 @@ const CriteriaNode_1 = require("./CriteriaNode");
 class CriteriaNodeFactory {
     static createNode(metadata, entityName, payload, parent, key) {
         const customExpression = CriteriaNode_1.CriteriaNode.isCustomExpression(key || '');
-        const scalar = core_1.Utils.isPrimaryKey(payload) || payload instanceof RegExp || payload instanceof Date || customExpression;
+        const scalar = core_1.Utils.isPrimaryKey(payload) || core_1.Utils.isRawSql(payload) || payload instanceof RegExp || payload instanceof Date || customExpression;
         if (Array.isArray(payload) && !scalar) {
             return this.createArrayNode(metadata, entityName, payload, parent, key);
         }
@@ -37,9 +37,6 @@ class CriteriaNodeFactory {
     }
     static createObjectNode(metadata, entityName, payload, parent, key) {
         const meta = metadata.find(entityName);
-        if (!parent && Object.keys(payload).every(k => meta?.properties[k]?.reference === core_1.ReferenceType.SCALAR)) {
-            return this.createScalarNode(metadata, entityName, payload, parent, key);
-        }
         const node = new ObjectCriteriaNode_1.ObjectCriteriaNode(metadata, entityName, parent, key);
         node.payload = Object.keys(payload).reduce((o, item) => {
             o[item] = this.createObjectItemNode(metadata, entityName, node, payload, item, meta);
@@ -47,24 +44,24 @@ class CriteriaNodeFactory {
         }, {});
         return node;
     }
-    static createObjectItemNode(metadata, entityName, node, payload, item, meta) {
-        const prop = meta?.properties[item];
-        if (prop?.reference !== core_1.ReferenceType.EMBEDDED) {
-            const childEntity = prop && prop.reference !== core_1.ReferenceType.SCALAR ? prop.type : entityName;
-            return this.createNode(metadata, childEntity, payload[item], node, item);
+    static createObjectItemNode(metadata, entityName, node, payload, key, meta) {
+        const prop = meta?.properties[key];
+        if (prop?.kind !== core_1.ReferenceKind.EMBEDDED) {
+            const childEntity = prop && prop.kind !== core_1.ReferenceKind.SCALAR ? prop.type : entityName;
+            return this.createNode(metadata, childEntity, payload[key], node, key);
         }
-        const operator = Object.keys(payload[item]).some(f => core_1.Utils.isOperator(f));
+        const operator = Object.keys(payload[key]).some(f => core_1.Utils.isOperator(f));
         if (operator) {
             throw core_1.ValidationError.cannotUseOperatorsInsideEmbeddables(entityName, prop.name, payload);
         }
-        const map = Object.keys(payload[item]).reduce((oo, k) => {
+        const map = Object.keys(payload[key]).reduce((oo, k) => {
             if (!prop.embeddedProps[k]) {
                 throw core_1.ValidationError.invalidEmbeddableQuery(entityName, k, prop.type);
             }
-            oo[prop.embeddedProps[k].name] = payload[item][k];
+            oo[prop.embeddedProps[k].name] = payload[key][k];
             return oo;
         }, {});
-        return this.createNode(metadata, entityName, map, node, item);
+        return this.createNode(metadata, entityName, map, node, key);
     }
 }
 exports.CriteriaNodeFactory = CriteriaNodeFactory;

package/query/ObjectCriteriaNode.d.ts

@@ -3,9 +3,9 @@ import type { IQueryBuilder } from '../typings';
 /**
  * @internal
  */
-export declare class ObjectCriteriaNode extends CriteriaNode {
-    process<T>(qb: IQueryBuilder<T>, alias?: string): any;
-    willAutoJoin<T>(qb: IQueryBuilder<T>, alias?: string): boolean;
+export declare class ObjectCriteriaNode<T extends object> extends CriteriaNode<T> {
+    process(qb: IQueryBuilder<T>, alias?: string): any;
+    willAutoJoin(qb: IQueryBuilder<T>, alias?: string): boolean;
     shouldInline(payload: any): boolean;
     private inlineChildPayload;
     private shouldAutoJoin;

package/query/ObjectCriteriaNode.js

@@ -21,7 +21,7 @@ class ObjectCriteriaNode extends CriteriaNode_1.CriteriaNode {
             const childNode = this.payload[field];
             const payload = childNode.process(qb, this.prop ? alias : ownerAlias);
             const operator = core_1.Utils.isOperator(field);
-            const customExpression = ObjectCriteriaNode.isCustomExpression(field);
+            const isRawField = core_1.RawQueryFragment.isKnownFragment(field);
             // we need to keep the prefixing for formulas otherwise we would lose aliasing context when nesting inside group operators
             const virtual = childNode.prop?.persist === false && !childNode.prop?.formula;
             // if key is missing, we are inside group operator and we need to prefix with alias
@@ -33,8 +33,12 @@ class ObjectCriteriaNode extends CriteriaNode_1.CriteriaNode {
             else if (childNode.shouldRename(payload)) {
                 o[childNode.renameFieldToPK(qb)] = payload;
             }
-            else if (primaryKey || virtual || operator || customExpression || field.includes('.') || ![enums_1.QueryType.SELECT, enums_1.QueryType.COUNT].includes(qb.type ?? enums_1.QueryType.SELECT)) {
-                o[field.replace(/\[::alias::]/g, alias)] = payload;
+            else if (isRawField) {
+                const rawField = core_1.RawQueryFragment.getKnownFragment(field);
+                o[(0, core_1.raw)(rawField.sql.replaceAll(core_1.ALIAS_REPLACEMENT, alias), rawField.params)] = payload;
+            }
+            else if (primaryKey || virtual || operator || field.includes('.') || ![enums_1.QueryType.SELECT, enums_1.QueryType.COUNT].includes(qb.type ?? enums_1.QueryType.SELECT)) {
+                o[field.replaceAll(core_1.ALIAS_REPLACEMENT, alias)] = payload;
             }
             else {
                 o[`${alias}.${field}`] = payload;
@@ -60,7 +64,7 @@ class ObjectCriteriaNode extends CriteriaNode_1.CriteriaNode {
         const customExpression = ObjectCriteriaNode.isCustomExpression(this.key);
         const scalar = core_1.Utils.isPrimaryKey(payload) || payload instanceof RegExp || payload instanceof Date || customExpression;
         const operator = core_1.Utils.isObject(payload) && Object.keys(payload).every(k => core_1.Utils.isOperator(k, false));
-        return !!this.prop && this.prop.reference !== core_1.ReferenceType.SCALAR && !scalar && !operator;
+        return !!this.prop && this.prop.kind !== core_1.ReferenceKind.SCALAR && !scalar && !operator;
     }
     inlineChildPayload(o, payload, field, alias, childAlias) {
         const prop = this.metadata.find(this.entityName).properties[field];
@@ -104,15 +108,15 @@ class ObjectCriteriaNode extends CriteriaNode_1.CriteriaNode {
         if (!this.prop || !this.parent) {
             return false;
         }
-        const embeddable = this.prop.reference === core_1.ReferenceType.EMBEDDED;
-        const knownKey = [core_1.ReferenceType.SCALAR, core_1.ReferenceType.MANY_TO_ONE, core_1.ReferenceType.EMBEDDED].includes(this.prop.reference) || (this.prop.reference === core_1.ReferenceType.ONE_TO_ONE && this.prop.owner);
+        const embeddable = this.prop.kind === core_1.ReferenceKind.EMBEDDED;
+        const knownKey = [core_1.ReferenceKind.SCALAR, core_1.ReferenceKind.MANY_TO_ONE, core_1.ReferenceKind.EMBEDDED].includes(this.prop.kind) || (this.prop.kind === core_1.ReferenceKind.ONE_TO_ONE && this.prop.owner);
         const operatorKeys = knownKey && Object.keys(this.payload).every(key => core_1.Utils.isOperator(key, false));
         const primaryKeys = knownKey && Object.keys(this.payload).every(key => {
             const meta = this.metadata.find(this.entityName);
             if (!meta.primaryKeys.includes(key)) {
                 return false;
             }
-            if (!core_1.Utils.isPlainObject(this.payload[key].payload) || ![core_1.ReferenceType.ONE_TO_ONE, core_1.ReferenceType.MANY_TO_ONE].includes(meta.properties[key].reference)) {
+            if (!core_1.Utils.isPlainObject(this.payload[key].payload) || ![core_1.ReferenceKind.ONE_TO_ONE, core_1.ReferenceKind.MANY_TO_ONE].includes(meta.properties[key].kind)) {
                 return true;
             }
             return Object.keys(this.payload[key].payload).every(k => meta.properties[key].targetMeta.primaryKeys.includes(k));
@@ -125,7 +129,7 @@ class ObjectCriteriaNode extends CriteriaNode_1.CriteriaNode {
         const scalar = core_1.Utils.isPrimaryKey(this.payload) || this.payload instanceof RegExp || this.payload instanceof Date || customExpression;
         const operator = core_1.Utils.isPlainObject(this.payload) && Object.keys(this.payload).every(k => core_1.Utils.isOperator(k, false));
         const field = `${alias}.${this.prop.name}`;
-        if (this.prop.reference === core_1.ReferenceType.MANY_TO_MANY && (scalar || operator)) {
+        if (this.prop.kind === core_1.ReferenceKind.MANY_TO_MANY && (scalar || operator)) {
             qb.join(field, nestedAlias, undefined, 'pivotJoin', this.getPath());
         }
         else {

package/query/QueryBuilder.d.ts

@@ -1,12 +1,13 @@
+/// <reference types="node" />
+import { inspect } from 'util';
 import type { Knex } from 'knex';
-import type { AnyEntity, ConnectionType, Dictionary, EntityData, EntityName, EntityProperty, FlushMode, GroupOperator, MetadataStorage, ObjectQuery, PopulateOptions, QBFilterQuery, QBQueryOrderMap, QueryResult, RequiredEntityData } from '@mikro-orm/core';
-import { LockMode, PopulateHint, QueryFlag } from '@mikro-orm/core';
+import { LockMode, PopulateHint, QueryFlag, type AnyEntity, type ConnectionType, type Dictionary, type EntityData, type EntityName, type EntityProperty, type FlushMode, type GroupOperator, type MetadataStorage, type ObjectQuery, type PopulateOptions, type QBFilterQuery, type QBQueryOrderMap, type QueryResult, type RequiredEntityData, type LoggingOptions } from '@mikro-orm/core';
 import { QueryType } from './enums';
 import type { AbstractSqlDriver } from '../AbstractSqlDriver';
-import { QueryBuilderHelper } from './QueryBuilderHelper';
-import type { Alias } from './QueryBuilderHelper';
+import { QueryBuilderHelper, type Alias } from './QueryBuilderHelper';
 import type { SqlEntityManager } from '../SqlEntityManager';
 import type { Field } from '../typings';
+import type { AbstractSqlPlatform } from '../AbstractSqlPlatform';
 /**
  * SQL query builder with fluent interface.
  *
@@ -27,12 +28,14 @@ import type { Field } from '../typings';
  * ```
  */
 export declare class QueryBuilder<T extends object = AnyEntity> {
+    #private;
     private readonly metadata;
     private readonly driver;
     private readonly context?;
     private connectionType?;
     private readonly em?;
-    get mainAlias(): Alias;
+    private readonly logging?;
+    get mainAlias(): Alias<T>;
     get alias(): string;
     get helper(): QueryBuilderHelper;
     /** @internal */
@@ -56,6 +59,7 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
     private _orderBy;
     private _groupBy;
     private _having;
+    private _returning?;
     private _onConflict?;
     private _limit?;
     private _offset?;
@@ -63,6 +67,8 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
     private _joinedProps;
     private _cache?;
     private _indexHint?;
+    private _comments;
+    private _hintComments;
     private flushMode?;
     private lockMode?;
     private lockTables?;
@@ -75,7 +81,7 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
     /**
      * @internal
      */
-    constructor(entityName: EntityName<T> | QueryBuilder<T>, metadata: MetadataStorage, driver: AbstractSqlDriver, context?: Knex.Transaction<any, any[]> | undefined, alias?: string, connectionType?: ConnectionType | undefined, em?: SqlEntityManager<AbstractSqlDriver<import("../AbstractSqlConnection").AbstractSqlConnection>> | undefined);
+    constructor(entityName: EntityName<T> | QueryBuilder<T>, metadata: MetadataStorage, driver: AbstractSqlDriver, context?: Knex.Transaction<any, any[]> | undefined, alias?: string, connectionType?: ConnectionType | undefined, em?: SqlEntityManager<AbstractSqlDriver<import("..").AbstractSqlConnection, AbstractSqlPlatform>> | undefined, logging?: LoggingOptions | undefined);
     select(fields: Field<T> | Field<T>[], distinct?: boolean): SelectQueryBuilder<T>;
     addSelect(fields: Field<T> | Field<T>[]): SelectQueryBuilder<T>;
     distinct(): SelectQueryBuilder<T>;
@@ -86,11 +92,12 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
     delete(cond?: QBFilterQuery): DeleteQueryBuilder<T>;
     truncate(): TruncateQueryBuilder<T>;
     count(field?: string | string[], distinct?: boolean): CountQueryBuilder<T>;
-    join(field: string, alias: string, cond?: QBFilterQuery, type?: 'leftJoin' | 'innerJoin' | 'pivotJoin', path?: string): this;
-    leftJoin(field: string, alias: string, cond?: QBFilterQuery): this;
-    joinAndSelect(field: string, alias: string, cond?: QBFilterQuery, type?: 'leftJoin' | 'innerJoin' | 'pivotJoin', path?: string): SelectQueryBuilder<T>;
-    leftJoinAndSelect(field: string, alias: string, cond?: QBFilterQuery): SelectQueryBuilder<T>;
-    protected getFieldsForJoinedLoad<U extends object>(prop: EntityProperty<U>, alias: string): Field<U>[];
+    join(field: string, alias: string, cond?: QBFilterQuery, type?: 'leftJoin' | 'innerJoin' | 'pivotJoin', path?: string, schema?: string): this;
+    leftJoin(field: string, alias: string, cond?: QBFilterQuery, schema?: string): this;
+    joinAndSelect(field: string, alias: string, cond?: QBFilterQuery, type?: 'leftJoin' | 'innerJoin' | 'pivotJoin', path?: string, fields?: string[], schema?: string): SelectQueryBuilder<T>;
+    leftJoinAndSelect(field: string, alias: string, cond?: QBFilterQuery, fields?: string[], schema?: string): SelectQueryBuilder<T>;
+    innerJoinAndSelect(field: string, 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;
     where(cond: string, params?: any[], operator?: keyof typeof GroupOperator): this;
@@ -104,17 +111,11 @@ 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
      */
     populate(populate: PopulateOptions<T>[], populateWhere?: ObjectQuery<T> | PopulateHint): this;
-    /**
-     * @internal
-     */
-    ref(field: string): Knex.Ref<string, {
-        [x: string]: string;
-    }>;
-    raw<R = Knex.Raw>(sql: string, bindings?: Knex.RawBinding[] | Knex.ValueDict): R;
     limit(limit?: number, offset?: number): this;
     offset(offset?: number): this;
     withSchema(schema?: string): this;
@@ -127,6 +128,16 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
      * Adds index hint to the FROM clause.
      */
     indexHint(sql: string): this;
+    /**
+     * Prepend comment to the sql query using the syntax `/* ... *&#8205;/`. Some characters are forbidden such as `/*, *&#8205;/` and `?`.
+     */
+    comment(comment: string | string[]): this;
+    /**
+     * Add hints to the query using comment-like syntax `/*+ ... *&#8205;/`. MySQL and Oracle use this syntax for optimizer hints.
+     * Also various DB proxies and routers use this syntax to pass hints to alter their behavior. In other dialects the hints
+     * are ignored as simple comments.
+     */
+    hintComment(comment: string | string[]): this;
     /**
      * Specifies FROM which entity's table select/update/delete will be executed, removing all previously set FROM-s.
      * Allows setting a main string alias of the selection data.
@@ -138,6 +149,11 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
      * Returns the query with parameters as wildcards.
      */
     getQuery(): string;
+    toQuery(): {
+        sql: string;
+        _sql: Knex.Sql;
+        params: readonly unknown[];
+    };
     /**
      * Returns the list of all parameters for this query.
      */
@@ -179,6 +195,10 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
      * Executes count query (without offset and limit), returning total count of results
      */
     getCount(field?: string | string[], distinct?: boolean): Promise<number>;
+    /**
+     * Executes the query, returning both array of results and total count query (without offset and limit).
+     */
+    getResultAndCount(): Promise<[T[], number]>;
     /**
      * Provides promise-like interface so we can await the QB instance.
      */
@@ -194,11 +214,12 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
     private prepareFields;
     private init;
     private getQueryBase;
+    private applyDiscriminatorCondition;
     private finalize;
+    private processPopulateWhere;
     private hasToManyJoins;
     private wrapPaginateSubQuery;
     private wrapModifySubQuery;
-    private autoJoinPivotTable;
     private getSchema;
     private createAlias;
     private createMainAlias;
@@ -207,6 +228,7 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
     private createQueryBuilderHelper;
     private ensureFromClause;
     private ensureNotFinalized;
+    [inspect.custom](depth: number): string;
 }
 export interface RunQueryBuilder<T extends object> extends Omit<QueryBuilder<T>, 'getResult' | 'getSingleResult' | 'getResultList' | 'where'> {
     where(cond: QBFilterQuery<T> | string, params?: keyof typeof GroupOperator | any[], operator?: keyof typeof GroupOperator): this;