1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-10 03:16:46 +00:00
gcloud-help/gcloud/firestore/databases/create

92 lines
3.1 KiB
Text
Raw Normal View History

2022-03-01 04:29:52 +00:00
NAME
2023-04-20 10:38:56 +00:00
gcloud firestore databases create - create a Google Cloud Firestore
database via Firestore API
2022-03-01 04:29:52 +00:00
SYNOPSIS
2023-04-20 10:38:56 +00:00
gcloud firestore databases create --location=LOCATION
2024-01-10 10:17:49 +00:00
[--database=DATABASE; default="(default)"] [--delete-protection]
[--enable-pitr] [--type=TYPE; default="firestore-native"]
[GCLOUD_WIDE_FLAG ...]
2022-03-01 04:29:52 +00:00
EXAMPLES
2023-05-04 10:43:54 +00:00
To create a Firestore Native database in nam5.
2022-03-01 04:29:52 +00:00
2023-04-20 10:38:56 +00:00
$ gcloud firestore databases create --location=nam5
2022-03-01 04:29:52 +00:00
2023-05-04 10:43:54 +00:00
To create a Datastore Mode database in us-east1.
2022-03-01 04:29:52 +00:00
2023-04-20 10:38:56 +00:00
$ gcloud firestore databases create --location=us-east1 \
--type=datastore-mode
2022-08-10 08:48:58 +00:00
2023-05-04 10:43:54 +00:00
To create a Datastore Mode database in us-east1 with a databaseId foo.
2022-08-10 08:48:58 +00:00
2023-05-04 10:43:54 +00:00
$ gcloud firestore databases create --database=foo \
2023-04-20 10:38:56 +00:00
--location=us-east1 --type=datastore-mode
2022-03-01 04:29:52 +00:00
2024-01-10 10:17:49 +00:00
To create a Firestore Native database in nam5 with delete protection
enabled.
$ gcloud firestore databases create --location=nam5 \
--delete-protection
2023-10-11 10:37:28 +00:00
To create a Firestore Native database in nam5 with Point In Time Recovery
(PITR) enabled.
$ gcloud firestore databases create --location=nam5 --enable-pitr
2023-04-20 10:38:56 +00:00
REQUIRED FLAGS
2023-04-12 10:43:12 +00:00
--location=LOCATION
2023-06-08 11:29:23 +00:00
The location to operate on. Available locations are listed at
2023-04-12 10:43:12 +00:00
https://cloud.google.com/firestore/docs/locations.
2023-06-08 11:29:23 +00:00
For example, to operate on location us-east1:
$ gcloud firestore databases create --location='us-east1'
2023-04-20 10:38:56 +00:00
OPTIONAL FLAGS
--database=DATABASE; default="(default)"
The ID to use for the database, which will become the final component
of the database's resource name. If database ID is not provided,
(default) will be used as database ID.
This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/
with first character a letter and the last a letter or a number. Must
not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.
Using "(default)" database ID is also allowed.
2023-04-12 10:43:12 +00:00
2024-01-10 10:17:49 +00:00
--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 delete operations will fail unless delete protection is disabled.
Default to false.
2023-10-11 10:37:28 +00:00
--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,
this feature is not enabled.
2023-04-20 10:38:56 +00:00
--type=TYPE; default="firestore-native"
The type of the database. TYPE must be one of: firestore-native,
datastore-mode.
2022-03-01 04:29:52 +00:00
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 help for details.
NOTES
These variants are also available:
$ gcloud alpha firestore databases create
$ gcloud beta firestore databases create