Module: Axiom::Algebra::Summarization::Methods

Defined in:

lib/axiom/algebra/summarization.rb

Instance Method Summary

• #summarize(summarize_with = TABLE_DEE, *args) {|function| ... } ⇒ Summarization

  Return a summarized relation.

Instance Method Details

#summarize(summarize_with = TABLE_DEE, *args) {|function| ... } ⇒ Summarization

Return a summarized relation

Examples:

with no arguments

summarization = relation.summarize do |context|
  context.add(:count, context[:id].count)
end

with a relation

summarization = relation.summarize(relation.project([:name])) do |context|
  context.add(:count, context[:id].count)
end

with a header

summarization = relation.summarize([:name]) do |context|
  context.add(:count, context[:id].count)
end

with summarizers

summarization = relation.summarize([:name], summarizers)

Parameters:

• summarize_with (Relation, Header, #to_ary) (defaults to: TABLE_DEE)

Yields:

• (function) —

  Evaluate a summarization function

Yield Parameters:

• context (Evaluator::Context) —

  the context to evaluate the function within

Returns:

• (Summarization)

# File 'lib/axiom/algebra/summarization.rb', line 188

def summarize(summarize_with = TABLE_DEE, *args, &block)
  summarize_per = coerce_to_relation(summarize_with)
  summarizers   = coerce_to_summarizers(summarize_per, *args, &block)
  Summarization.new(self, summarize_per, summarizers)
end