firebase-database/com.google.firebase.database/Query

Query

actual open class Query(source)

A read of a location with ordering and filtering, as the Android SDK's Query. Listeners are called on the thread the platform SDK delivers events on. keepSynced is in nonJsMain (the JS SDK has no equivalent).

Inheritors

DatabaseReference

actual open class Query(source)

Inheritors

DatabaseReference

expect open class Query(source)

Inheritors

DatabaseReference

actual open class Query(source)

Inheritors

DatabaseReference

actual open class Query(source)

Inheritors

DatabaseReference

Properties

childEvents

val Query.childEvents: Flow<ChildEvent>

The changes to the children of this location as a Flow, which fails if the listener is cancelled.

ios

open val ios: FIRDatabaseQuery

The underlying Firebase iOS SDK object.

open val js: Query

The underlying Firebase JS SDK object.

open val js: Query

The underlying Firebase JS SDK object.

jsDatabase

val jsDatabase: Database

The JS SDK database the query belongs to (the JS SDK does not expose it on the query).

val jsDatabase: Database

The JS SDK database the query belongs to (the JS SDK does not expose it on the query).

ref

actual val ref: DatabaseReference

The reference to the location of this query.

actual val ref: DatabaseReference

The reference to the location of this query.

expect val ref: DatabaseReference

The reference to the location of this query.

actual val ref: DatabaseReference

The reference to the location of this query.

actual val ref: DatabaseReference

The reference to the location of this query.

snapshots

val Query.snapshots: Flow<DataSnapshot>

The data at this location and every change to it as a Flow, which fails if the listener is cancelled.

Functions

addChildEventListener

actual fun addChildEventListener(listener: ChildEventListener): ChildEventListener

Adds listener for the changes to the children of this location; returns it for removeEventListener.

actual fun addChildEventListener(listener: ChildEventListener): ChildEventListener

Adds listener for the changes to the children of this location; returns it for removeEventListener.

expect fun addChildEventListener(listener: ChildEventListener): ChildEventListener

Adds listener for the changes to the children of this location; returns it for removeEventListener.

actual fun addChildEventListener(listener: ChildEventListener): ChildEventListener

Adds listener for the changes to the children of this location; returns it for removeEventListener.

actual fun addChildEventListener(listener: ChildEventListener): ChildEventListener

Adds listener for the changes to the children of this location; returns it for removeEventListener.

addListenerForSingleValueEvent

actual fun addListenerForSingleValueEvent(listener: ValueEventListener)

Calls listener once with the data at this location.

actual fun addListenerForSingleValueEvent(listener: ValueEventListener)

Calls listener once with the data at this location.

expect fun addListenerForSingleValueEvent(listener: ValueEventListener)

Calls listener once with the data at this location.

actual fun addListenerForSingleValueEvent(listener: ValueEventListener)

Calls listener once with the data at this location.

actual fun addListenerForSingleValueEvent(listener: ValueEventListener)

Calls listener once with the data at this location.

addValueEventListener

actual fun addValueEventListener(listener: ValueEventListener): ValueEventListener

Adds listener for the data at this location and its changes; returns it for removeEventListener.

actual fun addValueEventListener(listener: ValueEventListener): ValueEventListener

Adds listener for the data at this location and its changes; returns it for removeEventListener.

expect fun addValueEventListener(listener: ValueEventListener): ValueEventListener

Adds listener for the data at this location and its changes; returns it for removeEventListener.

actual fun addValueEventListener(listener: ValueEventListener): ValueEventListener

Adds listener for the data at this location and its changes; returns it for removeEventListener.

actual fun addValueEventListener(listener: ValueEventListener): ValueEventListener

Adds listener for the data at this location and its changes; returns it for removeEventListener.

endAt

actual fun endAt(value: Boolean): Query

actual fun endAt(value: Double): Query

actual fun endAt(value: Boolean, key: String?): Query

