Connect using a psql client

Stay organized with collections Save and categorize content based on your preferences.

You can use the PostgreSQL command-line client to connect to Cloud SQL. This page describes how to connect a psql client to your Cloud SQL instance, whether running locally on your client machine, on a Compute Engine VM, or in the Cloud Shell.

Before you begin

Before you can use a psql client to connect to your Cloud SQL instance, do the following:

• Create a Cloud SQL instance, including configuring the default user.

  See Create instances and Set the password for the default user account.

• Optionally, create a Compute Engine VM instance and then connected to the instance using SSH.

  See Create and start a VM instance, About SSH connections, or Connect to Windows VMs using RDP.

• Determine how you'll connect to your instance.

  For the connection options and how to choose from among them, see About connection options.

Use a PostgreSQL client on a local machine or a Compute Engine VM

Using a psql client to connect to your Cloud SQL instance involves three high-level tasks:

1. Install the client.
2. Configure access to your Cloud SQL instance.
3. Connect to your Cloud SQL instance.

Install the client

To install the psql client, do the following:

sudoapt-getupdate sudoapt-getinstallpostgresql-client

sudoyuminstallpostgresql

sudozypperinstallpostgresql

Configure access to your Cloud SQL instance

To configure access to your instance, do the following:

1. From the client machine or Compute Engine VM instance, use What's my IP to see the IP address of the client machine.
2. Copy that IP address.

3. In the Google Cloud console, go to the Cloud SQL Instances page.

   Go to Cloud SQL Instances

4. To open the Overview page of an instance, click the instance name.
5. Select Connections from the SQL navigation menu.
6. Select the Networking tab.
7. In the Authorized networks section, click Add network and enter the IP address of the machine where the client is installed.
8. Click Done. Then click Save at the bottom of the page to save your changes.
9. Connect to your instance, either using SSL/TLS or without encryption (without using SSL/TLS).

Connect to your Cloud SQL instance without encryption

To let you connect without encryption, the instance must have SSL mode set to ALLOW_UNENCRYPTED_AND_ENCRYPTED. In the Google Cloud console, the equivalent configuration is Allow unencrypted network traffic.

For more information about the SSL/TLS configuration of your instance, see Configure SSL/TLS certificates.

To connect to your instance, do the following:

1. Confirm that you have installed the client and configured access to your instance.
2. Start the psql client:

   psql"sslmode=disable dbname=postgres user=postgres hostaddr=INSTANCE_IP_ADDRESS"

3. Enter your password.
4. The psql prompt appears.

Connect to your Cloud SQL instance using SSL/TLS

To connect to your instance using SSL/TLS and built-in authentication:

1. Start the psql client:

   psql"sslmode=require \ hostaddr=INSTANCE_IP_ADDRESS \ user=postgres dbname=DB_NAME"

   For example:

    psql "sslmode=require \ hostaddr=203.12.34.56 \ user=postgres dbname=postgres" 

   You might also want to create a Connection Service File to manage your connection parameters, especially if you are connecting to more than one instance. For more information, see the PostgreSQL documentation.

2. Enter the password. The password is mandatory for Cloud SQL even though PostgreSQL supports passwordless connectivity while using SSL/TLS.
3. You can confirm that the connection is encrypted by looking for the cipher in the connection information:

    SSL connection (cipher: ECDHE-RSA-AES128-GCM-SHA256, bits: 128) 

Connect to your Cloud SQL instance using SSL/TLS and client certificate verification

If ssl_mode on your Cloud SQL instance is configured to TRUSTED_CLIENT_CERTIFICATE_REQUIRED, then you must also provide a verified client identity when you log in.

To connect using SSL/TLS certificates with client verification, you need the following:

• A client public key certificate in a client-cert.pem file.
• A client private key in a client-key.pem file.

In addition, to let the client verify the server's identity for mutual authentication, specify the server certificate server-ca.pem.

psql"sslmode=verify-ca sslrootcert=server-ca.pem \ sslcert=client-cert.pem sslkey=client-key.pem \ hostaddr=INSTANCE_IP_ADDRESS \ user=postgres dbname=DB_NAME"

If you do not have a client certificate and a corresponding private key, then create a new client certificate.

Using the client in the Cloud Shell

What's next

• Learn about configuring an instance with a private IP address.
• Learn about options for connecting to your instance from your application.
• Learn about how the psql client works with SSL.