Install the Neon Postgres Native Integration on Vercel

About the integration

What is the Neon Postgres Native Integration?

The Vercel Marketplace allows you to add Neon Postgres to your Vercel project as a native integration.

• Installing the integration creates a Neon account for you if you do not have one already.
• Billing for Neon Postgres is managed in Vercel, not Neon.
• You get access to the same features and Neon pricing plans as users who register with Neon directly, including access to your database from the Neon Console.

How to install

To install the Neon Postgres Native Integration from the Vercel Marketplace:

1. Navigate to the Vercel Marketplace or to the Integrations Console on your Vercel Dashboard.

2. Locate the Neon integration.

3. Click Install.

4. On the Install Neon modal, you are presented with two options. Select Create New Neon Account, and click Continue.

5. On the Create New Neon Postgres Account modal, accept the terms and conditions, and click Create New Neon Account.

6. On the Create Database modal, select a region and a Neon Plan, and click Continue.

   note

   For a full overview of features and allowances available in each Neon plan, please refer to the Neon Pricing page.

7. Specify a Database Name, and click Create.

   A Database in Vercel is a Project in Neon

   Your Database Name in Vercel will be the name of your Project in Neon. Just remember that A "Database" in Vercel is a "Project" in Neon. A Neon project can have multiple Postgres databases.

8. A Database is created in Vercel, and you are directed to the Storage tab on the Vercel Dashboard where you can view details about your new Database, including:

   • Status
   • Plan
   • Current Period (billing)
   • Period Total (billing)
   • Your database connection string

   From the sidebar, you can view your Neon Projects, Settings, Getting Started, and Usage. There's also a link to Neon Support.

Open your Database / Neon Project in the Neon Console

To open your Database / Neon Project in the Neon Console:

1. From the Storage tab in the Vercel Dashboard, select your Database.
2. On your Database page, select Open in Neon Postgres.
3. In the Neon Console, you are directed the projects page for your Organization. It will be named Vercel: <organization_name>. If you're a new Neon user, you will have a single Neon Project, and your Organization name in Neon will be the name of your Vercel account. For example, if your Vercel account name is Alex's projects, your Neon Organization name will be Vercel: Alex's projects.

Actions supported only from the Vercel Dashboard

As a user of the Neon Postgres Native Integration, you have access to all Neon features. However, some actions normally performed in the Neon Console are either not supported or only available through the Vercel Dashboard:

• Project/Database Management:

  • Databases (a.k.a "Projects" in Neon) can only be created or deleted through the Vercel Dashboard. See Adding more databases and Deleting your database.
  • Organization Deletion: Organizations cannot be deleted in the Neon Console; they are deleted if the Neon Postgres Native Integration is uninstalled from Vercel.

• User & Collaborator Management:

  • Organization members are managed in Vercel, not manually added through the Neon Dashboard.
  • Organization deletion is not supported for Neon organizations created by the native integration. You can only delete this organization by deleting the associated Database in Vercel.
  • Project transfer is not supported for a Neon organization created by the native integration.
  • Project collaborators are also managed as Members in Vercel.

• Compute Settings:

  • Compute settings like size, autoscaling, and autosuspend are managed in Vercel. See Changing your Database configuration.

• Project Naming:

  • Changing your Neon project name (Database Name in Vercel) is done in Vercel. See Changing your Database configuration.

• Billing & Payments:

  • Invoices, payments, and plan changes (upgrades/downgrades) are managed in Vercel.

Changing your Database configuration

Configuration changes you can make include:

• Changing the Database Name (Project name in Neon)
• Changing the Compute size
• Changing Suspend after period of inactivity setting (Autosuspend)
• Changing your Installation Level Plan (your Neon plan)

To change your configuration:

1. On the Vercel Dashboard, navigate to Storage tab.
2. Select Settings.
3. In the Update configuration section, select Change Configuration.
4. Select the desired configurations, and click Save.

Adding more Databases

All Neon Plans, including the Free Plan, support multiple Databases / Neon Projects (remember that A "Database" in Vercel is a "Project" in Neon).

To create another Database / Neon Project:

1. On the Vercel Dashboard, navigate to your Integrations tab.

2. Locate the Neon Postgres integration, and click Manage.

3. Find the More Products card, and click Install.

4. Make your selections for region, compute size settings, and plan on the Create Database modal, and click Continue.

   note

   Remember, if you're adding another "Database", you're' already on a Neon Plan, which will be identified on the modal by a Current tag. Select a different plan will change your Neon Plan for all of your "Databases". So, don't select a different plan unless you actually want to change your plan for all of your "Databases".

5. Specify a Database Name (this will be the Project name in Neon), and click Create.

6. A new Database is created in Vercel, and you are directed to the Storage tab on the Vercel Dashboard where you can view details about your new Database, including:

   • Status
   • Plan
   • Current Period (billing)
   • Period Total (billing)
   • Your database connection string

   From the sidebar, you can view your Neon Projects, Settings, Getting Started, and Usage. There's also a link to Neon Support.

Monitoring usage

You can monitor usage in Vercel or in the Neon Console. For information about monitoring usage in the Neon Console, see Monitor billing and usage.

To monitor usage in Vercel:

1. On the Vercel Dashboard, navigate to Storage tab.
2. Select Usage to view the Usage Report for available metrics.

Changing your plan

When you install the Neon Postgres Native Integration from the Vercel Marketplace, you have access to all the same Neon plans that are available to anyone signing up for Neon directly. Changing your plan (upgrading or downgrading) is performed in Vercel.

1. On the Vercel Dashboard, navigate to Storage tab.
2. Select Settings.
3. In the Update configuration section, select Change Configuration.
4. Select the desired Installation plan, and click Save.

For an overview of Neon's plans, please visit our Pricing page.

Deleting your Database

Deleting a database in Vercel deletes your project in Neon and all of its data.

To delete your database:

1. On the Vercel Dashboard, navigate to Storage tab.
2. Select Settings.
3. Navigate to the Delete Database section and follow the instructions.

This action is not reversible, so please proceed with caution.

Environment variables set by the integration

The environment variables listed below are set by the integration. Please note the following:

• The DATABASE_URL variable is a pooled Neon connection string. Connection pooling in Neon uses PgBouncer. For more, see Connection pooling.
• DATABASE_URL_UNPOOLED is an direct connection string for your database, often required by schema migration tools. For more, see Connection pooling with schema migration tools.
• There are several variables provided for constructing your own connection settings.
• The integration sets variables that were previously used by Vercel Postgres. These variables support Vercel Postgres Templates, which you can now use with Neon Postgres.

# Recommended for most uses
DATABASE_URL

# For uses requiring a connection without pgbouncer
DATABASE_URL_UNPOOLED

# Parameters for constructing your own connection string
PGHOST
PGHOST_UNPOOLED
PGUSER
PGDATABASE
PGPASSWORD

# Parameters for Vercel Postgres Templates
POSTGRES_URL
POSTGRES_URL_NON_POOLING
POSTGRES_USER
POSTGRES_HOST
POSTGRES_PASSWORD
POSTGRES_DATABASE
POSTGRES_URL_NO_SSL
POSTGRES_PRISMA_URL

Limitations

When using the Neon Postgres Native Integration, installing the Neon Postgres Previews Integration on the same Vercel Project is not supported.