Walkthroughs

Design together with your team

Three people design the demo shop together. You are the project owner, a DBA teammate reviews schema changes and applies them to the database, and a developer teammate edits tables in the ERD but cannot run DDL on the production database directly. When you finish, all three edit the same team ERD, and the developer's changes reach the database only after the DBA approves them. What is shared and what is yours alone, and how permissions are decided, is explained in Collaboration and permissions.

Where you can use itWebDesktopWithout signing inSigned inLocal projectsAccount projects

Before you start

  • Sign in. Features for working with teammates exist only in account projects. A local project cannot be shared and cannot be turned into an account project later (Sign-in and project types).
  • Check your plan's member limit. On a plan with a member limit of 1 (the Free plan), the Collaborate button does not appear in the header, so you cannot invite anyone. Co-editing, where saving a team ERD shows up on teammates' screens right away, only matters when there is someone to work with (Plans and features).
  • Decide whether you need a workspace or a project invitation. The steps use a project invitation, which brings teammates into one project.
What you needWhat to use
Teammates join this project and design togetherA project invitation (this page). It uses the member limit of the project's plan
Teammates create their own projects on your plan without payingA workspace invitation (see Workspaces). It uses workspace seats
BothInvite them to both separately. Inviting someone to a workspace does not share any project
  • You can invite teammates by email even if they are not NeoSQL members yet. They sign up with the invited email and then accept.

Create an account project

  1. Click the App menuCreate Database Project... item in the app menu on the left of the header. Result: The New project dialog opens. The web app always creates an account project.
  2. In the desktop app, check that the Account button (1) is selected. If you belong to someone else's workspace, choose the plan the project belongs to in the Affiliation (Plan) field. Result: The project's member limit is set by the chosen plan. It does not change unless you transfer ownership later.
  3. Enter a name and click the Create button. Result: The project is created on the NeoSQL server and opens. The dialog's fields are described in New project.
  4. Create the connection for the database the team shares. Enter a server address that every teammate can reach as the host. Result: It is saved as a public connection and teammates see it too. A connection pointing to localhost or a SQLite file becomes a private connection only you can see, and its ERDs cannot become team ERDs (Connections and execution targets).

Invite teammates

  1. Click the Collaborate button in the header. Result: The Project Share Settings dialog opens.
  2. Enter the DBA teammate's nickname or email in the Invite Team Members field (1), choose the DBA role from the arrow on the right of the invite button (5), and invite. Result: The invitation goes into the Pending Invitations list (4) and an invitation email goes to the DBA teammate. If they are already a member, it also arrives in the app's notifications.
  3. Invite the developer teammate by clicking the invite button (5) as it is, with the Member role. Result: They join with the role with the fewest permissions. The owner can raise the role later.
  4. Teammates open the link in the invitation email, or select the invitation in the app's notifications and click the Accept button. Result: Teammates appear in the Team Members list (2) with their roles, and open the project from the home screen.
  • An invitation can be accepted for 7 days. It must be accepted by an account signed in with the same email the invitation was sent to.
  • Which roles can invite, remove and transfer ownership is explained in Sharing and members.

Set permissions per role

Decide who applies changes to the database before teammates start editing the ERD. Changes saved before DDL restriction is turned on are shared with the team right away, and are handled differently from changes made after it is on.

  1. With the owner account, click the Project Settings button in the header and open the Project settingsRole Permissions tab. Result: There is a tab for each role except the owner, and each shows its permission options. Only the owner can change the Project settingsRole Permissions tab.
  2. On the Member role tab, select the DDL Restriction option and choose the DBA role in the Approver Role field. Result: Members cannot run DDL directly, and only the owner and roles at DBA level or above can approve their requests. The member role's Connection Permission option is turned off.
  3. If the developer teammate must not see customer information, also select the Sensitive Data Masking option on the same tab. Result: The member role sees values in sensitive columns masked. Columns are marked in Column masking.
  4. Save the project settings dialog. Result: The restrictions apply from the next time the developer teammate opens the project. If a teammate has the project open now, ask them to open it again.

Design together in a team ERD

A new ERD in an account project starts as a personal ERD that only you see. Turn the ERD you want to share into a team ERD.

  1. Create an ERD with the connection the team shares and add the customer, orders, order_item and product tables (ERD and SQL list). Result: A personal ERD is created. The Type field (1) of the info panel shows it is personal.
  2. In the info panel's More menu, choose the Start Team Sharing & Collaboration... item (2). Result: It becomes a team ERD that every project member sees. This cannot be undone. If you need your own copy, make one with the Copy to My ERD item.
  3. The DBA teammate adds a discontinued_at column to the product table in the ERD and saves. Result: The saved change shows up on the other teammates' screens right away. It is not applied to the database yet, so everyone sees it marked as a change.
  4. The developer teammate adds a memo column to the orders table and saves. Result: The developer's DDL is restricted, so the table change is kept separately until it is approved and does not appear on the other teammates' screens.
  • If two people edited different things, NeoSQL merges them without asking. Only when the same table was edited differently does the ERD Sync Conflict dialog ask which side to keep. A screen with no unsaved changes takes teammates' changes without asking, so save often during long edits.
  • A team ERD can be deleted only by someone with the All Permissions or ERD Delete Permission permission. Even its creator cannot delete it without the permission.

Apply to the database through approval

  1. The developer teammate clicks the Apply Changes to DB... button in the info panel. The Execute DDL button cannot be clicked, so they click the Request DB Apply button, write the reason and send it. Result: The request goes into the Pending tab of the Project railDDL Approval panel. Approvers do not get a notification, so let the team know.
  2. The DBA teammate clicks the request in the panel on the right rail. Result: The DDL Approval Review dialog opens and shows who wants to apply what to which database, and why.
  3. The DBA teammate reads the DDL in the DDL Content field (2), edits it if needed, clicks the Approve & Execute DDL button (6) and confirms. Result: The DBA teammate's app runs the DDL on the connection, and the approval is recorded only if it succeeds. If it fails, the request stays pending.
  4. The developer teammate gets a notification. Result: If approved, the applied change markers disappear from the developer's screen and the memo column becomes a column in the database. If rejected, the change stays so they can fix it and request again.
  • The approver's app runs the DDL. The DBA teammate must be able to reach the database: from their own device in the desktop app, or from the NeoSQL server in the web app (DDL approval).
  • DDL restriction blocks execution from NeoSQL screens and is not complete. The database user and password of a public connection are shared by the team, and approved DDL also runs with the same account. So if the account has DDL privileges, the app of a teammate whose DDL is restricted also connects to the database with the same account. Keep this in mind when you decide the privileges of production database accounts (Connect to a production database safely).

What's next