API til GraphQL-definition

Denne artikel indeholder en oversigt over definitionsstrukturen for GraphQLApi-elementer.

Definitionsdele

I denne tabel vises GraphQLApi-definitionsdelene.

Sti til definitionsdel	slags	Påkrævet	Beskrivelse
.platform	PlatformDetails (JSON)	falsk	Beskriver almindelige detaljer om elementet
graphql-definition.json	GraphQLDefinition (JSON)	sand	Beskriver den generelle konfiguration og datakildekonfigurationen for API'en til GraphQL

GraphQLDefinition

Navn	Slags	Beskrivelse
$schema	Streng	URL-adresse til skemaspecifikation
datakilder	Kilde[]	Liste over datakilder, der er knyttet til API'en for GraphQL

Kilde

Navn	Slags	Beskrivelse
sourceItemId	Guid	Id for kildeelementet
sourceWorkspaceId	Guid	Id for det arbejdsområde, der indeholder kildeelementet
connectionId	Guid	Id for den forbindelse, der bruges til kildeelementet
sourceType	Kildetype	Type af kildeelement
Objekter	SourceObject[]	Liste over objekter i kildeelementet, der vises ved hjælp af GraphQL-API'en

SourceType (enum)

Navn	Beskrivelse
SqlAnalyticsEndpoint	SQL Analytics-slutpunkt
Lageragersted	Lageragersted
SqlDbNative	SQL-database
AzureSql	Azure SQL Database

SourceObject

Navn	Slags	Beskrivelse
graphqlType	Streng	GraphQL-typenavn, der skal bruges til objektet i kildeelementet
sourceObject	Streng	Objektnavn i det kildeelement, der vises af GraphQL-API'en
sourceObjectType	SourceObjectType	Objekttype i kildeelementet
handlinger	<ActionType, ActionValue>	Ordbog over handlingstype til handlingsværdi, der angiver forespørgsler og mutationer med deres aktiveringsstatus
fieldMappings	<Streng, streng>	Ordbog over felter i kildeobjektet til GraphQL-felter
Relationer	Relation[]	Liste over relationer, der er konfigureret fra kildeobjektet
IsStoredProcedureQueryNode	Boolesk	GraphQL-handlingstype til eksponering af lagret procedure. Sand - Forespørgsel, Falsk - Mutation.

SourceObjectType (enum)

Navn	Beskrivelse
Sortbord	Databasetabel
Visning	Databasevisning
Lagret procedure	Lagret procedure for database

ActionType (enum)

Navn	Beskrivelse
Anmodning	Forespørgsel på kildeobjekt
Query_by_pk	Forespørg efter primær nøgle på kildeobjektet
Opret	Opret mutation på kildeobjekt
Opdatering	Opdater mutation på kildeobjekt
Slet	Slet mutation på kildeobjekt
Udfør	Udfør forespørgsel eller mutation ved lagret procedure

ActionValue (optæller)

Navn	Beskrivelse
Aktiveret	Aktivér forespørgsel eller mutation
Handicappet	Deaktiver forespørgsel eller mutation

Relationer

Navn	Slags	Beskrivelse
mark	Streng	GraphQL-feltnavn, der skal bruges til relationen i GraphQL-typen
kardinalitet	Relationskortinalitet	Kardinalitet for relationen
targetObject	Streng	Destinationsobjekt for relationen
sourceFields	Streng[]	Liste over felter i kildeobjektet, der bruges til relationen
targetFields	Streng[]	Liste over felter i det destinationsobjekt, der bruges til relationen
linkingObject	Streng	Sammenkæder objekt for mange til mange-relationer mellem kilde- og destinationsobjekter
linkingSourceFields	Streng[]	Liste over felter i sammenkædningsobjektet for relationen fra kildeobjektet
linkingTargetFields	Streng[]	Liste over felter i sammenkædningsobjektet for relationen til destinationsobjektet

RelationshipCardinality (optælling)

Navn	Beskrivelse
MangeTilOne	Mange til en-relation
OneToMany	En til mange-relation
OneToOne	En til en-relation
MangeTilMany	Mange til mange-relation

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"
    }
  ]
}