@mikro-orm/mysql 7.0.14 → 7.0.15-dev.0

package/MySqlConnection.d.ts

@@ -3,7 +3,7 @@ import { type PoolOptions } from 'mysql2';
 import { AbstractSqlConnection, type TransactionEventBroadcaster } from '@mikro-orm/sql';
 /** MySQL database connection using the `mysql2` driver. */
 export declare class MySqlConnection extends AbstractSqlConnection {
-  createKyselyDialect(overrides: PoolOptions): Promise<MysqlDialect>;
-  mapOptions(overrides: PoolOptions): PoolOptions;
-  commit(ctx: ControlledTransaction<any, any>, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
+    createKyselyDialect(overrides: PoolOptions): Promise<MysqlDialect>;
+    mapOptions(overrides: PoolOptions): PoolOptions;
+    commit(ctx: ControlledTransaction<any, any>, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
 }

package/MySqlConnection.js

@@ -1,77 +1,78 @@
 import { MysqlDialect } from 'kysely';
 import { createPool } from 'mysql2';
-import { Utils, AbstractSqlConnection } from '@mikro-orm/sql';
+import { Utils, AbstractSqlConnection, } from '@mikro-orm/sql';
 /** MySQL database connection using the `mysql2` driver. */
 export class MySqlConnection extends AbstractSqlConnection {
-  async createKyselyDialect(overrides) {
-    const options = this.mapOptions(overrides);
-    const password = options.password;
-    if (typeof password === 'function') {
-      const initialPassword = await password();
-      const innerPool = createPool({ ...options, password: initialPassword });
-      // mysql2 reads pool.config.connectionConfig.password when creating new physical
-      // connections, so updating it before getConnection() ensures fresh tokens are used.
-      // Existing idle connections are already authenticated and unaffected, so we skip
-      // the callback when the pool has a free connection to reuse.
-      const pool = {
-        getConnection(cb) {
-          const inner = innerPool;
-          if ((inner._freeConnections?.length ?? 0) > 0) {
-            innerPool.getConnection(cb);
-            return;
-          }
-          Promise.resolve(password())
-            .then(pw => {
-              inner.config.connectionConfig.password = pw;
-              innerPool.getConnection(cb);
-            })
-            .catch(err => cb(err, undefined));
-        },
-        end(cb) {
-          innerPool.end(cb);
-        },
-      };
-      return new MysqlDialect({
-        pool,
-        onCreateConnection: this.options.onCreateConnection ?? this.config.get('onCreateConnection'),
-      });
-    }
-    return new MysqlDialect({
-      pool: createPool(options),
-      onCreateConnection: this.options.onCreateConnection ?? this.config.get('onCreateConnection'),
-    });
-  }
-  mapOptions(overrides) {
-    const ret = { ...this.getConnectionOptions() };
-    const pool = this.config.get('pool');
-    ret.connectionLimit = pool?.max;
-    ret.idleTimeout = pool?.idleTimeoutMillis;
-    if (this.config.get('multipleStatements')) {
-      ret.multipleStatements = this.config.get('multipleStatements');
-    }
-    if (this.config.get('forceUtcTimezone')) {
-      ret.timezone = 'Z';
+    async createKyselyDialect(overrides) {
+        const options = this.mapOptions(overrides);
+        const password = options.password;
+        if (typeof password === 'function') {
+            const initialPassword = await password();
+            const innerPool = createPool({ ...options, password: initialPassword });
+            // mysql2 reads pool.config.connectionConfig.password when creating new physical
+            // connections, so updating it before getConnection() ensures fresh tokens are used.
+            // Existing idle connections are already authenticated and unaffected, so we skip
+            // the callback when the pool has a free connection to reuse.
+            const pool = {
+                getConnection(cb) {
+                    const inner = innerPool;
+                    if ((inner._freeConnections?.length ?? 0) > 0) {
+                        innerPool.getConnection(cb);
+                        return;
+                    }
+                    Promise.resolve(password())
+                        .then(pw => {
+                        inner.config.connectionConfig.password = pw;
+                        innerPool.getConnection(cb);
+                    })
+                        .catch(err => cb(err, undefined));
+                },
+                end(cb) {
+                    innerPool.end(cb);
+                },
+            };
+            return new MysqlDialect({
+                pool,
+                onCreateConnection: this.options.onCreateConnection ?? this.config.get('onCreateConnection'),
+            });
+        }
+        return new MysqlDialect({
+            pool: createPool(options),
+            onCreateConnection: this.options.onCreateConnection ?? this.config.get('onCreateConnection'),
+        });
     }
-    if (this.config.get('timezone')) {
-      ret.timezone = this.config.get('timezone');
+    mapOptions(overrides) {
+        const ret = { ...this.getConnectionOptions() };
+        const pool = this.config.get('pool');
+        ret.connectionLimit = pool?.max;
+        ret.idleTimeout = pool?.idleTimeoutMillis;
+        if (this.config.get('multipleStatements')) {
+            ret.multipleStatements = this.config.get('multipleStatements');
+        }
+        if (this.config.get('forceUtcTimezone')) {
+            ret.timezone = 'Z';
+        }
+        if (this.config.get('timezone')) {
+            ret.timezone = this.config.get('timezone');
+        }
+        ret.supportBigNumbers = true;
+        ret.dateStrings = true;
+        return Utils.mergeConfig(ret, overrides);
     }
-    ret.supportBigNumbers = true;
-    ret.dateStrings = true;
-    return Utils.mergeConfig(ret, overrides);
-  }
-  async commit(ctx, eventBroadcaster) {
-    if (!ctx.isRolledBack && 'savepointName' in ctx) {
-      try {
-        await ctx.releaseSavepoint(ctx.savepointName).execute();
-      } catch (e) {
-        /* v8 ignore next */
-        // https://github.com/knex/knex/issues/805
-        if (e.errno !== 1305) {
-          throw e;
+    async commit(ctx, eventBroadcaster) {
+        if (!ctx.isRolledBack && 'savepointName' in ctx) {
+            try {
+                await ctx.releaseSavepoint(ctx.savepointName).execute();
+            }
+            catch (e) {
+                /* v8 ignore next */
+                // https://github.com/knex/knex/issues/805
+                if (e.errno !== 1305) {
+                    throw e;
+                }
+            }
+            return this.logQuery(this.platform.getReleaseSavepointSQL(ctx.savepointName));
         }
-      }
-      return this.logQuery(this.platform.getReleaseSavepointSQL(ctx.savepointName));
+        await super.commit(ctx, eventBroadcaster);
     }
-    await super.commit(ctx, eventBroadcaster);
-  }
 }

package/MySqlDriver.d.ts

@@ -1,33 +1,15 @@
-import type {
-  Configuration,
-  Constructor,
-  EntityDictionary,
-  EntityName,
-  FilterQuery,
-  NativeInsertUpdateManyOptions,
-  QueryResult,
-  UpsertManyOptions,
-} from '@mikro-orm/core';
+import type { Configuration, Constructor, EntityDictionary, EntityName, FilterQuery, NativeInsertUpdateManyOptions, QueryResult, UpsertManyOptions } from '@mikro-orm/core';
 import { AbstractSqlDriver } from '@mikro-orm/sql';
 import { MySqlConnection } from './MySqlConnection.js';
 import { MySqlMikroORM } from './MySqlMikroORM.js';
 import { MySqlPlatform } from './MySqlPlatform.js';
 /** Database driver for MySQL. */
 export declare class MySqlDriver extends AbstractSqlDriver<MySqlConnection, MySqlPlatform> {
-  private autoIncrementIncrement?;
-  constructor(config: Configuration);
-  private getAutoIncrementIncrement;
-  nativeInsertMany<T extends object>(
-    entityName: EntityName<T>,
-    data: EntityDictionary<T>[],
-    options?: NativeInsertUpdateManyOptions<T>,
-  ): Promise<QueryResult<T>>;
-  nativeUpdateMany<T extends object>(
-    entityName: EntityName<T>,
-    where: FilterQuery<T>[],
-    data: EntityDictionary<T>[],
-    options?: NativeInsertUpdateManyOptions<T> & UpsertManyOptions<T>,
-  ): Promise<QueryResult<T>>;
-  /** @inheritDoc */
-  getORMClass(): Constructor<MySqlMikroORM>;
+    private autoIncrementIncrement?;
+    constructor(config: Configuration);
+    private getAutoIncrementIncrement;
+    nativeInsertMany<T extends object>(entityName: EntityName<T>, data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T>): Promise<QueryResult<T>>;
+    nativeUpdateMany<T extends object>(entityName: EntityName<T>, where: FilterQuery<T>[], data: EntityDictionary<T>[], options?: NativeInsertUpdateManyOptions<T> & UpsertManyOptions<T>): Promise<QueryResult<T>>;
+    /** @inheritDoc */
+    getORMClass(): Constructor<MySqlMikroORM>;
 }

package/MySqlDriver.js

@@ -4,58 +4,54 @@ import { MySqlMikroORM } from './MySqlMikroORM.js';
 import { MySqlPlatform } from './MySqlPlatform.js';
 /** Database driver for MySQL. */
 export class MySqlDriver extends AbstractSqlDriver {
-  autoIncrementIncrement;
-  constructor(config) {
-    super(config, new MySqlPlatform(), MySqlConnection, ['kysely', 'mysql2']);
-  }
-  async getAutoIncrementIncrement(ctx) {
-    if (this.autoIncrementIncrement == null) {
-      // the increment step may differ when running a cluster, see https://github.com/mikro-orm/mikro-orm/issues/3828
-      const res = await this.connection.execute(`show variables like 'auto_increment_increment'`, [], 'get', ctx, {
-        enabled: false,
-      });
-      /* v8 ignore next */
-      this.autoIncrementIncrement = res?.Value ? +res?.Value : 1;
+    autoIncrementIncrement;
+    constructor(config) {
+        super(config, new MySqlPlatform(), MySqlConnection, ['kysely', 'mysql2']);
     }
-    return this.autoIncrementIncrement;
-  }
-  async nativeInsertMany(entityName, data, options = {}) {
-    options.processCollections ??= true;
-    const res = await super.nativeInsertMany(entityName, data, options);
-    const meta = this.metadata.get(entityName);
-    const pks = this.getPrimaryKeyFields(meta);
-    const ctx = options.ctx;
-    const autoIncrementIncrement = await this.getAutoIncrementIncrement(ctx);
-    data.forEach(
-      (item, idx) => (res.rows[idx] = { [pks[0]]: item[pks[0]] ?? res.insertId + idx * autoIncrementIncrement }),
-    );
-    res.row = res.rows[0];
-    return res;
-  }
-  async nativeUpdateMany(entityName, where, data, options = {}) {
-    const res = await super.nativeUpdateMany(entityName, where, data, options);
-    const meta = this.metadata.get(entityName);
-    const pks = this.getPrimaryKeyFields(meta);
-    const ctx = options.ctx;
-    const autoIncrementIncrement = await this.getAutoIncrementIncrement(ctx);
-    let i = 0;
-    const rows = where.map(cond => {
-      if (res.insertId != null && Utils.isEmpty(cond)) {
-        return { [pks[0]]: res.insertId + i++ * autoIncrementIncrement };
-      }
-      if (cond[pks[0]] == null) {
-        return undefined;
-      }
-      return { [pks[0]]: cond[pks[0]] };
-    });
-    if (rows.every(i => i !== undefined)) {
-      res.rows = rows;
+    async getAutoIncrementIncrement(ctx) {
+        if (this.autoIncrementIncrement == null) {
+            // the increment step may differ when running a cluster, see https://github.com/mikro-orm/mikro-orm/issues/3828
+            const res = await this.connection.execute(`show variables like 'auto_increment_increment'`, [], 'get', ctx, { enabled: false });
+            /* v8 ignore next */
+            this.autoIncrementIncrement = res?.Value ? +res?.Value : 1;
+        }
+        return this.autoIncrementIncrement;
+    }
+    async nativeInsertMany(entityName, data, options = {}) {
+        options.processCollections ??= true;
+        const res = await super.nativeInsertMany(entityName, data, options);
+        const meta = this.metadata.get(entityName);
+        const pks = this.getPrimaryKeyFields(meta);
+        const ctx = options.ctx;
+        const autoIncrementIncrement = await this.getAutoIncrementIncrement(ctx);
+        data.forEach((item, idx) => (res.rows[idx] = { [pks[0]]: item[pks[0]] ?? res.insertId + idx * autoIncrementIncrement }));
+        res.row = res.rows[0];
+        return res;
+    }
+    async nativeUpdateMany(entityName, where, data, options = {}) {
+        const res = await super.nativeUpdateMany(entityName, where, data, options);
+        const meta = this.metadata.get(entityName);
+        const pks = this.getPrimaryKeyFields(meta);
+        const ctx = options.ctx;
+        const autoIncrementIncrement = await this.getAutoIncrementIncrement(ctx);
+        let i = 0;
+        const rows = where.map(cond => {
+            if (res.insertId != null && Utils.isEmpty(cond)) {
+                return { [pks[0]]: res.insertId + i++ * autoIncrementIncrement };
+            }
+            if (cond[pks[0]] == null) {
+                return undefined;
+            }
+            return { [pks[0]]: cond[pks[0]] };
+        });
+        if (rows.every(i => i !== undefined)) {
+            res.rows = rows;
+        }
+        res.row = res.rows[0];
+        return res;
+    }
+    /** @inheritDoc */
+    getORMClass() {
+        return MySqlMikroORM;
     }
-    res.row = res.rows[0];
-    return res;
-  }
-  /** @inheritDoc */
-  getORMClass() {
-    return MySqlMikroORM;
-  }
 }

package/MySqlMikroORM.d.ts

@@ -1,58 +1,20 @@
-import {
-  type AnyEntity,
-  type EntityClass,
-  type EntitySchema,
-  type MikroORM,
-  type Options,
-  type IDatabaseDriver,
-  type EntityManager,
-  type EntityManagerType,
-} from '@mikro-orm/core';
+import { type AnyEntity, type EntityClass, type EntitySchema, type MikroORM, type Options, type IDatabaseDriver, type EntityManager, type EntityManagerType } from '@mikro-orm/core';
 import { SqlMikroORM, type SqlEntityManager } from '@mikro-orm/sql';
 import { MySqlDriver } from './MySqlDriver.js';
 /** Configuration options for the MySQL driver. */
-export type MySqlOptions<
-  EM extends SqlEntityManager<MySqlDriver> = SqlEntityManager<MySqlDriver>,
-  Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (
-    | string
-    | EntityClass<AnyEntity>
-    | EntitySchema
-  )[],
-> = Partial<Options<MySqlDriver, EM, Entities>>;
+export type MySqlOptions<EM extends SqlEntityManager<MySqlDriver> = SqlEntityManager<MySqlDriver>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> = Partial<Options<MySqlDriver, EM, Entities>>;
 /** Creates a type-safe configuration object for the MySQL driver. */
-export declare function defineMySqlConfig<
-  EM extends SqlEntityManager<MySqlDriver> = SqlEntityManager<MySqlDriver>,
-  Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (
-    | string
-    | EntityClass<AnyEntity>
-    | EntitySchema
-  )[],
->(options: Partial<Options<MySqlDriver, EM, Entities>>): Partial<Options<MySqlDriver, EM, Entities>>;
+export declare function defineMySqlConfig<EM extends SqlEntityManager<MySqlDriver> = SqlEntityManager<MySqlDriver>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Partial<Options<MySqlDriver, EM, Entities>>): Partial<Options<MySqlDriver, EM, Entities>>;
 /**
  * @inheritDoc
  */
-export declare class MySqlMikroORM<
-  EM extends SqlEntityManager<MySqlDriver> = SqlEntityManager<MySqlDriver>,
-  Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (
-    | string
-    | EntityClass<AnyEntity>
-    | EntitySchema
-  )[],
-> extends SqlMikroORM<MySqlDriver, EM, Entities> {
-  /**
-   * @inheritDoc
-   */
-  static init<
-    D extends IDatabaseDriver = MySqlDriver,
-    EM extends EntityManager<D> = D[typeof EntityManagerType] & EntityManager<D>,
-    Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (
-      | string
-      | EntityClass<AnyEntity>
-      | EntitySchema
-    )[],
-  >(options: Partial<Options<D, EM, Entities>>): Promise<MikroORM<D, EM, Entities>>;
-  /**
-   * @inheritDoc
-   */
-  constructor(options: Partial<Options<MySqlDriver, EM, Entities>>);
+export declare class MySqlMikroORM<EM extends SqlEntityManager<MySqlDriver> = SqlEntityManager<MySqlDriver>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> extends SqlMikroORM<MySqlDriver, EM, Entities> {
+    /**
+     * @inheritDoc
+     */
+    static init<D extends IDatabaseDriver = MySqlDriver, EM extends EntityManager<D> = D[typeof EntityManagerType] & EntityManager<D>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Partial<Options<D, EM, Entities>>): Promise<MikroORM<D, EM, Entities>>;
+    /**
+     * @inheritDoc
+     */
+    constructor(options: Partial<Options<MySqlDriver, EM, Entities>>);
 }

package/MySqlMikroORM.js

@@ -1,24 +1,24 @@
-import { defineConfig } from '@mikro-orm/core';
+import { defineConfig, } from '@mikro-orm/core';
 import { SqlMikroORM } from '@mikro-orm/sql';
 import { MySqlDriver } from './MySqlDriver.js';
 /** Creates a type-safe configuration object for the MySQL driver. */
 export function defineMySqlConfig(options) {
-  return defineConfig({ driver: MySqlDriver, ...options });
+    return defineConfig({ driver: MySqlDriver, ...options });
 }
 /**
  * @inheritDoc
  */
 export class MySqlMikroORM extends SqlMikroORM {
-  /**
-   * @inheritDoc
-   */
-  static async init(options) {
-    return super.init(defineMySqlConfig(options));
-  }
-  /**
-   * @inheritDoc
-   */
-  constructor(options) {
-    super(defineMySqlConfig(options));
-  }
+    /**
+     * @inheritDoc
+     */
+    static async init(options) {
+        return super.init(defineMySqlConfig(options));
+    }
+    /**
+     * @inheritDoc
+     */
+    constructor(options) {
+        super(defineMySqlConfig(options));
+    }
 }

package/MySqlPlatform.d.ts

@@ -1,5 +1,5 @@
 import { BaseMySqlPlatform } from '@mikro-orm/sql';
 /** Platform implementation for MySQL. */
 export declare class MySqlPlatform extends BaseMySqlPlatform {
-  escape(value: any): string;
+    escape(value: any): string;
 }

package/MySqlPlatform.js

@@ -2,7 +2,7 @@ import SqlString from 'sqlstring';
 import { BaseMySqlPlatform } from '@mikro-orm/sql';
 /** Platform implementation for MySQL. */
 export class MySqlPlatform extends BaseMySqlPlatform {
-  escape(value) {
-    return SqlString.escape(value, true, this.timezone);
-  }
+    escape(value) {
+        return SqlString.escape(value, true, this.timezone);
+    }
 }

package/README.md

@@ -133,7 +133,7 @@ const author = await em.findOneOrFail(Author, 1, {
   populate: ['books'],
 });
 author.name = 'Jon Snow II';
-author.books.getItems().forEach(book => (book.title += ' (2nd ed.)'));
+author.books.getItems().forEach(book => book.title += ' (2nd ed.)');
 author.books.add(orm.em.create(Book, { title: 'New Book', author }));
 
 // Flush computes change sets and executes them in a single transaction

package/index.d.ts

@@ -2,8 +2,4 @@ export * from '@mikro-orm/sql';
 export * from './MySqlDriver.js';
 export * from './MySqlPlatform.js';
 export * from './MySqlConnection.js';
-export {
-  MySqlMikroORM as MikroORM,
-  type MySqlOptions as Options,
-  defineMySqlConfig as defineConfig,
-} from './MySqlMikroORM.js';
+export { MySqlMikroORM as MikroORM, type MySqlOptions as Options, defineMySqlConfig as defineConfig, } from './MySqlMikroORM.js';

package/index.js

@@ -2,4 +2,4 @@ export * from '@mikro-orm/sql';
 export * from './MySqlDriver.js';
 export * from './MySqlPlatform.js';
 export * from './MySqlConnection.js';
-export { MySqlMikroORM as MikroORM, defineMySqlConfig as defineConfig } from './MySqlMikroORM.js';
+export { MySqlMikroORM as MikroORM, defineMySqlConfig as defineConfig, } from './MySqlMikroORM.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/mysql",
-  "version": "7.0.14",
+  "version": "7.0.15-dev.0",
   "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",
@@ -47,7 +47,7 @@
     "copy": "node ../../scripts/copy.mjs"
   },
   "dependencies": {
-    "@mikro-orm/sql": "7.0.14",
+    "@mikro-orm/sql": "7.0.15-dev.0",
     "kysely": "0.28.17",
     "mysql2": "3.22.3",
     "sqlstring": "2.3.3"
@@ -56,7 +56,7 @@
     "@mikro-orm/core": "^7.0.14"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.14"
+    "@mikro-orm/core": "7.0.15-dev.0"
   },
   "engines": {
     "node": ">= 22.17.0"