Sdílet prostřednictvím

update příkaz

Aktualizujte existující definici entity v konfiguračním souboru Tvůrce rozhraní Data API. Tento příkaz slouží k úpravě zdrojových metadat, oprávnění, expozice (REST/GraphQL), zásad, ukládání do mezipaměti, relací, mapování a popisných metadat po přidání entity.

Návod

Slouží dab add k vytváření nových entit a dab update k jejich vývoji. Přemapování názvu pole (--map) je k dispozici pouze v update, nikoli v add.

Syntaxe

dab update <entity-name> [options]

Rychlý přehled

Možnost Shrnutí
<entity-name> Povinný poziční argument. Název logické entity
-s, --source Název zdrojové tabulky, zobrazení nebo uložené procedury
--permissions Role a akce ve role:actions formátu
--description Nahraďte popis entity.
-c, --config Cesta ke konfiguračnímu souboru Výchozí rozlišení se použije, pokud je vynecháno.
--help Zobrazení obrazovky nápovědy
--version Zobrazí informace o verzi.

Cache

Možnost Shrnutí
--cache.enabled Povolte nebo zakažte ukládání entit do mezipaměti.
--cache.ttl Ukládání do mezipaměti v sekundách

Fields

Možnost Shrnutí
--fields.exclude Seznam vyloučených polí oddělených čárkami
--fields.include Čárkami oddělený seznam zahrnutých polí (* = vše).
-m, --map Dvojice name:aliasmapování polí . Nahradí celou sadu.

Metadata polí

Možnost Shrnutí
--fields.name Název databázového sloupce, který chcete popsat.
--fields.alias Alias pole
--fields.description Popis pole
--fields.primary-key Nastavte toto pole jako primární klíč.

GraphQL

Možnost Shrnutí
--graphql Expozice GraphQL: false, true, singularnebo singular:plural.
--graphql.operation Uložené procedury: query nebo mutation (výchozí mutaci).

Oprávnění a zásady

Možnost Shrnutí
--permissions role:actions pro jednu roli. Spusťte vícekrát pro více rolí.
--policy-database Filtr ve stylu OData vložený do dotazu databáze
--policy-request Filtr požadavků před databází

Relationships

Možnost Shrnutí
--relationship Název relace Používá se s možnostmi relací.
--cardinality Kardinalita relace: one nebo many.
--target.entity Název cílové entity.
--linking.object Propojení objektu pro M:N
--linking.source.fields Propojení polí objektů odkazující na zdroj
--linking.target.fields Propojení polí objektů odkazující na cíl
--relationship.fields Mapování polí pro přímé relace

REST

Možnost Shrnutí
--rest Expozice REST: false, truenebo vlastní cesta.
--rest.methods Uložené procedury. Nahraďte povolené příkazy HTTP.

Zdroj

Možnost Shrnutí
-s, --source Název základního databázového objektu
--source.key-fields Vyžaduje se pro zobrazení nebo tabulky, které nejsou pk.
--source.params Uložené procedury. Nahraďte výchozí parametry.
--source.type Typ zdroje: table, viewnebo stored-procedure.

Parametry (uložené procedury)

Možnost Shrnutí
--parameters.name Čárkami oddělený seznam názvů parametrů.
--parameters.description Čárkami oddělený seznam popisů parametrů
--parameters.required Čárkami oddělený seznam požadovaných příznaků
--parameters.default Čárkami oddělený seznam výchozích hodnot.

--cache.enabled

Povolte nebo zakažte ukládání do mezipaměti pro tuto entitu.

Example

dab update \
  Book \
  --cache.enabled true

Výsledná konfigurace

{
  "entities": {
    "Book": {
      "cache": {
        "enabled": true
      }
    }
  }
}

--cache.ttl

Nastavte dobu mezipamětí v sekundách. Platí pouze v případě, že je povolené ukládání do mezipaměti.

Example

dab update \
  Book \
  --cache.ttl 600

Výsledná konfigurace

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

Poznámka:

Zadávání hodnoty TTL, pokud je mezipaměť zakázaná, nemá žádný vliv, dokud se ukládání do mezipaměti nepovolí.

--description

Nahraďte popis entity.

Poznámka:

Tato možnost je dostupná pouze v předběžné verzi rozhraní příkazového řádku verze 1.7 (aktuálně RC). Nainstalujte pomocí dotnet tool install microsoft.dataapibuilder --prereleasenástroje .

Example

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

Výsledná konfigurace

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

--fields.exclude

Seznam polí oddělených čárkami, která chcete vyloučit.

Example

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

Výsledná konfigurace

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

--fields.include

Seznam polí oddělených čárkami, která se mají zahrnout. * obsahuje všechna pole. Nahradí existující seznam zahrnutí.

Example

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

Výsledná konfigurace

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

--graphql

Řízení expozice GraphQL

Example

dab update \
  Book \
  --graphql book:books

Výsledná konfigurace

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

--graphql.operation

Uložené procedury. Nastaví typ operace. Výchozí hodnota je mutation.

Example

dab update \
  RunReport \
  --graphql.operation query

Výsledná konfigurace

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

Poznámka:

--graphql.operation Zadávání tabulek nebo zobrazení se ignoruje.

-m, --map

Mapovat pole databáze na vystavené názvy Nahradí celou sadu mapování.

Example

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

Výsledná konfigurace

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

Důležité

Všechna existující mapování se přepíší. Přehodnocujte všechna mapování, která chcete zachovat.

--permissions

Přidá nebo aktualizuje oprávnění pro jednu roli a její akce.

Pokud chcete přidat více rolí, můžete spustit dab update vícekrát (jednou na roli).

Example

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

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

Výsledná konfigurace

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

Poznámka:

Pokud zadaná role již existuje, její akce se aktualizují; jinak se role přidá.

--policy-database

Filtr ve stylu OData připojený k dotazu databáze.

Example

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

Výsledná konfigurace

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

--policy-request

Zásady na úrovni požadavku se vyhodnocovaly před dosažením databáze.

Example

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

Výsledná konfigurace

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

--relationship

Definujte nebo aktualizujte relaci. Používá se s dalšími možnostmi relace.

Example

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

Výsledná konfigurace

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

--cardinality

Kardinalita pro relaci. Používejte s --relationship.

Example

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

--target.entity

Název cílové entity pro relaci. Používejte s --relationship.

Example

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

--linking.object

Pouze M:N. Název databázového objektu, který se používá jako objekt propojování.

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

Pouze M:N. Čárkami oddělený seznam propojovacích polí objektů odkazující na zdrojovou entitu.

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

Pouze M:N. Čárkami oddělený seznam propojovacích polí objektů odkazující na cílovou entitu.

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

Mapování polí oddělených dvojtečkami pro přímé relace

Hodnota --relationship.fields je čárkami oddělený seznam sourceField:targetField dvojic.

Example

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

Výsledná konfigurace

{
  "entities": {
    "User": {
      "relationships": {
        "profile": {
          "source.fields": [ "id" ],
          "target.fields": [ "user_id" ]
        }
      }
    }
  }
}

--rest

Řízení expozice REST

Example

dab update \
  Book \
  --rest BooksApi

Výsledná konfigurace

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

--rest.methods

Uložené procedury. Nahraďte povolené metody HTTP. Výchozí hodnota je POST.

Example

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

Výsledná konfigurace

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

Poznámka:

--rest.methods Zadávání v době, kdy je rest zakázáno, nemá žádný vliv.

-s, --source

Aktualizujte podkladový databázový objekt.

Example

dab update \
  Book \
  --source dbo.Books

Výsledná konfigurace

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

--source.key-fields

Pro zobrazení nebo tabulky bez odvozené pk. Nahradí existující klíče. Není platné pro uložené procedury.

Example

dab update \
  SalesSummary \
  --source.type view \
  --source.key-fields "year,region"

Výsledná konfigurace

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

Poznámka:

Použití --source.key-fields s uloženými procedurami není povoleno.

--source.params

Uložené procedury. Nahraďte výchozí hodnoty parametrů.

Poznámka:

V předběžné verzi rozhraní příkazového řádku --source.params verze 1.7 je zastaralé. Použít --parameters.name--parameters.default//--parameters.description/--parameters.required.

Example

