.TH "GCLOUD_ALPHA_SPANNER_DATABASES_EXECUTE\-SQL" 1



.SH "NAME"
.HP
gcloud alpha spanner databases execute\-sql \- executes a SQL query against a Cloud Spanner database



.SH "SYNOPSIS"
.HP
\f5gcloud alpha spanner databases execute\-sql\fR (\fIDATABASE\fR\ :\ \fB\-\-instance\fR=\fIINSTANCE\fR) \fB\-\-sql\fR=\fISQL\fR [\fB\-\-database\-role\fR=\fIDATABASE_ROLE\fR] [\fB\-\-enable\-partitioned\-dml\fR] [\fB\-\-priority\fR=\fIPRIORITY\fR] [\fB\-\-query\-mode\fR=\fIQUERY_MODE\fR;\ default="NORMAL"] [\fB\-\-timeout\fR=\fITIMEOUT\fR;\ default="10m"] [\fB\-\-read\-timestamp\fR=\fITIMESTAMP\fR\ |\ \fB\-\-strong\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Executes a SQL query against a Cloud Spanner database.



.SH "EXAMPLES"

To execute a SQL SELECT statement against example\-database under
example\-instance, run:

.RS 2m
$ gcloud alpha spanner databases execute\-sql example\-database \e
    \-\-instance=example\-instance \e
    \-\-sql='SELECT * FROM MyTable WHERE MyKey = 1'
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Database resource \- The Cloud Spanner database to execute the SQL query
against. 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 "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-sql\fR=\fISQL\fR

The SQL query to issue to the database. Cloud Spanner SQL is described at
https://cloud.google.com/spanner/docs/query\-syntax


.RE
.sp

.SH "OPTIONAL FLAGS"

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

Database role user assumes while accessing the database.

.TP 2m
\fB\-\-enable\-partitioned\-dml\fR

Execute DML statement using Partitioned DML

.TP 2m
\fB\-\-priority\fR=\fIPRIORITY\fR

The priority for the execute SQL request. \fIPRIORITY\fR must be one of:
\fBhigh\fR, \fBlow\fR, \fBmedium\fR, \fBunspecified\fR.

.TP 2m
\fB\-\-query\-mode\fR=\fIQUERY_MODE\fR; default="NORMAL"

Mode in which the query must be processed. \fIQUERY_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBNORMAL\fR
Returns only the query result, without any information about the query plan.
.TP 2m
\fBPLAN\fR
Returns only the query plan, without any result rows or execution statistics
information.
.TP 2m
\fBPROFILE\fR
Returns the query plan, overall execution statistics, operator\-level execution
statistics, along with the result rows.
.TP 2m
\fBWITH_PLAN_AND_STATS\fR
Returns the query plan, overall (but not operator\-level) execution statistics,
along with the results.
.TP 2m
\fBWITH_STATS\fR
Returns the overall (but not operator\-level) execution statistics along with
the results.
.RE
.sp


.TP 2m
\fB\-\-timeout\fR=\fITIMEOUT\fR; default="10m"

Maximum time to wait for the SQL query to complete. See $ gcloud topic datetimes
for information on duration formats.

.TP 2m

Read\-only query timestamp bound. The default is \-\-strong. See
https://cloud.google.com/spanner/docs/timestamp\-bounds.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-read\-timestamp\fR=\fITIMESTAMP\fR

Perform a query at the given timestamp.

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

Perform a strong query.


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

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. These variants are also available:

.RS 2m
$ gcloud spanner databases execute\-sql
.RE

.RS 2m
$ gcloud beta spanner databases execute\-sql
.RE