update parancs

Frissítsen egy meglévő entitásdefiníciót a Data API Builder konfigurációs fájljában. Ezzel a paranccsal módosíthatja a forrás metaadatait, engedélyeit, expozícióját (REST/GraphQL), szabályzatait, gyorsítótárazását, kapcsolatait, leképezéseit és leíró metaadatait egy meglévő entitáshoz.

Jótanács

Új entitások létrehozására és dab add továbbfejlesztésére használhatódab update. A mező metaadatainak kezeléséhez használja --fields.name az , --fields.aliasés --fields.descriptiona --fields.primary-key.

Szemantika

dab update <entity-name> [options]

Gyors áttekintés

Lehetőség Összefoglalás
<entity-name> Kötelező pozícióargumentum. Logikai entitás neve.
-s, --source A forrástábla, a nézet vagy a tárolt eljárás neve.
-m, --map Adatbázismezők és közzétett nevek közötti leképezések.
--permissions Szerepkör és műveletek role:actions formátumban.
--description Az entitás leírásának cseréje.
-c, --config A konfigurációs fájl elérési útja. Az alapértelmezett feloldás akkor érvényes, ha nincs megadva.
--help A súgóképernyő megjelenítése.
--version Verzióinformációk megjelenítése.

Gyorsítótár

Lehetőség Összefoglalás
--cache.enabled Entitások gyorsítótárazásának engedélyezése vagy letiltása.
--cache.ttl Gyorsítótár élettartam másodpercben.

Fields

Lehetőség Összefoglalás
--fields.exclude Kizárt mezők vesszővel tagolt listája.
--fields.include A belefoglalt mezők vesszővel tagolt listája (* = az összes).

Mezők metaadatai

Lehetőség Összefoglalás
--fields.name A leírandó adatbázisoszlop neve.
--fields.alias A mező aliasa.
--fields.description A mező leírása.
--fields.primary-key Állítsa be ezt a mezőt elsődleges kulcsként.

GraphQL

Lehetőség Összefoglalás
--graphql GraphQL-expozíció: false, true, singularvagy singular:plural.
--graphql.operation Csak tárolt eljárások: query vagy mutation (alapértelmezett mutáció).

Engedélyek > szabályzatok

Lehetőség Összefoglalás
--permissions role:actions egyetlen szerepkörhöz. Többszörös futtatás több szerepkörhöz.
--policy-database Adatbázis-lekérdezésbe injektált OData-stílusú szűrő.
--policy-request Predatabase kérelemszűrő.

Relationships

Lehetőség Összefoglalás
--relationship Kapcsolat neve. Kapcsolati beállításokkal használható.
--cardinality Kapcsolat számossága: one vagy many.
--target.entity Cél entitás neve.
--linking.object Több-a-többhöz objektum csatolása.
--linking.source.fields Objektummezők csatolása a forráshoz.
--linking.target.fields Objektummezők csatolása a célhoz.
--relationship.fields Közvetlen kapcsolatok mezőleképezései.

REST

Lehetőség Összefoglalás
--rest REST-expozíció: false, truevagy egyéni elérési út.
--rest.methods Csak tárolt eljárások. Cserélje le az engedélyezett HTTP-parancsokat.

Leképezések

Lehetőség Összefoglalás
-m, --map Adatbázismezők és közzétett nevek közötti leképezések.

MCP

Lehetőség Összefoglalás
--mcp.dml-tools Engedélyezze vagy tiltsa le az MCP DML-eszközöket ehhez az entitáshoz.
--mcp.custom-tool Egyéni MCP-eszköz engedélyezése (csak tárolt eljárások).

Forrás

Lehetőség Összefoglalás
-s, --source Mögöttes adatbázis-objektum neve.
--source.type Forrás típusa: table, viewvagy stored-procedure.
--source.params A tárolt eljárások alapértelmezett paraméterértékei.
--source.key-fields Nézetek vagy táblák elsődleges kulcsmezői.

Paraméterek (tárolt eljárások)

Lehetőség Összefoglalás
--parameters.name Paraméternevek vesszővel tagolt listája.
--parameters.description Paraméterleírások vesszővel tagolt listája.
--parameters.required A szükséges jelölők vesszővel tagolt listája.
--parameters.default Az alapértelmezett értékek vesszővel tagolt listája.

--cache.enabled

Az entitás gyorsítótárazásának engedélyezése vagy letiltása.

Example

