class Post

• Post
• Reference
• Object

Included Modules

• Lustra::Model

Extended Modules

• Lustra::Model::HasHooks::ClassMethods

Defined in:

Constant Summary

COLUMNS = {"id" => {type: Int64, primary: true, converter: "Int64", db_column_name: "id", crystal_variable_name: id, presence: false, mass_assign: true}, "title" => {type: String, primary: false, converter: "String", db_column_name: "title", crystal_variable_name: title, presence: true, mass_assign: true}, "content" => {type: String, primary: false, converter: "String", db_column_name: "content", crystal_variable_name: content, presence: true, mass_assign: true}, "kind" => {type: String, primary: false, converter: "String", db_column_name: "kind", crystal_variable_name: kind, presence: true, mass_assign: true}, "updated_at" => {type: Time, primary: false, converter: "Time", db_column_name: "updated_at", crystal_variable_name: updated_at, presence: true, mass_assign: true}, "created_at" => {type: Time, primary: false, converter: "Time", db_column_name: "created_at", crystal_variable_name: created_at, presence: true, mass_assign: true}, "tsv" => {type: Lustra::TSVector, primary: false, converter: "Lustra::TSVector", db_column_name: "tsv", crystal_variable_name: tsv, presence: false, mass_assign: true}, "author_id" => {type: Int64, primary: false, converter: "Int64", db_column_name: "author_id", crystal_variable_name: author_id, presence: false, mass_assign: true}} of Nil => Nil

POLYMORPHISM_SETTINGS = {} of Nil => Nil

Constructors

• .build(x : NamedTuple) : self

  Build a new empty model and fill the columns using the NamedTuple in argument.

• .build(x : NamedTuple, &block : self -> Nil) : self

  Build a new empty model and fill the columns using the NamedTuple in argument.

• .create(x : NamedTuple, &block : self -> Nil) : self

  Build and new model and save it.

• .create(**tuple, &block : self -> Nil) : self

  Build and new model and save it.

• .create(x : NamedTuple) : self

  Build and new model and save it.

• .create(**tuple) : self

  Build and new model and save it.

• .create!(x : NamedTuple, &block : self -> Nil) : self

  Build and new model and save it.

• .create!(**tuple, &block : self -> Nil) : self

  Build and new model and save it.

• .create!(x : NamedTuple) : self

  Build and new model and save it.

• .create!(**tuple) : self

  Build and new model and save it.

• .new(h : Hash(String, _), cache : Lustra::Model::QueryCache | Nil = nil, persisted = false, fetch_columns = false)
• .new(json : JSON::Any, cache : Lustra::Model::QueryCache | Nil = nil, persisted = false)
• .new(t : NamedTuple, persisted = false)
• .new

Class Method Summary

• .build(**tuple : **T) forall T

  Build a new empty model and fill the columns using the NamedTuple in argument.

• .build(**tuple)

  Build a new empty model and fill the columns using the NamedTuple in argument.

• .build(**tuple, &)

  Build a new empty model and fill the columns using the NamedTuple in argument.

• .columns
• .connection : String

  Define on which connection the model is living.

• .connection=(connection : String)

  Define on which connection the model is living.

• .create_from_json(string_or_io : String | IO, trusted : Bool = false)

  Create a new model from json and save it.

• .create_from_json!(string_or_io : String | IO, trusted : Bool = false)

  Create a new model from json and save it.

• .find(x)

  Returns a model using primary key equality Returns nil if not found.

• .find!(x)

  Returns a model using primary key equality.

• .from_json(string_or_io : String | IO, trusted : Bool = false)

  Create a new empty model and fill the columns from json.

• .full_table_name

  returns the fully qualified and escaped name for this table.

• .import(array : Enumerable(self), on_conflict : Lustra::SQL::InsertQuery -> | Nil = nil)

  Import a bulk of models in one SQL insert query.

• .polymorphic? : Bool
• .query

  Return a new empty query SELECT * FROM [my_model_table].

