Quickstart for using the Cloud SQL Auth proxy

This page shows you how to connect to Cloud SQL from a local test environment using the Cloud SQL Auth proxy. The Cloud SQL Auth proxy provides secure access to your Cloud SQL instance without the need for authorized networks or for configuring SSL. By using the Cloud SQL Auth proxy, you can connect to your Cloud SQL instance securely.

Don't use these instructions to set up the Cloud SQL Auth proxy for a production environment. Also, for more connection options for authenticating and using the proxy, see Connecting using the Cloud SQL Auth proxy.

Set up your project

Before performing the steps in this quickstart, complete the following tasks:

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
  2. In the Google Cloud Console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Cloud project. Learn how to confirm that billing is enabled for your project.

  4. In the Google Cloud Console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Make sure that billing is enabled for your Cloud project. Learn how to confirm that billing is enabled for your project.

  6. Make sure you have the Cloud SQL Admin role on your user account.
    • Go to the IAM page.
      Go to the IAM page
    • Click Add.
    • In New Principals, add your user account name.
    • In Select a role, filter for Cloud SQL Admin and select it from the list.
    • Click Save.
  7. Enable the Cloud SQL Admin API.

    Enable the API

Create a Cloud SQL instance

In this procedure, you use the Google Cloud Console. To use the gcloud command-line tool, cURL, or PowerShell, see Creating instances.

  1. In the Google Cloud Console, go to the Cloud SQL Instances page.

    Go to Cloud SQL Instances

  2. Click Create Instance.
  3. Click SQL Server.
  4. If you're prompted to enable the Compute API, click the Enable API button.
  5. Enter myinstance for Instance ID.
  6. Enter a password for the sqlserver user.
  7. Use the default values for the other fields.
  8. Click Create.

    You are returned to the instances list; you can click into the new instance right away to see the details, but it won't be available until it initializes and starts.

    Note: In this example, the instance is created using default settings, including a public IP address.

Install a sqlcmd client.

Debian/Ubuntu

For Debian/Ubuntu, install the applicable SQL Server command-line tools using these instructions.

CentOS/RHEL

For CentOS/RHEL, install the applicable SQL Server command-line tools using these instructions.

openSUSE

For openSUSE, install the applicable SQL Server command-line tools using these instructions.

Other platforms

See the landing page for installing SQL Server, as well as the SQL Server downloads page.

Install the Cloud SQL Auth proxy client

For installation, see Installing the Cloud SQL Auth proxy.

Get the instance connection name

  1. In the Google Cloud Console, go to the Cloud SQL Instances page.

    Go to Cloud SQL Instances

  2. Click the instance name to open its Overview page.
  3. In the Connect to this instance section, copy the Connection name. The connection name is in the format projectID:region:instanceID.

Start the Cloud SQL Auth proxy

Start the Cloud SQL Auth proxy in its own terminal so you can monitor its output. Replace INSTANCE_CONNECTION_NAME with the instance connection name you copied in the previous step.

For Linux environments, use this command to launch the Cloud SQL Auth proxy:

./cloud_sql_proxy -instances=INSTANCE_CONNECTION_NAME=tcp:1433

In PowerShell on Windows, use this command to launch the Cloud SQL Auth proxy:

.\cloud_sql_proxy.exe -instances=INSTANCE_CONNECTION_NAME=tcp:1433

A message similar to the following appears:

Listening on 127.0.0.1:1433 for INSTANCE_CONNECTION_NAME
Ready for new connections

Run the following command, replacing USER_NAME with your SQL Server username.

sqlcmd -S 127.0.0.1 -U USER_NAME

Return to the terminal window where you started the Cloud SQL Auth proxy. You should see a message similar to the following:

New connection for myInstance

Cleanup

  1. In the Google Cloud Console, go to the Cloud SQL Instances page.

    Go to Cloud SQL Instances

  2. Select the your instance's name to open the Overview page.
  3. In the icon bar at the top of the page, click Delete.
  4. In the Delete instance window, type your instance's name, then click Delete to delete the instance.

    You cannot reuse an instance name for about 7 days after the instance is deleted.

What's next