API for GraphQL-definisjon

Denne artikkelen inneholder en oversikt over definisjonsstrukturen for GraphQLApi-elementer.

Definisjonsdeler

Denne tabellen viser definisjonsdelene for GraphQLApi.

Definisjonsdelbane	type	Obligatorisk	Beskrivelse
.platform	PlatformDetails (JSON)	usann	Beskriver vanlige detaljer om elementet
graphql-definition.json	GraphQLDefinition (JSON)	sann	Beskriver den generelle konfigurasjonen og datakildekonfigurasjonen av API-en for GraphQL

GraphQLDefinition

Navn	Type:	Beskrivelse
$schema	Streng	URL-adresse for skjemaspesifikasjon
datakilder	Kilde[]	Liste over datakilder som er knyttet til API for GraphQL

Kilde

Navn	Type:	Beskrivelse
sourceItemId	Guid	ID for kildeelementet
sourceWorkspaceId	Guid	ID for arbeidsområdet som inneholder kildeelementet
connectionId	Guid	ID for tilkoblingen som brukes for kildeelementet
sourceType	SourceType	Type kildeelement
Objekter	SourceObject[]	Liste over objekter i kildeelementet som vises ved hjelp av GraphQL-API-en

SourceType (opplisting)

Navn	Beskrivelse
SqlAnalyticsEndpoint	SQL Analytics-endepunkt
Lager	Lager
SqlDbNative	SQL-database
AzureSql	Azure SQL Database

SourceObject

Navn	Type:	Beskrivelse
graphqlType	Streng	GraphQL-typenavn som skal brukes for objekt i kildeelement
sourceObject	Streng	Objektnavn i kildeelementet som vises av GraphQL-API-en
sourceObjectType	SourceObjectType	Objekttype i kildeelementet
Handlinger	<ActionType, ActionValue>	Ordliste for handlingstype til handlingsverdi som angir spørringer og mutasjoner med aktiveringsstatus
fieldMappings	<Streng, streng>	Ordliste over felt i kildeobjektet til GraphQL-felt
Relasjoner	Relasjon[]	Liste over relasjoner som er konfigurert fra kildeobjektet
IsStoredProcedureQueryNode	Boolsk	GraphQL-operasjonstype for å eksponere lagret prosedyre. Sann - spørring, usann - mutasjon.

SourceObjectType (opplisting)

Navn	Beskrivelse
Bord	Databasetabell
Visning	Databasevisning
StoredProcedure	Databaselagret prosedyre

ActionType (opplisting)

Navn	Beskrivelse
Spørsmål	Spørring på kildeobjekt
Query_by_pk	Spørring etter primærnøkkel på kildeobjekt
Opprett	Opprett mutasjon på kildeobjekt
Oppdatering	Oppdater mutasjon på kildeobjekt
Slette	Slett mutasjon på kildeobjekt
Utfør	Utfør spørring eller mutasjon ved lagret prosedyre

ActionValue (opplisting)

Navn	Beskrivelse
Aktivert	Aktiver spørring eller mutasjon
Ufør	Deaktiver spørring eller mutasjon

Forbindelser

Navn	Type:	Beskrivelse
felt	Streng	GraphQL-feltnavn som skal brukes for relasjonen i GraphQL-typen
kardinalitet	RelationshipCardinality	Kardinalitet for relasjonen
targetObject	Streng	Målobjekt for relasjonen
sourceFields	String[]	Liste over felt i kildeobjektet som brukes for relasjonen
targetFields	String[]	Liste over felt i målobjektet som brukes for relasjonen
linkingObject	Streng	Koble objekt for mange-til-mange-relasjoner mellom kilde- og målobjekter
linkingSourceFields	String[]	Liste over felt i koblingsobjektet for relasjonen fra kildeobjektet
linkingTargetFields	String[]	Liste over felt i koblingsobjektet for relasjonen til målobjektet

Relasjonskortinalitet (opplisting)

Navn	Beskrivelse
ManyToOne	Mange-til-én-relasjon
OneToMany	Én-til-mange-relasjon
OneToOne	Én-til-én-relasjon
ManyToMany	Mange-til-mange-relasjon

Eksempel på GraphQLDefinition

{
  "$schema": "https://developer.microsoft.com/json-schemas/fabric/item/graphqlApi/definition/1.0.0/schema.json",
  "datasources": [
    {
      "objects": [
        {
          "actions": {
            "Query": "Enabled"
          },
          "fieldMappings": {
            "LastName": "LastName",
            "Name": "Name"
          },
          "graphqlType": "Customers",
          "relationships": [],
          "sourceObject": "model.Customers",
          "sourceObjectType": "View"
        }
      ],
      "sourceItemId": "c54cd4ce-cbaa-4fc5-bcc8-121f2a3e0c4c",
      "sourceType": "Warehouse",
      "sourceWorkspaceId": "c2231263-b81e-4dd2-a69b-41eca8c93584"
    },
    {
      "connectionId": "daa5dc10-6eae-4b19-af5f-da8db84c51c1",
      "objects": [
        {
          "actions": {
            "Query": "Enabled"
          },
          "fieldMappings": {
            "id": "id",
            "publisher_id": "publisher_id",
            "title": "title"
          },
          "graphqlType": "publishers",
          "relationships": [],
          "sourceObject": "dbo.publishers_view",
          "sourceObjectType": "View"
        },
        {
          "actions": {
            "Query": "Enabled",
            "Query_by_pk": "Enabled",
            "Create": "Enabled",
            "Update": "Enabled",
            "Delete": "Disabled"
          },
          "fieldMappings": {
            "id": "id",
            "title": "title"
          },
          "graphqlType": "books",
          "relationships": [],
          "sourceObject": "dbo.books",
          "sourceObjectType": "Table"
        }
      ],
      "sourceItemId": "daa5dc10-6eae-4b19-af5f-da8db84c51c1",
      "sourceType": "AzureSql",
      "sourceWorkspaceId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}