Method: Searchkick::Results#scroll

Defined in:

lib/searchkick/results.rb

#scroll ⇒ Object

Raises:

• (Error)

# File 'lib/searchkick/results.rb', line 182

def scroll
  raise Error, "Pass `scroll` option to the search method for scrolling" unless scroll_id

  if block_given?
    records = self
    while records.any?
      yield records
      records = records.scroll
    end

    records.clear_scroll
  else
    begin
      # TODO Active Support notifications for this scroll call
      Results.new(@klass, Searchkick.client.scroll(scroll: options[:scroll], body: {scroll_id: scroll_id}), @options)
    rescue => e
      if Searchkick.not_found_error?(e) && e.message =~ /search_context_missing_exception/i
        raise Error, "Scroll id has expired"
      else
        raise e
      end
    end
  end
end