elasticsearch-api 1.0.1 → 1.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGQwODMzZmNlYjgzMjE4OTQ4OGI4ZGIzM2VkYTA1NjAyZTYwZDI3ZQ==
+  data.tar.gz: !binary |-
+    ZjY0YzIzZWUyOTA3YjFkYjFhZjc5NjNlN2UwMWM2NmFhZDViNzZkYw==
+SHA512:
+  metadata.gz: !binary |-
+    ZmQyYmNiYzI0ODI4MzFiYmExZDU3Njc1ZmVlOGNmMTZkNGUxMWJjNzE3Yzhi
+    ZjllODY2OTAzMjViZDBhZGJkYjU5OGRjNWNhYmE1NzYwM2JlNmM4NDZkZDRl
+    YmVhZDM0MmJkNjhmMzU2MjBlZmYyNjBjMTdmOGQ0NWI3YWRlY2M=
+  data.tar.gz: !binary |-
+    ZDA5NzA2MjI5MDE1YjE1M2RlYzBjNmM0NTA2MDRjMzlmMTkwODA2M2MwNzc3
+    YjgyM2NkMDZjZTIxZDY2ODIxNzg5NDk3ZjczMDY0Yjg2ZDFhYzIyODI5OTgz
+    ZjcxNmQ3MTg0NTI3NzRjNjVhYTQ3MjYxYjYxODIwZTQ4NDg1Yzg=

data/elasticsearch-api.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "elasticsearch-transport"
 
   if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
+    s.add_development_dependency "minitest", "~> 4.0"
     s.add_development_dependency "elasticsearch-extensions"
   end
 
@@ -52,13 +53,13 @@ Gem::Specification.new do |s|
   end
 
   if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
-    s.add_development_dependency "ruby-prof" unless defined? JRUBY_VERSION
+    s.add_development_dependency "ruby-prof" unless defined?(JRUBY_VERSION) || defined?(Rubinius)
     s.add_development_dependency "jbuilder"
     s.add_development_dependency "escape_utils" unless defined? JRUBY_VERSION
     s.add_development_dependency "simplecov"
     s.add_development_dependency "simplecov-rcov"
     s.add_development_dependency "cane"
-    s.add_development_dependency "require-prof"
+    s.add_development_dependency "require-prof" unless defined?(JRUBY_VERSION) || defined?(Rubinius)
     s.add_development_dependency "coveralls"
   end
 

data/lib/elasticsearch/api.rb

@@ -21,7 +21,8 @@ module Elasticsearch
 
     COMMON_QUERY_PARAMS = [
       :format,                        # Search, Cat, ...
-      :pretty                         # Pretty-print the response
+      :pretty,                        # Pretty-print the response
+      :human                          # Return numeric values in human readable format
     ]
 
     # Auto-include all namespaces in the receiver

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

@@ -0,0 +1,27 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Abort a running benchmark
+      #
+      # @example
+      #
+      #     client.abort_benchmark name: 'my_benchmark'
+      #
+      # @option arguments [String] :name A benchmark name
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html
+      #
+      def abort_benchmark(arguments={})
+        valid_params = [
+           ]
+        method = 'POST'
+        path   = "_bench/abort/#{arguments[:name]}"
+        params = {}
+        body   = nil
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Run a single query, or a set of queries, and return statistics on their performance
+      #
+      # @example Return statistics for a single query
+      #
+      #     client.benchmark body: {
+      #       name: 'my_benchmark',
+      #       competitors: [
+      #         {
+      #           name: 'query_1',
+      #           requests: [
+      #             { query: { match: { _all: 'a*' } } }
+      #           ]
+      #         }
+      #       ]
+      #     }
+      #
+      # @example Return statistics for a set of "competing" queries
+      #
+      #     client.benchmark body: {
+      #       name: 'my_benchmark',
+      #       competitors: [
+      #         {
+      #           name: 'query_a',
+      #           requests: [
+      #             { query: { match: { _all: 'a*' } } }
+      #           ]
+      #         },
+      #         {
+      #           name: 'query_b',
+      #           requests: [
+      #             { query: { match: { _all: 'b*' } } }
+      #           ]
+      #         }
+      #       ]
+      #     }
+      #
+      # @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 [String] :type The name of the document type
+      # @option arguments [Hash] :body The search definition using the Query DSL
+      # @option arguments [Boolean] :verbose Specify whether to return verbose statistics about each iteration
+      #                                      (default: false)
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html
+      #
+      def benchmark(arguments={})
+        valid_params = [
+          :verbose ]
+        method = 'PUT'
+        path   = "_bench"
+        params = Utils.__validate_and_extract_params arguments, valid_params
+        body   = arguments[:body]
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Return information about field data usage across the cluster
+        #
+        # @example Return the total size of field data
+        #
+        #     client.cat.fielddata
+        #
+        # @example Return both the total size and size for specific fields
+        #
+        #     client.cat.fielddata fields: 'title,body'
+        #
+        # @option arguments [List] :fields A comma-separated list of fields to include in the output
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, m, g)
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
+        #                                   (default: false)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @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.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html
+        #
+        def fielddata(arguments={})
+          valid_params = [
+            :bytes,
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v,
+            :fields ]
+
+          fields = arguments.delete(:fields)
+
+          method = 'GET'
+          path   = Utils.__pathify "_cat/fielddata", Utils.__listify(fields)
+          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/cluster/health.rb

