Schema documentation

A table rendered as documentation — columns, types, keys and descriptions in one block.

The code

new SchemaDocDiagram({
  title: 'users',
  tables: [{
    name: 'users',
    comment: 'People who can sign in',
    columns: [
      { name: 'id',    type: 'INTEGER',      key: 'PK', description: 'Surrogate key' },
      { name: 'email', type: 'VARCHAR(255)', key: 'UQ', description: 'Login identity' },
      { name: 'name',  type: 'VARCHAR(100)' },
      { name: 'orgId', type: 'INTEGER',      key: 'FK', nullable: true,
        description: 'Owning organisation' },
    ],
  }],
}).generate()

What it produces

Generated by running the snippet above — this is the generator's real output,
rebuilt by scripts/build-diagram-examples.mjs, not a picture of it.

The closest thing here to a data dictionary — useful when someone outside the team has to read the schema.

Saving it

generate() returns the SVG as a string; save(path) writes it straight to
disk.

diagram.save('docs/schema.svg');

Diagram generators — every generator and its options

Models — the definitions these are drawn from

Schema documentation

The code#

What it produces#

Saving it#

Related reading#

The code

What it produces

Saving it

Related reading