When you open a project (), connections and the document list sit on the left, work documents such as ERDs and SQL editors in the middle, and helper panels such as the AI Assistant panel on the right. What each part is and which page covers it in detail is explained below. Creating a project is explained in New project.
What's on the screen
| No. | Name | Description |
|---|---|---|
| 1 | Project tab | On desktop, each open project sits as a tab in the work tab bar of the header, and the buttons below are inside the tab of the visible project. Right-click a tab for the Close item and the Project Settings item. The web app has no work tab bar; the project name and the buttons sit in the header. See Work tabs. |
| 2 | Project Settings button | The gear button. Opens the Project settings window. |
| 3 | AI Settings button | Opens the window where you decide, for each connection, how far AI is allowed to go. See Project AI settings. |
| 4 | Left rail | Three buttons that choose what the left panel shows. See 'Rail buttons' below. |
| 5 | Left panel | Shows the object explorer at first. Drag the right edge of the panel to change its width. |
| 6 | ERD and SQL list | Below the explorer are the project's ERDs and SQL documents. Drag the top edge to change its height. See ERD and SQL list. |
| 7 | Work document tabs | ERDs, SQL editors, dashboards and the detail screens of tables and objects open as tabs. See 'Work document tabs' below. |
| 8 | Add tab button | Has the Add ERD... item, the Add SQL Editor... item and the Add dashboard... item. You cannot create a SQL editor until a connection has database connection details. |
| 9 | Right rail | Buttons that open and close the right panel. See 'Rail buttons' below. |
| 10 | Status bar | Shows running background tasks, the location of the selected tree item or tab, and information about the tab. See App menu, top bar and status bar. |
- In account projects whose plan allows more than one member, the Collaborate button sits before the settings button. Local projects do not have it. See Sharing and members.
- The header buttons are dimmed and cannot be clicked until the project has finished loading.
Rail buttons
The left rail buttons change what the left panel shows. Clicking the button of the panel already shown collapses the left panel.
| Button | Opens | Explained in |
|---|---|---|
| button | The object explorer and the ERD and SQL list | Object explorer |
| button | The list of changes not yet applied to the database. The number on the button is the number of changed tables | 'Schema Changes panel' below |
| button | The list of dashboards | Dashboards |
The right rail buttons open the right panel. Clicking the button of the open panel closes it.
| Button | Opens | Available in | Explained in |
|---|---|---|---|
| button | The panel for chatting with AI | All projects | AI Assistant |
| button | The list of DDL approval requests. The number is the count of pending requests | Account projects | DDL approval |
| button | The domains and dictionaries assigned to the connection of the current tab | All projects | Assigning to a connection |
| button | The history of executed SQL | All projects | SQL history and saved SQL |
- Drag the left edge of the right panel to change its width.
- Click the pin button (Float over content) in the panel header to turn the panel into a window floating over the work documents. Drag the top handle to move it, and drag its edges and corners to resize it. Click it again (Dock to side) to dock it on the right.
Work document tabs
- A tab opens when you click an ERD or SQL document in the list on the left, double-click a table in the explorer, or create a new document with the add tab button (8).
- Drag a tab to change the order.
- Double-click a tab name to collapse the left and right panels so the tab uses more of the screen. Double-click it again to bring the panels back.
- When no tabs are open, the No open tabs message appears with the Create New ERD button, the Create New SQL Editor button and the New dashboard button.
- Right-click a tab for the Close item, the Close Others item, the Close Tabs to the Left item, the Close Tabs to the Right item and the Close All item. ERD and SQL document tabs also have the Rename... item and the Delete item.
- A dot at the end of a tab name means it has unsaved changes. The TX mark means that SQL tab has an uncommitted transaction (SQL execution and transactions).
- Drop
.sqlfiles on the tab bar to choose a connection and open each file in its own SQL editor tab (SQL editor). - When you close a project and open it again, the tabs you had open come back.
Schema Changes panel
The button gathers, across the whole project, the tables you changed and saved in ERDs and table tabs but have not yet applied to the database. Use it to pick changes spread over several ERDs and apply or revert them in one place. ERDs and the real database explains why saving and applying to the database are separate steps.
| No. | Name | Description |
|---|---|---|
| 1 | button | The number is the count of tables not yet applied. |
| 2 | Change count | The number of tables in the list. When there are none, the No pending changes message appears. |
| 3 | Select all checkbox | Selects or clears every item. The checkboxes on connection, database and schema rows select the items inside them. Everything is selected at first. |
| 4 | Change item | The table name with the ADDED, MODIFIED or DELETED mark. Index changes count as changes to their table. Click it to open the table's tab. |
| 5 | Reset button | Discards the changes of the selected tables and returns them to the state of the database. |
| 6 | Apply button | Opens the Change Review window for reviewing the selected tables. |
Applying selected changes to the database
- Check only the tables you want to apply.
- Click the Apply button. The Change Review window opens.
- Click a table in the list on the left to see what changed in its columns, indexes, foreign keys and table properties, and its DDL, on the right. Uncheck tables you do not want to apply.
- Click the DDL Preview & Execute (2) button. The window for previewing and running the DDL opens. Running it works the same as in Apply changes to the database.
- Tables that must be applied together with the selected ones (such as tables referencing a changed primary key) are added to the review window automatically and cannot be unchecked.
- If a table referenced by a foreign key is not in the database yet, you are asked whether to create that table too or leave the foreign key out this time.
Reverting changes
- Check only the tables you want to revert.
- Click the Reset button. The Reset Schema Changes window appears.
- Click the Reset button to discard the selected changes.
Things to keep in mind
- Changes discarded with the Reset button cannot be recovered. New tables that are not in the database yet are removed from the project.
- The Schema Changes panel only lists tables of connections that have database connection details. Tables of connections with only a DBMS set and of disabled connections are not listed.
- In account projects, if your role has the DDL Restriction permission, only the changes you made are listed. Applying them goes through approval (DDL approval).
- In account projects, if another member changes the same table first, your changes are discarded and the Schema Changes Discarded notification appears.
- On desktop, when several projects are open as tabs, the projects you are not looking at stay open. Moving between work tabs is explained in Work tabs.
- If the project cannot be loaded, the Failed to load project information. Would you like to retry? message and the Retry button appear instead of the screen.
Related screens
- Work tabs: How to keep several projects open as tabs and move between them.
- Project settings: The window the gear button opens.
- Object explorer: The connection tree in the left panel.
- ERD and SQL list: The document list below the explorer.
- Apply changes to the database: The DDL preview and run window that opens after the review window.
- App menu, top bar and status bar: The header and the status bar.