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 in the background. 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.

There are three types of Batch Jobs:

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. Batch Jobs can be returned for an entire Cluster or a single Namespace. temporal batch list --namespace=MyNamespace

Use the command options listed below to change the information returned by this command.

describe​

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

Pass a valid Job ID to return a Batch Job's information. temporal batch describe --jobid=MyJobId

Use the command options listed below to change the information returned by this command.

terminate​

The temporal batch terminate command terminates a Batch job with the provided Job ID. A reason for terminating the Batch Job can also be provided for future reference.

temporal batch terminate --job-id=MyJobId --reason=JobReason

Use the command options listed below to change the behavior of this command.