@mikro-orm/sql 7.0.4 → 7.0.5-dev.1

package/dialects/mysql/BaseMySqlPlatform.js

@@ -1,140 +1,137 @@
-import { Utils, QueryOrder, DecimalType, DoubleType } from '@mikro-orm/core';
+import { Utils, QueryOrder, DecimalType, DoubleType, } from '@mikro-orm/core';
 import { MySqlSchemaHelper } from './MySqlSchemaHelper.js';
 import { MySqlExceptionConverter } from './MySqlExceptionConverter.js';
 import { AbstractSqlPlatform } from '../../AbstractSqlPlatform.js';
 import { MySqlNativeQueryBuilder } from './MySqlNativeQueryBuilder.js';
 export class BaseMySqlPlatform extends AbstractSqlPlatform {
-  schemaHelper = new MySqlSchemaHelper(this);
-  exceptionConverter = new MySqlExceptionConverter();
-  #jsonTypeCasts = {
-    string: 'text',
-    number: 'double',
-    bigint: 'bigint',
-    boolean: 'unsigned',
-  };
-  ORDER_BY_NULLS_TRANSLATE = {
-    [QueryOrder.asc_nulls_first]: 'is not null',
-    [QueryOrder.asc_nulls_last]: 'is null',
-    [QueryOrder.desc_nulls_first]: 'is not null',
-    [QueryOrder.desc_nulls_last]: 'is null',
-  };
-  /** @internal */
-  createNativeQueryBuilder() {
-    return new MySqlNativeQueryBuilder(this);
-  }
-  getDefaultCharset() {
-    return 'utf8mb4';
-  }
-  init(orm) {
-    super.init(orm);
-    orm.config.get('schemaGenerator').disableForeignKeysForClear ??= true;
-  }
-  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;
-    }
-    return JSON.stringify(value);
-  }
-  getJsonIndexDefinition(index) {
-    return index.columnNames.map(column => {
-      if (!column.includes('.')) {
-        return column;
-      }
-      const [root, ...path] = column.split('.');
-      return `(json_value(${this.quoteIdentifier(root)}, '$.${path.join('.')}' returning ${index.options?.returning ?? 'char(255)'}))`;
-    });
-  }
-  getBooleanTypeDeclarationSQL() {
-    return 'tinyint(1)';
-  }
-  normalizeColumnType(type, options) {
-    const simpleType = this.extractSimpleType(type);
-    if (['decimal', 'numeric'].includes(simpleType)) {
-      return this.getDecimalTypeDeclarationSQL(options);
-    }
-    return type;
-  }
-  getDefaultMappedType(type) {
-    if (type === 'tinyint(1)') {
-      return super.getDefaultMappedType('boolean');
-    }
-    return super.getDefaultMappedType(type);
-  }
-  isNumericColumn(mappedType) {
-    return super.isNumericColumn(mappedType) || [DecimalType, DoubleType].some(t => mappedType instanceof t);
-  }
-  supportsUnsigned() {
-    return true;
-  }
-  /**
-   * Returns the default name of index for the given columns
-   * cannot go past 64 character length for identifiers in MySQL
-   */
-  getIndexName(tableName, columns, type) {
-    if (type === 'primary') {
-      return this.getDefaultPrimaryName(tableName, columns);
-    }
-    const indexName = super.getIndexName(tableName, columns, type);
-    if (indexName.length > 64) {
-      return `${indexName.substring(0, 56 - type.length)}_${Utils.hash(indexName, 5)}_${type}`;
-    }
-    return indexName;
-  }
-  getDefaultPrimaryName(tableName, columns) {
-    return 'PRIMARY'; // https://dev.mysql.com/doc/refman/8.0/en/create-table.html#create-table-indexes-keys
-  }
-  supportsCreatingFullTextIndex() {
-    return true;
-  }
-  getFullTextWhereClause() {
-    return `match(:column:) against (:query in boolean mode)`;
-  }
-  getFullTextIndexExpression(indexName, schemaName, tableName, columns) {
-    /* v8 ignore next */
-    const quotedTableName = this.quoteIdentifier(schemaName ? `${schemaName}.${tableName}` : tableName);
-    const quotedColumnNames = columns.map(c => this.quoteIdentifier(c.name));
-    const quotedIndexName = this.quoteIdentifier(indexName);
-    return `alter table ${quotedTableName} add fulltext index ${quotedIndexName}(${quotedColumnNames.join(',')})`;
-  }
-  getOrderByExpression(column, direction, collation) {
-    const ret = [];
-    const dir = direction.toLowerCase();
-    const col = collation ? `${column} collate ${this.quoteCollation(collation)}` : column;
-    if (dir in this.ORDER_BY_NULLS_TRANSLATE) {
-      ret.push(`${col} ${this.ORDER_BY_NULLS_TRANSLATE[dir]}`);
-    }
-    ret.push(`${col} ${dir.replace(/(\s|nulls|first|last)*/gi, '')}`);
-    return ret;
-  }
-  getJsonArrayFromSQL(column, alias, properties) {
-    const columns = properties
-      .map(
-        p =>
-          `${this.quoteIdentifier(p.name)} ${this.#jsonTypeCasts[p.type] ?? 'text'} path '$.${this.quoteJsonKey(p.name)}'`,
-      )
-      .join(', ');
-    return `json_table(${column}, '$[*]' columns (${columns})) as ${this.quoteIdentifier(alias)}`;
-  }
-  // MySQL does not support correlated json_table inside EXISTS subqueries,
-  // so we use a semi-join via the comma-join pattern instead.
-  getJsonArrayExistsSQL(from, where) {
-    return `(select 1 from ${from} where ${where} limit 1) is not null`;
-  }
-  getDefaultClientUrl() {
-    return 'mysql://root@127.0.0.1:3306';
-  }
+    schemaHelper = new MySqlSchemaHelper(this);
+    exceptionConverter = new MySqlExceptionConverter();
+    #jsonTypeCasts = {
+        string: 'text',
+        number: 'double',
+        bigint: 'bigint',
+        boolean: 'unsigned',
+    };
+    ORDER_BY_NULLS_TRANSLATE = {
+        [QueryOrder.asc_nulls_first]: 'is not null',
+        [QueryOrder.asc_nulls_last]: 'is null',
+        [QueryOrder.desc_nulls_first]: 'is not null',
+        [QueryOrder.desc_nulls_last]: 'is null',
+    };
+    /** @internal */
+    createNativeQueryBuilder() {
+        return new MySqlNativeQueryBuilder(this);
+    }
+    getDefaultCharset() {
+        return 'utf8mb4';
+    }
+    init(orm) {
+        super.init(orm);
+        orm.config.get('schemaGenerator').disableForeignKeysForClear ??= true;
+    }
+    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;
+        }
+        return JSON.stringify(value);
+    }
+    getJsonIndexDefinition(index) {
+        return index.columnNames.map(column => {
+            if (!column.includes('.')) {
+                return column;
+            }
+            const [root, ...path] = column.split('.');
+            return `(json_value(${this.quoteIdentifier(root)}, '$.${path.join('.')}' returning ${index.options?.returning ?? 'char(255)'}))`;
+        });
+    }
+    getBooleanTypeDeclarationSQL() {
+        return 'tinyint(1)';
+    }
+    normalizeColumnType(type, options) {
+        const simpleType = this.extractSimpleType(type);
+        if (['decimal', 'numeric'].includes(simpleType)) {
+            return this.getDecimalTypeDeclarationSQL(options);
+        }
+        return type;
+    }
+    getDefaultMappedType(type) {
+        if (type === 'tinyint(1)') {
+            return super.getDefaultMappedType('boolean');
+        }
+        return super.getDefaultMappedType(type);
+    }
+    isNumericColumn(mappedType) {
+        return super.isNumericColumn(mappedType) || [DecimalType, DoubleType].some(t => mappedType instanceof t);
+    }
+    supportsUnsigned() {
+        return true;
+    }
+    /**
+     * Returns the default name of index for the given columns
+     * cannot go past 64 character length for identifiers in MySQL
+     */
+    getIndexName(tableName, columns, type) {
+        if (type === 'primary') {
+            return this.getDefaultPrimaryName(tableName, columns);
+        }
+        const indexName = super.getIndexName(tableName, columns, type);
+        if (indexName.length > 64) {
+            return `${indexName.substring(0, 56 - type.length)}_${Utils.hash(indexName, 5)}_${type}`;
+        }
+        return indexName;
+    }
+    getDefaultPrimaryName(tableName, columns) {
+        return 'PRIMARY'; // https://dev.mysql.com/doc/refman/8.0/en/create-table.html#create-table-indexes-keys
+    }
+    supportsCreatingFullTextIndex() {
+        return true;
+    }
+    getFullTextWhereClause() {
+        return `match(:column:) against (:query in boolean mode)`;
+    }
+    getFullTextIndexExpression(indexName, schemaName, tableName, columns) {
+        /* v8 ignore next */
+        const quotedTableName = this.quoteIdentifier(schemaName ? `${schemaName}.${tableName}` : tableName);
+        const quotedColumnNames = columns.map(c => this.quoteIdentifier(c.name));
+        const quotedIndexName = this.quoteIdentifier(indexName);
+        return `alter table ${quotedTableName} add fulltext index ${quotedIndexName}(${quotedColumnNames.join(',')})`;
+    }
+    getOrderByExpression(column, direction, collation) {
+        const ret = [];
+        const dir = direction.toLowerCase();
+        const col = collation ? `${column} collate ${this.quoteCollation(collation)}` : column;
+        if (dir in this.ORDER_BY_NULLS_TRANSLATE) {
+            ret.push(`${col} ${this.ORDER_BY_NULLS_TRANSLATE[dir]}`);
+        }
+        ret.push(`${col} ${dir.replace(/(\s|nulls|first|last)*/gi, '')}`);
+        return ret;
+    }
+    getJsonArrayFromSQL(column, alias, properties) {
+        const columns = properties
+            .map(p => `${this.quoteIdentifier(p.name)} ${this.#jsonTypeCasts[p.type] ?? 'text'} path '$.${this.quoteJsonKey(p.name)}'`)
+            .join(', ');
+        return `json_table(${column}, '$[*]' columns (${columns})) as ${this.quoteIdentifier(alias)}`;
+    }
+    // MySQL does not support correlated json_table inside EXISTS subqueries,
+    // so we use a semi-join via the comma-join pattern instead.
+    getJsonArrayExistsSQL(from, where) {
+        return `(select 1 from ${from} where ${where} limit 1) is not null`;
+    }
+    getDefaultClientUrl() {
+        return 'mysql://root@127.0.0.1:3306';
+    }
 }

