org.apache.hive.service.cli

Class CLIService

java.lang.Object

org.apache.hive.service.AbstractService

org.apache.hive.service.CompositeService

org.apache.hive.service.cli.CLIService

All Implemented Interfaces:

ICLIService, Service

public class CLIService
extends CompositeService
implements ICLIService

CLIService.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hive.service.CompositeService

CompositeService.CompositeServiceShutdownHook

Nested classes/interfaces inherited from interface org.apache.hive.service.Service

Service.STATE

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.hive.service.rpc.thrift.TProtocolVersion	SERVER_VERSION

Constructor Summary

Constructors

Constructor and Description
CLIService(HiveServer2 hiveServer2)

Method Summary

Modifier and Type	Method and Description
void	cancelDelegationToken(SessionHandle sessionHandle, HiveAuthFactory authFactory, String tokenStr)
void	cancelOperation(OperationHandle opHandle)
void	closeOperation(OperationHandle opHandle)
void	closeSession(SessionHandle sessionHandle)
void	createSessionWithSessionHandle(SessionHandle sessionHandle, String username, String password, Map<String,String> configuration) Used to restore session
OperationHandle	executeStatement(SessionHandle sessionHandle, String statement, Map<String,String> confOverlay) Execute statement on the server.
OperationHandle	executeStatement(SessionHandle sessionHandle, String statement, Map<String,String> confOverlay, long queryTimeout) Execute statement on the server with a timeout.
OperationHandle	executeStatementAsync(SessionHandle sessionHandle, String statement, Map<String,String> confOverlay) Execute statement asynchronously on the server.
OperationHandle	executeStatementAsync(SessionHandle sessionHandle, String statement, Map<String,String> confOverlay, long queryTimeout) Execute statement asynchronously on the server with a timeout.
RowSet	fetchResults(OperationHandle opHandle)
RowSet	fetchResults(OperationHandle opHandle, FetchOrientation orientation, long maxRows, FetchType fetchType)
OperationHandle	getCatalogs(SessionHandle sessionHandle)
OperationHandle	getColumns(SessionHandle sessionHandle, String catalogName, String schemaName, String tableName, String columnName)
OperationHandle	getCrossReference(SessionHandle sessionHandle, String primaryCatalog, String primarySchema, String primaryTable, String foreignCatalog, String foreignSchema, String foreignTable)
String	getDelegationToken(SessionHandle sessionHandle, HiveAuthFactory authFactory, String owner, String renewer)
String	getDelegationTokenFromMetaStore(String owner)
OperationHandle	getFunctions(SessionHandle sessionHandle, String catalogName, String schemaName, String functionName)
org.apache.hadoop.security.UserGroupInformation	getHttpUGI()
GetInfoValue	getInfo(SessionHandle sessionHandle, GetInfoType getInfoType)
OperationStatus	getOperationStatus(OperationHandle opHandle, boolean getProgressUpdate)
OperationHandle	getPrimaryKeys(SessionHandle sessionHandle, String catalog, String schema, String table)
String	getQueryId(org.apache.hive.service.rpc.thrift.TOperationHandle opHandle)
TableSchema	getResultSetMetadata(OperationHandle opHandle)
OperationHandle	getSchemas(SessionHandle sessionHandle, String catalogName, String schemaName)
org.apache.hadoop.security.UserGroupInformation	getServiceUGI()
HiveConf	getSessionConf(SessionHandle sessionHandle)
SessionManager	getSessionManager()
OperationHandle	getTables(SessionHandle sessionHandle, String catalogName, String schemaName, String tableName, List<String> tableTypes)
OperationHandle	getTableTypes(SessionHandle sessionHandle)
OperationHandle	getTypeInfo(SessionHandle sessionHandle)
void	init(HiveConf hiveConf) Initialize the service.
SessionHandle	openSession(String username, String password, Map<String,String> configuration)
SessionHandle	openSession(org.apache.hive.service.rpc.thrift.TProtocolVersion protocol, String username, String password, Map<String,String> configuration) Deprecated. Use openSession(TProtocolVersion, String, String, String, Map)
SessionHandle	openSession(org.apache.hive.service.rpc.thrift.TProtocolVersion protocol, String username, String password, String ipAddress, Map<String,String> configuration)
SessionHandle	openSessionWithImpersonation(String username, String password, Map<String,String> configuration, String delegationToken)
SessionHandle	openSessionWithImpersonation(org.apache.hive.service.rpc.thrift.TProtocolVersion protocol, String username, String password, Map<String,String> configuration, String delegationToken) Deprecated. Use openSessionWithImpersonation(TProtocolVersion, String, String, String, Map, String)
SessionHandle	openSessionWithImpersonation(org.apache.hive.service.rpc.thrift.TProtocolVersion protocol, String username, String password, String ipAddress, Map<String,String> configuration, String delegationToken)
void	renewDelegationToken(SessionHandle sessionHandle, HiveAuthFactory authFactory, String tokenStr)
void	setApplicationName(SessionHandle sh, String value)
void	start() Start the service.
void	stop() Stop the service.

