Repository navigation
Dedicated Dev UI interface to execute (and "log"?) Hibernate ORM queries #39584
Description
Description
When developing, It can be quite useful to:
- Execute queries manually and see their effect/results.
- See the history of executed by the app, and potentially re-execute them with some changes.
Currently, the only options to do so are:
- For execution, through a JDBC-level Dev UI -- which is a bit too low-level
- For query history, the logs.
I think a dedicated Dev UI interface could increase developer joy significantly, especially if we introduce additional features.
Initially it could be just about executing queries, like #43618. If we go that route we can move the query history + "extra" features to a follow-up issue.
A few "extra" features that come to mind (though we may not end up implementing all of them):
- More user-friendly display: e.g. show SQL and bind parameter values next to each other, instead of in separate log lines
- Easy export: "copy" buttons, e.g. raw SQL that can be executed directly on the DB.
- Replay: re-run HQL/SQL requests, possibly after a manual edit, and display results
- Context: show the stack trace that led to a particular query. Or maybe just rely on some OpenTelemetry tracing integration?
- Timing: how long did a given query take?
- Search: filter query history by datasource, sort by query time, ... Though that could require rather heavy infrastructure.
Implementation ideas
No response
Activity
quarkus-bot commentedon Mar 20, 2024
/cc @cescoffier (devui), @phillip-kruger (devui)
gsmet commentedon Mar 20, 2024
That would indeed be awesome.
If you can get the query time there too, I think it could have even more value.
[-]Dedicated Dev UI interface to list Hibernate requests (ORM or Search)[/-][+]Dedicated Dev UI interface to list Hibernate queries (ORM or Search)[/+][-]Dedicated Dev UI interface to list Hibernate queries (ORM or Search)[/-][+]Dedicated Dev UI interface to "log" executed Hibernate queries (ORM or Search)[/+][-]Dedicated Dev UI interface to "log" executed Hibernate queries (ORM or Search)[/-][+]Dedicated Dev UI interface to "log" (and replay/execute?) Hibernate queries (ORM or Search)[/+]yrodiere commentedon Feb 7, 2025
See #43618 for the Agroal (SQL) implementation, which will likely be similar
yrodiere commentedon Mar 10, 2025
FWIW @mbladel is working on a first iteration that is more focused on executing queries, similar to #43618 but for Hibernate ORM. There won't be any logging or re-execution features, but we can add them later.
@mbladel please comment here with a link to that PR when it's available -- even if it doesn't fix everything, it's worth tracking :)
[-]Dedicated Dev UI interface to "log" (and replay/execute?) Hibernate queries (ORM or Search)[/-][+]Dedicated Dev UI interface to execute (and "log"?) Hibernate ORM queries[/+]yrodiere commentedon Mar 10, 2025
I rephrased the description to have a more realistic plan (MVP with execution only, logs/other features later), and to move the Hibernate Search part to #46693.