Del via

Fabric API til GraphQL-skemavisning og skemaoversigt

Fabric API'en til GraphQL genererer automatisk et skema, der definerer strukturen af dit API baseret på de datakilder, du forbinder. Skemaet, skrevet i GraphQL Schema Definition Language (SDL), beskriver alle tilgængelige typer, felter, forespørgsler og mutationer, som klienter kan bruge til at interagere med dine data.

Skemavisningen giver en skrivebeskyttet, tekstbaseret visning af dit komplette GraphQL-skema, mens skema-udforskeren i venstre panel lader dig navigere, inspicere og ændre de objekter, der er eksponeret gennem din API. Sammen hjælper disse værktøjer dig med at forstå din API's struktur og kontrollere, hvilke data der er tilgængelige for kunderne.

Hvem bruger skemavisningen

Skemavisningen og exploreren er værdifulde til:

  • Dataingeniører , der konfigurerer, hvilke Fabric-lakehouse- og lagerobjekter der skal eksponeres gennem GraphQL
  • Applikationsudviklere opdager tilgængelige Fabric-datatyper, felter og relationer, før de skriver forespørgsler
  • Fabric-workspace-bidragydere forstår og administrerer dataadgangsstrukturen for deres workspace
  • BI-udviklere , der gennemgår Fabric-datarelationer, når de bygger tilpassede analyseapplikationer

Brug skemavisningen til at udforske din API's struktur og skema-udforskeren til at ændre, hvilke dataobjekter der er eksponeret.

Få adgang til og udforsk skemaet

Du kan få adgang til skemavisningen enten fra forespørgselseditoren eller direkte fra dit GraphQL API-element. For at åbne skemavisningen, vælg Skema i nederste venstre hjørne. Skemavisningen viser en skrivebeskyttet, tekstbaseret version af din komplette GraphQL SDL med alle genererede typer, felter, forespørgsler og mutationer.

Følgende billede viser skemavisningen med Schema explorer-panelet til venstre:

Skærmbillede af skærmbilledet med API-skemavisning, som omfatter Skemaoversigt i ruden til venstre.

Skema-udforskeren i venstre panel lader dig navigere og inspicere alle objekterne i dit API. Exploreren er tilgængelig både i skemavisningen og i forespørgselseditoren, hvilket gør det nemt at udforske din API-struktur, mens du skriver forespørgsler.

Udvid noderne i skema-udforskeren for at se:

  • Typer: De GraphQL-typer, der genereres fra dine datakildetabeller og visninger
  • Forespørgsler: Automatisk genererede læseoperationer til at hente data
  • Mutationer: Automatisk genererede skriveoperationer til oprettelse, opdatering og sletning af data (kun warehouse)

Typer

Typer repræsenterer strukturen af dine data og vises under navnet på den datakilde, de er genereret fra. Følgende billede viser SalesOrderDetail-typen , der genereres fra SalesOrderDetail-tabellen i AdventureWorks SQL-analyse-endpointet:

Skærmbillede af ruden Skemaoversigt, der viser den udvidede liste over typer, der er tilgængelige under en eksempeldatakilde med navnet SalesOrderDetail.

Forespørgsler

API'et genererer automatisk forespørgsler til at hente data fra de objekter, du eksponerer. Udvid forespørgselsnoden for at se alle tilgængelige læseoperationer:

Skærmbillede af ruden Skemaoversigt, der viser en udvidet liste over automatisk genererede forespørgsler.

Mutationer

Mutationer er skriveoperationer til oprettelse, opdatering og sletning af data. Udvid mutationsnoden for at se alle tilgængelige skriveoperationer:

Skærmbillede af ruden Skemaoversigt, der viser en udvidet liste over automatisk genererede mutationer.

Bemærk

Mutationer genereres kun for Fabric Data Warehouse-datakilder. SQL Analytics Endpoints (Lakehouses og spejlede databaser) er skrivebeskyttede og understøtter kun forespørgsler. Hvis du ikke ser mutationer i din Schema Explorer, så verificér, at du har forbundet til et Fabric Data Warehouse.

Rediger objekter ved hjælp af skemaoversigten

Efter API'en har genereret dit oprindelige skema, kan du bruge skema-udforskeren til at forfine, hvad der er eksponeret gennem din API. Skemaexploreren tilbyder administrationsmuligheder, der lader dig kontrollere din API's struktur uden at ændre de underliggende datakilder. Disse værktøjer er essentielle for at opretholde en ren, velorganiseret API, der kun eksponerer de data, dine kunder har brug for.