Methods inherited from class org.apache.hive.service.CompositeService

addService, getServices, removeService

Methods inherited from class org.apache.hive.service.AbstractService

getHiveConf, getName, getServiceState, getStartTime, register, setHiveConf, unregister

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_VERSION

public static final org.apache.hive.service.rpc.thrift.TProtocolVersion SERVER_VERSION

Constructor Detail

CLIService

public CLIService(HiveServer2 hiveServer2)

Method Detail

init

public void init(HiveConf hiveConf)

Description copied from class: AbstractService

Initialize the service. The transition must be from Service.STATE.NOTINITED to Service.STATE.INITED unless the operation failed and an exception was raised.

Specified by:

init in interface Service

Overrides:

init in class CompositeService

getServiceUGI

public org.apache.hadoop.security.UserGroupInformation getServiceUGI()

getHttpUGI

public org.apache.hadoop.security.UserGroupInformation getHttpUGI()

start

public void start()

Description copied from class: AbstractService

Start the service. The transition should be from Service.STATE.INITED to Service.STATE.STARTED unless the operation failed and an exception was raised.

Specified by:

start in interface Service

Overrides:

start in class CompositeService

stop

public void stop()

Description copied from class: AbstractService

Stop the service. This operation must be designed to complete regardless of the initial state of the service, including the state of all its internal fields.

Specified by:

stop in interface Service

Overrides:

stop in class CompositeService

openSession

@Deprecated
public SessionHandle openSession(org.apache.hive.service.rpc.thrift.TProtocolVersion protocol,
                                             String username,
                                             String password,
                                             Map<String,String> configuration)
                                      throws HiveSQLException

Deprecated. Use openSession(TProtocolVersion, String, String, String, Map)

Throws:

HiveSQLException

openSessionWithImpersonation

@Deprecated
public SessionHandle openSessionWithImpersonation(org.apache.hive.service.rpc.thrift.TProtocolVersion protocol,
                                                              String username,
                                                              String password,
                                                              Map<String,String> configuration,
                                                              String delegationToken)
                                                       throws HiveSQLException

Deprecated. Use openSessionWithImpersonation(TProtocolVersion, String, String, String, Map, String)

Throws:

HiveSQLException

openSession

public SessionHandle openSession(org.apache.hive.service.rpc.thrift.TProtocolVersion protocol,
                                 String username,
                                 String password,
                                 String ipAddress,
                                 Map<String,String> configuration)
                          throws HiveSQLException

Throws:

HiveSQLException

openSessionWithImpersonation

public SessionHandle openSessionWithImpersonation(org.apache.hive.service.rpc.thrift.TProtocolVersion protocol,
                                                  String username,
                                                  String password,
                                                  String ipAddress,
                                                  Map<String,String> configuration,
                                                  String delegationToken)
                                           throws HiveSQLException

Throws:

HiveSQLException

openSession

