RecordsCombiner (Flink : Table : Runtime 1.20.2-cp1 API)

All Known Implementing Classes:

AggCombiner, GlobalAggCombiner, LocalAggCombiner, RowTimeDeduplicateRecordsCombiner, TopNRecordsCombiner
```
@Internal
public interface RecordsCombiner
```
The RecordsCombiner is used to combine buffered records into state.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`RecordsCombiner.Factory`	A factory that creates a `RecordsCombiner`.
`static interface`	`RecordsCombiner.LocalFactory`	A factory that creates a `RecordsCombiner` used for combining at local stage.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`close()`	Release resources allocated by this combine function.
`void`	`combine(WindowKey windowKey, Iterator<org.apache.flink.table.data.RowData> records)`	Combines the buffered data into state based on the given window-key pair.

- Method Detail
  - combine
```
void combine(WindowKey windowKey,
             Iterator<org.apache.flink.table.data.RowData> records)
      throws Exception
```
    Combines the buffered data into state based on the given window-key pair.
    
    Parameters:
    
    windowKey - the window-key pair that the buffered data belong to, the window-key object is reused.
    
    records - the buffered data, the iterator and RowData objects are reused.
    
    Throws:
    
    Exception
  - close
```
void close()
    throws Exception
```
    Release resources allocated by this combine function.
    
    Throws:
    
    Exception