Module: ActiveRecord::FinderMethods

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

Constant Summary collapse

ONE_AS_ONE =
"1 AS one"

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 where-style conditions (such as ['name LIKE ?', "%#{query}%"]).

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

  • false - Returns always false.

  • No args - Returns false if the relation 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?(id: [1, 4, 8])
Person.exists?(name: 'David')
Person.exists?(false)
Person.exists?
Person.where(name: 'Spartacus', rating: 4).exists?

Returns:

  • (Boolean)


349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
# File 'lib/active_record/relation/finder_methods.rb', line 349

def exists?(conditions = :none)
  return false if @none

  if Base === conditions
    raise ArgumentError, <<-MSG.squish
      You are passing an instance of ActiveRecord::Base to `exists?`.
      Please pass the id of the object by calling `.id`.
    MSG
  end

  return false if !conditions || limit_value == 0

  if eager_loading?
    relation = apply_join_dependency(eager_loading: false)
    return relation.exists?(conditions)
  end

  relation = construct_relation_for_exists(conditions)
  return false if relation.where_clause.contradiction?

  skip_query_cache_if_necessary { connection.select_rows(relation.arel, "#{name} Exists?").size == 1 }
end

#fifthObject

Find the fifth record. If no order is defined it will order by primary key.

Person.fifth # returns the fifth object fetched by SELECT * FROM people
Person.offset(3).fifth # returns the fifth object from OFFSET 3 (which is OFFSET 7)
Person.where(["user_name = :u", { u: user_name }]).fifth


263
264
265
# File 'lib/active_record/relation/finder_methods.rb', line 263

def fifth
  find_nth 4
end

#fifth!Object

Same as #fifth but raises ActiveRecord::RecordNotFound if no record is found.



269
270
271
# File 'lib/active_record/relation/finder_methods.rb', line 269

def fifth!
  fifth || raise_record_not_found_exception!
end

#find(*args) ⇒ Object

