org.apache.hadoop.hive.conf

Class HiveConf

java.lang.Object

org.apache.hadoop.conf.Configuration

org.apache.hadoop.hive.conf.HiveConf

All Implemented Interfaces:

Iterable<Map.Entry<String,String>>, org.apache.hadoop.io.Writable

public class HiveConf
extends Configuration

Hive Configuration. This is copied from hive to fix initialization failure when hive-site is not available.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HiveConf.ConfVars ConfVars.
static interface	HiveConf.EncoderDecoder<K,V>
static class	HiveConf.EncoderDecoderFactory
static class	HiveConf.StrictChecks
static class	HiveConf.URLEncoderDecoder

Nested classes/interfaces inherited from class org.apache.hadoop.conf.Configuration

Configuration.DeprecationDelta, Configuration.IntegerRanges

Field Summary

Fields

Modifier and Type	Field and Description
protected String	auxJars
static HiveConf.ConfVars[]	dbVars dbVars are the parameters can be set per database.
static HiveConf.ConfVars[]	ENCODED_CONF encoded parameter values are ;-) encoded.
static String	HIVE_LLAP_DAEMON_SERVICE_PRINCIPAL_NAME
static String	HIVE_SERVER2_AUTHENTICATION_LDAP_USERMEMBERSHIPKEY_NAME
protected String	hiveJar
static HiveConf.ConfVars[]	metaConfVars User configurable Metastore vars
static HiveConf.ConfVars[]	metaVars Metastore related options that the db is initialized against.
protected Properties	origProp
static String	PREFIX_HIVE_LLAP
static String	PREFIX_LLAP

Constructor Summary

Constructors

