модуль ActiveRecord::FinderMethods

Возвращает true, если в таблице существует запись, соответствующая указанным id или условиям, или false в противном случае. Аргумент может иметь шесть форм:

• Целое число - Находит запись с этим первичным ключом.

• Строка - Находит запись с первичным ключом, соответствующим этой строке (например, '5').

• Массив - Находит запись, соответствующую этим условиям в формате find (например, ['name LIKE ?', "%#{query}%"]).

• Хэш - Находит запись, соответствующую этим условиям в формате find (например, {name: 'David'}).

• false - Всегда возвращает false.

• Без аргументов - Возвращает false, если таблица пуста, true в противном случае.

Дополнительную информацию об указании условий в виде хэша или массива см. в разделе «Условия» в начале документации ActiveRecord::Base.

Примечание: Вы не можете передавать условие в виде строки (например, name = 'Jamie'), так как оно будет очищено и затем проверено на соответствие столбцу первичного ключа, как 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?

# File activerecord/lib/active_record/relation/finder_methods.rb, line 282
def exists?(conditions = :none)
  conditions = conditions.id if Base === conditions
  return false if !conditions

  relation = apply_join_dependency(self, construct_join_dependency)
  return false if ActiveRecord::NullRelation === relation

  relation = relation.except(:select, :order).select(ONE_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
end

Находит пятую запись. Если порядок не определён, он будет упорядочен по первичному ключу.

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

# File activerecord/lib/active_record/relation/finder_methods.rb, line 229
def fifth
  find_nth(:fifth, offset_value ? offset_value + 4 : 4)
end

То же, что и fifth, но генерирует ошибку ActiveRecord::RecordNotFound, если запись не найдена.

# File activerecord/lib/active_record/relation/finder_methods.rb, line 235
def fifth!
  fifth or raise RecordNotFound
end

Поиск по id - Это может быть конкретный id (1), список id (1, 5, 6) или массив id ([5, 6, 10]). Если для всех перечисленных id не найдено ни одной записи, то будет возбуждено исключение RecordNotFound. Если первичный ключ является целым числом, find по id использует преобразование 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)

ActiveRecord::RecordNotFound будет возбуждено, если один или несколько id не найдены.

ПРИМЕЧАНИЕ: Возвращаемые записи могут не быть в том же порядке, что и предоставленные id, так как строки базы данных неупорядочены. Вам нужно указать явный order параметр, если вы хотите отсортировать результаты.

Поиск с блокировкой

Пример поиска с блокировкой: Представьте две параллельные транзакции: каждая из них прочитает person.visits == 2, добавит 1 к нему и сохранит, что приведёт к двум сохранениям person.visits = 3. Блокируя строку, второй транзакции придётся подождать завершения первой; мы получаем ожидаемое значение person.visits == 4.

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

Вариации поиска

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.where(name: 'Spartacus', rating: 4).first_or_initialize
# returns the first item or returns a new instance (requires you call .save to persist against the database).

Person.where(name: 'Spartacus', rating: 4).first_or_create
# returns the first item or creates it and returns it, available since Rails 3.2.1.

Альтернативы поиску

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, available since Rails 3.2.1.

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

# File activerecord/lib/active_record/relation/finder_methods.rb, line 64
def find(*args)
  if block_given?
    to_a.find(*args) { |*block_args| yield(*block_args) }
  else
    find_with_ids(*args)
  end
end

Находит первую запись, соответствующую указанным условиям. Нет неявного упорядочивания, поэтому, если порядок важен, вам следует указать его.

Если запись не найдена, возвращает nil.

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

# File activerecord/lib/active_record/relation/finder_methods.rb, line 80
def find_by(*args)
  where(*args).take
end

Аналогично find_by, за исключением того, что если запись не найдена, генерируется ошибка ActiveRecord::RecordNotFound.

# File activerecord/lib/active_record/relation/finder_methods.rb, line 86
def find_by!(*args)
  where(*args).take!
end

Находит первую запись (или первые N записей, если параметр указан). Если порядок не определён, он будет упорядочен по первичному ключу.

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

Rails 3

