GraphQL-määritelmän ohjelmointirajapinta

Tässä artikkelissa on erittely GraphQLApi-kohteiden määritysrakenteesta.

Määritysosat

Tässä taulukossa on luettelo GraphQLApi-määritysosista.

Määritysosan polku	tyyppi	Pakollinen	Kuvaus
.platform	PlatformDetails (JSON)	väärä	Kuvaa kohteen yleisiä tietoja
graphql-definition.json	GraphQLDefinition (JSON)	tosi	Kuvailee GraphQL-ohjelmointirajapinnan yleisen ja tietolähteen määrityksen

GraphQLDefinition

Nimi	Kirjoita	Kuvaus
$schema	Merkkijono	Rakenteen URL-osoite
tietolähteet	Lähde[]	Luettelo GraphQL-ohjelmointirajapintaan liittyvistä tietolähteistä

Lähde

Nimi	Kirjoita	Kuvaus
sourceItemId	Guid	Lähdekohteen tunnus
sourceWorkspaceId	Guid	Lähdekohteen sisältävän työtilan tunnus
connectionId	Guid	Lähdekohteelle käytetyn yhteyden tunnus
sourceType	Lähdetyyppi	Lähdekohteen tyyppi
Objektit	SourceObject[]	Luettelo lähdekohteen objekteista, jotka näytetään GraphQL-ohjelmointirajapinnan avulla

SourceType (luettelointi)

Nimi	Kuvaus
SqlAnalyticsEndpoint	SQL Analytics -päätepiste
F. varastointi	F. varastointi
SqlDbNative	SQL-tietokanta
AzureSql	Azure SQL -tietokanta

SourceObject

Nimi	Kirjoita	Kuvaus
graphqlType	Merkkijono	Lähdekohteen objektille käytettävä GraphQL-tyypin nimi
sourceObject	Merkkijono	Objektin nimi lähdekohteessa, jonka GraphQL-ohjelmointirajapinta paljastaa
sourceObjectType	SourceObjectType	Kohdetyyppi lähdekohteessa
toimet	<ActionType, ActionValue>	Sanasto toimintotyypistä toimintoarvolle, joka ilmaisee kyselyitä ja mutaatioita niiden käyttöönoton tilassa
fieldMappings	<Merkkijono, merkkijono>	Lähdeobjektin kenttien sanasto GraphQL-kenttiin
suhteet	Suhde[]	Lähdeobjektista määritettyjen suhteiden luettelo
IsStoredProcedureQueryNode	Totuusarvo	GraphQL-toimintotyyppi tallennetun toimintosarjan paljastamista varten. True – kysely, epätosi – mutaatio.

SourceObjectType (luettelointi)

Nimi	Kuvaus
Sivupöytä	Tietokantataulukko
Näkymä	Tietokantanäkymä
StoredProcedure	Tietokannan tallennetut toimintosarjat

ActionType (luettelointi)

Nimi	Kuvaus
Kysely	Kysely lähdeobjektista
Query_by_pk	Kysely perusavaimen mukaan lähdeobjektissa
Luonti	Mutaation luominen lähdeobjektissa
Päivittää	Päivitä lähdeobjektin mutaatio
Poista	Lähdeobjektin mutaation poistaminen
Suorita	Kyselyn tai mutaation suorittaminen tallennetussa toimintosarjassa

ActionValue (luettelointi)

Nimi	Kuvaus
Käytössä	Kyselyn tai muunnuksen ottaminen käyttöön
Vammainen	Poista kysely tai mutaatio käytöstä

Suhde

Nimi	Kirjoita	Kuvaus
pelto	Merkkijono	GraphQL-kentän nimi, jota käytetään GraphQL-tyypin suhteessa
mahtavuus	RelationshipCardinality	Suhteen kardinaliteetti
targetObject	Merkkijono	Suhteen kohdeobjekti
sourceFields	Merkkijono[]	Suhteeseen käytetyn lähdeobjektin kenttäluettelo
targetFields	Merkkijono[]	Suhteeseen käytetyn kohdeobjektin kenttien luettelo
linkingObject	Merkkijono	Objektin linkittäminen lähde- ja kohdeobjektien välisille monta-moneen-yhteyksille
linkingSourceFields	Merkkijono[]	Luettelo kentistä linkittävässä -objektissa suhteelle lähdeobjektista
linkingTargetFields	Merkkijono[]	Luettelo linkittävän objektin kentistä suhteessa kohdeobjektiin

RelationshipCardinality (luettelointi)

Nimi	Kuvaus
ManyToOne	Monta yhteen -suhde
OneToMany	Yksi moneen -suhde
OneToOne	Yksi yhteen -suhde
ManyToMany	Monta moneen -suhde

GraphQLDefinition-esimerkki

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