Connect from Hasura Cloud to Neon

Hasura Cloud is an open source GraphQL engine that provides a scalable, highly available, globally distributed, secure GraphQL API for your data sources.

This guide describe how to connect a Hasura Cloud project to a new or existing Neon database.

Connecting to a new Neon database

Use the following instructions to connect to a new Neon database. This connection method authenticates you from Hasura Cloud.

Navigate to Hasura Cloud and sign up or log in.
On the Hasura Cloud dashboard, create a Hasura project.
After the project is initialized, click Launch Console to open the Hasura Console.
On the Hasura Console, navigate to DATA > Manage > Connect Database > Create New Database.
Click Connect Neon Database.
When prompted to login or sign up for Neon, we recommend selecting Continue with Hasura for seamless authentication.

After authenticating, a new Neon PostgreSQL database is created and connected to your Hasura project, and the Neon project connection string is associated with the PG_DATABASE_URL environment variable.

To start exploring Hasura's GraphQL API with data stored in Neon, see Load a template in Hasura.

Connecting to an existing Neon database

Use the following instructions to connect to an existing Neon database from Hasura Cloud. The connection is configured manually using a connection string.

Prerequisites

An existing Neon account. If you do not have one, see Sign up.
An existing Neon project. If you do not have a Neon project, see Set up a project.
A connection string for a branch in Neon project that includes your password. For example:
```
postgres://<user>:<password>@<endpoint_hostname>:5432/neondb
```
Your project's connection string can be found on the Neon Dashboard, under Connection Details. For more information, see Connect from any application. If you have misplaced your password, see Reset a password.

Add Neon as a data source

The following steps describe how to navigate to Hasura Cloud and connect to your Neon project.

Navigate to Hasura Cloud and sign up or log in.
Click Create Project to create a Hasura Cloud project or click Launch Console to open an existing project.
Select DATA from the top navigation bar.
On the Connect Existing Database tab, paste your connection string into the Database URL field.
Enter a display name for your database in the Database Display Name field, and click Connect Database.

Hasura Cloud connects to your Neon project and automatically discovers the default public schema.

To start exploring Hasura's GraphQL API with data stored in Neon, see Load a template in Hasura.

Load a template in Hasura (optional)

Optionally, after connecting from your Hasura project to Neon, you can explore Hasura's GraphQL API by loading a template from Hasura's template gallery. Follow these steps to load the Welcome to Hasura template, which creates customer and order tables and populates them with sample data.

In the Hasura Console, select DATA.
Under Data Manager, select your database.
From the Template Gallery, select Welcome to Hasura to install the template.

To view the newly created tables from the Neon Console:

In the Hasura Console, select DATA > Manage your Neon databases to open the Neon Console.
In the Neon Console, select your project.
Select the Tables tab. The newly created customer and order tables should appear under the Tables heading in the sidebar.

Import existing data to Neon

If you are migrating from Hasura with Heroku PostgreSQL to Neon, refer to the Import from Heroku guide for data import instructions. For general data import instructions, see Import from PostgreSQL.

Need help?

Send a request to support@neon.tech, or join the Neon community forum.