instance method `increment_counter`

Ruby on Rails 4.1.16

Since v4.0.13

Available in: 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:

increment_counter(counter_name, id)

Increment a numeric field by one, via a direct SQL update.

This method is used primarily for maintaining counter_cache columns that are used to store aggregate values. For example, a DiscussionBoard may cache posts_count and comments_count to avoid running an SQL query to calculate the number of posts and comments there are, each time it is displayed.

Parameters

counter_name - The name of the field that should be incremented.
id - The id of the object that should be incremented or an Array of ids.

Examples

# Increment the post_count column for the record with an id of 5
DiscussionBoard.increment_counter(:post_count, 5)

Parameters

counter_name req
id req

Source

# File activerecord/lib/active_record/counter_cache.rb, line 98
      def increment_counter(counter_name, id)
        update_counters(id, counter_name => 1)
      end

Defined in activerecord/lib/active_record/counter_cache.rb line 98 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveRecord::CounterCache::ClassMethods

Signature

Parameters

Examples

Parameters