Power Query: запросы и шаги

Жизненный цикл запросов, применённые шаги, параметры и навигация по папкам. Операций на странице: 13.

Жизненный цикл запросов, применённые шаги, параметры и навигация по папкам. Термины — в глоссарии.

Операции на этой странице — 13

commit_applied_step_edit
commit_power_query_load
delete_power_query
duplicate_power_query
list_power_query_definitions
mutate_applied_step
power_query_folder_navigator
power_query_parameter_manager
profile_applied_step_columns
project_applied_steps
reference_power_query
rename_power_query
save_power_query_definition

commit_applied_step_edit

Фиксирует applied step edit.

Запрос

Поле	Тип TypeScript	Обяз.
operation	`"commit_applied_step_edit"`	да
`mText`	string	да
`queryStableId`	string	нет
`stepId`	string	да
`canonicalM`	string	да
`editorSessionId`	string	нет
generation	number	нет
`requestedBackend`	ComputeBackendKind \| null	нет

Ответ при успехе · commit_applied_step_edit

Поле	Тип TypeScript	Обяз.
operation	`"commit_applied_step_edit"`	да
result	StepMutationResult	да

Минимальный JSON-шаблон

{
  "operation": "commit_applied_step_edit",
  "mText": "<string>",
  "stepId": "<string>",
  "canonicalM": "<string>",
  "requestedBackend": "native-desktop"
}

commit_power_query_load

Фиксирует power query load.

Запрос

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	`"commit_power_query_load"`	да
`subsetId`	string	да
`loadPlan`	PowerQueryLoadPlan	да
query	unknown	да	Opaque, secret-free Rust-owned persisted query record returned by evaluation.
`requestedBackend`	ComputeBackendKind \| null	нет

Ответ при успехе · commit_power_query_load

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	`"commit_power_query_load"`	да
`queryId`	string	да
`appliedEditCount`	number	да
`createdSheet`	boolean	да
`sheetKey`	string	нет
`staleClearCount`	number	да
projection	Extract< ComputeResponsePayload, { operation: `"open_workbook_subset"` } >	да	Состояние книги после применения правки, полученное в том же сеансе внутри одной неделимой операции.

Минимальный JSON-шаблон

{
  "operation": "commit_power_query_load",
  "subsetId": "<subsetId>",
  "loadPlan": "<PowerQueryLoadPlan>",
  "query": "<unknown>",
  "requestedBackend": "native-desktop"
}

delete_power_query

Запрос

Поле	Тип TypeScript	Обяз.
operation	“delete_power_query”	да
`subsetId`	string	да
`stableId`	string	да

Ответ при успехе · delete_power_query

Поле	Тип TypeScript	Обяз.
operation	“delete_power_query”	да
status	string	да
reason	string	нет
`removedDisplayName`	string	нет

Минимальный JSON-шаблон

{
  "operation": "delete_power_query",
  "subsetId": "<subsetId>",
  "stableId": "<stableId>"
}

duplicate_power_query

Запрос

Поле	Тип TypeScript	Обяз.
operation	“duplicate_power_query”	да
`subsetId`	string	да
`stableId`	string	да

Ответ при успехе · duplicate_power_query

Поле	Тип TypeScript	Обяз.
operation	“duplicate_power_query”	да
status	string	да
reason	string	нет
`newStableId`	string	нет
`newDisplayName`	string	нет

Минимальный JSON-шаблон

{
  "operation": "duplicate_power_query",
  "subsetId": "<subsetId>",
  "stableId": "<stableId>"
}

list_power_query_definitions

Запрос

Поле	Тип TypeScript	Обяз.
operation	“list_power_query_definitions”	да
`subsetId`	string	да

Ответ при успехе · list_power_query_definitions

Поле	Тип TypeScript	Обяз.
operation	“list_power_query_definitions”	да
queries	unknown[]	да

Минимальный JSON-шаблон

{
  "operation": "list_power_query_definitions",
  "subsetId": "<subsetId>"
}

mutate_applied_step

Изменяет applied step.

Запрос

Поле	Тип TypeScript	Обяз.
operation	`"mutate_applied_step"`	да
`mText`	string	да
`queryStableId`	string	нет
mutation	StepMutation	да
`editorSessionId`	string	нет
generation	number	нет
`requestedBackend`	ComputeBackendKind \| null	нет

Ответ при успехе · mutate_applied_step

Поле	Тип TypeScript	Обяз.
operation	`"mutate_applied_step"`	да
result	StepMutationResult	да

Минимальный JSON-шаблон

{
  "operation": "mutate_applied_step",
  "mText": "<string>",
  "mutation": "<StepMutation>",
  "requestedBackend": "native-desktop"
}

power_query_folder_navigator

Запрос

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	`"power_query_folder_navigator"`	да
action	string	да	“list-entries” \| “preview-entry” \| “preview-combined” \| “refresh” \| “package-ledger”
`sourceKind`	`"folder"` \| “json” \| “xml”	да
`rootUri`	string	да	Адрес папки в том же виде, что и в операции преобразования выше: `file:///путь` с параметрами `include`, `exclude` и `recursive`.
`entryId`	string	нет
`lineageJson`	string	нет
`savedDigest`	number	нет
`requestedBackend`	ComputeBackendKind \| null	нет

Ответ при успехе · power_query_folder_navigator

Поле	Тип TypeScript	Обяз.
operation	`"power_query_folder_navigator"`	да
outcome	FolderNavigatorOutcome	да

Минимальный JSON-шаблон

{
  "operation": "power_query_folder_navigator",
  "action": "<string>",
  "sourceKind": "folder",
  "rootUri": "<string>",
  "requestedBackend": "native-desktop"
}

