Interface Explainable

explain

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

  Executes query with explain statement before the main query.

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

  The generated SQL (MySQL):

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

  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`)
  Copy

  The generated SQL (PostgreSQL):

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

  Type Parameters

  • O extends Record<string, any> = Record<string, any>

  Parameters

  • Optionalformat: ExplainFormat
  • Optionaloptions: Expression<any>

  Returns Promise<O[]>