Class: Sequel::Model::Associations::ManyToManyAssociationReflection

Inherits:
AssociationReflection show all
Defined in:
lib/sequel/model/associations.rb

Direct Known Subclasses

OneThroughOneAssociationReflection, Plugins::ManyThroughMany::ManyThroughManyAssociationReflection

Constant Summary

Constant Summary

Constants included from Inflections

Inflections::CAMELIZE_CONVERT_REGEXP, Inflections::CAMELIZE_MODULE_REGEXP, Inflections::DASH, Inflections::DEMODULIZE_CONVERT_REGEXP, Inflections::EMPTY_STRING, Inflections::SLASH, Inflections::UNDERSCORE, Inflections::UNDERSCORE_CONVERT_REGEXP1, Inflections::UNDERSCORE_CONVERT_REGEXP2, Inflections::UNDERSCORE_CONVERT_REPLACE, Inflections::UNDERSCORE_MODULE_REGEXP, Inflections::VALID_CONSTANT_NAME_REGEXP

Instance Method Summary (collapse)

Methods inherited from AssociationReflection

#_add_method, #_remove_all_method, #_remove_method, #_setter_method, #add_method, #apply_dataset_changes, #apply_distinct_on_eager_limit_strategy, #apply_eager_graph_limit_strategy, #apply_eager_limit_strategy, #apply_ruby_eager_limit_strategy, #apply_window_function_eager_limit_strategy, #assign_singular?, #associated_class, #associated_dataset, #association_method, #dataset_method, #dataset_need_primary_key?, #delete_row_number_column, #eager_graph_lazy_dataset?, #eager_graph_limit_strategy, #eager_limit_strategy, #eager_loader_key, #eager_loading_predicate_key, #filter_by_associations_add_conditions?, #filter_by_associations_conditions_expression, #handle_silent_modification_failure?, #initialize_association_cache, #limit_and_offset, #predicate_keys, #qualify, #qualify_assoc, #qualify_cur, #reciprocal, #reciprocal_array?, #remove_all_method, #remove_before_destroy?, #remove_method, #remove_should_check_existing?, #returns_array?, #set_reciprocal_to_self?, #setter_method, #slice_range

Methods included from Inflections

clear, irregular, plural, singular, uncountable

Methods inherited from Hash

#&, #case, #hstore, #pg_json, #sql_expr, #sql_negate, #sql_or, #|, #~

Instance Method Details

- (Object) associated_key_alias

The alias to use for the associated key when eagerly loading



799
800
801
# File 'lib/sequel/model/associations.rb', line 799

def associated_key_alias
  self[:left_key_alias]
end

- (Object) associated_key_array

Array of associated keys used when eagerly loading.



804
805
806
807
808
809
810
811
812
# File 'lib/sequel/model/associations.rb', line 804

def associated_key_array
  cached_fetch(:associated_key_array) do
    if self[:uses_left_composite_keys]
      associated_key_alias.zip(predicate_keys).map{|a, k| SQL::AliasedExpression.new(k, a)}
    else
      [SQL::AliasedExpression.new(predicate_key, associated_key_alias)]
    end
  end
end

- (Object) associated_key_column

The column to use for the associated key when eagerly loading



815
816
817
# File 'lib/sequel/model/associations.rb', line 815

def associated_key_column
  self[:left_key]
end

- (Object) associated_object_keys

Alias of right_primary_keys



820
821
822
# File 'lib/sequel/model/associations.rb', line 820

def associated_object_keys
  right_primary_keys
end

- (Boolean) can_have_associated_objects?(obj)

many_to_many associations can only have associated objects if none of the :left_primary_keys options have a nil value.



826
827
828
# File 'lib/sequel/model/associations.rb', line 826

def can_have_associated_objects?(obj)
  !self[:left_primary_keys].any?{|k| obj.send(k).nil?}
end

- (Boolean) cloneable?(ref)

one_through_one and many_to_many associations can be clones



831
832
833
# File 'lib/sequel/model/associations.rb', line 831

def cloneable?(ref)
  ref[:type] == :many_to_many || ref[:type] == :one_through_one
end

- (Object) default_associated_key_alias

The default associated key alias(es) to use when eager loading associations via eager.



837
838
839
# File 'lib/sequel/model/associations.rb', line 837

