Session APIs

load_dataset(name, *, database=None)

描述：从指定数据库加载数据集。

输入参数：

• name (str) ：要加载的Dataset的名称。
• database (Optional[str]) ：要加载Dataset的数据库名称。如果未提供，则使用默认数据库。

返回值类型：Dataset。

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(query, **kwargs)

描述：用于执行SQL查询语句，并返回查询结果。

输入参数：

• query (str) ：要执行的SQL查询语句。
• **kwargs (Any) ：可变关键字参数，用于传递查询的额外参数。

返回值类型 ：Any，返回SQL查询的结果。

explain_plan(verbose=True)

描述：生成作业执行计划。

输入参数：

verbose(bool) ：如果为True，提供查询计划的详细说明；如果为false，则仅提供简单的执行计划。

返回值类型：str。

explain_performance()

描述：执行查询并生成计划，计划中包含执行过程中详细的性能指标。

输入参数：无。

返回值类型：str，详细的执行计划。

stats()

描述：获取当前会话的所有历史作业的执行记录。

输入参数：无。

返回值类型 ：list。