Skip to main content

Version: Next

OracleSchemaGenerator

Hierarchy

SqlSchemaGenerator
- OracleSchemaGenerator

Constructors

constructor

new OracleSchemaGenerator(em): OracleSchemaGenerator

Inherited from SqlSchemaGenerator.constructor
Parameters
- em: AbstractSqlDriver<AbstractSqlConnection, AbstractSqlPlatform> | SqlEntityManager<AbstractSqlDriver<AbstractSqlConnection, AbstractSqlPlatform>>
Returns OracleSchemaGenerator

Methods

clear

clear(options): Promise<void>

Overrides SqlSchemaGenerator.clear
Parameters
- optionaloptions: ClearDatabaseOptions
Returns Promise<void>

inheritedcreate

create(options): Promise<void>

Inherited from SqlSchemaGenerator.create
Parameters
- optionaloptions: CreateSchemaOptions
Returns Promise<void>

createDatabase

createDatabase(name): Promise<void>

Overrides SqlSchemaGenerator.createDatabase
creates new database and connects to it
Parameters
- optionalname: string
Returns Promise<void>

createNamespace

createNamespace(name): Promise<void>

Overrides SqlSchemaGenerator.createNamespace
Parameters
- name: string
Returns Promise<void>

inheriteddiffToSQL

diffToSQL(schemaDiff, options): string

Inherited from SqlSchemaGenerator.diffToSQL
Parameters
- schemaDiff: SchemaDifference
- options: { dropTables?: boolean; safe?: boolean; schema?: string; wrap?: boolean }
Returns string

inheriteddrop

drop(options): Promise<void>

Inherited from SqlSchemaGenerator.drop
Parameters
- options: DropSchemaOptions = {}
Returns Promise<void>

dropDatabase

dropDatabase(name): Promise<void>

Overrides SqlSchemaGenerator.dropDatabase
Parameters
- optionalname: string
Returns Promise<void>

dropNamespace

dropNamespace(name): Promise<void>

Overrides SqlSchemaGenerator.dropNamespace
Parameters
- name: string
Returns Promise<void>

inheriteddropTableIfExists

dropTableIfExists(name, schema): Promise<void>

Inherited from SqlSchemaGenerator.dropTableIfExists
Parameters
- name: string
- optionalschema: string
Returns Promise<void>

ensureDatabase

ensureDatabase(options): Promise<boolean>

Overrides SqlSchemaGenerator.ensureDatabase
Returns true if the database was created.
Parameters
- optionaloptions: EnsureDatabaseOptions
Returns Promise<boolean>

inheritedensureIndexes

ensureIndexes(): Promise<void>

Inherited from SqlSchemaGenerator.ensureIndexes
Returns Promise<void>

inheritedexecute

execute(sql, options): Promise<void>

Inherited from SqlSchemaGenerator.execute
Parameters
- sql: string
- options: { ctx?: any; wrap?: boolean } = {}
Returns Promise<void>

inheritedgetCreateSchemaSQL

getCreateSchemaSQL(options): Promise<string>

Inherited from SqlSchemaGenerator.getCreateSchemaSQL
Parameters
- options: CreateSchemaOptions = {}
Returns Promise<string>

getDropSchemaSQL

getDropSchemaSQL(options): Promise<string>

Overrides SqlSchemaGenerator.getDropSchemaSQL
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
- options: Omit<DropSchemaOptions, dropDb> = {}
Returns Promise<string>

inheritedgetTargetSchema

getTargetSchema(schema): DatabaseSchema

Inherited from SqlSchemaGenerator.getTargetSchema
Parameters
- optionalschema: string
Returns DatabaseSchema

inheritedgetUpdateSchemaMigrationSQL

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

Inherited from SqlSchemaGenerator.getUpdateSchemaMigrationSQL
Parameters
- options: UpdateSchemaOptions<DatabaseSchema> = {}
Returns Promise<{ down: string; up: string }>

inheritedgetUpdateSchemaSQL

getUpdateSchemaSQL(options): Promise<string>

Inherited from SqlSchemaGenerator.getUpdateSchemaSQL
Parameters
- options: UpdateSchemaOptions<DatabaseSchema> = {}
Returns Promise<string>

inheritedrefresh

refresh(options): Promise<void>

Inherited from SqlSchemaGenerator.refresh
Parameters
- optionaloptions: RefreshDatabaseOptions
Returns Promise<void>

update

update(options): Promise<void>

Overrides SqlSchemaGenerator.update
Parameters
- options: UpdateSchemaOptions<DatabaseSchema> = {}
Returns Promise<void>

staticregister

register(orm): void

Overrides SqlSchemaGenerator.register
Parameters
- orm: MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>, (string | EntityClass<Partial<any>> | EntitySchema<any, never, EntityCtor<any>>)[]>
Returns void