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

gcloud/beta/firestore/bulk-delete

@@ -0,0 +1,70 @@
+NAME
+    gcloud beta firestore bulk-delete - bulk delete Cloud Firestore documents
+
+SYNOPSIS
+    gcloud beta firestore bulk-delete [--async]
+        [--collection-ids=[COLLECTION_IDS,...]]
+        [--database=DATABASE; default="(default)"]
+        [--namespace-ids=[NAMESPACE_IDS,...]] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) bulk delete Cloud Firestore documents.
+
+EXAMPLES
+    To bulk delete a specific set of collections groups asynchronously, run:
+
+        $ gcloud beta firestore bulk-delete \
+            --collection-ids='specific collection group1','specific
+         collection group2' --async
+
+    To bulk delete all collection groups from certain namespace, run:
+
+        $ gcloud beta 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 beta 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 beta 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 beta 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 beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha firestore bulk-delete
+

gcloud/beta/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
+        (BETA) bulk delete Cloud Firestore documents.
+
      export
         (BETA) export Cloud Firestore documents to Google Cloud Storage.
 

gcloud/beta/firestore/indexes/composite/create

@@ -5,7 +5,7 @@ NAME
 SYNOPSIS
     gcloud beta firestore indexes composite create
         --field-config=[array-config=ARRAY-CONFIG],
-          [field-path=FIELD-PATH],[order=ORDER]
+          [field-path=FIELD-PATH],[order=ORDER],[vector-config=VECTOR-CONFIG]
         (--collection-group=COLLECTION_GROUP : --database=DATABASE)
         [--api-scope=API_SCOPE; default="any-api"] [--async]
         [--query-scope=QUERY_SCOPE; default="collection"]
@@ -30,31 +30,43 @@ EXAMPLES
             --field-config=field-path=timestamp,order=descending
 
 REQUIRED FLAGS
-     --field-config=[array-config=ARRAY-CONFIG],[field-path=FIELD-PATH],[order=ORDER]
-        Configuration for a field.
+     --field-config=[array-config=ARRAY-CONFIG],[field-path=FIELD-PATH],[order=ORDER],[vector-config=VECTOR-CONFIG]
+        Required, Configuration for an index field.
 
-        This flag must be repeated to provide the ordered list of field
-        configurations comprising the composite index. For example:
-
-            $ gcloud beta firestore indexes composite create \
-                --collection-group=Events \
-                --field-config field-path=tags,array-config=contains \
-                --field-config field-path=user_id,order=descending \
-                --field-config field-path=timestamp,order=descending
-
-        The following keys are allowed:
+         array-config
+            Specifies the configuration for an array field. The only valid
+            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.
+            Specifies the order. Valid options are 'ascending', 'descending'.
+            Exactly one of 'order', 'array-config', or 'vector-config' must be
+            specified.
 
-         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.
+         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.
+
+             flat
+                Sets flat value.
+
+        Shorthand Example:
+
+            --field-config='array-config=string,field-path=string,order=string,vector-config={"dimension": int, "flat": {"string"}}' --field-config='array-config=string,field-path=string,order=string,vector-config={"dimension": int, "flat": {"string"}}'
+
+        JSON Example:
+
+            --field-config='[{"array-config": "string", "field-path": "string", "order": "string", "vector-config": {"dimension": int, "flat": {"string"}}}]'
+
+        File Example:
+
+            --field-config=path_to_file.(yaml|json)
 
      Collection group resource - Collection group of the index. The arguments
      in this group can be used to specify the attributes of this resource.