androidx-room/se.ansman.dagger.auto.androidx.room/AutoProvideDaos

AutoProvideDaos

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class AutoProvideDaos(val inComponent: KClass<*> = SingletonComponent::class)(source)

A marker for Room Databases that will automatically contribute all DAOs in your database to the dependency graph.

Simply add this annotation to a Database and auto-data will provide all DAOs.

Example:

@AutoProvideDaos
@Database(entities = [User::class], version = 1)
abstract class AppDatabase : RoomDatabase() {
    abstract fun userDao(): UserDao
}

// You'll also need to provide the Database instance to the component you want to inject the service into:
@Module
@InstallIn(SingletonComponent::class)
object DatabaseModule {
  @Provides
  @Singleton
  fun provideDatabase(@ApplicationContext context: Context): AppDatabase =
    Room.databaseBuilder(context, AppDatabase::class.java, "database-name").build()
}

Changing the target component

By default, the DAOs are provided in the SingletonComponent. If you'd like to change this you can do so by specifying the inComponent parameter:

@AutoProvideDaos
@Database(entities = [User::class], version = 1)
abstract class AppDatabase : RoomDatabase() {
  abstract fun userDao(): UserDao
}

Since

1.0.0

Parameters

inComponent

The component to provide the DAOs in. Defaults to SingletonComponent.

Properties

inComponent

val inComponent: KClass<*>