Session (ODPS SDK Core 0.32.5-public API)

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

Nested Classes
Modifier and Type	Class and Description
`class`	`Session.SubQueryResponse`

Constructor Summary

Constructors
Constructor and Description

Session(Odps odps, Instance instance)

Constructors
Constructor and Description
`Session(Odps odps, Instance instance)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`	`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, 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
`Instance`	`getInstance()` 返回 odps instance 对象
`String`	`getLogView()`
`String`	`getSessionName()`
`String`	`getStartSessionMessage()`
`void`	`printLogView()`
`SessionQueryResult`	`run(String sql)` 提交查询
`SessionQueryResult`	`run(String sql, Map<String,String> hints)` 提交查询
`void`	`setLogView(String logView)`
`void`	`stop()` 停止 session
`void`	`waitForStart()` 阻塞等待 session 启动
`void`	`waitForStart(long timeout)` 等待 session 启动

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

Constructor Detail

Session

public Session(Odps odps,
               Instance instance)
        throws OdpsException

Throws:: OdpsException

Method Detail

getLogView
```
public String getLogView()
```

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

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,
                             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

run

public SessionQueryResult run(String sql)
                       throws OdpsException

提交查询

Parameters:: sql - sql 语句
Returns:: 查询结果
Throws:: OdpsException

run

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

提交查询

Parameters:: sql - sql 语句; hints - 能够影响 SQL 执行的Set 参数
Returns:: 查询结果
Throws:: OdpsException

stop

public void stop()
          throws OdpsException

停止 session

Throws:: OdpsException

waitForStart

public void waitForStart()
                  throws OdpsException

阻塞等待 session 启动

Throws:: OdpsException

waitForStart
```
public void waitForStart(long timeout)
                  throws OdpsException
```
等待 session 启动

Parameters:

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

Throws:

OdpsException

printLogView
```
public void printLogView()
```

getSessionName
```
public String getSessionName()
```

Class Session

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Session

Method Detail

getLogView

setLogView

getStartSessionMessage

getInstance

attach

attach

attach

create

create

create

create

create

create

run

run

stop

waitForStart

waitForStart

printLogView

getSessionName