.TH "GCLOUD_ALPHA_SPANNER_CLI" 1



.SH "NAME"
.HP
gcloud alpha spanner cli \- an interactive shell for Spanner



.SH "SYNOPSIS"
.HP
\f5gcloud alpha spanner cli\fR (\fIDATABASE\fR\ :\ \fB\-\-instance\fR=\fIINSTANCE\fR) [\fB\-\-database\-role\fR=\fIDATABASE_ROLE\fR] [\fB\-\-delimiter\fR=\fIDELIMITER\fR;\ default=";"] [\fB\-\-execute\fR=\fIEXECUTE\fR] [\fB\-\-host\fR=\fIHOST\fR;\ default="localhost"] [\fB\-\-html\fR] [\fB\-\-idle\-transaction\-timeout\fR=\fIIDLE_TRANSACTION_TIMEOUT\fR;\ default=60] [\fB\-\-init\-command\fR=\fIINIT_COMMAND\fR] [\fB\-\-init\-command\-add\fR=\fIINIT_COMMAND_ADD\fR] [\fB\-\-port\fR=\fIPORT\fR] [\fB\-\-prompt\fR=\fIPROMPT\fR;\ default="spanner\-cli>\ "] [\fB\-\-skip\-column\-names\fR] [\fB\-\-skip\-system\-command\fR] [\fB\-\-source\fR=\fISOURCE\fR] [\fB\-\-system\-command\fR=\fISYSTEM_COMMAND\fR;\ default="ON"] [\fB\-\-table\fR] [\fB\-\-tee\fR=\fITEE\fR] [\fB\-\-xml\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR An interactive shell for Spanner.



.SH "EXAMPLES"

To start an interactive shell with your Spanner example database, run the
following command:

.RS 2m
$ gcloud alpha spanner cli example\-database \e
    \-\-instance=example\-instance
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Database resource \- The Cloud Spanner database to use within the interactive
shell. The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but can
be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5database\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIDATABASE\fR

ID of the database or fully qualified identifier for the database.

To set the \f5database\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5database\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-instance\fR=\fIINSTANCE\fR

The Cloud Spanner instance for the database.

To set the \f5instance\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5database\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-instance\fR on the command line;
.IP "\(bu" 2m
set the property \f5spanner/instance\fR.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-database\-role\fR=\fIDATABASE_ROLE\fR

Database role user used to access the database.

.TP 2m
\fB\-\-delimiter\fR=\fIDELIMITER\fR; default=";"

Set the statement delimiter.

.TP 2m
\fB\-\-execute\fR=\fIEXECUTE\fR

Execute the statement and then exits.

.TP 2m
\fB\-\-host\fR=\fIHOST\fR; default="localhost"

Host on which Spanner server is located.

.TP 2m
\fB\-\-html\fR

Show output in HTML format.

.TP 2m
\fB\-\-idle\-transaction\-timeout\fR=\fIIDLE_TRANSACTION_TIMEOUT\fR; default=60

Set the idle transaction timeout. The default timeout is 60 seconds.

.TP 2m
\fB\-\-init\-command\fR=\fIINIT_COMMAND\fR

SQL statement to execute after startup.

.TP 2m
\fB\-\-init\-command\-add\fR=\fIINIT_COMMAND_ADD\fR

Additional SQL statement to execute after startup.

.TP 2m
\fB\-\-port\fR=\fIPORT\fR

Port number that gcloud uses to connect to Spanner.

.TP 2m
\fB\-\-prompt\fR=\fIPROMPT\fR; default="spanner\-cli> "

Set the prompt to the specified format.

.TP 2m
\fB\-\-skip\-column\-names\fR

Do not show column names in output.

.TP 2m
\fB\-\-skip\-system\-command\fR

Do not allow system command.

.TP 2m
\fB\-\-source\fR=\fISOURCE\fR

Execute the statement from a file and then exits.

.TP 2m
\fB\-\-system\-command\fR=\fISYSTEM_COMMAND\fR; default="ON"

Enable or disable system commands. Default: ON. \fISYSTEM_COMMAND\fR must be one
of: \fBON\fR, \fBOFF\fR.

.TP 2m
\fB\-\-table\fR

Show output in table format.

.TP 2m
\fB\-\-tee\fR=\fITEE\fR

Append a copy of the output to a named file.

.TP 2m
\fB\-\-xml\fR

Show output in XML format.


.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"

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:

.RS 2m
$ gcloud spanner cli
.RE