sql/ui: add tooltips to explain plans in db console #61764
Comments
awoods187
added
the
C-enhancement
|
Right now we still show the logical plan in db-console correct? So adding tooltips to the explain would rely on us updating the logical plan tab to the new explain plan? |
|
The logical plan in the db-console is pretty much the new explain plan, it's just formatted differently. |
|
As an aside, we should probably update the explain in the db console to match the SQL shell as much as possible. This item is about adding tooltips in the db console for defining what a span is, or an index, or distributed, vectorized, etc. Similarly, this could be an option in the SQL shell via verbose but I think its less needed. |
|
Designs for adding tooltips to the Explain Plan in the DB console can be found here (cc @maryliag): https://www.figma.com/file/MoSPFkEyJfGipCmQvvLg1a/21.1_SQL-obsrv_query-performance?node-id=2727%3A118388 @kevin-v-ngo @ianjevans I think we'll need your help defining which keywords to add tooltips for and what the messaging should be. Note: These designs include a style and structural update to the current Logical Plan visualized in the DB console. This design aligns with the latest Explain plans in the SQL shell (this may need a separate ticket). We should also name this tab 'Explain plan' rather than 'Logical plan' to stay consistent with the SQL shell. Let me know any thoughts. |
|
Created the issue for matching the format at #67328 |
kevin-v-ngo
changed the title
Resolves: cockroachdb#61764 This commit adds tooltips to explain plan operators and node attributes, providing more information to explain plans. Release justification: low-risk, high benefit changes to existing functionality Release note (ui change): On the explain plan tab in statement details, Users will be able to hover over underlined explain plan attributes to get tooltips with more information on the attribute.
Resolves: cockroachdb#61764 This commit adds tooltips to explain plan operators and node attributes, providing more information to explain plans. Release justification: low-risk, high benefit changes to existing functionality Release note (ui change): On the explain plan tab in statement details, Users will be able to hover over underlined explain plan attributes to get tooltips with more information on the attribute.
Resolves: cockroachdb#61764 This commit adds tooltips to explain plan operators and node attributes, providing more information to explain plans. Release justification: low-risk, high benefit changes to existing functionality Release note (ui change): On the explain plan tab in statement details, Users will be able to hover over underlined explain plan attributes to get tooltips with more information on the attribute.
Resolves: cockroachdb#61764 This commit adds tooltips to explain plan operators and node attributes, providing more information to explain plans. Release justification: low-risk, high benefit changes to existing functionality Release note (ui change): On the explain plan tab in statement details, Users will be able to hover over underlined explain plan attributes to get tooltips with more information on the attribute.
Resolves: cockroachdb#61764 This commit adds tooltips to explain plan operators and node attributes, providing more information to explain plans. Release justification: low-risk, high benefit changes to existing functionality Release note (ui change): On the explain plan tab in statement details, Users will be able to hover over underlined explain plan attributes to get tooltips with more information on the attribute.
70441: importccl: fix test for duplicate collated string primary keys r=rhu713 a=rhu713 Previously the test for duplicate collated string primary keys had an incorrectly formed CSV as the test data. This change fixes the test data by adding the collation to all of the rows in the CSV. Release note: None 70540: build: fix incorrect argument name when checking container memory limits r=AlexTalks a=AlexTalks This change fixes a typo where when checking if a build failed due to the Docker container memory limits being too low, the script checked for `xmkrelease` instead of `mkrelease`. This caused developers to potentially fail builds (for example, with MacOS Docker resource defaults) without realizing the reason why. Release note: None 70568: cluster-ui: add tooltips to explain plan r=Azhng,maryliag,matthewtodd a=xinhaoz Resolves: #61764 This commit adds tooltips to explain plan operators and node attributes, providing more information to explain plans. Release justification: low-risk, high benefit changes to existing functionality Release note (ui change): On the explain plan tab in statement details, Users will be able to hover over underlined explain plan attributes to get tooltips with more information on the attribute. -----------------------------------------------------------------------   Co-authored-by: Rui Hu <[email protected]> Co-authored-by: Alex Sarkesian <[email protected]> Co-authored-by: Xin Hao Zhang <[email protected]>
Resolves: #61764 This commit adds tooltips to explain plan operators and node attributes, providing more information to explain plans. Release justification: low-risk, high benefit changes to existing functionality Release note (ui change): On the explain plan tab in statement details, Users will be able to hover over underlined explain plan attributes to get tooltips with more information on the attribute.
|
Hi @xinhaoz, please add branch-* labels to identify which branch(es) this release-blocker affects. 🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is otan. |
@RaduBerinde outlined a proposal today to help others better understand EXPLAIN. EXPLAIN plans contain a lot of information. It can confusing to consume them directly. It would be great if we could provide tooltips in the DB Console for the various parts of explain and also in the SQL Shell (via verbose mode?).
cc @Annebirzin
The text was updated successfully, but these errors were encountered: