elasticsearch-dsl 0.0.0 → 0.1.0

data/lib/elasticsearch/dsl/search/aggregations/max.rb

@@ -0,0 +1,25 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A single-value metric aggregation which returns the maximum value from numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :max_clicks do
+        #         max field: 'clicks'
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-metrics-max-aggregation.html
+        #
+        class Max
+          include BaseComponent
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/min.rb

@@ -0,0 +1,25 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A single-value metric aggregation which returns the minimum value from numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :min_clicks do
+        #         min field: 'clicks'
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-metrics-min-aggregation.html
+        #
+        class Min
+          include BaseComponent
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/nested.rb

@@ -0,0 +1,34 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A single-bucket aggregation which allows to aggregate on nested fields
+        #
+        # @example
+        #
+        #    search do
+        #      aggregation :offers do
+        #        nested do
+        #          path 'offers'
+        #          aggregation :min_price do
+        #            min field: 'offers.price'
+        #          end
+        #        end
+        #      end
+        #    end
+        #
+        # See the integration test for a full example.
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-nested-aggregation.html
+        #
+        class Nested
+          include BaseAggregationComponent
+
+          option_method :path
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/percentile_ranks.rb

@@ -0,0 +1,34 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A multi-value metrics aggregation which calculates percentile ranks on numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :load_time_outliers do
+        #         percentile_ranks do
+        #           field 'load_time'
+        #           values [ 15, 30 ]
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-rank-aggregation.html
+        #
+        class PercentileRanks
+          include BaseComponent
+
+          option_method :field
+          option_method :values
+          option_method :script
+          option_method :params
+          option_method :compression
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/percentiles.rb

@@ -0,0 +1,33 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A multi-value metrics aggregation which calculates percentiles on numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :load_time_outliers do
+        #         percentiles do
+        #           field 'load_time'
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-aggregation.html
+        #
+        class Percentiles
+          include BaseComponent
+
+          option_method :field
+          option_method :percents
+          option_method :script
+          option_method :params
+          option_method :compression
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/range.rb

@@ -0,0 +1,53 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A multi-bucket aggregation which returns document counts for custom numerical ranges,
+        # which define the buckets
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :clicks do
+        #         range field: 'clicks',
+        #               ranges: [
+        #                 { to: 10 },
+        #                 { from: 10, to: 20 }
+        #               ]
+        #       end
+        #     end
+        #
+        # @example Using custom names for the ranges
+        #
+        #     search do
+        #       aggregation :clicks do
+        #         range do
+        #           field 'clicks'
+        #           key :low, to: 10
+        #           key :mid, from: 10, to: 20
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-range-aggregation.html
+        class Range
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :script
+          option_method :params
+
+          def key(key, value)
+            @hash[name].update(@args) if @args
+            @hash[name][:keyed]  ||= true
+            @hash[name][:ranges] ||= []
+            @hash[name][:ranges] << value.merge(key: key) unless @hash[name][:ranges].any? { |i| i[:key] == key }
+            self
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/reverse_nested.rb

@@ -0,0 +1,37 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A single-bucket aggregation which allows to aggregate on "parent" documents
+        # from the nested documents
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :offers do
+        #         nested do
+        #           path 'offers'
+        #           aggregation :top_categories do
+        #             reverse_nested do
+        #               aggregation :top_category_per_offer do
+        #                 terms field: 'category'
+        #               end
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # See the integration test for a full example.
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/guide/current/nested-aggregation.html
+        #
+        class ReverseNested
+          include BaseAggregationComponent
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/scripted_metric.rb

@@ -0,0 +1,39 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A metric aggregation which uses scripts for the computation
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :clicks_for_one do
+        #         scripted_metric do
+        #           init_script "_agg['transactions'] = []"
+        #           map_script  "if (doc['tags'].value.contains('one')) { _agg.transactions.add(doc['clicks'].value) }"
+        #           combine_script "sum = 0; for (t in _agg.transactions) { sum += t }; return sum"
+        #           reduce_script "sum = 0; for (a in _aggs) { sum += a }; return sum"
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-metrics-scripted-metric-aggregation.html
+        #
+        # See the integration test for a full example.
+        #
+        class ScriptedMetric
+          include BaseComponent
+
+          option_method :init_script
+          option_method :map_script
+          option_method :combine_script
+          option_method :reduce_script
+          option_method :params
+          option_method :lang
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/significant_terms.rb

@@ -0,0 +1,45 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A multi-bucket aggregation that returns interesting or unusual occurrences of terms in a set
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         match :title do
+        #           query 'fink'
+        #         end
+        #       end
+        #
+        #       aggregation :interesting_terms do
+        #         significant_terms do
+        #           field :body
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-significantterms-aggregation.html
+        #
+        class SignificantTerms
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :size
+          option_method :shard_size
+          option_method :min_doc_count
+          option_method :shard_min_doc_count
+          option_method :include
+          option_method :exclude
+          option_method :background_filter
+          option_method :mutual_information
+          option_method :chi_square
+          option_method :gnd
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/stats.rb

@@ -0,0 +1,25 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A multi-value metrics aggregation which returns statistical information on numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :clicks_stats do
+        #         stats field: 'clicks'
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html
+        #
+        class Stats
+          include BaseComponent
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/sum.rb

@@ -0,0 +1,25 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A single-value metric aggregation which returns the sum of numeric values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :sum_clicks do
+        #         sum field: 'clicks'
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-metrics-sum-aggregation.html
+        #
+        class Sum
+          include BaseComponent
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/terms.rb

@@ -0,0 +1,33 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A multi-bucket aggregation which returns the collection of terms and their document counts
+        #
+        # @example
+        #
+        #     aggregation :tags do
+        #       terms field: 'tags'
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html
+        #
+        class Terms
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :size
+          option_method :shard_size
+          option_method :order
+          option_method :min_doc_count
+          option_method :shard_min_doc_count
+          option_method :script
+          option_method :include
+          option_method :exclude
+        end
+
+      end
+    end
+  end
+end

data/lib/elasticsearch/dsl/search/aggregations/top_hits.rb

@@ -0,0 +1,35 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A metric aggregator which returns the most relevant documents per bucket
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :tags do
+        #         terms do
+        #           field 'tags'
+        #
+        #           aggregation :top_hits do
+        #             top_hits sort: [ clicks: { order: 'desc' } ], _source: { include: 'title' }
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-aggregation.html
+        #
+        class TopHits
+          include BaseComponent
+
+          option_method :from
+          option_method :size
+          option_method :sort
+        end
+
+      end
+    end
+  end
+end