String resourceArn
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
String secretArn
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.
String sql
The SQL statement to run. Don't include a semicolon (;) at the end of the SQL statement.
String database
The name of the database.
String schema
The name of the database schema.
Currently, the schema parameter isn't supported.
List<E> parameterSets
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.
Array parameters are not supported.
String 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.
String transactionId
The transaction ID of the transaction started by the call.
String name
The name of the column.
Integer type
The type of the column.
String typeName
The database-specific data type of the column.
String label
The label for the column.
String schemaName
The name of the schema that owns the table that includes the column.
String tableName
The name of the table that includes the column.
Boolean isAutoIncrement
A value that indicates whether the column increments automatically.
Boolean isSigned
A value that indicates whether an integer column is signed.
Boolean isCurrency
A value that indicates whether the column contains currency values.
Boolean isCaseSensitive
A value that indicates whether the column is case-sensitive.
Integer nullable
A value that indicates whether the column is nullable.
Integer precision
The precision value of a decimal number column.
Integer scale
The scale value of a decimal number column.
Integer arrayBaseColumnType
The type of the column.
String transactionStatus
The status of the commit operation.
String dbClusterOrInstanceArn
The ARN of the Aurora Serverless DB cluster.
String awsSecretStoreArn
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.
String sqlStatements
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.
String database
The name of the database.
String schema
The name of the database schema.
String resourceArn
The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
String secretArn
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.
String sql
The SQL statement to run.
String database
The name of the database.
String schema
The name of the database schema.
Currently, the schema parameter isn't supported.
List<E> parameters
The parameters for the SQL statement.
Array parameters are not supported.
String 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.
Boolean includeResultMetadata
A value that indicates whether to include metadata in the results.
Boolean 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.
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.
ResultSetOptions resultSetOptions
Options that control how the result set is returned.
String 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.
List<E> records
The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is
set to JSON.
List<E> columnMetadata
Metadata for the columns included in the results. This field is blank if the formatRecordsAs
parameter is set to JSON.
Long numberOfRecordsUpdated
The number of records updated by the request.
List<E> generatedFields
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.
String formattedRecords
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.
Boolean isNull
A NULL value.
Boolean booleanValue
A value of Boolean data type.
Long longValue
A value of long data type.
Double doubleValue
A value of double data type.
String stringValue
A value of string data type.
ByteBuffer blobValue
A value of BLOB data type.
ArrayValue arrayValue
An array of values.
ResultSetMetadata resultSetMetadata
The result-set metadata in the result set.
List<E> records
The records in the result set.
String decimalReturnType
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.
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.
String longReturnType
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.
String transactionStatus
The status of the rollback operation.
String name
The name of the parameter.
Field value
The value of the parameter.
String typeHint
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.
ResultFrame resultFrame
The result set of the SQL statement.
Long numberOfRecordsUpdated
The number of records updated by a SQL statement.
Long dbConnectionId
The database connection ID that executed the SQL statement.
Boolean isNull
A NULL value.
Boolean bitValue
A value for a column of BIT data type.
Long bigIntValue
A value for a column of big integer data type.
Integer intValue
A value for a column of integer data type.
Double doubleValue
A value for a column of double data type.
Float realValue
A value for a column of real data type.
String stringValue
A value for a column of string data type.
ByteBuffer blobValue
A value for a column of BLOB data type.
List<E> arrayValues
An array of column values.
StructValue structValue
A value for a column of STRUCT data type.
Copyright © 2025. All rights reserved.