elasticsearch-api 0.0.2

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

@@ -0,0 +1,41 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Return true if the specified alias exists, false otherwise.
+        #
+        # @example Check whether index alias named _myalias_ exists
+        #
+        #     client.indices.exists_alias name: 'myalias'
+        #
+        # @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 [String] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
+        #                                            (options: none, missing)
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
+        #
+        def exists_alias(arguments={})
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+          method = 'HEAD'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_alias', arguments[:name] )
+          params = arguments.select do |k,v|
+            [ :ignore_indices ].include?(k)
+          end
+          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
+          params = Hash[params] unless params.is_a?(Hash)
+          body = nil
+
+          perform_request(method, path, params, body).status == 200 ? true : false
+        rescue Exception => e
+          if e.class.to_s =~ /NotFound/ || e.message =~ /Not\s*Found|404/i
+            false
+          else
+            raise e
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Return true if the specified type exists, false otherwise.
+        #
+        # @option arguments [List] :index A comma-separated list of index names; use `_all`
+        #                                 to check the types across all indices (*Required*)
+        # @option arguments [List] :type A comma-separated list of document types to check (*Required*)
+        # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
+        #                                            (options: none, missing)
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-types-exists/
+        #
+        def exists_type(arguments={})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          raise ArgumentError, "Required argument 'type' missing" unless arguments[:type]
+          method = 'HEAD'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), arguments[:type] )
+          params = arguments.select do |k,v|
+            [ :ignore_indices ].include?(k)
+          end
+          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
+          params = Hash[params] unless params.is_a?(Hash)
+          body = nil
+
+          perform_request(method, path, params, body).status == 200 ? true : false
+        rescue Exception => e
+          if e.class.to_s =~ /NotFound/ || e.message =~ /Not\s*Found|404/i
+            false
+          else
+            raise e
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # "Flush" the index or indices.
+        #
+        # The "flush" operation clears the transaction log and memory and writes data to disk.
+        # It corresponds to a Lucene "commit" operation.
+        #
+        # @note The flush operation is handled automatically by Elasticsearch, you don't need to perform it manually.
+        #
+        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices
+        # @option arguments [Boolean] :force TODO: ?
+        # @option arguments [Boolean] :full TODO: ?
+        # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
+        #                                            (options: none, missing)
+        # @option arguments [Boolean] :refresh Refresh the index after performing the operation
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-flush/
+        #
+        def flush(arguments={})
+          method = 'POST'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_flush' )
+          params = arguments.select do |k,v|
+            [ :force,
+              :full,
+              :ignore_indices,
+              :refresh ].include?(k)
+          end
+          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
+          params = Hash[params] unless params.is_a?(Hash)
+          body = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Get information about a specific alias.
+        #
+        # @example Return all indices an alias points to
+        #
+        #     client.indices.get_alias name: '2013'
+        #
+        # @example Return all indices matching a wildcard pattern an alias points to
+        #
+        #     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 [String] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
+        #                                            (options: none, missing)
+        # @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
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
+        #
+        def get_alias(arguments={})
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+          method = 'GET'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_alias', arguments[:name] )
+          params = arguments.select do |k,v|
+            [ :ignore_indices ].include?(k)
+          end
+          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
+          params = Hash[params] unless params.is_a?(Hash)
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Get a list of all aliases, or aliases for a specific index.
+        #
+        # @example Get a list of all aliases
+        #
+        #     client.indices.get_aliases
+        #
+        # @option arguments [List] :index A comma-separated list of index names to filter aliases
+        # @option arguments [Time] :timeout Explicit timestamp for the document
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
+        #
+        def get_aliases(arguments={})
+          method = 'GET'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_aliases' )
+          params = arguments.select do |k,v|
+            [ :timeout ].include?(k)
+          end
+          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
+          params = Hash[params] unless params.is_a?(Hash)
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Return the mapping definitions for all indices, or specific indices/types.
+        #
+        # @example Get all mappings in the cluster
+        #
+        #     client.indices.get_mapping
+        #
+        # @example Get mapping for a specific index
+        #
+        #     client.indices.get_mapping index: 'foo'
+        #
+        # @example Get mapping for a specific type in a specific index
+        #
+        #     client.indices.get_mapping index: 'foo', type: 'baz'
+        #
+        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices
+        # @option arguments [List] :type A comma-separated list of document types
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-get-mapping/
+        #
+        def get_mapping(arguments={})
+          method = 'GET'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_mapping' )
+          params = {}
+          body = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Return the settings for all indices, or a list of indices.
+        #
+        # @example Get settings for all indices
+        #
+        #     client.indices.get_settings
+        #
+        # @example Get settings for an index named _myindex_
+        #
+        #     client.indices.get_settings index: 'myindex'
+        #
+        # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string
+        #                                 to perform the operation on all indices
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-get-settings/
+        #
+        def get_settings(arguments={})
+          method = 'GET'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_settings' )
+          params = {}
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Get a single index 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*)
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
+        #
+        def get_template(arguments={})
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+          method = 'GET'
+          path   = "_template/#{arguments[:name]}"
+          params = {}
+          body = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Get one or more warmers for an index.
+        #
+        # @example Get all warmers
+        #
+        #     client.indices.get_warmer index: '_all'
+        #
+        # @example Get all warmers matching a wildcard expression
+        #
+        #     client.indices.get_warmer index: '_all', name: 'ba*'
+        #
+        # @example Get all warmers for a single index
+        #
+        #     client.indices.get_warmer index: 'foo'
+        #
+        # @example Get a specific warmer
+        #
+        #     client.indices.get_warmer index: 'foo', name: 'bar'
+        #
+        # @option arguments [List] :index A comma-separated list of index names to restrict the operation;
+        #                                 use `_all` to perform the operation on all indices (*Required*)
+        # @option arguments [String] :name The name of the warmer (supports wildcards); leave empty to get all warmers
+        # @option arguments [List] :type A comma-separated list of document types to restrict the operation;
+        #                                leave empty to perform the operation on all types
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
+        #
+        def get_warmer(arguments={})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          method = 'GET'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_warmer', arguments[:name] )
+          params = {}
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Open a previously closed index (see the {Indices::Actions#close} API).
+        #
+        # @example Open index named _myindex_
+        #
+        #     client.indices.open index: 'myindex'
+        #
+        # @option arguments [String] :index The name of the index (*Required*)
+        # @option arguments [Time] :timeout Explicit operation timeout
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/
+        #
+        def open(arguments={})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          method = 'POST'
+          path   = "#{arguments[:index]}/_open"
+          params = arguments.select do |k,v|
+            [ :timeout ].include?(k)
+          end
+          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
+          params = Hash[params] unless params.is_a?(Hash)
+          body = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Perform an index optimization.
+        #
+        # The "optimize" operation merges the index segments, increasing search performance.
+        # It corresponds to a Lucene "merge" operation.
+        #
+        # @example Fully optimize an index (merge to one segment)
+        #
+        #     client.indices.optimize index: 'foo', max_num_segments: 1, wait_for_merge: false
+        #
+        # @note The optimize operation is handled automatically by Elasticsearch, you don't need to perform it manually.
+        #       The operation is expensive in terms of resources (I/O, CPU, memory) and can take a long time to
+        #       finish, potentially reducing operability of your cluster; schedule the manual optimization accordingly.
+        #
+        # @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] :flush Specify whether the index should be flushed after performing the operation
+        #                                    (default: true)
+        # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
+        #                                            (options: none, missing)
+        # @option arguments [Number] :max_num_segments The number of segments the index should be merged into
+        #                                              (default: dynamic)
+        # @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge
+        #                                                   deleted documents
+        # @option arguments [Boolean] :refresh Specify whether the index should be refreshed after performing the operation
+        #                                      (default: true)
+        # @option arguments [Boolean] :wait_for_merge Specify whether the request should block until the merge process
+        #                                             is finished (default: true)
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-optimize/
+        #
+        def optimize(arguments={})
+          method = 'POST'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_optimize' )
+          params = arguments.select do |k,v|
+            [ :flush,
+              :ignore_indices,
+              :max_num_segments,
+              :only_expunge_deletes,
+              :operation_threading,
+              :refresh,
+              :wait_for_merge ].include?(k)
+          end
+          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
+          params = Hash[params] unless params.is_a?(Hash)
+          body = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Create or update a single index alias.
+        #
+        # @example Create an alias for current month
+        #
+        #     client.indices.put_alias index: 'logs-2013-06', name: 'current-month'
+        #
+        # @example Create an alias for multiple indices
+        #
+        #     client.indices.put_alias index: 'logs-2013-06', name: 'year-2013'
+        #     client.indices.put_alias index: 'logs-2013-05', name: 'year-2013'
+        #
+        # See the {Indices::Actions#update_aliases} for performing operations with index aliases in bulk.
+        #
+        # @option arguments [String] :index The name of the index with an alias
+        # @option arguments [String] :name The name of the alias to be created or updated
+        # @option arguments [Hash] :body The settings for the alias, such as `routing` or `filter`
+        # @option arguments [Time] :timeout Explicit timestamp for the document
+        #
+        # @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]
+          method = 'PUT'
+          path   = "#{arguments[:index]}/_alias/#{arguments[:name]}"
+          params = arguments.select do |k,v|
+            [ :timeout ].include?(k)
+          end
+          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
+          params = Hash[params] unless params.is_a?(Hash)
+          body   = arguments[:body]
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end