work_queue

prefect.cli.work_queue

Work queue command — native cyclopts implementation.

Manage work queues.

Functions

create

create(name: Annotated[str, cyclopts.Parameter(help='The unique name to assign this work queue')])

Create a work queue.

set_concurrency_limit

set_concurrency_limit(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue')], limit: Annotated[int, cyclopts.Parameter(help='The concurrency limit to set on the queue.')])

Set a concurrency limit on a work queue.

clear_concurrency_limit

clear_concurrency_limit(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue to clear')])

Clear any concurrency limits from a work queue.

pause

pause(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue to pause')])

Pause a work queue.

resume

resume(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue to resume')])

Resume a paused work queue.

inspect

inspect(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue to inspect')])

Inspect a work queue by ID.

slots

slots(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue.')])

Show concurrency slot utilization for a work queue.

ls

ls()

View all work queues.

preview

preview(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue to preview')])

Preview a work queue.

delete

delete(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue to delete')])

Delete a work queue by ID.

read_wq_runs

read_wq_runs(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue to poll')])

Get runs in a work queue.

Note that this will trigger an artificial poll of the work queue.