AWS API Changes

2022/04/25 - AWS RDS DataService - 1 updated api methods

Changes Support to receive SQL query results in the form of a simplified JSON string. This enables developers using the new JSON string format to more easily convert it to an object using popular JSON string parsing libraries.

ExecuteStatement (updated)

Link ¶
Changes (request, response)
Request

{'formatRecordsAs': 'NONE | JSON',
 'resultSetOptions': {'longReturnType': 'STRING | LONG'}}

Response

{'formattedRecords': 'string'}

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.

If the binary response data from the database is more than 1 MB, the call is terminated.

See also: AWS API Documentation

Request Syntax

client.execute_statement(
    continueAfterTimeout=True|False,
    database='string',
    formatRecordsAs='NONE'|'JSON',
    includeResultMetadata=True|False,
    parameters=[
        {
            'name': 'string',
            'typeHint': 'JSON'|'UUID'|'TIMESTAMP'|'DATE'|'TIME'|'DECIMAL',
            'value': {
                'arrayValue': {
                    'arrayValues': [
                        {'... recursive ...'},
                    ],
                    'booleanValues': [
                        True|False,
                    ],
                    'doubleValues': [
                        123.0,
                    ],
                    'longValues': [
                        123,
                    ],
                    'stringValues': [
                        'string',
                    ]
                },
                'blobValue': b'bytes',
                'booleanValue': True|False,
                'doubleValue': 123.0,
                'isNull': True|False,
                'longValue': 123,
                'stringValue': 'string'
            }
        },
    ],
    resourceArn='string',
    resultSetOptions={
        'decimalReturnType': 'STRING'|'DOUBLE_OR_LONG',
        'longReturnType': 'STRING'|'LONG'
    },
    schema='string',
    secretArn='string',
    sql='string',
    transactionId='string'
)

type continueAfterTimeout

boolean

param continueAfterTimeout

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.

type database

string

param database

The name of the database.

type formatRecordsAs

string

param formatRecordsAs

A value that indicates whether to format the result set as a single JSON string. This parameter only applies to SELECT statements and is ignored for other types of statements. Allowed values are NONE and JSON . The default value is NONE . The result is returned in the formattedRecords field.

For usage information about the JSON format for result sets, see Using the Data API in the Amazon Aurora User Guide .

type includeResultMetadata

boolean

param includeResultMetadata

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

type parameters

list

param parameters

The parameters for the SQL statement.

Note

Array parameters are not supported.

(dict) --

A parameter used in a SQL statement.
- name (string) --
  
  The name of the parameter.
- 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.
- value (dict) --
  
  The value of the parameter.
  - arrayValue (dict) --
    
    An array of values.
    - arrayValues (list) --
      
      An array of arrays.
      - (dict) --
        
        Contains an array.
    - booleanValues (list) --
      
      An array of Boolean values.
      - (boolean) --
    - doubleValues (list) --
      
      An array of floating-point numbers.
      - (float) --
    - longValues (list) --
      
      An array of integers.
      - (integer) --
    - stringValues (list) --
      
      An array of strings.
      - (string) --
  - blobValue (bytes) --
    
    A value of BLOB data type.
  - booleanValue (boolean) --
    
    A value of Boolean data type.
  - doubleValue (float) --
    
    A value of double data type.
  - isNull (boolean) --
    
    A NULL value.
  - longValue (integer) --
    
    A value of long data type.
  - stringValue (string) --
    
    A value of string data type.

type resourceArn

string

param resourceArn

[REQUIRED]

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

type resultSetOptions

dict

param resultSetOptions

Options that control how the result set is returned.

decimalReturnType (string) --

A value that indicates how a field of DECIMAL type is represented in the response. The value of STRING , the default, specifies that it is converted to a String value. The value of DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise.

Warning

Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to String, especially when working with currency values.
longReturnType (string) --

A value that indicates how a field of LONG type is represented. Allowed values are LONG and STRING . The default is LONG . Specify STRING if the length or precision of numeric values might cause truncation or rounding errors.

type schema

string

param schema

The name of the database schema.

Note

Currently, the schema parameter isn't supported.

type secretArn

string

param secretArn

[REQUIRED]

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

type sql

string

