com.aliyun.odps

Class Session

java.lang.Object

com.aliyun.odps.Session

public class Session
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Session.SessionItem
class	Session.SessionProgress
class	Session.SubQueryInfo
class	Session.SubQueryResponse
class	Session.SubQueryResult

Field Summary

Fields

Modifier and Type	Field and Description
static int	OBJECT_STATUS_CANCELLED
static int	OBJECT_STATUS_FAILED
static int	OBJECT_STATUS_RUNNING
static int	OBJECT_STATUS_TERMINATED

Constructor Summary

Constructors

Constructor and Description
Session(Odps odps, Instance instance)
Session(Odps odps, Instance instance, String sessionName, String taskName)

Method Summary

Modifier and Type	Method and Description
static Session	attach(Odps odps, String sessionName) attach 指定名字的 session 此调用会立即返回，不会等待 session 启动完成。 可以手动调用 waitForStart(long) 来等待启动。
static Session	attach(Odps odps, String sessionName, Map<String,String> hints) attach 指定名字的 session 此调用会立即返回，不会等待 session 启动完成。 可以手动调用 waitForStart(long) 来等待启动。
static Session	attach(Odps odps, String sessionName, Map<String,String> hints, Long timeout) attach 指定名字的 session
static Session	attach(Odps odps, String sessionName, Map<String,String> hints, Long timeout, String taskName) attach 指定名字的 session
static Session	attach(Odps odps, String sessionName, Map<String,String> hints, Long timeout, String runningCluster, String taskName) attach 指定名字的 session
void	cancelQuery(int queryId)
static Session	create(Odps odps, int workerCount, int workerMemory) 创建 session 此调用会立即返回，不会等待 session 启动完成。 可以手动调用 waitForStart(long) 来等待启动。
static Session	create(Odps odps, int workerCount, int workerMemory, String sessionName) 创建 session 此调用会立即返回，不会等待 session 启动完成。 可以手动调用 waitForStart(long) 来等待启动。
static Session	create(Odps odps, int workerCount, int workerMemory, String sessionName, String projectName, String workerSpareSpan, Map<String,String> hints, Long timeout) 创建 session
static Session	create(Odps odps, int workerCount, int workerMemory, String sessionName, String projectName, String workerSpareSpan, Map<String,String> hints, Long timeout, Integer priority) 创建 session
static Session	create(Odps odps, int workerCount, int workerMemory, String sessionName, String projectName, String workerSpareSpan, Map<String,String> hints, Long timeout, Integer priority, String runningCluster) 创建 session
static Session	create(Odps odps, int workerCount, int workerMemory, String sessionName, String projectName, String workerSpareSpan, Map<String,String> hints, Long timeout, Integer priority, String runningCluster, String taskName) 创建 session
static Session	create(Odps odps, String sessionName, String projectName, Map<String,String> hints, Long timeout) 创建 session
static Session	create(Odps odps, String sessionName, String projectName, Map<String,String> hints, Long timeout, Integer priority) 创建 session
static Session	create(Odps odps, String sessionName, String projectName, Map<String,String> hints, Long timeout, Integer priority, String runningCluster) 创建 session
String	getInformation(String key) getInformation
Instance	getInstance() 返回 odps instance 对象
String	getLogView()
String	getQueryStats() get sqlstats of subqyery
String	getQueryStats(int queryId) get sqlstats of subqyery
Session.SubQueryResult	getRawSubQueryResult(int queryId) getInformation查询SubQuery的原始结果.
String	getSessionName()
Session.SessionProgress	getStartProgress() 获取 session 启动的进度
String	getStartSessionMessage()
Session.SubQueryResult	getSubQueryResult(int queryId) getInformation查询SubQuery结果.
Session.SubQueryResult	getSubQueryResultFromWorker(int queryId) 从odps_worker查询SubQuery结果
String	getTaskName()
String	getToken() 返回当前 attach session 可复用的 token
boolean	isStarted() 判断 session 是否已经成功启动
void	printLogView()
SessionQueryResult	run(String sql) Deprecated.
SessionQueryResult	run(String sql, Map<String,String> hints) Deprecated.
Session.SubQueryInfo	runSubQuery(String sql, Map<String,String> hints) 提交查询
String	setInformation(String key, String value) setInformation
void	setLogView(String logView)
List<String>	showVariables(Map<String,String> hints) 查询当前CacheOn的变量列表
void	stop() 停止 session
void	waitAttachSuccess(long timeout) 等待 attach session 返回
void	waitForStart() 阻塞等待 session 启动
void	waitForStart(long timeout) 等待 session 启动
Session.SubQueryResponse	waitForSubqueryTerminated(int queryId) 等待SubQuery执行结束获取查询结果

