Query Execution - Execute Query

Tjänst:: Dataflow

API-version:: v1

Kör en fråga mot ett dataflöde och returnerar resultatet.
Kör en angiven fråga mot ett dataflöde och strömmar resultatet tillbaka till anroparen. Stöder användning av anpassade kombinationsdokument för avancerade scenarier.

Det här API:et stöder tidskrävande åtgärder (LRO).

Permissions

Anroparen måste ha körningsbehörigheter för dataflödet.

Obligatoriska delegerade omfång

Dataflow.Execute.All eller Item.Execute.All.

Begränsningar

Frågor kan köras i högst 90 sekunder.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Support
User	Yes
Tjänsthuvudnamn och hanterade identiteter	Yes

Svarsformat

Accept Använd rubriken för att förhandla om svarsmedietypen. I dag är Apache Arrow-strömningsformatet det enda tillgängliga svarsformatet. ytterligare format kan erbjudas i framtiden.

Apache Arrow-strömningsformat

Medietyp:application/vnd.apache.arrow.stream

När du skickar den här medietypen krävs parametern pq-arrow-version av medietyp och väljer pilkodningsversionen:

pq-arrow-version=1 — Ursprunglig Apache Arrow-kodning. Kompatibel med alla dataflöden, inklusive de som ansluter via en lokal datagateway.
pq-arrow-version=2 — Nyare Apache Arrow-kodning med bättre strömningsprestanda. Stöds inte för dataflöden som ansluter via en lokal datagateway.

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

Accept Om rubriken utelämnas helt (eller */* skickasapplication/vnd.apache.arrow.stream;pq-arrow-version=1) är svaret som standard .

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
dataflowId	path	True	string (uuid)	Dataflödes-ID:t.
workspaceId	path	True	string (uuid)	Arbetsyte-ID.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Accept		string	Den önskade medietypen av svaret. Se åtgärdsbeskrivningen för listan över svarsformat som stöds. I dag stöds endast `application/vnd.apache.arrow.stream` . När du skickar den här medietypen krävs parametern `pq-arrow-version` och måste vara antingen `1` eller `2` (t.ex. `application/vnd.apache.arrow.stream;pq-arrow-version=1`). Om rubriken utelämnas helt används standardvärdet `application/vnd.apache.arrow.stream;pq-arrow-version=1` .

Begärandetext

Name	Obligatorisk	Typ	Description
queryName	True	string	Namnet på frågan som ska köras från dataflödet (eller från det anpassade kombinationsdokumentet om det tillhandahålls).
customMashupDocument		string	Valfritt anpassat kombinationsdokument för att åsidosätta dataflödets standardsammanslagning.

Svar

Name	Typ	Description
200 OK	file	Frågeresultatet har strömmats. Svarstexten kodas i medietypen som förhandlas fram via begärandehuvudet (se åtgärdsbeskrivningen `Accept` för listan över svarsformat som stöds). När svaret är i Apache Arrow-strömningsformatet (`application/vnd.apache.arrow.stream`det enda format som är tillgängligt i dag) strömmas resultaten som Apache Arrow IPC. Pilkodningsversionen som returneras matchar parametern `pq-arrow-version` som skickas i begärandehuvudet `Accept` (standard `1`). Läs Arrow-dokumentationen om hur du läser strömmen i Python och andra språk. Fel som påträffas vid frågekörning eller strömning rapporteras i ytterligare en kolumn i slutet med namnet "PQ Arrow Metadata".
202 Accepted		Begäran accepterad, frågekörning pågår. Sidhuvuden Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: DataflowExecuteQueryError – Frågekörningen misslyckades. Några möjliga orsaker är: det angivna frågenamnet är ogiltigt eller tomt, det anpassade kombinationsdokumentet är ogiltigt eller så hittades inte det angivna frågenamnet i dataflödet (eller i det anpassade kombinationsdokumentet om det tillhandahålls).

Definitioner

Name	Description
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
ExecuteQueryRequest	Begär nyttolast för att köra en fråga mot ett dataflöde.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable	boolean	När det är sant kan begäran göras på nytt. Använd svarshuvudet `Retry-After` för att fastställa fördröjningen, om den är tillgänglig.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

ExecuteQueryRequest

Objekt

Begär nyttolast för att köra en fråga mot ett dataflöde.

Name	Typ	Description
customMashupDocument	string	Valfritt anpassat kombinationsdokument för att åsidosätta dataflödets standardsammanslagning.
queryName	string	Namnet på frågan som ska köras från dataflödet (eller från det anpassade kombinationsdokumentet om det tillhandahålls).