tctl v1.17 taskqueue command reference

Temporal CLI is now available!

The new Temporal CLI is available for use.

tctl v1.17 can still be used with Temporal Server version 1.20 and is expected to be compatible with Temporal Server version 1.21.

tctl is expected to be fully deprecated by Temporal Server version 1.22

The tctl taskqueue command enables Task QueueWhat is a Task Queue?

A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.

Learn more operations.

Alias: t

• tctl taskqueue describetctl taskqueue describe
  
  How to describe the poller information of a Task Queue using tctl.
  
  Learn more
• tctl taskqueue list-partitiontctl taskqueue list-partition
  
  How to list Task Queue partitions and the hostname for partitions using tctl.
  
  Learn more

describe

The tctl taskqueue describe command describes the poller information of a Task QueueWhat is a Task Queue?

A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.

Learn more.

tctl taskqueue describe <modifiers> <value>

The following modifiers control the behavior of the command.

--taskqueue

Required modifier

Specify a Task QueueWhat is a Task Queue?

A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.

Learn more.

Alias: --t

Example

tctl taskqueue describe --taskqueue <value>

--taskqueuetype

Specify the type of a Task QueueWhat is a Task Queue?

A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.

Learn more. The type can be workflow or activity. The default is workflow.

Example

tctl taskqueue describe --taskqueue <value> --taskqueuetype <type>

list-partition

The tctl taskqueue list-partition command lists the partitions of a Task QueueWhat is a Task Queue?

A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.

Learn more and the hostname for the partitions.

tctl taskqueue list-partition --taskqueue <value>

The following modifier controls the behavior of the command.

--taskqueue

Required modifier

Specify a Task QueueWhat is a Task Queue?

A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.

Learn more description.

Alias: --t

Example

tctl taskqueue list-partition --taskqueue <value>