Class: Elasticband::Aggregation

Inherits:

Object

• Object
• Elasticband::Aggregation

Defined in:

lib/elasticband/aggregation.rb,
lib/elasticband/aggregation/max.rb,
lib/elasticband/aggregation/terms.rb,
lib/elasticband/aggregation/filter.rb,
lib/elasticband/aggregation/nested.rb,
lib/elasticband/aggregation/top_hits.rb,
lib/elasticband/aggregation/field_based.rb

Direct Known Subclasses

FieldBased, Filter, Nested, TopHits

Defined Under Namespace

Classes: FieldBased, Filter, Max, Nested, Terms, TopHits

Constant Summary

PARSE_AGGREGATIONS =

%i(group_by group_max top_hits group_by_filter).freeze

Instance Attribute Summary

• #name ⇒ Object

  Returns the value of attribute name.

Class Method Summary

• .merge(*aggregations) ⇒ Object
• .parse(options) ⇒ Object

  Parses some options to a Elasticsearch syntax, aggregations can be nested in another.

Instance Method Summary

• #initialize(name) ⇒ Aggregation constructor

  A new instance of Aggregation.

• #to_h(aggregation_hash = {}) ⇒ Object

Constructor Details

#initialize(name) ⇒ Aggregation

Returns a new instance of Aggregation.

# File 'lib/elasticband/aggregation.rb', line 14

def initialize(name)
  self.name = name.to_s.gsub(/\W/, '_'.freeze).to_sym
end

Instance Attribute Details

#name ⇒ Object

Returns the value of attribute name.

# File 'lib/elasticband/aggregation.rb', line 12

def name
  @name
end

Class Method Details

.merge(*aggregations) ⇒ Object

# File 'lib/elasticband/aggregation.rb', line 55

def merge(*aggregations)
  aggregations.each_with_object({}) { |a, h| h.merge!(a.to_h) }
end

.parse(options) ⇒ Object

Parses some options to a Elasticsearch syntax, aggregations can be nested in another.

#### Options

• ‘group_by:` Count results by the value of an attribute using `terms` filter. It can receive an array with some attributes:

  • ‘size:` Size of the results calculated in each shard (www.elastic.co/guide/en/elasticsearch/reference/1.x/search-aggregations-bucket-terms-aggregation.html#_size)

  • ‘script:` Generates terms defined by the script

• ‘group_max:` Group results by maximum value of a field It can receive an array with some attributes:

  • ‘script:` Generates max defined by the script

• ‘top_hits:` A number of results that should be return inside the group ranked by score.

• ‘group_by_filter:` Filter and group results with a name using Elasticband::Filter.parse options

#### Examples “‘ Aggregation.parse(group_by: :status)

> { status: { terms: { field: :status } } }

Aggregation.parse(group_max: :contents_count)

> { status: { max: { field: :contents_count } } }

Aggregation.parse(group_by: [:status, size: 5, top_hits: 3])

> { status: { terms: { field: :status, size: 5 }, aggs: { top_status: { top_hits: 3 } } } }

Aggregation.parse(group_by_filter: [:published_results, only: { status: :published }])

> { published_results: { filter: { term: { status: :published } } } }

“‘

# File 'lib/elasticband/aggregation.rb', line 51

def parse(options)
  merge(*parse_aggregations(options))
end

Instance Method Details

#to_h(aggregation_hash = {}) ⇒ Object

# File 'lib/elasticband/aggregation.rb', line 18

def to_h(aggregation_hash = {})
  { name => aggregation_hash }
end