Class QueryPlanEntry (3.22.0)

Version 3.22.0

• 3.27.0 (latest)
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.1
• 3.22.0
• 3.21.0
• 3.20.1
• 3.19.0
• 3.18.0
• 3.17.2
• 3.16.0
• 3.15.0
• 3.14.1
• 3.13.0
• 3.12.0
• 3.11.4
• 3.4.0
• 3.3.6
• 3.2.0
• 3.1.0
• 3.0.1
• 2.34.4
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.1
• 2.29.0
• 2.28.1
• 2.27.1
• 2.26.0
• 2.25.2
• 2.24.1
• 2.23.3
• 2.22.1
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.2
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.0
• 2.1.0
• 2.0.0
• 1.28.2
• 1.27.2
• 1.26.1
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0

QueryPlanEntry()

QueryPlanEntry represents a single stage of a query execution plan.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#ExplainQueryStage for the underlying API representation within query statistics.

Properties

completed_parallel_inputs

Optional[int]: Number of parallel input segments completed.

compute_ms_avg

Optional[int]: Milliseconds the average worker spent on CPU-bound processing.

compute_ms_max

Optional[int]: Milliseconds the slowest worker spent on CPU-bound processing.

compute_ratio_avg

Optional[float]: Ratio of time the average worker spent on CPU-bound processing, relative to the longest time spent by any worker in any stage of the overall plan.

compute_ratio_max

Optional[float]: Ratio of time the slowest worker spent on CPU-bound processing, relative to the longest time spent by any worker in any stage of the overall plan.

end

Optional[Datetime]: Datetime when the stage ended.

entry_id

Optional[str]: Unique ID for the stage within the plan.

input_stages

List(int): Entry IDs for stages that were inputs for this stage.

name

Optional[str]: Human-readable name of the stage.

parallel_inputs

Optional[int]: Number of parallel input segments within the stage.

read_ms_avg

Optional[int]: Milliseconds the average worker spent reading input.

read_ms_max

Optional[int]: Milliseconds the slowest worker spent reading input.

read_ratio_avg

Optional[float]: Ratio of time the average worker spent reading input, relative to the longest time spent by any worker in any stage of the overall plan.

read_ratio_max

Optional[float]: Ratio of time the slowest worker spent reading to be scheduled, relative to the longest time spent by any worker in any stage of the overall plan.

records_read

Optional[int]: Number of records read by this stage.

records_written

Optional[int]: Number of records written by this stage.

shuffle_output_bytes

Optional[int]: Number of bytes written by this stage to intermediate shuffle.

shuffle_output_bytes_spilled

Optional[int]: Number of bytes written by this stage to intermediate shuffle and spilled to disk.

slot_ms

Optional[int]: Slot-milliseconds used by the stage.

start

Optional[Datetime]: Datetime when the stage started.

status

Optional[str]: status of this stage.

steps

List(QueryPlanEntryStep): List of step operations performed by each worker in the stage.

wait_ms_avg

Optional[int]: Milliseconds the average worker spent waiting to be scheduled.

wait_ms_max

Optional[int]: Milliseconds the slowest worker spent waiting to be scheduled.

wait_ratio_avg

Optional[float]: Ratio of time the average worker spent waiting to be scheduled, relative to the longest time spent by any worker in any stage of the overall plan.

wait_ratio_max

Optional[float]: Ratio of time the slowest worker spent waiting to be scheduled, relative to the longest time spent by any worker in any stage of the overall plan.

write_ms_avg

Optional[int]: Milliseconds the average worker spent writing output data.

write_ms_max

Optional[int]: Milliseconds the slowest worker spent writing output data.

write_ratio_avg

Optional[float]: Ratio of time the average worker spent writing output data, relative to the longest time spent by any worker in any stage of the overall plan.

write_ratio_max

Optional[float]: Ratio of time the slowest worker spent writing output data, relative to the longest time spent by any worker in any stage of the overall plan.

Methods

from_api_repr

from_api_repr(resource: dict) -> google.cloud.bigquery.job.query.QueryPlanEntry

Factory: construct instance from the JSON repr.

Returns
Type	Description
google.cloud.bigquery.job.QueryPlanEntry	Query plan entry parsed from resource.