• .read_only=(read_only : Bool)
• .read_only? : Bool
• .register_counter_cache(association_model : Class, counter_column : String, foreign_key : String)

  Register a counter cache for this model using model class

• .reset_counters(id, *counter_models)

  Reset counter cache columns to their correct values.

• .schema : Lustra::SQL::Symbolic | Nil

  Define the current schema used in PostgreSQL.

• .schema=(schema : Lustra::SQL::Symbolic | Nil)

  Define the current schema used in PostgreSQL.

• .search(str)
• .table : Lustra::SQL::Symbolic

  Return the table name setup for this model.

• .table=(table : Lustra::SQL::Symbolic)

  Return the table name setup for this model.

Instance Method Summary

• #__trigger_append_operation_for_association__(association_name : String, models : Array(Lustra::Model))

  Handle append operation for through associations (called by autosave system)

• #_cached_author : Author | Nil
• #add_built_association(association_name : String, model : Lustra::Model)

  Add a built association to track for autosave

• #attributes : Hash(String, Lustra::SQL::Any)

  Attributes, used when fetch_columns is true

• #author : Author

  The method author is a belongs_to relation to Author

• #author=(model : Author)
• #author_id : Int64

  Returns the value of #author_id column or throw an exception if the column is not defined.

• #author_id=(x : Int64)

  Setter for #author_id column.

• #author_id_column : Lustra::Model::Column(Int64, Lustra::Model::Converter::Int64Converter)

  Returns the column object used to manage #author_id field

• #built_associations : Hash(String, Array(Lustra::Model))

  Track built associations for autosave functionality

• #built_associations=(built_associations : Hash(String, Array(Lustra::Model)))

  Track built associations for autosave functionality

