GraphQL スキーマビューとスキーマエクスプローラー用の Fabric API

GraphQL 用の Fabric API は、接続するデータソースに基づいて API の構造を定義するスキーマを自動的に生成します。 GraphQL スキーマ定義言語 (SDL) で記述されたスキーマでは、クライアントがデータの操作に使用できる、使用可能なすべての型、フィールド、クエリ、および変更について説明します。

スキーマビューには、GraphQL スキーマ全体の読み取り専用のテキストベースのビューが用意されていますが、左側のウィンドウのスキーマエクスプローラーでは、API を介して公開されているオブジェクトを移動、検査、変更できます。これらのツールを組み合わせることで、API の構造を理解し、クライアントがアクセスできるデータを制御できます。

スキーマビューを使用するユーザー

スキーマビューとエクスプローラーは、次の場合に重要です。

データエンジニアは、GraphQL を介して公開する Fabric Lakehouse オブジェクトとウェアハウスオブジェクトを構成します。
クエリを記述する前に使用可能な Fabric データ型、フィールド、リレーションシップを検出するアプリケーション開発者
Fabric ワークスペースの共同作成者は、 ワークスペースのデータアクセス構造を理解して管理します
カスタム分析アプリケーションの構築時に Fabric データリレーションシップを確認する BI 開発者

スキーマビューを使用して API の構造を調べ、スキーマエクスプローラーを使用して、公開されるデータオブジェクトを変更します。

スキーマにアクセスして探索する

スキーマビューには、クエリエディターからアクセスすることも、GraphQL API 項目から直接アクセスすることもできます。スキーマビューを開くには、左下隅にある [スキーマ ] を選択します。スキーマビューには、生成されたすべての型、フィールド、クエリ、および変更を含む、完全な GraphQL SDL の読み取り専用のテキストベースのバージョンが表示されます。

次の図は、左側にスキーマエクスプローラーウィンドウがある スキーマ ビューを示しています。

スキーマエクスプローラーで移動する

左側のウィンドウの スキーマエクスプローラー を使用すると、API 内のすべてのオブジェクトを移動して検査できます。エクスプローラーはスキーマビューとクエリエディターの両方で使用できるため、クエリの記述中に API 構造を簡単に調べることができます。

スキーマエクスプローラーでノードを展開して、次の内容を表示します。

型: データソースのテーブルとビューから生成された GraphQL 型
クエリ: データを取得するための自動的に生成された読み取り操作
変更: データの作成、更新、削除のための自動的に生成された書き込み操作 (ウェアハウスのみ)

種類

型はデータの構造を表し、生成元のデータソースの名前の下に表示されます。次の図は、AdventureWorks SQL 分析エンドポイントの SalesOrderDetail テーブルから生成された SalesOrderDetail 型を示しています。

Queries

API は、公開するオブジェクトからデータを取得するためのクエリを自動的に生成します。クエリノードを展開して、使用可能なすべての読み取り操作を表示します。

ミューテーション

変更は、データを作成、更新、および削除するための書き込み操作です。ミューテーションノードを展開して、使用可能なすべての書き込み操作を表示します。

Note

変更は、Fabric Data Warehouse データソースに対してのみ生成されます。 SQL分析エンドポイント(レイクハウスやミラードデータベース)は読み取り専用で、クエリのみをサポートします。スキーマエクスプローラーで突然変異が見当たらないなら、倉庫に接続されているか確認してください。

スキーマエクスプローラーを使用してオブジェクトを変更する

API によって初期スキーマが生成されたら、スキーマエクスプローラーを使用して、API を通じて公開される内容を調整できます。スキーマエクスプローラーには、基になるデータソースを変更せずに API の構造を制御できる管理オプションが用意されています。これらのツールは、クライアントが必要とするデータのみを公開する、整理されたクリーンな API を維持するために不可欠です。

アクセス変更オプション

オブジェクトを変更するには、スキーマエクスプローラーで任意の型の横にある省略記号 (...) を選択します。次の例は、 SalesOrderDetail 型の変更メニューを示しています。

使用可能な変更オプション

スキーマの更新 - GraphQL スキーマをデータソースの最新の構造と同期します。これは、新しいテーブル、ビュー、または列をデータソースに追加し、API を介して公開する場合に使用します。この操作では、既存の構成を維持しながら、新しいオブジェクトを検出して追加します。

名前の変更 - GraphQL API でのオブジェクトの表示方法を変更します。これは、より直感的な API 名前付け規則を作成したり、クライアントから実装の詳細を非表示にしたりする場合に便利です。たとえば、 tbl_SalesOrderDetail の名前を単に SalesOrderDetailに変更できます。名前の変更は API スキーマにのみ影響し、基になるデータソースオブジェクトは変更されません。

スキーマから削除 - GraphQL API からオブジェクトを削除し、クライアントが使用できないようにします。これを使用して、機密データを非表示にしたり、非推奨のオブジェクトを削除したり、API サーフェスを簡略化したりできます。データはデータソースに残ります。API の公開のみが削除されます。

リレーションシップの管理 - オブジェクトが相互に接続する方法を定義できるリレーションシップ管理インターフェイスを開きます。リレーションシップにより、入れ子になったクエリとグラフトラバーサルが可能になり、クライアントは 1 つの要求で関連データを取得できます。詳細については、「GraphQL 用 Fabric API でのリレーションシップの管理」を参照してください。

プロパティ - データソースに表示される元の名前、GraphQL の種類名、所有者、場所 (ワークスペースとデータソース名) など、オブジェクトに関する詳細なメタデータを表示します。これを使用して、データソースと GraphQL API の間でオブジェクトがどのようにマップされるかを確認します。

クエリと変更を有効または無効にする

クエリと変更の有効化または無効化機能により、管理者と開発者は API のアクセスと使用状況をきめ細かく制御できます。 GraphQL スキーマ内の特定のクエリと変更を選択的にアクティブ化または非アクティブ化できます。これにより、コードを変更したり、変更をデプロイしたりすることなく、API 機能を動的に管理できます。

この機能は、次のようなシナリオで使用します。

API のバージョン管理: クライアントを新しいバージョンに移行するときに非推奨の操作を無効にする
メンテナンス期間: データメンテナンス中に書き込み操作 (変更) を一時的に無効にする
セキュリティとコンプライアンス: 機密性の高い操作へのアクセスをスキーマから削除せずに制限する
段階的なロールアウト: 新しいクエリまたは変更をテスト用に有効にしてから、それらを幅広く使用できるようにする

スキーマエクスプローラーのクエリと変更には、他に 2 つのオプションがあります。

無効: 要求でクエリまたは変更が実行されないようにします。実行が試行されると、エラーが返されます。クエリまたは変更を無効にすると、スキーマの再読み込みが行われ、クエリまたは変更がスキーマエクスプローラーで淡色表示されます。

有効: 以前に無効にしたクエリまたは変更を再度有効にすることができます。クエリまたは変更は、[ 有効] オプションを選択したときに発生するスキーマの再読み込み操作の直後に使用できます。

Note

ストアドプロシージャから自動生成されたクエリと変更の動作は、テーブルまたはビューから生成されたものとは異なります。削除することはできますが、無効にすることはできません。削除後は、[ データの取得 ] または [ スキーマの更新 ] オプションを使用して読み取ることができます。詳細については、「ストアドプロシージャ」を参照してください。

フィードバック

このページはお役に立ちましたか?

Last updated on 2026-01-21

GraphQL スキーマ ビューとスキーマ エクスプローラー用の Fabric API

スキーマ ビューを使用するユーザー