default_scope
- 1.0.0
- 1.1.6
- 1.2.6
- 2.0.3
- 2.1.0
- 2.2.1
- 2.3.8
- 3.0.0
- 3.0.9
- 3.1.0
- 3.2.1 (0)
- 3.2.8 (0)
- 3.2.13 (0)
- 4.0.2 (-16)
- 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 (38)
- 7.1.3.2 (0)
- 7.1.3.4 (0)
- What's this?
default_scope(scope = {})
protected
Use this macro in your model to set a default scope for all operations on the model.
class Article < ActiveRecord::Base default_scope where(:published => true) end Article.all # => SELECT * FROM articles WHERE published = true
The default_scope is also applied while creating/building a record. It is not applied while updating a record.
Article.new.published # => true Article.create.published # => true
You can also use default_scope with a block, in order to have it lazily evaluated:
class Article < ActiveRecord::Base default_scope { where(:published_at => Time.now - 1.week) } end
(You can also pass any object which responds to call to the default_scope macro, and it will be called when building the default scope.)
If you use multiple default_scope declarations in your model then they will be merged together:
class Article < ActiveRecord::Base default_scope where(:published => true) default_scope where(:rating => 'G') end Article.all # => SELECT * FROM articles WHERE published = true AND rating = 'G'
This is also the case with inheritance and module includes where the parent or module defines a default_scope and the child or including class defines a second one.
If you need to do more complex things with a default scope, you can alternatively define it as a class method:
class Article < ActiveRecord::Base def self.default_scope # Should return a scope, you can call 'super' here etc. end end