Person.first # SELECT "people".* FROM "people" LIMIT 1

ПРИМЕЧАНИЕ: В Rails 3 данное запросы может не упорядочиваться по первичному ключу, и порядок будет зависеть от реализации базы данных. Чтобы гарантировать это поведение, используйте User.order(:id).first.

Rails 4

Person.first # SELECT "people".* FROM "people" ORDER BY "people"."id" ASC LIMIT 1

# File activerecord/lib/active_record/relation/finder_methods.rb, line 128
def first(limit = nil)
  if limit
    find_nth_with_limit(offset_value, limit)
  else
    find_nth(:first, offset_value)
  end
end

Аналогично first , но генерирует ошибку ActiveRecord::RecordNotFound если запись не найдена. Обратите внимание, что first! не принимает аргументов.

# File activerecord/lib/active_record/relation/finder_methods.rb, line 138
def first!
  first or raise RecordNotFound
end

Находит сорок вторую запись. Также известен как доступ к «reddit». Если порядок не определён, он будет упорядочен по первичному ключу.

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

# File activerecord/lib/active_record/relation/finder_methods.rb, line 245
def forty_two
  find_nth(:forty_two, offset_value ? offset_value + 41 : 41)
end

То же, что и forty_two , но генерирует ошибку ActiveRecord::RecordNotFound если запись не найдена.

# File activerecord/lib/active_record/relation/finder_methods.rb, line 251
def forty_two!
  forty_two or raise RecordNotFound
end

Находит четвёртую запись. Если порядок не определён, он будет упорядочен по первичному ключу.

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

# File activerecord/lib/active_record/relation/finder_methods.rb, line 213
def fourth
  find_nth(:fourth, offset_value ? offset_value + 3 : 3)
end

То же, что и fourth , но генерирует ошибку ActiveRecord::RecordNotFound если запись не найдена.

# File activerecord/lib/active_record/relation/finder_methods.rb, line 219
def fourth!
  fourth or raise RecordNotFound
end

Находит последнюю запись (или последние N записей, если указан параметр). Если порядок не определён, он будет упорядочен по первичному ключу.

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.

Обратите внимание, что в последнем случае результаты отсортированы по возрастанию:

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

а не:

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

# File activerecord/lib/active_record/relation/finder_methods.rb, line 157
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 , но генерирует ошибку ActiveRecord::RecordNotFound если запись не найдена. Обратите внимание, что last! не принимает аргументов.

# File activerecord/lib/active_record/relation/finder_methods.rb, line 171
def last!
  last or raise RecordNotFound
end

Находит вторую запись. Если порядок не определён, он будет упорядочен по первичному ключу.

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

# File activerecord/lib/active_record/relation/finder_methods.rb, line 181
def second
  find_nth(:second, offset_value ? offset_value + 1 : 1)
end

То же, что и second , но генерирует ошибку ActiveRecord::RecordNotFound если запись не найдена.

# File activerecord/lib/active_record/relation/finder_methods.rb, line 187
def second!
  second or raise RecordNotFound
end

Возвращает запись (или N записей, если указан параметр) без неявного порядка. Порядок будет зависеть от реализации базы данных. Если порядок задан, он будет соблюден.

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

# File activerecord/lib/active_record/relation/finder_methods.rb, line 97
def take(limit = nil)
  limit ? limit(limit).to_a : find_take
end

То же, что и take , но генерирует ошибку ActiveRecord::RecordNotFound если запись не найдена. Обратите внимание, что take! не принимает аргументов.

# File activerecord/lib/active_record/relation/finder_methods.rb, line 103
def take!
  take or raise RecordNotFound
end

Найти третью запись. Если порядок не определён, будет использован порядок по первичному ключу.

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

# File activerecord/lib/active_record/relation/finder_methods.rb, line 197
def third
  find_nth(:third, offset_value ? offset_value + 2 : 2)
end

То же, что и third, но генерирует ActiveRecord::RecordNotFound, если запись не найдена.

# File activerecord/lib/active_record/relation/finder_methods.rb, line 203
def third!
  third or raise RecordNotFound
end