com.google.firebase.firestore.ktx

firestoreSettings

fun firestoreSettings(init: FirebaseFirestoreSettings.Builder.() -> Unit): FirebaseFirestoreSettings

Returns a FirebaseFirestoreSettings instance initialized using the init function.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

memoryCacheSettings

fun memoryCacheSettings(init: MemoryCacheSettings.Builder.() -> Unit): MemoryCacheSettings

memoryEagerGcSettings

fun memoryEagerGcSettings(init: MemoryEagerGcSettings.Builder.() -> Unit): MemoryEagerGcSettings

memoryLruGcSettings

fun memoryLruGcSettings(init: MemoryLruGcSettings.Builder.() -> Unit): MemoryLruGcSettings

persistentCacheSettings

fun persistentCacheSettings(init: PersistentCacheSettings.Builder.() -> Unit): PersistentCacheSettings

dataObjects

inline fun <T : Any> DocumentReference.dataObjects(
    metadataChanges: MetadataChanges = MetadataChanges.EXCLUDE
): Flow<T?>

Starts listening to the document referenced by this DocumentReference with the given options and emits its values converted to a POJO via a Flow.

When the returned flow starts being collected, an EventListener will be attached.
When the flow completes, the listener will be removed.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Parameters
`<T : Any>`	The type of the object to convert to.
`metadataChanges: MetadataChanges = MetadataChanges.EXCLUDE`	controls metadata-only changes. Default: `MetadataChanges.EXCLUDE`

dataObjects

inline fun <T : Any> Query.dataObjects(
    metadataChanges: MetadataChanges = MetadataChanges.EXCLUDE
): Flow<List<T>>

Starts listening to this query with the given options and emits its values converted to a POJO via a Flow.

When the returned flow starts being collected, an EventListener will be attached.
When the flow completes, the listener will be removed.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Parameters
`<T : Any>`	The type of the object to convert to.
`metadataChanges: MetadataChanges = MetadataChanges.EXCLUDE`	controls metadata-only changes. Default: `MetadataChanges.EXCLUDE`

firestore

fun Firebase.firestore(app: FirebaseApp, database: String): FirebaseFirestore

Accessing this object for Kotlin apps has changed; see the migration guide.

Returns the FirebaseFirestore instance of a given FirebaseApp and database name.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

firestore

fun Firebase.firestore(app: FirebaseApp): FirebaseFirestore

Accessing this object for Kotlin apps has changed; see the migration guide.

Returns the FirebaseFirestore instance of a given FirebaseApp.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

firestore

fun Firebase.firestore(database: String): FirebaseFirestore

Accessing this object for Kotlin apps has changed; see the migration guide.

Returns the FirebaseFirestore instance of the default FirebaseApp, given the database name.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

getField

inline fun <T : Any?> DocumentSnapshot.getField(
    fieldPath: FieldPath,
    serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior
): T?

Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Parameters

<T : Any?>

The type to convert the field value to.

fieldPath: FieldPath

The path to the field.

serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior

Configures the behavior for server timestamps that have not yet

        been set to their final value.
    @return

The value at the given field or null.

getField

inline fun <T : Any?> DocumentSnapshot.getField(fieldPath: FieldPath): T?

Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Parameters
`<T : Any?>`	The type to convert the field value to.
`fieldPath: FieldPath`	The path to the field.

Returns
`T?`	The value at the given field or null.

getField

inline fun <T : Any?> DocumentSnapshot.getField(
    field: String,
    serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior
): T?

Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Parameters

<T : Any?>

The type to convert the field value to.

field: String

The path to the field.

serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior

Configures the behavior for server timestamps that have not yet

        been set to their final value.
    @return

The value at the given field or null.

getField

inline fun <T : Any?> DocumentSnapshot.getField(field: String): T?

Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Parameters
`<T : Any?>`	The type to convert the field value to.
`field: String`	The path to the field.

Returns
`T?`	The value at the given field or null.

snapshots

fun DocumentReference.snapshots(
    metadataChanges: MetadataChanges = MetadataChanges.EXCLUDE
): Flow<DocumentSnapshot>

Starts listening to the document referenced by this DocumentReference with the given options and emits its values via a Flow.

When the returned flow starts being collected, an EventListener will be attached.
When the flow completes, the listener will be removed.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Parameters
`metadataChanges: MetadataChanges = MetadataChanges.EXCLUDE`	controls metadata-only changes. Default: `MetadataChanges.EXCLUDE`

snapshots

fun Query.snapshots(
    metadataChanges: MetadataChanges = MetadataChanges.EXCLUDE
): Flow<QuerySnapshot>

Starts listening to this query with the given options and emits its values via a Flow.

When the returned flow starts being collected, an EventListener will be attached.
When the flow completes, the listener will be removed.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Parameters
`metadataChanges: MetadataChanges = MetadataChanges.EXCLUDE`	controls metadata-only changes. Default: `MetadataChanges.EXCLUDE`

toObject

inline fun <T : Any?> DocumentSnapshot.toObject(): T?

Returns the contents of the document converted to a POJO or null if the document doesn't exist.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Parameters
`<T : Any?>`	The type of the object to create.

