Skip to main content

Data Model

The Data Model is an interactive diagram that visualizes your entire API database structure.

What It Shows​

ElementDescription
CollectionsYour data tables (typically blue)
ViewsFiltered subsets (typically green)
QueriesMulti-collection joins (typically purple)
RelationshipsLines connecting related collections
  • Zoom — Mouse wheel or zoom buttons
  • Pan — Click and drag the canvas
  • Drag nodes — Reposition collections
  • Click nodes — View details

Viewing Options​

Toggle visibility of different elements:

  • Show/hide views
  • Show/hide queries
  • Show/hide system fields (id, created, modified)
  • Hide individual items via right-click

Relationships​

Lines connect lookup properties to their target collections:

  • Hover over lines to see property names
  • Required relationships are styled differently
  • Unique constraints are indicated visually

Auto Layout​

Click Auto Layout to automatically organize your diagram:

  • Minimizes line crossings
  • Groups related collections
  • Adjusts spacing for clarity

Uses the ELK (Eclipse Layout Kernel) algorithm.

Saving Layouts​

Save custom layouts for different purposes:

  • Create named layouts
  • Store node positions and viewport state
  • Switch between saved layouts quickly
  • Layouts persist in your API

Use Cases​

  • Schema design — Plan your database structure
  • Documentation — Generate visual documentation
  • Onboarding — Help team members understand data relationships
  • Debugging — Trace relationships and identify issues
  • Presentations — Show stakeholders how data is organized