gcloud firestore backups schedules create Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud firestore backups schedules create - creates a Cloud Firestore backup schedule
- SYNOPSIS
gcloud firestore backups schedules create--database=DATABASE--retention=RETENTION(--recurrence=RECURRENCE:--day-of-week=DAY_OF_WEEK)[GCLOUD_WIDE_FLAG …]
- EXAMPLES
- To create a backup schedule with 7 days retention and daily recurrence underdatabase testdb.
gcloudfirestorebackupsschedulescreate--database=testdb--retention=7d--recurrence=dailyTo create a backup schedule with 7 days retention and weekly recurrence onMonday under database testdb.
gcloudfirestorebackupsschedulescreate--database=testdb--retention=7d--recurrence=weekly--day-of-week=MON - REQUIRED FLAGS
--database=DATABASE- The database to operate on.
For example, to operate on database
foo:gcloudfirestorebackupsschedulescreate--database='foo' --retention=RETENTION- The rention of the backup. At what relative time in the future, compared to thecreation time of the backup should the backup be deleted, i.e. keep backups for7 days.
For example, to set retention as 7 days.
gcloudfirestorebackupsschedulescreate--retention=7d - Recurrence settings of a backup schedule.
This must be specified.
--recurrence=RECURRENCE- The recurrence settings of a backup schedule.
Currently only daily and weekly backup schedules are supported.
When a weekly backup schedule is created, day-of-week is needed.
For example, to create a weekly backup schedule which creates backups on Monday.
gcloudfirestorebackupsschedulescreate--recurrence=weekly--day-of-week=MONThis flag argument must be specified if any of the other arguments in this groupare specified.
--day-of-week=DAY_OF_WEEK- The day of week (UTC time zone) of when backups are created.
Theavailablevaluesare:`MON`,`TUE`,`WED`,`THU`,`FRI`,`SAT`,`SUN`.Valuesarecaseinsensitive.
Thisisrequiredwhencreatingaweeklybackupschedule.
DAY_OF_WEEKmust be one of:SUN,MON,TUE,WED,THU,FRI,SAT.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$gcloud helpfor details. - NOTES
- These variants are also available:
gcloudalphafirestorebackupsschedulescreategcloudbetafirestorebackupsschedulescreate
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-07-22 UTC.