- NAME
-
- gcloud beta firestore databases connection-string - prints the mongo connection string for the given Firestore database
- SYNOPSIS
-
-
gcloud beta firestore databases connection-string--database=DATABASE[--auth=AUTH; default="none" |--validate=VALIDATE] [GCLOUD_WIDE_FLAG …]
-
- EXAMPLES
-
To get the connection string for a Firestore database with a databaseId
testdbwithout auth configuration.gcloud beta firestore databases connection-string --database=testdb --auth=noneTo get the connection string for a Firestore database with a databaseId
testdbwith Google Compute Engine VM auth.gcloud beta 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 beta firestore databases connection-string --database='foo'
- OPTIONAL FLAGS
-
-
At most one of these can be specified:
--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, useaccess-token. For password auth use scram-sha-256. Otherwise, usenoneand configure auth manually.AUTHmust be one of:none,gce-vm,access-token,scram-sha-256. --validate=VALIDATE- Validate the specified connection string for the current database. This command checks that the connection string is well formed, contains the required parameters, and specifies correct configuration values for the current database.
-
At most one of these can be specified:
- 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 helpfor details. - NOTES
-
This command is currently in beta and might change without notice. These
variants are also available:
gcloud firestore databases connection-stringgcloud alpha firestore databases connection-string
gcloud beta firestore databases connection-string
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 2025-08-19 UTC.