Constructor and Description
HiveConf()
HiveConf(Class<?> cls)
HiveConf(Configuration other, Class<?> cls)
HiveConf(HiveConf other) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	addToRestrictList(String restrictListStr) Append comma separated list of config vars to the restrict List
static String	generateMrDeprecationWarning()
Properties	getAllProperties()
String	getAuxJars()
static boolean	getBoolVar(Configuration conf, HiveConf.ConfVars var)
static boolean	getBoolVar(Configuration conf, HiveConf.ConfVars var, boolean defaultVal)
boolean	getBoolVar(HiveConf.ConfVars var)
Properties	getChangedProperties()
static String	getColumnInternalName(int pos)
static Map<String,String>	getConfSystemProperties() This method returns a mapping from config variable name to its value for all config variables which have been set using System properties
static HiveConf.ConfVars	getConfVars(String name)
static TimeUnit	getDefaultTimeUnit(HiveConf.ConfVars var)
static float	getFloatVar(Configuration conf, HiveConf.ConfVars var)
static float	getFloatVar(Configuration conf, HiveConf.ConfVars var, float defaultVal)
float	getFloatVar(HiveConf.ConfVars var)
URL	getHiveDefaultLocation()
static URL	getHiveServer2SiteLocation()
static URL	getHiveSiteLocation()
static int	getIntVar(Configuration conf, HiveConf.ConfVars var)
int	getIntVar(HiveConf.ConfVars var)
String	getJar()
static Set<String>	getLlapDaemonConfVars() Get a set containing configuration parameter names used by LLAP Server isntances
java.time.ZoneId	getLocalTimeZone() Obtains the local time-zone ID.
String	getLogIdVar(String defaultValue)
static long	getLongVar(Configuration conf, HiveConf.ConfVars var)
static long	getLongVar(Configuration conf, HiveConf.ConfVars var, long defaultVal)
long	getLongVar(HiveConf.ConfVars var)
static HiveConf.ConfVars	getMetaConf(String name)
static URL	getMetastoreSiteLocation()
static String	getNonMrEngines()
static HashMap<String,HiveConf.ConfVars>	getOrCreateReverseMap()
static int	getPositionFromInternalName(String internalName)
static Properties	getProperties(Configuration conf)
String	getQueryString()
static String	getQueryString(Configuration conf)
static long	getSizeVar(Configuration conf, HiveConf.ConfVars var)
long	getSizeVar(HiveConf.ConfVars var)
boolean	getSparkConfigUpdated()
static long	getTimeVar(Configuration conf, HiveConf.ConfVars var, TimeUnit outUnit)
long	getTimeVar(HiveConf.ConfVars var, TimeUnit outUnit)
static String[]	getTrimmedStringsVar(Configuration conf, HiveConf.ConfVars var)
static String	getTrimmedVar(Configuration conf, HiveConf.ConfVars var)
String	getUser()
static String	getVar(Configuration conf, HiveConf.ConfVars var)
static String	getVar(Configuration conf, HiveConf.ConfVars var, HiveConf.EncoderDecoder<String,String> encoderDecoder)
static String	getVar(Configuration conf, HiveConf.ConfVars var, String defaultVal)
String	getVar(HiveConf.ConfVars var)
static String	getVarWithoutType(Configuration conf, HiveConf.ConfVars var)
static boolean	isEncodedPar(String name)
boolean	isHiddenConfig(String name)
static boolean	isLoadHiveServer2Config()
static boolean	isLoadMetastoreConfig()
boolean	isSparkDPPAny()
static boolean	isSparkDPPAny(Configuration conf)
boolean	isSparkDPPOnlyMapjoin()
boolean	isWebUiEnabled()
boolean	isWebUiQueryInfoCacheEnabled()
void	logVars(PrintStream ps)
static long	multiplierFor(String unit)
void	setAuxJars(String auxJars) Set the auxiliary jars.
static void	setBoolVar(Configuration conf, HiveConf.ConfVars var, boolean val)
void	setBoolVar(HiveConf.ConfVars var, boolean val)
static void	setFloatVar(Configuration conf, HiveConf.ConfVars var, float val)
void	setFloatVar(HiveConf.ConfVars var, float val)
static void	setHivemetastoreSiteUrl(URL location)
static void	setHiveSiteLocation(URL location)
static void	setIntVar(Configuration conf, HiveConf.ConfVars var, int val)
void	setIntVar(HiveConf.ConfVars var, int val)
static void	setLoadHiveServer2Config(boolean loadHiveServer2Config)
static void	setLoadMetastoreConfig(boolean loadMetastoreConfig)
static void	setLongVar(Configuration conf, HiveConf.ConfVars var, long val)
void	setLongVar(HiveConf.ConfVars var, long val)
void	setModifiableWhiteListRegex(String paramNameRegex) Set white list of parameters that are allowed to be modified
static void	setQueryString(Configuration conf, String query)
void	setQueryString(String query)
void	setSparkConfigUpdated(boolean isSparkConfigUpdated)
static void	setTimeVar(Configuration conf, HiveConf.ConfVars var, long time, TimeUnit timeunit)
void	setTimeVar(HiveConf.ConfVars var, long time, TimeUnit outUnit)
static void	setVar(Configuration conf, HiveConf.ConfVars var, String val)
static void	setVar(Configuration conf, HiveConf.ConfVars var, String val, HiveConf.EncoderDecoder<String,String> encoderDecoder)
void	setVar(HiveConf.ConfVars var, String val)
static String	stringFor(TimeUnit timeunit)
void	stripHiddenConfigurations(Configuration conf) Strips hidden config entries from configuration
Map<String,String>	subtree(String string)
static long	toSizeBytes(String value)
static long	toTime(String value, TimeUnit inputUnit, TimeUnit outUnit)
static TimeUnit	unitFor(String unit, TimeUnit defaultUnit)
void	verifyAndSet(String name, String value)
void	verifyAndSetAll(Map<String,String> overlay)

Methods inherited from class org.apache.hadoop.conf.Configuration

