Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add Cancel Query Nerdgraph Block #19498

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,18 @@ Some important details about this query:
* The `account` argument must match the `account` argument from the original query.
* This query will return results if asynchronous execution has completed; otherwise it will return `queryProgress` data.
* The query can be repeated verbatim until results or an error are returned.

## Cancel an async query [#example-cancel-query]

You can cancel an asynchronous query by using the `cancelQuery` mutation. This mutation takes the `queryId` of the
query you want to cancel. It will either return an `ACCEPTED` status, or `REJECTED` status with a reason for rejection.

```graphql
mutation {
cancelQuery(queryId: "YOUR_QUERY_ID") {
queryId
requestStatus
rejectionReason
}
}
```
Loading