method

excluding

v7.1.3.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
4.1.8
4.2.1
4.2.7
4.2.9
5.0.0.1
5.1.7
5.2.3
6.0.0
6.1.3.1
6.1.7.7
7.0.0 (0)
7.1.3.2 (0)
7.1.3.4 (0)
What's this?

excluding(*records) public

Excludes the specified record (or collection of records) from the resulting relation. For example:

Post.excluding(post)
# SELECT "posts".* FROM "posts" WHERE "posts"."id" != 1

Post.excluding(post_one, post_two)
# SELECT "posts".* FROM "posts" WHERE "posts"."id" NOT IN (1, 2)

This can also be called on associations. As with the above example, either a single record of collection thereof may be specified:

post = Post.find(1)
comment = Comment.find(2)
post.comments.excluding(comment)
# SELECT "comments".* FROM "comments" WHERE "comments"."post_id" = 1 AND "comments"."id" != 2

This is short-hand for .where.not(id: post.id) and .where.not(id: [post_one.id, post_two.id]).

An ArgumentError will be raised if either no records are specified, or if any of the records in the collection (if a collection is passed in) are not instances of the same model that the relation is scoping.

Show source

# File activerecord/lib/active_record/relation/query_methods.rb, line 1470
    def excluding(*records)
      records.flatten!(1)
      records.compact!

      unless records.all?(klass)
        raise ArgumentError, "You must only pass a single or collection of #{klass.name} objects to ##{__callee__}."
      end

      spawn.excluding!(records)
    end

excluding

Related methods