prefect.server.schemas.sorting

Schemas for sorting Prefect REST API objects.

Classes

FlowRunSort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L17" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Defines flow run sorting options.

Methods:

as_sql_sort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L30" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]

Return an expression used to sort flow runs

auto ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

auto() -> str

Exposes enum.auto() to avoid requiring a second import to use AutoEnum

TaskRunSort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L59" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Defines task run sorting options.

Methods:

as_sql_sort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L70" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]

Return an expression used to sort task runs

auto ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

auto() -> str

Exposes enum.auto() to avoid requiring a second import to use AutoEnum

LogSort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L89" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Defines log sorting options.

Methods:

as_sql_sort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L95" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]

Return an expression used to sort task runs

auto ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

auto() -> str

Exposes enum.auto() to avoid requiring a second import to use AutoEnum

FlowSort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L107" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Defines flow sorting options.

Methods:

as_sql_sort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L115" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]

Return an expression used to sort task runs

auto ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

auto() -> str

Exposes enum.auto() to avoid requiring a second import to use AutoEnum

DeploymentSort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L129" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Defines deployment sorting options.

Methods:

as_sql_sort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L137" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]

Return an expression used to sort task runs

auto ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

auto() -> str

Exposes enum.auto() to avoid requiring a second import to use AutoEnum

ArtifactSort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L151" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Defines artifact sorting options.

Methods:

as_sql_sort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L160" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]

Return an expression used to sort task runs

auto ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

auto() -> str

Exposes enum.auto() to avoid requiring a second import to use AutoEnum

ArtifactCollectionSort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L175" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Defines artifact collection sorting options.

Methods:

as_sql_sort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L184" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]

Return an expression used to sort task runs

auto ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

auto() -> str

Exposes enum.auto() to avoid requiring a second import to use AutoEnum

VariableSort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L199" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Defines variables sorting options.

Methods:

as_sql_sort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L207" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]

Return an expression used to sort task runs

auto ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

auto() -> str

Exposes enum.auto() to avoid requiring a second import to use AutoEnum

BlockDocumentSort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L221" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Defines block document sorting options.

Methods:

as_sql_sort ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L228" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]

Return an expression used to sort task runs

auto ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

auto() -> str

Exposes enum.auto() to avoid requiring a second import to use AutoEnum