ConfigUtils (hudi-common 0.15.0 API)

java.lang.Object
- org.apache.hudi.common.util.ConfigUtils

```
public class ConfigUtils
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static HoodieConfig`	`DEFAULT_HUDI_CONFIG_FOR_READER`
`static String`	`DELTA_STREAMER_CONFIG_PREFIX` Deprecated.
`static String`	`IS_QUERY_AS_RO_TABLE` Config stored in hive serde properties to tell query engine (spark/flink) to read the table as a read-optimized table when this config is true.
`static String`	`OLD_SCHEMAPROVIDER_CONFIG_PREFIX` Deprecated.
`static String`	`SCHEMAPROVIDER_CONFIG_PREFIX`
`static String`	`STREAMER_CONFIG_PREFIX`
`static String`	`TABLE_SERDE_PATH` Config stored in hive serde properties to tell query engine (spark) the location to read.

Constructor Summary

Constructors
Constructor and Description

ConfigUtils()

Constructors
Constructor and Description
`ConfigUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`checkRequiredConfigProperties(TypedProperties props, List<ConfigProperty<?>> configPropertyList)` Validates that all `ConfigProperty` configs exist in the properties.
`static void`	`checkRequiredProperties(TypedProperties props, List<String> checkPropNames)` Validates that config String keys exist in the properties.
`static String`	`configToString(Map<String,String> config)` Convert map config to key-value string.The format of the config is a key-value pair just like "k1=v1\nk2=v2\nk3=v3".
`static boolean`	`containsConfigProperty(Map<String,Object> props, ConfigProperty<?> configProperty)` Whether the properties contain a config.
`static boolean`	`containsConfigProperty(TypedProperties props, ConfigProperty<?> configProperty)` Whether the properties contain a config.
`static <T extends Enum<T>> String[]`	`enumNames(Class<T> enumType)`
`static Map<String,Object>`	`filterProperties(TypedProperties props, List<ConfigProperty<String>> configPropertyList)` Returns filtered properties based on the given `ConfigProperty` config list to keep.
`static Set<String>`	`getAllConfigKeys(List<ConfigProperty<String>> configPropertyList)`
`static boolean`	`getBooleanWithAltKeys(Properties props, ConfigProperty<?> configProperty)` Gets the boolean value for a `ConfigProperty` config from properties.
`static int`	`getIntWithAltKeys(TypedProperties props, ConfigProperty<?> configProperty)` Gets the integer value for a `ConfigProperty` config from properties.
`static long`	`getLongWithAltKeys(TypedProperties props, ConfigProperty<Long> configProperty)` Gets the long value for a `ConfigProperty` config from properties.
`static String`	`getOrderingField(Properties properties)` Get ordering field.
`static String`	`getPayloadClass(Properties properties)` Get payload class.
`static Option<Object>`	`getRawValueWithAltKeys(Properties props, ConfigProperty<?> configProperty)` Gets the raw value for a `ConfigProperty` config from properties.
`static HoodieConfig`	`getReaderConfigs(StorageConfiguration<?> storageConf)`
`static String`	`getStringWithAltKeys(Map<String,Object> props, ConfigProperty<String> configProperty)` Gets the String value for a `ConfigProperty` config from a `Map`.
`static String`	`getStringWithAltKeys(TypedProperties props, ConfigProperty<?> configProperty, String defaultValue)` Gets the String value for a `ConfigProperty` config from properties.
`static String`	`getStringWithAltKeys(TypedProperties props, ConfigProperty<String> configProperty)` Gets the String value for a `ConfigProperty` config from properties.
`static String`	`getStringWithAltKeys(TypedProperties props, ConfigProperty<String> configProperty, boolean useDefaultValue)` Gets the String value for a `ConfigProperty` config from properties.
`static String`	`getStringWithAltKeys(TypedProperties props, String key, String altKey, String defaultValue)` Gets String value from properties with alternative keys.
`static TypedProperties`	`loadGlobalProperties()`
`static void`	`removeConfigFromProps(TypedProperties props, ConfigProperty<?> configProperty)` Removes a `ConfigProperty` config from properties.
`static <T extends Enum<T>> T`	`resolveEnum(Class<T> enumType, String name)` Case-insensitive resolution of input enum name to the enum type
`static List<String>`	`split2List(String param)`
`static Option<String>`	`stripPrefix(String prop, ConfigProperty<String> prefixConfig)` Strips the prefix from a config key.
`static Map<String,String>`	`toMap(String keyValueConfig)` Convert the key-value config to a map.
`static Map<String,String>`	`toMap(String keyValueConfig, String separator)` Convert the key-value config to a map.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - STREAMER_CONFIG_PREFIX
```
public static final String STREAMER_CONFIG_PREFIX
```
    See Also:
    
    Constant Field Values
  - DELTA_STREAMER_CONFIG_PREFIX
```
@Deprecated
public static final String DELTA_STREAMER_CONFIG_PREFIX
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - SCHEMAPROVIDER_CONFIG_PREFIX
```
public static final String SCHEMAPROVIDER_CONFIG_PREFIX
```
    See Also:
    
    Constant Field Values
  - OLD_SCHEMAPROVIDER_CONFIG_PREFIX
