Query Execution - Execute Query

服务:: Dataflow

API 版本:: v1

针对数据流执行查询并返回结果。
针对数据流执行指定的查询，并使用 Apache Arrow 格式流式传输结果。支持对高级方案使用自定义混合文档。

此 API 支持长时间运行的作（LRO）。

Permissions

调用方必须具有数据流 的执行 权限。

所需的委派范围

Dataflow.Execute.All 或 Item.Execute.All。

局限性

查询最多可以运行 90 秒。

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份	Support
用户	是的
服务主体和托管标识	是的

接口

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/executeQuery

URI 参数

名称	在	必需	类型	说明
dataflowId	path	True	string (uuid)	数据流 ID。
workspaceId	path	True	string (uuid)	工作区 ID。

请求正文

名称	必需	类型	说明
queryName	True	string	要从数据流执行的查询的名称（或自定义混合文档（如果提供）。
customMashupDocument		string	可选自定义混合文档以替代数据流的默认混合。

响应

名称	类型	说明
200 OK	file	查询结果已成功写入。结果以 Apache Arrow 格式流式传输。请参阅箭头文档，了解如何使用 Python 和其他语言阅读流。在查询执行期间或流式处理期间遇到的错误将位于名为“PQ 箭头元数据”的末尾的其他列中。媒体类型：“application/vnd.apache.arrow.stream”
202 Accepted		请求接受，正在进行查询执行。标头 Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	超出服务速率限制。服务器返回一个 `Retry-After` 标头，指示客户端在发送其他请求之前必须等待的时间（以秒为单位）。标头 Retry-After: integer
Other Status Codes	ErrorResponse	常见错误代码： DataflowExecuteQueryError - 查询执行失败。一些可能的原因包括：指定的查询名称无效或为空，自定义混搭文档无效，或指定的查询名称未在数据流中找到（或自定义混合文档（如果提供）。

定义

名称	说明
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ExecuteQueryRequest	请求针对数据流执行查询的有效负载。

ErrorRelatedResource

对象

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

对象

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string (uuid)	与错误关联的请求的 ID。

ErrorResponseDetails

对象

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

ExecuteQueryRequest

对象

请求针对数据流执行查询的有效负载。

名称	类型	说明
customMashupDocument	string	可选自定义混合文档以替代数据流的默认混合。
queryName	string	要从数据流执行的查询的名称（或自定义混合文档（如果提供）。

通过