param sql

[REQUIRED]

The SQL statement to run.

type transactionId

string

param transactionId

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.

rtype

dict

returns

Response Syntax

{
    'columnMetadata': [
        {
            'arrayBaseColumnType': 123,
            'isAutoIncrement': True|False,
            'isCaseSensitive': True|False,
            'isCurrency': True|False,
            'isSigned': True|False,
            'label': 'string',
            'name': 'string',
            'nullable': 123,
            'precision': 123,
            'scale': 123,
            'schemaName': 'string',
            'tableName': 'string',
            'type': 123,
            'typeName': 'string'
        },
    ],
    'formattedRecords': 'string',
    'generatedFields': [
        {
            'arrayValue': {
                'arrayValues': [
                    {'... recursive ...'},
                ],
                'booleanValues': [
                    True|False,
                ],
                'doubleValues': [
                    123.0,
                ],
                'longValues': [
                    123,
                ],
                'stringValues': [
                    'string',
                ]
            },
            'blobValue': b'bytes',
            'booleanValue': True|False,
            'doubleValue': 123.0,
            'isNull': True|False,
            'longValue': 123,
            'stringValue': 'string'
        },
    ],
    'numberOfRecordsUpdated': 123,
    'records': [
        [
            {
                'arrayValue': {
                    'arrayValues': [
                        {'... recursive ...'},
                    ],
                    'booleanValues': [
                        True|False,
                    ],
                    'doubleValues': [
                        123.0,
                    ],
                    'longValues': [
                        123,
                    ],
                    'stringValues': [
                        'string',
                    ]
                },
                'blobValue': b'bytes',
                'booleanValue': True|False,
                'doubleValue': 123.0,
                'isNull': True|False,
                'longValue': 123,
                'stringValue': 'string'
            },
        ],
    ]
}

Response Structure

(dict) --

The response elements represent the output of a request to run a SQL statement against a database.
- columnMetadata (list) --
  
  Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON .
  - (dict) --
    
    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.
- formattedRecords (string) --
  
  A string value that represents the result set of a SELECT statement in JSON format. This value is only present when the formatRecordsAs parameter is set to JSON .
  
  The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error.
- generatedFields (list) --
  
  Values for fields generated during a DML request.
  
  <note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note>
  - (dict) --
    
    Contains a value.
    - arrayValue (dict) --
      
      An array of values.
      - arrayValues (list) --
        
        An array of arrays.
        
        (dict) --
        
        Contains an array.
      - booleanValues (list) --
        
        An array of Boolean values.
        
        (boolean) --
      - doubleValues (list) --
        
        An array of floating-point numbers.
        
        (float) --
      - longValues (list) --
        
        An array of integers.
        
        (integer) --
      - stringValues (list) --
        
        An array of strings.
        
        (string) --
    - blobValue (bytes) --
      
      A value of BLOB data type.
    - booleanValue (boolean) --
      
      A value of Boolean data type.
    - doubleValue (float) --
      
      A value of double data type.
    - isNull (boolean) --
      
      A NULL value.
    - longValue (integer) --
      
      A value of long data type.
    - stringValue (string) --
      
      A value of string data type.
- numberOfRecordsUpdated (integer) --
  
  The number of records updated by the request.
- records (list) --
  
  The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is set to JSON .
  - (list) --
    - (dict) --
      
      Contains a value.
      - arrayValue (dict) --
        
        An array of values.
        
        arrayValues (list) --
        
        An array of arrays.
        
        (dict) --
        
        Contains an array.
        
        booleanValues (list) --
        
        An array of Boolean values.
        
        (boolean) --
        
        doubleValues (list) --
        
        An array of floating-point numbers.
        
        (float) --
        
        longValues (list) --
        
        An array of integers.
        
        (integer) --
        
        stringValues (list) --
        
        An array of strings.
        
        (string) --
      - blobValue (bytes) --
        
        A value of BLOB data type.
      - booleanValue (boolean) --
        
        A value of Boolean data type.
      - doubleValue (float) --
        
        A value of double data type.
      - isNull (boolean) --
        
        A NULL value.
      - longValue (integer) --
        
        A value of long data type.
      - stringValue (string) --
        
        A value of string data type.