Find by id - This can either be a specific id (ID), a list of ids (ID, ID, ID), or an array of ids ([ID, ID, ID]). ‘ID` refers to an “identifier”. For models with a single-column primary key, `ID` will be a single value, and for models with a composite primary key, it will be an array of values. If one or more records cannot be found for the requested ids, then ActiveRecord::RecordNotFound will be raised. If the primary key is an integer, find by id coerces its arguments by 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)

Find a record for a composite primary key model

TravelRoute.primary_key = [:origin, :destination]

TravelRoute.find(["Ottawa", "London"])
=> #<TravelRoute origin: "Ottawa", destination: "London">

TravelRoute.find([["Paris", "Montreal"]])
=> [#<TravelRoute origin: "Paris", destination: "Montreal">]

TravelRoute.find(["New York", "Las Vegas"], ["New York", "Portland"])
=> [
     #<TravelRoute origin: "New York", destination: "Las Vegas">,
     #<TravelRoute origin: "New York", destination: "Portland">
   ]

TravelRoute.find([["Berlin", "London"], ["Barcelona", "Lisbon"]])
=> [
     #<TravelRoute origin: "Berlin", destination: "London">,
     #<TravelRoute origin: "Barcelona", destination: "Lisbon">
   ]

NOTE: The returned records are in the same order as the ids you provide. If you want the results to be sorted by database, you can use ActiveRecord::QueryMethods#where method and provide an explicit ActiveRecord::QueryMethods#order option. But ActiveRecord::QueryMethods#where method doesn’t raise ActiveRecord::RecordNotFound.

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

Variations of #find

Person.where(name: 'Spartacus', rating: 4)
# returns a chainable list (which can be empty).

Person.find_by(name: 'Spartacus', rating: 4)
# returns the first item or nil.

Person.find_or_initialize_by(name: 'Spartacus', rating: 4)
# returns the first item or returns a new instance (requires you call .save to persist against the database).

Person.find_or_create_by(name: 'Spartacus', rating: 4)
# returns the first item or creates it and returns it.

Alternatives for #find

Person.where(name: 'Spartacus', rating: 4).exists?(conditions = :none)
# returns a boolean indicating if any record with the given conditions exist.

Person.where(name: 'Spartacus', rating: 4).select("field1, field2, field3")
# returns a chainable list of instances with only the mentioned fields.

Person.where(name: 'Spartacus', rating: 4).ids
# returns an Array of ids.

Person.where(name: 'Spartacus', rating: 4).pluck(:field1, :field2)
# returns an Array of the required fields.


90
91
92
93
# File 'lib/active_record/relation/finder_methods.rb', line 90

def find(*args)
  return super if block_given?
  find_with_ids(*args)
end

#find_by(arg, *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


103
104
105
# File 'lib/active_record/relation/finder_methods.rb', line 103

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

#find_by!(arg, *args) ⇒ Object

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



109
110
111
# File 'lib/active_record/relation/finder_methods.rb', line 109

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

#find_sole_by(arg, *args) ⇒ Object

Finds the sole matching record. Raises ActiveRecord::RecordNotFound if no record is found. Raises ActiveRecord::SoleRecordExceeded if more than one record is found.

Product.find_sole_by(["price = %?", price])


152
153
154
# File 'lib/active_record/relation/finder_methods.rb', line 152

def find_sole_by(arg, *args)
  where(arg, *args).sole
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 ORDER BY people.id LIMIT 1
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 ORDER BY people.id LIMIT 3


165
166
167
168
169
170
171
# File 'lib/active_record/relation/finder_methods.rb', line 165

def first(limit = nil)
  if limit
    find_nth_with_limit(0, limit)
  else
    find_nth 0
  end
end

#first!Object

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



175
176
177
# File 'lib/active_record/relation/finder_methods.rb', line 175

def first!
  first || raise_record_not_found_exception!
end

#forty_twoObject

Find the forty-second record. Also known as accessing “the reddit”. If no order is defined it will order by primary key.

Person.forty_two # returns the forty-second object fetched by SELECT * FROM people
Person.offset(3).forty_two # returns the forty-second object from OFFSET 3 (which is OFFSET 44)
Person.where(["user_name = :u", { u: user_name }]).forty_two


279
280
281
# File 'lib/active_record/relation/finder_methods.rb', line 279

def forty_two
  find_nth 41
end

#forty_two!Object

Same as #forty_two but raises ActiveRecord::RecordNotFound if no record is found.



285
286
287
# File 'lib/active_record/relation/finder_methods.rb', line 285

def forty_two!
  forty_two || raise_record_not_found_exception!
end

#fourthObject

Find the fourth record. If no order is defined it will order by primary key.

Person.fourth # returns the fourth object fetched by SELECT * FROM people
Person.offset(3).fourth # returns the fourth object from OFFSET 3 (which is OFFSET 6)
Person.where(["user_name = :u", { u: user_name }]).fourth


247
248
249
# File 'lib/active_record/relation/finder_methods.rb', line 247

def fourth
  find_nth 3
end

#fourth!Object

Same as #fourth but raises ActiveRecord::RecordNotFound if no record is found.



253
254
255
# File 'lib/active_record/relation/finder_methods.rb', line 253

def fourth!
  fourth || raise_record_not_found_exception!
end

#include?(record) ⇒ Boolean Also known as: member?

Returns true if the relation contains the given record or false otherwise.

No query is performed if the relation is loaded; the given record is compared to the records in memory. If the relation is unloaded, an efficient existence query is performed, as in #exists?.

Returns:

  • (Boolean)


377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
# File 'lib/active_record/relation/finder_methods.rb', line 377

def include?(record)
  # The existing implementation relies on receiving an Active Record instance as the input parameter named record.
  # Any non-Active Record object passed to this implementation is guaranteed to return `false`.
  return false unless record.is_a?(klass)

  if loaded? || offset_value || limit_value || having_clause.any?
    records.include?(record)
  else
    id = if record.class.composite_primary_key?
      record.class.primary_key.zip(record.id).to_h
    else
      record.id
    end

    exists?(id)
  end
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>]


194
195
196
197
198
199
200
201
# File 'lib/active_record/relation/finder_methods.rb', line 194

def last(limit = nil)
  return find_last(limit) if loaded? || has_limit_or_offset?

  result = ordered_relation.limit(limit)
  result = result.reverse_order!

  limit ? result.reverse : result.first
end

#last!Object

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



205
206
207
# File 'lib/active_record/relation/finder_methods.rb', line 205

def last!
  last || raise_record_not_found_exception!
end

#raise_record_not_found_exception!(ids = nil, result_size = nil, expected_size = nil, key = primary_key, not_found_ids = nil) ⇒ Object

This method is called whenever no records are found with either a single id or multiple ids and raises an 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.



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
# File 'lib/active_record/relation/finder_methods.rb', line 405

def raise_record_not_found_exception!(ids = nil, result_size = nil, expected_size = nil, key = primary_key, not_found_ids = nil) # :nodoc:
  conditions = " [#{arel.where_sql(klass)}]" unless where_clause.empty?

  name = @klass.name

  if ids.nil?
    error = +"Couldn't find #{name}"
    error << " with#{conditions}" if conditions
    raise RecordNotFound.new(error, name, key)
  elsif Array.wrap(ids).size == 1
    error = "Couldn't find #{name} with '#{key}'=#{ids}#{conditions}"
    raise RecordNotFound.new(error, name, key, ids)
  else
    error = +"Couldn't find all #{name.pluralize} with '#{key}': "
    error << "(#{ids.join(", ")})#{conditions} (found #{result_size} results, but was looking for #{expected_size})."
    error << " Couldn't find #{name.pluralize(not_found_ids.size)} with #{key.to_s.pluralize(not_found_ids.size)} #{not_found_ids.join(', ')}." if not_found_ids
    raise RecordNotFound.new(error, name, key, ids)
  end
end

#secondObject

Find the second record. If no order is defined it will order by primary key.

Person.second # returns the second object fetched by SELECT * FROM people
Person.offset(3).second # returns the second object from OFFSET 3 (which is OFFSET 4)
Person.where(["user_name = :u", { u: user_name }]).second


215
216
217
# File 'lib/active_record/relation/finder_methods.rb', line 215

def second
  find_nth 1
end

#second!Object

Same as #second but raises ActiveRecord::RecordNotFound if no record is found.



221
222
223
# File 'lib/active_record/relation/finder_methods.rb', line 221

def second!
  second || raise_record_not_found_exception!
end

#second_to_lastObject

Find the second-to-last record. If no order is defined it will order by primary key.

Person.second_to_last # returns the second-to-last object fetched by SELECT * FROM people
Person.offset(3).second_to_last # returns the second-to-last object from OFFSET 3
Person.where(["user_name = :u", { u: user_name }]).second_to_last


311
312
313
# File 'lib/active_record/relation/finder_methods.rb', line 311

def second_to_last
  find_nth_from_last 2
end

#second_to_last!Object

Same as #second_to_last but raises ActiveRecord::RecordNotFound if no record is found.



317
318
319
# File 'lib/active_record/relation/finder_methods.rb', line 317

def second_to_last!
  second_to_last || raise_record_not_found_exception!
end

#soleObject

Finds the sole matching record. Raises ActiveRecord::RecordNotFound if no record is found. Raises ActiveRecord::SoleRecordExceeded if more than one record is found.

Product.where(["price = %?", price]).sole


135
136
137
138
139
140
141
142
143
144
145
# File 'lib/active_record/relation/finder_methods.rb', line 135

def sole
  found, undesired = first(2)

  if found.nil?
    raise_record_not_found_exception!
  elsif undesired.present?
    raise ActiveRecord::SoleRecordExceeded.new(self)
  else
    found
  end
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


120
121
122
# File 'lib/active_record/relation/finder_methods.rb', line 120

def take(limit = nil)
  limit ? find_take_with_limit(limit) : find_take
end

#take!Object

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



126
127
128
# File 'lib/active_record/relation/finder_methods.rb', line 126

def take!
  take || raise_record_not_found_exception!
end

#thirdObject

Find the third record. If no order is defined it will order by primary key.

Person.third # returns the third object fetched by SELECT * FROM people
Person.offset(3).third # returns the third object from OFFSET 3 (which is OFFSET 5)
Person.where(["user_name = :u", { u: user_name }]).third


231
232
233
# File 'lib/active_record/relation/finder_methods.rb', line 231

def third
  find_nth 2
end

#third!Object

Same as #third but raises ActiveRecord::RecordNotFound if no record is found.



237
238
239
# File 'lib/active_record/relation/finder_methods.rb', line 237

def third!
  third || raise_record_not_found_exception!
end

#third_to_lastObject

Find the third-to-last record. If no order is defined it will order by primary key.

Person.third_to_last # returns the third-to-last object fetched by SELECT * FROM people
Person.offset(3).third_to_last # returns the third-to-last object from OFFSET 3
Person.where(["user_name = :u", { u: user_name }]).third_to_last


295
296
297
# File 'lib/active_record/relation/finder_methods.rb', line 295

def third_to_last
  find_nth_from_last 3
end

#third_to_last!Object

Same as #third_to_last but raises ActiveRecord::RecordNotFound if no record is found.



301
302
303
# File 'lib/active_record/relation/finder_methods.rb', line 301

def third_to_last!
  third_to_last || raise_record_not_found_exception!
end