com.aliyun.odps.sqa.SQLExecutor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of odps-sdk-core Show documentation
There is a newer version: 0.51.5-public
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package com.aliyun.odps.sqa;

import com.aliyun.odps.Instance;
import com.aliyun.odps.OdpsException;
import com.aliyun.odps.data.Record;
import com.aliyun.odps.data.ResultSet;

import java.io.IOException;
import java.util.*;

public interface SQLExecutor {
  /**
   * 默认行为关闭该executor,若为连接池模式,则归还Executor到连接池中
   * @return
   * @throws
   */
  public void close();

  /**
   * 获取Executor的ID

   * @return
   * @throws
   */
  public String getId();

  /**
   * 获取当前query taskName

   * @return
   * @throws
   */
  public String getTaskName();

  /**
   * 获取当前query ID

   * @return null表示Executor尚未初始化或非Interactive模式
   */
  public String getQueryId();

  /**
   * 获取当前query ID

   * @return -1表示Executor尚未初始化或非Interactive模式
   * @throws
   */
  public int getSubqueryId();

  /**
   * 获取当前query Logview

   * @return
   * @throws
   */
  public String getLogView();

  /**
   * 检查该Executor是否活跃

   * @return 是否存活
   * @throws
   */
  public boolean isActive();

  /**
   * 取消当前查询

   * @return
   * @throws
   */
  public void cancel() throws OdpsException;

  /**
   * 获取当前查询Instance

   * @return
   * @throws
   */
  public Instance getInstance();

  /**
   * 获取当前查询的进度信息

   * @return 各阶段进度信息
   * @throws OdpsException
   */
  public List getProgress() throws OdpsException ;

  /**
   * 获取当前查询的执行日志

   * @return 执行信息,包括回退等消息
   * @throws OdpsException
   */
  public List getExecutionLog();

  /**
   * 获取当前查询的Summary信息

   * @return SQL summary
   * @throws OdpsException
   */
  public String getSummary() throws OdpsException ;

  /**
   * 通过InstanceTunnel获取所有结果

   * @return query执行的所有结果
   * @throws OdpsException, IOException
   */
  public List getResult()
      throws OdpsException, IOException;

  /**
   * 通过InstanceTunnel获取结果的迭代器

   * @return query执行的所有结果
   * @throws OdpsException, IOException
   */
  public ResultSet getResultSet()
      throws OdpsException, IOException;

  /**
   * 通过InstanceTunnel获取有限集结果
   *
   * @param countLimit
   *     返回结果数量
   * @return query执行的所有结果
   *  注意 : 返回结果类型为 {@link List}, 数据量较大时会带来较多内存开销
   *  大数据量下载建议直接使用{@link #getResultSet(Long)};
   * @throws OdpsException, IOException
   */
  public List getResult(Long countLimit)
      throws OdpsException, IOException;

  /**
   * 通过InstanceTunnel获取有限集结果
   *
   * @param countLimit
   *     返回结果数量
   * @param sizeLimit
   *     返回结果大小
   * @return query执行的所有结果
   *  注意 : 返回结果类型为 {@link List}, 数据量较大时会带来较多内存开销
   *  大数据量下载建议直接使用{@link #getResultSet(Long, Long)};
   * @throws OdpsException, IOException
   */
  public List getResult(Long countLimit, Long sizeLimit)
      throws OdpsException, IOException;

  /**
   * 通过InstanceTunnel获取有限集结果

   * @param offset
   *     返回结果的开始行数, 从第几行开始取结果
   * @param countLimit
   *     返回结果数量
   * @param sizeLimit
   *     返回结果大小
   * @return query执行的所有结果
   *  注意 : 返回结果类型为 {@link List}, 数据量较大时会带来较多内存开销
   *  大数据量下载建议直接使用{@link #getResultSet(Long, Long, Long)};
   * @throws OdpsException, IOException
   */
  public List getResult(Long offset, Long countLimit, Long sizeLimit)
      throws OdpsException, IOException;

  /**
   * 通过InstanceTunnel获取有限集结果

   * @param offset
   *     返回结果的开始行数, 从第几行开始取结果
   * @param countLimit
   *     返回结果数量
   * @param sizeLimit
   *     返回结果大小
   * @return query执行的所有结果
   *  注意 : 返回结果类型为 {@link List}, 数据量较大时会带来较多内存开销
   *  大数据量下载建议直接使用{@link #getResultSet(Long, Long, Long, boolean)};
   * @param limitEnabled
   *     是否启用project设置的READ_TABLE_MAX_ROW, 启用后countLimit设置不再生效(被READ_TABLE_MAX_ROW覆盖)
   *     不启用则取countLimit数量的结果, 但会进行权限校验, 需要提前在policy中为对应SQL中涉及的相应表和视图添加exception, 否则无权下载
   * @throws OdpsException, IOException
   */
  public List getResult(Long offset, Long countLimit, Long sizeLimit, boolean limitEnabled)
      throws OdpsException, IOException;

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

   * @param countLimit
   *     返回结果数量
   * @return query执行的所有结果
   * @throws OdpsException, IOException
   */
  public ResultSet getResultSet(Long countLimit)
      throws OdpsException, IOException;

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

   * @param countLimit
   *     返回结果数量
   * @param sizeLimit
   *     返回结果大小
   * @return query执行的所有结果
   * @throws OdpsException, IOException
   */
  public ResultSet getResultSet(Long countLimit, Long sizeLimit)
      throws OdpsException, IOException;

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

   * @param offset
   *     返回结果的开始行数, 从第几行开始取结果
   * @param countLimit
   *     返回结果数量
   * @param sizeLimit
   *     返回结果大小
   * @return query执行的所有结果
   * @throws OdpsException, IOException
   */
  public ResultSet getResultSet(Long offset, Long countLimit, Long sizeLimit)
      throws OdpsException, IOException;

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

   * @param offset
   *     返回结果的开始行数, 从第几行开始取结果
   * @param countLimit
   *     返回结果数量
   * @param sizeLimit
   *     返回结果大小
   * @param limitEnabled
   *     是否启用project设置的READ_TABLE_MAX_ROW, 启用后countLimit设置不再生效(被READ_TABLE_MAX_ROW覆盖)
   *     不启用则取countLimit数量的结果, 但会进行权限校验, 需要提前在policy中为对应SQL中涉及的相应表和视图添加exception, 否则无权下载
   *
   * @return query执行的所有结果
   * @throws OdpsException, IOException
   */
  public ResultSet getResultSet(Long offset, Long countLimit, Long sizeLimit, boolean limitEnabled)
      throws OdpsException, IOException;

  /**
   * 提交一个query
   *
   * @param sql
   *     sql语句
   * @param hint
   *     query需要的hint参数
   * @return
   * @throws OdpsException
   */
  public void run(String sql, Map hint) throws OdpsException;

  /**
   * 从语法结构上判断执行的sql是否具备结果集
   * 不判断也不保证是否有数据
   *
   * @return 是否具备结果集
   */
  public boolean hasResultSet();

  /**
   * 判断当前执行的sql是否在 Interactive Mode
   *
   * @return
   */
  public boolean isRunningInInteractiveMode();

  /**
   * 判断当前 SQLExecutor 是否使用 Instance Tunnel 取结果
   *
   * @return
   */
  boolean isUseInstanceTunnel();
}