HyukjinKwon commented on a change in pull request #26903:
[SPARK-30200][DOCS][FOLLOW-UP] Add documentation for explain(mode: String)
URL: https://github.com/apache/spark/pull/26903#discussion_r358070696
##########
File path: sql/core/src/main/scala/org/apache/spark/sql/Dataset.scala
##########
@@ -524,6 +524,16 @@ class Dataset[T] private[sql](
/**
* Prints the plans (logical and physical) with a format specified by a
given explain mode.
*
+ * @param mode specifies the expected output format of plans.
+ * <ul>
+ * <li>`simple` Print only a physical plan.</li>
+ * <li>`extended`: Print both logical and physical plans.</li>
+ * <li>`codegen`: Print a physical plan and generated codes if
they are
+ * available.</li>
+ * <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>
Review comment:
This is matched to Python side doc added FYI.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
