Spec-Zone.ru › Ruby on Rails 6.1

модуль ActiveRecord::Calculations

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

average(column_name) Показать исходный код
# File activerecord/lib/active_record/relation/calculations.rb, line 59
def average(column_name)
  calculate(:average, column_name)
end

Вычисляет среднее значение заданного столбца. Возвращает nil при отсутствии строк. Смотрите calculate для примеров с опциями.

Person.average(:age) # => 35.8
calculate(operation, column_name) Показать исходный код
# File activerecord/lib/active_record/relation/calculations.rb, line 129
def calculate(operation, column_name)
  if has_include?(column_name)
    relation = apply_join_dependency

    if operation.to_s.downcase == "count"
      unless distinct_value || distinct_select?(column_name || select_for_count)
        relation.distinct!
        relation.select_values = [ klass.primary_key || table[Arel.star] ]
      end
      # PostgreSQL: ORDER BY expressions must appear in SELECT list when using DISTINCT
      relation.order_values = [] if group_values.empty?
    end

    relation.calculate(operation, column_name)
  else
    perform_calculation(operation, column_name)
  end
end

Вычисляет агрегированные значения в заданном столбце. Методы для count, sum, average, minimum и maximum добавлены в качестве сокращений.

Person.calculate(:count, :all) # The same as Person.count
Person.average(:age) # SELECT AVG(age) FROM people...

# Selects the minimum age for any family without any minors
Person.group(:last_name).having("min(age) > 17").minimum(:age)

Person.sum("2 * age")

Существует две основные формы вывода:

  • Единое агрегированное значение: Единственное значение приводится к типу Integer для COUNT, Float для AVG и типу заданного столбца для всего остального.

  • Группированные значения: Возвращает упорядоченный массив значений, сгруппированных по ним. Используется либо имя столбца, либо имя ассоциации belongs_to.

    values = Person.group('last_name').maximum(:age)
    puts values["Drake"]
    # => 43
    
    drake  = Family.find_by(last_name: 'Drake')
    values = Person.group(:family).maximum(:age) # Person belongs_to :family
    puts values[drake]
    # => 43
    
    values.each do |family, max_age|
      ...
    end
count(column_name = nil) Показать исходный код
# File activerecord/lib/active_record/relation/calculations.rb, line 43
def count(column_name = nil)
  if block_given?
    unless column_name.nil?
      raise ArgumentError, "Column name argument is not supported when a block is passed."
    end

    super()
  else
    calculate(:count, column_name)
  end
end

Подсчитать записи.

Person.count
# => the total count of all people

Person.count(:age)
# => returns the total count of all people whose age is present in database

Person.count(:all)
# => performs a COUNT(*) (:all is an alias for '*')

Person.distinct.count(:age)
# => counts the number of different age values

Если count используется с Relation#group, возвращается Hash, ключи которого представляют агрегированный столбец, а значения — соответствующие количества:

Person.group(:city).count
# => { 'Rome' => 5, 'Paris' => 3 }

Если count используется с Relation#group для нескольких столбцов, возвращается Hash, ключи которого представляют собой массив, содержащий отдельные значения каждого столбца, а значение каждого ключа — count.

Article.group(:status, :category).count
# =>  {["draft", "business"]=>10, ["draft", "technology"]=>4,
       ["published", "business"]=>0, ["published", "technology"]=>2}

Если count используется с Relation#select, он подсчитывает выбранные столбцы:

Person.select(:age).count
# => counts the number of different age values

Примечание: не все допустимые выражения Relation#select являются допустимыми выражениями count. Подробности зависят от базы данных. В недопустимых случаях выбрасывается ошибка базы данных.

Вызывает метод суперкласса
ids() Показать исходный код
# File activerecord/lib/active_record/relation/calculations.rb, line 233
def ids
  pluck primary_key
end

Извлечь все ID для отношения, используя первичный ключ таблицы

Person.ids # SELECT people.id FROM people
Person.joins(:companies).ids # SELECT people.id FROM people INNER JOIN companies ON companies.person_id = people.id
maximum(column_name) Показать исходный код
# File activerecord/lib/active_record/relation/calculations.rb, line 77
def maximum(column_name)
  calculate(:maximum, column_name)
