GraphQL の型、リゾルバ、演算子

フィールド マッピング

App Services は、コレクション スキーマのフィールドを GraphQL 型のフィールドに直接マッピングしようとします。GraphQL 仕様で説明されている有効な名前の定義 は、有効なドキュメント フィールド名がすべてサポートされているわけではないため、App Services では、生成された GraphQL 型のフィールド名を決定するために次の変換ルールを適用します。

• サポートされていない文字の削除

• 先頭の数字を取り除く

• キャメルケースに変換する

• 二重アンダースコアで始まるフィールドを省略します（例: __myField )

BSON 型マッピング

GraphQL 型システムは、スキーマで使用できる BSON types と似ていますが、同一ではありません。App Services は、スキーマ内の BSON types とサポートされている GraphQL 型との間のマップを自動的に試行します。フィールドの種類に同等の GraphQL がない場合、App Services は生成された GraphQL ドキュメントの種類にフィールドを含めません。

次の表に、スキーマで使用できる BSON types と、それらがマッピングされる GraphQL 型を示します。

クエリ入力

QueryInput オブジェクトは、クエリに含めるためにドキュメントが満たす必要がある 1 つ以上の条件のセットを定義します。オブジェクトには、ドキュメント型のフィールドだけでなく、App Services が各フィールドの型に基づいて自動的に生成する任意の演算子フィールドが含まれる場合があります。

• ドキュメント フィールド: QueryInputフィールドの名前がドキュメント型のフィールドと同じである場合、入力フィールドに指定された値とドキュメント内のフィールドの値が同じであれば、App Services はドキュメントを一致させます。

  例

  次のクエリには、2 つのフィールドを持つQueryInputと、ratedとyearが含まれています。これらのフィールド名は両方ともMovieドキュメント型で定義されているため、App Services は両方に対して等価一致を実行します。

  このクエリは、2000 年にリリースされ、R 指定されたすべての映画のタイトルを返します。

  movies(query: { rated: "R", year: 2000 }) {
    title
  }

• 演算子フィールド:QueryInput フィールドがクエリ対象型の有効な演算子フィールドである場合、演算子が true と評価すると、App Services はドキュメントを照合します。

  例

  次のクエリには、2 つのフィールドを持つQueryInputと、rated_inとyear_gtが含まれています。これらはどちらも演算子フィールドなので、App Services は各演算子を評価して文書が一致するかどうかを判断します。

  このクエリは、2000 年以降にリリースされ、G または PG-13 指定されたすべての映画のタイトルを返します。

  movies(query: { rated_in: ["G", "PG-13"], year_gt: 2000 }) {
    title
  }

<Field Name>_<Operator>: <Operator Value>

movies(query: { year_gt: 2000 }) {
  title
  year
}

movies(query: { year_gte: 2000 }) {
  title
  year
}

movies(query: { year_lt: 2000 }) {
  title
  year
}

movies(query: { year_lte: 2000 }) {
  title
  year
}

movies(query: { year_ne: 2000 }) {
  title
  year
}

movies(query: { cast_in: ["Emma Stone", "Ryan Gosling"] }) {
  title
  year
}

movies(query: { rated_nin: ["G", "PG-13"] }) {
  title
  year
}

<Operator>: [<QueryInput>, ...]

query {
  movies(query: { AND: [{ rated: "PG-13" }, { runtime_lt: 120 }] }) {
    title
    year
  }
}

query {
  movies(query: { OR: [{ rated: "G" }, { rated: "PG-13" }] }) {
    title
    year
  }
}

<Field Name>_<Operator>: <Operator Value>

query {
  movies(query: { year_exists: false }) {
    _id
    title
  }
}

InsertInput

InsertInputオブジェクトは、コレクションに挿入するドキュメントを定義します。ドキュメントは GraphQL ドキュメント型に準拠し、すべての必須フィールドを含める必要があります。

insertOneMovie(input: {
  title: "My Fake Film",
  rated: "UNRATED",
  year: 2020
}) {
  title
}

UpdateInput

UpdateInputオブジェクトは、ドキュメント内の 1 つ以上のフィールドに新しい値を定義します。更新されたドキュメントには新しいフィールド値が含まれます。指定しないフィールドは変更されません。更新された値は、GraphQL ドキュメント タイプに準拠している必要があります。

updateOneMovie(
  query: { title: "My Fake Film" }
  set: { title: "My Super Real Film" }
) {
  title
}

関係入力

RelationInput は、変更されたドキュメント内の関係フィールドに関連するドキュメントの新しいセットを定義します。link フィールドを使用して関連コレクションに既に存在するドキュメントを参照したり、create フィールドを使用して関連コレクションに新しいドキュメントを挿入したりできます。

linkとcreateの両方を同時に使用することはできません。両方が指定されている場合は、 create操作が優先され、 linkは無視されます。

type RelationInput {
  link: [ObjectId]
  create: [InsertInput]
}

updateOneMovie(
  query: { title: "My Fake Film" }
  set: {
    reviews: {
      link: ["", ""]
      create: []
    }
  }
) {
  title
}

入力による並べ替え

