elasticsearch-api 7.3.0 → 7.5.0

data/lib/elasticsearch/api/actions/put_script.rb

@@ -5,52 +5,48 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Store a script in an internal index (`.scripts`), to be able to reference them
-      # in search definitions (with dynamic scripting disabled)
-      #
-      # @example Storing an Mvel script in Elasticsearch and using it in function score
-      #
-      #     client.put_script lang: 'groovy', id: 'my_score', body: { script: 'log(_score * factor)' }
-      #
-      #     client.search body: {
-      #       query: {
-      #         function_score: {
-      #           query: { match: { title: 'foo' } },
-      #           functions: [ { script_score: { script_id: 'my_score', params: { factor: 3 } } } ]
-      #         }
-      #       }
-      #     }
+      # Creates or updates a script.
       #
-      # @option arguments [String] :id Script ID (*Required*)
+      # @option arguments [String] :id Script ID
       # @option arguments [String] :context Script context
-      # @option arguments [Hash] :body The document (*Required*)
       # @option arguments [Time] :timeout Explicit operation timeout
       # @option arguments [Time] :master_timeout Specify timeout for connection to master
       # @option arguments [String] :context Context name to compile script against
+
+      # @option arguments [Hash] :body The document (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html#_indexed_scripts
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/modules-scripting.html
       #
-      def put_script(arguments={})
-        raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
+      def put_script(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        method = HTTP_PUT
-        path   = "_scripts/#{arguments.has_key?(:lang) ? "#{arguments.delete(:lang)}/" : ''}#{arguments[:id]}"
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
 
-        body   = arguments[:body]
+        _context = arguments.delete(:context)
 
+        method = Elasticsearch::API::HTTP_PUT
+        path   = if _id && _context
+                   "_scripts/#{Utils.__listify(_id)}/#{Utils.__listify(_context)}"
+                 else
+                   "_scripts/#{Utils.__listify(_id)}"
+  end
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+        body = arguments[:body]
         perform_request(method, path, params, body).body
       end
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:put_script, [
-          :timeout,
-          :master_timeout,
-          :context ].freeze)
+        :timeout,
+        :master_timeout,
+        :context
+      ].freeze)
+    end
     end
-  end
 end

data/lib/elasticsearch/api/actions/rank_eval.rb

@@ -5,26 +5,34 @@
 module Elasticsearch
   module API
     module Actions
-
-      # The ranking evaluation API allows to evaluate the quality of ranked search results over a set of typical search queries.
-      #   Given this set of queries and a list of manually rated documents, the _rank_eval endpoint calculates and
-      #   returns typical information retrieval metrics like mean reciprocal rank, precision or discounted cumulative gain.
+      # Allows to evaluate the quality of ranked search results over a set of typical search queries
       #
       # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
-      # @option arguments [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*)
       # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
       # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all)
+      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
+      #   (options: open,closed,none,all)
+
+      # @option arguments [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/search-rank-eval.html
       #
-      def rank_eval(arguments={})
+      def rank_eval(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
         method = Elasticsearch::API::HTTP_GET
-        path   = "_rank_eval"
-        params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
+        path   = if _index
+                   "#{Utils.__listify(_index)}/_rank_eval"
+                 else
+                   "_rank_eval"
+  end
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
+        body = arguments[:body]
         perform_request(method, path, params, body).body
       end
 
@@ -32,9 +40,10 @@ module Elasticsearch
       #
       # @since 6.2.0
       ParamsRegistry.register(:rank_eval, [
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards ].freeze)
+        :ignore_unavailable,
+        :allow_no_indices,
+        :expand_wildcards
+      ].freeze)
+    end
     end
-  end
 end

data/lib/elasticsearch/api/actions/reindex.rb

@@ -5,72 +5,49 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Copy documents from one index to another, potentially changing
-      # its settings, mappings and the documents itself.
-      #
-      # @example Copy documents into a different index
-      #
-      #     client.reindex body: { source: { index: 'test1' }, dest: { index: 'test2' } }
-      #
-      # @example Limit the copied documents with a query
-      #
-      #     client.reindex body: {
-      #       source: {
-      #         index: 'test1',
-      #         query: { terms: { category: ['one', 'two'] }  }
-      #       },
-      #       dest: {
-      #         index: 'test2'
-      #       }
-      #     }
-      #
-      # @example Remove a field from reindexed documents
-      #
-      #     client.reindex body: {
-      #       source: {
-      #         index: 'test1'
-      #       },
-      #       dest: {
-      #         index: 'test3'
-      #       },
-      #       script: {
-      #         inline: 'ctx._source.remove("category")'
-      #       }
-      #     }
+      # Allows to copy documents from one index to another, optionally filtering the source
+      # documents by a query, changing the destination index settings, or fetching the
+      # documents from a remote cluster.
       #
