Spec-Zone.ru › Ruby on Rails 5.0

модуль ActiveRecord::FinderMethods

Константы

ONE_AS_ONE

Открытые методы экземпляров

exists?(conditions = :none) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 310
    def exists?(conditions = :none)
      if Base === conditions
        conditions = conditions.id
        ActiveSupport::Deprecation.warn("          You are passing an instance of ActiveRecord::Base to `exists?`.
          Please pass the id of the object by calling `.id`.
".squish)
      end

      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
        unless conditions == :none
          relation = relation.where(primary_key => conditions)
        end
      end

      connection.select_value(relation, "#{name} Exists", relation.bound_attributes) ? true : 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?
fifth() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 225
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
fifth!() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 231
def fifth!
  find_nth! 4
end

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

find(*args) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 64
def find(*args)
  return super if block_given?
  find_with_ids(*args)
end

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

ПРИМЕЧАНИЕ: возвращаемые записи могут не быть в том же порядке, что и предоставленные вами ID, так как строки базы данных неупорядочены. Вам нужно указать явный параметр ActiveRecord::QueryMethods#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

Разновидности 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.
Вызывает метод суперкласса
find_by(arg, *args) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 77
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
find_by!(arg, *args) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 85
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)
end

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

first(limit = nil) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 118
def first(limit = nil)
  if limit
    find_nth_with_limit_and_offset(0, limit, offset: offset_index)
  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
first!() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 128
def first!
  find_nth! 0
end

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

forty_two() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 241
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
forty_two!() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 247
def forty_two!
  find_nth! 41
end

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

fourth() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 209
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
fourth!() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 215
def fourth!
  find_nth! 3
end

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

last(limit = nil) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 147
    def last(limit = nil)
      return find_last(limit) if loaded? || limit_value

      result = limit(limit || 1)
      result.order!(arel_attribute(primary_key)) if order_values.empty? && primary_key
      result = result.reverse_order!

      limit ? result.reverse : result.first
    rescue ActiveRecord::IrreversibleOrderError
      ActiveSupport::Deprecation.warn("          Finding a last element by loading the relation when SQL ORDER
          can not be reversed is deprecated.
          Rails 5.1 will raise ActiveRecord::IrreversibleOrderError in this case.
          Please call `to_a.last` if you still want to load the relation.
".squish)
      find_last(limit)
    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>]
last!() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 167
def last!
  last or raise RecordNotFound.new("Couldn't find #{@klass.name} with [#{arel.where_sql(@klass.arel_engine)}]")
end

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

second() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 177
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
second!() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 183
def second!
  find_nth! 1
end

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

second_to_last() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 273
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
END_OF_DOCUMENT_MARKER
second_to_last!() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 279
def second_to_last!
  find_nth_from_last 2 or raise RecordNotFound.new("Couldn't find #{@klass.name} with [#{arel.where_sql(@klass.arel_engine)}]")
end

То же, что и second_to_last, но вызывает ActiveRecord::RecordNotFound, если запись не найдена.

take(limit = nil) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 99
def take(limit = nil)
  limit ? limit(limit).to_a : 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
take!() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 105
def take!
  take or raise RecordNotFound.new("Couldn't find #{@klass.name} with [#{arel.where_sql(@klass.arel_engine)}]")
end

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

third() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 193
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
third!() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 199
def third!
  find_nth! 2
end

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

third_to_last() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 257
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
third_to_last!() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 263
def third_to_last!
  find_nth_from_last 3 or raise RecordNotFound.new("Couldn't find #{@klass.name} with [#{arel.where_sql(@klass.arel_engine)}]")
end

То же, что и third_to_last, но вызывает ActiveRecord::RecordNotFound, если запись не найдена.

Защищенные методы экземпляров