```
@Deprecated
public static final String OLD_SCHEMAPROVIDER_CONFIG_PREFIX
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - IS_QUERY_AS_RO_TABLE
```
public static final String IS_QUERY_AS_RO_TABLE
```
    Config stored in hive serde properties to tell query engine (spark/flink) to read the table as a read-optimized table when this config is true.
    
    See Also:
    
    Constant Field Values
  - TABLE_SERDE_PATH
```
public static final String TABLE_SERDE_PATH
```
    Config stored in hive serde properties to tell query engine (spark) the location to read.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HUDI_CONFIG_FOR_READER
```
public static final HoodieConfig DEFAULT_HUDI_CONFIG_FOR_READER
```
- Constructor Detail
  - ConfigUtils
```
public ConfigUtils()
```
- Method Detail
  - getOrderingField
```
public static String getOrderingField(Properties properties)
```
    Get ordering field.
  - getPayloadClass
```
public static String getPayloadClass(Properties properties)
```
    Get payload class.
  - split2List
```
public static List<String> split2List(String param)
```
  - toMap
```
public static Map<String,String> toMap(String keyValueConfig)
```
    Convert the key-value config to a map. The format of the config is a key-value pair just like "k1=v1\nk2=v2\nk3=v3".
    
    Parameters:
    
    keyValueConfig - Key-value configs in properties format, i.e., multiple lines of `key=value`.
    
    Returns:
    
    A Map of key-value configs.
  - toMap
```
public static Map<String,String> toMap(String keyValueConfig,
                                       String separator)
```
    Convert the key-value config to a map. The format of the config is a key-value pair with defined separator. For example, if the separator is a comma, the input is "k1=v1,k2=v2,k3=v3".
    
    Parameters:
    
    keyValueConfig - key-value configs in properties format, with defined separator.
    
    separator - the separator.
    
    Returns:
    
    A Map of key-value configs.
  - configToString
```
public static String configToString(Map<String,String> config)
```
    Convert map config to key-value string.The format of the config is a key-value pair just like "k1=v1\nk2=v2\nk3=v3".
    
    Parameters:
    
    config - A Map of key-value configs.
    
    Returns:
    
    Key-value configs in properties format, i.e., multiple lines of `key=value`.
  - resolveEnum
```
public static <T extends Enum<T>> T resolveEnum(Class<T> enumType,
                                                String name)
```
    Case-insensitive resolution of input enum name to the enum type
  - enumNames
```
public static <T extends Enum<T>> String[] enumNames(Class<T> enumType)
```
  - stripPrefix
```
public static Option<String> stripPrefix(String prop,
                                         ConfigProperty<String> prefixConfig)
```
    Strips the prefix from a config key. The prefix is defined by a ConfigProperty which can have alternatives. The method strips any matching prefix.
    
    Parameters:
    
    prop - The config key for stripping
    
    prefixConfig - The prefix.
    
    Returns:
    
    An Option of the config key after stripping, if any prefix matches the key; empty Option otherwise.
  - containsConfigProperty
```
public static boolean containsConfigProperty(TypedProperties props,
                                             ConfigProperty<?> configProperty)
```
    Whether the properties contain a config. If any of the key or alternative keys of the ConfigProperty exists in the properties, this method returns true.
    
    Parameters:
    
    props - Configs in TypedProperties
    
    configProperty - Config to look up.
    
    Returns:
    
    true if exists; false otherwise.
  - containsConfigProperty
```
public static boolean containsConfigProperty(Map<String,Object> props,
                                             ConfigProperty<?> configProperty)
```
    Whether the properties contain a config. If any of the key or alternative keys of the ConfigProperty exists in the properties, this method returns true.
    
    Parameters:
    
    props - Configs in Map
    
    configProperty - Config to look up.
    
    Returns:
    
    true if exists; false otherwise.
  - checkRequiredProperties
```
public static void checkRequiredProperties(TypedProperties props,
                                           List<String> checkPropNames)
```
    Validates that config String keys exist in the properties.
    
    Parameters:
    
    props - Configs in TypedProperties to validate.
    
    checkPropNames - List of String keys that must exist.
  - checkRequiredConfigProperties
```
public static void checkRequiredConfigProperties(TypedProperties props,
                                                 List<ConfigProperty<?>> configPropertyList)
```
    Validates that all ConfigProperty configs exist in the properties. For each ConfigProperty config, if any of the key or alternative keys of the ConfigProperty exists in the properties, the validation of this config passes.
    
    Parameters:
    
    props - Configs in TypedProperties to validate.
    
    configPropertyList - List of ConfigProperty configs that must exist.
  - getRawValueWithAltKeys
```
public static Option<Object> getRawValueWithAltKeys(Properties props,
                                                    ConfigProperty<?> configProperty)
```
    Gets the raw value for a ConfigProperty config from properties. The key and alternative keys are used to fetch the config.
    
    Parameters:
    
    props - Configs in Properties.
    
    configProperty - ConfigProperty config to fetch.
    
    Returns:
    
    Option of value if the config exists; empty Option otherwise.
  - getStringWithAltKeys
```
public static String getStringWithAltKeys(TypedProperties props,
                                          ConfigProperty<String> configProperty)
```
    Gets the String value for a ConfigProperty config from properties. The key and alternative keys are used to fetch the config. If the config is not found, an IllegalArgumentException is thrown.
    
    Parameters:
    
    props - Configs in TypedProperties.
    
    configProperty - ConfigProperty config of String type to fetch.
    
    Returns:
    
    String value if the config exists.
  - getStringWithAltKeys
```
public static String getStringWithAltKeys(TypedProperties props,
                                          ConfigProperty<String> configProperty,
                                          boolean useDefaultValue)
```
    Gets the String value for a ConfigProperty config from properties. The key and alternative keys are used to fetch the config. If using default value, the default value of ConfigProperty config, if exists, is returned if the config is not found in the properties. If not using default value, if the config is not found, an IllegalArgumentException is thrown.
    
    Parameters:
    
    props - Configs in TypedProperties.
    
    configProperty - ConfigProperty config of String type to fetch.
    
    useDefaultValue - Whether to use default value from ConfigProperty.
    
    Returns:
    
    String value if the config exists; otherwise, if the config does not exist and useDefaultValue is true, returns default String value if there is default value defined in the ConfigProperty config and null otherwise.
  - getStringWithAltKeys
```
public static String getStringWithAltKeys(TypedProperties props,
                                          ConfigProperty<?> configProperty,
                                          String defaultValue)
```
    Gets the String value for a ConfigProperty config from properties. The key and alternative keys are used to fetch the config. The default value as the input of the method is returned if the config is not found in the properties.
    
    Parameters:
    
    props - Configs in TypedProperties.
    
    configProperty - ConfigProperty config of String type to fetch.
    
    defaultValue - Default value.
    
    Returns:
    
    String value if the config exists; default value otherwise.
  - getStringWithAltKeys
```
public static String getStringWithAltKeys(Map<String,Object> props,
                                          ConfigProperty<String> configProperty)
```
    Gets the String value for a ConfigProperty config from a Map. The key and alternative keys are used to fetch the config. The default value of ConfigProperty config, if exists, is returned if the config is not found in the properties.
    
    Parameters:
    
    props - Configs in Map.
    
    configProperty - ConfigProperty config of String type to fetch.
    
    Returns:
    
    String value if the config exists; default String value if the config does not exist and there is default value defined in the ConfigProperty config; null otherwise.
  - getStringWithAltKeys
```
public static String getStringWithAltKeys(TypedProperties props,
                                          String key,
                                          String altKey,
                                          String defaultValue)
