dagg

Documentation

Overview

Package dagg provides a simple interface for aggregating data.

Index

• type Agg
  • func (o *Agg[T]) Add(value T) error
  • func (o *Agg[T]) Each(fn func(Row) error) error
  • func (o *Agg[T]) GroupBy(fn GroupFn[T])
  • func (o *Agg[T]) Reduce(name string, reduceFunc func(any, T) any, finalFunc func(any) any)
  • func (o *Agg[T]) Result() ([]Row, error)
• type Field
• type GroupFn
• type OptFn
• type Row

Types

type Agg

type Agg[T any] struct {
	// contains filtered or unexported fields
}

Agg is an aggregation struct with methods to perform aggregations.

func (*Agg[T]) Add

func (o *Agg[T]) Add(value T) error

Add adds a value to be processed and aggregated.

func (*Agg[T]) Each

func (o *Agg[T]) Each(fn func(Row) error) error

Each passes the produced aggregation row by calling fn

func (*Agg[T]) GroupBy

func (o *Agg[T]) GroupBy(fn GroupFn[T])

GroupBy sets the group function for the aggregation.

func (*Agg[T]) Reduce

func (o *Agg[T]) Reduce(name string, reduceFunc func(any, T) any, finalFunc func(any) any)

Reduce adds a reduce function for the aggregation.

func (*Agg[T]) Result

func (o *Agg[T]) Result() ([]Row, error)

type Field

type Field = drow.Field

Field is a drow.Field

type GroupFn

type GroupFn[T any] func(T) (any, error)

GroupFn type of function that will produce they key for the data to be grouped.

type OptFn

type OptFn[T any] func(*Agg[T])

OptFn type of the option function for aggBuilder

type Row

type Row = drow.Row

Row is a drow.Row