terraform-google-modules /terraform-google-sql-db

Creates a Cloud SQL database instance

★ 298⑂ 489👁 35⑃ 573● 308▤ 81
Download: v28.3.1v28.3.1 ↓28.3.12026-11-09
+0
Daily
298
stars
489
forks
35
watchers
573
prs
308
issues
81
releases

README

terraform-google-sql

terraform-google-sql makes it easy to create Google CloudSQL instance and implement high availability settings.
This module consists of the following submodules:

- mssql
- mysql
- postgresql

See more details in each module's README.

 Compatibility
This module is meant for use with Terraform 1.3+ and tested using Terraform 1.6+.
If you find incompatibilities using Terraform =1.13, please open an issue.

 Upgrading

The current version is 26.X. The following guides are available to assist with upgrades:

- 1.X - 2.0
- 2.X - 3.0
- 3.X - 4.0
- 10.X - 11.0
- 11.X - 12.0
- 13.X - 14.0
- 14.X - 15.0
- 16.X - 17.0
- 19.X - 20.0
- 20.X - 21.0
- 21.X - 22.0
- 22.X - 23.0
- 23.X - 24.0
- 25.X - 26.0

 Root module

The root module has been deprecated. Please switch to using one of the submodules.

 Requirements

 Installation Dependencies

- Terraform = 1.3.0
- terraform-provider-google plugin v5.12+
- Terraform Provider Beta for GCP plugin v5.12+

 Configure a Service Account

In order to execute this module you must have a Service Account with the following:

 Roles

- Cloud SQL Admin: roles/cloudsql.admin
- Compute Network Admin: roles/compute.networkAdmin

 Enable APIs

In order to operate with the Service Account you must activate the following APIs on the project where the Service Account was created:

- Cloud SQL Admin API: sqladmin.googleapis.com

In order to use Private Service Access, required for using Private IPs, you must activate
the following APIs on the project where your VPC resides:

- Cloud SQL Admin API: sqladmin.googleapis.com
- Compute Engine API: compute.googleapis.com
- Service Networking API: servicenetworking.googleapis.com
- Cloud Resource Manager API: cloudresourcemanager.googleapis.com

 Service Account Credentials

You can pass the service account credentials into this module by setting the following environment variables:

 GOOGLE_CREDENTIALS
 GOOGLE_CLOUD_KEYFILE_JSON
 GCLOUD_KEYFILE_JSON

See more details.

 Provision Instructions

This module has no root configuration. A module with no root configuration cannot be used directly.

Copy and paste into your Terraform configuration, insert the variables, and run terraform init :

For MySQL :

module "sql-db" {
  source  = "GoogleCloudPlatform/sql-db/google//modules/mysql"
  version = "~ 28.3"
}


or for PostgreSQL :


module "sql-db" {
  source  = "GoogleCloudPlatform/sql-db/google//modules/postgresql"
  version = "~ 22.0"
}


or for MSSQL Server :


module "sql-db" {
  source  = "GoogleCloudPlatform/sql-db/google//modules/mssql"
  version = "~ 22.0"
}



 Contributing

Refer to the contribution guidelines for
information on contributing to this module.

Top issues

Latest release

v28.3.1 v28.3.1 2026-11-09
28.3.1 (2026-11-09)


 Bug Fixes

 populate null defaultValue in mysql blueprint metadata (862) (501e225)
 populate null defaultValue in postgresql blueprint metadata (863) (5178f82)

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON