org.apache.hudi.async

Class HoodieAsyncService

java.lang.Object

org.apache.hudi.async.HoodieAsyncService

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HoodieAsyncTableService

public abstract class HoodieAsyncService
extends Object
implements Serializable

Base Class for running archive/clean/delta-sync/compaction/clustering in separate thread and controlling their life-cycles.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	hasError

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HoodieAsyncService()
protected	HoodieAsyncService(boolean runInDaemonMode)

Method Summary

Modifier and Type	Method and Description
void	enqueuePendingAsyncServiceInstant(HoodieInstant instant) Enqueues new pending clustering instant.
boolean	hasError()
boolean	isRunInDaemonMode()
boolean	isShutdown()
boolean	isShutdownRequested()
boolean	isStarted()
void	shutdown(boolean force) Request shutdown either forcefully or gracefully.
void	start(Function<Boolean,Boolean> onShutdownCallback) Start the service.
protected abstract Pair<CompletableFuture,ExecutorService>	startService() Service implementation.
void	waitForShutdown() Wait till the service shutdown.
void	waitTillPendingAsyncServiceInstantsReducesTo(int numPending) Wait till outstanding pending compaction/clustering reduces to the passed in value.

Methods inherited from class java.lang.Object

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

Field Detail

hasError

protected boolean hasError

Constructor Detail

HoodieAsyncService

protected HoodieAsyncService()

HoodieAsyncService

protected HoodieAsyncService(boolean runInDaemonMode)

Method Detail

isStarted

public boolean isStarted()

isShutdownRequested

public boolean isShutdownRequested()

isShutdown

public boolean isShutdown()

hasError

public boolean hasError()

waitForShutdown

public void waitForShutdown()
                     throws ExecutionException,
                            InterruptedException

Wait till the service shutdown. If the service shutdown with exception, it will be thrown

Throws:

ExecutionException

InterruptedException

shutdown

public void shutdown(boolean force)

Request shutdown either forcefully or gracefully. Graceful shutdown allows the service to finish up the current round of work and shutdown. For graceful shutdown, it waits till the service is shutdown

Parameters:

force - Forcefully shutdown

start

public void start(Function<Boolean,Boolean> onShutdownCallback)

Start the service. Runs the service in a different thread and returns. Also starts a monitor thread to run-callbacks in case of shutdown

Parameters:

onShutdownCallback -

startService

protected abstract Pair<CompletableFuture,ExecutorService> startService()

Service implementation.

isRunInDaemonMode

public boolean isRunInDaemonMode()

waitTillPendingAsyncServiceInstantsReducesTo

public void waitTillPendingAsyncServiceInstantsReducesTo(int numPending)
                                                  throws InterruptedException

Wait till outstanding pending compaction/clustering reduces to the passed in value.

Parameters:

numPending - Maximum pending compactions/clustering allowed

Throws:

InterruptedException

enqueuePendingAsyncServiceInstant

public void enqueuePendingAsyncServiceInstant(HoodieInstant instant)

Enqueues new pending clustering instant.

Parameters:

instant - HoodieInstant to enqueue.