polars_nanook.ExecuteRemote.explain#

ExecuteRemote.explain(
*,
plan_stage: PlanType = 'physical',
optimizations: QueryOptFlags = <polars.lazyframe.opt_flags.QueryOptFlags object>,
silent: bool | None = None,
) → str#

Plan the query on the compute cluster without executing it.

The query is sent to the cluster and planned there, but no data is read and no output is written. The rendered plan is returned as a string.

Note

This can only be called in ‘direct’ mode.

Parameters:
plan_stage{‘physical’, ‘ir’}

Which plan to return.

  • physical: The distributed physical plan/stages.

  • ir: The optimized query plan. Stops before distributed planning, so no physical plan is built.

optimizations

The optimization passes done during query optimization.

silent

Don’t print to stdout while waiting for the plan.

Examples

>>> print(query.remote(ctx).explain())  
>>> print(query.remote(ctx).explain(plan_stage="ir"))