Fabric-API voor GraphQL-schemaweergave en schemaverkenner

Met de Fabric-API voor GraphQL wordt automatisch een schema gegenereerd dat de structuur van uw API definieert op basis van de gegevensbronnen waarmee u verbinding maakt. Het schema, geschreven in GraphQL Schema Definition Language (SDL), beschrijft alle beschikbare typen, velden, query's en mutaties die clients kunnen gebruiken om met uw gegevens te communiceren.

De schemaweergave biedt een alleen-lezen, tekstweergave van uw volledige GraphQL-schema, terwijl u met de schemaverkenner in het linkerdeelvenster door de objecten kunt navigeren, inspecteren en wijzigen die via uw API worden weergegeven. Met deze hulpprogramma's krijgt u inzicht in de structuur van uw API en kunt u bepalen welke gegevens toegankelijk zijn voor clients.

Wie gebruikt de schemaweergave

De schemaweergave en verkenner zijn waardevol voor:

• Data engineers configureren welke Fabric Lakehouse- en magazijnobjecten beschikbaar moeten worden gemaakt via GraphQL
• Ontwikkelaars van toepassingen detecteren beschikbare Fabric-gegevenstypen, -velden en -relaties voordat ze query's schrijven
• Fabric werkruimtebijdragers begrijpen en beheren de gegevensstructuur voor hun werkruimte.
• BI-ontwikkelaars die fabric-gegevensrelaties beoordelen bij het bouwen van aangepaste analysetoepassingen

Gebruik de schemaweergave om de structuur van uw API en de schemaverkenner te verkennen om te wijzigen welke gegevensobjecten worden weergegeven.

Het schema openen en verkennen

U kunt de schemaweergave openen vanuit de queryeditor of rechtstreeks vanuit uw GraphQL API-item. Als u de schemaweergave wilt openen, selecteert u Schema in de linkerbenedenhoek. In de schemaweergave wordt een alleen-lezen, tekstgebaseerde versie van uw volledige GraphQL SDL weergegeven met alle gegenereerde typen, velden, query's en mutaties.

In de volgende afbeelding ziet u de schemaweergave met het deelvenster Schemaverkenner aan de linkerkant:

Navigeren met schemaverkenner

Met schemaverkenner in het linkerdeelvenster kunt u navigeren en alle objecten in uw API inspecteren. De verkenner is beschikbaar in zowel de schemaweergave als de query-editor, zodat u eenvoudig uw API-structuur kunt verkennen tijdens het schrijven van query's.

Vouw de knooppunten in de schemaverkenner uit om het volgende weer te geven:

• Typen: De GraphQL-typen die zijn gegenereerd op basis van uw gegevensbrontabellen en -weergaven
• Query's: Automatisch gegenereerde leesbewerkingen voor het ophalen van gegevens
• Mutaties: automatisch gegenereerde schrijfbewerkingen voor het maken, bijwerken en verwijderen van gegevens (alleen warehouse)

Types

Typen vertegenwoordigen de structuur van uw gegevens en worden weergegeven onder de naam van de gegevensbron waaruit ze zijn gegenereerd. In de volgende afbeelding ziet u het type SalesOrderDetail dat is gegenereerd op basis van de tabel SalesOrderDetail in het eindpunt van AdventureWorks SQL Analytics:

Queries

De API genereert automatisch query's voor het ophalen van gegevens uit de objecten die u beschikbaar maakt. Vouw het queryknooppunt uit om alle beschikbare leesbewerkingen weer te geven:

Mutaties

Mutaties zijn schrijfbewerkingen voor het maken, bijwerken en verwijderen van gegevens. Vouw het mutatieknooppunt uit om alle beschikbare schrijfbewerkingen te bekijken:

Objecten wijzigen met behulp van schemaverkenner

Nadat de API uw eerste schema heeft gegenereerd, kunt u de schemaverkenner gebruiken om te verfijnen wat beschikbaar is via uw API. De schemaverkenner biedt beheeropties waarmee u de structuur van uw API kunt beheren zonder de onderliggende gegevensbronnen te wijzigen. Deze hulpprogramma's zijn essentieel voor het onderhouden van een schone, goed georganiseerde API die alleen de gegevens beschikbaar maakt die uw clients nodig hebben.

