Delete backup

Delete a database backup.

Explore further

For detailed documentation that includes this code sample, see the following:

Manage backups

Code sample

C++

To learn how to install and use the client library for Spanner, see Spanner client libraries .

To authenticate to Spanner, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  void 
  
 DeleteBackup 
 ( 
 google 
 :: 
 cloud 
 :: 
 spanner_admin 
 :: 
 DatabaseAdminClient 
  
 client 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 project_id 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 instance_id 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 backup_id 
 ) 
  
 { 
  
 google 
 :: 
 cloud 
 :: 
 spanner 
 :: 
 Backup 
  
 backup 
 ( 
  
 google 
 :: 
 cloud 
 :: 
 spanner 
 :: 
 Instance 
 ( 
 project_id 
 , 
  
 instance_id 
 ), 
  
 backup_id 
 ); 
  
 auto 
  
 status 
  
 = 
  
 client 
 . 
 DeleteBackup 
 ( 
 backup 
 . 
 FullName 
 ()); 
  
 if 
  
 ( 
 ! 
 status 
 . 
 ok 
 ()) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 status 
 ); 
  
 std 
 :: 
 cout 
 << 
 "Backup " 
 << 
 backup 
 . 
 FullName 
 () 
 << 
 " was deleted. 
 \n 
 " 
 ; 
 }

C#

To learn how to install and use the client library for Spanner, see Spanner client libraries .

To authenticate to Spanner, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  using 
  
  Google.Cloud.Spanner.Admin.Database.V1 
 
 ; 
 using 
  
 System 
 ; 
 public 
  
 class 
  
 DeleteBackupSample 
 { 
  
 public 
  
 void 
  
 DeleteBackup 
 ( 
 string 
  
 projectId 
 , 
  
 string 
  
 instanceId 
 , 
  
 string 
  
 backupId 
 ) 
  
 { 
  
 // Create the DatabaseAdminClient instance. 
  
  DatabaseAdminClient 
 
  
 databaseAdminClient 
  
 = 
  
  DatabaseAdminClient 
 
 . 
  Create 
 
 (); 
  
 // Make the DeleteBackup request. 
  
  BackupName 
 
  
 backupName 
  
 = 
  
  BackupName 
 
 . 
  FromProjectInstanceBackup 
 
 ( 
 projectId 
 , 
  
 instanceId 
 , 
  
 backupId 
 ); 
  
 databaseAdminClient 
 . 
  DeleteBackup 
 
 ( 
 backupName 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 "Backup deleted successfully." 
 ); 
  
 } 
 }

Go

To learn how to install and use the client library for Spanner, see Spanner client libraries .

To authenticate to Spanner, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 "regexp" 
  
 database 
  
 "cloud.google.com/go/spanner/admin/database/apiv1" 
  
 adminpb 
  
 "cloud.google.com/go/spanner/admin/database/apiv1/databasepb" 
 ) 
 func 
  
 deleteBackup 
 ( 
 ctx 
  
 context 
 . 
 Context 
 , 
  
 w 
  
 io 
 . 
 Writer 
 , 
  
 db 
 , 
  
 backupID 
  
 string 
 ) 
  
 error 
  
 { 
  
 adminClient 
 , 
  
 err 
  
 := 
  
 database 
 . 
 NewDatabaseAdminClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 err 
  
 } 
  
 defer 
  
 adminClient 
 . 
  Close 
 
 () 
  
 matches 
  
 := 
  
 regexp 
 . 
 MustCompile 
 ( 
 "^(.*)/databases/(.*)$" 
 ). 
 FindStringSubmatch 
 ( 
 db 
 ) 
  
 if 
  
 matches 
  
 == 
  
 nil 
  
 || 
  
 len 
 ( 
 matches 
 ) 
  
 != 
  
 3 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Invalid database id %s" 
 , 
  
 db 
 ) 
  
 } 
  
 backupName 
  
 := 
  
 matches 
 [ 
 1 
 ] 
  
 + 
  
 "/backups/" 
  
 + 
  
 backupID 
  
 // Delete the backup. 
  
 err 
  
 = 
  
 adminClient 
 . 
 DeleteBackup 
 ( 
 ctx 
 , 
  
& adminpb 
 . 
 DeleteBackupRequest 
 { 
 Name 
 : 
  
 backupName 
 }) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 err 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Deleted backup %s\n" 
 , 
  
 backupID 
 ) 
  
 return 
  
 nil 
 }