-      # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*)
-      # @option arguments [Boolean] :refresh Should the effected indexes be refreshed?
+      # @option arguments [Boolean] :refresh Should the affected indexes be refreshed?
       # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable.
       # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
       # @option arguments [Boolean] :wait_for_completion Should the request should block until the reindex is complete.
       # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle.
       # @option arguments [Time] :scroll Control how long to keep the search context alive
       # @option arguments [Number] :slices The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
+      # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
+
+      # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*)
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-reindex.html
       #
-      def reindex(arguments={})
+      def reindex(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-        method = 'POST'
+
+        arguments = arguments.clone
+
+        method = Elasticsearch::API::HTTP_POST
         path   = "_reindex"
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
 
+        body = arguments[:body]
         perform_request(method, path, params, body).body
       end
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:reindex, [
-          :refresh,
-          :timeout,
-          :wait_for_active_shards,
-          :wait_for_completion,
-          :requests_per_second,
-          :scroll,
-          :slices ].freeze)
+        :refresh,
+        :timeout,
+        :wait_for_active_shards,
+        :wait_for_completion,
+        :requests_per_second,
+        :scroll,
+        :slices,
+        :max_docs
+      ].freeze)
+    end
     end
-  end
 end

data/lib/elasticsearch/api/actions/reindex_rethrottle.rb

@@ -5,21 +5,26 @@
 module Elasticsearch
   module API
     module Actions
-
-      # The value of requests_per_second can be changed on a running reindex using the _rethrottle
+      # Changes the number of requests per second for a particular Reindex operation.
       #
-      # @option arguments [String] :task_id The task id to rethrottle (*Required*)
-      # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.
+      # @option arguments [String] :task_id The task id to rethrottle
+      # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.  (*Required*)
+
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-reindex.html
       #
-      def reindex_rethrottle(arguments={})
+      def reindex_rethrottle(arguments = {})
         raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id]
+
+        arguments = arguments.clone
+
+        _task_id = arguments.delete(:task_id)
+
         method = Elasticsearch::API::HTTP_POST
-        path   = "_reindex/#{arguments[:task_id]}/_rethrottle"
-        params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = nil
+        path   = "_reindex/#{Utils.__listify(_task_id)}/_rethrottle"
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
+        body = nil
         perform_request(method, path, params, body).body
       end
 
@@ -27,7 +32,8 @@ module Elasticsearch
       #
       # @since 6.2.0
       ParamsRegistry.register(:reindex_rethrottle, [
-          :requests_per_second ].freeze)
+        :requests_per_second
+      ].freeze)
+    end
     end
-  end
-end
+end

data/lib/elasticsearch/api/actions/remote/info.rb

@@ -6,12 +6,11 @@ module Elasticsearch
   module API
     module Remote
       module Actions
-
         # Returns all of the configured remote cluster information
         #
         # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/remote-info.html
         #
-        def info(arguments={})
+        def info(arguments = {})
           method = HTTP_GET
           path   = "_remote/info"
           params = {}

data/lib/elasticsearch/api/actions/render_search_template.rb

@@ -5,28 +5,30 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Pre-render search requests before they are executed and fill existing templates with template parameters
+      # Allows to use the Mustache language to pre-render a search definition.
       #
       # @option arguments [String] :id The id of the stored search template
+
       # @option arguments [Hash] :body The search definition template and its params
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/search-template.html#_validating_templates
       #
-      def render_search_template(arguments={})
-        method = 'GET'
-        path   = "_render/template"
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
+      def render_search_template(arguments = {})
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
+
+        method = Elasticsearch::API::HTTP_GET
+        path   = if _id
+                   "_render/template/#{Utils.__listify(_id)}"
+                 else
+                   "_render/template"
+end
+        params = {}
 
+        body = arguments[:body]
         perform_request(method, path, params, body).body
       end
-
-      # Register this action with its valid params when the module is loaded.
-      #
-      # @since 6.1.1
-      ParamsRegistry.register(:render_search_template, [
-          :id ].freeze)
     end
-  end
+    end
 end

