gcloud beta firestore databases create Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta firestore databases create - create a Google Cloud Firestore database via Firestore API
- SYNOPSIS
gcloud beta firestore databases create--location=LOCATION[--database=DATABASE; default="(default)"][--delete-protection][--edition=EDITION; default="standard"][--enable-pitr][--kms-key-name=KMS_KEY_NAME][--tags=[KEY=VALUE,…]][--type=TYPE; default="firestore-native"][GCLOUD_WIDE_FLAG …]
- EXAMPLES
- To create a Firestore Enterprise database named
fooinnam5for use with MongoDB Compatibility.gcloudbetafirestoredatabasescreate--database=foo--edition=enterprise--location=nam5To create a Firestore Native database in
nam5.gcloudbetafirestoredatabasescreate--location=nam5To create a Firestore Native database in
us-central1with tags.gcloudbetafirestoredatabasescreate--location=us-central1--tags=key1=value1,key2=value2To create a Datastore Mode database in
us-east1.gcloudbetafirestoredatabasescreate--location=us-east1--type=datastore-modeTo create a Datastore Mode database in
us-east1with a databaseIdfoo.gcloudbetafirestoredatabasescreate--database=foo--location=us-east1--type=datastore-modeTo create a Firestore Native database in
nam5with deleteprotection enabled.gcloudbetafirestoredatabasescreate--location=nam5--delete-protectionTo create a Firestore Native database in
nam5with Point In TimeRecovery (PITR) enabled.gcloudbetafirestoredatabasescreate--location=nam5--enable-pitrTo create a Firestore Native database in
nam5encrypted by aCustomer-managed encryption key (CMEK).gcloudbetafirestoredatabasescreate--location=nam5--kms-key-name=projects/PROJECT_ID/locations/us/keyRings/KEY_RING_ID/cryptoKeys/CRYPTO_KEY_ID - REQUIRED FLAGS
--location=LOCATION- The location to operate on. Available locations are listed athttps://cloud.google.com/firestore/docs/locations.
For example, to operate on location
us-east1:gcloudbetafirestoredatabasescreate--location='us-east1'
- OPTIONAL FLAGS
--database=DATABASE; default="(default)"- The ID to use for the database, which will become the final component of thedatabase's resource name. If database ID is not provided, (default) will be usedas database ID.
This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ withfirst character a letter and the last a letter or a number. Must not beUUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.
Using "(default)" database ID is also allowed.
--delete-protection- Whether to enable delete protection on the created database.
If set to true, delete protection of the new database will be enabled and deleteoperations will fail unless delete protection is disabled.
Default to false.
--edition=EDITION; default="standard"- The edition of the database.
EDITIONmust be one of:standard,enterprise. --enable-pitr- Whether to enable Point In Time Recovery (PITR) on the created database.
If set to true, PITR on the new database will be enabled. By default, thisfeature is not enabled.
--kms-key-name=KMS_KEY_NAME- The resource ID of a Cloud KMS key. If set, the database created will be aCustomer-Managed Encryption Key (CMEK) database encrypted with this key. Thisfeature is allowlist only in initial launch.
Only a key in the same location as this database is allowed to be used forencryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMSlocation us. For Firestore's eur3 multi-region, this corresponds to Cloud KMSlocation europe. Seehttps://cloud.google.com/kms/docs/locations.
This value should be the KMS key resource ID in the format of
projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.How to retrieve this resource ID is listed athttps://cloud.google.com/kms/docs/getting-resource-ids#getting_the_id_for_a_key_and_version. --tags=[KEY=VALUE,…]- Tags to attach to the destination database. Example:--tags=key1=value1,key2=value2
For example, to attach tags to a database:
$ --tags=key1=value1,key2=value2
--type=TYPE; default="firestore-native"- The type of the database.
TYPEmust be one of:firestore-native,datastore-mode.
- 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
- This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudfirestoredatabasescreategcloudalphafirestoredatabasescreate
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-15 UTC.