Kankaan ohjelmointirajapinta GraphQL-skeemanäkymälle ja skeemojen hallintaan

GraphQL:n Fabric API generoi automaattisesti skeeman, joka määrittelee API:n rakenteen yhdistämiesi tietolähteiden perusteella. Skeema, joka on kirjoitettu GraphQL Schema Definition Language (SDL) -kielellä, kuvaa kaikki saatavilla olevat tyypit, kentät, kyselyt ja mutaatiot, joita asiakkaat voivat käyttää datasi kanssa vuorovaikutukseen.

Skeemanäkymä tarjoaa vain luku -pohjaisen, tekstipohjaisen näkymän koko GraphQL-skeemastasi, kun taas vasemman paneelin skeemaresurssi antaa sinun navigoida, tarkastella ja muokata API:n kautta paljastettuja objekteja. Yhdessä nämä työkalut auttavat sinua ymmärtämään API:n rakennetta ja hallitsemaan, mitä dataa asiakkaat voivat käyttää.

Kuka käyttää skeemanäkymää

Skeemanäkymä ja tutkimusmatkaaja ovat arvokkaita:

Data-insinöörit määrittävät, mitkä Fabric, lakehouse- ja varastoobjektit GraphQL:n kautta avataan
Sovelluskehittäjät löytävät saatavilla olevat Fabric-tietotyypit, kentät ja suhteet ennen kyselyiden kirjoittamista
Fabric-työtilan avustajat ymmärtävät ja hallinnoivat työtilansa datan käyttörakenteen
BI-kehittäjät tarkastelevat Fabric-tietosuhteita rakentaessaan räätälöityjä analytiikkasovelluksia

Käytä skeemanäkymää API:n rakenteen tutkimiseen ja skeemaresurssia muokkaamaan, mitkä dataobjektit ovat paljastettuja.

Pääsy ja skeeman tutkiminen

Voit käyttää skeemanäkymää joko kyselyeditorista tai suoraan GraphQL API -elementistäsi. Avataksesi skeemanäkymän, valitse Schema vasemmasta alakulmasta. Skeemanäkymä näyttää vain luku -pohjaisen, tekstipohjaisen version koko GraphQL SDL:stäsi kaikkine generoiduine tyyppeineen, kenttineen, kyselyineen ja mutaatioineen.

Seuraava kuva näyttää skeemanäkymän, jossa Schema Explorer -paneeli on vasemmalla:

Navigoi skeema-explorerilla

Vasemman paneelin Schema Explorer antaa sinun navigoida ja tarkastella kaikkia API:n objekteja. Explorer on saatavilla sekä skeemanäkymässä että kyselyeditorissa, mikä helpottaa API-rakenteen tutkimista kyselyitä kirjoittaessa.

Laajenna solmuja skeematutkimusohjelmassa nähdäksesi:

Tyypit: GraphQL-tyypit, jotka on luotu tietolähdetaulukoistasi ja näkymistäsi
Kyselyt: Automaattisesti luodut lukuoperaatiot datan noutoon
Mutaatiot: Automaattisesti luodut kirjoitusoperaatiot datan luomiseen, päivittämiseen ja poistamiseen (vain varastossa)

Tyypit

Tyypit edustavat datan rakennetta ja esiintyvät sen tietolähteen nimen alla, josta ne on tuotettu. Seuraava kuva näyttää SalesOrderDetail-tyypin , joka on luotu SalesOrderDetail-taulukostaAdventureWorks SQL-analytiikan päätepisteessä:

Kyselyt

API generoi automaattisesti kyselyt datan noutamista varten niistä objekteista, joita avaat. Laajenna kyselysolmua nähdäksesi kaikki saatavilla olevat lukutoiminnot:

Mutaatiot

Mutaatiot ovat kirjoitusoperaatioita datan luomiseen, päivittämiseen ja poistamiseen. Laajenna mutaatiosolmua nähdäksesi kaikki saatavilla olevat kirjoitustoiminnot:

Muistiinpano

Mutaatioita luodaan vain Fabric Data Warehouse -tietolähteille. SQL Analytics -päätelaitteet (Lakehouses ja peilatut tietokannat) ovat vain luku -lukua ja tukevat vain kyselyitä. Jos et näe mutaatioita Schema Explorerissasi, varmista, että olet yhdistänyt Fabric Data Warehouseen.

Objektien muokkaaminen rakenteen hallinnan avulla

Kun API on luonut alkuperäisen skeemasi, voit käyttää skeemaresurssinhallintaohjelmaa tarkentaaksesi API:n kautta paljastettua sisältöä. Skeemaresurssien hallintatyökalu tarjoaa hallintavaihtoehtoja, joiden avulla voit hallita API:n rakennetta muuttamatta taustalla olevia tietolähteitä. Nämä työkalut ovat välttämättömiä puhtaan ja hyvin organisoidun API:n ylläpitämiseksi, joka paljastaa vain asiakkaidesi tarvitsemat tiedot.