data/lib/elasticsearch/api/actions/scripts_painless_execute.rb

@@ -5,21 +5,23 @@
 module Elasticsearch
   module API
     module Actions
-
-      # The Painless execute API allows an arbitrary script to be executed and a result to be returned.
+      # Allows an arbitrary script to be executed and a result to be returned
       #
+
       # @option arguments [Hash] :body The script to execute
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-execute-api.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/painless/7.5/painless-execute-api.html
       #
-      def scripts_painless_execute(arguments={})
+      def scripts_painless_execute(arguments = {})
+        arguments = arguments.clone
+
         method = Elasticsearch::API::HTTP_GET
         path   = "_scripts/painless/_execute"
         params = {}
-        body   = arguments[:body]
 
+        body = arguments[:body]
         perform_request(method, path, params, body).body
       end
     end
-  end
+    end
 end

data/lib/elasticsearch/api/actions/scroll.rb

@@ -5,70 +5,47 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Efficiently iterate over a large result set.
-      #
-      # When using `from` and `size` to return a large result sets, performance drops as you "paginate" in the set,
-      # and you can't guarantee the consistency when the index is being updated at the same time.
-      #
-      # The "Scroll" API uses a "point in time" snapshot of the index state, which was created via a "Search" API
-      # request specifying the `scroll` parameter.
-      #
-      # @example A basic example
-      #
-      #     result = client.search index: 'scrollindex',
-      #                            scroll: '5m',
-      #                            body: { query: { match: { title: 'test' } }, sort: '_id' }
-      #
-      #     result = client.scroll body: { scroll_id: result['_scroll_id'], scroll: '5m' }
-      #
-      # @example Call the `scroll` API until all the documents are returned
-      #
-      #     # Index 1,000 documents
-      #     client.indices.delete index: 'test'
-      #     1_000.times do |i| client.index index: 'test', type: 'test', id: i+1, body: {title: "Test #{i+1}"} end
-      #     client.indices.refresh index: 'test'
-      #
-      #     # Open the "view" of the index by passing the `scroll` parameter
-      #     # Sorting by `_doc` makes the operations faster
-      #     r = client.search index: 'test', scroll: '1m', body: {sort: ['_doc']}
-      #
-      #     # Display the initial results
-      #     puts "--- BATCH 0 -------------------------------------------------"
-      #     puts r['hits']['hits'].map { |d| d['_source']['title'] }.inspect
+      # Allows to retrieve a large numbers of results from a single search request.
       #
-      #     # Call the `scroll` API until empty results are returned
-      #     while r = client.scroll(body: { scroll_id: r['_scroll_id'] }, scroll: '5m') and not r['hits']['hits'].empty? do
-      #       puts "--- BATCH #{defined?($i) ? $i += 1 : $i = 1} -------------------------------------------------"
-      #       puts r['hits']['hits'].map { |d| d['_source']['title'] }.inspect
-      #       puts
-      #     end
-      #
-      # @option arguments [String] :scroll_id The scroll ID
-      # @option arguments [Hash] :body The scroll ID if not passed by URL or query parameter.
+      # @option arguments [String] :scroll_id The scroll ID   *Deprecated*
       # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
       # @option arguments [String] :scroll_id The scroll ID for scrolled search
       # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+
+      # @option arguments [Hash] :body The scroll ID if not passed by URL or query parameter.
+      #
+      # *Deprecation notice*:
+      # A scroll id can be quite large and should be specified as part of the body
+      # Deprecated since version 7.0.0
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/guide/current/scan-scroll.html#scan-scroll
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html
       #
-      def scroll(arguments={})
-        method = HTTP_GET
-        path   = "_search/scroll"
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/search-request-body.html#request-body-search-scroll
+      #
+      def scroll(arguments = {})
+        arguments = arguments.clone
+
+        _scroll_id = arguments.delete(:scroll_id)
+
+        method = Elasticsearch::API::HTTP_GET
+        path   = if _scroll_id
+                   "_search/scroll/#{Utils.__listify(_scroll_id)}"
+                 else
+                   "_search/scroll"
+end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
 
+        body = arguments[:body]
         perform_request(method, path, params, body).body
       end
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:scroll, [
-          :scroll,
-          :scroll_id,
-          :rest_total_hits_as_int ].freeze)
+        :scroll,
+        :scroll_id,
+        :rest_total_hits_as_int
+      ].freeze)
+    end
     end
-  end
 end