Flera mutationer i GraphQL för Data API Builder

Data API Builder (DAB) har stöd för att kombinera flera mutationsåtgärder till en enda transaktion. Flera mutationer stöder scenarier där du behöver skapa flera objekt som tillhör samma entitet eller skapa flera objekt som tillhör en relaterad entitet. Den här guiden går igenom ett exempelscenario med hjälp av en åtgärd med flera mutationer.

Förutsättningar

• Befintlig SQL-server och databas.
• Data-API-byggarens CLI. Installera CLI
• En databasklient (SQL Server Management Studio, Azure Data Studio osv.)
  • Om du inte har en klient installerad installerar du Azure Data Studio

Skapa tabeller

Börja med att skapa två grundläggande tabeller som representerar böcker och deras respektive kapitel. Böcker har en en-till-många-relation med sina motsvarande kapitel.

1. Anslut till SQL-databasen med den klient eller det verktyg du föredrar.

2. Skapa en tabell med namnet Books med idkolumnerna , title, yearoch pages .

   DROP TABLE IF EXISTS dbo.Books;
   
   CREATE TABLE dbo.Books
   (
       id int NOT NULL PRIMARY KEY,
       title nvarchar(1000) NOT NULL,
       [year] int null,
       [pages] int null
   )
   GO
   

3. Skapa en annan tabell vid namn Chapters med kolumnerna id, name och pages. Skapa en book_id kolumn med en sekundärnyckelrelation till id kolumnen i Books tabellen.

   DROP TABLE IF EXISTS dbo.Chapters;
   
   CREATE TABLE dbo.Chapters
   (
       id int NOT NULL PRIMARY KEY,
       [name] nvarchar(1000) NOT NULL,
       [pages] int null,
       book_id int NOT NULL,
       FOREIGN KEY (book_id) REFERENCES dbo.Books(id)
   )
   GO
   

4. Kontrollera att tabellerna har skapats med några vanliga SQL-frågor.

   SELECT * FROM dbo.Books
   

   SELECT * FROM dbo.Chapters
   

   Anmärkning

   I det här läget bör frågorna inte returnera några data.

Skapa konfigurationsfil

Använd nu DAB CLI för att skapa en konfigurationsfil, entiteter och entitetsrelationer.

1. Öppna en terminal

2. Lagra sql-databasanslutningssträngen som en gränssnittsvariabel med namnet SQL_CONNECTION_STRING.

   SQL_CONNECTION_STRING="<your-sql-connection-string>"
   

   $SQL_CONNECTION_STRING="<your-sql-connection-string>"
   

3. Kör dab init och ange följande egenskaper.

   	Värde
   database-type	mssql
   graphql.multiple-create.enabled	true
   host-mode	development
   connection-string	Använd gränssnittsvariabeln SQL_CONNECTION_STRING som skapades i föregående steg.

   dab init --database-type "mssql" --graphql.multiple-create.enabled true --host-mode "development" --connection-string $SQL_CONNECTION_STRING
   

4. Kör dab add för att lägga till en bokentitet som anger följande egenskaper.

   	Värde
   source	dbo.Books
   permissions	anonymous:*

   dab add Book --source "dbo.Books" --permissions "anonymous:*"
   

5. Kör dab add igen för att lägga till en kapitelentitet som nu anger följande egenskaper.

   	Värde
   source	dbo.Chapters
   permissions	anonymous:*

   dab add Chapter --source "dbo.Chapters" --permissions "anonymous:*"  
   

6. Kör dab update för att skapa relationen Bok till kapitel med följande egenskaper.

   	Värde
   relationship	chapters
   cardinality	many

   dab update Book --relationship chapters --target.entity Chapter --cardinality many
   

7. dab update Kör slutligen en sista gång för att skapa relationen Chapter to Book som anger följande egenskaper.

   	Värde
   relationship	book
   cardinality	one

   dab update Chapter --relationship book --target.entity Book --cardinality one
   

Utföra flera skapande mutationer

För att avsluta, använd DAB CLI för att köra API:et och testa GraphQL-slutpunkten med Banana Cake Pop.

1. Starta körningsmotorn med den aktuella konfigurationen.

   dab start
   

2. Navigera till den /graphql relativa slutpunkten för ditt program som körs. Den här slutpunkten öppnar Banana Cake Pop-gränssnittet.

   Anmärkning

   Som standard skulle detta vara https://localhost:5001/graphql.

3. Skapa en GraphQL-mutation för att skapa tre distinkta rader i två tabeller i databasen. Den här mutationen använder både entiteterna Book och Chapter i en enda "multiple create"-åtgärd. Använd följande egenskaper för mutationen.

   Entitetstyp	ID-nummer	Namn	Sidor	År
   Bok	1	Introduktion till Data API-byggare	200	2024
   Kapitel	2	Konfigurationsfiler	150
   Kapitel	3	Springa	50

   mutation {
     createBook(
       item: {
         id: 1
         title: "Introduction to Data API builder"
         pages: 200
         year: 2024
         chapters: [
           {
               id: 2
               name: "Configuration files", pages: 150 
           }
           {
               id: 3
               name: "Running", pages: 50
           }
         ]
       }
     ) {
       id
       title
       pages
       year
       chapters {
         items {
           name
           pages
         }
       }
     }
   }
   

4. Observera utdata från mutationen. Mutationen skapade relaterade data för båda entitetstyperna.

   {
     "data": {
       "createBook": {
         "id": 1,
         "title": "Introduction to Data API builder",
         "pages": 200,
         "year": 2024,
         "chapters": {
           "items": [
             {
               "name": "Configuration files",
               "pages": 150
             },
             {
               "name": "Running",
               "pages": 50
             }
           ]
         }
       }
     }
   }
   

5. Använd en GraphQL-fråga för att hämta alla böcker i databasen, inklusive deras relaterade kapitel.

   query {
     books {
       items {
         pages
         title
         year
         chapters {
           items {
             name
             pages
           }
         }
       }
     }
   }
   

   Anmärkning

   I det här läget ska frågan returnera den enskilda boken med två kapitel.

6. Observera utdata från den här frågan med en matris med böcker, inklusive deras kapslade matris med kapitel.

   {
     "data": {
       "books": {
         "items": [
           {
             "pages": 200,
             "title": "Introduction to Data API builder",
             "year": 2024,
             "chapters": {
               "items": [
                 {
                   "name": "Configuration files",
                   "pages": 150
                 },
                 {
                   "name": "Running",
                   "pages": 50
                 }
               ]
             }
           }
         ]
       }
     }
   }
   

7. Anslut till SQL-databasen igen med den klient eller det verktyg du föredrar.

8. Kontrollera att dina data har skapats med hjälp av en SQL-fråga.

   SELECT 
       c.name AS chapterName,
       c.pages AS chapterPages,
       b.title AS bookName,
       b.year AS releaseYear
   FROM dbo.Chapters c
   LEFT JOIN dbo.Books b ON b.id = c.book_id
   

   Anmärkning

   Den här sökfrågan ska returnera två kapitelposter.

Relaterat innehåll

• Relationer
• GraphQL