Package org.apache.flink.table.runtime.operators.aggregate.asyncwindow.buffers

Class AsyncStateRecordsWindowBuffer

java.lang.Object

org.apache.flink.table.runtime.operators.aggregate.asyncwindow.buffers.AsyncStateRecordsWindowBuffer

All Implemented Interfaces:

AsyncStateWindowBuffer

public final class AsyncStateRecordsWindowBuffer
extends Object
implements AsyncStateWindowBuffer

An implementation of AsyncStateWindowBuffer that buffers input elements in a WindowBytesMultiMap and combines buffered elements into async state when flushing.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AsyncStateRecordsWindowBuffer.Factory	Factory to create AsyncStateRecordsWindowBuffer with AsyncStateRecordsCombiner.Factory.

Constructor Summary

Constructors

Constructor	Description
AsyncStateRecordsWindowBuffer(Object operatorOwner, org.apache.flink.runtime.memory.MemoryManager memoryManager, long memorySize, AsyncStateRecordsCombiner combineFunction, PagedTypeSerializer<org.apache.flink.table.data.RowData> keySer, AbstractRowDataSerializer<org.apache.flink.table.data.RowData> inputSer, RecordEqualiser keyEqualiser, AsyncStateKeyContext keyContext, ZoneId shiftTimeZone)

Method Summary

Modifier and Type	Method	Description
org.apache.flink.api.common.state.v2.StateFuture<Void>	addElement(org.apache.flink.table.data.RowData dataKey, long sliceEnd, org.apache.flink.table.data.RowData element)	Adds an element with associated key into the buffer.
org.apache.flink.api.common.state.v2.StateFuture<Void>	advanceProgress(org.apache.flink.table.data.RowData currentKey, long progress)	Advances the progress time, the progress time is watermark if working in event-time mode, or current processing time if working in processing-time mode.
void	close()	Release resources allocated by this buffer.
org.apache.flink.api.common.state.v2.StateFuture<Void>	flush(org.apache.flink.table.data.RowData currentKey)	Flushes all intermediate buffered data to the underlying backend or output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AsyncStateRecordsWindowBuffer

public AsyncStateRecordsWindowBuffer(Object operatorOwner,
 org.apache.flink.runtime.memory.MemoryManager memoryManager,
 long memorySize,
 AsyncStateRecordsCombiner combineFunction,
 PagedTypeSerializer<org.apache.flink.table.data.RowData> keySer,
 AbstractRowDataSerializer<org.apache.flink.table.data.RowData> inputSer,
 RecordEqualiser keyEqualiser,
 AsyncStateKeyContext keyContext,
 ZoneId shiftTimeZone)

Method Details

addElement

public org.apache.flink.api.common.state.v2.StateFuture<Void> addElement(org.apache.flink.table.data.RowData dataKey,
 long sliceEnd,
 org.apache.flink.table.data.RowData element)
                                                                  throws Exception

Description copied from interface: AsyncStateWindowBuffer

Adds an element with associated key into the buffer. The buffer may temporarily buffer the element, or immediately write it to the stream.

It may be that adding this element fills up an internal buffer and causes the buffer flushing of a batch of internally buffered elements.

Specified by:

addElement in interface AsyncStateWindowBuffer

Parameters:

dataKey - the key associated with the element

element - The element to add.

Throws:

Exception - Thrown, if the element cannot be added to the buffer, or if the flushing throws an exception.

advanceProgress

public org.apache.flink.api.common.state.v2.StateFuture<Void> advanceProgress(@Nullable
 org.apache.flink.table.data.RowData currentKey,
 long progress)
                                                                       throws Exception

Description copied from interface: AsyncStateWindowBuffer

Advances the progress time, the progress time is watermark if working in event-time mode, or current processing time if working in processing-time mode.

This will potentially flush buffered data into states or to the output stream, because the watermark advancement may be in a very small step, but we don't need to flush buffered data for every watermark advancement.

Note: There may be multiple different keys within the buffer. When flushing them to the async state, only the async state request for the current key of the operator will be returned as a StateFuture. Requests for async states for other keys will not be waited on.

Specified by:

advanceProgress in interface AsyncStateWindowBuffer

Parameters:

currentKey - the current key when processing and is used to return the result of accessing async state associated with the same key. If it is null, it means that the returns of asynchronous state requests for all keys will not be awaited.

progress - the current progress time

Returns:

the future of the flush operation about current key if the current key is not null, else a StateFutureUtils.completedVoidFuture() will be returned.

Throws:

Exception

flush

public org.apache.flink.api.common.state.v2.StateFuture<Void> flush(@Nullable
 org.apache.flink.table.data.RowData currentKey)
                                                             throws Exception

Description copied from interface: AsyncStateWindowBuffer

Flushes all intermediate buffered data to the underlying backend or output stream.

Note: There may be multiple different keys within the buffer. When flushing them to the async state, only the async state request for the current key of the operator will be returned as a StateFuture. Requests for async states for other keys will not be waited on.

Specified by:

flush in interface AsyncStateWindowBuffer

Parameters:

currentKey - the current key when processing and is used to return the result of accessing async state associated with the same key. If it is null, it means that the returns of asynchronous state requests for all keys will not be awaited.

Returns:

the future of the flush operation about current key if the current key is not null, else a StateFutureUtils.completedVoidFuture() will be returned.

Throws:

Exception - Thrown if the buffer cannot be flushed, or if the output stream throws an exception.

close

public void close()
           throws Exception

Description copied from interface: AsyncStateWindowBuffer

Release resources allocated by this buffer.

Specified by:

close in interface AsyncStateWindowBuffer

Throws:

Exception