Module Sequel::Model::Associations::DatasetMethods
In: lib/sequel/model/associations.rb

Eager loading makes it so that you can load all associated records for a set of objects in a single query, instead of a separate query for each object.

Two separate implementations are provided. eager should be used most of the time, as it loads associated records using one query per association. However, it does not allow you the ability to filter or order based on columns in associated tables. eager_graph loads all records in a single query using JOINs, allowing you to filter or order based on columns in associated tables. However, eager_graph is usually slower than eager, especially if multiple one_to_many or many_to_many associations are joined.

You can cascade the eager loading (loading associations on associated objects) with no limit to the depth of the cascades. You do this by passing a hash to eager or eager_graph with the keys being associations of the current model and values being associations of the model associated with the current model via the key.

The arguments can be symbols or hashes with symbol keys (for cascaded eager loading). Examples:

  Album.eager(:artist).all
  Album.eager_graph(:artist).all
  Album.eager(:artist, :genre).all
  Album.eager_graph(:artist, :genre).all
  Album.eager(:artist).eager(:genre).all
  Album.eager_graph(:artist).eager(:genre).all
  Artist.eager(albums: :tracks).all
  Artist.eager_graph(albums: :tracks).all
  Artist.eager(albums: {tracks: :genre}).all
  Artist.eager_graph(albums: {tracks: :genre}).all

You can also pass a callback as a hash value in order to customize the dataset being eager loaded at query time, analogous to the way the :eager_block association option allows you to customize it at association definition time. For example, if you wanted artists with their albums since 1990:

  Artist.eager(albums: proc{|ds| ds.where{year > 1990}})

Or if you needed albums and their artist‘s name only, using a single query:

  Albums.eager_graph(artist: proc{|ds| ds.select(:name)})

To cascade eager loading while using a callback, you substitute the cascaded associations with a single entry hash that has the proc callback as the key and the cascaded associations as the value. This will load artists with their albums since 1990, and also the tracks on those albums and the genre for those tracks:

  Artist.eager(albums: {proc{|ds| ds.where{year > 1990}}=>{tracks: :genre}})

Methods

Public Instance methods

If the dataset is being eagerly loaded, default to calling all instead of each.

[Source]

      # File lib/sequel/model/associations.rb, line 2824
2824:         def as_hash(key_column=nil, value_column=nil, opts=OPTS)
2825:           if (@opts[:eager_graph] || @opts[:eager]) && !opts.has_key?(:all)
2826:             opts = Hash[opts]
2827:             opts[:all] = true
2828:           end
2829:           super
2830:         end

Adds one or more INNER JOINs to the existing dataset using the keys and conditions specified by the given association. The following methods also exist for specifying a different type of JOIN:

association_full_join :FULL JOIN
association_inner_join :INNER JOIN
association_left_join :LEFT JOIN
association_right_join :RIGHT JOIN

[Source]

      # File lib/sequel/model/associations.rb, line 2671
2671:         def association_join(*associations)
2672:           association_inner_join(*associations)
2673:         end

If the expression is in the form x = y where y is a Sequel::Model instance, array of Sequel::Model instances, or a Sequel::Model dataset, assume x is an association symbol and look up the association reflection via the dataset‘s model. From there, return the appropriate SQL based on the type of association and the values of the foreign/primary keys of y. For most association types, this is a simple transformation, but for many_to_many associations this creates a subquery to the join table.

[Source]

      # File lib/sequel/model/associations.rb, line 2682