find_nth(index, offset = nil) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 531
    def find_nth(index, offset = nil)
      # TODO: once the offset argument is removed we rely on offset_index
      # within find_nth_with_limit, rather than pass it in via
      # find_nth_with_limit_and_offset
      if offset
        ActiveSupport::Deprecation.warn("          Passing an offset argument to find_nth is deprecated,
          please use Relation#offset instead.
".squish)
      end
      if loaded?
        records[index]
      else
        offset ||= offset_index
        @offsets[offset + index] ||= find_nth_with_limit_and_offset(index, 1, offset: offset).first
      end
    end
find_nth!(index) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 549
def find_nth!(index)
  find_nth(index) or raise RecordNotFound.new("Couldn't find #{@klass.name} with [#{arel.where_sql(@klass.arel_engine)}]")
end
find_nth_from_last(index) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 566
def find_nth_from_last(index)
  if loaded?
    records[-index]
  else
    relation = if order_values.empty? && primary_key
                 order(arel_attribute(primary_key).asc)
               else
                 self
               end

    relation.to_a[-index]
    # TODO: can be made more performant on large result sets by
    # for instance, last(index)[-index] (which would require
    # refactoring the last(n) finder method to make test suite pass),
    # or by using a combination of reverse_order, limit, and offset,
    # e.g., reverse_order.offset(index-1).first
  end
end
find_nth_with_limit(index, limit) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 553
def find_nth_with_limit(index, limit)
  # TODO: once the offset argument is removed from find_nth,
  # find_nth_with_limit_and_offset can be merged into this method
  relation = if order_values.empty? && primary_key
               order(arel_attribute(primary_key).asc)
             else
               self
             end

  relation = relation.offset(index) unless index.zero?
  relation.limit(limit).to_a
end
find_one(id) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 467
    def find_one(id)
      if ActiveRecord::Base === id
        id = id.id
        ActiveSupport::Deprecation.warn("          You are passing an instance of ActiveRecord::Base to `find`.
          Please pass the id of the object by calling `.id`.
".squish)
      end

      relation = where(primary_key => id)
      record = relation.take

      raise_record_not_found_exception!(id, 0, 1) unless record

      record
    end
find_some(ids) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 484
def find_some(ids)
  return find_some_ordered(ids) unless order_values.present?

  result = where(primary_key => ids).to_a

  expected_size =
    if limit_value && ids.size > limit_value
      limit_value
    else
      ids.size
    end

  # 11 ids with limit 3, offset 9 should give 2 results.
  if offset_value && (ids.size - offset_value < expected_size)
    expected_size = ids.size - offset_value
  end

  if result.size == expected_size
    result
  else
    raise_record_not_found_exception!(ids, result.size, expected_size)
  end
end
find_some_ordered(ids) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 508
def find_some_ordered(ids)
  ids = ids.slice(offset_value || 0, limit_value || ids.size) || []

  result = except(:limit, :offset).where(primary_key => ids).records

  if result.size == ids.size
    pk_type = @klass.type_for_attribute(primary_key)

    records_by_id = result.index_by(&:id)
    ids.map { |id| records_by_id.fetch(pk_type.cast(id)) }
  else
    raise_record_not_found_exception!(ids, result.size, ids.size)
  end
end
find_take() Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 523
def find_take
  if loaded?
    records.first
  else
    @take ||= limit(1).records.first
  end
end
find_with_ids(*ids) Показать исходный код
# File activerecord/lib/active_record/relation/finder_methods.rb, line 446
def find_with_ids(*ids)
  raise UnknownPrimaryKey.new(@klass) if primary_key.nil?

  expects_array = ids.first.kind_of?(Array)
  return ids.first if expects_array && ids.first.empty?

  ids = ids.flatten.compact.uniq

  case ids.size
  when 0
    raise RecordNotFound, "Couldn't find #{@klass.name} without an ID"
  when 1
    result = find_one(ids.first)
    expects_array ? [ result ] : result
  else
    find_some(ids)
  end
rescue RangeError
  raise RecordNotFound, "Couldn't find #{@klass.name} with an out of range ID"
end

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API