модуль ActiveRecord::CounterCache::ClassMethods
Публичные методы экземпляра
# File activerecord/lib/active_record/counter_cache.rb, line 176 def decrement_counter(counter_name, id, by: 1, touch: nil) update_counters(id, counter_name => -by, touch: touch) end
Уменьшает числовое поле на единицу с помощью прямого обновления SQL.
Этот метод работает так же, как increment_counter, но уменьшает значение столбца на 1 вместо увеличения.
Параметры
-
counter_name- Имя поля, которое нужно уменьшить. -
id- Идентификатор объекта, который нужно уменьшить, или массив идентификаторов. -
:by- Количество на которое нужно уменьшить значение. По умолчанию1. -
:touch- Обновить метки временных столбцов при обновлении. Передайтеtrueдля обновленияupdated_atи/илиupdated_on. Передайте символ, чтобы обновить этот столбец, или массив символов, чтобы обновить только указанные.
Примеры
# 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 by a specific amount. DiscussionBoard.decrement_counter(:posts_count, 5, by: 3) # 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)
# File activerecord/lib/active_record/counter_cache.rb, line 146 def increment_counter(counter_name, id, by: 1, touch: nil) update_counters(id, counter_name => by, touch: touch) end
Увеличивает числовое поле на единицу с помощью прямого обновления SQL.
Этот метод используется в основном для поддержания столбцов counter_cache, которые хранят агрегированные значения. Например, DiscussionBoard может кэшировать posts_count и comments_count, чтобы избежать выполнения запроса SQL для подсчёта количества постов и комментариев каждый раз при отображении.
Параметры
-
counter_name- Имя поля, которое нужно увеличить. -
id- Идентификатор объекта, который нужно увеличить, или массив идентификаторов. -
:by- Количество на которое нужно увеличить значение. По умолчанию1. -
:touch- Обновить метки временных столбцов при обновлении. Передайтеtrueдля обновленияupdated_atи/илиupdated_on. Передайте символ, чтобы обновить этот столбец, или массив символов, чтобы обновить только указанные.
Примеры
# Increment the posts_count column for the record with an id of 5 DiscussionBoard.increment_counter(:posts_count, 5) # Increment the posts_count column for the record with an id of 5 # by a specific amount. DiscussionBoard.increment_counter(:posts_count, 5, by: 3) # Increment the posts_count column for the record with an id of 5 # and update the updated_at value. DiscussionBoard.increment_counter(:posts_count, 5, touch: true)
# File activerecord/lib/active_record/counter_cache.rb, line 33
def reset_counters(id, *counters, touch: nil)
object = find(id)
updates = {}
counters.each do |counter_association|
has_many_association = _reflect_on_association(counter_association)
unless has_many_association
has_many = reflect_on_all_associations(:has_many)
has_many_association = has_many.find { |association| association.counter_cache_column && association.counter_cache_column.to_sym == counter_association.to_sym }
counter_association = has_many_association.plural_name if has_many_association
end
raise ArgumentError, "'#{name}' has no association called '#{counter_association}'" unless has_many_association
if has_many_association.is_a? ActiveRecord::Reflection::ThroughReflection
has_many_association = has_many_association.through_reflection
end
foreign_key = has_many_association.foreign_key.to_s
child_class = has_many_association.klass
reflection = child_class._reflections.values.find { |e| e.belongs_to? && e.foreign_key.to_s == foreign_key && e.options[:counter_cache].present? }
counter_name = reflection.counter_cache_column
count_was = object.send(counter_name)
count = object.send(counter_association).count(:all)
updates[counter_name] = count if count != count_was
end
if touch
names = touch if touch != true
names = Array.wrap(names)
options = names.extract_options!
touch_updates = touch_attributes_with_time(*names, **options)
updates.merge!(touch_updates)
end
unscoped.where(primary_key => object.id).update_all(updates) if updates.any?
true
end Сбрасывает один или несколько счётчиков кэша до правильного значения с помощью запроса SQL подсчёта. Это полезно при добавлении новых счётчиков кэша или если счётчик был повреждён или изменён непосредственно с помощью SQL.
Параметры
-
id- Идентификатор объекта, на котором вы хотите сбросить счётчик. -
counters- Один или несколько счётчиков ассоциации для сброса. Можно указать имя ассоциации или имя счётчика. -
:touch- Обновить метки временных столбцов при обновлении. Передайтеtrueдля обновленияupdated_atи/илиupdated_on. Передайте символ, чтобы обновить этот столбец, или массив символов, чтобы обновить только указанные.
Примеры
# For the Post with id #1, reset the comments_count Post.reset_counters(1, :comments) # Like above, but also touch the +updated_at+ and/or +updated_on+ # attributes. Post.reset_counters(1, :comments, touch: true)
# File activerecord/lib/active_record/counter_cache.rb, line 114 def update_counters(id, counters) unscoped.where!(primary_key => id).update_counters(counters) end
Реализация универсального «обновления счётчика», предназначенная в первую очередь для использования с increment_counter и decrement_counter, но которая также может быть полезна сама по себе. Она просто выполняет прямое обновление SQL для записи с заданным идентификатором, изменяя указанный хэш счётчиков на указанную величину:
Параметры
-
id- Идентификатор объекта, на котором вы хотите обновить счётчик, или массив идентификаторов. -
counters-Hash, содержащий имена полей для обновления в качестве ключей и величину для обновления поля в качестве значений. -
:touch- опция - Обновить метки временных столбцов при обновлении. Если переданы имена атрибутов, они обновляются вместе с атрибутами updated_at/on.
Примеры
# For the Post with id of 5, decrement the comments_count by 1, and # increment the actions_count by 1 Post.update_counters 5, comments_count: -1, actions_count: 1 # Executes the following SQL: # UPDATE posts # SET comments_count = COALESCE(comments_count, 0) - 1, # actions_count = COALESCE(actions_count, 0) + 1 # WHERE id = 5 # For the Posts with id of 10 and 15, increment the comments_count by 1 Post.update_counters [10, 15], comments_count: 1 # Executes the following SQL: # UPDATE posts # SET comments_count = COALESCE(comments_count, 0) + 1 # WHERE id IN (10, 15) # For the Posts with id of 10 and 15, increment the comments_count by 1 # and update the updated_at value for each counter. Post.update_counters [10, 15], comments_count: 1, touch: true # Executes the following SQL: # UPDATE posts # SET comments_count = COALESCE(comments_count, 0) + 1, # `updated_at` = '2016-10-13T09:59:23-05:00' # WHERE id IN (10, 15)
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.