prisma-mysql-explain

Execute mysql explain for Prisma

WARNING

This library is for development environments.

Don't use production environment.

usage

import { createExplain } from "prisma-mysql-explain"

const createPrisma = () => {
  // Need query event log
  const prisma = new PrismaClient({
    log: [{ level: "query", emit: "event" }]
  })

  const prismaExplain = creatExplainQuery(prisma, {cacheType: "params"})

  prisma.$on("query", async (event) => {
    const result = await prismaExplain.explain(event)
    if (!result) {
      return
    }
    console.log(result)
  })
  
  return prisma
}

API

createExplain(prisma: PrismaClient, option: Option?)

Option

• cacheType
  • query(default) - Cache with query
  • param - Cache with query and params
  • none - Disable cahce

Return

• explain: (event: Prisma.QueryEvent) => ExplainResult[]