elasticsearch-api 0.4.11 → 1.0.0.rc1

data/Gemfile

@@ -3,14 +3,10 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in elasticsearch-api.gemspec
 gemspec
 
-if File.exists? File.expand_path("../../elasticsearch-transport", __FILE__)
-  gem 'elasticsearch-transport', :path => File.expand_path("../../elasticsearch-transport", __FILE__), :require => true
-end
-
 if File.exists? File.expand_path("../../elasticsearch-extensions", __FILE__)
   gem 'elasticsearch-extensions', :path => File.expand_path("../../elasticsearch-extensions", __FILE__), :require => true
 end
 
-if File.exists? File.expand_path("../../elasticsearch/elasticsearch.gemspec", __FILE__)
-  gem 'elasticsearch', :path => File.expand_path("../../elasticsearch", __FILE__), :require => false
+if File.exists? File.expand_path("../../elasticsearch-transport", __FILE__)
+  gem 'elasticsearch-transport', :path => File.expand_path("../../elasticsearch-transport", __FILE__), :require => true
 end

data/README.md

@@ -54,18 +54,17 @@ require 'elasticsearch'
 client = Elasticsearch::Client.new log: true
 
 client.index  index: 'myindex', type: 'mytype', id: 1, body: { title: 'Test' }
-# => {"_index"=>"myindex", ... "created"=>true}
+# => {"ok"=>true, "_index"=>"myindex", ...}
 
 client.search index: 'myindex', body: { query: { match: { title: 'test' } } }
 # => {"took"=>2, ..., "hits"=>{"total":5, ...}}
 ```
 
-Full documentation and examples are included as RDoc annotations in the source code
-and available online at <http://rubydoc.info/gems/elasticsearch-api>.
+Full documentation is available at <http://rubydoc.info/gems/elasticsearch-api>.
 
 ### Usage with a custom client
 
-When you want to mix the library into your own client, it must conform to a following _contract_:
+When you want to mix the library into you own client, it must conform to a following _contract_:
 
 * It responds to a `perform_request(method, path, params, body)` method,
 * the method returns an object with `status`, `body` and `headers` methods.

data/lib/elasticsearch/api.rb

@@ -11,14 +11,18 @@ Dir[ File.expand_path('../api/namespace/**/*.rb', __FILE__) ].each { |f| require
 module Elasticsearch
   module API
     COMMON_PARAMS = [
-                      :ignore,                        # Client specific parameters
-                      :index, :type, :id,             # :index/:type/:id
-                      :body,                          # Request body
-                      :node_id,                       # Cluster APIs
-                      :name,                          # Template, warmer APIs
-                      :field,                         # Get field mapping
-                      :pretty                         # Pretty-print the response
-                    ]
+      :ignore,                        # Client specific parameters
+      :index, :type, :id,             # :index/:type/:id
+      :body,                          # Request body
+      :node_id,                       # Cluster
+      :name,                          # Alias, template, settings, warmer, ...
+      :field                          # Get field mapping
+    ]
+
+    COMMON_QUERY_PARAMS = [
+      :format,                        # Search, Cat, ...
+      :pretty                         # Pretty-print the response
+    ]
 
     # Auto-include all namespaces in the receiver
     #
@@ -27,7 +31,10 @@ module Elasticsearch
                 Elasticsearch::API::Common,
                 Elasticsearch::API::Actions,
                 Elasticsearch::API::Cluster,
-                Elasticsearch::API::Indices
+                Elasticsearch::API::Nodes,
+                Elasticsearch::API::Indices,
+                Elasticsearch::API::Snapshot,
+                Elasticsearch::API::Cat
     end
   end
 end

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

@@ -0,0 +1,67 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Returns information about aliases, including associated routing values and filters.
+        #
+        # @example Display all aliases in the cluster
+        #
+        #     puts client.cat.aliases
+        #
+        # @example Display indices for the 'year-2013' alias
+        #
+        #     puts client.cat.aliases name: 'year-2013'
+        #
+        # @example Display header names in the output
+        #
+        #     puts client.cat.aliases v: true
+        #
+        # @example Return only the 'alias' and 'index' columns
+        #
+        #     puts client.cat.aliases h: ['alias', 'index']
+        #
+        # @example Return only the 'alias' and 'index' columns, using short names
+        #
+        #     puts client.cat.aliases h: 'a,i'
+        #
+        # @example Return the information as Ruby objects
+        #
+        #     client.cat.aliases format: 'json'
+        #
+        # @option arguments [List] :name A comma-separated list of alias names to return
+        # @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'
+        # @option arguments [Boolean] :help Return information about headers
+        # @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
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-aliases.html
+        #
+        def aliases(arguments={})
+          valid_params = [
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v ]
+
+          name = arguments.delete(:name)
+
+          method = 'GET'
+
+          path   = Utils.__pathify '_cat/aliases', Utils.__listify(name)
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          params[:h] = Utils.__listify(params[:h]) if params[:h]
+
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Return shard allocation information
+        #
+        # @example Display allocation for all nodes in the cluster
+        #
+        #     puts client.cat.allocation
+        #
+        # @example Display allocation for node with name 'node-1'
+        #
+        #     puts client.cat.allocation node_id: 'node-1'
+        #
+        # @example Display header names in the output
+        #
+        #     puts client.cat.allocation v: true
+        #
+        # @example Display only specific columns in the output (see the `help` parameter)
+        #
+        #     puts client.cat.allocation h: ['node', 'shards', 'disk.percent']
+        #
+        # @example Display only specific columns in the output, using the short names
+        #
+        #     puts client.cat.allocation h: 'n,s,dp'
+        #
+        # @example Return the information as Ruby objects
+        #
+        #     client.cat.allocation format: 'json'
+        #
+        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, m, g)
+        # @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'
+        # @option arguments [Boolean] :help Return information about headers
+        # @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
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-allocation.html
+        #
+        def allocation(arguments={})
+          valid_params = [
+            :bytes,
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v ]
+
+          node_id = arguments.delete(:node_id)
+
+          method = 'GET'
+
+          path   = Utils.__pathify '_cat/allocation', Utils.__listify(node_id)
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          params[:h] = Utils.__listify(params[:h]) if params[:h]
+
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Return document counts for the entire cluster or specific indices
+        #
+        # @example Display number of documents in the cluster
+        #
+        #     puts client.cat.count
+        #
+        # @example Display number of documents in an index
+        #
+        #     puts client.cat.count index: 'index-a'
+        #
+        # @example Display number of documents in a list of indices
+        #
+        #     puts client.cat.count index: ['index-a', 'index-b']
+        #
+        # @example Return the information as Ruby objects
+        #
+        #     client.cat.allocation format: 'json'
+        #
+        # @option arguments [List] :index A comma-separated list of index names to limit the returned information
+        # @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'
+        # @option arguments [Boolean] :help Return information about headers
+        # @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
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-count.html
+        #
+        def count(arguments={})
+          valid_params = [
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v ]
+
+          index = arguments.delete(:index)
+
+          method = 'GET'
+
+          path   = Utils.__pathify '_cat/count', Utils.__listify(index)
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          params[:h] = Utils.__listify(params[:h]) if params[:h]
+
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Display a terse version of the {Elasticsearch::API::Cluster::Actions#health} API output
+        #
+        # @example Display cluster health
+        #
+        #     puts client.cat.health
+        #
+        # @option arguments [Boolean] :ts Whether to display timestamp information
+        # @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'
+        # @option arguments [Boolean] :help Return information about headers
+        # @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
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-health.html
+        #
+        def health(arguments={})
+          valid_params = [
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :ts,
+            :v ]
+
+          method = 'GET'
+          path   = "_cat/health"
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          params[:h] = Utils.__listify(params[:h]) if params[:h]
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Help information for the Cat API
+        #
+        # @option arguments [Boolean] :help Return help information
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html
+        #
+        def help(arguments={})
+          valid_params = [
+            :help ]
+          method = 'GET'
+          path   = "_cat"
+          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/indices.rb

@@ -0,0 +1,77 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Return the most important statistics about indices, across the cluster nodes
+        #
+        # Use the `help` parameter to display available statistics.
+        #
+        # @example Display information for all indices
+        #
+        #     puts client.cat.indices
+        #
+        # @example Display information for a specific index
+        #
+        #     puts client.cat.indices index: 'index-a'
+        #
+        # @example Display information for indices matching a pattern
+        #
+        #     puts client.cat.indices index: 'index-*'
+        #
+        # @example Display header names in the output
+        #
+        #     puts client.cat.indices v: true
+        #
+        # @example Display only specific columns in the output (see the `help` parameter)
+        #
+        #     puts client.cat.indices h: ['index', 'docs.count', 'fielddata.memory_size', 'filter_cache.memory_size']
+        #
+        # @example Display only specific columns in the output, using the short names
+        #
+        #     puts client.cat.indices h: 'i,dc,ss,mt', v: true
+        #
+        # @example Return the information as Ruby objects
+        #
+        #     client.cat.indices format: 'json'
+        #
+        # @option arguments [List] :index A comma-separated list of index names to limit the returned information
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, m, g)
+        # @option arguments [Boolean] :pri Limit the returned information on primary shards only (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 [String] :format The output format. Options: 'text', 'json'; default: 'text'
+        # @option arguments [Boolean] :help Return information about headers
+        # @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
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-indices.html
+        #
+        def indices(arguments={})
+          valid_params = [
+            :bytes,
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :pri,
+            :v ]
+
+          index = arguments.delete(:index)
+
+          method = 'GET'
+
+          path   = Utils.__pathify '_cat/indices', Utils.__listify(index)
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          params[:h] = Utils.__listify(params[:h]) if params[:h]
+
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Display basic information about the master node
+        #
+        # @example
+        #
+        #     puts client.cat.master
+        #
+        # @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'
+        # @option arguments [Boolean] :help Return information about headers
+        # @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
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-master.html
+        #
+        def master(arguments={})
+          valid_params = [
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v ]
+
+          method = 'GET'
+          path   = "_cat/master"
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end