class CQL::ActiveRecord::Relations::ManyCollection(Target, Through, Pk)

• CQL::ActiveRecord::Relations::ManyCollection(Target, Through, Pk)
• CQL::ActiveRecord::Relations::Collection(Target, Pk)
• Reference
• Object

Overview

Enhanced collection class for many-to-many relationships with improved type safety, error handling, and performance optimizations.

A many-to-many association occurs when multiple records of one model can be associated with multiple records of another model, and vice versa. This requires a join table (or junction table) to store the relationships between the records of the two models.

Example

class Movie
  include CQL::ActiveRecord::Model(Int64)
  db_context AcmeDB, :movies

  property title : String = ""
  many_to_many :actors, Actor, join_through: MoviesActor

  def initialize(@title : String = "")
  end
end

class Actor
  include CQL::ActiveRecord::Model(Int64)
  db_context AcmeDB, :actors

  property name : String = ""

  def initialize(@name : String = "")
  end
end

class MoviesActor
  include CQL::ActiveRecord::Model(Int64)
  db_context AcmeDB, :movies_actors

  property movie_id : Int64?
  property actor_id : Int64?

  def initialize(@movie_id : Int64? = nil, @actor_id : Int64? = nil)
  end
end

movie = Movie.create!(title: "The Matrix")
movie.actors.create(name: "Keanu Reeves")
movie.actors.size # => 1

Defined in:

Constructors

• .new(key : Symbol, id : Pk, target_key : Symbol, cascade : Bool = false, query : CQL::Query | Nil = nil, dependent : Symbol = :nullify, validate : Bool = true, autosave : Bool = false)

  Initialize the many-to-many association collection class - param : key (Symbol) - The key for the parent record - param : id (Pk) - The id value for the parent record - param : target_key (Symbol) - The key for the associated record - param : cascade (Bool) - Delete associated records (deprecated, use dependent) - param : query (CQL::Query) - Query object - param : dependent (Symbol) - Dependency handling strategy - param : validate (Bool) - Whether to validate records - param : autosave (Bool) - Whether to automatically save records - return : ManyCollection

Instance Method Summary

• #<<(record : Target)

  Adds an existing record to the association.

• #build(**attributes) : Target

  Build a new target record but don't save it or create association - param : attributes (Hash | NamedTuple) - return : Target

• #clear

  Clears all associated records from the parent record.

• #clear_join_records

  Clear only the join table records (preserve target records)

• #clear_with_delete

  Clear associations and delete target records (without callbacks)

• #clear_with_destroy

  Clear associations and destroy target records

• #concat(records : Array(Target)) : Array(Target)

  Add multiple records to the association

• #create(record : Target)

  Associates an existing or new target record with the parent record.

• #create(**attributes)

  Create a new target record with given attributes and associate it - param : attributes (Hash | NamedTuple) - return : Target - raise : RelationError on creation failure

• #delete(record : Target) : Target | Nil

  Deletes the association for the given record.

• #delete(id : Pk) : Target | Nil

  Deletes the association for the record with the given ID.

• #delete_all : Int64

  Unlinks every associated record by deleting this parent's join rows.

• #exists?(**attributes) : Bool

  Checks if any records exist with the given attributes - param : attributes (NamedTuple) - return : Bool

• #find(**attributes)

  Override find to properly handle many-to-many relationships via join table - param : attributes (NamedTuple | Hash(Symbol, DB::Any)) - return : Array(Target)

• #find_by(**attributes)

  Override find_by to properly handle many-to-many relationships via join table - param : attributes (NamedTuple | Hash(Symbol, DB::Any)) - return : Target?

• #ids : Array(Pk)

  Get associated record IDs

• #ids=(ids : Array(Pk))

  Set the associated record IDs (replaces current associations)

• #includes?(record : Target) : Bool

  Check if the collection includes a specific record

• #nullify_all : Int64

  The link lives in the join table, so nullifying it deletes the join rows (same as #delete_all).

• #remove(records : Array(Target)) : Array(Target)

  Remove multiple records from the association

Constructor Detail

Instance Method Detail