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

package/AbstractSqlConnection.d.ts

@@ -1,5 +1,5 @@
 import { type Knex } from 'knex';
-import { Connection, type AnyEntity, type Configuration, type ConnectionOptions, type EntityData, type IsolationLevel, type QueryResult, type Transaction, type TransactionEventBroadcaster, type LoggingOptions } from '@mikro-orm/core';
+import { Connection, type AnyEntity, type Configuration, type ConnectionOptions, type EntityData, type IsolationLevel, type QueryResult, type Transaction, type TransactionEventBroadcaster, type LogContext, type LoggingOptions } from '@mikro-orm/core';
 import type { AbstractSqlPlatform } from './AbstractSqlPlatform';
 export declare abstract class AbstractSqlConnection extends Connection {
     private static __patched;
@@ -33,15 +33,17 @@ export declare abstract class AbstractSqlConnection extends Connection {
         readOnly?: boolean;
         ctx?: Knex.Transaction;
         eventBroadcaster?: TransactionEventBroadcaster;
+        loggerContext?: LogContext;
     }): Promise<T>;
     begin(options?: {
         isolationLevel?: IsolationLevel;
         readOnly?: boolean;
         ctx?: Knex.Transaction;
         eventBroadcaster?: TransactionEventBroadcaster;
+        loggerContext?: LogContext;
     }): Promise<Knex.Transaction>;
