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