модуль ActiveRecord::FinderMethods
Константы
- ONE_AS_ONE
Публичные методы экземпляров
# File activerecord/lib/active_record/relation/finder_methods.rb, line 305
def exists?(conditions = :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)
skip_query_cache_if_necessary { connection.select_value(relation.arel, "#{name} Exists") } ? true : false
rescue ::RangeError
false
end Возвращает 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?
Person.where(name: 'Spartacus', rating: 4).exists?
# File activerecord/lib/active_record/relation/finder_methods.rb, line 219 def fifth find_nth 4 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 225 def fifth! fifth || raise_record_not_found_exception! end
То же, что и fifth, но генерирует исключение ActiveRecord::RecordNotFound, если запись не найдена.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 67 def find(*args) return super if block_given? find_with_ids(*args) end
Поиск по идентификатору — это может быть конкретный идентификатор (1), список идентификаторов (1, 5, 6) или массив идентификаторов ([5, 6, 10]). Если для запрошенных идентификаторов одна или несколько записей не найдены, будет сгенерировано исключение RecordNotFound. Если первичный ключ является целым числом, поиск по идентификатору выполняет приведение аргументов с использованием 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::QueryMethods#where и указать явное значение ActiveRecord::QueryMethods#order. Но метод ActiveRecord::QueryMethods#where не генерирует исключение ActiveRecord::RecordNotFound.
Поиск с блокировкой
Пример поиска с блокировкой: Представьте два одновременных транзакции: каждый из них прочитает 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
Вариации 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.
Альтернативы 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.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 80 def find_by(arg, *args) where(arg, *args).take rescue ::RangeError nil 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 88
def find_by!(arg, *args)
where(arg, *args).take!
rescue ::RangeError
raise RecordNotFound.new("Couldn't find #{@klass.name} with an out of range value",
@klass.name, @klass.primary_key)
end Аналогично find_by, за исключением того, что если запись не найдена, генерируется ошибка ActiveRecord::RecordNotFound.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 121
def first(limit = nil)
if limit
find_nth_with_limit(0, limit)
else
find_nth 0
end
end Находит первую запись (или первые N записей, если параметр указан). Если порядок не определён, будет использован порядок по первичному ключу.
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
# File activerecord/lib/active_record/relation/finder_methods.rb, line 131 def first! first || raise_record_not_found_exception! end
То же, что и first, но генерирует исключение ActiveRecord::RecordNotFound, если запись не найдена. Обратите внимание, что first! не принимает аргументов.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 235 def forty_two find_nth 41 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 241 def forty_two! forty_two || raise_record_not_found_exception! end
То же, что и forty_two, но генерирует исключение ActiveRecord::RecordNotFound, если запись не найдена.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 203 def fourth find_nth 3 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 209 def fourth! fourth || raise_record_not_found_exception! end
То же, что и fourth, но генерирует исключение ActiveRecord::RecordNotFound, если запись не найдена.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 150 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
Находит последнюю запись (или последние 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 161 def last! last || raise_record_not_found_exception! end
То же, что и last, но генерирует исключение ActiveRecord::RecordNotFound, если запись не найдена. Обратите внимание, что last! не принимает аргументов.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 171 def second find_nth 1 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 177 def second! second || raise_record_not_found_exception! end
То же, что и second, но генерирует исключение ActiveRecord::RecordNotFound, если запись не найдена.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 267 def second_to_last find_nth_from_last 2 end
Находит предпоследнюю запись. Если порядок не определён, будет использован порядок по первичному ключу.
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
# File activerecord/lib/active_record/relation/finder_methods.rb, line 273 def second_to_last! second_to_last || raise_record_not_found_exception! end
Аналогично second_to_last, но вызывает ActiveRecord::RecordNotFound, если запись не найдена.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 102 def take(limit = nil) limit ? find_take_with_limit(limit) : find_take 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 108 def take! take || raise_record_not_found_exception! end
Аналогично take, но вызывает ActiveRecord::RecordNotFound, если запись не найдена. Обратите внимание, что take! не принимает аргументов.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 187 def third find_nth 2 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 193 def third! third || raise_record_not_found_exception! end
Аналогично third, но вызывает ActiveRecord::RecordNotFound, если запись не найдена.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 251 def third_to_last find_nth_from_last 3 end
Находит запись, предшествующую последней на две позиции. Если порядок не определён, он будет определён по первичному ключу.
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
# File activerecord/lib/active_record/relation/finder_methods.rb, line 257 def third_to_last! third_to_last || raise_record_not_found_exception! end
Аналогично third_to_last, но вызывает ActiveRecord::RecordNotFound, если запись не найдена.
© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.