public SessionHandle openSession(String username,
                                 String password,
                                 Map<String,String> configuration)
                          throws HiveSQLException

Specified by:

openSession in interface ICLIService

Throws:

HiveSQLException

createSessionWithSessionHandle

public void createSessionWithSessionHandle(SessionHandle sessionHandle,
                                           String username,
                                           String password,
                                           Map<String,String> configuration)
                                    throws HiveSQLException

Used to restore session

Throws:

HiveSQLException

openSessionWithImpersonation

public SessionHandle openSessionWithImpersonation(String username,
                                                  String password,
                                                  Map<String,String> configuration,
                                                  String delegationToken)
                                           throws HiveSQLException

Specified by:

openSessionWithImpersonation in interface ICLIService

Throws:

HiveSQLException

closeSession

public void closeSession(SessionHandle sessionHandle)
                  throws HiveSQLException

Specified by:

closeSession in interface ICLIService

Throws:

HiveSQLException

getInfo

public GetInfoValue getInfo(SessionHandle sessionHandle,
                            GetInfoType getInfoType)
                     throws HiveSQLException

Specified by:

getInfo in interface ICLIService

Throws:

HiveSQLException

executeStatement

public OperationHandle executeStatement(SessionHandle sessionHandle,
                                        String statement,
                                        Map<String,String> confOverlay)
                                 throws HiveSQLException

Execute statement on the server. This is a blocking call.

Specified by:

executeStatement in interface ICLIService

Throws:

HiveSQLException

executeStatement

public OperationHandle executeStatement(SessionHandle sessionHandle,
                                        String statement,
                                        Map<String,String> confOverlay,
                                        long queryTimeout)
                                 throws HiveSQLException

Execute statement on the server with a timeout. This is a blocking call.

Specified by:

executeStatement in interface ICLIService

Throws:

HiveSQLException

executeStatementAsync

public OperationHandle executeStatementAsync(SessionHandle sessionHandle,
                                             String statement,
                                             Map<String,String> confOverlay)
                                      throws HiveSQLException

Execute statement asynchronously on the server. This is a non-blocking call

Specified by:

executeStatementAsync in interface ICLIService

Throws:

HiveSQLException

executeStatementAsync

public OperationHandle executeStatementAsync(SessionHandle sessionHandle,
                                             String statement,
                                             Map<String,String> confOverlay,
                                             long queryTimeout)
                                      throws HiveSQLException

Execute statement asynchronously on the server with a timeout. This is a non-blocking call

Specified by:

executeStatementAsync in interface ICLIService

Throws:

HiveSQLException

getTypeInfo

public OperationHandle getTypeInfo(SessionHandle sessionHandle)
                            throws HiveSQLException

Specified by:

getTypeInfo in interface ICLIService

Throws:

HiveSQLException

getCatalogs

public OperationHandle getCatalogs(SessionHandle sessionHandle)
                            throws HiveSQLException

Specified by:

getCatalogs in interface ICLIService

Throws:

HiveSQLException

getSchemas

public OperationHandle getSchemas(SessionHandle sessionHandle,
                                  String catalogName,
                                  String schemaName)
                           throws HiveSQLException

Specified by:

getSchemas in interface ICLIService

Throws:

HiveSQLException

getTables

public OperationHandle getTables(SessionHandle sessionHandle,
                                 String catalogName,
                                 String schemaName,
                                 String tableName,
                                 List<String> tableTypes)
                          throws HiveSQLException

Specified by:

getTables in interface ICLIService

Throws:

HiveSQLException

getTableTypes

public OperationHandle getTableTypes(SessionHandle sessionHandle)
                              throws HiveSQLException

Specified by:

getTableTypes in interface ICLIService

Throws:

HiveSQLException

getColumns

public OperationHandle getColumns(SessionHandle sessionHandle,
                                  String catalogName,
                                  String schemaName,
                                  String tableName,
                                  String columnName)
                           throws HiveSQLException

Specified by:

getColumns in interface ICLIService

Throws:

HiveSQLException

getFunctions

