streaming

Documentation

Overview

Package streaming implement the flow framework to provide the sliding window, top-n aggregation, and etc.

Index

• func New(name string, source flow.Source) flow.Flow
• func NewTumblingTimeWindows(size time.Duration, maxFlushInterval time.Duration) flow.WindowAssigner
• type TopNOption
  • func OrderBy(sort TopNSort) TopNOption
  • func WithGroupKeyExtractor(groupKeyExtractor func(flow.StreamRecord) string) TopNOption
  • func WithSortKeyExtractor(sortKeyExtractor func(flow.StreamRecord) int64) TopNOption
• type TopNSort
• type Tuple2

Functions

func New

func New(name string, source flow.Source) flow.Flow

New returns a new streaming flow.

func NewTumblingTimeWindows

func NewTumblingTimeWindows(size time.Duration, maxFlushInterval time.Duration) flow.WindowAssigner

NewTumblingTimeWindows return tumbling-time windows.

Types

type TopNOption

type TopNOption func(aggregator *topNAggregatorGroup)

TopNOption is the option to set up a top-n aggregator group.

func OrderBy

func OrderBy(sort TopNSort) TopNOption

OrderBy sets the sorting order.

func WithGroupKeyExtractor

func WithGroupKeyExtractor(groupKeyExtractor func(flow.StreamRecord) string) TopNOption

WithGroupKeyExtractor extract group key from the StreamRecord.

func WithSortKeyExtractor

func WithSortKeyExtractor(sortKeyExtractor func(flow.StreamRecord) int64) TopNOption

WithSortKeyExtractor sets a closure to extract the sorting key.

type TopNSort

type TopNSort uint8

TopNSort defines the order of sorting.

const (
	DESC TopNSort = iota
	ASC
)

The available order of sorting.

type Tuple2

type Tuple2 struct {
	V1 interface{} `json:"v1"`
	V2 interface{} `json:"v2"`
}

Tuple2 is a tuple with 2 fields. Each field may be a separate type.