elasticsearch-api 7.4.0 → 7.5.0.pre.pre

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

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

@@ -5,200 +5,139 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Return documents matching a query, as well as aggregations (facets), highlighted snippets, suggestions, etc.
-      #
-      # The search API is used to query one or more indices either using simple
-      # [query string queries](https://www.elastic.co/guide/reference/api/search/uri-request/)
-      # as the `:q` argument , or by passing the
-      # [full request definition](https://www.elastic.co/guide/reference/api/search/request-body/)
-      # in the [Query DSL](https://www.elastic.co/guide/reference/query-dsl/) as the `:body` argument.
-      #
-      # @example Search with a simple query string query
-      #
-      #     client.search index: 'myindex', q: 'title:test'
-      #
-      # @example Passing a full request definition in the Elasticsearch's Query DSL as a `Hash`
-      #
-      #     client.search index: 'myindex',
-      #                   body: {
-      #                     query: { match: { title: 'test' } },
-      #                     aggregations: { tags: { terms: { field: 'tags' } } }
-      #                   }
-      #
-      # @example Paginating results: return 10 documents, beginning from the 10th
-      #
-      #     client.search index: 'myindex',
-      #                   body: {
-      #                     query: { match: { title: 'test' } },
-      #                     from: 10,
-      #                     size: 10
-      #                   }
-      #
-      # @example Passing the search definition as a `String`, built with a JSON builder
-      #
-      #     require 'jbuilder'
-      #
-      #     json = Jbuilder.encode do |json|
-      #       json.query do
-      #         json.match do
-      #           json.title do
-      #             json.query    'test 1'
-      #             json.operator 'and'
-      #           end
-      #         end
-      #       end
-      #     end
-      #
-      #     client.search index: 'myindex', body: json
-      #
-      # @example Wrapping the result in [`Hashie::Mash`](https://github.com/intridea/hashie) for easier access
-      #
-      #     response = client.search index: 'myindex',
-      #                              body: {
-      #                                query:  { match: { title: 'test' } },
-      #                                aggregations: { tags:  { terms: { field: 'tags' } } }
-      #                              }
-      #
-      #     response = Hashie::Mash.new response
+      # Returns results matching a query.
       #
-      #     response.hits.hits.first._source.title
-      #
-      #     response.aggregations.tags.terms.to_a.map { |f| "#{f.term} [#{f.count}]" }.join(', ')
-      #
-      # @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 [List] :type A comma-separated list of document types to search;
-      #                                leave empty to perform the operation on all types
-      # @option arguments [Hash] :body The search definition using the Query DSL
+      # @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 [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
       # @option arguments [String] :analyzer The analyzer to use for the query string
-      # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed
-      #                                               (default: false)
+      # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
+      # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
       # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
-      #                                              (options: AND, OR)
+      #   (options: AND,OR)
+
       # @option arguments [String] :df The field to use as default where no field prefix is given in the query string
-      # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation
-      #                                      as part of a hit
-      # @option arguments [List] :fields A comma-separated list of fields to return as part of a hit
-      # @option arguments [List] :fielddata_fields A comma-separated list of fields to return as the field data
-      #                                            representation of a field for each hit
-      # @option arguments [List] :docvalue_fields A comma-separated list of fields to return as the docvalue
-      #                                           representation of a field for each hit
+      # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
       # @option arguments [List] :stored_fields A comma-separated list of stored fields to return as part of a hit
+      # @option arguments [List] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit
       # @option arguments [Number] :from Starting offset (default: 0)
-      # @option arguments [Boolean] :include_type_name Whether a type should be expected in the body of the mappings.
-      # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
-      #                                            (options: none, missing)
-      # @option arguments [Boolean] :lenient Specify whether format-based query failures
-      #                                      (such as providing text to a numeric field) should be ignored
-      # @option arguments [Boolean] :lowercase_expanded_terms Specify whether query terms should be lowercased
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
-      #                                        (default: random)
+      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
+      # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
+      # @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 [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [String] :q Query in the Lucene query string syntax
-      # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request
-      #                                            (defaults to index level setting)
       # @option arguments [List] :routing A comma-separated list of specific routing values
-      # @option arguments [Duration] :scroll Specify how long a consistent view of the index should be maintained
-      #                                      for scrolled search
-      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch,
-      #                                         dfs_query_then_fetch, dfs_query_and_fetch, count, scan)
+      # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search
+      # @option arguments [String] :search_type Search operation type
+      #   (options: query_then_fetch,dfs_query_then_fetch)
+
       # @option arguments [Number] :size Number of hits to return (default: 10)
       # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
-      # @option arguments [String] :source The URL-encoded request definition using the Query DSL
-      #                                    (instead of using request body)
-      # @option arguments [String] :_source Specify whether the _source field should be returned,
-      #                                     or a list of fields to return
-      # @option arguments [String] :_source_exclude A list of fields to exclude from the returned _source field
-      # @option arguments [String] :_source_include A list of fields to extract and return from the _source field
-      # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response
+      # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
+      # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
+      # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
       # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
       # @option arguments [String] :suggest_field Specify which field to use for suggestions
-      # @option arguments [String] :suggest_mode Specify suggest mode (options: missing, popular, always)
+      # @option arguments [String] :suggest_mode Specify suggest mode
+      #   (options: missing,popular,always)
+
       # @option arguments [Number] :suggest_size How many suggestions to return in response
-      # @option arguments [Text] :suggest_text The source text for which the suggestions should be returned
-      # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard
+      # @option arguments [String] :suggest_text The source text for which the suggestions should be returned
       # @option arguments [Time] :timeout Explicit operation timeout
