org.apache.hadoop.hive.ql.session

Class SessionState

java.lang.Object

org.apache.hadoop.hive.ql.session.SessionState

Direct Known Subclasses:

CliSessionState

public class SessionState
extends Object

SessionState encapsulates common data associated with a session. Also provides support for a thread static session object that can be accessed from any point in the code to interact with the user and to retrieve configuration information

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SessionState.AuthorizationMode
static class	SessionState.LogHelper This class provides helper routines to emit informational and error messages to the user and log4j files while obeying the current session's verbosity levels.
static class	SessionState.ResourceType ResourceType.

Field Summary

Fields

Modifier and Type	Field and Description
PrintStream	childErr Error output from any child process(es).
PrintStream	childOut Standard output from any child process(es).
protected HiveConf	conf current configuration.
PrintStream	err
protected HiveHistory	hiveHist
InputStream	in Streams to read/write from.
PrintStream	info
protected boolean	isSilent silent mode.
protected boolean	isVerbose verbose mode
static long	NO_CURRENT_TXN When setCurrentTxn(long) is set to this or getCurrentTxn()} returns this it indicates that there is not a current transaction in this session.
PrintStream	out
protected ClassLoader	parentLoader
protected File	tmpOutputFile Temporary file name used to store results of non-Hive commands (e.g., set, dfs) and HiveServer.fetch*() function will read results from this file

Constructor Summary

Constructors

Constructor and Description
SessionState(HiveConf conf)
SessionState(HiveConf conf, String userName)

Method Summary

Methods

