Skip to main content
Version: Next

SqlSchemaGenerator

Hierarchy

Implements

Index

Constructors

constructor

Methods

clearDatabase

  • clearDatabase(options): Promise<void>
  • Parameters

    Returns Promise<void>

createDatabase

  • createDatabase(name): Promise<void>
  • creates new database and connects to it


    Parameters

    • optionalname: string

    Returns Promise<void>

createNamespace

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

    • name: string

    Returns Promise<void>

createSchema

  • createSchema(options): Promise<void>
  • Parameters

    Returns Promise<void>

diffToSQL

  • diffToSQL(schemaDiff, options): 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): Promise<void>
  • Parameters

    • optionalname: string

    Returns Promise<void>

dropNamespace

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

    • name: string

    Returns Promise<void>

dropSchema

  • dropSchema(options): Promise<void>
  • Parameters

    Returns Promise<void>

ensureDatabase

  • ensureDatabase(options): Promise<boolean>
  • Returns true if the database was created.


    Parameters

    Returns Promise<boolean>

inheritedensureIndexes

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

execute

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

    • sql: string
    • options: { ctx?: any; wrap?: boolean } = {}
      • optionalctx: any
      • optionalwrap: boolean

    Returns Promise<void>

getCreateSchemaSQL

  • getCreateSchemaSQL(options): Promise<string>
  • Parameters

    Returns Promise<string>

getDropSchemaSQL

  • getDropSchemaSQL(options): Promise<string>
  • Parameters

    Returns Promise<string>

getTargetSchema

  • getTargetSchema(schema): DatabaseSchema
  • Parameters

    • optionalschema: string

    Returns DatabaseSchema

getUpdateSchemaMigrationSQL

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

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

getUpdateSchemaSQL

  • getUpdateSchemaSQL(options): Promise<string>
  • Parameters

    Returns Promise<string>

inheritedrefreshDatabase

  • refreshDatabase(options): Promise<void>
  • Parameters

    Returns Promise<void>

updateSchema

  • updateSchema(options): Promise<void>
  • Parameters

    Returns Promise<void>

staticregister

  • register(orm): void