Query Functions
Query FunctionsField To Input

Field To Input

Included in the “Power Extensions” bundle

Recupera o valor de um campo, manipula-o e passa como input para outro campo ou diretiva, tudo dentro da mesma operação.

Passe o valor do campo field como input para outro campo via $__field, e como input para uma diretiva via field @passOnwards(as: "variableName").

$__field

Passe o valor do campo como input para outro campo. A sintaxe para referenciar o valor do campo é: $ (ou seja, o símbolo de variável em GraphQL), seguido de __ e do alias ou nome do campo.

Por exemplo, o valor do campo excerpt é referenciado como $__excerpt, e postTitle: title é referenciado como $__postTitle.

A resposta do segundo campo pode, por sua vez, ser usada como input para outro campo:

{
  posts {
    excerpt
 
    # Referencing previous field with name "excerpt"
    isEmptyExcerpt: _isEmpty(value: $__excerpt)
 
    # Referencing previous field with alias "isEmptyExcerpt"
    isNotEmptyExcerpt: _not(value: $__isEmptyExcerpt)
  }
}

A resposta será:

{
  "data": {
    "posts": [
      {
        "excerpt": "Some post excerpt",
        "isEmptyExcerpt": false,
        "isNotEmptyExcerpt": true
      },
      {
        "excerpt": "",
        "isEmptyExcerpt": true,
        "isNotEmptyExcerpt": false
      }
    ]
  }
}
# This will fail because the reference to the field must appear after the field, not before
{
  posts {
    isEmptyExcerpt: _isEmpty(value: $__excerpt)
    excerpt
  }
}
 
# This will fail because the reference must be done within the same node
{
  posts {
    excerpt
  }
  isEmptyExcerpt: _isEmpty(value: $__excerpt)
}

O campo também não pode ser referenciado a partir de um argumento de diretiva (para isso, use @passOnwards):

# This will fail because the reference can be only used as input to a field, not to a directive
{
  posts {
    hasComments
    title @include(if: $__hasComments)
  }
}

@passOnwards

A diretiva @passOnwards torna o valor resolvido do campo disponível para as diretivas subsequentes por meio de uma variável dinâmica.

Na query abaixo, o campo notHasComments é composto obtendo o valor do campo hasComments e calculando seu valor oposto. Isso funciona da seguinte forma:

  • O valor do campo é disponibilizado via @passOnwards; o valor do campo pode então ser passado como input para qualquer diretiva subsequente
  • @applyField recebe o input (exportado sob a variável dinâmica $postHasComments), aplica o campo global not sobre ele e armazena o resultado de volta no campo
{
  posts {
    id
    hasComments
    notHasComments: hasComments
      @passOnwards(as: "postHasComments")
      @applyField(
        name: "_not"
        arguments: {
          value: $postHasComments
        },
        setResultInResponse: true
      )
  }
}

Isso produzirá:

{
  "data": {
    "posts": [
      {
        "id": 1724,
        "hasComments": true,
        "notHasComments": false
      },
      {
        "id": 358,
        "hasComments": false,
        "notHasComments": true
      },
      {
        "id": 555,
        "hasComments": false,
        "notHasComments": true
      }
    ]
  }
}

Também é possível recuperar o valor de qualquer campo resolvido no objeto, passando o alias ou o nome do campo sob o arg property.

Por exemplo, nesta query, acessamos o valor resolvido pelo nome do campo id, ou pelo alias second, e exportamos esse valor via uma variável dinâmica para exibi-lo em uma query subsequente:

query One {
  id
  second: _echo(value: 2)
    @passOnwards(
      property: "id",
      as: "resolvedFirstValue"
    )
    @exportFrom(
      scopedDynamicVariable: $resolvedFirstValue,
      as: "firstValue"
    )
  third: _echo(value: 3)
    @passOnwards(
      property: "second",
      as: "resolvedSecondValue"
    )
    @exportFrom(
      scopedDynamicVariable: $resolvedSecondValue,
      as: "secondValue"
    )
}
 
query Two @depends(on: "One") {
  firstValue: _echo(value: $firstValue)
  secondValue: _echo(value: $secondValue)
}

Isso produzirá:

{
  "data": {
    "id": "root",
    "second": 2,
    "third": 3,
    "firstValue": "root",
    "secondValue": 2
  }
}

Exemplos

Se o resumo do post estiver vazio, use o título no lugar:

{
  posts {
    title
    originalExcerpt: excerpt
    isEmptyExcerpt: _isEmpty(value: $__originalExcerpt)
    excerpt: _if(condition: $__isEmptyExcerpt, then: $__title, else: $__originalExcerpt)
  }
}

Recupere dados de um endpoint REST externo e manipule-os conforme suas necessidades.

{
  externalData: _sendJSONObjectItemHTTPRequest(input: { url: "https://example.com/rest/some-external-endpoint"} )
  userName: _objectProperty(object: $__externalData, by: { path: "data.user.name" })
  userLastName: _objectProperty(object: $__externalData, by: { path: "data.user.surname" })
}

Isso produzirá:

{
  "data": {
    "externalData": {
      "data": {
        "user": {
          "id": 1,
          "name": "Leo",
          "surname": "Loso"
        }
      }
    },
    "userName": "Leo",
    "userLastName": "Loso"
  }
}

Usando a diretiva @remove em externalData, também podemos evitar que os dados de origem do endpoint externo sejam impressos na resposta:

{
  externalData: _sendJSONObjectItemHTTPRequest(input: { url: "https://example.com/rest/some-external-endpoint" } ) @remove
  userName: _objectProperty(object: $__externalData, by: { path: "data.user.name" })
  userLastName: _objectProperty(object: $__externalData, by: { path: "data.user.surname" })
}

Isso agora produzirá:

{
  "data": {
    "userName": "Leo",
    "userLastName": "Loso"
  }
}

Recupere os posts de cada usuário que mencionam o e-mail do usuário:

{
  users {
    email
    posts(filter: { search: $__email }) {
      id
      title
    }
  }
}

Envie uma newsletter definindo os e-mails to e from por meio do campo optionValue:

mutation {
  fromEmail: optionValue(name: "admin_email")
  toEmail: optionValue(name: "subscribers_email_list_recipient_address")
  _sendEmail(
    from: {
      email: $__fromEmail
    }
    to: $__toEmail
    subject: "Weekly summary"
    messageAs: {
      html: "..."
    }
  )
}

Execute operações condicionais com base no valor do campo. Nesta query, os usuários "Leo" e "Peter" têm seus nomes convertidos para maiúsculas, pois estão no array de "usuários especiais", enquanto "Martin" não:

query {
  users {
    name
      @passOnwards(as: "userName")
      @applyField(
        name: "_inArray"
        arguments: {
          value: $userName
          array: ["Leo", "John", "Peter"]
        }
        passOnwardsAs: "isSpecialUser"
      )
      @if(
        condition: $isSpecialUser
      )
        @strUpperCase
  }
}

...produzindo:

{
  "data": {
    "users": [
      {
        "name": "LEO"
      },
      {
        "name": "Martin"
      },
      {
        "name": "PETER"
      }
    ]
  }
}