end

Вычисляет максимальное значение в заданном столбце. Значение возвращается с тем же типом данных, что и столбец, или nil при отсутствии строк. Смотрите calculate для примеров с опциями.

Person.maximum(:age) # => 93
minimum(column_name) Показать исходный код
# File activerecord/lib/active_record/relation/calculations.rb, line 68
def minimum(column_name)
  calculate(:minimum, column_name)
end

Вычисляет минимальное значение в заданном столбце. Значение возвращается с тем же типом данных, что и столбец, или nil при отсутствии строк. Смотрите calculate для примеров с опциями.

Person.minimum(:age) # => 7
pick(*column_names) Показать исходный код
# File activerecord/lib/active_record/relation/calculations.rb, line 221
def pick(*column_names)
  if loaded? && all_attributes?(column_names)
    return records.pick(*column_names)
  end

  limit(1).pluck(*column_names).first
end

Выбрать значение(я) из указанного(ых) столбца(ов) в текущем отношении. Это сокращение для relation.limit(1).pluck(*column_names).first, и оно преимущественно полезно, когда отношение уже сужено до одной строки.

Как и pluck, pick загружает только фактическое значение, а не весь объект записи, поэтому он также более эффективен. Значение, как и в случае с pluck, приводится к типу столбца.

Person.where(id: 1).pick(:name)
# SELECT people.name FROM people WHERE id = 1 LIMIT 1
# => 'David'

Person.where(id: 1).pick(:name, :email_address)
# SELECT people.name, people.email_address FROM people WHERE id = 1 LIMIT 1
# => [ 'David', 'david@loudthinking.com' ]
pluck(*column_names) Показать исходный код
# File activerecord/lib/active_record/relation/calculations.rb, line 183
def pluck(*column_names)
  if loaded? && all_attributes?(column_names)
    return records.pluck(*column_names)
  end

  if has_include?(column_names.first)
    relation = apply_join_dependency
    relation.pluck(*column_names)
  else
    klass.disallow_raw_sql!(column_names)
    columns = arel_columns(column_names)
    relation = spawn
    relation.select_values = columns
    result = skip_query_cache_if_necessary do
      if where_clause.contradiction?
        ActiveRecord::Result.new([], [])
      else
        klass.connection.select_all(relation.arel, nil)
      end
    end
    type_cast_pluck_values(result, columns)
  end
end

Используйте pluck в качестве сокращения для выбора одного или нескольких атрибутов без загрузки множества записей только для получения нужных атрибутов.

Person.pluck(:name)

вместо

Person.all.map(&:name)

Pluck возвращает Array значений атрибутов, приведенных к типу, соответствующему именам выбранных столбцов, если их можно определить. Выбор фрагмента SQL по умолчанию возвращает значения String.

Person.pluck(:name)
# SELECT people.name FROM people
# => ['David', 'Jeremy', 'Jose']

Person.pluck(:id, :name)
# SELECT people.id, people.name FROM people
# => [[1, 'David'], [2, 'Jeremy'], [3, 'Jose']]

Person.distinct.pluck(:role)
# SELECT DISTINCT role FROM people
# => ['admin', 'member', 'guest']

Person.where(age: 21).limit(5).pluck(:id)
# SELECT people.id FROM people WHERE people.age = 21 LIMIT 5
# => [2, 3]

Person.pluck(Arel.sql('DATEDIFF(updated_at, created_at)'))
# SELECT DATEDIFF(updated_at, created_at) FROM people
# => ['0', '27761', '173']

См. также ids.

sum(column_name = nil) Показать исходный код
# File activerecord/lib/active_record/relation/calculations.rb, line 86
def sum(column_name = nil)
  if block_given?
    unless column_name.nil?
      raise ArgumentError, "Column name argument is not supported when a block is passed."
    end

    super()
  else
    calculate(:sum, column_name)
  end
end

Вычисляет сумму значений в заданном столбце. Значение возвращается с тем же типом данных, что и столбец, 0 при отсутствии строк. Смотрите calculate для примеров с опциями.

Person.sum(:age) # => 4562
Вызывает метод суперкласса

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

Spec-Zone.ru

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