RenameColumn

Artifact: androidx.room:room-common

View Source

Added in 2.4.0

---

Kotlin |Java

Common/AllAndroid/JVMNative/C/iOS

• Cmn

  @Repeatable
  @Target(allowedTargets = [AnnotationTarget.CLASS])
  @Retention(value = AnnotationRetention.BINARY)
  @OptionalExpectation
  annotation RenameColumn

• android

  @Repeatable(value = RenameColumn.Entries)
  @Target(allowedTargets = [AnnotationTarget.CLASS])
  @Retention(value = AnnotationRetention.BINARY)
  annotation RenameColumn

---

Repeatable annotation declaring the renamed columns in the AutoMigration.to version of an auto migration.

See also
AutoMigration

Summary

Nested types
@Target(allowedTargets = [AnnotationTarget.CLASS]) @Retention(value = AnnotationRetention.BINARY) annotation RenameColumn.Entries Container annotation for the repeatable annotation RenameColumn.

Public constructors
RenameColumn(     tableName: String,     fromColumnName: String,     toColumnName: String )	Cmn android

Public properties
String	fromColumnName Name of the column in the AutoMigration.from version of the database.	Cmn android
String	tableName Name of the table in the AutoMigration.from version of the database the renamed column is found in.	Cmn android
String	toColumnName Name of the column in the AutoMigration.to version of the database.	Cmn android

Public constructors

RenameColumn

Cmn android

RenameColumn(
    tableName: String,
    fromColumnName: String,
    toColumnName: String
)

Public properties

fromColumnName

Cmn android

val fromColumnName: String

Name of the column in the AutoMigration.from version of the database.

Returns
String	Name of the column.

tableName

Cmn android

val tableName: String

Name of the table in the AutoMigration.from version of the database the renamed column is found in. The name in AutoMigration.from version is used in case the table was renamed in the AutoMigration.to version.

Returns
String	Name of the table

toColumnName

Cmn android

val toColumnName: String

Name of the column in the AutoMigration.to version of the database.

Returns
String	Name of the column.