2682:         def complex_expression_sql_append(sql, op, args)
2683:           r = args[1]
2684:           if (((op == '=''=' || op == '!=''!=') and r.is_a?(Sequel::Model)) ||
2685:               (multiple = ((op == :IN || op == 'NOT IN''NOT IN') and ((is_ds = r.is_a?(Sequel::Dataset)) or r.all?{|x| x.is_a?(Sequel::Model)}))))
2686:             l = args[0]
2687:             if ar = model.association_reflections[l]
2688:               if multiple
2689:                 klass = ar.associated_class
2690:                 if is_ds
2691:                   if r.respond_to?(:model)
2692:                     unless r.model <= klass
2693:                       # A dataset for a different model class, could be a valid regular query
2694:                       return super
2695:                     end
2696:                   else
2697:                     # Not a model dataset, could be a valid regular query
2698:                     return super
2699:                   end
2700:                 else
2701:                   unless r.all?{|x| x.is_a?(klass)}
2702:                     raise Sequel::Error, "invalid association class for one object for association #{l.inspect} used in dataset filter for model #{model.inspect}, expected class #{klass.inspect}"
2703:                   end
2704:                 end
2705:               elsif !r.is_a?(ar.associated_class)
2706:                 raise Sequel::Error, "invalid association class #{r.class.inspect} for association #{l.inspect} used in dataset filter for model #{model.inspect}, expected class #{ar.associated_class.inspect}"
2707:               end
2708: 
2709:               if exp = association_filter_expression(op, ar, r)
2710:                 literal_append(sql, exp)
2711:               else
2712:                 raise Sequel::Error, "invalid association type #{ar[:type].inspect} for association #{l.inspect} used in dataset filter for model #{model.inspect}"
2713:               end
2714:             elsif multiple && (is_ds || r.empty?)
2715:               # Not a query designed for this support, could be a valid regular query
2716:               super
2717:             else
2718:               raise Sequel::Error, "invalid association #{l.inspect} used in dataset filter for model #{model.inspect}"
2719:             end
2720:           else
2721:             super
2722:           end
2723:         end

The preferred eager loading method. Loads all associated records using one query for each association.

The basic idea for how it works is that the dataset is first loaded normally. Then it goes through all associations that have been specified via eager. It loads each of those associations separately, then associates them back to the original dataset via primary/foreign keys. Due to the necessity of all objects being present, you need to use all to use eager loading, as it can‘t work with each.

This implementation avoids the complexity of extracting an object graph out of a single dataset, by building the object graph out of multiple datasets, one for each association. By using a separate dataset for each association, it avoids problems such as aliasing conflicts and creating cartesian product result sets if multiple one_to_many or many_to_many eager associations are requested.

One limitation of using this method is that you cannot filter the current dataset based on values of columns in an associated table, since the associations are loaded in separate queries. To do that you need to load all associations in the same query, and extract an object graph from the results of that query. If you need to filter based on columns in associated tables, look at eager_graph or join the tables you need to filter on manually.

Each association‘s order, if defined, is respected. If the association uses a block or has an :eager_block argument, it is used.

[Source]

      # File lib/sequel/model/associations.rb, line 2750
2750:         def eager(*associations)
2751:           opts = @opts[:eager]
2752:           association_opts = eager_options_for_associations(associations)
2753:           opts = opts ? Hash[opts].merge!(association_opts) : association_opts
2754:           clone(:eager=>opts)
2755:         end

The secondary eager loading method. Loads all associations in a single query. This method should only be used if you need to filter or order based on columns in associated tables, or if you have done comparative benchmarking it and determined it is faster.

This method uses Dataset#graph to create appropriate aliases for columns in all the tables. Then it uses the graph‘s metadata to build the associations from the single hash, and finally replaces the array of hashes with an array model objects inside all.

Be very careful when using this with multiple one_to_many or many_to_many associations, as you can create large cartesian products. If you must graph multiple one_to_many and many_to_many associations, make sure your filters are narrow if the datasets are large.

Each association‘s order, if defined, is respected. eager_graph probably won‘t work correctly on a limited dataset, unless you are only graphing many_to_one, one_to_one, and one_through_one associations.

Does not use the block defined for the association, since it does a single query for all objects. You can use the :graph_* association options to modify the SQL query.

Like eager, you need to call all on the dataset for the eager loading to work. If you just call each, it will yield plain hashes, each containing all columns from all the tables.

[Source]

      # File lib/sequel/model/associations.rb, line 2778
2778:         def eager_graph(*associations)
2779:           eager_graph_with_options(associations)
2780:         end

Run eager_graph with some options specific to just this call. Unlike eager_graph, this takes the associations as a single argument instead of multiple arguments.

Options:

:join_type :Override the join type specified in the association
:limit_strategy :Use a strategy for handling limits on associations. Appropriate :limit_strategy values are:
true :Pick the most appropriate based on what the database supports
:distinct_on :Force use of DISTINCT ON stategy (*_one associations only)
:correlated_subquery :Force use of correlated subquery strategy (one_to_* associations only)
:window_function :Force use of window function strategy
:ruby :Don‘t modify the SQL, implement limits/offsets with array slicing

This can also be a hash with association name symbol keys and one of the above values, to use different strategies per association.

The default is the :ruby strategy. Choosing a different strategy can make your code significantly slower in some cases (perhaps even the majority of cases), so you should only use this if you have benchmarked that it is faster for your use cases.

[Source]

      # File lib/sequel/model/associations.rb, line 2802
2802:         def eager_graph_with_options(associations, opts=OPTS)
2803:           associations = [associations] unless associations.is_a?(Array)
2804:           if eg = @opts[:eager_graph]
2805:             eg = eg.dup
2806:             [:requirements, :reflections, :reciprocals, :limits].each{|k| eg[k] = eg[k].dup}
2807:             eg[:local] = opts
2808:             ds = clone(:eager_graph=>eg)
2809:             ds.eager_graph_associations(ds, model, ds.opts[:eager_graph][:master], [], *associations)
2810:           else
2811:             # Each of the following have a symbol key for the table alias, with the following values: 
2812:             # :reciprocals :: the reciprocal value to use for this association
2813:             # :reflections :: AssociationReflection instance related to this association
2814:             # :requirements :: array of requirements for this association
2815:             # :limits :: Any limit/offset array slicing that need to be handled in ruby land after loading
2816:             opts = {:requirements=>{}, :master=>alias_symbol(first_source), :reflections=>{}, :reciprocals=>{}, :limits=>{}, :local=>opts, :cartesian_product_number=>0, :row_proc=>row_proc}
2817:             ds = clone(:eager_graph=>opts)
2818:             ds.eager_graph_associations(ds, model, ds.opts[:eager_graph][:master], [], *associations).naked
2819:           end
2820:         end

If the dataset is being eagerly loaded, default to calling all instead of each.

[Source]

      # File lib/sequel/model/associations.rb, line 2834
2834:         def to_hash_groups(key_column, value_column=nil, opts=OPTS)
2835:           if (@opts[:eager_graph] || @opts[:eager]) && !opts.has_key?(:all)
2836:             opts = Hash[opts]
2837:             opts[:all] = true
2838:           end
2839:           super
2840:         end

Do not attempt to split the result set into associations, just return results as simple objects. This is useful if you want to use eager_graph as a shortcut to have all of the joins and aliasing set up, but want to do something else with the dataset.

[Source]

      # File lib/sequel/model/associations.rb, line 2846
2846:         def ungraphed
2847:           ds = super.clone(:eager_graph=>nil)
2848:           if (eg = @opts[:eager_graph]) && (rp = eg[:row_proc])
2849:             ds = ds.with_row_proc(rp)
2850:           end
2851:           ds
2852:         end

Protected Instance methods

Call graph on the association with the correct arguments, update the eager_graph data structure, and recurse into eager_graph_associations if there are any passed in associations (which would be dependencies of the current association)

Arguments:

ds :Current dataset
model :Current Model
ta :table_alias used for the parent association
requirements :an array, used as a stack for requirements
r :association reflection for the current association, or an SQL::AliasedExpression with the reflection as the expression and the alias base as the aliaz.
*associations :any associations dependent on this one

[Source]

      # File lib/sequel/model/associations.rb, line 2869
