instance method `sum`

Ruby on Rails 4.0.13

Since v3.0.20

Available in: v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

sum(*args)

Calculates the sum of values on a given column. The value is returned with the same data type of the column, 0 if there’s no row. See calculate for examples with options.

Person.sum('age') # => 4562

Parameters

args rest

Source

# File activerecord/lib/active_record/relation/calculations.rb, line 58
    def sum(*args)
      if block_given?
        ActiveSupport::Deprecation.warn(
          "Calling #sum with a block is deprecated and will be removed in Rails 4.1. " \
          "If you want to perform sum calculation over the array of elements, use `to_a.sum(&block)`."
        )
        self.to_a.sum(*args) {|*block_args| yield(*block_args)}
      else
        calculate(:sum, *args)
      end
    end

Defined in activerecord/lib/active_record/relation/calculations.rb line 58 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveRecord::Calculations

Signature

Parameters