Modifier and Type	Method and Description
String	add_resource(SessionState.ResourceType t, String value)
String	add_resource(SessionState.ResourceType t, String value, boolean convertToUnix)
List<String>	add_resources(SessionState.ResourceType t, Collection<String> values)
List<String>	add_resources(SessionState.ResourceType t, Collection<String> values, boolean convertToUnix)
void	addLocalMapRedErrors(String id, List<String> localMapRedErrors)
void	applyAuthorizationPolicy() If authorization mode is v2, then pass it through authorizer so that it can apply any security configuration changes.
static boolean	canDownloadResource(String value) Returns true if it is from any external File Systems except local
void	close()
void	delete_resources(SessionState.ResourceType t)
void	delete_resources(SessionState.ResourceType t, List<String> values)
static void	detachSession()
static SessionState.ResourceType	find_resource_type(String s)
static SessionState	get() get the current session.
Object	getActiveAuthorizer()
HiveAuthenticationProvider	getAuthenticator()
SessionState.AuthorizationMode	getAuthorizationMode()
HiveAuthorizationProvider	getAuthorizer()
Class	getAuthorizerInterface()
HiveAuthorizer	getAuthorizerV2()
String	getCmd()
String	getCommandType()
HiveConf	getConf()
static SessionState.LogHelper	getConsole() initialize or retrieve console object for SessionState.
CreateTableAutomaticGrant	getCreateTableGrants()
String	getCurrentDatabase()
long	getCurrentTxn()
HadoopShims.HdfsEncryptionShim	getHdfsEncryptionShim()
String	getHdfsScratchDirURIString()
static org.apache.hadoop.fs.Path	getHDFSSessionPath(org.apache.hadoop.conf.Configuration conf)
HiveHistory	getHiveHistory() get hiveHistory object which does structured logging.
HiveOperation	getHiveOperation()
Map<String,String>	getHiveVariables()
boolean	getIsSilent()
boolean	getIsVerbose()
String	getLastCommand()
LineageState	getLineageState() Get the lineage state stored in this session.
Map<String,List<String>>	getLocalMapRedErrors()
static org.apache.hadoop.fs.Path	getLocalSessionPath(org.apache.hadoop.conf.Configuration conf)
Map<String,MapRedStats>	getMapRedStats()
String	getNextValuesTempTableSuffix() Get the next suffix to use in naming a temporary table created by insert...values
Map<String,String>	getOverriddenConfigurations()
PerfLogger	getPerfLogger(boolean resetPerfLogger)
Timestamp	getQueryCurrentTimestamp() Get query current timestamp
String	getQueryId()
static Registry	getRegistry()
static Registry	getRegistryForWrite()
static HiveConf	getSessionConf()
String	getSessionId()
SparkSession	getSparkSession()
Map<String,List<List<String>>>	getStackTraces()
Map<String,Map<String,ColumnStatisticsObj>>	getTempTableColStats()
Map<String,Map<String,Table>>	getTempTables()
org.apache.hadoop.fs.Path	getTempTableSpace()
static org.apache.hadoop.fs.Path	getTempTableSpace(org.apache.hadoop.conf.Configuration conf)
TezSessionState	getTezSession()
File	getTmpOutputFile()
HiveTxnManager	getTxnMgr()
static String	getUserFromAuthenticator()
String	getUserIpAddress()
String	getUserName()
HiveTxnManager	initTxnMgr(HiveConf conf) Initialize the transaction manager.
boolean	isAuthorizationModeV2()
boolean	isAutoCommit()
boolean	isHiveServerQuery()
Set<String>	list_resource(SessionState.ResourceType t, List<String> filter)
void	reloadAuxJars()
void	setActiveAuthorizer(Object authorizer)
void	setAuthenticator(HiveAuthenticationProvider authenticator)
void	setAuthorizer(HiveAuthorizationProvider authorizer)
void	setCmd(String cmdString)
void	setCommandType(HiveOperation commandType)
void	setConf(HiveConf conf)
void	setCreateTableGrants(CreateTableAutomaticGrant createTableGrants)
void	setCurrentDatabase(String currentDatabase)
static void	setCurrentSessionState(SessionState startSs) Sets the given session state in the thread local var for sessions.
void	setCurrentTxn(long currTxn)
void	setHiveVariables(Map<String,String> hiveVariables)
void	setIsHiveServerQuery(boolean isHiveServerQuery)
void	setIsSilent(boolean isSilent)
void	setIsVerbose(boolean isVerbose)
void	setLastCommand(String lastCommand)
void	setLocalMapRedErrors(Map<String,List<String>> localMapRedErrors)
void	setMapRedStats(Map<String,MapRedStats> mapRedStats)
void	setOverriddenConfigurations(Map<String,String> overriddenConfigurations)
void	setSparkSession(SparkSession sparkSession)
void	setStackTraces(Map<String,List<List<String>>> stackTraces)
void	setTezSession(TezSessionState session)
void	setTmpOutputFile(File f)
void	setupQueryCurrentTimestamp() Initialize current timestamp, other necessary query initialization.
void	setUserIpAddress(String userIpAddress) set the ip address for user running the query
static SessionState	start(HiveConf conf) start a new session and set it to current session.
static SessionState	start(SessionState startSs) set current session to existing session object if a thread is running multiple sessions - it must call this method with the new session object when switching from one session to another.

Methods inherited from class java.lang.Object

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

Field Detail

parentLoader

protected ClassLoader parentLoader

conf

protected HiveConf conf

current configuration.

isSilent

protected boolean isSilent

silent mode.

isVerbose

protected boolean isVerbose

verbose mode

hiveHist

protected HiveHistory hiveHist

in

public InputStream in

Streams to read/write from.

out

public PrintStream out

info

public PrintStream info

err

public PrintStream err

childOut

public PrintStream childOut

Standard output from any child process(es).

childErr

public PrintStream childErr

Error output from any child process(es).

tmpOutputFile

protected File tmpOutputFile

Temporary file name used to store results of non-Hive commands (e.g., set, dfs) and HiveServer.fetch*() function will read results from this file

NO_CURRENT_TXN

public static final long NO_CURRENT_TXN

When setCurrentTxn(long) is set to this or getCurrentTxn()} returns this it indicates that there is not a current transaction in this session.

See Also:

Constant Field Values

Constructor Detail

SessionState

public SessionState(HiveConf conf)

SessionState

public SessionState(HiveConf conf,
            String userName)

Method Detail

getLineageState

public LineageState getLineageState()

Get the lineage state stored in this session.

Returns:

LineageState

getConf

public HiveConf getConf()

setConf

public void setConf(HiveConf conf)

getTmpOutputFile

