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

doc: update EXPLAIN PLAN docs #22195

Merged
merged 1 commit into from
Oct 5, 2023

Conversation

aalexandrov
Copy link
Contributor

@aalexandrov aalexandrov commented Oct 5, 2023

Update the docs to add the newly supported syntax introduced in some recently merged PRs (#21708, #21973, and #22021).

Motivation

  • This PR adds a known-desirable feature.

We want to document the EXPLAIN syntax extensions that landed in the past weeks (they are all live in prod as of today).

Tips for reviewer

The changes are exclusively in the EXPLAIN PLAN docs page. Here is a direct preview link.

Checklist

  • This PR has adequate test coverage / QA involvement has been duly considered.
  • This PR has an associated up-to-date design doc, is a design doc (template), or is sufficiently small to not require a design.
  • If this PR evolves an existing $T ⇔ Proto$T mapping (possibly in a backwards-incompatible way), then it is tagged with a T-proto label.
  • If this PR will require changes to cloud orchestration or tests, there is a companion cloud PR to account for those changes that is tagged with the release-blocker label (example).
  • This PR includes the following user-facing behavior changes:
    • The EXPLAIN syntax now supports CREATE MATERIALIZED VIEW and CREATE INDEX statement types as well as a humanized_exprs flag that can be used to produce more readable EXPLAIN AS TEXT output.

@aalexandrov aalexandrov added A-docs Area: documentation A-optimization Area: query optimization and transformation A-compute Area: compute labels Oct 5, 2023
@aalexandrov aalexandrov requested a review from morsapaes October 5, 2023 13:16
@aalexandrov aalexandrov requested a review from a team as a code owner October 5, 2023 13:16
@aalexandrov aalexandrov self-assigned this Oct 5, 2023
@aalexandrov aalexandrov force-pushed the update_explain_docs branch 4 times, most recently from 1551ff4 to 59bc77c Compare October 5, 2023 13:25
Update the docs to add the newly supported syntax introduced in
some recently merged PRs (MaterializeInc#21708, MaterializeInc#21973, and MaterializeInc#22021).
Copy link
Contributor

@morsapaes morsapaes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @aalexandrov!

@aalexandrov aalexandrov merged commit eadc695 into MaterializeInc:main Oct 5, 2023
@aalexandrov aalexandrov deleted the update_explain_docs branch October 5, 2023 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-compute Area: compute A-docs Area: documentation A-optimization Area: query optimization and transformation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants