kdrant-core/dev.kdrant.model/OrderBy

OrderBy

@Serializable

data class OrderBy(val key: String, val direction: Direction? = null, val startFrom: JsonPrimitive? = null)

Ordering for a scroll: a payload key, a direction, and the value to resume from.

Qdrant requires a payload index on key — an ordered scroll over an unindexed field is rejected by the server rather than falling back to a scan.

Constructors

OrderBy

constructor(key: String, direction: Direction? = null, startFrom: JsonPrimitive? = null)

Properties

direction

@SerialName(value = "direction")

val direction: Direction?

Ascending when null.

key

@SerialName(value = "key")

val key: String

startFrom

@SerialName(value = "start_from")

val startFrom: JsonPrimitive?

The order value to start from, inclusive: a number, or an RFC 3339 timestamp string. null starts at the lowest value for Direction.ASC and the highest for Direction.DESC.