Skip to main content
Version: Next

ISchemaGenerator

Implemented by

Index

Methods

clear

  • clear(options): Promise<void>

create

  • create(options): Promise<void>

createDatabase

  • createDatabase(name): Promise<void>
  • Parameters

    • optionalname: string

    Returns Promise<void>

drop

  • drop(options): Promise<void>

dropDatabase

  • dropDatabase(name): Promise<void>
  • Parameters

    • optionalname: string

    Returns Promise<void>

ensureDatabase

  • ensureDatabase(options): Promise<boolean>

ensureIndexes

  • ensureIndexes(): Promise<void>
  • Returns Promise<void>

execute

  • execute(sql, options): Promise<void>
  • Parameters

    • sql: string
    • optionaloptions: { wrap?: boolean }
      • optionalwrap: boolean

    Returns Promise<void>

getCreateSchemaSQL

  • getCreateSchemaSQL(options): Promise<string>

getDropSchemaSQL

  • getDropSchemaSQL(options): Promise<string>

getUpdateSchemaMigrationSQL

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

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

getUpdateSchemaSQL

  • getUpdateSchemaSQL(options): Promise<string>

refresh

  • refresh(options): Promise<void>

update

  • update(options): Promise<void>