org.apache.kyuubi.jdbc.hive

Class KyuubiConnection

java.lang.Object

org.apache.kyuubi.jdbc.hive.KyuubiConnection

All Implemented Interfaces:

AutoCloseable, Connection, Wrapper, SQLConnection, KyuubiLoggable

public class KyuubiConnection
extends Object
implements SQLConnection, KyuubiLoggable

KyuubiConnection.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEELINE_MODE_PROPERTY
static int	DEFAULT_ENGINE_LOG_THREAD_TIMEOUT
static String	HS2_PROXY_USER
static org.slf4j.Logger	LOG

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Constructor Summary

Constructors

Constructor and Description
KyuubiConnection(String uri, Properties info)

Method Summary

Modifier and Type	Method and Description
void	cancelDelegationToken(String tokenStr)
void	clearWarnings()
void	close()
Statement	createStatement() Creates a Statement object for sending SQL statements to the database.
Statement	createStatement(int resultSetType, int resultSetConcurrency)
void	executeInitSql()
static List<JdbcConnectionParams>	getAllUrls(String zookeeperBasedHS2Url) Get all direct HiveServer2 URLs from a ZooKeeper based HiveServer2 URL
boolean	getAutoCommit()
String	getCatalog()
Properties	getClientInfo()
String	getClientInfo(String name)
String	getConnectedUrl()
String	getDelegationToken(String owner, String renewer)
String	getEngineId()
String	getEngineName()
String	getEngineRefId()
String	getEngineUrl()
List<String>	getExecLog() Get the launch engine operation logs of current connection.
DatabaseMetaData	getMetaData()
org.apache.kyuubi.shaded.hive.service.rpc.thrift.TProtocolVersion	getProtocol()
String	getSchema()
int	getTransactionIsolation()
SQLWarning	getWarnings()
boolean	hasMoreLogs() Check whether launch engine operation might be producing more logs to be fetched.
boolean	isClosed()
boolean	isReadOnly()
boolean	isValid(int timeout)
boolean	isWrapperFor(Class<?> iface)
static org.apache.kyuubi.shaded.hive.service.rpc.thrift.TCLIService.Iface	newSynchronizedClient(org.apache.kyuubi.shaded.hive.service.rpc.thrift.TCLIService.Iface client)
static List<String>	parseInitFile(String initFile)
PreparedStatement	prepareStatement(String sql)
PreparedStatement	prepareStatement(String sql, int autoGeneratedKeys)
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
void	renewDelegationToken(String tokenStr)
void	setAutoCommit(boolean autoCommit)
void	setCatalog(String catalog)
void	setClientInfo(Properties properties)
void	setClientInfo(String name, String value)
void	setEngineLogThread(Thread logThread)
void	setReadOnly(boolean readOnly)
void	setSchema(String schema)
void	setTransactionIsolation(int level)
<T> T	unwrap(Class<T> iface)
void	waitLaunchEngineToComplete()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.kyuubi.jdbc.hive.adapter.SQLConnection

abort, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStruct, getHoldability, getNetworkTimeout, getTypeMap, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setHoldability, setNetworkTimeout, setSavepoint, setSavepoint, setTypeMap

Field Detail

LOG

public static final org.slf4j.Logger LOG

BEELINE_MODE_PROPERTY

public static final String BEELINE_MODE_PROPERTY

See Also:

Constant Field Values

HS2_PROXY_USER

public static final String HS2_PROXY_USER

See Also:

Constant Field Values

DEFAULT_ENGINE_LOG_THREAD_TIMEOUT

public static int DEFAULT_ENGINE_LOG_THREAD_TIMEOUT

Constructor Detail

KyuubiConnection

public KyuubiConnection(String uri,
                        Properties info)
                 throws SQLException

Throws:

SQLException

Method Detail

getAllUrls

public static List<JdbcConnectionParams> getAllUrls(String zookeeperBasedHS2Url)
                                             throws Exception

Get all direct HiveServer2 URLs from a ZooKeeper based HiveServer2 URL

Throws:

Exception

hasMoreLogs

public boolean hasMoreLogs()

Check whether launch engine operation might be producing more logs to be fetched. This method is a public API for usage outside of Kyuubi, although it is not part of the interface java.sql.Connection.

Specified by:

hasMoreLogs in interface KyuubiLoggable

Returns:

true if launch engine operation might be producing more logs. It does not indicate if last log lines have been fetched by getEngineLog.

getExecLog

public List<String> getExecLog()
                        throws SQLException,
                               ClosedOrCancelledException

Get the launch engine operation logs of current connection. This method is a public API for usage outside of Kyuubi, although it is not part of the interface java.sql.Connection. This method gets the incremental logs during launching engine, and uses fetchSize holden by KyuubiStatement object.

