Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ExecuteStatementResponse

The response elements represent the output of a request to run a SQL statement against a database.

Hierarchy

Index

Properties

Properties

Optional columnMetadata

columnMetadata: ColumnMetadata[]

Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON.

Optional formattedRecords

formattedRecords: undefined | 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.

Optional generatedFields

generatedFields: Field[]

Values for fields generated during a DML request.

The generatedFields data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the RETURNING clause. For more information, see Returning Data From Modified Rows in the PostgreSQL documentation.

Optional numberOfRecordsUpdated

numberOfRecordsUpdated: undefined | number

The number of records updated by the request.

Optional records

records: Field[][]

The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is set to JSON.