@mikro-orm/knex 6.0.0-dev.45 → 6.0.0-dev.46

package/AbstractSqlDriver.js

@@ -124,7 +124,7 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
         qb.where(where);
         const kqb = qb.getKnexQuery().clear('select');
         if (type === query_1.QueryType.COUNT) {
-            kqb.select(qb.raw('count(*) as count'));
+            kqb.select(this.connection.getKnex().raw('count(*) as count'));
         }
         else { // select
             kqb.select('*');
@@ -294,9 +294,10 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
                 return '(' + (keys.join(', ') || 'default') + ')';
             }).join(', ');
         }
-        if (this.platform.usesReturningStatement()) {
-            /* istanbul ignore next */
-            const returningProps = meta.hydrateProps.filter(prop => prop.persist !== false && (prop.primary || prop.defaultRaw));
+        if (meta && this.platform.usesReturningStatement()) {
+            const returningProps = meta.hydrateProps
+                .filter(prop => prop.persist !== false && ((prop.primary && prop.autoincrement) || prop.defaultRaw))
+                .filter(prop => !(prop.name in data[0]) || core_1.Utils.isRawSql(data[0][prop.name]));
             const returningFields = core_1.Utils.flatten(returningProps.map(prop => prop.fieldNames));
             /* istanbul ignore next */
             sql += returningFields.length > 0 ? ` returning ${returningFields.map(field => this.platform.quoteIdentifier(field)).join(', ')}` : '';
@@ -363,7 +364,15 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
         }
         const collections = options.processCollections ? data.map(d => this.extractManyToMany(entityName, d)) : [];
         const keys = new Set();
-        data.forEach(row => core_1.Utils.keys(row).forEach(k => keys.add(k)));
+        const returning = new Set();
+        data.forEach(row => {
+            core_1.Utils.keys(row).forEach(k => {
+                keys.add(k);
+                if (core_1.Utils.isRawSql(row[k])) {
+                    returning.add(k);
+                }
+            });
+        });
         const pkCond = core_1.Utils.flatten(meta.primaryKeys.map(pk => meta.properties[pk].fieldNames)).map(pk => `${this.platform.quoteIdentifier(pk)} = ?`).join(' and ');
         const params = [];
         let sql = `update ${this.getTableName(meta, options)} set `;
@@ -423,6 +432,11 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
             return '?';
         });
         sql += ` in (${conds.join(', ')})`;
+        if (this.platform.usesReturningStatement() && returning.size > 0) {
+            const returningFields = core_1.Utils.flatten([...returning].map(prop => meta.properties[prop].fieldNames));
+            /* istanbul ignore next */
+            sql += returningFields.length > 0 ? ` returning ${returningFields.map(field => this.platform.quoteIdentifier(field)).join(', ')}` : '';
+        }
         const res = await this.rethrow(this.execute(sql, params, 'run', options.ctx));
         for (let i = 0; i < collections.length; i++) {
             await this.processManyToMany(meta, where[i], collections[i], false, options);
@@ -612,7 +626,7 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
         const aliased = qb.ref(tableAlias ? `${tableAlias}__${prop.fieldNames[0]}` : prop.fieldNames[0]).toString();
         if (prop.customType?.convertToJSValueSQL && tableAlias) {
             const prefixed = qb.ref(prop.fieldNames[0]).withSchema(tableAlias).toString();
-            return [qb.raw(prop.customType.convertToJSValueSQL(prefixed, this.platform) + ' as ' + aliased).toString()];
+            return [prop.customType.convertToJSValueSQL(prefixed, this.platform) + ' as ' + aliased];
         }
         if (prop.formula) {
             const alias = qb.ref(tableAlias ?? qb.alias).toString();

package/AbstractSqlPlatform.js

@@ -27,6 +27,9 @@ class AbstractSqlPlatform extends core_1.Platform {
         return new schema_1.SqlSchemaGenerator(em ?? driver);
     }
     quoteValue(value) {
+        if (core_1.Utils.isRawSql(value)) {
+            return this.formatQuery(value.sql, value.params ?? []);
+        }
         if (this.isRaw(value)) {
             return value;
         }

package/SqlEntityManager.d.ts

@@ -16,10 +16,6 @@ export declare class SqlEntityManager<D extends AbstractSqlDriver = AbstractSqlD
      * Shortcut for `createQueryBuilder()`
      */
     qb<T extends object>(entityName: EntityName<T>, alias?: string, type?: ConnectionType): QueryBuilder<T>;
-    /**
-     * Creates raw SQL query that won't be escaped when used as a parameter.
-     */
-    raw<R = Knex.Raw>(sql: string, bindings?: Knex.RawBinding[] | Knex.ValueDict): R;
     /**
      * Returns configured knex instance.
      */

package/SqlEntityManager.js

@@ -20,14 +20,6 @@ class SqlEntityManager extends core_1.EntityManager {
     qb(entityName, alias, type) {
         return this.createQueryBuilder(entityName, alias, type);
     }
-    /**
-     * Creates raw SQL query that won't be escaped when used as a parameter.
-     */
-    raw(sql, bindings = []) {
-        const raw = this.getKnex().raw(sql, bindings);
-        raw.__raw = true; // tag it as there is now way to check via `instanceof`
-        return raw;
-    }
     /**
      * Returns configured knex instance.
      */

package/index.mjs

@@ -138,6 +138,7 @@ 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 Reference = mod.Reference;
 export const ReferenceKind = mod.ReferenceKind;
@@ -187,6 +188,7 @@ export const equals = mod.equals;
 export const expr = mod.expr;
 export const helper = mod.helper;
 export const knex = mod.knex;
+export const raw = mod.raw;
 export const ref = mod.ref;
 export const rel = mod.rel;
 export const serialize = mod.serialize;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/knex",
-  "version": "6.0.0-dev.45",
+  "version": "6.0.0-dev.46",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "index.js",
   "module": "index.mjs",
@@ -66,6 +66,6 @@
     "@mikro-orm/core": "^5.6.12"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "~6.0.0-dev.45"
+    "@mikro-orm/core": "~6.0.0-dev.46"
   }
 }

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);
         }

