> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# sorting

# `prefect.server.schemas.sorting`

Schemas for sorting Prefect REST API objects.

## Classes

### `FlowRunSort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L17](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L17)</sup>

Defines flow run sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L30](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L30)</sup>

```python theme={null}
as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]
```

Return an expression used to sort flow runs

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71)</sup>

```python theme={null}
auto() -> str
```

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

### `TaskRunSort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L59](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L59)</sup>

Defines task run sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L72](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L72)</sup>

```python theme={null}
as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]
```

Return an expression used to sort task runs

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71)</sup>

```python theme={null}
auto() -> str
```

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

### `LogSort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L103](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L103)</sup>

Defines log sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L109](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L109)</sup>

```python theme={null}
as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]
```

Return an expression used to sort task runs

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71)</sup>

```python theme={null}
auto() -> str
```

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

### `FlowSort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L121](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L121)</sup>

Defines flow sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L129](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L129)</sup>

```python theme={null}
as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]
```

Return an expression used to sort task runs

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71)</sup>

```python theme={null}
auto() -> str
```

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

### `DeploymentSort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L143](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L143)</sup>

Defines deployment sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L151](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L151)</sup>

```python theme={null}
as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]
```

Return an expression used to sort task runs

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71)</sup>

```python theme={null}
auto() -> str
```

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

### `ArtifactSort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L165](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L165)</sup>

Defines artifact sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L174](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L174)</sup>

```python theme={null}
as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]
```

Return an expression used to sort task runs

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71)</sup>

```python theme={null}
auto() -> str
```

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

### `ArtifactCollectionSort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L189](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L189)</sup>

Defines artifact collection sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L198](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L198)</sup>

```python theme={null}
as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]
```

Return an expression used to sort task runs

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71)</sup>

```python theme={null}
auto() -> str
```

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

### `VariableSort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L213](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L213)</sup>

Defines variables sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L221](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L221)</sup>

```python theme={null}
as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]
```

Return an expression used to sort task runs

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71)</sup>

```python theme={null}
auto() -> str
```

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

### `BlockDocumentSort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L235](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L235)</sup>

Defines block document sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L242](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L242)</sup>

```python theme={null}
as_sql_sort(self) -> Iterable[sa.ColumnElement[Any]]
```

Return an expression used to sort task runs

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L71)</sup>

```python theme={null}
auto() -> str
```

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