gcloud: Wed Aug 21 09:39:51 UTC 2024

gcloud/alpha/firestore/bulk-delete

@@ -0,0 +1,72 @@
+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' --async
+
+    To 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 and orders 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 and orders 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
+

gcloud/alpha/firestore/databases/restore

@@ -53,29 +53,30 @@ REQUIRED FLAGS
             cf9f748a-7980-4703-b1a1-d1ffff591db0
 
 OPTIONAL FLAGS
-     The encryption configuration of the restored database. If not specified,
-     the same encryption settings as the backup will be used.
+     The encryption configuration of the new database being created from the
+     backup. If not specified, the same encryption settings as the backup will
+     be used.
 
-     To restore to a CMEK-enabled database:
+     To create a CMEK-enabled database:
 
          $ gcloud alpha firestore databases restore \
              --encryption-type=customer-managed-encryption \
              --kms-key-name=projects/PROJECT_ID/locations/LOCATION_ID/\
          keyRings/KEY_RING_ID/cryptoKeys/CRYPTO_KEY_ID
 
-     To restore to a Google-default-encrypted database:
+     To create a Google-default-encrypted database:
 
          $ gcloud alpha firestore databases restore \
              --encryption-type=google-default-encryption
 
-     To restore to a database using the same encryption settings as the backup:
+     To create a database using the same encryption settings as the backup:
 
          $ gcloud alpha firestore databases restore \
-             --encryption-type=backup-encryption
+             --encryption-type=use-source-encryption
 
        --encryption-type=ENCRYPTION_TYPE
           The encryption type of the destination database. ENCRYPTION_TYPE must
-          be one of: backup-encryption, customer-managed-encryption,
+          be one of: use-source-encryption, customer-managed-encryption,
           google-default-encryption.
 
           This flag argument must be specified if any of the other arguments in

gcloud/alpha/firestore/help

@@ -9,6 +9,8 @@ DESCRIPTION
 
     import -- Import data from Google Cloud Storage
 
+    bulk-delete -- Bulk delete documents from Cloud Firestore
+
     indexes -- Manage your Cloud Firestore indexes
 
     operations -- Manage Long Running Operations for Cloud Firestore
@@ -42,6 +44,9 @@ GROUPS
 COMMANDS
     COMMAND is one of the following:
 
+     bulk-delete
+        (ALPHA) bulk delete Cloud Firestore documents.
+
      export
         (ALPHA) export Cloud Firestore documents to Google Cloud Storage.
 

gcloud/alpha/firestore/indexes/composite/create

@@ -31,22 +31,24 @@ EXAMPLES
 
 REQUIRED FLAGS
      --field-config=[array-config=ARRAY-CONFIG],[field-path=FIELD-PATH],[order=ORDER],[vector-config=VECTOR-CONFIG]
-        Configuration for a field. Required, Configuration for a field.
+        Required, Configuration for an index field.
 
          array-config
             Specifies the configuration for an array field. The only valid
-            option is 'contains'. Exactly one of 'order' or 'array-config' must
-            be specified.
+            option is 'contains'. Exactly one of 'order', 'array-config', or
+            'vector-config' must be specified.
 
          field-path
             Specifies the field path (e.g. 'address.city'). This is required.
 
          order
             Specifies the order. Valid options are 'ascending', 'descending'.
-            Exactly one of order or array-config must be specified.
+            Exactly one of 'order', 'array-config', or 'vector-config' must be
+            specified.
 
          vector-config
-            Specifies the vector config.
+            Specifies the configuration for a vector field. Exactly one of
+            'order', 'array-config', or 'vector-config' must be specified.
 
              dimension
                 Sets dimension value.