org.apache.flink.connector.file.table

Class FileSystemTableSink.TableRollingPolicy

java.lang.Object

org.apache.flink.streaming.api.functions.sink.filesystem.rollingpolicies.CheckpointRollingPolicy<RowData,String>

org.apache.flink.connector.file.table.FileSystemTableSink.TableRollingPolicy

All Implemented Interfaces:

Serializable, RollingPolicy<RowData,String>

Enclosing class:

FileSystemTableSink

public static class FileSystemTableSink.TableRollingPolicy
extends CheckpointRollingPolicy<RowData,String>

Table RollingPolicy, it extends CheckpointRollingPolicy for bulk writers.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.streaming.api.functions.sink.filesystem.rollingpolicies.CheckpointRollingPolicy

CheckpointRollingPolicy.PolicyBuilder<IN,BucketID,T extends CheckpointRollingPolicy.PolicyBuilder<IN,BucketID,T>>

Constructor Summary

Constructors

Constructor and Description
TableRollingPolicy(boolean rollOnCheckpoint, long rollingFileSize, long rollingTimeInterval, long inactivityInterval)

Method Summary

Modifier and Type	Method and Description
boolean	shouldRollOnCheckpoint(PartFileInfo<String> partFileState) Determines if the in-progress part file for a bucket should roll on every checkpoint.
boolean	shouldRollOnEvent(PartFileInfo<String> partFileState, RowData element) Determines if the in-progress part file for a bucket should roll based on its current state, e.g.
boolean	shouldRollOnProcessingTime(PartFileInfo<String> partFileState, long currentTime) Determines if the in-progress part file for a bucket should roll based on a time condition.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableRollingPolicy

public TableRollingPolicy(boolean rollOnCheckpoint,
                          long rollingFileSize,
                          long rollingTimeInterval,
                          long inactivityInterval)

Method Detail

shouldRollOnCheckpoint

public boolean shouldRollOnCheckpoint(PartFileInfo<String> partFileState)

Description copied from interface: RollingPolicy

Determines if the in-progress part file for a bucket should roll on every checkpoint.

Specified by:

shouldRollOnCheckpoint in interface RollingPolicy<RowData,String>

Overrides:

shouldRollOnCheckpoint in class CheckpointRollingPolicy<RowData,String>

Parameters:

partFileState - the state of the currently open part file of the bucket.

Returns:

True if the part file should roll, false otherwise.

shouldRollOnEvent

public boolean shouldRollOnEvent(PartFileInfo<String> partFileState,
                                 RowData element)
                          throws IOException

Description copied from interface: RollingPolicy

Determines if the in-progress part file for a bucket should roll based on its current state, e.g. its size.

Specified by:

shouldRollOnEvent in interface RollingPolicy<RowData,String>

Specified by:

shouldRollOnEvent in class CheckpointRollingPolicy<RowData,String>

Parameters:

partFileState - the state of the currently open part file of the bucket.

element - the element being processed.

Returns:

True if the part file should roll, false otherwise.

Throws:

IOException

shouldRollOnProcessingTime

public boolean shouldRollOnProcessingTime(PartFileInfo<String> partFileState,
                                          long currentTime)

Description copied from interface: RollingPolicy

Determines if the in-progress part file for a bucket should roll based on a time condition.

Specified by:

shouldRollOnProcessingTime in interface RollingPolicy<RowData,String>

Specified by:

shouldRollOnProcessingTime in class CheckpointRollingPolicy<RowData,String>

Parameters:

partFileState - the state of the currently open part file of the bucket.

currentTime - the current processing time.

Returns:

True if the part file should roll, false otherwise.