module ActiveRecord::Scoping::Default::ClassMethods
def default_scope(scope = nil, all_queries: nil, &block) # :doc:
end
end
# Should return a scope, you can call 'super' here etc.
def self.default_scope
class Article < ActiveRecord::Base
alternatively define it as a class method:
If you need to do more complex things with a default scope, you can
class defines a second one.
parent or module defines a #default_scope and the child or including
This is also the case with inheritance and module includes where the
Article.all # => SELECT * FROM articles WHERE published = true AND rating = 'G'
end
default_scope { where(rating: 'G') }
default_scope { where(published: true) }
class Article < ActiveRecord::Base
they will be merged together:
If you use multiple #default_scope declarations in your model then
default scope.)
+default_scope+ macro, and it will be called when building the
(You can also pass any object which responds to +call+ to the
=> DELETE ... FROM `articles` where ID = 1 AND blog_id = 1;
Article.find(1).destroy
queries that return a single object by primary key.
where clauses apply, as it does not make sense to add order to
are always queried by the additional conditions. Note that only
Applying a default scope to all queries will ensure that records
end
default_scope -> { where(blog_id: 1) }, all_queries: true
class Article < ActiveRecord::Base
all_queries: true:
To apply a #default_scope when updating or deleting a record, add
Article.create.published # => true
Article.new.published # => true
It is not applied while updating or deleting a record.
The #default_scope is also applied while creating/building a record.
Article.all # => SELECT * FROM articles WHERE published = true
end
default_scope { where(published: true) }
class Article < ActiveRecord::Base
the model.
Use this macro in your model to set a default scope for all operations on
def default_scope(scope = nil, all_queries: nil, &block) # :doc: scope = block if block_given? if scope.is_a?(Relation) || !scope.respond_to?(:call) raise ArgumentError, "Support for calling #default_scope without a block is removed. For example instead " \ "of `default_scope where(color: 'red')`, please use " \ "`default_scope { where(color: 'red') }`. (Alternatively you can just redefine " \ "self.default_scope.)" end default_scope = DefaultScope.new(scope, all_queries) self.default_scopes += [default_scope] end