actual fun endAt(value: Double, key: String?): Query

actual fun endAt(value: String?): Query

Limits the results to the children whose ordered value is at most value.

actual fun endAt(value: String?, key: String?): Query

Limits the results to the children whose ordered value is at most value, breaking ties by key.

actual fun endAt(value: Boolean): Query

actual fun endAt(value: Double): Query

actual fun endAt(value: Boolean, key: String?): Query

actual fun endAt(value: Double, key: String?): Query

actual fun endAt(value: String?): Query

Limits the results to the children whose ordered value is at most value.

actual fun endAt(value: String?, key: String?): Query

Limits the results to the children whose ordered value is at most value, breaking ties by key.

expect fun endAt(value: Boolean): Query

expect fun endAt(value: Double): Query

expect fun endAt(value: Boolean, key: String?): Query

expect fun endAt(value: Double, key: String?): Query

expect fun endAt(value: String?): Query

Limits the results to the children whose ordered value is at most value.

expect fun endAt(value: String?, key: String?): Query

Limits the results to the children whose ordered value is at most value, breaking ties by key.

actual fun endAt(value: Boolean): Query

actual fun endAt(value: Double): Query

actual fun endAt(value: Boolean, key: String?): Query

actual fun endAt(value: Double, key: String?): Query

actual fun endAt(value: String?): Query

Limits the results to the children whose ordered value is at most value.

actual fun endAt(value: String?, key: String?): Query

Limits the results to the children whose ordered value is at most value, breaking ties by key.

actual fun endAt(value: Boolean): Query

actual fun endAt(value: Double): Query

actual fun endAt(value: Boolean, key: String?): Query

actual fun endAt(value: Double, key: String?): Query

actual fun endAt(value: String?): Query

Limits the results to the children whose ordered value is at most value.

actual fun endAt(value: String?, key: String?): Query

Limits the results to the children whose ordered value is at most value, breaking ties by key.

endBefore

actual fun endBefore(value: Boolean): Query

actual fun endBefore(value: Double): Query

actual fun endBefore(value: Boolean, key: String?): Query

actual fun endBefore(value: Double, key: String?): Query

actual fun endBefore(value: String?): Query

Limits the results to the children whose ordered value is less than value.

actual fun endBefore(value: String?, key: String?): Query

Limits the results to the children whose ordered value is less than value, breaking ties by key.

actual fun endBefore(value: Boolean): Query

actual fun endBefore(value: Double): Query

actual fun endBefore(value: Boolean, key: String?): Query

actual fun endBefore(value: Double, key: String?): Query

actual fun endBefore(value: String?): Query

Limits the results to the children whose ordered value is less than value.

actual fun endBefore(value: String?, key: String?): Query

Limits the results to the children whose ordered value is less than value, breaking ties by key.

expect fun endBefore(value: Boolean): Query

expect fun endBefore(value: Double): Query

expect fun endBefore(value: Boolean, key: String?): Query

expect fun endBefore(value: Double, key: String?): Query

expect fun endBefore(value: String?): Query

Limits the results to the children whose ordered value is less than value.

expect fun endBefore(value: String?, key: String?): Query

Limits the results to the children whose ordered value is less than value, breaking ties by key.

actual fun endBefore(value: Boolean): Query

actual fun endBefore(value: Double): Query

actual fun endBefore(value: Boolean, key: String?): Query

actual fun endBefore(value: Double, key: String?): Query

actual fun endBefore(value: String?): Query

Limits the results to the children whose ordered value is less than value.

actual fun endBefore(value: String?, key: String?): Query

Limits the results to the children whose ordered value is less than value, breaking ties by key.

actual fun endBefore(value: Boolean): Query

actual fun endBefore(value: Double): Query

actual fun endBefore(value: Boolean, key: String?): Query

actual fun endBefore(value: Double, key: String?): Query

actual fun endBefore(value: String?): Query

