elasticsearch-api 1.0.17 → 1.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16dd5c8eba5c64fbac7e4b3e27b703f2118d2b98
-  data.tar.gz: 06672b797640d14a6404b5023ec9eaf390492160
+  metadata.gz: ccbe9ec4450fdf833e93e1c85ac3bd2594959d72
+  data.tar.gz: 10ad273b15eddba62c7ae9f29bd8f60fdf277937
 SHA512:
-  metadata.gz: 5ac5554777c2343765a350d805b3b5dc3e05c5f4f73874cd5d15df32ed8de8506de74b70dedf6dd323cc069884c0fd41bc8fff4a0ed274d2d4ce4517ced49bd5
-  data.tar.gz: 167108c46756ed40056e5d0868bfc0c126443daebddaea04ad7fd25304f22bbf296ff3f0595f05a956e4ada182acbf449a8243e7dfd2cc6c5801b26dd292f524
+  metadata.gz: 32833fc2c378b8c7eea938fab37fb277a815c9b3427d52e13e12df1bfa6dad4a1b1e446c3406ab8c8eb4bbc4e88fae2857e3f024008b6196916935fd8040e423
+  data.tar.gz: 77ae9c0a0688da4c609aa0df47cd4a33d743b2ab643e3d6bb67b5b0b1e4cea2a14e218778dd24a8ef3b87710c51a405cef3832520ceee5ad328a903a7f76bcf1

data/Rakefile

@@ -67,7 +67,8 @@ namespace :test do
 
     # Check if a test cluster is running
     begin
-      client = Elasticsearch::Client.new :host => "localhost:#{ENV['TEST_CLUSTER_PORT'] || 9250}"
+      url = ENV.fetch('TEST_CLUSTER_URL', "http://localhost:#{ENV['TEST_CLUSTER_PORT'] || 9250}")
+      client = Elasticsearch::Client.new :url => url
       es_version_info = client.info['version']
       build_hash      = es_version_info['build_hash']
       cluster_running = true

data/elasticsearch-api.gemspec

@@ -23,7 +23,12 @@ Gem::Specification.new do |s|
   s.add_dependency "multi_json"
 
   s.add_development_dependency "bundler", "> 1"
-  s.add_development_dependency "rake", "< 11.0"
+
+  if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
+    s.add_development_dependency "rake", "~> 11.1"
+  else
+    s.add_development_dependency "rake", "< 11.0"
+  end
 
   s.add_development_dependency "elasticsearch"
   s.add_development_dependency "elasticsearch-transport"

data/lib/elasticsearch/api.rb

@@ -45,6 +45,7 @@ module Elasticsearch
                 Elasticsearch::API::Cluster,
                 Elasticsearch::API::Nodes,
                 Elasticsearch::API::Indices,
+                Elasticsearch::API::Ingest,
                 Elasticsearch::API::Snapshot,
                 Elasticsearch::API::Tasks,
                 Elasticsearch::API::Cat

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

@@ -55,6 +55,7 @@ module Elasticsearch
       # @option arguments [Time]    :timeout Explicit operation timeout
       # @option arguments [String]  :fields Default comma-separated list of fields to return
       #                             in the response for updates
+      # @options arguments [String] :pipeline The pipeline ID to use for preprocessing incoming documents
       #
       # @return [Hash] Deserialized Elasticsearch response
       #
@@ -71,7 +72,8 @@ module Elasticsearch
           :replication,
           :type,
           :timeout,
-          :fields ]
+          :fields,
+          :pipeline ]
 
         method = HTTP_POST
         path   = Utils.__pathify Utils.__escape(arguments[:index]), Utils.__escape(type), '_bulk'

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

@@ -22,7 +22,7 @@ module Elasticsearch
             :help,
             :v ]
           method = 'GET'
-          path   = "/_cat/plugins"
+          path   = "_cat/plugins"
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil
 

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

@@ -0,0 +1,41 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Return currently running tasks
+        #
+        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
+        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
+        # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
+        # @option arguments [Boolean] :detailed Return detailed task information (default: false)
+        # @option arguments [String] :parent_node Return tasks with specified parent node.
+        # @option arguments [Number] :parent_task Return tasks with specified parent task id. Set to -1 to return all.
+        # @option arguments [List] :h Comma-separated list of column names to display
+        # @option arguments [Boolean] :help Return help information
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
+        #
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html
+        #
+        def tasks(arguments={})
+          valid_params = [
+            :format,
+            :node_id,
+            :actions,
+            :detailed,
+            :parent_node,
+            :parent_task,
+            :h,
+            :help,
+            :v ]
+          method = 'GET'
+          path   = "_cat/tasks"
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -23,6 +23,8 @@ module Elasticsearch
         #     puts client.cat.thread_pool h: 'host,ia,is,iq,ir,sa,ss,sq,sr', v: true
         #
         # @option arguments [Boolean] :full_id Display the complete node ID
