Skip to content

Commit

Permalink
refactor: rename SchemaGenerator to SqlSchemaGenerator
Browse files Browse the repository at this point in the history
But keep it reexported with the old name to.
  • Loading branch information
B4nan committed Jan 13, 2023
1 parent d624525 commit eec881d
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions packages/knex/src/AbstractSqlPlatform.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type { Constructor, EntityManager, EntityRepository, IDatabaseDriver, Mik
import { JsonProperty, Platform, Utils } from '@mikro-orm/core';
import { SqlEntityRepository } from './SqlEntityRepository';
import type { SchemaHelper } from './schema';
import { SchemaGenerator } from './schema';
import { SqlSchemaGenerator } from './schema';

export abstract class AbstractSqlPlatform extends Platform {

Expand All @@ -27,12 +27,12 @@ export abstract class AbstractSqlPlatform extends Platform {

/** @inheritDoc */
lookupExtensions(orm: MikroORM): void {
SchemaGenerator.register(orm);
SqlSchemaGenerator.register(orm);
}

/* istanbul ignore next: kept for type inference only */
getSchemaGenerator(driver: IDatabaseDriver, em?: EntityManager): SchemaGenerator {
return new SchemaGenerator(em ?? driver as any);
getSchemaGenerator(driver: IDatabaseDriver, em?: EntityManager): SqlSchemaGenerator {
return new SqlSchemaGenerator(em ?? driver as any);
}

quoteValue(value: any): string {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,14 @@ import type { DatabaseTable } from './DatabaseTable';
import type { AbstractSqlDriver } from '../AbstractSqlDriver';
import { SchemaComparator } from './SchemaComparator';

/**
* Should be renamed to `SqlSchemaGenerator` in v6
*/
export class SchemaGenerator extends AbstractSchemaGenerator<AbstractSqlDriver> implements ISchemaGenerator {
export class SqlSchemaGenerator extends AbstractSchemaGenerator<AbstractSqlDriver> implements ISchemaGenerator {

private readonly helper = this.platform.getSchemaHelper()!;
private readonly options = this.config.get('schemaGenerator');
protected lastEnsuredDatabase?: string;

static register(orm: MikroORM): void {
orm.config.registerExtension('@mikro-orm/schema-generator', () => new SchemaGenerator(orm.em));
orm.config.registerExtension('@mikro-orm/schema-generator', () => new SqlSchemaGenerator(orm.em));
}

/** @deprecated use `dropSchema` and `createSchema` commands respectively */
Expand Down Expand Up @@ -603,3 +600,6 @@ export class SchemaGenerator extends AbstractSchemaGenerator<AbstractSqlDriver>
}

}

// for back compatibility
export { SqlSchemaGenerator as SchemaGenerator };
2 changes: 1 addition & 1 deletion packages/knex/src/schema/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
export * from './DatabaseSchema';
export * from './DatabaseTable';
export * from './SchemaGenerator';
export * from './SqlSchemaGenerator';
export * from './SchemaHelper';
export * from './SchemaComparator';
4 changes: 2 additions & 2 deletions packages/migrations/src/Migrator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { ensureDir, pathExists, writeJSON } from 'fs-extra';
import type { Constructor, Dictionary, IMigrationGenerator, IMigrator, MikroORM, Transaction } from '@mikro-orm/core';
import { t, Type, UnknownType, Utils } from '@mikro-orm/core';
import type { EntityManager } from '@mikro-orm/knex';
import { DatabaseSchema, DatabaseTable, SchemaGenerator } from '@mikro-orm/knex';
import { DatabaseSchema, DatabaseTable, SqlSchemaGenerator } from '@mikro-orm/knex';
import type { Migration } from './Migration';
import { MigrationRunner } from './MigrationRunner';
import { MigrationStorage } from './MigrationStorage';
Expand All @@ -20,7 +20,7 @@ export class Migrator implements IMigrator {
private storage!: MigrationStorage;
private generator!: IMigrationGenerator;
private readonly driver = this.em.getDriver();
private readonly schemaGenerator = new SchemaGenerator(this.em);
private readonly schemaGenerator = new SqlSchemaGenerator(this.em);
private readonly config = this.em.config;
private readonly options = this.config.get('migrations');
private readonly absolutePath: string;
Expand Down

0 comments on commit eec881d

Please sign in to comment.