> ## 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#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</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#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L70)</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#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</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#L89](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L89)</sup>

Defines log sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L95](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L95)</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#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</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#L107](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L107)</sup>

Defines flow sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L115](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L115)</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#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</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#L129](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L129)</sup>

Defines deployment sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L137](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L137)</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#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</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#L151](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L151)</sup>

Defines artifact sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L160](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L160)</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#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</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#L175](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L175)</sup>

Defines artifact collection sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L184](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L184)</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#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</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#L199](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L199)</sup>

Defines variables sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L207](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L207)</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#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</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#L221](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L221)</sup>

Defines block document sorting options.

**Methods:**

#### `as_sql_sort` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L228](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/schemas/sorting.py#L228)</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#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</sup>

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

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