Class: Sequel::Model::Associations::ManyToOneAssociationReflection

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

Constant Summary collapse

FINALIZE_SETTINGS =
superclass::FINALIZE_SETTINGS.merge(
  :primary_key=>:primary_key,
  :primary_keys=>:primary_keys,
  :primary_key_method=>:primary_key_method,
  :primary_key_methods=>:primary_key_methods,
  :qualified_primary_key=>:qualified_primary_key,
  :reciprocal_type=>:reciprocal_type
).freeze

Constants inherited from AssociationReflection

AssociationReflection::ASSOCIATION_DATASET_PROC

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_dataset_changes, #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_dataset_for, #association_dataset_proc, #association_method, #cloneable?, #dataset_method, #delete_row_number_column, #eager_load_results, #eager_loader_key, #eager_loading_use_associated_key?, #filter_by_associations_add_conditions?, #filter_by_associations_conditions_expression, #finalize, #handle_silent_modification_failure?, #initialize_association_cache, #inspect, #limit_and_offset, #need_associated_primary_key?, #placeholder_loader, #predicate_key_values, #predicate_keys, #qualify, #qualify_assoc, #qualify_cur, #reciprocal, #remove_all_method, #remove_before_destroy?, #remove_method, #remove_should_check_existing?, #select, #setter_method, #slice_range

Methods included from Inflections

clear, irregular, plural, singular, uncountable

Methods inherited from Hash

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

Instance Method Details

#can_have_associated_objects?(obj) ⇒ Boolean

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

Returns:

  • (Boolean)

817
818
819
# File 'lib/sequel/model/associations.rb', line 817

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

#dataset_need_primary_key?Boolean

Whether the dataset needs a primary key to function, false for many_to_one associations.

Returns:

  • (Boolean)

822
823
824
# File 'lib/sequel/model/associations.rb', line 822

def dataset_need_primary_key?
  false
end

#default_keyObject

Default foreign key name symbol for foreign key in current model's table that points to the given association's table's primary key.


828
829
830
# File 'lib/sequel/model/associations.rb', line 828

def default_key
  :"#{self[:name]}_id"
end

#eager_graph_lazy_dataset?Boolean

Whether to eagerly graph a lazy dataset, true for many_to_one associations only if the key is nil.

Returns:

  • (Boolean)

834
835
836
# File 'lib/sequel/model/associations.rb', line 834

def eager_graph_lazy_dataset?
  self[:key].nil?
end

#eager_graph_limit_strategy(_) ⇒ Object

many_to_one associations don't need an eager_graph limit strategy


839
840
841
# File 'lib/sequel/model/associations.rb', line 839

def eager_graph_limit_strategy(_)
  nil
end

#eager_limit_strategyObject

many_to_one associations don't need an eager limit strategy


844
845
846
# File 'lib/sequel/model/associations.rb', line 844

def eager_limit_strategy
  nil
end

#filter_by_associations_limit_strategyObject

many_to_one associations don't need a filter by associations limit strategy


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

def filter_by_associations_limit_strategy
  nil
end

#finalize_settingsObject


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

def finalize_settings
  FINALIZE_SETTINGS
end

#predicate_keyObject

The expression to use on the left hand side of the IN lookup when eager loading


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

def predicate_key
  cached_fetch(:predicate_key){qualified_primary_key}
end

#primary_keyObject

The column(s) in the associated table that the key in the current table references (either a symbol or an array).


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

def primary_key
 cached_fetch(:primary_key){associated_class.primary_key || raise(Error, "no primary key specified for #{associated_class.inspect}")}
end

#primary_key_methodObject

The method symbol or array of method symbols to call on the associated object to get the value to use for the foreign keys.


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

def primary_key_method
 cached_fetch(:primary_key_method){primary_key}
end

#primary_key_methodsObject

The array of method symbols to call on the associated object to get the value to use for the foreign keys.


889
890
891
# File 'lib/sequel/model/associations.rb', line 889

def primary_key_methods
 cached_fetch(:primary_key_methods){Array(primary_key_method)}
end

#primary_keysObject Also known as: associated_object_keys

The columns in the associated table that the key in the current table references (always an array).


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

def primary_keys
 cached_fetch(:primary_keys){Array(primary_key)}
end

#qualified_primary_keyObject

#primary_key qualified by the associated table


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

def qualified_primary_key
  cached_fetch(:qualified_primary_key){self[:qualify] == false ? primary_key : qualify_assoc(primary_key)}
end

#reciprocal_array?Boolean

True only if the reciprocal is a one_to_many association.

Returns:

  • (Boolean)

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

def reciprocal_array?
  !set_reciprocal_to_self?
end

#returns_array?Boolean

Whether this association returns an array of objects instead of a single object, false for a many_to_one association.

Returns:

  • (Boolean)

905
906
907
# File 'lib/sequel/model/associations.rb', line 905

def returns_array?
  false
end

#set_reciprocal_to_self?Boolean

True only if the reciprocal is a one_to_one association.

Returns:

  • (Boolean)

910
911
912
913
# File 'lib/sequel/model/associations.rb', line 910

def set_reciprocal_to_self?
  reciprocal
  reciprocal_type == :one_to_one
end