elasticsearch-api 7.4.0 → 7.5.0.pre.pre

data/lib/elasticsearch/api/actions/tasks/params_registry.rb

@@ -7,7 +7,6 @@ module Elasticsearch
     module Tasks
       module Actions
         module ParamsRegistry
-
           extend self
 
           # A Mapping of all the actions to their list of valid params.

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

@@ -5,43 +5,11 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Return information and statistics about terms in the fields of a particular document
-      #
-      # @example Get statistics for an indexed document
-      #
-      #     client.indices.create index: 'my_index',
-      #                           body: {
-      #                             mappings: {
-      #                               properties: {
-      #                                 text: {
-      #                                   type: 'string',
-      #                                   term_vector: 'with_positions_offsets_payloads'
-      #                                 }
-      #                               }
-      #                             }
-      #                           }
-      #
-      #     client.index index: 'my_index', type: 'my_type', id: '1', body: { text: 'Foo Bar Fox' }
-      #
-      #     client.termvectors index: 'my_index', type: 'my_type', id: '1'
-      #     # => { ..., "term_vectors" => { "text" => { "field_statistics" => { ... }, "terms" => { "bar" => ... } } }
-      #
-      #
-      # @example Get statistics for an arbitrary document
+      # Returns information and statistics about terms in the fields of a particular document.
       #
-      #     client.termvector index: 'my_index', type: 'my_type',
-      #                       body: {
-      #                         doc: {
-      #                           text: 'Foo Bar Fox'
-      #                         }
-      #                       }
-      #     # => { ..., "term_vectors" => { "text" => { "field_statistics" => { ... }, "terms" => { "bar" => ... } } }
-      #
-      # @option arguments [String] :index The index in which the document resides. (*Required*)
-      # @option arguments [String] :type The type of the document.
+      # @option arguments [String] :index The index in which the document resides.  (*Required*)
       # @option arguments [String] :id The id of the document, when not specified a doc param should be supplied.
-      # @option arguments [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation.
+      # @option arguments [String] :type The type of the document.
       # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned.
       # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
       # @option arguments [List] :fields A comma-separated list of fields to return.
@@ -50,57 +18,71 @@ module Elasticsearch
       # @option arguments [Boolean] :payloads Specifies if term payloads should be returned.
       # @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 [String] :parent Parent id of documents.
       # @option arguments [Boolean] :realtime Specifies if request is real-time as opposed to near-real-time (default: true).
       # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
+      # @option arguments [String] :version_type Specific version type
+      #   (options: internal,external,external_gte,force)
+
+      # @option arguments [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation.
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      def termvectors(arguments={})
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-termvectors.html
+      #
+      def termvectors(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        method = HTTP_GET
-        endpoint = arguments.delete(:endpoint) || '_termvectors'
 
-        if arguments[:type]
-          path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                                  arguments[:type],
-                                                  arguments[:id],
-                                                  endpoint
-        else
-          path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                                  endpoint,
-                                                  arguments[:id]
-        end
+        arguments = arguments.clone
+
+        _index = arguments.delete(:index)
+
+        _id = arguments.delete(:id)
+
+        _type = arguments.delete(:type)
+
+        method = Elasticsearch::API::HTTP_GET
+
+        endpoint = arguments.delete(:endpoint) || '_termvectors'
+        path = if _index && _type && _id
+                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/#{endpoint}"
+               elsif _index && _type
+                 "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{endpoint}"
+               elsif _index && _id
+                 "#{Utils.__listify(_index)}/#{endpoint}/#{Utils.__listify(_id)}"
+               else
+                 "#{Utils.__listify(_index)}/#{endpoint}"
+  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
 
-      # @deprecated Use the plural version, {#termvectors}
+      # Deprecated: Use the plural version, {#termvectors}
       #
-      def termvector(arguments={})
-        termvectors(arguments.merge :endpoint => '_termvector')
+      def termvector(arguments = {})
+        termvectors(arguments.merge endpoint: '_termvector')
       end
-
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:termvectors, [
-          :term_statistics,
-          :field_statistics,
-          :fields,
-          :offsets,
-          :positions,
-          :payloads,
-          :preference,
-          :routing,
-          :parent,
-          :realtime,
-          :version,
-          :version_type ].freeze)
+        :term_statistics,
+        :field_statistics,
+        :fields,
+        :offsets,
+        :positions,
+        :payloads,
+        :preference,
+        :routing,
+        :realtime,
+        :version,
+        :version_type
+      ].freeze)
+    end
     end
-  end
 end

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

@@ -5,92 +5,56 @@
 module Elasticsearch
   module API
     module Actions
