Screens: ERD

ERD and SQL list

The ERD and SQL list gathers the project's ERDs and SQL documents. It sits on the left of the project screen, below the object explorer, and is where you create, find and delete ERDs. Clicking an ERD in the list opens an ERD tab (Document tabERD) in the middle, and that tab shows the ERD canvas. Which connection, database and schema an ERD belongs to is explained in Connections and execution targets.

Where you can use itWebDesktopWithout signing inSigned inLocal projectsAccount projects

What's on the screen

No.NameDescription
1ERD buttonOpens the Create ERD dialog to make an ERD.
2SQL buttonCreates an SQL document. You can't click it until the project has a connection with connection details.
3Search ERD / SQL... fieldFilters ERDs and SQL documents together by title. See 'Find an ERD' below.
4ConnectionThe connection a document belongs to. For a DBMS with a database layer, there is one more level for the database below it. Documents with no connection, or whose connection was deleted, are gathered under No connection.
5SchemaDocuments tied to a specific schema. An ERD created with All (allow all schemas) sits directly under the connection (or database), not under a schema.
6ERDOne ERD. Click it to open its tab; the document of the open tab is highlighted. The number next to it (7) is how many tables the ERD contains.
8Type iconA single person means a Personal ERD, several people mean a Team ERD. A globe next to it means the ERD is Published. All ERDs in a local project show as personal.
9SQL documentOne SQL document. The SQL editor is explained on its own page.
  • Within a schema, ERDs come before SQL documents, and the most recently modified ERD comes first.
  • Each document row has a delete button at its right end. SQL documents also have a settings button to change their connection and schema.
  • Drag the border between the list and the explorer up or down to change the list's height.

Create an ERD

  1. Click the ERD button above the list. The Create ERD dialog opens.
  2. Type a name in the ERD Title field (1). It starts as new erd.
  3. In the Connection field (2), choose the connection to draw the ERD on. If there is only one connection, it is already selected.
  4. For a DBMS with a database layer, such as PostgreSQL or SQL Server, choose one database in the Database field.
  5. Choose a schema in the Schema field (3). It starts at All (allow all schemas), which lets one ERD hold tables from several schemas of that connection (or database).
  6. Click the OK button (4). The ERD is created and its tab opens.

A new ERD in an account project is a personal ERD. To edit it together with your team, turn it into a team ERD in the Info panel.

The same dialog opens from other places as well.

  • Hover over a connection, database or schema row and a + button appears at its right end. Click the New ERD / SQL here button and choose New ERD to open the dialog with that row's connection, database and schema already selected.
  • Right-click a connection, database, schema or table in the object explorer and choose Explorer context menuNew ERD... to open the dialog with that location selected. If ERDs that cover that location already exist, the menu becomes a submenu that lists up to five of them, most recently modified first, below the item for a new ERD. Choosing an existing ERD opens it instead of creating one.
  • With no tabs open, click the Create New ERD button in the middle, or choose Add ERD... from the
    • button at the end of the tab bar.

Start with an ERD before a connection

Choose + New database… at the bottom of the Connection field and a DBMS field replaces the connection. If the project has no connections at all, the dialog shows only the DBMS field from the start. When you choose a DBMS and confirm, NeoSQL creates a new connection for that DBMS without connection details and opens an ERD on it. A Connection Setup confirmation then asks whether to enter connection details now or later. You can design without connection details (Connections and execution targets).

Find an ERD

Type in the Search ERD / SQL... field and only ERDs and SQL documents whose title contains the text remain. Case is ignored. The remaining documents stay grouped under their connection, database and schema.

  • This search looks at document titles only. Find tables inside an ERD in the Included Tables list of the Info panel, and tables not yet in the ERD in the Object explorer.

Rename

  1. In the tab bar in the middle, right-click the ERD tab's name.
  2. Choose Rename..., type the new name and click the OK button.

The name is saved right away and updates in the list and the tab. Changing the ERD Name field in the Info panel does the same.

Delete several documents at once

  1. In the list, hold Ctrl (Cmd on macOS) and click documents to add or remove them one by one. Hold Shift and click to select every document from the one you clicked before to this one. These clicks don't open tabs.
  2. Right-click one of the selected documents and choose Delete Selected Items. With only one selected, the item is Delete.
  3. In the confirmation that shows how many ERDs and SQL documents will be deleted, click the Delete button.
  • If the selection includes ERDs published to the gallery, NeoSQL asks once more for each of them, because the published copy is deleted too. Check Apply the same choice to remaining ERDs to give the same answer for the remaining ERDs.
  • To delete a single document, you can also use the delete button at the end of its row, or Delete when you right-click the tab's name.

Double-click a tab name

Double-click an ERD tab's name and the left and right panels fold away so the tab uses more of the screen. Double-click again to bring the panels back.

Things to keep in mind

  • Deleting an ERD deletes only the ERD document. The tables in the real database stay as they are.
  • A team ERD in an account project can be deleted only with the All Permissions or ERD Delete Permission permission. Without it, the delete button is hidden and the ERD can't be selected for bulk delete. A personal ERD is deleted by the person who made it (Collaboration and permissions).
  • In an account project, documents on a connection disabled after a plan downgrade show the Disabled label and don't open. You can't rename them or create a new ERD on that connection either (Plans and features).