ISchemaGenerator

Implemented by

• AbstractSchemaGenerator
• SqlSchemaGenerator

Index

Methods

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

Methods

clearDatabase

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

• Parameters

  • optionaloptions: ClearDatabaseOptions

  Returns Promise<void>

createDatabase

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

• Parameters

  • optionalname: string

  Returns Promise<void>

createSchema

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

• Parameters

  • optionaloptions: CreateSchemaOptions

  Returns Promise<void>

dropDatabase

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

• Parameters

  • optionalname: string

  Returns Promise<void>

dropSchema

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

• Parameters

  • optionaloptions: DropSchemaOptions

  Returns Promise<void>

ensureDatabase

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

• Parameters

  • optionaloptions: EnsureDatabaseOptions

  Returns Promise<boolean>

ensureIndexes

• ensureIndexes(): Promise<void>

• Returns Promise<void>

execute

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

• Parameters

  • sql: string

  • optionaloptions: { wrap?: boolean }

  • optionalwrap: boolean

  Returns Promise<void>

getCreateSchemaSQL

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

• Parameters

  • optionaloptions: CreateSchemaOptions

  Returns Promise<string>

getDropSchemaSQL

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

• Parameters

  • optionaloptions: Omit<DropSchemaOptions, dropDb>

  Returns Promise<string>

getUpdateSchemaMigrationSQL

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

• Parameters

  • optionaloptions: UpdateSchemaOptions<unknown>

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

getUpdateSchemaSQL

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

• Parameters

  • optionaloptions: UpdateSchemaOptions<unknown>

  Returns Promise<string>

refreshDatabase

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

• Parameters

  • optionaloptions: RefreshDatabaseOptions

  Returns Promise<void>

updateSchema

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

• Parameters

  • optionaloptions: UpdateSchemaOptions<unknown>

  Returns Promise<void>