@mikro-orm/sql 7.1.0-dev.1 → 7.1.0-dev.3

package/AbstractSqlDriver.d.ts

@@ -52,6 +52,12 @@ export declare abstract class AbstractSqlDriver<Connection extends AbstractSqlCo
     private mapJoinedProp;
     count<T extends object>(entityName: EntityName<T>, where: any, options?: CountOptions<T>): Promise<number>;
     nativeInsert<T extends object>(entityName: EntityName<T>, data: EntityDictionary<T>, options?: NativeInsertUpdateOptions<T>): Promise<QueryResult<T>>;
+    nativeClone<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, overrides?: EntityData<T>, options?: NativeInsertUpdateOptions<T>): Promise<QueryResult<T>>;
+    private nativeCloneSimple;
+    private nativeCloneTPT;
+    private mapCloneOverrides;
+    private buildCloneFields;
+    private getCloneableProps;
     nativeInsertMany<T extends object>(entityName: EntityName<T>, data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T>, transform?: (sql: string) => string): Promise<QueryResult<T>>;
     nativeUpdate<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>, data: EntityDictionary<T>, options?: NativeInsertUpdateOptions<T> & UpsertOptions<T>): Promise<QueryResult<T>>;
     nativeUpdateMany<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>[], data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T> & UpsertManyOptions<T>, transform?: (sql: string, params: any[]) => string): Promise<QueryResult<T>>;

package/AbstractSqlDriver.js

@@ -574,6 +574,109 @@ export class AbstractSqlDriver extends DatabaseDriver {
         await this.processManyToMany(meta, pk, collections, false, options);
         return res;
     }
