org.apache.kyuubi.shaded.hive.metastore.conf

Class MetastoreConf

java.lang.Object

org.apache.kyuubi.shaded.hive.metastore.conf.MetastoreConf

public class MetastoreConf
extends Object

A set of definitions of config values used by the Metastore. One of the key aims of this class is to provide backwards compatibility with existing Hive configuration keys while allowing the metastore to have its own, Hive independent keys. For this reason access to the underlying Configuration object should always be done via the static methods provided here rather than directly via Configuration.get(String) and Configuration.set(String, String). All the methods of this class will handle checking both the MetastoreConf key and the Hive key. The algorithm is, on reads, to check first the MetastoreConf key, then the Hive key, then return the default if neither are set. On write the Metastore key only is set.

This class does not extend Configuration. Rather it provides static methods for operating on a Configuration object. This allows it to work on HiveConf objects, which otherwise would not be the case.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetastoreConf.ConfVars

Field Summary

Fields

Modifier and Type	Field and Description
static MetastoreConf.ConfVars[]	metaVars Metastore related options that the db is initialized against.

Method Summary

Modifier and Type	Method and Description
static long	convertTimeStr(String val, TimeUnit defaultUnit, TimeUnit outUnit)
static String	get(org.apache.hadoop.conf.Configuration conf, String key) Get the configuration value based on a string rather than a ConfVar.
static String	getAsString(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var) Return the configuration value as a String.
static boolean	getBoolVar(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var) Get the variable as a boolean
static <I> Class<? extends I>	getClass(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var, Class<? extends I> defaultValue, Class<I> xface) Get a class instance based on a configuration value
static double	getDoubleVar(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var) Get the variable as a double
static URL	getHiveDefaultLocation()
static URL	getHiveMetastoreSiteURL()
static URL	getHiveSiteLocation()
static int	getIntVar(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var) Get the variable as a int.
static long	getLongVar(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var) Get the variable as a long
static MetastoreConf.ConfVars	getMetaConf(String name)
static URL	getMetastoreSiteURL()
static String	getPassword(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var) Get a password from the configuration file.
List<URL>	getResourceFileLocations()
static long	getSizeVar(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var)
static Collection<String>	getStringCollection(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var) Treat a configuration value as a comma separated list.
static long	getTimeVar(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var, TimeUnit outUnit) Get the variable as a long indicating a period of time
static String[]	getTrimmedStringsVar(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var) Get values from comma-separated config, to an array after extracting individual values.
static char[]	getValueFromKeystore(String keystorePath, String key)
static String	getVar(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var) Get the variable as a string
static String	getVar(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var, String defaultVal) Get the variable as a string
static ZooKeeperHiveHelper	getZKConfig(org.apache.hadoop.conf.Configuration conf)
static boolean	isEmbeddedMetaStore(String msUri) Check if metastore is being used in embedded mode.
static boolean	isPrintable(String key)
static org.apache.hadoop.conf.Configuration	newMetastoreConf()
static org.apache.hadoop.conf.Configuration	newMetastoreConf(org.apache.hadoop.conf.Configuration conf)
static void	setBoolVar(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var, boolean val) Set the variable as a boolean
static <I> void	setClass(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var, Class<? extends I> theClass, Class<I> xface) Set the class name in the configuration file
static void	setDoubleVar(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var, double val) Set the variable as a double
static void	setLongVar(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var, long val) Set the variable as a long
static void	setTimeVar(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var, long duration, TimeUnit unit) Set the variable as a string
static void	setVar(org.apache.hadoop.conf.Configuration conf, MetastoreConf.ConfVars var, String val) Set the variable as a string

Methods inherited from class java.lang.Object

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

Field Detail

metaVars

public static final MetastoreConf.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. TODO - I suspect the vast majority of these don't need to be here. But it requires testing before just pulling them out.

Method Detail

getMetaConf

public static MetastoreConf.ConfVars getMetaConf(String name)

newMetastoreConf

public static org.apache.hadoop.conf.Configuration newMetastoreConf()