def default_associated_key_alias
  self[:uses_left_composite_keys] ? (0...self[:left_keys].length).map{|i| :x_foreign_key_#{i}_x"} : :x_foreign_key_x
end

- (Object) default_join_table

Default name symbol for the join table.



842
843
844
# File 'lib/sequel/model/associations.rb', line 842

def default_join_table
  [self[:class_name], self[:model].name].map{|i| underscore(pluralize(demodulize(i)))}.sort.join('_').to_sym
end

- (Object) default_left_key

Default foreign key name symbol for key in join table that points to current table's primary key (or :left_primary_key column).



848
849
850
# File 'lib/sequel/model/associations.rb', line 848

def default_left_key
  :#{underscore(demodulize(self[:model].name))}_id"
end

- (Object) default_right_key

Default foreign key name symbol for foreign key in join table that points to the association's table's primary key (or :right_primary_key column).



854
855
856
# File 'lib/sequel/model/associations.rb', line 854

def default_right_key
  :#{singularize(self[:name])}_id"
end

- (Boolean) eager_loading_use_associated_key?

many_to_many associations need to select a key in an associated table to eagerly load



871
872
873
# File 'lib/sequel/model/associations.rb', line 871

def eager_loading_use_associated_key?
  true
end

- (Object) join_table_alias Also known as: associated_key_table

The join table itself, unless it is aliased, in which case this is the alias.



883
884
885
886
887
888
# File 'lib/sequel/model/associations.rb', line 883

def join_table_alias
  cached_fetch(:join_table_alias) do
    s, a = split_join_table_alias
    a || s
  end
end

- (Object) join_table_source

The source of the join table. This is the join table itself, unless it is aliased, in which case it is the unaliased part.



877
878
879
# File 'lib/sequel/model/associations.rb', line 877

def join_table_source
  cached_fetch(:join_table_source){split_join_table_alias[0]}
end

- (Boolean) need_associated_primary_key?

Whether the associated object needs a primary key to be added/removed, true for many_to_many associations.



893
894
895
# File 'lib/sequel/model/associations.rb', line 893

def need_associated_primary_key?
  true
end

- (Object) predicate_key Also known as: qualified_left_key

The hash key to use for the eager loading predicate (left side of IN (1, 2, 3)). The left key qualified by the join table.



860
861
862
# File 'lib/sequel/model/associations.rb', line 860

def predicate_key
  cached_fetch(:predicate_key){qualify(join_table_alias, self[:left_key])}
end

- (Object) qualified_right_key

The right key qualified by the join table.



866
867
868
# File 'lib/sequel/model/associations.rb', line 866

def qualified_right_key
  cached_fetch(:qualified_right_key){qualify(join_table_alias, self[:right_key])}
end

- (Object) qualified_right_primary_key

#right_primary_key qualified by the associated table



898
899
900
# File 'lib/sequel/model/associations.rb', line 898

def qualified_right_primary_key
  cached_fetch(:qualified_right_primary_key){qualify_assoc(right_primary_key)}
end

- (Object) right_primary_key

The primary key column(s) to use in the associated table (can be symbol or array).



903
904
905
# File 'lib/sequel/model/associations.rb', line 903

def right_primary_key
  cached_fetch(:right_primary_key){associated_class.primary_key}
end

- (Object) right_primary_key_method

The method symbol or array of method symbols to call on the associated objects to get the foreign key values for the join table.



914
915
916
# File 'lib/sequel/model/associations.rb', line 914

def right_primary_key_method
  cached_fetch(:right_primary_key_method){right_primary_key}
end

- (Object) right_primary_key_methods

The array of method symbols to call on the associated objects to get the foreign key values for the join table.



920
921
922
# File 'lib/sequel/model/associations.rb', line 920

def right_primary_key_methods
  cached_fetch(:right_primary_key_methods){Array(right_primary_key_method)}
end

- (Object) right_primary_keys

The primary key columns to use in the associated table (always array).



908
909
910
# File 'lib/sequel/model/associations.rb', line 908

def right_primary_keys
  cached_fetch(:right_primary_keys){Array(right_primary_key)}
end

- (Object) select

The columns to select when loading the association, associated_class.table_name.* by default.



925
926
927
# File 'lib/sequel/model/associations.rb', line 925

def select
 cached_fetch(:select){Sequel::SQL::ColumnAll.new(associated_class.table_name)}
end