class Marten::DB::Field::String

Direct Known Subclasses

Defined in:

marten/db/field.cr
marten/db/field/string.cr

Constructors

Instance Method Summary

Instance methods inherited from class Marten::DB::Field::Base

blank? : Bool blank?, db_column db_column, db_column! : ::String db_column!, db_column? db_column?, default default, empty_value?(value) : ::Bool empty_value?, from_db(value) from_db, from_db_result_set(result_set : ::DB::ResultSet) from_db_result_set, getter_value?(value) : ::Bool getter_value?, id : String id, index? : Bool index?, null? : Bool null?, prepare_save(record, new_record = false) prepare_save, primary_key? : Bool primary_key?, related_model related_model, relation? relation?, relation_name relation_name, to_column : Management::Column::Base | Nil to_column, to_db(value) : ::DB::Any to_db, truthy_value?(value) truthy_value?, unique? : Bool unique?, validate(record, value) validate

Constructor methods inherited from class Marten::DB::Field::Base

new(id : ::String, primary_key : ::Bool = false, blank : ::Bool = false, null : ::Bool = false, unique : ::Bool = false, index : ::Bool = false, db_column : ::String | Symbol | Nil = nil) new

Constructor Detail

def self.new(id : ::String, max_size : Int32, min_size : Int32 | Nil = nil, primary_key = false, default : ::String | Nil = nil, blank = false, null = false, unique = false, index = false, db_column = nil) #

[View source]

Instance Method Detail

def default : String? #
Description copied from class Marten::DB::Field::Base

Returns the default value of the field if any.


[View source]
def empty_value?(value) : ::Bool #
Description copied from class Marten::DB::Field::Base

Returns true if the value is considered empty by the field.


[View source]
def from_db(value) : ::String | Nil #
Description copied from class Marten::DB::Field::Base

Converts the raw DB value to the corresponding field value.


[View source]
def from_db_result_set(result_set : ::DB::ResultSet) : ::String | Nil #
Description copied from class Marten::DB::Field::Base

Extracts the field value from a DB result set and returns the right object corresponding to this value.


[View source]
def max_size : Int32 #

Returns the maximum string size allowed.


[View source]
def min_size : Int32? #

Returns the minimum string size allowed.


[View source]
def to_column : Management::Column::Base | Nil #
Description copied from class Marten::DB::Field::Base

Returns a migration column object corresponding to the field at hand.


[View source]
def to_db(value) : ::DB::Any #
Description copied from class Marten::DB::Field::Base

Converts the field value to the corresponding DB value.


[View source]
def validate(record, value) #
Description copied from class Marten::DB::Field::Base

Runs custom validation logic for a specific model field and model object.

This method should be overriden for each field implementation that requires custom validation logic.


[View source]