Methods inherited from class java.lang.Object

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

Field Detail

OBJECT_STATUS_RUNNING

public static int OBJECT_STATUS_RUNNING

OBJECT_STATUS_FAILED

public static int OBJECT_STATUS_FAILED

OBJECT_STATUS_TERMINATED

public static int OBJECT_STATUS_TERMINATED

OBJECT_STATUS_CANCELLED

public static int OBJECT_STATUS_CANCELLED

Constructor Detail

Session

public Session(Odps odps,
               Instance instance)

Session

public Session(Odps odps,
               Instance instance,
               String sessionName,
               String taskName)

Method Detail

getLogView

public String getLogView()
                  throws OdpsException

Throws:

OdpsException

setLogView

public void setLogView(String logView)

getStartSessionMessage

public String getStartSessionMessage()

getInstance

public Instance getInstance()

返回 odps instance 对象

Returns:

instance

attach

public static Session attach(Odps odps,
                             String sessionName)
                      throws OdpsException

attach 指定名字的 session 此调用会立即返回，不会等待 session 启动完成。 可以手动调用 waitForStart(long) 来等待启动。

Parameters:

odps - odps 对象

sessionName - 指定 session 的名字

Returns:

session 对象

Throws:

OdpsException

attach

public static Session attach(Odps odps,
                             String sessionName,
                             Map<String,String> hints)
                      throws OdpsException

attach 指定名字的 session 此调用会立即返回，不会等待 session 启动完成。 可以手动调用 waitForStart(long) 来等待启动。

Parameters:

odps - odps 对象

sessionName - 指定的 session 名字

hints - 能够影响 SQL 执行的Set 参数

Returns:

Throws:

OdpsException

attach

public static Session attach(Odps odps,
                             String sessionName,
                             Map<String,String> hints,
                             Long timeout)
                      throws OdpsException

attach 指定名字的 session

Parameters:

odps - odps 对象

sessionName - 指定的 session 名字

hints - 能够影响 SQL 执行的Set 参数数

timeout - 等待 session 启动的超时时间，单位: 秒 其中: null 表示从不等待； 0 表示阻塞等待

Returns:

Throws:

OdpsException

attach

public static Session attach(Odps odps,
                             String sessionName,
                             Map<String,String> hints,
                             Long timeout,
                             String taskName)
                      throws OdpsException

attach 指定名字的 session

Parameters:

odps - odps 对象

sessionName - 指定的 session 名字

hints - 能够影响 SQL 执行的Set 参数数

timeout - 等待 session 启动的超时时间，单位: 秒 其中: null 表示从不等待； 0 表示阻塞等待

taskName - SqlRtTask的taskName

Returns:

Throws:

OdpsException

attach

public static Session attach(Odps odps,
                             String sessionName,
                             Map<String,String> hints,
                             Long timeout,
                             String runningCluster,
                             String taskName)
                      throws OdpsException

attach 指定名字的 session

Parameters:

odps - odps 对象

sessionName - 指定的 session 名字

hints - 能够影响 SQL 执行的Set 参数数

timeout - 等待 session 启动的超时时间，单位: 秒 其中: null 表示从不等待； 0 表示阻塞等待

runningCluster - 运行集群

taskName - SqlRtTask的taskName

Returns:

Throws:

OdpsException

create

public static Session create(Odps odps,
                             int workerCount,
                             int workerMemory)
                      throws OdpsException

创建 session 此调用会立即返回，不会等待 session 启动完成。 可以手动调用 waitForStart(long) 来等待启动。

Parameters:

odps - odps 对象

workerCount - session work 数量（单位：个）

workerMemory - session work 内存 （单位： MB）

Returns:

session 对象

Throws:

OdpsException

create

public static Session create(Odps odps,
                             int workerCount,
                             int workerMemory,
                             String sessionName)
                      throws OdpsException

创建 session 此调用会立即返回，不会等待 session 启动完成。 可以手动调用 waitForStart(long) 来等待启动。

Parameters:

odps - odps 对象

workerCount - session work 数量（单位：个）

workerMemory - session work 内存 （单位： MB）

sessionName - 指定 session 名字

Returns:

session 对象

Throws:

OdpsException

create

public static Session create(Odps odps,
                             int workerCount,
                             int workerMemory,
                             String sessionName,
                             String projectName,
                             String workerSpareSpan,
                             Map<String,String> hints,
                             Long timeout)
                      throws OdpsException

