← Back to Stormify Documentation

stormify/onl.ycode.stormify/FieldInfo

FieldInfo

data class FieldInfo(val name: String, val dbName: String, val type: KClass<*>, val isPrimaryKey: Boolean, val isReference: Boolean, val isEnum: Boolean, val enumAsString: Boolean, val sequence: String?, val isAutoIncrement: Boolean, val isInsertable: Boolean, val isUpdatable: Boolean)

Describes a single mapped field (property) of an entity, including its database column name, type, and role in CRUD operations.

Constructors

constructor(name: String, dbName: String, type: KClass<*>, isPrimaryKey: Boolean, isReference: Boolean, isEnum: Boolean, enumAsString: Boolean, sequence: String?, isAutoIncrement: Boolean, isInsertable: Boolean, isUpdatable: Boolean)

Properties

val dbName: String

the corresponding database column name (after NamingPolicy conversion)

val enumAsString: Boolean

whether enum values are stored as their string name (true) or ordinal/custom integer (false)

isAutoIncrement

val isAutoIncrement: Boolean

whether the database auto-generates values for this field (e.g. IDENTITY columns)

val isEnum: Boolean

whether the property type is a Kotlin/Java enum

val isInsertable: Boolean

whether this field is included in INSERT statements

val isPrimaryKey: Boolean

whether this field is part of the entity's primary key

val isReference: Boolean

whether this field is a foreign key reference to another entity

val isUpdatable: Boolean

whether this field is included in UPDATE statements

val name: String

the Kotlin property name

val sequence: String?

the database sequence name used to generate values, or null if not sequence-backed

val type: KClass<*>

the Kotlin type of the property