Skip to content

[SPARK-30200][DOCS][FOLLOW-UP] Add documentation for explain(mode: String)#26903

Closed
HyukjinKwon wants to merge 1 commit intoapache:masterfrom
HyukjinKwon:SPARK-30200-doc
Closed

[SPARK-30200][DOCS][FOLLOW-UP] Add documentation for explain(mode: String)#26903
HyukjinKwon wants to merge 1 commit intoapache:masterfrom
HyukjinKwon:SPARK-30200-doc

Conversation

@HyukjinKwon
Copy link
Member

What changes were proposed in this pull request?

This PR adds the documentation of the new mode added to Dataset.explain.

Why are the changes needed?

To let users know the new modes.

Does this PR introduce any user-facing change?

No (doc-only change).

How was this patch tested?

Manually built the doc:
Screen Shot 2019-12-16 at 3 34 28 PM

* <li>`cost`: Print a logical plan and statistics if they are available.</li>
* <li>`formatted`: Split explain output into two sections: a physical plan outline
* and node details.</li>
* </ul>
Copy link
Member Author

Choose a reason for hiding this comment

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

This is matched to Python side doc added FYI.

@SparkQA
Copy link

SparkQA commented Dec 16, 2019

Test build #115378 has finished for PR 26903 at commit f47a255.

  • This patch fails due to an unknown error code, -9.
  • This patch merges cleanly.
  • This patch adds no public classes.

@wangyum
Copy link
Member

wangyum commented Dec 16, 2019

retest this please

@SparkQA
Copy link

SparkQA commented Dec 16, 2019

Test build #115382 has finished for PR 26903 at commit f47a255.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@HyukjinKwon
Copy link
Member Author

Merged to master.

@HyukjinKwon HyukjinKwon deleted the SPARK-30200-doc branch March 3, 2020 01:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants