Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . rds-data ]

execute-statement

Description

Runs a SQL statement against a database.

Warning

If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

The response size limit is 1 MB or 1,000 records. If the call returns more than 1 MB of response data or over 1,000 records, the call is terminated.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  execute-statement
[--continue-after-timeout | --no-continue-after-timeout]
[--database <value>]
[--include-result-metadata | --no-include-result-metadata]
[--parameters <value>]
--resource-arn <value>
[--result-set-options <value>]
[--schema <value>]
--secret-arn <value>
--sql <value>
[--transaction-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--continue-after-timeout | --no-continue-after-timeout (boolean)

A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out.

Warning

For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures.

--database (string)

The name of the database.

--include-result-metadata | --no-include-result-metadata (boolean)

A value that indicates whether to include metadata in the results.

--parameters (list)

The parameters for the SQL statement.

JSON Syntax:

[
  {
    "name": "string",
    "typeHint": "DATE"|"DECIMAL"|"TIME"|"TIMESTAMP",
    "value": {
      "arrayValue": {
        "arrayValues": [
          {
            "arrayValues": [
              { ... recursive ... }
              ...
            ],
            "booleanValues": [true|false, ...],
            "doubleValues": [double, ...],
            "longValues": [long, ...],
            "stringValues": ["string", ...]
          }
          ...
        ],
        "booleanValues": [true|false, ...],
        "doubleValues": [double, ...],
        "longValues": [long, ...],
        "stringValues": ["string", ...]
      },
      "blobValue": blob,
      "booleanValue": true|false,
      "doubleValue": double,
      "isNull": true|false,
      "longValue": long,
      "stringValue": "string"
    }
  }
  ...
]

--resource-arn (string)

The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

--result-set-options (structure)

Options that control how the result set is returned.

Shorthand Syntax:

decimalReturnType=string

JSON Syntax:

{
  "decimalReturnType": "DOUBLE_OR_LONG"|"STRING"
}

--schema (string)

The name of the database schema.

--secret-arn (string)

The name or ARN of the secret that enables access to the DB cluster.

--sql (string)

The SQL statement to run.

--transaction-id (string)

The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

If the SQL statement is not part of a transaction, don't set this parameter.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

Example 1: To execute a SQL statement that is part of a transaction

The following execute-statement example runs a SQL statement that is part of a transaction.

aws rds-data execute-statement \
    --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \
    --database "mydb" \
    --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" \
    --sql "update mytable set quantity=5 where id=201" \
    --transaction-id "ABC1234567890xyz"

Output:

{
    "numberOfRecordsUpdated": 1
}

Example 2: To execute a SQL statement with parameters

The following execute-statement example runs a SQL statement with parameters.

aws rds-data execute-statement \
    --resource-arn "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster" \
    --database "mydb" \
    --secret-arn "arn:aws:secretsmanager:us-east-1:123456789012:secret:mysecret" \
    --sql "insert into mytable values (:id, :val)" \
    --parameters "[{\"name\": \"id\", \"value\": {\"longValue\": 1}},{\"name\": \"val\", \"value\": {\"stringValue\": \"value1\"}}]"

Output:

{
    "numberOfRecordsUpdated": 1
}

For more information, see Using the Data API for Aurora Serverless in the Amazon RDS User Guide.

Output

columnMetadata -> (list)

Metadata for the columns included in the results.

(structure)

Contains the metadata for a column.

arrayBaseColumnType -> (integer)

The type of the column.

isAutoIncrement -> (boolean)

A value that indicates whether the column increments automatically.

isCaseSensitive -> (boolean)

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

isCurrency -> (boolean)

A value that indicates whether the column contains currency values.

isSigned -> (boolean)

A value that indicates whether an integer column is signed.

label -> (string)

The label for the column.

name -> (string)

The name of the column.

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.

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.

type -> (integer)

The type of the column.

typeName -> (string)

The database-specific data type of the column.

generatedFields -> (list)

Values for fields generated during the request.

`` note pThe codegeneratedFields/codedata isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the codeRETURNING/codeclause. For more information, see a href=https://www.postgresql.org/docs/10/dml-returning.htmlReturning Data From Modified Rows/ain the PostgreSQL documentation./p /note``

(structure)

Contains a value.

arrayValue -> (structure)

An array of values.

arrayValues -> (list)

An array of arrays.

(structure)

Contains an array.

arrayValues -> (list)

An array of arrays.

( ... recursive ... )

booleanValues -> (list)

An array of Boolean values.

(boolean)

doubleValues -> (list)

An array of integers.

(double)

longValues -> (list)

An array of floating point numbers.

(long)

stringValues -> (list)

An array of strings.

(string)

booleanValues -> (list)

An array of Boolean values.

(boolean)

doubleValues -> (list)

An array of integers.

(double)

longValues -> (list)

An array of floating point numbers.

(long)

stringValues -> (list)

An array of strings.

(string)

blobValue -> (blob)

A value of BLOB data type.

booleanValue -> (boolean)

A value of Boolean data type.

doubleValue -> (double)

A value of double data type.

isNull -> (boolean)

A NULL value.

longValue -> (long)

A value of long data type.

stringValue -> (string)

A value of string data type.

numberOfRecordsUpdated -> (long)

The number of records updated by the request.

records -> (list)

The records returned by the SQL statement.

(list)

(structure)

Contains a value.

arrayValue -> (structure)

An array of values.

arrayValues -> (list)

An array of arrays.

(structure)

Contains an array.

arrayValues -> (list)

An array of arrays.

( ... recursive ... )

booleanValues -> (list)

An array of Boolean values.

(boolean)

doubleValues -> (list)

An array of integers.

(double)

longValues -> (list)

An array of floating point numbers.

(long)

stringValues -> (list)

An array of strings.

(string)

booleanValues -> (list)

An array of Boolean values.

(boolean)

doubleValues -> (list)

An array of integers.

(double)

longValues -> (list)

An array of floating point numbers.

(long)

stringValues -> (list)

An array of strings.

(string)

blobValue -> (blob)

A value of BLOB data type.

booleanValue -> (boolean)

A value of Boolean data type.

doubleValue -> (double)

A value of double data type.

isNull -> (boolean)

A NULL value.

longValue -> (long)

A value of long data type.

stringValue -> (string)

A value of string data type.