Package org.apache.flink.cdc.connectors.mysql.source.offset

Class BinlogOffset

java.lang.Object

org.apache.flink.cdc.connectors.mysql.source.offset.BinlogOffset

All Implemented Interfaces:

Serializable, Comparable<BinlogOffset>

@PublicEvolving
public class BinlogOffset
extends Object
implements Comparable<BinlogOffset>, Serializable

A structure describes a fine grained offset in a binlog event including binlog position and gtid set etc.

This structure can also be used to deal the binlog event in transaction, a transaction may contain multiple change events, and each change event may contain multiple rows. When restart from a specific BinlogOffset, we need to skip the processed change events and the processed rows.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	BINLOG_FILENAME_OFFSET_KEY
static String	BINLOG_POSITION_OFFSET_KEY
static String	EVENTS_TO_SKIP_OFFSET_KEY
static String	GTID_SET_KEY
static String	OFFSET_KIND_KEY
static String	ROWS_TO_SKIP_OFFSET_KEY
static String	SERVER_ID_KEY
static String	TIMESTAMP_KEY

Constructor Summary

Constructors

Constructor	Description
BinlogOffset(Map<String,String> offset)

Method Summary

Modifier and Type	Method	Description
static BinlogOffsetBuilder	builder()	Create a BinlogOffsetBuilder.
int	compareTo(BinlogOffset that)	This method is inspired by HistoryRecordComparator.
boolean	equals(Object o)
String	getFilename()
String	getGtidSet()
Map<String,String>	getOffset()
BinlogOffsetKind	getOffsetKind()
long	getPosition()
long	getRestartSkipEvents()
long	getRestartSkipRows()
Long	getServerId()
long	getTimestampSec()
int	hashCode()
boolean	isAfter(BinlogOffset that)
boolean	isAtOrAfter(BinlogOffset that)
boolean	isAtOrBefore(BinlogOffset that)
boolean	isBefore(BinlogOffset that)
static BinlogOffset	ofBinlogFilePosition(String filename, long position)	Create offset from binlog filename and position.
static BinlogOffset	ofEarliest()	Create offset which represents the earliest accessible binlog offset.
static BinlogOffset	ofGtidSet(String gtidSet)	Create offset from GTID set.
static BinlogOffset	ofLatest()	Create offset which represents the latest offset at the point of access.
static BinlogOffset	ofNonStopping()
static BinlogOffset	ofTimestampSec(long timestampSec)	Create offset specified by a timestamp in second.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

BINLOG_FILENAME_OFFSET_KEY

public static final String BINLOG_FILENAME_OFFSET_KEY

See Also:

Constant Field Values

BINLOG_POSITION_OFFSET_KEY

public static final String BINLOG_POSITION_OFFSET_KEY

See Also:

Constant Field Values

EVENTS_TO_SKIP_OFFSET_KEY

public static final String EVENTS_TO_SKIP_OFFSET_KEY

See Also:

Constant Field Values

ROWS_TO_SKIP_OFFSET_KEY

public static final String ROWS_TO_SKIP_OFFSET_KEY

See Also:

Constant Field Values

GTID_SET_KEY

public static final String GTID_SET_KEY

See Also:

Constant Field Values

TIMESTAMP_KEY

public static final String TIMESTAMP_KEY

See Also:

Constant Field Values

SERVER_ID_KEY

public static final String SERVER_ID_KEY

See Also:

Constant Field Values

OFFSET_KIND_KEY

public static final String OFFSET_KIND_KEY

See Also:

Constant Field Values

Constructor Detail

BinlogOffset

@VisibleForTesting
public BinlogOffset(Map<String,String> offset)

Method Detail

builder

public static BinlogOffsetBuilder builder()

Create a BinlogOffsetBuilder.

ofBinlogFilePosition

public static BinlogOffset ofBinlogFilePosition(String filename,
                                                long position)

Create offset from binlog filename and position.

ofGtidSet

public static BinlogOffset ofGtidSet(String gtidSet)

Create offset from GTID set.

ofEarliest

public static BinlogOffset ofEarliest()

Create offset which represents the earliest accessible binlog offset.

ofLatest

public static BinlogOffset ofLatest()

Create offset which represents the latest offset at the point of access.

ofTimestampSec

public static BinlogOffset ofTimestampSec(long timestampSec)

Create offset specified by a timestamp in second.

ofNonStopping

@Internal
public static BinlogOffset ofNonStopping()

getOffset

public Map<String,String> getOffset()

getFilename

public String getFilename()

getPosition

public long getPosition()

getRestartSkipEvents

public long getRestartSkipEvents()

getRestartSkipRows

public long getRestartSkipRows()

getGtidSet

public String getGtidSet()

getTimestampSec

public long getTimestampSec()

getServerId

public Long getServerId()

getOffsetKind

@Nullable
public BinlogOffsetKind getOffsetKind()

compareTo

public int compareTo(BinlogOffset that)

This method is inspired by HistoryRecordComparator.

Specified by:

compareTo in interface Comparable<BinlogOffset>

isAtOrBefore

public boolean isAtOrBefore(BinlogOffset that)

isBefore

public boolean isBefore(BinlogOffset that)

isAtOrAfter

public boolean isAtOrAfter(BinlogOffset that)

isAfter

public boolean isAfter(BinlogOffset that)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object