newMetastoreConf

public static org.apache.hadoop.conf.Configuration newMetastoreConf(org.apache.hadoop.conf.Configuration conf)

getVar

public static String getVar(org.apache.hadoop.conf.Configuration conf,
                            MetastoreConf.ConfVars var)

Get the variable as a string

Parameters:

conf - configuration to retrieve it from

var - variable to retrieve

Returns:

value, or default value if value not in config file

getVar

public static String getVar(org.apache.hadoop.conf.Configuration conf,
                            MetastoreConf.ConfVars var,
                            String defaultVal)

Get the variable as a string

Parameters:

conf - configuration to retrieve it from

var - variable to retrieve

defaultVal - default to return if the variable is unset

Returns:

value, or default value passed in if the value is not in the config file

getStringCollection

public static Collection<String> getStringCollection(org.apache.hadoop.conf.Configuration conf,
                                                     MetastoreConf.ConfVars var)

Treat a configuration value as a comma separated list.

Parameters:

conf - configuration to retrieve it from

var - variable to retrieve

Returns:

collection of strings. If the value is unset it will return an empty collection.

setVar

public static void setVar(org.apache.hadoop.conf.Configuration conf,
                          MetastoreConf.ConfVars var,
                          String val)

Set the variable as a string

Parameters:

conf - configuration file to set it in

var - variable to set

val - value to set it to

getIntVar

public static int getIntVar(org.apache.hadoop.conf.Configuration conf,
                            MetastoreConf.ConfVars var)

Get the variable as a int. Note that all integer valued variables are stored as longs, thus this downcasts from a long to an in.

Parameters:

conf - configuration to retrieve it from

var - variable to retrieve

Returns:

value, or default value if value not in config file

getLongVar

public static long getLongVar(org.apache.hadoop.conf.Configuration conf,
                              MetastoreConf.ConfVars var)

Get the variable as a long

Parameters:

conf - configuration to retrieve it from

var - variable to retrieve

Returns:

value, or default value if value not in config file

setLongVar

public static void setLongVar(org.apache.hadoop.conf.Configuration conf,
                              MetastoreConf.ConfVars var,
                              long val)

Set the variable as a long

Parameters:

conf - configuration file to set it in

var - variable to set

val - value to set it to

getBoolVar

public static boolean getBoolVar(org.apache.hadoop.conf.Configuration conf,
                                 MetastoreConf.ConfVars var)

Get the variable as a boolean

Parameters:

conf - configuration to retrieve it from

var - variable to retrieve

Returns:

value, or default value if value not in config file

getTrimmedStringsVar

public static String[] getTrimmedStringsVar(org.apache.hadoop.conf.Configuration conf,
                                            MetastoreConf.ConfVars var)

Get values from comma-separated config, to an array after extracting individual values.

Parameters:

conf - Configuration to retrieve it from

var - variable to retrieve

Returns:

Array of String, containing each value from the comma-separated config, or default value if value not in config file

setBoolVar

public static void setBoolVar(org.apache.hadoop.conf.Configuration conf,
                              MetastoreConf.ConfVars var,
                              boolean val)

Set the variable as a boolean

Parameters:

conf - configuration file to set it in

var - variable to set

val - value to set it to

getDoubleVar

public static double getDoubleVar(org.apache.hadoop.conf.Configuration conf,
                                  MetastoreConf.ConfVars var)

Get the variable as a double

Parameters:

conf - configuration to retrieve it from

var - variable to retrieve

Returns:

value, or default value if value not in config file

setDoubleVar

public static void setDoubleVar(org.apache.hadoop.conf.Configuration conf,
                                MetastoreConf.ConfVars var,
                                double val)

Set the variable as a double

Parameters:

conf - configuration file to set it in

var - variable to set

val - value to set it to

getSizeVar

public static long getSizeVar(org.apache.hadoop.conf.Configuration conf,
                              MetastoreConf.ConfVars var)

getClass

