SqlSchemaGenerator

Hierarchy

• AbstractSchemaGenerator<AbstractSqlDriver>
  • SqlSchemaGenerator

Implements

• ISchemaGenerator

Index

Constructors

• constructor

Methods

• clearDatabase
• createDatabase
• createNamespace
• createSchema
• diffToSQL
• dropDatabase
• dropNamespace
• dropSchema
• ensureDatabase
• ensureIndexes
• execute
• getCreateSchemaSQL
• getDropSchemaSQL
• getTargetSchema
• getUpdateSchemaMigrationSQL
• getUpdateSchemaSQL
• refreshDatabase
• updateSchema
• register

Constructors

constructor

• new SqlSchemaGenerator(em: EntityManager<IDatabaseDriver<Connection>> | AbstractSqlDriver<AbstractSqlConnection, AbstractSqlPlatform>): SqlSchemaGenerator

• Inherited from AbstractSchemaGenerator.constructor

  Parameters

  • em: EntityManager<IDatabaseDriver<Connection>> | AbstractSqlDriver<AbstractSqlConnection, AbstractSqlPlatform>

  Returns SqlSchemaGenerator

Methods

clearDatabase

• clearDatabase(options?: ClearDatabaseOptions): Promise<void>

• Implementation of ISchemaGenerator.clearDatabase

  Overrides AbstractSchemaGenerator.clearDatabase

  Parameters

  • optionaloptions: ClearDatabaseOptions

  Returns Promise<void>

createDatabase

• createDatabase(name?: string): Promise<void>

• Implementation of ISchemaGenerator.createDatabase

  Overrides AbstractSchemaGenerator.createDatabase

  creates new database and connects to it

  ---

  Parameters

  • optionalname: string

  Returns Promise<void>

createNamespace

• createNamespace(name: string): Promise<void>

• Parameters

  • name: string

  Returns Promise<void>

createSchema

• createSchema(options?: CreateSchemaOptions): Promise<void>

• Implementation of ISchemaGenerator.createSchema

  Overrides AbstractSchemaGenerator.createSchema

  Parameters

  • optionaloptions: CreateSchemaOptions

  Returns Promise<void>

diffToSQL

• diffToSQL(schemaDiff: SchemaDifference, options: { dropTables?: boolean; safe?: boolean; schema?: string; wrap?: boolean }): Promise<string>

• Parameters

  • schemaDiff: SchemaDifference

  • options: { dropTables?: boolean; safe?: boolean; schema?: string; wrap?: boolean }

  • optionaldropTables: boolean

  • optionalsafe: boolean

  • optionalschema: string

  • optionalwrap: boolean

  Returns Promise<string>

dropDatabase

• dropDatabase(name?: string): Promise<void>

• Implementation of ISchemaGenerator.dropDatabase

  Overrides AbstractSchemaGenerator.dropDatabase

  Parameters

  • optionalname: string

  Returns Promise<void>

dropNamespace

• dropNamespace(name: string): Promise<void>

• Parameters

  • name: string

  Returns Promise<void>

dropSchema

• dropSchema(options?: DropSchemaOptions): Promise<void>

• Implementation of ISchemaGenerator.dropSchema

  Overrides AbstractSchemaGenerator.dropSchema

  Parameters

  • options: DropSchemaOptions = {}

  Returns Promise<void>

ensureDatabase

• ensureDatabase(options?: EnsureDatabaseOptions): Promise<boolean>

• Implementation of ISchemaGenerator.ensureDatabase

  Overrides AbstractSchemaGenerator.ensureDatabase

  Returns true if the database was created.

  ---

  Parameters

  • optionaloptions: EnsureDatabaseOptions

  Returns Promise<boolean>

ensureIndexes

• ensureIndexes(): Promise<void>

• Implementation of ISchemaGenerator.ensureIndexes

  Inherited from AbstractSchemaGenerator.ensureIndexes

  Returns Promise<void>

execute

• execute(sql: string, options?: { ctx?: any; wrap?: boolean }): Promise<void>

• Implementation of ISchemaGenerator.execute

  Overrides AbstractSchemaGenerator.execute

  Parameters

  • sql: string

  • options: { ctx?: any; wrap?: boolean } = {}

  • optionalctx: any

  • optionalwrap: boolean

  Returns Promise<void>

getCreateSchemaSQL

• getCreateSchemaSQL(options?: CreateSchemaOptions): Promise<string>

• Implementation of ISchemaGenerator.getCreateSchemaSQL

  Overrides AbstractSchemaGenerator.getCreateSchemaSQL

  Parameters

  • options: CreateSchemaOptions = {}

  Returns Promise<string>

getDropSchemaSQL

• getDropSchemaSQL(options?: Omit<DropSchemaOptions, dropDb>): Promise<string>

• Implementation of ISchemaGenerator.getDropSchemaSQL

  Overrides AbstractSchemaGenerator.getDropSchemaSQL

  Parameters

  • options: Omit<DropSchemaOptions, dropDb> = {}

  Returns Promise<string>

getTargetSchema

• getTargetSchema(schema?: string): DatabaseSchema

• Parameters

  • optionalschema: string

  Returns DatabaseSchema

getUpdateSchemaMigrationSQL

• getUpdateSchemaMigrationSQL(options?: UpdateSchemaOptions<DatabaseSchema>): 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?: UpdateSchemaOptions<DatabaseSchema>): Promise<string>

• Implementation of ISchemaGenerator.getUpdateSchemaSQL

  Overrides AbstractSchemaGenerator.getUpdateSchemaSQL

  Parameters

  • options: UpdateSchemaOptions<DatabaseSchema> = {}

  Returns Promise<string>

refreshDatabase

• refreshDatabase(options?: RefreshDatabaseOptions): Promise<void>

• Implementation of ISchemaGenerator.refreshDatabase

  Inherited from AbstractSchemaGenerator.refreshDatabase

  Parameters

  • optionaloptions: RefreshDatabaseOptions

  Returns Promise<void>

updateSchema

• updateSchema(options?: UpdateSchemaOptions<DatabaseSchema>): Promise<void>

• Implementation of ISchemaGenerator.updateSchema

  Overrides AbstractSchemaGenerator.updateSchema

  Parameters

  • options: UpdateSchemaOptions<DatabaseSchema> = {}

  Returns Promise<void>

staticregister

• register(orm: MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>): void

• Parameters

  • orm: MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

  Returns void