Udostępnij za pośrednictwem

update polecenie

Zaktualizuj istniejącą definicję jednostki w pliku konfiguracji konstruktora interfejsu API danych. Użyj tego polecenia, aby dostosować metadane źródłowe, uprawnienia, ekspozycję (REST/GraphQL), zasady, buforowanie, relacje, mapowania i opisowe metadane dla istniejącej jednostki.

Wskazówka

Użyj dab add polecenia , aby utworzyć nowe jednostki i dab update rozwijać je. Aby zarządzać metadanymi pól, użyj polecenia --fields.name z elementami --fields.alias, --fields.descriptioni --fields.primary-key.

Składnia

dab update <entity-name> [options]

Szybki rzut oka

Option Podsumowanie
<entity-name> Wymagany argument pozycyjny. Nazwa jednostki logicznej.
-s, --source Nazwa tabeli źródłowej, widoku lub procedury składowanej.
-m, --map Mapowania między polami bazy danych i uwidocznione nazwy.
--permissions Rola i akcje w role:actions formacie.
--description Zastąp opis jednostki.
-c, --config Ścieżka do pliku konfiguracji. Rozwiązanie domyślne ma zastosowanie w przypadku pominięcia.
--help Wyświetl ekran pomocy.
--version Wyświetl informacje o wersji.

Pamięć podręczna

Option Podsumowanie
--cache.enabled Włączanie lub wyłączanie buforowania jednostek.
--cache.ttl Czas wygaśnięcia pamięci podręcznej w sekundach.

Pola formularza

Option Podsumowanie
--fields.exclude Rozdzielona przecinkami lista wykluczonych pól.
--fields.include Rozdzielona przecinkami lista uwzględnionych pól (* = wszystkie).

Metadane pól

Option Podsumowanie
--fields.name Nazwa kolumny bazy danych do opisania.
--fields.alias Alias pola.
--fields.description Opis pola.
--fields.primary-key Ustaw to pole jako klucz podstawowy.

GraphQL

Option Podsumowanie
--graphql Ekspozycja graphQL: false, true, singularlub singular:plural.
--graphql.operation Tylko procedury składowane: query lub mutation (mutacja domyślna).

Uprawnienia i zasady

Option Podsumowanie
--permissions role:actions dla jednej roli. Uruchom wiele razy dla wielu ról.
--policy-database Filtr w stylu OData wstrzykiwany w zapytaniu bazy danych.
--policy-request Filtr żądania predatabase.

Relacje

Option Podsumowanie
--relationship Nazwa relacji. Użyj z opcjami relacji.
--cardinality Kardynalność relacji: one lub many.
--target.entity Nazwa jednostki docelowej.
--linking.object Łączenie obiektu dla wielu-do-wielu.
--linking.source.fields Łączenie pól obiektów wskazujących na źródło.
--linking.target.fields Łączenie pól obiektów wskazujących element docelowy.
--relationship.fields Mapowania pól dla relacji bezpośrednich.

REST

Option Podsumowanie
--rest Ekspozycja REST: false, truelub ścieżka niestandardowa.
--rest.methods Tylko procedury składowane. Zamień dozwolone czasowniki HTTP.

Mapowania

Option Podsumowanie
-m, --map Mapowania między polami bazy danych i uwidocznione nazwy.

MCP

Option Podsumowanie
--mcp.dml-tools Włącz lub wyłącz narzędzia DML MCP dla tej jednostki.
--mcp.custom-tool Włącz niestandardowe narzędzie MCP (tylko procedury składowane).

Źródło

Option Podsumowanie
-s, --source Podstawowa nazwa obiektu bazy danych.
--source.type Typ źródła: table, viewlub stored-procedure.
--source.params Domyślne wartości parametrów dla procedur składowanych.
--source.key-fields Pola klucza podstawowego dla widoków lub tabel.

Parametry (procedury składowane)

Option Podsumowanie
--parameters.name Rozdzielona przecinkami lista nazw parametrów.
--parameters.description Rozdzielona przecinkami lista opisów parametrów.
--parameters.required Rozdzielana przecinkami lista wymaganych flag.
--parameters.default Rozdzielona przecinkami lista wartości domyślnych.

--cache.enabled

Włącz lub wyłącz buforowanie dla tej jednostki.

Example

dab update \
  Book \
  --cache.enabled true

Wynikowa konfiguracja

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

Uwaga / Notatka

Gdy buforowanie jest włączone (ustawienie domyślne), interfejs wiersza polecenia zapisuje pusty cache obiekt. Właściwość jest wyświetlana "enabled" jawnie tylko po ustawieniu wartości false.

--cache.ttl

Ustaw czas wygaśnięcia pamięci podręcznej w sekundach. Tylko wtedy, gdy buforowanie jest włączone.

Example

