class Allocation

Included Modules

Extended Modules

Defined in:

bitte_ci/model.cr

Constant Summary

COLUMNS = {"id" => {type: UUID, primary: true, converter: "UUID", db_column_name: "id", crystal_variable_name: id, 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}, "updated_at" => {type: Time, primary: false, converter: "Time", db_column_name: "updated_at", crystal_variable_name: updated_at, presence: true, mass_assign: true}, "client_status" => {type: String, primary: false, converter: "String", db_column_name: "client_status", crystal_variable_name: client_status, presence: true, mass_assign: true}, "index" => {type: Int64, primary: false, converter: "Int64", db_column_name: "index", crystal_variable_name: index, presence: true, mass_assign: true}, "eval_id" => {type: UUID, primary: false, converter: "UUID", db_column_name: "eval_id", crystal_variable_name: eval_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}, "pr_id" => {type: Int64, primary: false, converter: "Int64", db_column_name: "pr_id", crystal_variable_name: pr_id, presence: false, mass_assign: true}, "job_id" => {type: UUID, primary: false, converter: "UUID", db_column_name: "job_id", crystal_variable_name: job_id, presence: false, mass_assign: true}} of Nil => Nil
POLYMORPHISM_SETTINGS = {} of Nil => Nil
RELATION_FILTERS = {} of String => (Clear::SQL::SelectBuilder ->)

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.create(x : Hash) : self #

[View source]
def self.create(x : NamedTuple) : self #

[View source]
def self.create(**args) : self #

Build and new model and save it. Returns the model.

The model may not be saved due to validation failure; check the returned model errors? and persisted? flags.


[View source]
def self.create!(a : Hash) : self #

[View source]
def self.create!(x : NamedTuple) : self #

[View source]
def self.create!(**args) : self #

Build and new model and save it. Returns the model.

Returns the newly inserted model Raises an exception if validation failed during the saving process.


[View source]
def self.new(h : Hash(String, _), cache : Clear::Model::QueryCache | Nil = nil, persisted = false, fetch_columns = false) #

[View source]
def self.new(json : JSON::Any, cache : Clear::Model::QueryCache | Nil = nil, persisted = false) #

[View source]
def self.new(t : NamedTuple, persisted = false) #

[View source]
def self.new #

[View source]

Class Method Detail

def self.__call_relation_filter__(name : String, query : Clear::SQL::SelectBuilder) #

[View source]
def self.__relation_filter_outputs__(query) #

def self.build(**x : **T) forall T #

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

Returns the new model


[View source]
def self.columns #

[View source]
def self.connection : String #

Define on which connection the model is living. Useful in case of models living in different databases.

Is set to "default" by default.

See Clear::SQL#init(URI, *opts) for more information about multi-connections.

Example:

 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

def self.connection=(connection : String) #

Define on which connection the model is living. Useful in case of models living in different databases.

Is set to "default" by default.

See Clear::SQL#init(URI, *opts) for more information about multi-connections.

Example:

 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

def self.create(x : Array(NamedTuple)) : Array(self) #

Multi-models creation. See Collection#create(**args)

Returns the list of newly created model.

Each model will call an INSERT query. You may want to use Collection#import to insert multiple model more efficiently in one query.


[View source]
def self.create!(x : Array(NamedTuple)) : Array(self) #

Multi-models creation. See Collection#create!(**args)

Returns the list of newly created model. Raises exception if any of the model has validation error.


[View source]
def self.create_from_json(string_or_io : String | IO, trusted : Bool = false) #

Create a new model from json and save it. Returns the model.

The model may not be saved due to validation failure; check the returned model errors? and persisted? flags. Trusted flag set to true will allow mass assignment without protection, FALSE by default


def self.create_from_json!(string_or_io : String | IO, trusted : Bool = false) #

Create a new model from json and save it. Returns the model.

Returns the newly inserted model Raises an exception if validation failed during the saving process. Trusted flag set to true will allow mass assignment without protection, FALSE by default


def self.find(x) #

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


[View source]
def self.find!(x) #

Returns a model using primary key equality. Raises error if the model is not found.


[View source]
def self.from_json(string_or_io : String | IO, trusted : Bool = false) #

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

Trusted flag set to true will allow mass assignment without protection, FALSE by default


def self.full_table_name #

returns the fully qualified and escaped name for this table. add schema if schema is different from 'public' (default schema)

ex: "schema"."table"


[View source]
def self.import(array : Enumerable(self), on_conflict : Clear::SQL::InsertQuery -> | Nil = nil) #

Import a bulk of models in one SQL insert query. Each model must be non-persisted.

on_conflict callback can be optionnaly turned on to manage constraints of the database.

Note: Old models are not modified. This method return a copy of the models as saved in the database.

Example:


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

[View source]
def self.polymorphic? : Bool #

def self.query #

Return a new empty query SELECT * FROM [my_model_table]. Can be refined after that.


[View source]
def self.read_only=(read_only : Bool) #

def self.read_only? : Bool #

def self.schema : Clear::SQL::Symbolic | Nil #

Define the current schema used in PostgreSQL. The value is nil by default, which lead to non-specified schema during the querying, and usage of "public" by PostgreSQL.

