Skip to main content

Quick start

This walkthrough takes you from a blank canvas to exported SQL in about five minutes. We'll build a tiny slice of the Acme Storefront sample used throughout these docs.

1. Create a diagram​

Click New in the top-left. The New diagram wizard opens with three ways to start:

The New diagram wizard

  • Empty diagram — a blank canvas (pick this one).
  • Import from query — paste the JSON result of an introspection query.
  • Connect to database — read the schema straight from a live database.

Choose Empty diagram, pick PostgreSQL as the engine, give it a name, and click Create.

2. Add a table​

Press the + Table button (or right-click empty canvas → Add table). A new card appears with an id primary key. Double-click the table's name to rename it to products, then use + Field to add columns. Click a field's type to open the type picker and click the pencil to set constraints like not null, unique or default.

A table card showing primary-key, foreign-key and not-null badges

The little badges tell you the role of each field at a glance: a gold key for the primary key, a blue link for foreign keys, and NN for non-nullable columns.

Add a second table, categories. Hover over the category_id field in products — a small port appears on the edge of the card. Drag from that port onto categories.id and release. EntityFlow draws an orthogonal foreign-key edge with cardinality badges (here, many products to one category). → Relationships

4. Group and annotate​

Select related tables and wrap them in a container group to keep big schemas readable, and drop a sticky note to leave context for your teammates.

Two container groups, six tables and a sticky note

→ Container groups · Sticky notes

5. Export SQL​

Click Export in the top bar. Choose a dialect — PostgreSQL, MySQL, MariaDB, SQL Server or SQLite — and EntityFlow shows the live DDL. Copy it, or switch to the Image tab to export a PNG/SVG.

The export dialog showing live PostgreSQL DDL

That's the whole loop: draw → validate → generate. Everything is saved locally as you work (and synced to the server when you're signed in).

:::tip Skip the typing Don't want to build it by hand? Download the Acme Storefront sample and load it with File → Import JSON. :::

Where to next​

  • Key concepts — the vocabulary behind the canvas.
  • Signing in — passwordless sign-in with your email address and a one-time code.
  • The Editor — every gesture and panel in depth.
  • Collaboration — invite your team onto the same diagram.