firebase-firestore/com.google.firebase.firestore.pipeline/CollectionHints

CollectionHints

class CollectionHints : AbstractOptions<CollectionHints> (source)

Index hints of a collection or collection group source; on Apple platforms only withForceIndex is supported.

Constructors

CollectionHints

constructor()

No hints.

Functions

with

fun with(key: String, value: Field): CollectionHints

A copy with the option key set to a reference to the field value. The JS SDK sends a field reference only as a nearest-neighbour search's distance field or an unnest's index field; on JS and wasmJs any other fails the execution.

fun with(key: String, value: RawOptions): CollectionHints

A copy with the option key set to the options value.

fun with(key: String, value: Boolean): CollectionHints

fun with(key: String, value: Double): CollectionHints

fun with(key: String, value: Long): CollectionHints

fun with(key: String, value: String): CollectionHints

A copy with the option key set to value.

withForceIndex

fun withForceIndex(value: String): CollectionHints

A copy that makes the backend use the index value.

withIgnoreIndexFields

fun withIgnoreIndexFields(vararg values: String): CollectionHints

A copy that makes the backend ignore the index fields values.