Python connector API方法概览
表1总结了Fabric SQL Python connector API支持的接口方法及描述，每个接口方法的详细描述和示例代码请单击表中方法名称跳转至详情页查看。
|
接口名 |
方法 |
功能描述 |
|---|---|---|
|
FabricSQLClient.createSession |
创建一个Session。 |
|
|
FabricSQLClient.getSessionStatus |
查询一个指定Session的状态。 |
|
|
FabricSQLClient.closeSession |
关闭一个指定的Session。 |
|
|
FabricSQLClient.executeQuery |
下发SQL请求，异步返回请求结果。 |
|
|
FabricSQLClient.getSummary |
查询本次SQL请求的执行结果。 |
|
|
FabricSQLClient.getStatementResult |
查询一个语句的结果集，可以指定查询页数。 |
|
|
FabricSQLClient.cancelExecute |
取消一个执行中的请求。 |
|
|
FabricSQLClient.deleteResult |
删除指定SQL请求在OBS产生的结果集文件。 |
Fabric SQL Python connector API支持部分符合PEP 249标准的接口，PEP 249（Python Enhancement Proposal 249）是Python官方定义的数据库API接口标准，全称为Python Database API Specification v2.0，PEP 249标准定义了一组连接数据库、执行SQL语句、获取元组的方法，其具体内容请参考PEP 249 – Python Database API Specification v2.0。表2总结了符合PEP 249标准的接口方法及描述，每个接口方法的详细描述和示例代码请单击表中方法名称跳转至详情页查看。考虑到Fabric SQL服务实际的情况，提供的接口方法所需要的参数和PEP 249官方标准中可能存在差异，请以本手册中描述为准。
|
接口名 |
方法 |
功能描述 |
|---|---|---|
|
FabricSQLConnector.connect |
创建一个连接，返回一个Connection对象。 |
|
|
Connection.cursor |
使用该Connection对象创建一个Cursor对象。 |
|
|
Connection.close |
关闭一个连接。 |
|
|
Cursor.execute |
使用该Cursor对象执行SQL请求。 |
|
|
Cursor.fetchone |
游标向后移动一行，返回该行数据。 |
|
|
Cursor.fetchall |
游标向后移动至结果集行尾，并返回剩余所有行数据。 |
|
|
Cursor.fetchbatch |
当存在Arrow格式结果集时，返回一页数据。 |
|
|
Cursor.nextset |
游标切换到下一个语句结果集（如果存在）开头。 |
|
|
Cursor.close |
关闭该Cursor对象。 |
