IN
- Type of the elements emitted by this sinkpublic abstract class GenericWriteAheadSink<IN> extends AbstractStreamOperator<IN> implements OneInputStreamOperator<IN,IN>
Incoming records are stored within a AbstractStateBackend
, and only committed if a
checkpoint is completed.
AbstractStreamOperator.CountingOutput<OUT>
Modifier and Type | Field and Description |
---|---|
protected static org.slf4j.Logger |
LOG |
protected TypeSerializer<IN> |
serializer |
chainingStrategy, config, latencyStats, metrics, output, timeServiceManager
Constructor and Description |
---|
GenericWriteAheadSink(CheckpointCommitter committer,
TypeSerializer<IN> serializer,
String jobID) |
Modifier and Type | Method and Description |
---|---|
void |
close()
This method is called after all records have been added to the operators via the methods
OneInputStreamOperator.processElement(StreamRecord) , or
TwoInputStreamOperator.processElement1(StreamRecord) and
TwoInputStreamOperator.processElement2(StreamRecord) . |
void |
initializeState(StateInitializationContext context)
Stream operators with state which can be restored need to override this hook method.
|
void |
notifyCheckpointComplete(long checkpointId)
This method is called as a notification once a distributed checkpoint has been completed.
|
void |
open()
This method is called immediately before any elements are processed, it should contain the
operator's initialization logic, e.g.
|
void |
processElement(StreamRecord<IN> element)
Processes one element that arrived at this operator.
|
protected abstract boolean |
sendValues(Iterable<IN> values,
long checkpointId,
long timestamp)
Write the given element into the backend.
|
void |
snapshotState(StateSnapshotContext context)
Stream operators with state, which want to participate in a snapshot need to override this hook method.
|
dispose, getChainingStrategy, getContainingTask, getCurrentKey, getExecutionConfig, getInternalTimerService, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getUserCodeClassloader, initializeState, numEventTimeTimers, numProcessingTimeTimers, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processWatermark, processWatermark1, processWatermark2, reportOrForwardLatencyMarker, setChainingStrategy, setCurrentKey, setKeyContextElement1, setKeyContextElement2, setup, snapshotState
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
processLatencyMarker, processWatermark
dispose, getChainingStrategy, getMetricGroup, getOperatorID, initializeState, prepareSnapshotPreBarrier, setChainingStrategy, setKeyContextElement1, setKeyContextElement2, setup, snapshotState
getCurrentKey, setCurrentKey
protected static final org.slf4j.Logger LOG
protected final TypeSerializer<IN> serializer
public GenericWriteAheadSink(CheckpointCommitter committer, TypeSerializer<IN> serializer, String jobID) throws Exception
Exception
public void initializeState(StateInitializationContext context) throws Exception
AbstractStreamOperator
initializeState
in class AbstractStreamOperator<IN>
context
- context that allows to register different states.Exception
public void open() throws Exception
AbstractStreamOperator
The default implementation does nothing.
open
in interface StreamOperator<IN>
open
in class AbstractStreamOperator<IN>
Exception
- An exception in this method causes the operator to fail.public void close() throws Exception
AbstractStreamOperator
OneInputStreamOperator.processElement(StreamRecord)
, or
TwoInputStreamOperator.processElement1(StreamRecord)
and
TwoInputStreamOperator.processElement2(StreamRecord)
.
The method is expected to flush all remaining buffered data. Exceptions during this flushing of buffered should be propagated, in order to cause the operation to be recognized asa failed, because the last data items are not processed properly.
close
in interface StreamOperator<IN>
close
in class AbstractStreamOperator<IN>
Exception
- An exception in this method causes the operator to fail.public void snapshotState(StateSnapshotContext context) throws Exception
AbstractStreamOperator
snapshotState
in class AbstractStreamOperator<IN>
context
- context that provides information and means required for taking a snapshotException
public void notifyCheckpointComplete(long checkpointId) throws Exception
CheckpointListener
notifyCheckpointComplete
in interface CheckpointListener
notifyCheckpointComplete
in class AbstractStreamOperator<IN>
checkpointId
- The ID of the checkpoint that has been completed.Exception
protected abstract boolean sendValues(Iterable<IN> values, long checkpointId, long timestamp) throws Exception
values
- The values to be writtencheckpointId
- The checkpoint ID of the checkpoint to be writtentimestamp
- The wall-clock timestamp of the checkpointException
public void processElement(StreamRecord<IN> element) throws Exception
OneInputStreamOperator
processElement
in interface OneInputStreamOperator<IN,IN>
Exception
Copyright © 2014–2020 The Apache Software Foundation. All rights reserved.