databricks.koalas.DataFrame.spark.explain

spark.explain(extended: Optional[bool] = None, mode: Optional[str] = None) → None

Prints the underlying (logical and physical) Spark plans to the console for debugging purpose.

Parameters
extendedboolean, default False.

If False, prints only the physical plan.

modestring, default None.

The expected output format of plans.

Returns
None

Examples

>>> df = ks.DataFrame({'id': range(10)})
>>> df.spark.explain()  
== Physical Plan ==
...
>>> df.spark.explain(True)  
== Parsed Logical Plan ==
...
== Analyzed Logical Plan ==
...
== Optimized Logical Plan ==
...
== Physical Plan ==
...
>>> df.spark.explain("extended")  
== Parsed Logical Plan ==
...
== Analyzed Logical Plan ==
...
== Optimized Logical Plan ==
...
== Physical Plan ==
...
>>> df.spark.explain(mode="extended")  
== Parsed Logical Plan ==
...
== Analyzed Logical Plan ==
...
== Optimized Logical Plan ==
...
== Physical Plan ==
...