module

Ktistec::Model

Constants

Log = ::Log.for("database")

logging in this module is related to database query performance.

Constructors

new(properties : Hash(String, Any), *, _strict : Bool = false) forall Any

Initializes a new instance.

Specified properties are assigned via setter methods. If a property lacks a setter the property is read-only and cannot be assigned. Non-nilable properties must be assigned.

To allow initialization of multiple models from a single collection of properties, initialize ignores specified properties that do not exist on the model. Specify _strict: true to change this behavior to raise an error instead.

new(*, _strict : Bool = false, **properties)

Initializes a new instance.

Specified properties are assigned via setter methods. If a property lacks a setter the property is read-only and cannot be assigned. Non-nilable properties must be assigned.

To allow initialization of multiple models from a single collection of properties, initialize ignores specified properties that do not exist on the model. Specify _strict: true to change this behavior to raise an error instead.

Instance methods

==(other : self)

Returns true if all persistent properties are equal.

==(other)

Returns false.

_run_validations

_save_model(skip_validation = false)

_serialize_graph(nodes, seen = Set(UInt64).new, association = nil, index = nil, skip_associated = false)

assign(properties : Hash(String, Any), *, _strict : Bool = false) forall Any

Bulk assigns properties.

Specified properties are assigned via setter methods. If a property lacks a setter the property is read-only and cannot be assigned.

To allow assignment of multiple models from a single collection of properties, assign ignores specified properties that do not exist on the model. Specify _strict: true to change this behavior to raise an error instead.

assign(*, _strict : Bool = false, **properties)

Bulk assigns properties.

Specified properties are assigned via setter methods. If a property lacks a setter the property is read-only and cannot be assigned.

To allow assignment of multiple models from a single collection of properties, assign ignores specified properties that do not exist on the model. Specify _strict: true to change this behavior to raise an error instead.

changed!(*properties : Symbol)

changed?

changed?(*properties : Symbol)

clear_changed!

clear_changed!(*properties : Symbol)

destroy

Destroys the instance.

destroyed?

errors

hash(hasher)

Computes the hash for this instance.

id

id!

id=(id : Int64 | Nil)

inspect(io : IO)

new_record?

reload!

Reloads the properties from the database.

Only reloads the persistent properties. Does not trigger any side effects. Does not ensure that the instance's state is otherwise valid.

save(skip_validation = false, skip_associated = false)

Saves the instance.

serialize_graph(skip_associated = false)

table_name

Returns the table name.

to_h

to_json(json : JSON::Builder)

to_s(io : IO)

update_property(property, value)

Updates and persists property value.

This method is meant for simple state changes -- it does not validate model state or run before and after actions! Prefer assign/save methods.

valid?(skip_associated = false)

Returns true if the instance is valid.

validate(skip_associated = false)

Validates the instance and returns any errors.

Macros

belongs_to(name, primary_key = id, foreign_key = nil, class_name = nil, inverse_of = nil)

Specifies a one-to-one association with another model.

derived(decl, *, aliased_to)

Specifies a property that is derived from another property.

has_many(name, primary_key = id, foreign_key = nil, class_name = nil, inverse_of = nil)

Specifies a one-to-many association with another model.

has_one(name, primary_key = id, foreign_key = nil, class_name = nil, inverse_of = nil)

Specifies a one-to-one association with another model.

validates(property, &block)

Adds a validation to a property on an instance.

validates xyz { "is blank" if xyz.blank? }

Nested types