org.apache.hudi.common.config

Class DFSPropertiesConfiguration

java.lang.Object

org.apache.hudi.common.config.PropertiesConfig

org.apache.hudi.common.config.DFSPropertiesConfiguration

public class DFSPropertiesConfiguration
extends PropertiesConfig

A simplified versions of Apache commons - PropertiesConfiguration, that supports limited field types and hierarchical configurations within the same folder as the root file. Includes denoted by the same include=filename.properties syntax, with relative path from root file's folder. Lines beginning with '#' are ignored as comments. Final values for properties are resolved by the order in which they are specified in the files, with included files treated as if they are inline. Note: Not reusing commons-configuration since it has too many conflicting runtime deps.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONF_FILE_DIR_ENV_NAME
static String	DEFAULT_CONF_FILE_DIR
static StoragePath	DEFAULT_PATH
static String	DEFAULT_PROPERTIES_FILE

Constructor Summary

Constructors

Constructor and Description
DFSPropertiesConfiguration()
DFSPropertiesConfiguration(org.apache.hadoop.conf.Configuration hadoopConf, StoragePath filePath)

Method Summary

Modifier and Type	Method and Description
void	addPropsFromFile(StoragePath filePath) Add properties from external configuration files.
void	addPropsFromStream(BufferedReader reader, StoragePath cfgFilePath) Add properties from buffered reader.
static TypedProperties	addToGlobalProps(String key, String value)
static void	clearGlobalProps()
TypedProperties	getGlobalProperties()
static TypedProperties	getGlobalProps()
TypedProperties	getProps()
TypedProperties	getProps(boolean includeGlobalProps)
static TypedProperties	loadGlobalProps() Load global props from hudi-defaults.conf which is under class loader or CONF_FILE_DIR_ENV_NAME.
static void	refreshGlobalProps()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROPERTIES_FILE

public static final String DEFAULT_PROPERTIES_FILE

See Also:

Constant Field Values

CONF_FILE_DIR_ENV_NAME

public static final String CONF_FILE_DIR_ENV_NAME

See Also:

Constant Field Values

DEFAULT_CONF_FILE_DIR

public static final String DEFAULT_CONF_FILE_DIR

See Also:

Constant Field Values

DEFAULT_PATH

public static final StoragePath DEFAULT_PATH

Constructor Detail

DFSPropertiesConfiguration

public DFSPropertiesConfiguration(@Nonnull
                                  org.apache.hadoop.conf.Configuration hadoopConf,
                                  @Nonnull
                                  StoragePath filePath)

DFSPropertiesConfiguration

public DFSPropertiesConfiguration()

Method Detail

loadGlobalProps

public static TypedProperties loadGlobalProps()

Load global props from hudi-defaults.conf which is under class loader or CONF_FILE_DIR_ENV_NAME.

Returns:

Typed Properties

refreshGlobalProps

public static void refreshGlobalProps()

clearGlobalProps

public static void clearGlobalProps()

addPropsFromFile

public void addPropsFromFile(StoragePath filePath)

Add properties from external configuration files.

Parameters:

filePath - file path for configuration file.

addPropsFromStream

public void addPropsFromStream(BufferedReader reader,
                               StoragePath cfgFilePath)
                        throws IOException

Add properties from buffered reader.

Parameters:

reader - Buffered Reader

Throws:

IOException

getGlobalProperties

public TypedProperties getGlobalProperties()

Overrides:

getGlobalProperties in class PropertiesConfig

getGlobalProps

public static TypedProperties getGlobalProps()

addToGlobalProps

public static TypedProperties addToGlobalProps(String key,
                                               String value)

getProps

public TypedProperties getProps()

getProps

public TypedProperties getProps(boolean includeGlobalProps)