daft.DataFrame.explain

daft.DataFrame.explain#

DataFrame.explain(show_all: bool = False, format: str = 'ascii', simple: bool = False, file: Optional[IOBase] = None) Any[source]#

Prints the (logical and physical) plans that will be executed to produce this DataFrame. Defaults to showing the unoptimized logical plan. Use show_all=True to show the unoptimized logical plan, the optimized logical plan, and the physical plan.

Parameters:
  • show_all (bool) – Whether to show the optimized logical plan and the physical plan in addition to the unoptimized logical plan.

  • format (str) – The format to print the plan in. one of ‘ascii’ or ‘mermaid’

  • simple (bool) – Whether to only show the type of op for each node in the plan, rather than showing details of how each op is configured.

  • file (Optional[io.IOBase]) – Location to print the output to, or defaults to None which defaults to the default location for print (in Python, that should be sys.stdout)