• #cache : Lustra::Model::QueryCache | Nil
• #changed?

  Return true if the model is dirty (e.g.

• #clear_built_associations

  Clear all built associations (called after successful save)

• #clear_change_flags

  Reset the #changed? flag on all columns

• #content : String

  Returns the value of #content column or throw an exception if the column is not defined.

• #content=(x : String)

  Setter for #content column.

• #content_column : Lustra::Model::Column(String, Lustra::Model::Converter::StringConverter)

  Returns the column object used to manage #content field

• #created_at : Time

  Returns the value of #created_at column or throw an exception if the column is not defined.

• #created_at=(x : Time)

  Setter for #created_at column.

• #created_at_column : Lustra::Model::Column(Time, Lustra::Model::Converter::TimeConverter)

  Returns the column object used to manage #created_at field

• #dependencies : Post::Collection
• #dependents : Post::Collection
• #has_built_associations? : Bool

  Check if there are any pending built associations

• #id : Int64

  Returns the value of #id column or throw an exception if the column is not defined.

• #id=(x : Int64)

  Setter for #id column.

• #id_column : Lustra::Model::Column(Int64, Lustra::Model::Converter::Int64Converter)

  Returns the column object used to manage #id field

• #kind : String

  Returns the value of #kind column or throw an exception if the column is not defined.

• #kind=(x : String)

  Setter for #kind column.

• #kind_column : Lustra::Model::Column(String, Lustra::Model::Converter::StringConverter)

  Returns the column object used to manage #kind field

• #reset(h : Hash(Symbol, _))

  Set the columns from hash

• #reset(h : Hash(String, _))

  Set the model fields from hash

• #reset(t : NamedTuple)
• #reset(from_json : JSON::Any)
• #reset(**t : **T) forall T

  reset flavors

• #reset_counters(*counter_models)

  Reset counter cache columns

• #set(h : Hash(Symbol, _))

  Set the columns from hash

• #set(h : Hash(String, _))

  Set the model fields from hash

• #set(t : NamedTuple)
• #set(from_json : JSON::Any)
• #set(**t : **T) forall T

  Set one or multiple columns to a specific value This two are equivalents:

• #set_from_json(string_or_io : String | IO, trusted : Bool = false)

  Set the fields from json passed as argument Trusted flag set to true will allow mass assignment without protection, FALSE by default

• #tag_names
• #tags : Tag::Collection
• #tags=(names : Array(String))
• #title : String

  Returns the value of #title column or throw an exception if the column is not defined.

• #title=(x : String)

  Setter for #title column.

• #title_column : Lustra::Model::Column(String, Lustra::Model::Converter::StringConverter)

  Returns the column object used to manage #title field

• #to_h(full = false) : Hash(String, Lustra::SQL::Any)

  Return a hash version of the columns of this model.

• #to_json(emit_nulls : Bool = false)
• #to_json(json, emit_nulls = false)
• #touch(now = Time.local) : Lustra::Model

  Saves the record with the updated_at set to the current time.

• #tsv : Lustra::TSVector

  Returns the value of #tsv column or throw an exception if the column is not defined.

• #tsv=(x : Lustra::TSVector)

  Setter for #tsv column.

• #tsv_column : Lustra::Model::Column(Lustra::TSVector, Lustra::TSVector::Converter)

  Returns the column object used to manage #tsv field

• #update_from_json(string_or_io : String | IO, trusted : Bool = false)

  Set the fields from json passed as argument and call save on the object Trusted flag set to true will allow mass assignment without protection, FALSE by default

• #update_from_json!(string_or_io : String | IO, trusted : Bool = false)

  Set the fields from json passed as argument and call save! on the object Trusted flag set to true will allow mass assignment without protection, FALSE by default

• #update_h : Hash(String, Lustra::SQL::Any)

  Generate the hash for update request (like during save)

• #updated_at : Time

  Returns the value of #updated_at column or throw an exception if the column is not defined.

• #updated_at=(x : Time)

  Setter for #updated_at column.

• #updated_at_column : Lustra::Model::Column(Time, Lustra::Model::Converter::TimeConverter)

  Returns the column object used to manage #updated_at field

• #validate_fields_presence

  For each column, ensure than when needed the column has present information into it.

Constructor Detail

Class Method Detail

Lustra::SQL.init("postgres://postgres@localhost/database_1")
Lustra::SQL.init("secondary", "postgres://postgres@localhost/database_2")

class ModelA
  include Lustra::Model

  # Performs all the queries on `database_1`
  # self.connection = "default"
  column id : Int32, primary: true, presence: false
  column title : String
end

class ModelB
  include Lustra::Model

  # Performs all the queries on `database_2`
  self.connection = "secondary"

  column id : Int32, primary: true, presence: false
end

Lustra::SQL.init("postgres://postgres@localhost/database_1")
Lustra::SQL.init("secondary", "postgres://postgres@localhost/database_2")

class ModelA
  include Lustra::Model

  # Performs all the queries on `database_1`
  # self.connection = "default"
  column id : Int32, primary: true, presence: false
  column title : String
end

class ModelB
  include Lustra::Model

  # Performs all the queries on `database_2`
  self.connection = "secondary"

  column id : Int32, primary: true, presence: false
end

users = [User.new(id: 1), User.new(id: 2), User.new(id: 3)]
users = User.import(users)

User.reset_counters(user.id, Post)
User.reset_counters(user.id, Post, Comment)

class MyModel
  include Lustra::Model

  self.schema = "my_schema"
end
MyModel.query.to_sql # SELECT * FROM "my_schema"."my_models"

class MyModel
  include Lustra::Model

  self.schema = "my_schema"
end
MyModel.query.to_sql # SELECT * FROM "my_schema"."my_models"

MyModel => "my_models"
Person => "people"
Project::Info => "project_infos"

class MyModel
  include Lustra::Model

  self.table = "another_table_name"
end
MyModel.query.to_sql # SELECT * FROM "another_table_name"

MyModel => "my_models"
Person => "people"
Project::Info => "project_infos"

class MyModel
  include Lustra::Model

  self.table = "another_table_name"
end
MyModel.query.to_sql # SELECT * FROM "another_table_name"

Instance Method Detail

user = User.find(1)
user.reset_counters(Post)
user.reset_counters(Post, Comment)

model.set(a: 1)
model.a = 1