Spec-Zone.ru › Ruby on Rails 8.1

класс ActiveRecord::Result

Родительский класс:
Object
Подключённые модули:
Enumerable

Результат Active Record

Этот класс инкапсулирует результат, возвращаемый при вызове #exec_query для любого адаптера подключения к базе данных. Например:

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

Атрибуты

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

Публичные методы класса

new (columns, rows, column_types = nil, affected_rows: nil) Показать исходный код
# 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

Публичные методы экземпляра

[] (idx) Показать исходный код
# File activerecord/lib/active_record/result.rb, line 155
def [](idx)
  hash_rows[idx]
end
column_types () Показать исходный код
# 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

Возвращает тип ActiveRecord::Type всех столбцов. Обратите внимание, что не все адаптеры баз данных возвращают типы результатов, поэтому хеш может быть пустым.

each (&block) Показать исходный код
# 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

Вызывает переданный блок один раз для каждого элемента коллекции строк, передавая строку в качестве параметра. Каждая строка — это объект, похожий на Hash, доступный только для чтения.

Чтобы получить обычные хеши, используйте .to_a.each.

Если блок не указан, возвращает Enumerator.

empty? () Показать исходный код
# File activerecord/lib/active_record/result.rb, line 144
def empty?
  rows.empty?
end

Возвращает true, если записей нет, и false в противном случае.

includes_column? (name) Показать исходный код
# File activerecord/lib/active_record/result.rb, line 120
def includes_column?(name)
  @columns.include? name
end

Возвращает true, если этот набор результатов содержит столбец с именем name

initialize_copy (other) Показать исходный код
# File activerecord/lib/active_record/result.rb, line 216
def initialize_copy(other)
  @rows = rows.dup
  @hash_rows    = nil
end
last (n = nil) Показать исходный код
# File activerecord/lib/active_record/result.rb, line 160
def last(n = nil)
  n ? hash_rows.last(n) : hash_rows.last
end

Возвращает последнюю запись из коллекции строк.

length () Показать исходный код
# File activerecord/lib/active_record/result.rb, line 125
def length
  @rows.length
end

Возвращает количество элементов в массиве строк.

to_a ()
Псевдоним для: to_ary
to_ary () Показать исходный код
# File activerecord/lib/active_record/result.rb, line 149
def to_ary
  hash_rows
end

Возвращает массив хешей, представляющих каждую запись строки.

Также имеет псевдоним: to_a

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API