SQLExecutorImpl (ODPS SDK Core 0.50.5-public API)

java.lang.Object
- com.aliyun.odps.sqa.SQLExecutorImpl

All Implemented Interfaces:: SQLExecutor

public class SQLExecutorImpl
extends Object
implements SQLExecutor

Method Summary

All Methods Instance Methods Concrete Methods
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()` 获取当前查询的进度信息
`String`	`getQueryId()` 获取当前queryId
`List<Record>`	`getResult()` 获取当前query的所有结果
`List<Record>`	`getResult(Long countLimit)` 获取有限集结果
`List<Record>`	`getResult(Long countLimit, Long sizeLimit)` 获取有限集结果
`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获取当前query的结果的迭代器
`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()` 获取当前subquery ID
`String`	`getSummary()` 获取当前查询的Summary信息
`String`	`getTaskName()` 获取当前query taskName
`boolean`	`hasResultSet()` 从语法结构上判断执行的sql是否具备结果集不判断也不保证是否有数据
`boolean`	`isActive()` 检查该Executor是否活跃
`boolean`	`isRunningInInteractiveMode()` 判断当前执行的sql是否在 Interactive Mode
`boolean`	`isSelect(String sql)`
`boolean`	`isUseInstanceTunnel()` 判断当前 SQLExecutor 是否使用 Instance Tunnel 取结果
`void`	`run(String sql, Map<String,String> hint)` 提交一个query

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - close
```
public void close()
```
    默认行为关闭该executor,若为连接池模式,则归还Executor到连接池中
    
    Specified by:
    
    close in interface SQLExecutor
    
    Throws:
  - getId
```
public String getId()
```
    获取Executor的ID
    
    Specified by:
    
    getId in interface SQLExecutor
    
    Returns:
    
    Throws:
  - getTaskName
```
public String getTaskName()
```
    获取当前query taskName
    
    Specified by:
    
    getTaskName in interface SQLExecutor
    
    Returns:
    
    Throws:
  - getSubqueryId
```
public int getSubqueryId()
```
    获取当前subquery ID
    
    Specified by:
    
    getSubqueryId in interface SQLExecutor
    
    Returns:
    
    Throws:
  - getQueryId
```
public String getQueryId()
```
    获取当前queryId
    
    Specified by:
    
    getQueryId in interface SQLExecutor
    
    Returns:
    
    Throws:
  - getLogView
```
public String getLogView()
```
    获取当前query Logview
    
    Specified by:
    
    getLogView in interface SQLExecutor
    
    Returns:
    
    Throws:
  - isActive
```
public boolean isActive()
```
    检查该Executor是否活跃
    
    Specified by:
    
    isActive in interface SQLExecutor
    
    Returns:
    
    是否存活
    
    Throws:
  - cancel
```
public void cancel()
            throws OdpsException
```
    取消当前查询
    
    Specified by:
    
    cancel in interface SQLExecutor
    
    Throws:
    
    OdpsException
  - getInstance
```
public Instance getInstance()
```
    获取当前查询Instance
    
    Specified by:
    
    getInstance in interface SQLExecutor
    
    Returns:
    
    Throws:
  - getProgress
```
public List<Instance.StageProgress> getProgress()
                                         throws OdpsException
```
    获取当前查询的进度信息
    
    Specified by:
    
    getProgress in interface SQLExecutor
    
    Returns:
    
    各阶段进度信息
    
    Throws:
    
    OdpsException
  - getSummary
```
public String getSummary()
                  throws OdpsException
```
    获取当前查询的Summary信息
    
    Specified by:
    
    getSummary in interface SQLExecutor
    
    Returns:
    
    SQL summary
    
    Throws:
    
    OdpsException
  - getExecutionLog
```
public List<String> getExecutionLog()
```
    获取当前查询的执行日志
    
    Specified by:
    
    getExecutionLog in interface SQLExecutor
    
    Returns:
    
    执行信息, 包括回退等消息
    
    Throws:
    
    OdpsException
  - getResult
```
public List<Record> getResult()
                       throws OdpsException,
                              IOException
```
    获取当前query的所有结果
    
    Specified by:
    
    getResult in interface SQLExecutor
    
    Returns:
    
    query执行的所有结果
    
    Throws:
    
    OdpsException, - IOException
    
    OdpsException
    
    IOException
  - getResultSet
```
public ResultSet getResultSet()
                       throws OdpsException,
                              IOException
```
    通过InstanceTunnel获取当前query的结果的迭代器
    
    Specified by:
    
    getResultSet in interface SQLExecutor
    
    Returns:
    
    query执行的所有结果
    
    Throws:
    
    OdpsException, - IOException
    
    OdpsException
    
    IOException
  - getResult
```
public List<Record> getResult(Long countLimit)
                       throws OdpsException,
                              IOException
```
    获取有限集结果
    
    Specified by:
    
    getResult in interface SQLExecutor
    
    Parameters:
    
    countLimit - 返回结果数量。在打开command api的情况下，异步command不受该参数限制，见SQLExecutorBuilder.enableCommandApi(boolean)
    
    Returns:
    
    query执行的所有结果注意 : 返回结果类型为 List, 数据量较大时会带来较多内存开销大数据量下载建议直接使用getResultSet(Long);
    
    Throws:
    
    OdpsException, - IOException
    
    OdpsException
    
    IOException
  - getResult
```
public List<Record> getResult(Long countLimit,
                              Long sizeLimit)
                       throws OdpsException,
                              IOException
```
    获取有限集结果
    
    Specified by:
    
    getResult in interface SQLExecutor
    
    Parameters:
    
    countLimit - 返回结果数量。在打开command api的情况下，异步command不受该参数限制，见SQLExecutorBuilder.enableCommandApi(boolean)
    
    sizeLimit - 返回结果大小(Bytes) 如果超过count大小会截断如果超过sizeLimit会直接抛出异常注意 : 返回结果类型为 List, 数据量较大时会带来较多内存开销大数据量下载建议直接使用getResultSet(Long, Long); 在打开command api的情况下，同步和异步command均不受该参数限制。
    
    Returns:
    
    query执行的所有结果
    
    Throws:
    
    OdpsException, - IOException
    
    OdpsException
    
    IOException
  - getResult
```
public List<Record> getResult(Long offset,
                              Long countLimit,
                              Long sizeLimit)
                       throws OdpsException,
                              IOException
```
    通过InstanceTunnel获取有限集结果
    
    Specified by:
    
    getResult in interface SQLExecutor
    
    Parameters:
    
    offset - 返回结果的开始行数，从第几行开始取结果。在打开command api的情况下，异步command不受该参数限制，见SQLExecutorBuilder.enableCommandApi(boolean)
    
    countLimit - 返回结果数量。在打开command api的情况下，异步command不受该参数限制，见SQLExecutorBuilder.enableCommandApi(boolean)
    
    sizeLimit - 返回结果大小注意 : 返回结果类型为 List, 数据量较大时会带来较多内存开销大数据量下载建议直接使用getResultSet(Long, Long, Long); 在打开command api的情况下，同步和异步command均不受该参数限制。
    
    Returns:
    
    query执行的所有结果
    
    Throws:
    
    OdpsException, - IOException
    
    OdpsException
    
    IOException
  - getResult
```
public List<Record> getResult(Long offset,
                              Long countLimit,
                              Long sizeLimit,
                              boolean limitEnabled)
                       throws OdpsException,
                              IOException
```
    通过InstanceTunnel获取有限集结果
    
    Specified by:
    
    getResult in interface SQLExecutor
    
    Parameters:
    
    offset - 返回结果的开始行数, 从第几行开始取结果。在打开command api的情况下，异步command不受该参数限制，见SQLExecutorBuilder.enableCommandApi(boolean)
    
    countLimit - 返回结果数量。在打开command api的情况下，异步command不受该参数限制，见SQLExecutorBuilder.enableCommandApi(boolean)
    
    sizeLimit - 返回结果大小。在打开command api的情况下，同步和异步command均不受该参数限制。
    
    limitEnabled - 是否启用project设置的READ_TABLE_MAX_ROW, 启用后countLimit设置不再生效(被READ_TABLE_MAX_ROW覆盖) 不启用则取countLimit数量的结果, 但会进行权限校验, 需要提前在policy中为对应SQL中涉及的相应表和视图添加exception, 否则无权下载。在打开command api的情况下，同步和异步command均不受该参数限制。
    
    Returns:
    
    query执行的所有结果注意 : 返回结果类型为 List, 数据量较大时会带来较多内存开销大数据量下载建议直接使用getResultSet(Long, Long, Long, boolean);
    
    Throws:
    
    OdpsException, - IOException
    
    OdpsException
    
    IOException
  - getResultSet
```
public ResultSet getResultSet(Long countLimit)
                       throws OdpsException,
                              IOException
```
    通过InstanceTunnel获取有限集结果的迭代器
    
    Specified by:
    
    getResultSet in interface SQLExecutor
    
    Parameters:
    
    countLimit - 返回结果数量。在打开command api的情况下，异步command不受该参数限制，见SQLExecutorBuilder.enableCommandApi(boolean)
    
    Returns:
    
    query执行的所有结果
    
    Throws:
    
    OdpsException, - IOException
    
    OdpsException
    
    IOException
  - getResultSet
