Query Execution - Execute Query

서비스:: Dataflow

API 버전:: v1

데이터 흐름에 대해 쿼리를 실행하고 결과를 반환합니다.
데이터 흐름에 대해 지정된 쿼리를 실행하고 결과를 호출자에게 다시 스트리밍합니다. 고급 시나리오에 사용자 지정 매시업 문서 사용을 지원합니다.

이 API는 LRO(장기 실행 작업)지원합니다.

Permissions

호출자에게 데이터 흐름에 대한 실행 권한이 있어야 합니다.

필요한 위임된 범위

Dataflow.Execute.All 또는 Item.Execute.All.

제한점

쿼리는 최대 90초 동안 실행할 수 있습니다.

Microsoft Entra 지원 식별자

이 API는 이 섹션에 나열된 Microsoft ID 지원합니다.

아이덴티티	Support
사용자	Yes
서비스 주체 및 관리 ID	Yes

응답 형식

헤더를 Accept 사용하여 응답 미디어 형식을 협상합니다. 현재 Apache 화살표 스트리밍 형식은 사용 가능한 유일한 응답 형식입니다. 추가 형식은 나중에 제공될 수 있습니다.

Apache 화살표 스트리밍 형식

미디어 유형:application/vnd.apache.arrow.stream

이 미디어 형식을 pq-arrow-version 보낼 때 미디어 형식 매개 변수가 필요하며 화살표 인코딩 버전을 선택합니다.

pq-arrow-version=1 — 원래 Apache 화살표 인코딩. 온-프레미스 데이터 게이트웨이를 통해 연결하는 데이터 흐름을 포함하여 모든 데이터 흐름과 호환됩니다.
pq-arrow-version=2 - 향상된 스트리밍 성능을 갖춘 최신 Apache 화살표 인코딩. 온-프레미스 데이터 게이트웨이를 통해 연결하는 데이터 흐름에는 지원되지 않습니다.

예: Accept: application/vnd.apache.arrow.stream;pq-arrow-version=2

헤더가 Accept 완전히 */* 생략되거나 전송되는 경우 응답의 기본값은 .입니다 application/vnd.apache.arrow.stream;pq-arrow-version=1.

인터페이스

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
dataflowId	path	True	string (uuid)	데이터 흐름 ID입니다.
workspaceId	path	True	string (uuid)	작업 영역 ID입니다.

요청 헤더

Name	필수	형식	Description
Accept		string	원하는 미디어 유형의 반응. 지원되는 응답 형식 목록은 작업 설명을 참조하세요. 현재는 이 미디어 형식만 `application/vnd.apache.arrow.stream` 지원됩니다. 이 미디어 형식을 `pq-arrow-version` 보낼 때는 매개 변수가 필요하며 매개 변수 중 하나 `1` 이거나 `2` (예: `application/vnd.apache.arrow.stream;pq-arrow-version=1`)여야 합니다. 헤더를 완전히 생략하면 기본값 `application/vnd.apache.arrow.stream;pq-arrow-version=1` 이 사용됩니다.

요청 본문

Name	필수	형식	Description
queryName	True	string	데이터 흐름에서 실행할 쿼리의 이름입니다(또는 제공된 경우 사용자 지정 매시업 문서에서).
customMashupDocument		string	데이터 흐름의 기본 매시업을 재정의하는 선택적 사용자 지정 매시업 문서입니다.

응답

Name	형식	Description
200 OK	file	쿼리 결과가 성공적으로 스트리밍되었습니다. 응답 본문은 요청의 `Accept` 헤더를 통해 협상된 미디어 형식으로 인코딩됩니다(지원되는 응답 형식 목록에 대한 작업 설명 참조). 응답이 Apache 화살표 스트리밍 형식(`application/vnd.apache.arrow.stream`현재 사용 가능한 유일한 형식)인 경우 결과는 Apache Arrow IPC로 스트리밍됩니다. 반환된 화살표 인코딩 버전은 요청의 `Accept` 헤더(기본값`1`)에서 보낸 매개 변수와 일치 `pq-arrow-version` 합니다. Python 및 기타 언어로 스트림을 읽는 방법에 대한 화살표 설명서를 참조하세요. 쿼리 실행 또는 스트리밍 중에 발생한 오류는 'PQ 화살표 메타데이터'라는 끝에 있는 추가 열에 보고됩니다.
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 - 쿼리 실행이 실패했습니다. 몇 가지 가능한 원인으로는 지정된 쿼리 이름이 잘못되었거나 비어 있거나, 사용자 지정 매시업 문서가 잘못되었거나, 데이터 흐름에서 지정한 쿼리 이름을 찾을 수 없습니다(제공된 경우 사용자 지정 매시업 문서).

정의

Name	Description
ErrorRelatedResource	오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse	오류 응답입니다.
ErrorResponseDetails	오류 응답 세부 정보입니다.
ExecuteQueryRequest	데이터 흐름에 대해 쿼리를 실행하기 위한 페이로드를 요청합니다.

ErrorRelatedResource

Object

오류 관련 리소스 세부 정보 개체입니다.

Name	형식	Description
resourceId	string	오류와 관련된 리소스 ID입니다.
resourceType	string	오류와 관련된 리소스의 형식입니다.

ErrorResponse

Object

오류 응답입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
isRetriable	boolean	true이면 요청을 다시 시도 할 수 있습니다. 응답 헤더를 `Retry-After` 사용하여 가능한 경우 지연을 확인합니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
moreDetails	ErrorResponseDetails[]	추가 오류 세부 정보 목록입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.
requestId	string (uuid)	오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

Object

오류 응답 세부 정보입니다.

Name	형식	Description
errorCode	string	오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message	string	사용자가 읽을 수 있는 오류 표현입니다.
relatedResource	ErrorRelatedResource	오류 관련 리소스 세부 정보입니다.

ExecuteQueryRequest

Object

데이터 흐름에 대해 쿼리를 실행하기 위한 페이로드를 요청합니다.

Name	형식	Description
customMashupDocument	string	데이터 흐름의 기본 매시업을 재정의하는 선택적 사용자 지정 매시업 문서입니다.
queryName	string	데이터 흐름에서 실행할 쿼리의 이름입니다(또는 제공된 경우 사용자 지정 매시업 문서에서).