Java

To learn how to install and use the client library for Spanner, see Spanner client libraries .

To authenticate to Spanner, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  static 
  
 void 
  
 deleteBackup 
 ( 
 DatabaseAdminClient 
  
 dbAdminClient 
 , 
  
 String 
  
 project 
 , 
  
 String 
  
 instance 
 , 
  
 String 
  
 backupId 
 ) 
  
 { 
  
 BackupName 
  
 backupName 
  
 = 
  
 BackupName 
 . 
 of 
 ( 
 project 
 , 
  
 instance 
 , 
  
 backupId 
 ); 
  
 // Delete the backup. 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Deleting backup [" 
  
 + 
  
 backupId 
  
 + 
  
 "]..." 
 ); 
  
 dbAdminClient 
 . 
 deleteBackup 
 ( 
 backupName 
 ); 
  
 // Verify that the backup is deleted. 
  
 try 
  
 { 
  
 dbAdminClient 
 . 
 getBackup 
 ( 
 backupName 
 ); 
  
 } 
  
 catch 
  
 ( 
 NotFoundException 
  
 e 
 ) 
  
 { 
  
 if 
  
 ( 
 e 
 . 
 getStatusCode 
 (). 
 getCode 
 () 
  
 == 
  
 Code 
 . 
 NOT_FOUND 
 ) 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Deleted backup [" 
  
 + 
  
 backupId 
  
 + 
  
 "]" 
 ); 
  
 } 
  
 else 
  
 { 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Delete backup [" 
  
 + 
  
 backupId 
  
 + 
  
 "] failed" 
 ); 
  
 throw 
  
 new 
  
 RuntimeException 
 ( 
 "Delete backup [" 
  
 + 
  
 backupId 
  
 + 
  
 "] failed" 
 , 
  
 e 
 ); 
  
 } 
  
 } 
 }

Node.js

To learn how to install and use the client library for Spanner, see Spanner client libraries .

To authenticate to Spanner, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  // Imports the Google Cloud client library 
 const 
  
 { 
 Spanner 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/spanner 
' 
 ); 
 /** 
 * TODO(developer): Uncomment the following lines before running the sample. 
 */ 
 // const projectId = 'my-project-id'; 
 // const instanceId = 'my-instance'; 
 // const databaseId = 'my-database'; 
 // const backupId = 'my-backup'; 
 // Creates a client 
 const 
  
 spanner 
  
 = 
  
 new 
  
  Spanner 
 
 ({ 
  
 projectId 
 : 
  
 projectId 
 , 
 }); 
 // Gets a reference to a Cloud Spanner Database Admin Client object 
 const 
  
 databaseAdminClient 
  
 = 
  
 spanner 
 . 
  getDatabaseAdminClient 
 
 (); 
 // Delete the backup 
 console 
 . 
 log 
 ( 
 `Deleting backup 
 ${ 
 backupId 
 } 
 .` 
 ); 
 await 
  
 databaseAdminClient 
 . 
 deleteBackup 
 ({ 
  
 name 
 : 
  
 databaseAdminClient 
 . 
  backupPath 
 
 ( 
 projectId 
 , 
  
 instanceId 
 , 
  
 backupId 
 ), 
 }); 
 console 
 . 
 log 
 ( 
 'Backup deleted.' 
 ); 
 // Verify backup no longer exists 
 try 
  
 { 
  
 await 
  
 databaseAdminClient 
 . 
 getBackup 
 ({ 
  
 name 
 : 
  
 databaseAdminClient 
 . 
  backupPath 
 
 ( 
 projectId 
 , 
  
 instanceId 
 , 
  
 backupId 
 ), 
  
 }); 
  
 console 
 . 
 error 
 ( 
 'Error: backup still exists.' 
 ); 
 } 
  
 catch 
  
 ( 
 err 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 'Backup deleted.' 
 ); 
 }

PHP

To learn how to install and use the client library for Spanner, see Spanner client libraries .

