kysely.InsertQueryBuilder | /deps.ts | kysely_postgrs_js_dialect@v0.27.3

method kysely.InsertQueryBuilder.prototype.explain

import { kysely } from "https://dotland.deno.dev/x/kysely_postgrs_js_dialect@v0.27.3/deps.ts";
const { InsertQueryBuilder } = kysely;

explain<ER extends Record<string, any> = Record<string, any>>(format?: ExplainFormat, options?: Expression<any>): Promise<ER[]>

Executes query with explain statement before the main query.

const explained = await db
 .selectFrom('person')
 .where('gender', '=', 'female')
 .selectAll()
 .explain('json')

The generated SQL (MySQL):

explain format=json select * from `person` where `gender` = ?

You can also execute explain analyze statements.

import { sql } from 'kysely'

const explained = await db
 .selectFrom('person')
 .where('gender', '=', 'female')
 .selectAll()
 .explain('json', sql`analyze`)

The generated SQL (PostgreSQL):

explain (analyze, format json) select * from "person" where "gender" = $1

Type Parameters

optional

ER extends Record<string, any> = Record<string, any>

Parameters

optional

format: ExplainFormat

optional

options: Expression<any>

Returns

Promise<ER[]>