Class SchemaEvolution

Computes schema diffs and generates ALTER TABLE migration SQL.

Index

Constructors

Methods

DiffSchema GenerateEvolutionMigration GenerateEvolutionSoftFKUpdates

Constructors

constructor

new SchemaEvolution(): SchemaEvolution
Returns SchemaEvolution

Methods

DiffSchema

DiffSchema(
    source: SourceObjectInfo,
    targetConfig: TargetTableConfig,
    existing: ExistingTableInfo,
    platform: DatabasePlatform,
): SchemaDiff
Diff a source object against an existing target table. Returns added, modified, and removed columns.
Parameters
- source: SourceObjectInfo
- targetConfig: TargetTableConfig
- existing: ExistingTableInfo
- platform: DatabasePlatform
Returns SchemaDiff
- Defined in SchemaEvolution.ts:29

GenerateEvolutionMigration

GenerateEvolutionMigration(
    diff: SchemaDiff,
    schemaName: string,
    tableName: string,
    platform: DatabasePlatform,
): string
Generate ALTER TABLE SQL for a schema diff.
Parameters
- diff: SchemaDiff
- schemaName: string
- tableName: string
- platform: DatabasePlatform
Returns string
- Defined in SchemaEvolution.ts:137

GenerateEvolutionSoftFKUpdates

GenerateEvolutionSoftFKUpdates(
diff: SchemaDiff,
targetConfig: TargetTableConfig,
): SoftFKEntry[]
Identify new soft FK entries from a diff (for added FK columns).
Parameters
- diff: SchemaDiff
- targetConfig: TargetTableConfig
Returns SoftFKEntry[]
- Defined in SchemaEvolution.ts:163