Query Execution - Execute Query

Tjeneste:: Dataflow

API-versjon:: v1

Utfører en spørring mot en dataflyt og returnerer resultatet.
Utfører en angitt spørring mot en dataflyt og strømmer resultatet tilbake til anroperen. 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

Svarformater

Bruk toppteksten Accept til å forhandle om medietypen for svar. I dag er Apache Arrow streaming-formatet det eneste tilgjengelige svarformatet. flere formater kan bli tilbudt i fremtiden.

Apache Arrow-strømmingsformat

Medietype:application/vnd.apache.arrow.stream

Når du sender denne medietypen, kreves medietypeparameteren pq-arrow-version og velger pilkodingsversjonen:

pq-arrow-version=1 — Opprinnelig Apache-pilkoding. Kompatibel med alle dataflyter, inkludert de som kobler til via en lokal datagateway.
pq-arrow-version=2 — Nyere Apache Arrow-koding med forbedret strømmingsytelse. Støttes ikke for dataflyter som kobles til via en lokal datagateway.

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

Hvis toppteksten Accept utelates fullstendig (eller */* sendes), brukes svaret som standard.application/vnd.apache.arrow.stream;pq-arrow-version=1

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.

Topptekst for forespørsel

Navn	Obligatorisk	Type	Beskrivelse
Accept		string	Ønsket medietype for svaret. Se operasjonsbeskrivelsen for listen over støttede svarformater. I dag støttes bare `application/vnd.apache.arrow.stream` . Når du sender denne medietypen, kreves parameteren `pq-arrow-version` og må være enten `1` eller `2` (f.eks. `application/vnd.apache.arrow.stream;pq-arrow-version=1`). Hvis toppteksten utelates fullstendig, brukes standardverdien `application/vnd.apache.arrow.stream;pq-arrow-version=1` .

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 strømmet. Svarteksten er kodet i medietypen som er forhandlet frem via forespørselshodet (se operasjonsbeskrivelsen `Accept` for listen over støttede svarformater). Når svaret er i apachepilstrømmingsformatet (`application/vnd.apache.arrow.stream`det eneste formatet som er tilgjengelig i dag), strømmes resultatene som Apache Arrow IPC. Pilkodingsversjonen som returneres, samsvarer med parameteren `pq-arrow-version` som sendes på forespørselshodet `Accept` (standard `1`). 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 strømming, rapporteres i en ekstra kolonne på slutten med navnet PQ-pilmetadata.
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.
isRetriable	boolean	Når sann, kan forespørselen prøves på nytt. `Retry-After` Bruk svarhodet til å fastslå forsinkelsen, hvis tilgjengelig.
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).