Connect to Cloud SQL for SQL Server 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.
The instructions on this page are for a test environment only and shouldn't be used for production environments. For more information on the configuration required for production environments, see Use the Cloud SQL Auth Proxy in a production environment and Connect using the Cloud SQL Auth Proxy.
Before you begin
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the necessary Google Cloud APIs.
Console
In the Google Cloud console, go to the APIs page.
Enable the Cloud SQL Admin API.gcloud
Click the following button to open Cloud Shell, which provides command-line access to your Google Cloud resources directly from the browser. Cloud Shell can be used to run the
gcloud
commands presented throughout this quickstart.Run the
gcloud services enable
command as follows using Cloud Shell to enable the APIs required for this quickstart.:gcloud services enable sqladmin.googleapis.com
This command enables the following APIs:
- Cloud SQL Admin API
Create a Cloud SQL instance
In this quickstart, you use the Google Cloud console. To use the gcloud CLI, cURL, or PowerShell, see Create instances.
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- Click Create instance.
- Click Choose SQL Server.
- In the Instance ID field, enter
myinstance
. - In the Password field, enter a password for the
sqlserver
user. Click Create instance.
You're returned to the instances list. You can click the new instance right away to see the details, but it won't be available for other operations until it initializes and starts.
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
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- Click the instance name to open its Overview page.
- 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 INSTANCE_CONNECTION_NAME
In PowerShell on Windows, use this command to launch the Cloud SQL Auth Proxy:
.\cloud-sql-proxy.exe INSTANCE_CONNECTION_NAME
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
Clean up
To avoid incurring charges to your Google Cloud account for the resources used on this page, follow these steps.
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- Select the
myinstance
instance to open the Instance details page. - In the icon bar at the top of the page, click Delete.
- In the Delete instance window, type your instance's name and then click Delete.
Optional cleanup steps
If you're not using the APIs that were enabled as part of this quickstart, you can disable them.
- APIs that were enabled within this quickstart:
- Cloud SQL Admin API
In the Google Cloud console, go to the APIs page.
Select the Cloud SQL Admin API and then click the Disable API button.
What's next
See how to troubleshoot information for the Cloud SQL Auth Proxy.
Learn more about the Cloud SQL Auth Proxy.