Sha256: 8b1915120e2465ea3fa15509ee20d0871f9061e2eaaaf3f0b4362813b60f541e

Contents?: true

Size: 1.01 KB

Versions: 26

Compression:

Stored size: 1.01 KB

Contents

module Elasticsearch
  module API
    module Actions

      # Abort a particular scroll search and clear all the resources associated with it.
      #
      # @option arguments [List] :scroll_id A comma-separated list of scroll IDs to clear;
      #                                     use `_all` clear all scroll search contexts
      #
      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-search-type.html#clear-scroll
      #
      def clear_scroll(arguments={})
        raise ArgumentError, "Required argument 'scroll_id' missing" unless arguments[:scroll_id]

        scroll_id = arguments[:body] || arguments.delete(:scroll_id)

        scroll_ids = case scroll_id
          when Array
            scroll_id.join(',')
          else
            scroll_id
        end

        method = HTTP_DELETE
        path   = Utils.__pathify '_search/scroll'
        params = {}
        body   = scroll_ids

        perform_request(method, path, params, body).body
      end
    end
  end
end

Version data entries

26 entries across 26 versions & 1 rubygems

Version Path
elasticsearch-api-1.1.3 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-2.0.2 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-5.0.3 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-5.0.2 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-5.0.1 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-2.0.1 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.1.2 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.1.1 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-5.0.0 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-5.0.0.pre lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-2.0.0 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.1.0 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-2.0.0.pre lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.1.pre lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.0.18 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.0.17 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.0.16 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.0.16.pre2 lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.0.16.pre lib/elasticsearch/api/actions/clear_scroll.rb
elasticsearch-api-1.0.15 lib/elasticsearch/api/actions/clear_scroll.rb