```
    Gets String value from properties with alternative keys.
    
    Parameters:
    
    props - Configs in TypedProperties.
    
    key - String key.
    
    altKey - Alternative String key.
    
    defaultValue - Default String value.
    
    Returns:
    
    String value if the config exists; default value otherwise.
  - getBooleanWithAltKeys
```
public static boolean getBooleanWithAltKeys(Properties props,
                                            ConfigProperty<?> configProperty)
```
    Gets the boolean value for a ConfigProperty config from properties. The key and alternative keys are used to fetch the config. The default value of ConfigProperty config, if exists, is returned if the config is not found in the properties.
    
    Parameters:
    
    props - Configs in Properties.
    
    configProperty - ConfigProperty config to fetch.
    
    Returns:
    
    boolean value if the config exists; default boolean value if the config does not exist and there is default value defined in the ConfigProperty config; false otherwise.
  - getIntWithAltKeys
```
public static int getIntWithAltKeys(TypedProperties props,
                                    ConfigProperty<?> configProperty)
```
    Gets the integer value for a ConfigProperty config from properties. The key and alternative keys are used to fetch the config. The default value of ConfigProperty config, if exists, is returned if the config is not found in the properties.
    
    Parameters:
    
    props - Configs in TypedProperties.
    
    configProperty - ConfigProperty config to fetch.
    
    Returns:
    
    integer value if the config exists; default integer value if the config does not exist and there is default value defined in the ConfigProperty config; 0 otherwise.
  - getLongWithAltKeys
```
public static long getLongWithAltKeys(TypedProperties props,
                                      ConfigProperty<Long> configProperty)
```
    Gets the long value for a ConfigProperty config from properties. The key and alternative keys are used to fetch the config. The default value of ConfigProperty config, if exists, is returned if the config is not found in the properties.
    
    Parameters:
    
    props - Configs in TypedProperties.
    
    configProperty - ConfigProperty config to fetch.
    
    Returns:
    
    long value if the config exists; default long value if the config does not exist and there is default value defined in the ConfigProperty config; 0 otherwise.
  - removeConfigFromProps
```
public static void removeConfigFromProps(TypedProperties props,
                                         ConfigProperty<?> configProperty)
```
    Removes a ConfigProperty config from properties. This removes all possible keys including the alternatives from the properties.
    
    Parameters:
    
    props - Configs in TypedProperties.
    
    configProperty - ConfigProperty config to remove.
  - filterProperties
```
public static Map<String,Object> filterProperties(TypedProperties props,
                                                  List<ConfigProperty<String>> configPropertyList)
```
    Returns filtered properties based on the given ConfigProperty config list to keep.
    
    Parameters:
    
    props - Configs in TypedProperties.
    
    configPropertyList - List of ConfigProperty configs to keep.
    
    Returns:
    
    Filtered configs in Map with ConfigProperty configs to keep.
  - getAllConfigKeys
```
public static Set<String> getAllConfigKeys(List<ConfigProperty<String>> configPropertyList)
```
    Parameters:
    
    configPropertyList - List of ConfigProperty configs to keep.
    
    Returns:
    
    all String keys of ConfigProperty configs.
  - getReaderConfigs
```
public static HoodieConfig getReaderConfigs(StorageConfiguration<?> storageConf)
```
  - loadGlobalProperties
```
public static TypedProperties loadGlobalProperties()
```

Class ConfigUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STREAMER_CONFIG_PREFIX

DELTA_STREAMER_CONFIG_PREFIX

SCHEMAPROVIDER_CONFIG_PREFIX

OLD_SCHEMAPROVIDER_CONFIG_PREFIX

IS_QUERY_AS_RO_TABLE

TABLE_SERDE_PATH

DEFAULT_HUDI_CONFIG_FOR_READER

Constructor Detail

ConfigUtils

Method Detail

getOrderingField

getPayloadClass

split2List

toMap

toMap

configToString

resolveEnum

enumNames

stripPrefix

containsConfigProperty

containsConfigProperty

checkRequiredProperties

checkRequiredConfigProperties

getRawValueWithAltKeys

getStringWithAltKeys

getStringWithAltKeys

getStringWithAltKeys

getStringWithAltKeys

getStringWithAltKeys

getBooleanWithAltKeys

getIntWithAltKeys

getLongWithAltKeys

removeConfigFromProps

filterProperties

getAllConfigKeys

getReaderConfigs

loadGlobalProperties