Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove simple explain and refactor explain #1570

Open
shahzadlone opened this issue Jun 12, 2023 · 0 comments
Open

Remove simple explain and refactor explain #1570

shahzadlone opened this issue Jun 12, 2023 · 0 comments
Assignees
Labels
area/planner Related to the planner system feature New feature or request refactor This issue specific to or requires *notable* refactoring of existing codebases and components

Comments

@shahzadlone
Copy link
Member

We currently have:

@explain
@explain(type: execute)
@explain(type: debug)
@explain(type: simple)
  • We want to remove the explicit simple explain as the default should do the basic explain stuff.
  • Remove all type arguments.

Instead we want to have:

@explain
  • Returns simple explain with all explainable nodes and their attributes.
@explain(debug: true)
  • Returns simple explain with all explainable nodes and their attributes
  • With extra internal nodes.
@explain(execute: true)
  • Returns simple explain with all explainable nodes and their attributes
  • With additional execute metrics for all explainable nodes.
@explain(execute: true, debug: true)
  • Returns simple explain with all explainable nodes and their attributes
  • With additional execute metrics for all explainable nodes.
  • With extra internal nodes.

Ability to hide attributes

@explain(execute: true, debug: true, hideAttributes: true)
  • Returns simple explain with all explainable nodes (without their attributes).
  • With additional execute metrics for all explainable nodes.
  • With extra internal nodes.
@explain(debug: true, hideAttributes: true)
  • Returns simple explain with all explainable nodes (without their attributes).
  • With extra internal nodes.
@explain(execute: true, hideAttributes: true)
  • Returns simple explain with all explainable nodes (without their attributes).
  • With additional execute metrics for all explainable nodes.
@explain(hideAttributes: true)
  • Returns simple explain with all explainable nodes (without their attributes).
@shahzadlone shahzadlone added feature New feature or request refactor This issue specific to or requires *notable* refactoring of existing codebases and components area/planner Related to the planner system labels Jun 12, 2023
@shahzadlone shahzadlone self-assigned this Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/planner Related to the planner system feature New feature or request refactor This issue specific to or requires *notable* refactoring of existing codebases and components
Projects
None yet
Development

No branches or pull requests

1 participant