Back to Exposed

ExplainSuspendExecutable

docs/api/exposed-r2dbc/org.jetbrains.exposed.v1.r2dbc/-explain-suspend-executable/index.html

1.2.04.3 KB
Original Source

ExplainSuspendExecutable

open class ExplainSuspendExecutable(val statement: ExplainQuery) : SuspendExecutable<ResultApi, ExplainQuery> , Flow<ExplainResultRow>

Represents the execution logic for an SQL statement that obtains information about a statement execution plan.

Members

Constructors

ExplainSuspendExecutable

Link copied to clipboard

constructor(statement: ExplainQuery)

Properties

isAlwaysBatch

Link copied to clipboard

open val isAlwaysBatch: Boolean

Whether the SQL statement is meant to be performed as part of a batch execution.

statement

Link copied to clipboard

open override val statement: ExplainQuery

The actual Exposed Statement on which the specific execution logic should be used.

Functions

collect

Link copied to clipboard

open suspend override fun collect(collector: FlowCollector<ExplainResultRow>)

execute

Link copied to clipboard

open suspend fun execute(transaction: R2dbcTransaction): ResultApi?

Executes the SQL statement directly in the provided transaction and returns the generated result, or null if either no result was retrieved or if the transaction blocked statement execution.

executeInternal

Link copied to clipboard

open suspend override fun R2dbcPreparedStatementApi.executeInternal(transaction: R2dbcTransaction): R2dbcResult

Determines the exact way that an SQL statement is executed in a transaction and applies any necessary logic before returning the result generated by the executed statement.

prepared

Link copied to clipboard

open suspend fun prepared(transaction: R2dbcTransaction, sql: String): R2dbcPreparedStatementApi

Uses a transaction connection and an sql string representation to return a precompiled SQL statement, stored as an implementation of R2dbcPreparedStatementApi.

Generated by Dokka © 2026 Copyright