Opties voor het wijzigen van toegang

Als u een object wilt wijzigen, selecteert u het beletselteken (...) naast elk type in de schemaverkenner. In het volgende voorbeeld ziet u het wijzigingsmenu voor het type SalesOrderDetail :

Beschikbare aanpassingsopties

Schema bijwerken: synchroniseert uw GraphQL-schema met de nieuwste structuur van de gegevensbron. Gebruik deze optie wanneer u nieuwe tabellen, weergaven of kolommen hebt toegevoegd aan uw gegevensbron en deze beschikbaar wilt maken via de API. Met deze bewerking worden nieuwe objecten gedetecteerd en toegevoegd terwijl uw bestaande configuratie behouden blijft.

Naam wijzigen : hiermee wijzigt u hoe het object wordt weergegeven in uw GraphQL-API. Dit is handig voor het maken van intuïtievere API-naamconventies of het verbergen van implementatiedetails van clients. U kunt bijvoorbeeld de naam wijzigen tbl_SalesOrderDetail in simpelweg SalesOrderDetail. De naamwijziging is alleen van invloed op het API-schema en wijzigt het onderliggende gegevensbronobject niet.

Verwijderen uit schema : hiermee verwijdert u het object uit uw GraphQL-API, waardoor het niet beschikbaar is voor clients. Gebruik deze optie om gevoelige gegevens te verbergen, afgeschafte objecten te verwijderen of uw API-oppervlak te vereenvoudigen. De gegevens blijven aanwezig in uw gegevensbron; alleen de API-blootstelling wordt verwijderd.

Relaties beheren - Hiermee opent u de interface voor relatiebeheer, waar u kunt definiëren hoe objecten met elkaar verbinding maken. Relaties maken geneste query's en graftraversering mogelijk, zodat clients gerelateerde gegevens in één verzoek kunnen ophalen. Zie Relaties beheren in Fabric-API voor GraphQL voor meer informatie.

Eigenschappen : geeft gedetailleerde metagegevens weer over het object, inclusief de oorspronkelijke naam zoals deze wordt weergegeven in de gegevensbron, de GraphQL-typenaam, de eigenaar en de locatie (naam van werkruimte en gegevensbron). Gebruik deze optie om te controleren hoe objecten worden toegewezen tussen uw gegevensbron en de GraphQL-API.

Query's en mutaties in- en uitschakelen

De functie voor het in- of uitschakelen van query's en mutaties biedt beheerders en ontwikkelaars gedetailleerde controle over API-toegang en -gebruik. Hiermee kunt u selectief specifieke query's en mutaties in het GraphQL-schema activeren of deactiveren. Hiermee kunt u API-mogelijkheden dynamisch beheren zonder code te wijzigen of wijzigingen te implementeren.

Gebruik deze functie voor scenario's zoals:

• API-versiebeheer: afgeschafte bewerkingen uitschakelen tijdens de overgang van clients naar nieuwe versies
• Onderhoudsvensters: Schrijfbewerkingen (mutaties) tijdelijk uitschakelen tijdens gegevensonderhoud
• Beveiliging en naleving: de toegang tot gevoelige bewerkingen beperken zonder ze uit het schema te verwijderen
• Gefaseerde implementaties: nieuwe query's of mutaties voor testen inschakelen voordat ze algemeen beschikbaar worden

Query's en mutaties in de schemaverkenner hebben twee andere opties:

• Uitschakelen: Hiermee voorkomt u dat er verzoeken gestart worden die de query of mutatie uitvoeren. Als er een poging wordt uitgevoerd, wordt er een fout geretourneerd. Nadat een query of mutatie is uitgeschakeld, wordt een schema opnieuw geladen en wordt de query of mutatie grijs weergegeven in de schemaverkenner.

• Inschakelen: Hiermee kunt u een eerder uitgeschakelde query of mutatie opnieuw inschakelen. De query of mutatie is onmiddellijk beschikbaar na het herladen van het schema dat optreedt wanneer u de optie Inschakelen selecteert.

Gerelateerde inhoud

• Fabric-API voor GraphQL-editor
• Relaties beheren in Fabric-API voor GraphQL
• Aan de slag met Fabric-API voor GraphQL