Fabric API GraphQL-sémanézethez és sémakezelőhöz

A GraphQL-hez készült Fabric API automatikusan létrehoz egy sémát, amely meghatározza az API struktúráját a csatlakozó adatforrások alapján. A GraphQL sémadefiníciós nyelven (SDL) írt séma az összes elérhető típust, mezőt, lekérdezést és mutációt ismerteti, amelyet az ügyfelek használhatnak az adatok kezeléséhez.

A sémanézet írásvédett, szöveges nézetet biztosít a teljes GraphQL-sémáról, míg a bal oldali panel sémakezelője lehetővé teszi az API-n keresztül közzétett objektumok navigálását, vizsgálatát és módosítását. Ezek az eszközök együttesen segítenek megérteni az API struktúráját, és szabályozni, hogy milyen adatok érhetők el az ügyfelek számára.

Ki használja a sémanézetet?

A sémavázlat nézet és a felderítő értékes a következő célokra:

Az adatmérnökök konfigurálják, hogy mely Fabric lakehouse- és raktárobjektumokat tegyék elérhetővé a GraphQL-ben
Az alkalmazásfejlesztők a lekérdezések írása előtt felfedezik az elérhető Fabric-adattípusokat, mezőket és kapcsolatokat
A Fabric munkaterület közreműködői megértik és kezelik a munkaterület adathozzáférési struktúráját
A Fabric-adatkapcsolatokat felülvizsgáló BI-fejlesztők egyéni elemzési alkalmazások létrehozásakor

A sémanézetben megismerheti az API struktúráját és a sémakezelőt annak módosításához, hogy mely adatobjektumok legyenek közzétéve.

A séma elérése és felfedezése

A sémanézetet a lekérdezésszerkesztőből vagy közvetlenül a GraphQL API-elemből érheti el. A sémanézet megnyitásához válassza a Séma lehetőséget a bal alsó sarokban. A sémanézet a teljes GraphQL SDL írásvédett, szövegalapú verzióját jeleníti meg az összes létrehozott típussal, mezővel, lekérdezéssel és mutációval.

Az alábbi képen a sémanézet látható, bal oldalon a Sémakezelő panellel:

Navigálás a sémakezelővel

A bal oldali panel Sémakezelője segítségével navigálhat és megvizsgálhatja az API összes objektumát. Az Explorer a sémanézetben és a lekérdezésszerkesztőben is elérhető, így a lekérdezések írása során könnyen felfedezhető az API-struktúra.

Bontsa ki a csomópontokat a sémakezelőben a megtekintéshez:

Típusok: Az adatforrástáblákból és nézetekből létrehozott GraphQL-típusok
Lekérdezések: Automatikusan létrehozott olvasási műveletek az adatok beolvasásához
Mutációk: Automatikusan létrehozott írási műveletek az adatok létrehozásához, frissítéséhez és törléséhez (csak a raktárban)

Types

A típusok az adatok struktúráját jelölik, és annak az adatforrásnak a neve alatt jelennek meg, amelyből létrehozták őket. Az alábbi képen az AdventureWorks SQL Analytics-végpont SalesOrderDetail táblájából létrehozott SalesOrderDetail típus látható:

Lekérdezések

Az API automatikusan lekérdezéseket hoz létre az adatok lekéréséhez a felfedett objektumokból. Bontsa ki a lekérdezési csomópontot az összes elérhető olvasási művelet megtekintéséhez:

Mutációk

Az írási műveletek, mint például az adatok létrehozása, frissítése és törlése, a mutációk közé tartoznak. Bontsa ki a mutációs csomópontot az összes elérhető írási művelet megtekintéséhez:

Feljegyzés

A mutációk csak Fabric Data Warehouse-adatforrásokhoz jönnek létre. Az SQL analitikai végpontok (lakehouse és tükrözött adatbázisok) csak olvashatóak és csak támogatják a lekérdezéseket. Ha nem látsz mutációkat a séma felfedeződben, ellenőrizd, hogy csatlakoztál-e raktárhoz.

Objektumok módosítása a sémakezelővel

Miután az API létrehozta a kezdeti sémát, a sémakezelővel pontosíthatja az API-val közzétett adatokat. A sémakezelő olyan felügyeleti lehetőségeket biztosít, amelyekkel az API struktúráját az alapul szolgáló adatforrások módosítása nélkül szabályozhatja. Ezek az eszközök nélkülözhetetlenek egy tiszta, jól szervezett API fenntartásához, amely csak az ügyfelek számára szükséges adatokat teszi elérhetővé.

