Package org.apache.flink.runtime.checkpoint

Class ZooKeeperCheckpointIDCounter

java.lang.Object

org.apache.flink.runtime.checkpoint.ZooKeeperCheckpointIDCounter

All Implemented Interfaces:

CheckpointIDCounter

public class ZooKeeperCheckpointIDCounter
extends Object
implements CheckpointIDCounter

CheckpointIDCounter instances for JobManagers running in HighAvailabilityMode.ZOOKEEPER.

Each counter creates a ZNode:

 +----O /flink/checkpoint-counter/<job-id> 1 [persistent]
 .
 .
 .
 +----O /flink/checkpoint-counter/<job-id> N [persistent]
 

The checkpoints IDs are required to be ascending (per job). In order to guarantee this in case of job manager failures we use ZooKeeper to have a shared counter across job manager instances.

Field Summary

Fields inherited from interface org.apache.flink.runtime.checkpoint.CheckpointIDCounter

INITIAL_CHECKPOINT_ID

Constructor Summary

Constructors

Constructor	Description
ZooKeeperCheckpointIDCounter(org.apache.flink.shaded.curator5.org.apache.curator.framework.CuratorFramework client, LastStateConnectionStateListener connectionStateListener)	Creates a ZooKeeperCheckpointIDCounter instance.

Method Summary

Modifier and Type	Method	Description
long	get()	Atomically gets the current checkpoint ID.
long	getAndIncrement()	Atomically increments the current checkpoint ID.
void	setCount(long newId)	Sets the current checkpoint ID.
CompletableFuture<Void>	shutdown(org.apache.flink.api.common.JobStatus jobStatus)	Shuts the CheckpointIDCounter service.
void	start()	Starts the CheckpointIDCounter service down.

Methods inherited from class java.lang.Object

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

Constructor Details

ZooKeeperCheckpointIDCounter

public ZooKeeperCheckpointIDCounter(org.apache.flink.shaded.curator5.org.apache.curator.framework.CuratorFramework client,
 LastStateConnectionStateListener connectionStateListener)

Creates a ZooKeeperCheckpointIDCounter instance.

Parameters:

client - Curator ZooKeeper client

Method Details

start

public void start()
           throws Exception

Description copied from interface: CheckpointIDCounter

Starts the CheckpointIDCounter service down.

Specified by:

start in interface CheckpointIDCounter

Throws:

Exception

shutdown

public CompletableFuture<Void> shutdown(org.apache.flink.api.common.JobStatus jobStatus)

Description copied from interface: CheckpointIDCounter

Shuts the CheckpointIDCounter service.

The job status is forwarded and used to decide whether state should actually be discarded or kept.

Specified by:

shutdown in interface CheckpointIDCounter

Parameters:

jobStatus - Job state on shut down

Returns:

The CompletableFuture holding the result of the shutdown operation.

getAndIncrement

public long getAndIncrement()
                     throws Exception

Description copied from interface: CheckpointIDCounter

Atomically increments the current checkpoint ID.

Specified by:

getAndIncrement in interface CheckpointIDCounter

Returns:

The previous checkpoint ID

Throws:

Exception

get

public long get()

Description copied from interface: CheckpointIDCounter

Atomically gets the current checkpoint ID.

Specified by:

get in interface CheckpointIDCounter

Returns:

The current checkpoint ID

setCount

public void setCount(long newId)
              throws Exception

Description copied from interface: CheckpointIDCounter

Sets the current checkpoint ID.

Specified by:

setCount in interface CheckpointIDCounter

Parameters:

newId - The new ID

Throws:

Exception