Skip to main content
The ERD (Entity-Relationship Diagram) is a visual map of your project’s database. It’s generated from your schema, so it stays current without a separate diagramming tool.

Open the ERD

Go to Backend → Data. You can open the diagram two ways:
  • In the page header, click Diagram under DB-LEVEL TOOLS, next to SQL Playground.
  • On the Your Data home, click View Diagram. This page appears when you open Data without selecting a table, and it shows how many tables, views, and data types the project has.
The Data page with the Your Data home, the View Diagram button, and the Diagram button in the page header. The diagram opens in a full-view dialog titled Entity-Relationship Diagram (ERD). Click the close icon in the top-right corner to return to the Data page. The ERD shows the environment selected in the Backend Console. Switch environments to compare a branch’s schema against master before you merge.

The canvas

The ERD arranges tables in colored bands, one band per domain, which groups related tables together. The diagram opens in a vertical layout and fits the whole schema on screen. The header shows the number of tables and relationships and the detail level, such as “21 of 21 tables · 28 relationships · keys + types”. The ERD canvas showing tables as cards inside four colored domain bands, connected by relationship lines, with the Domains panel on the left and a minimap in the corner. Each table is a card:
  • The header shows the table name and a summary such as “12 columns · 3 FK”.
  • Primary keys carry a PK badge. Foreign keys carry an FK badge and a link such as → users to the table they reference.
  • When a table has more columns than the card shows, a +N columns button expands the card to list them all. Audit columns sit in a collapsible Audit section.
  • Hover over a card and select the arrow icon to open the table’s data in a new tab.
Lines connect related tables. A badge on each line shows the cardinality: 1:1, 1:N, or N:M. Hover over a badge to read it in words, such as “one-to-many”. To move around, scroll to zoom and drag to pan. The controls in the bottom-left corner zoom in and out and fit the view. A minimap lets you jump around a large diagram. The status bar at the bottom shows how many tables are visible, the selected table, and the zoom level.

Toolbar

The toolbar sits in the top-right corner of the dialog: The ERD toolbar with the Detail selector set to Keys, the All tables button, and the Search, Layout, Fit, Export, and Close icon buttons. Click the search icon and type a table or column name. Results list matching tables, and matching columns appear as table.column. Use the arrow keys to move through results and press Enter, or click a result, to focus that table. If nothing matches, the list shows No matching tables. The ERD search box with the term ticket typed, listing the matching ticket tables and ticket_attachment.ticket_id and ticket_comment.ticket_id column results.

Filter tables

Open All tables to choose which tables appear:
  • Uncheck a table to remove it from the diagram. The button then reads Filtered tables.
  • Select Clear all or Select all to hide or show every table at once. At least one table always stays visible.
  • Hover over a table and select the focus icon to show only that table and the tables it relates to.
  • Select Rebalance diagram to re-lay out the remaining tables.
The All tables list open, headed "Tables in diagram", showing a checkbox for each table, a Clear all link, and a Rebalance diagram button. Relationships to hidden tables aren’t drawn.

Export the diagram

Open Export and choose a scope:
  • Current view exports what’s on screen.
  • All sources exports every table regardless of the current filter.
The Export menu open, with the Current view and All sources scopes and the Copy image and PNG options. Then choose a format:
  • Copy image sends the diagram to your clipboard. While the export menu is open, Cmd+C or Ctrl+C does the same.
  • PNG downloads a 2x, retina-resolution image.
The image follows the Detail level you selected and the tables you chose to show. Domains you hide in the Domains panel are left out.

Domains panel

The Domains panel on the left lists each domain with a colored dot, a checkbox, and its table count. The Domains panel on the left of the ERD, listing the System, Archie, Ticket, and Events & other domains with the Ticket domain expanded to show its four tables.
  • Check or uncheck a domain to show or hide its tables. Unchecked domains are left out of the diagram and the export.
  • Select All or None to show or hide every domain.
  • Click a domain name to expand it and see its tables. Click a table to focus it.
The panel footer shows how many tables are visible out of the total, and how many relationships.
Table and relationship counts leave out hidden permission tables. The All tables list still shows every table, so its count can be higher than the footer.

Inspector

Click a table on the canvas to focus it. The diagram narrows to the table and the tables related to it, and the status bar shows how many are related. The Inspector opens on the right. The ERD focused on the ticket table, with the Inspector open on the right listing its columns and the tables that reference it. The Inspector shows:
  • The table name, its domain, and a summary of columns, foreign keys, and references.
  • Columns — every column with its type. PK and FK badges mark keys.
  • A → table link under each foreign key. Click it to jump to the referenced table.
  • Referenced by — the tables that point to this one, with the column they use (for example, “via user_id”) and the cardinality. Click a row to jump to that table. If nothing points here, the section reads No tables point here.
To leave focus mode, press Esc, click an empty part of the canvas, or select Fit. The status bar reminds you: “Click a table to focus it. Esc resets.”

When the ERD doesn’t load

  • If the project has no tables yet, the ERD shows a button to generate the data model.
  • If your backend is generated but its data model can’t be loaded, the Data page shows We couldn’t load your database with a Retry button. This is a temporary problem, not a missing backend.
  • If the diagram itself fails to load, you see an error with a Try Again button.

FAQ

No. The ERD is read-only. Make schema changes on the Data page’s Schema tab.
Yes. It’s generated from the current schema, so a new table, field, or relationship appears the next time you open or refresh the ERD.
They show the cardinality of the relationship between the two connected tables: one-to-one, one-to-many, or many-to-many. The cardinality comes from how the relationship field is configured.
Yes. Hide tables with the All tables filter or uncheck domains in the Domains panel, then export with the scope set to Current view.
Yes. Drag a card to move it. Select Rebalance diagram in the All tables list to re-lay out the remaining tables.