abstractAbstractSchemaGenerator <D>

Hierarchy

• AbstractSchemaGenerator
  • SqlSchemaGenerator
  • MongoSchemaGenerator

Implements

• ISchemaGenerator

Index

Constructors

• constructor

Methods

• clearDatabase
• createDatabase
• createSchema
• dropDatabase
• dropSchema
• ensureDatabase
• ensureIndexes
• execute
• getCreateSchemaSQL
• getDropSchemaSQL
• getUpdateSchemaMigrationSQL
• getUpdateSchemaSQL
• refreshDatabase
• updateSchema

Constructors

constructor

• new AbstractSchemaGenerator<D>(em: D | ReturnType<D[createEntityManager]>): AbstractSchemaGenerator<D>

• Type parameters

  • D: IDatabaseDriver<Connection>

  Parameters

  • em: D | ReturnType<D[createEntityManager]>

  Returns AbstractSchemaGenerator<D>

Methods

clearDatabase

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

• Implementation of ISchemaGenerator.clearDatabase

  Parameters

  • optionaloptions: ClearDatabaseOptions

  Returns Promise<void>

createDatabase

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

• Implementation of ISchemaGenerator.createDatabase

  creates new database and connects to it

  ---

  Parameters

  • optionalname: string

  Returns Promise<void>

createSchema

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

• Implementation of ISchemaGenerator.createSchema

  Parameters

  • optionaloptions: CreateSchemaOptions

  Returns Promise<void>

dropDatabase

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

• Implementation of ISchemaGenerator.dropDatabase

  Parameters

  • optionalname: string

  Returns Promise<void>

dropSchema

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

• Implementation of ISchemaGenerator.dropSchema

  Parameters

  • optionaloptions: DropSchemaOptions

  Returns Promise<void>

ensureDatabase

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

• Implementation of ISchemaGenerator.ensureDatabase

  Returns true if the database was created.

  ---

  Parameters

  • optionaloptions: EnsureDatabaseOptions

  Returns Promise<boolean>

ensureIndexes

• ensureIndexes(): Promise<void>

• Implementation of ISchemaGenerator.ensureIndexes

  Returns Promise<void>

execute

• execute(query: string): Promise<void>

• Implementation of ISchemaGenerator.execute

  Parameters

  • query: string

  Returns Promise<void>

getCreateSchemaSQL

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

• Implementation of ISchemaGenerator.getCreateSchemaSQL

  Parameters

  • optionaloptions: CreateSchemaOptions

  Returns Promise<string>

getDropSchemaSQL

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

• Implementation of ISchemaGenerator.getDropSchemaSQL

  Parameters

  • optionaloptions: Omit<DropSchemaOptions, dropDb>

  Returns Promise<string>

getUpdateSchemaMigrationSQL

• getUpdateSchemaMigrationSQL(options?: UpdateSchemaOptions<unknown>): Promise<{ down: string; up: string }>

• Implementation of ISchemaGenerator.getUpdateSchemaMigrationSQL

  Parameters

  • optionaloptions: UpdateSchemaOptions<unknown>

  Returns Promise<{ down: string; up: string }>

getUpdateSchemaSQL

• getUpdateSchemaSQL(options?: UpdateSchemaOptions<unknown>): Promise<string>

• Implementation of ISchemaGenerator.getUpdateSchemaSQL

  Parameters

  • optionaloptions: UpdateSchemaOptions<unknown>

  Returns Promise<string>

refreshDatabase

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

• Implementation of ISchemaGenerator.refreshDatabase

  Parameters

  • optionaloptions: RefreshDatabaseOptions

  Returns Promise<void>

updateSchema

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

• Implementation of ISchemaGenerator.updateSchema

  Parameters

  • optionaloptions: UpdateSchemaOptions<unknown>

  Returns Promise<void>