SortByInput列挙型は、クエリによって返されるドキュメントの並べ替え順序を定義します。object または array のタイプがないルートレベルのフィールドであれば、昇順または降順でソートできます。GraphQL API はネストされたソートをサポートしていません。

App Services は、フィールドごとに 2 つの並べ替え列挙値を生成します。各値は、フィールド名とソート方向（ASC または DESC）を組み合わせた完全大文字の識別子です。

movies(sortBy: YEAR_DESC) {
  title
}

単一ドキュメントの検索

単一ドキュメント クエリ フィールドでは、コレクションに含まれるデータ型と同じ名前が使用されます。クエリされたタイプの単一のドキュメントを返し、次のパラメータを受け入れます。

query {
  movie(query: { title: "The Matrix" }) {
    title
    year
    runtime
    director
  }
}

複数ドキュメントの検索

マルチ ドキュメント クエリ フィールドは、コレクションに含まれるデータ型と同じ名前を使用しますが、型名の後に "s" が追加されます。クエリされた型のドキュメントの配列を返し、次のパラメータを受け入れます。

query {
  movies(
    query: { year: 2000 }
    limit: 100
    sortBy: TITLE_ASC
  ) {
    title
    year
    runtime
    director
  }
}

単一ドキュメントのインサート

単一ドキュメント挿入ミューテーション フィールドはinsertOne<Type> という名前を使用し、 <Type> はコレクションが含むデータ型の単数形の名前です。挿入されたドキュメントを返し、以下のパラメータを受け付けます。

mutation {
  insertOneMovie(data: {
    title: "Little Women"
    director: "Greta Gerwig"
    year: 2019
    runtime: 135
  }) {
    _id
    title
  }
}

複数のドキュメントの挿入

複数文書を挿入するミューテーション フィールドには insertMany<Type>s という名前を使用します。<Type> はコレクションに含まれるデータ型の単数形の名前です。挿入されたドキュメントを返し、以下のパラメータを受け付けます。

mutation {
  insertManyMovies(data: [
    {
      title: "Little Women"
      director: "Greta Gerwig"
      year: 2019
      runtime: 135
    },
    {
      title: "1917"
      director: "Sam Mendes"
      year: 2019
      runtime: 119
    }
  ]) {
    _id
    title
  }
}

単一ドキュメントの更新

単一ドキュメント更新ミューテーション フィールドには updateOne<Type> という名前を使用します。<Type> はコレクションに含まれるデータ型の単数形の名前です。更新されたドキュメントを返し、以下のパラメータを受け付けます。

mutation {
  updateOneMovie(
    query: { title: "The Room" }
    set: { runtime: 99 }
  ) {
    _id
    title
  }
}

複数のドキュメントの更新

複数ドキュメント更新ミューテーション フィールドでは updateMany<Type>s という名前を使用します。<Type> はコレクションに含まれるデータ型の単数形の名前です。照合および変更されたフィールドの数を示す UpdateManyPayload ドキュメントが返され、次のパラメーターを受け入れます。

mutation {
  updateManyMovies(
    query: { director: "Tommy Wiseau" }
    set: { director: "Tom Wiseau" }
  ) {
    matchedCount
    modifiedCount
  }
}

単一ドキュメントのアップサート

単一文書のアップサートミューテーション フィールドには upsertOne<Type> という名前を使用します。<Type> はコレクションに含まれるデータ型の単数形の名前です。このリゾルバーは、クエリ　パラメータに一致するドキュメントを更新し、クエリに一致するドキュメントがない場合は新しいドキュメントを挿入します。アップサートされたドキュメントを返し、次のパラメータを受け入れます。

mutation {
  upsertOneMovie(
    query: { title: "Blacksmith Scene" }
    data: {
      title: "Sandcastles in the Sand",
      director: "Robin Scherbatsky"
      runtime: 90
      year: 2002
    }
  ) {
    _id
    title
  }
}

単一ドキュメントの置換

単一ドキュメント置換ミューテーション フィールドは replaceOne<Type> という名前を使用します。<Type> はコレクションに含まれるデータ型の単数形の名前です。置換されたドキュメントを返し、以下のパラメータを受け付けます。

mutation {
  replaceOneMovie(
    query: { title: "Blacksmith Scene" }
    data: {
      title: "Sandcastles in the Sand",
      director: "Robin Scherbatsky"
      runtime: 90
      year: 2002
    }
  ) {
    _id
    title
  }
}

単一ドキュメントの削除

単一文書削除ミューテーション フィールドには deleteOne<Type> という名前を使用します。<Type> はコレクションに含まれるデータ型の単数形の名前です。削除されたドキュメントを返し、以下のパラメータを受け付けます。

mutation {
  deleteOneMovie(query: { title: "The Room" }) {
    _id
    title
    year
    runtime
    director
  }
}

複数のドキュメントの削除

複数文書削除ミューテーション　フィールドには deleteMany<Type>s という名前を使用します。<Type> はコレクションに含まれるデータ型の単数形の名前です。この関数は、削除されたドキュメントの数を示す DeleteManyPayload ドキュメントを返し、以下のパラメータを受け入れます。

mutation {
  deleteManyMovies(query: { director: "Tommy Wiseau" }) {
    deletedCount
  }
}