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 861 def can_have_associated_objects?(obj) 862 !self[:keys].any?{|k| obj.get_column_value(k).nil?} 863 end
Whether the dataset needs a primary key to function, false for many_to_one associations.
# File lib/sequel/model/associations.rb 866 def dataset_need_primary_key? 867 false 868 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 872 def default_key 873 :"#{self[:name]}_id" 874 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 878 def eager_graph_lazy_dataset? 879 self[:key].nil? 880 end
many_to_one associations don’t need an eager_graph limit strategy
# File lib/sequel/model/associations.rb 883 def eager_graph_limit_strategy(_) 884 nil 885 end
many_to_one associations don’t need an eager limit strategy
# File lib/sequel/model/associations.rb 888 def eager_limit_strategy 889 nil 890 end
many_to_one associations don’t need a filter by associations limit strategy
# File lib/sequel/model/associations.rb 893 def filter_by_associations_limit_strategy 894 nil 895 end
# File lib/sequel/model/associations.rb 905 def finalize_settings 906 FINALIZE_SETTINGS 907 end
The expression to use on the left hand side of the IN lookup when eager loading
# File lib/sequel/model/associations.rb 910 def predicate_key 911 cached_fetch(:predicate_key){qualified_primary_key} 912 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 915 def primary_key 916 cached_fetch(:primary_key){associated_class.primary_key || raise(Error, "no primary key specified for #{associated_class.inspect}")} 917 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 927 def primary_key_method 928 cached_fetch(:primary_key_method){primary_key} 929 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 933 def primary_key_methods 934 cached_fetch(:primary_key_methods){Array(primary_key_method)} 935 end
The columns in the associated table that the key in the current table references (always an array).
# File lib/sequel/model/associations.rb 920 def primary_keys 921 cached_fetch(:primary_keys){Array(primary_key)} 922 end
primary_key
qualified by the associated table
# File lib/sequel/model/associations.rb 938 def qualified_primary_key 939 cached_fetch(:qualified_primary_key){self[:qualify] == false ? primary_key : qualify_assoc(primary_key)} 940 end
True only if the reciprocal is a one_to_many association.
# File lib/sequel/model/associations.rb 943 def reciprocal_array? 944 !set_reciprocal_to_self? 945 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 949 def returns_array? 950 false 951 end
True only if the reciprocal is a one_to_one association.
# File lib/sequel/model/associations.rb 954 def set_reciprocal_to_self? 955 reciprocal 956 reciprocal_type == :one_to_one 957 end