You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: content/docs/manage/projects.md
+87-120
Original file line number
Diff line number
Diff line change
@@ -8,156 +8,80 @@ redirectFrom:
8
8
updatedOn: '2024-12-13T21:17:10.767Z'
9
9
---
10
10
11
-
With Neon, everything starts with the project. It is the top-level object in the [Neon object hierarchy](/docs/manage/overview). A project can hold as many databases and branches as your application or workflow needs. However, [plan limits](/docs/introduction/plans) define how many projects you can create.
12
-
13
-
Learn more about projects and how to manage them in these sections:
14
-
15
-
-[Default resources](#default-resources)
16
-
-[Project Settings](#about-the-settings-page)
17
-
-[Basic actions](#basic-actions)
18
-
-[Advanced settings](#advanced-settings)
19
-
-[Manage projects from the API](#manage-projects-with-the-neon-api)
11
+
With Neon, everything starts with the project. It is the top-level object in the [Neon object hierarchy](/docs/manage/overview). A project can hold as many branches, databases, and roles as your application or workflow needs. Your [Neon Plan](/docs/introduction/plans) determines how many projects you can create and resource limits within those projects.
20
12
21
13
## Default resources
22
14
23
15
When you add a new project, Neon creates the following resources by default:
24
16
25
17
- A default branch called `main`. You can create child branches from the default branch or from any previously created branch. For more information, see [Manage branches](/docs/manage/branches).
26
18
- A single primary read-write compute. This is the compute associated with the branch. For more information, see [Manage computes](/docs/manage/endpoints).
27
-
- A Postgres database that resides on the project's default branch. If you ddid not specify your own database name when creating the project, the database created is named `neondb`.
19
+
- A Postgres database that resides on the project's default branch. If you did not specify your own database name when creating the project, the database created is named `neondb`.
28
20
- A Postgres role that is named for your database. For example, if your database is named `neondb`, the project is created with a default role named `neondb_owner`.
29
21
30
-
## About the Settings page
31
-
32
-
Once you open a project, you can use the **Settings** page to manage that particular project and configure any defaults.
-**General**— Change the name of your project or copy the project ID.
39
-
-**Compute**— Set the scale to zero and sizing defaults for any new computes you create when branching.
40
-
-**Storage**— Choose how long Neon maintains a history of changes for all branches.
41
-
-**Sharing**— Let other users access your project's databases.
42
-
-**Delete**— Use with care! This action deletes your entire project and all its objects, and is irreversible.
43
-
44
-
## Basic actions
22
+
## Create a project
45
23
46
-
Here are some basic actions you can take to add or manage projects:
47
-
48
-
-[Create a project](#create-a-project)
49
-
-[View projects](#view-projects)
50
-
-[Change a project name](#change-the-name-or-copy-the-id-of-your-project)
51
-
-[Delete a project](#delete-a-project)
52
-
-[Invite collaborators to a project](#invite-collaborators-to-a-project)
53
-
54
-
### Create a project
55
-
56
-
The following instructions describe how to create additional Neon projects. If you are creating your very first Neon project, refer to the instructions in [Sign up](/docs/get-started-with-neon/signing-up).
24
+
The following instructions describe how to create additional Neon projects. If you are creating your very first Neon project, refer to the instructions in [Playing with Neon](/docs/get-started-with-neon/signing-up).
57
25
58
26
To create a Neon project:
59
27
60
28
1. Navigate to the [Neon Console](https://console.neon.tech).
61
29
2. Click **New Project**.
62
-
3. Specify values for **Project Name**, **Postgres version**, **Cloud Service Provider**, and **Region**. Project names are limited to 64 characters. If you are a paying user, you can specify **Compute size** settings when creating a project. The settings you specify become the default settings for computes that you add to your project when creating [branches](/docs/manage/branches#create-a-branch) or [read replicas](/docs/guides/read-replica-guide).
30
+
3. Specify values for **Project Name**, **Postgres version**, **Cloud Service Provider**, and **Region**. Project names are limited to 64 characters. You can also specify **Compute size** settings when creating a project. The settings you specify become the default settings for computes that you add to your project when creating [branches](/docs/manage/branches#create-a-branch) or [read replicas](/docs/guides/read-replica-guide).
63
31
64
32
- Neon supports fixed-size computes and autoscaling. For more information, see [Compute size and autoscaling configuration](/docs/manage/endpoints#compute-size-and-autoscaling-configuration).
65
33
- The scale to zero setting determines whether a compute is automatically suspended after a period of inactivity. For more information, see [Scale to zero configuration](/docs/manage/endpoints#scale-to-zero-configuration).
66
34
67
-
4. Optionally, select **More options** to specify a name for your default branch. The default name is `main`.
68
-
5. Click **Create Project**.
35
+
4. Click **Create Project**.
69
36
70
-
After creating a project, you are presented with a dialog that provides your connection details for your database. The connection details include your password.
37
+
After creating a project, you are directed to the Neon Quickstart.
71
38
72
39
<Admonitiontype="tip">
73
-
Similar to **docs.new** for instantly creating Google Docs or **repo.new** for adding new GitHub repositories, you can use [pg.new](https://pg.new) to create a new Neon Postgres project. Simply visit [pg.new](https://pg.new) and you'll be taken straight to the **Create project** page where you can create your new project.
40
+
Similar to **docs.new** for instantly creating Google Docs or **repo.new** for adding new GitHub repositories, you can use [pg.new](https://pg.new) to create a new Neon Postgres project. Simply visit [pg.new](https://pg.new) and you'll be taken directly to the **Create project** page where you can create your new project.
74
41
</Admonition>
75
42
76
-
###View projects
43
+
## View projects
77
44
78
45
To view your projects:
79
46
80
47
1. Navigate to the [Neon Console](https://console.neon.tech).
81
-
1.Select **Home** or the Neon logo at the topleft of the Console.
48
+
1.From the breadcrumb navigation menu at the top-left of the console, select your personal or organization account.
82
49
1. The **Projects** page lists your projects, including any projects that have been shared with you.
83
50
84
-
### Change the name or copy the ID of your project
85
-
86
-
You are permitted to change the name of your project at any point. The project ID is permanent.
87
-
88
-
To edit a Neon project:
89
-
90
-
1. Navigate to the [Neon Console](https://console.neon.tech).
91
-
2. Select the project that you want to edit.
92
-
3. Select **Settings**.
93
-
4. Select **General**.
94
-
5. Make your changes and click **Save**.
95
-
96
-
### Delete a project
97
-
98
-
Deleting a project is a permanent action, which also deletes any computes, branches, databases, and roles that belong to the project.
99
-
100
-
To delete a project:
101
-
102
-
1. Navigate to the [Neon Console](https://console.neon.tech).
103
-
2. Select the project that you want to delete.
104
-
3. Select **Project settings**.
105
-
4. Select **Delete**.
106
-
5. Click **Delete project.**
107
-
6. On the confirmation dialog, click **Delete**.
108
-
109
-
<Admonitiontype="important">
110
-
If you are any of Neon's paid plans, such as our Launch or Scale plan, deleting all your Neon projects won't stop monthly billing. To avoid charges, you also need to downgrade to the Free plan. You can do so from the [Billing](https://console.neon.tech/app/billing#change_plan) page in the Neon Console.
111
-
</Admonition>
112
-
113
-
### Invite collaborators to a project
114
-
115
-
Neon's project collaboration feature allows you to invite external Neon accounts to collaborate on a Neon project.
116
-
117
-
<Admonitiontype="note">
118
-
Organization members cannot be added as collaborators to organization-owned projects since they already have access to all projects through their organization membership.
119
-
</Admonition>
120
-
121
-
To invite collaborators to a Neon project:
51
+
## Project settings
122
52
123
-
1. In the Neon Console, select a project.
124
-
1. Select **Project settings**.
125
-
1. Select **Collaborators**.
126
-
1. Select **Invite** and enter the email address of the account you want to collaborate with.
127
-
1. Click **Invite**.
53
+
Once you open a project, you can use the **Settings** page to manage your project and configure any defaults.
128
54
129
-
The email you specify is added to the list of **Collaborators**. The Neon account associated with that email address is granted full access to the project, with the exception of privileges required to delete the project. This account can also invite other Neon users to the project. When that user logs in to Neon, the project they were invited to is listed on their **Projects**page under **Shared with you**.
The costs associated with projects being collaborated on are charged to the Neon account that owns the project. For example, if you invite another Neon user account to a project you own, any usage incurred by that user within your project is billed to your Neon account, not theirs.
57
+
The **Settings** page includes these sub-pages:
132
58
133
-
For additional information, refer to our [Project collaboration guide](/docs/guides/project-collaboration-guide).
59
+
-**General** — Change the name of your project or copy the project ID.
60
+
-**Compute** — Set the scale to zero and sizing defaults for any new computes you create when branching.
61
+
-**Storage** — Choose how long Neon maintains a history of changes for all branches.
62
+
-**Collaborators** — Let other users access your project's databases.
63
+
-**Network Security** — Configure Neon's IP and Private Networking features for secure access.
64
+
-**Logical Replication** — Enable logical replication to replicate data from your Neon project to external data services and platforms.
65
+
-**Transfer** — Transfer your project from a personal account to a Neon organization you are a member of.
66
+
-**Delete** — Use with care! This action deletes your entire project and all its objects, and is irreversible.
134
67
135
-
##Advanced settings
68
+
### General project settings
136
69
137
-
From the **Project settings** page, you can also set defaults or apply bulk changes across your Neon objects:
70
+
On the **General** page, you are permitted to change the name of your project or copy the project ID. The project ID is permanent and cannot be changed.
### Change your project's default compute settings
143
73
144
-
### Reset the default compute size
74
+
You can change your project's default compute settings on the **Compute** page.
145
75
146
76
_Compute size_ is the number of Compute Units (CUs) assigned to a Neon compute. The number of CUs determines the processing capacity of the compute. One CU is equal to 1 vCPU with 4 GB of RAM. Currently, a Neon compute can have anywhere from .25 CUs to 56 CUs. Larger compute sizes will be supported in a future release.
147
77
148
-
By default, new branches inherit the compute size from your first branch (i.e., `main`). However, there may be times when you want to reset this default. For example, if you want to create read replica computes, where each replica requires less compute per branch.
149
-
150
-
To reset the default compute size, go to **Settings** > **Compute**.
78
+
By default, new branches inherit the compute size from your first branch (i.e., `main`). However, there may be times when you want to configure this default.
151
79
152
80
Neon supports fixed-size and autoscaling compute configurations.
153
81
154
82
-**Fixed size:** Select a fixed compute size ranging from .25 CUs to 56 CUs. A fixed-size compute does not scale to meet workload demand.
155
83
-**Autoscaling:** Specify a minimum and maximum compute size. Neon scales the compute size up and down within the selected compute size boundaries in response to the current load. Currently, the _Autoscaling_ feature supports a range of 1/4 (.25) CU to 16 CUs. The 1/4 CU and 1/2 CU settings are _shared compute_. For information about how Neon implements the _Autoscaling_ feature, see [Autoscaling](/docs/introduction/autoscaling).
156
84
157
-
_Example: default minimum and maximum autoscale settings_
158
-
159
-
160
-
161
85
### Configure history retention
162
86
163
87
By default, Neon retains a history of changes for all branches in your project, enabling features like:
@@ -180,31 +104,31 @@ To configure the history retention period for a project:
180
104
181
105
For more information about available plan limits, see [Neon plans](/docs/introduction/plans).
182
106
183
-
## Enable logical replication
107
+
<Admonitiontype="note">
108
+
The Storage page also outlines Neon **Archive storage**** policy, if applicable to your Neon plan. For more information on this topic, see [Branch archiving](/docs/guides/branch-archiving).
109
+
</Admonition>
110
+
111
+
### Invite collaborators to a project
184
112
185
-
Logical replication enables replicating data from your Neon databases to a variety of external destinations, including data warehouses, analytical database services, messaging platforms, event-streaming platforms, and external Postgres databases.
113
+
Neon's project collaboration feature allows you to invite external Neon accounts to collaborate on a Neon project.
186
114
187
-
<Admonitiontype="important">
188
-
Enabling logical replication modifies the PostgreSQL `wal_level` configuration parameter, changing it from `replica`to `logical` for all databases in your Neon project. Once the `wal_level` setting is changed to `logical`, it cannot be reverted. Enabling logical replication also restarts all computes in your Neon project, meaning that active connections will be dropped and have to reconnect.
115
+
<Admonitiontype="note">
116
+
Organization members cannot be added as collaborators to organization-owned projects since they already have access to all projects through their organization membership.
189
117
</Admonition>
190
118
191
-
To enable logical replication in Neon:
119
+
To invite collaborators to a Neon project:
192
120
193
-
1. Select your project in the Neon Console.
194
-
2. On the Neon **Dashboard**, select **Settings**.
195
-
3. Select **Logical Replication**.
196
-
4. Click **Enable** to enable logical replication.
121
+
1. In the Neon Console, select a project.
122
+
1. Select **Project settings**.
123
+
1. Select **Collaborators**.
124
+
1. Select **Invite** and enter the email address of the account you want to collaborate with.
125
+
1. Click **Invite**.
197
126
198
-
You can verify that logical replication is enabled by running the following query:
127
+
The email you specify is added to the list of **Collaborators**. The Neon account associated with that email address is granted full access to the project, with the exception of privileges required to delete the project. This account can also invite other Neon users to the project. When that user logs in to Neon, the project they were invited to is listed on their **Projects** page under **Shared with you**.
199
128
200
-
```sql
201
-
SHOW wal_level;
202
-
wal_level
203
-
-----------
204
-
logical
205
-
```
129
+
The costs associated with projects being collaborated on are charged to the Neon account that owns the project. For example, if you invite another Neon user account to a project you own, any usage incurred by that user within your project is billed to your Neon account, not theirs.
206
130
207
-
After enabling logical replication, the next steps involve creating publications on your replication source database in Neon and configuring subscriptions on the destination system or service. To get started, refer to our [logical replication guides](/docs/guides/logical-replication-guide).
131
+
For additional information, refer to our [Project collaboration guide](/docs/guides/project-collaboration-guide).
208
132
209
133
### Configure IP Allow
210
134
@@ -395,6 +319,49 @@ curl -X PATCH \
395
319
396
320
</Tabs>
397
321
322
+
### Enable logical replication
323
+
324
+
Logical replication enables replicating data from your Neon databases to a variety of external destinations, including data warehouses, analytical database services, messaging platforms, event-streaming platforms, and external Postgres databases.
325
+
326
+
<Admonitiontype="important">
327
+
Enabling logical replication modifies the PostgreSQL `wal_level` configuration parameter, changing it from `replica` to `logical` for all databases in your Neon project. Once the `wal_level` setting is changed to `logical`, it cannot be reverted. Enabling logical replication also restarts all computes in your Neon project, meaning that active connections will be dropped and have to reconnect.
328
+
</Admonition>
329
+
330
+
To enable logical replication in Neon:
331
+
332
+
1. Select your project in the Neon Console.
333
+
2. On the Neon **Dashboard**, select **Settings**.
334
+
3. Select **Logical Replication**.
335
+
4. Click **Enable** to enable logical replication.
336
+
337
+
You can verify that logical replication is enabled by running the following query:
338
+
339
+
```sql
340
+
SHOW wal_level;
341
+
wal_level
342
+
-----------
343
+
logical
344
+
```
345
+
346
+
After enabling logical replication, the next steps involve creating publications on your replication source database in Neon and configuring subscriptions on the destination system or service. To get started, refer to our [logical replication guides](/docs/guides/logical-replication-guide).
347
+
348
+
### Delete a project
349
+
350
+
Deleting a project is a permanent action, which also deletes any computes, branches, databases, and roles that belong to the project.
351
+
352
+
To delete a project:
353
+
354
+
1. Navigate to the [Neon Console](https://console.neon.tech).
355
+
2. Select the project that you want to delete.
356
+
3. Select **Project settings**.
357
+
4. Select **Delete**.
358
+
5. Click **Delete project.**
359
+
6. On the confirmation dialog, click **Delete**.
360
+
361
+
<Admonitiontype="important">
362
+
If you are any of Neon's paid plans, such as our Launch or Scale plan, deleting all your Neon projects won't stop monthly billing. To avoid charges, you also need to downgrade to the Free plan. You can do so from the [Billing](https://console.neon.tech/app/billing#change_plan) page in the Neon Console.
363
+
</Admonition>
364
+
398
365
## Manage projects with the Neon API
399
366
400
367
Project actions performed in the Neon Console can also be performed using the Neon API. The following examples demonstrate how to create, view, and delete projects using the Neon API. For other project-related API methods, refer to the [Neon API reference](https://api-docs.neon.tech/reference/getting-started-with-neon-api).
0 commit comments