elasticsearch-api 0.4.11 → 1.0.0.rc1

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

@@ -17,6 +17,8 @@ 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] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-types-exists/
         #
@@ -27,7 +29,8 @@ module Elasticsearch
             :ignore_indices,
             :ignore_unavailable,
             :allow_no_indices,
-            :expand_wildcards
+            :expand_wildcards,
+            :local
           ]
 
           method = 'HEAD'

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

@@ -14,7 +14,7 @@ module Elasticsearch
         #     client.indices.get_alias index: 'log*', name: '2013'
         #
         # @option arguments [List] :index A comma-separated list of index names to filter aliases
-        # @option arguments [List] :name A comma-separated list of alias names to return (*Required*)
+        # @option arguments [List] :name A comma-separated list of alias names to return
         # @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)
@@ -24,16 +24,18 @@ 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] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
         #
         def get_alias(arguments={})
-          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
           valid_params = [
             :ignore_indices,
             :ignore_unavailable,
             :allow_no_indices,
-            :expand_wildcards
+            :expand_wildcards,
+            :local
           ]
 
           method = 'GET'

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

@@ -10,15 +10,18 @@ module Elasticsearch
         #     client.indices.get_aliases
         #
         # @option arguments [List] :index A comma-separated list of index names to filter aliases
+        # @option arguments [List] :name A comma-separated list of alias names to filter
         # @option arguments [Time] :timeout Explicit timestamp for the document
+        # @option arguments [Boolean] :local Return local information,
+        #                                    do not retrieve the state from master node (default: false)
         #
-        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-aliases.html
         #
         def get_aliases(arguments={})
-          valid_params = [ :timeout ]
+          valid_params = [ :timeout, :local ]
 
           method = 'GET'
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_aliases'
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_aliases', Utils.__listify(arguments[:name])
 
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil

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

@@ -46,8 +46,9 @@ module Elasticsearch
           method = 'GET'
           path   = Utils.__pathify(
                      Utils.__listify(arguments[:index]),
+                     '_mapping',
                      Utils.__listify(arguments[:type]),
-                     '_mapping', 'field',
+                     'field',
                      Utils.__listify(arguments[:field])
                    )
           params = Utils.__validate_and_extract_params arguments, valid_params

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

@@ -28,19 +28,24 @@ 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] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
         #
-        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-get-mapping/
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-mapping.html
         #
         def get_mapping(arguments={})
           valid_params = [
             :ignore_indices,
             :ignore_unavailable,
             :allow_no_indices,
-            :expand_wildcards
+            :expand_wildcards,
+            :local
           ]
 
           method = 'GET'
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_mapping'
+          path   = Utils.__pathify Utils.__listify(arguments[:index]),
+                                   '_mapping',
+                                   Utils.__listify(arguments[:type])
           params = Utils.__validate_and_extract_params arguments, valid_params
           body = nil
 

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

@@ -23,6 +23,7 @@ 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 [List] :name The name of the settings that should be included in the response
         # @option arguments [String] :prefix The prefix all settings must have in order to be included
         # @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
@@ -34,6 +35,8 @@ module Elasticsearch
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
         #                                                 unavailable (missing, closed, etc)
         # @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)
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-get-settings/
         #
@@ -44,14 +47,16 @@ module Elasticsearch
             :ignore_unavailable,
             :allow_no_indices,
             :expand_wildcards,
-            :flat_settings
+            :flat_settings,
+            :local
           ]
 
           method = 'GET'
           path   = Utils.__pathify Utils.__listify(arguments[:index]),
                                    Utils.__listify(arguments[:type]),
                                    arguments.delete(:prefix),
-                                   '_settings'
+                                   '_settings',
+                                   Utils.__escape(arguments[:name])
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil
 

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

@@ -39,8 +39,6 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
         #
         def get_warmer(arguments={})
-          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-
           valid_params = [
             :ignore_indices,
             :ignore_unavailable,

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

@@ -24,7 +24,6 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
         #
         def put_alias(arguments={})
-          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
           raise ArgumentError, "Required argument 'name' missing"  unless arguments[:name]
           valid_params = [ :timeout ]
 

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

@@ -17,9 +17,17 @@ module Elasticsearch
         #       }
         #     }
         #
+        # @example Update the mapping for a specific type in all indices
+        #
+        #     client.indices.put_mapping type: 'mytype', body: {
+        #       mytype: {
+        #         dynamic: 'strict'
+        #       }
+        #     }
+        #
         # @option arguments [Hash] :body The mapping definition (*Required*)
-        # @option arguments [List] :index A comma-separated list of index names; use `_all` to perform the operation
-        #                                 on all indices (*Required*)
+        # @option arguments [List] :index A comma-separated list of index names; use `_all` or omit to
+        #                                 update the mapping for all indices
         # @option arguments [String] :type The name of the document type (*Required*)
         # @option arguments [Boolean] :ignore_conflicts Specify whether to ignore conflicts while updating the mapping
         #                                               (default: false)
@@ -38,7 +46,6 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-put-mapping/
         #
         def put_mapping(arguments={})
-          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
           raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
           raise ArgumentError, "Required argument 'body' missing"  unless arguments[:body]
 
@@ -53,7 +60,7 @@ module Elasticsearch
           ]
 
           method = 'PUT'
