elasticsearch-api 0.0.2

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

@@ -0,0 +1,49 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Create or update mapping.
+        #
+        # Pass the mapping definition(s) in the `:body` argument.
+        #
+        # @example Create or update a mapping for a specific document type
+        #
+        #     client.indices.put_mapping index: 'myindex', type: 'mytype', body: {
+        #       mytype: {
+        #         properties: {
+        #           title: { type: 'string', analyzer: 'snowball' }
+        #         }
+        #       }
+        #     }
+        #
+        # @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 [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)
+        # @option arguments [Time] :timeout Explicit operation timeout
+        #
+        # @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]
+          method = 'PUT'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), arguments[:type], '_mapping' )
+          params = arguments.select do |k,v|
+            [ :ignore_conflicts,
+              :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/put_settings.rb

@@ -0,0 +1,45 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Update the settings for one or multiple indices.
+        #
+        # @example Change the number of replicas for all indices
+        #
+        #     client.indices.put_settings body: { index: { number_of_replicas: 0 } }
+        #
+        #
+        # @example Change the number of replicas for a specific index
+        #
+        #     client.indices.put_settings index: 'myindex', body: { index: { number_of_replicas: 0 } }
+        #
+        #
+        # @example Disable "flush" for all indices
+        #
+        #     client.indices.put_settings body: { 'index.translog.disable_flush' => true }
+        #
+        # @example Allocate specific index on specific nodes
+        #
+        #     client.indices.put_settings index: 'my-big-index',
+        #                                 body: { 'index.routing.allocation.require.tag' => 'bigbox' }
+        #
+        # @option arguments [Hash] :body The index settings to be updated (*Required*)
+        # @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-update-settings/
+        #
+        def put_settings(arguments={})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          method = 'PUT'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_settings' )
+          params = {}
+          body   = arguments[:body]
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # 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 } }
+        #
+        # @option arguments [String] :name The name of the template (*Required*)
+        # @option arguments [Hash] :body The template definition (*Required*)
+        # @option arguments [Number] :order The order for this template when merging multiple matching ones
+        #                                   (higher numbers are merged later, overriding the lower numbers)
+        # @option arguments [Time] :timeout Explicit operation timeout
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
+        #
+        def put_template(arguments={})
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          method = 'PUT'
+          path   = "_template/#{arguments[:name]}"
+          params = arguments.select do |k,v|
+            [ :order,
+              :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/put_warmer.rb

@@ -0,0 +1,48 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Create or update an index warmer.
+        #
+        # An index warmer will run before an index is refreshed, ie. available for search.
+        # It allows you to register "heavy" queries with popular filters, facets or sorts,
+        # increasing performance when the index is searched for the first time.
+        #
+        # @example Register a warmer which will populate the caches for `published` filter and sorting on `created_at`
+        #
+        #     client.indices.put_warmer index: 'myindex',
+        #                               name: 'main',
+        #                               body: {
+        #                                 query: { filtered: { filter: { term: { published: true } } } },
+        #                                 sort:  [ "created_at" ]
+        #                               }
+        #
+        # @option arguments [List] :index A comma-separated list of index names to register the warmer for; use `_all`
+        #                                 or empty string to perform the operation on all indices (*Required*)
+        # @option arguments [String] :name The name of the warmer (*Required*)
+        # @option arguments [List] :type A comma-separated list of document types to register the warmer for;
+        #                                leave empty to perform the operation on all types
+        # @option arguments [Hash] :body The search request definition for the warmer
+        #                                (query, filters, facets, sorting, etc) (*Required*)
+        #
+        # @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]
+          method = 'PUT'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]),
+                                    Utils.__listify(arguments[:type]),
+                                    '_warmer',
+                                    Utils.__listify(arguments[:name]) )
+          params = {}
+          body   = arguments[:body]
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Refresh the index and to make the changes (creates, updates, deletes) searchable.
+        #
+        # By default, Elasticsearch has a delay of 1 second until changes to an index are
+        # available for search; the delay is configurable, see {Indices::Actions#put_settings}.
+        #
+        # You can trigger this operation explicitely, for example when performing a sequence of commands
+        # in integration tests, or when you need to perform a manual "synchronization" of the index
+        # with an external system at given moment.
+        #
+        # @example Refresh an index named _myindex_
+        #
+        #     client.indices.refresh index: 'myindex'
+        #
+        # @note The refresh operation can adversely affect indexing throughput when used too frequently.
+        #
+        # @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] :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-refresh/
+        #
+        def refresh(arguments={})
+          method = 'POST'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_refresh' )
+          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/segments.rb

