Class: ActiveRecord::Result

Inherits:
Object show all
Includes:
Enumerable
Defined in:
activerecord/lib/active_record/result.rb

Overview

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

result = ActiveRecord::Base.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_hash
# => [{"id" => 1, "title" => "title_1", "body" => "body_1"},
      {"id" => 2, "title" => "title_2", "body" => "body_2"},
      ...
     ]

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

Constant Summary collapse

IDENTITY_TYPE =

:nodoc:

Type::Value.new

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Enumerable

#as_json, #exclude?, #index_by, #many?, #pluck, #sum, #without

Constructor Details

#initialize(columns, rows, column_types = {}) ⇒ Result

Returns a new instance of Result.


39
40
41
42
43
44
# File 'activerecord/lib/active_record/result.rb', line 39

def initialize(columns, rows, column_types = {})
  @columns      = columns
  @rows         = rows
  @hash_rows    = nil
  @column_types = column_types
end

Instance Attribute Details

#column_typesObject (readonly)

Returns the value of attribute column_types


37
38
39
# File 'activerecord/lib/active_record/result.rb', line 37

def column_types
  @column_types
end

#columnsObject (readonly)

Returns the value of attribute columns


37
38
39
# File 'activerecord/lib/active_record/result.rb', line 37

def columns
  @columns
end

#rowsObject (readonly)

Returns the value of attribute rows


37
38
39
# File 'activerecord/lib/active_record/result.rb', line 37

def rows
  @rows
end

Instance Method Details

#[](idx) ⇒ Object


74
75
76
# File 'activerecord/lib/active_record/result.rb', line 74

def [](idx)
  hash_rows[idx]
end

#cast_values(type_overrides = {}) ⇒ Object

:nodoc:


88
89
90
91
92
93
94
95
# File 'activerecord/lib/active_record/result.rb', line 88

def cast_values(type_overrides = {}) # :nodoc:
  types = columns.map { |name| column_type(name, type_overrides) }
  result = rows.map do |values|
    types.zip(values).map { |type, value| type.deserialize(value) }
  end

  columns.one? ? result.map!(&:first) : result
end

#eachObject


50
51
52
53
54
55
56
# File 'activerecord/lib/active_record/result.rb', line 50

def each
  if block_given?
    hash_rows.each { |row| yield row }
  else
    hash_rows.to_enum { @rows.size }
  end
end

#empty?Boolean

Returns true if there are no records.

Returns:

  • (Boolean)

66
67
68
# File 'activerecord/lib/active_record/result.rb', line 66

def empty?
  rows.empty?
end

#firstObject


78
79
80
81
# File 'activerecord/lib/active_record/result.rb', line 78

def first
  return nil if @rows.empty?
  Hash[@columns.zip(@rows.first)]
end

#initialize_copy(other) ⇒ Object


97
98
99
100
101
102
# File 'activerecord/lib/active_record/result.rb', line 97

def initialize_copy(other)
  @columns      = columns.dup
  @rows         = rows.dup
  @column_types = column_types.dup
  @hash_rows    = nil
end

#lastObject


83
84
85
86
# File 'activerecord/lib/active_record/result.rb', line 83

def last
  return nil if @rows.empty?
  Hash[@columns.zip(@rows.last)]
end

#lengthObject


46
47
48
# File 'activerecord/lib/active_record/result.rb', line 46

def length
  @rows.length
end

#to_aryObject


70
71
72
# File 'activerecord/lib/active_record/result.rb', line 70

def to_ary
  hash_rows
end

#to_hashObject


58
59
60
# File 'activerecord/lib/active_record/result.rb', line 58

def to_hash
  hash_rows
end