module ActiveRecord::Calculations

Вычисления Active Record

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

async_average (column_name) Показать исходный код

# File activerecord/lib/active_record/relation/calculations.rb, line 122
def async_average(column_name)
  async.average(column_name)
end

То же, что и average, но запрос выполняется асинхронно, а метод возвращает ActiveRecord::Promise.

async_count (column_name = nil) Показать исходный код

# File activerecord/lib/active_record/relation/calculations.rb, line 108
def async_count(column_name = nil)
  async.count(column_name)
end

То же, что и count, но запрос выполняется асинхронно, а метод возвращает ActiveRecord::Promise.

async_ids () Показать исходный код

# File activerecord/lib/active_record/relation/calculations.rb, line 413
def async_ids
  async.ids
end

То же, что и ids, но запрос выполняется асинхронно, а метод возвращает ActiveRecord::Promise.

async_maximum (column_name) Показать исходный код

# File activerecord/lib/active_record/relation/calculations.rb, line 152
def async_maximum(column_name)
  async.maximum(column_name)
end

То же, что и maximum, но запрос выполняется асинхронно, а метод возвращает ActiveRecord::Promise.

async_minimum (column_name) Показать исходный код

# File activerecord/lib/active_record/relation/calculations.rb, line 137
def async_minimum(column_name)
  async.minimum(column_name)
end

То же, что и minimum, но запрос выполняется асинхронно, а метод возвращает ActiveRecord::Promise.

async_pick (*column_names) Показать исходный код

# File activerecord/lib/active_record/relation/calculations.rb, line 367
def async_pick(*column_names)
  async.pick(*column_names)
end

То же, что и pick, но запрос выполняется асинхронно, а метод возвращает ActiveRecord::Promise.

async_pluck (*column_names) Показать исходный код

# File activerecord/lib/active_record/relation/calculations.rb, line 338
def async_pluck(*column_names)
  async.pluck(*column_names)
end

То же, что и pluck, но запрос выполняется асинхронно, а метод возвращает ActiveRecord::Promise.

async_sum (identity_or_column = nil) Показать исходный код

# File activerecord/lib/active_record/relation/calculations.rb, line 181
def async_sum(identity_or_column = nil)
  async.sum(identity_or_column)
end

То же, что и sum, но запрос выполняется асинхронно, а метод возвращает ActiveRecord::Promise.

average (column_name) Показать исходный код

# File activerecord/lib/active_record/relation/calculations.rb, line 116
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 216
def calculate(operation, column_name)
  operation = operation.to_s.downcase

  if @none
    case operation
    when "count", "sum"
      result = group_values.any? ? Hash.new : 0
      return @async ? Promise::Complete.new(result) : result
    when "average", "minimum", "maximum"
      result = group_values.any? ? Hash.new : nil
      return @async ? Promise::Complete.new(result) : result
    end
  end

  if has_include?(column_name)
    relation = apply_join_dependency

    if operation == "count"
      unless distinct_value || distinct_select?(column_name || select_for_count)
        relation.distinct!
        relation.select_values = Array(model.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 94
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, ключами которого являются массивы с отдельными значениями каждого столбца, а значениями — количество записей для каждого ключа.

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

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

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

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

Если передан блок, он вызывается для каждой записи в отношении, а метод возвращает количество записей, для которых блок возвращает истинное значение.

Person.count { |person| person.age > 21 }
# => counts the number of people older that 21

Если отношение ещё не загружено, вызов count с блоком загрузит все записи отношения. Если записей много, загрузка всех записей может привести к проблемам с производительностью.

Вызывает метод суперкласса

ids () Показать исходный код

# File activerecord/lib/active_record/relation/calculations.rb, line 375
def ids
  primary_key_array = Array(primary_key)

  if loaded?
    result = records.map do |record|
      if primary_key_array.one?
        record._read_attribute(primary_key_array.first)
      else
        primary_key_array.map { |column| record._read_attribute(column) }
      end
    end
    return @async ? Promise::Complete.new(result) : result
  end

  if has_include?(primary_key)
    relation = apply_join_dependency.group(*primary_key_array)
    return relation.ids
  end

  columns = arel_columns(primary_key_array)
  relation = spawn
  relation.select_values = columns

  result = if relation.where_clause.contradiction?
    ActiveRecord::Result.empty
  else
    skip_query_cache_if_necessary do
      model.with_connection do |c|
        c.select_all(relation, "#{model.name} Ids", async: @async)
      end
    end
  end

  result.then { |result| type_cast_pluck_values(result, columns) }
end

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

Person.ids # SELECT people.id FROM people
Person.joins(:company).ids # SELECT people.id FROM people INNER JOIN companies ON companies.id = people.company_id

maximum (column_name) Показать исходный код

# File activerecord/lib/active_record/relation/calculations.rb, line 146
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 131
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 356
def pick(*column_names)
  if loaded? && all_attributes?(column_names)
    result = records.pick(*column_names)
    return @async ? Promise::Complete.new(result) : result
  end

  limit(1).pluck(*column_names).then(&: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 295
def pluck(*column_names)
  if @none
    if @async
      return Promise::Complete.new([])
    else
      return []
    end
  end

  if loaded? && all_attributes?(column_names)
    result = records.pluck(*column_names)
    if @async
      return Promise::Complete.new(result)
    else
      return result
    end
  end

  if has_include?(column_names.first)
    relation = apply_join_dependency
    relation.pluck(*column_names)
  else
    model.disallow_raw_sql!(flattened_args(column_names))
    relation = spawn
    columns = relation.arel_columns(column_names)
    relation.select_values = columns
    result = skip_query_cache_if_necessary do
      if where_clause.contradiction? && !possible_aggregation?(column_names)
        ActiveRecord::Result.empty(async: @async)
      else
        model.with_connection do |c|
          c.select_all(relation.arel, "#{model.name} Pluck", async: @async)
        end
      end
    end
    result.then do |result|
      type_cast_pluck_values(result, columns)
    end
  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]

Comment.joins(:person).pluck(:id, person: :id)
# SELECT comments.id, person.id FROM comments INNER JOIN people person ON person.id = comments.person_id
# => [[1, 2], [2, 2]]

Comment.joins(:person).pluck(:id, person: [:id, :name])
# SELECT comments.id, person.id, person.name FROM comments INNER JOIN people person ON person.id = comments.person_id
# => [[1, 2, 'David'], [2, 2, 'David']]

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

Обратите внимание: pluck игнорирует все предыдущие условия выборки

Person.select(:name).pluck(:id)
# SELECT people.id FROM people

См. также ids.

sum (initial_value_or_column = 0, &block) Показать исходный код

# File activerecord/lib/active_record/relation/calculations.rb, line 171
def sum(initial_value_or_column = 0, &block)
  if block_given?
    map(&block).sum(initial_value_or_column)
  else
    calculate(:sum, initial_value_or_column)
  end
end

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

Person.sum(:age) # => 4562

Если передан блок, он вызывается для каждой записи в отношении, а метод возвращает сумму initial_value_or_column и значений, возвращённых блоком:

Person.sum { |person| person.age } # => 4562
Person.sum(1000) { |person| person.age } # => 5562

Если отношение ещё не загружено, вызов sum с блоком загрузит все записи отношения. Если записей много, загрузка всех записей может привести к проблемам с производительностью.

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

aggregate_column (column_name) Показать исходный код

# File activerecord/lib/active_record/relation/calculations.rb, line 418
def aggregate_column(column_name)
  case column_name
  when Arel::Expressions
    column_name
  when :all
    Arel.star
  else
    arel_column(column_name.to_s)
  end
end