- NAME
-
- gcloud alpha firestore bulk-delete - bulk delete Cloud Firestore documents
- SYNOPSIS
-
-
gcloud alpha firestore bulk-delete
[--async
] [--collection-ids
=[COLLECTION_IDS
,…]] [--database
=DATABASE
; default="(default)"] [--namespace-ids
=[NAMESPACE_IDS
,…]] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
bulk delete Cloud Firestore documents. - EXAMPLES
-
To bulk delete a specific set of collections groups asynchronously, run:
gcloud alpha firestore bulk-delete --collection-ids='specific collection group1','specific
collection group2' --asyncTo bulk delete all collection groups from certain namespace, run:
gcloud alpha firestore bulk-delete --namespace-ids='specific namespace id'
- FLAGS
-
--async
- Return immediately, without waiting for the operation in progress to complete.
--collection-ids
=[COLLECTION_IDS
,…]-
List specifying which collections will be included in the operation. When
omitted, all collections are included.
For example, to operate on only the
customers
andorders
collections:gcloud alpha firestore bulk-delete --collection-ids='customers','orders'
--database
=DATABASE
; default="(default)"-
The database to operate on. The default value is
(default)
.For example, to operate on database
foo
:gcloud alpha firestore bulk-delete --database='foo'
--namespace-ids
=[NAMESPACE_IDS
,…]-
List specifying which namespaces will be included in the operation. When
omitted, all namespaces are included.
This is only supported for Datastore Mode databases.
For example, to operate on only the
customers
andorders
namespaces:gcloud alpha firestore bulk-delete --namespaces-ids='customers','orders'
- 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
-
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation-only early access
allowlist. This variant is also available:
gcloud beta firestore bulk-delete
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-20 UTC.