elasticsearch-api 0.4.11 → 1.0.0.rc1

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

@@ -2,50 +2,96 @@ module Elasticsearch
   module API
     module Actions
 
-      # Return names of queries matching the passed document.
+      # Return names of queries matching a document.
       #
       # Percolator allows you to register queries and then evaluate a document against them:
       # the IDs of matching queries are returned in the response.
       #
-      # @example Register queries named "alert-1" and "alert-2" for the "myindex" index
+      # @example Register queries named "alert-1" and "alert-2" for the "my-index" index
       #
-      #     client.index index: '_percolator',
-      #                  type: 'myindex',
+      #     client.index index: 'my-index',
+      #                  type: '.percolator',
       #                  id: 'alert-1',
       #                  body: { query: { query_string: { query: 'foo' } } }
       #
-      #     client.index index: '_percolator',
-      #                  type: 'myindex',
+      #     client.index index: 'my-index',
+      #                  type: '.percolator',
       #                  id: 'alert-2',
       #                  body: { query: { query_string: { query: 'bar' } } }
       #
-      # @example Evaluate a document against the queries
+      # @example Evaluate a custom document (passed as `:doc`) against the queries
       #
-      #     client.percolate index: 'myindex', body: { doc: { title: "Foo" } }
-      #     # => {"ok":true,"matches":["alert-1"]}
+      #     client.percolate index: 'my-index', body: { doc: { title: "Foo" } }
+      #     # => {..., matches: [ {_index: 'my-index', _id: 'alert-1'} ]}
       #
-      #     client.percolate index: 'myindex', body: { doc: { title: "Foo Bar" } }
-      #     # => {"ok":true,"matches":["alert-1","alert-2"]}
+      #     client.percolate index: 'my-index', body: { doc: { title: "Foo Bar" } }
+      #     # => {..., matches: [ {_index: 'my-index', _id: 'alert-2'}, {_index: 'my-index', _id: 'alert-1'} ] }
       #
-      # @option arguments [String] :index The name of the index with a registered percolator query (*Required*)
-      # @option arguments [String] :type The document type
-      # @option arguments [Hash] :body The document (`doc`) to percolate against registered queries;
-      #                                optionally also a `query` to limit the percolation to specific registered queries
-      # @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)
+      # @example Evaluate an existing document against the queries
       #
-      # @see http://elasticsearch.org/guide/reference/api/percolate/
+      #     client.index index: 'my-index', type: 'my-type', id: 123, body: { title: "Foo Bar" }
+      #
+      #     client.percolate index: 'my-index', type: 'my-type', id: '123'
+      #     # => { ..., matches: [ {_index: 'my-index', _id: 'alert-2'}, { _index: 'my-index', _id: 'alert-1'} ] }
+      #
+      # @example Register a query with custom `priority` property
+      #
+      #     client.index index: 'my-index',
+      #                  type: '.percolator',
+      #                  id: 'alert-high-1',
+      #                  body: { query: { query_string: { query: 'foo' } },
+      #                          priority: 'high' }
+      #
+      # @example Evaluate a document against "high priority" percolator queries
+      #
+      #     client.percolate index: 'my-index', body: {
+      #         doc:    { title: "Foo" },
+      #         filter: { term: { priority: 'high' } }
+      #       }
+      #     # => {..., matches: [ {_index: 'my-index', _id: 'alert-high-1'} ]}
+      #
+      #
+      # @option arguments [String] :index The index of the document being percolated. (*Required*)
+      # @option arguments [String] :type The type of the document being percolated. (*Required*)
+      # @option arguments [String] :id Fetch the document specified by index/type/id and
+      #                                use it instead of the passed `doc`
+      # @option arguments [Hash] :body The percolator request definition using the percolate DSL
+      # @option arguments [List] :routing A comma-separated list of specific routing values
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
+      #                                        (default: random)
+      # @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)
+      # @option arguments [String] :percolate_index The index to percolate the document into. Defaults to passed `index`.
+      # @option arguments [String] :percolate_type The type to percolate document into. Defaults to passed `type`.
+      # @option arguments [Number] :version Explicit version number for concurrency control
+      # @option arguments [String] :version_type Specific version type (options: internal, external)
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-percolate.html
       #
       def percolate(arguments={})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'body' missing"  unless arguments[:body]
-        arguments[:type] ||= 'document'
+        raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
 
-        valid_params = [ :prefer_local ]
+        valid_params = [
+          :routing,
+          :preference,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :percolate_index,
+          :percolate_type,
+          :version,
+          :version_type ]
 
         method = 'GET'
         path   = Utils.__pathify Utils.__escape(arguments[:index]),
                                  Utils.__escape(arguments[:type]),
