backups

Creates, updates, deletes, gets or lists a backups resource.

Overview

Name	backups
Type	Resource
Id	google.spanner.backups

Fields

The following fields are returned by SELECT queries:

projects_instances_backups_get

Successful response

Name	Datatype	Description
name	string	Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form projects//instances//backups/a-z*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form projects//instances/.
backupSchedules	array	Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.
createTime	string (google-datetime)	Output only. The time the CreateBackup request is received. If the request does not specify version_time, the version_time of the backup will be equivalent to the create_time.
database	string	Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects//instances//databases/.
databaseDialect	string	Output only. The database dialect information for the backup.
encryptionInfo	object	Encryption information for a Cloud Spanner database or backup. (id: EncryptionInfo)
encryptionInformation	array	Output only. The encryption information for the backup, whether it is protected by one or more KMS keys. The information includes all Cloud KMS key versions used to encrypt the backup. The encryption_status field inside of each EncryptionInfo is not populated. At least one of the key versions must be available for the backup to be restored. If a key version is revoked in the middle of a restore, the restore behavior is undefined.
exclusiveSizeBytes	string (int64)	Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field.
expireTime	string (google-datetime)	Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.
freeableSizeBytes	string (int64)	Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired.
incrementalBackupChainId	string	Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup version_time.
instancePartitions	array	Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's version_time.
maxExpireTime	string (google-datetime)	Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than Backup.max_expire_time.
oldestVersionTime	string (google-datetime)	Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.
referencingBackups	array	Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form projects//instances//backups/. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed.
referencingDatabases	array	Output only. The names of the restored databases that reference the backup. The database names are of the form projects//instances//databases/. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the READY state, the reference to the backup is removed.
sizeBytes	string (int64)	Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the exclusive_size_bytes of itself and all older backups in the chain.
state	string	Output only. The current state of the backup.
versionTime	string (google-datetime)	The backup will contain an externally consistent copy of the database at the timestamp specified by version_time. If version_time is not specified, the system will set version_time to the create_time of the backup.

projects_instances_backups_list

Successful response

Name	Datatype	Description
name	string	Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form projects//instances//backups/a-z*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form projects//instances/.
backupSchedules	array	Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.
createTime	string (google-datetime)	Output only. The time the CreateBackup request is received. If the request does not specify version_time, the version_time of the backup will be equivalent to the create_time.
database	string	Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects//instances//databases/.
databaseDialect	string	Output only. The database dialect information for the backup.
encryptionInfo	object	Encryption information for a Cloud Spanner database or backup. (id: EncryptionInfo)
encryptionInformation	array	Output only. The encryption information for the backup, whether it is protected by one or more KMS keys. The information includes all Cloud KMS key versions used to encrypt the backup. The encryption_status field inside of each EncryptionInfo is not populated. At least one of the key versions must be available for the backup to be restored. If a key version is revoked in the middle of a restore, the restore behavior is undefined.
exclusiveSizeBytes	string (int64)	Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field.
expireTime	string (google-datetime)	Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.
freeableSizeBytes	string (int64)	Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired.
incrementalBackupChainId	string	Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup version_time.
instancePartitions	array	Output only. The instance partition(s) storing the backup. This is the same as the list of the instance partition(s) that the database had footprint in at the backup's version_time.
maxExpireTime	string (google-datetime)	Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than Backup.max_expire_time.
oldestVersionTime	string (google-datetime)	Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.
referencingBackups	array	Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form projects//instances//backups/. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed.
referencingDatabases	array	Output only. The names of the restored databases that reference the backup. The database names are of the form projects//instances//databases/. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the READY state, the reference to the backup is removed.
sizeBytes	string (int64)	Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the exclusive_size_bytes of itself and all older backups in the chain.
state	string	Output only. The current state of the backup.
versionTime	string (google-datetime)	The backup will contain an externally consistent copy of the database at the timestamp specified by version_time. If version_time is not specified, the system will set version_time to the create_time of the backup.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_instances_backups_get	select	projectsId, instancesId, backupsId		Gets metadata on a pending or completed Backup.
projects_instances_backups_list	select	projectsId, instancesId	filter, pageSize, pageToken	Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.
projects_instances_backups_create	insert	projectsId, instancesId	backupId, encryptionConfig.encryptionType, encryptionConfig.kmsKeyName, encryptionConfig.kmsKeyNames	Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format projects//instances//backups//operations/ and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.
projects_instances_backups_patch	update	projectsId, instancesId, backupsId	updateMask	Updates a pending or completed Backup.
projects_instances_backups_delete	delete	projectsId, instancesId, backupsId		Deletes a pending or completed Backup.
projects_instances_backups_copy	exec	projectsId, instancesId		Starts copying a Cloud Spanner Backup. The returned backup long-running operation will have a name of the format projects//instances//backups//operations/ and can be used to track copying of the backup. The operation is associated with the destination backup. The metadata field type is CopyBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the copying and delete the destination backup. Concurrent CopyBackup requests can run on the same source backup.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
backupsId	string
instancesId	string
projectsId	string
backupId	string
encryptionConfig.encryptionType	string
encryptionConfig.kmsKeyName	string
encryptionConfig.kmsKeyNames	string
filter	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_instances_backups_get

