@mikro-orm/migrations 7.0.4 → 7.0.5-dev.0

package/MigrationStorage.js

@@ -1,119 +1,114 @@
 import { defineEntity, p } from '@mikro-orm/core';
-import { DatabaseTable } from '@mikro-orm/sql';
+import { DatabaseTable, } from '@mikro-orm/sql';
 /** Tracks executed migrations in a database table. */
 export class MigrationStorage {
-  driver;
-  options;
-  #connection;
-  #helper;
-  #masterTransaction;
-  #platform;
-  constructor(driver, options) {
-    this.driver = driver;
-    this.options = options;
-    this.#connection = this.driver.getConnection();
-    this.#platform = this.driver.getPlatform();
-    this.#helper = this.#platform.getSchemaHelper();
-  }
-  async executed() {
-    const migrations = await this.getExecutedMigrations();
-    return migrations.map(({ name }) => this.getMigrationName(name));
-  }
-  async logMigration(params) {
-    const { entity } = this.getTableName();
-    const name = this.getMigrationName(params.name);
-    await this.driver.nativeInsert(entity, { name }, { ctx: this.#masterTransaction });
-  }
-  async unlogMigration(params) {
-    const { entity } = this.getTableName();
-    const withoutExt = this.getMigrationName(params.name);
-    const names = [withoutExt, withoutExt + '.js', withoutExt + '.ts'];
-    await this.driver.nativeDelete(
-      entity,
-      { name: { $in: [params.name, ...names] } },
-      { ctx: this.#masterTransaction },
-    );
-  }
-  async getExecutedMigrations() {
-    const { entity, schemaName } = this.getTableName();
-    const res = await this.driver
-      .createQueryBuilder(entity, this.#masterTransaction)
-      .withSchema(schemaName)
-      .orderBy({ id: 'asc' })
-      .execute('all', false);
-    return res.map(row => {
-      if (typeof row.executed_at === 'string' || typeof row.executed_at === 'number') {
-        row.executed_at = new Date(row.executed_at);
-      }
-      return row;
-    });
-  }
-  async ensureTable() {
-    const tables = await this.#connection.execute(this.#helper.getListTablesSQL(), [], 'all', this.#masterTransaction);
-    const { tableName, schemaName } = this.getTableName();
-    if (tables.find(t => t.table_name === tableName && (!t.schema_name || t.schema_name === schemaName))) {
-      return;
+    driver;
+    options;
+    #connection;
+    #helper;
+    #masterTransaction;
+    #platform;
+    constructor(driver, options) {
+        this.driver = driver;
+        this.options = options;
+        this.#connection = this.driver.getConnection();
+        this.#platform = this.driver.getPlatform();
+        this.#helper = this.#platform.getSchemaHelper();
     }
-    const schemas = await this.#helper.getNamespaces(this.#connection);
-    if (schemaName && !schemas.includes(schemaName)) {
-      const sql = this.#helper.getCreateNamespaceSQL(schemaName);
-      await this.#connection.execute(sql);
+    async executed() {
+        const migrations = await this.getExecutedMigrations();
+        return migrations.map(({ name }) => this.getMigrationName(name));
+    }
+    async logMigration(params) {
+        const { entity } = this.getTableName();
+        const name = this.getMigrationName(params.name);
+        await this.driver.nativeInsert(entity, { name }, { ctx: this.#masterTransaction });
+    }
+    async unlogMigration(params) {
+        const { entity } = this.getTableName();
+        const withoutExt = this.getMigrationName(params.name);
+        const names = [withoutExt, withoutExt + '.js', withoutExt + '.ts'];
+        await this.driver.nativeDelete(entity, { name: { $in: [params.name, ...names] } }, { ctx: this.#masterTransaction });
+    }
+    async getExecutedMigrations() {
+        const { entity, schemaName } = this.getTableName();
+        const res = await this.driver
+            .createQueryBuilder(entity, this.#masterTransaction)
+            .withSchema(schemaName)
+            .orderBy({ id: 'asc' })
+            .execute('all', false);
+        return res.map(row => {
+            if (typeof row.executed_at === 'string' || typeof row.executed_at === 'number') {
+                row.executed_at = new Date(row.executed_at);
+            }
+            return row;
+        });
+    }
+    async ensureTable() {
+        const tables = await this.#connection.execute(this.#helper.getListTablesSQL(), [], 'all', this.#masterTransaction);
+        const { tableName, schemaName } = this.getTableName();
+        if (tables.find(t => t.table_name === tableName && (!t.schema_name || t.schema_name === schemaName))) {
+            return;
+        }
+        const schemas = await this.#helper.getNamespaces(this.#connection);
+        if (schemaName && !schemas.includes(schemaName)) {
+            const sql = this.#helper.getCreateNamespaceSQL(schemaName);
+            await this.#connection.execute(sql);
+        }
+        const table = new DatabaseTable(this.#platform, tableName, schemaName);
+        table.addColumn({
+            name: 'id',
+            type: this.#platform.getIntegerTypeDeclarationSQL({ autoincrement: true, unsigned: true }),
+            mappedType: this.#platform.getMappedType('number'),
+            primary: true,
+            autoincrement: true,
+        });
+        table.addColumn({
+            name: 'name',
+            type: this.#platform.getVarcharTypeDeclarationSQL({}),
+            mappedType: this.#platform.getMappedType('string'),
+        });
+        const length = this.#platform.getDefaultDateTimeLength();
+        table.addColumn({
+            name: 'executed_at',
+            type: this.#platform.getDateTimeTypeDeclarationSQL({ length }),
+            mappedType: this.#platform.getMappedType('datetime'),
+            default: this.#platform.getCurrentTimestampSQL(length),
+            length,
+        });
+        const sql = this.#helper.createTable(table);
+        await this.#connection.execute(sql.join(';\n'), [], 'run', this.#masterTransaction);
+    }
+    setMasterMigration(trx) {
+        this.#masterTransaction = trx;
+    }
+    unsetMasterMigration() {
+        this.#masterTransaction = undefined;
+    }
+    /**
+     * @internal
+     */
+    getMigrationName(name) {
+        return name.replace(/\.[jt]s$/, '');
+    }
+    /**
+     * @internal
+     */
+    getTableName() {
+        const parts = this.options.tableName.split('.');
+        const tableName = parts.length > 1 ? parts[1] : parts[0];
+        const schemaName = parts.length > 1 ? parts[0] : this.driver.config.get('schema', this.driver.getPlatform().getDefaultSchemaName());
+        const entity = defineEntity({
+            name: 'Migration',
+            tableName,
+            schema: schemaName,
+            properties: {
+                id: p.integer().primary().fieldNames('id'),
+                name: p.string().fieldNames('name'),
+                executedAt: p.datetime().defaultRaw('current_timestamp').fieldNames('executed_at'),
+            },
+        }).init();
+        entity.meta.sync();
+        return { tableName, schemaName, entity };
     }
-    const table = new DatabaseTable(this.#platform, tableName, schemaName);
-    table.addColumn({
-      name: 'id',
-      type: this.#platform.getIntegerTypeDeclarationSQL({ autoincrement: true, unsigned: true }),
-      mappedType: this.#platform.getMappedType('number'),
-      primary: true,
-      autoincrement: true,
-    });
-    table.addColumn({
-      name: 'name',
-      type: this.#platform.getVarcharTypeDeclarationSQL({}),
-      mappedType: this.#platform.getMappedType('string'),
-    });
-    const length = this.#platform.getDefaultDateTimeLength();
-    table.addColumn({
-      name: 'executed_at',
-      type: this.#platform.getDateTimeTypeDeclarationSQL({ length }),
-      mappedType: this.#platform.getMappedType('datetime'),
-      default: this.#platform.getCurrentTimestampSQL(length),
-      length,
-    });
-    const sql = this.#helper.createTable(table);
-    await this.#connection.execute(sql.join(';\n'), [], 'run', this.#masterTransaction);
-  }
-  setMasterMigration(trx) {
-    this.#masterTransaction = trx;
-  }
-  unsetMasterMigration() {
-    this.#masterTransaction = undefined;
-  }
-  /**
-   * @internal
-   */
-  getMigrationName(name) {
-    return name.replace(/\.[jt]s$/, '');
-  }
-  /**
-   * @internal
-   */
-  getTableName() {
-    const parts = this.options.tableName.split('.');
-    const tableName = parts.length > 1 ? parts[1] : parts[0];
-    const schemaName =
-      parts.length > 1 ? parts[0] : this.driver.config.get('schema', this.driver.getPlatform().getDefaultSchemaName());
-    const entity = defineEntity({
-      name: 'Migration',
-      tableName,
-      schema: schemaName,
-      properties: {
-        id: p.integer().primary().fieldNames('id'),
-        name: p.string().fieldNames('name'),
-        executedAt: p.datetime().defaultRaw('current_timestamp').fieldNames('executed_at'),
-      },
-    }).init();
-    entity.meta.sync();
-    return { tableName, schemaName, entity };
-  }
 }

package/Migrator.d.ts

@@ -1,49 +1,39 @@
-import {
-  type IMigrationGenerator,
-  type IMigrationRunner,
-  type IMigratorStorage,
-  type MigrateOptions,
-  type MigrationInfo,
-  type MikroORM,
-} from '@mikro-orm/core';
+import { type IMigrationGenerator, type IMigrationRunner, type IMigratorStorage, type MigrateOptions, type MigrationInfo, type MikroORM } from '@mikro-orm/core';
 import { AbstractMigrator } from '@mikro-orm/core/migrations';
 import { type AbstractSqlDriver, DatabaseSchema, type EntityManager } from '@mikro-orm/sql';
 import { MigrationStorage } from './MigrationStorage.js';
 import type { MigrationResult } from './typings.js';
 /** Manages SQL database migrations: creation, execution, and rollback of schema changes. */
 export declare class Migrator extends AbstractMigrator<AbstractSqlDriver> {
-  #private;
-  constructor(em: EntityManager);
-  static register(orm: MikroORM): void;
-  protected createRunner(): IMigrationRunner;
-  protected createStorage(): IMigratorStorage;
-  protected getDefaultGenerator(): IMigrationGenerator;
-  private getSnapshotPath;
-  protected init(): Promise<void>;
-  /**
-   * @inheritDoc
-   */
-  create(path?: string, blank?: boolean, initial?: boolean, name?: string): Promise<MigrationResult>;
-  checkSchema(): Promise<boolean>;
-  /**
-   * @inheritDoc
-   */
-  createInitial(path?: string, name?: string, blank?: boolean): Promise<MigrationResult>;
-  protected runMigrations(
-    method: 'up' | 'down',
-    options?: string | string[] | MigrateOptions,
-  ): Promise<MigrationInfo[]>;
-  getStorage(): MigrationStorage;
-  /**
-   * Initial migration can be created only if:
-   * 1. no previous migrations were generated or executed
-   * 2. existing schema do not contain any of the tables defined by metadata
-   *
-   * If existing schema contains all of the tables already, we return true, based on that we mark the migration as already executed.
-   * If only some of the tables are present, exception is thrown.
-   */
-  private validateInitialMigration;
-  protected getSchemaFromSnapshot(): Promise<DatabaseSchema | undefined>;
-  protected storeCurrentSchema(schema?: DatabaseSchema): Promise<void>;
-  private getSchemaDiff;
+    #private;
+    constructor(em: EntityManager);
+    static register(orm: MikroORM): void;
+    protected createRunner(): IMigrationRunner;
+    protected createStorage(): IMigratorStorage;
+    protected getDefaultGenerator(): IMigrationGenerator;
+    private getSnapshotPath;
+    protected init(): Promise<void>;
+    /**
+     * @inheritDoc
+     */
+    create(path?: string, blank?: boolean, initial?: boolean, name?: string): Promise<MigrationResult>;
+    checkSchema(): Promise<boolean>;
+    /**
+     * @inheritDoc
+     */
+    createInitial(path?: string, name?: string, blank?: boolean): Promise<MigrationResult>;
+    protected runMigrations(method: 'up' | 'down', options?: string | string[] | MigrateOptions): Promise<MigrationInfo[]>;
+    getStorage(): MigrationStorage;
+    /**
+     * Initial migration can be created only if:
+     * 1. no previous migrations were generated or executed
+     * 2. existing schema do not contain any of the tables defined by metadata
+     *
+     * If existing schema contains all of the tables already, we return true, based on that we mark the migration as already executed.
+     * If only some of the tables are present, exception is thrown.
+     */
+    private validateInitialMigration;
+    protected getSchemaFromSnapshot(): Promise<DatabaseSchema | undefined>;
+    protected storeCurrentSchema(schema?: DatabaseSchema): Promise<void>;
+    private getSchemaDiff;
 }