データ API ビルダーのコマンド ライン インターフェイス リファレンス
Data API Builder コマンド ライン インターフェイス (CLI) (dab CLI または dab) は、Data API ビルダーを使用してアプリケーションのローカル開発エクスペリエンスを合理化するコマンド ライン ツールです。
ヒント
データ API ビルダー CLI には、統合されたヘルプ システムが付属しています。 使用できるコマンドの一覧を取得するには、 コマンドの --help オプションを dab 使用します。
dab --help
特定のコマンドに関するヘルプを表示するには、 オプションを使用します --help 。 たとえば、コマンドの詳細については、次を init 参照してください。
dab init --help
コマンド ライン動詞とオプション
init
データ API ビルダー ランタイム エンジンのランタイム構成を初期化します。 オプションとして指定されたプロパティを使用して、新しい JSON ファイルを作成します。
構文
dab init [options]
例
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
オプション
| オプション | オプション必須 | 既定値 | 値 必ず指定します。 | 値の型 | 説明 |
|---|---|---|---|---|---|
| --database-type | ✔️ はい | ✔️ はい | string | 接続するデータベースの種類。 サポートされている値: mssql、、cosmosdb_nosql、cosmosdb_postgresql、postgresqlmysql。 |
|
| --connection-string | ❌ いいえ | "" |
✔️ はい | string | データベースに接続するための接続の詳細。 |
| --cosmosdb_nosql-database | ✔️ はい ¹ | ✔️ はい | string | Cosmos DB for NoSql のデータベース名。 | |
| --cosmosdb_nosql-container | ❌ いいえ | ✔️ はい | string | Cosmos DB for NoSql のコンテナー名。 | |
| --graphql-schema | ✔️ はい ¹ | ✔️ はい | string | GraphQL スキーマパス | |
| --set-session-context | ❌ いいえ | false |
❌ いいえ | セッション コンテキストを使用して MsSql へのデータの送信を有効にします。 | |
| --host-mode | ❌ いいえ | production |
✔️ はい | string | ホスト モードの指定 - 開発または運用 |
| --cors-origin | ❌ いいえ | "" |
✔️ はい | string | 許可される配信元の一覧を指定します。 |
| --auth.provider | ❌ いいえ | StaticWebApps |
✔️ はい | string | ID プロバイダーを指定します。 |
| --rest.path | ❌ いいえ | /api |
✔️ はい | string | REST エンドポイントのプレフィックスを指定します。 |
| --rest.disabled | ❌ いいえ | false |
❌ いいえ | すべてのエンティティの REST エンドポイントを無効にします。 | |
| --rest.enabled | ❌ いいえ | true |
✔️ はい | すべてのエンティティに対して REST エンドポイントを有効にします。 | |
| --rest.request-body-strict | ❌ いいえ | true |
✔️ はい | 要求本文で余分なフィールドを許可しません。 | |
| --graphql.path | ❌ いいえ | /graphql |
✔️ はい | string | GraphQL エンドポイントのプレフィックスを指定します。 |
| --graphql.disabled | ❌ いいえ | false |
❌ いいえ | すべてのエンティティGraphQLエンドポイントを無効にします。 | |
| --graphql.enabled | ❌ いいえ | true |
✔️ はい | すべてのエンティティGraphQLエンドポイントを有効にします。 | |
| --graphql.multiple-create.enabled | ❌ いいえ | false |
✔️ はい | GraphQLで複数の作成機能を有効にします。 | |
| --auth.audience | ❌ いいえ | ✔️ はい | string | Json Web トークン (JWT) が意図されている受信者を識別します。 | |
| --auth.issuer | ❌ いいえ | ✔️ はい | string | JWT トークンを発行したパーティを指定します。 | |
| -c,--config | ❌ いいえ | dab-config.json |
✔️ はい | string | 構成ファイルへのパス。 |
¹ このオプションは、 が にcosmosdb_nosql設定されている場合--database-typeにのみ必要です。
add
構成ファイルに新しいデータベース エンティティを追加します。 このコマンドを実行する前に構成ファイルが既にあることを確認してください。それ以外の場合はエラーが返されます。
構文
dab add [entity-name] [options]
例
dab add Book -c "dab-config.MsSql.json" --source dbo.books --permissions "anonymous:*"
オプション
| オプション | オプション必須 | 既定値 | 値 必ず指定します。 | 値の型 | 説明 |
|---|---|---|---|---|---|
| -s、--source | ✔️ はい | ✔️ はい | string | ソース テーブルまたはコンテナーの名前。 | |
| --アクセス 許可 | ✔️ はい | ✔️ はい | string | ソース テーブルまたはコンテナーにアクセスするために必要なアクセス許可。 形式: [role]:[actions]。 |
|
| --source.type | ❌ いいえ | table |
✔️ はい | string | データベース オブジェクトの型。 サポートされている値: table、、stored-procedureview。 |
| --source.params | ❌ いいえ | ✔️ はい | string | Source オブジェクトのパラメーターとその値のディクショナリ。 param1:val1,param2:value2,... ストアド プロシージャの場合は 。 |
|
| --source.keyフィールド | ✔️ はい ¹ | ✔️ はい | string | テーブルとビューのみの主キーとして使用する 1 つ以上のフィールド。 コンマ区切りの値。 例: --source.key-fields "id,name,type"。 |
|
| --残り | ❌ いいえ | 大文字と小文字を区別するエンティティ名 | ✔️ はい | string | REST API のルート。 例: --rest: false -> このエンティティの REST API 呼び出しを無効にします。 --rest: true -> エンティティ名が残りのパスになります。 --rest: "customPathName" -> 指定された customPathName が REST パスになります。 |
| --rest.methods | ❌ いいえ | post |
✔️ はい | string | ストアド プロシージャでサポートされる HTTP アクション。 アクションをコンマ区切りリストとして指定します。 有効な HTTP アクションは次のとおりです:[get, post, put, patch, delete]. |
| --graphql | ❌ いいえ | 大文字と小文字を区別するエンティティ名 | ✔️ はい | Bool/String | GraphQLで公開されるエンティティ型。 例: --graphql: false -> このエンティティの graphql 呼び出しを無効にします。 --graphql: true-> 既定の名前を持つGraphQLのエンティティを公開します。 エンティティ名の単数形は、クエリ名とミューテーション名と見なされます。 --graphql: "customQueryName" -> DAB がクエリとミューテーションに指定された値を複数形化している間に、単数形の値を明示的に設定します。 --graphql: "singularName:pluralName" -> クエリとミューテーションに使用される単数形と複数形の値 (コロン :で区切られた値) の両方を設定します。 |
| --graphql.operation | ❌ いいえ | mutation |
✔️ はい | string | ストアド プロシージャでサポートされる操作をGraphQLします。 サポートされる値: query、mutation。 |
| --fields.include | ❌ いいえ | ✔️ はい | string | アクセス許可を持つフィールド。 | |
| --fields.exclude | ❌ いいえ | ✔️ はい | string | アクション リストから除外されたフィールド。 | |
| --policy-database | ❌ いいえ | ✔️ はい | string | データベースに送信されるクエリに挿入される OData スタイルフィルタールールを指定します。 | |
| -c,--config | ❌ いいえ | dab-config.json |
✔️ はい | string | 構成ファイルへのパス。 |
¹ このオプションは、 が にview設定されている場合--source.typeにのみ必要です。
update
構成ファイル内の任意のデータベース エンティティのプロパティを更新します。
注意
dab update では、 で dab addサポートされているすべてのオプションがサポートされます。 また、一覧表示されているオプションもサポートされています。
構文
dab update [entity-name] [options]
例
dab update Publisher --permissions "authenticated:*"
オプション
| オプション | オプション必須 | 既定値 | 値 必ず指定します。 | 値の型 | 説明 |
|---|---|---|---|---|---|
| --関係 | ❌ いいえ | ✔️ はい | string | 2 つのエンティティ間のリレーションシップを指定します。 リレーションシップの名前を指定します。 | |
| --基数 | ✔️ はい ¹ | ✔️ はい | string | 2 つのエンティティ間のカーディナリティを指定します。 1 つまたは複数の可能性があります。 | |
| --target.entity | ✔️ はい ¹ | ✔️ はい | string | ソース エンティティが関連付けられている別の公開エンティティ。 | |
| --linking.object | ❌ いいえ | ✔️ はい | string | M:N リレーションシップをサポートするために使用されるデータベース オブジェクト。 | |
| --linking.source.fields | ❌ いいえ | ✔️ はい | string | リンク オブジェクト内のデータベース フィールド。ソース エンティティ内の関連アイテムに接続します。 コンマ区切りのフィールド。 | |
| --linking.target.fields | ❌ いいえ | ✔️ はい | string | リンク オブジェクト内のデータベース フィールドを使用して、ターゲット エンティティ内の関連アイテムに接続します。 コンマ区切りのフィールド。 | |
| --relationship.fields | ❌ いいえ | ✔️ はい | string | エンティティのマッピングに使用するフィールドを指定します。 例: --relationship.fields "id:book_id". ここでは、 id sourceEntity の列と targetEntity book_id からの列を表します。 指定しない場合は、基になるソース間で外部キーが必要です。 |
|
| -m,--map | ❌ いいえ | ✔️ はい | string | データベース フィールドと GraphQL フィールドと REST フィールドの間のマッピングを指定します。 形式: --map "backendName1:exposedName1, backendName2:exposedName2,..."。 |
¹ このオプションは、オプションが --relationship 使用されている場合にのみ必要です。
export
必要なスキーマをファイルとしてエクスポートし、オプションに基づいてディスクに保存します。
構文
dab export [options]
例
dab export --graphql -o ./schemas
オプション
| オプション | オプション必須 | 既定値 | 値 必ず指定します。 | 値の型 | 説明 |
|---|---|---|---|---|---|
| --graphql | ❌ いいえ | false |
❌ いいえ | スキーマGraphQLエクスポートします。 | |
| -o、--output | ✔️ はい | ✔️ はい | string | スキーマ ファイルを保存するディレクトリを指定します。 | |
| -g,--graphql-schema-file | ❌ いいえ | schema.graphql |
✔️ はい | string | Graphql スキーマ ファイルの名前を指定します。 |
| -c,--config | ❌ いいえ | dab-config.json |
✔️ はい | string | 構成ファイルへのパス。 |
start
REST 要求とGraphQL要求を提供するために、指定された構成ファイルを使用してランタイム エンジンを起動します。
構文
dab start [options]
例
dab start
オプション
| オプション | オプション必須 | 既定値 | 値 必ず指定します。 | 値の型 | 説明 |
|---|---|---|---|---|---|
| --詳細 | ❌ いいえ | ❌ いいえ | 情報としてログ レベルを指定します。 | ||
| --Loglevel | ❌ いいえ | Debug の場合 hostMode=developmentは 。それ以外の Error 場合 HostMode=Production |
✔️ はい | string | 指定された値としてログ レベルを指定します。 例: デバッグ、エラー、情報など。 |
| --no-https-redirect | ❌ いいえ | false |
✔️ はい | string | https の自動リダイレクトを無効にします。 |
| -c,--config | ❌ いいえ | dab-config.json |
✔️ はい | string | 構成ファイルへのパス。 |
注意
と --LogLevel を同時に使用--verboseすることはできません。 さまざまなログ レベルの詳細については、「 .NET ログ レベル」を参照してください。
validate
Data API Builder ランタイム エンジンによって使用されるランタイム構成ファイルを検証します。 検証プロセスにより、構成ファイルがスキーマに準拠し、ランタイム エンジンが正しく機能するために必要なすべての情報が含まれていることが保証されます。
構文
dab validate [options]
例
dab validate
オプション
| オプション | オプション必須 | 既定値 | 値 必ず指定します。 | 値の型 | 説明 |
|---|---|---|---|---|---|
| -c,--config | ❌ いいえ | dab-config.json |
✔️ はい | string | 検証の対象となる構成ファイルへのパス。 |