创建 session

Parameters:

odps - odps 对象

workerCount - session work 数量（单位：个）

workerMemory - session work 内存 （单位： MB）

sessionName - 指定 session 名字

workerSpareSpan - session 对应 cg service 的服务休息时间, 格式是 startHour-endHour 例如 0-12 表示0点到12点 worker 数会降为 0。

hints - 能够影响 SQL 执行的Set 参数

timeout - 等待 session 启动的超时时间，单位: 秒 其中: null 表示从不等待； 0 表示阻塞等待

Returns:

session 对象

Throws:

OdpsException

create

public static Session create(Odps odps,
                             int workerCount,
                             int workerMemory,
                             String sessionName,
                             String projectName,
                             String workerSpareSpan,
                             Map<String,String> hints,
                             Long timeout,
                             Integer priority)
                      throws OdpsException

创建 session

Parameters:

odps - odps 对象

workerCount - session work 数量（单位：个）

workerMemory - session work 内存 （单位： MB）

sessionName - 指定 session 名字

workerSpareSpan - session 对应 cg service 的服务休息时间, 格式是 startHour-endHour 例如 0-12 表示0点到12点 worker 数会降为 0。

hints - 能够影响 SQL 执行的Set 参数

timeout - 等待 session 启动的超时时间，单位: 秒 其中: null 表示从不等待； 0 表示阻塞等待

priority - session 优先级

Returns:

session 对象

Throws:

OdpsException

create

public static Session create(Odps odps,
                             int workerCount,
                             int workerMemory,
                             String sessionName,
                             String projectName,
                             String workerSpareSpan,
                             Map<String,String> hints,
                             Long timeout,
                             Integer priority,
                             String runningCluster)
                      throws OdpsException

创建 session

Parameters:

odps - odps 对象

workerCount - session work 数量（单位：个）

workerMemory - session work 内存 （单位： MB）

sessionName - 指定 session 名字

workerSpareSpan - session 对应 cg service 的服务休息时间, 格式是 startHour-endHour 例如 0-12 表示0点到12点 worker 数会降为 0。

hints - 能够影响 SQL 执行的Set 参数

timeout - 等待 session 启动的超时时间，单位: 秒 其中: null 表示从不等待； 0 表示阻塞等待

priority - session 优先级

runningCluster - 运行集群

Returns:

session 对象

Throws:

OdpsException

create

public static Session create(Odps odps,
                             int workerCount,
                             int workerMemory,
                             String sessionName,
                             String projectName,
                             String workerSpareSpan,
                             Map<String,String> hints,
                             Long timeout,
                             Integer priority,
                             String runningCluster,
                             String taskName)
                      throws OdpsException

创建 session

Parameters:

odps - odps 对象

workerCount - session work 数量（单位：个）

workerMemory - session work 内存 （单位： MB）

sessionName - 指定 session 名字

workerSpareSpan - session 对应 cg service 的服务休息时间, 格式是 startHour-endHour 例如 0-12 表示0点到12点 worker 数会降为 0。

hints - 能够影响 SQL 执行的Set 参数

timeout - 等待 session 启动的超时时间，单位: 秒 其中: null 表示从不等待； 0 表示阻塞等待

priority - session 优先级

runningCluster - 运行集群

taskName - SqlRtTask的taskName

Returns:

session 对象

Throws:

OdpsException

create

public static Session create(Odps odps,
                             String sessionName,
                             String projectName,
                             Map<String,String> hints,
                             Long timeout)
                      throws OdpsException

创建 session

Parameters:

odps - odps 对象

hints - 能够影响 SQL 执行的Set 参数

timeout - 等待 session 启动的超时时间，单位: 秒 其中: null 表示从不等待； 0 表示阻塞等待

Returns:

session 对象

Throws:

OdpsException

create

public static Session create(Odps odps,
                             String sessionName,
                             String projectName,
                             Map<String,String> hints,
                             Long timeout,
                             Integer priority)
                      throws OdpsException

创建 session

Parameters:

odps - odps 对象

hints - 能够影响 SQL 执行的Set 参数

timeout - 等待 session 启动的超时时间，单位: 秒 其中: null 表示从不等待； 0 表示阻塞等待

priority - session 优先级

Returns:

session 对象

Throws:

OdpsException

create

public static Session create(Odps odps,
                             String sessionName,
                             String projectName,
                             Map<String,String> hints,
                             Long timeout,
                             Integer priority,
                             String runningCluster)
                      throws OdpsException

创建 session

Parameters:

odps - odps 对象

