Query Execution - Execute Query

Tjeneste:

Dataflow

API-versjon:

v1

Utfører en spørring mot en dataflyt og returnerer resultatet.
Kjører en angitt spørring mot en dataflyt og strømmer resultatene i Apache Arrow-format. Støtter bruk av egendefinerte mashup-dokumenter for avanserte scenarioer.

Denne API-en støtter langvarige operasjoner (LRO).

Tillatelser

Innringeren må ha kjøretillatelser for dataflyten.

Nødvendige delegerte omfang

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

Begrensninger

Spørringer kan kjøre i maksimalt 90 sekunder.

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	Kundestøtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
dataflowId	path	True	string (uuid)	Dataflyt-IDen.
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.

Brødtekst for forespørsel

Navn	Obligatorisk	Type	Beskrivelse
queryName	True	string	Navnet på spørringen som skal kjøres fra dataflyten (eller fra det egendefinerte mashup-dokumentet hvis angitt).
customMashupDocument		string	Valgfritt egendefinert mashup-dokument for å overstyre dataflytens standard mashup.

Svar

Navn	Type	Beskrivelse
200 OK	file	Spørringsresultatet ble skrevet på en vellykket måte. Resultatene strømmes i Apache-pilformat. Se arrow-dokumentasjonen om hvordan du leser strømmen på Python og andre språk. Det oppstod feil under kjøring av spørring eller under strømming, vil være i en ekstra kolonne på slutten med navnet PQ-pilmetadata. Medietype: «application/vnd.apache.arrow.stream»
202 Accepted		Forespørsel godtatt, kjøring av spørring pågår. Overskrifter Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: DataflowExecuteQueryError – kjøring av spørring mislyktes. Noen mulige årsaker inkluderer: Det angitte spørringsnavnet er ugyldig eller tomt, det egendefinerte mashup-dokumentet er ugyldig, eller det angitte spørringsnavnet ble ikke funnet i dataflyten (eller i det egendefinerte mashup-dokumentet hvis angitt).

Definisjoner

Navn	Beskrivelse
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
ExecuteQueryRequest	Be om nyttelast for å kjøre en spørring mot en dataflyt.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

ExecuteQueryRequest

Objekt

Be om nyttelast for å kjøre en spørring mot en dataflyt.

Navn	Type	Beskrivelse
customMashupDocument	string	Valgfritt egendefinert mashup-dokument for å overstyre dataflytens standard mashup.
queryName	string	Navnet på spørringen som skal kjøres fra dataflyten (eller fra det egendefinerte mashup-dokumentet hvis angitt).