typelevel / typelevel/skunk

Unknown completion 'EXPLAIN'

Open
#525 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
1.7k
Forks
175
Avg merge
5d 14h
Merged PRs (30d)
9

Description

I did an "EXPLAIN ANALYZE SELECT ..." call in Version 0.0.28:

🔥 SkunkException
🔥
🔥 Problem: Just constructed an unknown completion 'EXPLAIN'. Note that your
🔥 program has not crashed. This message is here to annoy you.
🔥 Hint: Please open an issue, or open a PR adding a case in Completion.scala
🔥 and a parser in CommandComplete.scala

Side note: The result of that is always a 'text' column, which is listed in the documentation as "not supported", although it apparently is.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading Completion.scala and CommandComplete.scala, then trace how an EXPLAIN ANALYZE response is parsed. Add the missing completion and parser handling described in the issue, and verify that the resulting text column behavior matches the documented support status.

Written by the indexing model from the issue text.

Assessment

Tech stack
postgres, scala
Domain
databases
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.