com.aliyun.odps.sqa

Interface SQLExecutor

public interface SQLExecutor

Method Summary

Modifier and Type	Method and Description
void	cancel() 取消当前查询
void	close() 默认行为关闭该executor,若为连接池模式,则归还Executor到连接池中
List<String>	getExecutionLog() 获取当前查询的执行日志
String	getId() 获取Executor的ID
Instance	getInstance() 获取当前查询Instance
String	getLogView() 获取当前query Logview
List<Instance.StageProgress>	getProgress() 获取当前查询的进度信息
List<Record>	getResult() 通过InstanceTunnel获取所有结果
List<Record>	getResult(Long countLimit) 通过InstanceTunnel获取有限集结果
List<Record>	getResult(Long countLimit, Long sizeLimit) 通过InstanceTunnel获取有限集结果
List<Record>	getResult(Long offset, Long countLimit, Long sizeLimit) 通过InstanceTunnel获取有限集结果
List<Record>	getResult(Long offset, Long countLimit, Long sizeLimit, boolean limitEnabled) 通过InstanceTunnel获取有限集结果
ResultSet	getResultSet() 通过InstanceTunnel获取结果的迭代器
ResultSet	getResultSet(Long countLimit) 通过InstanceTunnel获取有限集结果的迭代器
ResultSet	getResultSet(Long countLimit, Long sizeLimit) 通过InstanceTunnel获取有限集结果的迭代器
ResultSet	getResultSet(Long offset, Long countLimit, Long sizeLimit) 通过InstanceTunnel获取有限集结果的迭代器
ResultSet	getResultSet(Long offset, Long countLimit, Long sizeLimit, boolean limitEnabled) 通过InstanceTunnel获取有限集结果的迭代器
int	getSubqueryId() 获取当前query ID
String	getSummary() 获取当前查询的Summary信息
String	getTaskName() 获取当前query taskName
boolean	isActive() 检查该Executor是否活跃
void	run(String sql, Map<String,String> hint) 提交一个query

Method Detail

close

void close()

默认行为关闭该executor,若为连接池模式,则归还Executor到连接池中

Throws:

getId

String getId()

获取Executor的ID

Returns:

Throws:

getTaskName

String getTaskName()

获取当前query taskName

Returns:

Throws:

getSubqueryId

int getSubqueryId()

获取当前query ID

Returns:

-1表示Executor尚未初始化

Throws:

getLogView

String getLogView()

获取当前query Logview

Returns:

Throws:

isActive

boolean isActive()

检查该Executor是否活跃

Returns:

是否存活

Throws:

cancel

void cancel()
     throws OdpsException

取消当前查询

Throws:

OdpsException

getInstance

Instance getInstance()

获取当前查询Instance

Returns:

Throws:

getProgress

List<Instance.StageProgress> getProgress()
                                  throws OdpsException

获取当前查询的进度信息

Returns:

各阶段进度信息

Throws:

OdpsException

getExecutionLog

List<String> getExecutionLog()

获取当前查询的执行日志

Returns:

执行信息,包括回退等消息

Throws:

OdpsException

getSummary

String getSummary()
           throws OdpsException

获取当前查询的Summary信息

Returns:

SQL summary

Throws:

OdpsException

getResult

List<Record> getResult()
                throws OdpsException,
                       IOException

通过InstanceTunnel获取所有结果

Returns:

query执行的所有结果

Throws:

OdpsException, - IOException

OdpsException

IOException

getResultSet

ResultSet getResultSet()
                throws OdpsException,
                       IOException

通过InstanceTunnel获取结果的迭代器

Returns:

query执行的所有结果

Throws:

OdpsException, - IOException

OdpsException

IOException

getResult

List<Record> getResult(Long countLimit)
                throws OdpsException,
                       IOException

通过InstanceTunnel获取有限集结果

Parameters:

countLimit - 返回结果数量

Returns:

query执行的所有结果 注意 : 返回结果类型为 List, 数据量较大时会带来较多内存开销 大数据量下载建议直接使用getResultSet(Long);

Throws:

OdpsException, - IOException

OdpsException

IOException

getResult