Gets metadata on a pending or completed Backup.

SELECT
name,
backupSchedules,
createTime,
database,
databaseDialect,
encryptionInfo,
encryptionInformation,
exclusiveSizeBytes,
expireTime,
freeableSizeBytes,
incrementalBackupChainId,
instancePartitions,
maxExpireTime,
oldestVersionTime,
referencingBackups,
referencingDatabases,
sizeBytes,
state,
versionTime
FROM google.spanner.backups
WHERE projectsId = '{{ projectsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND backupsId = '{{ backupsId }}' -- required;

projects_instances_backups_list

Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.

SELECT
name,
backupSchedules,
createTime,
database,
databaseDialect,
encryptionInfo,
encryptionInformation,
exclusiveSizeBytes,
expireTime,
freeableSizeBytes,
incrementalBackupChainId,
instancePartitions,
maxExpireTime,
oldestVersionTime,
referencingBackups,
referencingDatabases,
sizeBytes,
state,
versionTime
FROM google.spanner.backups
WHERE projectsId = '{{ projectsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_instances_backups_create

Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format projects//instances//backups//operations/ and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

INSERT INTO google.spanner.backups (
data__database,
data__versionTime,
data__expireTime,
data__name,
projectsId,
instancesId,
backupId,
encryptionConfig.encryptionType,
encryptionConfig.kmsKeyName,
encryptionConfig.kmsKeyNames
)
SELECT 
'{{ database }}',
'{{ versionTime }}',
'{{ expireTime }}',
'{{ name }}',
'{{ projectsId }}',
'{{ instancesId }}',
'{{ backupId }}',
'{{ encryptionConfig.encryptionType }}',
'{{ encryptionConfig.kmsKeyName }}',
'{{ encryptionConfig.kmsKeyNames }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: backups
  props:
    - name: projectsId
      value: string
      description: Required parameter for the backups resource.
    - name: instancesId
      value: string
      description: Required parameter for the backups resource.
    - name: database
      value: string
      description: >
        Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`.
        
    - name: versionTime
      value: string
      description: >
        The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup.
        
    - name: expireTime
      value: string
      description: >
        Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.
        
    - name: name
      value: string
      description: >
        Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.
        
    - name: backupId
      value: string
    - name: encryptionConfig.encryptionType
      value: string
    - name: encryptionConfig.kmsKeyName
      value: string
    - name: encryptionConfig.kmsKeyNames
      value: string

UPDATE examples

projects_instances_backups_patch

Updates a pending or completed Backup.

UPDATE google.spanner.backups
SET 
data__database = '{{ database }}',
data__versionTime = '{{ versionTime }}',
data__expireTime = '{{ expireTime }}',
data__name = '{{ name }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND backupsId = '{{ backupsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
backupSchedules,
createTime,
database,
databaseDialect,
encryptionInfo,
encryptionInformation,
exclusiveSizeBytes,
expireTime,
freeableSizeBytes,
incrementalBackupChainId,
instancePartitions,
maxExpireTime,
oldestVersionTime,
referencingBackups,
referencingDatabases,
sizeBytes,
state,
versionTime;

DELETE examples

projects_instances_backups_delete

Deletes a pending or completed Backup.

DELETE FROM google.spanner.backups
WHERE projectsId = '{{ projectsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND backupsId = '{{ backupsId }}' --required;

Lifecycle Methods

projects_instances_backups_copy

Starts copying a Cloud Spanner Backup. The returned backup long-running operation will have a name of the format projects//instances//backups//operations/ and can be used to track copying of the backup. The operation is associated with the destination backup. The metadata field type is CopyBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the copying and delete the destination backup. Concurrent CopyBackup requests can run on the same source backup.

EXEC google.spanner.backups.projects_instances_backups_copy 
@projectsId='{{ projectsId }}' --required, 
@instancesId='{{ instancesId }}' --required 
@@json=
'{
"backupId": "{{ backupId }}", 
"sourceBackup": "{{ sourceBackup }}", 
"expireTime": "{{ expireTime }}", 
"encryptionConfig": "{{ encryptionConfig }}"
}';