elasticsearch-api 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cc08537b5dbcbca7ec02089ab9ee7a7e287de92
-  data.tar.gz: e01a7be115aa6647b862986416b2d07d15c43dbe
+  metadata.gz: 4c481f1950627254aa828e2f5b0618bb85d2c636
+  data.tar.gz: 7f926b2449c1b1cf88bff4595f01ce573c73aa71
 SHA512:
-  metadata.gz: 570952fbd8ba30c8ddaf3eff9e9817962208641bd9ed04b5192a165bd54d8d007aea0f1301196ab45e053bc3e20fe4cb1442de3a63a3c7da58a685f94ce31b04
-  data.tar.gz: 0ac3db83470814d07bcfd742f36d39e0f80c10a16515cf74789ddc8eeac62de579cd502f693c0ddae71a10226d1951f067cf6d45b544ee0bae0568ec32094bc4
+  metadata.gz: 53aad6b5e65b3958c7c4b1aa9572c74a36492f8ac316628c3f147bf9c909cd9f55dc0b93b002c49ba4d439e0a94dfc6ba46eb82cce9f7977b120151f188fd1ac
+  data.tar.gz: dacb2b8fdb3c759edc520786aea48519bea340b7df091ded51b9237043391b8a83109949a83ae497a6a0539d4e9004edb74514b2725bf436b1571b719f274437

data/lib/elasticsearch/api.rb

@@ -22,6 +22,7 @@ module Elasticsearch
     ]
 
     COMMON_QUERY_PARAMS = [
+      :ignore,                        # Client specific parameters
       :format,                        # Search, Cat, ...
       :pretty,                        # Pretty-print the response
       :human,                         # Return numeric values in human readable format

data/lib/elasticsearch/api/actions/cat/nodes.rb

@@ -25,6 +25,7 @@ module Elasticsearch
         #
         #     client.cat.nodes format: 'json'
         #
+        # @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false)
         # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
         # @option arguments [Boolean] :v Display column headers as part of the output
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
@@ -38,6 +39,7 @@ module Elasticsearch
         #
         def nodes(arguments={})
           valid_params = [
+            :full_id,
             :local,
             :master_timeout,
             :h,

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

@@ -15,55 +15,85 @@ module Elasticsearch
       #
       #     client.delete_by_query index: 'myindex', body: { query: { term: { published: false } } }
       #
-      # @option arguments [List] :index A comma-separated list of indices to restrict the operation;
-      #                                 use `_all`to perform the operation on all indices (*Required*)
-      # @option arguments [List] :type A comma-separated list of types to restrict the operation
-      # @option arguments [Hash] :body A query to restrict the operation
+      # @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 (*Required*)
       # @option arguments [String] :analyzer The analyzer to use for the query string
-      # @option arguments [String] :consistency Specific write consistency setting for the operation
-      #                                         (options: one, quorum, all)
-      # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
-      #                                              (options: AND, OR)
+      # @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] :df The field to use as default where no field prefix is given in the query string
-      # @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)
-      # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore
-      #                                            `missing` ones (options: none, missing) @until 1.0
-      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
-      #                                                 unavailable (missing, closed, etc)
-      # @option arguments [String] :replication Specific replication type (options: sync, async)
+      # @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 delete-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] :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 [String] :routing Specific routing value
-      # @option arguments [String] :source The URL-encoded query definition (instead of using the request body)
-      # @option arguments [Time] :timeout Explicit operation timeout
+      # @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 [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 [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_exclude A list of fields to exclude from the returned _source field
+      # @option arguments [List] :_source_include 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 [Boolean] :version Specify whether to return document version as part of a 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 [Boolean] :refresh Should the effected 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 delete 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 delete-by-query is complete.
+      # @option arguments [Number] :requests_per_second The throttle for this request in sub-requests per second. -1 means no throttle.
+      # @option arguments [Integer] :slices The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks.
       #
-      # @see http://www.elasticsearch.org/guide/reference/api/delete-by-query/
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html
       #
       def delete_by_query(arguments={})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
 
         valid_params = [
           :analyzer,
-          :consistency,
+          :analyze_wildcard,
           :default_operator,
           :df,
-          :ignore_indices,
+          :from,
           :ignore_unavailable,
           :allow_no_indices,
+          :conflicts,
           :expand_wildcards,
-          :replication,
+          :lenient,
+          :preference,
           :q,
           :routing,
-          :source,
-          :timeout ]
+          :scroll,
+          :search_type,
+          :search_timeout,
+          :size,
+          :sort,
+          :_source,
+          :_source_exclude,
+          :_source_include,
+          :terminate_after,
+          :stats,
+          :version,
+          :request_cache,
+          :refresh,
+          :timeout,
+          :wait_for_active_shards,
+          :scroll_size,
+          :wait_for_completion,
+          :requests_per_second,
+          :slices ]
 
-        method = HTTP_DELETE
+        method = HTTP_POST
         path   = Utils.__pathify Utils.__listify(arguments[:index]),
                                  Utils.__listify(arguments[:type]),
-                                 '/_query'
+                                 '/_delete_by_query'
 
         params = Utils.__validate_and_extract_params arguments, valid_params
         body   = arguments[:body]

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

@@ -7,7 +7,7 @@ module Elasticsearch
       # The `index` API will either _create_ a new document, or _update_ an existing one, when a document `:id`
       # is passed. When creating a document, an ID will be auto-generated, when it's not passed as an argument.
       #
-      # You can specifically enforce the _create_ operation by settint the `op_type` argument to `create`, or
+      # You can specifically enforce the _create_ operation by setting the `op_type` argument to `create`, or
       # by using the {Actions#create} method.
       #
       # Optimistic concurrency control is performed, when the `version` argument is specified. By default,

data/lib/elasticsearch/api/actions/indices/stats.rb

@@ -71,6 +71,8 @@ module Elasticsearch
         # @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] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files. Only applies if segment stats are requested. (default: false)
+        #
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-stats.html
         #
         def stats(arguments={})
@@ -99,7 +101,8 @@ module Elasticsearch
             :ignore_indices,
             :ignore_unavailable,
             :allow_no_indices,
-            :expand_wildcards ]
+            :expand_wildcards,
+            :include_segment_file_sizes ]
 
           method = HTTP_GET
 

