gcloud: Wed Apr 16 10:41:40 UTC 2025

gcloud/alpha/firestore/databases/connection-string

@@ -0,0 +1,56 @@
+NAME
+    gcloud alpha firestore databases connection-string - prints the mongo
+        connection string for the given Firestore database
+
+SYNOPSIS
+    gcloud alpha firestore databases connection-string --database=DATABASE
+        [--auth=AUTH; default="none"] [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To get the connection string for a Firestore database with a databaseId
+    testdb without auth configuration.
+
+        $ gcloud alpha firestore databases connection-string \
+          --database=testdb --auth=none
+
+    To get the connection string for a Firestore database with a databaseId
+    testdb with Google Compute Engine VM auth.
+
+        $ gcloud alpha firestore databases connection-string \
+          --database=testdb --auth=gce-vm
+
+REQUIRED FLAGS
+     --database=DATABASE
+        The database to operate on.
+
+        For example, to operate on database foo:
+
+            $ gcloud alpha firestore databases connection-string --database='foo'
+
+OPTIONAL FLAGS
+     --auth=AUTH; default="none"
+        The auth configuration for the connection string.
+
+        If connecting from a Google Compute Engine VM, use gce-vm. For short
+        term access using the gcloud CLI's access token, use access-token. For
+        password auth use scram-sha-256. Otherwise, use none and configure auth
+        manually.
+
+        AUTH must be one of: none, gce-vm, access-token, scram-sha-256.
+
+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 databases connection-string
+

gcloud/alpha/firestore/databases/create

@@ -5,10 +5,17 @@ NAME
 SYNOPSIS
     gcloud alpha firestore databases create --location=LOCATION
         [--database=DATABASE; default="(default)"] [--delete-protection]
-        [--enable-pitr] [--kms-key-name=KMS_KEY_NAME]
-        [--type=TYPE; default="firestore-native"] [GCLOUD_WIDE_FLAG ...]
+        [--edition=EDITION; default="standard"] [--enable-pitr]
+        [--kms-key-name=KMS_KEY_NAME] [--type=TYPE; default="firestore-native"]
+        [GCLOUD_WIDE_FLAG ...]
 
 EXAMPLES
+    To create a Firestore Enterprise database named foo in nam5 for use with
+    Ignite APIs.
+
+        $ gcloud alpha firestore databases create --database=foo \
+          --edition=enterprise --location=nam5
+
     To create a Firestore Native database in nam5.
 
         $ gcloud alpha firestore databases create --location=nam5
@@ -72,6 +79,10 @@ OPTIONAL FLAGS
 
         Default to false.
 
+     --edition=EDITION; default="standard"
+        The edition of the database. EDITION must be one of: standard,
+        enterprise.
+
      --enable-pitr
         Whether to enable Point In Time Recovery (PITR) on the created
         database.

gcloud/alpha/firestore/databases/help

@@ -16,6 +16,10 @@ GCLOUD WIDE FLAGS
 COMMANDS
     COMMAND is one of the following:
 
+     connection-string
+        (ALPHA) Prints the mongo connection string for the given Firestore
+        database.
+
      create
         (ALPHA) Create a Google Cloud Firestore database via Firestore API.
 

gcloud/alpha/firestore/help

@@ -41,6 +41,9 @@ GROUPS
      operations
         (ALPHA) Manage Long Running Operations for Cloud Firestore.
 
+     user-creds
+        (ALPHA) Manage the user creds for a Cloud Firestore Database.
+
 COMMANDS
     COMMAND is one of the following:
 

gcloud/alpha/firestore/indexes/composite/create

@@ -8,6 +8,7 @@ SYNOPSIS
           [field-path=FIELD-PATH],[order=ORDER],[vector-config=VECTOR-CONFIG]
         (--collection-group=COLLECTION_GROUP : --database=DATABASE)
         [--api-scope=API_SCOPE; default="any-api"] [--async]
+        [--density=DENSITY] [--multikey]
         [--query-scope=QUERY_SCOPE; default="collection"]
         [GCLOUD_WIDE_FLAG ...]
 
@@ -103,12 +104,25 @@ REQUIRED FLAGS
 OPTIONAL FLAGS
      --api-scope=API_SCOPE; default="any-api"
         Api scope the index applies to. API_SCOPE must be one of: any-api,
-        datastore-mode-api.
+        datastore-mode-api, mongodb-compatible-api.
 
      --async
         Return immediately, without waiting for the operation in progress to
         complete.
 
+     --density=DENSITY
+        Density of the index. DENSITY must be one of: dense,
+        density-unspecified, sparse-all, sparse-any.
+
+     --multikey
+        Optional. Whether the index is multikey. By default, the index is not
+        multikey. For non-multikey indexes, none of the paths in the index
+        definition reach or traverse an array, except via an explicit array
+        index. For multikey indexes, at most one of the paths in the index
+        definition reach or traverse an array, except via an explicit array
+        index. Violations will result in errors. Note this field only applies
+        to index with MONGODB_COMPATIBLE_API ApiScope.
+
      --query-scope=QUERY_SCOPE; default="collection"
         Query scope the index applies to. QUERY_SCOPE must be one of:
         collection, collection-group, collection-recursive.

gcloud/alpha/firestore/user-creds/create

@@ -0,0 +1,46 @@
+NAME
+    gcloud alpha firestore user-creds create - creates a Cloud Firestore user
+        creds
+
+SYNOPSIS
+    gcloud alpha firestore user-creds create USER_CREDS --database=DATABASE
+        [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To create a user creds called test-user-creds-id under database testdb.
+
+        $ gcloud alpha firestore user-creds create test-user-creds-id \
+          --database=testdb
+
+POSITIONAL ARGUMENTS
+     USER_CREDS
+        The user creds to operate on.
+
+        For example, to operate on user creds creds-name-1:
+
+            $ gcloud alpha firestore user-creds create creds-name-1
+
+REQUIRED FLAGS
+     --database=DATABASE
+        The database to operate on.
+
+        For example, to operate on database foo:
+
+            $ gcloud alpha firestore user-creds create --database='foo'
+
+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 user-creds create
+

gcloud/alpha/firestore/user-creds/delete

@@ -0,0 +1,46 @@
+NAME
+    gcloud alpha firestore user-creds delete - deletes a Cloud Firestore user
+        creds
+
+SYNOPSIS
+    gcloud alpha firestore user-creds delete USER_CREDS --database=DATABASE
+        [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To delete user creds 'test-user-creds-id' under database testdb.
+
+        $ gcloud alpha firestore user-creds delete test-user-creds-id \
+          --database='testdb'
+
+POSITIONAL ARGUMENTS
+     USER_CREDS
+        The user creds to operate on.
+
+        For example, to operate on user creds creds-name-1:
+
+            $ gcloud alpha firestore user-creds delete creds-name-1
+
+REQUIRED FLAGS
+     --database=DATABASE
+        The database to operate on.
+
+        For example, to operate on database foo:
+
+            $ gcloud alpha firestore user-creds delete --database='foo'
+
+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 user-creds delete
+

gcloud/alpha/firestore/user-creds/describe

@@ -0,0 +1,46 @@
+NAME
+    gcloud alpha firestore user-creds describe - describes a Cloud Firestore
+        user creds
+
+SYNOPSIS
+    gcloud alpha firestore user-creds describe USER_CREDS --database=DATABASE
+        [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To describe user creds 'test-user-creds-id' under database testdb.
+
+        $ gcloud alpha firestore user-creds describe test-user-creds-id \
+          --database='testdb'
+
+POSITIONAL ARGUMENTS
+     USER_CREDS
+        The user creds to operate on.
+
+        For example, to operate on user creds creds-name-1:
+
+            $ gcloud alpha firestore user-creds describe creds-name-1
+
+REQUIRED FLAGS
+     --database=DATABASE
+        The database to operate on.
+
+        For example, to operate on database foo:
+
+            $ gcloud alpha firestore user-creds describe --database='foo'
+
+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 user-creds describe
+

gcloud/alpha/firestore/user-creds/disable

@@ -0,0 +1,46 @@
+NAME
+    gcloud alpha firestore user-creds disable - disables a Cloud Firestore user
+        creds
+
+SYNOPSIS
+    gcloud alpha firestore user-creds disable USER_CREDS --database=DATABASE
+        [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To disable user creds 'test-user-creds-id' under database testdb.
+
+        $ gcloud alpha firestore user-creds disable test-user-creds-id \
+          --database='testdb'
+
+POSITIONAL ARGUMENTS
+     USER_CREDS
+        The user creds to operate on.
+
+        For example, to operate on user creds creds-name-1:
+
+            $ gcloud alpha firestore user-creds disable creds-name-1
+
+REQUIRED FLAGS
+     --database=DATABASE
+        The database to operate on.
+
+        For example, to operate on database foo:
+
+            $ gcloud alpha firestore user-creds disable --database='foo'
+
+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 user-creds disable
+

gcloud/alpha/firestore/user-creds/enable

@@ -0,0 +1,46 @@
+NAME
+    gcloud alpha firestore user-creds enable - enables a Cloud Firestore user
+        creds
+
+SYNOPSIS
+    gcloud alpha firestore user-creds enable USER_CREDS --database=DATABASE
+        [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To enable user creds 'test-user-creds-id' under database testdb.
+
+        $ gcloud alpha firestore user-creds enable test-user-creds-id \
+          --database='testdb'
+
+POSITIONAL ARGUMENTS
+     USER_CREDS
+        The user creds to operate on.
+
+        For example, to operate on user creds creds-name-1:
+
+            $ gcloud alpha firestore user-creds enable creds-name-1
+
+REQUIRED FLAGS
+     --database=DATABASE
+        The database to operate on.
+
+        For example, to operate on database foo:
+
+            $ gcloud alpha firestore user-creds enable --database='foo'
+
+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 user-creds enable
+

gcloud/alpha/firestore/user-creds/help

@@ -0,0 +1,47 @@
+NAME
+    gcloud alpha firestore user-creds - manage the user creds for a Cloud
+        Firestore Database
+
+SYNOPSIS
+    gcloud alpha firestore user-creds COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Manage the user creds for a Cloud Firestore Database.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --help.
+
+    Run $ gcloud help for details.
+
+COMMANDS
+    COMMAND is one of the following:
+
+     create
+        (ALPHA) Creates a Cloud Firestore user creds.
+
+     delete
+        (ALPHA) Deletes a Cloud Firestore user creds.
+
+     describe
+        (ALPHA) Describes a Cloud Firestore user creds.
+
+     disable
+        (ALPHA) Disables a Cloud Firestore user creds.
+
+     enable
+        (ALPHA) Enables a Cloud Firestore user creds.
+
+     list
+        (ALPHA) Lists user creds under a Cloud Firesore database.
+
+     reset-password
+        (ALPHA) Resets a Cloud Firestore user creds.
+
+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 user-creds
+

gcloud/alpha/firestore/user-creds/list

@@ -0,0 +1,70 @@
+NAME
+    gcloud alpha firestore user-creds list - lists user creds under a Cloud
+        Firesore database
+
+SYNOPSIS
+    gcloud alpha firestore user-creds list --database=DATABASE
+        [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
+        [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To list all user creds under database testdb.
+
+        $ gcloud alpha firestore user-creds list --database='testdb'
+
+REQUIRED FLAGS
+     --database=DATABASE
+        The database to operate on.
+
+        For example, to operate on database foo:
+
+            $ gcloud alpha firestore user-creds list --database='foo'
+
+LIST COMMAND FLAGS
+     --filter=EXPRESSION
+        Apply a Boolean filter EXPRESSION to each resource item to be listed.
+        If the expression evaluates True, then that item is listed. For more
+        details and examples of filter expressions, run $ gcloud topic filters.
+        This flag interacts with other flags that are applied in this order:
+        --flatten, --sort-by, --filter, --limit.
+
+     --limit=LIMIT
+        Maximum number of resources to list. The default is unlimited. This
+        flag interacts with other flags that are applied in this order:
+        --flatten, --sort-by, --filter, --limit.
+
+     --page-size=PAGE_SIZE
+        Some services group resource list output into pages. This flag
+        specifies the maximum number of resources per page. The default is
+        determined by the service if it supports paging, otherwise it is
+        unlimited (no paging). Paging may be applied before or after --filter
+        and --limit depending on the service.
+
+     --sort-by=[FIELD,...]
+        Comma-separated list of resource field key names to sort by. The
+        default order is ascending. Prefix a field with ``~'' for descending
+        order on that field. This flag interacts with other flags that are
+        applied in this order: --flatten, --sort-by, --filter, --limit.
+
+     --uri
+        Print a list of resource URIs instead of the default output, and change
+        the command output to a list of URIs. If this flag is used with
+        --format, the formatting is applied on this URI list. To display URIs
+        alongside other keys instead, use the uri() transform.
+
+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 user-creds list
+

gcloud/alpha/firestore/user-creds/reset-password

@@ -0,0 +1,47 @@
+NAME
+    gcloud alpha firestore user-creds reset-password - resets a Cloud Firestore
+        user creds
+
+SYNOPSIS
+    gcloud alpha firestore user-creds reset-password USER_CREDS
+        --database=DATABASE [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To reset password for user creds 'test-user-creds-id' under database
+    testdb.
+
+        $ gcloud alpha firestore user-creds reset-password \
+          test-user-creds-id --database='testdb'
+
+POSITIONAL ARGUMENTS
+     USER_CREDS
+        The user creds to operate on.
+
+        For example, to operate on user creds creds-name-1:
+
+            $ gcloud alpha firestore user-creds reset-password creds-name-1
+
+REQUIRED FLAGS
+     --database=DATABASE
+        The database to operate on.
+
+        For example, to operate on database foo:
+
+            $ gcloud alpha firestore user-creds reset-password --database='foo'
+
+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 user-creds reset-password
+