org.apache.kyuubi.jdbc.hive

Class KyuubiStatement

java.lang.Object

org.apache.kyuubi.jdbc.hive.KyuubiStatement

All Implemented Interfaces:

AutoCloseable, Statement, Wrapper, SQLStatement, KyuubiLoggable

Direct Known Subclasses:

KyuubiPreparedStatement

public class KyuubiStatement
extends Object
implements SQLStatement, KyuubiLoggable

KyuubiStatement.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ARROW_TIMESTAMP_AS_STRING
static int	DEFAULT_FETCH_SIZE
static String	DEFAULT_RESULT_FORMAT
static org.slf4j.Logger	LOG

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Constructor Summary

Constructors

Constructor and Description
KyuubiStatement(KyuubiConnection connection, org.apache.kyuubi.shaded.hive.service.rpc.thrift.TCLIService.Iface client, org.apache.kyuubi.shaded.hive.service.rpc.thrift.TSessionHandle sessHandle)
KyuubiStatement(KyuubiConnection connection, org.apache.kyuubi.shaded.hive.service.rpc.thrift.TCLIService.Iface client, org.apache.kyuubi.shaded.hive.service.rpc.thrift.TSessionHandle sessHandle, boolean isScrollableResultset)
KyuubiStatement(KyuubiConnection connection, org.apache.kyuubi.shaded.hive.service.rpc.thrift.TCLIService.Iface client, org.apache.kyuubi.shaded.hive.service.rpc.thrift.TSessionHandle sessHandle, boolean isScrollableResultset, int fetchSize)
KyuubiStatement(KyuubiConnection connection, org.apache.kyuubi.shaded.hive.service.rpc.thrift.TCLIService.Iface client, org.apache.kyuubi.shaded.hive.service.rpc.thrift.TSessionHandle sessHandle, int fetchSize)

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	clearWarnings()
void	close()
boolean	execute(String sql)
boolean	executeAsync(String sql) Starts the query execution asynchronously on the server, and immediately returns to the client.
ResultSet	executeGetCurrentCatalog(String sql)
ResultSet	executeGetCurrentDatabase(String sql)
ResultSet	executePython(String code)
ResultSet	executeQuery(String sql)
ResultSet	executeScala(String code)
void	executeSetCurrentCatalog(String sql, String catalog)
void	executeSetCurrentDatabase(String sql, String database)
int	executeUpdate(String sql)
Connection	getConnection()
List<String>	getExecLog() Get the execution logs of the given SQL statement.
int	getFetchDirection()
int	getFetchSize()
int	getMaxRows()
boolean	getMoreResults()
boolean	getMoreResults(int current)
String	getQueryId() Returns the Query ID if it is running.
List<String>	getQueryLog(boolean incremental, int fetchSize) Get the execution logs of the given SQL statement.
int	getQueryTimeout()
ResultSet	getResultSet()
int	getResultSetType()
int	getUpdateCount()
SQLWarning	getWarnings()
String	getYarnATSGuid() Returns the Yarn ATS GUID.
boolean	hasMoreLogs() Check whether query execution might be producing more logs to be fetched.
boolean	isClosed()
boolean	isCloseOnCompletion()
boolean	isPoolable()
boolean	isWrapperFor(Class<?> iface)
void	setFetchDirection(int direction)
void	setFetchSize(int rows)
void	setInPlaceUpdateStream(InPlaceUpdateStream stream) This is only used by the beeline client to set the stream on which in place progress updates are to be shown
void	setMaxRows(int max)
void	setQueryTimeout(int seconds)
<T> T	unwrap(Class<T> iface)

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.SQLStatement

addBatch, clearBatch, closeOnCompletion, execute, execute, execute, executeBatch, executeUpdate, executeUpdate, executeUpdate, getGeneratedKeys, getMaxFieldSize, getResultSetConcurrency, getResultSetHoldability, setCursorName, setEscapeProcessing, setMaxFieldSize, setPoolable

Methods inherited from interface java.sql.Statement

executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, getLargeMaxRows, getLargeUpdateCount, setLargeMaxRows

Field Detail

LOG

public static final org.slf4j.Logger LOG

DEFAULT_FETCH_SIZE

