Class SchemaDiffer

SchemaDiffer compares model definitions against database schema

Index

Constructors

Methods

diffModel diffAll getColumnChanges getIndexChanges getConstraintChanges getForeignKeyChanges

Constructors

constructor

new SchemaDiffer(dialect: Dialect, options?: SchemaDifferOptions): SchemaDiffer
Parameters
- dialect: Dialect
- options: SchemaDifferOptions = {}
Returns SchemaDiffer
- Defined in schema/schema-differ.ts:31

Methods

diffModel

diffModel(model: ModelStatic<any>): Promise<SchemaDiff>
Compare a model against its database table
Parameters
- model: ModelStatic<any>
Returns Promise<SchemaDiff>
- Defined in schema/schema-differ.ts:45

diffAll

diffAll(): Promise<SchemaDiff[]>
Diff all models registered with Prorm

Returns Promise<SchemaDiff[]>
- Defined in schema/schema-differ.ts:97

getColumnChanges

getColumnChanges(
modelColumns: ColumnDefinition[],
dbColumns: DatabaseColumnInfo[],
): ColumnChange[]
Get column changes between model and database
Parameters
- modelColumns: ColumnDefinition[]
- dbColumns: DatabaseColumnInfo[]
Returns ColumnChange[]
- Defined in schema/schema-differ.ts:121

getIndexChanges

getIndexChanges(
modelIndexes: { name: string; unique: boolean; fields: string[] }[],
dbIndexes: DatabaseIndexInfo[],
): IndexChange[]
Get index changes between model and database
Parameters
- modelIndexes: { name: string; unique: boolean; fields: string[] }[]
- dbIndexes: DatabaseIndexInfo[]
Returns IndexChange[]
- Defined in schema/schema-differ.ts:175

getConstraintChanges

getConstraintChanges(
modelConstraints: { name: string; type: string; fields: string[] }[],
dbConstraints: DatabaseConstraintInfo[],
): ConstraintChange[]
Get constraint changes between model and database
Parameters
- modelConstraints: { name: string; type: string; fields: string[] }[]
- dbConstraints: DatabaseConstraintInfo[]
Returns ConstraintChange[]
- Defined in schema/schema-differ.ts:227

getForeignKeyChanges

getForeignKeyChanges(
    modelFKs: {
        name: string;
        fields: string[];
        references: { table: string; fields: string[] };
    }[],
    dbFKs: DatabaseForeignKeyInfo[],
): ForeignKeyChange[]
Get foreign key changes between model and database
Parameters
- modelFKs: {
      name: string;
      fields: string[];
      references: { table: string; fields: string[] };
  }[]
- dbFKs: DatabaseForeignKeyInfo[]
Returns ForeignKeyChange[]
- Defined in schema/schema-differ.ts:282