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_a
# => [{"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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Enumerable

#as_json, #compact_blank, #exclude?, #excluding, #in_order_of, #including, #index_by, #index_with, #many?, #maximum, #minimum, #pick, #pluck, #sole, #sum

Constructor Details

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

Returns a new instance of Result.


47
48
49
50
51
52
# File 'activerecord/lib/active_record/result.rb', line 47

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

Class Method Details

.empty(async: false) ⇒ Object

:nodoc:


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

def self.empty(async: false) # :nodoc:
  if async
    EMPTY_ASYNC
  else
    EMPTY
  end
end

Instance Method Details

#[](idx) ⇒ Object


88
89
90
# File 'activerecord/lib/active_record/result.rb', line 88

def [](idx)
  hash_rows[idx]
end

#cancelObject

:nodoc:


101
102
103
# File 'activerecord/lib/active_record/result.rb', line 101

def cancel # :nodoc:
  self
end

#cast_values(type_overrides = {}) ⇒ Object

:nodoc:


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'activerecord/lib/active_record/result.rb', line 105

def cast_values(type_overrides = {}) # :nodoc:
  if columns.one?
    # Separated to avoid allocating an array per row

    type = if type_overrides.is_a?(Array)
      type_overrides.first
    else
      column_type(columns.first, type_overrides)
    end

    rows.map do |(value)|
      type.deserialize(value)
    end
  else
    types = if type_overrides.is_a?(Array)
      type_overrides
    else
      columns.map { |name| column_type(name, type_overrides) }
    end

    rows.map do |values|
      Array.new(values.size) { |i| types[i].deserialize(values[i]) }
    end
  end
end

#each(&block) ⇒ Object

Calls the given block once for each element in row collection, passing row as parameter.

Returns an Enumerator if no block is given.


68
69
70
71
72
73
74
# File 'activerecord/lib/active_record/result.rb', line 68

def each(&block)
  if block_given?
    hash_rows.each(&block)
  else
    hash_rows.to_enum { @rows.size }
  end
end

#empty?Boolean

Returns true if there are no records, otherwise false.

Returns:

  • (Boolean)

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

def empty?
  rows.empty?
end

#freezeObject

:nodoc:


138
139
140
141
# File 'activerecord/lib/active_record/result.rb', line 138

def freeze # :nodoc:
  hash_rows.freeze
  super
end

#includes_column?(name) ⇒ Boolean

Returns true if this result set includes the column named name

Returns:

  • (Boolean)

55
56
57
# File 'activerecord/lib/active_record/result.rb', line 55

def includes_column?(name)
  @columns.include? name
end

#initialize_copy(other) ⇒ Object


131
132
133
134
135
136
# File 'activerecord/lib/active_record/result.rb', line 131

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

#last(n = nil) ⇒ Object

Returns the last record from the rows collection.


93
94
95
# File 'activerecord/lib/active_record/result.rb', line 93

def last(n = nil)
  n ? hash_rows.last(n) : hash_rows.last
end

#lengthObject

Returns the number of elements in the rows array.


60
61
62
# File 'activerecord/lib/active_record/result.rb', line 60

def length
  @rows.length
end

#resultObject

:nodoc:


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

def result # :nodoc:
  self
end

#to_aryObject Also known as: to_a

Returns an array of hashes representing each row record.


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

def to_ary
  hash_rows
end