модуль ActiveRecord::FinderMethods
Константы
- ONE_AS_ONE
Общедоступные методы экземпляров
# File activerecord/lib/active_record/relation/finder_methods.rb, line 357
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 do
with_connection do |c|
c.select_rows(relation.arel, "#{name} Exists?").size == 1
end
end
end Возвращает true, если в таблице существует запись, соответствующая заданным id или условиям, и false в противном случае. Аргумент может иметь шесть форм:
-
Integer- Находит запись с этим первичным ключом. -
String- Находит запись с первичным ключом, соответствующим этой строке (например,'5'). -
Array- Находит запись, соответствующую этим условиям в стилеwhere(например,['name LIKE ?', "%#{query}%"]). -
Hash- Находит запись, соответствующую этим условиям в стилеwhere(например,{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 271 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 277 def fifth! fifth || raise_record_not_found_exception! end
Аналогично fifth, но вызывает ActiveRecord::RecordNotFound, если запись не найдена.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 98 def find(*args) return super if block_given? find_with_ids(*args) end
Нахождение по ID - Это может быть конкретный идентификатор (ID), список идентификаторов (ID, ID, ID) или массив идентификаторов ([ID, ID, ID]). «ID» относится к «идентификатору». Для моделей с одностолбцовым первичным ключом `ID` будет одним значением, а для моделей с составным первичным ключом - массивом значений. Если для запрошенных идентификаторов одна или несколько записей не найдены, то будет вызвано исключение ActiveRecord::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), or with composite primary key [7, 17]
Person.find([1]) # returns an array for the object with ID = 1
Person.where("administrator = 1").order("created_on DESC").find(1)
Поиск записи для модели с составным первичным ключом
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">
] ПРИМЕЧАНИЕ: возвращаемые записи находятся в том же порядке, что и предоставленные вами идентификаторы. Если вы хотите, чтобы результаты были отсортированы по базе данных, вы можете использовать метод 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.
Краевые случаи
Person.find(37) # raises ActiveRecord::RecordNotFound exception if the record with the given ID does not exist. Person.find([37]) # raises ActiveRecord::RecordNotFound exception if the record with the given ID in the input array does not exist. Person.find(nil) # raises ActiveRecord::RecordNotFound exception if the argument is nil. Person.find([]) # returns an empty array if the argument is an empty array. Person.find # raises ActiveRecord::RecordNotFound exception if the argument is not provided.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 111 def find_by(arg, *args) where(arg, *args).take 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 117 def find_by!(arg, *args) where(arg, *args).take! end
Как find_by, за исключением того, что если запись не найдена, генерирует ошибку ActiveRecord::RecordNotFound.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 160 def find_sole_by(arg, *args) where(arg, *args).sole end
Находит единственную соответствующую запись. Вызывает ActiveRecord::RecordNotFound, если запись не найдена. Вызывает ActiveRecord::SoleRecordExceeded, если найдено более одной записи.
Product.find_sole_by(["price = %?", price])
# File activerecord/lib/active_record/relation/finder_methods.rb, line 173
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 183 def first! first || raise_record_not_found_exception! end
Аналогично first, но вызывает ActiveRecord::RecordNotFound, если запись не найдена. Обратите внимание, что first! не принимает аргументов.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 287 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 293 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 255 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 261 def fourth! fourth || raise_record_not_found_exception! end
Аналогично fourth, но вызывает ActiveRecord::RecordNotFound, если запись не найдена.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 389
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 Возвращает true, если отношение содержит заданную запись, или false в противном случае.
Если отношение загружено, запрос не выполняется; заданная запись сравнивается со записями в памяти. Если отношение не загружено, выполняется эффективный запрос на существование, как в exists?.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 202 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 213 def last! last || raise_record_not_found_exception! end
То же, что и last, но генерирует исключение ActiveRecord::RecordNotFound, если запись не найдена. Обратите внимание, что last! не принимает аргументов.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 223 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 229 def second! second || raise_record_not_found_exception! end
То же, что и second, но генерирует исключение ActiveRecord::RecordNotFound, если запись не найдена.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 319 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 325 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 143
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 Находит единственную соответствующую запись. Генерирует исключение ActiveRecord::RecordNotFound, если запись не найдена. Генерирует исключение ActiveRecord::SoleRecordExceeded, если найдено более одной записи.
Product.where(["price = %?", price]).sole
# File activerecord/lib/active_record/relation/finder_methods.rb, line 128 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 134 def take! take || raise_record_not_found_exception! end
То же, что и take, но генерирует исключение ActiveRecord::RecordNotFound, если запись не найдена. Обратите внимание, что take! не принимает аргументов.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 239 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 245 def third! third || raise_record_not_found_exception! end
То же, что и third, но генерирует исключение ActiveRecord::RecordNotFound, если запись не найдена.
# File activerecord/lib/active_record/relation/finder_methods.rb, line 303 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 309 def third_to_last! third_to_last || raise_record_not_found_exception! end
То же, что и third_to_last, но генерирует исключение ActiveRecord::RecordNotFound, если запись не найдена.
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.