ContextQMD
Back to Prefect

global_concurrency_limit

docs/v3/api-ref/python/prefect-cli-global_concurrency_limit.mdx

3.8.02.6 KB
Original Source

prefect.cli.global_concurrency_limit

Global-concurrency-limit command — native cyclopts implementation.

Manage global concurrency limits.

Functions

ls <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/global_concurrency_limit.py#L30" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
ls()

List all global concurrency limits.

inspect <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/global_concurrency_limit.py#L99" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
inspect(name: str)

Inspect a global concurrency limit.

delete <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/global_concurrency_limit.py#L155" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
delete(name: str)

Delete a global concurrency limit.

enable <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/global_concurrency_limit.py#L181" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
enable(name: str)

Enable a global concurrency limit.

disable <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/global_concurrency_limit.py#L206" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
disable(name: str)

Disable a global concurrency limit.

update <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/global_concurrency_limit.py#L231" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
update(name: str)

Update a global concurrency limit.

Examples:

bash
$ prefect global-concurrency-limit update my-gcl --limit 10
$ prefect gcl update my-gcl --active-slots 5
$ prefect gcl update my-gcl --slot-decay-per-second 0.5
$ prefect gcl update my-gcl --enable
$ prefect gcl update my-gcl --disable --limit 5

create <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/global_concurrency_limit.py#L327" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
create(name: str)

Create a global concurrency limit.

Examples:

bash
$ prefect global-concurrency-limit create my-gcl --limit 10
$ prefect gcl create my-gcl --limit 5 --active-slots 3
$ prefect gcl create my-gcl --limit 5 --active-slots 3 --slot-decay-per-second 0.5
$ prefect gcl create my-gcl --limit 5 --disable