rdsdata/aws.sdk.kotlin.services.rdsdata.model/ExecuteStatementRequest

ExecuteStatementRequest

class ExecuteStatementRequest

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

Types

Builder

class Builder

Companion

object Companion

Properties

continueAfterTimeout

val continueAfterTimeout: Boolean

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.

database

val database: String?

The name of the database.

formatRecordsAs

val formatRecordsAs: RecordsFormatType?

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.

includeResultMetadata

val includeResultMetadata: Boolean

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

parameters

val parameters: List<SqlParameter>?

The parameters for the SQL statement.

resourceArn

val resourceArn: String

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

resultSetOptions

val resultSetOptions: ResultSetOptions?

Options that control how the result set is returned.

schema

val schema: String?

The name of the database schema.

secretArn

val secretArn: String

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.

sql

val sql: String

The SQL statement to run.

transactionId

val transactionId: String?

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.

Functions

copy

inline fun copy(block: ExecuteStatementRequest.Builder.() -> Unit = {}): ExecuteStatementRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String