ColumnInfo

const val BINARY = 2: Int

Collation sequence for case-sensitive match.

const val BLOB = 5: Int

Column affinity constant for binary data.

const val INHERIT_FIELD_NAME: String

Constant to let Room inherit the property name as the column name. If used, Room will use the property name as the column name.

const val INTEGER = 3: Int

Column affinity constant for integers or booleans.

const val LOCALIZED = 5: Int

Collation sequence that uses system's current locale.

const val NOCASE = 3: Int

Collation sequence for case-insensitive match.

const val REAL = 4: Int

Column affinity constant for floats or doubles.

const val RTRIM = 4: Int

Collation sequence for case-sensitive match except that trailing space characters are ignored.

const val TEXT = 2: Int

Column affinity constant for strings.

const val UNDEFINED = 1: Int

Undefined type affinity. Will be resolved based on the type.

const val UNICODE = 6: Int

Collation sequence that uses Unicode Collation Algorithm.

const val UNSPECIFIED = 1: Int

Collation sequence is not specified. The match will behave like BINARY.

const val VALUE_UNSPECIFIED: String

A constant for defaultValue() that makes the column to have no default value.

val collate: Int

The collation sequence for the column, which will be used when constructing the database.

The default value is UNSPECIFIED. In that case, Room does not add any collation sequence to the column, and SQLite treats it like BINARY.

val defaultValue: String

The default value for this column.

@ColumnInfo(defaultValue = "No name")
public name: String

@ColumnInfo(defaultValue = "0")
public flag: Int

Note that the default value you specify here will NOT be used if you simply insert the Entity with Insert. In that case, any value assigned in Java/Kotlin will be used. Use Query with an INSERT statement and skip this column there in order to use this default value.

NULL, CURRENT_TIMESTAMP and other SQLite constant values are interpreted as such. If you want to use them as strings for some reason, surround them with single-quotes.

@ColumnInfo(defaultValue = "NULL")
public description: String?

@ColumnInfo(defaultValue = "'NULL'")
public name: String

You can also use constant expressions by surrounding them with parentheses.

@ColumnInfo(defaultValue = "('Created at' || CURRENT_TIMESTAMP)")
public notice: String

val index: Boolean

Convenience method to index the property.

If you would like to create a composite index instead, see: Index.

val name: String

Name of the column in the database. Defaults to the property name if not set.

val typeAffinity: Int

The type affinity for the column, which will be used when constructing the database.

If it is not specified, the value defaults to UNDEFINED and Room resolves it based on the property's type and available TypeConverters.

See SQLite types documentation for details.