addDefaultResource, addDeprecation, addDeprecation, addDeprecation, addDeprecation, addDeprecations, addResource, addResource, addResource, addResource, addResource, addResource, addResource, addResource, addResource, addResource, addResource, clear, dumpConfiguration, dumpConfiguration, dumpDeprecatedKeys, get, get, getBoolean, getClass, getClass, getClassByName, getClassByNameOrNull, getClasses, getClassLoader, getConfResourceAsInputStream, getConfResourceAsReader, getDouble, getEnum, getFile, getFinalParameters, getFloat, getInstances, getInt, getInts, getLocalPath, getLong, getLongBytes, getPassword, getPasswordFromConfig, getPasswordFromCredentialProviders, getPattern, getPropertySources, getProps, getPropsWithPrefix, getRange, getRaw, getResource, getSocketAddr, getSocketAddr, getStorageSize, getStorageSize, getStringCollection, getStrings, getStrings, getTimeDuration, getTimeDuration, getTimeDurationHelper, getTimeDurations, getTrimmed, getTrimmed, getTrimmedStringCollection, getTrimmedStrings, getTrimmedStrings, getValByRegex, hasWarnedDeprecation, isDeprecated, iterator, main, onlyKeyExists, readFields, reloadConfiguration, reloadExistingConfigurations, set, set, setAllowNullValueProperties, setBoolean, setBooleanIfUnset, setClass, setClassLoader, setDeprecatedProperties, setDouble, setEnum, setFloat, setIfUnset, setInt, setLong, setPattern, setQuietMode, setRestrictSystemProperties, setRestrictSystemPropertiesDefault, setRestrictSystemProps, setSocketAddr, setStorageSize, setStrings, setTimeDuration, size, toString, unset, updateConnectAddr, updateConnectAddr, write, writeXml, writeXml, writeXml

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

hiveJar

protected String hiveJar

origProp

protected Properties origProp

auxJars

protected String auxJars

PREFIX_LLAP

@InterfaceAudience.Private
public static final String PREFIX_LLAP

See Also:

Constant Field Values

PREFIX_HIVE_LLAP

@InterfaceAudience.Private
public static final String PREFIX_HIVE_LLAP

See Also:

Constant Field Values

metaVars

public static final HiveConf.ConfVars[] metaVars

Metastore related options that the db is initialized against. When a conf var in this is list is changed, the metastore instance for the CLI will be recreated so that the change will take effect.

metaConfVars

public static final HiveConf.ConfVars[] metaConfVars

User configurable Metastore vars

HIVE_LLAP_DAEMON_SERVICE_PRINCIPAL_NAME

public static final String HIVE_LLAP_DAEMON_SERVICE_PRINCIPAL_NAME

See Also:

Constant Field Values

HIVE_SERVER2_AUTHENTICATION_LDAP_USERMEMBERSHIPKEY_NAME

public static final String HIVE_SERVER2_AUTHENTICATION_LDAP_USERMEMBERSHIPKEY_NAME

See Also:

Constant Field Values

dbVars

public static final HiveConf.ConfVars[] dbVars

dbVars are the parameters can be set per database. If these parameters are set as a database property, when switching to that database, the HiveConf variable will be changed. The change of these parameters will effectively change the DFS and MapReduce clusters for different databases.

ENCODED_CONF

public static final HiveConf.ConfVars[] ENCODED_CONF

encoded parameter values are ;-) encoded. Use decoder to get ;-) decoded string

Constructor Detail

HiveConf

public HiveConf()

HiveConf

public HiveConf(Class<?> cls)

HiveConf

public HiveConf(Configuration other,
                Class<?> cls)

HiveConf

public HiveConf(HiveConf other)

Copy constructor

Method Detail

getSparkConfigUpdated

public boolean getSparkConfigUpdated()

setSparkConfigUpdated

public void setSparkConfigUpdated(boolean isSparkConfigUpdated)

getLlapDaemonConfVars

public static final Set<String> getLlapDaemonConfVars()

Get a set containing configuration parameter names used by LLAP Server isntances

Returns:

an unmodifiable set containing llap ConfVars

verifyAndSet

public void verifyAndSet(String name,
                         String value)
                  throws IllegalArgumentException

Throws:

IllegalArgumentException

isHiddenConfig

public boolean isHiddenConfig(String name)

isEncodedPar

public static boolean isEncodedPar(String name)