dab update \
  Book \
  --cache.enabled true

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "cache": {}
    }
  }
}

Megjegyzés:

Ha a gyorsítótárazás engedélyezve van (az alapértelmezett), a parancssori felület üres cache objektumot ír. A "enabled" tulajdonság csak akkor jelenik meg explicit módon, ha be van állítva.false

--cache.ttl

A gyorsítótár élettartamának beállítása másodpercben. Csak akkor érvényes, ha a gyorsítótárazás engedélyezve van.

Example

dab update \
  Book \
  --cache.ttl 600

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "cache": {
        "ttl-seconds": 600
      }
    }
  }
}

Megjegyzés:

A gyorsítótár letiltása esetén a TTL (élettartam) szolgáltatásának nincs hatása, amíg a gyorsítótárazás nincs engedélyezve.

--description

Az entitás leírásának cseréje.

Megjegyzés:

Ez a lehetőség a Data API Builder 2.0 parancssori felületén és újabb verzióiban érhető el. Telepítse a legújabb stabil parancssori felületet a következővel dotnet tool install microsoft.dataapibuilder: .

Example

dab update \
  Book \
  --description "Updated description"

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "description": "Updated description"
    }
  }
}

--fields.exclude

A kizárandó mezők vesszővel tagolt listája.

Example

dab update \
  Book \
  --permissions "anonymous:read" \
  --fields.exclude "internal_flag,secret_note"

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "permissions": [
        {
          "role": "anonymous",
          "actions": [
            {
              "action": "read",
              "fields": {
                "exclude": [ "internal_flag", "secret_note" ]
              }
            }
          ]
        }
      ]
    }
  }
}

--fields.include

A belefoglalandó mezők vesszővel tagolt listája. * az összes mezőt tartalmazza. Lecseréli a meglévő belefoglalási listát.

Example

dab update \
  Book \
  --permissions "anonymous:read" \
  --fields.include "id,title,author"

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "permissions": [
        {
          "role": "anonymous",
          "actions": [
            {
              "action": "read",
              "fields": {
                "exclude": [],
                "include": [ "id", "title", "author" ]
              }
            }
          ]
        }
      ]
    }
  }
}

--graphql

A GraphQL expozíciójának szabályozása.

Example

dab update \
  Book \
  --graphql book:books

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "graphql": {
        "enabled": true,
        "type": {
          "singular": "book",
          "plural": "books"
        }
      }
    }
  }
}

--graphql.operation

Csak tárolt eljárások. A művelet típusát állítja be. Az alapértelmezett érték mutation.

Example

dab update \
  RunReport \
  --graphql.operation query

Eredményként kapott konfiguráció

{
  "entities": {
    "RunReport": {
      "graphql": {
        "operation": "query"
      }
    }
  }
}

Megjegyzés:

--graphql.operation A rendszer figyelmen kívül hagyja a táblák vagy nézetek megadását.

--permissions

Engedélyeket ad hozzá vagy frissít egyetlen szerepkörhöz és műveleteihez.

Több szerepkör hozzáadásához többször is futtatható dab update (szerepkörönként egyszer).

Example

dab update \
  Book \
  --permissions "anonymous:read"

dab update \
  Book \
  --permissions "authenticated:create,read,update"

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "permissions": [
        {
          "role": "anonymous",
          "actions": [
            {
              "action": "read"
            }
          ]
        },
        {
          "role": "authenticated",
          "actions": [
            { "action": "create" },
            { "action": "read" },
            { "action": "update" }
          ]
        }
      ]
    }
  }
}

Megjegyzés:

Ha a megadott szerepkör már létezik, a műveletei frissülnek; ellenkező esetben a rendszer hozzáadja a szerepkört.

--policy-database

Az adatbázis-lekérdezéshez hozzáfűzött OData-stílusú szűrő.

Example

dab update \
  Book \
  --permissions "anonymous:read" \
  --policy-database "region eq 'US'"

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "permissions": [
        {
          "role": "anonymous",
          "actions": [
            {
              "action": "read",
              "policy": {
                "database": "region eq 'US'"
              }
            }
          ]
        }
      ]
    }
  }
}

--policy-request

Az adatbázis létrehozása előtt kiértékelt kérelemszintű szabályzat.

Example

dab update \
  Book \
  --permissions "anonymous:read" \
  --policy-request "@claims.role == 'admin'"

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "permissions": [
        {
          "role": "anonymous",
          "actions": [
            {
              "action": "read",
              "policy": {
                "request": "@claims.role == 'admin'"
              }
            }
          ]
        }
      ]
    }
  }
}