+      # Updates a document with a script or partial document.
+      #
+      # @option arguments [String] :id Document ID
+      # @option arguments [String] :index The name of the index
+      # @option arguments [String] :type The type of the document   *Deprecated*
+      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update 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 [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 [String] :lang The script language (default: painless)
+      # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
+      #   (options: true,false,wait_for)
 
-      # Update a document without sending the whole document in the request ("partial update").
-      #
-      # Send either a partial document (`doc` ) which will be deeply merged into an existing document,
-      # or a `script`, which will update the document content, in the `:body` argument.
-      #
-      # The partial update operation allows you to limit the amount of data you send over the wire and
-      # reduces the chance of failed updates due to conflict.
-      #
-      # Specify the `:version` and `:retry_on_conflict` arguments to balance convenience and consistency.
-      #
-      # @example Update document _title_ using partial `doc`-ument
-      #
-      #     client.update index: 'myindex', type: 'mytype', id: '1',
-      #                   body: { doc: { title: 'Updated' } }
-      #
-      # @example Add a tag to document `tags` property using a `script`
-      #
-      #     client.update index: 'myindex', type: 'mytype', id: '1',
-      #                    body: { script: { source: 'ctx._source.tags.add(params.tag)', params: { tag: 'x' } } }
-      #
-      # @example Increment a document counter by 1 _or_ initialize it, when the document does not exist
-      #
-      #     client.update index: 'myindex', type: 'mytype', id: '666',
-      #                   body: { script: 'ctx._source.counter += 1', upsert: { counter: 1 } }
-      #
-      # @example Delete a document if it's tagged "to-delete"
-      #
-      #     client.update index: 'myindex', type: 'mytype', id: '1',
-      #                   body: { script: 'ctx._source.tags.contains(params.tag) ? ctx.op = "delete" : ctx.op = "none"',
-      #                           params: { tag: 'to-delete' } }
-      #
-      # @option arguments [String] :id Document ID (*Required*)
-      # @option arguments [Number,List] :ignore The list of HTTP errors to ignore; only `404` supported at the moment
-      # @option arguments [String] :index The name of the index (*Required*)
-      # @option arguments [String] :type The type of the document (*Required*)
-      # @option arguments [Hash] :body The request definition using either `script` or partial `doc` (*Required*)
-      # @option arguments [String] :consistency Explicit write consistency setting for the operation
-      #                                         (options: one, quorum, all)
-      # @option arguments [List] :fields A comma-separated list of fields to return in the response
-      # @option arguments [Boolean] :include_type_name Whether a type should be expected in the body of the mappings.
-      # @option arguments [String] :lang The script language (default: mvel)
-      # @option arguments [String] :parent ID of the parent document
-      # @option arguments [String] :percolate Perform percolation during the operation;
-      #                                       use specific registered query name, attribute, or wildcard
-      # @option arguments [Boolean] :refresh Refresh the index after performing the operation
-      # @option arguments [String] :replication Specific replication type (options: sync, async)
-      # @option arguments [Number] :retry_on_conflict Specify how many times should the operation be retried
-      #                                               when a conflict occurs (default: 0)
+      # @option arguments [Number] :retry_on_conflict Specify how many times should the operation be retried when a conflict occurs (default: 0)
       # @option arguments [String] :routing Specific routing value
-      # @option arguments [String] :script The URL-encoded script definition (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 [Time] :timeout Explicit operation timeout
-      # @option arguments [Time] :timestamp Explicit timestamp for the document
-      # @option arguments [Duration] :ttl Expiration time for the document
-      # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [Number] :version_type Explicit version number for concurrency control
+      # @option arguments [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number
+      # @option arguments [Number] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term
+
+      # @option arguments [Hash] :body The request definition requires either `script` or partial `doc` (*Required*)
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      # @since 0.20
       #
-      # @see http://elasticsearch.org/guide/reference/api/update/
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-update.html
       #
-      def update(arguments={})
+      def update(arguments = {})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
-        arguments[:type] ||= DEFAULT_DOC
-        method = HTTP_POST
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
 
-        if arguments[:type]
-          path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                   Utils.__escape(arguments[:type]),
-                                   Utils.__escape(arguments[:id]),
-                                   '_update'
-        else
-          path   = Utils.__pathify Utils.__escape(arguments[:index]),
-                                   '_update',
-                                   Utils.__escape(arguments[:id])
-        end
+        arguments = arguments.clone
+
+        _id = arguments.delete(:id)
 
+        _index = arguments.delete(:index)
+
+        _type = arguments.delete(:type)
+
+        method = Elasticsearch::API::HTTP_POST
+        path   = if _index && _type && _id
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/#{Utils.__listify(_id)}/_update"
+                 else
+                   "#{Utils.__listify(_index)}/_update/#{Utils.__listify(_id)}"
+  end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
-        params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
 
+        body = arguments[:body]
         if Array(arguments[:ignore]).include?(404)
           Utils.__rescue_from_not_found { perform_request(method, path, params, body).body }
         else
@@ -100,29 +64,20 @@ module Elasticsearch
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:update, [
-          :consistency,
-          :fields,
-          :include_type_name,
-          :lang,
-          :parent,
-          :percolate,
-          :refresh,
-          :replication,
-          :retry_on_conflict,
-          :routing,
-          :script,
-          :_source,
-          :_source_include,
-          :_source_exclude,
-          :timeout,
-          :timestamp,
-          :ttl,
-          :version,
-          :version_type,
-          :if_seq_no,
-          :if_primary_term ].freeze)
+        :wait_for_active_shards,
+        :_source,
+        :_source_excludes,
+        :_source_includes,
+        :lang,
+        :refresh,
+        :retry_on_conflict,
+        :routing,
+        :timeout,
+        :if_seq_no,
+        :if_primary_term
+      ].freeze)
+    end
     end
