QueryResult

class polars_cloud.QueryResult(result: QueryInfo, status: QueryStatus, query: DirectQuery | None = None)

The result of a Polars Cloud query.

Note

This object should not be instantiated directly by the user.

Attributes:

head	The first n rows of the result.
n_rows_total	Total rows that are outputted by the result.
total_stages	Get total planned stages of physical plan.
failed_stages	Total failed stages.
finished_stages	Total executed stages.
location	Location where the result is written.
file_type	The file type where the result is written to.

Methods:

await_profile	Await the query profile if direct mode is enabled.
await_profile_async	Await the query profile asynchronously if direct mode is enabled.
stage_statistics	Return the statistics of a specific stage.
lazy	Convert the QueryResult into a LazyFrame.

property head: DataFrame | None

The first n rows of the result.

property n_rows_total: int | None

Total rows that are outputted by the result.

property total_stages: int

Get total planned stages of physical plan.

property failed_stages: int

Total failed stages.

property finished_stages: int

Total executed stages.

This can be more than total stages, as failed stages can be rescheduled.

property location: list[str] | None

Location where the result is written.

property file_type: FileType

The file type where the result is written to.

await_profile() → QueryProfile

Await the query profile if direct mode is enabled.

async await_profile_async() → QueryProfile

Await the query profile asynchronously if direct mode is enabled.

stage_statistics(

stage_number: int | None = None,

) → StageStatistics | None | list[StageStatistics]

Return the statistics of a specific stage.

Parameters:

stage_number

if None this will give a list of stages.

lazy() → LazyFrame

Convert the QueryResult into a LazyFrame.