Skip to main content

tctl version-next batch command reference

A "batch" command enables you to affect multiple existing Workflow ExecutionsLink preview icon

What 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

with a single command. A batch job runs in the background and affects Workflow Executions one at a time.

In tctl version-next you can run the typical Signal Workflow, Terminate Workflow, and Cancel Workflow batch jobs using the tctl workflow signal, tctl workflow terminate, and tctl workflow cancel commands respectively. The batch command is automatically started when the --query modifier is provided with those commands.

In tctl version-next, the tctl batch commands are used solely to view the status of and terminate the batch jobs.

The --query modifier supports a List FilterLink preview icon

What is a List Filter?

A List Filter is the SQL-like string that is provided as the parameter to an Advanced Visibility List API.

Learn more

. The List Filter identifies the set of Workflow Executions to be affected by the command.

A successfully started batch job returns a Job ID. You can use this Job ID in the tctl batch describe command, which describes the progress of a specific batch job.

You can also use the Job ID to terminate the batch job itself. Terminating a batch job does not roll back the operations already performed by the batch job.

tctl batch-v2 commands​

list​

The tctl batch list command lists all batch jobs.

tctl batch list <modifiers>

The following modifiers are supported and control the behavior of the command. Always include required modifiers when executing this command.

describe​

The tctl batch describe command describes the progress of a batch job.

tctl batch describe --job-id <value> <modifiers>

The following modifiers are supported and control the behavior of the command. Always include required modifiers when executing this command.

terminate​

The tctl batch terminate command terminates a batch job.

tctl batch terminate --job-id <id> <modifiers>

The following modifiers are supported and control the behavior of the command. Always include required modifiers when executing this command.