explain
fun explain(analyze: Boolean = false, verbose: Boolean = false, settings: Boolean = false, buffers: Boolean = false, wal: Boolean = false, format: String = "text")(source)
Return data as the EXPLAIN plan for the query.
Parameters
analyze
If
true, the query will be executed and the actual run time will be returned
verbose
If
true, the query identifier will be returned anddatawill include the output columns of the query
settings
If
true, include information on configuration parameters that affect query planning
buffers
If
true, include information on buffer usage
wal
If
true, include information on WAL record generation
format
The format of the output, can be
"text"(default) or"json"