Skip to main content
Version: v2.x

Connecting Hasura to a Yugabyte Postgres Database

Introduction​

This guide explains how to connect a new or existing Yugabyte Postgres database to a Hasura instance, either on Hasura Cloud or via one of our self-hosted solutions. If you're exploring Yugabyte Postgres and are interested in migrating an existing Postgres database - such as from Heroku - check out their docs before continuing below.

Note

If you plan on using Hasura Cloud, which we recommend, follow steps 1 and 2 below. If you're self-hosting a Hasura instance and already have a project running, skip to step 3.

Step 1: Sign up or log in to Hasura Cloud​

Navigate to Hasura Cloud and sign up or log in.

Step 2: Create a Hasura Cloud project​

On the Hasura Cloud dashboard, create a new project:

Create Hasura Cloud project

You will get prompted for a Postgres Database URL. We will create this in the next step and then come back here.

After the project is initialized successfully, click on Launch Console to open the Hasura Console in your browser.

On the Hasura Console, navigate to Data -> Manage -> Connect Database -> Connect existing database:

Hasura Cloud database setup

Step 3: Create a Postgres DB on Yugabyte​

Log into the Yugabyte Cloud dashboard.

On the Yugabyte Cloud dashboard, click on Create a free cluster:

Create cluster on Yugabyte

Select the Managed Free option and then click Next.

Managed Free cluster on Yugabyte

Select a Cloud Provider and Region and then click Next.

Cloud Provider and Region on Yugabyte
Note

If you're using a database user other than the default one, make sure to give it the right Postgres permissions.

Download your credentials and then click Create Cluster.

Create cluster on Yugabyte after downloading credentials

Step 4: Allow connections to your DB from Hasura​

From the cluster's dashboard, click Add IP Allow List:

Add IP Allow List on Yugabyte

Within the modal, click Create New List and Add to Cluster:

Create New List and Add to Cluster on Yugabyte

If using Hasura Cloud, from your project's dashboard, copy the Hasura Cloud IP address:

Hasura Cloud IP field
Note

If you're using a self-hosted solution, you'll need to determine the IP address manually depending on your hosting service.

Enter the Hasura IP address that you copied:

Add Hasura IP to database in Allow List on Yugabyte

Then click Save.

Step 5: Construct the database connection URL​

The structure of the database connection URL looks as follows:

postgresql://<user-name>:<password>@<public-ip>:<postgres-port>/<db>?ssl=true&sslmode=require

To get it, from the cluster's dashboard, click Run your own application:

Run your own application on cluster dashboard

Click the Optimize for Hasura Cloud checkbox and then copy your connection string:

Copy connection string on cluster dashboard

Step 6: Finish connecting the database​

Back on the Hasura Console, enter the database URL that we just copied and replace the <DB USER> and <DB PASSWORD> with the information from your credentials downloaded in step 3:

Database setup

Then click Connect Database.

Note

For security reasons, it is recommended to set database URLs as env vars and using the env vars to connect to the databases in place of the raw database URLs.

Voilà. You are ready to start developing.

Hasura Console

Next steps​

Project actions
Note

For more information on which Postgres features we support, check out this page.