@mikro-orm/knex 7.0.0-dev.34 → 7.0.0-dev.36

package/AbstractSqlConnection.d.ts

@@ -42,7 +42,9 @@ export declare abstract class AbstractSqlConnection extends Connection {
     }): Promise<ControlledTransaction<any, any>>;
     commit(ctx: ControlledTransaction<any, any>, eventBroadcaster?: TransactionEventBroadcaster, loggerContext?: LogContext): Promise<void>;
     rollback(ctx: ControlledTransaction<any, any>, eventBroadcaster?: TransactionEventBroadcaster, loggerContext?: LogContext): Promise<void>;
+    private prepareQuery;
     execute<T extends QueryResult | EntityData<AnyEntity> | EntityData<AnyEntity>[] = EntityData<AnyEntity>[]>(query: string | NativeQueryBuilder | RawQueryFragment, params?: readonly unknown[], method?: 'all' | 'get' | 'run', ctx?: Transaction, loggerContext?: LoggingOptions): Promise<T>;
+    stream<T extends EntityData<AnyEntity>>(query: string | NativeQueryBuilder | RawQueryFragment, params?: readonly unknown[], ctx?: Transaction<Kysely<any>>, loggerContext?: LoggingOptions): AsyncIterableIterator<T>;
     /**
      * Execute raw SQL queries from file
      */

package/AbstractSqlConnection.js

@@ -1,6 +1,6 @@
-import { CompiledQuery, Kysely, } from 'kysely';
+import { CompiledQuery, Kysely } from 'kysely';
 import { readFile } from 'node:fs/promises';
-import { Connection, EventType, RawQueryFragment, } from '@mikro-orm/core';
+import { Connection, EventType, RawQueryFragment, Utils, } from '@mikro-orm/core';
 import { NativeQueryBuilder } from './query/NativeQueryBuilder.js';
 export class AbstractSqlConnection extends Connection {
     client;
@@ -135,8 +135,7 @@ export class AbstractSqlConnection extends Connection {
         }
         await eventBroadcaster?.dispatchEvent(EventType.afterTransactionRollback, ctx);
     }
