@mikro-orm/knex 6.0.0-dev.60 → 6.0.0-dev.62

package/AbstractSqlConnection.d.ts

@@ -1,5 +1,5 @@
 import type { Knex } from 'knex';
-import type { AnyEntity, Configuration, ConnectionOptions, EntityData, IsolationLevel, QueryResult, Transaction, TransactionEventBroadcaster } from '@mikro-orm/core';
+import type { AnyEntity, Configuration, ConnectionOptions, EntityData, IsolationLevel, LoggerContext, QueryResult, Transaction, TransactionEventBroadcaster } from '@mikro-orm/core';
 import { Connection } from '@mikro-orm/core';
 import type { AbstractSqlPlatform } from './AbstractSqlPlatform';
 export declare abstract class AbstractSqlConnection extends Connection {
@@ -25,7 +25,7 @@ export declare abstract class AbstractSqlConnection extends Connection {
     }): Promise<Knex.Transaction>;
     commit(ctx: Knex.Transaction, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
     rollback(ctx: Knex.Transaction, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
-    execute<T extends QueryResult | EntityData<AnyEntity> | EntityData<AnyEntity>[] = EntityData<AnyEntity>[]>(queryOrKnex: string | Knex.QueryBuilder | Knex.Raw, params?: unknown[], method?: 'all' | 'get' | 'run', ctx?: Transaction): Promise<T>;
+    execute<T extends QueryResult | EntityData<AnyEntity> | EntityData<AnyEntity>[] = EntityData<AnyEntity>[]>(queryOrKnex: string | Knex.QueryBuilder | Knex.Raw, params?: unknown[], method?: 'all' | 'get' | 'run', ctx?: Transaction, loggerContext?: LoggerContext): Promise<T>;
     /**
      * Execute raw SQL queries from file
      */

package/AbstractSqlConnection.js

@@ -83,7 +83,7 @@ class AbstractSqlConnection extends core_1.Connection {
             await eventBroadcaster?.dispatchEvent(core_1.EventType.afterTransactionRollback, ctx);
         }
     }
-    async execute(queryOrKnex, params = [], method = 'all', ctx) {
+    async execute(queryOrKnex, params = [], method = 'all', ctx, loggerContext) {
         await this.ensureConnection();
         if (core_1.Utils.isObject(queryOrKnex)) {
             ctx ??= (queryOrKnex.client.transacting ? queryOrKnex : null);
@@ -99,7 +99,7 @@ class AbstractSqlConnection extends core_1.Connection {
                 query.transacting(ctx);
             }
             return query;
-        }, { query: queryOrKnex, params });
+        }, { query: queryOrKnex, params, ...loggerContext });
         return this.transformRawResult(res, method);
     }
     /**

package/AbstractSqlDriver.d.ts

@@ -1,5 +1,5 @@
 import type { Knex } from 'knex';
-import type { AnyEntity, Collection, ConnectionType, Configuration, Constructor, CountOptions, DeleteOptions, Dictionary, DriverMethodOptions, EntityData, EntityDictionary, EntityField, EntityMetadata, EntityName, EntityProperty, FilterQuery, FindOneOptions, FindOptions, IDatabaseDriver, LockOptions, NativeInsertUpdateManyOptions, NativeInsertUpdateOptions, PopulateOptions, Primary, QueryOrderMap, QueryResult, Transaction, OrderDefinition } from '@mikro-orm/core';
+import type { AnyEntity, Collection, ConnectionType, Configuration, Constructor, CountOptions, DeleteOptions, Dictionary, DriverMethodOptions, EntityData, EntityDictionary, EntityField, EntityMetadata, EntityName, EntityProperty, FilterQuery, FindOneOptions, FindOptions, IDatabaseDriver, LockOptions, NativeInsertUpdateManyOptions, NativeInsertUpdateOptions, PopulateOptions, Primary, QueryOrderMap, QueryResult, Transaction, OrderDefinition, LoggerContext } from '@mikro-orm/core';
 import { DatabaseDriver, EntityManagerType } from '@mikro-orm/core';
 import type { AbstractSqlConnection } from './AbstractSqlConnection';
 import type { AbstractSqlPlatform } from './AbstractSqlPlatform';
@@ -48,7 +48,7 @@ export declare abstract class AbstractSqlDriver<Connection extends AbstractSqlCo
      */
     mapPropToFieldNames<T extends object>(qb: QueryBuilder<T>, prop: EntityProperty<T>, tableAlias?: string): Field<T>[];
     /** @internal */
