The new project window creates a project that holds your ERDs, SQL documents and connections. Everything in NeoSQL happens inside a project. The type you choose when creating it (local project or account project) cannot be changed later, so check the difference in Sign-in and project types first.
You can open the window from three places.
- The Create New Database Project card on the home screen
- The item in the app menu on the left of the header
- On desktop, the Create Database Project... item in the menu of the + button (Open project) at the end of the work tab bar
What's on the screen
| No. | Name | Description |
|---|---|---|
| 1 | Project type | On desktop without sign-in, the You are not signed in — this project will be stored only on this device. Sign in to create account projects. notice appears and only local projects can be created. On desktop with sign-in, the Project Type option appears here instead (see 'Choosing the type on desktop with sign-in' below). In the web app nothing appears here and projects are always account projects. |
| 2 | Project Name field | Required. If you leave it empty, the This field is required. message appears. You can rename the project later in the project settings. |
| 3 | Create Sample ERD (classicmodels) option | When checked, an ERD with example tables and one connection are created along with the project. When unchecked, an empty project without connections is created. Your choice from the last project you created is kept the next time you open the window. |
| 4 | Select DBMS field | Appears only when Create Sample ERD (classicmodels) is checked. The example tables and the connection are created for this DBMS. |
| 5 | Create button | Creates and opens the project. You can also press Enter in the name field. The Cancel button closes the window without creating anything. |
- When you create an account project and have joined a workspace, the Affiliation (Plan) field appears above the name field. See 'Choosing the affiliation' below.
- The connection created with the sample ERD only has its DBMS set and has no database connection details. Enter them after the project opens.
Creating a project
The steps are the same as 'Creating your first local project' in First run.
- Open the window from one of the three places above.
- On desktop with sign-in, choose the type; choose the affiliation if the field is shown.
- Enter a name in the Project Name field (2).
- To start with examples, check Create Sample ERD (classicmodels) (3) and choose a DBMS (4).
- Click the Create button (5). The Project created notification appears and the new project's screen opens.
What opens next depends on what you chose.
| What you chose | After the project opens |
|---|---|
| Create Sample ERD (classicmodels) | An ERD with example tables opens, and the Connection Setup window appears. Click OK to open the connection window and enter the database connection details. Click Cancel to work on the ERD without connection details. |
| Empty project | The project screen opens with no connections. Add one with the Add connection button in the explorer (Create and edit a connection). |
Choosing the type on desktop with sign-in
In the desktop app with sign-in, you choose each time whether to create a local project or an account project.
- Choose either the Account button or the Local button (1). Account is selected when the window opens.
- The description of the chosen type (2) appears right below.
| How you run NeoSQL | Type created |
|---|---|
| Desktop, without sign-in | Always a local project. To create an account project, sign in first (Sign-up and sign-in). |
| Desktop, signed in | Chosen in the Project Type option. |
| Web app | Create an account project. |
Choosing the affiliation
An account project belongs to a plan. If you have joined someone else's workspace, the Affiliation (Plan) field appears, and you choose either My plan or one of the workspaces you joined. If you have not joined any workspace, the field is hidden and the project belongs to your plan.
- Each item shows the plan name and, if the plan limits the number of projects, the current count and the limit.
- If the workspace owner's plan does not include the workspace feature, that item is dimmed and cannot be chosen.
- If the chosen affiliation is at its project limit, the project is not created and a notice appears.
- Local projects have no affiliation, so the field is hidden for them.
Workspaces are explained in Workspaces.
Things to keep in mind
- The project type cannot be changed later. For a project you will share with a team, sign in and create an account project.
- On desktop, the new project opens in a new work tab and the project that was open stays open. In the web app, the open project is closed first. If it has unsaved changes you are asked first, and if you cancel in that window, the project is not created.
- If closing the open project does not finish cleanly, the The new project was not created because the project that was open could not be closed cleanly. Try again in a moment. notification appears and the project is not created. Try again in a moment.
- If an error occurs while creating, an error notification appears and the window stays open.
Related screens
- First run: The steps for creating your first local project.
- Sign-in and project types: The difference between local projects and account projects.
- Project screen layout: The screen that opens after the project is created.
- Project settings: The window for changing the project name and other settings.
- Home: Where you open, rename and delete projects.
- Create and edit a connection: The window for adding a connection to an empty project.