Skip to main content
Version: june-2022

tctl batch start

The tctl batch start command starts a batch job.

tctl batch start --query <value> [<modifiers>]

The following modifiers control the behavior of the command.

--query

Required modifier

Specify the Workflow Executions that this batch job should operate.

The SQL-like query of Search Attributes is the same as used by the tctl workflow list --query command.

Alias: -q

Example

tctl batch start --query <value>

--reason

Specify a reason for running this batch job.

Alias: --re

Example

tctl batch start --query <value> --reason <string>

--batch_type

Specify the operation that this batch job performs. The supported operations are signal, cancel, and terminate.

Alias: --bt

Example

tctl batch start --query <value> --batch_type <operation>

--signal_name

Specify the name of a Signal. This modifier is required when --batch_type is signal.

Alias: --sig

Example

tctl batch start --query <value> --batch_type signal --signal_name <name>

--input

Pass input for the Signal. Input must be in JSON format.

Alias: -i

Example

tctl batch start --query <value> --input <json>

--rps

Specify RPS of processing. The default value is 50.

Example

tctl batch start --query <value> --rps <value>

--yes

Disable the confirmation prompt.

Example

tctl batch start --query <value> --yes