This property can be redefined on initialization. Example:

  class MyModel
    include Clear::Model

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

def self.schema=(schema : Clear::SQL::Symbolic | Nil) #

Define the current schema used in PostgreSQL. The value is nil by default, which lead to non-specified schema during the querying, and usage of "public" by PostgreSQL.

This property can be redefined on initialization. Example:

  class MyModel
    include Clear::Model

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

def self.table : Clear::SQL::Symbolic #

Return the table name setup for this model. By convention, the class name is by default equals to the pluralized underscored string form of the model name. Example:

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

The property can be updated at initialization to a custom table name:

  class MyModel
    include Clear::Model

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

def self.table=(table : Clear::SQL::Symbolic) #

Return the table name setup for this model. By convention, the class name is by default equals to the pluralized underscored string form of the model name. Example:

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

The property can be updated at initialization to a custom table name:

  class MyModel
    include Clear::Model

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

Instance Method Detail

def _cached_job : Job | Nil #

def _cached_outputs : Array(Output) | Nil #

def _cached_pull_request : PullRequest | Nil #

def attributes : Hash(String, Clear::SQL::Any) #

Attributes, used when fetch_columns is true


def cache : Clear::Model::QueryCache | Nil #

def changed? #

Return true if the model is dirty (e.g. one or more fields have been changed.). Return false otherwise.


def clear_change_flags #

Reset the #changed? flag on all columns

The model behave like its not dirty anymore and call to save would apply no changes.

Returns self


def client_status : String #

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


def client_status=(x : String) #

Setter for #client_status column.


def client_status_column : Clear::Model::Column(String, Clear::Model::Converter::StringConverter) #

Returns the column object used to manage #client_status field

See Clear::Model::Column


def created_at : Time #

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


def created_at=(x : Time) #

Setter for #created_at column.


def created_at_column : Clear::Model::Column(Time, Clear::Model::Converter::TimeConverter) #

Returns the column object used to manage #created_at field

See Clear::Model::Column


def data : JSON::Any #

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


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

Setter for #data column.


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

Returns the column object used to manage #data field

See Clear::Model::Column


def eval_id : UUID #

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


def eval_id=(x : UUID) #

Setter for #eval_id column.


def eval_id_column : Clear::Model::Column(UUID, Clear::Model::Converter::UUIDConverter) #

Returns the column object used to manage #eval_id field

See Clear::Model::Column


def id : UUID #

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


def id=(x : UUID) #

Setter for #id column.


def id_column : Clear::Model::Column(UUID, Clear::Model::Converter::UUIDConverter) #

Returns the column object used to manage #id field

See Clear::Model::Column


def index : Int64 #

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


def index=(x : Int64) #

Setter for #index column.


def index_column : Clear::Model::Column(Int64, Clear::Model::Converter::Int64Converter) #

Returns the column object used to manage #index field

See Clear::Model::Column


def invalidate_caches #

Invalidate local-to-relation cache and eager-loading cache. Useful to forcefully query again when calling relation defined method


def job : Job #

The method job is a belongs_to relation to Job


def job=(model : Job) #

def job_id : UUID #

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


def job_id=(x : UUID) #

Setter for #job_id column.


def job_id_column : Clear::Model::Column(UUID, Clear::Model::Converter::UUIDConverter) #

Returns the column object used to manage #job_id field

See Clear::Model::Column


def outputs : Output::Collection #

The method outputs is a has_many relation to Output


def parsed #

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


[View source]
def pr_id : Int64 #

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


def pr_id=(x : Int64) #

Setter for #pr_id column.


def pr_id_column : Clear::Model::Column(Int64, Clear::Model::Converter::Int64Converter) #

Returns the column object used to manage #pr_id field

See Clear::Model::Column


def pull_request : PullRequest #

The method pull_request is a belongs_to relation to PullRequest


def pull_request=(model : PullRequest) #

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

Set the columns from hash


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

Set the model fields from hash


def reset(t : NamedTuple) #

def reset(from_json : JSON::Any) #

def reset(**t : **T) forall T #

reset flavors


def send_github_status(user : String, token : String, target_url : URI) #

TODO only send status if something changed


[View source]
def set(h : Hash(Symbol, _)) #

Set the columns from hash


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

Set the model fields from hash


def set(t : NamedTuple) #

def set(from_json : JSON::Any) #

def set(**t : **T) forall T #
Description copied from module Clear::Model::HasColumns

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

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

def 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


def simplify #

[View source]
def status_to_state : String #

[View source]
def statuses_url #

[View source]
def to_h(full = false) : Hash(String, Clear::SQL::Any) #

Return a hash version of the columns of this model.


def to_json(emit_nulls : Bool = false) #

def to_json(json, emit_nulls = false) #

def 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


def 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


def update_h : Hash(String, Clear::SQL::Any) #

Generate the hash for update request (like during save)


def updated_at : Time #

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


def updated_at=(x : Time) #

Setter for #updated_at column.


def updated_at_column : Clear::Model::Column(Time, Clear::Model::Converter::TimeConverter) #

Returns the column object used to manage #updated_at field

See Clear::Model::Column


def validate_fields_presence #

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

This method is called on validation.