@mikro-orm/mysql 7.0.17 → 7.0.18-dev.0

package/MySqlConnection.d.ts

@@ -1,9 +1,11 @@
 import { type ControlledTransaction, MysqlDialect } from 'kysely';
 import { type PoolOptions } from 'mysql2';
+import { type Routine, type Transaction } from '@mikro-orm/core';
 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;
+    callRoutine<T>(routine: Routine, args?: Record<string, unknown>, ctx?: Transaction): Promise<T>;
     commit(ctx: ControlledTransaction<any, any>, eventBroadcaster?: TransactionEventBroadcaster): Promise<void>;
 }

package/MySqlConnection.js

@@ -70,6 +70,52 @@ export class MySqlConnection extends AbstractSqlConnection {
         ret.dateStrings = true;
         return Utils.mergeConfig(ret, overrides);
     }
+    async callRoutine(routine, args = {}, ctx) {
+        if (routine.type === 'function') {
+            return this.callRoutineFunction(routine, args, ctx);
+        }
+        const name = this.platform.quoteIdentifier(routine.name);
+        const callPlaceholders = [];
+        const callValues = [];
+        const outVarParams = [];
+        routine.params.forEach((p, i) => {
+            if (p.direction === 'in') {
+                callPlaceholders.push('?');
+                callValues.push(this.convertRoutineInbound(args[p.name], p));
+                return;
+            }
+            const varName = `@_mikro_orm_routine_${i}`;
+            outVarParams.push({ name: p.name, varName, param: p });
+            callPlaceholders.push(varName);
+        });
+        // MySQL `@var`s are connection-scoped, so SET + CALL + SELECT must share one physical
+        // connection — wrap in an implicit transaction when the caller didn't supply one.
+        const needsConnectionAffinity = outVarParams.length > 0 && !ctx;
+        const runSteps = async (sharedCtx) => {
+            for (let i = 0; i < routine.params.length; i++) {
+                const p = routine.params[i];
+                if (p.direction === 'inout') {
+                    const varName = `@_mikro_orm_routine_${i}`;
+                    await this.execute(`set ${varName} := ?`, [this.convertRoutineInbound(args[p.name], p)], 'run', sharedCtx);
+                }
+            }
+            // mysql2 trails the result sets with an OK packet (non-array); filter to row arrays.
+            const callResult = (await this.execute(`call ${name}(${callPlaceholders.join(', ')})`, callValues, 'all', sharedCtx));
+            const resultSets = callResult.filter(Array.isArray);
+            if (outVarParams.length > 0) {
+                const selectClause = outVarParams
+                    .map(o => `${o.varName} as ${this.platform.quoteIdentifier(o.name)}`)
+                    .join(', ');
+                const rows = (await this.execute(`select ${selectClause}`, [], 'all', sharedCtx));
+                this.applyRoutineOutParams(rows[0] ?? {}, outVarParams.map(o => o.param), args);
+            }
+            return (resultSets.length > 0 ? resultSets : undefined);
+        };
+        if (needsConnectionAffinity) {
+            return this.transactional(trx => runSteps(trx));
+        }
+        return runSteps(ctx);
+    }
     async commit(ctx, eventBroadcaster) {
         if (!ctx.isRolledBack && 'savepointName' in ctx) {
             try {

package/MySqlMikroORM.d.ts

@@ -2,17 +2,17 @@ import { type AnyEntity, type EntityClass, type EntitySchema, type MikroORM, typ
 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 readonly (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 readonly (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> {
+export declare class MySqlMikroORM<EM extends SqlEntityManager<MySqlDriver> = SqlEntityManager<MySqlDriver>, Entities extends readonly (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>>;
+    static init<D extends IDatabaseDriver = MySqlDriver, EM extends EntityManager<D> = D[typeof EntityManagerType] & EntityManager<D>, Entities extends readonly (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Partial<Options<D, EM, Entities>>): Promise<MikroORM<D, EM, Entities>>;
     /**
      * @inheritDoc
      */

package/README.md

@@ -2,7 +2,7 @@
   <a href="https://mikro-orm.io"><img src="https://raw.githubusercontent.com/mikro-orm/mikro-orm/master/docs/static/img/logo-readme.svg?sanitize=true" alt="MikroORM" /></a>
 </h1>
 
-TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-orm.io/docs/unit-of-work/) and [Identity Map](https://mikro-orm.io/docs/identity-map/) patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL, SQLite (including libSQL), MSSQL and Oracle databases.
+TypeScript ORM for Node.js based on Data Mapper, [Unit of Work](https://mikro-orm.io/docs/unit-of-work/) and [Identity Map](https://mikro-orm.io/docs/identity-map/) patterns. Supports MongoDB, MySQL, MariaDB, PostgreSQL (including CockroachDB and PGlite), SQLite (including libSQL), MSSQL and Oracle databases.
 
 > Heavily inspired by [Doctrine](https://www.doctrine-project.org/) and [Hibernate](https://hibernate.org/).
 
@@ -19,6 +19,7 @@ Install a driver package for your database:
 
 ```sh
 npm install @mikro-orm/postgresql   # PostgreSQL
+npm install @mikro-orm/pglite       # PGlite (embedded PostgreSQL in WASM)
 npm install @mikro-orm/mysql        # MySQL
 npm install @mikro-orm/mariadb      # MariaDB
 npm install @mikro-orm/sqlite       # SQLite

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/mysql",
-  "version": "7.0.17",
+  "version": "7.0.18-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.17",
+    "@mikro-orm/sql": "7.0.18-dev.0",
     "kysely": "0.29.2",
     "mysql2": "3.22.3",
     "sqlstring": "2.3.3"
@@ -56,7 +56,7 @@
     "@mikro-orm/core": "^7.0.17"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.17"
+    "@mikro-orm/core": "7.0.18-dev.0"
   },
   "engines": {
     "node": ">= 22.17.0"