getIntVar

public static int getIntVar(Configuration conf,
                            HiveConf.ConfVars var)

setIntVar

public static void setIntVar(Configuration conf,
                             HiveConf.ConfVars var,
                             int val)

getIntVar

public int getIntVar(HiveConf.ConfVars var)

setIntVar

public void setIntVar(HiveConf.ConfVars var,
                      int val)

getTimeVar

public static long getTimeVar(Configuration conf,
                              HiveConf.ConfVars var,
                              TimeUnit outUnit)

setTimeVar

public static void setTimeVar(Configuration conf,
                              HiveConf.ConfVars var,
                              long time,
                              TimeUnit timeunit)

getTimeVar

public long getTimeVar(HiveConf.ConfVars var,
                       TimeUnit outUnit)

setTimeVar

public void setTimeVar(HiveConf.ConfVars var,
                       long time,
                       TimeUnit outUnit)

getSizeVar

public static long getSizeVar(Configuration conf,
                              HiveConf.ConfVars var)

getSizeVar

public long getSizeVar(HiveConf.ConfVars var)

getDefaultTimeUnit

public static TimeUnit getDefaultTimeUnit(HiveConf.ConfVars var)

toTime

public static long toTime(String value,
                          TimeUnit inputUnit,
                          TimeUnit outUnit)

toSizeBytes

public static long toSizeBytes(String value)

unitFor

public static TimeUnit unitFor(String unit,
                               TimeUnit defaultUnit)

multiplierFor

public static long multiplierFor(String unit)

stringFor

public static String stringFor(TimeUnit timeunit)

getLongVar

public static long getLongVar(Configuration conf,
                              HiveConf.ConfVars var)

getLongVar

public static long getLongVar(Configuration conf,
                              HiveConf.ConfVars var,
                              long defaultVal)

setLongVar

public static void setLongVar(Configuration conf,
                              HiveConf.ConfVars var,
                              long val)

getLongVar

public long getLongVar(HiveConf.ConfVars var)

setLongVar

public void setLongVar(HiveConf.ConfVars var,
                       long val)

getFloatVar

public static float getFloatVar(Configuration conf,
                                HiveConf.ConfVars var)

getFloatVar

public static float getFloatVar(Configuration conf,
                                HiveConf.ConfVars var,
                                float defaultVal)

setFloatVar

public static void setFloatVar(Configuration conf,
                               HiveConf.ConfVars var,
                               float val)

getFloatVar

public float getFloatVar(HiveConf.ConfVars var)

setFloatVar

public void setFloatVar(HiveConf.ConfVars var,
                        float val)

getBoolVar

public static boolean getBoolVar(Configuration conf,
                                 HiveConf.ConfVars var)

getBoolVar

public static boolean getBoolVar(Configuration conf,
                                 HiveConf.ConfVars var,
                                 boolean defaultVal)

setBoolVar

public static void setBoolVar(Configuration conf,
                              HiveConf.ConfVars var,
                              boolean val)

isSparkDPPAny

public static boolean isSparkDPPAny(Configuration conf)

getBoolVar

public boolean getBoolVar(HiveConf.ConfVars var)

setBoolVar

public void setBoolVar(HiveConf.ConfVars var,
                       boolean val)

getVar

public static String getVar(Configuration conf,
                            HiveConf.ConfVars var)

getVarWithoutType

public static String getVarWithoutType(Configuration conf,
                                       HiveConf.ConfVars var)

getTrimmedVar

public static String getTrimmedVar(Configuration conf,
                                   HiveConf.ConfVars var)

getTrimmedStringsVar

public static String[] getTrimmedStringsVar(Configuration conf,
                                            HiveConf.ConfVars var)

getVar

public static String getVar(Configuration conf,
                            HiveConf.ConfVars var,
                            String defaultVal)

getVar

public static String getVar(Configuration conf,
                            HiveConf.ConfVars var,
                            HiveConf.EncoderDecoder<String,String> encoderDecoder)

getLogIdVar

public String getLogIdVar(String defaultValue)

