instance method decrement_counter

Ruby on Rails 6.1.7.10

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

Signature

decrement_counter(counter_name, id, touch: nil)

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

This works the same as #increment_counter but reduces the column value by 1 instead of increasing it.

Parameters

  • counter_name - The name of the field that should be decremented.

  • id - The id of the object that should be decremented or an array of ids.

  • :touch - Touch timestamp columns when updating. Pass true to touch updated_at and/or updated_on. Pass a symbol to touch that column or an array of symbols to touch just those ones.

Examples

# Decrement the posts_count column for the record with an id of 5
DiscussionBoard.decrement_counter(:posts_count, 5)

# Decrement the posts_count column for the record with an id of 5
# and update the updated_at value.
DiscussionBoard.decrement_counter(:posts_count, 5, touch: true)

Parameters

counter_name req
id req
touch key = nil
Source
# File activerecord/lib/active_record/counter_cache.rb, line 159
      def decrement_counter(counter_name, id, touch: nil)
        update_counters(id, counter_name => -1, touch: touch)
      end

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

Defined in ActiveRecord::CounterCache::ClassMethods

Type at least 2 characters to search.

↑↓ navigate · open · esc close