gcloud alpha sql instances execute-sql

NAME

gcloud alpha sql instances execute-sql - executes a statement on a Cloud SQL instance

SYNOPSIS

gcloud alpha sql instances execute-sql INSTANCE --sql=SQL [--database=DATABASE, -d DATABASE] [--partial_result_mode=PARTIAL_RESULT_MODE] [--row_limit=ROW_LIMIT] [GCLOUD_WIDE_FLAG …]

DESCRIPTION

(ALPHA) Executes a statement on a Cloud SQL instance. It will use the credentials of the specified Google Cloud account to connect to the instance, so an IAM user with the same name must exist in the instance. WARNING: The requests and responses might transit through intermediate locations between your client and the location of the target instance.

EXAMPLES

To execute a statement on a Cloud SQL instance, run:

gcloud alpha sql instances execute-sql my-instance-name --sql="ALTER TABLE employees RENAME TO personnel;" --database=my-db

POSITIONAL ARGUMENTS

INSTANCE

Cloud SQL instance ID.

REQUIRED FLAGS

--sql=SQL

SQL statement(s) to execute. It supports multiple statements as well. When it starts with the character '@', the rest should be a filepath to read the SQL statement(s) from. For example, --sql=@my_script.sql.

OPTIONAL FLAGS

--database=DATABASE, -d DATABASE

Database on which the statement is executed.

--partial_result_mode=PARTIAL_RESULT_MODE

Controls how the API responds when the SQL execution result is incomplete due to size limit or other reasons. The default mode is to return an error instead of returning a partial result. PARTIAL_RESULT_MODE must be one of:

ALLOW_PARTIAL_RESULT

If the complete result is unavailable, returns a partial result, marks the field <code>partial_result</code> to <code>true</code>, and doesn't throw an error.

FAIL_PARTIAL_RESULT

If the complete result is unavailable, returns an error and doesn't return the partial result.

PARTIAL_RESULT_MODE_UNSPECIFIED

Unspecified mode, effectively the same as <code>FAIL_PARTIAL_RESULT</code>.

--row_limit=ROW_LIMIT

Maximum number of rows to return. The default is unlimited.

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

gcloud sql instances execute-sql

gcloud beta sql instances execute-sql