RenameColumn

@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
)

Public properties

String

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

String

Name of the table in the AutoMigration.from version of the database the renamed column is found in.

String

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

Public constructors

RenameColumn

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

Public properties

fromColumnName

val fromColumnNameString

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

Returns
String

Name of the column.

tableName

val tableNameString

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

val toColumnNameString

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

Returns
String

Name of the column.