Insert  |  API reference  |  Android Developers (original) (raw)

@Target(allowedTargets = [AnnotationTarget.FUNCTION])
@Retention(value = AnnotationRetention.BINARY)
public annotation Insert

Marks a method in a [Dao](/reference/androidx/room/Dao) annotated class as an insert method.

The implementation of the method will insert its parameters into the database.

All of the parameters of the Insert method must either be classes annotated with [Entity](/reference/androidx/room/Entity) or collections/array of it.

Example:

@Dao
interface MusicDao {
@Insert(onConflict = OnConflictStrategy.REPLACE)
fun insertSongs(varargs songs: Song)

@Insert
fun insertBoth(song1: Song, song2: Song)

@Insert
fun insertAlbumWithSongs(album: Album, songs: List)
}

If the target entity is specified via [entity](/reference/androidx/room/Insert#%28kotlin.reflect.KClass,kotlin.Int%29) then the parameters can be of arbitrary POJO types that will be interpreted as partial entities. For example:

@Entity
data class Playlist (
@PrimaryKey(autoGenerate = true)
val playlistId: Long,
val name: String,
val description: String?,

@ColumnInfo(defaultValue = "normal")
val category: String,

@ColumnInfo(defaultValue = "CURRENT_TIMESTAMP")
val createdTime: String,

@ColumnInfo(defaultValue = "CURRENT_TIMESTAMP")
val lastModifiedTime: String
)

data class NameAndDescription (
val name: String,
val description: String
)

@Dao
interface PlaylistDao {
@Insert(entity = Playlist::class)
fun insertNewPlaylist(nameDescription: NameAndDescription)
}

Summary

Public constructors

Public methods

getEntity

public final @NonNull KClass<@NonNull ?> getEntity()

The target entity of the insert method.

When this is declared, the insert method parameters are interpreted as partial entities when the type of the parameter differs from the target. The POJO class that represents the entity must contain all of the non-null fields without default values of the target entity.

If the target entity contains a [PrimaryKey](/reference/androidx/room/PrimaryKey) that is auto generated, then the POJO class doesn't need an equal primary key field, otherwise primary keys must also be present in the POJO.

By default the target entity is interpreted by the method parameters.