Cloud SQL Basics
Cloud SQL is a fully managed relational database service for MySQL, PostgreSQL,
and SQL Server. It automates time-consuming tasks like patches, updates,
backups, and replicas, while providing high performance and availability for
your applications.
Prerequisites
Ensure you have the necessary IAM permissions to create and manage Cloud SQL
instances. The Cloud SQL Admin (roles/cloudsql.admin) role provides full
access to Cloud SQL resources.
Quick Start (PostgreSQL)
Enable the API:
gcloud services enable sqladmin.googleapis.com --quiet
Create an Instance:
gcloud sql instances create INSTANCE_NAME \
--database-version=POSTGRES_18 \
--cpu=2 \
--memory=7680MiB \
--region=REGION \
--quiet
Set a password for the default user:
Because this is a Cloud SQL for PostgreSQL instance, the default admin user
is postgres:
gcloud sql users set-password postgres \
--instance=INSTANCE_NAME --password=PASSWORD \
--quiet
Create a database:
gcloud sql databases create DATABASE_NAME \
--instance=INSTANCE_NAME \
--quiet
Get the instance connection name:
You need the instance connection name (which is formatted as
PROJECT_ID:REGION:INSTANCE_NAME) to connect using the Cloud SQL Auth
Proxy. Retrieve it with the following command:
gcloud sql instances describe INSTANCE_NAME \
--format="value(connectionName)" \
--quiet
Connect to the instance:
The Cloud SQL Auth Proxy must be running to be able to connect to the
instance. In a separate terminal, start the proxy using the connection name:
./cloud-sql-proxy INSTANCE_CONNECTION_NAME
With the proxy running, connect using psql in another terminal:
psql "host=127.0.0.1 port=5432 user=postgres dbname=DATABASE_NAME password=PASSWORD sslmode=disable"
Reference Directory
Core Concepts: Cloud SQL editions (Enterprise
& Enterprise Plus), instance architecture, read pools, high availability (HA),
and supported database engines.
CLI Usage: Essential gcloud sql commands for
instance, database, and user management.
Client Libraries & Connectors:
Connecting to Cloud SQL using Python, Java, Node.js, and Go.
MCP Usage: Using the Cloud SQL remote MCP
server and Gemini CLI extension.
Infrastructure as Code: Terraform
configuration for instances, databases, and users.
IAM & Security: Predefined roles, SSL/TLS
certificates, and Auth Proxy configuration.
Disaster Recovery & Backups: Backup types,
Point-in-Time Recovery (PITR), replicas, read pools comparison, and Enterprise Plus Advanced DR.
If you need product information not found in these references, use the
Developer Knowledge MCP server search_documents tool.
1---2name: cloud-sql-basics3description: This file generates or explains Cloud SQL resources. Use this file when the user asks to create a Cloud SQL instance or database for MySQL, PostgreSQL, or SQL Server. Cloud SQL manages third-party MySQL, PostgreSQL, and SQL Server instances as resources in Cloud SQL. For example, when Cloud SQL creates an open-source MySQL instance, the resulting resource is a Cloud SQL for MySQL instance that Google Cloud manages. Cloud SQL handles backups, high availability, and secure connectivity for relational database workloads.4---56# Cloud SQL Basics78Cloud SQL is a fully managed relational database service for MySQL, PostgreSQL,9and SQL Server. It automates time-consuming tasks like patches, updates,10backups, and replicas, while providing high performance and availability for11your applications.1213## Prerequisites1415Ensure you have the necessary IAM permissions to create and manage Cloud SQL16instances. The **Cloud SQL Admin** (`roles/cloudsql.admin`) role provides full17access to Cloud SQL resources.1819## Quick Start (PostgreSQL)20211. **Enable the API:**22 23 ```bash24 gcloud services enable sqladmin.googleapis.com --quiet25 ```26272. **Create an Instance:**28 29 ```bash30 gcloud sql instances create INSTANCE_NAME \31 --database-version=POSTGRES_18 \32 --cpu=2 \33 --memory=7680MiB \34 --region=REGION \35 --quiet36 ```37383. **Set a password for the default user:**3940 Because this is a Cloud SQL for PostgreSQL instance, the default admin user41 is `postgres`:42 43 ```bash44 gcloud sql users set-password postgres \45 --instance=INSTANCE_NAME --password=PASSWORD \46 --quiet47 ```48494. **Create a database:**50 51 ```bash52 gcloud sql databases create DATABASE_NAME \53 --instance=INSTANCE_NAME \54 --quiet55 ```56575. **Get the instance connection name:**5859 You need the instance connection name (which is formatted as60 `PROJECT_ID:REGION:INSTANCE_NAME`) to connect using the Cloud SQL Auth61 Proxy. Retrieve it with the following command:62 63 ```bash64 gcloud sql instances describe INSTANCE_NAME \65 --format="value(connectionName)" \66 --quiet67 ```68696. **Connect to the instance:**7071 The Cloud SQL Auth Proxy must be running to be able to connect to the72 instance. In a separate terminal, start the proxy using the connection name:73 74 ```bash75 ./cloud-sql-proxy INSTANCE_CONNECTION_NAME76 ```7778 With the proxy running, connect using `psql` in another terminal:79 80 ```bash81 psql "host=127.0.0.1 port=5432 user=postgres dbname=DATABASE_NAME password=PASSWORD sslmode=disable"82 ```8384## Reference Directory8586- [Core Concepts](references/core-concepts.md): Cloud SQL editions (Enterprise87 & Enterprise Plus), instance architecture, read pools, high availability (HA),88 and supported database engines.8990- [CLI Usage](references/cli-usage.md): Essential `gcloud sql` commands for91 instance, database, and user management.9293- [Client Libraries & Connectors](references/client-library-usage.md):94 Connecting to Cloud SQL using Python, Java, Node.js, and Go.9596- [MCP Usage](references/mcp-usage.md): Using the Cloud SQL remote MCP97 server and Gemini CLI extension.9899- [Infrastructure as Code](references/iac-usage.md): Terraform100 configuration for instances, databases, and users.101102- [IAM & Security](references/iam-security.md): Predefined roles, SSL/TLS103 certificates, and Auth Proxy configuration.104105- [Disaster Recovery & Backups](references/dr-backups.md): Backup types,106 Point-in-Time Recovery (PITR), replicas, read pools comparison, and Enterprise Plus Advanced DR.107108*If you need product information not found in these references, use the109 Developer Knowledge MCP server `search_documents` tool.*