firebase-firestore/dev.gitlive.firebase.firestore/Query

Query

open class Query(source)

Inheritors

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val Query.android: Query
val Query.android: Query
Link copied to clipboard
val Query.ios: NativeQuery
Link copied to clipboard

Functions

Link copied to clipboard
fun endAt(document: DocumentSnapshot): Query
fun endAt(vararg fieldValues: Any?): Query
fun endAt(vararg fieldValues: Any?, buildSettings: EncodeSettings.Builder.() -> Unit): Query
Link copied to clipboard
fun endAtFieldValues(builder: FieldValuesDSL.() -> Unit): Query

Creates and returns a new Query that ends at the provided fields relative to the order of the query. The field values are configured using a FieldValuesDSL. The order of the field values must match the order of the orderBy clauses of the query

Link copied to clipboard
fun endBefore(document: DocumentSnapshot): Query
fun endBefore(vararg fieldValues: Any?): Query
fun endBefore(vararg fieldValues: Any?, buildSettings: EncodeSettings.Builder.() -> Unit): Query
Link copied to clipboard
fun endBeforeFieldValues(builder: FieldValuesDSL.() -> Unit): Query

Creates and returns a new Query that ends before the provided fields relative to the order of the query. The field values are configured using a FieldValuesDSL. The order of the field values must match the order of the orderBy clauses of the query

Link copied to clipboard
suspend fun get(source: Source = Source.DEFAULT): QuerySnapshot
Link copied to clipboard
fun limit(limit: Number): Query
Link copied to clipboard
fun orderBy(field: FieldPath, direction: Direction = Direction.ASCENDING): Query
fun orderBy(field: String, direction: Direction = Direction.ASCENDING): Query
Link copied to clipboard
fun snapshots(includeMetadataChanges: Boolean = false): Flow<QuerySnapshot>
Link copied to clipboard
fun startAfter(document: DocumentSnapshot): Query
fun startAfter(vararg fieldValues: Any?): Query
fun startAfter(vararg fieldValues: Any?, buildSettings: EncodeSettings.Builder.() -> Unit): Query
Link copied to clipboard
fun startAfterFieldValues(builder: FieldValuesDSL.() -> Unit): Query

Creates and returns a new Query that starts after the provided fields relative to the order of the query. The field values are configured using a FieldValuesDSL. The order of the field values must match the order of the orderBy clauses of the query

Link copied to clipboard
fun startAt(document: DocumentSnapshot): Query
fun startAt(vararg fieldValues: Any?): Query
fun startAt(vararg fieldValues: Any?, buildSettings: EncodeSettings.Builder.() -> Unit): Query
Link copied to clipboard
fun startAtFieldValues(builder: FieldValuesDSL.() -> Unit): Query

Creates and returns a new Query that starts at the provided fields relative to the order of the query. The field values are configured using a FieldValuesDSL. The order of the field values must match the order of the orderBy clauses of the query

Link copied to clipboard
fun where(builder: FilterBuilder.() -> Filter?): Query
Link copied to clipboard
fun Query.where(path: FieldPath, equalTo: Any?): Query
fun Query.where(field: String, equalTo: Any?): Query
fun Query.where(path: FieldPath, inArray: List<Any>? = null, arrayContainsAny: List<Any>? = null): Query
fun Query.where(field: String, inArray: List<Any>? = null, arrayContainsAny: List<Any>? = null): Query
fun Query.where(path: FieldPath, lessThan: Any? = null, greaterThan: Any? = null, arrayContains: Any? = null): Query
fun Query.where(field: String, lessThan: Any? = null, greaterThan: Any? = null, arrayContains: Any? = null): Query