QueryProgress#

class polars_cloud.QueryProgress(id: 'UUID', inner: 'pcr.QueryProgressPy')

Attributes:

`total_stages`	Get total planned stages of physical plan.
`data`	Get the raw progress data.
`summary`	Get a summary of the progress of the query.

Methods:

`graph`	Return the query plan as dot diagram.
`plan`	Return the executed physical plan in string format.

property total_stages: int | None: Get total planned stages of physical plan.

graph( *, show: bool = True, output_path: str | Path | None = None, raw_output: bool = False, figsize: tuple[float, float] = (16.0, 12.0), ) → str | None

Return the query plan as dot diagram.

Parameters:

show: Show the figure.
output_path: Write the figure to disk.
raw_output: Return dot syntax. This cannot be combined with show and/or output_path.
figsize: Passed to matplotlib if show == True.

plan() → str: Return the executed physical plan in string format.

property data: DataFrame | None: Get the raw progress data.

property summary: DataFrame | None: Get a summary of the progress of the query.