-    async execute(query, params = [], method = 'all', ctx, loggerContext) {
-        await this.ensureConnection();
+    prepareQuery(query, params = []) {
         if (query instanceof NativeQueryBuilder) {
             query = query.toRaw();
         }
@@ -146,16 +145,47 @@ export class AbstractSqlConnection extends Connection {
         }
         query = this.config.get('onQuery')(query, params);
         const formatted = this.platform.formatQuery(query, params);
-        const sql = this.getSql(query, formatted, loggerContext);
+        return { query, params, formatted };
+    }
+    async execute(query, params = [], method = 'all', ctx, loggerContext) {
+        await this.ensureConnection();
+        const q = this.prepareQuery(query, params);
+        const sql = this.getSql(q.query, q.formatted, loggerContext);
         return this.executeQuery(sql, async () => {
-            const compiled = CompiledQuery.raw(formatted);
-            if (ctx) {
-                const res = await ctx.executeQuery(compiled);
-                return this.transformRawResult(res, method);
-            }
-            const res = await this.client.executeQuery(compiled);
+            const compiled = CompiledQuery.raw(q.formatted);
+            const res = await (ctx ?? this.client).executeQuery(compiled);
             return this.transformRawResult(res, method);
-        }, { query, params, ...loggerContext });
+        }, { ...q, ...loggerContext });
+    }
+    async *stream(query, params = [], ctx, loggerContext) {
+        await this.ensureConnection();
+        const q = this.prepareQuery(query, params);
+        const sql = this.getSql(q.query, q.formatted, loggerContext);
+        // construct the compiled query manually with `kind: 'SelectQueryNode'` to avoid sqlite validation for select queries when streaming
+        const compiled = {
+            query: {
+                kind: 'SelectQueryNode',
+            },
+            sql: q.formatted,
+            parameters: [],
+        };
+        try {
+            const res = (ctx ?? this.client).getExecutor().stream(compiled, 1);
+            this.logQuery(sql, {
+                sql, params,
+                ...loggerContext,
+                affected: Utils.isPlainObject(res) ? res.affectedRows : undefined,
+            });
+            for await (const items of res) {
+                for (const row of this.transformRawResult(items, 'all')) {
+                    yield row;
+                }
+            }
+        }
+        catch (e) {
+            this.logQuery(sql, { sql, params, ...loggerContext, level: 'error' });
+            throw e;
+        }
     }
     /**
      * Execute raw SQL queries from file

package/AbstractSqlDriver.d.ts

@@ -1,4 +1,4 @@
-import { type AnyEntity, type Collection, type Configuration, type ConnectionType, type Constructor, type CountOptions, DatabaseDriver, type DeleteOptions, type Dictionary, type DriverMethodOptions, type EntityData, type EntityDictionary, type EntityField, EntityManagerType, type EntityMetadata, type EntityName, type EntityProperty, type FilterQuery, type FindOneOptions, type FindOptions, type LockOptions, type LoggingOptions, type NativeInsertUpdateManyOptions, type NativeInsertUpdateOptions, type ObjectQuery, type Options, type OrderDefinition, type PopulateOptions, type PopulatePath, type Primary, type QueryOrderMap, type QueryResult, RawQueryFragment, type Transaction, type UpsertManyOptions, type UpsertOptions } from '@mikro-orm/core';
+import { type AnyEntity, type Collection, type Configuration, type ConnectionType, type Constructor, type CountOptions, DatabaseDriver, type DeleteOptions, type Dictionary, type DriverMethodOptions, type EntityData, type EntityDictionary, type EntityField, EntityManagerType, type EntityMetadata, type EntityName, type EntityProperty, type FilterQuery, type FindOneOptions, type FindOptions, type LockOptions, type LoggingOptions, type NativeInsertUpdateManyOptions, type NativeInsertUpdateOptions, type ObjectQuery, type Options, type OrderDefinition, type PopulateOptions, type PopulatePath, type Primary, type QueryOrderMap, type QueryResult, RawQueryFragment, type StreamOptions, type Transaction, type UpsertManyOptions, type UpsertOptions } from '@mikro-orm/core';
 import type { AbstractSqlConnection } from './AbstractSqlConnection.js';
 import type { AbstractSqlPlatform } from './AbstractSqlPlatform.js';
 import { QueryBuilder } from './query/QueryBuilder.js';
@@ -14,13 +14,16 @@ export declare abstract class AbstractSqlDriver<Connection extends AbstractSqlCo
     protected constructor(config: Configuration, platform: Platform, connection: Constructor<Connection>, connector: string[]);
     getPlatform(): Platform;
     createEntityManager(useContext?: boolean): this[typeof EntityManagerType];
+    private createQueryBuilderFromOptions;
     find<T extends object, P extends string = never, F extends string = PopulatePath.ALL, E extends string = never>(entityName: string, where: ObjectQuery<T>, options?: FindOptions<T, P, F, E>): Promise<EntityData<T>[]>;
     findOne<T extends object, P extends string = never, F extends string = PopulatePath.ALL, E extends string = never>(entityName: string, where: ObjectQuery<T>, options?: FindOneOptions<T, P, F, E>): Promise<EntityData<T> | null>;
     protected hasToManyJoins<T extends object>(hint: PopulateOptions<T>, meta: EntityMetadata<T>): boolean;
     findVirtual<T extends object>(entityName: string, where: ObjectQuery<T>, options: FindOptions<T, any, any, any>): Promise<EntityData<T>[]>;
     countVirtual<T extends object>(entityName: string, where: ObjectQuery<T>, options: CountOptions<T, any>): Promise<number>;
     protected findFromVirtual<T extends object>(entityName: string, where: ObjectQuery<T>, options: FindOptions<T, any> | CountOptions<T, any>, type: QueryType): Promise<EntityData<T>[] | number>;
+    protected streamFromVirtual<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, options: StreamOptions<T, any>): AsyncIterableIterator<EntityData<T>>;
     protected wrapVirtualExpressionInSubquery<T extends object>(meta: EntityMetadata<T>, expression: string, where: FilterQuery<T>, options: FindOptions<T, any>, type: QueryType): Promise<T[] | number>;
+    protected wrapVirtualExpressionInSubqueryStream<T extends object>(meta: EntityMetadata<T>, expression: string, where: FilterQuery<T>, options: FindOptions<T, any, any, any>, type: QueryType.SELECT): AsyncIterableIterator<T>;
     mapResult<T extends object>(result: EntityData<T>, meta: EntityMetadata<T>, populate?: PopulateOptions<T>[], qb?: QueryBuilder<T, any, any, any>, map?: Dictionary): EntityData<T> | null;
     private mapJoinedProps;
     count<T extends object>(entityName: string, where: any, options?: CountOptions<T>): Promise<number>;
@@ -39,6 +42,7 @@ export declare abstract class AbstractSqlDriver<Connection extends AbstractSqlCo
     loadFromPivotTable<T extends object, O extends object>(prop: EntityProperty, owners: Primary<O>[][], where?: FilterQuery<any>, orderBy?: OrderDefinition<T>, ctx?: Transaction, options?: FindOptions<T, any, any, any>, pivotJoin?: boolean): Promise<Dictionary<T[]>>;
     private getPivotOrderBy;
     execute<T extends QueryResult | EntityData<AnyEntity> | EntityData<AnyEntity>[] = EntityData<AnyEntity>[]>(query: string | NativeQueryBuilder | RawQueryFragment, params?: any[], method?: 'all' | 'get' | 'run', ctx?: Transaction, loggerContext?: LoggingOptions): Promise<T>;
+    stream<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, options: StreamOptions<T, any, any, any>): AsyncIterableIterator<T>;
     /**
      * 1:1 owner side needs to be marked for population so QB auto-joins the owner id
      */
@@ -53,11 +57,12 @@ export declare abstract class AbstractSqlDriver<Connection extends AbstractSqlCo
      * @internal
      */
     mergeJoinedResult<T extends object>(rawResults: EntityData<T>[], meta: EntityMetadata<T>, joinedProps: PopulateOptions<T>[]): EntityData<T>[];
+    protected shouldHaveColumn<T, U>(meta: EntityMetadata<T>, prop: EntityProperty<U>, populate: readonly PopulateOptions<U>[], fields?: readonly Field<U>[], exclude?: readonly Field<U>[]): boolean;
     protected getFieldsForJoinedLoad<T extends object>(qb: QueryBuilder<T, any, any, any>, meta: EntityMetadata<T>, options: FieldsForJoinedLoadOptions<T>): Field<T>[];
     /**
      * @internal
      */
