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 het resultaat terug naar de aanroeper. 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

Antwoordindelingen

Gebruik de Accept header om te onderhandelen over het type antwoordmedia. Vandaag is de streaming-indeling van Apache Arrow de enige beschikbare antwoordindeling. er kunnen in de toekomst extra indelingen worden aangeboden.

Streaming-indeling van Apache Arrow

Mediatype:application/vnd.apache.arrow.stream

Wanneer u dit mediatype verzendt, is de pq-arrow-version parameter mediatype vereist en selecteert u de coderingsversie pijl:

• pq-arrow-version=1 — Oorspronkelijke Apache Arrow-codering. Compatibel met alle gegevensstromen, inclusief gegevensstromen die verbinding maken via een on-premises gegevensgateway.
• pq-arrow-version=2 — Nieuwere Apache Arrow-codering met verbeterde streamingprestaties. Niet ondersteund voor gegevensstromen die verbinding maken via een on-premises gegevensgateway.

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

Als de Accept header volledig wordt weggelaten (of */* wordt verzonden), wordt het antwoord standaard ingesteld op application/vnd.apache.arrow.stream;pq-arrow-version=1.

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.

Aanvraagkoptekst

Name	Vereist	Type	Description
Accept		string	Het gewenste mediatype van de respons. Zie de beschrijving van de bewerking voor de lijst met ondersteunde antwoordindelingen. Tegenwoordig wordt alleen application/vnd.apache.arrow.stream ondersteund; wanneer u dit mediatype verzendt, is de parameter vereist en moet deze pq-arrow-version zijn 1 of 2 (bijvoorbeeld application/vnd.apache.arrow.stream;pq-arrow-version=1). Als de koptekst volledig wordt weggelaten, wordt de standaardwaarde application/vnd.apache.arrow.stream;pq-arrow-version=1 gebruikt.

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 gestreamd. De hoofdtekst van het antwoord wordt gecodeerd in het mediatype dat is onderhandeld via de header van Accept de aanvraag (zie de beschrijving van de bewerking voor de lijst met ondersteunde antwoordindelingen). Wanneer het antwoord de streaming-indeling van Apache Arrow heeft (application/vnd.apache.arrow.streamde enige indeling die momenteel beschikbaar is), worden de resultaten gestreamd als Apache Arrow IPC. De geretourneerde versie van de pijlcodering komt overeen met de pq-arrow-version parameter die is verzonden in de header van Accept de aanvraag (standaard 1). Raadpleeg de pijldocumentatie over het lezen van de stream in Python en andere talen. Fouten die zijn opgetreden tijdens het uitvoeren of streamen van query's, worden gerapporteerd in een extra kolom aan het einde met de naam 'PQ Arrow Metadata'.
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.
isRetriable	boolean	Wanneer waar, kan de aanvraag opnieuw worden geprobeerd. Gebruik de Retry-After antwoordheader om de vertraging te bepalen, indien beschikbaar.
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).