elasticsearch-dsl 0.0.0 → 0.1.0

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

@@ -0,0 +1,32 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A single-value metric aggregation which returns the approximate count of distinct values
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :authors do
+        #         cardinality do
+        #           field 'author'
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-metrics-cardinality-aggregation.html
+        #
+        class Cardinality
+          include BaseComponent
+
+          option_method :field
+          option_method :precision_threshold
+          option_method :rehash
+          option_method :script
+          option_method :params
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A single-bucket aggregation which allows to aggregate from buckets on parent documents
+        # to buckets on the children documents
+        #
+        # @example Return the top commenters per article category
+        #
+        #     search do
+        #       aggregation :top_categories do
+        #         terms field: 'category' do
+        #           aggregation :comments do
+        #             children type: 'comment' do
+        #               aggregation :top_authors do
+        #                 terms field: 'author'
+        #               end
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        #
+        # See the integration test for a full example.
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-children-aggregation.html
+        #
+        class Children
+          include BaseAggregationComponent
+
+          option_method :type
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A multi-bucket aggregation which returns a histogram for date fields
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :daily do
+        #         field    'published_at'
+        #         interval 'day'
+        #         format   'yyyy-MM-dd'
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html
+        #
+        class DateHistogram
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :interval
+          option_method :pre_zone
+          option_method :post_zone
+          option_method :time_zone
+          option_method :pre_zone_adjust_large_interval
+          option_method :pre_offset
+          option_method :post_offset
+          option_method :format
+          option_method :min_doc_count
+          option_method :extended_bounds
+          option_method :order
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A multi-bucket aggregation which returns document counts for custom date ranges
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :compare_to_last_year do
+        #         date_range do
+        #           field    'published_at'
+        #           ranges [
+        #             { from: 'now-1M/M', to: 'now/M' },
+        #             { from: 'now-13M/M', to: 'now-12M/M' }
+        #           ]
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-daterange-aggregation.html
+        #
+        class DateRange
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :format
+          option_method :ranges
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,30 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # Defines a single bucket with documents matching the provided filter,
+        # usually to define scope for a nested aggregation
+        #
+        # @example
+        #
+        #    search do
+        #      aggregation :clicks_for_tag_one do
+        #        filter terms: { tags: ['one'] } do
+        #          aggregation :sum_clicks do
+        #            sum field: 'clicks'
+        #          end
+        #        end
+        #      end
+        #    end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html
+        #
+        class Filter
+          include BaseAggregationComponent
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A multi-bucket aggregation which defines multiple buckets matching the provided filters,
+        # usually to define scope for a nested aggregation
+        #
+        # @example
+        #
+        #    search do
+        #      aggregation :avg_clicks_per_tag_one_and_two do
+        #        filters do
+        #          filters one: { terms: { tags: ['one'] } },
+        #                  two: { terms: { tags: ['two'] } }
+        #
+        #          aggregation :avg do
+        #            avg field: 'clicks'
+        #          end
+        #        end
+        #      end
+        #    end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-filters-aggregation.html
+        #
+        class Filters
+          include BaseAggregationComponent
+
+          option_method :filters
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # An aggregation which will calculate the smallest bounding box required to encapsulate
+        # all of the documents matching the query
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           filter do
+        #             geo_bounding_box :location do
+        #               top_left     "40.8,-74.1"
+        #               bottom_right "40.4,-73.9"
+        #             end
+        #           end
+        #         end
+        #       end
+        #
+        #       aggregation :new_york do
+        #         geohash_grid field: 'location'
+        #       end
+        #
+        #       aggregation :map_zoom do
+        #         geo_bounds field: 'location'
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/guide/current/geo-bounds-agg.html
+        #
+        class GeoBounds
+          include BaseComponent
+
+          option_method :field
+          option_method :wrap_longitude
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A multi-bucket aggregation which will return document counts for distance perimeters,
+        # defined as ranges
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :venue_distances do
+        #         geo_distance do
+        #           field  :location
+        #           origin '38.9126352,1.4350621'
+        #           unit   'km'
+        #           ranges [ { to: 1 }, { from: 1, to: 5 }, { from: 5, to: 10 }, { from: 10 } ]
+        #         end
+        #       end
+        #     end
+        #
+        # See the integration test for a full example.
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/guide/current/geo-distance-agg.html
+        #
+        class GeoDistance
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :origin
+          option_method :ranges
+          option_method :unit
+          option_method :distance_type
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A multi-bucket aggregation which will return document counts for geohash grid cells
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :venue_distributions do
+        #         geohash_grid do
+        #           field     :location
+        #           precision 5
+        #         end
+        #       end
+        #     end
+        #
+        # See the integration test for a full example.
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/guide/current/geohash-grid-agg.html
+        #
+        class GeohashGrid
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :precision
+          option_method :size
+          option_method :shard_size
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # Defines a single bucket of all the documents matching a query
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :all_documents do
+        #         global
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-global-aggregation.html
+        #
+        class Global
+          include BaseComponent
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A multi-bucket aggregation which returns document counts for a defined numerical interval
+        #
+        # @example
+        #
+        #    search do
+        #      aggregation :age do
+        #        histogram do
+        #          field   'age'
+        #          interval 5
+        #        end
+        #      end
+        #    end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html
+        #
+        class Histogram
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :interval
+          option_method :min_doc_count
+          option_method :extended_bounds
+          option_method :order
+          option_method :keyed
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Elasticsearch
+  module DSL
+    module Search
+      module Aggregations
+
+        # A multi-bucket aggregation which returns document counts for defined IP ranges
+        #
+        # @example
+        #
+        #     search do
+        #       aggregation :ips do
+        #         ip_range do
+        #           field 'ip'
+        #           ranges [ { mask: '10.0.0.0/25' }, { mask: '10.0.0.127/25' } ]
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-iprange-aggregation.html
+        #
+        class IpRange
+          include BaseAggregationComponent
+
+          option_method :field
+          option_method :ranges
+        end
+
+      end
+    end
+  end
+end