public File getTmpOutputFile()

setTmpOutputFile

public void setTmpOutputFile(File f)

getIsSilent

public boolean getIsSilent()

isHiveServerQuery

public boolean isHiveServerQuery()

setIsSilent

public void setIsSilent(boolean isSilent)

getIsVerbose

public boolean getIsVerbose()

setIsVerbose

public void setIsVerbose(boolean isVerbose)

setIsHiveServerQuery

public void setIsHiveServerQuery(boolean isHiveServerQuery)

setCmd

public void setCmd(String cmdString)

getCmd

public String getCmd()

getQueryId

public String getQueryId()

getHiveVariables

public Map<String,String> getHiveVariables()

setHiveVariables

public void setHiveVariables(Map<String,String> hiveVariables)

getSessionId

public String getSessionId()

initTxnMgr

public HiveTxnManager initTxnMgr(HiveConf conf)
                          throws LockException

Initialize the transaction manager. This is done lazily to avoid hard wiring one transaction manager at the beginning of the session. In general users shouldn't change this, but it's useful for testing.

Parameters:

conf - Hive configuration to initialize transaction manager

Returns:

transaction manager

Throws:

LockException

getTxnMgr

public HiveTxnManager getTxnMgr()

getCurrentTxn

public long getCurrentTxn()

setCurrentTxn

public void setCurrentTxn(long currTxn)

isAutoCommit

public boolean isAutoCommit()

getHdfsEncryptionShim

public HadoopShims.HdfsEncryptionShim getHdfsEncryptionShim()
                                                     throws HiveException

Throws:

HiveException

start

public static SessionState start(HiveConf conf)

start a new session and set it to current session.

setCurrentSessionState

public static void setCurrentSessionState(SessionState startSs)

Sets the given session state in the thread local var for sessions.

detachSession

public static void detachSession()

start

public static SessionState start(SessionState startSs)

set current session to existing session object if a thread is running multiple sessions - it must call this method with the new session object when switching from one session to another.

getHdfsScratchDirURIString

public String getHdfsScratchDirURIString()

getLocalSessionPath

public static org.apache.hadoop.fs.Path getLocalSessionPath(org.apache.hadoop.conf.Configuration conf)

getHDFSSessionPath

public static org.apache.hadoop.fs.Path getHDFSSessionPath(org.apache.hadoop.conf.Configuration conf)

getTempTableSpace

public static org.apache.hadoop.fs.Path getTempTableSpace(org.apache.hadoop.conf.Configuration conf)

getTempTableSpace

public org.apache.hadoop.fs.Path getTempTableSpace()

getActiveAuthorizer

public Object getActiveAuthorizer()

getAuthorizerInterface

public Class getAuthorizerInterface()

setActiveAuthorizer

public void setActiveAuthorizer(Object authorizer)

get

public static SessionState get()

get the current session.

getSessionConf

public static HiveConf getSessionConf()

getRegistry

public static Registry getRegistry()

getRegistryForWrite

public static Registry getRegistryForWrite()

getHiveHistory

public HiveHistory getHiveHistory()

get hiveHistory object which does structured logging.

Returns:

The hive history object

getLastCommand

public String getLastCommand()

setLastCommand

public void setLastCommand(String lastCommand)

getConsole

public static SessionState.LogHelper getConsole()

initialize or retrieve console object for SessionState.

getUserFromAuthenticator

public static String getUserFromAuthenticator()

Returns:

username from current SessionState authenticator. username will be null if there is no current SessionState object or authenticator is null.

reloadAuxJars

public void reloadAuxJars()
                   throws IOException

Throws:

IOException

find_resource_type

public static SessionState.ResourceType find_resource_type(String s)

add_resource

public String add_resource(SessionState.ResourceType t,
                  String value)
                    throws RuntimeException

Throws:

RuntimeException

add_resource

public String add_resource(SessionState.ResourceType t,
                  String value,
                  boolean convertToUnix)
                    throws RuntimeException

Throws:

RuntimeException

add_resources

public List<String> add_resources(SessionState.ResourceType t,
                         Collection<String> values)
                           throws RuntimeException

Throws:

RuntimeException

add_resources

public List<String> add_resources(SessionState.ResourceType t,
                         Collection<String> values,
                         boolean convertToUnix)
                           throws RuntimeException

Throws:

RuntimeException

canDownloadResource

public static boolean canDownloadResource(String value)

Returns true if it is from any external File Systems except local

delete_resources

public void delete_resources(SessionState.ResourceType t,
                    List<String> values)

list_resource

public Set<String> list_resource(SessionState.ResourceType t,
                        List<String> filter)

delete_resources

public void delete_resources(SessionState.ResourceType t)

getCommandType

public String getCommandType()

getHiveOperation

public HiveOperation getHiveOperation()

setCommandType

public void setCommandType(HiveOperation commandType)

getAuthorizer

public HiveAuthorizationProvider getAuthorizer()

setAuthorizer

public void setAuthorizer(HiveAuthorizationProvider authorizer)

getAuthorizerV2

public HiveAuthorizer getAuthorizerV2()

getAuthenticator

public HiveAuthenticationProvider getAuthenticator()

setAuthenticator

public void setAuthenticator(HiveAuthenticationProvider authenticator)

getCreateTableGrants

public CreateTableAutomaticGrant getCreateTableGrants()

setCreateTableGrants

public void setCreateTableGrants(CreateTableAutomaticGrant createTableGrants)

getMapRedStats

public Map<String,MapRedStats> getMapRedStats()

setMapRedStats

public void setMapRedStats(Map<String,MapRedStats> mapRedStats)

setStackTraces

public void setStackTraces(Map<String,List<List<String>>> stackTraces)

getStackTraces

public Map<String,List<List<String>>> getStackTraces()

getOverriddenConfigurations

public Map<String,String> getOverriddenConfigurations()

setOverriddenConfigurations

public void setOverriddenConfigurations(Map<String,String> overriddenConfigurations)

getLocalMapRedErrors

public Map<String,List<String>> getLocalMapRedErrors()

addLocalMapRedErrors

public void addLocalMapRedErrors(String id,
                        List<String> localMapRedErrors)

setLocalMapRedErrors

public void setLocalMapRedErrors(Map<String,List<String>> localMapRedErrors)

getCurrentDatabase

public String getCurrentDatabase()

setCurrentDatabase

public void setCurrentDatabase(String currentDatabase)

close

public void close()
           throws IOException

Throws:

IOException

getAuthorizationMode

public SessionState.AuthorizationMode getAuthorizationMode()

isAuthorizationModeV2

public boolean isAuthorizationModeV2()

getPerfLogger

public PerfLogger getPerfLogger(boolean resetPerfLogger)

Parameters:

resetPerfLogger -

Returns:

Tries to return an instance of the class whose name is configured in hive.exec.perf.logger, but if it can't it just returns an instance of the base PerfLogger class

getTezSession

public TezSessionState getTezSession()

setTezSession

public void setTezSession(TezSessionState session)

getUserName

public String getUserName()

applyAuthorizationPolicy

public void applyAuthorizationPolicy()
                              throws HiveException

If authorization mode is v2, then pass it through authorizer so that it can apply any security configuration changes.

Throws:

HiveException

getTempTables

public Map<String,Map<String,Table>> getTempTables()

getTempTableColStats

public Map<String,Map<String,ColumnStatisticsObj>> getTempTableColStats()

getUserIpAddress

public String getUserIpAddress()

Returns:

ip address for user running the query

setUserIpAddress

public void setUserIpAddress(String userIpAddress)

set the ip address for user running the query

Parameters:

userIpAddress -

getSparkSession

public SparkSession getSparkSession()

setSparkSession

public void setSparkSession(SparkSession sparkSession)

getNextValuesTempTableSuffix

public String getNextValuesTempTableSuffix()

Get the next suffix to use in naming a temporary table created by insert...values

Returns:

suffix

setupQueryCurrentTimestamp

public void setupQueryCurrentTimestamp()

Initialize current timestamp, other necessary query initialization.

getQueryCurrentTimestamp

public Timestamp getQueryCurrentTimestamp()

Get query current timestamp

Returns: