Temporal CLI task-queue command reference
Task Queue commands allow operations to be performed on Task QueuesWhat is a Task Queue?
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
Learn more.
To run a Task Queue command, run temporal task-queue [command] [command options]
describe
The temporal task-queue describe
command provides poller information for a given 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 ServerWhat is the Temporal Server?
The Temporal Server is a grouping of four horizontally scalable services.
Learn more records the last time of each poll request.
Should LastAccessTime
exceeds one minute, it's likely that the Worker is at capacity (all Workflow and Activity slots are full) or that the Worker has shut down.
In day-to-day conversations, the term Worker is used to denote both a Worker Program and a Worker Process. Temporal documentation aims to be explicit and differentiate between them.
Learn more are removed if 5 minutes have passed since the last poll request.
With this command, information about the Task Queue can be returned to troubleshoot server issues.
temporal task-queue describe --task-queue=MyTaskQueue --task-queue-type="activity"
Use the options listed below to modify what this command returns.
- --fieldstemporal fields
Customize fields to print.
Learn more - --limittemporal limit
Number of items to print.
Learn more - --no-pagertemporal no-pager
Disables the interactive pager.
Learn more - --outputtemporal output
Output format.
Learn more - --pagertemporal pager
Sets the pager for Temporal CLI to use.
Learn more - --task-queuetemporal task-queue
Task Queue
Learn more - --task-queue-typetemporal task-queue-type
Task Queue type [workflow|activity].
Learn more - --time-formattemporal time-format
Format time as either relative, iso, raw.
Learn more
list-partition
The temporal task-queue list-partition
command displays 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, along with the matching node they are assigned to.
Use the options listed below to change the command's behavior.
- --fieldstemporal fields
Customize fields to print.
Learn more - --limittemporal limit
Number of items to print.
Learn more - --no-pagertemporal no-pager
Disables the interactive pager.
Learn more - --outputtemporal output
Output format.
Learn more - --pagertemporal pager
Sets the pager for Temporal CLI to use.
Learn more - --task-queuetemporal task-queue
Task Queue
Learn more - --time-formattemporal time-format
Format time as either relative, iso, raw.
Learn more