-  end
 end

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

@@ -5,42 +5,38 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Process every document matching a query, potentially updating it
-      #
-      # @example Update all documents in the index, eg. to pick up new mappings
-      #
-      #     client.update_by_query index: 'articles'
-      #
-      # @example Update a property of documents matching a query in the index
-      #
-      #     client.update_by_query index: 'article',
-      #                            body: {
-      #                              script: { inline: 'ctx._source.views += 1' },
-      #                              query: { match: { title: 'foo' } }
-      #                            }
+      # Performs an update on every document in the index without changing the source,
+      # for example to pick up a mapping change.
       #
-      # @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 (*Required*)
+      # @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  (*Required*)
       # @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 [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 [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR)
+      # @option arguments [String] :default_operator The default operator for query string query (AND or 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 [Number] :from Starting offset (default: 0)
       # @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] :conflicts What to do when the update by query hits version conflicts? (options: abort, proceed)
-      # @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] :conflicts What to do when the update by query hits version conflicts?
+      #   (options: abort,proceed)
+
+      # @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] :pipeline Ingest pipeline to set on index requests made by this action. (default: none)
       # @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 [List] :routing A comma-separated list of specific routing values
       # @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 [String] :search_type Search operation type
+      #   (options: query_then_fetch,dfs_query_then_fetch)
+
       # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout.
-      # @option arguments [Number] :size Number of hits to return (default: 10)
+      # @option arguments [Number] :size Deprecated, please use `max_docs` instead
+      # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents)
       # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
       # @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
@@ -50,69 +46,84 @@ module Elasticsearch
       # @option arguments [Boolean] :version Specify whether to return document version as part of a hit
       # @option arguments [Boolean] :version_type Should the document increment the version number (internal) on hit or not (reindex)
       # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting
-      # @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 update by query 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 [Number] :scroll_size Size on the scroll request powering the update by query
       # @option arguments [Boolean] :wait_for_completion Should the request should block until the update by query operation 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 [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 [Hash] :body The search definition using the Query DSL
+      #
+      # *Deprecation notice*:
+      # Specifying types in urls has been deprecated
+      # Deprecated since version 7.0.0
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html
       #
-      def update_by_query(arguments={})
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-update-by-query.html
+      #
+      def update_by_query(arguments = {})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        method = HTTP_POST
 
-        path   = Utils.__pathify Utils.__listify(arguments[:index]),
-                                 Utils.__listify(arguments[:type]),
-                                 '/_update_by_query'
+        arguments = arguments.clone
 
-        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+        _index = arguments.delete(:index)
 
-        body   = arguments[:body]
+        _type = arguments.delete(:type)
 
+        method = Elasticsearch::API::HTTP_POST
+        path   = if _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_update_by_query"
+                 else
+                   "#{Utils.__listify(_index)}/_update_by_query"
+  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(:update_by_query, [
-          :analyzer,
-          :analyze_wildcard,
-          :default_operator,
-          :df,
-          :from,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :conflicts,
-          :expand_wildcards,
-          :lenient,
-          :pipeline,
-          :preference,
-          :q,
-          :routing,
-          :scroll,
-          :search_type,
-          :search_timeout,
-          :size,
-          :sort,
-          :_source,
-          :_source_excludes,
-          :_source_includes,
-          :terminate_after,
-          :stats,
-          :version,
-          :version_type,
-          :request_cache,
-          :refresh,
-          :timeout,
-          :wait_for_active_shards,
-          :scroll_size,
-          :wait_for_completion,
-          :requests_per_second,
-          :slices ].freeze)
+        :analyzer,
+        :analyze_wildcard,
+        :default_operator,
+        :df,
+        :from,
+        :ignore_unavailable,
+        :allow_no_indices,
+        :conflicts,
+        :expand_wildcards,
+        :lenient,
+        :pipeline,
+        :preference,
+        :q,
+        :routing,
+        :scroll,
+        :search_type,
+        :search_timeout,
+        :size,
+        :max_docs,
+        :sort,
+        :_source,
+        :_source_excludes,
+        :_source_includes,
+        :terminate_after,
+        :stats,
+        :version,
+        :version_type,
+        :request_cache,
+        :refresh,
+        :timeout,
+        :wait_for_active_shards,
+        :scroll_size,
+        :wait_for_completion,
+        :requests_per_second,
+        :slices
+      ].freeze)
+    end
     end
-  end
 end