-    mapPropToFieldNames<T extends object>(qb: QueryBuilder<T, any, any, any>, prop: EntityProperty<T>, tableAlias: string): Field<T>[];
+    mapPropToFieldNames<T extends object>(qb: QueryBuilder<T, any, any, any>, prop: EntityProperty<T>, tableAlias: string, explicitFields?: readonly Field<T>[]): Field<T>[];
     /** @internal */
     createQueryBuilder<T extends object>(entityName: EntityName<T> | QueryBuilder<T, any, any, any>, ctx?: Transaction, preferredConnectionType?: ConnectionType, convertCustomTypes?: boolean, loggerContext?: LoggingOptions, alias?: string, em?: SqlEntityManager): QueryBuilder<T, any, any, any>;
     protected resolveConnectionType(args: {

package/AbstractSqlDriver.js

@@ -1,4 +1,4 @@
-import { ALIAS_REPLACEMENT_RE, DatabaseDriver, EntityManagerType, getOnConflictFields, getOnConflictReturningFields, helper, isRaw, LoadStrategy, parseJsonSafe, QueryFlag, QueryHelper, QueryOrder, raw, RawQueryFragment, ReferenceKind, Utils, getLoadingStrategy, } from '@mikro-orm/core';
+import { ALIAS_REPLACEMENT_RE, DatabaseDriver, EntityManagerType, getLoadingStrategy, getOnConflictFields, getOnConflictReturningFields, helper, isRaw, LoadStrategy, parseJsonSafe, QueryFlag, QueryHelper, QueryOrder, raw, RawQueryFragment, ReferenceKind, Utils, } from '@mikro-orm/core';
 import { QueryBuilder } from './query/QueryBuilder.js';
 import { JoinType, QueryType } from './query/enums.js';
 import { SqlEntityManager } from './SqlEntityManager.js';
@@ -21,15 +21,11 @@ export class AbstractSqlDriver extends DatabaseDriver {
         const EntityManagerClass = this.config.get('entityManager', SqlEntityManager);
         return new EntityManagerClass(this.config, this, this.metadata, useContext);
     }
-    async find(entityName, where, options = {}) {
-        options = { populate: [], orderBy: [], ...options };
-        const meta = this.metadata.find(entityName);
-        if (meta?.virtual) {
-            return this.findVirtual(entityName, where, options);
-        }
+    async createQueryBuilderFromOptions(meta, where, options = {}) {
+        const connectionType = this.resolveConnectionType({ ctx: options.ctx, connectionType: options.connectionType });
         const populate = this.autoJoinOneToOneOwner(meta, options.populate, options.fields);
         const joinedProps = this.joinedProps(meta, populate, options);
-        const qb = this.createQueryBuilder(entityName, options.ctx, options.connectionType, false, options.logging);
+        const qb = this.createQueryBuilder(meta.className, options.ctx, connectionType, false, options.logging, undefined, options.em);
         const fields = this.buildFields(meta, populate, joinedProps, qb, qb.alias, options);
         const orderBy = this.buildOrderBy(qb, meta, populate, options);
         const populateWhere = this.buildPopulateWhere(meta, joinedProps, options);
@@ -66,8 +62,17 @@ export class AbstractSqlDriver extends DatabaseDriver {
         if (options.em) {
             await qb.applyJoinedFilters(options.em, options.filters);
         }
+        return qb;
+    }
+    async find(entityName, where, options = {}) {
+        options = { populate: [], orderBy: [], ...options };
+        const meta = this.metadata.find(entityName);
+        if (meta?.virtual) {
+            return this.findVirtual(entityName, where, options);
+        }
+        const qb = await this.createQueryBuilderFromOptions(meta, where, options);
         const result = await this.rethrow(qb.execute('all'));
-        if (isCursorPagination && !first && !!last) {
+        if (options.last && !options.first) {
             result.reverse();
         }
         return result;
@@ -127,35 +132,49 @@ export class AbstractSqlDriver extends DatabaseDriver {
             const expr = this.platform.formatQuery(res.sql, res.params);
             return this.wrapVirtualExpressionInSubquery(meta, expr, where, options, type);
         }
-        /* v8 ignore next */
+        /* v8 ignore next 2 */
         return res;
     }
-    async wrapVirtualExpressionInSubquery(meta, expression, where, options, type) {
-        const qb = this.createQueryBuilder(meta.className, options?.ctx, options.connectionType, options.convertCustomTypes, options.logging)
-            .indexHint(options.indexHint)
-            .comment(options.comments)
-            .hintComment(options.hintComments);
-        qb.where(where);
-        const { first, last, before, after } = options;
-        const isCursorPagination = [first, last, before, after].some(v => v != null);
-        if (type !== QueryType.COUNT) {
-            if (options.orderBy) {
-                if (isCursorPagination) {
-                    const { orderBy: newOrderBy, where } = this.processCursorOptions(meta, options, options.orderBy);
-                    qb.andWhere(where).orderBy(newOrderBy);
-                }
-                else {
-                    qb.orderBy(options.orderBy);
-                }
-            }
-            qb.limit(options?.limit, options?.offset);
+    async *streamFromVirtual(entityName, where, options) {
+        const meta = this.metadata.get(entityName);
+        /* v8 ignore next 3 */
+        if (!meta.expression) {
+            return;
         }
-        const native = qb.getNativeQuery(false).clear('select');
-        if (type === QueryType.COUNT) {
-            native.count();
+        if (typeof meta.expression === 'string') {
+            yield* this.wrapVirtualExpressionInSubqueryStream(meta, meta.expression, where, options, QueryType.SELECT);
+            return;
+        }
+        const em = this.createEntityManager();
+        em.setTransactionContext(options.ctx);
+        const res = meta.expression(em, where, options, true);
+        if (typeof res === 'string') {
+            yield* this.wrapVirtualExpressionInSubqueryStream(meta, res, where, options, QueryType.SELECT);
+            return;
         }
-        else { // select
-            native.select('*');
+        if (res instanceof QueryBuilder) {
+            yield* this.wrapVirtualExpressionInSubqueryStream(meta, res.getFormattedQuery(), where, options, QueryType.SELECT);
+            return;
+        }
+        if (res instanceof RawQueryFragment) {
+            const expr = this.platform.formatQuery(res.sql, res.params);
+            yield* this.wrapVirtualExpressionInSubqueryStream(meta, expr, where, options, QueryType.SELECT);
+            return;
+        }
+        /* v8 ignore next 2 */
+        yield* res;
+    }
+    async wrapVirtualExpressionInSubquery(meta, expression, where, options, type) {
+        const qb = await this.createQueryBuilderFromOptions(meta, where, options);
+        qb.setFlag(QueryFlag.DISABLE_PAGINATE);
+        const isCursorPagination = [options.first, options.last, options.before, options.after].some(v => v != null);
+        const native = qb.getNativeQuery(false);
+        if (type === QueryType.COUNT) {
+            native
+                .clear('select')
+                .clear('limit')
+                .clear('offset')
+                .count();
         }
         native.from(raw(`(${expression}) as ${this.platform.quoteIdentifier(qb.alias)}`));
         const query = native.compile();
@@ -163,11 +182,23 @@ export class AbstractSqlDriver extends DatabaseDriver {
         if (type === QueryType.COUNT) {
             return res[0].count;
         }
-        if (isCursorPagination && !first && !!last) {
+        if (isCursorPagination && !options.first && !!options.last) {
             res.reverse();
         }
         return res.map(row => this.mapResult(row, meta));
     }
+    async *wrapVirtualExpressionInSubqueryStream(meta, expression, where, options, type) {
+        const qb = await this.createQueryBuilderFromOptions(meta, where, options);
+        qb.unsetFlag(QueryFlag.DISABLE_PAGINATE);
+        const native = qb.getNativeQuery(false);
+        native.from(raw(`(${expression}) as ${this.platform.quoteIdentifier(qb.alias)}`));
+        const query = native.compile();
+        const connectionType = this.resolveConnectionType({ ctx: options.ctx, connectionType: options.connectionType });
+        const res = this.getConnection(connectionType).stream(query.sql, query.params, options.ctx, options.loggerContext);
+        for await (const row of res) {
+            yield this.mapResult(row, meta);
+        }
+    }
     mapResult(result, meta, populate = [], qb, map = {}) {
         const ret = super.mapResult(result, meta);
         /* v8 ignore next 3 */
@@ -221,9 +252,13 @@ export class AbstractSqlDriver extends DatabaseDriver {
                 }
                 return;
             }
+            const mapToPk = !!(ref || prop.mapToPk);
+            const targetProps = mapToPk
+                ? meta2.getPrimaryProps()
+                : meta2.props.filter(prop => this.platform.shouldHaveColumn(prop, hint.children || []));
             // If the primary key value for the relation is null, we know we haven't joined to anything
             // and therefore we don't return any record (since all values would be null)
-            const hasPK = meta2.primaryKeys.every(pk => meta2.properties[pk].fieldNames.every(name => {
+            const hasPK = meta2.getPrimaryProps().every(pk => pk.fieldNames.every(name => {
                 return root[`${relationAlias}__${name}`] != null;
             }));
             if (!hasPK) {
@@ -233,6 +268,11 @@ export class AbstractSqlDriver extends DatabaseDriver {
                 if ([ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(prop.kind)) {
                     result[prop.name] = null;
                 }
+                for (const prop of targetProps) {
+                    for (const name of prop.fieldNames) {
+                        delete root[`${relationAlias}__${name}`];
+                    }
+                }
                 return;
             }
             let relationPojo = {};
@@ -248,10 +288,6 @@ export class AbstractSqlDriver extends DatabaseDriver {
                     relationPojo[prop.name] = root[alias];
                 }
             });
-            const mapToPk = !!(ref || prop.mapToPk);
-            const targetProps = mapToPk
-                ? meta2.getPrimaryProps()
-                : meta2.props.filter(prop => this.platform.shouldHaveColumn(prop, hint.children || []));
             const tz = this.platform.getTimezone();
             for (const prop of targetProps) {
                 if (prop.fieldNames.every(name => typeof root[`${relationAlias}__${name}`] === 'undefined')) {
@@ -292,7 +328,9 @@ export class AbstractSqlDriver extends DatabaseDriver {
             // properties can be mapped to multiple places, e.g. when sharing a column in multiple FKs,
             // so we need to delete them after everything is mapped from given level
             for (const prop of targetProps) {
-                prop.fieldNames.map(name => delete root[`${relationAlias}__${name}`]);
+                for (const name of prop.fieldNames) {
+                    delete root[`${relationAlias}__${name}`];
+                }
             }
             if (mapToPk) {
                 const tmp = Object.values(relationPojo);
@@ -825,6 +863,24 @@ export class AbstractSqlDriver extends DatabaseDriver {
     async execute(query, params = [], method = 'all', ctx, loggerContext) {
         return this.rethrow(this.connection.execute(query, params, method, ctx, loggerContext));
     }
+    async *stream(entityName, where, options) {
+        options = { populate: [], orderBy: [], ...options };
+        const meta = this.metadata.find(entityName);
+        if (meta?.virtual) {
+            yield* this.streamFromVirtual(entityName, where, options);
+            return;
+        }
+        const qb = await this.createQueryBuilderFromOptions(meta, where, options);
+        try {
+            const result = qb.stream(options);
+            for await (const item of result) {
+                yield item;
+            }
+        }
+        catch (e) {
+            throw this.convertException(e);
+        }
+    }
     /**
      * 1:1 owner side needs to be marked for population so QB auto-joins the owner id
      */
@@ -919,26 +975,26 @@ export class AbstractSqlDriver extends DatabaseDriver {
         }
         return res;
     }
+    shouldHaveColumn(meta, prop, populate, fields, exclude) {
+        if (!this.platform.shouldHaveColumn(prop, populate, exclude)) {
+            return false;
+        }
+        if (!fields || fields.includes('*') || prop.primary || meta.root.discriminatorColumn === prop.name) {
+            return true;
+        }
+        return fields.some(f => f === prop.name || f.toString().startsWith(prop.name + '.'));
+    }
     getFieldsForJoinedLoad(qb, meta, options) {
         const fields = [];
         const populate = options.populate ?? [];
         const joinedProps = this.joinedProps(meta, populate, options);
-        const shouldHaveColumn = (meta, prop, populate, fields) => {
-            if (!this.platform.shouldHaveColumn(prop, populate, options.exclude)) {
-                return false;
-            }
-            if (!fields || fields.includes('*') || prop.primary || meta.root.discriminatorColumn === prop.name) {
-                return true;
-            }
-            return fields.some(f => f === prop.name || f.toString().startsWith(prop.name + '.'));
-        };
         const populateWhereAll = options?._populateWhere === 'all' || Utils.isEmpty(options?._populateWhere);
         // root entity is already handled, skip that
         if (options.parentJoinPath) {
             // alias all fields in the primary table
             meta.props
-                .filter(prop => shouldHaveColumn(meta, prop, populate, options.explicitFields))
-                .forEach(prop => fields.push(...this.mapPropToFieldNames(qb, prop, options.parentTableAlias)));
+                .filter(prop => this.shouldHaveColumn(meta, prop, populate, options.explicitFields, options.exclude))
+                .forEach(prop => fields.push(...this.mapPropToFieldNames(qb, prop, options.parentTableAlias, options.explicitFields)));
         }
         for (const hint of joinedProps) {
             const [propName, ref] = hint.field.split(':', 2);
@@ -1003,14 +1059,18 @@ export class AbstractSqlDriver extends DatabaseDriver {
     /**
      * @internal
      */
-    mapPropToFieldNames(qb, prop, tableAlias) {
+    mapPropToFieldNames(qb, prop, tableAlias, explicitFields) {
         if (prop.kind === ReferenceKind.EMBEDDED && !prop.object) {
-            return Object.values(prop.embeddedProps).flatMap(childProp => {
-                return this.mapPropToFieldNames(qb, childProp, tableAlias);
+            return Object.entries(prop.embeddedProps).flatMap(([name, childProp]) => {
+                const childFields = explicitFields ? Utils.extractChildElements(explicitFields, prop.name) : [];
+                if (childFields.length > 0 && !this.shouldHaveColumn(prop.targetMeta, { ...childProp, name }, [], childFields)) {
+                    return [];
+                }
+                return this.mapPropToFieldNames(qb, childProp, tableAlias, childFields);
             });
         }
         const aliased = this.platform.quoteIdentifier(`${tableAlias}__${prop.fieldNames[0]}`);
-        if (prop.customTypes?.some(type => type?.convertToJSValueSQL)) {
+        if (prop.customTypes?.some(type => !!type?.convertToJSValueSQL)) {
             return prop.fieldNames.map((col, idx) => {
                 if (!prop.customTypes[idx]?.convertToJSValueSQL) {
                     return col;
@@ -1295,7 +1355,7 @@ export class AbstractSqlDriver extends DatabaseDriver {
             }
         }
         else if (!Utils.isEmpty(options.exclude) || lazyProps.some(p => !p.formula && (p.kind !== '1:1' || p.owner))) {
-            const props = meta.props.filter(prop => this.platform.shouldHaveColumn(prop, populate, options.exclude, false));
+            const props = meta.props.filter(prop => this.platform.shouldHaveColumn(prop, populate, options.exclude, false, false));
             ret.push(...props.filter(p => !lazyProps.includes(p)).map(p => p.name));
             addFormulas = true;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/knex",
-  "version": "7.0.0-dev.34",
+  "version": "7.0.0-dev.36",
   "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.",
   "type": "module",
   "exports": {
@@ -54,9 +54,9 @@
     "sqlstring": "2.3.3"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^6.5.7"
+    "@mikro-orm/core": "^6.5.8"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.0-dev.34"
+    "@mikro-orm/core": "7.0.0-dev.36"
   }
 }

package/query/QueryBuilder.d.ts

@@ -11,6 +11,30 @@ export interface ExecuteOptions {
     mapResults?: boolean;
     mergeResults?: boolean;
 }
+export interface QBStreamOptions {
+    /**
+     * Results are mapped to entities, if you set `mapResults: false` you will get POJOs instead.
+     *
+     * @default true
+     */
+    mapResults?: boolean;
+    /**
+     * When populating to-many relations, the ORM streams fully merged entities instead of yielding every row.
+     * You can opt out of this behavior by specifying `mergeResults: false`. This will yield every row from
+     * the SQL result, but still mapped to entities, meaning that to-many collections will contain at most
+     * one item, and you will get duplicate root entities when they have multiple items in the populated
+     * collection.
+     *
+     * @default true
+     */
+    mergeResults?: boolean;
+    /**
+     * When enabled, the driver will return the raw database results without renaming the fields to match the entity property names.
+     *
+     * @default false
+     */
+    rawResults?: boolean;
+}
 type AnyString = string & {};
 type Compute<T> = {
     [K in keyof T]: T[K];
@@ -158,6 +182,8 @@ export declare class QueryBuilder<Entity extends object = AnyEntity, RootAlias e
     orWhere(cond: QBFilterQuery<Entity>): this;
     orWhere(cond: string, params?: any[]): this;
     orderBy(orderBy: QBQueryOrderMap<Entity> | QBQueryOrderMap<Entity>[]): SelectQueryBuilder<Entity, RootAlias, Hint, Context>;
+    andOrderBy(orderBy: QBQueryOrderMap<Entity> | QBQueryOrderMap<Entity>[]): SelectQueryBuilder<Entity, RootAlias, Hint, Context>;
+    private processOrderBy;
     groupBy(fields: EntityKeyOrString<Entity> | readonly EntityKeyOrString<Entity>[]): SelectQueryBuilder<Entity, RootAlias, Hint, Context>;
     having(cond?: QBFilterQuery | string, params?: any[], operator?: keyof typeof GroupOperator): SelectQueryBuilder<Entity, RootAlias, Hint, Context>;
     andHaving(cond?: QBFilterQuery | string, params?: any[]): SelectQueryBuilder<Entity, RootAlias, Hint, Context>;
@@ -182,17 +208,17 @@ export declare class QueryBuilder<Entity extends object = AnyEntity, RootAlias e
     /**
      * Adds index hint to the FROM clause.
      */
-    indexHint(sql: string): this;
+    indexHint(sql: string | undefined): this;
     /**
      * Prepend comment to the sql query using the syntax `/* ... *&#8205;/`. Some characters are forbidden such as `/*, *&#8205;/` and `?`.
      */
-    comment(comment: string | string[]): this;
+    comment(comment: string | string[] | undefined): 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;
+    hintComment(comment: string | string[] | undefined): 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.
@@ -245,14 +271,35 @@ export declare class QueryBuilder<Entity extends object = AnyEntity, RootAlias e
      * Use `method` to specify what kind of result you want to get (array/single/meta).
      */
     execute<U = any>(method?: 'all' | 'get' | 'run', options?: ExecuteOptions | boolean): Promise<U>;
+    private getConnection;
+    /**
+     * Executes the query and returns an async iterable (async generator) that yields results one by one.
+     * By default, the results are merged and mapped to entity instances, without adding them to the identity map.
+     * You can disable merging and mapping by passing the options `{ mergeResults: false, mapResults: false }`.
+     * This is useful for processing large datasets without loading everything into memory at once.
+     *
+     * ```ts
+     * const qb = em.createQueryBuilder(Book, 'b');
+     * qb.select('*').where({ title: '1984' }).leftJoinAndSelect('b.author', 'a');
+     *
+     * for await (const book of qb.stream()) {
+     *   // book is an instance of Book entity
+     *   console.log(book.title, book.author.name);
+     * }
+     * ```
+     */
+    stream(options?: QBStreamOptions): AsyncIterableIterator<Loaded<Entity, Hint>>;
     /**
      * Alias for `qb.getResultList()`
      */
     getResult(): Promise<Loaded<Entity, Hint>[]>;
     /**
-     * Executes the query, returning array of results
+     * Executes the query, returning array of results mapped to entity instances.
      */
     getResultList(limit?: number): Promise<Loaded<Entity, Hint>[]>;
+    private propagatePopulateHint;
+    private mapResult;
+    private mapResults;
     /**
      * Executes the query, returning the first result or null
      */

package/query/QueryBuilder.js

@@ -359,8 +359,16 @@ export class QueryBuilder {
         return this.where(cond, params, '$or');
     }
     orderBy(orderBy) {
+        return this.processOrderBy(orderBy, true);
+    }
+    andOrderBy(orderBy) {
+        return this.processOrderBy(orderBy, false);
+    }
+    processOrderBy(orderBy, reset = true) {
         this.ensureNotFinalized();
-        this._orderBy = [];
+        if (reset) {
+            this._orderBy = [];
+        }
         Utils.asArray(orderBy).forEach(o => {
             const processed = QueryHelper.processWhere({
                 where: o,
@@ -676,7 +684,7 @@ export class QueryBuilder {
         options.mapResults ??= true;
         const isRunType = [QueryType.INSERT, QueryType.UPDATE, QueryType.DELETE, QueryType.TRUNCATE].includes(this.type);
         method ??= isRunType ? 'run' : 'all';
-        if (!this.connectionType && isRunType) {
+        if (!this.connectionType && (isRunType || this.context)) {
             this.connectionType = 'write';
         }
         if (!this.finalized && method === 'get' && this.type === QueryType.SELECT) {
@@ -687,10 +695,8 @@ export class QueryBuilder {
         if (cached?.data !== undefined) {
             return cached.data;
         }
-        const write = method === 'run' || !this.platform.getConfig().get('preferReadReplicas');
-        const type = this.connectionType || (write ? 'write' : 'read');
         const loggerContext = { id: this.em?.id, ...this.loggerContext };
-        const res = await this.driver.getConnection(type).execute(query.sql, query.params, method, this.context, loggerContext);
+        const res = await this.getConnection().execute(query.sql, query.params, method, this.context, loggerContext);
         const meta = this.mainAlias.metadata;
         if (!options.mapResults || !meta) {
             await this.em?.storeCache(this._cache, cached, res);
@@ -718,6 +724,64 @@ export class QueryBuilder {
         await this.em?.storeCache(this._cache, cached, mapped);
         return mapped;
     }
+    getConnection() {
+        const write = !this.platform.getConfig().get('preferReadReplicas');
+        const type = this.connectionType || (write ? 'write' : 'read');
+        return this.driver.getConnection(type);
+    }
+    /**
+     * Executes the query and returns an async iterable (async generator) that yields results one by one.
+     * By default, the results are merged and mapped to entity instances, without adding them to the identity map.
+     * You can disable merging and mapping by passing the options `{ mergeResults: false, mapResults: false }`.
+     * This is useful for processing large datasets without loading everything into memory at once.
+     *
+     * ```ts
+     * const qb = em.createQueryBuilder(Book, 'b');
+     * qb.select('*').where({ title: '1984' }).leftJoinAndSelect('b.author', 'a');
+     *
+     * for await (const book of qb.stream()) {
+     *   // book is an instance of Book entity
+     *   console.log(book.title, book.author.name);
+     * }
+     * ```
+     */
+    async *stream(options) {
+        options ??= {};
+        options.mergeResults ??= true;
+        options.mapResults ??= true;
+        const query = this.toQuery();
+        const loggerContext = { id: this.em?.id, ...this.loggerContext };
+        const res = this.getConnection().stream(query.sql, query.params, this.context, loggerContext);
+        const meta = this.mainAlias.metadata;
+        if (options.rawResults || !meta) {
+            yield* res;
+            return;
+        }
+        const joinedProps = this.driver.joinedProps(meta, this._populate);
+        const stack = [];
+        const hash = (data) => {
+            return Utils.getPrimaryKeyHash(meta.primaryKeys.map(pk => data[pk]));
+        };
+        for await (const row of res) {
+            const mapped = this.driver.mapResult(row, meta, this._populate, this);
+            if (!options.mergeResults || joinedProps.length === 0) {
+                yield this.mapResult(mapped, options.mapResults);
+                continue;
+            }
+            if (stack.length > 0 && hash(stack[stack.length - 1]) !== hash(mapped)) {
+                const res = this.driver.mergeJoinedResult(stack, this.mainAlias.metadata, joinedProps);
+                for (const row of res) {
+                    yield this.mapResult(row, options.mapResults);
+                }
+                stack.length = 0;
+            }
+            stack.push(mapped);
+        }
+        if (stack.length > 0) {
+            const merged = this.driver.mergeJoinedResult(stack, this.mainAlias.metadata, joinedProps);
+            yield this.mapResult(merged[0], options.mapResults);
+        }
+    }
     /**
      * Alias for `qb.getResultList()`
      */
@@ -725,29 +789,40 @@ export class QueryBuilder {
         return this.getResultList();
     }
     /**
-     * Executes the query, returning array of results
+     * Executes the query, returning array of results mapped to entity instances.
      */
     async getResultList(limit) {
         await this.em.tryFlush(this.mainAlias.entityName, { flushMode: this.flushMode });
         const res = await this.execute('all', true);
-        const entities = [];
-        function propagatePopulateHint(entity, hint) {
-            helper(entity).__serializationContext.populate = hint.concat(helper(entity).__serializationContext.populate ?? []);
-            hint.forEach(hint => {
-                const [propName] = hint.field.split(':', 2);
-                const value = Reference.unwrapReference(entity[propName]);
-                if (Utils.isEntity(value)) {
-                    propagatePopulateHint(value, hint.children ?? []);
-                }
-                else if (Utils.isCollection(value)) {
-                    value.populated();
-                    value.getItems(false).forEach(item => propagatePopulateHint(item, hint.children ?? []));
-                }
-            });
+        return this.mapResults(res, limit);
+    }
+    propagatePopulateHint(entity, hint) {
+        helper(entity).__serializationContext.populate = hint.concat(helper(entity).__serializationContext.populate ?? []);
+        hint.forEach(hint => {
+            const [propName] = hint.field.split(':', 2);
+            const value = Reference.unwrapReference(entity[propName]);
+            if (Utils.isEntity(value)) {
+                this.propagatePopulateHint(value, hint.children ?? []);
+            }
+            else if (Utils.isCollection(value)) {
+                value.populated();
+                value.getItems(false).forEach(item => this.propagatePopulateHint(item, hint.children ?? []));
+            }
+        });
+    }
+    mapResult(row, map = true) {
+        if (!map) {
+            return row;
         }
-        for (const r of res) {
-            const entity = this.em.map(this.mainAlias.entityName, r, { schema: this._schema });
-            propagatePopulateHint(entity, this._populate);
+        const entity = this.em.map(this.mainAlias.entityName, row, { schema: this._schema });
+        this.propagatePopulateHint(entity, this._populate);
+        return entity;
+    }
+    mapResults(res, limit) {
+        const entities = [];
+        for (const row of res) {
+            const entity = this.mapResult(row);
+            this.propagatePopulateHint(entity, this._populate);
             entities.push(entity);
             if (limit != null && --limit === 0) {
                 break;
@@ -1145,7 +1220,7 @@ export class QueryBuilder {
         if (!this.flags.has(QueryFlag.DISABLE_PAGINATE) && this._groupBy.length === 0 && this.hasToManyJoins()) {
             this.flags.add(QueryFlag.PAGINATE);
         }
-        if (meta && this.flags.has(QueryFlag.PAGINATE) && (this._limit > 0 || this._offset > 0)) {
+        if (meta && this.flags.has(QueryFlag.PAGINATE) && !this.flags.has(QueryFlag.DISABLE_PAGINATE) && (this._limit > 0 || this._offset > 0)) {
             this.wrapPaginateSubQuery(meta);
         }
         if (meta && (this.flags.has(QueryFlag.UPDATE_SUB_QUERY) || this.flags.has(QueryFlag.DELETE_SUB_QUERY))) {
@@ -1267,10 +1342,11 @@ export class QueryBuilder {
                 }
                 else if (join.parent?.type === JoinType.nestedInnerJoin) {
                     const group = lookupParentGroup(join.parent);
+                    const nested = group ?? ((join.parent).nested ??= new Set());
                     join.type = join.type === JoinType.innerJoin
                         ? JoinType.nestedInnerJoin
                         : JoinType.nestedLeftJoin;
-                    group?.add(join);
+                    nested.add(join);
                 }
             }
         }

package/schema/DatabaseSchema.js

@@ -1,4 +1,4 @@
-import { ReferenceKind } from '@mikro-orm/core';
+import { ReferenceKind, RawQueryFragment, } from '@mikro-orm/core';
 import { DatabaseTable } from './DatabaseTable.js';
 /**
  * @internal
@@ -108,9 +108,14 @@ export class DatabaseSchema {
             table.addIndex(meta, { properties: meta.props.filter(prop => prop.primary).map(prop => prop.name) }, 'primary');
             for (const check of meta.checks) {
                 const columnName = check.property ? meta.properties[check.property].fieldNames[0] : undefined;
+                let expression = check.expression;
+                const raw = RawQueryFragment.getKnownFragment(expression);
+                if (raw) {
+                    expression = platform.formatQuery(raw.sql, raw.params);
+                }
                 table.addCheck({
                     name: check.name,
-                    expression: check.expression,
+                    expression,
                     definition: `check (${check.expression})`,
                     columnName,
                 });

package/schema/DatabaseTable.js

@@ -109,33 +109,34 @@ export class DatabaseTable {
             if (prop.referencedTableName.includes('.')) {
                 schema = undefined;
             }
-            this.foreignKeys[constraintName] = {
-                constraintName,
-                columnNames: prop.fieldNames,
-                localTableName: this.getShortestName(false),
-                referencedColumnNames: prop.referencedColumnNames,
-                referencedTableName: schema ? `${schema}.${prop.referencedTableName}` : prop.referencedTableName,
-                createForeignKeyConstraint: prop.createForeignKeyConstraint,
-            };
-            const cascade = prop.cascade.includes(Cascade.REMOVE) || prop.cascade.includes(Cascade.ALL);
-            if (prop.deleteRule || cascade || prop.nullable) {
-                this.foreignKeys[constraintName].deleteRule = prop.deleteRule || (cascade ? 'cascade' : 'set null');
-            }
-            if (prop.updateRule) {
-                this.foreignKeys[constraintName].updateRule = prop.updateRule || 'cascade';
-            }
-            if ((prop.cascade.includes(Cascade.PERSIST) || prop.cascade.includes(Cascade.ALL))) {
-                const hasCascadePath = Object.values(this.foreignKeys).some(fk => {
-                    return fk.constraintName !== constraintName
-                        && ((fk.updateRule && fk.updateRule !== 'no action') || (fk.deleteRule && fk.deleteRule !== 'no action'))
-                        && fk.referencedTableName === this.foreignKeys[constraintName].referencedTableName;
-                });
-                if (!hasCascadePath || this.platform.supportsMultipleCascadePaths()) {
-                    this.foreignKeys[constraintName].updateRule ??= 'cascade';
+            if (prop.createForeignKeyConstraint) {
+                this.foreignKeys[constraintName] = {
+                    constraintName,
+                    columnNames: prop.fieldNames,
+                    localTableName: this.getShortestName(false),
+                    referencedColumnNames: prop.referencedColumnNames,
+                    referencedTableName: schema ? `${schema}.${prop.referencedTableName}` : prop.referencedTableName,
+                };
+                const cascade = prop.cascade.includes(Cascade.REMOVE) || prop.cascade.includes(Cascade.ALL);
+                if (prop.deleteRule || cascade || prop.nullable) {
+                    this.foreignKeys[constraintName].deleteRule = prop.deleteRule || (cascade ? 'cascade' : 'set null');
+                }
+                if (prop.updateRule) {
+                    this.foreignKeys[constraintName].updateRule = prop.updateRule || 'cascade';
+                }
+                if ((prop.cascade.includes(Cascade.PERSIST) || prop.cascade.includes(Cascade.ALL))) {
+                    const hasCascadePath = Object.values(this.foreignKeys).some(fk => {
+                        return fk.constraintName !== constraintName
+                            && ((fk.updateRule && fk.updateRule !== 'no action') || (fk.deleteRule && fk.deleteRule !== 'no action'))
+                            && fk.referencedTableName === this.foreignKeys[constraintName].referencedTableName;
+                    });
+                    if (!hasCascadePath || this.platform.supportsMultipleCascadePaths()) {
+                        this.foreignKeys[constraintName].updateRule ??= 'cascade';
+                    }
+                }
+                if (prop.deferMode) {
+                    this.foreignKeys[constraintName].deferMode = prop.deferMode;
                 }
-            }
-            if (prop.deferMode) {
-                this.foreignKeys[constraintName].deferMode = prop.deferMode;
             }
         }
         if (prop.index) {

package/schema/SchemaComparator.js

@@ -269,7 +269,7 @@ export class SchemaComparator {
         }
         for (const toConstraint of Object.values(toForeignKeys)) {
             tableDifferences.addedForeignKeys[toConstraint.constraintName] = toConstraint;
-            this.log(`FK constraint ${toConstraint.constraintName} added from table ${tableDifferences.name}`, { constraint: toConstraint });
+            this.log(`FK constraint ${toConstraint.constraintName} added to table ${tableDifferences.name}`, { constraint: toConstraint });
             changes++;
         }
         return changes ? tableDifferences : false;

package/schema/SchemaHelper.js

@@ -426,7 +426,7 @@ export class SchemaHelper {
         return `alter table ${table.getQuotedName()} comment = ${this.platform.quoteValue(comment ?? '')}`;
     }
     createForeignKey(table, foreignKey, alterTable = true, inline = false) {
-        if (!this.options.createForeignKeyConstraints || !foreignKey.createForeignKeyConstraint) {
+        if (!this.options.createForeignKeyConstraints) {
             return '';
         }
         const constraintName = this.quote(foreignKey.constraintName);

package/typings.d.ts

@@ -60,7 +60,6 @@ export interface ForeignKey {
     updateRule?: string;
     deleteRule?: string;
     deferMode?: DeferMode;
-    createForeignKeyConstraint: boolean;
 }
 export interface IndexDef {
     columnNames: string[];