Adgangsmodifikationsmuligheder

For at ændre et objekt skal du vælge ellipsen (...) ved siden af en hvilken som helst type i skema-udforskeren. Følgende eksempel viser ændringsmenuen for typen SalesOrderDetail :

Skærmbillede af skemaoversigten med ellipsen valgt, der viser de tilgængelige menupunkter.

Tilgængelige modifikationsmuligheder

Opdatér skema - Synkroniserer dit GraphQL-skema med den nyeste struktur fra datakilden. Brug dette, når du har tilføjet nye tabeller, visninger eller kolonner til din datakilde og vil eksponere dem via API'en. Denne operation opdager og tilføjer nye objekter, samtidig med at din eksisterende konfiguration bevares.

Omdøb - Ændrer, hvordan objektet vises i din GraphQL API. Dette er nyttigt til at skabe mere intuitive API-navngivningskonventioner eller skjule implementeringsdetaljer for klienter. For eksempel kan du omdøbe tbl_SalesOrderDetail til blot SalesOrderDetail. Omdøbningen påvirker kun API-skemaet og ændrer ikke det underliggende datakildeobjekt.

Fjern fra skema - Fjerner objektet fra dit GraphQL API, så det ikke længere er tilgængeligt for klienterne. Brug dette til at skjule følsomme data, fjerne forældede objekter eller forenkle din API-overflade. Dataene forbliver i din datakilde; kun API-eksponeringen fjernes.

Administrer relationer – Åbner relationsstyringsgrænsefladen, hvor du kan definere, hvordan objekter forbinder til hinanden. Relationer muliggør indlejrede forespørgsler og grafgennemgang, så klienter kan hente relaterede data i én enkelt anmodning. Du kan få flere oplysninger under Administrer relationer i Fabric API til GraphQL.

Egenskaber - Viser detaljerede metadata om objektet, inklusive det oprindelige navn, som det fremgår af datakilden, GraphQL-typenavnet, ejeren og placeringen (arbejdsområde og datakildenavn). Brug dette til at verificere, hvordan objekter er kortlagt mellem din datakilde og GraphQL API'en.

Aktivér og deaktiver forespørgsler og mutationer

Funktionen til aktivering eller deaktivering af forespørgsler og mutationer giver administratorer og udviklere detaljeret kontrol over API-adgang og -brug. Det giver dig mulighed for selektivt at aktivere eller deaktivere specifikke forespørgsler og mutationer i GraphQL-skemaet. Dette giver dig mulighed for at administrere API-funktioner dynamisk uden at ændre kode eller udrulle ændringer.

Brug denne funktion til scenarier som:

  • API-versionering: Deaktiver forældede operationer under overgang til nye versioner af klienter
  • Vedligeholdelsesvinduer: Deaktiver midlertidigt skriveoperationer (mutationer) under datavedligeholdelse
  • Sikkerhed og overholdelse: Begræns adgangen til følsomme operationer uden at fjerne dem fra skemaet
  • Faseopdelte udrulninger: Muliggør nye forespørgsler eller mutationer til test, før de gøres bredt tilgængelige

Forespørgsler og mutationer i skemaoversigten har to andre muligheder:

  • Deaktiver: Forhindrer anmodninger i at køre forespørgslen eller mutationen. Hvis udførelse forsøges, returneres der en fejl. Når en forespørgsel eller mutation er deaktiveret, genindlæses skemaet, og forespørgslen eller mutationen vises nedtonet i skemaoversigten.

Skærmbillede af indstillingen Deaktiver forespørgsel eller mutation vist i skemaoversigten.

  • Aktivér: Giver dig mulighed for at genaktivere en tidligere deaktiveret forespørgsel eller mutation. Forespørgslen eller mutationen er umiddelbart tilgængelig efter den genindlæsning af skemaet, der udføres, når du vælger indstillingen Aktivér .

Skærmbillede af indstillingen Aktivér forespørgsel om mutation vist i skemaoversigten.

Bemærk

Forespørgsler og mutationer, der autogenereres fra lagrede procedurer, opfører sig anderledes end dem, der genereres fra tabeller eller visninger. De kan kun slettes, ikke deaktiveres. Efter sletning kan du tilføje dem igen ved at bruge indstillingerne Get Data eller Update Schema . For mere information, se Stored procedures.

Relateret indhold

  • Last updated on