Query Execution - Execute Query

Service:

Dataflow

API-versie:

v1

Voert een query uit op een gegevensstroom en retourneert het resultaat.
Voert een opgegeven query uit op een gegevensstroom en streamt de resultaten in Apache Arrow-indeling. Ondersteunt het gebruik van aangepaste mashup-documenten voor geavanceerde scenario's.

Deze API ondersteunt langlopende bewerkingen (LRO).

Permissions

De aanroeper moet machtigingen hebben voor het uitvoeren van de gegevensstroom.

Vereiste gedelegeerde bereiken

Dataflow.Execute.All of Item.Execute.All.

Beperkingen

Query's kunnen maximaal 90 seconden worden uitgevoerd.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identiteit	Support
User	Yes
serviceprincipal en beheerde identiteiten	Yes

gebruikersinterface

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

URI-parameters

Name	In	Vereist	Type	Description
dataflowId	path	True	string (uuid)	De gegevensstroom-id.
workspaceId	path	True	string (uuid)	De werkruimte-ID.

Aanvraagbody

Name	Vereist	Type	Description
queryName	True	string	De naam van de query die moet worden uitgevoerd vanuit de gegevensstroom (of vanuit het aangepaste mashup-document, indien opgegeven).
customMashupDocument		string	Optioneel aangepast mashup-document om de standaard mashup van de gegevensstroom te overschrijven.

Antwoorden

Name	Type	Description
200 OK	file	Het queryresultaat is geschreven. Resultaten worden gestreamd in Apache Arrow-indeling. Raadpleeg de pijldocumentatie over het lezen van de stream in Python en andere talen. Fouten die zijn opgetreden tijdens het uitvoeren van query's of tijdens het streamen, worden weergegeven in een extra kolom aan het einde met de naam 'PQ Arrow Metadata'. Mediatype: "application/vnd.apache.arrow.stream"
202 Accepted		Aanvraag geaccepteerd, uitvoering van query's wordt uitgevoerd. Kopteksten Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	De servicesnelheidslimiet is overschreden. De server retourneert een Retry-After header die in seconden aangeeft hoe lang de client moet wachten voordat extra aanvragen worden verzonden. Kopteksten Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: DataflowExecuteQueryError : de uitvoering van query's is mislukt. Enkele mogelijke redenen zijn: de opgegeven querynaam is ongeldig of leeg, het aangepaste mashup-document is ongeldig of de opgegeven querynaam is niet gevonden in de gegevensstroom (of in het aangepaste mashup-document, indien opgegeven).

Definities

Name	Description
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
ExecuteQueryRequest	Nettolading aanvragen voor het uitvoeren van een query op een gegevensstroom.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string (uuid)	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

ExecuteQueryRequest

Object

Nettolading aanvragen voor het uitvoeren van een query op een gegevensstroom.

Name	Type	Description
customMashupDocument	string	Optioneel aangepast mashup-document om de standaard mashup van de gegevensstroom te overschrijven.
queryName	string	De naam van de query die moet worden uitgevoerd vanuit de gegevensstroom (of vanuit het aangepaste mashup-document, indien opgegeven).