Query Execution - Execute Query

Usługa:

Dataflow

Wersja interfejsu API:

v1

Wykonuje zapytanie względem przepływu danych i zwraca wynik.
Wykonuje określone zapytanie względem przepływu danych i przesyła strumieniowo wyniki w formacie Apache Arrow. Obsługuje używanie niestandardowych dokumentów mashup dla zaawansowanych scenariuszy.

Ten interfejs API obsługuje długotrwałych operacji (LRO).

Permissions

Obiekt wywołujący musi mieć uprawnienia do wykonywania dla przepływu danych.

Wymagane zakresy delegowane

Dataflow.Execute.All lub Item.Execute.All.

Ograniczenia

Zapytania mogą być uruchamiane przez maksymalnie 90 sekund.

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Tożsamość	Support
User	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
dataflowId	path	True	string (uuid)	Identyfikator przepływu danych.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.

Treść żądania

Nazwa	Wymagane	Typ	Opis
queryName	True	string	Nazwa zapytania do wykonania z przepływu danych (lub z niestandardowego dokumentu mashup, jeśli podano).
customMashupDocument		string	Opcjonalny niestandardowy dokument mashupu umożliwiający zastąpienie domyślnego mashupu przepływu danych.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	file	Wynik zapytania został pomyślnie napisany. Wyniki są przesyłane strumieniowo w formacie Apache Arrow. Zapoznaj się z dokumentacją strzałki , aby dowiedzieć się, jak odczytywać strumień w języku Python i innych językach. Błędy napotkane podczas wykonywania zapytania lub podczas przesyłania strumieniowego będą znajdować się w dodatkowej kolumnie na końcu o nazwie "Metadane strzałki PQ". Typ nośnika: "application/vnd.apache.arrow.stream"
202 Accepted		Żądanie zaakceptowane, wykonywanie zapytania w toku. Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: DataflowExecuteQueryError — wykonywanie zapytania nie powiodło się. Niektóre możliwe przyczyny to: określona nazwa zapytania jest nieprawidłowa lub pusta, niestandardowy dokument mashupu jest nieprawidłowy lub nie można odnaleźć określonej nazwy zapytania w przepływie danych (lub w niestandardowym dokumencie mashup, jeśli podano).

Definicje

Nazwa	Opis
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
ExecuteQueryRequest	Żądanie ładunku do wykonania zapytania względem przepływu danych.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType	string	Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

ExecuteQueryRequest

Objekt

Żądanie ładunku do wykonania zapytania względem przepływu danych.

Nazwa	Typ	Opis
customMashupDocument	string	Opcjonalny niestandardowy dokument mashupu umożliwiający zastąpienie domyślnego mashupu przepływu danych.
queryName	string	Nazwa zapytania do wykonania z przepływu danych (lub z niestandardowego dokumentu mashup, jeśli podano).