Skip to main content
Version: v2.x

Connecting Hasura to a GCP Postgres Database

Introduction

This guide explains how to connect a new or existing GCP Postgres database to a Hasura instance, either on Hasura Cloud or via one of our self-hosted solutions. If you're exploring GCP 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

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

On the Hasura Console, navigate to the Data tab and choose Connect Existing Database. Hasura will prompt you for a Postgres Database URL. We'll create this in the next step and then come back here.

Hasura Cloud database setup

Step 3: Create a Postgres DB on GCP

Note

If you have an existing Postgres database on GCP, you can skip this step and move on to step 4.

Log into the GCP console.

On the left-side navigation, scroll down to Storage and click on SQL:

Navigate to SQL in GCP

On the top, click on Create instance:

Create database instance in GCP

Select Postgres:

Select Postgres database instance in GCP

Select an instance ID, as well as a default user password. If required, choose a specific region and zone.

Configure database instance in GCP

Then click Create.

Step 4: Allow connections to your DB from Hasura

On the dashboard of your GCP database instance, on the left sidebar, click on Connections. Then scroll down to the checkbox Public IP, and click + Add network:

Navigate to connections in GCP

You can choose an optional name (e.g. "Hasura").

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 a new network in GCP

Then click Save.

Note

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

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>/
  • user-name: If you have a separate database user, the user name will be their name. If you didn't specify a user, the default user name is postgres.
  • password: If you have a separate database user, use their password. Otherwise, use the password that you chose when creating the database.
  • public-ip: The public IP can be obtained by clicking on Overview on the left-side navigation and then scrolling down to Connect to this instance:
Find the public IP for a GCP Postgres database
  • postgres-port: The default port for Postgres is 5432 if not specified otherwise.
  • db: The DB is postgres by default unless otherwise specified.

Step 6: Finish connecting the database

Back on the Hasura Console, enter the database URL that we retrieved in step 5:

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

Step 7 (optional): Enable SSL connection

Step 7.1 Get GCP SSL Certs

Google Cloud (GCP) SQL makes the following SSL/TLS certificates available for download:

  • A server certificate saved as server-ca.pem
  • A client public key certificate saved as client-cert.pem
  • A client private key saved as client-key.pem
Note Please refer to the

Google Cloud Documentation for detailed information about the different certs.

Download these certs to your local drive.

Step 7.2: Add env vars

If using Hasura Cloud, go to your project and add the following env vars:

(Open the cert files using your favorite text editor, select all the contents and copy them to the clipboard)

Env Var NameValue
SSL_ROOTCERT_GCPContents from server-ca.pem
SSL_CERT_GCPContents from client-cert.pem
SSL_KEY_GCPContents from client-key.pem

Here is how your Hasura Cloud env vars setup should look like:

Hasura Cloud Env Vars
Note

If you're using a self-hosted solution, you can set these env vars in your docker-compose.yml file.

Step 7.3: Configure SSL settings

Open the Console of your Hasura Project, go to the Data -> Manage -> [db-name] -> Edit page.

Under Connection Settings add the following SSL certificate settings:

Field NameValue
SSL Modeverify-ca (select from dropdown)
SSL Root CertificateSSL_ROOTCERT_GCP
SSL CertificateSSL_CERT_GCP
SSL KeySSL_KEY_GCP

Here is how the setup should look like:

Hasura Console SSL Config Setup

Finally, click on the Update Connection button to apply the SSL settings.

Update Connection Button

Next steps

Project actions
Note

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