Skip to main content

Version: Next

SqlSchemaGenerator

Hierarchy

AbstractSchemaGenerator<AbstractSqlDriver>
- SqlSchemaGenerator

Implements

ISchemaGenerator

Constructors

constructor

new SqlSchemaGenerator(em): SqlSchemaGenerator

Inherited from AbstractSchemaGenerator.constructor
Parameters
- em: AbstractSqlDriver<AbstractSqlConnection, AbstractSqlPlatform> | SqlEntityManager<AbstractSqlDriver<AbstractSqlConnection, AbstractSqlPlatform>>
Returns SqlSchemaGenerator

Methods

clear

clear(options): Promise<void>

Implementation of ISchemaGenerator.clear
Overrides AbstractSchemaGenerator.clear
Parameters
- optionaloptions: ClearDatabaseOptions
Returns Promise<void>

create

create(options): Promise<void>

Implementation of ISchemaGenerator.create
Overrides AbstractSchemaGenerator.create
Parameters
- optionaloptions: CreateSchemaOptions
Returns Promise<void>

createDatabase

createDatabase(name, options): Promise<void>

Implementation of ISchemaGenerator.createDatabase
Overrides AbstractSchemaGenerator.createDatabase
creates new database and connects to it
Parameters
- optionalname: string
- optionaloptions: { skipOnConnect?: boolean }
Returns Promise<void>

createNamespace

createNamespace(name): Promise<void>

Parameters
- name: string
Returns Promise<void>

diffToSQL

diffToSQL(schemaDiff, options): string

Parameters
- schemaDiff: SchemaDifference
- options: { dropTables?: boolean; safe?: boolean; schema?: string; wrap?: boolean }
Returns string

drop

drop(options): Promise<void>

Implementation of ISchemaGenerator.drop
Overrides AbstractSchemaGenerator.drop
Parameters
- options: DropSchemaOptions = {}
Returns Promise<void>

dropDatabase

dropDatabase(name): Promise<void>

Implementation of ISchemaGenerator.dropDatabase
Overrides AbstractSchemaGenerator.dropDatabase
Parameters
- optionalname: string
Returns Promise<void>

dropNamespace

dropNamespace(name): Promise<void>

Parameters
- name: string
Returns Promise<void>

dropTableIfExists

dropTableIfExists(name, schema): Promise<void>

Parameters
- name: string
- optionalschema: string
Returns Promise<void>

ensureDatabase

ensureDatabase(options): Promise<boolean>

Implementation of ISchemaGenerator.ensureDatabase
Overrides AbstractSchemaGenerator.ensureDatabase
Returns true if the database was created.
Parameters
- optionaloptions: EnsureDatabaseOptions
Returns Promise<boolean>

inheritedensureIndexes

ensureIndexes(): Promise<void>

Implementation of ISchemaGenerator.ensureIndexes
Inherited from AbstractSchemaGenerator.ensureIndexes
Returns Promise<void>

execute

execute(sql, options): Promise<void>

Implementation of ISchemaGenerator.execute
Overrides AbstractSchemaGenerator.execute
Parameters
- sql: string
- options: { ctx?: any; wrap?: boolean } = {}
Returns Promise<void>

getCreateSchemaSQL

getCreateSchemaSQL(options): Promise<string>

Implementation of ISchemaGenerator.getCreateSchemaSQL
Overrides AbstractSchemaGenerator.getCreateSchemaSQL
Parameters
- options: CreateSchemaOptions = {}
Returns Promise<string>

getDropSchemaSQL

getDropSchemaSQL(options): Promise<string>

Implementation of ISchemaGenerator.getDropSchemaSQL
Overrides AbstractSchemaGenerator.getDropSchemaSQL
Parameters
- options: Omit<DropSchemaOptions, dropDb> = {}
Returns Promise<string>

getTargetSchema

getTargetSchema(schema): DatabaseSchema

Parameters
- optionalschema: string
Returns DatabaseSchema

getUpdateSchemaMigrationSQL

getUpdateSchemaMigrationSQL(options): Promise<{ down: string; up: string }>

Implementation of ISchemaGenerator.getUpdateSchemaMigrationSQL
Overrides AbstractSchemaGenerator.getUpdateSchemaMigrationSQL
Parameters
- options: UpdateSchemaOptions<DatabaseSchema> = {}
Returns Promise<{ down: string; up: string }>

getUpdateSchemaSQL

getUpdateSchemaSQL(options): Promise<string>

Implementation of ISchemaGenerator.getUpdateSchemaSQL
Overrides AbstractSchemaGenerator.getUpdateSchemaSQL
Parameters
- options: UpdateSchemaOptions<DatabaseSchema> = {}
Returns Promise<string>

inheritedrefresh

refresh(options): Promise<void>

Implementation of ISchemaGenerator.refresh
Inherited from AbstractSchemaGenerator.refresh
Parameters
- optionaloptions: RefreshDatabaseOptions
Returns Promise<void>

update

update(options): Promise<void>

Implementation of ISchemaGenerator.update
Overrides AbstractSchemaGenerator.update
Parameters
- options: UpdateSchemaOptions<DatabaseSchema> = {}
Returns Promise<void>

staticregister

register(orm): void

Parameters
- orm: MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>, (string | EntityClass<Partial<any>> | EntitySchema<any, never, EntityCtor<any>>)[]>
Returns void