Skip to main content
Anchor to bulkOperationRunQuery

bulkOperationRunQuery

mutation

Creates and runs a bulk operation query.

See the bulk operations guide for more details.

Anchor to Arguments

Arguments

Anchor to groupObjectsgroupObjects
•Boolean!requiredDefault:true

Whether to group objects under their corresponding parent objects in the JSONL output. Grouping is costly, causes bulk operations to take longer to complete, and increases the chances of failures such as timeouts.

Anchor to queryquery
•String!required

The query to be executed in bulk.

Was this section helpful?

Anchor to BulkOperationRunQueryPayload returnsBulkOperationRunQueryPayload returns

Anchor to bulkOperationbulkOperation
•BulkOperation

The newly created bulk operation.

Anchor to userErrorsuserErrors
•[BulkOperationUserError!]!non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?