This page describes how to schedule and turn off automatic backups, create and manage on-demand backups, and view backups for your Cloud SQL instance.
For more information about how backups work, see Overview of backups.
Create an on-demand backup
To create an on-demand backup:
Console
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- Select Backups from the SQL navigation menu.
- Click Create backup.
- On the Create backup page, add a description, if needed, and click Create.
gcloud
Create the backup:
gcloud sql backups create \ --async \ --instance=INSTANCE_NAME
You can provide a description of the backup using the --description
parameter.
To create a backup in a custom location:
gcloud sql backups create \ --async \ --instance=INSTANCE_NAME \ --location=BACKUP_LOCATION
REST v1
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-id: The instance ID
HTTP method and URL:
POST https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id/backupRuns
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
REST v1beta4
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-id: The instance ID
HTTP method and URL:
POST https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id/backupRuns
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
Schedule automated backups
To schedule automated backups for an instance:
Console
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- Select Backups from the SQL navigation menu.
- Click Edit, next to Settings.
- Choose a window of time for your data to be automatically backed up.
- Click Save.
gcloud
-
Edit the instance to specify a backup start time:
Thegcloud sql instances patch INSTANCE_NAME --backup-start-time=HH:MM
backup-start-time
parameter is specified in a 24-hour time format, in the UTC±00 time zone, and specifies the start of a 4-hour backup window. Backups can start any time during the backup window. -
Confirm your changes:
In thegcloud sql instances describe INSTANCE_NAME
backupConfiguration
section, confirm that you seeenabled: true
and the time that you specified.
Terraform
To create a backup for a database, use a Terraform resource.
Apply the changes
To apply your Terraform configuration in a Google Cloud project, complete the steps in the following sections.
Prepare Cloud Shell
- Launch Cloud Shell.
-
Set the default Google Cloud project where you want to apply your Terraform configurations.
You only need to run this command once per project, and you can run it in any directory.
export GOOGLE_CLOUD_PROJECT=PROJECT_ID
Environment variables are overridden if you set explicit values in the Terraform configuration file.
Prepare the directory
Each Terraform configuration file must have its own directory (also called a root module).
-
In Cloud Shell, create a directory and a new
file within that directory. The filename must have the
.tf
extension—for examplemain.tf
. In this tutorial, the file is referred to asmain.tf
.mkdir DIRECTORY && cd DIRECTORY && touch main.tf
-
If you are following a tutorial, you can copy the sample code in each section or step.
Copy the sample code into the newly created
main.tf
.Optionally, copy the code from GitHub. This is recommended when the Terraform snippet is part of an end-to-end solution.
- Review and modify the sample parameters to apply to your environment.
- Save your changes.
-
Initialize Terraform. You only need to do this once per directory.
terraform init
Optionally, to use the latest Google provider version, include the
-upgrade
option:terraform init -upgrade
Apply the changes
-
Review the configuration and verify that the resources that Terraform is going to create or
update match your expectations:
terraform plan
Make corrections to the configuration as necessary.
-
Apply the Terraform configuration by running the following command and entering
yes
at the prompt:terraform apply
Wait until Terraform displays the "Apply complete!" message.
- Open your Google Cloud project to view the results. In the Google Cloud console, navigate to your resources in the UI to make sure that Terraform has created or updated them.
Delete the changes
To delete your changes, do the following:
- To disable deletion protection, in your Terraform configuration file set the
deletion_protection
argument tofalse
.deletion_protection = "false"
- Apply the updated Terraform configuration by running the following command and
entering
yes
at the prompt:terraform apply
-
Remove resources previously applied with your Terraform configuration by running the following command and entering
yes
at the prompt:terraform destroy
REST v1
Before using any of the request data, make the following replacements:
- PROJECT_ID: the ID or project number of the Google Cloud project that contains the instance
- INSTANCE_NAME: the name of the primary or read replica instance that you're configuring for high availability
- START_TIME: the time (in hours and minutes)
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME
Request JSON body:
{ "settings": { "backupConfiguration": { "startTime": "START_TIME", "enabled": true, "binaryLogEnabled": true } } }
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
REST v1beta4
Set a custom location for backups
Only use a custom backup location if required by regulation. If not required, use the default multi-region backup location.
You can use a custom location for on-demand and automatic backups. For a complete list of valid location values, see the Instance locations.
To update an instance with a custom location:
Console
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- From the SQL navigation menu, select Backups.
- Next to Settings, click Edit.
- In the Automated Backups section, expand Advanced Options.
- Click Multi-region (default) or Region.
- Select the location from the Location drop-down menu.
- Click Save.
gcloud
For reference information, see gcloud sql instances patch.
gcloud sql instances patch INSTANCE_NAME \ --backup-location=BACKUP_LOCATION
Terraform
To specify a custom location for a database instance backup, use a Terraform resource.
REST v1
Use the instance's
settings.backupConfiguration.location
parameter for the
backup location.
Before using any of the request data, make the following replacements:
- region: The project region
- backup-region: The backup region
- project-id: The project ID
- instance-id: The instance ID
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id
Request JSON body:
{ "region": "region" "settings": { "backupConfiguration": { "location": "backup-region", "enabled": true, } } }
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
REST v1beta4
Use the instance's
settings.backupConfiguration.location
parameter for the
backup location.
Before using any of the request data, make the following replacements:
- region: The project region
- backup-region: The backup region
- project-id: The project ID
- instance-id: The instance ID
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id
Request JSON body:
{ "region": "region" "settings": { "backupConfiguration": { "location": "backup-region", "enabled": true, } } }
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
View a list of backups
To view a list of backups and details about a backup, use the following options.
The Google Cloud console does not show skipped or failed backups in the
backup history. To see skipped backups, use gcloud
or the API.
Console
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- Select Backups from the SQL navigation menu to view recent backups, along with creation time and type of backup.
gcloud
-
List the backups of the instance:
gcloud sql backups list \ --instance INSTANCE_NAME
You can filter and control the results using the standard list parameters. For a complete list, see the gcloud sql backups list command reference page.
-
View the details of a backup by specifying the backup
ID
from the output of thebackups list
command.gcloud sql backups describe BACKUP_ID \ --instance INSTANCE_NAME
REST v1
You can also use the APIs Explorer on the BackupRuns:list page to send the REST API request.Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-id: The instance ID
HTTP method and URL:
GET https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id/backupRuns
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
REST v1beta4
You can also use the APIs Explorer on the BackupRuns:list page to send the REST API request.Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-id: The instance ID
HTTP method and URL:
GET https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id/backupRuns
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
View a list of backups during an outage
When an instance is in a region that is having an outage, you can only view
backups for that instance using a wildcard (-
) with the backupRuns.list
API.
The wildcard returns all backups in the project. See
Restoring to a different instance.
When there's an outage in a region where an instance has customer-managed encryption keys (CMEK) enabled, you can't restore the backups for that instance to a different region. The reason is because Cloud SQL uses regional Cloud KMS keys for encryption when CMEK is enabled on the instance. To restore backups for a CMEK instance, Cloud SQL must have access to the CMEK key. In a regional outage, there's no access to the Cloud KMS keys in that region.
gcloud
-
List the backups for every instance in a project:
gcloud sql backups list --instance -
The command returns information similar to the following:
{ "kind": "sql#backupRun", "status": "SUCCESSFUL", "enqueuedTime": "2020-01-21T11:25:33.818Z", "id": "backup-id", "startTime": "2020-01-21T11:25:33.858Z", "endTime": "2020-01-21T11:26:18.663Z", "type": "AUTOMATED", "windowStartTime": "2020-01-21T10:00:00.479Z", "instance": "instance-id", "selfLink": "https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id/backupRuns/backup-id", "location": "us" "backupKind": "SNAPSHOT" }
- Find the backup for the instance you need. To restore this backup, see Restoring to a different instance.
REST v1
- List all the backups in a project:
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-id: The instance ID, or
-
for a list of all backups in the project
HTTP method and URL:
GET https://sqladmin.googleapis.com/v1/projects/project-id/instances/-/backupRuns
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
- Find the backup for the instance you need. To restore this backup, see Restoring to a different instance.
REST v1beta4
- List all the backups in a project:
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-id: The instance ID, or
-
for a list of all backups in the project
HTTP method and URL:
GET https://sqladmin.googleapis.com/v1beta4/projects/project-id/instances/-/backupRuns
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
- Find the backup for the instance you need. To restore this backup, see Restoring to a different instance.
View backup locations
To see the locations of the backups taken for an instance, use backupRuns
:
Console
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- Select Backups from the SQL navigation menu.
- In the backups list, the Location column lists the type of location (multi-region or region) and the specific multi-region or region for each backup.
gcloud
For reference information, see gcloud sql instances describe.
-
List the backups of the instance:
gcloud sql backups list \ --instance INSTANCE_NAME
You can filter and control the results using the standard list parameters. For a complete list, see the gcloud sql backups list command reference page.
-
To list the details of one backup, use the
ID
from the output of thebackups list
command.gcloud sql backups describe BACKUP_ID \ --instance INSTANCE_NAME
REST v1
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-id: The instance ID
HTTP method and URL:
GET https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id/backupRuns
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
In the previous examples:REGION
is the region for the original instance.BACKUP_LOCATION
is the location where you want Cloud SQL to store the backup.
REST v1beta4
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-id: The instance ID
HTTP method and URL:
GET https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id/backupRuns
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
In the previous examples:REGION
is the region for the original instance.BACKUP_LOCATION
is the location where you want Cloud SQL to store the backup.
Set automated backup retention
To set the number of automated backups to retain:
Console
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- Select Backups from the SQL navigation menu.
- Click Edit.
- In the Automate backups section, expand Advanced options.
-
Enter the Number of backups to store at a time.
The number can't be less than the default (seven).
- Click Save.
gcloud
Edit the instance to set the number of automated backups to retain. The number can't be less than the default (seven).
gcloud sql instances patch INSTANCE_NAME \ --retained-backups-count=NUM_TO_RETAIN
Terraform
To specify the number of automated backups to retain for a database instance, use a Terraform resource.
REST v1beta4
Before using any of the request data, make the following replacements:
- unit: Optional: The retention unit can either be an integer or a string. The currently supported (and default) values are 1 or "COUNT".
- num-to-retain: The number of automated backups to retain. The number can't be less than the default (7).
- project-id: The project ID
- instance-id: The instance ID
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id
Request JSON body:
{ "settings": { "backupConfiguration": { "backupRetentionSettings": { "retentionUnit": unit, "retainedBackups": "num-to-retain" } } } }
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
Delete a backup
You can delete automated and on-demand backups.
Deleting a backup might not free up as much space as the size of the backup. This is because backups are incremental, so deleting an older backup might transfer some of its contents to a more recent backup to preserve the integrity of the newer backup.Console
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- Select Backups from the SQL navigation menu.
- Click more actions for the backup you want to delete.
- Select Delete.
- In the Delete backup window, type
Delete
into the field and click Delete.
gcloud
Delete a backup of a Cloud SQL instance:
gcloud beta sql backups delete BACKUP_ID \ --instance INSTANCE_NAME
For a complete list of parameters, see the gcloud beta sql backups delete command reference page.
REST v1
- List the backups to obtain the ID for the backup you want to delete:
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-id: The instance ID
HTTP method and URL:
GET https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id/backupRuns
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
-
Delete the backup:
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-id: The instance ID
- backup-id: The backup ID
HTTP method and URL:
DELETE https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id/backupRuns/backup-id
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
REST v1beta4
- List the backups to obtain the ID for the backup you want to delete:
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-id: The instance ID
HTTP method and URL:
GET https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id/backupRuns
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
-
Delete the backup:
Before using any of the request data, make the following replacements:
- project-id: The project ID
- instance-id: The instance ID
- backup-id: The backup ID
HTTP method and URL:
DELETE https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id/backupRuns/backup-id
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
Disable automated backups
To disable automated backups for an instance:
Console
-
In the Google Cloud console, go to the Cloud SQL Instances page.
- To open the Overview page of an instance, click the instance name.
- Select Backups from the SQL navigation menu.
- Click Manage automated backups
- Clear Automate backups.
- Click Save.
gcloud
Edit the instance to disable backups:
gcloud sql instances patch INSTANCE_NAME \ --no-backup
REST v1
REST v1beta4
What's next
- Learn more about backing up your data.
- Learn more about restoring data.
- See how to restore your data from a backup.