Returns
`T?`	The contents of the document in an object of type T or null if the document doesn't exist.

toObject

inline fun <T : Any?> DocumentSnapshot.toObject(
    serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior
): T?

Returns the contents of the document converted to a POJO or null if the document doesn't exist.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Parameters

<T : Any?>

The type of the object to create.

serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior

Configures the behavior for server timestamps that have not yet

        been set to their final value.
    @return

The contents of the document in an object of type T or null if the document doesn't

    exist.

toObject

inline fun <T : Any> QueryDocumentSnapshot.toObject(): T

Returns the contents of the document converted to a POJO.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Parameters
`<T : Any>`	The type of the object to create.

Returns
`T`	The contents of the document in an object of type T.

toObject

inline fun <T : Any> QueryDocumentSnapshot.toObject(
    serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior
): T

Returns the contents of the document converted to a POJO.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Parameters

<T : Any>

The type of the object to create.

serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior

Configures the behavior for server timestamps that have not yet

        been set to their final value.
    @return

The contents of the document in an object of type T.

toObjects

inline fun <T : Any> QuerySnapshot.toObjects(): List<T>

Returns the contents of the documents in the QuerySnapshot, converted to the provided class, as a list.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Parameters
`<T : Any>`	The POJO type used to convert the documents in the list.

toObjects

inline fun <T : Any> QuerySnapshot.toObjects(
    serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior
): List<T>

Returns the contents of the documents in the QuerySnapshot, converted to the provided class, as a list.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Parameters
`<T : Any>`	The POJO type used to convert the documents in the list.
`serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior`	Configures the behavior for server timestamps that have not yet been set to their final value.

firestore

val Firebase.firestore: FirebaseFirestore

Accessing this object for Kotlin apps has changed; see the migration guide.

Returns the FirebaseFirestore instance of the default FirebaseApp.

Important In July 2025, we stopped releasing KTX modules and removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

`FirebaseFirestoreSettings`	`firestoreSettings(init: FirebaseFirestoreSettings.Builder.() -> Unit)` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`MemoryCacheSettings`	`memoryCacheSettings(init: MemoryCacheSettings.Builder.() -> Unit)`
`MemoryEagerGcSettings`	`memoryEagerGcSettings(init: MemoryEagerGcSettings.Builder.() -> Unit)`
`MemoryLruGcSettings`	`memoryLruGcSettings(init: MemoryLruGcSettings.Builder.() -> Unit)`
`PersistentCacheSettings`	`persistentCacheSettings(init: PersistentCacheSettings.Builder.() -> Unit)`

`inline Flow<T?>`	`<T : Any> DocumentReference.dataObjects(metadataChanges: MetadataChanges)` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`inline Flow<List<T>>`	`<T : Any> Query.dataObjects(metadataChanges: MetadataChanges)` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`FirebaseFirestore`	`Firebase.firestore(app: FirebaseApp, database: String)` Accessing this object for Kotlin apps has changed; see the migration guide.
`FirebaseFirestore`	`Firebase.firestore(app: FirebaseApp)` Accessing this object for Kotlin apps has changed; see the migration guide.
`FirebaseFirestore`	`Firebase.firestore(database: String)` Accessing this object for Kotlin apps has changed; see the migration guide.
`inline T?`	`<T : Any?> DocumentSnapshot.getField( fieldPath: FieldPath, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior )` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`inline T?`	`<T : Any?> DocumentSnapshot.getField(fieldPath: FieldPath)` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`inline T?`	`<T : Any?> DocumentSnapshot.getField( field: String, serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior )` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`inline T?`	`<T : Any?> DocumentSnapshot.getField(field: String)` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`Flow<DocumentSnapshot>`	`DocumentReference.snapshots(metadataChanges: MetadataChanges)` This function is deprecated. com.google.firebase.fires
`Flow<QuerySnapshot>`	`Query.snapshots(metadataChanges: MetadataChanges)` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`inline T?`	`<T : Any?> DocumentSnapshot.toObject()` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`inline T?`	`<T : Any?> DocumentSnapshot.toObject( serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior )` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`inline T`	`<T : Any> QueryDocumentSnapshot.toObject()` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`inline T`	`<T : Any> QueryDocumentSnapshot.toObject( serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior )` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`inline List<T>`	`<T : Any> QuerySnapshot.toObjects()` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.
`inline List<T>`	`<T : Any> QuerySnapshot.toObjects( serverTimestampBehavior: DocumentSnapshot.ServerTimestampBehavior )` This function is deprecated. Migrate to use the KTX API from the main module: https://firebase.google.com/docs/android/kotlin-migration.

Top-level functions summary

Extension functions summary

Extension properties summary

Top-level functions

firestoreSettings

memoryCacheSettings

memoryEagerGcSettings

memoryLruGcSettings

persistentCacheSettings

Extension functions

dataObjects

dataObjects

firestore

firestore

firestore

getField

getField

getField

getField

snapshots

snapshots

toObject

toObject

toObject

toObject

toObjects

toObjects

Extension properties

firestore