Skip to main content

backups

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

Overview​

Namebackups
TypeResource
Idgoogle.bigtableadmin.backups

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringA globally unique identifier for the backup which cannot be changed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9* The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form projects/{project}/instances/{instance}/clusters/{cluster}.
backupTypestringIndicates the backup type of the backup.
encryptionInfoobjectEncryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status. (id: EncryptionInfo)
endTimestring (google-datetime)Output only. end_time is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
expireTimestring (google-datetime)Required. The expiration time of the backup. When creating a backup or updating its expire_time, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the expire_time has passed, Cloud Bigtable will delete the backup.
hotToStandardTimestring (google-datetime)The time at which the hot backup will be converted to a standard backup. Once the hot_to_standard_time has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.
sizeBytesstring (int64)Output only. Size of the backup in bytes.
sourceBackupstringOutput only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/
sourceTablestringRequired. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects/{project}/instances/{instance}/tables/{source_table}.
startTimestring (google-datetime)Output only. start_time is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
statestringOutput only. The current state of the backup.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, instancesId, clustersId, backupsIdGets metadata on a pending or completed Cloud Bigtable Backup.
listselectprojectsId, instancesId, clustersIdfilter, orderBy, pageSize, pageTokenLists Cloud Bigtable backups. Returns both completed and pending backups.
createinsertprojectsId, instancesId, clustersIdbackupIdStarts creating a new Cloud Bigtable Backup. The returned backup long-running operation 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.
patchupdateprojectsId, instancesId, clustersId, backupsIdupdateMaskUpdates a pending or completed Cloud Bigtable Backup.
deletedeleteprojectsId, instancesId, clustersId, backupsIdDeletes a pending or completed Cloud Bigtable backup.
copyexecprojectsId, instancesId, clustersIdCopy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

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.

NameDatatypeDescription
backupsIdstring
clustersIdstring
instancesIdstring
projectsIdstring
backupIdstring
filterstring
orderBystring
pageSizeinteger (int32)
pageTokenstring
updateMaskstring (google-fieldmask)

SELECT examples​

Gets metadata on a pending or completed Cloud Bigtable Backup.

SELECT
name,
backupType,
encryptionInfo,
endTime,
expireTime,
hotToStandardTime,
sizeBytes,
sourceBackup,
sourceTable,
startTime,
state
FROM google.bigtableadmin.backups
WHERE projectsId = '{{ projectsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND clustersId = '{{ clustersId }}' -- required
AND backupsId = '{{ backupsId }}' -- required;

INSERT examples​

Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation 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.

INSERT INTO google.bigtableadmin.backups (
data__name,
data__sourceTable,
data__expireTime,
data__backupType,
data__hotToStandardTime,
projectsId,
instancesId,
clustersId,
backupId
)
SELECT 
'{{ name }}',
'{{ sourceTable }}',
'{{ expireTime }}',
'{{ backupType }}',
'{{ hotToStandardTime }}',
'{{ projectsId }}',
'{{ instancesId }}',
'{{ clustersId }}',
'{{ backupId }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples​

Updates a pending or completed Cloud Bigtable Backup.

UPDATE google.bigtableadmin.backups
SET 
data__name = '{{ name }}',
data__sourceTable = '{{ sourceTable }}',
data__expireTime = '{{ expireTime }}',
data__backupType = '{{ backupType }}',
data__hotToStandardTime = '{{ hotToStandardTime }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND backupsId = '{{ backupsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
backupType,
encryptionInfo,
endTime,
expireTime,
hotToStandardTime,
sizeBytes,
sourceBackup,
sourceTable,
startTime,
state;

DELETE examples​

Deletes a pending or completed Cloud Bigtable backup.

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

Lifecycle Methods​

Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

EXEC google.bigtableadmin.backups.copy 
@projectsId='{{ projectsId }}' --required, 
@instancesId='{{ instancesId }}' --required, 
@clustersId='{{ clustersId }}' --required 
@@json=
'{
"backupId": "{{ backupId }}", 
"sourceBackup": "{{ sourceBackup }}", 
"expireTime": "{{ expireTime }}"
}';