@@ -5,10 +5,14 @@ module Elasticsearch
 
         # Returns information about cluster "health".
         #
-        # @example
+        # @example Get the cluster health information
         #
         #     client.cluster.health
         #
+        # @example Block the request until the cluster is in the "yellow" state
+        #
+        #     client.cluster.health wait_for_status: 'yellow'
+        #
         # @option arguments [String] :index Limit the information returned to a specific index
         # @option arguments [String] :level Specify the level of detail for returned information
         #                                   (options: cluster, indices, shards)

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

@@ -12,7 +12,8 @@ module Elasticsearch
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or omit to
         #                                 perform the operation on all indices
         # @option arguments [List] :metric Limit the information returned to the specified metrics
-        #                                 (options: _all, blocks, index_templates, metadata, nodes, routing_table)
+        #                                 (options: _all, blocks, index_templates, metadata, nodes, routing_table,
+        #                                  master_node, version)
         # @option arguments [List] :index_templates A comma separated list to return specific index templates when
         #                                           returning metadata
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node

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

@@ -44,7 +44,7 @@ module Elasticsearch
       # @option arguments [String] :percolate_index The index to percolate the document into. Defaults to passed `index`.
       # @option arguments [String] :percolate_type The type to percolate document into. Defaults to passed `type`.
       # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external)
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
       #
       # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-percolate.html
       #

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

@@ -24,7 +24,7 @@ module Elasticsearch
       # @option arguments [String] :routing Specific routing value
       # @option arguments [Time] :timeout Explicit operation timeout
       # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external)
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
       #
       # @see http://elasticsearch.org/guide/reference/api/delete/
       #

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

@@ -22,6 +22,8 @@ module Elasticsearch
       # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
       # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
       # @option arguments [String] :routing Specific routing value
+      # @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] :_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
@@ -41,6 +43,8 @@ module Elasticsearch
           :realtime,
           :refresh,
           :routing,
+          :version,
+          :version_type,
           :_source,
           :_source_include,
           :_source_exclude ]

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

@@ -16,7 +16,6 @@ module Elasticsearch
       # By default, the document will be available for {Actions#get} immediately, for {Actions#search} only
       # after an index refresh operation has been performed (either automatically or manually).
       #
-      #
       # @example Create or update a document `myindex/mytype/1`
       #
       #     client.index index: 'myindex',
@@ -30,6 +29,27 @@ module Elasticsearch
       #                   counter: 1
       #                 }
       #