Limits the results to the children whose ordered value is less than value.

actual fun endBefore(value: String?, key: String?): Query

Limits the results to the children whose ordered value is less than value, breaking ties by key.

equals

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

The iOS SDK creates a new object per call, so queries are equal when they describe the same location and constraints.

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

The JS SDK creates a new object per call, so queries are equal when they are of the same location and constraints.

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

The JS SDK creates a new object per call, so queries are equal when they are of the same location and constraints.

equalTo

actual fun equalTo(value: Boolean): Query

actual fun equalTo(value: Double): Query

actual fun equalTo(value: Boolean, key: String?): Query

actual fun equalTo(value: Double, key: String?): Query

actual fun equalTo(value: String?): Query

Limits the results to the children whose ordered value equals value.

actual fun equalTo(value: String?, key: String?): Query

Limits the results to the child whose ordered value equals value and whose key is key.

actual fun equalTo(value: Boolean): Query

actual fun equalTo(value: Double): Query

actual fun equalTo(value: Boolean, key: String?): Query

actual fun equalTo(value: Double, key: String?): Query

actual fun equalTo(value: String?): Query

Limits the results to the children whose ordered value equals value.

actual fun equalTo(value: String?, key: String?): Query

Limits the results to the child whose ordered value equals value and whose key is key.

expect fun equalTo(value: Boolean): Query

expect fun equalTo(value: Double): Query

expect fun equalTo(value: Boolean, key: String?): Query

expect fun equalTo(value: Double, key: String?): Query

expect fun equalTo(value: String?): Query

Limits the results to the children whose ordered value equals value.

expect fun equalTo(value: String?, key: String?): Query

Limits the results to the child whose ordered value equals value and whose key is key.

actual fun equalTo(value: Boolean): Query

actual fun equalTo(value: Double): Query

actual fun equalTo(value: Boolean, key: String?): Query

actual fun equalTo(value: Double, key: String?): Query

actual fun equalTo(value: String?): Query

Limits the results to the children whose ordered value equals value.

actual fun equalTo(value: String?, key: String?): Query

Limits the results to the child whose ordered value equals value and whose key is key.

actual fun equalTo(value: Boolean): Query

actual fun equalTo(value: Double): Query

actual fun equalTo(value: Boolean, key: String?): Query

actual fun equalTo(value: Double, key: String?): Query

actual fun equalTo(value: String?): Query

Limits the results to the children whose ordered value equals value.

actual fun equalTo(value: String?, key: String?): Query

Limits the results to the child whose ordered value equals value and whose key is key.

get

actual fun get(): Task<DataSnapshot>

Reads the data at this location from the server, falling back to the cache when offline.

actual fun get(): Task<DataSnapshot>

Reads the data at this location from the server, falling back to the cache when offline.

expect fun get(): Task<DataSnapshot>

Reads the data at this location from the server, falling back to the cache when offline.

actual fun get(): Task<DataSnapshot>

Reads the data at this location from the server, falling back to the cache when offline.

actual fun get(): Task<DataSnapshot>

Reads the data at this location from the server, falling back to the cache when offline.

hashCode

open override fun hashCode(): Int

keepSynced

actual fun keepSynced(keepSynced: Boolean)

Keeps the data of this query synchronized in the persistent cache, even while it has no listener. A no-op on JS, whose SDK has no persistent cache.

actual fun keepSynced(keepSynced: Boolean)

Keeps the data of this query synchronized in the persistent cache, even while it has no listener. A no-op on JS, whose SDK has no persistent cache.

expect fun keepSynced(keepSynced: Boolean)

Keeps the data of this query synchronized in the persistent cache, even while it has no listener. A no-op on JS, whose SDK has no persistent cache.

actual fun keepSynced(keepSynced: Boolean)

A no-op: the JS SDK has no persistent cache to keep a query synchronized in.

actual fun keepSynced(keepSynced: Boolean)