--relationship

Kapcsolat definiálása vagy frissítése. Más kapcsolati lehetőségekkel is használható.

Example

dab update \
  User \
  --relationship profile \
  --target.entity Profile \
  --cardinality one \
  --relationship.fields "id:user_id"

Eredményként kapott konfiguráció

{
  "entities": {
    "User": {
      "relationships": {
        "profile": {
          "cardinality": "one",
          "target.entity": "Profile",
          "source.fields": [ "id" ],
          "target.fields": [ "user_id" ],
          "linking.source.fields": [],
          "linking.target.fields": []
        }
      }
    }
  }
}

--cardinality

A kapcsolat számossága. Használja a --relationship-vel.

Example

dab update \
  User \
  --relationship profile \
  --target.entity Profile \
  --cardinality one \
  --relationship.fields "id:user_id"

--target.entity

A kapcsolat cél entitásneve. Használja a --relationship-vel.

Example

dab update \
  User \
  --relationship profile \
  --target.entity Profile \
  --cardinality one \
  --relationship.fields "id:user_id"

--linking.object

Csak több-a-többhöz. A csatolási objektumként használni kívánt adatbázis-objektum neve.

Example

dab update \
  Book \
  --relationship books_authors \
  --target.entity Author \
  --cardinality many \
  --relationship.fields "id:id" \
  --linking.object dbo.books_authors \
  --linking.source.fields book_id \
  --linking.target.fields author_id

--linking.source.fields

Csak több-a-többhöz. A forrásentitással összekapcsolt objektummezők vesszővel tagolt listája.

Example

dab update \
  Book \
  --relationship books_authors \
  --target.entity Author \
  --cardinality many \
  --relationship.fields "id:id" \
  --linking.object dbo.books_authors \
  --linking.source.fields book_id \
  --linking.target.fields author_id

--linking.target.fields

Csak több-a-többhöz. A célentitásra mutató objektummezők vesszővel tagolt listája.

Example

dab update \
  Book \
  --relationship books_authors \
  --target.entity Author \
  --cardinality many \
  --relationship.fields "id:id" \
  --linking.object dbo.books_authors \
  --linking.source.fields book_id \
  --linking.target.fields author_id

--relationship.fields

Kettőspontokkal tagolt mezőleképezések közvetlen kapcsolatokhoz.

Az --relationship.fields érték a párok vesszővel tagolt listája sourceField:targetField .

Example

dab update \
  User \
  --relationship profile \
  --target.entity Profile \
  --cardinality one \
  --relationship.fields "id:user_id"

Eredményként kapott konfiguráció

{
  "entities": {
    "User": {
      "relationships": {
        "profile": {
          "cardinality": "one",
          "target.entity": "Profile",
          "source.fields": [ "id" ],
          "target.fields": [ "user_id" ],
          "linking.source.fields": [],
          "linking.target.fields": []
        }
      }
    }
  }
}

--rest

A REST expozíció szabályozása.

Example

dab update \
  Book \
  --rest BooksApi

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "rest": {
        "enabled": true,
        "path": "/BooksApi"
      }
    }
  }
}

--rest.methods

Csak tárolt eljárások. Cserélje le az engedélyezett HTTP-metódusokat. Alapértelmezés szerint POST.

Example

dab update \
  RunReport \
  --rest true \
  --rest.methods GET,POST

Eredményként kapott konfiguráció

{
  "entities": {
    "RunReport": {
      "rest": {
        "enabled": true,
        "methods": [ "get", "post" ]
      }
    }
  }
}

Megjegyzés:

Ha a --rest.methods REST le van tiltva, nincs hatása a szolgáltatásnak.

-s, --source

Frissítse a mögöttes adatbázis-objektumot.

Example

dab update \
  Book \
  --source dbo.Books

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "source": {
        "object": "dbo.Books",
        "type": "table"
      }
    }
  }
}

--source.type

Módosítsa a forrásobjektum típusát.

Megjegyzés:

A nézetek használatához .--source.key-fields A kulcsmezők megadása nélkül történő view váltás hibát okoz.

Example

dab update \
  Book \
  --source.type view \
  --source.key-fields "id"

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "source": {
        "type": "view",
        "object": "Book"
      },
      "fields": [
        {
          "name": "id",
          "primary-key": true
        }
      ]
    }
  }
}

