gcloud_beta_spanner_databases_execute-sql (1)
NAME
- gcloud beta spanner databases execute-sql - executes a SQL query against a Cloud Spanner database
SYNOPSIS
-
gcloud beta spanner databases execute-sql (DATABASE : --instance=INSTANCE) --sql=SQL [--enable-partitioned-dml] [--query-mode=QUERY_MODE; default="NORMAL"] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Executes a SQL query against a Cloud Spanner database.
POSITIONAL ARGUMENTS
-
-
- 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 [project] attribute: provide the argument [database] on the command line with a fully specified name; provide the argument [--project] on the command line; set the property [core/project]. This must be specified.
-
- DATABASE
-
ID of the database or fully qualified identifier for the database. This
positional must be specified if any of the other arguments in this group are
specified.
- --instance=INSTANCE
-
The Cloud Spanner instance for the database.
- 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 [project] attribute: provide the argument [database] on the command line with a fully specified name; provide the argument [--project] on the command line; set the property [core/project]. This must be specified.
-
REQUIRED FLAGS
-
- --sql=SQL
-
The SQL query to issue to the database. Cloud Spanner SQL is described at
cloud.google.com/spanner/docs/query-syntax
OPTIONAL FLAGS
-
- --enable-partitioned-dml
-
Execute DML statement using Partitioned DML
- --query-mode=QUERY_MODE; default="NORMAL"
-
Mode in which the query must be processed. QUERY_MODE must be one of:
-
- NORMAL
- Returns only the query result, without any information about the query plan.
- PLAN
- Returns only the query plan, without any result rows or execution statistics information.
- PROFILE
- Returns both the query plan and the execution statistics along with the result rows.
-
GCLOUD WIDE FLAGS
These flags are available to all commands: --account, --configuration, --flags-file, --flatten, --format, --help, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity. Run $ gcloud help for details.
EXAMPLES
To execute a SQL SELECT statement against example-database under.RS 2m example-instance, run:
-
$ gcloud beta spanner databases execute-sql example-database \
--instance=example-instance --sql='SELECT * FROM MyTable WHERE MyKey = 1'
NOTES
This command is currently in BETA and may change without notice. These variants are also available:
- $ gcloud spanner databases execute-sql $ gcloud alpha spanner databases execute-sql