package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Functions
NewLogWriteConsumer returns a new *LogWriteConsumer[K, V] instance.
NewMapReduceAggregator returns a new MapReduceAggregator[E, K, Agg].
NewWindowedFlush returns a new WindowedFlush for the provided window.
# Constants
Windowed is a FlushTrigger type that enforces windowed flush periods, containing a window start and end time.
# Structs
AggInfo is a type used to communicate metadata from a FlushTrigger to the targets of the flush about the aggregation type period.
KeyValueLog is the type logged to log.Structured via the LogWriteConsumer.
LogWriteConsumer is an example flushConsumer, which provides an easy plug-and-play method of logging all the values V flushed by a MapReduceAggregator[V].
MapReduceAggregator performs aggregations on events of type E, keyed by type K, which are reduced into type Agg.
WindowedFlush is a FlushTrigger which triggers flushes on a wall clock aligned time window.
# Interfaces
FlushTrigger defines the interface used by aggregators, such as MapReduceAggregator, to determine when a flush of the current aggregation should be triggered.
# Type aliases
FlushKind is the type of FlushTrigger used, which communicates aggregation strategy.