Building SQL QueriesDocumentation

Connecting to Postgres in Google Cloud

This guide is for connecting to Cloud SQL Postgres instances in Google Cloud. If you're using a custom Postgres server or another cloud provider, refer to Managing Postgres Connections.

Connect from Cloud Run

You may also find the official google cloud docs helpful as those docs may be updated more frequently than this document. The official docs are not specific to @database/pg though.

Before you can connect, you will need to:

  • Make sure that the instance created earlier has a public IP address. . You can verify this on the Overview page for your instance in the Google Cloud Console. If you need to add one, see the Configuring public IP page for instructions.

  • Get the for your instance. This can be found on the Overview page for your instance in the Google Cloud Console. or by running the following command: gcloud sql instances describe $INSTANCE_NAME.

  • Configure the service account for your service. Make sure that the service account has the appropriate Cloud SQL roles and permissions to connect to Cloud SQL. The service account for your service needs the Cloud SQL Client role.

  • Make sure you know the , and name you want to connect to.

The database password should be stored in Google Secret Manager. Create a new secret to store the value of and note the .

To configure your cloud run service to connect to the Postgres database, run:

gcloud run services update  \
  --add-cloudsql-instances= \
  --update-env-vars=PGHOST=/cloudsql/ \
  --update-env-vars=PGUSER= \
  --update-secrets=PGPASSWORD=:latest \

You can then connect using the following and @databases will automatically detect the config from your environment variables:

import createConnectionPool from '@databases/pg';

const db = createConnectionPool();

If you prefer to use custom environment variable names, you can also manually specify all the connection parameters:

import createConnectionPool from '@databases/pg';

const db = createConnectionPool({
  user: process.env.DB_USER, // e.g. 'my-user'
  password: process.env.DB_PASS, // e.g. 'my-user-password'
  database: process.env.DB_NAME, // e.g. 'my-database'
  host: `/cloudsql/${process.env.INSTANCE_CONNECTION_NAME}`,
PG Typed