Module: ActiveRecord::FinderMethods

Included in:
Relation
Defined in:
lib/active_record/relation/finder_methods.rb

Instance Method Summary collapse

Instance Method Details

#exists?(conditions = :none) ⇒ Boolean

Returns true if a record exists in the table that matches the id or conditions given, or false otherwise. The argument can take six forms:

  • Integer - Finds the record with this primary key.

  • String - Finds the record with a primary key corresponding to this string (such as '5').

  • Array - Finds the record that matches these find-style conditions (such as ['name LIKE ?', "%#{query}%"]).

  • Hash - Finds the record that matches these find-style conditions (such as {name: 'David'}).

  • false - Returns always false.

  • No args - Returns false if the table is empty, true otherwise.

For more information about specifying conditions as a hash or array, see the Conditions section in the introduction to ActiveRecord::Base.

Note: You can’t pass in a condition as a string (like name = 'Jamie'), since it would be sanitized and then queried against the primary key column, like id = 'name = \'Jamie\''.

Person.exists?(5)
Person.exists?('5')
Person.exists?(['name LIKE ?', "%#{query}%"])
Person.exists?(name: 'David')
Person.exists?(false)
Person.exists?

Returns:

  • (Boolean) 


160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/active_record/relation/finder_methods.rb', line 160

def exists?(conditions = :none)
  conditions = conditions.id if Base === conditions
  return false if !conditions

  join_dependency = construct_join_dependency_for_association_find
  relation = construct_relation_for_association_find(join_dependency)
  relation = relation.except(:select, :order).select("1 AS one").limit(1)

  case conditions
  when Array, Hash
    relation = relation.where(conditions)
  else
    relation = relation.where(table[primary_key].eq(conditions)) if conditions != :none
  end

  connection.select_value(relation, "#{name} Exists", relation.bind_values) ? true : false
rescue ThrowResult
  false
end

#find(*args) ⇒ Object

Find by id - This can either be a specific id (1), a list of ids (1, 5, 6), or an array of ids ([5, 6, 10]). If no record can be found for all of the listed ids, then RecordNotFound will be raised. If the primary key is an integer, find by id coerces its arguments using to_i.

Person.find(1)          # returns the object for ID = 1
Person.find("1")        # returns the object for ID = 1
Person.find("31-sarah") # returns the object for ID = 31
Person.find(1, 2, 6)    # returns an array for objects with IDs in (1, 2, 6)
Person.find([7, 17])    # returns an array for objects with IDs in (7, 17)
Person.find([1])        # returns an array for the object with ID = 1
Person.where("administrator = 1").order("created_on DESC").find(1)

Note that returned records may not be in the same order as the ids you provide since database rows are unordered. Give an explicit order to ensure the results are sorted.

Find with lock

Example for find with a lock: Imagine two concurrent transactions: each will read person.visits == 2, add 1 to it, and save, resulting in two saves of person.visits = 3. By locking the row, the second transaction has to wait until the first is finished; we get the expected person.visits == 4.

Person.transaction do
  person = Person.lock(true).find(1)
  person.visits += 1
  person.save!
end



32
33
34
35
36
37
38
 
# File 'lib/active_record/relation/finder_methods.rb', line 32

def find(*args)
  if block_given?
    to_a.find { |*block_args| yield(*block_args) }
  else
    find_with_ids(*args)
  end
end

#find_by(*args) ⇒ Object

Finds the first record matching the specified conditions. There is no implied ordering so if order matters, you should specify it yourself.

If no record is found, returns nil.

Post.find_by name: 'Spartacus', rating: 4
Post.find_by "published_at < ?", 2.weeks.ago



48
49
50
 
# File 'lib/active_record/relation/finder_methods.rb', line 48

def find_by(*args)
  where(*args).take
end

#find_by!(*args) ⇒ Object

Like find_by, except that if no record is found, raises an ActiveRecord::RecordNotFound error.



54
55
56
 
# File 'lib/active_record/relation/finder_methods.rb', line 54

