polars.LazyFrame.show_graph#
- LazyFrame.show_graph(
- *,
- optimized: bool = True,
- show: bool = True,
- output_path: str | Path | None = None,
- raw_output: bool = False,
- figsize: tuple[float, float] = (16.0, 12.0),
- engine: EngineType = 'auto',
- plan_stage: PlanStage = 'physical',
- optimizations: QueryOptFlags = (),
Show a plot of the query plan.
Note that Graphviz must be installed to render the visualization (if not already present, you can download it here: https://graphviz.org/download).
- Parameters:
- optimized
Optimize the query plan.
- show
Show the figure.
- output_path
Write the figure to disk.
- raw_output
Return dot syntax. This cannot be combined with
showand/oroutput_path.- figsize
Passed to matplotlib if
show == True.- engine
Select the engine used to process the query (default
"auto"). AEngineinstance may also be passed. Supported engine names are:"auto": use the engine set byConfig.set_engine_affinityor thePOLARS_ENGINE_AFFINITYenvironment variable, falling back to"streaming"if unset."in-memory": use the in-memory engine."streaming": use the streaming engine, which processes queries in batches, reducing memory pressure and often outperforming the in-memory engine."gpu": use the CUDA GPU engine (requires an Nvidia GPU andcudf-polars). Pass aGPUEngineobject for fine-grained control (e.g. device selection on multi-GPU systems).
If the selected engine cannot run the query, Polars falls back to the in-memory engine.
Note
GPU mode is considered unstable. Not all queries will run successfully on the GPU, however, they should fall back transparently to the default engine if execution is not supported.
Running with
POLARS_VERBOSE=1will provide information if a query falls back (and why).- plan_stage{‘ir’, ‘physical’}
Select the stage to display. Currently only the streaming engine has a separate physical stage, for the other engines both IR and physical are the same.
- optimizations
The set of the optimizations considered during query optimization.
Examples
>>> lf = pl.LazyFrame( ... { ... "a": ["a", "b", "a", "b", "b", "c"], ... "b": [1, 2, 3, 4, 5, 6], ... "c": [6, 5, 4, 3, 2, 1], ... } ... ) >>> lf.group_by("a", maintain_order=True).agg(pl.all().sum()).sort( ... "a" ... ).show_graph()