--source.params

Csak tárolt eljárások. Alapértelmezett paraméterértékek párként name:value .

Example

dab update \
  RunReport \
  --source.params "startDate:2024-01-01,endDate:2024-12-31"

Eredményként kapott konfiguráció

{
  "entities": {
    "RunReport": {
      "source": {
        "type": "stored-procedure",
        "parameters": [
          {
            "name": "startDate",
            "required": false,
            "default": "2024-01-01"
          },
          {
            "name": "endDate",
            "required": false,
            "default": "2024-12-31"
          }
        ]
      }
    }
  }
}

--source.key-fields

Adja meg az elsődleges kulcsmező(ke)t a lekövetett kulcs nélküli nézetekhez vagy táblákhoz.

Example

dab update \
  Book \
  --source.type view \
  --source.key-fields "id"

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "source": {
        "type": "view",
        "object": "Book"
      },
      "fields": [
        {
          "name": "id",
          "primary-key": true
        }
      ]
    }
  }
}

Megjegyzés:

A nézetekhez mindig kulcsmezők szükségesek. A --source.key-fields beállítás bejegyzéseket ad hozzá a tömbhöz a fields következővel "primary-key": true: .

-m, --map

Adja meg az adatbázisoszlopok és a közzétett REST/GraphQL mezőnevek közötti leképezéseket.

Example

dab update \
  Book \
  --map "id:bookId,title:bookTitle"

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "fields": [
        {
          "name": "id",
          "alias": "bookId",
          "primary-key": false
        },
        {
          "name": "title",
          "alias": "bookTitle",
          "primary-key": false
        }
      ]
    }
  }
}

Megjegyzés:

A --map beállítás bejegyzéseket hoz létre a tömbben a fieldsalias tulajdonságkészlettel.

--parameters.name

Csak tárolt eljárások. Paraméternevek vesszővel tagolt listája.

Megjegyzés:

Ez a lehetőség a Data API Builder 2.0 parancssori felületén és újabb verzióiban érhető el. Telepítse a legújabb stabil parancssori felületet a következővel dotnet tool install microsoft.dataapibuilder: .

Jótanács

Tárolt eljárásparaméterek definiálásához használja --parameters.name az --parameters.description, --parameters.requiredés --parameters.defaulta .

Example

dab update \
  GetOrdersByDateRange \
  --parameters.name "StartDate,EndDate" \
  --parameters.required "true,true" \
  --parameters.description "Beginning of date range,End of date range"

Eredményként kapott konfiguráció

{
  "entities": {
    "GetOrdersByDateRange": {
      "source": {
        "parameters": [
          {
            "name": "StartDate",
            "description": "Beginning of date range",
            "required": true
          },
          {
            "name": "EndDate",
            "description": "End of date range",
            "required": true
          }
        ]
      }
    }
  }
}

--parameters.description

Csak tárolt eljárások. A paraméterleírások vesszővel tagolt --parameters.namelistája.

Megjegyzés:

Ez a lehetőség a Data API Builder 2.0 parancssori felületén és újabb verzióiban érhető el. Telepítse a legújabb stabil parancssori felületet a következővel dotnet tool install microsoft.dataapibuilder: .

Example

dab update \
  GetOrdersByDateRange \
  --parameters.name "StartDate,EndDate" \
  --parameters.description "Beginning of date range,End of date range"

--parameters.required

Csak tárolt eljárások. Az értékek vesszővel tagolt truelistája/false--parameters.name.

Megjegyzés:

Ez a lehetőség a Data API Builder 2.0 parancssori felületén és újabb verzióiban érhető el. Telepítse a legújabb stabil parancssori felületet a következővel dotnet tool install microsoft.dataapibuilder: .

Example

dab update \
  GetOrdersByDateRange \
  --parameters.name "StartDate,EndDate" \
  --parameters.required "true,true"

--parameters.default

Csak tárolt eljárások. Az alapértelmezett értékek vesszővel tagolt --parameters.namelistája.

Megjegyzés:

Ez a lehetőség a Data API Builder 2.0 parancssori felületén és újabb verzióiban érhető el. Telepítse a legújabb stabil parancssori felületet a következővel dotnet tool install microsoft.dataapibuilder: .

Example

dab update \
  GetOrdersByDateRange \
  --parameters.name "CustomerID" \
  --parameters.default "null"

--fields.name

A leírandó adatbázisoszlop neve.

Megjegyzés:

Ez a lehetőség a Data API Builder 2.0 parancssori felületén és újabb verzióiban érhető el. Telepítse a legújabb stabil parancssori felületet a következővel dotnet tool install microsoft.dataapibuilder: .

Example

dab update \
  Products \
  --fields.name Id \
  --fields.primary-key true \
  --fields.description "Product Id"

Eredményként kapott konfiguráció

{
  "entities": {
    "Products": {
      "fields": [
        {
          "name": "Id",
          "description": "Product Id",
          "primary-key": true
        }
      ]
    }
  }
}

--fields.alias

A mező aliasa. Vesszővel tagolt --fields.namelista használata.

Megjegyzés:

Ez a lehetőség a Data API Builder 2.0 parancssori felületén és újabb verzióiban érhető el. Telepítse a legújabb stabil parancssori felületet a következővel dotnet tool install microsoft.dataapibuilder: .

Jótanács

--fields.alias A közzétett mezőnevek definiálásához használható--fields.name.

Example

dab update \
  Products \
  --fields.name "Id,Title" \
  --fields.alias "product_id,product_title"

--fields.description

A mező leírása. Vesszővel tagolt --fields.namelista használata.

Megjegyzés:

Ez a lehetőség a Data API Builder 2.0 parancssori felületén és újabb verzióiban érhető el. Telepítse a legújabb stabil parancssori felületet a következővel dotnet tool install microsoft.dataapibuilder: .

Example

dab update \
  Products \
  --fields.name Id \
  --fields.description "Product Id"

--fields.primary-key

A mező elsődleges kulcsjelölője. Az értékek vesszővel tagolt listájának true/false--fields.namehasználata.

Megjegyzés:

Ez a lehetőség a Data API Builder 2.0 parancssori felületén és újabb verzióiban érhető el. Telepítse a legújabb stabil parancssori felületet a következővel dotnet tool install microsoft.dataapibuilder: .

Jótanács

--fields.primary-key A nézetek vagy táblák elsődleges kulcsmezőinek meghatározására használható--fields.name, ha nincs kikövetkesztetett kulcs.

Example

dab update \
  SalesSummary \
  --fields.name "year,region" \
  --fields.primary-key "true,true"

Eredményként kapott konfiguráció

{
  "entities": {
    "SalesSummary": {
      "fields": [
        {
          "name": "year",
          "primary-key": true
        },
        {
          "name": "region",
          "primary-key": true
        }
      ]
    }
  }
}

--mcp.dml-tools

Engedélyezze vagy tiltsa le az MCP DML (adatkezelési nyelv) eszközeit ehhez az entitáshoz. Az alapértelmezett érték true.

Megjegyzés:

Ez a lehetőség a Data API Builder 2.0 parancssori felületén és újabb verzióiban érhető el. Telepítse a legújabb stabil parancssori felületet a következővel dotnet tool install microsoft.dataapibuilder: .

Example

dab update \
  Book \
  --mcp.dml-tools false

Eredményként kapott konfiguráció

{
  "entities": {
    "Book": {
      "mcp": {
        "dml-tools": false
      }
    }
  }
}

Megjegyzés:

Használat esetén --mcp.dml-tools állítsa be mcp objektuműrlap használatával, hogy a konfiguráció explicit legyen.

--mcp.custom-tool

Csak tárolt eljárások. Engedélyezze az MCP egyéni eszközét ehhez az entitáshoz. Az alapértelmezett érték false.

Megjegyzés:

Ez a lehetőség a Data API Builder 2.0 parancssori felületén és újabb verzióiban érhető el. Telepítse a legújabb stabil parancssori felületet a következővel dotnet tool install microsoft.dataapibuilder: .

Example

dab update \
  RunReport \
  --mcp.custom-tool true

Eredményként kapott konfiguráció

{
  "entities": {
    "RunReport": {
      "mcp": {
        "custom-tool": true
      }
    }
  }
}

-c, --config

A konfigurációs fájl elérési útja.

Example

dab update \
  Book \
  --description "Updated description" \
  --config dab-config.json

--help

A súgóképernyő megjelenítése.

Example

dab update --help

--version

Verzióinformációk megjelenítése.

Example

dab update --version

Fontos

A forrástípus módosítása érvényteleníthet más tulajdonságokat. A nézetekhez például mindig kulcsmezőkre van szükség; a tárolt eljárások nem definiálják a kulcsmezőket.

  • Last updated on