+      # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting
+      # @option arguments [Boolean] :track_total_hits Indicate if the number of documents that match the query should be tracked
+      # @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout
       # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
       # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
+      # @option arguments [Boolean] :seq_no_primary_term Specify whether to return sequence number and primary term of the last modification of each hit
+      # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting
       # @option arguments [Number] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
-      # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. The default grows with the number of nodes in the cluster but is at most 256.
-      # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. (Default: 128)
+      # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
+      # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
+      # @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 search definition using the Query DSL
       #
-      # @return [Hash]
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      # @see https://www.elastic.co/guide/reference/api/search/
-      # @see https://www.elastic.co/guide/reference/api/search/request-body/
       #
-      def search(arguments={})
-        arguments[:index] = UNDERSCORE_ALL if ! arguments[:index] && arguments[:type]
-        method = HTTP_GET
-        path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), UNDERSCORE_SEARCH )
-
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/search-search.html
+      #
+      def search(arguments = {})
+        arguments = arguments.clone
+        arguments[:index] = UNDERSCORE_ALL if !arguments[:index] && arguments[:type]
 
-        body   = arguments[:body]
+        _index = arguments.delete(:index)
 
-        params[:fields] = Utils.__listify(params[:fields], :escape => false) if params[:fields]
-        params[:fielddata_fields] = Utils.__listify(params[:fielddata_fields], :escape => false) if params[:fielddata_fields]
+        _type = arguments.delete(:type)
 
-        # FIX: Unescape the `filter_path` parameter due to __listify default behavior. Investigate.
-        params[:filter_path] =  defined?(EscapeUtils) ? EscapeUtils.unescape_url(params[:filter_path]) : CGI.unescape(params[:filter_path]) if params[:filter_path]
+        method = Elasticsearch::API::HTTP_GET
+        path   = if _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_search"
+                 elsif _index
+                   "#{Utils.__listify(_index)}/_search"
+                 else
+                   "_search"
+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(:search, [
-          :analyzer,
-          :analyze_wildcard,
-          :default_operator,
-          :df,
-          :explain,
-          :fielddata_fields,
-          :include_type_name,
-          :docvalue_fields,
-          :stored_fields,
-          :fields,
-          :from,
-          :ignore_indices,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :lenient,
-          :lowercase_expanded_terms,
-          :preference,
-          :q,
-          :query_cache,
-          :request_cache,
-          :routing,
-          :scroll,
-          :search_type,
-          :size,
-          :sort,
-          :source,
-          :_source,
-          :_source_includes,
-          :_source_excludes,
-          :stored_fields,
-          :stats,
-          :suggest_field,
-          :suggest_mode,
-          :suggest_size,
-          :suggest_text,
-          :terminate_after,
-          :timeout,
-          :typed_keys,
-          :version,
-          :batched_reduce_size,
-          :max_concurrent_shard_requests,
-          :pre_filter_shard_size,
-          :allow_partial_search_results,
-          :rest_total_hits_as_int,
-          :track_total_hits,
-          :ignore_throttled,
-          :seq_no_primary_term ].freeze)
+        :analyzer,
+        :analyze_wildcard,
+        :ccs_minimize_roundtrips,
+        :default_operator,
+        :df,
+        :explain,
+        :stored_fields,
+        :docvalue_fields,
+        :from,
+        :ignore_unavailable,
+        :ignore_throttled,
+        :allow_no_indices,
+        :expand_wildcards,
+        :lenient,
+        :preference,
+        :q,
+        :routing,
+        :scroll,
+        :search_type,
+        :size,
+        :sort,
+        :_source,
+        :_source_excludes,
+        :_source_includes,
+        :terminate_after,
+        :stats,
+        :suggest_field,
+        :suggest_mode,
+        :suggest_size,
+        :suggest_text,
+        :timeout,
+        :track_scores,
+        :track_total_hits,
+        :allow_partial_search_results,
+        :typed_keys,
+        :version,
+        :seq_no_primary_term,
+        :request_cache,
+        :batched_reduce_size,
+        :max_concurrent_shard_requests,
+        :pre_filter_shard_size,
+        :rest_total_hits_as_int
+      ].freeze)
+    end
     end
-  end
 end

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

@@ -5,45 +5,48 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Returns the names of indices and shards on which a search request would be executed
+      # Returns information about the indices and shards that a search request would be executed against.
       #
-      # @option arguments [String] :index The name of the index
-      # @option arguments [String] :type The type of the document
-      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
-      #                                        (default: random)
+      # @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 [String] :preference Specify the node or shard the operation should be performed on (default: random)
       # @option arguments [String] :routing Specific routing value
-      # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
-      #                                    (default: false)
-      # @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` 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)
+      # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+      # @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)
+
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/search-shards.html
       #
-      def search_shards(arguments={})
-        method = HTTP_GET
-        path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_search_shards' )
+      def search_shards(arguments = {})
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        method = Elasticsearch::API::HTTP_GET
+        path   = if _index
+                   "#{Utils.__listify(_index)}/_search_shards"
+                 else
+                   "_search_shards"
+end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = nil
 
+        body = nil
         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(:search_shards, [
-          :preference,
-          :routing,
-          :local,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards ].freeze)
+        :preference,
+        :routing,
+        :local,
+        :ignore_unavailable,
+        :allow_no_indices,
+        :expand_wildcards
+      ].freeze)
+    end
     end
-  end
 end