Delva/app.oreshkov.delva/DocumentKeyQuery

DocumentKeyQuery

class DocumentKeyQuery(val prefix: String = "", val limit: Int = 100, val maxBytes: Long = Long.MAX_VALUE, val after: Cursor? = null, val order: SearchOrder = SearchOrder.ASCENDING)(source)

A search of documents in key order (SPEC.md §3.3), in a store with a CreationOptions.documentKey: every visible document whose key starts with prefix ("" for all), once, with its root as the hit and SearchHit.documentKey set. Keys compare by code points, which is the order of their UTF-8 bytes; with Normalization.NFC the prefix is normalized as keys are.

limit, maxBytes: as for KeyValueQuery.
after: resume strictly past this cursor's key in order; only the cursor of a DocumentKeyQuery of the same order is taken, anything else throws InvalidCursorException.
order: SearchOrder.ASCENDING from the smallest key, SearchOrder.DESCENDING from the largest.

A store without document keys refuses the query with IllegalStateException. Queries are values: two instances with the same settings are equal, and copy derives a variant.

Constructors

DocumentKeyQuery

constructor(prefix: String = "", limit: Int = 100, maxBytes: Long = Long.MAX_VALUE, after: Cursor? = null, order: SearchOrder = SearchOrder.ASCENDING)

Properties

val after: Cursor?

val limit: Int

val maxBytes: Long

val order: SearchOrder

prefix

val prefix: String

Functions

copy

fun copy(prefix: String = this.prefix, limit: Int = this.limit, maxBytes: Long = this.maxBytes, after: Cursor? = this.after, order: SearchOrder = this.order): DocumentKeyQuery

This query with the given settings changed; the result is validated like a new instance.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String