-    createQueryBuilder<T extends object>(entityName: EntityName<T> | QueryBuilder<T>, ctx?: Transaction<Knex.Transaction>, preferredConnectionType?: ConnectionType, convertCustomTypes?: boolean): QueryBuilder<T>;
+    createQueryBuilder<T extends object>(entityName: EntityName<T> | QueryBuilder<T>, ctx?: Transaction<Knex.Transaction>, preferredConnectionType?: ConnectionType, convertCustomTypes?: boolean, loggerContext?: LoggerContext): QueryBuilder<T>;
     protected resolveConnectionType(args: {
         ctx?: Transaction<Knex.Transaction>;
         connectionType?: ConnectionType;

package/AbstractSqlDriver.js

@@ -26,7 +26,7 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
         }
         const populate = this.autoJoinOneToOneOwner(meta, options.populate, options.fields);
         const joinedProps = this.joinedProps(meta, populate);
-        const qb = this.createQueryBuilder(entityName, options.ctx, options.connectionType, false);
+        const qb = this.createQueryBuilder(entityName, options.ctx, options.connectionType, false, options.loggerContext);
         const fields = this.buildFields(meta, populate, joinedProps, qb, options.fields);
         const joinedPropsOrderBy = this.buildJoinedPropsOrderBy(entityName, qb, meta, joinedProps);
         const orderBy = [...core_1.Utils.asArray(options.orderBy), ...joinedPropsOrderBy];
@@ -650,9 +650,9 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
         return prop.fieldNames;
     }
     /** @internal */
-    createQueryBuilder(entityName, ctx, preferredConnectionType, convertCustomTypes) {
+    createQueryBuilder(entityName, ctx, preferredConnectionType, convertCustomTypes, loggerContext) {
         const connectionType = this.resolveConnectionType({ ctx, connectionType: preferredConnectionType });
-        const qb = new query_1.QueryBuilder(entityName, this.metadata, this, ctx, undefined, connectionType);
+        const qb = new query_1.QueryBuilder(entityName, this.metadata, this, ctx, undefined, connectionType, undefined, loggerContext);
         if (!convertCustomTypes) {
             qb.unsetFlag(core_1.QueryFlag.CONVERT_CUSTOM_TYPES);
         }
@@ -846,7 +846,7 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
                 ret.push((0, core_1.raw)(`${prop.formula(alias)} as ${aliased}`));
             });
             meta.props
-                .filter(prop => prop.customType?.convertToDatabaseValueSQL || prop.customType?.convertToJSValueSQL)
+                .filter(prop => prop.hasConvertToDatabaseValueSQL || prop.hasConvertToJSValueSQL)
                 .forEach(prop => ret.push(prop.name));
         }
         return ret.length > 0 ? core_1.Utils.unique(ret) : ['*'];

package/AbstractSqlPlatform.d.ts

@@ -14,6 +14,7 @@ export declare abstract class AbstractSqlPlatform extends Platform {
     quoteValue(value: any): string;
     formatQuery(sql: string, params: readonly any[]): string;
     getSearchJsonPropertySQL(path: string, type: string, aliased: boolean): string;
+    getSearchJsonPropertyKey(path: string[], type: string, aliased: boolean): string;
     isRaw(value: any): boolean;
     supportsSchemas(): boolean;
     /** @inheritDoc */

package/AbstractSqlPlatform.js

@@ -76,6 +76,14 @@ class AbstractSqlPlatform extends core_1.Platform {
     getSearchJsonPropertySQL(path, type, aliased) {
         return this.getSearchJsonPropertyKey(path.split('->'), type, aliased);
     }
+    getSearchJsonPropertyKey(path, type, aliased) {
+        const [a, ...b] = path;
+        const quoteKey = (key) => key.match(/^[a-z]\w*$/i) ? key : `"${key}"`;
+        if (aliased) {
+            return (0, core_1.raw)(alias => `json_extract(${this.quoteIdentifier(`${alias}.${a}`)}, '$.${b.map(quoteKey).join('.')}')`);
+        }
+        return (0, core_1.raw)(`json_extract(${this.quoteIdentifier(a)}, '$.${b.map(quoteKey).join('.')}')`);
+    }
     isRaw(value) {
         return super.isRaw(value) || (typeof value === 'object' && value !== null && value.client && ['Ref', 'Raw'].includes(value.constructor.name));
     }

package/SqlEntityRepository.d.ts

@@ -18,5 +18,12 @@ export declare class SqlEntityRepository<T extends object> extends EntityReposit
      * Returns configured knex instance.
      */
     getKnex(type?: ConnectionType): Knex;
+    /**
+     * @inheritDoc
+     */
+    getEntityManager(): SqlEntityManager;
+    /**
+     * @inheritDoc
+     */
     protected get em(): SqlEntityManager;
 }

package/SqlEntityRepository.js

@@ -11,7 +11,7 @@ class SqlEntityRepository extends core_1.EntityRepository {
      * Creates a QueryBuilder instance
      */
     createQueryBuilder(alias) {
-        return this.em.createQueryBuilder(this.entityName, alias);
+        return this.getEntityManager().createQueryBuilder(this.entityName, alias);
     }
     /**
      * Shortcut for `createQueryBuilder()`
@@ -23,10 +23,19 @@ class SqlEntityRepository extends core_1.EntityRepository {
      * Returns configured knex instance.
      */
     getKnex(type) {
-        return this.em.getConnection(type).getKnex();
+        return this.getEntityManager().getConnection(type).getKnex();
     }
+    /**
+     * @inheritDoc
+     */
+    getEntityManager() {
+        return this._em;
+    }
+    /**
+     * @inheritDoc
+     */
     get em() {
-        return this._em.getContext(false);
+        return this._em;
     }
 }
 exports.SqlEntityRepository = SqlEntityRepository;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/knex",
-  "version": "6.0.0-dev.60",
+  "version": "6.0.0-dev.62",
   "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",
@@ -63,9 +63,9 @@
     "sqlstring": "2.3.3"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^5.6.16"
+    "@mikro-orm/core": "^5.7.2"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "~6.0.0-dev.60"
+    "@mikro-orm/core": "~6.0.0-dev.62"
   }
 }