+                                 arguments[:id],
                                  '_percolate'
 
         params = Utils.__validate_and_extract_params arguments, valid_params

data/lib/elasticsearch/api/actions/snapshot/create.rb

@@ -0,0 +1,48 @@
+module Elasticsearch
+  module API
+    module Snapshot
+      module Actions
+
+        # Create a new snapshot in the repository
+        #
+        # @example Create a snapshot of the whole cluster in the `my-backups` repository
+        #
+        #     client.snapshot.create repository: 'my-backups', snapshot: 'snapshot-1'
+        #
+        # @example Create a snapshot for specific indices in the `my-backups` repository
+        #
+        #     client.snapshot.create repository: 'my-backups',
+        #                            snapshot: 'snapshot-2',
+        #                            body: { indices: 'foo,bar', ignore_unavailable: true }
+        #
+        # @option arguments [String] :repository A repository name (*Required*)
+        # @option arguments [String] :snapshot A snapshot name (*Required*)
+        # @option arguments [Hash] :body The snapshot definition
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Boolean] :wait_for_completion Whether the request should block and wait until
+        #                                                  the operation has completed
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        #
+        def create(arguments={})
+          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
+          raise ArgumentError, "Required argument 'snapshot' missing"   unless arguments[:snapshot]
+          valid_params = [
+            :master_timeout,
+            :wait_for_completion ]
+
+          repository = arguments.delete(:repository)
+          snapshot   = arguments.delete(:snapshot)
+
+          method = 'PUT'
+          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot) )
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = arguments[:body]
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/snapshot/create_repository.rb

@@ -0,0 +1,44 @@
+module Elasticsearch
+  module API
+    module Snapshot
+      module Actions
+
+        # Create a repository for storing snapshots
+        #
+        # @example Create a repository at `/tmp/backup`
+        #
+        #     client.snapshot.create_repository repository: 'my-backups',
+        #                                       body: {
+        #                                         type: 'fs',
+        #                                         settings: { location: '/tmp/backup', compress: true  }
+        #                                       }
+        #
+        # @option arguments [String] :repository A repository name (*Required*)
+        # @option arguments [Hash] :body The repository definition (*Required*)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Time] :timeout Explicit operation timeout
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        #
+        def create_repository(arguments={})
+          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
+          raise ArgumentError, "Required argument 'body' missing"       unless arguments[:body]
+          valid_params = [
+            :repository,
+            :master_timeout,
+            :timeout ]
+
+          repository = arguments.delete(:repository)
+
+          method = 'PUT'
+          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository) )
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = arguments[:body]
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Elasticsearch
+  module API
+    module Snapshot
+      module Actions
+
+        # Delete a snapshot from the repository
+        #
+        # @note Will also abort a currently running snapshot.
+        #
+        # @example Delete the `snapshot-1` snapshot
+        #
+        #     client.snapshot.delete repository: 'my-backups', snapshot: 'snapshot-1'
+        #
+        # @option arguments [String] :repository A repository name (*Required*)
+        # @option arguments [String] :snapshot A snapshot name (*Required*)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        #
+        def delete(arguments={})
+          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
+          raise ArgumentError, "Required argument 'snapshot' missing"   unless arguments[:snapshot]
+
+          valid_params = [
+            :master_timeout ]
+
+          repository = arguments.delete(:repository)
+          snapshot   = arguments.delete(:snapshot)
+
+          method = 'DELETE'
+          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__listify(snapshot) )
+
+          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/snapshot/delete_repository.rb

@@ -0,0 +1,38 @@
+module Elasticsearch
+  module API
+    module Snapshot
+      module Actions
+
+        # Delete a specific repository or repositories
+        #
+        # @example Delete the `my-backups` repository
+        #
+        #     client.snapshot.delete_repository repository: 'my-backups'
+        #
+        # @option arguments [List] :repository A comma-separated list of repository names (*Required*)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Time] :timeout Explicit operation timeout
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        #
+        def delete_repository(arguments={})
+          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
+
+          valid_params = [
+            :master_timeout,
+            :timeout ]
+
+          repository = arguments.delete(:repository)
+
+          method = 'DELETE'
+          path   = Utils.__pathify( '_snapshot', Utils.__listify(repository) )
+
+          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/snapshot/get.rb

