struct Athena::ORM::Types::String
inherits Athena::ORM::Types::Type
#
Holds String values, stored in a VARCHAR column.
String properties are mapped to this type by default.
It's also registered as text.
Methods#
#sql_declaration(column : Schema::Column, platform : AORM::Platforms::Platform) : ::String#
Returns the SQL used to declare column as this type on platform, e.g. VARCHAR(255).
Built-in types delegate to the matching declaration method of AORM::Platforms::Platform, which custom types can reuse.
Todo
Nothing in the ORM generates schema yet, so this isn't called by the ORM itself.
#to_crystal_value(value : DB::ResultSet, platform : Platforms::Platform) : ::String | Nil#
Reads the next column from value and converts it into the Crystal value this type represents.
Returns nil for a NULL value.
Used while hydrating entities. Advances the cursor by exactly one column.
#to_crystal_value(value : _, platform : Platforms::Platform) : ::String | Nil#
Converts value, as read from the database, into the Crystal value this type represents.
Returns nil for a NULL value, and raises if value can't be converted.
Used for values that have already been read, such as a database-generated identifier.
Each type defines this once, as the place for its translation logic (parsing, narrowing, decoding, etc.).
It accepts any input, since drivers disagree on the Crystal type of some columns, and validates it inside the body, e.g. with case value.