@@ -0,0 +1,33 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Return information about segments for one or more indices.
+        #
+        # The response contains information about segment size, number of documents, deleted documents, etc.
+        # See also {Indices::Actions#optimize}.
+        #
+        # @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] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
+        #                                            (options: none, missing)
+        #
+        # @see http://elasticsearch.org/guide/reference/api/admin-indices-segments/
+        #
+        def segments(arguments={})
+          method = 'GET'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_segments' )
+          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/snapshot_index.rb

@@ -0,0 +1,32 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # When using the shared storage gateway, manually trigger the snapshot operation.
+        #
+        # @deprecated The shared gateway has been deprecated [https://github.com/elasticsearch/elasticsearch/issues/2458]
+        #
+        # @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] :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-gateway-snapshot/
+        #
+        def snapshot_index(arguments={})
+          method = 'POST'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_gateway/snapshot' )
+          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/stats.rb

@@ -0,0 +1,96 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Return statistical information about one or more indices.
+        #
+        # The response contains comprehensive statistical information about metrics related to index:
+        # 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
+        #
+        #     client.indices.stats
+        #
+        # @example Get all available statistics for a single index
+        #
+        #     client.indices.stats index: 'foo', all: true
+        #
+        # @example Get statistics about documents and disk size for multiple indices
+        #
+        #     client.indices.stats index: ['foo', 'bar'], clear: true, docs: true, store: true
+        #
+        # @example Get statistics about filter cache and field data, for all indices
+        #
+        #     client.indices.stats clear: true, fielddata: true , filter_cache: true, fields: '*'
+        #
+        # @example Get statistics about searches, with segmentation for different search groups
+        #
+        #     client.indices.stats clear: true, search: true , groups: ['groupA', 'groupB']
+        #
+        # @since The `fielddata`, `filter_cache` and `id_cache` metrics are available from version 0.90.
+        #
+        # @option arguments [List] :search_groups A comma-separated list of search groups to include
+        #                                         in the `search` statistics
+        # @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)
+        # @option arguments [Boolean] :filter_cache Return information about filter cache
+        # @option arguments [Boolean] :flush Return information about flush operations
+        # @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)
+        # @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 [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 [Boolean] :store Return information about the size of the index
+        # @option arguments [Boolean] :warmer Return information about warmers
+        #
+        # @see http://elasticsearch.org/guide/reference/api/admin-indices-stats/
+        #
+        def stats(arguments={})
+          method = 'GET'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_stats' )
+          params = arguments.select do |k,v|
+            [ :all,
+              :clear,
+              :docs,
+              :fielddata,
+              :fields,
+              :filter_cache,
+              :flush,
+              :get,
+              :groups,
+              :id_cache,
+              :ignore_indices,
+              :indexing,
+              :merge,
+              :refresh,
+              :search,
+              :store,
+              :warmer ].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]
+          params[:groups] = Utils.__listify(params[:groups]) if params[:groups]
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Return information about one or more indices
+        #
+        # @example Get information about all indices
+        #
+        #     client.indices.status
+        #
+        # @example Get information about a specific index
+        #
+        #     client.indices.status index: 'foo'
+        #
+        # @example Get information about shard recovery for a specific index
+        #
+        #     client.indices.status index: 'foo', recovery: true
+        #
+        # @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] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
+        #                                            (options: none, missing)
+        # @option arguments [Boolean] :recovery Return information about shard recovery (progress, size, etc)
+        # @option arguments [Boolean] :snapshot Return information about snapshots (when shared gateway is used)
+        #
+        # @see http://elasticsearch.org/guide/reference/api/admin-indices-status/
+        #
+        def status(arguments={})
+          method = 'GET'
+          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_status' )
+          params = arguments.select do |k,v|
+            [ :ignore_indices,
+              :recovery,
+              :snapshot ].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/update_aliases.rb

@@ -0,0 +1,49 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # Perform multiple operation on index aliases in a single request.
+        #
+        # Pass the `actions` (add, remove) in the `body` argument.
+        #
+        # @example Add multiple indices to a single alias
+        #
+        #     client.indices.update_aliases body: {
+        #       actions: [
+        #         { add: { index: 'logs-2013-06', alias: 'year-2013' } },
+        #         { add: { index: 'logs-2013-05', alias: 'year-2013' } }
+        #       ]
+        #     }
+        #
+        # @example Swap an alias (atomic operation)
+        #
+        #     client.indices.update_aliases body: {
+        #       actions: [
+        #         { remove: { index: 'logs-2013-06', alias: 'current-month' } },
+        #         { add:    { index: 'logs-2013-07', alias: 'current-month' } }
+        #       ]
+        #     }
+        #
+        # @option arguments [Hash] :body The operations definition and other configuration (*Required*)
+        # @option arguments [Time] :timeout Explicit operation timeout
+        #
+        # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
+        #
+        def update_aliases(arguments={})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          method = 'POST'
+          path   = "_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   = arguments[:body]
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end