+      # @example Refresh the index after the operation (useful e.g. in integration tests)
+      #
+      #     client.index index: 'myindex', type: 'mytype', id: '1', body: { title: 'TEST' }, refresh: true
+      #     client.search index: 'myindex', q: 'title:test'
+      #
+      # @example Create a document with a specific expiration time (TTL)
+      #
+      #     # Decrease the default housekeeping interval first:
+      #     client.cluster.put_settings body: { transient: { 'indices.ttl.interval' => '1s' } }
+      #
+      #     # Enable the `_ttl` property for all types within the index
+      #     client.indices.create index: 'myindex', body: { mappings: { mytype: { _ttl: { enabled: true } }  } }
+      #
+      #     client.index index: 'myindex', type: 'mytype', id: '1', body: { title: 'TEST' }, ttl: '5s'
+      #
+      #     sleep 3 and client.get index: 'myindex', type: 'mytype', id: '1'
+      #     # => {"_index"=>"myindex" ... "_source"=>{"title"=>"TEST"}}
+      #
+      #     sleep 3 and client.get index: 'myindex', type: 'mytype', id: '1'
+      #     # => Elasticsearch::Transport::Transport::Errors::NotFound: [404] ...
+      #
       # @option arguments [String] :id Document ID (optional, will be auto-generated if missing)
       # @option arguments [String] :index The name of the index (*Required*)
       # @option arguments [String] :type The type of the document (*Required*)
@@ -46,7 +66,7 @@ module Elasticsearch
       # @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 [String] :version_type Specific version type (options: internal, external)
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
       #
       # @see http://elasticsearch.org/guide/reference/api/index_/
       #

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

@@ -5,13 +5,17 @@ module Elasticsearch
 
         # Get a single index template.
         #
+        # @example Get all templates
+        #
+        #     client.indices.get_template
+        #
         # @example Get a template named _mytemplate_
         #
         #     client.indices.get_template name: 'mytemplate'
         #
         # @note Use the {Cluster::Actions#state} API to get a list of all templates.
         #
-        # @option arguments [String] :name The name of the template (*Required*)
+        # @option arguments [String] :name The name of the template (supports wildcards)
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
         #

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

@@ -25,6 +25,8 @@ module Elasticsearch
         #                                              are open, closed or both. (options: open, closed)
         # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation
         #                                    (default: true)
+        # @option arguments [Boolean] :force Force a merge operation to run, even when the index has a single segment
+        #                                    (default: true)
         # @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
@@ -48,6 +50,7 @@ module Elasticsearch
             :allow_no_indices,
             :expand_wildcards,
             :flush,
+            :force,
             :master_timeout,
             :max_num_segments,
             :only_expunge_deletes,

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

@@ -5,11 +5,10 @@ module Elasticsearch
 
         # Create or update an index template.
         #
-        #
         # @example Create a template for all indices starting with `logs-`
         #
-        #     client.indices.put_template :name => 'foo',
-        #                                 :body => { template: 'logs-*', settings: { 'index.number_of_shards' => 1 } }
+        #     client.indices.put_template name: 'foo',
+        #                                 body: { template: 'logs-*', settings: { 'index.number_of_shards' => 1 } }
         #
         # @option arguments [String] :name The name of the template (*Required*)
         # @option arguments [Hash] :body The template definition (*Required*)

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

@@ -0,0 +1,42 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Return information about shard recovery for one or more indices
+        #
+        # @example Get recovery information for a single index
+        #
+        #     client.indices.recovery index: 'foo'
+        #
+        # @example Get detailed recovery information for multiple indices
+        #
+        #     client.indices.recovery index: ['foo', 'bar'], detailed: true
+        #
+        # @example Get recovery information for all indices
+        #
+        #     client.indices.recovery
+        #
+        # @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] :detailed Whether to display detailed information about shard recovery
+        # @option arguments [Boolean] :active_only Display only those recoveries that are currently on-going
+        # @option arguments [Boolean] :human Whether to return time and byte values in human readable format
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html
+        #
+        def recovery(arguments={})
+          valid_params = [
+            :detailed,
+            :active_only,
+            :human ]
+          method = 'GET'
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_recovery'
+          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/indices/stats.rb

@@ -9,35 +9,34 @@ module Elasticsearch
         # how much time did indexing, search and other operations take, how much disk space it takes,
         # how much memory filter caches or field data require, etc.
         #
-        # @example Get default statistics for all indices
+        # @example Get all available statistics for all indices
         #
         #     client.indices.stats
         #
-        # @example Get all available statistics for a single index
+        # @example Get statistics for a single index
         #
-        #     client.indices.stats index: 'foo', all: true
+        #     client.indices.stats index: 'foo'
         #
         # @example Get statistics about documents and disk size for multiple indices
         #
