Tipos de GraphQL, resolutores y operadores

Mapeo de campos

App Services intenta asignar los campos del esquema de tu colección directamente a los campos de tus tipos GraphQL. La definición de nombres válidos descrita en la especificación GraphQL no admite todos los nombres de campo de documento válidos posibles, por lo que App Services aplica las siguientes reglas de transformación para determinar los nombres de campo en los tipos GraphQL generados:

• eliminar caracteres no admitidos

• números iniciales de la tira

• convertir a camel case

• omitir los campos que comienzan con un guión bajo doble (por ejemplo, __myField)

Mapeo de tipos BSON

El sistema de tipos GraphQL es similar, pero no idéntico, a los tipos BSON que se pueden usar en un esquema. App Services intenta automáticamente establecer una correspondencia entre los tipos BSON del esquema y los tipos GraphQL compatibles. Si un tipo de campo no tiene un equivalente GraphQL, App Services no lo incluye en el tipo de documento GraphQL generado.

La siguiente tabla enumera los tipos BSON que puede utilizar en un esquema y los tipos GraphQL a los que se asignan:

Entrada de consulta

Un QueryInput objeto define un conjunto de una o más condiciones que un documento debe cumplir para ser incluido en una consulta. El objeto puede incluir campos del tipo de documento, así como cualquiera de los campos de operador que App Services genera automáticamente según el tipo de campo.

• Campos de documento: si un QueryInput campo tiene el mismo nombre que un campo en el tipo de documento, App Services coincide con un documento si el valor especificado en el campo de entrada y el valor del campo en el documento son los mismos.

  Ejemplo

  La siguiente consulta incluye un QueryInput con dos campos, rated y year. Ambos nombres de campo están definidos en el tipo de documento Movie, por lo que App Services realiza una coincidencia de igualdad para ambos.

  La consulta devuelve el título de todas las películas estrenadas en el año 2000 que están clasificadas R.

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

• Campos de operador: si un QueryInput campo es un campo de operador válido para el tipo consultado, App Services coincide con un documento si el operador se evalúa true como.

  Ejemplo

  La siguiente consulta incluye un QueryInput con dos campos, rated_in y year_gt. Ambos son campos de operador, por lo que App Services evalúa cada operador para determinar si un documento coincide.

  La consulta devuelve el título de todas las películas estrenadas después del año 2000 que estén clasificadas como G o 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
  }
}

Insertar entrada

Un objeto InsertInput define un documento que se insertará en una colección. El documento debe ser compatible con el tipo de documento GraphQL e incluir todos los campos obligatorios.

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

Actualizar entrada

Un objeto UpdateInput define un nuevo valor para uno o más campos de un documento. El documento actualizado incluye los nuevos valores de campo. Los campos que no especifique permanecerán sin cambios. Los valores actualizados deben ajustarse al tipo de documento GraphQL.

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

Relación de entrada

Un RelationInput define un nuevo conjunto de documentos relacionados para un campo de relación en el documento modificado. Puede referenciar documentos ya existentes en la colección relacionada con el campo link o insertar nuevos documentos en la colección relacionada con el campo create.

No se pueden usar link y create simultáneamente. Si se especifican ambos, la operación create tiene prioridad y la link se ignora.

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

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

Ordenar por entrada

Una enumeración SortByInput define un orden de clasificación para los documentos devueltos por una consulta. Puede ordenar en orden ascendente y descendente cualquier campo de nivel raíz que no tenga un tipo object o array. La API de GraphQL no admite ordenaciones anidadas.

App Services genera dos valores de enumeración de ordenación para cada campo. Cada valor es un identificador en mayúsculas que combina el nombre del campo y la dirección de ordenación, ya sea ASC o DESC.

movies(sortBy: YEAR_DESC) {
  title
}

Buscar un solo documento

El campo de consulta de documento único usa el mismo nombre que el tipo de datos que contiene la colección. Devuelve un documento único del tipo consultado y acepta los siguientes parámetros:

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

Encuentra varios documentos

El campo de consulta de varios documentos usa el mismo nombre que el tipo de datos que contiene la colección, pero añade un "s" adicional al nombre del tipo. Devuelve una matriz de documentos del tipo consultado y acepta los siguientes parámetros:

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

Inserta un solo documento

El campo de mutación de inserción de documento único usa el nombre insertOne<Type>, donde <Type> es el nombre singular del tipo de datos que contiene la colección. Devuelve el documento insertado y acepta los siguientes parámetros:

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

Inserta varios documentos

El campo de mutación de inserción de múltiples documentos usa el nombre insertMany<Type>s, donde <Type> es el nombre singular del tipo de datos que contiene la colección. Devuelve el documento insertado y acepta los siguientes parámetros:

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

Actualiza un solo documento

El campo de mutación de actualización de documento único usa el nombre updateOne<Type>, donde <Type> es el nombre singular del tipo de datos que contiene la colección. Devuelve el documento actualizado y acepta los siguientes parámetros:

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

Actualiza varios documentos

El campo de mutación de actualización de múltiples documentos usa el nombre updateMany<Type>s, donde <Type> es el nombre singular del tipo de datos que contiene la colección. Devuelve un documento UpdateManyPayload que describe el número de campos que se compararon y modificaron, y acepta los siguientes parámetros:

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

Insertar un solo documento

El campo de mutación de inserción y actualización de un solo documento usa el nombre upsertOne<Type>, donde <Type> es el nombre singular del tipo de datos que contiene la colección. Este solucionador actualiza un documento que coincide con el parámetro de consulta e inserta un nuevo documento si ninguno coincide con la consulta. Devuelve el documento insertado y acepta los siguientes parámetros:

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

Reemplazar un solo documento

El campo de mutación de reemplazo de documento único utiliza el nombre replaceOne<Type> donde <Type> es el nombre singular del tipo de dato que contiene la colección. Devuelve el documento reemplazado y acepta los siguientes parámetros:

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

Borrar un único documento

El campo de mutación de eliminación de un solo documento usa el nombre deleteOne<Type>, donde <Type> es el nombre singular del tipo de datos que contiene la colección. Devuelve el documento eliminado y acepta los siguientes parámetros:

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

Borra varios documentos

El campo de mutación de eliminación de varios documentos usa el nombre deleteMany<Type>s, donde <Type> es el nombre singular del tipo de datos que contiene la colección. Devuelve un documento DeleteManyPayload que describe el número de documentos eliminados y acepta los siguientes parámetros:

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