Power Query: execution and progress

The query graph, refreshing, cancellation, and monitoring long-running operations. Terms are in the glossary.

Operations on this page — 9

• pq-query-graph-cancel
• pq-query-graph-explain
• pq-query-graph-refresh
• pq-query-graph-snapshot
• pq-scale-progress-cancel
• pq-scale-progress-close
• pq-scale-progress-open
• pq-scale-progress-pull
• pq-scale-progress-snapshot

pq-query-graph-cancel

Cancels a query-graph analysis that’s already started.

Request

Field	TypeScript type	Req.
operation	"pq-query-graph-cancel"	yes
generation	number	yes
subset_id	string	no

Response on success · pq-query-graph-cancel

Field	TypeScript type	Req.
operation	"pq-query-graph-cancel"	yes
outcome	PqQueryGraphRefreshOutcome	yes

Minimal JSON template

{
  "operation": "pq-query-graph-cancel",
  "generation": 0,
  "requestedBackend": "native-desktop"
}

pq-query-graph-explain

Explains why the graph looks the way it does: where a query’s dependency comes from.

Request

Field	TypeScript type	Req.
operation	"pq-query-graph-explain"	yes
query_stable_id	string	yes
subset_id	string	no

Response on success · pq-query-graph-explain

Field	TypeScript type	Req.
operation	"pq-query-graph-explain"	yes
explain	PqQueryGraphExplain	yes

Minimal JSON template

{
  "operation": "pq-query-graph-explain",
  "query_stable_id": "<string>",
  "requestedBackend": "native-desktop"
}

pq-query-graph-refresh

Refreshes the query graph after an edit.

Request

Field	TypeScript type	Req.
operation	"pq-query-graph-refresh"	yes
scope	"current" | “all” | string	yes
query_stable_id	string	no
subset_id	string	no
user_store_levels	{ canonicalScope: string; level: string; invalid?: boolean; }[]	no

Response on success · pq-query-graph-refresh

Field	TypeScript type	Req.
operation	"pq-query-graph-refresh"	yes
outcome	PqQueryGraphRefreshOutcome	yes
committed	boolean	yes
publications	PqQueryGraphNodePublication[]	no

Minimal JSON template

{
  "operation": "pq-query-graph-refresh",
  "scope": "current",
  "requestedBackend": "native-desktop"
}

pq-query-graph-snapshot

A snapshot of the query graph: which queries exist and how they depend on each other.

Request

Field	TypeScript type	Req.
operation	"pq-query-graph-snapshot"	yes
subset_id	string	no

Response on success · pq-query-graph-snapshot

Field	TypeScript type	Req.
operation	"pq-query-graph-snapshot"	yes
snapshot	PqQueryGraphSnapshot	yes

Minimal JSON template

{
  "operation": "pq-query-graph-snapshot",
  "requestedBackend": "native-desktop"
}

pq-scale-progress-cancel

Stops a refresh that’s in progress.

Request

Field	TypeScript type	Req.
operation	"pq-scale-progress-cancel"	yes
session_id	string	yes

Response on success · pq-scale-progress-cancel

Field	TypeScript type	Req.
operation	"pq-scale-progress-cancel"	yes
outcome	PqScaleProgressCancelPayload	no
denied	PqScaleDenied	no

Minimal JSON template

{
  "operation": "pq-scale-progress-cancel",
  "session_id": "<string>",
  "requestedBackend": "native-desktop"
}

pq-scale-progress-close

Closes progress monitoring.

Request

Field	TypeScript type	Req.
operation	"pq-scale-progress-close"	yes
session_id	string	yes

Response on success · pq-scale-progress-close

Field	TypeScript type	Req.
operation	"pq-scale-progress-close"	yes
closed	boolean	yes

Minimal JSON template

{
  "operation": "pq-scale-progress-close",
  "session_id": "<string>",
  "requestedBackend": "native-desktop"
}

pq-scale-progress-open

Opens progress monitoring for a long Power Query refresh.

Request

Field	TypeScript type	Req.
operation	"pq-scale-progress-open"	yes
rows_requested	number	no
max_batch_rows	number	no

Response on success · pq-scale-progress-open

Field	TypeScript type	Req.
operation	"pq-scale-progress-open"	yes
session	PqScaleProgressOpenPayload	yes
denied	PqScaleDenied	no

Minimal JSON template

{
  "operation": "pq-scale-progress-open",
  "requestedBackend": "native-desktop"
}

pq-scale-progress-pull

Retrieves the progress information collected so far.

Request

Field	TypeScript type	Req.
operation	"pq-scale-progress-pull"	yes
session_id	string	yes

Response on success · pq-scale-progress-pull

Field	TypeScript type	Req.
operation	"pq-scale-progress-pull"	yes
progress	PqScaleProgressPullPayload	no
denied	PqScaleDenied	no

Minimal JSON template

{
  "operation": "pq-scale-progress-pull",
  "session_id": "<string>",
  "requestedBackend": "native-desktop"
}

pq-scale-progress-snapshot

A snapshot of progress at the current moment.

Request

Field	TypeScript type	Req.
operation	"pq-scale-progress-snapshot"	yes
session_id	string	yes

Response on success · pq-scale-progress-snapshot

Field	TypeScript type	Req.
operation	"pq-scale-progress-snapshot"	yes
snapshot	PqScaleProgressSnapshotPayload	no
denied	PqScaleDenied	no

Minimal JSON template

{
  "operation": "pq-scale-progress-snapshot",
  "session_id": "<string>",
  "requestedBackend": "native-desktop"
}