public static <I> Class<? extends I> getClass(org.apache.hadoop.conf.Configuration conf,
                                              MetastoreConf.ConfVars var,
                                              Class<? extends I> defaultValue,
                                              Class<I> xface)

Get a class instance based on a configuration value

Type Parameters:

I - interface that class implements

Parameters:

conf - configuration file to retrieve it from

var - variable to retrieve

defaultValue - default class to return if the value isn't set

xface - interface that class must implement

Returns:

instance of the class

setClass

public static <I> void setClass(org.apache.hadoop.conf.Configuration conf,
                                MetastoreConf.ConfVars var,
                                Class<? extends I> theClass,
                                Class<I> xface)

Set the class name in the configuration file

Type Parameters:

I - interface the class implements.

Parameters:

conf - configuration file to set it in

var - variable to set

theClass - the class to set it to

xface - interface that the class implements. I don't know why this is required, but the underlying Configuration.setClass(String, Class, Class) requires it.

getTimeVar

public static long getTimeVar(org.apache.hadoop.conf.Configuration conf,
                              MetastoreConf.ConfVars var,
                              TimeUnit outUnit)

Get the variable as a long indicating a period of time

Parameters:

conf - configuration to retrieve it from

var - variable to retrieve

outUnit - Timeout to return value in

Returns:

value, or default value if value not in config file

setTimeVar

public static void setTimeVar(org.apache.hadoop.conf.Configuration conf,
                              MetastoreConf.ConfVars var,
                              long duration,
                              TimeUnit unit)

Set the variable as a string

Parameters:

conf - configuration file to set it in

var - variable to set

duration - value to set it to

unit - time unit that duration is expressed in

convertTimeStr

public static long convertTimeStr(String val,
                                  TimeUnit defaultUnit,
                                  TimeUnit outUnit)

getPassword

public static String getPassword(org.apache.hadoop.conf.Configuration conf,
                                 MetastoreConf.ConfVars var)
                          throws IOException

Get a password from the configuration file. This uses Hadoop's Configuration.getPassword(String) to handle getting secure passwords.

Parameters:

conf - configuration file to read from

var - configuration value to read

Returns:

the password as a string, or the default value.

Throws:

IOException - if thrown by Configuration.getPassword

get

public static String get(org.apache.hadoop.conf.Configuration conf,
                         String key)

Get the configuration value based on a string rather than a ConfVar. This will do the mapping between metastore keys and Hive keys. That is, if there's a ConfVar with a metastore key of "metastore.a" and a hive key of "hive.a", the value for that variable will be returned if either of those keys is present in the config. If neither are present than the default value will be returned.

Parameters:

conf - configuration to read.

key - metastore or hive key to read.

Returns:

the value set

isPrintable

public static boolean isPrintable(String key)

getAsString

public static String getAsString(org.apache.hadoop.conf.Configuration conf,
                                 MetastoreConf.ConfVars var)

Return the configuration value as a String. For time based values it will be returned in the default time unit appended with an appropriate abbreviation (eg s for seconds, ...)

Parameters:

conf - configuration to read

var - variable to read

Returns:

value as a String

getHiveDefaultLocation

public static URL getHiveDefaultLocation()

getHiveSiteLocation

public static URL getHiveSiteLocation()

getHiveMetastoreSiteURL

public static URL getHiveMetastoreSiteURL()

getMetastoreSiteURL

public static URL getMetastoreSiteURL()

getResourceFileLocations

public List<URL> getResourceFileLocations()

isEmbeddedMetaStore

public static boolean isEmbeddedMetaStore(String msUri)

Check if metastore is being used in embedded mode. This utility function exists so that the logic for determining the mode is same in HiveConf and HiveMetaStoreClient

Parameters:

msUri - - metastore server uri

Returns:

true if the metastore is embedded

getZKConfig

public static ZooKeeperHiveHelper getZKConfig(org.apache.hadoop.conf.Configuration conf)

getValueFromKeystore

public static char[] getValueFromKeystore(String keystorePath,
                                          String key)
                                   throws IOException

Throws:

IOException