+        # @option arguments [String] :size The multiplier in which to display values
+        #                                  (Options: k, m, g, t, p)
         # @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 [String] :format The output format. Options: 'text', 'json'; default: 'text'
@@ -36,6 +38,7 @@ module Elasticsearch
         def thread_pool(arguments={})
           valid_params = [
             :full_id,
+            :size,
             :local,
             :master_timeout,
             :h,

data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb

@@ -0,0 +1,26 @@
+module Elasticsearch
+  module API
+    module Cluster
+      module Actions
+
+        # Return the information about why a shard is or isn't allocated
+        #
+        # @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'
+        # @option arguments [Boolean] :include_yes_decisions Return 'YES' decisions in explanation (default: false)
+        #
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html
+        #
+        def allocation_explain(arguments={})
+          valid_params = [
+            :include_yes_decisions ]
+          method = 'GET'
+          path   = "_cluster/allocation/explain"
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = arguments[:body]
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cluster/get_settings.rb

@@ -10,12 +10,15 @@ module Elasticsearch
         #     client.cluster.get_settings
         #
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
+        # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting
+        #                                               (default: false)
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
         #
         def get_settings(arguments={})
           valid_params = [
-            :flat_settings
+            :flat_settings,
+            :include_defaults
           ]
 
           method = HTTP_GET

data/lib/elasticsearch/api/actions/cluster/health.rb

@@ -30,6 +30,9 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-health/
         #
         def health(arguments={})
+          arguments = arguments.clone
+          index     = arguments.delete(:index)
+
           valid_params = [
             :level,
             :local,
@@ -41,7 +44,7 @@ module Elasticsearch
             :wait_for_status ]
 
           method = HTTP_GET
-          path   = "_cluster/health"
+          path   = Utils.__pathify "_cluster/health", Utils.__listify(index)
 
           params = Utils.__validate_and_extract_params arguments, valid_params
           body = nil

data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb

@@ -21,7 +21,7 @@ module Elasticsearch
             :local,
             :master_timeout ]
           method = HTTP_GET
-          path   = "/_cluster/pending_tasks"
+          path   = "_cluster/pending_tasks"
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil
 

data/lib/elasticsearch/api/actions/cluster/reroute.rb

@@ -26,11 +26,13 @@ module Elasticsearch
         #                                     Defaults to all but metadata. (Options: _all, blocks, metadata,
         #                                     nodes, routing_table, master_node, version)
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Boolean] :retry_failed Retries allocation of shards that are blocked due to too many
+        #                                           subsequent allocation failures
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-reroute/
         #
         def reroute(arguments={})
-          valid_params = [ :dry_run, :explain, :metric, :master_timeout, :timeout ]
+          valid_params = [ :dry_run, :explain, :metric, :master_timeout, :retry_failed, :timeout ]
 
           method = HTTP_POST
           path   = "_cluster/reroute"

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

@@ -0,0 +1,30 @@
+module Elasticsearch
+  module API
+    module Cluster
+      module Actions
+
+        # Returns statistical information about the cluster
+        #
+        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
+        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
+        # @option arguments [Boolean] :human Whether to return time and byte values in human-readable format.
+        # @option arguments [Time] :timeout Explicit operation timeout
+        #
+        # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html
+        #
+        def stats(arguments={})
+          valid_params = [
+            :flat_settings,
+            :human,
+            :timeout ]
+          method = 'GET'
+          path   = "_cluster/stats"
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -79,6 +79,7 @@ module Elasticsearch
           :op_type,
           :parent,
           :percolate,
+          :pipeline,
           :refresh,
           :replication,
           :routing,

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

@@ -36,6 +36,8 @@ module Elasticsearch
         # @option arguments [List] :filters A comma-separated list of token filters to use for the analysis.
         #                                   (Also available as the `:token_filters` option)
         # @option arguments [List] :char_filters A comma-separated list of char filters to use for the analysis
+        # @option arguments [Boolean] :explain Whether to output further details (default: false)
+        # @option arguments [List] :attributes A comma-separated list of token attributes to output (use with `:explain`)
         # @option arguments [String] :index The name of the index to scope the operation
         # @option arguments [Boolean] :prefer_local With `true`, specify that a local shard should be used if available,
         #                                           with `false`, use a random shard (default: true)