List<Record> getResult(Long countLimit,
                       Long sizeLimit)
                throws OdpsException,
                       IOException

通过InstanceTunnel获取有限集结果

Parameters:

countLimit - 返回结果数量

sizeLimit - 返回结果大小

Returns:

query执行的所有结果 注意 : 返回结果类型为 List, 数据量较大时会带来较多内存开销 大数据量下载建议直接使用getResultSet(Long, Long);

Throws:

OdpsException, - IOException

OdpsException

IOException

getResult

List<Record> getResult(Long offset,
                       Long countLimit,
                       Long sizeLimit)
                throws OdpsException,
                       IOException

通过InstanceTunnel获取有限集结果

Parameters:

offset - 返回结果的开始行数, 从第几行开始取结果

countLimit - 返回结果数量

sizeLimit - 返回结果大小

Returns:

query执行的所有结果 注意 : 返回结果类型为 List, 数据量较大时会带来较多内存开销 大数据量下载建议直接使用getResultSet(Long, Long, Long);

Throws:

OdpsException, - IOException

OdpsException

IOException

getResult

List<Record> getResult(Long offset,
                       Long countLimit,
                       Long sizeLimit,
                       boolean limitEnabled)
                throws OdpsException,
                       IOException

通过InstanceTunnel获取有限集结果

Parameters:

offset - 返回结果的开始行数, 从第几行开始取结果

countLimit - 返回结果数量

sizeLimit - 返回结果大小

limitEnabled - 是否启用project设置的READ_TABLE_MAX_ROW, 启用后countLimit设置不再生效(被READ_TABLE_MAX_ROW覆盖) 不启用则取countLimit数量的结果, 但会进行权限校验, 需要提前在policy中为对应SQL中涉及的相应表和视图添加exception, 否则无权下载

Returns:

query执行的所有结果 注意 : 返回结果类型为 List, 数据量较大时会带来较多内存开销 大数据量下载建议直接使用getResultSet(Long, Long, Long, boolean);

Throws:

OdpsException, - IOException

OdpsException

IOException

getResultSet

ResultSet getResultSet(Long countLimit)
                throws OdpsException,
                       IOException

通过InstanceTunnel获取有限集结果的迭代器

Parameters:

countLimit - 返回结果数量

Returns:

query执行的所有结果

Throws:

OdpsException, - IOException

OdpsException

IOException

getResultSet

ResultSet getResultSet(Long countLimit,
                       Long sizeLimit)
                throws OdpsException,
                       IOException

通过InstanceTunnel获取有限集结果的迭代器

Parameters:

countLimit - 返回结果数量

sizeLimit - 返回结果大小

Returns:

query执行的所有结果

Throws:

OdpsException, - IOException

OdpsException

IOException

getResultSet

ResultSet getResultSet(Long offset,
                       Long countLimit,
                       Long sizeLimit)
                throws OdpsException,
                       IOException

通过InstanceTunnel获取有限集结果的迭代器

Parameters:

offset - 返回结果的开始行数, 从第几行开始取结果

countLimit - 返回结果数量

sizeLimit - 返回结果大小

Returns:

query执行的所有结果

Throws:

OdpsException, - IOException

OdpsException

IOException

getResultSet

ResultSet getResultSet(Long offset,
                       Long countLimit,
                       Long sizeLimit,
                       boolean limitEnabled)
                throws OdpsException,
                       IOException

通过InstanceTunnel获取有限集结果的迭代器

Parameters:

offset - 返回结果的开始行数, 从第几行开始取结果

countLimit - 返回结果数量

sizeLimit - 返回结果大小

limitEnabled - 是否启用project设置的READ_TABLE_MAX_ROW, 启用后countLimit设置不再生效(被READ_TABLE_MAX_ROW覆盖) 不启用则取countLimit数量的结果, 但会进行权限校验, 需要提前在policy中为对应SQL中涉及的相应表和视图添加exception, 否则无权下载

Returns:

query执行的所有结果

Throws:

OdpsException, - IOException

OdpsException

IOException

run

void run(String sql,
         Map<String,String> hint)
  throws OdpsException

提交一个query

Parameters:

sql - sql语句

hint - query需要的hint参数

Throws:

OdpsException