Query Execution - Execute Query

Palvelu:

Dataflow

Ohjelmointirajapinnan versio:

v1

Suorittaa kyselyn tietovuota vastaan ja palauttaa tuloksen.
Suorittaa määritetyn kyselyn tietovuota vastaan ja suoratoistaa tulokset Apache Arrow -muodossa. 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ä

Liittymä

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

URI-parametrit

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

Pyynnön leipäteksti

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

Vastaukset

Nimi	Tyyppi	Description
200 OK	file	Kyselyn tulos kirjoitettiin moitteettomasti. Tulokset suoratoistaa Apache Arrow -muodossa. Katso nuolidokumentaatiosta , miten voit lukea suoratoiston Pythonissa ja muissa kielissä. Kyselyn suorittamisen tai suoratoiston aikana havaitut virheet ovat lisäsarakkeessa nimeltä PQ-nuolen metatiedot. Mediatyyppi: "application/vnd.apache.arrow.stream"
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	Description
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	Description
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Description
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ä.
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	Description
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	Description
customMashupDocument	string	Valinnainen mukautettu koostetiedosto, joka ohittaa tietovuon oletuskoostamisen.
queryName	string	Tietovuosta suoritettavan kyselyn nimi (tai tarvittaessa mukautetusta koosteasiakirjasta).