GraphQL API のデータベース ビュー

ビューは、Data API Builder (DAB) のテーブルの代替としてサポートされています。 ビューは、最小限の構成で GraphQL エンドポイントを介して公開できます。

コンフィギュレーション

ビューを公開するには:

• source.type を "view"に設定する
• source.objectを完全修飾ビュー名に設定する
• 行を一意に識別するには、key-fieldsを定義する
• "read" アクションを使用してアクセス許可を付与します (必要に応じて、ビューが更新可能な場合は、"create"、"update"、"delete")

CLI の例

dab add BookDetail \
  --source dbo.vw_books_details \
  --source.type "view" \
  --fields.name "id" \
  --fields.primary-key "true" \
  --permissions "anonymous:read"

構成の例

"BookDetail": {
  "source": {
    "type": "view",
    "object": "dbo.vw_books_details",
    "key-fields": [ "id" ]
  },
  "permissions": [
    {
      "role": "anonymous",
      "actions": [ "read" ]
    }
  ]
}

GraphQL の動作

• ビューが GraphQL の種類として表示される
• クエリは常にサポートされます
• 変更は、ビューが更新可能な場合にのみサポートされます
• 標準の DAB GraphQL スキーマ構造に従う

クエリの例

{
  bookDetails {
    items {
      id
      title
      authorName
    }
  }
}

アクセス許可

• 読み取り専用ビューに read アクションを使用する
• ビューが更新可能な場合にのみ、 create、 update、および delete を使用する

制限事項

• key-fields は必須です
• ビューはリレーションシップをサポートしていません
• ビューがテーブルのように動作する場合は、改ページ、フィルター処理、並べ替えがサポートされます

関連するコンテンツ

• REST API のデータベース ビュー
• ソース構成