ExecuteStatementRequest

import type { ExecuteStatementRequest } from "https://aws-api.deno.dev/v0.3/services/rdsdataservice.ts?docs=full";

The request parameters represent the input of a request to run a SQL statement against a database.

interface ExecuteStatementRequest {

continueAfterTimeout?: boolean | null;

database?: string | null;

includeResultMetadata?: boolean | null;

parameters?: SqlParameter[] | null;

resourceArn: string;

resultSetOptions?: ResultSetOptions | null;

schema?: string | null;

secretArn: string;

sql: string;

transactionId?: string | null;

}

§Properties

continueAfterTimeout?: boolean | null

[src]

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.

! IMPORTANT: ! 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.

database?: string | null

[src]

The name of the database.

includeResultMetadata?: boolean | null

[src]

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

parameters?: SqlParameter[] | null

[src]

The parameters for the SQL statement.

Note: Array parameters are not supported.

resourceArn: string

[src]

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

resultSetOptions?: ResultSetOptions | null

[src]

Options that control how the result set is returned.

schema?: string | null

[src]

The name of the database schema.

Note: Currently, the schema parameter isn't supported.

secretArn: string

[src]

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

sql: string

[src]

The SQL statement to run.

transactionId?: string | null

[src]

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.