package/query/QueryBuilder.d.ts

@@ -116,7 +116,6 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
     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;

package/query/QueryBuilder.js

@@ -116,7 +116,7 @@ class QueryBuilder {
             this._fields = this.mainAlias.metadata.primaryKeys;
         }
         else {
-            this._fields = [this.raw('*')];
+            this._fields = [(0, core_1.raw)('*')];
         }
         if (distinct) {
             this.flags.add(core_1.QueryFlag.DISTINCT);
@@ -278,11 +278,6 @@ class QueryBuilder {
     ref(field) {
         return this.knex.ref(field);
     }
-    raw(sql, bindings = []) {
-        const raw = this.knex.raw(sql, bindings);
-        raw.__raw = true; // tag it as there is now way to check via `instanceof`
-        return raw;
-    }
     limit(limit, offset = 0) {
         this.ensureNotFinalized();
         this._limit = limit;
@@ -374,7 +369,7 @@ class QueryBuilder {
         if (this.lockMode) {
             this.helper.getLockSQL(qb, this.lockMode, this.lockTables);
         }
-        this.helper.finalize(this.type ?? enums_1.QueryType.SELECT, qb, this.mainAlias.metadata);
+        this.helper.finalize(this.type ?? enums_1.QueryType.SELECT, qb, this.mainAlias.metadata, this._data);
         return qb;
     }
     /**

package/query/QueryBuilderHelper.d.ts

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

package/query/QueryBuilderHelper.js

@@ -19,6 +19,9 @@ class QueryBuilderHelper {
         this.metadata = this.driver.getMetadata();
     }
     mapper(field, type = enums_1.QueryType.SELECT, value, alias) {
+        if (core_1.Utils.isRawSql(field)) {
+            return this.platform.formatQuery(field.sql, field.params ?? []);
+        }
         if (typeof field !== 'string') {
             return field;
         }
@@ -460,11 +463,23 @@ class QueryBuilderHelper {
         });
         return ret.join(', ');
     }
-    finalize(type, qb, meta) {
-        const useReturningStatement = type === enums_1.QueryType.INSERT && this.platform.usesReturningStatement() && meta && !meta.compositePK;
-        if (useReturningStatement) {
-            const returningProps = meta.hydrateProps.filter(prop => prop.persist !== false && (prop.primary || prop.defaultRaw));
-            qb.returning(core_1.Utils.flatten(returningProps.map(prop => prop.fieldNames)));
+    finalize(type, qb, meta, data) {
+        if (!meta || !data || !this.platform.usesReturningStatement()) {
+            return;
+        }
+        if (type === enums_1.QueryType.INSERT) {
+            const returningProps = meta.hydrateProps
+                .filter(prop => prop.persist !== false && ((prop.primary && prop.autoincrement) || prop.defaultRaw))
+                .filter(prop => !(prop.name in data) || core_1.Utils.isRawSql(data[prop.name]));
+            if (returningProps.length > 0) {
+                qb.returning(core_1.Utils.flatten(returningProps.map(prop => prop.fieldNames)));
+            }
+        }
+        if (type === enums_1.QueryType.UPDATE) {
+            const returningProps = meta.hydrateProps.filter(prop => core_1.Utils.isRawSql(data[prop.name]));
+            if (returningProps.length > 0) {
+                qb.returning(core_1.Utils.flatten(returningProps.map(prop => prop.fieldNames)));
+            }
         }
     }
     splitField(field, greedyAlias = false) {