package/dialects/mysql/MySqlExceptionConverter.d.ts

@@ -1,9 +1,9 @@
 import { ExceptionConverter, type Dictionary, type DriverException } from '@mikro-orm/core';
 export declare class MySqlExceptionConverter extends ExceptionConverter {
-  /**
-   * @see http://dev.mysql.com/doc/refman/5.7/en/error-messages-client.html
-   * @see http://dev.mysql.com/doc/refman/5.7/en/error-messages-server.html
-   * @see https://github.com/doctrine/dbal/blob/master/src/Driver/AbstractMySQLDriver.php
-   */
-  convertException(exception: Error & Dictionary): DriverException;
+    /**
+     * @see http://dev.mysql.com/doc/refman/5.7/en/error-messages-client.html
+     * @see http://dev.mysql.com/doc/refman/5.7/en/error-messages-server.html
+     * @see https://github.com/doctrine/dbal/blob/master/src/Driver/AbstractMySQLDriver.php
+     */
+    convertException(exception: Error & Dictionary): DriverException;
 }

package/dialects/mysql/MySqlExceptionConverter.js

@@ -1,94 +1,80 @@
-import {
-  DeadlockException,
-  LockWaitTimeoutException,
-  TableExistsException,
-  TableNotFoundException,
-  ForeignKeyConstraintViolationException,
-  UniqueConstraintViolationException,
-  InvalidFieldNameException,
-  NonUniqueFieldNameException,
-  SyntaxErrorException,
-  ConnectionException,
-  NotNullConstraintViolationException,
-  ExceptionConverter,
-  CheckConstraintViolationException,
-} from '@mikro-orm/core';
+import { DeadlockException, LockWaitTimeoutException, TableExistsException, TableNotFoundException, ForeignKeyConstraintViolationException, UniqueConstraintViolationException, InvalidFieldNameException, NonUniqueFieldNameException, SyntaxErrorException, ConnectionException, NotNullConstraintViolationException, ExceptionConverter, CheckConstraintViolationException, } from '@mikro-orm/core';
 export class MySqlExceptionConverter extends ExceptionConverter {
-  /**
-   * @see http://dev.mysql.com/doc/refman/5.7/en/error-messages-client.html
-   * @see http://dev.mysql.com/doc/refman/5.7/en/error-messages-server.html
-   * @see https://github.com/doctrine/dbal/blob/master/src/Driver/AbstractMySQLDriver.php
-   */
-  convertException(exception) {
-    /* v8 ignore next */
-    switch (exception.errno) {
-      case 1213:
-        return new DeadlockException(exception);
-      case 1205:
-        return new LockWaitTimeoutException(exception);
-      case 1050:
-        return new TableExistsException(exception);
-      case 1051:
-      case 1146:
-        return new TableNotFoundException(exception);
-      case 1216:
-      case 1217:
-      case 1451:
-      case 1452:
-      case 1701:
-        return new ForeignKeyConstraintViolationException(exception);
-      case 3819:
-      case 4025:
-        return new CheckConstraintViolationException(exception);
-      case 1062:
-      case 1557:
-      case 1569:
-      case 1586:
-        return new UniqueConstraintViolationException(exception);
-      case 1054:
-      case 1166:
-      case 1611:
-        return new InvalidFieldNameException(exception);
-      case 1052:
-      case 1060:
-      case 1110:
-        return new NonUniqueFieldNameException(exception);
-      case 1064:
-      case 1149:
-      case 1287:
-      case 1341:
-      case 1342:
-      case 1343:
-      case 1344:
-      case 1382:
-      case 1479:
-      case 1541:
-      case 1554:
-      case 1626:
-        return new SyntaxErrorException(exception);
-      case 1044:
-      case 1045:
-      case 1046:
-      case 1049:
-      case 1095:
-      case 1142:
-      case 1143:
-      case 1227:
-      case 1370:
-      case 1429:
-      case 2002:
-      case 2005:
-        return new ConnectionException(exception);
-      case 1048:
-      case 1121:
-      case 1138:
-      case 1171:
-      case 1252:
-      case 1263:
-      case 1364:
-      case 1566:
-        return new NotNullConstraintViolationException(exception);
+    /**
+     * @see http://dev.mysql.com/doc/refman/5.7/en/error-messages-client.html
+     * @see http://dev.mysql.com/doc/refman/5.7/en/error-messages-server.html
+     * @see https://github.com/doctrine/dbal/blob/master/src/Driver/AbstractMySQLDriver.php
+     */
+    convertException(exception) {
+        /* v8 ignore next */
+        switch (exception.errno) {
+            case 1213:
+                return new DeadlockException(exception);
+            case 1205:
+                return new LockWaitTimeoutException(exception);
+            case 1050:
+                return new TableExistsException(exception);
+            case 1051:
+            case 1146:
+                return new TableNotFoundException(exception);
+            case 1216:
+            case 1217:
+            case 1451:
+            case 1452:
+            case 1701:
+                return new ForeignKeyConstraintViolationException(exception);
+            case 3819:
+            case 4025:
+                return new CheckConstraintViolationException(exception);
+            case 1062:
+            case 1557:
+            case 1569:
+            case 1586:
+                return new UniqueConstraintViolationException(exception);
+            case 1054:
+            case 1166:
+            case 1611:
+                return new InvalidFieldNameException(exception);
+            case 1052:
+            case 1060:
+            case 1110:
+                return new NonUniqueFieldNameException(exception);
+            case 1064:
+            case 1149:
+            case 1287:
+            case 1341:
+            case 1342:
+            case 1343:
+            case 1344:
+            case 1382:
+            case 1479:
+            case 1541:
+            case 1554:
+            case 1626:
+                return new SyntaxErrorException(exception);
+            case 1044:
+            case 1045:
+            case 1046:
+            case 1049:
+            case 1095:
+            case 1142:
+            case 1143:
+            case 1227:
+            case 1370:
+            case 1429:
+            case 2002:
+            case 2005:
+                return new ConnectionException(exception);
+            case 1048:
+            case 1121:
+            case 1138:
+            case 1171:
+            case 1252:
+            case 1263:
+            case 1364:
+            case 1566:
+                return new NotNullConstraintViolationException(exception);
+        }
+        return super.convertException(exception);
     }
-    return super.convertException(exception);
-  }
 }

package/dialects/mysql/MySqlNativeQueryBuilder.d.ts

@@ -1,7 +1,7 @@
 import { NativeQueryBuilder } from '../../query/NativeQueryBuilder.js';
 /** @internal */
 export declare class MySqlNativeQueryBuilder extends NativeQueryBuilder {
-  protected compileInsert(): void;
-  protected addLockClause(): void;
-  protected addOnConflictClause(): void;
+    protected compileInsert(): void;
+    protected addLockClause(): void;
+    protected addOnConflictClause(): void;
 }

package/dialects/mysql/MySqlNativeQueryBuilder.js

@@ -2,73 +2,76 @@ import { LockMode, RawQueryFragment, Utils } from '@mikro-orm/core';
 import { NativeQueryBuilder } from '../../query/NativeQueryBuilder.js';
 /** @internal */
 export class MySqlNativeQueryBuilder extends NativeQueryBuilder {
-  compileInsert() {
-    if (!this.options.data) {
-      throw new Error('No data provided');
+    compileInsert() {
+        if (!this.options.data) {
+            throw new Error('No data provided');
+        }
+        this.parts.push('insert');
+        if (this.options.onConflict?.ignore) {
+            this.parts.push('ignore');
+        }
+        this.addHintComment();
+        this.parts.push(`into ${this.getTableName()}`);
+        if (Object.keys(this.options.data).length === 0) {
+            this.parts.push('default values');
+            return;
+        }
+        const parts = this.processInsertData();
+        this.parts.push(parts.join(', '));
     }
-    this.parts.push('insert');
-    if (this.options.onConflict?.ignore) {
-      this.parts.push('ignore');
+    addLockClause() {
+        if (!this.options.lockMode) {
+            return;
+        }
+        const map = {
+            [LockMode.PESSIMISTIC_READ]: 'lock in share mode',
+            [LockMode.PESSIMISTIC_WRITE]: 'for update',
+            [LockMode.PESSIMISTIC_PARTIAL_WRITE]: 'for update skip locked',
+            [LockMode.PESSIMISTIC_WRITE_OR_FAIL]: 'for update nowait',
+            [LockMode.PESSIMISTIC_PARTIAL_READ]: 'lock in share mode skip locked',
+            [LockMode.PESSIMISTIC_READ_OR_FAIL]: 'lock in share mode nowait',
+        };
+        if (this.options.lockMode !== LockMode.OPTIMISTIC) {
+            this.parts.push(map[this.options.lockMode]);
+        }
     }
-    this.addHintComment();
-    this.parts.push(`into ${this.getTableName()}`);
-    if (Object.keys(this.options.data).length === 0) {
-      this.parts.push('default values');
-      return;
+    addOnConflictClause() {
+        const clause = this.options.onConflict;
+        if (!clause || clause.ignore) {
+            return;
+        }
+        if (clause.merge) {
+            this.parts.push('on duplicate key update');
+            if (Utils.isObject(clause.merge)) {
+                const fields = Object.keys(clause.merge).map(field => {
+                    this.params.push(clause.merge[field]);
+                    return `${this.quote(field)} = ?`;
+                });
+                this.parts.push(fields.join(', '));
+            }
+            else if (clause.merge.length === 0) {
+                const dataAsArray = Utils.asArray(this.options.data);
+                const keys = Object.keys(dataAsArray[0]);
+                this.parts.push(keys.map(key => `${this.quote(key)} = values(${this.quote(key)})`).join(', '));
+            }
+            else {
+                const fields = clause.merge.map(key => `${this.quote(key)} = values(${this.quote(key)})`);
+                this.parts.push(fields.join(', '));
+            }
+            if (clause.where) {
+                this.parts.push(`where ${clause.where.sql}`);
+                this.params.push(...clause.where.params);
+            }
+            return;
+        }
+        this.parts.push('on conflict');
+        if (clause.fields instanceof RawQueryFragment) {
+            this.parts.push(clause.fields.sql);
+            this.params.push(...clause.fields.params);
+        }
+        else if (clause.fields.length > 0) {
+            const fields = clause.fields.map(field => this.quote(field));
+            this.parts.push(`(${fields.join(', ')})`);
+        }
     }
-    const parts = this.processInsertData();
-    this.parts.push(parts.join(', '));
-  }
-  addLockClause() {
-    if (!this.options.lockMode) {
-      return;
-    }
-    const map = {
-      [LockMode.PESSIMISTIC_READ]: 'lock in share mode',
-      [LockMode.PESSIMISTIC_WRITE]: 'for update',
-      [LockMode.PESSIMISTIC_PARTIAL_WRITE]: 'for update skip locked',
-      [LockMode.PESSIMISTIC_WRITE_OR_FAIL]: 'for update nowait',
-      [LockMode.PESSIMISTIC_PARTIAL_READ]: 'lock in share mode skip locked',
-      [LockMode.PESSIMISTIC_READ_OR_FAIL]: 'lock in share mode nowait',
-    };
-    if (this.options.lockMode !== LockMode.OPTIMISTIC) {
-      this.parts.push(map[this.options.lockMode]);
-    }
-  }
-  addOnConflictClause() {
-    const clause = this.options.onConflict;
-    if (!clause || clause.ignore) {
-      return;
-    }
-    if (clause.merge) {
-      this.parts.push('on duplicate key update');
-      if (Utils.isObject(clause.merge)) {
-        const fields = Object.keys(clause.merge).map(field => {
-          this.params.push(clause.merge[field]);
-          return `${this.quote(field)} = ?`;
-        });
-        this.parts.push(fields.join(', '));
-      } else if (clause.merge.length === 0) {
-        const dataAsArray = Utils.asArray(this.options.data);
-        const keys = Object.keys(dataAsArray[0]);
-        this.parts.push(keys.map(key => `${this.quote(key)} = values(${this.quote(key)})`).join(', '));
-      } else {
-        const fields = clause.merge.map(key => `${this.quote(key)} = values(${this.quote(key)})`);
-        this.parts.push(fields.join(', '));
-      }
-      if (clause.where) {
-        this.parts.push(`where ${clause.where.sql}`);
-        this.params.push(...clause.where.params);
-      }
-      return;
-    }
-    this.parts.push('on conflict');
-    if (clause.fields instanceof RawQueryFragment) {
-      this.parts.push(clause.fields.sql);
-      this.params.push(...clause.fields.params);
-    } else if (clause.fields.length > 0) {
-      const fields = clause.fields.map(field => this.quote(field));
-      this.parts.push(`(${fields.join(', ')})`);
-    }
-  }
 }