instance method `sum`

Ruby on Rails 8.0.4

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(initial_value_or_column = 0, &block)

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

When given a block, calls the block with each record in the relation and returns the sum of initial_value_or_column plus the block return values:

Person.sum { |person| person.age } # => 4562
Person.sum(1000) { |person| person.age } # => 5562

If the relation hasn’t been loaded yet, calling sum with a block will load all records in the relation. If there are a lot of records in the relation, loading all records could result in performance issues.

Parameters

initial_value_or_column opt = 0
block block

Source

# File activerecord/lib/active_record/relation/calculations.rb, line 171
    def sum(initial_value_or_column = 0, &block)
      if block_given?
        map(&block).sum(initial_value_or_column)
      else
        calculate(:sum, initial_value_or_column)
      end
    end

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

Defined in ActiveRecord::Calculations

Signature

Parameters