Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/k0kubun/activerecord-precounter
Yet Another N+1 COUNT Query Killer for ActiveRecord
https://github.com/k0kubun/activerecord-precounter
Last synced: 30 days ago
JSON representation
Yet Another N+1 COUNT Query Killer for ActiveRecord
- Host: GitHub
- URL: https://github.com/k0kubun/activerecord-precounter
- Owner: k0kubun
- License: mit
- Created: 2017-08-12T10:06:50.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-07-20T03:57:30.000Z (almost 2 years ago)
- Last Synced: 2024-05-12T06:21:54.289Z (about 1 month ago)
- Language: Ruby
- Size: 50.8 KB
- Stars: 102
- Watchers: 6
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Lists
- awesome-stars - activerecord-precounter
README
# ActiveRecord::Precounter [](https://github.com/k0kubun/activerecord-precounter/actions/workflows/test.yml)
Yet Another N+1 COUNT Query Killer for ActiveRecord, counter\_cache alternative.
ActiveRecord::Precounter allows you to cache count of associated records by eager loading.
This is another version of [activerecord-precount](https://github.com/k0kubun/activerecord-precount),
which is not elegant but designed to have no monkey-patch to ActiveRecord internal APIs for maintainability.
## Synopsis
### N+1 count query
Sometimes you may see many count queries for one association.
You can use counter\_cache to solve it, but you need to ALTER table and concern about dead lock to use counter\_cache.
```rb
tweets = Tweet.all
tweets.each do |tweet|
p tweet.favorites.count
end
# SELECT `tweets`.* FROM `tweets`
# SELECT COUNT(*) FROM `favorites` WHERE `favorites`.`tweet_id` = 1
# SELECT COUNT(*) FROM `favorites` WHERE `favorites`.`tweet_id` = 2
# SELECT COUNT(*) FROM `favorites` WHERE `favorites`.`tweet_id` = 3
# SELECT COUNT(*) FROM `favorites` WHERE `favorites`.`tweet_id` = 4
# SELECT COUNT(*) FROM `favorites` WHERE `favorites`.`tweet_id` = 5
```
### Count eager loading
#### precount
With activerecord-precounter gem installed, you can use `ActiveRecord::Precounter#precount` method
to eagerly load counts of associated records.
Like `preload`, it loads counts by multiple queries
```rb
tweets = Tweet.all
ActiveRecord::Precounter.new(tweets).precount(:favorites)
tweets.each do |tweet|
p tweet.favorites_count
end
# SELECT `tweets`.* FROM `tweets`
# SELECT COUNT(`favorites`.`tweet_id`), `favorites`.`tweet_id` FROM `favorites` WHERE `favorites`.`tweet_id` IN (1, 2, 3, 4, 5) GROUP BY `favorites`.`tweet_id`
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'activerecord-precounter'
```
## Limitation
Target `has_many` association must have inversed `belongs_to`.
i.e. `ActiveRecord::Precounter.new(tweets).precount(:favorites)` needs both `Tweet.has_many(:favorites)` and `Favorite.belongs_to(:tweet)`.
Unlike [activerecord-precount](https://github.com/k0kubun/activerecord-precount), the cache store is not ActiveRecord association and it does not utilize ActiveRecord preloader.
Thus you can't use `preload` to eager load counts for nested associations. And currently there's no JOIN support.
## License
MIT License