Skip to content

Feature: Visual Explain #138

@worksofliam

Description

@worksofliam

Part 1: API

  • API to install Dove SQL procedure on the server in QTEMP. Accepts the statement and which mode (run and explain or explain without running) and returns the VE flat data (this would be run once when the user tries to use VE)
  • New APIs in vscode-db2i to invoke new Server Component
  • Unit tests for new APIs

Part 2: UI

  • Write code to convert VE flat data from API to nodes (this code was written by Liam and shared with Dave so far)
  • Implement new tree view which is only shown when VE is run from the client. The nodes in the tree match the new node structure from the flat data
  • When a node is clicked on, show another view of panel with the details of that node
  • New buttons to run VE based on the current statement (similar to the current runner)
  • Highlight important nodes
  • User configurable highlighting
  • Node details section headings
  • Icons for different explain nodes
  • Show scrolling result set when 'run and explain' is used (waiting for Server Component change)
  • Node detail tree needs to use parent/child nodes, expanded by default
  • Display node detail tree on initial display of the node tree
  • Reposition node detail tree to top when selection is made in the node tree
  • VS Code settings for visual explain

Part 3: review

  • Review UI for nodes and node data
    • Meet with Ryan/Scott/Db people for opinions
    • Let them try have a vsix
    • Gather new requirements/changes based on feedback
  • Review code
  • Performance considerations

Part 4: extras

  • Highlighting priority
  • Import and export of node data (or flat data?)
  • Basic vs detail option in the Server Component
  • Minimum vs optimise in the Server Component

Metadata

Metadata

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions