Active Record Result

This class encapsulates a result returned from calling #exec_query on any database connection adapter. For example:

result = ActiveRecord::Base.lease_connection.exec_query('SELECT id, title, body FROM posts')
result # => #<ActiveRecord::Result:0xdeadbeef>

# Get the column names of the result:
result.columns
# => ["id", "title", "body"]

# Get the record values of the result:
result.rows
# => [[1, "title_1", "body_1"],
      [2, "title_2", "body_2"],
      ...
     ]

# Get an array of hashes representing the result (column => value):
result.to_a
# => [{"id" => 1, "title" => "title_1", "body" => "body_1"},
      {"id" => 2, "title" => "title_2", "body" => "body_2"},
      ...
     ]

# Get the number of rows affected by the query:
result = ActiveRecord::Base.lease_connection.exec_query('INSERT INTO posts (title, body) VALUES ("title_3", "body_3"), ("title_4", "body_4")')
result.affected_rows
# => 2

# ActiveRecord::Result also includes Enumerable.
result.each do |row|
  puts row['title'] + " " + row['body']
end

Namespace

Class

Methods

Included Modules

Attributes

[R] affected_rows
[R] columns
[R] rows

Class Public methods

new(columns, rows, column_types = nil, affected_rows: nil)

📝 Source code 
# File activerecord/lib/active_record/result.rb, line 107
def initialize(columns, rows, column_types = nil, affected_rows: nil)
  # We freeze the strings to prevent them getting duped when
  # used as keys in ActiveRecord::Base's @attributes hash
  @columns      = columns.each(&:-@).freeze
  @rows         = rows
  @hash_rows    = nil
  @column_types = column_types.freeze
  @types_hash   = nil
  @column_indexes = nil
  @affected_rows = affected_rows
end
🔎 See on GitHub

Instance Public methods

[](idx)

📝 Source code 
# File activerecord/lib/active_record/result.rb, line 155
def [](idx)
  hash_rows[idx]
end
🔎 See on GitHub

column_types()

Returns the ActiveRecord::Type type of all columns. Note that not all database adapters return the result types, so the hash may be empty.

📝 Source code 
# File activerecord/lib/active_record/result.rb, line 167
def column_types
  if @column_types
    @types_hash ||= begin
      types = {}
      @columns.each_with_index do |name, index|
        type = @column_types[index] || Type.default_value
        types[name] = types[index] = type
      end
      types.freeze
    end
  else
    EMPTY_HASH
  end
end
🔎 See on GitHub

each(&block)

Calls the given block once for each element in row collection, passing row as parameter. Each row is a Hash-like, read only object.

To get real hashes, use .to_a.each.

Returns an Enumerator if no block is given.

📝 Source code 
# File activerecord/lib/active_record/result.rb, line 135
def each(&block)
  if block_given?
    hash_rows.each(&block)
  else
    hash_rows.to_enum { @rows.size }
  end
end
🔎 See on GitHub

empty?()

Returns true if there are no records, otherwise false.

📝 Source code 
# File activerecord/lib/active_record/result.rb, line 144
def empty?
  rows.empty?
end
🔎 See on GitHub

includes_column?(name)

Returns true if this result set includes the column named name

📝 Source code 
# File activerecord/lib/active_record/result.rb, line 120
def includes_column?(name)
  @columns.include? name
end
🔎 See on GitHub

initialize_copy(other)

📝 Source code 
# File activerecord/lib/active_record/result.rb, line 216
def initialize_copy(other)
  @rows = rows.dup
  @hash_rows    = nil
end
🔎 See on GitHub

last(n = nil)

Returns the last record from the rows collection.

📝 Source code 
# File activerecord/lib/active_record/result.rb, line 160
def last(n = nil)
  n ? hash_rows.last(n) : hash_rows.last
end
🔎 See on GitHub

length()

Returns the number of elements in the rows array.

📝 Source code 
# File activerecord/lib/active_record/result.rb, line 125
def length
  @rows.length
end
🔎 See on GitHub

to_a()

Alias for: to_ary.

to_ary()

Returns an array of hashes representing each row record.

Also aliased as: to_a.

📝 Source code 
# File activerecord/lib/active_record/result.rb, line 149
def to_ary
  hash_rows
end
🔎 See on GitHub

Definition files