package/query/CriteriaNode.js

@@ -97,7 +97,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.js

@@ -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]?.kind === core_1.ReferenceKind.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);

package/query/QueryBuilder.d.ts

@@ -1,7 +1,7 @@
 /// <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 type { AnyEntity, ConnectionType, Dictionary, EntityData, EntityName, EntityProperty, FlushMode, GroupOperator, LoggerContext, MetadataStorage, ObjectQuery, PopulateOptions, QBFilterQuery, QBQueryOrderMap, QueryResult, RequiredEntityData } from '@mikro-orm/core';
 import { LockMode, PopulateHint, QueryFlag } from '@mikro-orm/core';
 import { QueryType } from './enums';
 import type { AbstractSqlDriver } from '../AbstractSqlDriver';
@@ -35,6 +35,7 @@ export declare class QueryBuilder<T extends object = AnyEntity> {
     private readonly context?;
     private connectionType?;
     private readonly em?;
+    private readonly loggerContext?;
     get mainAlias(): Alias;
     get alias(): string;
     get helper(): QueryBuilderHelper;
@@ -78,7 +79,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, import("..").AbstractSqlPlatform>> | 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, import("..").AbstractSqlPlatform>> | undefined, loggerContext?: LoggerContext | undefined);
     select(fields: Field<T> | Field<T>[], distinct?: boolean): SelectQueryBuilder<T>;
     addSelect(fields: Field<T> | Field<T>[]): SelectQueryBuilder<T>;
     distinct(): SelectQueryBuilder<T>;

package/query/QueryBuilder.js