@@ -0,0 +1,47 @@
+module Elasticsearch
+  module API
+    module Snapshot
+      module Actions
+
+        # Return information about specific (or all) snapshots
+        #
+        # @example Return information about the `snapshot-2` snapshot
+        #
+        #     client.snapshot.get repository: 'my-backup', snapshot: 'snapshot-2'
+        #
+        # @example Return information about multiple snapshots
+        #
+        #     client.snapshot.get repository: 'my-backup', snapshot: ['snapshot-2', 'snapshot-3']
+        #
+        # @example Return information about all snapshots in the repository
+        #
+        #     client.snapshot.get repository: 'my-backup', snapshot: '_all'
+        #
+        # @option arguments [String] :repository A repository name (*Required*)
+        # @option arguments [List] :snapshot A comma-separated list of snapshot names (*Required*)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        #
+        def get(arguments={})
+          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
+          raise ArgumentError, "Required argument 'snapshot' missing"   unless arguments[:snapshot]
+
+          valid_params = [
+            :master_timeout ]
+
+          repository = arguments.delete(:repository)
+          snapshot   = arguments.delete(:snapshot)
+
+          method = 'GET'
+          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__listify(snapshot) )
+
+          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/snapshot/get_repository.rb

@@ -0,0 +1,42 @@
+module Elasticsearch
+  module API
+    module Snapshot
+      module Actions
+
+        # Get information about snapshot repositories or a specific repository
+        #
+        # @example Get all repositories
+        #
+        #     client.snapshot.get_repository
+        #
+        # @example Get a specific repository
+        #
+        #     client.snapshot.get_repository repository: 'my-backups'
+        #
+        # @option arguments [List] :repository A comma-separated list of repository names. Leave blank or use `_all`
+        #                                      to get a list of repositories
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        #
+        def get_repository(arguments={})
+          valid_params = [
+            :master_timeout,
+            :local ]
+
+          repository = arguments.delete(:repository)
+
+          method = 'GET'
+          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository) )
+
+          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/snapshot/restore.rb

@@ -0,0 +1,53 @@
+module Elasticsearch
+  module API
+    module Snapshot
+      module Actions
+
+        # Restore the state from a snapshot
+        #
+        # @example Restore from the `snapshot-1` snapshot
+        #
+        #     client.snapshot.restore repository: 'my-backups', snapshot: 'snapshot-1'
+        #
+        # @example Restore a specific index under a different name
+        #
+        #     client.snapshot.restore repository: 'my-backups',
+        #                             snapshot: 'snapshot-5',
+        #                             body: {
+        #                               rename_pattern: "^(.*)$",
+        #                               rename_replacement: "restored_$1"
+        #                             }
+        #
+        # @note You cannot restore into an open index, you have to {Indices::Actions#close} it first
+        #
+        # @option arguments [String] :repository A repository name (*Required*)
+        # @option arguments [String] :snapshot A snapshot name (*Required*)
+        # @option arguments [Hash] :body Details of what to restore
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        #
+        def restore(arguments={})
+          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
+          raise ArgumentError, "Required argument 'snapshot' missing"   unless arguments[:snapshot]
+
+          valid_params = [
+            :master_timeout,
+            :wait_for_completion ]
+
+          repository = arguments.delete(:repository)
+          snapshot   = arguments.delete(:snapshot)
+
+          method = 'POST'
+          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot), '_restore' )
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = arguments[:body]
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Return information and statistics about terms in the fields of a particular document
+      #
+      # @example Get statistics for a specific document
+      #
+      #     client.indices.create index: 'my_index',
+      #                           body: {
+      #                             mappings: {
+      #                               my_type: {
+      #                                 properties: {
+      #                                   text: {
+      #                                     type: 'string',
+      #                                     term_vector: 'with_positions_offsets_payloads'
+      #                                   }
+      #                                 }
+      #                               }
+      #                             }
+      #                           }
+      #
+      #     client.index index: 'my_index', type: 'my_type', id: '1', body: { text: 'Foo Bar Fox' }
+      #
+      #     client.termvector index: 'my_index', type: 'my_type', id: '1'
+      #     # => { ..., "term_vectors" => { "text" => { "field_statistics" => { ... }, "terms" => { "bar" => ... } } }
+      #
+      # @option arguments [String] :index The name of the index (*Required*)
+      # @option arguments [String] :type The type of the document (*Required*)
+      # @option arguments [String] :id The document ID (*Required*)
+      # @option arguments [Hash] :body The request definition
+      # @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 the documents
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-termvectors.html
+      #
+      def termvector(arguments={})
+        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+        raise ArgumentError, "Required argument 'type' missing" unless arguments[:type]
+        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+        valid_params = [
+          :term_statistics,
+          :field_statistics,
+          :fields,
+          :offsets,
+          :positions,
+          :payloads,
+          :preference,
+          :routing,
+          :parent ]
+
+        method = 'GET'
+
+        path   = Utils.__pathify Utils.__escape(arguments[:index]),
+                                 Utils.__escape(arguments[:type]),
+                                 arguments[:id],
+                                 '_termvector'
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
+        body   = arguments[:body]
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end