Query Execution - Execute Query

Tjeneste:

Dataflow

API-version:

v1

Udfører en forespørgsel mod et dataflow og returnerer resultatet.
Udfører en angivet forespørgsel mod et dataflow og streamer resultaterne i Apache Arrow-format. Understøtter brug af brugerdefinerede miksdokumenter til avancerede scenarier.

Denne API understøtter LRO-handlinger (Long Running Operations).

Tilladelser

Kalderen skal have kørselstilladelser til dataflowet.

Påkrævede delegerede områder

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

Begrænsninger

Forespørgsler kan maksimalt køre i 90 sekunder.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
dataflowId	path	True	string (uuid)	Dataflow-id'et.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Brødtekst for anmodning

Name	Påkrævet	Type	Beskrivelse
queryName	True	string	Navnet på den forespørgsel, der skal udføres fra dataflowet (eller fra det brugerdefinerede miksdokument, hvis det er angivet).
customMashupDocument		string	Valgfrit brugerdefineret miksdokument til at tilsidesætte dataflowets standard miks.

Svar

Name	Type	Beskrivelse
200 OK	file	Forespørgselsresultatet blev skrevet. Resultaterne streames i Apache Arrow-format. Se dokumentationen til Arrow for at få mere at vide om, hvordan du læser streamen i Python og andre sprog. Fejl, der opstår under udførelse af forespørgsler eller under streaming, vil være i en ekstra kolonne i slutningen med navnet 'PQ Arrow Metadata'. Medietype: "application/vnd.apache.arrow.stream"
202 Accepted		Anmodning accepteret, udførelse af forespørgsler er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: DataflowExecuteQueryError – Udførelse af forespørgsel mislykkedes. Nogle mulige årsager omfatter: Det angivne forespørgselsnavn er ugyldigt eller tomt, det brugerdefinerede miksdokument er ugyldigt, eller det angivne forespørgselsnavn blev ikke fundet i dataflowet (eller i det brugerdefinerede miksdokument, hvis det er angivet).

Definitioner

Name	Beskrivelse
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
ExecuteQueryRequest	Anmod om nyttedata for at udføre en forespørgsel mod et dataflow.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

ExecuteQueryRequest

Objekt

Anmod om nyttedata for at udføre en forespørgsel mod et dataflow.

Name	Type	Beskrivelse
customMashupDocument	string	Valgfrit brugerdefineret miksdokument til at tilsidesætte dataflowets standard miks.
queryName	string	Navnet på den forespørgsel, der skal udføres fra dataflowet (eller fra det brugerdefinerede miksdokument, hvis det er angivet).