Pääsyn muokkausvaihtoehdot

Objektin muokkaamiseksi valitse kolmen pisteen (...) vierestä minkä tahansa tyypin skeemaresurssissa. Seuraava esimerkki näyttää SalesOrderDetail-tyypin muokkausvalikon:

Saatavilla olevat muokkausvaihtoehdot

Päivitysskeema – Synkronoi GraphQL-skeemasi tietolähteen uusimpaan rakenteeseen. Käytä tätä, kun olet lisännyt uusia taulukoita, näkymiä tai sarakkeita tietolähteeseesi ja haluat avata ne API:n kautta. Tämä toiminto löytää ja lisää uusia objekteja säilyttäen samalla olemassa olevan kokoonpanosi.

Uudelleennimeä – Muuttaa sitä, miten objekti näkyy GraphQL API:ssasi. Tämä on hyödyllistä intuitiivisempien API-nimikäytäntöjen luomisessa tai toteutuksen yksityiskohtien piilottamisessa asiakkailta. Esimerkiksi voit nimetä tbl_SalesOrderDetail sen uudelleen yksinkertaisesti SalesOrderDetailmuotoon . Uudelleennimi vaikuttaa vain API-skeemaan eikä muuta taustalla olevaa tietolähdeobjektia.

Poista skeemasta – Poistaa objektin GraphQL API:sta, jolloin se ei ole asiakkaiden saatavilla. Käytä tätä arkaluonteisten tietojen piilottamiseen, vanhentuneiden objektien poistamiseen tai API-pinnan yksinkertaistamiseen. Data pysyy tietolähteessäsi; vain API-altistus poistetaan.

Hallinnoi suhteita – Avaa suhteiden hallintarajapinnan, jossa voit määritellä, miten objektit yhdistyvät toisiinsa. Suhteet mahdollistavat sisäkkäiset kyselyt ja graafien läpikäynnin, jolloin asiakkaat voivat hakea liittyvää dataa yhdellä pyynnöllä. Lisätietoja on artikkelissa Suhteiden hallinta Fabric-ohjelmointirajapinnassa GraphQL:lle.

Ominaisuudet – Näyttää yksityiskohtaiset metatiedot objektista, mukaan lukien alkuperäinen nimi tietolähteessä, GraphQL-tyypin nimi, omistaja ja sijainti (työtilan ja tietolähteen nimi). Käytä tätä varmistaaksesi, miten objektit ovat kartoitettu tietolähteesi ja GraphQL API:n välillä.

Kyselyjen ja mutaatioiden ottaminen käyttöön ja poistaminen käytöstä

Kyselyiden ja mutaatioiden Ota käyttöön tai poista käytöstä -ominaisuus antaa järjestelmänvalvojille ja kehittäjille yksityiskohtaisen hallinnan ohjelmointirajapinnan käyttöön ja käyttöön. Sen avulla voit aktivoida tai poistaa tiettyjen kyselyjen ja mutaatioiden aktivoinnin tai deaktivoinnin GraphQL-rakenteessa. Tämän avulla voit hallita ohjelmointirajapinnan ominaisuuksia dynaamisesti muokkaamatta koodia tai ottamalla käyttöön muutoksia.

Käytä tätä ominaisuutta tilanteissa kuten:

API-versiointi: Poista käytöstä vanhentuneet toiminnot samalla kun asiakkaat siirretään uusiin versioihin
Ylläpitoikkunat: Poista kirjoitustoiminnot (mutaatiot) tilapäisesti käytöstä datan ylläpidon aikana
Turvallisuus ja vaatimustenmukaisuus: Rajoita pääsyä arkaluontoisiin operaatioihin poistamatta niitä skeemasta
Vaiheittaiset käyttöönotot: Ota käyttöön uudet kyselyt tai mutaatiot testattavaksi ennen niiden laajaa saatavuutta

Skemanhallinnan kyselyillä ja mutaatioilla on kaksi muuta vaihtoehtoa:

Poista käytöstä: Estää pyyntöjä suorittamasta kyselyä tai mutaatiota. Jos suoritusta yritetään, palautetaan virhe. Kun kysely tai mutaatio on poistettu käytöstä, rakenne ladataan uudelleen ja kysely tai mutaatio näkyy harmaana rakenteen hallinnassa.

Ota käyttöön: Voit ottaa aiemmin käytöstä poistetun kyselyn tai mutaation uudelleen käyttöön. Kysely tai mutaatio on heti käytettävissä rakenteen uudelleenlataustoiminnon jälkeen, joka tapahtuu, kun valitset Ota käyttöön -vaihtoehdon.