dab update \
  Book \
  --cache.ttl 600

Wynikowa konfiguracja

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

Uwaga / Notatka

Podawanie czasu wygaśnięcia (czas wygaśnięcia), gdy pamięć podręczna jest wyłączona, nie ma wpływu do momentu włączenia buforowania.

--description

Zastąp opis jednostki.

Uwaga / Notatka

Ta opcja jest dostępna w interfejsie 2.0.0-rc wiersza polecenia. Konstruktor interfejsu API danych 2.0 jest obecnie w wersji zapoznawczej. Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

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

Wynikowa konfiguracja

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

--fields.exclude

Rozdzielona przecinkami lista pól do wykluczenia.

Example

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

Wynikowa konfiguracja

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

--fields.include

Rozdzielona przecinkami lista pól do uwzględnienia. * zawiera wszystkie pola. Zamienia istniejącą listę dołączania.

Example

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

Wynikowa konfiguracja

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

--graphql

Kontrolowanie ekspozycji GraphQL.

Example

dab update \
  Book \
  --graphql book:books

Wynikowa konfiguracja

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

--graphql.operation

Tylko procedury składowane. Ustawia typ operacji. Wartość domyślna to mutation.

Example

dab update \
  RunReport \
  --graphql.operation query

Wynikowa konfiguracja

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

Uwaga / Notatka

--graphql.operation Dostarczanie tabel lub widoków jest ignorowane.

--permissions

Dodaje lub aktualizuje uprawnienia do pojedynczej roli i jej akcji.

Możesz uruchomić dab update wiele razy (raz na rolę), aby dodać wiele ról.

Example

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

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

Wynikowa konfiguracja

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

Uwaga / Notatka

Jeśli określona rola już istnieje, jego akcje są aktualizowane; w przeciwnym razie zostanie dodana rola.

--policy-database

Filtr w stylu OData dołączony do zapytania bazy danych.

Example

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

Wynikowa konfiguracja

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

--policy-request

Zasady na poziomie żądania oceniane przed trafieniem do bazy danych.

Example

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

Wynikowa konfiguracja

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

--relationship

Definiowanie lub aktualizowanie relacji. Użyj z innymi opcjami relacji.

Example

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

Wynikowa konfiguracja

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

--cardinality

Kardynalność relacji. Użyj z --relationship.

Example

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

--target.entity

Nazwa jednostki docelowej dla relacji. Użyj z --relationship.

Example

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

--linking.object

Tylko wiele do wielu. Nazwa obiektu bazy danych, który ma być używany jako obiekt łączenia.

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

Tylko wiele do wielu. Rozdzielona przecinkami lista pól obiektów łączących wskazujących jednostkę źródłową.

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

Tylko wiele do wielu. Rozdzielona przecinkami lista pól obiektów łączących wskazująca jednostkę docelową.

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

Mapowania pól rozdzielonych dwukropkami dla relacji bezpośrednich.

Wartość --relationship.fields jest rozdzielaną przecinkami listą sourceField:targetField par.

Example

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

Wynikowa konfiguracja

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

--rest

Kontrolowanie ekspozycji REST.

Example

dab update \
  Book \
  --rest BooksApi

Wynikowa konfiguracja

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

--rest.methods

Tylko procedury składowane. Zastąp dozwolone metody HTTP. Domyślnie jest to POST.

Example

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

Wynikowa konfiguracja

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

Uwaga / Notatka

--rest.methods Dostarczanie, gdy funkcja REST jest wyłączona, nie ma wpływu.

-s, --source

Zaktualizuj bazowy obiekt bazy danych.

Example

dab update \
  Book \
  --source dbo.Books

Wynikowa konfiguracja

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

--source.type

Zmień typ obiektu źródłowego.

Uwaga / Notatka

Widoki wymagają .--source.key-fields Zmiana wartości na bez view określania pól kluczy powoduje błąd.

Example

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

Wynikowa konfiguracja

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

--source.params

Tylko procedury składowane. Domyślne wartości parametrów jako name:value pary.

Example

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

Wynikowa konfiguracja

