1. install

apply plugin: 'kotlin-kapt'

dependencies {
  def room_version = "2.2.3"

	implementation "androidx.room:room-runtime:$room_version"
	kapt "androidx.room:room-compiler:$room_version" // kotlin 기반 앱일 경우 kapt로 디펜던시 추가
	implementation "androidx.room:room-ktx:$room_version" // Kotlin Extensions and Coroutines support
}

2. document

Save data in a local database using Room | Android Developers

3. tutorial

테이블 정의

@Entity(
    tableName = "memo"
)
data class Memo(
    @PrimaryKey(autoGenerate = true) val id: Int,
    val title: String,
    @ColumnInfo(name="contents") val contents: String
)

----

@Entity(
    tableName = "image",
    foreignKeys = [ForeignKey(
        entity = Memo::class,
        parentColumns = arrayOf("id"),
        childColumns = arrayOf("memoId")
    )]
)
data class Image(
    @PrimaryKey(autoGenerate = true) val id: Int,
    val memoId: Int,
    val imageType: ImageType,
    val image: String
)

• 기본적으로 class name을 테이블 이름으로 가진다.
• 별도의 테이블 이름을 정하고 싶으면, @Entity 속성에 tableName을 정해준다.
• 최소 1개의 PrimaryKey가 있어야 한다. (칼럼이 하나여도 있어야 함)
• PrimaryKey의 값을 자동증가 시키고 싶으면, @PrimaryKey 속성의 autoGenerate를 사용한다.
• 칼럼의 이름은 기본적으로 변수명과 동일하다.
• 칼럼의 이름을 변수명과 다르게 가져가고 싶으면, @ColumnInfo 속성에 name을 추가한다.
• 외래키 관계를 지정하고 싶다면, @Entity 속성에 foreignKeys을 추가하여 관계를 지정해 준다.

쿼리 사용

@Dao
interface MemoDao {

    @Query("SELECT * FROM memo INNER JOIN image ON memo.id = image.memoId")
    fun getAll(): List<Memo>

    @Query("SELECT * FROM memo INNER JOIN image ON memo.id = image.memoId WHERE id = :id")
    fun getOneMemo(id: Int): Memo

}

----

@Dao
interface MyDao {
	@Query("SELECT * FROM user WHERE age BETWEEN :minAge AND :maxAge")
  fun loadAllUsersBetweenAges(minAge: Int, maxAge: Int): Array<User>

  @Query("SELECT * FROM user WHERE first_name LIKE :search " +
               "OR last_name LIKE :search")
  fun findUserWithName(search: String): List<User>
}

• 쿼리는 Dao로 interface를 만들어 사용