# InvalidationTracker

Artifact: [androidx.room3:room3-runtime](https://developer.android.com/jetpack/androidx/releases/room3) [View Source](https://cs.android.com/search?q=file:androidx/room3/InvalidationTracker.+class:androidx.room3.InvalidationTracker) Added in [3.0.0](https://developer.android.com/jetpack/androidx/releases/room3#3.0.0)

*** ** * ** ***

Common/AllAndroid/JVMNative/C/iOSJavaScript
- Cmn

  ```
  class InvalidationTracker
  ```

*** ** * ** ***

The invalidation tracker keeps track of tables modified by queries and notifies its created `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html`s about such modifications.

A `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` tracking one or more tables can be created via `https://developer.android.com/reference/kotlin/androidx/room3/InvalidationTracker#createFlow(kotlin.Array,kotlin.Boolean)`. Once the `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` stream starts being collected, if a database operation changes one of the tables that the `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` was created from, then such table is considered 'invalidated' and the `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` will emit a new value.

## Summary

| ### Public functions |
|---|---|---|
| `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html>>` | `https://developer.android.com/reference/kotlin/androidx/room3/InvalidationTracker#createFlow(kotlin.Array,kotlin.Boolean)(vararg tables: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, emitInitialState: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Creates a `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` that tracks modifications in the database and emits sets of the tables that were invalidated. | Cmn android |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/room3/InvalidationTracker#refreshAsync()()` Refresh created `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html`s asynchronously, emitting new values on those whose tables have been invalidated. | Cmn android |

## Public functions

### createFlow

Cmn android

```
fun createFlow(vararg tables: String, emitInitialState: Boolean = true): Flow<Set<String>>
```

Creates a `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` that tracks modifications in the database and emits sets of the tables that were invalidated.

The `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` will emit at least one value, a set of all the tables registered for observation to kick-start the stream unless `https://developer.android.com/reference/kotlin/androidx/room3/InvalidationTracker#createFlow(kotlin.Array,kotlin.Boolean)` is set to `false`.

If one of the tables to observe does not exist in the database, this functions throws an `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html`.

The returned `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html` can be used to create a stream that reacts to changes in the database:

```kotlin
fun getArtistTours(from: Date, to: Date): Flow<Map<Artist, TourState>> {
  return db.invalidationTracker.createFlow("Artist").map { _ ->
    val artists = artistsDao.getAllArtists()
    val tours = tourService.fetchStates(artists.map { it.id })
    associateTours(artists, tours, from, to)
  }
}
```

| Parameters |
|---|---|
| `vararg tables: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | The name of the tables or views to track. |
| `emitInitialState: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | Set to `false` if no initial emission is desired. Default value is `true`. |

### refreshAsync

Cmn android Added in [3.0.0](https://developer.android.com/jetpack/androidx/releases/room3#3.0.0)

```
fun refreshAsync(): Unit
```

Refresh created `https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html`s asynchronously, emitting new values on those whose tables have been invalidated.

This function should be called after any write operation is performed on the database, such that tracked tables and its associated flows are notified if invalidated. In most cases Room will call this function automatically but if a write operation is performed on the database via another connection or through `https://developer.android.com/reference/kotlin/androidx/room3/RoomDatabase#useConnection(kotlin.Boolean,kotlin.coroutines.SuspendFunction1)` you might need to invoke this function manually to trigger invalidation.