Class Backup (7.0.0)

The Backup class represents a Cloud Spanner backup.

Create aBackup object to interact with or create a Cloud Spanner backup or copy a backup.

Package

Example

const{Spanner}=require('@google-cloud/spanner');constspanner=newSpanner();constinstance=spanner.instance('my-instance');constbackup=instance.backup('my-backup');

*@exampleconst{Spanner}=require('@google-cloud/spanner');constspanner=newSpanner();constinstance=spanner.instance('my-instance');constsourceBackup=instance.backup('my-source-backup');constcopyBackup=instance.copyBackup('my-copy-backup','my-source-backup');

Constructors

(constructor)(instance, name, sourceName)

constructor(instance:Instance,name:string,sourceName?:string);

Constructs a new instance of theBackup class

Parameters
Name	Description
`instance`	`Instance`
`name`	`string`
`sourceName`	`string`

Properties

formattedName_

formattedName_:string;

id

id:string;

instanceFormattedName_

instanceFormattedName_:string;

metadata

metadata?:databaseAdmin.spanner.admin.database.v1.IBackup;

request

request:BackupRequest;

resourceHeader_

resourceHeader_:{[k:string]:string;};

sourceName

sourceName:string|undefined;

Methods

create(options)

create(options:CreateBackupOptions|CopyBackupOptions):Promise<CreateBackupResponse>|Promise<CopyBackupResponse>;

Create a backup.

Backup#create

Parameter
Name	Description
`options`	`CreateBackupOptions \|CopyBackupOptions` Parameters for creating a backup.

Returns

Type Description

Promise<CreateBackupResponse> |Promise<CopyBackupResponse>

