API voor GraphQL-definitie

Dit artikel bevat een uitsplitsing van de definitiestructuur voor GraphQLApi-items.

Definitieonderdelen

Deze tabel bevat de GraphQLApi-definitieonderdelen.

Pad van definitieonderdeel	soort	Verplicht	Beschrijving
.platform	PlatformDetails (JSON)	onwaar	Beschrijft algemene details van het item
graphql-definition.json	GraphQLDefinition (JSON)	waar	Beschrijft de algemene en gegevensbronconfiguratie van de API voor GraphQL

GraphQLDefinition

Naam	Typologie	Beschrijving
$schema	Snaar / Touwtje	URL voor schemaspecificatie
gegevensbronnen	Bron[]	Lijst met gegevensbronnen die zijn gekoppeld aan API voor GraphQL

Bron

Naam	Typologie	Beschrijving
sourceItemId	Guid	Id van het bronitem
sourceWorkspaceId	Guid	Id van de werkruimte met het bronitem
connectionId	Guid	Id van de verbinding die wordt gebruikt voor het bronitem
bronType	Type bron	Type bronitem
Objecten	SourceObject[]	Lijst met objecten in het bronitem die worden weergegeven met behulp van de GraphQL-API

SourceType (enum)

Naam	Beschrijving
SqlAnalyticsEndpoint	SQL Analytics-eindpunt
Magazijn	Magazijn
SqlDbNative	SQL Databank
AzureSql	Azure SQL Database

SourceObject

Naam	Typologie	Beschrijving
graphqlType	Snaar / Touwtje	GraphQL-typenaam die moet worden gebruikt voor object in bronitem
sourceObject	Snaar / Touwtje	Objectnaam in het bronitem dat wordt weergegeven door de GraphQL-API
sourceObjectType (type van het bronobject)	SourceObjectType	Objecttype in het bronitem
Acties	<ActionType, ActionValue>	Woordenlijst van actietype naar actiewaarde die query's en mutaties aangeeft met hun activeringsstatus
veldtoewijzingen	<Tekenreeks, tekenreeks>	Woordenlijst van velden in bronobject naar GraphQL-velden
relaties	Relatie[]	Lijst met relaties die zijn geconfigureerd vanuit het bronobject
IsStoredProcedureQueryNode	Booleaan	GraphQL-bewerkingstype voor het weergeven van opgeslagen procedures. Waar - Query, Onwaar - Mutatie.

SourceObjectType (enum)

Naam	Beschrijving
Tabel	Databasetabel
Bekijk	Databaseweergave
Opgeslagen procedure	Opgeslagen databaseprocedure

ActionType (enum)

Naam	Beschrijving
Zoekopdracht	Query uitvoeren op bronobject
Query_by_pk	Query's uitvoeren op primaire sleutel op bronobject
Maak	Mutatie maken op bronobject
bijwerken	Mutatie bijwerken op bronobject
Verwijderen	Mutatie op bronobject verwijderen
Uitvoeren	Query of mutatie uitvoeren op opgeslagen procedure

ActionValue (enum)

Naam	Beschrijving
Ingeschakeld	Query of mutatie inschakelen
Uitgeschakeld	Query of mutatie uitschakelen

Relatie

Naam	Typologie	Beschrijving
veld	Snaar / Touwtje	GraphQL-veldnaam die moet worden gebruikt voor de relatie in GraphQL-type
kardinaliteit	RelationshipCardinality	Kardinaliteit voor de relatie
targetObject	Snaar / Touwtje	Doelobject voor de relatie
bronvelden	Tekenreeks[]	Lijst met velden in het bronobject dat wordt gebruikt voor de relatie
targetFields	Tekenreeks[]	Lijst met velden in doelobject dat wordt gebruikt voor de relatie
linkingObject	Snaar / Touwtje	Object koppelen voor veel-op-veel-relaties tussen bron- en doelobjecten
linkingSourceFields	Tekenreeks[]	Lijst met velden in het koppelingsobject voor de relatie van het bronobject
linkingTargetFields	Tekenreeks[]	Lijst met velden in het koppelingsobject voor de relatie met het doelobject

RelationshipCardinality (enum)

Naam	Beschrijving
ManyToOne	Veel-op-een-relatie
OneToMany	Een-op-veel-relatie
OneToOne	Een-op-een-relatie
ManyToMany	Veel-op-veel-relatie

GraphQLDefinition-voorbeeld

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