Sequence diagram

What actually happens during a write — the call order from your code down to the driver and back.

The code

new SequenceDiagram({
  title: 'User.create()',
  participants: [
    { name: 'App',      kind: 'actor' },
    { name: 'Model',    kind: 'object' },
    { name: 'Hooks',    kind: 'object' },
    { name: 'Dialect',  kind: 'object' },
    { name: 'Postgres', kind: 'database' },
  ],
  messages: [
    { from: 'App',      to: 'Model',    label: 'create(values)', activate: true },
    { from: 'Model',    to: 'Hooks',    label: 'beforeValidate / beforeCreate' },
    { from: 'Model',    to: 'Dialect',  label: 'buildInsert(values)' },
    { from: 'Dialect',  to: 'Postgres', label: 'INSERT … RETURNING *', activate: true },
    { from: 'Postgres', to: 'Dialect',  label: 'row', return: true },
    { from: 'Model',    to: 'Hooks',    label: 'afterCreate' },
    { from: 'Model',    to: 'App',      label: 'instance', return: true },
  ],
}).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.

Hooks run on the same connection as the statement, which is why a throw inside one rolls the write back with it.

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

The code#

What it produces#

Saving it#

Related reading#

The code

What it produces

Saving it

Related reading