Contents

module Elasticsearch
  module XPack
    module API
      module SQL
        module Actions

          # TODO: Description
          #
          # @option arguments [Hash] :body Specify the cursor value in the `cursor` element to clean the cursor. (*Required*)
          #
          # @see Clear SQL cursor
          #
          def clear_cursor(arguments={})
            raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
            method = Elasticsearch::API::HTTP_POST
            path   = "_xpack/sql/close"
            params = {}
            body   = arguments[:body]

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

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
elasticsearch-xpack-6.8.1	lib/elasticsearch/xpack/api/actions/sql/clear_cursor.rb
elasticsearch-xpack-6.8.0	lib/elasticsearch/xpack/api/actions/sql/clear_cursor.rb
elasticsearch-xpack-6.3.1	lib/elasticsearch/xpack/api/actions/sql/clear_cursor.rb
elasticsearch-xpack-6.3.0	lib/elasticsearch/xpack/api/actions/sql/clear_cursor.rb
elasticsearch-xpack-6.2.0	lib/elasticsearch/xpack/api/actions/sql/clear_cursor.rb
elasticsearch-xpack-6.1.0	lib/elasticsearch/xpack/api/actions/sql/clear_cursor.rb