Query Execution - Execute Query

Palvelu:: Dataflow

Ohjelmointirajapinnan versio:: v1

Suorittaa kyselyn tietovuota vastaan ja palauttaa tuloksen.
Suorittaa määritetyn kyselyn tietovuota vasten ja suoratoistaa tuloksen takaisin soittajalle. Tukee mukautettujen koosteasiakirjojen käyttöä edistyneissä skenaarioissa.

Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

Käyttöoikeudet

Kutsujalla on oltava tietovuon suoritusoikeudet .

Vaaditut delegoidut vaikutusalueet

Dataflow.Execute.All tai Item.Execute.All.

Rajoitukset

Kyselyitä voidaan suorittaa enintään 90 sekuntia.

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Vastausmuodot

Ylätunnisteen Accept avulla voit neuvotella vastauksen mediatyypin. Nykyisin Apache Arrow -suoratoistomuoto on ainoa käytettävissä oleva vastausmuoto; lisämuotoja saattaa olla tarjolla tulevaisuudessa.

Suoratoistettava Apache-nuolen muoto

Mediatyyppi:application/vnd.apache.arrow.stream

Mediatyyppiä pq-arrow-version lähetettäessä vaaditaan mediatyypin parametri ja valitaan arrow-koodausversio:

pq-arrow-version=1 — Alkuperäinen apache-nuolen koodaus. Yhteensopiva kaikkien tietovoiden kanssa, myös niiden, jotka muodostavat yhteyden paikallisen tietoyhdyskäytävän kautta.
pq-arrow-version=2 — Uudempi Apache-nuolikoodaus parannettu suoratoiston suorituskyvyllä. Ei tueta tietovoille, jotka muodostavat yhteyden paikallisen tietoyhdyskäytävän kautta.

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

Accept Jos otsikko jätetään kokonaan pois (tai */* lähetetään), vastauksen oletusarvo on application/vnd.apache.arrow.stream;pq-arrow-version=1.

Liittymä

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Kuvaus
dataflowId	path	True	string (uuid)	Tietovuon tunnus.
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Pyynnön otsikko

Nimi	Pakollinen	Tyyppi	Kuvaus
Accept		string	Vastauksen haluttu mediatyyppi. Katso tuettujen vastausmuotojen luettelo toiminnon kuvauksesta. Nykyisin vain `application/vnd.apache.arrow.stream` tuetaan; kun lähetät tämän mediatyypin, `pq-arrow-version` parametri on pakollinen ja sen on oltava joko `1` tai `2` (esim. `application/vnd.apache.arrow.stream;pq-arrow-version=1`). Jos otsikko jätetään kokonaan pois, käytetään oletusarvoa `application/vnd.apache.arrow.stream;pq-arrow-version=1` .

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Kuvaus
queryName	True	string	Tietovuosta suoritettavan kyselyn nimi (tai tarvittaessa mukautetusta koosteasiakirjasta).
customMashupDocument		string	Valinnainen mukautettu koostetiedosto, joka ohittaa tietovuon oletuskoostamisen.

Vastaukset

Nimi	Tyyppi	Kuvaus
200 OK	file	Kyselyn tulos virtautettiin onnistuneesti. Vastauksen elin on koodattu pyynnön `Accept` otsikon kautta neuvotellun mediatyypin mukaan (katso tuettujen vastausmuotojen luettelon toiminnan kuvaus). Kun vastaus on suoratoistettavassa Apache-nuolen muodossa (`application/vnd.apache.arrow.stream`joka on ainoa tällä hetkellä käytettävissä oleva muoto), tulokset suoratoistaa muodossa Apache Arrow IPC. Palautettu nuolen koodausversio vastaa `pq-arrow-version` pyynnön `Accept` otsikossa lähetettyä parametria (oletus `1`). Katso nuolidokumentaatiosta , miten voit lukea suoratoiston Pythonissa ja muissa kielissä. Kyselyn suorittamisen tai suoratoiston aikana havaitut virheet ilmoitetaan lopussa olevassa lisäsarakkeessa nimeltä PQ-nuolen metatiedot.
202 Accepted		Pyyntö hyväksytty, kyselyn suorittaminen on meneillään. Otsikot Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka `Retry-After` ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: DataflowExecuteQueryError – Kyselyn suorittaminen epäonnistui. Mahdollisia syitä ovat esimerkiksi seuraavat: määritetty kyselyn nimi on virheellinen tai tyhjä, mukautettu koostetiedosto on virheellinen tai määritettyä kyselyn nimeä ei löytynyt tietovuosta (tai mukautetusta koosteasiakirjasta, jos sellainen on annettu).

Määritelmät

Nimi	Kuvaus
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
ExecuteQueryRequest	Pyynnön tiedot kyselyn suorittamiseksi tietovuosta.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Kuvaus
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable	boolean	Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon `Retry-After` avulla, jos se on käytettävissä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Kuvaus
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

ExecuteQueryRequest

Kohde

Pyynnön tiedot kyselyn suorittamiseksi tietovuosta.

Nimi	Tyyppi	Kuvaus
customMashupDocument	string	Valinnainen mukautettu koostetiedosto, joka ohittaa tietovuon oletuskoostamisen.
queryName	string	Tietovuosta suoritettavan kyselyn nimi (tai tarvittaessa mukautetusta koosteasiakirjasta).