Tipos, Resolvedores e Operadores do GraphQL

Mapeamento de campo

Os Serviços de Aplicativo tentam mapear campos em seu esquema de coleção diretamente para campos em seus tipos GraphQL. A definição de nomes válidos descrita na especificação GraphQL não oferece suporte a todos os possíveis nomes de campos de documento válidos, portanto, os Serviços de Aplicativo aplicam as seguintes regras de transformação para determinar nomes de campo em tipos de GraphQL gerados:

• remover caracteres inválidos

• remover números principais

• converter para camel case

• omite campos que comecem com um sublinhado duplo (por exemplo, __myField)

Mapeamento de Tipo BSON

O sistema de tipos do GraphQL é semelhante, mas não idêntico, aos tipos BSON que você pode usar em um esquema. O App Services tenta mapear automaticamente entre os tipos de BSON em seu esquema e os tipos compatíveis do GraphQL. Se um tipo de campo não tiver um equivalente do GraphQL, o App Services não incluirá o campo no tipo de documento GraphQL gerado.

A tabela a seguir lista os tipos de BSON que você pode usar em um esquema e os tipos do GraphQL para os quais eles mapeiam:

Entrada de query

Um objeto QueryInput define um conjunto de uma ou mais condições que um documento deve atender para ser incluído em uma consulta. O objeto pode incluir campos do tipo de documento, bem como qualquer um dos campos de operador que os Serviços de Aplicativo geram automaticamente com base no tipo de cada campo.

• Campos do Documento: se um campo QueryInput tiver o mesmo nome de um campo no tipo de documento, o App Services corresponderá a um documento se o valor especificado no campo de entrada e o valor do campo no documento forem iguais.

  Exemplo

  A seguinte consulta inclui uma QueryInput com dois campos, rated e year. Ambos os nomes de campo são definidos no tipo de documento Movie , portanto, o App Services executa uma correspondência de igualdade para ambos.

  A consulta retorna o título de todos os filmes lançados no ano 2000 com classificação R.

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

• Campos do operador: se um campo QueryInput for um campo de operador válido para o tipo de query, o App Services corresponderá a um documento se o operador avaliar true.

  Exemplo

  A seguinte consulta inclui uma QueryInput com dois campos, rated_in e year_gt. Ambos são campos de operador, portanto, os Serviços de Aplicativo avaliam cada operador para determinar se um documento corresponde.

  A consulta retorna o título de todos os filmes lançados após o ano de 2000 com classificação G ou 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

Um objeto InsertInput define um documento para inserir em uma coleção. O documento deve estar em conformidade com o tipo de documento GraphQL e incluir todos os campos obrigatórios.

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

UpdateInput

Um objeto UpdateInput define um novo valor para um ou mais campos em um documento. O documento atualizado inclui os novos valores de campo. Quaisquer campos que você não especificar permanecerão inalterados. Os valores atualizados devem estar em conformidade com o tipo de documento GraphQL.

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

RelationInput

Um RelationInput define um novo conjunto de documentos relacionados para um campo de relacionamento no documento mutado. Você pode referenciar documentos que já existem na coleção relacionada com o campo link ou inserir novos documentos na coleção relacionada com o campo create.

Você não pode usar link e create ao mesmo tempo. Se ambos forem especificados, a operação create terá precedência e o link será ignorado.

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

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

Ordenar por Entrada

Uma enumeração SortByInput define uma ordem de classificação para documentos retornados por uma consulta. Você pode classificar em ordem crescente e decrescente por qualquer campo de nível raiz que não tenha um tipo de object ou array. A API GraphQL não oferece suporte a classificações aninhadas.

App Services geram dois valores de enumeração de classificação para cada campo. Cada valor é um identificador totalmente capitalizado que combina o nome do campo e a direção de classificação, ASC ou DESC.

movies(sortBy: YEAR_DESC) {
  title
}

Encontrar um único documento

O campo de consulta de documento único utiliza o mesmo nome que o tipo de dados que a coleção contém. Ele retorna um único documento do tipo consultado e aceita os seguintes parâmetros:

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

Localizar vários documentos

O campo de consulta de vários documentos usa o mesmo nome que o tipo de dados que a coleção contém, mas tem um "s" adicional anexado ao nome do tipo. Ele retorna uma matriz de documentos do tipo consultado e aceita os seguintes parâmetros:

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

Inserir um único documento

O campo de mutação de inserção de documento único utiliza o nome insertOne<Type>, em que <Type> é o nome singular do tipo de dados que a coleção contém. Ele retorna o documento inserido e aceita os seguintes parâmetros:

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

Insira vários documentos

O campo de mutação de inserção de documento múltiplo usa o nome insertMany<Type>s, em que <Type> é o nome singular do tipo de dados que a coleção contém. Ele retorna o documento inserido e aceita os seguintes 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
  }
}

Atualizar um único documento

O campo de mutação de atualização de documento único utiliza o nome updateOne<Type>, em que <Type> é o nome singular do tipo de dados que a coleção contém. Ele retorna o documento atualizado e aceita os seguintes parâmetros:

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

Atualizar vários documentos

O campo de mutação de atualização de vários documentos usa o nome updateMany<Type>s, em que <Type> é o nome singular do tipo de dados que a coleta contém. Retorna um documento UpdateManyPayload que descreve o número de campos que foram correspondidos e modificados e aceita os seguintes parâmetros:

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

Upsert um Único Documento

O campo de mutação de inserir de documento único usa o nome upsertOne<Type>, em que <Type> é o nome singular do tipo de dados que a coleção contém. Esse resolvedor atualiza um documento que corresponde ao parâmetro de consulta e insere um novo documento se nenhum corresponder à consulta. Ele retorna o documento inserido e aceita os seguintes parâmetros:

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

Substituir um único documento

O campo de mutação de substituição de documento único usa o nome replaceOne<Type>, em que <Type> é o nome singular do tipo de dados que a coleção contém. Ele retorna o documento substituído e aceita os seguintes parâmetros:

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

Excluir um único documento

O campo de mutação de exclusão de documento único usa o nome deleteOne<Type>, em que <Type> é o nome singular do tipo de dados que a coleção contém. Ele retorna o documento excluído e aceita os seguintes parâmetros:

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

Excluir vários documentos

O campo de mutação de exclusão de múltiplos documentos usa o nome deleteMany<Type>s, em que <Type> é o nome singular do tipo de dados que a coleção contém. Retorna um documento DeleteManyPayload que descreve o número de documentos que foram excluídos e aceita os seguintes parâmetros:

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