DataFrame.Explain Method

Definition

Namespace:

Microsoft.Spark.Sql

Assembly:

Microsoft.Spark.dll

Package:

Microsoft.Spark v1.0.0

Overloads

Explain(Boolean)	Prints the plans (logical and physical) to the console for debugging purposes.
Explain(String)	Prints the plans (logical and physical) with a format specified by a given explain mode.

Explain(Boolean)

Prints the plans (logical and physical) to the console for debugging purposes.

public void Explain (bool extended = false);

member this.Explain : bool -> unit

Public Sub Explain (Optional extended As Boolean = false)

Parameters

extended

Boolean

prints only physical if set to false

Explain(String)

Prints the plans (logical and physical) with a format specified by a given explain mode.

[Microsoft.Spark.Since("3.0.0")]
public void Explain (string mode);

[<Microsoft.Spark.Since("3.0.0")>]
member this.Explain : string -> unit

Public Sub Explain (mode As String)

Parameters

mode

String

Specifies the expected output format of plans. 1. simple Print only a physical plan. 2. extended: Print both logical and physical plans. 3. codegen: Print a physical plan and generated codes if they are available. 4. cost: Print a logical plan and statistics if they are available. 5. formatted: Split explain output into two sections: a physical plan outline and node details.

Attributes

SinceAttribute