mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
25cee1f037
`in_batches` yields Relation objects if a block is given, otherwise it
returns an instance of `BatchEnumerator`. The existing `find_each` and
`find_in_batches` methods work with batches of records. The new API
allows working with relation batches as well.
Examples:
Person.in_batches.each_record(&:party_all_night!)
Person.in_batches.update_all(awesome: true)
Person.in_batches.delete_all
Person.in_batches.map do |relation|
relation.delete_all
sleep 10 # Throttles the delete queries
end
69 lines
3.7 KiB
Ruby
69 lines
3.7 KiB
Ruby
module ActiveRecord
|
|
module Querying
|
|
delegate :find, :take, :take!, :first, :first!, :last, :last!, :exists?, :any?, :many?, to: :all
|
|
delegate :second, :second!, :third, :third!, :fourth, :fourth!, :fifth, :fifth!, :forty_two, :forty_two!, to: :all
|
|
delegate :first_or_create, :first_or_create!, :first_or_initialize, to: :all
|
|
delegate :find_or_create_by, :find_or_create_by!, :find_or_initialize_by, to: :all
|
|
delegate :find_by, :find_by!, to: :all
|
|
delegate :destroy, :destroy_all, :delete, :delete_all, :update, :update_all, to: :all
|
|
delegate :find_each, :find_in_batches, :in_batches, to: :all
|
|
delegate :select, :group, :order, :except, :reorder, :limit, :offset, :joins, :or,
|
|
:where, :rewhere, :preload, :eager_load, :includes, :from, :lock, :readonly,
|
|
:having, :create_with, :uniq, :distinct, :references, :none, :unscope, to: :all
|
|
delegate :count, :average, :minimum, :maximum, :sum, :calculate, to: :all
|
|
delegate :pluck, :ids, to: :all
|
|
|
|
# Executes a custom SQL query against your database and returns all the results. The results will
|
|
# be returned as an array with columns requested encapsulated as attributes of the model you call
|
|
# this method from. If you call <tt>Product.find_by_sql</tt> then the results will be returned in
|
|
# a +Product+ object with the attributes you specified in the SQL query.
|
|
#
|
|
# If you call a complicated SQL query which spans multiple tables the columns specified by the
|
|
# SELECT will be attributes of the model, whether or not they are columns of the corresponding
|
|
# table.
|
|
#
|
|
# The +sql+ parameter is a full SQL query as a string. It will be called as is, there will be
|
|
# no database agnostic conversions performed. This should be a last resort because using, for example,
|
|
# MySQL specific terms will lock you to using that particular database engine or require you to
|
|
# change your call if you switch engines.
|
|
#
|
|
# # A simple SQL query spanning multiple tables
|
|
# Post.find_by_sql "SELECT p.title, c.author FROM posts p, comments c WHERE p.id = c.post_id"
|
|
# # => [#<Post:0x36bff9c @attributes={"title"=>"Ruby Meetup", "first_name"=>"Quentin"}>, ...]
|
|
#
|
|
# You can use the same string replacement techniques as you can with <tt>ActiveRecord::QueryMethods#where</tt>:
|
|
#
|
|
# Post.find_by_sql ["SELECT title FROM posts WHERE author = ? AND created > ?", author_id, start_date]
|
|
# Post.find_by_sql ["SELECT body FROM comments WHERE author = :user_id OR approved_by = :user_id", { :user_id => user_id }]
|
|
def find_by_sql(sql, binds = [])
|
|
result_set = connection.select_all(sanitize_sql(sql), "#{name} Load", binds)
|
|
column_types = result_set.column_types.dup
|
|
columns_hash.each_key { |k| column_types.delete k }
|
|
message_bus = ActiveSupport::Notifications.instrumenter
|
|
|
|
payload = {
|
|
record_count: result_set.length,
|
|
class_name: name
|
|
}
|
|
|
|
message_bus.instrument('instantiation.active_record', payload) do
|
|
result_set.map { |record| instantiate(record, column_types) }
|
|
end
|
|
end
|
|
|
|
# Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
|
|
# The use of this method should be restricted to complicated SQL queries that can't be executed
|
|
# using the ActiveRecord::Calculations class methods. Look into those before using this.
|
|
#
|
|
# Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
|
|
# # => 12
|
|
#
|
|
# ==== Parameters
|
|
#
|
|
# * +sql+ - An SQL statement which should return a count query from the database, see the example above.
|
|
def count_by_sql(sql)
|
|
sql = sanitize_conditions(sql)
|
|
connection.select_value(sql, "#{name} Count").to_i
|
|
end
|
|
end
|
|
end
|