prorm API Reference
    Preparing search index...

    Enumeration DiagramType

    Every diagram this package can render.

    The values are stable lowercase slugs, safe to accept from a CLI flag, a query string or a JSON config, and safe to persist.

    Index
    Model: "model"

    One model as a single panel: columns, keys, associations.

    ER: "er"

    Every model on one sheet, with the relationships drawn between them.

    Chen: "chen"

    Chen notation — entities, diamond relationships, oval attributes.

    Relational: "relational"

    Crow's-foot relational schema.

    Class: "class"

    UML class diagram: attributes, methods, visibility.

    Migration: "migration"

    What one migration changes: tables and columns added, altered, dropped.

    SchemaDoc: "schemadoc"

    Reference-style schema documentation, table by table.

    Index: "index"

    Indexes per table, and the columns they cover.

    Dependency: "dependency"

    Which models depend on which.

    Sequence: "sequence"

    Messages exchanged between participants, in order.

    State: "state"

    States and the transitions between them.

    Flow: "flow"

    Nodes and edges — a general flowchart.

    Tree: "tree"

    A hierarchy.

    Package: "package"

    Modules grouped into packages.

    Gantt: "gantt"

    A schedule, as bars on a timeline.