.TH "GCLOUD_FIRESTORE_DATABASES_CONNECTION\-STRING" 1



.SH "NAME"
.HP
gcloud firestore databases connection\-string \- prints the mongo connection string for the given Firestore database



.SH "SYNOPSIS"
.HP
\f5gcloud firestore databases connection\-string\fR \fB\-\-database\fR=\fIDATABASE\fR [\fB\-\-auth\fR=\fIAUTH\fR;\ default="none"\ |\ \fB\-\-validate\fR=\fIVALIDATE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "EXAMPLES"

To get the connection string for a Firestore database with a databaseId
\f5testdb\fR without auth configuration.

.RS 2m
$ gcloud firestore databases connection\-string \-\-database=testdb \e
  \-\-auth=none
.RE

To get the connection string for a Firestore database with a databaseId
\f5testdb\fR with Google Compute Engine VM auth.

.RS 2m
$ gcloud firestore databases connection\-string \-\-database=testdb \e
  \-\-auth=gce\-vm
.RE



.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-database\fR=\fIDATABASE\fR

The database to operate on.

For example, to operate on database \f5foo\fR:

.RS 2m
$ gcloud firestore databases connection\-string \-\-database='foo'
.RE


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-auth\fR=\fIAUTH\fR; default="none"

The auth configuration for the connection string.

If connecting from a Google Compute Engine VM, use \f5gce\-vm\fR. For short term
access using the gcloud CLI's access token, use \f5access\-token\fR. For
password auth use scram\-sha\-256. Otherwise, use \f5none\fR and configure auth
manually.

\fIAUTH\fR must be one of: \fBnone\fR, \fBgce\-vm\fR, \fBaccess\-token\fR,
\fBscram\-sha\-256\fR.

.TP 2m
\fB\-\-validate\fR=\fIVALIDATE\fR

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.


.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha firestore databases connection\-string
.RE

.RS 2m
$ gcloud beta firestore databases connection\-string
.RE