A no-op: the JS SDK has no persistent cache to keep a query synchronized in.

limitToFirst

actual fun limitToFirst(limit: Int): Query

Limits the results to the first limit children.

actual fun limitToFirst(limit: Int): Query

Limits the results to the first limit children.

expect fun limitToFirst(limit: Int): Query

Limits the results to the first limit children.

actual fun limitToFirst(limit: Int): Query

Limits the results to the first limit children.

actual fun limitToFirst(limit: Int): Query

Limits the results to the first limit children.

limitToLast

actual fun limitToLast(limit: Int): Query

Limits the results to the last limit children.

actual fun limitToLast(limit: Int): Query

Limits the results to the last limit children.

expect fun limitToLast(limit: Int): Query

Limits the results to the last limit children.

actual fun limitToLast(limit: Int): Query

Limits the results to the last limit children.

actual fun limitToLast(limit: Int): Query

Limits the results to the last limit children.

orderByChild

actual fun orderByChild(path: String): Query

Orders the children by the value at path within each of them.

actual fun orderByChild(path: String): Query

Orders the children by the value at path within each of them.

expect fun orderByChild(path: String): Query

Orders the children by the value at path within each of them.

actual fun orderByChild(path: String): Query

Orders the children by the value at path within each of them.

actual fun orderByChild(path: String): Query

Orders the children by the value at path within each of them.

orderByKey

actual fun orderByKey(): Query

Orders the children by their keys.

actual fun orderByKey(): Query

Orders the children by their keys.

expect fun orderByKey(): Query

Orders the children by their keys.

actual fun orderByKey(): Query

Orders the children by their keys.

actual fun orderByKey(): Query

Orders the children by their keys.

orderByPriority

actual fun orderByPriority(): Query

Orders the children by their priorities.

actual fun orderByPriority(): Query

Orders the children by their priorities.

expect fun orderByPriority(): Query

Orders the children by their priorities.

actual fun orderByPriority(): Query

Orders the children by their priorities.

actual fun orderByPriority(): Query

Orders the children by their priorities.

orderByValue

actual fun orderByValue(): Query

Orders the children by their values.

actual fun orderByValue(): Query

Orders the children by their values.

expect fun orderByValue(): Query

Orders the children by their values.

actual fun orderByValue(): Query

Orders the children by their values.

actual fun orderByValue(): Query

Orders the children by their values.

removeEventListener

actual fun removeEventListener(listener: ChildEventListener)

Removes a listener added with addChildEventListener.

actual fun removeEventListener(listener: ValueEventListener)

Removes a listener added with addValueEventListener.

actual fun removeEventListener(listener: ChildEventListener)

Removes a listener added with addChildEventListener.

actual fun removeEventListener(listener: ValueEventListener)

Removes a listener added with addValueEventListener.

expect fun removeEventListener(listener: ChildEventListener)

Removes a listener added with addChildEventListener.

expect fun removeEventListener(listener: ValueEventListener)

Removes a listener added with addValueEventListener.

actual fun removeEventListener(listener: ChildEventListener)

Removes a listener added with addChildEventListener.

actual fun removeEventListener(listener: ValueEventListener)

Removes a listener added with addValueEventListener.

actual fun removeEventListener(listener: ChildEventListener)

Removes a listener added with addChildEventListener.

actual fun removeEventListener(listener: ValueEventListener)

Removes a listener added with addValueEventListener.

startAfter

actual fun startAfter(value: Boolean): Query

actual fun startAfter(value: Double): Query

actual fun startAfter(value: Boolean, key: String?): Query

actual fun startAfter(value: Double, key: String?): Query

actual fun startAfter(value: String?): Query

Limits the results to the children whose ordered value is greater than value.

actual fun startAfter(value: String?, key: String?): Query

Limits the results to the children whose ordered value is greater than value, breaking ties by key.

actual fun startAfter(value: Boolean): Query