Specified by:

getExecLog in interface KyuubiLoggable

Returns:

a list of logs. It can be empty if there are no new logs to be retrieved at that time.

Throws:

SQLException

ClosedOrCancelledException - if connection has been closed

setEngineLogThread

public void setEngineLogThread(Thread logThread)

executeInitSql

public void executeInitSql()
                    throws SQLException

Throws:

SQLException

parseInitFile

public static List<String> parseInitFile(String initFile)
                                  throws IOException

Throws:

IOException

getConnectedUrl

public String getConnectedUrl()

getDelegationToken

public String getDelegationToken(String owner,
                                 String renewer)
                          throws SQLException

Throws:

SQLException

cancelDelegationToken

public void cancelDelegationToken(String tokenStr)
                           throws SQLException

Throws:

SQLException

renewDelegationToken

public void renewDelegationToken(String tokenStr)
                          throws SQLException

Throws:

SQLException

clearWarnings

public void clearWarnings()
                   throws SQLException

Specified by:

clearWarnings in interface Connection

Throws:

SQLException

close

public void close()
           throws SQLException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

Throws:

SQLException

createStatement

public Statement createStatement()
                          throws SQLException

Creates a Statement object for sending SQL statements to the database.

Specified by:

createStatement in interface Connection

Throws:

SQLException - if a database access error occurs.

See Also:

Connection.createStatement()

createStatement

public Statement createStatement(int resultSetType,
                                 int resultSetConcurrency)
                          throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

getAutoCommit

public boolean getAutoCommit()
                      throws SQLException

Specified by:

getAutoCommit in interface Connection

Throws:

SQLException

getCatalog

public String getCatalog()
                  throws SQLException

Specified by:

getCatalog in interface Connection

Throws:

SQLException

getClientInfo

public Properties getClientInfo()
                         throws SQLException

Specified by:

getClientInfo in interface Connection

Throws:

SQLException

getClientInfo

public String getClientInfo(String name)
                     throws SQLException

Specified by:

getClientInfo in interface Connection

Throws:

SQLException

getMetaData

public DatabaseMetaData getMetaData()
                             throws SQLException

Specified by:

getMetaData in interface Connection

Throws:

SQLException

getSchema

public String getSchema()
                 throws SQLException

Specified by:

getSchema in interface Connection

Throws:

SQLException

getTransactionIsolation

public int getTransactionIsolation()
                            throws SQLException

Specified by:

getTransactionIsolation in interface Connection

Throws:

SQLException

getWarnings

public SQLWarning getWarnings()
                       throws SQLException

Specified by:

getWarnings in interface Connection

Throws:

SQLException

isClosed

public boolean isClosed()
                 throws SQLException

Specified by:

isClosed in interface Connection

Throws:

SQLException

isReadOnly

public boolean isReadOnly()
                   throws SQLException

Specified by:

isReadOnly in interface Connection

Throws:

SQLException

isValid

public boolean isValid(int timeout)
                throws SQLException

Specified by:

isValid in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int autoGeneratedKeys)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql,
                                          int resultSetType,
                                          int resultSetConcurrency)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws SQLException

Specified by:

setAutoCommit in interface Connection

Throws:

SQLException

setCatalog

public void setCatalog(String catalog)
                throws SQLException

Specified by:

setCatalog in interface Connection

Throws:

SQLException

setClientInfo

public void setClientInfo(Properties properties)
                   throws SQLClientInfoException

Specified by:

setClientInfo in interface Connection

Throws:

SQLClientInfoException

setClientInfo

public void setClientInfo(String name,
                          String value)
                   throws SQLClientInfoException

Specified by:

setClientInfo in interface Connection

Throws:

SQLClientInfoException

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws SQLException

Specified by:

setReadOnly in interface Connection

Throws:

SQLException

setSchema

public void setSchema(String schema)
               throws SQLException

Specified by:

setSchema in interface Connection

Throws:

SQLException

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws SQLException

Specified by:

setTransactionIsolation in interface Connection

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

getProtocol

public org.apache.kyuubi.shaded.hive.service.rpc.thrift.TProtocolVersion getProtocol()

newSynchronizedClient

public static org.apache.kyuubi.shaded.hive.service.rpc.thrift.TCLIService.Iface newSynchronizedClient(org.apache.kyuubi.shaded.hive.service.rpc.thrift.TCLIService.Iface client)

waitLaunchEngineToComplete

public void waitLaunchEngineToComplete()
                                throws SQLException

Throws:

SQLException

getEngineId

public String getEngineId()

getEngineName

public String getEngineName()

getEngineUrl

public String getEngineUrl()

getEngineRefId

public String getEngineRefId()