To authenticate to Spanner, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  use Google\Cloud\Spanner\Admin\Database\V1\Client\DatabaseAdminClient; 
 use Google\Cloud\Spanner\Admin\Database\V1\DeleteBackupRequest; 
 /** 
 * Delete a backup. 
 * Example: 
 * ``` 
 * delete_backup($projectId, $instanceId, $backupId); 
 * ``` 
 * @param string $projectId The Google Cloud project ID. 
 * @param string $instanceId The Spanner instance ID. 
 * @param string $backupId The Spanner backup ID. 
 */ 
 function delete_backup(string $projectId, string $instanceId, string $backupId): void 
 { 
 $databaseAdminClient = new DatabaseAdminClient(); 
 $backupName = DatabaseAdminClient::backupName($projectId, $instanceId, $backupId); 
 $request = new DeleteBackupRequest(); 
 $request->setName($backupName); 
 $databaseAdminClient->deleteBackup($request); 
 print("Backup $backupName deleted" . PHP_EOL); 
 }

Python

To learn how to install and use the client library for Spanner, see Spanner client libraries .

To authenticate to Spanner, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  def 
  
 delete_backup 
 ( 
 instance_id 
 , 
 backup_id 
 ): 
 from 
  
 google.cloud.spanner_admin_database_v1.types 
  
 import 
 backup 
 as 
 backup_pb 
 spanner_client 
 = 
 spanner 
 . 
 Client 
 () 
 database_admin_api 
 = 
 spanner_client 
 . 
 database_admin_api 
 backup 
 = 
 database_admin_api 
 . 
 get_backup 
 ( 
 backup_pb 
 . 
 GetBackupRequest 
 ( 
 name 
 = 
 database_admin_api 
 . 
 backup_path 
 ( 
 spanner_client 
 . 
 project 
 , 
 instance_id 
 , 
 backup_id 
 ), 
 ) 
 ) 
 # Wait for databases that reference this backup to finish optimizing. 
 while 
 backup 
 . 
 referencing_databases 
 : 
 time 
 . 
 sleep 
 ( 
 30 
 ) 
 backup 
 = 
 database_admin_api 
 . 
 get_backup 
 ( 
 backup_pb 
 . 
 GetBackupRequest 
 ( 
 name 
 = 
 database_admin_api 
 . 
 backup_path 
 ( 
 spanner_client 
 . 
 project 
 , 
 instance_id 
 , 
 backup_id 
 ), 
 ) 
 ) 
 # Delete the backup. 
 database_admin_api 
 . 
 delete_backup 
 ( 
 backup_pb 
 . 
 DeleteBackupRequest 
 ( 
 name 
 = 
 backup 
 . 
 name 
 )) 
 # Verify that the backup is deleted. 
 try 
 : 
 backup 
 = 
 database_admin_api 
 . 
 get_backup 
 ( 
 backup_pb 
 . 
 GetBackupRequest 
 ( 
 name 
 = 
 backup 
 . 
 name 
 ) 
 ) 
 except 
 NotFound 
 : 
 print 
 ( 
 "Backup 
 {} 
 has been deleted." 
 . 
 format 
 ( 
 backup 
 . 
 name 
 )) 
 return

Ruby

To learn how to install and use the client library for Spanner, see Spanner client libraries .

To authenticate to Spanner, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  # project_id  = "Your Google Cloud project ID" 
 # instance_id = "Your Spanner instance ID" 
 # backup_id = "Your Spanner backup ID" 
 require 
  
 "google/cloud/spanner" 
 require 
  
 "google/cloud/spanner/admin/database" 
 database_admin_client 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
 Spanner 
 :: 
 Admin 
 :: 
 Database 
 . 
 database_admin 
 instance_path 
  
 = 
  
 database_admin_client 
 . 
 instance_path 
  
 project 
 : 
  
 project_id 
 , 
  
 instance 
 : 
  
 instance_id 
 backup_path 
  
 = 
  
 database_admin_client 
 . 
 backup_path 
  
 project 
 : 
  
 project_id 
 , 
  
 instance 
 : 
  
 instance_id 
 , 
  
 backup 
 : 
  
 backup_id 
 database_admin_client 
 . 
 delete_backup 
  
 name 
 : 
  
 backup_path 
 puts 
  
 "Backup 
 #{ 
 backup_id 
 } 
 deleted"

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .

Delete backup Stay organized with collections Save and categorize content based on your preferences.

Explore further

Code sample

C++

C#

Go

Java

Node.js

PHP

Python

Ruby

What's next

Delete backup