Referenční informace k rozhraní příkazového řádku Pro tvůrce dat
Rozhraní příkazového řádku (CLI) (dab CLI nebo dab) tvůrce rozhraní příkazového řádku ( Data API Builder) 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.
Spropitné
Rozhraní příkazového řádku pro tvůrce dat je součástí integrovaného systému nápovědy. Seznam dostupných příkazů získáte pomocí možnosti --help příkazu dab.
dab --help
Pokud chcete získat nápovědu k určitému příkazu, použijte možnost --help. Pokud chcete například získat další informace o příkazu init:
dab init --help
Příkazy a možnosti příkazového řádku
init
Inicializuje konfiguraci modulu runtime tvůrce dat. Vytvoří nový soubor JSON s vlastnostmi, které jsou k dispozici 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
Volby
| Volby | Požadována možnost | Výchozí hodnota | Požadovaná hodnota | Typ hodnoty | Popis |
|---|---|---|---|---|---|
| --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 produkce |
| --cors-origin | ❌ Ne | "" |
✔️ Ano | řetězec | Zadejte seznam povolených zdrojů. |
| --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.enabled | ❌ Ne | true |
✔️ Ano | booleovský | 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.enabled | ❌ Ne | true |
✔️ Ano | booleovský | 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 je --database-type nastavena na cosmosdb_nosql.
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:*"
Volby
| Volby | Požadována možnost | Výchozí hodnota | Požadovaná hodnota | Typ hodnoty | Popis |
|---|---|---|---|---|---|
| -s,--zdrojový | ✔️ Ano | ✔️ Ano | řetězec | Název zdrojové tabulky nebo kontejneru | |
| --permissions | ✔️ Ano | ✔️ Ano | řetězec | Oprávnění potřebná 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ů uložené procedury a jejich datových typů Podporované datové typy jsou string, numbera boolean. Parametry jsou zadány ve formátu: paramName:type. Příklad: --source.params "id:number,isActive:boolean,name:string". |
|
| polí |
✔️ Ano ¹ | ✔️ Ano | řetězec | Jedno nebo více polí, která se mají použít jako primární klíče pouze pro tabulky a zobrazení. Čárkami oddělené hodnoty. Příklad --source.key-fields "id,name,type". |
|
| --rest | ❌ Ne | název entity s rozlišováním velkých a malých písmen | ✔️ 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 pro zbytek.
--rest: "customPathName" –> Poskytnuté customPathName se stane cestou REST. |
| --rest.methods | ❌ Ne | post |
✔️ Ano | řetězec | Akce HTTP, které se mají podporovat 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 s rozlišováním velkých a malých písmen | ✔️ Ano | Bool/String | Vystavený typ entity pro GraphQL Příklady: --graphql: false –> zakáže volání graphql pro tuto entitu.
--graphql: true –> zpřístupňuje entitu pro GraphQL s výchozími názvy. Pro názvy dotazů a mutací se považuje jednotný tvar názvu entity.
--graphql: "customQueryName" –> explicitně nastaví jedinečnou hodnotu, zatímco DAB v množném čísle nastaví zadanou hodnotu pro dotazy a mutity.
--graphql: "singularName:pluralName" –> Nastaví hodnoty v jednotném čísle i v množném čísle (oddělené dvojtečka :) používané pro dotazy a mutace. |
| --graphql.operation | ❌ Ne | mutation |
✔️ Ano | řetězec | Operace GraphQL podporovaná pro uloženou proceduru Podporované hodnoty: query, mutation. |
| --fields.include | ❌ Ne | ✔️ Ano | řetězec | Pole s oprávněním pro přístup | |
| --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 je --source.type nastavena na view.
update
Aktualizujte vlastnosti libovolné entity databáze v konfiguračním souboru.
Poznámka
dab update podporuje všechny možnosti podporované dab add. Kromě toho také podporuje uvedené možnosti.
Syntax
dab update [entity-name] [options]
Příklady
dab update Publisher --permissions "authenticated:*"
Volby
| Volby | Požadována možnost | Výchozí hodnota | Požadovaná hodnota | Typ hodnoty | Popis |
|---|---|---|---|---|---|
| --relationship | ❌ Ne | ✔️ Ano | řetězec | Zadejte vztah mezi dvěma entitami. Zadejte název relace. | |
| --kardinalita | ✔️ Ano ¹ | ✔️ Ano | řetězec | Určete kardinalitu mezi dvěma entitami. Může to být jeden nebo mnoho. | |
| --target.entity | ✔️ Ano ¹ | ✔️ Ano | řetězec | Další vystavená entita, se kterou zdrojová entita souvisí. | |
| --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 objektu propojení pro připojení ke 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 k mapování entit. Příklad: --relationship.fields "id:book_id". Tady id představuje sloupec ze zdrojeEntity, zatímco book_id z targetEntity. Cizí klíče jsou vyžadovány mezi podkladovými zdroji, pokud nejsou zadané. |
|
| -m,--map | ❌ Ne | ✔️ Ano | řetězec | Určete 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 v případě, že je použita možnost --relationship.
export
Na základě možností vyexportujte požadované schéma jako soubor a uložte ho na disk.
Syntax
dab export [options]
Příklady
dab export --graphql -o ./schemas
Volby
| Volby | Požadována možnost | Výchozí hodnota | Požadovaná hodnota | Typ hodnoty | Popis |
|---|---|---|---|---|---|
| --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 se zadaným konfiguračním souborem pro obsluhu požadavků REST a GraphQL.
Syntax
dab start [options]
Příklady
dab start
Volby
| Volby | Požadována možnost | Výchozí hodnota | Požadovaná hodnota | Typ hodnoty | Popis |
|---|---|---|---|---|---|
| --podrobné | ❌ Ne | ❌ Ne | Zadejte úroveň protokolování jako informační. | ||
| --LogLevel | ❌ Ne |
Debug při hostMode=development, jinak Error při HostMode=Production |
✔️ Ano | řetězec | Zadejte úroveň protokolování jako zadanou hodnotu. příklad: ladění, chyba, informace atd. |
| --no-https-redirect | ❌ Ne | ✔️ Ano | - | 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 současně používat --verbose a --LogLevel. 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 tvůrce rozhraní Data API. Proces ověření zajišťuje, že konfigurační soubor vyhovuje schématu a obsahuje všechny požadované informace, aby modul runtime fungoval správně.
Syntax
dab validate [options]
Příklady
dab validate
Volby
| Volby | Požadována možnost | Výchozí hodnota | Požadovaná hodnota | Typ hodnoty | Popis |
|---|---|---|---|---|---|
| -c,--config | ❌ Ne | dab-config.json |
✔️ Ano | řetězec | Cesta ke konfiguračnímu souboru, který je cílem ověření. |
Související obsah
- Referenční
Functions - Referenční konfigurace