public OperationHandle getFunctions(SessionHandle sessionHandle,
                                    String catalogName,
                                    String schemaName,
                                    String functionName)
                             throws HiveSQLException

Specified by:

getFunctions in interface ICLIService

Throws:

HiveSQLException

getPrimaryKeys

public OperationHandle getPrimaryKeys(SessionHandle sessionHandle,
                                      String catalog,
                                      String schema,
                                      String table)
                               throws HiveSQLException

Specified by:

getPrimaryKeys in interface ICLIService

Throws:

HiveSQLException

getCrossReference

public OperationHandle getCrossReference(SessionHandle sessionHandle,
                                         String primaryCatalog,
                                         String primarySchema,
                                         String primaryTable,
                                         String foreignCatalog,
                                         String foreignSchema,
                                         String foreignTable)
                                  throws HiveSQLException

Specified by:

getCrossReference in interface ICLIService

Throws:

HiveSQLException

getOperationStatus

public OperationStatus getOperationStatus(OperationHandle opHandle,
                                          boolean getProgressUpdate)
                                   throws HiveSQLException

Specified by:

getOperationStatus in interface ICLIService

Throws:

HiveSQLException

getSessionConf

public HiveConf getSessionConf(SessionHandle sessionHandle)
                        throws HiveSQLException

Throws:

HiveSQLException

cancelOperation

public void cancelOperation(OperationHandle opHandle)
                     throws HiveSQLException

Specified by:

cancelOperation in interface ICLIService

Throws:

HiveSQLException

closeOperation

public void closeOperation(OperationHandle opHandle)
                    throws HiveSQLException

Specified by:

closeOperation in interface ICLIService

Throws:

HiveSQLException

getResultSetMetadata

public TableSchema getResultSetMetadata(OperationHandle opHandle)
                                 throws HiveSQLException

Specified by:

getResultSetMetadata in interface ICLIService

Throws:

HiveSQLException

fetchResults

public RowSet fetchResults(OperationHandle opHandle)
                    throws HiveSQLException

Specified by:

fetchResults in interface ICLIService

Throws:

HiveSQLException

fetchResults

public RowSet fetchResults(OperationHandle opHandle,
                           FetchOrientation orientation,
                           long maxRows,
                           FetchType fetchType)
                    throws HiveSQLException

Specified by:

fetchResults in interface ICLIService

Throws:

HiveSQLException

getDelegationTokenFromMetaStore

public String getDelegationTokenFromMetaStore(String owner)
                                       throws HiveSQLException,
                                              UnsupportedOperationException,
                                              LoginException,
                                              IOException

Throws:

HiveSQLException

UnsupportedOperationException

LoginException

IOException

getDelegationToken

public String getDelegationToken(SessionHandle sessionHandle,
                                 HiveAuthFactory authFactory,
                                 String owner,
                                 String renewer)
                          throws HiveSQLException

Specified by:

getDelegationToken in interface ICLIService

Throws:

HiveSQLException

setApplicationName

public void setApplicationName(SessionHandle sh,
                               String value)
                        throws HiveSQLException

Specified by:

setApplicationName in interface ICLIService

Throws:

HiveSQLException

cancelDelegationToken

public void cancelDelegationToken(SessionHandle sessionHandle,
                                  HiveAuthFactory authFactory,
                                  String tokenStr)
                           throws HiveSQLException

Specified by:

cancelDelegationToken in interface ICLIService

Throws:

HiveSQLException

renewDelegationToken

public void renewDelegationToken(SessionHandle sessionHandle,
                                 HiveAuthFactory authFactory,
                                 String tokenStr)
                          throws HiveSQLException

Specified by:

renewDelegationToken in interface ICLIService

Throws:

HiveSQLException

getQueryId

public String getQueryId(org.apache.hive.service.rpc.thrift.TOperationHandle opHandle)
                  throws HiveSQLException

Specified by:

getQueryId in interface ICLIService

Throws:

HiveSQLException

getSessionManager

public SessionManager getSessionManager()