IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Ordering.Companion

public static class Ordering.Companion

Summary

Public methods
`static final @NonNull Ordering`	`ascending(@NonNull Expression expr)` Create an `Ordering` that sorts documents in ascending order based on value of `expr`.
`static final @NonNull Ordering`	`ascending(@NonNull String fieldName)` Creates an `Ordering` that sorts documents in ascending order based on field.
`static final @NonNull Ordering`	`descending(@NonNull Expression expr)` Create an `Ordering` that sorts documents in descending order based on value of `expr`.
`static final @NonNull Ordering`	`descending(@NonNull String fieldName)` Creates an `Ordering` that sorts documents in descending order based on field.

Public methods

ascending

public static final @NonNull Ordering ascending(@NonNull Expression expr)

Create an Ordering that sorts documents in ascending order based on value of expr.

Parameters
`@NonNull Expression expr`	The order is based on the evaluation of the `Expression`.

Returns
`@NonNull Ordering`	A new `Ordering` object with ascending sort by `expr`.

ascending

public static final @NonNull Ordering ascending(@NonNull String fieldName)

Creates an Ordering that sorts documents in ascending order based on field.

Parameters
`@NonNull String fieldName`	The name of field to sort documents.

Returns
`@NonNull Ordering`	A new `Ordering` object with ascending sort by field.

descending

public static final @NonNull Ordering descending(@NonNull Expression expr)

Create an Ordering that sorts documents in descending order based on value of expr.

Parameters
`@NonNull Expression expr`	The order is based on the evaluation of the `Expression`.

Returns
`@NonNull Ordering`	A new `Ordering` object with descending sort by `expr`.

descending

public static final @NonNull Ordering descending(@NonNull String fieldName)

Creates an Ordering that sorts documents in descending order based on field.

Parameters
`@NonNull String fieldName`	The name of field to sort documents.

Returns
`@NonNull Ordering`	A new `Ordering` object with descending sort by field.