Skip to main content
Version: Next

OracleSchemaGenerator

Schema generator with Oracle-specific behavior for multi-schema support and privilege management.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

clear

  • clear(options): Promise<void>

  • Parameters

    Returns Promise<void>

inheritedcreate

  • create(options): Promise<void>

  • Parameters

    Returns Promise<void>

createDatabase

  • createDatabase(name, options): Promise<void>

  • creates new database and connects to it

    Parameters

    • optionalname: string
    • optionaloptions: { skipOnConnect?: boolean }
      • optionalskipOnConnect: boolean

    Returns Promise<void>

createNamespace

  • createNamespace(name): Promise<void>

  • Parameters

    • name: string

    Returns Promise<void>

inheriteddiffToSQL

  • diffToSQL(schemaDiff, options): string

  • Parameters

    • schemaDiff: SchemaDifference
    • options: { dropTables?: boolean; safe?: boolean; schema?: string; wrap?: boolean }
      • optionaldropTables: boolean
      • optionalsafe: boolean
      • optionalschema: string
      • optionalwrap: boolean

    Returns string

inheriteddrop

  • drop(options): Promise<void>

  • Parameters

    Returns Promise<void>

dropDatabase

  • dropDatabase(name): Promise<void>

  • Drops the user representing the database. When dropping the user we are connected as, we stay connected as the management user, as the dropped one can no longer authenticate.

    Parameters

    • optionalname: string

    Returns Promise<void>

dropNamespace

  • dropNamespace(name): Promise<void>

  • Parameters

    • name: string

    Returns Promise<void>

inheriteddropTableIfExists

  • dropTableIfExists(name, schema): Promise<void>

  • Parameters

    • name: string
    • optionalschema: string

    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>

inheritedexecute

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

  • Parameters

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

    Returns Promise<void>

inheritedgetCreateSchemaSQL

  • getCreateSchemaSQL(options): Promise<string>

  • Parameters

    Returns Promise<string>

getDropSchemaSQL

  • getDropSchemaSQL(options): Promise<string>

  • Oracle uses CASCADE CONSTRAINT in DROP TABLE and has no native enums, so we can generate drop SQL from metadata alone — no DB introspection needed.

    Parameters

    Returns Promise<string>

inheritedgetTargetSchema

  • getTargetSchema(schema, includeWildcardSchema): DatabaseSchema

  • Parameters

    • optionalschema: string
    • includeWildcardSchema: boolean = false

    Returns DatabaseSchema

inheritedgetUpdateSchemaMigrationSQL

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

  • Parameters

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

inheritedgetUpdateSchemaSQL

  • getUpdateSchemaSQL(options): Promise<string>

  • Parameters

    Returns Promise<string>

inheritedrefresh

  • refresh(options): Promise<void>

  • Parameters

    Returns Promise<void>

update

  • update(options): Promise<void>

  • Parameters

    Returns Promise<void>

staticregister

  • register(orm): void
Page Options