+    async nativeClone(entityName, where, overrides, options = {}) {
+        options.convertCustomTypes ??= true;
+        const meta = this.metadata.get(entityName);
+        if (meta.inheritanceType === 'tpt' || meta.tptParent) {
+            return this.nativeCloneTPT(meta, where, overrides, options);
+        }
+        return this.nativeCloneSimple(meta, where, overrides, options);
+    }
+    async nativeCloneSimple(meta, where, overrides, options = {}) {
+        const props = this.getCloneableProps(meta);
+        const mappedOverrides = this.mapCloneOverrides(overrides, meta, options);
+        const { selectFields, insertColumns } = this.buildCloneFields(props, mappedOverrides, meta);
+        const selectQb = this.createQueryBuilder(meta.class, options.ctx, 'read', options.convertCustomTypes, options.loggerContext).withSchema(this.getSchemaName(meta, options));
+        selectQb.select(selectFields).where(where);
+        const insertQb = this.createQueryBuilder(meta.class, options.ctx, 'write', options.convertCustomTypes, options.loggerContext).withSchema(this.getSchemaName(meta, options));
+        return this.rethrow(insertQb
+            .insertFrom(selectQb, { columns: insertColumns })
+            .execute('run', false));
+    }
+    async nativeCloneTPT(leafMeta, where, overrides, options = {}) {
+        const hierarchy = [];
+        let current = leafMeta;
+        while (current) {
+            hierarchy.unshift(current);
+            current = current.tptParent;
+        }
+        const rootMeta = hierarchy[0];
+        let newPk;
+        let rootResult;
+        for (const tableMeta of hierarchy) {
+            const props = this.getCloneableProps(tableMeta, true);
+            const mappedOverrides = this.mapCloneOverrides(overrides, tableMeta, options);
+            const { selectFields, insertColumns } = this.buildCloneFields(props, mappedOverrides, tableMeta);
+            // For child tables, prepend the new PK value
+            if (tableMeta !== rootMeta && newPk != null) {
+                for (const pkName of tableMeta.primaryKeys) {
+                    const prop = tableMeta.properties[pkName];
+                    for (const fieldName of prop.fieldNames) {
+                        insertColumns.unshift(fieldName);
+                        selectFields.unshift(raw('? as ??', [newPk, fieldName]));
+                    }
+                }
+            }
+            const sourceWhere = tableMeta === rootMeta ? where : (Utils.extractPK(where, tableMeta) ?? where);
+            const selectQb = this.createQueryBuilder(tableMeta.class, options.ctx, 'read', options.convertCustomTypes, options.loggerContext).withSchema(this.getSchemaName(tableMeta, options));
+            selectQb.select(selectFields).where(sourceWhere);
+            const insertQb = this.createQueryBuilder(tableMeta.class, options.ctx, 'write', options.convertCustomTypes, options.loggerContext).withSchema(this.getSchemaName(tableMeta, options));
+            const res = await this.rethrow(insertQb
+                .insertFrom(selectQb, { columns: insertColumns })
+                .execute('run', false));
+            if (tableMeta === rootMeta) {
+                rootResult = res;
+                newPk = res.insertId ?? res.row?.[rootMeta.primaryKeys[0]];
+            }
+        }
+        return rootResult;
+    }
+    mapCloneOverrides(overrides, meta, options) {
+        if (!overrides) {
+            return undefined;
+        }
+        return super.mapDataToFieldNames(overrides, true, meta.properties, options.convertCustomTypes);
+    }
+    buildCloneFields(props, mappedOverrides, meta) {
+        const selectFields = [];
+        const insertColumns = [];
+        for (const prop of props) {
+            for (const fieldName of prop.fieldNames) {
+                insertColumns.push(fieldName);
+                if (mappedOverrides && fieldName in mappedOverrides) {
+                    selectFields.push(raw('? as ??', [mappedOverrides[fieldName], fieldName]));
+                }
+                else if (meta.versionProperty === prop.name) {
+                    const initial = prop.runtimeType === 'Date' ? new Date() : 1;
+                    selectFields.push(raw('? as ??', [initial, fieldName]));
+                }
+                else {
+                    selectFields.push(fieldName);
+                }
+            }
+        }
+        return { selectFields, insertColumns };
+    }
+    getCloneableProps(meta, ownProps) {
+        return (ownProps ? (meta.ownProps ?? meta.props) : meta.props).filter(prop => {
+            if (prop.persist === false) {
+                return false;
+            }
+            if (prop.primary) {
+                return false;
+            }
+            if (!prop.fieldNames?.length) {
+                return false;
+            }
+            if ([ReferenceKind.ONE_TO_MANY, ReferenceKind.MANY_TO_MANY].includes(prop.kind)) {
+                return false;
+            }
+            if (prop.kind === ReferenceKind.EMBEDDED && !prop.object) {
+                return false;
+            }
+            return true;
+        });
+    }
     async nativeInsertMany(entityName, data, options = {}, transform) {
         options.processCollections ??= true;
         options.convertCustomTypes ??= true;

package/dialects/mssql/MsSqlNativeQueryBuilder.js

@@ -56,6 +56,10 @@ export class MsSqlNativeQueryBuilder extends NativeQueryBuilder {
         return this.combineParts();
     }
     compileInsert() {
+        if (this.options.insertSubQuery) {
+            super.compileInsert();
+            return;
+        }
         if (!this.options.data) {
             throw new Error('No data provided');
         }

package/dialects/mysql/MySqlNativeQueryBuilder.js

@@ -3,6 +3,17 @@ import { NativeQueryBuilder } from '../../query/NativeQueryBuilder.js';
 /** @internal */
 export class MySqlNativeQueryBuilder extends NativeQueryBuilder {
     compileInsert() {
+        if (this.options.insertSubQuery) {
+            super.compileInsert();
+            // Inject 'ignore' after 'insert' for MySQL's INSERT IGNORE ... SELECT syntax
+            if (this.options.onConflict?.ignore) {
+                const insertIdx = this.parts.indexOf('insert');
+                if (insertIdx >= 0) {
+                    this.parts.splice(insertIdx + 1, 0, 'ignore');
+                }
+            }
+            return;
+        }
         if (!this.options.data) {
             throw new Error('No data provided');
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/sql",
-  "version": "7.1.0-dev.1",
+  "version": "7.1.0-dev.3",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "keywords": [
     "data-mapper",
@@ -53,7 +53,7 @@
     "@mikro-orm/core": "^7.0.11"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.1.0-dev.1"
+    "@mikro-orm/core": "7.1.0-dev.3"
   },
   "engines": {
     "node": ">= 22.17.0"

package/query/NativeQueryBuilder.d.ts

@@ -37,6 +37,11 @@ interface Options {
     limit?: number;
     offset?: number;
     data?: Dictionary;
+    insertSubQuery?: {
+        sql: string;
+        params: unknown[];
+        columns: string[];
+    };
     onConflict?: OnConflictClause;
     lockMode?: LockMode;
     lockTables?: string[];
@@ -105,6 +110,7 @@ export declare class NativeQueryBuilder implements Subquery {
     limit(limit: number): this;
     offset(offset: number): this;
     insert(data: Dictionary): this;
+    insertSelect(columns: string[], subQuery: NativeQueryBuilder | RawQueryFragment): this;
     update(data: Dictionary): this;
     delete(): this;
     truncate(): this;

package/query/NativeQueryBuilder.js

@@ -215,6 +215,12 @@ export class NativeQueryBuilder {
         this.options.data = data;
         return this;
     }
+    insertSelect(columns, subQuery) {
+        this.type = QueryType.INSERT;
+        const { sql, params } = subQuery instanceof NativeQueryBuilder ? subQuery.compile() : { sql: subQuery.sql, params: [...subQuery.params] };
+        this.options.insertSubQuery = { sql, params, columns: columns.map(c => this.quote(c)) };
+        return this;
+    }
     update(data) {
         this.type = QueryType.UPDATE;
         this.options.data ??= {};
@@ -352,12 +358,21 @@ export class NativeQueryBuilder {
         return fields;
     }
     compileInsert() {
-        if (!this.options.data) {
+        if (!this.options.data && !this.options.insertSubQuery) {
             throw new Error('No data provided');
         }
         this.parts.push('insert');
         this.addHintComment();
         this.parts.push(`into ${this.getTableName()}`);
+        if (this.options.insertSubQuery) {
+            if (this.options.insertSubQuery.columns.length) {
+                this.parts.push(`(${this.options.insertSubQuery.columns.join(', ')})`);
+            }
+            this.addOutputClause('inserted');
+            this.parts.push(this.options.insertSubQuery.sql);
+            this.params.push(...this.options.insertSubQuery.params);
+            return;
+        }
         if (Object.keys(this.options.data).length === 0) {
             this.addOutputClause('inserted');
             this.parts.push('default values');

package/query/QueryBuilder.d.ts

@@ -158,6 +158,8 @@ export interface QBState<Entity extends object> {
     schema?: string;
     cond: Dictionary;
     data?: Dictionary;
+    insertSubQuery?: QueryBuilder<any>;
+    insertColumns?: string[];
     orderBy: QueryOrderMap<Entity>[];
     groupBy: InternalField<Entity>[];
     having: Dictionary;
@@ -324,6 +326,35 @@ export declare class QueryBuilder<Entity extends object = AnyEntity, RootAlias e
      * ```
      */
     insert(data: RequiredEntityData<Entity> | RequiredEntityData<Entity>[]): InsertQueryBuilder<Entity, RootAlias, Context>;
+    /**
+     * Creates an INSERT ... SELECT query that copies rows from the source query.
+     *
+     * Column resolution (3 tiers):
+     * 1. No explicit select on source, no explicit columns → all cloneable columns derived from entity metadata
+     * 2. Explicit select on source, no explicit columns → columns derived from selected field names
+     * 3. Explicit `columns` option → user-provided column list
+     *
+     * @example
+     * ```ts
+     * // Clone all fields (columns auto-derived from metadata)
+     * const source = em.createQueryBuilder(User).where({ id: 1 });
+     * await em.createQueryBuilder(User).insertFrom(source).execute();
+     *
+     * // Clone with overrides via raw() aliases
+     * const source = em.createQueryBuilder(User)
+     *   .select(['name', raw("'new@email.com'").as('email')])
+     *   .where({ id: 1 });
+     * await em.createQueryBuilder(User).insertFrom(source).execute();
+     *
+     * // Explicit columns for full control
+     * await em.createQueryBuilder(User)
+     *   .insertFrom(source, { columns: ['name', 'email'] })
+     *   .execute();
+     * ```
+     */
+    insertFrom(subQuery: QueryBuilder<any>, options?: {
+        columns?: Field<Entity, RootAlias, Context>[];
+    }): InsertQueryBuilder<Entity, RootAlias, Context>;
     /**
      * Creates an UPDATE query with the given data.
      * Use `where()` to specify which rows to update.
@@ -877,6 +908,16 @@ export declare class QueryBuilder<Entity extends object = AnyEntity, RootAlias e
     protected resolveNestedPath(field: string): string | string[];
     protected init(type: QueryType, data?: any, cond?: any): this;
     private getQueryBase;
+    /**
+     * Resolves the INSERT column list for `insertFrom()`.
+     *
+     * Tier 1: Explicit `insertColumns` from `options.columns` → map property names to field names
+     * Tier 2: Source QB has explicit select fields → derive from those
+     * Tier 3: Derive from target entity metadata (all cloneable columns), auto-populate source select
+     */
+    private resolveInsertFromColumns;
+    /** Returns properties that are safe to clone (persistable, non-PK, non-generated). */
+    private getCloneableProps;
     private applyDiscriminatorCondition;
     /**
      * Ensures TPT joins are applied. Can be called early before finalize() to populate

package/query/QueryBuilder.js

@@ -159,6 +159,41 @@ export class QueryBuilder {
     insert(data) {
         return this.init(QueryType.INSERT, data);
     }
+    /**
+     * Creates an INSERT ... SELECT query that copies rows from the source query.
+     *
+     * Column resolution (3 tiers):
+     * 1. No explicit select on source, no explicit columns → all cloneable columns derived from entity metadata
+     * 2. Explicit select on source, no explicit columns → columns derived from selected field names
+     * 3. Explicit `columns` option → user-provided column list
+     *
+     * @example
+     * ```ts
+     * // Clone all fields (columns auto-derived from metadata)
+     * const source = em.createQueryBuilder(User).where({ id: 1 });
+     * await em.createQueryBuilder(User).insertFrom(source).execute();
+     *
+     * // Clone with overrides via raw() aliases
+     * const source = em.createQueryBuilder(User)
+     *   .select(['name', raw("'new@email.com'").as('email')])
+     *   .where({ id: 1 });
+     * await em.createQueryBuilder(User).insertFrom(source).execute();
+     *
+     * // Explicit columns for full control
+     * await em.createQueryBuilder(User)
+     *   .insertFrom(source, { columns: ['name', 'email'] })
+     *   .execute();
+     * ```
+     */
+    insertFrom(subQuery, options) {
+        this.ensureNotFinalized();
+        this.#state.type = QueryType.INSERT;
+        this.#state.insertSubQuery = subQuery;
+        if (options?.columns) {
+            this.#state.insertColumns = Utils.asArray(options.columns);
+        }
+        return this;
+    }
     /**
      * Creates an UPDATE query with the given data.
      * Use `where()` to specify which rows to update.
@@ -789,12 +824,15 @@ export class QueryBuilder {
         if (this.#state.lockMode) {
             this.helper.getLockSQL(qb, this.#state.lockMode, this.#state.lockTables, this.#state.joins);
         }
-        this.processReturningStatement(qb, this.mainAlias.meta, this.#state.data, this.#state.returning);
+        this.processReturningStatement(qb, this.mainAlias.meta, this.#state.insertSubQuery ? undefined : this.#state.data, this.#state.returning);
         return (this.#query.qb = qb);
     }
     processReturningStatement(qb, meta, data, returning) {
         const usesReturningStatement = this.platform.usesReturningStatement() || this.platform.usesOutputStatement();
-        if (!meta || !data || !usesReturningStatement) {
+        if (!meta || !usesReturningStatement) {
+            return;
+        }
+        if (!data && !this.#state.insertSubQuery) {
             return;
         }
         // always respect explicit returning hint
@@ -805,13 +843,13 @@ export class QueryBuilder {
         if (this.type === QueryType.INSERT) {
             const returningProps = meta.hydrateProps
                 .filter(prop => prop.returning || (prop.persist !== false && ((prop.primary && prop.autoincrement) || prop.defaultRaw)))
-                .filter(prop => !(prop.name in data));
+                .filter(prop => !data || !(prop.name in data));
             if (returningProps.length > 0) {
                 qb.returning(Utils.flatten(returningProps.map(prop => prop.fieldNames)));
             }
             return;
         }
-        if (this.type === QueryType.UPDATE) {
+        if (this.type === QueryType.UPDATE && data) {
             const returningProps = meta.hydrateProps.filter(prop => prop.fieldNames && isRaw(data[prop.fieldNames[0]]));
             if (returningProps.length > 0) {
                 qb.returning(returningProps.flatMap((prop) => {
@@ -1603,7 +1641,14 @@ export class QueryBuilder {
                 break;
             }
             case QueryType.INSERT:
-                qb.insert(this.#state.data);
+                if (this.#state.insertSubQuery) {
+                    const columns = this.resolveInsertFromColumns();
+                    const compiled = this.#state.insertSubQuery.toQuery();
+                    qb.insertSelect(columns, raw(compiled.sql, compiled.params));
+                }
+                else {
+                    qb.insert(this.#state.data);
+                }
                 break;
             case QueryType.UPDATE:
                 qb.update(this.#state.data);
@@ -1619,6 +1664,78 @@ export class QueryBuilder {
         }
         return qb;
     }
+    /**
+     * Resolves the INSERT column list for `insertFrom()`.
+     *
+     * Tier 1: Explicit `insertColumns` from `options.columns` → map property names to field names
+     * Tier 2: Source QB has explicit select fields → derive from those
+     * Tier 3: Derive from target entity metadata (all cloneable columns), auto-populate source select
+     */
+    resolveInsertFromColumns() {
+        const meta = this.mainAlias.meta;
+        const subQuery = this.#state.insertSubQuery;
+        // Tier 1: explicit columns
+        if (this.#state.insertColumns?.length) {
+            return this.#state.insertColumns.flatMap(col => {
+                const prop = meta?.properties[col];
+                return prop?.fieldNames ?? [col];
+            });
+        }
+        // Tier 2: source QB has explicit select fields
+        const sourceFields = subQuery.state.fields;
+        if (sourceFields && subQuery.state.type === QueryType.SELECT) {
+            return sourceFields
+                .filter((field) => typeof field === 'string' || isRaw(field))
+                .flatMap((field) => {
+                if (typeof field === 'string') {
+                    // Strip alias prefix like 'a0.'
+                    const bare = field.replace(/^\w+\./, '');
+                    const prop = meta?.properties[bare];
+                    return prop?.fieldNames ?? [bare];
+                }
+                // RawQueryFragment with alias: raw('...').as('name')
+                const alias = String(field.params[field.params.length - 1]);
+                const prop = meta?.properties[alias];
+                return prop?.fieldNames ?? [alias];
+            });
+        }
+        // Tier 3: derive from metadata — all cloneable columns
+        const cloneableProps = this.getCloneableProps(meta);
+        const selectFields = [];
+        const columns = [];
+        for (const prop of cloneableProps) {
+            for (const fieldName of prop.fieldNames) {
+                columns.push(fieldName);
+                selectFields.push(fieldName);
+            }
+        }
+        // Auto-populate source select with matching fields
+        if (!sourceFields) {
+            subQuery.select(selectFields);
+        }
+        return columns;
+    }
+    /** Returns properties that are safe to clone (persistable, non-PK, non-generated). */
+    getCloneableProps(meta) {
+        return meta.props.filter(prop => {
+            if (prop.persist === false) {
+                return false;
+            }
+            if (prop.primary) {
+                return false;
+            }
+            if (!prop.fieldNames?.length) {
+                return false;
+            }
+            if ([ReferenceKind.ONE_TO_MANY, ReferenceKind.MANY_TO_MANY].includes(prop.kind)) {
+                return false;
+            }
+            if (prop.kind === ReferenceKind.EMBEDDED && !prop.object) {
+                return false;
+            }
+            return true;
+        });
+    }
     applyDiscriminatorCondition() {
         const meta = this.mainAlias.meta;
         if (meta.root.inheritanceType !== 'sti' || !meta.discriminatorValue) {