更新时间：2026-10-16 GMT+08:00
Session APIs
load_dataset
描述：从指定数据库加载数据集。
语法格式：
load_dataset(name, *, database=None)
输入参数：
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | str | 要加载的Dataset的名称。 |
| database | 否 | Optional[str] | 要加载Dataset的数据库名称。如果未提供，则使用默认数据库。 |
返回值类型：Dataset。
set_function_staging_workspace
描述：配置函数部署所需的临时工作区，包括设置必要的凭证和存储信息。
语法格式：
set_function_staging_workspace(*, obs_server, obs_bucket_name, obs_directory_base, access_key, secret_key, security_token=None)
输入参数：
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| obs_server | 是 | str | OBS服务的地址。 |
| obs_bucket_name | 是 | str | 要使用的OBS桶的名称。 |
| obs_directory_base | 是 | str | OBS中用于存储工作区数据的基目录路径。 |
| access_key | 是 | str | 用于身份验证的访问密钥。 |
| secret_key | 是 | str | 用于身份验证的私密密钥。 |
| security_token | 否 | Optional[str] | 用于身份验证的安全令牌，如果未提供则默认为None。 |
返回值类型 ：None。
sql
描述：用于执行SQL查询语句，并返回查询结果。
语法格式：
sql(query, **kwargs)
输入参数：
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| query | 是 | str | 要执行的SQL查询语句。 |
| **kwargs | 否 | Any | 可变关键字参数，用于传递查询的额外参数。 |
返回值类型 ：Any，返回SQL查询的结果。
explain_plan
描述：生成作业执行计划。
语法格式：
explain_plan(verbose=True)
输入参数：
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| verbose | 否 | bool | 如果为True，提供查询计划的详细说明；如果为False，则仅提供简单的执行计划。 |
返回值类型：str。
