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

Note: On Windows, enter these commands beforeexecutingpsql commands:
SET PGCLIENTENCODING=utf-8
chcp 65001

Before you begin

Before you can use apsql client to connect to your Cloud SQLinstance, do the following:

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

  See Create instances andSet the password for the default user account.

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

  SeeCreate and start a VM instance,About SSH connections, orConnect to Windows VMs using RDP.

• Determine how you'll connect to your instance.

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

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

Using apsql client to connect to your Cloud SQLinstance 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 thepsql client, do the following:

sudoapt-getupdatesudoapt-getinstallpostgresql-client

sudoyuminstallpostgresql

sudozypperinstallpostgresql

Configure access to your Cloud SQLinstance

To configure access to your instance, do the following:

1. From the client machine or Compute Engine VM instance, useWhat'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 theCloud SQL Instances page.

   Go to Cloud SQL Instances

4. To open theOverview page of an instance, click the instance name.
5. SelectConnections from the SQL navigation menu.
6. Select theNetworking tab.
7. In theAuthorized networks section, clickAdd network and enter the IP address of the machine where the client is installed.Note: The IP address of the instance and thepsql client IP address you authorize must both be IPv4.
8. ClickDone. Then clickSave at the bottom of the page to save your changes.
9. Connect to your instance, eitherusing SSL/TLS orwithout encryption (without using SSL/TLS).

Connect to your Cloud SQL instance withoutencryption

To let you connect without encryption, the instance must haveSSL modeset toALLOW_UNENCRYPTED_AND_ENCRYPTED. In the Google Cloud console,the equivalent configuration isAllow unencrypted network traffic.

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

To connect to your instance, do the following:

1. Confirm that you haveinstalled the client andconfigured access to your instance.
2. Start thepsql 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 thepsql 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

Ifssl_mode on your Cloud SQL instance is configured toTRUSTED_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 aclient-cert.pem file.
• A client private key in aclient-key.pem file.

In addition, to let the client verify the server's identityfor mutual authentication, specify the server certificateserver-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 correspondingprivate key, thencreate 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 thepsql client works with SSL.