streaming

package

v0.11.0 Latest Latest Go to latest Published: Aug 24, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Details

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

This section is empty.

This section is empty.

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

New returns a new streaming flow.

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

NewTumblingTimeWindows return tumbling-time windows.

func TopN[K TopSortKey](wf flow.WindowedFlow, topNum int, sortKeyExtractor func(flow.StreamRecord) K, opts ...any) flow.Flow

TopN creates a TopN flow from a windowed flow.

type TopNOption func(*topNConfig)

TopNOption is the option to set up a TopN config.

func OrderBy(sort TopNSort) TopNOption

OrderBy sets the sorting order.

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

WithGroupKeyExtractor extract group key from the StreamRecord.

func WithKeyExtractor(keyExtractor func(flow.StreamRecord) uint64) TopNOption

WithKeyExtractor sets a closure to extract the key.

type TopNSort uint8

TopNSort defines the order of sorting.

const (
	DESC TopNSort = iota
	ASC
)

The available order of sorting.

type TopSortKey interface {
	int64 | float64
}

TopSortKey defines the constraint for sort keys in TopN operations.

type Tuple2[K TopSortKey] struct {
	V1 K                 `json:"v1"`
	V2 flow.StreamRecord `json:"v2"`
}

Tuple2 is a tuple with 2 fields. V1 is the sort key (K), V2 is the record.

Path	Synopsis
sources Package sources implements data sources to sink data into the flow framework.	Package sources implements data sources to sink data into the flow framework.