polars.explain_all

polars.explain_all(
    lazy_frames: Iterable[LazyFrame],
    *,
    optimizations: QueryOptFlags = (,
), ) → str

Explain multiple LazyFrames as if passed to collect_all.

Common Subplan Elimination is applied on the combined plan, meaning that diverging queries will run only once.

Parameters:

lazy_frames

A list of LazyFrames to collect.

optimizations

The optimization passes done during query optimization.

Warning

This functionality is considered unstable. It may be changed at any point without it being considered a breaking change.

Returns:

Explained plan.