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 Note: The name you use for your project must be between 4 and 30 characters. When you type the name, the form suggests a project ID, which you can edit. The project ID must be between 6 and 30 characters, with a lowercase letter as the first character. You can use a dash, lowercase letter, or digit for the remaining characters, but the last character cannot be a dash.In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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.
Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.Make sure that billing is enabled for your Google Cloud project.
In the Google Cloud console, go to the APIs page.
Enable the Cloud SQL Admin API. gcloudClick 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:
Make sure that you have the following role or roles on the project: Cloud SQL Admin (roles/cloudsql.admin
), Cloud SQL Viewer (roles/cloudsql.viewer
)
In the Google Cloud console, go to the IAM page.
Go to IAMIn the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.
In the Google Cloud console, go to the IAM page.
Go to IAMIn the New principals field, enter your user identifier. This is typically the email address for a Google Account.
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.
myinstance
.postgres
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.
Note: In this example, the instance is created using default settings, including a public IP address.Install the psql client from the package manager:
sudo apt-get update sudo apt-get install postgresql-clientCentOS/RHEL
Install the psql client from the package manager:
sudo yum install postgresqlopenSUSE
Install the psql client from the package manager:
sudo zypper install postgresqlOther platforms
The Cloud SQL Auth Proxy binary you download depends on your operating system, and whether it uses a 32-bit or 64-bit kernel. Most newer hardware uses a 64-bit kernel. If you're unsure whether your machine is running a 32-bit or 64-bit kernel, then use the uname -a
command for Linux or macOS. For Windows, see the Windows documentation.
curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.17.1/cloud-sql-proxy.linux.amd64
chmod +x cloud-sql-proxy
curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.17.1/cloud-sql-proxy.linux.386
curl
command is not found, run sudo apt install curl
and repeat the download command.chmod +x cloud-sql-proxy
curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.17.1/cloud-sql-proxy.darwin.amd64
chmod +x cloud-sql-proxy
curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.17.1/cloud-sql-proxy.darwin.arm64
chmod +x cloud-sql-proxy
cloud-sql-proxy.exe
. Windows 32-bit Right-click https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.17.1/cloud-sql-proxy.x86.exe and select Save Link As to download the Cloud SQL Auth Proxy. Rename the file to cloud-sql-proxy.exe
. Cloud SQL Auth Proxy Docker image
The Cloud SQL Auth Proxy has different container images, such as distroless
, alpine
, and buster
. The default Cloud SQL Auth Proxy container image uses distroless
, which contains no shell. If you need a shell or related tools, then download an image based on alpine
or buster
. For more information, see Cloud SQL Auth Proxy Container Images.
You can pull the latest image to your local machine using Docker by using the following command:
docker pull gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.17.1Note: The Cloud SQL Auth Proxy uses a repository that supports the
gcr.io
domain but serves images from Artifact Registry. For more information, see Transition from Container Registry. Other OS For other operating systems not included here, you can compile the Cloud SQL Auth Proxy from source. Get the instance connection name
In the Google Cloud console, go to the Cloud SQL Instances page.
projectID:region:instanceID
.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:5432 for INSTANCE_CONNECTION_NAME Ready for new connections
Run the following command after replacing DB_NAME with the name of the Cloud SQL database:
psql "host=127.0.0.1 port=5432 sslmode=disable dbname=DB_NAME user=postgres"
At the Enter password: prompt, enter the password of your PostgreSQL account.
Verify that the PostgreSQL prompt appears. You have connected to your database using the psql client.
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
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.
myinstance
instance to open the Instance details page.If you're not using the APIs that were enabled as part of this quickstart, you can disable them.
In the Google Cloud console, go to the APIs page.
Select the Cloud SQL Admin API and then click the Disable API button.
See how to troubleshoot information for the Cloud SQL Auth Proxy.
Learn more about the Cloud SQL Auth Proxy.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4