public static final int DEFAULT_FETCH_SIZE

See Also:

Constant Field Values

DEFAULT_RESULT_FORMAT

public static final String DEFAULT_RESULT_FORMAT

See Also:

Constant Field Values

DEFAULT_ARROW_TIMESTAMP_AS_STRING

public static final String DEFAULT_ARROW_TIMESTAMP_AS_STRING

See Also:

Constant Field Values

Constructor Detail

KyuubiStatement

public KyuubiStatement(KyuubiConnection connection,
                       org.apache.kyuubi.shaded.hive.service.rpc.thrift.TCLIService.Iface client,
                       org.apache.kyuubi.shaded.hive.service.rpc.thrift.TSessionHandle sessHandle)

KyuubiStatement

public KyuubiStatement(KyuubiConnection connection,
                       org.apache.kyuubi.shaded.hive.service.rpc.thrift.TCLIService.Iface client,
                       org.apache.kyuubi.shaded.hive.service.rpc.thrift.TSessionHandle sessHandle,
                       int fetchSize)

KyuubiStatement

public KyuubiStatement(KyuubiConnection connection,
                       org.apache.kyuubi.shaded.hive.service.rpc.thrift.TCLIService.Iface client,
                       org.apache.kyuubi.shaded.hive.service.rpc.thrift.TSessionHandle sessHandle,
                       boolean isScrollableResultset)

KyuubiStatement

public KyuubiStatement(KyuubiConnection connection,
                       org.apache.kyuubi.shaded.hive.service.rpc.thrift.TCLIService.Iface client,
                       org.apache.kyuubi.shaded.hive.service.rpc.thrift.TSessionHandle sessHandle,
                       boolean isScrollableResultset,
                       int fetchSize)

Method Detail

cancel

public void cancel()
            throws SQLException

Specified by:

cancel in interface Statement

Throws:

SQLException

clearWarnings

public void clearWarnings()
                   throws SQLException

Specified by:

clearWarnings in interface Statement

Throws:

SQLException

close

public void close()
           throws SQLException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Statement

Throws:

SQLException

execute

public boolean execute(String sql)
                throws SQLException

Specified by:

execute in interface Statement

Throws:

SQLException

executeAsync

public boolean executeAsync(String sql)
                     throws SQLException

Starts the query execution asynchronously on the server, and immediately returns to the client. The client subsequently blocks on ResultSet#next or Statement#getUpdateCount, depending on the query type. Users should call ResultSet.next or Statement#getUpdateCount (depending on whether query returns results) to ensure that query completes successfully. Calling another execute* method, or close before query completion would result in the async query getting killed if it is not already finished. Note: This method is an API for limited usage outside of Hive by applications like Apache Ambari, although it is not part of the interface java.sql.Statement.

Parameters:

sql -

Returns:

true if the first result is a ResultSet object; false if it is an update count or there are no results

Throws:

SQLException

executeQuery

public ResultSet executeQuery(String sql)
                       throws SQLException

Specified by:

executeQuery in interface Statement

Throws:

SQLException

executeScala

public ResultSet executeScala(String code)
                       throws SQLException

Throws:

SQLException

executePython

public ResultSet executePython(String code)
                        throws SQLException

Throws:

SQLException

executeSetCurrentCatalog

public void executeSetCurrentCatalog(String sql,
                                     String catalog)
                              throws SQLException

Throws:

SQLException

executeGetCurrentCatalog

public ResultSet executeGetCurrentCatalog(String sql)
                                   throws SQLException

Throws:

SQLException

executeSetCurrentDatabase

public void executeSetCurrentDatabase(String sql,
                                      String database)
                               throws SQLException

Throws:

SQLException

executeGetCurrentDatabase

public ResultSet executeGetCurrentDatabase(String sql)
                                    throws SQLException

Throws:

SQLException

executeUpdate

public int executeUpdate(String sql)
                  throws SQLException

Specified by:

executeUpdate in interface Statement

Throws:

SQLException

getConnection

public Connection getConnection()
                         throws SQLException

Specified by:

getConnection in interface Statement

Throws:

SQLException

getFetchDirection

public int getFetchDirection()
                      throws SQLException

Specified by:

getFetchDirection in interface Statement

Throws:

SQLException

getFetchSize

public int getFetchSize()
                 throws SQLException

Specified by:

getFetchSize in interface Statement

Throws:

SQLException

getMaxRows

public int getMaxRows()
               throws SQLException

Specified by:

getMaxRows in interface Statement

Throws:

SQLException

getMoreResults

public boolean getMoreResults(int current)
                       throws SQLException

Specified by:

getMoreResults in interface Statement

Throws:

SQLException

getMoreResults

public boolean getMoreResults()
                       throws SQLException

Specified by:

getMoreResults in interface Statement

Throws:

SQLException

getQueryTimeout

public int getQueryTimeout()
                    throws SQLException

Specified by:

getQueryTimeout in interface Statement

Throws:

SQLException

getResultSet

public ResultSet getResultSet()
                       throws SQLException

Specified by:

getResultSet in interface Statement

Throws:

SQLException

getResultSetType

public int getResultSetType()
                     throws SQLException

Specified by:

getResultSetType in interface Statement

Throws:

SQLException

getUpdateCount

public int getUpdateCount()
                   throws SQLException

Specified by:

getUpdateCount in interface Statement

Throws:

SQLException

getWarnings

public SQLWarning getWarnings()
                       throws SQLException

Specified by:

getWarnings in interface Statement

Throws:

SQLException

isClosed

public boolean isClosed()
                 throws SQLException

Specified by:

isClosed in interface Statement

Throws:

SQLException

isCloseOnCompletion

public boolean isCloseOnCompletion()
                            throws SQLException

Specified by:

isCloseOnCompletion in interface Statement

Throws:

SQLException

isPoolable

public boolean isPoolable()
                   throws SQLException

Specified by:

isPoolable in interface Statement

Throws:

SQLException

setFetchDirection

public void setFetchDirection(int direction)
                       throws SQLException

Specified by:

setFetchDirection in interface Statement

Throws:

SQLException

setFetchSize

public void setFetchSize(int rows)
                  throws SQLException

Specified by:

setFetchSize in interface Statement

Throws:

SQLException

setMaxRows

public void setMaxRows(int max)
                throws SQLException

Specified by:

setMaxRows in interface Statement

Throws:

SQLException

setQueryTimeout

public void setQueryTimeout(int seconds)
                     throws SQLException

Specified by:

setQueryTimeout in interface Statement

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

hasMoreLogs

public boolean hasMoreLogs()

Check whether query execution might be producing more logs to be fetched. This method is a public API for usage outside of Hive, although it is not part of the interface java.sql.Statement.

Specified by:

hasMoreLogs in interface KyuubiLoggable

Returns:

true if query execution might be producing more logs. It does not indicate if last log lines have been fetched by getQueryLog.

getExecLog

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

Get the execution logs of the given SQL statement. This method is a public API for usage outside of Hive, although it is not part of the interface java.sql.Statement. This method gets the incremental logs during SQL execution, and uses fetchSize holden by HiveStatement 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 statement has been cancelled or closed

getQueryLog

public List<String> getQueryLog(boolean incremental,
                                int fetchSize)
                         throws SQLException,
                                ClosedOrCancelledException

Get the execution logs of the given SQL statement. This method is a public API for usage outside of Hive, although it is not part of the interface java.sql.Statement.

Parameters:

incremental - indicate getting logs either incrementally or from the beginning, when it is true or false.

fetchSize - the number of lines to fetch

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 statement has been cancelled or closed

getYarnATSGuid

public String getYarnATSGuid()

Returns the Yarn ATS GUID. This method is a public API for usage outside of Hive, although it is not part of the interface java.sql.Statement.

Returns:

Yarn ATS GUID or null if it hasn't been created yet.

getQueryId

public String getQueryId()
                  throws SQLException

Returns the Query ID if it is running. This method is a public API for usage outside of Hive, although it is not part of the interface java.sql.Statement.

Returns:

Valid query ID if it is running else returns NULL.

Throws:

SQLException - If any internal failures.

setInPlaceUpdateStream

public void setInPlaceUpdateStream(InPlaceUpdateStream stream)

This is only used by the beeline client to set the stream on which in place progress updates are to be shown