```
public ResultSet getResultSet(Long countLimit,
                              Long sizeLimit)
                       throws OdpsException,
                              IOException
```
    通过InstanceTunnel获取有限集结果的迭代器
    
    Specified by:
    
    getResultSet in interface SQLExecutor
    
    Parameters:
    
    countLimit - 返回结果数量。在打开command api的情况下，异步command不受该参数限制，见SQLExecutorBuilder.enableCommandApi(boolean)
    
    sizeLimit - 返回结果大小(Bytes) 如果超过count大小会截断如果超过sizeLimit会直接抛出异常。在打开command api的情况下，同步和异步command均不受该参数限制。
    
    Returns:
    
    query执行的所有结果
    
    Throws:
    
    OdpsException, - IOException
    
    OdpsException
    
    IOException
  - getResultSet
```
public ResultSet getResultSet(Long offset,
                              Long countLimit,
                              Long sizeLimit)
                       throws OdpsException,
                              IOException
```
    通过InstanceTunnel获取有限集结果的迭代器
    
    Specified by:
    
    getResultSet in interface SQLExecutor
    
    Parameters:
    
    offset - 返回结果的开始行数，从第几行开始取结果。在打开command api的情况下，异步command不受该参数限制，见SQLExecutorBuilder.enableCommandApi(boolean)
    
    countLimit - 返回结果数量。在打开command api的情况下，异步command不受该参数限制，见SQLExecutorBuilder.enableCommandApi(boolean)
    
    sizeLimit - 返回结果大小。在打开command api的情况下，同步和异步command均不受该参数限制。
    
    Returns:
    
    query执行的所有结果
    
    Throws:
    
    OdpsException, - IOException
    
    OdpsException
    
    IOException
  - getResultSet
```
public ResultSet getResultSet(Long offset,
                              Long countLimit,
                              Long sizeLimit,
                              boolean limitEnabled)
                       throws OdpsException,
                              IOException
```
    通过InstanceTunnel获取有限集结果的迭代器
    
    Specified by:
    
    getResultSet in interface SQLExecutor
    
    Parameters:
    
    offset - 返回结果的开始行数, 从第几行开始取结果。在打开command api的情况下，异步command不受该参数限制，见SQLExecutorBuilder.enableCommandApi(boolean)
    
    countLimit - 返回结果数量。在打开command api的情况下，异步command不受该参数限制，见SQLExecutorBuilder.enableCommandApi(boolean)
    
    sizeLimit - 返回结果大小。在打开command api的情况下，同步和异步command均不受该参数限制。
    
    limitEnabled - 是否启用project设置的READ_TABLE_MAX_ROW, 启用后countLimit设置不再生效(被READ_TABLE_MAX_ROW覆盖) 不启用则取countLimit数量的结果, 但会进行权限校验, 需要提前在policy中为对应SQL中涉及的相应表和视图添加exception, 否则无权下载。在打开command api的情况下，同步和异步command均不受该参数限制。
    
    Returns:
    
    query执行的所有结果
    
    Throws:
    
    OdpsException, - IOException
    
    OdpsException
    
    IOException
  - run
```
public void run(String sql,
                Map<String,String> hint)
         throws OdpsException
```
    提交一个query
    
    Specified by:
    
    run in interface SQLExecutor
    
    Parameters:
    
    sql - sql语句
    
    hint - query需要的hint参数
    
    Throws:
    
    OdpsException
  - hasResultSet
```
public boolean hasResultSet()
```
    Description copied from interface: SQLExecutor
    
    从语法结构上判断执行的sql是否具备结果集不判断也不保证是否有数据
    
    Specified by:
    
    hasResultSet in interface SQLExecutor
    
    Returns:
    
    是否具备结果集
  - isRunningInInteractiveMode
```
public boolean isRunningInInteractiveMode()
```
    Description copied from interface: SQLExecutor
    
    判断当前执行的sql是否在 Interactive Mode
    
    Specified by:
    
    isRunningInInteractiveMode in interface SQLExecutor
    
    Returns:
  - isUseInstanceTunnel
```
public boolean isUseInstanceTunnel()
```
    Description copied from interface: SQLExecutor
    
    判断当前 SQLExecutor 是否使用 Instance Tunnel 取结果
    
    Specified by:
    
    isUseInstanceTunnel in interface SQLExecutor
    
    Returns:
  - isSelect
```
public boolean isSelect(String sql)
                 throws OdpsException
```
    Throws:
    
    OdpsException

Class SQLExecutorImpl

Method Summary

Methods inherited from class java.lang.Object

Method Detail

close

getId

getTaskName

getSubqueryId

getQueryId

getLogView

isActive

cancel

getInstance

getProgress

getSummary

getExecutionLog

getResult

getResultSet

getResult

getResult

getResult

getResult

getResultSet

getResultSet

getResultSet

getResultSet

run

hasResultSet

isRunningInInteractiveMode

isUseInstanceTunnel

isSelect