class PullRequest

• PullRequest
• Reference
• Object

Included Modules

• Clear::Model
• Clear::Model::Relations::BelongsToMacro
• Clear::Model::Relations::HasManyMacro
• Clear::Model::Relations::HasManyThroughMacro
• Clear::Model::Relations::HasOneMacro

Extended Modules

• Clear::Model::HasHooks::ClassMethods

Defined in:

Constant Summary

COLUMNS = {"id" => {type: Int64, primary: true, converter: "Int64", db_column_name: "id", crystal_variable_name: id, presence: true, mass_assign: true}, "data" => {type: JSON::Any, primary: false, converter: "JSON::Any", db_column_name: "data", crystal_variable_name: data, presence: true, mass_assign: true}} of Nil => Nil

POLYMORPHISM_SETTINGS = {} of Nil => Nil

RELATION_FILTERS = {} of String => (Clear::SQL::SelectBuilder ->)

Constructors

• .create(x : Hash) : self
• .create(x : NamedTuple) : self
• .create(**args) : self

  Build and new model and save it.

• .create!(a : Hash) : self
• .create!(x : NamedTuple) : self
• .create!(**args) : self

  Build and new model and save it.

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

Class Method Summary

• .__call_relation_filter__(name : String, query : Clear::SQL::SelectBuilder)
• .__relation_filter_builds__(query)
• .build(**x : **T) forall T

  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(x : Array(NamedTuple)) : Array(self)

  Multi-models creation.

• .create!(x : Array(NamedTuple)) : Array(self)

  Multi-models creation.

• .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 : Clear::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
• .schema : Clear::SQL::Symbolic | Nil

  Define the current schema used in PostgreSQL.

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

  Define the current schema used in PostgreSQL.

• .table : Clear::SQL::Symbolic

  Return the table name setup for this model.

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

  Return the table name setup for this model.

Instance Method Summary

• #_cached_builds : Array(Build) | Nil
• #attributes : Hash(String, Clear::SQL::Any)

  Attributes, used when fetch_columns is true

• #base
• #base_name
• #base_url
• #branch_url
• #builds : Build::Collection

  The method builds is a has_many relation to Build

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

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

• #clear_change_flags

  Reset the #changed? flag on all columns

• #commit_url
• #created_at
• #created_at_relative
• #data : JSON::Any

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

• #data=(x : JSON::Any)

  Setter for #data column.

• #data_column : Clear::Model::Column(JSON::Any, Clear::Model::Converter::JSON::AnyConverter)

  Returns the column object used to manage #data field

• #head
• #head_repo_url
• #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 : Clear::Model::Column(Int64, Clear::Model::Converter::Int64Converter)

  Returns the column object used to manage #id field

• #invalidate_caches

  Invalidate local-to-relation cache and eager-loading cache.

• #job_id
• #number
• #org_avatar
• #org_url
• #parsed

  TODO Optimize this (see https://github.com/anykeyh/clear/issues/95 )!

• #pull_request
• #ref
• #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

• #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

• #sha
• #sha_short
• #simplify

  TODO whittle down the data we actually want to send

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

  Return a hash version of the columns of this model.

• #to_json(emit_nulls : Bool = false)
• #to_json(json, emit_nulls = false)
• #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, Clear::SQL::Any)

  Generate the hash for update request (like during save)

• #url
• #user_login
• #user_url
• #validate_fields_presence

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

Constructor Detail

Class Method Detail

 Clear::SQL.init("postgres://postgres@localhost/database_1", connection_pool_size: 5)
 Clear::SQL.init("secondary", "postgres://postgres@localhost/database_2", connection_pool_size: 5)

class ModelA
  include Clear::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 Clear::Model

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

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

 Clear::SQL.init("postgres://postgres@localhost/database_1", connection_pool_size: 5)
 Clear::SQL.init("secondary", "postgres://postgres@localhost/database_2", connection_pool_size: 5)

class ModelA
  include Clear::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 Clear::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)

  class MyModel
    include Clear::Model

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

  class MyModel
    include Clear::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 Clear::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 Clear::Model

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

Instance Method Detail

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