kdrant-core/dev.kdrant.dsl/ScrollBuilder

ScrollBuilder

class ScrollBuilder

DSL for scroll. The page size is fixed by the scroll(pageSize = ...) argument.

Properties

shardKey

var shardKey: ShardKey?

Scroll only the shards holding this key. null (default) reads every shard.

startAt

var startAt: PointId?

Start the scroll at this point id, inclusive, so a job that was interrupted resumes where it stopped instead of re-reading from the beginning. null (default) starts at the first point.

withPayload

var withPayload: WithPayload?

Which payload to return (defaults to the server's behavior).

withVector

var withVector: Boolean?

Whether to return the stored vectors.

Functions

filter

fun filter(filter: Filter)

Restrict the scroll to points matching an already-built Filter.

fun filter(configure: FilterBuilder.() -> Unit)

Restrict the scroll to points matching this filter.

orderBy

fun orderBy(key: String, direction: Direction? = null, startFrom: Number? = null)

Order the scroll by a numeric payload key instead of by point id, so a job that re-runs reads the points in the same order every time. Qdrant needs a payload index on key.

orderByDatetime

fun orderByDatetime(key: String, direction: Direction? = null, startFrom: String? = null)

As orderBy, for a payload key holding RFC 3339 datetimes.