org.apache.hudi.client

Class BaseHoodieClient

java.lang.Object

org.apache.hudi.client.BaseHoodieClient

All Implemented Interfaces:

Serializable, AutoCloseable

Direct Known Subclasses:

BaseHoodieWriteClient, CompactionAdminClient

public abstract class BaseHoodieClient
extends Object
implements Serializable, AutoCloseable

Abstract class taking care of holding common member variables (FileSystem, SparkContext, HoodieConfigs) Also, manages embedded timeline-server if enabled.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	basePath
protected HoodieWriteConfig	config
protected HoodieEngineContext	context
protected org.apache.hadoop.fs.FileSystem	fs
protected org.apache.hadoop.conf.Configuration	hadoopConf
protected HoodieHeartbeatClient	heartbeatClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseHoodieClient(HoodieEngineContext context, HoodieWriteConfig clientConfig)
protected	BaseHoodieClient(HoodieEngineContext context, HoodieWriteConfig clientConfig, Option<EmbeddedTimelineService> timelineServer)

Method Summary

Modifier and Type	Method and Description
void	close() Releases any resources used by the client.
protected HoodieTableMetaClient	createMetaClient(boolean loadActiveTimelineOnLoad)
HoodieWriteConfig	getConfig()
HoodieEngineContext	getEngineContext()
HoodieHeartbeatClient	getHeartbeatClient()
Option<EmbeddedTimelineService>	getTimelineServer()
protected void	initWrapperFSMetrics()

Methods inherited from class java.lang.Object

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

Field Detail

fs

protected final transient org.apache.hadoop.fs.FileSystem fs

context

protected final transient HoodieEngineContext context

hadoopConf

protected final transient org.apache.hadoop.conf.Configuration hadoopConf

config

protected final HoodieWriteConfig config

basePath

protected final String basePath

heartbeatClient

protected final HoodieHeartbeatClient heartbeatClient

Constructor Detail

BaseHoodieClient

protected BaseHoodieClient(HoodieEngineContext context,
                           HoodieWriteConfig clientConfig)

BaseHoodieClient

protected BaseHoodieClient(HoodieEngineContext context,
                           HoodieWriteConfig clientConfig,
                           Option<EmbeddedTimelineService> timelineServer)

Method Detail

close

public void close()

Releases any resources used by the client.

Specified by:

close in interface AutoCloseable

getConfig

public HoodieWriteConfig getConfig()

getEngineContext

public HoodieEngineContext getEngineContext()

initWrapperFSMetrics

protected void initWrapperFSMetrics()

createMetaClient

protected HoodieTableMetaClient createMetaClient(boolean loadActiveTimelineOnLoad)

getTimelineServer

public Option<EmbeddedTimelineService> getTimelineServer()

getHeartbeatClient

public HoodieHeartbeatClient getHeartbeatClient()