- 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, useaccess-token
. For password auth use scram-sha-256. Otherwise, usenone
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 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-04-15 UTC.