Skip to main content

Function: diffModels()

function diffModels(
before,
after,
options?
): ModelDiff;

Compares two models entry by entry (tables, columns, indexes, checks, refs, enums, groups, notes, views, project settings), pairing renamed tables when their columns are identical.

Parameters​

before​

DiagramModel

The older model.

after​

DiagramModel

The newer model; ids in the result refer to it, except for removed entries.

options?​

DiffOptions = {}

Returns​

ModelDiff

Example​

import { compileDbml, diffModels } from '@relvista/core';

const before = compileDbml('Table users { id int [pk] }').model!;
const after = compileDbml('Table users { id int [pk]\n email varchar }').model!;
const diff = diffModels(before, after);
diff.tables[0]; // { id: 'public.users', status: 'changed', columns: [{ name: 'email', status: 'added', ... }], ... }
diff.summary; // { added: 0, removed: 0, changed: 1 }