data/lib/elasticsearch/api/actions/indices/validate_query.rb

@@ -13,9 +13,12 @@ module Elasticsearch
         #
         #     client.indices.validate_query index: 'myindex', q: '[[[ BOOM! ]]]', explain: true
         #
-        # @example Validate a DSL query (with explanation)
+        # @example Validate a DSL query (with explanation and rewrite). With rewrite set to true, the 
+        #                                explanation is more detailed showing the actual Lucene query that will 
+        #                                be executed.
         #
         #     client.indices.validate_query index: 'myindex',
+        #                                   rewrite: true,
         #                                   explain: true,
         #                                   body: {
         #                                     filtered: {
@@ -64,6 +67,7 @@ module Elasticsearch
         #
         def validate_query(arguments={})
           valid_params = [
+            :rewrite,
             :explain,
             :ignore_unavailable,
             :allow_no_indices,

data/lib/elasticsearch/api/actions/nodes/stats.rb

@@ -32,6 +32,7 @@ module Elasticsearch
         #                                            (supports wildcards)
         # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index
         #                                  metrics (supports wildcards)
+        # @option arguments [Boolean] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files. Only applies if segment stats are requested. (default: false)
         # @option arguments [Boolean] :groups A comma-separated list of search groups for `search` index metric
         # @option arguments [Boolean] :human Whether to return time and byte values in human-readable format
         # @option arguments [String] :level Specify the level for aggregating indices stats
@@ -51,6 +52,7 @@ module Elasticsearch
             :completion_fields,
             :fielddata_fields,
             :fields,
+            :include_segment_file_sizes,
             :groups,
             :human,
             :level,

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

@@ -2,7 +2,7 @@ module Elasticsearch
   module API
     module Actions
 
-      # Returns true if the cluster returns a sucessfull HTTP response, false otherwise.
+      # Returns true if the cluster returns a successful HTTP response, false otherwise.
       #
       # @example
       #

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

@@ -7,7 +7,8 @@ module Elasticsearch
       # 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.
       #
-      # "Scrolling" the results is frequently used with the `scan` search type.
+      # 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
       #
@@ -24,8 +25,13 @@ module Elasticsearch
       #     1_000.times do |i| client.index index: 'test', type: 'test', id: i+1, body: {title: "Test #{i}"} end
       #     client.indices.refresh index: 'test'
       #
-      #     # Open the "view" of the index with the `scan` search_type
-      #     r = client.search index: 'test', search_type: 'scan', scroll: '5m', size: 10
+      #     # 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
       #
       #     # Call the `scroll` API until empty results are returned
       #     while r = client.scroll(scroll_id: r['_scroll_id'], scroll: '5m') and not r['hits']['hits'].empty? do

data/lib/elasticsearch/api/utils.rb

@@ -235,7 +235,7 @@ module Elasticsearch
         end
 
         unless messages.empty?
-          if terminal = STDERR.tty?
+          if STDERR.tty?
             STDERR.puts messages.map { |m| "\e[31;1m#{m}\e[0m" }.join("\n")
           else
             STDERR.puts messages.join("\n")
@@ -251,11 +251,11 @@ module Elasticsearch
 
         message += ". This method is not supported in the version you're using: #{Elasticsearch::API::VERSION}, and will be removed in the next release."
 
-        if terminal = STDERR.tty?
-            STDERR.puts "\e[31;1m#{message}\e[0m"
-          else
-            STDERR.puts message
-          end
+        if STDERR.tty?
+          STDERR.puts "\e[31;1m#{message}\e[0m"
+        else
+          STDERR.puts message
+        end
       end
 
       extend self

data/lib/elasticsearch/api/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module API
-    VERSION = "5.0.0"
+    VERSION = "5.0.1"
   end
 end

data/test/integration/yaml_test_runner.rb

@@ -231,39 +231,44 @@ module Elasticsearch
         skip = actions.select { |a| a['skip'] }.first
         $stderr.puts "SKIP: #{skip.inspect}" if ENV['DEBUG']
 
-        # Skip version
-        if skip && skip['skip']['version']
+        def skip_version(skip)
+          if skip && skip['skip']['version']
 
-          return skip['skip']['reason'] ? skip['skip']['reason'] : true if skip['skip']['version'] == 'all'
+            return skip['skip']['reason'] ? skip['skip']['reason'] : true if skip['skip']['version'] == 'all'
 
-          min, max = skip['skip']['version'].split('-').map(&:strip)
+            min, max = skip['skip']['version'].split('-').map(&:strip)
 
-          min_normalized = sprintf "%03d-%03d-%03d",
-                           *min.split('.')
-                               .map(&:to_i)
-                               .fill(0, min.split('.').length, 3-min.split('.').length)
+            min_normalized = sprintf "%03d-%03d-%03d",
+                             *min.split('.')
+                                 .map(&:to_i)
+                                 .fill(0, min.split('.').length, 3-min.split('.').length)
 
-          max_normalized = sprintf "%03d-%03d-%03d",
-                           *max.split('.')
-                               .map(&:to_i)
-                               .map(&:to_i)
-                               .fill(0, max.split('.').length, 3-max.split('.').length)
+            max_normalized = sprintf "%03d-%03d-%03d",
+                             *max.split('.')
+                                 .map(&:to_i)
+                                 .map(&:to_i)
+                                 .fill(0, max.split('.').length, 3-max.split('.').length)
 
-          es_normalized  = sprintf "%03d-%03d-%03d", *$es_version.split('.').map(&:to_i)
+            es_normalized  = sprintf "%03d-%03d-%03d", *$es_version.split('.').map(&:to_i)
 
-          if ( min.empty? || min_normalized <= es_normalized ) && ( max.empty? || max_normalized >= es_normalized )
-            return skip['skip']['reason'] ? skip['skip']['reason'] : true
+            if ( min.empty? || min_normalized <= es_normalized ) && ( max.empty? || max_normalized >= es_normalized )
+              return skip['skip']['reason'] ? skip['skip']['reason'] : true
+            end
+
+            return false
           end
+        end
 
-        # Skip features
-        elsif skip && skip['skip']['features']
-          skip_features = skip['skip']['features'].respond_to?(:split) ? skip['skip']['features'].split(',') : skip['skip']['features']
-          if ( skip_features & SKIP_FEATURES.split(',') ).size > 0
-            return skip['skip']['features']
+        def skip_features(skip)
+          if skip && skip['skip']['features']
+            skip_features = skip['skip']['features'].respond_to?(:split) ? skip['skip']['features'].split(',') : skip['skip']['features']
+            if ( skip_features & SKIP_FEATURES.split(',') ).size > 0
+              return skip['skip']['features']
+            end
           end
         end
 
-        return false
+        return skip_version(skip) || skip_features(skip)
       end
 
       extend self
@@ -401,6 +406,10 @@ suites.each do |suite|
             actions.each do |action|
               $stderr.puts "ACTION: #{action.inspect}" if ENV['DEBUG']
 
+              # This check verifies that the YAML has correct indentation.
+              # See https://github.com/elastic/elasticsearch/issues/21980
+              raise "INVALID YAML: #{action.inspect}" if action.keys.size != 1
+
               case
 
                 # --- Perform action ------------------------------------------

data/test/unit/delete_by_query_test.rb

@@ -15,8 +15,8 @@ module Elasticsearch
 
         should "perform correct request" do
           subject.expects(:perform_request).with do |method, url, params, body|
-            assert_equal 'DELETE', method
-            assert_equal 'foo/_query', url
+            assert_equal 'POST', method
+            assert_equal 'foo/_delete_by_query', url
             assert_equal Hash.new, params
             assert_equal Hash.new, body[:term]
             true
@@ -27,7 +27,7 @@ module Elasticsearch
 
         should "optionally take the :type argument" do
           subject.expects(:perform_request).with do |method, url, params, body|
-            assert_equal 'foo/tweet,post/_query', url
+            assert_equal 'foo/tweet,post/_delete_by_query', url
             true
           end.returns(FakeResponse.new)
 
@@ -36,7 +36,7 @@ module Elasticsearch
 
         should "pass the query in URL parameters" do
           subject.expects(:perform_request).with do |method, url, params, body|
-            assert_equal 'foo/_query', url
+            assert_equal 'foo/_delete_by_query', url
             assert_equal 'foo:bar', params[:q]
             true
           end.returns(FakeResponse.new)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-07 00:00:00.000000000 Z
+date: 2017-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json