Skip to main content

Temporal CLI batch command reference

Batch commands allow you to change multiple Workflow ExecutionsLink preview iconWhat is a Workflow Execution?

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Learn more without having to repeat yourself on the command line. In order to do this, you provide the command with a List FilterLink preview iconWhat is Visibility?

The term Visibility, within the Temporal Platform, refers to the subsystems and APIs that enable an operator to view Workflow Executions that currently exist within a Cluster.

Learn more and the type of Batch job to execute.

The List Filter identifies the Workflow Executions that will be affected by the Batch job. The Batch type determines the other parameters that need to be provided, along with what is being affected on the Workflow Executions.

To start the Batch job, run temporal workflow query. Running Signal, Terminate, or Cancel with the --query modifier will start a Batch job automatically.

A successfully started Batch job will return a Job ID. Use this Job ID to execute other actions on the Batch job.

list​

When used, temporal batch list returns all Batch jobs.

Use the command options listed below to change the information returned by this command. Make sure to write the command in this format: temporal batch list [command options] [arguments]

describe​

The temporal batch describe command shows the progress of an ongoing Batch job.

Use the command options listed below to change the information returned by this command. Make sure to write the command in this format: temporal batch describe [command options] [arguments]

terminate​

The temporal batch terminate command terminates a Batch job with the provided Job ID.

Use the command options listed below to change the behavior of this command. Make sure to write the command as follows: temporal batch terminate [command options] [arguments]