org.apache.hudi.client.transaction.lock

Class FileSystemBasedLockProvider

java.lang.Object

org.apache.hudi.client.transaction.lock.FileSystemBasedLockProvider

All Implemented Interfaces:

Serializable, AutoCloseable, Lock, LockProvider<String>

public class FileSystemBasedLockProvider
extends Object
implements LockProvider<String>, Serializable

A FileSystem based lock. This LockProvider implementation allows to lock table operations using DFS. Users might need to manually clean the Locker's path if writeClient crash and never run again. NOTE: This only works for DFS with atomic create/delete operation

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected LockConfiguration	lockConfiguration

Constructor Summary

Constructors

Constructor and Description
FileSystemBasedLockProvider(LockConfiguration lockConfiguration, StorageConfiguration<?> configuration)

Method Summary

Modifier and Type	Method and Description
void	close()
protected String	generateLogStatement(LockState state)
String	getCurrentOwnerLockInfo()
String	getLock()
static TypedProperties	getLockConfig(String tablePath) Returns a filesystem based lock config with given table path.
void	initLockInfo()
void	reloadCurrentOwnerLockInfo()
boolean	tryLock(long time, TimeUnit unit)
void	unlock()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hudi.common.lock.LockProvider

lock, lockInterruptibly, newCondition, tryLock

Field Detail

lockConfiguration

protected LockConfiguration lockConfiguration

Constructor Detail

FileSystemBasedLockProvider

public FileSystemBasedLockProvider(LockConfiguration lockConfiguration,
                                   StorageConfiguration<?> configuration)

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface LockProvider<String>

tryLock

public boolean tryLock(long time,
                       TimeUnit unit)

Specified by:

tryLock in interface Lock

unlock

public void unlock()

Specified by:

unlock in interface Lock

getLock

public String getLock()

Specified by:

getLock in interface LockProvider<String>

getCurrentOwnerLockInfo

public String getCurrentOwnerLockInfo()

Specified by:

getCurrentOwnerLockInfo in interface LockProvider<String>

initLockInfo

public void initLockInfo()

reloadCurrentOwnerLockInfo

public void reloadCurrentOwnerLockInfo()

generateLogStatement

protected String generateLogStatement(LockState state)

getLockConfig

public static TypedProperties getLockConfig(String tablePath)

Returns a filesystem based lock config with given table path.