Skip to main content

backups

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

Overview

Namebackups
TypeResource
Idgoogle.firestore.backups

Fields

NameDatatypeDescription
namestringOutput only. The unique resource name of the Backup. Format is projects/{project}/locations/{location}/backups/{backup}.
databasestringOutput only. Name of the Firestore database that the backup is from. Format is projects/{project}/databases/{database}.
databaseUidstringOutput only. The system-generated UUID4 for the Firestore database that the backup is from.
expireTimestringOutput only. The timestamp at which this backup expires.
snapshotTimestringOutput only. The backup contains an externally consistent copy of the database at this time.
statestringOutput only. The current state of the backup.
statsobjectBackup specific statistics.

Methods

NameAccessible byRequired ParamsDescription
getSELECTbackupsId, locationsId, projectsIdGets information about a backup.
listSELECTlocationsId, projectsIdLists all the backups.
deleteDELETEbackupsId, locationsId, projectsIdDeletes a backup.

SELECT examples

Lists all the backups.

SELECT
name,
database,
databaseUid,
expireTime,
snapshotTime,
state,
stats
FROM google.firestore.backups
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified backups resource.

/*+ delete */
DELETE FROM google.firestore.backups
WHERE backupsId = '{{ backupsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';