Back to Exposed

ExplainBlockingExecutable

docs/api/exposed-jdbc/org.jetbrains.exposed.v1.jdbc/-explain-blocking-executable/index.html

1.2.04.4 KB
Original Source

ExplainBlockingExecutable

open class ExplainBlockingExecutable(val statement: ExplainQuery) : BlockingExecutable<ResultApi, ExplainQuery> , Iterable<ExplainResultRow>

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

Members

Constructors

ExplainBlockingExecutable

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

execute

Link copied to clipboard

open fun execute(transaction: JdbcTransaction): 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 override fun JdbcPreparedStatementApi.executeInternal(transaction: JdbcTransaction): JdbcResult

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.

iterator

Link copied to clipboard

open operator override fun iterator(): Iterator<ExplainResultRow>

prepared

Link copied to clipboard

open fun prepared(transaction: JdbcTransaction, sql: String): JdbcPreparedStatementApi

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

Generated by Dokka © 2026 Copyright