GraphQL問合せ内のコメント

コメントは、GraphQL問合せに埋め込まれた注釈であり、特定の文の説明を記述して、問合せの理解と保守を容易にするのに役立ちます。

GraphQL表関数にコメントを追加するには、#記号を使用します。#に続くものはすべてコメントとみなされ、実行されません。

例3-20 GraphQL表関数でのコメントの定義

SELECT JSON_SERIALIZE(data PRETTY) AS data FROM GRAPHQL('
    race (limit: 2) {
        id: race_id
        name
        podium # this field is a JSON object having details of Top 3
        date: race_date
    }
');

テキスト「this field is a JSON object having details of Top 3」は、前に#記号が付けられているため、コメントとみなされます。コメントを追加しても、問合せによって生成される結果は変更されず、影響を受けません。