method

sum

v5.2.3 - Show latest stable - 0 notes - Class: ActiveRecord::Calculations

1.0.0
1.1.6
1.2.6
2.0.3
2.1.0
2.2.1
2.3.8
3.0.0 (0)
3.0.9 (-1)
3.1.0 (0)
3.2.1 (0)
3.2.8 (0)
3.2.13 (0)
4.0.2 (0)
4.1.8 (0)
4.2.1 (0)
4.2.7 (0)
4.2.9 (0)
5.0.0.1 (0)
5.1.7 (0)
5.2.3 (0)
6.0.0 (0)
6.1.3.1 (0)
6.1.7.7 (0)
7.0.0 (0)
7.1.3.2 (38)
7.1.3.4 (0)
What's this?

sum(column_name = nil) public

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

Show source

# File activerecord/lib/active_record/relation/calculations.rb, line 86
    def sum(column_name = nil)
      if block_given?
        unless column_name.nil?
          ActiveSupport::Deprecation.warn              "When `sum' is called with a block, it ignores other arguments. "              "This behavior is now deprecated and will result in an ArgumentError in Rails 6.0."
        end

        return super()
      end

      calculate(:sum, column_name)
    end

sum

Related methods