Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . rds-data ]

batch-execute-statement

Description

Runs a batch SQL statement over an array of data.

You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations.

Note

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.

There isn't a fixed upper limit on the number of parameter sets. However, the maximum size of the HTTP request submitted through the Data API is 4 MiB. If the request exceeds this limit, the Data API returns an error and doesn't process the request. This 4-MiB limit includes the size of the HTTP headers and the JSON notation in the request. Thus, the number of parameter sets that you can include depends on a combination of factors, such as the size of the SQL statement and the size of each parameter set.

The response size limit is 1 MiB. If the call returns more than 1 MiB of response data, the call is terminated.

See also: AWS API Documentation

Synopsis

  batch-execute-statement
--resource-arn <value>
--secret-arn <value>
--sql <value>
[--database <value>]
[--schema <value>]
[--parameter-sets <value>]
[--transaction-id <value>]
[--cli-input-json <value>]
[--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>]

Options

--resource-arn (string)

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

--secret-arn (string)

The 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 (string)

The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.

--database (string)

The name of the database.

--schema (string)

The name of the database schema.

--parameter-sets (list)

The parameter set for the batch operation.

The SQL statement is executed as many times as the number of parameter sets provided. To execute a SQL statement with no parameters, use one of the following options:

  • Specify one or more empty parameter sets.
  • Use the ExecuteStatement operation instead of the BatchExecuteStatement operation.

Note

Array parameters are not supported.

(list)

(structure)

A parameter used in a SQL statement.

name -> (string)

The name of the parameter.

value -> (tagged union structure)

The value of the parameter.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: isNull, booleanValue, longValue, doubleValue, stringValue, blobValue, arrayValue.

isNull -> (boolean)

A NULL value.

booleanValue -> (boolean)

A value of Boolean data type.

longValue -> (long)

A value of long data type.

doubleValue -> (double)

A value of double data type.

stringValue -> (string)

A value of string data type.

blobValue -> (blob)

A value of BLOB data type.

arrayValue -> (tagged union structure)

An array of values.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValues, longValues, doubleValues, stringValues, arrayValues.

booleanValues -> (list)

An array of Boolean values.

(boolean)

longValues -> (list)

An array of integers.

(long)

doubleValues -> (list)

An array of floating-point numbers.

(double)

stringValues -> (list)

An array of strings.

(string)

arrayValues -> (list)

An array of arrays.

(tagged union structure)

Contains an array.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValues, longValues, doubleValues, stringValues, arrayValues.

booleanValues -> (list)

An array of Boolean values.

(boolean)

longValues -> (list)

An array of integers.

(long)

doubleValues -> (list)

An array of floating-point numbers.

(double)

stringValues -> (list)

An array of strings.

(string)

arrayValues -> (list)

An array of arrays.

( ... recursive ... )

typeHint -> (string)

A hint that specifies the correct object type for data type mapping. Possible values are as follows:

  • DATE - The corresponding String parameter value is sent as an object of DATE type to the database. The accepted format is YYYY-MM-DD .
  • DECIMAL - The corresponding String parameter value is sent as an object of DECIMAL type to the database.
  • JSON - The corresponding String parameter value is sent as an object of JSON type to the database.
  • TIME - The corresponding String parameter value is sent as an object of TIME type to the database. The accepted format is HH:MM:SS[.FFF] .
  • TIMESTAMP - The corresponding String parameter value is sent as an object of TIMESTAMP type to the database. The accepted format is YYYY-MM-DD HH:MM:SS[.FFF] .
  • UUID - The corresponding String parameter value is sent as an object of UUID type to the database.

JSON Syntax:

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

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

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

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

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To execute a batch SQL statement

The following batch-execute-statement example executes a batch SQL statement over an array of data with a parameter set.

aws rds-data batch-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 "insert into mytable values (:id, :val)" \
    --parameter-sets "[[{\"name\": \"id\", \"value\": {\"longValue\": 1}},{\"name\": \"val\", \"value\": {\"stringValue\": \"ValueOne\"}}],
        [{\"name\": \"id\", \"value\": {\"longValue\": 2}},{\"name\": \"val\", \"value\": {\"stringValue\": \"ValueTwo\"}}],
        [{\"name\": \"id\", \"value\": {\"longValue\": 3}},{\"name\": \"val\", \"value\": {\"stringValue\": \"ValueThree\"}}]]"

This command produces no output.

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

Output

updateResults -> (list)

The execution results of each batch entry.

(structure)

The response elements represent the results of an update.

generatedFields -> (list)

Values for fields generated during the request.

(tagged union structure)

Contains a value.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: isNull, booleanValue, longValue, doubleValue, stringValue, blobValue, arrayValue.

isNull -> (boolean)

A NULL value.

booleanValue -> (boolean)

A value of Boolean data type.

longValue -> (long)

A value of long data type.

doubleValue -> (double)

A value of double data type.

stringValue -> (string)

A value of string data type.

blobValue -> (blob)

A value of BLOB data type.

arrayValue -> (tagged union structure)

An array of values.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValues, longValues, doubleValues, stringValues, arrayValues.

booleanValues -> (list)

An array of Boolean values.

(boolean)

longValues -> (list)

An array of integers.

(long)

doubleValues -> (list)

An array of floating-point numbers.

(double)

stringValues -> (list)

An array of strings.

(string)

arrayValues -> (list)

An array of arrays.

(tagged union structure)

Contains an array.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValues, longValues, doubleValues, stringValues, arrayValues.

booleanValues -> (list)

An array of Boolean values.

(boolean)

longValues -> (list)

An array of integers.

(long)

doubleValues -> (list)

An array of floating-point numbers.

(double)

stringValues -> (list)

An array of strings.

(string)

arrayValues -> (list)

An array of arrays.

( ... recursive ... )