return

Arguments

ArgumentTypeRequiredDefaultDescription
idString!Yes
analyzeBooleanNo

If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

ReturnQueryResult

Query

query return(
  $id: String!,
  $analyze: Boolean
) {
  return(
    id: $id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ReturnFragment
    }
  }
}

Variables

{
  "id": "abc123",
  "analyze": true
}

Response

{
  "data": {
    "return": {
      "request_id": "abc123",
      "complexity": 987,
      "data": Return
    }
  }
}