power_query_parameter_manager

Запрос

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	`"power_query_parameter_manager"`	да
`subsetId`	string	да
action	string	да	One of “create” \| “edit” \| “rename” \| “duplicate” \| “delete” \| “list” \| “set-value”.
dto	ContractParameterDTO	нет	Полный объект: при `create` его идентификатор не учитывается, при `edit` значения полей заменяются целиком.
id	string	нет	Target parameter’s stable id; required by edit/rename/duplicate/delete/set-value.
name	string	нет	New display name; required by “rename”.
value	ContractParamValueRepr	нет	New current value; required by “set-value”.
`requestedBackend`	ComputeBackendKind \| null	нет

Ответ при успехе · power_query_parameter_manager

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	`"power_query_parameter_manager"`	да
status	string	да
reason	string \| null	нет
parameter	ContractParameterDTO \| null	нет	Параметр, к которому относилось действие или который оно создало. Нет в ответе при `list` и при отказе.
parameters	ContractParameterDTO[]	да	Every parameter currently registered, in stable creation order.
recomputed	ContractRecomputedQueryStatus[]	да	Есть в ответе, только если `edit` или `set-value` действительно изменили значение.
`dependencyGraph`	ContractDependencyGraphSnapshot \| null	нет

Минимальный JSON-шаблон

{
  "operation": "power_query_parameter_manager",
  "subsetId": "<subsetId>",
  "action": "<string>",
  "requestedBackend": "native-desktop"
}

profile_applied_step_columns

Профилирует applied step columns.

Запрос

Поле	Тип TypeScript	Обяз.
operation	`"profile_applied_step_columns"`	да
`mText`	string	да
`queryStableId`	string	нет
`stepId`	string	нет
`editorSessionId`	string	нет
generation	number	нет
`requestedBackend`	ComputeBackendKind \| null	нет

Ответ при успехе · profile_applied_step_columns

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	`"profile_applied_step_columns"`	да
profiled	boolean	да	`true`, если профиль удалось посчитать; `false`, если вычисление не прошло.
columns	ColumnProfile[]	да	По одному профилю на каждый столбец результата; пусто, если вычисление не прошло. Значения считает ядро, интерфейс их только показывает.
`rowCount`	number	да	Настоящее число строк результата, а не размер выборки.
sampled	boolean	да	`true`, если профиль построен не по всем строкам, а по началу результата: строк оказалось больше предела выборки.
`sampledRows`	number	да	Сколько строк вошло в профиль: либо все, либо предел выборки — что меньше.
`sampleCap`	number	да	Предел выборки строк, действовавший при этом проходе.
block	{ sourceId: string; mSource: string; reason: string; detail: string; }	нет	Причина, по которой профиль построить не удалось. Частичного профиля не бывает: либо он есть целиком, либо здесь стоит причина отказа.
session	EditorSessionStamp	нет	Отметка сеанса, возвращаемая в ответах, привязанных к сеансу. В вызовах без сеанса поля нет.

Минимальный JSON-шаблон

{
  "operation": "profile_applied_step_columns",
  "mText": "<string>",
  "requestedBackend": "native-desktop"
}

project_applied_steps

Проецирует applied steps.

Запрос

Поле	Тип TypeScript	Обяз.
operation	`"project_applied_steps"`	да
`mText`	string	да
`queryStableId`	string	нет
`editorSessionId`	string	нет
generation	number	нет
`requestedBackend`	ComputeBackendKind \| null	нет

Ответ при успехе · project_applied_steps

Поле	Тип TypeScript	Обяз.
operation	`"project_applied_steps"`	да
projection	AppliedStepsProjection	да

Минимальный JSON-шаблон

{
  "operation": "project_applied_steps",
  "mText": "<string>",
  "requestedBackend": "native-desktop"
}

reference_power_query

Запрос

Поле	Тип TypeScript	Обяз.
operation	“reference_power_query”	да
`subsetId`	string	да
`stableId`	string	да

Ответ при успехе · reference_power_query

Поле	Тип TypeScript	Обяз.
operation	“reference_power_query”	да
status	string	да
reason	string	нет
`newStableId`	string	нет
`newDisplayName`	string	нет
`upstreamStableId`	string	нет

Минимальный JSON-шаблон

{
  "operation": "reference_power_query",
  "subsetId": "<subsetId>",
  "stableId": "<stableId>"
}

rename_power_query

Запрос

Поле	Тип TypeScript	Обяз.
operation	“rename_power_query”	да
`subsetId`	string	да
`stableId`	string	да
`newDisplayName`	string	да

Ответ при успехе · rename_power_query

Поле	Тип TypeScript	Обяз.
operation	“rename_power_query”	да
status	string	да
reason	string	нет
`previousDisplayName`	string	нет
`newDisplayName`	string	нет

Минимальный JSON-шаблон

{
  "operation": "rename_power_query",
  "subsetId": "<subsetId>",
  "stableId": "<stableId>",
  "newDisplayName": "<newDisplayName>"
}

save_power_query_definition

Сохраняет power query definition.

Запрос

Поле	Тип TypeScript	Обяз.
operation	`"save_power_query_definition"`	да
`subsetId`	string	да
query	unknown	да
`boundDestinationSheetKey`	string	нет
`requestedBackend`	ComputeBackendKind \| null	нет

Ответ при успехе · save_power_query_definition

Поле	Тип TypeScript	Обяз.
operation	`"save_power_query_definition"`	да
status	string	да
reason	string	нет

Минимальный JSON-шаблон

{
  "operation": "save_power_query_definition",
  "subsetId": "<subsetId>",
  "query": "<unknown>",
  "requestedBackend": "native-desktop"
}