GraphQLスキーマ

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

スキーマは、データがどのように整理され、構造化されるかを記述します。これは、コンテンツから入力されるフィールドを持つ型の階層を定義します。また、このスキーマは、クライアントがデータグラフに対して実行できるクエリを正確に指定します。

大事な

Preview APIとDelivery APIはミューテーションをサポートしていません。

GraphQLを使用して、__schemaフィールドをクエリすることで、使用可能なデータ型を確認できます。このフィールドは、クエリのルートタイプで常に使用できます。

スキーマに存在するすべての型を表示するには、次のコマンドを実行します。

{
 __schema {
  types {
   name
  }
 }
}

スキーマには、GraphQL IDEの右側にある「スキーマ」タブからアクセスすることもできます。スキーマをダウンロードするには、SCHEMAタブのDOWNLOADボタンをクリックします。

メモ

ほとんどのGraphQL IDEは、スキーマに対してイントロスペクションクエリを実行して、開発者に追加のツール (オートコンプリートなど) を提供し、スキーマに関する情報を表示します。

種類

GraphQLタイプは、エンティティ定義がGraphQLでどのようにマッピングされるかを示しています。使用可能なタイプは、スキーマによって異なります。

スカラー型

スカラー型は、常に具象データに解決される基本的なデータ型です。Sitecore Content Hubには、次のデフォルトのスカラータイプが含まれています。

スカラータイプ	形容
Int	符号付き32ビット整数。
Float	符号付き倍精度浮動小数点値。
String	UTF-8文字シーケンス。
Boolean	trueまたはfalseの値。
ID ( stringとして連載)	オブジェクトのフェッチに使用されるか、キャッシュのキーとして使用される一意の識別子。IDは文字列としてシリアル化されますが、人間が判読できるようには意図されていません。

Content Hubには、次のカスタムスカラーデータ型も含まれています。

スカラータイプ	形容
MultiplierPath	有効なGraphQL乗数パス文字列。
DateTime	2021-01-19T17:33:00.000Z形式の日時。
Long	非常に大きな数値を格納するための拡張容量変数。
Decimal	10進数変数は、96ビット (12バイト) 符号なし整数として格納され、スケーリング係数と10進数が正か負かを示す値と共に格納されます。

オブジェクトの種類

GraphQLスキーマで定義する型のほとんどはオブジェクト型です。オブジェクト・タイプにはフィールドが含まれ、各フィールドはスカラー・タイプまたは別のオブジェクト・タイプのいずれかです。Content Hubの場合、公開可能なエンティティ定義ごとにGraphQLスキーマにいくつかのタイプがあります。生成された型 (1つのクエリ型、allクエリ型、where句を記述するための述語型、または1つの戻り値の型) を一覧表示できます。これらのタイプのフィールドは、エンティティ定義のフィールドに基づいて生成されます。IDEの「 DOCS 」タブには、オブジェクト・タイプに関する詳細情報が含まれています。

この記事を改善するための提案がある場合は、お知らせください!