hints - 能够影响 SQL 执行的Set 参数

timeout - 等待 session 启动的超时时间，单位: 秒 其中: null 表示从不等待； 0 表示阻塞等待

priority - session 优先级

runningCluster - 运行集群

Returns:

session 对象

Throws:

OdpsException

run

@Deprecated
public SessionQueryResult run(String sql)
                                   throws OdpsException

Deprecated.

提交查询

Parameters:

sql - sql 语句

Returns:

查询结果

Throws:

OdpsException

run

@Deprecated
public SessionQueryResult run(String sql,
                                          Map<String,String> hints)
                                   throws OdpsException

Deprecated.

提交查询

Parameters:

sql - sql 语句

hints - 能够影响 SQL 执行的Set 参数

Returns:

查询结果

Throws:

OdpsException

runSubQuery

public Session.SubQueryInfo runSubQuery(String sql,
                                        Map<String,String> hints)
                                 throws OdpsException

提交查询

Parameters:

sql - sql 语句

hints - 能够影响 SQL 执行的Set 参数

Returns:

SubQueryInfo query标识

Throws:

OdpsException

waitForSubqueryTerminated

public Session.SubQueryResponse waitForSubqueryTerminated(int queryId)
                                                   throws OdpsException

等待SubQuery执行结束获取查询结果

Parameters:

queryId -

Returns:

查询结果

Throws:

OdpsException

getSubQueryResult

public Session.SubQueryResult getSubQueryResult(int queryId)
                                         throws OdpsException

getInformation查询SubQuery结果. 仅支持select query

Parameters:

queryId - sql 语句

Returns:

查询结果

Throws:

OdpsException

getRawSubQueryResult

public Session.SubQueryResult getRawSubQueryResult(int queryId)
                                            throws OdpsException

getInformation查询SubQuery的原始结果. 主要是用于non-select query，但是这类query是具备result的

Parameters:

queryId -

Returns:

Throws:

OdpsException

getSubQueryResultFromWorker

public Session.SubQueryResult getSubQueryResultFromWorker(int queryId)
                                                   throws OdpsException

从odps_worker查询SubQuery结果

Parameters:

queryId - sql 语句

Returns:

查询结果

Throws:

OdpsException

showVariables

public List<String> showVariables(Map<String,String> hints)
                           throws OdpsException

查询当前CacheOn的变量列表

Parameters:

-

Returns:

查询结果

Throws:

OdpsException

stop

public void stop()
          throws OdpsException

停止 session

Throws:

OdpsException

waitForStart

public void waitForStart()
                  throws OdpsException

阻塞等待 session 启动

Throws:

OdpsException

isStarted

public boolean isStarted()
                  throws OdpsException

判断 session 是否已经成功启动

Returns:

是否已经启动

Throws:

OdpsException - 启动异常

waitAttachSuccess

public void waitAttachSuccess(long timeout)
                       throws OdpsException

等待 attach session 返回

Parameters:

timeout - 等待的超时时间(单位: 秒) 0 表示阻塞等待

Throws:

OdpsException

getToken

public String getToken()
                throws OdpsException

返回当前 attach session 可复用的 token

Returns:

token

Throws:

OdpsException

getQueryStats

public String getQueryStats()
                     throws OdpsException

get sqlstats of subqyery

Returns:

stats

Throws:

OdpsException - 启动异常

getQueryStats

public String getQueryStats(int queryId)
                     throws OdpsException

get sqlstats of subqyery

Parameters:

queryId - queryId

Returns:

stats

Throws:

OdpsException - 启动异常

getInformation

public String getInformation(String key)
                      throws OdpsException

getInformation

Returns:

stats

Throws:

OdpsException - 获取information异常

setInformation

public String setInformation(String key,
                             String value)
                      throws OdpsException

setInformation

Returns:

stats

Throws:

OdpsException - 设置information异常

getStartProgress

public Session.SessionProgress getStartProgress()
                                         throws OdpsException

获取 session 启动的进度

Returns:

session 启动的当前进度，包含 worker 启动数和启动总数，启动进度百分比

Throws:

OdpsException

waitForStart

public void waitForStart(long timeout)
                  throws OdpsException

等待 session 启动

Parameters:

timeout - 等待的超时时间(单位: 秒) 0 表示阻塞等待

Throws:

OdpsException

printLogView

public void printLogView()
                  throws OdpsException

Throws:

OdpsException

cancelQuery

public void cancelQuery(int queryId)
                 throws OdpsException

Throws:

OdpsException

getSessionName

public String getSessionName()

getTaskName

public String getTaskName()