elasticsearch-api 0.0.2

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

@@ -0,0 +1,63 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Return the result of the analysis process (tokens)
+        #
+        # Allows to "test-drive" the Elasticsearch analysis process by performing the analysis on the
+        # same text with different analyzers. An ad-hoc analysis chain can be built from specific
+        # _tokenizer_ and _filters_.
+        #
+        # @example Analyze text "Quick Brown Jumping Fox" with the _snowball_ analyzer
+        #
+        #     client.indices.analyze text: 'The Quick Brown Jumping Fox', analyzer: 'snowball'
+        #
+        # @example Analyze text "Quick Brown Jumping Fox" with the _snowball_ analyzer
+        #
+        #     client.indices.analyze text: 'The Quick Brown Jumping Fox',
+        #                            tokenizer: 'whitespace',
+        #                            filters: ['lowercase','stop']
+        #
+        # @option arguments [String] :index The name of the index to scope the operation
+        # @option arguments [Hash] :body The text on which the analysis should be performed
+        # @option arguments [String] :analyzer The name of the analyzer to use
+        # @option arguments [String] :field Use the analyzer configured for this field
+        #                                   (instead of passing the analyzer name)
+        # @option arguments [List] :filters A comma-separated list of filters to use for the analysis
+        # @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)
+        # @option arguments [String] :text The text on which the analysis should be performed
+        #                                  (when request body is not used)
+        # @option arguments [String] :tokenizer The name of the tokenizer to use for the analysis
+        # @option arguments [String] :format Format of the output (options: detailed, text)
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-analyze/
+        #
+        def analyze(arguments={})
+          method = 'GET'
+          path   = Utils.__pathify( arguments[:index], '_analyze' )
+          params = arguments.select do |k,v|
+            [ :analyzer,
+              :field,
+              :filters,
+              :index,
+              :prefer_local,
+              :text,
+              :tokenizer,
+              :format ].include?(k)
+          end
+          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
+          params = Hash[params] unless params.is_a?(Hash)
+
+          params[:filters] = Utils.__listify(params[:filters]) if params[:filters]
+
+          body   = arguments[:body]
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Clear caches and other auxiliary data structures.
+        #
+        # Can be performed against a specific index, or against all indices.
+        #
+        # By default, all caches and data structures will be cleared.
+        # Pass a specific cache or structure name to clear just a single one.
+        #
+        # @example Clear all caches and data structures
+        #
+        #     client.indices.clear_cache
+        #
+        # @example Clear the field data structure only
+        #
+        #     client.indices.clear_cache field_data: true
+        #
+        # @example Clear only specific field in the field data structure
+        #
+        #     client.indices.clear_cache field_data: true, fields: 'created_at', filter_cache: false, id_cache: false
+        #
+        # @option arguments [List] :index A comma-separated list of index name to limit the operation
+        # @option arguments [Boolean] :field_data Clear field data
+        # @option arguments [Boolean] :fielddata Clear field data
+        # @option arguments [List] :fields A comma-separated list of fields to clear when using the
+        #                                  `field_data` parameter(default: all)
+        # @option arguments [Boolean] :filter Clear filter caches
+        # @option arguments [Boolean] :filter_cache Clear filter caches
+        # @option arguments [Boolean] :filter_keys A comma-separated list of keys to clear when using the
+        #                                          `filter_cache` parameter (default: all)
+        # @option arguments [Boolean] :id Clear ID caches for parent/child
+        # @option arguments [Boolean] :id_cache Clear ID caches for parent/child
+        # @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 name to limit the operation
+        # @option arguments [Boolean] :recycler Clear the recycler cache
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-clearcache/
+        #
+        def clear_cache(arguments={})
+          method = 'POST'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_cache/clear' )
+          params = arguments.select do |k,v|
+            [ :field_data,
+              :fielddata,
+              :fields,
+              :filter,
+              :filter_cache,
+              :filter_keys,
+              :id,
+              :id_cache,
+              :ignore_indices,
+              :recycler ].include?(k)
+          end
+          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
+          params = Hash[params] unless params.is_a?(Hash)
+          body   = nil
+
+          params[:fields] = Utils.__listify(params[:fields]) if params[:fields]
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Close an index (keep the data on disk, but deny operations with the index).
+        #
+        # A closed index can be opened again with the {Indices::Actions#close} API.
+        #
+        # @example Close index named _myindex_
+        #
+        #     client.indices.close 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 close(arguments={})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          method = 'POST'
+          path   = "#{arguments[:index]}/_close"
+          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/create.rb

@@ -0,0 +1,83 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Create an index.
+        #
+        # Pass the index `settings` and `mappings` in the `:body` attribute.
+        #
+        # @example Create an index with specific settings, custom analyzers and mappings
+        #
+        #     client.indices.create index: 'test',
+        #                           body: {
+        #                             settings: {
+        #                               index: {
+        #                                 number_of_shards: 1,
+        #                                 number_of_replicas: 0,
+        #                                 'routing.allocation.include.name' => 'node-1'
+        #                               },
+        #                               analysis: {
+        #                                 filter: {
+        #                                   ngram: {
+        #                                     type: 'nGram',
+        #                                     min_gram: 3,
+        #                                     max_gram: 25
+        #                                   }
+        #                                 },
+        #                                 analyzer: {
+        #                                   ngram: {
+        #                                     tokenizer: 'whitespace',
+        #                                     filter: ['lowercase', 'stop', 'ngram'],
+        #                                     type: 'custom'
+        #                                   },
+        #                                   ngram_search: {
+        #                                     tokenizer: 'whitespace',
+        #                                     filter: ['lowercase', 'stop'],
+        #                                     type: 'custom'
+        #                                   }
+        #                                 }
+        #                               }
+        #                             },
+        #                             mappings: {
+        #                               document: {
+        #                                 properties: {
+        #                                   title: {
+        #                                     type: 'multi_field',
+        #                                     fields: {
+        #                                         title:  { type: 'string', analyzer: 'snowball' },
+        #                                         exact:  { type: 'string', analyzer: 'keyword' },
+        #                                         ngram:  { type: 'string',
+        #                                                   index_analyzer: 'ngram',
+        #                                                   search_analyzer: 'ngram_search'
+        #                                         }
+        #                                     }
+        #                                   }
+        #                                 }
+        #                               }
+        #                             }
+        #                           }
+        #
+        # @option arguments [String] :index The name of the index (*Required*)
+        # @option arguments [Hash] :body Optional configuration for the index (`settings` and `mappings`)
+        # @option arguments [Time] :timeout Explicit operation timeout
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-create-index/
+        #
+        def create(arguments={})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          method = 'PUT'
+          path   = "#{arguments[:index]}"
+          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

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

@@ -0,0 +1,48 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Delete an index, list of indices, or all indices in the cluster.
+        #
+        # @example Delete an index
+        #
+        #     client.indices.delete index: 'foo'
+        #
+        # @example Delete a list of indices
+        #
+        #     client.indices.delete index: ['foo', 'bar']
+        #     client.indices.delete index: 'foo,bar'
+        #
+        #
+        # @example Delete a list of indices matching wildcard expression
+        #
+        #     client.indices.delete index: 'foo*'
+        #
+        # @example Delete all indices
+        #
+        #     client.indices.delete
+        #     client.indices.delete index: '_all'
+        #
+        # @option arguments [List] :index A comma-separated list of indices to delete;
+        #                                 use `_all` or leave empty to delete all indices
+        # @option arguments [Time] :timeout Explicit operation timeout
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-index/
+        #
+        def delete(arguments={})
+          method = 'DELETE'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]) )
+          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/delete_alias.rb

@@ -0,0 +1,37 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Delete a single index alias.
+        #
+        # @example Delete an alias
+        #
+        #     client.indices.delete_alias index: 'foo', name: 'bar'
+        #
+        # 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 (*Required*)
+        # @option arguments [String] :name The name of the alias to be deleted (*Required*)
+        # @option arguments [Time] :timeout Explicit timestamp for the document
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
+        #
+        def delete_alias(arguments={})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          raise ArgumentError, "Required argument 'name' missing"  unless arguments[:name]
+          method = 'DELETE'
+          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   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Delete all documents and mapping for a specific document type.
+        #
+        # @option arguments [List] :index A comma-separated list of index names; use `_all` for all indices (*Required*)
+        # @option arguments [String] :type The name of the document type to delete (*Required*)
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-mapping/
+        #
+        def delete_mapping(arguments={})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
+          method = 'DELETE'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), arguments[:type] )
+          params = {}
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Delete an index template.
+        #
+        # @example Delete a template named _mytemplate_
+        #
+        #     client.indices.delete_template name: 'mytemplate'
+        #
+        # @option arguments [String] :name The name of the template (*Required*)
+        # @option arguments [Time] :timeout Explicit operation timeout
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
+        #
+        def delete_template(arguments={})
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+          method = 'DELETE'
+          path   = "_template/#{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 = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Delete one or more warmers for a list of indices.
+        #
+        # @example Delete a warmer named _mywarmer_ for index named _myindex_
+        #
+        #     client.indices.delete_warmer index: 'myindex', name: 'mywarmer'
+        #
+        # @option arguments [List] :index A comma-separated list of index names to register warmer for; use `_all`
+        #                                 or empty string to perform the operation on all indices (*Required*)
+        # @option arguments [String] :name The name of the warmer (supports wildcards); leave empty to delete all warmers
+        # @option arguments [List] :type A comma-separated list of document types to register warmer for; use `_all`
+        #                                or empty string to perform the operation on all types
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
+        #
+        def delete_warmer(arguments={})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          method = 'DELETE'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_warmer', Utils.__listify(arguments[:name]) )
+          params = {}
+          body = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Return true if the index (or all indices in a list) exists, false otherwise.
+        #
+        # @example Check whether index named _myindex_ exists
+        #
+        #     client.indices.exists index: 'myindex'
+        #
+        # @option arguments [List] :index A comma-separated list of indices to check (*Required*)
+        # @return [true,false]
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-indices-exists/
+        #
+        def exists(arguments={})
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          method = 'HEAD'
+          path   = Utils.__listify(arguments[:index])
+          params = {}
+          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