setVar

public static void setVar(Configuration conf,
                          HiveConf.ConfVars var,
                          String val)

setVar

public static void setVar(Configuration conf,
                          HiveConf.ConfVars var,
                          String val,
                          HiveConf.EncoderDecoder<String,String> encoderDecoder)

getConfVars

public static HiveConf.ConfVars getConfVars(String name)

getMetaConf

public static HiveConf.ConfVars getMetaConf(String name)

getVar

public String getVar(HiveConf.ConfVars var)

setVar

public void setVar(HiveConf.ConfVars var,
                   String val)

getQueryString

public String getQueryString()

getQueryString

public static String getQueryString(Configuration conf)

setQueryString

public void setQueryString(String query)

setQueryString

public static void setQueryString(Configuration conf,
                                  String query)

logVars

public void logVars(PrintStream ps)

getAllProperties

public Properties getAllProperties()

getProperties

public static Properties getProperties(Configuration conf)

getLocalTimeZone

public java.time.ZoneId getLocalTimeZone()

Obtains the local time-zone ID.

getConfSystemProperties

public static Map<String,String> getConfSystemProperties()

This method returns a mapping from config variable name to its value for all config variables which have been set using System properties

getChangedProperties

public Properties getChangedProperties()

getJar

public String getJar()

getAuxJars

public String getAuxJars()

Returns:

the auxJars

setAuxJars

public void setAuxJars(String auxJars)

Set the auxiliary jars. Used for unit tests only.

Parameters:

auxJars - the auxJars to set.

getHiveDefaultLocation

public URL getHiveDefaultLocation()

setHiveSiteLocation

public static void setHiveSiteLocation(URL location)

setHivemetastoreSiteUrl

public static void setHivemetastoreSiteUrl(URL location)

getHiveSiteLocation

public static URL getHiveSiteLocation()

getMetastoreSiteLocation

public static URL getMetastoreSiteLocation()

getHiveServer2SiteLocation

public static URL getHiveServer2SiteLocation()

getUser

public String getUser()
               throws IOException

Returns:

the user name set in hadoop.job.ugi param or the current user from System

Throws:

IOException

getColumnInternalName

public static String getColumnInternalName(int pos)

getPositionFromInternalName

public static int getPositionFromInternalName(String internalName)

addToRestrictList

public void addToRestrictList(String restrictListStr)

Append comma separated list of config vars to the restrict List

Parameters:

restrictListStr -

setModifiableWhiteListRegex

@InterfaceAudience.LimitedPrivate(value="Currently only for use by HiveAuthorizer")
public void setModifiableWhiteListRegex(String paramNameRegex)

Set white list of parameters that are allowed to be modified

Parameters:

paramNameRegex -

stripHiddenConfigurations

public void stripHiddenConfigurations(Configuration conf)

Strips hidden config entries from configuration

isWebUiEnabled

public boolean isWebUiEnabled()

Returns:

true if HS2 webui is enabled

isWebUiQueryInfoCacheEnabled

public boolean isWebUiQueryInfoCacheEnabled()

Returns:

true if HS2 webui query-info cache is enabled

isSparkDPPAny

public boolean isSparkDPPAny()

isSparkDPPOnlyMapjoin

public boolean isSparkDPPOnlyMapjoin()

isLoadMetastoreConfig

public static boolean isLoadMetastoreConfig()

setLoadMetastoreConfig

public static void setLoadMetastoreConfig(boolean loadMetastoreConfig)

isLoadHiveServer2Config

public static boolean isLoadHiveServer2Config()

setLoadHiveServer2Config

public static void setLoadHiveServer2Config(boolean loadHiveServer2Config)

getNonMrEngines

public static String getNonMrEngines()

generateMrDeprecationWarning

public static String generateMrDeprecationWarning()

getOrCreateReverseMap

public static HashMap<String,HiveConf.ConfVars> getOrCreateReverseMap()

verifyAndSetAll

public void verifyAndSetAll(Map<String,String> overlay)

subtree

public Map<String,String> subtree(String string)