-        #     client.indices.stats index: ['foo', 'bar'], clear: true, docs: true, store: true
+        #     client.indices.stats index: ['foo', 'bar'], docs: true, store: true
         #
-        # @example Get statistics about filter cache and field data, for all indices
+        # @example Get statistics about filter cache and field data for all fields
         #
-        #     client.indices.stats clear: true, fielddata: true , filter_cache: true, fields: '*'
+        #     client.indices.stats fielddata: true, filter_cache: true
         #
-        # @example Get statistics about searches, with segmentation for different search groups
+        # @example Get statistics about filter cache and field data for specific fields
         #
-        #     client.indices.stats clear: true, search: true , groups: ['groupA', 'groupB']
+        #     client.indices.stats fielddata: true, filter_cache: true, fields: 'created_at,tags'
         #
-        # @since The `fielddata`, `filter_cache` and `id_cache` metrics are available from version 0.90.
+        # @example Get statistics about filter cache and field data per field for all fields
+        #
+        #     client.indices.stats fielddata: true, filter_cache: true, fields: '*'
+        #
+        # @example Get statistics about searches, with segmentation for different search groups
+        #
+        #     client.indices.stats search: true, groups: ['groupA', 'groupB']
         #
-        # @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] :all Return all available information
-        # @option arguments [Boolean] :clear Reset the default level of detail
         # @option arguments [Boolean] :docs Return information about indexed and deleted documents
         # @option arguments [Boolean] :fielddata Return information about field data
         # @option arguments [Boolean] :fields A comma-separated list of fields for `fielddata` metric (supports wildcards)
@@ -46,51 +45,58 @@ module Elasticsearch
         # @option arguments [Boolean] :get Return information about get operations
         # @option arguments [Boolean] :groups A comma-separated list of search groups for `search` statistics
         # @option arguments [Boolean] :id_cache Return information about ID cache
-        # @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 [List] :index A comma-separated list of index names; use `_all` or empty string
         #                                 to perform the operation on all indices
         # @option arguments [Boolean] :indexing Return information about indexing operations
-        # @option arguments [List] :indexing_types A comma-separated list of document types to include
-        #                                          in the `indexing` statistics
+        # @option arguments [List] :types A comma-separated list of document types to include in the `indexing` info
         # @option arguments [Boolean] :merge Return information about merge operations
         # @option arguments [Boolean] :refresh Return information about refresh operations
         # @option arguments [Boolean] :search Return information about search operations; use the `groups` parameter to
         #                                     include information for specific search groups
-        # @option arguments [List] :search_groups A comma-separated list of search groups to include
-        #                                         in the `search` statistics
+        # @option arguments [List] :groups A comma-separated list of search groups to include in the `search` statistics
+        # @option arguments [Boolean] :suggest Return information about suggest statistics
         # @option arguments [Boolean] :store Return information about the size of the index
         # @option arguments [Boolean] :warmer Return information about warmers
+        # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
+        #                                                 unavailable (missing, closed, etc)
+        # @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)
         #
-        # @see http://elasticsearch.org/guide/reference/api/admin-indices-stats/
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-stats.html
         #
         def stats(arguments={})
-          valid_params = [
-            :all,
-            :clear,
+          valid_parts = [
             :docs,
             :fielddata,
-            :fields,
             :filter_cache,
             :flush,
             :get,
-            :groups,
-            :id_cache,
-            :ignore_indices,
-            :ignore_unavailable,
-            :allow_no_indices,
-            :expand_wildcards,
             :indexing,
             :merge,
             :refresh,
             :search,
+            :suggest,
             :store,
             :warmer ]
 
+          valid_params = [
+            :fields,
+            :completion_fields,
+            :fielddata_fields,
+            :groups,
+            :types,
+            :ignore_indices,
+            :ignore_unavailable,
+            :allow_no_indices,
+            :expand_wildcards ]
+
           method = 'GET'
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_stats'
+
+          parts  = Utils.__extract_parts arguments, valid_parts
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_stats', Utils.__listify(parts)
 
           params = Utils.__validate_and_extract_params arguments, valid_params
           params[:fields] = Utils.__listify(params[:fields]) if params[:fields]