Screens: ERD

Gallery and embedding

Publishing to the gallery puts the current state of a personal ERD in the ERD gallery on the website, where anyone can see it. A published ERD can be embedded as a read-only viewer in a blog or documentation, and other users can bring it into their own projects as a starting point. The difference between personal and team ERDs is explained in Collaboration and permissions.

Where you can use itWebDesktopWithout signing inSigned inLocal projectsAccount projects

What's on the screen

No.NameDescription
1Public TitleThe title shown in the gallery. It starts with the value of ERD Name. You cannot publish with it empty.
2DescriptionThe introduction shown on the gallery detail page. It can be left empty.
3TagsAdd tags with the Add Tag button. People find ERDs in the gallery by tag.
4RangeThe area to capture for the cover. Current Viewport is what is on the screen now, and All (All Nodes) is the whole ERD.
5Capture ERD Snapshot buttonCaptures the chosen area as the cover. You cannot publish without a cover.
6Publish buttonPublishes to the gallery.
  1. Save the ERD. The layout, notes and groups are taken from the last saved ERD.
  2. Open the More menu in the info panel and choose Publish to Public....
  3. Fill in the Public Title (1), Description (2) and Tags (3) fields.
  4. Choose the Range (4) and click the Capture ERD Snapshot button (5) to make the cover.
  5. Click the Publish button (6). The Published to the gallery. notification appears.

A published ERD appears in the ERD gallery list and on its detail page on the website. Its DBMS is set automatically from the connection the ERD is attached to.

What becomes public

Publishing uploads a copy (snapshot) of that moment. Changing the ERD after publishing does not change the ERD in the gallery.

PublicNot public
The ERD's layout, notes, groups and name display settings (from the last saved ERD)Tables not included in the ERD
The columns, keys, indexes, comments and notes of the tables in the ERD. It is the design shown on the screen when you publish, including changes not yet applied to the databaseForeign keys that refer to tables outside the ERD (self-referencing foreign keys are kept)
Title, description, tags, cover and DBMS typeRow data in the database

Updating and unpublishing

For a published ERD, the More menu shows the two items below instead of the publish item.

MenuWhat it does
Update Gallery...Opens the Update Gallery dialog, filled with the current title, description and tags of the published copy. The Update button overwrites the published copy with the last saved ERD and the current table design.
Unpublish...After confirmation, removes the published copy from the gallery. The ERD itself stays.

Embedding in another page

A published ERD can be placed in other pages such as a blog or Notion with an iframe. The embed code is made in the gallery on the website, not in the app.

  1. Open the detail page of the published ERD in the ERD gallery on the website.
  2. Click the Share button at the top of the detail page, and open the Embed tab in the Share ERD dialog.
  3. Set Width (px), Height (px), Table panel, Open by default, Mini-map and Controls. You can drag or scroll inside the preview to frame the area shown at first.
  4. Click the Copy iframe button or the Copy URL button, and paste it into your page.

The embedded page opens the ScreenERD Embed Viewer screen. People who are not signed in can see it, and nobody can edit it.

No.NameWhat it does
1PanelIn the Tables tab, click a table to move the view to it. In the Config tab, choose which column details to show.
2TitleThe published title and the DBMS icon. The Open in gallery link next to it opens the gallery detail page on the website in a new window.
3Column display buttonOpens and closes the panel's Config tab.
4View DDL buttonOpens the Table DDL dialog with the tables' DDL. Copy it with the Copy DDL button.
5Fullscreen buttonShows the viewer in full screen.
6Zoom controlsZoom in and out, and fit the whole ERD on the screen. The Pan button is here too.
7Mini-mapShows which part of the whole ERD you are looking at.

Column display settings changed in the viewer with the Column display button apply only to that screen and are not saved to the published copy.

Anyone can bring (clone) a gallery ERD into their own project and use it as a new ERD. You must be signed in on both the website and the app.

  1. On the gallery detail page on the website, click the Clone to My Project button and confirm. An import request is registered.
  2. Click the Open in NeoSQL App button, and the desktop app opens. If the app does not open, you can use Continue in browser on the same page to continue in the web app.
  3. In the app's ERD Clone dialog, choose the project, connection and schema for the tables. You can also reopen this dialog from the Pending Imports card on the home screen.
  4. If the source and target DBMSs differ, the preview shows the MySQL → PostgreSQL auto-conversion will be applied. notice and the columns whose types were mapped automatically. Check them and click the Save as Ready button.
  5. The import is applied when you open the chosen project. The tables are created as virtual tables, and a new ERD with the source's layout, notes and groups appears.

Things to keep in mind

  • Publishing is public to everyone. Before publishing, check that table names, column names, comments and notes contain no internal or sensitive information.
  • The published copy does not update by itself. To show your changes in the gallery, save the ERD and upload it again with Update Gallery....
  • Deleting a published ERD also deletes its copy in the gallery. The confirmation dialog tells you so when you delete it.
  • Only personal ERDs in account projects can be published. Team ERDs have no publish item, so make a personal copy with Copy to My ERD and publish that. A personal ERD that is published cannot be turned into a team ERD.
  • When you are not signed in, or the ERD is in a local project, Publish to Public... shows a lock, and clicking it opens the dialog locked with the conditions for using it. An ERD in a local project is shown as personal in the info panel but cannot be published.