Stay organized with collections Save and categorize content based on your preferences.
This page contains information and examples for connecting to a Cloud SQL instance from a service running in Cloud Run functions.
For step-by-step instructions on running a Cloud Run functions sample web application connected to Cloud SQL, see the quickstart for connecting from Cloud Run functions.
Cloud SQL is a fully-managed database service that helps you set up, maintain, manage, and administer your relational databases in the cloud.
Cloud Run functions is a lightweight compute solution for developers to create single-purpose, standalone functions that respond to Cloud events without the need to manage a server or runtime environment.
Set up a Cloud SQL instanceBy default, Cloud SQL assigns a public IP address to a new instance. You also have the option to assign a private IP address. For more information about the connectivity options for both, see the Connecting Overview page.
serverCaMode
for the instance. You must select the per-instance CA option (GOOGLE_MANAGED_INTERNAL_CA
) as the server CA mode for instances that you want to connect to from web applications.The steps to configure Cloud Run functions depend on the type of IP address that you assigned to your Cloud SQL instance.
Public IP (default)To configure Cloud Run functions to enable connections to a Cloud SQL instance:
gcloud sql instances describe [INSTANCE_NAME]
Cloud SQL Client
IAM role to both projects.If the authorizing service account belongs to a different project than the one containing the Cloud SQL instance, do the following:
5432
.After you configure Cloud Run functions, you can connect to your Cloud SQL instance.
Public IP (default)For public IP paths, Cloud Run functions provides encryption and connects using the Cloud SQL Auth Proxy in two ways:
Once correctly configured, you can connect your service to your Cloud SQL instance's Unix domain socket accessed on the environment's filesystem at the following path: /cloudsql/INSTANCE_CONNECTION_NAME
.
The INSTANCE_CONNECTION_NAME uses the format project:region:instance-id
. You can find it on the Overview page for your instance in the Google Cloud console or by running the following command:
gcloud sql instances describe [INSTANCE_NAME]
These connections are automatically encrypted without any additional configuration.
The code samples shown below are extracts from more complete examples on the GitHub site. Click View on GitHub
to see more.
.s.PGSQL.5432
suffix in the socket path. Some libraries apply this suffix automatically, but others require you to specify the socket path as follows:
/cloudsql/INSTANCE_CONNECTION_NAME/.s.PGSQL.5432Warning: Linux-based operating systems have a maximum socket path length of 108 characters. If the total length of the path exceeds this length, you cannot connect with a socket from Cloud Run functions. Connect with Cloud SQL connectors
The Cloud SQL connectors are language specific libraries that provide encryption and IAM-based authorization when connecting to a Cloud SQL instance.
PythonTo see this snippet in the context of a web application, view the README on GitHub.
JavaTo see this snippet in the context of a web application, view the README on GitHub.
Note:
To see this snippet in the context of a web application, view the README on GitHub.
Node.jsTo see this snippet in the context of a web application, view the README on GitHub.
Private IPFor private IP paths, your application connects directly to your instance through a VPC network. This method uses TCP to connect directly to the Cloud SQL instance without using the Cloud SQL Auth Proxy.
Connect with TCPConnect using the private IP address of your Cloud SQL instance as the host and port 5432
.
You can use the Cloud SQL Auth Proxy when testing your application locally. See the quickstart for using the Cloud SQL Auth Proxy for detailed instructions.
Connection PoolsConnections to underlying databases may be dropped, either by the database server itself, or by the infrastructure underlying Cloud Run functions. We recommend using a client library that supports connection pools that automatically reconnect broken client connections. Additionally, we recommend using a globally scoped connection pool to increase the likelihood that your function reuses the same connection for subsequent invocations of the function, and closes the connection naturally when the instance is evicted (auto-scaled down). For more detailed examples on how to use connection pools, see
Managing database connections.
Connection LimitsCloud SQL imposes a maximum limit on concurrent connections, and these limits may vary depending on the database engine chosen (see
Cloud SQL Quotas and Limits). It's recommended to use a connection with Cloud Run functions, but it is important to set the maximum number of connections to 1.
Note: Cloud Run functions limits concurrent executions to one per instance. You never have a situation where a single function instance is processing two requests at the same time. In most situations, only a single database connection is needed.Where possible, you should take care to only initialize a connection pool for functions that need access to your database. Some connection pools will create connections preemptively, which can consume excess resources and count towards your connection limits. For this reason, it's recommended to use Lazy Initialization to delay the creation of a connection pool until needed, and only include the connection pool in functions where it's used.
For more detailed examples on how to limit the number of connections, see Managing database connections.
API Quota LimitsCloud Run functions provides a mechanism that connects using the Cloud SQL Auth Proxy, which uses the Cloud SQL Admin API. API quota limits apply to the Cloud SQL Auth Proxy. The Cloud SQL Admin API quota used is approximately two times the number of Cloud SQL instances configured times the total number of functions deployed. You can set the number of max concurrent invocations to modify the expected API quota consumed. Cloud Run functions also imposes rate limits on the number of API calls allowed per 100 seconds.
What's nextExcept as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-02 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-02 UTC."],[],[]]
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