# ExplainQuery

open class ExplainQuery(val analyze: Boolean, val options: String?, internalStatement: Statement<*>) : Statement<ResultApi>

Represents the SQL query that obtains information about a statement execution plan.

#### Parameters

analyze

Whether the statement whose execution plan is being queried should actually be executed as well.

options

String of comma-separated parameters to append after the `EXPLAIN` keyword.

## Constructors

ExplainQuery
Link copied to clipboard
constructor(analyze: Boolean, options: String?, internalStatement: Statement<*>)

## Properties

analyze
Link copied to clipboard
val analyze: Boolean
options
Link copied to clipboard
val options: String?
targets
Link copied to clipboard
val targets: List<Table>
type
Link copied to clipboard
val type: StatementType

## Functions

arguments
Link copied to clipboard
open override fun arguments(): Iterable<Iterable<Pair<IColumnType<*>, Any?>>>

Returns all mappings of columns and expression types to their values needed to prepare an SQL statement.

prepareSQL
Link copied to clipboard
open override fun prepareSQL(transaction: Transaction, prepared: Boolean = true): String

Returns the string representation of an SQL statement.