-          path   = Utils.__pathify Utils.__listify(arguments[:index]), Utils.__escape(arguments[:type]), '_mapping'
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), '_mapping', Utils.__escape(arguments[:type])
 
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = arguments[:body]

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

@@ -38,7 +38,6 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
         #
         def put_warmer(arguments={})
-          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
           raise ArgumentError, "Required argument 'name' missing"  unless arguments[:name]
           raise ArgumentError, "Required argument 'body' missing"  unless arguments[:body]
 

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

@@ -0,0 +1,58 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Perform multiple percolate operations in a single request, similar to the {#msearch} API
+      #
+      # Pass the percolate definitions as header-body pairs in the `:body` argument, as an Array of Hashes.
+      #
+      # @example Perform two different percolations in a single request
+      #
+      #     client.mpercolate \
+      #         body: [
+      #           { percolate: { index: "my-index", type: "my-type" } },
+      #           { doc: { message: "foo bar" } },
+      #           { percolate: { index: "my-other-index", type: "my-other-type", id: "1" } },
+      #           { }
+      #         ]
+      #
+      # @option arguments [String] :index The index of the document being count percolated to use as default
+      # @option arguments [String] :type The type of the document being percolated to use as default.
+      # @option arguments [Array<Hash>]  The percolate request definitions (header & body pairs) (*Required*)
+      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
+      #                                                 unavailable (missing or closed)
+      # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
+      #                                               no concrete indices. (This includes `_all` string or when no
+      #                                               indices have been specified)
+      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are
+      #                                              open, closed or both. (options: open, closed)
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-percolate.html
+      #
+      def mpercolate(arguments={})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        valid_params = [
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards ]
+
+        method = 'GET'
+        path   = "_mpercolate"
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
+        body   = arguments[:body]
+
+        case
+        when body.is_a?(Array)
+          payload = body.map { |d| d.is_a?(String) ? d : MultiJson.dump(d) }
+          payload << "" unless payload.empty?
+          payload = payload.join("\n")
+        else
+          payload = body
+        end
+
+        perform_request(method, path, params, payload).body
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Returns information and statistics about terms in the fields of multiple documents
+      # in a single request/response. The semantics are similar to the {#mget} API.
+      #
+      # @example Return information about multiple documents in a specific index
+      #
+      #     subject.mtermvectors index: 'my-index', type: 'my-type', body: { ids: [1, 2, 3] }
+      #
+      # @option arguments [String] :index The name of the index
+      # @option arguments [String] :type The type of the document
+      # @option arguments [Hash] :body Document identifiers; can be either `docs` (containing full document information)
+      #                                or `ids` (when index and type is provided in the URL (*Required*)
+      # @option arguments [List] :ids A comma-separated list of documents ids (alternative to `:body`)
+      # @option arguments [Boolean] :term_statistics Whether total term frequency and
+      #                                              document frequency should be returned.
+      # @option arguments [Boolean] :field_statistics Whether 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
+      # @option arguments [Boolean] :offsets Whether term offsets should be returned
+      # @option arguments [Boolean] :positions Whether term positions should be returned
+      # @option arguments [Boolean] :payloads Whether 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
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html
+      #
+      # @see #mget
+      # @see #termvector
+      #
+      def mtermvectors(arguments={})
+        valid_params = [
+          :ids,
+          :term_statistics,
+          :field_statistics,
+          :fields,
+          :offsets,
+          :positions,
+          :payloads,
+          :preference,
+          :routing,
+          :parent ]
+
+        ids = arguments.delete(:ids)
+
+        method = 'GET'
+        path   = Utils.__pathify Utils.__escape(arguments[:index]),
+                                 Utils.__escape(arguments[:type]),
+                                 '_mtermvectors'
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
+
+        if ids
+          body = { :ids => ids }
+        else
+          body = arguments[:body]
+        end
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/{cluster/node_hot_threads.rb → nodes/hot_threads.rb}

@@ -1,6 +1,6 @@
 module Elasticsearch
   module API
-    module Cluster
+    module Nodes
       module Actions
 
         # Returns information about the hottest threads in the cluster or on a specific node as a String.
@@ -11,7 +11,7 @@ module Elasticsearch
         #
         # @example Return 10 hottest threads
         #
-        #     client.cluster.node_hot_threads threads: 10
+        #     client.nodes.hot_threads threads: 10
         #
         # @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,
@@ -25,7 +25,7 @@ module Elasticsearch
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-hot-threads/
         #
-        def node_hot_threads(arguments={})
+        def hot_threads(arguments={})
           valid_params = [
             :interval,
             :snapshots,

data/lib/elasticsearch/api/actions/{cluster/node_info.rb → nodes/info.rb}

@@ -1,6 +1,6 @@
 module Elasticsearch
   module API
-    module Cluster
+    module Nodes
       module Actions
 
         # Returns information about nodes in the cluster (cluster settings, JVM version, etc).
@@ -12,7 +12,7 @@ module Elasticsearch
         #
         # @example Return information about JVM
         #
-        #     client.cluster.node_info jvm: true
+        #     client.nodes.info jvm: true
         #
         # @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
@@ -31,7 +31,7 @@ module Elasticsearch
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/
         #
-        def node_info(arguments={})
+        def info(arguments={})
           valid_params = [
             :all,
             :clear,

data/lib/elasticsearch/api/actions/{cluster/node_shutdown.rb → nodes/shutdown.rb}

@@ -1,13 +1,13 @@
 module Elasticsearch
   module API
-    module Cluster
+    module Nodes
       module Actions
 
         # Shutdown one or all nodes
         #
         # @example Shut down node named _Bloke_
         #
-        #     client.cluster.node_shutdown node_id: 'Bloke'
+        #     client.nodes.shutdown node_id: 'Bloke'
         #
         # @option arguments [List] :node_id A comma-separated list of node IDs or names to perform the operation on; use
         #                                   `_local` to shutdown the node you're connected to, leave empty to
@@ -17,7 +17,7 @@ module Elasticsearch
         #
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown/
         #
-        def node_shutdown(arguments={})
+        def shutdown(arguments={})
           valid_params = [
             :delay,
             :exit ]

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

@@ -0,0 +1,79 @@
+module Elasticsearch
+  module API
+    module Nodes
+      module Actions
+
+        # Returns statistical information about nodes in the cluster.
+        #
+        # @example Return statistics about JVM
+        #
+        #     client.nodes.stats metric: 'jvm'
+        #
+        # @example Return statistics about field data structures for all fields
+        #
+        #     client.nodes.stats metric: 'indices', index_metric: 'fielddata', fields: '*', human: true
+        #
+        # @option arguments [List] :metric Limit the information returned to the specified metrics
+        #                                  (options: _all, breaker, fs, http, indices, jvm, network,
+        #                                  os, process, thread_pool, transport)
+        # @option arguments [List] :index_metric Limit the information returned for the `indices` metric
+        #                                        to the specified index metrics. Used only when
+        #                                        `indices` or `all` metric is specified.
+        #                                  (options: _all, completion, docs, fielddata, filter_cache, flush, get,
+        #                                  id_cache, indexing, merge, percolate, refresh, search, segments, store,
+        #                                  warmer)
+        # @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] :completion_fields A comma-separated list of fields for `fielddata` and `suggest`
+        #                                             index metrics (supports wildcards)
+        # @option arguments [List] :fielddata_fields A comma-separated list of fields for `fielddata` index metric
+        #                                            (supports wildcards)
+        # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index
+        #                                  metrics (supports wildcards)
+        # @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
+        #                                   (options: node, indices, shards)
+        # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html
+        #
+        def stats(arguments={})
+          arguments = arguments.clone
+
+          valid_params = [
+            :metric,
+            :index_metric,
+            :node_id,
+            :completion_fields,
+            :fielddata_fields,
+            :fields,
+            :groups,
+            :human,
+            :level,
+            :types ]
+
+          method = 'GET'
+
+          path   = Utils.__pathify '_nodes',
+                                   Utils.__listify(arguments[:node_id]),
+                                   'stats',
+                                   Utils.__listify(arguments.delete(:metric)),
+                                   Utils.__listify(arguments.delete(:index_metric))
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+
+          [:completion_fields, :fielddata_fields, :fields, :groups, :types].each do |key|
+            params[key] = Utils.__listify(params[key]) if params[key]
+          end
+
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end