2869:         def eager_graph_association(ds, model, ta, requirements, r, *associations)
2870:           if r.is_a?(SQL::AliasedExpression)
2871:             alias_base = r.alias
2872:             r = r.expression
2873:           else
2874:             alias_base = r[:graph_alias_base]
2875:           end
2876:           assoc_table_alias = ds.unused_table_alias(alias_base)
2877:           loader = r[:eager_grapher]
2878:           if !associations.empty?
2879:             if associations.first.respond_to?(:call)
2880:               callback = associations.first
2881:               associations = {}
2882:             elsif associations.length == 1 && (assocs = associations.first).is_a?(Hash) && assocs.length == 1 && (pr_assoc = assocs.to_a.first) && pr_assoc.first.respond_to?(:call)
2883:               callback, assoc = pr_assoc
2884:               associations = assoc.is_a?(Array) ? assoc : [assoc]
2885:             end
2886:           end
2887:           local_opts = ds.opts[:eager_graph][:local]
2888:           limit_strategy = r.eager_graph_limit_strategy(local_opts[:limit_strategy])
2889: 
2890:           if r[:conditions] && !Sequel.condition_specifier?(r[:conditions]) && !r[:orig_opts].has_key?(:graph_conditions) && !r[:orig_opts].has_key?(:graph_only_conditions) && !r.has_key?(:graph_block)
2891:             raise Error, "Cannot eager_graph association when :conditions specified and not a hash or an array of pairs.  Specify :graph_conditions, :graph_only_conditions, or :graph_block for the association.  Model: #{r[:model]}, association: #{r[:name]}"
2892:           end
2893: 
2894:           ds = loader.call(:self=>ds, :table_alias=>assoc_table_alias, :implicit_qualifier=>(ta == ds.opts[:eager_graph][:master]) ? first_source : qualifier_from_alias_symbol(ta, first_source), :callback=>callback, :join_type=>local_opts[:join_type], :join_only=>local_opts[:join_only], :limit_strategy=>limit_strategy, :from_self_alias=>ds.opts[:eager_graph][:master])
2895:           if r[:order_eager_graph] && (order = r.fetch(:graph_order, r[:order]))
2896:             ds = ds.order_append(*qualified_expression(order, assoc_table_alias))
2897:           end
2898:           eager_graph = ds.opts[:eager_graph]
2899:           eager_graph[:requirements][assoc_table_alias] = requirements.dup
2900:           eager_graph[:reflections][assoc_table_alias] = r
2901:           if limit_strategy == :ruby
2902:             eager_graph[:limits][assoc_table_alias] = r.limit_and_offset 
2903:           end
2904:           eager_graph[:cartesian_product_number] += r[:cartesian_product_number] || 2
2905:           ds = ds.eager_graph_associations(ds, r.associated_class, assoc_table_alias, requirements + [assoc_table_alias], *associations) unless associations.empty?
2906:           ds
2907:         end

Check the associations are valid for the given model. Call eager_graph_association on each association.

Arguments:

ds :Current dataset
model :Current Model
ta :table_alias used for the parent association
requirements :an array, used as a stack for requirements
*associations :the associations to add to the graph

[Source]

      # File lib/sequel/model/associations.rb, line 2918
2918:         def eager_graph_associations(ds, model, ta, requirements, *associations)
2919:           return ds if associations.empty?
2920:           associations.flatten.each do |association|
2921:             ds = case association
2922:             when Symbol, SQL::AliasedExpression
2923:               ds.eager_graph_association(ds, model, ta, requirements, eager_graph_check_association(model, association))
2924:             when Hash
2925:               association.each do |assoc, assoc_assocs|
2926:                 ds = ds.eager_graph_association(ds, model, ta, requirements, eager_graph_check_association(model, assoc), assoc_assocs)
2927:               end
2928:               ds
2929:             else
2930:               raise(Sequel::Error, 'Associations must be in the form of a symbol or hash')
2931:             end
2932:           end
2933:           ds
2934:         end

Replace the array of plain hashes with an array of model objects will all eager_graphed associations set in the associations cache for each object.

[Source]

      # File lib/sequel/model/associations.rb, line 2938
2938:         def eager_graph_build_associations(hashes)
2939:           hashes.replace(EagerGraphLoader.new(self).load(hashes))
2940:         end

[Validate]