@mikro-orm/mysql 7.0.3-dev.9 → 7.0.3

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): MysqlDialect;
-    mapOptions(overrides: PoolOptions): PoolOptions;
-    commit(ctx: ControlledTransaction<any, any>, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
+  createKyselyDialect(overrides: PoolOptions): MysqlDialect;
+  mapOptions(overrides: PoolOptions): PoolOptions;
+  commit(ctx: ControlledTransaction<any, any>, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
 }

package/MySqlConnection.js

@@ -3,55 +3,55 @@ import { createPool } from 'mysql2';
 import { Utils, AbstractSqlConnection } from '@mikro-orm/sql';
 /** MySQL database connection using the `mysql2` driver. */
 export class MySqlConnection extends AbstractSqlConnection {
-    createKyselyDialect(overrides) {
-        const options = this.mapOptions(overrides);
-        const password = options.password;
-        if (typeof password === 'function') {
-            return new MysqlDialect({
-                pool: async () => createPool({
-                    ...options,
-                    password: await password(),
-                }),
-                onCreateConnection: this.options.onCreateConnection ?? this.config.get('onCreateConnection'),
-            });
-        }
-        return new MysqlDialect({
-            pool: createPool(options),
-            onCreateConnection: this.options.onCreateConnection ?? this.config.get('onCreateConnection'),
-        });
+  createKyselyDialect(overrides) {
+    const options = this.mapOptions(overrides);
+    const password = options.password;
+    if (typeof password === 'function') {
+      return new MysqlDialect({
+        pool: async () =>
+          createPool({
+            ...options,
+            password: await password(),
+          }),
+        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';
-        }
-        if (this.config.get('timezone')) {
-            ret.timezone = this.config.get('timezone');
-        }
-        ret.supportBigNumbers = true;
-        ret.dateStrings = true;
-        return Utils.mergeConfig(ret, overrides);
+    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';
+    }
+    if (this.config.get('timezone')) {
+      ret.timezone = this.config.get('timezone');
     }
-    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));
+    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;
         }
-        await super.commit(ctx, eventBroadcaster);
+      }
+      return this.logQuery(this.platform.getReleaseSavepointSQL(ctx.savepointName));
     }
+    await super.commit(ctx, eventBroadcaster);
+  }
 }

package/MySqlDriver.d.ts

@@ -1,15 +1,33 @@
-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,54 +4,58 @@ 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']);
+  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;
     }
-    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;
+    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;
+  }
 }

package/MySqlMikroORM.d.ts

@@ -1,20 +1,58 @@
-import { type AnyEntity, type EntityClass, type EntitySchema, MikroORM, type Options, type IDatabaseDriver, type EntityManager, type EntityManagerType } from '@mikro-orm/core';
+import {
+  type AnyEntity,
+  type EntityClass,
+  type EntitySchema,
+  MikroORM,
+  type Options,
+  type IDatabaseDriver,
+  type EntityManager,
+  type EntityManagerType,
+} from '@mikro-orm/core';
 import 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 MikroORM<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 MikroORM<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,23 +1,23 @@
-import { defineConfig, MikroORM, } from '@mikro-orm/core';
+import { defineConfig, MikroORM } from '@mikro-orm/core';
 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 MikroORM {
-    /**
-     * @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

@@ -64,7 +64,7 @@ export class Book extends BookSchema.class {}
 BookSchema.setClass(Book);
 ```
 
-You can also define entities using [decorators](https://mikro-orm.io/docs/defining-entities) or [`EntitySchema`](https://mikro-orm.io/docs/entity-schema). See the [defining entities guide](https://mikro-orm.io/docs/defining-entities) for all options.
+You can also define entities using [decorators](https://mikro-orm.io/docs/using-decorators) or [`EntitySchema`](https://mikro-orm.io/docs/define-entity#entityschema-low-level-api). See the [defining entities guide](https://mikro-orm.io/docs/defining-entities) for all options.
 
 ### Initialize and Use
 
@@ -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,4 +2,8 @@ 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.3-dev.9",
+  "version": "7.0.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",
@@ -47,16 +47,16 @@
     "copy": "node ../../scripts/copy.mjs"
   },
   "dependencies": {
-    "@mikro-orm/sql": "7.0.3-dev.9",
+    "@mikro-orm/sql": "7.0.3",
     "kysely": "0.28.12",
     "mysql2": "3.20.0",
     "sqlstring": "2.3.3"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^7.0.2"
+    "@mikro-orm/core": "^7.0.3"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.3-dev.9"
+    "@mikro-orm/core": "7.0.3"
   },
   "engines": {
     "node": ">= 22.17.0"