Referenční informace k rozhraní příkazového řádku Tvůrce rozhraní API pro data
Rozhraní příkazového řádku (CLI) (dab CLI nebo dab) tvůrce dat je nástroj příkazového řádku, který zjednodušuje místní vývojové prostředí pro aplikace využívající Tvůrce rozhraní API dat.
Tip
Rozhraní příkazového řádku Tvůrce dat api se dodává s integrovaným systémem nápovědy. Pokud chcete získat seznam dostupných příkazů, použijte --help u příkazu možnost dab .
dab --help
Pokud chcete získat nápovědu ke konkrétnímu příkazu, použijte možnost --help . Další informace o příkazu získáte například takto init :
dab init --help
Příkazy a možnosti příkazového řádku
init
Inicializuje konfiguraci modulu runtime pro modul runtime Data API Builder. Vytvoří nový soubor JSON s vlastnostmi zadanými jako možnosti.
Syntax
dab init [options]
Příklady
dab init --config "dab-config.mssql.json" --database-type mssql --connection-string "@env('SQL_CONNECTION_STRING')"
dab init --database-type mysql --connection-string "@env('MYSQL_CONNECTION_STRING')" --graphql.multiple-create.enabled true
Možnosti
| Možnosti | Požadovaná možnost | Výchozí hodnota | Hodnota: Povinný argument | Typ hodnoty | Description |
|---|---|---|---|---|---|
| --database-type | ✔️ Ano | ✔️ Ano | řetězec | Typ databáze, která se má připojit. Podporované hodnoty: mssql, cosmosdb_nosql, cosmosdb_postgresql, mysql, . postgresql |
|
| --connection-string | ❌ Ne | "" |
✔️ Ano | řetězec | Podrobnosti o připojení pro připojení k databázi |
| --cosmosdb_nosql-database | ✔️ Ano ¹ | ✔️ Ano | řetězec | Název databáze pro Cosmos DB for NoSql. | |
| --cosmosdb_nosql-container | ❌ Ne | ✔️ Ano | řetězec | Název kontejneru pro Cosmos DB for NoSql | |
| --graphql-schema | ✔️ Ano ¹ | ✔️ Ano | řetězec | Cesta schématu GraphQL | |
| --set-session-context | ❌ Ne | false |
❌ Ne | Povolte odesílání dat do MsSql pomocí kontextu relace. | |
| --host-mode | ❌ Ne | production |
✔️ Ano | řetězec | Určení režimu hostitele – vývoj nebo produkční |
| --cors-origin | ❌ Ne | "" |
✔️ Ano | řetězec | Zadejte seznam povolených původů. |
| --auth.provider | ❌ Ne | StaticWebApps |
✔️ Ano | řetězec | Zadejte zprostředkovatele identity. |
| --rest.path | ❌ Ne | /api |
✔️ Ano | řetězec | Zadejte předponu koncového bodu REST. |
| --rest.disabled | ❌ Ne | false |
❌ Ne | Zakáže koncový bod REST pro všechny entity. | |
| --rest.enabled | ❌ Ne | true |
✔️ Ano | Povolí koncový bod REST pro všechny entity. | |
| --rest.request-body-strict | ❌ Ne | true |
✔️ Ano | Nepovoluje nadbytečná pole v textu požadavku. | |
| --graphql.path | ❌ Ne | /graphql |
✔️ Ano | řetězec | Zadejte předponu koncového bodu GraphQL. |
| --graphql.disabled | ❌ Ne | false |
❌ Ne | Zakáže koncový bod GraphQL pro všechny entity. | |
| --graphql.enabled | ❌ Ne | true |
✔️ Ano | Povolí koncový bod GraphQL pro všechny entity. | |
| --graphql.multiple-create.enabled | ❌ Ne | false |
✔️ Ano | Umožňuje více funkcí vytváření v GraphQL. | |
| --auth.audience | ❌ Ne | ✔️ Ano | řetězec | Identifikuje příjemce, pro které je určený webový token JSON (JWT). | |
| --auth.issuer | ❌ Ne | ✔️ Ano | řetězec | Zadejte stranu, která vydala token JWT. | |
| -c,--config | ❌ Ne | dab-config.json |
✔️ Ano | řetězec | Cesta ke konfiguračnímu souboru |
¹ Tato možnost je vyžadována pouze v případě, že --database-type je nastavená na cosmosdb_nosqlhodnotu .
add
Přidejte do konfiguračního souboru novou entitu databáze. Před spuštěním tohoto příkazu se ujistěte, že už máte konfigurační soubor, jinak vrátí chybu.
Syntax
dab add [entity-name] [options]
Příklady
dab add Book -c "dab-config.MsSql.json" --source dbo.books --permissions "anonymous:*"
Možnosti
| Možnosti | Požadovaná možnost | Výchozí hodnota | Hodnota: Povinný argument | Typ hodnoty | Description |
|---|---|---|---|---|---|
| -s,--source | ✔️ Ano | ✔️ Ano | řetězec | Název zdrojové tabulky nebo kontejneru | |
| --Oprávnění | ✔️ Ano | ✔️ Ano | řetězec | Oprávnění požadovaná pro přístup ke zdrojové tabulce nebo kontejneru Formát: [role]:[actions]. |
|
| --source.type | ❌ Ne | table |
✔️ Ano | řetězec | Typ databázového objektu. Podporované hodnoty: table, view, stored-procedure. |
| --source.params | ❌ Ne | ✔️ Ano | řetězec | Slovník parametrů a jejich hodnot pro zdrojový objekt. param1:val1,param2:value2,... pro uložené procedury. |
|
| --source.key polí | ✔️ Ano ¹ | ✔️ Ano | řetězec | Jedno nebo více polí, která se mají použít pouze jako primární klíče pro tabulky a zobrazení. Hodnoty oddělené čárkami. Příklad --source.key-fields "id,name,type": |
|
| --Odpočinku | ❌ Ne | Název entity rozlišující malá a malá písmena | ✔️ Ano | řetězec | Trasa pro rozhraní REST API Příklady: --rest: false –> Zakáže volání rozhraní REST API pro tuto entitu. --rest: true –> Název entity se stane cestou k odpočinku. --rest: "customPathName" –> Za předpokladu, že se customPathName stane cestou REST. |
| --rest.methods | ❌ Ne | post |
✔️ Ano | řetězec | Akce HTTP, které mají být podporovány pro uloženou proceduru. Zadejte akce jako seznam oddělený čárkami. Platné akce HTTP jsou:[get, post, put, patch, delete]. |
| --graphql | ❌ Ne | Název entity rozlišující malá a malá písmena | ✔️ Ano | Logická hodnota/řetězec | Typ entity vystavený pro GraphQL Příklady: --graphql: false –> zakáže volání graphql pro tuto entitu. --graphql: true –> Zpřístupní entitu pro GraphQL s výchozími názvy. Pro názvy dotazů a mutací se uvažuje o jednotném tvaru názvu entity. --graphql: "customQueryName" –> Explicitně nastaví hodnotu singuláru, zatímco DAB pluralizuje zadanou hodnotu pro dotazy a mutaci. --graphql: "singularName:pluralName" -> Nastaví hodnotu v jednotném čísle i v množném čísle (oddělené dvojtečku :) používané pro dotazy a mutování. |
| --graphql.operation | ❌ Ne | mutation |
✔️ Ano | řetězec | Operace GraphQL, která se má podporovat pro uloženou proceduru. Podporované hodnoty: query, mutation. |
| --fields.include | ❌ Ne | ✔️ Ano | řetězec | Pole s oprávněním k přístupu. | |
| --fields.exclude | ❌ Ne | ✔️ Ano | řetězec | Pole vyloučená ze seznamů akcí. | |
| --policy-database | ❌ Ne | ✔️ Ano | řetězec | Zadejte pravidlo filtru stylu OData, které se vloží do dotazu odeslaného do databáze. | |
| -c,--config | ❌ Ne | dab-config.json |
✔️ Ano | řetězec | Cesta ke konfiguračnímu souboru |
¹ Tato možnost je vyžadována pouze v případě, že --source.type je nastavená na viewhodnotu .
update
Aktualizujte vlastnosti libovolné databázové entity v konfiguračním souboru.
Poznámka
dab update podporuje všechny možnosti, které podporuje dab add. Kromě toho podporuje také uvedené možnosti.
Syntax
dab update [entity-name] [options]
Příklady
dab update Publisher --permissions "authenticated:*"
Možnosti
| Možnosti | Požadovaná možnost | Výchozí hodnota | Hodnota: Povinný argument | Typ hodnoty | Description |
|---|---|---|---|---|---|
| --Vztah | ❌ Ne | ✔️ Ano | řetězec | Zadejte relaci mezi dvěma entitami. Zadejte název relace. | |
| --Mohutnost | ✔️ Ano ¹ | ✔️ Ano | řetězec | Zadejte kardinalitu mezi dvěma entitami. Může to být jedna nebo více. | |
| --target.entity | ✔️ Ano ¹ | ✔️ Ano | řetězec | Další vystavená entita, ke které se zdrojová entita vztahuje. | |
| --linking.object | ❌ Ne | ✔️ Ano | řetězec | Databázový objekt, který se používá k podpoře relace M:N. | |
| --linking.source.fields | ❌ Ne | ✔️ Ano | řetězec | Pole databáze v propojeném objektu pro připojení ke související položce ve zdrojové entitě. Pole oddělená čárkami. | |
| --linking.target.fields | ❌ Ne | ✔️ Ano | řetězec | Pole databáze v propojeném objektu pro připojení k související položce v cílové entitě. Pole oddělená čárkami. | |
| --relationship.fields | ❌ Ne | ✔️ Ano | řetězec | Zadejte pole, která se mají použít pro mapování entit. Příklad: --relationship.fields "id:book_id". id Zde představuje sloupec z sourceEntity, zatímco book_id z targetEntity. Cizí klíče se vyžadují mezi podkladovými zdroji, pokud nejsou zadané. |
|
| -m,--map | ❌ Ne | ✔️ Ano | řetězec | Zadejte mapování mezi databázovými poli a poli GraphQL a REST. Formát: --map "backendName1:exposedName1, backendName2:exposedName2,...". |
¹ Tato možnost je vyžadována pouze při --relationship použití této možnosti.
export
Exportujte požadované schéma jako soubor a na základě možností ho uložte na disk.
Syntax
dab export [options]
Příklady
dab export --graphql -o ./schemas
Možnosti
| Možnosti | Požadovaná možnost | Výchozí hodnota | Hodnota: Povinný argument | Typ hodnoty | Description |
|---|---|---|---|---|---|
| --graphql | ❌ Ne | false |
❌ Ne | Export schématu GraphQL | |
| -o,--output | ✔️ Ano | ✔️ Ano | řetězec | Zadejte adresář pro uložení souboru schématu. | |
| -g,--graphql-schema-file | ❌ Ne | schema.graphql |
✔️ Ano | řetězec | Zadejte název souboru schématu Graphql. |
| -c,--config | ❌ Ne | dab-config.json |
✔️ Ano | řetězec | Cesta ke konfiguračnímu souboru |
start
Spusťte modul runtime s poskytnutým konfiguračním souborem pro obsluhu požadavků REST a GraphQL.
Syntax
dab start [options]
Příklady
dab start
Možnosti
| Možnosti | Požadovaná možnost | Výchozí hodnota | Hodnota: Povinný argument | Typ hodnoty | Description |
|---|---|---|---|---|---|
| --Podrobné | ❌ Ne | ❌ Ne | Zadejte úroveň protokolování jako informační. | ||
| --Loglevel | ❌ Ne | Debug když hostMode=development, jinak Error když HostMode=Production |
✔️ Ano | řetězec | Zadejte úroveň protokolování jako zadanou hodnotu. příklad: ladění, chyba, informace atd. |
| --no-https-redirect | ❌ Ne | false |
✔️ Ano | řetězec | Zakáže automatická přesměrování https. |
| -c,--config | ❌ Ne | dab-config.json |
✔️ Ano | řetězec | Cesta ke konfiguračnímu souboru |
Poznámka
Nemůžete používat --verbose a --LogLevel současně. Další informace o různých úrovních protokolování najdete v tématu Úrovně protokolu .NET.
validate
Ověří konfigurační soubor modulu runtime, který používá modul runtime Data API Builder. Proces ověření zajišťuje, že konfigurační soubor vyhovuje schématu, a obsahuje všechny požadované informace, aby modul runtime správně fungoval.
Syntax
dab validate [options]
Příklady
dab validate
Možnosti
| Možnosti | Požadovaná možnost | Výchozí hodnota | Hodnota: Povinný argument | Typ hodnoty | Description |
|---|---|---|---|---|---|
| -c,--config | ❌ Ne | dab-config.json |
✔️ Ano | řetězec | Cesta ke konfiguračnímu souboru, který je cílem ověření. |