@@ -50,8 +52,11 @@ module Elasticsearch
           valid_params = [
             :analyzer,
             :char_filters,
+            :explain,
+            :attributes,
             :field,
             :filters,
+            :filter,
             :index,
             :prefer_local,
             :text,

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

@@ -11,7 +11,8 @@ module Elasticsearch
         #
         #     client.indices.close index: 'myindex'
         #
-        # @option arguments [String] :index The name of the index (*Required*)
+        # @option arguments [List] :index A comma separated list of indices to perform the operation on
+        #                                 (*Required*)
         # @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)

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

@@ -60,13 +60,20 @@ module Elasticsearch
         #
         # @option arguments [String] :index The name of the index (*Required*)
         # @option arguments [Hash] :body Optional configuration for the index (`settings` and `mappings`)
+        # @option arguments [Boolean] :update_all_types Whether to update the mapping for all fields
+        #                                               with the same name across all types
         # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Boolean] :master_timeout Timeout for connection to master
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-create-index/
         #
         def create(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-          valid_params = [ :timeout ]
+          valid_params = [
+            :timeout,
+            :master_timeout,
+            :update_all_types
+          ]
 
           method = HTTP_PUT
           path   = Utils.__pathify Utils.__escape(arguments[:index])

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

@@ -12,7 +12,11 @@ module Elasticsearch
         #
         def flush_synced(arguments={})
           valid_params = [
-             ]
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards
+          ]
+
           method = HTTP_POST
           path   = Utils.__pathify Utils.__listify(arguments[:index]), '_flush/synced'
 

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

@@ -7,6 +7,7 @@ module Elasticsearch
         #
         # @option arguments [List] :index A comma-separated list of index names (*Required*)
         # @option arguments [List] :feature A comma-separated list of features
+        #                                   (options: _settings, _mappings, _aliases]
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
         #                                    (default: false)
         # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
@@ -14,6 +15,11 @@ module Elasticsearch
         #                                               indices (default: false)
         # @option arguments [List] :expand_wildcards Whether wildcard expressions should get expanded
         #                                            to open or closed indices (default: open)
+        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
+        # @option arguments [Boolean] :human Whether to return version and creation date values in
+        #                                    human-readable format (default: false)
+        # @option arguments [Boolean] :include_defaults Whether to return all default setting
+        #                                               for each of the indices (default:false)
         #
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-get-index.html
         #
@@ -24,7 +30,10 @@ module Elasticsearch
             :local,
             :ignore_unavailable,
             :allow_no_indices,
-            :expand_wildcards ]
+            :expand_wildcards,
+            :flat_settings,
+            :human,
+            :include_defaults ]
 
           method = HTTP_GET
 

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

@@ -34,6 +34,7 @@ module Elasticsearch
         #                                            `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 [Boolean] :include_defaults Whether to return all default clusters setting
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
         #                                    (default: false)
@@ -45,6 +46,7 @@ module Elasticsearch
             :prefix,
             :ignore_indices,
             :ignore_unavailable,
+            :include_defaults,
             :allow_no_indices,
             :expand_wildcards,
             :flat_settings,

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

@@ -9,7 +9,8 @@ module Elasticsearch
         #
         #     client.indices.open index: 'myindex'
         #
-        # @option arguments [String] :index The name of the index (*Required*)
+        # @option arguments [List] :index A comma separated list of indices to perform the operation on
+        #                                 (*Required*)
         # @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)

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

@@ -40,8 +40,10 @@ module Elasticsearch
         #                                            `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 [Time] :master_timeout Specify timeout for connection to master
+        # @option arguments [Boolean] :update_all_types Whether to update the mapping for all fields
+        #                                               with the same name across all types
         # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [Boolean] :master_timeout Timeout for connection to master
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-put-mapping/
         #
@@ -55,6 +57,7 @@ module Elasticsearch
             :ignore_unavailable,
             :allow_no_indices,
             :expand_wildcards,
+            :update_all_types,
             :master_timeout,
             :timeout
           ]

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

@@ -36,6 +36,10 @@ module Elasticsearch
         #                                            `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 [Boolean] :include_defaults Whether to return all default clusters setting
+        # @option arguments [Boolean] :preserve_existing Whether to update existing settings.
+        #                                                If set to `true` existing settings on an index remain
+        #                                                unchanged, the default is `false`
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
         # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
         #
@@ -47,8 +51,10 @@ module Elasticsearch
           valid_params = [
             :ignore_indices,
             :ignore_unavailable,
+            :include_defaults,
             :allow_no_indices,
             :expand_wildcards,
+            :preserve_existing,
             :master_timeout,
             :flat_settings
           ]

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

@@ -10,15 +10,16 @@ module Elasticsearch
         #
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string
         #                                 to perform the operation on all indices
-        # @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 [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 [Boolean] :verbose Whether to include detailed memory usage by Lucene (default: false)
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-indices-segments/
         #
@@ -27,7 +28,8 @@ module Elasticsearch
             :ignore_indices,
             :ignore_unavailable,
             :allow_no_indices,
-            :expand_wildcards
+            :expand_wildcards,
+            :verbose
           ]
 
           method = HTTP_GET