{Promise

Example

const{Spanner}=require('@google-cloud/spanner');constspanner=newSpanner();constinstance=spanner.instance('my-instance');constoneDay=1000*60*60*24;constexpireTime=Date.now()+oneDay;constversionTime=Date.now()-oneDay;constbackup=instance.backup('my-backup');const[,backupOperation]=awaitbackup.create({databasePath:'projects/my-project/instances/my-instance/databases/my-database',expireTime:expireTime,versionTime:versionTime,encryptionConfig:{encryptionType:'CUSTOMER_MANAGED_ENCRYPTION',kmsKeyName:'projects/my-project-id/my-region/keyRings/my-key-ring/cryptoKeys/my-key',},});// Await completion of the backup operation.awaitbackupOperation.promise();

create(options, callback)

create(options:CreateBackupOptions|CopyBackupOptions,callback:CreateBackupCallback|CopyBackupCallback):void;

Parameters
Name	Description
`options`	`CreateBackupOptions \|CopyBackupOptions`
`callback`	`CreateBackupCallback \|CopyBackupCallback`

Returns
Type	Description
`void`

delete(gaxOptions)

delete(gaxOptions?:CallOptions):Promise<databaseAdmin.protobuf.IEmpty>;

Deletes a backup.

Backup#delete

Parameter
Name	Description
`gaxOptions`	`CallOptions` Request configuration options, SeeCallOptions for more details.

Returns

Type Description

Promise<databaseAdmin.protobuf.IEmpty>

{Promise

Example

const{Spanner}=require('@google-cloud/spanner');constspanner=newSpanner();constinstance=spanner.instance('my-instance');constbackup=instance.backup('my-backup');awaitbackup.delete();

delete(callback)

delete(callback:DeleteCallback):void;

Parameter
Name	Description
`callback`	`DeleteCallback`

Returns
Type	Description
`void`

delete(gaxOptions, callback)

delete(gaxOptions:CallOptions,callback:DeleteCallback):void;

Parameters
Name	Description
`gaxOptions`	`CallOptions`
`callback`	`DeleteCallback`

Returns
Type	Description
`void`

exists()

exists():Promise<boolean>;

Checks whether the backup exists.

Returns

Type Description

Promise<boolean>

{Promise

Example

const{Spanner}=require('@google-cloud/spanner');constspanner=newSpanner();constinstance=spanner.instance('my-instance');constbackup=instance.backup('my-backup');constalreadyExists=awaitbackup.exists();console.log(`Does backup exist?${alreadyExists}`);

exists(callback)

exists(callback:ExistsCallback):void;

Parameter
Name	Description
`callback`	`ExistsCallback`

Returns
Type	Description
`void`

formatName_(instanceName, name)

staticformatName_(instanceName:string,name:string):string;

Format the backup name to include the instance name.

Parameters
Name	Description
`instanceName`	`string` The formatted instance name.
`name`	`string` The table name.

Returns
Type	Description
`string`	{string}

Example

Backup.formatName_('projects/grape-spaceship-123/instances/my-instance','my-backup');// 'projects/grape-spaceship-123/instances/my-instance/backups/my-backup'

getExpireTime()

getExpireTime():Promise<PreciseDate|undefined>;

Retrieves the expiry time of the backup.

Returns
Type	Description
`Promise<PreciseDate \| undefined>`	{Promise<external:PreciseDate>} When resolved, contains the current expire time of the backup if it exists.

Example

const{Spanner}=require('@google-cloud/spanner');constspanner=newSpanner();constinstance=spanner.instance('my-instance');constbackup=instance.backup('my-backup');constexpireTime=awaitbackup.getExpireTime();console.log(`Backup expires on${expireTime.toISOString()}`);

getExpireTime(callback)

getExpireTime(callback:GetExpireTimeCallback):void;

Parameter
Name	Description
`callback`	`GetExpireTimeCallback`

Returns
Type	Description
`void`

getMetadata(gaxOptions)

getMetadata(gaxOptions?:CallOptions):Promise<GetMetadataResponse>;

Retrieves backup's metadata.

Parameter
Name	Description
`gaxOptions`	`CallOptions` Request configuration options, SeeCallOptions for more details.

Returns

Type Description

Promise<GetMetadataResponse>

{Promise

Example

const{Spanner}=require('@google-cloud/spanner');constspanner=newSpanner();constinstance=spanner.instance('my-instance');constbackup=instance.backup('my-backup');const[backupInfo]=awaitbackup.getMetadata();console.log(`${backupInfo.name}: size=${backupInfo.sizeBytes}`);

getMetadata(callback)

getMetadata(callback:GetMetadataCallback):void;

Parameter
Name	Description
`callback`	`GetMetadataCallback`

Returns
Type	Description
`void`

getMetadata(gaxOptions, callback)

getMetadata(gaxOptions:CallOptions,callback:GetMetadataCallback):void;

Parameters
Name	Description
`gaxOptions`	`CallOptions`
`callback`	`GetMetadataCallback`

Returns
Type	Description
`void`

getState()

getState():Promise<EnumKey<typeofdatabaseAdmin.spanner.admin.database.v1.Backup.State>|undefined|null>;

Retrieves the state of the backup.

The backup state indicates if the backup has completed.

Returns
Type	Description
`Promise<EnumKey<typeofdatabaseAdmin.spanner.admin.database.v1.Backup.State> \| undefined \| null>`	{Promise<EnumKey<typeof, databaseAdmin.spanner.admin.database.v1.Backup.State> \| undefined>} When resolved, contains the current state of the backup if it exists.

Example

const{Spanner}=require('@google-cloud/spanner');constspanner=newSpanner();constinstance=spanner.instance('my-instance');constbackup=instance.backup('my-backup');conststate=awaitbackup.getState();constbackupCompleted=(state==='READY');

getState(callback)

getState(callback:GetStateCallback):void;

Parameter
Name	Description
`callback`	`GetStateCallback`

Returns
Type	Description
`void`

updateExpireTime(expireTime)

updateExpireTime(expireTime:string|number|p.ITimestamp|PreciseDate):Promise<databaseAdmin.spanner.admin.database.v1.IBackup>;

Sets the expiry time of a backup.

Parameter
Name	Description
`expireTime`	`string \| number \|common.ITimestamp \|PreciseDate` The expiry time to update with.

Returns
Type	Description
`Promise<databaseAdmin.spanner.admin.database.v1.IBackup>`	{Promise<google.spanner.admin.database.v1.IBackup>} When resolved, the backup's expire time will have been updated.

Example

const{Spanner}=require('@google-cloud/spanner');constspanner=newSpanner();constinstance=spanner.instance('my-instance');constbackup=instance.backup('my-backup');constoneDay=1000*60*60*24;constnewExpireTime=Spanner.timestamp(Date.now()+oneDay);awaitbackup.updateExpireTime(newExpireTime);

updateExpireTime(expireTime, gaxOptions)

updateExpireTime(expireTime:string|number|p.ITimestamp|PreciseDate,gaxOptions?:CallOptions):Promise<databaseAdmin.spanner.admin.database.v1.IBackup>;

Parameters
Name	Description
`expireTime`	`string \| number \|common.ITimestamp \|PreciseDate`
`gaxOptions`	`CallOptions`

Returns
Type	Description
`Promise<databaseAdmin.spanner.admin.database.v1.IBackup>`

updateExpireTime(expireTime, callback)

updateExpireTime(expireTime:string|number|p.ITimestamp|PreciseDate,callback:UpdateExpireTimeCallback):void;

Parameters
Name	Description
`expireTime`	`string \| number \|common.ITimestamp \|PreciseDate`
`callback`	`UpdateExpireTimeCallback`

Returns
Type	Description
`void`

updateExpireTime(expireTime, gaxOptions, callback)

updateExpireTime(expireTime:string|number|p.ITimestamp|PreciseDate,gaxOptions:CallOptions,callback:UpdateExpireTimeCallback):void;

Parameters
Name	Description
`expireTime`	`string \| number \|common.ITimestamp \|PreciseDate`
`gaxOptions`	`CallOptions`
`callback`	`UpdateExpireTimeCallback`

Returns
Type	Description
`void`

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.

Movatterモバイル変換

Class Backup (7.0.0) Stay organized with collections Save and categorize content based on your preferences.

Package

Example

Constructors

(constructor)(instance, name, sourceName)

Properties

formattedName_

id

instanceFormattedName_

metadata

request

resourceHeader_

sourceName

Methods

create(options)

create(options, callback)

delete(gaxOptions)

delete(callback)

delete(gaxOptions, callback)

exists()

exists(callback)

formatName_(instanceName, name)

getExpireTime()

getExpireTime(callback)

getMetadata(gaxOptions)

getMetadata(callback)

getMetadata(gaxOptions, callback)

getState()

getState(callback)

updateExpireTime(expireTime)

updateExpireTime(expireTime, gaxOptions)

updateExpireTime(expireTime, callback)

updateExpireTime(expireTime, gaxOptions, callback)

Class Backup (7.0.0)