{
  "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

Określ pola klucza podstawowego dla widoków lub tabel bez wnioskowanego klucza.

Example

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

Wynikowa konfiguracja

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

Uwaga / Notatka

Widoki zawsze wymagają pól kluczy. Opcja --source.key-fields dodaje wpisy do fields tablicy za pomocą polecenia "primary-key": true.

-m, --map

Określ mapowania między nazwami kolumn bazy danych i ujawnionymi nazwami pól REST/GraphQL.

Example

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

Wynikowa konfiguracja

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

Uwaga / Notatka

Opcja --map tworzy wpisy w tablicy fields z zestawem alias właściwości.

--parameters.name

Tylko procedury składowane. Rozdzielona przecinkami lista nazw parametrów.

Uwaga / Notatka

Ta opcja jest dostępna w interfejsie 2.0.0-rc wiersza polecenia. Konstruktor interfejsu API danych 2.0 jest obecnie w wersji zapoznawczej. Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Wskazówka

Aby zdefiniować parametry procedury składowanej, użyj polecenia --parameters.name z parametrami --parameters.description, --parameters.requiredi --parameters.default.

Example

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

Wynikowa konfiguracja

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

--parameters.description

Tylko procedury składowane. Rozdzielona przecinkami lista opisów parametrów wyrównana do --parameters.name.

Uwaga / Notatka

Ta opcja jest dostępna w interfejsie 2.0.0-rc wiersza polecenia. Konstruktor interfejsu API danych 2.0 jest obecnie w wersji zapoznawczej. Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

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

--parameters.required

Tylko procedury składowane. Rozdzielona przecinkami lista true/false wartości wyrównanych do .--parameters.name

Uwaga / Notatka

Ta opcja jest dostępna w interfejsie 2.0.0-rc wiersza polecenia. Konstruktor interfejsu API danych 2.0 jest obecnie w wersji zapoznawczej. Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

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

--parameters.default

Tylko procedury składowane. Rozdzielona przecinkami lista wartości domyślnych wyrównana do --parameters.name.

Uwaga / Notatka

Ta opcja jest dostępna w interfejsie 2.0.0-rc wiersza polecenia. Konstruktor interfejsu API danych 2.0 jest obecnie w wersji zapoznawczej. Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

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

--fields.name

Nazwa kolumny bazy danych do opisania.

Uwaga / Notatka

Ta opcja jest dostępna w interfejsie 2.0.0-rc wiersza polecenia. Konstruktor interfejsu API danych 2.0 jest obecnie w wersji zapoznawczej. Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

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

Wynikowa konfiguracja

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

--fields.alias

Alias pola. Użyj listy rozdzielanej przecinkami wyrównanej do --fields.name.

Uwaga / Notatka

Ta opcja jest dostępna w interfejsie 2.0.0-rc wiersza polecenia. Konstruktor interfejsu API danych 2.0 jest obecnie w wersji zapoznawczej. Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Wskazówka

Użyj polecenia --fields.alias , --fields.name aby zdefiniować ujawnione nazwy pól.

Example

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

--fields.description

Opis pola. Użyj listy rozdzielanej przecinkami wyrównanej do --fields.name.

Uwaga / Notatka

Ta opcja jest dostępna w interfejsie 2.0.0-rc wiersza polecenia. Konstruktor interfejsu API danych 2.0 jest obecnie w wersji zapoznawczej. Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

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

--fields.primary-key

Flaga klucza podstawowego dla pola. Użyj rozdzielanej przecinkami listy true/false wartości wyrównanych do .--fields.name

Uwaga / Notatka

Ta opcja jest dostępna w interfejsie 2.0.0-rc wiersza polecenia. Konstruktor interfejsu API danych 2.0 jest obecnie w wersji zapoznawczej. Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Wskazówka

Użyj polecenia --fields.primary-key , --fields.name aby zdefiniować pola klucza podstawowego dla widoków lub tabel bez wnioskowanego klucza.

Example

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

Wynikowa konfiguracja

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

--mcp.dml-tools

Włącz lub wyłącz narzędzia DML MCP (język manipulowania danymi) dla tej jednostki. Wartość domyślna to true.

Uwaga / Notatka

Ta opcja jest dostępna w interfejsie 2.0.0-rc wiersza polecenia. Konstruktor interfejsu API danych 2.0 jest obecnie w wersji zapoznawczej. Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

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

Wynikowa konfiguracja

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

Uwaga / Notatka

Gdy --mcp.dml-tools jest używany, ustaw mcp przy użyciu formularza obiektu, aby konfiguracja była jawna.

--mcp.custom-tool

Tylko procedury składowane. Włącz narzędzie niestandardowe MCP dla tej jednostki. Wartość domyślna to false.

Uwaga / Notatka

Ta opcja jest dostępna w interfejsie 2.0.0-rc wiersza polecenia. Konstruktor interfejsu API danych 2.0 jest obecnie w wersji zapoznawczej. Zainstaluj za pomocą polecenia dotnet tool install microsoft.dataapibuilder --version 2.0.0-rc --prerelease.

Example

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

Wynikowa konfiguracja

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

-c, --config

Ścieżka do pliku konfiguracji.

Example

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

--help

Wyświetl ekran pomocy.

Example

dab update --help

--version

Wyświetl informacje o wersji.

Example

dab update --version

Ważne

Zmiana typu źródła może unieważnić inne właściwości. Na przykład widoki zawsze wymagają pól klucza; procedury składowane nie mogą definiować pól kluczy.

  • Last updated on