Methods
Public Instance
- can_have_associated_objects?
- dataset_need_primary_key?
- default_key
- eager_graph_lazy_dataset?
- eager_graph_limit_strategy
- eager_limit_strategy
- filter_by_associations_limit_strategy
- finalize_settings
- predicate_key
- primary_key
- primary_key_method
- primary_key_methods
- primary_keys
- qualified_primary_key
- reciprocal_array?
- returns_array?
- set_reciprocal_to_self?
Constants
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 |
Public Instance Aliases
associated_object_keys | -> | primary_keys |
Public Instance methods
many_to_one associations can only have associated objects if none of the :keys options have a nil value.
# File lib/sequel/model/associations.rb 829 def can_have_associated_objects?(obj) 830 !self[:keys].any?{|k| obj.get_column_value(k).nil?} 831 end
Whether the dataset needs a primary key to function, false for many_to_one associations.
# File lib/sequel/model/associations.rb 834 def dataset_need_primary_key? 835 false 836 end
Default foreign key name symbol for foreign key in current model’s table that points to the given association’s table’s primary key.
# File lib/sequel/model/associations.rb 840 def default_key 841 :"#{self[:name]}_id" 842 end
Whether to eagerly graph a lazy dataset, true for many_to_one associations only if the key is nil.
# File lib/sequel/model/associations.rb 846 def eager_graph_lazy_dataset? 847 self[:key].nil? 848 end
many_to_one associations don’t need an eager_graph limit strategy
# File lib/sequel/model/associations.rb 851 def eager_graph_limit_strategy(_) 852 nil 853 end
many_to_one associations don’t need an eager limit strategy
# File lib/sequel/model/associations.rb 856 def eager_limit_strategy 857 nil 858 end
many_to_one associations don’t need a filter by associations limit strategy
# File lib/sequel/model/associations.rb 861 def filter_by_associations_limit_strategy 862 nil 863 end
# File lib/sequel/model/associations.rb 873 def finalize_settings 874 FINALIZE_SETTINGS 875 end
The expression to use on the left hand side of the IN lookup when eager loading
# File lib/sequel/model/associations.rb 878 def predicate_key 879 cached_fetch(:predicate_key){qualified_primary_key} 880 end
The column(s) in the associated table that the key in the current table references (either a symbol or an array).
# File lib/sequel/model/associations.rb 883 def primary_key 884 cached_fetch(:primary_key){associated_class.primary_key || raise(Error, "no primary key specified for #{associated_class.inspect}")} 885 end
The method symbol or array of method symbols to call on the associated object to get the value to use for the foreign keys.
# File lib/sequel/model/associations.rb 895 def primary_key_method 896 cached_fetch(:primary_key_method){primary_key} 897 end
The array of method symbols to call on the associated object to get the value to use for the foreign keys.
# File lib/sequel/model/associations.rb 901 def primary_key_methods 902 cached_fetch(:primary_key_methods){Array(primary_key_method)} 903 end
The columns in the associated table that the key in the current table references (always an array).
# File lib/sequel/model/associations.rb 888 def primary_keys 889 cached_fetch(:primary_keys){Array(primary_key)} 890 end
primary_key
qualified by the associated table
# File lib/sequel/model/associations.rb 906 def qualified_primary_key 907 cached_fetch(:qualified_primary_key){self[:qualify] == false ? primary_key : qualify_assoc(primary_key)} 908 end
True only if the reciprocal is a one_to_many association.
# File lib/sequel/model/associations.rb 911 def reciprocal_array? 912 !set_reciprocal_to_self? 913 end
Whether this association returns an array of objects instead of a single object, false for a many_to_one association.
# File lib/sequel/model/associations.rb 917 def returns_array? 918 false 919 end
True only if the reciprocal is a one_to_one association.
# File lib/sequel/model/associations.rb 922 def set_reciprocal_to_self? 923 reciprocal 924 reciprocal_type == :one_to_one 925 end