Hozzáférés-módosítási beállítások

Egy objektum módosításához jelölje ki a sémaböngésző bármely típus melletti három pontot (...). Az alábbi példa a SalesOrderDetail típus módosítási menüjét mutatja be:

Elérhető módosítási lehetőségek

Séma frissítése – Szinkronizálja a GraphQL-sémát az adatforrás legújabb struktúrájával. Ezt akkor használja, ha új táblákat, nézeteket vagy oszlopokat adott hozzá az adatforráshoz, és az API-val szeretné elérhetővé tenni őket. Ez a művelet új objektumokat derít fel és ad hozzá a meglévő konfiguráció megőrzése mellett.

Átnevezés – Az objektum megjelenésének módosítása a GraphQL API-ban. Ez hasznos lehet intuitívabb API-elnevezési konvenciók létrehozásához vagy a megvalósítás részleteinek elrejtéséhez az ügyfelek elől. Átnevezheti tbl_SalesOrderDetail például egyszerűen SalesOrderDetail. Az átnevezés csak az API-sémát érinti, és nem módosítja az alapul szolgáló adatforrás-objektumot.

Eltávolítás a sémából – Eltávolítja az objektumot a GraphQL API-ból, így az ügyfelek számára elérhetetlenné válik. Ezzel elrejtheti a bizalmas adatokat, eltávolíthatja az elavult objektumokat, vagy egyszerűsítheti az API-felületet. Az adatok az adatforrásban maradnak; csak az API-expozíciót távolítja el.

Kapcsolatok kezelése – Megnyitja a kapcsolatkezelési felületet, ahol meghatározhatja, hogyan csatlakoznak egymáshoz az objektumok. A kapcsolatok lehetővé teszik a beágyazott lekérdezéseket és a gráfok bejárását, így az ügyfelek egyetlen kérelemben kérhetik le a kapcsolódó adatokat. További információ: Kapcsolatok kezelése a Fabric API for GraphQL-ben.

Tulajdonságok – Részletes metaadatokat jelenít meg az objektumról, beleértve az adatforrásban megjelenő eredeti nevet, a GraphQL-típusnevet, a tulajdonost és a helyet (munkaterület és adatforrás neve). Ezzel ellenőrizheti, hogyan vannak leképezve az objektumok az adatforrás és a GraphQL API között.

Lekérdezések és mutációk engedélyezése és letiltása

A lekérdezések és mutációk engedélyezésével és letiltásával a rendszergazdák és fejlesztők részletes vezérlést biztosítanak az API-hozzáférés és -használat felett. Lehetővé teszi bizonyos lekérdezések és mutációk szelektív aktiválását vagy inaktiválását a GraphQL-sémában. Ez lehetővé teszi az API-képességek dinamikus kezelését a kód módosítása vagy a módosítások üzembe helyezése nélkül.

Ezt a funkciót a következő forgatókönyvekhez használhatja:

API-verziószámozás: Az elavult műveletek letiltása az ügyfelek új verziókra való átállása közben
Karbantartási időszakok: Írási műveletek (mutációk) ideiglenes letiltása az adatkarbantartás során
Biztonság és megfelelőség: Bizalmas műveletekhez való hozzáférés korlátozása anélkül, hogy eltávolítaná őket a sémából
Fázisos bevezetés: Új lekérdezések vagy mutációk engedélyezése tesztelés előtt, mielőtt széles körben elérhetővé tennék őket

A sémakezelő lekérdezéseinek és mutációinak két másik lehetősége van:

Letiltás: Megakadályozza, hogy bármilyen kérés futtassa a lekérdezést vagy a mutációt. Ha végrehajtást kísérel meg, a rendszer hibát ad vissza. Ha egy lekérdezés vagy mutáció le van tiltva, a séma újratöltése megtörténik, és a lekérdezés vagy a mutáció szürkítve jelenik meg a sémakezelőben.

Engedélyezés: Lehetővé teszi egy korábban letiltott lekérdezés vagy mutáció újbóli engedélyezését. A lekérdezés vagy a mutáció azonnal elérhető a séma újrabetöltési művelete után, amely az Engedélyezés lehetőség kiválasztásakor következik be.