Working with teammates is available only in account projects. People who join a project as members see and edit team ERDs and table designs together, and what each of them can do depends on their role. This page explains what you share and what stays yours, how permissions are decided, and what happens when two people change the same thing.
What you need to work together
- The project must be an account project opened while signed in. Local projects cannot be shared, and cannot be turned into account projects later (Sign-in and project types).
- The project's plan must allow two or more people. On a plan with a sharing limit of one, the Collaborate button does not appear in the header (Plans and features).
- Clicking the Collaborate button in the header opens the Project Share Settings dialog. Invite people by email or nickname and choose a role. Invitations use the Member role, which has the fewest permissions, unless you choose another. Inviting and managing members is explained in Sharing and members.
Roles and permissions
Roles
Each member has one role. A role is a set of default permissions; what a member can actually do is decided by the permission items turned on or off for each role. The owner changes the permission items in the tab. Members with the All Permissions permission also see this tab, but read-only. Changing a member's role and removing members are decided by the role itself rather than by permission items, and inviting depends on both the role and the Share Permission permission.
| Role | Managing members | Permissions on at first |
|---|---|---|
| Owner | Changes the role of any member, removes members and transfers ownership. A project has one owner. | All permissions. Cannot be changed. |
| Manager | Removes members in the DBA and Member roles. Cannot change roles. | Share Permission, Connection Permission, ERD Delete Permission |
| DBA | None. | Connection Permission, ERD Delete Permission |
| Member | None. | None. |
Members other than the owner leave a project themselves with the Leave Project button in the Project Share Settings dialog.
Permission items
Some permission items grant something when turned on, and some restrict something when turned on.
| Item | When on |
|---|---|
| All Permissions | Turns on all the granting items below, including project settings, and turns off all restricting items. |
| Share Permission | Invites other users to this project. A Manager invites as DBA or Member, other roles only as Member. The owner invites as any role except owner regardless of this item. |
| Connection Permission | Views, adds, edits and deletes connections. |
| ERD Delete Permission | Deletes team ERDs. |
| Sensitive Data Masking | (Restriction) Values in columns marked as sensitive are shown masked. See Column masking. |
| Watermark Enforce | (Restriction) The watermark set in the project is always added to ERD images. It can be changed only on plans that let you set the watermark text. |
| DDL Restriction | (Restriction) DDL that creates, changes or drops tables cannot be run directly and must be requested through 'DDL approval' below. |
| Domain restriction | (Restriction) Domains can be used but not managed, and domain packs cannot be assigned to connections. |
What you share and what stays yours
| Seen by teammates | Seen only by you | |
|---|---|---|
| ERDs | Team ERDs | Personal ERDs |
| Table designs | There is only one set of columns, keys, indexes and not-yet-applied changes per project, so everyone sees it. Only the changes of members with the DDL Restriction permission on are kept apart until approved. | None. |
| Connections | Connections to servers teammates can reach | Connections to a database on your own computer (localhost, an SQLite file and so on). Only their creator sees them (Connections and execution targets). |
| SQL documents | None. | SQL editor documents are stored separately for each person. |
| Screen and editor settings | None. | Personal settings such as SQL editor settings (the SQL Editor tab of the Project Configuration dialog), connection profiles and the position of the ERD view |
Even in a personal ERD, saving a change to a table design changes the project's design, and teammates see it. What stays yours is only the ERD drawing (layout, notes, groups and the tables included). How designs relate to the database is explained in ERDs and the real database.
Personal and team ERDs
A new ERD in an account project starts as a personal ERD. To view it with teammates, turn it into a team ERD.
| Personal ERD | Team ERD | |
|---|---|---|
| Who sees it | Only its creator | All project members, including those who join later |
| Saving and sync | Saved on the server. You can open it on other devices signed in with the same account. | When saved, the change appears on teammates' screens right away. |
| Publishing to the gallery | Publish with the Publish to Public... item in the info panel. | There is no publish item. Make a personal copy with the Copy to My ERD item and publish that. |
| Who can delete it | Its creator | People with the All Permissions or ERD Delete Permission permission. Even its creator cannot delete it without one of them. |
- The Type field (1) of the ERD info panel shows whether it is a personal or a team ERD.
- Turn a personal ERD into a team ERD with the Start Team Sharing & Collaboration... item (2) in the More menu. This cannot be undone. If you need a personal ERD again, make a copy from the team ERD with the Copy to My ERD item.
- Publish to the gallery with the Publish to Public... item (3) in the same menu. See Gallery and embedding.
When two people change the same ERD
When the same ERD is changed in two places, NeoSQL handles it differently depending on the type of ERD.
| Personal ERD | Team ERD | |
|---|---|---|
| When a conflict occurs | When another device or window signed in with the same account saved first, and you then save on this screen | When a change saved by a teammate arrives while this screen has unsaved changes |
| What NeoSQL does | Asks in the ERD Sync Conflict dialog. | If different parts were changed, merges them without asking. Shows the ERD Sync Conflict dialog only when the same table, note or group was changed differently, or one side changed what the other deleted. |
| What you choose | The Overwrite with Mine button saves the ERD on your screen, and the Use Server Version button replaces it with the server's ERD. | The same two buttons. Whichever you choose, changes that do not overlap are kept from both sides. |
- If this screen has no unsaved changes, a teammate's change is applied right away without asking.
- Closing the dialog without choosing changes nothing. Your changes on screen remain, and you may be asked again the next time you save.
- If an SQL document was saved first on another device or window, you choose the same way in the SQL Sync Conflict dialog.
Workspaces and project sharing
Both a workspace and project sharing invite people, but they share different things. Inviting someone to your workspace does not share any project with them.
| Workspace | Project sharing | |
|---|---|---|
| What is shared | Your plan. Members create projects with your plan. | One project |
| Where you invite | The screen | The Collaborate button on the project screen |
| How many people | Workspace seats (the owner's plan) | Sharing limit (the project's plan) |
| The invited person | Chooses that workspace in the Affiliation (Plan) field when creating a new account project. | Joins that project with a role. |
| Each other's projects | Not shared automatically. To work together, invite each other to the project separately. | Not applicable |
- The owner of a project a member created under the workspace is that member. The project also appears in the workspace owner's home list, but clicking it shows the Management-only project notice and does not open it. The workspace owner only manages it, for example by deleting, enabling or disabling it.
- Seats, invitations and cleaning up members are explained in Workspaces.
DDL approval
Where not everyone should change tables, such as a production database, turn on the DDL Restriction permission for a role so that DDL from that role runs only after approval.
- The owner turns on the DDL Restriction item for a role in the tab. From then on, table changes saved by members of that role are kept apart instead of being shared with the team.
- When such a member clicks the Apply Changes to DB... button, the DDL cannot be run directly. They click the Request DB Apply button in the preview dialog and send a request with the reason for the change.
- A member who can approve opens the request in the panel. They check the DDL, edit it if needed, and click the Approve & Execute DDL button or the Reject button.
- On approval, the approver's app runs the DDL, and the request is recorded as approved only if it runs successfully. Processed requests remain in the Completed tab.
- The requester can withdraw a pending request with the Withdraw button.
- The people who can approve are the owner and members whose own role has DDL Restriction off (or All Permissions on). If the requester's role has a Approver Role, only members of that role or higher approve. The exact rules are in DDL approval.
- The screens and steps are explained in DDL approval.
Things to keep in mind
- The DDL Restriction permission stops DDL from being run in NeoSQL's screens and, as the app itself says, is not complete. For production databases, also create the connection with a database account that has no DDL privileges.
- When you turn off the DDL Restriction item and save the settings, the unapplied changes of members in that role are discarded and their pending requests are cancelled. Process the requests you want to keep before turning the item off.
- A personal ERD linked to a connection to a database on your own computer cannot become a team ERD. Link it to a connection to a server teammates can reach.
- A personal ERD published to the gallery does not show the Start Team Sharing & Collaboration... item.
Related pages
- Sharing and members: the dialog for inviting teammates and changing roles.
- DDL approval: the screens for sending and reviewing approval requests.
- Project settings: the dialog where role permissions are changed.
- Workspaces: how to share your plan with other people.
- Plans and features: sharing limits and whose plan applies.
- Design together with your team: the steps for inviting teammates and designing together in a team ERD.