ExecuteStatementRequest
import type { ExecuteStatementRequest } from "https://aws-api.deno.dev/v0.4/services/rdsdataservice.ts?docs=full";
The request parameters represent the input of a request to run a SQL statement against a database.
§Properties
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.
Note: 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.
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.
A value that indicates whether to include metadata in the results.
The parameters for the SQL statement.
Note: Array parameters are not supported.
Options that control how the result set is returned.
The name of the database schema.
Note:
Currently, the schema
parameter isn't supported.
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.