dab update \
  RunReport \
  --source.type stored-procedure \
  --source.params "year:2024,region:west"

Výsledná konfigurace

{
  "entities": {
    "RunReport": {
      "source": {
        "parameters": [
          { "name": "year", "required": false, "default": "2024" },
          { "name": "region", "required": false, "default": "west" }
        ]
      }
    }
  }
}

Poznámka:

Použití --source.params s tabulkami nebo zobrazeními není povoleno.

--source.type

Změňte typ zdrojového objektu.

Example

dab update \
  Book \
  --source.type view

Výsledná konfigurace

{
  "entities": {
    "Book": {
      "source": {
        "type": "view",
        "object": "Book"
      }
    }
  }
}

--parameters.name

Uložené procedury. Čárkami oddělený seznam názvů parametrů.

Poznámka:

Tato možnost je dostupná pouze v předběžné verzi rozhraní příkazového řádku verze 1.7 (aktuálně RC). Nainstalujte pomocí dotnet tool install microsoft.dataapibuilder --prereleasenástroje .

Example

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

Výsledná konfigurace

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

--parameters.description

Uložené procedury. Čárkami oddělený seznam popisů parametrů zarovnaných s --parameters.name.

Poznámka:

Tato možnost je dostupná pouze v předběžné verzi rozhraní příkazového řádku verze 1.7 (aktuálně RC). Nainstalujte pomocí dotnet tool install microsoft.dataapibuilder --prereleasenástroje .

Example

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

--parameters.required

Uložené procedury. Čárkami oddělený seznam true/false hodnot zarovnaných s .--parameters.name

Poznámka:

Tato možnost je dostupná pouze v předběžné verzi rozhraní příkazového řádku verze 1.7 (aktuálně RC). Nainstalujte pomocí dotnet tool install microsoft.dataapibuilder --prereleasenástroje .

Example

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

--parameters.default

Uložené procedury. Čárkami oddělený seznam výchozích hodnot zarovnaných s --parameters.name.

Poznámka:

Tato možnost je dostupná pouze v předběžné verzi rozhraní příkazového řádku verze 1.7 (aktuálně RC). Nainstalujte pomocí dotnet tool install microsoft.dataapibuilder --prereleasenástroje .

Example

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

--fields.name

Název databázového sloupce, který chcete popsat.

Poznámka:

Tato možnost je dostupná pouze v předběžné verzi rozhraní příkazového řádku verze 1.7 (aktuálně RC). Nainstalujte pomocí dotnet tool install microsoft.dataapibuilder --prereleasenástroje .

Example

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

Výsledná konfigurace

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

--fields.alias

Alias pole Použijte čárkami oddělený seznam zarovnaný na --fields.name.

Poznámka:

Tato možnost je dostupná pouze v předběžné verzi rozhraní příkazového řádku verze 1.7 (aktuálně RC). Nainstalujte pomocí dotnet tool install microsoft.dataapibuilder --prereleasenástroje .

Example

dab update \
  Products \
  --fields.name Id \
  --fields.alias product_id

--fields.description

Popis pole Použijte čárkami oddělený seznam zarovnaný na --fields.name.

Poznámka:

Tato možnost je dostupná pouze v předběžné verzi rozhraní příkazového řádku verze 1.7 (aktuálně RC). Nainstalujte pomocí dotnet tool install microsoft.dataapibuilder --prereleasenástroje .

Example

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

--fields.primary-key

Příznak primárního klíče pro pole Použijte čárkami oddělený seznam true/false hodnot, které jsou zarovnané na .--fields.name

Poznámka:

Tato možnost je dostupná pouze v předběžné verzi rozhraní příkazového řádku verze 1.7 (aktuálně RC). Nainstalujte pomocí dotnet tool install microsoft.dataapibuilder --prereleasenástroje .

Example

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

-c, --config

Cesta ke konfiguračnímu souboru.

Example

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

--help

Zobrazení obrazovky nápovědy

Example

dab update --help

--version

Zobrazí informace o verzi.

Example

dab update --version

Důležité

Změna typu zdroje může zneplatnit jiné vlastnosti. Zobrazení například vždy vyžadují pole klíče; uložené procedury nemohou definovat pole klíč-pole.

  • Last updated on