Temporal CLI task-queue command reference

Task Queue commands allow operations to be performed on Task Queues 🔗

x

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

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

x

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

x

Link preview

What is the Temporal Server?

The Temporal Server is a grouping of four horizontally scalable services.

term explanation

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. Workers 🔗

x

Link preview

What is a Worker?

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.

term explanation

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.

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --task-queue 🔗

  x

  Link preview

  temporal task-queue

  Task Queue

  cli reference temporal cli options-feature command-line-interface-cli task queue

• --task-queue-type 🔗

  x

  Link preview

  temporal task-queue-type

  Task Queue type [workflow|activity].

  cli reference temporal cli options-feature command-line-interface-cli task queue task queue type

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time

list-partition

The temporal task-queue list-partition command displays the partitions of a Task Queue 🔗

x

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

, along with the matching node they are assigned to.

Use the options listed below to change the command's behavior.

• --fields 🔗

  x

  Link preview

  temporal fields

  Customize fields to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --limit 🔗

  x

  Link preview

  temporal limit

  Number of items to print.

  cli reference temporal cli options-feature command-line-interface-cli

• --no-pager 🔗

  x

  Link preview

  temporal no-pager

  Disables the interactive pager.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --output 🔗

  x

  Link preview

  temporal output

  Output format.

  cli reference temporal cli options-feature command-line-interface-cli

• --pager 🔗

  x

  Link preview

  temporal pager

  Sets the pager for Temporal CLI to use.

  cli reference temporal cli options-feature command-line-interface-cli pager

• --task-queue 🔗

  x

  Link preview

  temporal task-queue

  Task Queue

  cli reference temporal cli options-feature command-line-interface-cli task queue

• --time-format 🔗

  x

  Link preview

  temporal time-format

  Format time as either relative, iso, raw.

  cli reference temporal cli options-feature command-line-interface-cli time