Skip to main content

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 Queue 🔗

Link preview
What is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
term explanation
operations.

Alias: t

  • tctl taskqueue describe 🔗
    Link preview
    tctl taskqueue describe
    How to describe the poller information of a Task Queue using tctl.
    tctl cli reference
  • tctl taskqueue list-partition 🔗
    Link preview
    tctl taskqueue list-partition
    How to list Task Queue partitions and the hostname for partitions using tctl.
    tctl cli reference

describe​

The tctl taskqueue describe command describes the poller information of a Task Queue 🔗

Link preview
What is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
term explanation
.

tctl taskqueue describe <modifiers> <value>

The following modifiers control the behavior of the command.

--taskqueue​

Required modifier

Specify a Task Queue 🔗

Link preview
What is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
term explanation
.

Alias: --t

Example

tctl taskqueue describe --taskqueue <value>

--taskqueuetype​

Specify the type of a Task Queue 🔗

Link preview
What is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
term explanation
. 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 Queue 🔗

Link preview
What is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
term explanation
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 Queue 🔗

Link preview
What is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
term explanation
description.

Alias: --t

Example

tctl taskqueue list-partition --taskqueue <value>