actual fun startAfter(value: Double): Query

actual fun startAfter(value: Boolean, key: String?): Query

actual fun startAfter(value: Double, key: String?): Query

actual fun startAfter(value: String?): Query

Limits the results to the children whose ordered value is greater than value.

actual fun startAfter(value: String?, key: String?): Query

Limits the results to the children whose ordered value is greater than value, breaking ties by key.

expect fun startAfter(value: Boolean): Query

expect fun startAfter(value: Double): Query

expect fun startAfter(value: Boolean, key: String?): Query

expect fun startAfter(value: Double, key: String?): Query

expect fun startAfter(value: String?): Query

Limits the results to the children whose ordered value is greater than value.

expect fun startAfter(value: String?, key: String?): Query

Limits the results to the children whose ordered value is greater than value, breaking ties by key.

actual fun startAfter(value: Boolean): Query

actual fun startAfter(value: Double): Query

actual fun startAfter(value: Boolean, key: String?): Query

actual fun startAfter(value: Double, key: String?): Query

actual fun startAfter(value: String?): Query

Limits the results to the children whose ordered value is greater than value.

actual fun startAfter(value: String?, key: String?): Query

Limits the results to the children whose ordered value is greater than value, breaking ties by key.

actual fun startAfter(value: Boolean): Query

actual fun startAfter(value: Double): Query

actual fun startAfter(value: Boolean, key: String?): Query

actual fun startAfter(value: Double, key: String?): Query

actual fun startAfter(value: String?): Query

Limits the results to the children whose ordered value is greater than value.

actual fun startAfter(value: String?, key: String?): Query

Limits the results to the children whose ordered value is greater than value, breaking ties by key.

startAt

actual fun startAt(value: Boolean): Query

actual fun startAt(value: Double): Query

actual fun startAt(value: Boolean, key: String?): Query

actual fun startAt(value: Double, key: String?): Query

actual fun startAt(value: String?): Query

Limits the results to the children whose ordered value is at least value.

actual fun startAt(value: String?, key: String?): Query

Limits the results to the children whose ordered value is at least value, breaking ties by key.

actual fun startAt(value: Boolean): Query

actual fun startAt(value: Double): Query

actual fun startAt(value: Boolean, key: String?): Query

actual fun startAt(value: Double, key: String?): Query

actual fun startAt(value: String?): Query

Limits the results to the children whose ordered value is at least value.

actual fun startAt(value: String?, key: String?): Query

Limits the results to the children whose ordered value is at least value, breaking ties by key.

expect fun startAt(value: Boolean): Query

expect fun startAt(value: Double): Query

expect fun startAt(value: Boolean, key: String?): Query

expect fun startAt(value: Double, key: String?): Query

expect fun startAt(value: String?): Query

Limits the results to the children whose ordered value is at least value.

expect fun startAt(value: String?, key: String?): Query

Limits the results to the children whose ordered value is at least value, breaking ties by key.

actual fun startAt(value: Boolean): Query

actual fun startAt(value: Double): Query

actual fun startAt(value: Boolean, key: String?): Query

actual fun startAt(value: Double, key: String?): Query

actual fun startAt(value: String?): Query

Limits the results to the children whose ordered value is at least value.

actual fun startAt(value: String?, key: String?): Query

Limits the results to the children whose ordered value is at least value, breaking ties by key.

actual fun startAt(value: Boolean): Query

actual fun startAt(value: Double): Query

actual fun startAt(value: Boolean, key: String?): Query

actual fun startAt(value: Double, key: String?): Query

actual fun startAt(value: String?): Query

Limits the results to the children whose ordered value is at least value.

actual fun startAt(value: String?, key: String?): Query

Limits the results to the children whose ordered value is at least value, breaking ties by key.

toString

open override fun toString(): String

values

inline fun <T> Query.values(): Flow<T?>

The data at this location and every change to it as T (see getValue).