@@ -52,12 +52,13 @@ class QueryBuilder {
     /**
      * @internal
      */
-    constructor(entityName, metadata, driver, context, alias, connectionType, em) {
+    constructor(entityName, metadata, driver, context, alias, connectionType, em, loggerContext) {
         this.metadata = metadata;
         this.driver = driver;
         this.context = context;
         this.connectionType = connectionType;
         this.em = em;
+        this.loggerContext = loggerContext;
         /** @internal */
         this._populate = [];
         /** @internal */
@@ -369,6 +370,7 @@ class QueryBuilder {
     getKnexQuery() {
         this.finalize();
         const qb = this.getQueryBase();
+        qb.__raw = true; // tag it as there is now way to check via `instanceof`
         core_1.Utils.runIfNotEmpty(() => this.helper.appendQueryCondition(this.type ?? enums_1.QueryType.SELECT, this._cond, qb), this._cond && !this._onConflict);
         core_1.Utils.runIfNotEmpty(() => qb.groupBy(this.prepareFields(this._groupBy, 'groupBy')), this._groupBy);
         core_1.Utils.runIfNotEmpty(() => this.helper.appendQueryCondition(this.type ?? enums_1.QueryType.SELECT, this._having, qb, undefined, 'having'), this._having);
@@ -457,7 +459,7 @@ class QueryBuilder {
             return cached.data;
         }
         const type = this.connectionType || (method === 'run' ? 'write' : 'read');
-        const res = await this.driver.getConnection(type).execute(query.sql, query.bindings, method, this.context);
+        const res = await this.driver.getConnection(type).execute(query.sql, query.bindings, method, this.context, this.loggerContext);
         const meta = this.mainAlias.metadata;
         if (!mapResults || !meta) {
             await this.em?.storeCache(this._cache, cached, res);
@@ -708,7 +710,7 @@ class QueryBuilder {
         });
         const meta = this.mainAlias.metadata;
         /* istanbul ignore next */
-        const requiresSQLConversion = meta?.props.filter(p => p.customType?.convertToJSValueSQL) ?? [];
+        const requiresSQLConversion = meta?.props.filter(p => p.hasConvertToJSValueSQL) ?? [];
         if (this.flags.has(core_1.QueryFlag.CONVERT_CUSTOM_TYPES) && (fields.includes('*') || fields.includes(`${this.mainAlias.aliasName}.*`)) && requiresSQLConversion.length > 0) {
             requiresSQLConversion.forEach(p => ret.push(this.helper.mapper(p.name, this.type)));
         }
@@ -939,6 +941,7 @@ class QueryBuilder {
         // multiple sub-queries are needed to get around mysql limitations with order by + limit + where in + group by (o.O)
         // https://stackoverflow.com/questions/17892762/mysql-this-version-of-mysql-doesnt-yet-support-limit-in-all-any-some-subqu
         const subSubQuery = this.getKnex().select(pks).from(knexQuery);
+        subSubQuery.__raw = true; // tag it as there is now way to check via `instanceof`
         this._limit = undefined;
         this._offset = undefined;
         this.select(this._fields).where({ [core_1.Utils.getPrimaryKeyHash(meta.primaryKeys)]: { $in: subSubQuery } });

package/query/QueryBuilderHelper.js

@@ -73,7 +73,7 @@ class QueryBuilderHelper {
             const as = alias === null ? '' : ` as ${aliased}`;
             return this.knex.raw(`${prop.formula(alias2)}${as}`);
         }
-        if (prop?.customType?.convertToJSValueSQL) {
+        if (prop?.hasConvertToJSValueSQL) {
             const prefixed = this.prefix(field, isTableNameAliasRequired, true);
             const valueSQL = prop.customType.convertToJSValueSQL(prefixed, this.platform);
             if (alias === null) {
@@ -301,7 +301,7 @@ class QueryBuilderHelper {
     }
     appendOnConflictClause(type, onConflict, qb) {
         onConflict.forEach(item => {
-            const sub = qb.onConflict(item.fields);
+            const sub = item.fields.length > 0 ? qb.onConflict(item.fields) : qb.onConflict();
             core_1.Utils.runIfNotEmpty(() => sub.ignore(), item.ignore);
             core_1.Utils.runIfNotEmpty(() => {
                 let mergeParam = item.merge;
@@ -618,9 +618,10 @@ class QueryBuilderHelper {
             if (prop.customType && convertCustomTypes && !this.platform.isRaw(data[k])) {
                 data[k] = prop.customType.convertToDatabaseValue(data[k], this.platform, { fromQuery: true, key: k, mode: 'query-data' });
             }
-            if (prop.customType && 'convertToDatabaseValueSQL' in prop.customType && !this.platform.isRaw(data[k])) {
+            if (prop.hasConvertToDatabaseValueSQL && !this.platform.isRaw(data[k])) {
                 const quoted = this.platform.quoteValue(data[k]);
-                data[k] = this.knex.raw(prop.customType.convertToDatabaseValueSQL(quoted, this.platform).replace(/\?/, '\\?'));
+                const sql = prop.customType.convertToDatabaseValueSQL(quoted, this.platform);
+                data[k] = this.knex.raw(sql.replace(/\?/, '\\?'));
             }
             if (!prop.customType && (Array.isArray(data[k]) || core_1.Utils.isPlainObject(data[k]))) {
                 data[k] = JSON.stringify(data[k]);

package/schema/SchemaComparator.js

@@ -439,6 +439,11 @@ class SchemaComparator {
             const defaultValueTo = !['0', 'false', 'f', 'n', 'no', 'off'].includes('' + to.default);
             return defaultValueFrom === defaultValueTo;
         }
+        if (to.mappedType instanceof core_1.JsonType) {
+            const defaultValueFrom = (0, core_1.parseJsonSafe)(from.default.replace(/^'(.*)'$/, '$1'));
+            const defaultValueTo = (0, core_1.parseJsonSafe)(to.default?.replace(/^'(.*)'$/, '$1'));
+            return core_1.Utils.equals(defaultValueFrom, defaultValueTo);
+        }
         if (to.mappedType instanceof core_1.DateTimeType && from.default && to.default) {
             // normalize now/current_timestamp defaults, also remove `()` from the end of default expression
             const defaultValueFrom = from.default.toLowerCase().replace('current_timestamp', 'now').replace(/\(\)$/, '');