def find_by!(*args)
  where(*args).take!
end

#first(limit = nil) ⇒ Object

Find the first record (or first N records if a parameter is supplied). If no order is defined it will order by primary key.

Person.first # returns the first object fetched by SELECT * FROM people
Person.where(["user_name = ?", user_name]).first
Person.where(["user_name = :u", { u: user_name }]).first
Person.order("created_on DESC").offset(5).first
Person.first(3) # returns the first three objects fetched by SELECT * FROM people LIMIT 3



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/active_record/relation/finder_methods.rb', line 83

def first(limit = nil)
  if limit
    if order_values.empty? && primary_key
      order(arel_table[primary_key].asc).limit(limit).to_a
    else
      limit(limit).to_a
    end
  else
    find_first
  end
end

#first! ⇒ Object

Same as first but raises ActiveRecord::RecordNotFound if no record is found. Note that first! accepts no arguments.



97
98
99
 
# File 'lib/active_record/relation/finder_methods.rb', line 97

def first!
  first or raise RecordNotFound
end

#last(limit = nil) ⇒ Object

Find the last record (or last N records if a parameter is supplied). If no order is defined it will order by primary key.

Person.last # returns the last object fetched by SELECT * FROM people
Person.where(["user_name = ?", user_name]).last
Person.order("created_on DESC").offset(5).last
Person.last(3) # returns the last three objects fetched by SELECT * FROM people.

Take note that in that last case, the results are sorted in ascending order:

[#<Person id:2>, #<Person id:3>, #<Person id:4>]

and not:

[#<Person id:4>, #<Person id:3>, #<Person id:2>]



116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/active_record/relation/finder_methods.rb', line 116

def last(limit = nil)
  if limit
    if order_values.empty? && primary_key
      order(arel_table[primary_key].desc).limit(limit).reverse
    else
      to_a.last(limit)
    end
  else
    find_last
  end
end

#last! ⇒ Object

Same as last but raises ActiveRecord::RecordNotFound if no record is found. Note that last! accepts no arguments.



130
131
132
 
# File 'lib/active_record/relation/finder_methods.rb', line 130

def last!
  last or raise RecordNotFound
end

#raise_record_not_found_exception!(ids, result_size, expected_size) ⇒ Object

This method is called whenever no records are found with either a single id or multiple ids and raises a ActiveRecord::RecordNotFound exception.

The error message is different depending on whether a single id or multiple ids are provided. If multiple ids are provided, then the number of results obtained should be provided in the result_size argument and the expected number of results should be provided in the expected_size argument.

Raises:



188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/active_record/relation/finder_methods.rb', line 188

def raise_record_not_found_exception!(ids, result_size, expected_size) #:nodoc:
  conditions = arel.where_sql
  conditions = " [#{conditions}]" if conditions

  if Array(ids).size == 1
    error = "Couldn't find #{@klass.name} with #{primary_key}=#{ids}#{conditions}"
  else
    error = "Couldn't find all #{@klass.name.pluralize} with IDs "
    error << "(#{ids.join(", ")})#{conditions} (found #{result_size} results, but was looking for #{expected_size})"
  end

  raise RecordNotFound, error
end

#take(limit = nil) ⇒ Object

Gives a record (or N records if a parameter is supplied) without any implied order. The order will depend on the database implementation. If an order is supplied it will be respected.

Person.take # returns an object fetched by SELECT * FROM people LIMIT 1
Person.take(5) # returns 5 objects fetched by SELECT * FROM people LIMIT 5
Person.where(["name LIKE '%?'", name]).take



65
66
67
 
# File 'lib/active_record/relation/finder_methods.rb', line 65

def take(limit = nil)
  limit ? limit(limit).to_a : find_take
end

#take! ⇒ Object

Same as take but raises ActiveRecord::RecordNotFound if no record is found. Note that take! accepts no arguments.



71
72
73
 
# File 'lib/active_record/relation/finder_methods.rb', line 71

def take!
  take or raise RecordNotFound
end