AWS CLI Command Reference

[ aws . rds-data ]

execute-sql

Description

Runs one or more SQL statements.

Note

This operation isn’t supported for Aurora Serverless v2 and provisioned DB clusters. For Aurora Serverless v1 DB clusters, the operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.

See also: AWS API Documentation

Synopsis

  execute-sql
--db-cluster-or-instance-arn <value>
--aws-secret-store-arn <value>
--sql-statements <value>
[--database <value>]
[--schema <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--db-cluster-or-instance-arn (string)

The ARN of the Aurora Serverless DB cluster.

--aws-secret-store-arn (string)

The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster. Enter the database user name and password for the credentials in the secret.

For information about creating the secret, see Create a database secret .

--sql-statements (string)

One or more SQL statements to run on the DB cluster.

You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements.

--database (string)

The name of the database.

--schema (string)

The name of the database schema.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

sqlStatementResults -> (list)

The results of the SQL statement or statements.

(structure)

The result of a SQL statement.

Note

This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.

resultFrame -> (structure)

The result set of the SQL statement.

resultSetMetadata -> (structure)

The result-set metadata in the result set.

columnCount -> (long)

The number of columns in the result set.

columnMetadata -> (list)

The metadata of the columns in the result set.

(structure)

Contains the metadata for a column.

name -> (string)

The name of the column.

type -> (integer)

The type of the column.

typeName -> (string)

The database-specific data type of the column.

label -> (string)

The label for the column.

schemaName -> (string)

The name of the schema that owns the table that includes the column.

tableName -> (string)

The name of the table that includes the column.

isAutoIncrement -> (boolean)

A value that indicates whether the column increments automatically.

isSigned -> (boolean)

A value that indicates whether an integer column is signed.

isCurrency -> (boolean)

A value that indicates whether the column contains currency values.

isCaseSensitive -> (boolean)

A value that indicates whether the column is case-sensitive.

nullable -> (integer)

A value that indicates whether the column is nullable.

precision -> (integer)

The precision value of a decimal number column.

scale -> (integer)

The scale value of a decimal number column.

arrayBaseColumnType -> (integer)

The type of the column.

records -> (list)

The records in the result set.

(structure)

A record returned by a call.

Note

This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.

values -> (list)

The values returned in the record.

(tagged union structure)

Contains the value of a column.

Note

This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: isNull, bitValue, bigIntValue, intValue, doubleValue, realValue, stringValue, blobValue, arrayValues, structValue.

isNull -> (boolean)

A NULL value.

bitValue -> (boolean)

A value for a column of BIT data type.

bigIntValue -> (long)

A value for a column of big integer data type.

intValue -> (integer)

A value for a column of integer data type.

doubleValue -> (double)

A value for a column of double data type.

realValue -> (float)

A value for a column of real data type.

stringValue -> (string)

A value for a column of string data type.

blobValue -> (blob)

A value for a column of BLOB data type.

arrayValues -> (list)

An array of column values.

(tagged union structure)

Contains the value of a column.

Note

This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: isNull, bitValue, bigIntValue, intValue, doubleValue, realValue, stringValue, blobValue, arrayValues, structValue.

isNull -> (boolean)

A NULL value.

bitValue -> (boolean)

A value for a column of BIT data type.

bigIntValue -> (long)

A value for a column of big integer data type.

intValue -> (integer)

A value for a column of integer data type.

doubleValue -> (double)

A value for a column of double data type.

realValue -> (float)

A value for a column of real data type.

stringValue -> (string)

A value for a column of string data type.

blobValue -> (blob)

A value for a column of BLOB data type.

arrayValues -> (list)

An array of column values.

( … recursive … )

structValue -> (structure)

A value for a column of STRUCT data type.

attributes -> (list)

The attributes returned in the record.

( … recursive … )

structValue -> (structure)

A value for a column of STRUCT data type.

attributes -> (list)

The attributes returned in the record.

(tagged union structure)

Contains the value of a column.

Note

This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: isNull, bitValue, bigIntValue, intValue, doubleValue, realValue, stringValue, blobValue, arrayValues, structValue.

isNull -> (boolean)

A NULL value.

bitValue -> (boolean)

A value for a column of BIT data type.

bigIntValue -> (long)

A value for a column of big integer data type.

intValue -> (integer)

A value for a column of integer data type.

doubleValue -> (double)

A value for a column of double data type.

realValue -> (float)

A value for a column of real data type.

stringValue -> (string)

A value for a column of string data type.

blobValue -> (blob)

A value for a column of BLOB data type.

arrayValues -> (list)

An array of column values.

( … recursive … )

structValue -> (structure)

A value for a column of STRUCT data type.

attributes -> (list)

The attributes returned in the record.

( … recursive … )

numberOfRecordsUpdated -> (long)

The number of records updated by a SQL statement.
© Copyright 2018, Amazon Web Services. Created using Sphinx.