method

unscope

v4.0.2 - Show latest stable - 0 notes - Class: ActiveRecord::QueryMethods

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
3.2.8
3.2.13
4.0.2 (0)
4.1.8 (38)
4.2.1 (0)
4.2.7 (0)
4.2.9 (0)
5.0.0.1 (-20)
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 (0)
7.1.3.2 (0)
7.1.3.4 (0)
What's this?

unscope(*args) public

Removes an unwanted relation that is already defined on a chain of relations. This is useful when passing around chains of relations and would like to modify the relations without reconstructing the entire chain.

User.order('email DESC').unscope(:order) == User.all

The method arguments are symbols which correspond to the names of the methods which should be unscoped. The valid arguments are given in VALID_UNSCOPING_VALUES. The method can also be called with multiple arguments. For example:

User.order('email DESC').select('id').where(name: "John")
    .unscope(:order, :select, :where) == User.all

One can additionally pass a hash as an argument to unscope specific :where values. This is done by passing a hash with a single key-value pair. The key should be :where and the value should be the where value to unscope. For example:

User.where(name: "John", active: true).unscope(where: :name)
    == User.where(active: true)

Note that this method is more generalized than ActiveRecord::SpawnMethods#except because #except will only affect a particular relation’s values. It won’t wipe the order, grouping, etc. when that relation is merged. For example:

Post.comments.except(:order)

will still have an order if it comes from the default_scope on Comment.

Show source

# File activerecord/lib/active_record/relation/query_methods.rb, line 352
    def unscope(*args)
      check_if_method_has_arguments!("unscope", args)
      spawn.unscope!(*args)
    end

unscope

Related methods