-    commit(ctx: Knex.Transaction, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
-    rollback(ctx: Knex.Transaction, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
+    commit(ctx: Knex.Transaction, eventBroadcaster?: TransactionEventBroadcaster, loggerContext?: LogContext): Promise<void>;
+    rollback(ctx: Knex.Transaction, eventBroadcaster?: TransactionEventBroadcaster, loggerContext?: LogContext): 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, loggerContext?: LoggingOptions): Promise<T>;
     /**
      * Execute raw SQL queries from file

package/AbstractSqlConnection.js

@@ -56,11 +56,11 @@ class AbstractSqlConnection extends core_1.Connection {
         const trx = await this.begin(options);
         try {
             const ret = await cb(trx);
-            await this.commit(trx, options.eventBroadcaster);
+            await this.commit(trx, options.eventBroadcaster, options.loggerContext);
             return ret;
         }
         catch (error) {
-            await this.rollback(trx, options.eventBroadcaster);
+            await this.rollback(trx, options.eventBroadcaster, options.loggerContext);
             throw error;
         }
     }
@@ -72,6 +72,19 @@ class AbstractSqlConnection extends core_1.Connection {
             isolationLevel: options.isolationLevel,
             readOnly: options.readOnly,
         });
+        if (options.ctx) {
+            const ctx = options.ctx;
+            ctx.index ??= 0;
+            const savepointName = `trx${ctx.index + 1}`;
+            Reflect.defineProperty(trx, 'index', { value: ctx.index + 1 });
+            Reflect.defineProperty(trx, 'savepointName', { value: savepointName });
+            this.logQuery(this.platform.getSavepointSQL(savepointName), options.loggerContext);
+        }
+        else {
+            for (const query of this.platform.getBeginTransactionSQL(options)) {
+                this.logQuery(query, options.loggerContext);
+            }
+        }
         if (!options.ctx) {
             await options.eventBroadcaster?.dispatchEvent(core_1.EventType.afterTransactionStart, trx);
         }
@@ -80,23 +93,35 @@ class AbstractSqlConnection extends core_1.Connection {
         }
         return trx;
     }
-    async commit(ctx, eventBroadcaster) {
+    async commit(ctx, eventBroadcaster, loggerContext) {
         const runTrxHooks = isRootTransaction(ctx);
         if (runTrxHooks) {
             await eventBroadcaster?.dispatchEvent(core_1.EventType.beforeTransactionCommit, ctx);
         }
         ctx.commit();
         await ctx.executionPromise; // https://github.com/knex/knex/issues/3847#issuecomment-626330453
+        if ('savepointName' in ctx) {
+            this.logQuery(this.platform.getReleaseSavepointSQL(ctx.savepointName), loggerContext);
+        }
+        else {
+            this.logQuery(this.platform.getCommitTransactionSQL(), loggerContext);
+        }
         if (runTrxHooks) {
             await eventBroadcaster?.dispatchEvent(core_1.EventType.afterTransactionCommit, ctx);
         }
     }
-    async rollback(ctx, eventBroadcaster) {
+    async rollback(ctx, eventBroadcaster, loggerContext) {
         const runTrxHooks = isRootTransaction(ctx);
         if (runTrxHooks) {
             await eventBroadcaster?.dispatchEvent(core_1.EventType.beforeTransactionRollback, ctx);
         }
         await ctx.rollback();
+        if ('savepointName' in ctx) {
+            this.logQuery(this.platform.getRollbackToSavepointSQL(ctx.savepointName), loggerContext);
+        }
+        else {
+            this.logQuery(this.platform.getRollbackTransactionSQL(), loggerContext);
+        }
         if (runTrxHooks) {
             await eventBroadcaster?.dispatchEvent(core_1.EventType.afterTransactionRollback, ctx);
         }
@@ -107,7 +132,7 @@ class AbstractSqlConnection extends core_1.Connection {
             ctx ??= (queryOrKnex.client.transacting ? queryOrKnex : null);
             const q = queryOrKnex.toSQL();
             queryOrKnex = q.sql;
-            params = q.bindings;
+            params = q.bindings ?? [];
         }
         queryOrKnex = this.config.get('onQuery')(queryOrKnex, params);
         const formatted = this.platform.formatQuery(queryOrKnex, params);
@@ -141,11 +166,7 @@ class AbstractSqlConnection extends core_1.Connection {
             return driverOptions;
         }
         return (0, knex_1.knex)(this.getKnexOptions(type))
-            .on('query', data => {
-            if (!data.__knexQueryUid) {
-                this.logQuery(data.sql.toLowerCase().replace(/;$/, ''));
-            }
-        });
+            .on('query', data => data);
     }
     getKnexOptions(type) {
         const config = core_1.Utils.mergeConfig({

package/AbstractSqlDriver.js

@@ -343,7 +343,7 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
         const meta = this.metadata.find(entityName);
         const collections = this.extractManyToMany(entityName, data);
         const pks = meta?.primaryKeys ?? [this.config.getNamingStrategy().referenceColumnName()];
-        const qb = this.createQueryBuilder(entityName, options.ctx, 'write', options.convertCustomTypes).withSchema(this.getSchemaName(meta, options));
+        const qb = this.createQueryBuilder(entityName, options.ctx, 'write', options.convertCustomTypes, options.loggerContext).withSchema(this.getSchemaName(meta, options));
         const res = await this.rethrow(qb.insert(data).execute('run', false));
         res.row = res.row || {};
         let pk;
@@ -470,7 +470,7 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
         if (transform) {
             sql = transform(sql);
         }
-        const res = await this.execute(sql, params, 'run', options.ctx);
+        const res = await this.execute(sql, params, 'run', options.ctx, options.loggerContext);
         let pk;
         /* istanbul ignore next */
         if (pks.length > 1) { // owner has composite pk
@@ -498,7 +498,7 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
             where = { [meta?.primaryKeys[0] ?? pks[0]]: where };
         }
         if (core_1.Utils.hasObjectKeys(data)) {
-            const qb = this.createQueryBuilder(entityName, options.ctx, 'write', options.convertCustomTypes)
+            const qb = this.createQueryBuilder(entityName, options.ctx, 'write', options.convertCustomTypes, options.loggerContext)
                 .withSchema(this.getSchemaName(meta, options));
             if (options.upsert) {
                 /* istanbul ignore next */
@@ -537,7 +537,7 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
         const meta = this.metadata.get(entityName);
         if (options.upsert) {
             const uniqueFields = options.onConflictFields ?? (core_1.Utils.isPlainObject(where[0]) ? Object.keys(where[0]).flatMap(key => core_1.Utils.splitPrimaryKeys(key)) : meta.primaryKeys);
-            const qb = this.createQueryBuilder(entityName, options.ctx, 'write', options.convertCustomTypes).withSchema(this.getSchemaName(meta, options));
+            const qb = this.createQueryBuilder(entityName, options.ctx, 'write', options.convertCustomTypes, options.loggerContext).withSchema(this.getSchemaName(meta, options));
             const returning = (0, core_1.getOnConflictReturningFields)(meta, data[0], uniqueFields, options);
             qb.insert(data)
                 .onConflict(uniqueFields)
@@ -650,7 +650,7 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
             /* 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));
+        const res = await this.rethrow(this.execute(sql, params, 'run', options.ctx, options.loggerContext));
         for (let i = 0; i < collections.length; i++) {
             await this.processManyToMany(meta, where[i], collections[i], false, options);
         }
@@ -662,7 +662,7 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
         if (core_1.Utils.isPrimaryKey(where) && pks.length === 1) {
             where = { [pks[0]]: where };
         }
-        const qb = this.createQueryBuilder(entityName, options.ctx, 'write', false).delete(where).withSchema(this.getSchemaName(meta, options));
+        const qb = this.createQueryBuilder(entityName, options.ctx, 'write', false, options.loggerContext).delete(where).withSchema(this.getSchemaName(meta, options));
         return this.rethrow(qb.execute('run', false));
     }
     /**
@@ -750,7 +750,7 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
                 schema = this.config.get('schema');
             }
             const tableName = `${schema ?? '_'}.${pivotMeta.tableName}`;
-            const persister = groups[tableName] ??= new PivotCollectionPersister_1.PivotCollectionPersister(pivotMeta, this, options?.ctx, schema);
+            const persister = groups[tableName] ??= new PivotCollectionPersister_1.PivotCollectionPersister(pivotMeta, this, options?.ctx, schema, options?.loggerContext);
             persister.enqueueUpdate(coll.property, insertDiff, deleteDiff, pks);
         }
         for (const persister of core_1.Utils.values(groups)) {
@@ -1081,7 +1081,7 @@ class AbstractSqlDriver extends core_1.DatabaseDriver {
         for (const prop of meta.relations) {
             if (collections[prop.name]) {
                 const pivotMeta = this.metadata.find(prop.pivotEntity);
-                const persister = new PivotCollectionPersister_1.PivotCollectionPersister(pivotMeta, this, options?.ctx, options?.schema);
+                const persister = new PivotCollectionPersister_1.PivotCollectionPersister(pivotMeta, this, options?.ctx, options?.schema, options?.loggerContext);
                 persister.enqueueUpdate(prop, collections[prop.name], clear, pks);
                 await this.rethrow(persister.execute());
             }

package/AbstractSqlPlatform.d.ts

@@ -1,4 +1,4 @@
-import { Platform, type Constructor, type EntityManager, type EntityRepository, type IDatabaseDriver, type MikroORM } from '@mikro-orm/core';
+import { Platform, type Constructor, type EntityManager, type EntityRepository, type IDatabaseDriver, type MikroORM, type IsolationLevel } from '@mikro-orm/core';
 import { SqlSchemaGenerator, type SchemaHelper } from './schema';
 import type { IndexDef } from './typings';
 export declare abstract class AbstractSqlPlatform extends Platform {
@@ -10,6 +10,15 @@ export declare abstract class AbstractSqlPlatform extends Platform {
     /** @inheritDoc */
     lookupExtensions(orm: MikroORM): void;
     getSchemaGenerator(driver: IDatabaseDriver, em?: EntityManager): SqlSchemaGenerator;
+    getBeginTransactionSQL(options?: {
+        isolationLevel?: IsolationLevel;
+        readOnly?: boolean;
+    }): string[];
+    getCommitTransactionSQL(): string;
+    getRollbackTransactionSQL(): string;
+    getSavepointSQL(savepointName: string): string;
+    getRollbackToSavepointSQL(savepointName: string): string;
+    getReleaseSavepointSQL(savepointName: string): string;
     quoteValue(value: any): string;
     escape(value: any): string;
     getSearchJsonPropertySQL(path: string, type: string, aliased: boolean): string;

package/AbstractSqlPlatform.js

@@ -27,6 +27,27 @@ class AbstractSqlPlatform extends core_1.Platform {
     getSchemaGenerator(driver, em) {
         return new schema_1.SqlSchemaGenerator(em ?? driver);
     }
+    getBeginTransactionSQL(options) {
+        if (options?.isolationLevel) {
+            return [`set transaction isolation level ${options.isolationLevel}`, 'begin'];
+        }
+        return ['begin'];
+    }
+    getCommitTransactionSQL() {
+        return 'commit';
+    }
+    getRollbackTransactionSQL() {
+        return 'rollback';
+    }
+    getSavepointSQL(savepointName) {
+        return `savepoint ${this.quoteIdentifier(savepointName)}`;
+    }
+    getRollbackToSavepointSQL(savepointName) {
+        return `rollback to savepoint ${this.quoteIdentifier(savepointName)}`;
+    }
+    getReleaseSavepointSQL(savepointName) {
+        return `release savepoint ${this.quoteIdentifier(savepointName)}`;
+    }
     quoteValue(value) {
         if (core_1.Utils.isRawSql(value)) {
             return this.formatQuery(value.sql, value.params ?? []);

package/PivotCollectionPersister.d.ts

@@ -1,16 +1,17 @@
-import { type EntityMetadata, type EntityProperty, type Primary, type Transaction } from '@mikro-orm/core';
+import { type Dictionary, type EntityMetadata, type EntityProperty, type Primary, type Transaction } from '@mikro-orm/core';
 import { type AbstractSqlDriver } from './AbstractSqlDriver';
 export declare class PivotCollectionPersister<Entity extends object> {
     private readonly meta;
     private readonly driver;
     private readonly ctx?;
     private readonly schema?;
+    private readonly loggerContext?;
     private readonly platform;
     private readonly inserts;
     private readonly deletes;
     private readonly batchSize;
     private order;
-    constructor(meta: EntityMetadata<Entity>, driver: AbstractSqlDriver, ctx?: Transaction | undefined, schema?: string | undefined);
+    constructor(meta: EntityMetadata<Entity>, driver: AbstractSqlDriver, ctx?: Transaction | undefined, schema?: string | undefined, loggerContext?: Dictionary | undefined);
     enqueueUpdate(prop: EntityProperty<Entity>, insertDiff: Primary<Entity>[][], deleteDiff: Primary<Entity>[][] | boolean, pks: Primary<Entity>[]): void;
     private enqueueInsert;
     private enqueueDelete;

package/PivotCollectionPersister.js

@@ -41,16 +41,18 @@ class PivotCollectionPersister {
     driver;
     ctx;
     schema;
+    loggerContext;
     platform;
     inserts = new Map();
     deletes = new Map();
     batchSize;
     order = 0;
-    constructor(meta, driver, ctx, schema) {
+    constructor(meta, driver, ctx, schema, loggerContext) {
         this.meta = meta;
         this.driver = driver;
         this.ctx = ctx;
         this.schema = schema;
+        this.loggerContext = loggerContext;
         this.platform = this.driver.getPlatform();
         this.batchSize = this.driver.config.get('batchSize');
     }
@@ -102,6 +104,7 @@ class PivotCollectionPersister {
                 await this.driver.nativeDelete(this.meta.className, cond, {
                     ctx: this.ctx,
                     schema: this.schema,
+                    loggerContext: this.loggerContext,
                 });
             }
         }
@@ -122,12 +125,13 @@ class PivotCollectionPersister {
                     schema: this.schema,
                     convertCustomTypes: false,
                     processCollections: false,
+                    loggerContext: this.loggerContext,
                 });
             }
         }
         else {
             await core_1.Utils.runSerial(items, item => {
-                return this.driver.createQueryBuilder(this.meta.className, this.ctx, 'write')
+                return this.driver.createQueryBuilder(this.meta.className, this.ctx, 'write', false, this.loggerContext)
                     .withSchema(this.schema)
                     .insert(item)
                     .execute('run', false);

package/dialects/mysql/MySqlPlatform.d.ts

@@ -1,4 +1,4 @@
-import { type SimpleColumnMeta, type Type, type TransformContext } from '@mikro-orm/core';
+import { type SimpleColumnMeta, type Type, type TransformContext, type IsolationLevel } from '@mikro-orm/core';
 import { MySqlSchemaHelper } from './MySqlSchemaHelper';
 import { MySqlExceptionConverter } from './MySqlExceptionConverter';
 import { AbstractSqlPlatform } from '../../AbstractSqlPlatform';
@@ -13,6 +13,10 @@ export declare class MySqlPlatform extends AbstractSqlPlatform {
         readonly "desc nulls last": "is null";
     };
     getDefaultCharset(): string;
+    getBeginTransactionSQL(options?: {
+        isolationLevel?: IsolationLevel;
+        readOnly?: boolean;
+    }): string[];
     convertJsonToDatabaseValue(value: unknown, context?: TransformContext): unknown;
     getJsonIndexDefinition(index: IndexDef): string[];
     getBooleanTypeDeclarationSQL(): string;

package/dialects/mysql/MySqlPlatform.js

@@ -17,6 +17,20 @@ class MySqlPlatform extends AbstractSqlPlatform_1.AbstractSqlPlatform {
     getDefaultCharset() {
         return 'utf8mb4';
     }
+    getBeginTransactionSQL(options) {
+        if (options?.isolationLevel || options?.readOnly) {
+            const parts = [];
+            if (options.isolationLevel) {
+                parts.push(`isolation level ${options.isolationLevel}`);
+            }
+            if (options.readOnly) {
+                parts.push('read only');
+            }
+            const sql = `set transaction ${parts.join(', ')}`;
+            return [sql, 'begin'];
+        }
+        return ['begin'];
+    }
     convertJsonToDatabaseValue(value, context) {
         if (context?.mode === 'query') {
             return value;

package/dialects/sqlite/BaseSqlitePlatform.d.ts

@@ -1,4 +1,4 @@
-import { type EntityProperty } from '@mikro-orm/core';
+import { type EntityProperty, type IsolationLevel } from '@mikro-orm/core';
 import { AbstractSqlPlatform } from '../../AbstractSqlPlatform';
 export declare abstract class BaseSqlitePlatform extends AbstractSqlPlatform {
     usesDefaultKeyword(): boolean;
@@ -7,6 +7,10 @@ export declare abstract class BaseSqlitePlatform extends AbstractSqlPlatform {
     getDateTimeTypeDeclarationSQL(column: {
         length: number;
     }): string;
+    getBeginTransactionSQL(options?: {
+        isolationLevel?: IsolationLevel;
+        readOnly?: boolean;
+    }): string[];
     getEnumTypeDeclarationSQL(column: {
         items?: unknown[];
         fieldNames: string[];

package/dialects/sqlite/BaseSqlitePlatform.js

@@ -16,6 +16,9 @@ class BaseSqlitePlatform extends AbstractSqlPlatform_1.AbstractSqlPlatform {
     getDateTimeTypeDeclarationSQL(column) {
         return 'datetime';
     }
+    getBeginTransactionSQL(options) {
+        return ['begin'];
+    }
     getEnumTypeDeclarationSQL(column) {
         if (column.items?.every(item => core_1.Utils.isString(item))) {
             return 'text';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/knex",
-  "version": "6.4.17-dev.60",
+  "version": "6.4.17-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",
@@ -66,7 +66,7 @@
     "@mikro-orm/core": "^6.4.16"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "6.4.17-dev.60",
+    "@mikro-orm/core": "6.4.17-dev.62",
     "better-sqlite3": "*",
     "libsql": "*",
     "mariadb": "*"